blob: ab4e47ab0d75b53fd835e0cdf79d166ec7e76eb9 [file] [log] [blame]
Gilles Peskinee59236f2018-01-27 23:32:46 +01001/*
2 * PSA crypto layer on top of Mbed TLS crypto
3 */
Bence Szépkúti86974652020-06-15 11:59:37 +02004/*
Bence Szépkúti1e148272020-08-07 13:07:28 +02005 * Copyright The Mbed TLS Contributors
Gilles Peskinee59236f2018-01-27 23:32:46 +01006 * SPDX-License-Identifier: Apache-2.0
7 *
8 * Licensed under the Apache License, Version 2.0 (the "License"); you may
9 * not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
Gilles Peskinee59236f2018-01-27 23:32:46 +010019 */
20
Gilles Peskinedb09ef62020-06-03 01:43:33 +020021#include "common.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010022
23#if defined(MBEDTLS_PSA_CRYPTO_C)
mohammad160327010052018-07-03 13:16:15 +030024
itayzafrir7723ab12019-02-14 10:28:02 +020025#include "psa_crypto_service_integration.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010026#include "psa/crypto.h"
27
Gilles Peskine039b90c2018-12-07 18:24:41 +010028#include "psa_crypto_core.h"
Gilles Peskine5e769522018-11-20 21:59:56 +010029#include "psa_crypto_invasive.h"
Steven Cooremancd84cb42020-07-16 20:28:36 +020030#include "psa_crypto_driver_wrappers.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020031#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +020032#include "psa_crypto_se.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020033#endif
Gilles Peskine961849f2018-11-30 18:54:54 +010034#include "psa_crypto_slot_management.h"
Darryl Greend49a4992018-06-18 17:27:26 +010035/* Include internal declarations that are useful for implementing persistently
36 * stored keys. */
37#include "psa_crypto_storage.h"
38
Gilles Peskineb46bef22019-07-30 21:32:04 +020039#include <assert.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010040#include <stdlib.h>
41#include <string.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010042#include "mbedtls/platform.h"
Gilles Peskineff2d2002019-05-06 15:26:23 +020043#if !defined(MBEDTLS_PLATFORM_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010044#define mbedtls_calloc calloc
45#define mbedtls_free free
46#endif
47
Gilles Peskinea5905292018-02-07 20:59:33 +010048#include "mbedtls/arc4.h"
Gilles Peskine9a944802018-06-21 09:35:35 +020049#include "mbedtls/asn1.h"
Jaeden Amero25384a22019-01-10 10:23:21 +000050#include "mbedtls/asn1write.h"
Gilles Peskinea81d85b2018-06-26 16:10:23 +020051#include "mbedtls/bignum.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010052#include "mbedtls/blowfish.h"
53#include "mbedtls/camellia.h"
Gilles Peskine26869f22019-05-06 15:25:00 +020054#include "mbedtls/chacha20.h"
55#include "mbedtls/chachapoly.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010056#include "mbedtls/cipher.h"
57#include "mbedtls/ccm.h"
58#include "mbedtls/cmac.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010059#include "mbedtls/ctr_drbg.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010060#include "mbedtls/des.h"
Gilles Peskineb7ecdf02018-09-18 12:11:27 +020061#include "mbedtls/ecdh.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010062#include "mbedtls/ecp.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010063#include "mbedtls/entropy.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010064#include "mbedtls/error.h"
65#include "mbedtls/gcm.h"
66#include "mbedtls/md2.h"
67#include "mbedtls/md4.h"
68#include "mbedtls/md5.h"
Gilles Peskine20035e32018-02-03 22:44:14 +010069#include "mbedtls/md.h"
70#include "mbedtls/md_internal.h"
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010071#include "mbedtls/pk.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010072#include "mbedtls/pk_internal.h"
Gilles Peskine3f108122018-12-07 18:14:53 +010073#include "mbedtls/platform_util.h"
Janos Follath24eed8d2019-11-22 13:21:35 +000074#include "mbedtls/error.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010075#include "mbedtls/ripemd160.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010076#include "mbedtls/rsa.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010077#include "mbedtls/sha1.h"
78#include "mbedtls/sha256.h"
79#include "mbedtls/sha512.h"
80#include "mbedtls/xtea.h"
81
Gilles Peskine996deb12018-08-01 15:45:45 +020082#define ARRAY_LENGTH( array ) ( sizeof( array ) / sizeof( *( array ) ) )
83
Gilles Peskine9ef733f2018-02-07 21:05:37 +010084/* constant-time buffer comparison */
85static inline int safer_memcmp( const uint8_t *a, const uint8_t *b, size_t n )
86{
87 size_t i;
88 unsigned char diff = 0;
89
90 for( i = 0; i < n; i++ )
91 diff |= a[i] ^ b[i];
92
93 return( diff );
94}
95
96
97
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010098/****************************************************************/
99/* Global data, support functions and library management */
100/****************************************************************/
101
Gilles Peskine48c0ea12018-06-21 14:15:31 +0200102static int key_type_is_raw_bytes( psa_key_type_t type )
103{
Gilles Peskine78b3bb62018-08-10 16:03:41 +0200104 return( PSA_KEY_TYPE_IS_UNSTRUCTURED( type ) );
Gilles Peskine48c0ea12018-06-21 14:15:31 +0200105}
106
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100107/* Values for psa_global_data_t::rng_state */
108#define RNG_NOT_INITIALIZED 0
109#define RNG_INITIALIZED 1
110#define RNG_SEEDED 2
Gilles Peskinec6b69072018-11-20 21:42:52 +0100111
Gilles Peskine2d277862018-06-18 15:41:12 +0200112typedef struct
113{
Gilles Peskine5e769522018-11-20 21:59:56 +0100114 void (* entropy_init )( mbedtls_entropy_context *ctx );
115 void (* entropy_free )( mbedtls_entropy_context *ctx );
Gilles Peskinee59236f2018-01-27 23:32:46 +0100116 mbedtls_entropy_context entropy;
117 mbedtls_ctr_drbg_context ctr_drbg;
Gilles Peskinec6b69072018-11-20 21:42:52 +0100118 unsigned initialized : 1;
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100119 unsigned rng_state : 2;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100120} psa_global_data_t;
121
122static psa_global_data_t global_data;
123
itayzafrir0adf0fc2018-09-06 16:24:41 +0300124#define GUARD_MODULE_INITIALIZED \
125 if( global_data.initialized == 0 ) \
126 return( PSA_ERROR_BAD_STATE );
127
Steven Cooreman01164162020-07-20 15:31:37 +0200128psa_status_t mbedtls_to_psa_error( int ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100129{
Gilles Peskinea5905292018-02-07 20:59:33 +0100130 /* If there's both a high-level code and low-level code, dispatch on
131 * the high-level code. */
132 switch( ret < -0x7f ? - ( -ret & 0x7f80 ) : ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100133 {
134 case 0:
135 return( PSA_SUCCESS );
Gilles Peskinea5905292018-02-07 20:59:33 +0100136
137 case MBEDTLS_ERR_AES_INVALID_KEY_LENGTH:
138 case MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH:
139 case MBEDTLS_ERR_AES_FEATURE_UNAVAILABLE:
140 return( PSA_ERROR_NOT_SUPPORTED );
141 case MBEDTLS_ERR_AES_HW_ACCEL_FAILED:
142 return( PSA_ERROR_HARDWARE_FAILURE );
143
144 case MBEDTLS_ERR_ARC4_HW_ACCEL_FAILED:
145 return( PSA_ERROR_HARDWARE_FAILURE );
146
Gilles Peskine9a944802018-06-21 09:35:35 +0200147 case MBEDTLS_ERR_ASN1_OUT_OF_DATA:
148 case MBEDTLS_ERR_ASN1_UNEXPECTED_TAG:
149 case MBEDTLS_ERR_ASN1_INVALID_LENGTH:
150 case MBEDTLS_ERR_ASN1_LENGTH_MISMATCH:
151 case MBEDTLS_ERR_ASN1_INVALID_DATA:
152 return( PSA_ERROR_INVALID_ARGUMENT );
153 case MBEDTLS_ERR_ASN1_ALLOC_FAILED:
154 return( PSA_ERROR_INSUFFICIENT_MEMORY );
155 case MBEDTLS_ERR_ASN1_BUF_TOO_SMALL:
156 return( PSA_ERROR_BUFFER_TOO_SMALL );
157
Jaeden Amero93e21112019-02-20 13:57:28 +0000158#if defined(MBEDTLS_ERR_BLOWFISH_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000159 case MBEDTLS_ERR_BLOWFISH_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000160#elif defined(MBEDTLS_ERR_BLOWFISH_INVALID_KEY_LENGTH)
161 case MBEDTLS_ERR_BLOWFISH_INVALID_KEY_LENGTH:
162#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100163 case MBEDTLS_ERR_BLOWFISH_INVALID_INPUT_LENGTH:
164 return( PSA_ERROR_NOT_SUPPORTED );
165 case MBEDTLS_ERR_BLOWFISH_HW_ACCEL_FAILED:
166 return( PSA_ERROR_HARDWARE_FAILURE );
167
Jaeden Amero93e21112019-02-20 13:57:28 +0000168#if defined(MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000169 case MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000170#elif defined(MBEDTLS_ERR_CAMELLIA_INVALID_KEY_LENGTH)
171 case MBEDTLS_ERR_CAMELLIA_INVALID_KEY_LENGTH:
172#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100173 case MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH:
174 return( PSA_ERROR_NOT_SUPPORTED );
175 case MBEDTLS_ERR_CAMELLIA_HW_ACCEL_FAILED:
176 return( PSA_ERROR_HARDWARE_FAILURE );
177
178 case MBEDTLS_ERR_CCM_BAD_INPUT:
179 return( PSA_ERROR_INVALID_ARGUMENT );
180 case MBEDTLS_ERR_CCM_AUTH_FAILED:
181 return( PSA_ERROR_INVALID_SIGNATURE );
182 case MBEDTLS_ERR_CCM_HW_ACCEL_FAILED:
183 return( PSA_ERROR_HARDWARE_FAILURE );
184
Gilles Peskine26869f22019-05-06 15:25:00 +0200185 case MBEDTLS_ERR_CHACHA20_BAD_INPUT_DATA:
186 return( PSA_ERROR_INVALID_ARGUMENT );
187
188 case MBEDTLS_ERR_CHACHAPOLY_BAD_STATE:
189 return( PSA_ERROR_BAD_STATE );
190 case MBEDTLS_ERR_CHACHAPOLY_AUTH_FAILED:
191 return( PSA_ERROR_INVALID_SIGNATURE );
192
Gilles Peskinea5905292018-02-07 20:59:33 +0100193 case MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE:
194 return( PSA_ERROR_NOT_SUPPORTED );
195 case MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA:
196 return( PSA_ERROR_INVALID_ARGUMENT );
197 case MBEDTLS_ERR_CIPHER_ALLOC_FAILED:
198 return( PSA_ERROR_INSUFFICIENT_MEMORY );
199 case MBEDTLS_ERR_CIPHER_INVALID_PADDING:
200 return( PSA_ERROR_INVALID_PADDING );
201 case MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED:
Fredrik Strupef90e3012020-09-28 16:11:33 +0200202 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100203 case MBEDTLS_ERR_CIPHER_AUTH_FAILED:
204 return( PSA_ERROR_INVALID_SIGNATURE );
205 case MBEDTLS_ERR_CIPHER_INVALID_CONTEXT:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200206 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100207 case MBEDTLS_ERR_CIPHER_HW_ACCEL_FAILED:
208 return( PSA_ERROR_HARDWARE_FAILURE );
209
210 case MBEDTLS_ERR_CMAC_HW_ACCEL_FAILED:
211 return( PSA_ERROR_HARDWARE_FAILURE );
212
213 case MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED:
214 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
215 case MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG:
216 case MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG:
217 return( PSA_ERROR_NOT_SUPPORTED );
218 case MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR:
219 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
220
221 case MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH:
222 return( PSA_ERROR_NOT_SUPPORTED );
223 case MBEDTLS_ERR_DES_HW_ACCEL_FAILED:
224 return( PSA_ERROR_HARDWARE_FAILURE );
225
Gilles Peskinee59236f2018-01-27 23:32:46 +0100226 case MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED:
227 case MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE:
228 case MBEDTLS_ERR_ENTROPY_SOURCE_FAILED:
229 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskinea5905292018-02-07 20:59:33 +0100230
231 case MBEDTLS_ERR_GCM_AUTH_FAILED:
232 return( PSA_ERROR_INVALID_SIGNATURE );
233 case MBEDTLS_ERR_GCM_BAD_INPUT:
Gilles Peskine8cac2e62018-08-21 15:07:38 +0200234 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100235 case MBEDTLS_ERR_GCM_HW_ACCEL_FAILED:
236 return( PSA_ERROR_HARDWARE_FAILURE );
237
238 case MBEDTLS_ERR_MD2_HW_ACCEL_FAILED:
239 case MBEDTLS_ERR_MD4_HW_ACCEL_FAILED:
240 case MBEDTLS_ERR_MD5_HW_ACCEL_FAILED:
241 return( PSA_ERROR_HARDWARE_FAILURE );
242
243 case MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE:
244 return( PSA_ERROR_NOT_SUPPORTED );
245 case MBEDTLS_ERR_MD_BAD_INPUT_DATA:
246 return( PSA_ERROR_INVALID_ARGUMENT );
247 case MBEDTLS_ERR_MD_ALLOC_FAILED:
248 return( PSA_ERROR_INSUFFICIENT_MEMORY );
249 case MBEDTLS_ERR_MD_FILE_IO_ERROR:
250 return( PSA_ERROR_STORAGE_FAILURE );
251 case MBEDTLS_ERR_MD_HW_ACCEL_FAILED:
252 return( PSA_ERROR_HARDWARE_FAILURE );
253
Gilles Peskinef76aa772018-10-29 19:24:33 +0100254 case MBEDTLS_ERR_MPI_FILE_IO_ERROR:
255 return( PSA_ERROR_STORAGE_FAILURE );
256 case MBEDTLS_ERR_MPI_BAD_INPUT_DATA:
257 return( PSA_ERROR_INVALID_ARGUMENT );
258 case MBEDTLS_ERR_MPI_INVALID_CHARACTER:
259 return( PSA_ERROR_INVALID_ARGUMENT );
260 case MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL:
261 return( PSA_ERROR_BUFFER_TOO_SMALL );
262 case MBEDTLS_ERR_MPI_NEGATIVE_VALUE:
263 return( PSA_ERROR_INVALID_ARGUMENT );
264 case MBEDTLS_ERR_MPI_DIVISION_BY_ZERO:
265 return( PSA_ERROR_INVALID_ARGUMENT );
266 case MBEDTLS_ERR_MPI_NOT_ACCEPTABLE:
267 return( PSA_ERROR_INVALID_ARGUMENT );
268 case MBEDTLS_ERR_MPI_ALLOC_FAILED:
269 return( PSA_ERROR_INSUFFICIENT_MEMORY );
270
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100271 case MBEDTLS_ERR_PK_ALLOC_FAILED:
272 return( PSA_ERROR_INSUFFICIENT_MEMORY );
273 case MBEDTLS_ERR_PK_TYPE_MISMATCH:
274 case MBEDTLS_ERR_PK_BAD_INPUT_DATA:
275 return( PSA_ERROR_INVALID_ARGUMENT );
276 case MBEDTLS_ERR_PK_FILE_IO_ERROR:
Gilles Peskinea5905292018-02-07 20:59:33 +0100277 return( PSA_ERROR_STORAGE_FAILURE );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100278 case MBEDTLS_ERR_PK_KEY_INVALID_VERSION:
279 case MBEDTLS_ERR_PK_KEY_INVALID_FORMAT:
280 return( PSA_ERROR_INVALID_ARGUMENT );
281 case MBEDTLS_ERR_PK_UNKNOWN_PK_ALG:
282 return( PSA_ERROR_NOT_SUPPORTED );
283 case MBEDTLS_ERR_PK_PASSWORD_REQUIRED:
284 case MBEDTLS_ERR_PK_PASSWORD_MISMATCH:
285 return( PSA_ERROR_NOT_PERMITTED );
286 case MBEDTLS_ERR_PK_INVALID_PUBKEY:
287 return( PSA_ERROR_INVALID_ARGUMENT );
288 case MBEDTLS_ERR_PK_INVALID_ALG:
289 case MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE:
290 case MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE:
291 return( PSA_ERROR_NOT_SUPPORTED );
292 case MBEDTLS_ERR_PK_SIG_LEN_MISMATCH:
293 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskinea5905292018-02-07 20:59:33 +0100294 case MBEDTLS_ERR_PK_HW_ACCEL_FAILED:
295 return( PSA_ERROR_HARDWARE_FAILURE );
296
Gilles Peskineff2d2002019-05-06 15:26:23 +0200297 case MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED:
298 return( PSA_ERROR_HARDWARE_FAILURE );
299 case MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED:
300 return( PSA_ERROR_NOT_SUPPORTED );
301
Gilles Peskinea5905292018-02-07 20:59:33 +0100302 case MBEDTLS_ERR_RIPEMD160_HW_ACCEL_FAILED:
303 return( PSA_ERROR_HARDWARE_FAILURE );
304
305 case MBEDTLS_ERR_RSA_BAD_INPUT_DATA:
306 return( PSA_ERROR_INVALID_ARGUMENT );
307 case MBEDTLS_ERR_RSA_INVALID_PADDING:
308 return( PSA_ERROR_INVALID_PADDING );
309 case MBEDTLS_ERR_RSA_KEY_GEN_FAILED:
310 return( PSA_ERROR_HARDWARE_FAILURE );
311 case MBEDTLS_ERR_RSA_KEY_CHECK_FAILED:
312 return( PSA_ERROR_INVALID_ARGUMENT );
313 case MBEDTLS_ERR_RSA_PUBLIC_FAILED:
314 case MBEDTLS_ERR_RSA_PRIVATE_FAILED:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200315 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100316 case MBEDTLS_ERR_RSA_VERIFY_FAILED:
317 return( PSA_ERROR_INVALID_SIGNATURE );
318 case MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE:
319 return( PSA_ERROR_BUFFER_TOO_SMALL );
320 case MBEDTLS_ERR_RSA_RNG_FAILED:
321 return( PSA_ERROR_INSUFFICIENT_MEMORY );
322 case MBEDTLS_ERR_RSA_UNSUPPORTED_OPERATION:
323 return( PSA_ERROR_NOT_SUPPORTED );
324 case MBEDTLS_ERR_RSA_HW_ACCEL_FAILED:
325 return( PSA_ERROR_HARDWARE_FAILURE );
326
327 case MBEDTLS_ERR_SHA1_HW_ACCEL_FAILED:
328 case MBEDTLS_ERR_SHA256_HW_ACCEL_FAILED:
329 case MBEDTLS_ERR_SHA512_HW_ACCEL_FAILED:
330 return( PSA_ERROR_HARDWARE_FAILURE );
331
332 case MBEDTLS_ERR_XTEA_INVALID_INPUT_LENGTH:
333 return( PSA_ERROR_INVALID_ARGUMENT );
334 case MBEDTLS_ERR_XTEA_HW_ACCEL_FAILED:
335 return( PSA_ERROR_HARDWARE_FAILURE );
336
itayzafrir5c753392018-05-08 11:18:38 +0300337 case MBEDTLS_ERR_ECP_BAD_INPUT_DATA:
itayzafrir7b30f8b2018-05-09 16:07:36 +0300338 case MBEDTLS_ERR_ECP_INVALID_KEY:
itayzafrir5c753392018-05-08 11:18:38 +0300339 return( PSA_ERROR_INVALID_ARGUMENT );
itayzafrir7b30f8b2018-05-09 16:07:36 +0300340 case MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL:
341 return( PSA_ERROR_BUFFER_TOO_SMALL );
342 case MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE:
343 return( PSA_ERROR_NOT_SUPPORTED );
344 case MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH:
345 case MBEDTLS_ERR_ECP_VERIFY_FAILED:
346 return( PSA_ERROR_INVALID_SIGNATURE );
347 case MBEDTLS_ERR_ECP_ALLOC_FAILED:
348 return( PSA_ERROR_INSUFFICIENT_MEMORY );
349 case MBEDTLS_ERR_ECP_HW_ACCEL_FAILED:
350 return( PSA_ERROR_HARDWARE_FAILURE );
Janos Follatha13b9052019-11-22 12:48:59 +0000351 case MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED:
352 return( PSA_ERROR_CORRUPTION_DETECTED );
itayzafrir5c753392018-05-08 11:18:38 +0300353
Gilles Peskinee59236f2018-01-27 23:32:46 +0100354 default:
David Saadab4ecc272019-02-14 13:48:10 +0200355 return( PSA_ERROR_GENERIC_ERROR );
Gilles Peskinee59236f2018-01-27 23:32:46 +0100356 }
357}
358
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200359
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +0200360
361
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100362/****************************************************************/
363/* Key management */
364/****************************************************************/
365
Gilles Peskine73167e12019-07-12 23:44:37 +0200366#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
367static inline int psa_key_slot_is_external( const psa_key_slot_t *slot )
368{
Gilles Peskine8e338702019-07-30 20:06:31 +0200369 return( psa_key_lifetime_is_external( slot->attr.lifetime ) );
Gilles Peskine73167e12019-07-12 23:44:37 +0200370}
371#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
372
Darryl Green8f8aa8f2018-07-24 15:44:51 +0100373#if defined(MBEDTLS_ECP_C)
Paul Elliott8ff510a2020-06-02 17:19:28 +0100374mbedtls_ecp_group_id mbedtls_ecc_group_of_psa( psa_ecc_family_t curve,
Gilles Peskine5055b232019-12-12 17:49:31 +0100375 size_t byte_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +0200376{
377 switch( curve )
378 {
Paul Elliott8ff510a2020-06-02 17:19:28 +0100379 case PSA_ECC_FAMILY_SECP_R1:
Gilles Peskine228abc52019-12-03 17:24:19 +0100380 switch( byte_length )
381 {
382 case PSA_BITS_TO_BYTES( 192 ):
383 return( MBEDTLS_ECP_DP_SECP192R1 );
384 case PSA_BITS_TO_BYTES( 224 ):
385 return( MBEDTLS_ECP_DP_SECP224R1 );
386 case PSA_BITS_TO_BYTES( 256 ):
387 return( MBEDTLS_ECP_DP_SECP256R1 );
388 case PSA_BITS_TO_BYTES( 384 ):
389 return( MBEDTLS_ECP_DP_SECP384R1 );
390 case PSA_BITS_TO_BYTES( 521 ):
391 return( MBEDTLS_ECP_DP_SECP521R1 );
392 default:
393 return( MBEDTLS_ECP_DP_NONE );
394 }
395 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100396
Paul Elliott8ff510a2020-06-02 17:19:28 +0100397 case PSA_ECC_FAMILY_BRAINPOOL_P_R1:
Gilles Peskine228abc52019-12-03 17:24:19 +0100398 switch( byte_length )
399 {
400 case PSA_BITS_TO_BYTES( 256 ):
401 return( MBEDTLS_ECP_DP_BP256R1 );
402 case PSA_BITS_TO_BYTES( 384 ):
403 return( MBEDTLS_ECP_DP_BP384R1 );
404 case PSA_BITS_TO_BYTES( 512 ):
405 return( MBEDTLS_ECP_DP_BP512R1 );
406 default:
407 return( MBEDTLS_ECP_DP_NONE );
408 }
409 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100410
Paul Elliott8ff510a2020-06-02 17:19:28 +0100411 case PSA_ECC_FAMILY_MONTGOMERY:
Gilles Peskine228abc52019-12-03 17:24:19 +0100412 switch( byte_length )
413 {
414 case PSA_BITS_TO_BYTES( 255 ):
415 return( MBEDTLS_ECP_DP_CURVE25519 );
416 case PSA_BITS_TO_BYTES( 448 ):
417 return( MBEDTLS_ECP_DP_CURVE448 );
418 default:
419 return( MBEDTLS_ECP_DP_NONE );
420 }
421 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100422
Paul Elliott8ff510a2020-06-02 17:19:28 +0100423 case PSA_ECC_FAMILY_SECP_K1:
Gilles Peskine228abc52019-12-03 17:24:19 +0100424 switch( byte_length )
425 {
426 case PSA_BITS_TO_BYTES( 192 ):
427 return( MBEDTLS_ECP_DP_SECP192K1 );
428 case PSA_BITS_TO_BYTES( 224 ):
429 return( MBEDTLS_ECP_DP_SECP224K1 );
430 case PSA_BITS_TO_BYTES( 256 ):
431 return( MBEDTLS_ECP_DP_SECP256K1 );
432 default:
433 return( MBEDTLS_ECP_DP_NONE );
434 }
435 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100436
Gilles Peskine12313cd2018-06-20 00:20:32 +0200437 default:
438 return( MBEDTLS_ECP_DP_NONE );
439 }
440}
Darryl Green8f8aa8f2018-07-24 15:44:51 +0100441#endif /* defined(MBEDTLS_ECP_C) */
Gilles Peskine12313cd2018-06-20 00:20:32 +0200442
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200443static psa_status_t validate_unstructured_key_bit_size( psa_key_type_t type,
444 size_t bits )
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200445{
446 /* Check that the bit size is acceptable for the key type */
447 switch( type )
448 {
449 case PSA_KEY_TYPE_RAW_DATA:
450#if defined(MBEDTLS_MD_C)
451 case PSA_KEY_TYPE_HMAC:
Gilles Peskine46f1fd72018-06-28 19:31:31 +0200452#endif
Gilles Peskineea0fb492018-07-12 17:17:20 +0200453 case PSA_KEY_TYPE_DERIVE:
454 break;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200455#if defined(MBEDTLS_AES_C)
456 case PSA_KEY_TYPE_AES:
457 if( bits != 128 && bits != 192 && bits != 256 )
458 return( PSA_ERROR_INVALID_ARGUMENT );
459 break;
460#endif
461#if defined(MBEDTLS_CAMELLIA_C)
462 case PSA_KEY_TYPE_CAMELLIA:
463 if( bits != 128 && bits != 192 && bits != 256 )
464 return( PSA_ERROR_INVALID_ARGUMENT );
465 break;
466#endif
467#if defined(MBEDTLS_DES_C)
468 case PSA_KEY_TYPE_DES:
469 if( bits != 64 && bits != 128 && bits != 192 )
470 return( PSA_ERROR_INVALID_ARGUMENT );
471 break;
472#endif
473#if defined(MBEDTLS_ARC4_C)
474 case PSA_KEY_TYPE_ARC4:
475 if( bits < 8 || bits > 2048 )
476 return( PSA_ERROR_INVALID_ARGUMENT );
477 break;
478#endif
Gilles Peskine26869f22019-05-06 15:25:00 +0200479#if defined(MBEDTLS_CHACHA20_C)
480 case PSA_KEY_TYPE_CHACHA20:
481 if( bits != 256 )
482 return( PSA_ERROR_INVALID_ARGUMENT );
483 break;
484#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200485 default:
486 return( PSA_ERROR_NOT_SUPPORTED );
487 }
Gilles Peskineb54979a2018-06-21 09:32:47 +0200488 if( bits % 8 != 0 )
489 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200490
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200491 return( PSA_SUCCESS );
492}
493
Steven Cooremana01795d2020-07-24 22:48:15 +0200494#if defined(MBEDTLS_RSA_C)
495
496#if defined(MBEDTLS_PK_PARSE_C)
Gilles Peskine86a440b2018-11-12 18:39:40 +0100497/* Mbed TLS doesn't support non-byte-aligned key sizes (i.e. key sizes
498 * that are not a multiple of 8) well. For example, there is only
499 * mbedtls_rsa_get_len(), which returns a number of bytes, and no
500 * way to return the exact bit size of a key.
501 * To keep things simple, reject non-byte-aligned key sizes. */
502static psa_status_t psa_check_rsa_key_byte_aligned(
503 const mbedtls_rsa_context *rsa )
504{
505 mbedtls_mpi n;
506 psa_status_t status;
507 mbedtls_mpi_init( &n );
508 status = mbedtls_to_psa_error(
509 mbedtls_rsa_export( rsa, &n, NULL, NULL, NULL, NULL ) );
510 if( status == PSA_SUCCESS )
511 {
512 if( mbedtls_mpi_bitlen( &n ) % 8 != 0 )
513 status = PSA_ERROR_NOT_SUPPORTED;
514 }
515 mbedtls_mpi_free( &n );
516 return( status );
517}
Steven Cooremana01795d2020-07-24 22:48:15 +0200518#endif /* MBEDTLS_PK_PARSE_C */
Gilles Peskine86a440b2018-11-12 18:39:40 +0100519
Steven Cooreman7f391872020-07-30 14:57:44 +0200520/** Load the contents of a key buffer into an internal RSA representation
Steven Cooremana01795d2020-07-24 22:48:15 +0200521 *
Steven Cooreman4fed4552020-08-03 14:46:03 +0200522 * \param[in] type The type of key contained in \p data.
523 * \param[in] data The buffer from which to load the representation.
524 * \param[in] data_length The size in bytes of \p data.
525 * \param[out] p_rsa Returns a pointer to an RSA context on success.
526 * The caller is responsible for freeing both the
527 * contents of the context and the context itself
528 * when done.
Steven Cooremana01795d2020-07-24 22:48:15 +0200529 */
Steven Cooreman4fed4552020-08-03 14:46:03 +0200530static psa_status_t psa_load_rsa_representation( psa_key_type_t type,
531 const uint8_t *data,
532 size_t data_length,
Steven Cooremana2371e52020-07-28 14:30:39 +0200533 mbedtls_rsa_context **p_rsa )
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200534{
Steven Cooremana01795d2020-07-24 22:48:15 +0200535#if defined(MBEDTLS_PK_PARSE_C)
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000536 psa_status_t status;
Steven Cooremana01795d2020-07-24 22:48:15 +0200537 mbedtls_pk_context ctx;
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000538 size_t bits;
Steven Cooremana01795d2020-07-24 22:48:15 +0200539 mbedtls_pk_init( &ctx );
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000540
541 /* Parse the data. */
Steven Cooreman7f391872020-07-30 14:57:44 +0200542 if( PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000543 status = mbedtls_to_psa_error(
Steven Cooreman4fed4552020-08-03 14:46:03 +0200544 mbedtls_pk_parse_key( &ctx, data, data_length, NULL, 0 ) );
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200545 else
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000546 status = mbedtls_to_psa_error(
Steven Cooreman4fed4552020-08-03 14:46:03 +0200547 mbedtls_pk_parse_public_key( &ctx, data, data_length ) );
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000548 if( status != PSA_SUCCESS )
549 goto exit;
550
551 /* We have something that the pkparse module recognizes. If it is a
552 * valid RSA key, store it. */
Steven Cooremana01795d2020-07-24 22:48:15 +0200553 if( mbedtls_pk_get_type( &ctx ) != MBEDTLS_PK_RSA )
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200554 {
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000555 status = PSA_ERROR_INVALID_ARGUMENT;
556 goto exit;
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200557 }
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000558
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000559 /* The size of an RSA key doesn't have to be a multiple of 8. Mbed TLS
560 * supports non-byte-aligned key sizes, but not well. For example,
561 * mbedtls_rsa_get_len() returns the key size in bytes, not in bits. */
Steven Cooremana01795d2020-07-24 22:48:15 +0200562 bits = PSA_BYTES_TO_BITS( mbedtls_rsa_get_len( mbedtls_pk_rsa( ctx ) ) );
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000563 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
564 {
565 status = PSA_ERROR_NOT_SUPPORTED;
566 goto exit;
567 }
Steven Cooremana01795d2020-07-24 22:48:15 +0200568 status = psa_check_rsa_key_byte_aligned( mbedtls_pk_rsa( ctx ) );
Steven Cooremana01795d2020-07-24 22:48:15 +0200569 if( status != PSA_SUCCESS )
570 goto exit;
571
Steven Cooremana2371e52020-07-28 14:30:39 +0200572 /* Copy out the pointer to the RSA context, and reset the PK context
573 * such that pk_free doesn't free the RSA context we just grabbed. */
574 *p_rsa = mbedtls_pk_rsa( ctx );
575 ctx.pk_info = NULL;
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000576
577exit:
Steven Cooremana01795d2020-07-24 22:48:15 +0200578 mbedtls_pk_free( &ctx );
579 return( status );
580#else
Steven Cooreman4fed4552020-08-03 14:46:03 +0200581 (void) data;
582 (void) data_length;
Steven Cooreman7f391872020-07-30 14:57:44 +0200583 (void) type;
Steven Cooremana01795d2020-07-24 22:48:15 +0200584 (void) rsa;
585 return( PSA_ERROR_NOT_SUPPORTED );
586#endif /* MBEDTLS_PK_PARSE_C */
587}
588
589/** Export an RSA key to export representation
590 *
591 * \param[in] type The type of key (public/private) to export
592 * \param[in] rsa The internal RSA representation from which to export
593 * \param[out] data The buffer to export to
594 * \param[in] data_size The length of the buffer to export to
595 * \param[out] data_length The amount of bytes written to \p data
596 */
597static psa_status_t psa_export_rsa_key( psa_key_type_t type,
598 mbedtls_rsa_context *rsa,
599 uint8_t *data,
600 size_t data_size,
601 size_t *data_length )
602{
603#if defined(MBEDTLS_PK_WRITE_C)
604 int ret;
605 mbedtls_pk_context pk;
606 uint8_t *pos = data + data_size;
607
608 mbedtls_pk_init( &pk );
609 pk.pk_info = &mbedtls_rsa_info;
610 pk.pk_ctx = rsa;
611
612 /* PSA Crypto API defines the format of an RSA key as a DER-encoded
Steven Cooreman75b74362020-07-28 14:30:13 +0200613 * representation of the non-encrypted PKCS#1 RSAPrivateKey for a
614 * private key and of the RFC3279 RSAPublicKey for a public key. */
Steven Cooremana01795d2020-07-24 22:48:15 +0200615 if( PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
616 ret = mbedtls_pk_write_key_der( &pk, data, data_size );
617 else
618 ret = mbedtls_pk_write_pubkey( &pos, data, &pk );
619
620 if( ret < 0 )
Steven Cooreman4fed4552020-08-03 14:46:03 +0200621 {
622 /* Clean up in case pk_write failed halfway through. */
623 memset( data, 0, data_size );
Steven Cooreman29149862020-08-05 15:43:42 +0200624 return( mbedtls_to_psa_error( ret ) );
Steven Cooreman4fed4552020-08-03 14:46:03 +0200625 }
Steven Cooremana01795d2020-07-24 22:48:15 +0200626
627 /* The mbedtls_pk_xxx functions write to the end of the buffer.
628 * Move the data to the beginning and erase remaining data
629 * at the original location. */
630 if( 2 * (size_t) ret <= data_size )
631 {
632 memcpy( data, data + data_size - ret, ret );
633 memset( data + data_size - ret, 0, ret );
634 }
635 else if( (size_t) ret < data_size )
636 {
637 memmove( data, data + data_size - ret, ret );
638 memset( data + ret, 0, data_size - ret );
639 }
640
641 *data_length = ret;
642 return( PSA_SUCCESS );
643#else
644 (void) type;
645 (void) rsa;
646 (void) data;
647 (void) data_size;
648 (void) data_length;
649 return( PSA_ERROR_NOT_SUPPORTED );
650#endif /* MBEDTLS_PK_WRITE_C */
651}
652
653/** Import an RSA key from import representation to a slot
654 *
655 * \param[in,out] slot The slot where to store the export representation to
656 * \param[in] data The buffer containing the import representation
657 * \param[in] data_length The amount of bytes in \p data
658 */
659static psa_status_t psa_import_rsa_key( psa_key_slot_t *slot,
660 const uint8_t *data,
661 size_t data_length )
662{
663 psa_status_t status;
664 uint8_t* output = NULL;
Steven Cooremana2371e52020-07-28 14:30:39 +0200665 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +0200666
Steven Cooremana01795d2020-07-24 22:48:15 +0200667 /* Parse input */
Steven Cooreman4fed4552020-08-03 14:46:03 +0200668 status = psa_load_rsa_representation( slot->attr.type,
669 data,
Steven Cooreman7f391872020-07-30 14:57:44 +0200670 data_length,
Steven Cooreman7f391872020-07-30 14:57:44 +0200671 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +0200672 if( status != PSA_SUCCESS )
673 goto exit;
674
675 slot->attr.bits = (psa_key_bits_t) PSA_BYTES_TO_BITS(
Steven Cooremana2371e52020-07-28 14:30:39 +0200676 mbedtls_rsa_get_len( rsa ) );
Steven Cooremana01795d2020-07-24 22:48:15 +0200677
Steven Cooreman75b74362020-07-28 14:30:13 +0200678 /* Re-export the data to PSA export format, such that we can store export
679 * representation in the key slot. Export representation in case of RSA is
680 * the smallest representation that's allowed as input, so a straight-up
681 * allocation of the same size as the input buffer will be large enough. */
Steven Cooremana01795d2020-07-24 22:48:15 +0200682 output = mbedtls_calloc( 1, data_length );
Steven Cooremana01795d2020-07-24 22:48:15 +0200683 if( output == NULL )
684 {
685 status = PSA_ERROR_INSUFFICIENT_MEMORY;
686 goto exit;
687 }
688
Steven Cooremana01795d2020-07-24 22:48:15 +0200689 status = psa_export_rsa_key( slot->attr.type,
Steven Cooremana2371e52020-07-28 14:30:39 +0200690 rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +0200691 output,
692 data_length,
693 &data_length);
Steven Cooremana01795d2020-07-24 22:48:15 +0200694exit:
695 /* Always free the RSA object */
Steven Cooremana2371e52020-07-28 14:30:39 +0200696 mbedtls_rsa_free( rsa );
Steven Cooreman6d839f02020-07-30 11:36:45 +0200697 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +0200698
699 /* Free the allocated buffer only on error. */
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000700 if( status != PSA_SUCCESS )
701 {
Steven Cooremana01795d2020-07-24 22:48:15 +0200702 mbedtls_free( output );
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000703 return( status );
704 }
705
Steven Cooremana01795d2020-07-24 22:48:15 +0200706 /* On success, store the allocated export-formatted key. */
707 slot->data.key.data = output;
708 slot->data.key.bytes = data_length;
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000709
710 return( PSA_SUCCESS );
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200711}
Steven Cooremana01795d2020-07-24 22:48:15 +0200712#endif /* defined(MBEDTLS_RSA_C) */
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200713
Jaeden Ameroccdce902019-01-10 11:42:27 +0000714#if defined(MBEDTLS_ECP_C)
Steven Cooreman7f391872020-07-30 14:57:44 +0200715/** Load the contents of a key buffer into an internal ECP representation
Steven Cooremana2371e52020-07-28 14:30:39 +0200716 *
Steven Cooreman4fed4552020-08-03 14:46:03 +0200717 * \param[in] type The type of key contained in \p data.
718 * \param[in] data The buffer from which to load the representation.
719 * \param[in] data_length The size in bytes of \p data.
720 * \param[out] p_ecp Returns a pointer to an ECP context on success.
721 * The caller is responsible for freeing both the
722 * contents of the context and the context itself
723 * when done.
Steven Cooremana2371e52020-07-28 14:30:39 +0200724 */
Steven Cooreman4fed4552020-08-03 14:46:03 +0200725static psa_status_t psa_load_ecp_representation( psa_key_type_t type,
726 const uint8_t *data,
727 size_t data_length,
Steven Cooremana2371e52020-07-28 14:30:39 +0200728 mbedtls_ecp_keypair **p_ecp )
Gilles Peskine4cd32772019-12-02 20:49:42 +0100729{
730 mbedtls_ecp_group_id grp_id = MBEDTLS_ECP_DP_NONE;
Steven Cooremanacda8342020-07-24 23:09:52 +0200731 psa_status_t status;
Steven Cooreman6d839f02020-07-30 11:36:45 +0200732 mbedtls_ecp_keypair *ecp = NULL;
Steven Cooreman4fed4552020-08-03 14:46:03 +0200733 size_t curve_size = data_length;
Gilles Peskine4cd32772019-12-02 20:49:42 +0100734
Steven Cooreman4fed4552020-08-03 14:46:03 +0200735 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) &&
736 PSA_KEY_TYPE_ECC_GET_FAMILY( type ) != PSA_ECC_FAMILY_MONTGOMERY )
Gilles Peskine4295e8b2019-12-02 21:39:10 +0100737 {
Steven Cooreman4fed4552020-08-03 14:46:03 +0200738 /* A Weierstrass public key is represented as:
739 * - The byte 0x04;
740 * - `x_P` as a `ceiling(m/8)`-byte string, big-endian;
741 * - `y_P` as a `ceiling(m/8)`-byte string, big-endian.
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200742 * So its data length is 2m+1 where m is the curve size in bits.
Steven Cooreman4fed4552020-08-03 14:46:03 +0200743 */
744 if( ( data_length & 1 ) == 0 )
745 return( PSA_ERROR_INVALID_ARGUMENT );
746 curve_size = data_length / 2;
747
748 /* Montgomery public keys are represented in compressed format, meaning
749 * their curve_size is equal to the amount of input. */
750
751 /* Private keys are represented in uncompressed private random integer
752 * format, meaning their curve_size is equal to the amount of input. */
Gilles Peskine4295e8b2019-12-02 21:39:10 +0100753 }
754
Steven Cooreman6d839f02020-07-30 11:36:45 +0200755 /* Allocate and initialize a key representation. */
Steven Cooreman29149862020-08-05 15:43:42 +0200756 ecp = mbedtls_calloc( 1, sizeof( mbedtls_ecp_keypair ) );
Steven Cooreman6d839f02020-07-30 11:36:45 +0200757 if( ecp == NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200758 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Steven Cooremana2371e52020-07-28 14:30:39 +0200759 mbedtls_ecp_keypair_init( ecp );
760
Gilles Peskine4cd32772019-12-02 20:49:42 +0100761 /* Load the group. */
Steven Cooreman7f391872020-07-30 14:57:44 +0200762 grp_id = mbedtls_ecc_group_of_psa( PSA_KEY_TYPE_ECC_GET_FAMILY( type ),
763 curve_size );
Gilles Peskine4295e8b2019-12-02 21:39:10 +0100764 if( grp_id == MBEDTLS_ECP_DP_NONE )
Steven Cooreman6d839f02020-07-30 11:36:45 +0200765 {
766 status = PSA_ERROR_INVALID_ARGUMENT;
767 goto exit;
768 }
769
Steven Cooremanacda8342020-07-24 23:09:52 +0200770 status = mbedtls_to_psa_error(
771 mbedtls_ecp_group_load( &ecp->grp, grp_id ) );
772 if( status != PSA_SUCCESS )
Steven Cooreman6d839f02020-07-30 11:36:45 +0200773 goto exit;
Steven Cooremanacda8342020-07-24 23:09:52 +0200774
Steven Cooreman6d839f02020-07-30 11:36:45 +0200775 /* Load the key material. */
Steven Cooreman7f391872020-07-30 14:57:44 +0200776 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) )
Steven Cooremanacda8342020-07-24 23:09:52 +0200777 {
778 /* Load the public value. */
779 status = mbedtls_to_psa_error(
780 mbedtls_ecp_point_read_binary( &ecp->grp, &ecp->Q,
Steven Cooreman4fed4552020-08-03 14:46:03 +0200781 data,
782 data_length ) );
Steven Cooremanacda8342020-07-24 23:09:52 +0200783 if( status != PSA_SUCCESS )
784 goto exit;
785
786 /* Check that the point is on the curve. */
787 status = mbedtls_to_psa_error(
788 mbedtls_ecp_check_pubkey( &ecp->grp, &ecp->Q ) );
789 if( status != PSA_SUCCESS )
790 goto exit;
791 }
792 else
793 {
Steven Cooreman6d839f02020-07-30 11:36:45 +0200794 /* Load and validate the secret value. */
Steven Cooremanacda8342020-07-24 23:09:52 +0200795 status = mbedtls_to_psa_error(
796 mbedtls_ecp_read_key( ecp->grp.id,
797 ecp,
Steven Cooreman4fed4552020-08-03 14:46:03 +0200798 data,
799 data_length ) );
Steven Cooremanacda8342020-07-24 23:09:52 +0200800 if( status != PSA_SUCCESS )
801 goto exit;
Steven Cooremanacda8342020-07-24 23:09:52 +0200802 }
Steven Cooremana2371e52020-07-28 14:30:39 +0200803
804 *p_ecp = ecp;
Steven Cooremanacda8342020-07-24 23:09:52 +0200805exit:
806 if( status != PSA_SUCCESS )
Steven Cooremana2371e52020-07-28 14:30:39 +0200807 {
Steven Cooremanacda8342020-07-24 23:09:52 +0200808 mbedtls_ecp_keypair_free( ecp );
Steven Cooremana2371e52020-07-28 14:30:39 +0200809 mbedtls_free( ecp );
810 }
811
Steven Cooreman29149862020-08-05 15:43:42 +0200812 return( status );
Gilles Peskine4cd32772019-12-02 20:49:42 +0100813}
Jaeden Ameroccdce902019-01-10 11:42:27 +0000814
Steven Cooreman4fed4552020-08-03 14:46:03 +0200815/** Export an ECP key to export representation
816 *
817 * \param[in] type The type of key (public/private) to export
818 * \param[in] ecp The internal ECP representation from which to export
819 * \param[out] data The buffer to export to
820 * \param[in] data_size The length of the buffer to export to
821 * \param[out] data_length The amount of bytes written to \p data
822 */
Steven Cooremanacda8342020-07-24 23:09:52 +0200823static psa_status_t psa_export_ecp_key( psa_key_type_t type,
824 mbedtls_ecp_keypair *ecp,
825 uint8_t *data,
826 size_t data_size,
827 size_t *data_length )
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200828{
Steven Cooremanacda8342020-07-24 23:09:52 +0200829 psa_status_t status;
Jaeden Ameroccdce902019-01-10 11:42:27 +0000830
Steven Cooremanacda8342020-07-24 23:09:52 +0200831 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) )
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200832 {
Steven Cooremanacda8342020-07-24 23:09:52 +0200833 /* Check whether the public part is loaded */
834 if( mbedtls_ecp_is_zero( &ecp->Q ) )
835 {
836 /* Calculate the public key */
837 status = mbedtls_to_psa_error(
838 mbedtls_ecp_mul( &ecp->grp, &ecp->Q, &ecp->d, &ecp->grp.G,
839 mbedtls_ctr_drbg_random, &global_data.ctr_drbg ) );
840 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +0200841 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +0200842 }
843
Steven Cooreman4fed4552020-08-03 14:46:03 +0200844 status = mbedtls_to_psa_error(
Steven Cooremanacda8342020-07-24 23:09:52 +0200845 mbedtls_ecp_point_write_binary( &ecp->grp, &ecp->Q,
846 MBEDTLS_ECP_PF_UNCOMPRESSED,
847 data_length,
848 data,
Steven Cooreman4fed4552020-08-03 14:46:03 +0200849 data_size ) );
Steven Cooreman4fed4552020-08-03 14:46:03 +0200850 if( status != PSA_SUCCESS )
851 memset( data, 0, data_size );
852
Steven Cooreman29149862020-08-05 15:43:42 +0200853 return( status );
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200854 }
Steven Cooremanacda8342020-07-24 23:09:52 +0200855 else
856 {
Steven Cooreman29149862020-08-05 15:43:42 +0200857 if( data_size < PSA_BITS_TO_BYTES( ecp->grp.nbits ) )
Steven Cooremanacda8342020-07-24 23:09:52 +0200858 return( PSA_ERROR_BUFFER_TOO_SMALL );
859
860 status = mbedtls_to_psa_error(
861 mbedtls_ecp_write_key( ecp,
862 data,
Steven Cooreman29149862020-08-05 15:43:42 +0200863 PSA_BITS_TO_BYTES( ecp->grp.nbits ) ) );
Steven Cooremanacda8342020-07-24 23:09:52 +0200864 if( status == PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +0200865 *data_length = PSA_BITS_TO_BYTES( ecp->grp.nbits );
Steven Cooremanb7f6dea2020-08-05 16:07:20 +0200866 else
867 memset( data, 0, data_size );
Steven Cooremanacda8342020-07-24 23:09:52 +0200868
869 return( status );
870 }
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200871}
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200872
Steven Cooreman4fed4552020-08-03 14:46:03 +0200873/** Import an ECP key from import representation to a slot
874 *
875 * \param[in,out] slot The slot where to store the export representation to
876 * \param[in] data The buffer containing the import representation
877 * \param[in] data_length The amount of bytes in \p data
878 */
Steven Cooremanacda8342020-07-24 23:09:52 +0200879static psa_status_t psa_import_ecp_key( psa_key_slot_t *slot,
880 const uint8_t *data,
881 size_t data_length )
Gilles Peskinef76aa772018-10-29 19:24:33 +0100882{
Steven Cooremanacda8342020-07-24 23:09:52 +0200883 psa_status_t status;
884 uint8_t* output = NULL;
Steven Cooremana2371e52020-07-28 14:30:39 +0200885 mbedtls_ecp_keypair *ecp = NULL;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100886
Steven Cooremanacda8342020-07-24 23:09:52 +0200887 /* Parse input */
Steven Cooreman4fed4552020-08-03 14:46:03 +0200888 status = psa_load_ecp_representation( slot->attr.type,
889 data,
Steven Cooreman7f391872020-07-30 14:57:44 +0200890 data_length,
Steven Cooreman7f391872020-07-30 14:57:44 +0200891 &ecp );
Gilles Peskinef76aa772018-10-29 19:24:33 +0100892 if( status != PSA_SUCCESS )
893 goto exit;
Gilles Peskine4cd32772019-12-02 20:49:42 +0100894
Steven Cooremanacda8342020-07-24 23:09:52 +0200895 if( PSA_KEY_TYPE_ECC_GET_FAMILY( slot->attr.type ) == PSA_ECC_FAMILY_MONTGOMERY)
Steven Cooremana2371e52020-07-28 14:30:39 +0200896 slot->attr.bits = (psa_key_bits_t) ecp->grp.nbits + 1;
Steven Cooremanacda8342020-07-24 23:09:52 +0200897 else
Steven Cooremana2371e52020-07-28 14:30:39 +0200898 slot->attr.bits = (psa_key_bits_t) ecp->grp.nbits;
Steven Cooremane3fd3922020-06-11 16:50:36 +0200899
Steven Cooremanacda8342020-07-24 23:09:52 +0200900 /* Re-export the data to PSA export format. There is currently no support
901 * for other input formats then the export format, so this is a 1-1
902 * copy operation. */
903 output = mbedtls_calloc( 1, data_length );
Steven Cooremanacda8342020-07-24 23:09:52 +0200904 if( output == NULL )
905 {
906 status = PSA_ERROR_INSUFFICIENT_MEMORY;
907 goto exit;
908 }
909
910 status = psa_export_ecp_key( slot->attr.type,
Steven Cooremana2371e52020-07-28 14:30:39 +0200911 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +0200912 output,
913 data_length,
914 &data_length);
Gilles Peskinef76aa772018-10-29 19:24:33 +0100915exit:
Steven Cooremana2371e52020-07-28 14:30:39 +0200916 /* Always free the PK object (will also free contained ECP context) */
917 mbedtls_ecp_keypair_free( ecp );
Steven Cooreman6d839f02020-07-30 11:36:45 +0200918 mbedtls_free( ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +0200919
920 /* Free the allocated buffer only on error. */
921 if( status != PSA_SUCCESS )
Gilles Peskinef76aa772018-10-29 19:24:33 +0100922 {
Steven Cooremanacda8342020-07-24 23:09:52 +0200923 mbedtls_free( output );
Steven Cooremanacda8342020-07-24 23:09:52 +0200924 return( status );
Gilles Peskinef76aa772018-10-29 19:24:33 +0100925 }
Steven Cooremanacda8342020-07-24 23:09:52 +0200926
927 /* On success, store the allocated export-formatted key. */
928 slot->data.key.data = output;
929 slot->data.key.bytes = data_length;
930
931 return( PSA_SUCCESS );
Gilles Peskinef76aa772018-10-29 19:24:33 +0100932}
933#endif /* defined(MBEDTLS_ECP_C) */
934
Gilles Peskineb46bef22019-07-30 21:32:04 +0200935/** Return the size of the key in the given slot, in bits.
936 *
937 * \param[in] slot A key slot.
938 *
939 * \return The key size in bits, read from the metadata in the slot.
940 */
941static inline size_t psa_get_key_slot_bits( const psa_key_slot_t *slot )
942{
943 return( slot->attr.bits );
944}
945
Steven Cooreman75b74362020-07-28 14:30:13 +0200946/** Try to allocate a buffer to an empty key slot.
947 *
948 * \param[in,out] slot Key slot to attach buffer to.
949 * \param[in] buffer_length Requested size of the buffer.
950 *
951 * \retval #PSA_SUCCESS
952 * The buffer has been successfully allocated.
953 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
954 * Not enough memory was available for allocation.
955 * \retval #PSA_ERROR_ALREADY_EXISTS
956 * Trying to allocate a buffer to a non-empty key slot.
957 */
958static psa_status_t psa_allocate_buffer_to_slot( psa_key_slot_t *slot,
959 size_t buffer_length )
960{
961 if( slot->data.key.data != NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200962 return( PSA_ERROR_ALREADY_EXISTS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200963
964 slot->data.key.data = mbedtls_calloc( 1, buffer_length );
965 if( slot->data.key.data == NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200966 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Steven Cooreman75b74362020-07-28 14:30:13 +0200967
968 slot->data.key.bytes = buffer_length;
Steven Cooreman29149862020-08-05 15:43:42 +0200969 return( PSA_SUCCESS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200970}
971
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200972psa_status_t psa_copy_key_material_into_slot( psa_key_slot_t *slot,
973 const uint8_t* data,
974 size_t data_length )
975{
976 psa_status_t status = psa_allocate_buffer_to_slot( slot,
977 data_length );
978 if( status != PSA_SUCCESS )
979 return( status );
980
981 memcpy( slot->data.key.data, data, data_length );
982 return( PSA_SUCCESS );
983}
984
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200985/** Import key data into a slot.
986 *
987 * `slot->type` must have been set previously.
988 * This function assumes that the slot does not contain any key material yet.
989 * On failure, the slot content is unchanged.
990 *
991 * Persistent storage is not affected.
992 *
993 * \param[in,out] slot The key slot to import data into.
994 * Its `type` field must have previously been set to
995 * the desired key type.
996 * It must not contain any key material yet.
997 * \param[in] data Buffer containing the key material to parse and import.
998 * \param data_length Size of \p data in bytes.
999 *
1000 * \retval #PSA_SUCCESS
1001 * \retval #PSA_ERROR_INVALID_ARGUMENT
1002 * \retval #PSA_ERROR_NOT_SUPPORTED
1003 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
1004 */
1005static psa_status_t psa_import_key_into_slot( psa_key_slot_t *slot,
1006 const uint8_t *data,
1007 size_t data_length )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001008{
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001009 psa_status_t status = PSA_SUCCESS;
Steven Cooreman04524762020-10-13 17:43:44 +02001010 size_t bit_size;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001011
Steven Cooreman81be2fa2020-07-24 22:04:59 +02001012 /* zero-length keys are never supported. */
1013 if( data_length == 0 )
1014 return( PSA_ERROR_NOT_SUPPORTED );
1015
Gilles Peskine8e338702019-07-30 20:06:31 +02001016 if( key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001017 {
Steven Cooreman04524762020-10-13 17:43:44 +02001018 bit_size = PSA_BYTES_TO_BITS( data_length );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02001019
Steven Cooreman75b74362020-07-28 14:30:13 +02001020 /* Ensure that the bytes-to-bits conversion hasn't overflown. */
1021 if( data_length > SIZE_MAX / 8 )
1022 return( PSA_ERROR_NOT_SUPPORTED );
1023
Gilles Peskine1b9505c2019-08-07 10:59:45 +02001024 /* Enforce a size limit, and in particular ensure that the bit
1025 * size fits in its representation type. */
Gilles Peskinec744d992019-07-30 17:26:54 +02001026 if( bit_size > PSA_MAX_KEY_BITS )
1027 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02001028
1029 status = validate_unstructured_key_bit_size( slot->attr.type, bit_size );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +02001030 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001031 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02001032
1033 /* Allocate memory for the key */
Steven Cooremanf7cebd42020-10-13 20:27:40 +02001034 status = psa_copy_key_material_into_slot( slot, data, data_length );
Steven Cooreman75b74362020-07-28 14:30:13 +02001035 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001036 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02001037
Steven Cooreman81be2fa2020-07-24 22:04:59 +02001038 /* Write the actual key size to the slot.
1039 * psa_start_key_creation() wrote the size declared by the
1040 * caller, which may be 0 (meaning unspecified) or wrong. */
1041 slot->attr.bits = (psa_key_bits_t) bit_size;
Steven Cooreman40120f62020-10-29 11:42:22 +01001042
1043 return( PSA_SUCCESS );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001044 }
Steven Cooreman3ea0ce42020-10-23 11:37:05 +02001045 else if( PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
Steven Cooreman19fd5742020-07-24 23:31:01 +02001046 {
Steven Cooreman3ea0ce42020-10-23 11:37:05 +02001047 /* Try validation through accelerators first. */
1048 bit_size = slot->attr.bits;
1049 psa_key_attributes_t attributes = {
1050 .core = slot->attr
1051 };
1052 status = psa_driver_wrapper_validate_key( &attributes,
1053 data,
1054 data_length,
1055 &bit_size );
1056 if( status == PSA_SUCCESS )
1057 {
1058 /* Key has been validated successfully by an accelerator.
1059 * Copy key material into slot. */
1060 status = psa_copy_key_material_into_slot( slot, data, data_length );
1061 if( status != PSA_SUCCESS )
1062 return( status );
1063
1064 slot->attr.bits = (psa_key_bits_t) bit_size;
1065 return( PSA_SUCCESS );
1066 }
1067 else if( status != PSA_ERROR_NOT_SUPPORTED )
1068 return( status );
1069
1070 /* Key format is not supported by any accelerator, try software fallback
1071 * if present. */
Gilles Peskinef76aa772018-10-29 19:24:33 +01001072#if defined(MBEDTLS_ECP_C)
Steven Cooreman3ea0ce42020-10-23 11:37:05 +02001073 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
1074 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001075 return( psa_import_ecp_key( slot, data, data_length ) );
1076 }
Steven Cooreman19fd5742020-07-24 23:31:01 +02001077#endif /* defined(MBEDTLS_ECP_C) */
Steven Cooreman19fd5742020-07-24 23:31:01 +02001078#if defined(MBEDTLS_RSA_C)
Steven Cooreman40120f62020-10-29 11:42:22 +01001079 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +02001080 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001081 return( psa_import_rsa_key( slot, data, data_length ) );
Steven Cooreman3ea0ce42020-10-23 11:37:05 +02001082 }
Steven Cooreman19fd5742020-07-24 23:31:01 +02001083#endif /* defined(MBEDTLS_RSA_C) */
Steven Cooreman40120f62020-10-29 11:42:22 +01001084
1085 /* Fell through the fallback as well, so have nothing else to try. */
1086 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001087 }
1088 else
Gilles Peskinec66ea6a2018-02-03 22:43:28 +01001089 {
Steven Cooreman19fd5742020-07-24 23:31:01 +02001090 /* Unknown key type */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001091 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969ac722018-01-28 18:16:59 +01001092 }
Darryl Green06fd18d2018-07-16 11:21:11 +01001093}
1094
Gilles Peskinef603c712019-01-19 13:40:11 +01001095/** Calculate the intersection of two algorithm usage policies.
1096 *
1097 * Return 0 (which allows no operation) on incompatibility.
1098 */
1099static psa_algorithm_t psa_key_policy_algorithm_intersection(
1100 psa_algorithm_t alg1,
1101 psa_algorithm_t alg2 )
1102{
Gilles Peskine549ea862019-05-22 11:45:59 +02001103 /* Common case: both sides actually specify the same policy. */
Gilles Peskinef603c712019-01-19 13:40:11 +01001104 if( alg1 == alg2 )
1105 return( alg1 );
1106 /* If the policies are from the same hash-and-sign family, check
1107 * if one is a wildcard. If so the other has the specific algorithm. */
1108 if( PSA_ALG_IS_HASH_AND_SIGN( alg1 ) &&
1109 PSA_ALG_IS_HASH_AND_SIGN( alg2 ) &&
1110 ( alg1 & ~PSA_ALG_HASH_MASK ) == ( alg2 & ~PSA_ALG_HASH_MASK ) )
1111 {
1112 if( PSA_ALG_SIGN_GET_HASH( alg1 ) == PSA_ALG_ANY_HASH )
1113 return( alg2 );
1114 if( PSA_ALG_SIGN_GET_HASH( alg2 ) == PSA_ALG_ANY_HASH )
1115 return( alg1 );
1116 }
1117 /* If the policies are incompatible, allow nothing. */
1118 return( 0 );
1119}
1120
Gilles Peskined6f371b2019-05-10 19:33:38 +02001121static int psa_key_algorithm_permits( psa_algorithm_t policy_alg,
1122 psa_algorithm_t requested_alg )
1123{
Gilles Peskine549ea862019-05-22 11:45:59 +02001124 /* Common case: the policy only allows requested_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +02001125 if( requested_alg == policy_alg )
1126 return( 1 );
1127 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
Gilles Peskine549ea862019-05-22 11:45:59 +02001128 * and requested_alg is the same hash-and-sign family with any hash,
1129 * then requested_alg is compliant with policy_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +02001130 if( PSA_ALG_IS_HASH_AND_SIGN( requested_alg ) &&
1131 PSA_ALG_SIGN_GET_HASH( policy_alg ) == PSA_ALG_ANY_HASH )
1132 {
1133 return( ( policy_alg & ~PSA_ALG_HASH_MASK ) ==
1134 ( requested_alg & ~PSA_ALG_HASH_MASK ) );
1135 }
Steven Cooremance48e852020-10-05 16:02:45 +02001136 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +02001137 * a key derivation with that key agreement should also be allowed. This
1138 * behaviour is expected to be defined in a future specification version. */
Steven Cooremance48e852020-10-05 16:02:45 +02001139 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( policy_alg ) &&
1140 PSA_ALG_IS_KEY_AGREEMENT( requested_alg ) )
1141 {
1142 return( PSA_ALG_KEY_AGREEMENT_GET_BASE( requested_alg ) ==
1143 policy_alg );
1144 }
Gilles Peskined6f371b2019-05-10 19:33:38 +02001145 /* If it isn't permitted, it's forbidden. */
1146 return( 0 );
1147}
1148
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001149/** Test whether a policy permits an algorithm.
1150 *
1151 * The caller must test usage flags separately.
1152 */
1153static int psa_key_policy_permits( const psa_key_policy_t *policy,
1154 psa_algorithm_t alg )
1155{
Gilles Peskined6f371b2019-05-10 19:33:38 +02001156 return( psa_key_algorithm_permits( policy->alg, alg ) ||
1157 psa_key_algorithm_permits( policy->alg2, alg ) );
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001158}
1159
Gilles Peskinef603c712019-01-19 13:40:11 +01001160/** Restrict a key policy based on a constraint.
1161 *
1162 * \param[in,out] policy The policy to restrict.
1163 * \param[in] constraint The policy constraint to apply.
1164 *
1165 * \retval #PSA_SUCCESS
1166 * \c *policy contains the intersection of the original value of
1167 * \c *policy and \c *constraint.
1168 * \retval #PSA_ERROR_INVALID_ARGUMENT
1169 * \c *policy and \c *constraint are incompatible.
1170 * \c *policy is unchanged.
1171 */
1172static psa_status_t psa_restrict_key_policy(
1173 psa_key_policy_t *policy,
1174 const psa_key_policy_t *constraint )
1175{
1176 psa_algorithm_t intersection_alg =
1177 psa_key_policy_algorithm_intersection( policy->alg, constraint->alg );
Gilles Peskined6f371b2019-05-10 19:33:38 +02001178 psa_algorithm_t intersection_alg2 =
1179 psa_key_policy_algorithm_intersection( policy->alg2, constraint->alg2 );
Gilles Peskinef603c712019-01-19 13:40:11 +01001180 if( intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0 )
1181 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskined6f371b2019-05-10 19:33:38 +02001182 if( intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0 )
1183 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinef603c712019-01-19 13:40:11 +01001184 policy->usage &= constraint->usage;
1185 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +02001186 policy->alg2 = intersection_alg2;
Gilles Peskinef603c712019-01-19 13:40:11 +01001187 return( PSA_SUCCESS );
1188}
1189
Darryl Green06fd18d2018-07-16 11:21:11 +01001190/** Retrieve a slot which must contain a key. The key must have allow all the
1191 * usage flags set in \p usage. If \p alg is nonzero, the key must allow
1192 * operations with this algorithm. */
Gilles Peskinec5487a82018-12-03 18:08:14 +01001193static psa_status_t psa_get_key_from_slot( psa_key_handle_t handle,
Gilles Peskine2f060a82018-12-04 17:12:32 +01001194 psa_key_slot_t **p_slot,
Darryl Green06fd18d2018-07-16 11:21:11 +01001195 psa_key_usage_t usage,
1196 psa_algorithm_t alg )
1197{
1198 psa_status_t status;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001199 psa_key_slot_t *slot = NULL;
Darryl Green06fd18d2018-07-16 11:21:11 +01001200
1201 *p_slot = NULL;
1202
Gilles Peskinec5487a82018-12-03 18:08:14 +01001203 status = psa_get_key_slot( handle, &slot );
Darryl Green06fd18d2018-07-16 11:21:11 +01001204 if( status != PSA_SUCCESS )
1205 return( status );
Darryl Green06fd18d2018-07-16 11:21:11 +01001206
1207 /* Enforce that usage policy for the key slot contains all the flags
1208 * required by the usage parameter. There is one exception: public
1209 * keys can always be exported, so we treat public key objects as
1210 * if they had the export flag. */
Gilles Peskine8e338702019-07-30 20:06:31 +02001211 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Darryl Green06fd18d2018-07-16 11:21:11 +01001212 usage &= ~PSA_KEY_USAGE_EXPORT;
Gilles Peskine8e338702019-07-30 20:06:31 +02001213 if( ( slot->attr.policy.usage & usage ) != usage )
Darryl Green06fd18d2018-07-16 11:21:11 +01001214 return( PSA_ERROR_NOT_PERMITTED );
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001215
1216 /* Enforce that the usage policy permits the requested algortihm. */
Gilles Peskine8e338702019-07-30 20:06:31 +02001217 if( alg != 0 && ! psa_key_policy_permits( &slot->attr.policy, alg ) )
Darryl Green06fd18d2018-07-16 11:21:11 +01001218 return( PSA_ERROR_NOT_PERMITTED );
1219
1220 *p_slot = slot;
1221 return( PSA_SUCCESS );
1222}
Darryl Green940d72c2018-07-13 13:18:51 +01001223
Gilles Peskine28f8f302019-07-24 13:30:31 +02001224/** Retrieve a slot which must contain a transparent key.
1225 *
1226 * A transparent key is a key for which the key material is directly
1227 * available, as opposed to a key in a secure element.
1228 *
Gilles Peskine60450a42019-07-25 11:32:45 +02001229 * This is a temporary function to use instead of psa_get_key_from_slot()
1230 * until secure element support is fully implemented.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001231 */
1232#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1233static psa_status_t psa_get_transparent_key( psa_key_handle_t handle,
1234 psa_key_slot_t **p_slot,
1235 psa_key_usage_t usage,
1236 psa_algorithm_t alg )
1237{
1238 psa_status_t status = psa_get_key_from_slot( handle, p_slot, usage, alg );
1239 if( status != PSA_SUCCESS )
1240 return( status );
Gilles Peskineadad8132019-07-25 11:31:23 +02001241 if( psa_key_slot_is_external( *p_slot ) )
Gilles Peskine28f8f302019-07-24 13:30:31 +02001242 {
1243 *p_slot = NULL;
1244 return( PSA_ERROR_NOT_SUPPORTED );
1245 }
1246 return( PSA_SUCCESS );
1247}
1248#else /* MBEDTLS_PSA_CRYPTO_SE_C */
1249/* With no secure element support, all keys are transparent. */
1250#define psa_get_transparent_key( handle, p_slot, usage, alg ) \
1251 psa_get_key_from_slot( handle, p_slot, usage, alg )
1252#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1253
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001254/** Wipe key data from a slot. Preserve metadata such as the policy. */
Gilles Peskine2f060a82018-12-04 17:12:32 +01001255static psa_status_t psa_remove_key_data_from_memory( psa_key_slot_t *slot )
Darryl Green40225ba2018-11-15 14:48:15 +00001256{
Gilles Peskine73167e12019-07-12 23:44:37 +02001257#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1258 if( psa_key_slot_is_external( slot ) )
Darryl Green40225ba2018-11-15 14:48:15 +00001259 {
1260 /* No key material to clean. */
1261 }
Gilles Peskine73167e12019-07-12 23:44:37 +02001262 else
1263#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Darryl Green40225ba2018-11-15 14:48:15 +00001264 {
Steven Cooremanfd4d69a2020-08-05 15:46:33 +02001265 /* Data pointer will always be either a valid pointer or NULL in an
1266 * initialized slot, so we can just free it. */
1267 if( slot->data.key.data != NULL )
1268 mbedtls_platform_zeroize( slot->data.key.data, slot->data.key.bytes);
Steven Cooremana01795d2020-07-24 22:48:15 +02001269 mbedtls_free( slot->data.key.data );
1270 slot->data.key.data = NULL;
1271 slot->data.key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +00001272 }
Darryl Green40225ba2018-11-15 14:48:15 +00001273
1274 return( PSA_SUCCESS );
1275}
1276
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001277/** Completely wipe a slot in memory, including its policy.
1278 * Persistent storage is not affected. */
Gilles Peskine66fb1262018-12-10 16:29:04 +01001279psa_status_t psa_wipe_key_slot( psa_key_slot_t *slot )
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001280{
1281 psa_status_t status = psa_remove_key_data_from_memory( slot );
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001282 /* Multipart operations may still be using the key. This is safe
1283 * because all multipart operation objects are independent from
1284 * the key slot: if they need to access the key after the setup
1285 * phase, they have a copy of the key. Note that this means that
1286 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001287 /* At this point, key material and other type-specific content has
1288 * been wiped. Clear remaining metadata. We can call memset and not
1289 * zeroize because the metadata is not particularly sensitive. */
1290 memset( slot, 0, sizeof( *slot ) );
1291 return( status );
1292}
1293
Gilles Peskinec5487a82018-12-03 18:08:14 +01001294psa_status_t psa_destroy_key( psa_key_handle_t handle )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001295{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001296 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001297 psa_status_t status; /* status of the last operation */
1298 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001299#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1300 psa_se_drv_table_entry_t *driver;
1301#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001302
Gilles Peskine1841cf42019-10-08 15:48:25 +02001303 if( handle == 0 )
1304 return( PSA_SUCCESS );
1305
Gilles Peskinec5487a82018-12-03 18:08:14 +01001306 status = psa_get_key_slot( handle, &slot );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001307 if( status != PSA_SUCCESS )
1308 return( status );
Gilles Peskine354f7672019-07-12 23:46:38 +02001309
1310#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001311 driver = psa_get_se_driver_entry( slot->attr.lifetime );
Gilles Peskine354f7672019-07-12 23:46:38 +02001312 if( driver != NULL )
Gilles Peskinefc762652019-07-22 19:30:34 +02001313 {
Gilles Peskine60450a42019-07-25 11:32:45 +02001314 /* For a key in a secure element, we need to do three things:
1315 * remove the key file in internal storage, destroy the
1316 * key inside the secure element, and update the driver's
1317 * persistent data. Start a transaction that will encompass these
1318 * three actions. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001319 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_DESTROY_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +02001320 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Gilles Peskinefc762652019-07-22 19:30:34 +02001321 psa_crypto_transaction.key.slot = slot->data.se.slot_number;
Gilles Peskine8e338702019-07-30 20:06:31 +02001322 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskinefc762652019-07-22 19:30:34 +02001323 status = psa_crypto_save_transaction( );
1324 if( status != PSA_SUCCESS )
1325 {
Gilles Peskine66be51c2019-07-25 18:02:52 +02001326 (void) psa_crypto_stop_transaction( );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001327 /* We should still try to destroy the key in the secure
1328 * element and the key metadata in storage. This is especially
1329 * important if the error is that the storage is full.
1330 * But how to do it exactly without risking an inconsistent
1331 * state after a reset?
1332 * https://github.com/ARMmbed/mbed-crypto/issues/215
1333 */
1334 overall_status = status;
1335 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001336 }
1337
Gilles Peskine354f7672019-07-12 23:46:38 +02001338 status = psa_destroy_se_key( driver, slot->data.se.slot_number );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001339 if( overall_status == PSA_SUCCESS )
1340 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001341 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001342#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1343
Darryl Greend49a4992018-06-18 17:27:26 +01001344#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskinecaec2782019-08-13 15:11:49 +02001345 if( slot->attr.lifetime != PSA_KEY_LIFETIME_VOLATILE )
Darryl Greend49a4992018-06-18 17:27:26 +01001346 {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001347 status = psa_destroy_persistent_key( slot->attr.id );
1348 if( overall_status == PSA_SUCCESS )
1349 overall_status = status;
1350
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001351 /* TODO: other slots may have a copy of the same key. We should
1352 * invalidate them.
1353 * https://github.com/ARMmbed/mbed-crypto/issues/214
1354 */
Darryl Greend49a4992018-06-18 17:27:26 +01001355 }
1356#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001357
Gilles Peskinefc762652019-07-22 19:30:34 +02001358#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1359 if( driver != NULL )
1360 {
Gilles Peskine725f22a2019-07-25 11:31:48 +02001361 status = psa_save_se_persistent_data( driver );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001362 if( overall_status == PSA_SUCCESS )
1363 overall_status = status;
1364 status = psa_crypto_stop_transaction( );
1365 if( overall_status == PSA_SUCCESS )
1366 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001367 }
1368#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1369
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001370#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1371exit:
1372#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001373 status = psa_wipe_key_slot( slot );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001374 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
1375 if( overall_status == PSA_SUCCESS )
1376 overall_status = status;
1377 return( overall_status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001378}
1379
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001380void psa_reset_key_attributes( psa_key_attributes_t *attributes )
Gilles Peskineb870b182018-07-06 16:02:09 +02001381{
Gilles Peskineb699f072019-04-26 16:06:02 +02001382 mbedtls_free( attributes->domain_parameters );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001383 memset( attributes, 0, sizeof( *attributes ) );
Gilles Peskineb870b182018-07-06 16:02:09 +02001384}
1385
Gilles Peskineb699f072019-04-26 16:06:02 +02001386psa_status_t psa_set_key_domain_parameters( psa_key_attributes_t *attributes,
1387 psa_key_type_t type,
1388 const uint8_t *data,
1389 size_t data_length )
1390{
1391 uint8_t *copy = NULL;
1392
1393 if( data_length != 0 )
1394 {
1395 copy = mbedtls_calloc( 1, data_length );
1396 if( copy == NULL )
1397 return( PSA_ERROR_INSUFFICIENT_MEMORY );
1398 memcpy( copy, data, data_length );
1399 }
1400 /* After this point, this function is guaranteed to succeed, so it
1401 * can start modifying `*attributes`. */
1402
1403 if( attributes->domain_parameters != NULL )
1404 {
1405 mbedtls_free( attributes->domain_parameters );
1406 attributes->domain_parameters = NULL;
1407 attributes->domain_parameters_size = 0;
1408 }
1409
1410 attributes->domain_parameters = copy;
1411 attributes->domain_parameters_size = data_length;
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001412 attributes->core.type = type;
Gilles Peskineb699f072019-04-26 16:06:02 +02001413 return( PSA_SUCCESS );
1414}
1415
1416psa_status_t psa_get_key_domain_parameters(
1417 const psa_key_attributes_t *attributes,
1418 uint8_t *data, size_t data_size, size_t *data_length )
1419{
1420 if( attributes->domain_parameters_size > data_size )
1421 return( PSA_ERROR_BUFFER_TOO_SMALL );
1422 *data_length = attributes->domain_parameters_size;
1423 if( attributes->domain_parameters_size != 0 )
1424 memcpy( data, attributes->domain_parameters,
1425 attributes->domain_parameters_size );
1426 return( PSA_SUCCESS );
1427}
1428
1429#if defined(MBEDTLS_RSA_C)
1430static psa_status_t psa_get_rsa_public_exponent(
1431 const mbedtls_rsa_context *rsa,
1432 psa_key_attributes_t *attributes )
1433{
1434 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001435 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001436 uint8_t *buffer = NULL;
1437 size_t buflen;
1438 mbedtls_mpi_init( &mpi );
1439
1440 ret = mbedtls_rsa_export( rsa, NULL, NULL, NULL, NULL, &mpi );
1441 if( ret != 0 )
1442 goto exit;
Gilles Peskine772c8b12019-04-26 17:37:21 +02001443 if( mbedtls_mpi_cmp_int( &mpi, 65537 ) == 0 )
1444 {
1445 /* It's the default value, which is reported as an empty string,
1446 * so there's nothing to do. */
1447 goto exit;
1448 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001449
1450 buflen = mbedtls_mpi_size( &mpi );
1451 buffer = mbedtls_calloc( 1, buflen );
1452 if( buffer == NULL )
1453 {
1454 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1455 goto exit;
1456 }
1457 ret = mbedtls_mpi_write_binary( &mpi, buffer, buflen );
1458 if( ret != 0 )
1459 goto exit;
1460 attributes->domain_parameters = buffer;
1461 attributes->domain_parameters_size = buflen;
1462
1463exit:
1464 mbedtls_mpi_free( &mpi );
1465 if( ret != 0 )
1466 mbedtls_free( buffer );
1467 return( mbedtls_to_psa_error( ret ) );
1468}
1469#endif /* MBEDTLS_RSA_C */
1470
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001471/** Retrieve all the publicly-accessible attributes of a key.
1472 */
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001473psa_status_t psa_get_key_attributes( psa_key_handle_t handle,
1474 psa_key_attributes_t *attributes )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001475{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001476 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001477 psa_status_t status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001478
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001479 psa_reset_key_attributes( attributes );
1480
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001481 status = psa_get_key_from_slot( handle, &slot, 0, 0 );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001482 if( status != PSA_SUCCESS )
1483 return( status );
Gilles Peskineb870b182018-07-06 16:02:09 +02001484
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001485 attributes->core = slot->attr;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001486 attributes->core.flags &= ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1487 MBEDTLS_PSA_KA_MASK_DUAL_USE );
1488
1489#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1490 if( psa_key_slot_is_external( slot ) )
1491 psa_set_key_slot_number( attributes, slot->data.se.slot_number );
1492#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001493
Gilles Peskine8e338702019-07-30 20:06:31 +02001494 switch( slot->attr.type )
Gilles Peskineb699f072019-04-26 16:06:02 +02001495 {
1496#if defined(MBEDTLS_RSA_C)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001497 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001498 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001499#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001500 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001501 * is not yet implemented.
1502 * https://github.com/ARMmbed/mbed-crypto/issues/216
1503 */
Gilles Peskinec8000c02019-08-02 20:15:51 +02001504 if( psa_key_slot_is_external( slot ) )
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001505 break;
1506#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Steven Cooremana01795d2020-07-24 22:48:15 +02001507 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001508 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001509
Steven Cooreman4fed4552020-08-03 14:46:03 +02001510 status = psa_load_rsa_representation( slot->attr.type,
1511 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02001512 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02001513 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001514 if( status != PSA_SUCCESS )
1515 break;
1516
Steven Cooremana2371e52020-07-28 14:30:39 +02001517 status = psa_get_rsa_public_exponent( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02001518 attributes );
Steven Cooremana2371e52020-07-28 14:30:39 +02001519 mbedtls_rsa_free( rsa );
1520 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001521 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001522 break;
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001523#endif /* MBEDTLS_RSA_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001524 default:
1525 /* Nothing else to do. */
1526 break;
1527 }
1528
1529 if( status != PSA_SUCCESS )
1530 psa_reset_key_attributes( attributes );
1531 return( status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001532}
1533
Gilles Peskinec8000c02019-08-02 20:15:51 +02001534#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1535psa_status_t psa_get_key_slot_number(
1536 const psa_key_attributes_t *attributes,
1537 psa_key_slot_number_t *slot_number )
1538{
1539 if( attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER )
1540 {
1541 *slot_number = attributes->slot_number;
1542 return( PSA_SUCCESS );
1543 }
1544 else
1545 return( PSA_ERROR_INVALID_ARGUMENT );
1546}
1547#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1548
Steven Cooremana01795d2020-07-24 22:48:15 +02001549static psa_status_t psa_internal_export_key_buffer( const psa_key_slot_t *slot,
1550 uint8_t *data,
1551 size_t data_size,
1552 size_t *data_length )
1553{
1554 if( slot->data.key.bytes > data_size )
1555 return( PSA_ERROR_BUFFER_TOO_SMALL );
1556 memcpy( data, slot->data.key.data, slot->data.key.bytes );
1557 memset( data + slot->data.key.bytes, 0,
1558 data_size - slot->data.key.bytes );
1559 *data_length = slot->data.key.bytes;
1560 return( PSA_SUCCESS );
1561}
1562
Gilles Peskinef603c712019-01-19 13:40:11 +01001563static psa_status_t psa_internal_export_key( const psa_key_slot_t *slot,
1564 uint8_t *data,
1565 size_t data_size,
1566 size_t *data_length,
1567 int export_public_key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001568{
Gilles Peskine5d309672019-07-12 23:47:28 +02001569#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1570 const psa_drv_se_t *drv;
1571 psa_drv_se_context_t *drv_context;
1572#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1573
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001574 *data_length = 0;
1575
Gilles Peskine8e338702019-07-30 20:06:31 +02001576 if( export_public_key && ! PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
Moran Pekera998bc62018-04-16 18:16:20 +03001577 return( PSA_ERROR_INVALID_ARGUMENT );
mohammad160306e79202018-03-28 13:17:44 +03001578
Gilles Peskinef9168942019-09-12 19:20:29 +02001579 /* Reject a zero-length output buffer now, since this can never be a
1580 * valid key representation. This way we know that data must be a valid
1581 * pointer and we can do things like memset(data, ..., data_size). */
1582 if( data_size == 0 )
1583 return( PSA_ERROR_BUFFER_TOO_SMALL );
1584
Gilles Peskine5d309672019-07-12 23:47:28 +02001585#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001586 if( psa_get_se_driver( slot->attr.lifetime, &drv, &drv_context ) )
Gilles Peskine5d309672019-07-12 23:47:28 +02001587 {
1588 psa_drv_se_export_key_t method;
1589 if( drv->key_management == NULL )
1590 return( PSA_ERROR_NOT_SUPPORTED );
1591 method = ( export_public_key ?
1592 drv->key_management->p_export_public :
1593 drv->key_management->p_export );
1594 if( method == NULL )
1595 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine2e0f3882019-07-25 11:34:33 +02001596 return( method( drv_context,
1597 slot->data.se.slot_number,
1598 data, data_size, data_length ) );
Gilles Peskine5d309672019-07-12 23:47:28 +02001599 }
1600#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1601
Gilles Peskine8e338702019-07-30 20:06:31 +02001602 if( key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001603 {
Steven Cooremanacda8342020-07-24 23:09:52 +02001604 return( psa_internal_export_key_buffer( slot, data, data_size, data_length ) );
Gilles Peskine188c71e2018-10-29 19:26:02 +01001605 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001606 else if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) ||
1607 PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
Moran Peker17e36e12018-05-02 12:55:20 +03001608 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001609 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Gilles Peskine969ac722018-01-28 18:16:59 +01001610 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001611 /* Exporting public -> public */
1612 return( psa_internal_export_key_buffer( slot, data, data_size, data_length ) );
1613 }
1614 else if( !export_public_key )
1615 {
1616 /* Exporting private -> private */
1617 return( psa_internal_export_key_buffer( slot, data, data_size, data_length ) );
1618 }
1619 /* Need to export the public part of a private key,
1620 * so conversion is needed */
1621 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
1622 {
Darryl Green9e2d7a02018-07-24 16:33:30 +01001623#if defined(MBEDTLS_RSA_C)
Steven Cooremana2371e52020-07-28 14:30:39 +02001624 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman7f391872020-07-30 14:57:44 +02001625 psa_status_t status = psa_load_rsa_representation(
Steven Cooreman4fed4552020-08-03 14:46:03 +02001626 slot->attr.type,
Steven Cooreman7f391872020-07-30 14:57:44 +02001627 slot->data.key.data,
1628 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02001629 &rsa );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001630 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001631 return( status );
Steven Cooremana01795d2020-07-24 22:48:15 +02001632
Steven Cooreman560c28a2020-07-24 23:20:24 +02001633 status = psa_export_rsa_key( PSA_KEY_TYPE_RSA_PUBLIC_KEY,
Steven Cooremana2371e52020-07-28 14:30:39 +02001634 rsa,
Steven Cooreman560c28a2020-07-24 23:20:24 +02001635 data,
1636 data_size,
1637 data_length );
Steven Cooremana01795d2020-07-24 22:48:15 +02001638
Steven Cooremana2371e52020-07-28 14:30:39 +02001639 mbedtls_rsa_free( rsa );
1640 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001641
Steven Cooreman560c28a2020-07-24 23:20:24 +02001642 return( status );
Darryl Green9e2d7a02018-07-24 16:33:30 +01001643#else
Steven Cooreman560c28a2020-07-24 23:20:24 +02001644 /* We don't know how to convert a private RSA key to public. */
1645 return( PSA_ERROR_NOT_SUPPORTED );
Darryl Green9e2d7a02018-07-24 16:33:30 +01001646#endif
Gilles Peskine969ac722018-01-28 18:16:59 +01001647 }
1648 else
Moran Pekera998bc62018-04-16 18:16:20 +03001649 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001650#if defined(MBEDTLS_ECP_C)
Steven Cooremana2371e52020-07-28 14:30:39 +02001651 mbedtls_ecp_keypair *ecp = NULL;
Steven Cooreman7f391872020-07-30 14:57:44 +02001652 psa_status_t status = psa_load_ecp_representation(
Steven Cooreman4fed4552020-08-03 14:46:03 +02001653 slot->attr.type,
Steven Cooreman7f391872020-07-30 14:57:44 +02001654 slot->data.key.data,
1655 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02001656 &ecp );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001657 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001658 return( status );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001659
1660 status = psa_export_ecp_key( PSA_KEY_TYPE_ECC_PUBLIC_KEY(
1661 PSA_KEY_TYPE_ECC_GET_FAMILY(
1662 slot->attr.type ) ),
Steven Cooremana2371e52020-07-28 14:30:39 +02001663 ecp,
Steven Cooreman560c28a2020-07-24 23:20:24 +02001664 data,
1665 data_size,
1666 data_length );
1667
Steven Cooremana2371e52020-07-28 14:30:39 +02001668 mbedtls_ecp_keypair_free( ecp );
1669 mbedtls_free( ecp );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001670 return( status );
1671#else
1672 /* We don't know how to convert a private ECC key to public */
Moran Pekera998bc62018-04-16 18:16:20 +03001673 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001674#endif
Moran Pekera998bc62018-04-16 18:16:20 +03001675 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001676 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001677 else
1678 {
1679 /* This shouldn't happen in the reference implementation, but
1680 it is valid for a special-purpose implementation to omit
1681 support for exporting certain key types. */
1682 return( PSA_ERROR_NOT_SUPPORTED );
1683 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001684}
1685
Gilles Peskinec5487a82018-12-03 18:08:14 +01001686psa_status_t psa_export_key( psa_key_handle_t handle,
Gilles Peskine2d277862018-06-18 15:41:12 +02001687 uint8_t *data,
1688 size_t data_size,
1689 size_t *data_length )
Moran Pekera998bc62018-04-16 18:16:20 +03001690{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001691 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001692 psa_status_t status;
1693
1694 /* Set the key to empty now, so that even when there are errors, we always
1695 * set data_length to a value between 0 and data_size. On error, setting
1696 * the key to empty is a good choice because an empty key representation is
1697 * unlikely to be accepted anywhere. */
1698 *data_length = 0;
1699
1700 /* Export requires the EXPORT flag. There is an exception for public keys,
1701 * which don't require any flag, but psa_get_key_from_slot takes
1702 * care of this. */
Gilles Peskinec5487a82018-12-03 18:08:14 +01001703 status = psa_get_key_from_slot( handle, &slot, PSA_KEY_USAGE_EXPORT, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001704 if( status != PSA_SUCCESS )
1705 return( status );
1706 return( psa_internal_export_key( slot, data, data_size,
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02001707 data_length, 0 ) );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001708}
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001709
Gilles Peskinec5487a82018-12-03 18:08:14 +01001710psa_status_t psa_export_public_key( psa_key_handle_t handle,
Gilles Peskine2d277862018-06-18 15:41:12 +02001711 uint8_t *data,
1712 size_t data_size,
1713 size_t *data_length )
Moran Pekerdd4ea382018-04-03 15:30:03 +03001714{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001715 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001716 psa_status_t status;
1717
1718 /* Set the key to empty now, so that even when there are errors, we always
1719 * set data_length to a value between 0 and data_size. On error, setting
1720 * the key to empty is a good choice because an empty key representation is
1721 * unlikely to be accepted anywhere. */
1722 *data_length = 0;
1723
1724 /* Exporting a public key doesn't require a usage flag. */
Gilles Peskinec5487a82018-12-03 18:08:14 +01001725 status = psa_get_key_from_slot( handle, &slot, 0, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001726 if( status != PSA_SUCCESS )
1727 return( status );
1728 return( psa_internal_export_key( slot, data, data_size,
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02001729 data_length, 1 ) );
Moran Pekerdd4ea382018-04-03 15:30:03 +03001730}
1731
Gilles Peskine91e8c332019-08-02 19:19:39 +02001732#if defined(static_assert)
1733static_assert( ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
1734 "One or more key attribute flag is listed as both external-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001735static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
Gilles Peskine094dac12019-08-07 18:19:46 +02001736 "One or more key attribute flag is listed as both internal-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001737static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY ) == 0,
Gilles Peskine91e8c332019-08-02 19:19:39 +02001738 "One or more key attribute flag is listed as both internal-only and external-only" );
1739#endif
1740
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001741/** Validate that a key policy is internally well-formed.
1742 *
1743 * This function only rejects invalid policies. It does not validate the
1744 * consistency of the policy with respect to other attributes of the key
1745 * such as the key type.
1746 */
1747static psa_status_t psa_validate_key_policy( const psa_key_policy_t *policy )
Gilles Peskine4747d192019-04-17 15:05:45 +02001748{
1749 if( ( policy->usage & ~( PSA_KEY_USAGE_EXPORT |
Gilles Peskine8e0206a2019-05-14 14:24:28 +02001750 PSA_KEY_USAGE_COPY |
Gilles Peskine4747d192019-04-17 15:05:45 +02001751 PSA_KEY_USAGE_ENCRYPT |
1752 PSA_KEY_USAGE_DECRYPT |
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001753 PSA_KEY_USAGE_SIGN_HASH |
1754 PSA_KEY_USAGE_VERIFY_HASH |
Gilles Peskine4747d192019-04-17 15:05:45 +02001755 PSA_KEY_USAGE_DERIVE ) ) != 0 )
1756 return( PSA_ERROR_INVALID_ARGUMENT );
1757
Gilles Peskine4747d192019-04-17 15:05:45 +02001758 return( PSA_SUCCESS );
1759}
1760
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001761/** Validate the internal consistency of key attributes.
1762 *
1763 * This function only rejects invalid attribute values. If does not
1764 * validate the consistency of the attributes with any key data that may
1765 * be involved in the creation of the key.
1766 *
1767 * Call this function early in the key creation process.
1768 *
1769 * \param[in] attributes Key attributes for the new key.
1770 * \param[out] p_drv On any return, the driver for the key, if any.
1771 * NULL for a transparent key.
1772 *
1773 */
1774static psa_status_t psa_validate_key_attributes(
1775 const psa_key_attributes_t *attributes,
1776 psa_se_drv_table_entry_t **p_drv )
Darryl Green0c6575a2018-11-07 16:05:30 +00001777{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001778 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001779
Steven Cooreman8c1e7592020-06-17 14:52:05 +02001780 status = psa_validate_key_location( psa_get_key_lifetime( attributes ),
1781 p_drv );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001782 if( status != PSA_SUCCESS )
1783 return( status );
1784
Steven Cooreman8c1e7592020-06-17 14:52:05 +02001785 status = psa_validate_key_persistence( psa_get_key_lifetime( attributes ),
1786 psa_get_key_id( attributes ) );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001787 if( status != PSA_SUCCESS )
1788 return( status );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001789
1790 status = psa_validate_key_policy( &attributes->core.policy );
Darryl Green0c6575a2018-11-07 16:05:30 +00001791 if( status != PSA_SUCCESS )
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001792 return( status );
1793
1794 /* Refuse to create overly large keys.
1795 * Note that this doesn't trigger on import if the attributes don't
1796 * explicitly specify a size (so psa_get_key_bits returns 0), so
1797 * psa_import_key() needs its own checks. */
1798 if( psa_get_key_bits( attributes ) > PSA_MAX_KEY_BITS )
1799 return( PSA_ERROR_NOT_SUPPORTED );
1800
Gilles Peskine91e8c332019-08-02 19:19:39 +02001801 /* Reject invalid flags. These should not be reachable through the API. */
1802 if( attributes->core.flags & ~ ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1803 MBEDTLS_PSA_KA_MASK_DUAL_USE ) )
1804 return( PSA_ERROR_INVALID_ARGUMENT );
1805
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001806 return( PSA_SUCCESS );
1807}
1808
Gilles Peskine4747d192019-04-17 15:05:45 +02001809/** Prepare a key slot to receive key material.
1810 *
1811 * This function allocates a key slot and sets its metadata.
1812 *
1813 * If this function fails, call psa_fail_key_creation().
1814 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001815 * This function is intended to be used as follows:
1816 * -# Call psa_start_key_creation() to allocate a key slot, prepare
1817 * it with the specified attributes, and assign it a handle.
1818 * -# Populate the slot with the key material.
1819 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1820 * In case of failure at any step, stop the sequence and call
1821 * psa_fail_key_creation().
1822 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001823 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001824 * \param[in] attributes Key attributes for the new key.
1825 * \param[out] handle On success, a handle for the allocated slot.
1826 * \param[out] p_slot On success, a pointer to the prepared slot.
1827 * \param[out] p_drv On any return, the driver for the key, if any.
1828 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001829 *
1830 * \retval #PSA_SUCCESS
1831 * The key slot is ready to receive key material.
1832 * \return If this function fails, the key slot is an invalid state.
1833 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001834 */
1835static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001836 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001837 const psa_key_attributes_t *attributes,
1838 psa_key_handle_t *handle,
Gilles Peskine011e4282019-06-26 18:34:38 +02001839 psa_key_slot_t **p_slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001840 psa_se_drv_table_entry_t **p_drv )
Gilles Peskine4747d192019-04-17 15:05:45 +02001841{
1842 psa_status_t status;
1843 psa_key_slot_t *slot;
1844
Gilles Peskinedf179142019-07-15 22:02:14 +02001845 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001846 *p_drv = NULL;
1847
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001848 status = psa_validate_key_attributes( attributes, p_drv );
1849 if( status != PSA_SUCCESS )
1850 return( status );
1851
Gilles Peskineedbed562019-08-07 18:19:59 +02001852 status = psa_get_empty_key_slot( handle, p_slot );
Gilles Peskine4747d192019-04-17 15:05:45 +02001853 if( status != PSA_SUCCESS )
1854 return( status );
1855 slot = *p_slot;
1856
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001857 /* We're storing the declared bit-size of the key. It's up to each
1858 * creation mechanism to verify that this information is correct.
1859 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001860 * an input (generate, device) but not for those where the bit-size
1861 * is optional (import, copy). */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001862
1863 slot->attr = attributes->core;
Gilles Peskinec744d992019-07-30 17:26:54 +02001864
Gilles Peskine91e8c332019-08-02 19:19:39 +02001865 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001866 * external-only flags, query `attributes`. Thanks to the check
1867 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001868 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001869 * may have set. */
1870 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001871
Gilles Peskinecbaff462019-07-12 23:46:04 +02001872#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001873 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001874 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001875 * create the key file in internal storage, create the
1876 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001877 * persistent data. This is done by starting a transaction that will
1878 * encompass these three actions.
1879 * For registering a volatile key, we just need to find an appropriate
1880 * slot number inside the SE. Since the key is designated volatile, creating
1881 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001882 /* The first thing to do is to find a slot number for the new key.
1883 * We save the slot number in persistent storage as part of the
1884 * transaction data. It will be needed to recover if the power
1885 * fails during the key creation process, to clean up on the secure
1886 * element side after restarting. Obtaining a slot number from the
1887 * secure element driver updates its persistent state, but we do not yet
1888 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001889 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001890 if( *p_drv != NULL )
Darryl Green0c6575a2018-11-07 16:05:30 +00001891 {
Gilles Peskinee88c2c12019-08-05 16:44:14 +02001892 status = psa_find_se_slot_for_key( attributes, method, *p_drv,
Gilles Peskinecbaff462019-07-12 23:46:04 +02001893 &slot->data.se.slot_number );
1894 if( status != PSA_SUCCESS )
1895 return( status );
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001896
1897 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( attributes->core.lifetime ) )
Gilles Peskine66be51c2019-07-25 18:02:52 +02001898 {
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001899 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_CREATE_KEY );
1900 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
1901 psa_crypto_transaction.key.slot = slot->data.se.slot_number;
1902 psa_crypto_transaction.key.id = slot->attr.id;
1903 status = psa_crypto_save_transaction( );
1904 if( status != PSA_SUCCESS )
1905 {
1906 (void) psa_crypto_stop_transaction( );
1907 return( status );
1908 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001909 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001910 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001911
1912 if( *p_drv == NULL && method == PSA_KEY_CREATION_REGISTER )
1913 {
1914 /* Key registration only makes sense with a secure element. */
1915 return( PSA_ERROR_INVALID_ARGUMENT );
1916 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001917#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1918
Darryl Green0c6575a2018-11-07 16:05:30 +00001919 return( status );
1920}
Gilles Peskine4747d192019-04-17 15:05:45 +02001921
1922/** Finalize the creation of a key once its key material has been set.
1923 *
1924 * This entails writing the key to persistent storage.
1925 *
1926 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001927 * See the documentation of psa_start_key_creation() for the intended use
1928 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001929 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001930 * \param[in,out] slot Pointer to the slot with key material.
1931 * \param[in] driver The secure element driver for the key,
1932 * or NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001933 *
1934 * \retval #PSA_SUCCESS
1935 * The key was successfully created. The handle is now valid.
1936 * \return If this function fails, the key slot is an invalid state.
1937 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001938 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001939static psa_status_t psa_finish_key_creation(
1940 psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001941 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001942{
1943 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001944 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001945 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001946
1947#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Steven Cooremanc59de6a2020-06-08 18:28:25 +02001948 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Gilles Peskine4747d192019-04-17 15:05:45 +02001949 {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001950#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1951 if( driver != NULL )
1952 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001953 psa_se_key_data_storage_t data;
1954#if defined(static_assert)
1955 static_assert( sizeof( slot->data.se.slot_number ) ==
1956 sizeof( data.slot_number ),
1957 "Slot number size does not match psa_se_key_data_storage_t" );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001958#endif
1959 memcpy( &data.slot_number, &slot->data.se.slot_number,
1960 sizeof( slot->data.se.slot_number ) );
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001961 status = psa_save_persistent_key( &slot->attr,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001962 (uint8_t*) &data,
1963 sizeof( data ) );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001964 }
1965 else
1966#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1967 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001968 /* Key material is saved in export representation in the slot, so
1969 * just pass the slot buffer for storage. */
1970 status = psa_save_persistent_key( &slot->attr,
1971 slot->data.key.data,
1972 slot->data.key.bytes );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001973 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001974 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001975#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1976
Gilles Peskinecbaff462019-07-12 23:46:04 +02001977#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001978 /* Finish the transaction for a key creation. This does not
1979 * happen when registering an existing key. Detect this case
1980 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001981 * creation of a persistent key in a secure element requires a transaction,
1982 * but registration or volatile key creation doesn't use one). */
Gilles Peskined7729582019-08-05 15:55:54 +02001983 if( driver != NULL &&
1984 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY )
Gilles Peskinecbaff462019-07-12 23:46:04 +02001985 {
1986 status = psa_save_se_persistent_data( driver );
1987 if( status != PSA_SUCCESS )
1988 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001989 psa_destroy_persistent_key( slot->attr.id );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001990 return( status );
1991 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001992 status = psa_crypto_stop_transaction( );
1993 if( status != PSA_SUCCESS )
1994 return( status );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001995 }
1996#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1997
Gilles Peskine4747d192019-04-17 15:05:45 +02001998 return( status );
1999}
2000
2001/** Abort the creation of a key.
2002 *
2003 * You may call this function after calling psa_start_key_creation(),
2004 * or after psa_finish_key_creation() fails. In other circumstances, this
2005 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02002006 * See the documentation of psa_start_key_creation() for the intended use
2007 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02002008 *
Gilles Peskine011e4282019-06-26 18:34:38 +02002009 * \param[in,out] slot Pointer to the slot with key material.
2010 * \param[in] driver The secure element driver for the key,
2011 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02002012 */
Gilles Peskine011e4282019-06-26 18:34:38 +02002013static void psa_fail_key_creation( psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002014 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02002015{
Gilles Peskine011e4282019-06-26 18:34:38 +02002016 (void) driver;
2017
Gilles Peskine4747d192019-04-17 15:05:45 +02002018 if( slot == NULL )
2019 return;
Gilles Peskine011e4282019-06-26 18:34:38 +02002020
2021#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01002022 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02002023 * element, and the failure happened later (when saving metadata
2024 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02002025 * element.
2026 * https://github.com/ARMmbed/mbed-crypto/issues/217
2027 */
Gilles Peskinefc762652019-07-22 19:30:34 +02002028
Gilles Peskined7729582019-08-05 15:55:54 +02002029 /* Abort the ongoing transaction if any (there may not be one if
2030 * the creation process failed before starting one, or if the
2031 * key creation is a registration of a key in a secure element).
2032 * Earlier functions must already have done what it takes to undo any
2033 * partial creation. All that's left is to update the transaction data
2034 * itself. */
Gilles Peskinefc762652019-07-22 19:30:34 +02002035 (void) psa_crypto_stop_transaction( );
Gilles Peskine011e4282019-06-26 18:34:38 +02002036#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2037
Gilles Peskine4747d192019-04-17 15:05:45 +02002038 psa_wipe_key_slot( slot );
2039}
2040
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002041/** Validate optional attributes during key creation.
2042 *
2043 * Some key attributes are optional during key creation. If they are
2044 * specified in the attributes structure, check that they are consistent
2045 * with the data in the slot.
2046 *
2047 * This function should be called near the end of key creation, after
2048 * the slot in memory is fully populated but before saving persistent data.
2049 */
2050static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002051 const psa_key_slot_t *slot,
2052 const psa_key_attributes_t *attributes )
2053{
Gilles Peskine7e0cff92019-07-30 13:48:52 +02002054 if( attributes->core.type != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002055 {
Gilles Peskine8e338702019-07-30 20:06:31 +02002056 if( attributes->core.type != slot->attr.type )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002057 return( PSA_ERROR_INVALID_ARGUMENT );
2058 }
2059
2060 if( attributes->domain_parameters_size != 0 )
2061 {
2062#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02002063 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002064 {
Steven Cooremana2371e52020-07-28 14:30:39 +02002065 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02002066 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02002067 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02002068
Steven Cooreman7f391872020-07-30 14:57:44 +02002069 psa_status_t status = psa_load_rsa_representation(
Steven Cooreman4fed4552020-08-03 14:46:03 +02002070 slot->attr.type,
Steven Cooreman7f391872020-07-30 14:57:44 +02002071 slot->data.key.data,
2072 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02002073 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02002074 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02002075 return( status );
Steven Cooreman75b74362020-07-28 14:30:13 +02002076
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002077 mbedtls_mpi_init( &actual );
2078 mbedtls_mpi_init( &required );
Steven Cooremana2371e52020-07-28 14:30:39 +02002079 ret = mbedtls_rsa_export( rsa,
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002080 NULL, NULL, NULL, NULL, &actual );
Steven Cooremana2371e52020-07-28 14:30:39 +02002081 mbedtls_rsa_free( rsa );
2082 mbedtls_free( rsa );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002083 if( ret != 0 )
2084 goto rsa_exit;
2085 ret = mbedtls_mpi_read_binary( &required,
2086 attributes->domain_parameters,
2087 attributes->domain_parameters_size );
2088 if( ret != 0 )
2089 goto rsa_exit;
2090 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
2091 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
2092 rsa_exit:
2093 mbedtls_mpi_free( &actual );
2094 mbedtls_mpi_free( &required );
2095 if( ret != 0)
2096 return( mbedtls_to_psa_error( ret ) );
2097 }
2098 else
2099#endif
2100 {
2101 return( PSA_ERROR_INVALID_ARGUMENT );
2102 }
2103 }
2104
Gilles Peskine7e0cff92019-07-30 13:48:52 +02002105 if( attributes->core.bits != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002106 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02002107 if( attributes->core.bits != slot->attr.bits )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002108 return( PSA_ERROR_INVALID_ARGUMENT );
2109 }
2110
2111 return( PSA_SUCCESS );
2112}
2113
Gilles Peskine4747d192019-04-17 15:05:45 +02002114psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02002115 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02002116 size_t data_length,
2117 psa_key_handle_t *handle )
Gilles Peskine4747d192019-04-17 15:05:45 +02002118{
2119 psa_status_t status;
2120 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002121 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002122
Gilles Peskine0f84d622019-09-12 19:03:13 +02002123 /* Reject zero-length symmetric keys (including raw data key objects).
2124 * This also rejects any key which might be encoded as an empty string,
2125 * which is never valid. */
2126 if( data_length == 0 )
2127 return( PSA_ERROR_INVALID_ARGUMENT );
2128
Gilles Peskinedf179142019-07-15 22:02:14 +02002129 status = psa_start_key_creation( PSA_KEY_CREATION_IMPORT, attributes,
2130 handle, &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002131 if( status != PSA_SUCCESS )
2132 goto exit;
2133
Gilles Peskine5d309672019-07-12 23:47:28 +02002134#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2135 if( driver != NULL )
2136 {
2137 const psa_drv_se_t *drv = psa_get_se_driver_methods( driver );
Darryl Green0892d0f2019-08-20 09:50:14 +01002138 /* The driver should set the number of key bits, however in
2139 * case it doesn't, we initialize bits to an invalid value. */
2140 size_t bits = PSA_MAX_KEY_BITS + 1;
Gilles Peskine5d309672019-07-12 23:47:28 +02002141 if( drv->key_management == NULL ||
2142 drv->key_management->p_import == NULL )
2143 {
2144 status = PSA_ERROR_NOT_SUPPORTED;
2145 goto exit;
2146 }
2147 status = drv->key_management->p_import(
2148 psa_get_se_driver_context( driver ),
Gilles Peskinef3801ff2019-08-06 17:32:04 +02002149 slot->data.se.slot_number, attributes, data, data_length,
Gilles Peskineb46bef22019-07-30 21:32:04 +02002150 &bits );
2151 if( status != PSA_SUCCESS )
2152 goto exit;
2153 if( bits > PSA_MAX_KEY_BITS )
2154 {
2155 status = PSA_ERROR_NOT_SUPPORTED;
2156 goto exit;
2157 }
2158 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskine5d309672019-07-12 23:47:28 +02002159 }
2160 else
2161#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2162 {
2163 status = psa_import_key_into_slot( slot, data, data_length );
2164 if( status != PSA_SUCCESS )
2165 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02002166 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002167 status = psa_validate_optional_attributes( slot, attributes );
Gilles Peskine18017402019-07-24 20:25:59 +02002168 if( status != PSA_SUCCESS )
2169 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002170
Gilles Peskine011e4282019-06-26 18:34:38 +02002171 status = psa_finish_key_creation( slot, driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002172exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02002173 if( status != PSA_SUCCESS )
2174 {
Gilles Peskine011e4282019-06-26 18:34:38 +02002175 psa_fail_key_creation( slot, driver );
Gilles Peskine4747d192019-04-17 15:05:45 +02002176 *handle = 0;
2177 }
2178 return( status );
2179}
2180
Gilles Peskined7729582019-08-05 15:55:54 +02002181#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2182psa_status_t mbedtls_psa_register_se_key(
2183 const psa_key_attributes_t *attributes )
2184{
2185 psa_status_t status;
2186 psa_key_slot_t *slot = NULL;
2187 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskined7729582019-08-05 15:55:54 +02002188 psa_key_handle_t handle = 0;
2189
2190 /* Leaving attributes unspecified is not currently supported.
2191 * It could make sense to query the key type and size from the
2192 * secure element, but not all secure elements support this
2193 * and the driver HAL doesn't currently support it. */
2194 if( psa_get_key_type( attributes ) == PSA_KEY_TYPE_NONE )
2195 return( PSA_ERROR_NOT_SUPPORTED );
2196 if( psa_get_key_bits( attributes ) == 0 )
2197 return( PSA_ERROR_NOT_SUPPORTED );
2198
2199 status = psa_start_key_creation( PSA_KEY_CREATION_REGISTER, attributes,
2200 &handle, &slot, &driver );
2201 if( status != PSA_SUCCESS )
2202 goto exit;
2203
Gilles Peskined7729582019-08-05 15:55:54 +02002204 status = psa_finish_key_creation( slot, driver );
2205
2206exit:
2207 if( status != PSA_SUCCESS )
2208 {
2209 psa_fail_key_creation( slot, driver );
2210 }
2211 /* Registration doesn't keep the key in RAM. */
2212 psa_close_key( handle );
2213 return( status );
2214}
2215#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2216
Gilles Peskinef603c712019-01-19 13:40:11 +01002217static psa_status_t psa_copy_key_material( const psa_key_slot_t *source,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002218 psa_key_slot_t *target )
Gilles Peskinef603c712019-01-19 13:40:11 +01002219{
Steven Cooremanf7cebd42020-10-13 20:27:40 +02002220 psa_status_t status = psa_copy_key_material_into_slot( target,
2221 source->data.key.data,
2222 source->data.key.bytes );
Gilles Peskinef603c712019-01-19 13:40:11 +01002223 if( status != PSA_SUCCESS )
Steven Cooreman398aee52020-10-13 14:35:45 +02002224 return( status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002225
Steven Cooreman398aee52020-10-13 14:35:45 +02002226 target->attr.type = source->attr.type;
2227 target->attr.bits = source->attr.bits;
2228
2229 return( PSA_SUCCESS );
Gilles Peskinef603c712019-01-19 13:40:11 +01002230}
2231
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002232psa_status_t psa_copy_key( psa_key_handle_t source_handle,
2233 const psa_key_attributes_t *specified_attributes,
2234 psa_key_handle_t *target_handle )
Gilles Peskinef603c712019-01-19 13:40:11 +01002235{
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002236 psa_status_t status;
Gilles Peskinef603c712019-01-19 13:40:11 +01002237 psa_key_slot_t *source_slot = NULL;
2238 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002239 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002240 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskinef603c712019-01-19 13:40:11 +01002241
Gilles Peskine28f8f302019-07-24 13:30:31 +02002242 status = psa_get_transparent_key( source_handle, &source_slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02002243 PSA_KEY_USAGE_COPY, 0 );
Gilles Peskinef603c712019-01-19 13:40:11 +01002244 if( status != PSA_SUCCESS )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002245 goto exit;
2246
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002247 status = psa_validate_optional_attributes( source_slot,
2248 specified_attributes );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002249 if( status != PSA_SUCCESS )
2250 goto exit;
2251
Gilles Peskine7e0cff92019-07-30 13:48:52 +02002252 status = psa_restrict_key_policy( &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02002253 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002254 if( status != PSA_SUCCESS )
2255 goto exit;
2256
Gilles Peskinedf179142019-07-15 22:02:14 +02002257 status = psa_start_key_creation( PSA_KEY_CREATION_COPY,
2258 &actual_attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02002259 target_handle, &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002260 if( status != PSA_SUCCESS )
2261 goto exit;
2262
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002263#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2264 if( driver != NULL )
Gilles Peskinef603c712019-01-19 13:40:11 +01002265 {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002266 /* Copying to a secure element is not implemented yet. */
2267 status = PSA_ERROR_NOT_SUPPORTED;
2268 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002269 }
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002270#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef603c712019-01-19 13:40:11 +01002271
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002272 status = psa_copy_key_material( source_slot, target_slot );
Gilles Peskinef603c712019-01-19 13:40:11 +01002273 if( status != PSA_SUCCESS )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002274 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002275
Gilles Peskine011e4282019-06-26 18:34:38 +02002276 status = psa_finish_key_creation( target_slot, driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002277exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002278 if( status != PSA_SUCCESS )
2279 {
Gilles Peskine011e4282019-06-26 18:34:38 +02002280 psa_fail_key_creation( target_slot, driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002281 *target_handle = 0;
2282 }
2283 return( status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002284}
2285
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002286
2287
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002288/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002289/* Message digests */
2290/****************************************************************/
2291
John Durkop0ea39e02020-10-13 19:58:20 -07002292#if defined(MBEDTLS_RSA_C) || defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinedc2fc842018-03-07 16:42:59 +01002293static const mbedtls_md_info_t *mbedtls_md_info_from_psa( psa_algorithm_t alg )
Gilles Peskine20035e32018-02-03 22:44:14 +01002294{
2295 switch( alg )
2296 {
2297#if defined(MBEDTLS_MD2_C)
2298 case PSA_ALG_MD2:
2299 return( &mbedtls_md2_info );
2300#endif
2301#if defined(MBEDTLS_MD4_C)
2302 case PSA_ALG_MD4:
2303 return( &mbedtls_md4_info );
2304#endif
2305#if defined(MBEDTLS_MD5_C)
2306 case PSA_ALG_MD5:
2307 return( &mbedtls_md5_info );
2308#endif
2309#if defined(MBEDTLS_RIPEMD160_C)
2310 case PSA_ALG_RIPEMD160:
2311 return( &mbedtls_ripemd160_info );
2312#endif
2313#if defined(MBEDTLS_SHA1_C)
2314 case PSA_ALG_SHA_1:
2315 return( &mbedtls_sha1_info );
2316#endif
2317#if defined(MBEDTLS_SHA256_C)
2318 case PSA_ALG_SHA_224:
2319 return( &mbedtls_sha224_info );
2320 case PSA_ALG_SHA_256:
2321 return( &mbedtls_sha256_info );
2322#endif
2323#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnardd6020842019-07-17 16:28:21 +02002324#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine20035e32018-02-03 22:44:14 +01002325 case PSA_ALG_SHA_384:
2326 return( &mbedtls_sha384_info );
Manuel Pégourié-Gonnardd6020842019-07-17 16:28:21 +02002327#endif
Gilles Peskine20035e32018-02-03 22:44:14 +01002328 case PSA_ALG_SHA_512:
2329 return( &mbedtls_sha512_info );
2330#endif
2331 default:
2332 return( NULL );
2333 }
2334}
John Durkop0ea39e02020-10-13 19:58:20 -07002335#endif /* defined(MBEDTLS_RSA_C) || defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine20035e32018-02-03 22:44:14 +01002336
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002337psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
2338{
2339 switch( operation->alg )
2340 {
Gilles Peskine81736312018-06-26 15:04:31 +02002341 case 0:
2342 /* The object has (apparently) been initialized but it is not
2343 * in use. It's ok to call abort on such an object, and there's
2344 * nothing to do. */
2345 break;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002346#if defined(MBEDTLS_MD2_C)
2347 case PSA_ALG_MD2:
2348 mbedtls_md2_free( &operation->ctx.md2 );
2349 break;
2350#endif
2351#if defined(MBEDTLS_MD4_C)
2352 case PSA_ALG_MD4:
2353 mbedtls_md4_free( &operation->ctx.md4 );
2354 break;
2355#endif
2356#if defined(MBEDTLS_MD5_C)
2357 case PSA_ALG_MD5:
2358 mbedtls_md5_free( &operation->ctx.md5 );
2359 break;
2360#endif
2361#if defined(MBEDTLS_RIPEMD160_C)
2362 case PSA_ALG_RIPEMD160:
2363 mbedtls_ripemd160_free( &operation->ctx.ripemd160 );
2364 break;
2365#endif
2366#if defined(MBEDTLS_SHA1_C)
2367 case PSA_ALG_SHA_1:
2368 mbedtls_sha1_free( &operation->ctx.sha1 );
2369 break;
2370#endif
2371#if defined(MBEDTLS_SHA256_C)
2372 case PSA_ALG_SHA_224:
2373 case PSA_ALG_SHA_256:
2374 mbedtls_sha256_free( &operation->ctx.sha256 );
2375 break;
2376#endif
2377#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002378#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002379 case PSA_ALG_SHA_384:
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002380#endif
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002381 case PSA_ALG_SHA_512:
2382 mbedtls_sha512_free( &operation->ctx.sha512 );
2383 break;
2384#endif
2385 default:
Gilles Peskinef9c2c092018-06-21 16:57:07 +02002386 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002387 }
2388 operation->alg = 0;
2389 return( PSA_SUCCESS );
2390}
2391
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002392psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002393 psa_algorithm_t alg )
2394{
Janos Follath24eed8d2019-11-22 13:21:35 +00002395 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002396
2397 /* A context must be freshly initialized before it can be set up. */
2398 if( operation->alg != 0 )
2399 {
2400 return( PSA_ERROR_BAD_STATE );
2401 }
2402
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002403 switch( alg )
2404 {
2405#if defined(MBEDTLS_MD2_C)
2406 case PSA_ALG_MD2:
2407 mbedtls_md2_init( &operation->ctx.md2 );
2408 ret = mbedtls_md2_starts_ret( &operation->ctx.md2 );
2409 break;
2410#endif
2411#if defined(MBEDTLS_MD4_C)
2412 case PSA_ALG_MD4:
2413 mbedtls_md4_init( &operation->ctx.md4 );
2414 ret = mbedtls_md4_starts_ret( &operation->ctx.md4 );
2415 break;
2416#endif
2417#if defined(MBEDTLS_MD5_C)
2418 case PSA_ALG_MD5:
2419 mbedtls_md5_init( &operation->ctx.md5 );
2420 ret = mbedtls_md5_starts_ret( &operation->ctx.md5 );
2421 break;
2422#endif
2423#if defined(MBEDTLS_RIPEMD160_C)
2424 case PSA_ALG_RIPEMD160:
2425 mbedtls_ripemd160_init( &operation->ctx.ripemd160 );
2426 ret = mbedtls_ripemd160_starts_ret( &operation->ctx.ripemd160 );
2427 break;
2428#endif
2429#if defined(MBEDTLS_SHA1_C)
2430 case PSA_ALG_SHA_1:
2431 mbedtls_sha1_init( &operation->ctx.sha1 );
2432 ret = mbedtls_sha1_starts_ret( &operation->ctx.sha1 );
2433 break;
2434#endif
2435#if defined(MBEDTLS_SHA256_C)
2436 case PSA_ALG_SHA_224:
2437 mbedtls_sha256_init( &operation->ctx.sha256 );
2438 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 1 );
2439 break;
2440 case PSA_ALG_SHA_256:
2441 mbedtls_sha256_init( &operation->ctx.sha256 );
2442 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 0 );
2443 break;
2444#endif
2445#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002446#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002447 case PSA_ALG_SHA_384:
2448 mbedtls_sha512_init( &operation->ctx.sha512 );
2449 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 1 );
2450 break;
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002451#endif
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002452 case PSA_ALG_SHA_512:
2453 mbedtls_sha512_init( &operation->ctx.sha512 );
2454 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 0 );
2455 break;
2456#endif
2457 default:
Gilles Peskinec06e0712018-06-20 16:21:04 +02002458 return( PSA_ALG_IS_HASH( alg ) ?
2459 PSA_ERROR_NOT_SUPPORTED :
2460 PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002461 }
2462 if( ret == 0 )
2463 operation->alg = alg;
2464 else
2465 psa_hash_abort( operation );
2466 return( mbedtls_to_psa_error( ret ) );
2467}
2468
2469psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2470 const uint8_t *input,
2471 size_t input_length )
2472{
Janos Follath24eed8d2019-11-22 13:21:35 +00002473 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine94e44542018-07-12 16:58:43 +02002474
2475 /* Don't require hash implementations to behave correctly on a
2476 * zero-length input, which may have an invalid pointer. */
2477 if( input_length == 0 )
2478 return( PSA_SUCCESS );
2479
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002480 switch( operation->alg )
2481 {
2482#if defined(MBEDTLS_MD2_C)
2483 case PSA_ALG_MD2:
2484 ret = mbedtls_md2_update_ret( &operation->ctx.md2,
2485 input, input_length );
2486 break;
2487#endif
2488#if defined(MBEDTLS_MD4_C)
2489 case PSA_ALG_MD4:
2490 ret = mbedtls_md4_update_ret( &operation->ctx.md4,
2491 input, input_length );
2492 break;
2493#endif
2494#if defined(MBEDTLS_MD5_C)
2495 case PSA_ALG_MD5:
2496 ret = mbedtls_md5_update_ret( &operation->ctx.md5,
2497 input, input_length );
2498 break;
2499#endif
2500#if defined(MBEDTLS_RIPEMD160_C)
2501 case PSA_ALG_RIPEMD160:
2502 ret = mbedtls_ripemd160_update_ret( &operation->ctx.ripemd160,
2503 input, input_length );
2504 break;
2505#endif
2506#if defined(MBEDTLS_SHA1_C)
2507 case PSA_ALG_SHA_1:
2508 ret = mbedtls_sha1_update_ret( &operation->ctx.sha1,
2509 input, input_length );
2510 break;
2511#endif
2512#if defined(MBEDTLS_SHA256_C)
2513 case PSA_ALG_SHA_224:
2514 case PSA_ALG_SHA_256:
2515 ret = mbedtls_sha256_update_ret( &operation->ctx.sha256,
2516 input, input_length );
2517 break;
2518#endif
2519#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002520#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002521 case PSA_ALG_SHA_384:
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002522#endif
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002523 case PSA_ALG_SHA_512:
2524 ret = mbedtls_sha512_update_ret( &operation->ctx.sha512,
2525 input, input_length );
2526 break;
2527#endif
2528 default:
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002529 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002530 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002531
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002532 if( ret != 0 )
2533 psa_hash_abort( operation );
2534 return( mbedtls_to_psa_error( ret ) );
2535}
2536
2537psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2538 uint8_t *hash,
2539 size_t hash_size,
2540 size_t *hash_length )
2541{
itayzafrir40835d42018-08-02 13:14:17 +03002542 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00002543 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine71bb7b72018-04-19 08:29:59 +02002544 size_t actual_hash_length = PSA_HASH_SIZE( operation->alg );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002545
2546 /* Fill the output buffer with something that isn't a valid hash
2547 * (barring an attack on the hash and deliberately-crafted input),
2548 * in case the caller doesn't check the return status properly. */
Gilles Peskineaee13332018-07-02 12:15:28 +02002549 *hash_length = hash_size;
Gilles Peskine46f1fd72018-06-28 19:31:31 +02002550 /* If hash_size is 0 then hash may be NULL and then the
2551 * call to memset would have undefined behavior. */
2552 if( hash_size != 0 )
2553 memset( hash, '!', hash_size );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002554
2555 if( hash_size < actual_hash_length )
itayzafrir40835d42018-08-02 13:14:17 +03002556 {
2557 status = PSA_ERROR_BUFFER_TOO_SMALL;
2558 goto exit;
2559 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002560
2561 switch( operation->alg )
2562 {
2563#if defined(MBEDTLS_MD2_C)
2564 case PSA_ALG_MD2:
2565 ret = mbedtls_md2_finish_ret( &operation->ctx.md2, hash );
2566 break;
2567#endif
2568#if defined(MBEDTLS_MD4_C)
2569 case PSA_ALG_MD4:
2570 ret = mbedtls_md4_finish_ret( &operation->ctx.md4, hash );
2571 break;
2572#endif
2573#if defined(MBEDTLS_MD5_C)
2574 case PSA_ALG_MD5:
2575 ret = mbedtls_md5_finish_ret( &operation->ctx.md5, hash );
2576 break;
2577#endif
2578#if defined(MBEDTLS_RIPEMD160_C)
2579 case PSA_ALG_RIPEMD160:
2580 ret = mbedtls_ripemd160_finish_ret( &operation->ctx.ripemd160, hash );
2581 break;
2582#endif
2583#if defined(MBEDTLS_SHA1_C)
2584 case PSA_ALG_SHA_1:
2585 ret = mbedtls_sha1_finish_ret( &operation->ctx.sha1, hash );
2586 break;
2587#endif
2588#if defined(MBEDTLS_SHA256_C)
2589 case PSA_ALG_SHA_224:
2590 case PSA_ALG_SHA_256:
2591 ret = mbedtls_sha256_finish_ret( &operation->ctx.sha256, hash );
2592 break;
2593#endif
2594#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002595#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002596 case PSA_ALG_SHA_384:
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002597#endif
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002598 case PSA_ALG_SHA_512:
2599 ret = mbedtls_sha512_finish_ret( &operation->ctx.sha512, hash );
2600 break;
2601#endif
2602 default:
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002603 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002604 }
itayzafrir40835d42018-08-02 13:14:17 +03002605 status = mbedtls_to_psa_error( ret );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002606
itayzafrir40835d42018-08-02 13:14:17 +03002607exit:
2608 if( status == PSA_SUCCESS )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002609 {
Gilles Peskineaee13332018-07-02 12:15:28 +02002610 *hash_length = actual_hash_length;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002611 return( psa_hash_abort( operation ) );
2612 }
2613 else
2614 {
2615 psa_hash_abort( operation );
itayzafrir40835d42018-08-02 13:14:17 +03002616 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002617 }
2618}
2619
Gilles Peskine2d277862018-06-18 15:41:12 +02002620psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2621 const uint8_t *hash,
2622 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002623{
2624 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2625 size_t actual_hash_length;
2626 psa_status_t status = psa_hash_finish( operation,
2627 actual_hash, sizeof( actual_hash ),
2628 &actual_hash_length );
2629 if( status != PSA_SUCCESS )
2630 return( status );
2631 if( actual_hash_length != hash_length )
2632 return( PSA_ERROR_INVALID_SIGNATURE );
2633 if( safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
2634 return( PSA_ERROR_INVALID_SIGNATURE );
2635 return( PSA_SUCCESS );
2636}
2637
Gilles Peskine0a749c82019-11-28 19:33:58 +01002638psa_status_t psa_hash_compute( psa_algorithm_t alg,
2639 const uint8_t *input, size_t input_length,
2640 uint8_t *hash, size_t hash_size,
2641 size_t *hash_length )
2642{
2643 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
2644 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2645
2646 *hash_length = hash_size;
2647 status = psa_hash_setup( &operation, alg );
2648 if( status != PSA_SUCCESS )
2649 goto exit;
2650 status = psa_hash_update( &operation, input, input_length );
2651 if( status != PSA_SUCCESS )
2652 goto exit;
2653 status = psa_hash_finish( &operation, hash, hash_size, hash_length );
2654 if( status != PSA_SUCCESS )
2655 goto exit;
2656
2657exit:
2658 if( status == PSA_SUCCESS )
2659 status = psa_hash_abort( &operation );
2660 else
2661 psa_hash_abort( &operation );
2662 return( status );
2663}
2664
2665psa_status_t psa_hash_compare( psa_algorithm_t alg,
2666 const uint8_t *input, size_t input_length,
2667 const uint8_t *hash, size_t hash_length )
2668{
2669 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
2670 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2671
2672 status = psa_hash_setup( &operation, alg );
2673 if( status != PSA_SUCCESS )
2674 goto exit;
2675 status = psa_hash_update( &operation, input, input_length );
2676 if( status != PSA_SUCCESS )
2677 goto exit;
2678 status = psa_hash_verify( &operation, hash, hash_length );
2679 if( status != PSA_SUCCESS )
2680 goto exit;
2681
2682exit:
2683 if( status == PSA_SUCCESS )
2684 status = psa_hash_abort( &operation );
2685 else
2686 psa_hash_abort( &operation );
2687 return( status );
2688}
2689
Gilles Peskineeb35d782019-01-22 17:56:16 +01002690psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2691 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002692{
2693 if( target_operation->alg != 0 )
2694 return( PSA_ERROR_BAD_STATE );
2695
2696 switch( source_operation->alg )
2697 {
2698 case 0:
2699 return( PSA_ERROR_BAD_STATE );
2700#if defined(MBEDTLS_MD2_C)
2701 case PSA_ALG_MD2:
2702 mbedtls_md2_clone( &target_operation->ctx.md2,
2703 &source_operation->ctx.md2 );
2704 break;
2705#endif
2706#if defined(MBEDTLS_MD4_C)
2707 case PSA_ALG_MD4:
2708 mbedtls_md4_clone( &target_operation->ctx.md4,
2709 &source_operation->ctx.md4 );
2710 break;
2711#endif
2712#if defined(MBEDTLS_MD5_C)
2713 case PSA_ALG_MD5:
2714 mbedtls_md5_clone( &target_operation->ctx.md5,
2715 &source_operation->ctx.md5 );
2716 break;
2717#endif
2718#if defined(MBEDTLS_RIPEMD160_C)
2719 case PSA_ALG_RIPEMD160:
2720 mbedtls_ripemd160_clone( &target_operation->ctx.ripemd160,
2721 &source_operation->ctx.ripemd160 );
2722 break;
2723#endif
2724#if defined(MBEDTLS_SHA1_C)
2725 case PSA_ALG_SHA_1:
2726 mbedtls_sha1_clone( &target_operation->ctx.sha1,
2727 &source_operation->ctx.sha1 );
2728 break;
2729#endif
2730#if defined(MBEDTLS_SHA256_C)
2731 case PSA_ALG_SHA_224:
2732 case PSA_ALG_SHA_256:
2733 mbedtls_sha256_clone( &target_operation->ctx.sha256,
2734 &source_operation->ctx.sha256 );
2735 break;
2736#endif
2737#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002738#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002739 case PSA_ALG_SHA_384:
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002740#endif
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002741 case PSA_ALG_SHA_512:
2742 mbedtls_sha512_clone( &target_operation->ctx.sha512,
2743 &source_operation->ctx.sha512 );
2744 break;
2745#endif
2746 default:
2747 return( PSA_ERROR_NOT_SUPPORTED );
2748 }
2749
2750 target_operation->alg = source_operation->alg;
2751 return( PSA_SUCCESS );
2752}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002753
2754
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002755/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002756/* MAC */
2757/****************************************************************/
2758
Gilles Peskinedc2fc842018-03-07 16:42:59 +01002759static const mbedtls_cipher_info_t *mbedtls_cipher_info_from_psa(
Gilles Peskine8c9def32018-02-08 10:02:12 +01002760 psa_algorithm_t alg,
2761 psa_key_type_t key_type,
Gilles Peskine2d277862018-06-18 15:41:12 +02002762 size_t key_bits,
mohammad1603f4f0d612018-06-03 15:04:51 +03002763 mbedtls_cipher_id_t* cipher_id )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002764{
Gilles Peskine8c9def32018-02-08 10:02:12 +01002765 mbedtls_cipher_mode_t mode;
mohammad1603f4f0d612018-06-03 15:04:51 +03002766 mbedtls_cipher_id_t cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002767
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002768 if( PSA_ALG_IS_AEAD( alg ) )
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002769 alg = PSA_ALG_AEAD_WITH_TAG_LENGTH( alg, 0 );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002770
Gilles Peskine8c9def32018-02-08 10:02:12 +01002771 if( PSA_ALG_IS_CIPHER( alg ) || PSA_ALG_IS_AEAD( alg ) )
2772 {
Nir Sonnenscheine9664c32018-06-17 14:41:30 +03002773 switch( alg )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002774 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002775 case PSA_ALG_ARC4:
Gilles Peskine26869f22019-05-06 15:25:00 +02002776 case PSA_ALG_CHACHA20:
Gilles Peskine8c9def32018-02-08 10:02:12 +01002777 mode = MBEDTLS_MODE_STREAM;
2778 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002779 case PSA_ALG_CTR:
2780 mode = MBEDTLS_MODE_CTR;
2781 break;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002782 case PSA_ALG_CFB:
2783 mode = MBEDTLS_MODE_CFB;
2784 break;
2785 case PSA_ALG_OFB:
2786 mode = MBEDTLS_MODE_OFB;
2787 break;
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02002788 case PSA_ALG_ECB_NO_PADDING:
2789 mode = MBEDTLS_MODE_ECB;
2790 break;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002791 case PSA_ALG_CBC_NO_PADDING:
2792 mode = MBEDTLS_MODE_CBC;
2793 break;
2794 case PSA_ALG_CBC_PKCS7:
2795 mode = MBEDTLS_MODE_CBC;
2796 break;
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002797 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002798 mode = MBEDTLS_MODE_CCM;
2799 break;
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002800 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_GCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002801 mode = MBEDTLS_MODE_GCM;
2802 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02002803 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CHACHA20_POLY1305, 0 ):
2804 mode = MBEDTLS_MODE_CHACHAPOLY;
2805 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002806 default:
2807 return( NULL );
2808 }
2809 }
2810 else if( alg == PSA_ALG_CMAC )
2811 mode = MBEDTLS_MODE_ECB;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002812 else
2813 return( NULL );
2814
2815 switch( key_type )
2816 {
2817 case PSA_KEY_TYPE_AES:
mohammad1603f4f0d612018-06-03 15:04:51 +03002818 cipher_id_tmp = MBEDTLS_CIPHER_ID_AES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002819 break;
2820 case PSA_KEY_TYPE_DES:
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002821 /* key_bits is 64 for Single-DES, 128 for two-key Triple-DES,
2822 * and 192 for three-key Triple-DES. */
Gilles Peskine8c9def32018-02-08 10:02:12 +01002823 if( key_bits == 64 )
mohammad1603f4f0d612018-06-03 15:04:51 +03002824 cipher_id_tmp = MBEDTLS_CIPHER_ID_DES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002825 else
mohammad1603f4f0d612018-06-03 15:04:51 +03002826 cipher_id_tmp = MBEDTLS_CIPHER_ID_3DES;
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002827 /* mbedtls doesn't recognize two-key Triple-DES as an algorithm,
2828 * but two-key Triple-DES is functionally three-key Triple-DES
2829 * with K1=K3, so that's how we present it to mbedtls. */
2830 if( key_bits == 128 )
2831 key_bits = 192;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002832 break;
2833 case PSA_KEY_TYPE_CAMELLIA:
mohammad1603f4f0d612018-06-03 15:04:51 +03002834 cipher_id_tmp = MBEDTLS_CIPHER_ID_CAMELLIA;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002835 break;
2836 case PSA_KEY_TYPE_ARC4:
mohammad1603f4f0d612018-06-03 15:04:51 +03002837 cipher_id_tmp = MBEDTLS_CIPHER_ID_ARC4;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002838 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02002839 case PSA_KEY_TYPE_CHACHA20:
2840 cipher_id_tmp = MBEDTLS_CIPHER_ID_CHACHA20;
2841 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002842 default:
2843 return( NULL );
2844 }
mohammad1603f4f0d612018-06-03 15:04:51 +03002845 if( cipher_id != NULL )
mohammad160360a64d02018-06-03 17:20:42 +03002846 *cipher_id = cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002847
Jaeden Amero23bbb752018-06-26 14:16:54 +01002848 return( mbedtls_cipher_info_from_values( cipher_id_tmp,
2849 (int) key_bits, mode ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002850}
2851
Gilles Peskinea05219c2018-11-16 16:02:56 +01002852#if defined(MBEDTLS_MD_C)
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002853static size_t psa_get_hash_block_size( psa_algorithm_t alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002854{
Gilles Peskine2d277862018-06-18 15:41:12 +02002855 switch( alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002856 {
2857 case PSA_ALG_MD2:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002858 return( 16 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002859 case PSA_ALG_MD4:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002860 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002861 case PSA_ALG_MD5:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002862 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002863 case PSA_ALG_RIPEMD160:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002864 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002865 case PSA_ALG_SHA_1:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002866 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002867 case PSA_ALG_SHA_224:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002868 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002869 case PSA_ALG_SHA_256:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002870 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002871 case PSA_ALG_SHA_384:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002872 return( 128 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002873 case PSA_ALG_SHA_512:
Gilles Peskine2d277862018-06-18 15:41:12 +02002874 return( 128 );
2875 default:
2876 return( 0 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002877 }
2878}
Gilles Peskinea05219c2018-11-16 16:02:56 +01002879#endif /* MBEDTLS_MD_C */
Nir Sonnenschein0c9ec532018-06-07 13:27:47 +03002880
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002881/* Initialize the MAC operation structure. Once this function has been
2882 * called, psa_mac_abort can run and will do the right thing. */
2883static psa_status_t psa_mac_init( psa_mac_operation_t *operation,
2884 psa_algorithm_t alg )
2885{
2886 psa_status_t status = PSA_ERROR_NOT_SUPPORTED;
2887
2888 operation->alg = alg;
2889 operation->key_set = 0;
2890 operation->iv_set = 0;
2891 operation->iv_required = 0;
2892 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002893 operation->is_sign = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002894
2895#if defined(MBEDTLS_CMAC_C)
2896 if( alg == PSA_ALG_CMAC )
2897 {
2898 operation->iv_required = 0;
2899 mbedtls_cipher_init( &operation->ctx.cmac );
2900 status = PSA_SUCCESS;
2901 }
2902 else
2903#endif /* MBEDTLS_CMAC_C */
2904#if defined(MBEDTLS_MD_C)
2905 if( PSA_ALG_IS_HMAC( operation->alg ) )
2906 {
Gilles Peskineff94abd2018-07-12 17:07:52 +02002907 /* We'll set up the hash operation later in psa_hmac_setup_internal. */
2908 operation->ctx.hmac.hash_ctx.alg = 0;
2909 status = PSA_SUCCESS;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002910 }
2911 else
2912#endif /* MBEDTLS_MD_C */
2913 {
Gilles Peskinec06e0712018-06-20 16:21:04 +02002914 if( ! PSA_ALG_IS_MAC( alg ) )
2915 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002916 }
2917
2918 if( status != PSA_SUCCESS )
2919 memset( operation, 0, sizeof( *operation ) );
2920 return( status );
2921}
2922
Gilles Peskine01126fa2018-07-12 17:04:55 +02002923#if defined(MBEDTLS_MD_C)
2924static psa_status_t psa_hmac_abort_internal( psa_hmac_internal_data *hmac )
2925{
Gilles Peskine3f108122018-12-07 18:14:53 +01002926 mbedtls_platform_zeroize( hmac->opad, sizeof( hmac->opad ) );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002927 return( psa_hash_abort( &hmac->hash_ctx ) );
2928}
2929#endif /* MBEDTLS_MD_C */
2930
Gilles Peskine8c9def32018-02-08 10:02:12 +01002931psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
2932{
Gilles Peskinefbfac682018-07-08 20:51:54 +02002933 if( operation->alg == 0 )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002934 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02002935 /* The object has (apparently) been initialized but it is not
2936 * in use. It's ok to call abort on such an object, and there's
2937 * nothing to do. */
2938 return( PSA_SUCCESS );
2939 }
2940 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002941#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002942 if( operation->alg == PSA_ALG_CMAC )
2943 {
2944 mbedtls_cipher_free( &operation->ctx.cmac );
2945 }
2946 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002947#endif /* MBEDTLS_CMAC_C */
Gilles Peskine8c9def32018-02-08 10:02:12 +01002948#if defined(MBEDTLS_MD_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002949 if( PSA_ALG_IS_HMAC( operation->alg ) )
2950 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02002951 psa_hmac_abort_internal( &operation->ctx.hmac );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002952 }
2953 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002954#endif /* MBEDTLS_MD_C */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002955 {
2956 /* Sanity check (shouldn't happen: operation->alg should
2957 * always have been initialized to a valid value). */
2958 goto bad_state;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002959 }
Moran Peker41deec42018-04-04 15:43:05 +03002960
Gilles Peskine8c9def32018-02-08 10:02:12 +01002961 operation->alg = 0;
2962 operation->key_set = 0;
2963 operation->iv_set = 0;
2964 operation->iv_required = 0;
2965 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002966 operation->is_sign = 0;
Moran Peker41deec42018-04-04 15:43:05 +03002967
Gilles Peskine8c9def32018-02-08 10:02:12 +01002968 return( PSA_SUCCESS );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002969
2970bad_state:
2971 /* If abort is called on an uninitialized object, we can't trust
2972 * anything. Wipe the object in case it contains confidential data.
2973 * This may result in a memory leak if a pointer gets overwritten,
2974 * but it's too late to do anything about this. */
2975 memset( operation, 0, sizeof( *operation ) );
2976 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002977}
2978
Gilles Peskinee3b07d82018-06-19 11:57:35 +02002979#if defined(MBEDTLS_CMAC_C)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002980static int psa_cmac_setup( psa_mac_operation_t *operation,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002981 size_t key_bits,
Gilles Peskine2f060a82018-12-04 17:12:32 +01002982 psa_key_slot_t *slot,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002983 const mbedtls_cipher_info_t *cipher_info )
2984{
Janos Follath24eed8d2019-11-22 13:21:35 +00002985 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002986
2987 operation->mac_size = cipher_info->block_size;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002988
2989 ret = mbedtls_cipher_setup( &operation->ctx.cmac, cipher_info );
2990 if( ret != 0 )
2991 return( ret );
2992
2993 ret = mbedtls_cipher_cmac_starts( &operation->ctx.cmac,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02002994 slot->data.key.data,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002995 key_bits );
2996 return( ret );
2997}
Gilles Peskinee3b07d82018-06-19 11:57:35 +02002998#endif /* MBEDTLS_CMAC_C */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002999
Gilles Peskine248051a2018-06-20 16:09:38 +02003000#if defined(MBEDTLS_MD_C)
Gilles Peskine01126fa2018-07-12 17:04:55 +02003001static psa_status_t psa_hmac_setup_internal( psa_hmac_internal_data *hmac,
3002 const uint8_t *key,
3003 size_t key_length,
3004 psa_algorithm_t hash_alg )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003005{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02003006 uint8_t ipad[PSA_HMAC_MAX_HASH_BLOCK_SIZE];
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003007 size_t i;
Gilles Peskine9aa369e2018-07-16 00:36:29 +02003008 size_t hash_size = PSA_HASH_SIZE( hash_alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003009 size_t block_size = psa_get_hash_block_size( hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003010 psa_status_t status;
3011
Gilles Peskine9aa369e2018-07-16 00:36:29 +02003012 /* Sanity checks on block_size, to guarantee that there won't be a buffer
3013 * overflow below. This should never trigger if the hash algorithm
3014 * is implemented correctly. */
3015 /* The size checks against the ipad and opad buffers cannot be written
3016 * `block_size > sizeof( ipad ) || block_size > sizeof( hmac->opad )`
3017 * because that triggers -Wlogical-op on GCC 7.3. */
3018 if( block_size > sizeof( ipad ) )
3019 return( PSA_ERROR_NOT_SUPPORTED );
3020 if( block_size > sizeof( hmac->opad ) )
3021 return( PSA_ERROR_NOT_SUPPORTED );
3022 if( block_size < hash_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003023 return( PSA_ERROR_NOT_SUPPORTED );
3024
Gilles Peskined223b522018-06-11 18:12:58 +02003025 if( key_length > block_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003026 {
Gilles Peskine84b8fc82019-11-28 20:07:20 +01003027 status = psa_hash_compute( hash_alg, key, key_length,
3028 ipad, sizeof( ipad ), &key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003029 if( status != PSA_SUCCESS )
Gilles Peskineb8be2882018-07-17 16:24:34 +02003030 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003031 }
Gilles Peskine96889972018-07-12 17:07:03 +02003032 /* A 0-length key is not commonly used in HMAC when used as a MAC,
3033 * but it is permitted. It is common when HMAC is used in HKDF, for
3034 * example. Don't call `memcpy` in the 0-length because `key` could be
3035 * an invalid pointer which would make the behavior undefined. */
3036 else if( key_length != 0 )
Gilles Peskine01126fa2018-07-12 17:04:55 +02003037 memcpy( ipad, key, key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003038
Gilles Peskined223b522018-06-11 18:12:58 +02003039 /* ipad contains the key followed by garbage. Xor and fill with 0x36
3040 * to create the ipad value. */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003041 for( i = 0; i < key_length; i++ )
Gilles Peskined223b522018-06-11 18:12:58 +02003042 ipad[i] ^= 0x36;
3043 memset( ipad + key_length, 0x36, block_size - key_length );
3044
3045 /* Copy the key material from ipad to opad, flipping the requisite bits,
3046 * and filling the rest of opad with the requisite constant. */
3047 for( i = 0; i < key_length; i++ )
Gilles Peskine01126fa2018-07-12 17:04:55 +02003048 hmac->opad[i] = ipad[i] ^ 0x36 ^ 0x5C;
3049 memset( hmac->opad + key_length, 0x5C, block_size - key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003050
Gilles Peskine01126fa2018-07-12 17:04:55 +02003051 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003052 if( status != PSA_SUCCESS )
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003053 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003054
Gilles Peskine01126fa2018-07-12 17:04:55 +02003055 status = psa_hash_update( &hmac->hash_ctx, ipad, block_size );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003056
3057cleanup:
Steven Cooreman29149862020-08-05 15:43:42 +02003058 mbedtls_platform_zeroize( ipad, sizeof( ipad ) );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003059
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003060 return( status );
3061}
Gilles Peskine248051a2018-06-20 16:09:38 +02003062#endif /* MBEDTLS_MD_C */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003063
Gilles Peskine89167cb2018-07-08 20:12:23 +02003064static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01003065 psa_key_handle_t handle,
Gilles Peskine89167cb2018-07-08 20:12:23 +02003066 psa_algorithm_t alg,
3067 int is_sign )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003068{
Gilles Peskine8c9def32018-02-08 10:02:12 +01003069 psa_status_t status;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003070 psa_key_slot_t *slot;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003071 size_t key_bits;
Gilles Peskine89167cb2018-07-08 20:12:23 +02003072 psa_key_usage_t usage =
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003073 is_sign ? PSA_KEY_USAGE_SIGN_HASH : PSA_KEY_USAGE_VERIFY_HASH;
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02003074 uint8_t truncated = PSA_MAC_TRUNCATED_LENGTH( alg );
Gilles Peskinee0e9c7c2018-10-17 18:28:05 +02003075 psa_algorithm_t full_length_alg = PSA_ALG_FULL_LENGTH_MAC( alg );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003076
Jaeden Amero36ee5d02019-02-19 09:25:10 +00003077 /* A context must be freshly initialized before it can be set up. */
3078 if( operation->alg != 0 )
3079 {
3080 return( PSA_ERROR_BAD_STATE );
3081 }
3082
Gilles Peskined911eb72018-08-14 15:18:45 +02003083 status = psa_mac_init( operation, full_length_alg );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003084 if( status != PSA_SUCCESS )
3085 return( status );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003086 if( is_sign )
3087 operation->is_sign = 1;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003088
Gilles Peskine28f8f302019-07-24 13:30:31 +02003089 status = psa_get_transparent_key( handle, &slot, usage, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003090 if( status != PSA_SUCCESS )
Gilles Peskinefbfac682018-07-08 20:51:54 +02003091 goto exit;
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02003092 key_bits = psa_get_key_slot_bits( slot );
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02003093
Gilles Peskine8c9def32018-02-08 10:02:12 +01003094#if defined(MBEDTLS_CMAC_C)
Gilles Peskined911eb72018-08-14 15:18:45 +02003095 if( full_length_alg == PSA_ALG_CMAC )
Gilles Peskinefbfac682018-07-08 20:51:54 +02003096 {
3097 const mbedtls_cipher_info_t *cipher_info =
Gilles Peskined911eb72018-08-14 15:18:45 +02003098 mbedtls_cipher_info_from_psa( full_length_alg,
Gilles Peskine8e338702019-07-30 20:06:31 +02003099 slot->attr.type, key_bits, NULL );
Janos Follath24eed8d2019-11-22 13:21:35 +00003100 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinefbfac682018-07-08 20:51:54 +02003101 if( cipher_info == NULL )
3102 {
3103 status = PSA_ERROR_NOT_SUPPORTED;
3104 goto exit;
3105 }
3106 operation->mac_size = cipher_info->block_size;
3107 ret = psa_cmac_setup( operation, key_bits, slot, cipher_info );
3108 status = mbedtls_to_psa_error( ret );
3109 }
3110 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01003111#endif /* MBEDTLS_CMAC_C */
Gilles Peskine8c9def32018-02-08 10:02:12 +01003112#if defined(MBEDTLS_MD_C)
Gilles Peskined911eb72018-08-14 15:18:45 +02003113 if( PSA_ALG_IS_HMAC( full_length_alg ) )
Gilles Peskinefbfac682018-07-08 20:51:54 +02003114 {
Gilles Peskine00709fa2018-08-22 18:25:41 +02003115 psa_algorithm_t hash_alg = PSA_ALG_HMAC_GET_HASH( alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003116 if( hash_alg == 0 )
3117 {
3118 status = PSA_ERROR_NOT_SUPPORTED;
3119 goto exit;
3120 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02003121
3122 operation->mac_size = PSA_HASH_SIZE( hash_alg );
3123 /* Sanity check. This shouldn't fail on a valid configuration. */
3124 if( operation->mac_size == 0 ||
3125 operation->mac_size > sizeof( operation->ctx.hmac.opad ) )
3126 {
3127 status = PSA_ERROR_NOT_SUPPORTED;
3128 goto exit;
3129 }
3130
Gilles Peskine8e338702019-07-30 20:06:31 +02003131 if( slot->attr.type != PSA_KEY_TYPE_HMAC )
Gilles Peskine01126fa2018-07-12 17:04:55 +02003132 {
3133 status = PSA_ERROR_INVALID_ARGUMENT;
3134 goto exit;
3135 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02003136
Gilles Peskine01126fa2018-07-12 17:04:55 +02003137 status = psa_hmac_setup_internal( &operation->ctx.hmac,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02003138 slot->data.key.data,
3139 slot->data.key.bytes,
Gilles Peskine01126fa2018-07-12 17:04:55 +02003140 hash_alg );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003141 }
3142 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01003143#endif /* MBEDTLS_MD_C */
Gilles Peskinefbfac682018-07-08 20:51:54 +02003144 {
Jaeden Amero82df32e2018-11-23 15:11:20 +00003145 (void) key_bits;
Gilles Peskinefbfac682018-07-08 20:51:54 +02003146 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003147 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003148
Gilles Peskined911eb72018-08-14 15:18:45 +02003149 if( truncated == 0 )
3150 {
3151 /* The "normal" case: untruncated algorithm. Nothing to do. */
3152 }
3153 else if( truncated < 4 )
3154 {
Gilles Peskine6d72ff92018-08-21 14:55:08 +02003155 /* A very short MAC is too short for security since it can be
3156 * brute-forced. Ancient protocols with 32-bit MACs do exist,
3157 * so we make this our minimum, even though 32 bits is still
3158 * too small for security. */
Gilles Peskined911eb72018-08-14 15:18:45 +02003159 status = PSA_ERROR_NOT_SUPPORTED;
3160 }
3161 else if( truncated > operation->mac_size )
3162 {
3163 /* It's impossible to "truncate" to a larger length. */
3164 status = PSA_ERROR_INVALID_ARGUMENT;
3165 }
3166 else
3167 operation->mac_size = truncated;
3168
Gilles Peskinefbfac682018-07-08 20:51:54 +02003169exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003170 if( status != PSA_SUCCESS )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003171 {
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003172 psa_mac_abort( operation );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003173 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003174 else
3175 {
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003176 operation->key_set = 1;
3177 }
3178 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003179}
3180
Gilles Peskine89167cb2018-07-08 20:12:23 +02003181psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01003182 psa_key_handle_t handle,
Gilles Peskine89167cb2018-07-08 20:12:23 +02003183 psa_algorithm_t alg )
3184{
Gilles Peskinec5487a82018-12-03 18:08:14 +01003185 return( psa_mac_setup( operation, handle, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003186}
3187
3188psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01003189 psa_key_handle_t handle,
Gilles Peskine89167cb2018-07-08 20:12:23 +02003190 psa_algorithm_t alg )
3191{
Gilles Peskinec5487a82018-12-03 18:08:14 +01003192 return( psa_mac_setup( operation, handle, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003193}
3194
Gilles Peskine8c9def32018-02-08 10:02:12 +01003195psa_status_t psa_mac_update( psa_mac_operation_t *operation,
3196 const uint8_t *input,
3197 size_t input_length )
3198{
Gilles Peskinefbfac682018-07-08 20:51:54 +02003199 psa_status_t status = PSA_ERROR_BAD_STATE;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003200 if( ! operation->key_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003201 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003202 if( operation->iv_required && ! operation->iv_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003203 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003204 operation->has_input = 1;
3205
Gilles Peskine8c9def32018-02-08 10:02:12 +01003206#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003207 if( operation->alg == PSA_ALG_CMAC )
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03003208 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02003209 int ret = mbedtls_cipher_cmac_update( &operation->ctx.cmac,
3210 input, input_length );
3211 status = mbedtls_to_psa_error( ret );
3212 }
3213 else
3214#endif /* MBEDTLS_CMAC_C */
3215#if defined(MBEDTLS_MD_C)
3216 if( PSA_ALG_IS_HMAC( operation->alg ) )
3217 {
3218 status = psa_hash_update( &operation->ctx.hmac.hash_ctx, input,
3219 input_length );
3220 }
3221 else
3222#endif /* MBEDTLS_MD_C */
3223 {
3224 /* This shouldn't happen if `operation` was initialized by
3225 * a setup function. */
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003226 return( PSA_ERROR_BAD_STATE );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03003227 }
3228
Gilles Peskinefbfac682018-07-08 20:51:54 +02003229 if( status != PSA_SUCCESS )
3230 psa_mac_abort( operation );
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02003231 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003232}
3233
Gilles Peskine01126fa2018-07-12 17:04:55 +02003234#if defined(MBEDTLS_MD_C)
3235static psa_status_t psa_hmac_finish_internal( psa_hmac_internal_data *hmac,
3236 uint8_t *mac,
3237 size_t mac_size )
3238{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02003239 uint8_t tmp[MBEDTLS_MD_MAX_SIZE];
Gilles Peskine01126fa2018-07-12 17:04:55 +02003240 psa_algorithm_t hash_alg = hmac->hash_ctx.alg;
3241 size_t hash_size = 0;
3242 size_t block_size = psa_get_hash_block_size( hash_alg );
3243 psa_status_t status;
3244
Gilles Peskine01126fa2018-07-12 17:04:55 +02003245 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
3246 if( status != PSA_SUCCESS )
3247 return( status );
3248 /* From here on, tmp needs to be wiped. */
3249
3250 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
3251 if( status != PSA_SUCCESS )
3252 goto exit;
3253
3254 status = psa_hash_update( &hmac->hash_ctx, hmac->opad, block_size );
3255 if( status != PSA_SUCCESS )
3256 goto exit;
3257
3258 status = psa_hash_update( &hmac->hash_ctx, tmp, hash_size );
3259 if( status != PSA_SUCCESS )
3260 goto exit;
3261
Gilles Peskined911eb72018-08-14 15:18:45 +02003262 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
3263 if( status != PSA_SUCCESS )
3264 goto exit;
3265
3266 memcpy( mac, tmp, mac_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003267
3268exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01003269 mbedtls_platform_zeroize( tmp, hash_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003270 return( status );
3271}
3272#endif /* MBEDTLS_MD_C */
3273
mohammad16036df908f2018-04-02 08:34:15 -07003274static psa_status_t psa_mac_finish_internal( psa_mac_operation_t *operation,
Gilles Peskine2d277862018-06-18 15:41:12 +02003275 uint8_t *mac,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003276 size_t mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003277{
Gilles Peskine1d96fff2018-07-02 12:15:39 +02003278 if( ! operation->key_set )
3279 return( PSA_ERROR_BAD_STATE );
3280 if( operation->iv_required && ! operation->iv_set )
3281 return( PSA_ERROR_BAD_STATE );
3282
Gilles Peskine8c9def32018-02-08 10:02:12 +01003283 if( mac_size < operation->mac_size )
3284 return( PSA_ERROR_BUFFER_TOO_SMALL );
3285
Gilles Peskine8c9def32018-02-08 10:02:12 +01003286#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003287 if( operation->alg == PSA_ALG_CMAC )
3288 {
Gilles Peskined911eb72018-08-14 15:18:45 +02003289 uint8_t tmp[PSA_MAX_BLOCK_CIPHER_BLOCK_SIZE];
3290 int ret = mbedtls_cipher_cmac_finish( &operation->ctx.cmac, tmp );
3291 if( ret == 0 )
Gilles Peskine87b0ac42018-08-21 14:55:49 +02003292 memcpy( mac, tmp, operation->mac_size );
Gilles Peskine3f108122018-12-07 18:14:53 +01003293 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003294 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003295 }
Gilles Peskinefbfac682018-07-08 20:51:54 +02003296 else
3297#endif /* MBEDTLS_CMAC_C */
3298#if defined(MBEDTLS_MD_C)
3299 if( PSA_ALG_IS_HMAC( operation->alg ) )
3300 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02003301 return( psa_hmac_finish_internal( &operation->ctx.hmac,
Gilles Peskined911eb72018-08-14 15:18:45 +02003302 mac, operation->mac_size ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003303 }
3304 else
3305#endif /* MBEDTLS_MD_C */
3306 {
3307 /* This shouldn't happen if `operation` was initialized by
3308 * a setup function. */
3309 return( PSA_ERROR_BAD_STATE );
3310 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01003311}
3312
Gilles Peskineacd4be32018-07-08 19:56:25 +02003313psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
3314 uint8_t *mac,
3315 size_t mac_size,
3316 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07003317{
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003318 psa_status_t status;
3319
Jaeden Amero252ef282019-02-15 14:05:35 +00003320 if( operation->alg == 0 )
3321 {
3322 return( PSA_ERROR_BAD_STATE );
3323 }
3324
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003325 /* Fill the output buffer with something that isn't a valid mac
3326 * (barring an attack on the mac and deliberately-crafted input),
3327 * in case the caller doesn't check the return status properly. */
3328 *mac_length = mac_size;
3329 /* If mac_size is 0 then mac may be NULL and then the
3330 * call to memset would have undefined behavior. */
3331 if( mac_size != 0 )
3332 memset( mac, '!', mac_size );
3333
Gilles Peskine89167cb2018-07-08 20:12:23 +02003334 if( ! operation->is_sign )
3335 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003336 return( PSA_ERROR_BAD_STATE );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003337 }
mohammad16036df908f2018-04-02 08:34:15 -07003338
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003339 status = psa_mac_finish_internal( operation, mac, mac_size );
3340
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003341 if( status == PSA_SUCCESS )
3342 {
3343 status = psa_mac_abort( operation );
3344 if( status == PSA_SUCCESS )
3345 *mac_length = operation->mac_size;
3346 else
3347 memset( mac, '!', mac_size );
3348 }
3349 else
3350 psa_mac_abort( operation );
3351 return( status );
mohammad16036df908f2018-04-02 08:34:15 -07003352}
3353
Gilles Peskineacd4be32018-07-08 19:56:25 +02003354psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
3355 const uint8_t *mac,
3356 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003357{
Gilles Peskine828ed142018-06-18 23:25:51 +02003358 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
mohammad16036df908f2018-04-02 08:34:15 -07003359 psa_status_t status;
3360
Jaeden Amero252ef282019-02-15 14:05:35 +00003361 if( operation->alg == 0 )
3362 {
3363 return( PSA_ERROR_BAD_STATE );
3364 }
3365
Gilles Peskine89167cb2018-07-08 20:12:23 +02003366 if( operation->is_sign )
3367 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003368 return( PSA_ERROR_BAD_STATE );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003369 }
3370 if( operation->mac_size != mac_length )
3371 {
3372 status = PSA_ERROR_INVALID_SIGNATURE;
3373 goto cleanup;
Gilles Peskine89167cb2018-07-08 20:12:23 +02003374 }
mohammad16036df908f2018-04-02 08:34:15 -07003375
3376 status = psa_mac_finish_internal( operation,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003377 actual_mac, sizeof( actual_mac ) );
Gilles Peskine28cd4162020-01-20 16:31:06 +01003378 if( status != PSA_SUCCESS )
3379 goto cleanup;
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003380
3381 if( safer_memcmp( mac, actual_mac, mac_length ) != 0 )
3382 status = PSA_ERROR_INVALID_SIGNATURE;
3383
3384cleanup:
3385 if( status == PSA_SUCCESS )
3386 status = psa_mac_abort( operation );
3387 else
3388 psa_mac_abort( operation );
3389
Gilles Peskine3f108122018-12-07 18:14:53 +01003390 mbedtls_platform_zeroize( actual_mac, sizeof( actual_mac ) );
Gilles Peskined911eb72018-08-14 15:18:45 +02003391
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003392 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003393}
3394
3395
Gilles Peskine20035e32018-02-03 22:44:14 +01003396
Gilles Peskine20035e32018-02-03 22:44:14 +01003397/****************************************************************/
3398/* Asymmetric cryptography */
3399/****************************************************************/
3400
Gilles Peskine2b450e32018-06-27 15:42:46 +02003401#if defined(MBEDTLS_RSA_C)
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02003402/* Decode the hash algorithm from alg and store the mbedtls encoding in
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003403 * md_alg. Verify that the hash length is acceptable. */
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02003404static psa_status_t psa_rsa_decode_md_type( psa_algorithm_t alg,
3405 size_t hash_length,
3406 mbedtls_md_type_t *md_alg )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003407{
Gilles Peskine7ed29c52018-06-26 15:50:08 +02003408 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003409 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003410 *md_alg = mbedtls_md_get_type( md_info );
3411
3412 /* The Mbed TLS RSA module uses an unsigned int for hash length
3413 * parameters. Validate that it fits so that we don't risk an
3414 * overflow later. */
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003415#if SIZE_MAX > UINT_MAX
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003416 if( hash_length > UINT_MAX )
3417 return( PSA_ERROR_INVALID_ARGUMENT );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003418#endif
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003419
3420#if defined(MBEDTLS_PKCS1_V15)
3421 /* For PKCS#1 v1.5 signature, if using a hash, the hash length
3422 * must be correct. */
3423 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) &&
3424 alg != PSA_ALG_RSA_PKCS1V15_SIGN_RAW )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003425 {
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003426 if( md_info == NULL )
3427 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003428 if( mbedtls_md_get_size( md_info ) != hash_length )
3429 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003430 }
3431#endif /* MBEDTLS_PKCS1_V15 */
3432
3433#if defined(MBEDTLS_PKCS1_V21)
3434 /* PSS requires a hash internally. */
3435 if( PSA_ALG_IS_RSA_PSS( alg ) )
3436 {
Gilles Peskine61b91d42018-06-08 16:09:36 +02003437 if( md_info == NULL )
3438 return( PSA_ERROR_NOT_SUPPORTED );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003439 }
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003440#endif /* MBEDTLS_PKCS1_V21 */
3441
Gilles Peskine61b91d42018-06-08 16:09:36 +02003442 return( PSA_SUCCESS );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003443}
3444
Gilles Peskine2b450e32018-06-27 15:42:46 +02003445static psa_status_t psa_rsa_sign( mbedtls_rsa_context *rsa,
3446 psa_algorithm_t alg,
3447 const uint8_t *hash,
3448 size_t hash_length,
3449 uint8_t *signature,
3450 size_t signature_size,
3451 size_t *signature_length )
3452{
3453 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00003454 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003455 mbedtls_md_type_t md_alg;
3456
3457 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
3458 if( status != PSA_SUCCESS )
3459 return( status );
3460
Gilles Peskine630a18a2018-06-29 17:49:35 +02003461 if( signature_size < mbedtls_rsa_get_len( rsa ) )
Gilles Peskine2b450e32018-06-27 15:42:46 +02003462 return( PSA_ERROR_BUFFER_TOO_SMALL );
3463
3464#if defined(MBEDTLS_PKCS1_V15)
3465 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
3466 {
3467 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
3468 MBEDTLS_MD_NONE );
3469 ret = mbedtls_rsa_pkcs1_sign( rsa,
3470 mbedtls_ctr_drbg_random,
3471 &global_data.ctr_drbg,
3472 MBEDTLS_RSA_PRIVATE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003473 md_alg,
3474 (unsigned int) hash_length,
3475 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003476 signature );
3477 }
3478 else
3479#endif /* MBEDTLS_PKCS1_V15 */
3480#if defined(MBEDTLS_PKCS1_V21)
3481 if( PSA_ALG_IS_RSA_PSS( alg ) )
3482 {
3483 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3484 ret = mbedtls_rsa_rsassa_pss_sign( rsa,
3485 mbedtls_ctr_drbg_random,
3486 &global_data.ctr_drbg,
3487 MBEDTLS_RSA_PRIVATE,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003488 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003489 (unsigned int) hash_length,
3490 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003491 signature );
3492 }
3493 else
3494#endif /* MBEDTLS_PKCS1_V21 */
3495 {
3496 return( PSA_ERROR_INVALID_ARGUMENT );
3497 }
3498
3499 if( ret == 0 )
Gilles Peskine630a18a2018-06-29 17:49:35 +02003500 *signature_length = mbedtls_rsa_get_len( rsa );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003501 return( mbedtls_to_psa_error( ret ) );
3502}
3503
3504static psa_status_t psa_rsa_verify( mbedtls_rsa_context *rsa,
3505 psa_algorithm_t alg,
3506 const uint8_t *hash,
3507 size_t hash_length,
3508 const uint8_t *signature,
3509 size_t signature_length )
3510{
3511 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00003512 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003513 mbedtls_md_type_t md_alg;
3514
3515 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
3516 if( status != PSA_SUCCESS )
3517 return( status );
3518
Gilles Peskine89cc74f2019-09-12 22:08:23 +02003519 if( signature_length != mbedtls_rsa_get_len( rsa ) )
3520 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003521
3522#if defined(MBEDTLS_PKCS1_V15)
3523 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
3524 {
3525 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
3526 MBEDTLS_MD_NONE );
3527 ret = mbedtls_rsa_pkcs1_verify( rsa,
3528 mbedtls_ctr_drbg_random,
3529 &global_data.ctr_drbg,
3530 MBEDTLS_RSA_PUBLIC,
3531 md_alg,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003532 (unsigned int) hash_length,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003533 hash,
3534 signature );
3535 }
3536 else
3537#endif /* MBEDTLS_PKCS1_V15 */
3538#if defined(MBEDTLS_PKCS1_V21)
3539 if( PSA_ALG_IS_RSA_PSS( alg ) )
3540 {
3541 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3542 ret = mbedtls_rsa_rsassa_pss_verify( rsa,
3543 mbedtls_ctr_drbg_random,
3544 &global_data.ctr_drbg,
3545 MBEDTLS_RSA_PUBLIC,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003546 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003547 (unsigned int) hash_length,
3548 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003549 signature );
3550 }
3551 else
3552#endif /* MBEDTLS_PKCS1_V21 */
3553 {
3554 return( PSA_ERROR_INVALID_ARGUMENT );
3555 }
Gilles Peskineef12c632018-09-13 20:37:48 +02003556
3557 /* Mbed TLS distinguishes "invalid padding" from "valid padding but
3558 * the rest of the signature is invalid". This has little use in
3559 * practice and PSA doesn't report this distinction. */
3560 if( ret == MBEDTLS_ERR_RSA_INVALID_PADDING )
3561 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003562 return( mbedtls_to_psa_error( ret ) );
3563}
3564#endif /* MBEDTLS_RSA_C */
3565
John Durkopf87e3ae2020-10-26 15:25:23 -07003566#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003567/* `ecp` cannot be const because `ecp->grp` needs to be non-const
3568 * for mbedtls_ecdsa_sign() and mbedtls_ecdsa_sign_det()
3569 * (even though these functions don't modify it). */
3570static psa_status_t psa_ecdsa_sign( mbedtls_ecp_keypair *ecp,
3571 psa_algorithm_t alg,
3572 const uint8_t *hash,
3573 size_t hash_length,
3574 uint8_t *signature,
3575 size_t signature_size,
3576 size_t *signature_length )
3577{
Janos Follath24eed8d2019-11-22 13:21:35 +00003578 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003579 mbedtls_mpi r, s;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003580 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003581 mbedtls_mpi_init( &r );
3582 mbedtls_mpi_init( &s );
3583
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003584 if( signature_size < 2 * curve_bytes )
3585 {
3586 ret = MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL;
3587 goto cleanup;
3588 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003589
John Durkop0ea39e02020-10-13 19:58:20 -07003590#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003591 if( PSA_ALG_DSA_IS_DETERMINISTIC( alg ) )
3592 {
3593 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
3594 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3595 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
Darryl Green5e843fa2019-09-05 14:06:34 +01003596 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign_det_ext( &ecp->grp, &r, &s,
3597 &ecp->d, hash,
3598 hash_length, md_alg,
3599 mbedtls_ctr_drbg_random,
3600 &global_data.ctr_drbg ) );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003601 }
3602 else
John Durkop0ea39e02020-10-13 19:58:20 -07003603#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003604 {
Gilles Peskinea05219c2018-11-16 16:02:56 +01003605 (void) alg;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003606 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign( &ecp->grp, &r, &s, &ecp->d,
3607 hash, hash_length,
3608 mbedtls_ctr_drbg_random,
3609 &global_data.ctr_drbg ) );
3610 }
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003611
3612 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &r,
3613 signature,
3614 curve_bytes ) );
3615 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &s,
3616 signature + curve_bytes,
3617 curve_bytes ) );
3618
3619cleanup:
3620 mbedtls_mpi_free( &r );
3621 mbedtls_mpi_free( &s );
3622 if( ret == 0 )
3623 *signature_length = 2 * curve_bytes;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003624 return( mbedtls_to_psa_error( ret ) );
3625}
3626
3627static psa_status_t psa_ecdsa_verify( mbedtls_ecp_keypair *ecp,
3628 const uint8_t *hash,
3629 size_t hash_length,
3630 const uint8_t *signature,
3631 size_t signature_length )
3632{
Janos Follath24eed8d2019-11-22 13:21:35 +00003633 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003634 mbedtls_mpi r, s;
3635 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
3636 mbedtls_mpi_init( &r );
3637 mbedtls_mpi_init( &s );
3638
3639 if( signature_length != 2 * curve_bytes )
3640 return( PSA_ERROR_INVALID_SIGNATURE );
3641
3642 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &r,
3643 signature,
3644 curve_bytes ) );
3645 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &s,
3646 signature + curve_bytes,
3647 curve_bytes ) );
3648
Steven Cooremanacda8342020-07-24 23:09:52 +02003649 /* Check whether the public part is loaded. If not, load it. */
3650 if( mbedtls_ecp_is_zero( &ecp->Q ) )
3651 {
3652 MBEDTLS_MPI_CHK(
3653 mbedtls_ecp_mul( &ecp->grp, &ecp->Q, &ecp->d, &ecp->grp.G,
3654 mbedtls_ctr_drbg_random, &global_data.ctr_drbg ) );
3655 }
3656
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003657 ret = mbedtls_ecdsa_verify( &ecp->grp, hash, hash_length,
3658 &ecp->Q, &r, &s );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003659
3660cleanup:
3661 mbedtls_mpi_free( &r );
3662 mbedtls_mpi_free( &s );
3663 return( mbedtls_to_psa_error( ret ) );
3664}
John Durkopf87e3ae2020-10-26 15:25:23 -07003665#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003666
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003667psa_status_t psa_sign_hash( psa_key_handle_t handle,
3668 psa_algorithm_t alg,
3669 const uint8_t *hash,
3670 size_t hash_length,
3671 uint8_t *signature,
3672 size_t signature_size,
3673 size_t *signature_length )
Gilles Peskine20035e32018-02-03 22:44:14 +01003674{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003675 psa_key_slot_t *slot;
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003676 psa_status_t status;
3677
3678 *signature_length = signature_size;
Gilles Peskine4019f0e2019-09-12 22:05:59 +02003679 /* Immediately reject a zero-length signature buffer. This guarantees
3680 * that signature must be a valid pointer. (On the other hand, the hash
3681 * buffer can in principle be empty since it doesn't actually have
3682 * to be a hash.) */
3683 if( signature_size == 0 )
3684 return( PSA_ERROR_BUFFER_TOO_SMALL );
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003685
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003686 status = psa_get_key_from_slot( handle, &slot, PSA_KEY_USAGE_SIGN_HASH, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003687 if( status != PSA_SUCCESS )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003688 goto exit;
Gilles Peskine8e338702019-07-30 20:06:31 +02003689 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003690 {
3691 status = PSA_ERROR_INVALID_ARGUMENT;
3692 goto exit;
3693 }
Gilles Peskine20035e32018-02-03 22:44:14 +01003694
Steven Cooremancd84cb42020-07-16 20:28:36 +02003695 /* Try any of the available accelerators first */
3696 status = psa_driver_wrapper_sign_hash( slot,
3697 alg,
3698 hash,
3699 hash_length,
3700 signature,
3701 signature_size,
3702 signature_length );
Steven Cooreman8d2bde72020-09-04 13:06:39 +02003703 if( status != PSA_ERROR_NOT_SUPPORTED ||
3704 psa_key_lifetime_is_external( slot->attr.lifetime ) )
Steven Cooremancd84cb42020-07-16 20:28:36 +02003705 goto exit;
3706
Steven Cooreman7a250572020-07-17 16:43:05 +02003707 /* If the operation was not supported by any accelerator, try fallback. */
Gilles Peskine20035e32018-02-03 22:44:14 +01003708#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003709 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskine20035e32018-02-03 22:44:14 +01003710 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003711 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02003712
Steven Cooreman4fed4552020-08-03 14:46:03 +02003713 status = psa_load_rsa_representation( slot->attr.type,
3714 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02003715 slot->data.key.bytes,
Steven Cooremana01795d2020-07-24 22:48:15 +02003716 &rsa );
3717 if( status != PSA_SUCCESS )
3718 goto exit;
3719
Steven Cooremana2371e52020-07-28 14:30:39 +02003720 status = psa_rsa_sign( rsa,
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003721 alg,
3722 hash, hash_length,
3723 signature, signature_size,
3724 signature_length );
Steven Cooremana01795d2020-07-24 22:48:15 +02003725
Steven Cooremana2371e52020-07-28 14:30:39 +02003726 mbedtls_rsa_free( rsa );
3727 mbedtls_free( rsa );
Gilles Peskine20035e32018-02-03 22:44:14 +01003728 }
3729 else
3730#endif /* defined(MBEDTLS_RSA_C) */
3731#if defined(MBEDTLS_ECP_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003732 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
Gilles Peskine20035e32018-02-03 22:44:14 +01003733 {
John Durkop0ea39e02020-10-13 19:58:20 -07003734#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA)
Gilles Peskinea05219c2018-11-16 16:02:56 +01003735 if(
John Durkop0ea39e02020-10-13 19:58:20 -07003736#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea05219c2018-11-16 16:02:56 +01003737 PSA_ALG_IS_ECDSA( alg )
3738#else
3739 PSA_ALG_IS_RANDOMIZED_ECDSA( alg )
3740#endif
3741 )
Steven Cooremanacda8342020-07-24 23:09:52 +02003742 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003743 mbedtls_ecp_keypair *ecp = NULL;
Steven Cooreman4fed4552020-08-03 14:46:03 +02003744 status = psa_load_ecp_representation( slot->attr.type,
3745 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02003746 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02003747 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003748 if( status != PSA_SUCCESS )
3749 goto exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003750 status = psa_ecdsa_sign( ecp,
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003751 alg,
3752 hash, hash_length,
3753 signature, signature_size,
3754 signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02003755 mbedtls_ecp_keypair_free( ecp );
3756 mbedtls_free( ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003757 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003758 else
John Durkop0ea39e02020-10-13 19:58:20 -07003759#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003760 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003761 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003762 }
itayzafrir5c753392018-05-08 11:18:38 +03003763 }
3764 else
3765#endif /* defined(MBEDTLS_ECP_C) */
3766 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003767 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine20035e32018-02-03 22:44:14 +01003768 }
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003769
3770exit:
3771 /* Fill the unused part of the output buffer (the whole buffer on error,
3772 * the trailing part on success) with something that isn't a valid mac
3773 * (barring an attack on the mac and deliberately-crafted input),
3774 * in case the caller doesn't check the return status properly. */
3775 if( status == PSA_SUCCESS )
3776 memset( signature + *signature_length, '!',
3777 signature_size - *signature_length );
Gilles Peskine4019f0e2019-09-12 22:05:59 +02003778 else
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003779 memset( signature, '!', signature_size );
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003780 /* If signature_size is 0 then we have nothing to do. We must not call
3781 * memset because signature may be NULL in this case. */
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003782 return( status );
itayzafrir5c753392018-05-08 11:18:38 +03003783}
3784
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003785psa_status_t psa_verify_hash( psa_key_handle_t handle,
3786 psa_algorithm_t alg,
3787 const uint8_t *hash,
3788 size_t hash_length,
3789 const uint8_t *signature,
3790 size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03003791{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003792 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003793 psa_status_t status;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003794
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003795 status = psa_get_key_from_slot( handle, &slot, PSA_KEY_USAGE_VERIFY_HASH, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003796 if( status != PSA_SUCCESS )
3797 return( status );
itayzafrir5c753392018-05-08 11:18:38 +03003798
Steven Cooreman55ae2172020-07-17 19:46:15 +02003799 /* Try any of the available accelerators first */
3800 status = psa_driver_wrapper_verify_hash( slot,
3801 alg,
3802 hash,
3803 hash_length,
3804 signature,
3805 signature_length );
Steven Cooreman8d2bde72020-09-04 13:06:39 +02003806 if( status != PSA_ERROR_NOT_SUPPORTED ||
3807 psa_key_lifetime_is_external( slot->attr.lifetime ) )
Steven Cooreman55ae2172020-07-17 19:46:15 +02003808 return status;
3809
Gilles Peskine61b91d42018-06-08 16:09:36 +02003810#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003811 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003812 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003813 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02003814
Steven Cooreman4fed4552020-08-03 14:46:03 +02003815 status = psa_load_rsa_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 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003819 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02003820 return( status );
Steven Cooremana01795d2020-07-24 22:48:15 +02003821
Steven Cooremana2371e52020-07-28 14:30:39 +02003822 status = psa_rsa_verify( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02003823 alg,
3824 hash, hash_length,
3825 signature, signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02003826 mbedtls_rsa_free( rsa );
3827 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003828 return( status );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003829 }
3830 else
3831#endif /* defined(MBEDTLS_RSA_C) */
itayzafrir5c753392018-05-08 11:18:38 +03003832#if defined(MBEDTLS_ECP_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003833 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
itayzafrir5c753392018-05-08 11:18:38 +03003834 {
John Durkopf87e3ae2020-10-26 15:25:23 -07003835#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003836 if( PSA_ALG_IS_ECDSA( alg ) )
Steven Cooremanacda8342020-07-24 23:09:52 +02003837 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003838 mbedtls_ecp_keypair *ecp = NULL;
Steven Cooreman4fed4552020-08-03 14:46:03 +02003839 status = psa_load_ecp_representation( slot->attr.type,
3840 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02003841 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02003842 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003843 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02003844 return( status );
Steven Cooremana2371e52020-07-28 14:30:39 +02003845 status = psa_ecdsa_verify( ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02003846 hash, hash_length,
3847 signature, signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02003848 mbedtls_ecp_keypair_free( ecp );
3849 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02003850 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02003851 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003852 else
John Durkopf87e3ae2020-10-26 15:25:23 -07003853#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003854 {
3855 return( PSA_ERROR_INVALID_ARGUMENT );
3856 }
itayzafrir5c753392018-05-08 11:18:38 +03003857 }
Gilles Peskine20035e32018-02-03 22:44:14 +01003858 else
3859#endif /* defined(MBEDTLS_ECP_C) */
3860 {
3861 return( PSA_ERROR_NOT_SUPPORTED );
3862 }
3863}
3864
Gilles Peskine072ac562018-06-30 00:21:29 +02003865#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PKCS1_V21)
3866static void psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
3867 mbedtls_rsa_context *rsa )
3868{
3869 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
3870 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3871 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
3872 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3873}
3874#endif /* defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PKCS1_V21) */
3875
Gilles Peskinec5487a82018-12-03 18:08:14 +01003876psa_status_t psa_asymmetric_encrypt( psa_key_handle_t handle,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003877 psa_algorithm_t alg,
3878 const uint8_t *input,
3879 size_t input_length,
3880 const uint8_t *salt,
3881 size_t salt_length,
3882 uint8_t *output,
3883 size_t output_size,
3884 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003885{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003886 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003887 psa_status_t status;
3888
Darryl Green5cc689a2018-07-24 15:34:10 +01003889 (void) input;
3890 (void) input_length;
3891 (void) salt;
3892 (void) output;
3893 (void) output_size;
3894
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003895 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003896
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003897 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3898 return( PSA_ERROR_INVALID_ARGUMENT );
3899
Gilles Peskine28f8f302019-07-24 13:30:31 +02003900 status = psa_get_transparent_key( handle, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003901 if( status != PSA_SUCCESS )
3902 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003903 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
3904 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003905 return( PSA_ERROR_INVALID_ARGUMENT );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003906
3907#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003908 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003909 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003910 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman4fed4552020-08-03 14:46:03 +02003911 status = psa_load_rsa_representation( slot->attr.type,
3912 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02003913 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02003914 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003915 if( status != PSA_SUCCESS )
Steven Cooreman4fed4552020-08-03 14:46:03 +02003916 goto rsa_exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003917
3918 if( output_size < mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003919 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003920 status = PSA_ERROR_BUFFER_TOO_SMALL;
3921 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003922 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003923#if defined(MBEDTLS_PKCS1_V15)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003924 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003925 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003926 status = mbedtls_to_psa_error(
3927 mbedtls_rsa_pkcs1_encrypt( rsa,
3928 mbedtls_ctr_drbg_random,
3929 &global_data.ctr_drbg,
3930 MBEDTLS_RSA_PUBLIC,
3931 input_length,
3932 input,
3933 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003934 }
3935 else
3936#endif /* MBEDTLS_PKCS1_V15 */
3937#if defined(MBEDTLS_PKCS1_V21)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003938 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003939 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003940 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02003941 status = mbedtls_to_psa_error(
3942 mbedtls_rsa_rsaes_oaep_encrypt( rsa,
3943 mbedtls_ctr_drbg_random,
3944 &global_data.ctr_drbg,
3945 MBEDTLS_RSA_PUBLIC,
3946 salt, salt_length,
3947 input_length,
3948 input,
3949 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003950 }
3951 else
3952#endif /* MBEDTLS_PKCS1_V21 */
3953 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003954 status = PSA_ERROR_INVALID_ARGUMENT;
3955 goto rsa_exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003956 }
Steven Cooreman4fed4552020-08-03 14:46:03 +02003957rsa_exit:
3958 if( status == PSA_SUCCESS )
Steven Cooremana2371e52020-07-28 14:30:39 +02003959 *output_length = mbedtls_rsa_get_len( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003960
Steven Cooremana2371e52020-07-28 14:30:39 +02003961 mbedtls_rsa_free( rsa );
3962 mbedtls_free( rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02003963 return( status );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003964 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003965 else
Gilles Peskineb75e4f12018-06-08 17:44:47 +02003966#endif /* defined(MBEDTLS_RSA_C) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003967 {
3968 return( PSA_ERROR_NOT_SUPPORTED );
3969 }
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003970}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003971
Gilles Peskinec5487a82018-12-03 18:08:14 +01003972psa_status_t psa_asymmetric_decrypt( psa_key_handle_t handle,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003973 psa_algorithm_t alg,
3974 const uint8_t *input,
3975 size_t input_length,
3976 const uint8_t *salt,
3977 size_t salt_length,
3978 uint8_t *output,
3979 size_t output_size,
3980 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003981{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003982 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003983 psa_status_t status;
3984
Darryl Green5cc689a2018-07-24 15:34:10 +01003985 (void) input;
3986 (void) input_length;
3987 (void) salt;
3988 (void) output;
3989 (void) output_size;
3990
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003991 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003992
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003993 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3994 return( PSA_ERROR_INVALID_ARGUMENT );
3995
Gilles Peskine28f8f302019-07-24 13:30:31 +02003996 status = psa_get_transparent_key( handle, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003997 if( status != PSA_SUCCESS )
3998 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003999 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004000 return( PSA_ERROR_INVALID_ARGUMENT );
4001
4002#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02004003 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004004 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004005 mbedtls_rsa_context *rsa = NULL;
4006 status = psa_load_rsa_representation( slot->attr.type,
4007 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02004008 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02004009 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02004010 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02004011 return( status );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004012
Steven Cooremana2371e52020-07-28 14:30:39 +02004013 if( input_length != mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02004014 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004015 status = PSA_ERROR_INVALID_ARGUMENT;
4016 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02004017 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004018
4019#if defined(MBEDTLS_PKCS1_V15)
Gilles Peskine6afe7892018-05-31 13:16:08 +02004020 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004021 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004022 status = mbedtls_to_psa_error(
4023 mbedtls_rsa_pkcs1_decrypt( rsa,
4024 mbedtls_ctr_drbg_random,
4025 &global_data.ctr_drbg,
4026 MBEDTLS_RSA_PRIVATE,
4027 output_length,
4028 input,
4029 output,
4030 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004031 }
4032 else
4033#endif /* MBEDTLS_PKCS1_V15 */
4034#if defined(MBEDTLS_PKCS1_V21)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02004035 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004036 {
Steven Cooremana2371e52020-07-28 14:30:39 +02004037 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02004038 status = mbedtls_to_psa_error(
4039 mbedtls_rsa_rsaes_oaep_decrypt( rsa,
4040 mbedtls_ctr_drbg_random,
4041 &global_data.ctr_drbg,
4042 MBEDTLS_RSA_PRIVATE,
4043 salt, salt_length,
4044 output_length,
4045 input,
4046 output,
4047 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004048 }
4049 else
4050#endif /* MBEDTLS_PKCS1_V21 */
4051 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004052 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004053 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03004054
Steven Cooreman4fed4552020-08-03 14:46:03 +02004055rsa_exit:
Steven Cooremana2371e52020-07-28 14:30:39 +02004056 mbedtls_rsa_free( rsa );
4057 mbedtls_free( rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02004058 return( status );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004059 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004060 else
Gilles Peskineb75e4f12018-06-08 17:44:47 +02004061#endif /* defined(MBEDTLS_RSA_C) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004062 {
4063 return( PSA_ERROR_NOT_SUPPORTED );
4064 }
Gilles Peskine5b051bc2018-05-31 13:25:48 +02004065}
Gilles Peskine20035e32018-02-03 22:44:14 +01004066
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004067
4068
mohammad1603503973b2018-03-12 15:59:30 +02004069/****************************************************************/
4070/* Symmetric cryptography */
4071/****************************************************************/
4072
Gilles Peskinee553c652018-06-04 16:22:46 +02004073static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01004074 psa_key_handle_t handle,
Gilles Peskine7e928852018-06-04 16:23:10 +02004075 psa_algorithm_t alg,
4076 mbedtls_operation_t cipher_operation )
mohammad1603503973b2018-03-12 15:59:30 +02004077{
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004078 int ret = 0;
4079 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Gilles Peskine2f060a82018-12-04 17:12:32 +01004080 psa_key_slot_t *slot;
mohammad1603503973b2018-03-12 15:59:30 +02004081 size_t key_bits;
4082 const mbedtls_cipher_info_t *cipher_info = NULL;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004083 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
4084 PSA_KEY_USAGE_ENCRYPT :
4085 PSA_KEY_USAGE_DECRYPT );
mohammad1603503973b2018-03-12 15:59:30 +02004086
Steven Cooremand3feccd2020-09-01 15:56:14 +02004087 /* A context must be freshly initialized before it can be set up. */
4088 if( operation->alg != 0 )
4089 return( PSA_ERROR_BAD_STATE );
4090
Steven Cooremana07b9972020-09-10 14:54:14 +02004091 /* The requested algorithm must be one that can be processed by cipher. */
4092 if( ! PSA_ALG_IS_CIPHER( alg ) )
Steven Cooremana07b9972020-09-10 14:54:14 +02004093 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremand3feccd2020-09-01 15:56:14 +02004094
Steven Cooremanef8575e2020-09-11 11:44:50 +02004095 /* Fetch key material from key storage. */
4096 status = psa_get_key_from_slot( handle, &slot, usage, alg );
4097 if( status != PSA_SUCCESS )
4098 goto exit;
4099
4100 /* Initialize the operation struct members, except for alg. The alg member
4101 * is used to indicate to psa_cipher_abort that there are resources to free,
4102 * so we only set it after resources have been allocated/initialized. */
Steven Cooremana07b9972020-09-10 14:54:14 +02004103 operation->key_set = 0;
4104 operation->iv_set = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004105 operation->mbedtls_in_use = 0;
Steven Cooremana07b9972020-09-10 14:54:14 +02004106 operation->iv_size = 0;
4107 operation->block_size = 0;
4108 if( alg == PSA_ALG_ECB_NO_PADDING )
4109 operation->iv_required = 0;
4110 else
4111 operation->iv_required = 1;
4112
Steven Cooremana07b9972020-09-10 14:54:14 +02004113 /* Try doing the operation through a driver before using software fallback. */
Steven Cooreman37941cb2020-07-28 18:49:51 +02004114 if( cipher_operation == MBEDTLS_ENCRYPT )
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004115 status = psa_driver_wrapper_cipher_encrypt_setup( &operation->ctx.driver,
Steven Cooreman37941cb2020-07-28 18:49:51 +02004116 slot,
4117 alg );
4118 else
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004119 status = psa_driver_wrapper_cipher_decrypt_setup( &operation->ctx.driver,
Steven Cooreman37941cb2020-07-28 18:49:51 +02004120 slot,
4121 alg );
4122
Steven Cooremanef8575e2020-09-11 11:44:50 +02004123 if( status == PSA_SUCCESS )
Steven Cooreman6d81f7e2020-09-14 13:14:31 +02004124 {
Steven Cooremanef8575e2020-09-11 11:44:50 +02004125 /* Once the driver context is initialised, it needs to be freed using
4126 * psa_cipher_abort. Indicate this through setting alg. */
4127 operation->alg = alg;
Steven Cooreman6d81f7e2020-09-14 13:14:31 +02004128 }
Steven Cooremanef8575e2020-09-11 11:44:50 +02004129
Steven Cooremand3feccd2020-09-01 15:56:14 +02004130 if( status != PSA_ERROR_NOT_SUPPORTED ||
4131 psa_key_lifetime_is_external( slot->attr.lifetime ) )
4132 goto exit;
4133
Steven Cooremana07b9972020-09-10 14:54:14 +02004134 /* Proceed with initializing an mbed TLS cipher context if no driver is
Steven Cooremand3feccd2020-09-01 15:56:14 +02004135 * available for the given algorithm & key. */
4136 mbedtls_cipher_init( &operation->ctx.cipher );
mohammad1603503973b2018-03-12 15:59:30 +02004137
Steven Cooremana07b9972020-09-10 14:54:14 +02004138 /* Once the cipher context is initialised, it needs to be freed using
Steven Cooremanef8575e2020-09-11 11:44:50 +02004139 * psa_cipher_abort. Indicate there is something to be freed through setting
4140 * alg, and indicate the operation is being done using mbedtls crypto through
4141 * setting mbedtls_in_use. */
Steven Cooremana07b9972020-09-10 14:54:14 +02004142 operation->alg = alg;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004143 operation->mbedtls_in_use = 1;
Steven Cooremana07b9972020-09-10 14:54:14 +02004144
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02004145 key_bits = psa_get_key_slot_bits( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +02004146 cipher_info = mbedtls_cipher_info_from_psa( alg, slot->attr.type, key_bits, NULL );
mohammad1603503973b2018-03-12 15:59:30 +02004147 if( cipher_info == NULL )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004148 {
4149 status = PSA_ERROR_NOT_SUPPORTED;
4150 goto exit;
4151 }
mohammad1603503973b2018-03-12 15:59:30 +02004152
mohammad1603503973b2018-03-12 15:59:30 +02004153 ret = mbedtls_cipher_setup( &operation->ctx.cipher, cipher_info );
Moran Peker41deec42018-04-04 15:43:05 +03004154 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004155 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004156
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004157#if defined(MBEDTLS_DES_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02004158 if( slot->attr.type == PSA_KEY_TYPE_DES && key_bits == 128 )
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004159 {
4160 /* Two-key Triple-DES is 3-key Triple-DES with K1=K3 */
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02004161 uint8_t keys[24];
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004162 memcpy( keys, slot->data.key.data, 16 );
4163 memcpy( keys + 16, slot->data.key.data, 8 );
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004164 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
4165 keys,
4166 192, cipher_operation );
4167 }
4168 else
4169#endif
4170 {
4171 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004172 slot->data.key.data,
Jaeden Amero23bbb752018-06-26 14:16:54 +01004173 (int) key_bits, cipher_operation );
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004174 }
Moran Peker41deec42018-04-04 15:43:05 +03004175 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004176 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004177
mohammad16038481e742018-03-18 13:57:31 +02004178#if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004179 switch( alg )
mohammad16038481e742018-03-18 13:57:31 +02004180 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004181 case PSA_ALG_CBC_NO_PADDING:
4182 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
4183 MBEDTLS_PADDING_NONE );
4184 break;
4185 case PSA_ALG_CBC_PKCS7:
4186 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
4187 MBEDTLS_PADDING_PKCS7 );
4188 break;
4189 default:
4190 /* The algorithm doesn't involve padding. */
4191 ret = 0;
4192 break;
4193 }
4194 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004195 goto exit;
mohammad16038481e742018-03-18 13:57:31 +02004196#endif //MBEDTLS_CIPHER_MODE_WITH_PADDING
4197
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004198 operation->block_size = ( PSA_ALG_IS_STREAM_CIPHER( alg ) ? 1 :
Gilles Peskine8e338702019-07-30 20:06:31 +02004199 PSA_BLOCK_CIPHER_BLOCK_SIZE( slot->attr.type ) );
Steven Cooremana6033e92020-08-25 11:47:50 +02004200 if( ( alg & PSA_ALG_CIPHER_FROM_BLOCK_FLAG ) != 0 &&
4201 alg != PSA_ALG_ECB_NO_PADDING )
mohammad16038481e742018-03-18 13:57:31 +02004202 {
Gilles Peskine8e338702019-07-30 20:06:31 +02004203 operation->iv_size = PSA_BLOCK_CIPHER_BLOCK_SIZE( slot->attr.type );
mohammad16038481e742018-03-18 13:57:31 +02004204 }
Gilles Peskine26869f22019-05-06 15:25:00 +02004205#if defined(MBEDTLS_CHACHA20_C)
4206 else
4207 if( alg == PSA_ALG_CHACHA20 )
4208 operation->iv_size = 12;
4209#endif
mohammad1603503973b2018-03-12 15:59:30 +02004210
Steven Cooreman7df02922020-09-09 15:28:49 +02004211 status = PSA_SUCCESS;
4212
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004213exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02004214 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004215 status = mbedtls_to_psa_error( ret );
Steven Cooreman7df02922020-09-09 15:28:49 +02004216 if( status == PSA_SUCCESS )
4217 {
4218 /* Update operation flags for both driver and software implementations */
4219 operation->key_set = 1;
4220 }
4221 else
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004222 psa_cipher_abort( operation );
4223 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004224}
4225
Gilles Peskinefe119512018-07-08 21:39:34 +02004226psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01004227 psa_key_handle_t handle,
Gilles Peskinefe119512018-07-08 21:39:34 +02004228 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02004229{
Gilles Peskinec5487a82018-12-03 18:08:14 +01004230 return( psa_cipher_setup( operation, handle, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02004231}
4232
Gilles Peskinefe119512018-07-08 21:39:34 +02004233psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01004234 psa_key_handle_t handle,
Gilles Peskinefe119512018-07-08 21:39:34 +02004235 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02004236{
Gilles Peskinec5487a82018-12-03 18:08:14 +01004237 return( psa_cipher_setup( operation, handle, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02004238}
4239
Gilles Peskinefe119512018-07-08 21:39:34 +02004240psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004241 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02004242 size_t iv_size,
4243 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02004244{
itayzafrir534bd7c2018-08-02 13:56:32 +03004245 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00004246 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooreman7df02922020-09-09 15:28:49 +02004247 if( operation->iv_set || ! operation->iv_required )
4248 {
4249 return( PSA_ERROR_BAD_STATE );
4250 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004251
Steven Cooremanef8575e2020-09-11 11:44:50 +02004252 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004253 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004254 status = psa_driver_wrapper_cipher_generate_iv( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004255 iv,
4256 iv_size,
4257 iv_length );
4258 goto exit;
4259 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004260
Moran Peker41deec42018-04-04 15:43:05 +03004261 if( iv_size < operation->iv_size )
mohammad1603503973b2018-03-12 15:59:30 +02004262 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004263 status = PSA_ERROR_BUFFER_TOO_SMALL;
Moran Peker41deec42018-04-04 15:43:05 +03004264 goto exit;
4265 }
Gilles Peskine7e928852018-06-04 16:23:10 +02004266 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg,
4267 iv, operation->iv_size );
Moran Peker41deec42018-04-04 15:43:05 +03004268 if( ret != 0 )
4269 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004270 status = mbedtls_to_psa_error( ret );
Gilles Peskinee553c652018-06-04 16:22:46 +02004271 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004272 }
Gilles Peskinee553c652018-06-04 16:22:46 +02004273
mohammad16038481e742018-03-18 13:57:31 +02004274 *iv_length = operation->iv_size;
itayzafrir534bd7c2018-08-02 13:56:32 +03004275 status = psa_cipher_set_iv( operation, iv, *iv_length );
Moran Peker41deec42018-04-04 15:43:05 +03004276
Moran Peker395db872018-05-31 14:07:14 +03004277exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02004278 if( status == PSA_SUCCESS )
4279 operation->iv_set = 1;
4280 else
Moran Peker395db872018-05-31 14:07:14 +03004281 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004282 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004283}
4284
Gilles Peskinefe119512018-07-08 21:39:34 +02004285psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004286 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02004287 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02004288{
itayzafrir534bd7c2018-08-02 13:56:32 +03004289 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00004290 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooreman7df02922020-09-09 15:28:49 +02004291 if( operation->iv_set || ! operation->iv_required )
4292 {
4293 return( PSA_ERROR_BAD_STATE );
4294 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004295
Steven Cooremanef8575e2020-09-11 11:44:50 +02004296 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004297 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004298 status = psa_driver_wrapper_cipher_set_iv( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004299 iv,
4300 iv_length );
4301 goto exit;
4302 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004303
Moran Pekera28258c2018-05-29 16:25:04 +03004304 if( iv_length != operation->iv_size )
Moran Peker71f19ae2018-04-22 20:23:16 +03004305 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004306 status = PSA_ERROR_INVALID_ARGUMENT;
4307 goto exit;
Moran Peker71f19ae2018-04-22 20:23:16 +03004308 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004309 ret = mbedtls_cipher_set_iv( &operation->ctx.cipher, iv, iv_length );
4310 status = mbedtls_to_psa_error( ret );
4311exit:
4312 if( status == PSA_SUCCESS )
4313 operation->iv_set = 1;
4314 else
mohammad1603503973b2018-03-12 15:59:30 +02004315 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004316 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004317}
4318
Steven Cooreman177deba2020-09-07 17:14:14 +02004319/* Process input for which the algorithm is set to ECB mode. This requires
4320 * manual processing, since the PSA API is defined as being able to process
4321 * arbitrary-length calls to psa_cipher_update() with ECB mode, but the
4322 * underlying mbedtls_cipher_update only takes full blocks. */
4323static psa_status_t psa_cipher_update_ecb_internal(
4324 mbedtls_cipher_context_t *ctx,
4325 const uint8_t *input,
4326 size_t input_length,
4327 uint8_t *output,
4328 size_t output_size,
4329 size_t *output_length )
4330{
4331 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4332 size_t block_size = ctx->cipher_info->block_size;
4333 size_t internal_output_length = 0;
4334 *output_length = 0;
4335
4336 if( input_length == 0 )
4337 {
4338 status = PSA_SUCCESS;
4339 goto exit;
4340 }
4341
4342 if( ctx->unprocessed_len > 0 )
4343 {
4344 /* Fill up to block size, and run the block if there's a full one. */
4345 size_t bytes_to_copy = block_size - ctx->unprocessed_len;
4346
4347 if( input_length < bytes_to_copy )
4348 bytes_to_copy = input_length;
4349
4350 memcpy( &( ctx->unprocessed_data[ctx->unprocessed_len] ),
4351 input, bytes_to_copy );
4352 input_length -= bytes_to_copy;
4353 input += bytes_to_copy;
4354 ctx->unprocessed_len += bytes_to_copy;
4355
4356 if( ctx->unprocessed_len == block_size )
4357 {
4358 status = mbedtls_to_psa_error(
4359 mbedtls_cipher_update( ctx,
4360 ctx->unprocessed_data,
4361 block_size,
4362 output, &internal_output_length ) );
4363
4364 if( status != PSA_SUCCESS )
4365 goto exit;
4366
4367 output += internal_output_length;
4368 output_size -= internal_output_length;
4369 *output_length += internal_output_length;
4370 ctx->unprocessed_len = 0;
4371 }
4372 }
4373
4374 while( input_length >= block_size )
4375 {
4376 /* Run all full blocks we have, one by one */
4377 status = mbedtls_to_psa_error(
4378 mbedtls_cipher_update( ctx, input,
4379 block_size,
4380 output, &internal_output_length ) );
4381
4382 if( status != PSA_SUCCESS )
4383 goto exit;
4384
4385 input_length -= block_size;
4386 input += block_size;
4387
4388 output += internal_output_length;
4389 output_size -= internal_output_length;
4390 *output_length += internal_output_length;
4391 }
4392
4393 if( input_length > 0 )
4394 {
4395 /* Save unprocessed bytes for later processing */
4396 memcpy( &( ctx->unprocessed_data[ctx->unprocessed_len] ),
4397 input, input_length );
4398 ctx->unprocessed_len += input_length;
4399 }
4400
4401 status = PSA_SUCCESS;
4402
4403exit:
4404 return( status );
4405}
4406
Gilles Peskinee553c652018-06-04 16:22:46 +02004407psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
4408 const uint8_t *input,
4409 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004410 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02004411 size_t output_size,
4412 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02004413{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004414 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine89d789c2018-06-04 17:17:16 +02004415 size_t expected_output_size;
Steven Cooreman7df02922020-09-09 15:28:49 +02004416 if( operation->alg == 0 )
4417 {
4418 return( PSA_ERROR_BAD_STATE );
4419 }
4420 if( operation->iv_required && ! operation->iv_set )
4421 {
4422 return( PSA_ERROR_BAD_STATE );
4423 }
Jaeden Ameroab439972019-02-15 14:12:05 +00004424
Steven Cooremanef8575e2020-09-11 11:44:50 +02004425 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004426 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004427 status = psa_driver_wrapper_cipher_update( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004428 input,
4429 input_length,
4430 output,
4431 output_size,
4432 output_length );
4433 goto exit;
4434 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004435
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004436 if( ! PSA_ALG_IS_STREAM_CIPHER( operation->alg ) )
Gilles Peskine89d789c2018-06-04 17:17:16 +02004437 {
4438 /* Take the unprocessed partial block left over from previous
4439 * update calls, if any, plus the input to this call. Remove
4440 * the last partial block, if any. You get the data that will be
4441 * output in this call. */
4442 expected_output_size =
4443 ( operation->ctx.cipher.unprocessed_len + input_length )
4444 / operation->block_size * operation->block_size;
4445 }
4446 else
4447 {
4448 expected_output_size = input_length;
4449 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004450
Gilles Peskine89d789c2018-06-04 17:17:16 +02004451 if( output_size < expected_output_size )
itayzafrir534bd7c2018-08-02 13:56:32 +03004452 {
4453 status = PSA_ERROR_BUFFER_TOO_SMALL;
4454 goto exit;
4455 }
mohammad160382759612018-03-12 18:16:40 +02004456
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004457 if( operation->alg == PSA_ALG_ECB_NO_PADDING )
4458 {
4459 /* mbedtls_cipher_update has an API inconsistency: it will only
4460 * process a single block at a time in ECB mode. Abstract away that
4461 * inconsistency here to match the PSA API behaviour. */
Steven Cooreman177deba2020-09-07 17:14:14 +02004462 status = psa_cipher_update_ecb_internal( &operation->ctx.cipher,
4463 input,
4464 input_length,
4465 output,
4466 output_size,
4467 output_length );
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004468 }
4469 else
4470 {
4471 status = mbedtls_to_psa_error(
4472 mbedtls_cipher_update( &operation->ctx.cipher, input,
4473 input_length, output, output_length ) );
4474 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004475exit:
4476 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02004477 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004478 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004479}
4480
Gilles Peskinee553c652018-06-04 16:22:46 +02004481psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
4482 uint8_t *output,
4483 size_t output_size,
4484 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02004485{
David Saadab4ecc272019-02-14 13:48:10 +02004486 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Gilles Peskinee553c652018-06-04 16:22:46 +02004487 uint8_t temp_output_buffer[MBEDTLS_MAX_BLOCK_LENGTH];
Steven Cooreman7df02922020-09-09 15:28:49 +02004488 if( operation->alg == 0 )
4489 {
4490 return( PSA_ERROR_BAD_STATE );
4491 }
4492 if( operation->iv_required && ! operation->iv_set )
4493 {
4494 return( PSA_ERROR_BAD_STATE );
4495 }
Moran Pekerbed71a22018-04-22 20:19:20 +03004496
Steven Cooremanef8575e2020-09-11 11:44:50 +02004497 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004498 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004499 status = psa_driver_wrapper_cipher_finish( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004500 output,
4501 output_size,
4502 output_length );
Steven Cooremanef8575e2020-09-11 11:44:50 +02004503 goto exit;
Steven Cooreman8b122252020-09-03 15:30:32 +02004504 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004505
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004506 if( operation->ctx.cipher.unprocessed_len != 0 )
Moran Peker7cb22b82018-06-05 11:40:02 +03004507 {
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004508 if( operation->alg == PSA_ALG_ECB_NO_PADDING ||
Fredrik Strupef90e3012020-09-28 16:11:33 +02004509 operation->alg == PSA_ALG_CBC_NO_PADDING )
Steven Cooremana6033e92020-08-25 11:47:50 +02004510 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004511 status = PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004512 goto exit;
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004513 }
Moran Pekerdc38ebc2018-04-30 15:45:34 +03004514 }
4515
Steven Cooremanef8575e2020-09-11 11:44:50 +02004516 status = mbedtls_to_psa_error(
4517 mbedtls_cipher_finish( &operation->ctx.cipher,
4518 temp_output_buffer,
4519 output_length ) );
4520 if( status != PSA_SUCCESS )
4521 goto exit;
Janos Follath315b51c2018-07-09 16:04:51 +01004522
Gilles Peskine46f1fd72018-06-28 19:31:31 +02004523 if( *output_length == 0 )
Janos Follath315b51c2018-07-09 16:04:51 +01004524 ; /* Nothing to copy. Note that output may be NULL in this case. */
Gilles Peskine46f1fd72018-06-28 19:31:31 +02004525 else if( output_size >= *output_length )
Moran Pekerdc38ebc2018-04-30 15:45:34 +03004526 memcpy( output, temp_output_buffer, *output_length );
4527 else
Janos Follath315b51c2018-07-09 16:04:51 +01004528 status = PSA_ERROR_BUFFER_TOO_SMALL;
mohammad1603503973b2018-03-12 15:59:30 +02004529
Steven Cooremanef8575e2020-09-11 11:44:50 +02004530exit:
4531 if( operation->mbedtls_in_use == 1 )
4532 mbedtls_platform_zeroize( temp_output_buffer, sizeof( temp_output_buffer ) );
Janos Follath315b51c2018-07-09 16:04:51 +01004533
Steven Cooremanef8575e2020-09-11 11:44:50 +02004534 if( status == PSA_SUCCESS )
4535 return( psa_cipher_abort( operation ) );
4536 else
4537 {
4538 *output_length = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004539 (void) psa_cipher_abort( operation );
Janos Follath315b51c2018-07-09 16:04:51 +01004540
Steven Cooremanef8575e2020-09-11 11:44:50 +02004541 return( status );
4542 }
mohammad1603503973b2018-03-12 15:59:30 +02004543}
4544
Gilles Peskinee553c652018-06-04 16:22:46 +02004545psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
4546{
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004547 if( operation->alg == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02004548 {
Steven Cooremana07b9972020-09-10 14:54:14 +02004549 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02004550 * in use. It's ok to call abort on such an object, and there's
4551 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004552 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02004553 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004554
Gilles Peskinef9c2c092018-06-21 16:57:07 +02004555 /* Sanity check (shouldn't happen: operation->alg should
4556 * always have been initialized to a valid value). */
4557 if( ! PSA_ALG_IS_CIPHER( operation->alg ) )
4558 return( PSA_ERROR_BAD_STATE );
4559
Steven Cooremanef8575e2020-09-11 11:44:50 +02004560 if( operation->mbedtls_in_use == 0 )
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004561 psa_driver_wrapper_cipher_abort( &operation->ctx.driver );
Steven Cooremand3feccd2020-09-01 15:56:14 +02004562 else
4563 mbedtls_cipher_free( &operation->ctx.cipher );
Gilles Peskinee553c652018-06-04 16:22:46 +02004564
Moran Peker41deec42018-04-04 15:43:05 +03004565 operation->alg = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004566 operation->key_set = 0;
4567 operation->iv_set = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004568 operation->mbedtls_in_use = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004569 operation->iv_size = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004570 operation->block_size = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004571 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004572
Moran Peker395db872018-05-31 14:07:14 +03004573 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02004574}
4575
Gilles Peskinea0655c32018-04-30 17:06:50 +02004576
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004577
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004578
mohammad16035955c982018-04-26 00:53:03 +03004579/****************************************************************/
4580/* AEAD */
4581/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004582
Gilles Peskineedf9a652018-08-17 18:11:56 +02004583typedef struct
4584{
Gilles Peskine2f060a82018-12-04 17:12:32 +01004585 psa_key_slot_t *slot;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004586 const mbedtls_cipher_info_t *cipher_info;
4587 union
4588 {
4589#if defined(MBEDTLS_CCM_C)
4590 mbedtls_ccm_context ccm;
4591#endif /* MBEDTLS_CCM_C */
4592#if defined(MBEDTLS_GCM_C)
4593 mbedtls_gcm_context gcm;
4594#endif /* MBEDTLS_GCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004595#if defined(MBEDTLS_CHACHAPOLY_C)
4596 mbedtls_chachapoly_context chachapoly;
4597#endif /* MBEDTLS_CHACHAPOLY_C */
Gilles Peskineedf9a652018-08-17 18:11:56 +02004598 } ctx;
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004599 psa_algorithm_t core_alg;
4600 uint8_t full_tag_length;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004601 uint8_t tag_length;
4602} aead_operation_t;
4603
Gilles Peskine30a9e412019-01-14 18:36:12 +01004604static void psa_aead_abort_internal( aead_operation_t *operation )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004605{
Gilles Peskinef8a8fe62018-08-21 16:38:05 +02004606 switch( operation->core_alg )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004607 {
4608#if defined(MBEDTLS_CCM_C)
4609 case PSA_ALG_CCM:
4610 mbedtls_ccm_free( &operation->ctx.ccm );
4611 break;
4612#endif /* MBEDTLS_CCM_C */
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004613#if defined(MBEDTLS_GCM_C)
Gilles Peskineedf9a652018-08-17 18:11:56 +02004614 case PSA_ALG_GCM:
4615 mbedtls_gcm_free( &operation->ctx.gcm );
4616 break;
4617#endif /* MBEDTLS_GCM_C */
4618 }
4619}
4620
4621static psa_status_t psa_aead_setup( aead_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01004622 psa_key_handle_t handle,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004623 psa_key_usage_t usage,
4624 psa_algorithm_t alg )
4625{
4626 psa_status_t status;
4627 size_t key_bits;
4628 mbedtls_cipher_id_t cipher_id;
4629
Gilles Peskine28f8f302019-07-24 13:30:31 +02004630 status = psa_get_transparent_key( handle, &operation->slot, usage, alg );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004631 if( status != PSA_SUCCESS )
4632 return( status );
4633
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02004634 key_bits = psa_get_key_slot_bits( operation->slot );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004635
4636 operation->cipher_info =
Gilles Peskine8e338702019-07-30 20:06:31 +02004637 mbedtls_cipher_info_from_psa( alg, operation->slot->attr.type, key_bits,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004638 &cipher_id );
4639 if( operation->cipher_info == NULL )
4640 return( PSA_ERROR_NOT_SUPPORTED );
4641
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004642 switch( PSA_ALG_AEAD_WITH_TAG_LENGTH( alg, 0 ) )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004643 {
4644#if defined(MBEDTLS_CCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004645 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CCM, 0 ):
4646 operation->core_alg = PSA_ALG_CCM;
4647 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004648 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.
4649 * The call to mbedtls_ccm_encrypt_and_tag or
4650 * mbedtls_ccm_auth_decrypt will validate the tag length. */
Gilles Peskine8e338702019-07-30 20:06:31 +02004651 if( PSA_BLOCK_CIPHER_BLOCK_SIZE( operation->slot->attr.type ) != 16 )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004652 return( PSA_ERROR_INVALID_ARGUMENT );
4653 mbedtls_ccm_init( &operation->ctx.ccm );
4654 status = mbedtls_to_psa_error(
4655 mbedtls_ccm_setkey( &operation->ctx.ccm, cipher_id,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004656 operation->slot->data.key.data,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004657 (unsigned int) key_bits ) );
4658 if( status != 0 )
4659 goto cleanup;
4660 break;
4661#endif /* MBEDTLS_CCM_C */
4662
4663#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004664 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_GCM, 0 ):
4665 operation->core_alg = PSA_ALG_GCM;
4666 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004667 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16.
4668 * The call to mbedtls_gcm_crypt_and_tag or
4669 * mbedtls_gcm_auth_decrypt will validate the tag length. */
Gilles Peskine8e338702019-07-30 20:06:31 +02004670 if( PSA_BLOCK_CIPHER_BLOCK_SIZE( operation->slot->attr.type ) != 16 )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004671 return( PSA_ERROR_INVALID_ARGUMENT );
4672 mbedtls_gcm_init( &operation->ctx.gcm );
4673 status = mbedtls_to_psa_error(
4674 mbedtls_gcm_setkey( &operation->ctx.gcm, cipher_id,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004675 operation->slot->data.key.data,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004676 (unsigned int) key_bits ) );
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004677 if( status != 0 )
4678 goto cleanup;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004679 break;
4680#endif /* MBEDTLS_GCM_C */
4681
Gilles Peskine26869f22019-05-06 15:25:00 +02004682#if defined(MBEDTLS_CHACHAPOLY_C)
4683 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CHACHA20_POLY1305, 0 ):
4684 operation->core_alg = PSA_ALG_CHACHA20_POLY1305;
4685 operation->full_tag_length = 16;
4686 /* We only support the default tag length. */
4687 if( alg != PSA_ALG_CHACHA20_POLY1305 )
4688 return( PSA_ERROR_NOT_SUPPORTED );
4689 mbedtls_chachapoly_init( &operation->ctx.chachapoly );
4690 status = mbedtls_to_psa_error(
4691 mbedtls_chachapoly_setkey( &operation->ctx.chachapoly,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004692 operation->slot->data.key.data ) );
Gilles Peskine26869f22019-05-06 15:25:00 +02004693 if( status != 0 )
4694 goto cleanup;
4695 break;
4696#endif /* MBEDTLS_CHACHAPOLY_C */
4697
Gilles Peskineedf9a652018-08-17 18:11:56 +02004698 default:
4699 return( PSA_ERROR_NOT_SUPPORTED );
4700 }
4701
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004702 if( PSA_AEAD_TAG_LENGTH( alg ) > operation->full_tag_length )
4703 {
4704 status = PSA_ERROR_INVALID_ARGUMENT;
4705 goto cleanup;
4706 }
4707 operation->tag_length = PSA_AEAD_TAG_LENGTH( alg );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004708
Gilles Peskineedf9a652018-08-17 18:11:56 +02004709 return( PSA_SUCCESS );
4710
4711cleanup:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004712 psa_aead_abort_internal( operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004713 return( status );
4714}
4715
Gilles Peskinec5487a82018-12-03 18:08:14 +01004716psa_status_t psa_aead_encrypt( psa_key_handle_t handle,
mohammad16035955c982018-04-26 00:53:03 +03004717 psa_algorithm_t alg,
4718 const uint8_t *nonce,
4719 size_t nonce_length,
4720 const uint8_t *additional_data,
4721 size_t additional_data_length,
4722 const uint8_t *plaintext,
4723 size_t plaintext_length,
4724 uint8_t *ciphertext,
4725 size_t ciphertext_size,
4726 size_t *ciphertext_length )
4727{
mohammad16035955c982018-04-26 00:53:03 +03004728 psa_status_t status;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004729 aead_operation_t operation;
mohammad160315223a82018-06-03 17:19:55 +03004730 uint8_t *tag;
Gilles Peskine2d277862018-06-18 15:41:12 +02004731
mohammad1603f08a5502018-06-03 15:05:47 +03004732 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004733
Gilles Peskinec5487a82018-12-03 18:08:14 +01004734 status = psa_aead_setup( &operation, handle, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004735 if( status != PSA_SUCCESS )
4736 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004737
Gilles Peskineedf9a652018-08-17 18:11:56 +02004738 /* For all currently supported modes, the tag is at the end of the
4739 * ciphertext. */
4740 if( ciphertext_size < ( plaintext_length + operation.tag_length ) )
4741 {
4742 status = PSA_ERROR_BUFFER_TOO_SMALL;
4743 goto exit;
4744 }
4745 tag = ciphertext + plaintext_length;
mohammad16035955c982018-04-26 00:53:03 +03004746
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004747#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004748 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03004749 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004750 status = mbedtls_to_psa_error(
4751 mbedtls_gcm_crypt_and_tag( &operation.ctx.gcm,
4752 MBEDTLS_GCM_ENCRYPT,
4753 plaintext_length,
4754 nonce, nonce_length,
4755 additional_data, additional_data_length,
4756 plaintext, ciphertext,
4757 operation.tag_length, tag ) );
mohammad16035955c982018-04-26 00:53:03 +03004758 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004759 else
4760#endif /* MBEDTLS_GCM_C */
4761#if defined(MBEDTLS_CCM_C)
4762 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03004763 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004764 status = mbedtls_to_psa_error(
4765 mbedtls_ccm_encrypt_and_tag( &operation.ctx.ccm,
4766 plaintext_length,
4767 nonce, nonce_length,
4768 additional_data,
4769 additional_data_length,
4770 plaintext, ciphertext,
4771 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03004772 }
mohammad16035c8845f2018-05-09 05:40:09 -07004773 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004774#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004775#if defined(MBEDTLS_CHACHAPOLY_C)
4776 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
4777 {
4778 if( nonce_length != 12 || operation.tag_length != 16 )
4779 {
4780 status = PSA_ERROR_NOT_SUPPORTED;
4781 goto exit;
4782 }
4783 status = mbedtls_to_psa_error(
4784 mbedtls_chachapoly_encrypt_and_tag( &operation.ctx.chachapoly,
4785 plaintext_length,
4786 nonce,
4787 additional_data,
4788 additional_data_length,
4789 plaintext,
4790 ciphertext,
4791 tag ) );
4792 }
4793 else
4794#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad16035c8845f2018-05-09 05:40:09 -07004795 {
mohammad1603554faad2018-06-03 15:07:38 +03004796 return( PSA_ERROR_NOT_SUPPORTED );
mohammad16035c8845f2018-05-09 05:40:09 -07004797 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004798
Gilles Peskineedf9a652018-08-17 18:11:56 +02004799 if( status != PSA_SUCCESS && ciphertext_size != 0 )
4800 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02004801
Gilles Peskineedf9a652018-08-17 18:11:56 +02004802exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004803 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004804 if( status == PSA_SUCCESS )
4805 *ciphertext_length = plaintext_length + operation.tag_length;
4806 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004807}
4808
Gilles Peskineee652a32018-06-01 19:23:52 +02004809/* Locate the tag in a ciphertext buffer containing the encrypted data
4810 * followed by the tag. Return the length of the part preceding the tag in
4811 * *plaintext_length. This is the size of the plaintext in modes where
4812 * the encrypted data has the same size as the plaintext, such as
4813 * CCM and GCM. */
4814static psa_status_t psa_aead_unpadded_locate_tag( size_t tag_length,
4815 const uint8_t *ciphertext,
4816 size_t ciphertext_length,
4817 size_t plaintext_size,
Gilles Peskineee652a32018-06-01 19:23:52 +02004818 const uint8_t **p_tag )
4819{
4820 size_t payload_length;
4821 if( tag_length > ciphertext_length )
4822 return( PSA_ERROR_INVALID_ARGUMENT );
4823 payload_length = ciphertext_length - tag_length;
4824 if( payload_length > plaintext_size )
4825 return( PSA_ERROR_BUFFER_TOO_SMALL );
4826 *p_tag = ciphertext + payload_length;
Gilles Peskineee652a32018-06-01 19:23:52 +02004827 return( PSA_SUCCESS );
4828}
4829
Gilles Peskinec5487a82018-12-03 18:08:14 +01004830psa_status_t psa_aead_decrypt( psa_key_handle_t handle,
mohammad16035955c982018-04-26 00:53:03 +03004831 psa_algorithm_t alg,
4832 const uint8_t *nonce,
4833 size_t nonce_length,
4834 const uint8_t *additional_data,
4835 size_t additional_data_length,
4836 const uint8_t *ciphertext,
4837 size_t ciphertext_length,
4838 uint8_t *plaintext,
4839 size_t plaintext_size,
4840 size_t *plaintext_length )
4841{
mohammad16035955c982018-04-26 00:53:03 +03004842 psa_status_t status;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004843 aead_operation_t operation;
4844 const uint8_t *tag = NULL;
Gilles Peskine2d277862018-06-18 15:41:12 +02004845
Gilles Peskineee652a32018-06-01 19:23:52 +02004846 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004847
Gilles Peskinec5487a82018-12-03 18:08:14 +01004848 status = psa_aead_setup( &operation, handle, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004849 if( status != PSA_SUCCESS )
4850 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004851
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004852 status = psa_aead_unpadded_locate_tag( operation.tag_length,
4853 ciphertext, ciphertext_length,
4854 plaintext_size, &tag );
4855 if( status != PSA_SUCCESS )
4856 goto exit;
4857
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004858#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004859 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03004860 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004861 status = mbedtls_to_psa_error(
4862 mbedtls_gcm_auth_decrypt( &operation.ctx.gcm,
4863 ciphertext_length - operation.tag_length,
4864 nonce, nonce_length,
4865 additional_data,
4866 additional_data_length,
4867 tag, operation.tag_length,
4868 ciphertext, plaintext ) );
mohammad16035955c982018-04-26 00:53:03 +03004869 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004870 else
4871#endif /* MBEDTLS_GCM_C */
4872#if defined(MBEDTLS_CCM_C)
4873 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03004874 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004875 status = mbedtls_to_psa_error(
4876 mbedtls_ccm_auth_decrypt( &operation.ctx.ccm,
4877 ciphertext_length - operation.tag_length,
4878 nonce, nonce_length,
4879 additional_data,
4880 additional_data_length,
4881 ciphertext, plaintext,
4882 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03004883 }
mohammad160339574652018-06-01 04:39:53 -07004884 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004885#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004886#if defined(MBEDTLS_CHACHAPOLY_C)
4887 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
4888 {
4889 if( nonce_length != 12 || operation.tag_length != 16 )
4890 {
4891 status = PSA_ERROR_NOT_SUPPORTED;
4892 goto exit;
4893 }
4894 status = mbedtls_to_psa_error(
4895 mbedtls_chachapoly_auth_decrypt( &operation.ctx.chachapoly,
4896 ciphertext_length - operation.tag_length,
4897 nonce,
4898 additional_data,
4899 additional_data_length,
4900 tag,
4901 ciphertext,
4902 plaintext ) );
4903 }
4904 else
4905#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad160339574652018-06-01 04:39:53 -07004906 {
mohammad1603554faad2018-06-03 15:07:38 +03004907 return( PSA_ERROR_NOT_SUPPORTED );
mohammad160339574652018-06-01 04:39:53 -07004908 }
Gilles Peskinea40d7742018-06-01 16:28:30 +02004909
Gilles Peskineedf9a652018-08-17 18:11:56 +02004910 if( status != PSA_SUCCESS && plaintext_size != 0 )
4911 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03004912
Gilles Peskineedf9a652018-08-17 18:11:56 +02004913exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004914 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004915 if( status == PSA_SUCCESS )
4916 *plaintext_length = ciphertext_length - operation.tag_length;
4917 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004918}
4919
Gilles Peskinea0655c32018-04-30 17:06:50 +02004920
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004921
Gilles Peskine20035e32018-02-03 22:44:14 +01004922/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02004923/* Generators */
4924/****************************************************************/
4925
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004926#define HKDF_STATE_INIT 0 /* no input yet */
4927#define HKDF_STATE_STARTED 1 /* got salt */
4928#define HKDF_STATE_KEYED 2 /* got key */
4929#define HKDF_STATE_OUTPUT 3 /* output started */
4930
Gilles Peskinecbe66502019-05-16 16:59:18 +02004931static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004932 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004933{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004934 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
4935 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004936 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004937 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004938}
4939
4940
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004941psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004942{
4943 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004944 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004945 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004946 {
4947 /* The object has (apparently) been initialized but it is not
4948 * in use. It's ok to call abort on such an object, and there's
4949 * nothing to do. */
4950 }
4951 else
Gilles Peskinebef7f142018-07-12 17:22:21 +02004952#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004953 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004954 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004955 mbedtls_free( operation->ctx.hkdf.info );
4956 status = psa_hmac_abort_internal( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004957 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01004958 else if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004959 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004960 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004961 {
Janos Follath6a1d2622019-06-11 10:37:28 +01004962 if( operation->ctx.tls12_prf.seed != NULL )
4963 {
4964 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
4965 operation->ctx.tls12_prf.seed_length );
4966 mbedtls_free( operation->ctx.tls12_prf.seed );
4967 }
4968
4969 if( operation->ctx.tls12_prf.label != NULL )
4970 {
4971 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
4972 operation->ctx.tls12_prf.label_length );
4973 mbedtls_free( operation->ctx.tls12_prf.label );
4974 }
4975
4976 status = psa_hmac_abort_internal( &operation->ctx.tls12_prf.hmac );
4977
4978 /* We leave the fields Ai and output_block to be erased safely by the
4979 * mbedtls_platform_zeroize() in the end of this function. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004980 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004981 else
4982#endif /* MBEDTLS_MD_C */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004983 {
4984 status = PSA_ERROR_BAD_STATE;
4985 }
Janos Follath083036a2019-06-11 10:22:26 +01004986 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004987 return( status );
4988}
4989
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004990psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02004991 size_t *capacity)
4992{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004993 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004994 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004995 /* This is a blank key derivation operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02004996 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004997 }
4998
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004999 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005000 return( PSA_SUCCESS );
5001}
5002
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005003psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005004 size_t capacity )
5005{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005006 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005007 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005008 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005009 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005010 operation->capacity = capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005011 return( PSA_SUCCESS );
5012}
5013
Gilles Peskinebef7f142018-07-12 17:22:21 +02005014#if defined(MBEDTLS_MD_C)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005015/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02005016 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02005017static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskinebef7f142018-07-12 17:22:21 +02005018 psa_algorithm_t hash_alg,
5019 uint8_t *output,
5020 size_t output_length )
5021{
5022 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
5023 psa_status_t status;
5024
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005025 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
5026 return( PSA_ERROR_BAD_STATE );
5027 hkdf->state = HKDF_STATE_OUTPUT;
5028
Gilles Peskinebef7f142018-07-12 17:22:21 +02005029 while( output_length != 0 )
5030 {
5031 /* Copy what remains of the current block */
5032 uint8_t n = hash_length - hkdf->offset_in_block;
5033 if( n > output_length )
5034 n = (uint8_t) output_length;
5035 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
5036 output += n;
5037 output_length -= n;
5038 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02005039 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02005040 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02005041 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005042 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005043 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02005044 * object was corrupted or if this function is called directly
5045 * inside the library. */
5046 if( hkdf->block_number == 0xff )
5047 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02005048
5049 /* We need a new block */
5050 ++hkdf->block_number;
5051 hkdf->offset_in_block = 0;
5052 status = psa_hmac_setup_internal( &hkdf->hmac,
5053 hkdf->prk, hash_length,
5054 hash_alg );
5055 if( status != PSA_SUCCESS )
5056 return( status );
5057 if( hkdf->block_number != 1 )
5058 {
5059 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5060 hkdf->output_block,
5061 hash_length );
5062 if( status != PSA_SUCCESS )
5063 return( status );
5064 }
5065 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5066 hkdf->info,
5067 hkdf->info_length );
5068 if( status != PSA_SUCCESS )
5069 return( status );
5070 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5071 &hkdf->block_number, 1 );
5072 if( status != PSA_SUCCESS )
5073 return( status );
5074 status = psa_hmac_finish_internal( &hkdf->hmac,
5075 hkdf->output_block,
5076 sizeof( hkdf->output_block ) );
5077 if( status != PSA_SUCCESS )
5078 return( status );
5079 }
5080
5081 return( PSA_SUCCESS );
5082}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005083
Janos Follath7742fee2019-06-17 12:58:10 +01005084static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
5085 psa_tls12_prf_key_derivation_t *tls12_prf,
5086 psa_algorithm_t alg )
5087{
5088 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
5089 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
Janos Follathea29bfb2019-06-19 12:21:20 +01005090 psa_hash_operation_t backup = PSA_HASH_OPERATION_INIT;
5091 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005092
Janos Follath7742fee2019-06-17 12:58:10 +01005093 /* We can't be wanting more output after block 0xff, otherwise
5094 * the capacity check in psa_key_derivation_output_bytes() would have
5095 * prevented this call. It could happen only if the operation
5096 * object was corrupted or if this function is called directly
5097 * inside the library. */
5098 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01005099 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01005100
5101 /* We need a new block */
5102 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01005103 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01005104
5105 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
5106 *
5107 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
5108 *
5109 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
5110 * HMAC_hash(secret, A(2) + seed) +
5111 * HMAC_hash(secret, A(3) + seed) + ...
5112 *
5113 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01005114 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01005115 *
Janos Follathea29bfb2019-06-19 12:21:20 +01005116 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01005117 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01005118 * is currently extracted as `output_block` and where i is
5119 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01005120 */
5121
Janos Follathea29bfb2019-06-19 12:21:20 +01005122 /* Save the hash context before using it, to preserve the hash state with
5123 * only the inner padding in it. We need this, because inner padding depends
5124 * on the key (secret in the RFC's terminology). */
5125 status = psa_hash_clone( &tls12_prf->hmac.hash_ctx, &backup );
5126 if( status != PSA_SUCCESS )
5127 goto cleanup;
5128
5129 /* Calculate A(i) where i = tls12_prf->block_number. */
5130 if( tls12_prf->block_number == 1 )
5131 {
5132 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
5133 * the variable seed and in this instance means it in the context of the
5134 * P_hash function, where seed = label + seed.) */
5135 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5136 tls12_prf->label, tls12_prf->label_length );
5137 if( status != PSA_SUCCESS )
5138 goto cleanup;
5139 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5140 tls12_prf->seed, tls12_prf->seed_length );
5141 if( status != PSA_SUCCESS )
5142 goto cleanup;
5143 }
5144 else
5145 {
5146 /* A(i) = HMAC_hash(secret, A(i-1)) */
5147 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5148 tls12_prf->Ai, hash_length );
5149 if( status != PSA_SUCCESS )
5150 goto cleanup;
5151 }
5152
5153 status = psa_hmac_finish_internal( &tls12_prf->hmac,
5154 tls12_prf->Ai, hash_length );
5155 if( status != PSA_SUCCESS )
5156 goto cleanup;
5157 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
5158 if( status != PSA_SUCCESS )
5159 goto cleanup;
5160
5161 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
5162 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5163 tls12_prf->Ai, hash_length );
5164 if( status != PSA_SUCCESS )
5165 goto cleanup;
5166 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5167 tls12_prf->label, tls12_prf->label_length );
5168 if( status != PSA_SUCCESS )
5169 goto cleanup;
5170 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5171 tls12_prf->seed, tls12_prf->seed_length );
5172 if( status != PSA_SUCCESS )
5173 goto cleanup;
5174 status = psa_hmac_finish_internal( &tls12_prf->hmac,
5175 tls12_prf->output_block, hash_length );
5176 if( status != PSA_SUCCESS )
5177 goto cleanup;
5178 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
5179 if( status != PSA_SUCCESS )
5180 goto cleanup;
5181
Janos Follath7742fee2019-06-17 12:58:10 +01005182
5183cleanup:
5184
Janos Follathea29bfb2019-06-19 12:21:20 +01005185 cleanup_status = psa_hash_abort( &backup );
5186 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
5187 status = cleanup_status;
5188
5189 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01005190}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005191
Janos Follath844eb0e2019-06-19 12:10:49 +01005192static psa_status_t psa_key_derivation_tls12_prf_read(
5193 psa_tls12_prf_key_derivation_t *tls12_prf,
5194 psa_algorithm_t alg,
5195 uint8_t *output,
5196 size_t output_length )
5197{
5198 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
5199 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
5200 psa_status_t status;
5201 uint8_t offset, length;
5202
5203 while( output_length != 0 )
5204 {
5205 /* Check if we have fully processed the current block. */
5206 if( tls12_prf->left_in_block == 0 )
5207 {
5208 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
5209 alg );
5210 if( status != PSA_SUCCESS )
5211 return( status );
5212
5213 continue;
5214 }
5215
5216 if( tls12_prf->left_in_block > output_length )
5217 length = (uint8_t) output_length;
5218 else
5219 length = tls12_prf->left_in_block;
5220
5221 offset = hash_length - tls12_prf->left_in_block;
5222 memcpy( output, tls12_prf->output_block + offset, length );
5223 output += length;
5224 output_length -= length;
5225 tls12_prf->left_in_block -= length;
5226 }
5227
5228 return( PSA_SUCCESS );
5229}
Gilles Peskinebef7f142018-07-12 17:22:21 +02005230#endif /* MBEDTLS_MD_C */
5231
Janos Follath6c6c8fc2019-06-17 12:38:20 +01005232psa_status_t psa_key_derivation_output_bytes(
5233 psa_key_derivation_operation_t *operation,
5234 uint8_t *output,
5235 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005236{
5237 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005238 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005239
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005240 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005241 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005242 /* This is a blank operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02005243 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005244 }
5245
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005246 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005247 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005248 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005249 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005250 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02005251 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005252 goto exit;
5253 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005254 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005255 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005256 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005257 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02005258 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
5259 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005260 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02005261 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02005262 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005263 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005264 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005265
Gilles Peskinebef7f142018-07-12 17:22:21 +02005266#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005267 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02005268 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01005269 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005270 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02005271 output, output_length );
5272 }
Janos Follathadbec812019-06-14 11:05:39 +01005273 else
Janos Follathadbec812019-06-14 11:05:39 +01005274 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine969c5d62019-01-16 15:53:06 +01005275 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005276 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005277 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005278 kdf_alg, output,
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005279 output_length );
5280 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005281 else
5282#endif /* MBEDTLS_MD_C */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005283 {
5284 return( PSA_ERROR_BAD_STATE );
5285 }
5286
5287exit:
5288 if( status != PSA_SUCCESS )
5289 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005290 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005291 * This allows us to differentiate between exhausted operations and
5292 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
5293 * operations. */
5294 psa_algorithm_t alg = operation->alg;
5295 psa_key_derivation_abort( operation );
5296 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005297 memset( output, '!', output_length );
5298 }
5299 return( status );
5300}
5301
Gilles Peskine08542d82018-07-19 17:05:42 +02005302#if defined(MBEDTLS_DES_C)
5303static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
5304{
5305 if( data_size >= 8 )
5306 mbedtls_des_key_set_parity( data );
5307 if( data_size >= 16 )
5308 mbedtls_des_key_set_parity( data + 8 );
5309 if( data_size >= 24 )
5310 mbedtls_des_key_set_parity( data + 16 );
5311}
5312#endif /* MBEDTLS_DES_C */
5313
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005314static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005315 psa_key_slot_t *slot,
5316 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005317 psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005318{
5319 uint8_t *data = NULL;
5320 size_t bytes = PSA_BITS_TO_BYTES( bits );
5321 psa_status_t status;
5322
Gilles Peskine8e338702019-07-30 20:06:31 +02005323 if( ! key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005324 return( PSA_ERROR_INVALID_ARGUMENT );
5325 if( bits % 8 != 0 )
5326 return( PSA_ERROR_INVALID_ARGUMENT );
5327 data = mbedtls_calloc( 1, bytes );
5328 if( data == NULL )
5329 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5330
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005331 status = psa_key_derivation_output_bytes( operation, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005332 if( status != PSA_SUCCESS )
5333 goto exit;
Gilles Peskine08542d82018-07-19 17:05:42 +02005334#if defined(MBEDTLS_DES_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02005335 if( slot->attr.type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02005336 psa_des_set_key_parity( data, bytes );
5337#endif /* MBEDTLS_DES_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005338 status = psa_import_key_into_slot( slot, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005339
5340exit:
5341 mbedtls_free( data );
5342 return( status );
5343}
5344
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005345psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005346 psa_key_derivation_operation_t *operation,
Gilles Peskine98dd7792019-05-15 19:43:49 +02005347 psa_key_handle_t *handle )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005348{
5349 psa_status_t status;
5350 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005351 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02005352
5353 /* Reject any attempt to create a zero-length key so that we don't
5354 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
5355 if( psa_get_key_bits( attributes ) == 0 )
5356 return( PSA_ERROR_INVALID_ARGUMENT );
5357
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005358 if( ! operation->can_output_key )
5359 return( PSA_ERROR_NOT_PERMITTED );
5360
Gilles Peskinedf179142019-07-15 22:02:14 +02005361 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE,
5362 attributes, handle, &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02005363#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
5364 if( driver != NULL )
5365 {
5366 /* Deriving a key in a secure element is not implemented yet. */
5367 status = PSA_ERROR_NOT_SUPPORTED;
5368 }
5369#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005370 if( status == PSA_SUCCESS )
5371 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005372 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02005373 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005374 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005375 }
5376 if( status == PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02005377 status = psa_finish_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005378 if( status != PSA_SUCCESS )
5379 {
Gilles Peskine011e4282019-06-26 18:34:38 +02005380 psa_fail_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005381 *handle = 0;
5382 }
5383 return( status );
5384}
5385
Gilles Peskineeab56e42018-07-12 17:12:33 +02005386
5387
5388/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02005389/* Key derivation */
5390/****************************************************************/
5391
Gilles Peskine969c5d62019-01-16 15:53:06 +01005392static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005393 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005394 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005395{
Janos Follath5fe19732019-06-20 15:09:30 +01005396 /* Make sure that operation->ctx is properly zero-initialised. (Macro
5397 * initialisers for this union leave some bytes unspecified.) */
5398 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
5399
Gilles Peskine969c5d62019-01-16 15:53:06 +01005400 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005401#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005402 if( PSA_ALG_IS_HKDF( kdf_alg ) ||
5403 PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
5404 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005405 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01005406 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005407 size_t hash_size = PSA_HASH_SIZE( hash_alg );
5408 if( hash_size == 0 )
5409 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005410 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
5411 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02005412 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005413 {
5414 return( PSA_ERROR_NOT_SUPPORTED );
5415 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005416 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01005417 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005418 }
5419#endif /* MBEDTLS_MD_C */
Gilles Peskine969c5d62019-01-16 15:53:06 +01005420 else
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005421 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005422}
5423
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005424psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005425 psa_algorithm_t alg )
5426{
5427 psa_status_t status;
5428
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005429 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005430 return( PSA_ERROR_BAD_STATE );
5431
Gilles Peskine6843c292019-01-18 16:44:49 +01005432 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
5433 return( PSA_ERROR_INVALID_ARGUMENT );
5434 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005435 {
5436 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005437 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005438 }
5439 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
5440 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005441 status = psa_key_derivation_setup_kdf( operation, alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005442 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005443 else
5444 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005445
5446 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005447 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01005448 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005449}
5450
5451#if defined(MBEDTLS_MD_C)
Gilles Peskinecbe66502019-05-16 16:59:18 +02005452static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005453 psa_algorithm_t hash_alg,
5454 psa_key_derivation_step_t step,
5455 const uint8_t *data,
5456 size_t data_length )
5457{
5458 psa_status_t status;
5459 switch( step )
5460 {
Gilles Peskine03410b52019-05-16 16:05:19 +02005461 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02005462 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005463 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005464 status = psa_hmac_setup_internal( &hkdf->hmac,
5465 data, data_length,
5466 hash_alg );
5467 if( status != PSA_SUCCESS )
5468 return( status );
5469 hkdf->state = HKDF_STATE_STARTED;
5470 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02005471 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005472 /* If no salt was provided, use an empty salt. */
5473 if( hkdf->state == HKDF_STATE_INIT )
5474 {
5475 status = psa_hmac_setup_internal( &hkdf->hmac,
5476 NULL, 0,
Gilles Peskinef9ee6332019-04-11 21:22:52 +02005477 hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005478 if( status != PSA_SUCCESS )
5479 return( status );
5480 hkdf->state = HKDF_STATE_STARTED;
5481 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02005482 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005483 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005484 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5485 data, data_length );
5486 if( status != PSA_SUCCESS )
5487 return( status );
5488 status = psa_hmac_finish_internal( &hkdf->hmac,
5489 hkdf->prk,
5490 sizeof( hkdf->prk ) );
5491 if( status != PSA_SUCCESS )
5492 return( status );
5493 hkdf->offset_in_block = PSA_HASH_SIZE( hash_alg );
5494 hkdf->block_number = 0;
5495 hkdf->state = HKDF_STATE_KEYED;
5496 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02005497 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005498 if( hkdf->state == HKDF_STATE_OUTPUT )
5499 return( PSA_ERROR_BAD_STATE );
5500 if( hkdf->info_set )
5501 return( PSA_ERROR_BAD_STATE );
5502 hkdf->info_length = data_length;
5503 if( data_length != 0 )
5504 {
5505 hkdf->info = mbedtls_calloc( 1, data_length );
5506 if( hkdf->info == NULL )
5507 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5508 memcpy( hkdf->info, data, data_length );
5509 }
5510 hkdf->info_set = 1;
5511 return( PSA_SUCCESS );
5512 default:
5513 return( PSA_ERROR_INVALID_ARGUMENT );
5514 }
5515}
Janos Follathb03233e2019-06-11 15:30:30 +01005516
Janos Follathf08e2652019-06-13 09:05:41 +01005517static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
5518 const uint8_t *data,
5519 size_t data_length )
5520{
5521 if( prf->state != TLS12_PRF_STATE_INIT )
5522 return( PSA_ERROR_BAD_STATE );
5523
Janos Follathd6dce9f2019-07-04 09:11:38 +01005524 if( data_length != 0 )
5525 {
5526 prf->seed = mbedtls_calloc( 1, data_length );
5527 if( prf->seed == NULL )
5528 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01005529
Janos Follathd6dce9f2019-07-04 09:11:38 +01005530 memcpy( prf->seed, data, data_length );
5531 prf->seed_length = data_length;
5532 }
Janos Follathf08e2652019-06-13 09:05:41 +01005533
5534 prf->state = TLS12_PRF_STATE_SEED_SET;
5535
5536 return( PSA_SUCCESS );
5537}
5538
Janos Follath81550542019-06-13 14:26:34 +01005539static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
5540 psa_algorithm_t hash_alg,
5541 const uint8_t *data,
5542 size_t data_length )
5543{
5544 psa_status_t status;
5545 if( prf->state != TLS12_PRF_STATE_SEED_SET )
5546 return( PSA_ERROR_BAD_STATE );
5547
5548 status = psa_hmac_setup_internal( &prf->hmac, data, data_length, hash_alg );
5549 if( status != PSA_SUCCESS )
5550 return( status );
5551
5552 prf->state = TLS12_PRF_STATE_KEY_SET;
5553
5554 return( PSA_SUCCESS );
5555}
5556
Janos Follath6660f0e2019-06-17 08:44:03 +01005557static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
5558 psa_tls12_prf_key_derivation_t *prf,
5559 psa_algorithm_t hash_alg,
5560 const uint8_t *data,
5561 size_t data_length )
5562{
5563 psa_status_t status;
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02005564 uint8_t pms[ 4 + 2 * PSA_ALG_TLS12_PSK_TO_MS_MAX_PSK_LEN ];
5565 uint8_t *cur = pms;
Janos Follath6660f0e2019-06-17 08:44:03 +01005566
5567 if( data_length > PSA_ALG_TLS12_PSK_TO_MS_MAX_PSK_LEN )
5568 return( PSA_ERROR_INVALID_ARGUMENT );
5569
5570 /* Quoting RFC 4279, Section 2:
5571 *
5572 * The premaster secret is formed as follows: if the PSK is N octets
5573 * long, concatenate a uint16 with the value N, N zero octets, a second
5574 * uint16 with the value N, and the PSK itself.
5575 */
5576
Janos Follath40e13932019-06-26 13:22:29 +01005577 *cur++ = ( data_length >> 8 ) & 0xff;
5578 *cur++ = ( data_length >> 0 ) & 0xff;
5579 memset( cur, 0, data_length );
5580 cur += data_length;
5581 *cur++ = pms[0];
5582 *cur++ = pms[1];
5583 memcpy( cur, data, data_length );
5584 cur += data_length;
Janos Follath6660f0e2019-06-17 08:44:03 +01005585
Janos Follath40e13932019-06-26 13:22:29 +01005586 status = psa_tls12_prf_set_key( prf, hash_alg, pms, cur - pms );
Janos Follath6660f0e2019-06-17 08:44:03 +01005587
5588 mbedtls_platform_zeroize( pms, sizeof( pms ) );
5589 return( status );
5590}
5591
Janos Follath63028dd2019-06-13 09:15:47 +01005592static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
5593 const uint8_t *data,
5594 size_t data_length )
5595{
5596 if( prf->state != TLS12_PRF_STATE_KEY_SET )
5597 return( PSA_ERROR_BAD_STATE );
5598
Janos Follathd6dce9f2019-07-04 09:11:38 +01005599 if( data_length != 0 )
5600 {
5601 prf->label = mbedtls_calloc( 1, data_length );
5602 if( prf->label == NULL )
5603 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01005604
Janos Follathd6dce9f2019-07-04 09:11:38 +01005605 memcpy( prf->label, data, data_length );
5606 prf->label_length = data_length;
5607 }
Janos Follath63028dd2019-06-13 09:15:47 +01005608
5609 prf->state = TLS12_PRF_STATE_LABEL_SET;
5610
5611 return( PSA_SUCCESS );
5612}
5613
Janos Follathb03233e2019-06-11 15:30:30 +01005614static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
5615 psa_algorithm_t hash_alg,
5616 psa_key_derivation_step_t step,
5617 const uint8_t *data,
5618 size_t data_length )
5619{
Janos Follathb03233e2019-06-11 15:30:30 +01005620 switch( step )
5621 {
Janos Follathf08e2652019-06-13 09:05:41 +01005622 case PSA_KEY_DERIVATION_INPUT_SEED:
5623 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01005624 case PSA_KEY_DERIVATION_INPUT_SECRET:
5625 return( psa_tls12_prf_set_key( prf, hash_alg, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01005626 case PSA_KEY_DERIVATION_INPUT_LABEL:
5627 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01005628 default:
5629 return( PSA_ERROR_INVALID_ARGUMENT );
5630 }
5631}
Janos Follath6660f0e2019-06-17 08:44:03 +01005632
5633static psa_status_t psa_tls12_prf_psk_to_ms_input(
5634 psa_tls12_prf_key_derivation_t *prf,
5635 psa_algorithm_t hash_alg,
5636 psa_key_derivation_step_t step,
5637 const uint8_t *data,
5638 size_t data_length )
5639{
5640 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01005641 {
Janos Follath6660f0e2019-06-17 08:44:03 +01005642 return( psa_tls12_prf_psk_to_ms_set_key( prf, hash_alg,
5643 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01005644 }
Janos Follath6660f0e2019-06-17 08:44:03 +01005645
5646 return( psa_tls12_prf_input( prf, hash_alg, step, data, data_length ) );
5647}
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005648#endif /* MBEDTLS_MD_C */
5649
Gilles Peskineb8965192019-09-24 16:21:10 +02005650/** Check whether the given key type is acceptable for the given
5651 * input step of a key derivation.
5652 *
5653 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
5654 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
5655 * Both secret and non-secret inputs can alternatively have the type
5656 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
5657 * that the input was passed as a buffer rather than via a key object.
5658 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02005659static int psa_key_derivation_check_input_type(
5660 psa_key_derivation_step_t step,
5661 psa_key_type_t key_type )
5662{
5663 switch( step )
5664 {
5665 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb8965192019-09-24 16:21:10 +02005666 if( key_type == PSA_KEY_TYPE_DERIVE )
5667 return( PSA_SUCCESS );
5668 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005669 return( PSA_SUCCESS );
5670 break;
5671 case PSA_KEY_DERIVATION_INPUT_LABEL:
5672 case PSA_KEY_DERIVATION_INPUT_SALT:
5673 case PSA_KEY_DERIVATION_INPUT_INFO:
5674 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskineb8965192019-09-24 16:21:10 +02005675 if( key_type == PSA_KEY_TYPE_RAW_DATA )
5676 return( PSA_SUCCESS );
5677 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005678 return( PSA_SUCCESS );
5679 break;
5680 }
5681 return( PSA_ERROR_INVALID_ARGUMENT );
5682}
5683
Janos Follathb80a94e2019-06-12 15:54:46 +01005684static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005685 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005686 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005687 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005688 const uint8_t *data,
5689 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005690{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02005691 psa_status_t status;
5692 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
5693
5694 status = psa_key_derivation_check_input_type( step, key_type );
Gilles Peskine224b0d62019-09-23 18:13:17 +02005695 if( status != PSA_SUCCESS )
5696 goto exit;
5697
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005698#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005699 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005700 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005701 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005702 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005703 step, data, data_length );
5704 }
k-stachowiak012dcc42019-08-13 14:55:03 +02005705 else if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005706 {
Janos Follathb03233e2019-06-11 15:30:30 +01005707 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
5708 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5709 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01005710 }
5711 else if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
5712 {
5713 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
5714 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5715 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005716 }
5717 else
5718#endif /* MBEDTLS_MD_C */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005719 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005720 /* This can't happen unless the operation object was not initialized */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005721 return( PSA_ERROR_BAD_STATE );
5722 }
5723
Gilles Peskine224b0d62019-09-23 18:13:17 +02005724exit:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005725 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005726 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005727 return( status );
5728}
5729
Janos Follath51f4a0f2019-06-14 11:35:55 +01005730psa_status_t psa_key_derivation_input_bytes(
5731 psa_key_derivation_operation_t *operation,
5732 psa_key_derivation_step_t step,
5733 const uint8_t *data,
5734 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005735{
Gilles Peskineb8965192019-09-24 16:21:10 +02005736 return( psa_key_derivation_input_internal( operation, step,
5737 PSA_KEY_TYPE_NONE,
Janos Follathc5621512019-06-14 11:27:57 +01005738 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005739}
5740
Janos Follath51f4a0f2019-06-14 11:35:55 +01005741psa_status_t psa_key_derivation_input_key(
5742 psa_key_derivation_operation_t *operation,
5743 psa_key_derivation_step_t step,
5744 psa_key_handle_t handle )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005745{
5746 psa_key_slot_t *slot;
5747 psa_status_t status;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005748
Gilles Peskine28f8f302019-07-24 13:30:31 +02005749 status = psa_get_transparent_key( handle, &slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02005750 PSA_KEY_USAGE_DERIVE,
5751 operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005752 if( status != PSA_SUCCESS )
Gilles Peskine593773d2019-09-23 18:17:40 +02005753 {
5754 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005755 return( status );
Gilles Peskine593773d2019-09-23 18:17:40 +02005756 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005757
5758 /* Passing a key object as a SECRET input unlocks the permission
5759 * to output to a key object. */
5760 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5761 operation->can_output_key = 1;
5762
Janos Follathb80a94e2019-06-12 15:54:46 +01005763 return( psa_key_derivation_input_internal( operation,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005764 step, slot->attr.type,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02005765 slot->data.key.data,
5766 slot->data.key.bytes ) );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005767}
Gilles Peskineea0fb492018-07-12 17:17:20 +02005768
5769
5770
5771/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02005772/* Key agreement */
5773/****************************************************************/
5774
Gilles Peskinea05219c2018-11-16 16:02:56 +01005775#if defined(MBEDTLS_ECDH_C)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005776static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
5777 size_t peer_key_length,
5778 const mbedtls_ecp_keypair *our_key,
5779 uint8_t *shared_secret,
5780 size_t shared_secret_size,
5781 size_t *shared_secret_length )
5782{
Steven Cooremand4867872020-08-05 16:31:39 +02005783 mbedtls_ecp_keypair *their_key = NULL;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005784 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00005785 psa_status_t status;
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005786 size_t bits = 0;
Paul Elliott8ff510a2020-06-02 17:19:28 +01005787 psa_ecc_family_t curve = mbedtls_ecc_group_to_psa( our_key->grp.id, &bits );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005788 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005789
Steven Cooreman4fed4552020-08-03 14:46:03 +02005790 status = psa_load_ecp_representation( PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve),
5791 peer_key,
Steven Cooreman7f391872020-07-30 14:57:44 +02005792 peer_key_length,
Steven Cooreman7f391872020-07-30 14:57:44 +02005793 &their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00005794 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005795 goto exit;
5796
Jaeden Amero97271b32019-01-10 19:38:51 +00005797 status = mbedtls_to_psa_error(
Steven Cooremana2371e52020-07-28 14:30:39 +02005798 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
Jaeden Amero97271b32019-01-10 19:38:51 +00005799 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005800 goto exit;
Jaeden Amero97271b32019-01-10 19:38:51 +00005801 status = mbedtls_to_psa_error(
5802 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
5803 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005804 goto exit;
5805
Jaeden Amero97271b32019-01-10 19:38:51 +00005806 status = mbedtls_to_psa_error(
5807 mbedtls_ecdh_calc_secret( &ecdh,
5808 shared_secret_length,
5809 shared_secret, shared_secret_size,
5810 mbedtls_ctr_drbg_random,
5811 &global_data.ctr_drbg ) );
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005812 if( status != PSA_SUCCESS )
5813 goto exit;
5814 if( PSA_BITS_TO_BYTES( bits ) != *shared_secret_length )
5815 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005816
5817exit:
Gilles Peskine3e819b72019-12-20 14:09:55 +01005818 if( status != PSA_SUCCESS )
5819 mbedtls_platform_zeroize( shared_secret, shared_secret_size );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005820 mbedtls_ecdh_free( &ecdh );
Steven Cooremana2371e52020-07-28 14:30:39 +02005821 mbedtls_ecp_keypair_free( their_key );
Steven Cooreman6d839f02020-07-30 11:36:45 +02005822 mbedtls_free( their_key );
Steven Cooremana2371e52020-07-28 14:30:39 +02005823
Jaeden Amero97271b32019-01-10 19:38:51 +00005824 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005825}
Gilles Peskinea05219c2018-11-16 16:02:56 +01005826#endif /* MBEDTLS_ECDH_C */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005827
Gilles Peskine01d718c2018-09-18 12:01:02 +02005828#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
5829
Gilles Peskine0216fe12019-04-11 21:23:21 +02005830static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
5831 psa_key_slot_t *private_key,
5832 const uint8_t *peer_key,
5833 size_t peer_key_length,
5834 uint8_t *shared_secret,
5835 size_t shared_secret_size,
5836 size_t *shared_secret_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005837{
Gilles Peskine0216fe12019-04-11 21:23:21 +02005838 switch( alg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005839 {
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005840#if defined(MBEDTLS_ECDH_C)
Gilles Peskine0216fe12019-04-11 21:23:21 +02005841 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02005842 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005843 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremana2371e52020-07-28 14:30:39 +02005844 mbedtls_ecp_keypair *ecp = NULL;
Steven Cooreman7f391872020-07-30 14:57:44 +02005845 psa_status_t status = psa_load_ecp_representation(
Steven Cooreman4fed4552020-08-03 14:46:03 +02005846 private_key->attr.type,
Steven Cooreman7f391872020-07-30 14:57:44 +02005847 private_key->data.key.data,
5848 private_key->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02005849 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02005850 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02005851 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02005852 status = psa_key_agreement_ecdh( peer_key, peer_key_length,
Steven Cooremana2371e52020-07-28 14:30:39 +02005853 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02005854 shared_secret, shared_secret_size,
5855 shared_secret_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02005856 mbedtls_ecp_keypair_free( ecp );
5857 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02005858 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005859#endif /* MBEDTLS_ECDH_C */
Gilles Peskine01d718c2018-09-18 12:01:02 +02005860 default:
Gilles Peskine93f85002018-11-16 16:43:31 +01005861 (void) private_key;
5862 (void) peer_key;
5863 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02005864 (void) shared_secret;
5865 (void) shared_secret_size;
5866 (void) shared_secret_length;
Gilles Peskine01d718c2018-09-18 12:01:02 +02005867 return( PSA_ERROR_NOT_SUPPORTED );
5868 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02005869}
5870
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005871/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02005872 * to potentially free embedded data structures and wipe confidential data.
5873 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005874static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005875 psa_key_derivation_step_t step,
Gilles Peskine01d718c2018-09-18 12:01:02 +02005876 psa_key_slot_t *private_key,
5877 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005878 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005879{
5880 psa_status_t status;
5881 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
5882 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005883 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005884
5885 /* Step 1: run the secret agreement algorithm to generate the shared
5886 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02005887 status = psa_key_agreement_raw_internal( ka_alg,
5888 private_key,
5889 peer_key, peer_key_length,
itayzafrir0adf0fc2018-09-06 16:24:41 +03005890 shared_secret,
5891 sizeof( shared_secret ),
Gilles Peskine05d69892018-06-19 22:00:52 +02005892 &shared_secret_length );
Gilles Peskine53d991e2018-07-12 01:14:59 +02005893 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005894 goto exit;
5895
Gilles Peskineb0b255c2018-07-06 17:01:38 +02005896 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02005897 * the shared secret. A shared secret is permitted wherever a key
5898 * of type DERIVE is permitted. */
Janos Follathb80a94e2019-06-12 15:54:46 +01005899 status = psa_key_derivation_input_internal( operation, step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005900 PSA_KEY_TYPE_DERIVE,
Janos Follathb80a94e2019-06-12 15:54:46 +01005901 shared_secret,
5902 shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005903exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01005904 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005905 return( status );
5906}
5907
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005908psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005909 psa_key_derivation_step_t step,
5910 psa_key_handle_t private_key,
5911 const uint8_t *peer_key,
5912 size_t peer_key_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005913{
Gilles Peskine2f060a82018-12-04 17:12:32 +01005914 psa_key_slot_t *slot;
Gilles Peskine08542d82018-07-19 17:05:42 +02005915 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005916 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005917 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine28f8f302019-07-24 13:30:31 +02005918 status = psa_get_transparent_key( private_key, &slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02005919 PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005920 if( status != PSA_SUCCESS )
5921 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005922 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01005923 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005924 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01005925 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005926 psa_key_derivation_abort( operation );
Steven Cooremanfa5e6312020-10-15 17:07:12 +02005927 else
5928 {
5929 /* If a private key has been added as SECRET, we allow the derived
5930 * key material to be used as a key in PSA Crypto. */
5931 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5932 operation->can_output_key = 1;
5933 }
Gilles Peskine346797d2018-11-16 16:05:06 +01005934 return( status );
Gilles Peskineaf3baab2018-06-27 22:55:52 +02005935}
5936
Gilles Peskinebe697d82019-05-16 18:00:41 +02005937psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
5938 psa_key_handle_t private_key,
5939 const uint8_t *peer_key,
5940 size_t peer_key_length,
5941 uint8_t *output,
5942 size_t output_size,
5943 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02005944{
5945 psa_key_slot_t *slot;
5946 psa_status_t status;
5947
5948 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
5949 {
5950 status = PSA_ERROR_INVALID_ARGUMENT;
5951 goto exit;
5952 }
Gilles Peskine28f8f302019-07-24 13:30:31 +02005953 status = psa_get_transparent_key( private_key, &slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02005954 PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02005955 if( status != PSA_SUCCESS )
5956 goto exit;
5957
5958 status = psa_key_agreement_raw_internal( alg, slot,
5959 peer_key, peer_key_length,
5960 output, output_size,
5961 output_length );
5962
5963exit:
5964 if( status != PSA_SUCCESS )
5965 {
5966 /* If an error happens and is not handled properly, the output
5967 * may be used as a key to protect sensitive data. Arrange for such
5968 * a key to be random, which is likely to result in decryption or
5969 * verification errors. This is better than filling the buffer with
5970 * some constant data such as zeros, which would result in the data
5971 * being protected with a reproducible, easily knowable key.
5972 */
5973 psa_generate_random( output, output_size );
5974 *output_length = output_size;
5975 }
5976 return( status );
5977}
Gilles Peskine86a440b2018-11-12 18:39:40 +01005978
5979
5980/****************************************************************/
5981/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02005982/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02005983
Gilles Peskine4c317f42018-07-12 01:24:09 +02005984psa_status_t psa_generate_random( uint8_t *output,
Gilles Peskine53d991e2018-07-12 01:14:59 +02005985 size_t output_size )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005986{
Janos Follath24eed8d2019-11-22 13:21:35 +00005987 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005988 GUARD_MODULE_INITIALIZED;
5989
Gilles Peskinef181eca2019-08-07 13:49:00 +02005990 while( output_size > MBEDTLS_CTR_DRBG_MAX_REQUEST )
5991 {
5992 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg,
5993 output,
5994 MBEDTLS_CTR_DRBG_MAX_REQUEST );
5995 if( ret != 0 )
5996 return( mbedtls_to_psa_error( ret ) );
5997 output += MBEDTLS_CTR_DRBG_MAX_REQUEST;
5998 output_size -= MBEDTLS_CTR_DRBG_MAX_REQUEST;
5999 }
6000
Gilles Peskinee59236f2018-01-27 23:32:46 +01006001 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg, output, output_size );
6002 return( mbedtls_to_psa_error( ret ) );
6003}
6004
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01006005#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
6006#include "mbedtls/entropy_poll.h"
6007
Gilles Peskine7228da22019-07-15 11:06:15 +02006008psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006009 size_t seed_size )
6010{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006011 if( global_data.initialized )
6012 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02006013
6014 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
6015 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
6016 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
6017 return( PSA_ERROR_INVALID_ARGUMENT );
6018
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01006019 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006020}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01006021#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006022
Gilles Peskinee56e8782019-04-26 17:34:02 +02006023#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_GENPRIME)
6024static psa_status_t psa_read_rsa_exponent( const uint8_t *domain_parameters,
6025 size_t domain_parameters_size,
6026 int *exponent )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006027{
Gilles Peskinee56e8782019-04-26 17:34:02 +02006028 size_t i;
6029 uint32_t acc = 0;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006030
Gilles Peskinee56e8782019-04-26 17:34:02 +02006031 if( domain_parameters_size == 0 )
6032 {
6033 *exponent = 65537;
6034 return( PSA_SUCCESS );
6035 }
6036
6037 /* Mbed TLS encodes the public exponent as an int. For simplicity, only
6038 * support values that fit in a 32-bit integer, which is larger than
6039 * int on just about every platform anyway. */
6040 if( domain_parameters_size > sizeof( acc ) )
6041 return( PSA_ERROR_NOT_SUPPORTED );
6042 for( i = 0; i < domain_parameters_size; i++ )
6043 acc = ( acc << 8 ) | domain_parameters[i];
6044 if( acc > INT_MAX )
6045 return( PSA_ERROR_NOT_SUPPORTED );
6046 *exponent = acc;
6047 return( PSA_SUCCESS );
6048}
6049#endif /* MBEDTLS_RSA_C && MBEDTLS_GENPRIME */
6050
Gilles Peskine35ef36b2019-05-16 19:42:05 +02006051static psa_status_t psa_generate_key_internal(
Gilles Peskinee56e8782019-04-26 17:34:02 +02006052 psa_key_slot_t *slot, size_t bits,
6053 const uint8_t *domain_parameters, size_t domain_parameters_size )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006054{
Gilles Peskine8e338702019-07-30 20:06:31 +02006055 psa_key_type_t type = slot->attr.type;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006056
Gilles Peskinee56e8782019-04-26 17:34:02 +02006057 if( domain_parameters == NULL && domain_parameters_size != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006058 return( PSA_ERROR_INVALID_ARGUMENT );
6059
Gilles Peskinee59236f2018-01-27 23:32:46 +01006060 if( key_type_is_raw_bytes( type ) )
6061 {
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006062 psa_status_t status;
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006063
6064 status = validate_unstructured_key_bit_size( slot->attr.type, bits );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006065 if( status != PSA_SUCCESS )
6066 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006067
6068 /* Allocate memory for the key */
Steven Cooreman75b74362020-07-28 14:30:13 +02006069 status = psa_allocate_buffer_to_slot( slot, PSA_BITS_TO_BYTES( bits ) );
6070 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02006071 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006072
Steven Cooreman71fd80d2020-07-07 21:12:27 +02006073 status = psa_generate_random( slot->data.key.data,
6074 slot->data.key.bytes );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006075 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006076 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006077
6078 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006079#if defined(MBEDTLS_DES_C)
6080 if( type == PSA_KEY_TYPE_DES )
Steven Cooreman71fd80d2020-07-07 21:12:27 +02006081 psa_des_set_key_parity( slot->data.key.data,
6082 slot->data.key.bytes );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006083#endif /* MBEDTLS_DES_C */
6084 }
6085 else
6086
6087#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_GENPRIME)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02006088 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006089 {
Steven Cooremana01795d2020-07-24 22:48:15 +02006090 mbedtls_rsa_context rsa;
Janos Follath24eed8d2019-11-22 13:21:35 +00006091 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee56e8782019-04-26 17:34:02 +02006092 int exponent;
6093 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006094 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
6095 return( PSA_ERROR_NOT_SUPPORTED );
6096 /* Accept only byte-aligned keys, for the same reasons as
6097 * in psa_import_rsa_key(). */
6098 if( bits % 8 != 0 )
6099 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinee56e8782019-04-26 17:34:02 +02006100 status = psa_read_rsa_exponent( domain_parameters,
6101 domain_parameters_size,
6102 &exponent );
6103 if( status != PSA_SUCCESS )
6104 return( status );
Steven Cooremana01795d2020-07-24 22:48:15 +02006105 mbedtls_rsa_init( &rsa, MBEDTLS_RSA_PKCS_V15, MBEDTLS_MD_NONE );
6106 ret = mbedtls_rsa_gen_key( &rsa,
Gilles Peskinee59236f2018-01-27 23:32:46 +01006107 mbedtls_ctr_drbg_random,
6108 &global_data.ctr_drbg,
6109 (unsigned int) bits,
6110 exponent );
6111 if( ret != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006112 return( mbedtls_to_psa_error( ret ) );
Steven Cooremana01795d2020-07-24 22:48:15 +02006113
6114 /* Make sure to always have an export representation available */
6115 size_t bytes = PSA_KEY_EXPORT_RSA_KEY_PAIR_MAX_SIZE( bits );
6116
Steven Cooreman75b74362020-07-28 14:30:13 +02006117 status = psa_allocate_buffer_to_slot( slot, bytes );
6118 if( status != PSA_SUCCESS )
Steven Cooremana01795d2020-07-24 22:48:15 +02006119 {
6120 mbedtls_rsa_free( &rsa );
Steven Cooreman29149862020-08-05 15:43:42 +02006121 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006122 }
Steven Cooremana01795d2020-07-24 22:48:15 +02006123
6124 status = psa_export_rsa_key( type,
6125 &rsa,
6126 slot->data.key.data,
6127 bytes,
6128 &slot->data.key.bytes );
6129 mbedtls_rsa_free( &rsa );
6130 if( status != PSA_SUCCESS )
Steven Cooremana01795d2020-07-24 22:48:15 +02006131 psa_remove_key_data_from_memory( slot );
Steven Cooreman560c28a2020-07-24 23:20:24 +02006132 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006133 }
6134 else
6135#endif /* MBEDTLS_RSA_C && MBEDTLS_GENPRIME */
6136
6137#if defined(MBEDTLS_ECP_C)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02006138 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006139 {
Paul Elliott8ff510a2020-06-02 17:19:28 +01006140 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY( type );
Gilles Peskine4295e8b2019-12-02 21:39:10 +01006141 mbedtls_ecp_group_id grp_id =
6142 mbedtls_ecc_group_of_psa( curve, PSA_BITS_TO_BYTES( bits ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006143 const mbedtls_ecp_curve_info *curve_info =
6144 mbedtls_ecp_curve_info_from_grp_id( grp_id );
Steven Cooremanacda8342020-07-24 23:09:52 +02006145 mbedtls_ecp_keypair ecp;
Janos Follath24eed8d2019-11-22 13:21:35 +00006146 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee56e8782019-04-26 17:34:02 +02006147 if( domain_parameters_size != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006148 return( PSA_ERROR_NOT_SUPPORTED );
6149 if( grp_id == MBEDTLS_ECP_DP_NONE || curve_info == NULL )
6150 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooremanacda8342020-07-24 23:09:52 +02006151 mbedtls_ecp_keypair_init( &ecp );
6152 ret = mbedtls_ecp_gen_key( grp_id, &ecp,
Gilles Peskinee59236f2018-01-27 23:32:46 +01006153 mbedtls_ctr_drbg_random,
6154 &global_data.ctr_drbg );
6155 if( ret != 0 )
6156 {
Steven Cooremanacda8342020-07-24 23:09:52 +02006157 mbedtls_ecp_keypair_free( &ecp );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006158 return( mbedtls_to_psa_error( ret ) );
6159 }
Steven Cooremanacda8342020-07-24 23:09:52 +02006160
6161
6162 /* Make sure to always have an export representation available */
6163 size_t bytes = PSA_BITS_TO_BYTES( bits );
Steven Cooreman75b74362020-07-28 14:30:13 +02006164 psa_status_t status = psa_allocate_buffer_to_slot( slot, bytes );
6165 if( status != PSA_SUCCESS )
Steven Cooremanacda8342020-07-24 23:09:52 +02006166 {
6167 mbedtls_ecp_keypair_free( &ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02006168 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02006169 }
Steven Cooreman75b74362020-07-28 14:30:13 +02006170
6171 status = mbedtls_to_psa_error(
Steven Cooremanacda8342020-07-24 23:09:52 +02006172 mbedtls_ecp_write_key( &ecp, slot->data.key.data, bytes ) );
6173
6174 mbedtls_ecp_keypair_free( &ecp );
Steven Cooremanb7f6dea2020-08-05 16:07:20 +02006175 if( status != PSA_SUCCESS ) {
6176 memset( slot->data.key.data, 0, bytes );
Steven Cooremanacda8342020-07-24 23:09:52 +02006177 psa_remove_key_data_from_memory( slot );
Steven Cooremanb7f6dea2020-08-05 16:07:20 +02006178 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02006179 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006180 }
6181 else
6182#endif /* MBEDTLS_ECP_C */
Steven Cooreman29149862020-08-05 15:43:42 +02006183 {
Gilles Peskinee59236f2018-01-27 23:32:46 +01006184 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman29149862020-08-05 15:43:42 +02006185 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01006186
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006187 return( PSA_SUCCESS );
6188}
Darryl Green0c6575a2018-11-07 16:05:30 +00006189
Gilles Peskine35ef36b2019-05-16 19:42:05 +02006190psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Gilles Peskinee56e8782019-04-26 17:34:02 +02006191 psa_key_handle_t *handle )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006192{
6193 psa_status_t status;
6194 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02006195 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine11792082019-08-06 18:36:36 +02006196
Gilles Peskine0f84d622019-09-12 19:03:13 +02006197 /* Reject any attempt to create a zero-length key so that we don't
6198 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
6199 if( psa_get_key_bits( attributes ) == 0 )
6200 return( PSA_ERROR_INVALID_ARGUMENT );
6201
Gilles Peskinedf179142019-07-15 22:02:14 +02006202 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE,
6203 attributes, handle, &slot, &driver );
Gilles Peskine11792082019-08-06 18:36:36 +02006204 if( status != PSA_SUCCESS )
6205 goto exit;
6206
Steven Cooreman2a1664c2020-07-20 15:33:08 +02006207 status = psa_driver_wrapper_generate_key( attributes,
6208 slot );
6209 if( status != PSA_ERROR_NOT_SUPPORTED ||
6210 psa_key_lifetime_is_external( attributes->core.lifetime ) )
6211 goto exit;
6212
6213 status = psa_generate_key_internal(
6214 slot, attributes->core.bits,
6215 attributes->domain_parameters, attributes->domain_parameters_size );
Gilles Peskine11792082019-08-06 18:36:36 +02006216
6217exit:
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006218 if( status == PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02006219 status = psa_finish_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006220 if( status != PSA_SUCCESS )
6221 {
Gilles Peskine011e4282019-06-26 18:34:38 +02006222 psa_fail_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006223 *handle = 0;
6224 }
Darryl Green0c6575a2018-11-07 16:05:30 +00006225 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006226}
6227
6228
Gilles Peskinee59236f2018-01-27 23:32:46 +01006229
6230/****************************************************************/
6231/* Module setup */
6232/****************************************************************/
6233
Gilles Peskine5e769522018-11-20 21:59:56 +01006234psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
6235 void (* entropy_init )( mbedtls_entropy_context *ctx ),
6236 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
6237{
6238 if( global_data.rng_state != RNG_NOT_INITIALIZED )
6239 return( PSA_ERROR_BAD_STATE );
6240 global_data.entropy_init = entropy_init;
6241 global_data.entropy_free = entropy_free;
6242 return( PSA_SUCCESS );
6243}
6244
Gilles Peskinee59236f2018-01-27 23:32:46 +01006245void mbedtls_psa_crypto_free( void )
6246{
Gilles Peskine66fb1262018-12-10 16:29:04 +01006247 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006248 if( global_data.rng_state != RNG_NOT_INITIALIZED )
6249 {
6250 mbedtls_ctr_drbg_free( &global_data.ctr_drbg );
Gilles Peskine5e769522018-11-20 21:59:56 +01006251 global_data.entropy_free( &global_data.entropy );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006252 }
6253 /* Wipe all remaining data, including configuration.
6254 * In particular, this sets all state indicator to the value
6255 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01006256 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Gilles Peskinea8ade162019-06-26 11:24:49 +02006257#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +02006258 /* Unregister all secure element drivers, so that we restart from
6259 * a pristine state. */
6260 psa_unregister_all_se_drivers( );
Gilles Peskinea8ade162019-06-26 11:24:49 +02006261#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006262}
6263
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006264#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
6265/** Recover a transaction that was interrupted by a power failure.
6266 *
6267 * This function is called during initialization, before psa_crypto_init()
6268 * returns. If this function returns a failure status, the initialization
6269 * fails.
6270 */
6271static psa_status_t psa_crypto_recover_transaction(
6272 const psa_crypto_transaction_t *transaction )
6273{
6274 switch( transaction->unknown.type )
6275 {
6276 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
6277 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01006278 /* TODO - fall through to the failure case until this
Gilles Peskinec9d7f942019-08-13 16:17:16 +02006279 * is implemented.
6280 * https://github.com/ARMmbed/mbed-crypto/issues/218
6281 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006282 default:
6283 /* We found an unsupported transaction in the storage.
6284 * We don't know what state the storage is in. Give up. */
6285 return( PSA_ERROR_STORAGE_FAILURE );
6286 }
6287}
6288#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
6289
Gilles Peskinee59236f2018-01-27 23:32:46 +01006290psa_status_t psa_crypto_init( void )
6291{
Gilles Peskine66fb1262018-12-10 16:29:04 +01006292 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006293 const unsigned char drbg_seed[] = "PSA";
6294
Gilles Peskinec6b69072018-11-20 21:42:52 +01006295 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006296 if( global_data.initialized != 0 )
6297 return( PSA_SUCCESS );
6298
Gilles Peskine5e769522018-11-20 21:59:56 +01006299 /* Set default configuration if
6300 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
6301 if( global_data.entropy_init == NULL )
6302 global_data.entropy_init = mbedtls_entropy_init;
6303 if( global_data.entropy_free == NULL )
6304 global_data.entropy_free = mbedtls_entropy_free;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006305
Gilles Peskinec6b69072018-11-20 21:42:52 +01006306 /* Initialize the random generator. */
Gilles Peskine5e769522018-11-20 21:59:56 +01006307 global_data.entropy_init( &global_data.entropy );
Jaeden Amero76541612019-06-04 17:14:43 +01006308#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
6309 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
6310 /* The PSA entropy injection feature depends on using NV seed as an entropy
6311 * source. Add NV seed as an entropy source for PSA entropy injection. */
6312 mbedtls_entropy_add_source( &global_data.entropy,
6313 mbedtls_nv_seed_poll, NULL,
6314 MBEDTLS_ENTROPY_BLOCK_SIZE,
6315 MBEDTLS_ENTROPY_SOURCE_STRONG );
6316#endif
Gilles Peskinee59236f2018-01-27 23:32:46 +01006317 mbedtls_ctr_drbg_init( &global_data.ctr_drbg );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006318 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine66fb1262018-12-10 16:29:04 +01006319 status = mbedtls_to_psa_error(
6320 mbedtls_ctr_drbg_seed( &global_data.ctr_drbg,
6321 mbedtls_entropy_func,
6322 &global_data.entropy,
6323 drbg_seed, sizeof( drbg_seed ) - 1 ) );
6324 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006325 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01006326 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006327
Gilles Peskine66fb1262018-12-10 16:29:04 +01006328 status = psa_initialize_key_slots( );
6329 if( status != PSA_SUCCESS )
6330 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01006331
Gilles Peskined9348f22019-10-01 15:22:29 +02006332#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
6333 status = psa_init_all_se_drivers( );
6334 if( status != PSA_SUCCESS )
6335 goto exit;
6336#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
6337
Gilles Peskine4b734222019-07-24 15:56:31 +02006338#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02006339 status = psa_crypto_load_transaction( );
6340 if( status == PSA_SUCCESS )
6341 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006342 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
6343 if( status != PSA_SUCCESS )
6344 goto exit;
6345 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02006346 }
6347 else if( status == PSA_ERROR_DOES_NOT_EXIST )
6348 {
6349 /* There's no transaction to complete. It's all good. */
6350 status = PSA_SUCCESS;
6351 }
Gilles Peskine4b734222019-07-24 15:56:31 +02006352#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02006353
Gilles Peskinec6b69072018-11-20 21:42:52 +01006354 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006355 global_data.initialized = 1;
6356
6357exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01006358 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006359 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01006360 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006361}
6362
6363#endif /* MBEDTLS_PSA_CRYPTO_C */