blob: afe09af029ad439a98e9c496f7628ab19cc555dc [file] [log] [blame]
Gilles Peskinee59236f2018-01-27 23:32:46 +01001/*
2 * PSA crypto layer on top of Mbed TLS crypto
3 */
Bence Szépkúti86974652020-06-15 11:59:37 +02004/*
Bence Szépkúti1e148272020-08-07 13:07:28 +02005 * Copyright The Mbed TLS Contributors
Gilles Peskinee59236f2018-01-27 23:32:46 +01006 * SPDX-License-Identifier: Apache-2.0
7 *
8 * Licensed under the Apache License, Version 2.0 (the "License"); you may
9 * not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
Gilles Peskinee59236f2018-01-27 23:32:46 +010019 */
20
Gilles Peskinedb09ef62020-06-03 01:43:33 +020021#include "common.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010022
23#if defined(MBEDTLS_PSA_CRYPTO_C)
mohammad160327010052018-07-03 13:16:15 +030024
itayzafrir7723ab12019-02-14 10:28:02 +020025#include "psa_crypto_service_integration.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010026#include "psa/crypto.h"
27
Gilles Peskine039b90c2018-12-07 18:24:41 +010028#include "psa_crypto_core.h"
Gilles Peskine5e769522018-11-20 21:59:56 +010029#include "psa_crypto_invasive.h"
Steven Cooremancd84cb42020-07-16 20:28:36 +020030#include "psa_crypto_driver_wrappers.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020031#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +020032#include "psa_crypto_se.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020033#endif
Gilles Peskine961849f2018-11-30 18:54:54 +010034#include "psa_crypto_slot_management.h"
Darryl Greend49a4992018-06-18 17:27:26 +010035/* Include internal declarations that are useful for implementing persistently
36 * stored keys. */
37#include "psa_crypto_storage.h"
38
Gilles Peskineb46bef22019-07-30 21:32:04 +020039#include <assert.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010040#include <stdlib.h>
41#include <string.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010042#include "mbedtls/platform.h"
Gilles Peskineff2d2002019-05-06 15:26:23 +020043#if !defined(MBEDTLS_PLATFORM_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010044#define mbedtls_calloc calloc
45#define mbedtls_free free
46#endif
47
Gilles Peskinea5905292018-02-07 20:59:33 +010048#include "mbedtls/arc4.h"
Gilles Peskine9a944802018-06-21 09:35:35 +020049#include "mbedtls/asn1.h"
Jaeden Amero25384a22019-01-10 10:23:21 +000050#include "mbedtls/asn1write.h"
Gilles Peskinea81d85b2018-06-26 16:10:23 +020051#include "mbedtls/bignum.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010052#include "mbedtls/blowfish.h"
53#include "mbedtls/camellia.h"
Gilles Peskine26869f22019-05-06 15:25:00 +020054#include "mbedtls/chacha20.h"
55#include "mbedtls/chachapoly.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010056#include "mbedtls/cipher.h"
57#include "mbedtls/ccm.h"
58#include "mbedtls/cmac.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010059#include "mbedtls/ctr_drbg.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010060#include "mbedtls/des.h"
Gilles Peskineb7ecdf02018-09-18 12:11:27 +020061#include "mbedtls/ecdh.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010062#include "mbedtls/ecp.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010063#include "mbedtls/entropy.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010064#include "mbedtls/error.h"
65#include "mbedtls/gcm.h"
66#include "mbedtls/md2.h"
67#include "mbedtls/md4.h"
68#include "mbedtls/md5.h"
Gilles Peskine20035e32018-02-03 22:44:14 +010069#include "mbedtls/md.h"
70#include "mbedtls/md_internal.h"
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010071#include "mbedtls/pk.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010072#include "mbedtls/pk_internal.h"
Gilles Peskine3f108122018-12-07 18:14:53 +010073#include "mbedtls/platform_util.h"
Janos Follath24eed8d2019-11-22 13:21:35 +000074#include "mbedtls/error.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010075#include "mbedtls/ripemd160.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010076#include "mbedtls/rsa.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010077#include "mbedtls/sha1.h"
78#include "mbedtls/sha256.h"
79#include "mbedtls/sha512.h"
80#include "mbedtls/xtea.h"
81
Gilles Peskine996deb12018-08-01 15:45:45 +020082#define ARRAY_LENGTH( array ) ( sizeof( array ) / sizeof( *( array ) ) )
83
Gilles Peskine9ef733f2018-02-07 21:05:37 +010084/* constant-time buffer comparison */
85static inline int safer_memcmp( const uint8_t *a, const uint8_t *b, size_t n )
86{
87 size_t i;
88 unsigned char diff = 0;
89
90 for( i = 0; i < n; i++ )
91 diff |= a[i] ^ b[i];
92
93 return( diff );
94}
95
96
97
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010098/****************************************************************/
99/* Global data, support functions and library management */
100/****************************************************************/
101
Gilles Peskine48c0ea12018-06-21 14:15:31 +0200102static int key_type_is_raw_bytes( psa_key_type_t type )
103{
Gilles Peskine78b3bb62018-08-10 16:03:41 +0200104 return( PSA_KEY_TYPE_IS_UNSTRUCTURED( type ) );
Gilles Peskine48c0ea12018-06-21 14:15:31 +0200105}
106
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100107/* Values for psa_global_data_t::rng_state */
108#define RNG_NOT_INITIALIZED 0
109#define RNG_INITIALIZED 1
110#define RNG_SEEDED 2
Gilles Peskinec6b69072018-11-20 21:42:52 +0100111
Gilles Peskine2d277862018-06-18 15:41:12 +0200112typedef struct
113{
Gilles Peskine5e769522018-11-20 21:59:56 +0100114 void (* entropy_init )( mbedtls_entropy_context *ctx );
115 void (* entropy_free )( mbedtls_entropy_context *ctx );
Gilles Peskinee59236f2018-01-27 23:32:46 +0100116 mbedtls_entropy_context entropy;
117 mbedtls_ctr_drbg_context ctr_drbg;
Gilles Peskinec6b69072018-11-20 21:42:52 +0100118 unsigned initialized : 1;
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100119 unsigned rng_state : 2;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100120} psa_global_data_t;
121
122static psa_global_data_t global_data;
123
itayzafrir0adf0fc2018-09-06 16:24:41 +0300124#define GUARD_MODULE_INITIALIZED \
125 if( global_data.initialized == 0 ) \
126 return( PSA_ERROR_BAD_STATE );
127
Steven Cooreman01164162020-07-20 15:31:37 +0200128psa_status_t mbedtls_to_psa_error( int ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100129{
Gilles Peskinea5905292018-02-07 20:59:33 +0100130 /* If there's both a high-level code and low-level code, dispatch on
131 * the high-level code. */
132 switch( ret < -0x7f ? - ( -ret & 0x7f80 ) : ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100133 {
134 case 0:
135 return( PSA_SUCCESS );
Gilles Peskinea5905292018-02-07 20:59:33 +0100136
137 case MBEDTLS_ERR_AES_INVALID_KEY_LENGTH:
138 case MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH:
139 case MBEDTLS_ERR_AES_FEATURE_UNAVAILABLE:
140 return( PSA_ERROR_NOT_SUPPORTED );
141 case MBEDTLS_ERR_AES_HW_ACCEL_FAILED:
142 return( PSA_ERROR_HARDWARE_FAILURE );
143
144 case MBEDTLS_ERR_ARC4_HW_ACCEL_FAILED:
145 return( PSA_ERROR_HARDWARE_FAILURE );
146
Gilles Peskine9a944802018-06-21 09:35:35 +0200147 case MBEDTLS_ERR_ASN1_OUT_OF_DATA:
148 case MBEDTLS_ERR_ASN1_UNEXPECTED_TAG:
149 case MBEDTLS_ERR_ASN1_INVALID_LENGTH:
150 case MBEDTLS_ERR_ASN1_LENGTH_MISMATCH:
151 case MBEDTLS_ERR_ASN1_INVALID_DATA:
152 return( PSA_ERROR_INVALID_ARGUMENT );
153 case MBEDTLS_ERR_ASN1_ALLOC_FAILED:
154 return( PSA_ERROR_INSUFFICIENT_MEMORY );
155 case MBEDTLS_ERR_ASN1_BUF_TOO_SMALL:
156 return( PSA_ERROR_BUFFER_TOO_SMALL );
157
Jaeden Amero93e21112019-02-20 13:57:28 +0000158#if defined(MBEDTLS_ERR_BLOWFISH_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000159 case MBEDTLS_ERR_BLOWFISH_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000160#elif defined(MBEDTLS_ERR_BLOWFISH_INVALID_KEY_LENGTH)
161 case MBEDTLS_ERR_BLOWFISH_INVALID_KEY_LENGTH:
162#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100163 case MBEDTLS_ERR_BLOWFISH_INVALID_INPUT_LENGTH:
164 return( PSA_ERROR_NOT_SUPPORTED );
165 case MBEDTLS_ERR_BLOWFISH_HW_ACCEL_FAILED:
166 return( PSA_ERROR_HARDWARE_FAILURE );
167
Jaeden Amero93e21112019-02-20 13:57:28 +0000168#if defined(MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000169 case MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000170#elif defined(MBEDTLS_ERR_CAMELLIA_INVALID_KEY_LENGTH)
171 case MBEDTLS_ERR_CAMELLIA_INVALID_KEY_LENGTH:
172#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100173 case MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH:
174 return( PSA_ERROR_NOT_SUPPORTED );
175 case MBEDTLS_ERR_CAMELLIA_HW_ACCEL_FAILED:
176 return( PSA_ERROR_HARDWARE_FAILURE );
177
178 case MBEDTLS_ERR_CCM_BAD_INPUT:
179 return( PSA_ERROR_INVALID_ARGUMENT );
180 case MBEDTLS_ERR_CCM_AUTH_FAILED:
181 return( PSA_ERROR_INVALID_SIGNATURE );
182 case MBEDTLS_ERR_CCM_HW_ACCEL_FAILED:
183 return( PSA_ERROR_HARDWARE_FAILURE );
184
Gilles Peskine26869f22019-05-06 15:25:00 +0200185 case MBEDTLS_ERR_CHACHA20_BAD_INPUT_DATA:
186 return( PSA_ERROR_INVALID_ARGUMENT );
187
188 case MBEDTLS_ERR_CHACHAPOLY_BAD_STATE:
189 return( PSA_ERROR_BAD_STATE );
190 case MBEDTLS_ERR_CHACHAPOLY_AUTH_FAILED:
191 return( PSA_ERROR_INVALID_SIGNATURE );
192
Gilles Peskinea5905292018-02-07 20:59:33 +0100193 case MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE:
194 return( PSA_ERROR_NOT_SUPPORTED );
195 case MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA:
196 return( PSA_ERROR_INVALID_ARGUMENT );
197 case MBEDTLS_ERR_CIPHER_ALLOC_FAILED:
198 return( PSA_ERROR_INSUFFICIENT_MEMORY );
199 case MBEDTLS_ERR_CIPHER_INVALID_PADDING:
200 return( PSA_ERROR_INVALID_PADDING );
201 case MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED:
Fredrik Strupef90e3012020-09-28 16:11:33 +0200202 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100203 case MBEDTLS_ERR_CIPHER_AUTH_FAILED:
204 return( PSA_ERROR_INVALID_SIGNATURE );
205 case MBEDTLS_ERR_CIPHER_INVALID_CONTEXT:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200206 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100207 case MBEDTLS_ERR_CIPHER_HW_ACCEL_FAILED:
208 return( PSA_ERROR_HARDWARE_FAILURE );
209
210 case MBEDTLS_ERR_CMAC_HW_ACCEL_FAILED:
211 return( PSA_ERROR_HARDWARE_FAILURE );
212
213 case MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED:
214 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
215 case MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG:
216 case MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG:
217 return( PSA_ERROR_NOT_SUPPORTED );
218 case MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR:
219 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
220
221 case MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH:
222 return( PSA_ERROR_NOT_SUPPORTED );
223 case MBEDTLS_ERR_DES_HW_ACCEL_FAILED:
224 return( PSA_ERROR_HARDWARE_FAILURE );
225
Gilles Peskinee59236f2018-01-27 23:32:46 +0100226 case MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED:
227 case MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE:
228 case MBEDTLS_ERR_ENTROPY_SOURCE_FAILED:
229 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskinea5905292018-02-07 20:59:33 +0100230
231 case MBEDTLS_ERR_GCM_AUTH_FAILED:
232 return( PSA_ERROR_INVALID_SIGNATURE );
233 case MBEDTLS_ERR_GCM_BAD_INPUT:
Gilles Peskine8cac2e62018-08-21 15:07:38 +0200234 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100235 case MBEDTLS_ERR_GCM_HW_ACCEL_FAILED:
236 return( PSA_ERROR_HARDWARE_FAILURE );
237
238 case MBEDTLS_ERR_MD2_HW_ACCEL_FAILED:
239 case MBEDTLS_ERR_MD4_HW_ACCEL_FAILED:
240 case MBEDTLS_ERR_MD5_HW_ACCEL_FAILED:
241 return( PSA_ERROR_HARDWARE_FAILURE );
242
243 case MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE:
244 return( PSA_ERROR_NOT_SUPPORTED );
245 case MBEDTLS_ERR_MD_BAD_INPUT_DATA:
246 return( PSA_ERROR_INVALID_ARGUMENT );
247 case MBEDTLS_ERR_MD_ALLOC_FAILED:
248 return( PSA_ERROR_INSUFFICIENT_MEMORY );
249 case MBEDTLS_ERR_MD_FILE_IO_ERROR:
250 return( PSA_ERROR_STORAGE_FAILURE );
251 case MBEDTLS_ERR_MD_HW_ACCEL_FAILED:
252 return( PSA_ERROR_HARDWARE_FAILURE );
253
Gilles Peskinef76aa772018-10-29 19:24:33 +0100254 case MBEDTLS_ERR_MPI_FILE_IO_ERROR:
255 return( PSA_ERROR_STORAGE_FAILURE );
256 case MBEDTLS_ERR_MPI_BAD_INPUT_DATA:
257 return( PSA_ERROR_INVALID_ARGUMENT );
258 case MBEDTLS_ERR_MPI_INVALID_CHARACTER:
259 return( PSA_ERROR_INVALID_ARGUMENT );
260 case MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL:
261 return( PSA_ERROR_BUFFER_TOO_SMALL );
262 case MBEDTLS_ERR_MPI_NEGATIVE_VALUE:
263 return( PSA_ERROR_INVALID_ARGUMENT );
264 case MBEDTLS_ERR_MPI_DIVISION_BY_ZERO:
265 return( PSA_ERROR_INVALID_ARGUMENT );
266 case MBEDTLS_ERR_MPI_NOT_ACCEPTABLE:
267 return( PSA_ERROR_INVALID_ARGUMENT );
268 case MBEDTLS_ERR_MPI_ALLOC_FAILED:
269 return( PSA_ERROR_INSUFFICIENT_MEMORY );
270
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100271 case MBEDTLS_ERR_PK_ALLOC_FAILED:
272 return( PSA_ERROR_INSUFFICIENT_MEMORY );
273 case MBEDTLS_ERR_PK_TYPE_MISMATCH:
274 case MBEDTLS_ERR_PK_BAD_INPUT_DATA:
275 return( PSA_ERROR_INVALID_ARGUMENT );
276 case MBEDTLS_ERR_PK_FILE_IO_ERROR:
Gilles Peskinea5905292018-02-07 20:59:33 +0100277 return( PSA_ERROR_STORAGE_FAILURE );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100278 case MBEDTLS_ERR_PK_KEY_INVALID_VERSION:
279 case MBEDTLS_ERR_PK_KEY_INVALID_FORMAT:
280 return( PSA_ERROR_INVALID_ARGUMENT );
281 case MBEDTLS_ERR_PK_UNKNOWN_PK_ALG:
282 return( PSA_ERROR_NOT_SUPPORTED );
283 case MBEDTLS_ERR_PK_PASSWORD_REQUIRED:
284 case MBEDTLS_ERR_PK_PASSWORD_MISMATCH:
285 return( PSA_ERROR_NOT_PERMITTED );
286 case MBEDTLS_ERR_PK_INVALID_PUBKEY:
287 return( PSA_ERROR_INVALID_ARGUMENT );
288 case MBEDTLS_ERR_PK_INVALID_ALG:
289 case MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE:
290 case MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE:
291 return( PSA_ERROR_NOT_SUPPORTED );
292 case MBEDTLS_ERR_PK_SIG_LEN_MISMATCH:
293 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskinea5905292018-02-07 20:59:33 +0100294 case MBEDTLS_ERR_PK_HW_ACCEL_FAILED:
295 return( PSA_ERROR_HARDWARE_FAILURE );
296
Gilles Peskineff2d2002019-05-06 15:26:23 +0200297 case MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED:
298 return( PSA_ERROR_HARDWARE_FAILURE );
299 case MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED:
300 return( PSA_ERROR_NOT_SUPPORTED );
301
Gilles Peskinea5905292018-02-07 20:59:33 +0100302 case MBEDTLS_ERR_RIPEMD160_HW_ACCEL_FAILED:
303 return( PSA_ERROR_HARDWARE_FAILURE );
304
305 case MBEDTLS_ERR_RSA_BAD_INPUT_DATA:
306 return( PSA_ERROR_INVALID_ARGUMENT );
307 case MBEDTLS_ERR_RSA_INVALID_PADDING:
308 return( PSA_ERROR_INVALID_PADDING );
309 case MBEDTLS_ERR_RSA_KEY_GEN_FAILED:
310 return( PSA_ERROR_HARDWARE_FAILURE );
311 case MBEDTLS_ERR_RSA_KEY_CHECK_FAILED:
312 return( PSA_ERROR_INVALID_ARGUMENT );
313 case MBEDTLS_ERR_RSA_PUBLIC_FAILED:
314 case MBEDTLS_ERR_RSA_PRIVATE_FAILED:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200315 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100316 case MBEDTLS_ERR_RSA_VERIFY_FAILED:
317 return( PSA_ERROR_INVALID_SIGNATURE );
318 case MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE:
319 return( PSA_ERROR_BUFFER_TOO_SMALL );
320 case MBEDTLS_ERR_RSA_RNG_FAILED:
321 return( PSA_ERROR_INSUFFICIENT_MEMORY );
322 case MBEDTLS_ERR_RSA_UNSUPPORTED_OPERATION:
323 return( PSA_ERROR_NOT_SUPPORTED );
324 case MBEDTLS_ERR_RSA_HW_ACCEL_FAILED:
325 return( PSA_ERROR_HARDWARE_FAILURE );
326
327 case MBEDTLS_ERR_SHA1_HW_ACCEL_FAILED:
328 case MBEDTLS_ERR_SHA256_HW_ACCEL_FAILED:
329 case MBEDTLS_ERR_SHA512_HW_ACCEL_FAILED:
330 return( PSA_ERROR_HARDWARE_FAILURE );
331
332 case MBEDTLS_ERR_XTEA_INVALID_INPUT_LENGTH:
333 return( PSA_ERROR_INVALID_ARGUMENT );
334 case MBEDTLS_ERR_XTEA_HW_ACCEL_FAILED:
335 return( PSA_ERROR_HARDWARE_FAILURE );
336
itayzafrir5c753392018-05-08 11:18:38 +0300337 case MBEDTLS_ERR_ECP_BAD_INPUT_DATA:
itayzafrir7b30f8b2018-05-09 16:07:36 +0300338 case MBEDTLS_ERR_ECP_INVALID_KEY:
itayzafrir5c753392018-05-08 11:18:38 +0300339 return( PSA_ERROR_INVALID_ARGUMENT );
itayzafrir7b30f8b2018-05-09 16:07:36 +0300340 case MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL:
341 return( PSA_ERROR_BUFFER_TOO_SMALL );
342 case MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE:
343 return( PSA_ERROR_NOT_SUPPORTED );
344 case MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH:
345 case MBEDTLS_ERR_ECP_VERIFY_FAILED:
346 return( PSA_ERROR_INVALID_SIGNATURE );
347 case MBEDTLS_ERR_ECP_ALLOC_FAILED:
348 return( PSA_ERROR_INSUFFICIENT_MEMORY );
349 case MBEDTLS_ERR_ECP_HW_ACCEL_FAILED:
350 return( PSA_ERROR_HARDWARE_FAILURE );
Janos Follatha13b9052019-11-22 12:48:59 +0000351 case MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED:
352 return( PSA_ERROR_CORRUPTION_DETECTED );
itayzafrir5c753392018-05-08 11:18:38 +0300353
Gilles Peskinee59236f2018-01-27 23:32:46 +0100354 default:
David Saadab4ecc272019-02-14 13:48:10 +0200355 return( PSA_ERROR_GENERIC_ERROR );
Gilles Peskinee59236f2018-01-27 23:32:46 +0100356 }
357}
358
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200359
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +0200360
361
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100362/****************************************************************/
363/* Key management */
364/****************************************************************/
365
Gilles Peskine73167e12019-07-12 23:44:37 +0200366#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
367static inline int psa_key_slot_is_external( const psa_key_slot_t *slot )
368{
Gilles Peskine8e338702019-07-30 20:06:31 +0200369 return( psa_key_lifetime_is_external( slot->attr.lifetime ) );
Gilles Peskine73167e12019-07-12 23:44:37 +0200370}
371#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
372
Darryl Green8f8aa8f2018-07-24 15:44:51 +0100373#if defined(MBEDTLS_ECP_C)
Paul Elliott8ff510a2020-06-02 17:19:28 +0100374mbedtls_ecp_group_id mbedtls_ecc_group_of_psa( psa_ecc_family_t curve,
Gilles Peskine5055b232019-12-12 17:49:31 +0100375 size_t byte_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +0200376{
377 switch( curve )
378 {
Paul Elliott8ff510a2020-06-02 17:19:28 +0100379 case PSA_ECC_FAMILY_SECP_R1:
Gilles Peskine228abc52019-12-03 17:24:19 +0100380 switch( byte_length )
381 {
382 case PSA_BITS_TO_BYTES( 192 ):
383 return( MBEDTLS_ECP_DP_SECP192R1 );
384 case PSA_BITS_TO_BYTES( 224 ):
385 return( MBEDTLS_ECP_DP_SECP224R1 );
386 case PSA_BITS_TO_BYTES( 256 ):
387 return( MBEDTLS_ECP_DP_SECP256R1 );
388 case PSA_BITS_TO_BYTES( 384 ):
389 return( MBEDTLS_ECP_DP_SECP384R1 );
390 case PSA_BITS_TO_BYTES( 521 ):
391 return( MBEDTLS_ECP_DP_SECP521R1 );
392 default:
393 return( MBEDTLS_ECP_DP_NONE );
394 }
395 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100396
Paul Elliott8ff510a2020-06-02 17:19:28 +0100397 case PSA_ECC_FAMILY_BRAINPOOL_P_R1:
Gilles Peskine228abc52019-12-03 17:24:19 +0100398 switch( byte_length )
399 {
400 case PSA_BITS_TO_BYTES( 256 ):
401 return( MBEDTLS_ECP_DP_BP256R1 );
402 case PSA_BITS_TO_BYTES( 384 ):
403 return( MBEDTLS_ECP_DP_BP384R1 );
404 case PSA_BITS_TO_BYTES( 512 ):
405 return( MBEDTLS_ECP_DP_BP512R1 );
406 default:
407 return( MBEDTLS_ECP_DP_NONE );
408 }
409 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100410
Paul Elliott8ff510a2020-06-02 17:19:28 +0100411 case PSA_ECC_FAMILY_MONTGOMERY:
Gilles Peskine228abc52019-12-03 17:24:19 +0100412 switch( byte_length )
413 {
414 case PSA_BITS_TO_BYTES( 255 ):
415 return( MBEDTLS_ECP_DP_CURVE25519 );
416 case PSA_BITS_TO_BYTES( 448 ):
417 return( MBEDTLS_ECP_DP_CURVE448 );
418 default:
419 return( MBEDTLS_ECP_DP_NONE );
420 }
421 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100422
Paul Elliott8ff510a2020-06-02 17:19:28 +0100423 case PSA_ECC_FAMILY_SECP_K1:
Gilles Peskine228abc52019-12-03 17:24:19 +0100424 switch( byte_length )
425 {
426 case PSA_BITS_TO_BYTES( 192 ):
427 return( MBEDTLS_ECP_DP_SECP192K1 );
428 case PSA_BITS_TO_BYTES( 224 ):
429 return( MBEDTLS_ECP_DP_SECP224K1 );
430 case PSA_BITS_TO_BYTES( 256 ):
431 return( MBEDTLS_ECP_DP_SECP256K1 );
432 default:
433 return( MBEDTLS_ECP_DP_NONE );
434 }
435 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100436
Gilles Peskine12313cd2018-06-20 00:20:32 +0200437 default:
438 return( MBEDTLS_ECP_DP_NONE );
439 }
440}
Darryl Green8f8aa8f2018-07-24 15:44:51 +0100441#endif /* defined(MBEDTLS_ECP_C) */
Gilles Peskine12313cd2018-06-20 00:20:32 +0200442
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200443static psa_status_t validate_unstructured_key_bit_size( psa_key_type_t type,
444 size_t bits )
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200445{
446 /* Check that the bit size is acceptable for the key type */
447 switch( type )
448 {
449 case PSA_KEY_TYPE_RAW_DATA:
450#if defined(MBEDTLS_MD_C)
451 case PSA_KEY_TYPE_HMAC:
Gilles Peskine46f1fd72018-06-28 19:31:31 +0200452#endif
Gilles Peskineea0fb492018-07-12 17:17:20 +0200453 case PSA_KEY_TYPE_DERIVE:
454 break;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200455#if defined(MBEDTLS_AES_C)
456 case PSA_KEY_TYPE_AES:
457 if( bits != 128 && bits != 192 && bits != 256 )
458 return( PSA_ERROR_INVALID_ARGUMENT );
459 break;
460#endif
461#if defined(MBEDTLS_CAMELLIA_C)
462 case PSA_KEY_TYPE_CAMELLIA:
463 if( bits != 128 && bits != 192 && bits != 256 )
464 return( PSA_ERROR_INVALID_ARGUMENT );
465 break;
466#endif
467#if defined(MBEDTLS_DES_C)
468 case PSA_KEY_TYPE_DES:
469 if( bits != 64 && bits != 128 && bits != 192 )
470 return( PSA_ERROR_INVALID_ARGUMENT );
471 break;
472#endif
473#if defined(MBEDTLS_ARC4_C)
474 case PSA_KEY_TYPE_ARC4:
475 if( bits < 8 || bits > 2048 )
476 return( PSA_ERROR_INVALID_ARGUMENT );
477 break;
478#endif
Gilles Peskine26869f22019-05-06 15:25:00 +0200479#if defined(MBEDTLS_CHACHA20_C)
480 case PSA_KEY_TYPE_CHACHA20:
481 if( bits != 256 )
482 return( PSA_ERROR_INVALID_ARGUMENT );
483 break;
484#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200485 default:
486 return( PSA_ERROR_NOT_SUPPORTED );
487 }
Gilles Peskineb54979a2018-06-21 09:32:47 +0200488 if( bits % 8 != 0 )
489 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200490
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200491 return( PSA_SUCCESS );
492}
493
Steven Cooremana01795d2020-07-24 22:48:15 +0200494#if defined(MBEDTLS_RSA_C)
495
496#if defined(MBEDTLS_PK_PARSE_C)
Gilles Peskine86a440b2018-11-12 18:39:40 +0100497/* Mbed TLS doesn't support non-byte-aligned key sizes (i.e. key sizes
498 * that are not a multiple of 8) well. For example, there is only
499 * mbedtls_rsa_get_len(), which returns a number of bytes, and no
500 * way to return the exact bit size of a key.
501 * To keep things simple, reject non-byte-aligned key sizes. */
502static psa_status_t psa_check_rsa_key_byte_aligned(
503 const mbedtls_rsa_context *rsa )
504{
505 mbedtls_mpi n;
506 psa_status_t status;
507 mbedtls_mpi_init( &n );
508 status = mbedtls_to_psa_error(
509 mbedtls_rsa_export( rsa, &n, NULL, NULL, NULL, NULL ) );
510 if( status == PSA_SUCCESS )
511 {
512 if( mbedtls_mpi_bitlen( &n ) % 8 != 0 )
513 status = PSA_ERROR_NOT_SUPPORTED;
514 }
515 mbedtls_mpi_free( &n );
516 return( status );
517}
Steven Cooremana01795d2020-07-24 22:48:15 +0200518#endif /* MBEDTLS_PK_PARSE_C */
Gilles Peskine86a440b2018-11-12 18:39:40 +0100519
Steven Cooreman7f391872020-07-30 14:57:44 +0200520/** Load the contents of a key buffer into an internal RSA representation
Steven Cooremana01795d2020-07-24 22:48:15 +0200521 *
Steven Cooreman4fed4552020-08-03 14:46:03 +0200522 * \param[in] type The type of key contained in \p data.
523 * \param[in] data The buffer from which to load the representation.
524 * \param[in] data_length The size in bytes of \p data.
525 * \param[out] p_rsa Returns a pointer to an RSA context on success.
526 * The caller is responsible for freeing both the
527 * contents of the context and the context itself
528 * when done.
Steven Cooremana01795d2020-07-24 22:48:15 +0200529 */
Steven Cooreman4fed4552020-08-03 14:46:03 +0200530static psa_status_t psa_load_rsa_representation( psa_key_type_t type,
531 const uint8_t *data,
532 size_t data_length,
Steven Cooremana2371e52020-07-28 14:30:39 +0200533 mbedtls_rsa_context **p_rsa )
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200534{
Steven Cooremana01795d2020-07-24 22:48:15 +0200535#if defined(MBEDTLS_PK_PARSE_C)
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000536 psa_status_t status;
Steven Cooremana01795d2020-07-24 22:48:15 +0200537 mbedtls_pk_context ctx;
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000538 size_t bits;
Steven Cooremana01795d2020-07-24 22:48:15 +0200539 mbedtls_pk_init( &ctx );
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000540
541 /* Parse the data. */
Steven Cooreman7f391872020-07-30 14:57:44 +0200542 if( PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000543 status = mbedtls_to_psa_error(
Steven Cooreman4fed4552020-08-03 14:46:03 +0200544 mbedtls_pk_parse_key( &ctx, data, data_length, NULL, 0 ) );
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200545 else
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000546 status = mbedtls_to_psa_error(
Steven Cooreman4fed4552020-08-03 14:46:03 +0200547 mbedtls_pk_parse_public_key( &ctx, data, data_length ) );
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000548 if( status != PSA_SUCCESS )
549 goto exit;
550
551 /* We have something that the pkparse module recognizes. If it is a
552 * valid RSA key, store it. */
Steven Cooremana01795d2020-07-24 22:48:15 +0200553 if( mbedtls_pk_get_type( &ctx ) != MBEDTLS_PK_RSA )
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200554 {
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000555 status = PSA_ERROR_INVALID_ARGUMENT;
556 goto exit;
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200557 }
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000558
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000559 /* The size of an RSA key doesn't have to be a multiple of 8. Mbed TLS
560 * supports non-byte-aligned key sizes, but not well. For example,
561 * mbedtls_rsa_get_len() returns the key size in bytes, not in bits. */
Steven Cooremana01795d2020-07-24 22:48:15 +0200562 bits = PSA_BYTES_TO_BITS( mbedtls_rsa_get_len( mbedtls_pk_rsa( ctx ) ) );
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000563 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
564 {
565 status = PSA_ERROR_NOT_SUPPORTED;
566 goto exit;
567 }
Steven Cooremana01795d2020-07-24 22:48:15 +0200568 status = psa_check_rsa_key_byte_aligned( mbedtls_pk_rsa( ctx ) );
Steven Cooremana01795d2020-07-24 22:48:15 +0200569 if( status != PSA_SUCCESS )
570 goto exit;
571
Steven Cooremana2371e52020-07-28 14:30:39 +0200572 /* Copy out the pointer to the RSA context, and reset the PK context
573 * such that pk_free doesn't free the RSA context we just grabbed. */
574 *p_rsa = mbedtls_pk_rsa( ctx );
575 ctx.pk_info = NULL;
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000576
577exit:
Steven Cooremana01795d2020-07-24 22:48:15 +0200578 mbedtls_pk_free( &ctx );
579 return( status );
580#else
Steven Cooreman4fed4552020-08-03 14:46:03 +0200581 (void) data;
582 (void) data_length;
Steven Cooreman7f391872020-07-30 14:57:44 +0200583 (void) type;
Steven Cooremana01795d2020-07-24 22:48:15 +0200584 (void) rsa;
585 return( PSA_ERROR_NOT_SUPPORTED );
586#endif /* MBEDTLS_PK_PARSE_C */
587}
588
589/** Export an RSA key to export representation
590 *
591 * \param[in] type The type of key (public/private) to export
592 * \param[in] rsa The internal RSA representation from which to export
593 * \param[out] data The buffer to export to
594 * \param[in] data_size The length of the buffer to export to
595 * \param[out] data_length The amount of bytes written to \p data
596 */
597static psa_status_t psa_export_rsa_key( psa_key_type_t type,
598 mbedtls_rsa_context *rsa,
599 uint8_t *data,
600 size_t data_size,
601 size_t *data_length )
602{
603#if defined(MBEDTLS_PK_WRITE_C)
604 int ret;
605 mbedtls_pk_context pk;
606 uint8_t *pos = data + data_size;
607
608 mbedtls_pk_init( &pk );
609 pk.pk_info = &mbedtls_rsa_info;
610 pk.pk_ctx = rsa;
611
612 /* PSA Crypto API defines the format of an RSA key as a DER-encoded
Steven Cooreman75b74362020-07-28 14:30:13 +0200613 * representation of the non-encrypted PKCS#1 RSAPrivateKey for a
614 * private key and of the RFC3279 RSAPublicKey for a public key. */
Steven Cooremana01795d2020-07-24 22:48:15 +0200615 if( PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
616 ret = mbedtls_pk_write_key_der( &pk, data, data_size );
617 else
618 ret = mbedtls_pk_write_pubkey( &pos, data, &pk );
619
620 if( ret < 0 )
Steven Cooreman4fed4552020-08-03 14:46:03 +0200621 {
622 /* Clean up in case pk_write failed halfway through. */
623 memset( data, 0, data_size );
Steven Cooreman29149862020-08-05 15:43:42 +0200624 return( mbedtls_to_psa_error( ret ) );
Steven Cooreman4fed4552020-08-03 14:46:03 +0200625 }
Steven Cooremana01795d2020-07-24 22:48:15 +0200626
627 /* The mbedtls_pk_xxx functions write to the end of the buffer.
628 * Move the data to the beginning and erase remaining data
629 * at the original location. */
630 if( 2 * (size_t) ret <= data_size )
631 {
632 memcpy( data, data + data_size - ret, ret );
633 memset( data + data_size - ret, 0, ret );
634 }
635 else if( (size_t) ret < data_size )
636 {
637 memmove( data, data + data_size - ret, ret );
638 memset( data + ret, 0, data_size - ret );
639 }
640
641 *data_length = ret;
642 return( PSA_SUCCESS );
643#else
644 (void) type;
645 (void) rsa;
646 (void) data;
647 (void) data_size;
648 (void) data_length;
649 return( PSA_ERROR_NOT_SUPPORTED );
650#endif /* MBEDTLS_PK_WRITE_C */
651}
652
653/** Import an RSA key from import representation to a slot
654 *
655 * \param[in,out] slot The slot where to store the export representation to
656 * \param[in] data The buffer containing the import representation
657 * \param[in] data_length The amount of bytes in \p data
658 */
659static psa_status_t psa_import_rsa_key( psa_key_slot_t *slot,
660 const uint8_t *data,
661 size_t data_length )
662{
663 psa_status_t status;
664 uint8_t* output = NULL;
Steven Cooremana2371e52020-07-28 14:30:39 +0200665 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +0200666
Steven Cooremana01795d2020-07-24 22:48:15 +0200667 /* Parse input */
Steven Cooreman4fed4552020-08-03 14:46:03 +0200668 status = psa_load_rsa_representation( slot->attr.type,
669 data,
Steven Cooreman7f391872020-07-30 14:57:44 +0200670 data_length,
Steven Cooreman7f391872020-07-30 14:57:44 +0200671 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +0200672 if( status != PSA_SUCCESS )
673 goto exit;
674
675 slot->attr.bits = (psa_key_bits_t) PSA_BYTES_TO_BITS(
Steven Cooremana2371e52020-07-28 14:30:39 +0200676 mbedtls_rsa_get_len( rsa ) );
Steven Cooremana01795d2020-07-24 22:48:15 +0200677
Steven Cooreman75b74362020-07-28 14:30:13 +0200678 /* Re-export the data to PSA export format, such that we can store export
679 * representation in the key slot. Export representation in case of RSA is
680 * the smallest representation that's allowed as input, so a straight-up
681 * allocation of the same size as the input buffer will be large enough. */
Steven Cooremana01795d2020-07-24 22:48:15 +0200682 output = mbedtls_calloc( 1, data_length );
Steven Cooremana01795d2020-07-24 22:48:15 +0200683 if( output == NULL )
684 {
685 status = PSA_ERROR_INSUFFICIENT_MEMORY;
686 goto exit;
687 }
688
Steven Cooremana01795d2020-07-24 22:48:15 +0200689 status = psa_export_rsa_key( slot->attr.type,
Steven Cooremana2371e52020-07-28 14:30:39 +0200690 rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +0200691 output,
692 data_length,
693 &data_length);
Steven Cooremana01795d2020-07-24 22:48:15 +0200694exit:
695 /* Always free the RSA object */
Steven Cooremana2371e52020-07-28 14:30:39 +0200696 mbedtls_rsa_free( rsa );
Steven Cooreman6d839f02020-07-30 11:36:45 +0200697 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +0200698
699 /* Free the allocated buffer only on error. */
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000700 if( status != PSA_SUCCESS )
701 {
Steven Cooremana01795d2020-07-24 22:48:15 +0200702 mbedtls_free( output );
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000703 return( status );
704 }
705
Steven Cooremana01795d2020-07-24 22:48:15 +0200706 /* On success, store the allocated export-formatted key. */
707 slot->data.key.data = output;
708 slot->data.key.bytes = data_length;
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000709
710 return( PSA_SUCCESS );
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200711}
Steven Cooremana01795d2020-07-24 22:48:15 +0200712#endif /* defined(MBEDTLS_RSA_C) */
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200713
Jaeden Ameroccdce902019-01-10 11:42:27 +0000714#if defined(MBEDTLS_ECP_C)
Steven Cooreman7f391872020-07-30 14:57:44 +0200715/** Load the contents of a key buffer into an internal ECP representation
Steven Cooremana2371e52020-07-28 14:30:39 +0200716 *
Steven Cooreman4fed4552020-08-03 14:46:03 +0200717 * \param[in] type The type of key contained in \p data.
718 * \param[in] data The buffer from which to load the representation.
719 * \param[in] data_length The size in bytes of \p data.
720 * \param[out] p_ecp Returns a pointer to an ECP context on success.
721 * The caller is responsible for freeing both the
722 * contents of the context and the context itself
723 * when done.
Steven Cooremana2371e52020-07-28 14:30:39 +0200724 */
Steven Cooreman4fed4552020-08-03 14:46:03 +0200725static psa_status_t psa_load_ecp_representation( psa_key_type_t type,
726 const uint8_t *data,
727 size_t data_length,
Steven Cooremana2371e52020-07-28 14:30:39 +0200728 mbedtls_ecp_keypair **p_ecp )
Gilles Peskine4cd32772019-12-02 20:49:42 +0100729{
730 mbedtls_ecp_group_id grp_id = MBEDTLS_ECP_DP_NONE;
Steven Cooremanacda8342020-07-24 23:09:52 +0200731 psa_status_t status;
Steven Cooreman6d839f02020-07-30 11:36:45 +0200732 mbedtls_ecp_keypair *ecp = NULL;
Steven Cooreman4fed4552020-08-03 14:46:03 +0200733 size_t curve_size = data_length;
Gilles Peskine4cd32772019-12-02 20:49:42 +0100734
Steven Cooreman4fed4552020-08-03 14:46:03 +0200735 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) &&
736 PSA_KEY_TYPE_ECC_GET_FAMILY( type ) != PSA_ECC_FAMILY_MONTGOMERY )
Gilles Peskine4295e8b2019-12-02 21:39:10 +0100737 {
Steven Cooreman4fed4552020-08-03 14:46:03 +0200738 /* A Weierstrass public key is represented as:
739 * - The byte 0x04;
740 * - `x_P` as a `ceiling(m/8)`-byte string, big-endian;
741 * - `y_P` as a `ceiling(m/8)`-byte string, big-endian.
742 * So its data length is 2m+1 where n is the key size in bits.
743 */
744 if( ( data_length & 1 ) == 0 )
745 return( PSA_ERROR_INVALID_ARGUMENT );
746 curve_size = data_length / 2;
747
748 /* Montgomery public keys are represented in compressed format, meaning
749 * their curve_size is equal to the amount of input. */
750
751 /* Private keys are represented in uncompressed private random integer
752 * format, meaning their curve_size is equal to the amount of input. */
Gilles Peskine4295e8b2019-12-02 21:39:10 +0100753 }
754
Steven Cooreman6d839f02020-07-30 11:36:45 +0200755 /* Allocate and initialize a key representation. */
Steven Cooreman29149862020-08-05 15:43:42 +0200756 ecp = mbedtls_calloc( 1, sizeof( mbedtls_ecp_keypair ) );
Steven Cooreman6d839f02020-07-30 11:36:45 +0200757 if( ecp == NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200758 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Steven Cooremana2371e52020-07-28 14:30:39 +0200759 mbedtls_ecp_keypair_init( ecp );
760
Gilles Peskine4cd32772019-12-02 20:49:42 +0100761 /* Load the group. */
Steven Cooreman7f391872020-07-30 14:57:44 +0200762 grp_id = mbedtls_ecc_group_of_psa( PSA_KEY_TYPE_ECC_GET_FAMILY( type ),
763 curve_size );
Gilles Peskine4295e8b2019-12-02 21:39:10 +0100764 if( grp_id == MBEDTLS_ECP_DP_NONE )
Steven Cooreman6d839f02020-07-30 11:36:45 +0200765 {
766 status = PSA_ERROR_INVALID_ARGUMENT;
767 goto exit;
768 }
769
Steven Cooremanacda8342020-07-24 23:09:52 +0200770 status = mbedtls_to_psa_error(
771 mbedtls_ecp_group_load( &ecp->grp, grp_id ) );
772 if( status != PSA_SUCCESS )
Steven Cooreman6d839f02020-07-30 11:36:45 +0200773 goto exit;
Steven Cooremanacda8342020-07-24 23:09:52 +0200774
Steven Cooreman6d839f02020-07-30 11:36:45 +0200775 /* Load the key material. */
Steven Cooreman7f391872020-07-30 14:57:44 +0200776 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) )
Steven Cooremanacda8342020-07-24 23:09:52 +0200777 {
778 /* Load the public value. */
779 status = mbedtls_to_psa_error(
780 mbedtls_ecp_point_read_binary( &ecp->grp, &ecp->Q,
Steven Cooreman4fed4552020-08-03 14:46:03 +0200781 data,
782 data_length ) );
Steven Cooremanacda8342020-07-24 23:09:52 +0200783 if( status != PSA_SUCCESS )
784 goto exit;
785
786 /* Check that the point is on the curve. */
787 status = mbedtls_to_psa_error(
788 mbedtls_ecp_check_pubkey( &ecp->grp, &ecp->Q ) );
789 if( status != PSA_SUCCESS )
790 goto exit;
791 }
792 else
793 {
Steven Cooreman6d839f02020-07-30 11:36:45 +0200794 /* Load and validate the secret value. */
Steven Cooremanacda8342020-07-24 23:09:52 +0200795 status = mbedtls_to_psa_error(
796 mbedtls_ecp_read_key( ecp->grp.id,
797 ecp,
Steven Cooreman4fed4552020-08-03 14:46:03 +0200798 data,
799 data_length ) );
Steven Cooremanacda8342020-07-24 23:09:52 +0200800 if( status != PSA_SUCCESS )
801 goto exit;
Steven Cooremanacda8342020-07-24 23:09:52 +0200802 }
Steven Cooremana2371e52020-07-28 14:30:39 +0200803
804 *p_ecp = ecp;
Steven Cooremanacda8342020-07-24 23:09:52 +0200805exit:
806 if( status != PSA_SUCCESS )
Steven Cooremana2371e52020-07-28 14:30:39 +0200807 {
Steven Cooremanacda8342020-07-24 23:09:52 +0200808 mbedtls_ecp_keypair_free( ecp );
Steven Cooremana2371e52020-07-28 14:30:39 +0200809 mbedtls_free( ecp );
810 }
811
Steven Cooreman29149862020-08-05 15:43:42 +0200812 return( status );
Gilles Peskine4cd32772019-12-02 20:49:42 +0100813}
Jaeden Ameroccdce902019-01-10 11:42:27 +0000814
Steven Cooreman4fed4552020-08-03 14:46:03 +0200815/** Export an ECP key to export representation
816 *
817 * \param[in] type The type of key (public/private) to export
818 * \param[in] ecp The internal ECP representation from which to export
819 * \param[out] data The buffer to export to
820 * \param[in] data_size The length of the buffer to export to
821 * \param[out] data_length The amount of bytes written to \p data
822 */
Steven Cooremanacda8342020-07-24 23:09:52 +0200823static psa_status_t psa_export_ecp_key( psa_key_type_t type,
824 mbedtls_ecp_keypair *ecp,
825 uint8_t *data,
826 size_t data_size,
827 size_t *data_length )
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200828{
Steven Cooremanacda8342020-07-24 23:09:52 +0200829 psa_status_t status;
Jaeden Ameroccdce902019-01-10 11:42:27 +0000830
Steven Cooremanacda8342020-07-24 23:09:52 +0200831 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) )
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200832 {
Steven Cooremanacda8342020-07-24 23:09:52 +0200833 /* Check whether the public part is loaded */
834 if( mbedtls_ecp_is_zero( &ecp->Q ) )
835 {
836 /* Calculate the public key */
837 status = mbedtls_to_psa_error(
838 mbedtls_ecp_mul( &ecp->grp, &ecp->Q, &ecp->d, &ecp->grp.G,
839 mbedtls_ctr_drbg_random, &global_data.ctr_drbg ) );
840 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +0200841 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +0200842 }
843
Steven Cooreman4fed4552020-08-03 14:46:03 +0200844 status = mbedtls_to_psa_error(
Steven Cooremanacda8342020-07-24 23:09:52 +0200845 mbedtls_ecp_point_write_binary( &ecp->grp, &ecp->Q,
846 MBEDTLS_ECP_PF_UNCOMPRESSED,
847 data_length,
848 data,
Steven Cooreman4fed4552020-08-03 14:46:03 +0200849 data_size ) );
Steven Cooreman4fed4552020-08-03 14:46:03 +0200850 if( status != PSA_SUCCESS )
851 memset( data, 0, data_size );
852
Steven Cooreman29149862020-08-05 15:43:42 +0200853 return( status );
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200854 }
Steven Cooremanacda8342020-07-24 23:09:52 +0200855 else
856 {
Steven Cooreman29149862020-08-05 15:43:42 +0200857 if( data_size < PSA_BITS_TO_BYTES( ecp->grp.nbits ) )
Steven Cooremanacda8342020-07-24 23:09:52 +0200858 return( PSA_ERROR_BUFFER_TOO_SMALL );
859
860 status = mbedtls_to_psa_error(
861 mbedtls_ecp_write_key( ecp,
862 data,
Steven Cooreman29149862020-08-05 15:43:42 +0200863 PSA_BITS_TO_BYTES( ecp->grp.nbits ) ) );
Steven Cooremanacda8342020-07-24 23:09:52 +0200864 if( status == PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +0200865 *data_length = PSA_BITS_TO_BYTES( ecp->grp.nbits );
Steven Cooremanb7f6dea2020-08-05 16:07:20 +0200866 else
867 memset( data, 0, data_size );
Steven Cooremanacda8342020-07-24 23:09:52 +0200868
869 return( status );
870 }
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200871}
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200872
Steven Cooreman4fed4552020-08-03 14:46:03 +0200873/** Import an ECP key from import representation to a slot
874 *
875 * \param[in,out] slot The slot where to store the export representation to
876 * \param[in] data The buffer containing the import representation
877 * \param[in] data_length The amount of bytes in \p data
878 */
Steven Cooremanacda8342020-07-24 23:09:52 +0200879static psa_status_t psa_import_ecp_key( psa_key_slot_t *slot,
880 const uint8_t *data,
881 size_t data_length )
Gilles Peskinef76aa772018-10-29 19:24:33 +0100882{
Steven Cooremanacda8342020-07-24 23:09:52 +0200883 psa_status_t status;
884 uint8_t* output = NULL;
Steven Cooremana2371e52020-07-28 14:30:39 +0200885 mbedtls_ecp_keypair *ecp = NULL;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100886
Steven Cooremanacda8342020-07-24 23:09:52 +0200887 /* Parse input */
Steven Cooreman4fed4552020-08-03 14:46:03 +0200888 status = psa_load_ecp_representation( slot->attr.type,
889 data,
Steven Cooreman7f391872020-07-30 14:57:44 +0200890 data_length,
Steven Cooreman7f391872020-07-30 14:57:44 +0200891 &ecp );
Gilles Peskinef76aa772018-10-29 19:24:33 +0100892 if( status != PSA_SUCCESS )
893 goto exit;
Gilles Peskine4cd32772019-12-02 20:49:42 +0100894
Steven Cooremanacda8342020-07-24 23:09:52 +0200895 if( PSA_KEY_TYPE_ECC_GET_FAMILY( slot->attr.type ) == PSA_ECC_FAMILY_MONTGOMERY)
Steven Cooremana2371e52020-07-28 14:30:39 +0200896 slot->attr.bits = (psa_key_bits_t) ecp->grp.nbits + 1;
Steven Cooremanacda8342020-07-24 23:09:52 +0200897 else
Steven Cooremana2371e52020-07-28 14:30:39 +0200898 slot->attr.bits = (psa_key_bits_t) ecp->grp.nbits;
Steven Cooremane3fd3922020-06-11 16:50:36 +0200899
Steven Cooremanacda8342020-07-24 23:09:52 +0200900 /* Re-export the data to PSA export format. There is currently no support
901 * for other input formats then the export format, so this is a 1-1
902 * copy operation. */
903 output = mbedtls_calloc( 1, data_length );
Steven Cooremanacda8342020-07-24 23:09:52 +0200904 if( output == NULL )
905 {
906 status = PSA_ERROR_INSUFFICIENT_MEMORY;
907 goto exit;
908 }
909
910 status = psa_export_ecp_key( slot->attr.type,
Steven Cooremana2371e52020-07-28 14:30:39 +0200911 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +0200912 output,
913 data_length,
914 &data_length);
Gilles Peskinef76aa772018-10-29 19:24:33 +0100915exit:
Steven Cooremana2371e52020-07-28 14:30:39 +0200916 /* Always free the PK object (will also free contained ECP context) */
917 mbedtls_ecp_keypair_free( ecp );
Steven Cooreman6d839f02020-07-30 11:36:45 +0200918 mbedtls_free( ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +0200919
920 /* Free the allocated buffer only on error. */
921 if( status != PSA_SUCCESS )
Gilles Peskinef76aa772018-10-29 19:24:33 +0100922 {
Steven Cooremanacda8342020-07-24 23:09:52 +0200923 mbedtls_free( output );
Steven Cooremanacda8342020-07-24 23:09:52 +0200924 return( status );
Gilles Peskinef76aa772018-10-29 19:24:33 +0100925 }
Steven Cooremanacda8342020-07-24 23:09:52 +0200926
927 /* On success, store the allocated export-formatted key. */
928 slot->data.key.data = output;
929 slot->data.key.bytes = data_length;
930
931 return( PSA_SUCCESS );
Gilles Peskinef76aa772018-10-29 19:24:33 +0100932}
933#endif /* defined(MBEDTLS_ECP_C) */
934
Gilles Peskineb46bef22019-07-30 21:32:04 +0200935/** Return the size of the key in the given slot, in bits.
936 *
937 * \param[in] slot A key slot.
938 *
939 * \return The key size in bits, read from the metadata in the slot.
940 */
941static inline size_t psa_get_key_slot_bits( const psa_key_slot_t *slot )
942{
943 return( slot->attr.bits );
944}
945
Steven Cooreman75b74362020-07-28 14:30:13 +0200946/** Try to allocate a buffer to an empty key slot.
947 *
948 * \param[in,out] slot Key slot to attach buffer to.
949 * \param[in] buffer_length Requested size of the buffer.
950 *
951 * \retval #PSA_SUCCESS
952 * The buffer has been successfully allocated.
953 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
954 * Not enough memory was available for allocation.
955 * \retval #PSA_ERROR_ALREADY_EXISTS
956 * Trying to allocate a buffer to a non-empty key slot.
957 */
958static psa_status_t psa_allocate_buffer_to_slot( psa_key_slot_t *slot,
959 size_t buffer_length )
960{
961 if( slot->data.key.data != NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200962 return( PSA_ERROR_ALREADY_EXISTS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200963
964 slot->data.key.data = mbedtls_calloc( 1, buffer_length );
965 if( slot->data.key.data == NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200966 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Steven Cooreman75b74362020-07-28 14:30:13 +0200967
968 slot->data.key.bytes = buffer_length;
Steven Cooreman29149862020-08-05 15:43:42 +0200969 return( PSA_SUCCESS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200970}
971
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
Gilles Peskine8e338702019-07-30 20:06:31 +0200985/** Import key data into a slot. `slot->attr.type` must have been set
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100986 * previously. This function assumes that the slot does not contain
987 * any key material yet. On failure, the slot content is unchanged. */
Gilles Peskinefa4135b2018-12-10 16:48:53 +0100988psa_status_t psa_import_key_into_slot( psa_key_slot_t *slot,
989 const uint8_t *data,
990 size_t data_length )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100991{
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200992 psa_status_t status = PSA_SUCCESS;
Steven Cooreman04524762020-10-13 17:43:44 +0200993 size_t bit_size;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100994
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200995 /* zero-length keys are never supported. */
996 if( data_length == 0 )
997 return( PSA_ERROR_NOT_SUPPORTED );
998
Gilles Peskine8e338702019-07-30 20:06:31 +0200999 if( key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001000 {
Steven Cooreman04524762020-10-13 17:43:44 +02001001 bit_size = PSA_BYTES_TO_BITS( data_length );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02001002
Steven Cooreman75b74362020-07-28 14:30:13 +02001003 /* Ensure that the bytes-to-bits conversion hasn't overflown. */
1004 if( data_length > SIZE_MAX / 8 )
1005 return( PSA_ERROR_NOT_SUPPORTED );
1006
Gilles Peskine1b9505c2019-08-07 10:59:45 +02001007 /* Enforce a size limit, and in particular ensure that the bit
1008 * size fits in its representation type. */
Gilles Peskinec744d992019-07-30 17:26:54 +02001009 if( bit_size > PSA_MAX_KEY_BITS )
1010 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02001011
1012 status = validate_unstructured_key_bit_size( slot->attr.type, bit_size );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +02001013 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001014 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02001015
1016 /* Allocate memory for the key */
Steven Cooremanf7cebd42020-10-13 20:27:40 +02001017 status = psa_copy_key_material_into_slot( slot, data, data_length );
Steven Cooreman75b74362020-07-28 14:30:13 +02001018 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001019 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02001020
Steven Cooreman81be2fa2020-07-24 22:04:59 +02001021 /* Write the actual key size to the slot.
1022 * psa_start_key_creation() wrote the size declared by the
1023 * caller, which may be 0 (meaning unspecified) or wrong. */
1024 slot->attr.bits = (psa_key_bits_t) bit_size;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001025 }
Steven Cooreman19fd5742020-07-24 23:31:01 +02001026 else if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
1027 {
Gilles Peskinef76aa772018-10-29 19:24:33 +01001028#if defined(MBEDTLS_ECP_C)
Steven Cooreman19fd5742020-07-24 23:31:01 +02001029 status = psa_import_ecp_key( slot,
1030 data, data_length );
1031#else
1032 /* No drivers have been implemented yet, so without mbed TLS backing
1033 * there's no way to do ECP with the current library. */
1034 return( PSA_ERROR_NOT_SUPPORTED );
1035#endif /* defined(MBEDTLS_ECP_C) */
1036 }
1037 else if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskinef76aa772018-10-29 19:24:33 +01001038 {
Steven Cooreman19fd5742020-07-24 23:31:01 +02001039#if defined(MBEDTLS_RSA_C)
1040 status = psa_import_rsa_key( slot,
1041 data, data_length );
1042#else
1043 /* No drivers have been implemented yet, so without mbed TLS backing
1044 * there's no way to do RSA with the current library. */
1045 status = PSA_ERROR_NOT_SUPPORTED;
1046#endif /* defined(MBEDTLS_RSA_C) */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001047 }
1048 else
Gilles Peskinec66ea6a2018-02-03 22:43:28 +01001049 {
Steven Cooreman19fd5742020-07-24 23:31:01 +02001050 /* Unknown key type */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001051 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969ac722018-01-28 18:16:59 +01001052 }
Darryl Green940d72c2018-07-13 13:18:51 +01001053
Darryl Green06fd18d2018-07-16 11:21:11 +01001054 return( status );
1055}
1056
Gilles Peskinef603c712019-01-19 13:40:11 +01001057/** Calculate the intersection of two algorithm usage policies.
1058 *
1059 * Return 0 (which allows no operation) on incompatibility.
1060 */
1061static psa_algorithm_t psa_key_policy_algorithm_intersection(
1062 psa_algorithm_t alg1,
1063 psa_algorithm_t alg2 )
1064{
Gilles Peskine549ea862019-05-22 11:45:59 +02001065 /* Common case: both sides actually specify the same policy. */
Gilles Peskinef603c712019-01-19 13:40:11 +01001066 if( alg1 == alg2 )
1067 return( alg1 );
1068 /* If the policies are from the same hash-and-sign family, check
1069 * if one is a wildcard. If so the other has the specific algorithm. */
1070 if( PSA_ALG_IS_HASH_AND_SIGN( alg1 ) &&
1071 PSA_ALG_IS_HASH_AND_SIGN( alg2 ) &&
1072 ( alg1 & ~PSA_ALG_HASH_MASK ) == ( alg2 & ~PSA_ALG_HASH_MASK ) )
1073 {
1074 if( PSA_ALG_SIGN_GET_HASH( alg1 ) == PSA_ALG_ANY_HASH )
1075 return( alg2 );
1076 if( PSA_ALG_SIGN_GET_HASH( alg2 ) == PSA_ALG_ANY_HASH )
1077 return( alg1 );
1078 }
1079 /* If the policies are incompatible, allow nothing. */
1080 return( 0 );
1081}
1082
Gilles Peskined6f371b2019-05-10 19:33:38 +02001083static int psa_key_algorithm_permits( psa_algorithm_t policy_alg,
1084 psa_algorithm_t requested_alg )
1085{
Gilles Peskine549ea862019-05-22 11:45:59 +02001086 /* Common case: the policy only allows requested_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +02001087 if( requested_alg == policy_alg )
1088 return( 1 );
1089 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
Gilles Peskine549ea862019-05-22 11:45:59 +02001090 * and requested_alg is the same hash-and-sign family with any hash,
1091 * then requested_alg is compliant with policy_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +02001092 if( PSA_ALG_IS_HASH_AND_SIGN( requested_alg ) &&
1093 PSA_ALG_SIGN_GET_HASH( policy_alg ) == PSA_ALG_ANY_HASH )
1094 {
1095 return( ( policy_alg & ~PSA_ALG_HASH_MASK ) ==
1096 ( requested_alg & ~PSA_ALG_HASH_MASK ) );
1097 }
Steven Cooremance48e852020-10-05 16:02:45 +02001098 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +02001099 * a key derivation with that key agreement should also be allowed. This
1100 * behaviour is expected to be defined in a future specification version. */
Steven Cooremance48e852020-10-05 16:02:45 +02001101 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( policy_alg ) &&
1102 PSA_ALG_IS_KEY_AGREEMENT( requested_alg ) )
1103 {
1104 return( PSA_ALG_KEY_AGREEMENT_GET_BASE( requested_alg ) ==
1105 policy_alg );
1106 }
Gilles Peskined6f371b2019-05-10 19:33:38 +02001107 /* If it isn't permitted, it's forbidden. */
1108 return( 0 );
1109}
1110
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001111/** Test whether a policy permits an algorithm.
1112 *
1113 * The caller must test usage flags separately.
1114 */
1115static int psa_key_policy_permits( const psa_key_policy_t *policy,
1116 psa_algorithm_t alg )
1117{
Gilles Peskined6f371b2019-05-10 19:33:38 +02001118 return( psa_key_algorithm_permits( policy->alg, alg ) ||
1119 psa_key_algorithm_permits( policy->alg2, alg ) );
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001120}
1121
Gilles Peskinef603c712019-01-19 13:40:11 +01001122/** Restrict a key policy based on a constraint.
1123 *
1124 * \param[in,out] policy The policy to restrict.
1125 * \param[in] constraint The policy constraint to apply.
1126 *
1127 * \retval #PSA_SUCCESS
1128 * \c *policy contains the intersection of the original value of
1129 * \c *policy and \c *constraint.
1130 * \retval #PSA_ERROR_INVALID_ARGUMENT
1131 * \c *policy and \c *constraint are incompatible.
1132 * \c *policy is unchanged.
1133 */
1134static psa_status_t psa_restrict_key_policy(
1135 psa_key_policy_t *policy,
1136 const psa_key_policy_t *constraint )
1137{
1138 psa_algorithm_t intersection_alg =
1139 psa_key_policy_algorithm_intersection( policy->alg, constraint->alg );
Gilles Peskined6f371b2019-05-10 19:33:38 +02001140 psa_algorithm_t intersection_alg2 =
1141 psa_key_policy_algorithm_intersection( policy->alg2, constraint->alg2 );
Gilles Peskinef603c712019-01-19 13:40:11 +01001142 if( intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0 )
1143 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskined6f371b2019-05-10 19:33:38 +02001144 if( intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0 )
1145 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinef603c712019-01-19 13:40:11 +01001146 policy->usage &= constraint->usage;
1147 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +02001148 policy->alg2 = intersection_alg2;
Gilles Peskinef603c712019-01-19 13:40:11 +01001149 return( PSA_SUCCESS );
1150}
1151
Darryl Green06fd18d2018-07-16 11:21:11 +01001152/** Retrieve a slot which must contain a key. The key must have allow all the
1153 * usage flags set in \p usage. If \p alg is nonzero, the key must allow
1154 * operations with this algorithm. */
Gilles Peskinec5487a82018-12-03 18:08:14 +01001155static psa_status_t psa_get_key_from_slot( psa_key_handle_t handle,
Gilles Peskine2f060a82018-12-04 17:12:32 +01001156 psa_key_slot_t **p_slot,
Darryl Green06fd18d2018-07-16 11:21:11 +01001157 psa_key_usage_t usage,
1158 psa_algorithm_t alg )
1159{
1160 psa_status_t status;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001161 psa_key_slot_t *slot = NULL;
Darryl Green06fd18d2018-07-16 11:21:11 +01001162
1163 *p_slot = NULL;
1164
Gilles Peskinec5487a82018-12-03 18:08:14 +01001165 status = psa_get_key_slot( handle, &slot );
Darryl Green06fd18d2018-07-16 11:21:11 +01001166 if( status != PSA_SUCCESS )
1167 return( status );
Darryl Green06fd18d2018-07-16 11:21:11 +01001168
1169 /* Enforce that usage policy for the key slot contains all the flags
1170 * required by the usage parameter. There is one exception: public
1171 * keys can always be exported, so we treat public key objects as
1172 * if they had the export flag. */
Gilles Peskine8e338702019-07-30 20:06:31 +02001173 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Darryl Green06fd18d2018-07-16 11:21:11 +01001174 usage &= ~PSA_KEY_USAGE_EXPORT;
Gilles Peskine8e338702019-07-30 20:06:31 +02001175 if( ( slot->attr.policy.usage & usage ) != usage )
Darryl Green06fd18d2018-07-16 11:21:11 +01001176 return( PSA_ERROR_NOT_PERMITTED );
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001177
1178 /* Enforce that the usage policy permits the requested algortihm. */
Gilles Peskine8e338702019-07-30 20:06:31 +02001179 if( alg != 0 && ! psa_key_policy_permits( &slot->attr.policy, alg ) )
Darryl Green06fd18d2018-07-16 11:21:11 +01001180 return( PSA_ERROR_NOT_PERMITTED );
1181
1182 *p_slot = slot;
1183 return( PSA_SUCCESS );
1184}
Darryl Green940d72c2018-07-13 13:18:51 +01001185
Gilles Peskine28f8f302019-07-24 13:30:31 +02001186/** Retrieve a slot which must contain a transparent key.
1187 *
1188 * A transparent key is a key for which the key material is directly
1189 * available, as opposed to a key in a secure element.
1190 *
Gilles Peskine60450a42019-07-25 11:32:45 +02001191 * This is a temporary function to use instead of psa_get_key_from_slot()
1192 * until secure element support is fully implemented.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001193 */
1194#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1195static psa_status_t psa_get_transparent_key( psa_key_handle_t handle,
1196 psa_key_slot_t **p_slot,
1197 psa_key_usage_t usage,
1198 psa_algorithm_t alg )
1199{
1200 psa_status_t status = psa_get_key_from_slot( handle, p_slot, usage, alg );
1201 if( status != PSA_SUCCESS )
1202 return( status );
Gilles Peskineadad8132019-07-25 11:31:23 +02001203 if( psa_key_slot_is_external( *p_slot ) )
Gilles Peskine28f8f302019-07-24 13:30:31 +02001204 {
1205 *p_slot = NULL;
1206 return( PSA_ERROR_NOT_SUPPORTED );
1207 }
1208 return( PSA_SUCCESS );
1209}
1210#else /* MBEDTLS_PSA_CRYPTO_SE_C */
1211/* With no secure element support, all keys are transparent. */
1212#define psa_get_transparent_key( handle, p_slot, usage, alg ) \
1213 psa_get_key_from_slot( handle, p_slot, usage, alg )
1214#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1215
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001216/** Wipe key data from a slot. Preserve metadata such as the policy. */
Gilles Peskine2f060a82018-12-04 17:12:32 +01001217static psa_status_t psa_remove_key_data_from_memory( psa_key_slot_t *slot )
Darryl Green40225ba2018-11-15 14:48:15 +00001218{
Gilles Peskine73167e12019-07-12 23:44:37 +02001219#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1220 if( psa_key_slot_is_external( slot ) )
Darryl Green40225ba2018-11-15 14:48:15 +00001221 {
1222 /* No key material to clean. */
1223 }
Gilles Peskine73167e12019-07-12 23:44:37 +02001224 else
1225#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Darryl Green40225ba2018-11-15 14:48:15 +00001226 {
Steven Cooremanfd4d69a2020-08-05 15:46:33 +02001227 /* Data pointer will always be either a valid pointer or NULL in an
1228 * initialized slot, so we can just free it. */
1229 if( slot->data.key.data != NULL )
1230 mbedtls_platform_zeroize( slot->data.key.data, slot->data.key.bytes);
Steven Cooremana01795d2020-07-24 22:48:15 +02001231 mbedtls_free( slot->data.key.data );
1232 slot->data.key.data = NULL;
1233 slot->data.key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +00001234 }
Darryl Green40225ba2018-11-15 14:48:15 +00001235
1236 return( PSA_SUCCESS );
1237}
1238
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001239/** Completely wipe a slot in memory, including its policy.
1240 * Persistent storage is not affected. */
Gilles Peskine66fb1262018-12-10 16:29:04 +01001241psa_status_t psa_wipe_key_slot( psa_key_slot_t *slot )
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001242{
1243 psa_status_t status = psa_remove_key_data_from_memory( slot );
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001244 /* Multipart operations may still be using the key. This is safe
1245 * because all multipart operation objects are independent from
1246 * the key slot: if they need to access the key after the setup
1247 * phase, they have a copy of the key. Note that this means that
1248 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001249 /* At this point, key material and other type-specific content has
1250 * been wiped. Clear remaining metadata. We can call memset and not
1251 * zeroize because the metadata is not particularly sensitive. */
1252 memset( slot, 0, sizeof( *slot ) );
1253 return( status );
1254}
1255
Gilles Peskinec5487a82018-12-03 18:08:14 +01001256psa_status_t psa_destroy_key( psa_key_handle_t handle )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001257{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001258 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001259 psa_status_t status; /* status of the last operation */
1260 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001261#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1262 psa_se_drv_table_entry_t *driver;
1263#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001264
Gilles Peskine1841cf42019-10-08 15:48:25 +02001265 if( handle == 0 )
1266 return( PSA_SUCCESS );
1267
Gilles Peskinec5487a82018-12-03 18:08:14 +01001268 status = psa_get_key_slot( handle, &slot );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001269 if( status != PSA_SUCCESS )
1270 return( status );
Gilles Peskine354f7672019-07-12 23:46:38 +02001271
1272#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001273 driver = psa_get_se_driver_entry( slot->attr.lifetime );
Gilles Peskine354f7672019-07-12 23:46:38 +02001274 if( driver != NULL )
Gilles Peskinefc762652019-07-22 19:30:34 +02001275 {
Gilles Peskine60450a42019-07-25 11:32:45 +02001276 /* For a key in a secure element, we need to do three things:
1277 * remove the key file in internal storage, destroy the
1278 * key inside the secure element, and update the driver's
1279 * persistent data. Start a transaction that will encompass these
1280 * three actions. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001281 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_DESTROY_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +02001282 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Gilles Peskinefc762652019-07-22 19:30:34 +02001283 psa_crypto_transaction.key.slot = slot->data.se.slot_number;
Gilles Peskine8e338702019-07-30 20:06:31 +02001284 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskinefc762652019-07-22 19:30:34 +02001285 status = psa_crypto_save_transaction( );
1286 if( status != PSA_SUCCESS )
1287 {
Gilles Peskine66be51c2019-07-25 18:02:52 +02001288 (void) psa_crypto_stop_transaction( );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001289 /* We should still try to destroy the key in the secure
1290 * element and the key metadata in storage. This is especially
1291 * important if the error is that the storage is full.
1292 * But how to do it exactly without risking an inconsistent
1293 * state after a reset?
1294 * https://github.com/ARMmbed/mbed-crypto/issues/215
1295 */
1296 overall_status = status;
1297 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001298 }
1299
Gilles Peskine354f7672019-07-12 23:46:38 +02001300 status = psa_destroy_se_key( driver, slot->data.se.slot_number );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001301 if( overall_status == PSA_SUCCESS )
1302 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001303 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001304#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1305
Darryl Greend49a4992018-06-18 17:27:26 +01001306#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskinecaec2782019-08-13 15:11:49 +02001307 if( slot->attr.lifetime != PSA_KEY_LIFETIME_VOLATILE )
Darryl Greend49a4992018-06-18 17:27:26 +01001308 {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001309 status = psa_destroy_persistent_key( slot->attr.id );
1310 if( overall_status == PSA_SUCCESS )
1311 overall_status = status;
1312
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001313 /* TODO: other slots may have a copy of the same key. We should
1314 * invalidate them.
1315 * https://github.com/ARMmbed/mbed-crypto/issues/214
1316 */
Darryl Greend49a4992018-06-18 17:27:26 +01001317 }
1318#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001319
Gilles Peskinefc762652019-07-22 19:30:34 +02001320#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1321 if( driver != NULL )
1322 {
Gilles Peskine725f22a2019-07-25 11:31:48 +02001323 status = psa_save_se_persistent_data( driver );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001324 if( overall_status == PSA_SUCCESS )
1325 overall_status = status;
1326 status = psa_crypto_stop_transaction( );
1327 if( overall_status == PSA_SUCCESS )
1328 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001329 }
1330#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1331
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001332#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1333exit:
1334#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001335 status = psa_wipe_key_slot( slot );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001336 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
1337 if( overall_status == PSA_SUCCESS )
1338 overall_status = status;
1339 return( overall_status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001340}
1341
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001342void psa_reset_key_attributes( psa_key_attributes_t *attributes )
Gilles Peskineb870b182018-07-06 16:02:09 +02001343{
Gilles Peskineb699f072019-04-26 16:06:02 +02001344 mbedtls_free( attributes->domain_parameters );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001345 memset( attributes, 0, sizeof( *attributes ) );
Gilles Peskineb870b182018-07-06 16:02:09 +02001346}
1347
Gilles Peskineb699f072019-04-26 16:06:02 +02001348psa_status_t psa_set_key_domain_parameters( psa_key_attributes_t *attributes,
1349 psa_key_type_t type,
1350 const uint8_t *data,
1351 size_t data_length )
1352{
1353 uint8_t *copy = NULL;
1354
1355 if( data_length != 0 )
1356 {
1357 copy = mbedtls_calloc( 1, data_length );
1358 if( copy == NULL )
1359 return( PSA_ERROR_INSUFFICIENT_MEMORY );
1360 memcpy( copy, data, data_length );
1361 }
1362 /* After this point, this function is guaranteed to succeed, so it
1363 * can start modifying `*attributes`. */
1364
1365 if( attributes->domain_parameters != NULL )
1366 {
1367 mbedtls_free( attributes->domain_parameters );
1368 attributes->domain_parameters = NULL;
1369 attributes->domain_parameters_size = 0;
1370 }
1371
1372 attributes->domain_parameters = copy;
1373 attributes->domain_parameters_size = data_length;
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001374 attributes->core.type = type;
Gilles Peskineb699f072019-04-26 16:06:02 +02001375 return( PSA_SUCCESS );
1376}
1377
1378psa_status_t psa_get_key_domain_parameters(
1379 const psa_key_attributes_t *attributes,
1380 uint8_t *data, size_t data_size, size_t *data_length )
1381{
1382 if( attributes->domain_parameters_size > data_size )
1383 return( PSA_ERROR_BUFFER_TOO_SMALL );
1384 *data_length = attributes->domain_parameters_size;
1385 if( attributes->domain_parameters_size != 0 )
1386 memcpy( data, attributes->domain_parameters,
1387 attributes->domain_parameters_size );
1388 return( PSA_SUCCESS );
1389}
1390
1391#if defined(MBEDTLS_RSA_C)
1392static psa_status_t psa_get_rsa_public_exponent(
1393 const mbedtls_rsa_context *rsa,
1394 psa_key_attributes_t *attributes )
1395{
1396 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001397 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001398 uint8_t *buffer = NULL;
1399 size_t buflen;
1400 mbedtls_mpi_init( &mpi );
1401
1402 ret = mbedtls_rsa_export( rsa, NULL, NULL, NULL, NULL, &mpi );
1403 if( ret != 0 )
1404 goto exit;
Gilles Peskine772c8b12019-04-26 17:37:21 +02001405 if( mbedtls_mpi_cmp_int( &mpi, 65537 ) == 0 )
1406 {
1407 /* It's the default value, which is reported as an empty string,
1408 * so there's nothing to do. */
1409 goto exit;
1410 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001411
1412 buflen = mbedtls_mpi_size( &mpi );
1413 buffer = mbedtls_calloc( 1, buflen );
1414 if( buffer == NULL )
1415 {
1416 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1417 goto exit;
1418 }
1419 ret = mbedtls_mpi_write_binary( &mpi, buffer, buflen );
1420 if( ret != 0 )
1421 goto exit;
1422 attributes->domain_parameters = buffer;
1423 attributes->domain_parameters_size = buflen;
1424
1425exit:
1426 mbedtls_mpi_free( &mpi );
1427 if( ret != 0 )
1428 mbedtls_free( buffer );
1429 return( mbedtls_to_psa_error( ret ) );
1430}
1431#endif /* MBEDTLS_RSA_C */
1432
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001433/** Retrieve all the publicly-accessible attributes of a key.
1434 */
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001435psa_status_t psa_get_key_attributes( psa_key_handle_t handle,
1436 psa_key_attributes_t *attributes )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001437{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001438 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001439 psa_status_t status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001440
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001441 psa_reset_key_attributes( attributes );
1442
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001443 status = psa_get_key_from_slot( handle, &slot, 0, 0 );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001444 if( status != PSA_SUCCESS )
1445 return( status );
Gilles Peskineb870b182018-07-06 16:02:09 +02001446
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001447 attributes->core = slot->attr;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001448 attributes->core.flags &= ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1449 MBEDTLS_PSA_KA_MASK_DUAL_USE );
1450
1451#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1452 if( psa_key_slot_is_external( slot ) )
1453 psa_set_key_slot_number( attributes, slot->data.se.slot_number );
1454#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001455
Gilles Peskine8e338702019-07-30 20:06:31 +02001456 switch( slot->attr.type )
Gilles Peskineb699f072019-04-26 16:06:02 +02001457 {
1458#if defined(MBEDTLS_RSA_C)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001459 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001460 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001461#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001462 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001463 * is not yet implemented.
1464 * https://github.com/ARMmbed/mbed-crypto/issues/216
1465 */
Gilles Peskinec8000c02019-08-02 20:15:51 +02001466 if( psa_key_slot_is_external( slot ) )
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001467 break;
1468#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Steven Cooremana01795d2020-07-24 22:48:15 +02001469 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001470 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001471
Steven Cooreman4fed4552020-08-03 14:46:03 +02001472 status = psa_load_rsa_representation( slot->attr.type,
1473 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02001474 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02001475 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001476 if( status != PSA_SUCCESS )
1477 break;
1478
Steven Cooremana2371e52020-07-28 14:30:39 +02001479 status = psa_get_rsa_public_exponent( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02001480 attributes );
Steven Cooremana2371e52020-07-28 14:30:39 +02001481 mbedtls_rsa_free( rsa );
1482 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001483 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001484 break;
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001485#endif /* MBEDTLS_RSA_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001486 default:
1487 /* Nothing else to do. */
1488 break;
1489 }
1490
1491 if( status != PSA_SUCCESS )
1492 psa_reset_key_attributes( attributes );
1493 return( status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001494}
1495
Gilles Peskinec8000c02019-08-02 20:15:51 +02001496#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1497psa_status_t psa_get_key_slot_number(
1498 const psa_key_attributes_t *attributes,
1499 psa_key_slot_number_t *slot_number )
1500{
1501 if( attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER )
1502 {
1503 *slot_number = attributes->slot_number;
1504 return( PSA_SUCCESS );
1505 }
1506 else
1507 return( PSA_ERROR_INVALID_ARGUMENT );
1508}
1509#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1510
Steven Cooremana01795d2020-07-24 22:48:15 +02001511static psa_status_t psa_internal_export_key_buffer( const psa_key_slot_t *slot,
1512 uint8_t *data,
1513 size_t data_size,
1514 size_t *data_length )
1515{
1516 if( slot->data.key.bytes > data_size )
1517 return( PSA_ERROR_BUFFER_TOO_SMALL );
1518 memcpy( data, slot->data.key.data, slot->data.key.bytes );
1519 memset( data + slot->data.key.bytes, 0,
1520 data_size - slot->data.key.bytes );
1521 *data_length = slot->data.key.bytes;
1522 return( PSA_SUCCESS );
1523}
1524
Gilles Peskinef603c712019-01-19 13:40:11 +01001525static psa_status_t psa_internal_export_key( const psa_key_slot_t *slot,
1526 uint8_t *data,
1527 size_t data_size,
1528 size_t *data_length,
1529 int export_public_key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001530{
Gilles Peskine5d309672019-07-12 23:47:28 +02001531#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1532 const psa_drv_se_t *drv;
1533 psa_drv_se_context_t *drv_context;
1534#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1535
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001536 *data_length = 0;
1537
Gilles Peskine8e338702019-07-30 20:06:31 +02001538 if( export_public_key && ! PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
Moran Pekera998bc62018-04-16 18:16:20 +03001539 return( PSA_ERROR_INVALID_ARGUMENT );
mohammad160306e79202018-03-28 13:17:44 +03001540
Gilles Peskinef9168942019-09-12 19:20:29 +02001541 /* Reject a zero-length output buffer now, since this can never be a
1542 * valid key representation. This way we know that data must be a valid
1543 * pointer and we can do things like memset(data, ..., data_size). */
1544 if( data_size == 0 )
1545 return( PSA_ERROR_BUFFER_TOO_SMALL );
1546
Gilles Peskine5d309672019-07-12 23:47:28 +02001547#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001548 if( psa_get_se_driver( slot->attr.lifetime, &drv, &drv_context ) )
Gilles Peskine5d309672019-07-12 23:47:28 +02001549 {
1550 psa_drv_se_export_key_t method;
1551 if( drv->key_management == NULL )
1552 return( PSA_ERROR_NOT_SUPPORTED );
1553 method = ( export_public_key ?
1554 drv->key_management->p_export_public :
1555 drv->key_management->p_export );
1556 if( method == NULL )
1557 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine2e0f3882019-07-25 11:34:33 +02001558 return( method( drv_context,
1559 slot->data.se.slot_number,
1560 data, data_size, data_length ) );
Gilles Peskine5d309672019-07-12 23:47:28 +02001561 }
1562#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1563
Gilles Peskine8e338702019-07-30 20:06:31 +02001564 if( key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001565 {
Steven Cooremanacda8342020-07-24 23:09:52 +02001566 return( psa_internal_export_key_buffer( slot, data, data_size, data_length ) );
Gilles Peskine188c71e2018-10-29 19:26:02 +01001567 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001568 else if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) ||
1569 PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
Moran Peker17e36e12018-05-02 12:55:20 +03001570 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001571 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Gilles Peskine969ac722018-01-28 18:16:59 +01001572 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001573 /* Exporting public -> public */
1574 return( psa_internal_export_key_buffer( slot, data, data_size, data_length ) );
1575 }
1576 else if( !export_public_key )
1577 {
1578 /* Exporting private -> private */
1579 return( psa_internal_export_key_buffer( slot, data, data_size, data_length ) );
1580 }
1581 /* Need to export the public part of a private key,
1582 * so conversion is needed */
1583 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
1584 {
Darryl Green9e2d7a02018-07-24 16:33:30 +01001585#if defined(MBEDTLS_RSA_C)
Steven Cooremana2371e52020-07-28 14:30:39 +02001586 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman7f391872020-07-30 14:57:44 +02001587 psa_status_t status = psa_load_rsa_representation(
Steven Cooreman4fed4552020-08-03 14:46:03 +02001588 slot->attr.type,
Steven Cooreman7f391872020-07-30 14:57:44 +02001589 slot->data.key.data,
1590 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02001591 &rsa );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001592 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001593 return( status );
Steven Cooremana01795d2020-07-24 22:48:15 +02001594
Steven Cooreman560c28a2020-07-24 23:20:24 +02001595 status = psa_export_rsa_key( PSA_KEY_TYPE_RSA_PUBLIC_KEY,
Steven Cooremana2371e52020-07-28 14:30:39 +02001596 rsa,
Steven Cooreman560c28a2020-07-24 23:20:24 +02001597 data,
1598 data_size,
1599 data_length );
Steven Cooremana01795d2020-07-24 22:48:15 +02001600
Steven Cooremana2371e52020-07-28 14:30:39 +02001601 mbedtls_rsa_free( rsa );
1602 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001603
Steven Cooreman560c28a2020-07-24 23:20:24 +02001604 return( status );
Darryl Green9e2d7a02018-07-24 16:33:30 +01001605#else
Steven Cooreman560c28a2020-07-24 23:20:24 +02001606 /* We don't know how to convert a private RSA key to public. */
1607 return( PSA_ERROR_NOT_SUPPORTED );
Darryl Green9e2d7a02018-07-24 16:33:30 +01001608#endif
Gilles Peskine969ac722018-01-28 18:16:59 +01001609 }
1610 else
Moran Pekera998bc62018-04-16 18:16:20 +03001611 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001612#if defined(MBEDTLS_ECP_C)
Steven Cooremana2371e52020-07-28 14:30:39 +02001613 mbedtls_ecp_keypair *ecp = NULL;
Steven Cooreman7f391872020-07-30 14:57:44 +02001614 psa_status_t status = psa_load_ecp_representation(
Steven Cooreman4fed4552020-08-03 14:46:03 +02001615 slot->attr.type,
Steven Cooreman7f391872020-07-30 14:57:44 +02001616 slot->data.key.data,
1617 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02001618 &ecp );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001619 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001620 return( status );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001621
1622 status = psa_export_ecp_key( PSA_KEY_TYPE_ECC_PUBLIC_KEY(
1623 PSA_KEY_TYPE_ECC_GET_FAMILY(
1624 slot->attr.type ) ),
Steven Cooremana2371e52020-07-28 14:30:39 +02001625 ecp,
Steven Cooreman560c28a2020-07-24 23:20:24 +02001626 data,
1627 data_size,
1628 data_length );
1629
Steven Cooremana2371e52020-07-28 14:30:39 +02001630 mbedtls_ecp_keypair_free( ecp );
1631 mbedtls_free( ecp );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001632 return( status );
1633#else
1634 /* We don't know how to convert a private ECC key to public */
Moran Pekera998bc62018-04-16 18:16:20 +03001635 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001636#endif
Moran Pekera998bc62018-04-16 18:16:20 +03001637 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001638 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001639 else
1640 {
1641 /* This shouldn't happen in the reference implementation, but
1642 it is valid for a special-purpose implementation to omit
1643 support for exporting certain key types. */
1644 return( PSA_ERROR_NOT_SUPPORTED );
1645 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001646}
1647
Gilles Peskinec5487a82018-12-03 18:08:14 +01001648psa_status_t psa_export_key( psa_key_handle_t handle,
Gilles Peskine2d277862018-06-18 15:41:12 +02001649 uint8_t *data,
1650 size_t data_size,
1651 size_t *data_length )
Moran Pekera998bc62018-04-16 18:16:20 +03001652{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001653 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001654 psa_status_t status;
1655
1656 /* Set the key to empty now, so that even when there are errors, we always
1657 * set data_length to a value between 0 and data_size. On error, setting
1658 * the key to empty is a good choice because an empty key representation is
1659 * unlikely to be accepted anywhere. */
1660 *data_length = 0;
1661
1662 /* Export requires the EXPORT flag. There is an exception for public keys,
1663 * which don't require any flag, but psa_get_key_from_slot takes
1664 * care of this. */
Gilles Peskinec5487a82018-12-03 18:08:14 +01001665 status = psa_get_key_from_slot( handle, &slot, PSA_KEY_USAGE_EXPORT, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001666 if( status != PSA_SUCCESS )
1667 return( status );
1668 return( psa_internal_export_key( slot, data, data_size,
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02001669 data_length, 0 ) );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001670}
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001671
Gilles Peskinec5487a82018-12-03 18:08:14 +01001672psa_status_t psa_export_public_key( psa_key_handle_t handle,
Gilles Peskine2d277862018-06-18 15:41:12 +02001673 uint8_t *data,
1674 size_t data_size,
1675 size_t *data_length )
Moran Pekerdd4ea382018-04-03 15:30:03 +03001676{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001677 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001678 psa_status_t status;
1679
1680 /* Set the key to empty now, so that even when there are errors, we always
1681 * set data_length to a value between 0 and data_size. On error, setting
1682 * the key to empty is a good choice because an empty key representation is
1683 * unlikely to be accepted anywhere. */
1684 *data_length = 0;
1685
1686 /* Exporting a public key doesn't require a usage flag. */
Gilles Peskinec5487a82018-12-03 18:08:14 +01001687 status = psa_get_key_from_slot( handle, &slot, 0, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001688 if( status != PSA_SUCCESS )
1689 return( status );
1690 return( psa_internal_export_key( slot, data, data_size,
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02001691 data_length, 1 ) );
Moran Pekerdd4ea382018-04-03 15:30:03 +03001692}
1693
Gilles Peskine91e8c332019-08-02 19:19:39 +02001694#if defined(static_assert)
1695static_assert( ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
1696 "One or more key attribute flag is listed as both external-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001697static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
Gilles Peskine094dac12019-08-07 18:19:46 +02001698 "One or more key attribute flag is listed as both internal-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001699static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY ) == 0,
Gilles Peskine91e8c332019-08-02 19:19:39 +02001700 "One or more key attribute flag is listed as both internal-only and external-only" );
1701#endif
1702
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001703/** Validate that a key policy is internally well-formed.
1704 *
1705 * This function only rejects invalid policies. It does not validate the
1706 * consistency of the policy with respect to other attributes of the key
1707 * such as the key type.
1708 */
1709static psa_status_t psa_validate_key_policy( const psa_key_policy_t *policy )
Gilles Peskine4747d192019-04-17 15:05:45 +02001710{
1711 if( ( policy->usage & ~( PSA_KEY_USAGE_EXPORT |
Gilles Peskine8e0206a2019-05-14 14:24:28 +02001712 PSA_KEY_USAGE_COPY |
Gilles Peskine4747d192019-04-17 15:05:45 +02001713 PSA_KEY_USAGE_ENCRYPT |
1714 PSA_KEY_USAGE_DECRYPT |
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001715 PSA_KEY_USAGE_SIGN_HASH |
1716 PSA_KEY_USAGE_VERIFY_HASH |
Gilles Peskine4747d192019-04-17 15:05:45 +02001717 PSA_KEY_USAGE_DERIVE ) ) != 0 )
1718 return( PSA_ERROR_INVALID_ARGUMENT );
1719
Gilles Peskine4747d192019-04-17 15:05:45 +02001720 return( PSA_SUCCESS );
1721}
1722
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001723/** Validate the internal consistency of key attributes.
1724 *
1725 * This function only rejects invalid attribute values. If does not
1726 * validate the consistency of the attributes with any key data that may
1727 * be involved in the creation of the key.
1728 *
1729 * Call this function early in the key creation process.
1730 *
1731 * \param[in] attributes Key attributes for the new key.
1732 * \param[out] p_drv On any return, the driver for the key, if any.
1733 * NULL for a transparent key.
1734 *
1735 */
1736static psa_status_t psa_validate_key_attributes(
1737 const psa_key_attributes_t *attributes,
1738 psa_se_drv_table_entry_t **p_drv )
Darryl Green0c6575a2018-11-07 16:05:30 +00001739{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001740 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001741
Steven Cooreman8c1e7592020-06-17 14:52:05 +02001742 status = psa_validate_key_location( psa_get_key_lifetime( attributes ),
1743 p_drv );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001744 if( status != PSA_SUCCESS )
1745 return( status );
1746
Steven Cooreman8c1e7592020-06-17 14:52:05 +02001747 status = psa_validate_key_persistence( psa_get_key_lifetime( attributes ),
1748 psa_get_key_id( attributes ) );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001749 if( status != PSA_SUCCESS )
1750 return( status );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001751
1752 status = psa_validate_key_policy( &attributes->core.policy );
Darryl Green0c6575a2018-11-07 16:05:30 +00001753 if( status != PSA_SUCCESS )
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001754 return( status );
1755
1756 /* Refuse to create overly large keys.
1757 * Note that this doesn't trigger on import if the attributes don't
1758 * explicitly specify a size (so psa_get_key_bits returns 0), so
1759 * psa_import_key() needs its own checks. */
1760 if( psa_get_key_bits( attributes ) > PSA_MAX_KEY_BITS )
1761 return( PSA_ERROR_NOT_SUPPORTED );
1762
Gilles Peskine91e8c332019-08-02 19:19:39 +02001763 /* Reject invalid flags. These should not be reachable through the API. */
1764 if( attributes->core.flags & ~ ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1765 MBEDTLS_PSA_KA_MASK_DUAL_USE ) )
1766 return( PSA_ERROR_INVALID_ARGUMENT );
1767
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001768 return( PSA_SUCCESS );
1769}
1770
Gilles Peskine4747d192019-04-17 15:05:45 +02001771/** Prepare a key slot to receive key material.
1772 *
1773 * This function allocates a key slot and sets its metadata.
1774 *
1775 * If this function fails, call psa_fail_key_creation().
1776 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001777 * This function is intended to be used as follows:
1778 * -# Call psa_start_key_creation() to allocate a key slot, prepare
1779 * it with the specified attributes, and assign it a handle.
1780 * -# Populate the slot with the key material.
1781 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1782 * In case of failure at any step, stop the sequence and call
1783 * psa_fail_key_creation().
1784 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001785 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001786 * \param[in] attributes Key attributes for the new key.
1787 * \param[out] handle On success, a handle for the allocated slot.
1788 * \param[out] p_slot On success, a pointer to the prepared slot.
1789 * \param[out] p_drv On any return, the driver for the key, if any.
1790 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001791 *
1792 * \retval #PSA_SUCCESS
1793 * The key slot is ready to receive key material.
1794 * \return If this function fails, the key slot is an invalid state.
1795 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001796 */
1797static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001798 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001799 const psa_key_attributes_t *attributes,
1800 psa_key_handle_t *handle,
Gilles Peskine011e4282019-06-26 18:34:38 +02001801 psa_key_slot_t **p_slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001802 psa_se_drv_table_entry_t **p_drv )
Gilles Peskine4747d192019-04-17 15:05:45 +02001803{
1804 psa_status_t status;
1805 psa_key_slot_t *slot;
1806
Gilles Peskinedf179142019-07-15 22:02:14 +02001807 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001808 *p_drv = NULL;
1809
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001810 status = psa_validate_key_attributes( attributes, p_drv );
1811 if( status != PSA_SUCCESS )
1812 return( status );
1813
Gilles Peskineedbed562019-08-07 18:19:59 +02001814 status = psa_get_empty_key_slot( handle, p_slot );
Gilles Peskine4747d192019-04-17 15:05:45 +02001815 if( status != PSA_SUCCESS )
1816 return( status );
1817 slot = *p_slot;
1818
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001819 /* We're storing the declared bit-size of the key. It's up to each
1820 * creation mechanism to verify that this information is correct.
1821 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001822 * an input (generate, device) but not for those where the bit-size
1823 * is optional (import, copy). */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001824
1825 slot->attr = attributes->core;
Gilles Peskinec744d992019-07-30 17:26:54 +02001826
Gilles Peskine91e8c332019-08-02 19:19:39 +02001827 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001828 * external-only flags, query `attributes`. Thanks to the check
1829 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001830 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001831 * may have set. */
1832 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001833
Gilles Peskinecbaff462019-07-12 23:46:04 +02001834#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001835 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001836 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001837 * create the key file in internal storage, create the
1838 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001839 * persistent data. This is done by starting a transaction that will
1840 * encompass these three actions.
1841 * For registering a volatile key, we just need to find an appropriate
1842 * slot number inside the SE. Since the key is designated volatile, creating
1843 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001844 /* The first thing to do is to find a slot number for the new key.
1845 * We save the slot number in persistent storage as part of the
1846 * transaction data. It will be needed to recover if the power
1847 * fails during the key creation process, to clean up on the secure
1848 * element side after restarting. Obtaining a slot number from the
1849 * secure element driver updates its persistent state, but we do not yet
1850 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001851 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001852 if( *p_drv != NULL )
Darryl Green0c6575a2018-11-07 16:05:30 +00001853 {
Gilles Peskinee88c2c12019-08-05 16:44:14 +02001854 status = psa_find_se_slot_for_key( attributes, method, *p_drv,
Gilles Peskinecbaff462019-07-12 23:46:04 +02001855 &slot->data.se.slot_number );
1856 if( status != PSA_SUCCESS )
1857 return( status );
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001858
1859 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( attributes->core.lifetime ) )
Gilles Peskine66be51c2019-07-25 18:02:52 +02001860 {
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001861 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_CREATE_KEY );
1862 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
1863 psa_crypto_transaction.key.slot = slot->data.se.slot_number;
1864 psa_crypto_transaction.key.id = slot->attr.id;
1865 status = psa_crypto_save_transaction( );
1866 if( status != PSA_SUCCESS )
1867 {
1868 (void) psa_crypto_stop_transaction( );
1869 return( status );
1870 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001871 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001872 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001873
1874 if( *p_drv == NULL && method == PSA_KEY_CREATION_REGISTER )
1875 {
1876 /* Key registration only makes sense with a secure element. */
1877 return( PSA_ERROR_INVALID_ARGUMENT );
1878 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001879#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1880
Darryl Green0c6575a2018-11-07 16:05:30 +00001881 return( status );
1882}
Gilles Peskine4747d192019-04-17 15:05:45 +02001883
1884/** Finalize the creation of a key once its key material has been set.
1885 *
1886 * This entails writing the key to persistent storage.
1887 *
1888 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001889 * See the documentation of psa_start_key_creation() for the intended use
1890 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001891 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001892 * \param[in,out] slot Pointer to the slot with key material.
1893 * \param[in] driver The secure element driver for the key,
1894 * or NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001895 *
1896 * \retval #PSA_SUCCESS
1897 * The key was successfully created. The handle is now valid.
1898 * \return If this function fails, the key slot is an invalid state.
1899 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001900 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001901static psa_status_t psa_finish_key_creation(
1902 psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001903 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001904{
1905 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001906 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001907 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001908
1909#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Steven Cooremanc59de6a2020-06-08 18:28:25 +02001910 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Gilles Peskine4747d192019-04-17 15:05:45 +02001911 {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001912#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1913 if( driver != NULL )
1914 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001915 psa_se_key_data_storage_t data;
1916#if defined(static_assert)
1917 static_assert( sizeof( slot->data.se.slot_number ) ==
1918 sizeof( data.slot_number ),
1919 "Slot number size does not match psa_se_key_data_storage_t" );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001920#endif
1921 memcpy( &data.slot_number, &slot->data.se.slot_number,
1922 sizeof( slot->data.se.slot_number ) );
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001923 status = psa_save_persistent_key( &slot->attr,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001924 (uint8_t*) &data,
1925 sizeof( data ) );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001926 }
1927 else
1928#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1929 {
Gilles Peskinee60d1d02019-07-24 20:27:59 +02001930 size_t buffer_size =
Gilles Peskine8e338702019-07-30 20:06:31 +02001931 PSA_KEY_EXPORT_MAX_SIZE( slot->attr.type,
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001932 slot->attr.bits );
Gilles Peskinee60d1d02019-07-24 20:27:59 +02001933 uint8_t *buffer = mbedtls_calloc( 1, buffer_size );
1934 size_t length = 0;
Gilles Peskinef9168942019-09-12 19:20:29 +02001935 if( buffer == NULL )
Gilles Peskine1df83d42019-07-23 16:13:14 +02001936 return( PSA_ERROR_INSUFFICIENT_MEMORY );
1937 status = psa_internal_export_key( slot,
1938 buffer, buffer_size, &length,
1939 0 );
Gilles Peskinee60d1d02019-07-24 20:27:59 +02001940 if( status == PSA_SUCCESS )
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001941 status = psa_save_persistent_key( &slot->attr,
Gilles Peskine4ed0e6f2019-07-30 20:22:33 +02001942 buffer, length );
Gilles Peskine4747d192019-04-17 15:05:45 +02001943
Gilles Peskinef9168942019-09-12 19:20:29 +02001944 mbedtls_platform_zeroize( buffer, buffer_size );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001945 mbedtls_free( buffer );
1946 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001947 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001948#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1949
Gilles Peskinecbaff462019-07-12 23:46:04 +02001950#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001951 /* Finish the transaction for a key creation. This does not
1952 * happen when registering an existing key. Detect this case
1953 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001954 * creation of a persistent key in a secure element requires a transaction,
1955 * but registration or volatile key creation doesn't use one). */
Gilles Peskined7729582019-08-05 15:55:54 +02001956 if( driver != NULL &&
1957 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY )
Gilles Peskinecbaff462019-07-12 23:46:04 +02001958 {
1959 status = psa_save_se_persistent_data( driver );
1960 if( status != PSA_SUCCESS )
1961 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001962 psa_destroy_persistent_key( slot->attr.id );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001963 return( status );
1964 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001965 status = psa_crypto_stop_transaction( );
1966 if( status != PSA_SUCCESS )
1967 return( status );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001968 }
1969#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1970
Gilles Peskine4747d192019-04-17 15:05:45 +02001971 return( status );
1972}
1973
1974/** Abort the creation of a key.
1975 *
1976 * You may call this function after calling psa_start_key_creation(),
1977 * or after psa_finish_key_creation() fails. In other circumstances, this
1978 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001979 * See the documentation of psa_start_key_creation() for the intended use
1980 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001981 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001982 * \param[in,out] slot Pointer to the slot with key material.
1983 * \param[in] driver The secure element driver for the key,
1984 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001985 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001986static void psa_fail_key_creation( psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001987 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001988{
Gilles Peskine011e4282019-06-26 18:34:38 +02001989 (void) driver;
1990
Gilles Peskine4747d192019-04-17 15:05:45 +02001991 if( slot == NULL )
1992 return;
Gilles Peskine011e4282019-06-26 18:34:38 +02001993
1994#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001995 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001996 * element, and the failure happened later (when saving metadata
1997 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001998 * element.
1999 * https://github.com/ARMmbed/mbed-crypto/issues/217
2000 */
Gilles Peskinefc762652019-07-22 19:30:34 +02002001
Gilles Peskined7729582019-08-05 15:55:54 +02002002 /* Abort the ongoing transaction if any (there may not be one if
2003 * the creation process failed before starting one, or if the
2004 * key creation is a registration of a key in a secure element).
2005 * Earlier functions must already have done what it takes to undo any
2006 * partial creation. All that's left is to update the transaction data
2007 * itself. */
Gilles Peskinefc762652019-07-22 19:30:34 +02002008 (void) psa_crypto_stop_transaction( );
Gilles Peskine011e4282019-06-26 18:34:38 +02002009#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2010
Gilles Peskine4747d192019-04-17 15:05:45 +02002011 psa_wipe_key_slot( slot );
2012}
2013
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002014/** Validate optional attributes during key creation.
2015 *
2016 * Some key attributes are optional during key creation. If they are
2017 * specified in the attributes structure, check that they are consistent
2018 * with the data in the slot.
2019 *
2020 * This function should be called near the end of key creation, after
2021 * the slot in memory is fully populated but before saving persistent data.
2022 */
2023static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002024 const psa_key_slot_t *slot,
2025 const psa_key_attributes_t *attributes )
2026{
Gilles Peskine7e0cff92019-07-30 13:48:52 +02002027 if( attributes->core.type != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002028 {
Gilles Peskine8e338702019-07-30 20:06:31 +02002029 if( attributes->core.type != slot->attr.type )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002030 return( PSA_ERROR_INVALID_ARGUMENT );
2031 }
2032
2033 if( attributes->domain_parameters_size != 0 )
2034 {
2035#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02002036 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002037 {
Steven Cooremana2371e52020-07-28 14:30:39 +02002038 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02002039 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02002040 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02002041
Steven Cooreman7f391872020-07-30 14:57:44 +02002042 psa_status_t status = psa_load_rsa_representation(
Steven Cooreman4fed4552020-08-03 14:46:03 +02002043 slot->attr.type,
Steven Cooreman7f391872020-07-30 14:57:44 +02002044 slot->data.key.data,
2045 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02002046 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02002047 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02002048 return( status );
Steven Cooreman75b74362020-07-28 14:30:13 +02002049
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002050 mbedtls_mpi_init( &actual );
2051 mbedtls_mpi_init( &required );
Steven Cooremana2371e52020-07-28 14:30:39 +02002052 ret = mbedtls_rsa_export( rsa,
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002053 NULL, NULL, NULL, NULL, &actual );
Steven Cooremana2371e52020-07-28 14:30:39 +02002054 mbedtls_rsa_free( rsa );
2055 mbedtls_free( rsa );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002056 if( ret != 0 )
2057 goto rsa_exit;
2058 ret = mbedtls_mpi_read_binary( &required,
2059 attributes->domain_parameters,
2060 attributes->domain_parameters_size );
2061 if( ret != 0 )
2062 goto rsa_exit;
2063 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
2064 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
2065 rsa_exit:
2066 mbedtls_mpi_free( &actual );
2067 mbedtls_mpi_free( &required );
2068 if( ret != 0)
2069 return( mbedtls_to_psa_error( ret ) );
2070 }
2071 else
2072#endif
2073 {
2074 return( PSA_ERROR_INVALID_ARGUMENT );
2075 }
2076 }
2077
Gilles Peskine7e0cff92019-07-30 13:48:52 +02002078 if( attributes->core.bits != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002079 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02002080 if( attributes->core.bits != slot->attr.bits )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002081 return( PSA_ERROR_INVALID_ARGUMENT );
2082 }
2083
2084 return( PSA_SUCCESS );
2085}
2086
Gilles Peskine4747d192019-04-17 15:05:45 +02002087psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02002088 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02002089 size_t data_length,
2090 psa_key_handle_t *handle )
Gilles Peskine4747d192019-04-17 15:05:45 +02002091{
2092 psa_status_t status;
2093 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002094 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002095
Gilles Peskine0f84d622019-09-12 19:03:13 +02002096 /* Reject zero-length symmetric keys (including raw data key objects).
2097 * This also rejects any key which might be encoded as an empty string,
2098 * which is never valid. */
2099 if( data_length == 0 )
2100 return( PSA_ERROR_INVALID_ARGUMENT );
2101
Gilles Peskinedf179142019-07-15 22:02:14 +02002102 status = psa_start_key_creation( PSA_KEY_CREATION_IMPORT, attributes,
2103 handle, &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002104 if( status != PSA_SUCCESS )
2105 goto exit;
2106
Gilles Peskine5d309672019-07-12 23:47:28 +02002107#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2108 if( driver != NULL )
2109 {
2110 const psa_drv_se_t *drv = psa_get_se_driver_methods( driver );
Darryl Green0892d0f2019-08-20 09:50:14 +01002111 /* The driver should set the number of key bits, however in
2112 * case it doesn't, we initialize bits to an invalid value. */
2113 size_t bits = PSA_MAX_KEY_BITS + 1;
Gilles Peskine5d309672019-07-12 23:47:28 +02002114 if( drv->key_management == NULL ||
2115 drv->key_management->p_import == NULL )
2116 {
2117 status = PSA_ERROR_NOT_SUPPORTED;
2118 goto exit;
2119 }
2120 status = drv->key_management->p_import(
2121 psa_get_se_driver_context( driver ),
Gilles Peskinef3801ff2019-08-06 17:32:04 +02002122 slot->data.se.slot_number, attributes, data, data_length,
Gilles Peskineb46bef22019-07-30 21:32:04 +02002123 &bits );
2124 if( status != PSA_SUCCESS )
2125 goto exit;
2126 if( bits > PSA_MAX_KEY_BITS )
2127 {
2128 status = PSA_ERROR_NOT_SUPPORTED;
2129 goto exit;
2130 }
2131 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskine5d309672019-07-12 23:47:28 +02002132 }
2133 else
2134#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2135 {
2136 status = psa_import_key_into_slot( slot, data, data_length );
2137 if( status != PSA_SUCCESS )
2138 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02002139 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002140 status = psa_validate_optional_attributes( slot, attributes );
Gilles Peskine18017402019-07-24 20:25:59 +02002141 if( status != PSA_SUCCESS )
2142 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002143
Gilles Peskine011e4282019-06-26 18:34:38 +02002144 status = psa_finish_key_creation( slot, driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002145exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02002146 if( status != PSA_SUCCESS )
2147 {
Gilles Peskine011e4282019-06-26 18:34:38 +02002148 psa_fail_key_creation( slot, driver );
Gilles Peskine4747d192019-04-17 15:05:45 +02002149 *handle = 0;
2150 }
2151 return( status );
2152}
2153
Gilles Peskined7729582019-08-05 15:55:54 +02002154#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2155psa_status_t mbedtls_psa_register_se_key(
2156 const psa_key_attributes_t *attributes )
2157{
2158 psa_status_t status;
2159 psa_key_slot_t *slot = NULL;
2160 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskined7729582019-08-05 15:55:54 +02002161 psa_key_handle_t handle = 0;
2162
2163 /* Leaving attributes unspecified is not currently supported.
2164 * It could make sense to query the key type and size from the
2165 * secure element, but not all secure elements support this
2166 * and the driver HAL doesn't currently support it. */
2167 if( psa_get_key_type( attributes ) == PSA_KEY_TYPE_NONE )
2168 return( PSA_ERROR_NOT_SUPPORTED );
2169 if( psa_get_key_bits( attributes ) == 0 )
2170 return( PSA_ERROR_NOT_SUPPORTED );
2171
2172 status = psa_start_key_creation( PSA_KEY_CREATION_REGISTER, attributes,
2173 &handle, &slot, &driver );
2174 if( status != PSA_SUCCESS )
2175 goto exit;
2176
Gilles Peskined7729582019-08-05 15:55:54 +02002177 status = psa_finish_key_creation( slot, driver );
2178
2179exit:
2180 if( status != PSA_SUCCESS )
2181 {
2182 psa_fail_key_creation( slot, driver );
2183 }
2184 /* Registration doesn't keep the key in RAM. */
2185 psa_close_key( handle );
2186 return( status );
2187}
2188#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2189
Gilles Peskinef603c712019-01-19 13:40:11 +01002190static psa_status_t psa_copy_key_material( const psa_key_slot_t *source,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002191 psa_key_slot_t *target )
Gilles Peskinef603c712019-01-19 13:40:11 +01002192{
Steven Cooremanf7cebd42020-10-13 20:27:40 +02002193 psa_status_t status = psa_copy_key_material_into_slot( target,
2194 source->data.key.data,
2195 source->data.key.bytes );
Gilles Peskinef603c712019-01-19 13:40:11 +01002196 if( status != PSA_SUCCESS )
Steven Cooreman398aee52020-10-13 14:35:45 +02002197 return( status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002198
Steven Cooreman398aee52020-10-13 14:35:45 +02002199 target->attr.type = source->attr.type;
2200 target->attr.bits = source->attr.bits;
2201
2202 return( PSA_SUCCESS );
Gilles Peskinef603c712019-01-19 13:40:11 +01002203}
2204
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002205psa_status_t psa_copy_key( psa_key_handle_t source_handle,
2206 const psa_key_attributes_t *specified_attributes,
2207 psa_key_handle_t *target_handle )
Gilles Peskinef603c712019-01-19 13:40:11 +01002208{
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002209 psa_status_t status;
Gilles Peskinef603c712019-01-19 13:40:11 +01002210 psa_key_slot_t *source_slot = NULL;
2211 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002212 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002213 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskinef603c712019-01-19 13:40:11 +01002214
Gilles Peskine28f8f302019-07-24 13:30:31 +02002215 status = psa_get_transparent_key( source_handle, &source_slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02002216 PSA_KEY_USAGE_COPY, 0 );
Gilles Peskinef603c712019-01-19 13:40:11 +01002217 if( status != PSA_SUCCESS )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002218 goto exit;
2219
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002220 status = psa_validate_optional_attributes( source_slot,
2221 specified_attributes );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002222 if( status != PSA_SUCCESS )
2223 goto exit;
2224
Gilles Peskine7e0cff92019-07-30 13:48:52 +02002225 status = psa_restrict_key_policy( &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02002226 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002227 if( status != PSA_SUCCESS )
2228 goto exit;
2229
Gilles Peskinedf179142019-07-15 22:02:14 +02002230 status = psa_start_key_creation( PSA_KEY_CREATION_COPY,
2231 &actual_attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02002232 target_handle, &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002233 if( status != PSA_SUCCESS )
2234 goto exit;
2235
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002236#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2237 if( driver != NULL )
Gilles Peskinef603c712019-01-19 13:40:11 +01002238 {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002239 /* Copying to a secure element is not implemented yet. */
2240 status = PSA_ERROR_NOT_SUPPORTED;
2241 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002242 }
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002243#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef603c712019-01-19 13:40:11 +01002244
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002245 status = psa_copy_key_material( source_slot, target_slot );
Gilles Peskinef603c712019-01-19 13:40:11 +01002246 if( status != PSA_SUCCESS )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002247 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002248
Gilles Peskine011e4282019-06-26 18:34:38 +02002249 status = psa_finish_key_creation( target_slot, driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002250exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002251 if( status != PSA_SUCCESS )
2252 {
Gilles Peskine011e4282019-06-26 18:34:38 +02002253 psa_fail_key_creation( target_slot, driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002254 *target_handle = 0;
2255 }
2256 return( status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002257}
2258
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002259
2260
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002261/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002262/* Message digests */
2263/****************************************************************/
2264
Gilles Peskineb16841e2019-10-10 20:36:12 +02002265#if defined(MBEDTLS_RSA_C) || defined(MBEDTLS_ECDSA_DETERMINISTIC)
Gilles Peskinedc2fc842018-03-07 16:42:59 +01002266static const mbedtls_md_info_t *mbedtls_md_info_from_psa( psa_algorithm_t alg )
Gilles Peskine20035e32018-02-03 22:44:14 +01002267{
2268 switch( alg )
2269 {
2270#if defined(MBEDTLS_MD2_C)
2271 case PSA_ALG_MD2:
2272 return( &mbedtls_md2_info );
2273#endif
2274#if defined(MBEDTLS_MD4_C)
2275 case PSA_ALG_MD4:
2276 return( &mbedtls_md4_info );
2277#endif
2278#if defined(MBEDTLS_MD5_C)
2279 case PSA_ALG_MD5:
2280 return( &mbedtls_md5_info );
2281#endif
2282#if defined(MBEDTLS_RIPEMD160_C)
2283 case PSA_ALG_RIPEMD160:
2284 return( &mbedtls_ripemd160_info );
2285#endif
2286#if defined(MBEDTLS_SHA1_C)
2287 case PSA_ALG_SHA_1:
2288 return( &mbedtls_sha1_info );
2289#endif
2290#if defined(MBEDTLS_SHA256_C)
2291 case PSA_ALG_SHA_224:
2292 return( &mbedtls_sha224_info );
2293 case PSA_ALG_SHA_256:
2294 return( &mbedtls_sha256_info );
2295#endif
2296#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnardd6020842019-07-17 16:28:21 +02002297#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine20035e32018-02-03 22:44:14 +01002298 case PSA_ALG_SHA_384:
2299 return( &mbedtls_sha384_info );
Manuel Pégourié-Gonnardd6020842019-07-17 16:28:21 +02002300#endif
Gilles Peskine20035e32018-02-03 22:44:14 +01002301 case PSA_ALG_SHA_512:
2302 return( &mbedtls_sha512_info );
2303#endif
2304 default:
2305 return( NULL );
2306 }
2307}
Gilles Peskineb16841e2019-10-10 20:36:12 +02002308#endif
Gilles Peskine20035e32018-02-03 22:44:14 +01002309
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002310psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
2311{
2312 switch( operation->alg )
2313 {
Gilles Peskine81736312018-06-26 15:04:31 +02002314 case 0:
2315 /* The object has (apparently) been initialized but it is not
2316 * in use. It's ok to call abort on such an object, and there's
2317 * nothing to do. */
2318 break;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002319#if defined(MBEDTLS_MD2_C)
2320 case PSA_ALG_MD2:
2321 mbedtls_md2_free( &operation->ctx.md2 );
2322 break;
2323#endif
2324#if defined(MBEDTLS_MD4_C)
2325 case PSA_ALG_MD4:
2326 mbedtls_md4_free( &operation->ctx.md4 );
2327 break;
2328#endif
2329#if defined(MBEDTLS_MD5_C)
2330 case PSA_ALG_MD5:
2331 mbedtls_md5_free( &operation->ctx.md5 );
2332 break;
2333#endif
2334#if defined(MBEDTLS_RIPEMD160_C)
2335 case PSA_ALG_RIPEMD160:
2336 mbedtls_ripemd160_free( &operation->ctx.ripemd160 );
2337 break;
2338#endif
2339#if defined(MBEDTLS_SHA1_C)
2340 case PSA_ALG_SHA_1:
2341 mbedtls_sha1_free( &operation->ctx.sha1 );
2342 break;
2343#endif
2344#if defined(MBEDTLS_SHA256_C)
2345 case PSA_ALG_SHA_224:
2346 case PSA_ALG_SHA_256:
2347 mbedtls_sha256_free( &operation->ctx.sha256 );
2348 break;
2349#endif
2350#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002351#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002352 case PSA_ALG_SHA_384:
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002353#endif
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002354 case PSA_ALG_SHA_512:
2355 mbedtls_sha512_free( &operation->ctx.sha512 );
2356 break;
2357#endif
2358 default:
Gilles Peskinef9c2c092018-06-21 16:57:07 +02002359 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002360 }
2361 operation->alg = 0;
2362 return( PSA_SUCCESS );
2363}
2364
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002365psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002366 psa_algorithm_t alg )
2367{
Janos Follath24eed8d2019-11-22 13:21:35 +00002368 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002369
2370 /* A context must be freshly initialized before it can be set up. */
2371 if( operation->alg != 0 )
2372 {
2373 return( PSA_ERROR_BAD_STATE );
2374 }
2375
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002376 switch( alg )
2377 {
2378#if defined(MBEDTLS_MD2_C)
2379 case PSA_ALG_MD2:
2380 mbedtls_md2_init( &operation->ctx.md2 );
2381 ret = mbedtls_md2_starts_ret( &operation->ctx.md2 );
2382 break;
2383#endif
2384#if defined(MBEDTLS_MD4_C)
2385 case PSA_ALG_MD4:
2386 mbedtls_md4_init( &operation->ctx.md4 );
2387 ret = mbedtls_md4_starts_ret( &operation->ctx.md4 );
2388 break;
2389#endif
2390#if defined(MBEDTLS_MD5_C)
2391 case PSA_ALG_MD5:
2392 mbedtls_md5_init( &operation->ctx.md5 );
2393 ret = mbedtls_md5_starts_ret( &operation->ctx.md5 );
2394 break;
2395#endif
2396#if defined(MBEDTLS_RIPEMD160_C)
2397 case PSA_ALG_RIPEMD160:
2398 mbedtls_ripemd160_init( &operation->ctx.ripemd160 );
2399 ret = mbedtls_ripemd160_starts_ret( &operation->ctx.ripemd160 );
2400 break;
2401#endif
2402#if defined(MBEDTLS_SHA1_C)
2403 case PSA_ALG_SHA_1:
2404 mbedtls_sha1_init( &operation->ctx.sha1 );
2405 ret = mbedtls_sha1_starts_ret( &operation->ctx.sha1 );
2406 break;
2407#endif
2408#if defined(MBEDTLS_SHA256_C)
2409 case PSA_ALG_SHA_224:
2410 mbedtls_sha256_init( &operation->ctx.sha256 );
2411 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 1 );
2412 break;
2413 case PSA_ALG_SHA_256:
2414 mbedtls_sha256_init( &operation->ctx.sha256 );
2415 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 0 );
2416 break;
2417#endif
2418#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002419#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002420 case PSA_ALG_SHA_384:
2421 mbedtls_sha512_init( &operation->ctx.sha512 );
2422 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 1 );
2423 break;
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002424#endif
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002425 case PSA_ALG_SHA_512:
2426 mbedtls_sha512_init( &operation->ctx.sha512 );
2427 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 0 );
2428 break;
2429#endif
2430 default:
Gilles Peskinec06e0712018-06-20 16:21:04 +02002431 return( PSA_ALG_IS_HASH( alg ) ?
2432 PSA_ERROR_NOT_SUPPORTED :
2433 PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002434 }
2435 if( ret == 0 )
2436 operation->alg = alg;
2437 else
2438 psa_hash_abort( operation );
2439 return( mbedtls_to_psa_error( ret ) );
2440}
2441
2442psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2443 const uint8_t *input,
2444 size_t input_length )
2445{
Janos Follath24eed8d2019-11-22 13:21:35 +00002446 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine94e44542018-07-12 16:58:43 +02002447
2448 /* Don't require hash implementations to behave correctly on a
2449 * zero-length input, which may have an invalid pointer. */
2450 if( input_length == 0 )
2451 return( PSA_SUCCESS );
2452
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002453 switch( operation->alg )
2454 {
2455#if defined(MBEDTLS_MD2_C)
2456 case PSA_ALG_MD2:
2457 ret = mbedtls_md2_update_ret( &operation->ctx.md2,
2458 input, input_length );
2459 break;
2460#endif
2461#if defined(MBEDTLS_MD4_C)
2462 case PSA_ALG_MD4:
2463 ret = mbedtls_md4_update_ret( &operation->ctx.md4,
2464 input, input_length );
2465 break;
2466#endif
2467#if defined(MBEDTLS_MD5_C)
2468 case PSA_ALG_MD5:
2469 ret = mbedtls_md5_update_ret( &operation->ctx.md5,
2470 input, input_length );
2471 break;
2472#endif
2473#if defined(MBEDTLS_RIPEMD160_C)
2474 case PSA_ALG_RIPEMD160:
2475 ret = mbedtls_ripemd160_update_ret( &operation->ctx.ripemd160,
2476 input, input_length );
2477 break;
2478#endif
2479#if defined(MBEDTLS_SHA1_C)
2480 case PSA_ALG_SHA_1:
2481 ret = mbedtls_sha1_update_ret( &operation->ctx.sha1,
2482 input, input_length );
2483 break;
2484#endif
2485#if defined(MBEDTLS_SHA256_C)
2486 case PSA_ALG_SHA_224:
2487 case PSA_ALG_SHA_256:
2488 ret = mbedtls_sha256_update_ret( &operation->ctx.sha256,
2489 input, input_length );
2490 break;
2491#endif
2492#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002493#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002494 case PSA_ALG_SHA_384:
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002495#endif
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002496 case PSA_ALG_SHA_512:
2497 ret = mbedtls_sha512_update_ret( &operation->ctx.sha512,
2498 input, input_length );
2499 break;
2500#endif
2501 default:
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002502 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002503 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002504
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002505 if( ret != 0 )
2506 psa_hash_abort( operation );
2507 return( mbedtls_to_psa_error( ret ) );
2508}
2509
2510psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2511 uint8_t *hash,
2512 size_t hash_size,
2513 size_t *hash_length )
2514{
itayzafrir40835d42018-08-02 13:14:17 +03002515 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00002516 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine71bb7b72018-04-19 08:29:59 +02002517 size_t actual_hash_length = PSA_HASH_SIZE( operation->alg );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002518
2519 /* Fill the output buffer with something that isn't a valid hash
2520 * (barring an attack on the hash and deliberately-crafted input),
2521 * in case the caller doesn't check the return status properly. */
Gilles Peskineaee13332018-07-02 12:15:28 +02002522 *hash_length = hash_size;
Gilles Peskine46f1fd72018-06-28 19:31:31 +02002523 /* If hash_size is 0 then hash may be NULL and then the
2524 * call to memset would have undefined behavior. */
2525 if( hash_size != 0 )
2526 memset( hash, '!', hash_size );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002527
2528 if( hash_size < actual_hash_length )
itayzafrir40835d42018-08-02 13:14:17 +03002529 {
2530 status = PSA_ERROR_BUFFER_TOO_SMALL;
2531 goto exit;
2532 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002533
2534 switch( operation->alg )
2535 {
2536#if defined(MBEDTLS_MD2_C)
2537 case PSA_ALG_MD2:
2538 ret = mbedtls_md2_finish_ret( &operation->ctx.md2, hash );
2539 break;
2540#endif
2541#if defined(MBEDTLS_MD4_C)
2542 case PSA_ALG_MD4:
2543 ret = mbedtls_md4_finish_ret( &operation->ctx.md4, hash );
2544 break;
2545#endif
2546#if defined(MBEDTLS_MD5_C)
2547 case PSA_ALG_MD5:
2548 ret = mbedtls_md5_finish_ret( &operation->ctx.md5, hash );
2549 break;
2550#endif
2551#if defined(MBEDTLS_RIPEMD160_C)
2552 case PSA_ALG_RIPEMD160:
2553 ret = mbedtls_ripemd160_finish_ret( &operation->ctx.ripemd160, hash );
2554 break;
2555#endif
2556#if defined(MBEDTLS_SHA1_C)
2557 case PSA_ALG_SHA_1:
2558 ret = mbedtls_sha1_finish_ret( &operation->ctx.sha1, hash );
2559 break;
2560#endif
2561#if defined(MBEDTLS_SHA256_C)
2562 case PSA_ALG_SHA_224:
2563 case PSA_ALG_SHA_256:
2564 ret = mbedtls_sha256_finish_ret( &operation->ctx.sha256, hash );
2565 break;
2566#endif
2567#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002568#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002569 case PSA_ALG_SHA_384:
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002570#endif
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002571 case PSA_ALG_SHA_512:
2572 ret = mbedtls_sha512_finish_ret( &operation->ctx.sha512, hash );
2573 break;
2574#endif
2575 default:
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002576 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002577 }
itayzafrir40835d42018-08-02 13:14:17 +03002578 status = mbedtls_to_psa_error( ret );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002579
itayzafrir40835d42018-08-02 13:14:17 +03002580exit:
2581 if( status == PSA_SUCCESS )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002582 {
Gilles Peskineaee13332018-07-02 12:15:28 +02002583 *hash_length = actual_hash_length;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002584 return( psa_hash_abort( operation ) );
2585 }
2586 else
2587 {
2588 psa_hash_abort( operation );
itayzafrir40835d42018-08-02 13:14:17 +03002589 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002590 }
2591}
2592
Gilles Peskine2d277862018-06-18 15:41:12 +02002593psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2594 const uint8_t *hash,
2595 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002596{
2597 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2598 size_t actual_hash_length;
2599 psa_status_t status = psa_hash_finish( operation,
2600 actual_hash, sizeof( actual_hash ),
2601 &actual_hash_length );
2602 if( status != PSA_SUCCESS )
2603 return( status );
2604 if( actual_hash_length != hash_length )
2605 return( PSA_ERROR_INVALID_SIGNATURE );
2606 if( safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
2607 return( PSA_ERROR_INVALID_SIGNATURE );
2608 return( PSA_SUCCESS );
2609}
2610
Gilles Peskine0a749c82019-11-28 19:33:58 +01002611psa_status_t psa_hash_compute( psa_algorithm_t alg,
2612 const uint8_t *input, size_t input_length,
2613 uint8_t *hash, size_t hash_size,
2614 size_t *hash_length )
2615{
2616 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
2617 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2618
2619 *hash_length = hash_size;
2620 status = psa_hash_setup( &operation, alg );
2621 if( status != PSA_SUCCESS )
2622 goto exit;
2623 status = psa_hash_update( &operation, input, input_length );
2624 if( status != PSA_SUCCESS )
2625 goto exit;
2626 status = psa_hash_finish( &operation, hash, hash_size, hash_length );
2627 if( status != PSA_SUCCESS )
2628 goto exit;
2629
2630exit:
2631 if( status == PSA_SUCCESS )
2632 status = psa_hash_abort( &operation );
2633 else
2634 psa_hash_abort( &operation );
2635 return( status );
2636}
2637
2638psa_status_t psa_hash_compare( psa_algorithm_t alg,
2639 const uint8_t *input, size_t input_length,
2640 const uint8_t *hash, size_t hash_length )
2641{
2642 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
2643 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2644
2645 status = psa_hash_setup( &operation, alg );
2646 if( status != PSA_SUCCESS )
2647 goto exit;
2648 status = psa_hash_update( &operation, input, input_length );
2649 if( status != PSA_SUCCESS )
2650 goto exit;
2651 status = psa_hash_verify( &operation, hash, hash_length );
2652 if( status != PSA_SUCCESS )
2653 goto exit;
2654
2655exit:
2656 if( status == PSA_SUCCESS )
2657 status = psa_hash_abort( &operation );
2658 else
2659 psa_hash_abort( &operation );
2660 return( status );
2661}
2662
Gilles Peskineeb35d782019-01-22 17:56:16 +01002663psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2664 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002665{
2666 if( target_operation->alg != 0 )
2667 return( PSA_ERROR_BAD_STATE );
2668
2669 switch( source_operation->alg )
2670 {
2671 case 0:
2672 return( PSA_ERROR_BAD_STATE );
2673#if defined(MBEDTLS_MD2_C)
2674 case PSA_ALG_MD2:
2675 mbedtls_md2_clone( &target_operation->ctx.md2,
2676 &source_operation->ctx.md2 );
2677 break;
2678#endif
2679#if defined(MBEDTLS_MD4_C)
2680 case PSA_ALG_MD4:
2681 mbedtls_md4_clone( &target_operation->ctx.md4,
2682 &source_operation->ctx.md4 );
2683 break;
2684#endif
2685#if defined(MBEDTLS_MD5_C)
2686 case PSA_ALG_MD5:
2687 mbedtls_md5_clone( &target_operation->ctx.md5,
2688 &source_operation->ctx.md5 );
2689 break;
2690#endif
2691#if defined(MBEDTLS_RIPEMD160_C)
2692 case PSA_ALG_RIPEMD160:
2693 mbedtls_ripemd160_clone( &target_operation->ctx.ripemd160,
2694 &source_operation->ctx.ripemd160 );
2695 break;
2696#endif
2697#if defined(MBEDTLS_SHA1_C)
2698 case PSA_ALG_SHA_1:
2699 mbedtls_sha1_clone( &target_operation->ctx.sha1,
2700 &source_operation->ctx.sha1 );
2701 break;
2702#endif
2703#if defined(MBEDTLS_SHA256_C)
2704 case PSA_ALG_SHA_224:
2705 case PSA_ALG_SHA_256:
2706 mbedtls_sha256_clone( &target_operation->ctx.sha256,
2707 &source_operation->ctx.sha256 );
2708 break;
2709#endif
2710#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002711#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002712 case PSA_ALG_SHA_384:
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002713#endif
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002714 case PSA_ALG_SHA_512:
2715 mbedtls_sha512_clone( &target_operation->ctx.sha512,
2716 &source_operation->ctx.sha512 );
2717 break;
2718#endif
2719 default:
2720 return( PSA_ERROR_NOT_SUPPORTED );
2721 }
2722
2723 target_operation->alg = source_operation->alg;
2724 return( PSA_SUCCESS );
2725}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002726
2727
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002728/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002729/* MAC */
2730/****************************************************************/
2731
Gilles Peskinedc2fc842018-03-07 16:42:59 +01002732static const mbedtls_cipher_info_t *mbedtls_cipher_info_from_psa(
Gilles Peskine8c9def32018-02-08 10:02:12 +01002733 psa_algorithm_t alg,
2734 psa_key_type_t key_type,
Gilles Peskine2d277862018-06-18 15:41:12 +02002735 size_t key_bits,
mohammad1603f4f0d612018-06-03 15:04:51 +03002736 mbedtls_cipher_id_t* cipher_id )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002737{
Gilles Peskine8c9def32018-02-08 10:02:12 +01002738 mbedtls_cipher_mode_t mode;
mohammad1603f4f0d612018-06-03 15:04:51 +03002739 mbedtls_cipher_id_t cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002740
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002741 if( PSA_ALG_IS_AEAD( alg ) )
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002742 alg = PSA_ALG_AEAD_WITH_TAG_LENGTH( alg, 0 );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002743
Gilles Peskine8c9def32018-02-08 10:02:12 +01002744 if( PSA_ALG_IS_CIPHER( alg ) || PSA_ALG_IS_AEAD( alg ) )
2745 {
Nir Sonnenscheine9664c32018-06-17 14:41:30 +03002746 switch( alg )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002747 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002748 case PSA_ALG_ARC4:
Gilles Peskine26869f22019-05-06 15:25:00 +02002749 case PSA_ALG_CHACHA20:
Gilles Peskine8c9def32018-02-08 10:02:12 +01002750 mode = MBEDTLS_MODE_STREAM;
2751 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002752 case PSA_ALG_CTR:
2753 mode = MBEDTLS_MODE_CTR;
2754 break;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002755 case PSA_ALG_CFB:
2756 mode = MBEDTLS_MODE_CFB;
2757 break;
2758 case PSA_ALG_OFB:
2759 mode = MBEDTLS_MODE_OFB;
2760 break;
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02002761 case PSA_ALG_ECB_NO_PADDING:
2762 mode = MBEDTLS_MODE_ECB;
2763 break;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002764 case PSA_ALG_CBC_NO_PADDING:
2765 mode = MBEDTLS_MODE_CBC;
2766 break;
2767 case PSA_ALG_CBC_PKCS7:
2768 mode = MBEDTLS_MODE_CBC;
2769 break;
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002770 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002771 mode = MBEDTLS_MODE_CCM;
2772 break;
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002773 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_GCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002774 mode = MBEDTLS_MODE_GCM;
2775 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02002776 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CHACHA20_POLY1305, 0 ):
2777 mode = MBEDTLS_MODE_CHACHAPOLY;
2778 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002779 default:
2780 return( NULL );
2781 }
2782 }
2783 else if( alg == PSA_ALG_CMAC )
2784 mode = MBEDTLS_MODE_ECB;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002785 else
2786 return( NULL );
2787
2788 switch( key_type )
2789 {
2790 case PSA_KEY_TYPE_AES:
mohammad1603f4f0d612018-06-03 15:04:51 +03002791 cipher_id_tmp = MBEDTLS_CIPHER_ID_AES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002792 break;
2793 case PSA_KEY_TYPE_DES:
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002794 /* key_bits is 64 for Single-DES, 128 for two-key Triple-DES,
2795 * and 192 for three-key Triple-DES. */
Gilles Peskine8c9def32018-02-08 10:02:12 +01002796 if( key_bits == 64 )
mohammad1603f4f0d612018-06-03 15:04:51 +03002797 cipher_id_tmp = MBEDTLS_CIPHER_ID_DES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002798 else
mohammad1603f4f0d612018-06-03 15:04:51 +03002799 cipher_id_tmp = MBEDTLS_CIPHER_ID_3DES;
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002800 /* mbedtls doesn't recognize two-key Triple-DES as an algorithm,
2801 * but two-key Triple-DES is functionally three-key Triple-DES
2802 * with K1=K3, so that's how we present it to mbedtls. */
2803 if( key_bits == 128 )
2804 key_bits = 192;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002805 break;
2806 case PSA_KEY_TYPE_CAMELLIA:
mohammad1603f4f0d612018-06-03 15:04:51 +03002807 cipher_id_tmp = MBEDTLS_CIPHER_ID_CAMELLIA;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002808 break;
2809 case PSA_KEY_TYPE_ARC4:
mohammad1603f4f0d612018-06-03 15:04:51 +03002810 cipher_id_tmp = MBEDTLS_CIPHER_ID_ARC4;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002811 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02002812 case PSA_KEY_TYPE_CHACHA20:
2813 cipher_id_tmp = MBEDTLS_CIPHER_ID_CHACHA20;
2814 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002815 default:
2816 return( NULL );
2817 }
mohammad1603f4f0d612018-06-03 15:04:51 +03002818 if( cipher_id != NULL )
mohammad160360a64d02018-06-03 17:20:42 +03002819 *cipher_id = cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002820
Jaeden Amero23bbb752018-06-26 14:16:54 +01002821 return( mbedtls_cipher_info_from_values( cipher_id_tmp,
2822 (int) key_bits, mode ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002823}
2824
Gilles Peskinea05219c2018-11-16 16:02:56 +01002825#if defined(MBEDTLS_MD_C)
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002826static size_t psa_get_hash_block_size( psa_algorithm_t alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002827{
Gilles Peskine2d277862018-06-18 15:41:12 +02002828 switch( alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002829 {
2830 case PSA_ALG_MD2:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002831 return( 16 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002832 case PSA_ALG_MD4:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002833 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002834 case PSA_ALG_MD5:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002835 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002836 case PSA_ALG_RIPEMD160:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002837 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002838 case PSA_ALG_SHA_1:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002839 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002840 case PSA_ALG_SHA_224:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002841 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002842 case PSA_ALG_SHA_256:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002843 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002844 case PSA_ALG_SHA_384:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002845 return( 128 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002846 case PSA_ALG_SHA_512:
Gilles Peskine2d277862018-06-18 15:41:12 +02002847 return( 128 );
2848 default:
2849 return( 0 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002850 }
2851}
Gilles Peskinea05219c2018-11-16 16:02:56 +01002852#endif /* MBEDTLS_MD_C */
Nir Sonnenschein0c9ec532018-06-07 13:27:47 +03002853
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002854/* Initialize the MAC operation structure. Once this function has been
2855 * called, psa_mac_abort can run and will do the right thing. */
2856static psa_status_t psa_mac_init( psa_mac_operation_t *operation,
2857 psa_algorithm_t alg )
2858{
2859 psa_status_t status = PSA_ERROR_NOT_SUPPORTED;
2860
2861 operation->alg = alg;
2862 operation->key_set = 0;
2863 operation->iv_set = 0;
2864 operation->iv_required = 0;
2865 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002866 operation->is_sign = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002867
2868#if defined(MBEDTLS_CMAC_C)
2869 if( alg == PSA_ALG_CMAC )
2870 {
2871 operation->iv_required = 0;
2872 mbedtls_cipher_init( &operation->ctx.cmac );
2873 status = PSA_SUCCESS;
2874 }
2875 else
2876#endif /* MBEDTLS_CMAC_C */
2877#if defined(MBEDTLS_MD_C)
2878 if( PSA_ALG_IS_HMAC( operation->alg ) )
2879 {
Gilles Peskineff94abd2018-07-12 17:07:52 +02002880 /* We'll set up the hash operation later in psa_hmac_setup_internal. */
2881 operation->ctx.hmac.hash_ctx.alg = 0;
2882 status = PSA_SUCCESS;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002883 }
2884 else
2885#endif /* MBEDTLS_MD_C */
2886 {
Gilles Peskinec06e0712018-06-20 16:21:04 +02002887 if( ! PSA_ALG_IS_MAC( alg ) )
2888 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002889 }
2890
2891 if( status != PSA_SUCCESS )
2892 memset( operation, 0, sizeof( *operation ) );
2893 return( status );
2894}
2895
Gilles Peskine01126fa2018-07-12 17:04:55 +02002896#if defined(MBEDTLS_MD_C)
2897static psa_status_t psa_hmac_abort_internal( psa_hmac_internal_data *hmac )
2898{
Gilles Peskine3f108122018-12-07 18:14:53 +01002899 mbedtls_platform_zeroize( hmac->opad, sizeof( hmac->opad ) );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002900 return( psa_hash_abort( &hmac->hash_ctx ) );
2901}
2902#endif /* MBEDTLS_MD_C */
2903
Gilles Peskine8c9def32018-02-08 10:02:12 +01002904psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
2905{
Gilles Peskinefbfac682018-07-08 20:51:54 +02002906 if( operation->alg == 0 )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002907 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02002908 /* The object has (apparently) been initialized but it is not
2909 * in use. It's ok to call abort on such an object, and there's
2910 * nothing to do. */
2911 return( PSA_SUCCESS );
2912 }
2913 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002914#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002915 if( operation->alg == PSA_ALG_CMAC )
2916 {
2917 mbedtls_cipher_free( &operation->ctx.cmac );
2918 }
2919 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002920#endif /* MBEDTLS_CMAC_C */
Gilles Peskine8c9def32018-02-08 10:02:12 +01002921#if defined(MBEDTLS_MD_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002922 if( PSA_ALG_IS_HMAC( operation->alg ) )
2923 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02002924 psa_hmac_abort_internal( &operation->ctx.hmac );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002925 }
2926 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002927#endif /* MBEDTLS_MD_C */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002928 {
2929 /* Sanity check (shouldn't happen: operation->alg should
2930 * always have been initialized to a valid value). */
2931 goto bad_state;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002932 }
Moran Peker41deec42018-04-04 15:43:05 +03002933
Gilles Peskine8c9def32018-02-08 10:02:12 +01002934 operation->alg = 0;
2935 operation->key_set = 0;
2936 operation->iv_set = 0;
2937 operation->iv_required = 0;
2938 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002939 operation->is_sign = 0;
Moran Peker41deec42018-04-04 15:43:05 +03002940
Gilles Peskine8c9def32018-02-08 10:02:12 +01002941 return( PSA_SUCCESS );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002942
2943bad_state:
2944 /* If abort is called on an uninitialized object, we can't trust
2945 * anything. Wipe the object in case it contains confidential data.
2946 * This may result in a memory leak if a pointer gets overwritten,
2947 * but it's too late to do anything about this. */
2948 memset( operation, 0, sizeof( *operation ) );
2949 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002950}
2951
Gilles Peskinee3b07d82018-06-19 11:57:35 +02002952#if defined(MBEDTLS_CMAC_C)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002953static int psa_cmac_setup( psa_mac_operation_t *operation,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002954 size_t key_bits,
Gilles Peskine2f060a82018-12-04 17:12:32 +01002955 psa_key_slot_t *slot,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002956 const mbedtls_cipher_info_t *cipher_info )
2957{
Janos Follath24eed8d2019-11-22 13:21:35 +00002958 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002959
2960 operation->mac_size = cipher_info->block_size;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002961
2962 ret = mbedtls_cipher_setup( &operation->ctx.cmac, cipher_info );
2963 if( ret != 0 )
2964 return( ret );
2965
2966 ret = mbedtls_cipher_cmac_starts( &operation->ctx.cmac,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02002967 slot->data.key.data,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002968 key_bits );
2969 return( ret );
2970}
Gilles Peskinee3b07d82018-06-19 11:57:35 +02002971#endif /* MBEDTLS_CMAC_C */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002972
Gilles Peskine248051a2018-06-20 16:09:38 +02002973#if defined(MBEDTLS_MD_C)
Gilles Peskine01126fa2018-07-12 17:04:55 +02002974static psa_status_t psa_hmac_setup_internal( psa_hmac_internal_data *hmac,
2975 const uint8_t *key,
2976 size_t key_length,
2977 psa_algorithm_t hash_alg )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002978{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02002979 uint8_t ipad[PSA_HMAC_MAX_HASH_BLOCK_SIZE];
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002980 size_t i;
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002981 size_t hash_size = PSA_HASH_SIZE( hash_alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002982 size_t block_size = psa_get_hash_block_size( hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002983 psa_status_t status;
2984
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002985 /* Sanity checks on block_size, to guarantee that there won't be a buffer
2986 * overflow below. This should never trigger if the hash algorithm
2987 * is implemented correctly. */
2988 /* The size checks against the ipad and opad buffers cannot be written
2989 * `block_size > sizeof( ipad ) || block_size > sizeof( hmac->opad )`
2990 * because that triggers -Wlogical-op on GCC 7.3. */
2991 if( block_size > sizeof( ipad ) )
2992 return( PSA_ERROR_NOT_SUPPORTED );
2993 if( block_size > sizeof( hmac->opad ) )
2994 return( PSA_ERROR_NOT_SUPPORTED );
2995 if( block_size < hash_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002996 return( PSA_ERROR_NOT_SUPPORTED );
2997
Gilles Peskined223b522018-06-11 18:12:58 +02002998 if( key_length > block_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002999 {
Gilles Peskine84b8fc82019-11-28 20:07:20 +01003000 status = psa_hash_compute( hash_alg, key, key_length,
3001 ipad, sizeof( ipad ), &key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003002 if( status != PSA_SUCCESS )
Gilles Peskineb8be2882018-07-17 16:24:34 +02003003 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003004 }
Gilles Peskine96889972018-07-12 17:07:03 +02003005 /* A 0-length key is not commonly used in HMAC when used as a MAC,
3006 * but it is permitted. It is common when HMAC is used in HKDF, for
3007 * example. Don't call `memcpy` in the 0-length because `key` could be
3008 * an invalid pointer which would make the behavior undefined. */
3009 else if( key_length != 0 )
Gilles Peskine01126fa2018-07-12 17:04:55 +02003010 memcpy( ipad, key, key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003011
Gilles Peskined223b522018-06-11 18:12:58 +02003012 /* ipad contains the key followed by garbage. Xor and fill with 0x36
3013 * to create the ipad value. */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003014 for( i = 0; i < key_length; i++ )
Gilles Peskined223b522018-06-11 18:12:58 +02003015 ipad[i] ^= 0x36;
3016 memset( ipad + key_length, 0x36, block_size - key_length );
3017
3018 /* Copy the key material from ipad to opad, flipping the requisite bits,
3019 * and filling the rest of opad with the requisite constant. */
3020 for( i = 0; i < key_length; i++ )
Gilles Peskine01126fa2018-07-12 17:04:55 +02003021 hmac->opad[i] = ipad[i] ^ 0x36 ^ 0x5C;
3022 memset( hmac->opad + key_length, 0x5C, block_size - key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003023
Gilles Peskine01126fa2018-07-12 17:04:55 +02003024 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003025 if( status != PSA_SUCCESS )
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003026 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003027
Gilles Peskine01126fa2018-07-12 17:04:55 +02003028 status = psa_hash_update( &hmac->hash_ctx, ipad, block_size );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003029
3030cleanup:
Steven Cooreman29149862020-08-05 15:43:42 +02003031 mbedtls_platform_zeroize( ipad, sizeof( ipad ) );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003032
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003033 return( status );
3034}
Gilles Peskine248051a2018-06-20 16:09:38 +02003035#endif /* MBEDTLS_MD_C */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003036
Gilles Peskine89167cb2018-07-08 20:12:23 +02003037static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01003038 psa_key_handle_t handle,
Gilles Peskine89167cb2018-07-08 20:12:23 +02003039 psa_algorithm_t alg,
3040 int is_sign )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003041{
Gilles Peskine8c9def32018-02-08 10:02:12 +01003042 psa_status_t status;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003043 psa_key_slot_t *slot;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003044 size_t key_bits;
Gilles Peskine89167cb2018-07-08 20:12:23 +02003045 psa_key_usage_t usage =
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003046 is_sign ? PSA_KEY_USAGE_SIGN_HASH : PSA_KEY_USAGE_VERIFY_HASH;
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02003047 uint8_t truncated = PSA_MAC_TRUNCATED_LENGTH( alg );
Gilles Peskinee0e9c7c2018-10-17 18:28:05 +02003048 psa_algorithm_t full_length_alg = PSA_ALG_FULL_LENGTH_MAC( alg );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003049
Jaeden Amero36ee5d02019-02-19 09:25:10 +00003050 /* A context must be freshly initialized before it can be set up. */
3051 if( operation->alg != 0 )
3052 {
3053 return( PSA_ERROR_BAD_STATE );
3054 }
3055
Gilles Peskined911eb72018-08-14 15:18:45 +02003056 status = psa_mac_init( operation, full_length_alg );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003057 if( status != PSA_SUCCESS )
3058 return( status );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003059 if( is_sign )
3060 operation->is_sign = 1;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003061
Gilles Peskine28f8f302019-07-24 13:30:31 +02003062 status = psa_get_transparent_key( handle, &slot, usage, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003063 if( status != PSA_SUCCESS )
Gilles Peskinefbfac682018-07-08 20:51:54 +02003064 goto exit;
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02003065 key_bits = psa_get_key_slot_bits( slot );
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02003066
Gilles Peskine8c9def32018-02-08 10:02:12 +01003067#if defined(MBEDTLS_CMAC_C)
Gilles Peskined911eb72018-08-14 15:18:45 +02003068 if( full_length_alg == PSA_ALG_CMAC )
Gilles Peskinefbfac682018-07-08 20:51:54 +02003069 {
3070 const mbedtls_cipher_info_t *cipher_info =
Gilles Peskined911eb72018-08-14 15:18:45 +02003071 mbedtls_cipher_info_from_psa( full_length_alg,
Gilles Peskine8e338702019-07-30 20:06:31 +02003072 slot->attr.type, key_bits, NULL );
Janos Follath24eed8d2019-11-22 13:21:35 +00003073 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinefbfac682018-07-08 20:51:54 +02003074 if( cipher_info == NULL )
3075 {
3076 status = PSA_ERROR_NOT_SUPPORTED;
3077 goto exit;
3078 }
3079 operation->mac_size = cipher_info->block_size;
3080 ret = psa_cmac_setup( operation, key_bits, slot, cipher_info );
3081 status = mbedtls_to_psa_error( ret );
3082 }
3083 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01003084#endif /* MBEDTLS_CMAC_C */
Gilles Peskine8c9def32018-02-08 10:02:12 +01003085#if defined(MBEDTLS_MD_C)
Gilles Peskined911eb72018-08-14 15:18:45 +02003086 if( PSA_ALG_IS_HMAC( full_length_alg ) )
Gilles Peskinefbfac682018-07-08 20:51:54 +02003087 {
Gilles Peskine00709fa2018-08-22 18:25:41 +02003088 psa_algorithm_t hash_alg = PSA_ALG_HMAC_GET_HASH( alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003089 if( hash_alg == 0 )
3090 {
3091 status = PSA_ERROR_NOT_SUPPORTED;
3092 goto exit;
3093 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02003094
3095 operation->mac_size = PSA_HASH_SIZE( hash_alg );
3096 /* Sanity check. This shouldn't fail on a valid configuration. */
3097 if( operation->mac_size == 0 ||
3098 operation->mac_size > sizeof( operation->ctx.hmac.opad ) )
3099 {
3100 status = PSA_ERROR_NOT_SUPPORTED;
3101 goto exit;
3102 }
3103
Gilles Peskine8e338702019-07-30 20:06:31 +02003104 if( slot->attr.type != PSA_KEY_TYPE_HMAC )
Gilles Peskine01126fa2018-07-12 17:04:55 +02003105 {
3106 status = PSA_ERROR_INVALID_ARGUMENT;
3107 goto exit;
3108 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02003109
Gilles Peskine01126fa2018-07-12 17:04:55 +02003110 status = psa_hmac_setup_internal( &operation->ctx.hmac,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02003111 slot->data.key.data,
3112 slot->data.key.bytes,
Gilles Peskine01126fa2018-07-12 17:04:55 +02003113 hash_alg );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003114 }
3115 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01003116#endif /* MBEDTLS_MD_C */
Gilles Peskinefbfac682018-07-08 20:51:54 +02003117 {
Jaeden Amero82df32e2018-11-23 15:11:20 +00003118 (void) key_bits;
Gilles Peskinefbfac682018-07-08 20:51:54 +02003119 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003120 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003121
Gilles Peskined911eb72018-08-14 15:18:45 +02003122 if( truncated == 0 )
3123 {
3124 /* The "normal" case: untruncated algorithm. Nothing to do. */
3125 }
3126 else if( truncated < 4 )
3127 {
Gilles Peskine6d72ff92018-08-21 14:55:08 +02003128 /* A very short MAC is too short for security since it can be
3129 * brute-forced. Ancient protocols with 32-bit MACs do exist,
3130 * so we make this our minimum, even though 32 bits is still
3131 * too small for security. */
Gilles Peskined911eb72018-08-14 15:18:45 +02003132 status = PSA_ERROR_NOT_SUPPORTED;
3133 }
3134 else if( truncated > operation->mac_size )
3135 {
3136 /* It's impossible to "truncate" to a larger length. */
3137 status = PSA_ERROR_INVALID_ARGUMENT;
3138 }
3139 else
3140 operation->mac_size = truncated;
3141
Gilles Peskinefbfac682018-07-08 20:51:54 +02003142exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003143 if( status != PSA_SUCCESS )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003144 {
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003145 psa_mac_abort( operation );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003146 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003147 else
3148 {
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003149 operation->key_set = 1;
3150 }
3151 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003152}
3153
Gilles Peskine89167cb2018-07-08 20:12:23 +02003154psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01003155 psa_key_handle_t handle,
Gilles Peskine89167cb2018-07-08 20:12:23 +02003156 psa_algorithm_t alg )
3157{
Gilles Peskinec5487a82018-12-03 18:08:14 +01003158 return( psa_mac_setup( operation, handle, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003159}
3160
3161psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01003162 psa_key_handle_t handle,
Gilles Peskine89167cb2018-07-08 20:12:23 +02003163 psa_algorithm_t alg )
3164{
Gilles Peskinec5487a82018-12-03 18:08:14 +01003165 return( psa_mac_setup( operation, handle, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003166}
3167
Gilles Peskine8c9def32018-02-08 10:02:12 +01003168psa_status_t psa_mac_update( psa_mac_operation_t *operation,
3169 const uint8_t *input,
3170 size_t input_length )
3171{
Gilles Peskinefbfac682018-07-08 20:51:54 +02003172 psa_status_t status = PSA_ERROR_BAD_STATE;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003173 if( ! operation->key_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003174 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003175 if( operation->iv_required && ! operation->iv_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003176 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003177 operation->has_input = 1;
3178
Gilles Peskine8c9def32018-02-08 10:02:12 +01003179#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003180 if( operation->alg == PSA_ALG_CMAC )
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03003181 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02003182 int ret = mbedtls_cipher_cmac_update( &operation->ctx.cmac,
3183 input, input_length );
3184 status = mbedtls_to_psa_error( ret );
3185 }
3186 else
3187#endif /* MBEDTLS_CMAC_C */
3188#if defined(MBEDTLS_MD_C)
3189 if( PSA_ALG_IS_HMAC( operation->alg ) )
3190 {
3191 status = psa_hash_update( &operation->ctx.hmac.hash_ctx, input,
3192 input_length );
3193 }
3194 else
3195#endif /* MBEDTLS_MD_C */
3196 {
3197 /* This shouldn't happen if `operation` was initialized by
3198 * a setup function. */
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003199 return( PSA_ERROR_BAD_STATE );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03003200 }
3201
Gilles Peskinefbfac682018-07-08 20:51:54 +02003202 if( status != PSA_SUCCESS )
3203 psa_mac_abort( operation );
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02003204 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003205}
3206
Gilles Peskine01126fa2018-07-12 17:04:55 +02003207#if defined(MBEDTLS_MD_C)
3208static psa_status_t psa_hmac_finish_internal( psa_hmac_internal_data *hmac,
3209 uint8_t *mac,
3210 size_t mac_size )
3211{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02003212 uint8_t tmp[MBEDTLS_MD_MAX_SIZE];
Gilles Peskine01126fa2018-07-12 17:04:55 +02003213 psa_algorithm_t hash_alg = hmac->hash_ctx.alg;
3214 size_t hash_size = 0;
3215 size_t block_size = psa_get_hash_block_size( hash_alg );
3216 psa_status_t status;
3217
Gilles Peskine01126fa2018-07-12 17:04:55 +02003218 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
3219 if( status != PSA_SUCCESS )
3220 return( status );
3221 /* From here on, tmp needs to be wiped. */
3222
3223 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
3224 if( status != PSA_SUCCESS )
3225 goto exit;
3226
3227 status = psa_hash_update( &hmac->hash_ctx, hmac->opad, block_size );
3228 if( status != PSA_SUCCESS )
3229 goto exit;
3230
3231 status = psa_hash_update( &hmac->hash_ctx, tmp, hash_size );
3232 if( status != PSA_SUCCESS )
3233 goto exit;
3234
Gilles Peskined911eb72018-08-14 15:18:45 +02003235 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
3236 if( status != PSA_SUCCESS )
3237 goto exit;
3238
3239 memcpy( mac, tmp, mac_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003240
3241exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01003242 mbedtls_platform_zeroize( tmp, hash_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003243 return( status );
3244}
3245#endif /* MBEDTLS_MD_C */
3246
mohammad16036df908f2018-04-02 08:34:15 -07003247static psa_status_t psa_mac_finish_internal( psa_mac_operation_t *operation,
Gilles Peskine2d277862018-06-18 15:41:12 +02003248 uint8_t *mac,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003249 size_t mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003250{
Gilles Peskine1d96fff2018-07-02 12:15:39 +02003251 if( ! operation->key_set )
3252 return( PSA_ERROR_BAD_STATE );
3253 if( operation->iv_required && ! operation->iv_set )
3254 return( PSA_ERROR_BAD_STATE );
3255
Gilles Peskine8c9def32018-02-08 10:02:12 +01003256 if( mac_size < operation->mac_size )
3257 return( PSA_ERROR_BUFFER_TOO_SMALL );
3258
Gilles Peskine8c9def32018-02-08 10:02:12 +01003259#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003260 if( operation->alg == PSA_ALG_CMAC )
3261 {
Gilles Peskined911eb72018-08-14 15:18:45 +02003262 uint8_t tmp[PSA_MAX_BLOCK_CIPHER_BLOCK_SIZE];
3263 int ret = mbedtls_cipher_cmac_finish( &operation->ctx.cmac, tmp );
3264 if( ret == 0 )
Gilles Peskine87b0ac42018-08-21 14:55:49 +02003265 memcpy( mac, tmp, operation->mac_size );
Gilles Peskine3f108122018-12-07 18:14:53 +01003266 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003267 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003268 }
Gilles Peskinefbfac682018-07-08 20:51:54 +02003269 else
3270#endif /* MBEDTLS_CMAC_C */
3271#if defined(MBEDTLS_MD_C)
3272 if( PSA_ALG_IS_HMAC( operation->alg ) )
3273 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02003274 return( psa_hmac_finish_internal( &operation->ctx.hmac,
Gilles Peskined911eb72018-08-14 15:18:45 +02003275 mac, operation->mac_size ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003276 }
3277 else
3278#endif /* MBEDTLS_MD_C */
3279 {
3280 /* This shouldn't happen if `operation` was initialized by
3281 * a setup function. */
3282 return( PSA_ERROR_BAD_STATE );
3283 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01003284}
3285
Gilles Peskineacd4be32018-07-08 19:56:25 +02003286psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
3287 uint8_t *mac,
3288 size_t mac_size,
3289 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07003290{
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003291 psa_status_t status;
3292
Jaeden Amero252ef282019-02-15 14:05:35 +00003293 if( operation->alg == 0 )
3294 {
3295 return( PSA_ERROR_BAD_STATE );
3296 }
3297
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003298 /* Fill the output buffer with something that isn't a valid mac
3299 * (barring an attack on the mac and deliberately-crafted input),
3300 * in case the caller doesn't check the return status properly. */
3301 *mac_length = mac_size;
3302 /* If mac_size is 0 then mac may be NULL and then the
3303 * call to memset would have undefined behavior. */
3304 if( mac_size != 0 )
3305 memset( mac, '!', mac_size );
3306
Gilles Peskine89167cb2018-07-08 20:12:23 +02003307 if( ! operation->is_sign )
3308 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003309 return( PSA_ERROR_BAD_STATE );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003310 }
mohammad16036df908f2018-04-02 08:34:15 -07003311
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003312 status = psa_mac_finish_internal( operation, mac, mac_size );
3313
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003314 if( status == PSA_SUCCESS )
3315 {
3316 status = psa_mac_abort( operation );
3317 if( status == PSA_SUCCESS )
3318 *mac_length = operation->mac_size;
3319 else
3320 memset( mac, '!', mac_size );
3321 }
3322 else
3323 psa_mac_abort( operation );
3324 return( status );
mohammad16036df908f2018-04-02 08:34:15 -07003325}
3326
Gilles Peskineacd4be32018-07-08 19:56:25 +02003327psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
3328 const uint8_t *mac,
3329 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003330{
Gilles Peskine828ed142018-06-18 23:25:51 +02003331 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
mohammad16036df908f2018-04-02 08:34:15 -07003332 psa_status_t status;
3333
Jaeden Amero252ef282019-02-15 14:05:35 +00003334 if( operation->alg == 0 )
3335 {
3336 return( PSA_ERROR_BAD_STATE );
3337 }
3338
Gilles Peskine89167cb2018-07-08 20:12:23 +02003339 if( operation->is_sign )
3340 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003341 return( PSA_ERROR_BAD_STATE );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003342 }
3343 if( operation->mac_size != mac_length )
3344 {
3345 status = PSA_ERROR_INVALID_SIGNATURE;
3346 goto cleanup;
Gilles Peskine89167cb2018-07-08 20:12:23 +02003347 }
mohammad16036df908f2018-04-02 08:34:15 -07003348
3349 status = psa_mac_finish_internal( operation,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003350 actual_mac, sizeof( actual_mac ) );
Gilles Peskine28cd4162020-01-20 16:31:06 +01003351 if( status != PSA_SUCCESS )
3352 goto cleanup;
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003353
3354 if( safer_memcmp( mac, actual_mac, mac_length ) != 0 )
3355 status = PSA_ERROR_INVALID_SIGNATURE;
3356
3357cleanup:
3358 if( status == PSA_SUCCESS )
3359 status = psa_mac_abort( operation );
3360 else
3361 psa_mac_abort( operation );
3362
Gilles Peskine3f108122018-12-07 18:14:53 +01003363 mbedtls_platform_zeroize( actual_mac, sizeof( actual_mac ) );
Gilles Peskined911eb72018-08-14 15:18:45 +02003364
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003365 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003366}
3367
3368
Gilles Peskine20035e32018-02-03 22:44:14 +01003369
Gilles Peskine20035e32018-02-03 22:44:14 +01003370/****************************************************************/
3371/* Asymmetric cryptography */
3372/****************************************************************/
3373
Gilles Peskine2b450e32018-06-27 15:42:46 +02003374#if defined(MBEDTLS_RSA_C)
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02003375/* Decode the hash algorithm from alg and store the mbedtls encoding in
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003376 * md_alg. Verify that the hash length is acceptable. */
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02003377static psa_status_t psa_rsa_decode_md_type( psa_algorithm_t alg,
3378 size_t hash_length,
3379 mbedtls_md_type_t *md_alg )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003380{
Gilles Peskine7ed29c52018-06-26 15:50:08 +02003381 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003382 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003383 *md_alg = mbedtls_md_get_type( md_info );
3384
3385 /* The Mbed TLS RSA module uses an unsigned int for hash length
3386 * parameters. Validate that it fits so that we don't risk an
3387 * overflow later. */
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003388#if SIZE_MAX > UINT_MAX
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003389 if( hash_length > UINT_MAX )
3390 return( PSA_ERROR_INVALID_ARGUMENT );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003391#endif
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003392
3393#if defined(MBEDTLS_PKCS1_V15)
3394 /* For PKCS#1 v1.5 signature, if using a hash, the hash length
3395 * must be correct. */
3396 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) &&
3397 alg != PSA_ALG_RSA_PKCS1V15_SIGN_RAW )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003398 {
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003399 if( md_info == NULL )
3400 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003401 if( mbedtls_md_get_size( md_info ) != hash_length )
3402 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003403 }
3404#endif /* MBEDTLS_PKCS1_V15 */
3405
3406#if defined(MBEDTLS_PKCS1_V21)
3407 /* PSS requires a hash internally. */
3408 if( PSA_ALG_IS_RSA_PSS( alg ) )
3409 {
Gilles Peskine61b91d42018-06-08 16:09:36 +02003410 if( md_info == NULL )
3411 return( PSA_ERROR_NOT_SUPPORTED );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003412 }
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003413#endif /* MBEDTLS_PKCS1_V21 */
3414
Gilles Peskine61b91d42018-06-08 16:09:36 +02003415 return( PSA_SUCCESS );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003416}
3417
Gilles Peskine2b450e32018-06-27 15:42:46 +02003418static psa_status_t psa_rsa_sign( mbedtls_rsa_context *rsa,
3419 psa_algorithm_t alg,
3420 const uint8_t *hash,
3421 size_t hash_length,
3422 uint8_t *signature,
3423 size_t signature_size,
3424 size_t *signature_length )
3425{
3426 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00003427 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003428 mbedtls_md_type_t md_alg;
3429
3430 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
3431 if( status != PSA_SUCCESS )
3432 return( status );
3433
Gilles Peskine630a18a2018-06-29 17:49:35 +02003434 if( signature_size < mbedtls_rsa_get_len( rsa ) )
Gilles Peskine2b450e32018-06-27 15:42:46 +02003435 return( PSA_ERROR_BUFFER_TOO_SMALL );
3436
3437#if defined(MBEDTLS_PKCS1_V15)
3438 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
3439 {
3440 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
3441 MBEDTLS_MD_NONE );
3442 ret = mbedtls_rsa_pkcs1_sign( rsa,
3443 mbedtls_ctr_drbg_random,
3444 &global_data.ctr_drbg,
3445 MBEDTLS_RSA_PRIVATE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003446 md_alg,
3447 (unsigned int) hash_length,
3448 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003449 signature );
3450 }
3451 else
3452#endif /* MBEDTLS_PKCS1_V15 */
3453#if defined(MBEDTLS_PKCS1_V21)
3454 if( PSA_ALG_IS_RSA_PSS( alg ) )
3455 {
3456 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3457 ret = mbedtls_rsa_rsassa_pss_sign( rsa,
3458 mbedtls_ctr_drbg_random,
3459 &global_data.ctr_drbg,
3460 MBEDTLS_RSA_PRIVATE,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003461 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003462 (unsigned int) hash_length,
3463 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003464 signature );
3465 }
3466 else
3467#endif /* MBEDTLS_PKCS1_V21 */
3468 {
3469 return( PSA_ERROR_INVALID_ARGUMENT );
3470 }
3471
3472 if( ret == 0 )
Gilles Peskine630a18a2018-06-29 17:49:35 +02003473 *signature_length = mbedtls_rsa_get_len( rsa );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003474 return( mbedtls_to_psa_error( ret ) );
3475}
3476
3477static psa_status_t psa_rsa_verify( mbedtls_rsa_context *rsa,
3478 psa_algorithm_t alg,
3479 const uint8_t *hash,
3480 size_t hash_length,
3481 const uint8_t *signature,
3482 size_t signature_length )
3483{
3484 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00003485 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003486 mbedtls_md_type_t md_alg;
3487
3488 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
3489 if( status != PSA_SUCCESS )
3490 return( status );
3491
Gilles Peskine89cc74f2019-09-12 22:08:23 +02003492 if( signature_length != mbedtls_rsa_get_len( rsa ) )
3493 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003494
3495#if defined(MBEDTLS_PKCS1_V15)
3496 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
3497 {
3498 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
3499 MBEDTLS_MD_NONE );
3500 ret = mbedtls_rsa_pkcs1_verify( rsa,
3501 mbedtls_ctr_drbg_random,
3502 &global_data.ctr_drbg,
3503 MBEDTLS_RSA_PUBLIC,
3504 md_alg,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003505 (unsigned int) hash_length,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003506 hash,
3507 signature );
3508 }
3509 else
3510#endif /* MBEDTLS_PKCS1_V15 */
3511#if defined(MBEDTLS_PKCS1_V21)
3512 if( PSA_ALG_IS_RSA_PSS( alg ) )
3513 {
3514 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3515 ret = mbedtls_rsa_rsassa_pss_verify( rsa,
3516 mbedtls_ctr_drbg_random,
3517 &global_data.ctr_drbg,
3518 MBEDTLS_RSA_PUBLIC,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003519 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003520 (unsigned int) hash_length,
3521 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003522 signature );
3523 }
3524 else
3525#endif /* MBEDTLS_PKCS1_V21 */
3526 {
3527 return( PSA_ERROR_INVALID_ARGUMENT );
3528 }
Gilles Peskineef12c632018-09-13 20:37:48 +02003529
3530 /* Mbed TLS distinguishes "invalid padding" from "valid padding but
3531 * the rest of the signature is invalid". This has little use in
3532 * practice and PSA doesn't report this distinction. */
3533 if( ret == MBEDTLS_ERR_RSA_INVALID_PADDING )
3534 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003535 return( mbedtls_to_psa_error( ret ) );
3536}
3537#endif /* MBEDTLS_RSA_C */
3538
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003539#if defined(MBEDTLS_ECDSA_C)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003540/* `ecp` cannot be const because `ecp->grp` needs to be non-const
3541 * for mbedtls_ecdsa_sign() and mbedtls_ecdsa_sign_det()
3542 * (even though these functions don't modify it). */
3543static psa_status_t psa_ecdsa_sign( mbedtls_ecp_keypair *ecp,
3544 psa_algorithm_t alg,
3545 const uint8_t *hash,
3546 size_t hash_length,
3547 uint8_t *signature,
3548 size_t signature_size,
3549 size_t *signature_length )
3550{
Janos Follath24eed8d2019-11-22 13:21:35 +00003551 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003552 mbedtls_mpi r, s;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003553 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003554 mbedtls_mpi_init( &r );
3555 mbedtls_mpi_init( &s );
3556
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003557 if( signature_size < 2 * curve_bytes )
3558 {
3559 ret = MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL;
3560 goto cleanup;
3561 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003562
Gilles Peskinea05219c2018-11-16 16:02:56 +01003563#if defined(MBEDTLS_ECDSA_DETERMINISTIC)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003564 if( PSA_ALG_DSA_IS_DETERMINISTIC( alg ) )
3565 {
3566 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
3567 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3568 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
Darryl Green5e843fa2019-09-05 14:06:34 +01003569 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign_det_ext( &ecp->grp, &r, &s,
3570 &ecp->d, hash,
3571 hash_length, md_alg,
3572 mbedtls_ctr_drbg_random,
3573 &global_data.ctr_drbg ) );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003574 }
3575 else
Gilles Peskinea05219c2018-11-16 16:02:56 +01003576#endif /* MBEDTLS_ECDSA_DETERMINISTIC */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003577 {
Gilles Peskinea05219c2018-11-16 16:02:56 +01003578 (void) alg;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003579 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign( &ecp->grp, &r, &s, &ecp->d,
3580 hash, hash_length,
3581 mbedtls_ctr_drbg_random,
3582 &global_data.ctr_drbg ) );
3583 }
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003584
3585 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &r,
3586 signature,
3587 curve_bytes ) );
3588 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &s,
3589 signature + curve_bytes,
3590 curve_bytes ) );
3591
3592cleanup:
3593 mbedtls_mpi_free( &r );
3594 mbedtls_mpi_free( &s );
3595 if( ret == 0 )
3596 *signature_length = 2 * curve_bytes;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003597 return( mbedtls_to_psa_error( ret ) );
3598}
3599
3600static psa_status_t psa_ecdsa_verify( mbedtls_ecp_keypair *ecp,
3601 const uint8_t *hash,
3602 size_t hash_length,
3603 const uint8_t *signature,
3604 size_t signature_length )
3605{
Janos Follath24eed8d2019-11-22 13:21:35 +00003606 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003607 mbedtls_mpi r, s;
3608 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
3609 mbedtls_mpi_init( &r );
3610 mbedtls_mpi_init( &s );
3611
3612 if( signature_length != 2 * curve_bytes )
3613 return( PSA_ERROR_INVALID_SIGNATURE );
3614
3615 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &r,
3616 signature,
3617 curve_bytes ) );
3618 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &s,
3619 signature + curve_bytes,
3620 curve_bytes ) );
3621
Steven Cooremanacda8342020-07-24 23:09:52 +02003622 /* Check whether the public part is loaded. If not, load it. */
3623 if( mbedtls_ecp_is_zero( &ecp->Q ) )
3624 {
3625 MBEDTLS_MPI_CHK(
3626 mbedtls_ecp_mul( &ecp->grp, &ecp->Q, &ecp->d, &ecp->grp.G,
3627 mbedtls_ctr_drbg_random, &global_data.ctr_drbg ) );
3628 }
3629
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003630 ret = mbedtls_ecdsa_verify( &ecp->grp, hash, hash_length,
3631 &ecp->Q, &r, &s );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003632
3633cleanup:
3634 mbedtls_mpi_free( &r );
3635 mbedtls_mpi_free( &s );
3636 return( mbedtls_to_psa_error( ret ) );
3637}
3638#endif /* MBEDTLS_ECDSA_C */
3639
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003640psa_status_t psa_sign_hash( psa_key_handle_t handle,
3641 psa_algorithm_t alg,
3642 const uint8_t *hash,
3643 size_t hash_length,
3644 uint8_t *signature,
3645 size_t signature_size,
3646 size_t *signature_length )
Gilles Peskine20035e32018-02-03 22:44:14 +01003647{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003648 psa_key_slot_t *slot;
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003649 psa_status_t status;
3650
3651 *signature_length = signature_size;
Gilles Peskine4019f0e2019-09-12 22:05:59 +02003652 /* Immediately reject a zero-length signature buffer. This guarantees
3653 * that signature must be a valid pointer. (On the other hand, the hash
3654 * buffer can in principle be empty since it doesn't actually have
3655 * to be a hash.) */
3656 if( signature_size == 0 )
3657 return( PSA_ERROR_BUFFER_TOO_SMALL );
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003658
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003659 status = psa_get_key_from_slot( handle, &slot, PSA_KEY_USAGE_SIGN_HASH, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003660 if( status != PSA_SUCCESS )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003661 goto exit;
Gilles Peskine8e338702019-07-30 20:06:31 +02003662 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003663 {
3664 status = PSA_ERROR_INVALID_ARGUMENT;
3665 goto exit;
3666 }
Gilles Peskine20035e32018-02-03 22:44:14 +01003667
Steven Cooremancd84cb42020-07-16 20:28:36 +02003668 /* Try any of the available accelerators first */
3669 status = psa_driver_wrapper_sign_hash( slot,
3670 alg,
3671 hash,
3672 hash_length,
3673 signature,
3674 signature_size,
3675 signature_length );
Steven Cooreman8d2bde72020-09-04 13:06:39 +02003676 if( status != PSA_ERROR_NOT_SUPPORTED ||
3677 psa_key_lifetime_is_external( slot->attr.lifetime ) )
Steven Cooremancd84cb42020-07-16 20:28:36 +02003678 goto exit;
3679
Steven Cooreman7a250572020-07-17 16:43:05 +02003680 /* If the operation was not supported by any accelerator, try fallback. */
Gilles Peskine20035e32018-02-03 22:44:14 +01003681#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003682 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskine20035e32018-02-03 22:44:14 +01003683 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003684 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02003685
Steven Cooreman4fed4552020-08-03 14:46:03 +02003686 status = psa_load_rsa_representation( slot->attr.type,
3687 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02003688 slot->data.key.bytes,
Steven Cooremana01795d2020-07-24 22:48:15 +02003689 &rsa );
3690 if( status != PSA_SUCCESS )
3691 goto exit;
3692
Steven Cooremana2371e52020-07-28 14:30:39 +02003693 status = psa_rsa_sign( rsa,
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003694 alg,
3695 hash, hash_length,
3696 signature, signature_size,
3697 signature_length );
Steven Cooremana01795d2020-07-24 22:48:15 +02003698
Steven Cooremana2371e52020-07-28 14:30:39 +02003699 mbedtls_rsa_free( rsa );
3700 mbedtls_free( rsa );
Gilles Peskine20035e32018-02-03 22:44:14 +01003701 }
3702 else
3703#endif /* defined(MBEDTLS_RSA_C) */
3704#if defined(MBEDTLS_ECP_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003705 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
Gilles Peskine20035e32018-02-03 22:44:14 +01003706 {
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003707#if defined(MBEDTLS_ECDSA_C)
Gilles Peskinea05219c2018-11-16 16:02:56 +01003708 if(
3709#if defined(MBEDTLS_ECDSA_DETERMINISTIC)
3710 PSA_ALG_IS_ECDSA( alg )
3711#else
3712 PSA_ALG_IS_RANDOMIZED_ECDSA( alg )
3713#endif
3714 )
Steven Cooremanacda8342020-07-24 23:09:52 +02003715 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003716 mbedtls_ecp_keypair *ecp = NULL;
Steven Cooreman4fed4552020-08-03 14:46:03 +02003717 status = psa_load_ecp_representation( slot->attr.type,
3718 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02003719 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02003720 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003721 if( status != PSA_SUCCESS )
3722 goto exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003723 status = psa_ecdsa_sign( ecp,
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003724 alg,
3725 hash, hash_length,
3726 signature, signature_size,
3727 signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02003728 mbedtls_ecp_keypair_free( ecp );
3729 mbedtls_free( ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003730 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003731 else
3732#endif /* defined(MBEDTLS_ECDSA_C) */
3733 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003734 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003735 }
itayzafrir5c753392018-05-08 11:18:38 +03003736 }
3737 else
3738#endif /* defined(MBEDTLS_ECP_C) */
3739 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003740 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine20035e32018-02-03 22:44:14 +01003741 }
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003742
3743exit:
3744 /* Fill the unused part of the output buffer (the whole buffer on error,
3745 * the trailing part on success) with something that isn't a valid mac
3746 * (barring an attack on the mac and deliberately-crafted input),
3747 * in case the caller doesn't check the return status properly. */
3748 if( status == PSA_SUCCESS )
3749 memset( signature + *signature_length, '!',
3750 signature_size - *signature_length );
Gilles Peskine4019f0e2019-09-12 22:05:59 +02003751 else
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003752 memset( signature, '!', signature_size );
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003753 /* If signature_size is 0 then we have nothing to do. We must not call
3754 * memset because signature may be NULL in this case. */
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003755 return( status );
itayzafrir5c753392018-05-08 11:18:38 +03003756}
3757
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003758psa_status_t psa_verify_hash( psa_key_handle_t handle,
3759 psa_algorithm_t alg,
3760 const uint8_t *hash,
3761 size_t hash_length,
3762 const uint8_t *signature,
3763 size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03003764{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003765 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003766 psa_status_t status;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003767
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003768 status = psa_get_key_from_slot( handle, &slot, PSA_KEY_USAGE_VERIFY_HASH, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003769 if( status != PSA_SUCCESS )
3770 return( status );
itayzafrir5c753392018-05-08 11:18:38 +03003771
Steven Cooreman55ae2172020-07-17 19:46:15 +02003772 /* Try any of the available accelerators first */
3773 status = psa_driver_wrapper_verify_hash( slot,
3774 alg,
3775 hash,
3776 hash_length,
3777 signature,
3778 signature_length );
Steven Cooreman8d2bde72020-09-04 13:06:39 +02003779 if( status != PSA_ERROR_NOT_SUPPORTED ||
3780 psa_key_lifetime_is_external( slot->attr.lifetime ) )
Steven Cooreman55ae2172020-07-17 19:46:15 +02003781 return status;
3782
Gilles Peskine61b91d42018-06-08 16:09:36 +02003783#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003784 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003785 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003786 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02003787
Steven Cooreman4fed4552020-08-03 14:46:03 +02003788 status = psa_load_rsa_representation( slot->attr.type,
3789 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02003790 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02003791 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003792 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02003793 return( status );
Steven Cooremana01795d2020-07-24 22:48:15 +02003794
Steven Cooremana2371e52020-07-28 14:30:39 +02003795 status = psa_rsa_verify( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02003796 alg,
3797 hash, hash_length,
3798 signature, signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02003799 mbedtls_rsa_free( rsa );
3800 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003801 return( status );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003802 }
3803 else
3804#endif /* defined(MBEDTLS_RSA_C) */
itayzafrir5c753392018-05-08 11:18:38 +03003805#if defined(MBEDTLS_ECP_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003806 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
itayzafrir5c753392018-05-08 11:18:38 +03003807 {
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003808#if defined(MBEDTLS_ECDSA_C)
3809 if( PSA_ALG_IS_ECDSA( alg ) )
Steven Cooremanacda8342020-07-24 23:09:52 +02003810 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003811 mbedtls_ecp_keypair *ecp = NULL;
Steven Cooreman4fed4552020-08-03 14:46:03 +02003812 status = psa_load_ecp_representation( slot->attr.type,
3813 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02003814 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02003815 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003816 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02003817 return( status );
Steven Cooremana2371e52020-07-28 14:30:39 +02003818 status = psa_ecdsa_verify( ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02003819 hash, hash_length,
3820 signature, signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02003821 mbedtls_ecp_keypair_free( ecp );
3822 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02003823 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02003824 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003825 else
3826#endif /* defined(MBEDTLS_ECDSA_C) */
3827 {
3828 return( PSA_ERROR_INVALID_ARGUMENT );
3829 }
itayzafrir5c753392018-05-08 11:18:38 +03003830 }
Gilles Peskine20035e32018-02-03 22:44:14 +01003831 else
3832#endif /* defined(MBEDTLS_ECP_C) */
3833 {
3834 return( PSA_ERROR_NOT_SUPPORTED );
3835 }
3836}
3837
Gilles Peskine072ac562018-06-30 00:21:29 +02003838#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PKCS1_V21)
3839static void psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
3840 mbedtls_rsa_context *rsa )
3841{
3842 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
3843 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3844 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
3845 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3846}
3847#endif /* defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PKCS1_V21) */
3848
Gilles Peskinec5487a82018-12-03 18:08:14 +01003849psa_status_t psa_asymmetric_encrypt( psa_key_handle_t handle,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003850 psa_algorithm_t alg,
3851 const uint8_t *input,
3852 size_t input_length,
3853 const uint8_t *salt,
3854 size_t salt_length,
3855 uint8_t *output,
3856 size_t output_size,
3857 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003858{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003859 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003860 psa_status_t status;
3861
Darryl Green5cc689a2018-07-24 15:34:10 +01003862 (void) input;
3863 (void) input_length;
3864 (void) salt;
3865 (void) output;
3866 (void) output_size;
3867
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003868 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003869
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003870 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3871 return( PSA_ERROR_INVALID_ARGUMENT );
3872
Gilles Peskine28f8f302019-07-24 13:30:31 +02003873 status = psa_get_transparent_key( handle, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003874 if( status != PSA_SUCCESS )
3875 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003876 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
3877 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003878 return( PSA_ERROR_INVALID_ARGUMENT );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003879
3880#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003881 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003882 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003883 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman4fed4552020-08-03 14:46:03 +02003884 status = psa_load_rsa_representation( slot->attr.type,
3885 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02003886 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02003887 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003888 if( status != PSA_SUCCESS )
Steven Cooreman4fed4552020-08-03 14:46:03 +02003889 goto rsa_exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003890
3891 if( output_size < mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003892 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003893 status = PSA_ERROR_BUFFER_TOO_SMALL;
3894 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003895 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003896#if defined(MBEDTLS_PKCS1_V15)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003897 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003898 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003899 status = mbedtls_to_psa_error(
3900 mbedtls_rsa_pkcs1_encrypt( rsa,
3901 mbedtls_ctr_drbg_random,
3902 &global_data.ctr_drbg,
3903 MBEDTLS_RSA_PUBLIC,
3904 input_length,
3905 input,
3906 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003907 }
3908 else
3909#endif /* MBEDTLS_PKCS1_V15 */
3910#if defined(MBEDTLS_PKCS1_V21)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003911 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003912 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003913 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02003914 status = mbedtls_to_psa_error(
3915 mbedtls_rsa_rsaes_oaep_encrypt( rsa,
3916 mbedtls_ctr_drbg_random,
3917 &global_data.ctr_drbg,
3918 MBEDTLS_RSA_PUBLIC,
3919 salt, salt_length,
3920 input_length,
3921 input,
3922 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003923 }
3924 else
3925#endif /* MBEDTLS_PKCS1_V21 */
3926 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003927 status = PSA_ERROR_INVALID_ARGUMENT;
3928 goto rsa_exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003929 }
Steven Cooreman4fed4552020-08-03 14:46:03 +02003930rsa_exit:
3931 if( status == PSA_SUCCESS )
Steven Cooremana2371e52020-07-28 14:30:39 +02003932 *output_length = mbedtls_rsa_get_len( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003933
Steven Cooremana2371e52020-07-28 14:30:39 +02003934 mbedtls_rsa_free( rsa );
3935 mbedtls_free( rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02003936 return( status );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003937 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003938 else
Gilles Peskineb75e4f12018-06-08 17:44:47 +02003939#endif /* defined(MBEDTLS_RSA_C) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003940 {
3941 return( PSA_ERROR_NOT_SUPPORTED );
3942 }
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003943}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003944
Gilles Peskinec5487a82018-12-03 18:08:14 +01003945psa_status_t psa_asymmetric_decrypt( psa_key_handle_t handle,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003946 psa_algorithm_t alg,
3947 const uint8_t *input,
3948 size_t input_length,
3949 const uint8_t *salt,
3950 size_t salt_length,
3951 uint8_t *output,
3952 size_t output_size,
3953 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003954{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003955 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003956 psa_status_t status;
3957
Darryl Green5cc689a2018-07-24 15:34:10 +01003958 (void) input;
3959 (void) input_length;
3960 (void) salt;
3961 (void) output;
3962 (void) output_size;
3963
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003964 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003965
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003966 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3967 return( PSA_ERROR_INVALID_ARGUMENT );
3968
Gilles Peskine28f8f302019-07-24 13:30:31 +02003969 status = psa_get_transparent_key( handle, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003970 if( status != PSA_SUCCESS )
3971 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003972 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003973 return( PSA_ERROR_INVALID_ARGUMENT );
3974
3975#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003976 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003977 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003978 mbedtls_rsa_context *rsa = NULL;
3979 status = psa_load_rsa_representation( slot->attr.type,
3980 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02003981 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02003982 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003983 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02003984 return( status );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003985
Steven Cooremana2371e52020-07-28 14:30:39 +02003986 if( input_length != mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003987 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003988 status = PSA_ERROR_INVALID_ARGUMENT;
3989 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003990 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003991
3992#if defined(MBEDTLS_PKCS1_V15)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003993 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003994 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003995 status = mbedtls_to_psa_error(
3996 mbedtls_rsa_pkcs1_decrypt( rsa,
3997 mbedtls_ctr_drbg_random,
3998 &global_data.ctr_drbg,
3999 MBEDTLS_RSA_PRIVATE,
4000 output_length,
4001 input,
4002 output,
4003 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004004 }
4005 else
4006#endif /* MBEDTLS_PKCS1_V15 */
4007#if defined(MBEDTLS_PKCS1_V21)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02004008 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004009 {
Steven Cooremana2371e52020-07-28 14:30:39 +02004010 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02004011 status = mbedtls_to_psa_error(
4012 mbedtls_rsa_rsaes_oaep_decrypt( rsa,
4013 mbedtls_ctr_drbg_random,
4014 &global_data.ctr_drbg,
4015 MBEDTLS_RSA_PRIVATE,
4016 salt, salt_length,
4017 output_length,
4018 input,
4019 output,
4020 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004021 }
4022 else
4023#endif /* MBEDTLS_PKCS1_V21 */
4024 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004025 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004026 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03004027
Steven Cooreman4fed4552020-08-03 14:46:03 +02004028rsa_exit:
Steven Cooremana2371e52020-07-28 14:30:39 +02004029 mbedtls_rsa_free( rsa );
4030 mbedtls_free( rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02004031 return( status );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004032 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004033 else
Gilles Peskineb75e4f12018-06-08 17:44:47 +02004034#endif /* defined(MBEDTLS_RSA_C) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004035 {
4036 return( PSA_ERROR_NOT_SUPPORTED );
4037 }
Gilles Peskine5b051bc2018-05-31 13:25:48 +02004038}
Gilles Peskine20035e32018-02-03 22:44:14 +01004039
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004040
4041
mohammad1603503973b2018-03-12 15:59:30 +02004042/****************************************************************/
4043/* Symmetric cryptography */
4044/****************************************************************/
4045
Gilles Peskinee553c652018-06-04 16:22:46 +02004046static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01004047 psa_key_handle_t handle,
Gilles Peskine7e928852018-06-04 16:23:10 +02004048 psa_algorithm_t alg,
4049 mbedtls_operation_t cipher_operation )
mohammad1603503973b2018-03-12 15:59:30 +02004050{
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004051 int ret = 0;
4052 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Gilles Peskine2f060a82018-12-04 17:12:32 +01004053 psa_key_slot_t *slot;
mohammad1603503973b2018-03-12 15:59:30 +02004054 size_t key_bits;
4055 const mbedtls_cipher_info_t *cipher_info = NULL;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004056 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
4057 PSA_KEY_USAGE_ENCRYPT :
4058 PSA_KEY_USAGE_DECRYPT );
mohammad1603503973b2018-03-12 15:59:30 +02004059
Steven Cooremand3feccd2020-09-01 15:56:14 +02004060 /* A context must be freshly initialized before it can be set up. */
4061 if( operation->alg != 0 )
4062 return( PSA_ERROR_BAD_STATE );
4063
Steven Cooremana07b9972020-09-10 14:54:14 +02004064 /* The requested algorithm must be one that can be processed by cipher. */
4065 if( ! PSA_ALG_IS_CIPHER( alg ) )
Steven Cooremana07b9972020-09-10 14:54:14 +02004066 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremand3feccd2020-09-01 15:56:14 +02004067
Steven Cooremanef8575e2020-09-11 11:44:50 +02004068 /* Fetch key material from key storage. */
4069 status = psa_get_key_from_slot( handle, &slot, usage, alg );
4070 if( status != PSA_SUCCESS )
4071 goto exit;
4072
4073 /* Initialize the operation struct members, except for alg. The alg member
4074 * is used to indicate to psa_cipher_abort that there are resources to free,
4075 * so we only set it after resources have been allocated/initialized. */
Steven Cooremana07b9972020-09-10 14:54:14 +02004076 operation->key_set = 0;
4077 operation->iv_set = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004078 operation->mbedtls_in_use = 0;
Steven Cooremana07b9972020-09-10 14:54:14 +02004079 operation->iv_size = 0;
4080 operation->block_size = 0;
4081 if( alg == PSA_ALG_ECB_NO_PADDING )
4082 operation->iv_required = 0;
4083 else
4084 operation->iv_required = 1;
4085
Steven Cooremana07b9972020-09-10 14:54:14 +02004086 /* Try doing the operation through a driver before using software fallback. */
Steven Cooreman37941cb2020-07-28 18:49:51 +02004087 if( cipher_operation == MBEDTLS_ENCRYPT )
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004088 status = psa_driver_wrapper_cipher_encrypt_setup( &operation->ctx.driver,
Steven Cooreman37941cb2020-07-28 18:49:51 +02004089 slot,
4090 alg );
4091 else
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004092 status = psa_driver_wrapper_cipher_decrypt_setup( &operation->ctx.driver,
Steven Cooreman37941cb2020-07-28 18:49:51 +02004093 slot,
4094 alg );
4095
Steven Cooremanef8575e2020-09-11 11:44:50 +02004096 if( status == PSA_SUCCESS )
Steven Cooreman6d81f7e2020-09-14 13:14:31 +02004097 {
Steven Cooremanef8575e2020-09-11 11:44:50 +02004098 /* Once the driver context is initialised, it needs to be freed using
4099 * psa_cipher_abort. Indicate this through setting alg. */
4100 operation->alg = alg;
Steven Cooreman6d81f7e2020-09-14 13:14:31 +02004101 }
Steven Cooremanef8575e2020-09-11 11:44:50 +02004102
Steven Cooremand3feccd2020-09-01 15:56:14 +02004103 if( status != PSA_ERROR_NOT_SUPPORTED ||
4104 psa_key_lifetime_is_external( slot->attr.lifetime ) )
4105 goto exit;
4106
Steven Cooremana07b9972020-09-10 14:54:14 +02004107 /* Proceed with initializing an mbed TLS cipher context if no driver is
Steven Cooremand3feccd2020-09-01 15:56:14 +02004108 * available for the given algorithm & key. */
4109 mbedtls_cipher_init( &operation->ctx.cipher );
mohammad1603503973b2018-03-12 15:59:30 +02004110
Steven Cooremana07b9972020-09-10 14:54:14 +02004111 /* Once the cipher context is initialised, it needs to be freed using
Steven Cooremanef8575e2020-09-11 11:44:50 +02004112 * psa_cipher_abort. Indicate there is something to be freed through setting
4113 * alg, and indicate the operation is being done using mbedtls crypto through
4114 * setting mbedtls_in_use. */
Steven Cooremana07b9972020-09-10 14:54:14 +02004115 operation->alg = alg;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004116 operation->mbedtls_in_use = 1;
Steven Cooremana07b9972020-09-10 14:54:14 +02004117
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02004118 key_bits = psa_get_key_slot_bits( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +02004119 cipher_info = mbedtls_cipher_info_from_psa( alg, slot->attr.type, key_bits, NULL );
mohammad1603503973b2018-03-12 15:59:30 +02004120 if( cipher_info == NULL )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004121 {
4122 status = PSA_ERROR_NOT_SUPPORTED;
4123 goto exit;
4124 }
mohammad1603503973b2018-03-12 15:59:30 +02004125
mohammad1603503973b2018-03-12 15:59:30 +02004126 ret = mbedtls_cipher_setup( &operation->ctx.cipher, cipher_info );
Moran Peker41deec42018-04-04 15:43:05 +03004127 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004128 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004129
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004130#if defined(MBEDTLS_DES_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02004131 if( slot->attr.type == PSA_KEY_TYPE_DES && key_bits == 128 )
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004132 {
4133 /* Two-key Triple-DES is 3-key Triple-DES with K1=K3 */
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02004134 uint8_t keys[24];
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004135 memcpy( keys, slot->data.key.data, 16 );
4136 memcpy( keys + 16, slot->data.key.data, 8 );
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004137 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
4138 keys,
4139 192, cipher_operation );
4140 }
4141 else
4142#endif
4143 {
4144 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004145 slot->data.key.data,
Jaeden Amero23bbb752018-06-26 14:16:54 +01004146 (int) key_bits, cipher_operation );
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004147 }
Moran Peker41deec42018-04-04 15:43:05 +03004148 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004149 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004150
mohammad16038481e742018-03-18 13:57:31 +02004151#if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004152 switch( alg )
mohammad16038481e742018-03-18 13:57:31 +02004153 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004154 case PSA_ALG_CBC_NO_PADDING:
4155 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
4156 MBEDTLS_PADDING_NONE );
4157 break;
4158 case PSA_ALG_CBC_PKCS7:
4159 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
4160 MBEDTLS_PADDING_PKCS7 );
4161 break;
4162 default:
4163 /* The algorithm doesn't involve padding. */
4164 ret = 0;
4165 break;
4166 }
4167 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004168 goto exit;
mohammad16038481e742018-03-18 13:57:31 +02004169#endif //MBEDTLS_CIPHER_MODE_WITH_PADDING
4170
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004171 operation->block_size = ( PSA_ALG_IS_STREAM_CIPHER( alg ) ? 1 :
Gilles Peskine8e338702019-07-30 20:06:31 +02004172 PSA_BLOCK_CIPHER_BLOCK_SIZE( slot->attr.type ) );
Steven Cooremana6033e92020-08-25 11:47:50 +02004173 if( ( alg & PSA_ALG_CIPHER_FROM_BLOCK_FLAG ) != 0 &&
4174 alg != PSA_ALG_ECB_NO_PADDING )
mohammad16038481e742018-03-18 13:57:31 +02004175 {
Gilles Peskine8e338702019-07-30 20:06:31 +02004176 operation->iv_size = PSA_BLOCK_CIPHER_BLOCK_SIZE( slot->attr.type );
mohammad16038481e742018-03-18 13:57:31 +02004177 }
Gilles Peskine26869f22019-05-06 15:25:00 +02004178#if defined(MBEDTLS_CHACHA20_C)
4179 else
4180 if( alg == PSA_ALG_CHACHA20 )
4181 operation->iv_size = 12;
4182#endif
mohammad1603503973b2018-03-12 15:59:30 +02004183
Steven Cooreman7df02922020-09-09 15:28:49 +02004184 status = PSA_SUCCESS;
4185
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004186exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02004187 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004188 status = mbedtls_to_psa_error( ret );
Steven Cooreman7df02922020-09-09 15:28:49 +02004189 if( status == PSA_SUCCESS )
4190 {
4191 /* Update operation flags for both driver and software implementations */
4192 operation->key_set = 1;
4193 }
4194 else
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004195 psa_cipher_abort( operation );
4196 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004197}
4198
Gilles Peskinefe119512018-07-08 21:39:34 +02004199psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01004200 psa_key_handle_t handle,
Gilles Peskinefe119512018-07-08 21:39:34 +02004201 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02004202{
Gilles Peskinec5487a82018-12-03 18:08:14 +01004203 return( psa_cipher_setup( operation, handle, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02004204}
4205
Gilles Peskinefe119512018-07-08 21:39:34 +02004206psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01004207 psa_key_handle_t handle,
Gilles Peskinefe119512018-07-08 21:39:34 +02004208 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02004209{
Gilles Peskinec5487a82018-12-03 18:08:14 +01004210 return( psa_cipher_setup( operation, handle, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02004211}
4212
Gilles Peskinefe119512018-07-08 21:39:34 +02004213psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004214 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02004215 size_t iv_size,
4216 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02004217{
itayzafrir534bd7c2018-08-02 13:56:32 +03004218 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00004219 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooreman7df02922020-09-09 15:28:49 +02004220 if( operation->iv_set || ! operation->iv_required )
4221 {
4222 return( PSA_ERROR_BAD_STATE );
4223 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004224
Steven Cooremanef8575e2020-09-11 11:44:50 +02004225 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004226 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004227 status = psa_driver_wrapper_cipher_generate_iv( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004228 iv,
4229 iv_size,
4230 iv_length );
4231 goto exit;
4232 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004233
Moran Peker41deec42018-04-04 15:43:05 +03004234 if( iv_size < operation->iv_size )
mohammad1603503973b2018-03-12 15:59:30 +02004235 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004236 status = PSA_ERROR_BUFFER_TOO_SMALL;
Moran Peker41deec42018-04-04 15:43:05 +03004237 goto exit;
4238 }
Gilles Peskine7e928852018-06-04 16:23:10 +02004239 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg,
4240 iv, operation->iv_size );
Moran Peker41deec42018-04-04 15:43:05 +03004241 if( ret != 0 )
4242 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004243 status = mbedtls_to_psa_error( ret );
Gilles Peskinee553c652018-06-04 16:22:46 +02004244 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004245 }
Gilles Peskinee553c652018-06-04 16:22:46 +02004246
mohammad16038481e742018-03-18 13:57:31 +02004247 *iv_length = operation->iv_size;
itayzafrir534bd7c2018-08-02 13:56:32 +03004248 status = psa_cipher_set_iv( operation, iv, *iv_length );
Moran Peker41deec42018-04-04 15:43:05 +03004249
Moran Peker395db872018-05-31 14:07:14 +03004250exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02004251 if( status == PSA_SUCCESS )
4252 operation->iv_set = 1;
4253 else
Moran Peker395db872018-05-31 14:07:14 +03004254 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004255 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004256}
4257
Gilles Peskinefe119512018-07-08 21:39:34 +02004258psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004259 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02004260 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02004261{
itayzafrir534bd7c2018-08-02 13:56:32 +03004262 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00004263 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooreman7df02922020-09-09 15:28:49 +02004264 if( operation->iv_set || ! operation->iv_required )
4265 {
4266 return( PSA_ERROR_BAD_STATE );
4267 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004268
Steven Cooremanef8575e2020-09-11 11:44:50 +02004269 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004270 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004271 status = psa_driver_wrapper_cipher_set_iv( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004272 iv,
4273 iv_length );
4274 goto exit;
4275 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004276
Moran Pekera28258c2018-05-29 16:25:04 +03004277 if( iv_length != operation->iv_size )
Moran Peker71f19ae2018-04-22 20:23:16 +03004278 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004279 status = PSA_ERROR_INVALID_ARGUMENT;
4280 goto exit;
Moran Peker71f19ae2018-04-22 20:23:16 +03004281 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004282 ret = mbedtls_cipher_set_iv( &operation->ctx.cipher, iv, iv_length );
4283 status = mbedtls_to_psa_error( ret );
4284exit:
4285 if( status == PSA_SUCCESS )
4286 operation->iv_set = 1;
4287 else
mohammad1603503973b2018-03-12 15:59:30 +02004288 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004289 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004290}
4291
Steven Cooreman177deba2020-09-07 17:14:14 +02004292/* Process input for which the algorithm is set to ECB mode. This requires
4293 * manual processing, since the PSA API is defined as being able to process
4294 * arbitrary-length calls to psa_cipher_update() with ECB mode, but the
4295 * underlying mbedtls_cipher_update only takes full blocks. */
4296static psa_status_t psa_cipher_update_ecb_internal(
4297 mbedtls_cipher_context_t *ctx,
4298 const uint8_t *input,
4299 size_t input_length,
4300 uint8_t *output,
4301 size_t output_size,
4302 size_t *output_length )
4303{
4304 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4305 size_t block_size = ctx->cipher_info->block_size;
4306 size_t internal_output_length = 0;
4307 *output_length = 0;
4308
4309 if( input_length == 0 )
4310 {
4311 status = PSA_SUCCESS;
4312 goto exit;
4313 }
4314
4315 if( ctx->unprocessed_len > 0 )
4316 {
4317 /* Fill up to block size, and run the block if there's a full one. */
4318 size_t bytes_to_copy = block_size - ctx->unprocessed_len;
4319
4320 if( input_length < bytes_to_copy )
4321 bytes_to_copy = input_length;
4322
4323 memcpy( &( ctx->unprocessed_data[ctx->unprocessed_len] ),
4324 input, bytes_to_copy );
4325 input_length -= bytes_to_copy;
4326 input += bytes_to_copy;
4327 ctx->unprocessed_len += bytes_to_copy;
4328
4329 if( ctx->unprocessed_len == block_size )
4330 {
4331 status = mbedtls_to_psa_error(
4332 mbedtls_cipher_update( ctx,
4333 ctx->unprocessed_data,
4334 block_size,
4335 output, &internal_output_length ) );
4336
4337 if( status != PSA_SUCCESS )
4338 goto exit;
4339
4340 output += internal_output_length;
4341 output_size -= internal_output_length;
4342 *output_length += internal_output_length;
4343 ctx->unprocessed_len = 0;
4344 }
4345 }
4346
4347 while( input_length >= block_size )
4348 {
4349 /* Run all full blocks we have, one by one */
4350 status = mbedtls_to_psa_error(
4351 mbedtls_cipher_update( ctx, input,
4352 block_size,
4353 output, &internal_output_length ) );
4354
4355 if( status != PSA_SUCCESS )
4356 goto exit;
4357
4358 input_length -= block_size;
4359 input += block_size;
4360
4361 output += internal_output_length;
4362 output_size -= internal_output_length;
4363 *output_length += internal_output_length;
4364 }
4365
4366 if( input_length > 0 )
4367 {
4368 /* Save unprocessed bytes for later processing */
4369 memcpy( &( ctx->unprocessed_data[ctx->unprocessed_len] ),
4370 input, input_length );
4371 ctx->unprocessed_len += input_length;
4372 }
4373
4374 status = PSA_SUCCESS;
4375
4376exit:
4377 return( status );
4378}
4379
Gilles Peskinee553c652018-06-04 16:22:46 +02004380psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
4381 const uint8_t *input,
4382 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004383 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02004384 size_t output_size,
4385 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02004386{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004387 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine89d789c2018-06-04 17:17:16 +02004388 size_t expected_output_size;
Steven Cooreman7df02922020-09-09 15:28:49 +02004389 if( operation->alg == 0 )
4390 {
4391 return( PSA_ERROR_BAD_STATE );
4392 }
4393 if( operation->iv_required && ! operation->iv_set )
4394 {
4395 return( PSA_ERROR_BAD_STATE );
4396 }
Jaeden Ameroab439972019-02-15 14:12:05 +00004397
Steven Cooremanef8575e2020-09-11 11:44:50 +02004398 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004399 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004400 status = psa_driver_wrapper_cipher_update( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004401 input,
4402 input_length,
4403 output,
4404 output_size,
4405 output_length );
4406 goto exit;
4407 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004408
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004409 if( ! PSA_ALG_IS_STREAM_CIPHER( operation->alg ) )
Gilles Peskine89d789c2018-06-04 17:17:16 +02004410 {
4411 /* Take the unprocessed partial block left over from previous
4412 * update calls, if any, plus the input to this call. Remove
4413 * the last partial block, if any. You get the data that will be
4414 * output in this call. */
4415 expected_output_size =
4416 ( operation->ctx.cipher.unprocessed_len + input_length )
4417 / operation->block_size * operation->block_size;
4418 }
4419 else
4420 {
4421 expected_output_size = input_length;
4422 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004423
Gilles Peskine89d789c2018-06-04 17:17:16 +02004424 if( output_size < expected_output_size )
itayzafrir534bd7c2018-08-02 13:56:32 +03004425 {
4426 status = PSA_ERROR_BUFFER_TOO_SMALL;
4427 goto exit;
4428 }
mohammad160382759612018-03-12 18:16:40 +02004429
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004430 if( operation->alg == PSA_ALG_ECB_NO_PADDING )
4431 {
4432 /* mbedtls_cipher_update has an API inconsistency: it will only
4433 * process a single block at a time in ECB mode. Abstract away that
4434 * inconsistency here to match the PSA API behaviour. */
Steven Cooreman177deba2020-09-07 17:14:14 +02004435 status = psa_cipher_update_ecb_internal( &operation->ctx.cipher,
4436 input,
4437 input_length,
4438 output,
4439 output_size,
4440 output_length );
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004441 }
4442 else
4443 {
4444 status = mbedtls_to_psa_error(
4445 mbedtls_cipher_update( &operation->ctx.cipher, input,
4446 input_length, output, output_length ) );
4447 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004448exit:
4449 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02004450 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004451 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004452}
4453
Gilles Peskinee553c652018-06-04 16:22:46 +02004454psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
4455 uint8_t *output,
4456 size_t output_size,
4457 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02004458{
David Saadab4ecc272019-02-14 13:48:10 +02004459 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Gilles Peskinee553c652018-06-04 16:22:46 +02004460 uint8_t temp_output_buffer[MBEDTLS_MAX_BLOCK_LENGTH];
Steven Cooreman7df02922020-09-09 15:28:49 +02004461 if( operation->alg == 0 )
4462 {
4463 return( PSA_ERROR_BAD_STATE );
4464 }
4465 if( operation->iv_required && ! operation->iv_set )
4466 {
4467 return( PSA_ERROR_BAD_STATE );
4468 }
Moran Pekerbed71a22018-04-22 20:19:20 +03004469
Steven Cooremanef8575e2020-09-11 11:44:50 +02004470 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004471 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004472 status = psa_driver_wrapper_cipher_finish( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004473 output,
4474 output_size,
4475 output_length );
Steven Cooremanef8575e2020-09-11 11:44:50 +02004476 goto exit;
Steven Cooreman8b122252020-09-03 15:30:32 +02004477 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004478
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004479 if( operation->ctx.cipher.unprocessed_len != 0 )
Moran Peker7cb22b82018-06-05 11:40:02 +03004480 {
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004481 if( operation->alg == PSA_ALG_ECB_NO_PADDING ||
Fredrik Strupef90e3012020-09-28 16:11:33 +02004482 operation->alg == PSA_ALG_CBC_NO_PADDING )
Steven Cooremana6033e92020-08-25 11:47:50 +02004483 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004484 status = PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004485 goto exit;
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004486 }
Moran Pekerdc38ebc2018-04-30 15:45:34 +03004487 }
4488
Steven Cooremanef8575e2020-09-11 11:44:50 +02004489 status = mbedtls_to_psa_error(
4490 mbedtls_cipher_finish( &operation->ctx.cipher,
4491 temp_output_buffer,
4492 output_length ) );
4493 if( status != PSA_SUCCESS )
4494 goto exit;
Janos Follath315b51c2018-07-09 16:04:51 +01004495
Gilles Peskine46f1fd72018-06-28 19:31:31 +02004496 if( *output_length == 0 )
Janos Follath315b51c2018-07-09 16:04:51 +01004497 ; /* Nothing to copy. Note that output may be NULL in this case. */
Gilles Peskine46f1fd72018-06-28 19:31:31 +02004498 else if( output_size >= *output_length )
Moran Pekerdc38ebc2018-04-30 15:45:34 +03004499 memcpy( output, temp_output_buffer, *output_length );
4500 else
Janos Follath315b51c2018-07-09 16:04:51 +01004501 status = PSA_ERROR_BUFFER_TOO_SMALL;
mohammad1603503973b2018-03-12 15:59:30 +02004502
Steven Cooremanef8575e2020-09-11 11:44:50 +02004503exit:
4504 if( operation->mbedtls_in_use == 1 )
4505 mbedtls_platform_zeroize( temp_output_buffer, sizeof( temp_output_buffer ) );
Janos Follath315b51c2018-07-09 16:04:51 +01004506
Steven Cooremanef8575e2020-09-11 11:44:50 +02004507 if( status == PSA_SUCCESS )
4508 return( psa_cipher_abort( operation ) );
4509 else
4510 {
4511 *output_length = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004512 (void) psa_cipher_abort( operation );
Janos Follath315b51c2018-07-09 16:04:51 +01004513
Steven Cooremanef8575e2020-09-11 11:44:50 +02004514 return( status );
4515 }
mohammad1603503973b2018-03-12 15:59:30 +02004516}
4517
Gilles Peskinee553c652018-06-04 16:22:46 +02004518psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
4519{
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004520 if( operation->alg == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02004521 {
Steven Cooremana07b9972020-09-10 14:54:14 +02004522 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02004523 * in use. It's ok to call abort on such an object, and there's
4524 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004525 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02004526 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004527
Gilles Peskinef9c2c092018-06-21 16:57:07 +02004528 /* Sanity check (shouldn't happen: operation->alg should
4529 * always have been initialized to a valid value). */
4530 if( ! PSA_ALG_IS_CIPHER( operation->alg ) )
4531 return( PSA_ERROR_BAD_STATE );
4532
Steven Cooremanef8575e2020-09-11 11:44:50 +02004533 if( operation->mbedtls_in_use == 0 )
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004534 psa_driver_wrapper_cipher_abort( &operation->ctx.driver );
Steven Cooremand3feccd2020-09-01 15:56:14 +02004535 else
4536 mbedtls_cipher_free( &operation->ctx.cipher );
Gilles Peskinee553c652018-06-04 16:22:46 +02004537
Moran Peker41deec42018-04-04 15:43:05 +03004538 operation->alg = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004539 operation->key_set = 0;
4540 operation->iv_set = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004541 operation->mbedtls_in_use = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004542 operation->iv_size = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004543 operation->block_size = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004544 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004545
Moran Peker395db872018-05-31 14:07:14 +03004546 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02004547}
4548
Gilles Peskinea0655c32018-04-30 17:06:50 +02004549
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004550
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004551
mohammad16035955c982018-04-26 00:53:03 +03004552/****************************************************************/
4553/* AEAD */
4554/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004555
Gilles Peskineedf9a652018-08-17 18:11:56 +02004556typedef struct
4557{
Gilles Peskine2f060a82018-12-04 17:12:32 +01004558 psa_key_slot_t *slot;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004559 const mbedtls_cipher_info_t *cipher_info;
4560 union
4561 {
4562#if defined(MBEDTLS_CCM_C)
4563 mbedtls_ccm_context ccm;
4564#endif /* MBEDTLS_CCM_C */
4565#if defined(MBEDTLS_GCM_C)
4566 mbedtls_gcm_context gcm;
4567#endif /* MBEDTLS_GCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004568#if defined(MBEDTLS_CHACHAPOLY_C)
4569 mbedtls_chachapoly_context chachapoly;
4570#endif /* MBEDTLS_CHACHAPOLY_C */
Gilles Peskineedf9a652018-08-17 18:11:56 +02004571 } ctx;
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004572 psa_algorithm_t core_alg;
4573 uint8_t full_tag_length;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004574 uint8_t tag_length;
4575} aead_operation_t;
4576
Gilles Peskine30a9e412019-01-14 18:36:12 +01004577static void psa_aead_abort_internal( aead_operation_t *operation )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004578{
Gilles Peskinef8a8fe62018-08-21 16:38:05 +02004579 switch( operation->core_alg )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004580 {
4581#if defined(MBEDTLS_CCM_C)
4582 case PSA_ALG_CCM:
4583 mbedtls_ccm_free( &operation->ctx.ccm );
4584 break;
4585#endif /* MBEDTLS_CCM_C */
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004586#if defined(MBEDTLS_GCM_C)
Gilles Peskineedf9a652018-08-17 18:11:56 +02004587 case PSA_ALG_GCM:
4588 mbedtls_gcm_free( &operation->ctx.gcm );
4589 break;
4590#endif /* MBEDTLS_GCM_C */
4591 }
4592}
4593
4594static psa_status_t psa_aead_setup( aead_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01004595 psa_key_handle_t handle,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004596 psa_key_usage_t usage,
4597 psa_algorithm_t alg )
4598{
4599 psa_status_t status;
4600 size_t key_bits;
4601 mbedtls_cipher_id_t cipher_id;
4602
Gilles Peskine28f8f302019-07-24 13:30:31 +02004603 status = psa_get_transparent_key( handle, &operation->slot, usage, alg );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004604 if( status != PSA_SUCCESS )
4605 return( status );
4606
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02004607 key_bits = psa_get_key_slot_bits( operation->slot );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004608
4609 operation->cipher_info =
Gilles Peskine8e338702019-07-30 20:06:31 +02004610 mbedtls_cipher_info_from_psa( alg, operation->slot->attr.type, key_bits,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004611 &cipher_id );
4612 if( operation->cipher_info == NULL )
4613 return( PSA_ERROR_NOT_SUPPORTED );
4614
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004615 switch( PSA_ALG_AEAD_WITH_TAG_LENGTH( alg, 0 ) )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004616 {
4617#if defined(MBEDTLS_CCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004618 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CCM, 0 ):
4619 operation->core_alg = PSA_ALG_CCM;
4620 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004621 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.
4622 * The call to mbedtls_ccm_encrypt_and_tag or
4623 * mbedtls_ccm_auth_decrypt will validate the tag length. */
Gilles Peskine8e338702019-07-30 20:06:31 +02004624 if( PSA_BLOCK_CIPHER_BLOCK_SIZE( operation->slot->attr.type ) != 16 )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004625 return( PSA_ERROR_INVALID_ARGUMENT );
4626 mbedtls_ccm_init( &operation->ctx.ccm );
4627 status = mbedtls_to_psa_error(
4628 mbedtls_ccm_setkey( &operation->ctx.ccm, cipher_id,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004629 operation->slot->data.key.data,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004630 (unsigned int) key_bits ) );
4631 if( status != 0 )
4632 goto cleanup;
4633 break;
4634#endif /* MBEDTLS_CCM_C */
4635
4636#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004637 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_GCM, 0 ):
4638 operation->core_alg = PSA_ALG_GCM;
4639 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004640 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16.
4641 * The call to mbedtls_gcm_crypt_and_tag or
4642 * mbedtls_gcm_auth_decrypt will validate the tag length. */
Gilles Peskine8e338702019-07-30 20:06:31 +02004643 if( PSA_BLOCK_CIPHER_BLOCK_SIZE( operation->slot->attr.type ) != 16 )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004644 return( PSA_ERROR_INVALID_ARGUMENT );
4645 mbedtls_gcm_init( &operation->ctx.gcm );
4646 status = mbedtls_to_psa_error(
4647 mbedtls_gcm_setkey( &operation->ctx.gcm, cipher_id,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004648 operation->slot->data.key.data,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004649 (unsigned int) key_bits ) );
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004650 if( status != 0 )
4651 goto cleanup;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004652 break;
4653#endif /* MBEDTLS_GCM_C */
4654
Gilles Peskine26869f22019-05-06 15:25:00 +02004655#if defined(MBEDTLS_CHACHAPOLY_C)
4656 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CHACHA20_POLY1305, 0 ):
4657 operation->core_alg = PSA_ALG_CHACHA20_POLY1305;
4658 operation->full_tag_length = 16;
4659 /* We only support the default tag length. */
4660 if( alg != PSA_ALG_CHACHA20_POLY1305 )
4661 return( PSA_ERROR_NOT_SUPPORTED );
4662 mbedtls_chachapoly_init( &operation->ctx.chachapoly );
4663 status = mbedtls_to_psa_error(
4664 mbedtls_chachapoly_setkey( &operation->ctx.chachapoly,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004665 operation->slot->data.key.data ) );
Gilles Peskine26869f22019-05-06 15:25:00 +02004666 if( status != 0 )
4667 goto cleanup;
4668 break;
4669#endif /* MBEDTLS_CHACHAPOLY_C */
4670
Gilles Peskineedf9a652018-08-17 18:11:56 +02004671 default:
4672 return( PSA_ERROR_NOT_SUPPORTED );
4673 }
4674
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004675 if( PSA_AEAD_TAG_LENGTH( alg ) > operation->full_tag_length )
4676 {
4677 status = PSA_ERROR_INVALID_ARGUMENT;
4678 goto cleanup;
4679 }
4680 operation->tag_length = PSA_AEAD_TAG_LENGTH( alg );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004681
Gilles Peskineedf9a652018-08-17 18:11:56 +02004682 return( PSA_SUCCESS );
4683
4684cleanup:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004685 psa_aead_abort_internal( operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004686 return( status );
4687}
4688
Gilles Peskinec5487a82018-12-03 18:08:14 +01004689psa_status_t psa_aead_encrypt( psa_key_handle_t handle,
mohammad16035955c982018-04-26 00:53:03 +03004690 psa_algorithm_t alg,
4691 const uint8_t *nonce,
4692 size_t nonce_length,
4693 const uint8_t *additional_data,
4694 size_t additional_data_length,
4695 const uint8_t *plaintext,
4696 size_t plaintext_length,
4697 uint8_t *ciphertext,
4698 size_t ciphertext_size,
4699 size_t *ciphertext_length )
4700{
mohammad16035955c982018-04-26 00:53:03 +03004701 psa_status_t status;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004702 aead_operation_t operation;
mohammad160315223a82018-06-03 17:19:55 +03004703 uint8_t *tag;
Gilles Peskine2d277862018-06-18 15:41:12 +02004704
mohammad1603f08a5502018-06-03 15:05:47 +03004705 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004706
Gilles Peskinec5487a82018-12-03 18:08:14 +01004707 status = psa_aead_setup( &operation, handle, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004708 if( status != PSA_SUCCESS )
4709 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004710
Gilles Peskineedf9a652018-08-17 18:11:56 +02004711 /* For all currently supported modes, the tag is at the end of the
4712 * ciphertext. */
4713 if( ciphertext_size < ( plaintext_length + operation.tag_length ) )
4714 {
4715 status = PSA_ERROR_BUFFER_TOO_SMALL;
4716 goto exit;
4717 }
4718 tag = ciphertext + plaintext_length;
mohammad16035955c982018-04-26 00:53:03 +03004719
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004720#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004721 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03004722 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004723 status = mbedtls_to_psa_error(
4724 mbedtls_gcm_crypt_and_tag( &operation.ctx.gcm,
4725 MBEDTLS_GCM_ENCRYPT,
4726 plaintext_length,
4727 nonce, nonce_length,
4728 additional_data, additional_data_length,
4729 plaintext, ciphertext,
4730 operation.tag_length, tag ) );
mohammad16035955c982018-04-26 00:53:03 +03004731 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004732 else
4733#endif /* MBEDTLS_GCM_C */
4734#if defined(MBEDTLS_CCM_C)
4735 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03004736 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004737 status = mbedtls_to_psa_error(
4738 mbedtls_ccm_encrypt_and_tag( &operation.ctx.ccm,
4739 plaintext_length,
4740 nonce, nonce_length,
4741 additional_data,
4742 additional_data_length,
4743 plaintext, ciphertext,
4744 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03004745 }
mohammad16035c8845f2018-05-09 05:40:09 -07004746 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004747#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004748#if defined(MBEDTLS_CHACHAPOLY_C)
4749 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
4750 {
4751 if( nonce_length != 12 || operation.tag_length != 16 )
4752 {
4753 status = PSA_ERROR_NOT_SUPPORTED;
4754 goto exit;
4755 }
4756 status = mbedtls_to_psa_error(
4757 mbedtls_chachapoly_encrypt_and_tag( &operation.ctx.chachapoly,
4758 plaintext_length,
4759 nonce,
4760 additional_data,
4761 additional_data_length,
4762 plaintext,
4763 ciphertext,
4764 tag ) );
4765 }
4766 else
4767#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad16035c8845f2018-05-09 05:40:09 -07004768 {
mohammad1603554faad2018-06-03 15:07:38 +03004769 return( PSA_ERROR_NOT_SUPPORTED );
mohammad16035c8845f2018-05-09 05:40:09 -07004770 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004771
Gilles Peskineedf9a652018-08-17 18:11:56 +02004772 if( status != PSA_SUCCESS && ciphertext_size != 0 )
4773 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02004774
Gilles Peskineedf9a652018-08-17 18:11:56 +02004775exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004776 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004777 if( status == PSA_SUCCESS )
4778 *ciphertext_length = plaintext_length + operation.tag_length;
4779 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004780}
4781
Gilles Peskineee652a32018-06-01 19:23:52 +02004782/* Locate the tag in a ciphertext buffer containing the encrypted data
4783 * followed by the tag. Return the length of the part preceding the tag in
4784 * *plaintext_length. This is the size of the plaintext in modes where
4785 * the encrypted data has the same size as the plaintext, such as
4786 * CCM and GCM. */
4787static psa_status_t psa_aead_unpadded_locate_tag( size_t tag_length,
4788 const uint8_t *ciphertext,
4789 size_t ciphertext_length,
4790 size_t plaintext_size,
Gilles Peskineee652a32018-06-01 19:23:52 +02004791 const uint8_t **p_tag )
4792{
4793 size_t payload_length;
4794 if( tag_length > ciphertext_length )
4795 return( PSA_ERROR_INVALID_ARGUMENT );
4796 payload_length = ciphertext_length - tag_length;
4797 if( payload_length > plaintext_size )
4798 return( PSA_ERROR_BUFFER_TOO_SMALL );
4799 *p_tag = ciphertext + payload_length;
Gilles Peskineee652a32018-06-01 19:23:52 +02004800 return( PSA_SUCCESS );
4801}
4802
Gilles Peskinec5487a82018-12-03 18:08:14 +01004803psa_status_t psa_aead_decrypt( psa_key_handle_t handle,
mohammad16035955c982018-04-26 00:53:03 +03004804 psa_algorithm_t alg,
4805 const uint8_t *nonce,
4806 size_t nonce_length,
4807 const uint8_t *additional_data,
4808 size_t additional_data_length,
4809 const uint8_t *ciphertext,
4810 size_t ciphertext_length,
4811 uint8_t *plaintext,
4812 size_t plaintext_size,
4813 size_t *plaintext_length )
4814{
mohammad16035955c982018-04-26 00:53:03 +03004815 psa_status_t status;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004816 aead_operation_t operation;
4817 const uint8_t *tag = NULL;
Gilles Peskine2d277862018-06-18 15:41:12 +02004818
Gilles Peskineee652a32018-06-01 19:23:52 +02004819 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004820
Gilles Peskinec5487a82018-12-03 18:08:14 +01004821 status = psa_aead_setup( &operation, handle, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004822 if( status != PSA_SUCCESS )
4823 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004824
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004825 status = psa_aead_unpadded_locate_tag( operation.tag_length,
4826 ciphertext, ciphertext_length,
4827 plaintext_size, &tag );
4828 if( status != PSA_SUCCESS )
4829 goto exit;
4830
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004831#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004832 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03004833 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004834 status = mbedtls_to_psa_error(
4835 mbedtls_gcm_auth_decrypt( &operation.ctx.gcm,
4836 ciphertext_length - operation.tag_length,
4837 nonce, nonce_length,
4838 additional_data,
4839 additional_data_length,
4840 tag, operation.tag_length,
4841 ciphertext, plaintext ) );
mohammad16035955c982018-04-26 00:53:03 +03004842 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004843 else
4844#endif /* MBEDTLS_GCM_C */
4845#if defined(MBEDTLS_CCM_C)
4846 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03004847 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004848 status = mbedtls_to_psa_error(
4849 mbedtls_ccm_auth_decrypt( &operation.ctx.ccm,
4850 ciphertext_length - operation.tag_length,
4851 nonce, nonce_length,
4852 additional_data,
4853 additional_data_length,
4854 ciphertext, plaintext,
4855 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03004856 }
mohammad160339574652018-06-01 04:39:53 -07004857 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004858#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004859#if defined(MBEDTLS_CHACHAPOLY_C)
4860 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
4861 {
4862 if( nonce_length != 12 || operation.tag_length != 16 )
4863 {
4864 status = PSA_ERROR_NOT_SUPPORTED;
4865 goto exit;
4866 }
4867 status = mbedtls_to_psa_error(
4868 mbedtls_chachapoly_auth_decrypt( &operation.ctx.chachapoly,
4869 ciphertext_length - operation.tag_length,
4870 nonce,
4871 additional_data,
4872 additional_data_length,
4873 tag,
4874 ciphertext,
4875 plaintext ) );
4876 }
4877 else
4878#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad160339574652018-06-01 04:39:53 -07004879 {
mohammad1603554faad2018-06-03 15:07:38 +03004880 return( PSA_ERROR_NOT_SUPPORTED );
mohammad160339574652018-06-01 04:39:53 -07004881 }
Gilles Peskinea40d7742018-06-01 16:28:30 +02004882
Gilles Peskineedf9a652018-08-17 18:11:56 +02004883 if( status != PSA_SUCCESS && plaintext_size != 0 )
4884 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03004885
Gilles Peskineedf9a652018-08-17 18:11:56 +02004886exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004887 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004888 if( status == PSA_SUCCESS )
4889 *plaintext_length = ciphertext_length - operation.tag_length;
4890 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004891}
4892
Gilles Peskinea0655c32018-04-30 17:06:50 +02004893
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004894
Gilles Peskine20035e32018-02-03 22:44:14 +01004895/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02004896/* Generators */
4897/****************************************************************/
4898
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004899#define HKDF_STATE_INIT 0 /* no input yet */
4900#define HKDF_STATE_STARTED 1 /* got salt */
4901#define HKDF_STATE_KEYED 2 /* got key */
4902#define HKDF_STATE_OUTPUT 3 /* output started */
4903
Gilles Peskinecbe66502019-05-16 16:59:18 +02004904static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004905 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004906{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004907 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
4908 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004909 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004910 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004911}
4912
4913
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004914psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004915{
4916 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004917 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004918 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004919 {
4920 /* The object has (apparently) been initialized but it is not
4921 * in use. It's ok to call abort on such an object, and there's
4922 * nothing to do. */
4923 }
4924 else
Gilles Peskinebef7f142018-07-12 17:22:21 +02004925#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004926 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004927 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004928 mbedtls_free( operation->ctx.hkdf.info );
4929 status = psa_hmac_abort_internal( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004930 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01004931 else if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004932 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004933 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004934 {
Janos Follath6a1d2622019-06-11 10:37:28 +01004935 if( operation->ctx.tls12_prf.seed != NULL )
4936 {
4937 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
4938 operation->ctx.tls12_prf.seed_length );
4939 mbedtls_free( operation->ctx.tls12_prf.seed );
4940 }
4941
4942 if( operation->ctx.tls12_prf.label != NULL )
4943 {
4944 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
4945 operation->ctx.tls12_prf.label_length );
4946 mbedtls_free( operation->ctx.tls12_prf.label );
4947 }
4948
4949 status = psa_hmac_abort_internal( &operation->ctx.tls12_prf.hmac );
4950
4951 /* We leave the fields Ai and output_block to be erased safely by the
4952 * mbedtls_platform_zeroize() in the end of this function. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004953 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004954 else
4955#endif /* MBEDTLS_MD_C */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004956 {
4957 status = PSA_ERROR_BAD_STATE;
4958 }
Janos Follath083036a2019-06-11 10:22:26 +01004959 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004960 return( status );
4961}
4962
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004963psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02004964 size_t *capacity)
4965{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004966 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004967 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004968 /* This is a blank key derivation operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02004969 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004970 }
4971
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004972 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004973 return( PSA_SUCCESS );
4974}
4975
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004976psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004977 size_t capacity )
4978{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004979 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004980 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004981 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004982 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004983 operation->capacity = capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004984 return( PSA_SUCCESS );
4985}
4986
Gilles Peskinebef7f142018-07-12 17:22:21 +02004987#if defined(MBEDTLS_MD_C)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004988/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02004989 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02004990static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskinebef7f142018-07-12 17:22:21 +02004991 psa_algorithm_t hash_alg,
4992 uint8_t *output,
4993 size_t output_length )
4994{
4995 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
4996 psa_status_t status;
4997
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004998 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
4999 return( PSA_ERROR_BAD_STATE );
5000 hkdf->state = HKDF_STATE_OUTPUT;
5001
Gilles Peskinebef7f142018-07-12 17:22:21 +02005002 while( output_length != 0 )
5003 {
5004 /* Copy what remains of the current block */
5005 uint8_t n = hash_length - hkdf->offset_in_block;
5006 if( n > output_length )
5007 n = (uint8_t) output_length;
5008 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
5009 output += n;
5010 output_length -= n;
5011 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02005012 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02005013 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02005014 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005015 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005016 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02005017 * object was corrupted or if this function is called directly
5018 * inside the library. */
5019 if( hkdf->block_number == 0xff )
5020 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02005021
5022 /* We need a new block */
5023 ++hkdf->block_number;
5024 hkdf->offset_in_block = 0;
5025 status = psa_hmac_setup_internal( &hkdf->hmac,
5026 hkdf->prk, hash_length,
5027 hash_alg );
5028 if( status != PSA_SUCCESS )
5029 return( status );
5030 if( hkdf->block_number != 1 )
5031 {
5032 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5033 hkdf->output_block,
5034 hash_length );
5035 if( status != PSA_SUCCESS )
5036 return( status );
5037 }
5038 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5039 hkdf->info,
5040 hkdf->info_length );
5041 if( status != PSA_SUCCESS )
5042 return( status );
5043 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5044 &hkdf->block_number, 1 );
5045 if( status != PSA_SUCCESS )
5046 return( status );
5047 status = psa_hmac_finish_internal( &hkdf->hmac,
5048 hkdf->output_block,
5049 sizeof( hkdf->output_block ) );
5050 if( status != PSA_SUCCESS )
5051 return( status );
5052 }
5053
5054 return( PSA_SUCCESS );
5055}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005056
Janos Follath7742fee2019-06-17 12:58:10 +01005057static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
5058 psa_tls12_prf_key_derivation_t *tls12_prf,
5059 psa_algorithm_t alg )
5060{
5061 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
5062 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
Janos Follathea29bfb2019-06-19 12:21:20 +01005063 psa_hash_operation_t backup = PSA_HASH_OPERATION_INIT;
5064 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005065
Janos Follath7742fee2019-06-17 12:58:10 +01005066 /* We can't be wanting more output after block 0xff, otherwise
5067 * the capacity check in psa_key_derivation_output_bytes() would have
5068 * prevented this call. It could happen only if the operation
5069 * object was corrupted or if this function is called directly
5070 * inside the library. */
5071 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01005072 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01005073
5074 /* We need a new block */
5075 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01005076 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01005077
5078 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
5079 *
5080 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
5081 *
5082 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
5083 * HMAC_hash(secret, A(2) + seed) +
5084 * HMAC_hash(secret, A(3) + seed) + ...
5085 *
5086 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01005087 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01005088 *
Janos Follathea29bfb2019-06-19 12:21:20 +01005089 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01005090 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01005091 * is currently extracted as `output_block` and where i is
5092 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01005093 */
5094
Janos Follathea29bfb2019-06-19 12:21:20 +01005095 /* Save the hash context before using it, to preserve the hash state with
5096 * only the inner padding in it. We need this, because inner padding depends
5097 * on the key (secret in the RFC's terminology). */
5098 status = psa_hash_clone( &tls12_prf->hmac.hash_ctx, &backup );
5099 if( status != PSA_SUCCESS )
5100 goto cleanup;
5101
5102 /* Calculate A(i) where i = tls12_prf->block_number. */
5103 if( tls12_prf->block_number == 1 )
5104 {
5105 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
5106 * the variable seed and in this instance means it in the context of the
5107 * P_hash function, where seed = label + seed.) */
5108 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5109 tls12_prf->label, tls12_prf->label_length );
5110 if( status != PSA_SUCCESS )
5111 goto cleanup;
5112 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5113 tls12_prf->seed, tls12_prf->seed_length );
5114 if( status != PSA_SUCCESS )
5115 goto cleanup;
5116 }
5117 else
5118 {
5119 /* A(i) = HMAC_hash(secret, A(i-1)) */
5120 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5121 tls12_prf->Ai, hash_length );
5122 if( status != PSA_SUCCESS )
5123 goto cleanup;
5124 }
5125
5126 status = psa_hmac_finish_internal( &tls12_prf->hmac,
5127 tls12_prf->Ai, hash_length );
5128 if( status != PSA_SUCCESS )
5129 goto cleanup;
5130 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
5131 if( status != PSA_SUCCESS )
5132 goto cleanup;
5133
5134 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
5135 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5136 tls12_prf->Ai, hash_length );
5137 if( status != PSA_SUCCESS )
5138 goto cleanup;
5139 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5140 tls12_prf->label, tls12_prf->label_length );
5141 if( status != PSA_SUCCESS )
5142 goto cleanup;
5143 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5144 tls12_prf->seed, tls12_prf->seed_length );
5145 if( status != PSA_SUCCESS )
5146 goto cleanup;
5147 status = psa_hmac_finish_internal( &tls12_prf->hmac,
5148 tls12_prf->output_block, hash_length );
5149 if( status != PSA_SUCCESS )
5150 goto cleanup;
5151 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
5152 if( status != PSA_SUCCESS )
5153 goto cleanup;
5154
Janos Follath7742fee2019-06-17 12:58:10 +01005155
5156cleanup:
5157
Janos Follathea29bfb2019-06-19 12:21:20 +01005158 cleanup_status = psa_hash_abort( &backup );
5159 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
5160 status = cleanup_status;
5161
5162 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01005163}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005164
Janos Follath844eb0e2019-06-19 12:10:49 +01005165static psa_status_t psa_key_derivation_tls12_prf_read(
5166 psa_tls12_prf_key_derivation_t *tls12_prf,
5167 psa_algorithm_t alg,
5168 uint8_t *output,
5169 size_t output_length )
5170{
5171 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
5172 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
5173 psa_status_t status;
5174 uint8_t offset, length;
5175
5176 while( output_length != 0 )
5177 {
5178 /* Check if we have fully processed the current block. */
5179 if( tls12_prf->left_in_block == 0 )
5180 {
5181 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
5182 alg );
5183 if( status != PSA_SUCCESS )
5184 return( status );
5185
5186 continue;
5187 }
5188
5189 if( tls12_prf->left_in_block > output_length )
5190 length = (uint8_t) output_length;
5191 else
5192 length = tls12_prf->left_in_block;
5193
5194 offset = hash_length - tls12_prf->left_in_block;
5195 memcpy( output, tls12_prf->output_block + offset, length );
5196 output += length;
5197 output_length -= length;
5198 tls12_prf->left_in_block -= length;
5199 }
5200
5201 return( PSA_SUCCESS );
5202}
Gilles Peskinebef7f142018-07-12 17:22:21 +02005203#endif /* MBEDTLS_MD_C */
5204
Janos Follath6c6c8fc2019-06-17 12:38:20 +01005205psa_status_t psa_key_derivation_output_bytes(
5206 psa_key_derivation_operation_t *operation,
5207 uint8_t *output,
5208 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005209{
5210 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005211 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005212
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005213 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005214 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005215 /* This is a blank operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02005216 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005217 }
5218
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005219 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005220 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005221 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005222 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005223 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02005224 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005225 goto exit;
5226 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005227 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005228 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005229 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005230 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02005231 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
5232 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005233 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02005234 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02005235 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005236 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005237 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005238
Gilles Peskinebef7f142018-07-12 17:22:21 +02005239#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005240 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02005241 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01005242 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005243 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02005244 output, output_length );
5245 }
Janos Follathadbec812019-06-14 11:05:39 +01005246 else
Janos Follathadbec812019-06-14 11:05:39 +01005247 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine969c5d62019-01-16 15:53:06 +01005248 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005249 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005250 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005251 kdf_alg, output,
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005252 output_length );
5253 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005254 else
5255#endif /* MBEDTLS_MD_C */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005256 {
5257 return( PSA_ERROR_BAD_STATE );
5258 }
5259
5260exit:
5261 if( status != PSA_SUCCESS )
5262 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005263 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005264 * This allows us to differentiate between exhausted operations and
5265 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
5266 * operations. */
5267 psa_algorithm_t alg = operation->alg;
5268 psa_key_derivation_abort( operation );
5269 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005270 memset( output, '!', output_length );
5271 }
5272 return( status );
5273}
5274
Gilles Peskine08542d82018-07-19 17:05:42 +02005275#if defined(MBEDTLS_DES_C)
5276static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
5277{
5278 if( data_size >= 8 )
5279 mbedtls_des_key_set_parity( data );
5280 if( data_size >= 16 )
5281 mbedtls_des_key_set_parity( data + 8 );
5282 if( data_size >= 24 )
5283 mbedtls_des_key_set_parity( data + 16 );
5284}
5285#endif /* MBEDTLS_DES_C */
5286
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005287static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005288 psa_key_slot_t *slot,
5289 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005290 psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005291{
5292 uint8_t *data = NULL;
5293 size_t bytes = PSA_BITS_TO_BYTES( bits );
5294 psa_status_t status;
5295
Gilles Peskine8e338702019-07-30 20:06:31 +02005296 if( ! key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005297 return( PSA_ERROR_INVALID_ARGUMENT );
5298 if( bits % 8 != 0 )
5299 return( PSA_ERROR_INVALID_ARGUMENT );
5300 data = mbedtls_calloc( 1, bytes );
5301 if( data == NULL )
5302 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5303
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005304 status = psa_key_derivation_output_bytes( operation, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005305 if( status != PSA_SUCCESS )
5306 goto exit;
Gilles Peskine08542d82018-07-19 17:05:42 +02005307#if defined(MBEDTLS_DES_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02005308 if( slot->attr.type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02005309 psa_des_set_key_parity( data, bytes );
5310#endif /* MBEDTLS_DES_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005311 status = psa_import_key_into_slot( slot, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005312
5313exit:
5314 mbedtls_free( data );
5315 return( status );
5316}
5317
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005318psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005319 psa_key_derivation_operation_t *operation,
Gilles Peskine98dd7792019-05-15 19:43:49 +02005320 psa_key_handle_t *handle )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005321{
5322 psa_status_t status;
5323 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005324 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02005325
5326 /* Reject any attempt to create a zero-length key so that we don't
5327 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
5328 if( psa_get_key_bits( attributes ) == 0 )
5329 return( PSA_ERROR_INVALID_ARGUMENT );
5330
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005331 if( ! operation->can_output_key )
5332 return( PSA_ERROR_NOT_PERMITTED );
5333
Gilles Peskinedf179142019-07-15 22:02:14 +02005334 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE,
5335 attributes, handle, &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02005336#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
5337 if( driver != NULL )
5338 {
5339 /* Deriving a key in a secure element is not implemented yet. */
5340 status = PSA_ERROR_NOT_SUPPORTED;
5341 }
5342#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005343 if( status == PSA_SUCCESS )
5344 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005345 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02005346 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005347 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005348 }
5349 if( status == PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02005350 status = psa_finish_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005351 if( status != PSA_SUCCESS )
5352 {
Gilles Peskine011e4282019-06-26 18:34:38 +02005353 psa_fail_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005354 *handle = 0;
5355 }
5356 return( status );
5357}
5358
Gilles Peskineeab56e42018-07-12 17:12:33 +02005359
5360
5361/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02005362/* Key derivation */
5363/****************************************************************/
5364
Gilles Peskine969c5d62019-01-16 15:53:06 +01005365static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005366 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005367 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005368{
Janos Follath5fe19732019-06-20 15:09:30 +01005369 /* Make sure that operation->ctx is properly zero-initialised. (Macro
5370 * initialisers for this union leave some bytes unspecified.) */
5371 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
5372
Gilles Peskine969c5d62019-01-16 15:53:06 +01005373 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005374#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005375 if( PSA_ALG_IS_HKDF( kdf_alg ) ||
5376 PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
5377 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005378 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01005379 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005380 size_t hash_size = PSA_HASH_SIZE( hash_alg );
5381 if( hash_size == 0 )
5382 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005383 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
5384 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02005385 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005386 {
5387 return( PSA_ERROR_NOT_SUPPORTED );
5388 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005389 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01005390 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005391 }
5392#endif /* MBEDTLS_MD_C */
Gilles Peskine969c5d62019-01-16 15:53:06 +01005393 else
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005394 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005395}
5396
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005397psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005398 psa_algorithm_t alg )
5399{
5400 psa_status_t status;
5401
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005402 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005403 return( PSA_ERROR_BAD_STATE );
5404
Gilles Peskine6843c292019-01-18 16:44:49 +01005405 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
5406 return( PSA_ERROR_INVALID_ARGUMENT );
5407 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005408 {
5409 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005410 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005411 }
5412 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
5413 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005414 status = psa_key_derivation_setup_kdf( operation, alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005415 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005416 else
5417 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005418
5419 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005420 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01005421 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005422}
5423
5424#if defined(MBEDTLS_MD_C)
Gilles Peskinecbe66502019-05-16 16:59:18 +02005425static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005426 psa_algorithm_t hash_alg,
5427 psa_key_derivation_step_t step,
5428 const uint8_t *data,
5429 size_t data_length )
5430{
5431 psa_status_t status;
5432 switch( step )
5433 {
Gilles Peskine03410b52019-05-16 16:05:19 +02005434 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02005435 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005436 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005437 status = psa_hmac_setup_internal( &hkdf->hmac,
5438 data, data_length,
5439 hash_alg );
5440 if( status != PSA_SUCCESS )
5441 return( status );
5442 hkdf->state = HKDF_STATE_STARTED;
5443 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02005444 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005445 /* If no salt was provided, use an empty salt. */
5446 if( hkdf->state == HKDF_STATE_INIT )
5447 {
5448 status = psa_hmac_setup_internal( &hkdf->hmac,
5449 NULL, 0,
Gilles Peskinef9ee6332019-04-11 21:22:52 +02005450 hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005451 if( status != PSA_SUCCESS )
5452 return( status );
5453 hkdf->state = HKDF_STATE_STARTED;
5454 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02005455 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005456 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005457 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5458 data, data_length );
5459 if( status != PSA_SUCCESS )
5460 return( status );
5461 status = psa_hmac_finish_internal( &hkdf->hmac,
5462 hkdf->prk,
5463 sizeof( hkdf->prk ) );
5464 if( status != PSA_SUCCESS )
5465 return( status );
5466 hkdf->offset_in_block = PSA_HASH_SIZE( hash_alg );
5467 hkdf->block_number = 0;
5468 hkdf->state = HKDF_STATE_KEYED;
5469 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02005470 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005471 if( hkdf->state == HKDF_STATE_OUTPUT )
5472 return( PSA_ERROR_BAD_STATE );
5473 if( hkdf->info_set )
5474 return( PSA_ERROR_BAD_STATE );
5475 hkdf->info_length = data_length;
5476 if( data_length != 0 )
5477 {
5478 hkdf->info = mbedtls_calloc( 1, data_length );
5479 if( hkdf->info == NULL )
5480 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5481 memcpy( hkdf->info, data, data_length );
5482 }
5483 hkdf->info_set = 1;
5484 return( PSA_SUCCESS );
5485 default:
5486 return( PSA_ERROR_INVALID_ARGUMENT );
5487 }
5488}
Janos Follathb03233e2019-06-11 15:30:30 +01005489
Janos Follathf08e2652019-06-13 09:05:41 +01005490static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
5491 const uint8_t *data,
5492 size_t data_length )
5493{
5494 if( prf->state != TLS12_PRF_STATE_INIT )
5495 return( PSA_ERROR_BAD_STATE );
5496
Janos Follathd6dce9f2019-07-04 09:11:38 +01005497 if( data_length != 0 )
5498 {
5499 prf->seed = mbedtls_calloc( 1, data_length );
5500 if( prf->seed == NULL )
5501 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01005502
Janos Follathd6dce9f2019-07-04 09:11:38 +01005503 memcpy( prf->seed, data, data_length );
5504 prf->seed_length = data_length;
5505 }
Janos Follathf08e2652019-06-13 09:05:41 +01005506
5507 prf->state = TLS12_PRF_STATE_SEED_SET;
5508
5509 return( PSA_SUCCESS );
5510}
5511
Janos Follath81550542019-06-13 14:26:34 +01005512static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
5513 psa_algorithm_t hash_alg,
5514 const uint8_t *data,
5515 size_t data_length )
5516{
5517 psa_status_t status;
5518 if( prf->state != TLS12_PRF_STATE_SEED_SET )
5519 return( PSA_ERROR_BAD_STATE );
5520
5521 status = psa_hmac_setup_internal( &prf->hmac, data, data_length, hash_alg );
5522 if( status != PSA_SUCCESS )
5523 return( status );
5524
5525 prf->state = TLS12_PRF_STATE_KEY_SET;
5526
5527 return( PSA_SUCCESS );
5528}
5529
Janos Follath6660f0e2019-06-17 08:44:03 +01005530static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
5531 psa_tls12_prf_key_derivation_t *prf,
5532 psa_algorithm_t hash_alg,
5533 const uint8_t *data,
5534 size_t data_length )
5535{
5536 psa_status_t status;
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02005537 uint8_t pms[ 4 + 2 * PSA_ALG_TLS12_PSK_TO_MS_MAX_PSK_LEN ];
5538 uint8_t *cur = pms;
Janos Follath6660f0e2019-06-17 08:44:03 +01005539
5540 if( data_length > PSA_ALG_TLS12_PSK_TO_MS_MAX_PSK_LEN )
5541 return( PSA_ERROR_INVALID_ARGUMENT );
5542
5543 /* Quoting RFC 4279, Section 2:
5544 *
5545 * The premaster secret is formed as follows: if the PSK is N octets
5546 * long, concatenate a uint16 with the value N, N zero octets, a second
5547 * uint16 with the value N, and the PSK itself.
5548 */
5549
Janos Follath40e13932019-06-26 13:22:29 +01005550 *cur++ = ( data_length >> 8 ) & 0xff;
5551 *cur++ = ( data_length >> 0 ) & 0xff;
5552 memset( cur, 0, data_length );
5553 cur += data_length;
5554 *cur++ = pms[0];
5555 *cur++ = pms[1];
5556 memcpy( cur, data, data_length );
5557 cur += data_length;
Janos Follath6660f0e2019-06-17 08:44:03 +01005558
Janos Follath40e13932019-06-26 13:22:29 +01005559 status = psa_tls12_prf_set_key( prf, hash_alg, pms, cur - pms );
Janos Follath6660f0e2019-06-17 08:44:03 +01005560
5561 mbedtls_platform_zeroize( pms, sizeof( pms ) );
5562 return( status );
5563}
5564
Janos Follath63028dd2019-06-13 09:15:47 +01005565static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
5566 const uint8_t *data,
5567 size_t data_length )
5568{
5569 if( prf->state != TLS12_PRF_STATE_KEY_SET )
5570 return( PSA_ERROR_BAD_STATE );
5571
Janos Follathd6dce9f2019-07-04 09:11:38 +01005572 if( data_length != 0 )
5573 {
5574 prf->label = mbedtls_calloc( 1, data_length );
5575 if( prf->label == NULL )
5576 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01005577
Janos Follathd6dce9f2019-07-04 09:11:38 +01005578 memcpy( prf->label, data, data_length );
5579 prf->label_length = data_length;
5580 }
Janos Follath63028dd2019-06-13 09:15:47 +01005581
5582 prf->state = TLS12_PRF_STATE_LABEL_SET;
5583
5584 return( PSA_SUCCESS );
5585}
5586
Janos Follathb03233e2019-06-11 15:30:30 +01005587static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
5588 psa_algorithm_t hash_alg,
5589 psa_key_derivation_step_t step,
5590 const uint8_t *data,
5591 size_t data_length )
5592{
Janos Follathb03233e2019-06-11 15:30:30 +01005593 switch( step )
5594 {
Janos Follathf08e2652019-06-13 09:05:41 +01005595 case PSA_KEY_DERIVATION_INPUT_SEED:
5596 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01005597 case PSA_KEY_DERIVATION_INPUT_SECRET:
5598 return( psa_tls12_prf_set_key( prf, hash_alg, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01005599 case PSA_KEY_DERIVATION_INPUT_LABEL:
5600 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01005601 default:
5602 return( PSA_ERROR_INVALID_ARGUMENT );
5603 }
5604}
Janos Follath6660f0e2019-06-17 08:44:03 +01005605
5606static psa_status_t psa_tls12_prf_psk_to_ms_input(
5607 psa_tls12_prf_key_derivation_t *prf,
5608 psa_algorithm_t hash_alg,
5609 psa_key_derivation_step_t step,
5610 const uint8_t *data,
5611 size_t data_length )
5612{
5613 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01005614 {
Janos Follath6660f0e2019-06-17 08:44:03 +01005615 return( psa_tls12_prf_psk_to_ms_set_key( prf, hash_alg,
5616 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01005617 }
Janos Follath6660f0e2019-06-17 08:44:03 +01005618
5619 return( psa_tls12_prf_input( prf, hash_alg, step, data, data_length ) );
5620}
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005621#endif /* MBEDTLS_MD_C */
5622
Gilles Peskineb8965192019-09-24 16:21:10 +02005623/** Check whether the given key type is acceptable for the given
5624 * input step of a key derivation.
5625 *
5626 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
5627 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
5628 * Both secret and non-secret inputs can alternatively have the type
5629 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
5630 * that the input was passed as a buffer rather than via a key object.
5631 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02005632static int psa_key_derivation_check_input_type(
5633 psa_key_derivation_step_t step,
5634 psa_key_type_t key_type )
5635{
5636 switch( step )
5637 {
5638 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb8965192019-09-24 16:21:10 +02005639 if( key_type == PSA_KEY_TYPE_DERIVE )
5640 return( PSA_SUCCESS );
5641 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005642 return( PSA_SUCCESS );
5643 break;
5644 case PSA_KEY_DERIVATION_INPUT_LABEL:
5645 case PSA_KEY_DERIVATION_INPUT_SALT:
5646 case PSA_KEY_DERIVATION_INPUT_INFO:
5647 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskineb8965192019-09-24 16:21:10 +02005648 if( key_type == PSA_KEY_TYPE_RAW_DATA )
5649 return( PSA_SUCCESS );
5650 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005651 return( PSA_SUCCESS );
5652 break;
5653 }
5654 return( PSA_ERROR_INVALID_ARGUMENT );
5655}
5656
Janos Follathb80a94e2019-06-12 15:54:46 +01005657static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005658 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005659 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005660 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005661 const uint8_t *data,
5662 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005663{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02005664 psa_status_t status;
5665 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
5666
5667 status = psa_key_derivation_check_input_type( step, key_type );
Gilles Peskine224b0d62019-09-23 18:13:17 +02005668 if( status != PSA_SUCCESS )
5669 goto exit;
5670
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005671#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005672 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005673 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005674 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005675 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005676 step, data, data_length );
5677 }
k-stachowiak012dcc42019-08-13 14:55:03 +02005678 else if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005679 {
Janos Follathb03233e2019-06-11 15:30:30 +01005680 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
5681 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5682 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01005683 }
5684 else if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
5685 {
5686 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
5687 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5688 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005689 }
5690 else
5691#endif /* MBEDTLS_MD_C */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005692 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005693 /* This can't happen unless the operation object was not initialized */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005694 return( PSA_ERROR_BAD_STATE );
5695 }
5696
Gilles Peskine224b0d62019-09-23 18:13:17 +02005697exit:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005698 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005699 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005700 return( status );
5701}
5702
Janos Follath51f4a0f2019-06-14 11:35:55 +01005703psa_status_t psa_key_derivation_input_bytes(
5704 psa_key_derivation_operation_t *operation,
5705 psa_key_derivation_step_t step,
5706 const uint8_t *data,
5707 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005708{
Gilles Peskineb8965192019-09-24 16:21:10 +02005709 return( psa_key_derivation_input_internal( operation, step,
5710 PSA_KEY_TYPE_NONE,
Janos Follathc5621512019-06-14 11:27:57 +01005711 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005712}
5713
Janos Follath51f4a0f2019-06-14 11:35:55 +01005714psa_status_t psa_key_derivation_input_key(
5715 psa_key_derivation_operation_t *operation,
5716 psa_key_derivation_step_t step,
5717 psa_key_handle_t handle )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005718{
5719 psa_key_slot_t *slot;
5720 psa_status_t status;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005721
Gilles Peskine28f8f302019-07-24 13:30:31 +02005722 status = psa_get_transparent_key( handle, &slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02005723 PSA_KEY_USAGE_DERIVE,
5724 operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005725 if( status != PSA_SUCCESS )
Gilles Peskine593773d2019-09-23 18:17:40 +02005726 {
5727 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005728 return( status );
Gilles Peskine593773d2019-09-23 18:17:40 +02005729 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005730
5731 /* Passing a key object as a SECRET input unlocks the permission
5732 * to output to a key object. */
5733 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5734 operation->can_output_key = 1;
5735
Janos Follathb80a94e2019-06-12 15:54:46 +01005736 return( psa_key_derivation_input_internal( operation,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005737 step, slot->attr.type,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02005738 slot->data.key.data,
5739 slot->data.key.bytes ) );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005740}
Gilles Peskineea0fb492018-07-12 17:17:20 +02005741
5742
5743
5744/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02005745/* Key agreement */
5746/****************************************************************/
5747
Gilles Peskinea05219c2018-11-16 16:02:56 +01005748#if defined(MBEDTLS_ECDH_C)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005749static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
5750 size_t peer_key_length,
5751 const mbedtls_ecp_keypair *our_key,
5752 uint8_t *shared_secret,
5753 size_t shared_secret_size,
5754 size_t *shared_secret_length )
5755{
Steven Cooremand4867872020-08-05 16:31:39 +02005756 mbedtls_ecp_keypair *their_key = NULL;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005757 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00005758 psa_status_t status;
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005759 size_t bits = 0;
Paul Elliott8ff510a2020-06-02 17:19:28 +01005760 psa_ecc_family_t curve = mbedtls_ecc_group_to_psa( our_key->grp.id, &bits );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005761 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005762
Steven Cooreman4fed4552020-08-03 14:46:03 +02005763 status = psa_load_ecp_representation( PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve),
5764 peer_key,
Steven Cooreman7f391872020-07-30 14:57:44 +02005765 peer_key_length,
Steven Cooreman7f391872020-07-30 14:57:44 +02005766 &their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00005767 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005768 goto exit;
5769
Jaeden Amero97271b32019-01-10 19:38:51 +00005770 status = mbedtls_to_psa_error(
Steven Cooremana2371e52020-07-28 14:30:39 +02005771 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
Jaeden Amero97271b32019-01-10 19:38:51 +00005772 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005773 goto exit;
Jaeden Amero97271b32019-01-10 19:38:51 +00005774 status = mbedtls_to_psa_error(
5775 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
5776 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005777 goto exit;
5778
Jaeden Amero97271b32019-01-10 19:38:51 +00005779 status = mbedtls_to_psa_error(
5780 mbedtls_ecdh_calc_secret( &ecdh,
5781 shared_secret_length,
5782 shared_secret, shared_secret_size,
5783 mbedtls_ctr_drbg_random,
5784 &global_data.ctr_drbg ) );
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005785 if( status != PSA_SUCCESS )
5786 goto exit;
5787 if( PSA_BITS_TO_BYTES( bits ) != *shared_secret_length )
5788 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005789
5790exit:
Gilles Peskine3e819b72019-12-20 14:09:55 +01005791 if( status != PSA_SUCCESS )
5792 mbedtls_platform_zeroize( shared_secret, shared_secret_size );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005793 mbedtls_ecdh_free( &ecdh );
Steven Cooremana2371e52020-07-28 14:30:39 +02005794 mbedtls_ecp_keypair_free( their_key );
Steven Cooreman6d839f02020-07-30 11:36:45 +02005795 mbedtls_free( their_key );
Steven Cooremana2371e52020-07-28 14:30:39 +02005796
Jaeden Amero97271b32019-01-10 19:38:51 +00005797 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005798}
Gilles Peskinea05219c2018-11-16 16:02:56 +01005799#endif /* MBEDTLS_ECDH_C */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005800
Gilles Peskine01d718c2018-09-18 12:01:02 +02005801#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
5802
Gilles Peskine0216fe12019-04-11 21:23:21 +02005803static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
5804 psa_key_slot_t *private_key,
5805 const uint8_t *peer_key,
5806 size_t peer_key_length,
5807 uint8_t *shared_secret,
5808 size_t shared_secret_size,
5809 size_t *shared_secret_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005810{
Gilles Peskine0216fe12019-04-11 21:23:21 +02005811 switch( alg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005812 {
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005813#if defined(MBEDTLS_ECDH_C)
Gilles Peskine0216fe12019-04-11 21:23:21 +02005814 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02005815 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005816 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremana2371e52020-07-28 14:30:39 +02005817 mbedtls_ecp_keypair *ecp = NULL;
Steven Cooreman7f391872020-07-30 14:57:44 +02005818 psa_status_t status = psa_load_ecp_representation(
Steven Cooreman4fed4552020-08-03 14:46:03 +02005819 private_key->attr.type,
Steven Cooreman7f391872020-07-30 14:57:44 +02005820 private_key->data.key.data,
5821 private_key->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02005822 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02005823 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02005824 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02005825 status = psa_key_agreement_ecdh( peer_key, peer_key_length,
Steven Cooremana2371e52020-07-28 14:30:39 +02005826 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02005827 shared_secret, shared_secret_size,
5828 shared_secret_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02005829 mbedtls_ecp_keypair_free( ecp );
5830 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02005831 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005832#endif /* MBEDTLS_ECDH_C */
Gilles Peskine01d718c2018-09-18 12:01:02 +02005833 default:
Gilles Peskine93f85002018-11-16 16:43:31 +01005834 (void) private_key;
5835 (void) peer_key;
5836 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02005837 (void) shared_secret;
5838 (void) shared_secret_size;
5839 (void) shared_secret_length;
Gilles Peskine01d718c2018-09-18 12:01:02 +02005840 return( PSA_ERROR_NOT_SUPPORTED );
5841 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02005842}
5843
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005844/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02005845 * to potentially free embedded data structures and wipe confidential data.
5846 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005847static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005848 psa_key_derivation_step_t step,
Gilles Peskine01d718c2018-09-18 12:01:02 +02005849 psa_key_slot_t *private_key,
5850 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005851 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005852{
5853 psa_status_t status;
5854 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
5855 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005856 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005857
5858 /* Step 1: run the secret agreement algorithm to generate the shared
5859 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02005860 status = psa_key_agreement_raw_internal( ka_alg,
5861 private_key,
5862 peer_key, peer_key_length,
itayzafrir0adf0fc2018-09-06 16:24:41 +03005863 shared_secret,
5864 sizeof( shared_secret ),
Gilles Peskine05d69892018-06-19 22:00:52 +02005865 &shared_secret_length );
Gilles Peskine53d991e2018-07-12 01:14:59 +02005866 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005867 goto exit;
5868
Gilles Peskineb0b255c2018-07-06 17:01:38 +02005869 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02005870 * the shared secret. A shared secret is permitted wherever a key
5871 * of type DERIVE is permitted. */
Janos Follathb80a94e2019-06-12 15:54:46 +01005872 status = psa_key_derivation_input_internal( operation, step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005873 PSA_KEY_TYPE_DERIVE,
Janos Follathb80a94e2019-06-12 15:54:46 +01005874 shared_secret,
5875 shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005876exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01005877 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005878 return( status );
5879}
5880
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005881psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005882 psa_key_derivation_step_t step,
5883 psa_key_handle_t private_key,
5884 const uint8_t *peer_key,
5885 size_t peer_key_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005886{
Gilles Peskine2f060a82018-12-04 17:12:32 +01005887 psa_key_slot_t *slot;
Gilles Peskine08542d82018-07-19 17:05:42 +02005888 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005889 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005890 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine28f8f302019-07-24 13:30:31 +02005891 status = psa_get_transparent_key( private_key, &slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02005892 PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005893 if( status != PSA_SUCCESS )
5894 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005895 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01005896 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005897 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01005898 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005899 psa_key_derivation_abort( operation );
Steven Cooremanfa5e6312020-10-15 17:07:12 +02005900 else
5901 {
5902 /* If a private key has been added as SECRET, we allow the derived
5903 * key material to be used as a key in PSA Crypto. */
5904 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5905 operation->can_output_key = 1;
5906 }
Gilles Peskine346797d2018-11-16 16:05:06 +01005907 return( status );
Gilles Peskineaf3baab2018-06-27 22:55:52 +02005908}
5909
Gilles Peskinebe697d82019-05-16 18:00:41 +02005910psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
5911 psa_key_handle_t private_key,
5912 const uint8_t *peer_key,
5913 size_t peer_key_length,
5914 uint8_t *output,
5915 size_t output_size,
5916 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02005917{
5918 psa_key_slot_t *slot;
5919 psa_status_t status;
5920
5921 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
5922 {
5923 status = PSA_ERROR_INVALID_ARGUMENT;
5924 goto exit;
5925 }
Gilles Peskine28f8f302019-07-24 13:30:31 +02005926 status = psa_get_transparent_key( private_key, &slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02005927 PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02005928 if( status != PSA_SUCCESS )
5929 goto exit;
5930
5931 status = psa_key_agreement_raw_internal( alg, slot,
5932 peer_key, peer_key_length,
5933 output, output_size,
5934 output_length );
5935
5936exit:
5937 if( status != PSA_SUCCESS )
5938 {
5939 /* If an error happens and is not handled properly, the output
5940 * may be used as a key to protect sensitive data. Arrange for such
5941 * a key to be random, which is likely to result in decryption or
5942 * verification errors. This is better than filling the buffer with
5943 * some constant data such as zeros, which would result in the data
5944 * being protected with a reproducible, easily knowable key.
5945 */
5946 psa_generate_random( output, output_size );
5947 *output_length = output_size;
5948 }
5949 return( status );
5950}
Gilles Peskine86a440b2018-11-12 18:39:40 +01005951
5952
5953/****************************************************************/
5954/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02005955/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02005956
Gilles Peskine4c317f42018-07-12 01:24:09 +02005957psa_status_t psa_generate_random( uint8_t *output,
Gilles Peskine53d991e2018-07-12 01:14:59 +02005958 size_t output_size )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005959{
Janos Follath24eed8d2019-11-22 13:21:35 +00005960 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005961 GUARD_MODULE_INITIALIZED;
5962
Gilles Peskinef181eca2019-08-07 13:49:00 +02005963 while( output_size > MBEDTLS_CTR_DRBG_MAX_REQUEST )
5964 {
5965 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg,
5966 output,
5967 MBEDTLS_CTR_DRBG_MAX_REQUEST );
5968 if( ret != 0 )
5969 return( mbedtls_to_psa_error( ret ) );
5970 output += MBEDTLS_CTR_DRBG_MAX_REQUEST;
5971 output_size -= MBEDTLS_CTR_DRBG_MAX_REQUEST;
5972 }
5973
Gilles Peskinee59236f2018-01-27 23:32:46 +01005974 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg, output, output_size );
5975 return( mbedtls_to_psa_error( ret ) );
5976}
5977
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005978#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
5979#include "mbedtls/entropy_poll.h"
5980
Gilles Peskine7228da22019-07-15 11:06:15 +02005981psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005982 size_t seed_size )
5983{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005984 if( global_data.initialized )
5985 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02005986
5987 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
5988 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
5989 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
5990 return( PSA_ERROR_INVALID_ARGUMENT );
5991
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005992 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005993}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005994#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005995
Gilles Peskinee56e8782019-04-26 17:34:02 +02005996#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_GENPRIME)
5997static psa_status_t psa_read_rsa_exponent( const uint8_t *domain_parameters,
5998 size_t domain_parameters_size,
5999 int *exponent )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006000{
Gilles Peskinee56e8782019-04-26 17:34:02 +02006001 size_t i;
6002 uint32_t acc = 0;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006003
Gilles Peskinee56e8782019-04-26 17:34:02 +02006004 if( domain_parameters_size == 0 )
6005 {
6006 *exponent = 65537;
6007 return( PSA_SUCCESS );
6008 }
6009
6010 /* Mbed TLS encodes the public exponent as an int. For simplicity, only
6011 * support values that fit in a 32-bit integer, which is larger than
6012 * int on just about every platform anyway. */
6013 if( domain_parameters_size > sizeof( acc ) )
6014 return( PSA_ERROR_NOT_SUPPORTED );
6015 for( i = 0; i < domain_parameters_size; i++ )
6016 acc = ( acc << 8 ) | domain_parameters[i];
6017 if( acc > INT_MAX )
6018 return( PSA_ERROR_NOT_SUPPORTED );
6019 *exponent = acc;
6020 return( PSA_SUCCESS );
6021}
6022#endif /* MBEDTLS_RSA_C && MBEDTLS_GENPRIME */
6023
Gilles Peskine35ef36b2019-05-16 19:42:05 +02006024static psa_status_t psa_generate_key_internal(
Gilles Peskinee56e8782019-04-26 17:34:02 +02006025 psa_key_slot_t *slot, size_t bits,
6026 const uint8_t *domain_parameters, size_t domain_parameters_size )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006027{
Gilles Peskine8e338702019-07-30 20:06:31 +02006028 psa_key_type_t type = slot->attr.type;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006029
Gilles Peskinee56e8782019-04-26 17:34:02 +02006030 if( domain_parameters == NULL && domain_parameters_size != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006031 return( PSA_ERROR_INVALID_ARGUMENT );
6032
Gilles Peskinee59236f2018-01-27 23:32:46 +01006033 if( key_type_is_raw_bytes( type ) )
6034 {
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006035 psa_status_t status;
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006036
6037 status = validate_unstructured_key_bit_size( slot->attr.type, bits );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006038 if( status != PSA_SUCCESS )
6039 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006040
6041 /* Allocate memory for the key */
Steven Cooreman75b74362020-07-28 14:30:13 +02006042 status = psa_allocate_buffer_to_slot( slot, PSA_BITS_TO_BYTES( bits ) );
6043 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02006044 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006045
Steven Cooreman71fd80d2020-07-07 21:12:27 +02006046 status = psa_generate_random( slot->data.key.data,
6047 slot->data.key.bytes );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006048 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006049 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006050
6051 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006052#if defined(MBEDTLS_DES_C)
6053 if( type == PSA_KEY_TYPE_DES )
Steven Cooreman71fd80d2020-07-07 21:12:27 +02006054 psa_des_set_key_parity( slot->data.key.data,
6055 slot->data.key.bytes );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006056#endif /* MBEDTLS_DES_C */
6057 }
6058 else
6059
6060#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_GENPRIME)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02006061 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006062 {
Steven Cooremana01795d2020-07-24 22:48:15 +02006063 mbedtls_rsa_context rsa;
Janos Follath24eed8d2019-11-22 13:21:35 +00006064 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee56e8782019-04-26 17:34:02 +02006065 int exponent;
6066 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006067 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
6068 return( PSA_ERROR_NOT_SUPPORTED );
6069 /* Accept only byte-aligned keys, for the same reasons as
6070 * in psa_import_rsa_key(). */
6071 if( bits % 8 != 0 )
6072 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinee56e8782019-04-26 17:34:02 +02006073 status = psa_read_rsa_exponent( domain_parameters,
6074 domain_parameters_size,
6075 &exponent );
6076 if( status != PSA_SUCCESS )
6077 return( status );
Steven Cooremana01795d2020-07-24 22:48:15 +02006078 mbedtls_rsa_init( &rsa, MBEDTLS_RSA_PKCS_V15, MBEDTLS_MD_NONE );
6079 ret = mbedtls_rsa_gen_key( &rsa,
Gilles Peskinee59236f2018-01-27 23:32:46 +01006080 mbedtls_ctr_drbg_random,
6081 &global_data.ctr_drbg,
6082 (unsigned int) bits,
6083 exponent );
6084 if( ret != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006085 return( mbedtls_to_psa_error( ret ) );
Steven Cooremana01795d2020-07-24 22:48:15 +02006086
6087 /* Make sure to always have an export representation available */
6088 size_t bytes = PSA_KEY_EXPORT_RSA_KEY_PAIR_MAX_SIZE( bits );
6089
Steven Cooreman75b74362020-07-28 14:30:13 +02006090 status = psa_allocate_buffer_to_slot( slot, bytes );
6091 if( status != PSA_SUCCESS )
Steven Cooremana01795d2020-07-24 22:48:15 +02006092 {
6093 mbedtls_rsa_free( &rsa );
Steven Cooreman29149862020-08-05 15:43:42 +02006094 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006095 }
Steven Cooremana01795d2020-07-24 22:48:15 +02006096
6097 status = psa_export_rsa_key( type,
6098 &rsa,
6099 slot->data.key.data,
6100 bytes,
6101 &slot->data.key.bytes );
6102 mbedtls_rsa_free( &rsa );
6103 if( status != PSA_SUCCESS )
Steven Cooremana01795d2020-07-24 22:48:15 +02006104 psa_remove_key_data_from_memory( slot );
Steven Cooreman560c28a2020-07-24 23:20:24 +02006105 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006106 }
6107 else
6108#endif /* MBEDTLS_RSA_C && MBEDTLS_GENPRIME */
6109
6110#if defined(MBEDTLS_ECP_C)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02006111 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006112 {
Paul Elliott8ff510a2020-06-02 17:19:28 +01006113 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY( type );
Gilles Peskine4295e8b2019-12-02 21:39:10 +01006114 mbedtls_ecp_group_id grp_id =
6115 mbedtls_ecc_group_of_psa( curve, PSA_BITS_TO_BYTES( bits ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006116 const mbedtls_ecp_curve_info *curve_info =
6117 mbedtls_ecp_curve_info_from_grp_id( grp_id );
Steven Cooremanacda8342020-07-24 23:09:52 +02006118 mbedtls_ecp_keypair ecp;
Janos Follath24eed8d2019-11-22 13:21:35 +00006119 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee56e8782019-04-26 17:34:02 +02006120 if( domain_parameters_size != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006121 return( PSA_ERROR_NOT_SUPPORTED );
6122 if( grp_id == MBEDTLS_ECP_DP_NONE || curve_info == NULL )
6123 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooremanacda8342020-07-24 23:09:52 +02006124 mbedtls_ecp_keypair_init( &ecp );
6125 ret = mbedtls_ecp_gen_key( grp_id, &ecp,
Gilles Peskinee59236f2018-01-27 23:32:46 +01006126 mbedtls_ctr_drbg_random,
6127 &global_data.ctr_drbg );
6128 if( ret != 0 )
6129 {
Steven Cooremanacda8342020-07-24 23:09:52 +02006130 mbedtls_ecp_keypair_free( &ecp );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006131 return( mbedtls_to_psa_error( ret ) );
6132 }
Steven Cooremanacda8342020-07-24 23:09:52 +02006133
6134
6135 /* Make sure to always have an export representation available */
6136 size_t bytes = PSA_BITS_TO_BYTES( bits );
Steven Cooreman75b74362020-07-28 14:30:13 +02006137 psa_status_t status = psa_allocate_buffer_to_slot( slot, bytes );
6138 if( status != PSA_SUCCESS )
Steven Cooremanacda8342020-07-24 23:09:52 +02006139 {
6140 mbedtls_ecp_keypair_free( &ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02006141 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02006142 }
Steven Cooreman75b74362020-07-28 14:30:13 +02006143
6144 status = mbedtls_to_psa_error(
Steven Cooremanacda8342020-07-24 23:09:52 +02006145 mbedtls_ecp_write_key( &ecp, slot->data.key.data, bytes ) );
6146
6147 mbedtls_ecp_keypair_free( &ecp );
Steven Cooremanb7f6dea2020-08-05 16:07:20 +02006148 if( status != PSA_SUCCESS ) {
6149 memset( slot->data.key.data, 0, bytes );
Steven Cooremanacda8342020-07-24 23:09:52 +02006150 psa_remove_key_data_from_memory( slot );
Steven Cooremanb7f6dea2020-08-05 16:07:20 +02006151 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02006152 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006153 }
6154 else
6155#endif /* MBEDTLS_ECP_C */
Steven Cooreman29149862020-08-05 15:43:42 +02006156 {
Gilles Peskinee59236f2018-01-27 23:32:46 +01006157 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman29149862020-08-05 15:43:42 +02006158 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01006159
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006160 return( PSA_SUCCESS );
6161}
Darryl Green0c6575a2018-11-07 16:05:30 +00006162
Gilles Peskine35ef36b2019-05-16 19:42:05 +02006163psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Gilles Peskinee56e8782019-04-26 17:34:02 +02006164 psa_key_handle_t *handle )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006165{
6166 psa_status_t status;
6167 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02006168 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine11792082019-08-06 18:36:36 +02006169
Gilles Peskine0f84d622019-09-12 19:03:13 +02006170 /* Reject any attempt to create a zero-length key so that we don't
6171 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
6172 if( psa_get_key_bits( attributes ) == 0 )
6173 return( PSA_ERROR_INVALID_ARGUMENT );
6174
Gilles Peskinedf179142019-07-15 22:02:14 +02006175 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE,
6176 attributes, handle, &slot, &driver );
Gilles Peskine11792082019-08-06 18:36:36 +02006177 if( status != PSA_SUCCESS )
6178 goto exit;
6179
Steven Cooreman2a1664c2020-07-20 15:33:08 +02006180 status = psa_driver_wrapper_generate_key( attributes,
6181 slot );
6182 if( status != PSA_ERROR_NOT_SUPPORTED ||
6183 psa_key_lifetime_is_external( attributes->core.lifetime ) )
6184 goto exit;
6185
6186 status = psa_generate_key_internal(
6187 slot, attributes->core.bits,
6188 attributes->domain_parameters, attributes->domain_parameters_size );
Gilles Peskine11792082019-08-06 18:36:36 +02006189
6190exit:
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006191 if( status == PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02006192 status = psa_finish_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006193 if( status != PSA_SUCCESS )
6194 {
Gilles Peskine011e4282019-06-26 18:34:38 +02006195 psa_fail_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006196 *handle = 0;
6197 }
Darryl Green0c6575a2018-11-07 16:05:30 +00006198 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006199}
6200
6201
Gilles Peskinee59236f2018-01-27 23:32:46 +01006202
6203/****************************************************************/
6204/* Module setup */
6205/****************************************************************/
6206
Gilles Peskine5e769522018-11-20 21:59:56 +01006207psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
6208 void (* entropy_init )( mbedtls_entropy_context *ctx ),
6209 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
6210{
6211 if( global_data.rng_state != RNG_NOT_INITIALIZED )
6212 return( PSA_ERROR_BAD_STATE );
6213 global_data.entropy_init = entropy_init;
6214 global_data.entropy_free = entropy_free;
6215 return( PSA_SUCCESS );
6216}
6217
Gilles Peskinee59236f2018-01-27 23:32:46 +01006218void mbedtls_psa_crypto_free( void )
6219{
Gilles Peskine66fb1262018-12-10 16:29:04 +01006220 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006221 if( global_data.rng_state != RNG_NOT_INITIALIZED )
6222 {
6223 mbedtls_ctr_drbg_free( &global_data.ctr_drbg );
Gilles Peskine5e769522018-11-20 21:59:56 +01006224 global_data.entropy_free( &global_data.entropy );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006225 }
6226 /* Wipe all remaining data, including configuration.
6227 * In particular, this sets all state indicator to the value
6228 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01006229 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Gilles Peskinea8ade162019-06-26 11:24:49 +02006230#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +02006231 /* Unregister all secure element drivers, so that we restart from
6232 * a pristine state. */
6233 psa_unregister_all_se_drivers( );
Gilles Peskinea8ade162019-06-26 11:24:49 +02006234#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006235}
6236
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006237#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
6238/** Recover a transaction that was interrupted by a power failure.
6239 *
6240 * This function is called during initialization, before psa_crypto_init()
6241 * returns. If this function returns a failure status, the initialization
6242 * fails.
6243 */
6244static psa_status_t psa_crypto_recover_transaction(
6245 const psa_crypto_transaction_t *transaction )
6246{
6247 switch( transaction->unknown.type )
6248 {
6249 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
6250 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01006251 /* TODO - fall through to the failure case until this
Gilles Peskinec9d7f942019-08-13 16:17:16 +02006252 * is implemented.
6253 * https://github.com/ARMmbed/mbed-crypto/issues/218
6254 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006255 default:
6256 /* We found an unsupported transaction in the storage.
6257 * We don't know what state the storage is in. Give up. */
6258 return( PSA_ERROR_STORAGE_FAILURE );
6259 }
6260}
6261#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
6262
Gilles Peskinee59236f2018-01-27 23:32:46 +01006263psa_status_t psa_crypto_init( void )
6264{
Gilles Peskine66fb1262018-12-10 16:29:04 +01006265 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006266 const unsigned char drbg_seed[] = "PSA";
6267
Gilles Peskinec6b69072018-11-20 21:42:52 +01006268 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006269 if( global_data.initialized != 0 )
6270 return( PSA_SUCCESS );
6271
Gilles Peskine5e769522018-11-20 21:59:56 +01006272 /* Set default configuration if
6273 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
6274 if( global_data.entropy_init == NULL )
6275 global_data.entropy_init = mbedtls_entropy_init;
6276 if( global_data.entropy_free == NULL )
6277 global_data.entropy_free = mbedtls_entropy_free;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006278
Gilles Peskinec6b69072018-11-20 21:42:52 +01006279 /* Initialize the random generator. */
Gilles Peskine5e769522018-11-20 21:59:56 +01006280 global_data.entropy_init( &global_data.entropy );
Jaeden Amero76541612019-06-04 17:14:43 +01006281#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
6282 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
6283 /* The PSA entropy injection feature depends on using NV seed as an entropy
6284 * source. Add NV seed as an entropy source for PSA entropy injection. */
6285 mbedtls_entropy_add_source( &global_data.entropy,
6286 mbedtls_nv_seed_poll, NULL,
6287 MBEDTLS_ENTROPY_BLOCK_SIZE,
6288 MBEDTLS_ENTROPY_SOURCE_STRONG );
6289#endif
Gilles Peskinee59236f2018-01-27 23:32:46 +01006290 mbedtls_ctr_drbg_init( &global_data.ctr_drbg );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006291 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine66fb1262018-12-10 16:29:04 +01006292 status = mbedtls_to_psa_error(
6293 mbedtls_ctr_drbg_seed( &global_data.ctr_drbg,
6294 mbedtls_entropy_func,
6295 &global_data.entropy,
6296 drbg_seed, sizeof( drbg_seed ) - 1 ) );
6297 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006298 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01006299 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006300
Gilles Peskine66fb1262018-12-10 16:29:04 +01006301 status = psa_initialize_key_slots( );
6302 if( status != PSA_SUCCESS )
6303 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01006304
Gilles Peskined9348f22019-10-01 15:22:29 +02006305#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
6306 status = psa_init_all_se_drivers( );
6307 if( status != PSA_SUCCESS )
6308 goto exit;
6309#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
6310
Gilles Peskine4b734222019-07-24 15:56:31 +02006311#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02006312 status = psa_crypto_load_transaction( );
6313 if( status == PSA_SUCCESS )
6314 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006315 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
6316 if( status != PSA_SUCCESS )
6317 goto exit;
6318 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02006319 }
6320 else if( status == PSA_ERROR_DOES_NOT_EXIST )
6321 {
6322 /* There's no transaction to complete. It's all good. */
6323 status = PSA_SUCCESS;
6324 }
Gilles Peskine4b734222019-07-24 15:56:31 +02006325#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02006326
Gilles Peskinec6b69072018-11-20 21:42:52 +01006327 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006328 global_data.initialized = 1;
6329
6330exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01006331 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006332 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01006333 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006334}
6335
6336#endif /* MBEDTLS_PSA_CRYPTO_C */