blob: f8a8c0ab7b27aeebc46e1b42391056cadb9b5e65 [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
1192 * operations with this algorithm. */
Gilles Peskinec5487a82018-12-03 18:08:14 +01001193static psa_status_t psa_get_key_from_slot( psa_key_handle_t handle,
Gilles Peskine2f060a82018-12-04 17:12:32 +01001194 psa_key_slot_t **p_slot,
Darryl Green06fd18d2018-07-16 11:21:11 +01001195 psa_key_usage_t usage,
1196 psa_algorithm_t alg )
1197{
1198 psa_status_t status;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001199 psa_key_slot_t *slot = NULL;
Darryl Green06fd18d2018-07-16 11:21:11 +01001200
1201 *p_slot = NULL;
1202
Gilles Peskinec5487a82018-12-03 18:08:14 +01001203 status = psa_get_key_slot( handle, &slot );
Darryl Green06fd18d2018-07-16 11:21:11 +01001204 if( status != PSA_SUCCESS )
1205 return( status );
Darryl Green06fd18d2018-07-16 11:21:11 +01001206
1207 /* Enforce that usage policy for the key slot contains all the flags
1208 * required by the usage parameter. There is one exception: public
1209 * keys can always be exported, so we treat public key objects as
1210 * if they had the export flag. */
Gilles Peskine8e338702019-07-30 20:06:31 +02001211 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Darryl Green06fd18d2018-07-16 11:21:11 +01001212 usage &= ~PSA_KEY_USAGE_EXPORT;
Gilles Peskine8e338702019-07-30 20:06:31 +02001213 if( ( slot->attr.policy.usage & usage ) != usage )
Darryl Green06fd18d2018-07-16 11:21:11 +01001214 return( PSA_ERROR_NOT_PERMITTED );
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001215
1216 /* Enforce that the usage policy permits the requested algortihm. */
Gilles Peskine8e338702019-07-30 20:06:31 +02001217 if( alg != 0 && ! psa_key_policy_permits( &slot->attr.policy, alg ) )
Darryl Green06fd18d2018-07-16 11:21:11 +01001218 return( PSA_ERROR_NOT_PERMITTED );
1219
1220 *p_slot = slot;
1221 return( PSA_SUCCESS );
1222}
Darryl Green940d72c2018-07-13 13:18:51 +01001223
Gilles Peskine28f8f302019-07-24 13:30:31 +02001224/** Retrieve a slot which must contain a transparent key.
1225 *
1226 * A transparent key is a key for which the key material is directly
1227 * available, as opposed to a key in a secure element.
1228 *
Gilles Peskine60450a42019-07-25 11:32:45 +02001229 * This is a temporary function to use instead of psa_get_key_from_slot()
1230 * until secure element support is fully implemented.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001231 */
1232#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1233static psa_status_t psa_get_transparent_key( psa_key_handle_t handle,
1234 psa_key_slot_t **p_slot,
1235 psa_key_usage_t usage,
1236 psa_algorithm_t alg )
1237{
1238 psa_status_t status = psa_get_key_from_slot( handle, p_slot, usage, alg );
1239 if( status != PSA_SUCCESS )
1240 return( status );
Gilles Peskineadad8132019-07-25 11:31:23 +02001241 if( psa_key_slot_is_external( *p_slot ) )
Gilles Peskine28f8f302019-07-24 13:30:31 +02001242 {
1243 *p_slot = NULL;
1244 return( PSA_ERROR_NOT_SUPPORTED );
1245 }
1246 return( PSA_SUCCESS );
1247}
1248#else /* MBEDTLS_PSA_CRYPTO_SE_C */
1249/* With no secure element support, all keys are transparent. */
1250#define psa_get_transparent_key( handle, p_slot, usage, alg ) \
1251 psa_get_key_from_slot( handle, p_slot, usage, alg )
1252#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1253
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001254/** Wipe key data from a slot. Preserve metadata such as the policy. */
Gilles Peskine2f060a82018-12-04 17:12:32 +01001255static psa_status_t psa_remove_key_data_from_memory( psa_key_slot_t *slot )
Darryl Green40225ba2018-11-15 14:48:15 +00001256{
Gilles Peskine73167e12019-07-12 23:44:37 +02001257#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1258 if( psa_key_slot_is_external( slot ) )
Darryl Green40225ba2018-11-15 14:48:15 +00001259 {
1260 /* No key material to clean. */
1261 }
Gilles Peskine73167e12019-07-12 23:44:37 +02001262 else
1263#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Darryl Green40225ba2018-11-15 14:48:15 +00001264 {
Steven Cooremanfd4d69a2020-08-05 15:46:33 +02001265 /* Data pointer will always be either a valid pointer or NULL in an
1266 * initialized slot, so we can just free it. */
1267 if( slot->data.key.data != NULL )
1268 mbedtls_platform_zeroize( slot->data.key.data, slot->data.key.bytes);
Steven Cooremana01795d2020-07-24 22:48:15 +02001269 mbedtls_free( slot->data.key.data );
1270 slot->data.key.data = NULL;
1271 slot->data.key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +00001272 }
Darryl Green40225ba2018-11-15 14:48:15 +00001273
1274 return( PSA_SUCCESS );
1275}
1276
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001277/** Completely wipe a slot in memory, including its policy.
1278 * Persistent storage is not affected. */
Gilles Peskine66fb1262018-12-10 16:29:04 +01001279psa_status_t psa_wipe_key_slot( psa_key_slot_t *slot )
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001280{
1281 psa_status_t status = psa_remove_key_data_from_memory( slot );
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001282 /* Multipart operations may still be using the key. This is safe
1283 * because all multipart operation objects are independent from
1284 * the key slot: if they need to access the key after the setup
1285 * phase, they have a copy of the key. Note that this means that
1286 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001287 /* At this point, key material and other type-specific content has
1288 * been wiped. Clear remaining metadata. We can call memset and not
1289 * zeroize because the metadata is not particularly sensitive. */
1290 memset( slot, 0, sizeof( *slot ) );
1291 return( status );
1292}
1293
Gilles Peskinec5487a82018-12-03 18:08:14 +01001294psa_status_t psa_destroy_key( psa_key_handle_t handle )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001295{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001296 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001297 psa_status_t status; /* status of the last operation */
1298 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001299#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1300 psa_se_drv_table_entry_t *driver;
1301#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001302
Ronald Cronc26f8d42020-09-01 10:51:51 +02001303 if( psa_key_handle_is_null( handle ) )
Gilles Peskine1841cf42019-10-08 15:48:25 +02001304 return( PSA_SUCCESS );
1305
Gilles Peskinec5487a82018-12-03 18:08:14 +01001306 status = psa_get_key_slot( handle, &slot );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001307 if( status != PSA_SUCCESS )
1308 return( status );
Gilles Peskine354f7672019-07-12 23:46:38 +02001309
1310#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001311 driver = psa_get_se_driver_entry( slot->attr.lifetime );
Gilles Peskine354f7672019-07-12 23:46:38 +02001312 if( driver != NULL )
Gilles Peskinefc762652019-07-22 19:30:34 +02001313 {
Gilles Peskine60450a42019-07-25 11:32:45 +02001314 /* For a key in a secure element, we need to do three things:
1315 * remove the key file in internal storage, destroy the
1316 * key inside the secure element, and update the driver's
1317 * persistent data. Start a transaction that will encompass these
1318 * three actions. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001319 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_DESTROY_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +02001320 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Gilles Peskinefc762652019-07-22 19:30:34 +02001321 psa_crypto_transaction.key.slot = slot->data.se.slot_number;
Gilles Peskine8e338702019-07-30 20:06:31 +02001322 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskinefc762652019-07-22 19:30:34 +02001323 status = psa_crypto_save_transaction( );
1324 if( status != PSA_SUCCESS )
1325 {
Gilles Peskine66be51c2019-07-25 18:02:52 +02001326 (void) psa_crypto_stop_transaction( );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001327 /* We should still try to destroy the key in the secure
1328 * element and the key metadata in storage. This is especially
1329 * important if the error is that the storage is full.
1330 * But how to do it exactly without risking an inconsistent
1331 * state after a reset?
1332 * https://github.com/ARMmbed/mbed-crypto/issues/215
1333 */
1334 overall_status = status;
1335 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001336 }
1337
Gilles Peskine354f7672019-07-12 23:46:38 +02001338 status = psa_destroy_se_key( driver, slot->data.se.slot_number );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001339 if( overall_status == PSA_SUCCESS )
1340 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001341 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001342#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1343
Darryl Greend49a4992018-06-18 17:27:26 +01001344#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskinecaec2782019-08-13 15:11:49 +02001345 if( slot->attr.lifetime != PSA_KEY_LIFETIME_VOLATILE )
Darryl Greend49a4992018-06-18 17:27:26 +01001346 {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001347 status = psa_destroy_persistent_key( slot->attr.id );
1348 if( overall_status == PSA_SUCCESS )
1349 overall_status = status;
1350
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001351 /* TODO: other slots may have a copy of the same key. We should
1352 * invalidate them.
1353 * https://github.com/ARMmbed/mbed-crypto/issues/214
1354 */
Darryl Greend49a4992018-06-18 17:27:26 +01001355 }
1356#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001357
Gilles Peskinefc762652019-07-22 19:30:34 +02001358#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1359 if( driver != NULL )
1360 {
Gilles Peskine725f22a2019-07-25 11:31:48 +02001361 status = psa_save_se_persistent_data( driver );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001362 if( overall_status == PSA_SUCCESS )
1363 overall_status = status;
1364 status = psa_crypto_stop_transaction( );
1365 if( overall_status == PSA_SUCCESS )
1366 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001367 }
1368#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1369
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001370#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1371exit:
1372#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001373 status = psa_wipe_key_slot( slot );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001374 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
1375 if( overall_status == PSA_SUCCESS )
1376 overall_status = status;
1377 return( overall_status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001378}
1379
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001380void psa_reset_key_attributes( psa_key_attributes_t *attributes )
Gilles Peskineb870b182018-07-06 16:02:09 +02001381{
Gilles Peskineb699f072019-04-26 16:06:02 +02001382 mbedtls_free( attributes->domain_parameters );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001383 memset( attributes, 0, sizeof( *attributes ) );
Gilles Peskineb870b182018-07-06 16:02:09 +02001384}
1385
Gilles Peskineb699f072019-04-26 16:06:02 +02001386psa_status_t psa_set_key_domain_parameters( psa_key_attributes_t *attributes,
1387 psa_key_type_t type,
1388 const uint8_t *data,
1389 size_t data_length )
1390{
1391 uint8_t *copy = NULL;
1392
1393 if( data_length != 0 )
1394 {
1395 copy = mbedtls_calloc( 1, data_length );
1396 if( copy == NULL )
1397 return( PSA_ERROR_INSUFFICIENT_MEMORY );
1398 memcpy( copy, data, data_length );
1399 }
1400 /* After this point, this function is guaranteed to succeed, so it
1401 * can start modifying `*attributes`. */
1402
1403 if( attributes->domain_parameters != NULL )
1404 {
1405 mbedtls_free( attributes->domain_parameters );
1406 attributes->domain_parameters = NULL;
1407 attributes->domain_parameters_size = 0;
1408 }
1409
1410 attributes->domain_parameters = copy;
1411 attributes->domain_parameters_size = data_length;
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001412 attributes->core.type = type;
Gilles Peskineb699f072019-04-26 16:06:02 +02001413 return( PSA_SUCCESS );
1414}
1415
1416psa_status_t psa_get_key_domain_parameters(
1417 const psa_key_attributes_t *attributes,
1418 uint8_t *data, size_t data_size, size_t *data_length )
1419{
1420 if( attributes->domain_parameters_size > data_size )
1421 return( PSA_ERROR_BUFFER_TOO_SMALL );
1422 *data_length = attributes->domain_parameters_size;
1423 if( attributes->domain_parameters_size != 0 )
1424 memcpy( data, attributes->domain_parameters,
1425 attributes->domain_parameters_size );
1426 return( PSA_SUCCESS );
1427}
1428
1429#if defined(MBEDTLS_RSA_C)
1430static psa_status_t psa_get_rsa_public_exponent(
1431 const mbedtls_rsa_context *rsa,
1432 psa_key_attributes_t *attributes )
1433{
1434 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001435 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001436 uint8_t *buffer = NULL;
1437 size_t buflen;
1438 mbedtls_mpi_init( &mpi );
1439
1440 ret = mbedtls_rsa_export( rsa, NULL, NULL, NULL, NULL, &mpi );
1441 if( ret != 0 )
1442 goto exit;
Gilles Peskine772c8b12019-04-26 17:37:21 +02001443 if( mbedtls_mpi_cmp_int( &mpi, 65537 ) == 0 )
1444 {
1445 /* It's the default value, which is reported as an empty string,
1446 * so there's nothing to do. */
1447 goto exit;
1448 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001449
1450 buflen = mbedtls_mpi_size( &mpi );
1451 buffer = mbedtls_calloc( 1, buflen );
1452 if( buffer == NULL )
1453 {
1454 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1455 goto exit;
1456 }
1457 ret = mbedtls_mpi_write_binary( &mpi, buffer, buflen );
1458 if( ret != 0 )
1459 goto exit;
1460 attributes->domain_parameters = buffer;
1461 attributes->domain_parameters_size = buflen;
1462
1463exit:
1464 mbedtls_mpi_free( &mpi );
1465 if( ret != 0 )
1466 mbedtls_free( buffer );
1467 return( mbedtls_to_psa_error( ret ) );
1468}
1469#endif /* MBEDTLS_RSA_C */
1470
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001471/** Retrieve all the publicly-accessible attributes of a key.
1472 */
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001473psa_status_t psa_get_key_attributes( psa_key_handle_t handle,
1474 psa_key_attributes_t *attributes )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001475{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001476 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001477 psa_status_t status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001478
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001479 psa_reset_key_attributes( attributes );
1480
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001481 status = psa_get_key_from_slot( handle, &slot, 0, 0 );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001482 if( status != PSA_SUCCESS )
1483 return( status );
Gilles Peskineb870b182018-07-06 16:02:09 +02001484
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001485 attributes->core = slot->attr;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001486 attributes->core.flags &= ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1487 MBEDTLS_PSA_KA_MASK_DUAL_USE );
1488
1489#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1490 if( psa_key_slot_is_external( slot ) )
1491 psa_set_key_slot_number( attributes, slot->data.se.slot_number );
1492#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001493
Gilles Peskine8e338702019-07-30 20:06:31 +02001494 switch( slot->attr.type )
Gilles Peskineb699f072019-04-26 16:06:02 +02001495 {
1496#if defined(MBEDTLS_RSA_C)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001497 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001498 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001499#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001500 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001501 * is not yet implemented.
1502 * https://github.com/ARMmbed/mbed-crypto/issues/216
1503 */
Gilles Peskinec8000c02019-08-02 20:15:51 +02001504 if( psa_key_slot_is_external( slot ) )
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001505 break;
1506#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Steven Cooremana01795d2020-07-24 22:48:15 +02001507 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001508 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001509
Steven Cooreman4fed4552020-08-03 14:46:03 +02001510 status = psa_load_rsa_representation( slot->attr.type,
1511 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02001512 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02001513 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001514 if( status != PSA_SUCCESS )
1515 break;
1516
Steven Cooremana2371e52020-07-28 14:30:39 +02001517 status = psa_get_rsa_public_exponent( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02001518 attributes );
Steven Cooremana2371e52020-07-28 14:30:39 +02001519 mbedtls_rsa_free( rsa );
1520 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001521 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001522 break;
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001523#endif /* MBEDTLS_RSA_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001524 default:
1525 /* Nothing else to do. */
1526 break;
1527 }
1528
1529 if( status != PSA_SUCCESS )
1530 psa_reset_key_attributes( attributes );
1531 return( status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001532}
1533
Gilles Peskinec8000c02019-08-02 20:15:51 +02001534#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1535psa_status_t psa_get_key_slot_number(
1536 const psa_key_attributes_t *attributes,
1537 psa_key_slot_number_t *slot_number )
1538{
1539 if( attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER )
1540 {
1541 *slot_number = attributes->slot_number;
1542 return( PSA_SUCCESS );
1543 }
1544 else
1545 return( PSA_ERROR_INVALID_ARGUMENT );
1546}
1547#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1548
Steven Cooremana01795d2020-07-24 22:48:15 +02001549static psa_status_t psa_internal_export_key_buffer( const psa_key_slot_t *slot,
1550 uint8_t *data,
1551 size_t data_size,
1552 size_t *data_length )
1553{
1554 if( slot->data.key.bytes > data_size )
1555 return( PSA_ERROR_BUFFER_TOO_SMALL );
1556 memcpy( data, slot->data.key.data, slot->data.key.bytes );
1557 memset( data + slot->data.key.bytes, 0,
1558 data_size - slot->data.key.bytes );
1559 *data_length = slot->data.key.bytes;
1560 return( PSA_SUCCESS );
1561}
1562
Gilles Peskinef603c712019-01-19 13:40:11 +01001563static psa_status_t psa_internal_export_key( const psa_key_slot_t *slot,
1564 uint8_t *data,
1565 size_t data_size,
1566 size_t *data_length,
1567 int export_public_key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001568{
Gilles Peskine5d309672019-07-12 23:47:28 +02001569#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1570 const psa_drv_se_t *drv;
1571 psa_drv_se_context_t *drv_context;
1572#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1573
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001574 *data_length = 0;
1575
Gilles Peskine8e338702019-07-30 20:06:31 +02001576 if( export_public_key && ! PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
Moran Pekera998bc62018-04-16 18:16:20 +03001577 return( PSA_ERROR_INVALID_ARGUMENT );
mohammad160306e79202018-03-28 13:17:44 +03001578
Gilles Peskinef9168942019-09-12 19:20:29 +02001579 /* Reject a zero-length output buffer now, since this can never be a
1580 * valid key representation. This way we know that data must be a valid
1581 * pointer and we can do things like memset(data, ..., data_size). */
1582 if( data_size == 0 )
1583 return( PSA_ERROR_BUFFER_TOO_SMALL );
1584
Gilles Peskine5d309672019-07-12 23:47:28 +02001585#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001586 if( psa_get_se_driver( slot->attr.lifetime, &drv, &drv_context ) )
Gilles Peskine5d309672019-07-12 23:47:28 +02001587 {
1588 psa_drv_se_export_key_t method;
1589 if( drv->key_management == NULL )
1590 return( PSA_ERROR_NOT_SUPPORTED );
1591 method = ( export_public_key ?
1592 drv->key_management->p_export_public :
1593 drv->key_management->p_export );
1594 if( method == NULL )
1595 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine2e0f3882019-07-25 11:34:33 +02001596 return( method( drv_context,
1597 slot->data.se.slot_number,
1598 data, data_size, data_length ) );
Gilles Peskine5d309672019-07-12 23:47:28 +02001599 }
1600#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1601
Gilles Peskine8e338702019-07-30 20:06:31 +02001602 if( key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001603 {
Steven Cooremanacda8342020-07-24 23:09:52 +02001604 return( psa_internal_export_key_buffer( slot, data, data_size, data_length ) );
Gilles Peskine188c71e2018-10-29 19:26:02 +01001605 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001606 else if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) ||
1607 PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
Moran Peker17e36e12018-05-02 12:55:20 +03001608 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001609 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Gilles Peskine969ac722018-01-28 18:16:59 +01001610 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001611 /* Exporting public -> public */
1612 return( psa_internal_export_key_buffer( slot, data, data_size, data_length ) );
1613 }
1614 else if( !export_public_key )
1615 {
1616 /* Exporting private -> private */
1617 return( psa_internal_export_key_buffer( slot, data, data_size, data_length ) );
1618 }
1619 /* Need to export the public part of a private key,
1620 * so conversion is needed */
1621 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
1622 {
Darryl Green9e2d7a02018-07-24 16:33:30 +01001623#if defined(MBEDTLS_RSA_C)
Steven Cooremana2371e52020-07-28 14:30:39 +02001624 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman7f391872020-07-30 14:57:44 +02001625 psa_status_t status = psa_load_rsa_representation(
Steven Cooreman4fed4552020-08-03 14:46:03 +02001626 slot->attr.type,
Steven Cooreman7f391872020-07-30 14:57:44 +02001627 slot->data.key.data,
1628 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02001629 &rsa );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001630 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001631 return( status );
Steven Cooremana01795d2020-07-24 22:48:15 +02001632
Steven Cooreman560c28a2020-07-24 23:20:24 +02001633 status = psa_export_rsa_key( PSA_KEY_TYPE_RSA_PUBLIC_KEY,
Steven Cooremana2371e52020-07-28 14:30:39 +02001634 rsa,
Steven Cooreman560c28a2020-07-24 23:20:24 +02001635 data,
1636 data_size,
1637 data_length );
Steven Cooremana01795d2020-07-24 22:48:15 +02001638
Steven Cooremana2371e52020-07-28 14:30:39 +02001639 mbedtls_rsa_free( rsa );
1640 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001641
Steven Cooreman560c28a2020-07-24 23:20:24 +02001642 return( status );
Darryl Green9e2d7a02018-07-24 16:33:30 +01001643#else
Steven Cooreman560c28a2020-07-24 23:20:24 +02001644 /* We don't know how to convert a private RSA key to public. */
1645 return( PSA_ERROR_NOT_SUPPORTED );
Darryl Green9e2d7a02018-07-24 16:33:30 +01001646#endif
Gilles Peskine969ac722018-01-28 18:16:59 +01001647 }
1648 else
Moran Pekera998bc62018-04-16 18:16:20 +03001649 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001650#if defined(MBEDTLS_ECP_C)
Steven Cooremana2371e52020-07-28 14:30:39 +02001651 mbedtls_ecp_keypair *ecp = NULL;
Steven Cooreman7f391872020-07-30 14:57:44 +02001652 psa_status_t status = psa_load_ecp_representation(
Steven Cooreman4fed4552020-08-03 14:46:03 +02001653 slot->attr.type,
Steven Cooreman7f391872020-07-30 14:57:44 +02001654 slot->data.key.data,
1655 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02001656 &ecp );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001657 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001658 return( status );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001659
1660 status = psa_export_ecp_key( PSA_KEY_TYPE_ECC_PUBLIC_KEY(
1661 PSA_KEY_TYPE_ECC_GET_FAMILY(
1662 slot->attr.type ) ),
Steven Cooremana2371e52020-07-28 14:30:39 +02001663 ecp,
Steven Cooreman560c28a2020-07-24 23:20:24 +02001664 data,
1665 data_size,
1666 data_length );
1667
Steven Cooremana2371e52020-07-28 14:30:39 +02001668 mbedtls_ecp_keypair_free( ecp );
1669 mbedtls_free( ecp );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001670 return( status );
1671#else
1672 /* We don't know how to convert a private ECC key to public */
Moran Pekera998bc62018-04-16 18:16:20 +03001673 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001674#endif
Moran Pekera998bc62018-04-16 18:16:20 +03001675 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001676 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001677 else
1678 {
1679 /* This shouldn't happen in the reference implementation, but
1680 it is valid for a special-purpose implementation to omit
1681 support for exporting certain key types. */
1682 return( PSA_ERROR_NOT_SUPPORTED );
1683 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001684}
1685
Gilles Peskinec5487a82018-12-03 18:08:14 +01001686psa_status_t psa_export_key( psa_key_handle_t handle,
Gilles Peskine2d277862018-06-18 15:41:12 +02001687 uint8_t *data,
1688 size_t data_size,
1689 size_t *data_length )
Moran Pekera998bc62018-04-16 18:16:20 +03001690{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001691 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001692 psa_status_t status;
1693
1694 /* Set the key to empty now, so that even when there are errors, we always
1695 * set data_length to a value between 0 and data_size. On error, setting
1696 * the key to empty is a good choice because an empty key representation is
1697 * unlikely to be accepted anywhere. */
1698 *data_length = 0;
1699
1700 /* Export requires the EXPORT flag. There is an exception for public keys,
1701 * which don't require any flag, but psa_get_key_from_slot takes
1702 * care of this. */
Gilles Peskinec5487a82018-12-03 18:08:14 +01001703 status = psa_get_key_from_slot( handle, &slot, PSA_KEY_USAGE_EXPORT, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001704 if( status != PSA_SUCCESS )
1705 return( status );
1706 return( psa_internal_export_key( slot, data, data_size,
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02001707 data_length, 0 ) );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001708}
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001709
Gilles Peskinec5487a82018-12-03 18:08:14 +01001710psa_status_t psa_export_public_key( psa_key_handle_t handle,
Gilles Peskine2d277862018-06-18 15:41:12 +02001711 uint8_t *data,
1712 size_t data_size,
1713 size_t *data_length )
Moran Pekerdd4ea382018-04-03 15:30:03 +03001714{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001715 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001716 psa_status_t status;
1717
1718 /* Set the key to empty now, so that even when there are errors, we always
1719 * set data_length to a value between 0 and data_size. On error, setting
1720 * the key to empty is a good choice because an empty key representation is
1721 * unlikely to be accepted anywhere. */
1722 *data_length = 0;
1723
1724 /* Exporting a public key doesn't require a usage flag. */
Gilles Peskinec5487a82018-12-03 18:08:14 +01001725 status = psa_get_key_from_slot( handle, &slot, 0, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001726 if( status != PSA_SUCCESS )
1727 return( status );
1728 return( psa_internal_export_key( slot, data, data_size,
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02001729 data_length, 1 ) );
Moran Pekerdd4ea382018-04-03 15:30:03 +03001730}
1731
Gilles Peskine91e8c332019-08-02 19:19:39 +02001732#if defined(static_assert)
1733static_assert( ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
1734 "One or more key attribute flag is listed as both external-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001735static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
Gilles Peskine094dac12019-08-07 18:19:46 +02001736 "One or more key attribute flag is listed as both internal-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001737static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY ) == 0,
Gilles Peskine91e8c332019-08-02 19:19:39 +02001738 "One or more key attribute flag is listed as both internal-only and external-only" );
1739#endif
1740
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001741/** Validate that a key policy is internally well-formed.
1742 *
1743 * This function only rejects invalid policies. It does not validate the
1744 * consistency of the policy with respect to other attributes of the key
1745 * such as the key type.
1746 */
1747static psa_status_t psa_validate_key_policy( const psa_key_policy_t *policy )
Gilles Peskine4747d192019-04-17 15:05:45 +02001748{
1749 if( ( policy->usage & ~( PSA_KEY_USAGE_EXPORT |
Gilles Peskine8e0206a2019-05-14 14:24:28 +02001750 PSA_KEY_USAGE_COPY |
Gilles Peskine4747d192019-04-17 15:05:45 +02001751 PSA_KEY_USAGE_ENCRYPT |
1752 PSA_KEY_USAGE_DECRYPT |
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001753 PSA_KEY_USAGE_SIGN_HASH |
1754 PSA_KEY_USAGE_VERIFY_HASH |
Gilles Peskine4747d192019-04-17 15:05:45 +02001755 PSA_KEY_USAGE_DERIVE ) ) != 0 )
1756 return( PSA_ERROR_INVALID_ARGUMENT );
1757
Gilles Peskine4747d192019-04-17 15:05:45 +02001758 return( PSA_SUCCESS );
1759}
1760
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001761/** Validate the internal consistency of key attributes.
1762 *
1763 * This function only rejects invalid attribute values. If does not
1764 * validate the consistency of the attributes with any key data that may
1765 * be involved in the creation of the key.
1766 *
1767 * Call this function early in the key creation process.
1768 *
1769 * \param[in] attributes Key attributes for the new key.
1770 * \param[out] p_drv On any return, the driver for the key, if any.
1771 * NULL for a transparent key.
1772 *
1773 */
1774static psa_status_t psa_validate_key_attributes(
1775 const psa_key_attributes_t *attributes,
1776 psa_se_drv_table_entry_t **p_drv )
Darryl Green0c6575a2018-11-07 16:05:30 +00001777{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001778 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Ronald Crond2ed4812020-07-17 16:11:30 +02001779 psa_key_lifetime_t lifetime = psa_get_key_lifetime( attributes );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001780
Steven Cooreman8c1e7592020-06-17 14:52:05 +02001781 status = psa_validate_key_location( psa_get_key_lifetime( attributes ),
1782 p_drv );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001783 if( status != PSA_SUCCESS )
1784 return( status );
1785
Ronald Crond2ed4812020-07-17 16:11:30 +02001786 status = psa_validate_key_persistence( lifetime );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001787 if( status != PSA_SUCCESS )
1788 return( status );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001789
Ronald Crond2ed4812020-07-17 16:11:30 +02001790 /* Validate the key identifier only in the case of a persistent key. */
1791 if ( ! PSA_KEY_LIFETIME_IS_VOLATILE( lifetime ) )
1792 {
1793 status = psa_validate_key_id(
1794 psa_get_key_id( attributes ),
1795 psa_key_lifetime_is_external( lifetime ) );
1796
1797 if( status != PSA_SUCCESS )
1798 return( status );
1799 }
1800
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001801 status = psa_validate_key_policy( &attributes->core.policy );
Darryl Green0c6575a2018-11-07 16:05:30 +00001802 if( status != PSA_SUCCESS )
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001803 return( status );
1804
1805 /* Refuse to create overly large keys.
1806 * Note that this doesn't trigger on import if the attributes don't
1807 * explicitly specify a size (so psa_get_key_bits returns 0), so
1808 * psa_import_key() needs its own checks. */
1809 if( psa_get_key_bits( attributes ) > PSA_MAX_KEY_BITS )
1810 return( PSA_ERROR_NOT_SUPPORTED );
1811
Gilles Peskine91e8c332019-08-02 19:19:39 +02001812 /* Reject invalid flags. These should not be reachable through the API. */
1813 if( attributes->core.flags & ~ ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1814 MBEDTLS_PSA_KA_MASK_DUAL_USE ) )
1815 return( PSA_ERROR_INVALID_ARGUMENT );
1816
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001817 return( PSA_SUCCESS );
1818}
1819
Gilles Peskine4747d192019-04-17 15:05:45 +02001820/** Prepare a key slot to receive key material.
1821 *
1822 * This function allocates a key slot and sets its metadata.
1823 *
1824 * If this function fails, call psa_fail_key_creation().
1825 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001826 * This function is intended to be used as follows:
1827 * -# Call psa_start_key_creation() to allocate a key slot, prepare
1828 * it with the specified attributes, and assign it a handle.
1829 * -# Populate the slot with the key material.
1830 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1831 * In case of failure at any step, stop the sequence and call
1832 * psa_fail_key_creation().
1833 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001834 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001835 * \param[in] attributes Key attributes for the new key.
1836 * \param[out] handle On success, a handle for the allocated slot.
1837 * \param[out] p_slot On success, a pointer to the prepared slot.
1838 * \param[out] p_drv On any return, the driver for the key, if any.
1839 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001840 *
1841 * \retval #PSA_SUCCESS
1842 * The key slot is ready to receive key material.
1843 * \return If this function fails, the key slot is an invalid state.
1844 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001845 */
1846static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001847 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001848 const psa_key_attributes_t *attributes,
1849 psa_key_handle_t *handle,
Gilles Peskine011e4282019-06-26 18:34:38 +02001850 psa_key_slot_t **p_slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001851 psa_se_drv_table_entry_t **p_drv )
Gilles Peskine4747d192019-04-17 15:05:45 +02001852{
1853 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001854 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001855 psa_key_slot_t *slot;
1856
Gilles Peskinedf179142019-07-15 22:02:14 +02001857 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001858 *p_drv = NULL;
1859
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001860 status = psa_validate_key_attributes( attributes, p_drv );
1861 if( status != PSA_SUCCESS )
1862 return( status );
1863
Ronald Cronc4d1b512020-07-31 11:26:37 +02001864 status = psa_get_empty_key_slot( &volatile_key_id, p_slot );
Gilles Peskine4747d192019-04-17 15:05:45 +02001865 if( status != PSA_SUCCESS )
1866 return( status );
1867 slot = *p_slot;
1868
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001869 /* We're storing the declared bit-size of the key. It's up to each
1870 * creation mechanism to verify that this information is correct.
1871 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001872 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001873 * is optional (import, copy). In case of a volatile key, assign it the
1874 * volatile key identifier associated to the slot returned to contain its
1875 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001876
1877 slot->attr = attributes->core;
Ronald Cronc4d1b512020-07-31 11:26:37 +02001878 if( PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
1879 {
1880#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1881 slot->attr.id = volatile_key_id;
1882#else
1883 slot->attr.id.key_id = volatile_key_id;
1884#endif
1885 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001886
Gilles Peskine91e8c332019-08-02 19:19:39 +02001887 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001888 * external-only flags, query `attributes`. Thanks to the check
1889 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001890 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001891 * may have set. */
1892 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001893
Gilles Peskinecbaff462019-07-12 23:46:04 +02001894#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001895 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001896 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001897 * create the key file in internal storage, create the
1898 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001899 * persistent data. This is done by starting a transaction that will
1900 * encompass these three actions.
1901 * For registering a volatile key, we just need to find an appropriate
1902 * slot number inside the SE. Since the key is designated volatile, creating
1903 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001904 /* The first thing to do is to find a slot number for the new key.
1905 * We save the slot number in persistent storage as part of the
1906 * transaction data. It will be needed to recover if the power
1907 * fails during the key creation process, to clean up on the secure
1908 * element side after restarting. Obtaining a slot number from the
1909 * secure element driver updates its persistent state, but we do not yet
1910 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001911 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001912 if( *p_drv != NULL )
Darryl Green0c6575a2018-11-07 16:05:30 +00001913 {
Gilles Peskinee88c2c12019-08-05 16:44:14 +02001914 status = psa_find_se_slot_for_key( attributes, method, *p_drv,
Gilles Peskinecbaff462019-07-12 23:46:04 +02001915 &slot->data.se.slot_number );
1916 if( status != PSA_SUCCESS )
1917 return( status );
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001918
1919 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( attributes->core.lifetime ) )
Gilles Peskine66be51c2019-07-25 18:02:52 +02001920 {
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001921 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_CREATE_KEY );
1922 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
1923 psa_crypto_transaction.key.slot = slot->data.se.slot_number;
1924 psa_crypto_transaction.key.id = slot->attr.id;
1925 status = psa_crypto_save_transaction( );
1926 if( status != PSA_SUCCESS )
1927 {
1928 (void) psa_crypto_stop_transaction( );
1929 return( status );
1930 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001931 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001932 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001933
1934 if( *p_drv == NULL && method == PSA_KEY_CREATION_REGISTER )
1935 {
1936 /* Key registration only makes sense with a secure element. */
1937 return( PSA_ERROR_INVALID_ARGUMENT );
1938 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001939#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1940
Ronald Cronc4d1b512020-07-31 11:26:37 +02001941 *handle = slot->attr.id;
1942
1943 return( PSA_SUCCESS );
Darryl Green0c6575a2018-11-07 16:05:30 +00001944}
Gilles Peskine4747d192019-04-17 15:05:45 +02001945
1946/** Finalize the creation of a key once its key material has been set.
1947 *
1948 * This entails writing the key to persistent storage.
1949 *
1950 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001951 * See the documentation of psa_start_key_creation() for the intended use
1952 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001953 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001954 * \param[in,out] slot Pointer to the slot with key material.
1955 * \param[in] driver The secure element driver for the key,
1956 * or NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001957 *
1958 * \retval #PSA_SUCCESS
1959 * The key was successfully created. The handle is now valid.
1960 * \return If this function fails, the key slot is an invalid state.
1961 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001962 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001963static psa_status_t psa_finish_key_creation(
1964 psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001965 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001966{
1967 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001968 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001969 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001970
1971#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Steven Cooremanc59de6a2020-06-08 18:28:25 +02001972 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Gilles Peskine4747d192019-04-17 15:05:45 +02001973 {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001974#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1975 if( driver != NULL )
1976 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001977 psa_se_key_data_storage_t data;
1978#if defined(static_assert)
1979 static_assert( sizeof( slot->data.se.slot_number ) ==
1980 sizeof( data.slot_number ),
1981 "Slot number size does not match psa_se_key_data_storage_t" );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001982#endif
1983 memcpy( &data.slot_number, &slot->data.se.slot_number,
1984 sizeof( slot->data.se.slot_number ) );
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001985 status = psa_save_persistent_key( &slot->attr,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001986 (uint8_t*) &data,
1987 sizeof( data ) );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001988 }
1989 else
1990#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1991 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001992 /* Key material is saved in export representation in the slot, so
1993 * just pass the slot buffer for storage. */
1994 status = psa_save_persistent_key( &slot->attr,
1995 slot->data.key.data,
1996 slot->data.key.bytes );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001997 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001998 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001999#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
2000
Gilles Peskinecbaff462019-07-12 23:46:04 +02002001#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02002002 /* Finish the transaction for a key creation. This does not
2003 * happen when registering an existing key. Detect this case
2004 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02002005 * creation of a persistent key in a secure element requires a transaction,
2006 * but registration or volatile key creation doesn't use one). */
Gilles Peskined7729582019-08-05 15:55:54 +02002007 if( driver != NULL &&
2008 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY )
Gilles Peskinecbaff462019-07-12 23:46:04 +02002009 {
2010 status = psa_save_se_persistent_data( driver );
2011 if( status != PSA_SUCCESS )
2012 {
Gilles Peskine8e338702019-07-30 20:06:31 +02002013 psa_destroy_persistent_key( slot->attr.id );
Gilles Peskinecbaff462019-07-12 23:46:04 +02002014 return( status );
2015 }
Gilles Peskinefc762652019-07-22 19:30:34 +02002016 status = psa_crypto_stop_transaction( );
2017 if( status != PSA_SUCCESS )
2018 return( status );
Gilles Peskinecbaff462019-07-12 23:46:04 +02002019 }
2020#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2021
Gilles Peskine4747d192019-04-17 15:05:45 +02002022 return( status );
2023}
2024
2025/** Abort the creation of a key.
2026 *
2027 * You may call this function after calling psa_start_key_creation(),
2028 * or after psa_finish_key_creation() fails. In other circumstances, this
2029 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02002030 * See the documentation of psa_start_key_creation() for the intended use
2031 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02002032 *
Gilles Peskine011e4282019-06-26 18:34:38 +02002033 * \param[in,out] slot Pointer to the slot with key material.
2034 * \param[in] driver The secure element driver for the key,
2035 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02002036 */
Gilles Peskine011e4282019-06-26 18:34:38 +02002037static void psa_fail_key_creation( psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002038 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02002039{
Gilles Peskine011e4282019-06-26 18:34:38 +02002040 (void) driver;
2041
Gilles Peskine4747d192019-04-17 15:05:45 +02002042 if( slot == NULL )
2043 return;
Gilles Peskine011e4282019-06-26 18:34:38 +02002044
2045#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01002046 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02002047 * element, and the failure happened later (when saving metadata
2048 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02002049 * element.
2050 * https://github.com/ARMmbed/mbed-crypto/issues/217
2051 */
Gilles Peskinefc762652019-07-22 19:30:34 +02002052
Gilles Peskined7729582019-08-05 15:55:54 +02002053 /* Abort the ongoing transaction if any (there may not be one if
2054 * the creation process failed before starting one, or if the
2055 * key creation is a registration of a key in a secure element).
2056 * Earlier functions must already have done what it takes to undo any
2057 * partial creation. All that's left is to update the transaction data
2058 * itself. */
Gilles Peskinefc762652019-07-22 19:30:34 +02002059 (void) psa_crypto_stop_transaction( );
Gilles Peskine011e4282019-06-26 18:34:38 +02002060#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2061
Gilles Peskine4747d192019-04-17 15:05:45 +02002062 psa_wipe_key_slot( slot );
2063}
2064
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002065/** Validate optional attributes during key creation.
2066 *
2067 * Some key attributes are optional during key creation. If they are
2068 * specified in the attributes structure, check that they are consistent
2069 * with the data in the slot.
2070 *
2071 * This function should be called near the end of key creation, after
2072 * the slot in memory is fully populated but before saving persistent data.
2073 */
2074static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002075 const psa_key_slot_t *slot,
2076 const psa_key_attributes_t *attributes )
2077{
Gilles Peskine7e0cff92019-07-30 13:48:52 +02002078 if( attributes->core.type != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002079 {
Gilles Peskine8e338702019-07-30 20:06:31 +02002080 if( attributes->core.type != slot->attr.type )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002081 return( PSA_ERROR_INVALID_ARGUMENT );
2082 }
2083
2084 if( attributes->domain_parameters_size != 0 )
2085 {
2086#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02002087 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002088 {
Steven Cooremana2371e52020-07-28 14:30:39 +02002089 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02002090 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02002091 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02002092
Steven Cooreman7f391872020-07-30 14:57:44 +02002093 psa_status_t status = psa_load_rsa_representation(
Steven Cooreman4fed4552020-08-03 14:46:03 +02002094 slot->attr.type,
Steven Cooreman7f391872020-07-30 14:57:44 +02002095 slot->data.key.data,
2096 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02002097 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02002098 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02002099 return( status );
Steven Cooreman75b74362020-07-28 14:30:13 +02002100
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002101 mbedtls_mpi_init( &actual );
2102 mbedtls_mpi_init( &required );
Steven Cooremana2371e52020-07-28 14:30:39 +02002103 ret = mbedtls_rsa_export( rsa,
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002104 NULL, NULL, NULL, NULL, &actual );
Steven Cooremana2371e52020-07-28 14:30:39 +02002105 mbedtls_rsa_free( rsa );
2106 mbedtls_free( rsa );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002107 if( ret != 0 )
2108 goto rsa_exit;
2109 ret = mbedtls_mpi_read_binary( &required,
2110 attributes->domain_parameters,
2111 attributes->domain_parameters_size );
2112 if( ret != 0 )
2113 goto rsa_exit;
2114 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
2115 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
2116 rsa_exit:
2117 mbedtls_mpi_free( &actual );
2118 mbedtls_mpi_free( &required );
2119 if( ret != 0)
2120 return( mbedtls_to_psa_error( ret ) );
2121 }
2122 else
2123#endif
2124 {
2125 return( PSA_ERROR_INVALID_ARGUMENT );
2126 }
2127 }
2128
Gilles Peskine7e0cff92019-07-30 13:48:52 +02002129 if( attributes->core.bits != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002130 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02002131 if( attributes->core.bits != slot->attr.bits )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002132 return( PSA_ERROR_INVALID_ARGUMENT );
2133 }
2134
2135 return( PSA_SUCCESS );
2136}
2137
Gilles Peskine4747d192019-04-17 15:05:45 +02002138psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02002139 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02002140 size_t data_length,
2141 psa_key_handle_t *handle )
Gilles Peskine4747d192019-04-17 15:05:45 +02002142{
2143 psa_status_t status;
2144 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002145 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002146
Gilles Peskine0f84d622019-09-12 19:03:13 +02002147 /* Reject zero-length symmetric keys (including raw data key objects).
2148 * This also rejects any key which might be encoded as an empty string,
2149 * which is never valid. */
2150 if( data_length == 0 )
2151 return( PSA_ERROR_INVALID_ARGUMENT );
2152
Gilles Peskinedf179142019-07-15 22:02:14 +02002153 status = psa_start_key_creation( PSA_KEY_CREATION_IMPORT, attributes,
2154 handle, &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002155 if( status != PSA_SUCCESS )
2156 goto exit;
2157
Gilles Peskine5d309672019-07-12 23:47:28 +02002158#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2159 if( driver != NULL )
2160 {
2161 const psa_drv_se_t *drv = psa_get_se_driver_methods( driver );
Darryl Green0892d0f2019-08-20 09:50:14 +01002162 /* The driver should set the number of key bits, however in
2163 * case it doesn't, we initialize bits to an invalid value. */
2164 size_t bits = PSA_MAX_KEY_BITS + 1;
Gilles Peskine5d309672019-07-12 23:47:28 +02002165 if( drv->key_management == NULL ||
2166 drv->key_management->p_import == NULL )
2167 {
2168 status = PSA_ERROR_NOT_SUPPORTED;
2169 goto exit;
2170 }
2171 status = drv->key_management->p_import(
2172 psa_get_se_driver_context( driver ),
Gilles Peskinef3801ff2019-08-06 17:32:04 +02002173 slot->data.se.slot_number, attributes, data, data_length,
Gilles Peskineb46bef22019-07-30 21:32:04 +02002174 &bits );
2175 if( status != PSA_SUCCESS )
2176 goto exit;
2177 if( bits > PSA_MAX_KEY_BITS )
2178 {
2179 status = PSA_ERROR_NOT_SUPPORTED;
2180 goto exit;
2181 }
2182 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskine5d309672019-07-12 23:47:28 +02002183 }
2184 else
2185#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2186 {
2187 status = psa_import_key_into_slot( slot, data, data_length );
2188 if( status != PSA_SUCCESS )
2189 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02002190 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002191 status = psa_validate_optional_attributes( slot, attributes );
Gilles Peskine18017402019-07-24 20:25:59 +02002192 if( status != PSA_SUCCESS )
2193 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002194
Gilles Peskine011e4282019-06-26 18:34:38 +02002195 status = psa_finish_key_creation( slot, driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002196exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02002197 if( status != PSA_SUCCESS )
2198 {
Gilles Peskine011e4282019-06-26 18:34:38 +02002199 psa_fail_key_creation( slot, driver );
Ronald Cron91e95152020-07-30 17:48:03 +02002200 *handle = PSA_KEY_HANDLE_INIT;
Gilles Peskine4747d192019-04-17 15:05:45 +02002201 }
2202 return( status );
2203}
2204
Gilles Peskined7729582019-08-05 15:55:54 +02002205#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2206psa_status_t mbedtls_psa_register_se_key(
2207 const psa_key_attributes_t *attributes )
2208{
2209 psa_status_t status;
2210 psa_key_slot_t *slot = NULL;
2211 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron91e95152020-07-30 17:48:03 +02002212 psa_key_handle_t handle = PSA_KEY_HANDLE_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02002213
2214 /* Leaving attributes unspecified is not currently supported.
2215 * It could make sense to query the key type and size from the
2216 * secure element, but not all secure elements support this
2217 * and the driver HAL doesn't currently support it. */
2218 if( psa_get_key_type( attributes ) == PSA_KEY_TYPE_NONE )
2219 return( PSA_ERROR_NOT_SUPPORTED );
2220 if( psa_get_key_bits( attributes ) == 0 )
2221 return( PSA_ERROR_NOT_SUPPORTED );
2222
2223 status = psa_start_key_creation( PSA_KEY_CREATION_REGISTER, attributes,
2224 &handle, &slot, &driver );
2225 if( status != PSA_SUCCESS )
2226 goto exit;
2227
Gilles Peskined7729582019-08-05 15:55:54 +02002228 status = psa_finish_key_creation( slot, driver );
2229
2230exit:
2231 if( status != PSA_SUCCESS )
2232 {
2233 psa_fail_key_creation( slot, driver );
2234 }
2235 /* Registration doesn't keep the key in RAM. */
2236 psa_close_key( handle );
2237 return( status );
2238}
2239#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2240
Gilles Peskinef603c712019-01-19 13:40:11 +01002241static psa_status_t psa_copy_key_material( const psa_key_slot_t *source,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002242 psa_key_slot_t *target )
Gilles Peskinef603c712019-01-19 13:40:11 +01002243{
Steven Cooremanf7cebd42020-10-13 20:27:40 +02002244 psa_status_t status = psa_copy_key_material_into_slot( target,
2245 source->data.key.data,
2246 source->data.key.bytes );
Gilles Peskinef603c712019-01-19 13:40:11 +01002247 if( status != PSA_SUCCESS )
Steven Cooreman398aee52020-10-13 14:35:45 +02002248 return( status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002249
Steven Cooreman398aee52020-10-13 14:35:45 +02002250 target->attr.type = source->attr.type;
2251 target->attr.bits = source->attr.bits;
2252
2253 return( PSA_SUCCESS );
Gilles Peskinef603c712019-01-19 13:40:11 +01002254}
2255
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002256psa_status_t psa_copy_key( psa_key_handle_t source_handle,
2257 const psa_key_attributes_t *specified_attributes,
2258 psa_key_handle_t *target_handle )
Gilles Peskinef603c712019-01-19 13:40:11 +01002259{
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002260 psa_status_t status;
Gilles Peskinef603c712019-01-19 13:40:11 +01002261 psa_key_slot_t *source_slot = NULL;
2262 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002263 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002264 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskinef603c712019-01-19 13:40:11 +01002265
Gilles Peskine28f8f302019-07-24 13:30:31 +02002266 status = psa_get_transparent_key( source_handle, &source_slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02002267 PSA_KEY_USAGE_COPY, 0 );
Gilles Peskinef603c712019-01-19 13:40:11 +01002268 if( status != PSA_SUCCESS )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002269 goto exit;
2270
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002271 status = psa_validate_optional_attributes( source_slot,
2272 specified_attributes );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002273 if( status != PSA_SUCCESS )
2274 goto exit;
2275
Gilles Peskine7e0cff92019-07-30 13:48:52 +02002276 status = psa_restrict_key_policy( &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02002277 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002278 if( status != PSA_SUCCESS )
2279 goto exit;
2280
Gilles Peskinedf179142019-07-15 22:02:14 +02002281 status = psa_start_key_creation( PSA_KEY_CREATION_COPY,
2282 &actual_attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02002283 target_handle, &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002284 if( status != PSA_SUCCESS )
2285 goto exit;
2286
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002287#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2288 if( driver != NULL )
Gilles Peskinef603c712019-01-19 13:40:11 +01002289 {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002290 /* Copying to a secure element is not implemented yet. */
2291 status = PSA_ERROR_NOT_SUPPORTED;
2292 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002293 }
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002294#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef603c712019-01-19 13:40:11 +01002295
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002296 status = psa_copy_key_material( source_slot, target_slot );
Gilles Peskinef603c712019-01-19 13:40:11 +01002297 if( status != PSA_SUCCESS )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002298 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002299
Gilles Peskine011e4282019-06-26 18:34:38 +02002300 status = psa_finish_key_creation( target_slot, driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002301exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002302 if( status != PSA_SUCCESS )
2303 {
Gilles Peskine011e4282019-06-26 18:34:38 +02002304 psa_fail_key_creation( target_slot, driver );
Ronald Cron91e95152020-07-30 17:48:03 +02002305 *target_handle = PSA_KEY_HANDLE_INIT;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002306 }
2307 return( status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002308}
2309
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002310
2311
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002312/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002313/* Message digests */
2314/****************************************************************/
2315
John Durkop0ea39e02020-10-13 19:58:20 -07002316#if defined(MBEDTLS_RSA_C) || defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinedc2fc842018-03-07 16:42:59 +01002317static const mbedtls_md_info_t *mbedtls_md_info_from_psa( psa_algorithm_t alg )
Gilles Peskine20035e32018-02-03 22:44:14 +01002318{
2319 switch( alg )
2320 {
2321#if defined(MBEDTLS_MD2_C)
2322 case PSA_ALG_MD2:
2323 return( &mbedtls_md2_info );
2324#endif
2325#if defined(MBEDTLS_MD4_C)
2326 case PSA_ALG_MD4:
2327 return( &mbedtls_md4_info );
2328#endif
2329#if defined(MBEDTLS_MD5_C)
2330 case PSA_ALG_MD5:
2331 return( &mbedtls_md5_info );
2332#endif
2333#if defined(MBEDTLS_RIPEMD160_C)
2334 case PSA_ALG_RIPEMD160:
2335 return( &mbedtls_ripemd160_info );
2336#endif
2337#if defined(MBEDTLS_SHA1_C)
2338 case PSA_ALG_SHA_1:
2339 return( &mbedtls_sha1_info );
2340#endif
2341#if defined(MBEDTLS_SHA256_C)
2342 case PSA_ALG_SHA_224:
2343 return( &mbedtls_sha224_info );
2344 case PSA_ALG_SHA_256:
2345 return( &mbedtls_sha256_info );
2346#endif
2347#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnardd6020842019-07-17 16:28:21 +02002348#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine20035e32018-02-03 22:44:14 +01002349 case PSA_ALG_SHA_384:
2350 return( &mbedtls_sha384_info );
Manuel Pégourié-Gonnardd6020842019-07-17 16:28:21 +02002351#endif
Gilles Peskine20035e32018-02-03 22:44:14 +01002352 case PSA_ALG_SHA_512:
2353 return( &mbedtls_sha512_info );
2354#endif
2355 default:
2356 return( NULL );
2357 }
2358}
John Durkop0ea39e02020-10-13 19:58:20 -07002359#endif /* defined(MBEDTLS_RSA_C) || defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine20035e32018-02-03 22:44:14 +01002360
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002361psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
2362{
2363 switch( operation->alg )
2364 {
Gilles Peskine81736312018-06-26 15:04:31 +02002365 case 0:
2366 /* The object has (apparently) been initialized but it is not
2367 * in use. It's ok to call abort on such an object, and there's
2368 * nothing to do. */
2369 break;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002370#if defined(MBEDTLS_MD2_C)
2371 case PSA_ALG_MD2:
2372 mbedtls_md2_free( &operation->ctx.md2 );
2373 break;
2374#endif
2375#if defined(MBEDTLS_MD4_C)
2376 case PSA_ALG_MD4:
2377 mbedtls_md4_free( &operation->ctx.md4 );
2378 break;
2379#endif
2380#if defined(MBEDTLS_MD5_C)
2381 case PSA_ALG_MD5:
2382 mbedtls_md5_free( &operation->ctx.md5 );
2383 break;
2384#endif
2385#if defined(MBEDTLS_RIPEMD160_C)
2386 case PSA_ALG_RIPEMD160:
2387 mbedtls_ripemd160_free( &operation->ctx.ripemd160 );
2388 break;
2389#endif
2390#if defined(MBEDTLS_SHA1_C)
2391 case PSA_ALG_SHA_1:
2392 mbedtls_sha1_free( &operation->ctx.sha1 );
2393 break;
2394#endif
2395#if defined(MBEDTLS_SHA256_C)
2396 case PSA_ALG_SHA_224:
2397 case PSA_ALG_SHA_256:
2398 mbedtls_sha256_free( &operation->ctx.sha256 );
2399 break;
2400#endif
2401#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002402#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002403 case PSA_ALG_SHA_384:
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002404#endif
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002405 case PSA_ALG_SHA_512:
2406 mbedtls_sha512_free( &operation->ctx.sha512 );
2407 break;
2408#endif
2409 default:
Gilles Peskinef9c2c092018-06-21 16:57:07 +02002410 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002411 }
2412 operation->alg = 0;
2413 return( PSA_SUCCESS );
2414}
2415
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002416psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002417 psa_algorithm_t alg )
2418{
Janos Follath24eed8d2019-11-22 13:21:35 +00002419 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002420
2421 /* A context must be freshly initialized before it can be set up. */
2422 if( operation->alg != 0 )
2423 {
2424 return( PSA_ERROR_BAD_STATE );
2425 }
2426
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002427 switch( alg )
2428 {
2429#if defined(MBEDTLS_MD2_C)
2430 case PSA_ALG_MD2:
2431 mbedtls_md2_init( &operation->ctx.md2 );
2432 ret = mbedtls_md2_starts_ret( &operation->ctx.md2 );
2433 break;
2434#endif
2435#if defined(MBEDTLS_MD4_C)
2436 case PSA_ALG_MD4:
2437 mbedtls_md4_init( &operation->ctx.md4 );
2438 ret = mbedtls_md4_starts_ret( &operation->ctx.md4 );
2439 break;
2440#endif
2441#if defined(MBEDTLS_MD5_C)
2442 case PSA_ALG_MD5:
2443 mbedtls_md5_init( &operation->ctx.md5 );
2444 ret = mbedtls_md5_starts_ret( &operation->ctx.md5 );
2445 break;
2446#endif
2447#if defined(MBEDTLS_RIPEMD160_C)
2448 case PSA_ALG_RIPEMD160:
2449 mbedtls_ripemd160_init( &operation->ctx.ripemd160 );
2450 ret = mbedtls_ripemd160_starts_ret( &operation->ctx.ripemd160 );
2451 break;
2452#endif
2453#if defined(MBEDTLS_SHA1_C)
2454 case PSA_ALG_SHA_1:
2455 mbedtls_sha1_init( &operation->ctx.sha1 );
2456 ret = mbedtls_sha1_starts_ret( &operation->ctx.sha1 );
2457 break;
2458#endif
2459#if defined(MBEDTLS_SHA256_C)
2460 case PSA_ALG_SHA_224:
2461 mbedtls_sha256_init( &operation->ctx.sha256 );
2462 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 1 );
2463 break;
2464 case PSA_ALG_SHA_256:
2465 mbedtls_sha256_init( &operation->ctx.sha256 );
2466 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 0 );
2467 break;
2468#endif
2469#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002470#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002471 case PSA_ALG_SHA_384:
2472 mbedtls_sha512_init( &operation->ctx.sha512 );
2473 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 1 );
2474 break;
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002475#endif
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002476 case PSA_ALG_SHA_512:
2477 mbedtls_sha512_init( &operation->ctx.sha512 );
2478 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 0 );
2479 break;
2480#endif
2481 default:
Gilles Peskinec06e0712018-06-20 16:21:04 +02002482 return( PSA_ALG_IS_HASH( alg ) ?
2483 PSA_ERROR_NOT_SUPPORTED :
2484 PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002485 }
2486 if( ret == 0 )
2487 operation->alg = alg;
2488 else
2489 psa_hash_abort( operation );
2490 return( mbedtls_to_psa_error( ret ) );
2491}
2492
2493psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2494 const uint8_t *input,
2495 size_t input_length )
2496{
Janos Follath24eed8d2019-11-22 13:21:35 +00002497 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine94e44542018-07-12 16:58:43 +02002498
2499 /* Don't require hash implementations to behave correctly on a
2500 * zero-length input, which may have an invalid pointer. */
2501 if( input_length == 0 )
2502 return( PSA_SUCCESS );
2503
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002504 switch( operation->alg )
2505 {
2506#if defined(MBEDTLS_MD2_C)
2507 case PSA_ALG_MD2:
2508 ret = mbedtls_md2_update_ret( &operation->ctx.md2,
2509 input, input_length );
2510 break;
2511#endif
2512#if defined(MBEDTLS_MD4_C)
2513 case PSA_ALG_MD4:
2514 ret = mbedtls_md4_update_ret( &operation->ctx.md4,
2515 input, input_length );
2516 break;
2517#endif
2518#if defined(MBEDTLS_MD5_C)
2519 case PSA_ALG_MD5:
2520 ret = mbedtls_md5_update_ret( &operation->ctx.md5,
2521 input, input_length );
2522 break;
2523#endif
2524#if defined(MBEDTLS_RIPEMD160_C)
2525 case PSA_ALG_RIPEMD160:
2526 ret = mbedtls_ripemd160_update_ret( &operation->ctx.ripemd160,
2527 input, input_length );
2528 break;
2529#endif
2530#if defined(MBEDTLS_SHA1_C)
2531 case PSA_ALG_SHA_1:
2532 ret = mbedtls_sha1_update_ret( &operation->ctx.sha1,
2533 input, input_length );
2534 break;
2535#endif
2536#if defined(MBEDTLS_SHA256_C)
2537 case PSA_ALG_SHA_224:
2538 case PSA_ALG_SHA_256:
2539 ret = mbedtls_sha256_update_ret( &operation->ctx.sha256,
2540 input, input_length );
2541 break;
2542#endif
2543#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002544#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002545 case PSA_ALG_SHA_384:
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002546#endif
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002547 case PSA_ALG_SHA_512:
2548 ret = mbedtls_sha512_update_ret( &operation->ctx.sha512,
2549 input, input_length );
2550 break;
2551#endif
2552 default:
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002553 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002554 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002555
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002556 if( ret != 0 )
2557 psa_hash_abort( operation );
2558 return( mbedtls_to_psa_error( ret ) );
2559}
2560
2561psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2562 uint8_t *hash,
2563 size_t hash_size,
2564 size_t *hash_length )
2565{
itayzafrir40835d42018-08-02 13:14:17 +03002566 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00002567 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine71bb7b72018-04-19 08:29:59 +02002568 size_t actual_hash_length = PSA_HASH_SIZE( operation->alg );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002569
2570 /* Fill the output buffer with something that isn't a valid hash
2571 * (barring an attack on the hash and deliberately-crafted input),
2572 * in case the caller doesn't check the return status properly. */
Gilles Peskineaee13332018-07-02 12:15:28 +02002573 *hash_length = hash_size;
Gilles Peskine46f1fd72018-06-28 19:31:31 +02002574 /* If hash_size is 0 then hash may be NULL and then the
2575 * call to memset would have undefined behavior. */
2576 if( hash_size != 0 )
2577 memset( hash, '!', hash_size );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002578
2579 if( hash_size < actual_hash_length )
itayzafrir40835d42018-08-02 13:14:17 +03002580 {
2581 status = PSA_ERROR_BUFFER_TOO_SMALL;
2582 goto exit;
2583 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002584
2585 switch( operation->alg )
2586 {
2587#if defined(MBEDTLS_MD2_C)
2588 case PSA_ALG_MD2:
2589 ret = mbedtls_md2_finish_ret( &operation->ctx.md2, hash );
2590 break;
2591#endif
2592#if defined(MBEDTLS_MD4_C)
2593 case PSA_ALG_MD4:
2594 ret = mbedtls_md4_finish_ret( &operation->ctx.md4, hash );
2595 break;
2596#endif
2597#if defined(MBEDTLS_MD5_C)
2598 case PSA_ALG_MD5:
2599 ret = mbedtls_md5_finish_ret( &operation->ctx.md5, hash );
2600 break;
2601#endif
2602#if defined(MBEDTLS_RIPEMD160_C)
2603 case PSA_ALG_RIPEMD160:
2604 ret = mbedtls_ripemd160_finish_ret( &operation->ctx.ripemd160, hash );
2605 break;
2606#endif
2607#if defined(MBEDTLS_SHA1_C)
2608 case PSA_ALG_SHA_1:
2609 ret = mbedtls_sha1_finish_ret( &operation->ctx.sha1, hash );
2610 break;
2611#endif
2612#if defined(MBEDTLS_SHA256_C)
2613 case PSA_ALG_SHA_224:
2614 case PSA_ALG_SHA_256:
2615 ret = mbedtls_sha256_finish_ret( &operation->ctx.sha256, hash );
2616 break;
2617#endif
2618#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002619#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002620 case PSA_ALG_SHA_384:
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002621#endif
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002622 case PSA_ALG_SHA_512:
2623 ret = mbedtls_sha512_finish_ret( &operation->ctx.sha512, hash );
2624 break;
2625#endif
2626 default:
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002627 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002628 }
itayzafrir40835d42018-08-02 13:14:17 +03002629 status = mbedtls_to_psa_error( ret );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002630
itayzafrir40835d42018-08-02 13:14:17 +03002631exit:
2632 if( status == PSA_SUCCESS )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002633 {
Gilles Peskineaee13332018-07-02 12:15:28 +02002634 *hash_length = actual_hash_length;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002635 return( psa_hash_abort( operation ) );
2636 }
2637 else
2638 {
2639 psa_hash_abort( operation );
itayzafrir40835d42018-08-02 13:14:17 +03002640 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002641 }
2642}
2643
Gilles Peskine2d277862018-06-18 15:41:12 +02002644psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2645 const uint8_t *hash,
2646 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002647{
2648 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2649 size_t actual_hash_length;
2650 psa_status_t status = psa_hash_finish( operation,
2651 actual_hash, sizeof( actual_hash ),
2652 &actual_hash_length );
2653 if( status != PSA_SUCCESS )
2654 return( status );
2655 if( actual_hash_length != hash_length )
2656 return( PSA_ERROR_INVALID_SIGNATURE );
2657 if( safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
2658 return( PSA_ERROR_INVALID_SIGNATURE );
2659 return( PSA_SUCCESS );
2660}
2661
Gilles Peskine0a749c82019-11-28 19:33:58 +01002662psa_status_t psa_hash_compute( psa_algorithm_t alg,
2663 const uint8_t *input, size_t input_length,
2664 uint8_t *hash, size_t hash_size,
2665 size_t *hash_length )
2666{
2667 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
2668 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2669
2670 *hash_length = hash_size;
2671 status = psa_hash_setup( &operation, alg );
2672 if( status != PSA_SUCCESS )
2673 goto exit;
2674 status = psa_hash_update( &operation, input, input_length );
2675 if( status != PSA_SUCCESS )
2676 goto exit;
2677 status = psa_hash_finish( &operation, hash, hash_size, hash_length );
2678 if( status != PSA_SUCCESS )
2679 goto exit;
2680
2681exit:
2682 if( status == PSA_SUCCESS )
2683 status = psa_hash_abort( &operation );
2684 else
2685 psa_hash_abort( &operation );
2686 return( status );
2687}
2688
2689psa_status_t psa_hash_compare( psa_algorithm_t alg,
2690 const uint8_t *input, size_t input_length,
2691 const uint8_t *hash, size_t hash_length )
2692{
2693 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
2694 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2695
2696 status = psa_hash_setup( &operation, alg );
2697 if( status != PSA_SUCCESS )
2698 goto exit;
2699 status = psa_hash_update( &operation, input, input_length );
2700 if( status != PSA_SUCCESS )
2701 goto exit;
2702 status = psa_hash_verify( &operation, hash, hash_length );
2703 if( status != PSA_SUCCESS )
2704 goto exit;
2705
2706exit:
2707 if( status == PSA_SUCCESS )
2708 status = psa_hash_abort( &operation );
2709 else
2710 psa_hash_abort( &operation );
2711 return( status );
2712}
2713
Gilles Peskineeb35d782019-01-22 17:56:16 +01002714psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2715 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002716{
2717 if( target_operation->alg != 0 )
2718 return( PSA_ERROR_BAD_STATE );
2719
2720 switch( source_operation->alg )
2721 {
2722 case 0:
2723 return( PSA_ERROR_BAD_STATE );
2724#if defined(MBEDTLS_MD2_C)
2725 case PSA_ALG_MD2:
2726 mbedtls_md2_clone( &target_operation->ctx.md2,
2727 &source_operation->ctx.md2 );
2728 break;
2729#endif
2730#if defined(MBEDTLS_MD4_C)
2731 case PSA_ALG_MD4:
2732 mbedtls_md4_clone( &target_operation->ctx.md4,
2733 &source_operation->ctx.md4 );
2734 break;
2735#endif
2736#if defined(MBEDTLS_MD5_C)
2737 case PSA_ALG_MD5:
2738 mbedtls_md5_clone( &target_operation->ctx.md5,
2739 &source_operation->ctx.md5 );
2740 break;
2741#endif
2742#if defined(MBEDTLS_RIPEMD160_C)
2743 case PSA_ALG_RIPEMD160:
2744 mbedtls_ripemd160_clone( &target_operation->ctx.ripemd160,
2745 &source_operation->ctx.ripemd160 );
2746 break;
2747#endif
2748#if defined(MBEDTLS_SHA1_C)
2749 case PSA_ALG_SHA_1:
2750 mbedtls_sha1_clone( &target_operation->ctx.sha1,
2751 &source_operation->ctx.sha1 );
2752 break;
2753#endif
2754#if defined(MBEDTLS_SHA256_C)
2755 case PSA_ALG_SHA_224:
2756 case PSA_ALG_SHA_256:
2757 mbedtls_sha256_clone( &target_operation->ctx.sha256,
2758 &source_operation->ctx.sha256 );
2759 break;
2760#endif
2761#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002762#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002763 case PSA_ALG_SHA_384:
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002764#endif
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002765 case PSA_ALG_SHA_512:
2766 mbedtls_sha512_clone( &target_operation->ctx.sha512,
2767 &source_operation->ctx.sha512 );
2768 break;
2769#endif
2770 default:
2771 return( PSA_ERROR_NOT_SUPPORTED );
2772 }
2773
2774 target_operation->alg = source_operation->alg;
2775 return( PSA_SUCCESS );
2776}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002777
2778
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002779/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002780/* MAC */
2781/****************************************************************/
2782
Gilles Peskinedc2fc842018-03-07 16:42:59 +01002783static const mbedtls_cipher_info_t *mbedtls_cipher_info_from_psa(
Gilles Peskine8c9def32018-02-08 10:02:12 +01002784 psa_algorithm_t alg,
2785 psa_key_type_t key_type,
Gilles Peskine2d277862018-06-18 15:41:12 +02002786 size_t key_bits,
mohammad1603f4f0d612018-06-03 15:04:51 +03002787 mbedtls_cipher_id_t* cipher_id )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002788{
Gilles Peskine8c9def32018-02-08 10:02:12 +01002789 mbedtls_cipher_mode_t mode;
mohammad1603f4f0d612018-06-03 15:04:51 +03002790 mbedtls_cipher_id_t cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002791
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002792 if( PSA_ALG_IS_AEAD( alg ) )
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002793 alg = PSA_ALG_AEAD_WITH_TAG_LENGTH( alg, 0 );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002794
Gilles Peskine8c9def32018-02-08 10:02:12 +01002795 if( PSA_ALG_IS_CIPHER( alg ) || PSA_ALG_IS_AEAD( alg ) )
2796 {
Nir Sonnenscheine9664c32018-06-17 14:41:30 +03002797 switch( alg )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002798 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002799 case PSA_ALG_ARC4:
Gilles Peskine26869f22019-05-06 15:25:00 +02002800 case PSA_ALG_CHACHA20:
Gilles Peskine8c9def32018-02-08 10:02:12 +01002801 mode = MBEDTLS_MODE_STREAM;
2802 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002803 case PSA_ALG_CTR:
2804 mode = MBEDTLS_MODE_CTR;
2805 break;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002806 case PSA_ALG_CFB:
2807 mode = MBEDTLS_MODE_CFB;
2808 break;
2809 case PSA_ALG_OFB:
2810 mode = MBEDTLS_MODE_OFB;
2811 break;
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02002812 case PSA_ALG_ECB_NO_PADDING:
2813 mode = MBEDTLS_MODE_ECB;
2814 break;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002815 case PSA_ALG_CBC_NO_PADDING:
2816 mode = MBEDTLS_MODE_CBC;
2817 break;
2818 case PSA_ALG_CBC_PKCS7:
2819 mode = MBEDTLS_MODE_CBC;
2820 break;
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002821 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002822 mode = MBEDTLS_MODE_CCM;
2823 break;
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002824 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_GCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002825 mode = MBEDTLS_MODE_GCM;
2826 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02002827 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CHACHA20_POLY1305, 0 ):
2828 mode = MBEDTLS_MODE_CHACHAPOLY;
2829 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002830 default:
2831 return( NULL );
2832 }
2833 }
2834 else if( alg == PSA_ALG_CMAC )
2835 mode = MBEDTLS_MODE_ECB;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002836 else
2837 return( NULL );
2838
2839 switch( key_type )
2840 {
2841 case PSA_KEY_TYPE_AES:
mohammad1603f4f0d612018-06-03 15:04:51 +03002842 cipher_id_tmp = MBEDTLS_CIPHER_ID_AES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002843 break;
2844 case PSA_KEY_TYPE_DES:
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002845 /* key_bits is 64 for Single-DES, 128 for two-key Triple-DES,
2846 * and 192 for three-key Triple-DES. */
Gilles Peskine8c9def32018-02-08 10:02:12 +01002847 if( key_bits == 64 )
mohammad1603f4f0d612018-06-03 15:04:51 +03002848 cipher_id_tmp = MBEDTLS_CIPHER_ID_DES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002849 else
mohammad1603f4f0d612018-06-03 15:04:51 +03002850 cipher_id_tmp = MBEDTLS_CIPHER_ID_3DES;
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002851 /* mbedtls doesn't recognize two-key Triple-DES as an algorithm,
2852 * but two-key Triple-DES is functionally three-key Triple-DES
2853 * with K1=K3, so that's how we present it to mbedtls. */
2854 if( key_bits == 128 )
2855 key_bits = 192;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002856 break;
2857 case PSA_KEY_TYPE_CAMELLIA:
mohammad1603f4f0d612018-06-03 15:04:51 +03002858 cipher_id_tmp = MBEDTLS_CIPHER_ID_CAMELLIA;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002859 break;
2860 case PSA_KEY_TYPE_ARC4:
mohammad1603f4f0d612018-06-03 15:04:51 +03002861 cipher_id_tmp = MBEDTLS_CIPHER_ID_ARC4;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002862 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02002863 case PSA_KEY_TYPE_CHACHA20:
2864 cipher_id_tmp = MBEDTLS_CIPHER_ID_CHACHA20;
2865 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002866 default:
2867 return( NULL );
2868 }
mohammad1603f4f0d612018-06-03 15:04:51 +03002869 if( cipher_id != NULL )
mohammad160360a64d02018-06-03 17:20:42 +03002870 *cipher_id = cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002871
Jaeden Amero23bbb752018-06-26 14:16:54 +01002872 return( mbedtls_cipher_info_from_values( cipher_id_tmp,
2873 (int) key_bits, mode ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002874}
2875
Gilles Peskinea05219c2018-11-16 16:02:56 +01002876#if defined(MBEDTLS_MD_C)
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002877static size_t psa_get_hash_block_size( psa_algorithm_t alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002878{
Gilles Peskine2d277862018-06-18 15:41:12 +02002879 switch( alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002880 {
2881 case PSA_ALG_MD2:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002882 return( 16 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002883 case PSA_ALG_MD4:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002884 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002885 case PSA_ALG_MD5:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002886 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002887 case PSA_ALG_RIPEMD160:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002888 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002889 case PSA_ALG_SHA_1:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002890 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002891 case PSA_ALG_SHA_224:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002892 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002893 case PSA_ALG_SHA_256:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002894 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002895 case PSA_ALG_SHA_384:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002896 return( 128 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002897 case PSA_ALG_SHA_512:
Gilles Peskine2d277862018-06-18 15:41:12 +02002898 return( 128 );
2899 default:
2900 return( 0 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002901 }
2902}
Gilles Peskinea05219c2018-11-16 16:02:56 +01002903#endif /* MBEDTLS_MD_C */
Nir Sonnenschein0c9ec532018-06-07 13:27:47 +03002904
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002905/* Initialize the MAC operation structure. Once this function has been
2906 * called, psa_mac_abort can run and will do the right thing. */
2907static psa_status_t psa_mac_init( psa_mac_operation_t *operation,
2908 psa_algorithm_t alg )
2909{
2910 psa_status_t status = PSA_ERROR_NOT_SUPPORTED;
2911
2912 operation->alg = alg;
2913 operation->key_set = 0;
2914 operation->iv_set = 0;
2915 operation->iv_required = 0;
2916 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002917 operation->is_sign = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002918
2919#if defined(MBEDTLS_CMAC_C)
2920 if( alg == PSA_ALG_CMAC )
2921 {
2922 operation->iv_required = 0;
2923 mbedtls_cipher_init( &operation->ctx.cmac );
2924 status = PSA_SUCCESS;
2925 }
2926 else
2927#endif /* MBEDTLS_CMAC_C */
2928#if defined(MBEDTLS_MD_C)
2929 if( PSA_ALG_IS_HMAC( operation->alg ) )
2930 {
Gilles Peskineff94abd2018-07-12 17:07:52 +02002931 /* We'll set up the hash operation later in psa_hmac_setup_internal. */
2932 operation->ctx.hmac.hash_ctx.alg = 0;
2933 status = PSA_SUCCESS;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002934 }
2935 else
2936#endif /* MBEDTLS_MD_C */
2937 {
Gilles Peskinec06e0712018-06-20 16:21:04 +02002938 if( ! PSA_ALG_IS_MAC( alg ) )
2939 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002940 }
2941
2942 if( status != PSA_SUCCESS )
2943 memset( operation, 0, sizeof( *operation ) );
2944 return( status );
2945}
2946
Gilles Peskine01126fa2018-07-12 17:04:55 +02002947#if defined(MBEDTLS_MD_C)
2948static psa_status_t psa_hmac_abort_internal( psa_hmac_internal_data *hmac )
2949{
Gilles Peskine3f108122018-12-07 18:14:53 +01002950 mbedtls_platform_zeroize( hmac->opad, sizeof( hmac->opad ) );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002951 return( psa_hash_abort( &hmac->hash_ctx ) );
2952}
2953#endif /* MBEDTLS_MD_C */
2954
Gilles Peskine8c9def32018-02-08 10:02:12 +01002955psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
2956{
Gilles Peskinefbfac682018-07-08 20:51:54 +02002957 if( operation->alg == 0 )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002958 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02002959 /* The object has (apparently) been initialized but it is not
2960 * in use. It's ok to call abort on such an object, and there's
2961 * nothing to do. */
2962 return( PSA_SUCCESS );
2963 }
2964 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002965#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002966 if( operation->alg == PSA_ALG_CMAC )
2967 {
2968 mbedtls_cipher_free( &operation->ctx.cmac );
2969 }
2970 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002971#endif /* MBEDTLS_CMAC_C */
Gilles Peskine8c9def32018-02-08 10:02:12 +01002972#if defined(MBEDTLS_MD_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002973 if( PSA_ALG_IS_HMAC( operation->alg ) )
2974 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02002975 psa_hmac_abort_internal( &operation->ctx.hmac );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002976 }
2977 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002978#endif /* MBEDTLS_MD_C */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002979 {
2980 /* Sanity check (shouldn't happen: operation->alg should
2981 * always have been initialized to a valid value). */
2982 goto bad_state;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002983 }
Moran Peker41deec42018-04-04 15:43:05 +03002984
Gilles Peskine8c9def32018-02-08 10:02:12 +01002985 operation->alg = 0;
2986 operation->key_set = 0;
2987 operation->iv_set = 0;
2988 operation->iv_required = 0;
2989 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002990 operation->is_sign = 0;
Moran Peker41deec42018-04-04 15:43:05 +03002991
Gilles Peskine8c9def32018-02-08 10:02:12 +01002992 return( PSA_SUCCESS );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002993
2994bad_state:
2995 /* If abort is called on an uninitialized object, we can't trust
2996 * anything. Wipe the object in case it contains confidential data.
2997 * This may result in a memory leak if a pointer gets overwritten,
2998 * but it's too late to do anything about this. */
2999 memset( operation, 0, sizeof( *operation ) );
3000 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003001}
3002
Gilles Peskinee3b07d82018-06-19 11:57:35 +02003003#if defined(MBEDTLS_CMAC_C)
Gilles Peskine89167cb2018-07-08 20:12:23 +02003004static int psa_cmac_setup( psa_mac_operation_t *operation,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003005 size_t key_bits,
Gilles Peskine2f060a82018-12-04 17:12:32 +01003006 psa_key_slot_t *slot,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003007 const mbedtls_cipher_info_t *cipher_info )
3008{
Janos Follath24eed8d2019-11-22 13:21:35 +00003009 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003010
3011 operation->mac_size = cipher_info->block_size;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003012
3013 ret = mbedtls_cipher_setup( &operation->ctx.cmac, cipher_info );
3014 if( ret != 0 )
3015 return( ret );
3016
3017 ret = mbedtls_cipher_cmac_starts( &operation->ctx.cmac,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02003018 slot->data.key.data,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003019 key_bits );
3020 return( ret );
3021}
Gilles Peskinee3b07d82018-06-19 11:57:35 +02003022#endif /* MBEDTLS_CMAC_C */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003023
Gilles Peskine248051a2018-06-20 16:09:38 +02003024#if defined(MBEDTLS_MD_C)
Gilles Peskine01126fa2018-07-12 17:04:55 +02003025static psa_status_t psa_hmac_setup_internal( psa_hmac_internal_data *hmac,
3026 const uint8_t *key,
3027 size_t key_length,
3028 psa_algorithm_t hash_alg )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003029{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02003030 uint8_t ipad[PSA_HMAC_MAX_HASH_BLOCK_SIZE];
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003031 size_t i;
Gilles Peskine9aa369e2018-07-16 00:36:29 +02003032 size_t hash_size = PSA_HASH_SIZE( hash_alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003033 size_t block_size = psa_get_hash_block_size( hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003034 psa_status_t status;
3035
Gilles Peskine9aa369e2018-07-16 00:36:29 +02003036 /* Sanity checks on block_size, to guarantee that there won't be a buffer
3037 * overflow below. This should never trigger if the hash algorithm
3038 * is implemented correctly. */
3039 /* The size checks against the ipad and opad buffers cannot be written
3040 * `block_size > sizeof( ipad ) || block_size > sizeof( hmac->opad )`
3041 * because that triggers -Wlogical-op on GCC 7.3. */
3042 if( block_size > sizeof( ipad ) )
3043 return( PSA_ERROR_NOT_SUPPORTED );
3044 if( block_size > sizeof( hmac->opad ) )
3045 return( PSA_ERROR_NOT_SUPPORTED );
3046 if( block_size < hash_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003047 return( PSA_ERROR_NOT_SUPPORTED );
3048
Gilles Peskined223b522018-06-11 18:12:58 +02003049 if( key_length > block_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003050 {
Gilles Peskine84b8fc82019-11-28 20:07:20 +01003051 status = psa_hash_compute( hash_alg, key, key_length,
3052 ipad, sizeof( ipad ), &key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003053 if( status != PSA_SUCCESS )
Gilles Peskineb8be2882018-07-17 16:24:34 +02003054 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003055 }
Gilles Peskine96889972018-07-12 17:07:03 +02003056 /* A 0-length key is not commonly used in HMAC when used as a MAC,
3057 * but it is permitted. It is common when HMAC is used in HKDF, for
3058 * example. Don't call `memcpy` in the 0-length because `key` could be
3059 * an invalid pointer which would make the behavior undefined. */
3060 else if( key_length != 0 )
Gilles Peskine01126fa2018-07-12 17:04:55 +02003061 memcpy( ipad, key, key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003062
Gilles Peskined223b522018-06-11 18:12:58 +02003063 /* ipad contains the key followed by garbage. Xor and fill with 0x36
3064 * to create the ipad value. */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003065 for( i = 0; i < key_length; i++ )
Gilles Peskined223b522018-06-11 18:12:58 +02003066 ipad[i] ^= 0x36;
3067 memset( ipad + key_length, 0x36, block_size - key_length );
3068
3069 /* Copy the key material from ipad to opad, flipping the requisite bits,
3070 * and filling the rest of opad with the requisite constant. */
3071 for( i = 0; i < key_length; i++ )
Gilles Peskine01126fa2018-07-12 17:04:55 +02003072 hmac->opad[i] = ipad[i] ^ 0x36 ^ 0x5C;
3073 memset( hmac->opad + key_length, 0x5C, block_size - key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003074
Gilles Peskine01126fa2018-07-12 17:04:55 +02003075 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003076 if( status != PSA_SUCCESS )
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003077 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003078
Gilles Peskine01126fa2018-07-12 17:04:55 +02003079 status = psa_hash_update( &hmac->hash_ctx, ipad, block_size );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003080
3081cleanup:
Steven Cooreman29149862020-08-05 15:43:42 +02003082 mbedtls_platform_zeroize( ipad, sizeof( ipad ) );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003083
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003084 return( status );
3085}
Gilles Peskine248051a2018-06-20 16:09:38 +02003086#endif /* MBEDTLS_MD_C */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003087
Gilles Peskine89167cb2018-07-08 20:12:23 +02003088static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01003089 psa_key_handle_t handle,
Gilles Peskine89167cb2018-07-08 20:12:23 +02003090 psa_algorithm_t alg,
3091 int is_sign )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003092{
Gilles Peskine8c9def32018-02-08 10:02:12 +01003093 psa_status_t status;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003094 psa_key_slot_t *slot;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003095 size_t key_bits;
Gilles Peskine89167cb2018-07-08 20:12:23 +02003096 psa_key_usage_t usage =
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003097 is_sign ? PSA_KEY_USAGE_SIGN_HASH : PSA_KEY_USAGE_VERIFY_HASH;
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02003098 uint8_t truncated = PSA_MAC_TRUNCATED_LENGTH( alg );
Gilles Peskinee0e9c7c2018-10-17 18:28:05 +02003099 psa_algorithm_t full_length_alg = PSA_ALG_FULL_LENGTH_MAC( alg );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003100
Jaeden Amero36ee5d02019-02-19 09:25:10 +00003101 /* A context must be freshly initialized before it can be set up. */
3102 if( operation->alg != 0 )
3103 {
3104 return( PSA_ERROR_BAD_STATE );
3105 }
3106
Gilles Peskined911eb72018-08-14 15:18:45 +02003107 status = psa_mac_init( operation, full_length_alg );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003108 if( status != PSA_SUCCESS )
3109 return( status );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003110 if( is_sign )
3111 operation->is_sign = 1;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003112
Gilles Peskine28f8f302019-07-24 13:30:31 +02003113 status = psa_get_transparent_key( handle, &slot, usage, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003114 if( status != PSA_SUCCESS )
Gilles Peskinefbfac682018-07-08 20:51:54 +02003115 goto exit;
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02003116 key_bits = psa_get_key_slot_bits( slot );
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02003117
Gilles Peskine8c9def32018-02-08 10:02:12 +01003118#if defined(MBEDTLS_CMAC_C)
Gilles Peskined911eb72018-08-14 15:18:45 +02003119 if( full_length_alg == PSA_ALG_CMAC )
Gilles Peskinefbfac682018-07-08 20:51:54 +02003120 {
3121 const mbedtls_cipher_info_t *cipher_info =
Gilles Peskined911eb72018-08-14 15:18:45 +02003122 mbedtls_cipher_info_from_psa( full_length_alg,
Gilles Peskine8e338702019-07-30 20:06:31 +02003123 slot->attr.type, key_bits, NULL );
Janos Follath24eed8d2019-11-22 13:21:35 +00003124 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinefbfac682018-07-08 20:51:54 +02003125 if( cipher_info == NULL )
3126 {
3127 status = PSA_ERROR_NOT_SUPPORTED;
3128 goto exit;
3129 }
3130 operation->mac_size = cipher_info->block_size;
3131 ret = psa_cmac_setup( operation, key_bits, slot, cipher_info );
3132 status = mbedtls_to_psa_error( ret );
3133 }
3134 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01003135#endif /* MBEDTLS_CMAC_C */
Gilles Peskine8c9def32018-02-08 10:02:12 +01003136#if defined(MBEDTLS_MD_C)
Gilles Peskined911eb72018-08-14 15:18:45 +02003137 if( PSA_ALG_IS_HMAC( full_length_alg ) )
Gilles Peskinefbfac682018-07-08 20:51:54 +02003138 {
Gilles Peskine00709fa2018-08-22 18:25:41 +02003139 psa_algorithm_t hash_alg = PSA_ALG_HMAC_GET_HASH( alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003140 if( hash_alg == 0 )
3141 {
3142 status = PSA_ERROR_NOT_SUPPORTED;
3143 goto exit;
3144 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02003145
3146 operation->mac_size = PSA_HASH_SIZE( hash_alg );
3147 /* Sanity check. This shouldn't fail on a valid configuration. */
3148 if( operation->mac_size == 0 ||
3149 operation->mac_size > sizeof( operation->ctx.hmac.opad ) )
3150 {
3151 status = PSA_ERROR_NOT_SUPPORTED;
3152 goto exit;
3153 }
3154
Gilles Peskine8e338702019-07-30 20:06:31 +02003155 if( slot->attr.type != PSA_KEY_TYPE_HMAC )
Gilles Peskine01126fa2018-07-12 17:04:55 +02003156 {
3157 status = PSA_ERROR_INVALID_ARGUMENT;
3158 goto exit;
3159 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02003160
Gilles Peskine01126fa2018-07-12 17:04:55 +02003161 status = psa_hmac_setup_internal( &operation->ctx.hmac,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02003162 slot->data.key.data,
3163 slot->data.key.bytes,
Gilles Peskine01126fa2018-07-12 17:04:55 +02003164 hash_alg );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003165 }
3166 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01003167#endif /* MBEDTLS_MD_C */
Gilles Peskinefbfac682018-07-08 20:51:54 +02003168 {
Jaeden Amero82df32e2018-11-23 15:11:20 +00003169 (void) key_bits;
Gilles Peskinefbfac682018-07-08 20:51:54 +02003170 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003171 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003172
Gilles Peskined911eb72018-08-14 15:18:45 +02003173 if( truncated == 0 )
3174 {
3175 /* The "normal" case: untruncated algorithm. Nothing to do. */
3176 }
3177 else if( truncated < 4 )
3178 {
Gilles Peskine6d72ff92018-08-21 14:55:08 +02003179 /* A very short MAC is too short for security since it can be
3180 * brute-forced. Ancient protocols with 32-bit MACs do exist,
3181 * so we make this our minimum, even though 32 bits is still
3182 * too small for security. */
Gilles Peskined911eb72018-08-14 15:18:45 +02003183 status = PSA_ERROR_NOT_SUPPORTED;
3184 }
3185 else if( truncated > operation->mac_size )
3186 {
3187 /* It's impossible to "truncate" to a larger length. */
3188 status = PSA_ERROR_INVALID_ARGUMENT;
3189 }
3190 else
3191 operation->mac_size = truncated;
3192
Gilles Peskinefbfac682018-07-08 20:51:54 +02003193exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003194 if( status != PSA_SUCCESS )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003195 {
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003196 psa_mac_abort( operation );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003197 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003198 else
3199 {
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003200 operation->key_set = 1;
3201 }
3202 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003203}
3204
Gilles Peskine89167cb2018-07-08 20:12:23 +02003205psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01003206 psa_key_handle_t handle,
Gilles Peskine89167cb2018-07-08 20:12:23 +02003207 psa_algorithm_t alg )
3208{
Gilles Peskinec5487a82018-12-03 18:08:14 +01003209 return( psa_mac_setup( operation, handle, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003210}
3211
3212psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01003213 psa_key_handle_t handle,
Gilles Peskine89167cb2018-07-08 20:12:23 +02003214 psa_algorithm_t alg )
3215{
Gilles Peskinec5487a82018-12-03 18:08:14 +01003216 return( psa_mac_setup( operation, handle, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003217}
3218
Gilles Peskine8c9def32018-02-08 10:02:12 +01003219psa_status_t psa_mac_update( psa_mac_operation_t *operation,
3220 const uint8_t *input,
3221 size_t input_length )
3222{
Gilles Peskinefbfac682018-07-08 20:51:54 +02003223 psa_status_t status = PSA_ERROR_BAD_STATE;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003224 if( ! operation->key_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003225 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003226 if( operation->iv_required && ! operation->iv_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003227 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003228 operation->has_input = 1;
3229
Gilles Peskine8c9def32018-02-08 10:02:12 +01003230#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003231 if( operation->alg == PSA_ALG_CMAC )
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03003232 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02003233 int ret = mbedtls_cipher_cmac_update( &operation->ctx.cmac,
3234 input, input_length );
3235 status = mbedtls_to_psa_error( ret );
3236 }
3237 else
3238#endif /* MBEDTLS_CMAC_C */
3239#if defined(MBEDTLS_MD_C)
3240 if( PSA_ALG_IS_HMAC( operation->alg ) )
3241 {
3242 status = psa_hash_update( &operation->ctx.hmac.hash_ctx, input,
3243 input_length );
3244 }
3245 else
3246#endif /* MBEDTLS_MD_C */
3247 {
3248 /* This shouldn't happen if `operation` was initialized by
3249 * a setup function. */
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003250 return( PSA_ERROR_BAD_STATE );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03003251 }
3252
Gilles Peskinefbfac682018-07-08 20:51:54 +02003253 if( status != PSA_SUCCESS )
3254 psa_mac_abort( operation );
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02003255 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003256}
3257
Gilles Peskine01126fa2018-07-12 17:04:55 +02003258#if defined(MBEDTLS_MD_C)
3259static psa_status_t psa_hmac_finish_internal( psa_hmac_internal_data *hmac,
3260 uint8_t *mac,
3261 size_t mac_size )
3262{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02003263 uint8_t tmp[MBEDTLS_MD_MAX_SIZE];
Gilles Peskine01126fa2018-07-12 17:04:55 +02003264 psa_algorithm_t hash_alg = hmac->hash_ctx.alg;
3265 size_t hash_size = 0;
3266 size_t block_size = psa_get_hash_block_size( hash_alg );
3267 psa_status_t status;
3268
Gilles Peskine01126fa2018-07-12 17:04:55 +02003269 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
3270 if( status != PSA_SUCCESS )
3271 return( status );
3272 /* From here on, tmp needs to be wiped. */
3273
3274 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
3275 if( status != PSA_SUCCESS )
3276 goto exit;
3277
3278 status = psa_hash_update( &hmac->hash_ctx, hmac->opad, block_size );
3279 if( status != PSA_SUCCESS )
3280 goto exit;
3281
3282 status = psa_hash_update( &hmac->hash_ctx, tmp, hash_size );
3283 if( status != PSA_SUCCESS )
3284 goto exit;
3285
Gilles Peskined911eb72018-08-14 15:18:45 +02003286 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
3287 if( status != PSA_SUCCESS )
3288 goto exit;
3289
3290 memcpy( mac, tmp, mac_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003291
3292exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01003293 mbedtls_platform_zeroize( tmp, hash_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003294 return( status );
3295}
3296#endif /* MBEDTLS_MD_C */
3297
mohammad16036df908f2018-04-02 08:34:15 -07003298static psa_status_t psa_mac_finish_internal( psa_mac_operation_t *operation,
Gilles Peskine2d277862018-06-18 15:41:12 +02003299 uint8_t *mac,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003300 size_t mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003301{
Gilles Peskine1d96fff2018-07-02 12:15:39 +02003302 if( ! operation->key_set )
3303 return( PSA_ERROR_BAD_STATE );
3304 if( operation->iv_required && ! operation->iv_set )
3305 return( PSA_ERROR_BAD_STATE );
3306
Gilles Peskine8c9def32018-02-08 10:02:12 +01003307 if( mac_size < operation->mac_size )
3308 return( PSA_ERROR_BUFFER_TOO_SMALL );
3309
Gilles Peskine8c9def32018-02-08 10:02:12 +01003310#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003311 if( operation->alg == PSA_ALG_CMAC )
3312 {
Gilles Peskined911eb72018-08-14 15:18:45 +02003313 uint8_t tmp[PSA_MAX_BLOCK_CIPHER_BLOCK_SIZE];
3314 int ret = mbedtls_cipher_cmac_finish( &operation->ctx.cmac, tmp );
3315 if( ret == 0 )
Gilles Peskine87b0ac42018-08-21 14:55:49 +02003316 memcpy( mac, tmp, operation->mac_size );
Gilles Peskine3f108122018-12-07 18:14:53 +01003317 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003318 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003319 }
Gilles Peskinefbfac682018-07-08 20:51:54 +02003320 else
3321#endif /* MBEDTLS_CMAC_C */
3322#if defined(MBEDTLS_MD_C)
3323 if( PSA_ALG_IS_HMAC( operation->alg ) )
3324 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02003325 return( psa_hmac_finish_internal( &operation->ctx.hmac,
Gilles Peskined911eb72018-08-14 15:18:45 +02003326 mac, operation->mac_size ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003327 }
3328 else
3329#endif /* MBEDTLS_MD_C */
3330 {
3331 /* This shouldn't happen if `operation` was initialized by
3332 * a setup function. */
3333 return( PSA_ERROR_BAD_STATE );
3334 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01003335}
3336
Gilles Peskineacd4be32018-07-08 19:56:25 +02003337psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
3338 uint8_t *mac,
3339 size_t mac_size,
3340 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07003341{
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003342 psa_status_t status;
3343
Jaeden Amero252ef282019-02-15 14:05:35 +00003344 if( operation->alg == 0 )
3345 {
3346 return( PSA_ERROR_BAD_STATE );
3347 }
3348
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003349 /* Fill the output buffer with something that isn't a valid mac
3350 * (barring an attack on the mac and deliberately-crafted input),
3351 * in case the caller doesn't check the return status properly. */
3352 *mac_length = mac_size;
3353 /* If mac_size is 0 then mac may be NULL and then the
3354 * call to memset would have undefined behavior. */
3355 if( mac_size != 0 )
3356 memset( mac, '!', mac_size );
3357
Gilles Peskine89167cb2018-07-08 20:12:23 +02003358 if( ! operation->is_sign )
3359 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003360 return( PSA_ERROR_BAD_STATE );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003361 }
mohammad16036df908f2018-04-02 08:34:15 -07003362
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003363 status = psa_mac_finish_internal( operation, mac, mac_size );
3364
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003365 if( status == PSA_SUCCESS )
3366 {
3367 status = psa_mac_abort( operation );
3368 if( status == PSA_SUCCESS )
3369 *mac_length = operation->mac_size;
3370 else
3371 memset( mac, '!', mac_size );
3372 }
3373 else
3374 psa_mac_abort( operation );
3375 return( status );
mohammad16036df908f2018-04-02 08:34:15 -07003376}
3377
Gilles Peskineacd4be32018-07-08 19:56:25 +02003378psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
3379 const uint8_t *mac,
3380 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003381{
Gilles Peskine828ed142018-06-18 23:25:51 +02003382 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
mohammad16036df908f2018-04-02 08:34:15 -07003383 psa_status_t status;
3384
Jaeden Amero252ef282019-02-15 14:05:35 +00003385 if( operation->alg == 0 )
3386 {
3387 return( PSA_ERROR_BAD_STATE );
3388 }
3389
Gilles Peskine89167cb2018-07-08 20:12:23 +02003390 if( operation->is_sign )
3391 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003392 return( PSA_ERROR_BAD_STATE );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003393 }
3394 if( operation->mac_size != mac_length )
3395 {
3396 status = PSA_ERROR_INVALID_SIGNATURE;
3397 goto cleanup;
Gilles Peskine89167cb2018-07-08 20:12:23 +02003398 }
mohammad16036df908f2018-04-02 08:34:15 -07003399
3400 status = psa_mac_finish_internal( operation,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003401 actual_mac, sizeof( actual_mac ) );
Gilles Peskine28cd4162020-01-20 16:31:06 +01003402 if( status != PSA_SUCCESS )
3403 goto cleanup;
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003404
3405 if( safer_memcmp( mac, actual_mac, mac_length ) != 0 )
3406 status = PSA_ERROR_INVALID_SIGNATURE;
3407
3408cleanup:
3409 if( status == PSA_SUCCESS )
3410 status = psa_mac_abort( operation );
3411 else
3412 psa_mac_abort( operation );
3413
Gilles Peskine3f108122018-12-07 18:14:53 +01003414 mbedtls_platform_zeroize( actual_mac, sizeof( actual_mac ) );
Gilles Peskined911eb72018-08-14 15:18:45 +02003415
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003416 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003417}
3418
3419
Gilles Peskine20035e32018-02-03 22:44:14 +01003420
Gilles Peskine20035e32018-02-03 22:44:14 +01003421/****************************************************************/
3422/* Asymmetric cryptography */
3423/****************************************************************/
3424
Gilles Peskine2b450e32018-06-27 15:42:46 +02003425#if defined(MBEDTLS_RSA_C)
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02003426/* Decode the hash algorithm from alg and store the mbedtls encoding in
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003427 * md_alg. Verify that the hash length is acceptable. */
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02003428static psa_status_t psa_rsa_decode_md_type( psa_algorithm_t alg,
3429 size_t hash_length,
3430 mbedtls_md_type_t *md_alg )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003431{
Gilles Peskine7ed29c52018-06-26 15:50:08 +02003432 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003433 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003434 *md_alg = mbedtls_md_get_type( md_info );
3435
3436 /* The Mbed TLS RSA module uses an unsigned int for hash length
3437 * parameters. Validate that it fits so that we don't risk an
3438 * overflow later. */
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003439#if SIZE_MAX > UINT_MAX
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003440 if( hash_length > UINT_MAX )
3441 return( PSA_ERROR_INVALID_ARGUMENT );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003442#endif
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003443
3444#if defined(MBEDTLS_PKCS1_V15)
3445 /* For PKCS#1 v1.5 signature, if using a hash, the hash length
3446 * must be correct. */
3447 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) &&
3448 alg != PSA_ALG_RSA_PKCS1V15_SIGN_RAW )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003449 {
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003450 if( md_info == NULL )
3451 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003452 if( mbedtls_md_get_size( md_info ) != hash_length )
3453 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003454 }
3455#endif /* MBEDTLS_PKCS1_V15 */
3456
3457#if defined(MBEDTLS_PKCS1_V21)
3458 /* PSS requires a hash internally. */
3459 if( PSA_ALG_IS_RSA_PSS( alg ) )
3460 {
Gilles Peskine61b91d42018-06-08 16:09:36 +02003461 if( md_info == NULL )
3462 return( PSA_ERROR_NOT_SUPPORTED );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003463 }
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003464#endif /* MBEDTLS_PKCS1_V21 */
3465
Gilles Peskine61b91d42018-06-08 16:09:36 +02003466 return( PSA_SUCCESS );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003467}
3468
Gilles Peskine2b450e32018-06-27 15:42:46 +02003469static psa_status_t psa_rsa_sign( mbedtls_rsa_context *rsa,
3470 psa_algorithm_t alg,
3471 const uint8_t *hash,
3472 size_t hash_length,
3473 uint8_t *signature,
3474 size_t signature_size,
3475 size_t *signature_length )
3476{
3477 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00003478 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003479 mbedtls_md_type_t md_alg;
3480
3481 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
3482 if( status != PSA_SUCCESS )
3483 return( status );
3484
Gilles Peskine630a18a2018-06-29 17:49:35 +02003485 if( signature_size < mbedtls_rsa_get_len( rsa ) )
Gilles Peskine2b450e32018-06-27 15:42:46 +02003486 return( PSA_ERROR_BUFFER_TOO_SMALL );
3487
3488#if defined(MBEDTLS_PKCS1_V15)
3489 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
3490 {
3491 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
3492 MBEDTLS_MD_NONE );
3493 ret = mbedtls_rsa_pkcs1_sign( rsa,
3494 mbedtls_ctr_drbg_random,
3495 &global_data.ctr_drbg,
3496 MBEDTLS_RSA_PRIVATE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003497 md_alg,
3498 (unsigned int) hash_length,
3499 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003500 signature );
3501 }
3502 else
3503#endif /* MBEDTLS_PKCS1_V15 */
3504#if defined(MBEDTLS_PKCS1_V21)
3505 if( PSA_ALG_IS_RSA_PSS( alg ) )
3506 {
3507 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3508 ret = mbedtls_rsa_rsassa_pss_sign( rsa,
3509 mbedtls_ctr_drbg_random,
3510 &global_data.ctr_drbg,
3511 MBEDTLS_RSA_PRIVATE,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003512 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003513 (unsigned int) hash_length,
3514 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003515 signature );
3516 }
3517 else
3518#endif /* MBEDTLS_PKCS1_V21 */
3519 {
3520 return( PSA_ERROR_INVALID_ARGUMENT );
3521 }
3522
3523 if( ret == 0 )
Gilles Peskine630a18a2018-06-29 17:49:35 +02003524 *signature_length = mbedtls_rsa_get_len( rsa );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003525 return( mbedtls_to_psa_error( ret ) );
3526}
3527
3528static psa_status_t psa_rsa_verify( mbedtls_rsa_context *rsa,
3529 psa_algorithm_t alg,
3530 const uint8_t *hash,
3531 size_t hash_length,
3532 const uint8_t *signature,
3533 size_t signature_length )
3534{
3535 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00003536 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003537 mbedtls_md_type_t md_alg;
3538
3539 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
3540 if( status != PSA_SUCCESS )
3541 return( status );
3542
Gilles Peskine89cc74f2019-09-12 22:08:23 +02003543 if( signature_length != mbedtls_rsa_get_len( rsa ) )
3544 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003545
3546#if defined(MBEDTLS_PKCS1_V15)
3547 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
3548 {
3549 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
3550 MBEDTLS_MD_NONE );
3551 ret = mbedtls_rsa_pkcs1_verify( rsa,
3552 mbedtls_ctr_drbg_random,
3553 &global_data.ctr_drbg,
3554 MBEDTLS_RSA_PUBLIC,
3555 md_alg,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003556 (unsigned int) hash_length,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003557 hash,
3558 signature );
3559 }
3560 else
3561#endif /* MBEDTLS_PKCS1_V15 */
3562#if defined(MBEDTLS_PKCS1_V21)
3563 if( PSA_ALG_IS_RSA_PSS( alg ) )
3564 {
3565 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3566 ret = mbedtls_rsa_rsassa_pss_verify( rsa,
3567 mbedtls_ctr_drbg_random,
3568 &global_data.ctr_drbg,
3569 MBEDTLS_RSA_PUBLIC,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003570 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003571 (unsigned int) hash_length,
3572 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003573 signature );
3574 }
3575 else
3576#endif /* MBEDTLS_PKCS1_V21 */
3577 {
3578 return( PSA_ERROR_INVALID_ARGUMENT );
3579 }
Gilles Peskineef12c632018-09-13 20:37:48 +02003580
3581 /* Mbed TLS distinguishes "invalid padding" from "valid padding but
3582 * the rest of the signature is invalid". This has little use in
3583 * practice and PSA doesn't report this distinction. */
3584 if( ret == MBEDTLS_ERR_RSA_INVALID_PADDING )
3585 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003586 return( mbedtls_to_psa_error( ret ) );
3587}
3588#endif /* MBEDTLS_RSA_C */
3589
John Durkopf87e3ae2020-10-26 15:25:23 -07003590#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003591/* `ecp` cannot be const because `ecp->grp` needs to be non-const
3592 * for mbedtls_ecdsa_sign() and mbedtls_ecdsa_sign_det()
3593 * (even though these functions don't modify it). */
3594static psa_status_t psa_ecdsa_sign( mbedtls_ecp_keypair *ecp,
3595 psa_algorithm_t alg,
3596 const uint8_t *hash,
3597 size_t hash_length,
3598 uint8_t *signature,
3599 size_t signature_size,
3600 size_t *signature_length )
3601{
Janos Follath24eed8d2019-11-22 13:21:35 +00003602 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003603 mbedtls_mpi r, s;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003604 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003605 mbedtls_mpi_init( &r );
3606 mbedtls_mpi_init( &s );
3607
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003608 if( signature_size < 2 * curve_bytes )
3609 {
3610 ret = MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL;
3611 goto cleanup;
3612 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003613
John Durkop0ea39e02020-10-13 19:58:20 -07003614#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003615 if( PSA_ALG_DSA_IS_DETERMINISTIC( alg ) )
3616 {
3617 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
3618 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3619 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
Darryl Green5e843fa2019-09-05 14:06:34 +01003620 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign_det_ext( &ecp->grp, &r, &s,
3621 &ecp->d, hash,
3622 hash_length, md_alg,
3623 mbedtls_ctr_drbg_random,
3624 &global_data.ctr_drbg ) );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003625 }
3626 else
John Durkop0ea39e02020-10-13 19:58:20 -07003627#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003628 {
Gilles Peskinea05219c2018-11-16 16:02:56 +01003629 (void) alg;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003630 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign( &ecp->grp, &r, &s, &ecp->d,
3631 hash, hash_length,
3632 mbedtls_ctr_drbg_random,
3633 &global_data.ctr_drbg ) );
3634 }
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003635
3636 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &r,
3637 signature,
3638 curve_bytes ) );
3639 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &s,
3640 signature + curve_bytes,
3641 curve_bytes ) );
3642
3643cleanup:
3644 mbedtls_mpi_free( &r );
3645 mbedtls_mpi_free( &s );
3646 if( ret == 0 )
3647 *signature_length = 2 * curve_bytes;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003648 return( mbedtls_to_psa_error( ret ) );
3649}
3650
3651static psa_status_t psa_ecdsa_verify( mbedtls_ecp_keypair *ecp,
3652 const uint8_t *hash,
3653 size_t hash_length,
3654 const uint8_t *signature,
3655 size_t signature_length )
3656{
Janos Follath24eed8d2019-11-22 13:21:35 +00003657 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003658 mbedtls_mpi r, s;
3659 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
3660 mbedtls_mpi_init( &r );
3661 mbedtls_mpi_init( &s );
3662
3663 if( signature_length != 2 * curve_bytes )
3664 return( PSA_ERROR_INVALID_SIGNATURE );
3665
3666 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &r,
3667 signature,
3668 curve_bytes ) );
3669 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &s,
3670 signature + curve_bytes,
3671 curve_bytes ) );
3672
Steven Cooremanacda8342020-07-24 23:09:52 +02003673 /* Check whether the public part is loaded. If not, load it. */
3674 if( mbedtls_ecp_is_zero( &ecp->Q ) )
3675 {
3676 MBEDTLS_MPI_CHK(
3677 mbedtls_ecp_mul( &ecp->grp, &ecp->Q, &ecp->d, &ecp->grp.G,
3678 mbedtls_ctr_drbg_random, &global_data.ctr_drbg ) );
3679 }
3680
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003681 ret = mbedtls_ecdsa_verify( &ecp->grp, hash, hash_length,
3682 &ecp->Q, &r, &s );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003683
3684cleanup:
3685 mbedtls_mpi_free( &r );
3686 mbedtls_mpi_free( &s );
3687 return( mbedtls_to_psa_error( ret ) );
3688}
John Durkopf87e3ae2020-10-26 15:25:23 -07003689#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003690
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003691psa_status_t psa_sign_hash( psa_key_handle_t handle,
3692 psa_algorithm_t alg,
3693 const uint8_t *hash,
3694 size_t hash_length,
3695 uint8_t *signature,
3696 size_t signature_size,
3697 size_t *signature_length )
Gilles Peskine20035e32018-02-03 22:44:14 +01003698{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003699 psa_key_slot_t *slot;
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003700 psa_status_t status;
3701
3702 *signature_length = signature_size;
Gilles Peskine4019f0e2019-09-12 22:05:59 +02003703 /* Immediately reject a zero-length signature buffer. This guarantees
3704 * that signature must be a valid pointer. (On the other hand, the hash
3705 * buffer can in principle be empty since it doesn't actually have
3706 * to be a hash.) */
3707 if( signature_size == 0 )
3708 return( PSA_ERROR_BUFFER_TOO_SMALL );
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003709
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003710 status = psa_get_key_from_slot( handle, &slot, PSA_KEY_USAGE_SIGN_HASH, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003711 if( status != PSA_SUCCESS )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003712 goto exit;
Gilles Peskine8e338702019-07-30 20:06:31 +02003713 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003714 {
3715 status = PSA_ERROR_INVALID_ARGUMENT;
3716 goto exit;
3717 }
Gilles Peskine20035e32018-02-03 22:44:14 +01003718
Steven Cooremancd84cb42020-07-16 20:28:36 +02003719 /* Try any of the available accelerators first */
3720 status = psa_driver_wrapper_sign_hash( slot,
3721 alg,
3722 hash,
3723 hash_length,
3724 signature,
3725 signature_size,
3726 signature_length );
Steven Cooreman8d2bde72020-09-04 13:06:39 +02003727 if( status != PSA_ERROR_NOT_SUPPORTED ||
3728 psa_key_lifetime_is_external( slot->attr.lifetime ) )
Steven Cooremancd84cb42020-07-16 20:28:36 +02003729 goto exit;
3730
Steven Cooreman7a250572020-07-17 16:43:05 +02003731 /* If the operation was not supported by any accelerator, try fallback. */
Gilles Peskine20035e32018-02-03 22:44:14 +01003732#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003733 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskine20035e32018-02-03 22:44:14 +01003734 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003735 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02003736
Steven Cooreman4fed4552020-08-03 14:46:03 +02003737 status = psa_load_rsa_representation( slot->attr.type,
3738 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02003739 slot->data.key.bytes,
Steven Cooremana01795d2020-07-24 22:48:15 +02003740 &rsa );
3741 if( status != PSA_SUCCESS )
3742 goto exit;
3743
Steven Cooremana2371e52020-07-28 14:30:39 +02003744 status = psa_rsa_sign( rsa,
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003745 alg,
3746 hash, hash_length,
3747 signature, signature_size,
3748 signature_length );
Steven Cooremana01795d2020-07-24 22:48:15 +02003749
Steven Cooremana2371e52020-07-28 14:30:39 +02003750 mbedtls_rsa_free( rsa );
3751 mbedtls_free( rsa );
Gilles Peskine20035e32018-02-03 22:44:14 +01003752 }
3753 else
3754#endif /* defined(MBEDTLS_RSA_C) */
3755#if defined(MBEDTLS_ECP_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003756 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
Gilles Peskine20035e32018-02-03 22:44:14 +01003757 {
John Durkop0ea39e02020-10-13 19:58:20 -07003758#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA)
Gilles Peskinea05219c2018-11-16 16:02:56 +01003759 if(
John Durkop0ea39e02020-10-13 19:58:20 -07003760#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea05219c2018-11-16 16:02:56 +01003761 PSA_ALG_IS_ECDSA( alg )
3762#else
3763 PSA_ALG_IS_RANDOMIZED_ECDSA( alg )
3764#endif
3765 )
Steven Cooremanacda8342020-07-24 23:09:52 +02003766 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003767 mbedtls_ecp_keypair *ecp = NULL;
Steven Cooreman4fed4552020-08-03 14:46:03 +02003768 status = psa_load_ecp_representation( slot->attr.type,
3769 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02003770 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02003771 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003772 if( status != PSA_SUCCESS )
3773 goto exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003774 status = psa_ecdsa_sign( ecp,
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003775 alg,
3776 hash, hash_length,
3777 signature, signature_size,
3778 signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02003779 mbedtls_ecp_keypair_free( ecp );
3780 mbedtls_free( ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003781 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003782 else
John Durkop0ea39e02020-10-13 19:58:20 -07003783#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003784 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003785 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003786 }
itayzafrir5c753392018-05-08 11:18:38 +03003787 }
3788 else
3789#endif /* defined(MBEDTLS_ECP_C) */
3790 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003791 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine20035e32018-02-03 22:44:14 +01003792 }
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003793
3794exit:
3795 /* Fill the unused part of the output buffer (the whole buffer on error,
3796 * the trailing part on success) with something that isn't a valid mac
3797 * (barring an attack on the mac and deliberately-crafted input),
3798 * in case the caller doesn't check the return status properly. */
3799 if( status == PSA_SUCCESS )
3800 memset( signature + *signature_length, '!',
3801 signature_size - *signature_length );
Gilles Peskine4019f0e2019-09-12 22:05:59 +02003802 else
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003803 memset( signature, '!', signature_size );
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003804 /* If signature_size is 0 then we have nothing to do. We must not call
3805 * memset because signature may be NULL in this case. */
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003806 return( status );
itayzafrir5c753392018-05-08 11:18:38 +03003807}
3808
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003809psa_status_t psa_verify_hash( psa_key_handle_t handle,
3810 psa_algorithm_t alg,
3811 const uint8_t *hash,
3812 size_t hash_length,
3813 const uint8_t *signature,
3814 size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03003815{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003816 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003817 psa_status_t status;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003818
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003819 status = psa_get_key_from_slot( handle, &slot, PSA_KEY_USAGE_VERIFY_HASH, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003820 if( status != PSA_SUCCESS )
3821 return( status );
itayzafrir5c753392018-05-08 11:18:38 +03003822
Steven Cooreman55ae2172020-07-17 19:46:15 +02003823 /* Try any of the available accelerators first */
3824 status = psa_driver_wrapper_verify_hash( slot,
3825 alg,
3826 hash,
3827 hash_length,
3828 signature,
3829 signature_length );
Steven Cooreman8d2bde72020-09-04 13:06:39 +02003830 if( status != PSA_ERROR_NOT_SUPPORTED ||
3831 psa_key_lifetime_is_external( slot->attr.lifetime ) )
Steven Cooreman55ae2172020-07-17 19:46:15 +02003832 return status;
3833
Gilles Peskine61b91d42018-06-08 16:09:36 +02003834#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003835 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003836 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003837 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02003838
Steven Cooreman4fed4552020-08-03 14:46:03 +02003839 status = psa_load_rsa_representation( slot->attr.type,
3840 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02003841 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02003842 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003843 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02003844 return( status );
Steven Cooremana01795d2020-07-24 22:48:15 +02003845
Steven Cooremana2371e52020-07-28 14:30:39 +02003846 status = psa_rsa_verify( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02003847 alg,
3848 hash, hash_length,
3849 signature, signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02003850 mbedtls_rsa_free( rsa );
3851 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003852 return( status );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003853 }
3854 else
3855#endif /* defined(MBEDTLS_RSA_C) */
itayzafrir5c753392018-05-08 11:18:38 +03003856#if defined(MBEDTLS_ECP_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003857 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
itayzafrir5c753392018-05-08 11:18:38 +03003858 {
John Durkopf87e3ae2020-10-26 15:25:23 -07003859#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003860 if( PSA_ALG_IS_ECDSA( alg ) )
Steven Cooremanacda8342020-07-24 23:09:52 +02003861 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003862 mbedtls_ecp_keypair *ecp = NULL;
Steven Cooreman4fed4552020-08-03 14:46:03 +02003863 status = psa_load_ecp_representation( slot->attr.type,
3864 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02003865 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02003866 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003867 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02003868 return( status );
Steven Cooremana2371e52020-07-28 14:30:39 +02003869 status = psa_ecdsa_verify( ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02003870 hash, hash_length,
3871 signature, signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02003872 mbedtls_ecp_keypair_free( ecp );
3873 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02003874 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02003875 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003876 else
John Durkopf87e3ae2020-10-26 15:25:23 -07003877#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003878 {
3879 return( PSA_ERROR_INVALID_ARGUMENT );
3880 }
itayzafrir5c753392018-05-08 11:18:38 +03003881 }
Gilles Peskine20035e32018-02-03 22:44:14 +01003882 else
3883#endif /* defined(MBEDTLS_ECP_C) */
3884 {
3885 return( PSA_ERROR_NOT_SUPPORTED );
3886 }
3887}
3888
Gilles Peskine072ac562018-06-30 00:21:29 +02003889#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PKCS1_V21)
3890static void psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
3891 mbedtls_rsa_context *rsa )
3892{
3893 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
3894 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3895 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
3896 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3897}
3898#endif /* defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PKCS1_V21) */
3899
Gilles Peskinec5487a82018-12-03 18:08:14 +01003900psa_status_t psa_asymmetric_encrypt( psa_key_handle_t handle,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003901 psa_algorithm_t alg,
3902 const uint8_t *input,
3903 size_t input_length,
3904 const uint8_t *salt,
3905 size_t salt_length,
3906 uint8_t *output,
3907 size_t output_size,
3908 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003909{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003910 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003911 psa_status_t status;
3912
Darryl Green5cc689a2018-07-24 15:34:10 +01003913 (void) input;
3914 (void) input_length;
3915 (void) salt;
3916 (void) output;
3917 (void) output_size;
3918
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003919 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003920
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003921 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3922 return( PSA_ERROR_INVALID_ARGUMENT );
3923
Gilles Peskine28f8f302019-07-24 13:30:31 +02003924 status = psa_get_transparent_key( handle, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003925 if( status != PSA_SUCCESS )
3926 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003927 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
3928 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003929 return( PSA_ERROR_INVALID_ARGUMENT );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003930
3931#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003932 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003933 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003934 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman4fed4552020-08-03 14:46:03 +02003935 status = psa_load_rsa_representation( slot->attr.type,
3936 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02003937 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02003938 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003939 if( status != PSA_SUCCESS )
Steven Cooreman4fed4552020-08-03 14:46:03 +02003940 goto rsa_exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003941
3942 if( output_size < mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003943 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003944 status = PSA_ERROR_BUFFER_TOO_SMALL;
3945 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003946 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003947#if defined(MBEDTLS_PKCS1_V15)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003948 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003949 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003950 status = mbedtls_to_psa_error(
3951 mbedtls_rsa_pkcs1_encrypt( rsa,
3952 mbedtls_ctr_drbg_random,
3953 &global_data.ctr_drbg,
3954 MBEDTLS_RSA_PUBLIC,
3955 input_length,
3956 input,
3957 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003958 }
3959 else
3960#endif /* MBEDTLS_PKCS1_V15 */
3961#if defined(MBEDTLS_PKCS1_V21)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003962 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003963 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003964 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02003965 status = mbedtls_to_psa_error(
3966 mbedtls_rsa_rsaes_oaep_encrypt( rsa,
3967 mbedtls_ctr_drbg_random,
3968 &global_data.ctr_drbg,
3969 MBEDTLS_RSA_PUBLIC,
3970 salt, salt_length,
3971 input_length,
3972 input,
3973 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003974 }
3975 else
3976#endif /* MBEDTLS_PKCS1_V21 */
3977 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003978 status = PSA_ERROR_INVALID_ARGUMENT;
3979 goto rsa_exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003980 }
Steven Cooreman4fed4552020-08-03 14:46:03 +02003981rsa_exit:
3982 if( status == PSA_SUCCESS )
Steven Cooremana2371e52020-07-28 14:30:39 +02003983 *output_length = mbedtls_rsa_get_len( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003984
Steven Cooremana2371e52020-07-28 14:30:39 +02003985 mbedtls_rsa_free( rsa );
3986 mbedtls_free( rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02003987 return( status );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003988 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003989 else
Gilles Peskineb75e4f12018-06-08 17:44:47 +02003990#endif /* defined(MBEDTLS_RSA_C) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003991 {
3992 return( PSA_ERROR_NOT_SUPPORTED );
3993 }
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003994}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003995
Gilles Peskinec5487a82018-12-03 18:08:14 +01003996psa_status_t psa_asymmetric_decrypt( psa_key_handle_t handle,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003997 psa_algorithm_t alg,
3998 const uint8_t *input,
3999 size_t input_length,
4000 const uint8_t *salt,
4001 size_t salt_length,
4002 uint8_t *output,
4003 size_t output_size,
4004 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004005{
Gilles Peskine2f060a82018-12-04 17:12:32 +01004006 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004007 psa_status_t status;
4008
Darryl Green5cc689a2018-07-24 15:34:10 +01004009 (void) input;
4010 (void) input_length;
4011 (void) salt;
4012 (void) output;
4013 (void) output_size;
4014
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03004015 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004016
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02004017 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
4018 return( PSA_ERROR_INVALID_ARGUMENT );
4019
Gilles Peskine28f8f302019-07-24 13:30:31 +02004020 status = psa_get_transparent_key( handle, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004021 if( status != PSA_SUCCESS )
4022 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02004023 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004024 return( PSA_ERROR_INVALID_ARGUMENT );
4025
4026#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02004027 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004028 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004029 mbedtls_rsa_context *rsa = NULL;
4030 status = psa_load_rsa_representation( slot->attr.type,
4031 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02004032 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02004033 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02004034 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02004035 return( status );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004036
Steven Cooremana2371e52020-07-28 14:30:39 +02004037 if( input_length != mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02004038 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004039 status = PSA_ERROR_INVALID_ARGUMENT;
4040 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02004041 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004042
4043#if defined(MBEDTLS_PKCS1_V15)
Gilles Peskine6afe7892018-05-31 13:16:08 +02004044 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004045 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004046 status = mbedtls_to_psa_error(
4047 mbedtls_rsa_pkcs1_decrypt( rsa,
4048 mbedtls_ctr_drbg_random,
4049 &global_data.ctr_drbg,
4050 MBEDTLS_RSA_PRIVATE,
4051 output_length,
4052 input,
4053 output,
4054 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004055 }
4056 else
4057#endif /* MBEDTLS_PKCS1_V15 */
4058#if defined(MBEDTLS_PKCS1_V21)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02004059 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004060 {
Steven Cooremana2371e52020-07-28 14:30:39 +02004061 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02004062 status = mbedtls_to_psa_error(
4063 mbedtls_rsa_rsaes_oaep_decrypt( rsa,
4064 mbedtls_ctr_drbg_random,
4065 &global_data.ctr_drbg,
4066 MBEDTLS_RSA_PRIVATE,
4067 salt, salt_length,
4068 output_length,
4069 input,
4070 output,
4071 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004072 }
4073 else
4074#endif /* MBEDTLS_PKCS1_V21 */
4075 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004076 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004077 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03004078
Steven Cooreman4fed4552020-08-03 14:46:03 +02004079rsa_exit:
Steven Cooremana2371e52020-07-28 14:30:39 +02004080 mbedtls_rsa_free( rsa );
4081 mbedtls_free( rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02004082 return( status );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004083 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004084 else
Gilles Peskineb75e4f12018-06-08 17:44:47 +02004085#endif /* defined(MBEDTLS_RSA_C) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004086 {
4087 return( PSA_ERROR_NOT_SUPPORTED );
4088 }
Gilles Peskine5b051bc2018-05-31 13:25:48 +02004089}
Gilles Peskine20035e32018-02-03 22:44:14 +01004090
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004091
4092
mohammad1603503973b2018-03-12 15:59:30 +02004093/****************************************************************/
4094/* Symmetric cryptography */
4095/****************************************************************/
4096
Gilles Peskinee553c652018-06-04 16:22:46 +02004097static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01004098 psa_key_handle_t handle,
Gilles Peskine7e928852018-06-04 16:23:10 +02004099 psa_algorithm_t alg,
4100 mbedtls_operation_t cipher_operation )
mohammad1603503973b2018-03-12 15:59:30 +02004101{
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004102 int ret = 0;
4103 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Gilles Peskine2f060a82018-12-04 17:12:32 +01004104 psa_key_slot_t *slot;
mohammad1603503973b2018-03-12 15:59:30 +02004105 size_t key_bits;
4106 const mbedtls_cipher_info_t *cipher_info = NULL;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004107 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
4108 PSA_KEY_USAGE_ENCRYPT :
4109 PSA_KEY_USAGE_DECRYPT );
mohammad1603503973b2018-03-12 15:59:30 +02004110
Steven Cooremand3feccd2020-09-01 15:56:14 +02004111 /* A context must be freshly initialized before it can be set up. */
4112 if( operation->alg != 0 )
4113 return( PSA_ERROR_BAD_STATE );
4114
Steven Cooremana07b9972020-09-10 14:54:14 +02004115 /* The requested algorithm must be one that can be processed by cipher. */
4116 if( ! PSA_ALG_IS_CIPHER( alg ) )
Steven Cooremana07b9972020-09-10 14:54:14 +02004117 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremand3feccd2020-09-01 15:56:14 +02004118
Steven Cooremanef8575e2020-09-11 11:44:50 +02004119 /* Fetch key material from key storage. */
4120 status = psa_get_key_from_slot( handle, &slot, usage, alg );
4121 if( status != PSA_SUCCESS )
4122 goto exit;
4123
4124 /* Initialize the operation struct members, except for alg. The alg member
4125 * is used to indicate to psa_cipher_abort that there are resources to free,
4126 * so we only set it after resources have been allocated/initialized. */
Steven Cooremana07b9972020-09-10 14:54:14 +02004127 operation->key_set = 0;
4128 operation->iv_set = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004129 operation->mbedtls_in_use = 0;
Steven Cooremana07b9972020-09-10 14:54:14 +02004130 operation->iv_size = 0;
4131 operation->block_size = 0;
4132 if( alg == PSA_ALG_ECB_NO_PADDING )
4133 operation->iv_required = 0;
4134 else
4135 operation->iv_required = 1;
4136
Steven Cooremana07b9972020-09-10 14:54:14 +02004137 /* Try doing the operation through a driver before using software fallback. */
Steven Cooreman37941cb2020-07-28 18:49:51 +02004138 if( cipher_operation == MBEDTLS_ENCRYPT )
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004139 status = psa_driver_wrapper_cipher_encrypt_setup( &operation->ctx.driver,
Steven Cooreman37941cb2020-07-28 18:49:51 +02004140 slot,
4141 alg );
4142 else
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004143 status = psa_driver_wrapper_cipher_decrypt_setup( &operation->ctx.driver,
Steven Cooreman37941cb2020-07-28 18:49:51 +02004144 slot,
4145 alg );
4146
Steven Cooremanef8575e2020-09-11 11:44:50 +02004147 if( status == PSA_SUCCESS )
Steven Cooreman6d81f7e2020-09-14 13:14:31 +02004148 {
Steven Cooremanef8575e2020-09-11 11:44:50 +02004149 /* Once the driver context is initialised, it needs to be freed using
4150 * psa_cipher_abort. Indicate this through setting alg. */
4151 operation->alg = alg;
Steven Cooreman6d81f7e2020-09-14 13:14:31 +02004152 }
Steven Cooremanef8575e2020-09-11 11:44:50 +02004153
Steven Cooremand3feccd2020-09-01 15:56:14 +02004154 if( status != PSA_ERROR_NOT_SUPPORTED ||
4155 psa_key_lifetime_is_external( slot->attr.lifetime ) )
4156 goto exit;
4157
Steven Cooremana07b9972020-09-10 14:54:14 +02004158 /* Proceed with initializing an mbed TLS cipher context if no driver is
Steven Cooremand3feccd2020-09-01 15:56:14 +02004159 * available for the given algorithm & key. */
4160 mbedtls_cipher_init( &operation->ctx.cipher );
mohammad1603503973b2018-03-12 15:59:30 +02004161
Steven Cooremana07b9972020-09-10 14:54:14 +02004162 /* Once the cipher context is initialised, it needs to be freed using
Steven Cooremanef8575e2020-09-11 11:44:50 +02004163 * psa_cipher_abort. Indicate there is something to be freed through setting
4164 * alg, and indicate the operation is being done using mbedtls crypto through
4165 * setting mbedtls_in_use. */
Steven Cooremana07b9972020-09-10 14:54:14 +02004166 operation->alg = alg;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004167 operation->mbedtls_in_use = 1;
Steven Cooremana07b9972020-09-10 14:54:14 +02004168
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02004169 key_bits = psa_get_key_slot_bits( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +02004170 cipher_info = mbedtls_cipher_info_from_psa( alg, slot->attr.type, key_bits, NULL );
mohammad1603503973b2018-03-12 15:59:30 +02004171 if( cipher_info == NULL )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004172 {
4173 status = PSA_ERROR_NOT_SUPPORTED;
4174 goto exit;
4175 }
mohammad1603503973b2018-03-12 15:59:30 +02004176
mohammad1603503973b2018-03-12 15:59:30 +02004177 ret = mbedtls_cipher_setup( &operation->ctx.cipher, cipher_info );
Moran Peker41deec42018-04-04 15:43:05 +03004178 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004179 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004180
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004181#if defined(MBEDTLS_DES_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02004182 if( slot->attr.type == PSA_KEY_TYPE_DES && key_bits == 128 )
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004183 {
4184 /* Two-key Triple-DES is 3-key Triple-DES with K1=K3 */
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02004185 uint8_t keys[24];
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004186 memcpy( keys, slot->data.key.data, 16 );
4187 memcpy( keys + 16, slot->data.key.data, 8 );
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004188 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
4189 keys,
4190 192, cipher_operation );
4191 }
4192 else
4193#endif
4194 {
4195 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004196 slot->data.key.data,
Jaeden Amero23bbb752018-06-26 14:16:54 +01004197 (int) key_bits, cipher_operation );
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004198 }
Moran Peker41deec42018-04-04 15:43:05 +03004199 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004200 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004201
mohammad16038481e742018-03-18 13:57:31 +02004202#if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004203 switch( alg )
mohammad16038481e742018-03-18 13:57:31 +02004204 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004205 case PSA_ALG_CBC_NO_PADDING:
4206 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
4207 MBEDTLS_PADDING_NONE );
4208 break;
4209 case PSA_ALG_CBC_PKCS7:
4210 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
4211 MBEDTLS_PADDING_PKCS7 );
4212 break;
4213 default:
4214 /* The algorithm doesn't involve padding. */
4215 ret = 0;
4216 break;
4217 }
4218 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004219 goto exit;
mohammad16038481e742018-03-18 13:57:31 +02004220#endif //MBEDTLS_CIPHER_MODE_WITH_PADDING
4221
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004222 operation->block_size = ( PSA_ALG_IS_STREAM_CIPHER( alg ) ? 1 :
Gilles Peskine8e338702019-07-30 20:06:31 +02004223 PSA_BLOCK_CIPHER_BLOCK_SIZE( slot->attr.type ) );
Steven Cooremana6033e92020-08-25 11:47:50 +02004224 if( ( alg & PSA_ALG_CIPHER_FROM_BLOCK_FLAG ) != 0 &&
4225 alg != PSA_ALG_ECB_NO_PADDING )
mohammad16038481e742018-03-18 13:57:31 +02004226 {
Gilles Peskine8e338702019-07-30 20:06:31 +02004227 operation->iv_size = PSA_BLOCK_CIPHER_BLOCK_SIZE( slot->attr.type );
mohammad16038481e742018-03-18 13:57:31 +02004228 }
Gilles Peskine26869f22019-05-06 15:25:00 +02004229#if defined(MBEDTLS_CHACHA20_C)
4230 else
4231 if( alg == PSA_ALG_CHACHA20 )
4232 operation->iv_size = 12;
4233#endif
mohammad1603503973b2018-03-12 15:59:30 +02004234
Steven Cooreman7df02922020-09-09 15:28:49 +02004235 status = PSA_SUCCESS;
4236
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004237exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02004238 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004239 status = mbedtls_to_psa_error( ret );
Steven Cooreman7df02922020-09-09 15:28:49 +02004240 if( status == PSA_SUCCESS )
4241 {
4242 /* Update operation flags for both driver and software implementations */
4243 operation->key_set = 1;
4244 }
4245 else
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004246 psa_cipher_abort( operation );
4247 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004248}
4249
Gilles Peskinefe119512018-07-08 21:39:34 +02004250psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01004251 psa_key_handle_t handle,
Gilles Peskinefe119512018-07-08 21:39:34 +02004252 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02004253{
Gilles Peskinec5487a82018-12-03 18:08:14 +01004254 return( psa_cipher_setup( operation, handle, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02004255}
4256
Gilles Peskinefe119512018-07-08 21:39:34 +02004257psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01004258 psa_key_handle_t handle,
Gilles Peskinefe119512018-07-08 21:39:34 +02004259 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02004260{
Gilles Peskinec5487a82018-12-03 18:08:14 +01004261 return( psa_cipher_setup( operation, handle, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02004262}
4263
Gilles Peskinefe119512018-07-08 21:39:34 +02004264psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004265 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02004266 size_t iv_size,
4267 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02004268{
itayzafrir534bd7c2018-08-02 13:56:32 +03004269 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00004270 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooreman7df02922020-09-09 15:28:49 +02004271 if( operation->iv_set || ! operation->iv_required )
4272 {
4273 return( PSA_ERROR_BAD_STATE );
4274 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004275
Steven Cooremanef8575e2020-09-11 11:44:50 +02004276 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004277 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004278 status = psa_driver_wrapper_cipher_generate_iv( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004279 iv,
4280 iv_size,
4281 iv_length );
4282 goto exit;
4283 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004284
Moran Peker41deec42018-04-04 15:43:05 +03004285 if( iv_size < operation->iv_size )
mohammad1603503973b2018-03-12 15:59:30 +02004286 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004287 status = PSA_ERROR_BUFFER_TOO_SMALL;
Moran Peker41deec42018-04-04 15:43:05 +03004288 goto exit;
4289 }
Gilles Peskine7e928852018-06-04 16:23:10 +02004290 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg,
4291 iv, operation->iv_size );
Moran Peker41deec42018-04-04 15:43:05 +03004292 if( ret != 0 )
4293 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004294 status = mbedtls_to_psa_error( ret );
Gilles Peskinee553c652018-06-04 16:22:46 +02004295 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004296 }
Gilles Peskinee553c652018-06-04 16:22:46 +02004297
mohammad16038481e742018-03-18 13:57:31 +02004298 *iv_length = operation->iv_size;
itayzafrir534bd7c2018-08-02 13:56:32 +03004299 status = psa_cipher_set_iv( operation, iv, *iv_length );
Moran Peker41deec42018-04-04 15:43:05 +03004300
Moran Peker395db872018-05-31 14:07:14 +03004301exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02004302 if( status == PSA_SUCCESS )
4303 operation->iv_set = 1;
4304 else
Moran Peker395db872018-05-31 14:07:14 +03004305 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004306 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004307}
4308
Gilles Peskinefe119512018-07-08 21:39:34 +02004309psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004310 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02004311 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02004312{
itayzafrir534bd7c2018-08-02 13:56:32 +03004313 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00004314 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooreman7df02922020-09-09 15:28:49 +02004315 if( operation->iv_set || ! operation->iv_required )
4316 {
4317 return( PSA_ERROR_BAD_STATE );
4318 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004319
Steven Cooremanef8575e2020-09-11 11:44:50 +02004320 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004321 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004322 status = psa_driver_wrapper_cipher_set_iv( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004323 iv,
4324 iv_length );
4325 goto exit;
4326 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004327
Moran Pekera28258c2018-05-29 16:25:04 +03004328 if( iv_length != operation->iv_size )
Moran Peker71f19ae2018-04-22 20:23:16 +03004329 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004330 status = PSA_ERROR_INVALID_ARGUMENT;
4331 goto exit;
Moran Peker71f19ae2018-04-22 20:23:16 +03004332 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004333 ret = mbedtls_cipher_set_iv( &operation->ctx.cipher, iv, iv_length );
4334 status = mbedtls_to_psa_error( ret );
4335exit:
4336 if( status == PSA_SUCCESS )
4337 operation->iv_set = 1;
4338 else
mohammad1603503973b2018-03-12 15:59:30 +02004339 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004340 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004341}
4342
Steven Cooreman177deba2020-09-07 17:14:14 +02004343/* Process input for which the algorithm is set to ECB mode. This requires
4344 * manual processing, since the PSA API is defined as being able to process
4345 * arbitrary-length calls to psa_cipher_update() with ECB mode, but the
4346 * underlying mbedtls_cipher_update only takes full blocks. */
4347static psa_status_t psa_cipher_update_ecb_internal(
4348 mbedtls_cipher_context_t *ctx,
4349 const uint8_t *input,
4350 size_t input_length,
4351 uint8_t *output,
4352 size_t output_size,
4353 size_t *output_length )
4354{
4355 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4356 size_t block_size = ctx->cipher_info->block_size;
4357 size_t internal_output_length = 0;
4358 *output_length = 0;
4359
4360 if( input_length == 0 )
4361 {
4362 status = PSA_SUCCESS;
4363 goto exit;
4364 }
4365
4366 if( ctx->unprocessed_len > 0 )
4367 {
4368 /* Fill up to block size, and run the block if there's a full one. */
4369 size_t bytes_to_copy = block_size - ctx->unprocessed_len;
4370
4371 if( input_length < bytes_to_copy )
4372 bytes_to_copy = input_length;
4373
4374 memcpy( &( ctx->unprocessed_data[ctx->unprocessed_len] ),
4375 input, bytes_to_copy );
4376 input_length -= bytes_to_copy;
4377 input += bytes_to_copy;
4378 ctx->unprocessed_len += bytes_to_copy;
4379
4380 if( ctx->unprocessed_len == block_size )
4381 {
4382 status = mbedtls_to_psa_error(
4383 mbedtls_cipher_update( ctx,
4384 ctx->unprocessed_data,
4385 block_size,
4386 output, &internal_output_length ) );
4387
4388 if( status != PSA_SUCCESS )
4389 goto exit;
4390
4391 output += internal_output_length;
4392 output_size -= internal_output_length;
4393 *output_length += internal_output_length;
4394 ctx->unprocessed_len = 0;
4395 }
4396 }
4397
4398 while( input_length >= block_size )
4399 {
4400 /* Run all full blocks we have, one by one */
4401 status = mbedtls_to_psa_error(
4402 mbedtls_cipher_update( ctx, input,
4403 block_size,
4404 output, &internal_output_length ) );
4405
4406 if( status != PSA_SUCCESS )
4407 goto exit;
4408
4409 input_length -= block_size;
4410 input += block_size;
4411
4412 output += internal_output_length;
4413 output_size -= internal_output_length;
4414 *output_length += internal_output_length;
4415 }
4416
4417 if( input_length > 0 )
4418 {
4419 /* Save unprocessed bytes for later processing */
4420 memcpy( &( ctx->unprocessed_data[ctx->unprocessed_len] ),
4421 input, input_length );
4422 ctx->unprocessed_len += input_length;
4423 }
4424
4425 status = PSA_SUCCESS;
4426
4427exit:
4428 return( status );
4429}
4430
Gilles Peskinee553c652018-06-04 16:22:46 +02004431psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
4432 const uint8_t *input,
4433 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004434 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02004435 size_t output_size,
4436 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02004437{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004438 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine89d789c2018-06-04 17:17:16 +02004439 size_t expected_output_size;
Steven Cooreman7df02922020-09-09 15:28:49 +02004440 if( operation->alg == 0 )
4441 {
4442 return( PSA_ERROR_BAD_STATE );
4443 }
4444 if( operation->iv_required && ! operation->iv_set )
4445 {
4446 return( PSA_ERROR_BAD_STATE );
4447 }
Jaeden Ameroab439972019-02-15 14:12:05 +00004448
Steven Cooremanef8575e2020-09-11 11:44:50 +02004449 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004450 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004451 status = psa_driver_wrapper_cipher_update( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004452 input,
4453 input_length,
4454 output,
4455 output_size,
4456 output_length );
4457 goto exit;
4458 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004459
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004460 if( ! PSA_ALG_IS_STREAM_CIPHER( operation->alg ) )
Gilles Peskine89d789c2018-06-04 17:17:16 +02004461 {
4462 /* Take the unprocessed partial block left over from previous
4463 * update calls, if any, plus the input to this call. Remove
4464 * the last partial block, if any. You get the data that will be
4465 * output in this call. */
4466 expected_output_size =
4467 ( operation->ctx.cipher.unprocessed_len + input_length )
4468 / operation->block_size * operation->block_size;
4469 }
4470 else
4471 {
4472 expected_output_size = input_length;
4473 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004474
Gilles Peskine89d789c2018-06-04 17:17:16 +02004475 if( output_size < expected_output_size )
itayzafrir534bd7c2018-08-02 13:56:32 +03004476 {
4477 status = PSA_ERROR_BUFFER_TOO_SMALL;
4478 goto exit;
4479 }
mohammad160382759612018-03-12 18:16:40 +02004480
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004481 if( operation->alg == PSA_ALG_ECB_NO_PADDING )
4482 {
4483 /* mbedtls_cipher_update has an API inconsistency: it will only
4484 * process a single block at a time in ECB mode. Abstract away that
4485 * inconsistency here to match the PSA API behaviour. */
Steven Cooreman177deba2020-09-07 17:14:14 +02004486 status = psa_cipher_update_ecb_internal( &operation->ctx.cipher,
4487 input,
4488 input_length,
4489 output,
4490 output_size,
4491 output_length );
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004492 }
4493 else
4494 {
4495 status = mbedtls_to_psa_error(
4496 mbedtls_cipher_update( &operation->ctx.cipher, input,
4497 input_length, output, output_length ) );
4498 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004499exit:
4500 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02004501 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004502 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004503}
4504
Gilles Peskinee553c652018-06-04 16:22:46 +02004505psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
4506 uint8_t *output,
4507 size_t output_size,
4508 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02004509{
David Saadab4ecc272019-02-14 13:48:10 +02004510 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Gilles Peskinee553c652018-06-04 16:22:46 +02004511 uint8_t temp_output_buffer[MBEDTLS_MAX_BLOCK_LENGTH];
Steven Cooreman7df02922020-09-09 15:28:49 +02004512 if( operation->alg == 0 )
4513 {
4514 return( PSA_ERROR_BAD_STATE );
4515 }
4516 if( operation->iv_required && ! operation->iv_set )
4517 {
4518 return( PSA_ERROR_BAD_STATE );
4519 }
Moran Pekerbed71a22018-04-22 20:19:20 +03004520
Steven Cooremanef8575e2020-09-11 11:44:50 +02004521 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004522 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004523 status = psa_driver_wrapper_cipher_finish( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004524 output,
4525 output_size,
4526 output_length );
Steven Cooremanef8575e2020-09-11 11:44:50 +02004527 goto exit;
Steven Cooreman8b122252020-09-03 15:30:32 +02004528 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004529
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004530 if( operation->ctx.cipher.unprocessed_len != 0 )
Moran Peker7cb22b82018-06-05 11:40:02 +03004531 {
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004532 if( operation->alg == PSA_ALG_ECB_NO_PADDING ||
Fredrik Strupef90e3012020-09-28 16:11:33 +02004533 operation->alg == PSA_ALG_CBC_NO_PADDING )
Steven Cooremana6033e92020-08-25 11:47:50 +02004534 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004535 status = PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004536 goto exit;
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004537 }
Moran Pekerdc38ebc2018-04-30 15:45:34 +03004538 }
4539
Steven Cooremanef8575e2020-09-11 11:44:50 +02004540 status = mbedtls_to_psa_error(
4541 mbedtls_cipher_finish( &operation->ctx.cipher,
4542 temp_output_buffer,
4543 output_length ) );
4544 if( status != PSA_SUCCESS )
4545 goto exit;
Janos Follath315b51c2018-07-09 16:04:51 +01004546
Gilles Peskine46f1fd72018-06-28 19:31:31 +02004547 if( *output_length == 0 )
Janos Follath315b51c2018-07-09 16:04:51 +01004548 ; /* Nothing to copy. Note that output may be NULL in this case. */
Gilles Peskine46f1fd72018-06-28 19:31:31 +02004549 else if( output_size >= *output_length )
Moran Pekerdc38ebc2018-04-30 15:45:34 +03004550 memcpy( output, temp_output_buffer, *output_length );
4551 else
Janos Follath315b51c2018-07-09 16:04:51 +01004552 status = PSA_ERROR_BUFFER_TOO_SMALL;
mohammad1603503973b2018-03-12 15:59:30 +02004553
Steven Cooremanef8575e2020-09-11 11:44:50 +02004554exit:
4555 if( operation->mbedtls_in_use == 1 )
4556 mbedtls_platform_zeroize( temp_output_buffer, sizeof( temp_output_buffer ) );
Janos Follath315b51c2018-07-09 16:04:51 +01004557
Steven Cooremanef8575e2020-09-11 11:44:50 +02004558 if( status == PSA_SUCCESS )
4559 return( psa_cipher_abort( operation ) );
4560 else
4561 {
4562 *output_length = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004563 (void) psa_cipher_abort( operation );
Janos Follath315b51c2018-07-09 16:04:51 +01004564
Steven Cooremanef8575e2020-09-11 11:44:50 +02004565 return( status );
4566 }
mohammad1603503973b2018-03-12 15:59:30 +02004567}
4568
Gilles Peskinee553c652018-06-04 16:22:46 +02004569psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
4570{
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004571 if( operation->alg == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02004572 {
Steven Cooremana07b9972020-09-10 14:54:14 +02004573 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02004574 * in use. It's ok to call abort on such an object, and there's
4575 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004576 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02004577 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004578
Gilles Peskinef9c2c092018-06-21 16:57:07 +02004579 /* Sanity check (shouldn't happen: operation->alg should
4580 * always have been initialized to a valid value). */
4581 if( ! PSA_ALG_IS_CIPHER( operation->alg ) )
4582 return( PSA_ERROR_BAD_STATE );
4583
Steven Cooremanef8575e2020-09-11 11:44:50 +02004584 if( operation->mbedtls_in_use == 0 )
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004585 psa_driver_wrapper_cipher_abort( &operation->ctx.driver );
Steven Cooremand3feccd2020-09-01 15:56:14 +02004586 else
4587 mbedtls_cipher_free( &operation->ctx.cipher );
Gilles Peskinee553c652018-06-04 16:22:46 +02004588
Moran Peker41deec42018-04-04 15:43:05 +03004589 operation->alg = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004590 operation->key_set = 0;
4591 operation->iv_set = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004592 operation->mbedtls_in_use = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004593 operation->iv_size = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004594 operation->block_size = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004595 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004596
Moran Peker395db872018-05-31 14:07:14 +03004597 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02004598}
4599
Gilles Peskinea0655c32018-04-30 17:06:50 +02004600
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004601
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004602
mohammad16035955c982018-04-26 00:53:03 +03004603/****************************************************************/
4604/* AEAD */
4605/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004606
Gilles Peskineedf9a652018-08-17 18:11:56 +02004607typedef struct
4608{
Gilles Peskine2f060a82018-12-04 17:12:32 +01004609 psa_key_slot_t *slot;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004610 const mbedtls_cipher_info_t *cipher_info;
4611 union
4612 {
4613#if defined(MBEDTLS_CCM_C)
4614 mbedtls_ccm_context ccm;
4615#endif /* MBEDTLS_CCM_C */
4616#if defined(MBEDTLS_GCM_C)
4617 mbedtls_gcm_context gcm;
4618#endif /* MBEDTLS_GCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004619#if defined(MBEDTLS_CHACHAPOLY_C)
4620 mbedtls_chachapoly_context chachapoly;
4621#endif /* MBEDTLS_CHACHAPOLY_C */
Gilles Peskineedf9a652018-08-17 18:11:56 +02004622 } ctx;
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004623 psa_algorithm_t core_alg;
4624 uint8_t full_tag_length;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004625 uint8_t tag_length;
4626} aead_operation_t;
4627
Gilles Peskine30a9e412019-01-14 18:36:12 +01004628static void psa_aead_abort_internal( aead_operation_t *operation )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004629{
Gilles Peskinef8a8fe62018-08-21 16:38:05 +02004630 switch( operation->core_alg )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004631 {
4632#if defined(MBEDTLS_CCM_C)
4633 case PSA_ALG_CCM:
4634 mbedtls_ccm_free( &operation->ctx.ccm );
4635 break;
4636#endif /* MBEDTLS_CCM_C */
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004637#if defined(MBEDTLS_GCM_C)
Gilles Peskineedf9a652018-08-17 18:11:56 +02004638 case PSA_ALG_GCM:
4639 mbedtls_gcm_free( &operation->ctx.gcm );
4640 break;
4641#endif /* MBEDTLS_GCM_C */
4642 }
4643}
4644
4645static psa_status_t psa_aead_setup( aead_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01004646 psa_key_handle_t handle,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004647 psa_key_usage_t usage,
4648 psa_algorithm_t alg )
4649{
4650 psa_status_t status;
4651 size_t key_bits;
4652 mbedtls_cipher_id_t cipher_id;
4653
Gilles Peskine28f8f302019-07-24 13:30:31 +02004654 status = psa_get_transparent_key( handle, &operation->slot, usage, alg );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004655 if( status != PSA_SUCCESS )
4656 return( status );
4657
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02004658 key_bits = psa_get_key_slot_bits( operation->slot );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004659
4660 operation->cipher_info =
Gilles Peskine8e338702019-07-30 20:06:31 +02004661 mbedtls_cipher_info_from_psa( alg, operation->slot->attr.type, key_bits,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004662 &cipher_id );
4663 if( operation->cipher_info == NULL )
4664 return( PSA_ERROR_NOT_SUPPORTED );
4665
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004666 switch( PSA_ALG_AEAD_WITH_TAG_LENGTH( alg, 0 ) )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004667 {
4668#if defined(MBEDTLS_CCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004669 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CCM, 0 ):
4670 operation->core_alg = PSA_ALG_CCM;
4671 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004672 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.
4673 * The call to mbedtls_ccm_encrypt_and_tag or
4674 * mbedtls_ccm_auth_decrypt will validate the tag length. */
Gilles Peskine8e338702019-07-30 20:06:31 +02004675 if( PSA_BLOCK_CIPHER_BLOCK_SIZE( operation->slot->attr.type ) != 16 )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004676 return( PSA_ERROR_INVALID_ARGUMENT );
4677 mbedtls_ccm_init( &operation->ctx.ccm );
4678 status = mbedtls_to_psa_error(
4679 mbedtls_ccm_setkey( &operation->ctx.ccm, cipher_id,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004680 operation->slot->data.key.data,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004681 (unsigned int) key_bits ) );
4682 if( status != 0 )
4683 goto cleanup;
4684 break;
4685#endif /* MBEDTLS_CCM_C */
4686
4687#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004688 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_GCM, 0 ):
4689 operation->core_alg = PSA_ALG_GCM;
4690 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004691 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16.
4692 * The call to mbedtls_gcm_crypt_and_tag or
4693 * mbedtls_gcm_auth_decrypt will validate the tag length. */
Gilles Peskine8e338702019-07-30 20:06:31 +02004694 if( PSA_BLOCK_CIPHER_BLOCK_SIZE( operation->slot->attr.type ) != 16 )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004695 return( PSA_ERROR_INVALID_ARGUMENT );
4696 mbedtls_gcm_init( &operation->ctx.gcm );
4697 status = mbedtls_to_psa_error(
4698 mbedtls_gcm_setkey( &operation->ctx.gcm, cipher_id,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004699 operation->slot->data.key.data,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004700 (unsigned int) key_bits ) );
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004701 if( status != 0 )
4702 goto cleanup;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004703 break;
4704#endif /* MBEDTLS_GCM_C */
4705
Gilles Peskine26869f22019-05-06 15:25:00 +02004706#if defined(MBEDTLS_CHACHAPOLY_C)
4707 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CHACHA20_POLY1305, 0 ):
4708 operation->core_alg = PSA_ALG_CHACHA20_POLY1305;
4709 operation->full_tag_length = 16;
4710 /* We only support the default tag length. */
4711 if( alg != PSA_ALG_CHACHA20_POLY1305 )
4712 return( PSA_ERROR_NOT_SUPPORTED );
4713 mbedtls_chachapoly_init( &operation->ctx.chachapoly );
4714 status = mbedtls_to_psa_error(
4715 mbedtls_chachapoly_setkey( &operation->ctx.chachapoly,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004716 operation->slot->data.key.data ) );
Gilles Peskine26869f22019-05-06 15:25:00 +02004717 if( status != 0 )
4718 goto cleanup;
4719 break;
4720#endif /* MBEDTLS_CHACHAPOLY_C */
4721
Gilles Peskineedf9a652018-08-17 18:11:56 +02004722 default:
4723 return( PSA_ERROR_NOT_SUPPORTED );
4724 }
4725
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004726 if( PSA_AEAD_TAG_LENGTH( alg ) > operation->full_tag_length )
4727 {
4728 status = PSA_ERROR_INVALID_ARGUMENT;
4729 goto cleanup;
4730 }
4731 operation->tag_length = PSA_AEAD_TAG_LENGTH( alg );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004732
Gilles Peskineedf9a652018-08-17 18:11:56 +02004733 return( PSA_SUCCESS );
4734
4735cleanup:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004736 psa_aead_abort_internal( operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004737 return( status );
4738}
4739
Gilles Peskinec5487a82018-12-03 18:08:14 +01004740psa_status_t psa_aead_encrypt( psa_key_handle_t handle,
mohammad16035955c982018-04-26 00:53:03 +03004741 psa_algorithm_t alg,
4742 const uint8_t *nonce,
4743 size_t nonce_length,
4744 const uint8_t *additional_data,
4745 size_t additional_data_length,
4746 const uint8_t *plaintext,
4747 size_t plaintext_length,
4748 uint8_t *ciphertext,
4749 size_t ciphertext_size,
4750 size_t *ciphertext_length )
4751{
mohammad16035955c982018-04-26 00:53:03 +03004752 psa_status_t status;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004753 aead_operation_t operation;
mohammad160315223a82018-06-03 17:19:55 +03004754 uint8_t *tag;
Gilles Peskine2d277862018-06-18 15:41:12 +02004755
mohammad1603f08a5502018-06-03 15:05:47 +03004756 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004757
Gilles Peskinec5487a82018-12-03 18:08:14 +01004758 status = psa_aead_setup( &operation, handle, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004759 if( status != PSA_SUCCESS )
4760 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004761
Gilles Peskineedf9a652018-08-17 18:11:56 +02004762 /* For all currently supported modes, the tag is at the end of the
4763 * ciphertext. */
4764 if( ciphertext_size < ( plaintext_length + operation.tag_length ) )
4765 {
4766 status = PSA_ERROR_BUFFER_TOO_SMALL;
4767 goto exit;
4768 }
4769 tag = ciphertext + plaintext_length;
mohammad16035955c982018-04-26 00:53:03 +03004770
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004771#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004772 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03004773 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004774 status = mbedtls_to_psa_error(
4775 mbedtls_gcm_crypt_and_tag( &operation.ctx.gcm,
4776 MBEDTLS_GCM_ENCRYPT,
4777 plaintext_length,
4778 nonce, nonce_length,
4779 additional_data, additional_data_length,
4780 plaintext, ciphertext,
4781 operation.tag_length, tag ) );
mohammad16035955c982018-04-26 00:53:03 +03004782 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004783 else
4784#endif /* MBEDTLS_GCM_C */
4785#if defined(MBEDTLS_CCM_C)
4786 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03004787 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004788 status = mbedtls_to_psa_error(
4789 mbedtls_ccm_encrypt_and_tag( &operation.ctx.ccm,
4790 plaintext_length,
4791 nonce, nonce_length,
4792 additional_data,
4793 additional_data_length,
4794 plaintext, ciphertext,
4795 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03004796 }
mohammad16035c8845f2018-05-09 05:40:09 -07004797 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004798#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004799#if defined(MBEDTLS_CHACHAPOLY_C)
4800 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
4801 {
4802 if( nonce_length != 12 || operation.tag_length != 16 )
4803 {
4804 status = PSA_ERROR_NOT_SUPPORTED;
4805 goto exit;
4806 }
4807 status = mbedtls_to_psa_error(
4808 mbedtls_chachapoly_encrypt_and_tag( &operation.ctx.chachapoly,
4809 plaintext_length,
4810 nonce,
4811 additional_data,
4812 additional_data_length,
4813 plaintext,
4814 ciphertext,
4815 tag ) );
4816 }
4817 else
4818#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad16035c8845f2018-05-09 05:40:09 -07004819 {
mohammad1603554faad2018-06-03 15:07:38 +03004820 return( PSA_ERROR_NOT_SUPPORTED );
mohammad16035c8845f2018-05-09 05:40:09 -07004821 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004822
Gilles Peskineedf9a652018-08-17 18:11:56 +02004823 if( status != PSA_SUCCESS && ciphertext_size != 0 )
4824 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02004825
Gilles Peskineedf9a652018-08-17 18:11:56 +02004826exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004827 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004828 if( status == PSA_SUCCESS )
4829 *ciphertext_length = plaintext_length + operation.tag_length;
4830 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004831}
4832
Gilles Peskineee652a32018-06-01 19:23:52 +02004833/* Locate the tag in a ciphertext buffer containing the encrypted data
4834 * followed by the tag. Return the length of the part preceding the tag in
4835 * *plaintext_length. This is the size of the plaintext in modes where
4836 * the encrypted data has the same size as the plaintext, such as
4837 * CCM and GCM. */
4838static psa_status_t psa_aead_unpadded_locate_tag( size_t tag_length,
4839 const uint8_t *ciphertext,
4840 size_t ciphertext_length,
4841 size_t plaintext_size,
Gilles Peskineee652a32018-06-01 19:23:52 +02004842 const uint8_t **p_tag )
4843{
4844 size_t payload_length;
4845 if( tag_length > ciphertext_length )
4846 return( PSA_ERROR_INVALID_ARGUMENT );
4847 payload_length = ciphertext_length - tag_length;
4848 if( payload_length > plaintext_size )
4849 return( PSA_ERROR_BUFFER_TOO_SMALL );
4850 *p_tag = ciphertext + payload_length;
Gilles Peskineee652a32018-06-01 19:23:52 +02004851 return( PSA_SUCCESS );
4852}
4853
Gilles Peskinec5487a82018-12-03 18:08:14 +01004854psa_status_t psa_aead_decrypt( psa_key_handle_t handle,
mohammad16035955c982018-04-26 00:53:03 +03004855 psa_algorithm_t alg,
4856 const uint8_t *nonce,
4857 size_t nonce_length,
4858 const uint8_t *additional_data,
4859 size_t additional_data_length,
4860 const uint8_t *ciphertext,
4861 size_t ciphertext_length,
4862 uint8_t *plaintext,
4863 size_t plaintext_size,
4864 size_t *plaintext_length )
4865{
mohammad16035955c982018-04-26 00:53:03 +03004866 psa_status_t status;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004867 aead_operation_t operation;
4868 const uint8_t *tag = NULL;
Gilles Peskine2d277862018-06-18 15:41:12 +02004869
Gilles Peskineee652a32018-06-01 19:23:52 +02004870 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004871
Gilles Peskinec5487a82018-12-03 18:08:14 +01004872 status = psa_aead_setup( &operation, handle, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004873 if( status != PSA_SUCCESS )
4874 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004875
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004876 status = psa_aead_unpadded_locate_tag( operation.tag_length,
4877 ciphertext, ciphertext_length,
4878 plaintext_size, &tag );
4879 if( status != PSA_SUCCESS )
4880 goto exit;
4881
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004882#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004883 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03004884 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004885 status = mbedtls_to_psa_error(
4886 mbedtls_gcm_auth_decrypt( &operation.ctx.gcm,
4887 ciphertext_length - operation.tag_length,
4888 nonce, nonce_length,
4889 additional_data,
4890 additional_data_length,
4891 tag, operation.tag_length,
4892 ciphertext, plaintext ) );
mohammad16035955c982018-04-26 00:53:03 +03004893 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004894 else
4895#endif /* MBEDTLS_GCM_C */
4896#if defined(MBEDTLS_CCM_C)
4897 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03004898 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004899 status = mbedtls_to_psa_error(
4900 mbedtls_ccm_auth_decrypt( &operation.ctx.ccm,
4901 ciphertext_length - operation.tag_length,
4902 nonce, nonce_length,
4903 additional_data,
4904 additional_data_length,
4905 ciphertext, plaintext,
4906 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03004907 }
mohammad160339574652018-06-01 04:39:53 -07004908 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004909#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004910#if defined(MBEDTLS_CHACHAPOLY_C)
4911 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
4912 {
4913 if( nonce_length != 12 || operation.tag_length != 16 )
4914 {
4915 status = PSA_ERROR_NOT_SUPPORTED;
4916 goto exit;
4917 }
4918 status = mbedtls_to_psa_error(
4919 mbedtls_chachapoly_auth_decrypt( &operation.ctx.chachapoly,
4920 ciphertext_length - operation.tag_length,
4921 nonce,
4922 additional_data,
4923 additional_data_length,
4924 tag,
4925 ciphertext,
4926 plaintext ) );
4927 }
4928 else
4929#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad160339574652018-06-01 04:39:53 -07004930 {
mohammad1603554faad2018-06-03 15:07:38 +03004931 return( PSA_ERROR_NOT_SUPPORTED );
mohammad160339574652018-06-01 04:39:53 -07004932 }
Gilles Peskinea40d7742018-06-01 16:28:30 +02004933
Gilles Peskineedf9a652018-08-17 18:11:56 +02004934 if( status != PSA_SUCCESS && plaintext_size != 0 )
4935 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03004936
Gilles Peskineedf9a652018-08-17 18:11:56 +02004937exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004938 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004939 if( status == PSA_SUCCESS )
4940 *plaintext_length = ciphertext_length - operation.tag_length;
4941 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004942}
4943
Gilles Peskinea0655c32018-04-30 17:06:50 +02004944
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004945
Gilles Peskine20035e32018-02-03 22:44:14 +01004946/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02004947/* Generators */
4948/****************************************************************/
4949
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004950#define HKDF_STATE_INIT 0 /* no input yet */
4951#define HKDF_STATE_STARTED 1 /* got salt */
4952#define HKDF_STATE_KEYED 2 /* got key */
4953#define HKDF_STATE_OUTPUT 3 /* output started */
4954
Gilles Peskinecbe66502019-05-16 16:59:18 +02004955static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004956 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004957{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004958 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
4959 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004960 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004961 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004962}
4963
4964
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004965psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004966{
4967 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004968 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004969 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004970 {
4971 /* The object has (apparently) been initialized but it is not
4972 * in use. It's ok to call abort on such an object, and there's
4973 * nothing to do. */
4974 }
4975 else
Gilles Peskinebef7f142018-07-12 17:22:21 +02004976#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004977 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004978 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004979 mbedtls_free( operation->ctx.hkdf.info );
4980 status = psa_hmac_abort_internal( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004981 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01004982 else if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004983 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004984 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004985 {
Janos Follath6a1d2622019-06-11 10:37:28 +01004986 if( operation->ctx.tls12_prf.seed != NULL )
4987 {
4988 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
4989 operation->ctx.tls12_prf.seed_length );
4990 mbedtls_free( operation->ctx.tls12_prf.seed );
4991 }
4992
4993 if( operation->ctx.tls12_prf.label != NULL )
4994 {
4995 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
4996 operation->ctx.tls12_prf.label_length );
4997 mbedtls_free( operation->ctx.tls12_prf.label );
4998 }
4999
5000 status = psa_hmac_abort_internal( &operation->ctx.tls12_prf.hmac );
5001
5002 /* We leave the fields Ai and output_block to be erased safely by the
5003 * mbedtls_platform_zeroize() in the end of this function. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005004 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005005 else
5006#endif /* MBEDTLS_MD_C */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005007 {
5008 status = PSA_ERROR_BAD_STATE;
5009 }
Janos Follath083036a2019-06-11 10:22:26 +01005010 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005011 return( status );
5012}
5013
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005014psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02005015 size_t *capacity)
5016{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005017 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005018 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005019 /* This is a blank key derivation operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02005020 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005021 }
5022
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005023 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005024 return( PSA_SUCCESS );
5025}
5026
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005027psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005028 size_t capacity )
5029{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005030 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005031 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005032 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005033 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005034 operation->capacity = capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005035 return( PSA_SUCCESS );
5036}
5037
Gilles Peskinebef7f142018-07-12 17:22:21 +02005038#if defined(MBEDTLS_MD_C)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005039/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02005040 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02005041static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskinebef7f142018-07-12 17:22:21 +02005042 psa_algorithm_t hash_alg,
5043 uint8_t *output,
5044 size_t output_length )
5045{
5046 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
5047 psa_status_t status;
5048
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005049 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
5050 return( PSA_ERROR_BAD_STATE );
5051 hkdf->state = HKDF_STATE_OUTPUT;
5052
Gilles Peskinebef7f142018-07-12 17:22:21 +02005053 while( output_length != 0 )
5054 {
5055 /* Copy what remains of the current block */
5056 uint8_t n = hash_length - hkdf->offset_in_block;
5057 if( n > output_length )
5058 n = (uint8_t) output_length;
5059 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
5060 output += n;
5061 output_length -= n;
5062 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02005063 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02005064 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02005065 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005066 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005067 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02005068 * object was corrupted or if this function is called directly
5069 * inside the library. */
5070 if( hkdf->block_number == 0xff )
5071 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02005072
5073 /* We need a new block */
5074 ++hkdf->block_number;
5075 hkdf->offset_in_block = 0;
5076 status = psa_hmac_setup_internal( &hkdf->hmac,
5077 hkdf->prk, hash_length,
5078 hash_alg );
5079 if( status != PSA_SUCCESS )
5080 return( status );
5081 if( hkdf->block_number != 1 )
5082 {
5083 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5084 hkdf->output_block,
5085 hash_length );
5086 if( status != PSA_SUCCESS )
5087 return( status );
5088 }
5089 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5090 hkdf->info,
5091 hkdf->info_length );
5092 if( status != PSA_SUCCESS )
5093 return( status );
5094 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5095 &hkdf->block_number, 1 );
5096 if( status != PSA_SUCCESS )
5097 return( status );
5098 status = psa_hmac_finish_internal( &hkdf->hmac,
5099 hkdf->output_block,
5100 sizeof( hkdf->output_block ) );
5101 if( status != PSA_SUCCESS )
5102 return( status );
5103 }
5104
5105 return( PSA_SUCCESS );
5106}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005107
Janos Follath7742fee2019-06-17 12:58:10 +01005108static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
5109 psa_tls12_prf_key_derivation_t *tls12_prf,
5110 psa_algorithm_t alg )
5111{
5112 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
5113 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
Janos Follathea29bfb2019-06-19 12:21:20 +01005114 psa_hash_operation_t backup = PSA_HASH_OPERATION_INIT;
5115 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005116
Janos Follath7742fee2019-06-17 12:58:10 +01005117 /* We can't be wanting more output after block 0xff, otherwise
5118 * the capacity check in psa_key_derivation_output_bytes() would have
5119 * prevented this call. It could happen only if the operation
5120 * object was corrupted or if this function is called directly
5121 * inside the library. */
5122 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01005123 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01005124
5125 /* We need a new block */
5126 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01005127 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01005128
5129 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
5130 *
5131 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
5132 *
5133 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
5134 * HMAC_hash(secret, A(2) + seed) +
5135 * HMAC_hash(secret, A(3) + seed) + ...
5136 *
5137 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01005138 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01005139 *
Janos Follathea29bfb2019-06-19 12:21:20 +01005140 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01005141 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01005142 * is currently extracted as `output_block` and where i is
5143 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01005144 */
5145
Janos Follathea29bfb2019-06-19 12:21:20 +01005146 /* Save the hash context before using it, to preserve the hash state with
5147 * only the inner padding in it. We need this, because inner padding depends
5148 * on the key (secret in the RFC's terminology). */
5149 status = psa_hash_clone( &tls12_prf->hmac.hash_ctx, &backup );
5150 if( status != PSA_SUCCESS )
5151 goto cleanup;
5152
5153 /* Calculate A(i) where i = tls12_prf->block_number. */
5154 if( tls12_prf->block_number == 1 )
5155 {
5156 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
5157 * the variable seed and in this instance means it in the context of the
5158 * P_hash function, where seed = label + seed.) */
5159 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5160 tls12_prf->label, tls12_prf->label_length );
5161 if( status != PSA_SUCCESS )
5162 goto cleanup;
5163 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5164 tls12_prf->seed, tls12_prf->seed_length );
5165 if( status != PSA_SUCCESS )
5166 goto cleanup;
5167 }
5168 else
5169 {
5170 /* A(i) = HMAC_hash(secret, A(i-1)) */
5171 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5172 tls12_prf->Ai, hash_length );
5173 if( status != PSA_SUCCESS )
5174 goto cleanup;
5175 }
5176
5177 status = psa_hmac_finish_internal( &tls12_prf->hmac,
5178 tls12_prf->Ai, hash_length );
5179 if( status != PSA_SUCCESS )
5180 goto cleanup;
5181 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
5182 if( status != PSA_SUCCESS )
5183 goto cleanup;
5184
5185 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
5186 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5187 tls12_prf->Ai, hash_length );
5188 if( status != PSA_SUCCESS )
5189 goto cleanup;
5190 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5191 tls12_prf->label, tls12_prf->label_length );
5192 if( status != PSA_SUCCESS )
5193 goto cleanup;
5194 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5195 tls12_prf->seed, tls12_prf->seed_length );
5196 if( status != PSA_SUCCESS )
5197 goto cleanup;
5198 status = psa_hmac_finish_internal( &tls12_prf->hmac,
5199 tls12_prf->output_block, hash_length );
5200 if( status != PSA_SUCCESS )
5201 goto cleanup;
5202 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
5203 if( status != PSA_SUCCESS )
5204 goto cleanup;
5205
Janos Follath7742fee2019-06-17 12:58:10 +01005206
5207cleanup:
5208
Janos Follathea29bfb2019-06-19 12:21:20 +01005209 cleanup_status = psa_hash_abort( &backup );
5210 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
5211 status = cleanup_status;
5212
5213 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01005214}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005215
Janos Follath844eb0e2019-06-19 12:10:49 +01005216static psa_status_t psa_key_derivation_tls12_prf_read(
5217 psa_tls12_prf_key_derivation_t *tls12_prf,
5218 psa_algorithm_t alg,
5219 uint8_t *output,
5220 size_t output_length )
5221{
5222 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
5223 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
5224 psa_status_t status;
5225 uint8_t offset, length;
5226
5227 while( output_length != 0 )
5228 {
5229 /* Check if we have fully processed the current block. */
5230 if( tls12_prf->left_in_block == 0 )
5231 {
5232 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
5233 alg );
5234 if( status != PSA_SUCCESS )
5235 return( status );
5236
5237 continue;
5238 }
5239
5240 if( tls12_prf->left_in_block > output_length )
5241 length = (uint8_t) output_length;
5242 else
5243 length = tls12_prf->left_in_block;
5244
5245 offset = hash_length - tls12_prf->left_in_block;
5246 memcpy( output, tls12_prf->output_block + offset, length );
5247 output += length;
5248 output_length -= length;
5249 tls12_prf->left_in_block -= length;
5250 }
5251
5252 return( PSA_SUCCESS );
5253}
Gilles Peskinebef7f142018-07-12 17:22:21 +02005254#endif /* MBEDTLS_MD_C */
5255
Janos Follath6c6c8fc2019-06-17 12:38:20 +01005256psa_status_t psa_key_derivation_output_bytes(
5257 psa_key_derivation_operation_t *operation,
5258 uint8_t *output,
5259 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005260{
5261 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005262 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005263
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005264 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005265 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005266 /* This is a blank operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02005267 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005268 }
5269
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005270 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005271 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005272 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005273 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005274 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02005275 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005276 goto exit;
5277 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005278 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005279 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005280 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005281 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02005282 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
5283 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005284 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02005285 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02005286 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005287 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005288 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005289
Gilles Peskinebef7f142018-07-12 17:22:21 +02005290#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005291 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02005292 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01005293 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005294 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02005295 output, output_length );
5296 }
Janos Follathadbec812019-06-14 11:05:39 +01005297 else
Janos Follathadbec812019-06-14 11:05:39 +01005298 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine969c5d62019-01-16 15:53:06 +01005299 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005300 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005301 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005302 kdf_alg, output,
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005303 output_length );
5304 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005305 else
5306#endif /* MBEDTLS_MD_C */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005307 {
5308 return( PSA_ERROR_BAD_STATE );
5309 }
5310
5311exit:
5312 if( status != PSA_SUCCESS )
5313 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005314 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005315 * This allows us to differentiate between exhausted operations and
5316 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
5317 * operations. */
5318 psa_algorithm_t alg = operation->alg;
5319 psa_key_derivation_abort( operation );
5320 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005321 memset( output, '!', output_length );
5322 }
5323 return( status );
5324}
5325
Gilles Peskine08542d82018-07-19 17:05:42 +02005326#if defined(MBEDTLS_DES_C)
5327static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
5328{
5329 if( data_size >= 8 )
5330 mbedtls_des_key_set_parity( data );
5331 if( data_size >= 16 )
5332 mbedtls_des_key_set_parity( data + 8 );
5333 if( data_size >= 24 )
5334 mbedtls_des_key_set_parity( data + 16 );
5335}
5336#endif /* MBEDTLS_DES_C */
5337
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005338static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005339 psa_key_slot_t *slot,
5340 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005341 psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005342{
5343 uint8_t *data = NULL;
5344 size_t bytes = PSA_BITS_TO_BYTES( bits );
5345 psa_status_t status;
5346
Gilles Peskine8e338702019-07-30 20:06:31 +02005347 if( ! key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005348 return( PSA_ERROR_INVALID_ARGUMENT );
5349 if( bits % 8 != 0 )
5350 return( PSA_ERROR_INVALID_ARGUMENT );
5351 data = mbedtls_calloc( 1, bytes );
5352 if( data == NULL )
5353 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5354
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005355 status = psa_key_derivation_output_bytes( operation, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005356 if( status != PSA_SUCCESS )
5357 goto exit;
Gilles Peskine08542d82018-07-19 17:05:42 +02005358#if defined(MBEDTLS_DES_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02005359 if( slot->attr.type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02005360 psa_des_set_key_parity( data, bytes );
5361#endif /* MBEDTLS_DES_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005362 status = psa_import_key_into_slot( slot, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005363
5364exit:
5365 mbedtls_free( data );
5366 return( status );
5367}
5368
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005369psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005370 psa_key_derivation_operation_t *operation,
Gilles Peskine98dd7792019-05-15 19:43:49 +02005371 psa_key_handle_t *handle )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005372{
5373 psa_status_t status;
5374 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005375 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02005376
5377 /* Reject any attempt to create a zero-length key so that we don't
5378 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
5379 if( psa_get_key_bits( attributes ) == 0 )
5380 return( PSA_ERROR_INVALID_ARGUMENT );
5381
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005382 if( ! operation->can_output_key )
5383 return( PSA_ERROR_NOT_PERMITTED );
5384
Gilles Peskinedf179142019-07-15 22:02:14 +02005385 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE,
5386 attributes, handle, &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02005387#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
5388 if( driver != NULL )
5389 {
5390 /* Deriving a key in a secure element is not implemented yet. */
5391 status = PSA_ERROR_NOT_SUPPORTED;
5392 }
5393#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005394 if( status == PSA_SUCCESS )
5395 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005396 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02005397 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005398 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005399 }
5400 if( status == PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02005401 status = psa_finish_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005402 if( status != PSA_SUCCESS )
5403 {
Gilles Peskine011e4282019-06-26 18:34:38 +02005404 psa_fail_key_creation( slot, driver );
Ronald Cron91e95152020-07-30 17:48:03 +02005405 *handle = PSA_KEY_HANDLE_INIT;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005406 }
5407 return( status );
5408}
5409
Gilles Peskineeab56e42018-07-12 17:12:33 +02005410
5411
5412/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02005413/* Key derivation */
5414/****************************************************************/
5415
Gilles Peskine969c5d62019-01-16 15:53:06 +01005416static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005417 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005418 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005419{
Janos Follath5fe19732019-06-20 15:09:30 +01005420 /* Make sure that operation->ctx is properly zero-initialised. (Macro
5421 * initialisers for this union leave some bytes unspecified.) */
5422 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
5423
Gilles Peskine969c5d62019-01-16 15:53:06 +01005424 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005425#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005426 if( PSA_ALG_IS_HKDF( kdf_alg ) ||
5427 PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
5428 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005429 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01005430 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005431 size_t hash_size = PSA_HASH_SIZE( hash_alg );
5432 if( hash_size == 0 )
5433 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005434 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
5435 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02005436 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005437 {
5438 return( PSA_ERROR_NOT_SUPPORTED );
5439 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005440 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01005441 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005442 }
5443#endif /* MBEDTLS_MD_C */
Gilles Peskine969c5d62019-01-16 15:53:06 +01005444 else
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005445 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005446}
5447
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005448psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005449 psa_algorithm_t alg )
5450{
5451 psa_status_t status;
5452
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005453 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005454 return( PSA_ERROR_BAD_STATE );
5455
Gilles Peskine6843c292019-01-18 16:44:49 +01005456 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
5457 return( PSA_ERROR_INVALID_ARGUMENT );
5458 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005459 {
5460 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005461 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005462 }
5463 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
5464 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005465 status = psa_key_derivation_setup_kdf( operation, alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005466 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005467 else
5468 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005469
5470 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005471 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01005472 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005473}
5474
5475#if defined(MBEDTLS_MD_C)
Gilles Peskinecbe66502019-05-16 16:59:18 +02005476static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005477 psa_algorithm_t hash_alg,
5478 psa_key_derivation_step_t step,
5479 const uint8_t *data,
5480 size_t data_length )
5481{
5482 psa_status_t status;
5483 switch( step )
5484 {
Gilles Peskine03410b52019-05-16 16:05:19 +02005485 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02005486 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005487 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005488 status = psa_hmac_setup_internal( &hkdf->hmac,
5489 data, data_length,
5490 hash_alg );
5491 if( status != PSA_SUCCESS )
5492 return( status );
5493 hkdf->state = HKDF_STATE_STARTED;
5494 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02005495 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005496 /* If no salt was provided, use an empty salt. */
5497 if( hkdf->state == HKDF_STATE_INIT )
5498 {
5499 status = psa_hmac_setup_internal( &hkdf->hmac,
5500 NULL, 0,
Gilles Peskinef9ee6332019-04-11 21:22:52 +02005501 hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005502 if( status != PSA_SUCCESS )
5503 return( status );
5504 hkdf->state = HKDF_STATE_STARTED;
5505 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02005506 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005507 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005508 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5509 data, data_length );
5510 if( status != PSA_SUCCESS )
5511 return( status );
5512 status = psa_hmac_finish_internal( &hkdf->hmac,
5513 hkdf->prk,
5514 sizeof( hkdf->prk ) );
5515 if( status != PSA_SUCCESS )
5516 return( status );
5517 hkdf->offset_in_block = PSA_HASH_SIZE( hash_alg );
5518 hkdf->block_number = 0;
5519 hkdf->state = HKDF_STATE_KEYED;
5520 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02005521 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005522 if( hkdf->state == HKDF_STATE_OUTPUT )
5523 return( PSA_ERROR_BAD_STATE );
5524 if( hkdf->info_set )
5525 return( PSA_ERROR_BAD_STATE );
5526 hkdf->info_length = data_length;
5527 if( data_length != 0 )
5528 {
5529 hkdf->info = mbedtls_calloc( 1, data_length );
5530 if( hkdf->info == NULL )
5531 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5532 memcpy( hkdf->info, data, data_length );
5533 }
5534 hkdf->info_set = 1;
5535 return( PSA_SUCCESS );
5536 default:
5537 return( PSA_ERROR_INVALID_ARGUMENT );
5538 }
5539}
Janos Follathb03233e2019-06-11 15:30:30 +01005540
Janos Follathf08e2652019-06-13 09:05:41 +01005541static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
5542 const uint8_t *data,
5543 size_t data_length )
5544{
5545 if( prf->state != TLS12_PRF_STATE_INIT )
5546 return( PSA_ERROR_BAD_STATE );
5547
Janos Follathd6dce9f2019-07-04 09:11:38 +01005548 if( data_length != 0 )
5549 {
5550 prf->seed = mbedtls_calloc( 1, data_length );
5551 if( prf->seed == NULL )
5552 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01005553
Janos Follathd6dce9f2019-07-04 09:11:38 +01005554 memcpy( prf->seed, data, data_length );
5555 prf->seed_length = data_length;
5556 }
Janos Follathf08e2652019-06-13 09:05:41 +01005557
5558 prf->state = TLS12_PRF_STATE_SEED_SET;
5559
5560 return( PSA_SUCCESS );
5561}
5562
Janos Follath81550542019-06-13 14:26:34 +01005563static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
5564 psa_algorithm_t hash_alg,
5565 const uint8_t *data,
5566 size_t data_length )
5567{
5568 psa_status_t status;
5569 if( prf->state != TLS12_PRF_STATE_SEED_SET )
5570 return( PSA_ERROR_BAD_STATE );
5571
5572 status = psa_hmac_setup_internal( &prf->hmac, data, data_length, hash_alg );
5573 if( status != PSA_SUCCESS )
5574 return( status );
5575
5576 prf->state = TLS12_PRF_STATE_KEY_SET;
5577
5578 return( PSA_SUCCESS );
5579}
5580
Janos Follath6660f0e2019-06-17 08:44:03 +01005581static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
5582 psa_tls12_prf_key_derivation_t *prf,
5583 psa_algorithm_t hash_alg,
5584 const uint8_t *data,
5585 size_t data_length )
5586{
5587 psa_status_t status;
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02005588 uint8_t pms[ 4 + 2 * PSA_ALG_TLS12_PSK_TO_MS_MAX_PSK_LEN ];
5589 uint8_t *cur = pms;
Janos Follath6660f0e2019-06-17 08:44:03 +01005590
5591 if( data_length > PSA_ALG_TLS12_PSK_TO_MS_MAX_PSK_LEN )
5592 return( PSA_ERROR_INVALID_ARGUMENT );
5593
5594 /* Quoting RFC 4279, Section 2:
5595 *
5596 * The premaster secret is formed as follows: if the PSK is N octets
5597 * long, concatenate a uint16 with the value N, N zero octets, a second
5598 * uint16 with the value N, and the PSK itself.
5599 */
5600
Janos Follath40e13932019-06-26 13:22:29 +01005601 *cur++ = ( data_length >> 8 ) & 0xff;
5602 *cur++ = ( data_length >> 0 ) & 0xff;
5603 memset( cur, 0, data_length );
5604 cur += data_length;
5605 *cur++ = pms[0];
5606 *cur++ = pms[1];
5607 memcpy( cur, data, data_length );
5608 cur += data_length;
Janos Follath6660f0e2019-06-17 08:44:03 +01005609
Janos Follath40e13932019-06-26 13:22:29 +01005610 status = psa_tls12_prf_set_key( prf, hash_alg, pms, cur - pms );
Janos Follath6660f0e2019-06-17 08:44:03 +01005611
5612 mbedtls_platform_zeroize( pms, sizeof( pms ) );
5613 return( status );
5614}
5615
Janos Follath63028dd2019-06-13 09:15:47 +01005616static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
5617 const uint8_t *data,
5618 size_t data_length )
5619{
5620 if( prf->state != TLS12_PRF_STATE_KEY_SET )
5621 return( PSA_ERROR_BAD_STATE );
5622
Janos Follathd6dce9f2019-07-04 09:11:38 +01005623 if( data_length != 0 )
5624 {
5625 prf->label = mbedtls_calloc( 1, data_length );
5626 if( prf->label == NULL )
5627 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01005628
Janos Follathd6dce9f2019-07-04 09:11:38 +01005629 memcpy( prf->label, data, data_length );
5630 prf->label_length = data_length;
5631 }
Janos Follath63028dd2019-06-13 09:15:47 +01005632
5633 prf->state = TLS12_PRF_STATE_LABEL_SET;
5634
5635 return( PSA_SUCCESS );
5636}
5637
Janos Follathb03233e2019-06-11 15:30:30 +01005638static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
5639 psa_algorithm_t hash_alg,
5640 psa_key_derivation_step_t step,
5641 const uint8_t *data,
5642 size_t data_length )
5643{
Janos Follathb03233e2019-06-11 15:30:30 +01005644 switch( step )
5645 {
Janos Follathf08e2652019-06-13 09:05:41 +01005646 case PSA_KEY_DERIVATION_INPUT_SEED:
5647 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01005648 case PSA_KEY_DERIVATION_INPUT_SECRET:
5649 return( psa_tls12_prf_set_key( prf, hash_alg, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01005650 case PSA_KEY_DERIVATION_INPUT_LABEL:
5651 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01005652 default:
5653 return( PSA_ERROR_INVALID_ARGUMENT );
5654 }
5655}
Janos Follath6660f0e2019-06-17 08:44:03 +01005656
5657static psa_status_t psa_tls12_prf_psk_to_ms_input(
5658 psa_tls12_prf_key_derivation_t *prf,
5659 psa_algorithm_t hash_alg,
5660 psa_key_derivation_step_t step,
5661 const uint8_t *data,
5662 size_t data_length )
5663{
5664 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01005665 {
Janos Follath6660f0e2019-06-17 08:44:03 +01005666 return( psa_tls12_prf_psk_to_ms_set_key( prf, hash_alg,
5667 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01005668 }
Janos Follath6660f0e2019-06-17 08:44:03 +01005669
5670 return( psa_tls12_prf_input( prf, hash_alg, step, data, data_length ) );
5671}
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005672#endif /* MBEDTLS_MD_C */
5673
Gilles Peskineb8965192019-09-24 16:21:10 +02005674/** Check whether the given key type is acceptable for the given
5675 * input step of a key derivation.
5676 *
5677 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
5678 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
5679 * Both secret and non-secret inputs can alternatively have the type
5680 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
5681 * that the input was passed as a buffer rather than via a key object.
5682 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02005683static int psa_key_derivation_check_input_type(
5684 psa_key_derivation_step_t step,
5685 psa_key_type_t key_type )
5686{
5687 switch( step )
5688 {
5689 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb8965192019-09-24 16:21:10 +02005690 if( key_type == PSA_KEY_TYPE_DERIVE )
5691 return( PSA_SUCCESS );
5692 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005693 return( PSA_SUCCESS );
5694 break;
5695 case PSA_KEY_DERIVATION_INPUT_LABEL:
5696 case PSA_KEY_DERIVATION_INPUT_SALT:
5697 case PSA_KEY_DERIVATION_INPUT_INFO:
5698 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskineb8965192019-09-24 16:21:10 +02005699 if( key_type == PSA_KEY_TYPE_RAW_DATA )
5700 return( PSA_SUCCESS );
5701 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005702 return( PSA_SUCCESS );
5703 break;
5704 }
5705 return( PSA_ERROR_INVALID_ARGUMENT );
5706}
5707
Janos Follathb80a94e2019-06-12 15:54:46 +01005708static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005709 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005710 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005711 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005712 const uint8_t *data,
5713 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005714{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02005715 psa_status_t status;
5716 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
5717
5718 status = psa_key_derivation_check_input_type( step, key_type );
Gilles Peskine224b0d62019-09-23 18:13:17 +02005719 if( status != PSA_SUCCESS )
5720 goto exit;
5721
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005722#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005723 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005724 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005725 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005726 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005727 step, data, data_length );
5728 }
k-stachowiak012dcc42019-08-13 14:55:03 +02005729 else if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005730 {
Janos Follathb03233e2019-06-11 15:30:30 +01005731 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
5732 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5733 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01005734 }
5735 else if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
5736 {
5737 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
5738 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5739 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005740 }
5741 else
5742#endif /* MBEDTLS_MD_C */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005743 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005744 /* This can't happen unless the operation object was not initialized */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005745 return( PSA_ERROR_BAD_STATE );
5746 }
5747
Gilles Peskine224b0d62019-09-23 18:13:17 +02005748exit:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005749 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005750 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005751 return( status );
5752}
5753
Janos Follath51f4a0f2019-06-14 11:35:55 +01005754psa_status_t psa_key_derivation_input_bytes(
5755 psa_key_derivation_operation_t *operation,
5756 psa_key_derivation_step_t step,
5757 const uint8_t *data,
5758 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005759{
Gilles Peskineb8965192019-09-24 16:21:10 +02005760 return( psa_key_derivation_input_internal( operation, step,
5761 PSA_KEY_TYPE_NONE,
Janos Follathc5621512019-06-14 11:27:57 +01005762 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005763}
5764
Janos Follath51f4a0f2019-06-14 11:35:55 +01005765psa_status_t psa_key_derivation_input_key(
5766 psa_key_derivation_operation_t *operation,
5767 psa_key_derivation_step_t step,
5768 psa_key_handle_t handle )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005769{
5770 psa_key_slot_t *slot;
5771 psa_status_t status;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005772
Gilles Peskine28f8f302019-07-24 13:30:31 +02005773 status = psa_get_transparent_key( handle, &slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02005774 PSA_KEY_USAGE_DERIVE,
5775 operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005776 if( status != PSA_SUCCESS )
Gilles Peskine593773d2019-09-23 18:17:40 +02005777 {
5778 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005779 return( status );
Gilles Peskine593773d2019-09-23 18:17:40 +02005780 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005781
5782 /* Passing a key object as a SECRET input unlocks the permission
5783 * to output to a key object. */
5784 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5785 operation->can_output_key = 1;
5786
Janos Follathb80a94e2019-06-12 15:54:46 +01005787 return( psa_key_derivation_input_internal( operation,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005788 step, slot->attr.type,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02005789 slot->data.key.data,
5790 slot->data.key.bytes ) );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005791}
Gilles Peskineea0fb492018-07-12 17:17:20 +02005792
5793
5794
5795/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02005796/* Key agreement */
5797/****************************************************************/
5798
Gilles Peskinea05219c2018-11-16 16:02:56 +01005799#if defined(MBEDTLS_ECDH_C)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005800static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
5801 size_t peer_key_length,
5802 const mbedtls_ecp_keypair *our_key,
5803 uint8_t *shared_secret,
5804 size_t shared_secret_size,
5805 size_t *shared_secret_length )
5806{
Steven Cooremand4867872020-08-05 16:31:39 +02005807 mbedtls_ecp_keypair *their_key = NULL;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005808 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00005809 psa_status_t status;
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005810 size_t bits = 0;
Paul Elliott8ff510a2020-06-02 17:19:28 +01005811 psa_ecc_family_t curve = mbedtls_ecc_group_to_psa( our_key->grp.id, &bits );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005812 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005813
Steven Cooreman4fed4552020-08-03 14:46:03 +02005814 status = psa_load_ecp_representation( PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve),
5815 peer_key,
Steven Cooreman7f391872020-07-30 14:57:44 +02005816 peer_key_length,
Steven Cooreman7f391872020-07-30 14:57:44 +02005817 &their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00005818 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005819 goto exit;
5820
Jaeden Amero97271b32019-01-10 19:38:51 +00005821 status = mbedtls_to_psa_error(
Steven Cooremana2371e52020-07-28 14:30:39 +02005822 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
Jaeden Amero97271b32019-01-10 19:38:51 +00005823 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005824 goto exit;
Jaeden Amero97271b32019-01-10 19:38:51 +00005825 status = mbedtls_to_psa_error(
5826 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
5827 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005828 goto exit;
5829
Jaeden Amero97271b32019-01-10 19:38:51 +00005830 status = mbedtls_to_psa_error(
5831 mbedtls_ecdh_calc_secret( &ecdh,
5832 shared_secret_length,
5833 shared_secret, shared_secret_size,
5834 mbedtls_ctr_drbg_random,
5835 &global_data.ctr_drbg ) );
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005836 if( status != PSA_SUCCESS )
5837 goto exit;
5838 if( PSA_BITS_TO_BYTES( bits ) != *shared_secret_length )
5839 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005840
5841exit:
Gilles Peskine3e819b72019-12-20 14:09:55 +01005842 if( status != PSA_SUCCESS )
5843 mbedtls_platform_zeroize( shared_secret, shared_secret_size );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005844 mbedtls_ecdh_free( &ecdh );
Steven Cooremana2371e52020-07-28 14:30:39 +02005845 mbedtls_ecp_keypair_free( their_key );
Steven Cooreman6d839f02020-07-30 11:36:45 +02005846 mbedtls_free( their_key );
Steven Cooremana2371e52020-07-28 14:30:39 +02005847
Jaeden Amero97271b32019-01-10 19:38:51 +00005848 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005849}
Gilles Peskinea05219c2018-11-16 16:02:56 +01005850#endif /* MBEDTLS_ECDH_C */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005851
Gilles Peskine01d718c2018-09-18 12:01:02 +02005852#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
5853
Gilles Peskine0216fe12019-04-11 21:23:21 +02005854static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
5855 psa_key_slot_t *private_key,
5856 const uint8_t *peer_key,
5857 size_t peer_key_length,
5858 uint8_t *shared_secret,
5859 size_t shared_secret_size,
5860 size_t *shared_secret_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005861{
Gilles Peskine0216fe12019-04-11 21:23:21 +02005862 switch( alg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005863 {
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005864#if defined(MBEDTLS_ECDH_C)
Gilles Peskine0216fe12019-04-11 21:23:21 +02005865 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02005866 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005867 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremana2371e52020-07-28 14:30:39 +02005868 mbedtls_ecp_keypair *ecp = NULL;
Steven Cooreman7f391872020-07-30 14:57:44 +02005869 psa_status_t status = psa_load_ecp_representation(
Steven Cooreman4fed4552020-08-03 14:46:03 +02005870 private_key->attr.type,
Steven Cooreman7f391872020-07-30 14:57:44 +02005871 private_key->data.key.data,
5872 private_key->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02005873 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02005874 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02005875 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02005876 status = psa_key_agreement_ecdh( peer_key, peer_key_length,
Steven Cooremana2371e52020-07-28 14:30:39 +02005877 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02005878 shared_secret, shared_secret_size,
5879 shared_secret_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02005880 mbedtls_ecp_keypair_free( ecp );
5881 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02005882 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005883#endif /* MBEDTLS_ECDH_C */
Gilles Peskine01d718c2018-09-18 12:01:02 +02005884 default:
Gilles Peskine93f85002018-11-16 16:43:31 +01005885 (void) private_key;
5886 (void) peer_key;
5887 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02005888 (void) shared_secret;
5889 (void) shared_secret_size;
5890 (void) shared_secret_length;
Gilles Peskine01d718c2018-09-18 12:01:02 +02005891 return( PSA_ERROR_NOT_SUPPORTED );
5892 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02005893}
5894
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005895/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02005896 * to potentially free embedded data structures and wipe confidential data.
5897 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005898static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005899 psa_key_derivation_step_t step,
Gilles Peskine01d718c2018-09-18 12:01:02 +02005900 psa_key_slot_t *private_key,
5901 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005902 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005903{
5904 psa_status_t status;
5905 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
5906 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005907 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005908
5909 /* Step 1: run the secret agreement algorithm to generate the shared
5910 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02005911 status = psa_key_agreement_raw_internal( ka_alg,
5912 private_key,
5913 peer_key, peer_key_length,
itayzafrir0adf0fc2018-09-06 16:24:41 +03005914 shared_secret,
5915 sizeof( shared_secret ),
Gilles Peskine05d69892018-06-19 22:00:52 +02005916 &shared_secret_length );
Gilles Peskine53d991e2018-07-12 01:14:59 +02005917 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005918 goto exit;
5919
Gilles Peskineb0b255c2018-07-06 17:01:38 +02005920 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02005921 * the shared secret. A shared secret is permitted wherever a key
5922 * of type DERIVE is permitted. */
Janos Follathb80a94e2019-06-12 15:54:46 +01005923 status = psa_key_derivation_input_internal( operation, step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005924 PSA_KEY_TYPE_DERIVE,
Janos Follathb80a94e2019-06-12 15:54:46 +01005925 shared_secret,
5926 shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005927exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01005928 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005929 return( status );
5930}
5931
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005932psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005933 psa_key_derivation_step_t step,
5934 psa_key_handle_t private_key,
5935 const uint8_t *peer_key,
5936 size_t peer_key_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005937{
Gilles Peskine2f060a82018-12-04 17:12:32 +01005938 psa_key_slot_t *slot;
Gilles Peskine08542d82018-07-19 17:05:42 +02005939 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005940 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005941 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine28f8f302019-07-24 13:30:31 +02005942 status = psa_get_transparent_key( private_key, &slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02005943 PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005944 if( status != PSA_SUCCESS )
5945 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005946 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01005947 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005948 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01005949 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005950 psa_key_derivation_abort( operation );
Steven Cooremanfa5e6312020-10-15 17:07:12 +02005951 else
5952 {
5953 /* If a private key has been added as SECRET, we allow the derived
5954 * key material to be used as a key in PSA Crypto. */
5955 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5956 operation->can_output_key = 1;
5957 }
Gilles Peskine346797d2018-11-16 16:05:06 +01005958 return( status );
Gilles Peskineaf3baab2018-06-27 22:55:52 +02005959}
5960
Gilles Peskinebe697d82019-05-16 18:00:41 +02005961psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
5962 psa_key_handle_t private_key,
5963 const uint8_t *peer_key,
5964 size_t peer_key_length,
5965 uint8_t *output,
5966 size_t output_size,
5967 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02005968{
5969 psa_key_slot_t *slot;
5970 psa_status_t status;
5971
5972 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
5973 {
5974 status = PSA_ERROR_INVALID_ARGUMENT;
5975 goto exit;
5976 }
Gilles Peskine28f8f302019-07-24 13:30:31 +02005977 status = psa_get_transparent_key( private_key, &slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02005978 PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02005979 if( status != PSA_SUCCESS )
5980 goto exit;
5981
5982 status = psa_key_agreement_raw_internal( alg, slot,
5983 peer_key, peer_key_length,
5984 output, output_size,
5985 output_length );
5986
5987exit:
5988 if( status != PSA_SUCCESS )
5989 {
5990 /* If an error happens and is not handled properly, the output
5991 * may be used as a key to protect sensitive data. Arrange for such
5992 * a key to be random, which is likely to result in decryption or
5993 * verification errors. This is better than filling the buffer with
5994 * some constant data such as zeros, which would result in the data
5995 * being protected with a reproducible, easily knowable key.
5996 */
5997 psa_generate_random( output, output_size );
5998 *output_length = output_size;
5999 }
6000 return( status );
6001}
Gilles Peskine86a440b2018-11-12 18:39:40 +01006002
6003
6004/****************************************************************/
6005/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02006006/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02006007
Gilles Peskine4c317f42018-07-12 01:24:09 +02006008psa_status_t psa_generate_random( uint8_t *output,
Gilles Peskine53d991e2018-07-12 01:14:59 +02006009 size_t output_size )
Gilles Peskine12313cd2018-06-20 00:20:32 +02006010{
Janos Follath24eed8d2019-11-22 13:21:35 +00006011 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006012 GUARD_MODULE_INITIALIZED;
6013
Gilles Peskinef181eca2019-08-07 13:49:00 +02006014 while( output_size > MBEDTLS_CTR_DRBG_MAX_REQUEST )
6015 {
6016 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg,
6017 output,
6018 MBEDTLS_CTR_DRBG_MAX_REQUEST );
6019 if( ret != 0 )
6020 return( mbedtls_to_psa_error( ret ) );
6021 output += MBEDTLS_CTR_DRBG_MAX_REQUEST;
6022 output_size -= MBEDTLS_CTR_DRBG_MAX_REQUEST;
6023 }
6024
Gilles Peskinee59236f2018-01-27 23:32:46 +01006025 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg, output, output_size );
6026 return( mbedtls_to_psa_error( ret ) );
6027}
6028
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01006029#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
6030#include "mbedtls/entropy_poll.h"
6031
Gilles Peskine7228da22019-07-15 11:06:15 +02006032psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006033 size_t seed_size )
6034{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006035 if( global_data.initialized )
6036 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02006037
6038 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
6039 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
6040 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
6041 return( PSA_ERROR_INVALID_ARGUMENT );
6042
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01006043 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006044}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01006045#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006046
Gilles Peskinee56e8782019-04-26 17:34:02 +02006047#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_GENPRIME)
6048static psa_status_t psa_read_rsa_exponent( const uint8_t *domain_parameters,
6049 size_t domain_parameters_size,
6050 int *exponent )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006051{
Gilles Peskinee56e8782019-04-26 17:34:02 +02006052 size_t i;
6053 uint32_t acc = 0;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006054
Gilles Peskinee56e8782019-04-26 17:34:02 +02006055 if( domain_parameters_size == 0 )
6056 {
6057 *exponent = 65537;
6058 return( PSA_SUCCESS );
6059 }
6060
6061 /* Mbed TLS encodes the public exponent as an int. For simplicity, only
6062 * support values that fit in a 32-bit integer, which is larger than
6063 * int on just about every platform anyway. */
6064 if( domain_parameters_size > sizeof( acc ) )
6065 return( PSA_ERROR_NOT_SUPPORTED );
6066 for( i = 0; i < domain_parameters_size; i++ )
6067 acc = ( acc << 8 ) | domain_parameters[i];
6068 if( acc > INT_MAX )
6069 return( PSA_ERROR_NOT_SUPPORTED );
6070 *exponent = acc;
6071 return( PSA_SUCCESS );
6072}
6073#endif /* MBEDTLS_RSA_C && MBEDTLS_GENPRIME */
6074
Gilles Peskine35ef36b2019-05-16 19:42:05 +02006075static psa_status_t psa_generate_key_internal(
Gilles Peskinee56e8782019-04-26 17:34:02 +02006076 psa_key_slot_t *slot, size_t bits,
6077 const uint8_t *domain_parameters, size_t domain_parameters_size )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006078{
Gilles Peskine8e338702019-07-30 20:06:31 +02006079 psa_key_type_t type = slot->attr.type;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006080
Gilles Peskinee56e8782019-04-26 17:34:02 +02006081 if( domain_parameters == NULL && domain_parameters_size != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006082 return( PSA_ERROR_INVALID_ARGUMENT );
6083
Gilles Peskinee59236f2018-01-27 23:32:46 +01006084 if( key_type_is_raw_bytes( type ) )
6085 {
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006086 psa_status_t status;
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006087
6088 status = validate_unstructured_key_bit_size( slot->attr.type, bits );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006089 if( status != PSA_SUCCESS )
6090 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006091
6092 /* Allocate memory for the key */
Steven Cooreman75b74362020-07-28 14:30:13 +02006093 status = psa_allocate_buffer_to_slot( slot, PSA_BITS_TO_BYTES( bits ) );
6094 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02006095 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006096
Steven Cooreman71fd80d2020-07-07 21:12:27 +02006097 status = psa_generate_random( slot->data.key.data,
6098 slot->data.key.bytes );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006099 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006100 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006101
6102 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006103#if defined(MBEDTLS_DES_C)
6104 if( type == PSA_KEY_TYPE_DES )
Steven Cooreman71fd80d2020-07-07 21:12:27 +02006105 psa_des_set_key_parity( slot->data.key.data,
6106 slot->data.key.bytes );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006107#endif /* MBEDTLS_DES_C */
6108 }
6109 else
6110
6111#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_GENPRIME)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02006112 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006113 {
Steven Cooremana01795d2020-07-24 22:48:15 +02006114 mbedtls_rsa_context rsa;
Janos Follath24eed8d2019-11-22 13:21:35 +00006115 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee56e8782019-04-26 17:34:02 +02006116 int exponent;
6117 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006118 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
6119 return( PSA_ERROR_NOT_SUPPORTED );
6120 /* Accept only byte-aligned keys, for the same reasons as
6121 * in psa_import_rsa_key(). */
6122 if( bits % 8 != 0 )
6123 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinee56e8782019-04-26 17:34:02 +02006124 status = psa_read_rsa_exponent( domain_parameters,
6125 domain_parameters_size,
6126 &exponent );
6127 if( status != PSA_SUCCESS )
6128 return( status );
Steven Cooremana01795d2020-07-24 22:48:15 +02006129 mbedtls_rsa_init( &rsa, MBEDTLS_RSA_PKCS_V15, MBEDTLS_MD_NONE );
6130 ret = mbedtls_rsa_gen_key( &rsa,
Gilles Peskinee59236f2018-01-27 23:32:46 +01006131 mbedtls_ctr_drbg_random,
6132 &global_data.ctr_drbg,
6133 (unsigned int) bits,
6134 exponent );
6135 if( ret != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006136 return( mbedtls_to_psa_error( ret ) );
Steven Cooremana01795d2020-07-24 22:48:15 +02006137
6138 /* Make sure to always have an export representation available */
6139 size_t bytes = PSA_KEY_EXPORT_RSA_KEY_PAIR_MAX_SIZE( bits );
6140
Steven Cooreman75b74362020-07-28 14:30:13 +02006141 status = psa_allocate_buffer_to_slot( slot, bytes );
6142 if( status != PSA_SUCCESS )
Steven Cooremana01795d2020-07-24 22:48:15 +02006143 {
6144 mbedtls_rsa_free( &rsa );
Steven Cooreman29149862020-08-05 15:43:42 +02006145 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006146 }
Steven Cooremana01795d2020-07-24 22:48:15 +02006147
6148 status = psa_export_rsa_key( type,
6149 &rsa,
6150 slot->data.key.data,
6151 bytes,
6152 &slot->data.key.bytes );
6153 mbedtls_rsa_free( &rsa );
6154 if( status != PSA_SUCCESS )
Steven Cooremana01795d2020-07-24 22:48:15 +02006155 psa_remove_key_data_from_memory( slot );
Steven Cooreman560c28a2020-07-24 23:20:24 +02006156 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006157 }
6158 else
6159#endif /* MBEDTLS_RSA_C && MBEDTLS_GENPRIME */
6160
6161#if defined(MBEDTLS_ECP_C)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02006162 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006163 {
Paul Elliott8ff510a2020-06-02 17:19:28 +01006164 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY( type );
Gilles Peskine4295e8b2019-12-02 21:39:10 +01006165 mbedtls_ecp_group_id grp_id =
6166 mbedtls_ecc_group_of_psa( curve, PSA_BITS_TO_BYTES( bits ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006167 const mbedtls_ecp_curve_info *curve_info =
6168 mbedtls_ecp_curve_info_from_grp_id( grp_id );
Steven Cooremanacda8342020-07-24 23:09:52 +02006169 mbedtls_ecp_keypair ecp;
Janos Follath24eed8d2019-11-22 13:21:35 +00006170 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee56e8782019-04-26 17:34:02 +02006171 if( domain_parameters_size != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006172 return( PSA_ERROR_NOT_SUPPORTED );
6173 if( grp_id == MBEDTLS_ECP_DP_NONE || curve_info == NULL )
6174 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooremanacda8342020-07-24 23:09:52 +02006175 mbedtls_ecp_keypair_init( &ecp );
6176 ret = mbedtls_ecp_gen_key( grp_id, &ecp,
Gilles Peskinee59236f2018-01-27 23:32:46 +01006177 mbedtls_ctr_drbg_random,
6178 &global_data.ctr_drbg );
6179 if( ret != 0 )
6180 {
Steven Cooremanacda8342020-07-24 23:09:52 +02006181 mbedtls_ecp_keypair_free( &ecp );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006182 return( mbedtls_to_psa_error( ret ) );
6183 }
Steven Cooremanacda8342020-07-24 23:09:52 +02006184
6185
6186 /* Make sure to always have an export representation available */
6187 size_t bytes = PSA_BITS_TO_BYTES( bits );
Steven Cooreman75b74362020-07-28 14:30:13 +02006188 psa_status_t status = psa_allocate_buffer_to_slot( slot, bytes );
6189 if( status != PSA_SUCCESS )
Steven Cooremanacda8342020-07-24 23:09:52 +02006190 {
6191 mbedtls_ecp_keypair_free( &ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02006192 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02006193 }
Steven Cooreman75b74362020-07-28 14:30:13 +02006194
6195 status = mbedtls_to_psa_error(
Steven Cooremanacda8342020-07-24 23:09:52 +02006196 mbedtls_ecp_write_key( &ecp, slot->data.key.data, bytes ) );
6197
6198 mbedtls_ecp_keypair_free( &ecp );
Steven Cooremanb7f6dea2020-08-05 16:07:20 +02006199 if( status != PSA_SUCCESS ) {
6200 memset( slot->data.key.data, 0, bytes );
Steven Cooremanacda8342020-07-24 23:09:52 +02006201 psa_remove_key_data_from_memory( slot );
Steven Cooremanb7f6dea2020-08-05 16:07:20 +02006202 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02006203 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006204 }
6205 else
6206#endif /* MBEDTLS_ECP_C */
Steven Cooreman29149862020-08-05 15:43:42 +02006207 {
Gilles Peskinee59236f2018-01-27 23:32:46 +01006208 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman29149862020-08-05 15:43:42 +02006209 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01006210
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006211 return( PSA_SUCCESS );
6212}
Darryl Green0c6575a2018-11-07 16:05:30 +00006213
Gilles Peskine35ef36b2019-05-16 19:42:05 +02006214psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Gilles Peskinee56e8782019-04-26 17:34:02 +02006215 psa_key_handle_t *handle )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006216{
6217 psa_status_t status;
6218 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02006219 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine11792082019-08-06 18:36:36 +02006220
Gilles Peskine0f84d622019-09-12 19:03:13 +02006221 /* Reject any attempt to create a zero-length key so that we don't
6222 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
6223 if( psa_get_key_bits( attributes ) == 0 )
6224 return( PSA_ERROR_INVALID_ARGUMENT );
6225
Gilles Peskinedf179142019-07-15 22:02:14 +02006226 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE,
6227 attributes, handle, &slot, &driver );
Gilles Peskine11792082019-08-06 18:36:36 +02006228 if( status != PSA_SUCCESS )
6229 goto exit;
6230
Steven Cooreman2a1664c2020-07-20 15:33:08 +02006231 status = psa_driver_wrapper_generate_key( attributes,
6232 slot );
6233 if( status != PSA_ERROR_NOT_SUPPORTED ||
6234 psa_key_lifetime_is_external( attributes->core.lifetime ) )
6235 goto exit;
6236
6237 status = psa_generate_key_internal(
6238 slot, attributes->core.bits,
6239 attributes->domain_parameters, attributes->domain_parameters_size );
Gilles Peskine11792082019-08-06 18:36:36 +02006240
6241exit:
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006242 if( status == PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02006243 status = psa_finish_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006244 if( status != PSA_SUCCESS )
6245 {
Gilles Peskine011e4282019-06-26 18:34:38 +02006246 psa_fail_key_creation( slot, driver );
Ronald Cron91e95152020-07-30 17:48:03 +02006247 *handle = PSA_KEY_HANDLE_INIT;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006248 }
Darryl Green0c6575a2018-11-07 16:05:30 +00006249 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006250}
6251
6252
Gilles Peskinee59236f2018-01-27 23:32:46 +01006253
6254/****************************************************************/
6255/* Module setup */
6256/****************************************************************/
6257
Gilles Peskine5e769522018-11-20 21:59:56 +01006258psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
6259 void (* entropy_init )( mbedtls_entropy_context *ctx ),
6260 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
6261{
6262 if( global_data.rng_state != RNG_NOT_INITIALIZED )
6263 return( PSA_ERROR_BAD_STATE );
6264 global_data.entropy_init = entropy_init;
6265 global_data.entropy_free = entropy_free;
6266 return( PSA_SUCCESS );
6267}
6268
Gilles Peskinee59236f2018-01-27 23:32:46 +01006269void mbedtls_psa_crypto_free( void )
6270{
Gilles Peskine66fb1262018-12-10 16:29:04 +01006271 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006272 if( global_data.rng_state != RNG_NOT_INITIALIZED )
6273 {
6274 mbedtls_ctr_drbg_free( &global_data.ctr_drbg );
Gilles Peskine5e769522018-11-20 21:59:56 +01006275 global_data.entropy_free( &global_data.entropy );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006276 }
6277 /* Wipe all remaining data, including configuration.
6278 * In particular, this sets all state indicator to the value
6279 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01006280 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Gilles Peskinea8ade162019-06-26 11:24:49 +02006281#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +02006282 /* Unregister all secure element drivers, so that we restart from
6283 * a pristine state. */
6284 psa_unregister_all_se_drivers( );
Gilles Peskinea8ade162019-06-26 11:24:49 +02006285#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006286}
6287
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006288#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
6289/** Recover a transaction that was interrupted by a power failure.
6290 *
6291 * This function is called during initialization, before psa_crypto_init()
6292 * returns. If this function returns a failure status, the initialization
6293 * fails.
6294 */
6295static psa_status_t psa_crypto_recover_transaction(
6296 const psa_crypto_transaction_t *transaction )
6297{
6298 switch( transaction->unknown.type )
6299 {
6300 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
6301 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01006302 /* TODO - fall through to the failure case until this
Gilles Peskinec9d7f942019-08-13 16:17:16 +02006303 * is implemented.
6304 * https://github.com/ARMmbed/mbed-crypto/issues/218
6305 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006306 default:
6307 /* We found an unsupported transaction in the storage.
6308 * We don't know what state the storage is in. Give up. */
6309 return( PSA_ERROR_STORAGE_FAILURE );
6310 }
6311}
6312#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
6313
Gilles Peskinee59236f2018-01-27 23:32:46 +01006314psa_status_t psa_crypto_init( void )
6315{
Gilles Peskine66fb1262018-12-10 16:29:04 +01006316 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006317 const unsigned char drbg_seed[] = "PSA";
6318
Gilles Peskinec6b69072018-11-20 21:42:52 +01006319 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006320 if( global_data.initialized != 0 )
6321 return( PSA_SUCCESS );
6322
Gilles Peskine5e769522018-11-20 21:59:56 +01006323 /* Set default configuration if
6324 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
6325 if( global_data.entropy_init == NULL )
6326 global_data.entropy_init = mbedtls_entropy_init;
6327 if( global_data.entropy_free == NULL )
6328 global_data.entropy_free = mbedtls_entropy_free;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006329
Gilles Peskinec6b69072018-11-20 21:42:52 +01006330 /* Initialize the random generator. */
Gilles Peskine5e769522018-11-20 21:59:56 +01006331 global_data.entropy_init( &global_data.entropy );
Jaeden Amero76541612019-06-04 17:14:43 +01006332#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
6333 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
6334 /* The PSA entropy injection feature depends on using NV seed as an entropy
6335 * source. Add NV seed as an entropy source for PSA entropy injection. */
6336 mbedtls_entropy_add_source( &global_data.entropy,
6337 mbedtls_nv_seed_poll, NULL,
6338 MBEDTLS_ENTROPY_BLOCK_SIZE,
6339 MBEDTLS_ENTROPY_SOURCE_STRONG );
6340#endif
Gilles Peskinee59236f2018-01-27 23:32:46 +01006341 mbedtls_ctr_drbg_init( &global_data.ctr_drbg );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006342 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine66fb1262018-12-10 16:29:04 +01006343 status = mbedtls_to_psa_error(
6344 mbedtls_ctr_drbg_seed( &global_data.ctr_drbg,
6345 mbedtls_entropy_func,
6346 &global_data.entropy,
6347 drbg_seed, sizeof( drbg_seed ) - 1 ) );
6348 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006349 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01006350 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006351
Gilles Peskine66fb1262018-12-10 16:29:04 +01006352 status = psa_initialize_key_slots( );
6353 if( status != PSA_SUCCESS )
6354 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01006355
Gilles Peskined9348f22019-10-01 15:22:29 +02006356#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
6357 status = psa_init_all_se_drivers( );
6358 if( status != PSA_SUCCESS )
6359 goto exit;
6360#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
6361
Gilles Peskine4b734222019-07-24 15:56:31 +02006362#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02006363 status = psa_crypto_load_transaction( );
6364 if( status == PSA_SUCCESS )
6365 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006366 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
6367 if( status != PSA_SUCCESS )
6368 goto exit;
6369 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02006370 }
6371 else if( status == PSA_ERROR_DOES_NOT_EXIST )
6372 {
6373 /* There's no transaction to complete. It's all good. */
6374 status = PSA_SUCCESS;
6375 }
Gilles Peskine4b734222019-07-24 15:56:31 +02006376#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02006377
Gilles Peskinec6b69072018-11-20 21:42:52 +01006378 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006379 global_data.initialized = 1;
6380
6381exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01006382 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006383 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01006384 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006385}
6386
6387#endif /* MBEDTLS_PSA_CRYPTO_C */