blob: 61f0ad4a4188700e4f18a6d145047eda21e32c1a [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
1311 * execution) and if MBEDTLS_PARAM_FAILED does not terminate execution
1312 * ouput an error message on standard error output.
1313 */
1314 if( slot->access_count != 1 )
1315 {
1316#ifdef MBEDTLS_CHECK_PARAMS
1317 MBEDTLS_PARAM_FAILED( slot->access_count == 1 );
1318#endif
1319#ifdef MBEDTLS_PLATFORM_C
1320 mbedtls_fprintf( stderr,
1321 "\nFATAL psa_wipe_key_slot Unexpected access counter value\n.");
1322#endif
1323 status = PSA_ERROR_CORRUPTION_DETECTED;
1324 }
1325
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001326 /* Multipart operations may still be using the key. This is safe
1327 * because all multipart operation objects are independent from
1328 * the key slot: if they need to access the key after the setup
1329 * phase, they have a copy of the key. Note that this means that
1330 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001331 /* At this point, key material and other type-specific content has
1332 * been wiped. Clear remaining metadata. We can call memset and not
1333 * zeroize because the metadata is not particularly sensitive. */
1334 memset( slot, 0, sizeof( *slot ) );
1335 return( status );
1336}
1337
Ronald Croncf56a0a2020-08-04 09:51:30 +02001338psa_status_t psa_destroy_key( mbedtls_svc_key_id_t key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001339{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001340 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001341 psa_status_t status; /* status of the last operation */
1342 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001343#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1344 psa_se_drv_table_entry_t *driver;
1345#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001346
Ronald Croncf56a0a2020-08-04 09:51:30 +02001347 if( mbedtls_svc_key_id_is_null( key ) )
Gilles Peskine1841cf42019-10-08 15:48:25 +02001348 return( PSA_SUCCESS );
1349
Ronald Cronf2911112020-10-29 17:51:10 +01001350 /*
Ronald Cron19daca92020-11-10 18:08:03 +01001351 * Get the description of the key in a key slot. In case of a persistent
Ronald Cronf2911112020-10-29 17:51:10 +01001352 * key, this will load the key description from persistent memory if not
1353 * done yet. We cannot avoid this loading as without it we don't know if
1354 * the key is operated by an SE or not and this information is needed by
1355 * the current implementation.
1356 */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001357 status = psa_get_key_slot( key, &slot );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001358 if( status != PSA_SUCCESS )
1359 return( status );
Gilles Peskine354f7672019-07-12 23:46:38 +02001360
Ronald Cronf2911112020-10-29 17:51:10 +01001361 /*
1362 * If the key slot containing the key description is under access by the
1363 * library (apart from the present access), the key cannot be destroyed
1364 * yet. For the time being, just return in error. Eventually (to be
1365 * implemented), the key should be destroyed when all accesses have
1366 * stopped.
1367 */
1368 if( slot->access_count > 1 )
1369 {
1370 psa_decrement_key_slot_access_count( slot );
1371 return( PSA_ERROR_GENERIC_ERROR );
1372 }
1373
Gilles Peskine354f7672019-07-12 23:46:38 +02001374#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001375 driver = psa_get_se_driver_entry( slot->attr.lifetime );
Gilles Peskine354f7672019-07-12 23:46:38 +02001376 if( driver != NULL )
Gilles Peskinefc762652019-07-22 19:30:34 +02001377 {
Gilles Peskine60450a42019-07-25 11:32:45 +02001378 /* For a key in a secure element, we need to do three things:
1379 * remove the key file in internal storage, destroy the
1380 * key inside the secure element, and update the driver's
1381 * persistent data. Start a transaction that will encompass these
1382 * three actions. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001383 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_DESTROY_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +02001384 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Gilles Peskinefc762652019-07-22 19:30:34 +02001385 psa_crypto_transaction.key.slot = slot->data.se.slot_number;
Gilles Peskine8e338702019-07-30 20:06:31 +02001386 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskinefc762652019-07-22 19:30:34 +02001387 status = psa_crypto_save_transaction( );
1388 if( status != PSA_SUCCESS )
1389 {
Gilles Peskine66be51c2019-07-25 18:02:52 +02001390 (void) psa_crypto_stop_transaction( );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001391 /* We should still try to destroy the key in the secure
1392 * element and the key metadata in storage. This is especially
1393 * important if the error is that the storage is full.
1394 * But how to do it exactly without risking an inconsistent
1395 * state after a reset?
1396 * https://github.com/ARMmbed/mbed-crypto/issues/215
1397 */
1398 overall_status = status;
1399 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001400 }
1401
Gilles Peskine354f7672019-07-12 23:46:38 +02001402 status = psa_destroy_se_key( driver, slot->data.se.slot_number );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001403 if( overall_status == PSA_SUCCESS )
1404 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001405 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001406#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1407
Darryl Greend49a4992018-06-18 17:27:26 +01001408#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Ronald Crond98059d2020-10-23 18:00:55 +02001409 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Darryl Greend49a4992018-06-18 17:27:26 +01001410 {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001411 status = psa_destroy_persistent_key( slot->attr.id );
1412 if( overall_status == PSA_SUCCESS )
1413 overall_status = status;
1414
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001415 /* TODO: other slots may have a copy of the same key. We should
1416 * invalidate them.
1417 * https://github.com/ARMmbed/mbed-crypto/issues/214
1418 */
Darryl Greend49a4992018-06-18 17:27:26 +01001419 }
1420#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001421
Gilles Peskinefc762652019-07-22 19:30:34 +02001422#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1423 if( driver != NULL )
1424 {
Gilles Peskine725f22a2019-07-25 11:31:48 +02001425 status = psa_save_se_persistent_data( driver );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001426 if( overall_status == PSA_SUCCESS )
1427 overall_status = status;
1428 status = psa_crypto_stop_transaction( );
1429 if( overall_status == PSA_SUCCESS )
1430 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001431 }
1432#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1433
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001434#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1435exit:
1436#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001437 status = psa_wipe_key_slot( slot );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001438 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
1439 if( overall_status == PSA_SUCCESS )
1440 overall_status = status;
1441 return( overall_status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001442}
1443
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001444void psa_reset_key_attributes( psa_key_attributes_t *attributes )
Gilles Peskineb870b182018-07-06 16:02:09 +02001445{
Gilles Peskineb699f072019-04-26 16:06:02 +02001446 mbedtls_free( attributes->domain_parameters );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001447 memset( attributes, 0, sizeof( *attributes ) );
Gilles Peskineb870b182018-07-06 16:02:09 +02001448}
1449
Gilles Peskineb699f072019-04-26 16:06:02 +02001450psa_status_t psa_set_key_domain_parameters( psa_key_attributes_t *attributes,
1451 psa_key_type_t type,
1452 const uint8_t *data,
1453 size_t data_length )
1454{
1455 uint8_t *copy = NULL;
1456
1457 if( data_length != 0 )
1458 {
1459 copy = mbedtls_calloc( 1, data_length );
1460 if( copy == NULL )
1461 return( PSA_ERROR_INSUFFICIENT_MEMORY );
1462 memcpy( copy, data, data_length );
1463 }
1464 /* After this point, this function is guaranteed to succeed, so it
1465 * can start modifying `*attributes`. */
1466
1467 if( attributes->domain_parameters != NULL )
1468 {
1469 mbedtls_free( attributes->domain_parameters );
1470 attributes->domain_parameters = NULL;
1471 attributes->domain_parameters_size = 0;
1472 }
1473
1474 attributes->domain_parameters = copy;
1475 attributes->domain_parameters_size = data_length;
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001476 attributes->core.type = type;
Gilles Peskineb699f072019-04-26 16:06:02 +02001477 return( PSA_SUCCESS );
1478}
1479
1480psa_status_t psa_get_key_domain_parameters(
1481 const psa_key_attributes_t *attributes,
1482 uint8_t *data, size_t data_size, size_t *data_length )
1483{
1484 if( attributes->domain_parameters_size > data_size )
1485 return( PSA_ERROR_BUFFER_TOO_SMALL );
1486 *data_length = attributes->domain_parameters_size;
1487 if( attributes->domain_parameters_size != 0 )
1488 memcpy( data, attributes->domain_parameters,
1489 attributes->domain_parameters_size );
1490 return( PSA_SUCCESS );
1491}
1492
1493#if defined(MBEDTLS_RSA_C)
1494static psa_status_t psa_get_rsa_public_exponent(
1495 const mbedtls_rsa_context *rsa,
1496 psa_key_attributes_t *attributes )
1497{
1498 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001499 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001500 uint8_t *buffer = NULL;
1501 size_t buflen;
1502 mbedtls_mpi_init( &mpi );
1503
1504 ret = mbedtls_rsa_export( rsa, NULL, NULL, NULL, NULL, &mpi );
1505 if( ret != 0 )
1506 goto exit;
Gilles Peskine772c8b12019-04-26 17:37:21 +02001507 if( mbedtls_mpi_cmp_int( &mpi, 65537 ) == 0 )
1508 {
1509 /* It's the default value, which is reported as an empty string,
1510 * so there's nothing to do. */
1511 goto exit;
1512 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001513
1514 buflen = mbedtls_mpi_size( &mpi );
1515 buffer = mbedtls_calloc( 1, buflen );
1516 if( buffer == NULL )
1517 {
1518 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1519 goto exit;
1520 }
1521 ret = mbedtls_mpi_write_binary( &mpi, buffer, buflen );
1522 if( ret != 0 )
1523 goto exit;
1524 attributes->domain_parameters = buffer;
1525 attributes->domain_parameters_size = buflen;
1526
1527exit:
1528 mbedtls_mpi_free( &mpi );
1529 if( ret != 0 )
1530 mbedtls_free( buffer );
1531 return( mbedtls_to_psa_error( ret ) );
1532}
1533#endif /* MBEDTLS_RSA_C */
1534
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001535/** Retrieve all the publicly-accessible attributes of a key.
1536 */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001537psa_status_t psa_get_key_attributes( mbedtls_svc_key_id_t key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001538 psa_key_attributes_t *attributes )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001539{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001540 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1541 psa_status_t decrement_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001542 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001543
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001544 psa_reset_key_attributes( attributes );
1545
Ronald Croncf56a0a2020-08-04 09:51:30 +02001546 status = psa_get_key_from_slot( key, &slot, 0, 0 );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001547 if( status != PSA_SUCCESS )
1548 return( status );
Gilles Peskineb870b182018-07-06 16:02:09 +02001549
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001550 attributes->core = slot->attr;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001551 attributes->core.flags &= ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1552 MBEDTLS_PSA_KA_MASK_DUAL_USE );
1553
1554#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1555 if( psa_key_slot_is_external( slot ) )
1556 psa_set_key_slot_number( attributes, slot->data.se.slot_number );
1557#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001558
Gilles Peskine8e338702019-07-30 20:06:31 +02001559 switch( slot->attr.type )
Gilles Peskineb699f072019-04-26 16:06:02 +02001560 {
1561#if defined(MBEDTLS_RSA_C)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001562 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001563 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001564#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001565 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001566 * is not yet implemented.
1567 * https://github.com/ARMmbed/mbed-crypto/issues/216
1568 */
Gilles Peskinec8000c02019-08-02 20:15:51 +02001569 if( psa_key_slot_is_external( slot ) )
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001570 break;
1571#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Steven Cooremana01795d2020-07-24 22:48:15 +02001572 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001573 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001574
Steven Cooreman4fed4552020-08-03 14:46:03 +02001575 status = psa_load_rsa_representation( slot->attr.type,
1576 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02001577 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02001578 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001579 if( status != PSA_SUCCESS )
1580 break;
1581
Steven Cooremana2371e52020-07-28 14:30:39 +02001582 status = psa_get_rsa_public_exponent( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02001583 attributes );
Steven Cooremana2371e52020-07-28 14:30:39 +02001584 mbedtls_rsa_free( rsa );
1585 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001586 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001587 break;
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001588#endif /* MBEDTLS_RSA_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001589 default:
1590 /* Nothing else to do. */
1591 break;
1592 }
1593
1594 if( status != PSA_SUCCESS )
1595 psa_reset_key_attributes( attributes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001596
1597 decrement_status = psa_decrement_key_slot_access_count( slot );
1598
1599 return( ( status == PSA_SUCCESS ) ? decrement_status : status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001600}
1601
Gilles Peskinec8000c02019-08-02 20:15:51 +02001602#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1603psa_status_t psa_get_key_slot_number(
1604 const psa_key_attributes_t *attributes,
1605 psa_key_slot_number_t *slot_number )
1606{
1607 if( attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER )
1608 {
1609 *slot_number = attributes->slot_number;
1610 return( PSA_SUCCESS );
1611 }
1612 else
1613 return( PSA_ERROR_INVALID_ARGUMENT );
1614}
1615#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1616
Steven Cooremana01795d2020-07-24 22:48:15 +02001617static psa_status_t psa_internal_export_key_buffer( const psa_key_slot_t *slot,
1618 uint8_t *data,
1619 size_t data_size,
1620 size_t *data_length )
1621{
1622 if( slot->data.key.bytes > data_size )
1623 return( PSA_ERROR_BUFFER_TOO_SMALL );
1624 memcpy( data, slot->data.key.data, slot->data.key.bytes );
1625 memset( data + slot->data.key.bytes, 0,
1626 data_size - slot->data.key.bytes );
1627 *data_length = slot->data.key.bytes;
1628 return( PSA_SUCCESS );
1629}
1630
Gilles Peskinef603c712019-01-19 13:40:11 +01001631static psa_status_t psa_internal_export_key( const psa_key_slot_t *slot,
1632 uint8_t *data,
1633 size_t data_size,
1634 size_t *data_length,
1635 int export_public_key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001636{
Gilles Peskine5d309672019-07-12 23:47:28 +02001637#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1638 const psa_drv_se_t *drv;
1639 psa_drv_se_context_t *drv_context;
1640#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1641
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001642 *data_length = 0;
1643
Gilles Peskine8e338702019-07-30 20:06:31 +02001644 if( export_public_key && ! PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
Moran Pekera998bc62018-04-16 18:16:20 +03001645 return( PSA_ERROR_INVALID_ARGUMENT );
mohammad160306e79202018-03-28 13:17:44 +03001646
Gilles Peskinef9168942019-09-12 19:20:29 +02001647 /* Reject a zero-length output buffer now, since this can never be a
1648 * valid key representation. This way we know that data must be a valid
1649 * pointer and we can do things like memset(data, ..., data_size). */
1650 if( data_size == 0 )
1651 return( PSA_ERROR_BUFFER_TOO_SMALL );
1652
Gilles Peskine5d309672019-07-12 23:47:28 +02001653#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001654 if( psa_get_se_driver( slot->attr.lifetime, &drv, &drv_context ) )
Gilles Peskine5d309672019-07-12 23:47:28 +02001655 {
1656 psa_drv_se_export_key_t method;
1657 if( drv->key_management == NULL )
1658 return( PSA_ERROR_NOT_SUPPORTED );
1659 method = ( export_public_key ?
1660 drv->key_management->p_export_public :
1661 drv->key_management->p_export );
1662 if( method == NULL )
1663 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine2e0f3882019-07-25 11:34:33 +02001664 return( method( drv_context,
1665 slot->data.se.slot_number,
1666 data, data_size, data_length ) );
Gilles Peskine5d309672019-07-12 23:47:28 +02001667 }
1668#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1669
Gilles Peskine8e338702019-07-30 20:06:31 +02001670 if( key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001671 {
Steven Cooremanacda8342020-07-24 23:09:52 +02001672 return( psa_internal_export_key_buffer( slot, data, data_size, data_length ) );
Gilles Peskine188c71e2018-10-29 19:26:02 +01001673 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001674 else if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) ||
1675 PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
Moran Peker17e36e12018-05-02 12:55:20 +03001676 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001677 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Gilles Peskine969ac722018-01-28 18:16:59 +01001678 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001679 /* Exporting public -> public */
1680 return( psa_internal_export_key_buffer( slot, data, data_size, data_length ) );
1681 }
1682 else if( !export_public_key )
1683 {
1684 /* Exporting private -> private */
1685 return( psa_internal_export_key_buffer( slot, data, data_size, data_length ) );
1686 }
1687 /* Need to export the public part of a private key,
1688 * so conversion is needed */
1689 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
1690 {
Darryl Green9e2d7a02018-07-24 16:33:30 +01001691#if defined(MBEDTLS_RSA_C)
Steven Cooremana2371e52020-07-28 14:30:39 +02001692 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman7f391872020-07-30 14:57:44 +02001693 psa_status_t status = psa_load_rsa_representation(
Steven Cooreman4fed4552020-08-03 14:46:03 +02001694 slot->attr.type,
Steven Cooreman7f391872020-07-30 14:57:44 +02001695 slot->data.key.data,
1696 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02001697 &rsa );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001698 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001699 return( status );
Steven Cooremana01795d2020-07-24 22:48:15 +02001700
Steven Cooreman560c28a2020-07-24 23:20:24 +02001701 status = psa_export_rsa_key( PSA_KEY_TYPE_RSA_PUBLIC_KEY,
Steven Cooremana2371e52020-07-28 14:30:39 +02001702 rsa,
Steven Cooreman560c28a2020-07-24 23:20:24 +02001703 data,
1704 data_size,
1705 data_length );
Steven Cooremana01795d2020-07-24 22:48:15 +02001706
Steven Cooremana2371e52020-07-28 14:30:39 +02001707 mbedtls_rsa_free( rsa );
1708 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001709
Steven Cooreman560c28a2020-07-24 23:20:24 +02001710 return( status );
Darryl Green9e2d7a02018-07-24 16:33:30 +01001711#else
Steven Cooreman560c28a2020-07-24 23:20:24 +02001712 /* We don't know how to convert a private RSA key to public. */
1713 return( PSA_ERROR_NOT_SUPPORTED );
Darryl Green9e2d7a02018-07-24 16:33:30 +01001714#endif
Gilles Peskine969ac722018-01-28 18:16:59 +01001715 }
1716 else
Moran Pekera998bc62018-04-16 18:16:20 +03001717 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001718#if defined(MBEDTLS_ECP_C)
Steven Cooremana2371e52020-07-28 14:30:39 +02001719 mbedtls_ecp_keypair *ecp = NULL;
Steven Cooreman7f391872020-07-30 14:57:44 +02001720 psa_status_t status = psa_load_ecp_representation(
Steven Cooreman4fed4552020-08-03 14:46:03 +02001721 slot->attr.type,
Steven Cooreman7f391872020-07-30 14:57:44 +02001722 slot->data.key.data,
1723 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02001724 &ecp );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001725 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001726 return( status );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001727
1728 status = psa_export_ecp_key( PSA_KEY_TYPE_ECC_PUBLIC_KEY(
1729 PSA_KEY_TYPE_ECC_GET_FAMILY(
1730 slot->attr.type ) ),
Steven Cooremana2371e52020-07-28 14:30:39 +02001731 ecp,
Steven Cooreman560c28a2020-07-24 23:20:24 +02001732 data,
1733 data_size,
1734 data_length );
1735
Steven Cooremana2371e52020-07-28 14:30:39 +02001736 mbedtls_ecp_keypair_free( ecp );
1737 mbedtls_free( ecp );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001738 return( status );
1739#else
1740 /* We don't know how to convert a private ECC key to public */
Moran Pekera998bc62018-04-16 18:16:20 +03001741 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001742#endif
Moran Pekera998bc62018-04-16 18:16:20 +03001743 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001744 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001745 else
1746 {
1747 /* This shouldn't happen in the reference implementation, but
1748 it is valid for a special-purpose implementation to omit
1749 support for exporting certain key types. */
1750 return( PSA_ERROR_NOT_SUPPORTED );
1751 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001752}
1753
Ronald Croncf56a0a2020-08-04 09:51:30 +02001754psa_status_t psa_export_key( mbedtls_svc_key_id_t key,
Gilles Peskine2d277862018-06-18 15:41:12 +02001755 uint8_t *data,
1756 size_t data_size,
1757 size_t *data_length )
Moran Pekera998bc62018-04-16 18:16:20 +03001758{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001759 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1760 psa_status_t decrement_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001761 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001762
1763 /* Set the key to empty now, so that even when there are errors, we always
1764 * set data_length to a value between 0 and data_size. On error, setting
1765 * the key to empty is a good choice because an empty key representation is
1766 * unlikely to be accepted anywhere. */
1767 *data_length = 0;
1768
1769 /* Export requires the EXPORT flag. There is an exception for public keys,
1770 * which don't require any flag, but psa_get_key_from_slot takes
1771 * care of this. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001772 status = psa_get_key_from_slot( key, &slot, PSA_KEY_USAGE_EXPORT, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001773 if( status != PSA_SUCCESS )
1774 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001775
1776 status = psa_internal_export_key( slot, data, data_size, data_length, 0 );
1777 decrement_status = psa_decrement_key_slot_access_count( slot );
1778
1779 return( ( status == PSA_SUCCESS ) ? decrement_status : status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001780}
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001781
Ronald Croncf56a0a2020-08-04 09:51:30 +02001782psa_status_t psa_export_public_key( mbedtls_svc_key_id_t key,
Gilles Peskine2d277862018-06-18 15:41:12 +02001783 uint8_t *data,
1784 size_t data_size,
1785 size_t *data_length )
Moran Pekerdd4ea382018-04-03 15:30:03 +03001786{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001787 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1788 psa_status_t decrement_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001789 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001790
1791 /* Set the key to empty now, so that even when there are errors, we always
1792 * set data_length to a value between 0 and data_size. On error, setting
1793 * the key to empty is a good choice because an empty key representation is
1794 * unlikely to be accepted anywhere. */
1795 *data_length = 0;
1796
1797 /* Exporting a public key doesn't require a usage flag. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001798 status = psa_get_key_from_slot( key, &slot, 0, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001799 if( status != PSA_SUCCESS )
1800 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001801
1802 status = psa_internal_export_key( slot, data, data_size, data_length, 1 );
1803 decrement_status = psa_decrement_key_slot_access_count( slot );
1804
1805 return( ( status == PSA_SUCCESS ) ? decrement_status : status );
Moran Pekerdd4ea382018-04-03 15:30:03 +03001806}
1807
Gilles Peskine91e8c332019-08-02 19:19:39 +02001808#if defined(static_assert)
1809static_assert( ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
1810 "One or more key attribute flag is listed as both external-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001811static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
Gilles Peskine094dac12019-08-07 18:19:46 +02001812 "One or more key attribute flag is listed as both internal-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001813static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY ) == 0,
Gilles Peskine91e8c332019-08-02 19:19:39 +02001814 "One or more key attribute flag is listed as both internal-only and external-only" );
1815#endif
1816
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001817/** Validate that a key policy is internally well-formed.
1818 *
1819 * This function only rejects invalid policies. It does not validate the
1820 * consistency of the policy with respect to other attributes of the key
1821 * such as the key type.
1822 */
1823static psa_status_t psa_validate_key_policy( const psa_key_policy_t *policy )
Gilles Peskine4747d192019-04-17 15:05:45 +02001824{
1825 if( ( policy->usage & ~( PSA_KEY_USAGE_EXPORT |
Gilles Peskine8e0206a2019-05-14 14:24:28 +02001826 PSA_KEY_USAGE_COPY |
Gilles Peskine4747d192019-04-17 15:05:45 +02001827 PSA_KEY_USAGE_ENCRYPT |
1828 PSA_KEY_USAGE_DECRYPT |
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001829 PSA_KEY_USAGE_SIGN_HASH |
1830 PSA_KEY_USAGE_VERIFY_HASH |
Gilles Peskine4747d192019-04-17 15:05:45 +02001831 PSA_KEY_USAGE_DERIVE ) ) != 0 )
1832 return( PSA_ERROR_INVALID_ARGUMENT );
1833
Gilles Peskine4747d192019-04-17 15:05:45 +02001834 return( PSA_SUCCESS );
1835}
1836
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001837/** Validate the internal consistency of key attributes.
1838 *
1839 * This function only rejects invalid attribute values. If does not
1840 * validate the consistency of the attributes with any key data that may
1841 * be involved in the creation of the key.
1842 *
1843 * Call this function early in the key creation process.
1844 *
1845 * \param[in] attributes Key attributes for the new key.
1846 * \param[out] p_drv On any return, the driver for the key, if any.
1847 * NULL for a transparent key.
1848 *
1849 */
1850static psa_status_t psa_validate_key_attributes(
1851 const psa_key_attributes_t *attributes,
1852 psa_se_drv_table_entry_t **p_drv )
Darryl Green0c6575a2018-11-07 16:05:30 +00001853{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001854 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Ronald Crond2ed4812020-07-17 16:11:30 +02001855 psa_key_lifetime_t lifetime = psa_get_key_lifetime( attributes );
Ronald Cron65f38a32020-10-23 17:11:13 +02001856 mbedtls_svc_key_id_t key = psa_get_key_id( attributes );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001857
Ronald Cron54b90082020-10-29 15:26:43 +01001858 status = psa_validate_key_location( lifetime, p_drv );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001859 if( status != PSA_SUCCESS )
1860 return( status );
1861
Ronald Crond2ed4812020-07-17 16:11:30 +02001862 status = psa_validate_key_persistence( lifetime );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001863 if( status != PSA_SUCCESS )
1864 return( status );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001865
Ronald Cron65f38a32020-10-23 17:11:13 +02001866 if ( PSA_KEY_LIFETIME_IS_VOLATILE( lifetime ) )
1867 {
1868 if( MBEDTLS_SVC_KEY_ID_GET_KEY_ID( key ) != 0 )
1869 return( PSA_ERROR_INVALID_ARGUMENT );
1870 }
1871 else
Ronald Crond2ed4812020-07-17 16:11:30 +02001872 {
Ronald Croncbd7bea2020-11-11 14:57:44 +01001873 status = psa_validate_key_id( psa_get_key_id( attributes ), 0 );
Ronald Crond2ed4812020-07-17 16:11:30 +02001874 if( status != PSA_SUCCESS )
1875 return( status );
1876 }
1877
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001878 status = psa_validate_key_policy( &attributes->core.policy );
Darryl Green0c6575a2018-11-07 16:05:30 +00001879 if( status != PSA_SUCCESS )
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001880 return( status );
1881
1882 /* Refuse to create overly large keys.
1883 * Note that this doesn't trigger on import if the attributes don't
1884 * explicitly specify a size (so psa_get_key_bits returns 0), so
1885 * psa_import_key() needs its own checks. */
1886 if( psa_get_key_bits( attributes ) > PSA_MAX_KEY_BITS )
1887 return( PSA_ERROR_NOT_SUPPORTED );
1888
Gilles Peskine91e8c332019-08-02 19:19:39 +02001889 /* Reject invalid flags. These should not be reachable through the API. */
1890 if( attributes->core.flags & ~ ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1891 MBEDTLS_PSA_KA_MASK_DUAL_USE ) )
1892 return( PSA_ERROR_INVALID_ARGUMENT );
1893
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001894 return( PSA_SUCCESS );
1895}
1896
Gilles Peskine4747d192019-04-17 15:05:45 +02001897/** Prepare a key slot to receive key material.
1898 *
1899 * This function allocates a key slot and sets its metadata.
1900 *
1901 * If this function fails, call psa_fail_key_creation().
1902 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001903 * This function is intended to be used as follows:
1904 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001905 * it with the specified attributes, and in case of a volatile key assign it
1906 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001907 * -# Populate the slot with the key material.
1908 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1909 * In case of failure at any step, stop the sequence and call
1910 * psa_fail_key_creation().
1911 *
Ronald Cronf95a2b12020-10-22 15:24:49 +02001912 * On success, the access counter of the returned key slot is incremented by
1913 * one. It is the responsibility of the caller to call
1914 * psa_decrement_key_slot_access_count() when it does not access the key slot
1915 * anymore.
1916 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001917 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001918 * \param[in] attributes Key attributes for the new key.
Ronald Cron3c76a422020-10-16 12:17:04 +02001919 * \param[out] key On success, identifier of the key. Note that the
1920 * key identifier is also stored in the prepared
1921 * slot.
Gilles Peskine011e4282019-06-26 18:34:38 +02001922 * \param[out] p_slot On success, a pointer to the prepared slot.
1923 * \param[out] p_drv On any return, the driver for the key, if any.
1924 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001925 *
1926 * \retval #PSA_SUCCESS
1927 * The key slot is ready to receive key material.
1928 * \return If this function fails, the key slot is an invalid state.
1929 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001930 */
1931static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001932 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001933 const psa_key_attributes_t *attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02001934 mbedtls_svc_key_id_t *key,
Gilles Peskine011e4282019-06-26 18:34:38 +02001935 psa_key_slot_t **p_slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001936 psa_se_drv_table_entry_t **p_drv )
Gilles Peskine4747d192019-04-17 15:05:45 +02001937{
1938 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001939 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001940 psa_key_slot_t *slot;
1941
Gilles Peskinedf179142019-07-15 22:02:14 +02001942 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001943 *p_drv = NULL;
1944
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001945 status = psa_validate_key_attributes( attributes, p_drv );
1946 if( status != PSA_SUCCESS )
1947 return( status );
1948
Ronald Cronc4d1b512020-07-31 11:26:37 +02001949 status = psa_get_empty_key_slot( &volatile_key_id, p_slot );
Gilles Peskine4747d192019-04-17 15:05:45 +02001950 if( status != PSA_SUCCESS )
1951 return( status );
1952 slot = *p_slot;
1953
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001954 /* We're storing the declared bit-size of the key. It's up to each
1955 * creation mechanism to verify that this information is correct.
1956 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001957 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001958 * is optional (import, copy). In case of a volatile key, assign it the
1959 * volatile key identifier associated to the slot returned to contain its
1960 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001961
1962 slot->attr = attributes->core;
Ronald Cronc4d1b512020-07-31 11:26:37 +02001963 if( PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
1964 {
1965#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1966 slot->attr.id = volatile_key_id;
1967#else
1968 slot->attr.id.key_id = volatile_key_id;
1969#endif
1970 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001971
Gilles Peskine91e8c332019-08-02 19:19:39 +02001972 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001973 * external-only flags, query `attributes`. Thanks to the check
1974 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001975 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001976 * may have set. */
1977 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001978
Gilles Peskinecbaff462019-07-12 23:46:04 +02001979#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001980 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001981 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001982 * create the key file in internal storage, create the
1983 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001984 * persistent data. This is done by starting a transaction that will
1985 * encompass these three actions.
1986 * For registering a volatile key, we just need to find an appropriate
1987 * slot number inside the SE. Since the key is designated volatile, creating
1988 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001989 /* The first thing to do is to find a slot number for the new key.
1990 * We save the slot number in persistent storage as part of the
1991 * transaction data. It will be needed to recover if the power
1992 * fails during the key creation process, to clean up on the secure
1993 * element side after restarting. Obtaining a slot number from the
1994 * secure element driver updates its persistent state, but we do not yet
1995 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001996 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001997 if( *p_drv != NULL )
Darryl Green0c6575a2018-11-07 16:05:30 +00001998 {
Gilles Peskinee88c2c12019-08-05 16:44:14 +02001999 status = psa_find_se_slot_for_key( attributes, method, *p_drv,
Gilles Peskinecbaff462019-07-12 23:46:04 +02002000 &slot->data.se.slot_number );
2001 if( status != PSA_SUCCESS )
2002 return( status );
Steven Cooremanbbeaf182020-06-08 18:29:44 +02002003
2004 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( attributes->core.lifetime ) )
Gilles Peskine66be51c2019-07-25 18:02:52 +02002005 {
Steven Cooremanbbeaf182020-06-08 18:29:44 +02002006 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_CREATE_KEY );
2007 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
2008 psa_crypto_transaction.key.slot = slot->data.se.slot_number;
2009 psa_crypto_transaction.key.id = slot->attr.id;
2010 status = psa_crypto_save_transaction( );
2011 if( status != PSA_SUCCESS )
2012 {
2013 (void) psa_crypto_stop_transaction( );
2014 return( status );
2015 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02002016 }
Darryl Green0c6575a2018-11-07 16:05:30 +00002017 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02002018
2019 if( *p_drv == NULL && method == PSA_KEY_CREATION_REGISTER )
2020 {
2021 /* Key registration only makes sense with a secure element. */
2022 return( PSA_ERROR_INVALID_ARGUMENT );
2023 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02002024#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2025
Ronald Croncf56a0a2020-08-04 09:51:30 +02002026 *key = slot->attr.id;
Ronald Cronc4d1b512020-07-31 11:26:37 +02002027 return( PSA_SUCCESS );
Darryl Green0c6575a2018-11-07 16:05:30 +00002028}
Gilles Peskine4747d192019-04-17 15:05:45 +02002029
2030/** Finalize the creation of a key once its key material has been set.
2031 *
2032 * This entails writing the key to persistent storage.
2033 *
2034 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02002035 * See the documentation of psa_start_key_creation() for the intended use
2036 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02002037 *
Gilles Peskine011e4282019-06-26 18:34:38 +02002038 * \param[in,out] slot Pointer to the slot with key material.
2039 * \param[in] driver The secure element driver for the key,
2040 * or NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02002041 *
2042 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02002043 * The key was successfully created.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02002044 * \return If this function fails, the key slot is an invalid state.
2045 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02002046 */
Gilles Peskine011e4282019-06-26 18:34:38 +02002047static psa_status_t psa_finish_key_creation(
2048 psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002049 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02002050{
2051 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02002052 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02002053 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02002054
2055#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Steven Cooremanc59de6a2020-06-08 18:28:25 +02002056 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Gilles Peskine4747d192019-04-17 15:05:45 +02002057 {
Gilles Peskine1df83d42019-07-23 16:13:14 +02002058#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2059 if( driver != NULL )
2060 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02002061 psa_se_key_data_storage_t data;
2062#if defined(static_assert)
2063 static_assert( sizeof( slot->data.se.slot_number ) ==
2064 sizeof( data.slot_number ),
2065 "Slot number size does not match psa_se_key_data_storage_t" );
Gilles Peskineb46bef22019-07-30 21:32:04 +02002066#endif
2067 memcpy( &data.slot_number, &slot->data.se.slot_number,
2068 sizeof( slot->data.se.slot_number ) );
Gilles Peskine76aa09c2019-07-31 14:15:34 +02002069 status = psa_save_persistent_key( &slot->attr,
Gilles Peskineb46bef22019-07-30 21:32:04 +02002070 (uint8_t*) &data,
2071 sizeof( data ) );
Gilles Peskine1df83d42019-07-23 16:13:14 +02002072 }
2073 else
2074#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2075 {
Steven Cooreman40120f62020-10-29 11:42:22 +01002076 /* Key material is saved in export representation in the slot, so
2077 * just pass the slot buffer for storage. */
2078 status = psa_save_persistent_key( &slot->attr,
2079 slot->data.key.data,
2080 slot->data.key.bytes );
Gilles Peskine1df83d42019-07-23 16:13:14 +02002081 }
Gilles Peskine4747d192019-04-17 15:05:45 +02002082 }
Darryl Green0c6575a2018-11-07 16:05:30 +00002083#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
2084
Gilles Peskinecbaff462019-07-12 23:46:04 +02002085#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02002086 /* Finish the transaction for a key creation. This does not
2087 * happen when registering an existing key. Detect this case
2088 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02002089 * creation of a persistent key in a secure element requires a transaction,
2090 * but registration or volatile key creation doesn't use one). */
Gilles Peskined7729582019-08-05 15:55:54 +02002091 if( driver != NULL &&
2092 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY )
Gilles Peskinecbaff462019-07-12 23:46:04 +02002093 {
2094 status = psa_save_se_persistent_data( driver );
2095 if( status != PSA_SUCCESS )
2096 {
Gilles Peskine8e338702019-07-30 20:06:31 +02002097 psa_destroy_persistent_key( slot->attr.id );
Gilles Peskinecbaff462019-07-12 23:46:04 +02002098 return( status );
2099 }
Gilles Peskinefc762652019-07-22 19:30:34 +02002100 status = psa_crypto_stop_transaction( );
2101 if( status != PSA_SUCCESS )
2102 return( status );
Gilles Peskinecbaff462019-07-12 23:46:04 +02002103 }
2104#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2105
Gilles Peskine4747d192019-04-17 15:05:45 +02002106 return( status );
2107}
2108
2109/** Abort the creation of a key.
2110 *
2111 * You may call this function after calling psa_start_key_creation(),
2112 * or after psa_finish_key_creation() fails. In other circumstances, this
2113 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02002114 * See the documentation of psa_start_key_creation() for the intended use
2115 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02002116 *
Gilles Peskine011e4282019-06-26 18:34:38 +02002117 * \param[in,out] slot Pointer to the slot with key material.
2118 * \param[in] driver The secure element driver for the key,
2119 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02002120 */
Gilles Peskine011e4282019-06-26 18:34:38 +02002121static void psa_fail_key_creation( psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002122 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02002123{
Gilles Peskine011e4282019-06-26 18:34:38 +02002124 (void) driver;
2125
Gilles Peskine4747d192019-04-17 15:05:45 +02002126 if( slot == NULL )
2127 return;
Gilles Peskine011e4282019-06-26 18:34:38 +02002128
2129#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01002130 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02002131 * element, and the failure happened later (when saving metadata
2132 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02002133 * element.
2134 * https://github.com/ARMmbed/mbed-crypto/issues/217
2135 */
Gilles Peskinefc762652019-07-22 19:30:34 +02002136
Gilles Peskined7729582019-08-05 15:55:54 +02002137 /* Abort the ongoing transaction if any (there may not be one if
2138 * the creation process failed before starting one, or if the
2139 * key creation is a registration of a key in a secure element).
2140 * Earlier functions must already have done what it takes to undo any
2141 * partial creation. All that's left is to update the transaction data
2142 * itself. */
Gilles Peskinefc762652019-07-22 19:30:34 +02002143 (void) psa_crypto_stop_transaction( );
Gilles Peskine011e4282019-06-26 18:34:38 +02002144#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2145
Gilles Peskine4747d192019-04-17 15:05:45 +02002146 psa_wipe_key_slot( slot );
2147}
2148
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002149/** Validate optional attributes during key creation.
2150 *
2151 * Some key attributes are optional during key creation. If they are
2152 * specified in the attributes structure, check that they are consistent
2153 * with the data in the slot.
2154 *
2155 * This function should be called near the end of key creation, after
2156 * the slot in memory is fully populated but before saving persistent data.
2157 */
2158static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002159 const psa_key_slot_t *slot,
2160 const psa_key_attributes_t *attributes )
2161{
Gilles Peskine7e0cff92019-07-30 13:48:52 +02002162 if( attributes->core.type != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002163 {
Gilles Peskine8e338702019-07-30 20:06:31 +02002164 if( attributes->core.type != slot->attr.type )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002165 return( PSA_ERROR_INVALID_ARGUMENT );
2166 }
2167
2168 if( attributes->domain_parameters_size != 0 )
2169 {
2170#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02002171 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002172 {
Steven Cooremana2371e52020-07-28 14:30:39 +02002173 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02002174 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02002175 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02002176
Steven Cooreman7f391872020-07-30 14:57:44 +02002177 psa_status_t status = psa_load_rsa_representation(
Steven Cooreman4fed4552020-08-03 14:46:03 +02002178 slot->attr.type,
Steven Cooreman7f391872020-07-30 14:57:44 +02002179 slot->data.key.data,
2180 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02002181 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02002182 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02002183 return( status );
Steven Cooreman75b74362020-07-28 14:30:13 +02002184
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002185 mbedtls_mpi_init( &actual );
2186 mbedtls_mpi_init( &required );
Steven Cooremana2371e52020-07-28 14:30:39 +02002187 ret = mbedtls_rsa_export( rsa,
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002188 NULL, NULL, NULL, NULL, &actual );
Steven Cooremana2371e52020-07-28 14:30:39 +02002189 mbedtls_rsa_free( rsa );
2190 mbedtls_free( rsa );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002191 if( ret != 0 )
2192 goto rsa_exit;
2193 ret = mbedtls_mpi_read_binary( &required,
2194 attributes->domain_parameters,
2195 attributes->domain_parameters_size );
2196 if( ret != 0 )
2197 goto rsa_exit;
2198 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
2199 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
2200 rsa_exit:
2201 mbedtls_mpi_free( &actual );
2202 mbedtls_mpi_free( &required );
2203 if( ret != 0)
2204 return( mbedtls_to_psa_error( ret ) );
2205 }
2206 else
2207#endif
2208 {
2209 return( PSA_ERROR_INVALID_ARGUMENT );
2210 }
2211 }
2212
Gilles Peskine7e0cff92019-07-30 13:48:52 +02002213 if( attributes->core.bits != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002214 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02002215 if( attributes->core.bits != slot->attr.bits )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002216 return( PSA_ERROR_INVALID_ARGUMENT );
2217 }
2218
2219 return( PSA_SUCCESS );
2220}
2221
Gilles Peskine4747d192019-04-17 15:05:45 +02002222psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02002223 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02002224 size_t data_length,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002225 mbedtls_svc_key_id_t *key )
Gilles Peskine4747d192019-04-17 15:05:45 +02002226{
2227 psa_status_t status;
2228 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002229 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002230
Gilles Peskine0f84d622019-09-12 19:03:13 +02002231 /* Reject zero-length symmetric keys (including raw data key objects).
2232 * This also rejects any key which might be encoded as an empty string,
2233 * which is never valid. */
2234 if( data_length == 0 )
2235 return( PSA_ERROR_INVALID_ARGUMENT );
2236
Gilles Peskinedf179142019-07-15 22:02:14 +02002237 status = psa_start_key_creation( PSA_KEY_CREATION_IMPORT, attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002238 key, &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002239 if( status != PSA_SUCCESS )
2240 goto exit;
2241
Gilles Peskine5d309672019-07-12 23:47:28 +02002242#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2243 if( driver != NULL )
2244 {
2245 const psa_drv_se_t *drv = psa_get_se_driver_methods( driver );
Darryl Green0892d0f2019-08-20 09:50:14 +01002246 /* The driver should set the number of key bits, however in
2247 * case it doesn't, we initialize bits to an invalid value. */
2248 size_t bits = PSA_MAX_KEY_BITS + 1;
Gilles Peskine5d309672019-07-12 23:47:28 +02002249 if( drv->key_management == NULL ||
2250 drv->key_management->p_import == NULL )
2251 {
2252 status = PSA_ERROR_NOT_SUPPORTED;
2253 goto exit;
2254 }
2255 status = drv->key_management->p_import(
2256 psa_get_se_driver_context( driver ),
Gilles Peskinef3801ff2019-08-06 17:32:04 +02002257 slot->data.se.slot_number, attributes, data, data_length,
Gilles Peskineb46bef22019-07-30 21:32:04 +02002258 &bits );
2259 if( status != PSA_SUCCESS )
2260 goto exit;
2261 if( bits > PSA_MAX_KEY_BITS )
2262 {
2263 status = PSA_ERROR_NOT_SUPPORTED;
2264 goto exit;
2265 }
2266 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskine5d309672019-07-12 23:47:28 +02002267 }
2268 else
2269#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2270 {
2271 status = psa_import_key_into_slot( slot, data, data_length );
2272 if( status != PSA_SUCCESS )
2273 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02002274 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002275 status = psa_validate_optional_attributes( slot, attributes );
Gilles Peskine18017402019-07-24 20:25:59 +02002276 if( status != PSA_SUCCESS )
2277 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002278
Gilles Peskine011e4282019-06-26 18:34:38 +02002279 status = psa_finish_key_creation( slot, driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002280exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02002281 if( status != PSA_SUCCESS )
2282 {
Gilles Peskine011e4282019-06-26 18:34:38 +02002283 psa_fail_key_creation( slot, driver );
Ronald Croncf56a0a2020-08-04 09:51:30 +02002284 *key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine4747d192019-04-17 15:05:45 +02002285 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002286 else
2287 status = psa_decrement_key_slot_access_count( slot );
2288
Gilles Peskine4747d192019-04-17 15:05:45 +02002289 return( status );
2290}
2291
Gilles Peskined7729582019-08-05 15:55:54 +02002292#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2293psa_status_t mbedtls_psa_register_se_key(
2294 const psa_key_attributes_t *attributes )
2295{
2296 psa_status_t status;
2297 psa_key_slot_t *slot = NULL;
2298 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02002299 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02002300
2301 /* Leaving attributes unspecified is not currently supported.
2302 * It could make sense to query the key type and size from the
2303 * secure element, but not all secure elements support this
2304 * and the driver HAL doesn't currently support it. */
2305 if( psa_get_key_type( attributes ) == PSA_KEY_TYPE_NONE )
2306 return( PSA_ERROR_NOT_SUPPORTED );
2307 if( psa_get_key_bits( attributes ) == 0 )
2308 return( PSA_ERROR_NOT_SUPPORTED );
2309
2310 status = psa_start_key_creation( PSA_KEY_CREATION_REGISTER, attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002311 &key, &slot, &driver );
Gilles Peskined7729582019-08-05 15:55:54 +02002312 if( status != PSA_SUCCESS )
2313 goto exit;
2314
Gilles Peskined7729582019-08-05 15:55:54 +02002315 status = psa_finish_key_creation( slot, driver );
2316
2317exit:
2318 if( status != PSA_SUCCESS )
Gilles Peskined7729582019-08-05 15:55:54 +02002319 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002320 else
2321 status = psa_decrement_key_slot_access_count( slot );
2322
Gilles Peskined7729582019-08-05 15:55:54 +02002323 /* Registration doesn't keep the key in RAM. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02002324 psa_close_key( key );
Gilles Peskined7729582019-08-05 15:55:54 +02002325 return( status );
2326}
2327#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2328
Gilles Peskinef603c712019-01-19 13:40:11 +01002329static psa_status_t psa_copy_key_material( const psa_key_slot_t *source,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002330 psa_key_slot_t *target )
Gilles Peskinef603c712019-01-19 13:40:11 +01002331{
Steven Cooremanf7cebd42020-10-13 20:27:40 +02002332 psa_status_t status = psa_copy_key_material_into_slot( target,
2333 source->data.key.data,
2334 source->data.key.bytes );
Gilles Peskinef603c712019-01-19 13:40:11 +01002335 if( status != PSA_SUCCESS )
Steven Cooreman398aee52020-10-13 14:35:45 +02002336 return( status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002337
Steven Cooreman398aee52020-10-13 14:35:45 +02002338 target->attr.type = source->attr.type;
2339 target->attr.bits = source->attr.bits;
2340
2341 return( PSA_SUCCESS );
Gilles Peskinef603c712019-01-19 13:40:11 +01002342}
2343
Ronald Croncf56a0a2020-08-04 09:51:30 +02002344psa_status_t psa_copy_key( mbedtls_svc_key_id_t source_key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002345 const psa_key_attributes_t *specified_attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002346 mbedtls_svc_key_id_t *target_key )
Gilles Peskinef603c712019-01-19 13:40:11 +01002347{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002348 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2349 psa_status_t decrement_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002350 psa_key_slot_t *source_slot = NULL;
2351 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002352 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002353 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskinef603c712019-01-19 13:40:11 +01002354
Ronald Croncf56a0a2020-08-04 09:51:30 +02002355 status = psa_get_transparent_key( source_key, &source_slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02002356 PSA_KEY_USAGE_COPY, 0 );
Gilles Peskinef603c712019-01-19 13:40:11 +01002357 if( status != PSA_SUCCESS )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002358 goto exit;
2359
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002360 status = psa_validate_optional_attributes( source_slot,
2361 specified_attributes );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002362 if( status != PSA_SUCCESS )
2363 goto exit;
2364
Gilles Peskine7e0cff92019-07-30 13:48:52 +02002365 status = psa_restrict_key_policy( &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02002366 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002367 if( status != PSA_SUCCESS )
2368 goto exit;
2369
Gilles Peskinedf179142019-07-15 22:02:14 +02002370 status = psa_start_key_creation( PSA_KEY_CREATION_COPY,
2371 &actual_attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002372 target_key, &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002373 if( status != PSA_SUCCESS )
2374 goto exit;
2375
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002376#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2377 if( driver != NULL )
Gilles Peskinef603c712019-01-19 13:40:11 +01002378 {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002379 /* Copying to a secure element is not implemented yet. */
2380 status = PSA_ERROR_NOT_SUPPORTED;
2381 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002382 }
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002383#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef603c712019-01-19 13:40:11 +01002384
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002385 status = psa_copy_key_material( source_slot, target_slot );
Gilles Peskinef603c712019-01-19 13:40:11 +01002386 if( status != PSA_SUCCESS )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002387 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002388
Gilles Peskine011e4282019-06-26 18:34:38 +02002389 status = psa_finish_key_creation( target_slot, driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002390exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002391 if( status != PSA_SUCCESS )
2392 {
Gilles Peskine011e4282019-06-26 18:34:38 +02002393 psa_fail_key_creation( target_slot, driver );
Ronald Croncf56a0a2020-08-04 09:51:30 +02002394 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002395 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002396 else
2397 status = psa_decrement_key_slot_access_count( target_slot );
2398
2399 decrement_status = psa_decrement_key_slot_access_count( source_slot );
2400
2401 return( ( status == PSA_SUCCESS ) ? decrement_status : status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002402}
2403
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002404
2405
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002406/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002407/* Message digests */
2408/****************************************************************/
2409
John Durkop0ea39e02020-10-13 19:58:20 -07002410#if defined(MBEDTLS_RSA_C) || defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinedc2fc842018-03-07 16:42:59 +01002411static const mbedtls_md_info_t *mbedtls_md_info_from_psa( psa_algorithm_t alg )
Gilles Peskine20035e32018-02-03 22:44:14 +01002412{
2413 switch( alg )
2414 {
2415#if defined(MBEDTLS_MD2_C)
2416 case PSA_ALG_MD2:
2417 return( &mbedtls_md2_info );
2418#endif
2419#if defined(MBEDTLS_MD4_C)
2420 case PSA_ALG_MD4:
2421 return( &mbedtls_md4_info );
2422#endif
2423#if defined(MBEDTLS_MD5_C)
2424 case PSA_ALG_MD5:
2425 return( &mbedtls_md5_info );
2426#endif
2427#if defined(MBEDTLS_RIPEMD160_C)
2428 case PSA_ALG_RIPEMD160:
2429 return( &mbedtls_ripemd160_info );
2430#endif
2431#if defined(MBEDTLS_SHA1_C)
2432 case PSA_ALG_SHA_1:
2433 return( &mbedtls_sha1_info );
2434#endif
2435#if defined(MBEDTLS_SHA256_C)
2436 case PSA_ALG_SHA_224:
2437 return( &mbedtls_sha224_info );
2438 case PSA_ALG_SHA_256:
2439 return( &mbedtls_sha256_info );
2440#endif
2441#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnardd6020842019-07-17 16:28:21 +02002442#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine20035e32018-02-03 22:44:14 +01002443 case PSA_ALG_SHA_384:
2444 return( &mbedtls_sha384_info );
Manuel Pégourié-Gonnardd6020842019-07-17 16:28:21 +02002445#endif
Gilles Peskine20035e32018-02-03 22:44:14 +01002446 case PSA_ALG_SHA_512:
2447 return( &mbedtls_sha512_info );
2448#endif
2449 default:
2450 return( NULL );
2451 }
2452}
John Durkop0ea39e02020-10-13 19:58:20 -07002453#endif /* defined(MBEDTLS_RSA_C) || defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine20035e32018-02-03 22:44:14 +01002454
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002455psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
2456{
2457 switch( operation->alg )
2458 {
Gilles Peskine81736312018-06-26 15:04:31 +02002459 case 0:
2460 /* The object has (apparently) been initialized but it is not
2461 * in use. It's ok to call abort on such an object, and there's
2462 * nothing to do. */
2463 break;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002464#if defined(MBEDTLS_MD2_C)
2465 case PSA_ALG_MD2:
2466 mbedtls_md2_free( &operation->ctx.md2 );
2467 break;
2468#endif
2469#if defined(MBEDTLS_MD4_C)
2470 case PSA_ALG_MD4:
2471 mbedtls_md4_free( &operation->ctx.md4 );
2472 break;
2473#endif
2474#if defined(MBEDTLS_MD5_C)
2475 case PSA_ALG_MD5:
2476 mbedtls_md5_free( &operation->ctx.md5 );
2477 break;
2478#endif
2479#if defined(MBEDTLS_RIPEMD160_C)
2480 case PSA_ALG_RIPEMD160:
2481 mbedtls_ripemd160_free( &operation->ctx.ripemd160 );
2482 break;
2483#endif
2484#if defined(MBEDTLS_SHA1_C)
2485 case PSA_ALG_SHA_1:
2486 mbedtls_sha1_free( &operation->ctx.sha1 );
2487 break;
2488#endif
2489#if defined(MBEDTLS_SHA256_C)
2490 case PSA_ALG_SHA_224:
2491 case PSA_ALG_SHA_256:
2492 mbedtls_sha256_free( &operation->ctx.sha256 );
2493 break;
2494#endif
2495#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002496#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002497 case PSA_ALG_SHA_384:
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002498#endif
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002499 case PSA_ALG_SHA_512:
2500 mbedtls_sha512_free( &operation->ctx.sha512 );
2501 break;
2502#endif
2503 default:
Gilles Peskinef9c2c092018-06-21 16:57:07 +02002504 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002505 }
2506 operation->alg = 0;
2507 return( PSA_SUCCESS );
2508}
2509
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002510psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002511 psa_algorithm_t alg )
2512{
Janos Follath24eed8d2019-11-22 13:21:35 +00002513 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002514
2515 /* A context must be freshly initialized before it can be set up. */
2516 if( operation->alg != 0 )
2517 {
2518 return( PSA_ERROR_BAD_STATE );
2519 }
2520
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002521 switch( alg )
2522 {
2523#if defined(MBEDTLS_MD2_C)
2524 case PSA_ALG_MD2:
2525 mbedtls_md2_init( &operation->ctx.md2 );
2526 ret = mbedtls_md2_starts_ret( &operation->ctx.md2 );
2527 break;
2528#endif
2529#if defined(MBEDTLS_MD4_C)
2530 case PSA_ALG_MD4:
2531 mbedtls_md4_init( &operation->ctx.md4 );
2532 ret = mbedtls_md4_starts_ret( &operation->ctx.md4 );
2533 break;
2534#endif
2535#if defined(MBEDTLS_MD5_C)
2536 case PSA_ALG_MD5:
2537 mbedtls_md5_init( &operation->ctx.md5 );
2538 ret = mbedtls_md5_starts_ret( &operation->ctx.md5 );
2539 break;
2540#endif
2541#if defined(MBEDTLS_RIPEMD160_C)
2542 case PSA_ALG_RIPEMD160:
2543 mbedtls_ripemd160_init( &operation->ctx.ripemd160 );
2544 ret = mbedtls_ripemd160_starts_ret( &operation->ctx.ripemd160 );
2545 break;
2546#endif
2547#if defined(MBEDTLS_SHA1_C)
2548 case PSA_ALG_SHA_1:
2549 mbedtls_sha1_init( &operation->ctx.sha1 );
2550 ret = mbedtls_sha1_starts_ret( &operation->ctx.sha1 );
2551 break;
2552#endif
2553#if defined(MBEDTLS_SHA256_C)
2554 case PSA_ALG_SHA_224:
2555 mbedtls_sha256_init( &operation->ctx.sha256 );
2556 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 1 );
2557 break;
2558 case PSA_ALG_SHA_256:
2559 mbedtls_sha256_init( &operation->ctx.sha256 );
2560 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 0 );
2561 break;
2562#endif
2563#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002564#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002565 case PSA_ALG_SHA_384:
2566 mbedtls_sha512_init( &operation->ctx.sha512 );
2567 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 1 );
2568 break;
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002569#endif
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002570 case PSA_ALG_SHA_512:
2571 mbedtls_sha512_init( &operation->ctx.sha512 );
2572 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 0 );
2573 break;
2574#endif
2575 default:
Gilles Peskinec06e0712018-06-20 16:21:04 +02002576 return( PSA_ALG_IS_HASH( alg ) ?
2577 PSA_ERROR_NOT_SUPPORTED :
2578 PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002579 }
2580 if( ret == 0 )
2581 operation->alg = alg;
2582 else
2583 psa_hash_abort( operation );
2584 return( mbedtls_to_psa_error( ret ) );
2585}
2586
2587psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2588 const uint8_t *input,
2589 size_t input_length )
2590{
Janos Follath24eed8d2019-11-22 13:21:35 +00002591 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine94e44542018-07-12 16:58:43 +02002592
2593 /* Don't require hash implementations to behave correctly on a
2594 * zero-length input, which may have an invalid pointer. */
2595 if( input_length == 0 )
2596 return( PSA_SUCCESS );
2597
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002598 switch( operation->alg )
2599 {
2600#if defined(MBEDTLS_MD2_C)
2601 case PSA_ALG_MD2:
2602 ret = mbedtls_md2_update_ret( &operation->ctx.md2,
2603 input, input_length );
2604 break;
2605#endif
2606#if defined(MBEDTLS_MD4_C)
2607 case PSA_ALG_MD4:
2608 ret = mbedtls_md4_update_ret( &operation->ctx.md4,
2609 input, input_length );
2610 break;
2611#endif
2612#if defined(MBEDTLS_MD5_C)
2613 case PSA_ALG_MD5:
2614 ret = mbedtls_md5_update_ret( &operation->ctx.md5,
2615 input, input_length );
2616 break;
2617#endif
2618#if defined(MBEDTLS_RIPEMD160_C)
2619 case PSA_ALG_RIPEMD160:
2620 ret = mbedtls_ripemd160_update_ret( &operation->ctx.ripemd160,
2621 input, input_length );
2622 break;
2623#endif
2624#if defined(MBEDTLS_SHA1_C)
2625 case PSA_ALG_SHA_1:
2626 ret = mbedtls_sha1_update_ret( &operation->ctx.sha1,
2627 input, input_length );
2628 break;
2629#endif
2630#if defined(MBEDTLS_SHA256_C)
2631 case PSA_ALG_SHA_224:
2632 case PSA_ALG_SHA_256:
2633 ret = mbedtls_sha256_update_ret( &operation->ctx.sha256,
2634 input, input_length );
2635 break;
2636#endif
2637#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002638#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002639 case PSA_ALG_SHA_384:
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002640#endif
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002641 case PSA_ALG_SHA_512:
2642 ret = mbedtls_sha512_update_ret( &operation->ctx.sha512,
2643 input, input_length );
2644 break;
2645#endif
2646 default:
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002647 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002648 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002649
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002650 if( ret != 0 )
2651 psa_hash_abort( operation );
2652 return( mbedtls_to_psa_error( ret ) );
2653}
2654
2655psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2656 uint8_t *hash,
2657 size_t hash_size,
2658 size_t *hash_length )
2659{
itayzafrir40835d42018-08-02 13:14:17 +03002660 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00002661 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine71bb7b72018-04-19 08:29:59 +02002662 size_t actual_hash_length = PSA_HASH_SIZE( operation->alg );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002663
2664 /* Fill the output buffer with something that isn't a valid hash
2665 * (barring an attack on the hash and deliberately-crafted input),
2666 * in case the caller doesn't check the return status properly. */
Gilles Peskineaee13332018-07-02 12:15:28 +02002667 *hash_length = hash_size;
Gilles Peskine46f1fd72018-06-28 19:31:31 +02002668 /* If hash_size is 0 then hash may be NULL and then the
2669 * call to memset would have undefined behavior. */
2670 if( hash_size != 0 )
2671 memset( hash, '!', hash_size );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002672
2673 if( hash_size < actual_hash_length )
itayzafrir40835d42018-08-02 13:14:17 +03002674 {
2675 status = PSA_ERROR_BUFFER_TOO_SMALL;
2676 goto exit;
2677 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002678
2679 switch( operation->alg )
2680 {
2681#if defined(MBEDTLS_MD2_C)
2682 case PSA_ALG_MD2:
2683 ret = mbedtls_md2_finish_ret( &operation->ctx.md2, hash );
2684 break;
2685#endif
2686#if defined(MBEDTLS_MD4_C)
2687 case PSA_ALG_MD4:
2688 ret = mbedtls_md4_finish_ret( &operation->ctx.md4, hash );
2689 break;
2690#endif
2691#if defined(MBEDTLS_MD5_C)
2692 case PSA_ALG_MD5:
2693 ret = mbedtls_md5_finish_ret( &operation->ctx.md5, hash );
2694 break;
2695#endif
2696#if defined(MBEDTLS_RIPEMD160_C)
2697 case PSA_ALG_RIPEMD160:
2698 ret = mbedtls_ripemd160_finish_ret( &operation->ctx.ripemd160, hash );
2699 break;
2700#endif
2701#if defined(MBEDTLS_SHA1_C)
2702 case PSA_ALG_SHA_1:
2703 ret = mbedtls_sha1_finish_ret( &operation->ctx.sha1, hash );
2704 break;
2705#endif
2706#if defined(MBEDTLS_SHA256_C)
2707 case PSA_ALG_SHA_224:
2708 case PSA_ALG_SHA_256:
2709 ret = mbedtls_sha256_finish_ret( &operation->ctx.sha256, hash );
2710 break;
2711#endif
2712#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002713#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002714 case PSA_ALG_SHA_384:
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002715#endif
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002716 case PSA_ALG_SHA_512:
2717 ret = mbedtls_sha512_finish_ret( &operation->ctx.sha512, hash );
2718 break;
2719#endif
2720 default:
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002721 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002722 }
itayzafrir40835d42018-08-02 13:14:17 +03002723 status = mbedtls_to_psa_error( ret );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002724
itayzafrir40835d42018-08-02 13:14:17 +03002725exit:
2726 if( status == PSA_SUCCESS )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002727 {
Gilles Peskineaee13332018-07-02 12:15:28 +02002728 *hash_length = actual_hash_length;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002729 return( psa_hash_abort( operation ) );
2730 }
2731 else
2732 {
2733 psa_hash_abort( operation );
itayzafrir40835d42018-08-02 13:14:17 +03002734 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002735 }
2736}
2737
Gilles Peskine2d277862018-06-18 15:41:12 +02002738psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2739 const uint8_t *hash,
2740 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002741{
2742 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2743 size_t actual_hash_length;
2744 psa_status_t status = psa_hash_finish( operation,
2745 actual_hash, sizeof( actual_hash ),
2746 &actual_hash_length );
2747 if( status != PSA_SUCCESS )
2748 return( status );
2749 if( actual_hash_length != hash_length )
2750 return( PSA_ERROR_INVALID_SIGNATURE );
2751 if( safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
2752 return( PSA_ERROR_INVALID_SIGNATURE );
2753 return( PSA_SUCCESS );
2754}
2755
Gilles Peskine0a749c82019-11-28 19:33:58 +01002756psa_status_t psa_hash_compute( psa_algorithm_t alg,
2757 const uint8_t *input, size_t input_length,
2758 uint8_t *hash, size_t hash_size,
2759 size_t *hash_length )
2760{
2761 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
2762 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2763
2764 *hash_length = hash_size;
2765 status = psa_hash_setup( &operation, alg );
2766 if( status != PSA_SUCCESS )
2767 goto exit;
2768 status = psa_hash_update( &operation, input, input_length );
2769 if( status != PSA_SUCCESS )
2770 goto exit;
2771 status = psa_hash_finish( &operation, hash, hash_size, hash_length );
2772 if( status != PSA_SUCCESS )
2773 goto exit;
2774
2775exit:
2776 if( status == PSA_SUCCESS )
2777 status = psa_hash_abort( &operation );
2778 else
2779 psa_hash_abort( &operation );
2780 return( status );
2781}
2782
2783psa_status_t psa_hash_compare( psa_algorithm_t alg,
2784 const uint8_t *input, size_t input_length,
2785 const uint8_t *hash, size_t hash_length )
2786{
2787 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
2788 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2789
2790 status = psa_hash_setup( &operation, alg );
2791 if( status != PSA_SUCCESS )
2792 goto exit;
2793 status = psa_hash_update( &operation, input, input_length );
2794 if( status != PSA_SUCCESS )
2795 goto exit;
2796 status = psa_hash_verify( &operation, hash, hash_length );
2797 if( status != PSA_SUCCESS )
2798 goto exit;
2799
2800exit:
2801 if( status == PSA_SUCCESS )
2802 status = psa_hash_abort( &operation );
2803 else
2804 psa_hash_abort( &operation );
2805 return( status );
2806}
2807
Gilles Peskineeb35d782019-01-22 17:56:16 +01002808psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2809 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002810{
2811 if( target_operation->alg != 0 )
2812 return( PSA_ERROR_BAD_STATE );
2813
2814 switch( source_operation->alg )
2815 {
2816 case 0:
2817 return( PSA_ERROR_BAD_STATE );
2818#if defined(MBEDTLS_MD2_C)
2819 case PSA_ALG_MD2:
2820 mbedtls_md2_clone( &target_operation->ctx.md2,
2821 &source_operation->ctx.md2 );
2822 break;
2823#endif
2824#if defined(MBEDTLS_MD4_C)
2825 case PSA_ALG_MD4:
2826 mbedtls_md4_clone( &target_operation->ctx.md4,
2827 &source_operation->ctx.md4 );
2828 break;
2829#endif
2830#if defined(MBEDTLS_MD5_C)
2831 case PSA_ALG_MD5:
2832 mbedtls_md5_clone( &target_operation->ctx.md5,
2833 &source_operation->ctx.md5 );
2834 break;
2835#endif
2836#if defined(MBEDTLS_RIPEMD160_C)
2837 case PSA_ALG_RIPEMD160:
2838 mbedtls_ripemd160_clone( &target_operation->ctx.ripemd160,
2839 &source_operation->ctx.ripemd160 );
2840 break;
2841#endif
2842#if defined(MBEDTLS_SHA1_C)
2843 case PSA_ALG_SHA_1:
2844 mbedtls_sha1_clone( &target_operation->ctx.sha1,
2845 &source_operation->ctx.sha1 );
2846 break;
2847#endif
2848#if defined(MBEDTLS_SHA256_C)
2849 case PSA_ALG_SHA_224:
2850 case PSA_ALG_SHA_256:
2851 mbedtls_sha256_clone( &target_operation->ctx.sha256,
2852 &source_operation->ctx.sha256 );
2853 break;
2854#endif
2855#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002856#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002857 case PSA_ALG_SHA_384:
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002858#endif
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002859 case PSA_ALG_SHA_512:
2860 mbedtls_sha512_clone( &target_operation->ctx.sha512,
2861 &source_operation->ctx.sha512 );
2862 break;
2863#endif
2864 default:
2865 return( PSA_ERROR_NOT_SUPPORTED );
2866 }
2867
2868 target_operation->alg = source_operation->alg;
2869 return( PSA_SUCCESS );
2870}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002871
2872
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002873/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002874/* MAC */
2875/****************************************************************/
2876
Gilles Peskinedc2fc842018-03-07 16:42:59 +01002877static const mbedtls_cipher_info_t *mbedtls_cipher_info_from_psa(
Gilles Peskine8c9def32018-02-08 10:02:12 +01002878 psa_algorithm_t alg,
2879 psa_key_type_t key_type,
Gilles Peskine2d277862018-06-18 15:41:12 +02002880 size_t key_bits,
mohammad1603f4f0d612018-06-03 15:04:51 +03002881 mbedtls_cipher_id_t* cipher_id )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002882{
Gilles Peskine8c9def32018-02-08 10:02:12 +01002883 mbedtls_cipher_mode_t mode;
mohammad1603f4f0d612018-06-03 15:04:51 +03002884 mbedtls_cipher_id_t cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002885
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002886 if( PSA_ALG_IS_AEAD( alg ) )
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002887 alg = PSA_ALG_AEAD_WITH_TAG_LENGTH( alg, 0 );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002888
Gilles Peskine8c9def32018-02-08 10:02:12 +01002889 if( PSA_ALG_IS_CIPHER( alg ) || PSA_ALG_IS_AEAD( alg ) )
2890 {
Nir Sonnenscheine9664c32018-06-17 14:41:30 +03002891 switch( alg )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002892 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002893 case PSA_ALG_ARC4:
Gilles Peskine26869f22019-05-06 15:25:00 +02002894 case PSA_ALG_CHACHA20:
Gilles Peskine8c9def32018-02-08 10:02:12 +01002895 mode = MBEDTLS_MODE_STREAM;
2896 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002897 case PSA_ALG_CTR:
2898 mode = MBEDTLS_MODE_CTR;
2899 break;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002900 case PSA_ALG_CFB:
2901 mode = MBEDTLS_MODE_CFB;
2902 break;
2903 case PSA_ALG_OFB:
2904 mode = MBEDTLS_MODE_OFB;
2905 break;
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02002906 case PSA_ALG_ECB_NO_PADDING:
2907 mode = MBEDTLS_MODE_ECB;
2908 break;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002909 case PSA_ALG_CBC_NO_PADDING:
2910 mode = MBEDTLS_MODE_CBC;
2911 break;
2912 case PSA_ALG_CBC_PKCS7:
2913 mode = MBEDTLS_MODE_CBC;
2914 break;
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002915 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002916 mode = MBEDTLS_MODE_CCM;
2917 break;
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002918 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_GCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002919 mode = MBEDTLS_MODE_GCM;
2920 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02002921 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CHACHA20_POLY1305, 0 ):
2922 mode = MBEDTLS_MODE_CHACHAPOLY;
2923 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002924 default:
2925 return( NULL );
2926 }
2927 }
2928 else if( alg == PSA_ALG_CMAC )
2929 mode = MBEDTLS_MODE_ECB;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002930 else
2931 return( NULL );
2932
2933 switch( key_type )
2934 {
2935 case PSA_KEY_TYPE_AES:
mohammad1603f4f0d612018-06-03 15:04:51 +03002936 cipher_id_tmp = MBEDTLS_CIPHER_ID_AES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002937 break;
2938 case PSA_KEY_TYPE_DES:
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002939 /* key_bits is 64 for Single-DES, 128 for two-key Triple-DES,
2940 * and 192 for three-key Triple-DES. */
Gilles Peskine8c9def32018-02-08 10:02:12 +01002941 if( key_bits == 64 )
mohammad1603f4f0d612018-06-03 15:04:51 +03002942 cipher_id_tmp = MBEDTLS_CIPHER_ID_DES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002943 else
mohammad1603f4f0d612018-06-03 15:04:51 +03002944 cipher_id_tmp = MBEDTLS_CIPHER_ID_3DES;
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002945 /* mbedtls doesn't recognize two-key Triple-DES as an algorithm,
2946 * but two-key Triple-DES is functionally three-key Triple-DES
2947 * with K1=K3, so that's how we present it to mbedtls. */
2948 if( key_bits == 128 )
2949 key_bits = 192;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002950 break;
2951 case PSA_KEY_TYPE_CAMELLIA:
mohammad1603f4f0d612018-06-03 15:04:51 +03002952 cipher_id_tmp = MBEDTLS_CIPHER_ID_CAMELLIA;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002953 break;
2954 case PSA_KEY_TYPE_ARC4:
mohammad1603f4f0d612018-06-03 15:04:51 +03002955 cipher_id_tmp = MBEDTLS_CIPHER_ID_ARC4;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002956 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02002957 case PSA_KEY_TYPE_CHACHA20:
2958 cipher_id_tmp = MBEDTLS_CIPHER_ID_CHACHA20;
2959 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002960 default:
2961 return( NULL );
2962 }
mohammad1603f4f0d612018-06-03 15:04:51 +03002963 if( cipher_id != NULL )
mohammad160360a64d02018-06-03 17:20:42 +03002964 *cipher_id = cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002965
Jaeden Amero23bbb752018-06-26 14:16:54 +01002966 return( mbedtls_cipher_info_from_values( cipher_id_tmp,
2967 (int) key_bits, mode ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002968}
2969
Gilles Peskinea05219c2018-11-16 16:02:56 +01002970#if defined(MBEDTLS_MD_C)
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002971static size_t psa_get_hash_block_size( psa_algorithm_t alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002972{
Gilles Peskine2d277862018-06-18 15:41:12 +02002973 switch( alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002974 {
2975 case PSA_ALG_MD2:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002976 return( 16 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002977 case PSA_ALG_MD4:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002978 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002979 case PSA_ALG_MD5:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002980 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002981 case PSA_ALG_RIPEMD160:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002982 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002983 case PSA_ALG_SHA_1:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002984 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002985 case PSA_ALG_SHA_224:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002986 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002987 case PSA_ALG_SHA_256:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002988 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002989 case PSA_ALG_SHA_384:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002990 return( 128 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002991 case PSA_ALG_SHA_512:
Gilles Peskine2d277862018-06-18 15:41:12 +02002992 return( 128 );
2993 default:
2994 return( 0 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002995 }
2996}
Gilles Peskinea05219c2018-11-16 16:02:56 +01002997#endif /* MBEDTLS_MD_C */
Nir Sonnenschein0c9ec532018-06-07 13:27:47 +03002998
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002999/* Initialize the MAC operation structure. Once this function has been
3000 * called, psa_mac_abort can run and will do the right thing. */
3001static psa_status_t psa_mac_init( psa_mac_operation_t *operation,
3002 psa_algorithm_t alg )
3003{
3004 psa_status_t status = PSA_ERROR_NOT_SUPPORTED;
3005
3006 operation->alg = alg;
3007 operation->key_set = 0;
3008 operation->iv_set = 0;
3009 operation->iv_required = 0;
3010 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02003011 operation->is_sign = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003012
3013#if defined(MBEDTLS_CMAC_C)
3014 if( alg == PSA_ALG_CMAC )
3015 {
3016 operation->iv_required = 0;
3017 mbedtls_cipher_init( &operation->ctx.cmac );
3018 status = PSA_SUCCESS;
3019 }
3020 else
3021#endif /* MBEDTLS_CMAC_C */
3022#if defined(MBEDTLS_MD_C)
3023 if( PSA_ALG_IS_HMAC( operation->alg ) )
3024 {
Gilles Peskineff94abd2018-07-12 17:07:52 +02003025 /* We'll set up the hash operation later in psa_hmac_setup_internal. */
3026 operation->ctx.hmac.hash_ctx.alg = 0;
3027 status = PSA_SUCCESS;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003028 }
3029 else
3030#endif /* MBEDTLS_MD_C */
3031 {
Gilles Peskinec06e0712018-06-20 16:21:04 +02003032 if( ! PSA_ALG_IS_MAC( alg ) )
3033 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003034 }
3035
3036 if( status != PSA_SUCCESS )
3037 memset( operation, 0, sizeof( *operation ) );
3038 return( status );
3039}
3040
Gilles Peskine01126fa2018-07-12 17:04:55 +02003041#if defined(MBEDTLS_MD_C)
3042static psa_status_t psa_hmac_abort_internal( psa_hmac_internal_data *hmac )
3043{
Gilles Peskine3f108122018-12-07 18:14:53 +01003044 mbedtls_platform_zeroize( hmac->opad, sizeof( hmac->opad ) );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003045 return( psa_hash_abort( &hmac->hash_ctx ) );
3046}
3047#endif /* MBEDTLS_MD_C */
3048
Gilles Peskine8c9def32018-02-08 10:02:12 +01003049psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
3050{
Gilles Peskinefbfac682018-07-08 20:51:54 +02003051 if( operation->alg == 0 )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003052 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02003053 /* The object has (apparently) been initialized but it is not
3054 * in use. It's ok to call abort on such an object, and there's
3055 * nothing to do. */
3056 return( PSA_SUCCESS );
3057 }
3058 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01003059#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003060 if( operation->alg == PSA_ALG_CMAC )
3061 {
3062 mbedtls_cipher_free( &operation->ctx.cmac );
3063 }
3064 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01003065#endif /* MBEDTLS_CMAC_C */
Gilles Peskine8c9def32018-02-08 10:02:12 +01003066#if defined(MBEDTLS_MD_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003067 if( PSA_ALG_IS_HMAC( operation->alg ) )
3068 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02003069 psa_hmac_abort_internal( &operation->ctx.hmac );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003070 }
3071 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01003072#endif /* MBEDTLS_MD_C */
Gilles Peskinefbfac682018-07-08 20:51:54 +02003073 {
3074 /* Sanity check (shouldn't happen: operation->alg should
3075 * always have been initialized to a valid value). */
3076 goto bad_state;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003077 }
Moran Peker41deec42018-04-04 15:43:05 +03003078
Gilles Peskine8c9def32018-02-08 10:02:12 +01003079 operation->alg = 0;
3080 operation->key_set = 0;
3081 operation->iv_set = 0;
3082 operation->iv_required = 0;
3083 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02003084 operation->is_sign = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003085
Gilles Peskine8c9def32018-02-08 10:02:12 +01003086 return( PSA_SUCCESS );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003087
3088bad_state:
3089 /* If abort is called on an uninitialized object, we can't trust
3090 * anything. Wipe the object in case it contains confidential data.
3091 * This may result in a memory leak if a pointer gets overwritten,
3092 * but it's too late to do anything about this. */
3093 memset( operation, 0, sizeof( *operation ) );
3094 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003095}
3096
Gilles Peskinee3b07d82018-06-19 11:57:35 +02003097#if defined(MBEDTLS_CMAC_C)
Gilles Peskine89167cb2018-07-08 20:12:23 +02003098static int psa_cmac_setup( psa_mac_operation_t *operation,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003099 size_t key_bits,
Gilles Peskine2f060a82018-12-04 17:12:32 +01003100 psa_key_slot_t *slot,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003101 const mbedtls_cipher_info_t *cipher_info )
3102{
Janos Follath24eed8d2019-11-22 13:21:35 +00003103 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003104
3105 operation->mac_size = cipher_info->block_size;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003106
3107 ret = mbedtls_cipher_setup( &operation->ctx.cmac, cipher_info );
3108 if( ret != 0 )
3109 return( ret );
3110
3111 ret = mbedtls_cipher_cmac_starts( &operation->ctx.cmac,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02003112 slot->data.key.data,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003113 key_bits );
3114 return( ret );
3115}
Gilles Peskinee3b07d82018-06-19 11:57:35 +02003116#endif /* MBEDTLS_CMAC_C */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003117
Gilles Peskine248051a2018-06-20 16:09:38 +02003118#if defined(MBEDTLS_MD_C)
Gilles Peskine01126fa2018-07-12 17:04:55 +02003119static psa_status_t psa_hmac_setup_internal( psa_hmac_internal_data *hmac,
3120 const uint8_t *key,
3121 size_t key_length,
3122 psa_algorithm_t hash_alg )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003123{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02003124 uint8_t ipad[PSA_HMAC_MAX_HASH_BLOCK_SIZE];
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003125 size_t i;
Gilles Peskine9aa369e2018-07-16 00:36:29 +02003126 size_t hash_size = PSA_HASH_SIZE( hash_alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003127 size_t block_size = psa_get_hash_block_size( hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003128 psa_status_t status;
3129
Gilles Peskine9aa369e2018-07-16 00:36:29 +02003130 /* Sanity checks on block_size, to guarantee that there won't be a buffer
3131 * overflow below. This should never trigger if the hash algorithm
3132 * is implemented correctly. */
3133 /* The size checks against the ipad and opad buffers cannot be written
3134 * `block_size > sizeof( ipad ) || block_size > sizeof( hmac->opad )`
3135 * because that triggers -Wlogical-op on GCC 7.3. */
3136 if( block_size > sizeof( ipad ) )
3137 return( PSA_ERROR_NOT_SUPPORTED );
3138 if( block_size > sizeof( hmac->opad ) )
3139 return( PSA_ERROR_NOT_SUPPORTED );
3140 if( block_size < hash_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003141 return( PSA_ERROR_NOT_SUPPORTED );
3142
Gilles Peskined223b522018-06-11 18:12:58 +02003143 if( key_length > block_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003144 {
Gilles Peskine84b8fc82019-11-28 20:07:20 +01003145 status = psa_hash_compute( hash_alg, key, key_length,
3146 ipad, sizeof( ipad ), &key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003147 if( status != PSA_SUCCESS )
Gilles Peskineb8be2882018-07-17 16:24:34 +02003148 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003149 }
Gilles Peskine96889972018-07-12 17:07:03 +02003150 /* A 0-length key is not commonly used in HMAC when used as a MAC,
3151 * but it is permitted. It is common when HMAC is used in HKDF, for
3152 * example. Don't call `memcpy` in the 0-length because `key` could be
3153 * an invalid pointer which would make the behavior undefined. */
3154 else if( key_length != 0 )
Gilles Peskine01126fa2018-07-12 17:04:55 +02003155 memcpy( ipad, key, key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003156
Gilles Peskined223b522018-06-11 18:12:58 +02003157 /* ipad contains the key followed by garbage. Xor and fill with 0x36
3158 * to create the ipad value. */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003159 for( i = 0; i < key_length; i++ )
Gilles Peskined223b522018-06-11 18:12:58 +02003160 ipad[i] ^= 0x36;
3161 memset( ipad + key_length, 0x36, block_size - key_length );
3162
3163 /* Copy the key material from ipad to opad, flipping the requisite bits,
3164 * and filling the rest of opad with the requisite constant. */
3165 for( i = 0; i < key_length; i++ )
Gilles Peskine01126fa2018-07-12 17:04:55 +02003166 hmac->opad[i] = ipad[i] ^ 0x36 ^ 0x5C;
3167 memset( hmac->opad + key_length, 0x5C, block_size - key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003168
Gilles Peskine01126fa2018-07-12 17:04:55 +02003169 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003170 if( status != PSA_SUCCESS )
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003171 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003172
Gilles Peskine01126fa2018-07-12 17:04:55 +02003173 status = psa_hash_update( &hmac->hash_ctx, ipad, block_size );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003174
3175cleanup:
Steven Cooreman29149862020-08-05 15:43:42 +02003176 mbedtls_platform_zeroize( ipad, sizeof( ipad ) );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003177
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003178 return( status );
3179}
Gilles Peskine248051a2018-06-20 16:09:38 +02003180#endif /* MBEDTLS_MD_C */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003181
Gilles Peskine89167cb2018-07-08 20:12:23 +02003182static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003183 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02003184 psa_algorithm_t alg,
3185 int is_sign )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003186{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003187 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3188 psa_status_t decrement_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003189 psa_key_slot_t *slot;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003190 size_t key_bits;
Gilles Peskine89167cb2018-07-08 20:12:23 +02003191 psa_key_usage_t usage =
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003192 is_sign ? PSA_KEY_USAGE_SIGN_HASH : PSA_KEY_USAGE_VERIFY_HASH;
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02003193 uint8_t truncated = PSA_MAC_TRUNCATED_LENGTH( alg );
Gilles Peskinee0e9c7c2018-10-17 18:28:05 +02003194 psa_algorithm_t full_length_alg = PSA_ALG_FULL_LENGTH_MAC( alg );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003195
Jaeden Amero36ee5d02019-02-19 09:25:10 +00003196 /* A context must be freshly initialized before it can be set up. */
3197 if( operation->alg != 0 )
3198 {
3199 return( PSA_ERROR_BAD_STATE );
3200 }
3201
Gilles Peskined911eb72018-08-14 15:18:45 +02003202 status = psa_mac_init( operation, full_length_alg );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003203 if( status != PSA_SUCCESS )
3204 return( status );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003205 if( is_sign )
3206 operation->is_sign = 1;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003207
Ronald Croncf56a0a2020-08-04 09:51:30 +02003208 status = psa_get_transparent_key( key, &slot, usage, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003209 if( status != PSA_SUCCESS )
Gilles Peskinefbfac682018-07-08 20:51:54 +02003210 goto exit;
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02003211 key_bits = psa_get_key_slot_bits( slot );
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02003212
Gilles Peskine8c9def32018-02-08 10:02:12 +01003213#if defined(MBEDTLS_CMAC_C)
Gilles Peskined911eb72018-08-14 15:18:45 +02003214 if( full_length_alg == PSA_ALG_CMAC )
Gilles Peskinefbfac682018-07-08 20:51:54 +02003215 {
3216 const mbedtls_cipher_info_t *cipher_info =
Gilles Peskined911eb72018-08-14 15:18:45 +02003217 mbedtls_cipher_info_from_psa( full_length_alg,
Gilles Peskine8e338702019-07-30 20:06:31 +02003218 slot->attr.type, key_bits, NULL );
Janos Follath24eed8d2019-11-22 13:21:35 +00003219 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinefbfac682018-07-08 20:51:54 +02003220 if( cipher_info == NULL )
3221 {
3222 status = PSA_ERROR_NOT_SUPPORTED;
3223 goto exit;
3224 }
3225 operation->mac_size = cipher_info->block_size;
3226 ret = psa_cmac_setup( operation, key_bits, slot, cipher_info );
3227 status = mbedtls_to_psa_error( ret );
3228 }
3229 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01003230#endif /* MBEDTLS_CMAC_C */
Gilles Peskine8c9def32018-02-08 10:02:12 +01003231#if defined(MBEDTLS_MD_C)
Gilles Peskined911eb72018-08-14 15:18:45 +02003232 if( PSA_ALG_IS_HMAC( full_length_alg ) )
Gilles Peskinefbfac682018-07-08 20:51:54 +02003233 {
Gilles Peskine00709fa2018-08-22 18:25:41 +02003234 psa_algorithm_t hash_alg = PSA_ALG_HMAC_GET_HASH( alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003235 if( hash_alg == 0 )
3236 {
3237 status = PSA_ERROR_NOT_SUPPORTED;
3238 goto exit;
3239 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02003240
3241 operation->mac_size = PSA_HASH_SIZE( hash_alg );
3242 /* Sanity check. This shouldn't fail on a valid configuration. */
3243 if( operation->mac_size == 0 ||
3244 operation->mac_size > sizeof( operation->ctx.hmac.opad ) )
3245 {
3246 status = PSA_ERROR_NOT_SUPPORTED;
3247 goto exit;
3248 }
3249
Gilles Peskine8e338702019-07-30 20:06:31 +02003250 if( slot->attr.type != PSA_KEY_TYPE_HMAC )
Gilles Peskine01126fa2018-07-12 17:04:55 +02003251 {
3252 status = PSA_ERROR_INVALID_ARGUMENT;
3253 goto exit;
3254 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02003255
Gilles Peskine01126fa2018-07-12 17:04:55 +02003256 status = psa_hmac_setup_internal( &operation->ctx.hmac,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02003257 slot->data.key.data,
3258 slot->data.key.bytes,
Gilles Peskine01126fa2018-07-12 17:04:55 +02003259 hash_alg );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003260 }
3261 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01003262#endif /* MBEDTLS_MD_C */
Gilles Peskinefbfac682018-07-08 20:51:54 +02003263 {
Jaeden Amero82df32e2018-11-23 15:11:20 +00003264 (void) key_bits;
Gilles Peskinefbfac682018-07-08 20:51:54 +02003265 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003266 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003267
Gilles Peskined911eb72018-08-14 15:18:45 +02003268 if( truncated == 0 )
3269 {
3270 /* The "normal" case: untruncated algorithm. Nothing to do. */
3271 }
3272 else if( truncated < 4 )
3273 {
Gilles Peskine6d72ff92018-08-21 14:55:08 +02003274 /* A very short MAC is too short for security since it can be
3275 * brute-forced. Ancient protocols with 32-bit MACs do exist,
3276 * so we make this our minimum, even though 32 bits is still
3277 * too small for security. */
Gilles Peskined911eb72018-08-14 15:18:45 +02003278 status = PSA_ERROR_NOT_SUPPORTED;
3279 }
3280 else if( truncated > operation->mac_size )
3281 {
3282 /* It's impossible to "truncate" to a larger length. */
3283 status = PSA_ERROR_INVALID_ARGUMENT;
3284 }
3285 else
3286 operation->mac_size = truncated;
3287
Gilles Peskinefbfac682018-07-08 20:51:54 +02003288exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003289 if( status != PSA_SUCCESS )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003290 {
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003291 psa_mac_abort( operation );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003292 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003293 else
3294 {
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003295 operation->key_set = 1;
3296 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003297
3298 decrement_status = psa_decrement_key_slot_access_count( slot );
3299
3300 return( ( status == PSA_SUCCESS ) ? decrement_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003301}
3302
Gilles Peskine89167cb2018-07-08 20:12:23 +02003303psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003304 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02003305 psa_algorithm_t alg )
3306{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003307 return( psa_mac_setup( operation, key, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003308}
3309
3310psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003311 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02003312 psa_algorithm_t alg )
3313{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003314 return( psa_mac_setup( operation, key, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003315}
3316
Gilles Peskine8c9def32018-02-08 10:02:12 +01003317psa_status_t psa_mac_update( psa_mac_operation_t *operation,
3318 const uint8_t *input,
3319 size_t input_length )
3320{
Gilles Peskinefbfac682018-07-08 20:51:54 +02003321 psa_status_t status = PSA_ERROR_BAD_STATE;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003322 if( ! operation->key_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003323 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003324 if( operation->iv_required && ! operation->iv_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003325 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003326 operation->has_input = 1;
3327
Gilles Peskine8c9def32018-02-08 10:02:12 +01003328#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003329 if( operation->alg == PSA_ALG_CMAC )
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03003330 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02003331 int ret = mbedtls_cipher_cmac_update( &operation->ctx.cmac,
3332 input, input_length );
3333 status = mbedtls_to_psa_error( ret );
3334 }
3335 else
3336#endif /* MBEDTLS_CMAC_C */
3337#if defined(MBEDTLS_MD_C)
3338 if( PSA_ALG_IS_HMAC( operation->alg ) )
3339 {
3340 status = psa_hash_update( &operation->ctx.hmac.hash_ctx, input,
3341 input_length );
3342 }
3343 else
3344#endif /* MBEDTLS_MD_C */
3345 {
3346 /* This shouldn't happen if `operation` was initialized by
3347 * a setup function. */
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003348 return( PSA_ERROR_BAD_STATE );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03003349 }
3350
Gilles Peskinefbfac682018-07-08 20:51:54 +02003351 if( status != PSA_SUCCESS )
3352 psa_mac_abort( operation );
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02003353 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003354}
3355
Gilles Peskine01126fa2018-07-12 17:04:55 +02003356#if defined(MBEDTLS_MD_C)
3357static psa_status_t psa_hmac_finish_internal( psa_hmac_internal_data *hmac,
3358 uint8_t *mac,
3359 size_t mac_size )
3360{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02003361 uint8_t tmp[MBEDTLS_MD_MAX_SIZE];
Gilles Peskine01126fa2018-07-12 17:04:55 +02003362 psa_algorithm_t hash_alg = hmac->hash_ctx.alg;
3363 size_t hash_size = 0;
3364 size_t block_size = psa_get_hash_block_size( hash_alg );
3365 psa_status_t status;
3366
Gilles Peskine01126fa2018-07-12 17:04:55 +02003367 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
3368 if( status != PSA_SUCCESS )
3369 return( status );
3370 /* From here on, tmp needs to be wiped. */
3371
3372 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
3373 if( status != PSA_SUCCESS )
3374 goto exit;
3375
3376 status = psa_hash_update( &hmac->hash_ctx, hmac->opad, block_size );
3377 if( status != PSA_SUCCESS )
3378 goto exit;
3379
3380 status = psa_hash_update( &hmac->hash_ctx, tmp, hash_size );
3381 if( status != PSA_SUCCESS )
3382 goto exit;
3383
Gilles Peskined911eb72018-08-14 15:18:45 +02003384 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
3385 if( status != PSA_SUCCESS )
3386 goto exit;
3387
3388 memcpy( mac, tmp, mac_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003389
3390exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01003391 mbedtls_platform_zeroize( tmp, hash_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003392 return( status );
3393}
3394#endif /* MBEDTLS_MD_C */
3395
mohammad16036df908f2018-04-02 08:34:15 -07003396static psa_status_t psa_mac_finish_internal( psa_mac_operation_t *operation,
Gilles Peskine2d277862018-06-18 15:41:12 +02003397 uint8_t *mac,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003398 size_t mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003399{
Gilles Peskine1d96fff2018-07-02 12:15:39 +02003400 if( ! operation->key_set )
3401 return( PSA_ERROR_BAD_STATE );
3402 if( operation->iv_required && ! operation->iv_set )
3403 return( PSA_ERROR_BAD_STATE );
3404
Gilles Peskine8c9def32018-02-08 10:02:12 +01003405 if( mac_size < operation->mac_size )
3406 return( PSA_ERROR_BUFFER_TOO_SMALL );
3407
Gilles Peskine8c9def32018-02-08 10:02:12 +01003408#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003409 if( operation->alg == PSA_ALG_CMAC )
3410 {
Gilles Peskined911eb72018-08-14 15:18:45 +02003411 uint8_t tmp[PSA_MAX_BLOCK_CIPHER_BLOCK_SIZE];
3412 int ret = mbedtls_cipher_cmac_finish( &operation->ctx.cmac, tmp );
3413 if( ret == 0 )
Gilles Peskine87b0ac42018-08-21 14:55:49 +02003414 memcpy( mac, tmp, operation->mac_size );
Gilles Peskine3f108122018-12-07 18:14:53 +01003415 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003416 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003417 }
Gilles Peskinefbfac682018-07-08 20:51:54 +02003418 else
3419#endif /* MBEDTLS_CMAC_C */
3420#if defined(MBEDTLS_MD_C)
3421 if( PSA_ALG_IS_HMAC( operation->alg ) )
3422 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02003423 return( psa_hmac_finish_internal( &operation->ctx.hmac,
Gilles Peskined911eb72018-08-14 15:18:45 +02003424 mac, operation->mac_size ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003425 }
3426 else
3427#endif /* MBEDTLS_MD_C */
3428 {
3429 /* This shouldn't happen if `operation` was initialized by
3430 * a setup function. */
3431 return( PSA_ERROR_BAD_STATE );
3432 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01003433}
3434
Gilles Peskineacd4be32018-07-08 19:56:25 +02003435psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
3436 uint8_t *mac,
3437 size_t mac_size,
3438 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07003439{
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003440 psa_status_t status;
3441
Jaeden Amero252ef282019-02-15 14:05:35 +00003442 if( operation->alg == 0 )
3443 {
3444 return( PSA_ERROR_BAD_STATE );
3445 }
3446
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003447 /* Fill the output buffer with something that isn't a valid mac
3448 * (barring an attack on the mac and deliberately-crafted input),
3449 * in case the caller doesn't check the return status properly. */
3450 *mac_length = mac_size;
3451 /* If mac_size is 0 then mac may be NULL and then the
3452 * call to memset would have undefined behavior. */
3453 if( mac_size != 0 )
3454 memset( mac, '!', mac_size );
3455
Gilles Peskine89167cb2018-07-08 20:12:23 +02003456 if( ! operation->is_sign )
3457 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003458 return( PSA_ERROR_BAD_STATE );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003459 }
mohammad16036df908f2018-04-02 08:34:15 -07003460
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003461 status = psa_mac_finish_internal( operation, mac, mac_size );
3462
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003463 if( status == PSA_SUCCESS )
3464 {
3465 status = psa_mac_abort( operation );
3466 if( status == PSA_SUCCESS )
3467 *mac_length = operation->mac_size;
3468 else
3469 memset( mac, '!', mac_size );
3470 }
3471 else
3472 psa_mac_abort( operation );
3473 return( status );
mohammad16036df908f2018-04-02 08:34:15 -07003474}
3475
Gilles Peskineacd4be32018-07-08 19:56:25 +02003476psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
3477 const uint8_t *mac,
3478 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003479{
Gilles Peskine828ed142018-06-18 23:25:51 +02003480 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
mohammad16036df908f2018-04-02 08:34:15 -07003481 psa_status_t status;
3482
Jaeden Amero252ef282019-02-15 14:05:35 +00003483 if( operation->alg == 0 )
3484 {
3485 return( PSA_ERROR_BAD_STATE );
3486 }
3487
Gilles Peskine89167cb2018-07-08 20:12:23 +02003488 if( operation->is_sign )
3489 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003490 return( PSA_ERROR_BAD_STATE );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003491 }
3492 if( operation->mac_size != mac_length )
3493 {
3494 status = PSA_ERROR_INVALID_SIGNATURE;
3495 goto cleanup;
Gilles Peskine89167cb2018-07-08 20:12:23 +02003496 }
mohammad16036df908f2018-04-02 08:34:15 -07003497
3498 status = psa_mac_finish_internal( operation,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003499 actual_mac, sizeof( actual_mac ) );
Gilles Peskine28cd4162020-01-20 16:31:06 +01003500 if( status != PSA_SUCCESS )
3501 goto cleanup;
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003502
3503 if( safer_memcmp( mac, actual_mac, mac_length ) != 0 )
3504 status = PSA_ERROR_INVALID_SIGNATURE;
3505
3506cleanup:
3507 if( status == PSA_SUCCESS )
3508 status = psa_mac_abort( operation );
3509 else
3510 psa_mac_abort( operation );
3511
Gilles Peskine3f108122018-12-07 18:14:53 +01003512 mbedtls_platform_zeroize( actual_mac, sizeof( actual_mac ) );
Gilles Peskined911eb72018-08-14 15:18:45 +02003513
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003514 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003515}
3516
3517
Gilles Peskine20035e32018-02-03 22:44:14 +01003518
Gilles Peskine20035e32018-02-03 22:44:14 +01003519/****************************************************************/
3520/* Asymmetric cryptography */
3521/****************************************************************/
3522
Gilles Peskine2b450e32018-06-27 15:42:46 +02003523#if defined(MBEDTLS_RSA_C)
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02003524/* Decode the hash algorithm from alg and store the mbedtls encoding in
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003525 * md_alg. Verify that the hash length is acceptable. */
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02003526static psa_status_t psa_rsa_decode_md_type( psa_algorithm_t alg,
3527 size_t hash_length,
3528 mbedtls_md_type_t *md_alg )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003529{
Gilles Peskine7ed29c52018-06-26 15:50:08 +02003530 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003531 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003532 *md_alg = mbedtls_md_get_type( md_info );
3533
3534 /* The Mbed TLS RSA module uses an unsigned int for hash length
3535 * parameters. Validate that it fits so that we don't risk an
3536 * overflow later. */
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003537#if SIZE_MAX > UINT_MAX
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003538 if( hash_length > UINT_MAX )
3539 return( PSA_ERROR_INVALID_ARGUMENT );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003540#endif
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003541
3542#if defined(MBEDTLS_PKCS1_V15)
3543 /* For PKCS#1 v1.5 signature, if using a hash, the hash length
3544 * must be correct. */
3545 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) &&
3546 alg != PSA_ALG_RSA_PKCS1V15_SIGN_RAW )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003547 {
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003548 if( md_info == NULL )
3549 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003550 if( mbedtls_md_get_size( md_info ) != hash_length )
3551 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003552 }
3553#endif /* MBEDTLS_PKCS1_V15 */
3554
3555#if defined(MBEDTLS_PKCS1_V21)
3556 /* PSS requires a hash internally. */
3557 if( PSA_ALG_IS_RSA_PSS( alg ) )
3558 {
Gilles Peskine61b91d42018-06-08 16:09:36 +02003559 if( md_info == NULL )
3560 return( PSA_ERROR_NOT_SUPPORTED );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003561 }
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003562#endif /* MBEDTLS_PKCS1_V21 */
3563
Gilles Peskine61b91d42018-06-08 16:09:36 +02003564 return( PSA_SUCCESS );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003565}
3566
Gilles Peskine2b450e32018-06-27 15:42:46 +02003567static psa_status_t psa_rsa_sign( mbedtls_rsa_context *rsa,
3568 psa_algorithm_t alg,
3569 const uint8_t *hash,
3570 size_t hash_length,
3571 uint8_t *signature,
3572 size_t signature_size,
3573 size_t *signature_length )
3574{
3575 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00003576 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003577 mbedtls_md_type_t md_alg;
3578
3579 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
3580 if( status != PSA_SUCCESS )
3581 return( status );
3582
Gilles Peskine630a18a2018-06-29 17:49:35 +02003583 if( signature_size < mbedtls_rsa_get_len( rsa ) )
Gilles Peskine2b450e32018-06-27 15:42:46 +02003584 return( PSA_ERROR_BUFFER_TOO_SMALL );
3585
3586#if defined(MBEDTLS_PKCS1_V15)
3587 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
3588 {
3589 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
3590 MBEDTLS_MD_NONE );
3591 ret = mbedtls_rsa_pkcs1_sign( rsa,
3592 mbedtls_ctr_drbg_random,
3593 &global_data.ctr_drbg,
3594 MBEDTLS_RSA_PRIVATE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003595 md_alg,
3596 (unsigned int) hash_length,
3597 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003598 signature );
3599 }
3600 else
3601#endif /* MBEDTLS_PKCS1_V15 */
3602#if defined(MBEDTLS_PKCS1_V21)
3603 if( PSA_ALG_IS_RSA_PSS( alg ) )
3604 {
3605 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3606 ret = mbedtls_rsa_rsassa_pss_sign( rsa,
3607 mbedtls_ctr_drbg_random,
3608 &global_data.ctr_drbg,
3609 MBEDTLS_RSA_PRIVATE,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003610 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003611 (unsigned int) hash_length,
3612 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003613 signature );
3614 }
3615 else
3616#endif /* MBEDTLS_PKCS1_V21 */
3617 {
3618 return( PSA_ERROR_INVALID_ARGUMENT );
3619 }
3620
3621 if( ret == 0 )
Gilles Peskine630a18a2018-06-29 17:49:35 +02003622 *signature_length = mbedtls_rsa_get_len( rsa );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003623 return( mbedtls_to_psa_error( ret ) );
3624}
3625
3626static psa_status_t psa_rsa_verify( mbedtls_rsa_context *rsa,
3627 psa_algorithm_t alg,
3628 const uint8_t *hash,
3629 size_t hash_length,
3630 const uint8_t *signature,
3631 size_t signature_length )
3632{
3633 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00003634 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003635 mbedtls_md_type_t md_alg;
3636
3637 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
3638 if( status != PSA_SUCCESS )
3639 return( status );
3640
Gilles Peskine89cc74f2019-09-12 22:08:23 +02003641 if( signature_length != mbedtls_rsa_get_len( rsa ) )
3642 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003643
3644#if defined(MBEDTLS_PKCS1_V15)
3645 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
3646 {
3647 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
3648 MBEDTLS_MD_NONE );
3649 ret = mbedtls_rsa_pkcs1_verify( rsa,
3650 mbedtls_ctr_drbg_random,
3651 &global_data.ctr_drbg,
3652 MBEDTLS_RSA_PUBLIC,
3653 md_alg,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003654 (unsigned int) hash_length,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003655 hash,
3656 signature );
3657 }
3658 else
3659#endif /* MBEDTLS_PKCS1_V15 */
3660#if defined(MBEDTLS_PKCS1_V21)
3661 if( PSA_ALG_IS_RSA_PSS( alg ) )
3662 {
3663 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3664 ret = mbedtls_rsa_rsassa_pss_verify( rsa,
3665 mbedtls_ctr_drbg_random,
3666 &global_data.ctr_drbg,
3667 MBEDTLS_RSA_PUBLIC,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003668 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003669 (unsigned int) hash_length,
3670 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003671 signature );
3672 }
3673 else
3674#endif /* MBEDTLS_PKCS1_V21 */
3675 {
3676 return( PSA_ERROR_INVALID_ARGUMENT );
3677 }
Gilles Peskineef12c632018-09-13 20:37:48 +02003678
3679 /* Mbed TLS distinguishes "invalid padding" from "valid padding but
3680 * the rest of the signature is invalid". This has little use in
3681 * practice and PSA doesn't report this distinction. */
3682 if( ret == MBEDTLS_ERR_RSA_INVALID_PADDING )
3683 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003684 return( mbedtls_to_psa_error( ret ) );
3685}
3686#endif /* MBEDTLS_RSA_C */
3687
John Durkopf87e3ae2020-10-26 15:25:23 -07003688#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003689/* `ecp` cannot be const because `ecp->grp` needs to be non-const
3690 * for mbedtls_ecdsa_sign() and mbedtls_ecdsa_sign_det()
3691 * (even though these functions don't modify it). */
3692static psa_status_t psa_ecdsa_sign( mbedtls_ecp_keypair *ecp,
3693 psa_algorithm_t alg,
3694 const uint8_t *hash,
3695 size_t hash_length,
3696 uint8_t *signature,
3697 size_t signature_size,
3698 size_t *signature_length )
3699{
Janos Follath24eed8d2019-11-22 13:21:35 +00003700 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003701 mbedtls_mpi r, s;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003702 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003703 mbedtls_mpi_init( &r );
3704 mbedtls_mpi_init( &s );
3705
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003706 if( signature_size < 2 * curve_bytes )
3707 {
3708 ret = MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL;
3709 goto cleanup;
3710 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003711
John Durkop0ea39e02020-10-13 19:58:20 -07003712#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003713 if( PSA_ALG_DSA_IS_DETERMINISTIC( alg ) )
3714 {
3715 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
3716 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3717 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
Darryl Green5e843fa2019-09-05 14:06:34 +01003718 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign_det_ext( &ecp->grp, &r, &s,
3719 &ecp->d, hash,
3720 hash_length, md_alg,
3721 mbedtls_ctr_drbg_random,
3722 &global_data.ctr_drbg ) );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003723 }
3724 else
John Durkop0ea39e02020-10-13 19:58:20 -07003725#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003726 {
Gilles Peskinea05219c2018-11-16 16:02:56 +01003727 (void) alg;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003728 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign( &ecp->grp, &r, &s, &ecp->d,
3729 hash, hash_length,
3730 mbedtls_ctr_drbg_random,
3731 &global_data.ctr_drbg ) );
3732 }
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003733
3734 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &r,
3735 signature,
3736 curve_bytes ) );
3737 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &s,
3738 signature + curve_bytes,
3739 curve_bytes ) );
3740
3741cleanup:
3742 mbedtls_mpi_free( &r );
3743 mbedtls_mpi_free( &s );
3744 if( ret == 0 )
3745 *signature_length = 2 * curve_bytes;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003746 return( mbedtls_to_psa_error( ret ) );
3747}
3748
3749static psa_status_t psa_ecdsa_verify( mbedtls_ecp_keypair *ecp,
3750 const uint8_t *hash,
3751 size_t hash_length,
3752 const uint8_t *signature,
3753 size_t signature_length )
3754{
Janos Follath24eed8d2019-11-22 13:21:35 +00003755 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003756 mbedtls_mpi r, s;
3757 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
3758 mbedtls_mpi_init( &r );
3759 mbedtls_mpi_init( &s );
3760
3761 if( signature_length != 2 * curve_bytes )
3762 return( PSA_ERROR_INVALID_SIGNATURE );
3763
3764 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &r,
3765 signature,
3766 curve_bytes ) );
3767 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &s,
3768 signature + curve_bytes,
3769 curve_bytes ) );
3770
Steven Cooremanacda8342020-07-24 23:09:52 +02003771 /* Check whether the public part is loaded. If not, load it. */
3772 if( mbedtls_ecp_is_zero( &ecp->Q ) )
3773 {
3774 MBEDTLS_MPI_CHK(
3775 mbedtls_ecp_mul( &ecp->grp, &ecp->Q, &ecp->d, &ecp->grp.G,
3776 mbedtls_ctr_drbg_random, &global_data.ctr_drbg ) );
3777 }
3778
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003779 ret = mbedtls_ecdsa_verify( &ecp->grp, hash, hash_length,
3780 &ecp->Q, &r, &s );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003781
3782cleanup:
3783 mbedtls_mpi_free( &r );
3784 mbedtls_mpi_free( &s );
3785 return( mbedtls_to_psa_error( ret ) );
3786}
John Durkopf87e3ae2020-10-26 15:25:23 -07003787#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003788
Ronald Croncf56a0a2020-08-04 09:51:30 +02003789psa_status_t psa_sign_hash( mbedtls_svc_key_id_t key,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003790 psa_algorithm_t alg,
3791 const uint8_t *hash,
3792 size_t hash_length,
3793 uint8_t *signature,
3794 size_t signature_size,
3795 size_t *signature_length )
Gilles Peskine20035e32018-02-03 22:44:14 +01003796{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003797 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3798 psa_status_t decrement_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003799 psa_key_slot_t *slot;
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003800
3801 *signature_length = signature_size;
Gilles Peskine4019f0e2019-09-12 22:05:59 +02003802 /* Immediately reject a zero-length signature buffer. This guarantees
3803 * that signature must be a valid pointer. (On the other hand, the hash
3804 * buffer can in principle be empty since it doesn't actually have
3805 * to be a hash.) */
3806 if( signature_size == 0 )
3807 return( PSA_ERROR_BUFFER_TOO_SMALL );
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003808
Ronald Croncf56a0a2020-08-04 09:51:30 +02003809 status = psa_get_key_from_slot( key, &slot, PSA_KEY_USAGE_SIGN_HASH, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003810 if( status != PSA_SUCCESS )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003811 goto exit;
Gilles Peskine8e338702019-07-30 20:06:31 +02003812 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003813 {
3814 status = PSA_ERROR_INVALID_ARGUMENT;
3815 goto exit;
3816 }
Gilles Peskine20035e32018-02-03 22:44:14 +01003817
Steven Cooremancd84cb42020-07-16 20:28:36 +02003818 /* Try any of the available accelerators first */
3819 status = psa_driver_wrapper_sign_hash( slot,
3820 alg,
3821 hash,
3822 hash_length,
3823 signature,
3824 signature_size,
3825 signature_length );
Steven Cooreman8d2bde72020-09-04 13:06:39 +02003826 if( status != PSA_ERROR_NOT_SUPPORTED ||
3827 psa_key_lifetime_is_external( slot->attr.lifetime ) )
Steven Cooremancd84cb42020-07-16 20:28:36 +02003828 goto exit;
3829
Steven Cooreman7a250572020-07-17 16:43:05 +02003830 /* If the operation was not supported by any accelerator, try fallback. */
Gilles Peskine20035e32018-02-03 22:44:14 +01003831#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003832 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskine20035e32018-02-03 22:44:14 +01003833 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003834 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02003835
Steven Cooreman4fed4552020-08-03 14:46:03 +02003836 status = psa_load_rsa_representation( slot->attr.type,
3837 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02003838 slot->data.key.bytes,
Steven Cooremana01795d2020-07-24 22:48:15 +02003839 &rsa );
3840 if( status != PSA_SUCCESS )
3841 goto exit;
3842
Steven Cooremana2371e52020-07-28 14:30:39 +02003843 status = psa_rsa_sign( rsa,
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003844 alg,
3845 hash, hash_length,
3846 signature, signature_size,
3847 signature_length );
Steven Cooremana01795d2020-07-24 22:48:15 +02003848
Steven Cooremana2371e52020-07-28 14:30:39 +02003849 mbedtls_rsa_free( rsa );
3850 mbedtls_free( rsa );
Gilles Peskine20035e32018-02-03 22:44:14 +01003851 }
3852 else
3853#endif /* defined(MBEDTLS_RSA_C) */
3854#if defined(MBEDTLS_ECP_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003855 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
Gilles Peskine20035e32018-02-03 22:44:14 +01003856 {
John Durkop0ea39e02020-10-13 19:58:20 -07003857#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA)
Gilles Peskinea05219c2018-11-16 16:02:56 +01003858 if(
John Durkop0ea39e02020-10-13 19:58:20 -07003859#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea05219c2018-11-16 16:02:56 +01003860 PSA_ALG_IS_ECDSA( alg )
3861#else
3862 PSA_ALG_IS_RANDOMIZED_ECDSA( alg )
3863#endif
3864 )
Steven Cooremanacda8342020-07-24 23:09:52 +02003865 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003866 mbedtls_ecp_keypair *ecp = NULL;
Steven Cooreman4fed4552020-08-03 14:46:03 +02003867 status = psa_load_ecp_representation( slot->attr.type,
3868 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02003869 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02003870 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003871 if( status != PSA_SUCCESS )
3872 goto exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003873 status = psa_ecdsa_sign( ecp,
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003874 alg,
3875 hash, hash_length,
3876 signature, signature_size,
3877 signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02003878 mbedtls_ecp_keypair_free( ecp );
3879 mbedtls_free( ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003880 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003881 else
John Durkop0ea39e02020-10-13 19:58:20 -07003882#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003883 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003884 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003885 }
itayzafrir5c753392018-05-08 11:18:38 +03003886 }
3887 else
3888#endif /* defined(MBEDTLS_ECP_C) */
3889 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003890 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine20035e32018-02-03 22:44:14 +01003891 }
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003892
3893exit:
3894 /* Fill the unused part of the output buffer (the whole buffer on error,
3895 * the trailing part on success) with something that isn't a valid mac
3896 * (barring an attack on the mac and deliberately-crafted input),
3897 * in case the caller doesn't check the return status properly. */
3898 if( status == PSA_SUCCESS )
3899 memset( signature + *signature_length, '!',
3900 signature_size - *signature_length );
Gilles Peskine4019f0e2019-09-12 22:05:59 +02003901 else
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003902 memset( signature, '!', signature_size );
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003903 /* If signature_size is 0 then we have nothing to do. We must not call
3904 * memset because signature may be NULL in this case. */
Ronald Cronf95a2b12020-10-22 15:24:49 +02003905
3906 decrement_status = psa_decrement_key_slot_access_count( slot );
3907
3908 return( ( status == PSA_SUCCESS ) ? decrement_status : status );
itayzafrir5c753392018-05-08 11:18:38 +03003909}
3910
Ronald Croncf56a0a2020-08-04 09:51:30 +02003911psa_status_t psa_verify_hash( mbedtls_svc_key_id_t key,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003912 psa_algorithm_t alg,
3913 const uint8_t *hash,
3914 size_t hash_length,
3915 const uint8_t *signature,
3916 size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03003917{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003918 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3919 psa_status_t decrement_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003920 psa_key_slot_t *slot;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003921
Ronald Croncf56a0a2020-08-04 09:51:30 +02003922 status = psa_get_key_from_slot( key, &slot,
3923 PSA_KEY_USAGE_VERIFY_HASH, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003924 if( status != PSA_SUCCESS )
3925 return( status );
itayzafrir5c753392018-05-08 11:18:38 +03003926
Steven Cooreman55ae2172020-07-17 19:46:15 +02003927 /* Try any of the available accelerators first */
3928 status = psa_driver_wrapper_verify_hash( slot,
3929 alg,
3930 hash,
3931 hash_length,
3932 signature,
3933 signature_length );
Steven Cooreman8d2bde72020-09-04 13:06:39 +02003934 if( status != PSA_ERROR_NOT_SUPPORTED ||
3935 psa_key_lifetime_is_external( slot->attr.lifetime ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003936 goto exit;
Steven Cooreman55ae2172020-07-17 19:46:15 +02003937
Gilles Peskine61b91d42018-06-08 16:09:36 +02003938#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003939 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003940 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003941 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02003942
Steven Cooreman4fed4552020-08-03 14:46:03 +02003943 status = psa_load_rsa_representation( slot->attr.type,
3944 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02003945 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02003946 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003947 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003948 goto exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003949
Steven Cooremana2371e52020-07-28 14:30:39 +02003950 status = psa_rsa_verify( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02003951 alg,
3952 hash, hash_length,
3953 signature, signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02003954 mbedtls_rsa_free( rsa );
3955 mbedtls_free( rsa );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003956 goto exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003957 }
3958 else
3959#endif /* defined(MBEDTLS_RSA_C) */
itayzafrir5c753392018-05-08 11:18:38 +03003960#if defined(MBEDTLS_ECP_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003961 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
itayzafrir5c753392018-05-08 11:18:38 +03003962 {
John Durkopf87e3ae2020-10-26 15:25:23 -07003963#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003964 if( PSA_ALG_IS_ECDSA( alg ) )
Steven Cooremanacda8342020-07-24 23:09:52 +02003965 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003966 mbedtls_ecp_keypair *ecp = NULL;
Steven Cooreman4fed4552020-08-03 14:46:03 +02003967 status = psa_load_ecp_representation( slot->attr.type,
3968 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02003969 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02003970 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003971 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003972 goto exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003973 status = psa_ecdsa_verify( ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02003974 hash, hash_length,
3975 signature, signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02003976 mbedtls_ecp_keypair_free( ecp );
3977 mbedtls_free( ecp );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003978 goto exit;
Steven Cooremanacda8342020-07-24 23:09:52 +02003979 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003980 else
John Durkopf87e3ae2020-10-26 15:25:23 -07003981#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003982 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003983 status = PSA_ERROR_INVALID_ARGUMENT;
3984 goto exit;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003985 }
itayzafrir5c753392018-05-08 11:18:38 +03003986 }
Gilles Peskine20035e32018-02-03 22:44:14 +01003987 else
3988#endif /* defined(MBEDTLS_ECP_C) */
3989 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003990 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine20035e32018-02-03 22:44:14 +01003991 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003992
3993exit:
3994 decrement_status = psa_decrement_key_slot_access_count( slot );
3995
3996 return( ( status == PSA_SUCCESS ) ? decrement_status : status );
Gilles Peskine20035e32018-02-03 22:44:14 +01003997}
3998
Gilles Peskine072ac562018-06-30 00:21:29 +02003999#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PKCS1_V21)
4000static void psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
4001 mbedtls_rsa_context *rsa )
4002{
4003 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
4004 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
4005 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
4006 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
4007}
4008#endif /* defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PKCS1_V21) */
4009
Ronald Croncf56a0a2020-08-04 09:51:30 +02004010psa_status_t psa_asymmetric_encrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02004011 psa_algorithm_t alg,
4012 const uint8_t *input,
4013 size_t input_length,
4014 const uint8_t *salt,
4015 size_t salt_length,
4016 uint8_t *output,
4017 size_t output_size,
4018 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004019{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004020 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4021 psa_status_t decrement_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01004022 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004023
Darryl Green5cc689a2018-07-24 15:34:10 +01004024 (void) input;
4025 (void) input_length;
4026 (void) salt;
4027 (void) output;
4028 (void) output_size;
4029
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03004030 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004031
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02004032 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
4033 return( PSA_ERROR_INVALID_ARGUMENT );
4034
Ronald Croncf56a0a2020-08-04 09:51:30 +02004035 status = psa_get_transparent_key( key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004036 if( status != PSA_SUCCESS )
4037 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02004038 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
4039 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004040 {
4041 status = PSA_ERROR_INVALID_ARGUMENT;
4042 goto exit;
4043 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004044
4045#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02004046 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004047 {
Steven Cooremana2371e52020-07-28 14:30:39 +02004048 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman4fed4552020-08-03 14:46:03 +02004049 status = psa_load_rsa_representation( slot->attr.type,
4050 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02004051 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02004052 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02004053 if( status != PSA_SUCCESS )
Steven Cooreman4fed4552020-08-03 14:46:03 +02004054 goto rsa_exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02004055
4056 if( output_size < mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02004057 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004058 status = PSA_ERROR_BUFFER_TOO_SMALL;
4059 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02004060 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004061#if defined(MBEDTLS_PKCS1_V15)
Gilles Peskine6afe7892018-05-31 13:16:08 +02004062 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004063 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004064 status = mbedtls_to_psa_error(
4065 mbedtls_rsa_pkcs1_encrypt( rsa,
4066 mbedtls_ctr_drbg_random,
4067 &global_data.ctr_drbg,
4068 MBEDTLS_RSA_PUBLIC,
4069 input_length,
4070 input,
4071 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004072 }
4073 else
4074#endif /* MBEDTLS_PKCS1_V15 */
4075#if defined(MBEDTLS_PKCS1_V21)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02004076 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004077 {
Steven Cooremana2371e52020-07-28 14:30:39 +02004078 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02004079 status = mbedtls_to_psa_error(
4080 mbedtls_rsa_rsaes_oaep_encrypt( rsa,
4081 mbedtls_ctr_drbg_random,
4082 &global_data.ctr_drbg,
4083 MBEDTLS_RSA_PUBLIC,
4084 salt, salt_length,
4085 input_length,
4086 input,
4087 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004088 }
4089 else
4090#endif /* MBEDTLS_PKCS1_V21 */
4091 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004092 status = PSA_ERROR_INVALID_ARGUMENT;
4093 goto rsa_exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004094 }
Steven Cooreman4fed4552020-08-03 14:46:03 +02004095rsa_exit:
4096 if( status == PSA_SUCCESS )
Steven Cooremana2371e52020-07-28 14:30:39 +02004097 *output_length = mbedtls_rsa_get_len( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02004098
Steven Cooremana2371e52020-07-28 14:30:39 +02004099 mbedtls_rsa_free( rsa );
4100 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004101 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004102 else
Gilles Peskineb75e4f12018-06-08 17:44:47 +02004103#endif /* defined(MBEDTLS_RSA_C) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004104 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02004105 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004106 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004107
4108exit:
4109 decrement_status = psa_decrement_key_slot_access_count( slot );
4110
4111 return( ( status == PSA_SUCCESS ) ? decrement_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02004112}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004113
Ronald Croncf56a0a2020-08-04 09:51:30 +02004114psa_status_t psa_asymmetric_decrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02004115 psa_algorithm_t alg,
4116 const uint8_t *input,
4117 size_t input_length,
4118 const uint8_t *salt,
4119 size_t salt_length,
4120 uint8_t *output,
4121 size_t output_size,
4122 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004123{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004124 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4125 psa_status_t decrement_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01004126 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004127
Darryl Green5cc689a2018-07-24 15:34:10 +01004128 (void) input;
4129 (void) input_length;
4130 (void) salt;
4131 (void) output;
4132 (void) output_size;
4133
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03004134 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004135
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02004136 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
4137 return( PSA_ERROR_INVALID_ARGUMENT );
4138
Ronald Croncf56a0a2020-08-04 09:51:30 +02004139 status = psa_get_transparent_key( key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004140 if( status != PSA_SUCCESS )
4141 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02004142 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004143 {
4144 status = PSA_ERROR_INVALID_ARGUMENT;
4145 goto exit;
4146 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004147
4148#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02004149 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004150 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004151 mbedtls_rsa_context *rsa = NULL;
4152 status = psa_load_rsa_representation( slot->attr.type,
4153 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02004154 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02004155 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02004156 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004157 goto exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004158
Steven Cooremana2371e52020-07-28 14:30:39 +02004159 if( input_length != mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02004160 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004161 status = PSA_ERROR_INVALID_ARGUMENT;
4162 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02004163 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004164
4165#if defined(MBEDTLS_PKCS1_V15)
Gilles Peskine6afe7892018-05-31 13:16:08 +02004166 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004167 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004168 status = mbedtls_to_psa_error(
4169 mbedtls_rsa_pkcs1_decrypt( rsa,
4170 mbedtls_ctr_drbg_random,
4171 &global_data.ctr_drbg,
4172 MBEDTLS_RSA_PRIVATE,
4173 output_length,
4174 input,
4175 output,
4176 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004177 }
4178 else
4179#endif /* MBEDTLS_PKCS1_V15 */
4180#if defined(MBEDTLS_PKCS1_V21)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02004181 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004182 {
Steven Cooremana2371e52020-07-28 14:30:39 +02004183 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02004184 status = mbedtls_to_psa_error(
4185 mbedtls_rsa_rsaes_oaep_decrypt( rsa,
4186 mbedtls_ctr_drbg_random,
4187 &global_data.ctr_drbg,
4188 MBEDTLS_RSA_PRIVATE,
4189 salt, salt_length,
4190 output_length,
4191 input,
4192 output,
4193 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004194 }
4195 else
4196#endif /* MBEDTLS_PKCS1_V21 */
4197 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004198 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004199 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03004200
Steven Cooreman4fed4552020-08-03 14:46:03 +02004201rsa_exit:
Steven Cooremana2371e52020-07-28 14:30:39 +02004202 mbedtls_rsa_free( rsa );
4203 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004204 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004205 else
Gilles Peskineb75e4f12018-06-08 17:44:47 +02004206#endif /* defined(MBEDTLS_RSA_C) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004207 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02004208 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004209 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004210
4211exit:
4212 decrement_status = psa_decrement_key_slot_access_count( slot );
4213
4214 return( ( status == PSA_SUCCESS ) ? decrement_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02004215}
Gilles Peskine20035e32018-02-03 22:44:14 +01004216
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004217
4218
mohammad1603503973b2018-03-12 15:59:30 +02004219/****************************************************************/
4220/* Symmetric cryptography */
4221/****************************************************************/
4222
Gilles Peskinee553c652018-06-04 16:22:46 +02004223static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004224 mbedtls_svc_key_id_t key,
Gilles Peskine7e928852018-06-04 16:23:10 +02004225 psa_algorithm_t alg,
4226 mbedtls_operation_t cipher_operation )
mohammad1603503973b2018-03-12 15:59:30 +02004227{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004228 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4229 psa_status_t decrement_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004230 int ret = 0;
Gilles Peskine2f060a82018-12-04 17:12:32 +01004231 psa_key_slot_t *slot;
mohammad1603503973b2018-03-12 15:59:30 +02004232 size_t key_bits;
4233 const mbedtls_cipher_info_t *cipher_info = NULL;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004234 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
4235 PSA_KEY_USAGE_ENCRYPT :
4236 PSA_KEY_USAGE_DECRYPT );
mohammad1603503973b2018-03-12 15:59:30 +02004237
Steven Cooremand3feccd2020-09-01 15:56:14 +02004238 /* A context must be freshly initialized before it can be set up. */
4239 if( operation->alg != 0 )
4240 return( PSA_ERROR_BAD_STATE );
4241
Steven Cooremana07b9972020-09-10 14:54:14 +02004242 /* The requested algorithm must be one that can be processed by cipher. */
4243 if( ! PSA_ALG_IS_CIPHER( alg ) )
Steven Cooremana07b9972020-09-10 14:54:14 +02004244 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremand3feccd2020-09-01 15:56:14 +02004245
Steven Cooremanef8575e2020-09-11 11:44:50 +02004246 /* Fetch key material from key storage. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02004247 status = psa_get_key_from_slot( key, &slot, usage, alg );
Steven Cooremanef8575e2020-09-11 11:44:50 +02004248 if( status != PSA_SUCCESS )
4249 goto exit;
4250
4251 /* Initialize the operation struct members, except for alg. The alg member
4252 * is used to indicate to psa_cipher_abort that there are resources to free,
4253 * so we only set it after resources have been allocated/initialized. */
Steven Cooremana07b9972020-09-10 14:54:14 +02004254 operation->key_set = 0;
4255 operation->iv_set = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004256 operation->mbedtls_in_use = 0;
Steven Cooremana07b9972020-09-10 14:54:14 +02004257 operation->iv_size = 0;
4258 operation->block_size = 0;
4259 if( alg == PSA_ALG_ECB_NO_PADDING )
4260 operation->iv_required = 0;
4261 else
4262 operation->iv_required = 1;
4263
Steven Cooremana07b9972020-09-10 14:54:14 +02004264 /* Try doing the operation through a driver before using software fallback. */
Steven Cooreman37941cb2020-07-28 18:49:51 +02004265 if( cipher_operation == MBEDTLS_ENCRYPT )
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004266 status = psa_driver_wrapper_cipher_encrypt_setup( &operation->ctx.driver,
Steven Cooreman37941cb2020-07-28 18:49:51 +02004267 slot,
4268 alg );
4269 else
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004270 status = psa_driver_wrapper_cipher_decrypt_setup( &operation->ctx.driver,
Steven Cooreman37941cb2020-07-28 18:49:51 +02004271 slot,
4272 alg );
4273
Steven Cooremanef8575e2020-09-11 11:44:50 +02004274 if( status == PSA_SUCCESS )
Steven Cooreman6d81f7e2020-09-14 13:14:31 +02004275 {
Steven Cooremanef8575e2020-09-11 11:44:50 +02004276 /* Once the driver context is initialised, it needs to be freed using
4277 * psa_cipher_abort. Indicate this through setting alg. */
4278 operation->alg = alg;
Steven Cooreman6d81f7e2020-09-14 13:14:31 +02004279 }
Steven Cooremanef8575e2020-09-11 11:44:50 +02004280
Steven Cooremand3feccd2020-09-01 15:56:14 +02004281 if( status != PSA_ERROR_NOT_SUPPORTED ||
4282 psa_key_lifetime_is_external( slot->attr.lifetime ) )
4283 goto exit;
4284
Steven Cooremana07b9972020-09-10 14:54:14 +02004285 /* Proceed with initializing an mbed TLS cipher context if no driver is
Steven Cooremand3feccd2020-09-01 15:56:14 +02004286 * available for the given algorithm & key. */
4287 mbedtls_cipher_init( &operation->ctx.cipher );
mohammad1603503973b2018-03-12 15:59:30 +02004288
Steven Cooremana07b9972020-09-10 14:54:14 +02004289 /* Once the cipher context is initialised, it needs to be freed using
Steven Cooremanef8575e2020-09-11 11:44:50 +02004290 * psa_cipher_abort. Indicate there is something to be freed through setting
4291 * alg, and indicate the operation is being done using mbedtls crypto through
4292 * setting mbedtls_in_use. */
Steven Cooremana07b9972020-09-10 14:54:14 +02004293 operation->alg = alg;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004294 operation->mbedtls_in_use = 1;
Steven Cooremana07b9972020-09-10 14:54:14 +02004295
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02004296 key_bits = psa_get_key_slot_bits( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +02004297 cipher_info = mbedtls_cipher_info_from_psa( alg, slot->attr.type, key_bits, NULL );
mohammad1603503973b2018-03-12 15:59:30 +02004298 if( cipher_info == NULL )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004299 {
4300 status = PSA_ERROR_NOT_SUPPORTED;
4301 goto exit;
4302 }
mohammad1603503973b2018-03-12 15:59:30 +02004303
mohammad1603503973b2018-03-12 15:59:30 +02004304 ret = mbedtls_cipher_setup( &operation->ctx.cipher, cipher_info );
Moran Peker41deec42018-04-04 15:43:05 +03004305 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004306 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004307
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004308#if defined(MBEDTLS_DES_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02004309 if( slot->attr.type == PSA_KEY_TYPE_DES && key_bits == 128 )
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004310 {
4311 /* Two-key Triple-DES is 3-key Triple-DES with K1=K3 */
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02004312 uint8_t keys[24];
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004313 memcpy( keys, slot->data.key.data, 16 );
4314 memcpy( keys + 16, slot->data.key.data, 8 );
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004315 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
4316 keys,
4317 192, cipher_operation );
4318 }
4319 else
4320#endif
4321 {
4322 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004323 slot->data.key.data,
Jaeden Amero23bbb752018-06-26 14:16:54 +01004324 (int) key_bits, cipher_operation );
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004325 }
Moran Peker41deec42018-04-04 15:43:05 +03004326 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004327 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004328
mohammad16038481e742018-03-18 13:57:31 +02004329#if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004330 switch( alg )
mohammad16038481e742018-03-18 13:57:31 +02004331 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004332 case PSA_ALG_CBC_NO_PADDING:
4333 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
4334 MBEDTLS_PADDING_NONE );
4335 break;
4336 case PSA_ALG_CBC_PKCS7:
4337 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
4338 MBEDTLS_PADDING_PKCS7 );
4339 break;
4340 default:
4341 /* The algorithm doesn't involve padding. */
4342 ret = 0;
4343 break;
4344 }
4345 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004346 goto exit;
mohammad16038481e742018-03-18 13:57:31 +02004347#endif //MBEDTLS_CIPHER_MODE_WITH_PADDING
4348
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004349 operation->block_size = ( PSA_ALG_IS_STREAM_CIPHER( alg ) ? 1 :
Gilles Peskine8e338702019-07-30 20:06:31 +02004350 PSA_BLOCK_CIPHER_BLOCK_SIZE( slot->attr.type ) );
Steven Cooremana6033e92020-08-25 11:47:50 +02004351 if( ( alg & PSA_ALG_CIPHER_FROM_BLOCK_FLAG ) != 0 &&
4352 alg != PSA_ALG_ECB_NO_PADDING )
mohammad16038481e742018-03-18 13:57:31 +02004353 {
Gilles Peskine8e338702019-07-30 20:06:31 +02004354 operation->iv_size = PSA_BLOCK_CIPHER_BLOCK_SIZE( slot->attr.type );
mohammad16038481e742018-03-18 13:57:31 +02004355 }
Gilles Peskine26869f22019-05-06 15:25:00 +02004356#if defined(MBEDTLS_CHACHA20_C)
4357 else
4358 if( alg == PSA_ALG_CHACHA20 )
4359 operation->iv_size = 12;
4360#endif
mohammad1603503973b2018-03-12 15:59:30 +02004361
Steven Cooreman7df02922020-09-09 15:28:49 +02004362 status = PSA_SUCCESS;
4363
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004364exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02004365 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004366 status = mbedtls_to_psa_error( ret );
Steven Cooreman7df02922020-09-09 15:28:49 +02004367 if( status == PSA_SUCCESS )
4368 {
4369 /* Update operation flags for both driver and software implementations */
4370 operation->key_set = 1;
4371 }
4372 else
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004373 psa_cipher_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004374
4375 decrement_status = psa_decrement_key_slot_access_count( slot );
4376
4377 return( ( status == PSA_SUCCESS ) ? decrement_status : status );
mohammad1603503973b2018-03-12 15:59:30 +02004378}
4379
Gilles Peskinefe119512018-07-08 21:39:34 +02004380psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004381 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02004382 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02004383{
Ronald Croncf56a0a2020-08-04 09:51:30 +02004384 return( psa_cipher_setup( operation, key, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02004385}
4386
Gilles Peskinefe119512018-07-08 21:39:34 +02004387psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004388 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02004389 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02004390{
Ronald Croncf56a0a2020-08-04 09:51:30 +02004391 return( psa_cipher_setup( operation, key, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02004392}
4393
Gilles Peskinefe119512018-07-08 21:39:34 +02004394psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004395 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02004396 size_t iv_size,
4397 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02004398{
itayzafrir534bd7c2018-08-02 13:56:32 +03004399 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00004400 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooreman7df02922020-09-09 15:28:49 +02004401 if( operation->iv_set || ! operation->iv_required )
4402 {
4403 return( PSA_ERROR_BAD_STATE );
4404 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004405
Steven Cooremanef8575e2020-09-11 11:44:50 +02004406 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004407 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004408 status = psa_driver_wrapper_cipher_generate_iv( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004409 iv,
4410 iv_size,
4411 iv_length );
4412 goto exit;
4413 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004414
Moran Peker41deec42018-04-04 15:43:05 +03004415 if( iv_size < operation->iv_size )
mohammad1603503973b2018-03-12 15:59:30 +02004416 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004417 status = PSA_ERROR_BUFFER_TOO_SMALL;
Moran Peker41deec42018-04-04 15:43:05 +03004418 goto exit;
4419 }
Gilles Peskine7e928852018-06-04 16:23:10 +02004420 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg,
4421 iv, operation->iv_size );
Moran Peker41deec42018-04-04 15:43:05 +03004422 if( ret != 0 )
4423 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004424 status = mbedtls_to_psa_error( ret );
Gilles Peskinee553c652018-06-04 16:22:46 +02004425 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004426 }
Gilles Peskinee553c652018-06-04 16:22:46 +02004427
mohammad16038481e742018-03-18 13:57:31 +02004428 *iv_length = operation->iv_size;
itayzafrir534bd7c2018-08-02 13:56:32 +03004429 status = psa_cipher_set_iv( operation, iv, *iv_length );
Moran Peker41deec42018-04-04 15:43:05 +03004430
Moran Peker395db872018-05-31 14:07:14 +03004431exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02004432 if( status == PSA_SUCCESS )
4433 operation->iv_set = 1;
4434 else
Moran Peker395db872018-05-31 14:07:14 +03004435 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004436 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004437}
4438
Gilles Peskinefe119512018-07-08 21:39:34 +02004439psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004440 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02004441 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02004442{
itayzafrir534bd7c2018-08-02 13:56:32 +03004443 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00004444 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooreman7df02922020-09-09 15:28:49 +02004445 if( operation->iv_set || ! operation->iv_required )
4446 {
4447 return( PSA_ERROR_BAD_STATE );
4448 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004449
Steven Cooremanef8575e2020-09-11 11:44:50 +02004450 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004451 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004452 status = psa_driver_wrapper_cipher_set_iv( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004453 iv,
4454 iv_length );
4455 goto exit;
4456 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004457
Moran Pekera28258c2018-05-29 16:25:04 +03004458 if( iv_length != operation->iv_size )
Moran Peker71f19ae2018-04-22 20:23:16 +03004459 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004460 status = PSA_ERROR_INVALID_ARGUMENT;
4461 goto exit;
Moran Peker71f19ae2018-04-22 20:23:16 +03004462 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004463 ret = mbedtls_cipher_set_iv( &operation->ctx.cipher, iv, iv_length );
4464 status = mbedtls_to_psa_error( ret );
4465exit:
4466 if( status == PSA_SUCCESS )
4467 operation->iv_set = 1;
4468 else
mohammad1603503973b2018-03-12 15:59:30 +02004469 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004470 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004471}
4472
Steven Cooreman177deba2020-09-07 17:14:14 +02004473/* Process input for which the algorithm is set to ECB mode. This requires
4474 * manual processing, since the PSA API is defined as being able to process
4475 * arbitrary-length calls to psa_cipher_update() with ECB mode, but the
4476 * underlying mbedtls_cipher_update only takes full blocks. */
4477static psa_status_t psa_cipher_update_ecb_internal(
4478 mbedtls_cipher_context_t *ctx,
4479 const uint8_t *input,
4480 size_t input_length,
4481 uint8_t *output,
4482 size_t output_size,
4483 size_t *output_length )
4484{
4485 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4486 size_t block_size = ctx->cipher_info->block_size;
4487 size_t internal_output_length = 0;
4488 *output_length = 0;
4489
4490 if( input_length == 0 )
4491 {
4492 status = PSA_SUCCESS;
4493 goto exit;
4494 }
4495
4496 if( ctx->unprocessed_len > 0 )
4497 {
4498 /* Fill up to block size, and run the block if there's a full one. */
4499 size_t bytes_to_copy = block_size - ctx->unprocessed_len;
4500
4501 if( input_length < bytes_to_copy )
4502 bytes_to_copy = input_length;
4503
4504 memcpy( &( ctx->unprocessed_data[ctx->unprocessed_len] ),
4505 input, bytes_to_copy );
4506 input_length -= bytes_to_copy;
4507 input += bytes_to_copy;
4508 ctx->unprocessed_len += bytes_to_copy;
4509
4510 if( ctx->unprocessed_len == block_size )
4511 {
4512 status = mbedtls_to_psa_error(
4513 mbedtls_cipher_update( ctx,
4514 ctx->unprocessed_data,
4515 block_size,
4516 output, &internal_output_length ) );
4517
4518 if( status != PSA_SUCCESS )
4519 goto exit;
4520
4521 output += internal_output_length;
4522 output_size -= internal_output_length;
4523 *output_length += internal_output_length;
4524 ctx->unprocessed_len = 0;
4525 }
4526 }
4527
4528 while( input_length >= block_size )
4529 {
4530 /* Run all full blocks we have, one by one */
4531 status = mbedtls_to_psa_error(
4532 mbedtls_cipher_update( ctx, input,
4533 block_size,
4534 output, &internal_output_length ) );
4535
4536 if( status != PSA_SUCCESS )
4537 goto exit;
4538
4539 input_length -= block_size;
4540 input += block_size;
4541
4542 output += internal_output_length;
4543 output_size -= internal_output_length;
4544 *output_length += internal_output_length;
4545 }
4546
4547 if( input_length > 0 )
4548 {
4549 /* Save unprocessed bytes for later processing */
4550 memcpy( &( ctx->unprocessed_data[ctx->unprocessed_len] ),
4551 input, input_length );
4552 ctx->unprocessed_len += input_length;
4553 }
4554
4555 status = PSA_SUCCESS;
4556
4557exit:
4558 return( status );
4559}
4560
Gilles Peskinee553c652018-06-04 16:22:46 +02004561psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
4562 const uint8_t *input,
4563 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004564 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02004565 size_t output_size,
4566 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02004567{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004568 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine89d789c2018-06-04 17:17:16 +02004569 size_t expected_output_size;
Steven Cooreman7df02922020-09-09 15:28:49 +02004570 if( operation->alg == 0 )
4571 {
4572 return( PSA_ERROR_BAD_STATE );
4573 }
4574 if( operation->iv_required && ! operation->iv_set )
4575 {
4576 return( PSA_ERROR_BAD_STATE );
4577 }
Jaeden Ameroab439972019-02-15 14:12:05 +00004578
Steven Cooremanef8575e2020-09-11 11:44:50 +02004579 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004580 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004581 status = psa_driver_wrapper_cipher_update( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004582 input,
4583 input_length,
4584 output,
4585 output_size,
4586 output_length );
4587 goto exit;
4588 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004589
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004590 if( ! PSA_ALG_IS_STREAM_CIPHER( operation->alg ) )
Gilles Peskine89d789c2018-06-04 17:17:16 +02004591 {
4592 /* Take the unprocessed partial block left over from previous
4593 * update calls, if any, plus the input to this call. Remove
4594 * the last partial block, if any. You get the data that will be
4595 * output in this call. */
4596 expected_output_size =
4597 ( operation->ctx.cipher.unprocessed_len + input_length )
4598 / operation->block_size * operation->block_size;
4599 }
4600 else
4601 {
4602 expected_output_size = input_length;
4603 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004604
Gilles Peskine89d789c2018-06-04 17:17:16 +02004605 if( output_size < expected_output_size )
itayzafrir534bd7c2018-08-02 13:56:32 +03004606 {
4607 status = PSA_ERROR_BUFFER_TOO_SMALL;
4608 goto exit;
4609 }
mohammad160382759612018-03-12 18:16:40 +02004610
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004611 if( operation->alg == PSA_ALG_ECB_NO_PADDING )
4612 {
4613 /* mbedtls_cipher_update has an API inconsistency: it will only
4614 * process a single block at a time in ECB mode. Abstract away that
4615 * inconsistency here to match the PSA API behaviour. */
Steven Cooreman177deba2020-09-07 17:14:14 +02004616 status = psa_cipher_update_ecb_internal( &operation->ctx.cipher,
4617 input,
4618 input_length,
4619 output,
4620 output_size,
4621 output_length );
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004622 }
4623 else
4624 {
4625 status = mbedtls_to_psa_error(
4626 mbedtls_cipher_update( &operation->ctx.cipher, input,
4627 input_length, output, output_length ) );
4628 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004629exit:
4630 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02004631 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004632 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004633}
4634
Gilles Peskinee553c652018-06-04 16:22:46 +02004635psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
4636 uint8_t *output,
4637 size_t output_size,
4638 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02004639{
David Saadab4ecc272019-02-14 13:48:10 +02004640 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Gilles Peskinee553c652018-06-04 16:22:46 +02004641 uint8_t temp_output_buffer[MBEDTLS_MAX_BLOCK_LENGTH];
Steven Cooreman7df02922020-09-09 15:28:49 +02004642 if( operation->alg == 0 )
4643 {
4644 return( PSA_ERROR_BAD_STATE );
4645 }
4646 if( operation->iv_required && ! operation->iv_set )
4647 {
4648 return( PSA_ERROR_BAD_STATE );
4649 }
Moran Pekerbed71a22018-04-22 20:19:20 +03004650
Steven Cooremanef8575e2020-09-11 11:44:50 +02004651 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004652 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004653 status = psa_driver_wrapper_cipher_finish( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004654 output,
4655 output_size,
4656 output_length );
Steven Cooremanef8575e2020-09-11 11:44:50 +02004657 goto exit;
Steven Cooreman8b122252020-09-03 15:30:32 +02004658 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004659
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004660 if( operation->ctx.cipher.unprocessed_len != 0 )
Moran Peker7cb22b82018-06-05 11:40:02 +03004661 {
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004662 if( operation->alg == PSA_ALG_ECB_NO_PADDING ||
Fredrik Strupef90e3012020-09-28 16:11:33 +02004663 operation->alg == PSA_ALG_CBC_NO_PADDING )
Steven Cooremana6033e92020-08-25 11:47:50 +02004664 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004665 status = PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004666 goto exit;
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004667 }
Moran Pekerdc38ebc2018-04-30 15:45:34 +03004668 }
4669
Steven Cooremanef8575e2020-09-11 11:44:50 +02004670 status = mbedtls_to_psa_error(
4671 mbedtls_cipher_finish( &operation->ctx.cipher,
4672 temp_output_buffer,
4673 output_length ) );
4674 if( status != PSA_SUCCESS )
4675 goto exit;
Janos Follath315b51c2018-07-09 16:04:51 +01004676
Gilles Peskine46f1fd72018-06-28 19:31:31 +02004677 if( *output_length == 0 )
Janos Follath315b51c2018-07-09 16:04:51 +01004678 ; /* Nothing to copy. Note that output may be NULL in this case. */
Gilles Peskine46f1fd72018-06-28 19:31:31 +02004679 else if( output_size >= *output_length )
Moran Pekerdc38ebc2018-04-30 15:45:34 +03004680 memcpy( output, temp_output_buffer, *output_length );
4681 else
Janos Follath315b51c2018-07-09 16:04:51 +01004682 status = PSA_ERROR_BUFFER_TOO_SMALL;
mohammad1603503973b2018-03-12 15:59:30 +02004683
Steven Cooremanef8575e2020-09-11 11:44:50 +02004684exit:
4685 if( operation->mbedtls_in_use == 1 )
4686 mbedtls_platform_zeroize( temp_output_buffer, sizeof( temp_output_buffer ) );
Janos Follath315b51c2018-07-09 16:04:51 +01004687
Steven Cooremanef8575e2020-09-11 11:44:50 +02004688 if( status == PSA_SUCCESS )
4689 return( psa_cipher_abort( operation ) );
4690 else
4691 {
4692 *output_length = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004693 (void) psa_cipher_abort( operation );
Janos Follath315b51c2018-07-09 16:04:51 +01004694
Steven Cooremanef8575e2020-09-11 11:44:50 +02004695 return( status );
4696 }
mohammad1603503973b2018-03-12 15:59:30 +02004697}
4698
Gilles Peskinee553c652018-06-04 16:22:46 +02004699psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
4700{
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004701 if( operation->alg == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02004702 {
Steven Cooremana07b9972020-09-10 14:54:14 +02004703 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02004704 * in use. It's ok to call abort on such an object, and there's
4705 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004706 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02004707 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004708
Gilles Peskinef9c2c092018-06-21 16:57:07 +02004709 /* Sanity check (shouldn't happen: operation->alg should
4710 * always have been initialized to a valid value). */
4711 if( ! PSA_ALG_IS_CIPHER( operation->alg ) )
4712 return( PSA_ERROR_BAD_STATE );
4713
Steven Cooremanef8575e2020-09-11 11:44:50 +02004714 if( operation->mbedtls_in_use == 0 )
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004715 psa_driver_wrapper_cipher_abort( &operation->ctx.driver );
Steven Cooremand3feccd2020-09-01 15:56:14 +02004716 else
4717 mbedtls_cipher_free( &operation->ctx.cipher );
Gilles Peskinee553c652018-06-04 16:22:46 +02004718
Moran Peker41deec42018-04-04 15:43:05 +03004719 operation->alg = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004720 operation->key_set = 0;
4721 operation->iv_set = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004722 operation->mbedtls_in_use = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004723 operation->iv_size = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004724 operation->block_size = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004725 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004726
Moran Peker395db872018-05-31 14:07:14 +03004727 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02004728}
4729
Gilles Peskinea0655c32018-04-30 17:06:50 +02004730
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004731
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004732
mohammad16035955c982018-04-26 00:53:03 +03004733/****************************************************************/
4734/* AEAD */
4735/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004736
Gilles Peskineedf9a652018-08-17 18:11:56 +02004737typedef struct
4738{
Gilles Peskine2f060a82018-12-04 17:12:32 +01004739 psa_key_slot_t *slot;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004740 const mbedtls_cipher_info_t *cipher_info;
4741 union
4742 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02004743 unsigned dummy; /* Make the union non-empty even with no supported algorithms. */
Gilles Peskineedf9a652018-08-17 18:11:56 +02004744#if defined(MBEDTLS_CCM_C)
4745 mbedtls_ccm_context ccm;
4746#endif /* MBEDTLS_CCM_C */
4747#if defined(MBEDTLS_GCM_C)
4748 mbedtls_gcm_context gcm;
4749#endif /* MBEDTLS_GCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004750#if defined(MBEDTLS_CHACHAPOLY_C)
4751 mbedtls_chachapoly_context chachapoly;
4752#endif /* MBEDTLS_CHACHAPOLY_C */
Gilles Peskineedf9a652018-08-17 18:11:56 +02004753 } ctx;
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004754 psa_algorithm_t core_alg;
4755 uint8_t full_tag_length;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004756 uint8_t tag_length;
4757} aead_operation_t;
4758
Ronald Cronf95a2b12020-10-22 15:24:49 +02004759#define AEAD_OPERATION_INIT {0, 0, {0}, 0, 0, 0}
4760
Gilles Peskine30a9e412019-01-14 18:36:12 +01004761static void psa_aead_abort_internal( aead_operation_t *operation )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004762{
Gilles Peskinef8a8fe62018-08-21 16:38:05 +02004763 switch( operation->core_alg )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004764 {
4765#if defined(MBEDTLS_CCM_C)
4766 case PSA_ALG_CCM:
4767 mbedtls_ccm_free( &operation->ctx.ccm );
4768 break;
4769#endif /* MBEDTLS_CCM_C */
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004770#if defined(MBEDTLS_GCM_C)
Gilles Peskineedf9a652018-08-17 18:11:56 +02004771 case PSA_ALG_GCM:
4772 mbedtls_gcm_free( &operation->ctx.gcm );
4773 break;
4774#endif /* MBEDTLS_GCM_C */
4775 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004776
4777 psa_decrement_key_slot_access_count( operation->slot );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004778}
4779
4780static psa_status_t psa_aead_setup( aead_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004781 mbedtls_svc_key_id_t key,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004782 psa_key_usage_t usage,
4783 psa_algorithm_t alg )
4784{
4785 psa_status_t status;
4786 size_t key_bits;
4787 mbedtls_cipher_id_t cipher_id;
4788
Ronald Croncf56a0a2020-08-04 09:51:30 +02004789 status = psa_get_transparent_key( key, &operation->slot, usage, alg );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004790 if( status != PSA_SUCCESS )
4791 return( status );
4792
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02004793 key_bits = psa_get_key_slot_bits( operation->slot );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004794
4795 operation->cipher_info =
Gilles Peskine8e338702019-07-30 20:06:31 +02004796 mbedtls_cipher_info_from_psa( alg, operation->slot->attr.type, key_bits,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004797 &cipher_id );
4798 if( operation->cipher_info == NULL )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004799 {
4800 status = PSA_ERROR_NOT_SUPPORTED;
4801 goto cleanup;
4802 }
Gilles Peskineedf9a652018-08-17 18:11:56 +02004803
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004804 switch( PSA_ALG_AEAD_WITH_TAG_LENGTH( alg, 0 ) )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004805 {
4806#if defined(MBEDTLS_CCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004807 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CCM, 0 ):
4808 operation->core_alg = PSA_ALG_CCM;
4809 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004810 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.
4811 * The call to mbedtls_ccm_encrypt_and_tag or
4812 * mbedtls_ccm_auth_decrypt will validate the tag length. */
Gilles Peskine8e338702019-07-30 20:06:31 +02004813 if( PSA_BLOCK_CIPHER_BLOCK_SIZE( operation->slot->attr.type ) != 16 )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004814 {
4815 status = PSA_ERROR_INVALID_ARGUMENT;
4816 goto cleanup;
4817 }
Gilles Peskineedf9a652018-08-17 18:11:56 +02004818 mbedtls_ccm_init( &operation->ctx.ccm );
4819 status = mbedtls_to_psa_error(
4820 mbedtls_ccm_setkey( &operation->ctx.ccm, cipher_id,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004821 operation->slot->data.key.data,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004822 (unsigned int) key_bits ) );
4823 if( status != 0 )
4824 goto cleanup;
4825 break;
4826#endif /* MBEDTLS_CCM_C */
4827
4828#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004829 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_GCM, 0 ):
4830 operation->core_alg = PSA_ALG_GCM;
4831 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004832 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16.
4833 * The call to mbedtls_gcm_crypt_and_tag or
4834 * mbedtls_gcm_auth_decrypt will validate the tag length. */
Gilles Peskine8e338702019-07-30 20:06:31 +02004835 if( PSA_BLOCK_CIPHER_BLOCK_SIZE( operation->slot->attr.type ) != 16 )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004836 {
4837 status = PSA_ERROR_INVALID_ARGUMENT;
4838 goto cleanup;
4839 }
Gilles Peskineedf9a652018-08-17 18:11:56 +02004840 mbedtls_gcm_init( &operation->ctx.gcm );
4841 status = mbedtls_to_psa_error(
4842 mbedtls_gcm_setkey( &operation->ctx.gcm, cipher_id,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004843 operation->slot->data.key.data,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004844 (unsigned int) key_bits ) );
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004845 if( status != 0 )
4846 goto cleanup;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004847 break;
4848#endif /* MBEDTLS_GCM_C */
4849
Gilles Peskine26869f22019-05-06 15:25:00 +02004850#if defined(MBEDTLS_CHACHAPOLY_C)
4851 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CHACHA20_POLY1305, 0 ):
4852 operation->core_alg = PSA_ALG_CHACHA20_POLY1305;
4853 operation->full_tag_length = 16;
4854 /* We only support the default tag length. */
4855 if( alg != PSA_ALG_CHACHA20_POLY1305 )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004856 {
4857 status = PSA_ERROR_NOT_SUPPORTED;
4858 goto cleanup;
4859 }
Gilles Peskine26869f22019-05-06 15:25:00 +02004860 mbedtls_chachapoly_init( &operation->ctx.chachapoly );
4861 status = mbedtls_to_psa_error(
4862 mbedtls_chachapoly_setkey( &operation->ctx.chachapoly,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004863 operation->slot->data.key.data ) );
Gilles Peskine26869f22019-05-06 15:25:00 +02004864 if( status != 0 )
4865 goto cleanup;
4866 break;
4867#endif /* MBEDTLS_CHACHAPOLY_C */
4868
Gilles Peskineedf9a652018-08-17 18:11:56 +02004869 default:
Ronald Cronf95a2b12020-10-22 15:24:49 +02004870 status = PSA_ERROR_NOT_SUPPORTED;
4871 goto cleanup;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004872 }
4873
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004874 if( PSA_AEAD_TAG_LENGTH( alg ) > operation->full_tag_length )
4875 {
4876 status = PSA_ERROR_INVALID_ARGUMENT;
4877 goto cleanup;
4878 }
4879 operation->tag_length = PSA_AEAD_TAG_LENGTH( alg );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004880
Gilles Peskineedf9a652018-08-17 18:11:56 +02004881 return( PSA_SUCCESS );
4882
4883cleanup:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004884 psa_aead_abort_internal( operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004885 return( status );
4886}
4887
Ronald Croncf56a0a2020-08-04 09:51:30 +02004888psa_status_t psa_aead_encrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03004889 psa_algorithm_t alg,
4890 const uint8_t *nonce,
4891 size_t nonce_length,
4892 const uint8_t *additional_data,
4893 size_t additional_data_length,
4894 const uint8_t *plaintext,
4895 size_t plaintext_length,
4896 uint8_t *ciphertext,
4897 size_t ciphertext_size,
4898 size_t *ciphertext_length )
4899{
mohammad16035955c982018-04-26 00:53:03 +03004900 psa_status_t status;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004901 aead_operation_t operation = AEAD_OPERATION_INIT;
mohammad160315223a82018-06-03 17:19:55 +03004902 uint8_t *tag;
Gilles Peskine2d277862018-06-18 15:41:12 +02004903
mohammad1603f08a5502018-06-03 15:05:47 +03004904 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004905
Ronald Croncf56a0a2020-08-04 09:51:30 +02004906 status = psa_aead_setup( &operation, key, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004907 if( status != PSA_SUCCESS )
4908 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004909
Gilles Peskineedf9a652018-08-17 18:11:56 +02004910 /* For all currently supported modes, the tag is at the end of the
4911 * ciphertext. */
4912 if( ciphertext_size < ( plaintext_length + operation.tag_length ) )
4913 {
4914 status = PSA_ERROR_BUFFER_TOO_SMALL;
4915 goto exit;
4916 }
4917 tag = ciphertext + plaintext_length;
mohammad16035955c982018-04-26 00:53:03 +03004918
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004919#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004920 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03004921 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004922 status = mbedtls_to_psa_error(
4923 mbedtls_gcm_crypt_and_tag( &operation.ctx.gcm,
4924 MBEDTLS_GCM_ENCRYPT,
4925 plaintext_length,
4926 nonce, nonce_length,
4927 additional_data, additional_data_length,
4928 plaintext, ciphertext,
4929 operation.tag_length, tag ) );
mohammad16035955c982018-04-26 00:53:03 +03004930 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004931 else
4932#endif /* MBEDTLS_GCM_C */
4933#if defined(MBEDTLS_CCM_C)
4934 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03004935 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004936 status = mbedtls_to_psa_error(
4937 mbedtls_ccm_encrypt_and_tag( &operation.ctx.ccm,
4938 plaintext_length,
4939 nonce, nonce_length,
4940 additional_data,
4941 additional_data_length,
4942 plaintext, ciphertext,
4943 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03004944 }
mohammad16035c8845f2018-05-09 05:40:09 -07004945 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004946#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004947#if defined(MBEDTLS_CHACHAPOLY_C)
4948 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
4949 {
4950 if( nonce_length != 12 || operation.tag_length != 16 )
4951 {
4952 status = PSA_ERROR_NOT_SUPPORTED;
4953 goto exit;
4954 }
4955 status = mbedtls_to_psa_error(
4956 mbedtls_chachapoly_encrypt_and_tag( &operation.ctx.chachapoly,
4957 plaintext_length,
4958 nonce,
4959 additional_data,
4960 additional_data_length,
4961 plaintext,
4962 ciphertext,
4963 tag ) );
4964 }
4965 else
4966#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad16035c8845f2018-05-09 05:40:09 -07004967 {
mohammad1603554faad2018-06-03 15:07:38 +03004968 return( PSA_ERROR_NOT_SUPPORTED );
mohammad16035c8845f2018-05-09 05:40:09 -07004969 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004970
Gilles Peskineedf9a652018-08-17 18:11:56 +02004971 if( status != PSA_SUCCESS && ciphertext_size != 0 )
4972 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02004973
Gilles Peskineedf9a652018-08-17 18:11:56 +02004974exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004975 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004976 if( status == PSA_SUCCESS )
4977 *ciphertext_length = plaintext_length + operation.tag_length;
4978 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004979}
4980
Gilles Peskineee652a32018-06-01 19:23:52 +02004981/* Locate the tag in a ciphertext buffer containing the encrypted data
4982 * followed by the tag. Return the length of the part preceding the tag in
4983 * *plaintext_length. This is the size of the plaintext in modes where
4984 * the encrypted data has the same size as the plaintext, such as
4985 * CCM and GCM. */
4986static psa_status_t psa_aead_unpadded_locate_tag( size_t tag_length,
4987 const uint8_t *ciphertext,
4988 size_t ciphertext_length,
4989 size_t plaintext_size,
Gilles Peskineee652a32018-06-01 19:23:52 +02004990 const uint8_t **p_tag )
4991{
4992 size_t payload_length;
4993 if( tag_length > ciphertext_length )
4994 return( PSA_ERROR_INVALID_ARGUMENT );
4995 payload_length = ciphertext_length - tag_length;
4996 if( payload_length > plaintext_size )
4997 return( PSA_ERROR_BUFFER_TOO_SMALL );
4998 *p_tag = ciphertext + payload_length;
Gilles Peskineee652a32018-06-01 19:23:52 +02004999 return( PSA_SUCCESS );
5000}
5001
Ronald Croncf56a0a2020-08-04 09:51:30 +02005002psa_status_t psa_aead_decrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03005003 psa_algorithm_t alg,
5004 const uint8_t *nonce,
5005 size_t nonce_length,
5006 const uint8_t *additional_data,
5007 size_t additional_data_length,
5008 const uint8_t *ciphertext,
5009 size_t ciphertext_length,
5010 uint8_t *plaintext,
5011 size_t plaintext_size,
5012 size_t *plaintext_length )
5013{
mohammad16035955c982018-04-26 00:53:03 +03005014 psa_status_t status;
Ronald Cronf95a2b12020-10-22 15:24:49 +02005015 aead_operation_t operation = AEAD_OPERATION_INIT;
Gilles Peskineedf9a652018-08-17 18:11:56 +02005016 const uint8_t *tag = NULL;
Gilles Peskine2d277862018-06-18 15:41:12 +02005017
Gilles Peskineee652a32018-06-01 19:23:52 +02005018 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03005019
Ronald Croncf56a0a2020-08-04 09:51:30 +02005020 status = psa_aead_setup( &operation, key, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02005021 if( status != PSA_SUCCESS )
5022 return( status );
mohammad16035955c982018-04-26 00:53:03 +03005023
Gilles Peskinef7e7b012019-05-06 15:27:16 +02005024 status = psa_aead_unpadded_locate_tag( operation.tag_length,
5025 ciphertext, ciphertext_length,
5026 plaintext_size, &tag );
5027 if( status != PSA_SUCCESS )
5028 goto exit;
5029
Gilles Peskineb0b189f2018-11-28 17:30:58 +01005030#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02005031 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03005032 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02005033 status = mbedtls_to_psa_error(
5034 mbedtls_gcm_auth_decrypt( &operation.ctx.gcm,
5035 ciphertext_length - operation.tag_length,
5036 nonce, nonce_length,
5037 additional_data,
5038 additional_data_length,
5039 tag, operation.tag_length,
5040 ciphertext, plaintext ) );
mohammad16035955c982018-04-26 00:53:03 +03005041 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01005042 else
5043#endif /* MBEDTLS_GCM_C */
5044#if defined(MBEDTLS_CCM_C)
5045 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03005046 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02005047 status = mbedtls_to_psa_error(
5048 mbedtls_ccm_auth_decrypt( &operation.ctx.ccm,
5049 ciphertext_length - operation.tag_length,
5050 nonce, nonce_length,
5051 additional_data,
5052 additional_data_length,
5053 ciphertext, plaintext,
5054 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03005055 }
mohammad160339574652018-06-01 04:39:53 -07005056 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01005057#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02005058#if defined(MBEDTLS_CHACHAPOLY_C)
5059 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
5060 {
5061 if( nonce_length != 12 || operation.tag_length != 16 )
5062 {
5063 status = PSA_ERROR_NOT_SUPPORTED;
5064 goto exit;
5065 }
5066 status = mbedtls_to_psa_error(
5067 mbedtls_chachapoly_auth_decrypt( &operation.ctx.chachapoly,
5068 ciphertext_length - operation.tag_length,
5069 nonce,
5070 additional_data,
5071 additional_data_length,
5072 tag,
5073 ciphertext,
5074 plaintext ) );
5075 }
5076 else
5077#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad160339574652018-06-01 04:39:53 -07005078 {
mohammad1603554faad2018-06-03 15:07:38 +03005079 return( PSA_ERROR_NOT_SUPPORTED );
mohammad160339574652018-06-01 04:39:53 -07005080 }
Gilles Peskinea40d7742018-06-01 16:28:30 +02005081
Gilles Peskineedf9a652018-08-17 18:11:56 +02005082 if( status != PSA_SUCCESS && plaintext_size != 0 )
5083 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03005084
Gilles Peskineedf9a652018-08-17 18:11:56 +02005085exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01005086 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02005087 if( status == PSA_SUCCESS )
5088 *plaintext_length = ciphertext_length - operation.tag_length;
5089 return( status );
mohammad16035955c982018-04-26 00:53:03 +03005090}
5091
Gilles Peskinea0655c32018-04-30 17:06:50 +02005092
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02005093
Gilles Peskine20035e32018-02-03 22:44:14 +01005094/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02005095/* Generators */
5096/****************************************************************/
5097
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005098#define HKDF_STATE_INIT 0 /* no input yet */
5099#define HKDF_STATE_STARTED 1 /* got salt */
5100#define HKDF_STATE_KEYED 2 /* got key */
5101#define HKDF_STATE_OUTPUT 3 /* output started */
5102
Gilles Peskinecbe66502019-05-16 16:59:18 +02005103static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005104 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005105{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005106 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
5107 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005108 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005109 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005110}
5111
5112
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005113psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005114{
5115 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005116 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005117 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005118 {
5119 /* The object has (apparently) been initialized but it is not
5120 * in use. It's ok to call abort on such an object, and there's
5121 * nothing to do. */
5122 }
5123 else
Gilles Peskinebef7f142018-07-12 17:22:21 +02005124#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005125 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02005126 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005127 mbedtls_free( operation->ctx.hkdf.info );
5128 status = psa_hmac_abort_internal( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02005129 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01005130 else if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005131 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01005132 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005133 {
Janos Follath6a1d2622019-06-11 10:37:28 +01005134 if( operation->ctx.tls12_prf.seed != NULL )
5135 {
5136 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
5137 operation->ctx.tls12_prf.seed_length );
5138 mbedtls_free( operation->ctx.tls12_prf.seed );
5139 }
5140
5141 if( operation->ctx.tls12_prf.label != NULL )
5142 {
5143 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
5144 operation->ctx.tls12_prf.label_length );
5145 mbedtls_free( operation->ctx.tls12_prf.label );
5146 }
5147
5148 status = psa_hmac_abort_internal( &operation->ctx.tls12_prf.hmac );
5149
5150 /* We leave the fields Ai and output_block to be erased safely by the
5151 * mbedtls_platform_zeroize() in the end of this function. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005152 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005153 else
5154#endif /* MBEDTLS_MD_C */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005155 {
5156 status = PSA_ERROR_BAD_STATE;
5157 }
Janos Follath083036a2019-06-11 10:22:26 +01005158 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005159 return( status );
5160}
5161
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005162psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02005163 size_t *capacity)
5164{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005165 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005166 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005167 /* This is a blank key derivation operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02005168 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005169 }
5170
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005171 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005172 return( PSA_SUCCESS );
5173}
5174
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005175psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005176 size_t capacity )
5177{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005178 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005179 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005180 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005181 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005182 operation->capacity = capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005183 return( PSA_SUCCESS );
5184}
5185
Gilles Peskinebef7f142018-07-12 17:22:21 +02005186#if defined(MBEDTLS_MD_C)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005187/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02005188 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02005189static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskinebef7f142018-07-12 17:22:21 +02005190 psa_algorithm_t hash_alg,
5191 uint8_t *output,
5192 size_t output_length )
5193{
5194 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
5195 psa_status_t status;
5196
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005197 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
5198 return( PSA_ERROR_BAD_STATE );
5199 hkdf->state = HKDF_STATE_OUTPUT;
5200
Gilles Peskinebef7f142018-07-12 17:22:21 +02005201 while( output_length != 0 )
5202 {
5203 /* Copy what remains of the current block */
5204 uint8_t n = hash_length - hkdf->offset_in_block;
5205 if( n > output_length )
5206 n = (uint8_t) output_length;
5207 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
5208 output += n;
5209 output_length -= n;
5210 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02005211 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02005212 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02005213 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005214 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005215 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02005216 * object was corrupted or if this function is called directly
5217 * inside the library. */
5218 if( hkdf->block_number == 0xff )
5219 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02005220
5221 /* We need a new block */
5222 ++hkdf->block_number;
5223 hkdf->offset_in_block = 0;
5224 status = psa_hmac_setup_internal( &hkdf->hmac,
5225 hkdf->prk, hash_length,
5226 hash_alg );
5227 if( status != PSA_SUCCESS )
5228 return( status );
5229 if( hkdf->block_number != 1 )
5230 {
5231 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5232 hkdf->output_block,
5233 hash_length );
5234 if( status != PSA_SUCCESS )
5235 return( status );
5236 }
5237 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5238 hkdf->info,
5239 hkdf->info_length );
5240 if( status != PSA_SUCCESS )
5241 return( status );
5242 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5243 &hkdf->block_number, 1 );
5244 if( status != PSA_SUCCESS )
5245 return( status );
5246 status = psa_hmac_finish_internal( &hkdf->hmac,
5247 hkdf->output_block,
5248 sizeof( hkdf->output_block ) );
5249 if( status != PSA_SUCCESS )
5250 return( status );
5251 }
5252
5253 return( PSA_SUCCESS );
5254}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005255
Janos Follath7742fee2019-06-17 12:58:10 +01005256static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
5257 psa_tls12_prf_key_derivation_t *tls12_prf,
5258 psa_algorithm_t alg )
5259{
5260 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
5261 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
Janos Follathea29bfb2019-06-19 12:21:20 +01005262 psa_hash_operation_t backup = PSA_HASH_OPERATION_INIT;
5263 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005264
Janos Follath7742fee2019-06-17 12:58:10 +01005265 /* We can't be wanting more output after block 0xff, otherwise
5266 * the capacity check in psa_key_derivation_output_bytes() would have
5267 * prevented this call. It could happen only if the operation
5268 * object was corrupted or if this function is called directly
5269 * inside the library. */
5270 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01005271 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01005272
5273 /* We need a new block */
5274 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01005275 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01005276
5277 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
5278 *
5279 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
5280 *
5281 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
5282 * HMAC_hash(secret, A(2) + seed) +
5283 * HMAC_hash(secret, A(3) + seed) + ...
5284 *
5285 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01005286 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01005287 *
Janos Follathea29bfb2019-06-19 12:21:20 +01005288 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01005289 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01005290 * is currently extracted as `output_block` and where i is
5291 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01005292 */
5293
Janos Follathea29bfb2019-06-19 12:21:20 +01005294 /* Save the hash context before using it, to preserve the hash state with
5295 * only the inner padding in it. We need this, because inner padding depends
5296 * on the key (secret in the RFC's terminology). */
5297 status = psa_hash_clone( &tls12_prf->hmac.hash_ctx, &backup );
5298 if( status != PSA_SUCCESS )
5299 goto cleanup;
5300
5301 /* Calculate A(i) where i = tls12_prf->block_number. */
5302 if( tls12_prf->block_number == 1 )
5303 {
5304 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
5305 * the variable seed and in this instance means it in the context of the
5306 * P_hash function, where seed = label + seed.) */
5307 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5308 tls12_prf->label, tls12_prf->label_length );
5309 if( status != PSA_SUCCESS )
5310 goto cleanup;
5311 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5312 tls12_prf->seed, tls12_prf->seed_length );
5313 if( status != PSA_SUCCESS )
5314 goto cleanup;
5315 }
5316 else
5317 {
5318 /* A(i) = HMAC_hash(secret, A(i-1)) */
5319 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5320 tls12_prf->Ai, hash_length );
5321 if( status != PSA_SUCCESS )
5322 goto cleanup;
5323 }
5324
5325 status = psa_hmac_finish_internal( &tls12_prf->hmac,
5326 tls12_prf->Ai, hash_length );
5327 if( status != PSA_SUCCESS )
5328 goto cleanup;
5329 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
5330 if( status != PSA_SUCCESS )
5331 goto cleanup;
5332
5333 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
5334 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5335 tls12_prf->Ai, hash_length );
5336 if( status != PSA_SUCCESS )
5337 goto cleanup;
5338 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5339 tls12_prf->label, tls12_prf->label_length );
5340 if( status != PSA_SUCCESS )
5341 goto cleanup;
5342 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5343 tls12_prf->seed, tls12_prf->seed_length );
5344 if( status != PSA_SUCCESS )
5345 goto cleanup;
5346 status = psa_hmac_finish_internal( &tls12_prf->hmac,
5347 tls12_prf->output_block, hash_length );
5348 if( status != PSA_SUCCESS )
5349 goto cleanup;
5350 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
5351 if( status != PSA_SUCCESS )
5352 goto cleanup;
5353
Janos Follath7742fee2019-06-17 12:58:10 +01005354
5355cleanup:
5356
Janos Follathea29bfb2019-06-19 12:21:20 +01005357 cleanup_status = psa_hash_abort( &backup );
5358 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
5359 status = cleanup_status;
5360
5361 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01005362}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005363
Janos Follath844eb0e2019-06-19 12:10:49 +01005364static psa_status_t psa_key_derivation_tls12_prf_read(
5365 psa_tls12_prf_key_derivation_t *tls12_prf,
5366 psa_algorithm_t alg,
5367 uint8_t *output,
5368 size_t output_length )
5369{
5370 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
5371 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
5372 psa_status_t status;
5373 uint8_t offset, length;
5374
5375 while( output_length != 0 )
5376 {
5377 /* Check if we have fully processed the current block. */
5378 if( tls12_prf->left_in_block == 0 )
5379 {
5380 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
5381 alg );
5382 if( status != PSA_SUCCESS )
5383 return( status );
5384
5385 continue;
5386 }
5387
5388 if( tls12_prf->left_in_block > output_length )
5389 length = (uint8_t) output_length;
5390 else
5391 length = tls12_prf->left_in_block;
5392
5393 offset = hash_length - tls12_prf->left_in_block;
5394 memcpy( output, tls12_prf->output_block + offset, length );
5395 output += length;
5396 output_length -= length;
5397 tls12_prf->left_in_block -= length;
5398 }
5399
5400 return( PSA_SUCCESS );
5401}
Gilles Peskinebef7f142018-07-12 17:22:21 +02005402#endif /* MBEDTLS_MD_C */
5403
Janos Follath6c6c8fc2019-06-17 12:38:20 +01005404psa_status_t psa_key_derivation_output_bytes(
5405 psa_key_derivation_operation_t *operation,
5406 uint8_t *output,
5407 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005408{
5409 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005410 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005411
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005412 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005413 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005414 /* This is a blank operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02005415 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005416 }
5417
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005418 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005419 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005420 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005421 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005422 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02005423 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005424 goto exit;
5425 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005426 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005427 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005428 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005429 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02005430 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
5431 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005432 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02005433 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02005434 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005435 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005436 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005437
Gilles Peskinebef7f142018-07-12 17:22:21 +02005438#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005439 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02005440 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01005441 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005442 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02005443 output, output_length );
5444 }
Janos Follathadbec812019-06-14 11:05:39 +01005445 else
Janos Follathadbec812019-06-14 11:05:39 +01005446 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine969c5d62019-01-16 15:53:06 +01005447 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005448 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005449 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005450 kdf_alg, output,
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005451 output_length );
5452 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005453 else
5454#endif /* MBEDTLS_MD_C */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005455 {
5456 return( PSA_ERROR_BAD_STATE );
5457 }
5458
5459exit:
5460 if( status != PSA_SUCCESS )
5461 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005462 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005463 * This allows us to differentiate between exhausted operations and
5464 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
5465 * operations. */
5466 psa_algorithm_t alg = operation->alg;
5467 psa_key_derivation_abort( operation );
5468 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005469 memset( output, '!', output_length );
5470 }
5471 return( status );
5472}
5473
Gilles Peskine08542d82018-07-19 17:05:42 +02005474#if defined(MBEDTLS_DES_C)
5475static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
5476{
5477 if( data_size >= 8 )
5478 mbedtls_des_key_set_parity( data );
5479 if( data_size >= 16 )
5480 mbedtls_des_key_set_parity( data + 8 );
5481 if( data_size >= 24 )
5482 mbedtls_des_key_set_parity( data + 16 );
5483}
5484#endif /* MBEDTLS_DES_C */
5485
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005486static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005487 psa_key_slot_t *slot,
5488 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005489 psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005490{
5491 uint8_t *data = NULL;
5492 size_t bytes = PSA_BITS_TO_BYTES( bits );
5493 psa_status_t status;
5494
Gilles Peskine8e338702019-07-30 20:06:31 +02005495 if( ! key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005496 return( PSA_ERROR_INVALID_ARGUMENT );
5497 if( bits % 8 != 0 )
5498 return( PSA_ERROR_INVALID_ARGUMENT );
5499 data = mbedtls_calloc( 1, bytes );
5500 if( data == NULL )
5501 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5502
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005503 status = psa_key_derivation_output_bytes( operation, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005504 if( status != PSA_SUCCESS )
5505 goto exit;
Gilles Peskine08542d82018-07-19 17:05:42 +02005506#if defined(MBEDTLS_DES_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02005507 if( slot->attr.type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02005508 psa_des_set_key_parity( data, bytes );
5509#endif /* MBEDTLS_DES_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005510 status = psa_import_key_into_slot( slot, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005511
5512exit:
5513 mbedtls_free( data );
5514 return( status );
5515}
5516
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005517psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005518 psa_key_derivation_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005519 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005520{
5521 psa_status_t status;
5522 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005523 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02005524
5525 /* Reject any attempt to create a zero-length key so that we don't
5526 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
5527 if( psa_get_key_bits( attributes ) == 0 )
5528 return( PSA_ERROR_INVALID_ARGUMENT );
5529
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005530 if( ! operation->can_output_key )
5531 return( PSA_ERROR_NOT_PERMITTED );
5532
Gilles Peskinedf179142019-07-15 22:02:14 +02005533 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005534 attributes, key, &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02005535#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
5536 if( driver != NULL )
5537 {
5538 /* Deriving a key in a secure element is not implemented yet. */
5539 status = PSA_ERROR_NOT_SUPPORTED;
5540 }
5541#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005542 if( status == PSA_SUCCESS )
5543 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005544 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02005545 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005546 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005547 }
5548 if( status == PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02005549 status = psa_finish_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005550 if( status != PSA_SUCCESS )
5551 {
Gilles Peskine011e4282019-06-26 18:34:38 +02005552 psa_fail_key_creation( slot, driver );
Ronald Croncf56a0a2020-08-04 09:51:30 +02005553 *key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005554 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02005555 else
5556 status = psa_decrement_key_slot_access_count( slot );
5557
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005558 return( status );
5559}
5560
Gilles Peskineeab56e42018-07-12 17:12:33 +02005561
5562
5563/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02005564/* Key derivation */
5565/****************************************************************/
5566
Gilles Peskine969c5d62019-01-16 15:53:06 +01005567static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005568 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005569 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005570{
Janos Follath5fe19732019-06-20 15:09:30 +01005571 /* Make sure that operation->ctx is properly zero-initialised. (Macro
5572 * initialisers for this union leave some bytes unspecified.) */
5573 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
5574
Gilles Peskine969c5d62019-01-16 15:53:06 +01005575 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005576#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005577 if( PSA_ALG_IS_HKDF( kdf_alg ) ||
5578 PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
5579 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005580 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01005581 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005582 size_t hash_size = PSA_HASH_SIZE( hash_alg );
5583 if( hash_size == 0 )
5584 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005585 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
5586 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02005587 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005588 {
5589 return( PSA_ERROR_NOT_SUPPORTED );
5590 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005591 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01005592 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005593 }
5594#endif /* MBEDTLS_MD_C */
Gilles Peskine969c5d62019-01-16 15:53:06 +01005595 else
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005596 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005597}
5598
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005599psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005600 psa_algorithm_t alg )
5601{
5602 psa_status_t status;
5603
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005604 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005605 return( PSA_ERROR_BAD_STATE );
5606
Gilles Peskine6843c292019-01-18 16:44:49 +01005607 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
5608 return( PSA_ERROR_INVALID_ARGUMENT );
5609 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005610 {
5611 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005612 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005613 }
5614 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
5615 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005616 status = psa_key_derivation_setup_kdf( operation, alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005617 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005618 else
5619 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005620
5621 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005622 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01005623 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005624}
5625
5626#if defined(MBEDTLS_MD_C)
Gilles Peskinecbe66502019-05-16 16:59:18 +02005627static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005628 psa_algorithm_t hash_alg,
5629 psa_key_derivation_step_t step,
5630 const uint8_t *data,
5631 size_t data_length )
5632{
5633 psa_status_t status;
5634 switch( step )
5635 {
Gilles Peskine03410b52019-05-16 16:05:19 +02005636 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02005637 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005638 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005639 status = psa_hmac_setup_internal( &hkdf->hmac,
5640 data, data_length,
5641 hash_alg );
5642 if( status != PSA_SUCCESS )
5643 return( status );
5644 hkdf->state = HKDF_STATE_STARTED;
5645 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02005646 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005647 /* If no salt was provided, use an empty salt. */
5648 if( hkdf->state == HKDF_STATE_INIT )
5649 {
5650 status = psa_hmac_setup_internal( &hkdf->hmac,
5651 NULL, 0,
Gilles Peskinef9ee6332019-04-11 21:22:52 +02005652 hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005653 if( status != PSA_SUCCESS )
5654 return( status );
5655 hkdf->state = HKDF_STATE_STARTED;
5656 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02005657 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005658 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005659 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5660 data, data_length );
5661 if( status != PSA_SUCCESS )
5662 return( status );
5663 status = psa_hmac_finish_internal( &hkdf->hmac,
5664 hkdf->prk,
5665 sizeof( hkdf->prk ) );
5666 if( status != PSA_SUCCESS )
5667 return( status );
5668 hkdf->offset_in_block = PSA_HASH_SIZE( hash_alg );
5669 hkdf->block_number = 0;
5670 hkdf->state = HKDF_STATE_KEYED;
5671 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02005672 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005673 if( hkdf->state == HKDF_STATE_OUTPUT )
5674 return( PSA_ERROR_BAD_STATE );
5675 if( hkdf->info_set )
5676 return( PSA_ERROR_BAD_STATE );
5677 hkdf->info_length = data_length;
5678 if( data_length != 0 )
5679 {
5680 hkdf->info = mbedtls_calloc( 1, data_length );
5681 if( hkdf->info == NULL )
5682 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5683 memcpy( hkdf->info, data, data_length );
5684 }
5685 hkdf->info_set = 1;
5686 return( PSA_SUCCESS );
5687 default:
5688 return( PSA_ERROR_INVALID_ARGUMENT );
5689 }
5690}
Janos Follathb03233e2019-06-11 15:30:30 +01005691
Janos Follathf08e2652019-06-13 09:05:41 +01005692static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
5693 const uint8_t *data,
5694 size_t data_length )
5695{
5696 if( prf->state != TLS12_PRF_STATE_INIT )
5697 return( PSA_ERROR_BAD_STATE );
5698
Janos Follathd6dce9f2019-07-04 09:11:38 +01005699 if( data_length != 0 )
5700 {
5701 prf->seed = mbedtls_calloc( 1, data_length );
5702 if( prf->seed == NULL )
5703 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01005704
Janos Follathd6dce9f2019-07-04 09:11:38 +01005705 memcpy( prf->seed, data, data_length );
5706 prf->seed_length = data_length;
5707 }
Janos Follathf08e2652019-06-13 09:05:41 +01005708
5709 prf->state = TLS12_PRF_STATE_SEED_SET;
5710
5711 return( PSA_SUCCESS );
5712}
5713
Janos Follath81550542019-06-13 14:26:34 +01005714static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
5715 psa_algorithm_t hash_alg,
5716 const uint8_t *data,
5717 size_t data_length )
5718{
5719 psa_status_t status;
5720 if( prf->state != TLS12_PRF_STATE_SEED_SET )
5721 return( PSA_ERROR_BAD_STATE );
5722
5723 status = psa_hmac_setup_internal( &prf->hmac, data, data_length, hash_alg );
5724 if( status != PSA_SUCCESS )
5725 return( status );
5726
5727 prf->state = TLS12_PRF_STATE_KEY_SET;
5728
5729 return( PSA_SUCCESS );
5730}
5731
Janos Follath6660f0e2019-06-17 08:44:03 +01005732static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
5733 psa_tls12_prf_key_derivation_t *prf,
5734 psa_algorithm_t hash_alg,
5735 const uint8_t *data,
5736 size_t data_length )
5737{
5738 psa_status_t status;
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02005739 uint8_t pms[ 4 + 2 * PSA_ALG_TLS12_PSK_TO_MS_MAX_PSK_LEN ];
5740 uint8_t *cur = pms;
Janos Follath6660f0e2019-06-17 08:44:03 +01005741
5742 if( data_length > PSA_ALG_TLS12_PSK_TO_MS_MAX_PSK_LEN )
5743 return( PSA_ERROR_INVALID_ARGUMENT );
5744
5745 /* Quoting RFC 4279, Section 2:
5746 *
5747 * The premaster secret is formed as follows: if the PSK is N octets
5748 * long, concatenate a uint16 with the value N, N zero octets, a second
5749 * uint16 with the value N, and the PSK itself.
5750 */
5751
Janos Follath40e13932019-06-26 13:22:29 +01005752 *cur++ = ( data_length >> 8 ) & 0xff;
5753 *cur++ = ( data_length >> 0 ) & 0xff;
5754 memset( cur, 0, data_length );
5755 cur += data_length;
5756 *cur++ = pms[0];
5757 *cur++ = pms[1];
5758 memcpy( cur, data, data_length );
5759 cur += data_length;
Janos Follath6660f0e2019-06-17 08:44:03 +01005760
Janos Follath40e13932019-06-26 13:22:29 +01005761 status = psa_tls12_prf_set_key( prf, hash_alg, pms, cur - pms );
Janos Follath6660f0e2019-06-17 08:44:03 +01005762
5763 mbedtls_platform_zeroize( pms, sizeof( pms ) );
5764 return( status );
5765}
5766
Janos Follath63028dd2019-06-13 09:15:47 +01005767static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
5768 const uint8_t *data,
5769 size_t data_length )
5770{
5771 if( prf->state != TLS12_PRF_STATE_KEY_SET )
5772 return( PSA_ERROR_BAD_STATE );
5773
Janos Follathd6dce9f2019-07-04 09:11:38 +01005774 if( data_length != 0 )
5775 {
5776 prf->label = mbedtls_calloc( 1, data_length );
5777 if( prf->label == NULL )
5778 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01005779
Janos Follathd6dce9f2019-07-04 09:11:38 +01005780 memcpy( prf->label, data, data_length );
5781 prf->label_length = data_length;
5782 }
Janos Follath63028dd2019-06-13 09:15:47 +01005783
5784 prf->state = TLS12_PRF_STATE_LABEL_SET;
5785
5786 return( PSA_SUCCESS );
5787}
5788
Janos Follathb03233e2019-06-11 15:30:30 +01005789static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
5790 psa_algorithm_t hash_alg,
5791 psa_key_derivation_step_t step,
5792 const uint8_t *data,
5793 size_t data_length )
5794{
Janos Follathb03233e2019-06-11 15:30:30 +01005795 switch( step )
5796 {
Janos Follathf08e2652019-06-13 09:05:41 +01005797 case PSA_KEY_DERIVATION_INPUT_SEED:
5798 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01005799 case PSA_KEY_DERIVATION_INPUT_SECRET:
5800 return( psa_tls12_prf_set_key( prf, hash_alg, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01005801 case PSA_KEY_DERIVATION_INPUT_LABEL:
5802 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01005803 default:
5804 return( PSA_ERROR_INVALID_ARGUMENT );
5805 }
5806}
Janos Follath6660f0e2019-06-17 08:44:03 +01005807
5808static psa_status_t psa_tls12_prf_psk_to_ms_input(
5809 psa_tls12_prf_key_derivation_t *prf,
5810 psa_algorithm_t hash_alg,
5811 psa_key_derivation_step_t step,
5812 const uint8_t *data,
5813 size_t data_length )
5814{
5815 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01005816 {
Janos Follath6660f0e2019-06-17 08:44:03 +01005817 return( psa_tls12_prf_psk_to_ms_set_key( prf, hash_alg,
5818 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01005819 }
Janos Follath6660f0e2019-06-17 08:44:03 +01005820
5821 return( psa_tls12_prf_input( prf, hash_alg, step, data, data_length ) );
5822}
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005823#endif /* MBEDTLS_MD_C */
5824
Gilles Peskineb8965192019-09-24 16:21:10 +02005825/** Check whether the given key type is acceptable for the given
5826 * input step of a key derivation.
5827 *
5828 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
5829 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
5830 * Both secret and non-secret inputs can alternatively have the type
5831 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
5832 * that the input was passed as a buffer rather than via a key object.
5833 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02005834static int psa_key_derivation_check_input_type(
5835 psa_key_derivation_step_t step,
5836 psa_key_type_t key_type )
5837{
5838 switch( step )
5839 {
5840 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb8965192019-09-24 16:21:10 +02005841 if( key_type == PSA_KEY_TYPE_DERIVE )
5842 return( PSA_SUCCESS );
5843 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005844 return( PSA_SUCCESS );
5845 break;
5846 case PSA_KEY_DERIVATION_INPUT_LABEL:
5847 case PSA_KEY_DERIVATION_INPUT_SALT:
5848 case PSA_KEY_DERIVATION_INPUT_INFO:
5849 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskineb8965192019-09-24 16:21:10 +02005850 if( key_type == PSA_KEY_TYPE_RAW_DATA )
5851 return( PSA_SUCCESS );
5852 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005853 return( PSA_SUCCESS );
5854 break;
5855 }
5856 return( PSA_ERROR_INVALID_ARGUMENT );
5857}
5858
Janos Follathb80a94e2019-06-12 15:54:46 +01005859static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005860 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005861 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005862 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005863 const uint8_t *data,
5864 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005865{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02005866 psa_status_t status;
5867 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
5868
5869 status = psa_key_derivation_check_input_type( step, key_type );
Gilles Peskine224b0d62019-09-23 18:13:17 +02005870 if( status != PSA_SUCCESS )
5871 goto exit;
5872
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005873#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005874 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005875 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005876 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005877 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005878 step, data, data_length );
5879 }
k-stachowiak012dcc42019-08-13 14:55:03 +02005880 else if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005881 {
Janos Follathb03233e2019-06-11 15:30:30 +01005882 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
5883 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5884 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01005885 }
5886 else if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
5887 {
5888 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
5889 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5890 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005891 }
5892 else
5893#endif /* MBEDTLS_MD_C */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005894 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005895 /* This can't happen unless the operation object was not initialized */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005896 return( PSA_ERROR_BAD_STATE );
5897 }
5898
Gilles Peskine224b0d62019-09-23 18:13:17 +02005899exit:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005900 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005901 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005902 return( status );
5903}
5904
Janos Follath51f4a0f2019-06-14 11:35:55 +01005905psa_status_t psa_key_derivation_input_bytes(
5906 psa_key_derivation_operation_t *operation,
5907 psa_key_derivation_step_t step,
5908 const uint8_t *data,
5909 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005910{
Gilles Peskineb8965192019-09-24 16:21:10 +02005911 return( psa_key_derivation_input_internal( operation, step,
5912 PSA_KEY_TYPE_NONE,
Janos Follathc5621512019-06-14 11:27:57 +01005913 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005914}
5915
Janos Follath51f4a0f2019-06-14 11:35:55 +01005916psa_status_t psa_key_derivation_input_key(
5917 psa_key_derivation_operation_t *operation,
5918 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005919 mbedtls_svc_key_id_t key )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005920{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005921 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5922 psa_status_t decrement_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005923 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005924
Ronald Croncf56a0a2020-08-04 09:51:30 +02005925 status = psa_get_transparent_key( key, &slot,
5926 PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005927 if( status != PSA_SUCCESS )
Gilles Peskine593773d2019-09-23 18:17:40 +02005928 {
5929 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005930 return( status );
Gilles Peskine593773d2019-09-23 18:17:40 +02005931 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005932
5933 /* Passing a key object as a SECRET input unlocks the permission
5934 * to output to a key object. */
5935 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5936 operation->can_output_key = 1;
5937
Ronald Cronf95a2b12020-10-22 15:24:49 +02005938 status = psa_key_derivation_input_internal( operation,
5939 step, slot->attr.type,
5940 slot->data.key.data,
5941 slot->data.key.bytes );
5942
5943 decrement_status = psa_decrement_key_slot_access_count( slot );
5944
5945 return( ( status == PSA_SUCCESS ) ? decrement_status : status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005946}
Gilles Peskineea0fb492018-07-12 17:17:20 +02005947
5948
5949
5950/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02005951/* Key agreement */
5952/****************************************************************/
5953
Gilles Peskinea05219c2018-11-16 16:02:56 +01005954#if defined(MBEDTLS_ECDH_C)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005955static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
5956 size_t peer_key_length,
5957 const mbedtls_ecp_keypair *our_key,
5958 uint8_t *shared_secret,
5959 size_t shared_secret_size,
5960 size_t *shared_secret_length )
5961{
Steven Cooremand4867872020-08-05 16:31:39 +02005962 mbedtls_ecp_keypair *their_key = NULL;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005963 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00005964 psa_status_t status;
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005965 size_t bits = 0;
Paul Elliott8ff510a2020-06-02 17:19:28 +01005966 psa_ecc_family_t curve = mbedtls_ecc_group_to_psa( our_key->grp.id, &bits );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005967 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005968
Steven Cooreman4fed4552020-08-03 14:46:03 +02005969 status = psa_load_ecp_representation( PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve),
5970 peer_key,
Steven Cooreman7f391872020-07-30 14:57:44 +02005971 peer_key_length,
Steven Cooreman7f391872020-07-30 14:57:44 +02005972 &their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00005973 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005974 goto exit;
5975
Jaeden Amero97271b32019-01-10 19:38:51 +00005976 status = mbedtls_to_psa_error(
Steven Cooremana2371e52020-07-28 14:30:39 +02005977 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
Jaeden Amero97271b32019-01-10 19:38:51 +00005978 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005979 goto exit;
Jaeden Amero97271b32019-01-10 19:38:51 +00005980 status = mbedtls_to_psa_error(
5981 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
5982 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005983 goto exit;
5984
Jaeden Amero97271b32019-01-10 19:38:51 +00005985 status = mbedtls_to_psa_error(
5986 mbedtls_ecdh_calc_secret( &ecdh,
5987 shared_secret_length,
5988 shared_secret, shared_secret_size,
5989 mbedtls_ctr_drbg_random,
5990 &global_data.ctr_drbg ) );
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005991 if( status != PSA_SUCCESS )
5992 goto exit;
5993 if( PSA_BITS_TO_BYTES( bits ) != *shared_secret_length )
5994 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005995
5996exit:
Gilles Peskine3e819b72019-12-20 14:09:55 +01005997 if( status != PSA_SUCCESS )
5998 mbedtls_platform_zeroize( shared_secret, shared_secret_size );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005999 mbedtls_ecdh_free( &ecdh );
Steven Cooremana2371e52020-07-28 14:30:39 +02006000 mbedtls_ecp_keypair_free( their_key );
Steven Cooreman6d839f02020-07-30 11:36:45 +02006001 mbedtls_free( their_key );
Steven Cooremana2371e52020-07-28 14:30:39 +02006002
Jaeden Amero97271b32019-01-10 19:38:51 +00006003 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006004}
Gilles Peskinea05219c2018-11-16 16:02:56 +01006005#endif /* MBEDTLS_ECDH_C */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006006
Gilles Peskine01d718c2018-09-18 12:01:02 +02006007#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
6008
Gilles Peskine0216fe12019-04-11 21:23:21 +02006009static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
6010 psa_key_slot_t *private_key,
6011 const uint8_t *peer_key,
6012 size_t peer_key_length,
6013 uint8_t *shared_secret,
6014 size_t shared_secret_size,
6015 size_t *shared_secret_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02006016{
Gilles Peskine0216fe12019-04-11 21:23:21 +02006017 switch( alg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02006018 {
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006019#if defined(MBEDTLS_ECDH_C)
Gilles Peskine0216fe12019-04-11 21:23:21 +02006020 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02006021 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006022 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremana2371e52020-07-28 14:30:39 +02006023 mbedtls_ecp_keypair *ecp = NULL;
Steven Cooreman7f391872020-07-30 14:57:44 +02006024 psa_status_t status = psa_load_ecp_representation(
Steven Cooreman4fed4552020-08-03 14:46:03 +02006025 private_key->attr.type,
Steven Cooreman7f391872020-07-30 14:57:44 +02006026 private_key->data.key.data,
6027 private_key->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02006028 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02006029 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02006030 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02006031 status = psa_key_agreement_ecdh( peer_key, peer_key_length,
Steven Cooremana2371e52020-07-28 14:30:39 +02006032 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02006033 shared_secret, shared_secret_size,
6034 shared_secret_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02006035 mbedtls_ecp_keypair_free( ecp );
6036 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02006037 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006038#endif /* MBEDTLS_ECDH_C */
Gilles Peskine01d718c2018-09-18 12:01:02 +02006039 default:
Gilles Peskine93f85002018-11-16 16:43:31 +01006040 (void) private_key;
6041 (void) peer_key;
6042 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02006043 (void) shared_secret;
6044 (void) shared_secret_size;
6045 (void) shared_secret_length;
Gilles Peskine01d718c2018-09-18 12:01:02 +02006046 return( PSA_ERROR_NOT_SUPPORTED );
6047 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02006048}
6049
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02006050/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02006051 * to potentially free embedded data structures and wipe confidential data.
6052 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006053static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01006054 psa_key_derivation_step_t step,
Gilles Peskine01d718c2018-09-18 12:01:02 +02006055 psa_key_slot_t *private_key,
6056 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01006057 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02006058{
6059 psa_status_t status;
6060 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
6061 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006062 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02006063
6064 /* Step 1: run the secret agreement algorithm to generate the shared
6065 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02006066 status = psa_key_agreement_raw_internal( ka_alg,
6067 private_key,
6068 peer_key, peer_key_length,
itayzafrir0adf0fc2018-09-06 16:24:41 +03006069 shared_secret,
6070 sizeof( shared_secret ),
Gilles Peskine05d69892018-06-19 22:00:52 +02006071 &shared_secret_length );
Gilles Peskine53d991e2018-07-12 01:14:59 +02006072 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02006073 goto exit;
6074
Gilles Peskineb0b255c2018-07-06 17:01:38 +02006075 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02006076 * the shared secret. A shared secret is permitted wherever a key
6077 * of type DERIVE is permitted. */
Janos Follathb80a94e2019-06-12 15:54:46 +01006078 status = psa_key_derivation_input_internal( operation, step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02006079 PSA_KEY_TYPE_DERIVE,
Janos Follathb80a94e2019-06-12 15:54:46 +01006080 shared_secret,
6081 shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02006082exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01006083 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02006084 return( status );
6085}
6086
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006087psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02006088 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02006089 mbedtls_svc_key_id_t private_key,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02006090 const uint8_t *peer_key,
6091 size_t peer_key_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +02006092{
Ronald Cronf95a2b12020-10-22 15:24:49 +02006093 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
6094 psa_status_t decrement_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01006095 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02006096
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006097 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02006098 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine28f8f302019-07-24 13:30:31 +02006099 status = psa_get_transparent_key( private_key, &slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02006100 PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine12313cd2018-06-20 00:20:32 +02006101 if( status != PSA_SUCCESS )
6102 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006103 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01006104 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01006105 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01006106 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006107 psa_key_derivation_abort( operation );
Steven Cooremanfa5e6312020-10-15 17:07:12 +02006108 else
6109 {
6110 /* If a private key has been added as SECRET, we allow the derived
6111 * key material to be used as a key in PSA Crypto. */
6112 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
6113 operation->can_output_key = 1;
6114 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02006115
6116 decrement_status = psa_decrement_key_slot_access_count( slot );
6117
6118 return( ( status == PSA_SUCCESS ) ? decrement_status : status );
Gilles Peskineaf3baab2018-06-27 22:55:52 +02006119}
6120
Gilles Peskinebe697d82019-05-16 18:00:41 +02006121psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
Ronald Croncf56a0a2020-08-04 09:51:30 +02006122 mbedtls_svc_key_id_t private_key,
Gilles Peskinebe697d82019-05-16 18:00:41 +02006123 const uint8_t *peer_key,
6124 size_t peer_key_length,
6125 uint8_t *output,
6126 size_t output_size,
6127 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02006128{
Ronald Cronf95a2b12020-10-22 15:24:49 +02006129 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
6130 psa_status_t decrement_status = PSA_ERROR_CORRUPTION_DETECTED;
6131 psa_key_slot_t *slot = NULL;
Gilles Peskine0216fe12019-04-11 21:23:21 +02006132
6133 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
6134 {
6135 status = PSA_ERROR_INVALID_ARGUMENT;
6136 goto exit;
6137 }
Gilles Peskine28f8f302019-07-24 13:30:31 +02006138 status = psa_get_transparent_key( private_key, &slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02006139 PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02006140 if( status != PSA_SUCCESS )
6141 goto exit;
6142
6143 status = psa_key_agreement_raw_internal( alg, slot,
6144 peer_key, peer_key_length,
6145 output, output_size,
6146 output_length );
6147
6148exit:
6149 if( status != PSA_SUCCESS )
6150 {
6151 /* If an error happens and is not handled properly, the output
6152 * may be used as a key to protect sensitive data. Arrange for such
6153 * a key to be random, which is likely to result in decryption or
6154 * verification errors. This is better than filling the buffer with
6155 * some constant data such as zeros, which would result in the data
6156 * being protected with a reproducible, easily knowable key.
6157 */
6158 psa_generate_random( output, output_size );
6159 *output_length = output_size;
6160 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02006161
6162 decrement_status = psa_decrement_key_slot_access_count( slot );
6163
6164 return( ( status == PSA_SUCCESS ) ? decrement_status : status );
Gilles Peskine0216fe12019-04-11 21:23:21 +02006165}
Gilles Peskine86a440b2018-11-12 18:39:40 +01006166
6167
6168/****************************************************************/
6169/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02006170/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02006171
Gilles Peskine4c317f42018-07-12 01:24:09 +02006172psa_status_t psa_generate_random( uint8_t *output,
Gilles Peskine53d991e2018-07-12 01:14:59 +02006173 size_t output_size )
Gilles Peskine12313cd2018-06-20 00:20:32 +02006174{
Janos Follath24eed8d2019-11-22 13:21:35 +00006175 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006176 GUARD_MODULE_INITIALIZED;
6177
Gilles Peskinef181eca2019-08-07 13:49:00 +02006178 while( output_size > MBEDTLS_CTR_DRBG_MAX_REQUEST )
6179 {
6180 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg,
6181 output,
6182 MBEDTLS_CTR_DRBG_MAX_REQUEST );
6183 if( ret != 0 )
6184 return( mbedtls_to_psa_error( ret ) );
6185 output += MBEDTLS_CTR_DRBG_MAX_REQUEST;
6186 output_size -= MBEDTLS_CTR_DRBG_MAX_REQUEST;
6187 }
6188
Gilles Peskinee59236f2018-01-27 23:32:46 +01006189 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg, output, output_size );
6190 return( mbedtls_to_psa_error( ret ) );
6191}
6192
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01006193#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
6194#include "mbedtls/entropy_poll.h"
6195
Gilles Peskine7228da22019-07-15 11:06:15 +02006196psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006197 size_t seed_size )
6198{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006199 if( global_data.initialized )
6200 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02006201
6202 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
6203 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
6204 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
6205 return( PSA_ERROR_INVALID_ARGUMENT );
6206
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01006207 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006208}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01006209#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006210
Gilles Peskinee56e8782019-04-26 17:34:02 +02006211#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_GENPRIME)
6212static psa_status_t psa_read_rsa_exponent( const uint8_t *domain_parameters,
6213 size_t domain_parameters_size,
6214 int *exponent )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006215{
Gilles Peskinee56e8782019-04-26 17:34:02 +02006216 size_t i;
6217 uint32_t acc = 0;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006218
Gilles Peskinee56e8782019-04-26 17:34:02 +02006219 if( domain_parameters_size == 0 )
6220 {
6221 *exponent = 65537;
6222 return( PSA_SUCCESS );
6223 }
6224
6225 /* Mbed TLS encodes the public exponent as an int. For simplicity, only
6226 * support values that fit in a 32-bit integer, which is larger than
6227 * int on just about every platform anyway. */
6228 if( domain_parameters_size > sizeof( acc ) )
6229 return( PSA_ERROR_NOT_SUPPORTED );
6230 for( i = 0; i < domain_parameters_size; i++ )
6231 acc = ( acc << 8 ) | domain_parameters[i];
6232 if( acc > INT_MAX )
6233 return( PSA_ERROR_NOT_SUPPORTED );
6234 *exponent = acc;
6235 return( PSA_SUCCESS );
6236}
6237#endif /* MBEDTLS_RSA_C && MBEDTLS_GENPRIME */
6238
Gilles Peskine35ef36b2019-05-16 19:42:05 +02006239static psa_status_t psa_generate_key_internal(
Gilles Peskinee56e8782019-04-26 17:34:02 +02006240 psa_key_slot_t *slot, size_t bits,
6241 const uint8_t *domain_parameters, size_t domain_parameters_size )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006242{
Gilles Peskine8e338702019-07-30 20:06:31 +02006243 psa_key_type_t type = slot->attr.type;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006244
Gilles Peskinee56e8782019-04-26 17:34:02 +02006245 if( domain_parameters == NULL && domain_parameters_size != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006246 return( PSA_ERROR_INVALID_ARGUMENT );
6247
Gilles Peskinee59236f2018-01-27 23:32:46 +01006248 if( key_type_is_raw_bytes( type ) )
6249 {
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006250 psa_status_t status;
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006251
6252 status = validate_unstructured_key_bit_size( slot->attr.type, bits );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006253 if( status != PSA_SUCCESS )
6254 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006255
6256 /* Allocate memory for the key */
Steven Cooreman75b74362020-07-28 14:30:13 +02006257 status = psa_allocate_buffer_to_slot( slot, PSA_BITS_TO_BYTES( bits ) );
6258 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02006259 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006260
Steven Cooreman71fd80d2020-07-07 21:12:27 +02006261 status = psa_generate_random( slot->data.key.data,
6262 slot->data.key.bytes );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006263 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006264 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006265
6266 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006267#if defined(MBEDTLS_DES_C)
6268 if( type == PSA_KEY_TYPE_DES )
Steven Cooreman71fd80d2020-07-07 21:12:27 +02006269 psa_des_set_key_parity( slot->data.key.data,
6270 slot->data.key.bytes );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006271#endif /* MBEDTLS_DES_C */
6272 }
6273 else
6274
6275#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_GENPRIME)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02006276 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006277 {
Steven Cooremana01795d2020-07-24 22:48:15 +02006278 mbedtls_rsa_context rsa;
Janos Follath24eed8d2019-11-22 13:21:35 +00006279 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee56e8782019-04-26 17:34:02 +02006280 int exponent;
6281 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006282 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
6283 return( PSA_ERROR_NOT_SUPPORTED );
6284 /* Accept only byte-aligned keys, for the same reasons as
6285 * in psa_import_rsa_key(). */
6286 if( bits % 8 != 0 )
6287 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinee56e8782019-04-26 17:34:02 +02006288 status = psa_read_rsa_exponent( domain_parameters,
6289 domain_parameters_size,
6290 &exponent );
6291 if( status != PSA_SUCCESS )
6292 return( status );
Steven Cooremana01795d2020-07-24 22:48:15 +02006293 mbedtls_rsa_init( &rsa, MBEDTLS_RSA_PKCS_V15, MBEDTLS_MD_NONE );
6294 ret = mbedtls_rsa_gen_key( &rsa,
Gilles Peskinee59236f2018-01-27 23:32:46 +01006295 mbedtls_ctr_drbg_random,
6296 &global_data.ctr_drbg,
6297 (unsigned int) bits,
6298 exponent );
6299 if( ret != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006300 return( mbedtls_to_psa_error( ret ) );
Steven Cooremana01795d2020-07-24 22:48:15 +02006301
6302 /* Make sure to always have an export representation available */
6303 size_t bytes = PSA_KEY_EXPORT_RSA_KEY_PAIR_MAX_SIZE( bits );
6304
Steven Cooreman75b74362020-07-28 14:30:13 +02006305 status = psa_allocate_buffer_to_slot( slot, bytes );
6306 if( status != PSA_SUCCESS )
Steven Cooremana01795d2020-07-24 22:48:15 +02006307 {
6308 mbedtls_rsa_free( &rsa );
Steven Cooreman29149862020-08-05 15:43:42 +02006309 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006310 }
Steven Cooremana01795d2020-07-24 22:48:15 +02006311
6312 status = psa_export_rsa_key( type,
6313 &rsa,
6314 slot->data.key.data,
6315 bytes,
6316 &slot->data.key.bytes );
6317 mbedtls_rsa_free( &rsa );
6318 if( status != PSA_SUCCESS )
Steven Cooremana01795d2020-07-24 22:48:15 +02006319 psa_remove_key_data_from_memory( slot );
Steven Cooreman560c28a2020-07-24 23:20:24 +02006320 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006321 }
6322 else
6323#endif /* MBEDTLS_RSA_C && MBEDTLS_GENPRIME */
6324
6325#if defined(MBEDTLS_ECP_C)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02006326 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006327 {
Paul Elliott8ff510a2020-06-02 17:19:28 +01006328 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY( type );
Gilles Peskine4295e8b2019-12-02 21:39:10 +01006329 mbedtls_ecp_group_id grp_id =
6330 mbedtls_ecc_group_of_psa( curve, PSA_BITS_TO_BYTES( bits ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006331 const mbedtls_ecp_curve_info *curve_info =
6332 mbedtls_ecp_curve_info_from_grp_id( grp_id );
Steven Cooremanacda8342020-07-24 23:09:52 +02006333 mbedtls_ecp_keypair ecp;
Janos Follath24eed8d2019-11-22 13:21:35 +00006334 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee56e8782019-04-26 17:34:02 +02006335 if( domain_parameters_size != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006336 return( PSA_ERROR_NOT_SUPPORTED );
6337 if( grp_id == MBEDTLS_ECP_DP_NONE || curve_info == NULL )
6338 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooremanacda8342020-07-24 23:09:52 +02006339 mbedtls_ecp_keypair_init( &ecp );
6340 ret = mbedtls_ecp_gen_key( grp_id, &ecp,
Gilles Peskinee59236f2018-01-27 23:32:46 +01006341 mbedtls_ctr_drbg_random,
6342 &global_data.ctr_drbg );
6343 if( ret != 0 )
6344 {
Steven Cooremanacda8342020-07-24 23:09:52 +02006345 mbedtls_ecp_keypair_free( &ecp );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006346 return( mbedtls_to_psa_error( ret ) );
6347 }
Steven Cooremanacda8342020-07-24 23:09:52 +02006348
6349
6350 /* Make sure to always have an export representation available */
6351 size_t bytes = PSA_BITS_TO_BYTES( bits );
Steven Cooreman75b74362020-07-28 14:30:13 +02006352 psa_status_t status = psa_allocate_buffer_to_slot( slot, bytes );
6353 if( status != PSA_SUCCESS )
Steven Cooremanacda8342020-07-24 23:09:52 +02006354 {
6355 mbedtls_ecp_keypair_free( &ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02006356 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02006357 }
Steven Cooreman75b74362020-07-28 14:30:13 +02006358
6359 status = mbedtls_to_psa_error(
Steven Cooremanacda8342020-07-24 23:09:52 +02006360 mbedtls_ecp_write_key( &ecp, slot->data.key.data, bytes ) );
6361
6362 mbedtls_ecp_keypair_free( &ecp );
Steven Cooremanb7f6dea2020-08-05 16:07:20 +02006363 if( status != PSA_SUCCESS ) {
6364 memset( slot->data.key.data, 0, bytes );
Steven Cooremanacda8342020-07-24 23:09:52 +02006365 psa_remove_key_data_from_memory( slot );
Steven Cooremanb7f6dea2020-08-05 16:07:20 +02006366 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02006367 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006368 }
6369 else
6370#endif /* MBEDTLS_ECP_C */
Steven Cooreman29149862020-08-05 15:43:42 +02006371 {
Gilles Peskinee59236f2018-01-27 23:32:46 +01006372 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman29149862020-08-05 15:43:42 +02006373 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01006374
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006375 return( PSA_SUCCESS );
6376}
Darryl Green0c6575a2018-11-07 16:05:30 +00006377
Gilles Peskine35ef36b2019-05-16 19:42:05 +02006378psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02006379 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006380{
6381 psa_status_t status;
6382 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02006383 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine11792082019-08-06 18:36:36 +02006384
Gilles Peskine0f84d622019-09-12 19:03:13 +02006385 /* Reject any attempt to create a zero-length key so that we don't
6386 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
6387 if( psa_get_key_bits( attributes ) == 0 )
6388 return( PSA_ERROR_INVALID_ARGUMENT );
6389
Gilles Peskinedf179142019-07-15 22:02:14 +02006390 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE,
Ronald Croncf56a0a2020-08-04 09:51:30 +02006391 attributes, key, &slot, &driver );
Gilles Peskine11792082019-08-06 18:36:36 +02006392 if( status != PSA_SUCCESS )
6393 goto exit;
6394
Steven Cooreman2a1664c2020-07-20 15:33:08 +02006395 status = psa_driver_wrapper_generate_key( attributes,
6396 slot );
6397 if( status != PSA_ERROR_NOT_SUPPORTED ||
6398 psa_key_lifetime_is_external( attributes->core.lifetime ) )
6399 goto exit;
6400
6401 status = psa_generate_key_internal(
6402 slot, attributes->core.bits,
6403 attributes->domain_parameters, attributes->domain_parameters_size );
Gilles Peskine11792082019-08-06 18:36:36 +02006404
6405exit:
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006406 if( status == PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02006407 status = psa_finish_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006408 if( status != PSA_SUCCESS )
6409 {
Gilles Peskine011e4282019-06-26 18:34:38 +02006410 psa_fail_key_creation( slot, driver );
Ronald Croncf56a0a2020-08-04 09:51:30 +02006411 *key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006412 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02006413 else
6414 status = psa_decrement_key_slot_access_count( slot );
6415
Darryl Green0c6575a2018-11-07 16:05:30 +00006416 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006417}
6418
6419
Gilles Peskinee59236f2018-01-27 23:32:46 +01006420
6421/****************************************************************/
6422/* Module setup */
6423/****************************************************************/
6424
Gilles Peskine5e769522018-11-20 21:59:56 +01006425psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
6426 void (* entropy_init )( mbedtls_entropy_context *ctx ),
6427 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
6428{
6429 if( global_data.rng_state != RNG_NOT_INITIALIZED )
6430 return( PSA_ERROR_BAD_STATE );
6431 global_data.entropy_init = entropy_init;
6432 global_data.entropy_free = entropy_free;
6433 return( PSA_SUCCESS );
6434}
6435
Gilles Peskinee59236f2018-01-27 23:32:46 +01006436void mbedtls_psa_crypto_free( void )
6437{
Gilles Peskine66fb1262018-12-10 16:29:04 +01006438 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006439 if( global_data.rng_state != RNG_NOT_INITIALIZED )
6440 {
6441 mbedtls_ctr_drbg_free( &global_data.ctr_drbg );
Gilles Peskine5e769522018-11-20 21:59:56 +01006442 global_data.entropy_free( &global_data.entropy );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006443 }
6444 /* Wipe all remaining data, including configuration.
6445 * In particular, this sets all state indicator to the value
6446 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01006447 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Gilles Peskinea8ade162019-06-26 11:24:49 +02006448#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +02006449 /* Unregister all secure element drivers, so that we restart from
6450 * a pristine state. */
6451 psa_unregister_all_se_drivers( );
Gilles Peskinea8ade162019-06-26 11:24:49 +02006452#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006453}
6454
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006455#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
6456/** Recover a transaction that was interrupted by a power failure.
6457 *
6458 * This function is called during initialization, before psa_crypto_init()
6459 * returns. If this function returns a failure status, the initialization
6460 * fails.
6461 */
6462static psa_status_t psa_crypto_recover_transaction(
6463 const psa_crypto_transaction_t *transaction )
6464{
6465 switch( transaction->unknown.type )
6466 {
6467 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
6468 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01006469 /* TODO - fall through to the failure case until this
Gilles Peskinec9d7f942019-08-13 16:17:16 +02006470 * is implemented.
6471 * https://github.com/ARMmbed/mbed-crypto/issues/218
6472 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006473 default:
6474 /* We found an unsupported transaction in the storage.
6475 * We don't know what state the storage is in. Give up. */
6476 return( PSA_ERROR_STORAGE_FAILURE );
6477 }
6478}
6479#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
6480
Gilles Peskinee59236f2018-01-27 23:32:46 +01006481psa_status_t psa_crypto_init( void )
6482{
Gilles Peskine66fb1262018-12-10 16:29:04 +01006483 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006484 const unsigned char drbg_seed[] = "PSA";
6485
Gilles Peskinec6b69072018-11-20 21:42:52 +01006486 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006487 if( global_data.initialized != 0 )
6488 return( PSA_SUCCESS );
6489
Gilles Peskine5e769522018-11-20 21:59:56 +01006490 /* Set default configuration if
6491 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
6492 if( global_data.entropy_init == NULL )
6493 global_data.entropy_init = mbedtls_entropy_init;
6494 if( global_data.entropy_free == NULL )
6495 global_data.entropy_free = mbedtls_entropy_free;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006496
Gilles Peskinec6b69072018-11-20 21:42:52 +01006497 /* Initialize the random generator. */
Gilles Peskine5e769522018-11-20 21:59:56 +01006498 global_data.entropy_init( &global_data.entropy );
Jaeden Amero76541612019-06-04 17:14:43 +01006499#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
6500 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
6501 /* The PSA entropy injection feature depends on using NV seed as an entropy
6502 * source. Add NV seed as an entropy source for PSA entropy injection. */
6503 mbedtls_entropy_add_source( &global_data.entropy,
6504 mbedtls_nv_seed_poll, NULL,
6505 MBEDTLS_ENTROPY_BLOCK_SIZE,
6506 MBEDTLS_ENTROPY_SOURCE_STRONG );
6507#endif
Gilles Peskinee59236f2018-01-27 23:32:46 +01006508 mbedtls_ctr_drbg_init( &global_data.ctr_drbg );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006509 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine66fb1262018-12-10 16:29:04 +01006510 status = mbedtls_to_psa_error(
6511 mbedtls_ctr_drbg_seed( &global_data.ctr_drbg,
6512 mbedtls_entropy_func,
6513 &global_data.entropy,
6514 drbg_seed, sizeof( drbg_seed ) - 1 ) );
6515 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006516 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01006517 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006518
Gilles Peskine66fb1262018-12-10 16:29:04 +01006519 status = psa_initialize_key_slots( );
6520 if( status != PSA_SUCCESS )
6521 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01006522
Gilles Peskined9348f22019-10-01 15:22:29 +02006523#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
6524 status = psa_init_all_se_drivers( );
6525 if( status != PSA_SUCCESS )
6526 goto exit;
6527#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
6528
Gilles Peskine4b734222019-07-24 15:56:31 +02006529#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02006530 status = psa_crypto_load_transaction( );
6531 if( status == PSA_SUCCESS )
6532 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006533 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
6534 if( status != PSA_SUCCESS )
6535 goto exit;
6536 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02006537 }
6538 else if( status == PSA_ERROR_DOES_NOT_EXIST )
6539 {
6540 /* There's no transaction to complete. It's all good. */
6541 status = PSA_SUCCESS;
6542 }
Gilles Peskine4b734222019-07-24 15:56:31 +02006543#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02006544
Gilles Peskinec6b69072018-11-20 21:42:52 +01006545 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006546 global_data.initialized = 1;
6547
6548exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01006549 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006550 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01006551 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006552}
6553
6554#endif /* MBEDTLS_PSA_CRYPTO_C */