blob: ddb03fc32db6b41746448fc1133a33a5adfac666 [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.
742 * So its data length is 2m+1 where n is the key size in bits.
743 */
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
Gilles Peskine8e338702019-07-30 20:06:31 +0200972/** Import key data into a slot. `slot->attr.type` must have been set
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100973 * previously. This function assumes that the slot does not contain
974 * any key material yet. On failure, the slot content is unchanged. */
Gilles Peskinefa4135b2018-12-10 16:48:53 +0100975psa_status_t psa_import_key_into_slot( psa_key_slot_t *slot,
976 const uint8_t *data,
977 size_t data_length )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100978{
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200979 psa_status_t status = PSA_SUCCESS;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100980
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200981 /* zero-length keys are never supported. */
982 if( data_length == 0 )
983 return( PSA_ERROR_NOT_SUPPORTED );
984
Gilles Peskine8e338702019-07-30 20:06:31 +0200985 if( key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100986 {
Gilles Peskinec744d992019-07-30 17:26:54 +0200987 size_t bit_size = PSA_BYTES_TO_BITS( data_length );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200988
Steven Cooreman75b74362020-07-28 14:30:13 +0200989 /* Ensure that the bytes-to-bits conversion hasn't overflown. */
990 if( data_length > SIZE_MAX / 8 )
991 return( PSA_ERROR_NOT_SUPPORTED );
992
Gilles Peskine1b9505c2019-08-07 10:59:45 +0200993 /* Enforce a size limit, and in particular ensure that the bit
994 * size fits in its representation type. */
Gilles Peskinec744d992019-07-30 17:26:54 +0200995 if( bit_size > PSA_MAX_KEY_BITS )
996 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200997
998 status = validate_unstructured_key_bit_size( slot->attr.type, bit_size );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200999 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001000 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02001001
1002 /* Allocate memory for the key */
Steven Cooreman75b74362020-07-28 14:30:13 +02001003 status = psa_allocate_buffer_to_slot( slot, data_length );
1004 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001005 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02001006
1007 /* copy key into allocated buffer */
Steven Cooreman29149862020-08-05 15:43:42 +02001008 memcpy( slot->data.key.data, data, data_length );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02001009
1010 /* Write the actual key size to the slot.
1011 * psa_start_key_creation() wrote the size declared by the
1012 * caller, which may be 0 (meaning unspecified) or wrong. */
1013 slot->attr.bits = (psa_key_bits_t) bit_size;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001014 }
Steven Cooreman19fd5742020-07-24 23:31:01 +02001015 else if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
1016 {
Gilles Peskinef76aa772018-10-29 19:24:33 +01001017#if defined(MBEDTLS_ECP_C)
Steven Cooreman19fd5742020-07-24 23:31:01 +02001018 status = psa_import_ecp_key( slot,
1019 data, data_length );
1020#else
1021 /* No drivers have been implemented yet, so without mbed TLS backing
1022 * there's no way to do ECP with the current library. */
1023 return( PSA_ERROR_NOT_SUPPORTED );
1024#endif /* defined(MBEDTLS_ECP_C) */
1025 }
1026 else if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskinef76aa772018-10-29 19:24:33 +01001027 {
Steven Cooreman19fd5742020-07-24 23:31:01 +02001028#if defined(MBEDTLS_RSA_C)
1029 status = psa_import_rsa_key( slot,
1030 data, data_length );
1031#else
1032 /* No drivers have been implemented yet, so without mbed TLS backing
1033 * there's no way to do RSA with the current library. */
1034 status = PSA_ERROR_NOT_SUPPORTED;
1035#endif /* defined(MBEDTLS_RSA_C) */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001036 }
1037 else
Gilles Peskinec66ea6a2018-02-03 22:43:28 +01001038 {
Steven Cooreman19fd5742020-07-24 23:31:01 +02001039 /* Unknown key type */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001040 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969ac722018-01-28 18:16:59 +01001041 }
Darryl Green940d72c2018-07-13 13:18:51 +01001042
Darryl Green06fd18d2018-07-16 11:21:11 +01001043 return( status );
1044}
1045
Gilles Peskinef603c712019-01-19 13:40:11 +01001046/** Calculate the intersection of two algorithm usage policies.
1047 *
1048 * Return 0 (which allows no operation) on incompatibility.
1049 */
1050static psa_algorithm_t psa_key_policy_algorithm_intersection(
1051 psa_algorithm_t alg1,
1052 psa_algorithm_t alg2 )
1053{
Gilles Peskine549ea862019-05-22 11:45:59 +02001054 /* Common case: both sides actually specify the same policy. */
Gilles Peskinef603c712019-01-19 13:40:11 +01001055 if( alg1 == alg2 )
1056 return( alg1 );
1057 /* If the policies are from the same hash-and-sign family, check
1058 * if one is a wildcard. If so the other has the specific algorithm. */
1059 if( PSA_ALG_IS_HASH_AND_SIGN( alg1 ) &&
1060 PSA_ALG_IS_HASH_AND_SIGN( alg2 ) &&
1061 ( alg1 & ~PSA_ALG_HASH_MASK ) == ( alg2 & ~PSA_ALG_HASH_MASK ) )
1062 {
1063 if( PSA_ALG_SIGN_GET_HASH( alg1 ) == PSA_ALG_ANY_HASH )
1064 return( alg2 );
1065 if( PSA_ALG_SIGN_GET_HASH( alg2 ) == PSA_ALG_ANY_HASH )
1066 return( alg1 );
1067 }
1068 /* If the policies are incompatible, allow nothing. */
1069 return( 0 );
1070}
1071
Gilles Peskined6f371b2019-05-10 19:33:38 +02001072static int psa_key_algorithm_permits( psa_algorithm_t policy_alg,
1073 psa_algorithm_t requested_alg )
1074{
Gilles Peskine549ea862019-05-22 11:45:59 +02001075 /* Common case: the policy only allows requested_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +02001076 if( requested_alg == policy_alg )
1077 return( 1 );
1078 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
Gilles Peskine549ea862019-05-22 11:45:59 +02001079 * and requested_alg is the same hash-and-sign family with any hash,
1080 * then requested_alg is compliant with policy_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +02001081 if( PSA_ALG_IS_HASH_AND_SIGN( requested_alg ) &&
1082 PSA_ALG_SIGN_GET_HASH( policy_alg ) == PSA_ALG_ANY_HASH )
1083 {
1084 return( ( policy_alg & ~PSA_ALG_HASH_MASK ) ==
1085 ( requested_alg & ~PSA_ALG_HASH_MASK ) );
1086 }
Steven Cooremance48e852020-10-05 16:02:45 +02001087 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +02001088 * a key derivation with that key agreement should also be allowed. This
1089 * behaviour is expected to be defined in a future specification version. */
Steven Cooremance48e852020-10-05 16:02:45 +02001090 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( policy_alg ) &&
1091 PSA_ALG_IS_KEY_AGREEMENT( requested_alg ) )
1092 {
1093 return( PSA_ALG_KEY_AGREEMENT_GET_BASE( requested_alg ) ==
1094 policy_alg );
1095 }
Gilles Peskined6f371b2019-05-10 19:33:38 +02001096 /* If it isn't permitted, it's forbidden. */
1097 return( 0 );
1098}
1099
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001100/** Test whether a policy permits an algorithm.
1101 *
1102 * The caller must test usage flags separately.
1103 */
1104static int psa_key_policy_permits( const psa_key_policy_t *policy,
1105 psa_algorithm_t alg )
1106{
Gilles Peskined6f371b2019-05-10 19:33:38 +02001107 return( psa_key_algorithm_permits( policy->alg, alg ) ||
1108 psa_key_algorithm_permits( policy->alg2, alg ) );
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001109}
1110
Gilles Peskinef603c712019-01-19 13:40:11 +01001111/** Restrict a key policy based on a constraint.
1112 *
1113 * \param[in,out] policy The policy to restrict.
1114 * \param[in] constraint The policy constraint to apply.
1115 *
1116 * \retval #PSA_SUCCESS
1117 * \c *policy contains the intersection of the original value of
1118 * \c *policy and \c *constraint.
1119 * \retval #PSA_ERROR_INVALID_ARGUMENT
1120 * \c *policy and \c *constraint are incompatible.
1121 * \c *policy is unchanged.
1122 */
1123static psa_status_t psa_restrict_key_policy(
1124 psa_key_policy_t *policy,
1125 const psa_key_policy_t *constraint )
1126{
1127 psa_algorithm_t intersection_alg =
1128 psa_key_policy_algorithm_intersection( policy->alg, constraint->alg );
Gilles Peskined6f371b2019-05-10 19:33:38 +02001129 psa_algorithm_t intersection_alg2 =
1130 psa_key_policy_algorithm_intersection( policy->alg2, constraint->alg2 );
Gilles Peskinef603c712019-01-19 13:40:11 +01001131 if( intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0 )
1132 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskined6f371b2019-05-10 19:33:38 +02001133 if( intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0 )
1134 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinef603c712019-01-19 13:40:11 +01001135 policy->usage &= constraint->usage;
1136 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +02001137 policy->alg2 = intersection_alg2;
Gilles Peskinef603c712019-01-19 13:40:11 +01001138 return( PSA_SUCCESS );
1139}
1140
Darryl Green06fd18d2018-07-16 11:21:11 +01001141/** Retrieve a slot which must contain a key. The key must have allow all the
1142 * usage flags set in \p usage. If \p alg is nonzero, the key must allow
1143 * operations with this algorithm. */
Gilles Peskinec5487a82018-12-03 18:08:14 +01001144static psa_status_t psa_get_key_from_slot( psa_key_handle_t handle,
Gilles Peskine2f060a82018-12-04 17:12:32 +01001145 psa_key_slot_t **p_slot,
Darryl Green06fd18d2018-07-16 11:21:11 +01001146 psa_key_usage_t usage,
1147 psa_algorithm_t alg )
1148{
1149 psa_status_t status;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001150 psa_key_slot_t *slot = NULL;
Darryl Green06fd18d2018-07-16 11:21:11 +01001151
1152 *p_slot = NULL;
1153
Gilles Peskinec5487a82018-12-03 18:08:14 +01001154 status = psa_get_key_slot( handle, &slot );
Darryl Green06fd18d2018-07-16 11:21:11 +01001155 if( status != PSA_SUCCESS )
1156 return( status );
Darryl Green06fd18d2018-07-16 11:21:11 +01001157
1158 /* Enforce that usage policy for the key slot contains all the flags
1159 * required by the usage parameter. There is one exception: public
1160 * keys can always be exported, so we treat public key objects as
1161 * if they had the export flag. */
Gilles Peskine8e338702019-07-30 20:06:31 +02001162 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Darryl Green06fd18d2018-07-16 11:21:11 +01001163 usage &= ~PSA_KEY_USAGE_EXPORT;
Gilles Peskine8e338702019-07-30 20:06:31 +02001164 if( ( slot->attr.policy.usage & usage ) != usage )
Darryl Green06fd18d2018-07-16 11:21:11 +01001165 return( PSA_ERROR_NOT_PERMITTED );
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001166
1167 /* Enforce that the usage policy permits the requested algortihm. */
Gilles Peskine8e338702019-07-30 20:06:31 +02001168 if( alg != 0 && ! psa_key_policy_permits( &slot->attr.policy, alg ) )
Darryl Green06fd18d2018-07-16 11:21:11 +01001169 return( PSA_ERROR_NOT_PERMITTED );
1170
1171 *p_slot = slot;
1172 return( PSA_SUCCESS );
1173}
Darryl Green940d72c2018-07-13 13:18:51 +01001174
Gilles Peskine28f8f302019-07-24 13:30:31 +02001175/** Retrieve a slot which must contain a transparent key.
1176 *
1177 * A transparent key is a key for which the key material is directly
1178 * available, as opposed to a key in a secure element.
1179 *
Gilles Peskine60450a42019-07-25 11:32:45 +02001180 * This is a temporary function to use instead of psa_get_key_from_slot()
1181 * until secure element support is fully implemented.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001182 */
1183#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1184static psa_status_t psa_get_transparent_key( psa_key_handle_t handle,
1185 psa_key_slot_t **p_slot,
1186 psa_key_usage_t usage,
1187 psa_algorithm_t alg )
1188{
1189 psa_status_t status = psa_get_key_from_slot( handle, p_slot, usage, alg );
1190 if( status != PSA_SUCCESS )
1191 return( status );
Gilles Peskineadad8132019-07-25 11:31:23 +02001192 if( psa_key_slot_is_external( *p_slot ) )
Gilles Peskine28f8f302019-07-24 13:30:31 +02001193 {
1194 *p_slot = NULL;
1195 return( PSA_ERROR_NOT_SUPPORTED );
1196 }
1197 return( PSA_SUCCESS );
1198}
1199#else /* MBEDTLS_PSA_CRYPTO_SE_C */
1200/* With no secure element support, all keys are transparent. */
1201#define psa_get_transparent_key( handle, p_slot, usage, alg ) \
1202 psa_get_key_from_slot( handle, p_slot, usage, alg )
1203#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1204
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001205/** Wipe key data from a slot. Preserve metadata such as the policy. */
Gilles Peskine2f060a82018-12-04 17:12:32 +01001206static psa_status_t psa_remove_key_data_from_memory( psa_key_slot_t *slot )
Darryl Green40225ba2018-11-15 14:48:15 +00001207{
Gilles Peskine73167e12019-07-12 23:44:37 +02001208#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1209 if( psa_key_slot_is_external( slot ) )
Darryl Green40225ba2018-11-15 14:48:15 +00001210 {
1211 /* No key material to clean. */
1212 }
Gilles Peskine73167e12019-07-12 23:44:37 +02001213 else
1214#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Darryl Green40225ba2018-11-15 14:48:15 +00001215 {
Steven Cooremanfd4d69a2020-08-05 15:46:33 +02001216 /* Data pointer will always be either a valid pointer or NULL in an
1217 * initialized slot, so we can just free it. */
1218 if( slot->data.key.data != NULL )
1219 mbedtls_platform_zeroize( slot->data.key.data, slot->data.key.bytes);
Steven Cooremana01795d2020-07-24 22:48:15 +02001220 mbedtls_free( slot->data.key.data );
1221 slot->data.key.data = NULL;
1222 slot->data.key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +00001223 }
Darryl Green40225ba2018-11-15 14:48:15 +00001224
1225 return( PSA_SUCCESS );
1226}
1227
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001228/** Completely wipe a slot in memory, including its policy.
1229 * Persistent storage is not affected. */
Gilles Peskine66fb1262018-12-10 16:29:04 +01001230psa_status_t psa_wipe_key_slot( psa_key_slot_t *slot )
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001231{
1232 psa_status_t status = psa_remove_key_data_from_memory( slot );
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001233 /* Multipart operations may still be using the key. This is safe
1234 * because all multipart operation objects are independent from
1235 * the key slot: if they need to access the key after the setup
1236 * phase, they have a copy of the key. Note that this means that
1237 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001238 /* At this point, key material and other type-specific content has
1239 * been wiped. Clear remaining metadata. We can call memset and not
1240 * zeroize because the metadata is not particularly sensitive. */
1241 memset( slot, 0, sizeof( *slot ) );
1242 return( status );
1243}
1244
Gilles Peskinec5487a82018-12-03 18:08:14 +01001245psa_status_t psa_destroy_key( psa_key_handle_t handle )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001246{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001247 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001248 psa_status_t status; /* status of the last operation */
1249 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001250#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1251 psa_se_drv_table_entry_t *driver;
1252#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001253
Gilles Peskine1841cf42019-10-08 15:48:25 +02001254 if( handle == 0 )
1255 return( PSA_SUCCESS );
1256
Gilles Peskinec5487a82018-12-03 18:08:14 +01001257 status = psa_get_key_slot( handle, &slot );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001258 if( status != PSA_SUCCESS )
1259 return( status );
Gilles Peskine354f7672019-07-12 23:46:38 +02001260
1261#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001262 driver = psa_get_se_driver_entry( slot->attr.lifetime );
Gilles Peskine354f7672019-07-12 23:46:38 +02001263 if( driver != NULL )
Gilles Peskinefc762652019-07-22 19:30:34 +02001264 {
Gilles Peskine60450a42019-07-25 11:32:45 +02001265 /* For a key in a secure element, we need to do three things:
1266 * remove the key file in internal storage, destroy the
1267 * key inside the secure element, and update the driver's
1268 * persistent data. Start a transaction that will encompass these
1269 * three actions. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001270 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_DESTROY_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +02001271 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Gilles Peskinefc762652019-07-22 19:30:34 +02001272 psa_crypto_transaction.key.slot = slot->data.se.slot_number;
Gilles Peskine8e338702019-07-30 20:06:31 +02001273 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskinefc762652019-07-22 19:30:34 +02001274 status = psa_crypto_save_transaction( );
1275 if( status != PSA_SUCCESS )
1276 {
Gilles Peskine66be51c2019-07-25 18:02:52 +02001277 (void) psa_crypto_stop_transaction( );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001278 /* We should still try to destroy the key in the secure
1279 * element and the key metadata in storage. This is especially
1280 * important if the error is that the storage is full.
1281 * But how to do it exactly without risking an inconsistent
1282 * state after a reset?
1283 * https://github.com/ARMmbed/mbed-crypto/issues/215
1284 */
1285 overall_status = status;
1286 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001287 }
1288
Gilles Peskine354f7672019-07-12 23:46:38 +02001289 status = psa_destroy_se_key( driver, slot->data.se.slot_number );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001290 if( overall_status == PSA_SUCCESS )
1291 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001292 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001293#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1294
Darryl Greend49a4992018-06-18 17:27:26 +01001295#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskinecaec2782019-08-13 15:11:49 +02001296 if( slot->attr.lifetime != PSA_KEY_LIFETIME_VOLATILE )
Darryl Greend49a4992018-06-18 17:27:26 +01001297 {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001298 status = psa_destroy_persistent_key( slot->attr.id );
1299 if( overall_status == PSA_SUCCESS )
1300 overall_status = status;
1301
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001302 /* TODO: other slots may have a copy of the same key. We should
1303 * invalidate them.
1304 * https://github.com/ARMmbed/mbed-crypto/issues/214
1305 */
Darryl Greend49a4992018-06-18 17:27:26 +01001306 }
1307#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001308
Gilles Peskinefc762652019-07-22 19:30:34 +02001309#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1310 if( driver != NULL )
1311 {
Gilles Peskine725f22a2019-07-25 11:31:48 +02001312 status = psa_save_se_persistent_data( driver );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001313 if( overall_status == PSA_SUCCESS )
1314 overall_status = status;
1315 status = psa_crypto_stop_transaction( );
1316 if( overall_status == PSA_SUCCESS )
1317 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001318 }
1319#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1320
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001321#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1322exit:
1323#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001324 status = psa_wipe_key_slot( slot );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001325 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
1326 if( overall_status == PSA_SUCCESS )
1327 overall_status = status;
1328 return( overall_status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001329}
1330
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001331void psa_reset_key_attributes( psa_key_attributes_t *attributes )
Gilles Peskineb870b182018-07-06 16:02:09 +02001332{
Gilles Peskineb699f072019-04-26 16:06:02 +02001333 mbedtls_free( attributes->domain_parameters );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001334 memset( attributes, 0, sizeof( *attributes ) );
Gilles Peskineb870b182018-07-06 16:02:09 +02001335}
1336
Gilles Peskineb699f072019-04-26 16:06:02 +02001337psa_status_t psa_set_key_domain_parameters( psa_key_attributes_t *attributes,
1338 psa_key_type_t type,
1339 const uint8_t *data,
1340 size_t data_length )
1341{
1342 uint8_t *copy = NULL;
1343
1344 if( data_length != 0 )
1345 {
1346 copy = mbedtls_calloc( 1, data_length );
1347 if( copy == NULL )
1348 return( PSA_ERROR_INSUFFICIENT_MEMORY );
1349 memcpy( copy, data, data_length );
1350 }
1351 /* After this point, this function is guaranteed to succeed, so it
1352 * can start modifying `*attributes`. */
1353
1354 if( attributes->domain_parameters != NULL )
1355 {
1356 mbedtls_free( attributes->domain_parameters );
1357 attributes->domain_parameters = NULL;
1358 attributes->domain_parameters_size = 0;
1359 }
1360
1361 attributes->domain_parameters = copy;
1362 attributes->domain_parameters_size = data_length;
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001363 attributes->core.type = type;
Gilles Peskineb699f072019-04-26 16:06:02 +02001364 return( PSA_SUCCESS );
1365}
1366
1367psa_status_t psa_get_key_domain_parameters(
1368 const psa_key_attributes_t *attributes,
1369 uint8_t *data, size_t data_size, size_t *data_length )
1370{
1371 if( attributes->domain_parameters_size > data_size )
1372 return( PSA_ERROR_BUFFER_TOO_SMALL );
1373 *data_length = attributes->domain_parameters_size;
1374 if( attributes->domain_parameters_size != 0 )
1375 memcpy( data, attributes->domain_parameters,
1376 attributes->domain_parameters_size );
1377 return( PSA_SUCCESS );
1378}
1379
1380#if defined(MBEDTLS_RSA_C)
1381static psa_status_t psa_get_rsa_public_exponent(
1382 const mbedtls_rsa_context *rsa,
1383 psa_key_attributes_t *attributes )
1384{
1385 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001386 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001387 uint8_t *buffer = NULL;
1388 size_t buflen;
1389 mbedtls_mpi_init( &mpi );
1390
1391 ret = mbedtls_rsa_export( rsa, NULL, NULL, NULL, NULL, &mpi );
1392 if( ret != 0 )
1393 goto exit;
Gilles Peskine772c8b12019-04-26 17:37:21 +02001394 if( mbedtls_mpi_cmp_int( &mpi, 65537 ) == 0 )
1395 {
1396 /* It's the default value, which is reported as an empty string,
1397 * so there's nothing to do. */
1398 goto exit;
1399 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001400
1401 buflen = mbedtls_mpi_size( &mpi );
1402 buffer = mbedtls_calloc( 1, buflen );
1403 if( buffer == NULL )
1404 {
1405 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1406 goto exit;
1407 }
1408 ret = mbedtls_mpi_write_binary( &mpi, buffer, buflen );
1409 if( ret != 0 )
1410 goto exit;
1411 attributes->domain_parameters = buffer;
1412 attributes->domain_parameters_size = buflen;
1413
1414exit:
1415 mbedtls_mpi_free( &mpi );
1416 if( ret != 0 )
1417 mbedtls_free( buffer );
1418 return( mbedtls_to_psa_error( ret ) );
1419}
1420#endif /* MBEDTLS_RSA_C */
1421
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001422/** Retrieve all the publicly-accessible attributes of a key.
1423 */
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001424psa_status_t psa_get_key_attributes( psa_key_handle_t handle,
1425 psa_key_attributes_t *attributes )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001426{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001427 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001428 psa_status_t status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001429
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001430 psa_reset_key_attributes( attributes );
1431
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001432 status = psa_get_key_from_slot( handle, &slot, 0, 0 );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001433 if( status != PSA_SUCCESS )
1434 return( status );
Gilles Peskineb870b182018-07-06 16:02:09 +02001435
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001436 attributes->core = slot->attr;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001437 attributes->core.flags &= ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1438 MBEDTLS_PSA_KA_MASK_DUAL_USE );
1439
1440#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1441 if( psa_key_slot_is_external( slot ) )
1442 psa_set_key_slot_number( attributes, slot->data.se.slot_number );
1443#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001444
Gilles Peskine8e338702019-07-30 20:06:31 +02001445 switch( slot->attr.type )
Gilles Peskineb699f072019-04-26 16:06:02 +02001446 {
1447#if defined(MBEDTLS_RSA_C)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001448 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001449 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001450#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001451 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001452 * is not yet implemented.
1453 * https://github.com/ARMmbed/mbed-crypto/issues/216
1454 */
Gilles Peskinec8000c02019-08-02 20:15:51 +02001455 if( psa_key_slot_is_external( slot ) )
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001456 break;
1457#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Steven Cooremana01795d2020-07-24 22:48:15 +02001458 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001459 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001460
Steven Cooreman4fed4552020-08-03 14:46:03 +02001461 status = psa_load_rsa_representation( slot->attr.type,
1462 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02001463 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02001464 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001465 if( status != PSA_SUCCESS )
1466 break;
1467
Steven Cooremana2371e52020-07-28 14:30:39 +02001468 status = psa_get_rsa_public_exponent( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02001469 attributes );
Steven Cooremana2371e52020-07-28 14:30:39 +02001470 mbedtls_rsa_free( rsa );
1471 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001472 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001473 break;
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001474#endif /* MBEDTLS_RSA_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001475 default:
1476 /* Nothing else to do. */
1477 break;
1478 }
1479
1480 if( status != PSA_SUCCESS )
1481 psa_reset_key_attributes( attributes );
1482 return( status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001483}
1484
Gilles Peskinec8000c02019-08-02 20:15:51 +02001485#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1486psa_status_t psa_get_key_slot_number(
1487 const psa_key_attributes_t *attributes,
1488 psa_key_slot_number_t *slot_number )
1489{
1490 if( attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER )
1491 {
1492 *slot_number = attributes->slot_number;
1493 return( PSA_SUCCESS );
1494 }
1495 else
1496 return( PSA_ERROR_INVALID_ARGUMENT );
1497}
1498#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1499
Steven Cooremana01795d2020-07-24 22:48:15 +02001500static psa_status_t psa_internal_export_key_buffer( const psa_key_slot_t *slot,
1501 uint8_t *data,
1502 size_t data_size,
1503 size_t *data_length )
1504{
1505 if( slot->data.key.bytes > data_size )
1506 return( PSA_ERROR_BUFFER_TOO_SMALL );
1507 memcpy( data, slot->data.key.data, slot->data.key.bytes );
1508 memset( data + slot->data.key.bytes, 0,
1509 data_size - slot->data.key.bytes );
1510 *data_length = slot->data.key.bytes;
1511 return( PSA_SUCCESS );
1512}
1513
Gilles Peskinef603c712019-01-19 13:40:11 +01001514static psa_status_t psa_internal_export_key( const psa_key_slot_t *slot,
1515 uint8_t *data,
1516 size_t data_size,
1517 size_t *data_length,
1518 int export_public_key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001519{
Gilles Peskine5d309672019-07-12 23:47:28 +02001520#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1521 const psa_drv_se_t *drv;
1522 psa_drv_se_context_t *drv_context;
1523#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1524
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001525 *data_length = 0;
1526
Gilles Peskine8e338702019-07-30 20:06:31 +02001527 if( export_public_key && ! PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
Moran Pekera998bc62018-04-16 18:16:20 +03001528 return( PSA_ERROR_INVALID_ARGUMENT );
mohammad160306e79202018-03-28 13:17:44 +03001529
Gilles Peskinef9168942019-09-12 19:20:29 +02001530 /* Reject a zero-length output buffer now, since this can never be a
1531 * valid key representation. This way we know that data must be a valid
1532 * pointer and we can do things like memset(data, ..., data_size). */
1533 if( data_size == 0 )
1534 return( PSA_ERROR_BUFFER_TOO_SMALL );
1535
Gilles Peskine5d309672019-07-12 23:47:28 +02001536#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001537 if( psa_get_se_driver( slot->attr.lifetime, &drv, &drv_context ) )
Gilles Peskine5d309672019-07-12 23:47:28 +02001538 {
1539 psa_drv_se_export_key_t method;
1540 if( drv->key_management == NULL )
1541 return( PSA_ERROR_NOT_SUPPORTED );
1542 method = ( export_public_key ?
1543 drv->key_management->p_export_public :
1544 drv->key_management->p_export );
1545 if( method == NULL )
1546 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine2e0f3882019-07-25 11:34:33 +02001547 return( method( drv_context,
1548 slot->data.se.slot_number,
1549 data, data_size, data_length ) );
Gilles Peskine5d309672019-07-12 23:47:28 +02001550 }
1551#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1552
Gilles Peskine8e338702019-07-30 20:06:31 +02001553 if( key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001554 {
Steven Cooremanacda8342020-07-24 23:09:52 +02001555 return( psa_internal_export_key_buffer( slot, data, data_size, data_length ) );
Gilles Peskine188c71e2018-10-29 19:26:02 +01001556 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001557 else if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) ||
1558 PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
Moran Peker17e36e12018-05-02 12:55:20 +03001559 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001560 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Gilles Peskine969ac722018-01-28 18:16:59 +01001561 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001562 /* Exporting public -> public */
1563 return( psa_internal_export_key_buffer( slot, data, data_size, data_length ) );
1564 }
1565 else if( !export_public_key )
1566 {
1567 /* Exporting private -> private */
1568 return( psa_internal_export_key_buffer( slot, data, data_size, data_length ) );
1569 }
1570 /* Need to export the public part of a private key,
1571 * so conversion is needed */
1572 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
1573 {
Darryl Green9e2d7a02018-07-24 16:33:30 +01001574#if defined(MBEDTLS_RSA_C)
Steven Cooremana2371e52020-07-28 14:30:39 +02001575 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman7f391872020-07-30 14:57:44 +02001576 psa_status_t status = psa_load_rsa_representation(
Steven Cooreman4fed4552020-08-03 14:46:03 +02001577 slot->attr.type,
Steven Cooreman7f391872020-07-30 14:57:44 +02001578 slot->data.key.data,
1579 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02001580 &rsa );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001581 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001582 return( status );
Steven Cooremana01795d2020-07-24 22:48:15 +02001583
Steven Cooreman560c28a2020-07-24 23:20:24 +02001584 status = psa_export_rsa_key( PSA_KEY_TYPE_RSA_PUBLIC_KEY,
Steven Cooremana2371e52020-07-28 14:30:39 +02001585 rsa,
Steven Cooreman560c28a2020-07-24 23:20:24 +02001586 data,
1587 data_size,
1588 data_length );
Steven Cooremana01795d2020-07-24 22:48:15 +02001589
Steven Cooremana2371e52020-07-28 14:30:39 +02001590 mbedtls_rsa_free( rsa );
1591 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001592
Steven Cooreman560c28a2020-07-24 23:20:24 +02001593 return( status );
Darryl Green9e2d7a02018-07-24 16:33:30 +01001594#else
Steven Cooreman560c28a2020-07-24 23:20:24 +02001595 /* We don't know how to convert a private RSA key to public. */
1596 return( PSA_ERROR_NOT_SUPPORTED );
Darryl Green9e2d7a02018-07-24 16:33:30 +01001597#endif
Gilles Peskine969ac722018-01-28 18:16:59 +01001598 }
1599 else
Moran Pekera998bc62018-04-16 18:16:20 +03001600 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001601#if defined(MBEDTLS_ECP_C)
Steven Cooremana2371e52020-07-28 14:30:39 +02001602 mbedtls_ecp_keypair *ecp = NULL;
Steven Cooreman7f391872020-07-30 14:57:44 +02001603 psa_status_t status = psa_load_ecp_representation(
Steven Cooreman4fed4552020-08-03 14:46:03 +02001604 slot->attr.type,
Steven Cooreman7f391872020-07-30 14:57:44 +02001605 slot->data.key.data,
1606 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02001607 &ecp );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001608 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001609 return( status );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001610
1611 status = psa_export_ecp_key( PSA_KEY_TYPE_ECC_PUBLIC_KEY(
1612 PSA_KEY_TYPE_ECC_GET_FAMILY(
1613 slot->attr.type ) ),
Steven Cooremana2371e52020-07-28 14:30:39 +02001614 ecp,
Steven Cooreman560c28a2020-07-24 23:20:24 +02001615 data,
1616 data_size,
1617 data_length );
1618
Steven Cooremana2371e52020-07-28 14:30:39 +02001619 mbedtls_ecp_keypair_free( ecp );
1620 mbedtls_free( ecp );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001621 return( status );
1622#else
1623 /* We don't know how to convert a private ECC key to public */
Moran Pekera998bc62018-04-16 18:16:20 +03001624 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001625#endif
Moran Pekera998bc62018-04-16 18:16:20 +03001626 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001627 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001628 else
1629 {
1630 /* This shouldn't happen in the reference implementation, but
1631 it is valid for a special-purpose implementation to omit
1632 support for exporting certain key types. */
1633 return( PSA_ERROR_NOT_SUPPORTED );
1634 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001635}
1636
Gilles Peskinec5487a82018-12-03 18:08:14 +01001637psa_status_t psa_export_key( psa_key_handle_t handle,
Gilles Peskine2d277862018-06-18 15:41:12 +02001638 uint8_t *data,
1639 size_t data_size,
1640 size_t *data_length )
Moran Pekera998bc62018-04-16 18:16:20 +03001641{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001642 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001643 psa_status_t status;
1644
1645 /* Set the key to empty now, so that even when there are errors, we always
1646 * set data_length to a value between 0 and data_size. On error, setting
1647 * the key to empty is a good choice because an empty key representation is
1648 * unlikely to be accepted anywhere. */
1649 *data_length = 0;
1650
1651 /* Export requires the EXPORT flag. There is an exception for public keys,
1652 * which don't require any flag, but psa_get_key_from_slot takes
1653 * care of this. */
Gilles Peskinec5487a82018-12-03 18:08:14 +01001654 status = psa_get_key_from_slot( handle, &slot, PSA_KEY_USAGE_EXPORT, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001655 if( status != PSA_SUCCESS )
1656 return( status );
1657 return( psa_internal_export_key( slot, data, data_size,
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02001658 data_length, 0 ) );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001659}
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001660
Gilles Peskinec5487a82018-12-03 18:08:14 +01001661psa_status_t psa_export_public_key( psa_key_handle_t handle,
Gilles Peskine2d277862018-06-18 15:41:12 +02001662 uint8_t *data,
1663 size_t data_size,
1664 size_t *data_length )
Moran Pekerdd4ea382018-04-03 15:30:03 +03001665{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001666 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001667 psa_status_t status;
1668
1669 /* Set the key to empty now, so that even when there are errors, we always
1670 * set data_length to a value between 0 and data_size. On error, setting
1671 * the key to empty is a good choice because an empty key representation is
1672 * unlikely to be accepted anywhere. */
1673 *data_length = 0;
1674
1675 /* Exporting a public key doesn't require a usage flag. */
Gilles Peskinec5487a82018-12-03 18:08:14 +01001676 status = psa_get_key_from_slot( handle, &slot, 0, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001677 if( status != PSA_SUCCESS )
1678 return( status );
1679 return( psa_internal_export_key( slot, data, data_size,
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02001680 data_length, 1 ) );
Moran Pekerdd4ea382018-04-03 15:30:03 +03001681}
1682
Gilles Peskine91e8c332019-08-02 19:19:39 +02001683#if defined(static_assert)
1684static_assert( ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
1685 "One or more key attribute flag is listed as both external-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001686static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
Gilles Peskine094dac12019-08-07 18:19:46 +02001687 "One or more key attribute flag is listed as both internal-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001688static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY ) == 0,
Gilles Peskine91e8c332019-08-02 19:19:39 +02001689 "One or more key attribute flag is listed as both internal-only and external-only" );
1690#endif
1691
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001692/** Validate that a key policy is internally well-formed.
1693 *
1694 * This function only rejects invalid policies. It does not validate the
1695 * consistency of the policy with respect to other attributes of the key
1696 * such as the key type.
1697 */
1698static psa_status_t psa_validate_key_policy( const psa_key_policy_t *policy )
Gilles Peskine4747d192019-04-17 15:05:45 +02001699{
1700 if( ( policy->usage & ~( PSA_KEY_USAGE_EXPORT |
Gilles Peskine8e0206a2019-05-14 14:24:28 +02001701 PSA_KEY_USAGE_COPY |
Gilles Peskine4747d192019-04-17 15:05:45 +02001702 PSA_KEY_USAGE_ENCRYPT |
1703 PSA_KEY_USAGE_DECRYPT |
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001704 PSA_KEY_USAGE_SIGN_HASH |
1705 PSA_KEY_USAGE_VERIFY_HASH |
Gilles Peskine4747d192019-04-17 15:05:45 +02001706 PSA_KEY_USAGE_DERIVE ) ) != 0 )
1707 return( PSA_ERROR_INVALID_ARGUMENT );
1708
Gilles Peskine4747d192019-04-17 15:05:45 +02001709 return( PSA_SUCCESS );
1710}
1711
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001712/** Validate the internal consistency of key attributes.
1713 *
1714 * This function only rejects invalid attribute values. If does not
1715 * validate the consistency of the attributes with any key data that may
1716 * be involved in the creation of the key.
1717 *
1718 * Call this function early in the key creation process.
1719 *
1720 * \param[in] attributes Key attributes for the new key.
1721 * \param[out] p_drv On any return, the driver for the key, if any.
1722 * NULL for a transparent key.
1723 *
1724 */
1725static psa_status_t psa_validate_key_attributes(
1726 const psa_key_attributes_t *attributes,
1727 psa_se_drv_table_entry_t **p_drv )
Darryl Green0c6575a2018-11-07 16:05:30 +00001728{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001729 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001730
Steven Cooreman8c1e7592020-06-17 14:52:05 +02001731 status = psa_validate_key_location( psa_get_key_lifetime( attributes ),
1732 p_drv );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001733 if( status != PSA_SUCCESS )
1734 return( status );
1735
Steven Cooreman8c1e7592020-06-17 14:52:05 +02001736 status = psa_validate_key_persistence( psa_get_key_lifetime( attributes ),
1737 psa_get_key_id( attributes ) );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001738 if( status != PSA_SUCCESS )
1739 return( status );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001740
1741 status = psa_validate_key_policy( &attributes->core.policy );
Darryl Green0c6575a2018-11-07 16:05:30 +00001742 if( status != PSA_SUCCESS )
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001743 return( status );
1744
1745 /* Refuse to create overly large keys.
1746 * Note that this doesn't trigger on import if the attributes don't
1747 * explicitly specify a size (so psa_get_key_bits returns 0), so
1748 * psa_import_key() needs its own checks. */
1749 if( psa_get_key_bits( attributes ) > PSA_MAX_KEY_BITS )
1750 return( PSA_ERROR_NOT_SUPPORTED );
1751
Gilles Peskine91e8c332019-08-02 19:19:39 +02001752 /* Reject invalid flags. These should not be reachable through the API. */
1753 if( attributes->core.flags & ~ ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1754 MBEDTLS_PSA_KA_MASK_DUAL_USE ) )
1755 return( PSA_ERROR_INVALID_ARGUMENT );
1756
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001757 return( PSA_SUCCESS );
1758}
1759
Gilles Peskine4747d192019-04-17 15:05:45 +02001760/** Prepare a key slot to receive key material.
1761 *
1762 * This function allocates a key slot and sets its metadata.
1763 *
1764 * If this function fails, call psa_fail_key_creation().
1765 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001766 * This function is intended to be used as follows:
1767 * -# Call psa_start_key_creation() to allocate a key slot, prepare
1768 * it with the specified attributes, and assign it a handle.
1769 * -# Populate the slot with the key material.
1770 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1771 * In case of failure at any step, stop the sequence and call
1772 * psa_fail_key_creation().
1773 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001774 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001775 * \param[in] attributes Key attributes for the new key.
1776 * \param[out] handle On success, a handle for the allocated slot.
1777 * \param[out] p_slot On success, a pointer to the prepared slot.
1778 * \param[out] p_drv On any return, the driver for the key, if any.
1779 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001780 *
1781 * \retval #PSA_SUCCESS
1782 * The key slot is ready to receive key material.
1783 * \return If this function fails, the key slot is an invalid state.
1784 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001785 */
1786static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001787 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001788 const psa_key_attributes_t *attributes,
1789 psa_key_handle_t *handle,
Gilles Peskine011e4282019-06-26 18:34:38 +02001790 psa_key_slot_t **p_slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001791 psa_se_drv_table_entry_t **p_drv )
Gilles Peskine4747d192019-04-17 15:05:45 +02001792{
1793 psa_status_t status;
1794 psa_key_slot_t *slot;
1795
Gilles Peskinedf179142019-07-15 22:02:14 +02001796 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001797 *p_drv = NULL;
1798
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001799 status = psa_validate_key_attributes( attributes, p_drv );
1800 if( status != PSA_SUCCESS )
1801 return( status );
1802
Gilles Peskineedbed562019-08-07 18:19:59 +02001803 status = psa_get_empty_key_slot( handle, p_slot );
Gilles Peskine4747d192019-04-17 15:05:45 +02001804 if( status != PSA_SUCCESS )
1805 return( status );
1806 slot = *p_slot;
1807
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001808 /* We're storing the declared bit-size of the key. It's up to each
1809 * creation mechanism to verify that this information is correct.
1810 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001811 * an input (generate, device) but not for those where the bit-size
1812 * is optional (import, copy). */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001813
1814 slot->attr = attributes->core;
Gilles Peskinec744d992019-07-30 17:26:54 +02001815
Gilles Peskine91e8c332019-08-02 19:19:39 +02001816 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001817 * external-only flags, query `attributes`. Thanks to the check
1818 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001819 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001820 * may have set. */
1821 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001822
Gilles Peskinecbaff462019-07-12 23:46:04 +02001823#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001824 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001825 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001826 * create the key file in internal storage, create the
1827 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001828 * persistent data. This is done by starting a transaction that will
1829 * encompass these three actions.
1830 * For registering a volatile key, we just need to find an appropriate
1831 * slot number inside the SE. Since the key is designated volatile, creating
1832 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001833 /* The first thing to do is to find a slot number for the new key.
1834 * We save the slot number in persistent storage as part of the
1835 * transaction data. It will be needed to recover if the power
1836 * fails during the key creation process, to clean up on the secure
1837 * element side after restarting. Obtaining a slot number from the
1838 * secure element driver updates its persistent state, but we do not yet
1839 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001840 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001841 if( *p_drv != NULL )
Darryl Green0c6575a2018-11-07 16:05:30 +00001842 {
Gilles Peskinee88c2c12019-08-05 16:44:14 +02001843 status = psa_find_se_slot_for_key( attributes, method, *p_drv,
Gilles Peskinecbaff462019-07-12 23:46:04 +02001844 &slot->data.se.slot_number );
1845 if( status != PSA_SUCCESS )
1846 return( status );
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001847
1848 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( attributes->core.lifetime ) )
Gilles Peskine66be51c2019-07-25 18:02:52 +02001849 {
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001850 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_CREATE_KEY );
1851 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
1852 psa_crypto_transaction.key.slot = slot->data.se.slot_number;
1853 psa_crypto_transaction.key.id = slot->attr.id;
1854 status = psa_crypto_save_transaction( );
1855 if( status != PSA_SUCCESS )
1856 {
1857 (void) psa_crypto_stop_transaction( );
1858 return( status );
1859 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001860 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001861 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001862
1863 if( *p_drv == NULL && method == PSA_KEY_CREATION_REGISTER )
1864 {
1865 /* Key registration only makes sense with a secure element. */
1866 return( PSA_ERROR_INVALID_ARGUMENT );
1867 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001868#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1869
Darryl Green0c6575a2018-11-07 16:05:30 +00001870 return( status );
1871}
Gilles Peskine4747d192019-04-17 15:05:45 +02001872
1873/** Finalize the creation of a key once its key material has been set.
1874 *
1875 * This entails writing the key to persistent storage.
1876 *
1877 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001878 * See the documentation of psa_start_key_creation() for the intended use
1879 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001880 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001881 * \param[in,out] slot Pointer to the slot with key material.
1882 * \param[in] driver The secure element driver for the key,
1883 * or NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001884 *
1885 * \retval #PSA_SUCCESS
1886 * The key was successfully created. The handle is now valid.
1887 * \return If this function fails, the key slot is an invalid state.
1888 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001889 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001890static psa_status_t psa_finish_key_creation(
1891 psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001892 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001893{
1894 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001895 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001896 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001897
1898#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Steven Cooremanc59de6a2020-06-08 18:28:25 +02001899 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Gilles Peskine4747d192019-04-17 15:05:45 +02001900 {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001901#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1902 if( driver != NULL )
1903 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001904 psa_se_key_data_storage_t data;
1905#if defined(static_assert)
1906 static_assert( sizeof( slot->data.se.slot_number ) ==
1907 sizeof( data.slot_number ),
1908 "Slot number size does not match psa_se_key_data_storage_t" );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001909#endif
1910 memcpy( &data.slot_number, &slot->data.se.slot_number,
1911 sizeof( slot->data.se.slot_number ) );
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001912 status = psa_save_persistent_key( &slot->attr,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001913 (uint8_t*) &data,
1914 sizeof( data ) );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001915 }
1916 else
1917#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1918 {
Gilles Peskinee60d1d02019-07-24 20:27:59 +02001919 size_t buffer_size =
Gilles Peskine8e338702019-07-30 20:06:31 +02001920 PSA_KEY_EXPORT_MAX_SIZE( slot->attr.type,
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001921 slot->attr.bits );
Gilles Peskinee60d1d02019-07-24 20:27:59 +02001922 uint8_t *buffer = mbedtls_calloc( 1, buffer_size );
1923 size_t length = 0;
Gilles Peskinef9168942019-09-12 19:20:29 +02001924 if( buffer == NULL )
Gilles Peskine1df83d42019-07-23 16:13:14 +02001925 return( PSA_ERROR_INSUFFICIENT_MEMORY );
1926 status = psa_internal_export_key( slot,
1927 buffer, buffer_size, &length,
1928 0 );
Gilles Peskinee60d1d02019-07-24 20:27:59 +02001929 if( status == PSA_SUCCESS )
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001930 status = psa_save_persistent_key( &slot->attr,
Gilles Peskine4ed0e6f2019-07-30 20:22:33 +02001931 buffer, length );
Gilles Peskine4747d192019-04-17 15:05:45 +02001932
Gilles Peskinef9168942019-09-12 19:20:29 +02001933 mbedtls_platform_zeroize( buffer, buffer_size );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001934 mbedtls_free( buffer );
1935 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001936 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001937#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1938
Gilles Peskinecbaff462019-07-12 23:46:04 +02001939#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001940 /* Finish the transaction for a key creation. This does not
1941 * happen when registering an existing key. Detect this case
1942 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001943 * creation of a persistent key in a secure element requires a transaction,
1944 * but registration or volatile key creation doesn't use one). */
Gilles Peskined7729582019-08-05 15:55:54 +02001945 if( driver != NULL &&
1946 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY )
Gilles Peskinecbaff462019-07-12 23:46:04 +02001947 {
1948 status = psa_save_se_persistent_data( driver );
1949 if( status != PSA_SUCCESS )
1950 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001951 psa_destroy_persistent_key( slot->attr.id );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001952 return( status );
1953 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001954 status = psa_crypto_stop_transaction( );
1955 if( status != PSA_SUCCESS )
1956 return( status );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001957 }
1958#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1959
Gilles Peskine4747d192019-04-17 15:05:45 +02001960 return( status );
1961}
1962
1963/** Abort the creation of a key.
1964 *
1965 * You may call this function after calling psa_start_key_creation(),
1966 * or after psa_finish_key_creation() fails. In other circumstances, this
1967 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001968 * See the documentation of psa_start_key_creation() for the intended use
1969 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001970 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001971 * \param[in,out] slot Pointer to the slot with key material.
1972 * \param[in] driver The secure element driver for the key,
1973 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001974 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001975static void psa_fail_key_creation( psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001976 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001977{
Gilles Peskine011e4282019-06-26 18:34:38 +02001978 (void) driver;
1979
Gilles Peskine4747d192019-04-17 15:05:45 +02001980 if( slot == NULL )
1981 return;
Gilles Peskine011e4282019-06-26 18:34:38 +02001982
1983#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001984 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001985 * element, and the failure happened later (when saving metadata
1986 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001987 * element.
1988 * https://github.com/ARMmbed/mbed-crypto/issues/217
1989 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001990
Gilles Peskined7729582019-08-05 15:55:54 +02001991 /* Abort the ongoing transaction if any (there may not be one if
1992 * the creation process failed before starting one, or if the
1993 * key creation is a registration of a key in a secure element).
1994 * Earlier functions must already have done what it takes to undo any
1995 * partial creation. All that's left is to update the transaction data
1996 * itself. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001997 (void) psa_crypto_stop_transaction( );
Gilles Peskine011e4282019-06-26 18:34:38 +02001998#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1999
Gilles Peskine4747d192019-04-17 15:05:45 +02002000 psa_wipe_key_slot( slot );
2001}
2002
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002003/** Validate optional attributes during key creation.
2004 *
2005 * Some key attributes are optional during key creation. If they are
2006 * specified in the attributes structure, check that they are consistent
2007 * with the data in the slot.
2008 *
2009 * This function should be called near the end of key creation, after
2010 * the slot in memory is fully populated but before saving persistent data.
2011 */
2012static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002013 const psa_key_slot_t *slot,
2014 const psa_key_attributes_t *attributes )
2015{
Gilles Peskine7e0cff92019-07-30 13:48:52 +02002016 if( attributes->core.type != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002017 {
Gilles Peskine8e338702019-07-30 20:06:31 +02002018 if( attributes->core.type != slot->attr.type )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002019 return( PSA_ERROR_INVALID_ARGUMENT );
2020 }
2021
2022 if( attributes->domain_parameters_size != 0 )
2023 {
2024#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02002025 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002026 {
Steven Cooremana2371e52020-07-28 14:30:39 +02002027 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02002028 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02002029 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02002030
Steven Cooreman7f391872020-07-30 14:57:44 +02002031 psa_status_t status = psa_load_rsa_representation(
Steven Cooreman4fed4552020-08-03 14:46:03 +02002032 slot->attr.type,
Steven Cooreman7f391872020-07-30 14:57:44 +02002033 slot->data.key.data,
2034 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02002035 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02002036 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02002037 return( status );
Steven Cooreman75b74362020-07-28 14:30:13 +02002038
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002039 mbedtls_mpi_init( &actual );
2040 mbedtls_mpi_init( &required );
Steven Cooremana2371e52020-07-28 14:30:39 +02002041 ret = mbedtls_rsa_export( rsa,
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002042 NULL, NULL, NULL, NULL, &actual );
Steven Cooremana2371e52020-07-28 14:30:39 +02002043 mbedtls_rsa_free( rsa );
2044 mbedtls_free( rsa );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002045 if( ret != 0 )
2046 goto rsa_exit;
2047 ret = mbedtls_mpi_read_binary( &required,
2048 attributes->domain_parameters,
2049 attributes->domain_parameters_size );
2050 if( ret != 0 )
2051 goto rsa_exit;
2052 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
2053 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
2054 rsa_exit:
2055 mbedtls_mpi_free( &actual );
2056 mbedtls_mpi_free( &required );
2057 if( ret != 0)
2058 return( mbedtls_to_psa_error( ret ) );
2059 }
2060 else
2061#endif
2062 {
2063 return( PSA_ERROR_INVALID_ARGUMENT );
2064 }
2065 }
2066
Gilles Peskine7e0cff92019-07-30 13:48:52 +02002067 if( attributes->core.bits != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002068 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02002069 if( attributes->core.bits != slot->attr.bits )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002070 return( PSA_ERROR_INVALID_ARGUMENT );
2071 }
2072
2073 return( PSA_SUCCESS );
2074}
2075
Gilles Peskine4747d192019-04-17 15:05:45 +02002076psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02002077 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02002078 size_t data_length,
2079 psa_key_handle_t *handle )
Gilles Peskine4747d192019-04-17 15:05:45 +02002080{
2081 psa_status_t status;
2082 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002083 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002084
Gilles Peskine0f84d622019-09-12 19:03:13 +02002085 /* Reject zero-length symmetric keys (including raw data key objects).
2086 * This also rejects any key which might be encoded as an empty string,
2087 * which is never valid. */
2088 if( data_length == 0 )
2089 return( PSA_ERROR_INVALID_ARGUMENT );
2090
Gilles Peskinedf179142019-07-15 22:02:14 +02002091 status = psa_start_key_creation( PSA_KEY_CREATION_IMPORT, attributes,
2092 handle, &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002093 if( status != PSA_SUCCESS )
2094 goto exit;
2095
Gilles Peskine5d309672019-07-12 23:47:28 +02002096#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2097 if( driver != NULL )
2098 {
2099 const psa_drv_se_t *drv = psa_get_se_driver_methods( driver );
Darryl Green0892d0f2019-08-20 09:50:14 +01002100 /* The driver should set the number of key bits, however in
2101 * case it doesn't, we initialize bits to an invalid value. */
2102 size_t bits = PSA_MAX_KEY_BITS + 1;
Gilles Peskine5d309672019-07-12 23:47:28 +02002103 if( drv->key_management == NULL ||
2104 drv->key_management->p_import == NULL )
2105 {
2106 status = PSA_ERROR_NOT_SUPPORTED;
2107 goto exit;
2108 }
2109 status = drv->key_management->p_import(
2110 psa_get_se_driver_context( driver ),
Gilles Peskinef3801ff2019-08-06 17:32:04 +02002111 slot->data.se.slot_number, attributes, data, data_length,
Gilles Peskineb46bef22019-07-30 21:32:04 +02002112 &bits );
2113 if( status != PSA_SUCCESS )
2114 goto exit;
2115 if( bits > PSA_MAX_KEY_BITS )
2116 {
2117 status = PSA_ERROR_NOT_SUPPORTED;
2118 goto exit;
2119 }
2120 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskine5d309672019-07-12 23:47:28 +02002121 }
2122 else
2123#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2124 {
2125 status = psa_import_key_into_slot( slot, data, data_length );
2126 if( status != PSA_SUCCESS )
2127 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02002128 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002129 status = psa_validate_optional_attributes( slot, attributes );
Gilles Peskine18017402019-07-24 20:25:59 +02002130 if( status != PSA_SUCCESS )
2131 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002132
Gilles Peskine011e4282019-06-26 18:34:38 +02002133 status = psa_finish_key_creation( slot, driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002134exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02002135 if( status != PSA_SUCCESS )
2136 {
Gilles Peskine011e4282019-06-26 18:34:38 +02002137 psa_fail_key_creation( slot, driver );
Gilles Peskine4747d192019-04-17 15:05:45 +02002138 *handle = 0;
2139 }
2140 return( status );
2141}
2142
Gilles Peskined7729582019-08-05 15:55:54 +02002143#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2144psa_status_t mbedtls_psa_register_se_key(
2145 const psa_key_attributes_t *attributes )
2146{
2147 psa_status_t status;
2148 psa_key_slot_t *slot = NULL;
2149 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskined7729582019-08-05 15:55:54 +02002150 psa_key_handle_t handle = 0;
2151
2152 /* Leaving attributes unspecified is not currently supported.
2153 * It could make sense to query the key type and size from the
2154 * secure element, but not all secure elements support this
2155 * and the driver HAL doesn't currently support it. */
2156 if( psa_get_key_type( attributes ) == PSA_KEY_TYPE_NONE )
2157 return( PSA_ERROR_NOT_SUPPORTED );
2158 if( psa_get_key_bits( attributes ) == 0 )
2159 return( PSA_ERROR_NOT_SUPPORTED );
2160
2161 status = psa_start_key_creation( PSA_KEY_CREATION_REGISTER, attributes,
2162 &handle, &slot, &driver );
2163 if( status != PSA_SUCCESS )
2164 goto exit;
2165
Gilles Peskined7729582019-08-05 15:55:54 +02002166 status = psa_finish_key_creation( slot, driver );
2167
2168exit:
2169 if( status != PSA_SUCCESS )
2170 {
2171 psa_fail_key_creation( slot, driver );
2172 }
2173 /* Registration doesn't keep the key in RAM. */
2174 psa_close_key( handle );
2175 return( status );
2176}
2177#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2178
Gilles Peskinef603c712019-01-19 13:40:11 +01002179static psa_status_t psa_copy_key_material( const psa_key_slot_t *source,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002180 psa_key_slot_t *target )
Gilles Peskinef603c712019-01-19 13:40:11 +01002181{
2182 psa_status_t status;
2183 uint8_t *buffer = NULL;
2184 size_t buffer_size = 0;
2185 size_t length;
2186
Gilles Peskine8e338702019-07-30 20:06:31 +02002187 buffer_size = PSA_KEY_EXPORT_MAX_SIZE( source->attr.type,
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02002188 psa_get_key_slot_bits( source ) );
Gilles Peskinef603c712019-01-19 13:40:11 +01002189 buffer = mbedtls_calloc( 1, buffer_size );
Gilles Peskinef9168942019-09-12 19:20:29 +02002190 if( buffer == NULL )
Gilles Peskine122d0022019-01-23 10:55:43 +01002191 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Gilles Peskinef603c712019-01-19 13:40:11 +01002192 status = psa_internal_export_key( source, buffer, buffer_size, &length, 0 );
2193 if( status != PSA_SUCCESS )
2194 goto exit;
Gilles Peskine8e338702019-07-30 20:06:31 +02002195 target->attr.type = source->attr.type;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002196 status = psa_import_key_into_slot( target, buffer, length );
Gilles Peskinef603c712019-01-19 13:40:11 +01002197
2198exit:
Gilles Peskinef9168942019-09-12 19:20:29 +02002199 mbedtls_platform_zeroize( buffer, buffer_size );
Gilles Peskine122d0022019-01-23 10:55:43 +01002200 mbedtls_free( buffer );
Gilles Peskinef603c712019-01-19 13:40:11 +01002201 return( status );
2202}
2203
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002204psa_status_t psa_copy_key( psa_key_handle_t source_handle,
2205 const psa_key_attributes_t *specified_attributes,
2206 psa_key_handle_t *target_handle )
Gilles Peskinef603c712019-01-19 13:40:11 +01002207{
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002208 psa_status_t status;
Gilles Peskinef603c712019-01-19 13:40:11 +01002209 psa_key_slot_t *source_slot = NULL;
2210 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002211 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002212 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskinef603c712019-01-19 13:40:11 +01002213
Gilles Peskine28f8f302019-07-24 13:30:31 +02002214 status = psa_get_transparent_key( source_handle, &source_slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02002215 PSA_KEY_USAGE_COPY, 0 );
Gilles Peskinef603c712019-01-19 13:40:11 +01002216 if( status != PSA_SUCCESS )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002217 goto exit;
2218
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002219 status = psa_validate_optional_attributes( source_slot,
2220 specified_attributes );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002221 if( status != PSA_SUCCESS )
2222 goto exit;
2223
Gilles Peskine7e0cff92019-07-30 13:48:52 +02002224 status = psa_restrict_key_policy( &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02002225 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002226 if( status != PSA_SUCCESS )
2227 goto exit;
2228
Gilles Peskinedf179142019-07-15 22:02:14 +02002229 status = psa_start_key_creation( PSA_KEY_CREATION_COPY,
2230 &actual_attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02002231 target_handle, &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002232 if( status != PSA_SUCCESS )
2233 goto exit;
2234
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002235#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2236 if( driver != NULL )
Gilles Peskinef603c712019-01-19 13:40:11 +01002237 {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002238 /* Copying to a secure element is not implemented yet. */
2239 status = PSA_ERROR_NOT_SUPPORTED;
2240 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002241 }
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002242#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef603c712019-01-19 13:40:11 +01002243
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002244 status = psa_copy_key_material( source_slot, target_slot );
Gilles Peskinef603c712019-01-19 13:40:11 +01002245 if( status != PSA_SUCCESS )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002246 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002247
Gilles Peskine011e4282019-06-26 18:34:38 +02002248 status = psa_finish_key_creation( target_slot, driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002249exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002250 if( status != PSA_SUCCESS )
2251 {
Gilles Peskine011e4282019-06-26 18:34:38 +02002252 psa_fail_key_creation( target_slot, driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002253 *target_handle = 0;
2254 }
2255 return( status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002256}
2257
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002258
2259
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002260/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002261/* Message digests */
2262/****************************************************************/
2263
Gilles Peskineb16841e2019-10-10 20:36:12 +02002264#if defined(MBEDTLS_RSA_C) || defined(MBEDTLS_ECDSA_DETERMINISTIC)
Gilles Peskinedc2fc842018-03-07 16:42:59 +01002265static const mbedtls_md_info_t *mbedtls_md_info_from_psa( psa_algorithm_t alg )
Gilles Peskine20035e32018-02-03 22:44:14 +01002266{
2267 switch( alg )
2268 {
2269#if defined(MBEDTLS_MD2_C)
2270 case PSA_ALG_MD2:
2271 return( &mbedtls_md2_info );
2272#endif
2273#if defined(MBEDTLS_MD4_C)
2274 case PSA_ALG_MD4:
2275 return( &mbedtls_md4_info );
2276#endif
2277#if defined(MBEDTLS_MD5_C)
2278 case PSA_ALG_MD5:
2279 return( &mbedtls_md5_info );
2280#endif
2281#if defined(MBEDTLS_RIPEMD160_C)
2282 case PSA_ALG_RIPEMD160:
2283 return( &mbedtls_ripemd160_info );
2284#endif
2285#if defined(MBEDTLS_SHA1_C)
2286 case PSA_ALG_SHA_1:
2287 return( &mbedtls_sha1_info );
2288#endif
2289#if defined(MBEDTLS_SHA256_C)
2290 case PSA_ALG_SHA_224:
2291 return( &mbedtls_sha224_info );
2292 case PSA_ALG_SHA_256:
2293 return( &mbedtls_sha256_info );
2294#endif
2295#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnardd6020842019-07-17 16:28:21 +02002296#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine20035e32018-02-03 22:44:14 +01002297 case PSA_ALG_SHA_384:
2298 return( &mbedtls_sha384_info );
Manuel Pégourié-Gonnardd6020842019-07-17 16:28:21 +02002299#endif
Gilles Peskine20035e32018-02-03 22:44:14 +01002300 case PSA_ALG_SHA_512:
2301 return( &mbedtls_sha512_info );
2302#endif
2303 default:
2304 return( NULL );
2305 }
2306}
Gilles Peskineb16841e2019-10-10 20:36:12 +02002307#endif
Gilles Peskine20035e32018-02-03 22:44:14 +01002308
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002309psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
2310{
2311 switch( operation->alg )
2312 {
Gilles Peskine81736312018-06-26 15:04:31 +02002313 case 0:
2314 /* The object has (apparently) been initialized but it is not
2315 * in use. It's ok to call abort on such an object, and there's
2316 * nothing to do. */
2317 break;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002318#if defined(MBEDTLS_MD2_C)
2319 case PSA_ALG_MD2:
2320 mbedtls_md2_free( &operation->ctx.md2 );
2321 break;
2322#endif
2323#if defined(MBEDTLS_MD4_C)
2324 case PSA_ALG_MD4:
2325 mbedtls_md4_free( &operation->ctx.md4 );
2326 break;
2327#endif
2328#if defined(MBEDTLS_MD5_C)
2329 case PSA_ALG_MD5:
2330 mbedtls_md5_free( &operation->ctx.md5 );
2331 break;
2332#endif
2333#if defined(MBEDTLS_RIPEMD160_C)
2334 case PSA_ALG_RIPEMD160:
2335 mbedtls_ripemd160_free( &operation->ctx.ripemd160 );
2336 break;
2337#endif
2338#if defined(MBEDTLS_SHA1_C)
2339 case PSA_ALG_SHA_1:
2340 mbedtls_sha1_free( &operation->ctx.sha1 );
2341 break;
2342#endif
2343#if defined(MBEDTLS_SHA256_C)
2344 case PSA_ALG_SHA_224:
2345 case PSA_ALG_SHA_256:
2346 mbedtls_sha256_free( &operation->ctx.sha256 );
2347 break;
2348#endif
2349#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002350#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002351 case PSA_ALG_SHA_384:
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002352#endif
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002353 case PSA_ALG_SHA_512:
2354 mbedtls_sha512_free( &operation->ctx.sha512 );
2355 break;
2356#endif
2357 default:
Gilles Peskinef9c2c092018-06-21 16:57:07 +02002358 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002359 }
2360 operation->alg = 0;
2361 return( PSA_SUCCESS );
2362}
2363
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002364psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002365 psa_algorithm_t alg )
2366{
Janos Follath24eed8d2019-11-22 13:21:35 +00002367 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002368
2369 /* A context must be freshly initialized before it can be set up. */
2370 if( operation->alg != 0 )
2371 {
2372 return( PSA_ERROR_BAD_STATE );
2373 }
2374
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002375 switch( alg )
2376 {
2377#if defined(MBEDTLS_MD2_C)
2378 case PSA_ALG_MD2:
2379 mbedtls_md2_init( &operation->ctx.md2 );
2380 ret = mbedtls_md2_starts_ret( &operation->ctx.md2 );
2381 break;
2382#endif
2383#if defined(MBEDTLS_MD4_C)
2384 case PSA_ALG_MD4:
2385 mbedtls_md4_init( &operation->ctx.md4 );
2386 ret = mbedtls_md4_starts_ret( &operation->ctx.md4 );
2387 break;
2388#endif
2389#if defined(MBEDTLS_MD5_C)
2390 case PSA_ALG_MD5:
2391 mbedtls_md5_init( &operation->ctx.md5 );
2392 ret = mbedtls_md5_starts_ret( &operation->ctx.md5 );
2393 break;
2394#endif
2395#if defined(MBEDTLS_RIPEMD160_C)
2396 case PSA_ALG_RIPEMD160:
2397 mbedtls_ripemd160_init( &operation->ctx.ripemd160 );
2398 ret = mbedtls_ripemd160_starts_ret( &operation->ctx.ripemd160 );
2399 break;
2400#endif
2401#if defined(MBEDTLS_SHA1_C)
2402 case PSA_ALG_SHA_1:
2403 mbedtls_sha1_init( &operation->ctx.sha1 );
2404 ret = mbedtls_sha1_starts_ret( &operation->ctx.sha1 );
2405 break;
2406#endif
2407#if defined(MBEDTLS_SHA256_C)
2408 case PSA_ALG_SHA_224:
2409 mbedtls_sha256_init( &operation->ctx.sha256 );
2410 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 1 );
2411 break;
2412 case PSA_ALG_SHA_256:
2413 mbedtls_sha256_init( &operation->ctx.sha256 );
2414 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 0 );
2415 break;
2416#endif
2417#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002418#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002419 case PSA_ALG_SHA_384:
2420 mbedtls_sha512_init( &operation->ctx.sha512 );
2421 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 1 );
2422 break;
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002423#endif
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002424 case PSA_ALG_SHA_512:
2425 mbedtls_sha512_init( &operation->ctx.sha512 );
2426 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 0 );
2427 break;
2428#endif
2429 default:
Gilles Peskinec06e0712018-06-20 16:21:04 +02002430 return( PSA_ALG_IS_HASH( alg ) ?
2431 PSA_ERROR_NOT_SUPPORTED :
2432 PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002433 }
2434 if( ret == 0 )
2435 operation->alg = alg;
2436 else
2437 psa_hash_abort( operation );
2438 return( mbedtls_to_psa_error( ret ) );
2439}
2440
2441psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2442 const uint8_t *input,
2443 size_t input_length )
2444{
Janos Follath24eed8d2019-11-22 13:21:35 +00002445 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine94e44542018-07-12 16:58:43 +02002446
2447 /* Don't require hash implementations to behave correctly on a
2448 * zero-length input, which may have an invalid pointer. */
2449 if( input_length == 0 )
2450 return( PSA_SUCCESS );
2451
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002452 switch( operation->alg )
2453 {
2454#if defined(MBEDTLS_MD2_C)
2455 case PSA_ALG_MD2:
2456 ret = mbedtls_md2_update_ret( &operation->ctx.md2,
2457 input, input_length );
2458 break;
2459#endif
2460#if defined(MBEDTLS_MD4_C)
2461 case PSA_ALG_MD4:
2462 ret = mbedtls_md4_update_ret( &operation->ctx.md4,
2463 input, input_length );
2464 break;
2465#endif
2466#if defined(MBEDTLS_MD5_C)
2467 case PSA_ALG_MD5:
2468 ret = mbedtls_md5_update_ret( &operation->ctx.md5,
2469 input, input_length );
2470 break;
2471#endif
2472#if defined(MBEDTLS_RIPEMD160_C)
2473 case PSA_ALG_RIPEMD160:
2474 ret = mbedtls_ripemd160_update_ret( &operation->ctx.ripemd160,
2475 input, input_length );
2476 break;
2477#endif
2478#if defined(MBEDTLS_SHA1_C)
2479 case PSA_ALG_SHA_1:
2480 ret = mbedtls_sha1_update_ret( &operation->ctx.sha1,
2481 input, input_length );
2482 break;
2483#endif
2484#if defined(MBEDTLS_SHA256_C)
2485 case PSA_ALG_SHA_224:
2486 case PSA_ALG_SHA_256:
2487 ret = mbedtls_sha256_update_ret( &operation->ctx.sha256,
2488 input, input_length );
2489 break;
2490#endif
2491#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002492#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002493 case PSA_ALG_SHA_384:
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002494#endif
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002495 case PSA_ALG_SHA_512:
2496 ret = mbedtls_sha512_update_ret( &operation->ctx.sha512,
2497 input, input_length );
2498 break;
2499#endif
2500 default:
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002501 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002502 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002503
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002504 if( ret != 0 )
2505 psa_hash_abort( operation );
2506 return( mbedtls_to_psa_error( ret ) );
2507}
2508
2509psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2510 uint8_t *hash,
2511 size_t hash_size,
2512 size_t *hash_length )
2513{
itayzafrir40835d42018-08-02 13:14:17 +03002514 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00002515 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine71bb7b72018-04-19 08:29:59 +02002516 size_t actual_hash_length = PSA_HASH_SIZE( operation->alg );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002517
2518 /* Fill the output buffer with something that isn't a valid hash
2519 * (barring an attack on the hash and deliberately-crafted input),
2520 * in case the caller doesn't check the return status properly. */
Gilles Peskineaee13332018-07-02 12:15:28 +02002521 *hash_length = hash_size;
Gilles Peskine46f1fd72018-06-28 19:31:31 +02002522 /* If hash_size is 0 then hash may be NULL and then the
2523 * call to memset would have undefined behavior. */
2524 if( hash_size != 0 )
2525 memset( hash, '!', hash_size );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002526
2527 if( hash_size < actual_hash_length )
itayzafrir40835d42018-08-02 13:14:17 +03002528 {
2529 status = PSA_ERROR_BUFFER_TOO_SMALL;
2530 goto exit;
2531 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002532
2533 switch( operation->alg )
2534 {
2535#if defined(MBEDTLS_MD2_C)
2536 case PSA_ALG_MD2:
2537 ret = mbedtls_md2_finish_ret( &operation->ctx.md2, hash );
2538 break;
2539#endif
2540#if defined(MBEDTLS_MD4_C)
2541 case PSA_ALG_MD4:
2542 ret = mbedtls_md4_finish_ret( &operation->ctx.md4, hash );
2543 break;
2544#endif
2545#if defined(MBEDTLS_MD5_C)
2546 case PSA_ALG_MD5:
2547 ret = mbedtls_md5_finish_ret( &operation->ctx.md5, hash );
2548 break;
2549#endif
2550#if defined(MBEDTLS_RIPEMD160_C)
2551 case PSA_ALG_RIPEMD160:
2552 ret = mbedtls_ripemd160_finish_ret( &operation->ctx.ripemd160, hash );
2553 break;
2554#endif
2555#if defined(MBEDTLS_SHA1_C)
2556 case PSA_ALG_SHA_1:
2557 ret = mbedtls_sha1_finish_ret( &operation->ctx.sha1, hash );
2558 break;
2559#endif
2560#if defined(MBEDTLS_SHA256_C)
2561 case PSA_ALG_SHA_224:
2562 case PSA_ALG_SHA_256:
2563 ret = mbedtls_sha256_finish_ret( &operation->ctx.sha256, hash );
2564 break;
2565#endif
2566#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002567#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002568 case PSA_ALG_SHA_384:
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002569#endif
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002570 case PSA_ALG_SHA_512:
2571 ret = mbedtls_sha512_finish_ret( &operation->ctx.sha512, hash );
2572 break;
2573#endif
2574 default:
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002575 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002576 }
itayzafrir40835d42018-08-02 13:14:17 +03002577 status = mbedtls_to_psa_error( ret );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002578
itayzafrir40835d42018-08-02 13:14:17 +03002579exit:
2580 if( status == PSA_SUCCESS )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002581 {
Gilles Peskineaee13332018-07-02 12:15:28 +02002582 *hash_length = actual_hash_length;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002583 return( psa_hash_abort( operation ) );
2584 }
2585 else
2586 {
2587 psa_hash_abort( operation );
itayzafrir40835d42018-08-02 13:14:17 +03002588 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002589 }
2590}
2591
Gilles Peskine2d277862018-06-18 15:41:12 +02002592psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2593 const uint8_t *hash,
2594 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002595{
2596 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2597 size_t actual_hash_length;
2598 psa_status_t status = psa_hash_finish( operation,
2599 actual_hash, sizeof( actual_hash ),
2600 &actual_hash_length );
2601 if( status != PSA_SUCCESS )
2602 return( status );
2603 if( actual_hash_length != hash_length )
2604 return( PSA_ERROR_INVALID_SIGNATURE );
2605 if( safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
2606 return( PSA_ERROR_INVALID_SIGNATURE );
2607 return( PSA_SUCCESS );
2608}
2609
Gilles Peskine0a749c82019-11-28 19:33:58 +01002610psa_status_t psa_hash_compute( psa_algorithm_t alg,
2611 const uint8_t *input, size_t input_length,
2612 uint8_t *hash, size_t hash_size,
2613 size_t *hash_length )
2614{
2615 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
2616 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2617
2618 *hash_length = hash_size;
2619 status = psa_hash_setup( &operation, alg );
2620 if( status != PSA_SUCCESS )
2621 goto exit;
2622 status = psa_hash_update( &operation, input, input_length );
2623 if( status != PSA_SUCCESS )
2624 goto exit;
2625 status = psa_hash_finish( &operation, hash, hash_size, hash_length );
2626 if( status != PSA_SUCCESS )
2627 goto exit;
2628
2629exit:
2630 if( status == PSA_SUCCESS )
2631 status = psa_hash_abort( &operation );
2632 else
2633 psa_hash_abort( &operation );
2634 return( status );
2635}
2636
2637psa_status_t psa_hash_compare( psa_algorithm_t alg,
2638 const uint8_t *input, size_t input_length,
2639 const uint8_t *hash, size_t hash_length )
2640{
2641 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
2642 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2643
2644 status = psa_hash_setup( &operation, alg );
2645 if( status != PSA_SUCCESS )
2646 goto exit;
2647 status = psa_hash_update( &operation, input, input_length );
2648 if( status != PSA_SUCCESS )
2649 goto exit;
2650 status = psa_hash_verify( &operation, hash, hash_length );
2651 if( status != PSA_SUCCESS )
2652 goto exit;
2653
2654exit:
2655 if( status == PSA_SUCCESS )
2656 status = psa_hash_abort( &operation );
2657 else
2658 psa_hash_abort( &operation );
2659 return( status );
2660}
2661
Gilles Peskineeb35d782019-01-22 17:56:16 +01002662psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2663 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002664{
2665 if( target_operation->alg != 0 )
2666 return( PSA_ERROR_BAD_STATE );
2667
2668 switch( source_operation->alg )
2669 {
2670 case 0:
2671 return( PSA_ERROR_BAD_STATE );
2672#if defined(MBEDTLS_MD2_C)
2673 case PSA_ALG_MD2:
2674 mbedtls_md2_clone( &target_operation->ctx.md2,
2675 &source_operation->ctx.md2 );
2676 break;
2677#endif
2678#if defined(MBEDTLS_MD4_C)
2679 case PSA_ALG_MD4:
2680 mbedtls_md4_clone( &target_operation->ctx.md4,
2681 &source_operation->ctx.md4 );
2682 break;
2683#endif
2684#if defined(MBEDTLS_MD5_C)
2685 case PSA_ALG_MD5:
2686 mbedtls_md5_clone( &target_operation->ctx.md5,
2687 &source_operation->ctx.md5 );
2688 break;
2689#endif
2690#if defined(MBEDTLS_RIPEMD160_C)
2691 case PSA_ALG_RIPEMD160:
2692 mbedtls_ripemd160_clone( &target_operation->ctx.ripemd160,
2693 &source_operation->ctx.ripemd160 );
2694 break;
2695#endif
2696#if defined(MBEDTLS_SHA1_C)
2697 case PSA_ALG_SHA_1:
2698 mbedtls_sha1_clone( &target_operation->ctx.sha1,
2699 &source_operation->ctx.sha1 );
2700 break;
2701#endif
2702#if defined(MBEDTLS_SHA256_C)
2703 case PSA_ALG_SHA_224:
2704 case PSA_ALG_SHA_256:
2705 mbedtls_sha256_clone( &target_operation->ctx.sha256,
2706 &source_operation->ctx.sha256 );
2707 break;
2708#endif
2709#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002710#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002711 case PSA_ALG_SHA_384:
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002712#endif
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002713 case PSA_ALG_SHA_512:
2714 mbedtls_sha512_clone( &target_operation->ctx.sha512,
2715 &source_operation->ctx.sha512 );
2716 break;
2717#endif
2718 default:
2719 return( PSA_ERROR_NOT_SUPPORTED );
2720 }
2721
2722 target_operation->alg = source_operation->alg;
2723 return( PSA_SUCCESS );
2724}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002725
2726
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002727/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002728/* MAC */
2729/****************************************************************/
2730
Gilles Peskinedc2fc842018-03-07 16:42:59 +01002731static const mbedtls_cipher_info_t *mbedtls_cipher_info_from_psa(
Gilles Peskine8c9def32018-02-08 10:02:12 +01002732 psa_algorithm_t alg,
2733 psa_key_type_t key_type,
Gilles Peskine2d277862018-06-18 15:41:12 +02002734 size_t key_bits,
mohammad1603f4f0d612018-06-03 15:04:51 +03002735 mbedtls_cipher_id_t* cipher_id )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002736{
Gilles Peskine8c9def32018-02-08 10:02:12 +01002737 mbedtls_cipher_mode_t mode;
mohammad1603f4f0d612018-06-03 15:04:51 +03002738 mbedtls_cipher_id_t cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002739
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002740 if( PSA_ALG_IS_AEAD( alg ) )
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002741 alg = PSA_ALG_AEAD_WITH_TAG_LENGTH( alg, 0 );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002742
Gilles Peskine8c9def32018-02-08 10:02:12 +01002743 if( PSA_ALG_IS_CIPHER( alg ) || PSA_ALG_IS_AEAD( alg ) )
2744 {
Nir Sonnenscheine9664c32018-06-17 14:41:30 +03002745 switch( alg )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002746 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002747 case PSA_ALG_ARC4:
Gilles Peskine26869f22019-05-06 15:25:00 +02002748 case PSA_ALG_CHACHA20:
Gilles Peskine8c9def32018-02-08 10:02:12 +01002749 mode = MBEDTLS_MODE_STREAM;
2750 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002751 case PSA_ALG_CTR:
2752 mode = MBEDTLS_MODE_CTR;
2753 break;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002754 case PSA_ALG_CFB:
2755 mode = MBEDTLS_MODE_CFB;
2756 break;
2757 case PSA_ALG_OFB:
2758 mode = MBEDTLS_MODE_OFB;
2759 break;
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02002760 case PSA_ALG_ECB_NO_PADDING:
2761 mode = MBEDTLS_MODE_ECB;
2762 break;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002763 case PSA_ALG_CBC_NO_PADDING:
2764 mode = MBEDTLS_MODE_CBC;
2765 break;
2766 case PSA_ALG_CBC_PKCS7:
2767 mode = MBEDTLS_MODE_CBC;
2768 break;
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002769 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002770 mode = MBEDTLS_MODE_CCM;
2771 break;
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002772 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_GCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002773 mode = MBEDTLS_MODE_GCM;
2774 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02002775 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CHACHA20_POLY1305, 0 ):
2776 mode = MBEDTLS_MODE_CHACHAPOLY;
2777 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002778 default:
2779 return( NULL );
2780 }
2781 }
2782 else if( alg == PSA_ALG_CMAC )
2783 mode = MBEDTLS_MODE_ECB;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002784 else
2785 return( NULL );
2786
2787 switch( key_type )
2788 {
2789 case PSA_KEY_TYPE_AES:
mohammad1603f4f0d612018-06-03 15:04:51 +03002790 cipher_id_tmp = MBEDTLS_CIPHER_ID_AES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002791 break;
2792 case PSA_KEY_TYPE_DES:
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002793 /* key_bits is 64 for Single-DES, 128 for two-key Triple-DES,
2794 * and 192 for three-key Triple-DES. */
Gilles Peskine8c9def32018-02-08 10:02:12 +01002795 if( key_bits == 64 )
mohammad1603f4f0d612018-06-03 15:04:51 +03002796 cipher_id_tmp = MBEDTLS_CIPHER_ID_DES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002797 else
mohammad1603f4f0d612018-06-03 15:04:51 +03002798 cipher_id_tmp = MBEDTLS_CIPHER_ID_3DES;
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002799 /* mbedtls doesn't recognize two-key Triple-DES as an algorithm,
2800 * but two-key Triple-DES is functionally three-key Triple-DES
2801 * with K1=K3, so that's how we present it to mbedtls. */
2802 if( key_bits == 128 )
2803 key_bits = 192;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002804 break;
2805 case PSA_KEY_TYPE_CAMELLIA:
mohammad1603f4f0d612018-06-03 15:04:51 +03002806 cipher_id_tmp = MBEDTLS_CIPHER_ID_CAMELLIA;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002807 break;
2808 case PSA_KEY_TYPE_ARC4:
mohammad1603f4f0d612018-06-03 15:04:51 +03002809 cipher_id_tmp = MBEDTLS_CIPHER_ID_ARC4;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002810 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02002811 case PSA_KEY_TYPE_CHACHA20:
2812 cipher_id_tmp = MBEDTLS_CIPHER_ID_CHACHA20;
2813 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002814 default:
2815 return( NULL );
2816 }
mohammad1603f4f0d612018-06-03 15:04:51 +03002817 if( cipher_id != NULL )
mohammad160360a64d02018-06-03 17:20:42 +03002818 *cipher_id = cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002819
Jaeden Amero23bbb752018-06-26 14:16:54 +01002820 return( mbedtls_cipher_info_from_values( cipher_id_tmp,
2821 (int) key_bits, mode ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002822}
2823
Gilles Peskinea05219c2018-11-16 16:02:56 +01002824#if defined(MBEDTLS_MD_C)
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002825static size_t psa_get_hash_block_size( psa_algorithm_t alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002826{
Gilles Peskine2d277862018-06-18 15:41:12 +02002827 switch( alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002828 {
2829 case PSA_ALG_MD2:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002830 return( 16 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002831 case PSA_ALG_MD4:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002832 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002833 case PSA_ALG_MD5:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002834 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002835 case PSA_ALG_RIPEMD160:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002836 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002837 case PSA_ALG_SHA_1:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002838 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002839 case PSA_ALG_SHA_224:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002840 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002841 case PSA_ALG_SHA_256:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002842 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002843 case PSA_ALG_SHA_384:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002844 return( 128 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002845 case PSA_ALG_SHA_512:
Gilles Peskine2d277862018-06-18 15:41:12 +02002846 return( 128 );
2847 default:
2848 return( 0 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002849 }
2850}
Gilles Peskinea05219c2018-11-16 16:02:56 +01002851#endif /* MBEDTLS_MD_C */
Nir Sonnenschein0c9ec532018-06-07 13:27:47 +03002852
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002853/* Initialize the MAC operation structure. Once this function has been
2854 * called, psa_mac_abort can run and will do the right thing. */
2855static psa_status_t psa_mac_init( psa_mac_operation_t *operation,
2856 psa_algorithm_t alg )
2857{
2858 psa_status_t status = PSA_ERROR_NOT_SUPPORTED;
2859
2860 operation->alg = alg;
2861 operation->key_set = 0;
2862 operation->iv_set = 0;
2863 operation->iv_required = 0;
2864 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002865 operation->is_sign = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002866
2867#if defined(MBEDTLS_CMAC_C)
2868 if( alg == PSA_ALG_CMAC )
2869 {
2870 operation->iv_required = 0;
2871 mbedtls_cipher_init( &operation->ctx.cmac );
2872 status = PSA_SUCCESS;
2873 }
2874 else
2875#endif /* MBEDTLS_CMAC_C */
2876#if defined(MBEDTLS_MD_C)
2877 if( PSA_ALG_IS_HMAC( operation->alg ) )
2878 {
Gilles Peskineff94abd2018-07-12 17:07:52 +02002879 /* We'll set up the hash operation later in psa_hmac_setup_internal. */
2880 operation->ctx.hmac.hash_ctx.alg = 0;
2881 status = PSA_SUCCESS;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002882 }
2883 else
2884#endif /* MBEDTLS_MD_C */
2885 {
Gilles Peskinec06e0712018-06-20 16:21:04 +02002886 if( ! PSA_ALG_IS_MAC( alg ) )
2887 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002888 }
2889
2890 if( status != PSA_SUCCESS )
2891 memset( operation, 0, sizeof( *operation ) );
2892 return( status );
2893}
2894
Gilles Peskine01126fa2018-07-12 17:04:55 +02002895#if defined(MBEDTLS_MD_C)
2896static psa_status_t psa_hmac_abort_internal( psa_hmac_internal_data *hmac )
2897{
Gilles Peskine3f108122018-12-07 18:14:53 +01002898 mbedtls_platform_zeroize( hmac->opad, sizeof( hmac->opad ) );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002899 return( psa_hash_abort( &hmac->hash_ctx ) );
2900}
2901#endif /* MBEDTLS_MD_C */
2902
Gilles Peskine8c9def32018-02-08 10:02:12 +01002903psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
2904{
Gilles Peskinefbfac682018-07-08 20:51:54 +02002905 if( operation->alg == 0 )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002906 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02002907 /* The object has (apparently) been initialized but it is not
2908 * in use. It's ok to call abort on such an object, and there's
2909 * nothing to do. */
2910 return( PSA_SUCCESS );
2911 }
2912 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002913#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002914 if( operation->alg == PSA_ALG_CMAC )
2915 {
2916 mbedtls_cipher_free( &operation->ctx.cmac );
2917 }
2918 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002919#endif /* MBEDTLS_CMAC_C */
Gilles Peskine8c9def32018-02-08 10:02:12 +01002920#if defined(MBEDTLS_MD_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002921 if( PSA_ALG_IS_HMAC( operation->alg ) )
2922 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02002923 psa_hmac_abort_internal( &operation->ctx.hmac );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002924 }
2925 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002926#endif /* MBEDTLS_MD_C */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002927 {
2928 /* Sanity check (shouldn't happen: operation->alg should
2929 * always have been initialized to a valid value). */
2930 goto bad_state;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002931 }
Moran Peker41deec42018-04-04 15:43:05 +03002932
Gilles Peskine8c9def32018-02-08 10:02:12 +01002933 operation->alg = 0;
2934 operation->key_set = 0;
2935 operation->iv_set = 0;
2936 operation->iv_required = 0;
2937 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002938 operation->is_sign = 0;
Moran Peker41deec42018-04-04 15:43:05 +03002939
Gilles Peskine8c9def32018-02-08 10:02:12 +01002940 return( PSA_SUCCESS );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002941
2942bad_state:
2943 /* If abort is called on an uninitialized object, we can't trust
2944 * anything. Wipe the object in case it contains confidential data.
2945 * This may result in a memory leak if a pointer gets overwritten,
2946 * but it's too late to do anything about this. */
2947 memset( operation, 0, sizeof( *operation ) );
2948 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002949}
2950
Gilles Peskinee3b07d82018-06-19 11:57:35 +02002951#if defined(MBEDTLS_CMAC_C)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002952static int psa_cmac_setup( psa_mac_operation_t *operation,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002953 size_t key_bits,
Gilles Peskine2f060a82018-12-04 17:12:32 +01002954 psa_key_slot_t *slot,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002955 const mbedtls_cipher_info_t *cipher_info )
2956{
Janos Follath24eed8d2019-11-22 13:21:35 +00002957 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002958
2959 operation->mac_size = cipher_info->block_size;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002960
2961 ret = mbedtls_cipher_setup( &operation->ctx.cmac, cipher_info );
2962 if( ret != 0 )
2963 return( ret );
2964
2965 ret = mbedtls_cipher_cmac_starts( &operation->ctx.cmac,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02002966 slot->data.key.data,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002967 key_bits );
2968 return( ret );
2969}
Gilles Peskinee3b07d82018-06-19 11:57:35 +02002970#endif /* MBEDTLS_CMAC_C */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002971
Gilles Peskine248051a2018-06-20 16:09:38 +02002972#if defined(MBEDTLS_MD_C)
Gilles Peskine01126fa2018-07-12 17:04:55 +02002973static psa_status_t psa_hmac_setup_internal( psa_hmac_internal_data *hmac,
2974 const uint8_t *key,
2975 size_t key_length,
2976 psa_algorithm_t hash_alg )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002977{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02002978 uint8_t ipad[PSA_HMAC_MAX_HASH_BLOCK_SIZE];
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002979 size_t i;
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002980 size_t hash_size = PSA_HASH_SIZE( hash_alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002981 size_t block_size = psa_get_hash_block_size( hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002982 psa_status_t status;
2983
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002984 /* Sanity checks on block_size, to guarantee that there won't be a buffer
2985 * overflow below. This should never trigger if the hash algorithm
2986 * is implemented correctly. */
2987 /* The size checks against the ipad and opad buffers cannot be written
2988 * `block_size > sizeof( ipad ) || block_size > sizeof( hmac->opad )`
2989 * because that triggers -Wlogical-op on GCC 7.3. */
2990 if( block_size > sizeof( ipad ) )
2991 return( PSA_ERROR_NOT_SUPPORTED );
2992 if( block_size > sizeof( hmac->opad ) )
2993 return( PSA_ERROR_NOT_SUPPORTED );
2994 if( block_size < hash_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002995 return( PSA_ERROR_NOT_SUPPORTED );
2996
Gilles Peskined223b522018-06-11 18:12:58 +02002997 if( key_length > block_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002998 {
Gilles Peskine84b8fc82019-11-28 20:07:20 +01002999 status = psa_hash_compute( hash_alg, key, key_length,
3000 ipad, sizeof( ipad ), &key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003001 if( status != PSA_SUCCESS )
Gilles Peskineb8be2882018-07-17 16:24:34 +02003002 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003003 }
Gilles Peskine96889972018-07-12 17:07:03 +02003004 /* A 0-length key is not commonly used in HMAC when used as a MAC,
3005 * but it is permitted. It is common when HMAC is used in HKDF, for
3006 * example. Don't call `memcpy` in the 0-length because `key` could be
3007 * an invalid pointer which would make the behavior undefined. */
3008 else if( key_length != 0 )
Gilles Peskine01126fa2018-07-12 17:04:55 +02003009 memcpy( ipad, key, key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003010
Gilles Peskined223b522018-06-11 18:12:58 +02003011 /* ipad contains the key followed by garbage. Xor and fill with 0x36
3012 * to create the ipad value. */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003013 for( i = 0; i < key_length; i++ )
Gilles Peskined223b522018-06-11 18:12:58 +02003014 ipad[i] ^= 0x36;
3015 memset( ipad + key_length, 0x36, block_size - key_length );
3016
3017 /* Copy the key material from ipad to opad, flipping the requisite bits,
3018 * and filling the rest of opad with the requisite constant. */
3019 for( i = 0; i < key_length; i++ )
Gilles Peskine01126fa2018-07-12 17:04:55 +02003020 hmac->opad[i] = ipad[i] ^ 0x36 ^ 0x5C;
3021 memset( hmac->opad + key_length, 0x5C, block_size - key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003022
Gilles Peskine01126fa2018-07-12 17:04:55 +02003023 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003024 if( status != PSA_SUCCESS )
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003025 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003026
Gilles Peskine01126fa2018-07-12 17:04:55 +02003027 status = psa_hash_update( &hmac->hash_ctx, ipad, block_size );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003028
3029cleanup:
Steven Cooreman29149862020-08-05 15:43:42 +02003030 mbedtls_platform_zeroize( ipad, sizeof( ipad ) );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003031
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003032 return( status );
3033}
Gilles Peskine248051a2018-06-20 16:09:38 +02003034#endif /* MBEDTLS_MD_C */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003035
Gilles Peskine89167cb2018-07-08 20:12:23 +02003036static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01003037 psa_key_handle_t handle,
Gilles Peskine89167cb2018-07-08 20:12:23 +02003038 psa_algorithm_t alg,
3039 int is_sign )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003040{
Gilles Peskine8c9def32018-02-08 10:02:12 +01003041 psa_status_t status;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003042 psa_key_slot_t *slot;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003043 size_t key_bits;
Gilles Peskine89167cb2018-07-08 20:12:23 +02003044 psa_key_usage_t usage =
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003045 is_sign ? PSA_KEY_USAGE_SIGN_HASH : PSA_KEY_USAGE_VERIFY_HASH;
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02003046 uint8_t truncated = PSA_MAC_TRUNCATED_LENGTH( alg );
Gilles Peskinee0e9c7c2018-10-17 18:28:05 +02003047 psa_algorithm_t full_length_alg = PSA_ALG_FULL_LENGTH_MAC( alg );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003048
Jaeden Amero36ee5d02019-02-19 09:25:10 +00003049 /* A context must be freshly initialized before it can be set up. */
3050 if( operation->alg != 0 )
3051 {
3052 return( PSA_ERROR_BAD_STATE );
3053 }
3054
Gilles Peskined911eb72018-08-14 15:18:45 +02003055 status = psa_mac_init( operation, full_length_alg );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003056 if( status != PSA_SUCCESS )
3057 return( status );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003058 if( is_sign )
3059 operation->is_sign = 1;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003060
Gilles Peskine28f8f302019-07-24 13:30:31 +02003061 status = psa_get_transparent_key( handle, &slot, usage, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003062 if( status != PSA_SUCCESS )
Gilles Peskinefbfac682018-07-08 20:51:54 +02003063 goto exit;
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02003064 key_bits = psa_get_key_slot_bits( slot );
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02003065
Gilles Peskine8c9def32018-02-08 10:02:12 +01003066#if defined(MBEDTLS_CMAC_C)
Gilles Peskined911eb72018-08-14 15:18:45 +02003067 if( full_length_alg == PSA_ALG_CMAC )
Gilles Peskinefbfac682018-07-08 20:51:54 +02003068 {
3069 const mbedtls_cipher_info_t *cipher_info =
Gilles Peskined911eb72018-08-14 15:18:45 +02003070 mbedtls_cipher_info_from_psa( full_length_alg,
Gilles Peskine8e338702019-07-30 20:06:31 +02003071 slot->attr.type, key_bits, NULL );
Janos Follath24eed8d2019-11-22 13:21:35 +00003072 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinefbfac682018-07-08 20:51:54 +02003073 if( cipher_info == NULL )
3074 {
3075 status = PSA_ERROR_NOT_SUPPORTED;
3076 goto exit;
3077 }
3078 operation->mac_size = cipher_info->block_size;
3079 ret = psa_cmac_setup( operation, key_bits, slot, cipher_info );
3080 status = mbedtls_to_psa_error( ret );
3081 }
3082 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01003083#endif /* MBEDTLS_CMAC_C */
Gilles Peskine8c9def32018-02-08 10:02:12 +01003084#if defined(MBEDTLS_MD_C)
Gilles Peskined911eb72018-08-14 15:18:45 +02003085 if( PSA_ALG_IS_HMAC( full_length_alg ) )
Gilles Peskinefbfac682018-07-08 20:51:54 +02003086 {
Gilles Peskine00709fa2018-08-22 18:25:41 +02003087 psa_algorithm_t hash_alg = PSA_ALG_HMAC_GET_HASH( alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003088 if( hash_alg == 0 )
3089 {
3090 status = PSA_ERROR_NOT_SUPPORTED;
3091 goto exit;
3092 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02003093
3094 operation->mac_size = PSA_HASH_SIZE( hash_alg );
3095 /* Sanity check. This shouldn't fail on a valid configuration. */
3096 if( operation->mac_size == 0 ||
3097 operation->mac_size > sizeof( operation->ctx.hmac.opad ) )
3098 {
3099 status = PSA_ERROR_NOT_SUPPORTED;
3100 goto exit;
3101 }
3102
Gilles Peskine8e338702019-07-30 20:06:31 +02003103 if( slot->attr.type != PSA_KEY_TYPE_HMAC )
Gilles Peskine01126fa2018-07-12 17:04:55 +02003104 {
3105 status = PSA_ERROR_INVALID_ARGUMENT;
3106 goto exit;
3107 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02003108
Gilles Peskine01126fa2018-07-12 17:04:55 +02003109 status = psa_hmac_setup_internal( &operation->ctx.hmac,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02003110 slot->data.key.data,
3111 slot->data.key.bytes,
Gilles Peskine01126fa2018-07-12 17:04:55 +02003112 hash_alg );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003113 }
3114 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01003115#endif /* MBEDTLS_MD_C */
Gilles Peskinefbfac682018-07-08 20:51:54 +02003116 {
Jaeden Amero82df32e2018-11-23 15:11:20 +00003117 (void) key_bits;
Gilles Peskinefbfac682018-07-08 20:51:54 +02003118 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003119 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003120
Gilles Peskined911eb72018-08-14 15:18:45 +02003121 if( truncated == 0 )
3122 {
3123 /* The "normal" case: untruncated algorithm. Nothing to do. */
3124 }
3125 else if( truncated < 4 )
3126 {
Gilles Peskine6d72ff92018-08-21 14:55:08 +02003127 /* A very short MAC is too short for security since it can be
3128 * brute-forced. Ancient protocols with 32-bit MACs do exist,
3129 * so we make this our minimum, even though 32 bits is still
3130 * too small for security. */
Gilles Peskined911eb72018-08-14 15:18:45 +02003131 status = PSA_ERROR_NOT_SUPPORTED;
3132 }
3133 else if( truncated > operation->mac_size )
3134 {
3135 /* It's impossible to "truncate" to a larger length. */
3136 status = PSA_ERROR_INVALID_ARGUMENT;
3137 }
3138 else
3139 operation->mac_size = truncated;
3140
Gilles Peskinefbfac682018-07-08 20:51:54 +02003141exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003142 if( status != PSA_SUCCESS )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003143 {
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003144 psa_mac_abort( operation );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003145 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003146 else
3147 {
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003148 operation->key_set = 1;
3149 }
3150 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003151}
3152
Gilles Peskine89167cb2018-07-08 20:12:23 +02003153psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01003154 psa_key_handle_t handle,
Gilles Peskine89167cb2018-07-08 20:12:23 +02003155 psa_algorithm_t alg )
3156{
Gilles Peskinec5487a82018-12-03 18:08:14 +01003157 return( psa_mac_setup( operation, handle, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003158}
3159
3160psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01003161 psa_key_handle_t handle,
Gilles Peskine89167cb2018-07-08 20:12:23 +02003162 psa_algorithm_t alg )
3163{
Gilles Peskinec5487a82018-12-03 18:08:14 +01003164 return( psa_mac_setup( operation, handle, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003165}
3166
Gilles Peskine8c9def32018-02-08 10:02:12 +01003167psa_status_t psa_mac_update( psa_mac_operation_t *operation,
3168 const uint8_t *input,
3169 size_t input_length )
3170{
Gilles Peskinefbfac682018-07-08 20:51:54 +02003171 psa_status_t status = PSA_ERROR_BAD_STATE;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003172 if( ! operation->key_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003173 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003174 if( operation->iv_required && ! operation->iv_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003175 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003176 operation->has_input = 1;
3177
Gilles Peskine8c9def32018-02-08 10:02:12 +01003178#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003179 if( operation->alg == PSA_ALG_CMAC )
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03003180 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02003181 int ret = mbedtls_cipher_cmac_update( &operation->ctx.cmac,
3182 input, input_length );
3183 status = mbedtls_to_psa_error( ret );
3184 }
3185 else
3186#endif /* MBEDTLS_CMAC_C */
3187#if defined(MBEDTLS_MD_C)
3188 if( PSA_ALG_IS_HMAC( operation->alg ) )
3189 {
3190 status = psa_hash_update( &operation->ctx.hmac.hash_ctx, input,
3191 input_length );
3192 }
3193 else
3194#endif /* MBEDTLS_MD_C */
3195 {
3196 /* This shouldn't happen if `operation` was initialized by
3197 * a setup function. */
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003198 return( PSA_ERROR_BAD_STATE );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03003199 }
3200
Gilles Peskinefbfac682018-07-08 20:51:54 +02003201 if( status != PSA_SUCCESS )
3202 psa_mac_abort( operation );
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02003203 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003204}
3205
Gilles Peskine01126fa2018-07-12 17:04:55 +02003206#if defined(MBEDTLS_MD_C)
3207static psa_status_t psa_hmac_finish_internal( psa_hmac_internal_data *hmac,
3208 uint8_t *mac,
3209 size_t mac_size )
3210{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02003211 uint8_t tmp[MBEDTLS_MD_MAX_SIZE];
Gilles Peskine01126fa2018-07-12 17:04:55 +02003212 psa_algorithm_t hash_alg = hmac->hash_ctx.alg;
3213 size_t hash_size = 0;
3214 size_t block_size = psa_get_hash_block_size( hash_alg );
3215 psa_status_t status;
3216
Gilles Peskine01126fa2018-07-12 17:04:55 +02003217 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
3218 if( status != PSA_SUCCESS )
3219 return( status );
3220 /* From here on, tmp needs to be wiped. */
3221
3222 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
3223 if( status != PSA_SUCCESS )
3224 goto exit;
3225
3226 status = psa_hash_update( &hmac->hash_ctx, hmac->opad, block_size );
3227 if( status != PSA_SUCCESS )
3228 goto exit;
3229
3230 status = psa_hash_update( &hmac->hash_ctx, tmp, hash_size );
3231 if( status != PSA_SUCCESS )
3232 goto exit;
3233
Gilles Peskined911eb72018-08-14 15:18:45 +02003234 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
3235 if( status != PSA_SUCCESS )
3236 goto exit;
3237
3238 memcpy( mac, tmp, mac_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003239
3240exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01003241 mbedtls_platform_zeroize( tmp, hash_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003242 return( status );
3243}
3244#endif /* MBEDTLS_MD_C */
3245
mohammad16036df908f2018-04-02 08:34:15 -07003246static psa_status_t psa_mac_finish_internal( psa_mac_operation_t *operation,
Gilles Peskine2d277862018-06-18 15:41:12 +02003247 uint8_t *mac,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003248 size_t mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003249{
Gilles Peskine1d96fff2018-07-02 12:15:39 +02003250 if( ! operation->key_set )
3251 return( PSA_ERROR_BAD_STATE );
3252 if( operation->iv_required && ! operation->iv_set )
3253 return( PSA_ERROR_BAD_STATE );
3254
Gilles Peskine8c9def32018-02-08 10:02:12 +01003255 if( mac_size < operation->mac_size )
3256 return( PSA_ERROR_BUFFER_TOO_SMALL );
3257
Gilles Peskine8c9def32018-02-08 10:02:12 +01003258#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003259 if( operation->alg == PSA_ALG_CMAC )
3260 {
Gilles Peskined911eb72018-08-14 15:18:45 +02003261 uint8_t tmp[PSA_MAX_BLOCK_CIPHER_BLOCK_SIZE];
3262 int ret = mbedtls_cipher_cmac_finish( &operation->ctx.cmac, tmp );
3263 if( ret == 0 )
Gilles Peskine87b0ac42018-08-21 14:55:49 +02003264 memcpy( mac, tmp, operation->mac_size );
Gilles Peskine3f108122018-12-07 18:14:53 +01003265 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003266 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003267 }
Gilles Peskinefbfac682018-07-08 20:51:54 +02003268 else
3269#endif /* MBEDTLS_CMAC_C */
3270#if defined(MBEDTLS_MD_C)
3271 if( PSA_ALG_IS_HMAC( operation->alg ) )
3272 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02003273 return( psa_hmac_finish_internal( &operation->ctx.hmac,
Gilles Peskined911eb72018-08-14 15:18:45 +02003274 mac, operation->mac_size ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003275 }
3276 else
3277#endif /* MBEDTLS_MD_C */
3278 {
3279 /* This shouldn't happen if `operation` was initialized by
3280 * a setup function. */
3281 return( PSA_ERROR_BAD_STATE );
3282 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01003283}
3284
Gilles Peskineacd4be32018-07-08 19:56:25 +02003285psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
3286 uint8_t *mac,
3287 size_t mac_size,
3288 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07003289{
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003290 psa_status_t status;
3291
Jaeden Amero252ef282019-02-15 14:05:35 +00003292 if( operation->alg == 0 )
3293 {
3294 return( PSA_ERROR_BAD_STATE );
3295 }
3296
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003297 /* Fill the output buffer with something that isn't a valid mac
3298 * (barring an attack on the mac and deliberately-crafted input),
3299 * in case the caller doesn't check the return status properly. */
3300 *mac_length = mac_size;
3301 /* If mac_size is 0 then mac may be NULL and then the
3302 * call to memset would have undefined behavior. */
3303 if( mac_size != 0 )
3304 memset( mac, '!', mac_size );
3305
Gilles Peskine89167cb2018-07-08 20:12:23 +02003306 if( ! operation->is_sign )
3307 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003308 return( PSA_ERROR_BAD_STATE );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003309 }
mohammad16036df908f2018-04-02 08:34:15 -07003310
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003311 status = psa_mac_finish_internal( operation, mac, mac_size );
3312
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003313 if( status == PSA_SUCCESS )
3314 {
3315 status = psa_mac_abort( operation );
3316 if( status == PSA_SUCCESS )
3317 *mac_length = operation->mac_size;
3318 else
3319 memset( mac, '!', mac_size );
3320 }
3321 else
3322 psa_mac_abort( operation );
3323 return( status );
mohammad16036df908f2018-04-02 08:34:15 -07003324}
3325
Gilles Peskineacd4be32018-07-08 19:56:25 +02003326psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
3327 const uint8_t *mac,
3328 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003329{
Gilles Peskine828ed142018-06-18 23:25:51 +02003330 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
mohammad16036df908f2018-04-02 08:34:15 -07003331 psa_status_t status;
3332
Jaeden Amero252ef282019-02-15 14:05:35 +00003333 if( operation->alg == 0 )
3334 {
3335 return( PSA_ERROR_BAD_STATE );
3336 }
3337
Gilles Peskine89167cb2018-07-08 20:12:23 +02003338 if( operation->is_sign )
3339 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003340 return( PSA_ERROR_BAD_STATE );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003341 }
3342 if( operation->mac_size != mac_length )
3343 {
3344 status = PSA_ERROR_INVALID_SIGNATURE;
3345 goto cleanup;
Gilles Peskine89167cb2018-07-08 20:12:23 +02003346 }
mohammad16036df908f2018-04-02 08:34:15 -07003347
3348 status = psa_mac_finish_internal( operation,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003349 actual_mac, sizeof( actual_mac ) );
Gilles Peskine28cd4162020-01-20 16:31:06 +01003350 if( status != PSA_SUCCESS )
3351 goto cleanup;
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003352
3353 if( safer_memcmp( mac, actual_mac, mac_length ) != 0 )
3354 status = PSA_ERROR_INVALID_SIGNATURE;
3355
3356cleanup:
3357 if( status == PSA_SUCCESS )
3358 status = psa_mac_abort( operation );
3359 else
3360 psa_mac_abort( operation );
3361
Gilles Peskine3f108122018-12-07 18:14:53 +01003362 mbedtls_platform_zeroize( actual_mac, sizeof( actual_mac ) );
Gilles Peskined911eb72018-08-14 15:18:45 +02003363
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003364 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003365}
3366
3367
Gilles Peskine20035e32018-02-03 22:44:14 +01003368
Gilles Peskine20035e32018-02-03 22:44:14 +01003369/****************************************************************/
3370/* Asymmetric cryptography */
3371/****************************************************************/
3372
Gilles Peskine2b450e32018-06-27 15:42:46 +02003373#if defined(MBEDTLS_RSA_C)
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02003374/* Decode the hash algorithm from alg and store the mbedtls encoding in
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003375 * md_alg. Verify that the hash length is acceptable. */
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02003376static psa_status_t psa_rsa_decode_md_type( psa_algorithm_t alg,
3377 size_t hash_length,
3378 mbedtls_md_type_t *md_alg )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003379{
Gilles Peskine7ed29c52018-06-26 15:50:08 +02003380 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003381 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003382 *md_alg = mbedtls_md_get_type( md_info );
3383
3384 /* The Mbed TLS RSA module uses an unsigned int for hash length
3385 * parameters. Validate that it fits so that we don't risk an
3386 * overflow later. */
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003387#if SIZE_MAX > UINT_MAX
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003388 if( hash_length > UINT_MAX )
3389 return( PSA_ERROR_INVALID_ARGUMENT );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003390#endif
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003391
3392#if defined(MBEDTLS_PKCS1_V15)
3393 /* For PKCS#1 v1.5 signature, if using a hash, the hash length
3394 * must be correct. */
3395 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) &&
3396 alg != PSA_ALG_RSA_PKCS1V15_SIGN_RAW )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003397 {
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003398 if( md_info == NULL )
3399 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003400 if( mbedtls_md_get_size( md_info ) != hash_length )
3401 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003402 }
3403#endif /* MBEDTLS_PKCS1_V15 */
3404
3405#if defined(MBEDTLS_PKCS1_V21)
3406 /* PSS requires a hash internally. */
3407 if( PSA_ALG_IS_RSA_PSS( alg ) )
3408 {
Gilles Peskine61b91d42018-06-08 16:09:36 +02003409 if( md_info == NULL )
3410 return( PSA_ERROR_NOT_SUPPORTED );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003411 }
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003412#endif /* MBEDTLS_PKCS1_V21 */
3413
Gilles Peskine61b91d42018-06-08 16:09:36 +02003414 return( PSA_SUCCESS );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003415}
3416
Gilles Peskine2b450e32018-06-27 15:42:46 +02003417static psa_status_t psa_rsa_sign( mbedtls_rsa_context *rsa,
3418 psa_algorithm_t alg,
3419 const uint8_t *hash,
3420 size_t hash_length,
3421 uint8_t *signature,
3422 size_t signature_size,
3423 size_t *signature_length )
3424{
3425 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00003426 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003427 mbedtls_md_type_t md_alg;
3428
3429 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
3430 if( status != PSA_SUCCESS )
3431 return( status );
3432
Gilles Peskine630a18a2018-06-29 17:49:35 +02003433 if( signature_size < mbedtls_rsa_get_len( rsa ) )
Gilles Peskine2b450e32018-06-27 15:42:46 +02003434 return( PSA_ERROR_BUFFER_TOO_SMALL );
3435
3436#if defined(MBEDTLS_PKCS1_V15)
3437 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
3438 {
3439 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
3440 MBEDTLS_MD_NONE );
3441 ret = mbedtls_rsa_pkcs1_sign( rsa,
3442 mbedtls_ctr_drbg_random,
3443 &global_data.ctr_drbg,
3444 MBEDTLS_RSA_PRIVATE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003445 md_alg,
3446 (unsigned int) hash_length,
3447 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003448 signature );
3449 }
3450 else
3451#endif /* MBEDTLS_PKCS1_V15 */
3452#if defined(MBEDTLS_PKCS1_V21)
3453 if( PSA_ALG_IS_RSA_PSS( alg ) )
3454 {
3455 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3456 ret = mbedtls_rsa_rsassa_pss_sign( rsa,
3457 mbedtls_ctr_drbg_random,
3458 &global_data.ctr_drbg,
3459 MBEDTLS_RSA_PRIVATE,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003460 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003461 (unsigned int) hash_length,
3462 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003463 signature );
3464 }
3465 else
3466#endif /* MBEDTLS_PKCS1_V21 */
3467 {
3468 return( PSA_ERROR_INVALID_ARGUMENT );
3469 }
3470
3471 if( ret == 0 )
Gilles Peskine630a18a2018-06-29 17:49:35 +02003472 *signature_length = mbedtls_rsa_get_len( rsa );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003473 return( mbedtls_to_psa_error( ret ) );
3474}
3475
3476static psa_status_t psa_rsa_verify( mbedtls_rsa_context *rsa,
3477 psa_algorithm_t alg,
3478 const uint8_t *hash,
3479 size_t hash_length,
3480 const uint8_t *signature,
3481 size_t signature_length )
3482{
3483 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00003484 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003485 mbedtls_md_type_t md_alg;
3486
3487 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
3488 if( status != PSA_SUCCESS )
3489 return( status );
3490
Gilles Peskine89cc74f2019-09-12 22:08:23 +02003491 if( signature_length != mbedtls_rsa_get_len( rsa ) )
3492 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003493
3494#if defined(MBEDTLS_PKCS1_V15)
3495 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
3496 {
3497 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
3498 MBEDTLS_MD_NONE );
3499 ret = mbedtls_rsa_pkcs1_verify( rsa,
3500 mbedtls_ctr_drbg_random,
3501 &global_data.ctr_drbg,
3502 MBEDTLS_RSA_PUBLIC,
3503 md_alg,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003504 (unsigned int) hash_length,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003505 hash,
3506 signature );
3507 }
3508 else
3509#endif /* MBEDTLS_PKCS1_V15 */
3510#if defined(MBEDTLS_PKCS1_V21)
3511 if( PSA_ALG_IS_RSA_PSS( alg ) )
3512 {
3513 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3514 ret = mbedtls_rsa_rsassa_pss_verify( rsa,
3515 mbedtls_ctr_drbg_random,
3516 &global_data.ctr_drbg,
3517 MBEDTLS_RSA_PUBLIC,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003518 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003519 (unsigned int) hash_length,
3520 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003521 signature );
3522 }
3523 else
3524#endif /* MBEDTLS_PKCS1_V21 */
3525 {
3526 return( PSA_ERROR_INVALID_ARGUMENT );
3527 }
Gilles Peskineef12c632018-09-13 20:37:48 +02003528
3529 /* Mbed TLS distinguishes "invalid padding" from "valid padding but
3530 * the rest of the signature is invalid". This has little use in
3531 * practice and PSA doesn't report this distinction. */
3532 if( ret == MBEDTLS_ERR_RSA_INVALID_PADDING )
3533 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003534 return( mbedtls_to_psa_error( ret ) );
3535}
3536#endif /* MBEDTLS_RSA_C */
3537
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003538#if defined(MBEDTLS_ECDSA_C)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003539/* `ecp` cannot be const because `ecp->grp` needs to be non-const
3540 * for mbedtls_ecdsa_sign() and mbedtls_ecdsa_sign_det()
3541 * (even though these functions don't modify it). */
3542static psa_status_t psa_ecdsa_sign( mbedtls_ecp_keypair *ecp,
3543 psa_algorithm_t alg,
3544 const uint8_t *hash,
3545 size_t hash_length,
3546 uint8_t *signature,
3547 size_t signature_size,
3548 size_t *signature_length )
3549{
Janos Follath24eed8d2019-11-22 13:21:35 +00003550 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003551 mbedtls_mpi r, s;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003552 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003553 mbedtls_mpi_init( &r );
3554 mbedtls_mpi_init( &s );
3555
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003556 if( signature_size < 2 * curve_bytes )
3557 {
3558 ret = MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL;
3559 goto cleanup;
3560 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003561
Gilles Peskinea05219c2018-11-16 16:02:56 +01003562#if defined(MBEDTLS_ECDSA_DETERMINISTIC)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003563 if( PSA_ALG_DSA_IS_DETERMINISTIC( alg ) )
3564 {
3565 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
3566 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3567 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
Darryl Green5e843fa2019-09-05 14:06:34 +01003568 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign_det_ext( &ecp->grp, &r, &s,
3569 &ecp->d, hash,
3570 hash_length, md_alg,
3571 mbedtls_ctr_drbg_random,
3572 &global_data.ctr_drbg ) );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003573 }
3574 else
Gilles Peskinea05219c2018-11-16 16:02:56 +01003575#endif /* MBEDTLS_ECDSA_DETERMINISTIC */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003576 {
Gilles Peskinea05219c2018-11-16 16:02:56 +01003577 (void) alg;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003578 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign( &ecp->grp, &r, &s, &ecp->d,
3579 hash, hash_length,
3580 mbedtls_ctr_drbg_random,
3581 &global_data.ctr_drbg ) );
3582 }
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003583
3584 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &r,
3585 signature,
3586 curve_bytes ) );
3587 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &s,
3588 signature + curve_bytes,
3589 curve_bytes ) );
3590
3591cleanup:
3592 mbedtls_mpi_free( &r );
3593 mbedtls_mpi_free( &s );
3594 if( ret == 0 )
3595 *signature_length = 2 * curve_bytes;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003596 return( mbedtls_to_psa_error( ret ) );
3597}
3598
3599static psa_status_t psa_ecdsa_verify( mbedtls_ecp_keypair *ecp,
3600 const uint8_t *hash,
3601 size_t hash_length,
3602 const uint8_t *signature,
3603 size_t signature_length )
3604{
Janos Follath24eed8d2019-11-22 13:21:35 +00003605 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003606 mbedtls_mpi r, s;
3607 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
3608 mbedtls_mpi_init( &r );
3609 mbedtls_mpi_init( &s );
3610
3611 if( signature_length != 2 * curve_bytes )
3612 return( PSA_ERROR_INVALID_SIGNATURE );
3613
3614 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &r,
3615 signature,
3616 curve_bytes ) );
3617 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &s,
3618 signature + curve_bytes,
3619 curve_bytes ) );
3620
Steven Cooremanacda8342020-07-24 23:09:52 +02003621 /* Check whether the public part is loaded. If not, load it. */
3622 if( mbedtls_ecp_is_zero( &ecp->Q ) )
3623 {
3624 MBEDTLS_MPI_CHK(
3625 mbedtls_ecp_mul( &ecp->grp, &ecp->Q, &ecp->d, &ecp->grp.G,
3626 mbedtls_ctr_drbg_random, &global_data.ctr_drbg ) );
3627 }
3628
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003629 ret = mbedtls_ecdsa_verify( &ecp->grp, hash, hash_length,
3630 &ecp->Q, &r, &s );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003631
3632cleanup:
3633 mbedtls_mpi_free( &r );
3634 mbedtls_mpi_free( &s );
3635 return( mbedtls_to_psa_error( ret ) );
3636}
3637#endif /* MBEDTLS_ECDSA_C */
3638
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003639psa_status_t psa_sign_hash( psa_key_handle_t handle,
3640 psa_algorithm_t alg,
3641 const uint8_t *hash,
3642 size_t hash_length,
3643 uint8_t *signature,
3644 size_t signature_size,
3645 size_t *signature_length )
Gilles Peskine20035e32018-02-03 22:44:14 +01003646{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003647 psa_key_slot_t *slot;
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003648 psa_status_t status;
3649
3650 *signature_length = signature_size;
Gilles Peskine4019f0e2019-09-12 22:05:59 +02003651 /* Immediately reject a zero-length signature buffer. This guarantees
3652 * that signature must be a valid pointer. (On the other hand, the hash
3653 * buffer can in principle be empty since it doesn't actually have
3654 * to be a hash.) */
3655 if( signature_size == 0 )
3656 return( PSA_ERROR_BUFFER_TOO_SMALL );
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003657
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003658 status = psa_get_key_from_slot( handle, &slot, PSA_KEY_USAGE_SIGN_HASH, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003659 if( status != PSA_SUCCESS )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003660 goto exit;
Gilles Peskine8e338702019-07-30 20:06:31 +02003661 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003662 {
3663 status = PSA_ERROR_INVALID_ARGUMENT;
3664 goto exit;
3665 }
Gilles Peskine20035e32018-02-03 22:44:14 +01003666
Steven Cooremancd84cb42020-07-16 20:28:36 +02003667 /* Try any of the available accelerators first */
3668 status = psa_driver_wrapper_sign_hash( slot,
3669 alg,
3670 hash,
3671 hash_length,
3672 signature,
3673 signature_size,
3674 signature_length );
Steven Cooreman8d2bde72020-09-04 13:06:39 +02003675 if( status != PSA_ERROR_NOT_SUPPORTED ||
3676 psa_key_lifetime_is_external( slot->attr.lifetime ) )
Steven Cooremancd84cb42020-07-16 20:28:36 +02003677 goto exit;
3678
Steven Cooreman7a250572020-07-17 16:43:05 +02003679 /* If the operation was not supported by any accelerator, try fallback. */
Gilles Peskine20035e32018-02-03 22:44:14 +01003680#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003681 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskine20035e32018-02-03 22:44:14 +01003682 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003683 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02003684
Steven Cooreman4fed4552020-08-03 14:46:03 +02003685 status = psa_load_rsa_representation( slot->attr.type,
3686 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02003687 slot->data.key.bytes,
Steven Cooremana01795d2020-07-24 22:48:15 +02003688 &rsa );
3689 if( status != PSA_SUCCESS )
3690 goto exit;
3691
Steven Cooremana2371e52020-07-28 14:30:39 +02003692 status = psa_rsa_sign( rsa,
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003693 alg,
3694 hash, hash_length,
3695 signature, signature_size,
3696 signature_length );
Steven Cooremana01795d2020-07-24 22:48:15 +02003697
Steven Cooremana2371e52020-07-28 14:30:39 +02003698 mbedtls_rsa_free( rsa );
3699 mbedtls_free( rsa );
Gilles Peskine20035e32018-02-03 22:44:14 +01003700 }
3701 else
3702#endif /* defined(MBEDTLS_RSA_C) */
3703#if defined(MBEDTLS_ECP_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003704 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
Gilles Peskine20035e32018-02-03 22:44:14 +01003705 {
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003706#if defined(MBEDTLS_ECDSA_C)
Gilles Peskinea05219c2018-11-16 16:02:56 +01003707 if(
3708#if defined(MBEDTLS_ECDSA_DETERMINISTIC)
3709 PSA_ALG_IS_ECDSA( alg )
3710#else
3711 PSA_ALG_IS_RANDOMIZED_ECDSA( alg )
3712#endif
3713 )
Steven Cooremanacda8342020-07-24 23:09:52 +02003714 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003715 mbedtls_ecp_keypair *ecp = NULL;
Steven Cooreman4fed4552020-08-03 14:46:03 +02003716 status = psa_load_ecp_representation( slot->attr.type,
3717 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02003718 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02003719 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003720 if( status != PSA_SUCCESS )
3721 goto exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003722 status = psa_ecdsa_sign( ecp,
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003723 alg,
3724 hash, hash_length,
3725 signature, signature_size,
3726 signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02003727 mbedtls_ecp_keypair_free( ecp );
3728 mbedtls_free( ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003729 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003730 else
3731#endif /* defined(MBEDTLS_ECDSA_C) */
3732 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003733 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003734 }
itayzafrir5c753392018-05-08 11:18:38 +03003735 }
3736 else
3737#endif /* defined(MBEDTLS_ECP_C) */
3738 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003739 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine20035e32018-02-03 22:44:14 +01003740 }
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003741
3742exit:
3743 /* Fill the unused part of the output buffer (the whole buffer on error,
3744 * the trailing part on success) with something that isn't a valid mac
3745 * (barring an attack on the mac and deliberately-crafted input),
3746 * in case the caller doesn't check the return status properly. */
3747 if( status == PSA_SUCCESS )
3748 memset( signature + *signature_length, '!',
3749 signature_size - *signature_length );
Gilles Peskine4019f0e2019-09-12 22:05:59 +02003750 else
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003751 memset( signature, '!', signature_size );
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003752 /* If signature_size is 0 then we have nothing to do. We must not call
3753 * memset because signature may be NULL in this case. */
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003754 return( status );
itayzafrir5c753392018-05-08 11:18:38 +03003755}
3756
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003757psa_status_t psa_verify_hash( psa_key_handle_t handle,
3758 psa_algorithm_t alg,
3759 const uint8_t *hash,
3760 size_t hash_length,
3761 const uint8_t *signature,
3762 size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03003763{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003764 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003765 psa_status_t status;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003766
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003767 status = psa_get_key_from_slot( handle, &slot, PSA_KEY_USAGE_VERIFY_HASH, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003768 if( status != PSA_SUCCESS )
3769 return( status );
itayzafrir5c753392018-05-08 11:18:38 +03003770
Steven Cooreman55ae2172020-07-17 19:46:15 +02003771 /* Try any of the available accelerators first */
3772 status = psa_driver_wrapper_verify_hash( slot,
3773 alg,
3774 hash,
3775 hash_length,
3776 signature,
3777 signature_length );
Steven Cooreman8d2bde72020-09-04 13:06:39 +02003778 if( status != PSA_ERROR_NOT_SUPPORTED ||
3779 psa_key_lifetime_is_external( slot->attr.lifetime ) )
Steven Cooreman55ae2172020-07-17 19:46:15 +02003780 return status;
3781
Gilles Peskine61b91d42018-06-08 16:09:36 +02003782#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003783 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003784 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003785 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02003786
Steven Cooreman4fed4552020-08-03 14:46:03 +02003787 status = psa_load_rsa_representation( slot->attr.type,
3788 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02003789 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02003790 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003791 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02003792 return( status );
Steven Cooremana01795d2020-07-24 22:48:15 +02003793
Steven Cooremana2371e52020-07-28 14:30:39 +02003794 status = psa_rsa_verify( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02003795 alg,
3796 hash, hash_length,
3797 signature, signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02003798 mbedtls_rsa_free( rsa );
3799 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003800 return( status );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003801 }
3802 else
3803#endif /* defined(MBEDTLS_RSA_C) */
itayzafrir5c753392018-05-08 11:18:38 +03003804#if defined(MBEDTLS_ECP_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003805 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
itayzafrir5c753392018-05-08 11:18:38 +03003806 {
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003807#if defined(MBEDTLS_ECDSA_C)
3808 if( PSA_ALG_IS_ECDSA( alg ) )
Steven Cooremanacda8342020-07-24 23:09:52 +02003809 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003810 mbedtls_ecp_keypair *ecp = NULL;
Steven Cooreman4fed4552020-08-03 14:46:03 +02003811 status = psa_load_ecp_representation( slot->attr.type,
3812 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02003813 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02003814 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003815 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02003816 return( status );
Steven Cooremana2371e52020-07-28 14:30:39 +02003817 status = psa_ecdsa_verify( ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02003818 hash, hash_length,
3819 signature, signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02003820 mbedtls_ecp_keypair_free( ecp );
3821 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02003822 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02003823 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003824 else
3825#endif /* defined(MBEDTLS_ECDSA_C) */
3826 {
3827 return( PSA_ERROR_INVALID_ARGUMENT );
3828 }
itayzafrir5c753392018-05-08 11:18:38 +03003829 }
Gilles Peskine20035e32018-02-03 22:44:14 +01003830 else
3831#endif /* defined(MBEDTLS_ECP_C) */
3832 {
3833 return( PSA_ERROR_NOT_SUPPORTED );
3834 }
3835}
3836
Gilles Peskine072ac562018-06-30 00:21:29 +02003837#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PKCS1_V21)
3838static void psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
3839 mbedtls_rsa_context *rsa )
3840{
3841 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
3842 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3843 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
3844 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3845}
3846#endif /* defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PKCS1_V21) */
3847
Gilles Peskinec5487a82018-12-03 18:08:14 +01003848psa_status_t psa_asymmetric_encrypt( psa_key_handle_t handle,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003849 psa_algorithm_t alg,
3850 const uint8_t *input,
3851 size_t input_length,
3852 const uint8_t *salt,
3853 size_t salt_length,
3854 uint8_t *output,
3855 size_t output_size,
3856 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003857{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003858 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003859 psa_status_t status;
3860
Darryl Green5cc689a2018-07-24 15:34:10 +01003861 (void) input;
3862 (void) input_length;
3863 (void) salt;
3864 (void) output;
3865 (void) output_size;
3866
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003867 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003868
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003869 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3870 return( PSA_ERROR_INVALID_ARGUMENT );
3871
Gilles Peskine28f8f302019-07-24 13:30:31 +02003872 status = psa_get_transparent_key( handle, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003873 if( status != PSA_SUCCESS )
3874 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003875 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
3876 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003877 return( PSA_ERROR_INVALID_ARGUMENT );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003878
3879#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003880 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003881 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003882 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman4fed4552020-08-03 14:46:03 +02003883 status = psa_load_rsa_representation( slot->attr.type,
3884 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02003885 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02003886 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003887 if( status != PSA_SUCCESS )
Steven Cooreman4fed4552020-08-03 14:46:03 +02003888 goto rsa_exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003889
3890 if( output_size < mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003891 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003892 status = PSA_ERROR_BUFFER_TOO_SMALL;
3893 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003894 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003895#if defined(MBEDTLS_PKCS1_V15)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003896 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003897 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003898 status = mbedtls_to_psa_error(
3899 mbedtls_rsa_pkcs1_encrypt( rsa,
3900 mbedtls_ctr_drbg_random,
3901 &global_data.ctr_drbg,
3902 MBEDTLS_RSA_PUBLIC,
3903 input_length,
3904 input,
3905 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003906 }
3907 else
3908#endif /* MBEDTLS_PKCS1_V15 */
3909#if defined(MBEDTLS_PKCS1_V21)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003910 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003911 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003912 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02003913 status = mbedtls_to_psa_error(
3914 mbedtls_rsa_rsaes_oaep_encrypt( rsa,
3915 mbedtls_ctr_drbg_random,
3916 &global_data.ctr_drbg,
3917 MBEDTLS_RSA_PUBLIC,
3918 salt, salt_length,
3919 input_length,
3920 input,
3921 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003922 }
3923 else
3924#endif /* MBEDTLS_PKCS1_V21 */
3925 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003926 status = PSA_ERROR_INVALID_ARGUMENT;
3927 goto rsa_exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003928 }
Steven Cooreman4fed4552020-08-03 14:46:03 +02003929rsa_exit:
3930 if( status == PSA_SUCCESS )
Steven Cooremana2371e52020-07-28 14:30:39 +02003931 *output_length = mbedtls_rsa_get_len( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003932
Steven Cooremana2371e52020-07-28 14:30:39 +02003933 mbedtls_rsa_free( rsa );
3934 mbedtls_free( rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02003935 return( status );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003936 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003937 else
Gilles Peskineb75e4f12018-06-08 17:44:47 +02003938#endif /* defined(MBEDTLS_RSA_C) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003939 {
3940 return( PSA_ERROR_NOT_SUPPORTED );
3941 }
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003942}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003943
Gilles Peskinec5487a82018-12-03 18:08:14 +01003944psa_status_t psa_asymmetric_decrypt( psa_key_handle_t handle,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003945 psa_algorithm_t alg,
3946 const uint8_t *input,
3947 size_t input_length,
3948 const uint8_t *salt,
3949 size_t salt_length,
3950 uint8_t *output,
3951 size_t output_size,
3952 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003953{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003954 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003955 psa_status_t status;
3956
Darryl Green5cc689a2018-07-24 15:34:10 +01003957 (void) input;
3958 (void) input_length;
3959 (void) salt;
3960 (void) output;
3961 (void) output_size;
3962
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003963 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003964
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003965 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3966 return( PSA_ERROR_INVALID_ARGUMENT );
3967
Gilles Peskine28f8f302019-07-24 13:30:31 +02003968 status = psa_get_transparent_key( handle, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003969 if( status != PSA_SUCCESS )
3970 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003971 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003972 return( PSA_ERROR_INVALID_ARGUMENT );
3973
3974#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003975 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003976 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003977 mbedtls_rsa_context *rsa = NULL;
3978 status = psa_load_rsa_representation( slot->attr.type,
3979 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02003980 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02003981 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003982 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02003983 return( status );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003984
Steven Cooremana2371e52020-07-28 14:30:39 +02003985 if( input_length != mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003986 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003987 status = PSA_ERROR_INVALID_ARGUMENT;
3988 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003989 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003990
3991#if defined(MBEDTLS_PKCS1_V15)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003992 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003993 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003994 status = mbedtls_to_psa_error(
3995 mbedtls_rsa_pkcs1_decrypt( rsa,
3996 mbedtls_ctr_drbg_random,
3997 &global_data.ctr_drbg,
3998 MBEDTLS_RSA_PRIVATE,
3999 output_length,
4000 input,
4001 output,
4002 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004003 }
4004 else
4005#endif /* MBEDTLS_PKCS1_V15 */
4006#if defined(MBEDTLS_PKCS1_V21)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02004007 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004008 {
Steven Cooremana2371e52020-07-28 14:30:39 +02004009 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02004010 status = mbedtls_to_psa_error(
4011 mbedtls_rsa_rsaes_oaep_decrypt( rsa,
4012 mbedtls_ctr_drbg_random,
4013 &global_data.ctr_drbg,
4014 MBEDTLS_RSA_PRIVATE,
4015 salt, salt_length,
4016 output_length,
4017 input,
4018 output,
4019 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004020 }
4021 else
4022#endif /* MBEDTLS_PKCS1_V21 */
4023 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004024 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004025 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03004026
Steven Cooreman4fed4552020-08-03 14:46:03 +02004027rsa_exit:
Steven Cooremana2371e52020-07-28 14:30:39 +02004028 mbedtls_rsa_free( rsa );
4029 mbedtls_free( rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02004030 return( status );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004031 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004032 else
Gilles Peskineb75e4f12018-06-08 17:44:47 +02004033#endif /* defined(MBEDTLS_RSA_C) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004034 {
4035 return( PSA_ERROR_NOT_SUPPORTED );
4036 }
Gilles Peskine5b051bc2018-05-31 13:25:48 +02004037}
Gilles Peskine20035e32018-02-03 22:44:14 +01004038
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004039
4040
mohammad1603503973b2018-03-12 15:59:30 +02004041/****************************************************************/
4042/* Symmetric cryptography */
4043/****************************************************************/
4044
Gilles Peskinee553c652018-06-04 16:22:46 +02004045static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01004046 psa_key_handle_t handle,
Gilles Peskine7e928852018-06-04 16:23:10 +02004047 psa_algorithm_t alg,
4048 mbedtls_operation_t cipher_operation )
mohammad1603503973b2018-03-12 15:59:30 +02004049{
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004050 int ret = 0;
4051 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Gilles Peskine2f060a82018-12-04 17:12:32 +01004052 psa_key_slot_t *slot;
mohammad1603503973b2018-03-12 15:59:30 +02004053 size_t key_bits;
4054 const mbedtls_cipher_info_t *cipher_info = NULL;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004055 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
4056 PSA_KEY_USAGE_ENCRYPT :
4057 PSA_KEY_USAGE_DECRYPT );
mohammad1603503973b2018-03-12 15:59:30 +02004058
Steven Cooremand3feccd2020-09-01 15:56:14 +02004059 /* A context must be freshly initialized before it can be set up. */
4060 if( operation->alg != 0 )
4061 return( PSA_ERROR_BAD_STATE );
4062
Steven Cooremana07b9972020-09-10 14:54:14 +02004063 /* The requested algorithm must be one that can be processed by cipher. */
4064 if( ! PSA_ALG_IS_CIPHER( alg ) )
Steven Cooremana07b9972020-09-10 14:54:14 +02004065 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremand3feccd2020-09-01 15:56:14 +02004066
Steven Cooremanef8575e2020-09-11 11:44:50 +02004067 /* Fetch key material from key storage. */
4068 status = psa_get_key_from_slot( handle, &slot, usage, alg );
4069 if( status != PSA_SUCCESS )
4070 goto exit;
4071
4072 /* Initialize the operation struct members, except for alg. The alg member
4073 * is used to indicate to psa_cipher_abort that there are resources to free,
4074 * so we only set it after resources have been allocated/initialized. */
Steven Cooremana07b9972020-09-10 14:54:14 +02004075 operation->key_set = 0;
4076 operation->iv_set = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004077 operation->mbedtls_in_use = 0;
Steven Cooremana07b9972020-09-10 14:54:14 +02004078 operation->iv_size = 0;
4079 operation->block_size = 0;
4080 if( alg == PSA_ALG_ECB_NO_PADDING )
4081 operation->iv_required = 0;
4082 else
4083 operation->iv_required = 1;
4084
Steven Cooremana07b9972020-09-10 14:54:14 +02004085 /* Try doing the operation through a driver before using software fallback. */
Steven Cooreman37941cb2020-07-28 18:49:51 +02004086 if( cipher_operation == MBEDTLS_ENCRYPT )
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004087 status = psa_driver_wrapper_cipher_encrypt_setup( &operation->ctx.driver,
Steven Cooreman37941cb2020-07-28 18:49:51 +02004088 slot,
4089 alg );
4090 else
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004091 status = psa_driver_wrapper_cipher_decrypt_setup( &operation->ctx.driver,
Steven Cooreman37941cb2020-07-28 18:49:51 +02004092 slot,
4093 alg );
4094
Steven Cooremanef8575e2020-09-11 11:44:50 +02004095 if( status == PSA_SUCCESS )
Steven Cooreman6d81f7e2020-09-14 13:14:31 +02004096 {
Steven Cooremanef8575e2020-09-11 11:44:50 +02004097 /* Once the driver context is initialised, it needs to be freed using
4098 * psa_cipher_abort. Indicate this through setting alg. */
4099 operation->alg = alg;
Steven Cooreman6d81f7e2020-09-14 13:14:31 +02004100 }
Steven Cooremanef8575e2020-09-11 11:44:50 +02004101
Steven Cooremand3feccd2020-09-01 15:56:14 +02004102 if( status != PSA_ERROR_NOT_SUPPORTED ||
4103 psa_key_lifetime_is_external( slot->attr.lifetime ) )
4104 goto exit;
4105
Steven Cooremana07b9972020-09-10 14:54:14 +02004106 /* Proceed with initializing an mbed TLS cipher context if no driver is
Steven Cooremand3feccd2020-09-01 15:56:14 +02004107 * available for the given algorithm & key. */
4108 mbedtls_cipher_init( &operation->ctx.cipher );
mohammad1603503973b2018-03-12 15:59:30 +02004109
Steven Cooremana07b9972020-09-10 14:54:14 +02004110 /* Once the cipher context is initialised, it needs to be freed using
Steven Cooremanef8575e2020-09-11 11:44:50 +02004111 * psa_cipher_abort. Indicate there is something to be freed through setting
4112 * alg, and indicate the operation is being done using mbedtls crypto through
4113 * setting mbedtls_in_use. */
Steven Cooremana07b9972020-09-10 14:54:14 +02004114 operation->alg = alg;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004115 operation->mbedtls_in_use = 1;
Steven Cooremana07b9972020-09-10 14:54:14 +02004116
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02004117 key_bits = psa_get_key_slot_bits( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +02004118 cipher_info = mbedtls_cipher_info_from_psa( alg, slot->attr.type, key_bits, NULL );
mohammad1603503973b2018-03-12 15:59:30 +02004119 if( cipher_info == NULL )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004120 {
4121 status = PSA_ERROR_NOT_SUPPORTED;
4122 goto exit;
4123 }
mohammad1603503973b2018-03-12 15:59:30 +02004124
mohammad1603503973b2018-03-12 15:59:30 +02004125 ret = mbedtls_cipher_setup( &operation->ctx.cipher, cipher_info );
Moran Peker41deec42018-04-04 15:43:05 +03004126 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004127 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004128
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004129#if defined(MBEDTLS_DES_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02004130 if( slot->attr.type == PSA_KEY_TYPE_DES && key_bits == 128 )
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004131 {
4132 /* Two-key Triple-DES is 3-key Triple-DES with K1=K3 */
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02004133 uint8_t keys[24];
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004134 memcpy( keys, slot->data.key.data, 16 );
4135 memcpy( keys + 16, slot->data.key.data, 8 );
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004136 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
4137 keys,
4138 192, cipher_operation );
4139 }
4140 else
4141#endif
4142 {
4143 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004144 slot->data.key.data,
Jaeden Amero23bbb752018-06-26 14:16:54 +01004145 (int) key_bits, cipher_operation );
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004146 }
Moran Peker41deec42018-04-04 15:43:05 +03004147 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004148 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004149
mohammad16038481e742018-03-18 13:57:31 +02004150#if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004151 switch( alg )
mohammad16038481e742018-03-18 13:57:31 +02004152 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004153 case PSA_ALG_CBC_NO_PADDING:
4154 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
4155 MBEDTLS_PADDING_NONE );
4156 break;
4157 case PSA_ALG_CBC_PKCS7:
4158 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
4159 MBEDTLS_PADDING_PKCS7 );
4160 break;
4161 default:
4162 /* The algorithm doesn't involve padding. */
4163 ret = 0;
4164 break;
4165 }
4166 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004167 goto exit;
mohammad16038481e742018-03-18 13:57:31 +02004168#endif //MBEDTLS_CIPHER_MODE_WITH_PADDING
4169
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004170 operation->block_size = ( PSA_ALG_IS_STREAM_CIPHER( alg ) ? 1 :
Gilles Peskine8e338702019-07-30 20:06:31 +02004171 PSA_BLOCK_CIPHER_BLOCK_SIZE( slot->attr.type ) );
Steven Cooremana6033e92020-08-25 11:47:50 +02004172 if( ( alg & PSA_ALG_CIPHER_FROM_BLOCK_FLAG ) != 0 &&
4173 alg != PSA_ALG_ECB_NO_PADDING )
mohammad16038481e742018-03-18 13:57:31 +02004174 {
Gilles Peskine8e338702019-07-30 20:06:31 +02004175 operation->iv_size = PSA_BLOCK_CIPHER_BLOCK_SIZE( slot->attr.type );
mohammad16038481e742018-03-18 13:57:31 +02004176 }
Gilles Peskine26869f22019-05-06 15:25:00 +02004177#if defined(MBEDTLS_CHACHA20_C)
4178 else
4179 if( alg == PSA_ALG_CHACHA20 )
4180 operation->iv_size = 12;
4181#endif
mohammad1603503973b2018-03-12 15:59:30 +02004182
Steven Cooreman7df02922020-09-09 15:28:49 +02004183 status = PSA_SUCCESS;
4184
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004185exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02004186 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004187 status = mbedtls_to_psa_error( ret );
Steven Cooreman7df02922020-09-09 15:28:49 +02004188 if( status == PSA_SUCCESS )
4189 {
4190 /* Update operation flags for both driver and software implementations */
4191 operation->key_set = 1;
4192 }
4193 else
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004194 psa_cipher_abort( operation );
4195 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004196}
4197
Gilles Peskinefe119512018-07-08 21:39:34 +02004198psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01004199 psa_key_handle_t handle,
Gilles Peskinefe119512018-07-08 21:39:34 +02004200 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02004201{
Gilles Peskinec5487a82018-12-03 18:08:14 +01004202 return( psa_cipher_setup( operation, handle, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02004203}
4204
Gilles Peskinefe119512018-07-08 21:39:34 +02004205psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01004206 psa_key_handle_t handle,
Gilles Peskinefe119512018-07-08 21:39:34 +02004207 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02004208{
Gilles Peskinec5487a82018-12-03 18:08:14 +01004209 return( psa_cipher_setup( operation, handle, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02004210}
4211
Gilles Peskinefe119512018-07-08 21:39:34 +02004212psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004213 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02004214 size_t iv_size,
4215 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02004216{
itayzafrir534bd7c2018-08-02 13:56:32 +03004217 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00004218 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooreman7df02922020-09-09 15:28:49 +02004219 if( operation->iv_set || ! operation->iv_required )
4220 {
4221 return( PSA_ERROR_BAD_STATE );
4222 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004223
Steven Cooremanef8575e2020-09-11 11:44:50 +02004224 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004225 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004226 status = psa_driver_wrapper_cipher_generate_iv( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004227 iv,
4228 iv_size,
4229 iv_length );
4230 goto exit;
4231 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004232
Moran Peker41deec42018-04-04 15:43:05 +03004233 if( iv_size < operation->iv_size )
mohammad1603503973b2018-03-12 15:59:30 +02004234 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004235 status = PSA_ERROR_BUFFER_TOO_SMALL;
Moran Peker41deec42018-04-04 15:43:05 +03004236 goto exit;
4237 }
Gilles Peskine7e928852018-06-04 16:23:10 +02004238 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg,
4239 iv, operation->iv_size );
Moran Peker41deec42018-04-04 15:43:05 +03004240 if( ret != 0 )
4241 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004242 status = mbedtls_to_psa_error( ret );
Gilles Peskinee553c652018-06-04 16:22:46 +02004243 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004244 }
Gilles Peskinee553c652018-06-04 16:22:46 +02004245
mohammad16038481e742018-03-18 13:57:31 +02004246 *iv_length = operation->iv_size;
itayzafrir534bd7c2018-08-02 13:56:32 +03004247 status = psa_cipher_set_iv( operation, iv, *iv_length );
Moran Peker41deec42018-04-04 15:43:05 +03004248
Moran Peker395db872018-05-31 14:07:14 +03004249exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02004250 if( status == PSA_SUCCESS )
4251 operation->iv_set = 1;
4252 else
Moran Peker395db872018-05-31 14:07:14 +03004253 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004254 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004255}
4256
Gilles Peskinefe119512018-07-08 21:39:34 +02004257psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004258 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02004259 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02004260{
itayzafrir534bd7c2018-08-02 13:56:32 +03004261 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00004262 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooreman7df02922020-09-09 15:28:49 +02004263 if( operation->iv_set || ! operation->iv_required )
4264 {
4265 return( PSA_ERROR_BAD_STATE );
4266 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004267
Steven Cooremanef8575e2020-09-11 11:44:50 +02004268 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004269 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004270 status = psa_driver_wrapper_cipher_set_iv( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004271 iv,
4272 iv_length );
4273 goto exit;
4274 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004275
Moran Pekera28258c2018-05-29 16:25:04 +03004276 if( iv_length != operation->iv_size )
Moran Peker71f19ae2018-04-22 20:23:16 +03004277 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004278 status = PSA_ERROR_INVALID_ARGUMENT;
4279 goto exit;
Moran Peker71f19ae2018-04-22 20:23:16 +03004280 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004281 ret = mbedtls_cipher_set_iv( &operation->ctx.cipher, iv, iv_length );
4282 status = mbedtls_to_psa_error( ret );
4283exit:
4284 if( status == PSA_SUCCESS )
4285 operation->iv_set = 1;
4286 else
mohammad1603503973b2018-03-12 15:59:30 +02004287 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004288 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004289}
4290
Steven Cooreman177deba2020-09-07 17:14:14 +02004291/* Process input for which the algorithm is set to ECB mode. This requires
4292 * manual processing, since the PSA API is defined as being able to process
4293 * arbitrary-length calls to psa_cipher_update() with ECB mode, but the
4294 * underlying mbedtls_cipher_update only takes full blocks. */
4295static psa_status_t psa_cipher_update_ecb_internal(
4296 mbedtls_cipher_context_t *ctx,
4297 const uint8_t *input,
4298 size_t input_length,
4299 uint8_t *output,
4300 size_t output_size,
4301 size_t *output_length )
4302{
4303 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4304 size_t block_size = ctx->cipher_info->block_size;
4305 size_t internal_output_length = 0;
4306 *output_length = 0;
4307
4308 if( input_length == 0 )
4309 {
4310 status = PSA_SUCCESS;
4311 goto exit;
4312 }
4313
4314 if( ctx->unprocessed_len > 0 )
4315 {
4316 /* Fill up to block size, and run the block if there's a full one. */
4317 size_t bytes_to_copy = block_size - ctx->unprocessed_len;
4318
4319 if( input_length < bytes_to_copy )
4320 bytes_to_copy = input_length;
4321
4322 memcpy( &( ctx->unprocessed_data[ctx->unprocessed_len] ),
4323 input, bytes_to_copy );
4324 input_length -= bytes_to_copy;
4325 input += bytes_to_copy;
4326 ctx->unprocessed_len += bytes_to_copy;
4327
4328 if( ctx->unprocessed_len == block_size )
4329 {
4330 status = mbedtls_to_psa_error(
4331 mbedtls_cipher_update( ctx,
4332 ctx->unprocessed_data,
4333 block_size,
4334 output, &internal_output_length ) );
4335
4336 if( status != PSA_SUCCESS )
4337 goto exit;
4338
4339 output += internal_output_length;
4340 output_size -= internal_output_length;
4341 *output_length += internal_output_length;
4342 ctx->unprocessed_len = 0;
4343 }
4344 }
4345
4346 while( input_length >= block_size )
4347 {
4348 /* Run all full blocks we have, one by one */
4349 status = mbedtls_to_psa_error(
4350 mbedtls_cipher_update( ctx, input,
4351 block_size,
4352 output, &internal_output_length ) );
4353
4354 if( status != PSA_SUCCESS )
4355 goto exit;
4356
4357 input_length -= block_size;
4358 input += block_size;
4359
4360 output += internal_output_length;
4361 output_size -= internal_output_length;
4362 *output_length += internal_output_length;
4363 }
4364
4365 if( input_length > 0 )
4366 {
4367 /* Save unprocessed bytes for later processing */
4368 memcpy( &( ctx->unprocessed_data[ctx->unprocessed_len] ),
4369 input, input_length );
4370 ctx->unprocessed_len += input_length;
4371 }
4372
4373 status = PSA_SUCCESS;
4374
4375exit:
4376 return( status );
4377}
4378
Gilles Peskinee553c652018-06-04 16:22:46 +02004379psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
4380 const uint8_t *input,
4381 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004382 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02004383 size_t output_size,
4384 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02004385{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004386 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine89d789c2018-06-04 17:17:16 +02004387 size_t expected_output_size;
Steven Cooreman7df02922020-09-09 15:28:49 +02004388 if( operation->alg == 0 )
4389 {
4390 return( PSA_ERROR_BAD_STATE );
4391 }
4392 if( operation->iv_required && ! operation->iv_set )
4393 {
4394 return( PSA_ERROR_BAD_STATE );
4395 }
Jaeden Ameroab439972019-02-15 14:12:05 +00004396
Steven Cooremanef8575e2020-09-11 11:44:50 +02004397 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004398 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004399 status = psa_driver_wrapper_cipher_update( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004400 input,
4401 input_length,
4402 output,
4403 output_size,
4404 output_length );
4405 goto exit;
4406 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004407
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004408 if( ! PSA_ALG_IS_STREAM_CIPHER( operation->alg ) )
Gilles Peskine89d789c2018-06-04 17:17:16 +02004409 {
4410 /* Take the unprocessed partial block left over from previous
4411 * update calls, if any, plus the input to this call. Remove
4412 * the last partial block, if any. You get the data that will be
4413 * output in this call. */
4414 expected_output_size =
4415 ( operation->ctx.cipher.unprocessed_len + input_length )
4416 / operation->block_size * operation->block_size;
4417 }
4418 else
4419 {
4420 expected_output_size = input_length;
4421 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004422
Gilles Peskine89d789c2018-06-04 17:17:16 +02004423 if( output_size < expected_output_size )
itayzafrir534bd7c2018-08-02 13:56:32 +03004424 {
4425 status = PSA_ERROR_BUFFER_TOO_SMALL;
4426 goto exit;
4427 }
mohammad160382759612018-03-12 18:16:40 +02004428
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004429 if( operation->alg == PSA_ALG_ECB_NO_PADDING )
4430 {
4431 /* mbedtls_cipher_update has an API inconsistency: it will only
4432 * process a single block at a time in ECB mode. Abstract away that
4433 * inconsistency here to match the PSA API behaviour. */
Steven Cooreman177deba2020-09-07 17:14:14 +02004434 status = psa_cipher_update_ecb_internal( &operation->ctx.cipher,
4435 input,
4436 input_length,
4437 output,
4438 output_size,
4439 output_length );
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004440 }
4441 else
4442 {
4443 status = mbedtls_to_psa_error(
4444 mbedtls_cipher_update( &operation->ctx.cipher, input,
4445 input_length, output, output_length ) );
4446 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004447exit:
4448 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02004449 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004450 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004451}
4452
Gilles Peskinee553c652018-06-04 16:22:46 +02004453psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
4454 uint8_t *output,
4455 size_t output_size,
4456 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02004457{
David Saadab4ecc272019-02-14 13:48:10 +02004458 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Gilles Peskinee553c652018-06-04 16:22:46 +02004459 uint8_t temp_output_buffer[MBEDTLS_MAX_BLOCK_LENGTH];
Steven Cooreman7df02922020-09-09 15:28:49 +02004460 if( operation->alg == 0 )
4461 {
4462 return( PSA_ERROR_BAD_STATE );
4463 }
4464 if( operation->iv_required && ! operation->iv_set )
4465 {
4466 return( PSA_ERROR_BAD_STATE );
4467 }
Moran Pekerbed71a22018-04-22 20:19:20 +03004468
Steven Cooremanef8575e2020-09-11 11:44:50 +02004469 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004470 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004471 status = psa_driver_wrapper_cipher_finish( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004472 output,
4473 output_size,
4474 output_length );
Steven Cooremanef8575e2020-09-11 11:44:50 +02004475 goto exit;
Steven Cooreman8b122252020-09-03 15:30:32 +02004476 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004477
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004478 if( operation->ctx.cipher.unprocessed_len != 0 )
Moran Peker7cb22b82018-06-05 11:40:02 +03004479 {
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004480 if( operation->alg == PSA_ALG_ECB_NO_PADDING ||
Fredrik Strupef90e3012020-09-28 16:11:33 +02004481 operation->alg == PSA_ALG_CBC_NO_PADDING )
Steven Cooremana6033e92020-08-25 11:47:50 +02004482 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004483 status = PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004484 goto exit;
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004485 }
Moran Pekerdc38ebc2018-04-30 15:45:34 +03004486 }
4487
Steven Cooremanef8575e2020-09-11 11:44:50 +02004488 status = mbedtls_to_psa_error(
4489 mbedtls_cipher_finish( &operation->ctx.cipher,
4490 temp_output_buffer,
4491 output_length ) );
4492 if( status != PSA_SUCCESS )
4493 goto exit;
Janos Follath315b51c2018-07-09 16:04:51 +01004494
Gilles Peskine46f1fd72018-06-28 19:31:31 +02004495 if( *output_length == 0 )
Janos Follath315b51c2018-07-09 16:04:51 +01004496 ; /* Nothing to copy. Note that output may be NULL in this case. */
Gilles Peskine46f1fd72018-06-28 19:31:31 +02004497 else if( output_size >= *output_length )
Moran Pekerdc38ebc2018-04-30 15:45:34 +03004498 memcpy( output, temp_output_buffer, *output_length );
4499 else
Janos Follath315b51c2018-07-09 16:04:51 +01004500 status = PSA_ERROR_BUFFER_TOO_SMALL;
mohammad1603503973b2018-03-12 15:59:30 +02004501
Steven Cooremanef8575e2020-09-11 11:44:50 +02004502exit:
4503 if( operation->mbedtls_in_use == 1 )
4504 mbedtls_platform_zeroize( temp_output_buffer, sizeof( temp_output_buffer ) );
Janos Follath315b51c2018-07-09 16:04:51 +01004505
Steven Cooremanef8575e2020-09-11 11:44:50 +02004506 if( status == PSA_SUCCESS )
4507 return( psa_cipher_abort( operation ) );
4508 else
4509 {
4510 *output_length = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004511 (void) psa_cipher_abort( operation );
Janos Follath315b51c2018-07-09 16:04:51 +01004512
Steven Cooremanef8575e2020-09-11 11:44:50 +02004513 return( status );
4514 }
mohammad1603503973b2018-03-12 15:59:30 +02004515}
4516
Gilles Peskinee553c652018-06-04 16:22:46 +02004517psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
4518{
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004519 if( operation->alg == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02004520 {
Steven Cooremana07b9972020-09-10 14:54:14 +02004521 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02004522 * in use. It's ok to call abort on such an object, and there's
4523 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004524 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02004525 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004526
Gilles Peskinef9c2c092018-06-21 16:57:07 +02004527 /* Sanity check (shouldn't happen: operation->alg should
4528 * always have been initialized to a valid value). */
4529 if( ! PSA_ALG_IS_CIPHER( operation->alg ) )
4530 return( PSA_ERROR_BAD_STATE );
4531
Steven Cooremanef8575e2020-09-11 11:44:50 +02004532 if( operation->mbedtls_in_use == 0 )
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004533 psa_driver_wrapper_cipher_abort( &operation->ctx.driver );
Steven Cooremand3feccd2020-09-01 15:56:14 +02004534 else
4535 mbedtls_cipher_free( &operation->ctx.cipher );
Gilles Peskinee553c652018-06-04 16:22:46 +02004536
Moran Peker41deec42018-04-04 15:43:05 +03004537 operation->alg = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004538 operation->key_set = 0;
4539 operation->iv_set = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004540 operation->mbedtls_in_use = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004541 operation->iv_size = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004542 operation->block_size = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004543 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004544
Moran Peker395db872018-05-31 14:07:14 +03004545 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02004546}
4547
Gilles Peskinea0655c32018-04-30 17:06:50 +02004548
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004549
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004550
mohammad16035955c982018-04-26 00:53:03 +03004551/****************************************************************/
4552/* AEAD */
4553/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004554
Gilles Peskineedf9a652018-08-17 18:11:56 +02004555typedef struct
4556{
Gilles Peskine2f060a82018-12-04 17:12:32 +01004557 psa_key_slot_t *slot;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004558 const mbedtls_cipher_info_t *cipher_info;
4559 union
4560 {
4561#if defined(MBEDTLS_CCM_C)
4562 mbedtls_ccm_context ccm;
4563#endif /* MBEDTLS_CCM_C */
4564#if defined(MBEDTLS_GCM_C)
4565 mbedtls_gcm_context gcm;
4566#endif /* MBEDTLS_GCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004567#if defined(MBEDTLS_CHACHAPOLY_C)
4568 mbedtls_chachapoly_context chachapoly;
4569#endif /* MBEDTLS_CHACHAPOLY_C */
Gilles Peskineedf9a652018-08-17 18:11:56 +02004570 } ctx;
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004571 psa_algorithm_t core_alg;
4572 uint8_t full_tag_length;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004573 uint8_t tag_length;
4574} aead_operation_t;
4575
Gilles Peskine30a9e412019-01-14 18:36:12 +01004576static void psa_aead_abort_internal( aead_operation_t *operation )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004577{
Gilles Peskinef8a8fe62018-08-21 16:38:05 +02004578 switch( operation->core_alg )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004579 {
4580#if defined(MBEDTLS_CCM_C)
4581 case PSA_ALG_CCM:
4582 mbedtls_ccm_free( &operation->ctx.ccm );
4583 break;
4584#endif /* MBEDTLS_CCM_C */
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004585#if defined(MBEDTLS_GCM_C)
Gilles Peskineedf9a652018-08-17 18:11:56 +02004586 case PSA_ALG_GCM:
4587 mbedtls_gcm_free( &operation->ctx.gcm );
4588 break;
4589#endif /* MBEDTLS_GCM_C */
4590 }
4591}
4592
4593static psa_status_t psa_aead_setup( aead_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01004594 psa_key_handle_t handle,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004595 psa_key_usage_t usage,
4596 psa_algorithm_t alg )
4597{
4598 psa_status_t status;
4599 size_t key_bits;
4600 mbedtls_cipher_id_t cipher_id;
4601
Gilles Peskine28f8f302019-07-24 13:30:31 +02004602 status = psa_get_transparent_key( handle, &operation->slot, usage, alg );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004603 if( status != PSA_SUCCESS )
4604 return( status );
4605
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02004606 key_bits = psa_get_key_slot_bits( operation->slot );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004607
4608 operation->cipher_info =
Gilles Peskine8e338702019-07-30 20:06:31 +02004609 mbedtls_cipher_info_from_psa( alg, operation->slot->attr.type, key_bits,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004610 &cipher_id );
4611 if( operation->cipher_info == NULL )
4612 return( PSA_ERROR_NOT_SUPPORTED );
4613
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004614 switch( PSA_ALG_AEAD_WITH_TAG_LENGTH( alg, 0 ) )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004615 {
4616#if defined(MBEDTLS_CCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004617 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CCM, 0 ):
4618 operation->core_alg = PSA_ALG_CCM;
4619 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004620 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.
4621 * The call to mbedtls_ccm_encrypt_and_tag or
4622 * mbedtls_ccm_auth_decrypt will validate the tag length. */
Gilles Peskine8e338702019-07-30 20:06:31 +02004623 if( PSA_BLOCK_CIPHER_BLOCK_SIZE( operation->slot->attr.type ) != 16 )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004624 return( PSA_ERROR_INVALID_ARGUMENT );
4625 mbedtls_ccm_init( &operation->ctx.ccm );
4626 status = mbedtls_to_psa_error(
4627 mbedtls_ccm_setkey( &operation->ctx.ccm, cipher_id,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004628 operation->slot->data.key.data,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004629 (unsigned int) key_bits ) );
4630 if( status != 0 )
4631 goto cleanup;
4632 break;
4633#endif /* MBEDTLS_CCM_C */
4634
4635#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004636 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_GCM, 0 ):
4637 operation->core_alg = PSA_ALG_GCM;
4638 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004639 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16.
4640 * The call to mbedtls_gcm_crypt_and_tag or
4641 * mbedtls_gcm_auth_decrypt will validate the tag length. */
Gilles Peskine8e338702019-07-30 20:06:31 +02004642 if( PSA_BLOCK_CIPHER_BLOCK_SIZE( operation->slot->attr.type ) != 16 )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004643 return( PSA_ERROR_INVALID_ARGUMENT );
4644 mbedtls_gcm_init( &operation->ctx.gcm );
4645 status = mbedtls_to_psa_error(
4646 mbedtls_gcm_setkey( &operation->ctx.gcm, cipher_id,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004647 operation->slot->data.key.data,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004648 (unsigned int) key_bits ) );
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004649 if( status != 0 )
4650 goto cleanup;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004651 break;
4652#endif /* MBEDTLS_GCM_C */
4653
Gilles Peskine26869f22019-05-06 15:25:00 +02004654#if defined(MBEDTLS_CHACHAPOLY_C)
4655 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CHACHA20_POLY1305, 0 ):
4656 operation->core_alg = PSA_ALG_CHACHA20_POLY1305;
4657 operation->full_tag_length = 16;
4658 /* We only support the default tag length. */
4659 if( alg != PSA_ALG_CHACHA20_POLY1305 )
4660 return( PSA_ERROR_NOT_SUPPORTED );
4661 mbedtls_chachapoly_init( &operation->ctx.chachapoly );
4662 status = mbedtls_to_psa_error(
4663 mbedtls_chachapoly_setkey( &operation->ctx.chachapoly,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004664 operation->slot->data.key.data ) );
Gilles Peskine26869f22019-05-06 15:25:00 +02004665 if( status != 0 )
4666 goto cleanup;
4667 break;
4668#endif /* MBEDTLS_CHACHAPOLY_C */
4669
Gilles Peskineedf9a652018-08-17 18:11:56 +02004670 default:
4671 return( PSA_ERROR_NOT_SUPPORTED );
4672 }
4673
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004674 if( PSA_AEAD_TAG_LENGTH( alg ) > operation->full_tag_length )
4675 {
4676 status = PSA_ERROR_INVALID_ARGUMENT;
4677 goto cleanup;
4678 }
4679 operation->tag_length = PSA_AEAD_TAG_LENGTH( alg );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004680
Gilles Peskineedf9a652018-08-17 18:11:56 +02004681 return( PSA_SUCCESS );
4682
4683cleanup:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004684 psa_aead_abort_internal( operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004685 return( status );
4686}
4687
Gilles Peskinec5487a82018-12-03 18:08:14 +01004688psa_status_t psa_aead_encrypt( psa_key_handle_t handle,
mohammad16035955c982018-04-26 00:53:03 +03004689 psa_algorithm_t alg,
4690 const uint8_t *nonce,
4691 size_t nonce_length,
4692 const uint8_t *additional_data,
4693 size_t additional_data_length,
4694 const uint8_t *plaintext,
4695 size_t plaintext_length,
4696 uint8_t *ciphertext,
4697 size_t ciphertext_size,
4698 size_t *ciphertext_length )
4699{
mohammad16035955c982018-04-26 00:53:03 +03004700 psa_status_t status;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004701 aead_operation_t operation;
mohammad160315223a82018-06-03 17:19:55 +03004702 uint8_t *tag;
Gilles Peskine2d277862018-06-18 15:41:12 +02004703
mohammad1603f08a5502018-06-03 15:05:47 +03004704 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004705
Gilles Peskinec5487a82018-12-03 18:08:14 +01004706 status = psa_aead_setup( &operation, handle, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004707 if( status != PSA_SUCCESS )
4708 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004709
Gilles Peskineedf9a652018-08-17 18:11:56 +02004710 /* For all currently supported modes, the tag is at the end of the
4711 * ciphertext. */
4712 if( ciphertext_size < ( plaintext_length + operation.tag_length ) )
4713 {
4714 status = PSA_ERROR_BUFFER_TOO_SMALL;
4715 goto exit;
4716 }
4717 tag = ciphertext + plaintext_length;
mohammad16035955c982018-04-26 00:53:03 +03004718
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004719#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004720 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03004721 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004722 status = mbedtls_to_psa_error(
4723 mbedtls_gcm_crypt_and_tag( &operation.ctx.gcm,
4724 MBEDTLS_GCM_ENCRYPT,
4725 plaintext_length,
4726 nonce, nonce_length,
4727 additional_data, additional_data_length,
4728 plaintext, ciphertext,
4729 operation.tag_length, tag ) );
mohammad16035955c982018-04-26 00:53:03 +03004730 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004731 else
4732#endif /* MBEDTLS_GCM_C */
4733#if defined(MBEDTLS_CCM_C)
4734 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03004735 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004736 status = mbedtls_to_psa_error(
4737 mbedtls_ccm_encrypt_and_tag( &operation.ctx.ccm,
4738 plaintext_length,
4739 nonce, nonce_length,
4740 additional_data,
4741 additional_data_length,
4742 plaintext, ciphertext,
4743 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03004744 }
mohammad16035c8845f2018-05-09 05:40:09 -07004745 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004746#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004747#if defined(MBEDTLS_CHACHAPOLY_C)
4748 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
4749 {
4750 if( nonce_length != 12 || operation.tag_length != 16 )
4751 {
4752 status = PSA_ERROR_NOT_SUPPORTED;
4753 goto exit;
4754 }
4755 status = mbedtls_to_psa_error(
4756 mbedtls_chachapoly_encrypt_and_tag( &operation.ctx.chachapoly,
4757 plaintext_length,
4758 nonce,
4759 additional_data,
4760 additional_data_length,
4761 plaintext,
4762 ciphertext,
4763 tag ) );
4764 }
4765 else
4766#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad16035c8845f2018-05-09 05:40:09 -07004767 {
mohammad1603554faad2018-06-03 15:07:38 +03004768 return( PSA_ERROR_NOT_SUPPORTED );
mohammad16035c8845f2018-05-09 05:40:09 -07004769 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004770
Gilles Peskineedf9a652018-08-17 18:11:56 +02004771 if( status != PSA_SUCCESS && ciphertext_size != 0 )
4772 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02004773
Gilles Peskineedf9a652018-08-17 18:11:56 +02004774exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004775 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004776 if( status == PSA_SUCCESS )
4777 *ciphertext_length = plaintext_length + operation.tag_length;
4778 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004779}
4780
Gilles Peskineee652a32018-06-01 19:23:52 +02004781/* Locate the tag in a ciphertext buffer containing the encrypted data
4782 * followed by the tag. Return the length of the part preceding the tag in
4783 * *plaintext_length. This is the size of the plaintext in modes where
4784 * the encrypted data has the same size as the plaintext, such as
4785 * CCM and GCM. */
4786static psa_status_t psa_aead_unpadded_locate_tag( size_t tag_length,
4787 const uint8_t *ciphertext,
4788 size_t ciphertext_length,
4789 size_t plaintext_size,
Gilles Peskineee652a32018-06-01 19:23:52 +02004790 const uint8_t **p_tag )
4791{
4792 size_t payload_length;
4793 if( tag_length > ciphertext_length )
4794 return( PSA_ERROR_INVALID_ARGUMENT );
4795 payload_length = ciphertext_length - tag_length;
4796 if( payload_length > plaintext_size )
4797 return( PSA_ERROR_BUFFER_TOO_SMALL );
4798 *p_tag = ciphertext + payload_length;
Gilles Peskineee652a32018-06-01 19:23:52 +02004799 return( PSA_SUCCESS );
4800}
4801
Gilles Peskinec5487a82018-12-03 18:08:14 +01004802psa_status_t psa_aead_decrypt( psa_key_handle_t handle,
mohammad16035955c982018-04-26 00:53:03 +03004803 psa_algorithm_t alg,
4804 const uint8_t *nonce,
4805 size_t nonce_length,
4806 const uint8_t *additional_data,
4807 size_t additional_data_length,
4808 const uint8_t *ciphertext,
4809 size_t ciphertext_length,
4810 uint8_t *plaintext,
4811 size_t plaintext_size,
4812 size_t *plaintext_length )
4813{
mohammad16035955c982018-04-26 00:53:03 +03004814 psa_status_t status;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004815 aead_operation_t operation;
4816 const uint8_t *tag = NULL;
Gilles Peskine2d277862018-06-18 15:41:12 +02004817
Gilles Peskineee652a32018-06-01 19:23:52 +02004818 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004819
Gilles Peskinec5487a82018-12-03 18:08:14 +01004820 status = psa_aead_setup( &operation, handle, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004821 if( status != PSA_SUCCESS )
4822 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004823
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004824 status = psa_aead_unpadded_locate_tag( operation.tag_length,
4825 ciphertext, ciphertext_length,
4826 plaintext_size, &tag );
4827 if( status != PSA_SUCCESS )
4828 goto exit;
4829
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004830#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004831 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03004832 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004833 status = mbedtls_to_psa_error(
4834 mbedtls_gcm_auth_decrypt( &operation.ctx.gcm,
4835 ciphertext_length - operation.tag_length,
4836 nonce, nonce_length,
4837 additional_data,
4838 additional_data_length,
4839 tag, operation.tag_length,
4840 ciphertext, plaintext ) );
mohammad16035955c982018-04-26 00:53:03 +03004841 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004842 else
4843#endif /* MBEDTLS_GCM_C */
4844#if defined(MBEDTLS_CCM_C)
4845 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03004846 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004847 status = mbedtls_to_psa_error(
4848 mbedtls_ccm_auth_decrypt( &operation.ctx.ccm,
4849 ciphertext_length - operation.tag_length,
4850 nonce, nonce_length,
4851 additional_data,
4852 additional_data_length,
4853 ciphertext, plaintext,
4854 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03004855 }
mohammad160339574652018-06-01 04:39:53 -07004856 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004857#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004858#if defined(MBEDTLS_CHACHAPOLY_C)
4859 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
4860 {
4861 if( nonce_length != 12 || operation.tag_length != 16 )
4862 {
4863 status = PSA_ERROR_NOT_SUPPORTED;
4864 goto exit;
4865 }
4866 status = mbedtls_to_psa_error(
4867 mbedtls_chachapoly_auth_decrypt( &operation.ctx.chachapoly,
4868 ciphertext_length - operation.tag_length,
4869 nonce,
4870 additional_data,
4871 additional_data_length,
4872 tag,
4873 ciphertext,
4874 plaintext ) );
4875 }
4876 else
4877#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad160339574652018-06-01 04:39:53 -07004878 {
mohammad1603554faad2018-06-03 15:07:38 +03004879 return( PSA_ERROR_NOT_SUPPORTED );
mohammad160339574652018-06-01 04:39:53 -07004880 }
Gilles Peskinea40d7742018-06-01 16:28:30 +02004881
Gilles Peskineedf9a652018-08-17 18:11:56 +02004882 if( status != PSA_SUCCESS && plaintext_size != 0 )
4883 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03004884
Gilles Peskineedf9a652018-08-17 18:11:56 +02004885exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004886 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004887 if( status == PSA_SUCCESS )
4888 *plaintext_length = ciphertext_length - operation.tag_length;
4889 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004890}
4891
Gilles Peskinea0655c32018-04-30 17:06:50 +02004892
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004893
Gilles Peskine20035e32018-02-03 22:44:14 +01004894/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02004895/* Generators */
4896/****************************************************************/
4897
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004898#define HKDF_STATE_INIT 0 /* no input yet */
4899#define HKDF_STATE_STARTED 1 /* got salt */
4900#define HKDF_STATE_KEYED 2 /* got key */
4901#define HKDF_STATE_OUTPUT 3 /* output started */
4902
Gilles Peskinecbe66502019-05-16 16:59:18 +02004903static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004904 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004905{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004906 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
4907 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004908 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004909 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004910}
4911
4912
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004913psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004914{
4915 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004916 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004917 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004918 {
4919 /* The object has (apparently) been initialized but it is not
4920 * in use. It's ok to call abort on such an object, and there's
4921 * nothing to do. */
4922 }
4923 else
Gilles Peskinebef7f142018-07-12 17:22:21 +02004924#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004925 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004926 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004927 mbedtls_free( operation->ctx.hkdf.info );
4928 status = psa_hmac_abort_internal( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004929 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01004930 else if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004931 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004932 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004933 {
Janos Follath6a1d2622019-06-11 10:37:28 +01004934 if( operation->ctx.tls12_prf.seed != NULL )
4935 {
4936 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
4937 operation->ctx.tls12_prf.seed_length );
4938 mbedtls_free( operation->ctx.tls12_prf.seed );
4939 }
4940
4941 if( operation->ctx.tls12_prf.label != NULL )
4942 {
4943 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
4944 operation->ctx.tls12_prf.label_length );
4945 mbedtls_free( operation->ctx.tls12_prf.label );
4946 }
4947
4948 status = psa_hmac_abort_internal( &operation->ctx.tls12_prf.hmac );
4949
4950 /* We leave the fields Ai and output_block to be erased safely by the
4951 * mbedtls_platform_zeroize() in the end of this function. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004952 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004953 else
4954#endif /* MBEDTLS_MD_C */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004955 {
4956 status = PSA_ERROR_BAD_STATE;
4957 }
Janos Follath083036a2019-06-11 10:22:26 +01004958 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004959 return( status );
4960}
4961
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004962psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02004963 size_t *capacity)
4964{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004965 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004966 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004967 /* This is a blank key derivation operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02004968 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004969 }
4970
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004971 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004972 return( PSA_SUCCESS );
4973}
4974
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004975psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004976 size_t capacity )
4977{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004978 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004979 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004980 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004981 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004982 operation->capacity = capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004983 return( PSA_SUCCESS );
4984}
4985
Gilles Peskinebef7f142018-07-12 17:22:21 +02004986#if defined(MBEDTLS_MD_C)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004987/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02004988 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02004989static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskinebef7f142018-07-12 17:22:21 +02004990 psa_algorithm_t hash_alg,
4991 uint8_t *output,
4992 size_t output_length )
4993{
4994 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
4995 psa_status_t status;
4996
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004997 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
4998 return( PSA_ERROR_BAD_STATE );
4999 hkdf->state = HKDF_STATE_OUTPUT;
5000
Gilles Peskinebef7f142018-07-12 17:22:21 +02005001 while( output_length != 0 )
5002 {
5003 /* Copy what remains of the current block */
5004 uint8_t n = hash_length - hkdf->offset_in_block;
5005 if( n > output_length )
5006 n = (uint8_t) output_length;
5007 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
5008 output += n;
5009 output_length -= n;
5010 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02005011 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02005012 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02005013 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005014 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005015 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02005016 * object was corrupted or if this function is called directly
5017 * inside the library. */
5018 if( hkdf->block_number == 0xff )
5019 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02005020
5021 /* We need a new block */
5022 ++hkdf->block_number;
5023 hkdf->offset_in_block = 0;
5024 status = psa_hmac_setup_internal( &hkdf->hmac,
5025 hkdf->prk, hash_length,
5026 hash_alg );
5027 if( status != PSA_SUCCESS )
5028 return( status );
5029 if( hkdf->block_number != 1 )
5030 {
5031 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5032 hkdf->output_block,
5033 hash_length );
5034 if( status != PSA_SUCCESS )
5035 return( status );
5036 }
5037 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5038 hkdf->info,
5039 hkdf->info_length );
5040 if( status != PSA_SUCCESS )
5041 return( status );
5042 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5043 &hkdf->block_number, 1 );
5044 if( status != PSA_SUCCESS )
5045 return( status );
5046 status = psa_hmac_finish_internal( &hkdf->hmac,
5047 hkdf->output_block,
5048 sizeof( hkdf->output_block ) );
5049 if( status != PSA_SUCCESS )
5050 return( status );
5051 }
5052
5053 return( PSA_SUCCESS );
5054}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005055
Janos Follath7742fee2019-06-17 12:58:10 +01005056static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
5057 psa_tls12_prf_key_derivation_t *tls12_prf,
5058 psa_algorithm_t alg )
5059{
5060 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
5061 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
Janos Follathea29bfb2019-06-19 12:21:20 +01005062 psa_hash_operation_t backup = PSA_HASH_OPERATION_INIT;
5063 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005064
Janos Follath7742fee2019-06-17 12:58:10 +01005065 /* We can't be wanting more output after block 0xff, otherwise
5066 * the capacity check in psa_key_derivation_output_bytes() would have
5067 * prevented this call. It could happen only if the operation
5068 * object was corrupted or if this function is called directly
5069 * inside the library. */
5070 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01005071 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01005072
5073 /* We need a new block */
5074 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01005075 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01005076
5077 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
5078 *
5079 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
5080 *
5081 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
5082 * HMAC_hash(secret, A(2) + seed) +
5083 * HMAC_hash(secret, A(3) + seed) + ...
5084 *
5085 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01005086 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01005087 *
Janos Follathea29bfb2019-06-19 12:21:20 +01005088 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01005089 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01005090 * is currently extracted as `output_block` and where i is
5091 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01005092 */
5093
Janos Follathea29bfb2019-06-19 12:21:20 +01005094 /* Save the hash context before using it, to preserve the hash state with
5095 * only the inner padding in it. We need this, because inner padding depends
5096 * on the key (secret in the RFC's terminology). */
5097 status = psa_hash_clone( &tls12_prf->hmac.hash_ctx, &backup );
5098 if( status != PSA_SUCCESS )
5099 goto cleanup;
5100
5101 /* Calculate A(i) where i = tls12_prf->block_number. */
5102 if( tls12_prf->block_number == 1 )
5103 {
5104 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
5105 * the variable seed and in this instance means it in the context of the
5106 * P_hash function, where seed = label + seed.) */
5107 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5108 tls12_prf->label, tls12_prf->label_length );
5109 if( status != PSA_SUCCESS )
5110 goto cleanup;
5111 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5112 tls12_prf->seed, tls12_prf->seed_length );
5113 if( status != PSA_SUCCESS )
5114 goto cleanup;
5115 }
5116 else
5117 {
5118 /* A(i) = HMAC_hash(secret, A(i-1)) */
5119 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5120 tls12_prf->Ai, hash_length );
5121 if( status != PSA_SUCCESS )
5122 goto cleanup;
5123 }
5124
5125 status = psa_hmac_finish_internal( &tls12_prf->hmac,
5126 tls12_prf->Ai, hash_length );
5127 if( status != PSA_SUCCESS )
5128 goto cleanup;
5129 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
5130 if( status != PSA_SUCCESS )
5131 goto cleanup;
5132
5133 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
5134 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5135 tls12_prf->Ai, hash_length );
5136 if( status != PSA_SUCCESS )
5137 goto cleanup;
5138 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5139 tls12_prf->label, tls12_prf->label_length );
5140 if( status != PSA_SUCCESS )
5141 goto cleanup;
5142 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5143 tls12_prf->seed, tls12_prf->seed_length );
5144 if( status != PSA_SUCCESS )
5145 goto cleanup;
5146 status = psa_hmac_finish_internal( &tls12_prf->hmac,
5147 tls12_prf->output_block, hash_length );
5148 if( status != PSA_SUCCESS )
5149 goto cleanup;
5150 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
5151 if( status != PSA_SUCCESS )
5152 goto cleanup;
5153
Janos Follath7742fee2019-06-17 12:58:10 +01005154
5155cleanup:
5156
Janos Follathea29bfb2019-06-19 12:21:20 +01005157 cleanup_status = psa_hash_abort( &backup );
5158 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
5159 status = cleanup_status;
5160
5161 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01005162}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005163
Janos Follath844eb0e2019-06-19 12:10:49 +01005164static psa_status_t psa_key_derivation_tls12_prf_read(
5165 psa_tls12_prf_key_derivation_t *tls12_prf,
5166 psa_algorithm_t alg,
5167 uint8_t *output,
5168 size_t output_length )
5169{
5170 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
5171 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
5172 psa_status_t status;
5173 uint8_t offset, length;
5174
5175 while( output_length != 0 )
5176 {
5177 /* Check if we have fully processed the current block. */
5178 if( tls12_prf->left_in_block == 0 )
5179 {
5180 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
5181 alg );
5182 if( status != PSA_SUCCESS )
5183 return( status );
5184
5185 continue;
5186 }
5187
5188 if( tls12_prf->left_in_block > output_length )
5189 length = (uint8_t) output_length;
5190 else
5191 length = tls12_prf->left_in_block;
5192
5193 offset = hash_length - tls12_prf->left_in_block;
5194 memcpy( output, tls12_prf->output_block + offset, length );
5195 output += length;
5196 output_length -= length;
5197 tls12_prf->left_in_block -= length;
5198 }
5199
5200 return( PSA_SUCCESS );
5201}
Gilles Peskinebef7f142018-07-12 17:22:21 +02005202#endif /* MBEDTLS_MD_C */
5203
Janos Follath6c6c8fc2019-06-17 12:38:20 +01005204psa_status_t psa_key_derivation_output_bytes(
5205 psa_key_derivation_operation_t *operation,
5206 uint8_t *output,
5207 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005208{
5209 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005210 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005211
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005212 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005213 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005214 /* This is a blank operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02005215 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005216 }
5217
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005218 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005219 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005220 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005221 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005222 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02005223 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005224 goto exit;
5225 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005226 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005227 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005228 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005229 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02005230 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
5231 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005232 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02005233 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02005234 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005235 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005236 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005237
Gilles Peskinebef7f142018-07-12 17:22:21 +02005238#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005239 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02005240 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01005241 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005242 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02005243 output, output_length );
5244 }
Janos Follathadbec812019-06-14 11:05:39 +01005245 else
Janos Follathadbec812019-06-14 11:05:39 +01005246 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine969c5d62019-01-16 15:53:06 +01005247 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005248 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005249 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005250 kdf_alg, output,
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005251 output_length );
5252 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005253 else
5254#endif /* MBEDTLS_MD_C */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005255 {
5256 return( PSA_ERROR_BAD_STATE );
5257 }
5258
5259exit:
5260 if( status != PSA_SUCCESS )
5261 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005262 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005263 * This allows us to differentiate between exhausted operations and
5264 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
5265 * operations. */
5266 psa_algorithm_t alg = operation->alg;
5267 psa_key_derivation_abort( operation );
5268 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005269 memset( output, '!', output_length );
5270 }
5271 return( status );
5272}
5273
Gilles Peskine08542d82018-07-19 17:05:42 +02005274#if defined(MBEDTLS_DES_C)
5275static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
5276{
5277 if( data_size >= 8 )
5278 mbedtls_des_key_set_parity( data );
5279 if( data_size >= 16 )
5280 mbedtls_des_key_set_parity( data + 8 );
5281 if( data_size >= 24 )
5282 mbedtls_des_key_set_parity( data + 16 );
5283}
5284#endif /* MBEDTLS_DES_C */
5285
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005286static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005287 psa_key_slot_t *slot,
5288 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005289 psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005290{
5291 uint8_t *data = NULL;
5292 size_t bytes = PSA_BITS_TO_BYTES( bits );
5293 psa_status_t status;
5294
Gilles Peskine8e338702019-07-30 20:06:31 +02005295 if( ! key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005296 return( PSA_ERROR_INVALID_ARGUMENT );
5297 if( bits % 8 != 0 )
5298 return( PSA_ERROR_INVALID_ARGUMENT );
5299 data = mbedtls_calloc( 1, bytes );
5300 if( data == NULL )
5301 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5302
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005303 status = psa_key_derivation_output_bytes( operation, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005304 if( status != PSA_SUCCESS )
5305 goto exit;
Gilles Peskine08542d82018-07-19 17:05:42 +02005306#if defined(MBEDTLS_DES_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02005307 if( slot->attr.type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02005308 psa_des_set_key_parity( data, bytes );
5309#endif /* MBEDTLS_DES_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005310 status = psa_import_key_into_slot( slot, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005311
5312exit:
5313 mbedtls_free( data );
5314 return( status );
5315}
5316
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005317psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005318 psa_key_derivation_operation_t *operation,
Gilles Peskine98dd7792019-05-15 19:43:49 +02005319 psa_key_handle_t *handle )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005320{
5321 psa_status_t status;
5322 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005323 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02005324
5325 /* Reject any attempt to create a zero-length key so that we don't
5326 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
5327 if( psa_get_key_bits( attributes ) == 0 )
5328 return( PSA_ERROR_INVALID_ARGUMENT );
5329
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005330 if( ! operation->can_output_key )
5331 return( PSA_ERROR_NOT_PERMITTED );
5332
Gilles Peskinedf179142019-07-15 22:02:14 +02005333 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE,
5334 attributes, handle, &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02005335#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
5336 if( driver != NULL )
5337 {
5338 /* Deriving a key in a secure element is not implemented yet. */
5339 status = PSA_ERROR_NOT_SUPPORTED;
5340 }
5341#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005342 if( status == PSA_SUCCESS )
5343 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005344 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02005345 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005346 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005347 }
5348 if( status == PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02005349 status = psa_finish_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005350 if( status != PSA_SUCCESS )
5351 {
Gilles Peskine011e4282019-06-26 18:34:38 +02005352 psa_fail_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005353 *handle = 0;
5354 }
5355 return( status );
5356}
5357
Gilles Peskineeab56e42018-07-12 17:12:33 +02005358
5359
5360/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02005361/* Key derivation */
5362/****************************************************************/
5363
Gilles Peskine969c5d62019-01-16 15:53:06 +01005364static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005365 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005366 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005367{
Janos Follath5fe19732019-06-20 15:09:30 +01005368 /* Make sure that operation->ctx is properly zero-initialised. (Macro
5369 * initialisers for this union leave some bytes unspecified.) */
5370 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
5371
Gilles Peskine969c5d62019-01-16 15:53:06 +01005372 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005373#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005374 if( PSA_ALG_IS_HKDF( kdf_alg ) ||
5375 PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
5376 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005377 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01005378 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005379 size_t hash_size = PSA_HASH_SIZE( hash_alg );
5380 if( hash_size == 0 )
5381 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005382 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
5383 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02005384 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005385 {
5386 return( PSA_ERROR_NOT_SUPPORTED );
5387 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005388 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01005389 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005390 }
5391#endif /* MBEDTLS_MD_C */
Gilles Peskine969c5d62019-01-16 15:53:06 +01005392 else
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005393 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005394}
5395
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005396psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005397 psa_algorithm_t alg )
5398{
5399 psa_status_t status;
5400
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005401 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005402 return( PSA_ERROR_BAD_STATE );
5403
Gilles Peskine6843c292019-01-18 16:44:49 +01005404 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
5405 return( PSA_ERROR_INVALID_ARGUMENT );
5406 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005407 {
5408 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005409 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005410 }
5411 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
5412 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005413 status = psa_key_derivation_setup_kdf( operation, alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005414 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005415 else
5416 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005417
5418 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005419 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01005420 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005421}
5422
5423#if defined(MBEDTLS_MD_C)
Gilles Peskinecbe66502019-05-16 16:59:18 +02005424static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005425 psa_algorithm_t hash_alg,
5426 psa_key_derivation_step_t step,
5427 const uint8_t *data,
5428 size_t data_length )
5429{
5430 psa_status_t status;
5431 switch( step )
5432 {
Gilles Peskine03410b52019-05-16 16:05:19 +02005433 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02005434 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005435 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005436 status = psa_hmac_setup_internal( &hkdf->hmac,
5437 data, data_length,
5438 hash_alg );
5439 if( status != PSA_SUCCESS )
5440 return( status );
5441 hkdf->state = HKDF_STATE_STARTED;
5442 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02005443 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005444 /* If no salt was provided, use an empty salt. */
5445 if( hkdf->state == HKDF_STATE_INIT )
5446 {
5447 status = psa_hmac_setup_internal( &hkdf->hmac,
5448 NULL, 0,
Gilles Peskinef9ee6332019-04-11 21:22:52 +02005449 hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005450 if( status != PSA_SUCCESS )
5451 return( status );
5452 hkdf->state = HKDF_STATE_STARTED;
5453 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02005454 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005455 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005456 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5457 data, data_length );
5458 if( status != PSA_SUCCESS )
5459 return( status );
5460 status = psa_hmac_finish_internal( &hkdf->hmac,
5461 hkdf->prk,
5462 sizeof( hkdf->prk ) );
5463 if( status != PSA_SUCCESS )
5464 return( status );
5465 hkdf->offset_in_block = PSA_HASH_SIZE( hash_alg );
5466 hkdf->block_number = 0;
5467 hkdf->state = HKDF_STATE_KEYED;
5468 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02005469 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005470 if( hkdf->state == HKDF_STATE_OUTPUT )
5471 return( PSA_ERROR_BAD_STATE );
5472 if( hkdf->info_set )
5473 return( PSA_ERROR_BAD_STATE );
5474 hkdf->info_length = data_length;
5475 if( data_length != 0 )
5476 {
5477 hkdf->info = mbedtls_calloc( 1, data_length );
5478 if( hkdf->info == NULL )
5479 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5480 memcpy( hkdf->info, data, data_length );
5481 }
5482 hkdf->info_set = 1;
5483 return( PSA_SUCCESS );
5484 default:
5485 return( PSA_ERROR_INVALID_ARGUMENT );
5486 }
5487}
Janos Follathb03233e2019-06-11 15:30:30 +01005488
Janos Follathf08e2652019-06-13 09:05:41 +01005489static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
5490 const uint8_t *data,
5491 size_t data_length )
5492{
5493 if( prf->state != TLS12_PRF_STATE_INIT )
5494 return( PSA_ERROR_BAD_STATE );
5495
Janos Follathd6dce9f2019-07-04 09:11:38 +01005496 if( data_length != 0 )
5497 {
5498 prf->seed = mbedtls_calloc( 1, data_length );
5499 if( prf->seed == NULL )
5500 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01005501
Janos Follathd6dce9f2019-07-04 09:11:38 +01005502 memcpy( prf->seed, data, data_length );
5503 prf->seed_length = data_length;
5504 }
Janos Follathf08e2652019-06-13 09:05:41 +01005505
5506 prf->state = TLS12_PRF_STATE_SEED_SET;
5507
5508 return( PSA_SUCCESS );
5509}
5510
Janos Follath81550542019-06-13 14:26:34 +01005511static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
5512 psa_algorithm_t hash_alg,
5513 const uint8_t *data,
5514 size_t data_length )
5515{
5516 psa_status_t status;
5517 if( prf->state != TLS12_PRF_STATE_SEED_SET )
5518 return( PSA_ERROR_BAD_STATE );
5519
5520 status = psa_hmac_setup_internal( &prf->hmac, data, data_length, hash_alg );
5521 if( status != PSA_SUCCESS )
5522 return( status );
5523
5524 prf->state = TLS12_PRF_STATE_KEY_SET;
5525
5526 return( PSA_SUCCESS );
5527}
5528
Janos Follath6660f0e2019-06-17 08:44:03 +01005529static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
5530 psa_tls12_prf_key_derivation_t *prf,
5531 psa_algorithm_t hash_alg,
5532 const uint8_t *data,
5533 size_t data_length )
5534{
5535 psa_status_t status;
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02005536 uint8_t pms[ 4 + 2 * PSA_ALG_TLS12_PSK_TO_MS_MAX_PSK_LEN ];
5537 uint8_t *cur = pms;
Janos Follath6660f0e2019-06-17 08:44:03 +01005538
5539 if( data_length > PSA_ALG_TLS12_PSK_TO_MS_MAX_PSK_LEN )
5540 return( PSA_ERROR_INVALID_ARGUMENT );
5541
5542 /* Quoting RFC 4279, Section 2:
5543 *
5544 * The premaster secret is formed as follows: if the PSK is N octets
5545 * long, concatenate a uint16 with the value N, N zero octets, a second
5546 * uint16 with the value N, and the PSK itself.
5547 */
5548
Janos Follath40e13932019-06-26 13:22:29 +01005549 *cur++ = ( data_length >> 8 ) & 0xff;
5550 *cur++ = ( data_length >> 0 ) & 0xff;
5551 memset( cur, 0, data_length );
5552 cur += data_length;
5553 *cur++ = pms[0];
5554 *cur++ = pms[1];
5555 memcpy( cur, data, data_length );
5556 cur += data_length;
Janos Follath6660f0e2019-06-17 08:44:03 +01005557
Janos Follath40e13932019-06-26 13:22:29 +01005558 status = psa_tls12_prf_set_key( prf, hash_alg, pms, cur - pms );
Janos Follath6660f0e2019-06-17 08:44:03 +01005559
5560 mbedtls_platform_zeroize( pms, sizeof( pms ) );
5561 return( status );
5562}
5563
Janos Follath63028dd2019-06-13 09:15:47 +01005564static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
5565 const uint8_t *data,
5566 size_t data_length )
5567{
5568 if( prf->state != TLS12_PRF_STATE_KEY_SET )
5569 return( PSA_ERROR_BAD_STATE );
5570
Janos Follathd6dce9f2019-07-04 09:11:38 +01005571 if( data_length != 0 )
5572 {
5573 prf->label = mbedtls_calloc( 1, data_length );
5574 if( prf->label == NULL )
5575 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01005576
Janos Follathd6dce9f2019-07-04 09:11:38 +01005577 memcpy( prf->label, data, data_length );
5578 prf->label_length = data_length;
5579 }
Janos Follath63028dd2019-06-13 09:15:47 +01005580
5581 prf->state = TLS12_PRF_STATE_LABEL_SET;
5582
5583 return( PSA_SUCCESS );
5584}
5585
Janos Follathb03233e2019-06-11 15:30:30 +01005586static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
5587 psa_algorithm_t hash_alg,
5588 psa_key_derivation_step_t step,
5589 const uint8_t *data,
5590 size_t data_length )
5591{
Janos Follathb03233e2019-06-11 15:30:30 +01005592 switch( step )
5593 {
Janos Follathf08e2652019-06-13 09:05:41 +01005594 case PSA_KEY_DERIVATION_INPUT_SEED:
5595 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01005596 case PSA_KEY_DERIVATION_INPUT_SECRET:
5597 return( psa_tls12_prf_set_key( prf, hash_alg, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01005598 case PSA_KEY_DERIVATION_INPUT_LABEL:
5599 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01005600 default:
5601 return( PSA_ERROR_INVALID_ARGUMENT );
5602 }
5603}
Janos Follath6660f0e2019-06-17 08:44:03 +01005604
5605static psa_status_t psa_tls12_prf_psk_to_ms_input(
5606 psa_tls12_prf_key_derivation_t *prf,
5607 psa_algorithm_t hash_alg,
5608 psa_key_derivation_step_t step,
5609 const uint8_t *data,
5610 size_t data_length )
5611{
5612 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01005613 {
Janos Follath6660f0e2019-06-17 08:44:03 +01005614 return( psa_tls12_prf_psk_to_ms_set_key( prf, hash_alg,
5615 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01005616 }
Janos Follath6660f0e2019-06-17 08:44:03 +01005617
5618 return( psa_tls12_prf_input( prf, hash_alg, step, data, data_length ) );
5619}
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005620#endif /* MBEDTLS_MD_C */
5621
Gilles Peskineb8965192019-09-24 16:21:10 +02005622/** Check whether the given key type is acceptable for the given
5623 * input step of a key derivation.
5624 *
5625 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
5626 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
5627 * Both secret and non-secret inputs can alternatively have the type
5628 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
5629 * that the input was passed as a buffer rather than via a key object.
5630 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02005631static int psa_key_derivation_check_input_type(
5632 psa_key_derivation_step_t step,
5633 psa_key_type_t key_type )
5634{
5635 switch( step )
5636 {
5637 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb8965192019-09-24 16:21:10 +02005638 if( key_type == PSA_KEY_TYPE_DERIVE )
5639 return( PSA_SUCCESS );
5640 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005641 return( PSA_SUCCESS );
5642 break;
5643 case PSA_KEY_DERIVATION_INPUT_LABEL:
5644 case PSA_KEY_DERIVATION_INPUT_SALT:
5645 case PSA_KEY_DERIVATION_INPUT_INFO:
5646 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskineb8965192019-09-24 16:21:10 +02005647 if( key_type == PSA_KEY_TYPE_RAW_DATA )
5648 return( PSA_SUCCESS );
5649 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005650 return( PSA_SUCCESS );
5651 break;
5652 }
5653 return( PSA_ERROR_INVALID_ARGUMENT );
5654}
5655
Janos Follathb80a94e2019-06-12 15:54:46 +01005656static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005657 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005658 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005659 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005660 const uint8_t *data,
5661 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005662{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02005663 psa_status_t status;
5664 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
5665
5666 status = psa_key_derivation_check_input_type( step, key_type );
Gilles Peskine224b0d62019-09-23 18:13:17 +02005667 if( status != PSA_SUCCESS )
5668 goto exit;
5669
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005670#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005671 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005672 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005673 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005674 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005675 step, data, data_length );
5676 }
k-stachowiak012dcc42019-08-13 14:55:03 +02005677 else if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005678 {
Janos Follathb03233e2019-06-11 15:30:30 +01005679 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
5680 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5681 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01005682 }
5683 else if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
5684 {
5685 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
5686 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5687 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005688 }
5689 else
5690#endif /* MBEDTLS_MD_C */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005691 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005692 /* This can't happen unless the operation object was not initialized */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005693 return( PSA_ERROR_BAD_STATE );
5694 }
5695
Gilles Peskine224b0d62019-09-23 18:13:17 +02005696exit:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005697 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005698 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005699 return( status );
5700}
5701
Janos Follath51f4a0f2019-06-14 11:35:55 +01005702psa_status_t psa_key_derivation_input_bytes(
5703 psa_key_derivation_operation_t *operation,
5704 psa_key_derivation_step_t step,
5705 const uint8_t *data,
5706 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005707{
Gilles Peskineb8965192019-09-24 16:21:10 +02005708 return( psa_key_derivation_input_internal( operation, step,
5709 PSA_KEY_TYPE_NONE,
Janos Follathc5621512019-06-14 11:27:57 +01005710 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005711}
5712
Janos Follath51f4a0f2019-06-14 11:35:55 +01005713psa_status_t psa_key_derivation_input_key(
5714 psa_key_derivation_operation_t *operation,
5715 psa_key_derivation_step_t step,
5716 psa_key_handle_t handle )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005717{
5718 psa_key_slot_t *slot;
5719 psa_status_t status;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005720
Gilles Peskine28f8f302019-07-24 13:30:31 +02005721 status = psa_get_transparent_key( handle, &slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02005722 PSA_KEY_USAGE_DERIVE,
5723 operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005724 if( status != PSA_SUCCESS )
Gilles Peskine593773d2019-09-23 18:17:40 +02005725 {
5726 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005727 return( status );
Gilles Peskine593773d2019-09-23 18:17:40 +02005728 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005729
5730 /* Passing a key object as a SECRET input unlocks the permission
5731 * to output to a key object. */
5732 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5733 operation->can_output_key = 1;
5734
Janos Follathb80a94e2019-06-12 15:54:46 +01005735 return( psa_key_derivation_input_internal( operation,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005736 step, slot->attr.type,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02005737 slot->data.key.data,
5738 slot->data.key.bytes ) );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005739}
Gilles Peskineea0fb492018-07-12 17:17:20 +02005740
5741
5742
5743/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02005744/* Key agreement */
5745/****************************************************************/
5746
Gilles Peskinea05219c2018-11-16 16:02:56 +01005747#if defined(MBEDTLS_ECDH_C)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005748static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
5749 size_t peer_key_length,
5750 const mbedtls_ecp_keypair *our_key,
5751 uint8_t *shared_secret,
5752 size_t shared_secret_size,
5753 size_t *shared_secret_length )
5754{
Steven Cooremand4867872020-08-05 16:31:39 +02005755 mbedtls_ecp_keypair *their_key = NULL;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005756 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00005757 psa_status_t status;
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005758 size_t bits = 0;
Paul Elliott8ff510a2020-06-02 17:19:28 +01005759 psa_ecc_family_t curve = mbedtls_ecc_group_to_psa( our_key->grp.id, &bits );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005760 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005761
Steven Cooreman4fed4552020-08-03 14:46:03 +02005762 status = psa_load_ecp_representation( PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve),
5763 peer_key,
Steven Cooreman7f391872020-07-30 14:57:44 +02005764 peer_key_length,
Steven Cooreman7f391872020-07-30 14:57:44 +02005765 &their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00005766 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005767 goto exit;
5768
Jaeden Amero97271b32019-01-10 19:38:51 +00005769 status = mbedtls_to_psa_error(
Steven Cooremana2371e52020-07-28 14:30:39 +02005770 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
Jaeden Amero97271b32019-01-10 19:38:51 +00005771 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005772 goto exit;
Jaeden Amero97271b32019-01-10 19:38:51 +00005773 status = mbedtls_to_psa_error(
5774 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
5775 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005776 goto exit;
5777
Jaeden Amero97271b32019-01-10 19:38:51 +00005778 status = mbedtls_to_psa_error(
5779 mbedtls_ecdh_calc_secret( &ecdh,
5780 shared_secret_length,
5781 shared_secret, shared_secret_size,
5782 mbedtls_ctr_drbg_random,
5783 &global_data.ctr_drbg ) );
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005784 if( status != PSA_SUCCESS )
5785 goto exit;
5786 if( PSA_BITS_TO_BYTES( bits ) != *shared_secret_length )
5787 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005788
5789exit:
Gilles Peskine3e819b72019-12-20 14:09:55 +01005790 if( status != PSA_SUCCESS )
5791 mbedtls_platform_zeroize( shared_secret, shared_secret_size );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005792 mbedtls_ecdh_free( &ecdh );
Steven Cooremana2371e52020-07-28 14:30:39 +02005793 mbedtls_ecp_keypair_free( their_key );
Steven Cooreman6d839f02020-07-30 11:36:45 +02005794 mbedtls_free( their_key );
Steven Cooremana2371e52020-07-28 14:30:39 +02005795
Jaeden Amero97271b32019-01-10 19:38:51 +00005796 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005797}
Gilles Peskinea05219c2018-11-16 16:02:56 +01005798#endif /* MBEDTLS_ECDH_C */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005799
Gilles Peskine01d718c2018-09-18 12:01:02 +02005800#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
5801
Gilles Peskine0216fe12019-04-11 21:23:21 +02005802static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
5803 psa_key_slot_t *private_key,
5804 const uint8_t *peer_key,
5805 size_t peer_key_length,
5806 uint8_t *shared_secret,
5807 size_t shared_secret_size,
5808 size_t *shared_secret_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005809{
Gilles Peskine0216fe12019-04-11 21:23:21 +02005810 switch( alg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005811 {
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005812#if defined(MBEDTLS_ECDH_C)
Gilles Peskine0216fe12019-04-11 21:23:21 +02005813 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02005814 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005815 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremana2371e52020-07-28 14:30:39 +02005816 mbedtls_ecp_keypair *ecp = NULL;
Steven Cooreman7f391872020-07-30 14:57:44 +02005817 psa_status_t status = psa_load_ecp_representation(
Steven Cooreman4fed4552020-08-03 14:46:03 +02005818 private_key->attr.type,
Steven Cooreman7f391872020-07-30 14:57:44 +02005819 private_key->data.key.data,
5820 private_key->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02005821 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02005822 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02005823 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02005824 status = psa_key_agreement_ecdh( peer_key, peer_key_length,
Steven Cooremana2371e52020-07-28 14:30:39 +02005825 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02005826 shared_secret, shared_secret_size,
5827 shared_secret_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02005828 mbedtls_ecp_keypair_free( ecp );
5829 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02005830 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005831#endif /* MBEDTLS_ECDH_C */
Gilles Peskine01d718c2018-09-18 12:01:02 +02005832 default:
Gilles Peskine93f85002018-11-16 16:43:31 +01005833 (void) private_key;
5834 (void) peer_key;
5835 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02005836 (void) shared_secret;
5837 (void) shared_secret_size;
5838 (void) shared_secret_length;
Gilles Peskine01d718c2018-09-18 12:01:02 +02005839 return( PSA_ERROR_NOT_SUPPORTED );
5840 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02005841}
5842
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005843/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02005844 * to potentially free embedded data structures and wipe confidential data.
5845 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005846static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005847 psa_key_derivation_step_t step,
Gilles Peskine01d718c2018-09-18 12:01:02 +02005848 psa_key_slot_t *private_key,
5849 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005850 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005851{
5852 psa_status_t status;
5853 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
5854 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005855 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005856
5857 /* Step 1: run the secret agreement algorithm to generate the shared
5858 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02005859 status = psa_key_agreement_raw_internal( ka_alg,
5860 private_key,
5861 peer_key, peer_key_length,
itayzafrir0adf0fc2018-09-06 16:24:41 +03005862 shared_secret,
5863 sizeof( shared_secret ),
Gilles Peskine05d69892018-06-19 22:00:52 +02005864 &shared_secret_length );
Gilles Peskine53d991e2018-07-12 01:14:59 +02005865 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005866 goto exit;
5867
Gilles Peskineb0b255c2018-07-06 17:01:38 +02005868 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02005869 * the shared secret. A shared secret is permitted wherever a key
5870 * of type DERIVE is permitted. */
Janos Follathb80a94e2019-06-12 15:54:46 +01005871 status = psa_key_derivation_input_internal( operation, step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005872 PSA_KEY_TYPE_DERIVE,
Janos Follathb80a94e2019-06-12 15:54:46 +01005873 shared_secret,
5874 shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005875exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01005876 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005877 return( status );
5878}
5879
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005880psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005881 psa_key_derivation_step_t step,
5882 psa_key_handle_t private_key,
5883 const uint8_t *peer_key,
5884 size_t peer_key_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005885{
Gilles Peskine2f060a82018-12-04 17:12:32 +01005886 psa_key_slot_t *slot;
Gilles Peskine08542d82018-07-19 17:05:42 +02005887 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005888 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005889 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine28f8f302019-07-24 13:30:31 +02005890 status = psa_get_transparent_key( private_key, &slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02005891 PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005892 if( status != PSA_SUCCESS )
5893 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005894 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01005895 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005896 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01005897 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005898 psa_key_derivation_abort( operation );
Steven Cooremanfa5e6312020-10-15 17:07:12 +02005899 else
5900 {
5901 /* If a private key has been added as SECRET, we allow the derived
5902 * key material to be used as a key in PSA Crypto. */
5903 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5904 operation->can_output_key = 1;
5905 }
Gilles Peskine346797d2018-11-16 16:05:06 +01005906 return( status );
Gilles Peskineaf3baab2018-06-27 22:55:52 +02005907}
5908
Gilles Peskinebe697d82019-05-16 18:00:41 +02005909psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
5910 psa_key_handle_t private_key,
5911 const uint8_t *peer_key,
5912 size_t peer_key_length,
5913 uint8_t *output,
5914 size_t output_size,
5915 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02005916{
5917 psa_key_slot_t *slot;
5918 psa_status_t status;
5919
5920 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
5921 {
5922 status = PSA_ERROR_INVALID_ARGUMENT;
5923 goto exit;
5924 }
Gilles Peskine28f8f302019-07-24 13:30:31 +02005925 status = psa_get_transparent_key( private_key, &slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02005926 PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02005927 if( status != PSA_SUCCESS )
5928 goto exit;
5929
5930 status = psa_key_agreement_raw_internal( alg, slot,
5931 peer_key, peer_key_length,
5932 output, output_size,
5933 output_length );
5934
5935exit:
5936 if( status != PSA_SUCCESS )
5937 {
5938 /* If an error happens and is not handled properly, the output
5939 * may be used as a key to protect sensitive data. Arrange for such
5940 * a key to be random, which is likely to result in decryption or
5941 * verification errors. This is better than filling the buffer with
5942 * some constant data such as zeros, which would result in the data
5943 * being protected with a reproducible, easily knowable key.
5944 */
5945 psa_generate_random( output, output_size );
5946 *output_length = output_size;
5947 }
5948 return( status );
5949}
Gilles Peskine86a440b2018-11-12 18:39:40 +01005950
5951
5952/****************************************************************/
5953/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02005954/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02005955
Gilles Peskine4c317f42018-07-12 01:24:09 +02005956psa_status_t psa_generate_random( uint8_t *output,
Gilles Peskine53d991e2018-07-12 01:14:59 +02005957 size_t output_size )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005958{
Janos Follath24eed8d2019-11-22 13:21:35 +00005959 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005960 GUARD_MODULE_INITIALIZED;
5961
Gilles Peskinef181eca2019-08-07 13:49:00 +02005962 while( output_size > MBEDTLS_CTR_DRBG_MAX_REQUEST )
5963 {
5964 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg,
5965 output,
5966 MBEDTLS_CTR_DRBG_MAX_REQUEST );
5967 if( ret != 0 )
5968 return( mbedtls_to_psa_error( ret ) );
5969 output += MBEDTLS_CTR_DRBG_MAX_REQUEST;
5970 output_size -= MBEDTLS_CTR_DRBG_MAX_REQUEST;
5971 }
5972
Gilles Peskinee59236f2018-01-27 23:32:46 +01005973 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg, output, output_size );
5974 return( mbedtls_to_psa_error( ret ) );
5975}
5976
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005977#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
5978#include "mbedtls/entropy_poll.h"
5979
Gilles Peskine7228da22019-07-15 11:06:15 +02005980psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005981 size_t seed_size )
5982{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005983 if( global_data.initialized )
5984 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02005985
5986 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
5987 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
5988 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
5989 return( PSA_ERROR_INVALID_ARGUMENT );
5990
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005991 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005992}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005993#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005994
Gilles Peskinee56e8782019-04-26 17:34:02 +02005995#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_GENPRIME)
5996static psa_status_t psa_read_rsa_exponent( const uint8_t *domain_parameters,
5997 size_t domain_parameters_size,
5998 int *exponent )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005999{
Gilles Peskinee56e8782019-04-26 17:34:02 +02006000 size_t i;
6001 uint32_t acc = 0;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006002
Gilles Peskinee56e8782019-04-26 17:34:02 +02006003 if( domain_parameters_size == 0 )
6004 {
6005 *exponent = 65537;
6006 return( PSA_SUCCESS );
6007 }
6008
6009 /* Mbed TLS encodes the public exponent as an int. For simplicity, only
6010 * support values that fit in a 32-bit integer, which is larger than
6011 * int on just about every platform anyway. */
6012 if( domain_parameters_size > sizeof( acc ) )
6013 return( PSA_ERROR_NOT_SUPPORTED );
6014 for( i = 0; i < domain_parameters_size; i++ )
6015 acc = ( acc << 8 ) | domain_parameters[i];
6016 if( acc > INT_MAX )
6017 return( PSA_ERROR_NOT_SUPPORTED );
6018 *exponent = acc;
6019 return( PSA_SUCCESS );
6020}
6021#endif /* MBEDTLS_RSA_C && MBEDTLS_GENPRIME */
6022
Gilles Peskine35ef36b2019-05-16 19:42:05 +02006023static psa_status_t psa_generate_key_internal(
Gilles Peskinee56e8782019-04-26 17:34:02 +02006024 psa_key_slot_t *slot, size_t bits,
6025 const uint8_t *domain_parameters, size_t domain_parameters_size )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006026{
Gilles Peskine8e338702019-07-30 20:06:31 +02006027 psa_key_type_t type = slot->attr.type;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006028
Gilles Peskinee56e8782019-04-26 17:34:02 +02006029 if( domain_parameters == NULL && domain_parameters_size != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006030 return( PSA_ERROR_INVALID_ARGUMENT );
6031
Gilles Peskinee59236f2018-01-27 23:32:46 +01006032 if( key_type_is_raw_bytes( type ) )
6033 {
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006034 psa_status_t status;
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006035
6036 status = validate_unstructured_key_bit_size( slot->attr.type, bits );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006037 if( status != PSA_SUCCESS )
6038 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006039
6040 /* Allocate memory for the key */
Steven Cooreman75b74362020-07-28 14:30:13 +02006041 status = psa_allocate_buffer_to_slot( slot, PSA_BITS_TO_BYTES( bits ) );
6042 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02006043 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006044
Steven Cooreman71fd80d2020-07-07 21:12:27 +02006045 status = psa_generate_random( slot->data.key.data,
6046 slot->data.key.bytes );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006047 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006048 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006049
6050 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006051#if defined(MBEDTLS_DES_C)
6052 if( type == PSA_KEY_TYPE_DES )
Steven Cooreman71fd80d2020-07-07 21:12:27 +02006053 psa_des_set_key_parity( slot->data.key.data,
6054 slot->data.key.bytes );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006055#endif /* MBEDTLS_DES_C */
6056 }
6057 else
6058
6059#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_GENPRIME)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02006060 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006061 {
Steven Cooremana01795d2020-07-24 22:48:15 +02006062 mbedtls_rsa_context rsa;
Janos Follath24eed8d2019-11-22 13:21:35 +00006063 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee56e8782019-04-26 17:34:02 +02006064 int exponent;
6065 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006066 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
6067 return( PSA_ERROR_NOT_SUPPORTED );
6068 /* Accept only byte-aligned keys, for the same reasons as
6069 * in psa_import_rsa_key(). */
6070 if( bits % 8 != 0 )
6071 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinee56e8782019-04-26 17:34:02 +02006072 status = psa_read_rsa_exponent( domain_parameters,
6073 domain_parameters_size,
6074 &exponent );
6075 if( status != PSA_SUCCESS )
6076 return( status );
Steven Cooremana01795d2020-07-24 22:48:15 +02006077 mbedtls_rsa_init( &rsa, MBEDTLS_RSA_PKCS_V15, MBEDTLS_MD_NONE );
6078 ret = mbedtls_rsa_gen_key( &rsa,
Gilles Peskinee59236f2018-01-27 23:32:46 +01006079 mbedtls_ctr_drbg_random,
6080 &global_data.ctr_drbg,
6081 (unsigned int) bits,
6082 exponent );
6083 if( ret != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006084 return( mbedtls_to_psa_error( ret ) );
Steven Cooremana01795d2020-07-24 22:48:15 +02006085
6086 /* Make sure to always have an export representation available */
6087 size_t bytes = PSA_KEY_EXPORT_RSA_KEY_PAIR_MAX_SIZE( bits );
6088
Steven Cooreman75b74362020-07-28 14:30:13 +02006089 status = psa_allocate_buffer_to_slot( slot, bytes );
6090 if( status != PSA_SUCCESS )
Steven Cooremana01795d2020-07-24 22:48:15 +02006091 {
6092 mbedtls_rsa_free( &rsa );
Steven Cooreman29149862020-08-05 15:43:42 +02006093 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006094 }
Steven Cooremana01795d2020-07-24 22:48:15 +02006095
6096 status = psa_export_rsa_key( type,
6097 &rsa,
6098 slot->data.key.data,
6099 bytes,
6100 &slot->data.key.bytes );
6101 mbedtls_rsa_free( &rsa );
6102 if( status != PSA_SUCCESS )
Steven Cooremana01795d2020-07-24 22:48:15 +02006103 psa_remove_key_data_from_memory( slot );
Steven Cooreman560c28a2020-07-24 23:20:24 +02006104 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006105 }
6106 else
6107#endif /* MBEDTLS_RSA_C && MBEDTLS_GENPRIME */
6108
6109#if defined(MBEDTLS_ECP_C)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02006110 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006111 {
Paul Elliott8ff510a2020-06-02 17:19:28 +01006112 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY( type );
Gilles Peskine4295e8b2019-12-02 21:39:10 +01006113 mbedtls_ecp_group_id grp_id =
6114 mbedtls_ecc_group_of_psa( curve, PSA_BITS_TO_BYTES( bits ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006115 const mbedtls_ecp_curve_info *curve_info =
6116 mbedtls_ecp_curve_info_from_grp_id( grp_id );
Steven Cooremanacda8342020-07-24 23:09:52 +02006117 mbedtls_ecp_keypair ecp;
Janos Follath24eed8d2019-11-22 13:21:35 +00006118 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee56e8782019-04-26 17:34:02 +02006119 if( domain_parameters_size != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006120 return( PSA_ERROR_NOT_SUPPORTED );
6121 if( grp_id == MBEDTLS_ECP_DP_NONE || curve_info == NULL )
6122 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooremanacda8342020-07-24 23:09:52 +02006123 mbedtls_ecp_keypair_init( &ecp );
6124 ret = mbedtls_ecp_gen_key( grp_id, &ecp,
Gilles Peskinee59236f2018-01-27 23:32:46 +01006125 mbedtls_ctr_drbg_random,
6126 &global_data.ctr_drbg );
6127 if( ret != 0 )
6128 {
Steven Cooremanacda8342020-07-24 23:09:52 +02006129 mbedtls_ecp_keypair_free( &ecp );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006130 return( mbedtls_to_psa_error( ret ) );
6131 }
Steven Cooremanacda8342020-07-24 23:09:52 +02006132
6133
6134 /* Make sure to always have an export representation available */
6135 size_t bytes = PSA_BITS_TO_BYTES( bits );
Steven Cooreman75b74362020-07-28 14:30:13 +02006136 psa_status_t status = psa_allocate_buffer_to_slot( slot, bytes );
6137 if( status != PSA_SUCCESS )
Steven Cooremanacda8342020-07-24 23:09:52 +02006138 {
6139 mbedtls_ecp_keypair_free( &ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02006140 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02006141 }
Steven Cooreman75b74362020-07-28 14:30:13 +02006142
6143 status = mbedtls_to_psa_error(
Steven Cooremanacda8342020-07-24 23:09:52 +02006144 mbedtls_ecp_write_key( &ecp, slot->data.key.data, bytes ) );
6145
6146 mbedtls_ecp_keypair_free( &ecp );
Steven Cooremanb7f6dea2020-08-05 16:07:20 +02006147 if( status != PSA_SUCCESS ) {
6148 memset( slot->data.key.data, 0, bytes );
Steven Cooremanacda8342020-07-24 23:09:52 +02006149 psa_remove_key_data_from_memory( slot );
Steven Cooremanb7f6dea2020-08-05 16:07:20 +02006150 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02006151 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006152 }
6153 else
6154#endif /* MBEDTLS_ECP_C */
Steven Cooreman29149862020-08-05 15:43:42 +02006155 {
Gilles Peskinee59236f2018-01-27 23:32:46 +01006156 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman29149862020-08-05 15:43:42 +02006157 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01006158
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006159 return( PSA_SUCCESS );
6160}
Darryl Green0c6575a2018-11-07 16:05:30 +00006161
Gilles Peskine35ef36b2019-05-16 19:42:05 +02006162psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Gilles Peskinee56e8782019-04-26 17:34:02 +02006163 psa_key_handle_t *handle )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006164{
6165 psa_status_t status;
6166 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02006167 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine11792082019-08-06 18:36:36 +02006168
Gilles Peskine0f84d622019-09-12 19:03:13 +02006169 /* Reject any attempt to create a zero-length key so that we don't
6170 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
6171 if( psa_get_key_bits( attributes ) == 0 )
6172 return( PSA_ERROR_INVALID_ARGUMENT );
6173
Gilles Peskinedf179142019-07-15 22:02:14 +02006174 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE,
6175 attributes, handle, &slot, &driver );
Gilles Peskine11792082019-08-06 18:36:36 +02006176 if( status != PSA_SUCCESS )
6177 goto exit;
6178
Steven Cooreman2a1664c2020-07-20 15:33:08 +02006179 status = psa_driver_wrapper_generate_key( attributes,
6180 slot );
6181 if( status != PSA_ERROR_NOT_SUPPORTED ||
6182 psa_key_lifetime_is_external( attributes->core.lifetime ) )
6183 goto exit;
6184
6185 status = psa_generate_key_internal(
6186 slot, attributes->core.bits,
6187 attributes->domain_parameters, attributes->domain_parameters_size );
Gilles Peskine11792082019-08-06 18:36:36 +02006188
6189exit:
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006190 if( status == PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02006191 status = psa_finish_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006192 if( status != PSA_SUCCESS )
6193 {
Gilles Peskine011e4282019-06-26 18:34:38 +02006194 psa_fail_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006195 *handle = 0;
6196 }
Darryl Green0c6575a2018-11-07 16:05:30 +00006197 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006198}
6199
6200
Gilles Peskinee59236f2018-01-27 23:32:46 +01006201
6202/****************************************************************/
6203/* Module setup */
6204/****************************************************************/
6205
Gilles Peskine5e769522018-11-20 21:59:56 +01006206psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
6207 void (* entropy_init )( mbedtls_entropy_context *ctx ),
6208 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
6209{
6210 if( global_data.rng_state != RNG_NOT_INITIALIZED )
6211 return( PSA_ERROR_BAD_STATE );
6212 global_data.entropy_init = entropy_init;
6213 global_data.entropy_free = entropy_free;
6214 return( PSA_SUCCESS );
6215}
6216
Gilles Peskinee59236f2018-01-27 23:32:46 +01006217void mbedtls_psa_crypto_free( void )
6218{
Gilles Peskine66fb1262018-12-10 16:29:04 +01006219 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006220 if( global_data.rng_state != RNG_NOT_INITIALIZED )
6221 {
6222 mbedtls_ctr_drbg_free( &global_data.ctr_drbg );
Gilles Peskine5e769522018-11-20 21:59:56 +01006223 global_data.entropy_free( &global_data.entropy );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006224 }
6225 /* Wipe all remaining data, including configuration.
6226 * In particular, this sets all state indicator to the value
6227 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01006228 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Gilles Peskinea8ade162019-06-26 11:24:49 +02006229#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +02006230 /* Unregister all secure element drivers, so that we restart from
6231 * a pristine state. */
6232 psa_unregister_all_se_drivers( );
Gilles Peskinea8ade162019-06-26 11:24:49 +02006233#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006234}
6235
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006236#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
6237/** Recover a transaction that was interrupted by a power failure.
6238 *
6239 * This function is called during initialization, before psa_crypto_init()
6240 * returns. If this function returns a failure status, the initialization
6241 * fails.
6242 */
6243static psa_status_t psa_crypto_recover_transaction(
6244 const psa_crypto_transaction_t *transaction )
6245{
6246 switch( transaction->unknown.type )
6247 {
6248 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
6249 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01006250 /* TODO - fall through to the failure case until this
Gilles Peskinec9d7f942019-08-13 16:17:16 +02006251 * is implemented.
6252 * https://github.com/ARMmbed/mbed-crypto/issues/218
6253 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006254 default:
6255 /* We found an unsupported transaction in the storage.
6256 * We don't know what state the storage is in. Give up. */
6257 return( PSA_ERROR_STORAGE_FAILURE );
6258 }
6259}
6260#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
6261
Gilles Peskinee59236f2018-01-27 23:32:46 +01006262psa_status_t psa_crypto_init( void )
6263{
Gilles Peskine66fb1262018-12-10 16:29:04 +01006264 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006265 const unsigned char drbg_seed[] = "PSA";
6266
Gilles Peskinec6b69072018-11-20 21:42:52 +01006267 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006268 if( global_data.initialized != 0 )
6269 return( PSA_SUCCESS );
6270
Gilles Peskine5e769522018-11-20 21:59:56 +01006271 /* Set default configuration if
6272 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
6273 if( global_data.entropy_init == NULL )
6274 global_data.entropy_init = mbedtls_entropy_init;
6275 if( global_data.entropy_free == NULL )
6276 global_data.entropy_free = mbedtls_entropy_free;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006277
Gilles Peskinec6b69072018-11-20 21:42:52 +01006278 /* Initialize the random generator. */
Gilles Peskine5e769522018-11-20 21:59:56 +01006279 global_data.entropy_init( &global_data.entropy );
Jaeden Amero76541612019-06-04 17:14:43 +01006280#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
6281 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
6282 /* The PSA entropy injection feature depends on using NV seed as an entropy
6283 * source. Add NV seed as an entropy source for PSA entropy injection. */
6284 mbedtls_entropy_add_source( &global_data.entropy,
6285 mbedtls_nv_seed_poll, NULL,
6286 MBEDTLS_ENTROPY_BLOCK_SIZE,
6287 MBEDTLS_ENTROPY_SOURCE_STRONG );
6288#endif
Gilles Peskinee59236f2018-01-27 23:32:46 +01006289 mbedtls_ctr_drbg_init( &global_data.ctr_drbg );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006290 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine66fb1262018-12-10 16:29:04 +01006291 status = mbedtls_to_psa_error(
6292 mbedtls_ctr_drbg_seed( &global_data.ctr_drbg,
6293 mbedtls_entropy_func,
6294 &global_data.entropy,
6295 drbg_seed, sizeof( drbg_seed ) - 1 ) );
6296 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006297 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01006298 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006299
Gilles Peskine66fb1262018-12-10 16:29:04 +01006300 status = psa_initialize_key_slots( );
6301 if( status != PSA_SUCCESS )
6302 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01006303
Gilles Peskined9348f22019-10-01 15:22:29 +02006304#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
6305 status = psa_init_all_se_drivers( );
6306 if( status != PSA_SUCCESS )
6307 goto exit;
6308#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
6309
Gilles Peskine4b734222019-07-24 15:56:31 +02006310#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02006311 status = psa_crypto_load_transaction( );
6312 if( status == PSA_SUCCESS )
6313 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006314 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
6315 if( status != PSA_SUCCESS )
6316 goto exit;
6317 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02006318 }
6319 else if( status == PSA_ERROR_DOES_NOT_EXIST )
6320 {
6321 /* There's no transaction to complete. It's all good. */
6322 status = PSA_SUCCESS;
6323 }
Gilles Peskine4b734222019-07-24 15:56:31 +02006324#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02006325
Gilles Peskinec6b69072018-11-20 21:42:52 +01006326 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006327 global_data.initialized = 1;
6328
6329exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01006330 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006331 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01006332 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006333}
6334
6335#endif /* MBEDTLS_PSA_CRYPTO_C */