blob: 6b2b500c7ab4298122783d78449f836b22ff830a [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
itayzafrir7723ab12019-02-14 10:28:02 +020025#include "psa_crypto_service_integration.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010026#include "psa/crypto.h"
27
Gilles Peskine039b90c2018-12-07 18:24:41 +010028#include "psa_crypto_core.h"
Gilles Peskine5e769522018-11-20 21:59:56 +010029#include "psa_crypto_invasive.h"
Steven Cooremancd84cb42020-07-16 20:28:36 +020030#include "psa_crypto_driver_wrappers.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020031#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +020032#include "psa_crypto_se.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020033#endif
Gilles Peskine961849f2018-11-30 18:54:54 +010034#include "psa_crypto_slot_management.h"
Darryl Greend49a4992018-06-18 17:27:26 +010035/* Include internal declarations that are useful for implementing persistently
36 * stored keys. */
37#include "psa_crypto_storage.h"
38
Gilles Peskineb46bef22019-07-30 21:32:04 +020039#include <assert.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010040#include <stdlib.h>
41#include <string.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010042#include "mbedtls/platform.h"
Gilles Peskineff2d2002019-05-06 15:26:23 +020043#if !defined(MBEDTLS_PLATFORM_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010044#define mbedtls_calloc calloc
45#define mbedtls_free free
46#endif
47
Gilles Peskinea5905292018-02-07 20:59:33 +010048#include "mbedtls/arc4.h"
Gilles Peskine9a944802018-06-21 09:35:35 +020049#include "mbedtls/asn1.h"
Jaeden Amero25384a22019-01-10 10:23:21 +000050#include "mbedtls/asn1write.h"
Gilles Peskinea81d85b2018-06-26 16:10:23 +020051#include "mbedtls/bignum.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010052#include "mbedtls/blowfish.h"
53#include "mbedtls/camellia.h"
Gilles Peskine26869f22019-05-06 15:25:00 +020054#include "mbedtls/chacha20.h"
55#include "mbedtls/chachapoly.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010056#include "mbedtls/cipher.h"
57#include "mbedtls/ccm.h"
58#include "mbedtls/cmac.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010059#include "mbedtls/ctr_drbg.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010060#include "mbedtls/des.h"
Gilles Peskineb7ecdf02018-09-18 12:11:27 +020061#include "mbedtls/ecdh.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010062#include "mbedtls/ecp.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010063#include "mbedtls/entropy.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010064#include "mbedtls/error.h"
65#include "mbedtls/gcm.h"
66#include "mbedtls/md2.h"
67#include "mbedtls/md4.h"
68#include "mbedtls/md5.h"
Gilles Peskine20035e32018-02-03 22:44:14 +010069#include "mbedtls/md.h"
70#include "mbedtls/md_internal.h"
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010071#include "mbedtls/pk.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010072#include "mbedtls/pk_internal.h"
Gilles Peskine3f108122018-12-07 18:14:53 +010073#include "mbedtls/platform_util.h"
Janos Follath24eed8d2019-11-22 13:21:35 +000074#include "mbedtls/error.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010075#include "mbedtls/ripemd160.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010076#include "mbedtls/rsa.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010077#include "mbedtls/sha1.h"
78#include "mbedtls/sha256.h"
79#include "mbedtls/sha512.h"
80#include "mbedtls/xtea.h"
81
Gilles Peskine996deb12018-08-01 15:45:45 +020082#define ARRAY_LENGTH( array ) ( sizeof( array ) / sizeof( *( array ) ) )
83
Gilles Peskine9ef733f2018-02-07 21:05:37 +010084/* constant-time buffer comparison */
85static inline int safer_memcmp( const uint8_t *a, const uint8_t *b, size_t n )
86{
87 size_t i;
88 unsigned char diff = 0;
89
90 for( i = 0; i < n; i++ )
91 diff |= a[i] ^ b[i];
92
93 return( diff );
94}
95
96
97
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010098/****************************************************************/
99/* Global data, support functions and library management */
100/****************************************************************/
101
Gilles Peskine48c0ea12018-06-21 14:15:31 +0200102static int key_type_is_raw_bytes( psa_key_type_t type )
103{
Gilles Peskine78b3bb62018-08-10 16:03:41 +0200104 return( PSA_KEY_TYPE_IS_UNSTRUCTURED( type ) );
Gilles Peskine48c0ea12018-06-21 14:15:31 +0200105}
106
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100107/* Values for psa_global_data_t::rng_state */
108#define RNG_NOT_INITIALIZED 0
109#define RNG_INITIALIZED 1
110#define RNG_SEEDED 2
Gilles Peskinec6b69072018-11-20 21:42:52 +0100111
Gilles Peskine2d277862018-06-18 15:41:12 +0200112typedef struct
113{
Gilles Peskine5e769522018-11-20 21:59:56 +0100114 void (* entropy_init )( mbedtls_entropy_context *ctx );
115 void (* entropy_free )( mbedtls_entropy_context *ctx );
Gilles Peskinee59236f2018-01-27 23:32:46 +0100116 mbedtls_entropy_context entropy;
117 mbedtls_ctr_drbg_context ctr_drbg;
Gilles Peskinec6b69072018-11-20 21:42:52 +0100118 unsigned initialized : 1;
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100119 unsigned rng_state : 2;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100120} psa_global_data_t;
121
122static psa_global_data_t global_data;
123
itayzafrir0adf0fc2018-09-06 16:24:41 +0300124#define GUARD_MODULE_INITIALIZED \
125 if( global_data.initialized == 0 ) \
126 return( PSA_ERROR_BAD_STATE );
127
Steven Cooreman01164162020-07-20 15:31:37 +0200128psa_status_t mbedtls_to_psa_error( int ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100129{
Gilles Peskinea5905292018-02-07 20:59:33 +0100130 /* If there's both a high-level code and low-level code, dispatch on
131 * the high-level code. */
132 switch( ret < -0x7f ? - ( -ret & 0x7f80 ) : ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100133 {
134 case 0:
135 return( PSA_SUCCESS );
Gilles Peskinea5905292018-02-07 20:59:33 +0100136
137 case MBEDTLS_ERR_AES_INVALID_KEY_LENGTH:
138 case MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH:
139 case MBEDTLS_ERR_AES_FEATURE_UNAVAILABLE:
140 return( PSA_ERROR_NOT_SUPPORTED );
141 case MBEDTLS_ERR_AES_HW_ACCEL_FAILED:
142 return( PSA_ERROR_HARDWARE_FAILURE );
143
144 case MBEDTLS_ERR_ARC4_HW_ACCEL_FAILED:
145 return( PSA_ERROR_HARDWARE_FAILURE );
146
Gilles Peskine9a944802018-06-21 09:35:35 +0200147 case MBEDTLS_ERR_ASN1_OUT_OF_DATA:
148 case MBEDTLS_ERR_ASN1_UNEXPECTED_TAG:
149 case MBEDTLS_ERR_ASN1_INVALID_LENGTH:
150 case MBEDTLS_ERR_ASN1_LENGTH_MISMATCH:
151 case MBEDTLS_ERR_ASN1_INVALID_DATA:
152 return( PSA_ERROR_INVALID_ARGUMENT );
153 case MBEDTLS_ERR_ASN1_ALLOC_FAILED:
154 return( PSA_ERROR_INSUFFICIENT_MEMORY );
155 case MBEDTLS_ERR_ASN1_BUF_TOO_SMALL:
156 return( PSA_ERROR_BUFFER_TOO_SMALL );
157
Jaeden Amero93e21112019-02-20 13:57:28 +0000158#if defined(MBEDTLS_ERR_BLOWFISH_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000159 case MBEDTLS_ERR_BLOWFISH_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000160#elif defined(MBEDTLS_ERR_BLOWFISH_INVALID_KEY_LENGTH)
161 case MBEDTLS_ERR_BLOWFISH_INVALID_KEY_LENGTH:
162#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100163 case MBEDTLS_ERR_BLOWFISH_INVALID_INPUT_LENGTH:
164 return( PSA_ERROR_NOT_SUPPORTED );
165 case MBEDTLS_ERR_BLOWFISH_HW_ACCEL_FAILED:
166 return( PSA_ERROR_HARDWARE_FAILURE );
167
Jaeden Amero93e21112019-02-20 13:57:28 +0000168#if defined(MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000169 case MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000170#elif defined(MBEDTLS_ERR_CAMELLIA_INVALID_KEY_LENGTH)
171 case MBEDTLS_ERR_CAMELLIA_INVALID_KEY_LENGTH:
172#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100173 case MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH:
174 return( PSA_ERROR_NOT_SUPPORTED );
175 case MBEDTLS_ERR_CAMELLIA_HW_ACCEL_FAILED:
176 return( PSA_ERROR_HARDWARE_FAILURE );
177
178 case MBEDTLS_ERR_CCM_BAD_INPUT:
179 return( PSA_ERROR_INVALID_ARGUMENT );
180 case MBEDTLS_ERR_CCM_AUTH_FAILED:
181 return( PSA_ERROR_INVALID_SIGNATURE );
182 case MBEDTLS_ERR_CCM_HW_ACCEL_FAILED:
183 return( PSA_ERROR_HARDWARE_FAILURE );
184
Gilles Peskine26869f22019-05-06 15:25:00 +0200185 case MBEDTLS_ERR_CHACHA20_BAD_INPUT_DATA:
186 return( PSA_ERROR_INVALID_ARGUMENT );
187
188 case MBEDTLS_ERR_CHACHAPOLY_BAD_STATE:
189 return( PSA_ERROR_BAD_STATE );
190 case MBEDTLS_ERR_CHACHAPOLY_AUTH_FAILED:
191 return( PSA_ERROR_INVALID_SIGNATURE );
192
Gilles Peskinea5905292018-02-07 20:59:33 +0100193 case MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE:
194 return( PSA_ERROR_NOT_SUPPORTED );
195 case MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA:
196 return( PSA_ERROR_INVALID_ARGUMENT );
197 case MBEDTLS_ERR_CIPHER_ALLOC_FAILED:
198 return( PSA_ERROR_INSUFFICIENT_MEMORY );
199 case MBEDTLS_ERR_CIPHER_INVALID_PADDING:
200 return( PSA_ERROR_INVALID_PADDING );
201 case MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED:
Fredrik Strupef90e3012020-09-28 16:11:33 +0200202 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100203 case MBEDTLS_ERR_CIPHER_AUTH_FAILED:
204 return( PSA_ERROR_INVALID_SIGNATURE );
205 case MBEDTLS_ERR_CIPHER_INVALID_CONTEXT:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200206 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100207 case MBEDTLS_ERR_CIPHER_HW_ACCEL_FAILED:
208 return( PSA_ERROR_HARDWARE_FAILURE );
209
210 case MBEDTLS_ERR_CMAC_HW_ACCEL_FAILED:
211 return( PSA_ERROR_HARDWARE_FAILURE );
212
213 case MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED:
214 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
215 case MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG:
216 case MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG:
217 return( PSA_ERROR_NOT_SUPPORTED );
218 case MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR:
219 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
220
221 case MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH:
222 return( PSA_ERROR_NOT_SUPPORTED );
223 case MBEDTLS_ERR_DES_HW_ACCEL_FAILED:
224 return( PSA_ERROR_HARDWARE_FAILURE );
225
Gilles Peskinee59236f2018-01-27 23:32:46 +0100226 case MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED:
227 case MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE:
228 case MBEDTLS_ERR_ENTROPY_SOURCE_FAILED:
229 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskinea5905292018-02-07 20:59:33 +0100230
231 case MBEDTLS_ERR_GCM_AUTH_FAILED:
232 return( PSA_ERROR_INVALID_SIGNATURE );
233 case MBEDTLS_ERR_GCM_BAD_INPUT:
Gilles Peskine8cac2e62018-08-21 15:07:38 +0200234 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100235 case MBEDTLS_ERR_GCM_HW_ACCEL_FAILED:
236 return( PSA_ERROR_HARDWARE_FAILURE );
237
238 case MBEDTLS_ERR_MD2_HW_ACCEL_FAILED:
239 case MBEDTLS_ERR_MD4_HW_ACCEL_FAILED:
240 case MBEDTLS_ERR_MD5_HW_ACCEL_FAILED:
241 return( PSA_ERROR_HARDWARE_FAILURE );
242
243 case MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE:
244 return( PSA_ERROR_NOT_SUPPORTED );
245 case MBEDTLS_ERR_MD_BAD_INPUT_DATA:
246 return( PSA_ERROR_INVALID_ARGUMENT );
247 case MBEDTLS_ERR_MD_ALLOC_FAILED:
248 return( PSA_ERROR_INSUFFICIENT_MEMORY );
249 case MBEDTLS_ERR_MD_FILE_IO_ERROR:
250 return( PSA_ERROR_STORAGE_FAILURE );
251 case MBEDTLS_ERR_MD_HW_ACCEL_FAILED:
252 return( PSA_ERROR_HARDWARE_FAILURE );
253
Gilles Peskinef76aa772018-10-29 19:24:33 +0100254 case MBEDTLS_ERR_MPI_FILE_IO_ERROR:
255 return( PSA_ERROR_STORAGE_FAILURE );
256 case MBEDTLS_ERR_MPI_BAD_INPUT_DATA:
257 return( PSA_ERROR_INVALID_ARGUMENT );
258 case MBEDTLS_ERR_MPI_INVALID_CHARACTER:
259 return( PSA_ERROR_INVALID_ARGUMENT );
260 case MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL:
261 return( PSA_ERROR_BUFFER_TOO_SMALL );
262 case MBEDTLS_ERR_MPI_NEGATIVE_VALUE:
263 return( PSA_ERROR_INVALID_ARGUMENT );
264 case MBEDTLS_ERR_MPI_DIVISION_BY_ZERO:
265 return( PSA_ERROR_INVALID_ARGUMENT );
266 case MBEDTLS_ERR_MPI_NOT_ACCEPTABLE:
267 return( PSA_ERROR_INVALID_ARGUMENT );
268 case MBEDTLS_ERR_MPI_ALLOC_FAILED:
269 return( PSA_ERROR_INSUFFICIENT_MEMORY );
270
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100271 case MBEDTLS_ERR_PK_ALLOC_FAILED:
272 return( PSA_ERROR_INSUFFICIENT_MEMORY );
273 case MBEDTLS_ERR_PK_TYPE_MISMATCH:
274 case MBEDTLS_ERR_PK_BAD_INPUT_DATA:
275 return( PSA_ERROR_INVALID_ARGUMENT );
276 case MBEDTLS_ERR_PK_FILE_IO_ERROR:
Gilles Peskinea5905292018-02-07 20:59:33 +0100277 return( PSA_ERROR_STORAGE_FAILURE );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100278 case MBEDTLS_ERR_PK_KEY_INVALID_VERSION:
279 case MBEDTLS_ERR_PK_KEY_INVALID_FORMAT:
280 return( PSA_ERROR_INVALID_ARGUMENT );
281 case MBEDTLS_ERR_PK_UNKNOWN_PK_ALG:
282 return( PSA_ERROR_NOT_SUPPORTED );
283 case MBEDTLS_ERR_PK_PASSWORD_REQUIRED:
284 case MBEDTLS_ERR_PK_PASSWORD_MISMATCH:
285 return( PSA_ERROR_NOT_PERMITTED );
286 case MBEDTLS_ERR_PK_INVALID_PUBKEY:
287 return( PSA_ERROR_INVALID_ARGUMENT );
288 case MBEDTLS_ERR_PK_INVALID_ALG:
289 case MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE:
290 case MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE:
291 return( PSA_ERROR_NOT_SUPPORTED );
292 case MBEDTLS_ERR_PK_SIG_LEN_MISMATCH:
293 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskinea5905292018-02-07 20:59:33 +0100294 case MBEDTLS_ERR_PK_HW_ACCEL_FAILED:
295 return( PSA_ERROR_HARDWARE_FAILURE );
296
Gilles Peskineff2d2002019-05-06 15:26:23 +0200297 case MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED:
298 return( PSA_ERROR_HARDWARE_FAILURE );
299 case MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED:
300 return( PSA_ERROR_NOT_SUPPORTED );
301
Gilles Peskinea5905292018-02-07 20:59:33 +0100302 case MBEDTLS_ERR_RIPEMD160_HW_ACCEL_FAILED:
303 return( PSA_ERROR_HARDWARE_FAILURE );
304
305 case MBEDTLS_ERR_RSA_BAD_INPUT_DATA:
306 return( PSA_ERROR_INVALID_ARGUMENT );
307 case MBEDTLS_ERR_RSA_INVALID_PADDING:
308 return( PSA_ERROR_INVALID_PADDING );
309 case MBEDTLS_ERR_RSA_KEY_GEN_FAILED:
310 return( PSA_ERROR_HARDWARE_FAILURE );
311 case MBEDTLS_ERR_RSA_KEY_CHECK_FAILED:
312 return( PSA_ERROR_INVALID_ARGUMENT );
313 case MBEDTLS_ERR_RSA_PUBLIC_FAILED:
314 case MBEDTLS_ERR_RSA_PRIVATE_FAILED:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200315 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100316 case MBEDTLS_ERR_RSA_VERIFY_FAILED:
317 return( PSA_ERROR_INVALID_SIGNATURE );
318 case MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE:
319 return( PSA_ERROR_BUFFER_TOO_SMALL );
320 case MBEDTLS_ERR_RSA_RNG_FAILED:
321 return( PSA_ERROR_INSUFFICIENT_MEMORY );
322 case MBEDTLS_ERR_RSA_UNSUPPORTED_OPERATION:
323 return( PSA_ERROR_NOT_SUPPORTED );
324 case MBEDTLS_ERR_RSA_HW_ACCEL_FAILED:
325 return( PSA_ERROR_HARDWARE_FAILURE );
326
327 case MBEDTLS_ERR_SHA1_HW_ACCEL_FAILED:
328 case MBEDTLS_ERR_SHA256_HW_ACCEL_FAILED:
329 case MBEDTLS_ERR_SHA512_HW_ACCEL_FAILED:
330 return( PSA_ERROR_HARDWARE_FAILURE );
331
332 case MBEDTLS_ERR_XTEA_INVALID_INPUT_LENGTH:
333 return( PSA_ERROR_INVALID_ARGUMENT );
334 case MBEDTLS_ERR_XTEA_HW_ACCEL_FAILED:
335 return( PSA_ERROR_HARDWARE_FAILURE );
336
itayzafrir5c753392018-05-08 11:18:38 +0300337 case MBEDTLS_ERR_ECP_BAD_INPUT_DATA:
itayzafrir7b30f8b2018-05-09 16:07:36 +0300338 case MBEDTLS_ERR_ECP_INVALID_KEY:
itayzafrir5c753392018-05-08 11:18:38 +0300339 return( PSA_ERROR_INVALID_ARGUMENT );
itayzafrir7b30f8b2018-05-09 16:07:36 +0300340 case MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL:
341 return( PSA_ERROR_BUFFER_TOO_SMALL );
342 case MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE:
343 return( PSA_ERROR_NOT_SUPPORTED );
344 case MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH:
345 case MBEDTLS_ERR_ECP_VERIFY_FAILED:
346 return( PSA_ERROR_INVALID_SIGNATURE );
347 case MBEDTLS_ERR_ECP_ALLOC_FAILED:
348 return( PSA_ERROR_INSUFFICIENT_MEMORY );
349 case MBEDTLS_ERR_ECP_HW_ACCEL_FAILED:
350 return( PSA_ERROR_HARDWARE_FAILURE );
Janos Follatha13b9052019-11-22 12:48:59 +0000351 case MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED:
352 return( PSA_ERROR_CORRUPTION_DETECTED );
itayzafrir5c753392018-05-08 11:18:38 +0300353
Gilles Peskinee59236f2018-01-27 23:32:46 +0100354 default:
David Saadab4ecc272019-02-14 13:48:10 +0200355 return( PSA_ERROR_GENERIC_ERROR );
Gilles Peskinee59236f2018-01-27 23:32:46 +0100356 }
357}
358
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200359
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +0200360
361
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100362/****************************************************************/
363/* Key management */
364/****************************************************************/
365
Gilles Peskine73167e12019-07-12 23:44:37 +0200366#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
367static inline int psa_key_slot_is_external( const psa_key_slot_t *slot )
368{
Gilles Peskine8e338702019-07-30 20:06:31 +0200369 return( psa_key_lifetime_is_external( slot->attr.lifetime ) );
Gilles Peskine73167e12019-07-12 23:44:37 +0200370}
371#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
372
Darryl Green8f8aa8f2018-07-24 15:44:51 +0100373#if defined(MBEDTLS_ECP_C)
Paul Elliott8ff510a2020-06-02 17:19:28 +0100374mbedtls_ecp_group_id mbedtls_ecc_group_of_psa( psa_ecc_family_t curve,
Gilles Peskine5055b232019-12-12 17:49:31 +0100375 size_t byte_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +0200376{
377 switch( curve )
378 {
Paul Elliott8ff510a2020-06-02 17:19:28 +0100379 case PSA_ECC_FAMILY_SECP_R1:
Gilles Peskine228abc52019-12-03 17:24:19 +0100380 switch( byte_length )
381 {
382 case PSA_BITS_TO_BYTES( 192 ):
383 return( MBEDTLS_ECP_DP_SECP192R1 );
384 case PSA_BITS_TO_BYTES( 224 ):
385 return( MBEDTLS_ECP_DP_SECP224R1 );
386 case PSA_BITS_TO_BYTES( 256 ):
387 return( MBEDTLS_ECP_DP_SECP256R1 );
388 case PSA_BITS_TO_BYTES( 384 ):
389 return( MBEDTLS_ECP_DP_SECP384R1 );
390 case PSA_BITS_TO_BYTES( 521 ):
391 return( MBEDTLS_ECP_DP_SECP521R1 );
392 default:
393 return( MBEDTLS_ECP_DP_NONE );
394 }
395 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100396
Paul Elliott8ff510a2020-06-02 17:19:28 +0100397 case PSA_ECC_FAMILY_BRAINPOOL_P_R1:
Gilles Peskine228abc52019-12-03 17:24:19 +0100398 switch( byte_length )
399 {
400 case PSA_BITS_TO_BYTES( 256 ):
401 return( MBEDTLS_ECP_DP_BP256R1 );
402 case PSA_BITS_TO_BYTES( 384 ):
403 return( MBEDTLS_ECP_DP_BP384R1 );
404 case PSA_BITS_TO_BYTES( 512 ):
405 return( MBEDTLS_ECP_DP_BP512R1 );
406 default:
407 return( MBEDTLS_ECP_DP_NONE );
408 }
409 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100410
Paul Elliott8ff510a2020-06-02 17:19:28 +0100411 case PSA_ECC_FAMILY_MONTGOMERY:
Gilles Peskine228abc52019-12-03 17:24:19 +0100412 switch( byte_length )
413 {
414 case PSA_BITS_TO_BYTES( 255 ):
415 return( MBEDTLS_ECP_DP_CURVE25519 );
416 case PSA_BITS_TO_BYTES( 448 ):
417 return( MBEDTLS_ECP_DP_CURVE448 );
418 default:
419 return( MBEDTLS_ECP_DP_NONE );
420 }
421 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100422
Paul Elliott8ff510a2020-06-02 17:19:28 +0100423 case PSA_ECC_FAMILY_SECP_K1:
Gilles Peskine228abc52019-12-03 17:24:19 +0100424 switch( byte_length )
425 {
426 case PSA_BITS_TO_BYTES( 192 ):
427 return( MBEDTLS_ECP_DP_SECP192K1 );
428 case PSA_BITS_TO_BYTES( 224 ):
429 return( MBEDTLS_ECP_DP_SECP224K1 );
430 case PSA_BITS_TO_BYTES( 256 ):
431 return( MBEDTLS_ECP_DP_SECP256K1 );
432 default:
433 return( MBEDTLS_ECP_DP_NONE );
434 }
435 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100436
Gilles Peskine12313cd2018-06-20 00:20:32 +0200437 default:
438 return( MBEDTLS_ECP_DP_NONE );
439 }
440}
Darryl Green8f8aa8f2018-07-24 15:44:51 +0100441#endif /* defined(MBEDTLS_ECP_C) */
Gilles Peskine12313cd2018-06-20 00:20:32 +0200442
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200443static psa_status_t validate_unstructured_key_bit_size( psa_key_type_t type,
444 size_t bits )
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200445{
446 /* Check that the bit size is acceptable for the key type */
447 switch( type )
448 {
449 case PSA_KEY_TYPE_RAW_DATA:
450#if defined(MBEDTLS_MD_C)
451 case PSA_KEY_TYPE_HMAC:
Gilles Peskine46f1fd72018-06-28 19:31:31 +0200452#endif
Gilles Peskineea0fb492018-07-12 17:17:20 +0200453 case PSA_KEY_TYPE_DERIVE:
454 break;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200455#if defined(MBEDTLS_AES_C)
456 case PSA_KEY_TYPE_AES:
457 if( bits != 128 && bits != 192 && bits != 256 )
458 return( PSA_ERROR_INVALID_ARGUMENT );
459 break;
460#endif
461#if defined(MBEDTLS_CAMELLIA_C)
462 case PSA_KEY_TYPE_CAMELLIA:
463 if( bits != 128 && bits != 192 && bits != 256 )
464 return( PSA_ERROR_INVALID_ARGUMENT );
465 break;
466#endif
467#if defined(MBEDTLS_DES_C)
468 case PSA_KEY_TYPE_DES:
469 if( bits != 64 && bits != 128 && bits != 192 )
470 return( PSA_ERROR_INVALID_ARGUMENT );
471 break;
472#endif
473#if defined(MBEDTLS_ARC4_C)
474 case PSA_KEY_TYPE_ARC4:
475 if( bits < 8 || bits > 2048 )
476 return( PSA_ERROR_INVALID_ARGUMENT );
477 break;
478#endif
Gilles Peskine26869f22019-05-06 15:25:00 +0200479#if defined(MBEDTLS_CHACHA20_C)
480 case PSA_KEY_TYPE_CHACHA20:
481 if( bits != 256 )
482 return( PSA_ERROR_INVALID_ARGUMENT );
483 break;
484#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200485 default:
486 return( PSA_ERROR_NOT_SUPPORTED );
487 }
Gilles Peskineb54979a2018-06-21 09:32:47 +0200488 if( bits % 8 != 0 )
489 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200490
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200491 return( PSA_SUCCESS );
492}
493
Steven Cooremana01795d2020-07-24 22:48:15 +0200494#if defined(MBEDTLS_RSA_C)
495
496#if defined(MBEDTLS_PK_PARSE_C)
Gilles Peskine86a440b2018-11-12 18:39:40 +0100497/* Mbed TLS doesn't support non-byte-aligned key sizes (i.e. key sizes
498 * that are not a multiple of 8) well. For example, there is only
499 * mbedtls_rsa_get_len(), which returns a number of bytes, and no
500 * way to return the exact bit size of a key.
501 * To keep things simple, reject non-byte-aligned key sizes. */
502static psa_status_t psa_check_rsa_key_byte_aligned(
503 const mbedtls_rsa_context *rsa )
504{
505 mbedtls_mpi n;
506 psa_status_t status;
507 mbedtls_mpi_init( &n );
508 status = mbedtls_to_psa_error(
509 mbedtls_rsa_export( rsa, &n, NULL, NULL, NULL, NULL ) );
510 if( status == PSA_SUCCESS )
511 {
512 if( mbedtls_mpi_bitlen( &n ) % 8 != 0 )
513 status = PSA_ERROR_NOT_SUPPORTED;
514 }
515 mbedtls_mpi_free( &n );
516 return( status );
517}
Steven Cooremana01795d2020-07-24 22:48:15 +0200518#endif /* MBEDTLS_PK_PARSE_C */
Gilles Peskine86a440b2018-11-12 18:39:40 +0100519
Steven Cooreman7f391872020-07-30 14:57:44 +0200520/** Load the contents of a key buffer into an internal RSA representation
Steven Cooremana01795d2020-07-24 22:48:15 +0200521 *
Steven Cooreman4fed4552020-08-03 14:46:03 +0200522 * \param[in] type The type of key contained in \p data.
523 * \param[in] data The buffer from which to load the representation.
524 * \param[in] data_length The size in bytes of \p data.
525 * \param[out] p_rsa Returns a pointer to an RSA context on success.
526 * The caller is responsible for freeing both the
527 * contents of the context and the context itself
528 * when done.
Steven Cooremana01795d2020-07-24 22:48:15 +0200529 */
Steven Cooreman4fed4552020-08-03 14:46:03 +0200530static psa_status_t psa_load_rsa_representation( psa_key_type_t type,
531 const uint8_t *data,
532 size_t data_length,
Steven Cooremana2371e52020-07-28 14:30:39 +0200533 mbedtls_rsa_context **p_rsa )
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200534{
Steven Cooremana01795d2020-07-24 22:48:15 +0200535#if defined(MBEDTLS_PK_PARSE_C)
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000536 psa_status_t status;
Steven Cooremana01795d2020-07-24 22:48:15 +0200537 mbedtls_pk_context ctx;
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000538 size_t bits;
Steven Cooremana01795d2020-07-24 22:48:15 +0200539 mbedtls_pk_init( &ctx );
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000540
541 /* Parse the data. */
Steven Cooreman7f391872020-07-30 14:57:44 +0200542 if( PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000543 status = mbedtls_to_psa_error(
Steven Cooreman4fed4552020-08-03 14:46:03 +0200544 mbedtls_pk_parse_key( &ctx, data, data_length, NULL, 0 ) );
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200545 else
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000546 status = mbedtls_to_psa_error(
Steven Cooreman4fed4552020-08-03 14:46:03 +0200547 mbedtls_pk_parse_public_key( &ctx, data, data_length ) );
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000548 if( status != PSA_SUCCESS )
549 goto exit;
550
551 /* We have something that the pkparse module recognizes. If it is a
552 * valid RSA key, store it. */
Steven Cooremana01795d2020-07-24 22:48:15 +0200553 if( mbedtls_pk_get_type( &ctx ) != MBEDTLS_PK_RSA )
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200554 {
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000555 status = PSA_ERROR_INVALID_ARGUMENT;
556 goto exit;
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200557 }
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000558
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000559 /* The size of an RSA key doesn't have to be a multiple of 8. Mbed TLS
560 * supports non-byte-aligned key sizes, but not well. For example,
561 * mbedtls_rsa_get_len() returns the key size in bytes, not in bits. */
Steven Cooremana01795d2020-07-24 22:48:15 +0200562 bits = PSA_BYTES_TO_BITS( mbedtls_rsa_get_len( mbedtls_pk_rsa( ctx ) ) );
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000563 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
564 {
565 status = PSA_ERROR_NOT_SUPPORTED;
566 goto exit;
567 }
Steven Cooremana01795d2020-07-24 22:48:15 +0200568 status = psa_check_rsa_key_byte_aligned( mbedtls_pk_rsa( ctx ) );
Steven Cooremana01795d2020-07-24 22:48:15 +0200569 if( status != PSA_SUCCESS )
570 goto exit;
571
Steven Cooremana2371e52020-07-28 14:30:39 +0200572 /* Copy out the pointer to the RSA context, and reset the PK context
573 * such that pk_free doesn't free the RSA context we just grabbed. */
574 *p_rsa = mbedtls_pk_rsa( ctx );
575 ctx.pk_info = NULL;
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000576
577exit:
Steven Cooremana01795d2020-07-24 22:48:15 +0200578 mbedtls_pk_free( &ctx );
579 return( status );
580#else
Steven Cooreman4fed4552020-08-03 14:46:03 +0200581 (void) data;
582 (void) data_length;
Steven Cooreman7f391872020-07-30 14:57:44 +0200583 (void) type;
Steven Cooremana01795d2020-07-24 22:48:15 +0200584 (void) rsa;
585 return( PSA_ERROR_NOT_SUPPORTED );
586#endif /* MBEDTLS_PK_PARSE_C */
587}
588
589/** Export an RSA key to export representation
590 *
591 * \param[in] type The type of key (public/private) to export
592 * \param[in] rsa The internal RSA representation from which to export
593 * \param[out] data The buffer to export to
594 * \param[in] data_size The length of the buffer to export to
595 * \param[out] data_length The amount of bytes written to \p data
596 */
597static psa_status_t psa_export_rsa_key( psa_key_type_t type,
598 mbedtls_rsa_context *rsa,
599 uint8_t *data,
600 size_t data_size,
601 size_t *data_length )
602{
603#if defined(MBEDTLS_PK_WRITE_C)
604 int ret;
605 mbedtls_pk_context pk;
606 uint8_t *pos = data + data_size;
607
608 mbedtls_pk_init( &pk );
609 pk.pk_info = &mbedtls_rsa_info;
610 pk.pk_ctx = rsa;
611
612 /* PSA Crypto API defines the format of an RSA key as a DER-encoded
Steven Cooreman75b74362020-07-28 14:30:13 +0200613 * representation of the non-encrypted PKCS#1 RSAPrivateKey for a
614 * private key and of the RFC3279 RSAPublicKey for a public key. */
Steven Cooremana01795d2020-07-24 22:48:15 +0200615 if( PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
616 ret = mbedtls_pk_write_key_der( &pk, data, data_size );
617 else
618 ret = mbedtls_pk_write_pubkey( &pos, data, &pk );
619
620 if( ret < 0 )
Steven Cooreman4fed4552020-08-03 14:46:03 +0200621 {
622 /* Clean up in case pk_write failed halfway through. */
623 memset( data, 0, data_size );
Steven Cooreman29149862020-08-05 15:43:42 +0200624 return( mbedtls_to_psa_error( ret ) );
Steven Cooreman4fed4552020-08-03 14:46:03 +0200625 }
Steven Cooremana01795d2020-07-24 22:48:15 +0200626
627 /* The mbedtls_pk_xxx functions write to the end of the buffer.
628 * Move the data to the beginning and erase remaining data
629 * at the original location. */
630 if( 2 * (size_t) ret <= data_size )
631 {
632 memcpy( data, data + data_size - ret, ret );
633 memset( data + data_size - ret, 0, ret );
634 }
635 else if( (size_t) ret < data_size )
636 {
637 memmove( data, data + data_size - ret, ret );
638 memset( data + ret, 0, data_size - ret );
639 }
640
641 *data_length = ret;
642 return( PSA_SUCCESS );
643#else
644 (void) type;
645 (void) rsa;
646 (void) data;
647 (void) data_size;
648 (void) data_length;
649 return( PSA_ERROR_NOT_SUPPORTED );
650#endif /* MBEDTLS_PK_WRITE_C */
651}
652
653/** Import an RSA key from import representation to a slot
654 *
655 * \param[in,out] slot The slot where to store the export representation to
656 * \param[in] data The buffer containing the import representation
657 * \param[in] data_length The amount of bytes in \p data
658 */
659static psa_status_t psa_import_rsa_key( psa_key_slot_t *slot,
660 const uint8_t *data,
661 size_t data_length )
662{
663 psa_status_t status;
664 uint8_t* output = NULL;
Steven Cooremana2371e52020-07-28 14:30:39 +0200665 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +0200666
Steven Cooremana01795d2020-07-24 22:48:15 +0200667 /* Parse input */
Steven Cooreman4fed4552020-08-03 14:46:03 +0200668 status = psa_load_rsa_representation( slot->attr.type,
669 data,
Steven Cooreman7f391872020-07-30 14:57:44 +0200670 data_length,
Steven Cooreman7f391872020-07-30 14:57:44 +0200671 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +0200672 if( status != PSA_SUCCESS )
673 goto exit;
674
675 slot->attr.bits = (psa_key_bits_t) PSA_BYTES_TO_BITS(
Steven Cooremana2371e52020-07-28 14:30:39 +0200676 mbedtls_rsa_get_len( rsa ) );
Steven Cooremana01795d2020-07-24 22:48:15 +0200677
Steven Cooreman75b74362020-07-28 14:30:13 +0200678 /* Re-export the data to PSA export format, such that we can store export
679 * representation in the key slot. Export representation in case of RSA is
680 * the smallest representation that's allowed as input, so a straight-up
681 * allocation of the same size as the input buffer will be large enough. */
Steven Cooremana01795d2020-07-24 22:48:15 +0200682 output = mbedtls_calloc( 1, data_length );
Steven Cooremana01795d2020-07-24 22:48:15 +0200683 if( output == NULL )
684 {
685 status = PSA_ERROR_INSUFFICIENT_MEMORY;
686 goto exit;
687 }
688
Steven Cooremana01795d2020-07-24 22:48:15 +0200689 status = psa_export_rsa_key( slot->attr.type,
Steven Cooremana2371e52020-07-28 14:30:39 +0200690 rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +0200691 output,
692 data_length,
693 &data_length);
Steven Cooremana01795d2020-07-24 22:48:15 +0200694exit:
695 /* Always free the RSA object */
Steven Cooremana2371e52020-07-28 14:30:39 +0200696 mbedtls_rsa_free( rsa );
Steven Cooreman6d839f02020-07-30 11:36:45 +0200697 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +0200698
699 /* Free the allocated buffer only on error. */
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000700 if( status != PSA_SUCCESS )
701 {
Steven Cooremana01795d2020-07-24 22:48:15 +0200702 mbedtls_free( output );
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000703 return( status );
704 }
705
Steven Cooremana01795d2020-07-24 22:48:15 +0200706 /* On success, store the allocated export-formatted key. */
707 slot->data.key.data = output;
708 slot->data.key.bytes = data_length;
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000709
710 return( PSA_SUCCESS );
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200711}
Steven Cooremana01795d2020-07-24 22:48:15 +0200712#endif /* defined(MBEDTLS_RSA_C) */
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200713
Jaeden Ameroccdce902019-01-10 11:42:27 +0000714#if defined(MBEDTLS_ECP_C)
Steven Cooreman7f391872020-07-30 14:57:44 +0200715/** Load the contents of a key buffer into an internal ECP representation
Steven Cooremana2371e52020-07-28 14:30:39 +0200716 *
Steven Cooreman4fed4552020-08-03 14:46:03 +0200717 * \param[in] type The type of key contained in \p data.
718 * \param[in] data The buffer from which to load the representation.
719 * \param[in] data_length The size in bytes of \p data.
720 * \param[out] p_ecp Returns a pointer to an ECP context on success.
721 * The caller is responsible for freeing both the
722 * contents of the context and the context itself
723 * when done.
Steven Cooremana2371e52020-07-28 14:30:39 +0200724 */
Steven Cooreman4fed4552020-08-03 14:46:03 +0200725static psa_status_t psa_load_ecp_representation( psa_key_type_t type,
726 const uint8_t *data,
727 size_t data_length,
Steven Cooremana2371e52020-07-28 14:30:39 +0200728 mbedtls_ecp_keypair **p_ecp )
Gilles Peskine4cd32772019-12-02 20:49:42 +0100729{
730 mbedtls_ecp_group_id grp_id = MBEDTLS_ECP_DP_NONE;
Steven Cooremanacda8342020-07-24 23:09:52 +0200731 psa_status_t status;
Steven Cooreman6d839f02020-07-30 11:36:45 +0200732 mbedtls_ecp_keypair *ecp = NULL;
Steven Cooreman4fed4552020-08-03 14:46:03 +0200733 size_t curve_size = data_length;
Gilles Peskine4cd32772019-12-02 20:49:42 +0100734
Steven Cooreman4fed4552020-08-03 14:46:03 +0200735 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) &&
736 PSA_KEY_TYPE_ECC_GET_FAMILY( type ) != PSA_ECC_FAMILY_MONTGOMERY )
Gilles Peskine4295e8b2019-12-02 21:39:10 +0100737 {
Steven Cooreman4fed4552020-08-03 14:46:03 +0200738 /* A Weierstrass public key is represented as:
739 * - The byte 0x04;
740 * - `x_P` as a `ceiling(m/8)`-byte string, big-endian;
741 * - `y_P` as a `ceiling(m/8)`-byte string, big-endian.
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200742 * So its data length is 2m+1 where m is the curve size in bits.
Steven Cooreman4fed4552020-08-03 14:46:03 +0200743 */
744 if( ( data_length & 1 ) == 0 )
745 return( PSA_ERROR_INVALID_ARGUMENT );
746 curve_size = data_length / 2;
747
748 /* Montgomery public keys are represented in compressed format, meaning
749 * their curve_size is equal to the amount of input. */
750
751 /* Private keys are represented in uncompressed private random integer
752 * format, meaning their curve_size is equal to the amount of input. */
Gilles Peskine4295e8b2019-12-02 21:39:10 +0100753 }
754
Steven Cooreman6d839f02020-07-30 11:36:45 +0200755 /* Allocate and initialize a key representation. */
Steven Cooreman29149862020-08-05 15:43:42 +0200756 ecp = mbedtls_calloc( 1, sizeof( mbedtls_ecp_keypair ) );
Steven Cooreman6d839f02020-07-30 11:36:45 +0200757 if( ecp == NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200758 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Steven Cooremana2371e52020-07-28 14:30:39 +0200759 mbedtls_ecp_keypair_init( ecp );
760
Gilles Peskine4cd32772019-12-02 20:49:42 +0100761 /* Load the group. */
Steven Cooreman7f391872020-07-30 14:57:44 +0200762 grp_id = mbedtls_ecc_group_of_psa( PSA_KEY_TYPE_ECC_GET_FAMILY( type ),
763 curve_size );
Gilles Peskine4295e8b2019-12-02 21:39:10 +0100764 if( grp_id == MBEDTLS_ECP_DP_NONE )
Steven Cooreman6d839f02020-07-30 11:36:45 +0200765 {
766 status = PSA_ERROR_INVALID_ARGUMENT;
767 goto exit;
768 }
769
Steven Cooremanacda8342020-07-24 23:09:52 +0200770 status = mbedtls_to_psa_error(
771 mbedtls_ecp_group_load( &ecp->grp, grp_id ) );
772 if( status != PSA_SUCCESS )
Steven Cooreman6d839f02020-07-30 11:36:45 +0200773 goto exit;
Steven Cooremanacda8342020-07-24 23:09:52 +0200774
Steven Cooreman6d839f02020-07-30 11:36:45 +0200775 /* Load the key material. */
Steven Cooreman7f391872020-07-30 14:57:44 +0200776 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) )
Steven Cooremanacda8342020-07-24 23:09:52 +0200777 {
778 /* Load the public value. */
779 status = mbedtls_to_psa_error(
780 mbedtls_ecp_point_read_binary( &ecp->grp, &ecp->Q,
Steven Cooreman4fed4552020-08-03 14:46:03 +0200781 data,
782 data_length ) );
Steven Cooremanacda8342020-07-24 23:09:52 +0200783 if( status != PSA_SUCCESS )
784 goto exit;
785
786 /* Check that the point is on the curve. */
787 status = mbedtls_to_psa_error(
788 mbedtls_ecp_check_pubkey( &ecp->grp, &ecp->Q ) );
789 if( status != PSA_SUCCESS )
790 goto exit;
791 }
792 else
793 {
Steven Cooreman6d839f02020-07-30 11:36:45 +0200794 /* Load and validate the secret value. */
Steven Cooremanacda8342020-07-24 23:09:52 +0200795 status = mbedtls_to_psa_error(
796 mbedtls_ecp_read_key( ecp->grp.id,
797 ecp,
Steven Cooreman4fed4552020-08-03 14:46:03 +0200798 data,
799 data_length ) );
Steven Cooremanacda8342020-07-24 23:09:52 +0200800 if( status != PSA_SUCCESS )
801 goto exit;
Steven Cooremanacda8342020-07-24 23:09:52 +0200802 }
Steven Cooremana2371e52020-07-28 14:30:39 +0200803
804 *p_ecp = ecp;
Steven Cooremanacda8342020-07-24 23:09:52 +0200805exit:
806 if( status != PSA_SUCCESS )
Steven Cooremana2371e52020-07-28 14:30:39 +0200807 {
Steven Cooremanacda8342020-07-24 23:09:52 +0200808 mbedtls_ecp_keypair_free( ecp );
Steven Cooremana2371e52020-07-28 14:30:39 +0200809 mbedtls_free( ecp );
810 }
811
Steven Cooreman29149862020-08-05 15:43:42 +0200812 return( status );
Gilles Peskine4cd32772019-12-02 20:49:42 +0100813}
Jaeden Ameroccdce902019-01-10 11:42:27 +0000814
Steven Cooreman4fed4552020-08-03 14:46:03 +0200815/** Export an ECP key to export representation
816 *
817 * \param[in] type The type of key (public/private) to export
818 * \param[in] ecp The internal ECP representation from which to export
819 * \param[out] data The buffer to export to
820 * \param[in] data_size The length of the buffer to export to
821 * \param[out] data_length The amount of bytes written to \p data
822 */
Steven Cooremanacda8342020-07-24 23:09:52 +0200823static psa_status_t psa_export_ecp_key( psa_key_type_t type,
824 mbedtls_ecp_keypair *ecp,
825 uint8_t *data,
826 size_t data_size,
827 size_t *data_length )
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200828{
Steven Cooremanacda8342020-07-24 23:09:52 +0200829 psa_status_t status;
Jaeden Ameroccdce902019-01-10 11:42:27 +0000830
Steven Cooremanacda8342020-07-24 23:09:52 +0200831 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) )
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200832 {
Steven Cooremanacda8342020-07-24 23:09:52 +0200833 /* Check whether the public part is loaded */
834 if( mbedtls_ecp_is_zero( &ecp->Q ) )
835 {
836 /* Calculate the public key */
837 status = mbedtls_to_psa_error(
838 mbedtls_ecp_mul( &ecp->grp, &ecp->Q, &ecp->d, &ecp->grp.G,
839 mbedtls_ctr_drbg_random, &global_data.ctr_drbg ) );
840 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +0200841 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +0200842 }
843
Steven Cooreman4fed4552020-08-03 14:46:03 +0200844 status = mbedtls_to_psa_error(
Steven Cooremanacda8342020-07-24 23:09:52 +0200845 mbedtls_ecp_point_write_binary( &ecp->grp, &ecp->Q,
846 MBEDTLS_ECP_PF_UNCOMPRESSED,
847 data_length,
848 data,
Steven Cooreman4fed4552020-08-03 14:46:03 +0200849 data_size ) );
Steven Cooreman4fed4552020-08-03 14:46:03 +0200850 if( status != PSA_SUCCESS )
851 memset( data, 0, data_size );
852
Steven Cooreman29149862020-08-05 15:43:42 +0200853 return( status );
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200854 }
Steven Cooremanacda8342020-07-24 23:09:52 +0200855 else
856 {
Steven Cooreman29149862020-08-05 15:43:42 +0200857 if( data_size < PSA_BITS_TO_BYTES( ecp->grp.nbits ) )
Steven Cooremanacda8342020-07-24 23:09:52 +0200858 return( PSA_ERROR_BUFFER_TOO_SMALL );
859
860 status = mbedtls_to_psa_error(
861 mbedtls_ecp_write_key( ecp,
862 data,
Steven Cooreman29149862020-08-05 15:43:42 +0200863 PSA_BITS_TO_BYTES( ecp->grp.nbits ) ) );
Steven Cooremanacda8342020-07-24 23:09:52 +0200864 if( status == PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +0200865 *data_length = PSA_BITS_TO_BYTES( ecp->grp.nbits );
Steven Cooremanb7f6dea2020-08-05 16:07:20 +0200866 else
867 memset( data, 0, data_size );
Steven Cooremanacda8342020-07-24 23:09:52 +0200868
869 return( status );
870 }
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200871}
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200872
Steven Cooreman4fed4552020-08-03 14:46:03 +0200873/** Import an ECP key from import representation to a slot
874 *
875 * \param[in,out] slot The slot where to store the export representation to
876 * \param[in] data The buffer containing the import representation
877 * \param[in] data_length The amount of bytes in \p data
878 */
Steven Cooremanacda8342020-07-24 23:09:52 +0200879static psa_status_t psa_import_ecp_key( psa_key_slot_t *slot,
880 const uint8_t *data,
881 size_t data_length )
Gilles Peskinef76aa772018-10-29 19:24:33 +0100882{
Steven Cooremanacda8342020-07-24 23:09:52 +0200883 psa_status_t status;
884 uint8_t* output = NULL;
Steven Cooremana2371e52020-07-28 14:30:39 +0200885 mbedtls_ecp_keypair *ecp = NULL;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100886
Steven Cooremanacda8342020-07-24 23:09:52 +0200887 /* Parse input */
Steven Cooreman4fed4552020-08-03 14:46:03 +0200888 status = psa_load_ecp_representation( slot->attr.type,
889 data,
Steven Cooreman7f391872020-07-30 14:57:44 +0200890 data_length,
Steven Cooreman7f391872020-07-30 14:57:44 +0200891 &ecp );
Gilles Peskinef76aa772018-10-29 19:24:33 +0100892 if( status != PSA_SUCCESS )
893 goto exit;
Gilles Peskine4cd32772019-12-02 20:49:42 +0100894
Steven Cooremanacda8342020-07-24 23:09:52 +0200895 if( PSA_KEY_TYPE_ECC_GET_FAMILY( slot->attr.type ) == PSA_ECC_FAMILY_MONTGOMERY)
Steven Cooremana2371e52020-07-28 14:30:39 +0200896 slot->attr.bits = (psa_key_bits_t) ecp->grp.nbits + 1;
Steven Cooremanacda8342020-07-24 23:09:52 +0200897 else
Steven Cooremana2371e52020-07-28 14:30:39 +0200898 slot->attr.bits = (psa_key_bits_t) ecp->grp.nbits;
Steven Cooremane3fd3922020-06-11 16:50:36 +0200899
Steven Cooremanacda8342020-07-24 23:09:52 +0200900 /* Re-export the data to PSA export format. There is currently no support
901 * for other input formats then the export format, so this is a 1-1
902 * copy operation. */
903 output = mbedtls_calloc( 1, data_length );
Steven Cooremanacda8342020-07-24 23:09:52 +0200904 if( output == NULL )
905 {
906 status = PSA_ERROR_INSUFFICIENT_MEMORY;
907 goto exit;
908 }
909
910 status = psa_export_ecp_key( slot->attr.type,
Steven Cooremana2371e52020-07-28 14:30:39 +0200911 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +0200912 output,
913 data_length,
914 &data_length);
Gilles Peskinef76aa772018-10-29 19:24:33 +0100915exit:
Steven Cooremana2371e52020-07-28 14:30:39 +0200916 /* Always free the PK object (will also free contained ECP context) */
917 mbedtls_ecp_keypair_free( ecp );
Steven Cooreman6d839f02020-07-30 11:36:45 +0200918 mbedtls_free( ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +0200919
920 /* Free the allocated buffer only on error. */
921 if( status != PSA_SUCCESS )
Gilles Peskinef76aa772018-10-29 19:24:33 +0100922 {
Steven Cooremanacda8342020-07-24 23:09:52 +0200923 mbedtls_free( output );
Steven Cooremanacda8342020-07-24 23:09:52 +0200924 return( status );
Gilles Peskinef76aa772018-10-29 19:24:33 +0100925 }
Steven Cooremanacda8342020-07-24 23:09:52 +0200926
927 /* On success, store the allocated export-formatted key. */
928 slot->data.key.data = output;
929 slot->data.key.bytes = data_length;
930
931 return( PSA_SUCCESS );
Gilles Peskinef76aa772018-10-29 19:24:33 +0100932}
933#endif /* defined(MBEDTLS_ECP_C) */
934
Gilles Peskineb46bef22019-07-30 21:32:04 +0200935/** Return the size of the key in the given slot, in bits.
936 *
937 * \param[in] slot A key slot.
938 *
939 * \return The key size in bits, read from the metadata in the slot.
940 */
941static inline size_t psa_get_key_slot_bits( const psa_key_slot_t *slot )
942{
943 return( slot->attr.bits );
944}
945
Steven Cooreman75b74362020-07-28 14:30:13 +0200946/** Try to allocate a buffer to an empty key slot.
947 *
948 * \param[in,out] slot Key slot to attach buffer to.
949 * \param[in] buffer_length Requested size of the buffer.
950 *
951 * \retval #PSA_SUCCESS
952 * The buffer has been successfully allocated.
953 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
954 * Not enough memory was available for allocation.
955 * \retval #PSA_ERROR_ALREADY_EXISTS
956 * Trying to allocate a buffer to a non-empty key slot.
957 */
958static psa_status_t psa_allocate_buffer_to_slot( psa_key_slot_t *slot,
959 size_t buffer_length )
960{
961 if( slot->data.key.data != NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200962 return( PSA_ERROR_ALREADY_EXISTS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200963
964 slot->data.key.data = mbedtls_calloc( 1, buffer_length );
965 if( slot->data.key.data == NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200966 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Steven Cooreman75b74362020-07-28 14:30:13 +0200967
968 slot->data.key.bytes = buffer_length;
Steven Cooreman29149862020-08-05 15:43:42 +0200969 return( PSA_SUCCESS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200970}
971
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200972psa_status_t psa_copy_key_material_into_slot( psa_key_slot_t *slot,
973 const uint8_t* data,
974 size_t data_length )
975{
976 psa_status_t status = psa_allocate_buffer_to_slot( slot,
977 data_length );
978 if( status != PSA_SUCCESS )
979 return( status );
980
981 memcpy( slot->data.key.data, data, data_length );
982 return( PSA_SUCCESS );
983}
984
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200985/** Import key data into a slot.
986 *
987 * `slot->type` must have been set previously.
988 * This function assumes that the slot does not contain any key material yet.
989 * On failure, the slot content is unchanged.
990 *
991 * Persistent storage is not affected.
992 *
993 * \param[in,out] slot The key slot to import data into.
994 * Its `type` field must have previously been set to
995 * the desired key type.
996 * It must not contain any key material yet.
997 * \param[in] data Buffer containing the key material to parse and import.
998 * \param data_length Size of \p data in bytes.
999 *
1000 * \retval #PSA_SUCCESS
1001 * \retval #PSA_ERROR_INVALID_ARGUMENT
1002 * \retval #PSA_ERROR_NOT_SUPPORTED
1003 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
1004 */
1005static psa_status_t psa_import_key_into_slot( psa_key_slot_t *slot,
1006 const uint8_t *data,
1007 size_t data_length )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001008{
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001009 psa_status_t status = PSA_SUCCESS;
Steven Cooreman04524762020-10-13 17:43:44 +02001010 size_t bit_size;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001011
Steven Cooreman81be2fa2020-07-24 22:04:59 +02001012 /* zero-length keys are never supported. */
1013 if( data_length == 0 )
1014 return( PSA_ERROR_NOT_SUPPORTED );
1015
Gilles Peskine8e338702019-07-30 20:06:31 +02001016 if( key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001017 {
Steven Cooreman04524762020-10-13 17:43:44 +02001018 bit_size = PSA_BYTES_TO_BITS( data_length );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02001019
Steven Cooreman75b74362020-07-28 14:30:13 +02001020 /* Ensure that the bytes-to-bits conversion hasn't overflown. */
1021 if( data_length > SIZE_MAX / 8 )
1022 return( PSA_ERROR_NOT_SUPPORTED );
1023
Gilles Peskine1b9505c2019-08-07 10:59:45 +02001024 /* Enforce a size limit, and in particular ensure that the bit
1025 * size fits in its representation type. */
Gilles Peskinec744d992019-07-30 17:26:54 +02001026 if( bit_size > PSA_MAX_KEY_BITS )
1027 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02001028
1029 status = validate_unstructured_key_bit_size( slot->attr.type, bit_size );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +02001030 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001031 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02001032
1033 /* Allocate memory for the key */
Steven Cooremanf7cebd42020-10-13 20:27:40 +02001034 status = psa_copy_key_material_into_slot( slot, data, data_length );
Steven Cooreman75b74362020-07-28 14:30:13 +02001035 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001036 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02001037
Steven Cooreman81be2fa2020-07-24 22:04:59 +02001038 /* Write the actual key size to the slot.
1039 * psa_start_key_creation() wrote the size declared by the
1040 * caller, which may be 0 (meaning unspecified) or wrong. */
1041 slot->attr.bits = (psa_key_bits_t) bit_size;
Steven Cooreman40120f62020-10-29 11:42:22 +01001042
1043 return( PSA_SUCCESS );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001044 }
Steven Cooreman3ea0ce42020-10-23 11:37:05 +02001045 else if( PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
Steven Cooreman19fd5742020-07-24 23:31:01 +02001046 {
Steven Cooreman3ea0ce42020-10-23 11:37:05 +02001047 /* Try validation through accelerators first. */
1048 bit_size = slot->attr.bits;
1049 psa_key_attributes_t attributes = {
1050 .core = slot->attr
1051 };
1052 status = psa_driver_wrapper_validate_key( &attributes,
1053 data,
1054 data_length,
1055 &bit_size );
1056 if( status == PSA_SUCCESS )
1057 {
1058 /* Key has been validated successfully by an accelerator.
1059 * Copy key material into slot. */
1060 status = psa_copy_key_material_into_slot( slot, data, data_length );
1061 if( status != PSA_SUCCESS )
1062 return( status );
1063
1064 slot->attr.bits = (psa_key_bits_t) bit_size;
1065 return( PSA_SUCCESS );
1066 }
1067 else if( status != PSA_ERROR_NOT_SUPPORTED )
1068 return( status );
1069
1070 /* Key format is not supported by any accelerator, try software fallback
1071 * if present. */
Gilles Peskinef76aa772018-10-29 19:24:33 +01001072#if defined(MBEDTLS_ECP_C)
Steven Cooreman3ea0ce42020-10-23 11:37:05 +02001073 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
1074 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001075 return( psa_import_ecp_key( slot, data, data_length ) );
1076 }
Steven Cooreman19fd5742020-07-24 23:31:01 +02001077#endif /* defined(MBEDTLS_ECP_C) */
Steven Cooreman19fd5742020-07-24 23:31:01 +02001078#if defined(MBEDTLS_RSA_C)
Steven Cooreman40120f62020-10-29 11:42:22 +01001079 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +02001080 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001081 return( psa_import_rsa_key( slot, data, data_length ) );
Steven Cooreman3ea0ce42020-10-23 11:37:05 +02001082 }
Steven Cooreman19fd5742020-07-24 23:31:01 +02001083#endif /* defined(MBEDTLS_RSA_C) */
Steven Cooreman40120f62020-10-29 11:42:22 +01001084
1085 /* Fell through the fallback as well, so have nothing else to try. */
1086 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001087 }
1088 else
Gilles Peskinec66ea6a2018-02-03 22:43:28 +01001089 {
Steven Cooreman19fd5742020-07-24 23:31:01 +02001090 /* Unknown key type */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001091 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969ac722018-01-28 18:16:59 +01001092 }
Darryl Green06fd18d2018-07-16 11:21:11 +01001093}
1094
Gilles Peskinef603c712019-01-19 13:40:11 +01001095/** Calculate the intersection of two algorithm usage policies.
1096 *
1097 * Return 0 (which allows no operation) on incompatibility.
1098 */
1099static psa_algorithm_t psa_key_policy_algorithm_intersection(
1100 psa_algorithm_t alg1,
1101 psa_algorithm_t alg2 )
1102{
Gilles Peskine549ea862019-05-22 11:45:59 +02001103 /* Common case: both sides actually specify the same policy. */
Gilles Peskinef603c712019-01-19 13:40:11 +01001104 if( alg1 == alg2 )
1105 return( alg1 );
1106 /* If the policies are from the same hash-and-sign family, check
1107 * if one is a wildcard. If so the other has the specific algorithm. */
1108 if( PSA_ALG_IS_HASH_AND_SIGN( alg1 ) &&
1109 PSA_ALG_IS_HASH_AND_SIGN( alg2 ) &&
1110 ( alg1 & ~PSA_ALG_HASH_MASK ) == ( alg2 & ~PSA_ALG_HASH_MASK ) )
1111 {
1112 if( PSA_ALG_SIGN_GET_HASH( alg1 ) == PSA_ALG_ANY_HASH )
1113 return( alg2 );
1114 if( PSA_ALG_SIGN_GET_HASH( alg2 ) == PSA_ALG_ANY_HASH )
1115 return( alg1 );
1116 }
1117 /* If the policies are incompatible, allow nothing. */
1118 return( 0 );
1119}
1120
Gilles Peskined6f371b2019-05-10 19:33:38 +02001121static int psa_key_algorithm_permits( psa_algorithm_t policy_alg,
1122 psa_algorithm_t requested_alg )
1123{
Gilles Peskine549ea862019-05-22 11:45:59 +02001124 /* Common case: the policy only allows requested_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +02001125 if( requested_alg == policy_alg )
1126 return( 1 );
1127 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
Gilles Peskine549ea862019-05-22 11:45:59 +02001128 * and requested_alg is the same hash-and-sign family with any hash,
1129 * then requested_alg is compliant with policy_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +02001130 if( PSA_ALG_IS_HASH_AND_SIGN( requested_alg ) &&
1131 PSA_ALG_SIGN_GET_HASH( policy_alg ) == PSA_ALG_ANY_HASH )
1132 {
1133 return( ( policy_alg & ~PSA_ALG_HASH_MASK ) ==
1134 ( requested_alg & ~PSA_ALG_HASH_MASK ) );
1135 }
Steven Cooremance48e852020-10-05 16:02:45 +02001136 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +02001137 * a key derivation with that key agreement should also be allowed. This
1138 * behaviour is expected to be defined in a future specification version. */
Steven Cooremance48e852020-10-05 16:02:45 +02001139 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( policy_alg ) &&
1140 PSA_ALG_IS_KEY_AGREEMENT( requested_alg ) )
1141 {
1142 return( PSA_ALG_KEY_AGREEMENT_GET_BASE( requested_alg ) ==
1143 policy_alg );
1144 }
Gilles Peskined6f371b2019-05-10 19:33:38 +02001145 /* If it isn't permitted, it's forbidden. */
1146 return( 0 );
1147}
1148
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001149/** Test whether a policy permits an algorithm.
1150 *
1151 * The caller must test usage flags separately.
1152 */
1153static int psa_key_policy_permits( const psa_key_policy_t *policy,
1154 psa_algorithm_t alg )
1155{
Gilles Peskined6f371b2019-05-10 19:33:38 +02001156 return( psa_key_algorithm_permits( policy->alg, alg ) ||
1157 psa_key_algorithm_permits( policy->alg2, alg ) );
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001158}
1159
Gilles Peskinef603c712019-01-19 13:40:11 +01001160/** Restrict a key policy based on a constraint.
1161 *
1162 * \param[in,out] policy The policy to restrict.
1163 * \param[in] constraint The policy constraint to apply.
1164 *
1165 * \retval #PSA_SUCCESS
1166 * \c *policy contains the intersection of the original value of
1167 * \c *policy and \c *constraint.
1168 * \retval #PSA_ERROR_INVALID_ARGUMENT
1169 * \c *policy and \c *constraint are incompatible.
1170 * \c *policy is unchanged.
1171 */
1172static psa_status_t psa_restrict_key_policy(
1173 psa_key_policy_t *policy,
1174 const psa_key_policy_t *constraint )
1175{
1176 psa_algorithm_t intersection_alg =
1177 psa_key_policy_algorithm_intersection( policy->alg, constraint->alg );
Gilles Peskined6f371b2019-05-10 19:33:38 +02001178 psa_algorithm_t intersection_alg2 =
1179 psa_key_policy_algorithm_intersection( policy->alg2, constraint->alg2 );
Gilles Peskinef603c712019-01-19 13:40:11 +01001180 if( intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0 )
1181 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskined6f371b2019-05-10 19:33:38 +02001182 if( intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0 )
1183 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinef603c712019-01-19 13:40:11 +01001184 policy->usage &= constraint->usage;
1185 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +02001186 policy->alg2 = intersection_alg2;
Gilles Peskinef603c712019-01-19 13:40:11 +01001187 return( PSA_SUCCESS );
1188}
1189
Darryl Green06fd18d2018-07-16 11:21:11 +01001190/** Retrieve a slot which must contain a key. The key must have allow all the
1191 * usage flags set in \p usage. If \p alg is nonzero, the key must allow
Ronald Cronf95a2b12020-10-22 15:24:49 +02001192 * operations with this algorithm.
1193 *
Ronald Cron7587ae42020-11-11 15:04:25 +01001194 * In case of a persistent key, the function loads the description of the key
1195 * into a key slot if not already done.
1196 *
Ronald Cronf95a2b12020-10-22 15:24:49 +02001197 * On success, the access counter of the returned key slot is incremented by
1198 * one. It is the responsibility of the caller to call
1199 * psa_decrement_key_slot_access_count() when it does not access the key slot
1200 * anymore.
1201 */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001202static psa_status_t psa_get_key_from_slot( mbedtls_svc_key_id_t key,
Gilles Peskine2f060a82018-12-04 17:12:32 +01001203 psa_key_slot_t **p_slot,
Darryl Green06fd18d2018-07-16 11:21:11 +01001204 psa_key_usage_t usage,
1205 psa_algorithm_t alg )
1206{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001207 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1208 psa_key_slot_t *slot;
Darryl Green06fd18d2018-07-16 11:21:11 +01001209
Ronald Cronf95a2b12020-10-22 15:24:49 +02001210 status = psa_get_key_slot( key, p_slot );
Darryl Green06fd18d2018-07-16 11:21:11 +01001211 if( status != PSA_SUCCESS )
1212 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001213 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +01001214
1215 /* Enforce that usage policy for the key slot contains all the flags
1216 * required by the usage parameter. There is one exception: public
1217 * keys can always be exported, so we treat public key objects as
1218 * if they had the export flag. */
Gilles Peskine8e338702019-07-30 20:06:31 +02001219 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Darryl Green06fd18d2018-07-16 11:21:11 +01001220 usage &= ~PSA_KEY_USAGE_EXPORT;
Ronald Cronf95a2b12020-10-22 15:24:49 +02001221
1222 status = PSA_ERROR_NOT_PERMITTED;
Gilles Peskine8e338702019-07-30 20:06:31 +02001223 if( ( slot->attr.policy.usage & usage ) != usage )
Ronald Cronf95a2b12020-10-22 15:24:49 +02001224 goto error;
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001225
1226 /* Enforce that the usage policy permits the requested algortihm. */
Gilles Peskine8e338702019-07-30 20:06:31 +02001227 if( alg != 0 && ! psa_key_policy_permits( &slot->attr.policy, alg ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02001228 goto error;
Darryl Green06fd18d2018-07-16 11:21:11 +01001229
Darryl Green06fd18d2018-07-16 11:21:11 +01001230 return( PSA_SUCCESS );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001231
1232error:
1233 *p_slot = NULL;
1234 psa_decrement_key_slot_access_count( slot );
1235
1236 return( status );
Darryl Green06fd18d2018-07-16 11:21:11 +01001237}
Darryl Green940d72c2018-07-13 13:18:51 +01001238
Gilles Peskine28f8f302019-07-24 13:30:31 +02001239/** Retrieve a slot which must contain a transparent key.
1240 *
1241 * A transparent key is a key for which the key material is directly
1242 * available, as opposed to a key in a secure element.
1243 *
Gilles Peskine60450a42019-07-25 11:32:45 +02001244 * This is a temporary function to use instead of psa_get_key_from_slot()
1245 * until secure element support is fully implemented.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001246 *
1247 * On success, the access counter of the returned key slot is incremented by
1248 * one. It is the responsibility of the caller to call
1249 * psa_decrement_key_slot_access_count() when it does not access the key slot
1250 * anymore.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001251 */
1252#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Ronald Croncf56a0a2020-08-04 09:51:30 +02001253static psa_status_t psa_get_transparent_key( mbedtls_svc_key_id_t key,
Gilles Peskine28f8f302019-07-24 13:30:31 +02001254 psa_key_slot_t **p_slot,
1255 psa_key_usage_t usage,
1256 psa_algorithm_t alg )
1257{
Ronald Croncf56a0a2020-08-04 09:51:30 +02001258 psa_status_t status = psa_get_key_from_slot( key, p_slot, usage, alg );
Gilles Peskine28f8f302019-07-24 13:30:31 +02001259 if( status != PSA_SUCCESS )
1260 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001261
Gilles Peskineadad8132019-07-25 11:31:23 +02001262 if( psa_key_slot_is_external( *p_slot ) )
Gilles Peskine28f8f302019-07-24 13:30:31 +02001263 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02001264 psa_decrement_key_slot_access_count( *p_slot );
Gilles Peskine28f8f302019-07-24 13:30:31 +02001265 *p_slot = NULL;
1266 return( PSA_ERROR_NOT_SUPPORTED );
1267 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001268
Gilles Peskine28f8f302019-07-24 13:30:31 +02001269 return( PSA_SUCCESS );
1270}
1271#else /* MBEDTLS_PSA_CRYPTO_SE_C */
1272/* With no secure element support, all keys are transparent. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001273#define psa_get_transparent_key( key, p_slot, usage, alg ) \
1274 psa_get_key_from_slot( key, p_slot, usage, alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +02001275#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1276
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001277/** Wipe key data from a slot. Preserve metadata such as the policy. */
Gilles Peskine2f060a82018-12-04 17:12:32 +01001278static psa_status_t psa_remove_key_data_from_memory( psa_key_slot_t *slot )
Darryl Green40225ba2018-11-15 14:48:15 +00001279{
Gilles Peskine73167e12019-07-12 23:44:37 +02001280#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1281 if( psa_key_slot_is_external( slot ) )
Darryl Green40225ba2018-11-15 14:48:15 +00001282 {
1283 /* No key material to clean. */
1284 }
Gilles Peskine73167e12019-07-12 23:44:37 +02001285 else
1286#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Darryl Green40225ba2018-11-15 14:48:15 +00001287 {
Steven Cooremanfd4d69a2020-08-05 15:46:33 +02001288 /* Data pointer will always be either a valid pointer or NULL in an
1289 * initialized slot, so we can just free it. */
1290 if( slot->data.key.data != NULL )
1291 mbedtls_platform_zeroize( slot->data.key.data, slot->data.key.bytes);
Steven Cooremana01795d2020-07-24 22:48:15 +02001292 mbedtls_free( slot->data.key.data );
1293 slot->data.key.data = NULL;
1294 slot->data.key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +00001295 }
Darryl Green40225ba2018-11-15 14:48:15 +00001296
1297 return( PSA_SUCCESS );
1298}
1299
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001300/** Completely wipe a slot in memory, including its policy.
1301 * Persistent storage is not affected. */
Gilles Peskine66fb1262018-12-10 16:29:04 +01001302psa_status_t psa_wipe_key_slot( psa_key_slot_t *slot )
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001303{
1304 psa_status_t status = psa_remove_key_data_from_memory( slot );
Ronald Cronddd3d052020-10-30 14:07:07 +01001305
1306 /*
1307 * As the return error code may not be handled in case of multiple errors,
1308 * do our best to report an unexpected access counter: if available
1309 * call MBEDTLS_PARAM_FAILED that may terminate execution (if called as
1310 * part of the execution of a test suite this will stop the test suite
Ronald Cron4640c152020-11-13 10:11:01 +01001311 * execution).
Ronald Cronddd3d052020-10-30 14:07:07 +01001312 */
1313 if( slot->access_count != 1 )
1314 {
1315#ifdef MBEDTLS_CHECK_PARAMS
1316 MBEDTLS_PARAM_FAILED( slot->access_count == 1 );
1317#endif
Ronald Cronddd3d052020-10-30 14:07:07 +01001318 status = PSA_ERROR_CORRUPTION_DETECTED;
1319 }
1320
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001321 /* Multipart operations may still be using the key. This is safe
1322 * because all multipart operation objects are independent from
1323 * the key slot: if they need to access the key after the setup
1324 * phase, they have a copy of the key. Note that this means that
1325 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001326 /* At this point, key material and other type-specific content has
1327 * been wiped. Clear remaining metadata. We can call memset and not
1328 * zeroize because the metadata is not particularly sensitive. */
1329 memset( slot, 0, sizeof( *slot ) );
1330 return( status );
1331}
1332
Ronald Croncf56a0a2020-08-04 09:51:30 +02001333psa_status_t psa_destroy_key( mbedtls_svc_key_id_t key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001334{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001335 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001336 psa_status_t status; /* status of the last operation */
1337 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001338#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1339 psa_se_drv_table_entry_t *driver;
1340#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001341
Ronald Croncf56a0a2020-08-04 09:51:30 +02001342 if( mbedtls_svc_key_id_is_null( key ) )
Gilles Peskine1841cf42019-10-08 15:48:25 +02001343 return( PSA_SUCCESS );
1344
Ronald Cronf2911112020-10-29 17:51:10 +01001345 /*
Ronald Cron19daca92020-11-10 18:08:03 +01001346 * Get the description of the key in a key slot. In case of a persistent
Ronald Cronf2911112020-10-29 17:51:10 +01001347 * key, this will load the key description from persistent memory if not
1348 * done yet. We cannot avoid this loading as without it we don't know if
1349 * the key is operated by an SE or not and this information is needed by
1350 * the current implementation.
1351 */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001352 status = psa_get_key_slot( key, &slot );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001353 if( status != PSA_SUCCESS )
1354 return( status );
Gilles Peskine354f7672019-07-12 23:46:38 +02001355
Ronald Cronf2911112020-10-29 17:51:10 +01001356 /*
1357 * If the key slot containing the key description is under access by the
1358 * library (apart from the present access), the key cannot be destroyed
1359 * yet. For the time being, just return in error. Eventually (to be
1360 * implemented), the key should be destroyed when all accesses have
1361 * stopped.
1362 */
1363 if( slot->access_count > 1 )
1364 {
1365 psa_decrement_key_slot_access_count( slot );
1366 return( PSA_ERROR_GENERIC_ERROR );
1367 }
1368
Gilles Peskine354f7672019-07-12 23:46:38 +02001369#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001370 driver = psa_get_se_driver_entry( slot->attr.lifetime );
Gilles Peskine354f7672019-07-12 23:46:38 +02001371 if( driver != NULL )
Gilles Peskinefc762652019-07-22 19:30:34 +02001372 {
Gilles Peskine60450a42019-07-25 11:32:45 +02001373 /* For a key in a secure element, we need to do three things:
1374 * remove the key file in internal storage, destroy the
1375 * key inside the secure element, and update the driver's
1376 * persistent data. Start a transaction that will encompass these
1377 * three actions. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001378 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_DESTROY_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +02001379 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Gilles Peskinefc762652019-07-22 19:30:34 +02001380 psa_crypto_transaction.key.slot = slot->data.se.slot_number;
Gilles Peskine8e338702019-07-30 20:06:31 +02001381 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskinefc762652019-07-22 19:30:34 +02001382 status = psa_crypto_save_transaction( );
1383 if( status != PSA_SUCCESS )
1384 {
Gilles Peskine66be51c2019-07-25 18:02:52 +02001385 (void) psa_crypto_stop_transaction( );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001386 /* We should still try to destroy the key in the secure
1387 * element and the key metadata in storage. This is especially
1388 * important if the error is that the storage is full.
1389 * But how to do it exactly without risking an inconsistent
1390 * state after a reset?
1391 * https://github.com/ARMmbed/mbed-crypto/issues/215
1392 */
1393 overall_status = status;
1394 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001395 }
1396
Gilles Peskine354f7672019-07-12 23:46:38 +02001397 status = psa_destroy_se_key( driver, slot->data.se.slot_number );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001398 if( overall_status == PSA_SUCCESS )
1399 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001400 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001401#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1402
Darryl Greend49a4992018-06-18 17:27:26 +01001403#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Ronald Crond98059d2020-10-23 18:00:55 +02001404 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Darryl Greend49a4992018-06-18 17:27:26 +01001405 {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001406 status = psa_destroy_persistent_key( slot->attr.id );
1407 if( overall_status == PSA_SUCCESS )
1408 overall_status = status;
1409
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001410 /* TODO: other slots may have a copy of the same key. We should
1411 * invalidate them.
1412 * https://github.com/ARMmbed/mbed-crypto/issues/214
1413 */
Darryl Greend49a4992018-06-18 17:27:26 +01001414 }
1415#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001416
Gilles Peskinefc762652019-07-22 19:30:34 +02001417#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1418 if( driver != NULL )
1419 {
Gilles Peskine725f22a2019-07-25 11:31:48 +02001420 status = psa_save_se_persistent_data( driver );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001421 if( overall_status == PSA_SUCCESS )
1422 overall_status = status;
1423 status = psa_crypto_stop_transaction( );
1424 if( overall_status == PSA_SUCCESS )
1425 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001426 }
1427#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1428
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001429#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1430exit:
1431#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001432 status = psa_wipe_key_slot( slot );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001433 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
1434 if( overall_status == PSA_SUCCESS )
1435 overall_status = status;
1436 return( overall_status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001437}
1438
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001439void psa_reset_key_attributes( psa_key_attributes_t *attributes )
Gilles Peskineb870b182018-07-06 16:02:09 +02001440{
Gilles Peskineb699f072019-04-26 16:06:02 +02001441 mbedtls_free( attributes->domain_parameters );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001442 memset( attributes, 0, sizeof( *attributes ) );
Gilles Peskineb870b182018-07-06 16:02:09 +02001443}
1444
Gilles Peskineb699f072019-04-26 16:06:02 +02001445psa_status_t psa_set_key_domain_parameters( psa_key_attributes_t *attributes,
1446 psa_key_type_t type,
1447 const uint8_t *data,
1448 size_t data_length )
1449{
1450 uint8_t *copy = NULL;
1451
1452 if( data_length != 0 )
1453 {
1454 copy = mbedtls_calloc( 1, data_length );
1455 if( copy == NULL )
1456 return( PSA_ERROR_INSUFFICIENT_MEMORY );
1457 memcpy( copy, data, data_length );
1458 }
1459 /* After this point, this function is guaranteed to succeed, so it
1460 * can start modifying `*attributes`. */
1461
1462 if( attributes->domain_parameters != NULL )
1463 {
1464 mbedtls_free( attributes->domain_parameters );
1465 attributes->domain_parameters = NULL;
1466 attributes->domain_parameters_size = 0;
1467 }
1468
1469 attributes->domain_parameters = copy;
1470 attributes->domain_parameters_size = data_length;
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001471 attributes->core.type = type;
Gilles Peskineb699f072019-04-26 16:06:02 +02001472 return( PSA_SUCCESS );
1473}
1474
1475psa_status_t psa_get_key_domain_parameters(
1476 const psa_key_attributes_t *attributes,
1477 uint8_t *data, size_t data_size, size_t *data_length )
1478{
1479 if( attributes->domain_parameters_size > data_size )
1480 return( PSA_ERROR_BUFFER_TOO_SMALL );
1481 *data_length = attributes->domain_parameters_size;
1482 if( attributes->domain_parameters_size != 0 )
1483 memcpy( data, attributes->domain_parameters,
1484 attributes->domain_parameters_size );
1485 return( PSA_SUCCESS );
1486}
1487
1488#if defined(MBEDTLS_RSA_C)
1489static psa_status_t psa_get_rsa_public_exponent(
1490 const mbedtls_rsa_context *rsa,
1491 psa_key_attributes_t *attributes )
1492{
1493 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001494 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001495 uint8_t *buffer = NULL;
1496 size_t buflen;
1497 mbedtls_mpi_init( &mpi );
1498
1499 ret = mbedtls_rsa_export( rsa, NULL, NULL, NULL, NULL, &mpi );
1500 if( ret != 0 )
1501 goto exit;
Gilles Peskine772c8b12019-04-26 17:37:21 +02001502 if( mbedtls_mpi_cmp_int( &mpi, 65537 ) == 0 )
1503 {
1504 /* It's the default value, which is reported as an empty string,
1505 * so there's nothing to do. */
1506 goto exit;
1507 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001508
1509 buflen = mbedtls_mpi_size( &mpi );
1510 buffer = mbedtls_calloc( 1, buflen );
1511 if( buffer == NULL )
1512 {
1513 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1514 goto exit;
1515 }
1516 ret = mbedtls_mpi_write_binary( &mpi, buffer, buflen );
1517 if( ret != 0 )
1518 goto exit;
1519 attributes->domain_parameters = buffer;
1520 attributes->domain_parameters_size = buflen;
1521
1522exit:
1523 mbedtls_mpi_free( &mpi );
1524 if( ret != 0 )
1525 mbedtls_free( buffer );
1526 return( mbedtls_to_psa_error( ret ) );
1527}
1528#endif /* MBEDTLS_RSA_C */
1529
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001530/** Retrieve all the publicly-accessible attributes of a key.
1531 */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001532psa_status_t psa_get_key_attributes( mbedtls_svc_key_id_t key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001533 psa_key_attributes_t *attributes )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001534{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001535 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1536 psa_status_t decrement_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001537 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001538
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001539 psa_reset_key_attributes( attributes );
1540
Ronald Croncf56a0a2020-08-04 09:51:30 +02001541 status = psa_get_key_from_slot( key, &slot, 0, 0 );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001542 if( status != PSA_SUCCESS )
1543 return( status );
Gilles Peskineb870b182018-07-06 16:02:09 +02001544
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001545 attributes->core = slot->attr;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001546 attributes->core.flags &= ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1547 MBEDTLS_PSA_KA_MASK_DUAL_USE );
1548
1549#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1550 if( psa_key_slot_is_external( slot ) )
1551 psa_set_key_slot_number( attributes, slot->data.se.slot_number );
1552#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001553
Gilles Peskine8e338702019-07-30 20:06:31 +02001554 switch( slot->attr.type )
Gilles Peskineb699f072019-04-26 16:06:02 +02001555 {
1556#if defined(MBEDTLS_RSA_C)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001557 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001558 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001559#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001560 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001561 * is not yet implemented.
1562 * https://github.com/ARMmbed/mbed-crypto/issues/216
1563 */
Gilles Peskinec8000c02019-08-02 20:15:51 +02001564 if( psa_key_slot_is_external( slot ) )
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001565 break;
1566#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Steven Cooremana01795d2020-07-24 22:48:15 +02001567 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001568 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001569
Steven Cooreman4fed4552020-08-03 14:46:03 +02001570 status = psa_load_rsa_representation( slot->attr.type,
1571 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02001572 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02001573 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001574 if( status != PSA_SUCCESS )
1575 break;
1576
Steven Cooremana2371e52020-07-28 14:30:39 +02001577 status = psa_get_rsa_public_exponent( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02001578 attributes );
Steven Cooremana2371e52020-07-28 14:30:39 +02001579 mbedtls_rsa_free( rsa );
1580 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001581 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001582 break;
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001583#endif /* MBEDTLS_RSA_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001584 default:
1585 /* Nothing else to do. */
1586 break;
1587 }
1588
1589 if( status != PSA_SUCCESS )
1590 psa_reset_key_attributes( attributes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001591
1592 decrement_status = psa_decrement_key_slot_access_count( slot );
1593
1594 return( ( status == PSA_SUCCESS ) ? decrement_status : status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001595}
1596
Gilles Peskinec8000c02019-08-02 20:15:51 +02001597#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1598psa_status_t psa_get_key_slot_number(
1599 const psa_key_attributes_t *attributes,
1600 psa_key_slot_number_t *slot_number )
1601{
1602 if( attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER )
1603 {
1604 *slot_number = attributes->slot_number;
1605 return( PSA_SUCCESS );
1606 }
1607 else
1608 return( PSA_ERROR_INVALID_ARGUMENT );
1609}
1610#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1611
Steven Cooremana01795d2020-07-24 22:48:15 +02001612static psa_status_t psa_internal_export_key_buffer( const psa_key_slot_t *slot,
1613 uint8_t *data,
1614 size_t data_size,
1615 size_t *data_length )
1616{
1617 if( slot->data.key.bytes > data_size )
1618 return( PSA_ERROR_BUFFER_TOO_SMALL );
1619 memcpy( data, slot->data.key.data, slot->data.key.bytes );
1620 memset( data + slot->data.key.bytes, 0,
1621 data_size - slot->data.key.bytes );
1622 *data_length = slot->data.key.bytes;
1623 return( PSA_SUCCESS );
1624}
1625
Gilles Peskinef603c712019-01-19 13:40:11 +01001626static psa_status_t psa_internal_export_key( const psa_key_slot_t *slot,
1627 uint8_t *data,
1628 size_t data_size,
1629 size_t *data_length,
1630 int export_public_key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001631{
Gilles Peskine5d309672019-07-12 23:47:28 +02001632#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1633 const psa_drv_se_t *drv;
1634 psa_drv_se_context_t *drv_context;
1635#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1636
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001637 *data_length = 0;
1638
Gilles Peskine8e338702019-07-30 20:06:31 +02001639 if( export_public_key && ! PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
Moran Pekera998bc62018-04-16 18:16:20 +03001640 return( PSA_ERROR_INVALID_ARGUMENT );
mohammad160306e79202018-03-28 13:17:44 +03001641
Gilles Peskinef9168942019-09-12 19:20:29 +02001642 /* Reject a zero-length output buffer now, since this can never be a
1643 * valid key representation. This way we know that data must be a valid
1644 * pointer and we can do things like memset(data, ..., data_size). */
1645 if( data_size == 0 )
1646 return( PSA_ERROR_BUFFER_TOO_SMALL );
1647
Gilles Peskine5d309672019-07-12 23:47:28 +02001648#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001649 if( psa_get_se_driver( slot->attr.lifetime, &drv, &drv_context ) )
Gilles Peskine5d309672019-07-12 23:47:28 +02001650 {
1651 psa_drv_se_export_key_t method;
1652 if( drv->key_management == NULL )
1653 return( PSA_ERROR_NOT_SUPPORTED );
1654 method = ( export_public_key ?
1655 drv->key_management->p_export_public :
1656 drv->key_management->p_export );
1657 if( method == NULL )
1658 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine2e0f3882019-07-25 11:34:33 +02001659 return( method( drv_context,
1660 slot->data.se.slot_number,
1661 data, data_size, data_length ) );
Gilles Peskine5d309672019-07-12 23:47:28 +02001662 }
1663#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1664
Gilles Peskine8e338702019-07-30 20:06:31 +02001665 if( key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001666 {
Steven Cooremanacda8342020-07-24 23:09:52 +02001667 return( psa_internal_export_key_buffer( slot, data, data_size, data_length ) );
Gilles Peskine188c71e2018-10-29 19:26:02 +01001668 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001669 else if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) ||
1670 PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
Moran Peker17e36e12018-05-02 12:55:20 +03001671 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001672 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Gilles Peskine969ac722018-01-28 18:16:59 +01001673 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001674 /* Exporting public -> public */
1675 return( psa_internal_export_key_buffer( slot, data, data_size, data_length ) );
1676 }
1677 else if( !export_public_key )
1678 {
1679 /* Exporting private -> private */
1680 return( psa_internal_export_key_buffer( slot, data, data_size, data_length ) );
1681 }
1682 /* Need to export the public part of a private key,
1683 * so conversion is needed */
1684 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
1685 {
Darryl Green9e2d7a02018-07-24 16:33:30 +01001686#if defined(MBEDTLS_RSA_C)
Steven Cooremana2371e52020-07-28 14:30:39 +02001687 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman7f391872020-07-30 14:57:44 +02001688 psa_status_t status = psa_load_rsa_representation(
Steven Cooreman4fed4552020-08-03 14:46:03 +02001689 slot->attr.type,
Steven Cooreman7f391872020-07-30 14:57:44 +02001690 slot->data.key.data,
1691 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02001692 &rsa );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001693 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001694 return( status );
Steven Cooremana01795d2020-07-24 22:48:15 +02001695
Steven Cooreman560c28a2020-07-24 23:20:24 +02001696 status = psa_export_rsa_key( PSA_KEY_TYPE_RSA_PUBLIC_KEY,
Steven Cooremana2371e52020-07-28 14:30:39 +02001697 rsa,
Steven Cooreman560c28a2020-07-24 23:20:24 +02001698 data,
1699 data_size,
1700 data_length );
Steven Cooremana01795d2020-07-24 22:48:15 +02001701
Steven Cooremana2371e52020-07-28 14:30:39 +02001702 mbedtls_rsa_free( rsa );
1703 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001704
Steven Cooreman560c28a2020-07-24 23:20:24 +02001705 return( status );
Darryl Green9e2d7a02018-07-24 16:33:30 +01001706#else
Steven Cooreman560c28a2020-07-24 23:20:24 +02001707 /* We don't know how to convert a private RSA key to public. */
1708 return( PSA_ERROR_NOT_SUPPORTED );
Darryl Green9e2d7a02018-07-24 16:33:30 +01001709#endif
Gilles Peskine969ac722018-01-28 18:16:59 +01001710 }
1711 else
Moran Pekera998bc62018-04-16 18:16:20 +03001712 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001713#if defined(MBEDTLS_ECP_C)
Steven Cooremana2371e52020-07-28 14:30:39 +02001714 mbedtls_ecp_keypair *ecp = NULL;
Steven Cooreman7f391872020-07-30 14:57:44 +02001715 psa_status_t status = psa_load_ecp_representation(
Steven Cooreman4fed4552020-08-03 14:46:03 +02001716 slot->attr.type,
Steven Cooreman7f391872020-07-30 14:57:44 +02001717 slot->data.key.data,
1718 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02001719 &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
1723 status = psa_export_ecp_key( PSA_KEY_TYPE_ECC_PUBLIC_KEY(
1724 PSA_KEY_TYPE_ECC_GET_FAMILY(
1725 slot->attr.type ) ),
Steven Cooremana2371e52020-07-28 14:30:39 +02001726 ecp,
Steven Cooreman560c28a2020-07-24 23:20:24 +02001727 data,
1728 data_size,
1729 data_length );
1730
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 );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001737#endif
Moran Pekera998bc62018-04-16 18:16:20 +03001738 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001739 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001740 else
1741 {
1742 /* This shouldn't happen in the reference implementation, but
1743 it is valid for a special-purpose implementation to omit
1744 support for exporting certain key types. */
1745 return( PSA_ERROR_NOT_SUPPORTED );
1746 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001747}
1748
Ronald Croncf56a0a2020-08-04 09:51:30 +02001749psa_status_t psa_export_key( mbedtls_svc_key_id_t key,
Gilles Peskine2d277862018-06-18 15:41:12 +02001750 uint8_t *data,
1751 size_t data_size,
1752 size_t *data_length )
Moran Pekera998bc62018-04-16 18:16:20 +03001753{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001754 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1755 psa_status_t decrement_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001756 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001757
1758 /* Set the key to empty now, so that even when there are errors, we always
1759 * set data_length to a value between 0 and data_size. On error, setting
1760 * the key to empty is a good choice because an empty key representation is
1761 * unlikely to be accepted anywhere. */
1762 *data_length = 0;
1763
1764 /* Export requires the EXPORT flag. There is an exception for public keys,
1765 * which don't require any flag, but psa_get_key_from_slot takes
1766 * care of this. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001767 status = psa_get_key_from_slot( key, &slot, PSA_KEY_USAGE_EXPORT, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001768 if( status != PSA_SUCCESS )
1769 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001770
1771 status = psa_internal_export_key( slot, data, data_size, data_length, 0 );
1772 decrement_status = psa_decrement_key_slot_access_count( slot );
1773
1774 return( ( status == PSA_SUCCESS ) ? decrement_status : status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001775}
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001776
Ronald Croncf56a0a2020-08-04 09:51:30 +02001777psa_status_t psa_export_public_key( mbedtls_svc_key_id_t key,
Gilles Peskine2d277862018-06-18 15:41:12 +02001778 uint8_t *data,
1779 size_t data_size,
1780 size_t *data_length )
Moran Pekerdd4ea382018-04-03 15:30:03 +03001781{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001782 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1783 psa_status_t decrement_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001784 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001785
1786 /* Set the key to empty now, so that even when there are errors, we always
1787 * set data_length to a value between 0 and data_size. On error, setting
1788 * the key to empty is a good choice because an empty key representation is
1789 * unlikely to be accepted anywhere. */
1790 *data_length = 0;
1791
1792 /* Exporting a public key doesn't require a usage flag. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001793 status = psa_get_key_from_slot( key, &slot, 0, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001794 if( status != PSA_SUCCESS )
1795 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001796
1797 status = psa_internal_export_key( slot, data, data_size, data_length, 1 );
1798 decrement_status = psa_decrement_key_slot_access_count( slot );
1799
1800 return( ( status == PSA_SUCCESS ) ? decrement_status : status );
Moran Pekerdd4ea382018-04-03 15:30:03 +03001801}
1802
Gilles Peskine91e8c332019-08-02 19:19:39 +02001803#if defined(static_assert)
1804static_assert( ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
1805 "One or more key attribute flag is listed as both external-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001806static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
Gilles Peskine094dac12019-08-07 18:19:46 +02001807 "One or more key attribute flag is listed as both internal-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001808static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY ) == 0,
Gilles Peskine91e8c332019-08-02 19:19:39 +02001809 "One or more key attribute flag is listed as both internal-only and external-only" );
1810#endif
1811
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001812/** Validate that a key policy is internally well-formed.
1813 *
1814 * This function only rejects invalid policies. It does not validate the
1815 * consistency of the policy with respect to other attributes of the key
1816 * such as the key type.
1817 */
1818static psa_status_t psa_validate_key_policy( const psa_key_policy_t *policy )
Gilles Peskine4747d192019-04-17 15:05:45 +02001819{
1820 if( ( policy->usage & ~( PSA_KEY_USAGE_EXPORT |
Gilles Peskine8e0206a2019-05-14 14:24:28 +02001821 PSA_KEY_USAGE_COPY |
Gilles Peskine4747d192019-04-17 15:05:45 +02001822 PSA_KEY_USAGE_ENCRYPT |
1823 PSA_KEY_USAGE_DECRYPT |
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001824 PSA_KEY_USAGE_SIGN_HASH |
1825 PSA_KEY_USAGE_VERIFY_HASH |
Gilles Peskine4747d192019-04-17 15:05:45 +02001826 PSA_KEY_USAGE_DERIVE ) ) != 0 )
1827 return( PSA_ERROR_INVALID_ARGUMENT );
1828
Gilles Peskine4747d192019-04-17 15:05:45 +02001829 return( PSA_SUCCESS );
1830}
1831
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001832/** Validate the internal consistency of key attributes.
1833 *
1834 * This function only rejects invalid attribute values. If does not
1835 * validate the consistency of the attributes with any key data that may
1836 * be involved in the creation of the key.
1837 *
1838 * Call this function early in the key creation process.
1839 *
1840 * \param[in] attributes Key attributes for the new key.
1841 * \param[out] p_drv On any return, the driver for the key, if any.
1842 * NULL for a transparent key.
1843 *
1844 */
1845static psa_status_t psa_validate_key_attributes(
1846 const psa_key_attributes_t *attributes,
1847 psa_se_drv_table_entry_t **p_drv )
Darryl Green0c6575a2018-11-07 16:05:30 +00001848{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001849 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Ronald Crond2ed4812020-07-17 16:11:30 +02001850 psa_key_lifetime_t lifetime = psa_get_key_lifetime( attributes );
Ronald Cron65f38a32020-10-23 17:11:13 +02001851 mbedtls_svc_key_id_t key = psa_get_key_id( attributes );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001852
Ronald Cron54b90082020-10-29 15:26:43 +01001853 status = psa_validate_key_location( lifetime, p_drv );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001854 if( status != PSA_SUCCESS )
1855 return( status );
1856
Ronald Crond2ed4812020-07-17 16:11:30 +02001857 status = psa_validate_key_persistence( lifetime );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001858 if( status != PSA_SUCCESS )
1859 return( status );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001860
Ronald Cron65f38a32020-10-23 17:11:13 +02001861 if ( PSA_KEY_LIFETIME_IS_VOLATILE( lifetime ) )
1862 {
1863 if( MBEDTLS_SVC_KEY_ID_GET_KEY_ID( key ) != 0 )
1864 return( PSA_ERROR_INVALID_ARGUMENT );
1865 }
1866 else
Ronald Crond2ed4812020-07-17 16:11:30 +02001867 {
Ronald Croncbd7bea2020-11-11 14:57:44 +01001868 status = psa_validate_key_id( psa_get_key_id( attributes ), 0 );
Ronald Crond2ed4812020-07-17 16:11:30 +02001869 if( status != PSA_SUCCESS )
1870 return( status );
1871 }
1872
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001873 status = psa_validate_key_policy( &attributes->core.policy );
Darryl Green0c6575a2018-11-07 16:05:30 +00001874 if( status != PSA_SUCCESS )
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001875 return( status );
1876
1877 /* Refuse to create overly large keys.
1878 * Note that this doesn't trigger on import if the attributes don't
1879 * explicitly specify a size (so psa_get_key_bits returns 0), so
1880 * psa_import_key() needs its own checks. */
1881 if( psa_get_key_bits( attributes ) > PSA_MAX_KEY_BITS )
1882 return( PSA_ERROR_NOT_SUPPORTED );
1883
Gilles Peskine91e8c332019-08-02 19:19:39 +02001884 /* Reject invalid flags. These should not be reachable through the API. */
1885 if( attributes->core.flags & ~ ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1886 MBEDTLS_PSA_KA_MASK_DUAL_USE ) )
1887 return( PSA_ERROR_INVALID_ARGUMENT );
1888
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001889 return( PSA_SUCCESS );
1890}
1891
Gilles Peskine4747d192019-04-17 15:05:45 +02001892/** Prepare a key slot to receive key material.
1893 *
1894 * This function allocates a key slot and sets its metadata.
1895 *
1896 * If this function fails, call psa_fail_key_creation().
1897 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001898 * This function is intended to be used as follows:
1899 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001900 * it with the specified attributes, and in case of a volatile key assign it
1901 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001902 * -# Populate the slot with the key material.
1903 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1904 * In case of failure at any step, stop the sequence and call
1905 * psa_fail_key_creation().
1906 *
Ronald Cronf95a2b12020-10-22 15:24:49 +02001907 * On success, the access counter of the returned key slot is incremented by
1908 * one. It is the responsibility of the caller to call
1909 * psa_decrement_key_slot_access_count() when it does not access the key slot
1910 * anymore.
1911 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001912 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001913 * \param[in] attributes Key attributes for the new key.
Ronald Cron3c76a422020-10-16 12:17:04 +02001914 * \param[out] key On success, identifier of the key. Note that the
1915 * key identifier is also stored in the prepared
1916 * slot.
Gilles Peskine011e4282019-06-26 18:34:38 +02001917 * \param[out] p_slot On success, a pointer to the prepared slot.
1918 * \param[out] p_drv On any return, the driver for the key, if any.
1919 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001920 *
1921 * \retval #PSA_SUCCESS
1922 * The key slot is ready to receive key material.
1923 * \return If this function fails, the key slot is an invalid state.
1924 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001925 */
1926static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001927 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001928 const psa_key_attributes_t *attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02001929 mbedtls_svc_key_id_t *key,
Gilles Peskine011e4282019-06-26 18:34:38 +02001930 psa_key_slot_t **p_slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001931 psa_se_drv_table_entry_t **p_drv )
Gilles Peskine4747d192019-04-17 15:05:45 +02001932{
1933 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001934 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001935 psa_key_slot_t *slot;
1936
Gilles Peskinedf179142019-07-15 22:02:14 +02001937 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001938 *p_drv = NULL;
1939
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001940 status = psa_validate_key_attributes( attributes, p_drv );
1941 if( status != PSA_SUCCESS )
1942 return( status );
1943
Ronald Cronc4d1b512020-07-31 11:26:37 +02001944 status = psa_get_empty_key_slot( &volatile_key_id, p_slot );
Gilles Peskine4747d192019-04-17 15:05:45 +02001945 if( status != PSA_SUCCESS )
1946 return( status );
1947 slot = *p_slot;
1948
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001949 /* We're storing the declared bit-size of the key. It's up to each
1950 * creation mechanism to verify that this information is correct.
1951 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001952 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001953 * is optional (import, copy). In case of a volatile key, assign it the
1954 * volatile key identifier associated to the slot returned to contain its
1955 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001956
1957 slot->attr = attributes->core;
Ronald Cronc4d1b512020-07-31 11:26:37 +02001958 if( PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
1959 {
1960#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1961 slot->attr.id = volatile_key_id;
1962#else
1963 slot->attr.id.key_id = volatile_key_id;
1964#endif
1965 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001966
Gilles Peskine91e8c332019-08-02 19:19:39 +02001967 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001968 * external-only flags, query `attributes`. Thanks to the check
1969 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001970 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001971 * may have set. */
1972 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001973
Gilles Peskinecbaff462019-07-12 23:46:04 +02001974#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001975 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001976 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001977 * create the key file in internal storage, create the
1978 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001979 * persistent data. This is done by starting a transaction that will
1980 * encompass these three actions.
1981 * For registering a volatile key, we just need to find an appropriate
1982 * slot number inside the SE. Since the key is designated volatile, creating
1983 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001984 /* The first thing to do is to find a slot number for the new key.
1985 * We save the slot number in persistent storage as part of the
1986 * transaction data. It will be needed to recover if the power
1987 * fails during the key creation process, to clean up on the secure
1988 * element side after restarting. Obtaining a slot number from the
1989 * secure element driver updates its persistent state, but we do not yet
1990 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001991 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001992 if( *p_drv != NULL )
Darryl Green0c6575a2018-11-07 16:05:30 +00001993 {
Gilles Peskinee88c2c12019-08-05 16:44:14 +02001994 status = psa_find_se_slot_for_key( attributes, method, *p_drv,
Gilles Peskinecbaff462019-07-12 23:46:04 +02001995 &slot->data.se.slot_number );
1996 if( status != PSA_SUCCESS )
1997 return( status );
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001998
1999 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( attributes->core.lifetime ) )
Gilles Peskine66be51c2019-07-25 18:02:52 +02002000 {
Steven Cooremanbbeaf182020-06-08 18:29:44 +02002001 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_CREATE_KEY );
2002 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
2003 psa_crypto_transaction.key.slot = slot->data.se.slot_number;
2004 psa_crypto_transaction.key.id = slot->attr.id;
2005 status = psa_crypto_save_transaction( );
2006 if( status != PSA_SUCCESS )
2007 {
2008 (void) psa_crypto_stop_transaction( );
2009 return( status );
2010 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02002011 }
Darryl Green0c6575a2018-11-07 16:05:30 +00002012 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02002013
2014 if( *p_drv == NULL && method == PSA_KEY_CREATION_REGISTER )
2015 {
2016 /* Key registration only makes sense with a secure element. */
2017 return( PSA_ERROR_INVALID_ARGUMENT );
2018 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02002019#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2020
Ronald Croncf56a0a2020-08-04 09:51:30 +02002021 *key = slot->attr.id;
Ronald Cronc4d1b512020-07-31 11:26:37 +02002022 return( PSA_SUCCESS );
Darryl Green0c6575a2018-11-07 16:05:30 +00002023}
Gilles Peskine4747d192019-04-17 15:05:45 +02002024
2025/** Finalize the creation of a key once its key material has been set.
2026 *
2027 * This entails writing the key to persistent storage.
2028 *
2029 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02002030 * See the documentation of psa_start_key_creation() for the intended use
2031 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02002032 *
Gilles Peskine011e4282019-06-26 18:34:38 +02002033 * \param[in,out] slot Pointer to the slot with key material.
2034 * \param[in] driver The secure element driver for the key,
2035 * or NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02002036 *
2037 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02002038 * The key was successfully created.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02002039 * \return If this function fails, the key slot is an invalid state.
2040 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02002041 */
Gilles Peskine011e4282019-06-26 18:34:38 +02002042static psa_status_t psa_finish_key_creation(
2043 psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002044 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02002045{
2046 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02002047 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02002048 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02002049
2050#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Steven Cooremanc59de6a2020-06-08 18:28:25 +02002051 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Gilles Peskine4747d192019-04-17 15:05:45 +02002052 {
Gilles Peskine1df83d42019-07-23 16:13:14 +02002053#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2054 if( driver != NULL )
2055 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02002056 psa_se_key_data_storage_t data;
2057#if defined(static_assert)
2058 static_assert( sizeof( slot->data.se.slot_number ) ==
2059 sizeof( data.slot_number ),
2060 "Slot number size does not match psa_se_key_data_storage_t" );
Gilles Peskineb46bef22019-07-30 21:32:04 +02002061#endif
2062 memcpy( &data.slot_number, &slot->data.se.slot_number,
2063 sizeof( slot->data.se.slot_number ) );
Gilles Peskine76aa09c2019-07-31 14:15:34 +02002064 status = psa_save_persistent_key( &slot->attr,
Gilles Peskineb46bef22019-07-30 21:32:04 +02002065 (uint8_t*) &data,
2066 sizeof( data ) );
Gilles Peskine1df83d42019-07-23 16:13:14 +02002067 }
2068 else
2069#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2070 {
Steven Cooreman40120f62020-10-29 11:42:22 +01002071 /* Key material is saved in export representation in the slot, so
2072 * just pass the slot buffer for storage. */
2073 status = psa_save_persistent_key( &slot->attr,
2074 slot->data.key.data,
2075 slot->data.key.bytes );
Gilles Peskine1df83d42019-07-23 16:13:14 +02002076 }
Gilles Peskine4747d192019-04-17 15:05:45 +02002077 }
Darryl Green0c6575a2018-11-07 16:05:30 +00002078#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
2079
Gilles Peskinecbaff462019-07-12 23:46:04 +02002080#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02002081 /* Finish the transaction for a key creation. This does not
2082 * happen when registering an existing key. Detect this case
2083 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02002084 * creation of a persistent key in a secure element requires a transaction,
2085 * but registration or volatile key creation doesn't use one). */
Gilles Peskined7729582019-08-05 15:55:54 +02002086 if( driver != NULL &&
2087 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY )
Gilles Peskinecbaff462019-07-12 23:46:04 +02002088 {
2089 status = psa_save_se_persistent_data( driver );
2090 if( status != PSA_SUCCESS )
2091 {
Gilles Peskine8e338702019-07-30 20:06:31 +02002092 psa_destroy_persistent_key( slot->attr.id );
Gilles Peskinecbaff462019-07-12 23:46:04 +02002093 return( status );
2094 }
Gilles Peskinefc762652019-07-22 19:30:34 +02002095 status = psa_crypto_stop_transaction( );
2096 if( status != PSA_SUCCESS )
2097 return( status );
Gilles Peskinecbaff462019-07-12 23:46:04 +02002098 }
2099#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2100
Gilles Peskine4747d192019-04-17 15:05:45 +02002101 return( status );
2102}
2103
2104/** Abort the creation of a key.
2105 *
2106 * You may call this function after calling psa_start_key_creation(),
2107 * or after psa_finish_key_creation() fails. In other circumstances, this
2108 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02002109 * See the documentation of psa_start_key_creation() for the intended use
2110 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02002111 *
Gilles Peskine011e4282019-06-26 18:34:38 +02002112 * \param[in,out] slot Pointer to the slot with key material.
2113 * \param[in] driver The secure element driver for the key,
2114 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02002115 */
Gilles Peskine011e4282019-06-26 18:34:38 +02002116static void psa_fail_key_creation( psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002117 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02002118{
Gilles Peskine011e4282019-06-26 18:34:38 +02002119 (void) driver;
2120
Gilles Peskine4747d192019-04-17 15:05:45 +02002121 if( slot == NULL )
2122 return;
Gilles Peskine011e4282019-06-26 18:34:38 +02002123
2124#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01002125 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02002126 * element, and the failure happened later (when saving metadata
2127 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02002128 * element.
2129 * https://github.com/ARMmbed/mbed-crypto/issues/217
2130 */
Gilles Peskinefc762652019-07-22 19:30:34 +02002131
Gilles Peskined7729582019-08-05 15:55:54 +02002132 /* Abort the ongoing transaction if any (there may not be one if
2133 * the creation process failed before starting one, or if the
2134 * key creation is a registration of a key in a secure element).
2135 * Earlier functions must already have done what it takes to undo any
2136 * partial creation. All that's left is to update the transaction data
2137 * itself. */
Gilles Peskinefc762652019-07-22 19:30:34 +02002138 (void) psa_crypto_stop_transaction( );
Gilles Peskine011e4282019-06-26 18:34:38 +02002139#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2140
Gilles Peskine4747d192019-04-17 15:05:45 +02002141 psa_wipe_key_slot( slot );
2142}
2143
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002144/** Validate optional attributes during key creation.
2145 *
2146 * Some key attributes are optional during key creation. If they are
2147 * specified in the attributes structure, check that they are consistent
2148 * with the data in the slot.
2149 *
2150 * This function should be called near the end of key creation, after
2151 * the slot in memory is fully populated but before saving persistent data.
2152 */
2153static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002154 const psa_key_slot_t *slot,
2155 const psa_key_attributes_t *attributes )
2156{
Gilles Peskine7e0cff92019-07-30 13:48:52 +02002157 if( attributes->core.type != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002158 {
Gilles Peskine8e338702019-07-30 20:06:31 +02002159 if( attributes->core.type != slot->attr.type )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002160 return( PSA_ERROR_INVALID_ARGUMENT );
2161 }
2162
2163 if( attributes->domain_parameters_size != 0 )
2164 {
2165#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02002166 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002167 {
Steven Cooremana2371e52020-07-28 14:30:39 +02002168 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02002169 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02002170 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02002171
Steven Cooreman7f391872020-07-30 14:57:44 +02002172 psa_status_t status = psa_load_rsa_representation(
Steven Cooreman4fed4552020-08-03 14:46:03 +02002173 slot->attr.type,
Steven Cooreman7f391872020-07-30 14:57:44 +02002174 slot->data.key.data,
2175 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02002176 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02002177 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02002178 return( status );
Steven Cooreman75b74362020-07-28 14:30:13 +02002179
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002180 mbedtls_mpi_init( &actual );
2181 mbedtls_mpi_init( &required );
Steven Cooremana2371e52020-07-28 14:30:39 +02002182 ret = mbedtls_rsa_export( rsa,
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002183 NULL, NULL, NULL, NULL, &actual );
Steven Cooremana2371e52020-07-28 14:30:39 +02002184 mbedtls_rsa_free( rsa );
2185 mbedtls_free( rsa );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002186 if( ret != 0 )
2187 goto rsa_exit;
2188 ret = mbedtls_mpi_read_binary( &required,
2189 attributes->domain_parameters,
2190 attributes->domain_parameters_size );
2191 if( ret != 0 )
2192 goto rsa_exit;
2193 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
2194 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
2195 rsa_exit:
2196 mbedtls_mpi_free( &actual );
2197 mbedtls_mpi_free( &required );
2198 if( ret != 0)
2199 return( mbedtls_to_psa_error( ret ) );
2200 }
2201 else
2202#endif
2203 {
2204 return( PSA_ERROR_INVALID_ARGUMENT );
2205 }
2206 }
2207
Gilles Peskine7e0cff92019-07-30 13:48:52 +02002208 if( attributes->core.bits != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002209 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02002210 if( attributes->core.bits != slot->attr.bits )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002211 return( PSA_ERROR_INVALID_ARGUMENT );
2212 }
2213
2214 return( PSA_SUCCESS );
2215}
2216
Gilles Peskine4747d192019-04-17 15:05:45 +02002217psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02002218 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02002219 size_t data_length,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002220 mbedtls_svc_key_id_t *key )
Gilles Peskine4747d192019-04-17 15:05:45 +02002221{
2222 psa_status_t status;
2223 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002224 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002225
Gilles Peskine0f84d622019-09-12 19:03:13 +02002226 /* Reject zero-length symmetric keys (including raw data key objects).
2227 * This also rejects any key which might be encoded as an empty string,
2228 * which is never valid. */
2229 if( data_length == 0 )
2230 return( PSA_ERROR_INVALID_ARGUMENT );
2231
Gilles Peskinedf179142019-07-15 22:02:14 +02002232 status = psa_start_key_creation( PSA_KEY_CREATION_IMPORT, attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002233 key, &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002234 if( status != PSA_SUCCESS )
2235 goto exit;
2236
Gilles Peskine5d309672019-07-12 23:47:28 +02002237#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2238 if( driver != NULL )
2239 {
2240 const psa_drv_se_t *drv = psa_get_se_driver_methods( driver );
Darryl Green0892d0f2019-08-20 09:50:14 +01002241 /* The driver should set the number of key bits, however in
2242 * case it doesn't, we initialize bits to an invalid value. */
2243 size_t bits = PSA_MAX_KEY_BITS + 1;
Gilles Peskine5d309672019-07-12 23:47:28 +02002244 if( drv->key_management == NULL ||
2245 drv->key_management->p_import == NULL )
2246 {
2247 status = PSA_ERROR_NOT_SUPPORTED;
2248 goto exit;
2249 }
2250 status = drv->key_management->p_import(
2251 psa_get_se_driver_context( driver ),
Gilles Peskinef3801ff2019-08-06 17:32:04 +02002252 slot->data.se.slot_number, attributes, data, data_length,
Gilles Peskineb46bef22019-07-30 21:32:04 +02002253 &bits );
2254 if( status != PSA_SUCCESS )
2255 goto exit;
2256 if( bits > PSA_MAX_KEY_BITS )
2257 {
2258 status = PSA_ERROR_NOT_SUPPORTED;
2259 goto exit;
2260 }
2261 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskine5d309672019-07-12 23:47:28 +02002262 }
2263 else
2264#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2265 {
2266 status = psa_import_key_into_slot( slot, data, data_length );
2267 if( status != PSA_SUCCESS )
2268 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02002269 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002270 status = psa_validate_optional_attributes( slot, attributes );
Gilles Peskine18017402019-07-24 20:25:59 +02002271 if( status != PSA_SUCCESS )
2272 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002273
Gilles Peskine011e4282019-06-26 18:34:38 +02002274 status = psa_finish_key_creation( slot, driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002275exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02002276 if( status != PSA_SUCCESS )
2277 {
Gilles Peskine011e4282019-06-26 18:34:38 +02002278 psa_fail_key_creation( slot, driver );
Ronald Croncf56a0a2020-08-04 09:51:30 +02002279 *key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine4747d192019-04-17 15:05:45 +02002280 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002281 else
2282 status = psa_decrement_key_slot_access_count( slot );
2283
Gilles Peskine4747d192019-04-17 15:05:45 +02002284 return( status );
2285}
2286
Gilles Peskined7729582019-08-05 15:55:54 +02002287#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2288psa_status_t mbedtls_psa_register_se_key(
2289 const psa_key_attributes_t *attributes )
2290{
2291 psa_status_t status;
2292 psa_key_slot_t *slot = NULL;
2293 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02002294 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02002295
2296 /* Leaving attributes unspecified is not currently supported.
2297 * It could make sense to query the key type and size from the
2298 * secure element, but not all secure elements support this
2299 * and the driver HAL doesn't currently support it. */
2300 if( psa_get_key_type( attributes ) == PSA_KEY_TYPE_NONE )
2301 return( PSA_ERROR_NOT_SUPPORTED );
2302 if( psa_get_key_bits( attributes ) == 0 )
2303 return( PSA_ERROR_NOT_SUPPORTED );
2304
2305 status = psa_start_key_creation( PSA_KEY_CREATION_REGISTER, attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002306 &key, &slot, &driver );
Gilles Peskined7729582019-08-05 15:55:54 +02002307 if( status != PSA_SUCCESS )
2308 goto exit;
2309
Gilles Peskined7729582019-08-05 15:55:54 +02002310 status = psa_finish_key_creation( slot, driver );
2311
2312exit:
2313 if( status != PSA_SUCCESS )
Gilles Peskined7729582019-08-05 15:55:54 +02002314 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002315 else
2316 status = psa_decrement_key_slot_access_count( slot );
2317
Gilles Peskined7729582019-08-05 15:55:54 +02002318 /* Registration doesn't keep the key in RAM. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02002319 psa_close_key( key );
Gilles Peskined7729582019-08-05 15:55:54 +02002320 return( status );
2321}
2322#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2323
Gilles Peskinef603c712019-01-19 13:40:11 +01002324static psa_status_t psa_copy_key_material( const psa_key_slot_t *source,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002325 psa_key_slot_t *target )
Gilles Peskinef603c712019-01-19 13:40:11 +01002326{
Steven Cooremanf7cebd42020-10-13 20:27:40 +02002327 psa_status_t status = psa_copy_key_material_into_slot( target,
2328 source->data.key.data,
2329 source->data.key.bytes );
Gilles Peskinef603c712019-01-19 13:40:11 +01002330 if( status != PSA_SUCCESS )
Steven Cooreman398aee52020-10-13 14:35:45 +02002331 return( status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002332
Steven Cooreman398aee52020-10-13 14:35:45 +02002333 target->attr.type = source->attr.type;
2334 target->attr.bits = source->attr.bits;
2335
2336 return( PSA_SUCCESS );
Gilles Peskinef603c712019-01-19 13:40:11 +01002337}
2338
Ronald Croncf56a0a2020-08-04 09:51:30 +02002339psa_status_t psa_copy_key( mbedtls_svc_key_id_t source_key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002340 const psa_key_attributes_t *specified_attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002341 mbedtls_svc_key_id_t *target_key )
Gilles Peskinef603c712019-01-19 13:40:11 +01002342{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002343 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2344 psa_status_t decrement_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002345 psa_key_slot_t *source_slot = NULL;
2346 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002347 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002348 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskinef603c712019-01-19 13:40:11 +01002349
Ronald Croncf56a0a2020-08-04 09:51:30 +02002350 status = psa_get_transparent_key( source_key, &source_slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02002351 PSA_KEY_USAGE_COPY, 0 );
Gilles Peskinef603c712019-01-19 13:40:11 +01002352 if( status != PSA_SUCCESS )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002353 goto exit;
2354
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002355 status = psa_validate_optional_attributes( source_slot,
2356 specified_attributes );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002357 if( status != PSA_SUCCESS )
2358 goto exit;
2359
Gilles Peskine7e0cff92019-07-30 13:48:52 +02002360 status = psa_restrict_key_policy( &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02002361 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002362 if( status != PSA_SUCCESS )
2363 goto exit;
2364
Gilles Peskinedf179142019-07-15 22:02:14 +02002365 status = psa_start_key_creation( PSA_KEY_CREATION_COPY,
2366 &actual_attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002367 target_key, &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002368 if( status != PSA_SUCCESS )
2369 goto exit;
2370
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002371#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2372 if( driver != NULL )
Gilles Peskinef603c712019-01-19 13:40:11 +01002373 {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002374 /* Copying to a secure element is not implemented yet. */
2375 status = PSA_ERROR_NOT_SUPPORTED;
2376 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002377 }
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002378#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef603c712019-01-19 13:40:11 +01002379
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002380 status = psa_copy_key_material( source_slot, target_slot );
Gilles Peskinef603c712019-01-19 13:40:11 +01002381 if( status != PSA_SUCCESS )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002382 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002383
Gilles Peskine011e4282019-06-26 18:34:38 +02002384 status = psa_finish_key_creation( target_slot, driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002385exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002386 if( status != PSA_SUCCESS )
2387 {
Gilles Peskine011e4282019-06-26 18:34:38 +02002388 psa_fail_key_creation( target_slot, driver );
Ronald Croncf56a0a2020-08-04 09:51:30 +02002389 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002390 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002391 else
2392 status = psa_decrement_key_slot_access_count( target_slot );
2393
2394 decrement_status = psa_decrement_key_slot_access_count( source_slot );
2395
2396 return( ( status == PSA_SUCCESS ) ? decrement_status : status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002397}
2398
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002399
2400
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002401/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002402/* Message digests */
2403/****************************************************************/
2404
John Durkop0ea39e02020-10-13 19:58:20 -07002405#if defined(MBEDTLS_RSA_C) || defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinedc2fc842018-03-07 16:42:59 +01002406static const mbedtls_md_info_t *mbedtls_md_info_from_psa( psa_algorithm_t alg )
Gilles Peskine20035e32018-02-03 22:44:14 +01002407{
2408 switch( alg )
2409 {
2410#if defined(MBEDTLS_MD2_C)
2411 case PSA_ALG_MD2:
2412 return( &mbedtls_md2_info );
2413#endif
2414#if defined(MBEDTLS_MD4_C)
2415 case PSA_ALG_MD4:
2416 return( &mbedtls_md4_info );
2417#endif
2418#if defined(MBEDTLS_MD5_C)
2419 case PSA_ALG_MD5:
2420 return( &mbedtls_md5_info );
2421#endif
2422#if defined(MBEDTLS_RIPEMD160_C)
2423 case PSA_ALG_RIPEMD160:
2424 return( &mbedtls_ripemd160_info );
2425#endif
2426#if defined(MBEDTLS_SHA1_C)
2427 case PSA_ALG_SHA_1:
2428 return( &mbedtls_sha1_info );
2429#endif
2430#if defined(MBEDTLS_SHA256_C)
2431 case PSA_ALG_SHA_224:
2432 return( &mbedtls_sha224_info );
2433 case PSA_ALG_SHA_256:
2434 return( &mbedtls_sha256_info );
2435#endif
2436#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnardd6020842019-07-17 16:28:21 +02002437#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine20035e32018-02-03 22:44:14 +01002438 case PSA_ALG_SHA_384:
2439 return( &mbedtls_sha384_info );
Manuel Pégourié-Gonnardd6020842019-07-17 16:28:21 +02002440#endif
Gilles Peskine20035e32018-02-03 22:44:14 +01002441 case PSA_ALG_SHA_512:
2442 return( &mbedtls_sha512_info );
2443#endif
2444 default:
2445 return( NULL );
2446 }
2447}
John Durkop0ea39e02020-10-13 19:58:20 -07002448#endif /* defined(MBEDTLS_RSA_C) || defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine20035e32018-02-03 22:44:14 +01002449
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002450psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
2451{
2452 switch( operation->alg )
2453 {
Gilles Peskine81736312018-06-26 15:04:31 +02002454 case 0:
2455 /* The object has (apparently) been initialized but it is not
2456 * in use. It's ok to call abort on such an object, and there's
2457 * nothing to do. */
2458 break;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002459#if defined(MBEDTLS_MD2_C)
2460 case PSA_ALG_MD2:
2461 mbedtls_md2_free( &operation->ctx.md2 );
2462 break;
2463#endif
2464#if defined(MBEDTLS_MD4_C)
2465 case PSA_ALG_MD4:
2466 mbedtls_md4_free( &operation->ctx.md4 );
2467 break;
2468#endif
2469#if defined(MBEDTLS_MD5_C)
2470 case PSA_ALG_MD5:
2471 mbedtls_md5_free( &operation->ctx.md5 );
2472 break;
2473#endif
2474#if defined(MBEDTLS_RIPEMD160_C)
2475 case PSA_ALG_RIPEMD160:
2476 mbedtls_ripemd160_free( &operation->ctx.ripemd160 );
2477 break;
2478#endif
2479#if defined(MBEDTLS_SHA1_C)
2480 case PSA_ALG_SHA_1:
2481 mbedtls_sha1_free( &operation->ctx.sha1 );
2482 break;
2483#endif
2484#if defined(MBEDTLS_SHA256_C)
2485 case PSA_ALG_SHA_224:
2486 case PSA_ALG_SHA_256:
2487 mbedtls_sha256_free( &operation->ctx.sha256 );
2488 break;
2489#endif
2490#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002491#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002492 case PSA_ALG_SHA_384:
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002493#endif
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002494 case PSA_ALG_SHA_512:
2495 mbedtls_sha512_free( &operation->ctx.sha512 );
2496 break;
2497#endif
2498 default:
Gilles Peskinef9c2c092018-06-21 16:57:07 +02002499 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002500 }
2501 operation->alg = 0;
2502 return( PSA_SUCCESS );
2503}
2504
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002505psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002506 psa_algorithm_t alg )
2507{
Janos Follath24eed8d2019-11-22 13:21:35 +00002508 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002509
2510 /* A context must be freshly initialized before it can be set up. */
2511 if( operation->alg != 0 )
2512 {
2513 return( PSA_ERROR_BAD_STATE );
2514 }
2515
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002516 switch( alg )
2517 {
2518#if defined(MBEDTLS_MD2_C)
2519 case PSA_ALG_MD2:
2520 mbedtls_md2_init( &operation->ctx.md2 );
2521 ret = mbedtls_md2_starts_ret( &operation->ctx.md2 );
2522 break;
2523#endif
2524#if defined(MBEDTLS_MD4_C)
2525 case PSA_ALG_MD4:
2526 mbedtls_md4_init( &operation->ctx.md4 );
2527 ret = mbedtls_md4_starts_ret( &operation->ctx.md4 );
2528 break;
2529#endif
2530#if defined(MBEDTLS_MD5_C)
2531 case PSA_ALG_MD5:
2532 mbedtls_md5_init( &operation->ctx.md5 );
2533 ret = mbedtls_md5_starts_ret( &operation->ctx.md5 );
2534 break;
2535#endif
2536#if defined(MBEDTLS_RIPEMD160_C)
2537 case PSA_ALG_RIPEMD160:
2538 mbedtls_ripemd160_init( &operation->ctx.ripemd160 );
2539 ret = mbedtls_ripemd160_starts_ret( &operation->ctx.ripemd160 );
2540 break;
2541#endif
2542#if defined(MBEDTLS_SHA1_C)
2543 case PSA_ALG_SHA_1:
2544 mbedtls_sha1_init( &operation->ctx.sha1 );
2545 ret = mbedtls_sha1_starts_ret( &operation->ctx.sha1 );
2546 break;
2547#endif
2548#if defined(MBEDTLS_SHA256_C)
2549 case PSA_ALG_SHA_224:
2550 mbedtls_sha256_init( &operation->ctx.sha256 );
2551 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 1 );
2552 break;
2553 case PSA_ALG_SHA_256:
2554 mbedtls_sha256_init( &operation->ctx.sha256 );
2555 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 0 );
2556 break;
2557#endif
2558#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002559#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002560 case PSA_ALG_SHA_384:
2561 mbedtls_sha512_init( &operation->ctx.sha512 );
2562 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 1 );
2563 break;
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002564#endif
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002565 case PSA_ALG_SHA_512:
2566 mbedtls_sha512_init( &operation->ctx.sha512 );
2567 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 0 );
2568 break;
2569#endif
2570 default:
Gilles Peskinec06e0712018-06-20 16:21:04 +02002571 return( PSA_ALG_IS_HASH( alg ) ?
2572 PSA_ERROR_NOT_SUPPORTED :
2573 PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002574 }
2575 if( ret == 0 )
2576 operation->alg = alg;
2577 else
2578 psa_hash_abort( operation );
2579 return( mbedtls_to_psa_error( ret ) );
2580}
2581
2582psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2583 const uint8_t *input,
2584 size_t input_length )
2585{
Janos Follath24eed8d2019-11-22 13:21:35 +00002586 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine94e44542018-07-12 16:58:43 +02002587
2588 /* Don't require hash implementations to behave correctly on a
2589 * zero-length input, which may have an invalid pointer. */
2590 if( input_length == 0 )
2591 return( PSA_SUCCESS );
2592
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002593 switch( operation->alg )
2594 {
2595#if defined(MBEDTLS_MD2_C)
2596 case PSA_ALG_MD2:
2597 ret = mbedtls_md2_update_ret( &operation->ctx.md2,
2598 input, input_length );
2599 break;
2600#endif
2601#if defined(MBEDTLS_MD4_C)
2602 case PSA_ALG_MD4:
2603 ret = mbedtls_md4_update_ret( &operation->ctx.md4,
2604 input, input_length );
2605 break;
2606#endif
2607#if defined(MBEDTLS_MD5_C)
2608 case PSA_ALG_MD5:
2609 ret = mbedtls_md5_update_ret( &operation->ctx.md5,
2610 input, input_length );
2611 break;
2612#endif
2613#if defined(MBEDTLS_RIPEMD160_C)
2614 case PSA_ALG_RIPEMD160:
2615 ret = mbedtls_ripemd160_update_ret( &operation->ctx.ripemd160,
2616 input, input_length );
2617 break;
2618#endif
2619#if defined(MBEDTLS_SHA1_C)
2620 case PSA_ALG_SHA_1:
2621 ret = mbedtls_sha1_update_ret( &operation->ctx.sha1,
2622 input, input_length );
2623 break;
2624#endif
2625#if defined(MBEDTLS_SHA256_C)
2626 case PSA_ALG_SHA_224:
2627 case PSA_ALG_SHA_256:
2628 ret = mbedtls_sha256_update_ret( &operation->ctx.sha256,
2629 input, input_length );
2630 break;
2631#endif
2632#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002633#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002634 case PSA_ALG_SHA_384:
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002635#endif
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002636 case PSA_ALG_SHA_512:
2637 ret = mbedtls_sha512_update_ret( &operation->ctx.sha512,
2638 input, input_length );
2639 break;
2640#endif
2641 default:
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002642 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002643 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002644
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002645 if( ret != 0 )
2646 psa_hash_abort( operation );
2647 return( mbedtls_to_psa_error( ret ) );
2648}
2649
2650psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2651 uint8_t *hash,
2652 size_t hash_size,
2653 size_t *hash_length )
2654{
itayzafrir40835d42018-08-02 13:14:17 +03002655 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00002656 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine71bb7b72018-04-19 08:29:59 +02002657 size_t actual_hash_length = PSA_HASH_SIZE( operation->alg );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002658
2659 /* Fill the output buffer with something that isn't a valid hash
2660 * (barring an attack on the hash and deliberately-crafted input),
2661 * in case the caller doesn't check the return status properly. */
Gilles Peskineaee13332018-07-02 12:15:28 +02002662 *hash_length = hash_size;
Gilles Peskine46f1fd72018-06-28 19:31:31 +02002663 /* If hash_size is 0 then hash may be NULL and then the
2664 * call to memset would have undefined behavior. */
2665 if( hash_size != 0 )
2666 memset( hash, '!', hash_size );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002667
2668 if( hash_size < actual_hash_length )
itayzafrir40835d42018-08-02 13:14:17 +03002669 {
2670 status = PSA_ERROR_BUFFER_TOO_SMALL;
2671 goto exit;
2672 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002673
2674 switch( operation->alg )
2675 {
2676#if defined(MBEDTLS_MD2_C)
2677 case PSA_ALG_MD2:
2678 ret = mbedtls_md2_finish_ret( &operation->ctx.md2, hash );
2679 break;
2680#endif
2681#if defined(MBEDTLS_MD4_C)
2682 case PSA_ALG_MD4:
2683 ret = mbedtls_md4_finish_ret( &operation->ctx.md4, hash );
2684 break;
2685#endif
2686#if defined(MBEDTLS_MD5_C)
2687 case PSA_ALG_MD5:
2688 ret = mbedtls_md5_finish_ret( &operation->ctx.md5, hash );
2689 break;
2690#endif
2691#if defined(MBEDTLS_RIPEMD160_C)
2692 case PSA_ALG_RIPEMD160:
2693 ret = mbedtls_ripemd160_finish_ret( &operation->ctx.ripemd160, hash );
2694 break;
2695#endif
2696#if defined(MBEDTLS_SHA1_C)
2697 case PSA_ALG_SHA_1:
2698 ret = mbedtls_sha1_finish_ret( &operation->ctx.sha1, hash );
2699 break;
2700#endif
2701#if defined(MBEDTLS_SHA256_C)
2702 case PSA_ALG_SHA_224:
2703 case PSA_ALG_SHA_256:
2704 ret = mbedtls_sha256_finish_ret( &operation->ctx.sha256, hash );
2705 break;
2706#endif
2707#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002708#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002709 case PSA_ALG_SHA_384:
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002710#endif
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002711 case PSA_ALG_SHA_512:
2712 ret = mbedtls_sha512_finish_ret( &operation->ctx.sha512, hash );
2713 break;
2714#endif
2715 default:
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002716 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002717 }
itayzafrir40835d42018-08-02 13:14:17 +03002718 status = mbedtls_to_psa_error( ret );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002719
itayzafrir40835d42018-08-02 13:14:17 +03002720exit:
2721 if( status == PSA_SUCCESS )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002722 {
Gilles Peskineaee13332018-07-02 12:15:28 +02002723 *hash_length = actual_hash_length;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002724 return( psa_hash_abort( operation ) );
2725 }
2726 else
2727 {
2728 psa_hash_abort( operation );
itayzafrir40835d42018-08-02 13:14:17 +03002729 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002730 }
2731}
2732
Gilles Peskine2d277862018-06-18 15:41:12 +02002733psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2734 const uint8_t *hash,
2735 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002736{
2737 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2738 size_t actual_hash_length;
2739 psa_status_t status = psa_hash_finish( operation,
2740 actual_hash, sizeof( actual_hash ),
2741 &actual_hash_length );
2742 if( status != PSA_SUCCESS )
2743 return( status );
2744 if( actual_hash_length != hash_length )
2745 return( PSA_ERROR_INVALID_SIGNATURE );
2746 if( safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
2747 return( PSA_ERROR_INVALID_SIGNATURE );
2748 return( PSA_SUCCESS );
2749}
2750
Gilles Peskine0a749c82019-11-28 19:33:58 +01002751psa_status_t psa_hash_compute( psa_algorithm_t alg,
2752 const uint8_t *input, size_t input_length,
2753 uint8_t *hash, size_t hash_size,
2754 size_t *hash_length )
2755{
2756 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
2757 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2758
2759 *hash_length = hash_size;
2760 status = psa_hash_setup( &operation, alg );
2761 if( status != PSA_SUCCESS )
2762 goto exit;
2763 status = psa_hash_update( &operation, input, input_length );
2764 if( status != PSA_SUCCESS )
2765 goto exit;
2766 status = psa_hash_finish( &operation, hash, hash_size, hash_length );
2767 if( status != PSA_SUCCESS )
2768 goto exit;
2769
2770exit:
2771 if( status == PSA_SUCCESS )
2772 status = psa_hash_abort( &operation );
2773 else
2774 psa_hash_abort( &operation );
2775 return( status );
2776}
2777
2778psa_status_t psa_hash_compare( psa_algorithm_t alg,
2779 const uint8_t *input, size_t input_length,
2780 const uint8_t *hash, size_t hash_length )
2781{
2782 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
2783 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2784
2785 status = psa_hash_setup( &operation, alg );
2786 if( status != PSA_SUCCESS )
2787 goto exit;
2788 status = psa_hash_update( &operation, input, input_length );
2789 if( status != PSA_SUCCESS )
2790 goto exit;
2791 status = psa_hash_verify( &operation, hash, hash_length );
2792 if( status != PSA_SUCCESS )
2793 goto exit;
2794
2795exit:
2796 if( status == PSA_SUCCESS )
2797 status = psa_hash_abort( &operation );
2798 else
2799 psa_hash_abort( &operation );
2800 return( status );
2801}
2802
Gilles Peskineeb35d782019-01-22 17:56:16 +01002803psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2804 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002805{
2806 if( target_operation->alg != 0 )
2807 return( PSA_ERROR_BAD_STATE );
2808
2809 switch( source_operation->alg )
2810 {
2811 case 0:
2812 return( PSA_ERROR_BAD_STATE );
2813#if defined(MBEDTLS_MD2_C)
2814 case PSA_ALG_MD2:
2815 mbedtls_md2_clone( &target_operation->ctx.md2,
2816 &source_operation->ctx.md2 );
2817 break;
2818#endif
2819#if defined(MBEDTLS_MD4_C)
2820 case PSA_ALG_MD4:
2821 mbedtls_md4_clone( &target_operation->ctx.md4,
2822 &source_operation->ctx.md4 );
2823 break;
2824#endif
2825#if defined(MBEDTLS_MD5_C)
2826 case PSA_ALG_MD5:
2827 mbedtls_md5_clone( &target_operation->ctx.md5,
2828 &source_operation->ctx.md5 );
2829 break;
2830#endif
2831#if defined(MBEDTLS_RIPEMD160_C)
2832 case PSA_ALG_RIPEMD160:
2833 mbedtls_ripemd160_clone( &target_operation->ctx.ripemd160,
2834 &source_operation->ctx.ripemd160 );
2835 break;
2836#endif
2837#if defined(MBEDTLS_SHA1_C)
2838 case PSA_ALG_SHA_1:
2839 mbedtls_sha1_clone( &target_operation->ctx.sha1,
2840 &source_operation->ctx.sha1 );
2841 break;
2842#endif
2843#if defined(MBEDTLS_SHA256_C)
2844 case PSA_ALG_SHA_224:
2845 case PSA_ALG_SHA_256:
2846 mbedtls_sha256_clone( &target_operation->ctx.sha256,
2847 &source_operation->ctx.sha256 );
2848 break;
2849#endif
2850#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002851#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002852 case PSA_ALG_SHA_384:
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002853#endif
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002854 case PSA_ALG_SHA_512:
2855 mbedtls_sha512_clone( &target_operation->ctx.sha512,
2856 &source_operation->ctx.sha512 );
2857 break;
2858#endif
2859 default:
2860 return( PSA_ERROR_NOT_SUPPORTED );
2861 }
2862
2863 target_operation->alg = source_operation->alg;
2864 return( PSA_SUCCESS );
2865}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002866
2867
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002868/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002869/* MAC */
2870/****************************************************************/
2871
Gilles Peskinedc2fc842018-03-07 16:42:59 +01002872static const mbedtls_cipher_info_t *mbedtls_cipher_info_from_psa(
Gilles Peskine8c9def32018-02-08 10:02:12 +01002873 psa_algorithm_t alg,
2874 psa_key_type_t key_type,
Gilles Peskine2d277862018-06-18 15:41:12 +02002875 size_t key_bits,
mohammad1603f4f0d612018-06-03 15:04:51 +03002876 mbedtls_cipher_id_t* cipher_id )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002877{
Gilles Peskine8c9def32018-02-08 10:02:12 +01002878 mbedtls_cipher_mode_t mode;
mohammad1603f4f0d612018-06-03 15:04:51 +03002879 mbedtls_cipher_id_t cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002880
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002881 if( PSA_ALG_IS_AEAD( alg ) )
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002882 alg = PSA_ALG_AEAD_WITH_TAG_LENGTH( alg, 0 );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002883
Gilles Peskine8c9def32018-02-08 10:02:12 +01002884 if( PSA_ALG_IS_CIPHER( alg ) || PSA_ALG_IS_AEAD( alg ) )
2885 {
Nir Sonnenscheine9664c32018-06-17 14:41:30 +03002886 switch( alg )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002887 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002888 case PSA_ALG_ARC4:
Gilles Peskine26869f22019-05-06 15:25:00 +02002889 case PSA_ALG_CHACHA20:
Gilles Peskine8c9def32018-02-08 10:02:12 +01002890 mode = MBEDTLS_MODE_STREAM;
2891 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002892 case PSA_ALG_CTR:
2893 mode = MBEDTLS_MODE_CTR;
2894 break;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002895 case PSA_ALG_CFB:
2896 mode = MBEDTLS_MODE_CFB;
2897 break;
2898 case PSA_ALG_OFB:
2899 mode = MBEDTLS_MODE_OFB;
2900 break;
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02002901 case PSA_ALG_ECB_NO_PADDING:
2902 mode = MBEDTLS_MODE_ECB;
2903 break;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002904 case PSA_ALG_CBC_NO_PADDING:
2905 mode = MBEDTLS_MODE_CBC;
2906 break;
2907 case PSA_ALG_CBC_PKCS7:
2908 mode = MBEDTLS_MODE_CBC;
2909 break;
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002910 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002911 mode = MBEDTLS_MODE_CCM;
2912 break;
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002913 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_GCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002914 mode = MBEDTLS_MODE_GCM;
2915 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02002916 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CHACHA20_POLY1305, 0 ):
2917 mode = MBEDTLS_MODE_CHACHAPOLY;
2918 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002919 default:
2920 return( NULL );
2921 }
2922 }
2923 else if( alg == PSA_ALG_CMAC )
2924 mode = MBEDTLS_MODE_ECB;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002925 else
2926 return( NULL );
2927
2928 switch( key_type )
2929 {
2930 case PSA_KEY_TYPE_AES:
mohammad1603f4f0d612018-06-03 15:04:51 +03002931 cipher_id_tmp = MBEDTLS_CIPHER_ID_AES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002932 break;
2933 case PSA_KEY_TYPE_DES:
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002934 /* key_bits is 64 for Single-DES, 128 for two-key Triple-DES,
2935 * and 192 for three-key Triple-DES. */
Gilles Peskine8c9def32018-02-08 10:02:12 +01002936 if( key_bits == 64 )
mohammad1603f4f0d612018-06-03 15:04:51 +03002937 cipher_id_tmp = MBEDTLS_CIPHER_ID_DES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002938 else
mohammad1603f4f0d612018-06-03 15:04:51 +03002939 cipher_id_tmp = MBEDTLS_CIPHER_ID_3DES;
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002940 /* mbedtls doesn't recognize two-key Triple-DES as an algorithm,
2941 * but two-key Triple-DES is functionally three-key Triple-DES
2942 * with K1=K3, so that's how we present it to mbedtls. */
2943 if( key_bits == 128 )
2944 key_bits = 192;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002945 break;
2946 case PSA_KEY_TYPE_CAMELLIA:
mohammad1603f4f0d612018-06-03 15:04:51 +03002947 cipher_id_tmp = MBEDTLS_CIPHER_ID_CAMELLIA;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002948 break;
2949 case PSA_KEY_TYPE_ARC4:
mohammad1603f4f0d612018-06-03 15:04:51 +03002950 cipher_id_tmp = MBEDTLS_CIPHER_ID_ARC4;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002951 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02002952 case PSA_KEY_TYPE_CHACHA20:
2953 cipher_id_tmp = MBEDTLS_CIPHER_ID_CHACHA20;
2954 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002955 default:
2956 return( NULL );
2957 }
mohammad1603f4f0d612018-06-03 15:04:51 +03002958 if( cipher_id != NULL )
mohammad160360a64d02018-06-03 17:20:42 +03002959 *cipher_id = cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002960
Jaeden Amero23bbb752018-06-26 14:16:54 +01002961 return( mbedtls_cipher_info_from_values( cipher_id_tmp,
2962 (int) key_bits, mode ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002963}
2964
Gilles Peskinea05219c2018-11-16 16:02:56 +01002965#if defined(MBEDTLS_MD_C)
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002966static size_t psa_get_hash_block_size( psa_algorithm_t alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002967{
Gilles Peskine2d277862018-06-18 15:41:12 +02002968 switch( alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002969 {
2970 case PSA_ALG_MD2:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002971 return( 16 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002972 case PSA_ALG_MD4:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002973 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002974 case PSA_ALG_MD5:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002975 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002976 case PSA_ALG_RIPEMD160:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002977 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002978 case PSA_ALG_SHA_1:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002979 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002980 case PSA_ALG_SHA_224:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002981 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002982 case PSA_ALG_SHA_256:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002983 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002984 case PSA_ALG_SHA_384:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002985 return( 128 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002986 case PSA_ALG_SHA_512:
Gilles Peskine2d277862018-06-18 15:41:12 +02002987 return( 128 );
2988 default:
2989 return( 0 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002990 }
2991}
Gilles Peskinea05219c2018-11-16 16:02:56 +01002992#endif /* MBEDTLS_MD_C */
Nir Sonnenschein0c9ec532018-06-07 13:27:47 +03002993
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002994/* Initialize the MAC operation structure. Once this function has been
2995 * called, psa_mac_abort can run and will do the right thing. */
2996static psa_status_t psa_mac_init( psa_mac_operation_t *operation,
2997 psa_algorithm_t alg )
2998{
2999 psa_status_t status = PSA_ERROR_NOT_SUPPORTED;
3000
3001 operation->alg = alg;
3002 operation->key_set = 0;
3003 operation->iv_set = 0;
3004 operation->iv_required = 0;
3005 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02003006 operation->is_sign = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003007
3008#if defined(MBEDTLS_CMAC_C)
3009 if( alg == PSA_ALG_CMAC )
3010 {
3011 operation->iv_required = 0;
3012 mbedtls_cipher_init( &operation->ctx.cmac );
3013 status = PSA_SUCCESS;
3014 }
3015 else
3016#endif /* MBEDTLS_CMAC_C */
3017#if defined(MBEDTLS_MD_C)
3018 if( PSA_ALG_IS_HMAC( operation->alg ) )
3019 {
Gilles Peskineff94abd2018-07-12 17:07:52 +02003020 /* We'll set up the hash operation later in psa_hmac_setup_internal. */
3021 operation->ctx.hmac.hash_ctx.alg = 0;
3022 status = PSA_SUCCESS;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003023 }
3024 else
3025#endif /* MBEDTLS_MD_C */
3026 {
Gilles Peskinec06e0712018-06-20 16:21:04 +02003027 if( ! PSA_ALG_IS_MAC( alg ) )
3028 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003029 }
3030
3031 if( status != PSA_SUCCESS )
3032 memset( operation, 0, sizeof( *operation ) );
3033 return( status );
3034}
3035
Gilles Peskine01126fa2018-07-12 17:04:55 +02003036#if defined(MBEDTLS_MD_C)
3037static psa_status_t psa_hmac_abort_internal( psa_hmac_internal_data *hmac )
3038{
Gilles Peskine3f108122018-12-07 18:14:53 +01003039 mbedtls_platform_zeroize( hmac->opad, sizeof( hmac->opad ) );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003040 return( psa_hash_abort( &hmac->hash_ctx ) );
3041}
3042#endif /* MBEDTLS_MD_C */
3043
Gilles Peskine8c9def32018-02-08 10:02:12 +01003044psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
3045{
Gilles Peskinefbfac682018-07-08 20:51:54 +02003046 if( operation->alg == 0 )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003047 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02003048 /* The object has (apparently) been initialized but it is not
3049 * in use. It's ok to call abort on such an object, and there's
3050 * nothing to do. */
3051 return( PSA_SUCCESS );
3052 }
3053 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01003054#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003055 if( operation->alg == PSA_ALG_CMAC )
3056 {
3057 mbedtls_cipher_free( &operation->ctx.cmac );
3058 }
3059 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01003060#endif /* MBEDTLS_CMAC_C */
Gilles Peskine8c9def32018-02-08 10:02:12 +01003061#if defined(MBEDTLS_MD_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003062 if( PSA_ALG_IS_HMAC( operation->alg ) )
3063 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02003064 psa_hmac_abort_internal( &operation->ctx.hmac );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003065 }
3066 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01003067#endif /* MBEDTLS_MD_C */
Gilles Peskinefbfac682018-07-08 20:51:54 +02003068 {
3069 /* Sanity check (shouldn't happen: operation->alg should
3070 * always have been initialized to a valid value). */
3071 goto bad_state;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003072 }
Moran Peker41deec42018-04-04 15:43:05 +03003073
Gilles Peskine8c9def32018-02-08 10:02:12 +01003074 operation->alg = 0;
3075 operation->key_set = 0;
3076 operation->iv_set = 0;
3077 operation->iv_required = 0;
3078 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02003079 operation->is_sign = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003080
Gilles Peskine8c9def32018-02-08 10:02:12 +01003081 return( PSA_SUCCESS );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003082
3083bad_state:
3084 /* If abort is called on an uninitialized object, we can't trust
3085 * anything. Wipe the object in case it contains confidential data.
3086 * This may result in a memory leak if a pointer gets overwritten,
3087 * but it's too late to do anything about this. */
3088 memset( operation, 0, sizeof( *operation ) );
3089 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003090}
3091
Gilles Peskinee3b07d82018-06-19 11:57:35 +02003092#if defined(MBEDTLS_CMAC_C)
Gilles Peskine89167cb2018-07-08 20:12:23 +02003093static int psa_cmac_setup( psa_mac_operation_t *operation,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003094 size_t key_bits,
Gilles Peskine2f060a82018-12-04 17:12:32 +01003095 psa_key_slot_t *slot,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003096 const mbedtls_cipher_info_t *cipher_info )
3097{
Janos Follath24eed8d2019-11-22 13:21:35 +00003098 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003099
3100 operation->mac_size = cipher_info->block_size;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003101
3102 ret = mbedtls_cipher_setup( &operation->ctx.cmac, cipher_info );
3103 if( ret != 0 )
3104 return( ret );
3105
3106 ret = mbedtls_cipher_cmac_starts( &operation->ctx.cmac,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02003107 slot->data.key.data,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003108 key_bits );
3109 return( ret );
3110}
Gilles Peskinee3b07d82018-06-19 11:57:35 +02003111#endif /* MBEDTLS_CMAC_C */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003112
Gilles Peskine248051a2018-06-20 16:09:38 +02003113#if defined(MBEDTLS_MD_C)
Gilles Peskine01126fa2018-07-12 17:04:55 +02003114static psa_status_t psa_hmac_setup_internal( psa_hmac_internal_data *hmac,
3115 const uint8_t *key,
3116 size_t key_length,
3117 psa_algorithm_t hash_alg )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003118{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02003119 uint8_t ipad[PSA_HMAC_MAX_HASH_BLOCK_SIZE];
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003120 size_t i;
Gilles Peskine9aa369e2018-07-16 00:36:29 +02003121 size_t hash_size = PSA_HASH_SIZE( hash_alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003122 size_t block_size = psa_get_hash_block_size( hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003123 psa_status_t status;
3124
Gilles Peskine9aa369e2018-07-16 00:36:29 +02003125 /* Sanity checks on block_size, to guarantee that there won't be a buffer
3126 * overflow below. This should never trigger if the hash algorithm
3127 * is implemented correctly. */
3128 /* The size checks against the ipad and opad buffers cannot be written
3129 * `block_size > sizeof( ipad ) || block_size > sizeof( hmac->opad )`
3130 * because that triggers -Wlogical-op on GCC 7.3. */
3131 if( block_size > sizeof( ipad ) )
3132 return( PSA_ERROR_NOT_SUPPORTED );
3133 if( block_size > sizeof( hmac->opad ) )
3134 return( PSA_ERROR_NOT_SUPPORTED );
3135 if( block_size < hash_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003136 return( PSA_ERROR_NOT_SUPPORTED );
3137
Gilles Peskined223b522018-06-11 18:12:58 +02003138 if( key_length > block_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003139 {
Gilles Peskine84b8fc82019-11-28 20:07:20 +01003140 status = psa_hash_compute( hash_alg, key, key_length,
3141 ipad, sizeof( ipad ), &key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003142 if( status != PSA_SUCCESS )
Gilles Peskineb8be2882018-07-17 16:24:34 +02003143 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003144 }
Gilles Peskine96889972018-07-12 17:07:03 +02003145 /* A 0-length key is not commonly used in HMAC when used as a MAC,
3146 * but it is permitted. It is common when HMAC is used in HKDF, for
3147 * example. Don't call `memcpy` in the 0-length because `key` could be
3148 * an invalid pointer which would make the behavior undefined. */
3149 else if( key_length != 0 )
Gilles Peskine01126fa2018-07-12 17:04:55 +02003150 memcpy( ipad, key, key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003151
Gilles Peskined223b522018-06-11 18:12:58 +02003152 /* ipad contains the key followed by garbage. Xor and fill with 0x36
3153 * to create the ipad value. */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003154 for( i = 0; i < key_length; i++ )
Gilles Peskined223b522018-06-11 18:12:58 +02003155 ipad[i] ^= 0x36;
3156 memset( ipad + key_length, 0x36, block_size - key_length );
3157
3158 /* Copy the key material from ipad to opad, flipping the requisite bits,
3159 * and filling the rest of opad with the requisite constant. */
3160 for( i = 0; i < key_length; i++ )
Gilles Peskine01126fa2018-07-12 17:04:55 +02003161 hmac->opad[i] = ipad[i] ^ 0x36 ^ 0x5C;
3162 memset( hmac->opad + key_length, 0x5C, block_size - key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003163
Gilles Peskine01126fa2018-07-12 17:04:55 +02003164 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003165 if( status != PSA_SUCCESS )
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003166 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003167
Gilles Peskine01126fa2018-07-12 17:04:55 +02003168 status = psa_hash_update( &hmac->hash_ctx, ipad, block_size );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003169
3170cleanup:
Steven Cooreman29149862020-08-05 15:43:42 +02003171 mbedtls_platform_zeroize( ipad, sizeof( ipad ) );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003172
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003173 return( status );
3174}
Gilles Peskine248051a2018-06-20 16:09:38 +02003175#endif /* MBEDTLS_MD_C */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003176
Gilles Peskine89167cb2018-07-08 20:12:23 +02003177static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003178 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02003179 psa_algorithm_t alg,
3180 int is_sign )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003181{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003182 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3183 psa_status_t decrement_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003184 psa_key_slot_t *slot;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003185 size_t key_bits;
Gilles Peskine89167cb2018-07-08 20:12:23 +02003186 psa_key_usage_t usage =
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003187 is_sign ? PSA_KEY_USAGE_SIGN_HASH : PSA_KEY_USAGE_VERIFY_HASH;
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02003188 uint8_t truncated = PSA_MAC_TRUNCATED_LENGTH( alg );
Gilles Peskinee0e9c7c2018-10-17 18:28:05 +02003189 psa_algorithm_t full_length_alg = PSA_ALG_FULL_LENGTH_MAC( alg );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003190
Jaeden Amero36ee5d02019-02-19 09:25:10 +00003191 /* A context must be freshly initialized before it can be set up. */
3192 if( operation->alg != 0 )
3193 {
3194 return( PSA_ERROR_BAD_STATE );
3195 }
3196
Gilles Peskined911eb72018-08-14 15:18:45 +02003197 status = psa_mac_init( operation, full_length_alg );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003198 if( status != PSA_SUCCESS )
3199 return( status );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003200 if( is_sign )
3201 operation->is_sign = 1;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003202
Ronald Croncf56a0a2020-08-04 09:51:30 +02003203 status = psa_get_transparent_key( key, &slot, usage, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003204 if( status != PSA_SUCCESS )
Gilles Peskinefbfac682018-07-08 20:51:54 +02003205 goto exit;
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02003206 key_bits = psa_get_key_slot_bits( slot );
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02003207
Gilles Peskine8c9def32018-02-08 10:02:12 +01003208#if defined(MBEDTLS_CMAC_C)
Gilles Peskined911eb72018-08-14 15:18:45 +02003209 if( full_length_alg == PSA_ALG_CMAC )
Gilles Peskinefbfac682018-07-08 20:51:54 +02003210 {
3211 const mbedtls_cipher_info_t *cipher_info =
Gilles Peskined911eb72018-08-14 15:18:45 +02003212 mbedtls_cipher_info_from_psa( full_length_alg,
Gilles Peskine8e338702019-07-30 20:06:31 +02003213 slot->attr.type, key_bits, NULL );
Janos Follath24eed8d2019-11-22 13:21:35 +00003214 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinefbfac682018-07-08 20:51:54 +02003215 if( cipher_info == NULL )
3216 {
3217 status = PSA_ERROR_NOT_SUPPORTED;
3218 goto exit;
3219 }
3220 operation->mac_size = cipher_info->block_size;
3221 ret = psa_cmac_setup( operation, key_bits, slot, cipher_info );
3222 status = mbedtls_to_psa_error( ret );
3223 }
3224 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01003225#endif /* MBEDTLS_CMAC_C */
Gilles Peskine8c9def32018-02-08 10:02:12 +01003226#if defined(MBEDTLS_MD_C)
Gilles Peskined911eb72018-08-14 15:18:45 +02003227 if( PSA_ALG_IS_HMAC( full_length_alg ) )
Gilles Peskinefbfac682018-07-08 20:51:54 +02003228 {
Gilles Peskine00709fa2018-08-22 18:25:41 +02003229 psa_algorithm_t hash_alg = PSA_ALG_HMAC_GET_HASH( alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003230 if( hash_alg == 0 )
3231 {
3232 status = PSA_ERROR_NOT_SUPPORTED;
3233 goto exit;
3234 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02003235
3236 operation->mac_size = PSA_HASH_SIZE( hash_alg );
3237 /* Sanity check. This shouldn't fail on a valid configuration. */
3238 if( operation->mac_size == 0 ||
3239 operation->mac_size > sizeof( operation->ctx.hmac.opad ) )
3240 {
3241 status = PSA_ERROR_NOT_SUPPORTED;
3242 goto exit;
3243 }
3244
Gilles Peskine8e338702019-07-30 20:06:31 +02003245 if( slot->attr.type != PSA_KEY_TYPE_HMAC )
Gilles Peskine01126fa2018-07-12 17:04:55 +02003246 {
3247 status = PSA_ERROR_INVALID_ARGUMENT;
3248 goto exit;
3249 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02003250
Gilles Peskine01126fa2018-07-12 17:04:55 +02003251 status = psa_hmac_setup_internal( &operation->ctx.hmac,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02003252 slot->data.key.data,
3253 slot->data.key.bytes,
Gilles Peskine01126fa2018-07-12 17:04:55 +02003254 hash_alg );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003255 }
3256 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01003257#endif /* MBEDTLS_MD_C */
Gilles Peskinefbfac682018-07-08 20:51:54 +02003258 {
Jaeden Amero82df32e2018-11-23 15:11:20 +00003259 (void) key_bits;
Gilles Peskinefbfac682018-07-08 20:51:54 +02003260 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003261 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003262
Gilles Peskined911eb72018-08-14 15:18:45 +02003263 if( truncated == 0 )
3264 {
3265 /* The "normal" case: untruncated algorithm. Nothing to do. */
3266 }
3267 else if( truncated < 4 )
3268 {
Gilles Peskine6d72ff92018-08-21 14:55:08 +02003269 /* A very short MAC is too short for security since it can be
3270 * brute-forced. Ancient protocols with 32-bit MACs do exist,
3271 * so we make this our minimum, even though 32 bits is still
3272 * too small for security. */
Gilles Peskined911eb72018-08-14 15:18:45 +02003273 status = PSA_ERROR_NOT_SUPPORTED;
3274 }
3275 else if( truncated > operation->mac_size )
3276 {
3277 /* It's impossible to "truncate" to a larger length. */
3278 status = PSA_ERROR_INVALID_ARGUMENT;
3279 }
3280 else
3281 operation->mac_size = truncated;
3282
Gilles Peskinefbfac682018-07-08 20:51:54 +02003283exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003284 if( status != PSA_SUCCESS )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003285 {
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003286 psa_mac_abort( operation );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003287 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003288 else
3289 {
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003290 operation->key_set = 1;
3291 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003292
3293 decrement_status = psa_decrement_key_slot_access_count( slot );
3294
3295 return( ( status == PSA_SUCCESS ) ? decrement_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003296}
3297
Gilles Peskine89167cb2018-07-08 20:12:23 +02003298psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003299 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02003300 psa_algorithm_t alg )
3301{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003302 return( psa_mac_setup( operation, key, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003303}
3304
3305psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003306 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02003307 psa_algorithm_t alg )
3308{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003309 return( psa_mac_setup( operation, key, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003310}
3311
Gilles Peskine8c9def32018-02-08 10:02:12 +01003312psa_status_t psa_mac_update( psa_mac_operation_t *operation,
3313 const uint8_t *input,
3314 size_t input_length )
3315{
Gilles Peskinefbfac682018-07-08 20:51:54 +02003316 psa_status_t status = PSA_ERROR_BAD_STATE;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003317 if( ! operation->key_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003318 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003319 if( operation->iv_required && ! operation->iv_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003320 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003321 operation->has_input = 1;
3322
Gilles Peskine8c9def32018-02-08 10:02:12 +01003323#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003324 if( operation->alg == PSA_ALG_CMAC )
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03003325 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02003326 int ret = mbedtls_cipher_cmac_update( &operation->ctx.cmac,
3327 input, input_length );
3328 status = mbedtls_to_psa_error( ret );
3329 }
3330 else
3331#endif /* MBEDTLS_CMAC_C */
3332#if defined(MBEDTLS_MD_C)
3333 if( PSA_ALG_IS_HMAC( operation->alg ) )
3334 {
3335 status = psa_hash_update( &operation->ctx.hmac.hash_ctx, input,
3336 input_length );
3337 }
3338 else
3339#endif /* MBEDTLS_MD_C */
3340 {
3341 /* This shouldn't happen if `operation` was initialized by
3342 * a setup function. */
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003343 return( PSA_ERROR_BAD_STATE );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03003344 }
3345
Gilles Peskinefbfac682018-07-08 20:51:54 +02003346 if( status != PSA_SUCCESS )
3347 psa_mac_abort( operation );
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02003348 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003349}
3350
Gilles Peskine01126fa2018-07-12 17:04:55 +02003351#if defined(MBEDTLS_MD_C)
3352static psa_status_t psa_hmac_finish_internal( psa_hmac_internal_data *hmac,
3353 uint8_t *mac,
3354 size_t mac_size )
3355{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02003356 uint8_t tmp[MBEDTLS_MD_MAX_SIZE];
Gilles Peskine01126fa2018-07-12 17:04:55 +02003357 psa_algorithm_t hash_alg = hmac->hash_ctx.alg;
3358 size_t hash_size = 0;
3359 size_t block_size = psa_get_hash_block_size( hash_alg );
3360 psa_status_t status;
3361
Gilles Peskine01126fa2018-07-12 17:04:55 +02003362 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
3363 if( status != PSA_SUCCESS )
3364 return( status );
3365 /* From here on, tmp needs to be wiped. */
3366
3367 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
3368 if( status != PSA_SUCCESS )
3369 goto exit;
3370
3371 status = psa_hash_update( &hmac->hash_ctx, hmac->opad, block_size );
3372 if( status != PSA_SUCCESS )
3373 goto exit;
3374
3375 status = psa_hash_update( &hmac->hash_ctx, tmp, hash_size );
3376 if( status != PSA_SUCCESS )
3377 goto exit;
3378
Gilles Peskined911eb72018-08-14 15:18:45 +02003379 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
3380 if( status != PSA_SUCCESS )
3381 goto exit;
3382
3383 memcpy( mac, tmp, mac_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003384
3385exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01003386 mbedtls_platform_zeroize( tmp, hash_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003387 return( status );
3388}
3389#endif /* MBEDTLS_MD_C */
3390
mohammad16036df908f2018-04-02 08:34:15 -07003391static psa_status_t psa_mac_finish_internal( psa_mac_operation_t *operation,
Gilles Peskine2d277862018-06-18 15:41:12 +02003392 uint8_t *mac,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003393 size_t mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003394{
Gilles Peskine1d96fff2018-07-02 12:15:39 +02003395 if( ! operation->key_set )
3396 return( PSA_ERROR_BAD_STATE );
3397 if( operation->iv_required && ! operation->iv_set )
3398 return( PSA_ERROR_BAD_STATE );
3399
Gilles Peskine8c9def32018-02-08 10:02:12 +01003400 if( mac_size < operation->mac_size )
3401 return( PSA_ERROR_BUFFER_TOO_SMALL );
3402
Gilles Peskine8c9def32018-02-08 10:02:12 +01003403#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003404 if( operation->alg == PSA_ALG_CMAC )
3405 {
Gilles Peskined911eb72018-08-14 15:18:45 +02003406 uint8_t tmp[PSA_MAX_BLOCK_CIPHER_BLOCK_SIZE];
3407 int ret = mbedtls_cipher_cmac_finish( &operation->ctx.cmac, tmp );
3408 if( ret == 0 )
Gilles Peskine87b0ac42018-08-21 14:55:49 +02003409 memcpy( mac, tmp, operation->mac_size );
Gilles Peskine3f108122018-12-07 18:14:53 +01003410 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003411 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003412 }
Gilles Peskinefbfac682018-07-08 20:51:54 +02003413 else
3414#endif /* MBEDTLS_CMAC_C */
3415#if defined(MBEDTLS_MD_C)
3416 if( PSA_ALG_IS_HMAC( operation->alg ) )
3417 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02003418 return( psa_hmac_finish_internal( &operation->ctx.hmac,
Gilles Peskined911eb72018-08-14 15:18:45 +02003419 mac, operation->mac_size ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003420 }
3421 else
3422#endif /* MBEDTLS_MD_C */
3423 {
3424 /* This shouldn't happen if `operation` was initialized by
3425 * a setup function. */
3426 return( PSA_ERROR_BAD_STATE );
3427 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01003428}
3429
Gilles Peskineacd4be32018-07-08 19:56:25 +02003430psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
3431 uint8_t *mac,
3432 size_t mac_size,
3433 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07003434{
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003435 psa_status_t status;
3436
Jaeden Amero252ef282019-02-15 14:05:35 +00003437 if( operation->alg == 0 )
3438 {
3439 return( PSA_ERROR_BAD_STATE );
3440 }
3441
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003442 /* Fill the output buffer with something that isn't a valid mac
3443 * (barring an attack on the mac and deliberately-crafted input),
3444 * in case the caller doesn't check the return status properly. */
3445 *mac_length = mac_size;
3446 /* If mac_size is 0 then mac may be NULL and then the
3447 * call to memset would have undefined behavior. */
3448 if( mac_size != 0 )
3449 memset( mac, '!', mac_size );
3450
Gilles Peskine89167cb2018-07-08 20:12:23 +02003451 if( ! operation->is_sign )
3452 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003453 return( PSA_ERROR_BAD_STATE );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003454 }
mohammad16036df908f2018-04-02 08:34:15 -07003455
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003456 status = psa_mac_finish_internal( operation, mac, mac_size );
3457
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003458 if( status == PSA_SUCCESS )
3459 {
3460 status = psa_mac_abort( operation );
3461 if( status == PSA_SUCCESS )
3462 *mac_length = operation->mac_size;
3463 else
3464 memset( mac, '!', mac_size );
3465 }
3466 else
3467 psa_mac_abort( operation );
3468 return( status );
mohammad16036df908f2018-04-02 08:34:15 -07003469}
3470
Gilles Peskineacd4be32018-07-08 19:56:25 +02003471psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
3472 const uint8_t *mac,
3473 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003474{
Gilles Peskine828ed142018-06-18 23:25:51 +02003475 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
mohammad16036df908f2018-04-02 08:34:15 -07003476 psa_status_t status;
3477
Jaeden Amero252ef282019-02-15 14:05:35 +00003478 if( operation->alg == 0 )
3479 {
3480 return( PSA_ERROR_BAD_STATE );
3481 }
3482
Gilles Peskine89167cb2018-07-08 20:12:23 +02003483 if( operation->is_sign )
3484 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003485 return( PSA_ERROR_BAD_STATE );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003486 }
3487 if( operation->mac_size != mac_length )
3488 {
3489 status = PSA_ERROR_INVALID_SIGNATURE;
3490 goto cleanup;
Gilles Peskine89167cb2018-07-08 20:12:23 +02003491 }
mohammad16036df908f2018-04-02 08:34:15 -07003492
3493 status = psa_mac_finish_internal( operation,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003494 actual_mac, sizeof( actual_mac ) );
Gilles Peskine28cd4162020-01-20 16:31:06 +01003495 if( status != PSA_SUCCESS )
3496 goto cleanup;
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003497
3498 if( safer_memcmp( mac, actual_mac, mac_length ) != 0 )
3499 status = PSA_ERROR_INVALID_SIGNATURE;
3500
3501cleanup:
3502 if( status == PSA_SUCCESS )
3503 status = psa_mac_abort( operation );
3504 else
3505 psa_mac_abort( operation );
3506
Gilles Peskine3f108122018-12-07 18:14:53 +01003507 mbedtls_platform_zeroize( actual_mac, sizeof( actual_mac ) );
Gilles Peskined911eb72018-08-14 15:18:45 +02003508
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003509 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003510}
3511
3512
Gilles Peskine20035e32018-02-03 22:44:14 +01003513
Gilles Peskine20035e32018-02-03 22:44:14 +01003514/****************************************************************/
3515/* Asymmetric cryptography */
3516/****************************************************************/
3517
Gilles Peskine2b450e32018-06-27 15:42:46 +02003518#if defined(MBEDTLS_RSA_C)
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02003519/* Decode the hash algorithm from alg and store the mbedtls encoding in
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003520 * md_alg. Verify that the hash length is acceptable. */
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02003521static psa_status_t psa_rsa_decode_md_type( psa_algorithm_t alg,
3522 size_t hash_length,
3523 mbedtls_md_type_t *md_alg )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003524{
Gilles Peskine7ed29c52018-06-26 15:50:08 +02003525 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003526 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003527 *md_alg = mbedtls_md_get_type( md_info );
3528
3529 /* The Mbed TLS RSA module uses an unsigned int for hash length
3530 * parameters. Validate that it fits so that we don't risk an
3531 * overflow later. */
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003532#if SIZE_MAX > UINT_MAX
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003533 if( hash_length > UINT_MAX )
3534 return( PSA_ERROR_INVALID_ARGUMENT );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003535#endif
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003536
3537#if defined(MBEDTLS_PKCS1_V15)
3538 /* For PKCS#1 v1.5 signature, if using a hash, the hash length
3539 * must be correct. */
3540 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) &&
3541 alg != PSA_ALG_RSA_PKCS1V15_SIGN_RAW )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003542 {
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003543 if( md_info == NULL )
3544 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003545 if( mbedtls_md_get_size( md_info ) != hash_length )
3546 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003547 }
3548#endif /* MBEDTLS_PKCS1_V15 */
3549
3550#if defined(MBEDTLS_PKCS1_V21)
3551 /* PSS requires a hash internally. */
3552 if( PSA_ALG_IS_RSA_PSS( alg ) )
3553 {
Gilles Peskine61b91d42018-06-08 16:09:36 +02003554 if( md_info == NULL )
3555 return( PSA_ERROR_NOT_SUPPORTED );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003556 }
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003557#endif /* MBEDTLS_PKCS1_V21 */
3558
Gilles Peskine61b91d42018-06-08 16:09:36 +02003559 return( PSA_SUCCESS );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003560}
3561
Gilles Peskine2b450e32018-06-27 15:42:46 +02003562static psa_status_t psa_rsa_sign( mbedtls_rsa_context *rsa,
3563 psa_algorithm_t alg,
3564 const uint8_t *hash,
3565 size_t hash_length,
3566 uint8_t *signature,
3567 size_t signature_size,
3568 size_t *signature_length )
3569{
3570 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00003571 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003572 mbedtls_md_type_t md_alg;
3573
3574 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
3575 if( status != PSA_SUCCESS )
3576 return( status );
3577
Gilles Peskine630a18a2018-06-29 17:49:35 +02003578 if( signature_size < mbedtls_rsa_get_len( rsa ) )
Gilles Peskine2b450e32018-06-27 15:42:46 +02003579 return( PSA_ERROR_BUFFER_TOO_SMALL );
3580
3581#if defined(MBEDTLS_PKCS1_V15)
3582 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
3583 {
3584 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
3585 MBEDTLS_MD_NONE );
3586 ret = mbedtls_rsa_pkcs1_sign( rsa,
3587 mbedtls_ctr_drbg_random,
3588 &global_data.ctr_drbg,
3589 MBEDTLS_RSA_PRIVATE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003590 md_alg,
3591 (unsigned int) hash_length,
3592 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003593 signature );
3594 }
3595 else
3596#endif /* MBEDTLS_PKCS1_V15 */
3597#if defined(MBEDTLS_PKCS1_V21)
3598 if( PSA_ALG_IS_RSA_PSS( alg ) )
3599 {
3600 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3601 ret = mbedtls_rsa_rsassa_pss_sign( rsa,
3602 mbedtls_ctr_drbg_random,
3603 &global_data.ctr_drbg,
3604 MBEDTLS_RSA_PRIVATE,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003605 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003606 (unsigned int) hash_length,
3607 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003608 signature );
3609 }
3610 else
3611#endif /* MBEDTLS_PKCS1_V21 */
3612 {
3613 return( PSA_ERROR_INVALID_ARGUMENT );
3614 }
3615
3616 if( ret == 0 )
Gilles Peskine630a18a2018-06-29 17:49:35 +02003617 *signature_length = mbedtls_rsa_get_len( rsa );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003618 return( mbedtls_to_psa_error( ret ) );
3619}
3620
3621static psa_status_t psa_rsa_verify( mbedtls_rsa_context *rsa,
3622 psa_algorithm_t alg,
3623 const uint8_t *hash,
3624 size_t hash_length,
3625 const uint8_t *signature,
3626 size_t signature_length )
3627{
3628 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00003629 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003630 mbedtls_md_type_t md_alg;
3631
3632 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
3633 if( status != PSA_SUCCESS )
3634 return( status );
3635
Gilles Peskine89cc74f2019-09-12 22:08:23 +02003636 if( signature_length != mbedtls_rsa_get_len( rsa ) )
3637 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003638
3639#if defined(MBEDTLS_PKCS1_V15)
3640 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
3641 {
3642 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
3643 MBEDTLS_MD_NONE );
3644 ret = mbedtls_rsa_pkcs1_verify( rsa,
3645 mbedtls_ctr_drbg_random,
3646 &global_data.ctr_drbg,
3647 MBEDTLS_RSA_PUBLIC,
3648 md_alg,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003649 (unsigned int) hash_length,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003650 hash,
3651 signature );
3652 }
3653 else
3654#endif /* MBEDTLS_PKCS1_V15 */
3655#if defined(MBEDTLS_PKCS1_V21)
3656 if( PSA_ALG_IS_RSA_PSS( alg ) )
3657 {
3658 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3659 ret = mbedtls_rsa_rsassa_pss_verify( rsa,
3660 mbedtls_ctr_drbg_random,
3661 &global_data.ctr_drbg,
3662 MBEDTLS_RSA_PUBLIC,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003663 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003664 (unsigned int) hash_length,
3665 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003666 signature );
3667 }
3668 else
3669#endif /* MBEDTLS_PKCS1_V21 */
3670 {
3671 return( PSA_ERROR_INVALID_ARGUMENT );
3672 }
Gilles Peskineef12c632018-09-13 20:37:48 +02003673
3674 /* Mbed TLS distinguishes "invalid padding" from "valid padding but
3675 * the rest of the signature is invalid". This has little use in
3676 * practice and PSA doesn't report this distinction. */
3677 if( ret == MBEDTLS_ERR_RSA_INVALID_PADDING )
3678 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003679 return( mbedtls_to_psa_error( ret ) );
3680}
3681#endif /* MBEDTLS_RSA_C */
3682
John Durkopf87e3ae2020-10-26 15:25:23 -07003683#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003684/* `ecp` cannot be const because `ecp->grp` needs to be non-const
3685 * for mbedtls_ecdsa_sign() and mbedtls_ecdsa_sign_det()
3686 * (even though these functions don't modify it). */
3687static psa_status_t psa_ecdsa_sign( mbedtls_ecp_keypair *ecp,
3688 psa_algorithm_t alg,
3689 const uint8_t *hash,
3690 size_t hash_length,
3691 uint8_t *signature,
3692 size_t signature_size,
3693 size_t *signature_length )
3694{
Janos Follath24eed8d2019-11-22 13:21:35 +00003695 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003696 mbedtls_mpi r, s;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003697 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003698 mbedtls_mpi_init( &r );
3699 mbedtls_mpi_init( &s );
3700
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003701 if( signature_size < 2 * curve_bytes )
3702 {
3703 ret = MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL;
3704 goto cleanup;
3705 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003706
John Durkop0ea39e02020-10-13 19:58:20 -07003707#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003708 if( PSA_ALG_DSA_IS_DETERMINISTIC( alg ) )
3709 {
3710 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
3711 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3712 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
Darryl Green5e843fa2019-09-05 14:06:34 +01003713 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign_det_ext( &ecp->grp, &r, &s,
3714 &ecp->d, hash,
3715 hash_length, md_alg,
3716 mbedtls_ctr_drbg_random,
3717 &global_data.ctr_drbg ) );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003718 }
3719 else
John Durkop0ea39e02020-10-13 19:58:20 -07003720#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003721 {
Gilles Peskinea05219c2018-11-16 16:02:56 +01003722 (void) alg;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003723 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign( &ecp->grp, &r, &s, &ecp->d,
3724 hash, hash_length,
3725 mbedtls_ctr_drbg_random,
3726 &global_data.ctr_drbg ) );
3727 }
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003728
3729 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &r,
3730 signature,
3731 curve_bytes ) );
3732 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &s,
3733 signature + curve_bytes,
3734 curve_bytes ) );
3735
3736cleanup:
3737 mbedtls_mpi_free( &r );
3738 mbedtls_mpi_free( &s );
3739 if( ret == 0 )
3740 *signature_length = 2 * curve_bytes;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003741 return( mbedtls_to_psa_error( ret ) );
3742}
3743
3744static psa_status_t psa_ecdsa_verify( mbedtls_ecp_keypair *ecp,
3745 const uint8_t *hash,
3746 size_t hash_length,
3747 const uint8_t *signature,
3748 size_t signature_length )
3749{
Janos Follath24eed8d2019-11-22 13:21:35 +00003750 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003751 mbedtls_mpi r, s;
3752 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
3753 mbedtls_mpi_init( &r );
3754 mbedtls_mpi_init( &s );
3755
3756 if( signature_length != 2 * curve_bytes )
3757 return( PSA_ERROR_INVALID_SIGNATURE );
3758
3759 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &r,
3760 signature,
3761 curve_bytes ) );
3762 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &s,
3763 signature + curve_bytes,
3764 curve_bytes ) );
3765
Steven Cooremanacda8342020-07-24 23:09:52 +02003766 /* Check whether the public part is loaded. If not, load it. */
3767 if( mbedtls_ecp_is_zero( &ecp->Q ) )
3768 {
3769 MBEDTLS_MPI_CHK(
3770 mbedtls_ecp_mul( &ecp->grp, &ecp->Q, &ecp->d, &ecp->grp.G,
3771 mbedtls_ctr_drbg_random, &global_data.ctr_drbg ) );
3772 }
3773
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003774 ret = mbedtls_ecdsa_verify( &ecp->grp, hash, hash_length,
3775 &ecp->Q, &r, &s );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003776
3777cleanup:
3778 mbedtls_mpi_free( &r );
3779 mbedtls_mpi_free( &s );
3780 return( mbedtls_to_psa_error( ret ) );
3781}
John Durkopf87e3ae2020-10-26 15:25:23 -07003782#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003783
Ronald Croncf56a0a2020-08-04 09:51:30 +02003784psa_status_t psa_sign_hash( mbedtls_svc_key_id_t key,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003785 psa_algorithm_t alg,
3786 const uint8_t *hash,
3787 size_t hash_length,
3788 uint8_t *signature,
3789 size_t signature_size,
3790 size_t *signature_length )
Gilles Peskine20035e32018-02-03 22:44:14 +01003791{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003792 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3793 psa_status_t decrement_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003794 psa_key_slot_t *slot;
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003795
3796 *signature_length = signature_size;
Gilles Peskine4019f0e2019-09-12 22:05:59 +02003797 /* Immediately reject a zero-length signature buffer. This guarantees
3798 * that signature must be a valid pointer. (On the other hand, the hash
3799 * buffer can in principle be empty since it doesn't actually have
3800 * to be a hash.) */
3801 if( signature_size == 0 )
3802 return( PSA_ERROR_BUFFER_TOO_SMALL );
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003803
Ronald Croncf56a0a2020-08-04 09:51:30 +02003804 status = psa_get_key_from_slot( key, &slot, PSA_KEY_USAGE_SIGN_HASH, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003805 if( status != PSA_SUCCESS )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003806 goto exit;
Gilles Peskine8e338702019-07-30 20:06:31 +02003807 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003808 {
3809 status = PSA_ERROR_INVALID_ARGUMENT;
3810 goto exit;
3811 }
Gilles Peskine20035e32018-02-03 22:44:14 +01003812
Steven Cooremancd84cb42020-07-16 20:28:36 +02003813 /* Try any of the available accelerators first */
3814 status = psa_driver_wrapper_sign_hash( slot,
3815 alg,
3816 hash,
3817 hash_length,
3818 signature,
3819 signature_size,
3820 signature_length );
Steven Cooreman8d2bde72020-09-04 13:06:39 +02003821 if( status != PSA_ERROR_NOT_SUPPORTED ||
3822 psa_key_lifetime_is_external( slot->attr.lifetime ) )
Steven Cooremancd84cb42020-07-16 20:28:36 +02003823 goto exit;
3824
Steven Cooreman7a250572020-07-17 16:43:05 +02003825 /* If the operation was not supported by any accelerator, try fallback. */
Gilles Peskine20035e32018-02-03 22:44:14 +01003826#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003827 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskine20035e32018-02-03 22:44:14 +01003828 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003829 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02003830
Steven Cooreman4fed4552020-08-03 14:46:03 +02003831 status = psa_load_rsa_representation( slot->attr.type,
3832 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02003833 slot->data.key.bytes,
Steven Cooremana01795d2020-07-24 22:48:15 +02003834 &rsa );
3835 if( status != PSA_SUCCESS )
3836 goto exit;
3837
Steven Cooremana2371e52020-07-28 14:30:39 +02003838 status = psa_rsa_sign( rsa,
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003839 alg,
3840 hash, hash_length,
3841 signature, signature_size,
3842 signature_length );
Steven Cooremana01795d2020-07-24 22:48:15 +02003843
Steven Cooremana2371e52020-07-28 14:30:39 +02003844 mbedtls_rsa_free( rsa );
3845 mbedtls_free( rsa );
Gilles Peskine20035e32018-02-03 22:44:14 +01003846 }
3847 else
3848#endif /* defined(MBEDTLS_RSA_C) */
3849#if defined(MBEDTLS_ECP_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003850 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
Gilles Peskine20035e32018-02-03 22:44:14 +01003851 {
John Durkop0ea39e02020-10-13 19:58:20 -07003852#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA)
Gilles Peskinea05219c2018-11-16 16:02:56 +01003853 if(
John Durkop0ea39e02020-10-13 19:58:20 -07003854#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea05219c2018-11-16 16:02:56 +01003855 PSA_ALG_IS_ECDSA( alg )
3856#else
3857 PSA_ALG_IS_RANDOMIZED_ECDSA( alg )
3858#endif
3859 )
Steven Cooremanacda8342020-07-24 23:09:52 +02003860 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003861 mbedtls_ecp_keypair *ecp = NULL;
Steven Cooreman4fed4552020-08-03 14:46:03 +02003862 status = psa_load_ecp_representation( slot->attr.type,
3863 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02003864 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02003865 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003866 if( status != PSA_SUCCESS )
3867 goto exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003868 status = psa_ecdsa_sign( ecp,
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003869 alg,
3870 hash, hash_length,
3871 signature, signature_size,
3872 signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02003873 mbedtls_ecp_keypair_free( ecp );
3874 mbedtls_free( ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003875 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003876 else
John Durkop0ea39e02020-10-13 19:58:20 -07003877#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003878 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003879 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003880 }
itayzafrir5c753392018-05-08 11:18:38 +03003881 }
3882 else
3883#endif /* defined(MBEDTLS_ECP_C) */
3884 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003885 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine20035e32018-02-03 22:44:14 +01003886 }
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003887
3888exit:
3889 /* Fill the unused part of the output buffer (the whole buffer on error,
3890 * the trailing part on success) with something that isn't a valid mac
3891 * (barring an attack on the mac and deliberately-crafted input),
3892 * in case the caller doesn't check the return status properly. */
3893 if( status == PSA_SUCCESS )
3894 memset( signature + *signature_length, '!',
3895 signature_size - *signature_length );
Gilles Peskine4019f0e2019-09-12 22:05:59 +02003896 else
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003897 memset( signature, '!', signature_size );
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003898 /* If signature_size is 0 then we have nothing to do. We must not call
3899 * memset because signature may be NULL in this case. */
Ronald Cronf95a2b12020-10-22 15:24:49 +02003900
3901 decrement_status = psa_decrement_key_slot_access_count( slot );
3902
3903 return( ( status == PSA_SUCCESS ) ? decrement_status : status );
itayzafrir5c753392018-05-08 11:18:38 +03003904}
3905
Ronald Croncf56a0a2020-08-04 09:51:30 +02003906psa_status_t psa_verify_hash( mbedtls_svc_key_id_t key,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003907 psa_algorithm_t alg,
3908 const uint8_t *hash,
3909 size_t hash_length,
3910 const uint8_t *signature,
3911 size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03003912{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003913 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3914 psa_status_t decrement_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003915 psa_key_slot_t *slot;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003916
Ronald Croncf56a0a2020-08-04 09:51:30 +02003917 status = psa_get_key_from_slot( key, &slot,
3918 PSA_KEY_USAGE_VERIFY_HASH, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003919 if( status != PSA_SUCCESS )
3920 return( status );
itayzafrir5c753392018-05-08 11:18:38 +03003921
Steven Cooreman55ae2172020-07-17 19:46:15 +02003922 /* Try any of the available accelerators first */
3923 status = psa_driver_wrapper_verify_hash( slot,
3924 alg,
3925 hash,
3926 hash_length,
3927 signature,
3928 signature_length );
Steven Cooreman8d2bde72020-09-04 13:06:39 +02003929 if( status != PSA_ERROR_NOT_SUPPORTED ||
3930 psa_key_lifetime_is_external( slot->attr.lifetime ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003931 goto exit;
Steven Cooreman55ae2172020-07-17 19:46:15 +02003932
Gilles Peskine61b91d42018-06-08 16:09:36 +02003933#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003934 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003935 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003936 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02003937
Steven Cooreman4fed4552020-08-03 14:46:03 +02003938 status = psa_load_rsa_representation( slot->attr.type,
3939 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02003940 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02003941 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003942 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003943 goto exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003944
Steven Cooremana2371e52020-07-28 14:30:39 +02003945 status = psa_rsa_verify( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02003946 alg,
3947 hash, hash_length,
3948 signature, signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02003949 mbedtls_rsa_free( rsa );
3950 mbedtls_free( rsa );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003951 goto exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003952 }
3953 else
3954#endif /* defined(MBEDTLS_RSA_C) */
itayzafrir5c753392018-05-08 11:18:38 +03003955#if defined(MBEDTLS_ECP_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003956 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
itayzafrir5c753392018-05-08 11:18:38 +03003957 {
John Durkopf87e3ae2020-10-26 15:25:23 -07003958#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003959 if( PSA_ALG_IS_ECDSA( alg ) )
Steven Cooremanacda8342020-07-24 23:09:52 +02003960 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003961 mbedtls_ecp_keypair *ecp = NULL;
Steven Cooreman4fed4552020-08-03 14:46:03 +02003962 status = psa_load_ecp_representation( slot->attr.type,
3963 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02003964 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02003965 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003966 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003967 goto exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003968 status = psa_ecdsa_verify( ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02003969 hash, hash_length,
3970 signature, signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02003971 mbedtls_ecp_keypair_free( ecp );
3972 mbedtls_free( ecp );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003973 goto exit;
Steven Cooremanacda8342020-07-24 23:09:52 +02003974 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003975 else
John Durkopf87e3ae2020-10-26 15:25:23 -07003976#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003977 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003978 status = PSA_ERROR_INVALID_ARGUMENT;
3979 goto exit;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003980 }
itayzafrir5c753392018-05-08 11:18:38 +03003981 }
Gilles Peskine20035e32018-02-03 22:44:14 +01003982 else
3983#endif /* defined(MBEDTLS_ECP_C) */
3984 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003985 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine20035e32018-02-03 22:44:14 +01003986 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003987
3988exit:
3989 decrement_status = psa_decrement_key_slot_access_count( slot );
3990
3991 return( ( status == PSA_SUCCESS ) ? decrement_status : status );
Gilles Peskine20035e32018-02-03 22:44:14 +01003992}
3993
Gilles Peskine072ac562018-06-30 00:21:29 +02003994#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PKCS1_V21)
3995static void psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
3996 mbedtls_rsa_context *rsa )
3997{
3998 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
3999 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
4000 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
4001 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
4002}
4003#endif /* defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PKCS1_V21) */
4004
Ronald Croncf56a0a2020-08-04 09:51:30 +02004005psa_status_t psa_asymmetric_encrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02004006 psa_algorithm_t alg,
4007 const uint8_t *input,
4008 size_t input_length,
4009 const uint8_t *salt,
4010 size_t salt_length,
4011 uint8_t *output,
4012 size_t output_size,
4013 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004014{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004015 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4016 psa_status_t decrement_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01004017 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004018
Darryl Green5cc689a2018-07-24 15:34:10 +01004019 (void) input;
4020 (void) input_length;
4021 (void) salt;
4022 (void) output;
4023 (void) output_size;
4024
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03004025 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004026
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02004027 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
4028 return( PSA_ERROR_INVALID_ARGUMENT );
4029
Ronald Croncf56a0a2020-08-04 09:51:30 +02004030 status = psa_get_transparent_key( key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004031 if( status != PSA_SUCCESS )
4032 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02004033 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
4034 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004035 {
4036 status = PSA_ERROR_INVALID_ARGUMENT;
4037 goto exit;
4038 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004039
4040#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02004041 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004042 {
Steven Cooremana2371e52020-07-28 14:30:39 +02004043 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman4fed4552020-08-03 14:46:03 +02004044 status = psa_load_rsa_representation( slot->attr.type,
4045 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02004046 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02004047 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02004048 if( status != PSA_SUCCESS )
Steven Cooreman4fed4552020-08-03 14:46:03 +02004049 goto rsa_exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02004050
4051 if( output_size < mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02004052 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004053 status = PSA_ERROR_BUFFER_TOO_SMALL;
4054 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02004055 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004056#if defined(MBEDTLS_PKCS1_V15)
Gilles Peskine6afe7892018-05-31 13:16:08 +02004057 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004058 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004059 status = mbedtls_to_psa_error(
4060 mbedtls_rsa_pkcs1_encrypt( rsa,
4061 mbedtls_ctr_drbg_random,
4062 &global_data.ctr_drbg,
4063 MBEDTLS_RSA_PUBLIC,
4064 input_length,
4065 input,
4066 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004067 }
4068 else
4069#endif /* MBEDTLS_PKCS1_V15 */
4070#if defined(MBEDTLS_PKCS1_V21)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02004071 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004072 {
Steven Cooremana2371e52020-07-28 14:30:39 +02004073 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02004074 status = mbedtls_to_psa_error(
4075 mbedtls_rsa_rsaes_oaep_encrypt( rsa,
4076 mbedtls_ctr_drbg_random,
4077 &global_data.ctr_drbg,
4078 MBEDTLS_RSA_PUBLIC,
4079 salt, salt_length,
4080 input_length,
4081 input,
4082 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004083 }
4084 else
4085#endif /* MBEDTLS_PKCS1_V21 */
4086 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004087 status = PSA_ERROR_INVALID_ARGUMENT;
4088 goto rsa_exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004089 }
Steven Cooreman4fed4552020-08-03 14:46:03 +02004090rsa_exit:
4091 if( status == PSA_SUCCESS )
Steven Cooremana2371e52020-07-28 14:30:39 +02004092 *output_length = mbedtls_rsa_get_len( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02004093
Steven Cooremana2371e52020-07-28 14:30:39 +02004094 mbedtls_rsa_free( rsa );
4095 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004096 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004097 else
Gilles Peskineb75e4f12018-06-08 17:44:47 +02004098#endif /* defined(MBEDTLS_RSA_C) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004099 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02004100 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004101 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004102
4103exit:
4104 decrement_status = psa_decrement_key_slot_access_count( slot );
4105
4106 return( ( status == PSA_SUCCESS ) ? decrement_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02004107}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004108
Ronald Croncf56a0a2020-08-04 09:51:30 +02004109psa_status_t psa_asymmetric_decrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02004110 psa_algorithm_t alg,
4111 const uint8_t *input,
4112 size_t input_length,
4113 const uint8_t *salt,
4114 size_t salt_length,
4115 uint8_t *output,
4116 size_t output_size,
4117 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004118{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004119 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4120 psa_status_t decrement_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01004121 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004122
Darryl Green5cc689a2018-07-24 15:34:10 +01004123 (void) input;
4124 (void) input_length;
4125 (void) salt;
4126 (void) output;
4127 (void) output_size;
4128
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03004129 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004130
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02004131 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
4132 return( PSA_ERROR_INVALID_ARGUMENT );
4133
Ronald Croncf56a0a2020-08-04 09:51:30 +02004134 status = psa_get_transparent_key( key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004135 if( status != PSA_SUCCESS )
4136 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02004137 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004138 {
4139 status = PSA_ERROR_INVALID_ARGUMENT;
4140 goto exit;
4141 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004142
4143#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02004144 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004145 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004146 mbedtls_rsa_context *rsa = NULL;
4147 status = psa_load_rsa_representation( slot->attr.type,
4148 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02004149 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02004150 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02004151 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004152 goto exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004153
Steven Cooremana2371e52020-07-28 14:30:39 +02004154 if( input_length != mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02004155 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004156 status = PSA_ERROR_INVALID_ARGUMENT;
4157 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02004158 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004159
4160#if defined(MBEDTLS_PKCS1_V15)
Gilles Peskine6afe7892018-05-31 13:16:08 +02004161 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004162 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004163 status = mbedtls_to_psa_error(
4164 mbedtls_rsa_pkcs1_decrypt( rsa,
4165 mbedtls_ctr_drbg_random,
4166 &global_data.ctr_drbg,
4167 MBEDTLS_RSA_PRIVATE,
4168 output_length,
4169 input,
4170 output,
4171 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004172 }
4173 else
4174#endif /* MBEDTLS_PKCS1_V15 */
4175#if defined(MBEDTLS_PKCS1_V21)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02004176 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004177 {
Steven Cooremana2371e52020-07-28 14:30:39 +02004178 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02004179 status = mbedtls_to_psa_error(
4180 mbedtls_rsa_rsaes_oaep_decrypt( rsa,
4181 mbedtls_ctr_drbg_random,
4182 &global_data.ctr_drbg,
4183 MBEDTLS_RSA_PRIVATE,
4184 salt, salt_length,
4185 output_length,
4186 input,
4187 output,
4188 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004189 }
4190 else
4191#endif /* MBEDTLS_PKCS1_V21 */
4192 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004193 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004194 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03004195
Steven Cooreman4fed4552020-08-03 14:46:03 +02004196rsa_exit:
Steven Cooremana2371e52020-07-28 14:30:39 +02004197 mbedtls_rsa_free( rsa );
4198 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004199 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004200 else
Gilles Peskineb75e4f12018-06-08 17:44:47 +02004201#endif /* defined(MBEDTLS_RSA_C) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004202 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02004203 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004204 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004205
4206exit:
4207 decrement_status = psa_decrement_key_slot_access_count( slot );
4208
4209 return( ( status == PSA_SUCCESS ) ? decrement_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02004210}
Gilles Peskine20035e32018-02-03 22:44:14 +01004211
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004212
4213
mohammad1603503973b2018-03-12 15:59:30 +02004214/****************************************************************/
4215/* Symmetric cryptography */
4216/****************************************************************/
4217
Gilles Peskinee553c652018-06-04 16:22:46 +02004218static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004219 mbedtls_svc_key_id_t key,
Gilles Peskine7e928852018-06-04 16:23:10 +02004220 psa_algorithm_t alg,
4221 mbedtls_operation_t cipher_operation )
mohammad1603503973b2018-03-12 15:59:30 +02004222{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004223 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4224 psa_status_t decrement_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004225 int ret = 0;
Gilles Peskine2f060a82018-12-04 17:12:32 +01004226 psa_key_slot_t *slot;
mohammad1603503973b2018-03-12 15:59:30 +02004227 size_t key_bits;
4228 const mbedtls_cipher_info_t *cipher_info = NULL;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004229 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
4230 PSA_KEY_USAGE_ENCRYPT :
4231 PSA_KEY_USAGE_DECRYPT );
mohammad1603503973b2018-03-12 15:59:30 +02004232
Steven Cooremand3feccd2020-09-01 15:56:14 +02004233 /* A context must be freshly initialized before it can be set up. */
4234 if( operation->alg != 0 )
4235 return( PSA_ERROR_BAD_STATE );
4236
Steven Cooremana07b9972020-09-10 14:54:14 +02004237 /* The requested algorithm must be one that can be processed by cipher. */
4238 if( ! PSA_ALG_IS_CIPHER( alg ) )
Steven Cooremana07b9972020-09-10 14:54:14 +02004239 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremand3feccd2020-09-01 15:56:14 +02004240
Steven Cooremanef8575e2020-09-11 11:44:50 +02004241 /* Fetch key material from key storage. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02004242 status = psa_get_key_from_slot( key, &slot, usage, alg );
Steven Cooremanef8575e2020-09-11 11:44:50 +02004243 if( status != PSA_SUCCESS )
4244 goto exit;
4245
4246 /* Initialize the operation struct members, except for alg. The alg member
4247 * is used to indicate to psa_cipher_abort that there are resources to free,
4248 * so we only set it after resources have been allocated/initialized. */
Steven Cooremana07b9972020-09-10 14:54:14 +02004249 operation->key_set = 0;
4250 operation->iv_set = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004251 operation->mbedtls_in_use = 0;
Steven Cooremana07b9972020-09-10 14:54:14 +02004252 operation->iv_size = 0;
4253 operation->block_size = 0;
4254 if( alg == PSA_ALG_ECB_NO_PADDING )
4255 operation->iv_required = 0;
4256 else
4257 operation->iv_required = 1;
4258
Steven Cooremana07b9972020-09-10 14:54:14 +02004259 /* Try doing the operation through a driver before using software fallback. */
Steven Cooreman37941cb2020-07-28 18:49:51 +02004260 if( cipher_operation == MBEDTLS_ENCRYPT )
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004261 status = psa_driver_wrapper_cipher_encrypt_setup( &operation->ctx.driver,
Steven Cooreman37941cb2020-07-28 18:49:51 +02004262 slot,
4263 alg );
4264 else
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004265 status = psa_driver_wrapper_cipher_decrypt_setup( &operation->ctx.driver,
Steven Cooreman37941cb2020-07-28 18:49:51 +02004266 slot,
4267 alg );
4268
Steven Cooremanef8575e2020-09-11 11:44:50 +02004269 if( status == PSA_SUCCESS )
Steven Cooreman6d81f7e2020-09-14 13:14:31 +02004270 {
Steven Cooremanef8575e2020-09-11 11:44:50 +02004271 /* Once the driver context is initialised, it needs to be freed using
4272 * psa_cipher_abort. Indicate this through setting alg. */
4273 operation->alg = alg;
Steven Cooreman6d81f7e2020-09-14 13:14:31 +02004274 }
Steven Cooremanef8575e2020-09-11 11:44:50 +02004275
Steven Cooremand3feccd2020-09-01 15:56:14 +02004276 if( status != PSA_ERROR_NOT_SUPPORTED ||
4277 psa_key_lifetime_is_external( slot->attr.lifetime ) )
4278 goto exit;
4279
Steven Cooremana07b9972020-09-10 14:54:14 +02004280 /* Proceed with initializing an mbed TLS cipher context if no driver is
Steven Cooremand3feccd2020-09-01 15:56:14 +02004281 * available for the given algorithm & key. */
4282 mbedtls_cipher_init( &operation->ctx.cipher );
mohammad1603503973b2018-03-12 15:59:30 +02004283
Steven Cooremana07b9972020-09-10 14:54:14 +02004284 /* Once the cipher context is initialised, it needs to be freed using
Steven Cooremanef8575e2020-09-11 11:44:50 +02004285 * psa_cipher_abort. Indicate there is something to be freed through setting
4286 * alg, and indicate the operation is being done using mbedtls crypto through
4287 * setting mbedtls_in_use. */
Steven Cooremana07b9972020-09-10 14:54:14 +02004288 operation->alg = alg;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004289 operation->mbedtls_in_use = 1;
Steven Cooremana07b9972020-09-10 14:54:14 +02004290
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02004291 key_bits = psa_get_key_slot_bits( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +02004292 cipher_info = mbedtls_cipher_info_from_psa( alg, slot->attr.type, key_bits, NULL );
mohammad1603503973b2018-03-12 15:59:30 +02004293 if( cipher_info == NULL )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004294 {
4295 status = PSA_ERROR_NOT_SUPPORTED;
4296 goto exit;
4297 }
mohammad1603503973b2018-03-12 15:59:30 +02004298
mohammad1603503973b2018-03-12 15:59:30 +02004299 ret = mbedtls_cipher_setup( &operation->ctx.cipher, cipher_info );
Moran Peker41deec42018-04-04 15:43:05 +03004300 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004301 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004302
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004303#if defined(MBEDTLS_DES_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02004304 if( slot->attr.type == PSA_KEY_TYPE_DES && key_bits == 128 )
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004305 {
4306 /* Two-key Triple-DES is 3-key Triple-DES with K1=K3 */
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02004307 uint8_t keys[24];
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004308 memcpy( keys, slot->data.key.data, 16 );
4309 memcpy( keys + 16, slot->data.key.data, 8 );
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004310 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
4311 keys,
4312 192, cipher_operation );
4313 }
4314 else
4315#endif
4316 {
4317 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004318 slot->data.key.data,
Jaeden Amero23bbb752018-06-26 14:16:54 +01004319 (int) key_bits, cipher_operation );
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004320 }
Moran Peker41deec42018-04-04 15:43:05 +03004321 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004322 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004323
mohammad16038481e742018-03-18 13:57:31 +02004324#if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004325 switch( alg )
mohammad16038481e742018-03-18 13:57:31 +02004326 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004327 case PSA_ALG_CBC_NO_PADDING:
4328 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
4329 MBEDTLS_PADDING_NONE );
4330 break;
4331 case PSA_ALG_CBC_PKCS7:
4332 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
4333 MBEDTLS_PADDING_PKCS7 );
4334 break;
4335 default:
4336 /* The algorithm doesn't involve padding. */
4337 ret = 0;
4338 break;
4339 }
4340 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004341 goto exit;
mohammad16038481e742018-03-18 13:57:31 +02004342#endif //MBEDTLS_CIPHER_MODE_WITH_PADDING
4343
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004344 operation->block_size = ( PSA_ALG_IS_STREAM_CIPHER( alg ) ? 1 :
Gilles Peskine8e338702019-07-30 20:06:31 +02004345 PSA_BLOCK_CIPHER_BLOCK_SIZE( slot->attr.type ) );
Steven Cooremana6033e92020-08-25 11:47:50 +02004346 if( ( alg & PSA_ALG_CIPHER_FROM_BLOCK_FLAG ) != 0 &&
4347 alg != PSA_ALG_ECB_NO_PADDING )
mohammad16038481e742018-03-18 13:57:31 +02004348 {
Gilles Peskine8e338702019-07-30 20:06:31 +02004349 operation->iv_size = PSA_BLOCK_CIPHER_BLOCK_SIZE( slot->attr.type );
mohammad16038481e742018-03-18 13:57:31 +02004350 }
Gilles Peskine26869f22019-05-06 15:25:00 +02004351#if defined(MBEDTLS_CHACHA20_C)
4352 else
4353 if( alg == PSA_ALG_CHACHA20 )
4354 operation->iv_size = 12;
4355#endif
mohammad1603503973b2018-03-12 15:59:30 +02004356
Steven Cooreman7df02922020-09-09 15:28:49 +02004357 status = PSA_SUCCESS;
4358
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004359exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02004360 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004361 status = mbedtls_to_psa_error( ret );
Steven Cooreman7df02922020-09-09 15:28:49 +02004362 if( status == PSA_SUCCESS )
4363 {
4364 /* Update operation flags for both driver and software implementations */
4365 operation->key_set = 1;
4366 }
4367 else
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004368 psa_cipher_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004369
4370 decrement_status = psa_decrement_key_slot_access_count( slot );
4371
4372 return( ( status == PSA_SUCCESS ) ? decrement_status : status );
mohammad1603503973b2018-03-12 15:59:30 +02004373}
4374
Gilles Peskinefe119512018-07-08 21:39:34 +02004375psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004376 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02004377 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02004378{
Ronald Croncf56a0a2020-08-04 09:51:30 +02004379 return( psa_cipher_setup( operation, key, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02004380}
4381
Gilles Peskinefe119512018-07-08 21:39:34 +02004382psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004383 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02004384 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02004385{
Ronald Croncf56a0a2020-08-04 09:51:30 +02004386 return( psa_cipher_setup( operation, key, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02004387}
4388
Gilles Peskinefe119512018-07-08 21:39:34 +02004389psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004390 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02004391 size_t iv_size,
4392 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02004393{
itayzafrir534bd7c2018-08-02 13:56:32 +03004394 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00004395 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooreman7df02922020-09-09 15:28:49 +02004396 if( operation->iv_set || ! operation->iv_required )
4397 {
4398 return( PSA_ERROR_BAD_STATE );
4399 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004400
Steven Cooremanef8575e2020-09-11 11:44:50 +02004401 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004402 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004403 status = psa_driver_wrapper_cipher_generate_iv( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004404 iv,
4405 iv_size,
4406 iv_length );
4407 goto exit;
4408 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004409
Moran Peker41deec42018-04-04 15:43:05 +03004410 if( iv_size < operation->iv_size )
mohammad1603503973b2018-03-12 15:59:30 +02004411 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004412 status = PSA_ERROR_BUFFER_TOO_SMALL;
Moran Peker41deec42018-04-04 15:43:05 +03004413 goto exit;
4414 }
Gilles Peskine7e928852018-06-04 16:23:10 +02004415 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg,
4416 iv, operation->iv_size );
Moran Peker41deec42018-04-04 15:43:05 +03004417 if( ret != 0 )
4418 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004419 status = mbedtls_to_psa_error( ret );
Gilles Peskinee553c652018-06-04 16:22:46 +02004420 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004421 }
Gilles Peskinee553c652018-06-04 16:22:46 +02004422
mohammad16038481e742018-03-18 13:57:31 +02004423 *iv_length = operation->iv_size;
itayzafrir534bd7c2018-08-02 13:56:32 +03004424 status = psa_cipher_set_iv( operation, iv, *iv_length );
Moran Peker41deec42018-04-04 15:43:05 +03004425
Moran Peker395db872018-05-31 14:07:14 +03004426exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02004427 if( status == PSA_SUCCESS )
4428 operation->iv_set = 1;
4429 else
Moran Peker395db872018-05-31 14:07:14 +03004430 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004431 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004432}
4433
Gilles Peskinefe119512018-07-08 21:39:34 +02004434psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004435 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02004436 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02004437{
itayzafrir534bd7c2018-08-02 13:56:32 +03004438 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00004439 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooreman7df02922020-09-09 15:28:49 +02004440 if( operation->iv_set || ! operation->iv_required )
4441 {
4442 return( PSA_ERROR_BAD_STATE );
4443 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004444
Steven Cooremanef8575e2020-09-11 11:44:50 +02004445 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004446 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004447 status = psa_driver_wrapper_cipher_set_iv( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004448 iv,
4449 iv_length );
4450 goto exit;
4451 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004452
Moran Pekera28258c2018-05-29 16:25:04 +03004453 if( iv_length != operation->iv_size )
Moran Peker71f19ae2018-04-22 20:23:16 +03004454 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004455 status = PSA_ERROR_INVALID_ARGUMENT;
4456 goto exit;
Moran Peker71f19ae2018-04-22 20:23:16 +03004457 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004458 ret = mbedtls_cipher_set_iv( &operation->ctx.cipher, iv, iv_length );
4459 status = mbedtls_to_psa_error( ret );
4460exit:
4461 if( status == PSA_SUCCESS )
4462 operation->iv_set = 1;
4463 else
mohammad1603503973b2018-03-12 15:59:30 +02004464 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004465 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004466}
4467
Steven Cooreman177deba2020-09-07 17:14:14 +02004468/* Process input for which the algorithm is set to ECB mode. This requires
4469 * manual processing, since the PSA API is defined as being able to process
4470 * arbitrary-length calls to psa_cipher_update() with ECB mode, but the
4471 * underlying mbedtls_cipher_update only takes full blocks. */
4472static psa_status_t psa_cipher_update_ecb_internal(
4473 mbedtls_cipher_context_t *ctx,
4474 const uint8_t *input,
4475 size_t input_length,
4476 uint8_t *output,
4477 size_t output_size,
4478 size_t *output_length )
4479{
4480 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4481 size_t block_size = ctx->cipher_info->block_size;
4482 size_t internal_output_length = 0;
4483 *output_length = 0;
4484
4485 if( input_length == 0 )
4486 {
4487 status = PSA_SUCCESS;
4488 goto exit;
4489 }
4490
4491 if( ctx->unprocessed_len > 0 )
4492 {
4493 /* Fill up to block size, and run the block if there's a full one. */
4494 size_t bytes_to_copy = block_size - ctx->unprocessed_len;
4495
4496 if( input_length < bytes_to_copy )
4497 bytes_to_copy = input_length;
4498
4499 memcpy( &( ctx->unprocessed_data[ctx->unprocessed_len] ),
4500 input, bytes_to_copy );
4501 input_length -= bytes_to_copy;
4502 input += bytes_to_copy;
4503 ctx->unprocessed_len += bytes_to_copy;
4504
4505 if( ctx->unprocessed_len == block_size )
4506 {
4507 status = mbedtls_to_psa_error(
4508 mbedtls_cipher_update( ctx,
4509 ctx->unprocessed_data,
4510 block_size,
4511 output, &internal_output_length ) );
4512
4513 if( status != PSA_SUCCESS )
4514 goto exit;
4515
4516 output += internal_output_length;
4517 output_size -= internal_output_length;
4518 *output_length += internal_output_length;
4519 ctx->unprocessed_len = 0;
4520 }
4521 }
4522
4523 while( input_length >= block_size )
4524 {
4525 /* Run all full blocks we have, one by one */
4526 status = mbedtls_to_psa_error(
4527 mbedtls_cipher_update( ctx, input,
4528 block_size,
4529 output, &internal_output_length ) );
4530
4531 if( status != PSA_SUCCESS )
4532 goto exit;
4533
4534 input_length -= block_size;
4535 input += block_size;
4536
4537 output += internal_output_length;
4538 output_size -= internal_output_length;
4539 *output_length += internal_output_length;
4540 }
4541
4542 if( input_length > 0 )
4543 {
4544 /* Save unprocessed bytes for later processing */
4545 memcpy( &( ctx->unprocessed_data[ctx->unprocessed_len] ),
4546 input, input_length );
4547 ctx->unprocessed_len += input_length;
4548 }
4549
4550 status = PSA_SUCCESS;
4551
4552exit:
4553 return( status );
4554}
4555
Gilles Peskinee553c652018-06-04 16:22:46 +02004556psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
4557 const uint8_t *input,
4558 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004559 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02004560 size_t output_size,
4561 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02004562{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004563 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine89d789c2018-06-04 17:17:16 +02004564 size_t expected_output_size;
Steven Cooreman7df02922020-09-09 15:28:49 +02004565 if( operation->alg == 0 )
4566 {
4567 return( PSA_ERROR_BAD_STATE );
4568 }
4569 if( operation->iv_required && ! operation->iv_set )
4570 {
4571 return( PSA_ERROR_BAD_STATE );
4572 }
Jaeden Ameroab439972019-02-15 14:12:05 +00004573
Steven Cooremanef8575e2020-09-11 11:44:50 +02004574 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004575 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004576 status = psa_driver_wrapper_cipher_update( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004577 input,
4578 input_length,
4579 output,
4580 output_size,
4581 output_length );
4582 goto exit;
4583 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004584
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004585 if( ! PSA_ALG_IS_STREAM_CIPHER( operation->alg ) )
Gilles Peskine89d789c2018-06-04 17:17:16 +02004586 {
4587 /* Take the unprocessed partial block left over from previous
4588 * update calls, if any, plus the input to this call. Remove
4589 * the last partial block, if any. You get the data that will be
4590 * output in this call. */
4591 expected_output_size =
4592 ( operation->ctx.cipher.unprocessed_len + input_length )
4593 / operation->block_size * operation->block_size;
4594 }
4595 else
4596 {
4597 expected_output_size = input_length;
4598 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004599
Gilles Peskine89d789c2018-06-04 17:17:16 +02004600 if( output_size < expected_output_size )
itayzafrir534bd7c2018-08-02 13:56:32 +03004601 {
4602 status = PSA_ERROR_BUFFER_TOO_SMALL;
4603 goto exit;
4604 }
mohammad160382759612018-03-12 18:16:40 +02004605
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004606 if( operation->alg == PSA_ALG_ECB_NO_PADDING )
4607 {
4608 /* mbedtls_cipher_update has an API inconsistency: it will only
4609 * process a single block at a time in ECB mode. Abstract away that
4610 * inconsistency here to match the PSA API behaviour. */
Steven Cooreman177deba2020-09-07 17:14:14 +02004611 status = psa_cipher_update_ecb_internal( &operation->ctx.cipher,
4612 input,
4613 input_length,
4614 output,
4615 output_size,
4616 output_length );
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004617 }
4618 else
4619 {
4620 status = mbedtls_to_psa_error(
4621 mbedtls_cipher_update( &operation->ctx.cipher, input,
4622 input_length, output, output_length ) );
4623 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004624exit:
4625 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02004626 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004627 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004628}
4629
Gilles Peskinee553c652018-06-04 16:22:46 +02004630psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
4631 uint8_t *output,
4632 size_t output_size,
4633 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02004634{
David Saadab4ecc272019-02-14 13:48:10 +02004635 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Gilles Peskinee553c652018-06-04 16:22:46 +02004636 uint8_t temp_output_buffer[MBEDTLS_MAX_BLOCK_LENGTH];
Steven Cooreman7df02922020-09-09 15:28:49 +02004637 if( operation->alg == 0 )
4638 {
4639 return( PSA_ERROR_BAD_STATE );
4640 }
4641 if( operation->iv_required && ! operation->iv_set )
4642 {
4643 return( PSA_ERROR_BAD_STATE );
4644 }
Moran Pekerbed71a22018-04-22 20:19:20 +03004645
Steven Cooremanef8575e2020-09-11 11:44:50 +02004646 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004647 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004648 status = psa_driver_wrapper_cipher_finish( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004649 output,
4650 output_size,
4651 output_length );
Steven Cooremanef8575e2020-09-11 11:44:50 +02004652 goto exit;
Steven Cooreman8b122252020-09-03 15:30:32 +02004653 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004654
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004655 if( operation->ctx.cipher.unprocessed_len != 0 )
Moran Peker7cb22b82018-06-05 11:40:02 +03004656 {
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004657 if( operation->alg == PSA_ALG_ECB_NO_PADDING ||
Fredrik Strupef90e3012020-09-28 16:11:33 +02004658 operation->alg == PSA_ALG_CBC_NO_PADDING )
Steven Cooremana6033e92020-08-25 11:47:50 +02004659 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004660 status = PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004661 goto exit;
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004662 }
Moran Pekerdc38ebc2018-04-30 15:45:34 +03004663 }
4664
Steven Cooremanef8575e2020-09-11 11:44:50 +02004665 status = mbedtls_to_psa_error(
4666 mbedtls_cipher_finish( &operation->ctx.cipher,
4667 temp_output_buffer,
4668 output_length ) );
4669 if( status != PSA_SUCCESS )
4670 goto exit;
Janos Follath315b51c2018-07-09 16:04:51 +01004671
Gilles Peskine46f1fd72018-06-28 19:31:31 +02004672 if( *output_length == 0 )
Janos Follath315b51c2018-07-09 16:04:51 +01004673 ; /* Nothing to copy. Note that output may be NULL in this case. */
Gilles Peskine46f1fd72018-06-28 19:31:31 +02004674 else if( output_size >= *output_length )
Moran Pekerdc38ebc2018-04-30 15:45:34 +03004675 memcpy( output, temp_output_buffer, *output_length );
4676 else
Janos Follath315b51c2018-07-09 16:04:51 +01004677 status = PSA_ERROR_BUFFER_TOO_SMALL;
mohammad1603503973b2018-03-12 15:59:30 +02004678
Steven Cooremanef8575e2020-09-11 11:44:50 +02004679exit:
4680 if( operation->mbedtls_in_use == 1 )
4681 mbedtls_platform_zeroize( temp_output_buffer, sizeof( temp_output_buffer ) );
Janos Follath315b51c2018-07-09 16:04:51 +01004682
Steven Cooremanef8575e2020-09-11 11:44:50 +02004683 if( status == PSA_SUCCESS )
4684 return( psa_cipher_abort( operation ) );
4685 else
4686 {
4687 *output_length = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004688 (void) psa_cipher_abort( operation );
Janos Follath315b51c2018-07-09 16:04:51 +01004689
Steven Cooremanef8575e2020-09-11 11:44:50 +02004690 return( status );
4691 }
mohammad1603503973b2018-03-12 15:59:30 +02004692}
4693
Gilles Peskinee553c652018-06-04 16:22:46 +02004694psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
4695{
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004696 if( operation->alg == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02004697 {
Steven Cooremana07b9972020-09-10 14:54:14 +02004698 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02004699 * in use. It's ok to call abort on such an object, and there's
4700 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004701 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02004702 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004703
Gilles Peskinef9c2c092018-06-21 16:57:07 +02004704 /* Sanity check (shouldn't happen: operation->alg should
4705 * always have been initialized to a valid value). */
4706 if( ! PSA_ALG_IS_CIPHER( operation->alg ) )
4707 return( PSA_ERROR_BAD_STATE );
4708
Steven Cooremanef8575e2020-09-11 11:44:50 +02004709 if( operation->mbedtls_in_use == 0 )
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004710 psa_driver_wrapper_cipher_abort( &operation->ctx.driver );
Steven Cooremand3feccd2020-09-01 15:56:14 +02004711 else
4712 mbedtls_cipher_free( &operation->ctx.cipher );
Gilles Peskinee553c652018-06-04 16:22:46 +02004713
Moran Peker41deec42018-04-04 15:43:05 +03004714 operation->alg = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004715 operation->key_set = 0;
4716 operation->iv_set = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004717 operation->mbedtls_in_use = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004718 operation->iv_size = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004719 operation->block_size = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004720 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004721
Moran Peker395db872018-05-31 14:07:14 +03004722 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02004723}
4724
Gilles Peskinea0655c32018-04-30 17:06:50 +02004725
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004726
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004727
mohammad16035955c982018-04-26 00:53:03 +03004728/****************************************************************/
4729/* AEAD */
4730/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004731
Gilles Peskineedf9a652018-08-17 18:11:56 +02004732typedef struct
4733{
Gilles Peskine2f060a82018-12-04 17:12:32 +01004734 psa_key_slot_t *slot;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004735 const mbedtls_cipher_info_t *cipher_info;
4736 union
4737 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02004738 unsigned dummy; /* Make the union non-empty even with no supported algorithms. */
Gilles Peskineedf9a652018-08-17 18:11:56 +02004739#if defined(MBEDTLS_CCM_C)
4740 mbedtls_ccm_context ccm;
4741#endif /* MBEDTLS_CCM_C */
4742#if defined(MBEDTLS_GCM_C)
4743 mbedtls_gcm_context gcm;
4744#endif /* MBEDTLS_GCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004745#if defined(MBEDTLS_CHACHAPOLY_C)
4746 mbedtls_chachapoly_context chachapoly;
4747#endif /* MBEDTLS_CHACHAPOLY_C */
Gilles Peskineedf9a652018-08-17 18:11:56 +02004748 } ctx;
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004749 psa_algorithm_t core_alg;
4750 uint8_t full_tag_length;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004751 uint8_t tag_length;
4752} aead_operation_t;
4753
Ronald Cronf95a2b12020-10-22 15:24:49 +02004754#define AEAD_OPERATION_INIT {0, 0, {0}, 0, 0, 0}
4755
Gilles Peskine30a9e412019-01-14 18:36:12 +01004756static void psa_aead_abort_internal( aead_operation_t *operation )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004757{
Gilles Peskinef8a8fe62018-08-21 16:38:05 +02004758 switch( operation->core_alg )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004759 {
4760#if defined(MBEDTLS_CCM_C)
4761 case PSA_ALG_CCM:
4762 mbedtls_ccm_free( &operation->ctx.ccm );
4763 break;
4764#endif /* MBEDTLS_CCM_C */
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004765#if defined(MBEDTLS_GCM_C)
Gilles Peskineedf9a652018-08-17 18:11:56 +02004766 case PSA_ALG_GCM:
4767 mbedtls_gcm_free( &operation->ctx.gcm );
4768 break;
4769#endif /* MBEDTLS_GCM_C */
4770 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004771
4772 psa_decrement_key_slot_access_count( operation->slot );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004773}
4774
4775static psa_status_t psa_aead_setup( aead_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004776 mbedtls_svc_key_id_t key,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004777 psa_key_usage_t usage,
4778 psa_algorithm_t alg )
4779{
4780 psa_status_t status;
4781 size_t key_bits;
4782 mbedtls_cipher_id_t cipher_id;
4783
Ronald Croncf56a0a2020-08-04 09:51:30 +02004784 status = psa_get_transparent_key( key, &operation->slot, usage, alg );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004785 if( status != PSA_SUCCESS )
4786 return( status );
4787
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02004788 key_bits = psa_get_key_slot_bits( operation->slot );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004789
4790 operation->cipher_info =
Gilles Peskine8e338702019-07-30 20:06:31 +02004791 mbedtls_cipher_info_from_psa( alg, operation->slot->attr.type, key_bits,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004792 &cipher_id );
4793 if( operation->cipher_info == NULL )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004794 {
4795 status = PSA_ERROR_NOT_SUPPORTED;
4796 goto cleanup;
4797 }
Gilles Peskineedf9a652018-08-17 18:11:56 +02004798
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004799 switch( PSA_ALG_AEAD_WITH_TAG_LENGTH( alg, 0 ) )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004800 {
4801#if defined(MBEDTLS_CCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004802 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CCM, 0 ):
4803 operation->core_alg = PSA_ALG_CCM;
4804 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004805 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.
4806 * The call to mbedtls_ccm_encrypt_and_tag or
4807 * mbedtls_ccm_auth_decrypt will validate the tag length. */
Gilles Peskine8e338702019-07-30 20:06:31 +02004808 if( PSA_BLOCK_CIPHER_BLOCK_SIZE( operation->slot->attr.type ) != 16 )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004809 {
4810 status = PSA_ERROR_INVALID_ARGUMENT;
4811 goto cleanup;
4812 }
Gilles Peskineedf9a652018-08-17 18:11:56 +02004813 mbedtls_ccm_init( &operation->ctx.ccm );
4814 status = mbedtls_to_psa_error(
4815 mbedtls_ccm_setkey( &operation->ctx.ccm, cipher_id,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004816 operation->slot->data.key.data,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004817 (unsigned int) key_bits ) );
4818 if( status != 0 )
4819 goto cleanup;
4820 break;
4821#endif /* MBEDTLS_CCM_C */
4822
4823#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004824 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_GCM, 0 ):
4825 operation->core_alg = PSA_ALG_GCM;
4826 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004827 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16.
4828 * The call to mbedtls_gcm_crypt_and_tag or
4829 * mbedtls_gcm_auth_decrypt will validate the tag length. */
Gilles Peskine8e338702019-07-30 20:06:31 +02004830 if( PSA_BLOCK_CIPHER_BLOCK_SIZE( operation->slot->attr.type ) != 16 )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004831 {
4832 status = PSA_ERROR_INVALID_ARGUMENT;
4833 goto cleanup;
4834 }
Gilles Peskineedf9a652018-08-17 18:11:56 +02004835 mbedtls_gcm_init( &operation->ctx.gcm );
4836 status = mbedtls_to_psa_error(
4837 mbedtls_gcm_setkey( &operation->ctx.gcm, cipher_id,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004838 operation->slot->data.key.data,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004839 (unsigned int) key_bits ) );
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004840 if( status != 0 )
4841 goto cleanup;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004842 break;
4843#endif /* MBEDTLS_GCM_C */
4844
Gilles Peskine26869f22019-05-06 15:25:00 +02004845#if defined(MBEDTLS_CHACHAPOLY_C)
4846 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CHACHA20_POLY1305, 0 ):
4847 operation->core_alg = PSA_ALG_CHACHA20_POLY1305;
4848 operation->full_tag_length = 16;
4849 /* We only support the default tag length. */
4850 if( alg != PSA_ALG_CHACHA20_POLY1305 )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004851 {
4852 status = PSA_ERROR_NOT_SUPPORTED;
4853 goto cleanup;
4854 }
Gilles Peskine26869f22019-05-06 15:25:00 +02004855 mbedtls_chachapoly_init( &operation->ctx.chachapoly );
4856 status = mbedtls_to_psa_error(
4857 mbedtls_chachapoly_setkey( &operation->ctx.chachapoly,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004858 operation->slot->data.key.data ) );
Gilles Peskine26869f22019-05-06 15:25:00 +02004859 if( status != 0 )
4860 goto cleanup;
4861 break;
4862#endif /* MBEDTLS_CHACHAPOLY_C */
4863
Gilles Peskineedf9a652018-08-17 18:11:56 +02004864 default:
Ronald Cronf95a2b12020-10-22 15:24:49 +02004865 status = PSA_ERROR_NOT_SUPPORTED;
4866 goto cleanup;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004867 }
4868
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004869 if( PSA_AEAD_TAG_LENGTH( alg ) > operation->full_tag_length )
4870 {
4871 status = PSA_ERROR_INVALID_ARGUMENT;
4872 goto cleanup;
4873 }
4874 operation->tag_length = PSA_AEAD_TAG_LENGTH( alg );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004875
Gilles Peskineedf9a652018-08-17 18:11:56 +02004876 return( PSA_SUCCESS );
4877
4878cleanup:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004879 psa_aead_abort_internal( operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004880 return( status );
4881}
4882
Ronald Croncf56a0a2020-08-04 09:51:30 +02004883psa_status_t psa_aead_encrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03004884 psa_algorithm_t alg,
4885 const uint8_t *nonce,
4886 size_t nonce_length,
4887 const uint8_t *additional_data,
4888 size_t additional_data_length,
4889 const uint8_t *plaintext,
4890 size_t plaintext_length,
4891 uint8_t *ciphertext,
4892 size_t ciphertext_size,
4893 size_t *ciphertext_length )
4894{
mohammad16035955c982018-04-26 00:53:03 +03004895 psa_status_t status;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004896 aead_operation_t operation = AEAD_OPERATION_INIT;
mohammad160315223a82018-06-03 17:19:55 +03004897 uint8_t *tag;
Gilles Peskine2d277862018-06-18 15:41:12 +02004898
mohammad1603f08a5502018-06-03 15:05:47 +03004899 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004900
Ronald Croncf56a0a2020-08-04 09:51:30 +02004901 status = psa_aead_setup( &operation, key, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004902 if( status != PSA_SUCCESS )
4903 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004904
Gilles Peskineedf9a652018-08-17 18:11:56 +02004905 /* For all currently supported modes, the tag is at the end of the
4906 * ciphertext. */
4907 if( ciphertext_size < ( plaintext_length + operation.tag_length ) )
4908 {
4909 status = PSA_ERROR_BUFFER_TOO_SMALL;
4910 goto exit;
4911 }
4912 tag = ciphertext + plaintext_length;
mohammad16035955c982018-04-26 00:53:03 +03004913
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004914#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004915 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03004916 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004917 status = mbedtls_to_psa_error(
4918 mbedtls_gcm_crypt_and_tag( &operation.ctx.gcm,
4919 MBEDTLS_GCM_ENCRYPT,
4920 plaintext_length,
4921 nonce, nonce_length,
4922 additional_data, additional_data_length,
4923 plaintext, ciphertext,
4924 operation.tag_length, tag ) );
mohammad16035955c982018-04-26 00:53:03 +03004925 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004926 else
4927#endif /* MBEDTLS_GCM_C */
4928#if defined(MBEDTLS_CCM_C)
4929 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03004930 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004931 status = mbedtls_to_psa_error(
4932 mbedtls_ccm_encrypt_and_tag( &operation.ctx.ccm,
4933 plaintext_length,
4934 nonce, nonce_length,
4935 additional_data,
4936 additional_data_length,
4937 plaintext, ciphertext,
4938 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03004939 }
mohammad16035c8845f2018-05-09 05:40:09 -07004940 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004941#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004942#if defined(MBEDTLS_CHACHAPOLY_C)
4943 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
4944 {
4945 if( nonce_length != 12 || operation.tag_length != 16 )
4946 {
4947 status = PSA_ERROR_NOT_SUPPORTED;
4948 goto exit;
4949 }
4950 status = mbedtls_to_psa_error(
4951 mbedtls_chachapoly_encrypt_and_tag( &operation.ctx.chachapoly,
4952 plaintext_length,
4953 nonce,
4954 additional_data,
4955 additional_data_length,
4956 plaintext,
4957 ciphertext,
4958 tag ) );
4959 }
4960 else
4961#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad16035c8845f2018-05-09 05:40:09 -07004962 {
mohammad1603554faad2018-06-03 15:07:38 +03004963 return( PSA_ERROR_NOT_SUPPORTED );
mohammad16035c8845f2018-05-09 05:40:09 -07004964 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004965
Gilles Peskineedf9a652018-08-17 18:11:56 +02004966 if( status != PSA_SUCCESS && ciphertext_size != 0 )
4967 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02004968
Gilles Peskineedf9a652018-08-17 18:11:56 +02004969exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004970 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004971 if( status == PSA_SUCCESS )
4972 *ciphertext_length = plaintext_length + operation.tag_length;
4973 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004974}
4975
Gilles Peskineee652a32018-06-01 19:23:52 +02004976/* Locate the tag in a ciphertext buffer containing the encrypted data
4977 * followed by the tag. Return the length of the part preceding the tag in
4978 * *plaintext_length. This is the size of the plaintext in modes where
4979 * the encrypted data has the same size as the plaintext, such as
4980 * CCM and GCM. */
4981static psa_status_t psa_aead_unpadded_locate_tag( size_t tag_length,
4982 const uint8_t *ciphertext,
4983 size_t ciphertext_length,
4984 size_t plaintext_size,
Gilles Peskineee652a32018-06-01 19:23:52 +02004985 const uint8_t **p_tag )
4986{
4987 size_t payload_length;
4988 if( tag_length > ciphertext_length )
4989 return( PSA_ERROR_INVALID_ARGUMENT );
4990 payload_length = ciphertext_length - tag_length;
4991 if( payload_length > plaintext_size )
4992 return( PSA_ERROR_BUFFER_TOO_SMALL );
4993 *p_tag = ciphertext + payload_length;
Gilles Peskineee652a32018-06-01 19:23:52 +02004994 return( PSA_SUCCESS );
4995}
4996
Ronald Croncf56a0a2020-08-04 09:51:30 +02004997psa_status_t psa_aead_decrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03004998 psa_algorithm_t alg,
4999 const uint8_t *nonce,
5000 size_t nonce_length,
5001 const uint8_t *additional_data,
5002 size_t additional_data_length,
5003 const uint8_t *ciphertext,
5004 size_t ciphertext_length,
5005 uint8_t *plaintext,
5006 size_t plaintext_size,
5007 size_t *plaintext_length )
5008{
mohammad16035955c982018-04-26 00:53:03 +03005009 psa_status_t status;
Ronald Cronf95a2b12020-10-22 15:24:49 +02005010 aead_operation_t operation = AEAD_OPERATION_INIT;
Gilles Peskineedf9a652018-08-17 18:11:56 +02005011 const uint8_t *tag = NULL;
Gilles Peskine2d277862018-06-18 15:41:12 +02005012
Gilles Peskineee652a32018-06-01 19:23:52 +02005013 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03005014
Ronald Croncf56a0a2020-08-04 09:51:30 +02005015 status = psa_aead_setup( &operation, key, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02005016 if( status != PSA_SUCCESS )
5017 return( status );
mohammad16035955c982018-04-26 00:53:03 +03005018
Gilles Peskinef7e7b012019-05-06 15:27:16 +02005019 status = psa_aead_unpadded_locate_tag( operation.tag_length,
5020 ciphertext, ciphertext_length,
5021 plaintext_size, &tag );
5022 if( status != PSA_SUCCESS )
5023 goto exit;
5024
Gilles Peskineb0b189f2018-11-28 17:30:58 +01005025#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02005026 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03005027 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02005028 status = mbedtls_to_psa_error(
5029 mbedtls_gcm_auth_decrypt( &operation.ctx.gcm,
5030 ciphertext_length - operation.tag_length,
5031 nonce, nonce_length,
5032 additional_data,
5033 additional_data_length,
5034 tag, operation.tag_length,
5035 ciphertext, plaintext ) );
mohammad16035955c982018-04-26 00:53:03 +03005036 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01005037 else
5038#endif /* MBEDTLS_GCM_C */
5039#if defined(MBEDTLS_CCM_C)
5040 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03005041 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02005042 status = mbedtls_to_psa_error(
5043 mbedtls_ccm_auth_decrypt( &operation.ctx.ccm,
5044 ciphertext_length - operation.tag_length,
5045 nonce, nonce_length,
5046 additional_data,
5047 additional_data_length,
5048 ciphertext, plaintext,
5049 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03005050 }
mohammad160339574652018-06-01 04:39:53 -07005051 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01005052#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02005053#if defined(MBEDTLS_CHACHAPOLY_C)
5054 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
5055 {
5056 if( nonce_length != 12 || operation.tag_length != 16 )
5057 {
5058 status = PSA_ERROR_NOT_SUPPORTED;
5059 goto exit;
5060 }
5061 status = mbedtls_to_psa_error(
5062 mbedtls_chachapoly_auth_decrypt( &operation.ctx.chachapoly,
5063 ciphertext_length - operation.tag_length,
5064 nonce,
5065 additional_data,
5066 additional_data_length,
5067 tag,
5068 ciphertext,
5069 plaintext ) );
5070 }
5071 else
5072#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad160339574652018-06-01 04:39:53 -07005073 {
mohammad1603554faad2018-06-03 15:07:38 +03005074 return( PSA_ERROR_NOT_SUPPORTED );
mohammad160339574652018-06-01 04:39:53 -07005075 }
Gilles Peskinea40d7742018-06-01 16:28:30 +02005076
Gilles Peskineedf9a652018-08-17 18:11:56 +02005077 if( status != PSA_SUCCESS && plaintext_size != 0 )
5078 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03005079
Gilles Peskineedf9a652018-08-17 18:11:56 +02005080exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01005081 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02005082 if( status == PSA_SUCCESS )
5083 *plaintext_length = ciphertext_length - operation.tag_length;
5084 return( status );
mohammad16035955c982018-04-26 00:53:03 +03005085}
5086
Gilles Peskinea0655c32018-04-30 17:06:50 +02005087
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02005088
Gilles Peskine20035e32018-02-03 22:44:14 +01005089/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02005090/* Generators */
5091/****************************************************************/
5092
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005093#define HKDF_STATE_INIT 0 /* no input yet */
5094#define HKDF_STATE_STARTED 1 /* got salt */
5095#define HKDF_STATE_KEYED 2 /* got key */
5096#define HKDF_STATE_OUTPUT 3 /* output started */
5097
Gilles Peskinecbe66502019-05-16 16:59:18 +02005098static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005099 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005100{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005101 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
5102 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005103 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005104 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005105}
5106
5107
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005108psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005109{
5110 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005111 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005112 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005113 {
5114 /* The object has (apparently) been initialized but it is not
5115 * in use. It's ok to call abort on such an object, and there's
5116 * nothing to do. */
5117 }
5118 else
Gilles Peskinebef7f142018-07-12 17:22:21 +02005119#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005120 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02005121 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005122 mbedtls_free( operation->ctx.hkdf.info );
5123 status = psa_hmac_abort_internal( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02005124 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01005125 else if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005126 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01005127 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005128 {
Janos Follath6a1d2622019-06-11 10:37:28 +01005129 if( operation->ctx.tls12_prf.seed != NULL )
5130 {
5131 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
5132 operation->ctx.tls12_prf.seed_length );
5133 mbedtls_free( operation->ctx.tls12_prf.seed );
5134 }
5135
5136 if( operation->ctx.tls12_prf.label != NULL )
5137 {
5138 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
5139 operation->ctx.tls12_prf.label_length );
5140 mbedtls_free( operation->ctx.tls12_prf.label );
5141 }
5142
5143 status = psa_hmac_abort_internal( &operation->ctx.tls12_prf.hmac );
5144
5145 /* We leave the fields Ai and output_block to be erased safely by the
5146 * mbedtls_platform_zeroize() in the end of this function. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005147 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005148 else
5149#endif /* MBEDTLS_MD_C */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005150 {
5151 status = PSA_ERROR_BAD_STATE;
5152 }
Janos Follath083036a2019-06-11 10:22:26 +01005153 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005154 return( status );
5155}
5156
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005157psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02005158 size_t *capacity)
5159{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005160 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005161 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005162 /* This is a blank key derivation operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02005163 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005164 }
5165
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005166 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005167 return( PSA_SUCCESS );
5168}
5169
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005170psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005171 size_t capacity )
5172{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005173 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005174 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005175 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005176 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005177 operation->capacity = capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005178 return( PSA_SUCCESS );
5179}
5180
Gilles Peskinebef7f142018-07-12 17:22:21 +02005181#if defined(MBEDTLS_MD_C)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005182/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02005183 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02005184static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskinebef7f142018-07-12 17:22:21 +02005185 psa_algorithm_t hash_alg,
5186 uint8_t *output,
5187 size_t output_length )
5188{
5189 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
5190 psa_status_t status;
5191
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005192 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
5193 return( PSA_ERROR_BAD_STATE );
5194 hkdf->state = HKDF_STATE_OUTPUT;
5195
Gilles Peskinebef7f142018-07-12 17:22:21 +02005196 while( output_length != 0 )
5197 {
5198 /* Copy what remains of the current block */
5199 uint8_t n = hash_length - hkdf->offset_in_block;
5200 if( n > output_length )
5201 n = (uint8_t) output_length;
5202 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
5203 output += n;
5204 output_length -= n;
5205 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02005206 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02005207 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02005208 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005209 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005210 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02005211 * object was corrupted or if this function is called directly
5212 * inside the library. */
5213 if( hkdf->block_number == 0xff )
5214 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02005215
5216 /* We need a new block */
5217 ++hkdf->block_number;
5218 hkdf->offset_in_block = 0;
5219 status = psa_hmac_setup_internal( &hkdf->hmac,
5220 hkdf->prk, hash_length,
5221 hash_alg );
5222 if( status != PSA_SUCCESS )
5223 return( status );
5224 if( hkdf->block_number != 1 )
5225 {
5226 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5227 hkdf->output_block,
5228 hash_length );
5229 if( status != PSA_SUCCESS )
5230 return( status );
5231 }
5232 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5233 hkdf->info,
5234 hkdf->info_length );
5235 if( status != PSA_SUCCESS )
5236 return( status );
5237 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5238 &hkdf->block_number, 1 );
5239 if( status != PSA_SUCCESS )
5240 return( status );
5241 status = psa_hmac_finish_internal( &hkdf->hmac,
5242 hkdf->output_block,
5243 sizeof( hkdf->output_block ) );
5244 if( status != PSA_SUCCESS )
5245 return( status );
5246 }
5247
5248 return( PSA_SUCCESS );
5249}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005250
Janos Follath7742fee2019-06-17 12:58:10 +01005251static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
5252 psa_tls12_prf_key_derivation_t *tls12_prf,
5253 psa_algorithm_t alg )
5254{
5255 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
5256 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
Janos Follathea29bfb2019-06-19 12:21:20 +01005257 psa_hash_operation_t backup = PSA_HASH_OPERATION_INIT;
5258 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005259
Janos Follath7742fee2019-06-17 12:58:10 +01005260 /* We can't be wanting more output after block 0xff, otherwise
5261 * the capacity check in psa_key_derivation_output_bytes() would have
5262 * prevented this call. It could happen only if the operation
5263 * object was corrupted or if this function is called directly
5264 * inside the library. */
5265 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01005266 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01005267
5268 /* We need a new block */
5269 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01005270 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01005271
5272 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
5273 *
5274 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
5275 *
5276 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
5277 * HMAC_hash(secret, A(2) + seed) +
5278 * HMAC_hash(secret, A(3) + seed) + ...
5279 *
5280 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01005281 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01005282 *
Janos Follathea29bfb2019-06-19 12:21:20 +01005283 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01005284 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01005285 * is currently extracted as `output_block` and where i is
5286 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01005287 */
5288
Janos Follathea29bfb2019-06-19 12:21:20 +01005289 /* Save the hash context before using it, to preserve the hash state with
5290 * only the inner padding in it. We need this, because inner padding depends
5291 * on the key (secret in the RFC's terminology). */
5292 status = psa_hash_clone( &tls12_prf->hmac.hash_ctx, &backup );
5293 if( status != PSA_SUCCESS )
5294 goto cleanup;
5295
5296 /* Calculate A(i) where i = tls12_prf->block_number. */
5297 if( tls12_prf->block_number == 1 )
5298 {
5299 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
5300 * the variable seed and in this instance means it in the context of the
5301 * P_hash function, where seed = label + seed.) */
5302 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5303 tls12_prf->label, tls12_prf->label_length );
5304 if( status != PSA_SUCCESS )
5305 goto cleanup;
5306 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5307 tls12_prf->seed, tls12_prf->seed_length );
5308 if( status != PSA_SUCCESS )
5309 goto cleanup;
5310 }
5311 else
5312 {
5313 /* A(i) = HMAC_hash(secret, A(i-1)) */
5314 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5315 tls12_prf->Ai, hash_length );
5316 if( status != PSA_SUCCESS )
5317 goto cleanup;
5318 }
5319
5320 status = psa_hmac_finish_internal( &tls12_prf->hmac,
5321 tls12_prf->Ai, hash_length );
5322 if( status != PSA_SUCCESS )
5323 goto cleanup;
5324 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
5325 if( status != PSA_SUCCESS )
5326 goto cleanup;
5327
5328 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
5329 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5330 tls12_prf->Ai, hash_length );
5331 if( status != PSA_SUCCESS )
5332 goto cleanup;
5333 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5334 tls12_prf->label, tls12_prf->label_length );
5335 if( status != PSA_SUCCESS )
5336 goto cleanup;
5337 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5338 tls12_prf->seed, tls12_prf->seed_length );
5339 if( status != PSA_SUCCESS )
5340 goto cleanup;
5341 status = psa_hmac_finish_internal( &tls12_prf->hmac,
5342 tls12_prf->output_block, hash_length );
5343 if( status != PSA_SUCCESS )
5344 goto cleanup;
5345 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
5346 if( status != PSA_SUCCESS )
5347 goto cleanup;
5348
Janos Follath7742fee2019-06-17 12:58:10 +01005349
5350cleanup:
5351
Janos Follathea29bfb2019-06-19 12:21:20 +01005352 cleanup_status = psa_hash_abort( &backup );
5353 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
5354 status = cleanup_status;
5355
5356 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01005357}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005358
Janos Follath844eb0e2019-06-19 12:10:49 +01005359static psa_status_t psa_key_derivation_tls12_prf_read(
5360 psa_tls12_prf_key_derivation_t *tls12_prf,
5361 psa_algorithm_t alg,
5362 uint8_t *output,
5363 size_t output_length )
5364{
5365 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
5366 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
5367 psa_status_t status;
5368 uint8_t offset, length;
5369
5370 while( output_length != 0 )
5371 {
5372 /* Check if we have fully processed the current block. */
5373 if( tls12_prf->left_in_block == 0 )
5374 {
5375 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
5376 alg );
5377 if( status != PSA_SUCCESS )
5378 return( status );
5379
5380 continue;
5381 }
5382
5383 if( tls12_prf->left_in_block > output_length )
5384 length = (uint8_t) output_length;
5385 else
5386 length = tls12_prf->left_in_block;
5387
5388 offset = hash_length - tls12_prf->left_in_block;
5389 memcpy( output, tls12_prf->output_block + offset, length );
5390 output += length;
5391 output_length -= length;
5392 tls12_prf->left_in_block -= length;
5393 }
5394
5395 return( PSA_SUCCESS );
5396}
Gilles Peskinebef7f142018-07-12 17:22:21 +02005397#endif /* MBEDTLS_MD_C */
5398
Janos Follath6c6c8fc2019-06-17 12:38:20 +01005399psa_status_t psa_key_derivation_output_bytes(
5400 psa_key_derivation_operation_t *operation,
5401 uint8_t *output,
5402 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005403{
5404 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005405 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005406
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005407 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005408 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005409 /* This is a blank operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02005410 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005411 }
5412
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005413 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005414 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005415 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005416 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005417 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02005418 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005419 goto exit;
5420 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005421 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005422 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005423 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005424 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02005425 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
5426 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005427 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02005428 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02005429 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005430 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005431 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005432
Gilles Peskinebef7f142018-07-12 17:22:21 +02005433#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005434 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02005435 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01005436 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005437 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02005438 output, output_length );
5439 }
Janos Follathadbec812019-06-14 11:05:39 +01005440 else
Janos Follathadbec812019-06-14 11:05:39 +01005441 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine969c5d62019-01-16 15:53:06 +01005442 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005443 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005444 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005445 kdf_alg, output,
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005446 output_length );
5447 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005448 else
5449#endif /* MBEDTLS_MD_C */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005450 {
5451 return( PSA_ERROR_BAD_STATE );
5452 }
5453
5454exit:
5455 if( status != PSA_SUCCESS )
5456 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005457 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005458 * This allows us to differentiate between exhausted operations and
5459 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
5460 * operations. */
5461 psa_algorithm_t alg = operation->alg;
5462 psa_key_derivation_abort( operation );
5463 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005464 memset( output, '!', output_length );
5465 }
5466 return( status );
5467}
5468
Gilles Peskine08542d82018-07-19 17:05:42 +02005469#if defined(MBEDTLS_DES_C)
5470static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
5471{
5472 if( data_size >= 8 )
5473 mbedtls_des_key_set_parity( data );
5474 if( data_size >= 16 )
5475 mbedtls_des_key_set_parity( data + 8 );
5476 if( data_size >= 24 )
5477 mbedtls_des_key_set_parity( data + 16 );
5478}
5479#endif /* MBEDTLS_DES_C */
5480
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005481static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005482 psa_key_slot_t *slot,
5483 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005484 psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005485{
5486 uint8_t *data = NULL;
5487 size_t bytes = PSA_BITS_TO_BYTES( bits );
5488 psa_status_t status;
5489
Gilles Peskine8e338702019-07-30 20:06:31 +02005490 if( ! key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005491 return( PSA_ERROR_INVALID_ARGUMENT );
5492 if( bits % 8 != 0 )
5493 return( PSA_ERROR_INVALID_ARGUMENT );
5494 data = mbedtls_calloc( 1, bytes );
5495 if( data == NULL )
5496 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5497
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005498 status = psa_key_derivation_output_bytes( operation, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005499 if( status != PSA_SUCCESS )
5500 goto exit;
Gilles Peskine08542d82018-07-19 17:05:42 +02005501#if defined(MBEDTLS_DES_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02005502 if( slot->attr.type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02005503 psa_des_set_key_parity( data, bytes );
5504#endif /* MBEDTLS_DES_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005505 status = psa_import_key_into_slot( slot, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005506
5507exit:
5508 mbedtls_free( data );
5509 return( status );
5510}
5511
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005512psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005513 psa_key_derivation_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005514 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005515{
5516 psa_status_t status;
5517 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005518 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02005519
5520 /* Reject any attempt to create a zero-length key so that we don't
5521 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
5522 if( psa_get_key_bits( attributes ) == 0 )
5523 return( PSA_ERROR_INVALID_ARGUMENT );
5524
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005525 if( ! operation->can_output_key )
5526 return( PSA_ERROR_NOT_PERMITTED );
5527
Gilles Peskinedf179142019-07-15 22:02:14 +02005528 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005529 attributes, key, &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02005530#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
5531 if( driver != NULL )
5532 {
5533 /* Deriving a key in a secure element is not implemented yet. */
5534 status = PSA_ERROR_NOT_SUPPORTED;
5535 }
5536#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005537 if( status == PSA_SUCCESS )
5538 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005539 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02005540 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005541 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005542 }
5543 if( status == PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02005544 status = psa_finish_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005545 if( status != PSA_SUCCESS )
5546 {
Gilles Peskine011e4282019-06-26 18:34:38 +02005547 psa_fail_key_creation( slot, driver );
Ronald Croncf56a0a2020-08-04 09:51:30 +02005548 *key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005549 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02005550 else
5551 status = psa_decrement_key_slot_access_count( slot );
5552
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005553 return( status );
5554}
5555
Gilles Peskineeab56e42018-07-12 17:12:33 +02005556
5557
5558/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02005559/* Key derivation */
5560/****************************************************************/
5561
Gilles Peskine969c5d62019-01-16 15:53:06 +01005562static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005563 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005564 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005565{
Janos Follath5fe19732019-06-20 15:09:30 +01005566 /* Make sure that operation->ctx is properly zero-initialised. (Macro
5567 * initialisers for this union leave some bytes unspecified.) */
5568 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
5569
Gilles Peskine969c5d62019-01-16 15:53:06 +01005570 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005571#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005572 if( PSA_ALG_IS_HKDF( kdf_alg ) ||
5573 PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
5574 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005575 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01005576 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005577 size_t hash_size = PSA_HASH_SIZE( hash_alg );
5578 if( hash_size == 0 )
5579 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005580 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
5581 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02005582 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005583 {
5584 return( PSA_ERROR_NOT_SUPPORTED );
5585 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005586 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01005587 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005588 }
5589#endif /* MBEDTLS_MD_C */
Gilles Peskine969c5d62019-01-16 15:53:06 +01005590 else
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005591 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005592}
5593
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005594psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005595 psa_algorithm_t alg )
5596{
5597 psa_status_t status;
5598
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005599 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005600 return( PSA_ERROR_BAD_STATE );
5601
Gilles Peskine6843c292019-01-18 16:44:49 +01005602 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
5603 return( PSA_ERROR_INVALID_ARGUMENT );
5604 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005605 {
5606 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005607 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005608 }
5609 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
5610 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005611 status = psa_key_derivation_setup_kdf( operation, alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005612 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005613 else
5614 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005615
5616 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005617 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01005618 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005619}
5620
5621#if defined(MBEDTLS_MD_C)
Gilles Peskinecbe66502019-05-16 16:59:18 +02005622static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005623 psa_algorithm_t hash_alg,
5624 psa_key_derivation_step_t step,
5625 const uint8_t *data,
5626 size_t data_length )
5627{
5628 psa_status_t status;
5629 switch( step )
5630 {
Gilles Peskine03410b52019-05-16 16:05:19 +02005631 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02005632 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005633 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005634 status = psa_hmac_setup_internal( &hkdf->hmac,
5635 data, data_length,
5636 hash_alg );
5637 if( status != PSA_SUCCESS )
5638 return( status );
5639 hkdf->state = HKDF_STATE_STARTED;
5640 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02005641 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005642 /* If no salt was provided, use an empty salt. */
5643 if( hkdf->state == HKDF_STATE_INIT )
5644 {
5645 status = psa_hmac_setup_internal( &hkdf->hmac,
5646 NULL, 0,
Gilles Peskinef9ee6332019-04-11 21:22:52 +02005647 hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005648 if( status != PSA_SUCCESS )
5649 return( status );
5650 hkdf->state = HKDF_STATE_STARTED;
5651 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02005652 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005653 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005654 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5655 data, data_length );
5656 if( status != PSA_SUCCESS )
5657 return( status );
5658 status = psa_hmac_finish_internal( &hkdf->hmac,
5659 hkdf->prk,
5660 sizeof( hkdf->prk ) );
5661 if( status != PSA_SUCCESS )
5662 return( status );
5663 hkdf->offset_in_block = PSA_HASH_SIZE( hash_alg );
5664 hkdf->block_number = 0;
5665 hkdf->state = HKDF_STATE_KEYED;
5666 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02005667 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005668 if( hkdf->state == HKDF_STATE_OUTPUT )
5669 return( PSA_ERROR_BAD_STATE );
5670 if( hkdf->info_set )
5671 return( PSA_ERROR_BAD_STATE );
5672 hkdf->info_length = data_length;
5673 if( data_length != 0 )
5674 {
5675 hkdf->info = mbedtls_calloc( 1, data_length );
5676 if( hkdf->info == NULL )
5677 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5678 memcpy( hkdf->info, data, data_length );
5679 }
5680 hkdf->info_set = 1;
5681 return( PSA_SUCCESS );
5682 default:
5683 return( PSA_ERROR_INVALID_ARGUMENT );
5684 }
5685}
Janos Follathb03233e2019-06-11 15:30:30 +01005686
Janos Follathf08e2652019-06-13 09:05:41 +01005687static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
5688 const uint8_t *data,
5689 size_t data_length )
5690{
5691 if( prf->state != TLS12_PRF_STATE_INIT )
5692 return( PSA_ERROR_BAD_STATE );
5693
Janos Follathd6dce9f2019-07-04 09:11:38 +01005694 if( data_length != 0 )
5695 {
5696 prf->seed = mbedtls_calloc( 1, data_length );
5697 if( prf->seed == NULL )
5698 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01005699
Janos Follathd6dce9f2019-07-04 09:11:38 +01005700 memcpy( prf->seed, data, data_length );
5701 prf->seed_length = data_length;
5702 }
Janos Follathf08e2652019-06-13 09:05:41 +01005703
5704 prf->state = TLS12_PRF_STATE_SEED_SET;
5705
5706 return( PSA_SUCCESS );
5707}
5708
Janos Follath81550542019-06-13 14:26:34 +01005709static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
5710 psa_algorithm_t hash_alg,
5711 const uint8_t *data,
5712 size_t data_length )
5713{
5714 psa_status_t status;
5715 if( prf->state != TLS12_PRF_STATE_SEED_SET )
5716 return( PSA_ERROR_BAD_STATE );
5717
5718 status = psa_hmac_setup_internal( &prf->hmac, data, data_length, hash_alg );
5719 if( status != PSA_SUCCESS )
5720 return( status );
5721
5722 prf->state = TLS12_PRF_STATE_KEY_SET;
5723
5724 return( PSA_SUCCESS );
5725}
5726
Janos Follath6660f0e2019-06-17 08:44:03 +01005727static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
5728 psa_tls12_prf_key_derivation_t *prf,
5729 psa_algorithm_t hash_alg,
5730 const uint8_t *data,
5731 size_t data_length )
5732{
5733 psa_status_t status;
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02005734 uint8_t pms[ 4 + 2 * PSA_ALG_TLS12_PSK_TO_MS_MAX_PSK_LEN ];
5735 uint8_t *cur = pms;
Janos Follath6660f0e2019-06-17 08:44:03 +01005736
5737 if( data_length > PSA_ALG_TLS12_PSK_TO_MS_MAX_PSK_LEN )
5738 return( PSA_ERROR_INVALID_ARGUMENT );
5739
5740 /* Quoting RFC 4279, Section 2:
5741 *
5742 * The premaster secret is formed as follows: if the PSK is N octets
5743 * long, concatenate a uint16 with the value N, N zero octets, a second
5744 * uint16 with the value N, and the PSK itself.
5745 */
5746
Janos Follath40e13932019-06-26 13:22:29 +01005747 *cur++ = ( data_length >> 8 ) & 0xff;
5748 *cur++ = ( data_length >> 0 ) & 0xff;
5749 memset( cur, 0, data_length );
5750 cur += data_length;
5751 *cur++ = pms[0];
5752 *cur++ = pms[1];
5753 memcpy( cur, data, data_length );
5754 cur += data_length;
Janos Follath6660f0e2019-06-17 08:44:03 +01005755
Janos Follath40e13932019-06-26 13:22:29 +01005756 status = psa_tls12_prf_set_key( prf, hash_alg, pms, cur - pms );
Janos Follath6660f0e2019-06-17 08:44:03 +01005757
5758 mbedtls_platform_zeroize( pms, sizeof( pms ) );
5759 return( status );
5760}
5761
Janos Follath63028dd2019-06-13 09:15:47 +01005762static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
5763 const uint8_t *data,
5764 size_t data_length )
5765{
5766 if( prf->state != TLS12_PRF_STATE_KEY_SET )
5767 return( PSA_ERROR_BAD_STATE );
5768
Janos Follathd6dce9f2019-07-04 09:11:38 +01005769 if( data_length != 0 )
5770 {
5771 prf->label = mbedtls_calloc( 1, data_length );
5772 if( prf->label == NULL )
5773 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01005774
Janos Follathd6dce9f2019-07-04 09:11:38 +01005775 memcpy( prf->label, data, data_length );
5776 prf->label_length = data_length;
5777 }
Janos Follath63028dd2019-06-13 09:15:47 +01005778
5779 prf->state = TLS12_PRF_STATE_LABEL_SET;
5780
5781 return( PSA_SUCCESS );
5782}
5783
Janos Follathb03233e2019-06-11 15:30:30 +01005784static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
5785 psa_algorithm_t hash_alg,
5786 psa_key_derivation_step_t step,
5787 const uint8_t *data,
5788 size_t data_length )
5789{
Janos Follathb03233e2019-06-11 15:30:30 +01005790 switch( step )
5791 {
Janos Follathf08e2652019-06-13 09:05:41 +01005792 case PSA_KEY_DERIVATION_INPUT_SEED:
5793 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01005794 case PSA_KEY_DERIVATION_INPUT_SECRET:
5795 return( psa_tls12_prf_set_key( prf, hash_alg, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01005796 case PSA_KEY_DERIVATION_INPUT_LABEL:
5797 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01005798 default:
5799 return( PSA_ERROR_INVALID_ARGUMENT );
5800 }
5801}
Janos Follath6660f0e2019-06-17 08:44:03 +01005802
5803static psa_status_t psa_tls12_prf_psk_to_ms_input(
5804 psa_tls12_prf_key_derivation_t *prf,
5805 psa_algorithm_t hash_alg,
5806 psa_key_derivation_step_t step,
5807 const uint8_t *data,
5808 size_t data_length )
5809{
5810 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01005811 {
Janos Follath6660f0e2019-06-17 08:44:03 +01005812 return( psa_tls12_prf_psk_to_ms_set_key( prf, hash_alg,
5813 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01005814 }
Janos Follath6660f0e2019-06-17 08:44:03 +01005815
5816 return( psa_tls12_prf_input( prf, hash_alg, step, data, data_length ) );
5817}
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005818#endif /* MBEDTLS_MD_C */
5819
Gilles Peskineb8965192019-09-24 16:21:10 +02005820/** Check whether the given key type is acceptable for the given
5821 * input step of a key derivation.
5822 *
5823 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
5824 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
5825 * Both secret and non-secret inputs can alternatively have the type
5826 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
5827 * that the input was passed as a buffer rather than via a key object.
5828 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02005829static int psa_key_derivation_check_input_type(
5830 psa_key_derivation_step_t step,
5831 psa_key_type_t key_type )
5832{
5833 switch( step )
5834 {
5835 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb8965192019-09-24 16:21:10 +02005836 if( key_type == PSA_KEY_TYPE_DERIVE )
5837 return( PSA_SUCCESS );
5838 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005839 return( PSA_SUCCESS );
5840 break;
5841 case PSA_KEY_DERIVATION_INPUT_LABEL:
5842 case PSA_KEY_DERIVATION_INPUT_SALT:
5843 case PSA_KEY_DERIVATION_INPUT_INFO:
5844 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskineb8965192019-09-24 16:21:10 +02005845 if( key_type == PSA_KEY_TYPE_RAW_DATA )
5846 return( PSA_SUCCESS );
5847 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005848 return( PSA_SUCCESS );
5849 break;
5850 }
5851 return( PSA_ERROR_INVALID_ARGUMENT );
5852}
5853
Janos Follathb80a94e2019-06-12 15:54:46 +01005854static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005855 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005856 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005857 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005858 const uint8_t *data,
5859 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005860{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02005861 psa_status_t status;
5862 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
5863
5864 status = psa_key_derivation_check_input_type( step, key_type );
Gilles Peskine224b0d62019-09-23 18:13:17 +02005865 if( status != PSA_SUCCESS )
5866 goto exit;
5867
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005868#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005869 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005870 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005871 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005872 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005873 step, data, data_length );
5874 }
k-stachowiak012dcc42019-08-13 14:55:03 +02005875 else if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005876 {
Janos Follathb03233e2019-06-11 15:30:30 +01005877 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
5878 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5879 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01005880 }
5881 else if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
5882 {
5883 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
5884 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5885 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005886 }
5887 else
5888#endif /* MBEDTLS_MD_C */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005889 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005890 /* This can't happen unless the operation object was not initialized */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005891 return( PSA_ERROR_BAD_STATE );
5892 }
5893
Gilles Peskine224b0d62019-09-23 18:13:17 +02005894exit:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005895 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005896 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005897 return( status );
5898}
5899
Janos Follath51f4a0f2019-06-14 11:35:55 +01005900psa_status_t psa_key_derivation_input_bytes(
5901 psa_key_derivation_operation_t *operation,
5902 psa_key_derivation_step_t step,
5903 const uint8_t *data,
5904 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005905{
Gilles Peskineb8965192019-09-24 16:21:10 +02005906 return( psa_key_derivation_input_internal( operation, step,
5907 PSA_KEY_TYPE_NONE,
Janos Follathc5621512019-06-14 11:27:57 +01005908 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005909}
5910
Janos Follath51f4a0f2019-06-14 11:35:55 +01005911psa_status_t psa_key_derivation_input_key(
5912 psa_key_derivation_operation_t *operation,
5913 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005914 mbedtls_svc_key_id_t key )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005915{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005916 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5917 psa_status_t decrement_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005918 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005919
Ronald Croncf56a0a2020-08-04 09:51:30 +02005920 status = psa_get_transparent_key( key, &slot,
5921 PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005922 if( status != PSA_SUCCESS )
Gilles Peskine593773d2019-09-23 18:17:40 +02005923 {
5924 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005925 return( status );
Gilles Peskine593773d2019-09-23 18:17:40 +02005926 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005927
5928 /* Passing a key object as a SECRET input unlocks the permission
5929 * to output to a key object. */
5930 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5931 operation->can_output_key = 1;
5932
Ronald Cronf95a2b12020-10-22 15:24:49 +02005933 status = psa_key_derivation_input_internal( operation,
5934 step, slot->attr.type,
5935 slot->data.key.data,
5936 slot->data.key.bytes );
5937
5938 decrement_status = psa_decrement_key_slot_access_count( slot );
5939
5940 return( ( status == PSA_SUCCESS ) ? decrement_status : status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005941}
Gilles Peskineea0fb492018-07-12 17:17:20 +02005942
5943
5944
5945/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02005946/* Key agreement */
5947/****************************************************************/
5948
Gilles Peskinea05219c2018-11-16 16:02:56 +01005949#if defined(MBEDTLS_ECDH_C)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005950static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
5951 size_t peer_key_length,
5952 const mbedtls_ecp_keypair *our_key,
5953 uint8_t *shared_secret,
5954 size_t shared_secret_size,
5955 size_t *shared_secret_length )
5956{
Steven Cooremand4867872020-08-05 16:31:39 +02005957 mbedtls_ecp_keypair *their_key = NULL;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005958 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00005959 psa_status_t status;
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005960 size_t bits = 0;
Paul Elliott8ff510a2020-06-02 17:19:28 +01005961 psa_ecc_family_t curve = mbedtls_ecc_group_to_psa( our_key->grp.id, &bits );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005962 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005963
Steven Cooreman4fed4552020-08-03 14:46:03 +02005964 status = psa_load_ecp_representation( PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve),
5965 peer_key,
Steven Cooreman7f391872020-07-30 14:57:44 +02005966 peer_key_length,
Steven Cooreman7f391872020-07-30 14:57:44 +02005967 &their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00005968 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005969 goto exit;
5970
Jaeden Amero97271b32019-01-10 19:38:51 +00005971 status = mbedtls_to_psa_error(
Steven Cooremana2371e52020-07-28 14:30:39 +02005972 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
Jaeden Amero97271b32019-01-10 19:38:51 +00005973 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005974 goto exit;
Jaeden Amero97271b32019-01-10 19:38:51 +00005975 status = mbedtls_to_psa_error(
5976 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
5977 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005978 goto exit;
5979
Jaeden Amero97271b32019-01-10 19:38:51 +00005980 status = mbedtls_to_psa_error(
5981 mbedtls_ecdh_calc_secret( &ecdh,
5982 shared_secret_length,
5983 shared_secret, shared_secret_size,
5984 mbedtls_ctr_drbg_random,
5985 &global_data.ctr_drbg ) );
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005986 if( status != PSA_SUCCESS )
5987 goto exit;
5988 if( PSA_BITS_TO_BYTES( bits ) != *shared_secret_length )
5989 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005990
5991exit:
Gilles Peskine3e819b72019-12-20 14:09:55 +01005992 if( status != PSA_SUCCESS )
5993 mbedtls_platform_zeroize( shared_secret, shared_secret_size );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005994 mbedtls_ecdh_free( &ecdh );
Steven Cooremana2371e52020-07-28 14:30:39 +02005995 mbedtls_ecp_keypair_free( their_key );
Steven Cooreman6d839f02020-07-30 11:36:45 +02005996 mbedtls_free( their_key );
Steven Cooremana2371e52020-07-28 14:30:39 +02005997
Jaeden Amero97271b32019-01-10 19:38:51 +00005998 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005999}
Gilles Peskinea05219c2018-11-16 16:02:56 +01006000#endif /* MBEDTLS_ECDH_C */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006001
Gilles Peskine01d718c2018-09-18 12:01:02 +02006002#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
6003
Gilles Peskine0216fe12019-04-11 21:23:21 +02006004static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
6005 psa_key_slot_t *private_key,
6006 const uint8_t *peer_key,
6007 size_t peer_key_length,
6008 uint8_t *shared_secret,
6009 size_t shared_secret_size,
6010 size_t *shared_secret_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02006011{
Gilles Peskine0216fe12019-04-11 21:23:21 +02006012 switch( alg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02006013 {
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006014#if defined(MBEDTLS_ECDH_C)
Gilles Peskine0216fe12019-04-11 21:23:21 +02006015 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02006016 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006017 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremana2371e52020-07-28 14:30:39 +02006018 mbedtls_ecp_keypair *ecp = NULL;
Steven Cooreman7f391872020-07-30 14:57:44 +02006019 psa_status_t status = psa_load_ecp_representation(
Steven Cooreman4fed4552020-08-03 14:46:03 +02006020 private_key->attr.type,
Steven Cooreman7f391872020-07-30 14:57:44 +02006021 private_key->data.key.data,
6022 private_key->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02006023 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02006024 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02006025 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02006026 status = psa_key_agreement_ecdh( peer_key, peer_key_length,
Steven Cooremana2371e52020-07-28 14:30:39 +02006027 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02006028 shared_secret, shared_secret_size,
6029 shared_secret_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02006030 mbedtls_ecp_keypair_free( ecp );
6031 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02006032 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006033#endif /* MBEDTLS_ECDH_C */
Gilles Peskine01d718c2018-09-18 12:01:02 +02006034 default:
Gilles Peskine93f85002018-11-16 16:43:31 +01006035 (void) private_key;
6036 (void) peer_key;
6037 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02006038 (void) shared_secret;
6039 (void) shared_secret_size;
6040 (void) shared_secret_length;
Gilles Peskine01d718c2018-09-18 12:01:02 +02006041 return( PSA_ERROR_NOT_SUPPORTED );
6042 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02006043}
6044
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02006045/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02006046 * to potentially free embedded data structures and wipe confidential data.
6047 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006048static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01006049 psa_key_derivation_step_t step,
Gilles Peskine01d718c2018-09-18 12:01:02 +02006050 psa_key_slot_t *private_key,
6051 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01006052 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02006053{
6054 psa_status_t status;
6055 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
6056 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006057 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02006058
6059 /* Step 1: run the secret agreement algorithm to generate the shared
6060 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02006061 status = psa_key_agreement_raw_internal( ka_alg,
6062 private_key,
6063 peer_key, peer_key_length,
itayzafrir0adf0fc2018-09-06 16:24:41 +03006064 shared_secret,
6065 sizeof( shared_secret ),
Gilles Peskine05d69892018-06-19 22:00:52 +02006066 &shared_secret_length );
Gilles Peskine53d991e2018-07-12 01:14:59 +02006067 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02006068 goto exit;
6069
Gilles Peskineb0b255c2018-07-06 17:01:38 +02006070 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02006071 * the shared secret. A shared secret is permitted wherever a key
6072 * of type DERIVE is permitted. */
Janos Follathb80a94e2019-06-12 15:54:46 +01006073 status = psa_key_derivation_input_internal( operation, step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02006074 PSA_KEY_TYPE_DERIVE,
Janos Follathb80a94e2019-06-12 15:54:46 +01006075 shared_secret,
6076 shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02006077exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01006078 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02006079 return( status );
6080}
6081
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006082psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02006083 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02006084 mbedtls_svc_key_id_t private_key,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02006085 const uint8_t *peer_key,
6086 size_t peer_key_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +02006087{
Ronald Cronf95a2b12020-10-22 15:24:49 +02006088 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
6089 psa_status_t decrement_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01006090 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02006091
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006092 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02006093 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine28f8f302019-07-24 13:30:31 +02006094 status = psa_get_transparent_key( private_key, &slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02006095 PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine12313cd2018-06-20 00:20:32 +02006096 if( status != PSA_SUCCESS )
6097 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006098 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01006099 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01006100 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01006101 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006102 psa_key_derivation_abort( operation );
Steven Cooremanfa5e6312020-10-15 17:07:12 +02006103 else
6104 {
6105 /* If a private key has been added as SECRET, we allow the derived
6106 * key material to be used as a key in PSA Crypto. */
6107 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
6108 operation->can_output_key = 1;
6109 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02006110
6111 decrement_status = psa_decrement_key_slot_access_count( slot );
6112
6113 return( ( status == PSA_SUCCESS ) ? decrement_status : status );
Gilles Peskineaf3baab2018-06-27 22:55:52 +02006114}
6115
Gilles Peskinebe697d82019-05-16 18:00:41 +02006116psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
Ronald Croncf56a0a2020-08-04 09:51:30 +02006117 mbedtls_svc_key_id_t private_key,
Gilles Peskinebe697d82019-05-16 18:00:41 +02006118 const uint8_t *peer_key,
6119 size_t peer_key_length,
6120 uint8_t *output,
6121 size_t output_size,
6122 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02006123{
Ronald Cronf95a2b12020-10-22 15:24:49 +02006124 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
6125 psa_status_t decrement_status = PSA_ERROR_CORRUPTION_DETECTED;
6126 psa_key_slot_t *slot = NULL;
Gilles Peskine0216fe12019-04-11 21:23:21 +02006127
6128 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
6129 {
6130 status = PSA_ERROR_INVALID_ARGUMENT;
6131 goto exit;
6132 }
Gilles Peskine28f8f302019-07-24 13:30:31 +02006133 status = psa_get_transparent_key( private_key, &slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02006134 PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02006135 if( status != PSA_SUCCESS )
6136 goto exit;
6137
6138 status = psa_key_agreement_raw_internal( alg, slot,
6139 peer_key, peer_key_length,
6140 output, output_size,
6141 output_length );
6142
6143exit:
6144 if( status != PSA_SUCCESS )
6145 {
6146 /* If an error happens and is not handled properly, the output
6147 * may be used as a key to protect sensitive data. Arrange for such
6148 * a key to be random, which is likely to result in decryption or
6149 * verification errors. This is better than filling the buffer with
6150 * some constant data such as zeros, which would result in the data
6151 * being protected with a reproducible, easily knowable key.
6152 */
6153 psa_generate_random( output, output_size );
6154 *output_length = output_size;
6155 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02006156
6157 decrement_status = psa_decrement_key_slot_access_count( slot );
6158
6159 return( ( status == PSA_SUCCESS ) ? decrement_status : status );
Gilles Peskine0216fe12019-04-11 21:23:21 +02006160}
Gilles Peskine86a440b2018-11-12 18:39:40 +01006161
6162
6163/****************************************************************/
6164/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02006165/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02006166
Gilles Peskine4c317f42018-07-12 01:24:09 +02006167psa_status_t psa_generate_random( uint8_t *output,
Gilles Peskine53d991e2018-07-12 01:14:59 +02006168 size_t output_size )
Gilles Peskine12313cd2018-06-20 00:20:32 +02006169{
Janos Follath24eed8d2019-11-22 13:21:35 +00006170 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006171 GUARD_MODULE_INITIALIZED;
6172
Gilles Peskinef181eca2019-08-07 13:49:00 +02006173 while( output_size > MBEDTLS_CTR_DRBG_MAX_REQUEST )
6174 {
6175 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg,
6176 output,
6177 MBEDTLS_CTR_DRBG_MAX_REQUEST );
6178 if( ret != 0 )
6179 return( mbedtls_to_psa_error( ret ) );
6180 output += MBEDTLS_CTR_DRBG_MAX_REQUEST;
6181 output_size -= MBEDTLS_CTR_DRBG_MAX_REQUEST;
6182 }
6183
Gilles Peskinee59236f2018-01-27 23:32:46 +01006184 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg, output, output_size );
6185 return( mbedtls_to_psa_error( ret ) );
6186}
6187
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01006188#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
6189#include "mbedtls/entropy_poll.h"
6190
Gilles Peskine7228da22019-07-15 11:06:15 +02006191psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006192 size_t seed_size )
6193{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006194 if( global_data.initialized )
6195 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02006196
6197 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
6198 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
6199 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
6200 return( PSA_ERROR_INVALID_ARGUMENT );
6201
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01006202 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006203}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01006204#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006205
Gilles Peskinee56e8782019-04-26 17:34:02 +02006206#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_GENPRIME)
6207static psa_status_t psa_read_rsa_exponent( const uint8_t *domain_parameters,
6208 size_t domain_parameters_size,
6209 int *exponent )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006210{
Gilles Peskinee56e8782019-04-26 17:34:02 +02006211 size_t i;
6212 uint32_t acc = 0;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006213
Gilles Peskinee56e8782019-04-26 17:34:02 +02006214 if( domain_parameters_size == 0 )
6215 {
6216 *exponent = 65537;
6217 return( PSA_SUCCESS );
6218 }
6219
6220 /* Mbed TLS encodes the public exponent as an int. For simplicity, only
6221 * support values that fit in a 32-bit integer, which is larger than
6222 * int on just about every platform anyway. */
6223 if( domain_parameters_size > sizeof( acc ) )
6224 return( PSA_ERROR_NOT_SUPPORTED );
6225 for( i = 0; i < domain_parameters_size; i++ )
6226 acc = ( acc << 8 ) | domain_parameters[i];
6227 if( acc > INT_MAX )
6228 return( PSA_ERROR_NOT_SUPPORTED );
6229 *exponent = acc;
6230 return( PSA_SUCCESS );
6231}
6232#endif /* MBEDTLS_RSA_C && MBEDTLS_GENPRIME */
6233
Gilles Peskine35ef36b2019-05-16 19:42:05 +02006234static psa_status_t psa_generate_key_internal(
Gilles Peskinee56e8782019-04-26 17:34:02 +02006235 psa_key_slot_t *slot, size_t bits,
6236 const uint8_t *domain_parameters, size_t domain_parameters_size )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006237{
Gilles Peskine8e338702019-07-30 20:06:31 +02006238 psa_key_type_t type = slot->attr.type;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006239
Gilles Peskinee56e8782019-04-26 17:34:02 +02006240 if( domain_parameters == NULL && domain_parameters_size != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006241 return( PSA_ERROR_INVALID_ARGUMENT );
6242
Gilles Peskinee59236f2018-01-27 23:32:46 +01006243 if( key_type_is_raw_bytes( type ) )
6244 {
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006245 psa_status_t status;
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006246
6247 status = validate_unstructured_key_bit_size( slot->attr.type, bits );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006248 if( status != PSA_SUCCESS )
6249 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006250
6251 /* Allocate memory for the key */
Steven Cooreman75b74362020-07-28 14:30:13 +02006252 status = psa_allocate_buffer_to_slot( slot, PSA_BITS_TO_BYTES( bits ) );
6253 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02006254 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006255
Steven Cooreman71fd80d2020-07-07 21:12:27 +02006256 status = psa_generate_random( slot->data.key.data,
6257 slot->data.key.bytes );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006258 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006259 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006260
6261 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006262#if defined(MBEDTLS_DES_C)
6263 if( type == PSA_KEY_TYPE_DES )
Steven Cooreman71fd80d2020-07-07 21:12:27 +02006264 psa_des_set_key_parity( slot->data.key.data,
6265 slot->data.key.bytes );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006266#endif /* MBEDTLS_DES_C */
6267 }
6268 else
6269
6270#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_GENPRIME)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02006271 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006272 {
Steven Cooremana01795d2020-07-24 22:48:15 +02006273 mbedtls_rsa_context rsa;
Janos Follath24eed8d2019-11-22 13:21:35 +00006274 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee56e8782019-04-26 17:34:02 +02006275 int exponent;
6276 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006277 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
6278 return( PSA_ERROR_NOT_SUPPORTED );
6279 /* Accept only byte-aligned keys, for the same reasons as
6280 * in psa_import_rsa_key(). */
6281 if( bits % 8 != 0 )
6282 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinee56e8782019-04-26 17:34:02 +02006283 status = psa_read_rsa_exponent( domain_parameters,
6284 domain_parameters_size,
6285 &exponent );
6286 if( status != PSA_SUCCESS )
6287 return( status );
Steven Cooremana01795d2020-07-24 22:48:15 +02006288 mbedtls_rsa_init( &rsa, MBEDTLS_RSA_PKCS_V15, MBEDTLS_MD_NONE );
6289 ret = mbedtls_rsa_gen_key( &rsa,
Gilles Peskinee59236f2018-01-27 23:32:46 +01006290 mbedtls_ctr_drbg_random,
6291 &global_data.ctr_drbg,
6292 (unsigned int) bits,
6293 exponent );
6294 if( ret != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006295 return( mbedtls_to_psa_error( ret ) );
Steven Cooremana01795d2020-07-24 22:48:15 +02006296
6297 /* Make sure to always have an export representation available */
6298 size_t bytes = PSA_KEY_EXPORT_RSA_KEY_PAIR_MAX_SIZE( bits );
6299
Steven Cooreman75b74362020-07-28 14:30:13 +02006300 status = psa_allocate_buffer_to_slot( slot, bytes );
6301 if( status != PSA_SUCCESS )
Steven Cooremana01795d2020-07-24 22:48:15 +02006302 {
6303 mbedtls_rsa_free( &rsa );
Steven Cooreman29149862020-08-05 15:43:42 +02006304 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006305 }
Steven Cooremana01795d2020-07-24 22:48:15 +02006306
6307 status = psa_export_rsa_key( type,
6308 &rsa,
6309 slot->data.key.data,
6310 bytes,
6311 &slot->data.key.bytes );
6312 mbedtls_rsa_free( &rsa );
6313 if( status != PSA_SUCCESS )
Steven Cooremana01795d2020-07-24 22:48:15 +02006314 psa_remove_key_data_from_memory( slot );
Steven Cooreman560c28a2020-07-24 23:20:24 +02006315 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006316 }
6317 else
6318#endif /* MBEDTLS_RSA_C && MBEDTLS_GENPRIME */
6319
6320#if defined(MBEDTLS_ECP_C)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02006321 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006322 {
Paul Elliott8ff510a2020-06-02 17:19:28 +01006323 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY( type );
Gilles Peskine4295e8b2019-12-02 21:39:10 +01006324 mbedtls_ecp_group_id grp_id =
6325 mbedtls_ecc_group_of_psa( curve, PSA_BITS_TO_BYTES( bits ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006326 const mbedtls_ecp_curve_info *curve_info =
6327 mbedtls_ecp_curve_info_from_grp_id( grp_id );
Steven Cooremanacda8342020-07-24 23:09:52 +02006328 mbedtls_ecp_keypair ecp;
Janos Follath24eed8d2019-11-22 13:21:35 +00006329 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee56e8782019-04-26 17:34:02 +02006330 if( domain_parameters_size != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006331 return( PSA_ERROR_NOT_SUPPORTED );
6332 if( grp_id == MBEDTLS_ECP_DP_NONE || curve_info == NULL )
6333 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooremanacda8342020-07-24 23:09:52 +02006334 mbedtls_ecp_keypair_init( &ecp );
6335 ret = mbedtls_ecp_gen_key( grp_id, &ecp,
Gilles Peskinee59236f2018-01-27 23:32:46 +01006336 mbedtls_ctr_drbg_random,
6337 &global_data.ctr_drbg );
6338 if( ret != 0 )
6339 {
Steven Cooremanacda8342020-07-24 23:09:52 +02006340 mbedtls_ecp_keypair_free( &ecp );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006341 return( mbedtls_to_psa_error( ret ) );
6342 }
Steven Cooremanacda8342020-07-24 23:09:52 +02006343
6344
6345 /* Make sure to always have an export representation available */
6346 size_t bytes = PSA_BITS_TO_BYTES( bits );
Steven Cooreman75b74362020-07-28 14:30:13 +02006347 psa_status_t status = psa_allocate_buffer_to_slot( slot, bytes );
6348 if( status != PSA_SUCCESS )
Steven Cooremanacda8342020-07-24 23:09:52 +02006349 {
6350 mbedtls_ecp_keypair_free( &ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02006351 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02006352 }
Steven Cooreman75b74362020-07-28 14:30:13 +02006353
6354 status = mbedtls_to_psa_error(
Steven Cooremanacda8342020-07-24 23:09:52 +02006355 mbedtls_ecp_write_key( &ecp, slot->data.key.data, bytes ) );
6356
6357 mbedtls_ecp_keypair_free( &ecp );
Steven Cooremanb7f6dea2020-08-05 16:07:20 +02006358 if( status != PSA_SUCCESS ) {
6359 memset( slot->data.key.data, 0, bytes );
Steven Cooremanacda8342020-07-24 23:09:52 +02006360 psa_remove_key_data_from_memory( slot );
Steven Cooremanb7f6dea2020-08-05 16:07:20 +02006361 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02006362 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006363 }
6364 else
6365#endif /* MBEDTLS_ECP_C */
Steven Cooreman29149862020-08-05 15:43:42 +02006366 {
Gilles Peskinee59236f2018-01-27 23:32:46 +01006367 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman29149862020-08-05 15:43:42 +02006368 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01006369
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006370 return( PSA_SUCCESS );
6371}
Darryl Green0c6575a2018-11-07 16:05:30 +00006372
Gilles Peskine35ef36b2019-05-16 19:42:05 +02006373psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02006374 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006375{
6376 psa_status_t status;
6377 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02006378 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine11792082019-08-06 18:36:36 +02006379
Gilles Peskine0f84d622019-09-12 19:03:13 +02006380 /* Reject any attempt to create a zero-length key so that we don't
6381 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
6382 if( psa_get_key_bits( attributes ) == 0 )
6383 return( PSA_ERROR_INVALID_ARGUMENT );
6384
Gilles Peskinedf179142019-07-15 22:02:14 +02006385 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE,
Ronald Croncf56a0a2020-08-04 09:51:30 +02006386 attributes, key, &slot, &driver );
Gilles Peskine11792082019-08-06 18:36:36 +02006387 if( status != PSA_SUCCESS )
6388 goto exit;
6389
Steven Cooreman2a1664c2020-07-20 15:33:08 +02006390 status = psa_driver_wrapper_generate_key( attributes,
6391 slot );
6392 if( status != PSA_ERROR_NOT_SUPPORTED ||
6393 psa_key_lifetime_is_external( attributes->core.lifetime ) )
6394 goto exit;
6395
6396 status = psa_generate_key_internal(
6397 slot, attributes->core.bits,
6398 attributes->domain_parameters, attributes->domain_parameters_size );
Gilles Peskine11792082019-08-06 18:36:36 +02006399
6400exit:
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006401 if( status == PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02006402 status = psa_finish_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006403 if( status != PSA_SUCCESS )
6404 {
Gilles Peskine011e4282019-06-26 18:34:38 +02006405 psa_fail_key_creation( slot, driver );
Ronald Croncf56a0a2020-08-04 09:51:30 +02006406 *key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006407 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02006408 else
6409 status = psa_decrement_key_slot_access_count( slot );
6410
Darryl Green0c6575a2018-11-07 16:05:30 +00006411 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006412}
6413
6414
Gilles Peskinee59236f2018-01-27 23:32:46 +01006415
6416/****************************************************************/
6417/* Module setup */
6418/****************************************************************/
6419
Gilles Peskine5e769522018-11-20 21:59:56 +01006420psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
6421 void (* entropy_init )( mbedtls_entropy_context *ctx ),
6422 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
6423{
6424 if( global_data.rng_state != RNG_NOT_INITIALIZED )
6425 return( PSA_ERROR_BAD_STATE );
6426 global_data.entropy_init = entropy_init;
6427 global_data.entropy_free = entropy_free;
6428 return( PSA_SUCCESS );
6429}
6430
Gilles Peskinee59236f2018-01-27 23:32:46 +01006431void mbedtls_psa_crypto_free( void )
6432{
Gilles Peskine66fb1262018-12-10 16:29:04 +01006433 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006434 if( global_data.rng_state != RNG_NOT_INITIALIZED )
6435 {
6436 mbedtls_ctr_drbg_free( &global_data.ctr_drbg );
Gilles Peskine5e769522018-11-20 21:59:56 +01006437 global_data.entropy_free( &global_data.entropy );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006438 }
6439 /* Wipe all remaining data, including configuration.
6440 * In particular, this sets all state indicator to the value
6441 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01006442 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Gilles Peskinea8ade162019-06-26 11:24:49 +02006443#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +02006444 /* Unregister all secure element drivers, so that we restart from
6445 * a pristine state. */
6446 psa_unregister_all_se_drivers( );
Gilles Peskinea8ade162019-06-26 11:24:49 +02006447#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006448}
6449
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006450#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
6451/** Recover a transaction that was interrupted by a power failure.
6452 *
6453 * This function is called during initialization, before psa_crypto_init()
6454 * returns. If this function returns a failure status, the initialization
6455 * fails.
6456 */
6457static psa_status_t psa_crypto_recover_transaction(
6458 const psa_crypto_transaction_t *transaction )
6459{
6460 switch( transaction->unknown.type )
6461 {
6462 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
6463 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01006464 /* TODO - fall through to the failure case until this
Gilles Peskinec9d7f942019-08-13 16:17:16 +02006465 * is implemented.
6466 * https://github.com/ARMmbed/mbed-crypto/issues/218
6467 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006468 default:
6469 /* We found an unsupported transaction in the storage.
6470 * We don't know what state the storage is in. Give up. */
6471 return( PSA_ERROR_STORAGE_FAILURE );
6472 }
6473}
6474#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
6475
Gilles Peskinee59236f2018-01-27 23:32:46 +01006476psa_status_t psa_crypto_init( void )
6477{
Gilles Peskine66fb1262018-12-10 16:29:04 +01006478 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006479 const unsigned char drbg_seed[] = "PSA";
6480
Gilles Peskinec6b69072018-11-20 21:42:52 +01006481 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006482 if( global_data.initialized != 0 )
6483 return( PSA_SUCCESS );
6484
Gilles Peskine5e769522018-11-20 21:59:56 +01006485 /* Set default configuration if
6486 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
6487 if( global_data.entropy_init == NULL )
6488 global_data.entropy_init = mbedtls_entropy_init;
6489 if( global_data.entropy_free == NULL )
6490 global_data.entropy_free = mbedtls_entropy_free;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006491
Gilles Peskinec6b69072018-11-20 21:42:52 +01006492 /* Initialize the random generator. */
Gilles Peskine5e769522018-11-20 21:59:56 +01006493 global_data.entropy_init( &global_data.entropy );
Jaeden Amero76541612019-06-04 17:14:43 +01006494#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
6495 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
6496 /* The PSA entropy injection feature depends on using NV seed as an entropy
6497 * source. Add NV seed as an entropy source for PSA entropy injection. */
6498 mbedtls_entropy_add_source( &global_data.entropy,
6499 mbedtls_nv_seed_poll, NULL,
6500 MBEDTLS_ENTROPY_BLOCK_SIZE,
6501 MBEDTLS_ENTROPY_SOURCE_STRONG );
6502#endif
Gilles Peskinee59236f2018-01-27 23:32:46 +01006503 mbedtls_ctr_drbg_init( &global_data.ctr_drbg );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006504 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine66fb1262018-12-10 16:29:04 +01006505 status = mbedtls_to_psa_error(
6506 mbedtls_ctr_drbg_seed( &global_data.ctr_drbg,
6507 mbedtls_entropy_func,
6508 &global_data.entropy,
6509 drbg_seed, sizeof( drbg_seed ) - 1 ) );
6510 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006511 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01006512 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006513
Gilles Peskine66fb1262018-12-10 16:29:04 +01006514 status = psa_initialize_key_slots( );
6515 if( status != PSA_SUCCESS )
6516 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01006517
Gilles Peskined9348f22019-10-01 15:22:29 +02006518#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
6519 status = psa_init_all_se_drivers( );
6520 if( status != PSA_SUCCESS )
6521 goto exit;
6522#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
6523
Gilles Peskine4b734222019-07-24 15:56:31 +02006524#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02006525 status = psa_crypto_load_transaction( );
6526 if( status == PSA_SUCCESS )
6527 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006528 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
6529 if( status != PSA_SUCCESS )
6530 goto exit;
6531 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02006532 }
6533 else if( status == PSA_ERROR_DOES_NOT_EXIST )
6534 {
6535 /* There's no transaction to complete. It's all good. */
6536 status = PSA_SUCCESS;
6537 }
Gilles Peskine4b734222019-07-24 15:56:31 +02006538#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02006539
Gilles Peskinec6b69072018-11-20 21:42:52 +01006540 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006541 global_data.initialized = 1;
6542
6543exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01006544 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006545 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01006546 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006547}
6548
6549#endif /* MBEDTLS_PSA_CRYPTO_C */