blob: 36dcd3fca2b3ec96a55bb143c4c3e98e1defadf3 [file] [log] [blame]
Gilles Peskinee59236f2018-01-27 23:32:46 +01001/*
2 * PSA crypto layer on top of Mbed TLS crypto
3 */
Bence Szépkúti86974652020-06-15 11:59:37 +02004/*
Bence Szépkúti1e148272020-08-07 13:07:28 +02005 * Copyright The Mbed TLS Contributors
Gilles Peskinee59236f2018-01-27 23:32:46 +01006 * SPDX-License-Identifier: Apache-2.0
7 *
8 * Licensed under the Apache License, Version 2.0 (the "License"); you may
9 * not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
Gilles Peskinee59236f2018-01-27 23:32:46 +010019 */
20
Gilles Peskinedb09ef62020-06-03 01:43:33 +020021#include "common.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010022
23#if defined(MBEDTLS_PSA_CRYPTO_C)
mohammad160327010052018-07-03 13:16:15 +030024
itayzafrir7723ab12019-02-14 10:28:02 +020025#include "psa_crypto_service_integration.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010026#include "psa/crypto.h"
27
Gilles Peskine039b90c2018-12-07 18:24:41 +010028#include "psa_crypto_core.h"
Gilles Peskine5e769522018-11-20 21:59:56 +010029#include "psa_crypto_invasive.h"
Steven Cooremancd84cb42020-07-16 20:28:36 +020030#include "psa_crypto_driver_wrappers.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020031#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +020032#include "psa_crypto_se.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020033#endif
Gilles Peskine961849f2018-11-30 18:54:54 +010034#include "psa_crypto_slot_management.h"
Darryl Greend49a4992018-06-18 17:27:26 +010035/* Include internal declarations that are useful for implementing persistently
36 * stored keys. */
37#include "psa_crypto_storage.h"
38
Gilles Peskineb46bef22019-07-30 21:32:04 +020039#include <assert.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010040#include <stdlib.h>
41#include <string.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010042#include "mbedtls/platform.h"
Gilles Peskineff2d2002019-05-06 15:26:23 +020043#if !defined(MBEDTLS_PLATFORM_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010044#define mbedtls_calloc calloc
45#define mbedtls_free free
46#endif
47
Gilles Peskinea5905292018-02-07 20:59:33 +010048#include "mbedtls/arc4.h"
Gilles Peskine9a944802018-06-21 09:35:35 +020049#include "mbedtls/asn1.h"
Jaeden Amero25384a22019-01-10 10:23:21 +000050#include "mbedtls/asn1write.h"
Gilles Peskinea81d85b2018-06-26 16:10:23 +020051#include "mbedtls/bignum.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010052#include "mbedtls/blowfish.h"
53#include "mbedtls/camellia.h"
Gilles Peskine26869f22019-05-06 15:25:00 +020054#include "mbedtls/chacha20.h"
55#include "mbedtls/chachapoly.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010056#include "mbedtls/cipher.h"
57#include "mbedtls/ccm.h"
58#include "mbedtls/cmac.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010059#include "mbedtls/ctr_drbg.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010060#include "mbedtls/des.h"
Gilles Peskineb7ecdf02018-09-18 12:11:27 +020061#include "mbedtls/ecdh.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010062#include "mbedtls/ecp.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010063#include "mbedtls/entropy.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010064#include "mbedtls/error.h"
65#include "mbedtls/gcm.h"
66#include "mbedtls/md2.h"
67#include "mbedtls/md4.h"
68#include "mbedtls/md5.h"
Gilles Peskine20035e32018-02-03 22:44:14 +010069#include "mbedtls/md.h"
70#include "mbedtls/md_internal.h"
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010071#include "mbedtls/pk.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010072#include "mbedtls/pk_internal.h"
Gilles Peskine3f108122018-12-07 18:14:53 +010073#include "mbedtls/platform_util.h"
Janos Follath24eed8d2019-11-22 13:21:35 +000074#include "mbedtls/error.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010075#include "mbedtls/ripemd160.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010076#include "mbedtls/rsa.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010077#include "mbedtls/sha1.h"
78#include "mbedtls/sha256.h"
79#include "mbedtls/sha512.h"
80#include "mbedtls/xtea.h"
81
Gilles Peskine996deb12018-08-01 15:45:45 +020082#define ARRAY_LENGTH( array ) ( sizeof( array ) / sizeof( *( array ) ) )
83
Gilles Peskine9ef733f2018-02-07 21:05:37 +010084/* constant-time buffer comparison */
85static inline int safer_memcmp( const uint8_t *a, const uint8_t *b, size_t n )
86{
87 size_t i;
88 unsigned char diff = 0;
89
90 for( i = 0; i < n; i++ )
91 diff |= a[i] ^ b[i];
92
93 return( diff );
94}
95
96
97
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010098/****************************************************************/
99/* Global data, support functions and library management */
100/****************************************************************/
101
Gilles Peskine48c0ea12018-06-21 14:15:31 +0200102static int key_type_is_raw_bytes( psa_key_type_t type )
103{
Gilles Peskine78b3bb62018-08-10 16:03:41 +0200104 return( PSA_KEY_TYPE_IS_UNSTRUCTURED( type ) );
Gilles Peskine48c0ea12018-06-21 14:15:31 +0200105}
106
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100107/* Values for psa_global_data_t::rng_state */
108#define RNG_NOT_INITIALIZED 0
109#define RNG_INITIALIZED 1
110#define RNG_SEEDED 2
Gilles Peskinec6b69072018-11-20 21:42:52 +0100111
Gilles Peskine2d277862018-06-18 15:41:12 +0200112typedef struct
113{
Gilles Peskine5e769522018-11-20 21:59:56 +0100114 void (* entropy_init )( mbedtls_entropy_context *ctx );
115 void (* entropy_free )( mbedtls_entropy_context *ctx );
Gilles Peskinee59236f2018-01-27 23:32:46 +0100116 mbedtls_entropy_context entropy;
117 mbedtls_ctr_drbg_context ctr_drbg;
Gilles Peskinec6b69072018-11-20 21:42:52 +0100118 unsigned initialized : 1;
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100119 unsigned rng_state : 2;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100120} psa_global_data_t;
121
122static psa_global_data_t global_data;
123
itayzafrir0adf0fc2018-09-06 16:24:41 +0300124#define GUARD_MODULE_INITIALIZED \
125 if( global_data.initialized == 0 ) \
126 return( PSA_ERROR_BAD_STATE );
127
Steven Cooreman01164162020-07-20 15:31:37 +0200128psa_status_t mbedtls_to_psa_error( int ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100129{
Gilles Peskinea5905292018-02-07 20:59:33 +0100130 /* If there's both a high-level code and low-level code, dispatch on
131 * the high-level code. */
132 switch( ret < -0x7f ? - ( -ret & 0x7f80 ) : ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100133 {
134 case 0:
135 return( PSA_SUCCESS );
Gilles Peskinea5905292018-02-07 20:59:33 +0100136
137 case MBEDTLS_ERR_AES_INVALID_KEY_LENGTH:
138 case MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH:
139 case MBEDTLS_ERR_AES_FEATURE_UNAVAILABLE:
140 return( PSA_ERROR_NOT_SUPPORTED );
141 case MBEDTLS_ERR_AES_HW_ACCEL_FAILED:
142 return( PSA_ERROR_HARDWARE_FAILURE );
143
144 case MBEDTLS_ERR_ARC4_HW_ACCEL_FAILED:
145 return( PSA_ERROR_HARDWARE_FAILURE );
146
Gilles Peskine9a944802018-06-21 09:35:35 +0200147 case MBEDTLS_ERR_ASN1_OUT_OF_DATA:
148 case MBEDTLS_ERR_ASN1_UNEXPECTED_TAG:
149 case MBEDTLS_ERR_ASN1_INVALID_LENGTH:
150 case MBEDTLS_ERR_ASN1_LENGTH_MISMATCH:
151 case MBEDTLS_ERR_ASN1_INVALID_DATA:
152 return( PSA_ERROR_INVALID_ARGUMENT );
153 case MBEDTLS_ERR_ASN1_ALLOC_FAILED:
154 return( PSA_ERROR_INSUFFICIENT_MEMORY );
155 case MBEDTLS_ERR_ASN1_BUF_TOO_SMALL:
156 return( PSA_ERROR_BUFFER_TOO_SMALL );
157
Jaeden Amero93e21112019-02-20 13:57:28 +0000158#if defined(MBEDTLS_ERR_BLOWFISH_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000159 case MBEDTLS_ERR_BLOWFISH_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000160#elif defined(MBEDTLS_ERR_BLOWFISH_INVALID_KEY_LENGTH)
161 case MBEDTLS_ERR_BLOWFISH_INVALID_KEY_LENGTH:
162#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100163 case MBEDTLS_ERR_BLOWFISH_INVALID_INPUT_LENGTH:
164 return( PSA_ERROR_NOT_SUPPORTED );
165 case MBEDTLS_ERR_BLOWFISH_HW_ACCEL_FAILED:
166 return( PSA_ERROR_HARDWARE_FAILURE );
167
Jaeden Amero93e21112019-02-20 13:57:28 +0000168#if defined(MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000169 case MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000170#elif defined(MBEDTLS_ERR_CAMELLIA_INVALID_KEY_LENGTH)
171 case MBEDTLS_ERR_CAMELLIA_INVALID_KEY_LENGTH:
172#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100173 case MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH:
174 return( PSA_ERROR_NOT_SUPPORTED );
175 case MBEDTLS_ERR_CAMELLIA_HW_ACCEL_FAILED:
176 return( PSA_ERROR_HARDWARE_FAILURE );
177
178 case MBEDTLS_ERR_CCM_BAD_INPUT:
179 return( PSA_ERROR_INVALID_ARGUMENT );
180 case MBEDTLS_ERR_CCM_AUTH_FAILED:
181 return( PSA_ERROR_INVALID_SIGNATURE );
182 case MBEDTLS_ERR_CCM_HW_ACCEL_FAILED:
183 return( PSA_ERROR_HARDWARE_FAILURE );
184
Gilles Peskine26869f22019-05-06 15:25:00 +0200185 case MBEDTLS_ERR_CHACHA20_BAD_INPUT_DATA:
186 return( PSA_ERROR_INVALID_ARGUMENT );
187
188 case MBEDTLS_ERR_CHACHAPOLY_BAD_STATE:
189 return( PSA_ERROR_BAD_STATE );
190 case MBEDTLS_ERR_CHACHAPOLY_AUTH_FAILED:
191 return( PSA_ERROR_INVALID_SIGNATURE );
192
Gilles Peskinea5905292018-02-07 20:59:33 +0100193 case MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE:
194 return( PSA_ERROR_NOT_SUPPORTED );
195 case MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA:
196 return( PSA_ERROR_INVALID_ARGUMENT );
197 case MBEDTLS_ERR_CIPHER_ALLOC_FAILED:
198 return( PSA_ERROR_INSUFFICIENT_MEMORY );
199 case MBEDTLS_ERR_CIPHER_INVALID_PADDING:
200 return( PSA_ERROR_INVALID_PADDING );
201 case MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED:
Fredrik Strupef90e3012020-09-28 16:11:33 +0200202 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100203 case MBEDTLS_ERR_CIPHER_AUTH_FAILED:
204 return( PSA_ERROR_INVALID_SIGNATURE );
205 case MBEDTLS_ERR_CIPHER_INVALID_CONTEXT:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200206 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100207 case MBEDTLS_ERR_CIPHER_HW_ACCEL_FAILED:
208 return( PSA_ERROR_HARDWARE_FAILURE );
209
210 case MBEDTLS_ERR_CMAC_HW_ACCEL_FAILED:
211 return( PSA_ERROR_HARDWARE_FAILURE );
212
213 case MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED:
214 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
215 case MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG:
216 case MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG:
217 return( PSA_ERROR_NOT_SUPPORTED );
218 case MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR:
219 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
220
221 case MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH:
222 return( PSA_ERROR_NOT_SUPPORTED );
223 case MBEDTLS_ERR_DES_HW_ACCEL_FAILED:
224 return( PSA_ERROR_HARDWARE_FAILURE );
225
Gilles Peskinee59236f2018-01-27 23:32:46 +0100226 case MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED:
227 case MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE:
228 case MBEDTLS_ERR_ENTROPY_SOURCE_FAILED:
229 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskinea5905292018-02-07 20:59:33 +0100230
231 case MBEDTLS_ERR_GCM_AUTH_FAILED:
232 return( PSA_ERROR_INVALID_SIGNATURE );
233 case MBEDTLS_ERR_GCM_BAD_INPUT:
Gilles Peskine8cac2e62018-08-21 15:07:38 +0200234 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100235 case MBEDTLS_ERR_GCM_HW_ACCEL_FAILED:
236 return( PSA_ERROR_HARDWARE_FAILURE );
237
238 case MBEDTLS_ERR_MD2_HW_ACCEL_FAILED:
239 case MBEDTLS_ERR_MD4_HW_ACCEL_FAILED:
240 case MBEDTLS_ERR_MD5_HW_ACCEL_FAILED:
241 return( PSA_ERROR_HARDWARE_FAILURE );
242
243 case MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE:
244 return( PSA_ERROR_NOT_SUPPORTED );
245 case MBEDTLS_ERR_MD_BAD_INPUT_DATA:
246 return( PSA_ERROR_INVALID_ARGUMENT );
247 case MBEDTLS_ERR_MD_ALLOC_FAILED:
248 return( PSA_ERROR_INSUFFICIENT_MEMORY );
249 case MBEDTLS_ERR_MD_FILE_IO_ERROR:
250 return( PSA_ERROR_STORAGE_FAILURE );
251 case MBEDTLS_ERR_MD_HW_ACCEL_FAILED:
252 return( PSA_ERROR_HARDWARE_FAILURE );
253
Gilles Peskinef76aa772018-10-29 19:24:33 +0100254 case MBEDTLS_ERR_MPI_FILE_IO_ERROR:
255 return( PSA_ERROR_STORAGE_FAILURE );
256 case MBEDTLS_ERR_MPI_BAD_INPUT_DATA:
257 return( PSA_ERROR_INVALID_ARGUMENT );
258 case MBEDTLS_ERR_MPI_INVALID_CHARACTER:
259 return( PSA_ERROR_INVALID_ARGUMENT );
260 case MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL:
261 return( PSA_ERROR_BUFFER_TOO_SMALL );
262 case MBEDTLS_ERR_MPI_NEGATIVE_VALUE:
263 return( PSA_ERROR_INVALID_ARGUMENT );
264 case MBEDTLS_ERR_MPI_DIVISION_BY_ZERO:
265 return( PSA_ERROR_INVALID_ARGUMENT );
266 case MBEDTLS_ERR_MPI_NOT_ACCEPTABLE:
267 return( PSA_ERROR_INVALID_ARGUMENT );
268 case MBEDTLS_ERR_MPI_ALLOC_FAILED:
269 return( PSA_ERROR_INSUFFICIENT_MEMORY );
270
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100271 case MBEDTLS_ERR_PK_ALLOC_FAILED:
272 return( PSA_ERROR_INSUFFICIENT_MEMORY );
273 case MBEDTLS_ERR_PK_TYPE_MISMATCH:
274 case MBEDTLS_ERR_PK_BAD_INPUT_DATA:
275 return( PSA_ERROR_INVALID_ARGUMENT );
276 case MBEDTLS_ERR_PK_FILE_IO_ERROR:
Gilles Peskinea5905292018-02-07 20:59:33 +0100277 return( PSA_ERROR_STORAGE_FAILURE );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100278 case MBEDTLS_ERR_PK_KEY_INVALID_VERSION:
279 case MBEDTLS_ERR_PK_KEY_INVALID_FORMAT:
280 return( PSA_ERROR_INVALID_ARGUMENT );
281 case MBEDTLS_ERR_PK_UNKNOWN_PK_ALG:
282 return( PSA_ERROR_NOT_SUPPORTED );
283 case MBEDTLS_ERR_PK_PASSWORD_REQUIRED:
284 case MBEDTLS_ERR_PK_PASSWORD_MISMATCH:
285 return( PSA_ERROR_NOT_PERMITTED );
286 case MBEDTLS_ERR_PK_INVALID_PUBKEY:
287 return( PSA_ERROR_INVALID_ARGUMENT );
288 case MBEDTLS_ERR_PK_INVALID_ALG:
289 case MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE:
290 case MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE:
291 return( PSA_ERROR_NOT_SUPPORTED );
292 case MBEDTLS_ERR_PK_SIG_LEN_MISMATCH:
293 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskinea5905292018-02-07 20:59:33 +0100294 case MBEDTLS_ERR_PK_HW_ACCEL_FAILED:
295 return( PSA_ERROR_HARDWARE_FAILURE );
296
Gilles Peskineff2d2002019-05-06 15:26:23 +0200297 case MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED:
298 return( PSA_ERROR_HARDWARE_FAILURE );
299 case MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED:
300 return( PSA_ERROR_NOT_SUPPORTED );
301
Gilles Peskinea5905292018-02-07 20:59:33 +0100302 case MBEDTLS_ERR_RIPEMD160_HW_ACCEL_FAILED:
303 return( PSA_ERROR_HARDWARE_FAILURE );
304
305 case MBEDTLS_ERR_RSA_BAD_INPUT_DATA:
306 return( PSA_ERROR_INVALID_ARGUMENT );
307 case MBEDTLS_ERR_RSA_INVALID_PADDING:
308 return( PSA_ERROR_INVALID_PADDING );
309 case MBEDTLS_ERR_RSA_KEY_GEN_FAILED:
310 return( PSA_ERROR_HARDWARE_FAILURE );
311 case MBEDTLS_ERR_RSA_KEY_CHECK_FAILED:
312 return( PSA_ERROR_INVALID_ARGUMENT );
313 case MBEDTLS_ERR_RSA_PUBLIC_FAILED:
314 case MBEDTLS_ERR_RSA_PRIVATE_FAILED:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200315 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100316 case MBEDTLS_ERR_RSA_VERIFY_FAILED:
317 return( PSA_ERROR_INVALID_SIGNATURE );
318 case MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE:
319 return( PSA_ERROR_BUFFER_TOO_SMALL );
320 case MBEDTLS_ERR_RSA_RNG_FAILED:
321 return( PSA_ERROR_INSUFFICIENT_MEMORY );
322 case MBEDTLS_ERR_RSA_UNSUPPORTED_OPERATION:
323 return( PSA_ERROR_NOT_SUPPORTED );
324 case MBEDTLS_ERR_RSA_HW_ACCEL_FAILED:
325 return( PSA_ERROR_HARDWARE_FAILURE );
326
327 case MBEDTLS_ERR_SHA1_HW_ACCEL_FAILED:
328 case MBEDTLS_ERR_SHA256_HW_ACCEL_FAILED:
329 case MBEDTLS_ERR_SHA512_HW_ACCEL_FAILED:
330 return( PSA_ERROR_HARDWARE_FAILURE );
331
332 case MBEDTLS_ERR_XTEA_INVALID_INPUT_LENGTH:
333 return( PSA_ERROR_INVALID_ARGUMENT );
334 case MBEDTLS_ERR_XTEA_HW_ACCEL_FAILED:
335 return( PSA_ERROR_HARDWARE_FAILURE );
336
itayzafrir5c753392018-05-08 11:18:38 +0300337 case MBEDTLS_ERR_ECP_BAD_INPUT_DATA:
itayzafrir7b30f8b2018-05-09 16:07:36 +0300338 case MBEDTLS_ERR_ECP_INVALID_KEY:
itayzafrir5c753392018-05-08 11:18:38 +0300339 return( PSA_ERROR_INVALID_ARGUMENT );
itayzafrir7b30f8b2018-05-09 16:07:36 +0300340 case MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL:
341 return( PSA_ERROR_BUFFER_TOO_SMALL );
342 case MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE:
343 return( PSA_ERROR_NOT_SUPPORTED );
344 case MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH:
345 case MBEDTLS_ERR_ECP_VERIFY_FAILED:
346 return( PSA_ERROR_INVALID_SIGNATURE );
347 case MBEDTLS_ERR_ECP_ALLOC_FAILED:
348 return( PSA_ERROR_INSUFFICIENT_MEMORY );
349 case MBEDTLS_ERR_ECP_HW_ACCEL_FAILED:
350 return( PSA_ERROR_HARDWARE_FAILURE );
Janos Follatha13b9052019-11-22 12:48:59 +0000351 case MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED:
352 return( PSA_ERROR_CORRUPTION_DETECTED );
itayzafrir5c753392018-05-08 11:18:38 +0300353
Gilles Peskinee59236f2018-01-27 23:32:46 +0100354 default:
David Saadab4ecc272019-02-14 13:48:10 +0200355 return( PSA_ERROR_GENERIC_ERROR );
Gilles Peskinee59236f2018-01-27 23:32:46 +0100356 }
357}
358
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200359
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +0200360
361
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100362/****************************************************************/
363/* Key management */
364/****************************************************************/
365
Gilles Peskine73167e12019-07-12 23:44:37 +0200366#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
367static inline int psa_key_slot_is_external( const psa_key_slot_t *slot )
368{
Gilles Peskine8e338702019-07-30 20:06:31 +0200369 return( psa_key_lifetime_is_external( slot->attr.lifetime ) );
Gilles Peskine73167e12019-07-12 23:44:37 +0200370}
371#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
372
Darryl Green8f8aa8f2018-07-24 15:44:51 +0100373#if defined(MBEDTLS_ECP_C)
Paul Elliott8ff510a2020-06-02 17:19:28 +0100374mbedtls_ecp_group_id mbedtls_ecc_group_of_psa( psa_ecc_family_t curve,
Gilles Peskine5055b232019-12-12 17:49:31 +0100375 size_t byte_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +0200376{
377 switch( curve )
378 {
Paul Elliott8ff510a2020-06-02 17:19:28 +0100379 case PSA_ECC_FAMILY_SECP_R1:
Gilles Peskine228abc52019-12-03 17:24:19 +0100380 switch( byte_length )
381 {
382 case PSA_BITS_TO_BYTES( 192 ):
383 return( MBEDTLS_ECP_DP_SECP192R1 );
384 case PSA_BITS_TO_BYTES( 224 ):
385 return( MBEDTLS_ECP_DP_SECP224R1 );
386 case PSA_BITS_TO_BYTES( 256 ):
387 return( MBEDTLS_ECP_DP_SECP256R1 );
388 case PSA_BITS_TO_BYTES( 384 ):
389 return( MBEDTLS_ECP_DP_SECP384R1 );
390 case PSA_BITS_TO_BYTES( 521 ):
391 return( MBEDTLS_ECP_DP_SECP521R1 );
392 default:
393 return( MBEDTLS_ECP_DP_NONE );
394 }
395 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100396
Paul Elliott8ff510a2020-06-02 17:19:28 +0100397 case PSA_ECC_FAMILY_BRAINPOOL_P_R1:
Gilles Peskine228abc52019-12-03 17:24:19 +0100398 switch( byte_length )
399 {
400 case PSA_BITS_TO_BYTES( 256 ):
401 return( MBEDTLS_ECP_DP_BP256R1 );
402 case PSA_BITS_TO_BYTES( 384 ):
403 return( MBEDTLS_ECP_DP_BP384R1 );
404 case PSA_BITS_TO_BYTES( 512 ):
405 return( MBEDTLS_ECP_DP_BP512R1 );
406 default:
407 return( MBEDTLS_ECP_DP_NONE );
408 }
409 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100410
Paul Elliott8ff510a2020-06-02 17:19:28 +0100411 case PSA_ECC_FAMILY_MONTGOMERY:
Gilles Peskine228abc52019-12-03 17:24:19 +0100412 switch( byte_length )
413 {
414 case PSA_BITS_TO_BYTES( 255 ):
415 return( MBEDTLS_ECP_DP_CURVE25519 );
416 case PSA_BITS_TO_BYTES( 448 ):
417 return( MBEDTLS_ECP_DP_CURVE448 );
418 default:
419 return( MBEDTLS_ECP_DP_NONE );
420 }
421 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100422
Paul Elliott8ff510a2020-06-02 17:19:28 +0100423 case PSA_ECC_FAMILY_SECP_K1:
Gilles Peskine228abc52019-12-03 17:24:19 +0100424 switch( byte_length )
425 {
426 case PSA_BITS_TO_BYTES( 192 ):
427 return( MBEDTLS_ECP_DP_SECP192K1 );
428 case PSA_BITS_TO_BYTES( 224 ):
429 return( MBEDTLS_ECP_DP_SECP224K1 );
430 case PSA_BITS_TO_BYTES( 256 ):
431 return( MBEDTLS_ECP_DP_SECP256K1 );
432 default:
433 return( MBEDTLS_ECP_DP_NONE );
434 }
435 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100436
Gilles Peskine12313cd2018-06-20 00:20:32 +0200437 default:
438 return( MBEDTLS_ECP_DP_NONE );
439 }
440}
Darryl Green8f8aa8f2018-07-24 15:44:51 +0100441#endif /* defined(MBEDTLS_ECP_C) */
Gilles Peskine12313cd2018-06-20 00:20:32 +0200442
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200443static psa_status_t validate_unstructured_key_bit_size( psa_key_type_t type,
444 size_t bits )
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200445{
446 /* Check that the bit size is acceptable for the key type */
447 switch( type )
448 {
449 case PSA_KEY_TYPE_RAW_DATA:
450#if defined(MBEDTLS_MD_C)
451 case PSA_KEY_TYPE_HMAC:
Gilles Peskine46f1fd72018-06-28 19:31:31 +0200452#endif
Gilles Peskineea0fb492018-07-12 17:17:20 +0200453 case PSA_KEY_TYPE_DERIVE:
454 break;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200455#if defined(MBEDTLS_AES_C)
456 case PSA_KEY_TYPE_AES:
457 if( bits != 128 && bits != 192 && bits != 256 )
458 return( PSA_ERROR_INVALID_ARGUMENT );
459 break;
460#endif
461#if defined(MBEDTLS_CAMELLIA_C)
462 case PSA_KEY_TYPE_CAMELLIA:
463 if( bits != 128 && bits != 192 && bits != 256 )
464 return( PSA_ERROR_INVALID_ARGUMENT );
465 break;
466#endif
467#if defined(MBEDTLS_DES_C)
468 case PSA_KEY_TYPE_DES:
469 if( bits != 64 && bits != 128 && bits != 192 )
470 return( PSA_ERROR_INVALID_ARGUMENT );
471 break;
472#endif
473#if defined(MBEDTLS_ARC4_C)
474 case PSA_KEY_TYPE_ARC4:
475 if( bits < 8 || bits > 2048 )
476 return( PSA_ERROR_INVALID_ARGUMENT );
477 break;
478#endif
Gilles Peskine26869f22019-05-06 15:25:00 +0200479#if defined(MBEDTLS_CHACHA20_C)
480 case PSA_KEY_TYPE_CHACHA20:
481 if( bits != 256 )
482 return( PSA_ERROR_INVALID_ARGUMENT );
483 break;
484#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200485 default:
486 return( PSA_ERROR_NOT_SUPPORTED );
487 }
Gilles Peskineb54979a2018-06-21 09:32:47 +0200488 if( bits % 8 != 0 )
489 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200490
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200491 return( PSA_SUCCESS );
492}
493
Steven Cooremana01795d2020-07-24 22:48:15 +0200494#if defined(MBEDTLS_RSA_C)
495
496#if defined(MBEDTLS_PK_PARSE_C)
Gilles Peskine86a440b2018-11-12 18:39:40 +0100497/* Mbed TLS doesn't support non-byte-aligned key sizes (i.e. key sizes
498 * that are not a multiple of 8) well. For example, there is only
499 * mbedtls_rsa_get_len(), which returns a number of bytes, and no
500 * way to return the exact bit size of a key.
501 * To keep things simple, reject non-byte-aligned key sizes. */
502static psa_status_t psa_check_rsa_key_byte_aligned(
503 const mbedtls_rsa_context *rsa )
504{
505 mbedtls_mpi n;
506 psa_status_t status;
507 mbedtls_mpi_init( &n );
508 status = mbedtls_to_psa_error(
509 mbedtls_rsa_export( rsa, &n, NULL, NULL, NULL, NULL ) );
510 if( status == PSA_SUCCESS )
511 {
512 if( mbedtls_mpi_bitlen( &n ) % 8 != 0 )
513 status = PSA_ERROR_NOT_SUPPORTED;
514 }
515 mbedtls_mpi_free( &n );
516 return( status );
517}
Steven Cooremana01795d2020-07-24 22:48:15 +0200518#endif /* MBEDTLS_PK_PARSE_C */
Gilles Peskine86a440b2018-11-12 18:39:40 +0100519
Steven Cooreman7f391872020-07-30 14:57:44 +0200520/** Load the contents of a key buffer into an internal RSA representation
Steven Cooremana01795d2020-07-24 22:48:15 +0200521 *
Steven Cooreman4fed4552020-08-03 14:46:03 +0200522 * \param[in] type The type of key contained in \p data.
523 * \param[in] data The buffer from which to load the representation.
524 * \param[in] data_length The size in bytes of \p data.
525 * \param[out] p_rsa Returns a pointer to an RSA context on success.
526 * The caller is responsible for freeing both the
527 * contents of the context and the context itself
528 * when done.
Steven Cooremana01795d2020-07-24 22:48:15 +0200529 */
Steven Cooreman4fed4552020-08-03 14:46:03 +0200530static psa_status_t psa_load_rsa_representation( psa_key_type_t type,
531 const uint8_t *data,
532 size_t data_length,
Steven Cooremana2371e52020-07-28 14:30:39 +0200533 mbedtls_rsa_context **p_rsa )
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200534{
Steven Cooremana01795d2020-07-24 22:48:15 +0200535#if defined(MBEDTLS_PK_PARSE_C)
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000536 psa_status_t status;
Steven Cooremana01795d2020-07-24 22:48:15 +0200537 mbedtls_pk_context ctx;
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000538 size_t bits;
Steven Cooremana01795d2020-07-24 22:48:15 +0200539 mbedtls_pk_init( &ctx );
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000540
541 /* Parse the data. */
Steven Cooreman7f391872020-07-30 14:57:44 +0200542 if( PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000543 status = mbedtls_to_psa_error(
Steven Cooreman4fed4552020-08-03 14:46:03 +0200544 mbedtls_pk_parse_key( &ctx, data, data_length, NULL, 0 ) );
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200545 else
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000546 status = mbedtls_to_psa_error(
Steven Cooreman4fed4552020-08-03 14:46:03 +0200547 mbedtls_pk_parse_public_key( &ctx, data, data_length ) );
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000548 if( status != PSA_SUCCESS )
549 goto exit;
550
551 /* We have something that the pkparse module recognizes. If it is a
552 * valid RSA key, store it. */
Steven Cooremana01795d2020-07-24 22:48:15 +0200553 if( mbedtls_pk_get_type( &ctx ) != MBEDTLS_PK_RSA )
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200554 {
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000555 status = PSA_ERROR_INVALID_ARGUMENT;
556 goto exit;
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200557 }
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000558
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000559 /* The size of an RSA key doesn't have to be a multiple of 8. Mbed TLS
560 * supports non-byte-aligned key sizes, but not well. For example,
561 * mbedtls_rsa_get_len() returns the key size in bytes, not in bits. */
Steven Cooremana01795d2020-07-24 22:48:15 +0200562 bits = PSA_BYTES_TO_BITS( mbedtls_rsa_get_len( mbedtls_pk_rsa( ctx ) ) );
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000563 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
564 {
565 status = PSA_ERROR_NOT_SUPPORTED;
566 goto exit;
567 }
Steven Cooremana01795d2020-07-24 22:48:15 +0200568 status = psa_check_rsa_key_byte_aligned( mbedtls_pk_rsa( ctx ) );
Steven Cooremana01795d2020-07-24 22:48:15 +0200569 if( status != PSA_SUCCESS )
570 goto exit;
571
Steven Cooremana2371e52020-07-28 14:30:39 +0200572 /* Copy out the pointer to the RSA context, and reset the PK context
573 * such that pk_free doesn't free the RSA context we just grabbed. */
574 *p_rsa = mbedtls_pk_rsa( ctx );
575 ctx.pk_info = NULL;
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000576
577exit:
Steven Cooremana01795d2020-07-24 22:48:15 +0200578 mbedtls_pk_free( &ctx );
579 return( status );
580#else
Steven Cooreman4fed4552020-08-03 14:46:03 +0200581 (void) data;
582 (void) data_length;
Steven Cooreman7f391872020-07-30 14:57:44 +0200583 (void) type;
Steven Cooremana01795d2020-07-24 22:48:15 +0200584 (void) rsa;
585 return( PSA_ERROR_NOT_SUPPORTED );
586#endif /* MBEDTLS_PK_PARSE_C */
587}
588
589/** Export an RSA key to export representation
590 *
591 * \param[in] type The type of key (public/private) to export
592 * \param[in] rsa The internal RSA representation from which to export
593 * \param[out] data The buffer to export to
594 * \param[in] data_size The length of the buffer to export to
595 * \param[out] data_length The amount of bytes written to \p data
596 */
597static psa_status_t psa_export_rsa_key( psa_key_type_t type,
598 mbedtls_rsa_context *rsa,
599 uint8_t *data,
600 size_t data_size,
601 size_t *data_length )
602{
603#if defined(MBEDTLS_PK_WRITE_C)
604 int ret;
605 mbedtls_pk_context pk;
606 uint8_t *pos = data + data_size;
607
608 mbedtls_pk_init( &pk );
609 pk.pk_info = &mbedtls_rsa_info;
610 pk.pk_ctx = rsa;
611
612 /* PSA Crypto API defines the format of an RSA key as a DER-encoded
Steven Cooreman75b74362020-07-28 14:30:13 +0200613 * representation of the non-encrypted PKCS#1 RSAPrivateKey for a
614 * private key and of the RFC3279 RSAPublicKey for a public key. */
Steven Cooremana01795d2020-07-24 22:48:15 +0200615 if( PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
616 ret = mbedtls_pk_write_key_der( &pk, data, data_size );
617 else
618 ret = mbedtls_pk_write_pubkey( &pos, data, &pk );
619
620 if( ret < 0 )
Steven Cooreman4fed4552020-08-03 14:46:03 +0200621 {
622 /* Clean up in case pk_write failed halfway through. */
623 memset( data, 0, data_size );
Steven Cooreman29149862020-08-05 15:43:42 +0200624 return( mbedtls_to_psa_error( ret ) );
Steven Cooreman4fed4552020-08-03 14:46:03 +0200625 }
Steven Cooremana01795d2020-07-24 22:48:15 +0200626
627 /* The mbedtls_pk_xxx functions write to the end of the buffer.
628 * Move the data to the beginning and erase remaining data
629 * at the original location. */
630 if( 2 * (size_t) ret <= data_size )
631 {
632 memcpy( data, data + data_size - ret, ret );
633 memset( data + data_size - ret, 0, ret );
634 }
635 else if( (size_t) ret < data_size )
636 {
637 memmove( data, data + data_size - ret, ret );
638 memset( data + ret, 0, data_size - ret );
639 }
640
641 *data_length = ret;
642 return( PSA_SUCCESS );
643#else
644 (void) type;
645 (void) rsa;
646 (void) data;
647 (void) data_size;
648 (void) data_length;
649 return( PSA_ERROR_NOT_SUPPORTED );
650#endif /* MBEDTLS_PK_WRITE_C */
651}
652
653/** Import an RSA key from import representation to a slot
654 *
655 * \param[in,out] slot The slot where to store the export representation to
656 * \param[in] data The buffer containing the import representation
657 * \param[in] data_length The amount of bytes in \p data
658 */
659static psa_status_t psa_import_rsa_key( psa_key_slot_t *slot,
660 const uint8_t *data,
661 size_t data_length )
662{
663 psa_status_t status;
664 uint8_t* output = NULL;
Steven Cooremana2371e52020-07-28 14:30:39 +0200665 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +0200666
Steven Cooremana01795d2020-07-24 22:48:15 +0200667 /* Parse input */
Steven Cooreman4fed4552020-08-03 14:46:03 +0200668 status = psa_load_rsa_representation( slot->attr.type,
669 data,
Steven Cooreman7f391872020-07-30 14:57:44 +0200670 data_length,
Steven Cooreman7f391872020-07-30 14:57:44 +0200671 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +0200672 if( status != PSA_SUCCESS )
673 goto exit;
674
675 slot->attr.bits = (psa_key_bits_t) PSA_BYTES_TO_BITS(
Steven Cooremana2371e52020-07-28 14:30:39 +0200676 mbedtls_rsa_get_len( rsa ) );
Steven Cooremana01795d2020-07-24 22:48:15 +0200677
Steven Cooreman75b74362020-07-28 14:30:13 +0200678 /* Re-export the data to PSA export format, such that we can store export
679 * representation in the key slot. Export representation in case of RSA is
680 * the smallest representation that's allowed as input, so a straight-up
681 * allocation of the same size as the input buffer will be large enough. */
Steven Cooremana01795d2020-07-24 22:48:15 +0200682 output = mbedtls_calloc( 1, data_length );
Steven Cooremana01795d2020-07-24 22:48:15 +0200683 if( output == NULL )
684 {
685 status = PSA_ERROR_INSUFFICIENT_MEMORY;
686 goto exit;
687 }
688
Steven Cooremana01795d2020-07-24 22:48:15 +0200689 status = psa_export_rsa_key( slot->attr.type,
Steven Cooremana2371e52020-07-28 14:30:39 +0200690 rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +0200691 output,
692 data_length,
693 &data_length);
Steven Cooremana01795d2020-07-24 22:48:15 +0200694exit:
695 /* Always free the RSA object */
Steven Cooremana2371e52020-07-28 14:30:39 +0200696 mbedtls_rsa_free( rsa );
Steven Cooreman6d839f02020-07-30 11:36:45 +0200697 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +0200698
699 /* Free the allocated buffer only on error. */
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000700 if( status != PSA_SUCCESS )
701 {
Steven Cooremana01795d2020-07-24 22:48:15 +0200702 mbedtls_free( output );
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000703 return( status );
704 }
705
Steven Cooremana01795d2020-07-24 22:48:15 +0200706 /* On success, store the allocated export-formatted key. */
707 slot->data.key.data = output;
708 slot->data.key.bytes = data_length;
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000709
710 return( PSA_SUCCESS );
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200711}
Steven Cooremana01795d2020-07-24 22:48:15 +0200712#endif /* defined(MBEDTLS_RSA_C) */
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200713
Jaeden Ameroccdce902019-01-10 11:42:27 +0000714#if defined(MBEDTLS_ECP_C)
Steven Cooreman7f391872020-07-30 14:57:44 +0200715/** Load the contents of a key buffer into an internal ECP representation
Steven Cooremana2371e52020-07-28 14:30:39 +0200716 *
Steven Cooreman4fed4552020-08-03 14:46:03 +0200717 * \param[in] type The type of key contained in \p data.
718 * \param[in] data The buffer from which to load the representation.
719 * \param[in] data_length The size in bytes of \p data.
720 * \param[out] p_ecp Returns a pointer to an ECP context on success.
721 * The caller is responsible for freeing both the
722 * contents of the context and the context itself
723 * when done.
Steven Cooremana2371e52020-07-28 14:30:39 +0200724 */
Steven Cooreman4fed4552020-08-03 14:46:03 +0200725static psa_status_t psa_load_ecp_representation( psa_key_type_t type,
726 const uint8_t *data,
727 size_t data_length,
Steven Cooremana2371e52020-07-28 14:30:39 +0200728 mbedtls_ecp_keypair **p_ecp )
Gilles Peskine4cd32772019-12-02 20:49:42 +0100729{
730 mbedtls_ecp_group_id grp_id = MBEDTLS_ECP_DP_NONE;
Steven Cooremanacda8342020-07-24 23:09:52 +0200731 psa_status_t status;
Steven Cooreman6d839f02020-07-30 11:36:45 +0200732 mbedtls_ecp_keypair *ecp = NULL;
Steven Cooreman4fed4552020-08-03 14:46:03 +0200733 size_t curve_size = data_length;
Gilles Peskine4cd32772019-12-02 20:49:42 +0100734
Steven Cooreman4fed4552020-08-03 14:46:03 +0200735 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) &&
736 PSA_KEY_TYPE_ECC_GET_FAMILY( type ) != PSA_ECC_FAMILY_MONTGOMERY )
Gilles Peskine4295e8b2019-12-02 21:39:10 +0100737 {
Steven Cooreman4fed4552020-08-03 14:46:03 +0200738 /* A Weierstrass public key is represented as:
739 * - The byte 0x04;
740 * - `x_P` as a `ceiling(m/8)`-byte string, big-endian;
741 * - `y_P` as a `ceiling(m/8)`-byte string, big-endian.
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200742 * So its data length is 2m+1 where m is the curve size in bits.
Steven Cooreman4fed4552020-08-03 14:46:03 +0200743 */
744 if( ( data_length & 1 ) == 0 )
745 return( PSA_ERROR_INVALID_ARGUMENT );
746 curve_size = data_length / 2;
747
748 /* Montgomery public keys are represented in compressed format, meaning
749 * their curve_size is equal to the amount of input. */
750
751 /* Private keys are represented in uncompressed private random integer
752 * format, meaning their curve_size is equal to the amount of input. */
Gilles Peskine4295e8b2019-12-02 21:39:10 +0100753 }
754
Steven Cooreman6d839f02020-07-30 11:36:45 +0200755 /* Allocate and initialize a key representation. */
Steven Cooreman29149862020-08-05 15:43:42 +0200756 ecp = mbedtls_calloc( 1, sizeof( mbedtls_ecp_keypair ) );
Steven Cooreman6d839f02020-07-30 11:36:45 +0200757 if( ecp == NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200758 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Steven Cooremana2371e52020-07-28 14:30:39 +0200759 mbedtls_ecp_keypair_init( ecp );
760
Gilles Peskine4cd32772019-12-02 20:49:42 +0100761 /* Load the group. */
Steven Cooreman7f391872020-07-30 14:57:44 +0200762 grp_id = mbedtls_ecc_group_of_psa( PSA_KEY_TYPE_ECC_GET_FAMILY( type ),
763 curve_size );
Gilles Peskine4295e8b2019-12-02 21:39:10 +0100764 if( grp_id == MBEDTLS_ECP_DP_NONE )
Steven Cooreman6d839f02020-07-30 11:36:45 +0200765 {
766 status = PSA_ERROR_INVALID_ARGUMENT;
767 goto exit;
768 }
769
Steven Cooremanacda8342020-07-24 23:09:52 +0200770 status = mbedtls_to_psa_error(
771 mbedtls_ecp_group_load( &ecp->grp, grp_id ) );
772 if( status != PSA_SUCCESS )
Steven Cooreman6d839f02020-07-30 11:36:45 +0200773 goto exit;
Steven Cooremanacda8342020-07-24 23:09:52 +0200774
Steven Cooreman6d839f02020-07-30 11:36:45 +0200775 /* Load the key material. */
Steven Cooreman7f391872020-07-30 14:57:44 +0200776 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) )
Steven Cooremanacda8342020-07-24 23:09:52 +0200777 {
778 /* Load the public value. */
779 status = mbedtls_to_psa_error(
780 mbedtls_ecp_point_read_binary( &ecp->grp, &ecp->Q,
Steven Cooreman4fed4552020-08-03 14:46:03 +0200781 data,
782 data_length ) );
Steven Cooremanacda8342020-07-24 23:09:52 +0200783 if( status != PSA_SUCCESS )
784 goto exit;
785
786 /* Check that the point is on the curve. */
787 status = mbedtls_to_psa_error(
788 mbedtls_ecp_check_pubkey( &ecp->grp, &ecp->Q ) );
789 if( status != PSA_SUCCESS )
790 goto exit;
791 }
792 else
793 {
Steven Cooreman6d839f02020-07-30 11:36:45 +0200794 /* Load and validate the secret value. */
Steven Cooremanacda8342020-07-24 23:09:52 +0200795 status = mbedtls_to_psa_error(
796 mbedtls_ecp_read_key( ecp->grp.id,
797 ecp,
Steven Cooreman4fed4552020-08-03 14:46:03 +0200798 data,
799 data_length ) );
Steven Cooremanacda8342020-07-24 23:09:52 +0200800 if( status != PSA_SUCCESS )
801 goto exit;
Steven Cooremanacda8342020-07-24 23:09:52 +0200802 }
Steven Cooremana2371e52020-07-28 14:30:39 +0200803
804 *p_ecp = ecp;
Steven Cooremanacda8342020-07-24 23:09:52 +0200805exit:
806 if( status != PSA_SUCCESS )
Steven Cooremana2371e52020-07-28 14:30:39 +0200807 {
Steven Cooremanacda8342020-07-24 23:09:52 +0200808 mbedtls_ecp_keypair_free( ecp );
Steven Cooremana2371e52020-07-28 14:30:39 +0200809 mbedtls_free( ecp );
810 }
811
Steven Cooreman29149862020-08-05 15:43:42 +0200812 return( status );
Gilles Peskine4cd32772019-12-02 20:49:42 +0100813}
Jaeden Ameroccdce902019-01-10 11:42:27 +0000814
Steven Cooreman4fed4552020-08-03 14:46:03 +0200815/** Export an ECP key to export representation
816 *
817 * \param[in] type The type of key (public/private) to export
818 * \param[in] ecp The internal ECP representation from which to export
819 * \param[out] data The buffer to export to
820 * \param[in] data_size The length of the buffer to export to
821 * \param[out] data_length The amount of bytes written to \p data
822 */
Steven Cooremanacda8342020-07-24 23:09:52 +0200823static psa_status_t psa_export_ecp_key( psa_key_type_t type,
824 mbedtls_ecp_keypair *ecp,
825 uint8_t *data,
826 size_t data_size,
827 size_t *data_length )
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200828{
Steven Cooremanacda8342020-07-24 23:09:52 +0200829 psa_status_t status;
Jaeden Ameroccdce902019-01-10 11:42:27 +0000830
Steven Cooremanacda8342020-07-24 23:09:52 +0200831 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) )
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200832 {
Steven Cooremanacda8342020-07-24 23:09:52 +0200833 /* Check whether the public part is loaded */
834 if( mbedtls_ecp_is_zero( &ecp->Q ) )
835 {
836 /* Calculate the public key */
837 status = mbedtls_to_psa_error(
838 mbedtls_ecp_mul( &ecp->grp, &ecp->Q, &ecp->d, &ecp->grp.G,
839 mbedtls_ctr_drbg_random, &global_data.ctr_drbg ) );
840 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +0200841 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +0200842 }
843
Steven Cooreman4fed4552020-08-03 14:46:03 +0200844 status = mbedtls_to_psa_error(
Steven Cooremanacda8342020-07-24 23:09:52 +0200845 mbedtls_ecp_point_write_binary( &ecp->grp, &ecp->Q,
846 MBEDTLS_ECP_PF_UNCOMPRESSED,
847 data_length,
848 data,
Steven Cooreman4fed4552020-08-03 14:46:03 +0200849 data_size ) );
Steven Cooreman4fed4552020-08-03 14:46:03 +0200850 if( status != PSA_SUCCESS )
851 memset( data, 0, data_size );
852
Steven Cooreman29149862020-08-05 15:43:42 +0200853 return( status );
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200854 }
Steven Cooremanacda8342020-07-24 23:09:52 +0200855 else
856 {
Steven Cooreman29149862020-08-05 15:43:42 +0200857 if( data_size < PSA_BITS_TO_BYTES( ecp->grp.nbits ) )
Steven Cooremanacda8342020-07-24 23:09:52 +0200858 return( PSA_ERROR_BUFFER_TOO_SMALL );
859
860 status = mbedtls_to_psa_error(
861 mbedtls_ecp_write_key( ecp,
862 data,
Steven Cooreman29149862020-08-05 15:43:42 +0200863 PSA_BITS_TO_BYTES( ecp->grp.nbits ) ) );
Steven Cooremanacda8342020-07-24 23:09:52 +0200864 if( status == PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +0200865 *data_length = PSA_BITS_TO_BYTES( ecp->grp.nbits );
Steven Cooremanb7f6dea2020-08-05 16:07:20 +0200866 else
867 memset( data, 0, data_size );
Steven Cooremanacda8342020-07-24 23:09:52 +0200868
869 return( status );
870 }
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200871}
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200872
Steven Cooreman4fed4552020-08-03 14:46:03 +0200873/** Import an ECP key from import representation to a slot
874 *
875 * \param[in,out] slot The slot where to store the export representation to
876 * \param[in] data The buffer containing the import representation
877 * \param[in] data_length The amount of bytes in \p data
878 */
Steven Cooremanacda8342020-07-24 23:09:52 +0200879static psa_status_t psa_import_ecp_key( psa_key_slot_t *slot,
880 const uint8_t *data,
881 size_t data_length )
Gilles Peskinef76aa772018-10-29 19:24:33 +0100882{
Steven Cooremanacda8342020-07-24 23:09:52 +0200883 psa_status_t status;
884 uint8_t* output = NULL;
Steven Cooremana2371e52020-07-28 14:30:39 +0200885 mbedtls_ecp_keypair *ecp = NULL;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100886
Steven Cooremanacda8342020-07-24 23:09:52 +0200887 /* Parse input */
Steven Cooreman4fed4552020-08-03 14:46:03 +0200888 status = psa_load_ecp_representation( slot->attr.type,
889 data,
Steven Cooreman7f391872020-07-30 14:57:44 +0200890 data_length,
Steven Cooreman7f391872020-07-30 14:57:44 +0200891 &ecp );
Gilles Peskinef76aa772018-10-29 19:24:33 +0100892 if( status != PSA_SUCCESS )
893 goto exit;
Gilles Peskine4cd32772019-12-02 20:49:42 +0100894
Steven Cooremanacda8342020-07-24 23:09:52 +0200895 if( PSA_KEY_TYPE_ECC_GET_FAMILY( slot->attr.type ) == PSA_ECC_FAMILY_MONTGOMERY)
Steven Cooremana2371e52020-07-28 14:30:39 +0200896 slot->attr.bits = (psa_key_bits_t) ecp->grp.nbits + 1;
Steven Cooremanacda8342020-07-24 23:09:52 +0200897 else
Steven Cooremana2371e52020-07-28 14:30:39 +0200898 slot->attr.bits = (psa_key_bits_t) ecp->grp.nbits;
Steven Cooremane3fd3922020-06-11 16:50:36 +0200899
Steven Cooremanacda8342020-07-24 23:09:52 +0200900 /* Re-export the data to PSA export format. There is currently no support
901 * for other input formats then the export format, so this is a 1-1
902 * copy operation. */
903 output = mbedtls_calloc( 1, data_length );
Steven Cooremanacda8342020-07-24 23:09:52 +0200904 if( output == NULL )
905 {
906 status = PSA_ERROR_INSUFFICIENT_MEMORY;
907 goto exit;
908 }
909
910 status = psa_export_ecp_key( slot->attr.type,
Steven Cooremana2371e52020-07-28 14:30:39 +0200911 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +0200912 output,
913 data_length,
914 &data_length);
Gilles Peskinef76aa772018-10-29 19:24:33 +0100915exit:
Steven Cooremana2371e52020-07-28 14:30:39 +0200916 /* Always free the PK object (will also free contained ECP context) */
917 mbedtls_ecp_keypair_free( ecp );
Steven Cooreman6d839f02020-07-30 11:36:45 +0200918 mbedtls_free( ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +0200919
920 /* Free the allocated buffer only on error. */
921 if( status != PSA_SUCCESS )
Gilles Peskinef76aa772018-10-29 19:24:33 +0100922 {
Steven Cooremanacda8342020-07-24 23:09:52 +0200923 mbedtls_free( output );
Steven Cooremanacda8342020-07-24 23:09:52 +0200924 return( status );
Gilles Peskinef76aa772018-10-29 19:24:33 +0100925 }
Steven Cooremanacda8342020-07-24 23:09:52 +0200926
927 /* On success, store the allocated export-formatted key. */
928 slot->data.key.data = output;
929 slot->data.key.bytes = data_length;
930
931 return( PSA_SUCCESS );
Gilles Peskinef76aa772018-10-29 19:24:33 +0100932}
933#endif /* defined(MBEDTLS_ECP_C) */
934
Gilles Peskineb46bef22019-07-30 21:32:04 +0200935/** Return the size of the key in the given slot, in bits.
936 *
937 * \param[in] slot A key slot.
938 *
939 * \return The key size in bits, read from the metadata in the slot.
940 */
941static inline size_t psa_get_key_slot_bits( const psa_key_slot_t *slot )
942{
943 return( slot->attr.bits );
944}
945
Steven Cooreman75b74362020-07-28 14:30:13 +0200946/** Try to allocate a buffer to an empty key slot.
947 *
948 * \param[in,out] slot Key slot to attach buffer to.
949 * \param[in] buffer_length Requested size of the buffer.
950 *
951 * \retval #PSA_SUCCESS
952 * The buffer has been successfully allocated.
953 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
954 * Not enough memory was available for allocation.
955 * \retval #PSA_ERROR_ALREADY_EXISTS
956 * Trying to allocate a buffer to a non-empty key slot.
957 */
958static psa_status_t psa_allocate_buffer_to_slot( psa_key_slot_t *slot,
959 size_t buffer_length )
960{
961 if( slot->data.key.data != NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200962 return( PSA_ERROR_ALREADY_EXISTS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200963
964 slot->data.key.data = mbedtls_calloc( 1, buffer_length );
965 if( slot->data.key.data == NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200966 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Steven Cooreman75b74362020-07-28 14:30:13 +0200967
968 slot->data.key.bytes = buffer_length;
Steven Cooreman29149862020-08-05 15:43:42 +0200969 return( PSA_SUCCESS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200970}
971
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200972psa_status_t psa_copy_key_material_into_slot( psa_key_slot_t *slot,
973 const uint8_t* data,
974 size_t data_length )
975{
976 psa_status_t status = psa_allocate_buffer_to_slot( slot,
977 data_length );
978 if( status != PSA_SUCCESS )
979 return( status );
980
981 memcpy( slot->data.key.data, data, data_length );
982 return( PSA_SUCCESS );
983}
984
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200985/** Import key data into a slot.
986 *
987 * `slot->type` must have been set previously.
988 * This function assumes that the slot does not contain any key material yet.
989 * On failure, the slot content is unchanged.
990 *
991 * Persistent storage is not affected.
992 *
993 * \param[in,out] slot The key slot to import data into.
994 * Its `type` field must have previously been set to
995 * the desired key type.
996 * It must not contain any key material yet.
997 * \param[in] data Buffer containing the key material to parse and import.
998 * \param data_length Size of \p data in bytes.
999 *
1000 * \retval #PSA_SUCCESS
1001 * \retval #PSA_ERROR_INVALID_ARGUMENT
1002 * \retval #PSA_ERROR_NOT_SUPPORTED
1003 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
1004 */
1005static psa_status_t psa_import_key_into_slot( psa_key_slot_t *slot,
1006 const uint8_t *data,
1007 size_t data_length )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001008{
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001009 psa_status_t status = PSA_SUCCESS;
Steven Cooreman04524762020-10-13 17:43:44 +02001010 size_t bit_size;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001011
Steven Cooreman81be2fa2020-07-24 22:04:59 +02001012 /* zero-length keys are never supported. */
1013 if( data_length == 0 )
1014 return( PSA_ERROR_NOT_SUPPORTED );
1015
Gilles Peskine8e338702019-07-30 20:06:31 +02001016 if( key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001017 {
Steven Cooreman04524762020-10-13 17:43:44 +02001018 bit_size = PSA_BYTES_TO_BITS( data_length );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02001019
Steven Cooreman75b74362020-07-28 14:30:13 +02001020 /* Ensure that the bytes-to-bits conversion hasn't overflown. */
1021 if( data_length > SIZE_MAX / 8 )
1022 return( PSA_ERROR_NOT_SUPPORTED );
1023
Gilles Peskine1b9505c2019-08-07 10:59:45 +02001024 /* Enforce a size limit, and in particular ensure that the bit
1025 * size fits in its representation type. */
Gilles Peskinec744d992019-07-30 17:26:54 +02001026 if( bit_size > PSA_MAX_KEY_BITS )
1027 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02001028
1029 status = validate_unstructured_key_bit_size( slot->attr.type, bit_size );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +02001030 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001031 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02001032
1033 /* Allocate memory for the key */
Steven Cooremanf7cebd42020-10-13 20:27:40 +02001034 status = psa_copy_key_material_into_slot( slot, data, data_length );
Steven Cooreman75b74362020-07-28 14:30:13 +02001035 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001036 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02001037
Steven Cooreman81be2fa2020-07-24 22:04:59 +02001038 /* Write the actual key size to the slot.
1039 * psa_start_key_creation() wrote the size declared by the
1040 * caller, which may be 0 (meaning unspecified) or wrong. */
1041 slot->attr.bits = (psa_key_bits_t) bit_size;
Steven Cooreman40120f62020-10-29 11:42:22 +01001042
1043 return( PSA_SUCCESS );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001044 }
Steven Cooreman3ea0ce42020-10-23 11:37:05 +02001045 else if( PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
Steven Cooreman19fd5742020-07-24 23:31:01 +02001046 {
Steven Cooreman3ea0ce42020-10-23 11:37:05 +02001047 /* Try validation through accelerators first. */
1048 bit_size = slot->attr.bits;
1049 psa_key_attributes_t attributes = {
1050 .core = slot->attr
1051 };
1052 status = psa_driver_wrapper_validate_key( &attributes,
1053 data,
1054 data_length,
1055 &bit_size );
1056 if( status == PSA_SUCCESS )
1057 {
1058 /* Key has been validated successfully by an accelerator.
1059 * Copy key material into slot. */
1060 status = psa_copy_key_material_into_slot( slot, data, data_length );
1061 if( status != PSA_SUCCESS )
1062 return( status );
1063
1064 slot->attr.bits = (psa_key_bits_t) bit_size;
1065 return( PSA_SUCCESS );
1066 }
1067 else if( status != PSA_ERROR_NOT_SUPPORTED )
1068 return( status );
1069
1070 /* Key format is not supported by any accelerator, try software fallback
1071 * if present. */
Gilles Peskinef76aa772018-10-29 19:24:33 +01001072#if defined(MBEDTLS_ECP_C)
Steven Cooreman3ea0ce42020-10-23 11:37:05 +02001073 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
1074 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001075 return( psa_import_ecp_key( slot, data, data_length ) );
1076 }
Steven Cooreman19fd5742020-07-24 23:31:01 +02001077#endif /* defined(MBEDTLS_ECP_C) */
Steven Cooreman19fd5742020-07-24 23:31:01 +02001078#if defined(MBEDTLS_RSA_C)
Steven Cooreman40120f62020-10-29 11:42:22 +01001079 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +02001080 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001081 return( psa_import_rsa_key( slot, data, data_length ) );
Steven Cooreman3ea0ce42020-10-23 11:37:05 +02001082 }
Steven Cooreman19fd5742020-07-24 23:31:01 +02001083#endif /* defined(MBEDTLS_RSA_C) */
Steven Cooreman40120f62020-10-29 11:42:22 +01001084
1085 /* Fell through the fallback as well, so have nothing else to try. */
1086 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001087 }
1088 else
Gilles Peskinec66ea6a2018-02-03 22:43:28 +01001089 {
Steven Cooreman19fd5742020-07-24 23:31:01 +02001090 /* Unknown key type */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001091 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969ac722018-01-28 18:16:59 +01001092 }
Darryl Green06fd18d2018-07-16 11:21:11 +01001093}
1094
Gilles Peskinef603c712019-01-19 13:40:11 +01001095/** Calculate the intersection of two algorithm usage policies.
1096 *
1097 * Return 0 (which allows no operation) on incompatibility.
1098 */
1099static psa_algorithm_t psa_key_policy_algorithm_intersection(
1100 psa_algorithm_t alg1,
1101 psa_algorithm_t alg2 )
1102{
Gilles Peskine549ea862019-05-22 11:45:59 +02001103 /* Common case: both sides actually specify the same policy. */
Gilles Peskinef603c712019-01-19 13:40:11 +01001104 if( alg1 == alg2 )
1105 return( alg1 );
1106 /* If the policies are from the same hash-and-sign family, check
1107 * if one is a wildcard. If so the other has the specific algorithm. */
1108 if( PSA_ALG_IS_HASH_AND_SIGN( alg1 ) &&
1109 PSA_ALG_IS_HASH_AND_SIGN( alg2 ) &&
1110 ( alg1 & ~PSA_ALG_HASH_MASK ) == ( alg2 & ~PSA_ALG_HASH_MASK ) )
1111 {
1112 if( PSA_ALG_SIGN_GET_HASH( alg1 ) == PSA_ALG_ANY_HASH )
1113 return( alg2 );
1114 if( PSA_ALG_SIGN_GET_HASH( alg2 ) == PSA_ALG_ANY_HASH )
1115 return( alg1 );
1116 }
1117 /* If the policies are incompatible, allow nothing. */
1118 return( 0 );
1119}
1120
Gilles Peskined6f371b2019-05-10 19:33:38 +02001121static int psa_key_algorithm_permits( psa_algorithm_t policy_alg,
1122 psa_algorithm_t requested_alg )
1123{
Gilles Peskine549ea862019-05-22 11:45:59 +02001124 /* Common case: the policy only allows requested_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +02001125 if( requested_alg == policy_alg )
1126 return( 1 );
1127 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
Gilles Peskine549ea862019-05-22 11:45:59 +02001128 * and requested_alg is the same hash-and-sign family with any hash,
1129 * then requested_alg is compliant with policy_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +02001130 if( PSA_ALG_IS_HASH_AND_SIGN( requested_alg ) &&
1131 PSA_ALG_SIGN_GET_HASH( policy_alg ) == PSA_ALG_ANY_HASH )
1132 {
1133 return( ( policy_alg & ~PSA_ALG_HASH_MASK ) ==
1134 ( requested_alg & ~PSA_ALG_HASH_MASK ) );
1135 }
Steven Cooremance48e852020-10-05 16:02:45 +02001136 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +02001137 * a key derivation with that key agreement should also be allowed. This
1138 * behaviour is expected to be defined in a future specification version. */
Steven Cooremance48e852020-10-05 16:02:45 +02001139 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( policy_alg ) &&
1140 PSA_ALG_IS_KEY_AGREEMENT( requested_alg ) )
1141 {
1142 return( PSA_ALG_KEY_AGREEMENT_GET_BASE( requested_alg ) ==
1143 policy_alg );
1144 }
Gilles Peskined6f371b2019-05-10 19:33:38 +02001145 /* If it isn't permitted, it's forbidden. */
1146 return( 0 );
1147}
1148
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001149/** Test whether a policy permits an algorithm.
1150 *
1151 * The caller must test usage flags separately.
1152 */
1153static int psa_key_policy_permits( const psa_key_policy_t *policy,
1154 psa_algorithm_t alg )
1155{
Gilles Peskined6f371b2019-05-10 19:33:38 +02001156 return( psa_key_algorithm_permits( policy->alg, alg ) ||
1157 psa_key_algorithm_permits( policy->alg2, alg ) );
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001158}
1159
Gilles Peskinef603c712019-01-19 13:40:11 +01001160/** Restrict a key policy based on a constraint.
1161 *
1162 * \param[in,out] policy The policy to restrict.
1163 * \param[in] constraint The policy constraint to apply.
1164 *
1165 * \retval #PSA_SUCCESS
1166 * \c *policy contains the intersection of the original value of
1167 * \c *policy and \c *constraint.
1168 * \retval #PSA_ERROR_INVALID_ARGUMENT
1169 * \c *policy and \c *constraint are incompatible.
1170 * \c *policy is unchanged.
1171 */
1172static psa_status_t psa_restrict_key_policy(
1173 psa_key_policy_t *policy,
1174 const psa_key_policy_t *constraint )
1175{
1176 psa_algorithm_t intersection_alg =
1177 psa_key_policy_algorithm_intersection( policy->alg, constraint->alg );
Gilles Peskined6f371b2019-05-10 19:33:38 +02001178 psa_algorithm_t intersection_alg2 =
1179 psa_key_policy_algorithm_intersection( policy->alg2, constraint->alg2 );
Gilles Peskinef603c712019-01-19 13:40:11 +01001180 if( intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0 )
1181 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskined6f371b2019-05-10 19:33:38 +02001182 if( intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0 )
1183 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinef603c712019-01-19 13:40:11 +01001184 policy->usage &= constraint->usage;
1185 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +02001186 policy->alg2 = intersection_alg2;
Gilles Peskinef603c712019-01-19 13:40:11 +01001187 return( PSA_SUCCESS );
1188}
1189
Darryl Green06fd18d2018-07-16 11:21:11 +01001190/** Retrieve a slot which must contain a key. The key must have allow all the
1191 * usage flags set in \p usage. If \p alg is nonzero, the key must allow
1192 * operations with this algorithm. */
Gilles Peskinec5487a82018-12-03 18:08:14 +01001193static psa_status_t psa_get_key_from_slot( psa_key_handle_t handle,
Gilles Peskine2f060a82018-12-04 17:12:32 +01001194 psa_key_slot_t **p_slot,
Darryl Green06fd18d2018-07-16 11:21:11 +01001195 psa_key_usage_t usage,
1196 psa_algorithm_t alg )
1197{
1198 psa_status_t status;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001199 psa_key_slot_t *slot = NULL;
Darryl Green06fd18d2018-07-16 11:21:11 +01001200
1201 *p_slot = NULL;
1202
Gilles Peskinec5487a82018-12-03 18:08:14 +01001203 status = psa_get_key_slot( handle, &slot );
Darryl Green06fd18d2018-07-16 11:21:11 +01001204 if( status != PSA_SUCCESS )
1205 return( status );
Darryl Green06fd18d2018-07-16 11:21:11 +01001206
1207 /* Enforce that usage policy for the key slot contains all the flags
1208 * required by the usage parameter. There is one exception: public
1209 * keys can always be exported, so we treat public key objects as
1210 * if they had the export flag. */
Gilles Peskine8e338702019-07-30 20:06:31 +02001211 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Darryl Green06fd18d2018-07-16 11:21:11 +01001212 usage &= ~PSA_KEY_USAGE_EXPORT;
Gilles Peskine8e338702019-07-30 20:06:31 +02001213 if( ( slot->attr.policy.usage & usage ) != usage )
Darryl Green06fd18d2018-07-16 11:21:11 +01001214 return( PSA_ERROR_NOT_PERMITTED );
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001215
1216 /* Enforce that the usage policy permits the requested algortihm. */
Gilles Peskine8e338702019-07-30 20:06:31 +02001217 if( alg != 0 && ! psa_key_policy_permits( &slot->attr.policy, alg ) )
Darryl Green06fd18d2018-07-16 11:21:11 +01001218 return( PSA_ERROR_NOT_PERMITTED );
1219
1220 *p_slot = slot;
1221 return( PSA_SUCCESS );
1222}
Darryl Green940d72c2018-07-13 13:18:51 +01001223
Gilles Peskine28f8f302019-07-24 13:30:31 +02001224/** Retrieve a slot which must contain a transparent key.
1225 *
1226 * A transparent key is a key for which the key material is directly
1227 * available, as opposed to a key in a secure element.
1228 *
Gilles Peskine60450a42019-07-25 11:32:45 +02001229 * This is a temporary function to use instead of psa_get_key_from_slot()
1230 * until secure element support is fully implemented.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001231 */
1232#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1233static psa_status_t psa_get_transparent_key( psa_key_handle_t handle,
1234 psa_key_slot_t **p_slot,
1235 psa_key_usage_t usage,
1236 psa_algorithm_t alg )
1237{
1238 psa_status_t status = psa_get_key_from_slot( handle, p_slot, usage, alg );
1239 if( status != PSA_SUCCESS )
1240 return( status );
Gilles Peskineadad8132019-07-25 11:31:23 +02001241 if( psa_key_slot_is_external( *p_slot ) )
Gilles Peskine28f8f302019-07-24 13:30:31 +02001242 {
1243 *p_slot = NULL;
1244 return( PSA_ERROR_NOT_SUPPORTED );
1245 }
1246 return( PSA_SUCCESS );
1247}
1248#else /* MBEDTLS_PSA_CRYPTO_SE_C */
1249/* With no secure element support, all keys are transparent. */
1250#define psa_get_transparent_key( handle, p_slot, usage, alg ) \
1251 psa_get_key_from_slot( handle, p_slot, usage, alg )
1252#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1253
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001254/** Wipe key data from a slot. Preserve metadata such as the policy. */
Gilles Peskine2f060a82018-12-04 17:12:32 +01001255static psa_status_t psa_remove_key_data_from_memory( psa_key_slot_t *slot )
Darryl Green40225ba2018-11-15 14:48:15 +00001256{
Gilles Peskine73167e12019-07-12 23:44:37 +02001257#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1258 if( psa_key_slot_is_external( slot ) )
Darryl Green40225ba2018-11-15 14:48:15 +00001259 {
1260 /* No key material to clean. */
1261 }
Gilles Peskine73167e12019-07-12 23:44:37 +02001262 else
1263#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Darryl Green40225ba2018-11-15 14:48:15 +00001264 {
Steven Cooremanfd4d69a2020-08-05 15:46:33 +02001265 /* Data pointer will always be either a valid pointer or NULL in an
1266 * initialized slot, so we can just free it. */
1267 if( slot->data.key.data != NULL )
1268 mbedtls_platform_zeroize( slot->data.key.data, slot->data.key.bytes);
Steven Cooremana01795d2020-07-24 22:48:15 +02001269 mbedtls_free( slot->data.key.data );
1270 slot->data.key.data = NULL;
1271 slot->data.key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +00001272 }
Darryl Green40225ba2018-11-15 14:48:15 +00001273
1274 return( PSA_SUCCESS );
1275}
1276
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001277/** Completely wipe a slot in memory, including its policy.
1278 * Persistent storage is not affected. */
Gilles Peskine66fb1262018-12-10 16:29:04 +01001279psa_status_t psa_wipe_key_slot( psa_key_slot_t *slot )
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001280{
1281 psa_status_t status = psa_remove_key_data_from_memory( slot );
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001282 /* Multipart operations may still be using the key. This is safe
1283 * because all multipart operation objects are independent from
1284 * the key slot: if they need to access the key after the setup
1285 * phase, they have a copy of the key. Note that this means that
1286 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001287 /* At this point, key material and other type-specific content has
1288 * been wiped. Clear remaining metadata. We can call memset and not
1289 * zeroize because the metadata is not particularly sensitive. */
1290 memset( slot, 0, sizeof( *slot ) );
1291 return( status );
1292}
1293
Gilles Peskinec5487a82018-12-03 18:08:14 +01001294psa_status_t psa_destroy_key( psa_key_handle_t handle )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001295{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001296 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001297 psa_status_t status; /* status of the last operation */
1298 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001299#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1300 psa_se_drv_table_entry_t *driver;
1301#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001302
Gilles Peskine1841cf42019-10-08 15:48:25 +02001303 if( handle == 0 )
1304 return( PSA_SUCCESS );
1305
Gilles Peskinec5487a82018-12-03 18:08:14 +01001306 status = psa_get_key_slot( handle, &slot );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001307 if( status != PSA_SUCCESS )
1308 return( status );
Gilles Peskine354f7672019-07-12 23:46:38 +02001309
1310#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001311 driver = psa_get_se_driver_entry( slot->attr.lifetime );
Gilles Peskine354f7672019-07-12 23:46:38 +02001312 if( driver != NULL )
Gilles Peskinefc762652019-07-22 19:30:34 +02001313 {
Gilles Peskine60450a42019-07-25 11:32:45 +02001314 /* For a key in a secure element, we need to do three things:
1315 * remove the key file in internal storage, destroy the
1316 * key inside the secure element, and update the driver's
1317 * persistent data. Start a transaction that will encompass these
1318 * three actions. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001319 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_DESTROY_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +02001320 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Gilles Peskinefc762652019-07-22 19:30:34 +02001321 psa_crypto_transaction.key.slot = slot->data.se.slot_number;
Gilles Peskine8e338702019-07-30 20:06:31 +02001322 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskinefc762652019-07-22 19:30:34 +02001323 status = psa_crypto_save_transaction( );
1324 if( status != PSA_SUCCESS )
1325 {
Gilles Peskine66be51c2019-07-25 18:02:52 +02001326 (void) psa_crypto_stop_transaction( );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001327 /* We should still try to destroy the key in the secure
1328 * element and the key metadata in storage. This is especially
1329 * important if the error is that the storage is full.
1330 * But how to do it exactly without risking an inconsistent
1331 * state after a reset?
1332 * https://github.com/ARMmbed/mbed-crypto/issues/215
1333 */
1334 overall_status = status;
1335 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001336 }
1337
Gilles Peskine354f7672019-07-12 23:46:38 +02001338 status = psa_destroy_se_key( driver, slot->data.se.slot_number );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001339 if( overall_status == PSA_SUCCESS )
1340 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001341 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001342#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1343
Darryl Greend49a4992018-06-18 17:27:26 +01001344#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskinecaec2782019-08-13 15:11:49 +02001345 if( slot->attr.lifetime != PSA_KEY_LIFETIME_VOLATILE )
Darryl Greend49a4992018-06-18 17:27:26 +01001346 {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001347 status = psa_destroy_persistent_key( slot->attr.id );
1348 if( overall_status == PSA_SUCCESS )
1349 overall_status = status;
1350
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001351 /* TODO: other slots may have a copy of the same key. We should
1352 * invalidate them.
1353 * https://github.com/ARMmbed/mbed-crypto/issues/214
1354 */
Darryl Greend49a4992018-06-18 17:27:26 +01001355 }
1356#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001357
Gilles Peskinefc762652019-07-22 19:30:34 +02001358#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1359 if( driver != NULL )
1360 {
Gilles Peskine725f22a2019-07-25 11:31:48 +02001361 status = psa_save_se_persistent_data( driver );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001362 if( overall_status == PSA_SUCCESS )
1363 overall_status = status;
1364 status = psa_crypto_stop_transaction( );
1365 if( overall_status == PSA_SUCCESS )
1366 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001367 }
1368#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1369
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001370#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1371exit:
1372#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001373 status = psa_wipe_key_slot( slot );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001374 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
1375 if( overall_status == PSA_SUCCESS )
1376 overall_status = status;
1377 return( overall_status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001378}
1379
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001380void psa_reset_key_attributes( psa_key_attributes_t *attributes )
Gilles Peskineb870b182018-07-06 16:02:09 +02001381{
Gilles Peskineb699f072019-04-26 16:06:02 +02001382 mbedtls_free( attributes->domain_parameters );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001383 memset( attributes, 0, sizeof( *attributes ) );
Gilles Peskineb870b182018-07-06 16:02:09 +02001384}
1385
Gilles Peskineb699f072019-04-26 16:06:02 +02001386psa_status_t psa_set_key_domain_parameters( psa_key_attributes_t *attributes,
1387 psa_key_type_t type,
1388 const uint8_t *data,
1389 size_t data_length )
1390{
1391 uint8_t *copy = NULL;
1392
1393 if( data_length != 0 )
1394 {
1395 copy = mbedtls_calloc( 1, data_length );
1396 if( copy == NULL )
1397 return( PSA_ERROR_INSUFFICIENT_MEMORY );
1398 memcpy( copy, data, data_length );
1399 }
1400 /* After this point, this function is guaranteed to succeed, so it
1401 * can start modifying `*attributes`. */
1402
1403 if( attributes->domain_parameters != NULL )
1404 {
1405 mbedtls_free( attributes->domain_parameters );
1406 attributes->domain_parameters = NULL;
1407 attributes->domain_parameters_size = 0;
1408 }
1409
1410 attributes->domain_parameters = copy;
1411 attributes->domain_parameters_size = data_length;
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001412 attributes->core.type = type;
Gilles Peskineb699f072019-04-26 16:06:02 +02001413 return( PSA_SUCCESS );
1414}
1415
1416psa_status_t psa_get_key_domain_parameters(
1417 const psa_key_attributes_t *attributes,
1418 uint8_t *data, size_t data_size, size_t *data_length )
1419{
1420 if( attributes->domain_parameters_size > data_size )
1421 return( PSA_ERROR_BUFFER_TOO_SMALL );
1422 *data_length = attributes->domain_parameters_size;
1423 if( attributes->domain_parameters_size != 0 )
1424 memcpy( data, attributes->domain_parameters,
1425 attributes->domain_parameters_size );
1426 return( PSA_SUCCESS );
1427}
1428
1429#if defined(MBEDTLS_RSA_C)
1430static psa_status_t psa_get_rsa_public_exponent(
1431 const mbedtls_rsa_context *rsa,
1432 psa_key_attributes_t *attributes )
1433{
1434 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001435 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001436 uint8_t *buffer = NULL;
1437 size_t buflen;
1438 mbedtls_mpi_init( &mpi );
1439
1440 ret = mbedtls_rsa_export( rsa, NULL, NULL, NULL, NULL, &mpi );
1441 if( ret != 0 )
1442 goto exit;
Gilles Peskine772c8b12019-04-26 17:37:21 +02001443 if( mbedtls_mpi_cmp_int( &mpi, 65537 ) == 0 )
1444 {
1445 /* It's the default value, which is reported as an empty string,
1446 * so there's nothing to do. */
1447 goto exit;
1448 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001449
1450 buflen = mbedtls_mpi_size( &mpi );
1451 buffer = mbedtls_calloc( 1, buflen );
1452 if( buffer == NULL )
1453 {
1454 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1455 goto exit;
1456 }
1457 ret = mbedtls_mpi_write_binary( &mpi, buffer, buflen );
1458 if( ret != 0 )
1459 goto exit;
1460 attributes->domain_parameters = buffer;
1461 attributes->domain_parameters_size = buflen;
1462
1463exit:
1464 mbedtls_mpi_free( &mpi );
1465 if( ret != 0 )
1466 mbedtls_free( buffer );
1467 return( mbedtls_to_psa_error( ret ) );
1468}
1469#endif /* MBEDTLS_RSA_C */
1470
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001471/** Retrieve all the publicly-accessible attributes of a key.
1472 */
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001473psa_status_t psa_get_key_attributes( psa_key_handle_t handle,
1474 psa_key_attributes_t *attributes )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001475{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001476 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001477 psa_status_t status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001478
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001479 psa_reset_key_attributes( attributes );
1480
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001481 status = psa_get_key_from_slot( handle, &slot, 0, 0 );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001482 if( status != PSA_SUCCESS )
1483 return( status );
Gilles Peskineb870b182018-07-06 16:02:09 +02001484
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001485 attributes->core = slot->attr;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001486 attributes->core.flags &= ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1487 MBEDTLS_PSA_KA_MASK_DUAL_USE );
1488
1489#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1490 if( psa_key_slot_is_external( slot ) )
1491 psa_set_key_slot_number( attributes, slot->data.se.slot_number );
1492#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001493
Gilles Peskine8e338702019-07-30 20:06:31 +02001494 switch( slot->attr.type )
Gilles Peskineb699f072019-04-26 16:06:02 +02001495 {
1496#if defined(MBEDTLS_RSA_C)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001497 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001498 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001499#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001500 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001501 * is not yet implemented.
1502 * https://github.com/ARMmbed/mbed-crypto/issues/216
1503 */
Gilles Peskinec8000c02019-08-02 20:15:51 +02001504 if( psa_key_slot_is_external( slot ) )
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001505 break;
1506#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Steven Cooremana01795d2020-07-24 22:48:15 +02001507 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001508 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001509
Steven Cooreman4fed4552020-08-03 14:46:03 +02001510 status = psa_load_rsa_representation( slot->attr.type,
1511 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02001512 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02001513 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001514 if( status != PSA_SUCCESS )
1515 break;
1516
Steven Cooremana2371e52020-07-28 14:30:39 +02001517 status = psa_get_rsa_public_exponent( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02001518 attributes );
Steven Cooremana2371e52020-07-28 14:30:39 +02001519 mbedtls_rsa_free( rsa );
1520 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001521 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001522 break;
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001523#endif /* MBEDTLS_RSA_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001524 default:
1525 /* Nothing else to do. */
1526 break;
1527 }
1528
1529 if( status != PSA_SUCCESS )
1530 psa_reset_key_attributes( attributes );
1531 return( status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001532}
1533
Gilles Peskinec8000c02019-08-02 20:15:51 +02001534#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1535psa_status_t psa_get_key_slot_number(
1536 const psa_key_attributes_t *attributes,
1537 psa_key_slot_number_t *slot_number )
1538{
1539 if( attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER )
1540 {
1541 *slot_number = attributes->slot_number;
1542 return( PSA_SUCCESS );
1543 }
1544 else
1545 return( PSA_ERROR_INVALID_ARGUMENT );
1546}
1547#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1548
Steven Cooremana01795d2020-07-24 22:48:15 +02001549static psa_status_t psa_internal_export_key_buffer( const psa_key_slot_t *slot,
1550 uint8_t *data,
1551 size_t data_size,
1552 size_t *data_length )
1553{
1554 if( slot->data.key.bytes > data_size )
1555 return( PSA_ERROR_BUFFER_TOO_SMALL );
1556 memcpy( data, slot->data.key.data, slot->data.key.bytes );
1557 memset( data + slot->data.key.bytes, 0,
1558 data_size - slot->data.key.bytes );
1559 *data_length = slot->data.key.bytes;
1560 return( PSA_SUCCESS );
1561}
1562
Gilles Peskinef603c712019-01-19 13:40:11 +01001563static psa_status_t psa_internal_export_key( const psa_key_slot_t *slot,
1564 uint8_t *data,
1565 size_t data_size,
1566 size_t *data_length,
1567 int export_public_key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001568{
Gilles Peskine5d309672019-07-12 23:47:28 +02001569#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1570 const psa_drv_se_t *drv;
1571 psa_drv_se_context_t *drv_context;
1572#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1573
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001574 *data_length = 0;
1575
Gilles Peskine8e338702019-07-30 20:06:31 +02001576 if( export_public_key && ! PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
Moran Pekera998bc62018-04-16 18:16:20 +03001577 return( PSA_ERROR_INVALID_ARGUMENT );
mohammad160306e79202018-03-28 13:17:44 +03001578
Gilles Peskinef9168942019-09-12 19:20:29 +02001579 /* Reject a zero-length output buffer now, since this can never be a
1580 * valid key representation. This way we know that data must be a valid
1581 * pointer and we can do things like memset(data, ..., data_size). */
1582 if( data_size == 0 )
1583 return( PSA_ERROR_BUFFER_TOO_SMALL );
1584
Gilles Peskine5d309672019-07-12 23:47:28 +02001585#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001586 if( psa_get_se_driver( slot->attr.lifetime, &drv, &drv_context ) )
Gilles Peskine5d309672019-07-12 23:47:28 +02001587 {
1588 psa_drv_se_export_key_t method;
1589 if( drv->key_management == NULL )
1590 return( PSA_ERROR_NOT_SUPPORTED );
1591 method = ( export_public_key ?
1592 drv->key_management->p_export_public :
1593 drv->key_management->p_export );
1594 if( method == NULL )
1595 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine2e0f3882019-07-25 11:34:33 +02001596 return( method( drv_context,
1597 slot->data.se.slot_number,
1598 data, data_size, data_length ) );
Gilles Peskine5d309672019-07-12 23:47:28 +02001599 }
1600#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1601
Gilles Peskine8e338702019-07-30 20:06:31 +02001602 if( key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001603 {
Steven Cooremanacda8342020-07-24 23:09:52 +02001604 return( psa_internal_export_key_buffer( slot, data, data_size, data_length ) );
Gilles Peskine188c71e2018-10-29 19:26:02 +01001605 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001606 else if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) ||
1607 PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
Moran Peker17e36e12018-05-02 12:55:20 +03001608 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001609 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Gilles Peskine969ac722018-01-28 18:16:59 +01001610 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001611 /* Exporting public -> public */
1612 return( psa_internal_export_key_buffer( slot, data, data_size, data_length ) );
1613 }
1614 else if( !export_public_key )
1615 {
1616 /* Exporting private -> private */
1617 return( psa_internal_export_key_buffer( slot, data, data_size, data_length ) );
1618 }
1619 /* Need to export the public part of a private key,
1620 * so conversion is needed */
1621 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
1622 {
Darryl Green9e2d7a02018-07-24 16:33:30 +01001623#if defined(MBEDTLS_RSA_C)
Steven Cooremana2371e52020-07-28 14:30:39 +02001624 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman7f391872020-07-30 14:57:44 +02001625 psa_status_t status = psa_load_rsa_representation(
Steven Cooreman4fed4552020-08-03 14:46:03 +02001626 slot->attr.type,
Steven Cooreman7f391872020-07-30 14:57:44 +02001627 slot->data.key.data,
1628 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02001629 &rsa );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001630 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001631 return( status );
Steven Cooremana01795d2020-07-24 22:48:15 +02001632
Steven Cooreman560c28a2020-07-24 23:20:24 +02001633 status = psa_export_rsa_key( PSA_KEY_TYPE_RSA_PUBLIC_KEY,
Steven Cooremana2371e52020-07-28 14:30:39 +02001634 rsa,
Steven Cooreman560c28a2020-07-24 23:20:24 +02001635 data,
1636 data_size,
1637 data_length );
Steven Cooremana01795d2020-07-24 22:48:15 +02001638
Steven Cooremana2371e52020-07-28 14:30:39 +02001639 mbedtls_rsa_free( rsa );
1640 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001641
Steven Cooreman560c28a2020-07-24 23:20:24 +02001642 return( status );
Darryl Green9e2d7a02018-07-24 16:33:30 +01001643#else
Steven Cooreman560c28a2020-07-24 23:20:24 +02001644 /* We don't know how to convert a private RSA key to public. */
1645 return( PSA_ERROR_NOT_SUPPORTED );
Darryl Green9e2d7a02018-07-24 16:33:30 +01001646#endif
Gilles Peskine969ac722018-01-28 18:16:59 +01001647 }
1648 else
Moran Pekera998bc62018-04-16 18:16:20 +03001649 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001650#if defined(MBEDTLS_ECP_C)
Steven Cooremana2371e52020-07-28 14:30:39 +02001651 mbedtls_ecp_keypair *ecp = NULL;
Steven Cooreman7f391872020-07-30 14:57:44 +02001652 psa_status_t status = psa_load_ecp_representation(
Steven Cooreman4fed4552020-08-03 14:46:03 +02001653 slot->attr.type,
Steven Cooreman7f391872020-07-30 14:57:44 +02001654 slot->data.key.data,
1655 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02001656 &ecp );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001657 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001658 return( status );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001659
1660 status = psa_export_ecp_key( PSA_KEY_TYPE_ECC_PUBLIC_KEY(
1661 PSA_KEY_TYPE_ECC_GET_FAMILY(
1662 slot->attr.type ) ),
Steven Cooremana2371e52020-07-28 14:30:39 +02001663 ecp,
Steven Cooreman560c28a2020-07-24 23:20:24 +02001664 data,
1665 data_size,
1666 data_length );
1667
Steven Cooremana2371e52020-07-28 14:30:39 +02001668 mbedtls_ecp_keypair_free( ecp );
1669 mbedtls_free( ecp );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001670 return( status );
1671#else
1672 /* We don't know how to convert a private ECC key to public */
Moran Pekera998bc62018-04-16 18:16:20 +03001673 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001674#endif
Moran Pekera998bc62018-04-16 18:16:20 +03001675 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001676 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001677 else
1678 {
1679 /* This shouldn't happen in the reference implementation, but
1680 it is valid for a special-purpose implementation to omit
1681 support for exporting certain key types. */
1682 return( PSA_ERROR_NOT_SUPPORTED );
1683 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001684}
1685
Gilles Peskinec5487a82018-12-03 18:08:14 +01001686psa_status_t psa_export_key( psa_key_handle_t handle,
Gilles Peskine2d277862018-06-18 15:41:12 +02001687 uint8_t *data,
1688 size_t data_size,
1689 size_t *data_length )
Moran Pekera998bc62018-04-16 18:16:20 +03001690{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001691 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001692 psa_status_t status;
1693
1694 /* Set the key to empty now, so that even when there are errors, we always
1695 * set data_length to a value between 0 and data_size. On error, setting
1696 * the key to empty is a good choice because an empty key representation is
1697 * unlikely to be accepted anywhere. */
1698 *data_length = 0;
1699
1700 /* Export requires the EXPORT flag. There is an exception for public keys,
1701 * which don't require any flag, but psa_get_key_from_slot takes
1702 * care of this. */
Gilles Peskinec5487a82018-12-03 18:08:14 +01001703 status = psa_get_key_from_slot( handle, &slot, PSA_KEY_USAGE_EXPORT, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001704 if( status != PSA_SUCCESS )
1705 return( status );
1706 return( psa_internal_export_key( slot, data, data_size,
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02001707 data_length, 0 ) );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001708}
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001709
Gilles Peskinec5487a82018-12-03 18:08:14 +01001710psa_status_t psa_export_public_key( psa_key_handle_t handle,
Gilles Peskine2d277862018-06-18 15:41:12 +02001711 uint8_t *data,
1712 size_t data_size,
1713 size_t *data_length )
Moran Pekerdd4ea382018-04-03 15:30:03 +03001714{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001715 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001716 psa_status_t status;
1717
1718 /* Set the key to empty now, so that even when there are errors, we always
1719 * set data_length to a value between 0 and data_size. On error, setting
1720 * the key to empty is a good choice because an empty key representation is
1721 * unlikely to be accepted anywhere. */
1722 *data_length = 0;
1723
1724 /* Exporting a public key doesn't require a usage flag. */
Gilles Peskinec5487a82018-12-03 18:08:14 +01001725 status = psa_get_key_from_slot( handle, &slot, 0, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001726 if( status != PSA_SUCCESS )
1727 return( status );
1728 return( psa_internal_export_key( slot, data, data_size,
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02001729 data_length, 1 ) );
Moran Pekerdd4ea382018-04-03 15:30:03 +03001730}
1731
Gilles Peskine91e8c332019-08-02 19:19:39 +02001732#if defined(static_assert)
1733static_assert( ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
1734 "One or more key attribute flag is listed as both external-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001735static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
Gilles Peskine094dac12019-08-07 18:19:46 +02001736 "One or more key attribute flag is listed as both internal-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001737static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY ) == 0,
Gilles Peskine91e8c332019-08-02 19:19:39 +02001738 "One or more key attribute flag is listed as both internal-only and external-only" );
1739#endif
1740
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001741/** Validate that a key policy is internally well-formed.
1742 *
1743 * This function only rejects invalid policies. It does not validate the
1744 * consistency of the policy with respect to other attributes of the key
1745 * such as the key type.
1746 */
1747static psa_status_t psa_validate_key_policy( const psa_key_policy_t *policy )
Gilles Peskine4747d192019-04-17 15:05:45 +02001748{
1749 if( ( policy->usage & ~( PSA_KEY_USAGE_EXPORT |
Gilles Peskine8e0206a2019-05-14 14:24:28 +02001750 PSA_KEY_USAGE_COPY |
Gilles Peskine4747d192019-04-17 15:05:45 +02001751 PSA_KEY_USAGE_ENCRYPT |
1752 PSA_KEY_USAGE_DECRYPT |
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001753 PSA_KEY_USAGE_SIGN_HASH |
1754 PSA_KEY_USAGE_VERIFY_HASH |
Gilles Peskine4747d192019-04-17 15:05:45 +02001755 PSA_KEY_USAGE_DERIVE ) ) != 0 )
1756 return( PSA_ERROR_INVALID_ARGUMENT );
1757
Gilles Peskine4747d192019-04-17 15:05:45 +02001758 return( PSA_SUCCESS );
1759}
1760
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001761/** Validate the internal consistency of key attributes.
1762 *
1763 * This function only rejects invalid attribute values. If does not
1764 * validate the consistency of the attributes with any key data that may
1765 * be involved in the creation of the key.
1766 *
1767 * Call this function early in the key creation process.
1768 *
1769 * \param[in] attributes Key attributes for the new key.
1770 * \param[out] p_drv On any return, the driver for the key, if any.
1771 * NULL for a transparent key.
1772 *
1773 */
1774static psa_status_t psa_validate_key_attributes(
1775 const psa_key_attributes_t *attributes,
1776 psa_se_drv_table_entry_t **p_drv )
Darryl Green0c6575a2018-11-07 16:05:30 +00001777{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001778 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Ronald Crond2ed4812020-07-17 16:11:30 +02001779 psa_key_lifetime_t lifetime = psa_get_key_lifetime( attributes );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001780
Steven Cooreman8c1e7592020-06-17 14:52:05 +02001781 status = psa_validate_key_location( psa_get_key_lifetime( attributes ),
1782 p_drv );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001783 if( status != PSA_SUCCESS )
1784 return( status );
1785
Ronald Crond2ed4812020-07-17 16:11:30 +02001786 status = psa_validate_key_persistence( lifetime );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001787 if( status != PSA_SUCCESS )
1788 return( status );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001789
Ronald Crond2ed4812020-07-17 16:11:30 +02001790 /* Validate the key identifier only in the case of a persistent key. */
1791 if ( ! PSA_KEY_LIFETIME_IS_VOLATILE( lifetime ) )
1792 {
1793 status = psa_validate_key_id(
1794 psa_get_key_id( attributes ),
1795 psa_key_lifetime_is_external( lifetime ) );
1796
1797 if( status != PSA_SUCCESS )
1798 return( status );
1799 }
1800
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001801 status = psa_validate_key_policy( &attributes->core.policy );
Darryl Green0c6575a2018-11-07 16:05:30 +00001802 if( status != PSA_SUCCESS )
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001803 return( status );
1804
1805 /* Refuse to create overly large keys.
1806 * Note that this doesn't trigger on import if the attributes don't
1807 * explicitly specify a size (so psa_get_key_bits returns 0), so
1808 * psa_import_key() needs its own checks. */
1809 if( psa_get_key_bits( attributes ) > PSA_MAX_KEY_BITS )
1810 return( PSA_ERROR_NOT_SUPPORTED );
1811
Gilles Peskine91e8c332019-08-02 19:19:39 +02001812 /* Reject invalid flags. These should not be reachable through the API. */
1813 if( attributes->core.flags & ~ ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1814 MBEDTLS_PSA_KA_MASK_DUAL_USE ) )
1815 return( PSA_ERROR_INVALID_ARGUMENT );
1816
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001817 return( PSA_SUCCESS );
1818}
1819
Gilles Peskine4747d192019-04-17 15:05:45 +02001820/** Prepare a key slot to receive key material.
1821 *
1822 * This function allocates a key slot and sets its metadata.
1823 *
1824 * If this function fails, call psa_fail_key_creation().
1825 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001826 * This function is intended to be used as follows:
1827 * -# Call psa_start_key_creation() to allocate a key slot, prepare
1828 * it with the specified attributes, and assign it a handle.
1829 * -# Populate the slot with the key material.
1830 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1831 * In case of failure at any step, stop the sequence and call
1832 * psa_fail_key_creation().
1833 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001834 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001835 * \param[in] attributes Key attributes for the new key.
1836 * \param[out] handle On success, a handle for the allocated slot.
1837 * \param[out] p_slot On success, a pointer to the prepared slot.
1838 * \param[out] p_drv On any return, the driver for the key, if any.
1839 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001840 *
1841 * \retval #PSA_SUCCESS
1842 * The key slot is ready to receive key material.
1843 * \return If this function fails, the key slot is an invalid state.
1844 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001845 */
1846static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001847 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001848 const psa_key_attributes_t *attributes,
1849 psa_key_handle_t *handle,
Gilles Peskine011e4282019-06-26 18:34:38 +02001850 psa_key_slot_t **p_slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001851 psa_se_drv_table_entry_t **p_drv )
Gilles Peskine4747d192019-04-17 15:05:45 +02001852{
1853 psa_status_t status;
1854 psa_key_slot_t *slot;
1855
Gilles Peskinedf179142019-07-15 22:02:14 +02001856 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001857 *p_drv = NULL;
1858
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001859 status = psa_validate_key_attributes( attributes, p_drv );
1860 if( status != PSA_SUCCESS )
1861 return( status );
1862
Gilles Peskineedbed562019-08-07 18:19:59 +02001863 status = psa_get_empty_key_slot( handle, p_slot );
Gilles Peskine4747d192019-04-17 15:05:45 +02001864 if( status != PSA_SUCCESS )
1865 return( status );
1866 slot = *p_slot;
1867
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001868 /* We're storing the declared bit-size of the key. It's up to each
1869 * creation mechanism to verify that this information is correct.
1870 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001871 * an input (generate, device) but not for those where the bit-size
1872 * is optional (import, copy). */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001873
1874 slot->attr = attributes->core;
Gilles Peskinec744d992019-07-30 17:26:54 +02001875
Gilles Peskine91e8c332019-08-02 19:19:39 +02001876 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001877 * external-only flags, query `attributes`. Thanks to the check
1878 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001879 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001880 * may have set. */
1881 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001882
Gilles Peskinecbaff462019-07-12 23:46:04 +02001883#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001884 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001885 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001886 * create the key file in internal storage, create the
1887 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001888 * persistent data. This is done by starting a transaction that will
1889 * encompass these three actions.
1890 * For registering a volatile key, we just need to find an appropriate
1891 * slot number inside the SE. Since the key is designated volatile, creating
1892 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001893 /* The first thing to do is to find a slot number for the new key.
1894 * We save the slot number in persistent storage as part of the
1895 * transaction data. It will be needed to recover if the power
1896 * fails during the key creation process, to clean up on the secure
1897 * element side after restarting. Obtaining a slot number from the
1898 * secure element driver updates its persistent state, but we do not yet
1899 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001900 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001901 if( *p_drv != NULL )
Darryl Green0c6575a2018-11-07 16:05:30 +00001902 {
Gilles Peskinee88c2c12019-08-05 16:44:14 +02001903 status = psa_find_se_slot_for_key( attributes, method, *p_drv,
Gilles Peskinecbaff462019-07-12 23:46:04 +02001904 &slot->data.se.slot_number );
1905 if( status != PSA_SUCCESS )
1906 return( status );
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001907
1908 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( attributes->core.lifetime ) )
Gilles Peskine66be51c2019-07-25 18:02:52 +02001909 {
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001910 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_CREATE_KEY );
1911 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
1912 psa_crypto_transaction.key.slot = slot->data.se.slot_number;
1913 psa_crypto_transaction.key.id = slot->attr.id;
1914 status = psa_crypto_save_transaction( );
1915 if( status != PSA_SUCCESS )
1916 {
1917 (void) psa_crypto_stop_transaction( );
1918 return( status );
1919 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001920 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001921 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001922
1923 if( *p_drv == NULL && method == PSA_KEY_CREATION_REGISTER )
1924 {
1925 /* Key registration only makes sense with a secure element. */
1926 return( PSA_ERROR_INVALID_ARGUMENT );
1927 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001928#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1929
Darryl Green0c6575a2018-11-07 16:05:30 +00001930 return( status );
1931}
Gilles Peskine4747d192019-04-17 15:05:45 +02001932
1933/** Finalize the creation of a key once its key material has been set.
1934 *
1935 * This entails writing the key to persistent storage.
1936 *
1937 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001938 * See the documentation of psa_start_key_creation() for the intended use
1939 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001940 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001941 * \param[in,out] slot Pointer to the slot with key material.
1942 * \param[in] driver The secure element driver for the key,
1943 * or NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001944 *
1945 * \retval #PSA_SUCCESS
1946 * The key was successfully created. The handle is now valid.
1947 * \return If this function fails, the key slot is an invalid state.
1948 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001949 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001950static psa_status_t psa_finish_key_creation(
1951 psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001952 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001953{
1954 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001955 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001956 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001957
1958#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Steven Cooremanc59de6a2020-06-08 18:28:25 +02001959 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Gilles Peskine4747d192019-04-17 15:05:45 +02001960 {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001961#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1962 if( driver != NULL )
1963 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001964 psa_se_key_data_storage_t data;
1965#if defined(static_assert)
1966 static_assert( sizeof( slot->data.se.slot_number ) ==
1967 sizeof( data.slot_number ),
1968 "Slot number size does not match psa_se_key_data_storage_t" );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001969#endif
1970 memcpy( &data.slot_number, &slot->data.se.slot_number,
1971 sizeof( slot->data.se.slot_number ) );
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001972 status = psa_save_persistent_key( &slot->attr,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001973 (uint8_t*) &data,
1974 sizeof( data ) );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001975 }
1976 else
1977#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1978 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001979 /* Key material is saved in export representation in the slot, so
1980 * just pass the slot buffer for storage. */
1981 status = psa_save_persistent_key( &slot->attr,
1982 slot->data.key.data,
1983 slot->data.key.bytes );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001984 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001985 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001986#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1987
Gilles Peskinecbaff462019-07-12 23:46:04 +02001988#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001989 /* Finish the transaction for a key creation. This does not
1990 * happen when registering an existing key. Detect this case
1991 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001992 * creation of a persistent key in a secure element requires a transaction,
1993 * but registration or volatile key creation doesn't use one). */
Gilles Peskined7729582019-08-05 15:55:54 +02001994 if( driver != NULL &&
1995 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY )
Gilles Peskinecbaff462019-07-12 23:46:04 +02001996 {
1997 status = psa_save_se_persistent_data( driver );
1998 if( status != PSA_SUCCESS )
1999 {
Gilles Peskine8e338702019-07-30 20:06:31 +02002000 psa_destroy_persistent_key( slot->attr.id );
Gilles Peskinecbaff462019-07-12 23:46:04 +02002001 return( status );
2002 }
Gilles Peskinefc762652019-07-22 19:30:34 +02002003 status = psa_crypto_stop_transaction( );
2004 if( status != PSA_SUCCESS )
2005 return( status );
Gilles Peskinecbaff462019-07-12 23:46:04 +02002006 }
2007#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2008
Gilles Peskine4747d192019-04-17 15:05:45 +02002009 return( status );
2010}
2011
2012/** Abort the creation of a key.
2013 *
2014 * You may call this function after calling psa_start_key_creation(),
2015 * or after psa_finish_key_creation() fails. In other circumstances, this
2016 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02002017 * See the documentation of psa_start_key_creation() for the intended use
2018 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02002019 *
Gilles Peskine011e4282019-06-26 18:34:38 +02002020 * \param[in,out] slot Pointer to the slot with key material.
2021 * \param[in] driver The secure element driver for the key,
2022 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02002023 */
Gilles Peskine011e4282019-06-26 18:34:38 +02002024static void psa_fail_key_creation( psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002025 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02002026{
Gilles Peskine011e4282019-06-26 18:34:38 +02002027 (void) driver;
2028
Gilles Peskine4747d192019-04-17 15:05:45 +02002029 if( slot == NULL )
2030 return;
Gilles Peskine011e4282019-06-26 18:34:38 +02002031
2032#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01002033 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02002034 * element, and the failure happened later (when saving metadata
2035 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02002036 * element.
2037 * https://github.com/ARMmbed/mbed-crypto/issues/217
2038 */
Gilles Peskinefc762652019-07-22 19:30:34 +02002039
Gilles Peskined7729582019-08-05 15:55:54 +02002040 /* Abort the ongoing transaction if any (there may not be one if
2041 * the creation process failed before starting one, or if the
2042 * key creation is a registration of a key in a secure element).
2043 * Earlier functions must already have done what it takes to undo any
2044 * partial creation. All that's left is to update the transaction data
2045 * itself. */
Gilles Peskinefc762652019-07-22 19:30:34 +02002046 (void) psa_crypto_stop_transaction( );
Gilles Peskine011e4282019-06-26 18:34:38 +02002047#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2048
Gilles Peskine4747d192019-04-17 15:05:45 +02002049 psa_wipe_key_slot( slot );
2050}
2051
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002052/** Validate optional attributes during key creation.
2053 *
2054 * Some key attributes are optional during key creation. If they are
2055 * specified in the attributes structure, check that they are consistent
2056 * with the data in the slot.
2057 *
2058 * This function should be called near the end of key creation, after
2059 * the slot in memory is fully populated but before saving persistent data.
2060 */
2061static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002062 const psa_key_slot_t *slot,
2063 const psa_key_attributes_t *attributes )
2064{
Gilles Peskine7e0cff92019-07-30 13:48:52 +02002065 if( attributes->core.type != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002066 {
Gilles Peskine8e338702019-07-30 20:06:31 +02002067 if( attributes->core.type != slot->attr.type )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002068 return( PSA_ERROR_INVALID_ARGUMENT );
2069 }
2070
2071 if( attributes->domain_parameters_size != 0 )
2072 {
2073#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02002074 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002075 {
Steven Cooremana2371e52020-07-28 14:30:39 +02002076 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02002077 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02002078 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02002079
Steven Cooreman7f391872020-07-30 14:57:44 +02002080 psa_status_t status = psa_load_rsa_representation(
Steven Cooreman4fed4552020-08-03 14:46:03 +02002081 slot->attr.type,
Steven Cooreman7f391872020-07-30 14:57:44 +02002082 slot->data.key.data,
2083 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02002084 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02002085 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02002086 return( status );
Steven Cooreman75b74362020-07-28 14:30:13 +02002087
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002088 mbedtls_mpi_init( &actual );
2089 mbedtls_mpi_init( &required );
Steven Cooremana2371e52020-07-28 14:30:39 +02002090 ret = mbedtls_rsa_export( rsa,
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002091 NULL, NULL, NULL, NULL, &actual );
Steven Cooremana2371e52020-07-28 14:30:39 +02002092 mbedtls_rsa_free( rsa );
2093 mbedtls_free( rsa );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002094 if( ret != 0 )
2095 goto rsa_exit;
2096 ret = mbedtls_mpi_read_binary( &required,
2097 attributes->domain_parameters,
2098 attributes->domain_parameters_size );
2099 if( ret != 0 )
2100 goto rsa_exit;
2101 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
2102 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
2103 rsa_exit:
2104 mbedtls_mpi_free( &actual );
2105 mbedtls_mpi_free( &required );
2106 if( ret != 0)
2107 return( mbedtls_to_psa_error( ret ) );
2108 }
2109 else
2110#endif
2111 {
2112 return( PSA_ERROR_INVALID_ARGUMENT );
2113 }
2114 }
2115
Gilles Peskine7e0cff92019-07-30 13:48:52 +02002116 if( attributes->core.bits != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002117 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02002118 if( attributes->core.bits != slot->attr.bits )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002119 return( PSA_ERROR_INVALID_ARGUMENT );
2120 }
2121
2122 return( PSA_SUCCESS );
2123}
2124
Gilles Peskine4747d192019-04-17 15:05:45 +02002125psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02002126 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02002127 size_t data_length,
2128 psa_key_handle_t *handle )
Gilles Peskine4747d192019-04-17 15:05:45 +02002129{
2130 psa_status_t status;
2131 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002132 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002133
Gilles Peskine0f84d622019-09-12 19:03:13 +02002134 /* Reject zero-length symmetric keys (including raw data key objects).
2135 * This also rejects any key which might be encoded as an empty string,
2136 * which is never valid. */
2137 if( data_length == 0 )
2138 return( PSA_ERROR_INVALID_ARGUMENT );
2139
Gilles Peskinedf179142019-07-15 22:02:14 +02002140 status = psa_start_key_creation( PSA_KEY_CREATION_IMPORT, attributes,
2141 handle, &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002142 if( status != PSA_SUCCESS )
2143 goto exit;
2144
Gilles Peskine5d309672019-07-12 23:47:28 +02002145#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2146 if( driver != NULL )
2147 {
2148 const psa_drv_se_t *drv = psa_get_se_driver_methods( driver );
Darryl Green0892d0f2019-08-20 09:50:14 +01002149 /* The driver should set the number of key bits, however in
2150 * case it doesn't, we initialize bits to an invalid value. */
2151 size_t bits = PSA_MAX_KEY_BITS + 1;
Gilles Peskine5d309672019-07-12 23:47:28 +02002152 if( drv->key_management == NULL ||
2153 drv->key_management->p_import == NULL )
2154 {
2155 status = PSA_ERROR_NOT_SUPPORTED;
2156 goto exit;
2157 }
2158 status = drv->key_management->p_import(
2159 psa_get_se_driver_context( driver ),
Gilles Peskinef3801ff2019-08-06 17:32:04 +02002160 slot->data.se.slot_number, attributes, data, data_length,
Gilles Peskineb46bef22019-07-30 21:32:04 +02002161 &bits );
2162 if( status != PSA_SUCCESS )
2163 goto exit;
2164 if( bits > PSA_MAX_KEY_BITS )
2165 {
2166 status = PSA_ERROR_NOT_SUPPORTED;
2167 goto exit;
2168 }
2169 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskine5d309672019-07-12 23:47:28 +02002170 }
2171 else
2172#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2173 {
2174 status = psa_import_key_into_slot( slot, data, data_length );
2175 if( status != PSA_SUCCESS )
2176 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02002177 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002178 status = psa_validate_optional_attributes( slot, attributes );
Gilles Peskine18017402019-07-24 20:25:59 +02002179 if( status != PSA_SUCCESS )
2180 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002181
Gilles Peskine011e4282019-06-26 18:34:38 +02002182 status = psa_finish_key_creation( slot, driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002183exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02002184 if( status != PSA_SUCCESS )
2185 {
Gilles Peskine011e4282019-06-26 18:34:38 +02002186 psa_fail_key_creation( slot, driver );
Gilles Peskine4747d192019-04-17 15:05:45 +02002187 *handle = 0;
2188 }
2189 return( status );
2190}
2191
Gilles Peskined7729582019-08-05 15:55:54 +02002192#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2193psa_status_t mbedtls_psa_register_se_key(
2194 const psa_key_attributes_t *attributes )
2195{
2196 psa_status_t status;
2197 psa_key_slot_t *slot = NULL;
2198 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskined7729582019-08-05 15:55:54 +02002199 psa_key_handle_t handle = 0;
2200
2201 /* Leaving attributes unspecified is not currently supported.
2202 * It could make sense to query the key type and size from the
2203 * secure element, but not all secure elements support this
2204 * and the driver HAL doesn't currently support it. */
2205 if( psa_get_key_type( attributes ) == PSA_KEY_TYPE_NONE )
2206 return( PSA_ERROR_NOT_SUPPORTED );
2207 if( psa_get_key_bits( attributes ) == 0 )
2208 return( PSA_ERROR_NOT_SUPPORTED );
2209
2210 status = psa_start_key_creation( PSA_KEY_CREATION_REGISTER, attributes,
2211 &handle, &slot, &driver );
2212 if( status != PSA_SUCCESS )
2213 goto exit;
2214
Gilles Peskined7729582019-08-05 15:55:54 +02002215 status = psa_finish_key_creation( slot, driver );
2216
2217exit:
2218 if( status != PSA_SUCCESS )
2219 {
2220 psa_fail_key_creation( slot, driver );
2221 }
2222 /* Registration doesn't keep the key in RAM. */
2223 psa_close_key( handle );
2224 return( status );
2225}
2226#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2227
Gilles Peskinef603c712019-01-19 13:40:11 +01002228static psa_status_t psa_copy_key_material( const psa_key_slot_t *source,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002229 psa_key_slot_t *target )
Gilles Peskinef603c712019-01-19 13:40:11 +01002230{
Steven Cooremanf7cebd42020-10-13 20:27:40 +02002231 psa_status_t status = psa_copy_key_material_into_slot( target,
2232 source->data.key.data,
2233 source->data.key.bytes );
Gilles Peskinef603c712019-01-19 13:40:11 +01002234 if( status != PSA_SUCCESS )
Steven Cooreman398aee52020-10-13 14:35:45 +02002235 return( status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002236
Steven Cooreman398aee52020-10-13 14:35:45 +02002237 target->attr.type = source->attr.type;
2238 target->attr.bits = source->attr.bits;
2239
2240 return( PSA_SUCCESS );
Gilles Peskinef603c712019-01-19 13:40:11 +01002241}
2242
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002243psa_status_t psa_copy_key( psa_key_handle_t source_handle,
2244 const psa_key_attributes_t *specified_attributes,
2245 psa_key_handle_t *target_handle )
Gilles Peskinef603c712019-01-19 13:40:11 +01002246{
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002247 psa_status_t status;
Gilles Peskinef603c712019-01-19 13:40:11 +01002248 psa_key_slot_t *source_slot = NULL;
2249 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002250 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002251 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskinef603c712019-01-19 13:40:11 +01002252
Gilles Peskine28f8f302019-07-24 13:30:31 +02002253 status = psa_get_transparent_key( source_handle, &source_slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02002254 PSA_KEY_USAGE_COPY, 0 );
Gilles Peskinef603c712019-01-19 13:40:11 +01002255 if( status != PSA_SUCCESS )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002256 goto exit;
2257
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002258 status = psa_validate_optional_attributes( source_slot,
2259 specified_attributes );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002260 if( status != PSA_SUCCESS )
2261 goto exit;
2262
Gilles Peskine7e0cff92019-07-30 13:48:52 +02002263 status = psa_restrict_key_policy( &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02002264 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002265 if( status != PSA_SUCCESS )
2266 goto exit;
2267
Gilles Peskinedf179142019-07-15 22:02:14 +02002268 status = psa_start_key_creation( PSA_KEY_CREATION_COPY,
2269 &actual_attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02002270 target_handle, &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002271 if( status != PSA_SUCCESS )
2272 goto exit;
2273
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002274#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2275 if( driver != NULL )
Gilles Peskinef603c712019-01-19 13:40:11 +01002276 {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002277 /* Copying to a secure element is not implemented yet. */
2278 status = PSA_ERROR_NOT_SUPPORTED;
2279 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002280 }
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002281#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef603c712019-01-19 13:40:11 +01002282
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002283 status = psa_copy_key_material( source_slot, target_slot );
Gilles Peskinef603c712019-01-19 13:40:11 +01002284 if( status != PSA_SUCCESS )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002285 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002286
Gilles Peskine011e4282019-06-26 18:34:38 +02002287 status = psa_finish_key_creation( target_slot, driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002288exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002289 if( status != PSA_SUCCESS )
2290 {
Gilles Peskine011e4282019-06-26 18:34:38 +02002291 psa_fail_key_creation( target_slot, driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002292 *target_handle = 0;
2293 }
2294 return( status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002295}
2296
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002297
2298
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002299/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002300/* Message digests */
2301/****************************************************************/
2302
John Durkop0ea39e02020-10-13 19:58:20 -07002303#if defined(MBEDTLS_RSA_C) || defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinedc2fc842018-03-07 16:42:59 +01002304static const mbedtls_md_info_t *mbedtls_md_info_from_psa( psa_algorithm_t alg )
Gilles Peskine20035e32018-02-03 22:44:14 +01002305{
2306 switch( alg )
2307 {
2308#if defined(MBEDTLS_MD2_C)
2309 case PSA_ALG_MD2:
2310 return( &mbedtls_md2_info );
2311#endif
2312#if defined(MBEDTLS_MD4_C)
2313 case PSA_ALG_MD4:
2314 return( &mbedtls_md4_info );
2315#endif
2316#if defined(MBEDTLS_MD5_C)
2317 case PSA_ALG_MD5:
2318 return( &mbedtls_md5_info );
2319#endif
2320#if defined(MBEDTLS_RIPEMD160_C)
2321 case PSA_ALG_RIPEMD160:
2322 return( &mbedtls_ripemd160_info );
2323#endif
2324#if defined(MBEDTLS_SHA1_C)
2325 case PSA_ALG_SHA_1:
2326 return( &mbedtls_sha1_info );
2327#endif
2328#if defined(MBEDTLS_SHA256_C)
2329 case PSA_ALG_SHA_224:
2330 return( &mbedtls_sha224_info );
2331 case PSA_ALG_SHA_256:
2332 return( &mbedtls_sha256_info );
2333#endif
2334#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnardd6020842019-07-17 16:28:21 +02002335#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine20035e32018-02-03 22:44:14 +01002336 case PSA_ALG_SHA_384:
2337 return( &mbedtls_sha384_info );
Manuel Pégourié-Gonnardd6020842019-07-17 16:28:21 +02002338#endif
Gilles Peskine20035e32018-02-03 22:44:14 +01002339 case PSA_ALG_SHA_512:
2340 return( &mbedtls_sha512_info );
2341#endif
2342 default:
2343 return( NULL );
2344 }
2345}
John Durkop0ea39e02020-10-13 19:58:20 -07002346#endif /* defined(MBEDTLS_RSA_C) || defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine20035e32018-02-03 22:44:14 +01002347
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002348psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
2349{
2350 switch( operation->alg )
2351 {
Gilles Peskine81736312018-06-26 15:04:31 +02002352 case 0:
2353 /* The object has (apparently) been initialized but it is not
2354 * in use. It's ok to call abort on such an object, and there's
2355 * nothing to do. */
2356 break;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002357#if defined(MBEDTLS_MD2_C)
2358 case PSA_ALG_MD2:
2359 mbedtls_md2_free( &operation->ctx.md2 );
2360 break;
2361#endif
2362#if defined(MBEDTLS_MD4_C)
2363 case PSA_ALG_MD4:
2364 mbedtls_md4_free( &operation->ctx.md4 );
2365 break;
2366#endif
2367#if defined(MBEDTLS_MD5_C)
2368 case PSA_ALG_MD5:
2369 mbedtls_md5_free( &operation->ctx.md5 );
2370 break;
2371#endif
2372#if defined(MBEDTLS_RIPEMD160_C)
2373 case PSA_ALG_RIPEMD160:
2374 mbedtls_ripemd160_free( &operation->ctx.ripemd160 );
2375 break;
2376#endif
2377#if defined(MBEDTLS_SHA1_C)
2378 case PSA_ALG_SHA_1:
2379 mbedtls_sha1_free( &operation->ctx.sha1 );
2380 break;
2381#endif
2382#if defined(MBEDTLS_SHA256_C)
2383 case PSA_ALG_SHA_224:
2384 case PSA_ALG_SHA_256:
2385 mbedtls_sha256_free( &operation->ctx.sha256 );
2386 break;
2387#endif
2388#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002389#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002390 case PSA_ALG_SHA_384:
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002391#endif
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002392 case PSA_ALG_SHA_512:
2393 mbedtls_sha512_free( &operation->ctx.sha512 );
2394 break;
2395#endif
2396 default:
Gilles Peskinef9c2c092018-06-21 16:57:07 +02002397 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002398 }
2399 operation->alg = 0;
2400 return( PSA_SUCCESS );
2401}
2402
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002403psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002404 psa_algorithm_t alg )
2405{
Janos Follath24eed8d2019-11-22 13:21:35 +00002406 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002407
2408 /* A context must be freshly initialized before it can be set up. */
2409 if( operation->alg != 0 )
2410 {
2411 return( PSA_ERROR_BAD_STATE );
2412 }
2413
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002414 switch( alg )
2415 {
2416#if defined(MBEDTLS_MD2_C)
2417 case PSA_ALG_MD2:
2418 mbedtls_md2_init( &operation->ctx.md2 );
2419 ret = mbedtls_md2_starts_ret( &operation->ctx.md2 );
2420 break;
2421#endif
2422#if defined(MBEDTLS_MD4_C)
2423 case PSA_ALG_MD4:
2424 mbedtls_md4_init( &operation->ctx.md4 );
2425 ret = mbedtls_md4_starts_ret( &operation->ctx.md4 );
2426 break;
2427#endif
2428#if defined(MBEDTLS_MD5_C)
2429 case PSA_ALG_MD5:
2430 mbedtls_md5_init( &operation->ctx.md5 );
2431 ret = mbedtls_md5_starts_ret( &operation->ctx.md5 );
2432 break;
2433#endif
2434#if defined(MBEDTLS_RIPEMD160_C)
2435 case PSA_ALG_RIPEMD160:
2436 mbedtls_ripemd160_init( &operation->ctx.ripemd160 );
2437 ret = mbedtls_ripemd160_starts_ret( &operation->ctx.ripemd160 );
2438 break;
2439#endif
2440#if defined(MBEDTLS_SHA1_C)
2441 case PSA_ALG_SHA_1:
2442 mbedtls_sha1_init( &operation->ctx.sha1 );
2443 ret = mbedtls_sha1_starts_ret( &operation->ctx.sha1 );
2444 break;
2445#endif
2446#if defined(MBEDTLS_SHA256_C)
2447 case PSA_ALG_SHA_224:
2448 mbedtls_sha256_init( &operation->ctx.sha256 );
2449 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 1 );
2450 break;
2451 case PSA_ALG_SHA_256:
2452 mbedtls_sha256_init( &operation->ctx.sha256 );
2453 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 0 );
2454 break;
2455#endif
2456#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002457#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002458 case PSA_ALG_SHA_384:
2459 mbedtls_sha512_init( &operation->ctx.sha512 );
2460 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 1 );
2461 break;
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002462#endif
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002463 case PSA_ALG_SHA_512:
2464 mbedtls_sha512_init( &operation->ctx.sha512 );
2465 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 0 );
2466 break;
2467#endif
2468 default:
Gilles Peskinec06e0712018-06-20 16:21:04 +02002469 return( PSA_ALG_IS_HASH( alg ) ?
2470 PSA_ERROR_NOT_SUPPORTED :
2471 PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002472 }
2473 if( ret == 0 )
2474 operation->alg = alg;
2475 else
2476 psa_hash_abort( operation );
2477 return( mbedtls_to_psa_error( ret ) );
2478}
2479
2480psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2481 const uint8_t *input,
2482 size_t input_length )
2483{
Janos Follath24eed8d2019-11-22 13:21:35 +00002484 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine94e44542018-07-12 16:58:43 +02002485
2486 /* Don't require hash implementations to behave correctly on a
2487 * zero-length input, which may have an invalid pointer. */
2488 if( input_length == 0 )
2489 return( PSA_SUCCESS );
2490
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002491 switch( operation->alg )
2492 {
2493#if defined(MBEDTLS_MD2_C)
2494 case PSA_ALG_MD2:
2495 ret = mbedtls_md2_update_ret( &operation->ctx.md2,
2496 input, input_length );
2497 break;
2498#endif
2499#if defined(MBEDTLS_MD4_C)
2500 case PSA_ALG_MD4:
2501 ret = mbedtls_md4_update_ret( &operation->ctx.md4,
2502 input, input_length );
2503 break;
2504#endif
2505#if defined(MBEDTLS_MD5_C)
2506 case PSA_ALG_MD5:
2507 ret = mbedtls_md5_update_ret( &operation->ctx.md5,
2508 input, input_length );
2509 break;
2510#endif
2511#if defined(MBEDTLS_RIPEMD160_C)
2512 case PSA_ALG_RIPEMD160:
2513 ret = mbedtls_ripemd160_update_ret( &operation->ctx.ripemd160,
2514 input, input_length );
2515 break;
2516#endif
2517#if defined(MBEDTLS_SHA1_C)
2518 case PSA_ALG_SHA_1:
2519 ret = mbedtls_sha1_update_ret( &operation->ctx.sha1,
2520 input, input_length );
2521 break;
2522#endif
2523#if defined(MBEDTLS_SHA256_C)
2524 case PSA_ALG_SHA_224:
2525 case PSA_ALG_SHA_256:
2526 ret = mbedtls_sha256_update_ret( &operation->ctx.sha256,
2527 input, input_length );
2528 break;
2529#endif
2530#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002531#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002532 case PSA_ALG_SHA_384:
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002533#endif
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002534 case PSA_ALG_SHA_512:
2535 ret = mbedtls_sha512_update_ret( &operation->ctx.sha512,
2536 input, input_length );
2537 break;
2538#endif
2539 default:
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002540 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002541 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002542
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002543 if( ret != 0 )
2544 psa_hash_abort( operation );
2545 return( mbedtls_to_psa_error( ret ) );
2546}
2547
2548psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2549 uint8_t *hash,
2550 size_t hash_size,
2551 size_t *hash_length )
2552{
itayzafrir40835d42018-08-02 13:14:17 +03002553 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00002554 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine71bb7b72018-04-19 08:29:59 +02002555 size_t actual_hash_length = PSA_HASH_SIZE( operation->alg );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002556
2557 /* Fill the output buffer with something that isn't a valid hash
2558 * (barring an attack on the hash and deliberately-crafted input),
2559 * in case the caller doesn't check the return status properly. */
Gilles Peskineaee13332018-07-02 12:15:28 +02002560 *hash_length = hash_size;
Gilles Peskine46f1fd72018-06-28 19:31:31 +02002561 /* If hash_size is 0 then hash may be NULL and then the
2562 * call to memset would have undefined behavior. */
2563 if( hash_size != 0 )
2564 memset( hash, '!', hash_size );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002565
2566 if( hash_size < actual_hash_length )
itayzafrir40835d42018-08-02 13:14:17 +03002567 {
2568 status = PSA_ERROR_BUFFER_TOO_SMALL;
2569 goto exit;
2570 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002571
2572 switch( operation->alg )
2573 {
2574#if defined(MBEDTLS_MD2_C)
2575 case PSA_ALG_MD2:
2576 ret = mbedtls_md2_finish_ret( &operation->ctx.md2, hash );
2577 break;
2578#endif
2579#if defined(MBEDTLS_MD4_C)
2580 case PSA_ALG_MD4:
2581 ret = mbedtls_md4_finish_ret( &operation->ctx.md4, hash );
2582 break;
2583#endif
2584#if defined(MBEDTLS_MD5_C)
2585 case PSA_ALG_MD5:
2586 ret = mbedtls_md5_finish_ret( &operation->ctx.md5, hash );
2587 break;
2588#endif
2589#if defined(MBEDTLS_RIPEMD160_C)
2590 case PSA_ALG_RIPEMD160:
2591 ret = mbedtls_ripemd160_finish_ret( &operation->ctx.ripemd160, hash );
2592 break;
2593#endif
2594#if defined(MBEDTLS_SHA1_C)
2595 case PSA_ALG_SHA_1:
2596 ret = mbedtls_sha1_finish_ret( &operation->ctx.sha1, hash );
2597 break;
2598#endif
2599#if defined(MBEDTLS_SHA256_C)
2600 case PSA_ALG_SHA_224:
2601 case PSA_ALG_SHA_256:
2602 ret = mbedtls_sha256_finish_ret( &operation->ctx.sha256, hash );
2603 break;
2604#endif
2605#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002606#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002607 case PSA_ALG_SHA_384:
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002608#endif
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002609 case PSA_ALG_SHA_512:
2610 ret = mbedtls_sha512_finish_ret( &operation->ctx.sha512, hash );
2611 break;
2612#endif
2613 default:
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002614 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002615 }
itayzafrir40835d42018-08-02 13:14:17 +03002616 status = mbedtls_to_psa_error( ret );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002617
itayzafrir40835d42018-08-02 13:14:17 +03002618exit:
2619 if( status == PSA_SUCCESS )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002620 {
Gilles Peskineaee13332018-07-02 12:15:28 +02002621 *hash_length = actual_hash_length;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002622 return( psa_hash_abort( operation ) );
2623 }
2624 else
2625 {
2626 psa_hash_abort( operation );
itayzafrir40835d42018-08-02 13:14:17 +03002627 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002628 }
2629}
2630
Gilles Peskine2d277862018-06-18 15:41:12 +02002631psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2632 const uint8_t *hash,
2633 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002634{
2635 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2636 size_t actual_hash_length;
2637 psa_status_t status = psa_hash_finish( operation,
2638 actual_hash, sizeof( actual_hash ),
2639 &actual_hash_length );
2640 if( status != PSA_SUCCESS )
2641 return( status );
2642 if( actual_hash_length != hash_length )
2643 return( PSA_ERROR_INVALID_SIGNATURE );
2644 if( safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
2645 return( PSA_ERROR_INVALID_SIGNATURE );
2646 return( PSA_SUCCESS );
2647}
2648
Gilles Peskine0a749c82019-11-28 19:33:58 +01002649psa_status_t psa_hash_compute( psa_algorithm_t alg,
2650 const uint8_t *input, size_t input_length,
2651 uint8_t *hash, size_t hash_size,
2652 size_t *hash_length )
2653{
2654 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
2655 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2656
2657 *hash_length = hash_size;
2658 status = psa_hash_setup( &operation, alg );
2659 if( status != PSA_SUCCESS )
2660 goto exit;
2661 status = psa_hash_update( &operation, input, input_length );
2662 if( status != PSA_SUCCESS )
2663 goto exit;
2664 status = psa_hash_finish( &operation, hash, hash_size, hash_length );
2665 if( status != PSA_SUCCESS )
2666 goto exit;
2667
2668exit:
2669 if( status == PSA_SUCCESS )
2670 status = psa_hash_abort( &operation );
2671 else
2672 psa_hash_abort( &operation );
2673 return( status );
2674}
2675
2676psa_status_t psa_hash_compare( psa_algorithm_t alg,
2677 const uint8_t *input, size_t input_length,
2678 const uint8_t *hash, size_t hash_length )
2679{
2680 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
2681 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2682
2683 status = psa_hash_setup( &operation, alg );
2684 if( status != PSA_SUCCESS )
2685 goto exit;
2686 status = psa_hash_update( &operation, input, input_length );
2687 if( status != PSA_SUCCESS )
2688 goto exit;
2689 status = psa_hash_verify( &operation, hash, hash_length );
2690 if( status != PSA_SUCCESS )
2691 goto exit;
2692
2693exit:
2694 if( status == PSA_SUCCESS )
2695 status = psa_hash_abort( &operation );
2696 else
2697 psa_hash_abort( &operation );
2698 return( status );
2699}
2700
Gilles Peskineeb35d782019-01-22 17:56:16 +01002701psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2702 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002703{
2704 if( target_operation->alg != 0 )
2705 return( PSA_ERROR_BAD_STATE );
2706
2707 switch( source_operation->alg )
2708 {
2709 case 0:
2710 return( PSA_ERROR_BAD_STATE );
2711#if defined(MBEDTLS_MD2_C)
2712 case PSA_ALG_MD2:
2713 mbedtls_md2_clone( &target_operation->ctx.md2,
2714 &source_operation->ctx.md2 );
2715 break;
2716#endif
2717#if defined(MBEDTLS_MD4_C)
2718 case PSA_ALG_MD4:
2719 mbedtls_md4_clone( &target_operation->ctx.md4,
2720 &source_operation->ctx.md4 );
2721 break;
2722#endif
2723#if defined(MBEDTLS_MD5_C)
2724 case PSA_ALG_MD5:
2725 mbedtls_md5_clone( &target_operation->ctx.md5,
2726 &source_operation->ctx.md5 );
2727 break;
2728#endif
2729#if defined(MBEDTLS_RIPEMD160_C)
2730 case PSA_ALG_RIPEMD160:
2731 mbedtls_ripemd160_clone( &target_operation->ctx.ripemd160,
2732 &source_operation->ctx.ripemd160 );
2733 break;
2734#endif
2735#if defined(MBEDTLS_SHA1_C)
2736 case PSA_ALG_SHA_1:
2737 mbedtls_sha1_clone( &target_operation->ctx.sha1,
2738 &source_operation->ctx.sha1 );
2739 break;
2740#endif
2741#if defined(MBEDTLS_SHA256_C)
2742 case PSA_ALG_SHA_224:
2743 case PSA_ALG_SHA_256:
2744 mbedtls_sha256_clone( &target_operation->ctx.sha256,
2745 &source_operation->ctx.sha256 );
2746 break;
2747#endif
2748#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002749#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002750 case PSA_ALG_SHA_384:
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002751#endif
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002752 case PSA_ALG_SHA_512:
2753 mbedtls_sha512_clone( &target_operation->ctx.sha512,
2754 &source_operation->ctx.sha512 );
2755 break;
2756#endif
2757 default:
2758 return( PSA_ERROR_NOT_SUPPORTED );
2759 }
2760
2761 target_operation->alg = source_operation->alg;
2762 return( PSA_SUCCESS );
2763}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002764
2765
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002766/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002767/* MAC */
2768/****************************************************************/
2769
Gilles Peskinedc2fc842018-03-07 16:42:59 +01002770static const mbedtls_cipher_info_t *mbedtls_cipher_info_from_psa(
Gilles Peskine8c9def32018-02-08 10:02:12 +01002771 psa_algorithm_t alg,
2772 psa_key_type_t key_type,
Gilles Peskine2d277862018-06-18 15:41:12 +02002773 size_t key_bits,
mohammad1603f4f0d612018-06-03 15:04:51 +03002774 mbedtls_cipher_id_t* cipher_id )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002775{
Gilles Peskine8c9def32018-02-08 10:02:12 +01002776 mbedtls_cipher_mode_t mode;
mohammad1603f4f0d612018-06-03 15:04:51 +03002777 mbedtls_cipher_id_t cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002778
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002779 if( PSA_ALG_IS_AEAD( alg ) )
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002780 alg = PSA_ALG_AEAD_WITH_TAG_LENGTH( alg, 0 );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002781
Gilles Peskine8c9def32018-02-08 10:02:12 +01002782 if( PSA_ALG_IS_CIPHER( alg ) || PSA_ALG_IS_AEAD( alg ) )
2783 {
Nir Sonnenscheine9664c32018-06-17 14:41:30 +03002784 switch( alg )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002785 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002786 case PSA_ALG_ARC4:
Gilles Peskine26869f22019-05-06 15:25:00 +02002787 case PSA_ALG_CHACHA20:
Gilles Peskine8c9def32018-02-08 10:02:12 +01002788 mode = MBEDTLS_MODE_STREAM;
2789 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002790 case PSA_ALG_CTR:
2791 mode = MBEDTLS_MODE_CTR;
2792 break;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002793 case PSA_ALG_CFB:
2794 mode = MBEDTLS_MODE_CFB;
2795 break;
2796 case PSA_ALG_OFB:
2797 mode = MBEDTLS_MODE_OFB;
2798 break;
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02002799 case PSA_ALG_ECB_NO_PADDING:
2800 mode = MBEDTLS_MODE_ECB;
2801 break;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002802 case PSA_ALG_CBC_NO_PADDING:
2803 mode = MBEDTLS_MODE_CBC;
2804 break;
2805 case PSA_ALG_CBC_PKCS7:
2806 mode = MBEDTLS_MODE_CBC;
2807 break;
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002808 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002809 mode = MBEDTLS_MODE_CCM;
2810 break;
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002811 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_GCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002812 mode = MBEDTLS_MODE_GCM;
2813 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02002814 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CHACHA20_POLY1305, 0 ):
2815 mode = MBEDTLS_MODE_CHACHAPOLY;
2816 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002817 default:
2818 return( NULL );
2819 }
2820 }
2821 else if( alg == PSA_ALG_CMAC )
2822 mode = MBEDTLS_MODE_ECB;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002823 else
2824 return( NULL );
2825
2826 switch( key_type )
2827 {
2828 case PSA_KEY_TYPE_AES:
mohammad1603f4f0d612018-06-03 15:04:51 +03002829 cipher_id_tmp = MBEDTLS_CIPHER_ID_AES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002830 break;
2831 case PSA_KEY_TYPE_DES:
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002832 /* key_bits is 64 for Single-DES, 128 for two-key Triple-DES,
2833 * and 192 for three-key Triple-DES. */
Gilles Peskine8c9def32018-02-08 10:02:12 +01002834 if( key_bits == 64 )
mohammad1603f4f0d612018-06-03 15:04:51 +03002835 cipher_id_tmp = MBEDTLS_CIPHER_ID_DES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002836 else
mohammad1603f4f0d612018-06-03 15:04:51 +03002837 cipher_id_tmp = MBEDTLS_CIPHER_ID_3DES;
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002838 /* mbedtls doesn't recognize two-key Triple-DES as an algorithm,
2839 * but two-key Triple-DES is functionally three-key Triple-DES
2840 * with K1=K3, so that's how we present it to mbedtls. */
2841 if( key_bits == 128 )
2842 key_bits = 192;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002843 break;
2844 case PSA_KEY_TYPE_CAMELLIA:
mohammad1603f4f0d612018-06-03 15:04:51 +03002845 cipher_id_tmp = MBEDTLS_CIPHER_ID_CAMELLIA;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002846 break;
2847 case PSA_KEY_TYPE_ARC4:
mohammad1603f4f0d612018-06-03 15:04:51 +03002848 cipher_id_tmp = MBEDTLS_CIPHER_ID_ARC4;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002849 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02002850 case PSA_KEY_TYPE_CHACHA20:
2851 cipher_id_tmp = MBEDTLS_CIPHER_ID_CHACHA20;
2852 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002853 default:
2854 return( NULL );
2855 }
mohammad1603f4f0d612018-06-03 15:04:51 +03002856 if( cipher_id != NULL )
mohammad160360a64d02018-06-03 17:20:42 +03002857 *cipher_id = cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002858
Jaeden Amero23bbb752018-06-26 14:16:54 +01002859 return( mbedtls_cipher_info_from_values( cipher_id_tmp,
2860 (int) key_bits, mode ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002861}
2862
Gilles Peskinea05219c2018-11-16 16:02:56 +01002863#if defined(MBEDTLS_MD_C)
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002864static size_t psa_get_hash_block_size( psa_algorithm_t alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002865{
Gilles Peskine2d277862018-06-18 15:41:12 +02002866 switch( alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002867 {
2868 case PSA_ALG_MD2:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002869 return( 16 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002870 case PSA_ALG_MD4:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002871 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002872 case PSA_ALG_MD5:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002873 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002874 case PSA_ALG_RIPEMD160:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002875 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002876 case PSA_ALG_SHA_1:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002877 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002878 case PSA_ALG_SHA_224:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002879 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002880 case PSA_ALG_SHA_256:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002881 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002882 case PSA_ALG_SHA_384:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002883 return( 128 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002884 case PSA_ALG_SHA_512:
Gilles Peskine2d277862018-06-18 15:41:12 +02002885 return( 128 );
2886 default:
2887 return( 0 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002888 }
2889}
Gilles Peskinea05219c2018-11-16 16:02:56 +01002890#endif /* MBEDTLS_MD_C */
Nir Sonnenschein0c9ec532018-06-07 13:27:47 +03002891
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002892/* Initialize the MAC operation structure. Once this function has been
2893 * called, psa_mac_abort can run and will do the right thing. */
2894static psa_status_t psa_mac_init( psa_mac_operation_t *operation,
2895 psa_algorithm_t alg )
2896{
2897 psa_status_t status = PSA_ERROR_NOT_SUPPORTED;
2898
2899 operation->alg = alg;
2900 operation->key_set = 0;
2901 operation->iv_set = 0;
2902 operation->iv_required = 0;
2903 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002904 operation->is_sign = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002905
2906#if defined(MBEDTLS_CMAC_C)
2907 if( alg == PSA_ALG_CMAC )
2908 {
2909 operation->iv_required = 0;
2910 mbedtls_cipher_init( &operation->ctx.cmac );
2911 status = PSA_SUCCESS;
2912 }
2913 else
2914#endif /* MBEDTLS_CMAC_C */
2915#if defined(MBEDTLS_MD_C)
2916 if( PSA_ALG_IS_HMAC( operation->alg ) )
2917 {
Gilles Peskineff94abd2018-07-12 17:07:52 +02002918 /* We'll set up the hash operation later in psa_hmac_setup_internal. */
2919 operation->ctx.hmac.hash_ctx.alg = 0;
2920 status = PSA_SUCCESS;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002921 }
2922 else
2923#endif /* MBEDTLS_MD_C */
2924 {
Gilles Peskinec06e0712018-06-20 16:21:04 +02002925 if( ! PSA_ALG_IS_MAC( alg ) )
2926 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002927 }
2928
2929 if( status != PSA_SUCCESS )
2930 memset( operation, 0, sizeof( *operation ) );
2931 return( status );
2932}
2933
Gilles Peskine01126fa2018-07-12 17:04:55 +02002934#if defined(MBEDTLS_MD_C)
2935static psa_status_t psa_hmac_abort_internal( psa_hmac_internal_data *hmac )
2936{
Gilles Peskine3f108122018-12-07 18:14:53 +01002937 mbedtls_platform_zeroize( hmac->opad, sizeof( hmac->opad ) );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002938 return( psa_hash_abort( &hmac->hash_ctx ) );
2939}
2940#endif /* MBEDTLS_MD_C */
2941
Gilles Peskine8c9def32018-02-08 10:02:12 +01002942psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
2943{
Gilles Peskinefbfac682018-07-08 20:51:54 +02002944 if( operation->alg == 0 )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002945 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02002946 /* The object has (apparently) been initialized but it is not
2947 * in use. It's ok to call abort on such an object, and there's
2948 * nothing to do. */
2949 return( PSA_SUCCESS );
2950 }
2951 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002952#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002953 if( operation->alg == PSA_ALG_CMAC )
2954 {
2955 mbedtls_cipher_free( &operation->ctx.cmac );
2956 }
2957 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002958#endif /* MBEDTLS_CMAC_C */
Gilles Peskine8c9def32018-02-08 10:02:12 +01002959#if defined(MBEDTLS_MD_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002960 if( PSA_ALG_IS_HMAC( operation->alg ) )
2961 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02002962 psa_hmac_abort_internal( &operation->ctx.hmac );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002963 }
2964 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002965#endif /* MBEDTLS_MD_C */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002966 {
2967 /* Sanity check (shouldn't happen: operation->alg should
2968 * always have been initialized to a valid value). */
2969 goto bad_state;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002970 }
Moran Peker41deec42018-04-04 15:43:05 +03002971
Gilles Peskine8c9def32018-02-08 10:02:12 +01002972 operation->alg = 0;
2973 operation->key_set = 0;
2974 operation->iv_set = 0;
2975 operation->iv_required = 0;
2976 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002977 operation->is_sign = 0;
Moran Peker41deec42018-04-04 15:43:05 +03002978
Gilles Peskine8c9def32018-02-08 10:02:12 +01002979 return( PSA_SUCCESS );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002980
2981bad_state:
2982 /* If abort is called on an uninitialized object, we can't trust
2983 * anything. Wipe the object in case it contains confidential data.
2984 * This may result in a memory leak if a pointer gets overwritten,
2985 * but it's too late to do anything about this. */
2986 memset( operation, 0, sizeof( *operation ) );
2987 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002988}
2989
Gilles Peskinee3b07d82018-06-19 11:57:35 +02002990#if defined(MBEDTLS_CMAC_C)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002991static int psa_cmac_setup( psa_mac_operation_t *operation,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002992 size_t key_bits,
Gilles Peskine2f060a82018-12-04 17:12:32 +01002993 psa_key_slot_t *slot,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002994 const mbedtls_cipher_info_t *cipher_info )
2995{
Janos Follath24eed8d2019-11-22 13:21:35 +00002996 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002997
2998 operation->mac_size = cipher_info->block_size;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002999
3000 ret = mbedtls_cipher_setup( &operation->ctx.cmac, cipher_info );
3001 if( ret != 0 )
3002 return( ret );
3003
3004 ret = mbedtls_cipher_cmac_starts( &operation->ctx.cmac,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02003005 slot->data.key.data,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003006 key_bits );
3007 return( ret );
3008}
Gilles Peskinee3b07d82018-06-19 11:57:35 +02003009#endif /* MBEDTLS_CMAC_C */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003010
Gilles Peskine248051a2018-06-20 16:09:38 +02003011#if defined(MBEDTLS_MD_C)
Gilles Peskine01126fa2018-07-12 17:04:55 +02003012static psa_status_t psa_hmac_setup_internal( psa_hmac_internal_data *hmac,
3013 const uint8_t *key,
3014 size_t key_length,
3015 psa_algorithm_t hash_alg )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003016{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02003017 uint8_t ipad[PSA_HMAC_MAX_HASH_BLOCK_SIZE];
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003018 size_t i;
Gilles Peskine9aa369e2018-07-16 00:36:29 +02003019 size_t hash_size = PSA_HASH_SIZE( hash_alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003020 size_t block_size = psa_get_hash_block_size( hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003021 psa_status_t status;
3022
Gilles Peskine9aa369e2018-07-16 00:36:29 +02003023 /* Sanity checks on block_size, to guarantee that there won't be a buffer
3024 * overflow below. This should never trigger if the hash algorithm
3025 * is implemented correctly. */
3026 /* The size checks against the ipad and opad buffers cannot be written
3027 * `block_size > sizeof( ipad ) || block_size > sizeof( hmac->opad )`
3028 * because that triggers -Wlogical-op on GCC 7.3. */
3029 if( block_size > sizeof( ipad ) )
3030 return( PSA_ERROR_NOT_SUPPORTED );
3031 if( block_size > sizeof( hmac->opad ) )
3032 return( PSA_ERROR_NOT_SUPPORTED );
3033 if( block_size < hash_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003034 return( PSA_ERROR_NOT_SUPPORTED );
3035
Gilles Peskined223b522018-06-11 18:12:58 +02003036 if( key_length > block_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003037 {
Gilles Peskine84b8fc82019-11-28 20:07:20 +01003038 status = psa_hash_compute( hash_alg, key, key_length,
3039 ipad, sizeof( ipad ), &key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003040 if( status != PSA_SUCCESS )
Gilles Peskineb8be2882018-07-17 16:24:34 +02003041 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003042 }
Gilles Peskine96889972018-07-12 17:07:03 +02003043 /* A 0-length key is not commonly used in HMAC when used as a MAC,
3044 * but it is permitted. It is common when HMAC is used in HKDF, for
3045 * example. Don't call `memcpy` in the 0-length because `key` could be
3046 * an invalid pointer which would make the behavior undefined. */
3047 else if( key_length != 0 )
Gilles Peskine01126fa2018-07-12 17:04:55 +02003048 memcpy( ipad, key, key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003049
Gilles Peskined223b522018-06-11 18:12:58 +02003050 /* ipad contains the key followed by garbage. Xor and fill with 0x36
3051 * to create the ipad value. */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003052 for( i = 0; i < key_length; i++ )
Gilles Peskined223b522018-06-11 18:12:58 +02003053 ipad[i] ^= 0x36;
3054 memset( ipad + key_length, 0x36, block_size - key_length );
3055
3056 /* Copy the key material from ipad to opad, flipping the requisite bits,
3057 * and filling the rest of opad with the requisite constant. */
3058 for( i = 0; i < key_length; i++ )
Gilles Peskine01126fa2018-07-12 17:04:55 +02003059 hmac->opad[i] = ipad[i] ^ 0x36 ^ 0x5C;
3060 memset( hmac->opad + key_length, 0x5C, block_size - key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003061
Gilles Peskine01126fa2018-07-12 17:04:55 +02003062 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003063 if( status != PSA_SUCCESS )
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003064 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003065
Gilles Peskine01126fa2018-07-12 17:04:55 +02003066 status = psa_hash_update( &hmac->hash_ctx, ipad, block_size );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003067
3068cleanup:
Steven Cooreman29149862020-08-05 15:43:42 +02003069 mbedtls_platform_zeroize( ipad, sizeof( ipad ) );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003070
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003071 return( status );
3072}
Gilles Peskine248051a2018-06-20 16:09:38 +02003073#endif /* MBEDTLS_MD_C */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003074
Gilles Peskine89167cb2018-07-08 20:12:23 +02003075static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01003076 psa_key_handle_t handle,
Gilles Peskine89167cb2018-07-08 20:12:23 +02003077 psa_algorithm_t alg,
3078 int is_sign )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003079{
Gilles Peskine8c9def32018-02-08 10:02:12 +01003080 psa_status_t status;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003081 psa_key_slot_t *slot;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003082 size_t key_bits;
Gilles Peskine89167cb2018-07-08 20:12:23 +02003083 psa_key_usage_t usage =
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003084 is_sign ? PSA_KEY_USAGE_SIGN_HASH : PSA_KEY_USAGE_VERIFY_HASH;
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02003085 uint8_t truncated = PSA_MAC_TRUNCATED_LENGTH( alg );
Gilles Peskinee0e9c7c2018-10-17 18:28:05 +02003086 psa_algorithm_t full_length_alg = PSA_ALG_FULL_LENGTH_MAC( alg );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003087
Jaeden Amero36ee5d02019-02-19 09:25:10 +00003088 /* A context must be freshly initialized before it can be set up. */
3089 if( operation->alg != 0 )
3090 {
3091 return( PSA_ERROR_BAD_STATE );
3092 }
3093
Gilles Peskined911eb72018-08-14 15:18:45 +02003094 status = psa_mac_init( operation, full_length_alg );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003095 if( status != PSA_SUCCESS )
3096 return( status );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003097 if( is_sign )
3098 operation->is_sign = 1;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003099
Gilles Peskine28f8f302019-07-24 13:30:31 +02003100 status = psa_get_transparent_key( handle, &slot, usage, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003101 if( status != PSA_SUCCESS )
Gilles Peskinefbfac682018-07-08 20:51:54 +02003102 goto exit;
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02003103 key_bits = psa_get_key_slot_bits( slot );
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02003104
Gilles Peskine8c9def32018-02-08 10:02:12 +01003105#if defined(MBEDTLS_CMAC_C)
Gilles Peskined911eb72018-08-14 15:18:45 +02003106 if( full_length_alg == PSA_ALG_CMAC )
Gilles Peskinefbfac682018-07-08 20:51:54 +02003107 {
3108 const mbedtls_cipher_info_t *cipher_info =
Gilles Peskined911eb72018-08-14 15:18:45 +02003109 mbedtls_cipher_info_from_psa( full_length_alg,
Gilles Peskine8e338702019-07-30 20:06:31 +02003110 slot->attr.type, key_bits, NULL );
Janos Follath24eed8d2019-11-22 13:21:35 +00003111 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinefbfac682018-07-08 20:51:54 +02003112 if( cipher_info == NULL )
3113 {
3114 status = PSA_ERROR_NOT_SUPPORTED;
3115 goto exit;
3116 }
3117 operation->mac_size = cipher_info->block_size;
3118 ret = psa_cmac_setup( operation, key_bits, slot, cipher_info );
3119 status = mbedtls_to_psa_error( ret );
3120 }
3121 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01003122#endif /* MBEDTLS_CMAC_C */
Gilles Peskine8c9def32018-02-08 10:02:12 +01003123#if defined(MBEDTLS_MD_C)
Gilles Peskined911eb72018-08-14 15:18:45 +02003124 if( PSA_ALG_IS_HMAC( full_length_alg ) )
Gilles Peskinefbfac682018-07-08 20:51:54 +02003125 {
Gilles Peskine00709fa2018-08-22 18:25:41 +02003126 psa_algorithm_t hash_alg = PSA_ALG_HMAC_GET_HASH( alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003127 if( hash_alg == 0 )
3128 {
3129 status = PSA_ERROR_NOT_SUPPORTED;
3130 goto exit;
3131 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02003132
3133 operation->mac_size = PSA_HASH_SIZE( hash_alg );
3134 /* Sanity check. This shouldn't fail on a valid configuration. */
3135 if( operation->mac_size == 0 ||
3136 operation->mac_size > sizeof( operation->ctx.hmac.opad ) )
3137 {
3138 status = PSA_ERROR_NOT_SUPPORTED;
3139 goto exit;
3140 }
3141
Gilles Peskine8e338702019-07-30 20:06:31 +02003142 if( slot->attr.type != PSA_KEY_TYPE_HMAC )
Gilles Peskine01126fa2018-07-12 17:04:55 +02003143 {
3144 status = PSA_ERROR_INVALID_ARGUMENT;
3145 goto exit;
3146 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02003147
Gilles Peskine01126fa2018-07-12 17:04:55 +02003148 status = psa_hmac_setup_internal( &operation->ctx.hmac,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02003149 slot->data.key.data,
3150 slot->data.key.bytes,
Gilles Peskine01126fa2018-07-12 17:04:55 +02003151 hash_alg );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003152 }
3153 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01003154#endif /* MBEDTLS_MD_C */
Gilles Peskinefbfac682018-07-08 20:51:54 +02003155 {
Jaeden Amero82df32e2018-11-23 15:11:20 +00003156 (void) key_bits;
Gilles Peskinefbfac682018-07-08 20:51:54 +02003157 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003158 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003159
Gilles Peskined911eb72018-08-14 15:18:45 +02003160 if( truncated == 0 )
3161 {
3162 /* The "normal" case: untruncated algorithm. Nothing to do. */
3163 }
3164 else if( truncated < 4 )
3165 {
Gilles Peskine6d72ff92018-08-21 14:55:08 +02003166 /* A very short MAC is too short for security since it can be
3167 * brute-forced. Ancient protocols with 32-bit MACs do exist,
3168 * so we make this our minimum, even though 32 bits is still
3169 * too small for security. */
Gilles Peskined911eb72018-08-14 15:18:45 +02003170 status = PSA_ERROR_NOT_SUPPORTED;
3171 }
3172 else if( truncated > operation->mac_size )
3173 {
3174 /* It's impossible to "truncate" to a larger length. */
3175 status = PSA_ERROR_INVALID_ARGUMENT;
3176 }
3177 else
3178 operation->mac_size = truncated;
3179
Gilles Peskinefbfac682018-07-08 20:51:54 +02003180exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003181 if( status != PSA_SUCCESS )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003182 {
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003183 psa_mac_abort( operation );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003184 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003185 else
3186 {
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003187 operation->key_set = 1;
3188 }
3189 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003190}
3191
Gilles Peskine89167cb2018-07-08 20:12:23 +02003192psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01003193 psa_key_handle_t handle,
Gilles Peskine89167cb2018-07-08 20:12:23 +02003194 psa_algorithm_t alg )
3195{
Gilles Peskinec5487a82018-12-03 18:08:14 +01003196 return( psa_mac_setup( operation, handle, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003197}
3198
3199psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01003200 psa_key_handle_t handle,
Gilles Peskine89167cb2018-07-08 20:12:23 +02003201 psa_algorithm_t alg )
3202{
Gilles Peskinec5487a82018-12-03 18:08:14 +01003203 return( psa_mac_setup( operation, handle, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003204}
3205
Gilles Peskine8c9def32018-02-08 10:02:12 +01003206psa_status_t psa_mac_update( psa_mac_operation_t *operation,
3207 const uint8_t *input,
3208 size_t input_length )
3209{
Gilles Peskinefbfac682018-07-08 20:51:54 +02003210 psa_status_t status = PSA_ERROR_BAD_STATE;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003211 if( ! operation->key_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003212 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003213 if( operation->iv_required && ! operation->iv_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003214 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003215 operation->has_input = 1;
3216
Gilles Peskine8c9def32018-02-08 10:02:12 +01003217#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003218 if( operation->alg == PSA_ALG_CMAC )
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03003219 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02003220 int ret = mbedtls_cipher_cmac_update( &operation->ctx.cmac,
3221 input, input_length );
3222 status = mbedtls_to_psa_error( ret );
3223 }
3224 else
3225#endif /* MBEDTLS_CMAC_C */
3226#if defined(MBEDTLS_MD_C)
3227 if( PSA_ALG_IS_HMAC( operation->alg ) )
3228 {
3229 status = psa_hash_update( &operation->ctx.hmac.hash_ctx, input,
3230 input_length );
3231 }
3232 else
3233#endif /* MBEDTLS_MD_C */
3234 {
3235 /* This shouldn't happen if `operation` was initialized by
3236 * a setup function. */
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003237 return( PSA_ERROR_BAD_STATE );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03003238 }
3239
Gilles Peskinefbfac682018-07-08 20:51:54 +02003240 if( status != PSA_SUCCESS )
3241 psa_mac_abort( operation );
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02003242 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003243}
3244
Gilles Peskine01126fa2018-07-12 17:04:55 +02003245#if defined(MBEDTLS_MD_C)
3246static psa_status_t psa_hmac_finish_internal( psa_hmac_internal_data *hmac,
3247 uint8_t *mac,
3248 size_t mac_size )
3249{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02003250 uint8_t tmp[MBEDTLS_MD_MAX_SIZE];
Gilles Peskine01126fa2018-07-12 17:04:55 +02003251 psa_algorithm_t hash_alg = hmac->hash_ctx.alg;
3252 size_t hash_size = 0;
3253 size_t block_size = psa_get_hash_block_size( hash_alg );
3254 psa_status_t status;
3255
Gilles Peskine01126fa2018-07-12 17:04:55 +02003256 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
3257 if( status != PSA_SUCCESS )
3258 return( status );
3259 /* From here on, tmp needs to be wiped. */
3260
3261 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
3262 if( status != PSA_SUCCESS )
3263 goto exit;
3264
3265 status = psa_hash_update( &hmac->hash_ctx, hmac->opad, block_size );
3266 if( status != PSA_SUCCESS )
3267 goto exit;
3268
3269 status = psa_hash_update( &hmac->hash_ctx, tmp, hash_size );
3270 if( status != PSA_SUCCESS )
3271 goto exit;
3272
Gilles Peskined911eb72018-08-14 15:18:45 +02003273 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
3274 if( status != PSA_SUCCESS )
3275 goto exit;
3276
3277 memcpy( mac, tmp, mac_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003278
3279exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01003280 mbedtls_platform_zeroize( tmp, hash_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003281 return( status );
3282}
3283#endif /* MBEDTLS_MD_C */
3284
mohammad16036df908f2018-04-02 08:34:15 -07003285static psa_status_t psa_mac_finish_internal( psa_mac_operation_t *operation,
Gilles Peskine2d277862018-06-18 15:41:12 +02003286 uint8_t *mac,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003287 size_t mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003288{
Gilles Peskine1d96fff2018-07-02 12:15:39 +02003289 if( ! operation->key_set )
3290 return( PSA_ERROR_BAD_STATE );
3291 if( operation->iv_required && ! operation->iv_set )
3292 return( PSA_ERROR_BAD_STATE );
3293
Gilles Peskine8c9def32018-02-08 10:02:12 +01003294 if( mac_size < operation->mac_size )
3295 return( PSA_ERROR_BUFFER_TOO_SMALL );
3296
Gilles Peskine8c9def32018-02-08 10:02:12 +01003297#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003298 if( operation->alg == PSA_ALG_CMAC )
3299 {
Gilles Peskined911eb72018-08-14 15:18:45 +02003300 uint8_t tmp[PSA_MAX_BLOCK_CIPHER_BLOCK_SIZE];
3301 int ret = mbedtls_cipher_cmac_finish( &operation->ctx.cmac, tmp );
3302 if( ret == 0 )
Gilles Peskine87b0ac42018-08-21 14:55:49 +02003303 memcpy( mac, tmp, operation->mac_size );
Gilles Peskine3f108122018-12-07 18:14:53 +01003304 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003305 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003306 }
Gilles Peskinefbfac682018-07-08 20:51:54 +02003307 else
3308#endif /* MBEDTLS_CMAC_C */
3309#if defined(MBEDTLS_MD_C)
3310 if( PSA_ALG_IS_HMAC( operation->alg ) )
3311 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02003312 return( psa_hmac_finish_internal( &operation->ctx.hmac,
Gilles Peskined911eb72018-08-14 15:18:45 +02003313 mac, operation->mac_size ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003314 }
3315 else
3316#endif /* MBEDTLS_MD_C */
3317 {
3318 /* This shouldn't happen if `operation` was initialized by
3319 * a setup function. */
3320 return( PSA_ERROR_BAD_STATE );
3321 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01003322}
3323
Gilles Peskineacd4be32018-07-08 19:56:25 +02003324psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
3325 uint8_t *mac,
3326 size_t mac_size,
3327 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07003328{
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003329 psa_status_t status;
3330
Jaeden Amero252ef282019-02-15 14:05:35 +00003331 if( operation->alg == 0 )
3332 {
3333 return( PSA_ERROR_BAD_STATE );
3334 }
3335
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003336 /* Fill the output buffer with something that isn't a valid mac
3337 * (barring an attack on the mac and deliberately-crafted input),
3338 * in case the caller doesn't check the return status properly. */
3339 *mac_length = mac_size;
3340 /* If mac_size is 0 then mac may be NULL and then the
3341 * call to memset would have undefined behavior. */
3342 if( mac_size != 0 )
3343 memset( mac, '!', mac_size );
3344
Gilles Peskine89167cb2018-07-08 20:12:23 +02003345 if( ! operation->is_sign )
3346 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003347 return( PSA_ERROR_BAD_STATE );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003348 }
mohammad16036df908f2018-04-02 08:34:15 -07003349
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003350 status = psa_mac_finish_internal( operation, mac, mac_size );
3351
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003352 if( status == PSA_SUCCESS )
3353 {
3354 status = psa_mac_abort( operation );
3355 if( status == PSA_SUCCESS )
3356 *mac_length = operation->mac_size;
3357 else
3358 memset( mac, '!', mac_size );
3359 }
3360 else
3361 psa_mac_abort( operation );
3362 return( status );
mohammad16036df908f2018-04-02 08:34:15 -07003363}
3364
Gilles Peskineacd4be32018-07-08 19:56:25 +02003365psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
3366 const uint8_t *mac,
3367 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003368{
Gilles Peskine828ed142018-06-18 23:25:51 +02003369 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
mohammad16036df908f2018-04-02 08:34:15 -07003370 psa_status_t status;
3371
Jaeden Amero252ef282019-02-15 14:05:35 +00003372 if( operation->alg == 0 )
3373 {
3374 return( PSA_ERROR_BAD_STATE );
3375 }
3376
Gilles Peskine89167cb2018-07-08 20:12:23 +02003377 if( operation->is_sign )
3378 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003379 return( PSA_ERROR_BAD_STATE );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003380 }
3381 if( operation->mac_size != mac_length )
3382 {
3383 status = PSA_ERROR_INVALID_SIGNATURE;
3384 goto cleanup;
Gilles Peskine89167cb2018-07-08 20:12:23 +02003385 }
mohammad16036df908f2018-04-02 08:34:15 -07003386
3387 status = psa_mac_finish_internal( operation,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003388 actual_mac, sizeof( actual_mac ) );
Gilles Peskine28cd4162020-01-20 16:31:06 +01003389 if( status != PSA_SUCCESS )
3390 goto cleanup;
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003391
3392 if( safer_memcmp( mac, actual_mac, mac_length ) != 0 )
3393 status = PSA_ERROR_INVALID_SIGNATURE;
3394
3395cleanup:
3396 if( status == PSA_SUCCESS )
3397 status = psa_mac_abort( operation );
3398 else
3399 psa_mac_abort( operation );
3400
Gilles Peskine3f108122018-12-07 18:14:53 +01003401 mbedtls_platform_zeroize( actual_mac, sizeof( actual_mac ) );
Gilles Peskined911eb72018-08-14 15:18:45 +02003402
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003403 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003404}
3405
3406
Gilles Peskine20035e32018-02-03 22:44:14 +01003407
Gilles Peskine20035e32018-02-03 22:44:14 +01003408/****************************************************************/
3409/* Asymmetric cryptography */
3410/****************************************************************/
3411
Gilles Peskine2b450e32018-06-27 15:42:46 +02003412#if defined(MBEDTLS_RSA_C)
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02003413/* Decode the hash algorithm from alg and store the mbedtls encoding in
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003414 * md_alg. Verify that the hash length is acceptable. */
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02003415static psa_status_t psa_rsa_decode_md_type( psa_algorithm_t alg,
3416 size_t hash_length,
3417 mbedtls_md_type_t *md_alg )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003418{
Gilles Peskine7ed29c52018-06-26 15:50:08 +02003419 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003420 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003421 *md_alg = mbedtls_md_get_type( md_info );
3422
3423 /* The Mbed TLS RSA module uses an unsigned int for hash length
3424 * parameters. Validate that it fits so that we don't risk an
3425 * overflow later. */
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003426#if SIZE_MAX > UINT_MAX
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003427 if( hash_length > UINT_MAX )
3428 return( PSA_ERROR_INVALID_ARGUMENT );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003429#endif
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003430
3431#if defined(MBEDTLS_PKCS1_V15)
3432 /* For PKCS#1 v1.5 signature, if using a hash, the hash length
3433 * must be correct. */
3434 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) &&
3435 alg != PSA_ALG_RSA_PKCS1V15_SIGN_RAW )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003436 {
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003437 if( md_info == NULL )
3438 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003439 if( mbedtls_md_get_size( md_info ) != hash_length )
3440 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003441 }
3442#endif /* MBEDTLS_PKCS1_V15 */
3443
3444#if defined(MBEDTLS_PKCS1_V21)
3445 /* PSS requires a hash internally. */
3446 if( PSA_ALG_IS_RSA_PSS( alg ) )
3447 {
Gilles Peskine61b91d42018-06-08 16:09:36 +02003448 if( md_info == NULL )
3449 return( PSA_ERROR_NOT_SUPPORTED );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003450 }
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003451#endif /* MBEDTLS_PKCS1_V21 */
3452
Gilles Peskine61b91d42018-06-08 16:09:36 +02003453 return( PSA_SUCCESS );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003454}
3455
Gilles Peskine2b450e32018-06-27 15:42:46 +02003456static psa_status_t psa_rsa_sign( mbedtls_rsa_context *rsa,
3457 psa_algorithm_t alg,
3458 const uint8_t *hash,
3459 size_t hash_length,
3460 uint8_t *signature,
3461 size_t signature_size,
3462 size_t *signature_length )
3463{
3464 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00003465 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003466 mbedtls_md_type_t md_alg;
3467
3468 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
3469 if( status != PSA_SUCCESS )
3470 return( status );
3471
Gilles Peskine630a18a2018-06-29 17:49:35 +02003472 if( signature_size < mbedtls_rsa_get_len( rsa ) )
Gilles Peskine2b450e32018-06-27 15:42:46 +02003473 return( PSA_ERROR_BUFFER_TOO_SMALL );
3474
3475#if defined(MBEDTLS_PKCS1_V15)
3476 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
3477 {
3478 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
3479 MBEDTLS_MD_NONE );
3480 ret = mbedtls_rsa_pkcs1_sign( rsa,
3481 mbedtls_ctr_drbg_random,
3482 &global_data.ctr_drbg,
3483 MBEDTLS_RSA_PRIVATE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003484 md_alg,
3485 (unsigned int) hash_length,
3486 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003487 signature );
3488 }
3489 else
3490#endif /* MBEDTLS_PKCS1_V15 */
3491#if defined(MBEDTLS_PKCS1_V21)
3492 if( PSA_ALG_IS_RSA_PSS( alg ) )
3493 {
3494 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3495 ret = mbedtls_rsa_rsassa_pss_sign( rsa,
3496 mbedtls_ctr_drbg_random,
3497 &global_data.ctr_drbg,
3498 MBEDTLS_RSA_PRIVATE,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003499 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003500 (unsigned int) hash_length,
3501 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003502 signature );
3503 }
3504 else
3505#endif /* MBEDTLS_PKCS1_V21 */
3506 {
3507 return( PSA_ERROR_INVALID_ARGUMENT );
3508 }
3509
3510 if( ret == 0 )
Gilles Peskine630a18a2018-06-29 17:49:35 +02003511 *signature_length = mbedtls_rsa_get_len( rsa );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003512 return( mbedtls_to_psa_error( ret ) );
3513}
3514
3515static psa_status_t psa_rsa_verify( mbedtls_rsa_context *rsa,
3516 psa_algorithm_t alg,
3517 const uint8_t *hash,
3518 size_t hash_length,
3519 const uint8_t *signature,
3520 size_t signature_length )
3521{
3522 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00003523 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003524 mbedtls_md_type_t md_alg;
3525
3526 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
3527 if( status != PSA_SUCCESS )
3528 return( status );
3529
Gilles Peskine89cc74f2019-09-12 22:08:23 +02003530 if( signature_length != mbedtls_rsa_get_len( rsa ) )
3531 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003532
3533#if defined(MBEDTLS_PKCS1_V15)
3534 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
3535 {
3536 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
3537 MBEDTLS_MD_NONE );
3538 ret = mbedtls_rsa_pkcs1_verify( rsa,
3539 mbedtls_ctr_drbg_random,
3540 &global_data.ctr_drbg,
3541 MBEDTLS_RSA_PUBLIC,
3542 md_alg,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003543 (unsigned int) hash_length,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003544 hash,
3545 signature );
3546 }
3547 else
3548#endif /* MBEDTLS_PKCS1_V15 */
3549#if defined(MBEDTLS_PKCS1_V21)
3550 if( PSA_ALG_IS_RSA_PSS( alg ) )
3551 {
3552 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3553 ret = mbedtls_rsa_rsassa_pss_verify( rsa,
3554 mbedtls_ctr_drbg_random,
3555 &global_data.ctr_drbg,
3556 MBEDTLS_RSA_PUBLIC,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003557 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003558 (unsigned int) hash_length,
3559 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003560 signature );
3561 }
3562 else
3563#endif /* MBEDTLS_PKCS1_V21 */
3564 {
3565 return( PSA_ERROR_INVALID_ARGUMENT );
3566 }
Gilles Peskineef12c632018-09-13 20:37:48 +02003567
3568 /* Mbed TLS distinguishes "invalid padding" from "valid padding but
3569 * the rest of the signature is invalid". This has little use in
3570 * practice and PSA doesn't report this distinction. */
3571 if( ret == MBEDTLS_ERR_RSA_INVALID_PADDING )
3572 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003573 return( mbedtls_to_psa_error( ret ) );
3574}
3575#endif /* MBEDTLS_RSA_C */
3576
John Durkopf87e3ae2020-10-26 15:25:23 -07003577#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003578/* `ecp` cannot be const because `ecp->grp` needs to be non-const
3579 * for mbedtls_ecdsa_sign() and mbedtls_ecdsa_sign_det()
3580 * (even though these functions don't modify it). */
3581static psa_status_t psa_ecdsa_sign( mbedtls_ecp_keypair *ecp,
3582 psa_algorithm_t alg,
3583 const uint8_t *hash,
3584 size_t hash_length,
3585 uint8_t *signature,
3586 size_t signature_size,
3587 size_t *signature_length )
3588{
Janos Follath24eed8d2019-11-22 13:21:35 +00003589 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003590 mbedtls_mpi r, s;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003591 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003592 mbedtls_mpi_init( &r );
3593 mbedtls_mpi_init( &s );
3594
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003595 if( signature_size < 2 * curve_bytes )
3596 {
3597 ret = MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL;
3598 goto cleanup;
3599 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003600
John Durkop0ea39e02020-10-13 19:58:20 -07003601#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003602 if( PSA_ALG_DSA_IS_DETERMINISTIC( alg ) )
3603 {
3604 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
3605 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3606 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
Darryl Green5e843fa2019-09-05 14:06:34 +01003607 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign_det_ext( &ecp->grp, &r, &s,
3608 &ecp->d, hash,
3609 hash_length, md_alg,
3610 mbedtls_ctr_drbg_random,
3611 &global_data.ctr_drbg ) );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003612 }
3613 else
John Durkop0ea39e02020-10-13 19:58:20 -07003614#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003615 {
Gilles Peskinea05219c2018-11-16 16:02:56 +01003616 (void) alg;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003617 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign( &ecp->grp, &r, &s, &ecp->d,
3618 hash, hash_length,
3619 mbedtls_ctr_drbg_random,
3620 &global_data.ctr_drbg ) );
3621 }
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003622
3623 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &r,
3624 signature,
3625 curve_bytes ) );
3626 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &s,
3627 signature + curve_bytes,
3628 curve_bytes ) );
3629
3630cleanup:
3631 mbedtls_mpi_free( &r );
3632 mbedtls_mpi_free( &s );
3633 if( ret == 0 )
3634 *signature_length = 2 * curve_bytes;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003635 return( mbedtls_to_psa_error( ret ) );
3636}
3637
3638static psa_status_t psa_ecdsa_verify( mbedtls_ecp_keypair *ecp,
3639 const uint8_t *hash,
3640 size_t hash_length,
3641 const uint8_t *signature,
3642 size_t signature_length )
3643{
Janos Follath24eed8d2019-11-22 13:21:35 +00003644 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003645 mbedtls_mpi r, s;
3646 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
3647 mbedtls_mpi_init( &r );
3648 mbedtls_mpi_init( &s );
3649
3650 if( signature_length != 2 * curve_bytes )
3651 return( PSA_ERROR_INVALID_SIGNATURE );
3652
3653 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &r,
3654 signature,
3655 curve_bytes ) );
3656 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &s,
3657 signature + curve_bytes,
3658 curve_bytes ) );
3659
Steven Cooremanacda8342020-07-24 23:09:52 +02003660 /* Check whether the public part is loaded. If not, load it. */
3661 if( mbedtls_ecp_is_zero( &ecp->Q ) )
3662 {
3663 MBEDTLS_MPI_CHK(
3664 mbedtls_ecp_mul( &ecp->grp, &ecp->Q, &ecp->d, &ecp->grp.G,
3665 mbedtls_ctr_drbg_random, &global_data.ctr_drbg ) );
3666 }
3667
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003668 ret = mbedtls_ecdsa_verify( &ecp->grp, hash, hash_length,
3669 &ecp->Q, &r, &s );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003670
3671cleanup:
3672 mbedtls_mpi_free( &r );
3673 mbedtls_mpi_free( &s );
3674 return( mbedtls_to_psa_error( ret ) );
3675}
John Durkopf87e3ae2020-10-26 15:25:23 -07003676#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003677
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003678psa_status_t psa_sign_hash( psa_key_handle_t handle,
3679 psa_algorithm_t alg,
3680 const uint8_t *hash,
3681 size_t hash_length,
3682 uint8_t *signature,
3683 size_t signature_size,
3684 size_t *signature_length )
Gilles Peskine20035e32018-02-03 22:44:14 +01003685{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003686 psa_key_slot_t *slot;
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003687 psa_status_t status;
3688
3689 *signature_length = signature_size;
Gilles Peskine4019f0e2019-09-12 22:05:59 +02003690 /* Immediately reject a zero-length signature buffer. This guarantees
3691 * that signature must be a valid pointer. (On the other hand, the hash
3692 * buffer can in principle be empty since it doesn't actually have
3693 * to be a hash.) */
3694 if( signature_size == 0 )
3695 return( PSA_ERROR_BUFFER_TOO_SMALL );
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003696
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003697 status = psa_get_key_from_slot( handle, &slot, PSA_KEY_USAGE_SIGN_HASH, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003698 if( status != PSA_SUCCESS )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003699 goto exit;
Gilles Peskine8e338702019-07-30 20:06:31 +02003700 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003701 {
3702 status = PSA_ERROR_INVALID_ARGUMENT;
3703 goto exit;
3704 }
Gilles Peskine20035e32018-02-03 22:44:14 +01003705
Steven Cooremancd84cb42020-07-16 20:28:36 +02003706 /* Try any of the available accelerators first */
3707 status = psa_driver_wrapper_sign_hash( slot,
3708 alg,
3709 hash,
3710 hash_length,
3711 signature,
3712 signature_size,
3713 signature_length );
Steven Cooreman8d2bde72020-09-04 13:06:39 +02003714 if( status != PSA_ERROR_NOT_SUPPORTED ||
3715 psa_key_lifetime_is_external( slot->attr.lifetime ) )
Steven Cooremancd84cb42020-07-16 20:28:36 +02003716 goto exit;
3717
Steven Cooreman7a250572020-07-17 16:43:05 +02003718 /* If the operation was not supported by any accelerator, try fallback. */
Gilles Peskine20035e32018-02-03 22:44:14 +01003719#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003720 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskine20035e32018-02-03 22:44:14 +01003721 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003722 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02003723
Steven Cooreman4fed4552020-08-03 14:46:03 +02003724 status = psa_load_rsa_representation( slot->attr.type,
3725 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02003726 slot->data.key.bytes,
Steven Cooremana01795d2020-07-24 22:48:15 +02003727 &rsa );
3728 if( status != PSA_SUCCESS )
3729 goto exit;
3730
Steven Cooremana2371e52020-07-28 14:30:39 +02003731 status = psa_rsa_sign( rsa,
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003732 alg,
3733 hash, hash_length,
3734 signature, signature_size,
3735 signature_length );
Steven Cooremana01795d2020-07-24 22:48:15 +02003736
Steven Cooremana2371e52020-07-28 14:30:39 +02003737 mbedtls_rsa_free( rsa );
3738 mbedtls_free( rsa );
Gilles Peskine20035e32018-02-03 22:44:14 +01003739 }
3740 else
3741#endif /* defined(MBEDTLS_RSA_C) */
3742#if defined(MBEDTLS_ECP_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003743 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
Gilles Peskine20035e32018-02-03 22:44:14 +01003744 {
John Durkop0ea39e02020-10-13 19:58:20 -07003745#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA)
Gilles Peskinea05219c2018-11-16 16:02:56 +01003746 if(
John Durkop0ea39e02020-10-13 19:58:20 -07003747#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea05219c2018-11-16 16:02:56 +01003748 PSA_ALG_IS_ECDSA( alg )
3749#else
3750 PSA_ALG_IS_RANDOMIZED_ECDSA( alg )
3751#endif
3752 )
Steven Cooremanacda8342020-07-24 23:09:52 +02003753 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003754 mbedtls_ecp_keypair *ecp = NULL;
Steven Cooreman4fed4552020-08-03 14:46:03 +02003755 status = psa_load_ecp_representation( slot->attr.type,
3756 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02003757 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02003758 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003759 if( status != PSA_SUCCESS )
3760 goto exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003761 status = psa_ecdsa_sign( ecp,
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003762 alg,
3763 hash, hash_length,
3764 signature, signature_size,
3765 signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02003766 mbedtls_ecp_keypair_free( ecp );
3767 mbedtls_free( ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003768 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003769 else
John Durkop0ea39e02020-10-13 19:58:20 -07003770#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003771 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003772 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003773 }
itayzafrir5c753392018-05-08 11:18:38 +03003774 }
3775 else
3776#endif /* defined(MBEDTLS_ECP_C) */
3777 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003778 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine20035e32018-02-03 22:44:14 +01003779 }
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003780
3781exit:
3782 /* Fill the unused part of the output buffer (the whole buffer on error,
3783 * the trailing part on success) with something that isn't a valid mac
3784 * (barring an attack on the mac and deliberately-crafted input),
3785 * in case the caller doesn't check the return status properly. */
3786 if( status == PSA_SUCCESS )
3787 memset( signature + *signature_length, '!',
3788 signature_size - *signature_length );
Gilles Peskine4019f0e2019-09-12 22:05:59 +02003789 else
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003790 memset( signature, '!', signature_size );
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003791 /* If signature_size is 0 then we have nothing to do. We must not call
3792 * memset because signature may be NULL in this case. */
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003793 return( status );
itayzafrir5c753392018-05-08 11:18:38 +03003794}
3795
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003796psa_status_t psa_verify_hash( psa_key_handle_t handle,
3797 psa_algorithm_t alg,
3798 const uint8_t *hash,
3799 size_t hash_length,
3800 const uint8_t *signature,
3801 size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03003802{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003803 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003804 psa_status_t status;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003805
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003806 status = psa_get_key_from_slot( handle, &slot, PSA_KEY_USAGE_VERIFY_HASH, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003807 if( status != PSA_SUCCESS )
3808 return( status );
itayzafrir5c753392018-05-08 11:18:38 +03003809
Steven Cooreman55ae2172020-07-17 19:46:15 +02003810 /* Try any of the available accelerators first */
3811 status = psa_driver_wrapper_verify_hash( slot,
3812 alg,
3813 hash,
3814 hash_length,
3815 signature,
3816 signature_length );
Steven Cooreman8d2bde72020-09-04 13:06:39 +02003817 if( status != PSA_ERROR_NOT_SUPPORTED ||
3818 psa_key_lifetime_is_external( slot->attr.lifetime ) )
Steven Cooreman55ae2172020-07-17 19:46:15 +02003819 return status;
3820
Gilles Peskine61b91d42018-06-08 16:09:36 +02003821#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003822 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003823 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003824 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02003825
Steven Cooreman4fed4552020-08-03 14:46:03 +02003826 status = psa_load_rsa_representation( slot->attr.type,
3827 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02003828 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02003829 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003830 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02003831 return( status );
Steven Cooremana01795d2020-07-24 22:48:15 +02003832
Steven Cooremana2371e52020-07-28 14:30:39 +02003833 status = psa_rsa_verify( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02003834 alg,
3835 hash, hash_length,
3836 signature, signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02003837 mbedtls_rsa_free( rsa );
3838 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003839 return( status );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003840 }
3841 else
3842#endif /* defined(MBEDTLS_RSA_C) */
itayzafrir5c753392018-05-08 11:18:38 +03003843#if defined(MBEDTLS_ECP_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003844 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
itayzafrir5c753392018-05-08 11:18:38 +03003845 {
John Durkopf87e3ae2020-10-26 15:25:23 -07003846#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003847 if( PSA_ALG_IS_ECDSA( alg ) )
Steven Cooremanacda8342020-07-24 23:09:52 +02003848 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003849 mbedtls_ecp_keypair *ecp = NULL;
Steven Cooreman4fed4552020-08-03 14:46:03 +02003850 status = psa_load_ecp_representation( slot->attr.type,
3851 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02003852 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02003853 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003854 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02003855 return( status );
Steven Cooremana2371e52020-07-28 14:30:39 +02003856 status = psa_ecdsa_verify( ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02003857 hash, hash_length,
3858 signature, signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02003859 mbedtls_ecp_keypair_free( ecp );
3860 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02003861 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02003862 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003863 else
John Durkopf87e3ae2020-10-26 15:25:23 -07003864#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003865 {
3866 return( PSA_ERROR_INVALID_ARGUMENT );
3867 }
itayzafrir5c753392018-05-08 11:18:38 +03003868 }
Gilles Peskine20035e32018-02-03 22:44:14 +01003869 else
3870#endif /* defined(MBEDTLS_ECP_C) */
3871 {
3872 return( PSA_ERROR_NOT_SUPPORTED );
3873 }
3874}
3875
Gilles Peskine072ac562018-06-30 00:21:29 +02003876#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PKCS1_V21)
3877static void psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
3878 mbedtls_rsa_context *rsa )
3879{
3880 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
3881 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3882 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
3883 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3884}
3885#endif /* defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PKCS1_V21) */
3886
Gilles Peskinec5487a82018-12-03 18:08:14 +01003887psa_status_t psa_asymmetric_encrypt( psa_key_handle_t handle,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003888 psa_algorithm_t alg,
3889 const uint8_t *input,
3890 size_t input_length,
3891 const uint8_t *salt,
3892 size_t salt_length,
3893 uint8_t *output,
3894 size_t output_size,
3895 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003896{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003897 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003898 psa_status_t status;
3899
Darryl Green5cc689a2018-07-24 15:34:10 +01003900 (void) input;
3901 (void) input_length;
3902 (void) salt;
3903 (void) output;
3904 (void) output_size;
3905
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003906 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003907
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003908 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3909 return( PSA_ERROR_INVALID_ARGUMENT );
3910
Gilles Peskine28f8f302019-07-24 13:30:31 +02003911 status = psa_get_transparent_key( handle, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003912 if( status != PSA_SUCCESS )
3913 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003914 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
3915 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003916 return( PSA_ERROR_INVALID_ARGUMENT );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003917
3918#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003919 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003920 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003921 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman4fed4552020-08-03 14:46:03 +02003922 status = psa_load_rsa_representation( slot->attr.type,
3923 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02003924 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02003925 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003926 if( status != PSA_SUCCESS )
Steven Cooreman4fed4552020-08-03 14:46:03 +02003927 goto rsa_exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003928
3929 if( output_size < mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003930 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003931 status = PSA_ERROR_BUFFER_TOO_SMALL;
3932 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003933 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003934#if defined(MBEDTLS_PKCS1_V15)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003935 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003936 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003937 status = mbedtls_to_psa_error(
3938 mbedtls_rsa_pkcs1_encrypt( rsa,
3939 mbedtls_ctr_drbg_random,
3940 &global_data.ctr_drbg,
3941 MBEDTLS_RSA_PUBLIC,
3942 input_length,
3943 input,
3944 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003945 }
3946 else
3947#endif /* MBEDTLS_PKCS1_V15 */
3948#if defined(MBEDTLS_PKCS1_V21)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003949 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003950 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003951 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02003952 status = mbedtls_to_psa_error(
3953 mbedtls_rsa_rsaes_oaep_encrypt( rsa,
3954 mbedtls_ctr_drbg_random,
3955 &global_data.ctr_drbg,
3956 MBEDTLS_RSA_PUBLIC,
3957 salt, salt_length,
3958 input_length,
3959 input,
3960 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003961 }
3962 else
3963#endif /* MBEDTLS_PKCS1_V21 */
3964 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003965 status = PSA_ERROR_INVALID_ARGUMENT;
3966 goto rsa_exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003967 }
Steven Cooreman4fed4552020-08-03 14:46:03 +02003968rsa_exit:
3969 if( status == PSA_SUCCESS )
Steven Cooremana2371e52020-07-28 14:30:39 +02003970 *output_length = mbedtls_rsa_get_len( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003971
Steven Cooremana2371e52020-07-28 14:30:39 +02003972 mbedtls_rsa_free( rsa );
3973 mbedtls_free( rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02003974 return( status );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003975 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003976 else
Gilles Peskineb75e4f12018-06-08 17:44:47 +02003977#endif /* defined(MBEDTLS_RSA_C) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003978 {
3979 return( PSA_ERROR_NOT_SUPPORTED );
3980 }
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003981}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003982
Gilles Peskinec5487a82018-12-03 18:08:14 +01003983psa_status_t psa_asymmetric_decrypt( psa_key_handle_t handle,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003984 psa_algorithm_t alg,
3985 const uint8_t *input,
3986 size_t input_length,
3987 const uint8_t *salt,
3988 size_t salt_length,
3989 uint8_t *output,
3990 size_t output_size,
3991 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003992{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003993 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003994 psa_status_t status;
3995
Darryl Green5cc689a2018-07-24 15:34:10 +01003996 (void) input;
3997 (void) input_length;
3998 (void) salt;
3999 (void) output;
4000 (void) output_size;
4001
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03004002 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004003
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02004004 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
4005 return( PSA_ERROR_INVALID_ARGUMENT );
4006
Gilles Peskine28f8f302019-07-24 13:30:31 +02004007 status = psa_get_transparent_key( handle, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004008 if( status != PSA_SUCCESS )
4009 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02004010 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004011 return( PSA_ERROR_INVALID_ARGUMENT );
4012
4013#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02004014 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004015 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004016 mbedtls_rsa_context *rsa = NULL;
4017 status = psa_load_rsa_representation( slot->attr.type,
4018 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02004019 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02004020 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02004021 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02004022 return( status );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004023
Steven Cooremana2371e52020-07-28 14:30:39 +02004024 if( input_length != mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02004025 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004026 status = PSA_ERROR_INVALID_ARGUMENT;
4027 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02004028 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004029
4030#if defined(MBEDTLS_PKCS1_V15)
Gilles Peskine6afe7892018-05-31 13:16:08 +02004031 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004032 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004033 status = mbedtls_to_psa_error(
4034 mbedtls_rsa_pkcs1_decrypt( rsa,
4035 mbedtls_ctr_drbg_random,
4036 &global_data.ctr_drbg,
4037 MBEDTLS_RSA_PRIVATE,
4038 output_length,
4039 input,
4040 output,
4041 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004042 }
4043 else
4044#endif /* MBEDTLS_PKCS1_V15 */
4045#if defined(MBEDTLS_PKCS1_V21)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02004046 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004047 {
Steven Cooremana2371e52020-07-28 14:30:39 +02004048 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02004049 status = mbedtls_to_psa_error(
4050 mbedtls_rsa_rsaes_oaep_decrypt( rsa,
4051 mbedtls_ctr_drbg_random,
4052 &global_data.ctr_drbg,
4053 MBEDTLS_RSA_PRIVATE,
4054 salt, salt_length,
4055 output_length,
4056 input,
4057 output,
4058 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004059 }
4060 else
4061#endif /* MBEDTLS_PKCS1_V21 */
4062 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004063 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004064 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03004065
Steven Cooreman4fed4552020-08-03 14:46:03 +02004066rsa_exit:
Steven Cooremana2371e52020-07-28 14:30:39 +02004067 mbedtls_rsa_free( rsa );
4068 mbedtls_free( rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02004069 return( status );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004070 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004071 else
Gilles Peskineb75e4f12018-06-08 17:44:47 +02004072#endif /* defined(MBEDTLS_RSA_C) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004073 {
4074 return( PSA_ERROR_NOT_SUPPORTED );
4075 }
Gilles Peskine5b051bc2018-05-31 13:25:48 +02004076}
Gilles Peskine20035e32018-02-03 22:44:14 +01004077
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004078
4079
mohammad1603503973b2018-03-12 15:59:30 +02004080/****************************************************************/
4081/* Symmetric cryptography */
4082/****************************************************************/
4083
Gilles Peskinee553c652018-06-04 16:22:46 +02004084static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01004085 psa_key_handle_t handle,
Gilles Peskine7e928852018-06-04 16:23:10 +02004086 psa_algorithm_t alg,
4087 mbedtls_operation_t cipher_operation )
mohammad1603503973b2018-03-12 15:59:30 +02004088{
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004089 int ret = 0;
4090 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Gilles Peskine2f060a82018-12-04 17:12:32 +01004091 psa_key_slot_t *slot;
mohammad1603503973b2018-03-12 15:59:30 +02004092 size_t key_bits;
4093 const mbedtls_cipher_info_t *cipher_info = NULL;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004094 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
4095 PSA_KEY_USAGE_ENCRYPT :
4096 PSA_KEY_USAGE_DECRYPT );
mohammad1603503973b2018-03-12 15:59:30 +02004097
Steven Cooremand3feccd2020-09-01 15:56:14 +02004098 /* A context must be freshly initialized before it can be set up. */
4099 if( operation->alg != 0 )
4100 return( PSA_ERROR_BAD_STATE );
4101
Steven Cooremana07b9972020-09-10 14:54:14 +02004102 /* The requested algorithm must be one that can be processed by cipher. */
4103 if( ! PSA_ALG_IS_CIPHER( alg ) )
Steven Cooremana07b9972020-09-10 14:54:14 +02004104 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremand3feccd2020-09-01 15:56:14 +02004105
Steven Cooremanef8575e2020-09-11 11:44:50 +02004106 /* Fetch key material from key storage. */
4107 status = psa_get_key_from_slot( handle, &slot, usage, alg );
4108 if( status != PSA_SUCCESS )
4109 goto exit;
4110
4111 /* Initialize the operation struct members, except for alg. The alg member
4112 * is used to indicate to psa_cipher_abort that there are resources to free,
4113 * so we only set it after resources have been allocated/initialized. */
Steven Cooremana07b9972020-09-10 14:54:14 +02004114 operation->key_set = 0;
4115 operation->iv_set = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004116 operation->mbedtls_in_use = 0;
Steven Cooremana07b9972020-09-10 14:54:14 +02004117 operation->iv_size = 0;
4118 operation->block_size = 0;
4119 if( alg == PSA_ALG_ECB_NO_PADDING )
4120 operation->iv_required = 0;
4121 else
4122 operation->iv_required = 1;
4123
Steven Cooremana07b9972020-09-10 14:54:14 +02004124 /* Try doing the operation through a driver before using software fallback. */
Steven Cooreman37941cb2020-07-28 18:49:51 +02004125 if( cipher_operation == MBEDTLS_ENCRYPT )
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004126 status = psa_driver_wrapper_cipher_encrypt_setup( &operation->ctx.driver,
Steven Cooreman37941cb2020-07-28 18:49:51 +02004127 slot,
4128 alg );
4129 else
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004130 status = psa_driver_wrapper_cipher_decrypt_setup( &operation->ctx.driver,
Steven Cooreman37941cb2020-07-28 18:49:51 +02004131 slot,
4132 alg );
4133
Steven Cooremanef8575e2020-09-11 11:44:50 +02004134 if( status == PSA_SUCCESS )
Steven Cooreman6d81f7e2020-09-14 13:14:31 +02004135 {
Steven Cooremanef8575e2020-09-11 11:44:50 +02004136 /* Once the driver context is initialised, it needs to be freed using
4137 * psa_cipher_abort. Indicate this through setting alg. */
4138 operation->alg = alg;
Steven Cooreman6d81f7e2020-09-14 13:14:31 +02004139 }
Steven Cooremanef8575e2020-09-11 11:44:50 +02004140
Steven Cooremand3feccd2020-09-01 15:56:14 +02004141 if( status != PSA_ERROR_NOT_SUPPORTED ||
4142 psa_key_lifetime_is_external( slot->attr.lifetime ) )
4143 goto exit;
4144
Steven Cooremana07b9972020-09-10 14:54:14 +02004145 /* Proceed with initializing an mbed TLS cipher context if no driver is
Steven Cooremand3feccd2020-09-01 15:56:14 +02004146 * available for the given algorithm & key. */
4147 mbedtls_cipher_init( &operation->ctx.cipher );
mohammad1603503973b2018-03-12 15:59:30 +02004148
Steven Cooremana07b9972020-09-10 14:54:14 +02004149 /* Once the cipher context is initialised, it needs to be freed using
Steven Cooremanef8575e2020-09-11 11:44:50 +02004150 * psa_cipher_abort. Indicate there is something to be freed through setting
4151 * alg, and indicate the operation is being done using mbedtls crypto through
4152 * setting mbedtls_in_use. */
Steven Cooremana07b9972020-09-10 14:54:14 +02004153 operation->alg = alg;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004154 operation->mbedtls_in_use = 1;
Steven Cooremana07b9972020-09-10 14:54:14 +02004155
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02004156 key_bits = psa_get_key_slot_bits( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +02004157 cipher_info = mbedtls_cipher_info_from_psa( alg, slot->attr.type, key_bits, NULL );
mohammad1603503973b2018-03-12 15:59:30 +02004158 if( cipher_info == NULL )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004159 {
4160 status = PSA_ERROR_NOT_SUPPORTED;
4161 goto exit;
4162 }
mohammad1603503973b2018-03-12 15:59:30 +02004163
mohammad1603503973b2018-03-12 15:59:30 +02004164 ret = mbedtls_cipher_setup( &operation->ctx.cipher, cipher_info );
Moran Peker41deec42018-04-04 15:43:05 +03004165 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004166 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004167
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004168#if defined(MBEDTLS_DES_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02004169 if( slot->attr.type == PSA_KEY_TYPE_DES && key_bits == 128 )
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004170 {
4171 /* Two-key Triple-DES is 3-key Triple-DES with K1=K3 */
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02004172 uint8_t keys[24];
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004173 memcpy( keys, slot->data.key.data, 16 );
4174 memcpy( keys + 16, slot->data.key.data, 8 );
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004175 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
4176 keys,
4177 192, cipher_operation );
4178 }
4179 else
4180#endif
4181 {
4182 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004183 slot->data.key.data,
Jaeden Amero23bbb752018-06-26 14:16:54 +01004184 (int) key_bits, cipher_operation );
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004185 }
Moran Peker41deec42018-04-04 15:43:05 +03004186 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004187 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004188
mohammad16038481e742018-03-18 13:57:31 +02004189#if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004190 switch( alg )
mohammad16038481e742018-03-18 13:57:31 +02004191 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004192 case PSA_ALG_CBC_NO_PADDING:
4193 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
4194 MBEDTLS_PADDING_NONE );
4195 break;
4196 case PSA_ALG_CBC_PKCS7:
4197 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
4198 MBEDTLS_PADDING_PKCS7 );
4199 break;
4200 default:
4201 /* The algorithm doesn't involve padding. */
4202 ret = 0;
4203 break;
4204 }
4205 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004206 goto exit;
mohammad16038481e742018-03-18 13:57:31 +02004207#endif //MBEDTLS_CIPHER_MODE_WITH_PADDING
4208
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004209 operation->block_size = ( PSA_ALG_IS_STREAM_CIPHER( alg ) ? 1 :
Gilles Peskine8e338702019-07-30 20:06:31 +02004210 PSA_BLOCK_CIPHER_BLOCK_SIZE( slot->attr.type ) );
Steven Cooremana6033e92020-08-25 11:47:50 +02004211 if( ( alg & PSA_ALG_CIPHER_FROM_BLOCK_FLAG ) != 0 &&
4212 alg != PSA_ALG_ECB_NO_PADDING )
mohammad16038481e742018-03-18 13:57:31 +02004213 {
Gilles Peskine8e338702019-07-30 20:06:31 +02004214 operation->iv_size = PSA_BLOCK_CIPHER_BLOCK_SIZE( slot->attr.type );
mohammad16038481e742018-03-18 13:57:31 +02004215 }
Gilles Peskine26869f22019-05-06 15:25:00 +02004216#if defined(MBEDTLS_CHACHA20_C)
4217 else
4218 if( alg == PSA_ALG_CHACHA20 )
4219 operation->iv_size = 12;
4220#endif
mohammad1603503973b2018-03-12 15:59:30 +02004221
Steven Cooreman7df02922020-09-09 15:28:49 +02004222 status = PSA_SUCCESS;
4223
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004224exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02004225 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004226 status = mbedtls_to_psa_error( ret );
Steven Cooreman7df02922020-09-09 15:28:49 +02004227 if( status == PSA_SUCCESS )
4228 {
4229 /* Update operation flags for both driver and software implementations */
4230 operation->key_set = 1;
4231 }
4232 else
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004233 psa_cipher_abort( operation );
4234 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004235}
4236
Gilles Peskinefe119512018-07-08 21:39:34 +02004237psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01004238 psa_key_handle_t handle,
Gilles Peskinefe119512018-07-08 21:39:34 +02004239 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02004240{
Gilles Peskinec5487a82018-12-03 18:08:14 +01004241 return( psa_cipher_setup( operation, handle, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02004242}
4243
Gilles Peskinefe119512018-07-08 21:39:34 +02004244psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01004245 psa_key_handle_t handle,
Gilles Peskinefe119512018-07-08 21:39:34 +02004246 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02004247{
Gilles Peskinec5487a82018-12-03 18:08:14 +01004248 return( psa_cipher_setup( operation, handle, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02004249}
4250
Gilles Peskinefe119512018-07-08 21:39:34 +02004251psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004252 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02004253 size_t iv_size,
4254 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02004255{
itayzafrir534bd7c2018-08-02 13:56:32 +03004256 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00004257 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooreman7df02922020-09-09 15:28:49 +02004258 if( operation->iv_set || ! operation->iv_required )
4259 {
4260 return( PSA_ERROR_BAD_STATE );
4261 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004262
Steven Cooremanef8575e2020-09-11 11:44:50 +02004263 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004264 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004265 status = psa_driver_wrapper_cipher_generate_iv( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004266 iv,
4267 iv_size,
4268 iv_length );
4269 goto exit;
4270 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004271
Moran Peker41deec42018-04-04 15:43:05 +03004272 if( iv_size < operation->iv_size )
mohammad1603503973b2018-03-12 15:59:30 +02004273 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004274 status = PSA_ERROR_BUFFER_TOO_SMALL;
Moran Peker41deec42018-04-04 15:43:05 +03004275 goto exit;
4276 }
Gilles Peskine7e928852018-06-04 16:23:10 +02004277 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg,
4278 iv, operation->iv_size );
Moran Peker41deec42018-04-04 15:43:05 +03004279 if( ret != 0 )
4280 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004281 status = mbedtls_to_psa_error( ret );
Gilles Peskinee553c652018-06-04 16:22:46 +02004282 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004283 }
Gilles Peskinee553c652018-06-04 16:22:46 +02004284
mohammad16038481e742018-03-18 13:57:31 +02004285 *iv_length = operation->iv_size;
itayzafrir534bd7c2018-08-02 13:56:32 +03004286 status = psa_cipher_set_iv( operation, iv, *iv_length );
Moran Peker41deec42018-04-04 15:43:05 +03004287
Moran Peker395db872018-05-31 14:07:14 +03004288exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02004289 if( status == PSA_SUCCESS )
4290 operation->iv_set = 1;
4291 else
Moran Peker395db872018-05-31 14:07:14 +03004292 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004293 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004294}
4295
Gilles Peskinefe119512018-07-08 21:39:34 +02004296psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004297 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02004298 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02004299{
itayzafrir534bd7c2018-08-02 13:56:32 +03004300 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00004301 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooreman7df02922020-09-09 15:28:49 +02004302 if( operation->iv_set || ! operation->iv_required )
4303 {
4304 return( PSA_ERROR_BAD_STATE );
4305 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004306
Steven Cooremanef8575e2020-09-11 11:44:50 +02004307 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004308 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004309 status = psa_driver_wrapper_cipher_set_iv( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004310 iv,
4311 iv_length );
4312 goto exit;
4313 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004314
Moran Pekera28258c2018-05-29 16:25:04 +03004315 if( iv_length != operation->iv_size )
Moran Peker71f19ae2018-04-22 20:23:16 +03004316 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004317 status = PSA_ERROR_INVALID_ARGUMENT;
4318 goto exit;
Moran Peker71f19ae2018-04-22 20:23:16 +03004319 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004320 ret = mbedtls_cipher_set_iv( &operation->ctx.cipher, iv, iv_length );
4321 status = mbedtls_to_psa_error( ret );
4322exit:
4323 if( status == PSA_SUCCESS )
4324 operation->iv_set = 1;
4325 else
mohammad1603503973b2018-03-12 15:59:30 +02004326 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004327 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004328}
4329
Steven Cooreman177deba2020-09-07 17:14:14 +02004330/* Process input for which the algorithm is set to ECB mode. This requires
4331 * manual processing, since the PSA API is defined as being able to process
4332 * arbitrary-length calls to psa_cipher_update() with ECB mode, but the
4333 * underlying mbedtls_cipher_update only takes full blocks. */
4334static psa_status_t psa_cipher_update_ecb_internal(
4335 mbedtls_cipher_context_t *ctx,
4336 const uint8_t *input,
4337 size_t input_length,
4338 uint8_t *output,
4339 size_t output_size,
4340 size_t *output_length )
4341{
4342 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4343 size_t block_size = ctx->cipher_info->block_size;
4344 size_t internal_output_length = 0;
4345 *output_length = 0;
4346
4347 if( input_length == 0 )
4348 {
4349 status = PSA_SUCCESS;
4350 goto exit;
4351 }
4352
4353 if( ctx->unprocessed_len > 0 )
4354 {
4355 /* Fill up to block size, and run the block if there's a full one. */
4356 size_t bytes_to_copy = block_size - ctx->unprocessed_len;
4357
4358 if( input_length < bytes_to_copy )
4359 bytes_to_copy = input_length;
4360
4361 memcpy( &( ctx->unprocessed_data[ctx->unprocessed_len] ),
4362 input, bytes_to_copy );
4363 input_length -= bytes_to_copy;
4364 input += bytes_to_copy;
4365 ctx->unprocessed_len += bytes_to_copy;
4366
4367 if( ctx->unprocessed_len == block_size )
4368 {
4369 status = mbedtls_to_psa_error(
4370 mbedtls_cipher_update( ctx,
4371 ctx->unprocessed_data,
4372 block_size,
4373 output, &internal_output_length ) );
4374
4375 if( status != PSA_SUCCESS )
4376 goto exit;
4377
4378 output += internal_output_length;
4379 output_size -= internal_output_length;
4380 *output_length += internal_output_length;
4381 ctx->unprocessed_len = 0;
4382 }
4383 }
4384
4385 while( input_length >= block_size )
4386 {
4387 /* Run all full blocks we have, one by one */
4388 status = mbedtls_to_psa_error(
4389 mbedtls_cipher_update( ctx, input,
4390 block_size,
4391 output, &internal_output_length ) );
4392
4393 if( status != PSA_SUCCESS )
4394 goto exit;
4395
4396 input_length -= block_size;
4397 input += block_size;
4398
4399 output += internal_output_length;
4400 output_size -= internal_output_length;
4401 *output_length += internal_output_length;
4402 }
4403
4404 if( input_length > 0 )
4405 {
4406 /* Save unprocessed bytes for later processing */
4407 memcpy( &( ctx->unprocessed_data[ctx->unprocessed_len] ),
4408 input, input_length );
4409 ctx->unprocessed_len += input_length;
4410 }
4411
4412 status = PSA_SUCCESS;
4413
4414exit:
4415 return( status );
4416}
4417
Gilles Peskinee553c652018-06-04 16:22:46 +02004418psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
4419 const uint8_t *input,
4420 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004421 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02004422 size_t output_size,
4423 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02004424{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004425 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine89d789c2018-06-04 17:17:16 +02004426 size_t expected_output_size;
Steven Cooreman7df02922020-09-09 15:28:49 +02004427 if( operation->alg == 0 )
4428 {
4429 return( PSA_ERROR_BAD_STATE );
4430 }
4431 if( operation->iv_required && ! operation->iv_set )
4432 {
4433 return( PSA_ERROR_BAD_STATE );
4434 }
Jaeden Ameroab439972019-02-15 14:12:05 +00004435
Steven Cooremanef8575e2020-09-11 11:44:50 +02004436 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004437 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004438 status = psa_driver_wrapper_cipher_update( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004439 input,
4440 input_length,
4441 output,
4442 output_size,
4443 output_length );
4444 goto exit;
4445 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004446
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004447 if( ! PSA_ALG_IS_STREAM_CIPHER( operation->alg ) )
Gilles Peskine89d789c2018-06-04 17:17:16 +02004448 {
4449 /* Take the unprocessed partial block left over from previous
4450 * update calls, if any, plus the input to this call. Remove
4451 * the last partial block, if any. You get the data that will be
4452 * output in this call. */
4453 expected_output_size =
4454 ( operation->ctx.cipher.unprocessed_len + input_length )
4455 / operation->block_size * operation->block_size;
4456 }
4457 else
4458 {
4459 expected_output_size = input_length;
4460 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004461
Gilles Peskine89d789c2018-06-04 17:17:16 +02004462 if( output_size < expected_output_size )
itayzafrir534bd7c2018-08-02 13:56:32 +03004463 {
4464 status = PSA_ERROR_BUFFER_TOO_SMALL;
4465 goto exit;
4466 }
mohammad160382759612018-03-12 18:16:40 +02004467
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004468 if( operation->alg == PSA_ALG_ECB_NO_PADDING )
4469 {
4470 /* mbedtls_cipher_update has an API inconsistency: it will only
4471 * process a single block at a time in ECB mode. Abstract away that
4472 * inconsistency here to match the PSA API behaviour. */
Steven Cooreman177deba2020-09-07 17:14:14 +02004473 status = psa_cipher_update_ecb_internal( &operation->ctx.cipher,
4474 input,
4475 input_length,
4476 output,
4477 output_size,
4478 output_length );
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004479 }
4480 else
4481 {
4482 status = mbedtls_to_psa_error(
4483 mbedtls_cipher_update( &operation->ctx.cipher, input,
4484 input_length, output, output_length ) );
4485 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004486exit:
4487 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02004488 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004489 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004490}
4491
Gilles Peskinee553c652018-06-04 16:22:46 +02004492psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
4493 uint8_t *output,
4494 size_t output_size,
4495 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02004496{
David Saadab4ecc272019-02-14 13:48:10 +02004497 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Gilles Peskinee553c652018-06-04 16:22:46 +02004498 uint8_t temp_output_buffer[MBEDTLS_MAX_BLOCK_LENGTH];
Steven Cooreman7df02922020-09-09 15:28:49 +02004499 if( operation->alg == 0 )
4500 {
4501 return( PSA_ERROR_BAD_STATE );
4502 }
4503 if( operation->iv_required && ! operation->iv_set )
4504 {
4505 return( PSA_ERROR_BAD_STATE );
4506 }
Moran Pekerbed71a22018-04-22 20:19:20 +03004507
Steven Cooremanef8575e2020-09-11 11:44:50 +02004508 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004509 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004510 status = psa_driver_wrapper_cipher_finish( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004511 output,
4512 output_size,
4513 output_length );
Steven Cooremanef8575e2020-09-11 11:44:50 +02004514 goto exit;
Steven Cooreman8b122252020-09-03 15:30:32 +02004515 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004516
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004517 if( operation->ctx.cipher.unprocessed_len != 0 )
Moran Peker7cb22b82018-06-05 11:40:02 +03004518 {
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004519 if( operation->alg == PSA_ALG_ECB_NO_PADDING ||
Fredrik Strupef90e3012020-09-28 16:11:33 +02004520 operation->alg == PSA_ALG_CBC_NO_PADDING )
Steven Cooremana6033e92020-08-25 11:47:50 +02004521 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004522 status = PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004523 goto exit;
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004524 }
Moran Pekerdc38ebc2018-04-30 15:45:34 +03004525 }
4526
Steven Cooremanef8575e2020-09-11 11:44:50 +02004527 status = mbedtls_to_psa_error(
4528 mbedtls_cipher_finish( &operation->ctx.cipher,
4529 temp_output_buffer,
4530 output_length ) );
4531 if( status != PSA_SUCCESS )
4532 goto exit;
Janos Follath315b51c2018-07-09 16:04:51 +01004533
Gilles Peskine46f1fd72018-06-28 19:31:31 +02004534 if( *output_length == 0 )
Janos Follath315b51c2018-07-09 16:04:51 +01004535 ; /* Nothing to copy. Note that output may be NULL in this case. */
Gilles Peskine46f1fd72018-06-28 19:31:31 +02004536 else if( output_size >= *output_length )
Moran Pekerdc38ebc2018-04-30 15:45:34 +03004537 memcpy( output, temp_output_buffer, *output_length );
4538 else
Janos Follath315b51c2018-07-09 16:04:51 +01004539 status = PSA_ERROR_BUFFER_TOO_SMALL;
mohammad1603503973b2018-03-12 15:59:30 +02004540
Steven Cooremanef8575e2020-09-11 11:44:50 +02004541exit:
4542 if( operation->mbedtls_in_use == 1 )
4543 mbedtls_platform_zeroize( temp_output_buffer, sizeof( temp_output_buffer ) );
Janos Follath315b51c2018-07-09 16:04:51 +01004544
Steven Cooremanef8575e2020-09-11 11:44:50 +02004545 if( status == PSA_SUCCESS )
4546 return( psa_cipher_abort( operation ) );
4547 else
4548 {
4549 *output_length = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004550 (void) psa_cipher_abort( operation );
Janos Follath315b51c2018-07-09 16:04:51 +01004551
Steven Cooremanef8575e2020-09-11 11:44:50 +02004552 return( status );
4553 }
mohammad1603503973b2018-03-12 15:59:30 +02004554}
4555
Gilles Peskinee553c652018-06-04 16:22:46 +02004556psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
4557{
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004558 if( operation->alg == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02004559 {
Steven Cooremana07b9972020-09-10 14:54:14 +02004560 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02004561 * in use. It's ok to call abort on such an object, and there's
4562 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004563 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02004564 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004565
Gilles Peskinef9c2c092018-06-21 16:57:07 +02004566 /* Sanity check (shouldn't happen: operation->alg should
4567 * always have been initialized to a valid value). */
4568 if( ! PSA_ALG_IS_CIPHER( operation->alg ) )
4569 return( PSA_ERROR_BAD_STATE );
4570
Steven Cooremanef8575e2020-09-11 11:44:50 +02004571 if( operation->mbedtls_in_use == 0 )
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004572 psa_driver_wrapper_cipher_abort( &operation->ctx.driver );
Steven Cooremand3feccd2020-09-01 15:56:14 +02004573 else
4574 mbedtls_cipher_free( &operation->ctx.cipher );
Gilles Peskinee553c652018-06-04 16:22:46 +02004575
Moran Peker41deec42018-04-04 15:43:05 +03004576 operation->alg = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004577 operation->key_set = 0;
4578 operation->iv_set = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004579 operation->mbedtls_in_use = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004580 operation->iv_size = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004581 operation->block_size = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004582 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004583
Moran Peker395db872018-05-31 14:07:14 +03004584 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02004585}
4586
Gilles Peskinea0655c32018-04-30 17:06:50 +02004587
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004588
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004589
mohammad16035955c982018-04-26 00:53:03 +03004590/****************************************************************/
4591/* AEAD */
4592/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004593
Gilles Peskineedf9a652018-08-17 18:11:56 +02004594typedef struct
4595{
Gilles Peskine2f060a82018-12-04 17:12:32 +01004596 psa_key_slot_t *slot;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004597 const mbedtls_cipher_info_t *cipher_info;
4598 union
4599 {
4600#if defined(MBEDTLS_CCM_C)
4601 mbedtls_ccm_context ccm;
4602#endif /* MBEDTLS_CCM_C */
4603#if defined(MBEDTLS_GCM_C)
4604 mbedtls_gcm_context gcm;
4605#endif /* MBEDTLS_GCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004606#if defined(MBEDTLS_CHACHAPOLY_C)
4607 mbedtls_chachapoly_context chachapoly;
4608#endif /* MBEDTLS_CHACHAPOLY_C */
Gilles Peskineedf9a652018-08-17 18:11:56 +02004609 } ctx;
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004610 psa_algorithm_t core_alg;
4611 uint8_t full_tag_length;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004612 uint8_t tag_length;
4613} aead_operation_t;
4614
Gilles Peskine30a9e412019-01-14 18:36:12 +01004615static void psa_aead_abort_internal( aead_operation_t *operation )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004616{
Gilles Peskinef8a8fe62018-08-21 16:38:05 +02004617 switch( operation->core_alg )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004618 {
4619#if defined(MBEDTLS_CCM_C)
4620 case PSA_ALG_CCM:
4621 mbedtls_ccm_free( &operation->ctx.ccm );
4622 break;
4623#endif /* MBEDTLS_CCM_C */
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004624#if defined(MBEDTLS_GCM_C)
Gilles Peskineedf9a652018-08-17 18:11:56 +02004625 case PSA_ALG_GCM:
4626 mbedtls_gcm_free( &operation->ctx.gcm );
4627 break;
4628#endif /* MBEDTLS_GCM_C */
4629 }
4630}
4631
4632static psa_status_t psa_aead_setup( aead_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01004633 psa_key_handle_t handle,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004634 psa_key_usage_t usage,
4635 psa_algorithm_t alg )
4636{
4637 psa_status_t status;
4638 size_t key_bits;
4639 mbedtls_cipher_id_t cipher_id;
4640
Gilles Peskine28f8f302019-07-24 13:30:31 +02004641 status = psa_get_transparent_key( handle, &operation->slot, usage, alg );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004642 if( status != PSA_SUCCESS )
4643 return( status );
4644
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02004645 key_bits = psa_get_key_slot_bits( operation->slot );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004646
4647 operation->cipher_info =
Gilles Peskine8e338702019-07-30 20:06:31 +02004648 mbedtls_cipher_info_from_psa( alg, operation->slot->attr.type, key_bits,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004649 &cipher_id );
4650 if( operation->cipher_info == NULL )
4651 return( PSA_ERROR_NOT_SUPPORTED );
4652
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004653 switch( PSA_ALG_AEAD_WITH_TAG_LENGTH( alg, 0 ) )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004654 {
4655#if defined(MBEDTLS_CCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004656 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CCM, 0 ):
4657 operation->core_alg = PSA_ALG_CCM;
4658 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004659 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.
4660 * The call to mbedtls_ccm_encrypt_and_tag or
4661 * mbedtls_ccm_auth_decrypt will validate the tag length. */
Gilles Peskine8e338702019-07-30 20:06:31 +02004662 if( PSA_BLOCK_CIPHER_BLOCK_SIZE( operation->slot->attr.type ) != 16 )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004663 return( PSA_ERROR_INVALID_ARGUMENT );
4664 mbedtls_ccm_init( &operation->ctx.ccm );
4665 status = mbedtls_to_psa_error(
4666 mbedtls_ccm_setkey( &operation->ctx.ccm, cipher_id,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004667 operation->slot->data.key.data,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004668 (unsigned int) key_bits ) );
4669 if( status != 0 )
4670 goto cleanup;
4671 break;
4672#endif /* MBEDTLS_CCM_C */
4673
4674#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004675 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_GCM, 0 ):
4676 operation->core_alg = PSA_ALG_GCM;
4677 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004678 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16.
4679 * The call to mbedtls_gcm_crypt_and_tag or
4680 * mbedtls_gcm_auth_decrypt will validate the tag length. */
Gilles Peskine8e338702019-07-30 20:06:31 +02004681 if( PSA_BLOCK_CIPHER_BLOCK_SIZE( operation->slot->attr.type ) != 16 )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004682 return( PSA_ERROR_INVALID_ARGUMENT );
4683 mbedtls_gcm_init( &operation->ctx.gcm );
4684 status = mbedtls_to_psa_error(
4685 mbedtls_gcm_setkey( &operation->ctx.gcm, cipher_id,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004686 operation->slot->data.key.data,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004687 (unsigned int) key_bits ) );
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004688 if( status != 0 )
4689 goto cleanup;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004690 break;
4691#endif /* MBEDTLS_GCM_C */
4692
Gilles Peskine26869f22019-05-06 15:25:00 +02004693#if defined(MBEDTLS_CHACHAPOLY_C)
4694 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CHACHA20_POLY1305, 0 ):
4695 operation->core_alg = PSA_ALG_CHACHA20_POLY1305;
4696 operation->full_tag_length = 16;
4697 /* We only support the default tag length. */
4698 if( alg != PSA_ALG_CHACHA20_POLY1305 )
4699 return( PSA_ERROR_NOT_SUPPORTED );
4700 mbedtls_chachapoly_init( &operation->ctx.chachapoly );
4701 status = mbedtls_to_psa_error(
4702 mbedtls_chachapoly_setkey( &operation->ctx.chachapoly,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004703 operation->slot->data.key.data ) );
Gilles Peskine26869f22019-05-06 15:25:00 +02004704 if( status != 0 )
4705 goto cleanup;
4706 break;
4707#endif /* MBEDTLS_CHACHAPOLY_C */
4708
Gilles Peskineedf9a652018-08-17 18:11:56 +02004709 default:
4710 return( PSA_ERROR_NOT_SUPPORTED );
4711 }
4712
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004713 if( PSA_AEAD_TAG_LENGTH( alg ) > operation->full_tag_length )
4714 {
4715 status = PSA_ERROR_INVALID_ARGUMENT;
4716 goto cleanup;
4717 }
4718 operation->tag_length = PSA_AEAD_TAG_LENGTH( alg );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004719
Gilles Peskineedf9a652018-08-17 18:11:56 +02004720 return( PSA_SUCCESS );
4721
4722cleanup:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004723 psa_aead_abort_internal( operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004724 return( status );
4725}
4726
Gilles Peskinec5487a82018-12-03 18:08:14 +01004727psa_status_t psa_aead_encrypt( psa_key_handle_t handle,
mohammad16035955c982018-04-26 00:53:03 +03004728 psa_algorithm_t alg,
4729 const uint8_t *nonce,
4730 size_t nonce_length,
4731 const uint8_t *additional_data,
4732 size_t additional_data_length,
4733 const uint8_t *plaintext,
4734 size_t plaintext_length,
4735 uint8_t *ciphertext,
4736 size_t ciphertext_size,
4737 size_t *ciphertext_length )
4738{
mohammad16035955c982018-04-26 00:53:03 +03004739 psa_status_t status;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004740 aead_operation_t operation;
mohammad160315223a82018-06-03 17:19:55 +03004741 uint8_t *tag;
Gilles Peskine2d277862018-06-18 15:41:12 +02004742
mohammad1603f08a5502018-06-03 15:05:47 +03004743 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004744
Gilles Peskinec5487a82018-12-03 18:08:14 +01004745 status = psa_aead_setup( &operation, handle, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004746 if( status != PSA_SUCCESS )
4747 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004748
Gilles Peskineedf9a652018-08-17 18:11:56 +02004749 /* For all currently supported modes, the tag is at the end of the
4750 * ciphertext. */
4751 if( ciphertext_size < ( plaintext_length + operation.tag_length ) )
4752 {
4753 status = PSA_ERROR_BUFFER_TOO_SMALL;
4754 goto exit;
4755 }
4756 tag = ciphertext + plaintext_length;
mohammad16035955c982018-04-26 00:53:03 +03004757
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004758#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004759 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03004760 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004761 status = mbedtls_to_psa_error(
4762 mbedtls_gcm_crypt_and_tag( &operation.ctx.gcm,
4763 MBEDTLS_GCM_ENCRYPT,
4764 plaintext_length,
4765 nonce, nonce_length,
4766 additional_data, additional_data_length,
4767 plaintext, ciphertext,
4768 operation.tag_length, tag ) );
mohammad16035955c982018-04-26 00:53:03 +03004769 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004770 else
4771#endif /* MBEDTLS_GCM_C */
4772#if defined(MBEDTLS_CCM_C)
4773 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03004774 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004775 status = mbedtls_to_psa_error(
4776 mbedtls_ccm_encrypt_and_tag( &operation.ctx.ccm,
4777 plaintext_length,
4778 nonce, nonce_length,
4779 additional_data,
4780 additional_data_length,
4781 plaintext, ciphertext,
4782 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03004783 }
mohammad16035c8845f2018-05-09 05:40:09 -07004784 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004785#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004786#if defined(MBEDTLS_CHACHAPOLY_C)
4787 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
4788 {
4789 if( nonce_length != 12 || operation.tag_length != 16 )
4790 {
4791 status = PSA_ERROR_NOT_SUPPORTED;
4792 goto exit;
4793 }
4794 status = mbedtls_to_psa_error(
4795 mbedtls_chachapoly_encrypt_and_tag( &operation.ctx.chachapoly,
4796 plaintext_length,
4797 nonce,
4798 additional_data,
4799 additional_data_length,
4800 plaintext,
4801 ciphertext,
4802 tag ) );
4803 }
4804 else
4805#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad16035c8845f2018-05-09 05:40:09 -07004806 {
mohammad1603554faad2018-06-03 15:07:38 +03004807 return( PSA_ERROR_NOT_SUPPORTED );
mohammad16035c8845f2018-05-09 05:40:09 -07004808 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004809
Gilles Peskineedf9a652018-08-17 18:11:56 +02004810 if( status != PSA_SUCCESS && ciphertext_size != 0 )
4811 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02004812
Gilles Peskineedf9a652018-08-17 18:11:56 +02004813exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004814 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004815 if( status == PSA_SUCCESS )
4816 *ciphertext_length = plaintext_length + operation.tag_length;
4817 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004818}
4819
Gilles Peskineee652a32018-06-01 19:23:52 +02004820/* Locate the tag in a ciphertext buffer containing the encrypted data
4821 * followed by the tag. Return the length of the part preceding the tag in
4822 * *plaintext_length. This is the size of the plaintext in modes where
4823 * the encrypted data has the same size as the plaintext, such as
4824 * CCM and GCM. */
4825static psa_status_t psa_aead_unpadded_locate_tag( size_t tag_length,
4826 const uint8_t *ciphertext,
4827 size_t ciphertext_length,
4828 size_t plaintext_size,
Gilles Peskineee652a32018-06-01 19:23:52 +02004829 const uint8_t **p_tag )
4830{
4831 size_t payload_length;
4832 if( tag_length > ciphertext_length )
4833 return( PSA_ERROR_INVALID_ARGUMENT );
4834 payload_length = ciphertext_length - tag_length;
4835 if( payload_length > plaintext_size )
4836 return( PSA_ERROR_BUFFER_TOO_SMALL );
4837 *p_tag = ciphertext + payload_length;
Gilles Peskineee652a32018-06-01 19:23:52 +02004838 return( PSA_SUCCESS );
4839}
4840
Gilles Peskinec5487a82018-12-03 18:08:14 +01004841psa_status_t psa_aead_decrypt( psa_key_handle_t handle,
mohammad16035955c982018-04-26 00:53:03 +03004842 psa_algorithm_t alg,
4843 const uint8_t *nonce,
4844 size_t nonce_length,
4845 const uint8_t *additional_data,
4846 size_t additional_data_length,
4847 const uint8_t *ciphertext,
4848 size_t ciphertext_length,
4849 uint8_t *plaintext,
4850 size_t plaintext_size,
4851 size_t *plaintext_length )
4852{
mohammad16035955c982018-04-26 00:53:03 +03004853 psa_status_t status;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004854 aead_operation_t operation;
4855 const uint8_t *tag = NULL;
Gilles Peskine2d277862018-06-18 15:41:12 +02004856
Gilles Peskineee652a32018-06-01 19:23:52 +02004857 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004858
Gilles Peskinec5487a82018-12-03 18:08:14 +01004859 status = psa_aead_setup( &operation, handle, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004860 if( status != PSA_SUCCESS )
4861 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004862
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004863 status = psa_aead_unpadded_locate_tag( operation.tag_length,
4864 ciphertext, ciphertext_length,
4865 plaintext_size, &tag );
4866 if( status != PSA_SUCCESS )
4867 goto exit;
4868
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004869#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004870 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03004871 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004872 status = mbedtls_to_psa_error(
4873 mbedtls_gcm_auth_decrypt( &operation.ctx.gcm,
4874 ciphertext_length - operation.tag_length,
4875 nonce, nonce_length,
4876 additional_data,
4877 additional_data_length,
4878 tag, operation.tag_length,
4879 ciphertext, plaintext ) );
mohammad16035955c982018-04-26 00:53:03 +03004880 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004881 else
4882#endif /* MBEDTLS_GCM_C */
4883#if defined(MBEDTLS_CCM_C)
4884 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03004885 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004886 status = mbedtls_to_psa_error(
4887 mbedtls_ccm_auth_decrypt( &operation.ctx.ccm,
4888 ciphertext_length - operation.tag_length,
4889 nonce, nonce_length,
4890 additional_data,
4891 additional_data_length,
4892 ciphertext, plaintext,
4893 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03004894 }
mohammad160339574652018-06-01 04:39:53 -07004895 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004896#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004897#if defined(MBEDTLS_CHACHAPOLY_C)
4898 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
4899 {
4900 if( nonce_length != 12 || operation.tag_length != 16 )
4901 {
4902 status = PSA_ERROR_NOT_SUPPORTED;
4903 goto exit;
4904 }
4905 status = mbedtls_to_psa_error(
4906 mbedtls_chachapoly_auth_decrypt( &operation.ctx.chachapoly,
4907 ciphertext_length - operation.tag_length,
4908 nonce,
4909 additional_data,
4910 additional_data_length,
4911 tag,
4912 ciphertext,
4913 plaintext ) );
4914 }
4915 else
4916#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad160339574652018-06-01 04:39:53 -07004917 {
mohammad1603554faad2018-06-03 15:07:38 +03004918 return( PSA_ERROR_NOT_SUPPORTED );
mohammad160339574652018-06-01 04:39:53 -07004919 }
Gilles Peskinea40d7742018-06-01 16:28:30 +02004920
Gilles Peskineedf9a652018-08-17 18:11:56 +02004921 if( status != PSA_SUCCESS && plaintext_size != 0 )
4922 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03004923
Gilles Peskineedf9a652018-08-17 18:11:56 +02004924exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004925 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004926 if( status == PSA_SUCCESS )
4927 *plaintext_length = ciphertext_length - operation.tag_length;
4928 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004929}
4930
Gilles Peskinea0655c32018-04-30 17:06:50 +02004931
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004932
Gilles Peskine20035e32018-02-03 22:44:14 +01004933/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02004934/* Generators */
4935/****************************************************************/
4936
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004937#define HKDF_STATE_INIT 0 /* no input yet */
4938#define HKDF_STATE_STARTED 1 /* got salt */
4939#define HKDF_STATE_KEYED 2 /* got key */
4940#define HKDF_STATE_OUTPUT 3 /* output started */
4941
Gilles Peskinecbe66502019-05-16 16:59:18 +02004942static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004943 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004944{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004945 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
4946 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004947 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004948 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004949}
4950
4951
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004952psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004953{
4954 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004955 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004956 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004957 {
4958 /* The object has (apparently) been initialized but it is not
4959 * in use. It's ok to call abort on such an object, and there's
4960 * nothing to do. */
4961 }
4962 else
Gilles Peskinebef7f142018-07-12 17:22:21 +02004963#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004964 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004965 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004966 mbedtls_free( operation->ctx.hkdf.info );
4967 status = psa_hmac_abort_internal( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004968 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01004969 else if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004970 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004971 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004972 {
Janos Follath6a1d2622019-06-11 10:37:28 +01004973 if( operation->ctx.tls12_prf.seed != NULL )
4974 {
4975 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
4976 operation->ctx.tls12_prf.seed_length );
4977 mbedtls_free( operation->ctx.tls12_prf.seed );
4978 }
4979
4980 if( operation->ctx.tls12_prf.label != NULL )
4981 {
4982 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
4983 operation->ctx.tls12_prf.label_length );
4984 mbedtls_free( operation->ctx.tls12_prf.label );
4985 }
4986
4987 status = psa_hmac_abort_internal( &operation->ctx.tls12_prf.hmac );
4988
4989 /* We leave the fields Ai and output_block to be erased safely by the
4990 * mbedtls_platform_zeroize() in the end of this function. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004991 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004992 else
4993#endif /* MBEDTLS_MD_C */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004994 {
4995 status = PSA_ERROR_BAD_STATE;
4996 }
Janos Follath083036a2019-06-11 10:22:26 +01004997 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004998 return( status );
4999}
5000
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005001psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02005002 size_t *capacity)
5003{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005004 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005005 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005006 /* This is a blank key derivation operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02005007 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005008 }
5009
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005010 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005011 return( PSA_SUCCESS );
5012}
5013
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005014psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005015 size_t capacity )
5016{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005017 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005018 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005019 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005020 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005021 operation->capacity = capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005022 return( PSA_SUCCESS );
5023}
5024
Gilles Peskinebef7f142018-07-12 17:22:21 +02005025#if defined(MBEDTLS_MD_C)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005026/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02005027 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02005028static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskinebef7f142018-07-12 17:22:21 +02005029 psa_algorithm_t hash_alg,
5030 uint8_t *output,
5031 size_t output_length )
5032{
5033 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
5034 psa_status_t status;
5035
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005036 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
5037 return( PSA_ERROR_BAD_STATE );
5038 hkdf->state = HKDF_STATE_OUTPUT;
5039
Gilles Peskinebef7f142018-07-12 17:22:21 +02005040 while( output_length != 0 )
5041 {
5042 /* Copy what remains of the current block */
5043 uint8_t n = hash_length - hkdf->offset_in_block;
5044 if( n > output_length )
5045 n = (uint8_t) output_length;
5046 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
5047 output += n;
5048 output_length -= n;
5049 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02005050 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02005051 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02005052 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005053 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005054 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02005055 * object was corrupted or if this function is called directly
5056 * inside the library. */
5057 if( hkdf->block_number == 0xff )
5058 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02005059
5060 /* We need a new block */
5061 ++hkdf->block_number;
5062 hkdf->offset_in_block = 0;
5063 status = psa_hmac_setup_internal( &hkdf->hmac,
5064 hkdf->prk, hash_length,
5065 hash_alg );
5066 if( status != PSA_SUCCESS )
5067 return( status );
5068 if( hkdf->block_number != 1 )
5069 {
5070 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5071 hkdf->output_block,
5072 hash_length );
5073 if( status != PSA_SUCCESS )
5074 return( status );
5075 }
5076 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5077 hkdf->info,
5078 hkdf->info_length );
5079 if( status != PSA_SUCCESS )
5080 return( status );
5081 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5082 &hkdf->block_number, 1 );
5083 if( status != PSA_SUCCESS )
5084 return( status );
5085 status = psa_hmac_finish_internal( &hkdf->hmac,
5086 hkdf->output_block,
5087 sizeof( hkdf->output_block ) );
5088 if( status != PSA_SUCCESS )
5089 return( status );
5090 }
5091
5092 return( PSA_SUCCESS );
5093}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005094
Janos Follath7742fee2019-06-17 12:58:10 +01005095static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
5096 psa_tls12_prf_key_derivation_t *tls12_prf,
5097 psa_algorithm_t alg )
5098{
5099 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
5100 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
Janos Follathea29bfb2019-06-19 12:21:20 +01005101 psa_hash_operation_t backup = PSA_HASH_OPERATION_INIT;
5102 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005103
Janos Follath7742fee2019-06-17 12:58:10 +01005104 /* We can't be wanting more output after block 0xff, otherwise
5105 * the capacity check in psa_key_derivation_output_bytes() would have
5106 * prevented this call. It could happen only if the operation
5107 * object was corrupted or if this function is called directly
5108 * inside the library. */
5109 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01005110 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01005111
5112 /* We need a new block */
5113 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01005114 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01005115
5116 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
5117 *
5118 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
5119 *
5120 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
5121 * HMAC_hash(secret, A(2) + seed) +
5122 * HMAC_hash(secret, A(3) + seed) + ...
5123 *
5124 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01005125 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01005126 *
Janos Follathea29bfb2019-06-19 12:21:20 +01005127 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01005128 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01005129 * is currently extracted as `output_block` and where i is
5130 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01005131 */
5132
Janos Follathea29bfb2019-06-19 12:21:20 +01005133 /* Save the hash context before using it, to preserve the hash state with
5134 * only the inner padding in it. We need this, because inner padding depends
5135 * on the key (secret in the RFC's terminology). */
5136 status = psa_hash_clone( &tls12_prf->hmac.hash_ctx, &backup );
5137 if( status != PSA_SUCCESS )
5138 goto cleanup;
5139
5140 /* Calculate A(i) where i = tls12_prf->block_number. */
5141 if( tls12_prf->block_number == 1 )
5142 {
5143 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
5144 * the variable seed and in this instance means it in the context of the
5145 * P_hash function, where seed = label + seed.) */
5146 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5147 tls12_prf->label, tls12_prf->label_length );
5148 if( status != PSA_SUCCESS )
5149 goto cleanup;
5150 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5151 tls12_prf->seed, tls12_prf->seed_length );
5152 if( status != PSA_SUCCESS )
5153 goto cleanup;
5154 }
5155 else
5156 {
5157 /* A(i) = HMAC_hash(secret, A(i-1)) */
5158 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5159 tls12_prf->Ai, hash_length );
5160 if( status != PSA_SUCCESS )
5161 goto cleanup;
5162 }
5163
5164 status = psa_hmac_finish_internal( &tls12_prf->hmac,
5165 tls12_prf->Ai, hash_length );
5166 if( status != PSA_SUCCESS )
5167 goto cleanup;
5168 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
5169 if( status != PSA_SUCCESS )
5170 goto cleanup;
5171
5172 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
5173 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5174 tls12_prf->Ai, hash_length );
5175 if( status != PSA_SUCCESS )
5176 goto cleanup;
5177 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5178 tls12_prf->label, tls12_prf->label_length );
5179 if( status != PSA_SUCCESS )
5180 goto cleanup;
5181 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5182 tls12_prf->seed, tls12_prf->seed_length );
5183 if( status != PSA_SUCCESS )
5184 goto cleanup;
5185 status = psa_hmac_finish_internal( &tls12_prf->hmac,
5186 tls12_prf->output_block, hash_length );
5187 if( status != PSA_SUCCESS )
5188 goto cleanup;
5189 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
5190 if( status != PSA_SUCCESS )
5191 goto cleanup;
5192
Janos Follath7742fee2019-06-17 12:58:10 +01005193
5194cleanup:
5195
Janos Follathea29bfb2019-06-19 12:21:20 +01005196 cleanup_status = psa_hash_abort( &backup );
5197 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
5198 status = cleanup_status;
5199
5200 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01005201}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005202
Janos Follath844eb0e2019-06-19 12:10:49 +01005203static psa_status_t psa_key_derivation_tls12_prf_read(
5204 psa_tls12_prf_key_derivation_t *tls12_prf,
5205 psa_algorithm_t alg,
5206 uint8_t *output,
5207 size_t output_length )
5208{
5209 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
5210 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
5211 psa_status_t status;
5212 uint8_t offset, length;
5213
5214 while( output_length != 0 )
5215 {
5216 /* Check if we have fully processed the current block. */
5217 if( tls12_prf->left_in_block == 0 )
5218 {
5219 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
5220 alg );
5221 if( status != PSA_SUCCESS )
5222 return( status );
5223
5224 continue;
5225 }
5226
5227 if( tls12_prf->left_in_block > output_length )
5228 length = (uint8_t) output_length;
5229 else
5230 length = tls12_prf->left_in_block;
5231
5232 offset = hash_length - tls12_prf->left_in_block;
5233 memcpy( output, tls12_prf->output_block + offset, length );
5234 output += length;
5235 output_length -= length;
5236 tls12_prf->left_in_block -= length;
5237 }
5238
5239 return( PSA_SUCCESS );
5240}
Gilles Peskinebef7f142018-07-12 17:22:21 +02005241#endif /* MBEDTLS_MD_C */
5242
Janos Follath6c6c8fc2019-06-17 12:38:20 +01005243psa_status_t psa_key_derivation_output_bytes(
5244 psa_key_derivation_operation_t *operation,
5245 uint8_t *output,
5246 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005247{
5248 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005249 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005250
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005251 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005252 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005253 /* This is a blank operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02005254 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005255 }
5256
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005257 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005258 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005259 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005260 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005261 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02005262 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005263 goto exit;
5264 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005265 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005266 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005267 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005268 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02005269 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
5270 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005271 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02005272 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02005273 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005274 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005275 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005276
Gilles Peskinebef7f142018-07-12 17:22:21 +02005277#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005278 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02005279 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01005280 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005281 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02005282 output, output_length );
5283 }
Janos Follathadbec812019-06-14 11:05:39 +01005284 else
Janos Follathadbec812019-06-14 11:05:39 +01005285 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine969c5d62019-01-16 15:53:06 +01005286 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005287 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005288 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005289 kdf_alg, output,
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005290 output_length );
5291 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005292 else
5293#endif /* MBEDTLS_MD_C */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005294 {
5295 return( PSA_ERROR_BAD_STATE );
5296 }
5297
5298exit:
5299 if( status != PSA_SUCCESS )
5300 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005301 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005302 * This allows us to differentiate between exhausted operations and
5303 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
5304 * operations. */
5305 psa_algorithm_t alg = operation->alg;
5306 psa_key_derivation_abort( operation );
5307 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005308 memset( output, '!', output_length );
5309 }
5310 return( status );
5311}
5312
Gilles Peskine08542d82018-07-19 17:05:42 +02005313#if defined(MBEDTLS_DES_C)
5314static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
5315{
5316 if( data_size >= 8 )
5317 mbedtls_des_key_set_parity( data );
5318 if( data_size >= 16 )
5319 mbedtls_des_key_set_parity( data + 8 );
5320 if( data_size >= 24 )
5321 mbedtls_des_key_set_parity( data + 16 );
5322}
5323#endif /* MBEDTLS_DES_C */
5324
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005325static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005326 psa_key_slot_t *slot,
5327 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005328 psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005329{
5330 uint8_t *data = NULL;
5331 size_t bytes = PSA_BITS_TO_BYTES( bits );
5332 psa_status_t status;
5333
Gilles Peskine8e338702019-07-30 20:06:31 +02005334 if( ! key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005335 return( PSA_ERROR_INVALID_ARGUMENT );
5336 if( bits % 8 != 0 )
5337 return( PSA_ERROR_INVALID_ARGUMENT );
5338 data = mbedtls_calloc( 1, bytes );
5339 if( data == NULL )
5340 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5341
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005342 status = psa_key_derivation_output_bytes( operation, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005343 if( status != PSA_SUCCESS )
5344 goto exit;
Gilles Peskine08542d82018-07-19 17:05:42 +02005345#if defined(MBEDTLS_DES_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02005346 if( slot->attr.type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02005347 psa_des_set_key_parity( data, bytes );
5348#endif /* MBEDTLS_DES_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005349 status = psa_import_key_into_slot( slot, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005350
5351exit:
5352 mbedtls_free( data );
5353 return( status );
5354}
5355
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005356psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005357 psa_key_derivation_operation_t *operation,
Gilles Peskine98dd7792019-05-15 19:43:49 +02005358 psa_key_handle_t *handle )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005359{
5360 psa_status_t status;
5361 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005362 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02005363
5364 /* Reject any attempt to create a zero-length key so that we don't
5365 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
5366 if( psa_get_key_bits( attributes ) == 0 )
5367 return( PSA_ERROR_INVALID_ARGUMENT );
5368
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005369 if( ! operation->can_output_key )
5370 return( PSA_ERROR_NOT_PERMITTED );
5371
Gilles Peskinedf179142019-07-15 22:02:14 +02005372 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE,
5373 attributes, handle, &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02005374#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
5375 if( driver != NULL )
5376 {
5377 /* Deriving a key in a secure element is not implemented yet. */
5378 status = PSA_ERROR_NOT_SUPPORTED;
5379 }
5380#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005381 if( status == PSA_SUCCESS )
5382 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005383 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02005384 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005385 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005386 }
5387 if( status == PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02005388 status = psa_finish_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005389 if( status != PSA_SUCCESS )
5390 {
Gilles Peskine011e4282019-06-26 18:34:38 +02005391 psa_fail_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005392 *handle = 0;
5393 }
5394 return( status );
5395}
5396
Gilles Peskineeab56e42018-07-12 17:12:33 +02005397
5398
5399/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02005400/* Key derivation */
5401/****************************************************************/
5402
Gilles Peskine969c5d62019-01-16 15:53:06 +01005403static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005404 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005405 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005406{
Janos Follath5fe19732019-06-20 15:09:30 +01005407 /* Make sure that operation->ctx is properly zero-initialised. (Macro
5408 * initialisers for this union leave some bytes unspecified.) */
5409 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
5410
Gilles Peskine969c5d62019-01-16 15:53:06 +01005411 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005412#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005413 if( PSA_ALG_IS_HKDF( kdf_alg ) ||
5414 PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
5415 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005416 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01005417 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005418 size_t hash_size = PSA_HASH_SIZE( hash_alg );
5419 if( hash_size == 0 )
5420 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005421 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
5422 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02005423 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005424 {
5425 return( PSA_ERROR_NOT_SUPPORTED );
5426 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005427 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01005428 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005429 }
5430#endif /* MBEDTLS_MD_C */
Gilles Peskine969c5d62019-01-16 15:53:06 +01005431 else
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005432 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005433}
5434
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005435psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005436 psa_algorithm_t alg )
5437{
5438 psa_status_t status;
5439
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005440 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005441 return( PSA_ERROR_BAD_STATE );
5442
Gilles Peskine6843c292019-01-18 16:44:49 +01005443 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
5444 return( PSA_ERROR_INVALID_ARGUMENT );
5445 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005446 {
5447 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005448 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005449 }
5450 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
5451 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005452 status = psa_key_derivation_setup_kdf( operation, alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005453 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005454 else
5455 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005456
5457 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005458 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01005459 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005460}
5461
5462#if defined(MBEDTLS_MD_C)
Gilles Peskinecbe66502019-05-16 16:59:18 +02005463static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005464 psa_algorithm_t hash_alg,
5465 psa_key_derivation_step_t step,
5466 const uint8_t *data,
5467 size_t data_length )
5468{
5469 psa_status_t status;
5470 switch( step )
5471 {
Gilles Peskine03410b52019-05-16 16:05:19 +02005472 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02005473 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005474 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005475 status = psa_hmac_setup_internal( &hkdf->hmac,
5476 data, data_length,
5477 hash_alg );
5478 if( status != PSA_SUCCESS )
5479 return( status );
5480 hkdf->state = HKDF_STATE_STARTED;
5481 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02005482 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005483 /* If no salt was provided, use an empty salt. */
5484 if( hkdf->state == HKDF_STATE_INIT )
5485 {
5486 status = psa_hmac_setup_internal( &hkdf->hmac,
5487 NULL, 0,
Gilles Peskinef9ee6332019-04-11 21:22:52 +02005488 hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005489 if( status != PSA_SUCCESS )
5490 return( status );
5491 hkdf->state = HKDF_STATE_STARTED;
5492 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02005493 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005494 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005495 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5496 data, data_length );
5497 if( status != PSA_SUCCESS )
5498 return( status );
5499 status = psa_hmac_finish_internal( &hkdf->hmac,
5500 hkdf->prk,
5501 sizeof( hkdf->prk ) );
5502 if( status != PSA_SUCCESS )
5503 return( status );
5504 hkdf->offset_in_block = PSA_HASH_SIZE( hash_alg );
5505 hkdf->block_number = 0;
5506 hkdf->state = HKDF_STATE_KEYED;
5507 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02005508 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005509 if( hkdf->state == HKDF_STATE_OUTPUT )
5510 return( PSA_ERROR_BAD_STATE );
5511 if( hkdf->info_set )
5512 return( PSA_ERROR_BAD_STATE );
5513 hkdf->info_length = data_length;
5514 if( data_length != 0 )
5515 {
5516 hkdf->info = mbedtls_calloc( 1, data_length );
5517 if( hkdf->info == NULL )
5518 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5519 memcpy( hkdf->info, data, data_length );
5520 }
5521 hkdf->info_set = 1;
5522 return( PSA_SUCCESS );
5523 default:
5524 return( PSA_ERROR_INVALID_ARGUMENT );
5525 }
5526}
Janos Follathb03233e2019-06-11 15:30:30 +01005527
Janos Follathf08e2652019-06-13 09:05:41 +01005528static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
5529 const uint8_t *data,
5530 size_t data_length )
5531{
5532 if( prf->state != TLS12_PRF_STATE_INIT )
5533 return( PSA_ERROR_BAD_STATE );
5534
Janos Follathd6dce9f2019-07-04 09:11:38 +01005535 if( data_length != 0 )
5536 {
5537 prf->seed = mbedtls_calloc( 1, data_length );
5538 if( prf->seed == NULL )
5539 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01005540
Janos Follathd6dce9f2019-07-04 09:11:38 +01005541 memcpy( prf->seed, data, data_length );
5542 prf->seed_length = data_length;
5543 }
Janos Follathf08e2652019-06-13 09:05:41 +01005544
5545 prf->state = TLS12_PRF_STATE_SEED_SET;
5546
5547 return( PSA_SUCCESS );
5548}
5549
Janos Follath81550542019-06-13 14:26:34 +01005550static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
5551 psa_algorithm_t hash_alg,
5552 const uint8_t *data,
5553 size_t data_length )
5554{
5555 psa_status_t status;
5556 if( prf->state != TLS12_PRF_STATE_SEED_SET )
5557 return( PSA_ERROR_BAD_STATE );
5558
5559 status = psa_hmac_setup_internal( &prf->hmac, data, data_length, hash_alg );
5560 if( status != PSA_SUCCESS )
5561 return( status );
5562
5563 prf->state = TLS12_PRF_STATE_KEY_SET;
5564
5565 return( PSA_SUCCESS );
5566}
5567
Janos Follath6660f0e2019-06-17 08:44:03 +01005568static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
5569 psa_tls12_prf_key_derivation_t *prf,
5570 psa_algorithm_t hash_alg,
5571 const uint8_t *data,
5572 size_t data_length )
5573{
5574 psa_status_t status;
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02005575 uint8_t pms[ 4 + 2 * PSA_ALG_TLS12_PSK_TO_MS_MAX_PSK_LEN ];
5576 uint8_t *cur = pms;
Janos Follath6660f0e2019-06-17 08:44:03 +01005577
5578 if( data_length > PSA_ALG_TLS12_PSK_TO_MS_MAX_PSK_LEN )
5579 return( PSA_ERROR_INVALID_ARGUMENT );
5580
5581 /* Quoting RFC 4279, Section 2:
5582 *
5583 * The premaster secret is formed as follows: if the PSK is N octets
5584 * long, concatenate a uint16 with the value N, N zero octets, a second
5585 * uint16 with the value N, and the PSK itself.
5586 */
5587
Janos Follath40e13932019-06-26 13:22:29 +01005588 *cur++ = ( data_length >> 8 ) & 0xff;
5589 *cur++ = ( data_length >> 0 ) & 0xff;
5590 memset( cur, 0, data_length );
5591 cur += data_length;
5592 *cur++ = pms[0];
5593 *cur++ = pms[1];
5594 memcpy( cur, data, data_length );
5595 cur += data_length;
Janos Follath6660f0e2019-06-17 08:44:03 +01005596
Janos Follath40e13932019-06-26 13:22:29 +01005597 status = psa_tls12_prf_set_key( prf, hash_alg, pms, cur - pms );
Janos Follath6660f0e2019-06-17 08:44:03 +01005598
5599 mbedtls_platform_zeroize( pms, sizeof( pms ) );
5600 return( status );
5601}
5602
Janos Follath63028dd2019-06-13 09:15:47 +01005603static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
5604 const uint8_t *data,
5605 size_t data_length )
5606{
5607 if( prf->state != TLS12_PRF_STATE_KEY_SET )
5608 return( PSA_ERROR_BAD_STATE );
5609
Janos Follathd6dce9f2019-07-04 09:11:38 +01005610 if( data_length != 0 )
5611 {
5612 prf->label = mbedtls_calloc( 1, data_length );
5613 if( prf->label == NULL )
5614 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01005615
Janos Follathd6dce9f2019-07-04 09:11:38 +01005616 memcpy( prf->label, data, data_length );
5617 prf->label_length = data_length;
5618 }
Janos Follath63028dd2019-06-13 09:15:47 +01005619
5620 prf->state = TLS12_PRF_STATE_LABEL_SET;
5621
5622 return( PSA_SUCCESS );
5623}
5624
Janos Follathb03233e2019-06-11 15:30:30 +01005625static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
5626 psa_algorithm_t hash_alg,
5627 psa_key_derivation_step_t step,
5628 const uint8_t *data,
5629 size_t data_length )
5630{
Janos Follathb03233e2019-06-11 15:30:30 +01005631 switch( step )
5632 {
Janos Follathf08e2652019-06-13 09:05:41 +01005633 case PSA_KEY_DERIVATION_INPUT_SEED:
5634 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01005635 case PSA_KEY_DERIVATION_INPUT_SECRET:
5636 return( psa_tls12_prf_set_key( prf, hash_alg, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01005637 case PSA_KEY_DERIVATION_INPUT_LABEL:
5638 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01005639 default:
5640 return( PSA_ERROR_INVALID_ARGUMENT );
5641 }
5642}
Janos Follath6660f0e2019-06-17 08:44:03 +01005643
5644static psa_status_t psa_tls12_prf_psk_to_ms_input(
5645 psa_tls12_prf_key_derivation_t *prf,
5646 psa_algorithm_t hash_alg,
5647 psa_key_derivation_step_t step,
5648 const uint8_t *data,
5649 size_t data_length )
5650{
5651 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01005652 {
Janos Follath6660f0e2019-06-17 08:44:03 +01005653 return( psa_tls12_prf_psk_to_ms_set_key( prf, hash_alg,
5654 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01005655 }
Janos Follath6660f0e2019-06-17 08:44:03 +01005656
5657 return( psa_tls12_prf_input( prf, hash_alg, step, data, data_length ) );
5658}
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005659#endif /* MBEDTLS_MD_C */
5660
Gilles Peskineb8965192019-09-24 16:21:10 +02005661/** Check whether the given key type is acceptable for the given
5662 * input step of a key derivation.
5663 *
5664 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
5665 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
5666 * Both secret and non-secret inputs can alternatively have the type
5667 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
5668 * that the input was passed as a buffer rather than via a key object.
5669 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02005670static int psa_key_derivation_check_input_type(
5671 psa_key_derivation_step_t step,
5672 psa_key_type_t key_type )
5673{
5674 switch( step )
5675 {
5676 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb8965192019-09-24 16:21:10 +02005677 if( key_type == PSA_KEY_TYPE_DERIVE )
5678 return( PSA_SUCCESS );
5679 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005680 return( PSA_SUCCESS );
5681 break;
5682 case PSA_KEY_DERIVATION_INPUT_LABEL:
5683 case PSA_KEY_DERIVATION_INPUT_SALT:
5684 case PSA_KEY_DERIVATION_INPUT_INFO:
5685 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskineb8965192019-09-24 16:21:10 +02005686 if( key_type == PSA_KEY_TYPE_RAW_DATA )
5687 return( PSA_SUCCESS );
5688 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005689 return( PSA_SUCCESS );
5690 break;
5691 }
5692 return( PSA_ERROR_INVALID_ARGUMENT );
5693}
5694
Janos Follathb80a94e2019-06-12 15:54:46 +01005695static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005696 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005697 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005698 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005699 const uint8_t *data,
5700 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005701{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02005702 psa_status_t status;
5703 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
5704
5705 status = psa_key_derivation_check_input_type( step, key_type );
Gilles Peskine224b0d62019-09-23 18:13:17 +02005706 if( status != PSA_SUCCESS )
5707 goto exit;
5708
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005709#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005710 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005711 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005712 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005713 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005714 step, data, data_length );
5715 }
k-stachowiak012dcc42019-08-13 14:55:03 +02005716 else if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005717 {
Janos Follathb03233e2019-06-11 15:30:30 +01005718 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
5719 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5720 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01005721 }
5722 else if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
5723 {
5724 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
5725 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5726 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005727 }
5728 else
5729#endif /* MBEDTLS_MD_C */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005730 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005731 /* This can't happen unless the operation object was not initialized */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005732 return( PSA_ERROR_BAD_STATE );
5733 }
5734
Gilles Peskine224b0d62019-09-23 18:13:17 +02005735exit:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005736 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005737 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005738 return( status );
5739}
5740
Janos Follath51f4a0f2019-06-14 11:35:55 +01005741psa_status_t psa_key_derivation_input_bytes(
5742 psa_key_derivation_operation_t *operation,
5743 psa_key_derivation_step_t step,
5744 const uint8_t *data,
5745 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005746{
Gilles Peskineb8965192019-09-24 16:21:10 +02005747 return( psa_key_derivation_input_internal( operation, step,
5748 PSA_KEY_TYPE_NONE,
Janos Follathc5621512019-06-14 11:27:57 +01005749 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005750}
5751
Janos Follath51f4a0f2019-06-14 11:35:55 +01005752psa_status_t psa_key_derivation_input_key(
5753 psa_key_derivation_operation_t *operation,
5754 psa_key_derivation_step_t step,
5755 psa_key_handle_t handle )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005756{
5757 psa_key_slot_t *slot;
5758 psa_status_t status;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005759
Gilles Peskine28f8f302019-07-24 13:30:31 +02005760 status = psa_get_transparent_key( handle, &slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02005761 PSA_KEY_USAGE_DERIVE,
5762 operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005763 if( status != PSA_SUCCESS )
Gilles Peskine593773d2019-09-23 18:17:40 +02005764 {
5765 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005766 return( status );
Gilles Peskine593773d2019-09-23 18:17:40 +02005767 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005768
5769 /* Passing a key object as a SECRET input unlocks the permission
5770 * to output to a key object. */
5771 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5772 operation->can_output_key = 1;
5773
Janos Follathb80a94e2019-06-12 15:54:46 +01005774 return( psa_key_derivation_input_internal( operation,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005775 step, slot->attr.type,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02005776 slot->data.key.data,
5777 slot->data.key.bytes ) );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005778}
Gilles Peskineea0fb492018-07-12 17:17:20 +02005779
5780
5781
5782/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02005783/* Key agreement */
5784/****************************************************************/
5785
Gilles Peskinea05219c2018-11-16 16:02:56 +01005786#if defined(MBEDTLS_ECDH_C)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005787static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
5788 size_t peer_key_length,
5789 const mbedtls_ecp_keypair *our_key,
5790 uint8_t *shared_secret,
5791 size_t shared_secret_size,
5792 size_t *shared_secret_length )
5793{
Steven Cooremand4867872020-08-05 16:31:39 +02005794 mbedtls_ecp_keypair *their_key = NULL;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005795 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00005796 psa_status_t status;
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005797 size_t bits = 0;
Paul Elliott8ff510a2020-06-02 17:19:28 +01005798 psa_ecc_family_t curve = mbedtls_ecc_group_to_psa( our_key->grp.id, &bits );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005799 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005800
Steven Cooreman4fed4552020-08-03 14:46:03 +02005801 status = psa_load_ecp_representation( PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve),
5802 peer_key,
Steven Cooreman7f391872020-07-30 14:57:44 +02005803 peer_key_length,
Steven Cooreman7f391872020-07-30 14:57:44 +02005804 &their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00005805 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005806 goto exit;
5807
Jaeden Amero97271b32019-01-10 19:38:51 +00005808 status = mbedtls_to_psa_error(
Steven Cooremana2371e52020-07-28 14:30:39 +02005809 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
Jaeden Amero97271b32019-01-10 19:38:51 +00005810 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005811 goto exit;
Jaeden Amero97271b32019-01-10 19:38:51 +00005812 status = mbedtls_to_psa_error(
5813 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
5814 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005815 goto exit;
5816
Jaeden Amero97271b32019-01-10 19:38:51 +00005817 status = mbedtls_to_psa_error(
5818 mbedtls_ecdh_calc_secret( &ecdh,
5819 shared_secret_length,
5820 shared_secret, shared_secret_size,
5821 mbedtls_ctr_drbg_random,
5822 &global_data.ctr_drbg ) );
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005823 if( status != PSA_SUCCESS )
5824 goto exit;
5825 if( PSA_BITS_TO_BYTES( bits ) != *shared_secret_length )
5826 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005827
5828exit:
Gilles Peskine3e819b72019-12-20 14:09:55 +01005829 if( status != PSA_SUCCESS )
5830 mbedtls_platform_zeroize( shared_secret, shared_secret_size );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005831 mbedtls_ecdh_free( &ecdh );
Steven Cooremana2371e52020-07-28 14:30:39 +02005832 mbedtls_ecp_keypair_free( their_key );
Steven Cooreman6d839f02020-07-30 11:36:45 +02005833 mbedtls_free( their_key );
Steven Cooremana2371e52020-07-28 14:30:39 +02005834
Jaeden Amero97271b32019-01-10 19:38:51 +00005835 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005836}
Gilles Peskinea05219c2018-11-16 16:02:56 +01005837#endif /* MBEDTLS_ECDH_C */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005838
Gilles Peskine01d718c2018-09-18 12:01:02 +02005839#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
5840
Gilles Peskine0216fe12019-04-11 21:23:21 +02005841static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
5842 psa_key_slot_t *private_key,
5843 const uint8_t *peer_key,
5844 size_t peer_key_length,
5845 uint8_t *shared_secret,
5846 size_t shared_secret_size,
5847 size_t *shared_secret_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005848{
Gilles Peskine0216fe12019-04-11 21:23:21 +02005849 switch( alg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005850 {
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005851#if defined(MBEDTLS_ECDH_C)
Gilles Peskine0216fe12019-04-11 21:23:21 +02005852 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02005853 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005854 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremana2371e52020-07-28 14:30:39 +02005855 mbedtls_ecp_keypair *ecp = NULL;
Steven Cooreman7f391872020-07-30 14:57:44 +02005856 psa_status_t status = psa_load_ecp_representation(
Steven Cooreman4fed4552020-08-03 14:46:03 +02005857 private_key->attr.type,
Steven Cooreman7f391872020-07-30 14:57:44 +02005858 private_key->data.key.data,
5859 private_key->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02005860 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02005861 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02005862 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02005863 status = psa_key_agreement_ecdh( peer_key, peer_key_length,
Steven Cooremana2371e52020-07-28 14:30:39 +02005864 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02005865 shared_secret, shared_secret_size,
5866 shared_secret_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02005867 mbedtls_ecp_keypair_free( ecp );
5868 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02005869 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005870#endif /* MBEDTLS_ECDH_C */
Gilles Peskine01d718c2018-09-18 12:01:02 +02005871 default:
Gilles Peskine93f85002018-11-16 16:43:31 +01005872 (void) private_key;
5873 (void) peer_key;
5874 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02005875 (void) shared_secret;
5876 (void) shared_secret_size;
5877 (void) shared_secret_length;
Gilles Peskine01d718c2018-09-18 12:01:02 +02005878 return( PSA_ERROR_NOT_SUPPORTED );
5879 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02005880}
5881
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005882/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02005883 * to potentially free embedded data structures and wipe confidential data.
5884 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005885static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005886 psa_key_derivation_step_t step,
Gilles Peskine01d718c2018-09-18 12:01:02 +02005887 psa_key_slot_t *private_key,
5888 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005889 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005890{
5891 psa_status_t status;
5892 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
5893 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005894 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005895
5896 /* Step 1: run the secret agreement algorithm to generate the shared
5897 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02005898 status = psa_key_agreement_raw_internal( ka_alg,
5899 private_key,
5900 peer_key, peer_key_length,
itayzafrir0adf0fc2018-09-06 16:24:41 +03005901 shared_secret,
5902 sizeof( shared_secret ),
Gilles Peskine05d69892018-06-19 22:00:52 +02005903 &shared_secret_length );
Gilles Peskine53d991e2018-07-12 01:14:59 +02005904 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005905 goto exit;
5906
Gilles Peskineb0b255c2018-07-06 17:01:38 +02005907 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02005908 * the shared secret. A shared secret is permitted wherever a key
5909 * of type DERIVE is permitted. */
Janos Follathb80a94e2019-06-12 15:54:46 +01005910 status = psa_key_derivation_input_internal( operation, step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005911 PSA_KEY_TYPE_DERIVE,
Janos Follathb80a94e2019-06-12 15:54:46 +01005912 shared_secret,
5913 shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005914exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01005915 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005916 return( status );
5917}
5918
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005919psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005920 psa_key_derivation_step_t step,
5921 psa_key_handle_t private_key,
5922 const uint8_t *peer_key,
5923 size_t peer_key_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005924{
Gilles Peskine2f060a82018-12-04 17:12:32 +01005925 psa_key_slot_t *slot;
Gilles Peskine08542d82018-07-19 17:05:42 +02005926 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005927 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005928 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine28f8f302019-07-24 13:30:31 +02005929 status = psa_get_transparent_key( private_key, &slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02005930 PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005931 if( status != PSA_SUCCESS )
5932 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005933 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01005934 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005935 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01005936 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005937 psa_key_derivation_abort( operation );
Steven Cooremanfa5e6312020-10-15 17:07:12 +02005938 else
5939 {
5940 /* If a private key has been added as SECRET, we allow the derived
5941 * key material to be used as a key in PSA Crypto. */
5942 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5943 operation->can_output_key = 1;
5944 }
Gilles Peskine346797d2018-11-16 16:05:06 +01005945 return( status );
Gilles Peskineaf3baab2018-06-27 22:55:52 +02005946}
5947
Gilles Peskinebe697d82019-05-16 18:00:41 +02005948psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
5949 psa_key_handle_t private_key,
5950 const uint8_t *peer_key,
5951 size_t peer_key_length,
5952 uint8_t *output,
5953 size_t output_size,
5954 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02005955{
5956 psa_key_slot_t *slot;
5957 psa_status_t status;
5958
5959 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
5960 {
5961 status = PSA_ERROR_INVALID_ARGUMENT;
5962 goto exit;
5963 }
Gilles Peskine28f8f302019-07-24 13:30:31 +02005964 status = psa_get_transparent_key( private_key, &slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02005965 PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02005966 if( status != PSA_SUCCESS )
5967 goto exit;
5968
5969 status = psa_key_agreement_raw_internal( alg, slot,
5970 peer_key, peer_key_length,
5971 output, output_size,
5972 output_length );
5973
5974exit:
5975 if( status != PSA_SUCCESS )
5976 {
5977 /* If an error happens and is not handled properly, the output
5978 * may be used as a key to protect sensitive data. Arrange for such
5979 * a key to be random, which is likely to result in decryption or
5980 * verification errors. This is better than filling the buffer with
5981 * some constant data such as zeros, which would result in the data
5982 * being protected with a reproducible, easily knowable key.
5983 */
5984 psa_generate_random( output, output_size );
5985 *output_length = output_size;
5986 }
5987 return( status );
5988}
Gilles Peskine86a440b2018-11-12 18:39:40 +01005989
5990
5991/****************************************************************/
5992/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02005993/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02005994
Gilles Peskine4c317f42018-07-12 01:24:09 +02005995psa_status_t psa_generate_random( uint8_t *output,
Gilles Peskine53d991e2018-07-12 01:14:59 +02005996 size_t output_size )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005997{
Janos Follath24eed8d2019-11-22 13:21:35 +00005998 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005999 GUARD_MODULE_INITIALIZED;
6000
Gilles Peskinef181eca2019-08-07 13:49:00 +02006001 while( output_size > MBEDTLS_CTR_DRBG_MAX_REQUEST )
6002 {
6003 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg,
6004 output,
6005 MBEDTLS_CTR_DRBG_MAX_REQUEST );
6006 if( ret != 0 )
6007 return( mbedtls_to_psa_error( ret ) );
6008 output += MBEDTLS_CTR_DRBG_MAX_REQUEST;
6009 output_size -= MBEDTLS_CTR_DRBG_MAX_REQUEST;
6010 }
6011
Gilles Peskinee59236f2018-01-27 23:32:46 +01006012 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg, output, output_size );
6013 return( mbedtls_to_psa_error( ret ) );
6014}
6015
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01006016#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
6017#include "mbedtls/entropy_poll.h"
6018
Gilles Peskine7228da22019-07-15 11:06:15 +02006019psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006020 size_t seed_size )
6021{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006022 if( global_data.initialized )
6023 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02006024
6025 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
6026 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
6027 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
6028 return( PSA_ERROR_INVALID_ARGUMENT );
6029
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01006030 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006031}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01006032#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006033
Gilles Peskinee56e8782019-04-26 17:34:02 +02006034#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_GENPRIME)
6035static psa_status_t psa_read_rsa_exponent( const uint8_t *domain_parameters,
6036 size_t domain_parameters_size,
6037 int *exponent )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006038{
Gilles Peskinee56e8782019-04-26 17:34:02 +02006039 size_t i;
6040 uint32_t acc = 0;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006041
Gilles Peskinee56e8782019-04-26 17:34:02 +02006042 if( domain_parameters_size == 0 )
6043 {
6044 *exponent = 65537;
6045 return( PSA_SUCCESS );
6046 }
6047
6048 /* Mbed TLS encodes the public exponent as an int. For simplicity, only
6049 * support values that fit in a 32-bit integer, which is larger than
6050 * int on just about every platform anyway. */
6051 if( domain_parameters_size > sizeof( acc ) )
6052 return( PSA_ERROR_NOT_SUPPORTED );
6053 for( i = 0; i < domain_parameters_size; i++ )
6054 acc = ( acc << 8 ) | domain_parameters[i];
6055 if( acc > INT_MAX )
6056 return( PSA_ERROR_NOT_SUPPORTED );
6057 *exponent = acc;
6058 return( PSA_SUCCESS );
6059}
6060#endif /* MBEDTLS_RSA_C && MBEDTLS_GENPRIME */
6061
Gilles Peskine35ef36b2019-05-16 19:42:05 +02006062static psa_status_t psa_generate_key_internal(
Gilles Peskinee56e8782019-04-26 17:34:02 +02006063 psa_key_slot_t *slot, size_t bits,
6064 const uint8_t *domain_parameters, size_t domain_parameters_size )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006065{
Gilles Peskine8e338702019-07-30 20:06:31 +02006066 psa_key_type_t type = slot->attr.type;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006067
Gilles Peskinee56e8782019-04-26 17:34:02 +02006068 if( domain_parameters == NULL && domain_parameters_size != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006069 return( PSA_ERROR_INVALID_ARGUMENT );
6070
Gilles Peskinee59236f2018-01-27 23:32:46 +01006071 if( key_type_is_raw_bytes( type ) )
6072 {
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006073 psa_status_t status;
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006074
6075 status = validate_unstructured_key_bit_size( slot->attr.type, bits );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006076 if( status != PSA_SUCCESS )
6077 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006078
6079 /* Allocate memory for the key */
Steven Cooreman75b74362020-07-28 14:30:13 +02006080 status = psa_allocate_buffer_to_slot( slot, PSA_BITS_TO_BYTES( bits ) );
6081 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02006082 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006083
Steven Cooreman71fd80d2020-07-07 21:12:27 +02006084 status = psa_generate_random( slot->data.key.data,
6085 slot->data.key.bytes );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006086 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006087 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006088
6089 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006090#if defined(MBEDTLS_DES_C)
6091 if( type == PSA_KEY_TYPE_DES )
Steven Cooreman71fd80d2020-07-07 21:12:27 +02006092 psa_des_set_key_parity( slot->data.key.data,
6093 slot->data.key.bytes );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006094#endif /* MBEDTLS_DES_C */
6095 }
6096 else
6097
6098#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_GENPRIME)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02006099 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006100 {
Steven Cooremana01795d2020-07-24 22:48:15 +02006101 mbedtls_rsa_context rsa;
Janos Follath24eed8d2019-11-22 13:21:35 +00006102 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee56e8782019-04-26 17:34:02 +02006103 int exponent;
6104 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006105 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
6106 return( PSA_ERROR_NOT_SUPPORTED );
6107 /* Accept only byte-aligned keys, for the same reasons as
6108 * in psa_import_rsa_key(). */
6109 if( bits % 8 != 0 )
6110 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinee56e8782019-04-26 17:34:02 +02006111 status = psa_read_rsa_exponent( domain_parameters,
6112 domain_parameters_size,
6113 &exponent );
6114 if( status != PSA_SUCCESS )
6115 return( status );
Steven Cooremana01795d2020-07-24 22:48:15 +02006116 mbedtls_rsa_init( &rsa, MBEDTLS_RSA_PKCS_V15, MBEDTLS_MD_NONE );
6117 ret = mbedtls_rsa_gen_key( &rsa,
Gilles Peskinee59236f2018-01-27 23:32:46 +01006118 mbedtls_ctr_drbg_random,
6119 &global_data.ctr_drbg,
6120 (unsigned int) bits,
6121 exponent );
6122 if( ret != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006123 return( mbedtls_to_psa_error( ret ) );
Steven Cooremana01795d2020-07-24 22:48:15 +02006124
6125 /* Make sure to always have an export representation available */
6126 size_t bytes = PSA_KEY_EXPORT_RSA_KEY_PAIR_MAX_SIZE( bits );
6127
Steven Cooreman75b74362020-07-28 14:30:13 +02006128 status = psa_allocate_buffer_to_slot( slot, bytes );
6129 if( status != PSA_SUCCESS )
Steven Cooremana01795d2020-07-24 22:48:15 +02006130 {
6131 mbedtls_rsa_free( &rsa );
Steven Cooreman29149862020-08-05 15:43:42 +02006132 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006133 }
Steven Cooremana01795d2020-07-24 22:48:15 +02006134
6135 status = psa_export_rsa_key( type,
6136 &rsa,
6137 slot->data.key.data,
6138 bytes,
6139 &slot->data.key.bytes );
6140 mbedtls_rsa_free( &rsa );
6141 if( status != PSA_SUCCESS )
Steven Cooremana01795d2020-07-24 22:48:15 +02006142 psa_remove_key_data_from_memory( slot );
Steven Cooreman560c28a2020-07-24 23:20:24 +02006143 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006144 }
6145 else
6146#endif /* MBEDTLS_RSA_C && MBEDTLS_GENPRIME */
6147
6148#if defined(MBEDTLS_ECP_C)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02006149 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006150 {
Paul Elliott8ff510a2020-06-02 17:19:28 +01006151 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY( type );
Gilles Peskine4295e8b2019-12-02 21:39:10 +01006152 mbedtls_ecp_group_id grp_id =
6153 mbedtls_ecc_group_of_psa( curve, PSA_BITS_TO_BYTES( bits ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006154 const mbedtls_ecp_curve_info *curve_info =
6155 mbedtls_ecp_curve_info_from_grp_id( grp_id );
Steven Cooremanacda8342020-07-24 23:09:52 +02006156 mbedtls_ecp_keypair ecp;
Janos Follath24eed8d2019-11-22 13:21:35 +00006157 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee56e8782019-04-26 17:34:02 +02006158 if( domain_parameters_size != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006159 return( PSA_ERROR_NOT_SUPPORTED );
6160 if( grp_id == MBEDTLS_ECP_DP_NONE || curve_info == NULL )
6161 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooremanacda8342020-07-24 23:09:52 +02006162 mbedtls_ecp_keypair_init( &ecp );
6163 ret = mbedtls_ecp_gen_key( grp_id, &ecp,
Gilles Peskinee59236f2018-01-27 23:32:46 +01006164 mbedtls_ctr_drbg_random,
6165 &global_data.ctr_drbg );
6166 if( ret != 0 )
6167 {
Steven Cooremanacda8342020-07-24 23:09:52 +02006168 mbedtls_ecp_keypair_free( &ecp );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006169 return( mbedtls_to_psa_error( ret ) );
6170 }
Steven Cooremanacda8342020-07-24 23:09:52 +02006171
6172
6173 /* Make sure to always have an export representation available */
6174 size_t bytes = PSA_BITS_TO_BYTES( bits );
Steven Cooreman75b74362020-07-28 14:30:13 +02006175 psa_status_t status = psa_allocate_buffer_to_slot( slot, bytes );
6176 if( status != PSA_SUCCESS )
Steven Cooremanacda8342020-07-24 23:09:52 +02006177 {
6178 mbedtls_ecp_keypair_free( &ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02006179 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02006180 }
Steven Cooreman75b74362020-07-28 14:30:13 +02006181
6182 status = mbedtls_to_psa_error(
Steven Cooremanacda8342020-07-24 23:09:52 +02006183 mbedtls_ecp_write_key( &ecp, slot->data.key.data, bytes ) );
6184
6185 mbedtls_ecp_keypair_free( &ecp );
Steven Cooremanb7f6dea2020-08-05 16:07:20 +02006186 if( status != PSA_SUCCESS ) {
6187 memset( slot->data.key.data, 0, bytes );
Steven Cooremanacda8342020-07-24 23:09:52 +02006188 psa_remove_key_data_from_memory( slot );
Steven Cooremanb7f6dea2020-08-05 16:07:20 +02006189 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02006190 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006191 }
6192 else
6193#endif /* MBEDTLS_ECP_C */
Steven Cooreman29149862020-08-05 15:43:42 +02006194 {
Gilles Peskinee59236f2018-01-27 23:32:46 +01006195 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman29149862020-08-05 15:43:42 +02006196 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01006197
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006198 return( PSA_SUCCESS );
6199}
Darryl Green0c6575a2018-11-07 16:05:30 +00006200
Gilles Peskine35ef36b2019-05-16 19:42:05 +02006201psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Gilles Peskinee56e8782019-04-26 17:34:02 +02006202 psa_key_handle_t *handle )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006203{
6204 psa_status_t status;
6205 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02006206 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine11792082019-08-06 18:36:36 +02006207
Gilles Peskine0f84d622019-09-12 19:03:13 +02006208 /* Reject any attempt to create a zero-length key so that we don't
6209 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
6210 if( psa_get_key_bits( attributes ) == 0 )
6211 return( PSA_ERROR_INVALID_ARGUMENT );
6212
Gilles Peskinedf179142019-07-15 22:02:14 +02006213 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE,
6214 attributes, handle, &slot, &driver );
Gilles Peskine11792082019-08-06 18:36:36 +02006215 if( status != PSA_SUCCESS )
6216 goto exit;
6217
Steven Cooreman2a1664c2020-07-20 15:33:08 +02006218 status = psa_driver_wrapper_generate_key( attributes,
6219 slot );
6220 if( status != PSA_ERROR_NOT_SUPPORTED ||
6221 psa_key_lifetime_is_external( attributes->core.lifetime ) )
6222 goto exit;
6223
6224 status = psa_generate_key_internal(
6225 slot, attributes->core.bits,
6226 attributes->domain_parameters, attributes->domain_parameters_size );
Gilles Peskine11792082019-08-06 18:36:36 +02006227
6228exit:
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006229 if( status == PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02006230 status = psa_finish_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006231 if( status != PSA_SUCCESS )
6232 {
Gilles Peskine011e4282019-06-26 18:34:38 +02006233 psa_fail_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006234 *handle = 0;
6235 }
Darryl Green0c6575a2018-11-07 16:05:30 +00006236 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006237}
6238
6239
Gilles Peskinee59236f2018-01-27 23:32:46 +01006240
6241/****************************************************************/
6242/* Module setup */
6243/****************************************************************/
6244
Gilles Peskine5e769522018-11-20 21:59:56 +01006245psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
6246 void (* entropy_init )( mbedtls_entropy_context *ctx ),
6247 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
6248{
6249 if( global_data.rng_state != RNG_NOT_INITIALIZED )
6250 return( PSA_ERROR_BAD_STATE );
6251 global_data.entropy_init = entropy_init;
6252 global_data.entropy_free = entropy_free;
6253 return( PSA_SUCCESS );
6254}
6255
Gilles Peskinee59236f2018-01-27 23:32:46 +01006256void mbedtls_psa_crypto_free( void )
6257{
Gilles Peskine66fb1262018-12-10 16:29:04 +01006258 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006259 if( global_data.rng_state != RNG_NOT_INITIALIZED )
6260 {
6261 mbedtls_ctr_drbg_free( &global_data.ctr_drbg );
Gilles Peskine5e769522018-11-20 21:59:56 +01006262 global_data.entropy_free( &global_data.entropy );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006263 }
6264 /* Wipe all remaining data, including configuration.
6265 * In particular, this sets all state indicator to the value
6266 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01006267 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Gilles Peskinea8ade162019-06-26 11:24:49 +02006268#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +02006269 /* Unregister all secure element drivers, so that we restart from
6270 * a pristine state. */
6271 psa_unregister_all_se_drivers( );
Gilles Peskinea8ade162019-06-26 11:24:49 +02006272#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006273}
6274
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006275#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
6276/** Recover a transaction that was interrupted by a power failure.
6277 *
6278 * This function is called during initialization, before psa_crypto_init()
6279 * returns. If this function returns a failure status, the initialization
6280 * fails.
6281 */
6282static psa_status_t psa_crypto_recover_transaction(
6283 const psa_crypto_transaction_t *transaction )
6284{
6285 switch( transaction->unknown.type )
6286 {
6287 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
6288 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01006289 /* TODO - fall through to the failure case until this
Gilles Peskinec9d7f942019-08-13 16:17:16 +02006290 * is implemented.
6291 * https://github.com/ARMmbed/mbed-crypto/issues/218
6292 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006293 default:
6294 /* We found an unsupported transaction in the storage.
6295 * We don't know what state the storage is in. Give up. */
6296 return( PSA_ERROR_STORAGE_FAILURE );
6297 }
6298}
6299#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
6300
Gilles Peskinee59236f2018-01-27 23:32:46 +01006301psa_status_t psa_crypto_init( void )
6302{
Gilles Peskine66fb1262018-12-10 16:29:04 +01006303 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006304 const unsigned char drbg_seed[] = "PSA";
6305
Gilles Peskinec6b69072018-11-20 21:42:52 +01006306 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006307 if( global_data.initialized != 0 )
6308 return( PSA_SUCCESS );
6309
Gilles Peskine5e769522018-11-20 21:59:56 +01006310 /* Set default configuration if
6311 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
6312 if( global_data.entropy_init == NULL )
6313 global_data.entropy_init = mbedtls_entropy_init;
6314 if( global_data.entropy_free == NULL )
6315 global_data.entropy_free = mbedtls_entropy_free;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006316
Gilles Peskinec6b69072018-11-20 21:42:52 +01006317 /* Initialize the random generator. */
Gilles Peskine5e769522018-11-20 21:59:56 +01006318 global_data.entropy_init( &global_data.entropy );
Jaeden Amero76541612019-06-04 17:14:43 +01006319#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
6320 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
6321 /* The PSA entropy injection feature depends on using NV seed as an entropy
6322 * source. Add NV seed as an entropy source for PSA entropy injection. */
6323 mbedtls_entropy_add_source( &global_data.entropy,
6324 mbedtls_nv_seed_poll, NULL,
6325 MBEDTLS_ENTROPY_BLOCK_SIZE,
6326 MBEDTLS_ENTROPY_SOURCE_STRONG );
6327#endif
Gilles Peskinee59236f2018-01-27 23:32:46 +01006328 mbedtls_ctr_drbg_init( &global_data.ctr_drbg );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006329 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine66fb1262018-12-10 16:29:04 +01006330 status = mbedtls_to_psa_error(
6331 mbedtls_ctr_drbg_seed( &global_data.ctr_drbg,
6332 mbedtls_entropy_func,
6333 &global_data.entropy,
6334 drbg_seed, sizeof( drbg_seed ) - 1 ) );
6335 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006336 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01006337 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006338
Gilles Peskine66fb1262018-12-10 16:29:04 +01006339 status = psa_initialize_key_slots( );
6340 if( status != PSA_SUCCESS )
6341 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01006342
Gilles Peskined9348f22019-10-01 15:22:29 +02006343#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
6344 status = psa_init_all_se_drivers( );
6345 if( status != PSA_SUCCESS )
6346 goto exit;
6347#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
6348
Gilles Peskine4b734222019-07-24 15:56:31 +02006349#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02006350 status = psa_crypto_load_transaction( );
6351 if( status == PSA_SUCCESS )
6352 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006353 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
6354 if( status != PSA_SUCCESS )
6355 goto exit;
6356 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02006357 }
6358 else if( status == PSA_ERROR_DOES_NOT_EXIST )
6359 {
6360 /* There's no transaction to complete. It's all good. */
6361 status = PSA_SUCCESS;
6362 }
Gilles Peskine4b734222019-07-24 15:56:31 +02006363#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02006364
Gilles Peskinec6b69072018-11-20 21:42:52 +01006365 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006366 global_data.initialized = 1;
6367
6368exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01006369 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006370 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01006371 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006372}
6373
6374#endif /* MBEDTLS_PSA_CRYPTO_C */