blob: 76d1a990e4a4f7778d18316619db73cf6b42f23c [file] [log] [blame]
Gilles Peskinee59236f2018-01-27 23:32:46 +01001/*
2 * PSA crypto layer on top of Mbed TLS crypto
3 */
Bence Szépkúti86974652020-06-15 11:59:37 +02004/*
Bence Szépkúti1e148272020-08-07 13:07:28 +02005 * Copyright The Mbed TLS Contributors
Gilles Peskinee59236f2018-01-27 23:32:46 +01006 * SPDX-License-Identifier: Apache-2.0
7 *
8 * Licensed under the Apache License, Version 2.0 (the "License"); you may
9 * not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
Gilles Peskinee59236f2018-01-27 23:32:46 +010019 */
20
Gilles Peskinedb09ef62020-06-03 01:43:33 +020021#include "common.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010022
23#if defined(MBEDTLS_PSA_CRYPTO_C)
mohammad160327010052018-07-03 13:16:15 +030024
John Durkop07cc04a2020-11-16 22:08:34 -080025#if defined(MBEDTLS_PSA_CRYPTO_CONFIG)
26#include "check_crypto_config.h"
27#endif
28
itayzafrir7723ab12019-02-14 10:28:02 +020029#include "psa_crypto_service_integration.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010030#include "psa/crypto.h"
31
Gilles Peskine039b90c2018-12-07 18:24:41 +010032#include "psa_crypto_core.h"
Gilles Peskine5e769522018-11-20 21:59:56 +010033#include "psa_crypto_invasive.h"
Steven Cooremancd84cb42020-07-16 20:28:36 +020034#include "psa_crypto_driver_wrappers.h"
Ronald Cron00b7bfc2020-11-25 15:25:26 +010035#include "psa_crypto_ecp.h"
36#include "psa_crypto_rsa.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020037#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +020038#include "psa_crypto_se.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020039#endif
Gilles Peskine961849f2018-11-30 18:54:54 +010040#include "psa_crypto_slot_management.h"
Darryl Greend49a4992018-06-18 17:27:26 +010041/* Include internal declarations that are useful for implementing persistently
42 * stored keys. */
43#include "psa_crypto_storage.h"
44
Gilles Peskineb2b64d32020-12-14 16:43:58 +010045#include "psa_crypto_random_impl.h"
Gilles Peskine90edc992020-11-13 15:39:19 +010046
Gilles Peskineb46bef22019-07-30 21:32:04 +020047#include <assert.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010048#include <stdlib.h>
49#include <string.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010050#include "mbedtls/platform.h"
Gilles Peskineff2d2002019-05-06 15:26:23 +020051#if !defined(MBEDTLS_PLATFORM_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010052#define mbedtls_calloc calloc
53#define mbedtls_free free
54#endif
55
Gilles Peskine1c49f1a2020-11-13 18:46:25 +010056#include "mbedtls/aes.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010057#include "mbedtls/arc4.h"
Gilles Peskine9a944802018-06-21 09:35:35 +020058#include "mbedtls/asn1.h"
Jaeden Amero25384a22019-01-10 10:23:21 +000059#include "mbedtls/asn1write.h"
Gilles Peskinea81d85b2018-06-26 16:10:23 +020060#include "mbedtls/bignum.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010061#include "mbedtls/blowfish.h"
62#include "mbedtls/camellia.h"
Gilles Peskine26869f22019-05-06 15:25:00 +020063#include "mbedtls/chacha20.h"
64#include "mbedtls/chachapoly.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010065#include "mbedtls/cipher.h"
66#include "mbedtls/ccm.h"
67#include "mbedtls/cmac.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010068#include "mbedtls/des.h"
Gilles Peskineb7ecdf02018-09-18 12:11:27 +020069#include "mbedtls/ecdh.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010070#include "mbedtls/ecp.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010071#include "mbedtls/entropy.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010072#include "mbedtls/error.h"
73#include "mbedtls/gcm.h"
74#include "mbedtls/md2.h"
75#include "mbedtls/md4.h"
76#include "mbedtls/md5.h"
Gilles Peskine20035e32018-02-03 22:44:14 +010077#include "mbedtls/md.h"
78#include "mbedtls/md_internal.h"
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010079#include "mbedtls/pk.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010080#include "mbedtls/pk_internal.h"
Gilles Peskine3f108122018-12-07 18:14:53 +010081#include "mbedtls/platform_util.h"
Janos Follath24eed8d2019-11-22 13:21:35 +000082#include "mbedtls/error.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010083#include "mbedtls/ripemd160.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010084#include "mbedtls/rsa.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010085#include "mbedtls/sha1.h"
86#include "mbedtls/sha256.h"
87#include "mbedtls/sha512.h"
88#include "mbedtls/xtea.h"
89
Gilles Peskine996deb12018-08-01 15:45:45 +020090#define ARRAY_LENGTH( array ) ( sizeof( array ) / sizeof( *( array ) ) )
91
Gilles Peskine9ef733f2018-02-07 21:05:37 +010092/* constant-time buffer comparison */
93static inline int safer_memcmp( const uint8_t *a, const uint8_t *b, size_t n )
94{
95 size_t i;
96 unsigned char diff = 0;
97
98 for( i = 0; i < n; i++ )
99 diff |= a[i] ^ b[i];
100
101 return( diff );
102}
103
104
105
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100106/****************************************************************/
107/* Global data, support functions and library management */
108/****************************************************************/
109
Gilles Peskine48c0ea12018-06-21 14:15:31 +0200110static int key_type_is_raw_bytes( psa_key_type_t type )
111{
Gilles Peskine78b3bb62018-08-10 16:03:41 +0200112 return( PSA_KEY_TYPE_IS_UNSTRUCTURED( type ) );
Gilles Peskine48c0ea12018-06-21 14:15:31 +0200113}
114
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100115/* Values for psa_global_data_t::rng_state */
116#define RNG_NOT_INITIALIZED 0
117#define RNG_INITIALIZED 1
118#define RNG_SEEDED 2
Gilles Peskinec6b69072018-11-20 21:42:52 +0100119
Gilles Peskine2d277862018-06-18 15:41:12 +0200120typedef struct
121{
Gilles Peskine30524eb2020-11-13 17:02:26 +0100122 mbedtls_psa_random_context_t rng;
Gilles Peskinec6b69072018-11-20 21:42:52 +0100123 unsigned initialized : 1;
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100124 unsigned rng_state : 2;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100125} psa_global_data_t;
126
127static psa_global_data_t global_data;
128
Gilles Peskine5894e8e2020-12-14 14:54:06 +0100129#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
130mbedtls_psa_drbg_context_t *const mbedtls_psa_random_state =
131 &global_data.rng.drbg;
132#endif
133
itayzafrir0adf0fc2018-09-06 16:24:41 +0300134#define GUARD_MODULE_INITIALIZED \
135 if( global_data.initialized == 0 ) \
136 return( PSA_ERROR_BAD_STATE );
137
Steven Cooreman01164162020-07-20 15:31:37 +0200138psa_status_t mbedtls_to_psa_error( int ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100139{
Gilles Peskinedbf68962021-01-06 20:04:23 +0100140 /* Mbed TLS error codes can combine a high-level error code and a
141 * low-level error code. The low-level error usually reflects the
142 * root cause better, so dispatch on that preferably. */
143 int low_level_ret = - ( -ret & 0x007f );
144 switch( low_level_ret != 0 ? low_level_ret : ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100145 {
146 case 0:
147 return( PSA_SUCCESS );
Gilles Peskinea5905292018-02-07 20:59:33 +0100148
149 case MBEDTLS_ERR_AES_INVALID_KEY_LENGTH:
150 case MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH:
151 case MBEDTLS_ERR_AES_FEATURE_UNAVAILABLE:
152 return( PSA_ERROR_NOT_SUPPORTED );
153 case MBEDTLS_ERR_AES_HW_ACCEL_FAILED:
154 return( PSA_ERROR_HARDWARE_FAILURE );
155
156 case MBEDTLS_ERR_ARC4_HW_ACCEL_FAILED:
157 return( PSA_ERROR_HARDWARE_FAILURE );
158
Gilles Peskine9a944802018-06-21 09:35:35 +0200159 case MBEDTLS_ERR_ASN1_OUT_OF_DATA:
160 case MBEDTLS_ERR_ASN1_UNEXPECTED_TAG:
161 case MBEDTLS_ERR_ASN1_INVALID_LENGTH:
162 case MBEDTLS_ERR_ASN1_LENGTH_MISMATCH:
163 case MBEDTLS_ERR_ASN1_INVALID_DATA:
164 return( PSA_ERROR_INVALID_ARGUMENT );
165 case MBEDTLS_ERR_ASN1_ALLOC_FAILED:
166 return( PSA_ERROR_INSUFFICIENT_MEMORY );
167 case MBEDTLS_ERR_ASN1_BUF_TOO_SMALL:
168 return( PSA_ERROR_BUFFER_TOO_SMALL );
169
Jaeden Amero93e21112019-02-20 13:57:28 +0000170#if defined(MBEDTLS_ERR_BLOWFISH_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000171 case MBEDTLS_ERR_BLOWFISH_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000172#elif defined(MBEDTLS_ERR_BLOWFISH_INVALID_KEY_LENGTH)
173 case MBEDTLS_ERR_BLOWFISH_INVALID_KEY_LENGTH:
174#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100175 case MBEDTLS_ERR_BLOWFISH_INVALID_INPUT_LENGTH:
176 return( PSA_ERROR_NOT_SUPPORTED );
177 case MBEDTLS_ERR_BLOWFISH_HW_ACCEL_FAILED:
178 return( PSA_ERROR_HARDWARE_FAILURE );
179
Jaeden Amero93e21112019-02-20 13:57:28 +0000180#if defined(MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000181 case MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000182#elif defined(MBEDTLS_ERR_CAMELLIA_INVALID_KEY_LENGTH)
183 case MBEDTLS_ERR_CAMELLIA_INVALID_KEY_LENGTH:
184#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100185 case MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH:
186 return( PSA_ERROR_NOT_SUPPORTED );
187 case MBEDTLS_ERR_CAMELLIA_HW_ACCEL_FAILED:
188 return( PSA_ERROR_HARDWARE_FAILURE );
189
190 case MBEDTLS_ERR_CCM_BAD_INPUT:
191 return( PSA_ERROR_INVALID_ARGUMENT );
192 case MBEDTLS_ERR_CCM_AUTH_FAILED:
193 return( PSA_ERROR_INVALID_SIGNATURE );
194 case MBEDTLS_ERR_CCM_HW_ACCEL_FAILED:
195 return( PSA_ERROR_HARDWARE_FAILURE );
196
Gilles Peskine26869f22019-05-06 15:25:00 +0200197 case MBEDTLS_ERR_CHACHA20_BAD_INPUT_DATA:
198 return( PSA_ERROR_INVALID_ARGUMENT );
199
200 case MBEDTLS_ERR_CHACHAPOLY_BAD_STATE:
201 return( PSA_ERROR_BAD_STATE );
202 case MBEDTLS_ERR_CHACHAPOLY_AUTH_FAILED:
203 return( PSA_ERROR_INVALID_SIGNATURE );
204
Gilles Peskinea5905292018-02-07 20:59:33 +0100205 case MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE:
206 return( PSA_ERROR_NOT_SUPPORTED );
207 case MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA:
208 return( PSA_ERROR_INVALID_ARGUMENT );
209 case MBEDTLS_ERR_CIPHER_ALLOC_FAILED:
210 return( PSA_ERROR_INSUFFICIENT_MEMORY );
211 case MBEDTLS_ERR_CIPHER_INVALID_PADDING:
212 return( PSA_ERROR_INVALID_PADDING );
213 case MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED:
Fredrik Strupef90e3012020-09-28 16:11:33 +0200214 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100215 case MBEDTLS_ERR_CIPHER_AUTH_FAILED:
216 return( PSA_ERROR_INVALID_SIGNATURE );
217 case MBEDTLS_ERR_CIPHER_INVALID_CONTEXT:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200218 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100219 case MBEDTLS_ERR_CIPHER_HW_ACCEL_FAILED:
220 return( PSA_ERROR_HARDWARE_FAILURE );
221
222 case MBEDTLS_ERR_CMAC_HW_ACCEL_FAILED:
223 return( PSA_ERROR_HARDWARE_FAILURE );
224
Gilles Peskine82e57d12020-11-13 21:31:17 +0100225#if !( defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) || \
226 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE) )
Gilles Peskinebee96c82020-11-23 21:00:09 +0100227 /* Only check CTR_DRBG error codes if underlying mbedtls_xxx
228 * functions are passed a CTR_DRBG instance. */
Gilles Peskinea5905292018-02-07 20:59:33 +0100229 case MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED:
230 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
231 case MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG:
232 case MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG:
233 return( PSA_ERROR_NOT_SUPPORTED );
234 case MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR:
235 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskine82e57d12020-11-13 21:31:17 +0100236#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100237
238 case MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH:
239 return( PSA_ERROR_NOT_SUPPORTED );
240 case MBEDTLS_ERR_DES_HW_ACCEL_FAILED:
241 return( PSA_ERROR_HARDWARE_FAILURE );
242
Gilles Peskinee59236f2018-01-27 23:32:46 +0100243 case MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED:
244 case MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE:
245 case MBEDTLS_ERR_ENTROPY_SOURCE_FAILED:
246 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskinea5905292018-02-07 20:59:33 +0100247
248 case MBEDTLS_ERR_GCM_AUTH_FAILED:
249 return( PSA_ERROR_INVALID_SIGNATURE );
250 case MBEDTLS_ERR_GCM_BAD_INPUT:
Gilles Peskine8cac2e62018-08-21 15:07:38 +0200251 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100252 case MBEDTLS_ERR_GCM_HW_ACCEL_FAILED:
253 return( PSA_ERROR_HARDWARE_FAILURE );
254
Gilles Peskine82e57d12020-11-13 21:31:17 +0100255#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) && \
256 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE)
Gilles Peskinebee96c82020-11-23 21:00:09 +0100257 /* Only check HMAC_DRBG error codes if underlying mbedtls_xxx
258 * functions are passed a HMAC_DRBG instance. */
Gilles Peskine82e57d12020-11-13 21:31:17 +0100259 case MBEDTLS_ERR_HMAC_DRBG_ENTROPY_SOURCE_FAILED:
260 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
261 case MBEDTLS_ERR_HMAC_DRBG_REQUEST_TOO_BIG:
262 case MBEDTLS_ERR_HMAC_DRBG_INPUT_TOO_BIG:
263 return( PSA_ERROR_NOT_SUPPORTED );
264 case MBEDTLS_ERR_HMAC_DRBG_FILE_IO_ERROR:
265 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
266#endif
267
Gilles Peskinea5905292018-02-07 20:59:33 +0100268 case MBEDTLS_ERR_MD2_HW_ACCEL_FAILED:
269 case MBEDTLS_ERR_MD4_HW_ACCEL_FAILED:
270 case MBEDTLS_ERR_MD5_HW_ACCEL_FAILED:
271 return( PSA_ERROR_HARDWARE_FAILURE );
272
273 case MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE:
274 return( PSA_ERROR_NOT_SUPPORTED );
275 case MBEDTLS_ERR_MD_BAD_INPUT_DATA:
276 return( PSA_ERROR_INVALID_ARGUMENT );
277 case MBEDTLS_ERR_MD_ALLOC_FAILED:
278 return( PSA_ERROR_INSUFFICIENT_MEMORY );
279 case MBEDTLS_ERR_MD_FILE_IO_ERROR:
280 return( PSA_ERROR_STORAGE_FAILURE );
281 case MBEDTLS_ERR_MD_HW_ACCEL_FAILED:
282 return( PSA_ERROR_HARDWARE_FAILURE );
283
Gilles Peskinef76aa772018-10-29 19:24:33 +0100284 case MBEDTLS_ERR_MPI_FILE_IO_ERROR:
285 return( PSA_ERROR_STORAGE_FAILURE );
286 case MBEDTLS_ERR_MPI_BAD_INPUT_DATA:
287 return( PSA_ERROR_INVALID_ARGUMENT );
288 case MBEDTLS_ERR_MPI_INVALID_CHARACTER:
289 return( PSA_ERROR_INVALID_ARGUMENT );
290 case MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL:
291 return( PSA_ERROR_BUFFER_TOO_SMALL );
292 case MBEDTLS_ERR_MPI_NEGATIVE_VALUE:
293 return( PSA_ERROR_INVALID_ARGUMENT );
294 case MBEDTLS_ERR_MPI_DIVISION_BY_ZERO:
295 return( PSA_ERROR_INVALID_ARGUMENT );
296 case MBEDTLS_ERR_MPI_NOT_ACCEPTABLE:
297 return( PSA_ERROR_INVALID_ARGUMENT );
298 case MBEDTLS_ERR_MPI_ALLOC_FAILED:
299 return( PSA_ERROR_INSUFFICIENT_MEMORY );
300
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100301 case MBEDTLS_ERR_PK_ALLOC_FAILED:
302 return( PSA_ERROR_INSUFFICIENT_MEMORY );
303 case MBEDTLS_ERR_PK_TYPE_MISMATCH:
304 case MBEDTLS_ERR_PK_BAD_INPUT_DATA:
305 return( PSA_ERROR_INVALID_ARGUMENT );
306 case MBEDTLS_ERR_PK_FILE_IO_ERROR:
Gilles Peskinea5905292018-02-07 20:59:33 +0100307 return( PSA_ERROR_STORAGE_FAILURE );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100308 case MBEDTLS_ERR_PK_KEY_INVALID_VERSION:
309 case MBEDTLS_ERR_PK_KEY_INVALID_FORMAT:
310 return( PSA_ERROR_INVALID_ARGUMENT );
311 case MBEDTLS_ERR_PK_UNKNOWN_PK_ALG:
312 return( PSA_ERROR_NOT_SUPPORTED );
313 case MBEDTLS_ERR_PK_PASSWORD_REQUIRED:
314 case MBEDTLS_ERR_PK_PASSWORD_MISMATCH:
315 return( PSA_ERROR_NOT_PERMITTED );
316 case MBEDTLS_ERR_PK_INVALID_PUBKEY:
317 return( PSA_ERROR_INVALID_ARGUMENT );
318 case MBEDTLS_ERR_PK_INVALID_ALG:
319 case MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE:
320 case MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE:
321 return( PSA_ERROR_NOT_SUPPORTED );
322 case MBEDTLS_ERR_PK_SIG_LEN_MISMATCH:
323 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskinea5905292018-02-07 20:59:33 +0100324 case MBEDTLS_ERR_PK_HW_ACCEL_FAILED:
325 return( PSA_ERROR_HARDWARE_FAILURE );
326
Gilles Peskineff2d2002019-05-06 15:26:23 +0200327 case MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED:
328 return( PSA_ERROR_HARDWARE_FAILURE );
329 case MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED:
330 return( PSA_ERROR_NOT_SUPPORTED );
331
Gilles Peskinea5905292018-02-07 20:59:33 +0100332 case MBEDTLS_ERR_RIPEMD160_HW_ACCEL_FAILED:
333 return( PSA_ERROR_HARDWARE_FAILURE );
334
335 case MBEDTLS_ERR_RSA_BAD_INPUT_DATA:
336 return( PSA_ERROR_INVALID_ARGUMENT );
337 case MBEDTLS_ERR_RSA_INVALID_PADDING:
338 return( PSA_ERROR_INVALID_PADDING );
339 case MBEDTLS_ERR_RSA_KEY_GEN_FAILED:
340 return( PSA_ERROR_HARDWARE_FAILURE );
341 case MBEDTLS_ERR_RSA_KEY_CHECK_FAILED:
342 return( PSA_ERROR_INVALID_ARGUMENT );
343 case MBEDTLS_ERR_RSA_PUBLIC_FAILED:
344 case MBEDTLS_ERR_RSA_PRIVATE_FAILED:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200345 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100346 case MBEDTLS_ERR_RSA_VERIFY_FAILED:
347 return( PSA_ERROR_INVALID_SIGNATURE );
348 case MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE:
349 return( PSA_ERROR_BUFFER_TOO_SMALL );
350 case MBEDTLS_ERR_RSA_RNG_FAILED:
Gilles Peskine40d81602020-11-25 00:09:47 +0100351 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskinea5905292018-02-07 20:59:33 +0100352 case MBEDTLS_ERR_RSA_UNSUPPORTED_OPERATION:
353 return( PSA_ERROR_NOT_SUPPORTED );
354 case MBEDTLS_ERR_RSA_HW_ACCEL_FAILED:
355 return( PSA_ERROR_HARDWARE_FAILURE );
356
357 case MBEDTLS_ERR_SHA1_HW_ACCEL_FAILED:
358 case MBEDTLS_ERR_SHA256_HW_ACCEL_FAILED:
359 case MBEDTLS_ERR_SHA512_HW_ACCEL_FAILED:
360 return( PSA_ERROR_HARDWARE_FAILURE );
361
362 case MBEDTLS_ERR_XTEA_INVALID_INPUT_LENGTH:
363 return( PSA_ERROR_INVALID_ARGUMENT );
364 case MBEDTLS_ERR_XTEA_HW_ACCEL_FAILED:
365 return( PSA_ERROR_HARDWARE_FAILURE );
366
itayzafrir5c753392018-05-08 11:18:38 +0300367 case MBEDTLS_ERR_ECP_BAD_INPUT_DATA:
itayzafrir7b30f8b2018-05-09 16:07:36 +0300368 case MBEDTLS_ERR_ECP_INVALID_KEY:
itayzafrir5c753392018-05-08 11:18:38 +0300369 return( PSA_ERROR_INVALID_ARGUMENT );
itayzafrir7b30f8b2018-05-09 16:07:36 +0300370 case MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL:
371 return( PSA_ERROR_BUFFER_TOO_SMALL );
372 case MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE:
373 return( PSA_ERROR_NOT_SUPPORTED );
374 case MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH:
375 case MBEDTLS_ERR_ECP_VERIFY_FAILED:
376 return( PSA_ERROR_INVALID_SIGNATURE );
377 case MBEDTLS_ERR_ECP_ALLOC_FAILED:
378 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Gilles Peskine40d81602020-11-25 00:09:47 +0100379 case MBEDTLS_ERR_ECP_RANDOM_FAILED:
380 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
itayzafrir7b30f8b2018-05-09 16:07:36 +0300381 case MBEDTLS_ERR_ECP_HW_ACCEL_FAILED:
382 return( PSA_ERROR_HARDWARE_FAILURE );
Gilles Peskine40d81602020-11-25 00:09:47 +0100383
Janos Follatha13b9052019-11-22 12:48:59 +0000384 case MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED:
385 return( PSA_ERROR_CORRUPTION_DETECTED );
itayzafrir5c753392018-05-08 11:18:38 +0300386
Gilles Peskinee59236f2018-01-27 23:32:46 +0100387 default:
David Saadab4ecc272019-02-14 13:48:10 +0200388 return( PSA_ERROR_GENERIC_ERROR );
Gilles Peskinee59236f2018-01-27 23:32:46 +0100389 }
390}
391
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200392
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +0200393
394
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100395/****************************************************************/
396/* Key management */
397/****************************************************************/
398
Gilles Peskine73167e12019-07-12 23:44:37 +0200399#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
400static inline int psa_key_slot_is_external( const psa_key_slot_t *slot )
401{
Gilles Peskine8e338702019-07-30 20:06:31 +0200402 return( psa_key_lifetime_is_external( slot->attr.lifetime ) );
Gilles Peskine73167e12019-07-12 23:44:37 +0200403}
404#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
405
John Durkop07cc04a2020-11-16 22:08:34 -0800406/* For now the MBEDTLS_PSA_ACCEL_ guards are also used here since the
407 * current test driver in key_management.c is using this function
408 * when accelerators are used for ECC key pair and public key.
409 * Once that dependency is resolved these guards can be removed.
410 */
John Durkop9814fa22020-11-04 12:28:15 -0800411#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
John Durkop6ba40d12020-11-10 08:50:04 -0800412 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) || \
413 defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_KEY_PAIR) || \
414 defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_PUBLIC_KEY)
Paul Elliott8ff510a2020-06-02 17:19:28 +0100415mbedtls_ecp_group_id mbedtls_ecc_group_of_psa( psa_ecc_family_t curve,
Gilles Peskine5055b232019-12-12 17:49:31 +0100416 size_t byte_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +0200417{
418 switch( curve )
419 {
Paul Elliott8ff510a2020-06-02 17:19:28 +0100420 case PSA_ECC_FAMILY_SECP_R1:
Gilles Peskine228abc52019-12-03 17:24:19 +0100421 switch( byte_length )
422 {
423 case PSA_BITS_TO_BYTES( 192 ):
424 return( MBEDTLS_ECP_DP_SECP192R1 );
425 case PSA_BITS_TO_BYTES( 224 ):
426 return( MBEDTLS_ECP_DP_SECP224R1 );
427 case PSA_BITS_TO_BYTES( 256 ):
428 return( MBEDTLS_ECP_DP_SECP256R1 );
429 case PSA_BITS_TO_BYTES( 384 ):
430 return( MBEDTLS_ECP_DP_SECP384R1 );
431 case PSA_BITS_TO_BYTES( 521 ):
432 return( MBEDTLS_ECP_DP_SECP521R1 );
433 default:
434 return( MBEDTLS_ECP_DP_NONE );
435 }
436 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100437
Paul Elliott8ff510a2020-06-02 17:19:28 +0100438 case PSA_ECC_FAMILY_BRAINPOOL_P_R1:
Gilles Peskine228abc52019-12-03 17:24:19 +0100439 switch( byte_length )
440 {
441 case PSA_BITS_TO_BYTES( 256 ):
442 return( MBEDTLS_ECP_DP_BP256R1 );
443 case PSA_BITS_TO_BYTES( 384 ):
444 return( MBEDTLS_ECP_DP_BP384R1 );
445 case PSA_BITS_TO_BYTES( 512 ):
446 return( MBEDTLS_ECP_DP_BP512R1 );
447 default:
448 return( MBEDTLS_ECP_DP_NONE );
449 }
450 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100451
Paul Elliott8ff510a2020-06-02 17:19:28 +0100452 case PSA_ECC_FAMILY_MONTGOMERY:
Gilles Peskine228abc52019-12-03 17:24:19 +0100453 switch( byte_length )
454 {
455 case PSA_BITS_TO_BYTES( 255 ):
456 return( MBEDTLS_ECP_DP_CURVE25519 );
457 case PSA_BITS_TO_BYTES( 448 ):
458 return( MBEDTLS_ECP_DP_CURVE448 );
459 default:
460 return( MBEDTLS_ECP_DP_NONE );
461 }
462 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100463
Paul Elliott8ff510a2020-06-02 17:19:28 +0100464 case PSA_ECC_FAMILY_SECP_K1:
Gilles Peskine228abc52019-12-03 17:24:19 +0100465 switch( byte_length )
466 {
467 case PSA_BITS_TO_BYTES( 192 ):
468 return( MBEDTLS_ECP_DP_SECP192K1 );
469 case PSA_BITS_TO_BYTES( 224 ):
470 return( MBEDTLS_ECP_DP_SECP224K1 );
471 case PSA_BITS_TO_BYTES( 256 ):
472 return( MBEDTLS_ECP_DP_SECP256K1 );
473 default:
474 return( MBEDTLS_ECP_DP_NONE );
475 }
476 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100477
Gilles Peskine12313cd2018-06-20 00:20:32 +0200478 default:
479 return( MBEDTLS_ECP_DP_NONE );
480 }
481}
John Durkop9814fa22020-11-04 12:28:15 -0800482#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
John Durkop6ba40d12020-11-10 08:50:04 -0800483 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) ||
484 * defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_KEY_PAIR) ||
485 * defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_PUBLIC_KEY) */
Gilles Peskine12313cd2018-06-20 00:20:32 +0200486
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200487static psa_status_t validate_unstructured_key_bit_size( psa_key_type_t type,
488 size_t bits )
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200489{
490 /* Check that the bit size is acceptable for the key type */
491 switch( type )
492 {
493 case PSA_KEY_TYPE_RAW_DATA:
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200494 case PSA_KEY_TYPE_HMAC:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200495 case PSA_KEY_TYPE_DERIVE:
496 break;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200497#if defined(MBEDTLS_AES_C)
498 case PSA_KEY_TYPE_AES:
499 if( bits != 128 && bits != 192 && bits != 256 )
500 return( PSA_ERROR_INVALID_ARGUMENT );
501 break;
502#endif
503#if defined(MBEDTLS_CAMELLIA_C)
504 case PSA_KEY_TYPE_CAMELLIA:
505 if( bits != 128 && bits != 192 && bits != 256 )
506 return( PSA_ERROR_INVALID_ARGUMENT );
507 break;
508#endif
509#if defined(MBEDTLS_DES_C)
510 case PSA_KEY_TYPE_DES:
511 if( bits != 64 && bits != 128 && bits != 192 )
512 return( PSA_ERROR_INVALID_ARGUMENT );
513 break;
514#endif
515#if defined(MBEDTLS_ARC4_C)
516 case PSA_KEY_TYPE_ARC4:
517 if( bits < 8 || bits > 2048 )
518 return( PSA_ERROR_INVALID_ARGUMENT );
519 break;
520#endif
Gilles Peskine26869f22019-05-06 15:25:00 +0200521#if defined(MBEDTLS_CHACHA20_C)
522 case PSA_KEY_TYPE_CHACHA20:
523 if( bits != 256 )
524 return( PSA_ERROR_INVALID_ARGUMENT );
525 break;
526#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200527 default:
528 return( PSA_ERROR_NOT_SUPPORTED );
529 }
Gilles Peskineb54979a2018-06-21 09:32:47 +0200530 if( bits % 8 != 0 )
531 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200532
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200533 return( PSA_SUCCESS );
534}
535
John Durkop6ba40d12020-11-10 08:50:04 -0800536#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
537 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
538
Steven Cooremana01795d2020-07-24 22:48:15 +0200539/** Export an RSA key to export representation
540 *
541 * \param[in] type The type of key (public/private) to export
542 * \param[in] rsa The internal RSA representation from which to export
543 * \param[out] data The buffer to export to
544 * \param[in] data_size The length of the buffer to export to
545 * \param[out] data_length The amount of bytes written to \p data
546 */
Ronald Cron3c8ca3a2020-11-26 16:45:24 +0100547static psa_status_t mbedtls_psa_rsa_export_key( psa_key_type_t type,
548 mbedtls_rsa_context *rsa,
549 uint8_t *data,
550 size_t data_size,
551 size_t *data_length )
Steven Cooremana01795d2020-07-24 22:48:15 +0200552{
553#if defined(MBEDTLS_PK_WRITE_C)
554 int ret;
555 mbedtls_pk_context pk;
556 uint8_t *pos = data + data_size;
557
558 mbedtls_pk_init( &pk );
559 pk.pk_info = &mbedtls_rsa_info;
560 pk.pk_ctx = rsa;
561
562 /* PSA Crypto API defines the format of an RSA key as a DER-encoded
Steven Cooreman75b74362020-07-28 14:30:13 +0200563 * representation of the non-encrypted PKCS#1 RSAPrivateKey for a
564 * private key and of the RFC3279 RSAPublicKey for a public key. */
Steven Cooremana01795d2020-07-24 22:48:15 +0200565 if( PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
566 ret = mbedtls_pk_write_key_der( &pk, data, data_size );
567 else
568 ret = mbedtls_pk_write_pubkey( &pos, data, &pk );
569
570 if( ret < 0 )
Steven Cooreman4fed4552020-08-03 14:46:03 +0200571 {
572 /* Clean up in case pk_write failed halfway through. */
573 memset( data, 0, data_size );
Steven Cooreman29149862020-08-05 15:43:42 +0200574 return( mbedtls_to_psa_error( ret ) );
Steven Cooreman4fed4552020-08-03 14:46:03 +0200575 }
Steven Cooremana01795d2020-07-24 22:48:15 +0200576
577 /* The mbedtls_pk_xxx functions write to the end of the buffer.
578 * Move the data to the beginning and erase remaining data
579 * at the original location. */
580 if( 2 * (size_t) ret <= data_size )
581 {
582 memcpy( data, data + data_size - ret, ret );
583 memset( data + data_size - ret, 0, ret );
584 }
585 else if( (size_t) ret < data_size )
586 {
587 memmove( data, data + data_size - ret, ret );
588 memset( data + ret, 0, data_size - ret );
589 }
590
591 *data_length = ret;
592 return( PSA_SUCCESS );
593#else
594 (void) type;
595 (void) rsa;
596 (void) data;
597 (void) data_size;
598 (void) data_length;
599 return( PSA_ERROR_NOT_SUPPORTED );
600#endif /* MBEDTLS_PK_WRITE_C */
601}
602
603/** Import an RSA key from import representation to a slot
604 *
605 * \param[in,out] slot The slot where to store the export representation to
606 * \param[in] data The buffer containing the import representation
607 * \param[in] data_length The amount of bytes in \p data
608 */
609static psa_status_t psa_import_rsa_key( psa_key_slot_t *slot,
610 const uint8_t *data,
611 size_t data_length )
612{
613 psa_status_t status;
614 uint8_t* output = NULL;
Steven Cooremana2371e52020-07-28 14:30:39 +0200615 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +0200616
Steven Cooremana01795d2020-07-24 22:48:15 +0200617 /* Parse input */
Ronald Cron90857082020-11-25 14:58:33 +0100618 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
619 data,
620 data_length,
621 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +0200622 if( status != PSA_SUCCESS )
623 goto exit;
624
625 slot->attr.bits = (psa_key_bits_t) PSA_BYTES_TO_BITS(
Steven Cooremana2371e52020-07-28 14:30:39 +0200626 mbedtls_rsa_get_len( rsa ) );
Steven Cooremana01795d2020-07-24 22:48:15 +0200627
Steven Cooreman75b74362020-07-28 14:30:13 +0200628 /* Re-export the data to PSA export format, such that we can store export
629 * representation in the key slot. Export representation in case of RSA is
630 * the smallest representation that's allowed as input, so a straight-up
631 * allocation of the same size as the input buffer will be large enough. */
Steven Cooremana01795d2020-07-24 22:48:15 +0200632 output = mbedtls_calloc( 1, data_length );
Steven Cooremana01795d2020-07-24 22:48:15 +0200633 if( output == NULL )
634 {
635 status = PSA_ERROR_INSUFFICIENT_MEMORY;
636 goto exit;
637 }
638
Ronald Cron3c8ca3a2020-11-26 16:45:24 +0100639 status = mbedtls_psa_rsa_export_key( slot->attr.type,
640 rsa,
641 output,
642 data_length,
643 &data_length);
Steven Cooremana01795d2020-07-24 22:48:15 +0200644exit:
645 /* Always free the RSA object */
Steven Cooremana2371e52020-07-28 14:30:39 +0200646 mbedtls_rsa_free( rsa );
Steven Cooreman6d839f02020-07-30 11:36:45 +0200647 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +0200648
649 /* Free the allocated buffer only on error. */
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000650 if( status != PSA_SUCCESS )
651 {
Steven Cooremana01795d2020-07-24 22:48:15 +0200652 mbedtls_free( output );
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000653 return( status );
654 }
655
Steven Cooremana01795d2020-07-24 22:48:15 +0200656 /* On success, store the allocated export-formatted key. */
Ronald Cronea0f8a62020-11-25 17:52:23 +0100657 slot->key.data = output;
658 slot->key.bytes = data_length;
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000659
660 return( PSA_SUCCESS );
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200661}
John Durkop6ba40d12020-11-10 08:50:04 -0800662
663#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -0800664 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200665
John Durkop9814fa22020-11-04 12:28:15 -0800666#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
John Durkop6ba40d12020-11-10 08:50:04 -0800667 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Steven Cooreman4fed4552020-08-03 14:46:03 +0200668/** Export an ECP key to export representation
669 *
670 * \param[in] type The type of key (public/private) to export
671 * \param[in] ecp The internal ECP representation from which to export
672 * \param[out] data The buffer to export to
673 * \param[in] data_size The length of the buffer to export to
674 * \param[out] data_length The amount of bytes written to \p data
675 */
Ronald Cron3c8ca3a2020-11-26 16:45:24 +0100676static psa_status_t mbedtls_psa_ecp_export_key( psa_key_type_t type,
677 mbedtls_ecp_keypair *ecp,
678 uint8_t *data,
679 size_t data_size,
680 size_t *data_length )
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200681{
Steven Cooremanacda8342020-07-24 23:09:52 +0200682 psa_status_t status;
Jaeden Ameroccdce902019-01-10 11:42:27 +0000683
Steven Cooremanacda8342020-07-24 23:09:52 +0200684 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) )
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200685 {
Steven Cooremanacda8342020-07-24 23:09:52 +0200686 /* Check whether the public part is loaded */
687 if( mbedtls_ecp_is_zero( &ecp->Q ) )
688 {
689 /* Calculate the public key */
690 status = mbedtls_to_psa_error(
691 mbedtls_ecp_mul( &ecp->grp, &ecp->Q, &ecp->d, &ecp->grp.G,
Gilles Peskine5894e8e2020-12-14 14:54:06 +0100692 mbedtls_psa_get_random, MBEDTLS_PSA_RANDOM_STATE ) );
Steven Cooremanacda8342020-07-24 23:09:52 +0200693 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +0200694 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +0200695 }
696
Steven Cooreman4fed4552020-08-03 14:46:03 +0200697 status = mbedtls_to_psa_error(
Steven Cooremanacda8342020-07-24 23:09:52 +0200698 mbedtls_ecp_point_write_binary( &ecp->grp, &ecp->Q,
699 MBEDTLS_ECP_PF_UNCOMPRESSED,
700 data_length,
701 data,
Steven Cooreman4fed4552020-08-03 14:46:03 +0200702 data_size ) );
Steven Cooreman4fed4552020-08-03 14:46:03 +0200703 if( status != PSA_SUCCESS )
704 memset( data, 0, data_size );
705
Steven Cooreman29149862020-08-05 15:43:42 +0200706 return( status );
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200707 }
Steven Cooremanacda8342020-07-24 23:09:52 +0200708 else
709 {
Steven Cooreman29149862020-08-05 15:43:42 +0200710 if( data_size < PSA_BITS_TO_BYTES( ecp->grp.nbits ) )
Steven Cooremanacda8342020-07-24 23:09:52 +0200711 return( PSA_ERROR_BUFFER_TOO_SMALL );
712
713 status = mbedtls_to_psa_error(
714 mbedtls_ecp_write_key( ecp,
715 data,
Steven Cooreman29149862020-08-05 15:43:42 +0200716 PSA_BITS_TO_BYTES( ecp->grp.nbits ) ) );
Steven Cooremanacda8342020-07-24 23:09:52 +0200717 if( status == PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +0200718 *data_length = PSA_BITS_TO_BYTES( ecp->grp.nbits );
Steven Cooremanb7f6dea2020-08-05 16:07:20 +0200719 else
720 memset( data, 0, data_size );
Steven Cooremanacda8342020-07-24 23:09:52 +0200721
722 return( status );
723 }
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200724}
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200725
Steven Cooreman4fed4552020-08-03 14:46:03 +0200726/** Import an ECP key from import representation to a slot
727 *
728 * \param[in,out] slot The slot where to store the export representation to
729 * \param[in] data The buffer containing the import representation
730 * \param[in] data_length The amount of bytes in \p data
731 */
Steven Cooremanacda8342020-07-24 23:09:52 +0200732static psa_status_t psa_import_ecp_key( psa_key_slot_t *slot,
733 const uint8_t *data,
734 size_t data_length )
Gilles Peskinef76aa772018-10-29 19:24:33 +0100735{
Steven Cooremanacda8342020-07-24 23:09:52 +0200736 psa_status_t status;
737 uint8_t* output = NULL;
Steven Cooremana2371e52020-07-28 14:30:39 +0200738 mbedtls_ecp_keypair *ecp = NULL;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100739
Steven Cooremanacda8342020-07-24 23:09:52 +0200740 /* Parse input */
Ronald Cron90857082020-11-25 14:58:33 +0100741 status = mbedtls_psa_ecp_load_representation( slot->attr.type,
742 data,
743 data_length,
744 &ecp );
Gilles Peskinef76aa772018-10-29 19:24:33 +0100745 if( status != PSA_SUCCESS )
746 goto exit;
Gilles Peskine4cd32772019-12-02 20:49:42 +0100747
Steven Cooremanacda8342020-07-24 23:09:52 +0200748 if( PSA_KEY_TYPE_ECC_GET_FAMILY( slot->attr.type ) == PSA_ECC_FAMILY_MONTGOMERY)
Steven Cooremana2371e52020-07-28 14:30:39 +0200749 slot->attr.bits = (psa_key_bits_t) ecp->grp.nbits + 1;
Steven Cooremanacda8342020-07-24 23:09:52 +0200750 else
Steven Cooremana2371e52020-07-28 14:30:39 +0200751 slot->attr.bits = (psa_key_bits_t) ecp->grp.nbits;
Steven Cooremane3fd3922020-06-11 16:50:36 +0200752
Steven Cooremanacda8342020-07-24 23:09:52 +0200753 /* Re-export the data to PSA export format. There is currently no support
754 * for other input formats then the export format, so this is a 1-1
755 * copy operation. */
756 output = mbedtls_calloc( 1, data_length );
Steven Cooremanacda8342020-07-24 23:09:52 +0200757 if( output == NULL )
758 {
759 status = PSA_ERROR_INSUFFICIENT_MEMORY;
760 goto exit;
761 }
762
Ronald Cron3c8ca3a2020-11-26 16:45:24 +0100763 status = mbedtls_psa_ecp_export_key( slot->attr.type,
764 ecp,
765 output,
766 data_length,
767 &data_length);
Gilles Peskinef76aa772018-10-29 19:24:33 +0100768exit:
Steven Cooremana2371e52020-07-28 14:30:39 +0200769 /* Always free the PK object (will also free contained ECP context) */
770 mbedtls_ecp_keypair_free( ecp );
Steven Cooreman6d839f02020-07-30 11:36:45 +0200771 mbedtls_free( ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +0200772
773 /* Free the allocated buffer only on error. */
774 if( status != PSA_SUCCESS )
Gilles Peskinef76aa772018-10-29 19:24:33 +0100775 {
Steven Cooremanacda8342020-07-24 23:09:52 +0200776 mbedtls_free( output );
Steven Cooremanacda8342020-07-24 23:09:52 +0200777 return( status );
Gilles Peskinef76aa772018-10-29 19:24:33 +0100778 }
Steven Cooremanacda8342020-07-24 23:09:52 +0200779
780 /* On success, store the allocated export-formatted key. */
Ronald Cronea0f8a62020-11-25 17:52:23 +0100781 slot->key.data = output;
782 slot->key.bytes = data_length;
Steven Cooremanacda8342020-07-24 23:09:52 +0200783
784 return( PSA_SUCCESS );
Gilles Peskinef76aa772018-10-29 19:24:33 +0100785}
John Durkop9814fa22020-11-04 12:28:15 -0800786#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
787 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Gilles Peskinef76aa772018-10-29 19:24:33 +0100788
Gilles Peskineb46bef22019-07-30 21:32:04 +0200789/** Return the size of the key in the given slot, in bits.
790 *
791 * \param[in] slot A key slot.
792 *
793 * \return The key size in bits, read from the metadata in the slot.
794 */
795static inline size_t psa_get_key_slot_bits( const psa_key_slot_t *slot )
796{
797 return( slot->attr.bits );
798}
799
Steven Cooreman75b74362020-07-28 14:30:13 +0200800/** Try to allocate a buffer to an empty key slot.
801 *
802 * \param[in,out] slot Key slot to attach buffer to.
803 * \param[in] buffer_length Requested size of the buffer.
804 *
805 * \retval #PSA_SUCCESS
806 * The buffer has been successfully allocated.
807 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
808 * Not enough memory was available for allocation.
809 * \retval #PSA_ERROR_ALREADY_EXISTS
810 * Trying to allocate a buffer to a non-empty key slot.
811 */
812static psa_status_t psa_allocate_buffer_to_slot( psa_key_slot_t *slot,
813 size_t buffer_length )
814{
Ronald Cronea0f8a62020-11-25 17:52:23 +0100815 if( slot->key.data != NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200816 return( PSA_ERROR_ALREADY_EXISTS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200817
Ronald Cronea0f8a62020-11-25 17:52:23 +0100818 slot->key.data = mbedtls_calloc( 1, buffer_length );
819 if( slot->key.data == NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200820 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Steven Cooreman75b74362020-07-28 14:30:13 +0200821
Ronald Cronea0f8a62020-11-25 17:52:23 +0100822 slot->key.bytes = buffer_length;
Steven Cooreman29149862020-08-05 15:43:42 +0200823 return( PSA_SUCCESS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200824}
825
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200826psa_status_t psa_copy_key_material_into_slot( psa_key_slot_t *slot,
827 const uint8_t* data,
828 size_t data_length )
829{
830 psa_status_t status = psa_allocate_buffer_to_slot( slot,
831 data_length );
832 if( status != PSA_SUCCESS )
833 return( status );
834
Ronald Cronea0f8a62020-11-25 17:52:23 +0100835 memcpy( slot->key.data, data, data_length );
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200836 return( PSA_SUCCESS );
837}
838
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200839/** Import key data into a slot.
840 *
841 * `slot->type` must have been set previously.
842 * This function assumes that the slot does not contain any key material yet.
843 * On failure, the slot content is unchanged.
844 *
845 * Persistent storage is not affected.
846 *
847 * \param[in,out] slot The key slot to import data into.
848 * Its `type` field must have previously been set to
849 * the desired key type.
850 * It must not contain any key material yet.
851 * \param[in] data Buffer containing the key material to parse and import.
852 * \param data_length Size of \p data in bytes.
853 *
854 * \retval #PSA_SUCCESS
855 * \retval #PSA_ERROR_INVALID_ARGUMENT
856 * \retval #PSA_ERROR_NOT_SUPPORTED
857 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
858 */
859static psa_status_t psa_import_key_into_slot( psa_key_slot_t *slot,
860 const uint8_t *data,
861 size_t data_length )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100862{
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200863 psa_status_t status = PSA_SUCCESS;
Steven Cooreman04524762020-10-13 17:43:44 +0200864 size_t bit_size;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100865
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200866 /* zero-length keys are never supported. */
867 if( data_length == 0 )
868 return( PSA_ERROR_NOT_SUPPORTED );
869
Gilles Peskine8e338702019-07-30 20:06:31 +0200870 if( key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100871 {
Steven Cooreman04524762020-10-13 17:43:44 +0200872 bit_size = PSA_BYTES_TO_BITS( data_length );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200873
Steven Cooreman75b74362020-07-28 14:30:13 +0200874 /* Ensure that the bytes-to-bits conversion hasn't overflown. */
875 if( data_length > SIZE_MAX / 8 )
876 return( PSA_ERROR_NOT_SUPPORTED );
877
Gilles Peskine1b9505c2019-08-07 10:59:45 +0200878 /* Enforce a size limit, and in particular ensure that the bit
879 * size fits in its representation type. */
Gilles Peskinec744d992019-07-30 17:26:54 +0200880 if( bit_size > PSA_MAX_KEY_BITS )
881 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200882
883 status = validate_unstructured_key_bit_size( slot->attr.type, bit_size );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200884 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +0200885 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200886
887 /* Allocate memory for the key */
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200888 status = psa_copy_key_material_into_slot( slot, data, data_length );
Steven Cooreman75b74362020-07-28 14:30:13 +0200889 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +0200890 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200891
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200892 /* Write the actual key size to the slot.
893 * psa_start_key_creation() wrote the size declared by the
894 * caller, which may be 0 (meaning unspecified) or wrong. */
895 slot->attr.bits = (psa_key_bits_t) bit_size;
Steven Cooreman40120f62020-10-29 11:42:22 +0100896
897 return( PSA_SUCCESS );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100898 }
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200899 else if( PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
Steven Cooreman19fd5742020-07-24 23:31:01 +0200900 {
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200901 /* Try validation through accelerators first. */
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200902 psa_key_attributes_t attributes = {
903 .core = slot->attr
904 };
Ronald Cron83282872020-11-22 14:02:39 +0100905
906 status = psa_allocate_buffer_to_slot( slot, data_length );
907 if( status != PSA_SUCCESS )
908 return( status );
909
910 bit_size = slot->attr.bits;
911 status = psa_driver_wrapper_import_key( &attributes,
912 data, data_length,
913 slot->key.data,
914 slot->key.bytes,
915 &slot->key.bytes,
916 &bit_size );
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200917 if( status == PSA_SUCCESS )
918 {
Ronald Cron83282872020-11-22 14:02:39 +0100919 if( slot->attr.bits == 0 )
920 slot->attr.bits = (psa_key_bits_t) bit_size;
921 else if( bit_size != slot->attr.bits )
922 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200923
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200924 return( PSA_SUCCESS );
925 }
Ronald Cron83282872020-11-22 14:02:39 +0100926 else
927 {
928 if( status != PSA_ERROR_NOT_SUPPORTED )
929 return( status );
930 }
931
932 mbedtls_platform_zeroize( slot->key.data, data_length );
933 mbedtls_free( slot->key.data );
934 slot->key.data = NULL;
935 slot->key.bytes = 0;
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200936
937 /* Key format is not supported by any accelerator, try software fallback
938 * if present. */
John Durkop9814fa22020-11-04 12:28:15 -0800939#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
940 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200941 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
942 {
Steven Cooreman40120f62020-10-29 11:42:22 +0100943 return( psa_import_ecp_key( slot, data, data_length ) );
944 }
John Durkop9814fa22020-11-04 12:28:15 -0800945#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
946 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
John Durkop0e005192020-10-31 22:06:54 -0700947#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
948 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Steven Cooreman40120f62020-10-29 11:42:22 +0100949 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200950 {
Steven Cooreman40120f62020-10-29 11:42:22 +0100951 return( psa_import_rsa_key( slot, data, data_length ) );
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200952 }
John Durkop9814fa22020-11-04 12:28:15 -0800953#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
954 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Steven Cooreman40120f62020-10-29 11:42:22 +0100955
956 /* Fell through the fallback as well, so have nothing else to try. */
957 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100958 }
959 else
Gilles Peskinec66ea6a2018-02-03 22:43:28 +0100960 {
Steven Cooreman19fd5742020-07-24 23:31:01 +0200961 /* Unknown key type */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100962 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969ac722018-01-28 18:16:59 +0100963 }
Darryl Green06fd18d2018-07-16 11:21:11 +0100964}
965
Gilles Peskinef603c712019-01-19 13:40:11 +0100966/** Calculate the intersection of two algorithm usage policies.
967 *
968 * Return 0 (which allows no operation) on incompatibility.
969 */
970static psa_algorithm_t psa_key_policy_algorithm_intersection(
971 psa_algorithm_t alg1,
972 psa_algorithm_t alg2 )
973{
Gilles Peskine549ea862019-05-22 11:45:59 +0200974 /* Common case: both sides actually specify the same policy. */
Gilles Peskinef603c712019-01-19 13:40:11 +0100975 if( alg1 == alg2 )
976 return( alg1 );
977 /* If the policies are from the same hash-and-sign family, check
978 * if one is a wildcard. If so the other has the specific algorithm. */
979 if( PSA_ALG_IS_HASH_AND_SIGN( alg1 ) &&
980 PSA_ALG_IS_HASH_AND_SIGN( alg2 ) &&
981 ( alg1 & ~PSA_ALG_HASH_MASK ) == ( alg2 & ~PSA_ALG_HASH_MASK ) )
982 {
983 if( PSA_ALG_SIGN_GET_HASH( alg1 ) == PSA_ALG_ANY_HASH )
984 return( alg2 );
985 if( PSA_ALG_SIGN_GET_HASH( alg2 ) == PSA_ALG_ANY_HASH )
986 return( alg1 );
987 }
988 /* If the policies are incompatible, allow nothing. */
989 return( 0 );
990}
991
Gilles Peskined6f371b2019-05-10 19:33:38 +0200992static int psa_key_algorithm_permits( psa_algorithm_t policy_alg,
993 psa_algorithm_t requested_alg )
994{
Gilles Peskine549ea862019-05-22 11:45:59 +0200995 /* Common case: the policy only allows requested_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200996 if( requested_alg == policy_alg )
997 return( 1 );
998 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
Gilles Peskine549ea862019-05-22 11:45:59 +0200999 * and requested_alg is the same hash-and-sign family with any hash,
1000 * then requested_alg is compliant with policy_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +02001001 if( PSA_ALG_IS_HASH_AND_SIGN( requested_alg ) &&
1002 PSA_ALG_SIGN_GET_HASH( policy_alg ) == PSA_ALG_ANY_HASH )
1003 {
1004 return( ( policy_alg & ~PSA_ALG_HASH_MASK ) ==
1005 ( requested_alg & ~PSA_ALG_HASH_MASK ) );
1006 }
Steven Cooremance48e852020-10-05 16:02:45 +02001007 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +02001008 * a key derivation with that key agreement should also be allowed. This
1009 * behaviour is expected to be defined in a future specification version. */
Steven Cooremance48e852020-10-05 16:02:45 +02001010 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( policy_alg ) &&
1011 PSA_ALG_IS_KEY_AGREEMENT( requested_alg ) )
1012 {
1013 return( PSA_ALG_KEY_AGREEMENT_GET_BASE( requested_alg ) ==
1014 policy_alg );
1015 }
Gilles Peskined6f371b2019-05-10 19:33:38 +02001016 /* If it isn't permitted, it's forbidden. */
1017 return( 0 );
1018}
1019
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001020/** Test whether a policy permits an algorithm.
1021 *
1022 * The caller must test usage flags separately.
1023 */
1024static int psa_key_policy_permits( const psa_key_policy_t *policy,
1025 psa_algorithm_t alg )
1026{
Gilles Peskined6f371b2019-05-10 19:33:38 +02001027 return( psa_key_algorithm_permits( policy->alg, alg ) ||
1028 psa_key_algorithm_permits( policy->alg2, alg ) );
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001029}
1030
Gilles Peskinef603c712019-01-19 13:40:11 +01001031/** Restrict a key policy based on a constraint.
1032 *
1033 * \param[in,out] policy The policy to restrict.
1034 * \param[in] constraint The policy constraint to apply.
1035 *
1036 * \retval #PSA_SUCCESS
1037 * \c *policy contains the intersection of the original value of
1038 * \c *policy and \c *constraint.
1039 * \retval #PSA_ERROR_INVALID_ARGUMENT
1040 * \c *policy and \c *constraint are incompatible.
1041 * \c *policy is unchanged.
1042 */
1043static psa_status_t psa_restrict_key_policy(
1044 psa_key_policy_t *policy,
1045 const psa_key_policy_t *constraint )
1046{
1047 psa_algorithm_t intersection_alg =
1048 psa_key_policy_algorithm_intersection( policy->alg, constraint->alg );
Gilles Peskined6f371b2019-05-10 19:33:38 +02001049 psa_algorithm_t intersection_alg2 =
1050 psa_key_policy_algorithm_intersection( policy->alg2, constraint->alg2 );
Gilles Peskinef603c712019-01-19 13:40:11 +01001051 if( intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0 )
1052 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskined6f371b2019-05-10 19:33:38 +02001053 if( intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0 )
1054 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinef603c712019-01-19 13:40:11 +01001055 policy->usage &= constraint->usage;
1056 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +02001057 policy->alg2 = intersection_alg2;
Gilles Peskinef603c712019-01-19 13:40:11 +01001058 return( PSA_SUCCESS );
1059}
1060
Ronald Cron5c522922020-11-14 16:35:34 +01001061/** Get the description of a key given its identifier and policy constraints
1062 * and lock it.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001063 *
Ronald Cron5c522922020-11-14 16:35:34 +01001064 * The key must have allow all the usage flags set in \p usage. If \p alg is
1065 * nonzero, the key must allow operations with this algorithm.
Ronald Cron7587ae42020-11-11 15:04:25 +01001066 *
Ronald Cron5c522922020-11-14 16:35:34 +01001067 * In case of a persistent key, the function loads the description of the key
1068 * into a key slot if not already done.
1069 *
1070 * On success, the returned key slot is locked. It is the responsibility of
1071 * the caller to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001072 */
Ronald Cron5c522922020-11-14 16:35:34 +01001073static psa_status_t psa_get_and_lock_key_slot_with_policy(
1074 mbedtls_svc_key_id_t key,
1075 psa_key_slot_t **p_slot,
1076 psa_key_usage_t usage,
1077 psa_algorithm_t alg )
Darryl Green06fd18d2018-07-16 11:21:11 +01001078{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001079 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1080 psa_key_slot_t *slot;
Darryl Green06fd18d2018-07-16 11:21:11 +01001081
Ronald Cron5c522922020-11-14 16:35:34 +01001082 status = psa_get_and_lock_key_slot( key, p_slot );
Darryl Green06fd18d2018-07-16 11:21:11 +01001083 if( status != PSA_SUCCESS )
1084 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001085 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +01001086
1087 /* Enforce that usage policy for the key slot contains all the flags
1088 * required by the usage parameter. There is one exception: public
1089 * keys can always be exported, so we treat public key objects as
1090 * if they had the export flag. */
Gilles Peskine8e338702019-07-30 20:06:31 +02001091 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Darryl Green06fd18d2018-07-16 11:21:11 +01001092 usage &= ~PSA_KEY_USAGE_EXPORT;
Ronald Cronf95a2b12020-10-22 15:24:49 +02001093
1094 status = PSA_ERROR_NOT_PERMITTED;
Gilles Peskine8e338702019-07-30 20:06:31 +02001095 if( ( slot->attr.policy.usage & usage ) != usage )
Ronald Cronf95a2b12020-10-22 15:24:49 +02001096 goto error;
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001097
1098 /* Enforce that the usage policy permits the requested algortihm. */
Gilles Peskine8e338702019-07-30 20:06:31 +02001099 if( alg != 0 && ! psa_key_policy_permits( &slot->attr.policy, alg ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02001100 goto error;
Darryl Green06fd18d2018-07-16 11:21:11 +01001101
Darryl Green06fd18d2018-07-16 11:21:11 +01001102 return( PSA_SUCCESS );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001103
1104error:
1105 *p_slot = NULL;
Ronald Cron5c522922020-11-14 16:35:34 +01001106 psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001107
1108 return( status );
Darryl Green06fd18d2018-07-16 11:21:11 +01001109}
Darryl Green940d72c2018-07-13 13:18:51 +01001110
Ronald Cron5c522922020-11-14 16:35:34 +01001111/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001112 *
1113 * A transparent key is a key for which the key material is directly
1114 * available, as opposed to a key in a secure element.
1115 *
Ronald Cron5c522922020-11-14 16:35:34 +01001116 * This is a temporary function to use instead of
1117 * psa_get_and_lock_key_slot_with_policy() until secure element support is
1118 * fully implemented.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001119 *
Ronald Cron5c522922020-11-14 16:35:34 +01001120 * On success, the returned key slot is locked. It is the responsibility of the
1121 * caller to unlock the key slot when it does not access it anymore.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001122 */
1123#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Ronald Cron5c522922020-11-14 16:35:34 +01001124static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
1125 mbedtls_svc_key_id_t key,
1126 psa_key_slot_t **p_slot,
1127 psa_key_usage_t usage,
1128 psa_algorithm_t alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +02001129{
Ronald Cron5c522922020-11-14 16:35:34 +01001130 psa_status_t status = psa_get_and_lock_key_slot_with_policy( key, p_slot,
1131 usage, alg );
Gilles Peskine28f8f302019-07-24 13:30:31 +02001132 if( status != PSA_SUCCESS )
1133 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001134
Gilles Peskineadad8132019-07-25 11:31:23 +02001135 if( psa_key_slot_is_external( *p_slot ) )
Gilles Peskine28f8f302019-07-24 13:30:31 +02001136 {
Ronald Cron5c522922020-11-14 16:35:34 +01001137 psa_unlock_key_slot( *p_slot );
Gilles Peskine28f8f302019-07-24 13:30:31 +02001138 *p_slot = NULL;
1139 return( PSA_ERROR_NOT_SUPPORTED );
1140 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001141
Gilles Peskine28f8f302019-07-24 13:30:31 +02001142 return( PSA_SUCCESS );
1143}
1144#else /* MBEDTLS_PSA_CRYPTO_SE_C */
1145/* With no secure element support, all keys are transparent. */
Ronald Cron5c522922020-11-14 16:35:34 +01001146#define psa_get_and_lock_transparent_key_slot_with_policy( key, p_slot, usage, alg ) \
1147 psa_get_and_lock_key_slot_with_policy( key, p_slot, usage, alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +02001148#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1149
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001150/** Wipe key data from a slot. Preserve metadata such as the policy. */
Gilles Peskine2f060a82018-12-04 17:12:32 +01001151static psa_status_t psa_remove_key_data_from_memory( psa_key_slot_t *slot )
Darryl Green40225ba2018-11-15 14:48:15 +00001152{
Ronald Cronea0f8a62020-11-25 17:52:23 +01001153 /* Data pointer will always be either a valid pointer or NULL in an
1154 * initialized slot, so we can just free it. */
1155 if( slot->key.data != NULL )
1156 mbedtls_platform_zeroize( slot->key.data, slot->key.bytes);
1157
1158 mbedtls_free( slot->key.data );
1159 slot->key.data = NULL;
1160 slot->key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +00001161
1162 return( PSA_SUCCESS );
1163}
1164
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001165/** Completely wipe a slot in memory, including its policy.
1166 * Persistent storage is not affected. */
Gilles Peskine66fb1262018-12-10 16:29:04 +01001167psa_status_t psa_wipe_key_slot( psa_key_slot_t *slot )
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001168{
1169 psa_status_t status = psa_remove_key_data_from_memory( slot );
Ronald Cronddd3d052020-10-30 14:07:07 +01001170
1171 /*
1172 * As the return error code may not be handled in case of multiple errors,
Ronald Cron5c522922020-11-14 16:35:34 +01001173 * do our best to report an unexpected lock counter: if available
Ronald Cronddd3d052020-10-30 14:07:07 +01001174 * call MBEDTLS_PARAM_FAILED that may terminate execution (if called as
1175 * part of the execution of a test suite this will stop the test suite
Ronald Cron4640c152020-11-13 10:11:01 +01001176 * execution).
Ronald Cronddd3d052020-10-30 14:07:07 +01001177 */
Ronald Cron5c522922020-11-14 16:35:34 +01001178 if( slot->lock_count != 1 )
Ronald Cronddd3d052020-10-30 14:07:07 +01001179 {
1180#ifdef MBEDTLS_CHECK_PARAMS
Ronald Cron5c522922020-11-14 16:35:34 +01001181 MBEDTLS_PARAM_FAILED( slot->lock_count == 1 );
Ronald Cronddd3d052020-10-30 14:07:07 +01001182#endif
Ronald Cronddd3d052020-10-30 14:07:07 +01001183 status = PSA_ERROR_CORRUPTION_DETECTED;
1184 }
1185
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001186 /* Multipart operations may still be using the key. This is safe
1187 * because all multipart operation objects are independent from
1188 * the key slot: if they need to access the key after the setup
1189 * phase, they have a copy of the key. Note that this means that
1190 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001191 /* At this point, key material and other type-specific content has
1192 * been wiped. Clear remaining metadata. We can call memset and not
1193 * zeroize because the metadata is not particularly sensitive. */
1194 memset( slot, 0, sizeof( *slot ) );
1195 return( status );
1196}
1197
Ronald Croncf56a0a2020-08-04 09:51:30 +02001198psa_status_t psa_destroy_key( mbedtls_svc_key_id_t key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001199{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001200 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001201 psa_status_t status; /* status of the last operation */
1202 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001203#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1204 psa_se_drv_table_entry_t *driver;
1205#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001206
Ronald Croncf56a0a2020-08-04 09:51:30 +02001207 if( mbedtls_svc_key_id_is_null( key ) )
Gilles Peskine1841cf42019-10-08 15:48:25 +02001208 return( PSA_SUCCESS );
1209
Ronald Cronf2911112020-10-29 17:51:10 +01001210 /*
Ronald Cron19daca92020-11-10 18:08:03 +01001211 * Get the description of the key in a key slot. In case of a persistent
Ronald Cronf2911112020-10-29 17:51:10 +01001212 * key, this will load the key description from persistent memory if not
1213 * done yet. We cannot avoid this loading as without it we don't know if
1214 * the key is operated by an SE or not and this information is needed by
1215 * the current implementation.
1216 */
Ronald Cron5c522922020-11-14 16:35:34 +01001217 status = psa_get_and_lock_key_slot( key, &slot );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001218 if( status != PSA_SUCCESS )
1219 return( status );
Gilles Peskine354f7672019-07-12 23:46:38 +02001220
Ronald Cronf2911112020-10-29 17:51:10 +01001221 /*
1222 * If the key slot containing the key description is under access by the
1223 * library (apart from the present access), the key cannot be destroyed
1224 * yet. For the time being, just return in error. Eventually (to be
1225 * implemented), the key should be destroyed when all accesses have
1226 * stopped.
1227 */
Ronald Cron5c522922020-11-14 16:35:34 +01001228 if( slot->lock_count > 1 )
Ronald Cronf2911112020-10-29 17:51:10 +01001229 {
Ronald Cron5c522922020-11-14 16:35:34 +01001230 psa_unlock_key_slot( slot );
Ronald Cronf2911112020-10-29 17:51:10 +01001231 return( PSA_ERROR_GENERIC_ERROR );
1232 }
1233
Gilles Peskine354f7672019-07-12 23:46:38 +02001234#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001235 driver = psa_get_se_driver_entry( slot->attr.lifetime );
Gilles Peskine354f7672019-07-12 23:46:38 +02001236 if( driver != NULL )
Gilles Peskinefc762652019-07-22 19:30:34 +02001237 {
Gilles Peskine60450a42019-07-25 11:32:45 +02001238 /* For a key in a secure element, we need to do three things:
1239 * remove the key file in internal storage, destroy the
1240 * key inside the secure element, and update the driver's
1241 * persistent data. Start a transaction that will encompass these
1242 * three actions. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001243 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_DESTROY_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +02001244 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001245 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +02001246 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskinefc762652019-07-22 19:30:34 +02001247 status = psa_crypto_save_transaction( );
1248 if( status != PSA_SUCCESS )
1249 {
Gilles Peskine66be51c2019-07-25 18:02:52 +02001250 (void) psa_crypto_stop_transaction( );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001251 /* We should still try to destroy the key in the secure
1252 * element and the key metadata in storage. This is especially
1253 * important if the error is that the storage is full.
1254 * But how to do it exactly without risking an inconsistent
1255 * state after a reset?
1256 * https://github.com/ARMmbed/mbed-crypto/issues/215
1257 */
1258 overall_status = status;
1259 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001260 }
1261
Ronald Cronea0f8a62020-11-25 17:52:23 +01001262 status = psa_destroy_se_key( driver,
1263 psa_key_slot_get_slot_number( slot ) );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001264 if( overall_status == PSA_SUCCESS )
1265 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001266 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001267#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1268
Darryl Greend49a4992018-06-18 17:27:26 +01001269#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Ronald Crond98059d2020-10-23 18:00:55 +02001270 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Darryl Greend49a4992018-06-18 17:27:26 +01001271 {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001272 status = psa_destroy_persistent_key( slot->attr.id );
1273 if( overall_status == PSA_SUCCESS )
1274 overall_status = status;
1275
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001276 /* TODO: other slots may have a copy of the same key. We should
1277 * invalidate them.
1278 * https://github.com/ARMmbed/mbed-crypto/issues/214
1279 */
Darryl Greend49a4992018-06-18 17:27:26 +01001280 }
1281#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001282
Gilles Peskinefc762652019-07-22 19:30:34 +02001283#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1284 if( driver != NULL )
1285 {
Gilles Peskine725f22a2019-07-25 11:31:48 +02001286 status = psa_save_se_persistent_data( driver );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001287 if( overall_status == PSA_SUCCESS )
1288 overall_status = status;
1289 status = psa_crypto_stop_transaction( );
1290 if( overall_status == PSA_SUCCESS )
1291 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001292 }
1293#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1294
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001295#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1296exit:
1297#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001298 status = psa_wipe_key_slot( slot );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001299 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
1300 if( overall_status == PSA_SUCCESS )
1301 overall_status = status;
1302 return( overall_status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001303}
1304
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001305void psa_reset_key_attributes( psa_key_attributes_t *attributes )
Gilles Peskineb870b182018-07-06 16:02:09 +02001306{
Gilles Peskineb699f072019-04-26 16:06:02 +02001307 mbedtls_free( attributes->domain_parameters );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001308 memset( attributes, 0, sizeof( *attributes ) );
Gilles Peskineb870b182018-07-06 16:02:09 +02001309}
1310
Gilles Peskineb699f072019-04-26 16:06:02 +02001311psa_status_t psa_set_key_domain_parameters( psa_key_attributes_t *attributes,
1312 psa_key_type_t type,
1313 const uint8_t *data,
1314 size_t data_length )
1315{
1316 uint8_t *copy = NULL;
1317
1318 if( data_length != 0 )
1319 {
1320 copy = mbedtls_calloc( 1, data_length );
1321 if( copy == NULL )
1322 return( PSA_ERROR_INSUFFICIENT_MEMORY );
1323 memcpy( copy, data, data_length );
1324 }
1325 /* After this point, this function is guaranteed to succeed, so it
1326 * can start modifying `*attributes`. */
1327
1328 if( attributes->domain_parameters != NULL )
1329 {
1330 mbedtls_free( attributes->domain_parameters );
1331 attributes->domain_parameters = NULL;
1332 attributes->domain_parameters_size = 0;
1333 }
1334
1335 attributes->domain_parameters = copy;
1336 attributes->domain_parameters_size = data_length;
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001337 attributes->core.type = type;
Gilles Peskineb699f072019-04-26 16:06:02 +02001338 return( PSA_SUCCESS );
1339}
1340
1341psa_status_t psa_get_key_domain_parameters(
1342 const psa_key_attributes_t *attributes,
1343 uint8_t *data, size_t data_size, size_t *data_length )
1344{
1345 if( attributes->domain_parameters_size > data_size )
1346 return( PSA_ERROR_BUFFER_TOO_SMALL );
1347 *data_length = attributes->domain_parameters_size;
1348 if( attributes->domain_parameters_size != 0 )
1349 memcpy( data, attributes->domain_parameters,
1350 attributes->domain_parameters_size );
1351 return( PSA_SUCCESS );
1352}
1353
John Durkop07cc04a2020-11-16 22:08:34 -08001354#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001355 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001356static psa_status_t psa_get_rsa_public_exponent(
1357 const mbedtls_rsa_context *rsa,
1358 psa_key_attributes_t *attributes )
1359{
1360 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001361 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001362 uint8_t *buffer = NULL;
1363 size_t buflen;
1364 mbedtls_mpi_init( &mpi );
1365
1366 ret = mbedtls_rsa_export( rsa, NULL, NULL, NULL, NULL, &mpi );
1367 if( ret != 0 )
1368 goto exit;
Gilles Peskine772c8b12019-04-26 17:37:21 +02001369 if( mbedtls_mpi_cmp_int( &mpi, 65537 ) == 0 )
1370 {
1371 /* It's the default value, which is reported as an empty string,
1372 * so there's nothing to do. */
1373 goto exit;
1374 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001375
1376 buflen = mbedtls_mpi_size( &mpi );
1377 buffer = mbedtls_calloc( 1, buflen );
1378 if( buffer == NULL )
1379 {
1380 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1381 goto exit;
1382 }
1383 ret = mbedtls_mpi_write_binary( &mpi, buffer, buflen );
1384 if( ret != 0 )
1385 goto exit;
1386 attributes->domain_parameters = buffer;
1387 attributes->domain_parameters_size = buflen;
1388
1389exit:
1390 mbedtls_mpi_free( &mpi );
1391 if( ret != 0 )
1392 mbedtls_free( buffer );
1393 return( mbedtls_to_psa_error( ret ) );
1394}
John Durkop07cc04a2020-11-16 22:08:34 -08001395#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001396 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001397
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001398/** Retrieve all the publicly-accessible attributes of a key.
1399 */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001400psa_status_t psa_get_key_attributes( mbedtls_svc_key_id_t key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001401 psa_key_attributes_t *attributes )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001402{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001403 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001404 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001405 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001406
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001407 psa_reset_key_attributes( attributes );
1408
Ronald Cron5c522922020-11-14 16:35:34 +01001409 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001410 if( status != PSA_SUCCESS )
1411 return( status );
Gilles Peskineb870b182018-07-06 16:02:09 +02001412
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001413 attributes->core = slot->attr;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001414 attributes->core.flags &= ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1415 MBEDTLS_PSA_KA_MASK_DUAL_USE );
1416
1417#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1418 if( psa_key_slot_is_external( slot ) )
Ronald Cronea0f8a62020-11-25 17:52:23 +01001419 psa_set_key_slot_number( attributes,
1420 psa_key_slot_get_slot_number( slot ) );
Gilles Peskinec8000c02019-08-02 20:15:51 +02001421#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001422
Gilles Peskine8e338702019-07-30 20:06:31 +02001423 switch( slot->attr.type )
Gilles Peskineb699f072019-04-26 16:06:02 +02001424 {
John Durkop07cc04a2020-11-16 22:08:34 -08001425#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001426 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001427 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001428 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001429#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001430 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001431 * is not yet implemented.
1432 * https://github.com/ARMmbed/mbed-crypto/issues/216
1433 */
Gilles Peskinec8000c02019-08-02 20:15:51 +02001434 if( psa_key_slot_is_external( slot ) )
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001435 break;
1436#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Steven Cooremana01795d2020-07-24 22:48:15 +02001437 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001438 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001439
Ronald Cron90857082020-11-25 14:58:33 +01001440 status = mbedtls_psa_rsa_load_representation(
1441 slot->attr.type,
1442 slot->key.data,
1443 slot->key.bytes,
1444 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001445 if( status != PSA_SUCCESS )
1446 break;
1447
Steven Cooremana2371e52020-07-28 14:30:39 +02001448 status = psa_get_rsa_public_exponent( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02001449 attributes );
Steven Cooremana2371e52020-07-28 14:30:39 +02001450 mbedtls_rsa_free( rsa );
1451 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001452 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001453 break;
John Durkop07cc04a2020-11-16 22:08:34 -08001454#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001455 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001456 default:
1457 /* Nothing else to do. */
1458 break;
1459 }
1460
1461 if( status != PSA_SUCCESS )
1462 psa_reset_key_attributes( attributes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001463
Ronald Cron5c522922020-11-14 16:35:34 +01001464 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001465
Ronald Cron5c522922020-11-14 16:35:34 +01001466 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001467}
1468
Gilles Peskinec8000c02019-08-02 20:15:51 +02001469#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1470psa_status_t psa_get_key_slot_number(
1471 const psa_key_attributes_t *attributes,
1472 psa_key_slot_number_t *slot_number )
1473{
1474 if( attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER )
1475 {
1476 *slot_number = attributes->slot_number;
1477 return( PSA_SUCCESS );
1478 }
1479 else
1480 return( PSA_ERROR_INVALID_ARGUMENT );
1481}
1482#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1483
Ronald Crond18b5f82020-11-25 16:46:05 +01001484static psa_status_t psa_export_key_buffer_internal( const uint8_t *key_buffer,
1485 size_t key_buffer_size,
Steven Cooremana01795d2020-07-24 22:48:15 +02001486 uint8_t *data,
1487 size_t data_size,
1488 size_t *data_length )
1489{
Ronald Crond18b5f82020-11-25 16:46:05 +01001490 if( key_buffer_size > data_size )
Steven Cooremana01795d2020-07-24 22:48:15 +02001491 return( PSA_ERROR_BUFFER_TOO_SMALL );
Ronald Crond18b5f82020-11-25 16:46:05 +01001492 memcpy( data, key_buffer, key_buffer_size );
1493 memset( data + key_buffer_size, 0,
1494 data_size - key_buffer_size );
1495 *data_length = key_buffer_size;
Steven Cooremana01795d2020-07-24 22:48:15 +02001496 return( PSA_SUCCESS );
1497}
1498
Ronald Crond18b5f82020-11-25 16:46:05 +01001499/** Export a key in binary format
1500 *
1501 * \note The signature of this function is that of a PSA driver export_key
1502 * entry point. This function behaves as an export_key entry point as
1503 * defined in the PSA driver interface specification.
1504 *
1505 * \param[in] attributes The attributes for the key to export.
1506 * \param[in] key_buffer Material or context of the key to export.
1507 * \param[in] key_buffer_size Size of the \p key_buffer buffer in bytes.
1508 * \param[out] data Buffer where the key data is to be written.
1509 * \param[in] data_size Size of the \p data buffer in bytes.
1510 * \param[out] data_length On success, the number of bytes written in
1511 * \p data
1512 *
1513 * \retval #PSA_SUCCESS The key was exported successfully.
1514 * \retval #PSA_ERROR_NOT_SUPPORTED
1515 * \retval #PSA_ERROR_COMMUNICATION_FAILURE
1516 * \retval #PSA_ERROR_HARDWARE_FAILURE
1517 * \retval #PSA_ERROR_CORRUPTION_DETECTED
1518 * \retval #PSA_ERROR_STORAGE_FAILURE
1519 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
1520 */
1521static psa_status_t psa_export_key_internal(
1522 const psa_key_attributes_t *attributes,
1523 const uint8_t *key_buffer, size_t key_buffer_size,
1524 uint8_t *data, size_t data_size, size_t *data_length )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001525{
Ronald Crond18b5f82020-11-25 16:46:05 +01001526 psa_key_type_t type = attributes->core.type;
1527
Gilles Peskine5d309672019-07-12 23:47:28 +02001528#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1529 const psa_drv_se_t *drv;
1530 psa_drv_se_context_t *drv_context;
1531#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1532
Ronald Cron9486f9d2020-11-26 13:36:23 +01001533#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Ronald Crond18b5f82020-11-25 16:46:05 +01001534 if( psa_get_se_driver( attributes->core.lifetime, &drv, &drv_context ) )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001535 {
1536 if( ( drv->key_management == NULL ) ||
1537 ( drv->key_management->p_export == NULL ) )
1538 return( PSA_ERROR_NOT_SUPPORTED );
1539
1540 return( drv->key_management->p_export(
Ronald Crond18b5f82020-11-25 16:46:05 +01001541 drv_context,
1542 *( (psa_key_slot_number_t *)key_buffer ),
Ronald Cron9486f9d2020-11-26 13:36:23 +01001543 data, data_size, data_length ) );
1544 }
1545#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1546
Ronald Crond18b5f82020-11-25 16:46:05 +01001547 if( key_type_is_raw_bytes( type ) ||
1548 PSA_KEY_TYPE_IS_RSA( type ) ||
1549 PSA_KEY_TYPE_IS_ECC( type ) )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001550 {
1551 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001552 key_buffer, key_buffer_size,
1553 data, data_size, data_length ) );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001554 }
1555 else
1556 {
1557 /* This shouldn't happen in the reference implementation, but
1558 it is valid for a special-purpose implementation to omit
1559 support for exporting certain key types. */
1560 return( PSA_ERROR_NOT_SUPPORTED );
1561 }
1562}
1563
1564psa_status_t psa_export_key( mbedtls_svc_key_id_t key,
1565 uint8_t *data,
1566 size_t data_size,
1567 size_t *data_length )
1568{
1569 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1570 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1571 psa_key_slot_t *slot;
1572
1573 /* Set the key to empty now, so that even when there are errors, we always
1574 * set data_length to a value between 0 and data_size. On error, setting
1575 * the key to empty is a good choice because an empty key representation is
1576 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001577 *data_length = 0;
1578
Ronald Cron9486f9d2020-11-26 13:36:23 +01001579 /* Export requires the EXPORT flag. There is an exception for public keys,
1580 * which don't require any flag, but
1581 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1582 */
1583 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
1584 PSA_KEY_USAGE_EXPORT, 0 );
1585 if( status != PSA_SUCCESS )
1586 return( status );
mohammad160306e79202018-03-28 13:17:44 +03001587
Gilles Peskinef9168942019-09-12 19:20:29 +02001588 /* Reject a zero-length output buffer now, since this can never be a
1589 * valid key representation. This way we know that data must be a valid
1590 * pointer and we can do things like memset(data, ..., data_size). */
1591 if( data_size == 0 )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001592 {
1593 status = PSA_ERROR_BUFFER_TOO_SMALL;
1594 goto exit;
1595 }
1596
Ronald Crond18b5f82020-11-25 16:46:05 +01001597 psa_key_attributes_t attributes = {
1598 .core = slot->attr
1599 };
1600 status = psa_export_key_internal( &attributes,
1601 slot->key.data, slot->key.bytes,
1602 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001603
1604exit:
1605 unlock_status = psa_unlock_key_slot( slot );
1606
1607 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
1608}
1609
Ronald Crond18b5f82020-11-25 16:46:05 +01001610/** Export a public key or the public part of a key pair in binary format.
1611 *
1612 * \note The signature of this function is that of a PSA driver
1613 * export_public_key entry point. This function behaves as an
1614 * export_public_key entry point as defined in the PSA driver interface
1615 * specification.
1616 *
1617 * \param[in] attributes The attributes for the key to export.
1618 * \param[in] key_buffer Material or context of the key to export.
1619 * \param[in] key_buffer_size Size of the \p key_buffer buffer in bytes.
1620 * \param[out] data Buffer where the key data is to be written.
1621 * \param[in] data_size Size of the \p data buffer in bytes.
1622 * \param[out] data_length On success, the number of bytes written in
1623 * \p data
1624 *
1625 * \retval #PSA_SUCCESS The public key was exported successfully.
1626 * \retval #PSA_ERROR_NOT_SUPPORTED
1627 * \retval #PSA_ERROR_COMMUNICATION_FAILURE
1628 * \retval #PSA_ERROR_HARDWARE_FAILURE
1629 * \retval #PSA_ERROR_CORRUPTION_DETECTED
1630 * \retval #PSA_ERROR_STORAGE_FAILURE
1631 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
1632 */
1633static psa_status_t psa_export_public_key_internal(
1634 const psa_key_attributes_t *attributes,
1635 const uint8_t *key_buffer,
1636 size_t key_buffer_size,
1637 uint8_t *data,
1638 size_t data_size,
1639 size_t *data_length )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001640{
Ronald Crond18b5f82020-11-25 16:46:05 +01001641 psa_key_type_t type = attributes->core.type;
1642 psa_key_lifetime_t lifetime = attributes->core.lifetime;
1643
Ronald Cron9486f9d2020-11-26 13:36:23 +01001644#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1645 const psa_drv_se_t *drv;
1646 psa_drv_se_context_t *drv_context;
1647#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef9168942019-09-12 19:20:29 +02001648
Gilles Peskine5d309672019-07-12 23:47:28 +02001649#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Ronald Crond18b5f82020-11-25 16:46:05 +01001650 if( psa_get_se_driver( lifetime, &drv, &drv_context ) )
Gilles Peskine5d309672019-07-12 23:47:28 +02001651 {
Ronald Cron9486f9d2020-11-26 13:36:23 +01001652 if( ( drv->key_management == NULL ) ||
1653 ( drv->key_management->p_export_public == NULL ) )
Gilles Peskine5d309672019-07-12 23:47:28 +02001654 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine5d309672019-07-12 23:47:28 +02001655
Ronald Cron9486f9d2020-11-26 13:36:23 +01001656 return( drv->key_management->p_export_public(
Ronald Crond18b5f82020-11-25 16:46:05 +01001657 drv_context,
1658 *( (psa_key_slot_number_t *)key_buffer ),
Ronald Cron9486f9d2020-11-26 13:36:23 +01001659 data, data_size, data_length ) );
Gilles Peskine188c71e2018-10-29 19:26:02 +01001660 }
Ronald Cron9486f9d2020-11-26 13:36:23 +01001661 else
1662#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Ronald Crond18b5f82020-11-25 16:46:05 +01001663 if( PSA_KEY_TYPE_IS_RSA( type ) || PSA_KEY_TYPE_IS_ECC( type ) )
Moran Peker17e36e12018-05-02 12:55:20 +03001664 {
Ronald Crond18b5f82020-11-25 16:46:05 +01001665 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) )
Gilles Peskine969ac722018-01-28 18:16:59 +01001666 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001667 /* Exporting public -> public */
Ronald Cron9486f9d2020-11-26 13:36:23 +01001668 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001669 key_buffer, key_buffer_size,
1670 data, data_size, data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001671 }
Steven Cooremanb9b84422020-10-14 14:39:20 +02001672
Steven Cooreman560c28a2020-07-24 23:20:24 +02001673 /* Need to export the public part of a private key,
Steven Cooremanb9b84422020-10-14 14:39:20 +02001674 * so conversion is needed. Try the accelerators first. */
Ronald Cron84cc9942020-11-25 14:30:05 +01001675 psa_status_t status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001676 attributes, key_buffer, key_buffer_size,
Ronald Cron84cc9942020-11-25 14:30:05 +01001677 data, data_size, data_length );
Steven Cooremanb9b84422020-10-14 14:39:20 +02001678
1679 if( status != PSA_ERROR_NOT_SUPPORTED ||
Ronald Crond18b5f82020-11-25 16:46:05 +01001680 psa_key_lifetime_is_external( lifetime ) )
Steven Cooremanb9b84422020-10-14 14:39:20 +02001681 return( status );
1682
Ronald Crond18b5f82020-11-25 16:46:05 +01001683 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman560c28a2020-07-24 23:20:24 +02001684 {
John Durkop0e005192020-10-31 22:06:54 -07001685#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1686 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Steven Cooremana2371e52020-07-28 14:30:39 +02001687 mbedtls_rsa_context *rsa = NULL;
Ronald Crond18b5f82020-11-25 16:46:05 +01001688 status = mbedtls_psa_rsa_load_representation( type,
1689 key_buffer,
1690 key_buffer_size,
Ronald Cron90857082020-11-25 14:58:33 +01001691 &rsa );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001692 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001693 return( status );
Steven Cooremana01795d2020-07-24 22:48:15 +02001694
Ronald Cron3c8ca3a2020-11-26 16:45:24 +01001695 status = mbedtls_psa_rsa_export_key( PSA_KEY_TYPE_RSA_PUBLIC_KEY,
1696 rsa,
1697 data,
1698 data_size,
1699 data_length );
Steven Cooremana01795d2020-07-24 22:48:15 +02001700
Steven Cooremana2371e52020-07-28 14:30:39 +02001701 mbedtls_rsa_free( rsa );
1702 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001703
Steven Cooreman560c28a2020-07-24 23:20:24 +02001704 return( status );
Darryl Green9e2d7a02018-07-24 16:33:30 +01001705#else
Steven Cooreman560c28a2020-07-24 23:20:24 +02001706 /* We don't know how to convert a private RSA key to public. */
1707 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001708#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1709 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine969ac722018-01-28 18:16:59 +01001710 }
1711 else
Moran Pekera998bc62018-04-16 18:16:20 +03001712 {
John Durkop6ba40d12020-11-10 08:50:04 -08001713#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
1714 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Steven Cooremana2371e52020-07-28 14:30:39 +02001715 mbedtls_ecp_keypair *ecp = NULL;
Ronald Crond18b5f82020-11-25 16:46:05 +01001716 status = mbedtls_psa_ecp_load_representation( type,
1717 key_buffer,
1718 key_buffer_size,
Ronald Cron90857082020-11-25 14:58:33 +01001719 &ecp );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001720 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001721 return( status );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001722
Ronald Cron3c8ca3a2020-11-26 16:45:24 +01001723 status = mbedtls_psa_ecp_export_key(
1724 PSA_KEY_TYPE_ECC_PUBLIC_KEY(
Ronald Crond18b5f82020-11-25 16:46:05 +01001725 PSA_KEY_TYPE_ECC_GET_FAMILY( type ) ),
Ronald Cron3c8ca3a2020-11-26 16:45:24 +01001726 ecp,
1727 data,
1728 data_size,
1729 data_length );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001730
Steven Cooremana2371e52020-07-28 14:30:39 +02001731 mbedtls_ecp_keypair_free( ecp );
1732 mbedtls_free( ecp );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001733 return( status );
1734#else
1735 /* We don't know how to convert a private ECC key to public */
Moran Pekera998bc62018-04-16 18:16:20 +03001736 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001737#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
1738 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Moran Pekera998bc62018-04-16 18:16:20 +03001739 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001740 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001741 else
1742 {
1743 /* This shouldn't happen in the reference implementation, but
1744 it is valid for a special-purpose implementation to omit
1745 support for exporting certain key types. */
1746 return( PSA_ERROR_NOT_SUPPORTED );
1747 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001748}
Ronald Crond18b5f82020-11-25 16:46:05 +01001749
Ronald Croncf56a0a2020-08-04 09:51:30 +02001750psa_status_t psa_export_public_key( mbedtls_svc_key_id_t key,
Gilles Peskine2d277862018-06-18 15:41:12 +02001751 uint8_t *data,
1752 size_t data_size,
1753 size_t *data_length )
Moran Pekerdd4ea382018-04-03 15:30:03 +03001754{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001755 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001756 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001757 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001758
1759 /* Set the key to empty now, so that even when there are errors, we always
1760 * set data_length to a value between 0 and data_size. On error, setting
1761 * the key to empty is a good choice because an empty key representation is
1762 * unlikely to be accepted anywhere. */
1763 *data_length = 0;
1764
1765 /* Exporting a public key doesn't require a usage flag. */
Ronald Cron5c522922020-11-14 16:35:34 +01001766 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001767 if( status != PSA_SUCCESS )
1768 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001769
Ronald Cron9486f9d2020-11-26 13:36:23 +01001770 if( ! PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
1771 {
1772 status = PSA_ERROR_INVALID_ARGUMENT;
1773 goto exit;
1774 }
1775
1776 /* Reject a zero-length output buffer now, since this can never be a
1777 * valid key representation. This way we know that data must be a valid
1778 * pointer and we can do things like memset(data, ..., data_size). */
1779 if( data_size == 0 )
1780 {
1781 status = PSA_ERROR_BUFFER_TOO_SMALL;
1782 goto exit;
1783 }
1784
Ronald Crond18b5f82020-11-25 16:46:05 +01001785 psa_key_attributes_t attributes = {
1786 .core = slot->attr
1787 };
Ronald Cron9486f9d2020-11-26 13:36:23 +01001788 status = psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001789 &attributes, slot->key.data, slot->key.bytes,
1790 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001791
1792exit:
Ronald Cron5c522922020-11-14 16:35:34 +01001793 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001794
Ronald Cron5c522922020-11-14 16:35:34 +01001795 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Moran Pekerdd4ea382018-04-03 15:30:03 +03001796}
1797
Gilles Peskine91e8c332019-08-02 19:19:39 +02001798#if defined(static_assert)
1799static_assert( ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
1800 "One or more key attribute flag is listed as both external-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001801static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
Gilles Peskine094dac12019-08-07 18:19:46 +02001802 "One or more key attribute flag is listed as both internal-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001803static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY ) == 0,
Gilles Peskine91e8c332019-08-02 19:19:39 +02001804 "One or more key attribute flag is listed as both internal-only and external-only" );
1805#endif
1806
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001807/** Validate that a key policy is internally well-formed.
1808 *
1809 * This function only rejects invalid policies. It does not validate the
1810 * consistency of the policy with respect to other attributes of the key
1811 * such as the key type.
1812 */
1813static psa_status_t psa_validate_key_policy( const psa_key_policy_t *policy )
Gilles Peskine4747d192019-04-17 15:05:45 +02001814{
1815 if( ( policy->usage & ~( PSA_KEY_USAGE_EXPORT |
Gilles Peskine8e0206a2019-05-14 14:24:28 +02001816 PSA_KEY_USAGE_COPY |
Gilles Peskine4747d192019-04-17 15:05:45 +02001817 PSA_KEY_USAGE_ENCRYPT |
1818 PSA_KEY_USAGE_DECRYPT |
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001819 PSA_KEY_USAGE_SIGN_HASH |
1820 PSA_KEY_USAGE_VERIFY_HASH |
Gilles Peskine4747d192019-04-17 15:05:45 +02001821 PSA_KEY_USAGE_DERIVE ) ) != 0 )
1822 return( PSA_ERROR_INVALID_ARGUMENT );
1823
Gilles Peskine4747d192019-04-17 15:05:45 +02001824 return( PSA_SUCCESS );
1825}
1826
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001827/** Validate the internal consistency of key attributes.
1828 *
1829 * This function only rejects invalid attribute values. If does not
1830 * validate the consistency of the attributes with any key data that may
1831 * be involved in the creation of the key.
1832 *
1833 * Call this function early in the key creation process.
1834 *
1835 * \param[in] attributes Key attributes for the new key.
1836 * \param[out] p_drv On any return, the driver for the key, if any.
1837 * NULL for a transparent key.
1838 *
1839 */
1840static psa_status_t psa_validate_key_attributes(
1841 const psa_key_attributes_t *attributes,
1842 psa_se_drv_table_entry_t **p_drv )
Darryl Green0c6575a2018-11-07 16:05:30 +00001843{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001844 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Ronald Crond2ed4812020-07-17 16:11:30 +02001845 psa_key_lifetime_t lifetime = psa_get_key_lifetime( attributes );
Ronald Cron65f38a32020-10-23 17:11:13 +02001846 mbedtls_svc_key_id_t key = psa_get_key_id( attributes );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001847
Ronald Cron54b90082020-10-29 15:26:43 +01001848 status = psa_validate_key_location( lifetime, p_drv );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001849 if( status != PSA_SUCCESS )
1850 return( status );
1851
Ronald Crond2ed4812020-07-17 16:11:30 +02001852 status = psa_validate_key_persistence( lifetime );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001853 if( status != PSA_SUCCESS )
1854 return( status );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001855
Ronald Cron65f38a32020-10-23 17:11:13 +02001856 if ( PSA_KEY_LIFETIME_IS_VOLATILE( lifetime ) )
1857 {
1858 if( MBEDTLS_SVC_KEY_ID_GET_KEY_ID( key ) != 0 )
1859 return( PSA_ERROR_INVALID_ARGUMENT );
1860 }
1861 else
Ronald Crond2ed4812020-07-17 16:11:30 +02001862 {
Ronald Croncbd7bea2020-11-11 14:57:44 +01001863 status = psa_validate_key_id( psa_get_key_id( attributes ), 0 );
Ronald Crond2ed4812020-07-17 16:11:30 +02001864 if( status != PSA_SUCCESS )
1865 return( status );
1866 }
1867
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001868 status = psa_validate_key_policy( &attributes->core.policy );
Darryl Green0c6575a2018-11-07 16:05:30 +00001869 if( status != PSA_SUCCESS )
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001870 return( status );
1871
1872 /* Refuse to create overly large keys.
1873 * Note that this doesn't trigger on import if the attributes don't
1874 * explicitly specify a size (so psa_get_key_bits returns 0), so
1875 * psa_import_key() needs its own checks. */
1876 if( psa_get_key_bits( attributes ) > PSA_MAX_KEY_BITS )
1877 return( PSA_ERROR_NOT_SUPPORTED );
1878
Gilles Peskine91e8c332019-08-02 19:19:39 +02001879 /* Reject invalid flags. These should not be reachable through the API. */
1880 if( attributes->core.flags & ~ ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1881 MBEDTLS_PSA_KA_MASK_DUAL_USE ) )
1882 return( PSA_ERROR_INVALID_ARGUMENT );
1883
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001884 return( PSA_SUCCESS );
1885}
1886
Gilles Peskine4747d192019-04-17 15:05:45 +02001887/** Prepare a key slot to receive key material.
1888 *
1889 * This function allocates a key slot and sets its metadata.
1890 *
1891 * If this function fails, call psa_fail_key_creation().
1892 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001893 * This function is intended to be used as follows:
1894 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001895 * it with the specified attributes, and in case of a volatile key assign it
1896 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001897 * -# Populate the slot with the key material.
1898 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1899 * In case of failure at any step, stop the sequence and call
1900 * psa_fail_key_creation().
1901 *
Ronald Cron5c522922020-11-14 16:35:34 +01001902 * On success, the key slot is locked. It is the responsibility of the caller
1903 * to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001904 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001905 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001906 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001907 * \param[out] p_slot On success, a pointer to the prepared slot.
1908 * \param[out] p_drv On any return, the driver for the key, if any.
1909 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001910 *
1911 * \retval #PSA_SUCCESS
1912 * The key slot is ready to receive key material.
1913 * \return If this function fails, the key slot is an invalid state.
1914 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001915 */
1916static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001917 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001918 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001919 psa_key_slot_t **p_slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001920 psa_se_drv_table_entry_t **p_drv )
Gilles Peskine4747d192019-04-17 15:05:45 +02001921{
1922 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001923 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001924 psa_key_slot_t *slot;
1925
Gilles Peskinedf179142019-07-15 22:02:14 +02001926 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001927 *p_drv = NULL;
1928
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001929 status = psa_validate_key_attributes( attributes, p_drv );
1930 if( status != PSA_SUCCESS )
1931 return( status );
1932
Ronald Cronc4d1b512020-07-31 11:26:37 +02001933 status = psa_get_empty_key_slot( &volatile_key_id, p_slot );
Gilles Peskine4747d192019-04-17 15:05:45 +02001934 if( status != PSA_SUCCESS )
1935 return( status );
1936 slot = *p_slot;
1937
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001938 /* We're storing the declared bit-size of the key. It's up to each
1939 * creation mechanism to verify that this information is correct.
1940 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001941 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001942 * is optional (import, copy). In case of a volatile key, assign it the
1943 * volatile key identifier associated to the slot returned to contain its
1944 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001945
1946 slot->attr = attributes->core;
Ronald Cronc4d1b512020-07-31 11:26:37 +02001947 if( PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
1948 {
1949#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1950 slot->attr.id = volatile_key_id;
1951#else
1952 slot->attr.id.key_id = volatile_key_id;
1953#endif
1954 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001955
Gilles Peskine91e8c332019-08-02 19:19:39 +02001956 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001957 * external-only flags, query `attributes`. Thanks to the check
1958 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001959 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001960 * may have set. */
1961 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001962
Gilles Peskinecbaff462019-07-12 23:46:04 +02001963#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001964 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001965 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001966 * create the key file in internal storage, create the
1967 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001968 * persistent data. This is done by starting a transaction that will
1969 * encompass these three actions.
1970 * For registering a volatile key, we just need to find an appropriate
1971 * slot number inside the SE. Since the key is designated volatile, creating
1972 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001973 /* The first thing to do is to find a slot number for the new key.
1974 * We save the slot number in persistent storage as part of the
1975 * transaction data. It will be needed to recover if the power
1976 * fails during the key creation process, to clean up on the secure
1977 * element side after restarting. Obtaining a slot number from the
1978 * secure element driver updates its persistent state, but we do not yet
1979 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001980 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001981 if( *p_drv != NULL )
Darryl Green0c6575a2018-11-07 16:05:30 +00001982 {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001983 psa_key_slot_number_t slot_number;
Gilles Peskinee88c2c12019-08-05 16:44:14 +02001984 status = psa_find_se_slot_for_key( attributes, method, *p_drv,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001985 &slot_number );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001986 if( status != PSA_SUCCESS )
1987 return( status );
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001988
1989 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( attributes->core.lifetime ) )
Gilles Peskine66be51c2019-07-25 18:02:52 +02001990 {
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001991 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_CREATE_KEY );
1992 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001993 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001994 psa_crypto_transaction.key.id = slot->attr.id;
1995 status = psa_crypto_save_transaction( );
1996 if( status != PSA_SUCCESS )
1997 {
1998 (void) psa_crypto_stop_transaction( );
1999 return( status );
2000 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02002001 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01002002
2003 status = psa_copy_key_material_into_slot(
2004 slot, (uint8_t *)( &slot_number ), sizeof( slot_number ) );
Darryl Green0c6575a2018-11-07 16:05:30 +00002005 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02002006
2007 if( *p_drv == NULL && method == PSA_KEY_CREATION_REGISTER )
2008 {
2009 /* Key registration only makes sense with a secure element. */
2010 return( PSA_ERROR_INVALID_ARGUMENT );
2011 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02002012#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2013
Ronald Cronc4d1b512020-07-31 11:26:37 +02002014 return( PSA_SUCCESS );
Darryl Green0c6575a2018-11-07 16:05:30 +00002015}
Gilles Peskine4747d192019-04-17 15:05:45 +02002016
2017/** Finalize the creation of a key once its key material has been set.
2018 *
2019 * This entails writing the key to persistent storage.
2020 *
2021 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02002022 * See the documentation of psa_start_key_creation() for the intended use
2023 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02002024 *
Ronald Cron5c522922020-11-14 16:35:34 +01002025 * If the finalization succeeds, the function unlocks the key slot (it was
2026 * locked by psa_start_key_creation()) and the key slot cannot be accessed
2027 * anymore as part of the key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01002028 *
Gilles Peskine011e4282019-06-26 18:34:38 +02002029 * \param[in,out] slot Pointer to the slot with key material.
2030 * \param[in] driver The secure element driver for the key,
2031 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01002032 * \param[out] key On success, identifier of the key. Note that the
2033 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02002034 *
2035 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02002036 * The key was successfully created.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02002037 * \return If this function fails, the key slot is an invalid state.
2038 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02002039 */
Gilles Peskine011e4282019-06-26 18:34:38 +02002040static psa_status_t psa_finish_key_creation(
2041 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01002042 psa_se_drv_table_entry_t *driver,
2043 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02002044{
2045 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02002046 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02002047 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02002048
2049#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Steven Cooremanc59de6a2020-06-08 18:28:25 +02002050 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Gilles Peskine4747d192019-04-17 15:05:45 +02002051 {
Gilles Peskine1df83d42019-07-23 16:13:14 +02002052#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2053 if( driver != NULL )
2054 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02002055 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01002056 psa_key_slot_number_t slot_number =
2057 psa_key_slot_get_slot_number( slot ) ;
2058
Gilles Peskineb46bef22019-07-30 21:32:04 +02002059#if defined(static_assert)
Ronald Cronea0f8a62020-11-25 17:52:23 +01002060 static_assert( sizeof( slot_number ) ==
Gilles Peskineb46bef22019-07-30 21:32:04 +02002061 sizeof( data.slot_number ),
2062 "Slot number size does not match psa_se_key_data_storage_t" );
Gilles Peskineb46bef22019-07-30 21:32:04 +02002063#endif
Ronald Cronea0f8a62020-11-25 17:52:23 +01002064 memcpy( &data.slot_number, &slot_number, sizeof( slot_number ) );
Gilles Peskine76aa09c2019-07-31 14:15:34 +02002065 status = psa_save_persistent_key( &slot->attr,
Gilles Peskineb46bef22019-07-30 21:32:04 +02002066 (uint8_t*) &data,
2067 sizeof( data ) );
Gilles Peskine1df83d42019-07-23 16:13:14 +02002068 }
2069 else
2070#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2071 {
Steven Cooreman40120f62020-10-29 11:42:22 +01002072 /* Key material is saved in export representation in the slot, so
2073 * just pass the slot buffer for storage. */
2074 status = psa_save_persistent_key( &slot->attr,
Ronald Cronea0f8a62020-11-25 17:52:23 +01002075 slot->key.data,
2076 slot->key.bytes );
Gilles Peskine1df83d42019-07-23 16:13:14 +02002077 }
Gilles Peskine4747d192019-04-17 15:05:45 +02002078 }
Darryl Green0c6575a2018-11-07 16:05:30 +00002079#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
2080
Gilles Peskinecbaff462019-07-12 23:46:04 +02002081#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02002082 /* Finish the transaction for a key creation. This does not
2083 * happen when registering an existing key. Detect this case
2084 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02002085 * creation of a persistent key in a secure element requires a transaction,
2086 * but registration or volatile key creation doesn't use one). */
Gilles Peskined7729582019-08-05 15:55:54 +02002087 if( driver != NULL &&
2088 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY )
Gilles Peskinecbaff462019-07-12 23:46:04 +02002089 {
2090 status = psa_save_se_persistent_data( driver );
2091 if( status != PSA_SUCCESS )
2092 {
Gilles Peskine8e338702019-07-30 20:06:31 +02002093 psa_destroy_persistent_key( slot->attr.id );
Gilles Peskinecbaff462019-07-12 23:46:04 +02002094 return( status );
2095 }
Gilles Peskinefc762652019-07-22 19:30:34 +02002096 status = psa_crypto_stop_transaction( );
Gilles Peskinecbaff462019-07-12 23:46:04 +02002097 }
2098#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2099
Ronald Cron50972942020-11-14 11:28:25 +01002100 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01002101 {
2102 *key = slot->attr.id;
Ronald Cron5c522922020-11-14 16:35:34 +01002103 status = psa_unlock_key_slot( slot );
Ronald Cron81709fc2020-11-14 12:10:32 +01002104 if( status != PSA_SUCCESS )
2105 *key = MBEDTLS_SVC_KEY_ID_INIT;
2106 }
Ronald Cron50972942020-11-14 11:28:25 +01002107
Gilles Peskine4747d192019-04-17 15:05:45 +02002108 return( status );
2109}
2110
2111/** Abort the creation of a key.
2112 *
2113 * You may call this function after calling psa_start_key_creation(),
2114 * or after psa_finish_key_creation() fails. In other circumstances, this
2115 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02002116 * See the documentation of psa_start_key_creation() for the intended use
2117 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02002118 *
Gilles Peskine011e4282019-06-26 18:34:38 +02002119 * \param[in,out] slot Pointer to the slot with key material.
2120 * \param[in] driver The secure element driver for the key,
2121 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02002122 */
Gilles Peskine011e4282019-06-26 18:34:38 +02002123static void psa_fail_key_creation( psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002124 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02002125{
Gilles Peskine011e4282019-06-26 18:34:38 +02002126 (void) driver;
2127
Gilles Peskine4747d192019-04-17 15:05:45 +02002128 if( slot == NULL )
2129 return;
Gilles Peskine011e4282019-06-26 18:34:38 +02002130
2131#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01002132 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02002133 * element, and the failure happened later (when saving metadata
2134 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02002135 * element.
2136 * https://github.com/ARMmbed/mbed-crypto/issues/217
2137 */
Gilles Peskinefc762652019-07-22 19:30:34 +02002138
Gilles Peskined7729582019-08-05 15:55:54 +02002139 /* Abort the ongoing transaction if any (there may not be one if
2140 * the creation process failed before starting one, or if the
2141 * key creation is a registration of a key in a secure element).
2142 * Earlier functions must already have done what it takes to undo any
2143 * partial creation. All that's left is to update the transaction data
2144 * itself. */
Gilles Peskinefc762652019-07-22 19:30:34 +02002145 (void) psa_crypto_stop_transaction( );
Gilles Peskine011e4282019-06-26 18:34:38 +02002146#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2147
Gilles Peskine4747d192019-04-17 15:05:45 +02002148 psa_wipe_key_slot( slot );
2149}
2150
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002151/** Validate optional attributes during key creation.
2152 *
2153 * Some key attributes are optional during key creation. If they are
2154 * specified in the attributes structure, check that they are consistent
2155 * with the data in the slot.
2156 *
2157 * This function should be called near the end of key creation, after
2158 * the slot in memory is fully populated but before saving persistent data.
2159 */
2160static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002161 const psa_key_slot_t *slot,
2162 const psa_key_attributes_t *attributes )
2163{
Gilles Peskine7e0cff92019-07-30 13:48:52 +02002164 if( attributes->core.type != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002165 {
Gilles Peskine8e338702019-07-30 20:06:31 +02002166 if( attributes->core.type != slot->attr.type )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002167 return( PSA_ERROR_INVALID_ARGUMENT );
2168 }
2169
2170 if( attributes->domain_parameters_size != 0 )
2171 {
John Durkop0e005192020-10-31 22:06:54 -07002172#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
2173 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskine8e338702019-07-30 20:06:31 +02002174 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002175 {
Steven Cooremana2371e52020-07-28 14:30:39 +02002176 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02002177 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02002178 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02002179
Ronald Cron90857082020-11-25 14:58:33 +01002180 psa_status_t status = mbedtls_psa_rsa_load_representation(
2181 slot->attr.type,
2182 slot->key.data,
2183 slot->key.bytes,
2184 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02002185 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02002186 return( status );
Steven Cooreman75b74362020-07-28 14:30:13 +02002187
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002188 mbedtls_mpi_init( &actual );
2189 mbedtls_mpi_init( &required );
Steven Cooremana2371e52020-07-28 14:30:39 +02002190 ret = mbedtls_rsa_export( rsa,
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002191 NULL, NULL, NULL, NULL, &actual );
Steven Cooremana2371e52020-07-28 14:30:39 +02002192 mbedtls_rsa_free( rsa );
2193 mbedtls_free( rsa );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002194 if( ret != 0 )
2195 goto rsa_exit;
2196 ret = mbedtls_mpi_read_binary( &required,
2197 attributes->domain_parameters,
2198 attributes->domain_parameters_size );
2199 if( ret != 0 )
2200 goto rsa_exit;
2201 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
2202 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
2203 rsa_exit:
2204 mbedtls_mpi_free( &actual );
2205 mbedtls_mpi_free( &required );
2206 if( ret != 0)
2207 return( mbedtls_to_psa_error( ret ) );
2208 }
2209 else
John Durkop9814fa22020-11-04 12:28:15 -08002210#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
2211 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002212 {
2213 return( PSA_ERROR_INVALID_ARGUMENT );
2214 }
2215 }
2216
Gilles Peskine7e0cff92019-07-30 13:48:52 +02002217 if( attributes->core.bits != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002218 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02002219 if( attributes->core.bits != slot->attr.bits )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002220 return( PSA_ERROR_INVALID_ARGUMENT );
2221 }
2222
2223 return( PSA_SUCCESS );
2224}
2225
Gilles Peskine4747d192019-04-17 15:05:45 +02002226psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02002227 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02002228 size_t data_length,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002229 mbedtls_svc_key_id_t *key )
Gilles Peskine4747d192019-04-17 15:05:45 +02002230{
2231 psa_status_t status;
2232 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002233 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002234
Ronald Cron81709fc2020-11-14 12:10:32 +01002235 *key = MBEDTLS_SVC_KEY_ID_INIT;
2236
Gilles Peskine0f84d622019-09-12 19:03:13 +02002237 /* Reject zero-length symmetric keys (including raw data key objects).
2238 * This also rejects any key which might be encoded as an empty string,
2239 * which is never valid. */
2240 if( data_length == 0 )
2241 return( PSA_ERROR_INVALID_ARGUMENT );
2242
Gilles Peskinedf179142019-07-15 22:02:14 +02002243 status = psa_start_key_creation( PSA_KEY_CREATION_IMPORT, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01002244 &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002245 if( status != PSA_SUCCESS )
2246 goto exit;
2247
Gilles Peskine5d309672019-07-12 23:47:28 +02002248#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2249 if( driver != NULL )
2250 {
2251 const psa_drv_se_t *drv = psa_get_se_driver_methods( driver );
Darryl Green0892d0f2019-08-20 09:50:14 +01002252 /* The driver should set the number of key bits, however in
2253 * case it doesn't, we initialize bits to an invalid value. */
2254 size_t bits = PSA_MAX_KEY_BITS + 1;
Gilles Peskine5d309672019-07-12 23:47:28 +02002255 if( drv->key_management == NULL ||
2256 drv->key_management->p_import == NULL )
2257 {
2258 status = PSA_ERROR_NOT_SUPPORTED;
2259 goto exit;
2260 }
2261 status = drv->key_management->p_import(
2262 psa_get_se_driver_context( driver ),
Ronald Cronea0f8a62020-11-25 17:52:23 +01002263 psa_key_slot_get_slot_number( slot ),
2264 attributes, data, data_length, &bits );
Gilles Peskineb46bef22019-07-30 21:32:04 +02002265 if( status != PSA_SUCCESS )
2266 goto exit;
2267 if( bits > PSA_MAX_KEY_BITS )
2268 {
2269 status = PSA_ERROR_NOT_SUPPORTED;
2270 goto exit;
2271 }
2272 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskine5d309672019-07-12 23:47:28 +02002273 }
2274 else
2275#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Steven Cooremanac3434f2021-01-15 17:36:02 +01002276 if( psa_key_lifetime_is_external( psa_get_key_lifetime( attributes ) ) )
2277 {
2278 /* Importing a key with external lifetime through the driver wrapper
2279 * interface is not yet supported. Return as if this was an invalid
2280 * lifetime. */
2281 status = PSA_ERROR_INVALID_ARGUMENT;
2282 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02002283 }
2284 else
Gilles Peskine5d309672019-07-12 23:47:28 +02002285 {
2286 status = psa_import_key_into_slot( slot, data, data_length );
2287 if( status != PSA_SUCCESS )
2288 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02002289 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002290 status = psa_validate_optional_attributes( slot, attributes );
Gilles Peskine18017402019-07-24 20:25:59 +02002291 if( status != PSA_SUCCESS )
2292 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002293
Ronald Cron81709fc2020-11-14 12:10:32 +01002294 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002295exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02002296 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02002297 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002298
Gilles Peskine4747d192019-04-17 15:05:45 +02002299 return( status );
2300}
2301
Gilles Peskined7729582019-08-05 15:55:54 +02002302#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2303psa_status_t mbedtls_psa_register_se_key(
2304 const psa_key_attributes_t *attributes )
2305{
2306 psa_status_t status;
2307 psa_key_slot_t *slot = NULL;
2308 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02002309 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02002310
2311 /* Leaving attributes unspecified is not currently supported.
2312 * It could make sense to query the key type and size from the
2313 * secure element, but not all secure elements support this
2314 * and the driver HAL doesn't currently support it. */
2315 if( psa_get_key_type( attributes ) == PSA_KEY_TYPE_NONE )
2316 return( PSA_ERROR_NOT_SUPPORTED );
2317 if( psa_get_key_bits( attributes ) == 0 )
2318 return( PSA_ERROR_NOT_SUPPORTED );
2319
2320 status = psa_start_key_creation( PSA_KEY_CREATION_REGISTER, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01002321 &slot, &driver );
Gilles Peskined7729582019-08-05 15:55:54 +02002322 if( status != PSA_SUCCESS )
2323 goto exit;
2324
Ronald Cron81709fc2020-11-14 12:10:32 +01002325 status = psa_finish_key_creation( slot, driver, &key );
Gilles Peskined7729582019-08-05 15:55:54 +02002326
2327exit:
2328 if( status != PSA_SUCCESS )
Gilles Peskined7729582019-08-05 15:55:54 +02002329 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002330
Gilles Peskined7729582019-08-05 15:55:54 +02002331 /* Registration doesn't keep the key in RAM. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02002332 psa_close_key( key );
Gilles Peskined7729582019-08-05 15:55:54 +02002333 return( status );
2334}
2335#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2336
Gilles Peskinef603c712019-01-19 13:40:11 +01002337static psa_status_t psa_copy_key_material( const psa_key_slot_t *source,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002338 psa_key_slot_t *target )
Gilles Peskinef603c712019-01-19 13:40:11 +01002339{
Steven Cooremanf7cebd42020-10-13 20:27:40 +02002340 psa_status_t status = psa_copy_key_material_into_slot( target,
Ronald Cronea0f8a62020-11-25 17:52:23 +01002341 source->key.data,
2342 source->key.bytes );
Gilles Peskinef603c712019-01-19 13:40:11 +01002343 if( status != PSA_SUCCESS )
Steven Cooreman398aee52020-10-13 14:35:45 +02002344 return( status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002345
Steven Cooreman398aee52020-10-13 14:35:45 +02002346 target->attr.type = source->attr.type;
2347 target->attr.bits = source->attr.bits;
2348
2349 return( PSA_SUCCESS );
Gilles Peskinef603c712019-01-19 13:40:11 +01002350}
2351
Ronald Croncf56a0a2020-08-04 09:51:30 +02002352psa_status_t psa_copy_key( mbedtls_svc_key_id_t source_key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002353 const psa_key_attributes_t *specified_attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002354 mbedtls_svc_key_id_t *target_key )
Gilles Peskinef603c712019-01-19 13:40:11 +01002355{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002356 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002357 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002358 psa_key_slot_t *source_slot = NULL;
2359 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002360 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002361 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskinef603c712019-01-19 13:40:11 +01002362
Ronald Cron81709fc2020-11-14 12:10:32 +01002363 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2364
Ronald Cron5c522922020-11-14 16:35:34 +01002365 status = psa_get_and_lock_transparent_key_slot_with_policy(
2366 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0 );
Gilles Peskinef603c712019-01-19 13:40:11 +01002367 if( status != PSA_SUCCESS )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002368 goto exit;
2369
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002370 status = psa_validate_optional_attributes( source_slot,
2371 specified_attributes );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002372 if( status != PSA_SUCCESS )
2373 goto exit;
2374
Gilles Peskine7e0cff92019-07-30 13:48:52 +02002375 status = psa_restrict_key_policy( &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02002376 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002377 if( status != PSA_SUCCESS )
2378 goto exit;
2379
Ronald Cron81709fc2020-11-14 12:10:32 +01002380 status = psa_start_key_creation( PSA_KEY_CREATION_COPY, &actual_attributes,
2381 &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002382 if( status != PSA_SUCCESS )
2383 goto exit;
2384
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002385#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2386 if( driver != NULL )
Gilles Peskinef603c712019-01-19 13:40:11 +01002387 {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002388 /* Copying to a secure element is not implemented yet. */
2389 status = PSA_ERROR_NOT_SUPPORTED;
2390 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002391 }
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002392#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef603c712019-01-19 13:40:11 +01002393
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002394 status = psa_copy_key_material( source_slot, target_slot );
Gilles Peskinef603c712019-01-19 13:40:11 +01002395 if( status != PSA_SUCCESS )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002396 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002397
Ronald Cron81709fc2020-11-14 12:10:32 +01002398 status = psa_finish_key_creation( target_slot, driver, target_key );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002399exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002400 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02002401 psa_fail_key_creation( target_slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002402
Ronald Cron5c522922020-11-14 16:35:34 +01002403 unlock_status = psa_unlock_key_slot( source_slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002404
Ronald Cron5c522922020-11-14 16:35:34 +01002405 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002406}
2407
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002408
2409
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002410/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002411/* Message digests */
2412/****************************************************************/
2413
John Durkop07cc04a2020-11-16 22:08:34 -08002414#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
John Durkop0e005192020-10-31 22:06:54 -07002415 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) || \
2416 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) || \
John Durkop9814fa22020-11-04 12:28:15 -08002417 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinedc2fc842018-03-07 16:42:59 +01002418static const mbedtls_md_info_t *mbedtls_md_info_from_psa( psa_algorithm_t alg )
Gilles Peskine20035e32018-02-03 22:44:14 +01002419{
2420 switch( alg )
2421 {
John Durkopee4e6602020-11-27 08:48:46 -08002422#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskine20035e32018-02-03 22:44:14 +01002423 case PSA_ALG_MD2:
2424 return( &mbedtls_md2_info );
2425#endif
John Durkopee4e6602020-11-27 08:48:46 -08002426#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskine20035e32018-02-03 22:44:14 +01002427 case PSA_ALG_MD4:
2428 return( &mbedtls_md4_info );
2429#endif
John Durkopee4e6602020-11-27 08:48:46 -08002430#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskine20035e32018-02-03 22:44:14 +01002431 case PSA_ALG_MD5:
2432 return( &mbedtls_md5_info );
2433#endif
John Durkopee4e6602020-11-27 08:48:46 -08002434#if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
Gilles Peskine20035e32018-02-03 22:44:14 +01002435 case PSA_ALG_RIPEMD160:
2436 return( &mbedtls_ripemd160_info );
2437#endif
John Durkopee4e6602020-11-27 08:48:46 -08002438#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskine20035e32018-02-03 22:44:14 +01002439 case PSA_ALG_SHA_1:
2440 return( &mbedtls_sha1_info );
2441#endif
John Durkopee4e6602020-11-27 08:48:46 -08002442#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskine20035e32018-02-03 22:44:14 +01002443 case PSA_ALG_SHA_224:
2444 return( &mbedtls_sha224_info );
John Durkopee4e6602020-11-27 08:48:46 -08002445#endif
2446#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskine20035e32018-02-03 22:44:14 +01002447 case PSA_ALG_SHA_256:
2448 return( &mbedtls_sha256_info );
2449#endif
John Durkopee4e6602020-11-27 08:48:46 -08002450#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskine20035e32018-02-03 22:44:14 +01002451 case PSA_ALG_SHA_384:
2452 return( &mbedtls_sha384_info );
Manuel Pégourié-Gonnardd6020842019-07-17 16:28:21 +02002453#endif
John Durkopee4e6602020-11-27 08:48:46 -08002454#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskine20035e32018-02-03 22:44:14 +01002455 case PSA_ALG_SHA_512:
2456 return( &mbedtls_sha512_info );
2457#endif
2458 default:
2459 return( NULL );
2460 }
2461}
John Durkop07cc04a2020-11-16 22:08:34 -08002462#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
John Durkop9814fa22020-11-04 12:28:15 -08002463 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) ||
2464 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) ||
2465 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine20035e32018-02-03 22:44:14 +01002466
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002467psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
2468{
2469 switch( operation->alg )
2470 {
Gilles Peskine81736312018-06-26 15:04:31 +02002471 case 0:
2472 /* The object has (apparently) been initialized but it is not
2473 * in use. It's ok to call abort on such an object, and there's
2474 * nothing to do. */
2475 break;
John Durkopee4e6602020-11-27 08:48:46 -08002476#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002477 case PSA_ALG_MD2:
2478 mbedtls_md2_free( &operation->ctx.md2 );
2479 break;
2480#endif
John Durkopee4e6602020-11-27 08:48:46 -08002481#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002482 case PSA_ALG_MD4:
2483 mbedtls_md4_free( &operation->ctx.md4 );
2484 break;
2485#endif
John Durkopee4e6602020-11-27 08:48:46 -08002486#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002487 case PSA_ALG_MD5:
2488 mbedtls_md5_free( &operation->ctx.md5 );
2489 break;
2490#endif
John Durkopee4e6602020-11-27 08:48:46 -08002491#if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002492 case PSA_ALG_RIPEMD160:
2493 mbedtls_ripemd160_free( &operation->ctx.ripemd160 );
2494 break;
2495#endif
John Durkopee4e6602020-11-27 08:48:46 -08002496#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002497 case PSA_ALG_SHA_1:
2498 mbedtls_sha1_free( &operation->ctx.sha1 );
2499 break;
2500#endif
John Durkop6ca23272020-12-03 06:01:32 -08002501#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002502 case PSA_ALG_SHA_224:
John Durkop6ca23272020-12-03 06:01:32 -08002503 mbedtls_sha256_free( &operation->ctx.sha256 );
2504 break;
2505#endif
2506#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002507 case PSA_ALG_SHA_256:
2508 mbedtls_sha256_free( &operation->ctx.sha256 );
2509 break;
2510#endif
John Durkop6ca23272020-12-03 06:01:32 -08002511#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002512 case PSA_ALG_SHA_384:
John Durkop6ca23272020-12-03 06:01:32 -08002513 mbedtls_sha512_free( &operation->ctx.sha512 );
2514 break;
2515#endif
2516#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002517 case PSA_ALG_SHA_512:
2518 mbedtls_sha512_free( &operation->ctx.sha512 );
2519 break;
2520#endif
2521 default:
Gilles Peskinef9c2c092018-06-21 16:57:07 +02002522 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002523 }
2524 operation->alg = 0;
2525 return( PSA_SUCCESS );
2526}
2527
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002528psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002529 psa_algorithm_t alg )
2530{
Janos Follath24eed8d2019-11-22 13:21:35 +00002531 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002532
2533 /* A context must be freshly initialized before it can be set up. */
2534 if( operation->alg != 0 )
2535 {
2536 return( PSA_ERROR_BAD_STATE );
2537 }
2538
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002539 switch( alg )
2540 {
John Durkopee4e6602020-11-27 08:48:46 -08002541#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002542 case PSA_ALG_MD2:
2543 mbedtls_md2_init( &operation->ctx.md2 );
2544 ret = mbedtls_md2_starts_ret( &operation->ctx.md2 );
2545 break;
2546#endif
John Durkopee4e6602020-11-27 08:48:46 -08002547#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002548 case PSA_ALG_MD4:
2549 mbedtls_md4_init( &operation->ctx.md4 );
2550 ret = mbedtls_md4_starts_ret( &operation->ctx.md4 );
2551 break;
2552#endif
John Durkopee4e6602020-11-27 08:48:46 -08002553#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002554 case PSA_ALG_MD5:
2555 mbedtls_md5_init( &operation->ctx.md5 );
2556 ret = mbedtls_md5_starts_ret( &operation->ctx.md5 );
2557 break;
2558#endif
John Durkopee4e6602020-11-27 08:48:46 -08002559#if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002560 case PSA_ALG_RIPEMD160:
2561 mbedtls_ripemd160_init( &operation->ctx.ripemd160 );
2562 ret = mbedtls_ripemd160_starts_ret( &operation->ctx.ripemd160 );
2563 break;
2564#endif
John Durkopee4e6602020-11-27 08:48:46 -08002565#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002566 case PSA_ALG_SHA_1:
2567 mbedtls_sha1_init( &operation->ctx.sha1 );
2568 ret = mbedtls_sha1_starts_ret( &operation->ctx.sha1 );
2569 break;
2570#endif
John Durkopee4e6602020-11-27 08:48:46 -08002571#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002572 case PSA_ALG_SHA_224:
2573 mbedtls_sha256_init( &operation->ctx.sha256 );
2574 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 1 );
2575 break;
John Durkopee4e6602020-11-27 08:48:46 -08002576#endif
2577#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002578 case PSA_ALG_SHA_256:
2579 mbedtls_sha256_init( &operation->ctx.sha256 );
2580 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 0 );
2581 break;
2582#endif
John Durkopee4e6602020-11-27 08:48:46 -08002583#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002584 case PSA_ALG_SHA_384:
2585 mbedtls_sha512_init( &operation->ctx.sha512 );
2586 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 1 );
2587 break;
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002588#endif
John Durkopee4e6602020-11-27 08:48:46 -08002589#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002590 case PSA_ALG_SHA_512:
2591 mbedtls_sha512_init( &operation->ctx.sha512 );
2592 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 0 );
2593 break;
2594#endif
2595 default:
Gilles Peskinec06e0712018-06-20 16:21:04 +02002596 return( PSA_ALG_IS_HASH( alg ) ?
2597 PSA_ERROR_NOT_SUPPORTED :
2598 PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002599 }
2600 if( ret == 0 )
2601 operation->alg = alg;
2602 else
2603 psa_hash_abort( operation );
2604 return( mbedtls_to_psa_error( ret ) );
2605}
2606
2607psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2608 const uint8_t *input,
2609 size_t input_length )
2610{
Janos Follath24eed8d2019-11-22 13:21:35 +00002611 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine94e44542018-07-12 16:58:43 +02002612
2613 /* Don't require hash implementations to behave correctly on a
2614 * zero-length input, which may have an invalid pointer. */
2615 if( input_length == 0 )
2616 return( PSA_SUCCESS );
2617
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002618 switch( operation->alg )
2619 {
John Durkopee4e6602020-11-27 08:48:46 -08002620#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002621 case PSA_ALG_MD2:
2622 ret = mbedtls_md2_update_ret( &operation->ctx.md2,
2623 input, input_length );
2624 break;
2625#endif
John Durkopee4e6602020-11-27 08:48:46 -08002626#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002627 case PSA_ALG_MD4:
2628 ret = mbedtls_md4_update_ret( &operation->ctx.md4,
2629 input, input_length );
2630 break;
2631#endif
John Durkopee4e6602020-11-27 08:48:46 -08002632#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002633 case PSA_ALG_MD5:
2634 ret = mbedtls_md5_update_ret( &operation->ctx.md5,
2635 input, input_length );
2636 break;
2637#endif
John Durkopee4e6602020-11-27 08:48:46 -08002638#if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002639 case PSA_ALG_RIPEMD160:
2640 ret = mbedtls_ripemd160_update_ret( &operation->ctx.ripemd160,
2641 input, input_length );
2642 break;
2643#endif
John Durkopee4e6602020-11-27 08:48:46 -08002644#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002645 case PSA_ALG_SHA_1:
2646 ret = mbedtls_sha1_update_ret( &operation->ctx.sha1,
2647 input, input_length );
2648 break;
2649#endif
John Durkop6ca23272020-12-03 06:01:32 -08002650#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002651 case PSA_ALG_SHA_224:
John Durkop6ca23272020-12-03 06:01:32 -08002652 ret = mbedtls_sha256_update_ret( &operation->ctx.sha256,
2653 input, input_length );
2654 break;
2655#endif
2656#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002657 case PSA_ALG_SHA_256:
2658 ret = mbedtls_sha256_update_ret( &operation->ctx.sha256,
2659 input, input_length );
2660 break;
2661#endif
John Durkop6ca23272020-12-03 06:01:32 -08002662#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002663 case PSA_ALG_SHA_384:
John Durkop6ca23272020-12-03 06:01:32 -08002664 ret = mbedtls_sha512_update_ret( &operation->ctx.sha512,
2665 input, input_length );
2666 break;
2667#endif
2668#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002669 case PSA_ALG_SHA_512:
2670 ret = mbedtls_sha512_update_ret( &operation->ctx.sha512,
2671 input, input_length );
2672 break;
2673#endif
2674 default:
John Durkopee4e6602020-11-27 08:48:46 -08002675 (void)input;
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002676 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002677 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002678
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002679 if( ret != 0 )
2680 psa_hash_abort( operation );
2681 return( mbedtls_to_psa_error( ret ) );
2682}
2683
2684psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2685 uint8_t *hash,
2686 size_t hash_size,
2687 size_t *hash_length )
2688{
itayzafrir40835d42018-08-02 13:14:17 +03002689 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00002690 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01002691 size_t actual_hash_length = PSA_HASH_LENGTH( operation->alg );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002692
2693 /* Fill the output buffer with something that isn't a valid hash
2694 * (barring an attack on the hash and deliberately-crafted input),
2695 * in case the caller doesn't check the return status properly. */
Gilles Peskineaee13332018-07-02 12:15:28 +02002696 *hash_length = hash_size;
Gilles Peskine46f1fd72018-06-28 19:31:31 +02002697 /* If hash_size is 0 then hash may be NULL and then the
2698 * call to memset would have undefined behavior. */
2699 if( hash_size != 0 )
2700 memset( hash, '!', hash_size );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002701
2702 if( hash_size < actual_hash_length )
itayzafrir40835d42018-08-02 13:14:17 +03002703 {
2704 status = PSA_ERROR_BUFFER_TOO_SMALL;
2705 goto exit;
2706 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002707
2708 switch( operation->alg )
2709 {
John Durkopee4e6602020-11-27 08:48:46 -08002710#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002711 case PSA_ALG_MD2:
2712 ret = mbedtls_md2_finish_ret( &operation->ctx.md2, hash );
2713 break;
2714#endif
John Durkopee4e6602020-11-27 08:48:46 -08002715#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002716 case PSA_ALG_MD4:
2717 ret = mbedtls_md4_finish_ret( &operation->ctx.md4, hash );
2718 break;
2719#endif
John Durkopee4e6602020-11-27 08:48:46 -08002720#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002721 case PSA_ALG_MD5:
2722 ret = mbedtls_md5_finish_ret( &operation->ctx.md5, hash );
2723 break;
2724#endif
John Durkopee4e6602020-11-27 08:48:46 -08002725#if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002726 case PSA_ALG_RIPEMD160:
2727 ret = mbedtls_ripemd160_finish_ret( &operation->ctx.ripemd160, hash );
2728 break;
2729#endif
John Durkopee4e6602020-11-27 08:48:46 -08002730#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002731 case PSA_ALG_SHA_1:
2732 ret = mbedtls_sha1_finish_ret( &operation->ctx.sha1, hash );
2733 break;
2734#endif
John Durkop6ca23272020-12-03 06:01:32 -08002735#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002736 case PSA_ALG_SHA_224:
John Durkop6ca23272020-12-03 06:01:32 -08002737 ret = mbedtls_sha256_finish_ret( &operation->ctx.sha256, hash );
2738 break;
2739#endif
2740#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002741 case PSA_ALG_SHA_256:
2742 ret = mbedtls_sha256_finish_ret( &operation->ctx.sha256, hash );
2743 break;
2744#endif
John Durkop6ca23272020-12-03 06:01:32 -08002745#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002746 case PSA_ALG_SHA_384:
John Durkop6ca23272020-12-03 06:01:32 -08002747 ret = mbedtls_sha512_finish_ret( &operation->ctx.sha512, hash );
2748 break;
2749#endif
2750#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002751 case PSA_ALG_SHA_512:
2752 ret = mbedtls_sha512_finish_ret( &operation->ctx.sha512, hash );
2753 break;
2754#endif
2755 default:
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002756 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002757 }
itayzafrir40835d42018-08-02 13:14:17 +03002758 status = mbedtls_to_psa_error( ret );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002759
itayzafrir40835d42018-08-02 13:14:17 +03002760exit:
2761 if( status == PSA_SUCCESS )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002762 {
Gilles Peskineaee13332018-07-02 12:15:28 +02002763 *hash_length = actual_hash_length;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002764 return( psa_hash_abort( operation ) );
2765 }
2766 else
2767 {
2768 psa_hash_abort( operation );
itayzafrir40835d42018-08-02 13:14:17 +03002769 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002770 }
2771}
2772
Gilles Peskine2d277862018-06-18 15:41:12 +02002773psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2774 const uint8_t *hash,
2775 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002776{
2777 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2778 size_t actual_hash_length;
2779 psa_status_t status = psa_hash_finish( operation,
2780 actual_hash, sizeof( actual_hash ),
2781 &actual_hash_length );
2782 if( status != PSA_SUCCESS )
2783 return( status );
2784 if( actual_hash_length != hash_length )
2785 return( PSA_ERROR_INVALID_SIGNATURE );
2786 if( safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
2787 return( PSA_ERROR_INVALID_SIGNATURE );
2788 return( PSA_SUCCESS );
2789}
2790
Gilles Peskine0a749c82019-11-28 19:33:58 +01002791psa_status_t psa_hash_compute( psa_algorithm_t alg,
2792 const uint8_t *input, size_t input_length,
2793 uint8_t *hash, size_t hash_size,
2794 size_t *hash_length )
2795{
2796 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
2797 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2798
2799 *hash_length = hash_size;
2800 status = psa_hash_setup( &operation, alg );
2801 if( status != PSA_SUCCESS )
2802 goto exit;
2803 status = psa_hash_update( &operation, input, input_length );
2804 if( status != PSA_SUCCESS )
2805 goto exit;
2806 status = psa_hash_finish( &operation, hash, hash_size, hash_length );
2807 if( status != PSA_SUCCESS )
2808 goto exit;
2809
2810exit:
2811 if( status == PSA_SUCCESS )
2812 status = psa_hash_abort( &operation );
2813 else
2814 psa_hash_abort( &operation );
2815 return( status );
2816}
2817
2818psa_status_t psa_hash_compare( psa_algorithm_t alg,
2819 const uint8_t *input, size_t input_length,
2820 const uint8_t *hash, size_t hash_length )
2821{
2822 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
2823 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2824
2825 status = psa_hash_setup( &operation, alg );
2826 if( status != PSA_SUCCESS )
2827 goto exit;
2828 status = psa_hash_update( &operation, input, input_length );
2829 if( status != PSA_SUCCESS )
2830 goto exit;
2831 status = psa_hash_verify( &operation, hash, hash_length );
2832 if( status != PSA_SUCCESS )
2833 goto exit;
2834
2835exit:
2836 if( status == PSA_SUCCESS )
2837 status = psa_hash_abort( &operation );
2838 else
2839 psa_hash_abort( &operation );
2840 return( status );
2841}
2842
Gilles Peskineeb35d782019-01-22 17:56:16 +01002843psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2844 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002845{
2846 if( target_operation->alg != 0 )
2847 return( PSA_ERROR_BAD_STATE );
2848
2849 switch( source_operation->alg )
2850 {
2851 case 0:
2852 return( PSA_ERROR_BAD_STATE );
John Durkopee4e6602020-11-27 08:48:46 -08002853#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002854 case PSA_ALG_MD2:
2855 mbedtls_md2_clone( &target_operation->ctx.md2,
2856 &source_operation->ctx.md2 );
2857 break;
2858#endif
John Durkopee4e6602020-11-27 08:48:46 -08002859#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002860 case PSA_ALG_MD4:
2861 mbedtls_md4_clone( &target_operation->ctx.md4,
2862 &source_operation->ctx.md4 );
2863 break;
2864#endif
John Durkopee4e6602020-11-27 08:48:46 -08002865#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002866 case PSA_ALG_MD5:
2867 mbedtls_md5_clone( &target_operation->ctx.md5,
2868 &source_operation->ctx.md5 );
2869 break;
2870#endif
John Durkopee4e6602020-11-27 08:48:46 -08002871#if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002872 case PSA_ALG_RIPEMD160:
2873 mbedtls_ripemd160_clone( &target_operation->ctx.ripemd160,
2874 &source_operation->ctx.ripemd160 );
2875 break;
2876#endif
John Durkopee4e6602020-11-27 08:48:46 -08002877#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002878 case PSA_ALG_SHA_1:
2879 mbedtls_sha1_clone( &target_operation->ctx.sha1,
2880 &source_operation->ctx.sha1 );
2881 break;
2882#endif
John Durkop6ca23272020-12-03 06:01:32 -08002883#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002884 case PSA_ALG_SHA_224:
John Durkop6ca23272020-12-03 06:01:32 -08002885 mbedtls_sha256_clone( &target_operation->ctx.sha256,
2886 &source_operation->ctx.sha256 );
2887 break;
2888#endif
2889#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002890 case PSA_ALG_SHA_256:
2891 mbedtls_sha256_clone( &target_operation->ctx.sha256,
2892 &source_operation->ctx.sha256 );
2893 break;
2894#endif
John Durkop6ca23272020-12-03 06:01:32 -08002895#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002896 case PSA_ALG_SHA_384:
John Durkop6ca23272020-12-03 06:01:32 -08002897 mbedtls_sha512_clone( &target_operation->ctx.sha512,
2898 &source_operation->ctx.sha512 );
2899 break;
2900#endif
2901#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002902 case PSA_ALG_SHA_512:
2903 mbedtls_sha512_clone( &target_operation->ctx.sha512,
2904 &source_operation->ctx.sha512 );
2905 break;
2906#endif
2907 default:
2908 return( PSA_ERROR_NOT_SUPPORTED );
2909 }
2910
2911 target_operation->alg = source_operation->alg;
2912 return( PSA_SUCCESS );
2913}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002914
2915
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002916/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002917/* MAC */
2918/****************************************************************/
2919
Gilles Peskinedc2fc842018-03-07 16:42:59 +01002920static const mbedtls_cipher_info_t *mbedtls_cipher_info_from_psa(
Gilles Peskine8c9def32018-02-08 10:02:12 +01002921 psa_algorithm_t alg,
2922 psa_key_type_t key_type,
Gilles Peskine2d277862018-06-18 15:41:12 +02002923 size_t key_bits,
mohammad1603f4f0d612018-06-03 15:04:51 +03002924 mbedtls_cipher_id_t* cipher_id )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002925{
Gilles Peskine8c9def32018-02-08 10:02:12 +01002926 mbedtls_cipher_mode_t mode;
mohammad1603f4f0d612018-06-03 15:04:51 +03002927 mbedtls_cipher_id_t cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002928
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002929 if( PSA_ALG_IS_AEAD( alg ) )
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002930 alg = PSA_ALG_AEAD_WITH_TAG_LENGTH( alg, 0 );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002931
Gilles Peskine8c9def32018-02-08 10:02:12 +01002932 if( PSA_ALG_IS_CIPHER( alg ) || PSA_ALG_IS_AEAD( alg ) )
2933 {
Nir Sonnenscheine9664c32018-06-17 14:41:30 +03002934 switch( alg )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002935 {
Bence Szépkúti1de907d2020-12-07 18:20:28 +01002936 case PSA_ALG_STREAM_CIPHER:
Gilles Peskine8c9def32018-02-08 10:02:12 +01002937 mode = MBEDTLS_MODE_STREAM;
2938 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002939 case PSA_ALG_CTR:
2940 mode = MBEDTLS_MODE_CTR;
2941 break;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002942 case PSA_ALG_CFB:
2943 mode = MBEDTLS_MODE_CFB;
2944 break;
2945 case PSA_ALG_OFB:
2946 mode = MBEDTLS_MODE_OFB;
2947 break;
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02002948 case PSA_ALG_ECB_NO_PADDING:
2949 mode = MBEDTLS_MODE_ECB;
2950 break;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002951 case PSA_ALG_CBC_NO_PADDING:
2952 mode = MBEDTLS_MODE_CBC;
2953 break;
2954 case PSA_ALG_CBC_PKCS7:
2955 mode = MBEDTLS_MODE_CBC;
2956 break;
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002957 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002958 mode = MBEDTLS_MODE_CCM;
2959 break;
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002960 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_GCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002961 mode = MBEDTLS_MODE_GCM;
2962 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02002963 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CHACHA20_POLY1305, 0 ):
2964 mode = MBEDTLS_MODE_CHACHAPOLY;
2965 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002966 default:
2967 return( NULL );
2968 }
2969 }
2970 else if( alg == PSA_ALG_CMAC )
2971 mode = MBEDTLS_MODE_ECB;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002972 else
2973 return( NULL );
2974
2975 switch( key_type )
2976 {
2977 case PSA_KEY_TYPE_AES:
mohammad1603f4f0d612018-06-03 15:04:51 +03002978 cipher_id_tmp = MBEDTLS_CIPHER_ID_AES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002979 break;
2980 case PSA_KEY_TYPE_DES:
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002981 /* key_bits is 64 for Single-DES, 128 for two-key Triple-DES,
2982 * and 192 for three-key Triple-DES. */
Gilles Peskine8c9def32018-02-08 10:02:12 +01002983 if( key_bits == 64 )
mohammad1603f4f0d612018-06-03 15:04:51 +03002984 cipher_id_tmp = MBEDTLS_CIPHER_ID_DES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002985 else
mohammad1603f4f0d612018-06-03 15:04:51 +03002986 cipher_id_tmp = MBEDTLS_CIPHER_ID_3DES;
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002987 /* mbedtls doesn't recognize two-key Triple-DES as an algorithm,
2988 * but two-key Triple-DES is functionally three-key Triple-DES
2989 * with K1=K3, so that's how we present it to mbedtls. */
2990 if( key_bits == 128 )
2991 key_bits = 192;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002992 break;
2993 case PSA_KEY_TYPE_CAMELLIA:
mohammad1603f4f0d612018-06-03 15:04:51 +03002994 cipher_id_tmp = MBEDTLS_CIPHER_ID_CAMELLIA;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002995 break;
2996 case PSA_KEY_TYPE_ARC4:
mohammad1603f4f0d612018-06-03 15:04:51 +03002997 cipher_id_tmp = MBEDTLS_CIPHER_ID_ARC4;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002998 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02002999 case PSA_KEY_TYPE_CHACHA20:
3000 cipher_id_tmp = MBEDTLS_CIPHER_ID_CHACHA20;
3001 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003002 default:
3003 return( NULL );
3004 }
mohammad1603f4f0d612018-06-03 15:04:51 +03003005 if( cipher_id != NULL )
mohammad160360a64d02018-06-03 17:20:42 +03003006 *cipher_id = cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003007
Jaeden Amero23bbb752018-06-26 14:16:54 +01003008 return( mbedtls_cipher_info_from_values( cipher_id_tmp,
3009 (int) key_bits, mode ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003010}
3011
John Durkop6ba40d12020-11-10 08:50:04 -08003012#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03003013static size_t psa_get_hash_block_size( psa_algorithm_t alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03003014{
Gilles Peskine2d277862018-06-18 15:41:12 +02003015 switch( alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03003016 {
3017 case PSA_ALG_MD2:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03003018 return( 16 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03003019 case PSA_ALG_MD4:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03003020 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03003021 case PSA_ALG_MD5:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03003022 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03003023 case PSA_ALG_RIPEMD160:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03003024 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03003025 case PSA_ALG_SHA_1:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03003026 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03003027 case PSA_ALG_SHA_224:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03003028 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03003029 case PSA_ALG_SHA_256:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03003030 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03003031 case PSA_ALG_SHA_384:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03003032 return( 128 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03003033 case PSA_ALG_SHA_512:
Gilles Peskine2d277862018-06-18 15:41:12 +02003034 return( 128 );
3035 default:
3036 return( 0 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03003037 }
3038}
John Durkop07cc04a2020-11-16 22:08:34 -08003039#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC) */
Nir Sonnenschein0c9ec532018-06-07 13:27:47 +03003040
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003041/* Initialize the MAC operation structure. Once this function has been
3042 * called, psa_mac_abort can run and will do the right thing. */
3043static psa_status_t psa_mac_init( psa_mac_operation_t *operation,
3044 psa_algorithm_t alg )
3045{
3046 psa_status_t status = PSA_ERROR_NOT_SUPPORTED;
3047
3048 operation->alg = alg;
3049 operation->key_set = 0;
3050 operation->iv_set = 0;
3051 operation->iv_required = 0;
3052 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02003053 operation->is_sign = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003054
3055#if defined(MBEDTLS_CMAC_C)
3056 if( alg == PSA_ALG_CMAC )
3057 {
3058 operation->iv_required = 0;
3059 mbedtls_cipher_init( &operation->ctx.cmac );
3060 status = PSA_SUCCESS;
3061 }
3062 else
3063#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07003064#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003065 if( PSA_ALG_IS_HMAC( operation->alg ) )
3066 {
Gilles Peskineff94abd2018-07-12 17:07:52 +02003067 /* We'll set up the hash operation later in psa_hmac_setup_internal. */
3068 operation->ctx.hmac.hash_ctx.alg = 0;
3069 status = PSA_SUCCESS;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003070 }
3071 else
John Durkopd0321952020-10-29 21:37:36 -07003072#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003073 {
Gilles Peskinec06e0712018-06-20 16:21:04 +02003074 if( ! PSA_ALG_IS_MAC( alg ) )
3075 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003076 }
3077
3078 if( status != PSA_SUCCESS )
3079 memset( operation, 0, sizeof( *operation ) );
3080 return( status );
3081}
3082
John Durkop6ba40d12020-11-10 08:50:04 -08003083#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine01126fa2018-07-12 17:04:55 +02003084static psa_status_t psa_hmac_abort_internal( psa_hmac_internal_data *hmac )
3085{
Gilles Peskine3f108122018-12-07 18:14:53 +01003086 mbedtls_platform_zeroize( hmac->opad, sizeof( hmac->opad ) );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003087 return( psa_hash_abort( &hmac->hash_ctx ) );
3088}
John Durkop6ba40d12020-11-10 08:50:04 -08003089#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine01126fa2018-07-12 17:04:55 +02003090
Gilles Peskine8c9def32018-02-08 10:02:12 +01003091psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
3092{
Gilles Peskinefbfac682018-07-08 20:51:54 +02003093 if( operation->alg == 0 )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003094 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02003095 /* The object has (apparently) been initialized but it is not
3096 * in use. It's ok to call abort on such an object, and there's
3097 * nothing to do. */
3098 return( PSA_SUCCESS );
3099 }
3100 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01003101#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003102 if( operation->alg == PSA_ALG_CMAC )
3103 {
3104 mbedtls_cipher_free( &operation->ctx.cmac );
3105 }
3106 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01003107#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07003108#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003109 if( PSA_ALG_IS_HMAC( operation->alg ) )
3110 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02003111 psa_hmac_abort_internal( &operation->ctx.hmac );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003112 }
3113 else
John Durkopd0321952020-10-29 21:37:36 -07003114#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02003115 {
3116 /* Sanity check (shouldn't happen: operation->alg should
3117 * always have been initialized to a valid value). */
3118 goto bad_state;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003119 }
Moran Peker41deec42018-04-04 15:43:05 +03003120
Gilles Peskine8c9def32018-02-08 10:02:12 +01003121 operation->alg = 0;
3122 operation->key_set = 0;
3123 operation->iv_set = 0;
3124 operation->iv_required = 0;
3125 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02003126 operation->is_sign = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003127
Gilles Peskine8c9def32018-02-08 10:02:12 +01003128 return( PSA_SUCCESS );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003129
3130bad_state:
3131 /* If abort is called on an uninitialized object, we can't trust
3132 * anything. Wipe the object in case it contains confidential data.
3133 * This may result in a memory leak if a pointer gets overwritten,
3134 * but it's too late to do anything about this. */
3135 memset( operation, 0, sizeof( *operation ) );
3136 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003137}
3138
Gilles Peskinee3b07d82018-06-19 11:57:35 +02003139#if defined(MBEDTLS_CMAC_C)
Gilles Peskine89167cb2018-07-08 20:12:23 +02003140static int psa_cmac_setup( psa_mac_operation_t *operation,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003141 size_t key_bits,
Gilles Peskine2f060a82018-12-04 17:12:32 +01003142 psa_key_slot_t *slot,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003143 const mbedtls_cipher_info_t *cipher_info )
3144{
Janos Follath24eed8d2019-11-22 13:21:35 +00003145 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003146
3147 operation->mac_size = cipher_info->block_size;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003148
3149 ret = mbedtls_cipher_setup( &operation->ctx.cmac, cipher_info );
3150 if( ret != 0 )
3151 return( ret );
3152
3153 ret = mbedtls_cipher_cmac_starts( &operation->ctx.cmac,
Ronald Cronea0f8a62020-11-25 17:52:23 +01003154 slot->key.data,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003155 key_bits );
3156 return( ret );
3157}
Gilles Peskinee3b07d82018-06-19 11:57:35 +02003158#endif /* MBEDTLS_CMAC_C */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003159
John Durkop6ba40d12020-11-10 08:50:04 -08003160#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine01126fa2018-07-12 17:04:55 +02003161static psa_status_t psa_hmac_setup_internal( psa_hmac_internal_data *hmac,
3162 const uint8_t *key,
3163 size_t key_length,
3164 psa_algorithm_t hash_alg )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003165{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02003166 uint8_t ipad[PSA_HMAC_MAX_HASH_BLOCK_SIZE];
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003167 size_t i;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003168 size_t hash_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003169 size_t block_size = psa_get_hash_block_size( hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003170 psa_status_t status;
3171
Gilles Peskine9aa369e2018-07-16 00:36:29 +02003172 /* Sanity checks on block_size, to guarantee that there won't be a buffer
3173 * overflow below. This should never trigger if the hash algorithm
3174 * is implemented correctly. */
3175 /* The size checks against the ipad and opad buffers cannot be written
3176 * `block_size > sizeof( ipad ) || block_size > sizeof( hmac->opad )`
3177 * because that triggers -Wlogical-op on GCC 7.3. */
3178 if( block_size > sizeof( ipad ) )
3179 return( PSA_ERROR_NOT_SUPPORTED );
3180 if( block_size > sizeof( hmac->opad ) )
3181 return( PSA_ERROR_NOT_SUPPORTED );
3182 if( block_size < hash_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003183 return( PSA_ERROR_NOT_SUPPORTED );
3184
Gilles Peskined223b522018-06-11 18:12:58 +02003185 if( key_length > block_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003186 {
Gilles Peskine84b8fc82019-11-28 20:07:20 +01003187 status = psa_hash_compute( hash_alg, key, key_length,
3188 ipad, sizeof( ipad ), &key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003189 if( status != PSA_SUCCESS )
Gilles Peskineb8be2882018-07-17 16:24:34 +02003190 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003191 }
Gilles Peskine96889972018-07-12 17:07:03 +02003192 /* A 0-length key is not commonly used in HMAC when used as a MAC,
3193 * but it is permitted. It is common when HMAC is used in HKDF, for
3194 * example. Don't call `memcpy` in the 0-length because `key` could be
3195 * an invalid pointer which would make the behavior undefined. */
3196 else if( key_length != 0 )
Gilles Peskine01126fa2018-07-12 17:04:55 +02003197 memcpy( ipad, key, key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003198
Gilles Peskined223b522018-06-11 18:12:58 +02003199 /* ipad contains the key followed by garbage. Xor and fill with 0x36
3200 * to create the ipad value. */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003201 for( i = 0; i < key_length; i++ )
Gilles Peskined223b522018-06-11 18:12:58 +02003202 ipad[i] ^= 0x36;
3203 memset( ipad + key_length, 0x36, block_size - key_length );
3204
3205 /* Copy the key material from ipad to opad, flipping the requisite bits,
3206 * and filling the rest of opad with the requisite constant. */
3207 for( i = 0; i < key_length; i++ )
Gilles Peskine01126fa2018-07-12 17:04:55 +02003208 hmac->opad[i] = ipad[i] ^ 0x36 ^ 0x5C;
3209 memset( hmac->opad + key_length, 0x5C, block_size - key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003210
Gilles Peskine01126fa2018-07-12 17:04:55 +02003211 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003212 if( status != PSA_SUCCESS )
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003213 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003214
Gilles Peskine01126fa2018-07-12 17:04:55 +02003215 status = psa_hash_update( &hmac->hash_ctx, ipad, block_size );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003216
3217cleanup:
Steven Cooreman29149862020-08-05 15:43:42 +02003218 mbedtls_platform_zeroize( ipad, sizeof( ipad ) );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003219
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003220 return( status );
3221}
John Durkop6ba40d12020-11-10 08:50:04 -08003222#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003223
Gilles Peskine89167cb2018-07-08 20:12:23 +02003224static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003225 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02003226 psa_algorithm_t alg,
3227 int is_sign )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003228{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003229 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003230 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003231 psa_key_slot_t *slot;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003232 size_t key_bits;
Gilles Peskine89167cb2018-07-08 20:12:23 +02003233 psa_key_usage_t usage =
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003234 is_sign ? PSA_KEY_USAGE_SIGN_HASH : PSA_KEY_USAGE_VERIFY_HASH;
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02003235 uint8_t truncated = PSA_MAC_TRUNCATED_LENGTH( alg );
Gilles Peskinee0e9c7c2018-10-17 18:28:05 +02003236 psa_algorithm_t full_length_alg = PSA_ALG_FULL_LENGTH_MAC( alg );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003237
Jaeden Amero36ee5d02019-02-19 09:25:10 +00003238 /* A context must be freshly initialized before it can be set up. */
3239 if( operation->alg != 0 )
3240 {
3241 return( PSA_ERROR_BAD_STATE );
3242 }
3243
Gilles Peskined911eb72018-08-14 15:18:45 +02003244 status = psa_mac_init( operation, full_length_alg );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003245 if( status != PSA_SUCCESS )
3246 return( status );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003247 if( is_sign )
3248 operation->is_sign = 1;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003249
Ronald Cron5c522922020-11-14 16:35:34 +01003250 status = psa_get_and_lock_transparent_key_slot_with_policy(
3251 key, &slot, usage, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003252 if( status != PSA_SUCCESS )
Gilles Peskinefbfac682018-07-08 20:51:54 +02003253 goto exit;
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02003254 key_bits = psa_get_key_slot_bits( slot );
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02003255
Gilles Peskine8c9def32018-02-08 10:02:12 +01003256#if defined(MBEDTLS_CMAC_C)
Gilles Peskined911eb72018-08-14 15:18:45 +02003257 if( full_length_alg == PSA_ALG_CMAC )
Gilles Peskinefbfac682018-07-08 20:51:54 +02003258 {
3259 const mbedtls_cipher_info_t *cipher_info =
Gilles Peskined911eb72018-08-14 15:18:45 +02003260 mbedtls_cipher_info_from_psa( full_length_alg,
Gilles Peskine8e338702019-07-30 20:06:31 +02003261 slot->attr.type, key_bits, NULL );
Janos Follath24eed8d2019-11-22 13:21:35 +00003262 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinefbfac682018-07-08 20:51:54 +02003263 if( cipher_info == NULL )
3264 {
3265 status = PSA_ERROR_NOT_SUPPORTED;
3266 goto exit;
3267 }
3268 operation->mac_size = cipher_info->block_size;
3269 ret = psa_cmac_setup( operation, key_bits, slot, cipher_info );
3270 status = mbedtls_to_psa_error( ret );
3271 }
3272 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01003273#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07003274#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskined911eb72018-08-14 15:18:45 +02003275 if( PSA_ALG_IS_HMAC( full_length_alg ) )
Gilles Peskinefbfac682018-07-08 20:51:54 +02003276 {
Gilles Peskine00709fa2018-08-22 18:25:41 +02003277 psa_algorithm_t hash_alg = PSA_ALG_HMAC_GET_HASH( alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003278 if( hash_alg == 0 )
3279 {
3280 status = PSA_ERROR_NOT_SUPPORTED;
3281 goto exit;
3282 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02003283
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003284 operation->mac_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine9aa369e2018-07-16 00:36:29 +02003285 /* Sanity check. This shouldn't fail on a valid configuration. */
3286 if( operation->mac_size == 0 ||
3287 operation->mac_size > sizeof( operation->ctx.hmac.opad ) )
3288 {
3289 status = PSA_ERROR_NOT_SUPPORTED;
3290 goto exit;
3291 }
3292
Gilles Peskine8e338702019-07-30 20:06:31 +02003293 if( slot->attr.type != PSA_KEY_TYPE_HMAC )
Gilles Peskine01126fa2018-07-12 17:04:55 +02003294 {
3295 status = PSA_ERROR_INVALID_ARGUMENT;
3296 goto exit;
3297 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02003298
Gilles Peskine01126fa2018-07-12 17:04:55 +02003299 status = psa_hmac_setup_internal( &operation->ctx.hmac,
Ronald Cronea0f8a62020-11-25 17:52:23 +01003300 slot->key.data,
3301 slot->key.bytes,
Gilles Peskine01126fa2018-07-12 17:04:55 +02003302 hash_alg );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003303 }
3304 else
John Durkopd0321952020-10-29 21:37:36 -07003305#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02003306 {
Jaeden Amero82df32e2018-11-23 15:11:20 +00003307 (void) key_bits;
Gilles Peskinefbfac682018-07-08 20:51:54 +02003308 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003309 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003310
Gilles Peskined911eb72018-08-14 15:18:45 +02003311 if( truncated == 0 )
3312 {
3313 /* The "normal" case: untruncated algorithm. Nothing to do. */
3314 }
3315 else if( truncated < 4 )
3316 {
Gilles Peskine6d72ff92018-08-21 14:55:08 +02003317 /* A very short MAC is too short for security since it can be
3318 * brute-forced. Ancient protocols with 32-bit MACs do exist,
3319 * so we make this our minimum, even though 32 bits is still
3320 * too small for security. */
Gilles Peskined911eb72018-08-14 15:18:45 +02003321 status = PSA_ERROR_NOT_SUPPORTED;
3322 }
3323 else if( truncated > operation->mac_size )
3324 {
3325 /* It's impossible to "truncate" to a larger length. */
3326 status = PSA_ERROR_INVALID_ARGUMENT;
3327 }
3328 else
3329 operation->mac_size = truncated;
3330
Gilles Peskinefbfac682018-07-08 20:51:54 +02003331exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003332 if( status != PSA_SUCCESS )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003333 {
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003334 psa_mac_abort( operation );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003335 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003336 else
3337 {
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003338 operation->key_set = 1;
3339 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003340
Ronald Cron5c522922020-11-14 16:35:34 +01003341 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003342
Ronald Cron5c522922020-11-14 16:35:34 +01003343 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003344}
3345
Gilles Peskine89167cb2018-07-08 20:12:23 +02003346psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003347 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02003348 psa_algorithm_t alg )
3349{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003350 return( psa_mac_setup( operation, key, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003351}
3352
3353psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003354 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02003355 psa_algorithm_t alg )
3356{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003357 return( psa_mac_setup( operation, key, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003358}
3359
Gilles Peskine8c9def32018-02-08 10:02:12 +01003360psa_status_t psa_mac_update( psa_mac_operation_t *operation,
3361 const uint8_t *input,
3362 size_t input_length )
3363{
Gilles Peskinefbfac682018-07-08 20:51:54 +02003364 psa_status_t status = PSA_ERROR_BAD_STATE;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003365 if( ! operation->key_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003366 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003367 if( operation->iv_required && ! operation->iv_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003368 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003369 operation->has_input = 1;
3370
Gilles Peskine8c9def32018-02-08 10:02:12 +01003371#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003372 if( operation->alg == PSA_ALG_CMAC )
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03003373 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02003374 int ret = mbedtls_cipher_cmac_update( &operation->ctx.cmac,
3375 input, input_length );
3376 status = mbedtls_to_psa_error( ret );
3377 }
3378 else
3379#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07003380#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003381 if( PSA_ALG_IS_HMAC( operation->alg ) )
3382 {
3383 status = psa_hash_update( &operation->ctx.hmac.hash_ctx, input,
3384 input_length );
3385 }
3386 else
John Durkopd0321952020-10-29 21:37:36 -07003387#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02003388 {
3389 /* This shouldn't happen if `operation` was initialized by
3390 * a setup function. */
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003391 return( PSA_ERROR_BAD_STATE );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03003392 }
3393
Gilles Peskinefbfac682018-07-08 20:51:54 +02003394 if( status != PSA_SUCCESS )
3395 psa_mac_abort( operation );
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02003396 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003397}
3398
John Durkop6ba40d12020-11-10 08:50:04 -08003399#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine01126fa2018-07-12 17:04:55 +02003400static psa_status_t psa_hmac_finish_internal( psa_hmac_internal_data *hmac,
3401 uint8_t *mac,
3402 size_t mac_size )
3403{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02003404 uint8_t tmp[MBEDTLS_MD_MAX_SIZE];
Gilles Peskine01126fa2018-07-12 17:04:55 +02003405 psa_algorithm_t hash_alg = hmac->hash_ctx.alg;
3406 size_t hash_size = 0;
3407 size_t block_size = psa_get_hash_block_size( hash_alg );
3408 psa_status_t status;
3409
Gilles Peskine01126fa2018-07-12 17:04:55 +02003410 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
3411 if( status != PSA_SUCCESS )
3412 return( status );
3413 /* From here on, tmp needs to be wiped. */
3414
3415 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
3416 if( status != PSA_SUCCESS )
3417 goto exit;
3418
3419 status = psa_hash_update( &hmac->hash_ctx, hmac->opad, block_size );
3420 if( status != PSA_SUCCESS )
3421 goto exit;
3422
3423 status = psa_hash_update( &hmac->hash_ctx, tmp, hash_size );
3424 if( status != PSA_SUCCESS )
3425 goto exit;
3426
Gilles Peskined911eb72018-08-14 15:18:45 +02003427 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
3428 if( status != PSA_SUCCESS )
3429 goto exit;
3430
3431 memcpy( mac, tmp, mac_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003432
3433exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01003434 mbedtls_platform_zeroize( tmp, hash_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003435 return( status );
3436}
John Durkop6ba40d12020-11-10 08:50:04 -08003437#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine01126fa2018-07-12 17:04:55 +02003438
mohammad16036df908f2018-04-02 08:34:15 -07003439static psa_status_t psa_mac_finish_internal( psa_mac_operation_t *operation,
Gilles Peskine2d277862018-06-18 15:41:12 +02003440 uint8_t *mac,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003441 size_t mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003442{
Gilles Peskine1d96fff2018-07-02 12:15:39 +02003443 if( ! operation->key_set )
3444 return( PSA_ERROR_BAD_STATE );
3445 if( operation->iv_required && ! operation->iv_set )
3446 return( PSA_ERROR_BAD_STATE );
3447
Gilles Peskine8c9def32018-02-08 10:02:12 +01003448 if( mac_size < operation->mac_size )
3449 return( PSA_ERROR_BUFFER_TOO_SMALL );
3450
Gilles Peskine8c9def32018-02-08 10:02:12 +01003451#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003452 if( operation->alg == PSA_ALG_CMAC )
3453 {
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003454 uint8_t tmp[PSA_BLOCK_CIPHER_BLOCK_MAX_SIZE];
Gilles Peskined911eb72018-08-14 15:18:45 +02003455 int ret = mbedtls_cipher_cmac_finish( &operation->ctx.cmac, tmp );
3456 if( ret == 0 )
Gilles Peskine87b0ac42018-08-21 14:55:49 +02003457 memcpy( mac, tmp, operation->mac_size );
Gilles Peskine3f108122018-12-07 18:14:53 +01003458 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003459 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003460 }
Gilles Peskinefbfac682018-07-08 20:51:54 +02003461 else
3462#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07003463#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003464 if( PSA_ALG_IS_HMAC( operation->alg ) )
3465 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02003466 return( psa_hmac_finish_internal( &operation->ctx.hmac,
Gilles Peskined911eb72018-08-14 15:18:45 +02003467 mac, operation->mac_size ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003468 }
3469 else
John Durkopd0321952020-10-29 21:37:36 -07003470#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02003471 {
3472 /* This shouldn't happen if `operation` was initialized by
3473 * a setup function. */
3474 return( PSA_ERROR_BAD_STATE );
3475 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01003476}
3477
Gilles Peskineacd4be32018-07-08 19:56:25 +02003478psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
3479 uint8_t *mac,
3480 size_t mac_size,
3481 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07003482{
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003483 psa_status_t status;
3484
Jaeden Amero252ef282019-02-15 14:05:35 +00003485 if( operation->alg == 0 )
3486 {
3487 return( PSA_ERROR_BAD_STATE );
3488 }
3489
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003490 /* Fill the output buffer with something that isn't a valid mac
3491 * (barring an attack on the mac and deliberately-crafted input),
3492 * in case the caller doesn't check the return status properly. */
3493 *mac_length = mac_size;
3494 /* If mac_size is 0 then mac may be NULL and then the
3495 * call to memset would have undefined behavior. */
3496 if( mac_size != 0 )
3497 memset( mac, '!', mac_size );
3498
Gilles Peskine89167cb2018-07-08 20:12:23 +02003499 if( ! operation->is_sign )
3500 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003501 return( PSA_ERROR_BAD_STATE );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003502 }
mohammad16036df908f2018-04-02 08:34:15 -07003503
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003504 status = psa_mac_finish_internal( operation, mac, mac_size );
3505
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003506 if( status == PSA_SUCCESS )
3507 {
3508 status = psa_mac_abort( operation );
3509 if( status == PSA_SUCCESS )
3510 *mac_length = operation->mac_size;
3511 else
3512 memset( mac, '!', mac_size );
3513 }
3514 else
3515 psa_mac_abort( operation );
3516 return( status );
mohammad16036df908f2018-04-02 08:34:15 -07003517}
3518
Gilles Peskineacd4be32018-07-08 19:56:25 +02003519psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
3520 const uint8_t *mac,
3521 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003522{
Gilles Peskine828ed142018-06-18 23:25:51 +02003523 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
mohammad16036df908f2018-04-02 08:34:15 -07003524 psa_status_t status;
3525
Jaeden Amero252ef282019-02-15 14:05:35 +00003526 if( operation->alg == 0 )
3527 {
3528 return( PSA_ERROR_BAD_STATE );
3529 }
3530
Gilles Peskine89167cb2018-07-08 20:12:23 +02003531 if( operation->is_sign )
3532 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003533 return( PSA_ERROR_BAD_STATE );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003534 }
3535 if( operation->mac_size != mac_length )
3536 {
3537 status = PSA_ERROR_INVALID_SIGNATURE;
3538 goto cleanup;
Gilles Peskine89167cb2018-07-08 20:12:23 +02003539 }
mohammad16036df908f2018-04-02 08:34:15 -07003540
3541 status = psa_mac_finish_internal( operation,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003542 actual_mac, sizeof( actual_mac ) );
Gilles Peskine28cd4162020-01-20 16:31:06 +01003543 if( status != PSA_SUCCESS )
3544 goto cleanup;
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003545
3546 if( safer_memcmp( mac, actual_mac, mac_length ) != 0 )
3547 status = PSA_ERROR_INVALID_SIGNATURE;
3548
3549cleanup:
3550 if( status == PSA_SUCCESS )
3551 status = psa_mac_abort( operation );
3552 else
3553 psa_mac_abort( operation );
3554
Gilles Peskine3f108122018-12-07 18:14:53 +01003555 mbedtls_platform_zeroize( actual_mac, sizeof( actual_mac ) );
Gilles Peskined911eb72018-08-14 15:18:45 +02003556
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003557 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003558}
3559
3560
Gilles Peskine20035e32018-02-03 22:44:14 +01003561
Gilles Peskine20035e32018-02-03 22:44:14 +01003562/****************************************************************/
3563/* Asymmetric cryptography */
3564/****************************************************************/
3565
John Durkop6ba40d12020-11-10 08:50:04 -08003566#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
3567 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02003568/* Decode the hash algorithm from alg and store the mbedtls encoding in
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003569 * md_alg. Verify that the hash length is acceptable. */
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02003570static psa_status_t psa_rsa_decode_md_type( psa_algorithm_t alg,
3571 size_t hash_length,
3572 mbedtls_md_type_t *md_alg )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003573{
Gilles Peskine7ed29c52018-06-26 15:50:08 +02003574 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003575 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003576 *md_alg = mbedtls_md_get_type( md_info );
3577
3578 /* The Mbed TLS RSA module uses an unsigned int for hash length
3579 * parameters. Validate that it fits so that we don't risk an
3580 * overflow later. */
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003581#if SIZE_MAX > UINT_MAX
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003582 if( hash_length > UINT_MAX )
3583 return( PSA_ERROR_INVALID_ARGUMENT );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003584#endif
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003585
John Durkop0e005192020-10-31 22:06:54 -07003586#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN)
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003587 /* For PKCS#1 v1.5 signature, if using a hash, the hash length
3588 * must be correct. */
3589 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) &&
3590 alg != PSA_ALG_RSA_PKCS1V15_SIGN_RAW )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003591 {
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003592 if( md_info == NULL )
3593 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003594 if( mbedtls_md_get_size( md_info ) != hash_length )
3595 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003596 }
John Durkop0e005192020-10-31 22:06:54 -07003597#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN */
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003598
John Durkop0e005192020-10-31 22:06:54 -07003599#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003600 /* PSS requires a hash internally. */
3601 if( PSA_ALG_IS_RSA_PSS( alg ) )
3602 {
Gilles Peskine61b91d42018-06-08 16:09:36 +02003603 if( md_info == NULL )
3604 return( PSA_ERROR_NOT_SUPPORTED );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003605 }
John Durkop0e005192020-10-31 22:06:54 -07003606#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS */
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003607
Gilles Peskine61b91d42018-06-08 16:09:36 +02003608 return( PSA_SUCCESS );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003609}
3610
Gilles Peskine2b450e32018-06-27 15:42:46 +02003611static psa_status_t psa_rsa_sign( mbedtls_rsa_context *rsa,
3612 psa_algorithm_t alg,
3613 const uint8_t *hash,
3614 size_t hash_length,
3615 uint8_t *signature,
3616 size_t signature_size,
3617 size_t *signature_length )
3618{
3619 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00003620 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003621 mbedtls_md_type_t md_alg;
3622
3623 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
3624 if( status != PSA_SUCCESS )
3625 return( status );
3626
Gilles Peskine630a18a2018-06-29 17:49:35 +02003627 if( signature_size < mbedtls_rsa_get_len( rsa ) )
Gilles Peskine2b450e32018-06-27 15:42:46 +02003628 return( PSA_ERROR_BUFFER_TOO_SMALL );
3629
John Durkop0e005192020-10-31 22:06:54 -07003630#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN)
Gilles Peskine2b450e32018-06-27 15:42:46 +02003631 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
3632 {
3633 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
3634 MBEDTLS_MD_NONE );
3635 ret = mbedtls_rsa_pkcs1_sign( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003636 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003637 MBEDTLS_PSA_RANDOM_STATE,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003638 MBEDTLS_RSA_PRIVATE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003639 md_alg,
3640 (unsigned int) hash_length,
3641 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003642 signature );
3643 }
3644 else
John Durkop0e005192020-10-31 22:06:54 -07003645#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN */
3646#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine2b450e32018-06-27 15:42:46 +02003647 if( PSA_ALG_IS_RSA_PSS( alg ) )
3648 {
3649 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3650 ret = mbedtls_rsa_rsassa_pss_sign( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003651 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003652 MBEDTLS_PSA_RANDOM_STATE,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003653 MBEDTLS_RSA_PRIVATE,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003654 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003655 (unsigned int) hash_length,
3656 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003657 signature );
3658 }
3659 else
John Durkop0e005192020-10-31 22:06:54 -07003660#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS */
Gilles Peskine2b450e32018-06-27 15:42:46 +02003661 {
3662 return( PSA_ERROR_INVALID_ARGUMENT );
3663 }
3664
3665 if( ret == 0 )
Gilles Peskine630a18a2018-06-29 17:49:35 +02003666 *signature_length = mbedtls_rsa_get_len( rsa );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003667 return( mbedtls_to_psa_error( ret ) );
3668}
3669
3670static psa_status_t psa_rsa_verify( mbedtls_rsa_context *rsa,
3671 psa_algorithm_t alg,
3672 const uint8_t *hash,
3673 size_t hash_length,
3674 const uint8_t *signature,
3675 size_t signature_length )
3676{
3677 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00003678 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003679 mbedtls_md_type_t md_alg;
3680
3681 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
3682 if( status != PSA_SUCCESS )
3683 return( status );
3684
Gilles Peskine89cc74f2019-09-12 22:08:23 +02003685 if( signature_length != mbedtls_rsa_get_len( rsa ) )
3686 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003687
John Durkop0e005192020-10-31 22:06:54 -07003688#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN)
Gilles Peskine2b450e32018-06-27 15:42:46 +02003689 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
3690 {
3691 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
3692 MBEDTLS_MD_NONE );
3693 ret = mbedtls_rsa_pkcs1_verify( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003694 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003695 MBEDTLS_PSA_RANDOM_STATE,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003696 MBEDTLS_RSA_PUBLIC,
3697 md_alg,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003698 (unsigned int) hash_length,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003699 hash,
3700 signature );
3701 }
3702 else
John Durkop0e005192020-10-31 22:06:54 -07003703#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN */
3704#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine2b450e32018-06-27 15:42:46 +02003705 if( PSA_ALG_IS_RSA_PSS( alg ) )
3706 {
3707 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3708 ret = mbedtls_rsa_rsassa_pss_verify( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003709 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003710 MBEDTLS_PSA_RANDOM_STATE,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003711 MBEDTLS_RSA_PUBLIC,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003712 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003713 (unsigned int) hash_length,
3714 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003715 signature );
3716 }
3717 else
John Durkop0e005192020-10-31 22:06:54 -07003718#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS */
Gilles Peskine2b450e32018-06-27 15:42:46 +02003719 {
3720 return( PSA_ERROR_INVALID_ARGUMENT );
3721 }
Gilles Peskineef12c632018-09-13 20:37:48 +02003722
3723 /* Mbed TLS distinguishes "invalid padding" from "valid padding but
3724 * the rest of the signature is invalid". This has little use in
3725 * practice and PSA doesn't report this distinction. */
3726 if( ret == MBEDTLS_ERR_RSA_INVALID_PADDING )
3727 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003728 return( mbedtls_to_psa_error( ret ) );
3729}
John Durkop6ba40d12020-11-10 08:50:04 -08003730#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3731 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine2b450e32018-06-27 15:42:46 +02003732
John Durkop6ba40d12020-11-10 08:50:04 -08003733#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3734 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003735/* `ecp` cannot be const because `ecp->grp` needs to be non-const
3736 * for mbedtls_ecdsa_sign() and mbedtls_ecdsa_sign_det()
3737 * (even though these functions don't modify it). */
3738static psa_status_t psa_ecdsa_sign( mbedtls_ecp_keypair *ecp,
3739 psa_algorithm_t alg,
3740 const uint8_t *hash,
3741 size_t hash_length,
3742 uint8_t *signature,
3743 size_t signature_size,
3744 size_t *signature_length )
3745{
Janos Follath24eed8d2019-11-22 13:21:35 +00003746 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003747 mbedtls_mpi r, s;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003748 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003749 mbedtls_mpi_init( &r );
3750 mbedtls_mpi_init( &s );
3751
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003752 if( signature_size < 2 * curve_bytes )
3753 {
3754 ret = MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL;
3755 goto cleanup;
3756 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003757
John Durkop0ea39e02020-10-13 19:58:20 -07003758#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003759 if( PSA_ALG_DSA_IS_DETERMINISTIC( alg ) )
3760 {
3761 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
3762 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3763 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
Darryl Green5e843fa2019-09-05 14:06:34 +01003764 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign_det_ext( &ecp->grp, &r, &s,
3765 &ecp->d, hash,
3766 hash_length, md_alg,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003767 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003768 MBEDTLS_PSA_RANDOM_STATE ) );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003769 }
3770 else
John Durkop0ea39e02020-10-13 19:58:20 -07003771#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003772 {
Gilles Peskinea05219c2018-11-16 16:02:56 +01003773 (void) alg;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003774 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign( &ecp->grp, &r, &s, &ecp->d,
3775 hash, hash_length,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003776 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003777 MBEDTLS_PSA_RANDOM_STATE ) );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003778 }
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003779
3780 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &r,
3781 signature,
3782 curve_bytes ) );
3783 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &s,
3784 signature + curve_bytes,
3785 curve_bytes ) );
3786
3787cleanup:
3788 mbedtls_mpi_free( &r );
3789 mbedtls_mpi_free( &s );
3790 if( ret == 0 )
3791 *signature_length = 2 * curve_bytes;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003792 return( mbedtls_to_psa_error( ret ) );
3793}
3794
3795static psa_status_t psa_ecdsa_verify( mbedtls_ecp_keypair *ecp,
3796 const uint8_t *hash,
3797 size_t hash_length,
3798 const uint8_t *signature,
3799 size_t signature_length )
3800{
Janos Follath24eed8d2019-11-22 13:21:35 +00003801 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003802 mbedtls_mpi r, s;
3803 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
3804 mbedtls_mpi_init( &r );
3805 mbedtls_mpi_init( &s );
3806
3807 if( signature_length != 2 * curve_bytes )
3808 return( PSA_ERROR_INVALID_SIGNATURE );
3809
3810 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &r,
3811 signature,
3812 curve_bytes ) );
3813 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &s,
3814 signature + curve_bytes,
3815 curve_bytes ) );
3816
Steven Cooremanacda8342020-07-24 23:09:52 +02003817 /* Check whether the public part is loaded. If not, load it. */
3818 if( mbedtls_ecp_is_zero( &ecp->Q ) )
3819 {
3820 MBEDTLS_MPI_CHK(
3821 mbedtls_ecp_mul( &ecp->grp, &ecp->Q, &ecp->d, &ecp->grp.G,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003822 mbedtls_psa_get_random, MBEDTLS_PSA_RANDOM_STATE ) );
Steven Cooremanacda8342020-07-24 23:09:52 +02003823 }
3824
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003825 ret = mbedtls_ecdsa_verify( &ecp->grp, hash, hash_length,
3826 &ecp->Q, &r, &s );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003827
3828cleanup:
3829 mbedtls_mpi_free( &r );
3830 mbedtls_mpi_free( &s );
3831 return( mbedtls_to_psa_error( ret ) );
3832}
John Durkop6ba40d12020-11-10 08:50:04 -08003833#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3834 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003835
Ronald Croncf56a0a2020-08-04 09:51:30 +02003836psa_status_t psa_sign_hash( mbedtls_svc_key_id_t key,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003837 psa_algorithm_t alg,
3838 const uint8_t *hash,
3839 size_t hash_length,
3840 uint8_t *signature,
3841 size_t signature_size,
3842 size_t *signature_length )
Gilles Peskine20035e32018-02-03 22:44:14 +01003843{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003844 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003845 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003846 psa_key_slot_t *slot;
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003847
3848 *signature_length = signature_size;
Gilles Peskine4019f0e2019-09-12 22:05:59 +02003849 /* Immediately reject a zero-length signature buffer. This guarantees
3850 * that signature must be a valid pointer. (On the other hand, the hash
3851 * buffer can in principle be empty since it doesn't actually have
3852 * to be a hash.) */
3853 if( signature_size == 0 )
3854 return( PSA_ERROR_BUFFER_TOO_SMALL );
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003855
Ronald Cron5c522922020-11-14 16:35:34 +01003856 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3857 PSA_KEY_USAGE_SIGN_HASH,
3858 alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003859 if( status != PSA_SUCCESS )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003860 goto exit;
Gilles Peskine8e338702019-07-30 20:06:31 +02003861 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003862 {
3863 status = PSA_ERROR_INVALID_ARGUMENT;
3864 goto exit;
3865 }
Gilles Peskine20035e32018-02-03 22:44:14 +01003866
Steven Cooremancd84cb42020-07-16 20:28:36 +02003867 /* Try any of the available accelerators first */
3868 status = psa_driver_wrapper_sign_hash( slot,
3869 alg,
3870 hash,
3871 hash_length,
3872 signature,
3873 signature_size,
3874 signature_length );
Steven Cooreman8d2bde72020-09-04 13:06:39 +02003875 if( status != PSA_ERROR_NOT_SUPPORTED ||
3876 psa_key_lifetime_is_external( slot->attr.lifetime ) )
Steven Cooremancd84cb42020-07-16 20:28:36 +02003877 goto exit;
3878
Steven Cooreman7a250572020-07-17 16:43:05 +02003879 /* If the operation was not supported by any accelerator, try fallback. */
John Durkop6ba40d12020-11-10 08:50:04 -08003880#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
3881 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine8e338702019-07-30 20:06:31 +02003882 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskine20035e32018-02-03 22:44:14 +01003883 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003884 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02003885
Ronald Cron90857082020-11-25 14:58:33 +01003886 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3887 slot->key.data,
3888 slot->key.bytes,
3889 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003890 if( status != PSA_SUCCESS )
3891 goto exit;
3892
Steven Cooremana2371e52020-07-28 14:30:39 +02003893 status = psa_rsa_sign( rsa,
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003894 alg,
3895 hash, hash_length,
3896 signature, signature_size,
3897 signature_length );
Steven Cooremana01795d2020-07-24 22:48:15 +02003898
Steven Cooremana2371e52020-07-28 14:30:39 +02003899 mbedtls_rsa_free( rsa );
3900 mbedtls_free( rsa );
Gilles Peskine20035e32018-02-03 22:44:14 +01003901 }
3902 else
John Durkop6ba40d12020-11-10 08:50:04 -08003903#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3904 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine8e338702019-07-30 20:06:31 +02003905 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
Gilles Peskine20035e32018-02-03 22:44:14 +01003906 {
John Durkop9814fa22020-11-04 12:28:15 -08003907#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3908 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea05219c2018-11-16 16:02:56 +01003909 if(
John Durkop0ea39e02020-10-13 19:58:20 -07003910#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea05219c2018-11-16 16:02:56 +01003911 PSA_ALG_IS_ECDSA( alg )
3912#else
3913 PSA_ALG_IS_RANDOMIZED_ECDSA( alg )
3914#endif
3915 )
Steven Cooremanacda8342020-07-24 23:09:52 +02003916 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003917 mbedtls_ecp_keypair *ecp = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003918 status = mbedtls_psa_ecp_load_representation( slot->attr.type,
3919 slot->key.data,
3920 slot->key.bytes,
3921 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003922 if( status != PSA_SUCCESS )
3923 goto exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003924 status = psa_ecdsa_sign( ecp,
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003925 alg,
3926 hash, hash_length,
3927 signature, signature_size,
3928 signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02003929 mbedtls_ecp_keypair_free( ecp );
3930 mbedtls_free( ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003931 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003932 else
John Durkop9814fa22020-11-04 12:28:15 -08003933#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3934 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003935 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003936 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003937 }
itayzafrir5c753392018-05-08 11:18:38 +03003938 }
3939 else
itayzafrir5c753392018-05-08 11:18:38 +03003940 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003941 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine20035e32018-02-03 22:44:14 +01003942 }
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003943
3944exit:
3945 /* Fill the unused part of the output buffer (the whole buffer on error,
3946 * the trailing part on success) with something that isn't a valid mac
3947 * (barring an attack on the mac and deliberately-crafted input),
3948 * in case the caller doesn't check the return status properly. */
3949 if( status == PSA_SUCCESS )
3950 memset( signature + *signature_length, '!',
3951 signature_size - *signature_length );
Gilles Peskine4019f0e2019-09-12 22:05:59 +02003952 else
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003953 memset( signature, '!', signature_size );
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003954 /* If signature_size is 0 then we have nothing to do. We must not call
3955 * memset because signature may be NULL in this case. */
Ronald Cronf95a2b12020-10-22 15:24:49 +02003956
Ronald Cron5c522922020-11-14 16:35:34 +01003957 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003958
Ronald Cron5c522922020-11-14 16:35:34 +01003959 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
itayzafrir5c753392018-05-08 11:18:38 +03003960}
3961
Ronald Croncf56a0a2020-08-04 09:51:30 +02003962psa_status_t psa_verify_hash( mbedtls_svc_key_id_t key,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003963 psa_algorithm_t alg,
3964 const uint8_t *hash,
3965 size_t hash_length,
3966 const uint8_t *signature,
3967 size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03003968{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003969 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003970 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003971 psa_key_slot_t *slot;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003972
Ronald Cron5c522922020-11-14 16:35:34 +01003973 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3974 PSA_KEY_USAGE_VERIFY_HASH,
3975 alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003976 if( status != PSA_SUCCESS )
3977 return( status );
itayzafrir5c753392018-05-08 11:18:38 +03003978
Steven Cooreman55ae2172020-07-17 19:46:15 +02003979 /* Try any of the available accelerators first */
3980 status = psa_driver_wrapper_verify_hash( slot,
3981 alg,
3982 hash,
3983 hash_length,
3984 signature,
3985 signature_length );
Steven Cooreman8d2bde72020-09-04 13:06:39 +02003986 if( status != PSA_ERROR_NOT_SUPPORTED ||
3987 psa_key_lifetime_is_external( slot->attr.lifetime ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003988 goto exit;
Steven Cooreman55ae2172020-07-17 19:46:15 +02003989
John Durkop6ba40d12020-11-10 08:50:04 -08003990#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
3991 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine8e338702019-07-30 20:06:31 +02003992 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003993 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003994 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02003995
Ronald Cron90857082020-11-25 14:58:33 +01003996 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3997 slot->key.data,
3998 slot->key.bytes,
3999 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02004000 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004001 goto exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02004002
Steven Cooremana2371e52020-07-28 14:30:39 +02004003 status = psa_rsa_verify( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02004004 alg,
4005 hash, hash_length,
4006 signature, signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02004007 mbedtls_rsa_free( rsa );
4008 mbedtls_free( rsa );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004009 goto exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004010 }
4011 else
John Durkop6ba40d12020-11-10 08:50:04 -08004012#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
4013 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine8e338702019-07-30 20:06:31 +02004014 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
itayzafrir5c753392018-05-08 11:18:38 +03004015 {
John Durkop9814fa22020-11-04 12:28:15 -08004016#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
4017 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02004018 if( PSA_ALG_IS_ECDSA( alg ) )
Steven Cooremanacda8342020-07-24 23:09:52 +02004019 {
Steven Cooremana2371e52020-07-28 14:30:39 +02004020 mbedtls_ecp_keypair *ecp = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01004021 status = mbedtls_psa_ecp_load_representation( slot->attr.type,
4022 slot->key.data,
4023 slot->key.bytes,
4024 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02004025 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004026 goto exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02004027 status = psa_ecdsa_verify( ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02004028 hash, hash_length,
4029 signature, signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02004030 mbedtls_ecp_keypair_free( ecp );
4031 mbedtls_free( ecp );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004032 goto exit;
Steven Cooremanacda8342020-07-24 23:09:52 +02004033 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02004034 else
John Durkop9814fa22020-11-04 12:28:15 -08004035#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4036 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02004037 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02004038 status = PSA_ERROR_INVALID_ARGUMENT;
4039 goto exit;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02004040 }
itayzafrir5c753392018-05-08 11:18:38 +03004041 }
Gilles Peskine20035e32018-02-03 22:44:14 +01004042 else
Gilles Peskine20035e32018-02-03 22:44:14 +01004043 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02004044 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine20035e32018-02-03 22:44:14 +01004045 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004046
4047exit:
Ronald Cron5c522922020-11-14 16:35:34 +01004048 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004049
Ronald Cron5c522922020-11-14 16:35:34 +01004050 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine20035e32018-02-03 22:44:14 +01004051}
4052
John Durkop0e005192020-10-31 22:06:54 -07004053#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine072ac562018-06-30 00:21:29 +02004054static void psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
4055 mbedtls_rsa_context *rsa )
4056{
4057 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
4058 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
4059 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
4060 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
4061}
John Durkop0e005192020-10-31 22:06:54 -07004062#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Gilles Peskine072ac562018-06-30 00:21:29 +02004063
Ronald Croncf56a0a2020-08-04 09:51:30 +02004064psa_status_t psa_asymmetric_encrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02004065 psa_algorithm_t alg,
4066 const uint8_t *input,
4067 size_t input_length,
4068 const uint8_t *salt,
4069 size_t salt_length,
4070 uint8_t *output,
4071 size_t output_size,
4072 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004073{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004074 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004075 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01004076 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004077
Darryl Green5cc689a2018-07-24 15:34:10 +01004078 (void) input;
4079 (void) input_length;
4080 (void) salt;
4081 (void) output;
4082 (void) output_size;
4083
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03004084 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004085
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02004086 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
4087 return( PSA_ERROR_INVALID_ARGUMENT );
4088
Ronald Cron5c522922020-11-14 16:35:34 +01004089 status = psa_get_and_lock_transparent_key_slot_with_policy(
4090 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004091 if( status != PSA_SUCCESS )
4092 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02004093 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
4094 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004095 {
4096 status = PSA_ERROR_INVALID_ARGUMENT;
4097 goto exit;
4098 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004099
John Durkop6ba40d12020-11-10 08:50:04 -08004100#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
4101 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02004102 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004103 {
Steven Cooremana2371e52020-07-28 14:30:39 +02004104 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01004105 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
4106 slot->key.data,
4107 slot->key.bytes,
4108 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02004109 if( status != PSA_SUCCESS )
Steven Cooreman4fed4552020-08-03 14:46:03 +02004110 goto rsa_exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02004111
4112 if( output_size < mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02004113 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004114 status = PSA_ERROR_BUFFER_TOO_SMALL;
4115 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02004116 }
John Durkop0e005192020-10-31 22:06:54 -07004117#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Gilles Peskine6afe7892018-05-31 13:16:08 +02004118 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004119 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004120 status = mbedtls_to_psa_error(
4121 mbedtls_rsa_pkcs1_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01004122 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004123 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02004124 MBEDTLS_RSA_PUBLIC,
4125 input_length,
4126 input,
4127 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004128 }
4129 else
John Durkop0e005192020-10-31 22:06:54 -07004130#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
4131#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02004132 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004133 {
Steven Cooremana2371e52020-07-28 14:30:39 +02004134 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02004135 status = mbedtls_to_psa_error(
4136 mbedtls_rsa_rsaes_oaep_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01004137 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004138 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02004139 MBEDTLS_RSA_PUBLIC,
4140 salt, salt_length,
4141 input_length,
4142 input,
4143 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004144 }
4145 else
John Durkop0e005192020-10-31 22:06:54 -07004146#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004147 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004148 status = PSA_ERROR_INVALID_ARGUMENT;
4149 goto rsa_exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004150 }
Steven Cooreman4fed4552020-08-03 14:46:03 +02004151rsa_exit:
4152 if( status == PSA_SUCCESS )
Steven Cooremana2371e52020-07-28 14:30:39 +02004153 *output_length = mbedtls_rsa_get_len( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02004154
Steven Cooremana2371e52020-07-28 14:30:39 +02004155 mbedtls_rsa_free( rsa );
4156 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004157 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004158 else
John Durkop9814fa22020-11-04 12:28:15 -08004159#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
John Durkop6ba40d12020-11-10 08:50:04 -08004160 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004161 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02004162 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004163 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004164
4165exit:
Ronald Cron5c522922020-11-14 16:35:34 +01004166 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004167
Ronald Cron5c522922020-11-14 16:35:34 +01004168 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02004169}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004170
Ronald Croncf56a0a2020-08-04 09:51:30 +02004171psa_status_t psa_asymmetric_decrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02004172 psa_algorithm_t alg,
4173 const uint8_t *input,
4174 size_t input_length,
4175 const uint8_t *salt,
4176 size_t salt_length,
4177 uint8_t *output,
4178 size_t output_size,
4179 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004180{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004181 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004182 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01004183 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004184
Darryl Green5cc689a2018-07-24 15:34:10 +01004185 (void) input;
4186 (void) input_length;
4187 (void) salt;
4188 (void) output;
4189 (void) output_size;
4190
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03004191 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004192
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02004193 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
4194 return( PSA_ERROR_INVALID_ARGUMENT );
4195
Ronald Cron5c522922020-11-14 16:35:34 +01004196 status = psa_get_and_lock_transparent_key_slot_with_policy(
4197 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004198 if( status != PSA_SUCCESS )
4199 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02004200 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004201 {
4202 status = PSA_ERROR_INVALID_ARGUMENT;
4203 goto exit;
4204 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004205
John Durkop6ba40d12020-11-10 08:50:04 -08004206#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
4207 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02004208 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004209 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004210 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01004211 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
4212 slot->key.data,
4213 slot->key.bytes,
4214 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02004215 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004216 goto exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004217
Steven Cooremana2371e52020-07-28 14:30:39 +02004218 if( input_length != mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02004219 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004220 status = PSA_ERROR_INVALID_ARGUMENT;
4221 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02004222 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004223
John Durkop0e005192020-10-31 22:06:54 -07004224#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Gilles Peskine6afe7892018-05-31 13:16:08 +02004225 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004226 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004227 status = mbedtls_to_psa_error(
4228 mbedtls_rsa_pkcs1_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01004229 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004230 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02004231 MBEDTLS_RSA_PRIVATE,
4232 output_length,
4233 input,
4234 output,
4235 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004236 }
4237 else
John Durkop0e005192020-10-31 22:06:54 -07004238#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
4239#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02004240 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004241 {
Steven Cooremana2371e52020-07-28 14:30:39 +02004242 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02004243 status = mbedtls_to_psa_error(
4244 mbedtls_rsa_rsaes_oaep_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01004245 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004246 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02004247 MBEDTLS_RSA_PRIVATE,
4248 salt, salt_length,
4249 output_length,
4250 input,
4251 output,
4252 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004253 }
4254 else
John Durkop0e005192020-10-31 22:06:54 -07004255#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004256 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004257 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004258 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03004259
Steven Cooreman4fed4552020-08-03 14:46:03 +02004260rsa_exit:
Steven Cooremana2371e52020-07-28 14:30:39 +02004261 mbedtls_rsa_free( rsa );
4262 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004263 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004264 else
John Durkop6ba40d12020-11-10 08:50:04 -08004265#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
4266 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004267 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02004268 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004269 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004270
4271exit:
Ronald Cron5c522922020-11-14 16:35:34 +01004272 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004273
Ronald Cron5c522922020-11-14 16:35:34 +01004274 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02004275}
Gilles Peskine20035e32018-02-03 22:44:14 +01004276
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004277
4278
mohammad1603503973b2018-03-12 15:59:30 +02004279/****************************************************************/
4280/* Symmetric cryptography */
4281/****************************************************************/
4282
Gilles Peskinee553c652018-06-04 16:22:46 +02004283static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004284 mbedtls_svc_key_id_t key,
Gilles Peskine7e928852018-06-04 16:23:10 +02004285 psa_algorithm_t alg,
4286 mbedtls_operation_t cipher_operation )
mohammad1603503973b2018-03-12 15:59:30 +02004287{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004288 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004289 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004290 int ret = 0;
Gilles Peskine2f060a82018-12-04 17:12:32 +01004291 psa_key_slot_t *slot;
mohammad1603503973b2018-03-12 15:59:30 +02004292 size_t key_bits;
4293 const mbedtls_cipher_info_t *cipher_info = NULL;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004294 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
4295 PSA_KEY_USAGE_ENCRYPT :
4296 PSA_KEY_USAGE_DECRYPT );
mohammad1603503973b2018-03-12 15:59:30 +02004297
Steven Cooremand3feccd2020-09-01 15:56:14 +02004298 /* A context must be freshly initialized before it can be set up. */
4299 if( operation->alg != 0 )
4300 return( PSA_ERROR_BAD_STATE );
4301
Steven Cooremana07b9972020-09-10 14:54:14 +02004302 /* The requested algorithm must be one that can be processed by cipher. */
4303 if( ! PSA_ALG_IS_CIPHER( alg ) )
Steven Cooremana07b9972020-09-10 14:54:14 +02004304 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremand3feccd2020-09-01 15:56:14 +02004305
Steven Cooremanef8575e2020-09-11 11:44:50 +02004306 /* Fetch key material from key storage. */
Ronald Cron5c522922020-11-14 16:35:34 +01004307 status = psa_get_and_lock_key_slot_with_policy( key, &slot, usage, alg );
Steven Cooremanef8575e2020-09-11 11:44:50 +02004308 if( status != PSA_SUCCESS )
4309 goto exit;
4310
4311 /* Initialize the operation struct members, except for alg. The alg member
4312 * is used to indicate to psa_cipher_abort that there are resources to free,
4313 * so we only set it after resources have been allocated/initialized. */
Steven Cooremana07b9972020-09-10 14:54:14 +02004314 operation->key_set = 0;
4315 operation->iv_set = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004316 operation->mbedtls_in_use = 0;
Steven Cooremana07b9972020-09-10 14:54:14 +02004317 operation->iv_size = 0;
4318 operation->block_size = 0;
4319 if( alg == PSA_ALG_ECB_NO_PADDING )
4320 operation->iv_required = 0;
4321 else
4322 operation->iv_required = 1;
4323
Steven Cooremana07b9972020-09-10 14:54:14 +02004324 /* Try doing the operation through a driver before using software fallback. */
Steven Cooreman37941cb2020-07-28 18:49:51 +02004325 if( cipher_operation == MBEDTLS_ENCRYPT )
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004326 status = psa_driver_wrapper_cipher_encrypt_setup( &operation->ctx.driver,
Steven Cooreman37941cb2020-07-28 18:49:51 +02004327 slot,
4328 alg );
4329 else
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004330 status = psa_driver_wrapper_cipher_decrypt_setup( &operation->ctx.driver,
Steven Cooreman37941cb2020-07-28 18:49:51 +02004331 slot,
4332 alg );
4333
Steven Cooremanef8575e2020-09-11 11:44:50 +02004334 if( status == PSA_SUCCESS )
Steven Cooreman6d81f7e2020-09-14 13:14:31 +02004335 {
Steven Cooremanef8575e2020-09-11 11:44:50 +02004336 /* Once the driver context is initialised, it needs to be freed using
4337 * psa_cipher_abort. Indicate this through setting alg. */
4338 operation->alg = alg;
Steven Cooreman6d81f7e2020-09-14 13:14:31 +02004339 }
Steven Cooremanef8575e2020-09-11 11:44:50 +02004340
Steven Cooremand3feccd2020-09-01 15:56:14 +02004341 if( status != PSA_ERROR_NOT_SUPPORTED ||
4342 psa_key_lifetime_is_external( slot->attr.lifetime ) )
4343 goto exit;
4344
Steven Cooremana07b9972020-09-10 14:54:14 +02004345 /* Proceed with initializing an mbed TLS cipher context if no driver is
Steven Cooremand3feccd2020-09-01 15:56:14 +02004346 * available for the given algorithm & key. */
4347 mbedtls_cipher_init( &operation->ctx.cipher );
mohammad1603503973b2018-03-12 15:59:30 +02004348
Steven Cooremana07b9972020-09-10 14:54:14 +02004349 /* Once the cipher context is initialised, it needs to be freed using
Steven Cooremanef8575e2020-09-11 11:44:50 +02004350 * psa_cipher_abort. Indicate there is something to be freed through setting
4351 * alg, and indicate the operation is being done using mbedtls crypto through
4352 * setting mbedtls_in_use. */
Steven Cooremana07b9972020-09-10 14:54:14 +02004353 operation->alg = alg;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004354 operation->mbedtls_in_use = 1;
Steven Cooremana07b9972020-09-10 14:54:14 +02004355
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02004356 key_bits = psa_get_key_slot_bits( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +02004357 cipher_info = mbedtls_cipher_info_from_psa( alg, slot->attr.type, key_bits, NULL );
mohammad1603503973b2018-03-12 15:59:30 +02004358 if( cipher_info == NULL )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004359 {
4360 status = PSA_ERROR_NOT_SUPPORTED;
4361 goto exit;
4362 }
mohammad1603503973b2018-03-12 15:59:30 +02004363
mohammad1603503973b2018-03-12 15:59:30 +02004364 ret = mbedtls_cipher_setup( &operation->ctx.cipher, cipher_info );
Moran Peker41deec42018-04-04 15:43:05 +03004365 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004366 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004367
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004368#if defined(MBEDTLS_DES_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02004369 if( slot->attr.type == PSA_KEY_TYPE_DES && key_bits == 128 )
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004370 {
4371 /* Two-key Triple-DES is 3-key Triple-DES with K1=K3 */
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02004372 uint8_t keys[24];
Ronald Cronea0f8a62020-11-25 17:52:23 +01004373 memcpy( keys, slot->key.data, 16 );
4374 memcpy( keys + 16, slot->key.data, 8 );
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004375 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
4376 keys,
4377 192, cipher_operation );
4378 }
4379 else
4380#endif
4381 {
4382 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
Ronald Cronea0f8a62020-11-25 17:52:23 +01004383 slot->key.data,
Jaeden Amero23bbb752018-06-26 14:16:54 +01004384 (int) key_bits, cipher_operation );
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004385 }
Moran Peker41deec42018-04-04 15:43:05 +03004386 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004387 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004388
mohammad16038481e742018-03-18 13:57:31 +02004389#if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004390 switch( alg )
mohammad16038481e742018-03-18 13:57:31 +02004391 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004392 case PSA_ALG_CBC_NO_PADDING:
4393 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
4394 MBEDTLS_PADDING_NONE );
4395 break;
4396 case PSA_ALG_CBC_PKCS7:
4397 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
4398 MBEDTLS_PADDING_PKCS7 );
4399 break;
4400 default:
4401 /* The algorithm doesn't involve padding. */
4402 ret = 0;
4403 break;
4404 }
4405 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004406 goto exit;
mohammad16038481e742018-03-18 13:57:31 +02004407#endif //MBEDTLS_CIPHER_MODE_WITH_PADDING
4408
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004409 operation->block_size = ( PSA_ALG_IS_STREAM_CIPHER( alg ) ? 1 :
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004410 PSA_BLOCK_CIPHER_BLOCK_LENGTH( slot->attr.type ) );
Steven Cooremana6033e92020-08-25 11:47:50 +02004411 if( ( alg & PSA_ALG_CIPHER_FROM_BLOCK_FLAG ) != 0 &&
4412 alg != PSA_ALG_ECB_NO_PADDING )
mohammad16038481e742018-03-18 13:57:31 +02004413 {
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004414 operation->iv_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH( slot->attr.type );
mohammad16038481e742018-03-18 13:57:31 +02004415 }
Gilles Peskine26869f22019-05-06 15:25:00 +02004416#if defined(MBEDTLS_CHACHA20_C)
4417 else
Bence Szépkúticbe39532020-12-08 00:01:31 +01004418 if( alg == PSA_ALG_STREAM_CIPHER && slot->attr.type == PSA_KEY_TYPE_CHACHA20 )
Gilles Peskine26869f22019-05-06 15:25:00 +02004419 operation->iv_size = 12;
4420#endif
mohammad1603503973b2018-03-12 15:59:30 +02004421
Steven Cooreman7df02922020-09-09 15:28:49 +02004422 status = PSA_SUCCESS;
4423
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004424exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02004425 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004426 status = mbedtls_to_psa_error( ret );
Steven Cooreman7df02922020-09-09 15:28:49 +02004427 if( status == PSA_SUCCESS )
4428 {
4429 /* Update operation flags for both driver and software implementations */
4430 operation->key_set = 1;
4431 }
4432 else
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004433 psa_cipher_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004434
Ronald Cron5c522922020-11-14 16:35:34 +01004435 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004436
Ronald Cron5c522922020-11-14 16:35:34 +01004437 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
mohammad1603503973b2018-03-12 15:59:30 +02004438}
4439
Gilles Peskinefe119512018-07-08 21:39:34 +02004440psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004441 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02004442 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02004443{
Ronald Croncf56a0a2020-08-04 09:51:30 +02004444 return( psa_cipher_setup( operation, key, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02004445}
4446
Gilles Peskinefe119512018-07-08 21:39:34 +02004447psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004448 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02004449 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02004450{
Ronald Croncf56a0a2020-08-04 09:51:30 +02004451 return( psa_cipher_setup( operation, key, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02004452}
4453
Gilles Peskinefe119512018-07-08 21:39:34 +02004454psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004455 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02004456 size_t iv_size,
4457 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02004458{
itayzafrir534bd7c2018-08-02 13:56:32 +03004459 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00004460 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooreman7df02922020-09-09 15:28:49 +02004461 if( operation->iv_set || ! operation->iv_required )
4462 {
4463 return( PSA_ERROR_BAD_STATE );
4464 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004465
Steven Cooremanef8575e2020-09-11 11:44:50 +02004466 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004467 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004468 status = psa_driver_wrapper_cipher_generate_iv( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004469 iv,
4470 iv_size,
4471 iv_length );
4472 goto exit;
4473 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004474
Moran Peker41deec42018-04-04 15:43:05 +03004475 if( iv_size < operation->iv_size )
mohammad1603503973b2018-03-12 15:59:30 +02004476 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004477 status = PSA_ERROR_BUFFER_TOO_SMALL;
Moran Peker41deec42018-04-04 15:43:05 +03004478 goto exit;
4479 }
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004480 ret = mbedtls_psa_get_random( MBEDTLS_PSA_RANDOM_STATE,
Gilles Peskine30524eb2020-11-13 17:02:26 +01004481 iv, operation->iv_size );
Moran Peker41deec42018-04-04 15:43:05 +03004482 if( ret != 0 )
4483 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004484 status = mbedtls_to_psa_error( ret );
Gilles Peskinee553c652018-06-04 16:22:46 +02004485 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004486 }
Gilles Peskinee553c652018-06-04 16:22:46 +02004487
mohammad16038481e742018-03-18 13:57:31 +02004488 *iv_length = operation->iv_size;
itayzafrir534bd7c2018-08-02 13:56:32 +03004489 status = psa_cipher_set_iv( operation, iv, *iv_length );
Moran Peker41deec42018-04-04 15:43:05 +03004490
Moran Peker395db872018-05-31 14:07:14 +03004491exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02004492 if( status == PSA_SUCCESS )
4493 operation->iv_set = 1;
4494 else
Moran Peker395db872018-05-31 14:07:14 +03004495 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004496 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004497}
4498
Gilles Peskinefe119512018-07-08 21:39:34 +02004499psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004500 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02004501 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02004502{
itayzafrir534bd7c2018-08-02 13:56:32 +03004503 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00004504 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooreman7df02922020-09-09 15:28:49 +02004505 if( operation->iv_set || ! operation->iv_required )
4506 {
4507 return( PSA_ERROR_BAD_STATE );
4508 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004509
Steven Cooremanef8575e2020-09-11 11:44:50 +02004510 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004511 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004512 status = psa_driver_wrapper_cipher_set_iv( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004513 iv,
4514 iv_length );
4515 goto exit;
4516 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004517
Moran Pekera28258c2018-05-29 16:25:04 +03004518 if( iv_length != operation->iv_size )
Moran Peker71f19ae2018-04-22 20:23:16 +03004519 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004520 status = PSA_ERROR_INVALID_ARGUMENT;
4521 goto exit;
Moran Peker71f19ae2018-04-22 20:23:16 +03004522 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004523 ret = mbedtls_cipher_set_iv( &operation->ctx.cipher, iv, iv_length );
4524 status = mbedtls_to_psa_error( ret );
4525exit:
4526 if( status == PSA_SUCCESS )
4527 operation->iv_set = 1;
4528 else
mohammad1603503973b2018-03-12 15:59:30 +02004529 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004530 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004531}
4532
Steven Cooreman177deba2020-09-07 17:14:14 +02004533/* Process input for which the algorithm is set to ECB mode. This requires
4534 * manual processing, since the PSA API is defined as being able to process
4535 * arbitrary-length calls to psa_cipher_update() with ECB mode, but the
4536 * underlying mbedtls_cipher_update only takes full blocks. */
4537static psa_status_t psa_cipher_update_ecb_internal(
4538 mbedtls_cipher_context_t *ctx,
4539 const uint8_t *input,
4540 size_t input_length,
4541 uint8_t *output,
4542 size_t output_size,
4543 size_t *output_length )
4544{
4545 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4546 size_t block_size = ctx->cipher_info->block_size;
4547 size_t internal_output_length = 0;
4548 *output_length = 0;
4549
4550 if( input_length == 0 )
4551 {
4552 status = PSA_SUCCESS;
4553 goto exit;
4554 }
4555
4556 if( ctx->unprocessed_len > 0 )
4557 {
4558 /* Fill up to block size, and run the block if there's a full one. */
4559 size_t bytes_to_copy = block_size - ctx->unprocessed_len;
4560
4561 if( input_length < bytes_to_copy )
4562 bytes_to_copy = input_length;
4563
4564 memcpy( &( ctx->unprocessed_data[ctx->unprocessed_len] ),
4565 input, bytes_to_copy );
4566 input_length -= bytes_to_copy;
4567 input += bytes_to_copy;
4568 ctx->unprocessed_len += bytes_to_copy;
4569
4570 if( ctx->unprocessed_len == block_size )
4571 {
4572 status = mbedtls_to_psa_error(
4573 mbedtls_cipher_update( ctx,
4574 ctx->unprocessed_data,
4575 block_size,
4576 output, &internal_output_length ) );
4577
4578 if( status != PSA_SUCCESS )
4579 goto exit;
4580
4581 output += internal_output_length;
4582 output_size -= internal_output_length;
4583 *output_length += internal_output_length;
4584 ctx->unprocessed_len = 0;
4585 }
4586 }
4587
4588 while( input_length >= block_size )
4589 {
4590 /* Run all full blocks we have, one by one */
4591 status = mbedtls_to_psa_error(
4592 mbedtls_cipher_update( ctx, input,
4593 block_size,
4594 output, &internal_output_length ) );
4595
4596 if( status != PSA_SUCCESS )
4597 goto exit;
4598
4599 input_length -= block_size;
4600 input += block_size;
4601
4602 output += internal_output_length;
4603 output_size -= internal_output_length;
4604 *output_length += internal_output_length;
4605 }
4606
4607 if( input_length > 0 )
4608 {
4609 /* Save unprocessed bytes for later processing */
4610 memcpy( &( ctx->unprocessed_data[ctx->unprocessed_len] ),
4611 input, input_length );
4612 ctx->unprocessed_len += input_length;
4613 }
4614
4615 status = PSA_SUCCESS;
4616
4617exit:
4618 return( status );
4619}
4620
Gilles Peskinee553c652018-06-04 16:22:46 +02004621psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
4622 const uint8_t *input,
4623 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004624 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02004625 size_t output_size,
4626 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02004627{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004628 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine89d789c2018-06-04 17:17:16 +02004629 size_t expected_output_size;
Steven Cooreman7df02922020-09-09 15:28:49 +02004630 if( operation->alg == 0 )
4631 {
4632 return( PSA_ERROR_BAD_STATE );
4633 }
4634 if( operation->iv_required && ! operation->iv_set )
4635 {
4636 return( PSA_ERROR_BAD_STATE );
4637 }
Jaeden Ameroab439972019-02-15 14:12:05 +00004638
Steven Cooremanef8575e2020-09-11 11:44:50 +02004639 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004640 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004641 status = psa_driver_wrapper_cipher_update( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004642 input,
4643 input_length,
4644 output,
4645 output_size,
4646 output_length );
4647 goto exit;
4648 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004649
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004650 if( ! PSA_ALG_IS_STREAM_CIPHER( operation->alg ) )
Gilles Peskine89d789c2018-06-04 17:17:16 +02004651 {
4652 /* Take the unprocessed partial block left over from previous
4653 * update calls, if any, plus the input to this call. Remove
4654 * the last partial block, if any. You get the data that will be
4655 * output in this call. */
4656 expected_output_size =
4657 ( operation->ctx.cipher.unprocessed_len + input_length )
4658 / operation->block_size * operation->block_size;
4659 }
4660 else
4661 {
4662 expected_output_size = input_length;
4663 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004664
Gilles Peskine89d789c2018-06-04 17:17:16 +02004665 if( output_size < expected_output_size )
itayzafrir534bd7c2018-08-02 13:56:32 +03004666 {
4667 status = PSA_ERROR_BUFFER_TOO_SMALL;
4668 goto exit;
4669 }
mohammad160382759612018-03-12 18:16:40 +02004670
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004671 if( operation->alg == PSA_ALG_ECB_NO_PADDING )
4672 {
4673 /* mbedtls_cipher_update has an API inconsistency: it will only
4674 * process a single block at a time in ECB mode. Abstract away that
4675 * inconsistency here to match the PSA API behaviour. */
Steven Cooreman177deba2020-09-07 17:14:14 +02004676 status = psa_cipher_update_ecb_internal( &operation->ctx.cipher,
4677 input,
4678 input_length,
4679 output,
4680 output_size,
4681 output_length );
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004682 }
4683 else
4684 {
4685 status = mbedtls_to_psa_error(
4686 mbedtls_cipher_update( &operation->ctx.cipher, input,
4687 input_length, output, output_length ) );
4688 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004689exit:
4690 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02004691 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004692 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004693}
4694
Gilles Peskinee553c652018-06-04 16:22:46 +02004695psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
4696 uint8_t *output,
4697 size_t output_size,
4698 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02004699{
David Saadab4ecc272019-02-14 13:48:10 +02004700 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Gilles Peskinee553c652018-06-04 16:22:46 +02004701 uint8_t temp_output_buffer[MBEDTLS_MAX_BLOCK_LENGTH];
Steven Cooreman7df02922020-09-09 15:28:49 +02004702 if( operation->alg == 0 )
4703 {
4704 return( PSA_ERROR_BAD_STATE );
4705 }
4706 if( operation->iv_required && ! operation->iv_set )
4707 {
4708 return( PSA_ERROR_BAD_STATE );
4709 }
Moran Pekerbed71a22018-04-22 20:19:20 +03004710
Steven Cooremanef8575e2020-09-11 11:44:50 +02004711 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004712 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004713 status = psa_driver_wrapper_cipher_finish( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004714 output,
4715 output_size,
4716 output_length );
Steven Cooremanef8575e2020-09-11 11:44:50 +02004717 goto exit;
Steven Cooreman8b122252020-09-03 15:30:32 +02004718 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004719
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004720 if( operation->ctx.cipher.unprocessed_len != 0 )
Moran Peker7cb22b82018-06-05 11:40:02 +03004721 {
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004722 if( operation->alg == PSA_ALG_ECB_NO_PADDING ||
Fredrik Strupef90e3012020-09-28 16:11:33 +02004723 operation->alg == PSA_ALG_CBC_NO_PADDING )
Steven Cooremana6033e92020-08-25 11:47:50 +02004724 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004725 status = PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004726 goto exit;
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004727 }
Moran Pekerdc38ebc2018-04-30 15:45:34 +03004728 }
4729
Steven Cooremanef8575e2020-09-11 11:44:50 +02004730 status = mbedtls_to_psa_error(
4731 mbedtls_cipher_finish( &operation->ctx.cipher,
4732 temp_output_buffer,
4733 output_length ) );
4734 if( status != PSA_SUCCESS )
4735 goto exit;
Janos Follath315b51c2018-07-09 16:04:51 +01004736
Gilles Peskine46f1fd72018-06-28 19:31:31 +02004737 if( *output_length == 0 )
Janos Follath315b51c2018-07-09 16:04:51 +01004738 ; /* Nothing to copy. Note that output may be NULL in this case. */
Gilles Peskine46f1fd72018-06-28 19:31:31 +02004739 else if( output_size >= *output_length )
Moran Pekerdc38ebc2018-04-30 15:45:34 +03004740 memcpy( output, temp_output_buffer, *output_length );
4741 else
Janos Follath315b51c2018-07-09 16:04:51 +01004742 status = PSA_ERROR_BUFFER_TOO_SMALL;
mohammad1603503973b2018-03-12 15:59:30 +02004743
Steven Cooremanef8575e2020-09-11 11:44:50 +02004744exit:
4745 if( operation->mbedtls_in_use == 1 )
4746 mbedtls_platform_zeroize( temp_output_buffer, sizeof( temp_output_buffer ) );
Janos Follath315b51c2018-07-09 16:04:51 +01004747
Steven Cooremanef8575e2020-09-11 11:44:50 +02004748 if( status == PSA_SUCCESS )
4749 return( psa_cipher_abort( operation ) );
4750 else
4751 {
4752 *output_length = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004753 (void) psa_cipher_abort( operation );
Janos Follath315b51c2018-07-09 16:04:51 +01004754
Steven Cooremanef8575e2020-09-11 11:44:50 +02004755 return( status );
4756 }
mohammad1603503973b2018-03-12 15:59:30 +02004757}
4758
Gilles Peskinee553c652018-06-04 16:22:46 +02004759psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
4760{
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004761 if( operation->alg == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02004762 {
Steven Cooremana07b9972020-09-10 14:54:14 +02004763 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02004764 * in use. It's ok to call abort on such an object, and there's
4765 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004766 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02004767 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004768
Gilles Peskinef9c2c092018-06-21 16:57:07 +02004769 /* Sanity check (shouldn't happen: operation->alg should
4770 * always have been initialized to a valid value). */
4771 if( ! PSA_ALG_IS_CIPHER( operation->alg ) )
4772 return( PSA_ERROR_BAD_STATE );
4773
Steven Cooremanef8575e2020-09-11 11:44:50 +02004774 if( operation->mbedtls_in_use == 0 )
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004775 psa_driver_wrapper_cipher_abort( &operation->ctx.driver );
Steven Cooremand3feccd2020-09-01 15:56:14 +02004776 else
4777 mbedtls_cipher_free( &operation->ctx.cipher );
Gilles Peskinee553c652018-06-04 16:22:46 +02004778
Moran Peker41deec42018-04-04 15:43:05 +03004779 operation->alg = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004780 operation->key_set = 0;
4781 operation->iv_set = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004782 operation->mbedtls_in_use = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004783 operation->iv_size = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004784 operation->block_size = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004785 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004786
Moran Peker395db872018-05-31 14:07:14 +03004787 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02004788}
4789
Gilles Peskinea0655c32018-04-30 17:06:50 +02004790
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004791
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004792
mohammad16035955c982018-04-26 00:53:03 +03004793/****************************************************************/
4794/* AEAD */
4795/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004796
Gilles Peskineedf9a652018-08-17 18:11:56 +02004797typedef struct
4798{
Gilles Peskine2f060a82018-12-04 17:12:32 +01004799 psa_key_slot_t *slot;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004800 const mbedtls_cipher_info_t *cipher_info;
4801 union
4802 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02004803 unsigned dummy; /* Make the union non-empty even with no supported algorithms. */
Gilles Peskineedf9a652018-08-17 18:11:56 +02004804#if defined(MBEDTLS_CCM_C)
4805 mbedtls_ccm_context ccm;
4806#endif /* MBEDTLS_CCM_C */
4807#if defined(MBEDTLS_GCM_C)
4808 mbedtls_gcm_context gcm;
4809#endif /* MBEDTLS_GCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004810#if defined(MBEDTLS_CHACHAPOLY_C)
4811 mbedtls_chachapoly_context chachapoly;
4812#endif /* MBEDTLS_CHACHAPOLY_C */
Gilles Peskineedf9a652018-08-17 18:11:56 +02004813 } ctx;
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004814 psa_algorithm_t core_alg;
4815 uint8_t full_tag_length;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004816 uint8_t tag_length;
4817} aead_operation_t;
4818
Ronald Cronf95a2b12020-10-22 15:24:49 +02004819#define AEAD_OPERATION_INIT {0, 0, {0}, 0, 0, 0}
4820
Gilles Peskine30a9e412019-01-14 18:36:12 +01004821static void psa_aead_abort_internal( aead_operation_t *operation )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004822{
Gilles Peskinef8a8fe62018-08-21 16:38:05 +02004823 switch( operation->core_alg )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004824 {
4825#if defined(MBEDTLS_CCM_C)
4826 case PSA_ALG_CCM:
4827 mbedtls_ccm_free( &operation->ctx.ccm );
4828 break;
4829#endif /* MBEDTLS_CCM_C */
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004830#if defined(MBEDTLS_GCM_C)
Gilles Peskineedf9a652018-08-17 18:11:56 +02004831 case PSA_ALG_GCM:
4832 mbedtls_gcm_free( &operation->ctx.gcm );
4833 break;
4834#endif /* MBEDTLS_GCM_C */
4835 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004836
Ronald Cron5c522922020-11-14 16:35:34 +01004837 psa_unlock_key_slot( operation->slot );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004838}
4839
4840static psa_status_t psa_aead_setup( aead_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004841 mbedtls_svc_key_id_t key,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004842 psa_key_usage_t usage,
4843 psa_algorithm_t alg )
4844{
4845 psa_status_t status;
4846 size_t key_bits;
4847 mbedtls_cipher_id_t cipher_id;
4848
Ronald Cron5c522922020-11-14 16:35:34 +01004849 status = psa_get_and_lock_transparent_key_slot_with_policy(
4850 key, &operation->slot, usage, alg );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004851 if( status != PSA_SUCCESS )
4852 return( status );
4853
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02004854 key_bits = psa_get_key_slot_bits( operation->slot );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004855
4856 operation->cipher_info =
Gilles Peskine8e338702019-07-30 20:06:31 +02004857 mbedtls_cipher_info_from_psa( alg, operation->slot->attr.type, key_bits,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004858 &cipher_id );
4859 if( operation->cipher_info == NULL )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004860 {
4861 status = PSA_ERROR_NOT_SUPPORTED;
4862 goto cleanup;
4863 }
Gilles Peskineedf9a652018-08-17 18:11:56 +02004864
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004865 switch( PSA_ALG_AEAD_WITH_TAG_LENGTH( alg, 0 ) )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004866 {
4867#if defined(MBEDTLS_CCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004868 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CCM, 0 ):
4869 operation->core_alg = PSA_ALG_CCM;
4870 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004871 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.
4872 * The call to mbedtls_ccm_encrypt_and_tag or
4873 * mbedtls_ccm_auth_decrypt will validate the tag length. */
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004874 if( PSA_BLOCK_CIPHER_BLOCK_LENGTH( operation->slot->attr.type ) != 16 )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004875 {
4876 status = PSA_ERROR_INVALID_ARGUMENT;
4877 goto cleanup;
4878 }
Gilles Peskineedf9a652018-08-17 18:11:56 +02004879 mbedtls_ccm_init( &operation->ctx.ccm );
4880 status = mbedtls_to_psa_error(
4881 mbedtls_ccm_setkey( &operation->ctx.ccm, cipher_id,
Ronald Cronea0f8a62020-11-25 17:52:23 +01004882 operation->slot->key.data,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004883 (unsigned int) key_bits ) );
4884 if( status != 0 )
4885 goto cleanup;
4886 break;
4887#endif /* MBEDTLS_CCM_C */
4888
4889#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004890 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_GCM, 0 ):
4891 operation->core_alg = PSA_ALG_GCM;
4892 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004893 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16.
4894 * The call to mbedtls_gcm_crypt_and_tag or
4895 * mbedtls_gcm_auth_decrypt will validate the tag length. */
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004896 if( PSA_BLOCK_CIPHER_BLOCK_LENGTH( operation->slot->attr.type ) != 16 )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004897 {
4898 status = PSA_ERROR_INVALID_ARGUMENT;
4899 goto cleanup;
4900 }
Gilles Peskineedf9a652018-08-17 18:11:56 +02004901 mbedtls_gcm_init( &operation->ctx.gcm );
4902 status = mbedtls_to_psa_error(
4903 mbedtls_gcm_setkey( &operation->ctx.gcm, cipher_id,
Ronald Cronea0f8a62020-11-25 17:52:23 +01004904 operation->slot->key.data,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004905 (unsigned int) key_bits ) );
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004906 if( status != 0 )
4907 goto cleanup;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004908 break;
4909#endif /* MBEDTLS_GCM_C */
4910
Gilles Peskine26869f22019-05-06 15:25:00 +02004911#if defined(MBEDTLS_CHACHAPOLY_C)
4912 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CHACHA20_POLY1305, 0 ):
4913 operation->core_alg = PSA_ALG_CHACHA20_POLY1305;
4914 operation->full_tag_length = 16;
4915 /* We only support the default tag length. */
4916 if( alg != PSA_ALG_CHACHA20_POLY1305 )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004917 {
4918 status = PSA_ERROR_NOT_SUPPORTED;
4919 goto cleanup;
4920 }
Gilles Peskine26869f22019-05-06 15:25:00 +02004921 mbedtls_chachapoly_init( &operation->ctx.chachapoly );
4922 status = mbedtls_to_psa_error(
4923 mbedtls_chachapoly_setkey( &operation->ctx.chachapoly,
Ronald Cronea0f8a62020-11-25 17:52:23 +01004924 operation->slot->key.data ) );
Gilles Peskine26869f22019-05-06 15:25:00 +02004925 if( status != 0 )
4926 goto cleanup;
4927 break;
4928#endif /* MBEDTLS_CHACHAPOLY_C */
4929
Gilles Peskineedf9a652018-08-17 18:11:56 +02004930 default:
Ronald Cronf95a2b12020-10-22 15:24:49 +02004931 status = PSA_ERROR_NOT_SUPPORTED;
4932 goto cleanup;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004933 }
4934
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004935 if( PSA_AEAD_TAG_LENGTH( alg ) > operation->full_tag_length )
4936 {
4937 status = PSA_ERROR_INVALID_ARGUMENT;
4938 goto cleanup;
4939 }
4940 operation->tag_length = PSA_AEAD_TAG_LENGTH( alg );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004941
Gilles Peskineedf9a652018-08-17 18:11:56 +02004942 return( PSA_SUCCESS );
4943
4944cleanup:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004945 psa_aead_abort_internal( operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004946 return( status );
4947}
4948
Ronald Croncf56a0a2020-08-04 09:51:30 +02004949psa_status_t psa_aead_encrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03004950 psa_algorithm_t alg,
4951 const uint8_t *nonce,
4952 size_t nonce_length,
4953 const uint8_t *additional_data,
4954 size_t additional_data_length,
4955 const uint8_t *plaintext,
4956 size_t plaintext_length,
4957 uint8_t *ciphertext,
4958 size_t ciphertext_size,
4959 size_t *ciphertext_length )
4960{
mohammad16035955c982018-04-26 00:53:03 +03004961 psa_status_t status;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004962 aead_operation_t operation = AEAD_OPERATION_INIT;
mohammad160315223a82018-06-03 17:19:55 +03004963 uint8_t *tag;
Gilles Peskine2d277862018-06-18 15:41:12 +02004964
mohammad1603f08a5502018-06-03 15:05:47 +03004965 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004966
Ronald Croncf56a0a2020-08-04 09:51:30 +02004967 status = psa_aead_setup( &operation, key, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004968 if( status != PSA_SUCCESS )
4969 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004970
Gilles Peskineedf9a652018-08-17 18:11:56 +02004971 /* For all currently supported modes, the tag is at the end of the
4972 * ciphertext. */
4973 if( ciphertext_size < ( plaintext_length + operation.tag_length ) )
4974 {
4975 status = PSA_ERROR_BUFFER_TOO_SMALL;
4976 goto exit;
4977 }
4978 tag = ciphertext + plaintext_length;
mohammad16035955c982018-04-26 00:53:03 +03004979
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004980#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004981 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03004982 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004983 status = mbedtls_to_psa_error(
4984 mbedtls_gcm_crypt_and_tag( &operation.ctx.gcm,
4985 MBEDTLS_GCM_ENCRYPT,
4986 plaintext_length,
4987 nonce, nonce_length,
4988 additional_data, additional_data_length,
4989 plaintext, ciphertext,
4990 operation.tag_length, tag ) );
mohammad16035955c982018-04-26 00:53:03 +03004991 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004992 else
4993#endif /* MBEDTLS_GCM_C */
4994#if defined(MBEDTLS_CCM_C)
4995 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03004996 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004997 status = mbedtls_to_psa_error(
4998 mbedtls_ccm_encrypt_and_tag( &operation.ctx.ccm,
4999 plaintext_length,
5000 nonce, nonce_length,
5001 additional_data,
5002 additional_data_length,
5003 plaintext, ciphertext,
5004 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03005005 }
mohammad16035c8845f2018-05-09 05:40:09 -07005006 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01005007#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02005008#if defined(MBEDTLS_CHACHAPOLY_C)
5009 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
5010 {
5011 if( nonce_length != 12 || operation.tag_length != 16 )
5012 {
5013 status = PSA_ERROR_NOT_SUPPORTED;
5014 goto exit;
5015 }
5016 status = mbedtls_to_psa_error(
5017 mbedtls_chachapoly_encrypt_and_tag( &operation.ctx.chachapoly,
5018 plaintext_length,
5019 nonce,
5020 additional_data,
5021 additional_data_length,
5022 plaintext,
5023 ciphertext,
5024 tag ) );
5025 }
5026 else
5027#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad16035c8845f2018-05-09 05:40:09 -07005028 {
mohammad1603554faad2018-06-03 15:07:38 +03005029 return( PSA_ERROR_NOT_SUPPORTED );
mohammad16035c8845f2018-05-09 05:40:09 -07005030 }
Gilles Peskine2d277862018-06-18 15:41:12 +02005031
Gilles Peskineedf9a652018-08-17 18:11:56 +02005032 if( status != PSA_SUCCESS && ciphertext_size != 0 )
5033 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02005034
Gilles Peskineedf9a652018-08-17 18:11:56 +02005035exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01005036 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02005037 if( status == PSA_SUCCESS )
5038 *ciphertext_length = plaintext_length + operation.tag_length;
5039 return( status );
mohammad16035955c982018-04-26 00:53:03 +03005040}
5041
Gilles Peskineee652a32018-06-01 19:23:52 +02005042/* Locate the tag in a ciphertext buffer containing the encrypted data
5043 * followed by the tag. Return the length of the part preceding the tag in
5044 * *plaintext_length. This is the size of the plaintext in modes where
5045 * the encrypted data has the same size as the plaintext, such as
5046 * CCM and GCM. */
5047static psa_status_t psa_aead_unpadded_locate_tag( size_t tag_length,
5048 const uint8_t *ciphertext,
5049 size_t ciphertext_length,
5050 size_t plaintext_size,
Gilles Peskineee652a32018-06-01 19:23:52 +02005051 const uint8_t **p_tag )
5052{
5053 size_t payload_length;
5054 if( tag_length > ciphertext_length )
5055 return( PSA_ERROR_INVALID_ARGUMENT );
5056 payload_length = ciphertext_length - tag_length;
5057 if( payload_length > plaintext_size )
5058 return( PSA_ERROR_BUFFER_TOO_SMALL );
5059 *p_tag = ciphertext + payload_length;
Gilles Peskineee652a32018-06-01 19:23:52 +02005060 return( PSA_SUCCESS );
5061}
5062
Ronald Croncf56a0a2020-08-04 09:51:30 +02005063psa_status_t psa_aead_decrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03005064 psa_algorithm_t alg,
5065 const uint8_t *nonce,
5066 size_t nonce_length,
5067 const uint8_t *additional_data,
5068 size_t additional_data_length,
5069 const uint8_t *ciphertext,
5070 size_t ciphertext_length,
5071 uint8_t *plaintext,
5072 size_t plaintext_size,
5073 size_t *plaintext_length )
5074{
mohammad16035955c982018-04-26 00:53:03 +03005075 psa_status_t status;
Ronald Cronf95a2b12020-10-22 15:24:49 +02005076 aead_operation_t operation = AEAD_OPERATION_INIT;
Gilles Peskineedf9a652018-08-17 18:11:56 +02005077 const uint8_t *tag = NULL;
Gilles Peskine2d277862018-06-18 15:41:12 +02005078
Gilles Peskineee652a32018-06-01 19:23:52 +02005079 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03005080
Ronald Croncf56a0a2020-08-04 09:51:30 +02005081 status = psa_aead_setup( &operation, key, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02005082 if( status != PSA_SUCCESS )
5083 return( status );
mohammad16035955c982018-04-26 00:53:03 +03005084
Gilles Peskinef7e7b012019-05-06 15:27:16 +02005085 status = psa_aead_unpadded_locate_tag( operation.tag_length,
5086 ciphertext, ciphertext_length,
5087 plaintext_size, &tag );
5088 if( status != PSA_SUCCESS )
5089 goto exit;
5090
Gilles Peskineb0b189f2018-11-28 17:30:58 +01005091#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02005092 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03005093 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02005094 status = mbedtls_to_psa_error(
5095 mbedtls_gcm_auth_decrypt( &operation.ctx.gcm,
5096 ciphertext_length - operation.tag_length,
5097 nonce, nonce_length,
5098 additional_data,
5099 additional_data_length,
5100 tag, operation.tag_length,
5101 ciphertext, plaintext ) );
mohammad16035955c982018-04-26 00:53:03 +03005102 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01005103 else
5104#endif /* MBEDTLS_GCM_C */
5105#if defined(MBEDTLS_CCM_C)
5106 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03005107 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02005108 status = mbedtls_to_psa_error(
5109 mbedtls_ccm_auth_decrypt( &operation.ctx.ccm,
5110 ciphertext_length - operation.tag_length,
5111 nonce, nonce_length,
5112 additional_data,
5113 additional_data_length,
5114 ciphertext, plaintext,
5115 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03005116 }
mohammad160339574652018-06-01 04:39:53 -07005117 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01005118#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02005119#if defined(MBEDTLS_CHACHAPOLY_C)
5120 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
5121 {
5122 if( nonce_length != 12 || operation.tag_length != 16 )
5123 {
5124 status = PSA_ERROR_NOT_SUPPORTED;
5125 goto exit;
5126 }
5127 status = mbedtls_to_psa_error(
5128 mbedtls_chachapoly_auth_decrypt( &operation.ctx.chachapoly,
5129 ciphertext_length - operation.tag_length,
5130 nonce,
5131 additional_data,
5132 additional_data_length,
5133 tag,
5134 ciphertext,
5135 plaintext ) );
5136 }
5137 else
5138#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad160339574652018-06-01 04:39:53 -07005139 {
mohammad1603554faad2018-06-03 15:07:38 +03005140 return( PSA_ERROR_NOT_SUPPORTED );
mohammad160339574652018-06-01 04:39:53 -07005141 }
Gilles Peskinea40d7742018-06-01 16:28:30 +02005142
Gilles Peskineedf9a652018-08-17 18:11:56 +02005143 if( status != PSA_SUCCESS && plaintext_size != 0 )
5144 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03005145
Gilles Peskineedf9a652018-08-17 18:11:56 +02005146exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01005147 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02005148 if( status == PSA_SUCCESS )
5149 *plaintext_length = ciphertext_length - operation.tag_length;
5150 return( status );
mohammad16035955c982018-04-26 00:53:03 +03005151}
5152
Gilles Peskinea0655c32018-04-30 17:06:50 +02005153
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02005154
Gilles Peskine20035e32018-02-03 22:44:14 +01005155/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02005156/* Generators */
5157/****************************************************************/
5158
John Durkop07cc04a2020-11-16 22:08:34 -08005159#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
5160 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5161 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5162#define AT_LEAST_ONE_BUILTIN_KDF
5163#endif
5164
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005165#define HKDF_STATE_INIT 0 /* no input yet */
5166#define HKDF_STATE_STARTED 1 /* got salt */
5167#define HKDF_STATE_KEYED 2 /* got key */
5168#define HKDF_STATE_OUTPUT 3 /* output started */
5169
Gilles Peskinecbe66502019-05-16 16:59:18 +02005170static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005171 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005172{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005173 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
5174 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005175 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005176 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005177}
5178
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005179psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005180{
5181 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005182 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005183 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005184 {
5185 /* The object has (apparently) been initialized but it is not
5186 * in use. It's ok to call abort on such an object, and there's
5187 * nothing to do. */
5188 }
5189 else
John Durkopd0321952020-10-29 21:37:36 -07005190#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005191 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02005192 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005193 mbedtls_free( operation->ctx.hkdf.info );
5194 status = psa_hmac_abort_internal( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02005195 }
John Durkop07cc04a2020-11-16 22:08:34 -08005196 else
5197#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF */
5198#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5199 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5200 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005201 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01005202 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005203 {
Janos Follath6a1d2622019-06-11 10:37:28 +01005204 if( operation->ctx.tls12_prf.seed != NULL )
5205 {
5206 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
5207 operation->ctx.tls12_prf.seed_length );
5208 mbedtls_free( operation->ctx.tls12_prf.seed );
5209 }
5210
5211 if( operation->ctx.tls12_prf.label != NULL )
5212 {
5213 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
5214 operation->ctx.tls12_prf.label_length );
5215 mbedtls_free( operation->ctx.tls12_prf.label );
5216 }
5217
5218 status = psa_hmac_abort_internal( &operation->ctx.tls12_prf.hmac );
5219
5220 /* We leave the fields Ai and output_block to be erased safely by the
5221 * mbedtls_platform_zeroize() in the end of this function. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005222 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005223 else
John Durkop07cc04a2020-11-16 22:08:34 -08005224#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
5225 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005226 {
5227 status = PSA_ERROR_BAD_STATE;
5228 }
Janos Follath083036a2019-06-11 10:22:26 +01005229 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005230 return( status );
5231}
5232
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005233psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02005234 size_t *capacity)
5235{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005236 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005237 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005238 /* This is a blank key derivation operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02005239 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005240 }
5241
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005242 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005243 return( PSA_SUCCESS );
5244}
5245
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005246psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005247 size_t capacity )
5248{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005249 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005250 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005251 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005252 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005253 operation->capacity = capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005254 return( PSA_SUCCESS );
5255}
5256
John Durkopd0321952020-10-29 21:37:36 -07005257#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005258/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02005259 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02005260static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskinebef7f142018-07-12 17:22:21 +02005261 psa_algorithm_t hash_alg,
5262 uint8_t *output,
5263 size_t output_length )
5264{
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005265 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Gilles Peskinebef7f142018-07-12 17:22:21 +02005266 psa_status_t status;
5267
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005268 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
5269 return( PSA_ERROR_BAD_STATE );
5270 hkdf->state = HKDF_STATE_OUTPUT;
5271
Gilles Peskinebef7f142018-07-12 17:22:21 +02005272 while( output_length != 0 )
5273 {
5274 /* Copy what remains of the current block */
5275 uint8_t n = hash_length - hkdf->offset_in_block;
5276 if( n > output_length )
5277 n = (uint8_t) output_length;
5278 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
5279 output += n;
5280 output_length -= n;
5281 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02005282 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02005283 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02005284 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005285 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005286 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02005287 * object was corrupted or if this function is called directly
5288 * inside the library. */
5289 if( hkdf->block_number == 0xff )
5290 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02005291
5292 /* We need a new block */
5293 ++hkdf->block_number;
5294 hkdf->offset_in_block = 0;
5295 status = psa_hmac_setup_internal( &hkdf->hmac,
5296 hkdf->prk, hash_length,
5297 hash_alg );
5298 if( status != PSA_SUCCESS )
5299 return( status );
5300 if( hkdf->block_number != 1 )
5301 {
5302 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5303 hkdf->output_block,
5304 hash_length );
5305 if( status != PSA_SUCCESS )
5306 return( status );
5307 }
5308 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5309 hkdf->info,
5310 hkdf->info_length );
5311 if( status != PSA_SUCCESS )
5312 return( status );
5313 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5314 &hkdf->block_number, 1 );
5315 if( status != PSA_SUCCESS )
5316 return( status );
5317 status = psa_hmac_finish_internal( &hkdf->hmac,
5318 hkdf->output_block,
5319 sizeof( hkdf->output_block ) );
5320 if( status != PSA_SUCCESS )
5321 return( status );
5322 }
5323
5324 return( PSA_SUCCESS );
5325}
John Durkop07cc04a2020-11-16 22:08:34 -08005326#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005327
John Durkop07cc04a2020-11-16 22:08:34 -08005328#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5329 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01005330static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
5331 psa_tls12_prf_key_derivation_t *tls12_prf,
5332 psa_algorithm_t alg )
5333{
5334 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005335 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Janos Follathea29bfb2019-06-19 12:21:20 +01005336 psa_hash_operation_t backup = PSA_HASH_OPERATION_INIT;
5337 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005338
Janos Follath7742fee2019-06-17 12:58:10 +01005339 /* We can't be wanting more output after block 0xff, otherwise
5340 * the capacity check in psa_key_derivation_output_bytes() would have
5341 * prevented this call. It could happen only if the operation
5342 * object was corrupted or if this function is called directly
5343 * inside the library. */
5344 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01005345 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01005346
5347 /* We need a new block */
5348 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01005349 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01005350
5351 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
5352 *
5353 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
5354 *
5355 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
5356 * HMAC_hash(secret, A(2) + seed) +
5357 * HMAC_hash(secret, A(3) + seed) + ...
5358 *
5359 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01005360 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01005361 *
Janos Follathea29bfb2019-06-19 12:21:20 +01005362 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01005363 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01005364 * is currently extracted as `output_block` and where i is
5365 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01005366 */
5367
Janos Follathea29bfb2019-06-19 12:21:20 +01005368 /* Save the hash context before using it, to preserve the hash state with
5369 * only the inner padding in it. We need this, because inner padding depends
5370 * on the key (secret in the RFC's terminology). */
5371 status = psa_hash_clone( &tls12_prf->hmac.hash_ctx, &backup );
5372 if( status != PSA_SUCCESS )
5373 goto cleanup;
5374
5375 /* Calculate A(i) where i = tls12_prf->block_number. */
5376 if( tls12_prf->block_number == 1 )
5377 {
5378 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
5379 * the variable seed and in this instance means it in the context of the
5380 * P_hash function, where seed = label + seed.) */
5381 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5382 tls12_prf->label, tls12_prf->label_length );
5383 if( status != PSA_SUCCESS )
5384 goto cleanup;
5385 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5386 tls12_prf->seed, tls12_prf->seed_length );
5387 if( status != PSA_SUCCESS )
5388 goto cleanup;
5389 }
5390 else
5391 {
5392 /* A(i) = HMAC_hash(secret, A(i-1)) */
5393 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5394 tls12_prf->Ai, hash_length );
5395 if( status != PSA_SUCCESS )
5396 goto cleanup;
5397 }
5398
5399 status = psa_hmac_finish_internal( &tls12_prf->hmac,
5400 tls12_prf->Ai, hash_length );
5401 if( status != PSA_SUCCESS )
5402 goto cleanup;
5403 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
5404 if( status != PSA_SUCCESS )
5405 goto cleanup;
5406
5407 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
5408 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5409 tls12_prf->Ai, hash_length );
5410 if( status != PSA_SUCCESS )
5411 goto cleanup;
5412 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5413 tls12_prf->label, tls12_prf->label_length );
5414 if( status != PSA_SUCCESS )
5415 goto cleanup;
5416 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5417 tls12_prf->seed, tls12_prf->seed_length );
5418 if( status != PSA_SUCCESS )
5419 goto cleanup;
5420 status = psa_hmac_finish_internal( &tls12_prf->hmac,
5421 tls12_prf->output_block, hash_length );
5422 if( status != PSA_SUCCESS )
5423 goto cleanup;
5424 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
5425 if( status != PSA_SUCCESS )
5426 goto cleanup;
5427
Janos Follath7742fee2019-06-17 12:58:10 +01005428
5429cleanup:
5430
Janos Follathea29bfb2019-06-19 12:21:20 +01005431 cleanup_status = psa_hash_abort( &backup );
5432 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
5433 status = cleanup_status;
5434
5435 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01005436}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005437
Janos Follath844eb0e2019-06-19 12:10:49 +01005438static psa_status_t psa_key_derivation_tls12_prf_read(
5439 psa_tls12_prf_key_derivation_t *tls12_prf,
5440 psa_algorithm_t alg,
5441 uint8_t *output,
5442 size_t output_length )
5443{
5444 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005445 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Janos Follath844eb0e2019-06-19 12:10:49 +01005446 psa_status_t status;
5447 uint8_t offset, length;
5448
5449 while( output_length != 0 )
5450 {
5451 /* Check if we have fully processed the current block. */
5452 if( tls12_prf->left_in_block == 0 )
5453 {
5454 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
5455 alg );
5456 if( status != PSA_SUCCESS )
5457 return( status );
5458
5459 continue;
5460 }
5461
5462 if( tls12_prf->left_in_block > output_length )
5463 length = (uint8_t) output_length;
5464 else
5465 length = tls12_prf->left_in_block;
5466
5467 offset = hash_length - tls12_prf->left_in_block;
5468 memcpy( output, tls12_prf->output_block + offset, length );
5469 output += length;
5470 output_length -= length;
5471 tls12_prf->left_in_block -= length;
5472 }
5473
5474 return( PSA_SUCCESS );
5475}
John Durkop07cc04a2020-11-16 22:08:34 -08005476#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5477 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005478
Janos Follath6c6c8fc2019-06-17 12:38:20 +01005479psa_status_t psa_key_derivation_output_bytes(
5480 psa_key_derivation_operation_t *operation,
5481 uint8_t *output,
5482 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005483{
5484 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005485 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005486
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005487 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005488 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005489 /* This is a blank operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02005490 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005491 }
5492
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005493 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005494 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005495 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005496 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005497 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02005498 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005499 goto exit;
5500 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005501 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005502 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005503 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005504 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02005505 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
5506 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005507 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02005508 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02005509 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005510 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005511 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005512
John Durkopd0321952020-10-29 21:37:36 -07005513#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005514 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02005515 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01005516 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005517 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02005518 output, output_length );
5519 }
Janos Follathadbec812019-06-14 11:05:39 +01005520 else
John Durkop07cc04a2020-11-16 22:08:34 -08005521#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
5522#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5523 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathadbec812019-06-14 11:05:39 +01005524 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
John Durkop07cc04a2020-11-16 22:08:34 -08005525 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005526 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005527 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005528 kdf_alg, output,
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005529 output_length );
5530 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005531 else
John Durkop07cc04a2020-11-16 22:08:34 -08005532#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5533 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005534 {
5535 return( PSA_ERROR_BAD_STATE );
5536 }
5537
5538exit:
5539 if( status != PSA_SUCCESS )
5540 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005541 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005542 * This allows us to differentiate between exhausted operations and
5543 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
5544 * operations. */
5545 psa_algorithm_t alg = operation->alg;
5546 psa_key_derivation_abort( operation );
5547 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005548 memset( output, '!', output_length );
5549 }
5550 return( status );
5551}
5552
Gilles Peskine08542d82018-07-19 17:05:42 +02005553#if defined(MBEDTLS_DES_C)
5554static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
5555{
5556 if( data_size >= 8 )
5557 mbedtls_des_key_set_parity( data );
5558 if( data_size >= 16 )
5559 mbedtls_des_key_set_parity( data + 8 );
5560 if( data_size >= 24 )
5561 mbedtls_des_key_set_parity( data + 16 );
5562}
5563#endif /* MBEDTLS_DES_C */
5564
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005565static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005566 psa_key_slot_t *slot,
5567 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005568 psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005569{
5570 uint8_t *data = NULL;
5571 size_t bytes = PSA_BITS_TO_BYTES( bits );
5572 psa_status_t status;
5573
Gilles Peskine8e338702019-07-30 20:06:31 +02005574 if( ! key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005575 return( PSA_ERROR_INVALID_ARGUMENT );
5576 if( bits % 8 != 0 )
5577 return( PSA_ERROR_INVALID_ARGUMENT );
5578 data = mbedtls_calloc( 1, bytes );
5579 if( data == NULL )
5580 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5581
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005582 status = psa_key_derivation_output_bytes( operation, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005583 if( status != PSA_SUCCESS )
5584 goto exit;
Gilles Peskine08542d82018-07-19 17:05:42 +02005585#if defined(MBEDTLS_DES_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02005586 if( slot->attr.type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02005587 psa_des_set_key_parity( data, bytes );
5588#endif /* MBEDTLS_DES_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005589 status = psa_import_key_into_slot( slot, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005590
5591exit:
5592 mbedtls_free( data );
5593 return( status );
5594}
5595
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005596psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005597 psa_key_derivation_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005598 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005599{
5600 psa_status_t status;
5601 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005602 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02005603
Ronald Cron81709fc2020-11-14 12:10:32 +01005604 *key = MBEDTLS_SVC_KEY_ID_INIT;
5605
Gilles Peskine0f84d622019-09-12 19:03:13 +02005606 /* Reject any attempt to create a zero-length key so that we don't
5607 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
5608 if( psa_get_key_bits( attributes ) == 0 )
5609 return( PSA_ERROR_INVALID_ARGUMENT );
5610
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005611 if( ! operation->can_output_key )
5612 return( PSA_ERROR_NOT_PERMITTED );
5613
Ronald Cron81709fc2020-11-14 12:10:32 +01005614 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE, attributes,
5615 &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02005616#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
5617 if( driver != NULL )
5618 {
5619 /* Deriving a key in a secure element is not implemented yet. */
5620 status = PSA_ERROR_NOT_SUPPORTED;
5621 }
5622#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005623 if( status == PSA_SUCCESS )
5624 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005625 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02005626 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005627 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005628 }
5629 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01005630 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005631 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02005632 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005633
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005634 return( status );
5635}
5636
Gilles Peskineeab56e42018-07-12 17:12:33 +02005637
5638
5639/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02005640/* Key derivation */
5641/****************************************************************/
5642
John Durkop07cc04a2020-11-16 22:08:34 -08005643#ifdef AT_LEAST_ONE_BUILTIN_KDF
Gilles Peskine969c5d62019-01-16 15:53:06 +01005644static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005645 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005646 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005647{
John Durkop07cc04a2020-11-16 22:08:34 -08005648 int is_kdf_alg_supported;
5649
Janos Follath5fe19732019-06-20 15:09:30 +01005650 /* Make sure that operation->ctx is properly zero-initialised. (Macro
5651 * initialisers for this union leave some bytes unspecified.) */
5652 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
5653
Gilles Peskine969c5d62019-01-16 15:53:06 +01005654 /* Make sure that kdf_alg is a supported key derivation algorithm. */
John Durkopd0321952020-10-29 21:37:36 -07005655#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
John Durkop07cc04a2020-11-16 22:08:34 -08005656 if( PSA_ALG_IS_HKDF( kdf_alg ) )
5657 is_kdf_alg_supported = 1;
5658 else
5659#endif
5660#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
5661 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
5662 is_kdf_alg_supported = 1;
5663 else
5664#endif
5665#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5666 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
5667 is_kdf_alg_supported = 1;
5668 else
5669#endif
5670 is_kdf_alg_supported = 0;
5671
5672 if( is_kdf_alg_supported )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005673 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01005674 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005675 size_t hash_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005676 if( hash_size == 0 )
5677 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005678 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
5679 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02005680 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005681 {
5682 return( PSA_ERROR_NOT_SUPPORTED );
5683 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005684 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01005685 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005686 }
John Durkop07cc04a2020-11-16 22:08:34 -08005687
5688 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005689}
John Durkop07cc04a2020-11-16 22:08:34 -08005690#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01005691
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005692psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005693 psa_algorithm_t alg )
5694{
5695 psa_status_t status;
5696
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005697 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005698 return( PSA_ERROR_BAD_STATE );
5699
Gilles Peskine6843c292019-01-18 16:44:49 +01005700 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
5701 return( PSA_ERROR_INVALID_ARGUMENT );
John Durkop07cc04a2020-11-16 22:08:34 -08005702#ifdef AT_LEAST_ONE_BUILTIN_KDF
Gilles Peskine6843c292019-01-18 16:44:49 +01005703 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005704 {
5705 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005706 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005707 }
5708 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
5709 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005710 status = psa_key_derivation_setup_kdf( operation, alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005711 }
John Durkop07cc04a2020-11-16 22:08:34 -08005712#endif
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005713 else
5714 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005715
5716 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005717 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01005718 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005719}
5720
John Durkopd0321952020-10-29 21:37:36 -07005721#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskinecbe66502019-05-16 16:59:18 +02005722static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005723 psa_algorithm_t hash_alg,
5724 psa_key_derivation_step_t step,
5725 const uint8_t *data,
5726 size_t data_length )
5727{
5728 psa_status_t status;
5729 switch( step )
5730 {
Gilles Peskine03410b52019-05-16 16:05:19 +02005731 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02005732 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005733 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005734 status = psa_hmac_setup_internal( &hkdf->hmac,
5735 data, data_length,
5736 hash_alg );
5737 if( status != PSA_SUCCESS )
5738 return( status );
5739 hkdf->state = HKDF_STATE_STARTED;
5740 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02005741 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005742 /* If no salt was provided, use an empty salt. */
5743 if( hkdf->state == HKDF_STATE_INIT )
5744 {
5745 status = psa_hmac_setup_internal( &hkdf->hmac,
5746 NULL, 0,
Gilles Peskinef9ee6332019-04-11 21:22:52 +02005747 hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005748 if( status != PSA_SUCCESS )
5749 return( status );
5750 hkdf->state = HKDF_STATE_STARTED;
5751 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02005752 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005753 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005754 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5755 data, data_length );
5756 if( status != PSA_SUCCESS )
5757 return( status );
5758 status = psa_hmac_finish_internal( &hkdf->hmac,
5759 hkdf->prk,
5760 sizeof( hkdf->prk ) );
5761 if( status != PSA_SUCCESS )
5762 return( status );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005763 hkdf->offset_in_block = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005764 hkdf->block_number = 0;
5765 hkdf->state = HKDF_STATE_KEYED;
5766 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02005767 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005768 if( hkdf->state == HKDF_STATE_OUTPUT )
5769 return( PSA_ERROR_BAD_STATE );
5770 if( hkdf->info_set )
5771 return( PSA_ERROR_BAD_STATE );
5772 hkdf->info_length = data_length;
5773 if( data_length != 0 )
5774 {
5775 hkdf->info = mbedtls_calloc( 1, data_length );
5776 if( hkdf->info == NULL )
5777 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5778 memcpy( hkdf->info, data, data_length );
5779 }
5780 hkdf->info_set = 1;
5781 return( PSA_SUCCESS );
5782 default:
5783 return( PSA_ERROR_INVALID_ARGUMENT );
5784 }
5785}
John Durkop07cc04a2020-11-16 22:08:34 -08005786#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01005787
John Durkop07cc04a2020-11-16 22:08:34 -08005788#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5789 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathf08e2652019-06-13 09:05:41 +01005790static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
5791 const uint8_t *data,
5792 size_t data_length )
5793{
5794 if( prf->state != TLS12_PRF_STATE_INIT )
5795 return( PSA_ERROR_BAD_STATE );
5796
Janos Follathd6dce9f2019-07-04 09:11:38 +01005797 if( data_length != 0 )
5798 {
5799 prf->seed = mbedtls_calloc( 1, data_length );
5800 if( prf->seed == NULL )
5801 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01005802
Janos Follathd6dce9f2019-07-04 09:11:38 +01005803 memcpy( prf->seed, data, data_length );
5804 prf->seed_length = data_length;
5805 }
Janos Follathf08e2652019-06-13 09:05:41 +01005806
5807 prf->state = TLS12_PRF_STATE_SEED_SET;
5808
5809 return( PSA_SUCCESS );
5810}
5811
Janos Follath81550542019-06-13 14:26:34 +01005812static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
5813 psa_algorithm_t hash_alg,
5814 const uint8_t *data,
5815 size_t data_length )
5816{
5817 psa_status_t status;
5818 if( prf->state != TLS12_PRF_STATE_SEED_SET )
5819 return( PSA_ERROR_BAD_STATE );
5820
5821 status = psa_hmac_setup_internal( &prf->hmac, data, data_length, hash_alg );
5822 if( status != PSA_SUCCESS )
5823 return( status );
5824
5825 prf->state = TLS12_PRF_STATE_KEY_SET;
5826
5827 return( PSA_SUCCESS );
5828}
5829
Janos Follath63028dd2019-06-13 09:15:47 +01005830static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
5831 const uint8_t *data,
5832 size_t data_length )
5833{
5834 if( prf->state != TLS12_PRF_STATE_KEY_SET )
5835 return( PSA_ERROR_BAD_STATE );
5836
Janos Follathd6dce9f2019-07-04 09:11:38 +01005837 if( data_length != 0 )
5838 {
5839 prf->label = mbedtls_calloc( 1, data_length );
5840 if( prf->label == NULL )
5841 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01005842
Janos Follathd6dce9f2019-07-04 09:11:38 +01005843 memcpy( prf->label, data, data_length );
5844 prf->label_length = data_length;
5845 }
Janos Follath63028dd2019-06-13 09:15:47 +01005846
5847 prf->state = TLS12_PRF_STATE_LABEL_SET;
5848
5849 return( PSA_SUCCESS );
5850}
5851
Janos Follathb03233e2019-06-11 15:30:30 +01005852static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
5853 psa_algorithm_t hash_alg,
5854 psa_key_derivation_step_t step,
5855 const uint8_t *data,
5856 size_t data_length )
5857{
Janos Follathb03233e2019-06-11 15:30:30 +01005858 switch( step )
5859 {
Janos Follathf08e2652019-06-13 09:05:41 +01005860 case PSA_KEY_DERIVATION_INPUT_SEED:
5861 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01005862 case PSA_KEY_DERIVATION_INPUT_SECRET:
5863 return( psa_tls12_prf_set_key( prf, hash_alg, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01005864 case PSA_KEY_DERIVATION_INPUT_LABEL:
5865 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01005866 default:
5867 return( PSA_ERROR_INVALID_ARGUMENT );
5868 }
5869}
John Durkop07cc04a2020-11-16 22:08:34 -08005870#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
5871 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
5872
5873#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5874static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
5875 psa_tls12_prf_key_derivation_t *prf,
5876 psa_algorithm_t hash_alg,
5877 const uint8_t *data,
5878 size_t data_length )
5879{
5880 psa_status_t status;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005881 uint8_t pms[ 4 + 2 * PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE ];
John Durkop07cc04a2020-11-16 22:08:34 -08005882 uint8_t *cur = pms;
5883
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005884 if( data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE )
John Durkop07cc04a2020-11-16 22:08:34 -08005885 return( PSA_ERROR_INVALID_ARGUMENT );
5886
5887 /* Quoting RFC 4279, Section 2:
5888 *
5889 * The premaster secret is formed as follows: if the PSK is N octets
5890 * long, concatenate a uint16 with the value N, N zero octets, a second
5891 * uint16 with the value N, and the PSK itself.
5892 */
5893
5894 *cur++ = ( data_length >> 8 ) & 0xff;
5895 *cur++ = ( data_length >> 0 ) & 0xff;
5896 memset( cur, 0, data_length );
5897 cur += data_length;
5898 *cur++ = pms[0];
5899 *cur++ = pms[1];
5900 memcpy( cur, data, data_length );
5901 cur += data_length;
5902
5903 status = psa_tls12_prf_set_key( prf, hash_alg, pms, cur - pms );
5904
5905 mbedtls_platform_zeroize( pms, sizeof( pms ) );
5906 return( status );
5907}
Janos Follath6660f0e2019-06-17 08:44:03 +01005908
5909static psa_status_t psa_tls12_prf_psk_to_ms_input(
5910 psa_tls12_prf_key_derivation_t *prf,
5911 psa_algorithm_t hash_alg,
5912 psa_key_derivation_step_t step,
5913 const uint8_t *data,
5914 size_t data_length )
5915{
5916 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01005917 {
Janos Follath6660f0e2019-06-17 08:44:03 +01005918 return( psa_tls12_prf_psk_to_ms_set_key( prf, hash_alg,
5919 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01005920 }
Janos Follath6660f0e2019-06-17 08:44:03 +01005921
5922 return( psa_tls12_prf_input( prf, hash_alg, step, data, data_length ) );
5923}
John Durkop07cc04a2020-11-16 22:08:34 -08005924#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005925
Gilles Peskineb8965192019-09-24 16:21:10 +02005926/** Check whether the given key type is acceptable for the given
5927 * input step of a key derivation.
5928 *
5929 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
5930 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
5931 * Both secret and non-secret inputs can alternatively have the type
5932 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
5933 * that the input was passed as a buffer rather than via a key object.
5934 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02005935static int psa_key_derivation_check_input_type(
5936 psa_key_derivation_step_t step,
5937 psa_key_type_t key_type )
5938{
5939 switch( step )
5940 {
5941 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb8965192019-09-24 16:21:10 +02005942 if( key_type == PSA_KEY_TYPE_DERIVE )
5943 return( PSA_SUCCESS );
5944 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005945 return( PSA_SUCCESS );
5946 break;
5947 case PSA_KEY_DERIVATION_INPUT_LABEL:
5948 case PSA_KEY_DERIVATION_INPUT_SALT:
5949 case PSA_KEY_DERIVATION_INPUT_INFO:
5950 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskineb8965192019-09-24 16:21:10 +02005951 if( key_type == PSA_KEY_TYPE_RAW_DATA )
5952 return( PSA_SUCCESS );
5953 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005954 return( PSA_SUCCESS );
5955 break;
5956 }
5957 return( PSA_ERROR_INVALID_ARGUMENT );
5958}
5959
Janos Follathb80a94e2019-06-12 15:54:46 +01005960static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005961 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005962 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005963 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005964 const uint8_t *data,
5965 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005966{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02005967 psa_status_t status;
5968 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
5969
5970 status = psa_key_derivation_check_input_type( step, key_type );
Gilles Peskine224b0d62019-09-23 18:13:17 +02005971 if( status != PSA_SUCCESS )
5972 goto exit;
5973
John Durkopd0321952020-10-29 21:37:36 -07005974#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005975 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005976 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005977 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005978 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005979 step, data, data_length );
5980 }
John Durkop07cc04a2020-11-16 22:08:34 -08005981 else
5982#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
5983#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
5984 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005985 {
Janos Follathb03233e2019-06-11 15:30:30 +01005986 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
5987 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5988 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01005989 }
John Durkop07cc04a2020-11-16 22:08:34 -08005990 else
5991#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
5992#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5993 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Janos Follath6660f0e2019-06-17 08:44:03 +01005994 {
5995 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
5996 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5997 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005998 }
5999 else
John Durkop07cc04a2020-11-16 22:08:34 -08006000#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006001 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006002 /* This can't happen unless the operation object was not initialized */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006003 return( PSA_ERROR_BAD_STATE );
6004 }
6005
Gilles Peskine224b0d62019-09-23 18:13:17 +02006006exit:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006007 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006008 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006009 return( status );
6010}
6011
Janos Follath51f4a0f2019-06-14 11:35:55 +01006012psa_status_t psa_key_derivation_input_bytes(
6013 psa_key_derivation_operation_t *operation,
6014 psa_key_derivation_step_t step,
6015 const uint8_t *data,
6016 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006017{
Gilles Peskineb8965192019-09-24 16:21:10 +02006018 return( psa_key_derivation_input_internal( operation, step,
6019 PSA_KEY_TYPE_NONE,
Janos Follathc5621512019-06-14 11:27:57 +01006020 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006021}
6022
Janos Follath51f4a0f2019-06-14 11:35:55 +01006023psa_status_t psa_key_derivation_input_key(
6024 psa_key_derivation_operation_t *operation,
6025 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02006026 mbedtls_svc_key_id_t key )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006027{
Ronald Cronf95a2b12020-10-22 15:24:49 +02006028 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01006029 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006030 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006031
Ronald Cron5c522922020-11-14 16:35:34 +01006032 status = psa_get_and_lock_transparent_key_slot_with_policy(
6033 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006034 if( status != PSA_SUCCESS )
Gilles Peskine593773d2019-09-23 18:17:40 +02006035 {
6036 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006037 return( status );
Gilles Peskine593773d2019-09-23 18:17:40 +02006038 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006039
6040 /* Passing a key object as a SECRET input unlocks the permission
6041 * to output to a key object. */
6042 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
6043 operation->can_output_key = 1;
6044
Ronald Cronf95a2b12020-10-22 15:24:49 +02006045 status = psa_key_derivation_input_internal( operation,
6046 step, slot->attr.type,
Ronald Cronea0f8a62020-11-25 17:52:23 +01006047 slot->key.data,
6048 slot->key.bytes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02006049
Ronald Cron5c522922020-11-14 16:35:34 +01006050 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02006051
Ronald Cron5c522922020-11-14 16:35:34 +01006052 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006053}
Gilles Peskineea0fb492018-07-12 17:17:20 +02006054
6055
6056
6057/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02006058/* Key agreement */
6059/****************************************************************/
6060
John Durkop6ba40d12020-11-10 08:50:04 -08006061#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006062static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
6063 size_t peer_key_length,
6064 const mbedtls_ecp_keypair *our_key,
6065 uint8_t *shared_secret,
6066 size_t shared_secret_size,
6067 size_t *shared_secret_length )
6068{
Steven Cooremand4867872020-08-05 16:31:39 +02006069 mbedtls_ecp_keypair *their_key = NULL;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006070 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00006071 psa_status_t status;
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01006072 size_t bits = 0;
Paul Elliott8ff510a2020-06-02 17:19:28 +01006073 psa_ecc_family_t curve = mbedtls_ecc_group_to_psa( our_key->grp.id, &bits );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006074 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006075
Ronald Cron90857082020-11-25 14:58:33 +01006076 status = mbedtls_psa_ecp_load_representation(
6077 PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve),
6078 peer_key,
6079 peer_key_length,
6080 &their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00006081 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006082 goto exit;
6083
Jaeden Amero97271b32019-01-10 19:38:51 +00006084 status = mbedtls_to_psa_error(
Steven Cooremana2371e52020-07-28 14:30:39 +02006085 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
Jaeden Amero97271b32019-01-10 19:38:51 +00006086 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006087 goto exit;
Jaeden Amero97271b32019-01-10 19:38:51 +00006088 status = mbedtls_to_psa_error(
6089 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
6090 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006091 goto exit;
6092
Jaeden Amero97271b32019-01-10 19:38:51 +00006093 status = mbedtls_to_psa_error(
6094 mbedtls_ecdh_calc_secret( &ecdh,
6095 shared_secret_length,
6096 shared_secret, shared_secret_size,
Gilles Peskine30524eb2020-11-13 17:02:26 +01006097 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01006098 MBEDTLS_PSA_RANDOM_STATE ) );
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01006099 if( status != PSA_SUCCESS )
6100 goto exit;
6101 if( PSA_BITS_TO_BYTES( bits ) != *shared_secret_length )
6102 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006103
6104exit:
Gilles Peskine3e819b72019-12-20 14:09:55 +01006105 if( status != PSA_SUCCESS )
6106 mbedtls_platform_zeroize( shared_secret, shared_secret_size );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006107 mbedtls_ecdh_free( &ecdh );
Steven Cooremana2371e52020-07-28 14:30:39 +02006108 mbedtls_ecp_keypair_free( their_key );
Steven Cooreman6d839f02020-07-30 11:36:45 +02006109 mbedtls_free( their_key );
Steven Cooremana2371e52020-07-28 14:30:39 +02006110
Jaeden Amero97271b32019-01-10 19:38:51 +00006111 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006112}
John Durkop6ba40d12020-11-10 08:50:04 -08006113#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006114
Gilles Peskine01d718c2018-09-18 12:01:02 +02006115#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
6116
Gilles Peskine0216fe12019-04-11 21:23:21 +02006117static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
6118 psa_key_slot_t *private_key,
6119 const uint8_t *peer_key,
6120 size_t peer_key_length,
6121 uint8_t *shared_secret,
6122 size_t shared_secret_size,
6123 size_t *shared_secret_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02006124{
Gilles Peskine0216fe12019-04-11 21:23:21 +02006125 switch( alg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02006126 {
John Durkop6ba40d12020-11-10 08:50:04 -08006127#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02006128 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02006129 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006130 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremana2371e52020-07-28 14:30:39 +02006131 mbedtls_ecp_keypair *ecp = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01006132 psa_status_t status = mbedtls_psa_ecp_load_representation(
6133 private_key->attr.type,
6134 private_key->key.data,
6135 private_key->key.bytes,
6136 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02006137 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02006138 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02006139 status = psa_key_agreement_ecdh( peer_key, peer_key_length,
Steven Cooremana2371e52020-07-28 14:30:39 +02006140 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02006141 shared_secret, shared_secret_size,
6142 shared_secret_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02006143 mbedtls_ecp_keypair_free( ecp );
6144 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02006145 return( status );
John Durkop6ba40d12020-11-10 08:50:04 -08006146#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskine01d718c2018-09-18 12:01:02 +02006147 default:
Gilles Peskine93f85002018-11-16 16:43:31 +01006148 (void) private_key;
6149 (void) peer_key;
6150 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02006151 (void) shared_secret;
6152 (void) shared_secret_size;
6153 (void) shared_secret_length;
Gilles Peskine01d718c2018-09-18 12:01:02 +02006154 return( PSA_ERROR_NOT_SUPPORTED );
6155 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02006156}
6157
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02006158/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02006159 * to potentially free embedded data structures and wipe confidential data.
6160 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006161static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01006162 psa_key_derivation_step_t step,
Gilles Peskine01d718c2018-09-18 12:01:02 +02006163 psa_key_slot_t *private_key,
6164 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01006165 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02006166{
6167 psa_status_t status;
6168 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
6169 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006170 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02006171
6172 /* Step 1: run the secret agreement algorithm to generate the shared
6173 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02006174 status = psa_key_agreement_raw_internal( ka_alg,
6175 private_key,
6176 peer_key, peer_key_length,
itayzafrir0adf0fc2018-09-06 16:24:41 +03006177 shared_secret,
6178 sizeof( shared_secret ),
Gilles Peskine05d69892018-06-19 22:00:52 +02006179 &shared_secret_length );
Gilles Peskine53d991e2018-07-12 01:14:59 +02006180 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02006181 goto exit;
6182
Gilles Peskineb0b255c2018-07-06 17:01:38 +02006183 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02006184 * the shared secret. A shared secret is permitted wherever a key
6185 * of type DERIVE is permitted. */
Janos Follathb80a94e2019-06-12 15:54:46 +01006186 status = psa_key_derivation_input_internal( operation, step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02006187 PSA_KEY_TYPE_DERIVE,
Janos Follathb80a94e2019-06-12 15:54:46 +01006188 shared_secret,
6189 shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02006190exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01006191 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02006192 return( status );
6193}
6194
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006195psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02006196 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02006197 mbedtls_svc_key_id_t private_key,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02006198 const uint8_t *peer_key,
6199 size_t peer_key_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +02006200{
Ronald Cronf95a2b12020-10-22 15:24:49 +02006201 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01006202 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01006203 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02006204
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006205 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02006206 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Cron5c522922020-11-14 16:35:34 +01006207 status = psa_get_and_lock_transparent_key_slot_with_policy(
6208 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine12313cd2018-06-20 00:20:32 +02006209 if( status != PSA_SUCCESS )
6210 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006211 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01006212 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01006213 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01006214 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006215 psa_key_derivation_abort( operation );
Steven Cooremanfa5e6312020-10-15 17:07:12 +02006216 else
6217 {
6218 /* If a private key has been added as SECRET, we allow the derived
6219 * key material to be used as a key in PSA Crypto. */
6220 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
6221 operation->can_output_key = 1;
6222 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02006223
Ronald Cron5c522922020-11-14 16:35:34 +01006224 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02006225
Ronald Cron5c522922020-11-14 16:35:34 +01006226 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineaf3baab2018-06-27 22:55:52 +02006227}
6228
Gilles Peskinebe697d82019-05-16 18:00:41 +02006229psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
Ronald Croncf56a0a2020-08-04 09:51:30 +02006230 mbedtls_svc_key_id_t private_key,
Gilles Peskinebe697d82019-05-16 18:00:41 +02006231 const uint8_t *peer_key,
6232 size_t peer_key_length,
6233 uint8_t *output,
6234 size_t output_size,
6235 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02006236{
Ronald Cronf95a2b12020-10-22 15:24:49 +02006237 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01006238 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02006239 psa_key_slot_t *slot = NULL;
Gilles Peskine0216fe12019-04-11 21:23:21 +02006240
6241 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
6242 {
6243 status = PSA_ERROR_INVALID_ARGUMENT;
6244 goto exit;
6245 }
Ronald Cron5c522922020-11-14 16:35:34 +01006246 status = psa_get_and_lock_transparent_key_slot_with_policy(
6247 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02006248 if( status != PSA_SUCCESS )
6249 goto exit;
6250
6251 status = psa_key_agreement_raw_internal( alg, slot,
6252 peer_key, peer_key_length,
6253 output, output_size,
6254 output_length );
6255
6256exit:
6257 if( status != PSA_SUCCESS )
6258 {
6259 /* If an error happens and is not handled properly, the output
6260 * may be used as a key to protect sensitive data. Arrange for such
6261 * a key to be random, which is likely to result in decryption or
6262 * verification errors. This is better than filling the buffer with
6263 * some constant data such as zeros, which would result in the data
6264 * being protected with a reproducible, easily knowable key.
6265 */
6266 psa_generate_random( output, output_size );
6267 *output_length = output_size;
6268 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02006269
Ronald Cron5c522922020-11-14 16:35:34 +01006270 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02006271
Ronald Cron5c522922020-11-14 16:35:34 +01006272 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine0216fe12019-04-11 21:23:21 +02006273}
Gilles Peskine86a440b2018-11-12 18:39:40 +01006274
6275
Gilles Peskine30524eb2020-11-13 17:02:26 +01006276
Gilles Peskine86a440b2018-11-12 18:39:40 +01006277/****************************************************************/
6278/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02006279/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02006280
Gilles Peskine30524eb2020-11-13 17:02:26 +01006281/** Initialize the PSA random generator.
6282 */
6283static void mbedtls_psa_random_init( mbedtls_psa_random_context_t *rng )
6284{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006285#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
6286 memset( rng, 0, sizeof( *rng ) );
6287#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
6288
Gilles Peskine30524eb2020-11-13 17:02:26 +01006289 /* Set default configuration if
6290 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
6291 if( rng->entropy_init == NULL )
6292 rng->entropy_init = mbedtls_entropy_init;
6293 if( rng->entropy_free == NULL )
6294 rng->entropy_free = mbedtls_entropy_free;
6295
6296 rng->entropy_init( &rng->entropy );
6297#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
6298 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
6299 /* The PSA entropy injection feature depends on using NV seed as an entropy
6300 * source. Add NV seed as an entropy source for PSA entropy injection. */
6301 mbedtls_entropy_add_source( &rng->entropy,
6302 mbedtls_nv_seed_poll, NULL,
6303 MBEDTLS_ENTROPY_BLOCK_SIZE,
6304 MBEDTLS_ENTROPY_SOURCE_STRONG );
6305#endif
6306
Gilles Peskine5894e8e2020-12-14 14:54:06 +01006307 mbedtls_psa_drbg_init( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006308#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01006309}
6310
6311/** Deinitialize the PSA random generator.
6312 */
6313static void mbedtls_psa_random_free( mbedtls_psa_random_context_t *rng )
6314{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006315#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
6316 memset( rng, 0, sizeof( *rng ) );
6317#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine5894e8e2020-12-14 14:54:06 +01006318 mbedtls_psa_drbg_free( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01006319 rng->entropy_free( &rng->entropy );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006320#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01006321}
6322
6323/** Seed the PSA random generator.
6324 */
6325static psa_status_t mbedtls_psa_random_seed( mbedtls_psa_random_context_t *rng )
6326{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006327#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
6328 /* Do nothing: the external RNG seeds itself. */
6329 (void) rng;
6330 return( PSA_SUCCESS );
6331#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01006332 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine5894e8e2020-12-14 14:54:06 +01006333 int ret = mbedtls_psa_drbg_seed( &rng->entropy,
6334 drbg_seed, sizeof( drbg_seed ) - 1 );
Gilles Peskine30524eb2020-11-13 17:02:26 +01006335 return mbedtls_to_psa_error( ret );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006336#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01006337}
6338
Gilles Peskinee59236f2018-01-27 23:32:46 +01006339psa_status_t psa_generate_random( uint8_t *output,
6340 size_t output_size )
6341{
Gilles Peskinee59236f2018-01-27 23:32:46 +01006342 GUARD_MODULE_INITIALIZED;
6343
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006344#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
6345
6346 size_t output_length = 0;
6347 psa_status_t status = mbedtls_psa_external_get_random( &global_data.rng,
6348 output, output_size,
6349 &output_length );
6350 if( status != PSA_SUCCESS )
6351 return( status );
6352 /* Breaking up a request into smaller chunks is currently not supported
6353 * for the extrernal RNG interface. */
6354 if( output_length != output_size )
6355 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
6356 return( PSA_SUCCESS );
6357
6358#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
6359
Gilles Peskine71ddab92021-01-04 21:01:07 +01006360 while( output_size > 0 )
Gilles Peskinef181eca2019-08-07 13:49:00 +02006361 {
Gilles Peskine71ddab92021-01-04 21:01:07 +01006362 size_t request_size =
6363 ( output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
6364 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
6365 output_size );
Gilles Peskine0c59ba82021-01-05 14:10:59 +01006366 int ret = mbedtls_psa_get_random( MBEDTLS_PSA_RANDOM_STATE,
6367 output, request_size );
Gilles Peskinef181eca2019-08-07 13:49:00 +02006368 if( ret != 0 )
6369 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine71ddab92021-01-04 21:01:07 +01006370 output_size -= request_size;
6371 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02006372 }
Gilles Peskine0c59ba82021-01-05 14:10:59 +01006373 return( PSA_SUCCESS );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006374#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006375}
6376
Gilles Peskine8814fc42020-12-14 15:33:44 +01006377/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01006378 *
6379 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
6380 * `psa_generate_random(...)`. The state parameter is ignored since the
6381 * PSA API doesn't support passing an explicit state.
6382 *
6383 * In the non-external case, psa_generate_random() calls an
6384 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
6385 * and semantics as mbedtls_psa_get_random(). As an optimization,
6386 * instead of doing this back-and-forth between the PSA API and the
6387 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
6388 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01006389 */
6390#if defined (MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
6391int mbedtls_psa_get_random( void *p_rng,
6392 unsigned char *output,
6393 size_t output_size )
6394{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01006395 /* This function takes a pointer to the RNG state because that's what
6396 * classic mbedtls functions using an RNG expect. The PSA RNG manages
6397 * its own state internally and doesn't let the caller access that state.
6398 * So we just ignore the state parameter, and in practice we'll pass
6399 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01006400 (void) p_rng;
6401 psa_status_t status = psa_generate_random( output, output_size );
6402 if( status == PSA_SUCCESS )
6403 return( 0 );
6404 else
6405 return( MBEDTLS_ERR_ENTROPY_SOURCE_FAILED );
6406}
6407#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
6408
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01006409#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
6410#include "mbedtls/entropy_poll.h"
6411
Gilles Peskine7228da22019-07-15 11:06:15 +02006412psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006413 size_t seed_size )
6414{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006415 if( global_data.initialized )
6416 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02006417
6418 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
6419 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
6420 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
6421 return( PSA_ERROR_INVALID_ARGUMENT );
6422
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01006423 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006424}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01006425#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006426
John Durkop07cc04a2020-11-16 22:08:34 -08006427#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR)
Gilles Peskinee56e8782019-04-26 17:34:02 +02006428static psa_status_t psa_read_rsa_exponent( const uint8_t *domain_parameters,
6429 size_t domain_parameters_size,
6430 int *exponent )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006431{
Gilles Peskinee56e8782019-04-26 17:34:02 +02006432 size_t i;
6433 uint32_t acc = 0;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006434
Gilles Peskinee56e8782019-04-26 17:34:02 +02006435 if( domain_parameters_size == 0 )
6436 {
6437 *exponent = 65537;
6438 return( PSA_SUCCESS );
6439 }
6440
6441 /* Mbed TLS encodes the public exponent as an int. For simplicity, only
6442 * support values that fit in a 32-bit integer, which is larger than
6443 * int on just about every platform anyway. */
6444 if( domain_parameters_size > sizeof( acc ) )
6445 return( PSA_ERROR_NOT_SUPPORTED );
6446 for( i = 0; i < domain_parameters_size; i++ )
6447 acc = ( acc << 8 ) | domain_parameters[i];
6448 if( acc > INT_MAX )
6449 return( PSA_ERROR_NOT_SUPPORTED );
6450 *exponent = acc;
6451 return( PSA_SUCCESS );
6452}
John Durkop07cc04a2020-11-16 22:08:34 -08006453#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) */
Gilles Peskinee56e8782019-04-26 17:34:02 +02006454
Gilles Peskine35ef36b2019-05-16 19:42:05 +02006455static psa_status_t psa_generate_key_internal(
Gilles Peskinee56e8782019-04-26 17:34:02 +02006456 psa_key_slot_t *slot, size_t bits,
6457 const uint8_t *domain_parameters, size_t domain_parameters_size )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006458{
Gilles Peskine8e338702019-07-30 20:06:31 +02006459 psa_key_type_t type = slot->attr.type;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006460
Gilles Peskinee56e8782019-04-26 17:34:02 +02006461 if( domain_parameters == NULL && domain_parameters_size != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006462 return( PSA_ERROR_INVALID_ARGUMENT );
6463
Gilles Peskinee59236f2018-01-27 23:32:46 +01006464 if( key_type_is_raw_bytes( type ) )
6465 {
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006466 psa_status_t status;
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006467
6468 status = validate_unstructured_key_bit_size( slot->attr.type, bits );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006469 if( status != PSA_SUCCESS )
6470 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006471
6472 /* Allocate memory for the key */
Steven Cooreman75b74362020-07-28 14:30:13 +02006473 status = psa_allocate_buffer_to_slot( slot, PSA_BITS_TO_BYTES( bits ) );
6474 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02006475 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006476
Ronald Cronea0f8a62020-11-25 17:52:23 +01006477 status = psa_generate_random( slot->key.data,
6478 slot->key.bytes );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006479 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006480 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006481
6482 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006483#if defined(MBEDTLS_DES_C)
6484 if( type == PSA_KEY_TYPE_DES )
Ronald Cronea0f8a62020-11-25 17:52:23 +01006485 psa_des_set_key_parity( slot->key.data,
6486 slot->key.bytes );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006487#endif /* MBEDTLS_DES_C */
6488 }
6489 else
6490
John Durkop07cc04a2020-11-16 22:08:34 -08006491#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02006492 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006493 {
Steven Cooremana01795d2020-07-24 22:48:15 +02006494 mbedtls_rsa_context rsa;
Janos Follath24eed8d2019-11-22 13:21:35 +00006495 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee56e8782019-04-26 17:34:02 +02006496 int exponent;
6497 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006498 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
6499 return( PSA_ERROR_NOT_SUPPORTED );
6500 /* Accept only byte-aligned keys, for the same reasons as
6501 * in psa_import_rsa_key(). */
6502 if( bits % 8 != 0 )
6503 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinee56e8782019-04-26 17:34:02 +02006504 status = psa_read_rsa_exponent( domain_parameters,
6505 domain_parameters_size,
6506 &exponent );
6507 if( status != PSA_SUCCESS )
6508 return( status );
Steven Cooremana01795d2020-07-24 22:48:15 +02006509 mbedtls_rsa_init( &rsa, MBEDTLS_RSA_PKCS_V15, MBEDTLS_MD_NONE );
6510 ret = mbedtls_rsa_gen_key( &rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01006511 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01006512 MBEDTLS_PSA_RANDOM_STATE,
Gilles Peskinee59236f2018-01-27 23:32:46 +01006513 (unsigned int) bits,
6514 exponent );
6515 if( ret != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006516 return( mbedtls_to_psa_error( ret ) );
Steven Cooremana01795d2020-07-24 22:48:15 +02006517
6518 /* Make sure to always have an export representation available */
6519 size_t bytes = PSA_KEY_EXPORT_RSA_KEY_PAIR_MAX_SIZE( bits );
6520
Steven Cooreman75b74362020-07-28 14:30:13 +02006521 status = psa_allocate_buffer_to_slot( slot, bytes );
6522 if( status != PSA_SUCCESS )
Steven Cooremana01795d2020-07-24 22:48:15 +02006523 {
6524 mbedtls_rsa_free( &rsa );
Steven Cooreman29149862020-08-05 15:43:42 +02006525 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006526 }
Steven Cooremana01795d2020-07-24 22:48:15 +02006527
Ronald Cron3c8ca3a2020-11-26 16:45:24 +01006528 status = mbedtls_psa_rsa_export_key( type,
6529 &rsa,
6530 slot->key.data,
6531 bytes,
6532 &slot->key.bytes );
Steven Cooremana01795d2020-07-24 22:48:15 +02006533 mbedtls_rsa_free( &rsa );
6534 if( status != PSA_SUCCESS )
Steven Cooremana01795d2020-07-24 22:48:15 +02006535 psa_remove_key_data_from_memory( slot );
Steven Cooreman560c28a2020-07-24 23:20:24 +02006536 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006537 }
6538 else
John Durkop07cc04a2020-11-16 22:08:34 -08006539#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006540
John Durkop9814fa22020-11-04 12:28:15 -08006541#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02006542 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006543 {
Paul Elliott8ff510a2020-06-02 17:19:28 +01006544 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY( type );
Gilles Peskine4295e8b2019-12-02 21:39:10 +01006545 mbedtls_ecp_group_id grp_id =
6546 mbedtls_ecc_group_of_psa( curve, PSA_BITS_TO_BYTES( bits ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006547 const mbedtls_ecp_curve_info *curve_info =
6548 mbedtls_ecp_curve_info_from_grp_id( grp_id );
Steven Cooremanacda8342020-07-24 23:09:52 +02006549 mbedtls_ecp_keypair ecp;
Janos Follath24eed8d2019-11-22 13:21:35 +00006550 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee56e8782019-04-26 17:34:02 +02006551 if( domain_parameters_size != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006552 return( PSA_ERROR_NOT_SUPPORTED );
6553 if( grp_id == MBEDTLS_ECP_DP_NONE || curve_info == NULL )
6554 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooremanacda8342020-07-24 23:09:52 +02006555 mbedtls_ecp_keypair_init( &ecp );
6556 ret = mbedtls_ecp_gen_key( grp_id, &ecp,
Gilles Peskine30524eb2020-11-13 17:02:26 +01006557 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01006558 MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006559 if( ret != 0 )
6560 {
Steven Cooremanacda8342020-07-24 23:09:52 +02006561 mbedtls_ecp_keypair_free( &ecp );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006562 return( mbedtls_to_psa_error( ret ) );
6563 }
Steven Cooremanacda8342020-07-24 23:09:52 +02006564
6565
6566 /* Make sure to always have an export representation available */
6567 size_t bytes = PSA_BITS_TO_BYTES( bits );
Steven Cooreman75b74362020-07-28 14:30:13 +02006568 psa_status_t status = psa_allocate_buffer_to_slot( slot, bytes );
6569 if( status != PSA_SUCCESS )
Steven Cooremanacda8342020-07-24 23:09:52 +02006570 {
6571 mbedtls_ecp_keypair_free( &ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02006572 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02006573 }
Steven Cooreman75b74362020-07-28 14:30:13 +02006574
6575 status = mbedtls_to_psa_error(
Ronald Cronea0f8a62020-11-25 17:52:23 +01006576 mbedtls_ecp_write_key( &ecp, slot->key.data, bytes ) );
Steven Cooremanacda8342020-07-24 23:09:52 +02006577
6578 mbedtls_ecp_keypair_free( &ecp );
Steven Cooremanb7f6dea2020-08-05 16:07:20 +02006579 if( status != PSA_SUCCESS ) {
Ronald Cronea0f8a62020-11-25 17:52:23 +01006580 memset( slot->key.data, 0, bytes );
Steven Cooremanacda8342020-07-24 23:09:52 +02006581 psa_remove_key_data_from_memory( slot );
Steven Cooremanb7f6dea2020-08-05 16:07:20 +02006582 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02006583 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006584 }
6585 else
John Durkop9814fa22020-11-04 12:28:15 -08006586#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) */
Steven Cooreman29149862020-08-05 15:43:42 +02006587 {
Gilles Peskinee59236f2018-01-27 23:32:46 +01006588 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman29149862020-08-05 15:43:42 +02006589 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01006590
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006591 return( PSA_SUCCESS );
6592}
Darryl Green0c6575a2018-11-07 16:05:30 +00006593
Gilles Peskine35ef36b2019-05-16 19:42:05 +02006594psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02006595 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006596{
6597 psa_status_t status;
6598 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02006599 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine11792082019-08-06 18:36:36 +02006600
Ronald Cron81709fc2020-11-14 12:10:32 +01006601 *key = MBEDTLS_SVC_KEY_ID_INIT;
6602
Gilles Peskine0f84d622019-09-12 19:03:13 +02006603 /* Reject any attempt to create a zero-length key so that we don't
6604 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
6605 if( psa_get_key_bits( attributes ) == 0 )
6606 return( PSA_ERROR_INVALID_ARGUMENT );
6607
Ronald Cron81709fc2020-11-14 12:10:32 +01006608 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE, attributes,
6609 &slot, &driver );
Gilles Peskine11792082019-08-06 18:36:36 +02006610 if( status != PSA_SUCCESS )
6611 goto exit;
6612
Steven Cooreman2a1664c2020-07-20 15:33:08 +02006613 status = psa_driver_wrapper_generate_key( attributes,
6614 slot );
6615 if( status != PSA_ERROR_NOT_SUPPORTED ||
6616 psa_key_lifetime_is_external( attributes->core.lifetime ) )
6617 goto exit;
6618
6619 status = psa_generate_key_internal(
6620 slot, attributes->core.bits,
6621 attributes->domain_parameters, attributes->domain_parameters_size );
Gilles Peskine11792082019-08-06 18:36:36 +02006622
6623exit:
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006624 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01006625 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006626 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02006627 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02006628
Darryl Green0c6575a2018-11-07 16:05:30 +00006629 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006630}
6631
6632
Gilles Peskinee59236f2018-01-27 23:32:46 +01006633
6634/****************************************************************/
6635/* Module setup */
6636/****************************************************************/
6637
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006638#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01006639psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
6640 void (* entropy_init )( mbedtls_entropy_context *ctx ),
6641 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
6642{
6643 if( global_data.rng_state != RNG_NOT_INITIALIZED )
6644 return( PSA_ERROR_BAD_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01006645 global_data.rng.entropy_init = entropy_init;
6646 global_data.rng.entropy_free = entropy_free;
Gilles Peskine5e769522018-11-20 21:59:56 +01006647 return( PSA_SUCCESS );
6648}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006649#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01006650
Gilles Peskinee59236f2018-01-27 23:32:46 +01006651void mbedtls_psa_crypto_free( void )
6652{
Gilles Peskine66fb1262018-12-10 16:29:04 +01006653 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006654 if( global_data.rng_state != RNG_NOT_INITIALIZED )
6655 {
Gilles Peskine30524eb2020-11-13 17:02:26 +01006656 mbedtls_psa_random_free( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006657 }
6658 /* Wipe all remaining data, including configuration.
6659 * In particular, this sets all state indicator to the value
6660 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01006661 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Gilles Peskinea8ade162019-06-26 11:24:49 +02006662#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +02006663 /* Unregister all secure element drivers, so that we restart from
6664 * a pristine state. */
6665 psa_unregister_all_se_drivers( );
Gilles Peskinea8ade162019-06-26 11:24:49 +02006666#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006667}
6668
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006669#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
6670/** Recover a transaction that was interrupted by a power failure.
6671 *
6672 * This function is called during initialization, before psa_crypto_init()
6673 * returns. If this function returns a failure status, the initialization
6674 * fails.
6675 */
6676static psa_status_t psa_crypto_recover_transaction(
6677 const psa_crypto_transaction_t *transaction )
6678{
6679 switch( transaction->unknown.type )
6680 {
6681 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
6682 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01006683 /* TODO - fall through to the failure case until this
Gilles Peskinec9d7f942019-08-13 16:17:16 +02006684 * is implemented.
6685 * https://github.com/ARMmbed/mbed-crypto/issues/218
6686 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006687 default:
6688 /* We found an unsupported transaction in the storage.
6689 * We don't know what state the storage is in. Give up. */
6690 return( PSA_ERROR_STORAGE_FAILURE );
6691 }
6692}
6693#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
6694
Gilles Peskinee59236f2018-01-27 23:32:46 +01006695psa_status_t psa_crypto_init( void )
6696{
Gilles Peskine66fb1262018-12-10 16:29:04 +01006697 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006698
Gilles Peskinec6b69072018-11-20 21:42:52 +01006699 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006700 if( global_data.initialized != 0 )
6701 return( PSA_SUCCESS );
6702
Gilles Peskine30524eb2020-11-13 17:02:26 +01006703 /* Initialize and seed the random generator. */
6704 mbedtls_psa_random_init( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006705 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine30524eb2020-11-13 17:02:26 +01006706 status = mbedtls_psa_random_seed( &global_data.rng );
Gilles Peskine66fb1262018-12-10 16:29:04 +01006707 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006708 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01006709 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006710
Gilles Peskine66fb1262018-12-10 16:29:04 +01006711 status = psa_initialize_key_slots( );
6712 if( status != PSA_SUCCESS )
6713 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01006714
Gilles Peskined9348f22019-10-01 15:22:29 +02006715#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
6716 status = psa_init_all_se_drivers( );
6717 if( status != PSA_SUCCESS )
6718 goto exit;
6719#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
6720
Gilles Peskine4b734222019-07-24 15:56:31 +02006721#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02006722 status = psa_crypto_load_transaction( );
6723 if( status == PSA_SUCCESS )
6724 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006725 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
6726 if( status != PSA_SUCCESS )
6727 goto exit;
6728 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02006729 }
6730 else if( status == PSA_ERROR_DOES_NOT_EXIST )
6731 {
6732 /* There's no transaction to complete. It's all good. */
6733 status = PSA_SUCCESS;
6734 }
Gilles Peskine4b734222019-07-24 15:56:31 +02006735#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02006736
Gilles Peskinec6b69072018-11-20 21:42:52 +01006737 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006738 global_data.initialized = 1;
6739
6740exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01006741 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006742 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01006743 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006744}
6745
6746#endif /* MBEDTLS_PSA_CRYPTO_C */