blob: ad6f052af0e21cc696609ef6f56355463d34bceb [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:
202 return( PSA_ERROR_BAD_STATE );
203 case MBEDTLS_ERR_CIPHER_AUTH_FAILED:
204 return( PSA_ERROR_INVALID_SIGNATURE );
205 case MBEDTLS_ERR_CIPHER_INVALID_CONTEXT:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200206 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100207 case MBEDTLS_ERR_CIPHER_HW_ACCEL_FAILED:
208 return( PSA_ERROR_HARDWARE_FAILURE );
209
210 case MBEDTLS_ERR_CMAC_HW_ACCEL_FAILED:
211 return( PSA_ERROR_HARDWARE_FAILURE );
212
213 case MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED:
214 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
215 case MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG:
216 case MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG:
217 return( PSA_ERROR_NOT_SUPPORTED );
218 case MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR:
219 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
220
221 case MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH:
222 return( PSA_ERROR_NOT_SUPPORTED );
223 case MBEDTLS_ERR_DES_HW_ACCEL_FAILED:
224 return( PSA_ERROR_HARDWARE_FAILURE );
225
Gilles Peskinee59236f2018-01-27 23:32:46 +0100226 case MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED:
227 case MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE:
228 case MBEDTLS_ERR_ENTROPY_SOURCE_FAILED:
229 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskinea5905292018-02-07 20:59:33 +0100230
231 case MBEDTLS_ERR_GCM_AUTH_FAILED:
232 return( PSA_ERROR_INVALID_SIGNATURE );
233 case MBEDTLS_ERR_GCM_BAD_INPUT:
Gilles Peskine8cac2e62018-08-21 15:07:38 +0200234 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100235 case MBEDTLS_ERR_GCM_HW_ACCEL_FAILED:
236 return( PSA_ERROR_HARDWARE_FAILURE );
237
238 case MBEDTLS_ERR_MD2_HW_ACCEL_FAILED:
239 case MBEDTLS_ERR_MD4_HW_ACCEL_FAILED:
240 case MBEDTLS_ERR_MD5_HW_ACCEL_FAILED:
241 return( PSA_ERROR_HARDWARE_FAILURE );
242
243 case MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE:
244 return( PSA_ERROR_NOT_SUPPORTED );
245 case MBEDTLS_ERR_MD_BAD_INPUT_DATA:
246 return( PSA_ERROR_INVALID_ARGUMENT );
247 case MBEDTLS_ERR_MD_ALLOC_FAILED:
248 return( PSA_ERROR_INSUFFICIENT_MEMORY );
249 case MBEDTLS_ERR_MD_FILE_IO_ERROR:
250 return( PSA_ERROR_STORAGE_FAILURE );
251 case MBEDTLS_ERR_MD_HW_ACCEL_FAILED:
252 return( PSA_ERROR_HARDWARE_FAILURE );
253
Gilles Peskinef76aa772018-10-29 19:24:33 +0100254 case MBEDTLS_ERR_MPI_FILE_IO_ERROR:
255 return( PSA_ERROR_STORAGE_FAILURE );
256 case MBEDTLS_ERR_MPI_BAD_INPUT_DATA:
257 return( PSA_ERROR_INVALID_ARGUMENT );
258 case MBEDTLS_ERR_MPI_INVALID_CHARACTER:
259 return( PSA_ERROR_INVALID_ARGUMENT );
260 case MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL:
261 return( PSA_ERROR_BUFFER_TOO_SMALL );
262 case MBEDTLS_ERR_MPI_NEGATIVE_VALUE:
263 return( PSA_ERROR_INVALID_ARGUMENT );
264 case MBEDTLS_ERR_MPI_DIVISION_BY_ZERO:
265 return( PSA_ERROR_INVALID_ARGUMENT );
266 case MBEDTLS_ERR_MPI_NOT_ACCEPTABLE:
267 return( PSA_ERROR_INVALID_ARGUMENT );
268 case MBEDTLS_ERR_MPI_ALLOC_FAILED:
269 return( PSA_ERROR_INSUFFICIENT_MEMORY );
270
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100271 case MBEDTLS_ERR_PK_ALLOC_FAILED:
272 return( PSA_ERROR_INSUFFICIENT_MEMORY );
273 case MBEDTLS_ERR_PK_TYPE_MISMATCH:
274 case MBEDTLS_ERR_PK_BAD_INPUT_DATA:
275 return( PSA_ERROR_INVALID_ARGUMENT );
276 case MBEDTLS_ERR_PK_FILE_IO_ERROR:
Gilles Peskinea5905292018-02-07 20:59:33 +0100277 return( PSA_ERROR_STORAGE_FAILURE );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100278 case MBEDTLS_ERR_PK_KEY_INVALID_VERSION:
279 case MBEDTLS_ERR_PK_KEY_INVALID_FORMAT:
280 return( PSA_ERROR_INVALID_ARGUMENT );
281 case MBEDTLS_ERR_PK_UNKNOWN_PK_ALG:
282 return( PSA_ERROR_NOT_SUPPORTED );
283 case MBEDTLS_ERR_PK_PASSWORD_REQUIRED:
284 case MBEDTLS_ERR_PK_PASSWORD_MISMATCH:
285 return( PSA_ERROR_NOT_PERMITTED );
286 case MBEDTLS_ERR_PK_INVALID_PUBKEY:
287 return( PSA_ERROR_INVALID_ARGUMENT );
288 case MBEDTLS_ERR_PK_INVALID_ALG:
289 case MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE:
290 case MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE:
291 return( PSA_ERROR_NOT_SUPPORTED );
292 case MBEDTLS_ERR_PK_SIG_LEN_MISMATCH:
293 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskinea5905292018-02-07 20:59:33 +0100294 case MBEDTLS_ERR_PK_HW_ACCEL_FAILED:
295 return( PSA_ERROR_HARDWARE_FAILURE );
296
Gilles Peskineff2d2002019-05-06 15:26:23 +0200297 case MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED:
298 return( PSA_ERROR_HARDWARE_FAILURE );
299 case MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED:
300 return( PSA_ERROR_NOT_SUPPORTED );
301
Gilles Peskinea5905292018-02-07 20:59:33 +0100302 case MBEDTLS_ERR_RIPEMD160_HW_ACCEL_FAILED:
303 return( PSA_ERROR_HARDWARE_FAILURE );
304
305 case MBEDTLS_ERR_RSA_BAD_INPUT_DATA:
306 return( PSA_ERROR_INVALID_ARGUMENT );
307 case MBEDTLS_ERR_RSA_INVALID_PADDING:
308 return( PSA_ERROR_INVALID_PADDING );
309 case MBEDTLS_ERR_RSA_KEY_GEN_FAILED:
310 return( PSA_ERROR_HARDWARE_FAILURE );
311 case MBEDTLS_ERR_RSA_KEY_CHECK_FAILED:
312 return( PSA_ERROR_INVALID_ARGUMENT );
313 case MBEDTLS_ERR_RSA_PUBLIC_FAILED:
314 case MBEDTLS_ERR_RSA_PRIVATE_FAILED:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200315 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100316 case MBEDTLS_ERR_RSA_VERIFY_FAILED:
317 return( PSA_ERROR_INVALID_SIGNATURE );
318 case MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE:
319 return( PSA_ERROR_BUFFER_TOO_SMALL );
320 case MBEDTLS_ERR_RSA_RNG_FAILED:
321 return( PSA_ERROR_INSUFFICIENT_MEMORY );
322 case MBEDTLS_ERR_RSA_UNSUPPORTED_OPERATION:
323 return( PSA_ERROR_NOT_SUPPORTED );
324 case MBEDTLS_ERR_RSA_HW_ACCEL_FAILED:
325 return( PSA_ERROR_HARDWARE_FAILURE );
326
327 case MBEDTLS_ERR_SHA1_HW_ACCEL_FAILED:
328 case MBEDTLS_ERR_SHA256_HW_ACCEL_FAILED:
329 case MBEDTLS_ERR_SHA512_HW_ACCEL_FAILED:
330 return( PSA_ERROR_HARDWARE_FAILURE );
331
332 case MBEDTLS_ERR_XTEA_INVALID_INPUT_LENGTH:
333 return( PSA_ERROR_INVALID_ARGUMENT );
334 case MBEDTLS_ERR_XTEA_HW_ACCEL_FAILED:
335 return( PSA_ERROR_HARDWARE_FAILURE );
336
itayzafrir5c753392018-05-08 11:18:38 +0300337 case MBEDTLS_ERR_ECP_BAD_INPUT_DATA:
itayzafrir7b30f8b2018-05-09 16:07:36 +0300338 case MBEDTLS_ERR_ECP_INVALID_KEY:
itayzafrir5c753392018-05-08 11:18:38 +0300339 return( PSA_ERROR_INVALID_ARGUMENT );
itayzafrir7b30f8b2018-05-09 16:07:36 +0300340 case MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL:
341 return( PSA_ERROR_BUFFER_TOO_SMALL );
342 case MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE:
343 return( PSA_ERROR_NOT_SUPPORTED );
344 case MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH:
345 case MBEDTLS_ERR_ECP_VERIFY_FAILED:
346 return( PSA_ERROR_INVALID_SIGNATURE );
347 case MBEDTLS_ERR_ECP_ALLOC_FAILED:
348 return( PSA_ERROR_INSUFFICIENT_MEMORY );
349 case MBEDTLS_ERR_ECP_HW_ACCEL_FAILED:
350 return( PSA_ERROR_HARDWARE_FAILURE );
Janos Follatha13b9052019-11-22 12:48:59 +0000351 case MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED:
352 return( PSA_ERROR_CORRUPTION_DETECTED );
itayzafrir5c753392018-05-08 11:18:38 +0300353
Gilles Peskinee59236f2018-01-27 23:32:46 +0100354 default:
David Saadab4ecc272019-02-14 13:48:10 +0200355 return( PSA_ERROR_GENERIC_ERROR );
Gilles Peskinee59236f2018-01-27 23:32:46 +0100356 }
357}
358
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200359
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +0200360
361
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100362/****************************************************************/
363/* Key management */
364/****************************************************************/
365
Gilles Peskine73167e12019-07-12 23:44:37 +0200366#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
367static inline int psa_key_slot_is_external( const psa_key_slot_t *slot )
368{
Gilles Peskine8e338702019-07-30 20:06:31 +0200369 return( psa_key_lifetime_is_external( slot->attr.lifetime ) );
Gilles Peskine73167e12019-07-12 23:44:37 +0200370}
371#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
372
Darryl Green8f8aa8f2018-07-24 15:44:51 +0100373#if defined(MBEDTLS_ECP_C)
Paul Elliott8ff510a2020-06-02 17:19:28 +0100374mbedtls_ecp_group_id mbedtls_ecc_group_of_psa( psa_ecc_family_t curve,
Gilles Peskine5055b232019-12-12 17:49:31 +0100375 size_t byte_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +0200376{
377 switch( curve )
378 {
Paul Elliott8ff510a2020-06-02 17:19:28 +0100379 case PSA_ECC_FAMILY_SECP_R1:
Gilles Peskine228abc52019-12-03 17:24:19 +0100380 switch( byte_length )
381 {
382 case PSA_BITS_TO_BYTES( 192 ):
383 return( MBEDTLS_ECP_DP_SECP192R1 );
384 case PSA_BITS_TO_BYTES( 224 ):
385 return( MBEDTLS_ECP_DP_SECP224R1 );
386 case PSA_BITS_TO_BYTES( 256 ):
387 return( MBEDTLS_ECP_DP_SECP256R1 );
388 case PSA_BITS_TO_BYTES( 384 ):
389 return( MBEDTLS_ECP_DP_SECP384R1 );
390 case PSA_BITS_TO_BYTES( 521 ):
391 return( MBEDTLS_ECP_DP_SECP521R1 );
392 default:
393 return( MBEDTLS_ECP_DP_NONE );
394 }
395 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100396
Paul Elliott8ff510a2020-06-02 17:19:28 +0100397 case PSA_ECC_FAMILY_BRAINPOOL_P_R1:
Gilles Peskine228abc52019-12-03 17:24:19 +0100398 switch( byte_length )
399 {
400 case PSA_BITS_TO_BYTES( 256 ):
401 return( MBEDTLS_ECP_DP_BP256R1 );
402 case PSA_BITS_TO_BYTES( 384 ):
403 return( MBEDTLS_ECP_DP_BP384R1 );
404 case PSA_BITS_TO_BYTES( 512 ):
405 return( MBEDTLS_ECP_DP_BP512R1 );
406 default:
407 return( MBEDTLS_ECP_DP_NONE );
408 }
409 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100410
Paul Elliott8ff510a2020-06-02 17:19:28 +0100411 case PSA_ECC_FAMILY_MONTGOMERY:
Gilles Peskine228abc52019-12-03 17:24:19 +0100412 switch( byte_length )
413 {
414 case PSA_BITS_TO_BYTES( 255 ):
415 return( MBEDTLS_ECP_DP_CURVE25519 );
416 case PSA_BITS_TO_BYTES( 448 ):
417 return( MBEDTLS_ECP_DP_CURVE448 );
418 default:
419 return( MBEDTLS_ECP_DP_NONE );
420 }
421 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100422
Paul Elliott8ff510a2020-06-02 17:19:28 +0100423 case PSA_ECC_FAMILY_SECP_K1:
Gilles Peskine228abc52019-12-03 17:24:19 +0100424 switch( byte_length )
425 {
426 case PSA_BITS_TO_BYTES( 192 ):
427 return( MBEDTLS_ECP_DP_SECP192K1 );
428 case PSA_BITS_TO_BYTES( 224 ):
429 return( MBEDTLS_ECP_DP_SECP224K1 );
430 case PSA_BITS_TO_BYTES( 256 ):
431 return( MBEDTLS_ECP_DP_SECP256K1 );
432 default:
433 return( MBEDTLS_ECP_DP_NONE );
434 }
435 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100436
Gilles Peskine12313cd2018-06-20 00:20:32 +0200437 default:
438 return( MBEDTLS_ECP_DP_NONE );
439 }
440}
Darryl Green8f8aa8f2018-07-24 15:44:51 +0100441#endif /* defined(MBEDTLS_ECP_C) */
Gilles Peskine12313cd2018-06-20 00:20:32 +0200442
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200443static psa_status_t validate_unstructured_key_bit_size( psa_key_type_t type,
444 size_t bits )
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200445{
446 /* Check that the bit size is acceptable for the key type */
447 switch( type )
448 {
449 case PSA_KEY_TYPE_RAW_DATA:
450#if defined(MBEDTLS_MD_C)
451 case PSA_KEY_TYPE_HMAC:
Gilles Peskine46f1fd72018-06-28 19:31:31 +0200452#endif
Gilles Peskineea0fb492018-07-12 17:17:20 +0200453 case PSA_KEY_TYPE_DERIVE:
454 break;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200455#if defined(MBEDTLS_AES_C)
456 case PSA_KEY_TYPE_AES:
457 if( bits != 128 && bits != 192 && bits != 256 )
458 return( PSA_ERROR_INVALID_ARGUMENT );
459 break;
460#endif
461#if defined(MBEDTLS_CAMELLIA_C)
462 case PSA_KEY_TYPE_CAMELLIA:
463 if( bits != 128 && bits != 192 && bits != 256 )
464 return( PSA_ERROR_INVALID_ARGUMENT );
465 break;
466#endif
467#if defined(MBEDTLS_DES_C)
468 case PSA_KEY_TYPE_DES:
469 if( bits != 64 && bits != 128 && bits != 192 )
470 return( PSA_ERROR_INVALID_ARGUMENT );
471 break;
472#endif
473#if defined(MBEDTLS_ARC4_C)
474 case PSA_KEY_TYPE_ARC4:
475 if( bits < 8 || bits > 2048 )
476 return( PSA_ERROR_INVALID_ARGUMENT );
477 break;
478#endif
Gilles Peskine26869f22019-05-06 15:25:00 +0200479#if defined(MBEDTLS_CHACHA20_C)
480 case PSA_KEY_TYPE_CHACHA20:
481 if( bits != 256 )
482 return( PSA_ERROR_INVALID_ARGUMENT );
483 break;
484#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200485 default:
486 return( PSA_ERROR_NOT_SUPPORTED );
487 }
Gilles Peskineb54979a2018-06-21 09:32:47 +0200488 if( bits % 8 != 0 )
489 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200490
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200491 return( PSA_SUCCESS );
492}
493
Steven Cooremana01795d2020-07-24 22:48:15 +0200494#if defined(MBEDTLS_RSA_C)
495
496#if defined(MBEDTLS_PK_PARSE_C)
Gilles Peskine86a440b2018-11-12 18:39:40 +0100497/* Mbed TLS doesn't support non-byte-aligned key sizes (i.e. key sizes
498 * that are not a multiple of 8) well. For example, there is only
499 * mbedtls_rsa_get_len(), which returns a number of bytes, and no
500 * way to return the exact bit size of a key.
501 * To keep things simple, reject non-byte-aligned key sizes. */
502static psa_status_t psa_check_rsa_key_byte_aligned(
503 const mbedtls_rsa_context *rsa )
504{
505 mbedtls_mpi n;
506 psa_status_t status;
507 mbedtls_mpi_init( &n );
508 status = mbedtls_to_psa_error(
509 mbedtls_rsa_export( rsa, &n, NULL, NULL, NULL, NULL ) );
510 if( status == PSA_SUCCESS )
511 {
512 if( mbedtls_mpi_bitlen( &n ) % 8 != 0 )
513 status = PSA_ERROR_NOT_SUPPORTED;
514 }
515 mbedtls_mpi_free( &n );
516 return( status );
517}
Steven Cooremana01795d2020-07-24 22:48:15 +0200518#endif /* MBEDTLS_PK_PARSE_C */
Gilles Peskine86a440b2018-11-12 18:39:40 +0100519
Steven Cooreman7f391872020-07-30 14:57:44 +0200520/** Load the contents of a key buffer into an internal RSA representation
Steven Cooremana01795d2020-07-24 22:48:15 +0200521 *
Steven Cooreman4fed4552020-08-03 14:46:03 +0200522 * \param[in] type The type of key contained in \p data.
523 * \param[in] data The buffer from which to load the representation.
524 * \param[in] data_length The size in bytes of \p data.
525 * \param[out] p_rsa Returns a pointer to an RSA context on success.
526 * The caller is responsible for freeing both the
527 * contents of the context and the context itself
528 * when done.
Steven Cooremana01795d2020-07-24 22:48:15 +0200529 */
Steven Cooreman4fed4552020-08-03 14:46:03 +0200530static psa_status_t psa_load_rsa_representation( psa_key_type_t type,
531 const uint8_t *data,
532 size_t data_length,
Steven Cooremana2371e52020-07-28 14:30:39 +0200533 mbedtls_rsa_context **p_rsa )
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200534{
Steven Cooremana01795d2020-07-24 22:48:15 +0200535#if defined(MBEDTLS_PK_PARSE_C)
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000536 psa_status_t status;
Steven Cooremana01795d2020-07-24 22:48:15 +0200537 mbedtls_pk_context ctx;
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000538 size_t bits;
Steven Cooremana01795d2020-07-24 22:48:15 +0200539 mbedtls_pk_init( &ctx );
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000540
541 /* Parse the data. */
Steven Cooreman7f391872020-07-30 14:57:44 +0200542 if( PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000543 status = mbedtls_to_psa_error(
Steven Cooreman4fed4552020-08-03 14:46:03 +0200544 mbedtls_pk_parse_key( &ctx, data, data_length, NULL, 0 ) );
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200545 else
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000546 status = mbedtls_to_psa_error(
Steven Cooreman4fed4552020-08-03 14:46:03 +0200547 mbedtls_pk_parse_public_key( &ctx, data, data_length ) );
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000548 if( status != PSA_SUCCESS )
549 goto exit;
550
551 /* We have something that the pkparse module recognizes. If it is a
552 * valid RSA key, store it. */
Steven Cooremana01795d2020-07-24 22:48:15 +0200553 if( mbedtls_pk_get_type( &ctx ) != MBEDTLS_PK_RSA )
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200554 {
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000555 status = PSA_ERROR_INVALID_ARGUMENT;
556 goto exit;
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200557 }
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000558
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000559 /* The size of an RSA key doesn't have to be a multiple of 8. Mbed TLS
560 * supports non-byte-aligned key sizes, but not well. For example,
561 * mbedtls_rsa_get_len() returns the key size in bytes, not in bits. */
Steven Cooremana01795d2020-07-24 22:48:15 +0200562 bits = PSA_BYTES_TO_BITS( mbedtls_rsa_get_len( mbedtls_pk_rsa( ctx ) ) );
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000563 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
564 {
565 status = PSA_ERROR_NOT_SUPPORTED;
566 goto exit;
567 }
Steven Cooremana01795d2020-07-24 22:48:15 +0200568 status = psa_check_rsa_key_byte_aligned( mbedtls_pk_rsa( ctx ) );
Steven Cooremana01795d2020-07-24 22:48:15 +0200569 if( status != PSA_SUCCESS )
570 goto exit;
571
Steven Cooremana2371e52020-07-28 14:30:39 +0200572 /* Copy out the pointer to the RSA context, and reset the PK context
573 * such that pk_free doesn't free the RSA context we just grabbed. */
574 *p_rsa = mbedtls_pk_rsa( ctx );
575 ctx.pk_info = NULL;
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000576
577exit:
Steven Cooremana01795d2020-07-24 22:48:15 +0200578 mbedtls_pk_free( &ctx );
579 return( status );
580#else
Steven Cooreman4fed4552020-08-03 14:46:03 +0200581 (void) data;
582 (void) data_length;
Steven Cooreman7f391872020-07-30 14:57:44 +0200583 (void) type;
Steven Cooremana01795d2020-07-24 22:48:15 +0200584 (void) rsa;
585 return( PSA_ERROR_NOT_SUPPORTED );
586#endif /* MBEDTLS_PK_PARSE_C */
587}
588
589/** Export an RSA key to export representation
590 *
591 * \param[in] type The type of key (public/private) to export
592 * \param[in] rsa The internal RSA representation from which to export
593 * \param[out] data The buffer to export to
594 * \param[in] data_size The length of the buffer to export to
595 * \param[out] data_length The amount of bytes written to \p data
596 */
597static psa_status_t psa_export_rsa_key( psa_key_type_t type,
598 mbedtls_rsa_context *rsa,
599 uint8_t *data,
600 size_t data_size,
601 size_t *data_length )
602{
603#if defined(MBEDTLS_PK_WRITE_C)
604 int ret;
605 mbedtls_pk_context pk;
606 uint8_t *pos = data + data_size;
607
608 mbedtls_pk_init( &pk );
609 pk.pk_info = &mbedtls_rsa_info;
610 pk.pk_ctx = rsa;
611
612 /* PSA Crypto API defines the format of an RSA key as a DER-encoded
Steven Cooreman75b74362020-07-28 14:30:13 +0200613 * representation of the non-encrypted PKCS#1 RSAPrivateKey for a
614 * private key and of the RFC3279 RSAPublicKey for a public key. */
Steven Cooremana01795d2020-07-24 22:48:15 +0200615 if( PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
616 ret = mbedtls_pk_write_key_der( &pk, data, data_size );
617 else
618 ret = mbedtls_pk_write_pubkey( &pos, data, &pk );
619
620 if( ret < 0 )
Steven Cooreman4fed4552020-08-03 14:46:03 +0200621 {
622 /* Clean up in case pk_write failed halfway through. */
623 memset( data, 0, data_size );
Steven Cooreman29149862020-08-05 15:43:42 +0200624 return( mbedtls_to_psa_error( ret ) );
Steven Cooreman4fed4552020-08-03 14:46:03 +0200625 }
Steven Cooremana01795d2020-07-24 22:48:15 +0200626
627 /* The mbedtls_pk_xxx functions write to the end of the buffer.
628 * Move the data to the beginning and erase remaining data
629 * at the original location. */
630 if( 2 * (size_t) ret <= data_size )
631 {
632 memcpy( data, data + data_size - ret, ret );
633 memset( data + data_size - ret, 0, ret );
634 }
635 else if( (size_t) ret < data_size )
636 {
637 memmove( data, data + data_size - ret, ret );
638 memset( data + ret, 0, data_size - ret );
639 }
640
641 *data_length = ret;
642 return( PSA_SUCCESS );
643#else
644 (void) type;
645 (void) rsa;
646 (void) data;
647 (void) data_size;
648 (void) data_length;
649 return( PSA_ERROR_NOT_SUPPORTED );
650#endif /* MBEDTLS_PK_WRITE_C */
651}
652
653/** Import an RSA key from import representation to a slot
654 *
655 * \param[in,out] slot The slot where to store the export representation to
656 * \param[in] data The buffer containing the import representation
657 * \param[in] data_length The amount of bytes in \p data
658 */
659static psa_status_t psa_import_rsa_key( psa_key_slot_t *slot,
660 const uint8_t *data,
661 size_t data_length )
662{
663 psa_status_t status;
664 uint8_t* output = NULL;
Steven Cooremana2371e52020-07-28 14:30:39 +0200665 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +0200666
Steven Cooremana01795d2020-07-24 22:48:15 +0200667 /* Parse input */
Steven Cooreman4fed4552020-08-03 14:46:03 +0200668 status = psa_load_rsa_representation( slot->attr.type,
669 data,
Steven Cooreman7f391872020-07-30 14:57:44 +0200670 data_length,
Steven Cooreman7f391872020-07-30 14:57:44 +0200671 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +0200672 if( status != PSA_SUCCESS )
673 goto exit;
674
675 slot->attr.bits = (psa_key_bits_t) PSA_BYTES_TO_BITS(
Steven Cooremana2371e52020-07-28 14:30:39 +0200676 mbedtls_rsa_get_len( rsa ) );
Steven Cooremana01795d2020-07-24 22:48:15 +0200677
Steven Cooreman75b74362020-07-28 14:30:13 +0200678 /* Re-export the data to PSA export format, such that we can store export
679 * representation in the key slot. Export representation in case of RSA is
680 * the smallest representation that's allowed as input, so a straight-up
681 * allocation of the same size as the input buffer will be large enough. */
Steven Cooremana01795d2020-07-24 22:48:15 +0200682 output = mbedtls_calloc( 1, data_length );
Steven Cooremana01795d2020-07-24 22:48:15 +0200683 if( output == NULL )
684 {
685 status = PSA_ERROR_INSUFFICIENT_MEMORY;
686 goto exit;
687 }
688
Steven Cooremana01795d2020-07-24 22:48:15 +0200689 status = psa_export_rsa_key( slot->attr.type,
Steven Cooremana2371e52020-07-28 14:30:39 +0200690 rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +0200691 output,
692 data_length,
693 &data_length);
Steven Cooremana01795d2020-07-24 22:48:15 +0200694exit:
695 /* Always free the RSA object */
Steven Cooremana2371e52020-07-28 14:30:39 +0200696 mbedtls_rsa_free( rsa );
Steven Cooreman6d839f02020-07-30 11:36:45 +0200697 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +0200698
699 /* Free the allocated buffer only on error. */
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000700 if( status != PSA_SUCCESS )
701 {
Steven Cooremana01795d2020-07-24 22:48:15 +0200702 mbedtls_free( output );
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000703 return( status );
704 }
705
Steven Cooremana01795d2020-07-24 22:48:15 +0200706 /* On success, store the allocated export-formatted key. */
707 slot->data.key.data = output;
708 slot->data.key.bytes = data_length;
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000709
710 return( PSA_SUCCESS );
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200711}
Steven Cooremana01795d2020-07-24 22:48:15 +0200712#endif /* defined(MBEDTLS_RSA_C) */
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200713
Jaeden Ameroccdce902019-01-10 11:42:27 +0000714#if defined(MBEDTLS_ECP_C)
Steven Cooreman7f391872020-07-30 14:57:44 +0200715/** Load the contents of a key buffer into an internal ECP representation
Steven Cooremana2371e52020-07-28 14:30:39 +0200716 *
Steven Cooreman4fed4552020-08-03 14:46:03 +0200717 * \param[in] type The type of key contained in \p data.
718 * \param[in] data The buffer from which to load the representation.
719 * \param[in] data_length The size in bytes of \p data.
720 * \param[out] p_ecp Returns a pointer to an ECP context on success.
721 * The caller is responsible for freeing both the
722 * contents of the context and the context itself
723 * when done.
Steven Cooremana2371e52020-07-28 14:30:39 +0200724 */
Steven Cooreman4fed4552020-08-03 14:46:03 +0200725static psa_status_t psa_load_ecp_representation( psa_key_type_t type,
726 const uint8_t *data,
727 size_t data_length,
Steven Cooremana2371e52020-07-28 14:30:39 +0200728 mbedtls_ecp_keypair **p_ecp )
Gilles Peskine4cd32772019-12-02 20:49:42 +0100729{
730 mbedtls_ecp_group_id grp_id = MBEDTLS_ECP_DP_NONE;
Steven Cooremanacda8342020-07-24 23:09:52 +0200731 psa_status_t status;
Steven Cooreman6d839f02020-07-30 11:36:45 +0200732 mbedtls_ecp_keypair *ecp = NULL;
Steven Cooreman4fed4552020-08-03 14:46:03 +0200733 size_t curve_size = data_length;
Gilles Peskine4cd32772019-12-02 20:49:42 +0100734
Steven Cooreman4fed4552020-08-03 14:46:03 +0200735 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) &&
736 PSA_KEY_TYPE_ECC_GET_FAMILY( type ) != PSA_ECC_FAMILY_MONTGOMERY )
Gilles Peskine4295e8b2019-12-02 21:39:10 +0100737 {
Steven Cooreman4fed4552020-08-03 14:46:03 +0200738 /* A Weierstrass public key is represented as:
739 * - The byte 0x04;
740 * - `x_P` as a `ceiling(m/8)`-byte string, big-endian;
741 * - `y_P` as a `ceiling(m/8)`-byte string, big-endian.
742 * So its data length is 2m+1 where n is the key size in bits.
743 */
744 if( ( data_length & 1 ) == 0 )
745 return( PSA_ERROR_INVALID_ARGUMENT );
746 curve_size = data_length / 2;
747
748 /* Montgomery public keys are represented in compressed format, meaning
749 * their curve_size is equal to the amount of input. */
750
751 /* Private keys are represented in uncompressed private random integer
752 * format, meaning their curve_size is equal to the amount of input. */
Gilles Peskine4295e8b2019-12-02 21:39:10 +0100753 }
754
Steven Cooreman6d839f02020-07-30 11:36:45 +0200755 /* Allocate and initialize a key representation. */
Steven Cooreman29149862020-08-05 15:43:42 +0200756 ecp = mbedtls_calloc( 1, sizeof( mbedtls_ecp_keypair ) );
Steven Cooreman6d839f02020-07-30 11:36:45 +0200757 if( ecp == NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200758 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Steven Cooremana2371e52020-07-28 14:30:39 +0200759 mbedtls_ecp_keypair_init( ecp );
760
Gilles Peskine4cd32772019-12-02 20:49:42 +0100761 /* Load the group. */
Steven Cooreman7f391872020-07-30 14:57:44 +0200762 grp_id = mbedtls_ecc_group_of_psa( PSA_KEY_TYPE_ECC_GET_FAMILY( type ),
763 curve_size );
Gilles Peskine4295e8b2019-12-02 21:39:10 +0100764 if( grp_id == MBEDTLS_ECP_DP_NONE )
Steven Cooreman6d839f02020-07-30 11:36:45 +0200765 {
766 status = PSA_ERROR_INVALID_ARGUMENT;
767 goto exit;
768 }
769
Steven Cooremanacda8342020-07-24 23:09:52 +0200770 status = mbedtls_to_psa_error(
771 mbedtls_ecp_group_load( &ecp->grp, grp_id ) );
772 if( status != PSA_SUCCESS )
Steven Cooreman6d839f02020-07-30 11:36:45 +0200773 goto exit;
Steven Cooremanacda8342020-07-24 23:09:52 +0200774
Steven Cooreman6d839f02020-07-30 11:36:45 +0200775 /* Load the key material. */
Steven Cooreman7f391872020-07-30 14:57:44 +0200776 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) )
Steven Cooremanacda8342020-07-24 23:09:52 +0200777 {
778 /* Load the public value. */
779 status = mbedtls_to_psa_error(
780 mbedtls_ecp_point_read_binary( &ecp->grp, &ecp->Q,
Steven Cooreman4fed4552020-08-03 14:46:03 +0200781 data,
782 data_length ) );
Steven Cooremanacda8342020-07-24 23:09:52 +0200783 if( status != PSA_SUCCESS )
784 goto exit;
785
786 /* Check that the point is on the curve. */
787 status = mbedtls_to_psa_error(
788 mbedtls_ecp_check_pubkey( &ecp->grp, &ecp->Q ) );
789 if( status != PSA_SUCCESS )
790 goto exit;
791 }
792 else
793 {
Steven Cooreman6d839f02020-07-30 11:36:45 +0200794 /* Load and validate the secret value. */
Steven Cooremanacda8342020-07-24 23:09:52 +0200795 status = mbedtls_to_psa_error(
796 mbedtls_ecp_read_key( ecp->grp.id,
797 ecp,
Steven Cooreman4fed4552020-08-03 14:46:03 +0200798 data,
799 data_length ) );
Steven Cooremanacda8342020-07-24 23:09:52 +0200800 if( status != PSA_SUCCESS )
801 goto exit;
Steven Cooremanacda8342020-07-24 23:09:52 +0200802 }
Steven Cooremana2371e52020-07-28 14:30:39 +0200803
804 *p_ecp = ecp;
Steven Cooremanacda8342020-07-24 23:09:52 +0200805exit:
806 if( status != PSA_SUCCESS )
Steven Cooremana2371e52020-07-28 14:30:39 +0200807 {
Steven Cooremanacda8342020-07-24 23:09:52 +0200808 mbedtls_ecp_keypair_free( ecp );
Steven Cooremana2371e52020-07-28 14:30:39 +0200809 mbedtls_free( ecp );
810 }
811
Steven Cooreman29149862020-08-05 15:43:42 +0200812 return( status );
Gilles Peskine4cd32772019-12-02 20:49:42 +0100813}
Jaeden Ameroccdce902019-01-10 11:42:27 +0000814
Steven Cooreman4fed4552020-08-03 14:46:03 +0200815/** Export an ECP key to export representation
816 *
817 * \param[in] type The type of key (public/private) to export
818 * \param[in] ecp The internal ECP representation from which to export
819 * \param[out] data The buffer to export to
820 * \param[in] data_size The length of the buffer to export to
821 * \param[out] data_length The amount of bytes written to \p data
822 */
Steven Cooremanacda8342020-07-24 23:09:52 +0200823static psa_status_t psa_export_ecp_key( psa_key_type_t type,
824 mbedtls_ecp_keypair *ecp,
825 uint8_t *data,
826 size_t data_size,
827 size_t *data_length )
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200828{
Steven Cooremanacda8342020-07-24 23:09:52 +0200829 psa_status_t status;
Jaeden Ameroccdce902019-01-10 11:42:27 +0000830
Steven Cooremanacda8342020-07-24 23:09:52 +0200831 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) )
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200832 {
Steven Cooremanacda8342020-07-24 23:09:52 +0200833 /* Check whether the public part is loaded */
834 if( mbedtls_ecp_is_zero( &ecp->Q ) )
835 {
836 /* Calculate the public key */
837 status = mbedtls_to_psa_error(
838 mbedtls_ecp_mul( &ecp->grp, &ecp->Q, &ecp->d, &ecp->grp.G,
839 mbedtls_ctr_drbg_random, &global_data.ctr_drbg ) );
840 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +0200841 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +0200842 }
843
Steven Cooreman4fed4552020-08-03 14:46:03 +0200844 status = mbedtls_to_psa_error(
Steven Cooremanacda8342020-07-24 23:09:52 +0200845 mbedtls_ecp_point_write_binary( &ecp->grp, &ecp->Q,
846 MBEDTLS_ECP_PF_UNCOMPRESSED,
847 data_length,
848 data,
Steven Cooreman4fed4552020-08-03 14:46:03 +0200849 data_size ) );
Steven Cooreman4fed4552020-08-03 14:46:03 +0200850 if( status != PSA_SUCCESS )
851 memset( data, 0, data_size );
852
Steven Cooreman29149862020-08-05 15:43:42 +0200853 return( status );
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200854 }
Steven Cooremanacda8342020-07-24 23:09:52 +0200855 else
856 {
Steven Cooreman29149862020-08-05 15:43:42 +0200857 if( data_size < PSA_BITS_TO_BYTES( ecp->grp.nbits ) )
Steven Cooremanacda8342020-07-24 23:09:52 +0200858 return( PSA_ERROR_BUFFER_TOO_SMALL );
859
860 status = mbedtls_to_psa_error(
861 mbedtls_ecp_write_key( ecp,
862 data,
Steven Cooreman29149862020-08-05 15:43:42 +0200863 PSA_BITS_TO_BYTES( ecp->grp.nbits ) ) );
Steven Cooremanacda8342020-07-24 23:09:52 +0200864 if( status == PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +0200865 *data_length = PSA_BITS_TO_BYTES( ecp->grp.nbits );
Steven Cooremanb7f6dea2020-08-05 16:07:20 +0200866 else
867 memset( data, 0, data_size );
Steven Cooremanacda8342020-07-24 23:09:52 +0200868
869 return( status );
870 }
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200871}
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200872
Steven Cooreman4fed4552020-08-03 14:46:03 +0200873/** Import an ECP key from import representation to a slot
874 *
875 * \param[in,out] slot The slot where to store the export representation to
876 * \param[in] data The buffer containing the import representation
877 * \param[in] data_length The amount of bytes in \p data
878 */
Steven Cooremanacda8342020-07-24 23:09:52 +0200879static psa_status_t psa_import_ecp_key( psa_key_slot_t *slot,
880 const uint8_t *data,
881 size_t data_length )
Gilles Peskinef76aa772018-10-29 19:24:33 +0100882{
Steven Cooremanacda8342020-07-24 23:09:52 +0200883 psa_status_t status;
884 uint8_t* output = NULL;
Steven Cooremana2371e52020-07-28 14:30:39 +0200885 mbedtls_ecp_keypair *ecp = NULL;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100886
Steven Cooremanacda8342020-07-24 23:09:52 +0200887 /* Parse input */
Steven Cooreman4fed4552020-08-03 14:46:03 +0200888 status = psa_load_ecp_representation( slot->attr.type,
889 data,
Steven Cooreman7f391872020-07-30 14:57:44 +0200890 data_length,
Steven Cooreman7f391872020-07-30 14:57:44 +0200891 &ecp );
Gilles Peskinef76aa772018-10-29 19:24:33 +0100892 if( status != PSA_SUCCESS )
893 goto exit;
Gilles Peskine4cd32772019-12-02 20:49:42 +0100894
Steven Cooremanacda8342020-07-24 23:09:52 +0200895 if( PSA_KEY_TYPE_ECC_GET_FAMILY( slot->attr.type ) == PSA_ECC_FAMILY_MONTGOMERY)
Steven Cooremana2371e52020-07-28 14:30:39 +0200896 slot->attr.bits = (psa_key_bits_t) ecp->grp.nbits + 1;
Steven Cooremanacda8342020-07-24 23:09:52 +0200897 else
Steven Cooremana2371e52020-07-28 14:30:39 +0200898 slot->attr.bits = (psa_key_bits_t) ecp->grp.nbits;
Steven Cooremane3fd3922020-06-11 16:50:36 +0200899
Steven Cooremanacda8342020-07-24 23:09:52 +0200900 /* Re-export the data to PSA export format. There is currently no support
901 * for other input formats then the export format, so this is a 1-1
902 * copy operation. */
903 output = mbedtls_calloc( 1, data_length );
Steven Cooremanacda8342020-07-24 23:09:52 +0200904 if( output == NULL )
905 {
906 status = PSA_ERROR_INSUFFICIENT_MEMORY;
907 goto exit;
908 }
909
910 status = psa_export_ecp_key( slot->attr.type,
Steven Cooremana2371e52020-07-28 14:30:39 +0200911 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +0200912 output,
913 data_length,
914 &data_length);
Gilles Peskinef76aa772018-10-29 19:24:33 +0100915exit:
Steven Cooremana2371e52020-07-28 14:30:39 +0200916 /* Always free the PK object (will also free contained ECP context) */
917 mbedtls_ecp_keypair_free( ecp );
Steven Cooreman6d839f02020-07-30 11:36:45 +0200918 mbedtls_free( ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +0200919
920 /* Free the allocated buffer only on error. */
921 if( status != PSA_SUCCESS )
Gilles Peskinef76aa772018-10-29 19:24:33 +0100922 {
Steven Cooremanacda8342020-07-24 23:09:52 +0200923 mbedtls_free( output );
Steven Cooremanacda8342020-07-24 23:09:52 +0200924 return( status );
Gilles Peskinef76aa772018-10-29 19:24:33 +0100925 }
Steven Cooremanacda8342020-07-24 23:09:52 +0200926
927 /* On success, store the allocated export-formatted key. */
928 slot->data.key.data = output;
929 slot->data.key.bytes = data_length;
930
931 return( PSA_SUCCESS );
Gilles Peskinef76aa772018-10-29 19:24:33 +0100932}
933#endif /* defined(MBEDTLS_ECP_C) */
934
Gilles Peskineb46bef22019-07-30 21:32:04 +0200935/** Return the size of the key in the given slot, in bits.
936 *
937 * \param[in] slot A key slot.
938 *
939 * \return The key size in bits, read from the metadata in the slot.
940 */
941static inline size_t psa_get_key_slot_bits( const psa_key_slot_t *slot )
942{
943 return( slot->attr.bits );
944}
945
Steven Cooreman75b74362020-07-28 14:30:13 +0200946/** Try to allocate a buffer to an empty key slot.
947 *
948 * \param[in,out] slot Key slot to attach buffer to.
949 * \param[in] buffer_length Requested size of the buffer.
950 *
951 * \retval #PSA_SUCCESS
952 * The buffer has been successfully allocated.
953 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
954 * Not enough memory was available for allocation.
955 * \retval #PSA_ERROR_ALREADY_EXISTS
956 * Trying to allocate a buffer to a non-empty key slot.
957 */
958static psa_status_t psa_allocate_buffer_to_slot( psa_key_slot_t *slot,
959 size_t buffer_length )
960{
961 if( slot->data.key.data != NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200962 return( PSA_ERROR_ALREADY_EXISTS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200963
964 slot->data.key.data = mbedtls_calloc( 1, buffer_length );
965 if( slot->data.key.data == NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200966 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Steven Cooreman75b74362020-07-28 14:30:13 +0200967
968 slot->data.key.bytes = buffer_length;
Steven Cooreman29149862020-08-05 15:43:42 +0200969 return( PSA_SUCCESS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200970}
971
Gilles Peskine8e338702019-07-30 20:06:31 +0200972/** Import key data into a slot. `slot->attr.type` must have been set
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100973 * previously. This function assumes that the slot does not contain
974 * any key material yet. On failure, the slot content is unchanged. */
Gilles Peskinefa4135b2018-12-10 16:48:53 +0100975psa_status_t psa_import_key_into_slot( psa_key_slot_t *slot,
976 const uint8_t *data,
977 size_t data_length )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100978{
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200979 psa_status_t status = PSA_SUCCESS;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100980
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200981 /* zero-length keys are never supported. */
982 if( data_length == 0 )
983 return( PSA_ERROR_NOT_SUPPORTED );
984
Gilles Peskine8e338702019-07-30 20:06:31 +0200985 if( key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100986 {
Gilles Peskinec744d992019-07-30 17:26:54 +0200987 size_t bit_size = PSA_BYTES_TO_BITS( data_length );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200988
Steven Cooreman75b74362020-07-28 14:30:13 +0200989 /* Ensure that the bytes-to-bits conversion hasn't overflown. */
990 if( data_length > SIZE_MAX / 8 )
991 return( PSA_ERROR_NOT_SUPPORTED );
992
Gilles Peskine1b9505c2019-08-07 10:59:45 +0200993 /* Enforce a size limit, and in particular ensure that the bit
994 * size fits in its representation type. */
Gilles Peskinec744d992019-07-30 17:26:54 +0200995 if( bit_size > PSA_MAX_KEY_BITS )
996 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200997
998 status = validate_unstructured_key_bit_size( slot->attr.type, bit_size );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200999 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001000 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02001001
1002 /* Allocate memory for the key */
Steven Cooreman75b74362020-07-28 14:30:13 +02001003 status = psa_allocate_buffer_to_slot( slot, data_length );
1004 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001005 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02001006
1007 /* copy key into allocated buffer */
Steven Cooreman29149862020-08-05 15:43:42 +02001008 memcpy( slot->data.key.data, data, data_length );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02001009
1010 /* Write the actual key size to the slot.
1011 * psa_start_key_creation() wrote the size declared by the
1012 * caller, which may be 0 (meaning unspecified) or wrong. */
1013 slot->attr.bits = (psa_key_bits_t) bit_size;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001014 }
Steven Cooreman19fd5742020-07-24 23:31:01 +02001015 else if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
1016 {
Gilles Peskinef76aa772018-10-29 19:24:33 +01001017#if defined(MBEDTLS_ECP_C)
Steven Cooreman19fd5742020-07-24 23:31:01 +02001018 status = psa_import_ecp_key( slot,
1019 data, data_length );
1020#else
1021 /* No drivers have been implemented yet, so without mbed TLS backing
1022 * there's no way to do ECP with the current library. */
1023 return( PSA_ERROR_NOT_SUPPORTED );
1024#endif /* defined(MBEDTLS_ECP_C) */
1025 }
1026 else if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskinef76aa772018-10-29 19:24:33 +01001027 {
Steven Cooreman19fd5742020-07-24 23:31:01 +02001028#if defined(MBEDTLS_RSA_C)
1029 status = psa_import_rsa_key( slot,
1030 data, data_length );
1031#else
1032 /* No drivers have been implemented yet, so without mbed TLS backing
1033 * there's no way to do RSA with the current library. */
1034 status = PSA_ERROR_NOT_SUPPORTED;
1035#endif /* defined(MBEDTLS_RSA_C) */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001036 }
1037 else
Gilles Peskinec66ea6a2018-02-03 22:43:28 +01001038 {
Steven Cooreman19fd5742020-07-24 23:31:01 +02001039 /* Unknown key type */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001040 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969ac722018-01-28 18:16:59 +01001041 }
Darryl Green940d72c2018-07-13 13:18:51 +01001042
Darryl Green06fd18d2018-07-16 11:21:11 +01001043 return( status );
1044}
1045
Gilles Peskinef603c712019-01-19 13:40:11 +01001046/** Calculate the intersection of two algorithm usage policies.
1047 *
1048 * Return 0 (which allows no operation) on incompatibility.
1049 */
1050static psa_algorithm_t psa_key_policy_algorithm_intersection(
1051 psa_algorithm_t alg1,
1052 psa_algorithm_t alg2 )
1053{
Gilles Peskine549ea862019-05-22 11:45:59 +02001054 /* Common case: both sides actually specify the same policy. */
Gilles Peskinef603c712019-01-19 13:40:11 +01001055 if( alg1 == alg2 )
1056 return( alg1 );
1057 /* If the policies are from the same hash-and-sign family, check
1058 * if one is a wildcard. If so the other has the specific algorithm. */
1059 if( PSA_ALG_IS_HASH_AND_SIGN( alg1 ) &&
1060 PSA_ALG_IS_HASH_AND_SIGN( alg2 ) &&
1061 ( alg1 & ~PSA_ALG_HASH_MASK ) == ( alg2 & ~PSA_ALG_HASH_MASK ) )
1062 {
1063 if( PSA_ALG_SIGN_GET_HASH( alg1 ) == PSA_ALG_ANY_HASH )
1064 return( alg2 );
1065 if( PSA_ALG_SIGN_GET_HASH( alg2 ) == PSA_ALG_ANY_HASH )
1066 return( alg1 );
1067 }
1068 /* If the policies are incompatible, allow nothing. */
1069 return( 0 );
1070}
1071
Gilles Peskined6f371b2019-05-10 19:33:38 +02001072static int psa_key_algorithm_permits( psa_algorithm_t policy_alg,
1073 psa_algorithm_t requested_alg )
1074{
Gilles Peskine549ea862019-05-22 11:45:59 +02001075 /* Common case: the policy only allows requested_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +02001076 if( requested_alg == policy_alg )
1077 return( 1 );
1078 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
Gilles Peskine549ea862019-05-22 11:45:59 +02001079 * and requested_alg is the same hash-and-sign family with any hash,
1080 * then requested_alg is compliant with policy_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +02001081 if( PSA_ALG_IS_HASH_AND_SIGN( requested_alg ) &&
1082 PSA_ALG_SIGN_GET_HASH( policy_alg ) == PSA_ALG_ANY_HASH )
1083 {
1084 return( ( policy_alg & ~PSA_ALG_HASH_MASK ) ==
1085 ( requested_alg & ~PSA_ALG_HASH_MASK ) );
1086 }
Steven Cooremance48e852020-10-05 16:02:45 +02001087 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +02001088 * a key derivation with that key agreement should also be allowed. This
1089 * behaviour is expected to be defined in a future specification version. */
Steven Cooremance48e852020-10-05 16:02:45 +02001090 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( policy_alg ) &&
1091 PSA_ALG_IS_KEY_AGREEMENT( requested_alg ) )
1092 {
1093 return( PSA_ALG_KEY_AGREEMENT_GET_BASE( requested_alg ) ==
1094 policy_alg );
1095 }
Gilles Peskined6f371b2019-05-10 19:33:38 +02001096 /* If it isn't permitted, it's forbidden. */
1097 return( 0 );
1098}
1099
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001100/** Test whether a policy permits an algorithm.
1101 *
1102 * The caller must test usage flags separately.
1103 */
1104static int psa_key_policy_permits( const psa_key_policy_t *policy,
1105 psa_algorithm_t alg )
1106{
Gilles Peskined6f371b2019-05-10 19:33:38 +02001107 return( psa_key_algorithm_permits( policy->alg, alg ) ||
1108 psa_key_algorithm_permits( policy->alg2, alg ) );
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001109}
1110
Gilles Peskinef603c712019-01-19 13:40:11 +01001111/** Restrict a key policy based on a constraint.
1112 *
1113 * \param[in,out] policy The policy to restrict.
1114 * \param[in] constraint The policy constraint to apply.
1115 *
1116 * \retval #PSA_SUCCESS
1117 * \c *policy contains the intersection of the original value of
1118 * \c *policy and \c *constraint.
1119 * \retval #PSA_ERROR_INVALID_ARGUMENT
1120 * \c *policy and \c *constraint are incompatible.
1121 * \c *policy is unchanged.
1122 */
1123static psa_status_t psa_restrict_key_policy(
1124 psa_key_policy_t *policy,
1125 const psa_key_policy_t *constraint )
1126{
1127 psa_algorithm_t intersection_alg =
1128 psa_key_policy_algorithm_intersection( policy->alg, constraint->alg );
Gilles Peskined6f371b2019-05-10 19:33:38 +02001129 psa_algorithm_t intersection_alg2 =
1130 psa_key_policy_algorithm_intersection( policy->alg2, constraint->alg2 );
Gilles Peskinef603c712019-01-19 13:40:11 +01001131 if( intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0 )
1132 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskined6f371b2019-05-10 19:33:38 +02001133 if( intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0 )
1134 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinef603c712019-01-19 13:40:11 +01001135 policy->usage &= constraint->usage;
1136 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +02001137 policy->alg2 = intersection_alg2;
Gilles Peskinef603c712019-01-19 13:40:11 +01001138 return( PSA_SUCCESS );
1139}
1140
Darryl Green06fd18d2018-07-16 11:21:11 +01001141/** Retrieve a slot which must contain a key. The key must have allow all the
1142 * usage flags set in \p usage. If \p alg is nonzero, the key must allow
1143 * operations with this algorithm. */
Gilles Peskinec5487a82018-12-03 18:08:14 +01001144static psa_status_t psa_get_key_from_slot( psa_key_handle_t handle,
Gilles Peskine2f060a82018-12-04 17:12:32 +01001145 psa_key_slot_t **p_slot,
Darryl Green06fd18d2018-07-16 11:21:11 +01001146 psa_key_usage_t usage,
1147 psa_algorithm_t alg )
1148{
1149 psa_status_t status;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001150 psa_key_slot_t *slot = NULL;
Darryl Green06fd18d2018-07-16 11:21:11 +01001151
1152 *p_slot = NULL;
1153
Gilles Peskinec5487a82018-12-03 18:08:14 +01001154 status = psa_get_key_slot( handle, &slot );
Darryl Green06fd18d2018-07-16 11:21:11 +01001155 if( status != PSA_SUCCESS )
1156 return( status );
Darryl Green06fd18d2018-07-16 11:21:11 +01001157
1158 /* Enforce that usage policy for the key slot contains all the flags
1159 * required by the usage parameter. There is one exception: public
1160 * keys can always be exported, so we treat public key objects as
1161 * if they had the export flag. */
Gilles Peskine8e338702019-07-30 20:06:31 +02001162 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Darryl Green06fd18d2018-07-16 11:21:11 +01001163 usage &= ~PSA_KEY_USAGE_EXPORT;
Gilles Peskine8e338702019-07-30 20:06:31 +02001164 if( ( slot->attr.policy.usage & usage ) != usage )
Darryl Green06fd18d2018-07-16 11:21:11 +01001165 return( PSA_ERROR_NOT_PERMITTED );
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001166
1167 /* Enforce that the usage policy permits the requested algortihm. */
Gilles Peskine8e338702019-07-30 20:06:31 +02001168 if( alg != 0 && ! psa_key_policy_permits( &slot->attr.policy, alg ) )
Darryl Green06fd18d2018-07-16 11:21:11 +01001169 return( PSA_ERROR_NOT_PERMITTED );
1170
1171 *p_slot = slot;
1172 return( PSA_SUCCESS );
1173}
Darryl Green940d72c2018-07-13 13:18:51 +01001174
Gilles Peskine28f8f302019-07-24 13:30:31 +02001175/** Retrieve a slot which must contain a transparent key.
1176 *
1177 * A transparent key is a key for which the key material is directly
1178 * available, as opposed to a key in a secure element.
1179 *
Gilles Peskine60450a42019-07-25 11:32:45 +02001180 * This is a temporary function to use instead of psa_get_key_from_slot()
1181 * until secure element support is fully implemented.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001182 */
1183#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1184static psa_status_t psa_get_transparent_key( psa_key_handle_t handle,
1185 psa_key_slot_t **p_slot,
1186 psa_key_usage_t usage,
1187 psa_algorithm_t alg )
1188{
1189 psa_status_t status = psa_get_key_from_slot( handle, p_slot, usage, alg );
1190 if( status != PSA_SUCCESS )
1191 return( status );
Gilles Peskineadad8132019-07-25 11:31:23 +02001192 if( psa_key_slot_is_external( *p_slot ) )
Gilles Peskine28f8f302019-07-24 13:30:31 +02001193 {
1194 *p_slot = NULL;
1195 return( PSA_ERROR_NOT_SUPPORTED );
1196 }
1197 return( PSA_SUCCESS );
1198}
1199#else /* MBEDTLS_PSA_CRYPTO_SE_C */
1200/* With no secure element support, all keys are transparent. */
1201#define psa_get_transparent_key( handle, p_slot, usage, alg ) \
1202 psa_get_key_from_slot( handle, p_slot, usage, alg )
1203#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1204
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001205/** Wipe key data from a slot. Preserve metadata such as the policy. */
Gilles Peskine2f060a82018-12-04 17:12:32 +01001206static psa_status_t psa_remove_key_data_from_memory( psa_key_slot_t *slot )
Darryl Green40225ba2018-11-15 14:48:15 +00001207{
Gilles Peskine73167e12019-07-12 23:44:37 +02001208#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1209 if( psa_key_slot_is_external( slot ) )
Darryl Green40225ba2018-11-15 14:48:15 +00001210 {
1211 /* No key material to clean. */
1212 }
Gilles Peskine73167e12019-07-12 23:44:37 +02001213 else
1214#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Darryl Green40225ba2018-11-15 14:48:15 +00001215 {
Steven Cooremanfd4d69a2020-08-05 15:46:33 +02001216 /* Data pointer will always be either a valid pointer or NULL in an
1217 * initialized slot, so we can just free it. */
1218 if( slot->data.key.data != NULL )
1219 mbedtls_platform_zeroize( slot->data.key.data, slot->data.key.bytes);
Steven Cooremana01795d2020-07-24 22:48:15 +02001220 mbedtls_free( slot->data.key.data );
1221 slot->data.key.data = NULL;
1222 slot->data.key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +00001223 }
Darryl Green40225ba2018-11-15 14:48:15 +00001224
1225 return( PSA_SUCCESS );
1226}
1227
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001228/** Completely wipe a slot in memory, including its policy.
1229 * Persistent storage is not affected. */
Gilles Peskine66fb1262018-12-10 16:29:04 +01001230psa_status_t psa_wipe_key_slot( psa_key_slot_t *slot )
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001231{
1232 psa_status_t status = psa_remove_key_data_from_memory( slot );
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001233 /* Multipart operations may still be using the key. This is safe
1234 * because all multipart operation objects are independent from
1235 * the key slot: if they need to access the key after the setup
1236 * phase, they have a copy of the key. Note that this means that
1237 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001238 /* At this point, key material and other type-specific content has
1239 * been wiped. Clear remaining metadata. We can call memset and not
1240 * zeroize because the metadata is not particularly sensitive. */
1241 memset( slot, 0, sizeof( *slot ) );
1242 return( status );
1243}
1244
Gilles Peskinec5487a82018-12-03 18:08:14 +01001245psa_status_t psa_destroy_key( psa_key_handle_t handle )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001246{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001247 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001248 psa_status_t status; /* status of the last operation */
1249 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001250#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1251 psa_se_drv_table_entry_t *driver;
1252#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001253
Gilles Peskine1841cf42019-10-08 15:48:25 +02001254 if( handle == 0 )
1255 return( PSA_SUCCESS );
1256
Gilles Peskinec5487a82018-12-03 18:08:14 +01001257 status = psa_get_key_slot( handle, &slot );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001258 if( status != PSA_SUCCESS )
1259 return( status );
Gilles Peskine354f7672019-07-12 23:46:38 +02001260
1261#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001262 driver = psa_get_se_driver_entry( slot->attr.lifetime );
Gilles Peskine354f7672019-07-12 23:46:38 +02001263 if( driver != NULL )
Gilles Peskinefc762652019-07-22 19:30:34 +02001264 {
Gilles Peskine60450a42019-07-25 11:32:45 +02001265 /* For a key in a secure element, we need to do three things:
1266 * remove the key file in internal storage, destroy the
1267 * key inside the secure element, and update the driver's
1268 * persistent data. Start a transaction that will encompass these
1269 * three actions. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001270 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_DESTROY_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +02001271 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Gilles Peskinefc762652019-07-22 19:30:34 +02001272 psa_crypto_transaction.key.slot = slot->data.se.slot_number;
Gilles Peskine8e338702019-07-30 20:06:31 +02001273 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskinefc762652019-07-22 19:30:34 +02001274 status = psa_crypto_save_transaction( );
1275 if( status != PSA_SUCCESS )
1276 {
Gilles Peskine66be51c2019-07-25 18:02:52 +02001277 (void) psa_crypto_stop_transaction( );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001278 /* We should still try to destroy the key in the secure
1279 * element and the key metadata in storage. This is especially
1280 * important if the error is that the storage is full.
1281 * But how to do it exactly without risking an inconsistent
1282 * state after a reset?
1283 * https://github.com/ARMmbed/mbed-crypto/issues/215
1284 */
1285 overall_status = status;
1286 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001287 }
1288
Gilles Peskine354f7672019-07-12 23:46:38 +02001289 status = psa_destroy_se_key( driver, slot->data.se.slot_number );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001290 if( overall_status == PSA_SUCCESS )
1291 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001292 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001293#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1294
Darryl Greend49a4992018-06-18 17:27:26 +01001295#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskinecaec2782019-08-13 15:11:49 +02001296 if( slot->attr.lifetime != PSA_KEY_LIFETIME_VOLATILE )
Darryl Greend49a4992018-06-18 17:27:26 +01001297 {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001298 status = psa_destroy_persistent_key( slot->attr.id );
1299 if( overall_status == PSA_SUCCESS )
1300 overall_status = status;
1301
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001302 /* TODO: other slots may have a copy of the same key. We should
1303 * invalidate them.
1304 * https://github.com/ARMmbed/mbed-crypto/issues/214
1305 */
Darryl Greend49a4992018-06-18 17:27:26 +01001306 }
1307#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001308
Gilles Peskinefc762652019-07-22 19:30:34 +02001309#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1310 if( driver != NULL )
1311 {
Gilles Peskine725f22a2019-07-25 11:31:48 +02001312 status = psa_save_se_persistent_data( driver );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001313 if( overall_status == PSA_SUCCESS )
1314 overall_status = status;
1315 status = psa_crypto_stop_transaction( );
1316 if( overall_status == PSA_SUCCESS )
1317 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001318 }
1319#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1320
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001321#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1322exit:
1323#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001324 status = psa_wipe_key_slot( slot );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001325 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
1326 if( overall_status == PSA_SUCCESS )
1327 overall_status = status;
1328 return( overall_status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001329}
1330
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001331void psa_reset_key_attributes( psa_key_attributes_t *attributes )
Gilles Peskineb870b182018-07-06 16:02:09 +02001332{
Gilles Peskineb699f072019-04-26 16:06:02 +02001333 mbedtls_free( attributes->domain_parameters );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001334 memset( attributes, 0, sizeof( *attributes ) );
Gilles Peskineb870b182018-07-06 16:02:09 +02001335}
1336
Gilles Peskineb699f072019-04-26 16:06:02 +02001337psa_status_t psa_set_key_domain_parameters( psa_key_attributes_t *attributes,
1338 psa_key_type_t type,
1339 const uint8_t *data,
1340 size_t data_length )
1341{
1342 uint8_t *copy = NULL;
1343
1344 if( data_length != 0 )
1345 {
1346 copy = mbedtls_calloc( 1, data_length );
1347 if( copy == NULL )
1348 return( PSA_ERROR_INSUFFICIENT_MEMORY );
1349 memcpy( copy, data, data_length );
1350 }
1351 /* After this point, this function is guaranteed to succeed, so it
1352 * can start modifying `*attributes`. */
1353
1354 if( attributes->domain_parameters != NULL )
1355 {
1356 mbedtls_free( attributes->domain_parameters );
1357 attributes->domain_parameters = NULL;
1358 attributes->domain_parameters_size = 0;
1359 }
1360
1361 attributes->domain_parameters = copy;
1362 attributes->domain_parameters_size = data_length;
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001363 attributes->core.type = type;
Gilles Peskineb699f072019-04-26 16:06:02 +02001364 return( PSA_SUCCESS );
1365}
1366
1367psa_status_t psa_get_key_domain_parameters(
1368 const psa_key_attributes_t *attributes,
1369 uint8_t *data, size_t data_size, size_t *data_length )
1370{
1371 if( attributes->domain_parameters_size > data_size )
1372 return( PSA_ERROR_BUFFER_TOO_SMALL );
1373 *data_length = attributes->domain_parameters_size;
1374 if( attributes->domain_parameters_size != 0 )
1375 memcpy( data, attributes->domain_parameters,
1376 attributes->domain_parameters_size );
1377 return( PSA_SUCCESS );
1378}
1379
1380#if defined(MBEDTLS_RSA_C)
1381static psa_status_t psa_get_rsa_public_exponent(
1382 const mbedtls_rsa_context *rsa,
1383 psa_key_attributes_t *attributes )
1384{
1385 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001386 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001387 uint8_t *buffer = NULL;
1388 size_t buflen;
1389 mbedtls_mpi_init( &mpi );
1390
1391 ret = mbedtls_rsa_export( rsa, NULL, NULL, NULL, NULL, &mpi );
1392 if( ret != 0 )
1393 goto exit;
Gilles Peskine772c8b12019-04-26 17:37:21 +02001394 if( mbedtls_mpi_cmp_int( &mpi, 65537 ) == 0 )
1395 {
1396 /* It's the default value, which is reported as an empty string,
1397 * so there's nothing to do. */
1398 goto exit;
1399 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001400
1401 buflen = mbedtls_mpi_size( &mpi );
1402 buffer = mbedtls_calloc( 1, buflen );
1403 if( buffer == NULL )
1404 {
1405 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1406 goto exit;
1407 }
1408 ret = mbedtls_mpi_write_binary( &mpi, buffer, buflen );
1409 if( ret != 0 )
1410 goto exit;
1411 attributes->domain_parameters = buffer;
1412 attributes->domain_parameters_size = buflen;
1413
1414exit:
1415 mbedtls_mpi_free( &mpi );
1416 if( ret != 0 )
1417 mbedtls_free( buffer );
1418 return( mbedtls_to_psa_error( ret ) );
1419}
1420#endif /* MBEDTLS_RSA_C */
1421
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001422/** Retrieve all the publicly-accessible attributes of a key.
1423 */
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001424psa_status_t psa_get_key_attributes( psa_key_handle_t handle,
1425 psa_key_attributes_t *attributes )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001426{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001427 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001428 psa_status_t status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001429
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001430 psa_reset_key_attributes( attributes );
1431
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001432 status = psa_get_key_from_slot( handle, &slot, 0, 0 );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001433 if( status != PSA_SUCCESS )
1434 return( status );
Gilles Peskineb870b182018-07-06 16:02:09 +02001435
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001436 attributes->core = slot->attr;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001437 attributes->core.flags &= ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1438 MBEDTLS_PSA_KA_MASK_DUAL_USE );
1439
1440#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1441 if( psa_key_slot_is_external( slot ) )
1442 psa_set_key_slot_number( attributes, slot->data.se.slot_number );
1443#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001444
Gilles Peskine8e338702019-07-30 20:06:31 +02001445 switch( slot->attr.type )
Gilles Peskineb699f072019-04-26 16:06:02 +02001446 {
1447#if defined(MBEDTLS_RSA_C)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001448 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001449 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001450#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001451 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001452 * is not yet implemented.
1453 * https://github.com/ARMmbed/mbed-crypto/issues/216
1454 */
Gilles Peskinec8000c02019-08-02 20:15:51 +02001455 if( psa_key_slot_is_external( slot ) )
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001456 break;
1457#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Steven Cooremana01795d2020-07-24 22:48:15 +02001458 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001459 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001460
Steven Cooreman4fed4552020-08-03 14:46:03 +02001461 status = psa_load_rsa_representation( slot->attr.type,
1462 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02001463 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02001464 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001465 if( status != PSA_SUCCESS )
1466 break;
1467
Steven Cooremana2371e52020-07-28 14:30:39 +02001468 status = psa_get_rsa_public_exponent( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02001469 attributes );
Steven Cooremana2371e52020-07-28 14:30:39 +02001470 mbedtls_rsa_free( rsa );
1471 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001472 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001473 break;
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001474#endif /* MBEDTLS_RSA_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001475 default:
1476 /* Nothing else to do. */
1477 break;
1478 }
1479
1480 if( status != PSA_SUCCESS )
1481 psa_reset_key_attributes( attributes );
1482 return( status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001483}
1484
Gilles Peskinec8000c02019-08-02 20:15:51 +02001485#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1486psa_status_t psa_get_key_slot_number(
1487 const psa_key_attributes_t *attributes,
1488 psa_key_slot_number_t *slot_number )
1489{
1490 if( attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER )
1491 {
1492 *slot_number = attributes->slot_number;
1493 return( PSA_SUCCESS );
1494 }
1495 else
1496 return( PSA_ERROR_INVALID_ARGUMENT );
1497}
1498#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1499
Steven Cooremana01795d2020-07-24 22:48:15 +02001500static psa_status_t psa_internal_export_key_buffer( const psa_key_slot_t *slot,
1501 uint8_t *data,
1502 size_t data_size,
1503 size_t *data_length )
1504{
1505 if( slot->data.key.bytes > data_size )
1506 return( PSA_ERROR_BUFFER_TOO_SMALL );
1507 memcpy( data, slot->data.key.data, slot->data.key.bytes );
1508 memset( data + slot->data.key.bytes, 0,
1509 data_size - slot->data.key.bytes );
1510 *data_length = slot->data.key.bytes;
1511 return( PSA_SUCCESS );
1512}
1513
Gilles Peskinef603c712019-01-19 13:40:11 +01001514static psa_status_t psa_internal_export_key( const psa_key_slot_t *slot,
1515 uint8_t *data,
1516 size_t data_size,
1517 size_t *data_length,
1518 int export_public_key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001519{
Gilles Peskine5d309672019-07-12 23:47:28 +02001520#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1521 const psa_drv_se_t *drv;
1522 psa_drv_se_context_t *drv_context;
1523#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1524
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001525 *data_length = 0;
1526
Gilles Peskine8e338702019-07-30 20:06:31 +02001527 if( export_public_key && ! PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
Moran Pekera998bc62018-04-16 18:16:20 +03001528 return( PSA_ERROR_INVALID_ARGUMENT );
mohammad160306e79202018-03-28 13:17:44 +03001529
Gilles Peskinef9168942019-09-12 19:20:29 +02001530 /* Reject a zero-length output buffer now, since this can never be a
1531 * valid key representation. This way we know that data must be a valid
1532 * pointer and we can do things like memset(data, ..., data_size). */
1533 if( data_size == 0 )
1534 return( PSA_ERROR_BUFFER_TOO_SMALL );
1535
Gilles Peskine5d309672019-07-12 23:47:28 +02001536#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001537 if( psa_get_se_driver( slot->attr.lifetime, &drv, &drv_context ) )
Gilles Peskine5d309672019-07-12 23:47:28 +02001538 {
1539 psa_drv_se_export_key_t method;
1540 if( drv->key_management == NULL )
1541 return( PSA_ERROR_NOT_SUPPORTED );
1542 method = ( export_public_key ?
1543 drv->key_management->p_export_public :
1544 drv->key_management->p_export );
1545 if( method == NULL )
1546 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine2e0f3882019-07-25 11:34:33 +02001547 return( method( drv_context,
1548 slot->data.se.slot_number,
1549 data, data_size, data_length ) );
Gilles Peskine5d309672019-07-12 23:47:28 +02001550 }
1551#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1552
Gilles Peskine8e338702019-07-30 20:06:31 +02001553 if( key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001554 {
Steven Cooremanacda8342020-07-24 23:09:52 +02001555 return( psa_internal_export_key_buffer( slot, data, data_size, data_length ) );
Gilles Peskine188c71e2018-10-29 19:26:02 +01001556 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001557 else if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) ||
1558 PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
Moran Peker17e36e12018-05-02 12:55:20 +03001559 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001560 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Gilles Peskine969ac722018-01-28 18:16:59 +01001561 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001562 /* Exporting public -> public */
1563 return( psa_internal_export_key_buffer( slot, data, data_size, data_length ) );
1564 }
1565 else if( !export_public_key )
1566 {
1567 /* Exporting private -> private */
1568 return( psa_internal_export_key_buffer( slot, data, data_size, data_length ) );
1569 }
1570 /* Need to export the public part of a private key,
1571 * so conversion is needed */
1572 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
1573 {
Darryl Green9e2d7a02018-07-24 16:33:30 +01001574#if defined(MBEDTLS_RSA_C)
Steven Cooremana2371e52020-07-28 14:30:39 +02001575 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman7f391872020-07-30 14:57:44 +02001576 psa_status_t status = psa_load_rsa_representation(
Steven Cooreman4fed4552020-08-03 14:46:03 +02001577 slot->attr.type,
Steven Cooreman7f391872020-07-30 14:57:44 +02001578 slot->data.key.data,
1579 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02001580 &rsa );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001581 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001582 return( status );
Steven Cooremana01795d2020-07-24 22:48:15 +02001583
Steven Cooreman560c28a2020-07-24 23:20:24 +02001584 status = psa_export_rsa_key( PSA_KEY_TYPE_RSA_PUBLIC_KEY,
Steven Cooremana2371e52020-07-28 14:30:39 +02001585 rsa,
Steven Cooreman560c28a2020-07-24 23:20:24 +02001586 data,
1587 data_size,
1588 data_length );
Steven Cooremana01795d2020-07-24 22:48:15 +02001589
Steven Cooremana2371e52020-07-28 14:30:39 +02001590 mbedtls_rsa_free( rsa );
1591 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001592
Steven Cooreman560c28a2020-07-24 23:20:24 +02001593 return( status );
Darryl Green9e2d7a02018-07-24 16:33:30 +01001594#else
Steven Cooreman560c28a2020-07-24 23:20:24 +02001595 /* We don't know how to convert a private RSA key to public. */
1596 return( PSA_ERROR_NOT_SUPPORTED );
Darryl Green9e2d7a02018-07-24 16:33:30 +01001597#endif
Gilles Peskine969ac722018-01-28 18:16:59 +01001598 }
1599 else
Moran Pekera998bc62018-04-16 18:16:20 +03001600 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001601#if defined(MBEDTLS_ECP_C)
Steven Cooremana2371e52020-07-28 14:30:39 +02001602 mbedtls_ecp_keypair *ecp = NULL;
Steven Cooreman7f391872020-07-30 14:57:44 +02001603 psa_status_t status = psa_load_ecp_representation(
Steven Cooreman4fed4552020-08-03 14:46:03 +02001604 slot->attr.type,
Steven Cooreman7f391872020-07-30 14:57:44 +02001605 slot->data.key.data,
1606 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02001607 &ecp );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001608 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001609 return( status );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001610
1611 status = psa_export_ecp_key( PSA_KEY_TYPE_ECC_PUBLIC_KEY(
1612 PSA_KEY_TYPE_ECC_GET_FAMILY(
1613 slot->attr.type ) ),
Steven Cooremana2371e52020-07-28 14:30:39 +02001614 ecp,
Steven Cooreman560c28a2020-07-24 23:20:24 +02001615 data,
1616 data_size,
1617 data_length );
1618
Steven Cooremana2371e52020-07-28 14:30:39 +02001619 mbedtls_ecp_keypair_free( ecp );
1620 mbedtls_free( ecp );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001621 return( status );
1622#else
1623 /* We don't know how to convert a private ECC key to public */
Moran Pekera998bc62018-04-16 18:16:20 +03001624 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001625#endif
Moran Pekera998bc62018-04-16 18:16:20 +03001626 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001627 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001628 else
1629 {
1630 /* This shouldn't happen in the reference implementation, but
1631 it is valid for a special-purpose implementation to omit
1632 support for exporting certain key types. */
1633 return( PSA_ERROR_NOT_SUPPORTED );
1634 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001635}
1636
Gilles Peskinec5487a82018-12-03 18:08:14 +01001637psa_status_t psa_export_key( psa_key_handle_t handle,
Gilles Peskine2d277862018-06-18 15:41:12 +02001638 uint8_t *data,
1639 size_t data_size,
1640 size_t *data_length )
Moran Pekera998bc62018-04-16 18:16:20 +03001641{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001642 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001643 psa_status_t status;
1644
1645 /* Set the key to empty now, so that even when there are errors, we always
1646 * set data_length to a value between 0 and data_size. On error, setting
1647 * the key to empty is a good choice because an empty key representation is
1648 * unlikely to be accepted anywhere. */
1649 *data_length = 0;
1650
1651 /* Export requires the EXPORT flag. There is an exception for public keys,
1652 * which don't require any flag, but psa_get_key_from_slot takes
1653 * care of this. */
Gilles Peskinec5487a82018-12-03 18:08:14 +01001654 status = psa_get_key_from_slot( handle, &slot, PSA_KEY_USAGE_EXPORT, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001655 if( status != PSA_SUCCESS )
1656 return( status );
1657 return( psa_internal_export_key( slot, data, data_size,
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02001658 data_length, 0 ) );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001659}
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001660
Gilles Peskinec5487a82018-12-03 18:08:14 +01001661psa_status_t psa_export_public_key( psa_key_handle_t handle,
Gilles Peskine2d277862018-06-18 15:41:12 +02001662 uint8_t *data,
1663 size_t data_size,
1664 size_t *data_length )
Moran Pekerdd4ea382018-04-03 15:30:03 +03001665{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001666 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001667 psa_status_t status;
1668
1669 /* Set the key to empty now, so that even when there are errors, we always
1670 * set data_length to a value between 0 and data_size. On error, setting
1671 * the key to empty is a good choice because an empty key representation is
1672 * unlikely to be accepted anywhere. */
1673 *data_length = 0;
1674
1675 /* Exporting a public key doesn't require a usage flag. */
Gilles Peskinec5487a82018-12-03 18:08:14 +01001676 status = psa_get_key_from_slot( handle, &slot, 0, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001677 if( status != PSA_SUCCESS )
1678 return( status );
1679 return( psa_internal_export_key( slot, data, data_size,
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02001680 data_length, 1 ) );
Moran Pekerdd4ea382018-04-03 15:30:03 +03001681}
1682
Gilles Peskine91e8c332019-08-02 19:19:39 +02001683#if defined(static_assert)
1684static_assert( ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
1685 "One or more key attribute flag is listed as both external-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001686static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
Gilles Peskine094dac12019-08-07 18:19:46 +02001687 "One or more key attribute flag is listed as both internal-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001688static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY ) == 0,
Gilles Peskine91e8c332019-08-02 19:19:39 +02001689 "One or more key attribute flag is listed as both internal-only and external-only" );
1690#endif
1691
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001692/** Validate that a key policy is internally well-formed.
1693 *
1694 * This function only rejects invalid policies. It does not validate the
1695 * consistency of the policy with respect to other attributes of the key
1696 * such as the key type.
1697 */
1698static psa_status_t psa_validate_key_policy( const psa_key_policy_t *policy )
Gilles Peskine4747d192019-04-17 15:05:45 +02001699{
1700 if( ( policy->usage & ~( PSA_KEY_USAGE_EXPORT |
Gilles Peskine8e0206a2019-05-14 14:24:28 +02001701 PSA_KEY_USAGE_COPY |
Gilles Peskine4747d192019-04-17 15:05:45 +02001702 PSA_KEY_USAGE_ENCRYPT |
1703 PSA_KEY_USAGE_DECRYPT |
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001704 PSA_KEY_USAGE_SIGN_HASH |
1705 PSA_KEY_USAGE_VERIFY_HASH |
Gilles Peskine4747d192019-04-17 15:05:45 +02001706 PSA_KEY_USAGE_DERIVE ) ) != 0 )
1707 return( PSA_ERROR_INVALID_ARGUMENT );
1708
Gilles Peskine4747d192019-04-17 15:05:45 +02001709 return( PSA_SUCCESS );
1710}
1711
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001712/** Validate the internal consistency of key attributes.
1713 *
1714 * This function only rejects invalid attribute values. If does not
1715 * validate the consistency of the attributes with any key data that may
1716 * be involved in the creation of the key.
1717 *
1718 * Call this function early in the key creation process.
1719 *
1720 * \param[in] attributes Key attributes for the new key.
1721 * \param[out] p_drv On any return, the driver for the key, if any.
1722 * NULL for a transparent key.
1723 *
1724 */
1725static psa_status_t psa_validate_key_attributes(
1726 const psa_key_attributes_t *attributes,
1727 psa_se_drv_table_entry_t **p_drv )
Darryl Green0c6575a2018-11-07 16:05:30 +00001728{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001729 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001730
Steven Cooreman8c1e7592020-06-17 14:52:05 +02001731 status = psa_validate_key_location( psa_get_key_lifetime( attributes ),
1732 p_drv );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001733 if( status != PSA_SUCCESS )
1734 return( status );
1735
Steven Cooreman8c1e7592020-06-17 14:52:05 +02001736 status = psa_validate_key_persistence( psa_get_key_lifetime( attributes ),
1737 psa_get_key_id( attributes ) );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001738 if( status != PSA_SUCCESS )
1739 return( status );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001740
1741 status = psa_validate_key_policy( &attributes->core.policy );
Darryl Green0c6575a2018-11-07 16:05:30 +00001742 if( status != PSA_SUCCESS )
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001743 return( status );
1744
1745 /* Refuse to create overly large keys.
1746 * Note that this doesn't trigger on import if the attributes don't
1747 * explicitly specify a size (so psa_get_key_bits returns 0), so
1748 * psa_import_key() needs its own checks. */
1749 if( psa_get_key_bits( attributes ) > PSA_MAX_KEY_BITS )
1750 return( PSA_ERROR_NOT_SUPPORTED );
1751
Gilles Peskine91e8c332019-08-02 19:19:39 +02001752 /* Reject invalid flags. These should not be reachable through the API. */
1753 if( attributes->core.flags & ~ ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1754 MBEDTLS_PSA_KA_MASK_DUAL_USE ) )
1755 return( PSA_ERROR_INVALID_ARGUMENT );
1756
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001757 return( PSA_SUCCESS );
1758}
1759
Gilles Peskine4747d192019-04-17 15:05:45 +02001760/** Prepare a key slot to receive key material.
1761 *
1762 * This function allocates a key slot and sets its metadata.
1763 *
1764 * If this function fails, call psa_fail_key_creation().
1765 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001766 * This function is intended to be used as follows:
1767 * -# Call psa_start_key_creation() to allocate a key slot, prepare
1768 * it with the specified attributes, and assign it a handle.
1769 * -# Populate the slot with the key material.
1770 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1771 * In case of failure at any step, stop the sequence and call
1772 * psa_fail_key_creation().
1773 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001774 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001775 * \param[in] attributes Key attributes for the new key.
1776 * \param[out] handle On success, a handle for the allocated slot.
1777 * \param[out] p_slot On success, a pointer to the prepared slot.
1778 * \param[out] p_drv On any return, the driver for the key, if any.
1779 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001780 *
1781 * \retval #PSA_SUCCESS
1782 * The key slot is ready to receive key material.
1783 * \return If this function fails, the key slot is an invalid state.
1784 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001785 */
1786static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001787 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001788 const psa_key_attributes_t *attributes,
1789 psa_key_handle_t *handle,
Gilles Peskine011e4282019-06-26 18:34:38 +02001790 psa_key_slot_t **p_slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001791 psa_se_drv_table_entry_t **p_drv )
Gilles Peskine4747d192019-04-17 15:05:45 +02001792{
1793 psa_status_t status;
1794 psa_key_slot_t *slot;
1795
Gilles Peskinedf179142019-07-15 22:02:14 +02001796 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001797 *p_drv = NULL;
1798
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001799 status = psa_validate_key_attributes( attributes, p_drv );
1800 if( status != PSA_SUCCESS )
1801 return( status );
1802
Gilles Peskineedbed562019-08-07 18:19:59 +02001803 status = psa_get_empty_key_slot( handle, p_slot );
Gilles Peskine4747d192019-04-17 15:05:45 +02001804 if( status != PSA_SUCCESS )
1805 return( status );
1806 slot = *p_slot;
1807
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001808 /* We're storing the declared bit-size of the key. It's up to each
1809 * creation mechanism to verify that this information is correct.
1810 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001811 * an input (generate, device) but not for those where the bit-size
1812 * is optional (import, copy). */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001813
1814 slot->attr = attributes->core;
Gilles Peskinec744d992019-07-30 17:26:54 +02001815
Gilles Peskine91e8c332019-08-02 19:19:39 +02001816 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001817 * external-only flags, query `attributes`. Thanks to the check
1818 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001819 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001820 * may have set. */
1821 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001822
Gilles Peskinecbaff462019-07-12 23:46:04 +02001823#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001824 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001825 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001826 * create the key file in internal storage, create the
1827 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001828 * persistent data. This is done by starting a transaction that will
1829 * encompass these three actions.
1830 * For registering a volatile key, we just need to find an appropriate
1831 * slot number inside the SE. Since the key is designated volatile, creating
1832 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001833 /* The first thing to do is to find a slot number for the new key.
1834 * We save the slot number in persistent storage as part of the
1835 * transaction data. It will be needed to recover if the power
1836 * fails during the key creation process, to clean up on the secure
1837 * element side after restarting. Obtaining a slot number from the
1838 * secure element driver updates its persistent state, but we do not yet
1839 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001840 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001841 if( *p_drv != NULL )
Darryl Green0c6575a2018-11-07 16:05:30 +00001842 {
Gilles Peskinee88c2c12019-08-05 16:44:14 +02001843 status = psa_find_se_slot_for_key( attributes, method, *p_drv,
Gilles Peskinecbaff462019-07-12 23:46:04 +02001844 &slot->data.se.slot_number );
1845 if( status != PSA_SUCCESS )
1846 return( status );
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001847
1848 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( attributes->core.lifetime ) )
Gilles Peskine66be51c2019-07-25 18:02:52 +02001849 {
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001850 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_CREATE_KEY );
1851 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
1852 psa_crypto_transaction.key.slot = slot->data.se.slot_number;
1853 psa_crypto_transaction.key.id = slot->attr.id;
1854 status = psa_crypto_save_transaction( );
1855 if( status != PSA_SUCCESS )
1856 {
1857 (void) psa_crypto_stop_transaction( );
1858 return( status );
1859 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001860 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001861 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001862
1863 if( *p_drv == NULL && method == PSA_KEY_CREATION_REGISTER )
1864 {
1865 /* Key registration only makes sense with a secure element. */
1866 return( PSA_ERROR_INVALID_ARGUMENT );
1867 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001868#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1869
Darryl Green0c6575a2018-11-07 16:05:30 +00001870 return( status );
1871}
Gilles Peskine4747d192019-04-17 15:05:45 +02001872
1873/** Finalize the creation of a key once its key material has been set.
1874 *
1875 * This entails writing the key to persistent storage.
1876 *
1877 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001878 * See the documentation of psa_start_key_creation() for the intended use
1879 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001880 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001881 * \param[in,out] slot Pointer to the slot with key material.
1882 * \param[in] driver The secure element driver for the key,
1883 * or NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001884 *
1885 * \retval #PSA_SUCCESS
1886 * The key was successfully created. The handle is now valid.
1887 * \return If this function fails, the key slot is an invalid state.
1888 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001889 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001890static psa_status_t psa_finish_key_creation(
1891 psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001892 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001893{
1894 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001895 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001896 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001897
1898#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Steven Cooremanc59de6a2020-06-08 18:28:25 +02001899 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Gilles Peskine4747d192019-04-17 15:05:45 +02001900 {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001901#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1902 if( driver != NULL )
1903 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001904 psa_se_key_data_storage_t data;
1905#if defined(static_assert)
1906 static_assert( sizeof( slot->data.se.slot_number ) ==
1907 sizeof( data.slot_number ),
1908 "Slot number size does not match psa_se_key_data_storage_t" );
1909 static_assert( sizeof( slot->attr.bits ) == sizeof( data.bits ),
1910 "Bit-size size does not match psa_se_key_data_storage_t" );
1911#endif
1912 memcpy( &data.slot_number, &slot->data.se.slot_number,
1913 sizeof( slot->data.se.slot_number ) );
1914 memcpy( &data.bits, &slot->attr.bits,
1915 sizeof( slot->attr.bits ) );
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001916 status = psa_save_persistent_key( &slot->attr,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001917 (uint8_t*) &data,
1918 sizeof( data ) );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001919 }
1920 else
1921#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1922 {
Gilles Peskinee60d1d02019-07-24 20:27:59 +02001923 size_t buffer_size =
Gilles Peskine8e338702019-07-30 20:06:31 +02001924 PSA_KEY_EXPORT_MAX_SIZE( slot->attr.type,
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001925 slot->attr.bits );
Gilles Peskinee60d1d02019-07-24 20:27:59 +02001926 uint8_t *buffer = mbedtls_calloc( 1, buffer_size );
1927 size_t length = 0;
Gilles Peskinef9168942019-09-12 19:20:29 +02001928 if( buffer == NULL )
Gilles Peskine1df83d42019-07-23 16:13:14 +02001929 return( PSA_ERROR_INSUFFICIENT_MEMORY );
1930 status = psa_internal_export_key( slot,
1931 buffer, buffer_size, &length,
1932 0 );
Gilles Peskinee60d1d02019-07-24 20:27:59 +02001933 if( status == PSA_SUCCESS )
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001934 status = psa_save_persistent_key( &slot->attr,
Gilles Peskine4ed0e6f2019-07-30 20:22:33 +02001935 buffer, length );
Gilles Peskine4747d192019-04-17 15:05:45 +02001936
Gilles Peskinef9168942019-09-12 19:20:29 +02001937 mbedtls_platform_zeroize( buffer, buffer_size );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001938 mbedtls_free( buffer );
1939 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001940 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001941#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1942
Gilles Peskinecbaff462019-07-12 23:46:04 +02001943#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001944 /* Finish the transaction for a key creation. This does not
1945 * happen when registering an existing key. Detect this case
1946 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001947 * creation of a persistent key in a secure element requires a transaction,
1948 * but registration or volatile key creation doesn't use one). */
Gilles Peskined7729582019-08-05 15:55:54 +02001949 if( driver != NULL &&
1950 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY )
Gilles Peskinecbaff462019-07-12 23:46:04 +02001951 {
1952 status = psa_save_se_persistent_data( driver );
1953 if( status != PSA_SUCCESS )
1954 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001955 psa_destroy_persistent_key( slot->attr.id );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001956 return( status );
1957 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001958 status = psa_crypto_stop_transaction( );
1959 if( status != PSA_SUCCESS )
1960 return( status );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001961 }
1962#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1963
Gilles Peskine4747d192019-04-17 15:05:45 +02001964 return( status );
1965}
1966
1967/** Abort the creation of a key.
1968 *
1969 * You may call this function after calling psa_start_key_creation(),
1970 * or after psa_finish_key_creation() fails. In other circumstances, this
1971 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001972 * See the documentation of psa_start_key_creation() for the intended use
1973 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001974 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001975 * \param[in,out] slot Pointer to the slot with key material.
1976 * \param[in] driver The secure element driver for the key,
1977 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001978 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001979static void psa_fail_key_creation( psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001980 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001981{
Gilles Peskine011e4282019-06-26 18:34:38 +02001982 (void) driver;
1983
Gilles Peskine4747d192019-04-17 15:05:45 +02001984 if( slot == NULL )
1985 return;
Gilles Peskine011e4282019-06-26 18:34:38 +02001986
1987#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001988 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001989 * element, and the failure happened later (when saving metadata
1990 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001991 * element.
1992 * https://github.com/ARMmbed/mbed-crypto/issues/217
1993 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001994
Gilles Peskined7729582019-08-05 15:55:54 +02001995 /* Abort the ongoing transaction if any (there may not be one if
1996 * the creation process failed before starting one, or if the
1997 * key creation is a registration of a key in a secure element).
1998 * Earlier functions must already have done what it takes to undo any
1999 * partial creation. All that's left is to update the transaction data
2000 * itself. */
Gilles Peskinefc762652019-07-22 19:30:34 +02002001 (void) psa_crypto_stop_transaction( );
Gilles Peskine011e4282019-06-26 18:34:38 +02002002#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2003
Gilles Peskine4747d192019-04-17 15:05:45 +02002004 psa_wipe_key_slot( slot );
2005}
2006
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002007/** Validate optional attributes during key creation.
2008 *
2009 * Some key attributes are optional during key creation. If they are
2010 * specified in the attributes structure, check that they are consistent
2011 * with the data in the slot.
2012 *
2013 * This function should be called near the end of key creation, after
2014 * the slot in memory is fully populated but before saving persistent data.
2015 */
2016static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002017 const psa_key_slot_t *slot,
2018 const psa_key_attributes_t *attributes )
2019{
Gilles Peskine7e0cff92019-07-30 13:48:52 +02002020 if( attributes->core.type != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002021 {
Gilles Peskine8e338702019-07-30 20:06:31 +02002022 if( attributes->core.type != slot->attr.type )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002023 return( PSA_ERROR_INVALID_ARGUMENT );
2024 }
2025
2026 if( attributes->domain_parameters_size != 0 )
2027 {
2028#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02002029 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002030 {
Steven Cooremana2371e52020-07-28 14:30:39 +02002031 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02002032 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02002033 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02002034
Steven Cooreman7f391872020-07-30 14:57:44 +02002035 psa_status_t status = psa_load_rsa_representation(
Steven Cooreman4fed4552020-08-03 14:46:03 +02002036 slot->attr.type,
Steven Cooreman7f391872020-07-30 14:57:44 +02002037 slot->data.key.data,
2038 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02002039 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02002040 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02002041 return( status );
Steven Cooreman75b74362020-07-28 14:30:13 +02002042
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002043 mbedtls_mpi_init( &actual );
2044 mbedtls_mpi_init( &required );
Steven Cooremana2371e52020-07-28 14:30:39 +02002045 ret = mbedtls_rsa_export( rsa,
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002046 NULL, NULL, NULL, NULL, &actual );
Steven Cooremana2371e52020-07-28 14:30:39 +02002047 mbedtls_rsa_free( rsa );
2048 mbedtls_free( rsa );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002049 if( ret != 0 )
2050 goto rsa_exit;
2051 ret = mbedtls_mpi_read_binary( &required,
2052 attributes->domain_parameters,
2053 attributes->domain_parameters_size );
2054 if( ret != 0 )
2055 goto rsa_exit;
2056 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
2057 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
2058 rsa_exit:
2059 mbedtls_mpi_free( &actual );
2060 mbedtls_mpi_free( &required );
2061 if( ret != 0)
2062 return( mbedtls_to_psa_error( ret ) );
2063 }
2064 else
2065#endif
2066 {
2067 return( PSA_ERROR_INVALID_ARGUMENT );
2068 }
2069 }
2070
Gilles Peskine7e0cff92019-07-30 13:48:52 +02002071 if( attributes->core.bits != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002072 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02002073 if( attributes->core.bits != slot->attr.bits )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002074 return( PSA_ERROR_INVALID_ARGUMENT );
2075 }
2076
2077 return( PSA_SUCCESS );
2078}
2079
Gilles Peskine4747d192019-04-17 15:05:45 +02002080psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02002081 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02002082 size_t data_length,
2083 psa_key_handle_t *handle )
Gilles Peskine4747d192019-04-17 15:05:45 +02002084{
2085 psa_status_t status;
2086 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002087 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002088
Gilles Peskine0f84d622019-09-12 19:03:13 +02002089 /* Reject zero-length symmetric keys (including raw data key objects).
2090 * This also rejects any key which might be encoded as an empty string,
2091 * which is never valid. */
2092 if( data_length == 0 )
2093 return( PSA_ERROR_INVALID_ARGUMENT );
2094
Gilles Peskinedf179142019-07-15 22:02:14 +02002095 status = psa_start_key_creation( PSA_KEY_CREATION_IMPORT, attributes,
2096 handle, &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002097 if( status != PSA_SUCCESS )
2098 goto exit;
2099
Gilles Peskine5d309672019-07-12 23:47:28 +02002100#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2101 if( driver != NULL )
2102 {
2103 const psa_drv_se_t *drv = psa_get_se_driver_methods( driver );
Darryl Green0892d0f2019-08-20 09:50:14 +01002104 /* The driver should set the number of key bits, however in
2105 * case it doesn't, we initialize bits to an invalid value. */
2106 size_t bits = PSA_MAX_KEY_BITS + 1;
Gilles Peskine5d309672019-07-12 23:47:28 +02002107 if( drv->key_management == NULL ||
2108 drv->key_management->p_import == NULL )
2109 {
2110 status = PSA_ERROR_NOT_SUPPORTED;
2111 goto exit;
2112 }
2113 status = drv->key_management->p_import(
2114 psa_get_se_driver_context( driver ),
Gilles Peskinef3801ff2019-08-06 17:32:04 +02002115 slot->data.se.slot_number, attributes, data, data_length,
Gilles Peskineb46bef22019-07-30 21:32:04 +02002116 &bits );
2117 if( status != PSA_SUCCESS )
2118 goto exit;
2119 if( bits > PSA_MAX_KEY_BITS )
2120 {
2121 status = PSA_ERROR_NOT_SUPPORTED;
2122 goto exit;
2123 }
2124 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskine5d309672019-07-12 23:47:28 +02002125 }
2126 else
2127#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2128 {
2129 status = psa_import_key_into_slot( slot, data, data_length );
2130 if( status != PSA_SUCCESS )
2131 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02002132 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002133 status = psa_validate_optional_attributes( slot, attributes );
Gilles Peskine18017402019-07-24 20:25:59 +02002134 if( status != PSA_SUCCESS )
2135 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002136
Gilles Peskine011e4282019-06-26 18:34:38 +02002137 status = psa_finish_key_creation( slot, driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002138exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02002139 if( status != PSA_SUCCESS )
2140 {
Gilles Peskine011e4282019-06-26 18:34:38 +02002141 psa_fail_key_creation( slot, driver );
Gilles Peskine4747d192019-04-17 15:05:45 +02002142 *handle = 0;
2143 }
2144 return( status );
2145}
2146
Gilles Peskined7729582019-08-05 15:55:54 +02002147#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2148psa_status_t mbedtls_psa_register_se_key(
2149 const psa_key_attributes_t *attributes )
2150{
2151 psa_status_t status;
2152 psa_key_slot_t *slot = NULL;
2153 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskined7729582019-08-05 15:55:54 +02002154 psa_key_handle_t handle = 0;
2155
2156 /* Leaving attributes unspecified is not currently supported.
2157 * It could make sense to query the key type and size from the
2158 * secure element, but not all secure elements support this
2159 * and the driver HAL doesn't currently support it. */
2160 if( psa_get_key_type( attributes ) == PSA_KEY_TYPE_NONE )
2161 return( PSA_ERROR_NOT_SUPPORTED );
2162 if( psa_get_key_bits( attributes ) == 0 )
2163 return( PSA_ERROR_NOT_SUPPORTED );
2164
2165 status = psa_start_key_creation( PSA_KEY_CREATION_REGISTER, attributes,
2166 &handle, &slot, &driver );
2167 if( status != PSA_SUCCESS )
2168 goto exit;
2169
Gilles Peskined7729582019-08-05 15:55:54 +02002170 status = psa_finish_key_creation( slot, driver );
2171
2172exit:
2173 if( status != PSA_SUCCESS )
2174 {
2175 psa_fail_key_creation( slot, driver );
2176 }
2177 /* Registration doesn't keep the key in RAM. */
2178 psa_close_key( handle );
2179 return( status );
2180}
2181#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2182
Gilles Peskinef603c712019-01-19 13:40:11 +01002183static psa_status_t psa_copy_key_material( const psa_key_slot_t *source,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002184 psa_key_slot_t *target )
Gilles Peskinef603c712019-01-19 13:40:11 +01002185{
2186 psa_status_t status;
2187 uint8_t *buffer = NULL;
2188 size_t buffer_size = 0;
2189 size_t length;
2190
Gilles Peskine8e338702019-07-30 20:06:31 +02002191 buffer_size = PSA_KEY_EXPORT_MAX_SIZE( source->attr.type,
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02002192 psa_get_key_slot_bits( source ) );
Gilles Peskinef603c712019-01-19 13:40:11 +01002193 buffer = mbedtls_calloc( 1, buffer_size );
Gilles Peskinef9168942019-09-12 19:20:29 +02002194 if( buffer == NULL )
Gilles Peskine122d0022019-01-23 10:55:43 +01002195 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Gilles Peskinef603c712019-01-19 13:40:11 +01002196 status = psa_internal_export_key( source, buffer, buffer_size, &length, 0 );
2197 if( status != PSA_SUCCESS )
2198 goto exit;
Gilles Peskine8e338702019-07-30 20:06:31 +02002199 target->attr.type = source->attr.type;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002200 status = psa_import_key_into_slot( target, buffer, length );
Gilles Peskinef603c712019-01-19 13:40:11 +01002201
2202exit:
Gilles Peskinef9168942019-09-12 19:20:29 +02002203 mbedtls_platform_zeroize( buffer, buffer_size );
Gilles Peskine122d0022019-01-23 10:55:43 +01002204 mbedtls_free( buffer );
Gilles Peskinef603c712019-01-19 13:40:11 +01002205 return( status );
2206}
2207
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002208psa_status_t psa_copy_key( psa_key_handle_t source_handle,
2209 const psa_key_attributes_t *specified_attributes,
2210 psa_key_handle_t *target_handle )
Gilles Peskinef603c712019-01-19 13:40:11 +01002211{
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002212 psa_status_t status;
Gilles Peskinef603c712019-01-19 13:40:11 +01002213 psa_key_slot_t *source_slot = NULL;
2214 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002215 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002216 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskinef603c712019-01-19 13:40:11 +01002217
Gilles Peskine28f8f302019-07-24 13:30:31 +02002218 status = psa_get_transparent_key( source_handle, &source_slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02002219 PSA_KEY_USAGE_COPY, 0 );
Gilles Peskinef603c712019-01-19 13:40:11 +01002220 if( status != PSA_SUCCESS )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002221 goto exit;
2222
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002223 status = psa_validate_optional_attributes( source_slot,
2224 specified_attributes );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002225 if( status != PSA_SUCCESS )
2226 goto exit;
2227
Gilles Peskine7e0cff92019-07-30 13:48:52 +02002228 status = psa_restrict_key_policy( &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02002229 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002230 if( status != PSA_SUCCESS )
2231 goto exit;
2232
Gilles Peskinedf179142019-07-15 22:02:14 +02002233 status = psa_start_key_creation( PSA_KEY_CREATION_COPY,
2234 &actual_attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02002235 target_handle, &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002236 if( status != PSA_SUCCESS )
2237 goto exit;
2238
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002239#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2240 if( driver != NULL )
Gilles Peskinef603c712019-01-19 13:40:11 +01002241 {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002242 /* Copying to a secure element is not implemented yet. */
2243 status = PSA_ERROR_NOT_SUPPORTED;
2244 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002245 }
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002246#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef603c712019-01-19 13:40:11 +01002247
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002248 status = psa_copy_key_material( source_slot, target_slot );
Gilles Peskinef603c712019-01-19 13:40:11 +01002249 if( status != PSA_SUCCESS )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002250 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002251
Gilles Peskine011e4282019-06-26 18:34:38 +02002252 status = psa_finish_key_creation( target_slot, driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002253exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002254 if( status != PSA_SUCCESS )
2255 {
Gilles Peskine011e4282019-06-26 18:34:38 +02002256 psa_fail_key_creation( target_slot, driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002257 *target_handle = 0;
2258 }
2259 return( status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002260}
2261
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002262
2263
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002264/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002265/* Message digests */
2266/****************************************************************/
2267
Gilles Peskineb16841e2019-10-10 20:36:12 +02002268#if defined(MBEDTLS_RSA_C) || defined(MBEDTLS_ECDSA_DETERMINISTIC)
Gilles Peskinedc2fc842018-03-07 16:42:59 +01002269static const mbedtls_md_info_t *mbedtls_md_info_from_psa( psa_algorithm_t alg )
Gilles Peskine20035e32018-02-03 22:44:14 +01002270{
2271 switch( alg )
2272 {
2273#if defined(MBEDTLS_MD2_C)
2274 case PSA_ALG_MD2:
2275 return( &mbedtls_md2_info );
2276#endif
2277#if defined(MBEDTLS_MD4_C)
2278 case PSA_ALG_MD4:
2279 return( &mbedtls_md4_info );
2280#endif
2281#if defined(MBEDTLS_MD5_C)
2282 case PSA_ALG_MD5:
2283 return( &mbedtls_md5_info );
2284#endif
2285#if defined(MBEDTLS_RIPEMD160_C)
2286 case PSA_ALG_RIPEMD160:
2287 return( &mbedtls_ripemd160_info );
2288#endif
2289#if defined(MBEDTLS_SHA1_C)
2290 case PSA_ALG_SHA_1:
2291 return( &mbedtls_sha1_info );
2292#endif
2293#if defined(MBEDTLS_SHA256_C)
2294 case PSA_ALG_SHA_224:
2295 return( &mbedtls_sha224_info );
2296 case PSA_ALG_SHA_256:
2297 return( &mbedtls_sha256_info );
2298#endif
2299#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnardd6020842019-07-17 16:28:21 +02002300#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine20035e32018-02-03 22:44:14 +01002301 case PSA_ALG_SHA_384:
2302 return( &mbedtls_sha384_info );
Manuel Pégourié-Gonnardd6020842019-07-17 16:28:21 +02002303#endif
Gilles Peskine20035e32018-02-03 22:44:14 +01002304 case PSA_ALG_SHA_512:
2305 return( &mbedtls_sha512_info );
2306#endif
2307 default:
2308 return( NULL );
2309 }
2310}
Gilles Peskineb16841e2019-10-10 20:36:12 +02002311#endif
Gilles Peskine20035e32018-02-03 22:44:14 +01002312
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002313psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
2314{
2315 switch( operation->alg )
2316 {
Gilles Peskine81736312018-06-26 15:04:31 +02002317 case 0:
2318 /* The object has (apparently) been initialized but it is not
2319 * in use. It's ok to call abort on such an object, and there's
2320 * nothing to do. */
2321 break;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002322#if defined(MBEDTLS_MD2_C)
2323 case PSA_ALG_MD2:
2324 mbedtls_md2_free( &operation->ctx.md2 );
2325 break;
2326#endif
2327#if defined(MBEDTLS_MD4_C)
2328 case PSA_ALG_MD4:
2329 mbedtls_md4_free( &operation->ctx.md4 );
2330 break;
2331#endif
2332#if defined(MBEDTLS_MD5_C)
2333 case PSA_ALG_MD5:
2334 mbedtls_md5_free( &operation->ctx.md5 );
2335 break;
2336#endif
2337#if defined(MBEDTLS_RIPEMD160_C)
2338 case PSA_ALG_RIPEMD160:
2339 mbedtls_ripemd160_free( &operation->ctx.ripemd160 );
2340 break;
2341#endif
2342#if defined(MBEDTLS_SHA1_C)
2343 case PSA_ALG_SHA_1:
2344 mbedtls_sha1_free( &operation->ctx.sha1 );
2345 break;
2346#endif
2347#if defined(MBEDTLS_SHA256_C)
2348 case PSA_ALG_SHA_224:
2349 case PSA_ALG_SHA_256:
2350 mbedtls_sha256_free( &operation->ctx.sha256 );
2351 break;
2352#endif
2353#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002354#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002355 case PSA_ALG_SHA_384:
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002356#endif
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002357 case PSA_ALG_SHA_512:
2358 mbedtls_sha512_free( &operation->ctx.sha512 );
2359 break;
2360#endif
2361 default:
Gilles Peskinef9c2c092018-06-21 16:57:07 +02002362 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002363 }
2364 operation->alg = 0;
2365 return( PSA_SUCCESS );
2366}
2367
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002368psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002369 psa_algorithm_t alg )
2370{
Janos Follath24eed8d2019-11-22 13:21:35 +00002371 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002372
2373 /* A context must be freshly initialized before it can be set up. */
2374 if( operation->alg != 0 )
2375 {
2376 return( PSA_ERROR_BAD_STATE );
2377 }
2378
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002379 switch( alg )
2380 {
2381#if defined(MBEDTLS_MD2_C)
2382 case PSA_ALG_MD2:
2383 mbedtls_md2_init( &operation->ctx.md2 );
2384 ret = mbedtls_md2_starts_ret( &operation->ctx.md2 );
2385 break;
2386#endif
2387#if defined(MBEDTLS_MD4_C)
2388 case PSA_ALG_MD4:
2389 mbedtls_md4_init( &operation->ctx.md4 );
2390 ret = mbedtls_md4_starts_ret( &operation->ctx.md4 );
2391 break;
2392#endif
2393#if defined(MBEDTLS_MD5_C)
2394 case PSA_ALG_MD5:
2395 mbedtls_md5_init( &operation->ctx.md5 );
2396 ret = mbedtls_md5_starts_ret( &operation->ctx.md5 );
2397 break;
2398#endif
2399#if defined(MBEDTLS_RIPEMD160_C)
2400 case PSA_ALG_RIPEMD160:
2401 mbedtls_ripemd160_init( &operation->ctx.ripemd160 );
2402 ret = mbedtls_ripemd160_starts_ret( &operation->ctx.ripemd160 );
2403 break;
2404#endif
2405#if defined(MBEDTLS_SHA1_C)
2406 case PSA_ALG_SHA_1:
2407 mbedtls_sha1_init( &operation->ctx.sha1 );
2408 ret = mbedtls_sha1_starts_ret( &operation->ctx.sha1 );
2409 break;
2410#endif
2411#if defined(MBEDTLS_SHA256_C)
2412 case PSA_ALG_SHA_224:
2413 mbedtls_sha256_init( &operation->ctx.sha256 );
2414 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 1 );
2415 break;
2416 case PSA_ALG_SHA_256:
2417 mbedtls_sha256_init( &operation->ctx.sha256 );
2418 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 0 );
2419 break;
2420#endif
2421#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002422#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002423 case PSA_ALG_SHA_384:
2424 mbedtls_sha512_init( &operation->ctx.sha512 );
2425 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 1 );
2426 break;
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002427#endif
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002428 case PSA_ALG_SHA_512:
2429 mbedtls_sha512_init( &operation->ctx.sha512 );
2430 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 0 );
2431 break;
2432#endif
2433 default:
Gilles Peskinec06e0712018-06-20 16:21:04 +02002434 return( PSA_ALG_IS_HASH( alg ) ?
2435 PSA_ERROR_NOT_SUPPORTED :
2436 PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002437 }
2438 if( ret == 0 )
2439 operation->alg = alg;
2440 else
2441 psa_hash_abort( operation );
2442 return( mbedtls_to_psa_error( ret ) );
2443}
2444
2445psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2446 const uint8_t *input,
2447 size_t input_length )
2448{
Janos Follath24eed8d2019-11-22 13:21:35 +00002449 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine94e44542018-07-12 16:58:43 +02002450
2451 /* Don't require hash implementations to behave correctly on a
2452 * zero-length input, which may have an invalid pointer. */
2453 if( input_length == 0 )
2454 return( PSA_SUCCESS );
2455
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002456 switch( operation->alg )
2457 {
2458#if defined(MBEDTLS_MD2_C)
2459 case PSA_ALG_MD2:
2460 ret = mbedtls_md2_update_ret( &operation->ctx.md2,
2461 input, input_length );
2462 break;
2463#endif
2464#if defined(MBEDTLS_MD4_C)
2465 case PSA_ALG_MD4:
2466 ret = mbedtls_md4_update_ret( &operation->ctx.md4,
2467 input, input_length );
2468 break;
2469#endif
2470#if defined(MBEDTLS_MD5_C)
2471 case PSA_ALG_MD5:
2472 ret = mbedtls_md5_update_ret( &operation->ctx.md5,
2473 input, input_length );
2474 break;
2475#endif
2476#if defined(MBEDTLS_RIPEMD160_C)
2477 case PSA_ALG_RIPEMD160:
2478 ret = mbedtls_ripemd160_update_ret( &operation->ctx.ripemd160,
2479 input, input_length );
2480 break;
2481#endif
2482#if defined(MBEDTLS_SHA1_C)
2483 case PSA_ALG_SHA_1:
2484 ret = mbedtls_sha1_update_ret( &operation->ctx.sha1,
2485 input, input_length );
2486 break;
2487#endif
2488#if defined(MBEDTLS_SHA256_C)
2489 case PSA_ALG_SHA_224:
2490 case PSA_ALG_SHA_256:
2491 ret = mbedtls_sha256_update_ret( &operation->ctx.sha256,
2492 input, input_length );
2493 break;
2494#endif
2495#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002496#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002497 case PSA_ALG_SHA_384:
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002498#endif
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002499 case PSA_ALG_SHA_512:
2500 ret = mbedtls_sha512_update_ret( &operation->ctx.sha512,
2501 input, input_length );
2502 break;
2503#endif
2504 default:
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002505 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002506 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002507
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002508 if( ret != 0 )
2509 psa_hash_abort( operation );
2510 return( mbedtls_to_psa_error( ret ) );
2511}
2512
2513psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2514 uint8_t *hash,
2515 size_t hash_size,
2516 size_t *hash_length )
2517{
itayzafrir40835d42018-08-02 13:14:17 +03002518 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00002519 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine71bb7b72018-04-19 08:29:59 +02002520 size_t actual_hash_length = PSA_HASH_SIZE( operation->alg );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002521
2522 /* Fill the output buffer with something that isn't a valid hash
2523 * (barring an attack on the hash and deliberately-crafted input),
2524 * in case the caller doesn't check the return status properly. */
Gilles Peskineaee13332018-07-02 12:15:28 +02002525 *hash_length = hash_size;
Gilles Peskine46f1fd72018-06-28 19:31:31 +02002526 /* If hash_size is 0 then hash may be NULL and then the
2527 * call to memset would have undefined behavior. */
2528 if( hash_size != 0 )
2529 memset( hash, '!', hash_size );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002530
2531 if( hash_size < actual_hash_length )
itayzafrir40835d42018-08-02 13:14:17 +03002532 {
2533 status = PSA_ERROR_BUFFER_TOO_SMALL;
2534 goto exit;
2535 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002536
2537 switch( operation->alg )
2538 {
2539#if defined(MBEDTLS_MD2_C)
2540 case PSA_ALG_MD2:
2541 ret = mbedtls_md2_finish_ret( &operation->ctx.md2, hash );
2542 break;
2543#endif
2544#if defined(MBEDTLS_MD4_C)
2545 case PSA_ALG_MD4:
2546 ret = mbedtls_md4_finish_ret( &operation->ctx.md4, hash );
2547 break;
2548#endif
2549#if defined(MBEDTLS_MD5_C)
2550 case PSA_ALG_MD5:
2551 ret = mbedtls_md5_finish_ret( &operation->ctx.md5, hash );
2552 break;
2553#endif
2554#if defined(MBEDTLS_RIPEMD160_C)
2555 case PSA_ALG_RIPEMD160:
2556 ret = mbedtls_ripemd160_finish_ret( &operation->ctx.ripemd160, hash );
2557 break;
2558#endif
2559#if defined(MBEDTLS_SHA1_C)
2560 case PSA_ALG_SHA_1:
2561 ret = mbedtls_sha1_finish_ret( &operation->ctx.sha1, hash );
2562 break;
2563#endif
2564#if defined(MBEDTLS_SHA256_C)
2565 case PSA_ALG_SHA_224:
2566 case PSA_ALG_SHA_256:
2567 ret = mbedtls_sha256_finish_ret( &operation->ctx.sha256, hash );
2568 break;
2569#endif
2570#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002571#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002572 case PSA_ALG_SHA_384:
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002573#endif
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002574 case PSA_ALG_SHA_512:
2575 ret = mbedtls_sha512_finish_ret( &operation->ctx.sha512, hash );
2576 break;
2577#endif
2578 default:
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002579 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002580 }
itayzafrir40835d42018-08-02 13:14:17 +03002581 status = mbedtls_to_psa_error( ret );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002582
itayzafrir40835d42018-08-02 13:14:17 +03002583exit:
2584 if( status == PSA_SUCCESS )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002585 {
Gilles Peskineaee13332018-07-02 12:15:28 +02002586 *hash_length = actual_hash_length;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002587 return( psa_hash_abort( operation ) );
2588 }
2589 else
2590 {
2591 psa_hash_abort( operation );
itayzafrir40835d42018-08-02 13:14:17 +03002592 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002593 }
2594}
2595
Gilles Peskine2d277862018-06-18 15:41:12 +02002596psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2597 const uint8_t *hash,
2598 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002599{
2600 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2601 size_t actual_hash_length;
2602 psa_status_t status = psa_hash_finish( operation,
2603 actual_hash, sizeof( actual_hash ),
2604 &actual_hash_length );
2605 if( status != PSA_SUCCESS )
2606 return( status );
2607 if( actual_hash_length != hash_length )
2608 return( PSA_ERROR_INVALID_SIGNATURE );
2609 if( safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
2610 return( PSA_ERROR_INVALID_SIGNATURE );
2611 return( PSA_SUCCESS );
2612}
2613
Gilles Peskine0a749c82019-11-28 19:33:58 +01002614psa_status_t psa_hash_compute( psa_algorithm_t alg,
2615 const uint8_t *input, size_t input_length,
2616 uint8_t *hash, size_t hash_size,
2617 size_t *hash_length )
2618{
2619 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
2620 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2621
2622 *hash_length = hash_size;
2623 status = psa_hash_setup( &operation, alg );
2624 if( status != PSA_SUCCESS )
2625 goto exit;
2626 status = psa_hash_update( &operation, input, input_length );
2627 if( status != PSA_SUCCESS )
2628 goto exit;
2629 status = psa_hash_finish( &operation, hash, hash_size, hash_length );
2630 if( status != PSA_SUCCESS )
2631 goto exit;
2632
2633exit:
2634 if( status == PSA_SUCCESS )
2635 status = psa_hash_abort( &operation );
2636 else
2637 psa_hash_abort( &operation );
2638 return( status );
2639}
2640
2641psa_status_t psa_hash_compare( psa_algorithm_t alg,
2642 const uint8_t *input, size_t input_length,
2643 const uint8_t *hash, size_t hash_length )
2644{
2645 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
2646 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2647
2648 status = psa_hash_setup( &operation, alg );
2649 if( status != PSA_SUCCESS )
2650 goto exit;
2651 status = psa_hash_update( &operation, input, input_length );
2652 if( status != PSA_SUCCESS )
2653 goto exit;
2654 status = psa_hash_verify( &operation, hash, hash_length );
2655 if( status != PSA_SUCCESS )
2656 goto exit;
2657
2658exit:
2659 if( status == PSA_SUCCESS )
2660 status = psa_hash_abort( &operation );
2661 else
2662 psa_hash_abort( &operation );
2663 return( status );
2664}
2665
Gilles Peskineeb35d782019-01-22 17:56:16 +01002666psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2667 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002668{
2669 if( target_operation->alg != 0 )
2670 return( PSA_ERROR_BAD_STATE );
2671
2672 switch( source_operation->alg )
2673 {
2674 case 0:
2675 return( PSA_ERROR_BAD_STATE );
2676#if defined(MBEDTLS_MD2_C)
2677 case PSA_ALG_MD2:
2678 mbedtls_md2_clone( &target_operation->ctx.md2,
2679 &source_operation->ctx.md2 );
2680 break;
2681#endif
2682#if defined(MBEDTLS_MD4_C)
2683 case PSA_ALG_MD4:
2684 mbedtls_md4_clone( &target_operation->ctx.md4,
2685 &source_operation->ctx.md4 );
2686 break;
2687#endif
2688#if defined(MBEDTLS_MD5_C)
2689 case PSA_ALG_MD5:
2690 mbedtls_md5_clone( &target_operation->ctx.md5,
2691 &source_operation->ctx.md5 );
2692 break;
2693#endif
2694#if defined(MBEDTLS_RIPEMD160_C)
2695 case PSA_ALG_RIPEMD160:
2696 mbedtls_ripemd160_clone( &target_operation->ctx.ripemd160,
2697 &source_operation->ctx.ripemd160 );
2698 break;
2699#endif
2700#if defined(MBEDTLS_SHA1_C)
2701 case PSA_ALG_SHA_1:
2702 mbedtls_sha1_clone( &target_operation->ctx.sha1,
2703 &source_operation->ctx.sha1 );
2704 break;
2705#endif
2706#if defined(MBEDTLS_SHA256_C)
2707 case PSA_ALG_SHA_224:
2708 case PSA_ALG_SHA_256:
2709 mbedtls_sha256_clone( &target_operation->ctx.sha256,
2710 &source_operation->ctx.sha256 );
2711 break;
2712#endif
2713#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002714#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002715 case PSA_ALG_SHA_384:
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002716#endif
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002717 case PSA_ALG_SHA_512:
2718 mbedtls_sha512_clone( &target_operation->ctx.sha512,
2719 &source_operation->ctx.sha512 );
2720 break;
2721#endif
2722 default:
2723 return( PSA_ERROR_NOT_SUPPORTED );
2724 }
2725
2726 target_operation->alg = source_operation->alg;
2727 return( PSA_SUCCESS );
2728}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002729
2730
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002731/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002732/* MAC */
2733/****************************************************************/
2734
Gilles Peskinedc2fc842018-03-07 16:42:59 +01002735static const mbedtls_cipher_info_t *mbedtls_cipher_info_from_psa(
Gilles Peskine8c9def32018-02-08 10:02:12 +01002736 psa_algorithm_t alg,
2737 psa_key_type_t key_type,
Gilles Peskine2d277862018-06-18 15:41:12 +02002738 size_t key_bits,
mohammad1603f4f0d612018-06-03 15:04:51 +03002739 mbedtls_cipher_id_t* cipher_id )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002740{
Gilles Peskine8c9def32018-02-08 10:02:12 +01002741 mbedtls_cipher_mode_t mode;
mohammad1603f4f0d612018-06-03 15:04:51 +03002742 mbedtls_cipher_id_t cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002743
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002744 if( PSA_ALG_IS_AEAD( alg ) )
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002745 alg = PSA_ALG_AEAD_WITH_TAG_LENGTH( alg, 0 );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002746
Gilles Peskine8c9def32018-02-08 10:02:12 +01002747 if( PSA_ALG_IS_CIPHER( alg ) || PSA_ALG_IS_AEAD( alg ) )
2748 {
Nir Sonnenscheine9664c32018-06-17 14:41:30 +03002749 switch( alg )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002750 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002751 case PSA_ALG_ARC4:
Gilles Peskine26869f22019-05-06 15:25:00 +02002752 case PSA_ALG_CHACHA20:
Gilles Peskine8c9def32018-02-08 10:02:12 +01002753 mode = MBEDTLS_MODE_STREAM;
2754 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002755 case PSA_ALG_CTR:
2756 mode = MBEDTLS_MODE_CTR;
2757 break;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002758 case PSA_ALG_CFB:
2759 mode = MBEDTLS_MODE_CFB;
2760 break;
2761 case PSA_ALG_OFB:
2762 mode = MBEDTLS_MODE_OFB;
2763 break;
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02002764 case PSA_ALG_ECB_NO_PADDING:
2765 mode = MBEDTLS_MODE_ECB;
2766 break;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002767 case PSA_ALG_CBC_NO_PADDING:
2768 mode = MBEDTLS_MODE_CBC;
2769 break;
2770 case PSA_ALG_CBC_PKCS7:
2771 mode = MBEDTLS_MODE_CBC;
2772 break;
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002773 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002774 mode = MBEDTLS_MODE_CCM;
2775 break;
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002776 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_GCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002777 mode = MBEDTLS_MODE_GCM;
2778 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02002779 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CHACHA20_POLY1305, 0 ):
2780 mode = MBEDTLS_MODE_CHACHAPOLY;
2781 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002782 default:
2783 return( NULL );
2784 }
2785 }
2786 else if( alg == PSA_ALG_CMAC )
2787 mode = MBEDTLS_MODE_ECB;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002788 else
2789 return( NULL );
2790
2791 switch( key_type )
2792 {
2793 case PSA_KEY_TYPE_AES:
mohammad1603f4f0d612018-06-03 15:04:51 +03002794 cipher_id_tmp = MBEDTLS_CIPHER_ID_AES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002795 break;
2796 case PSA_KEY_TYPE_DES:
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002797 /* key_bits is 64 for Single-DES, 128 for two-key Triple-DES,
2798 * and 192 for three-key Triple-DES. */
Gilles Peskine8c9def32018-02-08 10:02:12 +01002799 if( key_bits == 64 )
mohammad1603f4f0d612018-06-03 15:04:51 +03002800 cipher_id_tmp = MBEDTLS_CIPHER_ID_DES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002801 else
mohammad1603f4f0d612018-06-03 15:04:51 +03002802 cipher_id_tmp = MBEDTLS_CIPHER_ID_3DES;
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002803 /* mbedtls doesn't recognize two-key Triple-DES as an algorithm,
2804 * but two-key Triple-DES is functionally three-key Triple-DES
2805 * with K1=K3, so that's how we present it to mbedtls. */
2806 if( key_bits == 128 )
2807 key_bits = 192;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002808 break;
2809 case PSA_KEY_TYPE_CAMELLIA:
mohammad1603f4f0d612018-06-03 15:04:51 +03002810 cipher_id_tmp = MBEDTLS_CIPHER_ID_CAMELLIA;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002811 break;
2812 case PSA_KEY_TYPE_ARC4:
mohammad1603f4f0d612018-06-03 15:04:51 +03002813 cipher_id_tmp = MBEDTLS_CIPHER_ID_ARC4;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002814 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02002815 case PSA_KEY_TYPE_CHACHA20:
2816 cipher_id_tmp = MBEDTLS_CIPHER_ID_CHACHA20;
2817 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002818 default:
2819 return( NULL );
2820 }
mohammad1603f4f0d612018-06-03 15:04:51 +03002821 if( cipher_id != NULL )
mohammad160360a64d02018-06-03 17:20:42 +03002822 *cipher_id = cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002823
Jaeden Amero23bbb752018-06-26 14:16:54 +01002824 return( mbedtls_cipher_info_from_values( cipher_id_tmp,
2825 (int) key_bits, mode ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002826}
2827
Gilles Peskinea05219c2018-11-16 16:02:56 +01002828#if defined(MBEDTLS_MD_C)
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002829static size_t psa_get_hash_block_size( psa_algorithm_t alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002830{
Gilles Peskine2d277862018-06-18 15:41:12 +02002831 switch( alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002832 {
2833 case PSA_ALG_MD2:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002834 return( 16 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002835 case PSA_ALG_MD4:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002836 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002837 case PSA_ALG_MD5:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002838 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002839 case PSA_ALG_RIPEMD160:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002840 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002841 case PSA_ALG_SHA_1:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002842 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002843 case PSA_ALG_SHA_224:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002844 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002845 case PSA_ALG_SHA_256:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002846 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002847 case PSA_ALG_SHA_384:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002848 return( 128 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002849 case PSA_ALG_SHA_512:
Gilles Peskine2d277862018-06-18 15:41:12 +02002850 return( 128 );
2851 default:
2852 return( 0 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002853 }
2854}
Gilles Peskinea05219c2018-11-16 16:02:56 +01002855#endif /* MBEDTLS_MD_C */
Nir Sonnenschein0c9ec532018-06-07 13:27:47 +03002856
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002857/* Initialize the MAC operation structure. Once this function has been
2858 * called, psa_mac_abort can run and will do the right thing. */
2859static psa_status_t psa_mac_init( psa_mac_operation_t *operation,
2860 psa_algorithm_t alg )
2861{
2862 psa_status_t status = PSA_ERROR_NOT_SUPPORTED;
2863
2864 operation->alg = alg;
2865 operation->key_set = 0;
2866 operation->iv_set = 0;
2867 operation->iv_required = 0;
2868 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002869 operation->is_sign = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002870
2871#if defined(MBEDTLS_CMAC_C)
2872 if( alg == PSA_ALG_CMAC )
2873 {
2874 operation->iv_required = 0;
2875 mbedtls_cipher_init( &operation->ctx.cmac );
2876 status = PSA_SUCCESS;
2877 }
2878 else
2879#endif /* MBEDTLS_CMAC_C */
2880#if defined(MBEDTLS_MD_C)
2881 if( PSA_ALG_IS_HMAC( operation->alg ) )
2882 {
Gilles Peskineff94abd2018-07-12 17:07:52 +02002883 /* We'll set up the hash operation later in psa_hmac_setup_internal. */
2884 operation->ctx.hmac.hash_ctx.alg = 0;
2885 status = PSA_SUCCESS;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002886 }
2887 else
2888#endif /* MBEDTLS_MD_C */
2889 {
Gilles Peskinec06e0712018-06-20 16:21:04 +02002890 if( ! PSA_ALG_IS_MAC( alg ) )
2891 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002892 }
2893
2894 if( status != PSA_SUCCESS )
2895 memset( operation, 0, sizeof( *operation ) );
2896 return( status );
2897}
2898
Gilles Peskine01126fa2018-07-12 17:04:55 +02002899#if defined(MBEDTLS_MD_C)
2900static psa_status_t psa_hmac_abort_internal( psa_hmac_internal_data *hmac )
2901{
Gilles Peskine3f108122018-12-07 18:14:53 +01002902 mbedtls_platform_zeroize( hmac->opad, sizeof( hmac->opad ) );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002903 return( psa_hash_abort( &hmac->hash_ctx ) );
2904}
2905#endif /* MBEDTLS_MD_C */
2906
Gilles Peskine8c9def32018-02-08 10:02:12 +01002907psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
2908{
Gilles Peskinefbfac682018-07-08 20:51:54 +02002909 if( operation->alg == 0 )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002910 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02002911 /* The object has (apparently) been initialized but it is not
2912 * in use. It's ok to call abort on such an object, and there's
2913 * nothing to do. */
2914 return( PSA_SUCCESS );
2915 }
2916 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002917#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002918 if( operation->alg == PSA_ALG_CMAC )
2919 {
2920 mbedtls_cipher_free( &operation->ctx.cmac );
2921 }
2922 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002923#endif /* MBEDTLS_CMAC_C */
Gilles Peskine8c9def32018-02-08 10:02:12 +01002924#if defined(MBEDTLS_MD_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002925 if( PSA_ALG_IS_HMAC( operation->alg ) )
2926 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02002927 psa_hmac_abort_internal( &operation->ctx.hmac );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002928 }
2929 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002930#endif /* MBEDTLS_MD_C */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002931 {
2932 /* Sanity check (shouldn't happen: operation->alg should
2933 * always have been initialized to a valid value). */
2934 goto bad_state;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002935 }
Moran Peker41deec42018-04-04 15:43:05 +03002936
Gilles Peskine8c9def32018-02-08 10:02:12 +01002937 operation->alg = 0;
2938 operation->key_set = 0;
2939 operation->iv_set = 0;
2940 operation->iv_required = 0;
2941 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002942 operation->is_sign = 0;
Moran Peker41deec42018-04-04 15:43:05 +03002943
Gilles Peskine8c9def32018-02-08 10:02:12 +01002944 return( PSA_SUCCESS );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002945
2946bad_state:
2947 /* If abort is called on an uninitialized object, we can't trust
2948 * anything. Wipe the object in case it contains confidential data.
2949 * This may result in a memory leak if a pointer gets overwritten,
2950 * but it's too late to do anything about this. */
2951 memset( operation, 0, sizeof( *operation ) );
2952 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002953}
2954
Gilles Peskinee3b07d82018-06-19 11:57:35 +02002955#if defined(MBEDTLS_CMAC_C)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002956static int psa_cmac_setup( psa_mac_operation_t *operation,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002957 size_t key_bits,
Gilles Peskine2f060a82018-12-04 17:12:32 +01002958 psa_key_slot_t *slot,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002959 const mbedtls_cipher_info_t *cipher_info )
2960{
Janos Follath24eed8d2019-11-22 13:21:35 +00002961 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002962
2963 operation->mac_size = cipher_info->block_size;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002964
2965 ret = mbedtls_cipher_setup( &operation->ctx.cmac, cipher_info );
2966 if( ret != 0 )
2967 return( ret );
2968
2969 ret = mbedtls_cipher_cmac_starts( &operation->ctx.cmac,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02002970 slot->data.key.data,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002971 key_bits );
2972 return( ret );
2973}
Gilles Peskinee3b07d82018-06-19 11:57:35 +02002974#endif /* MBEDTLS_CMAC_C */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002975
Gilles Peskine248051a2018-06-20 16:09:38 +02002976#if defined(MBEDTLS_MD_C)
Gilles Peskine01126fa2018-07-12 17:04:55 +02002977static psa_status_t psa_hmac_setup_internal( psa_hmac_internal_data *hmac,
2978 const uint8_t *key,
2979 size_t key_length,
2980 psa_algorithm_t hash_alg )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002981{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02002982 uint8_t ipad[PSA_HMAC_MAX_HASH_BLOCK_SIZE];
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002983 size_t i;
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002984 size_t hash_size = PSA_HASH_SIZE( hash_alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002985 size_t block_size = psa_get_hash_block_size( hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002986 psa_status_t status;
2987
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002988 /* Sanity checks on block_size, to guarantee that there won't be a buffer
2989 * overflow below. This should never trigger if the hash algorithm
2990 * is implemented correctly. */
2991 /* The size checks against the ipad and opad buffers cannot be written
2992 * `block_size > sizeof( ipad ) || block_size > sizeof( hmac->opad )`
2993 * because that triggers -Wlogical-op on GCC 7.3. */
2994 if( block_size > sizeof( ipad ) )
2995 return( PSA_ERROR_NOT_SUPPORTED );
2996 if( block_size > sizeof( hmac->opad ) )
2997 return( PSA_ERROR_NOT_SUPPORTED );
2998 if( block_size < hash_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002999 return( PSA_ERROR_NOT_SUPPORTED );
3000
Gilles Peskined223b522018-06-11 18:12:58 +02003001 if( key_length > block_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003002 {
Gilles Peskine84b8fc82019-11-28 20:07:20 +01003003 status = psa_hash_compute( hash_alg, key, key_length,
3004 ipad, sizeof( ipad ), &key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003005 if( status != PSA_SUCCESS )
Gilles Peskineb8be2882018-07-17 16:24:34 +02003006 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003007 }
Gilles Peskine96889972018-07-12 17:07:03 +02003008 /* A 0-length key is not commonly used in HMAC when used as a MAC,
3009 * but it is permitted. It is common when HMAC is used in HKDF, for
3010 * example. Don't call `memcpy` in the 0-length because `key` could be
3011 * an invalid pointer which would make the behavior undefined. */
3012 else if( key_length != 0 )
Gilles Peskine01126fa2018-07-12 17:04:55 +02003013 memcpy( ipad, key, key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003014
Gilles Peskined223b522018-06-11 18:12:58 +02003015 /* ipad contains the key followed by garbage. Xor and fill with 0x36
3016 * to create the ipad value. */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003017 for( i = 0; i < key_length; i++ )
Gilles Peskined223b522018-06-11 18:12:58 +02003018 ipad[i] ^= 0x36;
3019 memset( ipad + key_length, 0x36, block_size - key_length );
3020
3021 /* Copy the key material from ipad to opad, flipping the requisite bits,
3022 * and filling the rest of opad with the requisite constant. */
3023 for( i = 0; i < key_length; i++ )
Gilles Peskine01126fa2018-07-12 17:04:55 +02003024 hmac->opad[i] = ipad[i] ^ 0x36 ^ 0x5C;
3025 memset( hmac->opad + key_length, 0x5C, block_size - key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003026
Gilles Peskine01126fa2018-07-12 17:04:55 +02003027 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003028 if( status != PSA_SUCCESS )
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003029 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003030
Gilles Peskine01126fa2018-07-12 17:04:55 +02003031 status = psa_hash_update( &hmac->hash_ctx, ipad, block_size );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003032
3033cleanup:
Steven Cooreman29149862020-08-05 15:43:42 +02003034 mbedtls_platform_zeroize( ipad, sizeof( ipad ) );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003035
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003036 return( status );
3037}
Gilles Peskine248051a2018-06-20 16:09:38 +02003038#endif /* MBEDTLS_MD_C */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003039
Gilles Peskine89167cb2018-07-08 20:12:23 +02003040static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01003041 psa_key_handle_t handle,
Gilles Peskine89167cb2018-07-08 20:12:23 +02003042 psa_algorithm_t alg,
3043 int is_sign )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003044{
Gilles Peskine8c9def32018-02-08 10:02:12 +01003045 psa_status_t status;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003046 psa_key_slot_t *slot;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003047 size_t key_bits;
Gilles Peskine89167cb2018-07-08 20:12:23 +02003048 psa_key_usage_t usage =
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003049 is_sign ? PSA_KEY_USAGE_SIGN_HASH : PSA_KEY_USAGE_VERIFY_HASH;
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02003050 uint8_t truncated = PSA_MAC_TRUNCATED_LENGTH( alg );
Gilles Peskinee0e9c7c2018-10-17 18:28:05 +02003051 psa_algorithm_t full_length_alg = PSA_ALG_FULL_LENGTH_MAC( alg );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003052
Jaeden Amero36ee5d02019-02-19 09:25:10 +00003053 /* A context must be freshly initialized before it can be set up. */
3054 if( operation->alg != 0 )
3055 {
3056 return( PSA_ERROR_BAD_STATE );
3057 }
3058
Gilles Peskined911eb72018-08-14 15:18:45 +02003059 status = psa_mac_init( operation, full_length_alg );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003060 if( status != PSA_SUCCESS )
3061 return( status );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003062 if( is_sign )
3063 operation->is_sign = 1;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003064
Gilles Peskine28f8f302019-07-24 13:30:31 +02003065 status = psa_get_transparent_key( handle, &slot, usage, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003066 if( status != PSA_SUCCESS )
Gilles Peskinefbfac682018-07-08 20:51:54 +02003067 goto exit;
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02003068 key_bits = psa_get_key_slot_bits( slot );
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02003069
Gilles Peskine8c9def32018-02-08 10:02:12 +01003070#if defined(MBEDTLS_CMAC_C)
Gilles Peskined911eb72018-08-14 15:18:45 +02003071 if( full_length_alg == PSA_ALG_CMAC )
Gilles Peskinefbfac682018-07-08 20:51:54 +02003072 {
3073 const mbedtls_cipher_info_t *cipher_info =
Gilles Peskined911eb72018-08-14 15:18:45 +02003074 mbedtls_cipher_info_from_psa( full_length_alg,
Gilles Peskine8e338702019-07-30 20:06:31 +02003075 slot->attr.type, key_bits, NULL );
Janos Follath24eed8d2019-11-22 13:21:35 +00003076 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinefbfac682018-07-08 20:51:54 +02003077 if( cipher_info == NULL )
3078 {
3079 status = PSA_ERROR_NOT_SUPPORTED;
3080 goto exit;
3081 }
3082 operation->mac_size = cipher_info->block_size;
3083 ret = psa_cmac_setup( operation, key_bits, slot, cipher_info );
3084 status = mbedtls_to_psa_error( ret );
3085 }
3086 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01003087#endif /* MBEDTLS_CMAC_C */
Gilles Peskine8c9def32018-02-08 10:02:12 +01003088#if defined(MBEDTLS_MD_C)
Gilles Peskined911eb72018-08-14 15:18:45 +02003089 if( PSA_ALG_IS_HMAC( full_length_alg ) )
Gilles Peskinefbfac682018-07-08 20:51:54 +02003090 {
Gilles Peskine00709fa2018-08-22 18:25:41 +02003091 psa_algorithm_t hash_alg = PSA_ALG_HMAC_GET_HASH( alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003092 if( hash_alg == 0 )
3093 {
3094 status = PSA_ERROR_NOT_SUPPORTED;
3095 goto exit;
3096 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02003097
3098 operation->mac_size = PSA_HASH_SIZE( hash_alg );
3099 /* Sanity check. This shouldn't fail on a valid configuration. */
3100 if( operation->mac_size == 0 ||
3101 operation->mac_size > sizeof( operation->ctx.hmac.opad ) )
3102 {
3103 status = PSA_ERROR_NOT_SUPPORTED;
3104 goto exit;
3105 }
3106
Gilles Peskine8e338702019-07-30 20:06:31 +02003107 if( slot->attr.type != PSA_KEY_TYPE_HMAC )
Gilles Peskine01126fa2018-07-12 17:04:55 +02003108 {
3109 status = PSA_ERROR_INVALID_ARGUMENT;
3110 goto exit;
3111 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02003112
Gilles Peskine01126fa2018-07-12 17:04:55 +02003113 status = psa_hmac_setup_internal( &operation->ctx.hmac,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02003114 slot->data.key.data,
3115 slot->data.key.bytes,
Gilles Peskine01126fa2018-07-12 17:04:55 +02003116 hash_alg );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003117 }
3118 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01003119#endif /* MBEDTLS_MD_C */
Gilles Peskinefbfac682018-07-08 20:51:54 +02003120 {
Jaeden Amero82df32e2018-11-23 15:11:20 +00003121 (void) key_bits;
Gilles Peskinefbfac682018-07-08 20:51:54 +02003122 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003123 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003124
Gilles Peskined911eb72018-08-14 15:18:45 +02003125 if( truncated == 0 )
3126 {
3127 /* The "normal" case: untruncated algorithm. Nothing to do. */
3128 }
3129 else if( truncated < 4 )
3130 {
Gilles Peskine6d72ff92018-08-21 14:55:08 +02003131 /* A very short MAC is too short for security since it can be
3132 * brute-forced. Ancient protocols with 32-bit MACs do exist,
3133 * so we make this our minimum, even though 32 bits is still
3134 * too small for security. */
Gilles Peskined911eb72018-08-14 15:18:45 +02003135 status = PSA_ERROR_NOT_SUPPORTED;
3136 }
3137 else if( truncated > operation->mac_size )
3138 {
3139 /* It's impossible to "truncate" to a larger length. */
3140 status = PSA_ERROR_INVALID_ARGUMENT;
3141 }
3142 else
3143 operation->mac_size = truncated;
3144
Gilles Peskinefbfac682018-07-08 20:51:54 +02003145exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003146 if( status != PSA_SUCCESS )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003147 {
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003148 psa_mac_abort( operation );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003149 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003150 else
3151 {
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003152 operation->key_set = 1;
3153 }
3154 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003155}
3156
Gilles Peskine89167cb2018-07-08 20:12:23 +02003157psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01003158 psa_key_handle_t handle,
Gilles Peskine89167cb2018-07-08 20:12:23 +02003159 psa_algorithm_t alg )
3160{
Gilles Peskinec5487a82018-12-03 18:08:14 +01003161 return( psa_mac_setup( operation, handle, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003162}
3163
3164psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01003165 psa_key_handle_t handle,
Gilles Peskine89167cb2018-07-08 20:12:23 +02003166 psa_algorithm_t alg )
3167{
Gilles Peskinec5487a82018-12-03 18:08:14 +01003168 return( psa_mac_setup( operation, handle, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003169}
3170
Gilles Peskine8c9def32018-02-08 10:02:12 +01003171psa_status_t psa_mac_update( psa_mac_operation_t *operation,
3172 const uint8_t *input,
3173 size_t input_length )
3174{
Gilles Peskinefbfac682018-07-08 20:51:54 +02003175 psa_status_t status = PSA_ERROR_BAD_STATE;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003176 if( ! operation->key_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003177 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003178 if( operation->iv_required && ! operation->iv_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003179 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003180 operation->has_input = 1;
3181
Gilles Peskine8c9def32018-02-08 10:02:12 +01003182#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003183 if( operation->alg == PSA_ALG_CMAC )
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03003184 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02003185 int ret = mbedtls_cipher_cmac_update( &operation->ctx.cmac,
3186 input, input_length );
3187 status = mbedtls_to_psa_error( ret );
3188 }
3189 else
3190#endif /* MBEDTLS_CMAC_C */
3191#if defined(MBEDTLS_MD_C)
3192 if( PSA_ALG_IS_HMAC( operation->alg ) )
3193 {
3194 status = psa_hash_update( &operation->ctx.hmac.hash_ctx, input,
3195 input_length );
3196 }
3197 else
3198#endif /* MBEDTLS_MD_C */
3199 {
3200 /* This shouldn't happen if `operation` was initialized by
3201 * a setup function. */
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003202 return( PSA_ERROR_BAD_STATE );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03003203 }
3204
Gilles Peskinefbfac682018-07-08 20:51:54 +02003205 if( status != PSA_SUCCESS )
3206 psa_mac_abort( operation );
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02003207 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003208}
3209
Gilles Peskine01126fa2018-07-12 17:04:55 +02003210#if defined(MBEDTLS_MD_C)
3211static psa_status_t psa_hmac_finish_internal( psa_hmac_internal_data *hmac,
3212 uint8_t *mac,
3213 size_t mac_size )
3214{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02003215 uint8_t tmp[MBEDTLS_MD_MAX_SIZE];
Gilles Peskine01126fa2018-07-12 17:04:55 +02003216 psa_algorithm_t hash_alg = hmac->hash_ctx.alg;
3217 size_t hash_size = 0;
3218 size_t block_size = psa_get_hash_block_size( hash_alg );
3219 psa_status_t status;
3220
Gilles Peskine01126fa2018-07-12 17:04:55 +02003221 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
3222 if( status != PSA_SUCCESS )
3223 return( status );
3224 /* From here on, tmp needs to be wiped. */
3225
3226 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
3227 if( status != PSA_SUCCESS )
3228 goto exit;
3229
3230 status = psa_hash_update( &hmac->hash_ctx, hmac->opad, block_size );
3231 if( status != PSA_SUCCESS )
3232 goto exit;
3233
3234 status = psa_hash_update( &hmac->hash_ctx, tmp, hash_size );
3235 if( status != PSA_SUCCESS )
3236 goto exit;
3237
Gilles Peskined911eb72018-08-14 15:18:45 +02003238 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
3239 if( status != PSA_SUCCESS )
3240 goto exit;
3241
3242 memcpy( mac, tmp, mac_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003243
3244exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01003245 mbedtls_platform_zeroize( tmp, hash_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003246 return( status );
3247}
3248#endif /* MBEDTLS_MD_C */
3249
mohammad16036df908f2018-04-02 08:34:15 -07003250static psa_status_t psa_mac_finish_internal( psa_mac_operation_t *operation,
Gilles Peskine2d277862018-06-18 15:41:12 +02003251 uint8_t *mac,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003252 size_t mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003253{
Gilles Peskine1d96fff2018-07-02 12:15:39 +02003254 if( ! operation->key_set )
3255 return( PSA_ERROR_BAD_STATE );
3256 if( operation->iv_required && ! operation->iv_set )
3257 return( PSA_ERROR_BAD_STATE );
3258
Gilles Peskine8c9def32018-02-08 10:02:12 +01003259 if( mac_size < operation->mac_size )
3260 return( PSA_ERROR_BUFFER_TOO_SMALL );
3261
Gilles Peskine8c9def32018-02-08 10:02:12 +01003262#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003263 if( operation->alg == PSA_ALG_CMAC )
3264 {
Gilles Peskined911eb72018-08-14 15:18:45 +02003265 uint8_t tmp[PSA_MAX_BLOCK_CIPHER_BLOCK_SIZE];
3266 int ret = mbedtls_cipher_cmac_finish( &operation->ctx.cmac, tmp );
3267 if( ret == 0 )
Gilles Peskine87b0ac42018-08-21 14:55:49 +02003268 memcpy( mac, tmp, operation->mac_size );
Gilles Peskine3f108122018-12-07 18:14:53 +01003269 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003270 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003271 }
Gilles Peskinefbfac682018-07-08 20:51:54 +02003272 else
3273#endif /* MBEDTLS_CMAC_C */
3274#if defined(MBEDTLS_MD_C)
3275 if( PSA_ALG_IS_HMAC( operation->alg ) )
3276 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02003277 return( psa_hmac_finish_internal( &operation->ctx.hmac,
Gilles Peskined911eb72018-08-14 15:18:45 +02003278 mac, operation->mac_size ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003279 }
3280 else
3281#endif /* MBEDTLS_MD_C */
3282 {
3283 /* This shouldn't happen if `operation` was initialized by
3284 * a setup function. */
3285 return( PSA_ERROR_BAD_STATE );
3286 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01003287}
3288
Gilles Peskineacd4be32018-07-08 19:56:25 +02003289psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
3290 uint8_t *mac,
3291 size_t mac_size,
3292 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07003293{
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003294 psa_status_t status;
3295
Jaeden Amero252ef282019-02-15 14:05:35 +00003296 if( operation->alg == 0 )
3297 {
3298 return( PSA_ERROR_BAD_STATE );
3299 }
3300
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003301 /* Fill the output buffer with something that isn't a valid mac
3302 * (barring an attack on the mac and deliberately-crafted input),
3303 * in case the caller doesn't check the return status properly. */
3304 *mac_length = mac_size;
3305 /* If mac_size is 0 then mac may be NULL and then the
3306 * call to memset would have undefined behavior. */
3307 if( mac_size != 0 )
3308 memset( mac, '!', mac_size );
3309
Gilles Peskine89167cb2018-07-08 20:12:23 +02003310 if( ! operation->is_sign )
3311 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003312 return( PSA_ERROR_BAD_STATE );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003313 }
mohammad16036df908f2018-04-02 08:34:15 -07003314
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003315 status = psa_mac_finish_internal( operation, mac, mac_size );
3316
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003317 if( status == PSA_SUCCESS )
3318 {
3319 status = psa_mac_abort( operation );
3320 if( status == PSA_SUCCESS )
3321 *mac_length = operation->mac_size;
3322 else
3323 memset( mac, '!', mac_size );
3324 }
3325 else
3326 psa_mac_abort( operation );
3327 return( status );
mohammad16036df908f2018-04-02 08:34:15 -07003328}
3329
Gilles Peskineacd4be32018-07-08 19:56:25 +02003330psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
3331 const uint8_t *mac,
3332 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003333{
Gilles Peskine828ed142018-06-18 23:25:51 +02003334 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
mohammad16036df908f2018-04-02 08:34:15 -07003335 psa_status_t status;
3336
Jaeden Amero252ef282019-02-15 14:05:35 +00003337 if( operation->alg == 0 )
3338 {
3339 return( PSA_ERROR_BAD_STATE );
3340 }
3341
Gilles Peskine89167cb2018-07-08 20:12:23 +02003342 if( operation->is_sign )
3343 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003344 return( PSA_ERROR_BAD_STATE );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003345 }
3346 if( operation->mac_size != mac_length )
3347 {
3348 status = PSA_ERROR_INVALID_SIGNATURE;
3349 goto cleanup;
Gilles Peskine89167cb2018-07-08 20:12:23 +02003350 }
mohammad16036df908f2018-04-02 08:34:15 -07003351
3352 status = psa_mac_finish_internal( operation,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003353 actual_mac, sizeof( actual_mac ) );
Gilles Peskine28cd4162020-01-20 16:31:06 +01003354 if( status != PSA_SUCCESS )
3355 goto cleanup;
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003356
3357 if( safer_memcmp( mac, actual_mac, mac_length ) != 0 )
3358 status = PSA_ERROR_INVALID_SIGNATURE;
3359
3360cleanup:
3361 if( status == PSA_SUCCESS )
3362 status = psa_mac_abort( operation );
3363 else
3364 psa_mac_abort( operation );
3365
Gilles Peskine3f108122018-12-07 18:14:53 +01003366 mbedtls_platform_zeroize( actual_mac, sizeof( actual_mac ) );
Gilles Peskined911eb72018-08-14 15:18:45 +02003367
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003368 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003369}
3370
3371
Gilles Peskine20035e32018-02-03 22:44:14 +01003372
Gilles Peskine20035e32018-02-03 22:44:14 +01003373/****************************************************************/
3374/* Asymmetric cryptography */
3375/****************************************************************/
3376
Gilles Peskine2b450e32018-06-27 15:42:46 +02003377#if defined(MBEDTLS_RSA_C)
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02003378/* Decode the hash algorithm from alg and store the mbedtls encoding in
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003379 * md_alg. Verify that the hash length is acceptable. */
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02003380static psa_status_t psa_rsa_decode_md_type( psa_algorithm_t alg,
3381 size_t hash_length,
3382 mbedtls_md_type_t *md_alg )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003383{
Gilles Peskine7ed29c52018-06-26 15:50:08 +02003384 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003385 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003386 *md_alg = mbedtls_md_get_type( md_info );
3387
3388 /* The Mbed TLS RSA module uses an unsigned int for hash length
3389 * parameters. Validate that it fits so that we don't risk an
3390 * overflow later. */
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003391#if SIZE_MAX > UINT_MAX
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003392 if( hash_length > UINT_MAX )
3393 return( PSA_ERROR_INVALID_ARGUMENT );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003394#endif
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003395
3396#if defined(MBEDTLS_PKCS1_V15)
3397 /* For PKCS#1 v1.5 signature, if using a hash, the hash length
3398 * must be correct. */
3399 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) &&
3400 alg != PSA_ALG_RSA_PKCS1V15_SIGN_RAW )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003401 {
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003402 if( md_info == NULL )
3403 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003404 if( mbedtls_md_get_size( md_info ) != hash_length )
3405 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003406 }
3407#endif /* MBEDTLS_PKCS1_V15 */
3408
3409#if defined(MBEDTLS_PKCS1_V21)
3410 /* PSS requires a hash internally. */
3411 if( PSA_ALG_IS_RSA_PSS( alg ) )
3412 {
Gilles Peskine61b91d42018-06-08 16:09:36 +02003413 if( md_info == NULL )
3414 return( PSA_ERROR_NOT_SUPPORTED );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003415 }
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003416#endif /* MBEDTLS_PKCS1_V21 */
3417
Gilles Peskine61b91d42018-06-08 16:09:36 +02003418 return( PSA_SUCCESS );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003419}
3420
Gilles Peskine2b450e32018-06-27 15:42:46 +02003421static psa_status_t psa_rsa_sign( mbedtls_rsa_context *rsa,
3422 psa_algorithm_t alg,
3423 const uint8_t *hash,
3424 size_t hash_length,
3425 uint8_t *signature,
3426 size_t signature_size,
3427 size_t *signature_length )
3428{
3429 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00003430 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003431 mbedtls_md_type_t md_alg;
3432
3433 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
3434 if( status != PSA_SUCCESS )
3435 return( status );
3436
Gilles Peskine630a18a2018-06-29 17:49:35 +02003437 if( signature_size < mbedtls_rsa_get_len( rsa ) )
Gilles Peskine2b450e32018-06-27 15:42:46 +02003438 return( PSA_ERROR_BUFFER_TOO_SMALL );
3439
3440#if defined(MBEDTLS_PKCS1_V15)
3441 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
3442 {
3443 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
3444 MBEDTLS_MD_NONE );
3445 ret = mbedtls_rsa_pkcs1_sign( rsa,
3446 mbedtls_ctr_drbg_random,
3447 &global_data.ctr_drbg,
3448 MBEDTLS_RSA_PRIVATE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003449 md_alg,
3450 (unsigned int) hash_length,
3451 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003452 signature );
3453 }
3454 else
3455#endif /* MBEDTLS_PKCS1_V15 */
3456#if defined(MBEDTLS_PKCS1_V21)
3457 if( PSA_ALG_IS_RSA_PSS( alg ) )
3458 {
3459 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3460 ret = mbedtls_rsa_rsassa_pss_sign( rsa,
3461 mbedtls_ctr_drbg_random,
3462 &global_data.ctr_drbg,
3463 MBEDTLS_RSA_PRIVATE,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003464 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003465 (unsigned int) hash_length,
3466 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003467 signature );
3468 }
3469 else
3470#endif /* MBEDTLS_PKCS1_V21 */
3471 {
3472 return( PSA_ERROR_INVALID_ARGUMENT );
3473 }
3474
3475 if( ret == 0 )
Gilles Peskine630a18a2018-06-29 17:49:35 +02003476 *signature_length = mbedtls_rsa_get_len( rsa );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003477 return( mbedtls_to_psa_error( ret ) );
3478}
3479
3480static psa_status_t psa_rsa_verify( mbedtls_rsa_context *rsa,
3481 psa_algorithm_t alg,
3482 const uint8_t *hash,
3483 size_t hash_length,
3484 const uint8_t *signature,
3485 size_t signature_length )
3486{
3487 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00003488 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003489 mbedtls_md_type_t md_alg;
3490
3491 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
3492 if( status != PSA_SUCCESS )
3493 return( status );
3494
Gilles Peskine89cc74f2019-09-12 22:08:23 +02003495 if( signature_length != mbedtls_rsa_get_len( rsa ) )
3496 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003497
3498#if defined(MBEDTLS_PKCS1_V15)
3499 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
3500 {
3501 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
3502 MBEDTLS_MD_NONE );
3503 ret = mbedtls_rsa_pkcs1_verify( rsa,
3504 mbedtls_ctr_drbg_random,
3505 &global_data.ctr_drbg,
3506 MBEDTLS_RSA_PUBLIC,
3507 md_alg,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003508 (unsigned int) hash_length,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003509 hash,
3510 signature );
3511 }
3512 else
3513#endif /* MBEDTLS_PKCS1_V15 */
3514#if defined(MBEDTLS_PKCS1_V21)
3515 if( PSA_ALG_IS_RSA_PSS( alg ) )
3516 {
3517 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3518 ret = mbedtls_rsa_rsassa_pss_verify( rsa,
3519 mbedtls_ctr_drbg_random,
3520 &global_data.ctr_drbg,
3521 MBEDTLS_RSA_PUBLIC,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003522 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003523 (unsigned int) hash_length,
3524 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003525 signature );
3526 }
3527 else
3528#endif /* MBEDTLS_PKCS1_V21 */
3529 {
3530 return( PSA_ERROR_INVALID_ARGUMENT );
3531 }
Gilles Peskineef12c632018-09-13 20:37:48 +02003532
3533 /* Mbed TLS distinguishes "invalid padding" from "valid padding but
3534 * the rest of the signature is invalid". This has little use in
3535 * practice and PSA doesn't report this distinction. */
3536 if( ret == MBEDTLS_ERR_RSA_INVALID_PADDING )
3537 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003538 return( mbedtls_to_psa_error( ret ) );
3539}
3540#endif /* MBEDTLS_RSA_C */
3541
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003542#if defined(MBEDTLS_ECDSA_C)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003543/* `ecp` cannot be const because `ecp->grp` needs to be non-const
3544 * for mbedtls_ecdsa_sign() and mbedtls_ecdsa_sign_det()
3545 * (even though these functions don't modify it). */
3546static psa_status_t psa_ecdsa_sign( mbedtls_ecp_keypair *ecp,
3547 psa_algorithm_t alg,
3548 const uint8_t *hash,
3549 size_t hash_length,
3550 uint8_t *signature,
3551 size_t signature_size,
3552 size_t *signature_length )
3553{
Janos Follath24eed8d2019-11-22 13:21:35 +00003554 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003555 mbedtls_mpi r, s;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003556 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003557 mbedtls_mpi_init( &r );
3558 mbedtls_mpi_init( &s );
3559
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003560 if( signature_size < 2 * curve_bytes )
3561 {
3562 ret = MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL;
3563 goto cleanup;
3564 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003565
Gilles Peskinea05219c2018-11-16 16:02:56 +01003566#if defined(MBEDTLS_ECDSA_DETERMINISTIC)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003567 if( PSA_ALG_DSA_IS_DETERMINISTIC( alg ) )
3568 {
3569 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
3570 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3571 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
Darryl Green5e843fa2019-09-05 14:06:34 +01003572 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign_det_ext( &ecp->grp, &r, &s,
3573 &ecp->d, hash,
3574 hash_length, md_alg,
3575 mbedtls_ctr_drbg_random,
3576 &global_data.ctr_drbg ) );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003577 }
3578 else
Gilles Peskinea05219c2018-11-16 16:02:56 +01003579#endif /* MBEDTLS_ECDSA_DETERMINISTIC */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003580 {
Gilles Peskinea05219c2018-11-16 16:02:56 +01003581 (void) alg;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003582 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign( &ecp->grp, &r, &s, &ecp->d,
3583 hash, hash_length,
3584 mbedtls_ctr_drbg_random,
3585 &global_data.ctr_drbg ) );
3586 }
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003587
3588 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &r,
3589 signature,
3590 curve_bytes ) );
3591 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &s,
3592 signature + curve_bytes,
3593 curve_bytes ) );
3594
3595cleanup:
3596 mbedtls_mpi_free( &r );
3597 mbedtls_mpi_free( &s );
3598 if( ret == 0 )
3599 *signature_length = 2 * curve_bytes;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003600 return( mbedtls_to_psa_error( ret ) );
3601}
3602
3603static psa_status_t psa_ecdsa_verify( mbedtls_ecp_keypair *ecp,
3604 const uint8_t *hash,
3605 size_t hash_length,
3606 const uint8_t *signature,
3607 size_t signature_length )
3608{
Janos Follath24eed8d2019-11-22 13:21:35 +00003609 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003610 mbedtls_mpi r, s;
3611 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
3612 mbedtls_mpi_init( &r );
3613 mbedtls_mpi_init( &s );
3614
3615 if( signature_length != 2 * curve_bytes )
3616 return( PSA_ERROR_INVALID_SIGNATURE );
3617
3618 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &r,
3619 signature,
3620 curve_bytes ) );
3621 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &s,
3622 signature + curve_bytes,
3623 curve_bytes ) );
3624
Steven Cooremanacda8342020-07-24 23:09:52 +02003625 /* Check whether the public part is loaded. If not, load it. */
3626 if( mbedtls_ecp_is_zero( &ecp->Q ) )
3627 {
3628 MBEDTLS_MPI_CHK(
3629 mbedtls_ecp_mul( &ecp->grp, &ecp->Q, &ecp->d, &ecp->grp.G,
3630 mbedtls_ctr_drbg_random, &global_data.ctr_drbg ) );
3631 }
3632
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003633 ret = mbedtls_ecdsa_verify( &ecp->grp, hash, hash_length,
3634 &ecp->Q, &r, &s );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003635
3636cleanup:
3637 mbedtls_mpi_free( &r );
3638 mbedtls_mpi_free( &s );
3639 return( mbedtls_to_psa_error( ret ) );
3640}
3641#endif /* MBEDTLS_ECDSA_C */
3642
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003643psa_status_t psa_sign_hash( psa_key_handle_t handle,
3644 psa_algorithm_t alg,
3645 const uint8_t *hash,
3646 size_t hash_length,
3647 uint8_t *signature,
3648 size_t signature_size,
3649 size_t *signature_length )
Gilles Peskine20035e32018-02-03 22:44:14 +01003650{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003651 psa_key_slot_t *slot;
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003652 psa_status_t status;
3653
3654 *signature_length = signature_size;
Gilles Peskine4019f0e2019-09-12 22:05:59 +02003655 /* Immediately reject a zero-length signature buffer. This guarantees
3656 * that signature must be a valid pointer. (On the other hand, the hash
3657 * buffer can in principle be empty since it doesn't actually have
3658 * to be a hash.) */
3659 if( signature_size == 0 )
3660 return( PSA_ERROR_BUFFER_TOO_SMALL );
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003661
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003662 status = psa_get_key_from_slot( handle, &slot, PSA_KEY_USAGE_SIGN_HASH, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003663 if( status != PSA_SUCCESS )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003664 goto exit;
Gilles Peskine8e338702019-07-30 20:06:31 +02003665 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003666 {
3667 status = PSA_ERROR_INVALID_ARGUMENT;
3668 goto exit;
3669 }
Gilles Peskine20035e32018-02-03 22:44:14 +01003670
Steven Cooremancd84cb42020-07-16 20:28:36 +02003671 /* Try any of the available accelerators first */
3672 status = psa_driver_wrapper_sign_hash( slot,
3673 alg,
3674 hash,
3675 hash_length,
3676 signature,
3677 signature_size,
3678 signature_length );
Steven Cooreman8d2bde72020-09-04 13:06:39 +02003679 if( status != PSA_ERROR_NOT_SUPPORTED ||
3680 psa_key_lifetime_is_external( slot->attr.lifetime ) )
Steven Cooremancd84cb42020-07-16 20:28:36 +02003681 goto exit;
3682
Steven Cooreman7a250572020-07-17 16:43:05 +02003683 /* If the operation was not supported by any accelerator, try fallback. */
Gilles Peskine20035e32018-02-03 22:44:14 +01003684#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003685 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskine20035e32018-02-03 22:44:14 +01003686 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003687 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02003688
Steven Cooreman4fed4552020-08-03 14:46:03 +02003689 status = psa_load_rsa_representation( slot->attr.type,
3690 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02003691 slot->data.key.bytes,
Steven Cooremana01795d2020-07-24 22:48:15 +02003692 &rsa );
3693 if( status != PSA_SUCCESS )
3694 goto exit;
3695
Steven Cooremana2371e52020-07-28 14:30:39 +02003696 status = psa_rsa_sign( rsa,
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003697 alg,
3698 hash, hash_length,
3699 signature, signature_size,
3700 signature_length );
Steven Cooremana01795d2020-07-24 22:48:15 +02003701
Steven Cooremana2371e52020-07-28 14:30:39 +02003702 mbedtls_rsa_free( rsa );
3703 mbedtls_free( rsa );
Gilles Peskine20035e32018-02-03 22:44:14 +01003704 }
3705 else
3706#endif /* defined(MBEDTLS_RSA_C) */
3707#if defined(MBEDTLS_ECP_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003708 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
Gilles Peskine20035e32018-02-03 22:44:14 +01003709 {
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003710#if defined(MBEDTLS_ECDSA_C)
Gilles Peskinea05219c2018-11-16 16:02:56 +01003711 if(
3712#if defined(MBEDTLS_ECDSA_DETERMINISTIC)
3713 PSA_ALG_IS_ECDSA( alg )
3714#else
3715 PSA_ALG_IS_RANDOMIZED_ECDSA( alg )
3716#endif
3717 )
Steven Cooremanacda8342020-07-24 23:09:52 +02003718 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003719 mbedtls_ecp_keypair *ecp = NULL;
Steven Cooreman4fed4552020-08-03 14:46:03 +02003720 status = psa_load_ecp_representation( slot->attr.type,
3721 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02003722 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02003723 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003724 if( status != PSA_SUCCESS )
3725 goto exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003726 status = psa_ecdsa_sign( ecp,
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003727 alg,
3728 hash, hash_length,
3729 signature, signature_size,
3730 signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02003731 mbedtls_ecp_keypair_free( ecp );
3732 mbedtls_free( ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003733 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003734 else
3735#endif /* defined(MBEDTLS_ECDSA_C) */
3736 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003737 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003738 }
itayzafrir5c753392018-05-08 11:18:38 +03003739 }
3740 else
3741#endif /* defined(MBEDTLS_ECP_C) */
3742 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003743 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine20035e32018-02-03 22:44:14 +01003744 }
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003745
3746exit:
3747 /* Fill the unused part of the output buffer (the whole buffer on error,
3748 * the trailing part on success) with something that isn't a valid mac
3749 * (barring an attack on the mac and deliberately-crafted input),
3750 * in case the caller doesn't check the return status properly. */
3751 if( status == PSA_SUCCESS )
3752 memset( signature + *signature_length, '!',
3753 signature_size - *signature_length );
Gilles Peskine4019f0e2019-09-12 22:05:59 +02003754 else
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003755 memset( signature, '!', signature_size );
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003756 /* If signature_size is 0 then we have nothing to do. We must not call
3757 * memset because signature may be NULL in this case. */
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003758 return( status );
itayzafrir5c753392018-05-08 11:18:38 +03003759}
3760
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003761psa_status_t psa_verify_hash( psa_key_handle_t handle,
3762 psa_algorithm_t alg,
3763 const uint8_t *hash,
3764 size_t hash_length,
3765 const uint8_t *signature,
3766 size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03003767{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003768 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003769 psa_status_t status;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003770
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003771 status = psa_get_key_from_slot( handle, &slot, PSA_KEY_USAGE_VERIFY_HASH, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003772 if( status != PSA_SUCCESS )
3773 return( status );
itayzafrir5c753392018-05-08 11:18:38 +03003774
Steven Cooreman55ae2172020-07-17 19:46:15 +02003775 /* Try any of the available accelerators first */
3776 status = psa_driver_wrapper_verify_hash( slot,
3777 alg,
3778 hash,
3779 hash_length,
3780 signature,
3781 signature_length );
Steven Cooreman8d2bde72020-09-04 13:06:39 +02003782 if( status != PSA_ERROR_NOT_SUPPORTED ||
3783 psa_key_lifetime_is_external( slot->attr.lifetime ) )
Steven Cooreman55ae2172020-07-17 19:46:15 +02003784 return status;
3785
Gilles Peskine61b91d42018-06-08 16:09:36 +02003786#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003787 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003788 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003789 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02003790
Steven Cooreman4fed4552020-08-03 14:46:03 +02003791 status = psa_load_rsa_representation( slot->attr.type,
3792 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02003793 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02003794 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003795 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02003796 return( status );
Steven Cooremana01795d2020-07-24 22:48:15 +02003797
Steven Cooremana2371e52020-07-28 14:30:39 +02003798 status = psa_rsa_verify( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02003799 alg,
3800 hash, hash_length,
3801 signature, signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02003802 mbedtls_rsa_free( rsa );
3803 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003804 return( status );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003805 }
3806 else
3807#endif /* defined(MBEDTLS_RSA_C) */
itayzafrir5c753392018-05-08 11:18:38 +03003808#if defined(MBEDTLS_ECP_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003809 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
itayzafrir5c753392018-05-08 11:18:38 +03003810 {
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003811#if defined(MBEDTLS_ECDSA_C)
3812 if( PSA_ALG_IS_ECDSA( alg ) )
Steven Cooremanacda8342020-07-24 23:09:52 +02003813 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003814 mbedtls_ecp_keypair *ecp = NULL;
Steven Cooreman4fed4552020-08-03 14:46:03 +02003815 status = psa_load_ecp_representation( slot->attr.type,
3816 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02003817 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02003818 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003819 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02003820 return( status );
Steven Cooremana2371e52020-07-28 14:30:39 +02003821 status = psa_ecdsa_verify( ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02003822 hash, hash_length,
3823 signature, signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02003824 mbedtls_ecp_keypair_free( ecp );
3825 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02003826 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02003827 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003828 else
3829#endif /* defined(MBEDTLS_ECDSA_C) */
3830 {
3831 return( PSA_ERROR_INVALID_ARGUMENT );
3832 }
itayzafrir5c753392018-05-08 11:18:38 +03003833 }
Gilles Peskine20035e32018-02-03 22:44:14 +01003834 else
3835#endif /* defined(MBEDTLS_ECP_C) */
3836 {
3837 return( PSA_ERROR_NOT_SUPPORTED );
3838 }
3839}
3840
Gilles Peskine072ac562018-06-30 00:21:29 +02003841#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PKCS1_V21)
3842static void psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
3843 mbedtls_rsa_context *rsa )
3844{
3845 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
3846 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3847 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
3848 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3849}
3850#endif /* defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PKCS1_V21) */
3851
Gilles Peskinec5487a82018-12-03 18:08:14 +01003852psa_status_t psa_asymmetric_encrypt( psa_key_handle_t handle,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003853 psa_algorithm_t alg,
3854 const uint8_t *input,
3855 size_t input_length,
3856 const uint8_t *salt,
3857 size_t salt_length,
3858 uint8_t *output,
3859 size_t output_size,
3860 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003861{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003862 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003863 psa_status_t status;
3864
Darryl Green5cc689a2018-07-24 15:34:10 +01003865 (void) input;
3866 (void) input_length;
3867 (void) salt;
3868 (void) output;
3869 (void) output_size;
3870
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003871 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003872
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003873 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3874 return( PSA_ERROR_INVALID_ARGUMENT );
3875
Gilles Peskine28f8f302019-07-24 13:30:31 +02003876 status = psa_get_transparent_key( handle, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003877 if( status != PSA_SUCCESS )
3878 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003879 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
3880 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003881 return( PSA_ERROR_INVALID_ARGUMENT );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003882
3883#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003884 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003885 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003886 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman4fed4552020-08-03 14:46:03 +02003887 status = psa_load_rsa_representation( slot->attr.type,
3888 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02003889 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02003890 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003891 if( status != PSA_SUCCESS )
Steven Cooreman4fed4552020-08-03 14:46:03 +02003892 goto rsa_exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003893
3894 if( output_size < mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003895 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003896 status = PSA_ERROR_BUFFER_TOO_SMALL;
3897 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003898 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003899#if defined(MBEDTLS_PKCS1_V15)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003900 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003901 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003902 status = mbedtls_to_psa_error(
3903 mbedtls_rsa_pkcs1_encrypt( rsa,
3904 mbedtls_ctr_drbg_random,
3905 &global_data.ctr_drbg,
3906 MBEDTLS_RSA_PUBLIC,
3907 input_length,
3908 input,
3909 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003910 }
3911 else
3912#endif /* MBEDTLS_PKCS1_V15 */
3913#if defined(MBEDTLS_PKCS1_V21)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003914 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003915 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003916 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02003917 status = mbedtls_to_psa_error(
3918 mbedtls_rsa_rsaes_oaep_encrypt( rsa,
3919 mbedtls_ctr_drbg_random,
3920 &global_data.ctr_drbg,
3921 MBEDTLS_RSA_PUBLIC,
3922 salt, salt_length,
3923 input_length,
3924 input,
3925 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003926 }
3927 else
3928#endif /* MBEDTLS_PKCS1_V21 */
3929 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003930 status = PSA_ERROR_INVALID_ARGUMENT;
3931 goto rsa_exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003932 }
Steven Cooreman4fed4552020-08-03 14:46:03 +02003933rsa_exit:
3934 if( status == PSA_SUCCESS )
Steven Cooremana2371e52020-07-28 14:30:39 +02003935 *output_length = mbedtls_rsa_get_len( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003936
Steven Cooremana2371e52020-07-28 14:30:39 +02003937 mbedtls_rsa_free( rsa );
3938 mbedtls_free( rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02003939 return( status );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003940 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003941 else
Gilles Peskineb75e4f12018-06-08 17:44:47 +02003942#endif /* defined(MBEDTLS_RSA_C) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003943 {
3944 return( PSA_ERROR_NOT_SUPPORTED );
3945 }
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003946}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003947
Gilles Peskinec5487a82018-12-03 18:08:14 +01003948psa_status_t psa_asymmetric_decrypt( psa_key_handle_t handle,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003949 psa_algorithm_t alg,
3950 const uint8_t *input,
3951 size_t input_length,
3952 const uint8_t *salt,
3953 size_t salt_length,
3954 uint8_t *output,
3955 size_t output_size,
3956 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003957{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003958 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003959 psa_status_t status;
3960
Darryl Green5cc689a2018-07-24 15:34:10 +01003961 (void) input;
3962 (void) input_length;
3963 (void) salt;
3964 (void) output;
3965 (void) output_size;
3966
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003967 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003968
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003969 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3970 return( PSA_ERROR_INVALID_ARGUMENT );
3971
Gilles Peskine28f8f302019-07-24 13:30:31 +02003972 status = psa_get_transparent_key( handle, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003973 if( status != PSA_SUCCESS )
3974 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003975 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003976 return( PSA_ERROR_INVALID_ARGUMENT );
3977
3978#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003979 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003980 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003981 mbedtls_rsa_context *rsa = NULL;
3982 status = psa_load_rsa_representation( slot->attr.type,
3983 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02003984 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02003985 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003986 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02003987 return( status );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003988
Steven Cooremana2371e52020-07-28 14:30:39 +02003989 if( input_length != mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003990 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003991 status = PSA_ERROR_INVALID_ARGUMENT;
3992 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003993 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003994
3995#if defined(MBEDTLS_PKCS1_V15)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003996 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003997 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003998 status = mbedtls_to_psa_error(
3999 mbedtls_rsa_pkcs1_decrypt( rsa,
4000 mbedtls_ctr_drbg_random,
4001 &global_data.ctr_drbg,
4002 MBEDTLS_RSA_PRIVATE,
4003 output_length,
4004 input,
4005 output,
4006 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004007 }
4008 else
4009#endif /* MBEDTLS_PKCS1_V15 */
4010#if defined(MBEDTLS_PKCS1_V21)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02004011 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004012 {
Steven Cooremana2371e52020-07-28 14:30:39 +02004013 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02004014 status = mbedtls_to_psa_error(
4015 mbedtls_rsa_rsaes_oaep_decrypt( rsa,
4016 mbedtls_ctr_drbg_random,
4017 &global_data.ctr_drbg,
4018 MBEDTLS_RSA_PRIVATE,
4019 salt, salt_length,
4020 output_length,
4021 input,
4022 output,
4023 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004024 }
4025 else
4026#endif /* MBEDTLS_PKCS1_V21 */
4027 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004028 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004029 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03004030
Steven Cooreman4fed4552020-08-03 14:46:03 +02004031rsa_exit:
Steven Cooremana2371e52020-07-28 14:30:39 +02004032 mbedtls_rsa_free( rsa );
4033 mbedtls_free( rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02004034 return( status );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004035 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004036 else
Gilles Peskineb75e4f12018-06-08 17:44:47 +02004037#endif /* defined(MBEDTLS_RSA_C) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004038 {
4039 return( PSA_ERROR_NOT_SUPPORTED );
4040 }
Gilles Peskine5b051bc2018-05-31 13:25:48 +02004041}
Gilles Peskine20035e32018-02-03 22:44:14 +01004042
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004043
4044
mohammad1603503973b2018-03-12 15:59:30 +02004045/****************************************************************/
4046/* Symmetric cryptography */
4047/****************************************************************/
4048
Gilles Peskinee553c652018-06-04 16:22:46 +02004049static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01004050 psa_key_handle_t handle,
Gilles Peskine7e928852018-06-04 16:23:10 +02004051 psa_algorithm_t alg,
4052 mbedtls_operation_t cipher_operation )
mohammad1603503973b2018-03-12 15:59:30 +02004053{
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004054 int ret = 0;
4055 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Gilles Peskine2f060a82018-12-04 17:12:32 +01004056 psa_key_slot_t *slot;
mohammad1603503973b2018-03-12 15:59:30 +02004057 size_t key_bits;
4058 const mbedtls_cipher_info_t *cipher_info = NULL;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004059 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
4060 PSA_KEY_USAGE_ENCRYPT :
4061 PSA_KEY_USAGE_DECRYPT );
mohammad1603503973b2018-03-12 15:59:30 +02004062
Steven Cooremand3feccd2020-09-01 15:56:14 +02004063 /* A context must be freshly initialized before it can be set up. */
4064 if( operation->alg != 0 )
4065 return( PSA_ERROR_BAD_STATE );
4066
Steven Cooremana07b9972020-09-10 14:54:14 +02004067 /* The requested algorithm must be one that can be processed by cipher. */
4068 if( ! PSA_ALG_IS_CIPHER( alg ) )
Steven Cooremana07b9972020-09-10 14:54:14 +02004069 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremand3feccd2020-09-01 15:56:14 +02004070
Steven Cooremanef8575e2020-09-11 11:44:50 +02004071 /* Fetch key material from key storage. */
4072 status = psa_get_key_from_slot( handle, &slot, usage, alg );
4073 if( status != PSA_SUCCESS )
4074 goto exit;
4075
4076 /* Initialize the operation struct members, except for alg. The alg member
4077 * is used to indicate to psa_cipher_abort that there are resources to free,
4078 * so we only set it after resources have been allocated/initialized. */
Steven Cooremana07b9972020-09-10 14:54:14 +02004079 operation->key_set = 0;
4080 operation->iv_set = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004081 operation->mbedtls_in_use = 0;
Steven Cooremana07b9972020-09-10 14:54:14 +02004082 operation->iv_size = 0;
4083 operation->block_size = 0;
4084 if( alg == PSA_ALG_ECB_NO_PADDING )
4085 operation->iv_required = 0;
4086 else
4087 operation->iv_required = 1;
4088
Steven Cooremana07b9972020-09-10 14:54:14 +02004089 /* Try doing the operation through a driver before using software fallback. */
Steven Cooreman37941cb2020-07-28 18:49:51 +02004090 if( cipher_operation == MBEDTLS_ENCRYPT )
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004091 status = psa_driver_wrapper_cipher_encrypt_setup( &operation->ctx.driver,
Steven Cooreman37941cb2020-07-28 18:49:51 +02004092 slot,
4093 alg );
4094 else
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004095 status = psa_driver_wrapper_cipher_decrypt_setup( &operation->ctx.driver,
Steven Cooreman37941cb2020-07-28 18:49:51 +02004096 slot,
4097 alg );
4098
Steven Cooremanef8575e2020-09-11 11:44:50 +02004099 if( status == PSA_SUCCESS )
Steven Cooreman6d81f7e2020-09-14 13:14:31 +02004100 {
Steven Cooremanef8575e2020-09-11 11:44:50 +02004101 /* Once the driver context is initialised, it needs to be freed using
4102 * psa_cipher_abort. Indicate this through setting alg. */
4103 operation->alg = alg;
Steven Cooreman6d81f7e2020-09-14 13:14:31 +02004104 }
Steven Cooremanef8575e2020-09-11 11:44:50 +02004105
Steven Cooremand3feccd2020-09-01 15:56:14 +02004106 if( status != PSA_ERROR_NOT_SUPPORTED ||
4107 psa_key_lifetime_is_external( slot->attr.lifetime ) )
4108 goto exit;
4109
Steven Cooremana07b9972020-09-10 14:54:14 +02004110 /* Proceed with initializing an mbed TLS cipher context if no driver is
Steven Cooremand3feccd2020-09-01 15:56:14 +02004111 * available for the given algorithm & key. */
4112 mbedtls_cipher_init( &operation->ctx.cipher );
mohammad1603503973b2018-03-12 15:59:30 +02004113
Steven Cooremana07b9972020-09-10 14:54:14 +02004114 /* Once the cipher context is initialised, it needs to be freed using
Steven Cooremanef8575e2020-09-11 11:44:50 +02004115 * psa_cipher_abort. Indicate there is something to be freed through setting
4116 * alg, and indicate the operation is being done using mbedtls crypto through
4117 * setting mbedtls_in_use. */
Steven Cooremana07b9972020-09-10 14:54:14 +02004118 operation->alg = alg;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004119 operation->mbedtls_in_use = 1;
Steven Cooremana07b9972020-09-10 14:54:14 +02004120
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02004121 key_bits = psa_get_key_slot_bits( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +02004122 cipher_info = mbedtls_cipher_info_from_psa( alg, slot->attr.type, key_bits, NULL );
mohammad1603503973b2018-03-12 15:59:30 +02004123 if( cipher_info == NULL )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004124 {
4125 status = PSA_ERROR_NOT_SUPPORTED;
4126 goto exit;
4127 }
mohammad1603503973b2018-03-12 15:59:30 +02004128
mohammad1603503973b2018-03-12 15:59:30 +02004129 ret = mbedtls_cipher_setup( &operation->ctx.cipher, cipher_info );
Moran Peker41deec42018-04-04 15:43:05 +03004130 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004131 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004132
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004133#if defined(MBEDTLS_DES_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02004134 if( slot->attr.type == PSA_KEY_TYPE_DES && key_bits == 128 )
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004135 {
4136 /* Two-key Triple-DES is 3-key Triple-DES with K1=K3 */
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02004137 uint8_t keys[24];
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004138 memcpy( keys, slot->data.key.data, 16 );
4139 memcpy( keys + 16, slot->data.key.data, 8 );
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004140 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
4141 keys,
4142 192, cipher_operation );
4143 }
4144 else
4145#endif
4146 {
4147 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004148 slot->data.key.data,
Jaeden Amero23bbb752018-06-26 14:16:54 +01004149 (int) key_bits, cipher_operation );
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004150 }
Moran Peker41deec42018-04-04 15:43:05 +03004151 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004152 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004153
mohammad16038481e742018-03-18 13:57:31 +02004154#if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004155 switch( alg )
mohammad16038481e742018-03-18 13:57:31 +02004156 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004157 case PSA_ALG_CBC_NO_PADDING:
4158 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
4159 MBEDTLS_PADDING_NONE );
4160 break;
4161 case PSA_ALG_CBC_PKCS7:
4162 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
4163 MBEDTLS_PADDING_PKCS7 );
4164 break;
4165 default:
4166 /* The algorithm doesn't involve padding. */
4167 ret = 0;
4168 break;
4169 }
4170 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004171 goto exit;
mohammad16038481e742018-03-18 13:57:31 +02004172#endif //MBEDTLS_CIPHER_MODE_WITH_PADDING
4173
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004174 operation->block_size = ( PSA_ALG_IS_STREAM_CIPHER( alg ) ? 1 :
Gilles Peskine8e338702019-07-30 20:06:31 +02004175 PSA_BLOCK_CIPHER_BLOCK_SIZE( slot->attr.type ) );
Steven Cooremana6033e92020-08-25 11:47:50 +02004176 if( ( alg & PSA_ALG_CIPHER_FROM_BLOCK_FLAG ) != 0 &&
4177 alg != PSA_ALG_ECB_NO_PADDING )
mohammad16038481e742018-03-18 13:57:31 +02004178 {
Gilles Peskine8e338702019-07-30 20:06:31 +02004179 operation->iv_size = PSA_BLOCK_CIPHER_BLOCK_SIZE( slot->attr.type );
mohammad16038481e742018-03-18 13:57:31 +02004180 }
Gilles Peskine26869f22019-05-06 15:25:00 +02004181#if defined(MBEDTLS_CHACHA20_C)
4182 else
4183 if( alg == PSA_ALG_CHACHA20 )
4184 operation->iv_size = 12;
4185#endif
mohammad1603503973b2018-03-12 15:59:30 +02004186
Steven Cooreman7df02922020-09-09 15:28:49 +02004187 status = PSA_SUCCESS;
4188
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004189exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02004190 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004191 status = mbedtls_to_psa_error( ret );
Steven Cooreman7df02922020-09-09 15:28:49 +02004192 if( status == PSA_SUCCESS )
4193 {
4194 /* Update operation flags for both driver and software implementations */
4195 operation->key_set = 1;
4196 }
4197 else
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004198 psa_cipher_abort( operation );
4199 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004200}
4201
Gilles Peskinefe119512018-07-08 21:39:34 +02004202psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01004203 psa_key_handle_t handle,
Gilles Peskinefe119512018-07-08 21:39:34 +02004204 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02004205{
Gilles Peskinec5487a82018-12-03 18:08:14 +01004206 return( psa_cipher_setup( operation, handle, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02004207}
4208
Gilles Peskinefe119512018-07-08 21:39:34 +02004209psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01004210 psa_key_handle_t handle,
Gilles Peskinefe119512018-07-08 21:39:34 +02004211 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02004212{
Gilles Peskinec5487a82018-12-03 18:08:14 +01004213 return( psa_cipher_setup( operation, handle, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02004214}
4215
Gilles Peskinefe119512018-07-08 21:39:34 +02004216psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004217 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02004218 size_t iv_size,
4219 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02004220{
itayzafrir534bd7c2018-08-02 13:56:32 +03004221 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00004222 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooreman7df02922020-09-09 15:28:49 +02004223 if( operation->iv_set || ! operation->iv_required )
4224 {
4225 return( PSA_ERROR_BAD_STATE );
4226 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004227
Steven Cooremanef8575e2020-09-11 11:44:50 +02004228 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004229 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004230 status = psa_driver_wrapper_cipher_generate_iv( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004231 iv,
4232 iv_size,
4233 iv_length );
4234 goto exit;
4235 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004236
Moran Peker41deec42018-04-04 15:43:05 +03004237 if( iv_size < operation->iv_size )
mohammad1603503973b2018-03-12 15:59:30 +02004238 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004239 status = PSA_ERROR_BUFFER_TOO_SMALL;
Moran Peker41deec42018-04-04 15:43:05 +03004240 goto exit;
4241 }
Gilles Peskine7e928852018-06-04 16:23:10 +02004242 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg,
4243 iv, operation->iv_size );
Moran Peker41deec42018-04-04 15:43:05 +03004244 if( ret != 0 )
4245 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004246 status = mbedtls_to_psa_error( ret );
Gilles Peskinee553c652018-06-04 16:22:46 +02004247 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004248 }
Gilles Peskinee553c652018-06-04 16:22:46 +02004249
mohammad16038481e742018-03-18 13:57:31 +02004250 *iv_length = operation->iv_size;
itayzafrir534bd7c2018-08-02 13:56:32 +03004251 status = psa_cipher_set_iv( operation, iv, *iv_length );
Moran Peker41deec42018-04-04 15:43:05 +03004252
Moran Peker395db872018-05-31 14:07:14 +03004253exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02004254 if( status == PSA_SUCCESS )
4255 operation->iv_set = 1;
4256 else
Moran Peker395db872018-05-31 14:07:14 +03004257 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004258 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004259}
4260
Gilles Peskinefe119512018-07-08 21:39:34 +02004261psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004262 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02004263 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02004264{
itayzafrir534bd7c2018-08-02 13:56:32 +03004265 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00004266 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooreman7df02922020-09-09 15:28:49 +02004267 if( operation->iv_set || ! operation->iv_required )
4268 {
4269 return( PSA_ERROR_BAD_STATE );
4270 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004271
Steven Cooremanef8575e2020-09-11 11:44:50 +02004272 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004273 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004274 status = psa_driver_wrapper_cipher_set_iv( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004275 iv,
4276 iv_length );
4277 goto exit;
4278 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004279
Moran Pekera28258c2018-05-29 16:25:04 +03004280 if( iv_length != operation->iv_size )
Moran Peker71f19ae2018-04-22 20:23:16 +03004281 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004282 status = PSA_ERROR_INVALID_ARGUMENT;
4283 goto exit;
Moran Peker71f19ae2018-04-22 20:23:16 +03004284 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004285 ret = mbedtls_cipher_set_iv( &operation->ctx.cipher, iv, iv_length );
4286 status = mbedtls_to_psa_error( ret );
4287exit:
4288 if( status == PSA_SUCCESS )
4289 operation->iv_set = 1;
4290 else
mohammad1603503973b2018-03-12 15:59:30 +02004291 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004292 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004293}
4294
Steven Cooreman177deba2020-09-07 17:14:14 +02004295/* Process input for which the algorithm is set to ECB mode. This requires
4296 * manual processing, since the PSA API is defined as being able to process
4297 * arbitrary-length calls to psa_cipher_update() with ECB mode, but the
4298 * underlying mbedtls_cipher_update only takes full blocks. */
4299static psa_status_t psa_cipher_update_ecb_internal(
4300 mbedtls_cipher_context_t *ctx,
4301 const uint8_t *input,
4302 size_t input_length,
4303 uint8_t *output,
4304 size_t output_size,
4305 size_t *output_length )
4306{
4307 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4308 size_t block_size = ctx->cipher_info->block_size;
4309 size_t internal_output_length = 0;
4310 *output_length = 0;
4311
4312 if( input_length == 0 )
4313 {
4314 status = PSA_SUCCESS;
4315 goto exit;
4316 }
4317
4318 if( ctx->unprocessed_len > 0 )
4319 {
4320 /* Fill up to block size, and run the block if there's a full one. */
4321 size_t bytes_to_copy = block_size - ctx->unprocessed_len;
4322
4323 if( input_length < bytes_to_copy )
4324 bytes_to_copy = input_length;
4325
4326 memcpy( &( ctx->unprocessed_data[ctx->unprocessed_len] ),
4327 input, bytes_to_copy );
4328 input_length -= bytes_to_copy;
4329 input += bytes_to_copy;
4330 ctx->unprocessed_len += bytes_to_copy;
4331
4332 if( ctx->unprocessed_len == block_size )
4333 {
4334 status = mbedtls_to_psa_error(
4335 mbedtls_cipher_update( ctx,
4336 ctx->unprocessed_data,
4337 block_size,
4338 output, &internal_output_length ) );
4339
4340 if( status != PSA_SUCCESS )
4341 goto exit;
4342
4343 output += internal_output_length;
4344 output_size -= internal_output_length;
4345 *output_length += internal_output_length;
4346 ctx->unprocessed_len = 0;
4347 }
4348 }
4349
4350 while( input_length >= block_size )
4351 {
4352 /* Run all full blocks we have, one by one */
4353 status = mbedtls_to_psa_error(
4354 mbedtls_cipher_update( ctx, input,
4355 block_size,
4356 output, &internal_output_length ) );
4357
4358 if( status != PSA_SUCCESS )
4359 goto exit;
4360
4361 input_length -= block_size;
4362 input += block_size;
4363
4364 output += internal_output_length;
4365 output_size -= internal_output_length;
4366 *output_length += internal_output_length;
4367 }
4368
4369 if( input_length > 0 )
4370 {
4371 /* Save unprocessed bytes for later processing */
4372 memcpy( &( ctx->unprocessed_data[ctx->unprocessed_len] ),
4373 input, input_length );
4374 ctx->unprocessed_len += input_length;
4375 }
4376
4377 status = PSA_SUCCESS;
4378
4379exit:
4380 return( status );
4381}
4382
Gilles Peskinee553c652018-06-04 16:22:46 +02004383psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
4384 const uint8_t *input,
4385 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004386 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02004387 size_t output_size,
4388 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02004389{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004390 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine89d789c2018-06-04 17:17:16 +02004391 size_t expected_output_size;
Steven Cooreman7df02922020-09-09 15:28:49 +02004392 if( operation->alg == 0 )
4393 {
4394 return( PSA_ERROR_BAD_STATE );
4395 }
4396 if( operation->iv_required && ! operation->iv_set )
4397 {
4398 return( PSA_ERROR_BAD_STATE );
4399 }
Jaeden Ameroab439972019-02-15 14:12:05 +00004400
Steven Cooremanef8575e2020-09-11 11:44:50 +02004401 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004402 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004403 status = psa_driver_wrapper_cipher_update( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004404 input,
4405 input_length,
4406 output,
4407 output_size,
4408 output_length );
4409 goto exit;
4410 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004411
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004412 if( ! PSA_ALG_IS_STREAM_CIPHER( operation->alg ) )
Gilles Peskine89d789c2018-06-04 17:17:16 +02004413 {
4414 /* Take the unprocessed partial block left over from previous
4415 * update calls, if any, plus the input to this call. Remove
4416 * the last partial block, if any. You get the data that will be
4417 * output in this call. */
4418 expected_output_size =
4419 ( operation->ctx.cipher.unprocessed_len + input_length )
4420 / operation->block_size * operation->block_size;
4421 }
4422 else
4423 {
4424 expected_output_size = input_length;
4425 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004426
Gilles Peskine89d789c2018-06-04 17:17:16 +02004427 if( output_size < expected_output_size )
itayzafrir534bd7c2018-08-02 13:56:32 +03004428 {
4429 status = PSA_ERROR_BUFFER_TOO_SMALL;
4430 goto exit;
4431 }
mohammad160382759612018-03-12 18:16:40 +02004432
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004433 if( operation->alg == PSA_ALG_ECB_NO_PADDING )
4434 {
4435 /* mbedtls_cipher_update has an API inconsistency: it will only
4436 * process a single block at a time in ECB mode. Abstract away that
4437 * inconsistency here to match the PSA API behaviour. */
Steven Cooreman177deba2020-09-07 17:14:14 +02004438 status = psa_cipher_update_ecb_internal( &operation->ctx.cipher,
4439 input,
4440 input_length,
4441 output,
4442 output_size,
4443 output_length );
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004444 }
4445 else
4446 {
4447 status = mbedtls_to_psa_error(
4448 mbedtls_cipher_update( &operation->ctx.cipher, input,
4449 input_length, output, output_length ) );
4450 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004451exit:
4452 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02004453 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004454 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004455}
4456
Gilles Peskinee553c652018-06-04 16:22:46 +02004457psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
4458 uint8_t *output,
4459 size_t output_size,
4460 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02004461{
David Saadab4ecc272019-02-14 13:48:10 +02004462 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Gilles Peskinee553c652018-06-04 16:22:46 +02004463 uint8_t temp_output_buffer[MBEDTLS_MAX_BLOCK_LENGTH];
Steven Cooreman7df02922020-09-09 15:28:49 +02004464 if( operation->alg == 0 )
4465 {
4466 return( PSA_ERROR_BAD_STATE );
4467 }
4468 if( operation->iv_required && ! operation->iv_set )
4469 {
4470 return( PSA_ERROR_BAD_STATE );
4471 }
Moran Pekerbed71a22018-04-22 20:19:20 +03004472
Steven Cooremanef8575e2020-09-11 11:44:50 +02004473 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004474 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004475 status = psa_driver_wrapper_cipher_finish( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004476 output,
4477 output_size,
4478 output_length );
Steven Cooremanef8575e2020-09-11 11:44:50 +02004479 goto exit;
Steven Cooreman8b122252020-09-03 15:30:32 +02004480 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004481
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004482 if( operation->ctx.cipher.unprocessed_len != 0 )
Moran Peker7cb22b82018-06-05 11:40:02 +03004483 {
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004484 if( operation->alg == PSA_ALG_ECB_NO_PADDING ||
4485 ( operation->alg == PSA_ALG_CBC_NO_PADDING &&
Steven Cooremana6033e92020-08-25 11:47:50 +02004486 operation->ctx.cipher.operation == MBEDTLS_ENCRYPT ) )
4487 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004488 status = PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004489 goto exit;
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004490 }
Moran Pekerdc38ebc2018-04-30 15:45:34 +03004491 }
4492
Steven Cooremanef8575e2020-09-11 11:44:50 +02004493 status = mbedtls_to_psa_error(
4494 mbedtls_cipher_finish( &operation->ctx.cipher,
4495 temp_output_buffer,
4496 output_length ) );
4497 if( status != PSA_SUCCESS )
4498 goto exit;
Janos Follath315b51c2018-07-09 16:04:51 +01004499
Gilles Peskine46f1fd72018-06-28 19:31:31 +02004500 if( *output_length == 0 )
Janos Follath315b51c2018-07-09 16:04:51 +01004501 ; /* Nothing to copy. Note that output may be NULL in this case. */
Gilles Peskine46f1fd72018-06-28 19:31:31 +02004502 else if( output_size >= *output_length )
Moran Pekerdc38ebc2018-04-30 15:45:34 +03004503 memcpy( output, temp_output_buffer, *output_length );
4504 else
Janos Follath315b51c2018-07-09 16:04:51 +01004505 status = PSA_ERROR_BUFFER_TOO_SMALL;
mohammad1603503973b2018-03-12 15:59:30 +02004506
Steven Cooremanef8575e2020-09-11 11:44:50 +02004507exit:
4508 if( operation->mbedtls_in_use == 1 )
4509 mbedtls_platform_zeroize( temp_output_buffer, sizeof( temp_output_buffer ) );
Janos Follath315b51c2018-07-09 16:04:51 +01004510
Steven Cooremanef8575e2020-09-11 11:44:50 +02004511 if( status == PSA_SUCCESS )
4512 return( psa_cipher_abort( operation ) );
4513 else
4514 {
4515 *output_length = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004516 (void) psa_cipher_abort( operation );
Janos Follath315b51c2018-07-09 16:04:51 +01004517
Steven Cooremanef8575e2020-09-11 11:44:50 +02004518 return( status );
4519 }
mohammad1603503973b2018-03-12 15:59:30 +02004520}
4521
Gilles Peskinee553c652018-06-04 16:22:46 +02004522psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
4523{
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004524 if( operation->alg == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02004525 {
Steven Cooremana07b9972020-09-10 14:54:14 +02004526 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02004527 * in use. It's ok to call abort on such an object, and there's
4528 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004529 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02004530 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004531
Gilles Peskinef9c2c092018-06-21 16:57:07 +02004532 /* Sanity check (shouldn't happen: operation->alg should
4533 * always have been initialized to a valid value). */
4534 if( ! PSA_ALG_IS_CIPHER( operation->alg ) )
4535 return( PSA_ERROR_BAD_STATE );
4536
Steven Cooremanef8575e2020-09-11 11:44:50 +02004537 if( operation->mbedtls_in_use == 0 )
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004538 psa_driver_wrapper_cipher_abort( &operation->ctx.driver );
Steven Cooremand3feccd2020-09-01 15:56:14 +02004539 else
4540 mbedtls_cipher_free( &operation->ctx.cipher );
Gilles Peskinee553c652018-06-04 16:22:46 +02004541
Moran Peker41deec42018-04-04 15:43:05 +03004542 operation->alg = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004543 operation->key_set = 0;
4544 operation->iv_set = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004545 operation->mbedtls_in_use = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004546 operation->iv_size = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004547 operation->block_size = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004548 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004549
Moran Peker395db872018-05-31 14:07:14 +03004550 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02004551}
4552
Gilles Peskinea0655c32018-04-30 17:06:50 +02004553
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004554
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004555
mohammad16035955c982018-04-26 00:53:03 +03004556/****************************************************************/
4557/* AEAD */
4558/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004559
Gilles Peskineedf9a652018-08-17 18:11:56 +02004560typedef struct
4561{
Gilles Peskine2f060a82018-12-04 17:12:32 +01004562 psa_key_slot_t *slot;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004563 const mbedtls_cipher_info_t *cipher_info;
4564 union
4565 {
4566#if defined(MBEDTLS_CCM_C)
4567 mbedtls_ccm_context ccm;
4568#endif /* MBEDTLS_CCM_C */
4569#if defined(MBEDTLS_GCM_C)
4570 mbedtls_gcm_context gcm;
4571#endif /* MBEDTLS_GCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004572#if defined(MBEDTLS_CHACHAPOLY_C)
4573 mbedtls_chachapoly_context chachapoly;
4574#endif /* MBEDTLS_CHACHAPOLY_C */
Gilles Peskineedf9a652018-08-17 18:11:56 +02004575 } ctx;
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004576 psa_algorithm_t core_alg;
4577 uint8_t full_tag_length;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004578 uint8_t tag_length;
4579} aead_operation_t;
4580
Gilles Peskine30a9e412019-01-14 18:36:12 +01004581static void psa_aead_abort_internal( aead_operation_t *operation )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004582{
Gilles Peskinef8a8fe62018-08-21 16:38:05 +02004583 switch( operation->core_alg )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004584 {
4585#if defined(MBEDTLS_CCM_C)
4586 case PSA_ALG_CCM:
4587 mbedtls_ccm_free( &operation->ctx.ccm );
4588 break;
4589#endif /* MBEDTLS_CCM_C */
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004590#if defined(MBEDTLS_GCM_C)
Gilles Peskineedf9a652018-08-17 18:11:56 +02004591 case PSA_ALG_GCM:
4592 mbedtls_gcm_free( &operation->ctx.gcm );
4593 break;
4594#endif /* MBEDTLS_GCM_C */
4595 }
4596}
4597
4598static psa_status_t psa_aead_setup( aead_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01004599 psa_key_handle_t handle,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004600 psa_key_usage_t usage,
4601 psa_algorithm_t alg )
4602{
4603 psa_status_t status;
4604 size_t key_bits;
4605 mbedtls_cipher_id_t cipher_id;
4606
Gilles Peskine28f8f302019-07-24 13:30:31 +02004607 status = psa_get_transparent_key( handle, &operation->slot, usage, alg );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004608 if( status != PSA_SUCCESS )
4609 return( status );
4610
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02004611 key_bits = psa_get_key_slot_bits( operation->slot );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004612
4613 operation->cipher_info =
Gilles Peskine8e338702019-07-30 20:06:31 +02004614 mbedtls_cipher_info_from_psa( alg, operation->slot->attr.type, key_bits,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004615 &cipher_id );
4616 if( operation->cipher_info == NULL )
4617 return( PSA_ERROR_NOT_SUPPORTED );
4618
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004619 switch( PSA_ALG_AEAD_WITH_TAG_LENGTH( alg, 0 ) )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004620 {
4621#if defined(MBEDTLS_CCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004622 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CCM, 0 ):
4623 operation->core_alg = PSA_ALG_CCM;
4624 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004625 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.
4626 * The call to mbedtls_ccm_encrypt_and_tag or
4627 * mbedtls_ccm_auth_decrypt will validate the tag length. */
Gilles Peskine8e338702019-07-30 20:06:31 +02004628 if( PSA_BLOCK_CIPHER_BLOCK_SIZE( operation->slot->attr.type ) != 16 )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004629 return( PSA_ERROR_INVALID_ARGUMENT );
4630 mbedtls_ccm_init( &operation->ctx.ccm );
4631 status = mbedtls_to_psa_error(
4632 mbedtls_ccm_setkey( &operation->ctx.ccm, cipher_id,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004633 operation->slot->data.key.data,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004634 (unsigned int) key_bits ) );
4635 if( status != 0 )
4636 goto cleanup;
4637 break;
4638#endif /* MBEDTLS_CCM_C */
4639
4640#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004641 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_GCM, 0 ):
4642 operation->core_alg = PSA_ALG_GCM;
4643 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004644 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16.
4645 * The call to mbedtls_gcm_crypt_and_tag or
4646 * mbedtls_gcm_auth_decrypt will validate the tag length. */
Gilles Peskine8e338702019-07-30 20:06:31 +02004647 if( PSA_BLOCK_CIPHER_BLOCK_SIZE( operation->slot->attr.type ) != 16 )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004648 return( PSA_ERROR_INVALID_ARGUMENT );
4649 mbedtls_gcm_init( &operation->ctx.gcm );
4650 status = mbedtls_to_psa_error(
4651 mbedtls_gcm_setkey( &operation->ctx.gcm, cipher_id,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004652 operation->slot->data.key.data,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004653 (unsigned int) key_bits ) );
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004654 if( status != 0 )
4655 goto cleanup;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004656 break;
4657#endif /* MBEDTLS_GCM_C */
4658
Gilles Peskine26869f22019-05-06 15:25:00 +02004659#if defined(MBEDTLS_CHACHAPOLY_C)
4660 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CHACHA20_POLY1305, 0 ):
4661 operation->core_alg = PSA_ALG_CHACHA20_POLY1305;
4662 operation->full_tag_length = 16;
4663 /* We only support the default tag length. */
4664 if( alg != PSA_ALG_CHACHA20_POLY1305 )
4665 return( PSA_ERROR_NOT_SUPPORTED );
4666 mbedtls_chachapoly_init( &operation->ctx.chachapoly );
4667 status = mbedtls_to_psa_error(
4668 mbedtls_chachapoly_setkey( &operation->ctx.chachapoly,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004669 operation->slot->data.key.data ) );
Gilles Peskine26869f22019-05-06 15:25:00 +02004670 if( status != 0 )
4671 goto cleanup;
4672 break;
4673#endif /* MBEDTLS_CHACHAPOLY_C */
4674
Gilles Peskineedf9a652018-08-17 18:11:56 +02004675 default:
4676 return( PSA_ERROR_NOT_SUPPORTED );
4677 }
4678
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004679 if( PSA_AEAD_TAG_LENGTH( alg ) > operation->full_tag_length )
4680 {
4681 status = PSA_ERROR_INVALID_ARGUMENT;
4682 goto cleanup;
4683 }
4684 operation->tag_length = PSA_AEAD_TAG_LENGTH( alg );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004685
Gilles Peskineedf9a652018-08-17 18:11:56 +02004686 return( PSA_SUCCESS );
4687
4688cleanup:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004689 psa_aead_abort_internal( operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004690 return( status );
4691}
4692
Gilles Peskinec5487a82018-12-03 18:08:14 +01004693psa_status_t psa_aead_encrypt( psa_key_handle_t handle,
mohammad16035955c982018-04-26 00:53:03 +03004694 psa_algorithm_t alg,
4695 const uint8_t *nonce,
4696 size_t nonce_length,
4697 const uint8_t *additional_data,
4698 size_t additional_data_length,
4699 const uint8_t *plaintext,
4700 size_t plaintext_length,
4701 uint8_t *ciphertext,
4702 size_t ciphertext_size,
4703 size_t *ciphertext_length )
4704{
mohammad16035955c982018-04-26 00:53:03 +03004705 psa_status_t status;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004706 aead_operation_t operation;
mohammad160315223a82018-06-03 17:19:55 +03004707 uint8_t *tag;
Gilles Peskine2d277862018-06-18 15:41:12 +02004708
mohammad1603f08a5502018-06-03 15:05:47 +03004709 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004710
Gilles Peskinec5487a82018-12-03 18:08:14 +01004711 status = psa_aead_setup( &operation, handle, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004712 if( status != PSA_SUCCESS )
4713 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004714
Gilles Peskineedf9a652018-08-17 18:11:56 +02004715 /* For all currently supported modes, the tag is at the end of the
4716 * ciphertext. */
4717 if( ciphertext_size < ( plaintext_length + operation.tag_length ) )
4718 {
4719 status = PSA_ERROR_BUFFER_TOO_SMALL;
4720 goto exit;
4721 }
4722 tag = ciphertext + plaintext_length;
mohammad16035955c982018-04-26 00:53:03 +03004723
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004724#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004725 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03004726 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004727 status = mbedtls_to_psa_error(
4728 mbedtls_gcm_crypt_and_tag( &operation.ctx.gcm,
4729 MBEDTLS_GCM_ENCRYPT,
4730 plaintext_length,
4731 nonce, nonce_length,
4732 additional_data, additional_data_length,
4733 plaintext, ciphertext,
4734 operation.tag_length, tag ) );
mohammad16035955c982018-04-26 00:53:03 +03004735 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004736 else
4737#endif /* MBEDTLS_GCM_C */
4738#if defined(MBEDTLS_CCM_C)
4739 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03004740 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004741 status = mbedtls_to_psa_error(
4742 mbedtls_ccm_encrypt_and_tag( &operation.ctx.ccm,
4743 plaintext_length,
4744 nonce, nonce_length,
4745 additional_data,
4746 additional_data_length,
4747 plaintext, ciphertext,
4748 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03004749 }
mohammad16035c8845f2018-05-09 05:40:09 -07004750 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004751#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004752#if defined(MBEDTLS_CHACHAPOLY_C)
4753 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
4754 {
4755 if( nonce_length != 12 || operation.tag_length != 16 )
4756 {
4757 status = PSA_ERROR_NOT_SUPPORTED;
4758 goto exit;
4759 }
4760 status = mbedtls_to_psa_error(
4761 mbedtls_chachapoly_encrypt_and_tag( &operation.ctx.chachapoly,
4762 plaintext_length,
4763 nonce,
4764 additional_data,
4765 additional_data_length,
4766 plaintext,
4767 ciphertext,
4768 tag ) );
4769 }
4770 else
4771#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad16035c8845f2018-05-09 05:40:09 -07004772 {
mohammad1603554faad2018-06-03 15:07:38 +03004773 return( PSA_ERROR_NOT_SUPPORTED );
mohammad16035c8845f2018-05-09 05:40:09 -07004774 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004775
Gilles Peskineedf9a652018-08-17 18:11:56 +02004776 if( status != PSA_SUCCESS && ciphertext_size != 0 )
4777 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02004778
Gilles Peskineedf9a652018-08-17 18:11:56 +02004779exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004780 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004781 if( status == PSA_SUCCESS )
4782 *ciphertext_length = plaintext_length + operation.tag_length;
4783 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004784}
4785
Gilles Peskineee652a32018-06-01 19:23:52 +02004786/* Locate the tag in a ciphertext buffer containing the encrypted data
4787 * followed by the tag. Return the length of the part preceding the tag in
4788 * *plaintext_length. This is the size of the plaintext in modes where
4789 * the encrypted data has the same size as the plaintext, such as
4790 * CCM and GCM. */
4791static psa_status_t psa_aead_unpadded_locate_tag( size_t tag_length,
4792 const uint8_t *ciphertext,
4793 size_t ciphertext_length,
4794 size_t plaintext_size,
Gilles Peskineee652a32018-06-01 19:23:52 +02004795 const uint8_t **p_tag )
4796{
4797 size_t payload_length;
4798 if( tag_length > ciphertext_length )
4799 return( PSA_ERROR_INVALID_ARGUMENT );
4800 payload_length = ciphertext_length - tag_length;
4801 if( payload_length > plaintext_size )
4802 return( PSA_ERROR_BUFFER_TOO_SMALL );
4803 *p_tag = ciphertext + payload_length;
Gilles Peskineee652a32018-06-01 19:23:52 +02004804 return( PSA_SUCCESS );
4805}
4806
Gilles Peskinec5487a82018-12-03 18:08:14 +01004807psa_status_t psa_aead_decrypt( psa_key_handle_t handle,
mohammad16035955c982018-04-26 00:53:03 +03004808 psa_algorithm_t alg,
4809 const uint8_t *nonce,
4810 size_t nonce_length,
4811 const uint8_t *additional_data,
4812 size_t additional_data_length,
4813 const uint8_t *ciphertext,
4814 size_t ciphertext_length,
4815 uint8_t *plaintext,
4816 size_t plaintext_size,
4817 size_t *plaintext_length )
4818{
mohammad16035955c982018-04-26 00:53:03 +03004819 psa_status_t status;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004820 aead_operation_t operation;
4821 const uint8_t *tag = NULL;
Gilles Peskine2d277862018-06-18 15:41:12 +02004822
Gilles Peskineee652a32018-06-01 19:23:52 +02004823 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004824
Gilles Peskinec5487a82018-12-03 18:08:14 +01004825 status = psa_aead_setup( &operation, handle, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004826 if( status != PSA_SUCCESS )
4827 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004828
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004829 status = psa_aead_unpadded_locate_tag( operation.tag_length,
4830 ciphertext, ciphertext_length,
4831 plaintext_size, &tag );
4832 if( status != PSA_SUCCESS )
4833 goto exit;
4834
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004835#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004836 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03004837 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004838 status = mbedtls_to_psa_error(
4839 mbedtls_gcm_auth_decrypt( &operation.ctx.gcm,
4840 ciphertext_length - operation.tag_length,
4841 nonce, nonce_length,
4842 additional_data,
4843 additional_data_length,
4844 tag, operation.tag_length,
4845 ciphertext, plaintext ) );
mohammad16035955c982018-04-26 00:53:03 +03004846 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004847 else
4848#endif /* MBEDTLS_GCM_C */
4849#if defined(MBEDTLS_CCM_C)
4850 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03004851 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004852 status = mbedtls_to_psa_error(
4853 mbedtls_ccm_auth_decrypt( &operation.ctx.ccm,
4854 ciphertext_length - operation.tag_length,
4855 nonce, nonce_length,
4856 additional_data,
4857 additional_data_length,
4858 ciphertext, plaintext,
4859 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03004860 }
mohammad160339574652018-06-01 04:39:53 -07004861 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004862#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004863#if defined(MBEDTLS_CHACHAPOLY_C)
4864 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
4865 {
4866 if( nonce_length != 12 || operation.tag_length != 16 )
4867 {
4868 status = PSA_ERROR_NOT_SUPPORTED;
4869 goto exit;
4870 }
4871 status = mbedtls_to_psa_error(
4872 mbedtls_chachapoly_auth_decrypt( &operation.ctx.chachapoly,
4873 ciphertext_length - operation.tag_length,
4874 nonce,
4875 additional_data,
4876 additional_data_length,
4877 tag,
4878 ciphertext,
4879 plaintext ) );
4880 }
4881 else
4882#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad160339574652018-06-01 04:39:53 -07004883 {
mohammad1603554faad2018-06-03 15:07:38 +03004884 return( PSA_ERROR_NOT_SUPPORTED );
mohammad160339574652018-06-01 04:39:53 -07004885 }
Gilles Peskinea40d7742018-06-01 16:28:30 +02004886
Gilles Peskineedf9a652018-08-17 18:11:56 +02004887 if( status != PSA_SUCCESS && plaintext_size != 0 )
4888 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03004889
Gilles Peskineedf9a652018-08-17 18:11:56 +02004890exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004891 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004892 if( status == PSA_SUCCESS )
4893 *plaintext_length = ciphertext_length - operation.tag_length;
4894 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004895}
4896
Gilles Peskinea0655c32018-04-30 17:06:50 +02004897
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004898
Gilles Peskine20035e32018-02-03 22:44:14 +01004899/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02004900/* Generators */
4901/****************************************************************/
4902
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004903#define HKDF_STATE_INIT 0 /* no input yet */
4904#define HKDF_STATE_STARTED 1 /* got salt */
4905#define HKDF_STATE_KEYED 2 /* got key */
4906#define HKDF_STATE_OUTPUT 3 /* output started */
4907
Gilles Peskinecbe66502019-05-16 16:59:18 +02004908static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004909 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004910{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004911 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
4912 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004913 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004914 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004915}
4916
4917
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004918psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004919{
4920 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004921 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004922 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004923 {
4924 /* The object has (apparently) been initialized but it is not
4925 * in use. It's ok to call abort on such an object, and there's
4926 * nothing to do. */
4927 }
4928 else
Gilles Peskinebef7f142018-07-12 17:22:21 +02004929#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004930 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004931 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004932 mbedtls_free( operation->ctx.hkdf.info );
4933 status = psa_hmac_abort_internal( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004934 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01004935 else if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004936 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004937 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004938 {
Janos Follath6a1d2622019-06-11 10:37:28 +01004939 if( operation->ctx.tls12_prf.seed != NULL )
4940 {
4941 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
4942 operation->ctx.tls12_prf.seed_length );
4943 mbedtls_free( operation->ctx.tls12_prf.seed );
4944 }
4945
4946 if( operation->ctx.tls12_prf.label != NULL )
4947 {
4948 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
4949 operation->ctx.tls12_prf.label_length );
4950 mbedtls_free( operation->ctx.tls12_prf.label );
4951 }
4952
4953 status = psa_hmac_abort_internal( &operation->ctx.tls12_prf.hmac );
4954
4955 /* We leave the fields Ai and output_block to be erased safely by the
4956 * mbedtls_platform_zeroize() in the end of this function. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004957 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004958 else
4959#endif /* MBEDTLS_MD_C */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004960 {
4961 status = PSA_ERROR_BAD_STATE;
4962 }
Janos Follath083036a2019-06-11 10:22:26 +01004963 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004964 return( status );
4965}
4966
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004967psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02004968 size_t *capacity)
4969{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004970 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004971 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004972 /* This is a blank key derivation operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02004973 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004974 }
4975
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004976 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004977 return( PSA_SUCCESS );
4978}
4979
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004980psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004981 size_t capacity )
4982{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004983 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004984 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004985 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004986 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004987 operation->capacity = capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004988 return( PSA_SUCCESS );
4989}
4990
Gilles Peskinebef7f142018-07-12 17:22:21 +02004991#if defined(MBEDTLS_MD_C)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004992/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02004993 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02004994static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskinebef7f142018-07-12 17:22:21 +02004995 psa_algorithm_t hash_alg,
4996 uint8_t *output,
4997 size_t output_length )
4998{
4999 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
5000 psa_status_t status;
5001
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005002 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
5003 return( PSA_ERROR_BAD_STATE );
5004 hkdf->state = HKDF_STATE_OUTPUT;
5005
Gilles Peskinebef7f142018-07-12 17:22:21 +02005006 while( output_length != 0 )
5007 {
5008 /* Copy what remains of the current block */
5009 uint8_t n = hash_length - hkdf->offset_in_block;
5010 if( n > output_length )
5011 n = (uint8_t) output_length;
5012 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
5013 output += n;
5014 output_length -= n;
5015 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02005016 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02005017 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02005018 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005019 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005020 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02005021 * object was corrupted or if this function is called directly
5022 * inside the library. */
5023 if( hkdf->block_number == 0xff )
5024 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02005025
5026 /* We need a new block */
5027 ++hkdf->block_number;
5028 hkdf->offset_in_block = 0;
5029 status = psa_hmac_setup_internal( &hkdf->hmac,
5030 hkdf->prk, hash_length,
5031 hash_alg );
5032 if( status != PSA_SUCCESS )
5033 return( status );
5034 if( hkdf->block_number != 1 )
5035 {
5036 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5037 hkdf->output_block,
5038 hash_length );
5039 if( status != PSA_SUCCESS )
5040 return( status );
5041 }
5042 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5043 hkdf->info,
5044 hkdf->info_length );
5045 if( status != PSA_SUCCESS )
5046 return( status );
5047 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5048 &hkdf->block_number, 1 );
5049 if( status != PSA_SUCCESS )
5050 return( status );
5051 status = psa_hmac_finish_internal( &hkdf->hmac,
5052 hkdf->output_block,
5053 sizeof( hkdf->output_block ) );
5054 if( status != PSA_SUCCESS )
5055 return( status );
5056 }
5057
5058 return( PSA_SUCCESS );
5059}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005060
Janos Follath7742fee2019-06-17 12:58:10 +01005061static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
5062 psa_tls12_prf_key_derivation_t *tls12_prf,
5063 psa_algorithm_t alg )
5064{
5065 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
5066 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
Janos Follathea29bfb2019-06-19 12:21:20 +01005067 psa_hash_operation_t backup = PSA_HASH_OPERATION_INIT;
5068 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005069
Janos Follath7742fee2019-06-17 12:58:10 +01005070 /* We can't be wanting more output after block 0xff, otherwise
5071 * the capacity check in psa_key_derivation_output_bytes() would have
5072 * prevented this call. It could happen only if the operation
5073 * object was corrupted or if this function is called directly
5074 * inside the library. */
5075 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01005076 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01005077
5078 /* We need a new block */
5079 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01005080 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01005081
5082 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
5083 *
5084 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
5085 *
5086 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
5087 * HMAC_hash(secret, A(2) + seed) +
5088 * HMAC_hash(secret, A(3) + seed) + ...
5089 *
5090 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01005091 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01005092 *
Janos Follathea29bfb2019-06-19 12:21:20 +01005093 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01005094 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01005095 * is currently extracted as `output_block` and where i is
5096 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01005097 */
5098
Janos Follathea29bfb2019-06-19 12:21:20 +01005099 /* Save the hash context before using it, to preserve the hash state with
5100 * only the inner padding in it. We need this, because inner padding depends
5101 * on the key (secret in the RFC's terminology). */
5102 status = psa_hash_clone( &tls12_prf->hmac.hash_ctx, &backup );
5103 if( status != PSA_SUCCESS )
5104 goto cleanup;
5105
5106 /* Calculate A(i) where i = tls12_prf->block_number. */
5107 if( tls12_prf->block_number == 1 )
5108 {
5109 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
5110 * the variable seed and in this instance means it in the context of the
5111 * P_hash function, where seed = label + seed.) */
5112 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5113 tls12_prf->label, tls12_prf->label_length );
5114 if( status != PSA_SUCCESS )
5115 goto cleanup;
5116 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5117 tls12_prf->seed, tls12_prf->seed_length );
5118 if( status != PSA_SUCCESS )
5119 goto cleanup;
5120 }
5121 else
5122 {
5123 /* A(i) = HMAC_hash(secret, A(i-1)) */
5124 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5125 tls12_prf->Ai, hash_length );
5126 if( status != PSA_SUCCESS )
5127 goto cleanup;
5128 }
5129
5130 status = psa_hmac_finish_internal( &tls12_prf->hmac,
5131 tls12_prf->Ai, hash_length );
5132 if( status != PSA_SUCCESS )
5133 goto cleanup;
5134 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
5135 if( status != PSA_SUCCESS )
5136 goto cleanup;
5137
5138 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
5139 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5140 tls12_prf->Ai, hash_length );
5141 if( status != PSA_SUCCESS )
5142 goto cleanup;
5143 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5144 tls12_prf->label, tls12_prf->label_length );
5145 if( status != PSA_SUCCESS )
5146 goto cleanup;
5147 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5148 tls12_prf->seed, tls12_prf->seed_length );
5149 if( status != PSA_SUCCESS )
5150 goto cleanup;
5151 status = psa_hmac_finish_internal( &tls12_prf->hmac,
5152 tls12_prf->output_block, hash_length );
5153 if( status != PSA_SUCCESS )
5154 goto cleanup;
5155 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
5156 if( status != PSA_SUCCESS )
5157 goto cleanup;
5158
Janos Follath7742fee2019-06-17 12:58:10 +01005159
5160cleanup:
5161
Janos Follathea29bfb2019-06-19 12:21:20 +01005162 cleanup_status = psa_hash_abort( &backup );
5163 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
5164 status = cleanup_status;
5165
5166 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01005167}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005168
Janos Follath844eb0e2019-06-19 12:10:49 +01005169static psa_status_t psa_key_derivation_tls12_prf_read(
5170 psa_tls12_prf_key_derivation_t *tls12_prf,
5171 psa_algorithm_t alg,
5172 uint8_t *output,
5173 size_t output_length )
5174{
5175 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
5176 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
5177 psa_status_t status;
5178 uint8_t offset, length;
5179
5180 while( output_length != 0 )
5181 {
5182 /* Check if we have fully processed the current block. */
5183 if( tls12_prf->left_in_block == 0 )
5184 {
5185 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
5186 alg );
5187 if( status != PSA_SUCCESS )
5188 return( status );
5189
5190 continue;
5191 }
5192
5193 if( tls12_prf->left_in_block > output_length )
5194 length = (uint8_t) output_length;
5195 else
5196 length = tls12_prf->left_in_block;
5197
5198 offset = hash_length - tls12_prf->left_in_block;
5199 memcpy( output, tls12_prf->output_block + offset, length );
5200 output += length;
5201 output_length -= length;
5202 tls12_prf->left_in_block -= length;
5203 }
5204
5205 return( PSA_SUCCESS );
5206}
Gilles Peskinebef7f142018-07-12 17:22:21 +02005207#endif /* MBEDTLS_MD_C */
5208
Janos Follath6c6c8fc2019-06-17 12:38:20 +01005209psa_status_t psa_key_derivation_output_bytes(
5210 psa_key_derivation_operation_t *operation,
5211 uint8_t *output,
5212 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005213{
5214 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005215 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005216
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005217 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005218 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005219 /* This is a blank operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02005220 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005221 }
5222
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005223 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005224 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005225 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005226 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005227 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02005228 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005229 goto exit;
5230 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005231 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005232 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005233 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005234 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02005235 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
5236 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005237 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02005238 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02005239 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005240 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005241 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005242
Gilles Peskinebef7f142018-07-12 17:22:21 +02005243#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005244 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02005245 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01005246 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005247 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02005248 output, output_length );
5249 }
Janos Follathadbec812019-06-14 11:05:39 +01005250 else
Janos Follathadbec812019-06-14 11:05:39 +01005251 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine969c5d62019-01-16 15:53:06 +01005252 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005253 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005254 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005255 kdf_alg, output,
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005256 output_length );
5257 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005258 else
5259#endif /* MBEDTLS_MD_C */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005260 {
5261 return( PSA_ERROR_BAD_STATE );
5262 }
5263
5264exit:
5265 if( status != PSA_SUCCESS )
5266 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005267 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005268 * This allows us to differentiate between exhausted operations and
5269 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
5270 * operations. */
5271 psa_algorithm_t alg = operation->alg;
5272 psa_key_derivation_abort( operation );
5273 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005274 memset( output, '!', output_length );
5275 }
5276 return( status );
5277}
5278
Gilles Peskine08542d82018-07-19 17:05:42 +02005279#if defined(MBEDTLS_DES_C)
5280static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
5281{
5282 if( data_size >= 8 )
5283 mbedtls_des_key_set_parity( data );
5284 if( data_size >= 16 )
5285 mbedtls_des_key_set_parity( data + 8 );
5286 if( data_size >= 24 )
5287 mbedtls_des_key_set_parity( data + 16 );
5288}
5289#endif /* MBEDTLS_DES_C */
5290
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005291static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005292 psa_key_slot_t *slot,
5293 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005294 psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005295{
5296 uint8_t *data = NULL;
5297 size_t bytes = PSA_BITS_TO_BYTES( bits );
5298 psa_status_t status;
5299
Gilles Peskine8e338702019-07-30 20:06:31 +02005300 if( ! key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005301 return( PSA_ERROR_INVALID_ARGUMENT );
5302 if( bits % 8 != 0 )
5303 return( PSA_ERROR_INVALID_ARGUMENT );
5304 data = mbedtls_calloc( 1, bytes );
5305 if( data == NULL )
5306 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5307
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005308 status = psa_key_derivation_output_bytes( operation, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005309 if( status != PSA_SUCCESS )
5310 goto exit;
Gilles Peskine08542d82018-07-19 17:05:42 +02005311#if defined(MBEDTLS_DES_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02005312 if( slot->attr.type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02005313 psa_des_set_key_parity( data, bytes );
5314#endif /* MBEDTLS_DES_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005315 status = psa_import_key_into_slot( slot, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005316
5317exit:
5318 mbedtls_free( data );
5319 return( status );
5320}
5321
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005322psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005323 psa_key_derivation_operation_t *operation,
Gilles Peskine98dd7792019-05-15 19:43:49 +02005324 psa_key_handle_t *handle )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005325{
5326 psa_status_t status;
5327 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005328 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02005329
5330 /* Reject any attempt to create a zero-length key so that we don't
5331 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
5332 if( psa_get_key_bits( attributes ) == 0 )
5333 return( PSA_ERROR_INVALID_ARGUMENT );
5334
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005335 if( ! operation->can_output_key )
5336 return( PSA_ERROR_NOT_PERMITTED );
5337
Gilles Peskinedf179142019-07-15 22:02:14 +02005338 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE,
5339 attributes, handle, &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02005340#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
5341 if( driver != NULL )
5342 {
5343 /* Deriving a key in a secure element is not implemented yet. */
5344 status = PSA_ERROR_NOT_SUPPORTED;
5345 }
5346#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005347 if( status == PSA_SUCCESS )
5348 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005349 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02005350 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005351 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005352 }
5353 if( status == PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02005354 status = psa_finish_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005355 if( status != PSA_SUCCESS )
5356 {
Gilles Peskine011e4282019-06-26 18:34:38 +02005357 psa_fail_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005358 *handle = 0;
5359 }
5360 return( status );
5361}
5362
Gilles Peskineeab56e42018-07-12 17:12:33 +02005363
5364
5365/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02005366/* Key derivation */
5367/****************************************************************/
5368
Gilles Peskine969c5d62019-01-16 15:53:06 +01005369static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005370 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005371 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005372{
Janos Follath5fe19732019-06-20 15:09:30 +01005373 /* Make sure that operation->ctx is properly zero-initialised. (Macro
5374 * initialisers for this union leave some bytes unspecified.) */
5375 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
5376
Gilles Peskine969c5d62019-01-16 15:53:06 +01005377 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005378#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005379 if( PSA_ALG_IS_HKDF( kdf_alg ) ||
5380 PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
5381 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005382 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01005383 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005384 size_t hash_size = PSA_HASH_SIZE( hash_alg );
5385 if( hash_size == 0 )
5386 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005387 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
5388 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02005389 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005390 {
5391 return( PSA_ERROR_NOT_SUPPORTED );
5392 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005393 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01005394 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005395 }
5396#endif /* MBEDTLS_MD_C */
Gilles Peskine969c5d62019-01-16 15:53:06 +01005397 else
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005398 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005399}
5400
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005401psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005402 psa_algorithm_t alg )
5403{
5404 psa_status_t status;
5405
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005406 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005407 return( PSA_ERROR_BAD_STATE );
5408
Gilles Peskine6843c292019-01-18 16:44:49 +01005409 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
5410 return( PSA_ERROR_INVALID_ARGUMENT );
5411 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005412 {
5413 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005414 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005415 }
5416 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
5417 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005418 status = psa_key_derivation_setup_kdf( operation, alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005419 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005420 else
5421 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005422
5423 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005424 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01005425 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005426}
5427
5428#if defined(MBEDTLS_MD_C)
Gilles Peskinecbe66502019-05-16 16:59:18 +02005429static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005430 psa_algorithm_t hash_alg,
5431 psa_key_derivation_step_t step,
5432 const uint8_t *data,
5433 size_t data_length )
5434{
5435 psa_status_t status;
5436 switch( step )
5437 {
Gilles Peskine03410b52019-05-16 16:05:19 +02005438 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02005439 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005440 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005441 status = psa_hmac_setup_internal( &hkdf->hmac,
5442 data, data_length,
5443 hash_alg );
5444 if( status != PSA_SUCCESS )
5445 return( status );
5446 hkdf->state = HKDF_STATE_STARTED;
5447 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02005448 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005449 /* If no salt was provided, use an empty salt. */
5450 if( hkdf->state == HKDF_STATE_INIT )
5451 {
5452 status = psa_hmac_setup_internal( &hkdf->hmac,
5453 NULL, 0,
Gilles Peskinef9ee6332019-04-11 21:22:52 +02005454 hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005455 if( status != PSA_SUCCESS )
5456 return( status );
5457 hkdf->state = HKDF_STATE_STARTED;
5458 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02005459 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005460 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005461 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5462 data, data_length );
5463 if( status != PSA_SUCCESS )
5464 return( status );
5465 status = psa_hmac_finish_internal( &hkdf->hmac,
5466 hkdf->prk,
5467 sizeof( hkdf->prk ) );
5468 if( status != PSA_SUCCESS )
5469 return( status );
5470 hkdf->offset_in_block = PSA_HASH_SIZE( hash_alg );
5471 hkdf->block_number = 0;
5472 hkdf->state = HKDF_STATE_KEYED;
5473 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02005474 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005475 if( hkdf->state == HKDF_STATE_OUTPUT )
5476 return( PSA_ERROR_BAD_STATE );
5477 if( hkdf->info_set )
5478 return( PSA_ERROR_BAD_STATE );
5479 hkdf->info_length = data_length;
5480 if( data_length != 0 )
5481 {
5482 hkdf->info = mbedtls_calloc( 1, data_length );
5483 if( hkdf->info == NULL )
5484 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5485 memcpy( hkdf->info, data, data_length );
5486 }
5487 hkdf->info_set = 1;
5488 return( PSA_SUCCESS );
5489 default:
5490 return( PSA_ERROR_INVALID_ARGUMENT );
5491 }
5492}
Janos Follathb03233e2019-06-11 15:30:30 +01005493
Janos Follathf08e2652019-06-13 09:05:41 +01005494static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
5495 const uint8_t *data,
5496 size_t data_length )
5497{
5498 if( prf->state != TLS12_PRF_STATE_INIT )
5499 return( PSA_ERROR_BAD_STATE );
5500
Janos Follathd6dce9f2019-07-04 09:11:38 +01005501 if( data_length != 0 )
5502 {
5503 prf->seed = mbedtls_calloc( 1, data_length );
5504 if( prf->seed == NULL )
5505 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01005506
Janos Follathd6dce9f2019-07-04 09:11:38 +01005507 memcpy( prf->seed, data, data_length );
5508 prf->seed_length = data_length;
5509 }
Janos Follathf08e2652019-06-13 09:05:41 +01005510
5511 prf->state = TLS12_PRF_STATE_SEED_SET;
5512
5513 return( PSA_SUCCESS );
5514}
5515
Janos Follath81550542019-06-13 14:26:34 +01005516static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
5517 psa_algorithm_t hash_alg,
5518 const uint8_t *data,
5519 size_t data_length )
5520{
5521 psa_status_t status;
5522 if( prf->state != TLS12_PRF_STATE_SEED_SET )
5523 return( PSA_ERROR_BAD_STATE );
5524
5525 status = psa_hmac_setup_internal( &prf->hmac, data, data_length, hash_alg );
5526 if( status != PSA_SUCCESS )
5527 return( status );
5528
5529 prf->state = TLS12_PRF_STATE_KEY_SET;
5530
5531 return( PSA_SUCCESS );
5532}
5533
Janos Follath6660f0e2019-06-17 08:44:03 +01005534static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
5535 psa_tls12_prf_key_derivation_t *prf,
5536 psa_algorithm_t hash_alg,
5537 const uint8_t *data,
5538 size_t data_length )
5539{
5540 psa_status_t status;
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02005541 uint8_t pms[ 4 + 2 * PSA_ALG_TLS12_PSK_TO_MS_MAX_PSK_LEN ];
5542 uint8_t *cur = pms;
Janos Follath6660f0e2019-06-17 08:44:03 +01005543
5544 if( data_length > PSA_ALG_TLS12_PSK_TO_MS_MAX_PSK_LEN )
5545 return( PSA_ERROR_INVALID_ARGUMENT );
5546
5547 /* Quoting RFC 4279, Section 2:
5548 *
5549 * The premaster secret is formed as follows: if the PSK is N octets
5550 * long, concatenate a uint16 with the value N, N zero octets, a second
5551 * uint16 with the value N, and the PSK itself.
5552 */
5553
Janos Follath40e13932019-06-26 13:22:29 +01005554 *cur++ = ( data_length >> 8 ) & 0xff;
5555 *cur++ = ( data_length >> 0 ) & 0xff;
5556 memset( cur, 0, data_length );
5557 cur += data_length;
5558 *cur++ = pms[0];
5559 *cur++ = pms[1];
5560 memcpy( cur, data, data_length );
5561 cur += data_length;
Janos Follath6660f0e2019-06-17 08:44:03 +01005562
Janos Follath40e13932019-06-26 13:22:29 +01005563 status = psa_tls12_prf_set_key( prf, hash_alg, pms, cur - pms );
Janos Follath6660f0e2019-06-17 08:44:03 +01005564
5565 mbedtls_platform_zeroize( pms, sizeof( pms ) );
5566 return( status );
5567}
5568
Janos Follath63028dd2019-06-13 09:15:47 +01005569static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
5570 const uint8_t *data,
5571 size_t data_length )
5572{
5573 if( prf->state != TLS12_PRF_STATE_KEY_SET )
5574 return( PSA_ERROR_BAD_STATE );
5575
Janos Follathd6dce9f2019-07-04 09:11:38 +01005576 if( data_length != 0 )
5577 {
5578 prf->label = mbedtls_calloc( 1, data_length );
5579 if( prf->label == NULL )
5580 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01005581
Janos Follathd6dce9f2019-07-04 09:11:38 +01005582 memcpy( prf->label, data, data_length );
5583 prf->label_length = data_length;
5584 }
Janos Follath63028dd2019-06-13 09:15:47 +01005585
5586 prf->state = TLS12_PRF_STATE_LABEL_SET;
5587
5588 return( PSA_SUCCESS );
5589}
5590
Janos Follathb03233e2019-06-11 15:30:30 +01005591static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
5592 psa_algorithm_t hash_alg,
5593 psa_key_derivation_step_t step,
5594 const uint8_t *data,
5595 size_t data_length )
5596{
Janos Follathb03233e2019-06-11 15:30:30 +01005597 switch( step )
5598 {
Janos Follathf08e2652019-06-13 09:05:41 +01005599 case PSA_KEY_DERIVATION_INPUT_SEED:
5600 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01005601 case PSA_KEY_DERIVATION_INPUT_SECRET:
5602 return( psa_tls12_prf_set_key( prf, hash_alg, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01005603 case PSA_KEY_DERIVATION_INPUT_LABEL:
5604 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01005605 default:
5606 return( PSA_ERROR_INVALID_ARGUMENT );
5607 }
5608}
Janos Follath6660f0e2019-06-17 08:44:03 +01005609
5610static psa_status_t psa_tls12_prf_psk_to_ms_input(
5611 psa_tls12_prf_key_derivation_t *prf,
5612 psa_algorithm_t hash_alg,
5613 psa_key_derivation_step_t step,
5614 const uint8_t *data,
5615 size_t data_length )
5616{
5617 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01005618 {
Janos Follath6660f0e2019-06-17 08:44:03 +01005619 return( psa_tls12_prf_psk_to_ms_set_key( prf, hash_alg,
5620 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01005621 }
Janos Follath6660f0e2019-06-17 08:44:03 +01005622
5623 return( psa_tls12_prf_input( prf, hash_alg, step, data, data_length ) );
5624}
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005625#endif /* MBEDTLS_MD_C */
5626
Gilles Peskineb8965192019-09-24 16:21:10 +02005627/** Check whether the given key type is acceptable for the given
5628 * input step of a key derivation.
5629 *
5630 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
5631 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
5632 * Both secret and non-secret inputs can alternatively have the type
5633 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
5634 * that the input was passed as a buffer rather than via a key object.
5635 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02005636static int psa_key_derivation_check_input_type(
5637 psa_key_derivation_step_t step,
5638 psa_key_type_t key_type )
5639{
5640 switch( step )
5641 {
5642 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb8965192019-09-24 16:21:10 +02005643 if( key_type == PSA_KEY_TYPE_DERIVE )
5644 return( PSA_SUCCESS );
5645 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005646 return( PSA_SUCCESS );
5647 break;
5648 case PSA_KEY_DERIVATION_INPUT_LABEL:
5649 case PSA_KEY_DERIVATION_INPUT_SALT:
5650 case PSA_KEY_DERIVATION_INPUT_INFO:
5651 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskineb8965192019-09-24 16:21:10 +02005652 if( key_type == PSA_KEY_TYPE_RAW_DATA )
5653 return( PSA_SUCCESS );
5654 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005655 return( PSA_SUCCESS );
5656 break;
5657 }
5658 return( PSA_ERROR_INVALID_ARGUMENT );
5659}
5660
Janos Follathb80a94e2019-06-12 15:54:46 +01005661static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005662 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005663 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005664 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005665 const uint8_t *data,
5666 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005667{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02005668 psa_status_t status;
5669 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
5670
5671 status = psa_key_derivation_check_input_type( step, key_type );
Gilles Peskine224b0d62019-09-23 18:13:17 +02005672 if( status != PSA_SUCCESS )
5673 goto exit;
5674
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005675#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005676 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005677 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005678 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005679 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005680 step, data, data_length );
5681 }
k-stachowiak012dcc42019-08-13 14:55:03 +02005682 else if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005683 {
Janos Follathb03233e2019-06-11 15:30:30 +01005684 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
5685 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5686 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01005687 }
5688 else if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
5689 {
5690 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
5691 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5692 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005693 }
5694 else
5695#endif /* MBEDTLS_MD_C */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005696 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005697 /* This can't happen unless the operation object was not initialized */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005698 return( PSA_ERROR_BAD_STATE );
5699 }
5700
Gilles Peskine224b0d62019-09-23 18:13:17 +02005701exit:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005702 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005703 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005704 return( status );
5705}
5706
Janos Follath51f4a0f2019-06-14 11:35:55 +01005707psa_status_t psa_key_derivation_input_bytes(
5708 psa_key_derivation_operation_t *operation,
5709 psa_key_derivation_step_t step,
5710 const uint8_t *data,
5711 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005712{
Gilles Peskineb8965192019-09-24 16:21:10 +02005713 return( psa_key_derivation_input_internal( operation, step,
5714 PSA_KEY_TYPE_NONE,
Janos Follathc5621512019-06-14 11:27:57 +01005715 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005716}
5717
Janos Follath51f4a0f2019-06-14 11:35:55 +01005718psa_status_t psa_key_derivation_input_key(
5719 psa_key_derivation_operation_t *operation,
5720 psa_key_derivation_step_t step,
5721 psa_key_handle_t handle )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005722{
5723 psa_key_slot_t *slot;
5724 psa_status_t status;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005725
Gilles Peskine28f8f302019-07-24 13:30:31 +02005726 status = psa_get_transparent_key( handle, &slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02005727 PSA_KEY_USAGE_DERIVE,
5728 operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005729 if( status != PSA_SUCCESS )
Gilles Peskine593773d2019-09-23 18:17:40 +02005730 {
5731 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005732 return( status );
Gilles Peskine593773d2019-09-23 18:17:40 +02005733 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005734
5735 /* Passing a key object as a SECRET input unlocks the permission
5736 * to output to a key object. */
5737 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5738 operation->can_output_key = 1;
5739
Janos Follathb80a94e2019-06-12 15:54:46 +01005740 return( psa_key_derivation_input_internal( operation,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005741 step, slot->attr.type,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02005742 slot->data.key.data,
5743 slot->data.key.bytes ) );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005744}
Gilles Peskineea0fb492018-07-12 17:17:20 +02005745
5746
5747
5748/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02005749/* Key agreement */
5750/****************************************************************/
5751
Gilles Peskinea05219c2018-11-16 16:02:56 +01005752#if defined(MBEDTLS_ECDH_C)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005753static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
5754 size_t peer_key_length,
5755 const mbedtls_ecp_keypair *our_key,
5756 uint8_t *shared_secret,
5757 size_t shared_secret_size,
5758 size_t *shared_secret_length )
5759{
Steven Cooremand4867872020-08-05 16:31:39 +02005760 mbedtls_ecp_keypair *their_key = NULL;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005761 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00005762 psa_status_t status;
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005763 size_t bits = 0;
Paul Elliott8ff510a2020-06-02 17:19:28 +01005764 psa_ecc_family_t curve = mbedtls_ecc_group_to_psa( our_key->grp.id, &bits );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005765 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005766
Steven Cooreman4fed4552020-08-03 14:46:03 +02005767 status = psa_load_ecp_representation( PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve),
5768 peer_key,
Steven Cooreman7f391872020-07-30 14:57:44 +02005769 peer_key_length,
Steven Cooreman7f391872020-07-30 14:57:44 +02005770 &their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00005771 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005772 goto exit;
5773
Jaeden Amero97271b32019-01-10 19:38:51 +00005774 status = mbedtls_to_psa_error(
Steven Cooremana2371e52020-07-28 14:30:39 +02005775 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
Jaeden Amero97271b32019-01-10 19:38:51 +00005776 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005777 goto exit;
Jaeden Amero97271b32019-01-10 19:38:51 +00005778 status = mbedtls_to_psa_error(
5779 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
5780 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005781 goto exit;
5782
Jaeden Amero97271b32019-01-10 19:38:51 +00005783 status = mbedtls_to_psa_error(
5784 mbedtls_ecdh_calc_secret( &ecdh,
5785 shared_secret_length,
5786 shared_secret, shared_secret_size,
5787 mbedtls_ctr_drbg_random,
5788 &global_data.ctr_drbg ) );
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005789 if( status != PSA_SUCCESS )
5790 goto exit;
5791 if( PSA_BITS_TO_BYTES( bits ) != *shared_secret_length )
5792 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005793
5794exit:
Gilles Peskine3e819b72019-12-20 14:09:55 +01005795 if( status != PSA_SUCCESS )
5796 mbedtls_platform_zeroize( shared_secret, shared_secret_size );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005797 mbedtls_ecdh_free( &ecdh );
Steven Cooremana2371e52020-07-28 14:30:39 +02005798 mbedtls_ecp_keypair_free( their_key );
Steven Cooreman6d839f02020-07-30 11:36:45 +02005799 mbedtls_free( their_key );
Steven Cooremana2371e52020-07-28 14:30:39 +02005800
Jaeden Amero97271b32019-01-10 19:38:51 +00005801 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005802}
Gilles Peskinea05219c2018-11-16 16:02:56 +01005803#endif /* MBEDTLS_ECDH_C */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005804
Gilles Peskine01d718c2018-09-18 12:01:02 +02005805#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
5806
Gilles Peskine0216fe12019-04-11 21:23:21 +02005807static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
5808 psa_key_slot_t *private_key,
5809 const uint8_t *peer_key,
5810 size_t peer_key_length,
5811 uint8_t *shared_secret,
5812 size_t shared_secret_size,
5813 size_t *shared_secret_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005814{
Gilles Peskine0216fe12019-04-11 21:23:21 +02005815 switch( alg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005816 {
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005817#if defined(MBEDTLS_ECDH_C)
Gilles Peskine0216fe12019-04-11 21:23:21 +02005818 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02005819 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005820 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremana2371e52020-07-28 14:30:39 +02005821 mbedtls_ecp_keypair *ecp = NULL;
Steven Cooreman7f391872020-07-30 14:57:44 +02005822 psa_status_t status = psa_load_ecp_representation(
Steven Cooreman4fed4552020-08-03 14:46:03 +02005823 private_key->attr.type,
Steven Cooreman7f391872020-07-30 14:57:44 +02005824 private_key->data.key.data,
5825 private_key->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02005826 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02005827 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02005828 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02005829 status = psa_key_agreement_ecdh( peer_key, peer_key_length,
Steven Cooremana2371e52020-07-28 14:30:39 +02005830 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02005831 shared_secret, shared_secret_size,
5832 shared_secret_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02005833 mbedtls_ecp_keypair_free( ecp );
5834 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02005835 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005836#endif /* MBEDTLS_ECDH_C */
Gilles Peskine01d718c2018-09-18 12:01:02 +02005837 default:
Gilles Peskine93f85002018-11-16 16:43:31 +01005838 (void) private_key;
5839 (void) peer_key;
5840 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02005841 (void) shared_secret;
5842 (void) shared_secret_size;
5843 (void) shared_secret_length;
Gilles Peskine01d718c2018-09-18 12:01:02 +02005844 return( PSA_ERROR_NOT_SUPPORTED );
5845 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02005846}
5847
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005848/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02005849 * to potentially free embedded data structures and wipe confidential data.
5850 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005851static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005852 psa_key_derivation_step_t step,
Gilles Peskine01d718c2018-09-18 12:01:02 +02005853 psa_key_slot_t *private_key,
5854 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005855 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005856{
5857 psa_status_t status;
5858 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
5859 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005860 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005861
5862 /* Step 1: run the secret agreement algorithm to generate the shared
5863 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02005864 status = psa_key_agreement_raw_internal( ka_alg,
5865 private_key,
5866 peer_key, peer_key_length,
itayzafrir0adf0fc2018-09-06 16:24:41 +03005867 shared_secret,
5868 sizeof( shared_secret ),
Gilles Peskine05d69892018-06-19 22:00:52 +02005869 &shared_secret_length );
Gilles Peskine53d991e2018-07-12 01:14:59 +02005870 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005871 goto exit;
5872
Gilles Peskineb0b255c2018-07-06 17:01:38 +02005873 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02005874 * the shared secret. A shared secret is permitted wherever a key
5875 * of type DERIVE is permitted. */
Janos Follathb80a94e2019-06-12 15:54:46 +01005876 status = psa_key_derivation_input_internal( operation, step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005877 PSA_KEY_TYPE_DERIVE,
Janos Follathb80a94e2019-06-12 15:54:46 +01005878 shared_secret,
5879 shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005880exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01005881 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005882 return( status );
5883}
5884
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005885psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005886 psa_key_derivation_step_t step,
5887 psa_key_handle_t private_key,
5888 const uint8_t *peer_key,
5889 size_t peer_key_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005890{
Gilles Peskine2f060a82018-12-04 17:12:32 +01005891 psa_key_slot_t *slot;
Gilles Peskine08542d82018-07-19 17:05:42 +02005892 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005893 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005894 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine28f8f302019-07-24 13:30:31 +02005895 status = psa_get_transparent_key( private_key, &slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02005896 PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005897 if( status != PSA_SUCCESS )
5898 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005899 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01005900 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005901 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01005902 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005903 psa_key_derivation_abort( operation );
Steven Cooremanfa5e6312020-10-15 17:07:12 +02005904 else
5905 {
5906 /* If a private key has been added as SECRET, we allow the derived
5907 * key material to be used as a key in PSA Crypto. */
5908 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5909 operation->can_output_key = 1;
5910 }
Gilles Peskine346797d2018-11-16 16:05:06 +01005911 return( status );
Gilles Peskineaf3baab2018-06-27 22:55:52 +02005912}
5913
Gilles Peskinebe697d82019-05-16 18:00:41 +02005914psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
5915 psa_key_handle_t private_key,
5916 const uint8_t *peer_key,
5917 size_t peer_key_length,
5918 uint8_t *output,
5919 size_t output_size,
5920 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02005921{
5922 psa_key_slot_t *slot;
5923 psa_status_t status;
5924
5925 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
5926 {
5927 status = PSA_ERROR_INVALID_ARGUMENT;
5928 goto exit;
5929 }
Gilles Peskine28f8f302019-07-24 13:30:31 +02005930 status = psa_get_transparent_key( private_key, &slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02005931 PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02005932 if( status != PSA_SUCCESS )
5933 goto exit;
5934
5935 status = psa_key_agreement_raw_internal( alg, slot,
5936 peer_key, peer_key_length,
5937 output, output_size,
5938 output_length );
5939
5940exit:
5941 if( status != PSA_SUCCESS )
5942 {
5943 /* If an error happens and is not handled properly, the output
5944 * may be used as a key to protect sensitive data. Arrange for such
5945 * a key to be random, which is likely to result in decryption or
5946 * verification errors. This is better than filling the buffer with
5947 * some constant data such as zeros, which would result in the data
5948 * being protected with a reproducible, easily knowable key.
5949 */
5950 psa_generate_random( output, output_size );
5951 *output_length = output_size;
5952 }
5953 return( status );
5954}
Gilles Peskine86a440b2018-11-12 18:39:40 +01005955
5956
5957/****************************************************************/
5958/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02005959/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02005960
Gilles Peskine4c317f42018-07-12 01:24:09 +02005961psa_status_t psa_generate_random( uint8_t *output,
Gilles Peskine53d991e2018-07-12 01:14:59 +02005962 size_t output_size )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005963{
Janos Follath24eed8d2019-11-22 13:21:35 +00005964 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005965 GUARD_MODULE_INITIALIZED;
5966
Gilles Peskinef181eca2019-08-07 13:49:00 +02005967 while( output_size > MBEDTLS_CTR_DRBG_MAX_REQUEST )
5968 {
5969 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg,
5970 output,
5971 MBEDTLS_CTR_DRBG_MAX_REQUEST );
5972 if( ret != 0 )
5973 return( mbedtls_to_psa_error( ret ) );
5974 output += MBEDTLS_CTR_DRBG_MAX_REQUEST;
5975 output_size -= MBEDTLS_CTR_DRBG_MAX_REQUEST;
5976 }
5977
Gilles Peskinee59236f2018-01-27 23:32:46 +01005978 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg, output, output_size );
5979 return( mbedtls_to_psa_error( ret ) );
5980}
5981
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005982#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
5983#include "mbedtls/entropy_poll.h"
5984
Gilles Peskine7228da22019-07-15 11:06:15 +02005985psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005986 size_t seed_size )
5987{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005988 if( global_data.initialized )
5989 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02005990
5991 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
5992 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
5993 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
5994 return( PSA_ERROR_INVALID_ARGUMENT );
5995
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005996 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005997}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005998#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005999
Gilles Peskinee56e8782019-04-26 17:34:02 +02006000#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_GENPRIME)
6001static psa_status_t psa_read_rsa_exponent( const uint8_t *domain_parameters,
6002 size_t domain_parameters_size,
6003 int *exponent )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006004{
Gilles Peskinee56e8782019-04-26 17:34:02 +02006005 size_t i;
6006 uint32_t acc = 0;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006007
Gilles Peskinee56e8782019-04-26 17:34:02 +02006008 if( domain_parameters_size == 0 )
6009 {
6010 *exponent = 65537;
6011 return( PSA_SUCCESS );
6012 }
6013
6014 /* Mbed TLS encodes the public exponent as an int. For simplicity, only
6015 * support values that fit in a 32-bit integer, which is larger than
6016 * int on just about every platform anyway. */
6017 if( domain_parameters_size > sizeof( acc ) )
6018 return( PSA_ERROR_NOT_SUPPORTED );
6019 for( i = 0; i < domain_parameters_size; i++ )
6020 acc = ( acc << 8 ) | domain_parameters[i];
6021 if( acc > INT_MAX )
6022 return( PSA_ERROR_NOT_SUPPORTED );
6023 *exponent = acc;
6024 return( PSA_SUCCESS );
6025}
6026#endif /* MBEDTLS_RSA_C && MBEDTLS_GENPRIME */
6027
Gilles Peskine35ef36b2019-05-16 19:42:05 +02006028static psa_status_t psa_generate_key_internal(
Gilles Peskinee56e8782019-04-26 17:34:02 +02006029 psa_key_slot_t *slot, size_t bits,
6030 const uint8_t *domain_parameters, size_t domain_parameters_size )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006031{
Gilles Peskine8e338702019-07-30 20:06:31 +02006032 psa_key_type_t type = slot->attr.type;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006033
Gilles Peskinee56e8782019-04-26 17:34:02 +02006034 if( domain_parameters == NULL && domain_parameters_size != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006035 return( PSA_ERROR_INVALID_ARGUMENT );
6036
Gilles Peskinee59236f2018-01-27 23:32:46 +01006037 if( key_type_is_raw_bytes( type ) )
6038 {
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006039 psa_status_t status;
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006040
6041 status = validate_unstructured_key_bit_size( slot->attr.type, bits );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006042 if( status != PSA_SUCCESS )
6043 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006044
6045 /* Allocate memory for the key */
Steven Cooreman75b74362020-07-28 14:30:13 +02006046 status = psa_allocate_buffer_to_slot( slot, PSA_BITS_TO_BYTES( bits ) );
6047 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02006048 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006049
Steven Cooreman71fd80d2020-07-07 21:12:27 +02006050 status = psa_generate_random( slot->data.key.data,
6051 slot->data.key.bytes );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006052 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006053 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006054
6055 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006056#if defined(MBEDTLS_DES_C)
6057 if( type == PSA_KEY_TYPE_DES )
Steven Cooreman71fd80d2020-07-07 21:12:27 +02006058 psa_des_set_key_parity( slot->data.key.data,
6059 slot->data.key.bytes );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006060#endif /* MBEDTLS_DES_C */
6061 }
6062 else
6063
6064#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_GENPRIME)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02006065 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006066 {
Steven Cooremana01795d2020-07-24 22:48:15 +02006067 mbedtls_rsa_context rsa;
Janos Follath24eed8d2019-11-22 13:21:35 +00006068 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee56e8782019-04-26 17:34:02 +02006069 int exponent;
6070 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006071 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
6072 return( PSA_ERROR_NOT_SUPPORTED );
6073 /* Accept only byte-aligned keys, for the same reasons as
6074 * in psa_import_rsa_key(). */
6075 if( bits % 8 != 0 )
6076 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinee56e8782019-04-26 17:34:02 +02006077 status = psa_read_rsa_exponent( domain_parameters,
6078 domain_parameters_size,
6079 &exponent );
6080 if( status != PSA_SUCCESS )
6081 return( status );
Steven Cooremana01795d2020-07-24 22:48:15 +02006082 mbedtls_rsa_init( &rsa, MBEDTLS_RSA_PKCS_V15, MBEDTLS_MD_NONE );
6083 ret = mbedtls_rsa_gen_key( &rsa,
Gilles Peskinee59236f2018-01-27 23:32:46 +01006084 mbedtls_ctr_drbg_random,
6085 &global_data.ctr_drbg,
6086 (unsigned int) bits,
6087 exponent );
6088 if( ret != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006089 return( mbedtls_to_psa_error( ret ) );
Steven Cooremana01795d2020-07-24 22:48:15 +02006090
6091 /* Make sure to always have an export representation available */
6092 size_t bytes = PSA_KEY_EXPORT_RSA_KEY_PAIR_MAX_SIZE( bits );
6093
Steven Cooreman75b74362020-07-28 14:30:13 +02006094 status = psa_allocate_buffer_to_slot( slot, bytes );
6095 if( status != PSA_SUCCESS )
Steven Cooremana01795d2020-07-24 22:48:15 +02006096 {
6097 mbedtls_rsa_free( &rsa );
Steven Cooreman29149862020-08-05 15:43:42 +02006098 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006099 }
Steven Cooremana01795d2020-07-24 22:48:15 +02006100
6101 status = psa_export_rsa_key( type,
6102 &rsa,
6103 slot->data.key.data,
6104 bytes,
6105 &slot->data.key.bytes );
6106 mbedtls_rsa_free( &rsa );
6107 if( status != PSA_SUCCESS )
Steven Cooremana01795d2020-07-24 22:48:15 +02006108 psa_remove_key_data_from_memory( slot );
Steven Cooreman560c28a2020-07-24 23:20:24 +02006109 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006110 }
6111 else
6112#endif /* MBEDTLS_RSA_C && MBEDTLS_GENPRIME */
6113
6114#if defined(MBEDTLS_ECP_C)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02006115 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006116 {
Paul Elliott8ff510a2020-06-02 17:19:28 +01006117 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY( type );
Gilles Peskine4295e8b2019-12-02 21:39:10 +01006118 mbedtls_ecp_group_id grp_id =
6119 mbedtls_ecc_group_of_psa( curve, PSA_BITS_TO_BYTES( bits ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006120 const mbedtls_ecp_curve_info *curve_info =
6121 mbedtls_ecp_curve_info_from_grp_id( grp_id );
Steven Cooremanacda8342020-07-24 23:09:52 +02006122 mbedtls_ecp_keypair ecp;
Janos Follath24eed8d2019-11-22 13:21:35 +00006123 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee56e8782019-04-26 17:34:02 +02006124 if( domain_parameters_size != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006125 return( PSA_ERROR_NOT_SUPPORTED );
6126 if( grp_id == MBEDTLS_ECP_DP_NONE || curve_info == NULL )
6127 return( PSA_ERROR_NOT_SUPPORTED );
6128 if( curve_info->bit_size != bits )
6129 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremanacda8342020-07-24 23:09:52 +02006130 mbedtls_ecp_keypair_init( &ecp );
6131 ret = mbedtls_ecp_gen_key( grp_id, &ecp,
Gilles Peskinee59236f2018-01-27 23:32:46 +01006132 mbedtls_ctr_drbg_random,
6133 &global_data.ctr_drbg );
6134 if( ret != 0 )
6135 {
Steven Cooremanacda8342020-07-24 23:09:52 +02006136 mbedtls_ecp_keypair_free( &ecp );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006137 return( mbedtls_to_psa_error( ret ) );
6138 }
Steven Cooremanacda8342020-07-24 23:09:52 +02006139
6140
6141 /* Make sure to always have an export representation available */
6142 size_t bytes = PSA_BITS_TO_BYTES( bits );
Steven Cooreman75b74362020-07-28 14:30:13 +02006143 psa_status_t status = psa_allocate_buffer_to_slot( slot, bytes );
6144 if( status != PSA_SUCCESS )
Steven Cooremanacda8342020-07-24 23:09:52 +02006145 {
6146 mbedtls_ecp_keypair_free( &ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02006147 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02006148 }
Steven Cooreman75b74362020-07-28 14:30:13 +02006149
6150 status = mbedtls_to_psa_error(
Steven Cooremanacda8342020-07-24 23:09:52 +02006151 mbedtls_ecp_write_key( &ecp, slot->data.key.data, bytes ) );
6152
6153 mbedtls_ecp_keypair_free( &ecp );
Steven Cooremanb7f6dea2020-08-05 16:07:20 +02006154 if( status != PSA_SUCCESS ) {
6155 memset( slot->data.key.data, 0, bytes );
Steven Cooremanacda8342020-07-24 23:09:52 +02006156 psa_remove_key_data_from_memory( slot );
Steven Cooremanb7f6dea2020-08-05 16:07:20 +02006157 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02006158 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006159 }
6160 else
6161#endif /* MBEDTLS_ECP_C */
Steven Cooreman29149862020-08-05 15:43:42 +02006162 {
Gilles Peskinee59236f2018-01-27 23:32:46 +01006163 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman29149862020-08-05 15:43:42 +02006164 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01006165
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006166 return( PSA_SUCCESS );
6167}
Darryl Green0c6575a2018-11-07 16:05:30 +00006168
Gilles Peskine35ef36b2019-05-16 19:42:05 +02006169psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Gilles Peskinee56e8782019-04-26 17:34:02 +02006170 psa_key_handle_t *handle )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006171{
6172 psa_status_t status;
6173 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02006174 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine11792082019-08-06 18:36:36 +02006175
Gilles Peskine0f84d622019-09-12 19:03:13 +02006176 /* Reject any attempt to create a zero-length key so that we don't
6177 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
6178 if( psa_get_key_bits( attributes ) == 0 )
6179 return( PSA_ERROR_INVALID_ARGUMENT );
6180
Gilles Peskinedf179142019-07-15 22:02:14 +02006181 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE,
6182 attributes, handle, &slot, &driver );
Gilles Peskine11792082019-08-06 18:36:36 +02006183 if( status != PSA_SUCCESS )
6184 goto exit;
6185
Steven Cooreman2a1664c2020-07-20 15:33:08 +02006186 status = psa_driver_wrapper_generate_key( attributes,
6187 slot );
6188 if( status != PSA_ERROR_NOT_SUPPORTED ||
6189 psa_key_lifetime_is_external( attributes->core.lifetime ) )
6190 goto exit;
6191
6192 status = psa_generate_key_internal(
6193 slot, attributes->core.bits,
6194 attributes->domain_parameters, attributes->domain_parameters_size );
Gilles Peskine11792082019-08-06 18:36:36 +02006195
6196exit:
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006197 if( status == PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02006198 status = psa_finish_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006199 if( status != PSA_SUCCESS )
6200 {
Gilles Peskine011e4282019-06-26 18:34:38 +02006201 psa_fail_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006202 *handle = 0;
6203 }
Darryl Green0c6575a2018-11-07 16:05:30 +00006204 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006205}
6206
6207
Gilles Peskinee59236f2018-01-27 23:32:46 +01006208
6209/****************************************************************/
6210/* Module setup */
6211/****************************************************************/
6212
Gilles Peskine5e769522018-11-20 21:59:56 +01006213psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
6214 void (* entropy_init )( mbedtls_entropy_context *ctx ),
6215 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
6216{
6217 if( global_data.rng_state != RNG_NOT_INITIALIZED )
6218 return( PSA_ERROR_BAD_STATE );
6219 global_data.entropy_init = entropy_init;
6220 global_data.entropy_free = entropy_free;
6221 return( PSA_SUCCESS );
6222}
6223
Gilles Peskinee59236f2018-01-27 23:32:46 +01006224void mbedtls_psa_crypto_free( void )
6225{
Gilles Peskine66fb1262018-12-10 16:29:04 +01006226 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006227 if( global_data.rng_state != RNG_NOT_INITIALIZED )
6228 {
6229 mbedtls_ctr_drbg_free( &global_data.ctr_drbg );
Gilles Peskine5e769522018-11-20 21:59:56 +01006230 global_data.entropy_free( &global_data.entropy );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006231 }
6232 /* Wipe all remaining data, including configuration.
6233 * In particular, this sets all state indicator to the value
6234 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01006235 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Gilles Peskinea8ade162019-06-26 11:24:49 +02006236#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +02006237 /* Unregister all secure element drivers, so that we restart from
6238 * a pristine state. */
6239 psa_unregister_all_se_drivers( );
Gilles Peskinea8ade162019-06-26 11:24:49 +02006240#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006241}
6242
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006243#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
6244/** Recover a transaction that was interrupted by a power failure.
6245 *
6246 * This function is called during initialization, before psa_crypto_init()
6247 * returns. If this function returns a failure status, the initialization
6248 * fails.
6249 */
6250static psa_status_t psa_crypto_recover_transaction(
6251 const psa_crypto_transaction_t *transaction )
6252{
6253 switch( transaction->unknown.type )
6254 {
6255 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
6256 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01006257 /* TODO - fall through to the failure case until this
Gilles Peskinec9d7f942019-08-13 16:17:16 +02006258 * is implemented.
6259 * https://github.com/ARMmbed/mbed-crypto/issues/218
6260 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006261 default:
6262 /* We found an unsupported transaction in the storage.
6263 * We don't know what state the storage is in. Give up. */
6264 return( PSA_ERROR_STORAGE_FAILURE );
6265 }
6266}
6267#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
6268
Gilles Peskinee59236f2018-01-27 23:32:46 +01006269psa_status_t psa_crypto_init( void )
6270{
Gilles Peskine66fb1262018-12-10 16:29:04 +01006271 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006272 const unsigned char drbg_seed[] = "PSA";
6273
Gilles Peskinec6b69072018-11-20 21:42:52 +01006274 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006275 if( global_data.initialized != 0 )
6276 return( PSA_SUCCESS );
6277
Gilles Peskine5e769522018-11-20 21:59:56 +01006278 /* Set default configuration if
6279 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
6280 if( global_data.entropy_init == NULL )
6281 global_data.entropy_init = mbedtls_entropy_init;
6282 if( global_data.entropy_free == NULL )
6283 global_data.entropy_free = mbedtls_entropy_free;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006284
Gilles Peskinec6b69072018-11-20 21:42:52 +01006285 /* Initialize the random generator. */
Gilles Peskine5e769522018-11-20 21:59:56 +01006286 global_data.entropy_init( &global_data.entropy );
Jaeden Amero76541612019-06-04 17:14:43 +01006287#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
6288 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
6289 /* The PSA entropy injection feature depends on using NV seed as an entropy
6290 * source. Add NV seed as an entropy source for PSA entropy injection. */
6291 mbedtls_entropy_add_source( &global_data.entropy,
6292 mbedtls_nv_seed_poll, NULL,
6293 MBEDTLS_ENTROPY_BLOCK_SIZE,
6294 MBEDTLS_ENTROPY_SOURCE_STRONG );
6295#endif
Gilles Peskinee59236f2018-01-27 23:32:46 +01006296 mbedtls_ctr_drbg_init( &global_data.ctr_drbg );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006297 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine66fb1262018-12-10 16:29:04 +01006298 status = mbedtls_to_psa_error(
6299 mbedtls_ctr_drbg_seed( &global_data.ctr_drbg,
6300 mbedtls_entropy_func,
6301 &global_data.entropy,
6302 drbg_seed, sizeof( drbg_seed ) - 1 ) );
6303 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006304 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01006305 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006306
Gilles Peskine66fb1262018-12-10 16:29:04 +01006307 status = psa_initialize_key_slots( );
6308 if( status != PSA_SUCCESS )
6309 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01006310
Gilles Peskined9348f22019-10-01 15:22:29 +02006311#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
6312 status = psa_init_all_se_drivers( );
6313 if( status != PSA_SUCCESS )
6314 goto exit;
6315#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
6316
Gilles Peskine4b734222019-07-24 15:56:31 +02006317#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02006318 status = psa_crypto_load_transaction( );
6319 if( status == PSA_SUCCESS )
6320 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006321 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
6322 if( status != PSA_SUCCESS )
6323 goto exit;
6324 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02006325 }
6326 else if( status == PSA_ERROR_DOES_NOT_EXIST )
6327 {
6328 /* There's no transaction to complete. It's all good. */
6329 status = PSA_SUCCESS;
6330 }
Gilles Peskine4b734222019-07-24 15:56:31 +02006331#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02006332
Gilles Peskinec6b69072018-11-20 21:42:52 +01006333 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006334 global_data.initialized = 1;
6335
6336exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01006337 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006338 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01006339 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006340}
6341
6342#endif /* MBEDTLS_PSA_CRYPTO_C */