blob: a437aeec9b916b586455b05c1fca1c8e6de4fdba [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. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001193static psa_status_t psa_get_key_from_slot( mbedtls_svc_key_id_t key,
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
Ronald Croncf56a0a2020-08-04 09:51:30 +02001203 status = psa_get_key_slot( key, &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)
Ronald Croncf56a0a2020-08-04 09:51:30 +02001233static psa_status_t psa_get_transparent_key( mbedtls_svc_key_id_t key,
Gilles Peskine28f8f302019-07-24 13:30:31 +02001234 psa_key_slot_t **p_slot,
1235 psa_key_usage_t usage,
1236 psa_algorithm_t alg )
1237{
Ronald Croncf56a0a2020-08-04 09:51:30 +02001238 psa_status_t status = psa_get_key_from_slot( key, p_slot, usage, alg );
Gilles Peskine28f8f302019-07-24 13:30:31 +02001239 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. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001250#define psa_get_transparent_key( key, p_slot, usage, alg ) \
1251 psa_get_key_from_slot( key, p_slot, usage, alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +02001252#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
Ronald Croncf56a0a2020-08-04 09:51:30 +02001294psa_status_t psa_destroy_key( mbedtls_svc_key_id_t key )
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
Ronald Croncf56a0a2020-08-04 09:51:30 +02001303 if( mbedtls_svc_key_id_is_null( key ) )
Gilles Peskine1841cf42019-10-08 15:48:25 +02001304 return( PSA_SUCCESS );
1305
Ronald Croncf56a0a2020-08-04 09:51:30 +02001306 status = psa_get_key_slot( key, &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 */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001473psa_status_t psa_get_key_attributes( mbedtls_svc_key_id_t key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001474 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
Ronald Croncf56a0a2020-08-04 09:51:30 +02001481 status = psa_get_key_from_slot( key, &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
Ronald Croncf56a0a2020-08-04 09:51:30 +02001686psa_status_t psa_export_key( mbedtls_svc_key_id_t key,
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. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001703 status = psa_get_key_from_slot( key, &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
Ronald Croncf56a0a2020-08-04 09:51:30 +02001710psa_status_t psa_export_public_key( mbedtls_svc_key_id_t key,
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. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001725 status = psa_get_key_from_slot( key, &slot, 0, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001726 if( status != PSA_SUCCESS )
1727 return( status );
1728 return( psa_internal_export_key( slot, data, data_size,
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02001729 data_length, 1 ) );
Moran Pekerdd4ea382018-04-03 15:30:03 +03001730}
1731
Gilles Peskine91e8c332019-08-02 19:19:39 +02001732#if defined(static_assert)
1733static_assert( ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
1734 "One or more key attribute flag is listed as both external-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001735static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
Gilles Peskine094dac12019-08-07 18:19:46 +02001736 "One or more key attribute flag is listed as both internal-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001737static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY ) == 0,
Gilles Peskine91e8c332019-08-02 19:19:39 +02001738 "One or more key attribute flag is listed as both internal-only and external-only" );
1739#endif
1740
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001741/** Validate that a key policy is internally well-formed.
1742 *
1743 * This function only rejects invalid policies. It does not validate the
1744 * consistency of the policy with respect to other attributes of the key
1745 * such as the key type.
1746 */
1747static psa_status_t psa_validate_key_policy( const psa_key_policy_t *policy )
Gilles Peskine4747d192019-04-17 15:05:45 +02001748{
1749 if( ( policy->usage & ~( PSA_KEY_USAGE_EXPORT |
Gilles Peskine8e0206a2019-05-14 14:24:28 +02001750 PSA_KEY_USAGE_COPY |
Gilles Peskine4747d192019-04-17 15:05:45 +02001751 PSA_KEY_USAGE_ENCRYPT |
1752 PSA_KEY_USAGE_DECRYPT |
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001753 PSA_KEY_USAGE_SIGN_HASH |
1754 PSA_KEY_USAGE_VERIFY_HASH |
Gilles Peskine4747d192019-04-17 15:05:45 +02001755 PSA_KEY_USAGE_DERIVE ) ) != 0 )
1756 return( PSA_ERROR_INVALID_ARGUMENT );
1757
Gilles Peskine4747d192019-04-17 15:05:45 +02001758 return( PSA_SUCCESS );
1759}
1760
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001761/** Validate the internal consistency of key attributes.
1762 *
1763 * This function only rejects invalid attribute values. If does not
1764 * validate the consistency of the attributes with any key data that may
1765 * be involved in the creation of the key.
1766 *
1767 * Call this function early in the key creation process.
1768 *
1769 * \param[in] attributes Key attributes for the new key.
1770 * \param[out] p_drv On any return, the driver for the key, if any.
1771 * NULL for a transparent key.
1772 *
1773 */
1774static psa_status_t psa_validate_key_attributes(
1775 const psa_key_attributes_t *attributes,
1776 psa_se_drv_table_entry_t **p_drv )
Darryl Green0c6575a2018-11-07 16:05:30 +00001777{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001778 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Ronald Crond2ed4812020-07-17 16:11:30 +02001779 psa_key_lifetime_t lifetime = psa_get_key_lifetime( attributes );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001780
Steven Cooreman8c1e7592020-06-17 14:52:05 +02001781 status = psa_validate_key_location( psa_get_key_lifetime( attributes ),
1782 p_drv );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001783 if( status != PSA_SUCCESS )
1784 return( status );
1785
Ronald Crond2ed4812020-07-17 16:11:30 +02001786 status = psa_validate_key_persistence( lifetime );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001787 if( status != PSA_SUCCESS )
1788 return( status );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001789
Ronald Crond2ed4812020-07-17 16:11:30 +02001790 /* Validate the key identifier only in the case of a persistent key. */
1791 if ( ! PSA_KEY_LIFETIME_IS_VOLATILE( lifetime ) )
1792 {
1793 status = psa_validate_key_id(
1794 psa_get_key_id( attributes ),
1795 psa_key_lifetime_is_external( lifetime ) );
1796
1797 if( status != PSA_SUCCESS )
1798 return( status );
1799 }
1800
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001801 status = psa_validate_key_policy( &attributes->core.policy );
Darryl Green0c6575a2018-11-07 16:05:30 +00001802 if( status != PSA_SUCCESS )
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001803 return( status );
1804
1805 /* Refuse to create overly large keys.
1806 * Note that this doesn't trigger on import if the attributes don't
1807 * explicitly specify a size (so psa_get_key_bits returns 0), so
1808 * psa_import_key() needs its own checks. */
1809 if( psa_get_key_bits( attributes ) > PSA_MAX_KEY_BITS )
1810 return( PSA_ERROR_NOT_SUPPORTED );
1811
Gilles Peskine91e8c332019-08-02 19:19:39 +02001812 /* Reject invalid flags. These should not be reachable through the API. */
1813 if( attributes->core.flags & ~ ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1814 MBEDTLS_PSA_KA_MASK_DUAL_USE ) )
1815 return( PSA_ERROR_INVALID_ARGUMENT );
1816
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001817 return( PSA_SUCCESS );
1818}
1819
Gilles Peskine4747d192019-04-17 15:05:45 +02001820/** Prepare a key slot to receive key material.
1821 *
1822 * This function allocates a key slot and sets its metadata.
1823 *
1824 * If this function fails, call psa_fail_key_creation().
1825 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001826 * This function is intended to be used as follows:
1827 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001828 * it with the specified attributes, and in case of a volatile key assign it
1829 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001830 * -# Populate the slot with the key material.
1831 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1832 * In case of failure at any step, stop the sequence and call
1833 * psa_fail_key_creation().
1834 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001835 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001836 * \param[in] attributes Key attributes for the new key.
Ronald Croncf56a0a2020-08-04 09:51:30 +02001837 * \param[out] key On success, identifier of the key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001838 * \param[out] p_slot On success, a pointer to the prepared slot.
1839 * \param[out] p_drv On any return, the driver for the key, if any.
1840 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001841 *
1842 * \retval #PSA_SUCCESS
1843 * The key slot is ready to receive key material.
1844 * \return If this function fails, the key slot is an invalid state.
1845 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001846 */
1847static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001848 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001849 const psa_key_attributes_t *attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02001850 mbedtls_svc_key_id_t *key,
Gilles Peskine011e4282019-06-26 18:34:38 +02001851 psa_key_slot_t **p_slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001852 psa_se_drv_table_entry_t **p_drv )
Gilles Peskine4747d192019-04-17 15:05:45 +02001853{
1854 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001855 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001856 psa_key_slot_t *slot;
1857
Gilles Peskinedf179142019-07-15 22:02:14 +02001858 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001859 *p_drv = NULL;
1860
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001861 status = psa_validate_key_attributes( attributes, p_drv );
1862 if( status != PSA_SUCCESS )
1863 return( status );
1864
Ronald Cronc4d1b512020-07-31 11:26:37 +02001865 status = psa_get_empty_key_slot( &volatile_key_id, p_slot );
Gilles Peskine4747d192019-04-17 15:05:45 +02001866 if( status != PSA_SUCCESS )
1867 return( status );
1868 slot = *p_slot;
1869
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001870 /* We're storing the declared bit-size of the key. It's up to each
1871 * creation mechanism to verify that this information is correct.
1872 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001873 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001874 * is optional (import, copy). In case of a volatile key, assign it the
1875 * volatile key identifier associated to the slot returned to contain its
1876 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001877
1878 slot->attr = attributes->core;
Ronald Cronc4d1b512020-07-31 11:26:37 +02001879 if( PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
1880 {
1881#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1882 slot->attr.id = volatile_key_id;
1883#else
1884 slot->attr.id.key_id = volatile_key_id;
1885#endif
1886 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001887
Gilles Peskine91e8c332019-08-02 19:19:39 +02001888 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001889 * external-only flags, query `attributes`. Thanks to the check
1890 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001891 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001892 * may have set. */
1893 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001894
Gilles Peskinecbaff462019-07-12 23:46:04 +02001895#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001896 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001897 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001898 * create the key file in internal storage, create the
1899 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001900 * persistent data. This is done by starting a transaction that will
1901 * encompass these three actions.
1902 * For registering a volatile key, we just need to find an appropriate
1903 * slot number inside the SE. Since the key is designated volatile, creating
1904 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001905 /* The first thing to do is to find a slot number for the new key.
1906 * We save the slot number in persistent storage as part of the
1907 * transaction data. It will be needed to recover if the power
1908 * fails during the key creation process, to clean up on the secure
1909 * element side after restarting. Obtaining a slot number from the
1910 * secure element driver updates its persistent state, but we do not yet
1911 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001912 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001913 if( *p_drv != NULL )
Darryl Green0c6575a2018-11-07 16:05:30 +00001914 {
Gilles Peskinee88c2c12019-08-05 16:44:14 +02001915 status = psa_find_se_slot_for_key( attributes, method, *p_drv,
Gilles Peskinecbaff462019-07-12 23:46:04 +02001916 &slot->data.se.slot_number );
1917 if( status != PSA_SUCCESS )
1918 return( status );
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001919
1920 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( attributes->core.lifetime ) )
Gilles Peskine66be51c2019-07-25 18:02:52 +02001921 {
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001922 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_CREATE_KEY );
1923 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
1924 psa_crypto_transaction.key.slot = slot->data.se.slot_number;
1925 psa_crypto_transaction.key.id = slot->attr.id;
1926 status = psa_crypto_save_transaction( );
1927 if( status != PSA_SUCCESS )
1928 {
1929 (void) psa_crypto_stop_transaction( );
1930 return( status );
1931 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001932 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001933 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001934
1935 if( *p_drv == NULL && method == PSA_KEY_CREATION_REGISTER )
1936 {
1937 /* Key registration only makes sense with a secure element. */
1938 return( PSA_ERROR_INVALID_ARGUMENT );
1939 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001940#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1941
Ronald Croncf56a0a2020-08-04 09:51:30 +02001942 *key = slot->attr.id;
Ronald Cronc4d1b512020-07-31 11:26:37 +02001943
1944 return( PSA_SUCCESS );
Darryl Green0c6575a2018-11-07 16:05:30 +00001945}
Gilles Peskine4747d192019-04-17 15:05:45 +02001946
1947/** Finalize the creation of a key once its key material has been set.
1948 *
1949 * This entails writing the key to persistent storage.
1950 *
1951 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001952 * See the documentation of psa_start_key_creation() for the intended use
1953 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001954 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001955 * \param[in,out] slot Pointer to the slot with key material.
1956 * \param[in] driver The secure element driver for the key,
1957 * or NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001958 *
1959 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001960 * The key was successfully created.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001961 * \return If this function fails, the key slot is an invalid state.
1962 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001963 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001964static psa_status_t psa_finish_key_creation(
1965 psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001966 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001967{
1968 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001969 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001970 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001971
1972#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Steven Cooremanc59de6a2020-06-08 18:28:25 +02001973 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Gilles Peskine4747d192019-04-17 15:05:45 +02001974 {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001975#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1976 if( driver != NULL )
1977 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001978 psa_se_key_data_storage_t data;
1979#if defined(static_assert)
1980 static_assert( sizeof( slot->data.se.slot_number ) ==
1981 sizeof( data.slot_number ),
1982 "Slot number size does not match psa_se_key_data_storage_t" );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001983#endif
1984 memcpy( &data.slot_number, &slot->data.se.slot_number,
1985 sizeof( slot->data.se.slot_number ) );
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001986 status = psa_save_persistent_key( &slot->attr,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001987 (uint8_t*) &data,
1988 sizeof( data ) );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001989 }
1990 else
1991#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1992 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001993 /* Key material is saved in export representation in the slot, so
1994 * just pass the slot buffer for storage. */
1995 status = psa_save_persistent_key( &slot->attr,
1996 slot->data.key.data,
1997 slot->data.key.bytes );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001998 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001999 }
Darryl Green0c6575a2018-11-07 16:05:30 +00002000#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
2001
Gilles Peskinecbaff462019-07-12 23:46:04 +02002002#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02002003 /* Finish the transaction for a key creation. This does not
2004 * happen when registering an existing key. Detect this case
2005 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02002006 * creation of a persistent key in a secure element requires a transaction,
2007 * but registration or volatile key creation doesn't use one). */
Gilles Peskined7729582019-08-05 15:55:54 +02002008 if( driver != NULL &&
2009 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY )
Gilles Peskinecbaff462019-07-12 23:46:04 +02002010 {
2011 status = psa_save_se_persistent_data( driver );
2012 if( status != PSA_SUCCESS )
2013 {
Gilles Peskine8e338702019-07-30 20:06:31 +02002014 psa_destroy_persistent_key( slot->attr.id );
Gilles Peskinecbaff462019-07-12 23:46:04 +02002015 return( status );
2016 }
Gilles Peskinefc762652019-07-22 19:30:34 +02002017 status = psa_crypto_stop_transaction( );
2018 if( status != PSA_SUCCESS )
2019 return( status );
Gilles Peskinecbaff462019-07-12 23:46:04 +02002020 }
2021#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2022
Gilles Peskine4747d192019-04-17 15:05:45 +02002023 return( status );
2024}
2025
2026/** Abort the creation of a key.
2027 *
2028 * You may call this function after calling psa_start_key_creation(),
2029 * or after psa_finish_key_creation() fails. In other circumstances, this
2030 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02002031 * See the documentation of psa_start_key_creation() for the intended use
2032 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02002033 *
Gilles Peskine011e4282019-06-26 18:34:38 +02002034 * \param[in,out] slot Pointer to the slot with key material.
2035 * \param[in] driver The secure element driver for the key,
2036 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02002037 */
Gilles Peskine011e4282019-06-26 18:34:38 +02002038static void psa_fail_key_creation( psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002039 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02002040{
Gilles Peskine011e4282019-06-26 18:34:38 +02002041 (void) driver;
2042
Gilles Peskine4747d192019-04-17 15:05:45 +02002043 if( slot == NULL )
2044 return;
Gilles Peskine011e4282019-06-26 18:34:38 +02002045
2046#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01002047 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02002048 * element, and the failure happened later (when saving metadata
2049 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02002050 * element.
2051 * https://github.com/ARMmbed/mbed-crypto/issues/217
2052 */
Gilles Peskinefc762652019-07-22 19:30:34 +02002053
Gilles Peskined7729582019-08-05 15:55:54 +02002054 /* Abort the ongoing transaction if any (there may not be one if
2055 * the creation process failed before starting one, or if the
2056 * key creation is a registration of a key in a secure element).
2057 * Earlier functions must already have done what it takes to undo any
2058 * partial creation. All that's left is to update the transaction data
2059 * itself. */
Gilles Peskinefc762652019-07-22 19:30:34 +02002060 (void) psa_crypto_stop_transaction( );
Gilles Peskine011e4282019-06-26 18:34:38 +02002061#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2062
Gilles Peskine4747d192019-04-17 15:05:45 +02002063 psa_wipe_key_slot( slot );
2064}
2065
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002066/** Validate optional attributes during key creation.
2067 *
2068 * Some key attributes are optional during key creation. If they are
2069 * specified in the attributes structure, check that they are consistent
2070 * with the data in the slot.
2071 *
2072 * This function should be called near the end of key creation, after
2073 * the slot in memory is fully populated but before saving persistent data.
2074 */
2075static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002076 const psa_key_slot_t *slot,
2077 const psa_key_attributes_t *attributes )
2078{
Gilles Peskine7e0cff92019-07-30 13:48:52 +02002079 if( attributes->core.type != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002080 {
Gilles Peskine8e338702019-07-30 20:06:31 +02002081 if( attributes->core.type != slot->attr.type )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002082 return( PSA_ERROR_INVALID_ARGUMENT );
2083 }
2084
2085 if( attributes->domain_parameters_size != 0 )
2086 {
2087#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02002088 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002089 {
Steven Cooremana2371e52020-07-28 14:30:39 +02002090 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02002091 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02002092 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02002093
Steven Cooreman7f391872020-07-30 14:57:44 +02002094 psa_status_t status = psa_load_rsa_representation(
Steven Cooreman4fed4552020-08-03 14:46:03 +02002095 slot->attr.type,
Steven Cooreman7f391872020-07-30 14:57:44 +02002096 slot->data.key.data,
2097 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02002098 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02002099 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02002100 return( status );
Steven Cooreman75b74362020-07-28 14:30:13 +02002101
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002102 mbedtls_mpi_init( &actual );
2103 mbedtls_mpi_init( &required );
Steven Cooremana2371e52020-07-28 14:30:39 +02002104 ret = mbedtls_rsa_export( rsa,
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002105 NULL, NULL, NULL, NULL, &actual );
Steven Cooremana2371e52020-07-28 14:30:39 +02002106 mbedtls_rsa_free( rsa );
2107 mbedtls_free( rsa );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002108 if( ret != 0 )
2109 goto rsa_exit;
2110 ret = mbedtls_mpi_read_binary( &required,
2111 attributes->domain_parameters,
2112 attributes->domain_parameters_size );
2113 if( ret != 0 )
2114 goto rsa_exit;
2115 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
2116 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
2117 rsa_exit:
2118 mbedtls_mpi_free( &actual );
2119 mbedtls_mpi_free( &required );
2120 if( ret != 0)
2121 return( mbedtls_to_psa_error( ret ) );
2122 }
2123 else
2124#endif
2125 {
2126 return( PSA_ERROR_INVALID_ARGUMENT );
2127 }
2128 }
2129
Gilles Peskine7e0cff92019-07-30 13:48:52 +02002130 if( attributes->core.bits != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002131 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02002132 if( attributes->core.bits != slot->attr.bits )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002133 return( PSA_ERROR_INVALID_ARGUMENT );
2134 }
2135
2136 return( PSA_SUCCESS );
2137}
2138
Gilles Peskine4747d192019-04-17 15:05:45 +02002139psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02002140 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02002141 size_t data_length,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002142 mbedtls_svc_key_id_t *key )
Gilles Peskine4747d192019-04-17 15:05:45 +02002143{
2144 psa_status_t status;
2145 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002146 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002147
Gilles Peskine0f84d622019-09-12 19:03:13 +02002148 /* Reject zero-length symmetric keys (including raw data key objects).
2149 * This also rejects any key which might be encoded as an empty string,
2150 * which is never valid. */
2151 if( data_length == 0 )
2152 return( PSA_ERROR_INVALID_ARGUMENT );
2153
Gilles Peskinedf179142019-07-15 22:02:14 +02002154 status = psa_start_key_creation( PSA_KEY_CREATION_IMPORT, attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002155 key, &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002156 if( status != PSA_SUCCESS )
2157 goto exit;
2158
Gilles Peskine5d309672019-07-12 23:47:28 +02002159#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2160 if( driver != NULL )
2161 {
2162 const psa_drv_se_t *drv = psa_get_se_driver_methods( driver );
Darryl Green0892d0f2019-08-20 09:50:14 +01002163 /* The driver should set the number of key bits, however in
2164 * case it doesn't, we initialize bits to an invalid value. */
2165 size_t bits = PSA_MAX_KEY_BITS + 1;
Gilles Peskine5d309672019-07-12 23:47:28 +02002166 if( drv->key_management == NULL ||
2167 drv->key_management->p_import == NULL )
2168 {
2169 status = PSA_ERROR_NOT_SUPPORTED;
2170 goto exit;
2171 }
2172 status = drv->key_management->p_import(
2173 psa_get_se_driver_context( driver ),
Gilles Peskinef3801ff2019-08-06 17:32:04 +02002174 slot->data.se.slot_number, attributes, data, data_length,
Gilles Peskineb46bef22019-07-30 21:32:04 +02002175 &bits );
2176 if( status != PSA_SUCCESS )
2177 goto exit;
2178 if( bits > PSA_MAX_KEY_BITS )
2179 {
2180 status = PSA_ERROR_NOT_SUPPORTED;
2181 goto exit;
2182 }
2183 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskine5d309672019-07-12 23:47:28 +02002184 }
2185 else
2186#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2187 {
2188 status = psa_import_key_into_slot( slot, data, data_length );
2189 if( status != PSA_SUCCESS )
2190 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02002191 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002192 status = psa_validate_optional_attributes( slot, attributes );
Gilles Peskine18017402019-07-24 20:25:59 +02002193 if( status != PSA_SUCCESS )
2194 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002195
Gilles Peskine011e4282019-06-26 18:34:38 +02002196 status = psa_finish_key_creation( slot, driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002197exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02002198 if( status != PSA_SUCCESS )
2199 {
Gilles Peskine011e4282019-06-26 18:34:38 +02002200 psa_fail_key_creation( slot, driver );
Ronald Croncf56a0a2020-08-04 09:51:30 +02002201 *key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine4747d192019-04-17 15:05:45 +02002202 }
2203 return( status );
2204}
2205
Gilles Peskined7729582019-08-05 15:55:54 +02002206#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2207psa_status_t mbedtls_psa_register_se_key(
2208 const psa_key_attributes_t *attributes )
2209{
2210 psa_status_t status;
2211 psa_key_slot_t *slot = NULL;
2212 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02002213 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02002214
2215 /* Leaving attributes unspecified is not currently supported.
2216 * It could make sense to query the key type and size from the
2217 * secure element, but not all secure elements support this
2218 * and the driver HAL doesn't currently support it. */
2219 if( psa_get_key_type( attributes ) == PSA_KEY_TYPE_NONE )
2220 return( PSA_ERROR_NOT_SUPPORTED );
2221 if( psa_get_key_bits( attributes ) == 0 )
2222 return( PSA_ERROR_NOT_SUPPORTED );
2223
2224 status = psa_start_key_creation( PSA_KEY_CREATION_REGISTER, attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002225 &key, &slot, &driver );
Gilles Peskined7729582019-08-05 15:55:54 +02002226 if( status != PSA_SUCCESS )
2227 goto exit;
2228
Gilles Peskined7729582019-08-05 15:55:54 +02002229 status = psa_finish_key_creation( slot, driver );
2230
2231exit:
2232 if( status != PSA_SUCCESS )
2233 {
2234 psa_fail_key_creation( slot, driver );
2235 }
2236 /* Registration doesn't keep the key in RAM. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02002237 psa_close_key( key );
Gilles Peskined7729582019-08-05 15:55:54 +02002238 return( status );
2239}
2240#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2241
Gilles Peskinef603c712019-01-19 13:40:11 +01002242static psa_status_t psa_copy_key_material( const psa_key_slot_t *source,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002243 psa_key_slot_t *target )
Gilles Peskinef603c712019-01-19 13:40:11 +01002244{
Steven Cooremanf7cebd42020-10-13 20:27:40 +02002245 psa_status_t status = psa_copy_key_material_into_slot( target,
2246 source->data.key.data,
2247 source->data.key.bytes );
Gilles Peskinef603c712019-01-19 13:40:11 +01002248 if( status != PSA_SUCCESS )
Steven Cooreman398aee52020-10-13 14:35:45 +02002249 return( status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002250
Steven Cooreman398aee52020-10-13 14:35:45 +02002251 target->attr.type = source->attr.type;
2252 target->attr.bits = source->attr.bits;
2253
2254 return( PSA_SUCCESS );
Gilles Peskinef603c712019-01-19 13:40:11 +01002255}
2256
Ronald Croncf56a0a2020-08-04 09:51:30 +02002257psa_status_t psa_copy_key( mbedtls_svc_key_id_t source_key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002258 const psa_key_attributes_t *specified_attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002259 mbedtls_svc_key_id_t *target_key )
Gilles Peskinef603c712019-01-19 13:40:11 +01002260{
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002261 psa_status_t status;
Gilles Peskinef603c712019-01-19 13:40:11 +01002262 psa_key_slot_t *source_slot = NULL;
2263 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002264 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002265 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskinef603c712019-01-19 13:40:11 +01002266
Ronald Croncf56a0a2020-08-04 09:51:30 +02002267 status = psa_get_transparent_key( source_key, &source_slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02002268 PSA_KEY_USAGE_COPY, 0 );
Gilles Peskinef603c712019-01-19 13:40:11 +01002269 if( status != PSA_SUCCESS )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002270 goto exit;
2271
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002272 status = psa_validate_optional_attributes( source_slot,
2273 specified_attributes );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002274 if( status != PSA_SUCCESS )
2275 goto exit;
2276
Gilles Peskine7e0cff92019-07-30 13:48:52 +02002277 status = psa_restrict_key_policy( &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02002278 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002279 if( status != PSA_SUCCESS )
2280 goto exit;
2281
Gilles Peskinedf179142019-07-15 22:02:14 +02002282 status = psa_start_key_creation( PSA_KEY_CREATION_COPY,
2283 &actual_attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002284 target_key, &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002285 if( status != PSA_SUCCESS )
2286 goto exit;
2287
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002288#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2289 if( driver != NULL )
Gilles Peskinef603c712019-01-19 13:40:11 +01002290 {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002291 /* Copying to a secure element is not implemented yet. */
2292 status = PSA_ERROR_NOT_SUPPORTED;
2293 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002294 }
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002295#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef603c712019-01-19 13:40:11 +01002296
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002297 status = psa_copy_key_material( source_slot, target_slot );
Gilles Peskinef603c712019-01-19 13:40:11 +01002298 if( status != PSA_SUCCESS )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002299 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002300
Gilles Peskine011e4282019-06-26 18:34:38 +02002301 status = psa_finish_key_creation( target_slot, driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002302exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002303 if( status != PSA_SUCCESS )
2304 {
Gilles Peskine011e4282019-06-26 18:34:38 +02002305 psa_fail_key_creation( target_slot, driver );
Ronald Croncf56a0a2020-08-04 09:51:30 +02002306 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002307 }
2308 return( status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002309}
2310
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002311
2312
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002313/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002314/* Message digests */
2315/****************************************************************/
2316
John Durkop0ea39e02020-10-13 19:58:20 -07002317#if defined(MBEDTLS_RSA_C) || defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinedc2fc842018-03-07 16:42:59 +01002318static const mbedtls_md_info_t *mbedtls_md_info_from_psa( psa_algorithm_t alg )
Gilles Peskine20035e32018-02-03 22:44:14 +01002319{
2320 switch( alg )
2321 {
2322#if defined(MBEDTLS_MD2_C)
2323 case PSA_ALG_MD2:
2324 return( &mbedtls_md2_info );
2325#endif
2326#if defined(MBEDTLS_MD4_C)
2327 case PSA_ALG_MD4:
2328 return( &mbedtls_md4_info );
2329#endif
2330#if defined(MBEDTLS_MD5_C)
2331 case PSA_ALG_MD5:
2332 return( &mbedtls_md5_info );
2333#endif
2334#if defined(MBEDTLS_RIPEMD160_C)
2335 case PSA_ALG_RIPEMD160:
2336 return( &mbedtls_ripemd160_info );
2337#endif
2338#if defined(MBEDTLS_SHA1_C)
2339 case PSA_ALG_SHA_1:
2340 return( &mbedtls_sha1_info );
2341#endif
2342#if defined(MBEDTLS_SHA256_C)
2343 case PSA_ALG_SHA_224:
2344 return( &mbedtls_sha224_info );
2345 case PSA_ALG_SHA_256:
2346 return( &mbedtls_sha256_info );
2347#endif
2348#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnardd6020842019-07-17 16:28:21 +02002349#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine20035e32018-02-03 22:44:14 +01002350 case PSA_ALG_SHA_384:
2351 return( &mbedtls_sha384_info );
Manuel Pégourié-Gonnardd6020842019-07-17 16:28:21 +02002352#endif
Gilles Peskine20035e32018-02-03 22:44:14 +01002353 case PSA_ALG_SHA_512:
2354 return( &mbedtls_sha512_info );
2355#endif
2356 default:
2357 return( NULL );
2358 }
2359}
John Durkop0ea39e02020-10-13 19:58:20 -07002360#endif /* defined(MBEDTLS_RSA_C) || defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine20035e32018-02-03 22:44:14 +01002361
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002362psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
2363{
2364 switch( operation->alg )
2365 {
Gilles Peskine81736312018-06-26 15:04:31 +02002366 case 0:
2367 /* The object has (apparently) been initialized but it is not
2368 * in use. It's ok to call abort on such an object, and there's
2369 * nothing to do. */
2370 break;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002371#if defined(MBEDTLS_MD2_C)
2372 case PSA_ALG_MD2:
2373 mbedtls_md2_free( &operation->ctx.md2 );
2374 break;
2375#endif
2376#if defined(MBEDTLS_MD4_C)
2377 case PSA_ALG_MD4:
2378 mbedtls_md4_free( &operation->ctx.md4 );
2379 break;
2380#endif
2381#if defined(MBEDTLS_MD5_C)
2382 case PSA_ALG_MD5:
2383 mbedtls_md5_free( &operation->ctx.md5 );
2384 break;
2385#endif
2386#if defined(MBEDTLS_RIPEMD160_C)
2387 case PSA_ALG_RIPEMD160:
2388 mbedtls_ripemd160_free( &operation->ctx.ripemd160 );
2389 break;
2390#endif
2391#if defined(MBEDTLS_SHA1_C)
2392 case PSA_ALG_SHA_1:
2393 mbedtls_sha1_free( &operation->ctx.sha1 );
2394 break;
2395#endif
2396#if defined(MBEDTLS_SHA256_C)
2397 case PSA_ALG_SHA_224:
2398 case PSA_ALG_SHA_256:
2399 mbedtls_sha256_free( &operation->ctx.sha256 );
2400 break;
2401#endif
2402#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002403#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002404 case PSA_ALG_SHA_384:
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002405#endif
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002406 case PSA_ALG_SHA_512:
2407 mbedtls_sha512_free( &operation->ctx.sha512 );
2408 break;
2409#endif
2410 default:
Gilles Peskinef9c2c092018-06-21 16:57:07 +02002411 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002412 }
2413 operation->alg = 0;
2414 return( PSA_SUCCESS );
2415}
2416
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002417psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002418 psa_algorithm_t alg )
2419{
Janos Follath24eed8d2019-11-22 13:21:35 +00002420 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002421
2422 /* A context must be freshly initialized before it can be set up. */
2423 if( operation->alg != 0 )
2424 {
2425 return( PSA_ERROR_BAD_STATE );
2426 }
2427
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002428 switch( alg )
2429 {
2430#if defined(MBEDTLS_MD2_C)
2431 case PSA_ALG_MD2:
2432 mbedtls_md2_init( &operation->ctx.md2 );
2433 ret = mbedtls_md2_starts_ret( &operation->ctx.md2 );
2434 break;
2435#endif
2436#if defined(MBEDTLS_MD4_C)
2437 case PSA_ALG_MD4:
2438 mbedtls_md4_init( &operation->ctx.md4 );
2439 ret = mbedtls_md4_starts_ret( &operation->ctx.md4 );
2440 break;
2441#endif
2442#if defined(MBEDTLS_MD5_C)
2443 case PSA_ALG_MD5:
2444 mbedtls_md5_init( &operation->ctx.md5 );
2445 ret = mbedtls_md5_starts_ret( &operation->ctx.md5 );
2446 break;
2447#endif
2448#if defined(MBEDTLS_RIPEMD160_C)
2449 case PSA_ALG_RIPEMD160:
2450 mbedtls_ripemd160_init( &operation->ctx.ripemd160 );
2451 ret = mbedtls_ripemd160_starts_ret( &operation->ctx.ripemd160 );
2452 break;
2453#endif
2454#if defined(MBEDTLS_SHA1_C)
2455 case PSA_ALG_SHA_1:
2456 mbedtls_sha1_init( &operation->ctx.sha1 );
2457 ret = mbedtls_sha1_starts_ret( &operation->ctx.sha1 );
2458 break;
2459#endif
2460#if defined(MBEDTLS_SHA256_C)
2461 case PSA_ALG_SHA_224:
2462 mbedtls_sha256_init( &operation->ctx.sha256 );
2463 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 1 );
2464 break;
2465 case PSA_ALG_SHA_256:
2466 mbedtls_sha256_init( &operation->ctx.sha256 );
2467 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 0 );
2468 break;
2469#endif
2470#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002471#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002472 case PSA_ALG_SHA_384:
2473 mbedtls_sha512_init( &operation->ctx.sha512 );
2474 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 1 );
2475 break;
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002476#endif
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002477 case PSA_ALG_SHA_512:
2478 mbedtls_sha512_init( &operation->ctx.sha512 );
2479 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 0 );
2480 break;
2481#endif
2482 default:
Gilles Peskinec06e0712018-06-20 16:21:04 +02002483 return( PSA_ALG_IS_HASH( alg ) ?
2484 PSA_ERROR_NOT_SUPPORTED :
2485 PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002486 }
2487 if( ret == 0 )
2488 operation->alg = alg;
2489 else
2490 psa_hash_abort( operation );
2491 return( mbedtls_to_psa_error( ret ) );
2492}
2493
2494psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2495 const uint8_t *input,
2496 size_t input_length )
2497{
Janos Follath24eed8d2019-11-22 13:21:35 +00002498 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine94e44542018-07-12 16:58:43 +02002499
2500 /* Don't require hash implementations to behave correctly on a
2501 * zero-length input, which may have an invalid pointer. */
2502 if( input_length == 0 )
2503 return( PSA_SUCCESS );
2504
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002505 switch( operation->alg )
2506 {
2507#if defined(MBEDTLS_MD2_C)
2508 case PSA_ALG_MD2:
2509 ret = mbedtls_md2_update_ret( &operation->ctx.md2,
2510 input, input_length );
2511 break;
2512#endif
2513#if defined(MBEDTLS_MD4_C)
2514 case PSA_ALG_MD4:
2515 ret = mbedtls_md4_update_ret( &operation->ctx.md4,
2516 input, input_length );
2517 break;
2518#endif
2519#if defined(MBEDTLS_MD5_C)
2520 case PSA_ALG_MD5:
2521 ret = mbedtls_md5_update_ret( &operation->ctx.md5,
2522 input, input_length );
2523 break;
2524#endif
2525#if defined(MBEDTLS_RIPEMD160_C)
2526 case PSA_ALG_RIPEMD160:
2527 ret = mbedtls_ripemd160_update_ret( &operation->ctx.ripemd160,
2528 input, input_length );
2529 break;
2530#endif
2531#if defined(MBEDTLS_SHA1_C)
2532 case PSA_ALG_SHA_1:
2533 ret = mbedtls_sha1_update_ret( &operation->ctx.sha1,
2534 input, input_length );
2535 break;
2536#endif
2537#if defined(MBEDTLS_SHA256_C)
2538 case PSA_ALG_SHA_224:
2539 case PSA_ALG_SHA_256:
2540 ret = mbedtls_sha256_update_ret( &operation->ctx.sha256,
2541 input, input_length );
2542 break;
2543#endif
2544#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002545#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002546 case PSA_ALG_SHA_384:
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002547#endif
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002548 case PSA_ALG_SHA_512:
2549 ret = mbedtls_sha512_update_ret( &operation->ctx.sha512,
2550 input, input_length );
2551 break;
2552#endif
2553 default:
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002554 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002555 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002556
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002557 if( ret != 0 )
2558 psa_hash_abort( operation );
2559 return( mbedtls_to_psa_error( ret ) );
2560}
2561
2562psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2563 uint8_t *hash,
2564 size_t hash_size,
2565 size_t *hash_length )
2566{
itayzafrir40835d42018-08-02 13:14:17 +03002567 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00002568 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine71bb7b72018-04-19 08:29:59 +02002569 size_t actual_hash_length = PSA_HASH_SIZE( operation->alg );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002570
2571 /* Fill the output buffer with something that isn't a valid hash
2572 * (barring an attack on the hash and deliberately-crafted input),
2573 * in case the caller doesn't check the return status properly. */
Gilles Peskineaee13332018-07-02 12:15:28 +02002574 *hash_length = hash_size;
Gilles Peskine46f1fd72018-06-28 19:31:31 +02002575 /* If hash_size is 0 then hash may be NULL and then the
2576 * call to memset would have undefined behavior. */
2577 if( hash_size != 0 )
2578 memset( hash, '!', hash_size );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002579
2580 if( hash_size < actual_hash_length )
itayzafrir40835d42018-08-02 13:14:17 +03002581 {
2582 status = PSA_ERROR_BUFFER_TOO_SMALL;
2583 goto exit;
2584 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002585
2586 switch( operation->alg )
2587 {
2588#if defined(MBEDTLS_MD2_C)
2589 case PSA_ALG_MD2:
2590 ret = mbedtls_md2_finish_ret( &operation->ctx.md2, hash );
2591 break;
2592#endif
2593#if defined(MBEDTLS_MD4_C)
2594 case PSA_ALG_MD4:
2595 ret = mbedtls_md4_finish_ret( &operation->ctx.md4, hash );
2596 break;
2597#endif
2598#if defined(MBEDTLS_MD5_C)
2599 case PSA_ALG_MD5:
2600 ret = mbedtls_md5_finish_ret( &operation->ctx.md5, hash );
2601 break;
2602#endif
2603#if defined(MBEDTLS_RIPEMD160_C)
2604 case PSA_ALG_RIPEMD160:
2605 ret = mbedtls_ripemd160_finish_ret( &operation->ctx.ripemd160, hash );
2606 break;
2607#endif
2608#if defined(MBEDTLS_SHA1_C)
2609 case PSA_ALG_SHA_1:
2610 ret = mbedtls_sha1_finish_ret( &operation->ctx.sha1, hash );
2611 break;
2612#endif
2613#if defined(MBEDTLS_SHA256_C)
2614 case PSA_ALG_SHA_224:
2615 case PSA_ALG_SHA_256:
2616 ret = mbedtls_sha256_finish_ret( &operation->ctx.sha256, hash );
2617 break;
2618#endif
2619#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002620#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002621 case PSA_ALG_SHA_384:
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002622#endif
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002623 case PSA_ALG_SHA_512:
2624 ret = mbedtls_sha512_finish_ret( &operation->ctx.sha512, hash );
2625 break;
2626#endif
2627 default:
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002628 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002629 }
itayzafrir40835d42018-08-02 13:14:17 +03002630 status = mbedtls_to_psa_error( ret );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002631
itayzafrir40835d42018-08-02 13:14:17 +03002632exit:
2633 if( status == PSA_SUCCESS )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002634 {
Gilles Peskineaee13332018-07-02 12:15:28 +02002635 *hash_length = actual_hash_length;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002636 return( psa_hash_abort( operation ) );
2637 }
2638 else
2639 {
2640 psa_hash_abort( operation );
itayzafrir40835d42018-08-02 13:14:17 +03002641 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002642 }
2643}
2644
Gilles Peskine2d277862018-06-18 15:41:12 +02002645psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2646 const uint8_t *hash,
2647 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002648{
2649 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2650 size_t actual_hash_length;
2651 psa_status_t status = psa_hash_finish( operation,
2652 actual_hash, sizeof( actual_hash ),
2653 &actual_hash_length );
2654 if( status != PSA_SUCCESS )
2655 return( status );
2656 if( actual_hash_length != hash_length )
2657 return( PSA_ERROR_INVALID_SIGNATURE );
2658 if( safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
2659 return( PSA_ERROR_INVALID_SIGNATURE );
2660 return( PSA_SUCCESS );
2661}
2662
Gilles Peskine0a749c82019-11-28 19:33:58 +01002663psa_status_t psa_hash_compute( psa_algorithm_t alg,
2664 const uint8_t *input, size_t input_length,
2665 uint8_t *hash, size_t hash_size,
2666 size_t *hash_length )
2667{
2668 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
2669 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2670
2671 *hash_length = hash_size;
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_finish( &operation, hash, hash_size, 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
2690psa_status_t psa_hash_compare( psa_algorithm_t alg,
2691 const uint8_t *input, size_t input_length,
2692 const uint8_t *hash, size_t hash_length )
2693{
2694 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
2695 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2696
2697 status = psa_hash_setup( &operation, alg );
2698 if( status != PSA_SUCCESS )
2699 goto exit;
2700 status = psa_hash_update( &operation, input, input_length );
2701 if( status != PSA_SUCCESS )
2702 goto exit;
2703 status = psa_hash_verify( &operation, hash, hash_length );
2704 if( status != PSA_SUCCESS )
2705 goto exit;
2706
2707exit:
2708 if( status == PSA_SUCCESS )
2709 status = psa_hash_abort( &operation );
2710 else
2711 psa_hash_abort( &operation );
2712 return( status );
2713}
2714
Gilles Peskineeb35d782019-01-22 17:56:16 +01002715psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2716 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002717{
2718 if( target_operation->alg != 0 )
2719 return( PSA_ERROR_BAD_STATE );
2720
2721 switch( source_operation->alg )
2722 {
2723 case 0:
2724 return( PSA_ERROR_BAD_STATE );
2725#if defined(MBEDTLS_MD2_C)
2726 case PSA_ALG_MD2:
2727 mbedtls_md2_clone( &target_operation->ctx.md2,
2728 &source_operation->ctx.md2 );
2729 break;
2730#endif
2731#if defined(MBEDTLS_MD4_C)
2732 case PSA_ALG_MD4:
2733 mbedtls_md4_clone( &target_operation->ctx.md4,
2734 &source_operation->ctx.md4 );
2735 break;
2736#endif
2737#if defined(MBEDTLS_MD5_C)
2738 case PSA_ALG_MD5:
2739 mbedtls_md5_clone( &target_operation->ctx.md5,
2740 &source_operation->ctx.md5 );
2741 break;
2742#endif
2743#if defined(MBEDTLS_RIPEMD160_C)
2744 case PSA_ALG_RIPEMD160:
2745 mbedtls_ripemd160_clone( &target_operation->ctx.ripemd160,
2746 &source_operation->ctx.ripemd160 );
2747 break;
2748#endif
2749#if defined(MBEDTLS_SHA1_C)
2750 case PSA_ALG_SHA_1:
2751 mbedtls_sha1_clone( &target_operation->ctx.sha1,
2752 &source_operation->ctx.sha1 );
2753 break;
2754#endif
2755#if defined(MBEDTLS_SHA256_C)
2756 case PSA_ALG_SHA_224:
2757 case PSA_ALG_SHA_256:
2758 mbedtls_sha256_clone( &target_operation->ctx.sha256,
2759 &source_operation->ctx.sha256 );
2760 break;
2761#endif
2762#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002763#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002764 case PSA_ALG_SHA_384:
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002765#endif
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002766 case PSA_ALG_SHA_512:
2767 mbedtls_sha512_clone( &target_operation->ctx.sha512,
2768 &source_operation->ctx.sha512 );
2769 break;
2770#endif
2771 default:
2772 return( PSA_ERROR_NOT_SUPPORTED );
2773 }
2774
2775 target_operation->alg = source_operation->alg;
2776 return( PSA_SUCCESS );
2777}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002778
2779
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002780/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002781/* MAC */
2782/****************************************************************/
2783
Gilles Peskinedc2fc842018-03-07 16:42:59 +01002784static const mbedtls_cipher_info_t *mbedtls_cipher_info_from_psa(
Gilles Peskine8c9def32018-02-08 10:02:12 +01002785 psa_algorithm_t alg,
2786 psa_key_type_t key_type,
Gilles Peskine2d277862018-06-18 15:41:12 +02002787 size_t key_bits,
mohammad1603f4f0d612018-06-03 15:04:51 +03002788 mbedtls_cipher_id_t* cipher_id )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002789{
Gilles Peskine8c9def32018-02-08 10:02:12 +01002790 mbedtls_cipher_mode_t mode;
mohammad1603f4f0d612018-06-03 15:04:51 +03002791 mbedtls_cipher_id_t cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002792
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002793 if( PSA_ALG_IS_AEAD( alg ) )
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002794 alg = PSA_ALG_AEAD_WITH_TAG_LENGTH( alg, 0 );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002795
Gilles Peskine8c9def32018-02-08 10:02:12 +01002796 if( PSA_ALG_IS_CIPHER( alg ) || PSA_ALG_IS_AEAD( alg ) )
2797 {
Nir Sonnenscheine9664c32018-06-17 14:41:30 +03002798 switch( alg )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002799 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002800 case PSA_ALG_ARC4:
Gilles Peskine26869f22019-05-06 15:25:00 +02002801 case PSA_ALG_CHACHA20:
Gilles Peskine8c9def32018-02-08 10:02:12 +01002802 mode = MBEDTLS_MODE_STREAM;
2803 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002804 case PSA_ALG_CTR:
2805 mode = MBEDTLS_MODE_CTR;
2806 break;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002807 case PSA_ALG_CFB:
2808 mode = MBEDTLS_MODE_CFB;
2809 break;
2810 case PSA_ALG_OFB:
2811 mode = MBEDTLS_MODE_OFB;
2812 break;
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02002813 case PSA_ALG_ECB_NO_PADDING:
2814 mode = MBEDTLS_MODE_ECB;
2815 break;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002816 case PSA_ALG_CBC_NO_PADDING:
2817 mode = MBEDTLS_MODE_CBC;
2818 break;
2819 case PSA_ALG_CBC_PKCS7:
2820 mode = MBEDTLS_MODE_CBC;
2821 break;
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002822 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002823 mode = MBEDTLS_MODE_CCM;
2824 break;
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002825 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_GCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002826 mode = MBEDTLS_MODE_GCM;
2827 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02002828 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CHACHA20_POLY1305, 0 ):
2829 mode = MBEDTLS_MODE_CHACHAPOLY;
2830 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002831 default:
2832 return( NULL );
2833 }
2834 }
2835 else if( alg == PSA_ALG_CMAC )
2836 mode = MBEDTLS_MODE_ECB;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002837 else
2838 return( NULL );
2839
2840 switch( key_type )
2841 {
2842 case PSA_KEY_TYPE_AES:
mohammad1603f4f0d612018-06-03 15:04:51 +03002843 cipher_id_tmp = MBEDTLS_CIPHER_ID_AES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002844 break;
2845 case PSA_KEY_TYPE_DES:
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002846 /* key_bits is 64 for Single-DES, 128 for two-key Triple-DES,
2847 * and 192 for three-key Triple-DES. */
Gilles Peskine8c9def32018-02-08 10:02:12 +01002848 if( key_bits == 64 )
mohammad1603f4f0d612018-06-03 15:04:51 +03002849 cipher_id_tmp = MBEDTLS_CIPHER_ID_DES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002850 else
mohammad1603f4f0d612018-06-03 15:04:51 +03002851 cipher_id_tmp = MBEDTLS_CIPHER_ID_3DES;
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002852 /* mbedtls doesn't recognize two-key Triple-DES as an algorithm,
2853 * but two-key Triple-DES is functionally three-key Triple-DES
2854 * with K1=K3, so that's how we present it to mbedtls. */
2855 if( key_bits == 128 )
2856 key_bits = 192;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002857 break;
2858 case PSA_KEY_TYPE_CAMELLIA:
mohammad1603f4f0d612018-06-03 15:04:51 +03002859 cipher_id_tmp = MBEDTLS_CIPHER_ID_CAMELLIA;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002860 break;
2861 case PSA_KEY_TYPE_ARC4:
mohammad1603f4f0d612018-06-03 15:04:51 +03002862 cipher_id_tmp = MBEDTLS_CIPHER_ID_ARC4;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002863 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02002864 case PSA_KEY_TYPE_CHACHA20:
2865 cipher_id_tmp = MBEDTLS_CIPHER_ID_CHACHA20;
2866 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002867 default:
2868 return( NULL );
2869 }
mohammad1603f4f0d612018-06-03 15:04:51 +03002870 if( cipher_id != NULL )
mohammad160360a64d02018-06-03 17:20:42 +03002871 *cipher_id = cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002872
Jaeden Amero23bbb752018-06-26 14:16:54 +01002873 return( mbedtls_cipher_info_from_values( cipher_id_tmp,
2874 (int) key_bits, mode ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002875}
2876
Gilles Peskinea05219c2018-11-16 16:02:56 +01002877#if defined(MBEDTLS_MD_C)
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002878static size_t psa_get_hash_block_size( psa_algorithm_t alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002879{
Gilles Peskine2d277862018-06-18 15:41:12 +02002880 switch( alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002881 {
2882 case PSA_ALG_MD2:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002883 return( 16 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002884 case PSA_ALG_MD4:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002885 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002886 case PSA_ALG_MD5:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002887 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002888 case PSA_ALG_RIPEMD160:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002889 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002890 case PSA_ALG_SHA_1:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002891 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002892 case PSA_ALG_SHA_224:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002893 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002894 case PSA_ALG_SHA_256:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002895 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002896 case PSA_ALG_SHA_384:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002897 return( 128 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002898 case PSA_ALG_SHA_512:
Gilles Peskine2d277862018-06-18 15:41:12 +02002899 return( 128 );
2900 default:
2901 return( 0 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002902 }
2903}
Gilles Peskinea05219c2018-11-16 16:02:56 +01002904#endif /* MBEDTLS_MD_C */
Nir Sonnenschein0c9ec532018-06-07 13:27:47 +03002905
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002906/* Initialize the MAC operation structure. Once this function has been
2907 * called, psa_mac_abort can run and will do the right thing. */
2908static psa_status_t psa_mac_init( psa_mac_operation_t *operation,
2909 psa_algorithm_t alg )
2910{
2911 psa_status_t status = PSA_ERROR_NOT_SUPPORTED;
2912
2913 operation->alg = alg;
2914 operation->key_set = 0;
2915 operation->iv_set = 0;
2916 operation->iv_required = 0;
2917 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002918 operation->is_sign = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002919
2920#if defined(MBEDTLS_CMAC_C)
2921 if( alg == PSA_ALG_CMAC )
2922 {
2923 operation->iv_required = 0;
2924 mbedtls_cipher_init( &operation->ctx.cmac );
2925 status = PSA_SUCCESS;
2926 }
2927 else
2928#endif /* MBEDTLS_CMAC_C */
2929#if defined(MBEDTLS_MD_C)
2930 if( PSA_ALG_IS_HMAC( operation->alg ) )
2931 {
Gilles Peskineff94abd2018-07-12 17:07:52 +02002932 /* We'll set up the hash operation later in psa_hmac_setup_internal. */
2933 operation->ctx.hmac.hash_ctx.alg = 0;
2934 status = PSA_SUCCESS;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002935 }
2936 else
2937#endif /* MBEDTLS_MD_C */
2938 {
Gilles Peskinec06e0712018-06-20 16:21:04 +02002939 if( ! PSA_ALG_IS_MAC( alg ) )
2940 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002941 }
2942
2943 if( status != PSA_SUCCESS )
2944 memset( operation, 0, sizeof( *operation ) );
2945 return( status );
2946}
2947
Gilles Peskine01126fa2018-07-12 17:04:55 +02002948#if defined(MBEDTLS_MD_C)
2949static psa_status_t psa_hmac_abort_internal( psa_hmac_internal_data *hmac )
2950{
Gilles Peskine3f108122018-12-07 18:14:53 +01002951 mbedtls_platform_zeroize( hmac->opad, sizeof( hmac->opad ) );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002952 return( psa_hash_abort( &hmac->hash_ctx ) );
2953}
2954#endif /* MBEDTLS_MD_C */
2955
Gilles Peskine8c9def32018-02-08 10:02:12 +01002956psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
2957{
Gilles Peskinefbfac682018-07-08 20:51:54 +02002958 if( operation->alg == 0 )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002959 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02002960 /* The object has (apparently) been initialized but it is not
2961 * in use. It's ok to call abort on such an object, and there's
2962 * nothing to do. */
2963 return( PSA_SUCCESS );
2964 }
2965 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002966#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002967 if( operation->alg == PSA_ALG_CMAC )
2968 {
2969 mbedtls_cipher_free( &operation->ctx.cmac );
2970 }
2971 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002972#endif /* MBEDTLS_CMAC_C */
Gilles Peskine8c9def32018-02-08 10:02:12 +01002973#if defined(MBEDTLS_MD_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002974 if( PSA_ALG_IS_HMAC( operation->alg ) )
2975 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02002976 psa_hmac_abort_internal( &operation->ctx.hmac );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002977 }
2978 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002979#endif /* MBEDTLS_MD_C */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002980 {
2981 /* Sanity check (shouldn't happen: operation->alg should
2982 * always have been initialized to a valid value). */
2983 goto bad_state;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002984 }
Moran Peker41deec42018-04-04 15:43:05 +03002985
Gilles Peskine8c9def32018-02-08 10:02:12 +01002986 operation->alg = 0;
2987 operation->key_set = 0;
2988 operation->iv_set = 0;
2989 operation->iv_required = 0;
2990 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002991 operation->is_sign = 0;
Moran Peker41deec42018-04-04 15:43:05 +03002992
Gilles Peskine8c9def32018-02-08 10:02:12 +01002993 return( PSA_SUCCESS );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002994
2995bad_state:
2996 /* If abort is called on an uninitialized object, we can't trust
2997 * anything. Wipe the object in case it contains confidential data.
2998 * This may result in a memory leak if a pointer gets overwritten,
2999 * but it's too late to do anything about this. */
3000 memset( operation, 0, sizeof( *operation ) );
3001 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003002}
3003
Gilles Peskinee3b07d82018-06-19 11:57:35 +02003004#if defined(MBEDTLS_CMAC_C)
Gilles Peskine89167cb2018-07-08 20:12:23 +02003005static int psa_cmac_setup( psa_mac_operation_t *operation,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003006 size_t key_bits,
Gilles Peskine2f060a82018-12-04 17:12:32 +01003007 psa_key_slot_t *slot,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003008 const mbedtls_cipher_info_t *cipher_info )
3009{
Janos Follath24eed8d2019-11-22 13:21:35 +00003010 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003011
3012 operation->mac_size = cipher_info->block_size;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003013
3014 ret = mbedtls_cipher_setup( &operation->ctx.cmac, cipher_info );
3015 if( ret != 0 )
3016 return( ret );
3017
3018 ret = mbedtls_cipher_cmac_starts( &operation->ctx.cmac,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02003019 slot->data.key.data,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003020 key_bits );
3021 return( ret );
3022}
Gilles Peskinee3b07d82018-06-19 11:57:35 +02003023#endif /* MBEDTLS_CMAC_C */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003024
Gilles Peskine248051a2018-06-20 16:09:38 +02003025#if defined(MBEDTLS_MD_C)
Gilles Peskine01126fa2018-07-12 17:04:55 +02003026static psa_status_t psa_hmac_setup_internal( psa_hmac_internal_data *hmac,
3027 const uint8_t *key,
3028 size_t key_length,
3029 psa_algorithm_t hash_alg )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003030{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02003031 uint8_t ipad[PSA_HMAC_MAX_HASH_BLOCK_SIZE];
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003032 size_t i;
Gilles Peskine9aa369e2018-07-16 00:36:29 +02003033 size_t hash_size = PSA_HASH_SIZE( hash_alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003034 size_t block_size = psa_get_hash_block_size( hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003035 psa_status_t status;
3036
Gilles Peskine9aa369e2018-07-16 00:36:29 +02003037 /* Sanity checks on block_size, to guarantee that there won't be a buffer
3038 * overflow below. This should never trigger if the hash algorithm
3039 * is implemented correctly. */
3040 /* The size checks against the ipad and opad buffers cannot be written
3041 * `block_size > sizeof( ipad ) || block_size > sizeof( hmac->opad )`
3042 * because that triggers -Wlogical-op on GCC 7.3. */
3043 if( block_size > sizeof( ipad ) )
3044 return( PSA_ERROR_NOT_SUPPORTED );
3045 if( block_size > sizeof( hmac->opad ) )
3046 return( PSA_ERROR_NOT_SUPPORTED );
3047 if( block_size < hash_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003048 return( PSA_ERROR_NOT_SUPPORTED );
3049
Gilles Peskined223b522018-06-11 18:12:58 +02003050 if( key_length > block_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003051 {
Gilles Peskine84b8fc82019-11-28 20:07:20 +01003052 status = psa_hash_compute( hash_alg, key, key_length,
3053 ipad, sizeof( ipad ), &key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003054 if( status != PSA_SUCCESS )
Gilles Peskineb8be2882018-07-17 16:24:34 +02003055 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003056 }
Gilles Peskine96889972018-07-12 17:07:03 +02003057 /* A 0-length key is not commonly used in HMAC when used as a MAC,
3058 * but it is permitted. It is common when HMAC is used in HKDF, for
3059 * example. Don't call `memcpy` in the 0-length because `key` could be
3060 * an invalid pointer which would make the behavior undefined. */
3061 else if( key_length != 0 )
Gilles Peskine01126fa2018-07-12 17:04:55 +02003062 memcpy( ipad, key, key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003063
Gilles Peskined223b522018-06-11 18:12:58 +02003064 /* ipad contains the key followed by garbage. Xor and fill with 0x36
3065 * to create the ipad value. */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003066 for( i = 0; i < key_length; i++ )
Gilles Peskined223b522018-06-11 18:12:58 +02003067 ipad[i] ^= 0x36;
3068 memset( ipad + key_length, 0x36, block_size - key_length );
3069
3070 /* Copy the key material from ipad to opad, flipping the requisite bits,
3071 * and filling the rest of opad with the requisite constant. */
3072 for( i = 0; i < key_length; i++ )
Gilles Peskine01126fa2018-07-12 17:04:55 +02003073 hmac->opad[i] = ipad[i] ^ 0x36 ^ 0x5C;
3074 memset( hmac->opad + key_length, 0x5C, block_size - key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003075
Gilles Peskine01126fa2018-07-12 17:04:55 +02003076 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003077 if( status != PSA_SUCCESS )
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003078 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003079
Gilles Peskine01126fa2018-07-12 17:04:55 +02003080 status = psa_hash_update( &hmac->hash_ctx, ipad, block_size );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003081
3082cleanup:
Steven Cooreman29149862020-08-05 15:43:42 +02003083 mbedtls_platform_zeroize( ipad, sizeof( ipad ) );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003084
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003085 return( status );
3086}
Gilles Peskine248051a2018-06-20 16:09:38 +02003087#endif /* MBEDTLS_MD_C */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003088
Gilles Peskine89167cb2018-07-08 20:12:23 +02003089static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003090 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02003091 psa_algorithm_t alg,
3092 int is_sign )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003093{
Gilles Peskine8c9def32018-02-08 10:02:12 +01003094 psa_status_t status;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003095 psa_key_slot_t *slot;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003096 size_t key_bits;
Gilles Peskine89167cb2018-07-08 20:12:23 +02003097 psa_key_usage_t usage =
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003098 is_sign ? PSA_KEY_USAGE_SIGN_HASH : PSA_KEY_USAGE_VERIFY_HASH;
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02003099 uint8_t truncated = PSA_MAC_TRUNCATED_LENGTH( alg );
Gilles Peskinee0e9c7c2018-10-17 18:28:05 +02003100 psa_algorithm_t full_length_alg = PSA_ALG_FULL_LENGTH_MAC( alg );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003101
Jaeden Amero36ee5d02019-02-19 09:25:10 +00003102 /* A context must be freshly initialized before it can be set up. */
3103 if( operation->alg != 0 )
3104 {
3105 return( PSA_ERROR_BAD_STATE );
3106 }
3107
Gilles Peskined911eb72018-08-14 15:18:45 +02003108 status = psa_mac_init( operation, full_length_alg );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003109 if( status != PSA_SUCCESS )
3110 return( status );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003111 if( is_sign )
3112 operation->is_sign = 1;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003113
Ronald Croncf56a0a2020-08-04 09:51:30 +02003114 status = psa_get_transparent_key( key, &slot, usage, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003115 if( status != PSA_SUCCESS )
Gilles Peskinefbfac682018-07-08 20:51:54 +02003116 goto exit;
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02003117 key_bits = psa_get_key_slot_bits( slot );
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02003118
Gilles Peskine8c9def32018-02-08 10:02:12 +01003119#if defined(MBEDTLS_CMAC_C)
Gilles Peskined911eb72018-08-14 15:18:45 +02003120 if( full_length_alg == PSA_ALG_CMAC )
Gilles Peskinefbfac682018-07-08 20:51:54 +02003121 {
3122 const mbedtls_cipher_info_t *cipher_info =
Gilles Peskined911eb72018-08-14 15:18:45 +02003123 mbedtls_cipher_info_from_psa( full_length_alg,
Gilles Peskine8e338702019-07-30 20:06:31 +02003124 slot->attr.type, key_bits, NULL );
Janos Follath24eed8d2019-11-22 13:21:35 +00003125 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinefbfac682018-07-08 20:51:54 +02003126 if( cipher_info == NULL )
3127 {
3128 status = PSA_ERROR_NOT_SUPPORTED;
3129 goto exit;
3130 }
3131 operation->mac_size = cipher_info->block_size;
3132 ret = psa_cmac_setup( operation, key_bits, slot, cipher_info );
3133 status = mbedtls_to_psa_error( ret );
3134 }
3135 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01003136#endif /* MBEDTLS_CMAC_C */
Gilles Peskine8c9def32018-02-08 10:02:12 +01003137#if defined(MBEDTLS_MD_C)
Gilles Peskined911eb72018-08-14 15:18:45 +02003138 if( PSA_ALG_IS_HMAC( full_length_alg ) )
Gilles Peskinefbfac682018-07-08 20:51:54 +02003139 {
Gilles Peskine00709fa2018-08-22 18:25:41 +02003140 psa_algorithm_t hash_alg = PSA_ALG_HMAC_GET_HASH( alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003141 if( hash_alg == 0 )
3142 {
3143 status = PSA_ERROR_NOT_SUPPORTED;
3144 goto exit;
3145 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02003146
3147 operation->mac_size = PSA_HASH_SIZE( hash_alg );
3148 /* Sanity check. This shouldn't fail on a valid configuration. */
3149 if( operation->mac_size == 0 ||
3150 operation->mac_size > sizeof( operation->ctx.hmac.opad ) )
3151 {
3152 status = PSA_ERROR_NOT_SUPPORTED;
3153 goto exit;
3154 }
3155
Gilles Peskine8e338702019-07-30 20:06:31 +02003156 if( slot->attr.type != PSA_KEY_TYPE_HMAC )
Gilles Peskine01126fa2018-07-12 17:04:55 +02003157 {
3158 status = PSA_ERROR_INVALID_ARGUMENT;
3159 goto exit;
3160 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02003161
Gilles Peskine01126fa2018-07-12 17:04:55 +02003162 status = psa_hmac_setup_internal( &operation->ctx.hmac,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02003163 slot->data.key.data,
3164 slot->data.key.bytes,
Gilles Peskine01126fa2018-07-12 17:04:55 +02003165 hash_alg );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003166 }
3167 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01003168#endif /* MBEDTLS_MD_C */
Gilles Peskinefbfac682018-07-08 20:51:54 +02003169 {
Jaeden Amero82df32e2018-11-23 15:11:20 +00003170 (void) key_bits;
Gilles Peskinefbfac682018-07-08 20:51:54 +02003171 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003172 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003173
Gilles Peskined911eb72018-08-14 15:18:45 +02003174 if( truncated == 0 )
3175 {
3176 /* The "normal" case: untruncated algorithm. Nothing to do. */
3177 }
3178 else if( truncated < 4 )
3179 {
Gilles Peskine6d72ff92018-08-21 14:55:08 +02003180 /* A very short MAC is too short for security since it can be
3181 * brute-forced. Ancient protocols with 32-bit MACs do exist,
3182 * so we make this our minimum, even though 32 bits is still
3183 * too small for security. */
Gilles Peskined911eb72018-08-14 15:18:45 +02003184 status = PSA_ERROR_NOT_SUPPORTED;
3185 }
3186 else if( truncated > operation->mac_size )
3187 {
3188 /* It's impossible to "truncate" to a larger length. */
3189 status = PSA_ERROR_INVALID_ARGUMENT;
3190 }
3191 else
3192 operation->mac_size = truncated;
3193
Gilles Peskinefbfac682018-07-08 20:51:54 +02003194exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003195 if( status != PSA_SUCCESS )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003196 {
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003197 psa_mac_abort( operation );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003198 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003199 else
3200 {
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003201 operation->key_set = 1;
3202 }
3203 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003204}
3205
Gilles Peskine89167cb2018-07-08 20:12:23 +02003206psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003207 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02003208 psa_algorithm_t alg )
3209{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003210 return( psa_mac_setup( operation, key, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003211}
3212
3213psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003214 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02003215 psa_algorithm_t alg )
3216{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003217 return( psa_mac_setup( operation, key, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003218}
3219
Gilles Peskine8c9def32018-02-08 10:02:12 +01003220psa_status_t psa_mac_update( psa_mac_operation_t *operation,
3221 const uint8_t *input,
3222 size_t input_length )
3223{
Gilles Peskinefbfac682018-07-08 20:51:54 +02003224 psa_status_t status = PSA_ERROR_BAD_STATE;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003225 if( ! operation->key_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003226 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003227 if( operation->iv_required && ! operation->iv_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003228 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003229 operation->has_input = 1;
3230
Gilles Peskine8c9def32018-02-08 10:02:12 +01003231#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003232 if( operation->alg == PSA_ALG_CMAC )
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03003233 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02003234 int ret = mbedtls_cipher_cmac_update( &operation->ctx.cmac,
3235 input, input_length );
3236 status = mbedtls_to_psa_error( ret );
3237 }
3238 else
3239#endif /* MBEDTLS_CMAC_C */
3240#if defined(MBEDTLS_MD_C)
3241 if( PSA_ALG_IS_HMAC( operation->alg ) )
3242 {
3243 status = psa_hash_update( &operation->ctx.hmac.hash_ctx, input,
3244 input_length );
3245 }
3246 else
3247#endif /* MBEDTLS_MD_C */
3248 {
3249 /* This shouldn't happen if `operation` was initialized by
3250 * a setup function. */
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003251 return( PSA_ERROR_BAD_STATE );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03003252 }
3253
Gilles Peskinefbfac682018-07-08 20:51:54 +02003254 if( status != PSA_SUCCESS )
3255 psa_mac_abort( operation );
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02003256 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003257}
3258
Gilles Peskine01126fa2018-07-12 17:04:55 +02003259#if defined(MBEDTLS_MD_C)
3260static psa_status_t psa_hmac_finish_internal( psa_hmac_internal_data *hmac,
3261 uint8_t *mac,
3262 size_t mac_size )
3263{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02003264 uint8_t tmp[MBEDTLS_MD_MAX_SIZE];
Gilles Peskine01126fa2018-07-12 17:04:55 +02003265 psa_algorithm_t hash_alg = hmac->hash_ctx.alg;
3266 size_t hash_size = 0;
3267 size_t block_size = psa_get_hash_block_size( hash_alg );
3268 psa_status_t status;
3269
Gilles Peskine01126fa2018-07-12 17:04:55 +02003270 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
3271 if( status != PSA_SUCCESS )
3272 return( status );
3273 /* From here on, tmp needs to be wiped. */
3274
3275 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
3276 if( status != PSA_SUCCESS )
3277 goto exit;
3278
3279 status = psa_hash_update( &hmac->hash_ctx, hmac->opad, block_size );
3280 if( status != PSA_SUCCESS )
3281 goto exit;
3282
3283 status = psa_hash_update( &hmac->hash_ctx, tmp, hash_size );
3284 if( status != PSA_SUCCESS )
3285 goto exit;
3286
Gilles Peskined911eb72018-08-14 15:18:45 +02003287 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
3288 if( status != PSA_SUCCESS )
3289 goto exit;
3290
3291 memcpy( mac, tmp, mac_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003292
3293exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01003294 mbedtls_platform_zeroize( tmp, hash_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003295 return( status );
3296}
3297#endif /* MBEDTLS_MD_C */
3298
mohammad16036df908f2018-04-02 08:34:15 -07003299static psa_status_t psa_mac_finish_internal( psa_mac_operation_t *operation,
Gilles Peskine2d277862018-06-18 15:41:12 +02003300 uint8_t *mac,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003301 size_t mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003302{
Gilles Peskine1d96fff2018-07-02 12:15:39 +02003303 if( ! operation->key_set )
3304 return( PSA_ERROR_BAD_STATE );
3305 if( operation->iv_required && ! operation->iv_set )
3306 return( PSA_ERROR_BAD_STATE );
3307
Gilles Peskine8c9def32018-02-08 10:02:12 +01003308 if( mac_size < operation->mac_size )
3309 return( PSA_ERROR_BUFFER_TOO_SMALL );
3310
Gilles Peskine8c9def32018-02-08 10:02:12 +01003311#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003312 if( operation->alg == PSA_ALG_CMAC )
3313 {
Gilles Peskined911eb72018-08-14 15:18:45 +02003314 uint8_t tmp[PSA_MAX_BLOCK_CIPHER_BLOCK_SIZE];
3315 int ret = mbedtls_cipher_cmac_finish( &operation->ctx.cmac, tmp );
3316 if( ret == 0 )
Gilles Peskine87b0ac42018-08-21 14:55:49 +02003317 memcpy( mac, tmp, operation->mac_size );
Gilles Peskine3f108122018-12-07 18:14:53 +01003318 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003319 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003320 }
Gilles Peskinefbfac682018-07-08 20:51:54 +02003321 else
3322#endif /* MBEDTLS_CMAC_C */
3323#if defined(MBEDTLS_MD_C)
3324 if( PSA_ALG_IS_HMAC( operation->alg ) )
3325 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02003326 return( psa_hmac_finish_internal( &operation->ctx.hmac,
Gilles Peskined911eb72018-08-14 15:18:45 +02003327 mac, operation->mac_size ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003328 }
3329 else
3330#endif /* MBEDTLS_MD_C */
3331 {
3332 /* This shouldn't happen if `operation` was initialized by
3333 * a setup function. */
3334 return( PSA_ERROR_BAD_STATE );
3335 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01003336}
3337
Gilles Peskineacd4be32018-07-08 19:56:25 +02003338psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
3339 uint8_t *mac,
3340 size_t mac_size,
3341 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07003342{
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003343 psa_status_t status;
3344
Jaeden Amero252ef282019-02-15 14:05:35 +00003345 if( operation->alg == 0 )
3346 {
3347 return( PSA_ERROR_BAD_STATE );
3348 }
3349
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003350 /* Fill the output buffer with something that isn't a valid mac
3351 * (barring an attack on the mac and deliberately-crafted input),
3352 * in case the caller doesn't check the return status properly. */
3353 *mac_length = mac_size;
3354 /* If mac_size is 0 then mac may be NULL and then the
3355 * call to memset would have undefined behavior. */
3356 if( mac_size != 0 )
3357 memset( mac, '!', mac_size );
3358
Gilles Peskine89167cb2018-07-08 20:12:23 +02003359 if( ! operation->is_sign )
3360 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003361 return( PSA_ERROR_BAD_STATE );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003362 }
mohammad16036df908f2018-04-02 08:34:15 -07003363
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003364 status = psa_mac_finish_internal( operation, mac, mac_size );
3365
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003366 if( status == PSA_SUCCESS )
3367 {
3368 status = psa_mac_abort( operation );
3369 if( status == PSA_SUCCESS )
3370 *mac_length = operation->mac_size;
3371 else
3372 memset( mac, '!', mac_size );
3373 }
3374 else
3375 psa_mac_abort( operation );
3376 return( status );
mohammad16036df908f2018-04-02 08:34:15 -07003377}
3378
Gilles Peskineacd4be32018-07-08 19:56:25 +02003379psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
3380 const uint8_t *mac,
3381 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003382{
Gilles Peskine828ed142018-06-18 23:25:51 +02003383 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
mohammad16036df908f2018-04-02 08:34:15 -07003384 psa_status_t status;
3385
Jaeden Amero252ef282019-02-15 14:05:35 +00003386 if( operation->alg == 0 )
3387 {
3388 return( PSA_ERROR_BAD_STATE );
3389 }
3390
Gilles Peskine89167cb2018-07-08 20:12:23 +02003391 if( operation->is_sign )
3392 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003393 return( PSA_ERROR_BAD_STATE );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003394 }
3395 if( operation->mac_size != mac_length )
3396 {
3397 status = PSA_ERROR_INVALID_SIGNATURE;
3398 goto cleanup;
Gilles Peskine89167cb2018-07-08 20:12:23 +02003399 }
mohammad16036df908f2018-04-02 08:34:15 -07003400
3401 status = psa_mac_finish_internal( operation,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003402 actual_mac, sizeof( actual_mac ) );
Gilles Peskine28cd4162020-01-20 16:31:06 +01003403 if( status != PSA_SUCCESS )
3404 goto cleanup;
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003405
3406 if( safer_memcmp( mac, actual_mac, mac_length ) != 0 )
3407 status = PSA_ERROR_INVALID_SIGNATURE;
3408
3409cleanup:
3410 if( status == PSA_SUCCESS )
3411 status = psa_mac_abort( operation );
3412 else
3413 psa_mac_abort( operation );
3414
Gilles Peskine3f108122018-12-07 18:14:53 +01003415 mbedtls_platform_zeroize( actual_mac, sizeof( actual_mac ) );
Gilles Peskined911eb72018-08-14 15:18:45 +02003416
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003417 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003418}
3419
3420
Gilles Peskine20035e32018-02-03 22:44:14 +01003421
Gilles Peskine20035e32018-02-03 22:44:14 +01003422/****************************************************************/
3423/* Asymmetric cryptography */
3424/****************************************************************/
3425
Gilles Peskine2b450e32018-06-27 15:42:46 +02003426#if defined(MBEDTLS_RSA_C)
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02003427/* Decode the hash algorithm from alg and store the mbedtls encoding in
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003428 * md_alg. Verify that the hash length is acceptable. */
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02003429static psa_status_t psa_rsa_decode_md_type( psa_algorithm_t alg,
3430 size_t hash_length,
3431 mbedtls_md_type_t *md_alg )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003432{
Gilles Peskine7ed29c52018-06-26 15:50:08 +02003433 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003434 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003435 *md_alg = mbedtls_md_get_type( md_info );
3436
3437 /* The Mbed TLS RSA module uses an unsigned int for hash length
3438 * parameters. Validate that it fits so that we don't risk an
3439 * overflow later. */
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003440#if SIZE_MAX > UINT_MAX
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003441 if( hash_length > UINT_MAX )
3442 return( PSA_ERROR_INVALID_ARGUMENT );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003443#endif
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003444
3445#if defined(MBEDTLS_PKCS1_V15)
3446 /* For PKCS#1 v1.5 signature, if using a hash, the hash length
3447 * must be correct. */
3448 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) &&
3449 alg != PSA_ALG_RSA_PKCS1V15_SIGN_RAW )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003450 {
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003451 if( md_info == NULL )
3452 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003453 if( mbedtls_md_get_size( md_info ) != hash_length )
3454 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003455 }
3456#endif /* MBEDTLS_PKCS1_V15 */
3457
3458#if defined(MBEDTLS_PKCS1_V21)
3459 /* PSS requires a hash internally. */
3460 if( PSA_ALG_IS_RSA_PSS( alg ) )
3461 {
Gilles Peskine61b91d42018-06-08 16:09:36 +02003462 if( md_info == NULL )
3463 return( PSA_ERROR_NOT_SUPPORTED );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003464 }
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003465#endif /* MBEDTLS_PKCS1_V21 */
3466
Gilles Peskine61b91d42018-06-08 16:09:36 +02003467 return( PSA_SUCCESS );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003468}
3469
Gilles Peskine2b450e32018-06-27 15:42:46 +02003470static psa_status_t psa_rsa_sign( mbedtls_rsa_context *rsa,
3471 psa_algorithm_t alg,
3472 const uint8_t *hash,
3473 size_t hash_length,
3474 uint8_t *signature,
3475 size_t signature_size,
3476 size_t *signature_length )
3477{
3478 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00003479 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003480 mbedtls_md_type_t md_alg;
3481
3482 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
3483 if( status != PSA_SUCCESS )
3484 return( status );
3485
Gilles Peskine630a18a2018-06-29 17:49:35 +02003486 if( signature_size < mbedtls_rsa_get_len( rsa ) )
Gilles Peskine2b450e32018-06-27 15:42:46 +02003487 return( PSA_ERROR_BUFFER_TOO_SMALL );
3488
3489#if defined(MBEDTLS_PKCS1_V15)
3490 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
3491 {
3492 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
3493 MBEDTLS_MD_NONE );
3494 ret = mbedtls_rsa_pkcs1_sign( rsa,
3495 mbedtls_ctr_drbg_random,
3496 &global_data.ctr_drbg,
3497 MBEDTLS_RSA_PRIVATE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003498 md_alg,
3499 (unsigned int) hash_length,
3500 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003501 signature );
3502 }
3503 else
3504#endif /* MBEDTLS_PKCS1_V15 */
3505#if defined(MBEDTLS_PKCS1_V21)
3506 if( PSA_ALG_IS_RSA_PSS( alg ) )
3507 {
3508 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3509 ret = mbedtls_rsa_rsassa_pss_sign( rsa,
3510 mbedtls_ctr_drbg_random,
3511 &global_data.ctr_drbg,
3512 MBEDTLS_RSA_PRIVATE,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003513 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003514 (unsigned int) hash_length,
3515 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003516 signature );
3517 }
3518 else
3519#endif /* MBEDTLS_PKCS1_V21 */
3520 {
3521 return( PSA_ERROR_INVALID_ARGUMENT );
3522 }
3523
3524 if( ret == 0 )
Gilles Peskine630a18a2018-06-29 17:49:35 +02003525 *signature_length = mbedtls_rsa_get_len( rsa );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003526 return( mbedtls_to_psa_error( ret ) );
3527}
3528
3529static psa_status_t psa_rsa_verify( mbedtls_rsa_context *rsa,
3530 psa_algorithm_t alg,
3531 const uint8_t *hash,
3532 size_t hash_length,
3533 const uint8_t *signature,
3534 size_t signature_length )
3535{
3536 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00003537 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003538 mbedtls_md_type_t md_alg;
3539
3540 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
3541 if( status != PSA_SUCCESS )
3542 return( status );
3543
Gilles Peskine89cc74f2019-09-12 22:08:23 +02003544 if( signature_length != mbedtls_rsa_get_len( rsa ) )
3545 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003546
3547#if defined(MBEDTLS_PKCS1_V15)
3548 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
3549 {
3550 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
3551 MBEDTLS_MD_NONE );
3552 ret = mbedtls_rsa_pkcs1_verify( rsa,
3553 mbedtls_ctr_drbg_random,
3554 &global_data.ctr_drbg,
3555 MBEDTLS_RSA_PUBLIC,
3556 md_alg,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003557 (unsigned int) hash_length,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003558 hash,
3559 signature );
3560 }
3561 else
3562#endif /* MBEDTLS_PKCS1_V15 */
3563#if defined(MBEDTLS_PKCS1_V21)
3564 if( PSA_ALG_IS_RSA_PSS( alg ) )
3565 {
3566 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3567 ret = mbedtls_rsa_rsassa_pss_verify( rsa,
3568 mbedtls_ctr_drbg_random,
3569 &global_data.ctr_drbg,
3570 MBEDTLS_RSA_PUBLIC,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003571 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003572 (unsigned int) hash_length,
3573 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003574 signature );
3575 }
3576 else
3577#endif /* MBEDTLS_PKCS1_V21 */
3578 {
3579 return( PSA_ERROR_INVALID_ARGUMENT );
3580 }
Gilles Peskineef12c632018-09-13 20:37:48 +02003581
3582 /* Mbed TLS distinguishes "invalid padding" from "valid padding but
3583 * the rest of the signature is invalid". This has little use in
3584 * practice and PSA doesn't report this distinction. */
3585 if( ret == MBEDTLS_ERR_RSA_INVALID_PADDING )
3586 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003587 return( mbedtls_to_psa_error( ret ) );
3588}
3589#endif /* MBEDTLS_RSA_C */
3590
John Durkopf87e3ae2020-10-26 15:25:23 -07003591#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003592/* `ecp` cannot be const because `ecp->grp` needs to be non-const
3593 * for mbedtls_ecdsa_sign() and mbedtls_ecdsa_sign_det()
3594 * (even though these functions don't modify it). */
3595static psa_status_t psa_ecdsa_sign( mbedtls_ecp_keypair *ecp,
3596 psa_algorithm_t alg,
3597 const uint8_t *hash,
3598 size_t hash_length,
3599 uint8_t *signature,
3600 size_t signature_size,
3601 size_t *signature_length )
3602{
Janos Follath24eed8d2019-11-22 13:21:35 +00003603 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003604 mbedtls_mpi r, s;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003605 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003606 mbedtls_mpi_init( &r );
3607 mbedtls_mpi_init( &s );
3608
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003609 if( signature_size < 2 * curve_bytes )
3610 {
3611 ret = MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL;
3612 goto cleanup;
3613 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003614
John Durkop0ea39e02020-10-13 19:58:20 -07003615#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003616 if( PSA_ALG_DSA_IS_DETERMINISTIC( alg ) )
3617 {
3618 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
3619 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3620 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
Darryl Green5e843fa2019-09-05 14:06:34 +01003621 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign_det_ext( &ecp->grp, &r, &s,
3622 &ecp->d, hash,
3623 hash_length, md_alg,
3624 mbedtls_ctr_drbg_random,
3625 &global_data.ctr_drbg ) );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003626 }
3627 else
John Durkop0ea39e02020-10-13 19:58:20 -07003628#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003629 {
Gilles Peskinea05219c2018-11-16 16:02:56 +01003630 (void) alg;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003631 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign( &ecp->grp, &r, &s, &ecp->d,
3632 hash, hash_length,
3633 mbedtls_ctr_drbg_random,
3634 &global_data.ctr_drbg ) );
3635 }
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003636
3637 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &r,
3638 signature,
3639 curve_bytes ) );
3640 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &s,
3641 signature + curve_bytes,
3642 curve_bytes ) );
3643
3644cleanup:
3645 mbedtls_mpi_free( &r );
3646 mbedtls_mpi_free( &s );
3647 if( ret == 0 )
3648 *signature_length = 2 * curve_bytes;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003649 return( mbedtls_to_psa_error( ret ) );
3650}
3651
3652static psa_status_t psa_ecdsa_verify( mbedtls_ecp_keypair *ecp,
3653 const uint8_t *hash,
3654 size_t hash_length,
3655 const uint8_t *signature,
3656 size_t signature_length )
3657{
Janos Follath24eed8d2019-11-22 13:21:35 +00003658 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003659 mbedtls_mpi r, s;
3660 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
3661 mbedtls_mpi_init( &r );
3662 mbedtls_mpi_init( &s );
3663
3664 if( signature_length != 2 * curve_bytes )
3665 return( PSA_ERROR_INVALID_SIGNATURE );
3666
3667 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &r,
3668 signature,
3669 curve_bytes ) );
3670 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &s,
3671 signature + curve_bytes,
3672 curve_bytes ) );
3673
Steven Cooremanacda8342020-07-24 23:09:52 +02003674 /* Check whether the public part is loaded. If not, load it. */
3675 if( mbedtls_ecp_is_zero( &ecp->Q ) )
3676 {
3677 MBEDTLS_MPI_CHK(
3678 mbedtls_ecp_mul( &ecp->grp, &ecp->Q, &ecp->d, &ecp->grp.G,
3679 mbedtls_ctr_drbg_random, &global_data.ctr_drbg ) );
3680 }
3681
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003682 ret = mbedtls_ecdsa_verify( &ecp->grp, hash, hash_length,
3683 &ecp->Q, &r, &s );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003684
3685cleanup:
3686 mbedtls_mpi_free( &r );
3687 mbedtls_mpi_free( &s );
3688 return( mbedtls_to_psa_error( ret ) );
3689}
John Durkopf87e3ae2020-10-26 15:25:23 -07003690#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003691
Ronald Croncf56a0a2020-08-04 09:51:30 +02003692psa_status_t psa_sign_hash( mbedtls_svc_key_id_t key,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003693 psa_algorithm_t alg,
3694 const uint8_t *hash,
3695 size_t hash_length,
3696 uint8_t *signature,
3697 size_t signature_size,
3698 size_t *signature_length )
Gilles Peskine20035e32018-02-03 22:44:14 +01003699{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003700 psa_key_slot_t *slot;
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003701 psa_status_t status;
3702
3703 *signature_length = signature_size;
Gilles Peskine4019f0e2019-09-12 22:05:59 +02003704 /* Immediately reject a zero-length signature buffer. This guarantees
3705 * that signature must be a valid pointer. (On the other hand, the hash
3706 * buffer can in principle be empty since it doesn't actually have
3707 * to be a hash.) */
3708 if( signature_size == 0 )
3709 return( PSA_ERROR_BUFFER_TOO_SMALL );
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003710
Ronald Croncf56a0a2020-08-04 09:51:30 +02003711 status = psa_get_key_from_slot( key, &slot, PSA_KEY_USAGE_SIGN_HASH, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003712 if( status != PSA_SUCCESS )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003713 goto exit;
Gilles Peskine8e338702019-07-30 20:06:31 +02003714 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003715 {
3716 status = PSA_ERROR_INVALID_ARGUMENT;
3717 goto exit;
3718 }
Gilles Peskine20035e32018-02-03 22:44:14 +01003719
Steven Cooremancd84cb42020-07-16 20:28:36 +02003720 /* Try any of the available accelerators first */
3721 status = psa_driver_wrapper_sign_hash( slot,
3722 alg,
3723 hash,
3724 hash_length,
3725 signature,
3726 signature_size,
3727 signature_length );
Steven Cooreman8d2bde72020-09-04 13:06:39 +02003728 if( status != PSA_ERROR_NOT_SUPPORTED ||
3729 psa_key_lifetime_is_external( slot->attr.lifetime ) )
Steven Cooremancd84cb42020-07-16 20:28:36 +02003730 goto exit;
3731
Steven Cooreman7a250572020-07-17 16:43:05 +02003732 /* If the operation was not supported by any accelerator, try fallback. */
Gilles Peskine20035e32018-02-03 22:44:14 +01003733#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003734 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskine20035e32018-02-03 22:44:14 +01003735 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003736 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02003737
Steven Cooreman4fed4552020-08-03 14:46:03 +02003738 status = psa_load_rsa_representation( slot->attr.type,
3739 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02003740 slot->data.key.bytes,
Steven Cooremana01795d2020-07-24 22:48:15 +02003741 &rsa );
3742 if( status != PSA_SUCCESS )
3743 goto exit;
3744
Steven Cooremana2371e52020-07-28 14:30:39 +02003745 status = psa_rsa_sign( rsa,
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003746 alg,
3747 hash, hash_length,
3748 signature, signature_size,
3749 signature_length );
Steven Cooremana01795d2020-07-24 22:48:15 +02003750
Steven Cooremana2371e52020-07-28 14:30:39 +02003751 mbedtls_rsa_free( rsa );
3752 mbedtls_free( rsa );
Gilles Peskine20035e32018-02-03 22:44:14 +01003753 }
3754 else
3755#endif /* defined(MBEDTLS_RSA_C) */
3756#if defined(MBEDTLS_ECP_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003757 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
Gilles Peskine20035e32018-02-03 22:44:14 +01003758 {
John Durkop0ea39e02020-10-13 19:58:20 -07003759#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA)
Gilles Peskinea05219c2018-11-16 16:02:56 +01003760 if(
John Durkop0ea39e02020-10-13 19:58:20 -07003761#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea05219c2018-11-16 16:02:56 +01003762 PSA_ALG_IS_ECDSA( alg )
3763#else
3764 PSA_ALG_IS_RANDOMIZED_ECDSA( alg )
3765#endif
3766 )
Steven Cooremanacda8342020-07-24 23:09:52 +02003767 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003768 mbedtls_ecp_keypair *ecp = NULL;
Steven Cooreman4fed4552020-08-03 14:46:03 +02003769 status = psa_load_ecp_representation( slot->attr.type,
3770 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02003771 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02003772 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003773 if( status != PSA_SUCCESS )
3774 goto exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003775 status = psa_ecdsa_sign( ecp,
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003776 alg,
3777 hash, hash_length,
3778 signature, signature_size,
3779 signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02003780 mbedtls_ecp_keypair_free( ecp );
3781 mbedtls_free( ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003782 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003783 else
John Durkop0ea39e02020-10-13 19:58:20 -07003784#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003785 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003786 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003787 }
itayzafrir5c753392018-05-08 11:18:38 +03003788 }
3789 else
3790#endif /* defined(MBEDTLS_ECP_C) */
3791 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003792 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine20035e32018-02-03 22:44:14 +01003793 }
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003794
3795exit:
3796 /* Fill the unused part of the output buffer (the whole buffer on error,
3797 * the trailing part on success) with something that isn't a valid mac
3798 * (barring an attack on the mac and deliberately-crafted input),
3799 * in case the caller doesn't check the return status properly. */
3800 if( status == PSA_SUCCESS )
3801 memset( signature + *signature_length, '!',
3802 signature_size - *signature_length );
Gilles Peskine4019f0e2019-09-12 22:05:59 +02003803 else
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003804 memset( signature, '!', signature_size );
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003805 /* If signature_size is 0 then we have nothing to do. We must not call
3806 * memset because signature may be NULL in this case. */
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003807 return( status );
itayzafrir5c753392018-05-08 11:18:38 +03003808}
3809
Ronald Croncf56a0a2020-08-04 09:51:30 +02003810psa_status_t psa_verify_hash( mbedtls_svc_key_id_t key,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003811 psa_algorithm_t alg,
3812 const uint8_t *hash,
3813 size_t hash_length,
3814 const uint8_t *signature,
3815 size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03003816{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003817 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003818 psa_status_t status;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003819
Ronald Croncf56a0a2020-08-04 09:51:30 +02003820 status = psa_get_key_from_slot( key, &slot,
3821 PSA_KEY_USAGE_VERIFY_HASH, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003822 if( status != PSA_SUCCESS )
3823 return( status );
itayzafrir5c753392018-05-08 11:18:38 +03003824
Steven Cooreman55ae2172020-07-17 19:46:15 +02003825 /* Try any of the available accelerators first */
3826 status = psa_driver_wrapper_verify_hash( slot,
3827 alg,
3828 hash,
3829 hash_length,
3830 signature,
3831 signature_length );
Steven Cooreman8d2bde72020-09-04 13:06:39 +02003832 if( status != PSA_ERROR_NOT_SUPPORTED ||
3833 psa_key_lifetime_is_external( slot->attr.lifetime ) )
Steven Cooreman55ae2172020-07-17 19:46:15 +02003834 return status;
3835
Gilles Peskine61b91d42018-06-08 16:09:36 +02003836#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003837 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003838 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003839 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02003840
Steven Cooreman4fed4552020-08-03 14:46:03 +02003841 status = psa_load_rsa_representation( slot->attr.type,
3842 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02003843 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02003844 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003845 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02003846 return( status );
Steven Cooremana01795d2020-07-24 22:48:15 +02003847
Steven Cooremana2371e52020-07-28 14:30:39 +02003848 status = psa_rsa_verify( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02003849 alg,
3850 hash, hash_length,
3851 signature, signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02003852 mbedtls_rsa_free( rsa );
3853 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003854 return( status );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003855 }
3856 else
3857#endif /* defined(MBEDTLS_RSA_C) */
itayzafrir5c753392018-05-08 11:18:38 +03003858#if defined(MBEDTLS_ECP_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003859 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
itayzafrir5c753392018-05-08 11:18:38 +03003860 {
John Durkopf87e3ae2020-10-26 15:25:23 -07003861#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003862 if( PSA_ALG_IS_ECDSA( alg ) )
Steven Cooremanacda8342020-07-24 23:09:52 +02003863 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003864 mbedtls_ecp_keypair *ecp = NULL;
Steven Cooreman4fed4552020-08-03 14:46:03 +02003865 status = psa_load_ecp_representation( slot->attr.type,
3866 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02003867 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02003868 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003869 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02003870 return( status );
Steven Cooremana2371e52020-07-28 14:30:39 +02003871 status = psa_ecdsa_verify( ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02003872 hash, hash_length,
3873 signature, signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02003874 mbedtls_ecp_keypair_free( ecp );
3875 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02003876 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02003877 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003878 else
John Durkopf87e3ae2020-10-26 15:25:23 -07003879#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003880 {
3881 return( PSA_ERROR_INVALID_ARGUMENT );
3882 }
itayzafrir5c753392018-05-08 11:18:38 +03003883 }
Gilles Peskine20035e32018-02-03 22:44:14 +01003884 else
3885#endif /* defined(MBEDTLS_ECP_C) */
3886 {
3887 return( PSA_ERROR_NOT_SUPPORTED );
3888 }
3889}
3890
Gilles Peskine072ac562018-06-30 00:21:29 +02003891#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PKCS1_V21)
3892static void psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
3893 mbedtls_rsa_context *rsa )
3894{
3895 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
3896 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3897 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
3898 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3899}
3900#endif /* defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PKCS1_V21) */
3901
Ronald Croncf56a0a2020-08-04 09:51:30 +02003902psa_status_t psa_asymmetric_encrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003903 psa_algorithm_t alg,
3904 const uint8_t *input,
3905 size_t input_length,
3906 const uint8_t *salt,
3907 size_t salt_length,
3908 uint8_t *output,
3909 size_t output_size,
3910 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003911{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003912 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003913 psa_status_t status;
3914
Darryl Green5cc689a2018-07-24 15:34:10 +01003915 (void) input;
3916 (void) input_length;
3917 (void) salt;
3918 (void) output;
3919 (void) output_size;
3920
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003921 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003922
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003923 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3924 return( PSA_ERROR_INVALID_ARGUMENT );
3925
Ronald Croncf56a0a2020-08-04 09:51:30 +02003926 status = psa_get_transparent_key( key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003927 if( status != PSA_SUCCESS )
3928 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003929 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
3930 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003931 return( PSA_ERROR_INVALID_ARGUMENT );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003932
3933#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003934 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003935 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003936 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman4fed4552020-08-03 14:46:03 +02003937 status = psa_load_rsa_representation( slot->attr.type,
3938 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02003939 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02003940 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003941 if( status != PSA_SUCCESS )
Steven Cooreman4fed4552020-08-03 14:46:03 +02003942 goto rsa_exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003943
3944 if( output_size < mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003945 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003946 status = PSA_ERROR_BUFFER_TOO_SMALL;
3947 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003948 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003949#if defined(MBEDTLS_PKCS1_V15)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003950 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003951 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003952 status = mbedtls_to_psa_error(
3953 mbedtls_rsa_pkcs1_encrypt( rsa,
3954 mbedtls_ctr_drbg_random,
3955 &global_data.ctr_drbg,
3956 MBEDTLS_RSA_PUBLIC,
3957 input_length,
3958 input,
3959 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003960 }
3961 else
3962#endif /* MBEDTLS_PKCS1_V15 */
3963#if defined(MBEDTLS_PKCS1_V21)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003964 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003965 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003966 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02003967 status = mbedtls_to_psa_error(
3968 mbedtls_rsa_rsaes_oaep_encrypt( rsa,
3969 mbedtls_ctr_drbg_random,
3970 &global_data.ctr_drbg,
3971 MBEDTLS_RSA_PUBLIC,
3972 salt, salt_length,
3973 input_length,
3974 input,
3975 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003976 }
3977 else
3978#endif /* MBEDTLS_PKCS1_V21 */
3979 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003980 status = PSA_ERROR_INVALID_ARGUMENT;
3981 goto rsa_exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003982 }
Steven Cooreman4fed4552020-08-03 14:46:03 +02003983rsa_exit:
3984 if( status == PSA_SUCCESS )
Steven Cooremana2371e52020-07-28 14:30:39 +02003985 *output_length = mbedtls_rsa_get_len( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003986
Steven Cooremana2371e52020-07-28 14:30:39 +02003987 mbedtls_rsa_free( rsa );
3988 mbedtls_free( rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02003989 return( status );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003990 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003991 else
Gilles Peskineb75e4f12018-06-08 17:44:47 +02003992#endif /* defined(MBEDTLS_RSA_C) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003993 {
3994 return( PSA_ERROR_NOT_SUPPORTED );
3995 }
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003996}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003997
Ronald Croncf56a0a2020-08-04 09:51:30 +02003998psa_status_t psa_asymmetric_decrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003999 psa_algorithm_t alg,
4000 const uint8_t *input,
4001 size_t input_length,
4002 const uint8_t *salt,
4003 size_t salt_length,
4004 uint8_t *output,
4005 size_t output_size,
4006 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004007{
Gilles Peskine2f060a82018-12-04 17:12:32 +01004008 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004009 psa_status_t status;
4010
Darryl Green5cc689a2018-07-24 15:34:10 +01004011 (void) input;
4012 (void) input_length;
4013 (void) salt;
4014 (void) output;
4015 (void) output_size;
4016
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03004017 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004018
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02004019 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
4020 return( PSA_ERROR_INVALID_ARGUMENT );
4021
Ronald Croncf56a0a2020-08-04 09:51:30 +02004022 status = psa_get_transparent_key( key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004023 if( status != PSA_SUCCESS )
4024 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02004025 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004026 return( PSA_ERROR_INVALID_ARGUMENT );
4027
4028#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02004029 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004030 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004031 mbedtls_rsa_context *rsa = NULL;
4032 status = psa_load_rsa_representation( slot->attr.type,
4033 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02004034 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02004035 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02004036 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02004037 return( status );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004038
Steven Cooremana2371e52020-07-28 14:30:39 +02004039 if( input_length != mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02004040 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004041 status = PSA_ERROR_INVALID_ARGUMENT;
4042 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02004043 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004044
4045#if defined(MBEDTLS_PKCS1_V15)
Gilles Peskine6afe7892018-05-31 13:16:08 +02004046 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004047 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004048 status = mbedtls_to_psa_error(
4049 mbedtls_rsa_pkcs1_decrypt( rsa,
4050 mbedtls_ctr_drbg_random,
4051 &global_data.ctr_drbg,
4052 MBEDTLS_RSA_PRIVATE,
4053 output_length,
4054 input,
4055 output,
4056 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004057 }
4058 else
4059#endif /* MBEDTLS_PKCS1_V15 */
4060#if defined(MBEDTLS_PKCS1_V21)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02004061 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004062 {
Steven Cooremana2371e52020-07-28 14:30:39 +02004063 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02004064 status = mbedtls_to_psa_error(
4065 mbedtls_rsa_rsaes_oaep_decrypt( rsa,
4066 mbedtls_ctr_drbg_random,
4067 &global_data.ctr_drbg,
4068 MBEDTLS_RSA_PRIVATE,
4069 salt, salt_length,
4070 output_length,
4071 input,
4072 output,
4073 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004074 }
4075 else
4076#endif /* MBEDTLS_PKCS1_V21 */
4077 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004078 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004079 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03004080
Steven Cooreman4fed4552020-08-03 14:46:03 +02004081rsa_exit:
Steven Cooremana2371e52020-07-28 14:30:39 +02004082 mbedtls_rsa_free( rsa );
4083 mbedtls_free( rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02004084 return( status );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004085 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004086 else
Gilles Peskineb75e4f12018-06-08 17:44:47 +02004087#endif /* defined(MBEDTLS_RSA_C) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004088 {
4089 return( PSA_ERROR_NOT_SUPPORTED );
4090 }
Gilles Peskine5b051bc2018-05-31 13:25:48 +02004091}
Gilles Peskine20035e32018-02-03 22:44:14 +01004092
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004093
4094
mohammad1603503973b2018-03-12 15:59:30 +02004095/****************************************************************/
4096/* Symmetric cryptography */
4097/****************************************************************/
4098
Gilles Peskinee553c652018-06-04 16:22:46 +02004099static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004100 mbedtls_svc_key_id_t key,
Gilles Peskine7e928852018-06-04 16:23:10 +02004101 psa_algorithm_t alg,
4102 mbedtls_operation_t cipher_operation )
mohammad1603503973b2018-03-12 15:59:30 +02004103{
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004104 int ret = 0;
4105 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Gilles Peskine2f060a82018-12-04 17:12:32 +01004106 psa_key_slot_t *slot;
mohammad1603503973b2018-03-12 15:59:30 +02004107 size_t key_bits;
4108 const mbedtls_cipher_info_t *cipher_info = NULL;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004109 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
4110 PSA_KEY_USAGE_ENCRYPT :
4111 PSA_KEY_USAGE_DECRYPT );
mohammad1603503973b2018-03-12 15:59:30 +02004112
Steven Cooremand3feccd2020-09-01 15:56:14 +02004113 /* A context must be freshly initialized before it can be set up. */
4114 if( operation->alg != 0 )
4115 return( PSA_ERROR_BAD_STATE );
4116
Steven Cooremana07b9972020-09-10 14:54:14 +02004117 /* The requested algorithm must be one that can be processed by cipher. */
4118 if( ! PSA_ALG_IS_CIPHER( alg ) )
Steven Cooremana07b9972020-09-10 14:54:14 +02004119 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremand3feccd2020-09-01 15:56:14 +02004120
Steven Cooremanef8575e2020-09-11 11:44:50 +02004121 /* Fetch key material from key storage. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02004122 status = psa_get_key_from_slot( key, &slot, usage, alg );
Steven Cooremanef8575e2020-09-11 11:44:50 +02004123 if( status != PSA_SUCCESS )
4124 goto exit;
4125
4126 /* Initialize the operation struct members, except for alg. The alg member
4127 * is used to indicate to psa_cipher_abort that there are resources to free,
4128 * so we only set it after resources have been allocated/initialized. */
Steven Cooremana07b9972020-09-10 14:54:14 +02004129 operation->key_set = 0;
4130 operation->iv_set = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004131 operation->mbedtls_in_use = 0;
Steven Cooremana07b9972020-09-10 14:54:14 +02004132 operation->iv_size = 0;
4133 operation->block_size = 0;
4134 if( alg == PSA_ALG_ECB_NO_PADDING )
4135 operation->iv_required = 0;
4136 else
4137 operation->iv_required = 1;
4138
Steven Cooremana07b9972020-09-10 14:54:14 +02004139 /* Try doing the operation through a driver before using software fallback. */
Steven Cooreman37941cb2020-07-28 18:49:51 +02004140 if( cipher_operation == MBEDTLS_ENCRYPT )
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004141 status = psa_driver_wrapper_cipher_encrypt_setup( &operation->ctx.driver,
Steven Cooreman37941cb2020-07-28 18:49:51 +02004142 slot,
4143 alg );
4144 else
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004145 status = psa_driver_wrapper_cipher_decrypt_setup( &operation->ctx.driver,
Steven Cooreman37941cb2020-07-28 18:49:51 +02004146 slot,
4147 alg );
4148
Steven Cooremanef8575e2020-09-11 11:44:50 +02004149 if( status == PSA_SUCCESS )
Steven Cooreman6d81f7e2020-09-14 13:14:31 +02004150 {
Steven Cooremanef8575e2020-09-11 11:44:50 +02004151 /* Once the driver context is initialised, it needs to be freed using
4152 * psa_cipher_abort. Indicate this through setting alg. */
4153 operation->alg = alg;
Steven Cooreman6d81f7e2020-09-14 13:14:31 +02004154 }
Steven Cooremanef8575e2020-09-11 11:44:50 +02004155
Steven Cooremand3feccd2020-09-01 15:56:14 +02004156 if( status != PSA_ERROR_NOT_SUPPORTED ||
4157 psa_key_lifetime_is_external( slot->attr.lifetime ) )
4158 goto exit;
4159
Steven Cooremana07b9972020-09-10 14:54:14 +02004160 /* Proceed with initializing an mbed TLS cipher context if no driver is
Steven Cooremand3feccd2020-09-01 15:56:14 +02004161 * available for the given algorithm & key. */
4162 mbedtls_cipher_init( &operation->ctx.cipher );
mohammad1603503973b2018-03-12 15:59:30 +02004163
Steven Cooremana07b9972020-09-10 14:54:14 +02004164 /* Once the cipher context is initialised, it needs to be freed using
Steven Cooremanef8575e2020-09-11 11:44:50 +02004165 * psa_cipher_abort. Indicate there is something to be freed through setting
4166 * alg, and indicate the operation is being done using mbedtls crypto through
4167 * setting mbedtls_in_use. */
Steven Cooremana07b9972020-09-10 14:54:14 +02004168 operation->alg = alg;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004169 operation->mbedtls_in_use = 1;
Steven Cooremana07b9972020-09-10 14:54:14 +02004170
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02004171 key_bits = psa_get_key_slot_bits( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +02004172 cipher_info = mbedtls_cipher_info_from_psa( alg, slot->attr.type, key_bits, NULL );
mohammad1603503973b2018-03-12 15:59:30 +02004173 if( cipher_info == NULL )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004174 {
4175 status = PSA_ERROR_NOT_SUPPORTED;
4176 goto exit;
4177 }
mohammad1603503973b2018-03-12 15:59:30 +02004178
mohammad1603503973b2018-03-12 15:59:30 +02004179 ret = mbedtls_cipher_setup( &operation->ctx.cipher, cipher_info );
Moran Peker41deec42018-04-04 15:43:05 +03004180 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004181 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004182
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004183#if defined(MBEDTLS_DES_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02004184 if( slot->attr.type == PSA_KEY_TYPE_DES && key_bits == 128 )
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004185 {
4186 /* Two-key Triple-DES is 3-key Triple-DES with K1=K3 */
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02004187 uint8_t keys[24];
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004188 memcpy( keys, slot->data.key.data, 16 );
4189 memcpy( keys + 16, slot->data.key.data, 8 );
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004190 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
4191 keys,
4192 192, cipher_operation );
4193 }
4194 else
4195#endif
4196 {
4197 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004198 slot->data.key.data,
Jaeden Amero23bbb752018-06-26 14:16:54 +01004199 (int) key_bits, cipher_operation );
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004200 }
Moran Peker41deec42018-04-04 15:43:05 +03004201 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004202 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004203
mohammad16038481e742018-03-18 13:57:31 +02004204#if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004205 switch( alg )
mohammad16038481e742018-03-18 13:57:31 +02004206 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004207 case PSA_ALG_CBC_NO_PADDING:
4208 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
4209 MBEDTLS_PADDING_NONE );
4210 break;
4211 case PSA_ALG_CBC_PKCS7:
4212 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
4213 MBEDTLS_PADDING_PKCS7 );
4214 break;
4215 default:
4216 /* The algorithm doesn't involve padding. */
4217 ret = 0;
4218 break;
4219 }
4220 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004221 goto exit;
mohammad16038481e742018-03-18 13:57:31 +02004222#endif //MBEDTLS_CIPHER_MODE_WITH_PADDING
4223
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004224 operation->block_size = ( PSA_ALG_IS_STREAM_CIPHER( alg ) ? 1 :
Gilles Peskine8e338702019-07-30 20:06:31 +02004225 PSA_BLOCK_CIPHER_BLOCK_SIZE( slot->attr.type ) );
Steven Cooremana6033e92020-08-25 11:47:50 +02004226 if( ( alg & PSA_ALG_CIPHER_FROM_BLOCK_FLAG ) != 0 &&
4227 alg != PSA_ALG_ECB_NO_PADDING )
mohammad16038481e742018-03-18 13:57:31 +02004228 {
Gilles Peskine8e338702019-07-30 20:06:31 +02004229 operation->iv_size = PSA_BLOCK_CIPHER_BLOCK_SIZE( slot->attr.type );
mohammad16038481e742018-03-18 13:57:31 +02004230 }
Gilles Peskine26869f22019-05-06 15:25:00 +02004231#if defined(MBEDTLS_CHACHA20_C)
4232 else
4233 if( alg == PSA_ALG_CHACHA20 )
4234 operation->iv_size = 12;
4235#endif
mohammad1603503973b2018-03-12 15:59:30 +02004236
Steven Cooreman7df02922020-09-09 15:28:49 +02004237 status = PSA_SUCCESS;
4238
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004239exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02004240 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004241 status = mbedtls_to_psa_error( ret );
Steven Cooreman7df02922020-09-09 15:28:49 +02004242 if( status == PSA_SUCCESS )
4243 {
4244 /* Update operation flags for both driver and software implementations */
4245 operation->key_set = 1;
4246 }
4247 else
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004248 psa_cipher_abort( operation );
4249 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004250}
4251
Gilles Peskinefe119512018-07-08 21:39:34 +02004252psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004253 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02004254 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02004255{
Ronald Croncf56a0a2020-08-04 09:51:30 +02004256 return( psa_cipher_setup( operation, key, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02004257}
4258
Gilles Peskinefe119512018-07-08 21:39:34 +02004259psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004260 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02004261 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02004262{
Ronald Croncf56a0a2020-08-04 09:51:30 +02004263 return( psa_cipher_setup( operation, key, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02004264}
4265
Gilles Peskinefe119512018-07-08 21:39:34 +02004266psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004267 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02004268 size_t iv_size,
4269 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02004270{
itayzafrir534bd7c2018-08-02 13:56:32 +03004271 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00004272 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooreman7df02922020-09-09 15:28:49 +02004273 if( operation->iv_set || ! operation->iv_required )
4274 {
4275 return( PSA_ERROR_BAD_STATE );
4276 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004277
Steven Cooremanef8575e2020-09-11 11:44:50 +02004278 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004279 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004280 status = psa_driver_wrapper_cipher_generate_iv( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004281 iv,
4282 iv_size,
4283 iv_length );
4284 goto exit;
4285 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004286
Moran Peker41deec42018-04-04 15:43:05 +03004287 if( iv_size < operation->iv_size )
mohammad1603503973b2018-03-12 15:59:30 +02004288 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004289 status = PSA_ERROR_BUFFER_TOO_SMALL;
Moran Peker41deec42018-04-04 15:43:05 +03004290 goto exit;
4291 }
Gilles Peskine7e928852018-06-04 16:23:10 +02004292 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg,
4293 iv, operation->iv_size );
Moran Peker41deec42018-04-04 15:43:05 +03004294 if( ret != 0 )
4295 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004296 status = mbedtls_to_psa_error( ret );
Gilles Peskinee553c652018-06-04 16:22:46 +02004297 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004298 }
Gilles Peskinee553c652018-06-04 16:22:46 +02004299
mohammad16038481e742018-03-18 13:57:31 +02004300 *iv_length = operation->iv_size;
itayzafrir534bd7c2018-08-02 13:56:32 +03004301 status = psa_cipher_set_iv( operation, iv, *iv_length );
Moran Peker41deec42018-04-04 15:43:05 +03004302
Moran Peker395db872018-05-31 14:07:14 +03004303exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02004304 if( status == PSA_SUCCESS )
4305 operation->iv_set = 1;
4306 else
Moran Peker395db872018-05-31 14:07:14 +03004307 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004308 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004309}
4310
Gilles Peskinefe119512018-07-08 21:39:34 +02004311psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004312 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02004313 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02004314{
itayzafrir534bd7c2018-08-02 13:56:32 +03004315 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00004316 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooreman7df02922020-09-09 15:28:49 +02004317 if( operation->iv_set || ! operation->iv_required )
4318 {
4319 return( PSA_ERROR_BAD_STATE );
4320 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004321
Steven Cooremanef8575e2020-09-11 11:44:50 +02004322 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004323 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004324 status = psa_driver_wrapper_cipher_set_iv( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004325 iv,
4326 iv_length );
4327 goto exit;
4328 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004329
Moran Pekera28258c2018-05-29 16:25:04 +03004330 if( iv_length != operation->iv_size )
Moran Peker71f19ae2018-04-22 20:23:16 +03004331 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004332 status = PSA_ERROR_INVALID_ARGUMENT;
4333 goto exit;
Moran Peker71f19ae2018-04-22 20:23:16 +03004334 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004335 ret = mbedtls_cipher_set_iv( &operation->ctx.cipher, iv, iv_length );
4336 status = mbedtls_to_psa_error( ret );
4337exit:
4338 if( status == PSA_SUCCESS )
4339 operation->iv_set = 1;
4340 else
mohammad1603503973b2018-03-12 15:59:30 +02004341 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004342 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004343}
4344
Steven Cooreman177deba2020-09-07 17:14:14 +02004345/* Process input for which the algorithm is set to ECB mode. This requires
4346 * manual processing, since the PSA API is defined as being able to process
4347 * arbitrary-length calls to psa_cipher_update() with ECB mode, but the
4348 * underlying mbedtls_cipher_update only takes full blocks. */
4349static psa_status_t psa_cipher_update_ecb_internal(
4350 mbedtls_cipher_context_t *ctx,
4351 const uint8_t *input,
4352 size_t input_length,
4353 uint8_t *output,
4354 size_t output_size,
4355 size_t *output_length )
4356{
4357 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4358 size_t block_size = ctx->cipher_info->block_size;
4359 size_t internal_output_length = 0;
4360 *output_length = 0;
4361
4362 if( input_length == 0 )
4363 {
4364 status = PSA_SUCCESS;
4365 goto exit;
4366 }
4367
4368 if( ctx->unprocessed_len > 0 )
4369 {
4370 /* Fill up to block size, and run the block if there's a full one. */
4371 size_t bytes_to_copy = block_size - ctx->unprocessed_len;
4372
4373 if( input_length < bytes_to_copy )
4374 bytes_to_copy = input_length;
4375
4376 memcpy( &( ctx->unprocessed_data[ctx->unprocessed_len] ),
4377 input, bytes_to_copy );
4378 input_length -= bytes_to_copy;
4379 input += bytes_to_copy;
4380 ctx->unprocessed_len += bytes_to_copy;
4381
4382 if( ctx->unprocessed_len == block_size )
4383 {
4384 status = mbedtls_to_psa_error(
4385 mbedtls_cipher_update( ctx,
4386 ctx->unprocessed_data,
4387 block_size,
4388 output, &internal_output_length ) );
4389
4390 if( status != PSA_SUCCESS )
4391 goto exit;
4392
4393 output += internal_output_length;
4394 output_size -= internal_output_length;
4395 *output_length += internal_output_length;
4396 ctx->unprocessed_len = 0;
4397 }
4398 }
4399
4400 while( input_length >= block_size )
4401 {
4402 /* Run all full blocks we have, one by one */
4403 status = mbedtls_to_psa_error(
4404 mbedtls_cipher_update( ctx, input,
4405 block_size,
4406 output, &internal_output_length ) );
4407
4408 if( status != PSA_SUCCESS )
4409 goto exit;
4410
4411 input_length -= block_size;
4412 input += block_size;
4413
4414 output += internal_output_length;
4415 output_size -= internal_output_length;
4416 *output_length += internal_output_length;
4417 }
4418
4419 if( input_length > 0 )
4420 {
4421 /* Save unprocessed bytes for later processing */
4422 memcpy( &( ctx->unprocessed_data[ctx->unprocessed_len] ),
4423 input, input_length );
4424 ctx->unprocessed_len += input_length;
4425 }
4426
4427 status = PSA_SUCCESS;
4428
4429exit:
4430 return( status );
4431}
4432
Gilles Peskinee553c652018-06-04 16:22:46 +02004433psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
4434 const uint8_t *input,
4435 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004436 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02004437 size_t output_size,
4438 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02004439{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004440 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine89d789c2018-06-04 17:17:16 +02004441 size_t expected_output_size;
Steven Cooreman7df02922020-09-09 15:28:49 +02004442 if( operation->alg == 0 )
4443 {
4444 return( PSA_ERROR_BAD_STATE );
4445 }
4446 if( operation->iv_required && ! operation->iv_set )
4447 {
4448 return( PSA_ERROR_BAD_STATE );
4449 }
Jaeden Ameroab439972019-02-15 14:12:05 +00004450
Steven Cooremanef8575e2020-09-11 11:44:50 +02004451 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004452 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004453 status = psa_driver_wrapper_cipher_update( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004454 input,
4455 input_length,
4456 output,
4457 output_size,
4458 output_length );
4459 goto exit;
4460 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004461
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004462 if( ! PSA_ALG_IS_STREAM_CIPHER( operation->alg ) )
Gilles Peskine89d789c2018-06-04 17:17:16 +02004463 {
4464 /* Take the unprocessed partial block left over from previous
4465 * update calls, if any, plus the input to this call. Remove
4466 * the last partial block, if any. You get the data that will be
4467 * output in this call. */
4468 expected_output_size =
4469 ( operation->ctx.cipher.unprocessed_len + input_length )
4470 / operation->block_size * operation->block_size;
4471 }
4472 else
4473 {
4474 expected_output_size = input_length;
4475 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004476
Gilles Peskine89d789c2018-06-04 17:17:16 +02004477 if( output_size < expected_output_size )
itayzafrir534bd7c2018-08-02 13:56:32 +03004478 {
4479 status = PSA_ERROR_BUFFER_TOO_SMALL;
4480 goto exit;
4481 }
mohammad160382759612018-03-12 18:16:40 +02004482
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004483 if( operation->alg == PSA_ALG_ECB_NO_PADDING )
4484 {
4485 /* mbedtls_cipher_update has an API inconsistency: it will only
4486 * process a single block at a time in ECB mode. Abstract away that
4487 * inconsistency here to match the PSA API behaviour. */
Steven Cooreman177deba2020-09-07 17:14:14 +02004488 status = psa_cipher_update_ecb_internal( &operation->ctx.cipher,
4489 input,
4490 input_length,
4491 output,
4492 output_size,
4493 output_length );
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004494 }
4495 else
4496 {
4497 status = mbedtls_to_psa_error(
4498 mbedtls_cipher_update( &operation->ctx.cipher, input,
4499 input_length, output, output_length ) );
4500 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004501exit:
4502 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02004503 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004504 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004505}
4506
Gilles Peskinee553c652018-06-04 16:22:46 +02004507psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
4508 uint8_t *output,
4509 size_t output_size,
4510 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02004511{
David Saadab4ecc272019-02-14 13:48:10 +02004512 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Gilles Peskinee553c652018-06-04 16:22:46 +02004513 uint8_t temp_output_buffer[MBEDTLS_MAX_BLOCK_LENGTH];
Steven Cooreman7df02922020-09-09 15:28:49 +02004514 if( operation->alg == 0 )
4515 {
4516 return( PSA_ERROR_BAD_STATE );
4517 }
4518 if( operation->iv_required && ! operation->iv_set )
4519 {
4520 return( PSA_ERROR_BAD_STATE );
4521 }
Moran Pekerbed71a22018-04-22 20:19:20 +03004522
Steven Cooremanef8575e2020-09-11 11:44:50 +02004523 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004524 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004525 status = psa_driver_wrapper_cipher_finish( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004526 output,
4527 output_size,
4528 output_length );
Steven Cooremanef8575e2020-09-11 11:44:50 +02004529 goto exit;
Steven Cooreman8b122252020-09-03 15:30:32 +02004530 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004531
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004532 if( operation->ctx.cipher.unprocessed_len != 0 )
Moran Peker7cb22b82018-06-05 11:40:02 +03004533 {
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004534 if( operation->alg == PSA_ALG_ECB_NO_PADDING ||
Fredrik Strupef90e3012020-09-28 16:11:33 +02004535 operation->alg == PSA_ALG_CBC_NO_PADDING )
Steven Cooremana6033e92020-08-25 11:47:50 +02004536 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004537 status = PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004538 goto exit;
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004539 }
Moran Pekerdc38ebc2018-04-30 15:45:34 +03004540 }
4541
Steven Cooremanef8575e2020-09-11 11:44:50 +02004542 status = mbedtls_to_psa_error(
4543 mbedtls_cipher_finish( &operation->ctx.cipher,
4544 temp_output_buffer,
4545 output_length ) );
4546 if( status != PSA_SUCCESS )
4547 goto exit;
Janos Follath315b51c2018-07-09 16:04:51 +01004548
Gilles Peskine46f1fd72018-06-28 19:31:31 +02004549 if( *output_length == 0 )
Janos Follath315b51c2018-07-09 16:04:51 +01004550 ; /* Nothing to copy. Note that output may be NULL in this case. */
Gilles Peskine46f1fd72018-06-28 19:31:31 +02004551 else if( output_size >= *output_length )
Moran Pekerdc38ebc2018-04-30 15:45:34 +03004552 memcpy( output, temp_output_buffer, *output_length );
4553 else
Janos Follath315b51c2018-07-09 16:04:51 +01004554 status = PSA_ERROR_BUFFER_TOO_SMALL;
mohammad1603503973b2018-03-12 15:59:30 +02004555
Steven Cooremanef8575e2020-09-11 11:44:50 +02004556exit:
4557 if( operation->mbedtls_in_use == 1 )
4558 mbedtls_platform_zeroize( temp_output_buffer, sizeof( temp_output_buffer ) );
Janos Follath315b51c2018-07-09 16:04:51 +01004559
Steven Cooremanef8575e2020-09-11 11:44:50 +02004560 if( status == PSA_SUCCESS )
4561 return( psa_cipher_abort( operation ) );
4562 else
4563 {
4564 *output_length = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004565 (void) psa_cipher_abort( operation );
Janos Follath315b51c2018-07-09 16:04:51 +01004566
Steven Cooremanef8575e2020-09-11 11:44:50 +02004567 return( status );
4568 }
mohammad1603503973b2018-03-12 15:59:30 +02004569}
4570
Gilles Peskinee553c652018-06-04 16:22:46 +02004571psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
4572{
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004573 if( operation->alg == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02004574 {
Steven Cooremana07b9972020-09-10 14:54:14 +02004575 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02004576 * in use. It's ok to call abort on such an object, and there's
4577 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004578 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02004579 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004580
Gilles Peskinef9c2c092018-06-21 16:57:07 +02004581 /* Sanity check (shouldn't happen: operation->alg should
4582 * always have been initialized to a valid value). */
4583 if( ! PSA_ALG_IS_CIPHER( operation->alg ) )
4584 return( PSA_ERROR_BAD_STATE );
4585
Steven Cooremanef8575e2020-09-11 11:44:50 +02004586 if( operation->mbedtls_in_use == 0 )
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004587 psa_driver_wrapper_cipher_abort( &operation->ctx.driver );
Steven Cooremand3feccd2020-09-01 15:56:14 +02004588 else
4589 mbedtls_cipher_free( &operation->ctx.cipher );
Gilles Peskinee553c652018-06-04 16:22:46 +02004590
Moran Peker41deec42018-04-04 15:43:05 +03004591 operation->alg = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004592 operation->key_set = 0;
4593 operation->iv_set = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004594 operation->mbedtls_in_use = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004595 operation->iv_size = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004596 operation->block_size = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004597 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004598
Moran Peker395db872018-05-31 14:07:14 +03004599 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02004600}
4601
Gilles Peskinea0655c32018-04-30 17:06:50 +02004602
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004603
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004604
mohammad16035955c982018-04-26 00:53:03 +03004605/****************************************************************/
4606/* AEAD */
4607/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004608
Gilles Peskineedf9a652018-08-17 18:11:56 +02004609typedef struct
4610{
Gilles Peskine2f060a82018-12-04 17:12:32 +01004611 psa_key_slot_t *slot;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004612 const mbedtls_cipher_info_t *cipher_info;
4613 union
4614 {
4615#if defined(MBEDTLS_CCM_C)
4616 mbedtls_ccm_context ccm;
4617#endif /* MBEDTLS_CCM_C */
4618#if defined(MBEDTLS_GCM_C)
4619 mbedtls_gcm_context gcm;
4620#endif /* MBEDTLS_GCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004621#if defined(MBEDTLS_CHACHAPOLY_C)
4622 mbedtls_chachapoly_context chachapoly;
4623#endif /* MBEDTLS_CHACHAPOLY_C */
Gilles Peskineedf9a652018-08-17 18:11:56 +02004624 } ctx;
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004625 psa_algorithm_t core_alg;
4626 uint8_t full_tag_length;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004627 uint8_t tag_length;
4628} aead_operation_t;
4629
Gilles Peskine30a9e412019-01-14 18:36:12 +01004630static void psa_aead_abort_internal( aead_operation_t *operation )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004631{
Gilles Peskinef8a8fe62018-08-21 16:38:05 +02004632 switch( operation->core_alg )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004633 {
4634#if defined(MBEDTLS_CCM_C)
4635 case PSA_ALG_CCM:
4636 mbedtls_ccm_free( &operation->ctx.ccm );
4637 break;
4638#endif /* MBEDTLS_CCM_C */
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004639#if defined(MBEDTLS_GCM_C)
Gilles Peskineedf9a652018-08-17 18:11:56 +02004640 case PSA_ALG_GCM:
4641 mbedtls_gcm_free( &operation->ctx.gcm );
4642 break;
4643#endif /* MBEDTLS_GCM_C */
4644 }
4645}
4646
4647static psa_status_t psa_aead_setup( aead_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004648 mbedtls_svc_key_id_t key,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004649 psa_key_usage_t usage,
4650 psa_algorithm_t alg )
4651{
4652 psa_status_t status;
4653 size_t key_bits;
4654 mbedtls_cipher_id_t cipher_id;
4655
Ronald Croncf56a0a2020-08-04 09:51:30 +02004656 status = psa_get_transparent_key( key, &operation->slot, usage, alg );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004657 if( status != PSA_SUCCESS )
4658 return( status );
4659
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02004660 key_bits = psa_get_key_slot_bits( operation->slot );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004661
4662 operation->cipher_info =
Gilles Peskine8e338702019-07-30 20:06:31 +02004663 mbedtls_cipher_info_from_psa( alg, operation->slot->attr.type, key_bits,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004664 &cipher_id );
4665 if( operation->cipher_info == NULL )
4666 return( PSA_ERROR_NOT_SUPPORTED );
4667
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004668 switch( PSA_ALG_AEAD_WITH_TAG_LENGTH( alg, 0 ) )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004669 {
4670#if defined(MBEDTLS_CCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004671 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CCM, 0 ):
4672 operation->core_alg = PSA_ALG_CCM;
4673 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004674 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.
4675 * The call to mbedtls_ccm_encrypt_and_tag or
4676 * mbedtls_ccm_auth_decrypt will validate the tag length. */
Gilles Peskine8e338702019-07-30 20:06:31 +02004677 if( PSA_BLOCK_CIPHER_BLOCK_SIZE( operation->slot->attr.type ) != 16 )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004678 return( PSA_ERROR_INVALID_ARGUMENT );
4679 mbedtls_ccm_init( &operation->ctx.ccm );
4680 status = mbedtls_to_psa_error(
4681 mbedtls_ccm_setkey( &operation->ctx.ccm, cipher_id,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004682 operation->slot->data.key.data,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004683 (unsigned int) key_bits ) );
4684 if( status != 0 )
4685 goto cleanup;
4686 break;
4687#endif /* MBEDTLS_CCM_C */
4688
4689#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004690 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_GCM, 0 ):
4691 operation->core_alg = PSA_ALG_GCM;
4692 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004693 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16.
4694 * The call to mbedtls_gcm_crypt_and_tag or
4695 * mbedtls_gcm_auth_decrypt will validate the tag length. */
Gilles Peskine8e338702019-07-30 20:06:31 +02004696 if( PSA_BLOCK_CIPHER_BLOCK_SIZE( operation->slot->attr.type ) != 16 )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004697 return( PSA_ERROR_INVALID_ARGUMENT );
4698 mbedtls_gcm_init( &operation->ctx.gcm );
4699 status = mbedtls_to_psa_error(
4700 mbedtls_gcm_setkey( &operation->ctx.gcm, cipher_id,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004701 operation->slot->data.key.data,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004702 (unsigned int) key_bits ) );
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004703 if( status != 0 )
4704 goto cleanup;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004705 break;
4706#endif /* MBEDTLS_GCM_C */
4707
Gilles Peskine26869f22019-05-06 15:25:00 +02004708#if defined(MBEDTLS_CHACHAPOLY_C)
4709 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CHACHA20_POLY1305, 0 ):
4710 operation->core_alg = PSA_ALG_CHACHA20_POLY1305;
4711 operation->full_tag_length = 16;
4712 /* We only support the default tag length. */
4713 if( alg != PSA_ALG_CHACHA20_POLY1305 )
4714 return( PSA_ERROR_NOT_SUPPORTED );
4715 mbedtls_chachapoly_init( &operation->ctx.chachapoly );
4716 status = mbedtls_to_psa_error(
4717 mbedtls_chachapoly_setkey( &operation->ctx.chachapoly,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004718 operation->slot->data.key.data ) );
Gilles Peskine26869f22019-05-06 15:25:00 +02004719 if( status != 0 )
4720 goto cleanup;
4721 break;
4722#endif /* MBEDTLS_CHACHAPOLY_C */
4723
Gilles Peskineedf9a652018-08-17 18:11:56 +02004724 default:
4725 return( PSA_ERROR_NOT_SUPPORTED );
4726 }
4727
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004728 if( PSA_AEAD_TAG_LENGTH( alg ) > operation->full_tag_length )
4729 {
4730 status = PSA_ERROR_INVALID_ARGUMENT;
4731 goto cleanup;
4732 }
4733 operation->tag_length = PSA_AEAD_TAG_LENGTH( alg );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004734
Gilles Peskineedf9a652018-08-17 18:11:56 +02004735 return( PSA_SUCCESS );
4736
4737cleanup:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004738 psa_aead_abort_internal( operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004739 return( status );
4740}
4741
Ronald Croncf56a0a2020-08-04 09:51:30 +02004742psa_status_t psa_aead_encrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03004743 psa_algorithm_t alg,
4744 const uint8_t *nonce,
4745 size_t nonce_length,
4746 const uint8_t *additional_data,
4747 size_t additional_data_length,
4748 const uint8_t *plaintext,
4749 size_t plaintext_length,
4750 uint8_t *ciphertext,
4751 size_t ciphertext_size,
4752 size_t *ciphertext_length )
4753{
mohammad16035955c982018-04-26 00:53:03 +03004754 psa_status_t status;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004755 aead_operation_t operation;
mohammad160315223a82018-06-03 17:19:55 +03004756 uint8_t *tag;
Gilles Peskine2d277862018-06-18 15:41:12 +02004757
mohammad1603f08a5502018-06-03 15:05:47 +03004758 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004759
Ronald Croncf56a0a2020-08-04 09:51:30 +02004760 status = psa_aead_setup( &operation, key, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004761 if( status != PSA_SUCCESS )
4762 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004763
Gilles Peskineedf9a652018-08-17 18:11:56 +02004764 /* For all currently supported modes, the tag is at the end of the
4765 * ciphertext. */
4766 if( ciphertext_size < ( plaintext_length + operation.tag_length ) )
4767 {
4768 status = PSA_ERROR_BUFFER_TOO_SMALL;
4769 goto exit;
4770 }
4771 tag = ciphertext + plaintext_length;
mohammad16035955c982018-04-26 00:53:03 +03004772
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004773#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004774 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03004775 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004776 status = mbedtls_to_psa_error(
4777 mbedtls_gcm_crypt_and_tag( &operation.ctx.gcm,
4778 MBEDTLS_GCM_ENCRYPT,
4779 plaintext_length,
4780 nonce, nonce_length,
4781 additional_data, additional_data_length,
4782 plaintext, ciphertext,
4783 operation.tag_length, tag ) );
mohammad16035955c982018-04-26 00:53:03 +03004784 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004785 else
4786#endif /* MBEDTLS_GCM_C */
4787#if defined(MBEDTLS_CCM_C)
4788 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03004789 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004790 status = mbedtls_to_psa_error(
4791 mbedtls_ccm_encrypt_and_tag( &operation.ctx.ccm,
4792 plaintext_length,
4793 nonce, nonce_length,
4794 additional_data,
4795 additional_data_length,
4796 plaintext, ciphertext,
4797 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03004798 }
mohammad16035c8845f2018-05-09 05:40:09 -07004799 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004800#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004801#if defined(MBEDTLS_CHACHAPOLY_C)
4802 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
4803 {
4804 if( nonce_length != 12 || operation.tag_length != 16 )
4805 {
4806 status = PSA_ERROR_NOT_SUPPORTED;
4807 goto exit;
4808 }
4809 status = mbedtls_to_psa_error(
4810 mbedtls_chachapoly_encrypt_and_tag( &operation.ctx.chachapoly,
4811 plaintext_length,
4812 nonce,
4813 additional_data,
4814 additional_data_length,
4815 plaintext,
4816 ciphertext,
4817 tag ) );
4818 }
4819 else
4820#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad16035c8845f2018-05-09 05:40:09 -07004821 {
mohammad1603554faad2018-06-03 15:07:38 +03004822 return( PSA_ERROR_NOT_SUPPORTED );
mohammad16035c8845f2018-05-09 05:40:09 -07004823 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004824
Gilles Peskineedf9a652018-08-17 18:11:56 +02004825 if( status != PSA_SUCCESS && ciphertext_size != 0 )
4826 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02004827
Gilles Peskineedf9a652018-08-17 18:11:56 +02004828exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004829 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004830 if( status == PSA_SUCCESS )
4831 *ciphertext_length = plaintext_length + operation.tag_length;
4832 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004833}
4834
Gilles Peskineee652a32018-06-01 19:23:52 +02004835/* Locate the tag in a ciphertext buffer containing the encrypted data
4836 * followed by the tag. Return the length of the part preceding the tag in
4837 * *plaintext_length. This is the size of the plaintext in modes where
4838 * the encrypted data has the same size as the plaintext, such as
4839 * CCM and GCM. */
4840static psa_status_t psa_aead_unpadded_locate_tag( size_t tag_length,
4841 const uint8_t *ciphertext,
4842 size_t ciphertext_length,
4843 size_t plaintext_size,
Gilles Peskineee652a32018-06-01 19:23:52 +02004844 const uint8_t **p_tag )
4845{
4846 size_t payload_length;
4847 if( tag_length > ciphertext_length )
4848 return( PSA_ERROR_INVALID_ARGUMENT );
4849 payload_length = ciphertext_length - tag_length;
4850 if( payload_length > plaintext_size )
4851 return( PSA_ERROR_BUFFER_TOO_SMALL );
4852 *p_tag = ciphertext + payload_length;
Gilles Peskineee652a32018-06-01 19:23:52 +02004853 return( PSA_SUCCESS );
4854}
4855
Ronald Croncf56a0a2020-08-04 09:51:30 +02004856psa_status_t psa_aead_decrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03004857 psa_algorithm_t alg,
4858 const uint8_t *nonce,
4859 size_t nonce_length,
4860 const uint8_t *additional_data,
4861 size_t additional_data_length,
4862 const uint8_t *ciphertext,
4863 size_t ciphertext_length,
4864 uint8_t *plaintext,
4865 size_t plaintext_size,
4866 size_t *plaintext_length )
4867{
mohammad16035955c982018-04-26 00:53:03 +03004868 psa_status_t status;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004869 aead_operation_t operation;
4870 const uint8_t *tag = NULL;
Gilles Peskine2d277862018-06-18 15:41:12 +02004871
Gilles Peskineee652a32018-06-01 19:23:52 +02004872 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004873
Ronald Croncf56a0a2020-08-04 09:51:30 +02004874 status = psa_aead_setup( &operation, key, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004875 if( status != PSA_SUCCESS )
4876 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004877
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004878 status = psa_aead_unpadded_locate_tag( operation.tag_length,
4879 ciphertext, ciphertext_length,
4880 plaintext_size, &tag );
4881 if( status != PSA_SUCCESS )
4882 goto exit;
4883
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004884#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004885 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03004886 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004887 status = mbedtls_to_psa_error(
4888 mbedtls_gcm_auth_decrypt( &operation.ctx.gcm,
4889 ciphertext_length - operation.tag_length,
4890 nonce, nonce_length,
4891 additional_data,
4892 additional_data_length,
4893 tag, operation.tag_length,
4894 ciphertext, plaintext ) );
mohammad16035955c982018-04-26 00:53:03 +03004895 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004896 else
4897#endif /* MBEDTLS_GCM_C */
4898#if defined(MBEDTLS_CCM_C)
4899 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03004900 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004901 status = mbedtls_to_psa_error(
4902 mbedtls_ccm_auth_decrypt( &operation.ctx.ccm,
4903 ciphertext_length - operation.tag_length,
4904 nonce, nonce_length,
4905 additional_data,
4906 additional_data_length,
4907 ciphertext, plaintext,
4908 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03004909 }
mohammad160339574652018-06-01 04:39:53 -07004910 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004911#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004912#if defined(MBEDTLS_CHACHAPOLY_C)
4913 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
4914 {
4915 if( nonce_length != 12 || operation.tag_length != 16 )
4916 {
4917 status = PSA_ERROR_NOT_SUPPORTED;
4918 goto exit;
4919 }
4920 status = mbedtls_to_psa_error(
4921 mbedtls_chachapoly_auth_decrypt( &operation.ctx.chachapoly,
4922 ciphertext_length - operation.tag_length,
4923 nonce,
4924 additional_data,
4925 additional_data_length,
4926 tag,
4927 ciphertext,
4928 plaintext ) );
4929 }
4930 else
4931#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad160339574652018-06-01 04:39:53 -07004932 {
mohammad1603554faad2018-06-03 15:07:38 +03004933 return( PSA_ERROR_NOT_SUPPORTED );
mohammad160339574652018-06-01 04:39:53 -07004934 }
Gilles Peskinea40d7742018-06-01 16:28:30 +02004935
Gilles Peskineedf9a652018-08-17 18:11:56 +02004936 if( status != PSA_SUCCESS && plaintext_size != 0 )
4937 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03004938
Gilles Peskineedf9a652018-08-17 18:11:56 +02004939exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004940 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004941 if( status == PSA_SUCCESS )
4942 *plaintext_length = ciphertext_length - operation.tag_length;
4943 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004944}
4945
Gilles Peskinea0655c32018-04-30 17:06:50 +02004946
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004947
Gilles Peskine20035e32018-02-03 22:44:14 +01004948/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02004949/* Generators */
4950/****************************************************************/
4951
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004952#define HKDF_STATE_INIT 0 /* no input yet */
4953#define HKDF_STATE_STARTED 1 /* got salt */
4954#define HKDF_STATE_KEYED 2 /* got key */
4955#define HKDF_STATE_OUTPUT 3 /* output started */
4956
Gilles Peskinecbe66502019-05-16 16:59:18 +02004957static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004958 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004959{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004960 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
4961 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004962 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004963 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004964}
4965
4966
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004967psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004968{
4969 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004970 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004971 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004972 {
4973 /* The object has (apparently) been initialized but it is not
4974 * in use. It's ok to call abort on such an object, and there's
4975 * nothing to do. */
4976 }
4977 else
Gilles Peskinebef7f142018-07-12 17:22:21 +02004978#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004979 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004980 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004981 mbedtls_free( operation->ctx.hkdf.info );
4982 status = psa_hmac_abort_internal( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004983 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01004984 else if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004985 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004986 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004987 {
Janos Follath6a1d2622019-06-11 10:37:28 +01004988 if( operation->ctx.tls12_prf.seed != NULL )
4989 {
4990 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
4991 operation->ctx.tls12_prf.seed_length );
4992 mbedtls_free( operation->ctx.tls12_prf.seed );
4993 }
4994
4995 if( operation->ctx.tls12_prf.label != NULL )
4996 {
4997 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
4998 operation->ctx.tls12_prf.label_length );
4999 mbedtls_free( operation->ctx.tls12_prf.label );
5000 }
5001
5002 status = psa_hmac_abort_internal( &operation->ctx.tls12_prf.hmac );
5003
5004 /* We leave the fields Ai and output_block to be erased safely by the
5005 * mbedtls_platform_zeroize() in the end of this function. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005006 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005007 else
5008#endif /* MBEDTLS_MD_C */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005009 {
5010 status = PSA_ERROR_BAD_STATE;
5011 }
Janos Follath083036a2019-06-11 10:22:26 +01005012 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005013 return( status );
5014}
5015
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005016psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02005017 size_t *capacity)
5018{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005019 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005020 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005021 /* This is a blank key derivation operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02005022 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005023 }
5024
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005025 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005026 return( PSA_SUCCESS );
5027}
5028
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005029psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005030 size_t capacity )
5031{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005032 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005033 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005034 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005035 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005036 operation->capacity = capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005037 return( PSA_SUCCESS );
5038}
5039
Gilles Peskinebef7f142018-07-12 17:22:21 +02005040#if defined(MBEDTLS_MD_C)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005041/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02005042 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02005043static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskinebef7f142018-07-12 17:22:21 +02005044 psa_algorithm_t hash_alg,
5045 uint8_t *output,
5046 size_t output_length )
5047{
5048 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
5049 psa_status_t status;
5050
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005051 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
5052 return( PSA_ERROR_BAD_STATE );
5053 hkdf->state = HKDF_STATE_OUTPUT;
5054
Gilles Peskinebef7f142018-07-12 17:22:21 +02005055 while( output_length != 0 )
5056 {
5057 /* Copy what remains of the current block */
5058 uint8_t n = hash_length - hkdf->offset_in_block;
5059 if( n > output_length )
5060 n = (uint8_t) output_length;
5061 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
5062 output += n;
5063 output_length -= n;
5064 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02005065 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02005066 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02005067 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005068 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005069 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02005070 * object was corrupted or if this function is called directly
5071 * inside the library. */
5072 if( hkdf->block_number == 0xff )
5073 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02005074
5075 /* We need a new block */
5076 ++hkdf->block_number;
5077 hkdf->offset_in_block = 0;
5078 status = psa_hmac_setup_internal( &hkdf->hmac,
5079 hkdf->prk, hash_length,
5080 hash_alg );
5081 if( status != PSA_SUCCESS )
5082 return( status );
5083 if( hkdf->block_number != 1 )
5084 {
5085 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5086 hkdf->output_block,
5087 hash_length );
5088 if( status != PSA_SUCCESS )
5089 return( status );
5090 }
5091 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5092 hkdf->info,
5093 hkdf->info_length );
5094 if( status != PSA_SUCCESS )
5095 return( status );
5096 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5097 &hkdf->block_number, 1 );
5098 if( status != PSA_SUCCESS )
5099 return( status );
5100 status = psa_hmac_finish_internal( &hkdf->hmac,
5101 hkdf->output_block,
5102 sizeof( hkdf->output_block ) );
5103 if( status != PSA_SUCCESS )
5104 return( status );
5105 }
5106
5107 return( PSA_SUCCESS );
5108}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005109
Janos Follath7742fee2019-06-17 12:58:10 +01005110static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
5111 psa_tls12_prf_key_derivation_t *tls12_prf,
5112 psa_algorithm_t alg )
5113{
5114 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
5115 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
Janos Follathea29bfb2019-06-19 12:21:20 +01005116 psa_hash_operation_t backup = PSA_HASH_OPERATION_INIT;
5117 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005118
Janos Follath7742fee2019-06-17 12:58:10 +01005119 /* We can't be wanting more output after block 0xff, otherwise
5120 * the capacity check in psa_key_derivation_output_bytes() would have
5121 * prevented this call. It could happen only if the operation
5122 * object was corrupted or if this function is called directly
5123 * inside the library. */
5124 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01005125 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01005126
5127 /* We need a new block */
5128 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01005129 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01005130
5131 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
5132 *
5133 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
5134 *
5135 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
5136 * HMAC_hash(secret, A(2) + seed) +
5137 * HMAC_hash(secret, A(3) + seed) + ...
5138 *
5139 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01005140 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01005141 *
Janos Follathea29bfb2019-06-19 12:21:20 +01005142 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01005143 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01005144 * is currently extracted as `output_block` and where i is
5145 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01005146 */
5147
Janos Follathea29bfb2019-06-19 12:21:20 +01005148 /* Save the hash context before using it, to preserve the hash state with
5149 * only the inner padding in it. We need this, because inner padding depends
5150 * on the key (secret in the RFC's terminology). */
5151 status = psa_hash_clone( &tls12_prf->hmac.hash_ctx, &backup );
5152 if( status != PSA_SUCCESS )
5153 goto cleanup;
5154
5155 /* Calculate A(i) where i = tls12_prf->block_number. */
5156 if( tls12_prf->block_number == 1 )
5157 {
5158 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
5159 * the variable seed and in this instance means it in the context of the
5160 * P_hash function, where seed = label + seed.) */
5161 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5162 tls12_prf->label, tls12_prf->label_length );
5163 if( status != PSA_SUCCESS )
5164 goto cleanup;
5165 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5166 tls12_prf->seed, tls12_prf->seed_length );
5167 if( status != PSA_SUCCESS )
5168 goto cleanup;
5169 }
5170 else
5171 {
5172 /* A(i) = HMAC_hash(secret, A(i-1)) */
5173 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5174 tls12_prf->Ai, hash_length );
5175 if( status != PSA_SUCCESS )
5176 goto cleanup;
5177 }
5178
5179 status = psa_hmac_finish_internal( &tls12_prf->hmac,
5180 tls12_prf->Ai, hash_length );
5181 if( status != PSA_SUCCESS )
5182 goto cleanup;
5183 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
5184 if( status != PSA_SUCCESS )
5185 goto cleanup;
5186
5187 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
5188 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5189 tls12_prf->Ai, hash_length );
5190 if( status != PSA_SUCCESS )
5191 goto cleanup;
5192 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5193 tls12_prf->label, tls12_prf->label_length );
5194 if( status != PSA_SUCCESS )
5195 goto cleanup;
5196 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5197 tls12_prf->seed, tls12_prf->seed_length );
5198 if( status != PSA_SUCCESS )
5199 goto cleanup;
5200 status = psa_hmac_finish_internal( &tls12_prf->hmac,
5201 tls12_prf->output_block, hash_length );
5202 if( status != PSA_SUCCESS )
5203 goto cleanup;
5204 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
5205 if( status != PSA_SUCCESS )
5206 goto cleanup;
5207
Janos Follath7742fee2019-06-17 12:58:10 +01005208
5209cleanup:
5210
Janos Follathea29bfb2019-06-19 12:21:20 +01005211 cleanup_status = psa_hash_abort( &backup );
5212 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
5213 status = cleanup_status;
5214
5215 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01005216}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005217
Janos Follath844eb0e2019-06-19 12:10:49 +01005218static psa_status_t psa_key_derivation_tls12_prf_read(
5219 psa_tls12_prf_key_derivation_t *tls12_prf,
5220 psa_algorithm_t alg,
5221 uint8_t *output,
5222 size_t output_length )
5223{
5224 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
5225 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
5226 psa_status_t status;
5227 uint8_t offset, length;
5228
5229 while( output_length != 0 )
5230 {
5231 /* Check if we have fully processed the current block. */
5232 if( tls12_prf->left_in_block == 0 )
5233 {
5234 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
5235 alg );
5236 if( status != PSA_SUCCESS )
5237 return( status );
5238
5239 continue;
5240 }
5241
5242 if( tls12_prf->left_in_block > output_length )
5243 length = (uint8_t) output_length;
5244 else
5245 length = tls12_prf->left_in_block;
5246
5247 offset = hash_length - tls12_prf->left_in_block;
5248 memcpy( output, tls12_prf->output_block + offset, length );
5249 output += length;
5250 output_length -= length;
5251 tls12_prf->left_in_block -= length;
5252 }
5253
5254 return( PSA_SUCCESS );
5255}
Gilles Peskinebef7f142018-07-12 17:22:21 +02005256#endif /* MBEDTLS_MD_C */
5257
Janos Follath6c6c8fc2019-06-17 12:38:20 +01005258psa_status_t psa_key_derivation_output_bytes(
5259 psa_key_derivation_operation_t *operation,
5260 uint8_t *output,
5261 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005262{
5263 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005264 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005265
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005266 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005267 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005268 /* This is a blank operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02005269 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005270 }
5271
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005272 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005273 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005274 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005275 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005276 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02005277 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005278 goto exit;
5279 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005280 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005281 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005282 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005283 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02005284 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
5285 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005286 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02005287 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02005288 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005289 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005290 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005291
Gilles Peskinebef7f142018-07-12 17:22:21 +02005292#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005293 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02005294 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01005295 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005296 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02005297 output, output_length );
5298 }
Janos Follathadbec812019-06-14 11:05:39 +01005299 else
Janos Follathadbec812019-06-14 11:05:39 +01005300 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine969c5d62019-01-16 15:53:06 +01005301 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005302 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005303 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005304 kdf_alg, output,
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005305 output_length );
5306 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005307 else
5308#endif /* MBEDTLS_MD_C */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005309 {
5310 return( PSA_ERROR_BAD_STATE );
5311 }
5312
5313exit:
5314 if( status != PSA_SUCCESS )
5315 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005316 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005317 * This allows us to differentiate between exhausted operations and
5318 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
5319 * operations. */
5320 psa_algorithm_t alg = operation->alg;
5321 psa_key_derivation_abort( operation );
5322 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005323 memset( output, '!', output_length );
5324 }
5325 return( status );
5326}
5327
Gilles Peskine08542d82018-07-19 17:05:42 +02005328#if defined(MBEDTLS_DES_C)
5329static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
5330{
5331 if( data_size >= 8 )
5332 mbedtls_des_key_set_parity( data );
5333 if( data_size >= 16 )
5334 mbedtls_des_key_set_parity( data + 8 );
5335 if( data_size >= 24 )
5336 mbedtls_des_key_set_parity( data + 16 );
5337}
5338#endif /* MBEDTLS_DES_C */
5339
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005340static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005341 psa_key_slot_t *slot,
5342 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005343 psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005344{
5345 uint8_t *data = NULL;
5346 size_t bytes = PSA_BITS_TO_BYTES( bits );
5347 psa_status_t status;
5348
Gilles Peskine8e338702019-07-30 20:06:31 +02005349 if( ! key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005350 return( PSA_ERROR_INVALID_ARGUMENT );
5351 if( bits % 8 != 0 )
5352 return( PSA_ERROR_INVALID_ARGUMENT );
5353 data = mbedtls_calloc( 1, bytes );
5354 if( data == NULL )
5355 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5356
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005357 status = psa_key_derivation_output_bytes( operation, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005358 if( status != PSA_SUCCESS )
5359 goto exit;
Gilles Peskine08542d82018-07-19 17:05:42 +02005360#if defined(MBEDTLS_DES_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02005361 if( slot->attr.type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02005362 psa_des_set_key_parity( data, bytes );
5363#endif /* MBEDTLS_DES_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005364 status = psa_import_key_into_slot( slot, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005365
5366exit:
5367 mbedtls_free( data );
5368 return( status );
5369}
5370
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005371psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005372 psa_key_derivation_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005373 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005374{
5375 psa_status_t status;
5376 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005377 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02005378
5379 /* Reject any attempt to create a zero-length key so that we don't
5380 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
5381 if( psa_get_key_bits( attributes ) == 0 )
5382 return( PSA_ERROR_INVALID_ARGUMENT );
5383
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005384 if( ! operation->can_output_key )
5385 return( PSA_ERROR_NOT_PERMITTED );
5386
Gilles Peskinedf179142019-07-15 22:02:14 +02005387 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005388 attributes, key, &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02005389#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
5390 if( driver != NULL )
5391 {
5392 /* Deriving a key in a secure element is not implemented yet. */
5393 status = PSA_ERROR_NOT_SUPPORTED;
5394 }
5395#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005396 if( status == PSA_SUCCESS )
5397 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005398 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02005399 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005400 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005401 }
5402 if( status == PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02005403 status = psa_finish_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005404 if( status != PSA_SUCCESS )
5405 {
Gilles Peskine011e4282019-06-26 18:34:38 +02005406 psa_fail_key_creation( slot, driver );
Ronald Croncf56a0a2020-08-04 09:51:30 +02005407 *key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005408 }
5409 return( status );
5410}
5411
Gilles Peskineeab56e42018-07-12 17:12:33 +02005412
5413
5414/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02005415/* Key derivation */
5416/****************************************************************/
5417
Gilles Peskine969c5d62019-01-16 15:53:06 +01005418static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005419 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005420 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005421{
Janos Follath5fe19732019-06-20 15:09:30 +01005422 /* Make sure that operation->ctx is properly zero-initialised. (Macro
5423 * initialisers for this union leave some bytes unspecified.) */
5424 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
5425
Gilles Peskine969c5d62019-01-16 15:53:06 +01005426 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005427#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005428 if( PSA_ALG_IS_HKDF( kdf_alg ) ||
5429 PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
5430 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005431 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01005432 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005433 size_t hash_size = PSA_HASH_SIZE( hash_alg );
5434 if( hash_size == 0 )
5435 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005436 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
5437 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02005438 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005439 {
5440 return( PSA_ERROR_NOT_SUPPORTED );
5441 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005442 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01005443 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005444 }
5445#endif /* MBEDTLS_MD_C */
Gilles Peskine969c5d62019-01-16 15:53:06 +01005446 else
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005447 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005448}
5449
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005450psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005451 psa_algorithm_t alg )
5452{
5453 psa_status_t status;
5454
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005455 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005456 return( PSA_ERROR_BAD_STATE );
5457
Gilles Peskine6843c292019-01-18 16:44:49 +01005458 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
5459 return( PSA_ERROR_INVALID_ARGUMENT );
5460 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005461 {
5462 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005463 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005464 }
5465 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
5466 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005467 status = psa_key_derivation_setup_kdf( operation, alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005468 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005469 else
5470 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005471
5472 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005473 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01005474 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005475}
5476
5477#if defined(MBEDTLS_MD_C)
Gilles Peskinecbe66502019-05-16 16:59:18 +02005478static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005479 psa_algorithm_t hash_alg,
5480 psa_key_derivation_step_t step,
5481 const uint8_t *data,
5482 size_t data_length )
5483{
5484 psa_status_t status;
5485 switch( step )
5486 {
Gilles Peskine03410b52019-05-16 16:05:19 +02005487 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02005488 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005489 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005490 status = psa_hmac_setup_internal( &hkdf->hmac,
5491 data, data_length,
5492 hash_alg );
5493 if( status != PSA_SUCCESS )
5494 return( status );
5495 hkdf->state = HKDF_STATE_STARTED;
5496 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02005497 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005498 /* If no salt was provided, use an empty salt. */
5499 if( hkdf->state == HKDF_STATE_INIT )
5500 {
5501 status = psa_hmac_setup_internal( &hkdf->hmac,
5502 NULL, 0,
Gilles Peskinef9ee6332019-04-11 21:22:52 +02005503 hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005504 if( status != PSA_SUCCESS )
5505 return( status );
5506 hkdf->state = HKDF_STATE_STARTED;
5507 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02005508 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005509 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005510 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5511 data, data_length );
5512 if( status != PSA_SUCCESS )
5513 return( status );
5514 status = psa_hmac_finish_internal( &hkdf->hmac,
5515 hkdf->prk,
5516 sizeof( hkdf->prk ) );
5517 if( status != PSA_SUCCESS )
5518 return( status );
5519 hkdf->offset_in_block = PSA_HASH_SIZE( hash_alg );
5520 hkdf->block_number = 0;
5521 hkdf->state = HKDF_STATE_KEYED;
5522 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02005523 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005524 if( hkdf->state == HKDF_STATE_OUTPUT )
5525 return( PSA_ERROR_BAD_STATE );
5526 if( hkdf->info_set )
5527 return( PSA_ERROR_BAD_STATE );
5528 hkdf->info_length = data_length;
5529 if( data_length != 0 )
5530 {
5531 hkdf->info = mbedtls_calloc( 1, data_length );
5532 if( hkdf->info == NULL )
5533 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5534 memcpy( hkdf->info, data, data_length );
5535 }
5536 hkdf->info_set = 1;
5537 return( PSA_SUCCESS );
5538 default:
5539 return( PSA_ERROR_INVALID_ARGUMENT );
5540 }
5541}
Janos Follathb03233e2019-06-11 15:30:30 +01005542
Janos Follathf08e2652019-06-13 09:05:41 +01005543static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
5544 const uint8_t *data,
5545 size_t data_length )
5546{
5547 if( prf->state != TLS12_PRF_STATE_INIT )
5548 return( PSA_ERROR_BAD_STATE );
5549
Janos Follathd6dce9f2019-07-04 09:11:38 +01005550 if( data_length != 0 )
5551 {
5552 prf->seed = mbedtls_calloc( 1, data_length );
5553 if( prf->seed == NULL )
5554 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01005555
Janos Follathd6dce9f2019-07-04 09:11:38 +01005556 memcpy( prf->seed, data, data_length );
5557 prf->seed_length = data_length;
5558 }
Janos Follathf08e2652019-06-13 09:05:41 +01005559
5560 prf->state = TLS12_PRF_STATE_SEED_SET;
5561
5562 return( PSA_SUCCESS );
5563}
5564
Janos Follath81550542019-06-13 14:26:34 +01005565static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
5566 psa_algorithm_t hash_alg,
5567 const uint8_t *data,
5568 size_t data_length )
5569{
5570 psa_status_t status;
5571 if( prf->state != TLS12_PRF_STATE_SEED_SET )
5572 return( PSA_ERROR_BAD_STATE );
5573
5574 status = psa_hmac_setup_internal( &prf->hmac, data, data_length, hash_alg );
5575 if( status != PSA_SUCCESS )
5576 return( status );
5577
5578 prf->state = TLS12_PRF_STATE_KEY_SET;
5579
5580 return( PSA_SUCCESS );
5581}
5582
Janos Follath6660f0e2019-06-17 08:44:03 +01005583static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
5584 psa_tls12_prf_key_derivation_t *prf,
5585 psa_algorithm_t hash_alg,
5586 const uint8_t *data,
5587 size_t data_length )
5588{
5589 psa_status_t status;
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02005590 uint8_t pms[ 4 + 2 * PSA_ALG_TLS12_PSK_TO_MS_MAX_PSK_LEN ];
5591 uint8_t *cur = pms;
Janos Follath6660f0e2019-06-17 08:44:03 +01005592
5593 if( data_length > PSA_ALG_TLS12_PSK_TO_MS_MAX_PSK_LEN )
5594 return( PSA_ERROR_INVALID_ARGUMENT );
5595
5596 /* Quoting RFC 4279, Section 2:
5597 *
5598 * The premaster secret is formed as follows: if the PSK is N octets
5599 * long, concatenate a uint16 with the value N, N zero octets, a second
5600 * uint16 with the value N, and the PSK itself.
5601 */
5602
Janos Follath40e13932019-06-26 13:22:29 +01005603 *cur++ = ( data_length >> 8 ) & 0xff;
5604 *cur++ = ( data_length >> 0 ) & 0xff;
5605 memset( cur, 0, data_length );
5606 cur += data_length;
5607 *cur++ = pms[0];
5608 *cur++ = pms[1];
5609 memcpy( cur, data, data_length );
5610 cur += data_length;
Janos Follath6660f0e2019-06-17 08:44:03 +01005611
Janos Follath40e13932019-06-26 13:22:29 +01005612 status = psa_tls12_prf_set_key( prf, hash_alg, pms, cur - pms );
Janos Follath6660f0e2019-06-17 08:44:03 +01005613
5614 mbedtls_platform_zeroize( pms, sizeof( pms ) );
5615 return( status );
5616}
5617
Janos Follath63028dd2019-06-13 09:15:47 +01005618static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
5619 const uint8_t *data,
5620 size_t data_length )
5621{
5622 if( prf->state != TLS12_PRF_STATE_KEY_SET )
5623 return( PSA_ERROR_BAD_STATE );
5624
Janos Follathd6dce9f2019-07-04 09:11:38 +01005625 if( data_length != 0 )
5626 {
5627 prf->label = mbedtls_calloc( 1, data_length );
5628 if( prf->label == NULL )
5629 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01005630
Janos Follathd6dce9f2019-07-04 09:11:38 +01005631 memcpy( prf->label, data, data_length );
5632 prf->label_length = data_length;
5633 }
Janos Follath63028dd2019-06-13 09:15:47 +01005634
5635 prf->state = TLS12_PRF_STATE_LABEL_SET;
5636
5637 return( PSA_SUCCESS );
5638}
5639
Janos Follathb03233e2019-06-11 15:30:30 +01005640static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
5641 psa_algorithm_t hash_alg,
5642 psa_key_derivation_step_t step,
5643 const uint8_t *data,
5644 size_t data_length )
5645{
Janos Follathb03233e2019-06-11 15:30:30 +01005646 switch( step )
5647 {
Janos Follathf08e2652019-06-13 09:05:41 +01005648 case PSA_KEY_DERIVATION_INPUT_SEED:
5649 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01005650 case PSA_KEY_DERIVATION_INPUT_SECRET:
5651 return( psa_tls12_prf_set_key( prf, hash_alg, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01005652 case PSA_KEY_DERIVATION_INPUT_LABEL:
5653 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01005654 default:
5655 return( PSA_ERROR_INVALID_ARGUMENT );
5656 }
5657}
Janos Follath6660f0e2019-06-17 08:44:03 +01005658
5659static psa_status_t psa_tls12_prf_psk_to_ms_input(
5660 psa_tls12_prf_key_derivation_t *prf,
5661 psa_algorithm_t hash_alg,
5662 psa_key_derivation_step_t step,
5663 const uint8_t *data,
5664 size_t data_length )
5665{
5666 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01005667 {
Janos Follath6660f0e2019-06-17 08:44:03 +01005668 return( psa_tls12_prf_psk_to_ms_set_key( prf, hash_alg,
5669 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01005670 }
Janos Follath6660f0e2019-06-17 08:44:03 +01005671
5672 return( psa_tls12_prf_input( prf, hash_alg, step, data, data_length ) );
5673}
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005674#endif /* MBEDTLS_MD_C */
5675
Gilles Peskineb8965192019-09-24 16:21:10 +02005676/** Check whether the given key type is acceptable for the given
5677 * input step of a key derivation.
5678 *
5679 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
5680 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
5681 * Both secret and non-secret inputs can alternatively have the type
5682 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
5683 * that the input was passed as a buffer rather than via a key object.
5684 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02005685static int psa_key_derivation_check_input_type(
5686 psa_key_derivation_step_t step,
5687 psa_key_type_t key_type )
5688{
5689 switch( step )
5690 {
5691 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb8965192019-09-24 16:21:10 +02005692 if( key_type == PSA_KEY_TYPE_DERIVE )
5693 return( PSA_SUCCESS );
5694 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005695 return( PSA_SUCCESS );
5696 break;
5697 case PSA_KEY_DERIVATION_INPUT_LABEL:
5698 case PSA_KEY_DERIVATION_INPUT_SALT:
5699 case PSA_KEY_DERIVATION_INPUT_INFO:
5700 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskineb8965192019-09-24 16:21:10 +02005701 if( key_type == PSA_KEY_TYPE_RAW_DATA )
5702 return( PSA_SUCCESS );
5703 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005704 return( PSA_SUCCESS );
5705 break;
5706 }
5707 return( PSA_ERROR_INVALID_ARGUMENT );
5708}
5709
Janos Follathb80a94e2019-06-12 15:54:46 +01005710static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005711 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005712 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005713 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005714 const uint8_t *data,
5715 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005716{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02005717 psa_status_t status;
5718 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
5719
5720 status = psa_key_derivation_check_input_type( step, key_type );
Gilles Peskine224b0d62019-09-23 18:13:17 +02005721 if( status != PSA_SUCCESS )
5722 goto exit;
5723
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005724#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005725 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005726 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005727 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005728 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005729 step, data, data_length );
5730 }
k-stachowiak012dcc42019-08-13 14:55:03 +02005731 else if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005732 {
Janos Follathb03233e2019-06-11 15:30:30 +01005733 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
5734 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5735 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01005736 }
5737 else if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
5738 {
5739 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
5740 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5741 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005742 }
5743 else
5744#endif /* MBEDTLS_MD_C */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005745 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005746 /* This can't happen unless the operation object was not initialized */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005747 return( PSA_ERROR_BAD_STATE );
5748 }
5749
Gilles Peskine224b0d62019-09-23 18:13:17 +02005750exit:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005751 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005752 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005753 return( status );
5754}
5755
Janos Follath51f4a0f2019-06-14 11:35:55 +01005756psa_status_t psa_key_derivation_input_bytes(
5757 psa_key_derivation_operation_t *operation,
5758 psa_key_derivation_step_t step,
5759 const uint8_t *data,
5760 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005761{
Gilles Peskineb8965192019-09-24 16:21:10 +02005762 return( psa_key_derivation_input_internal( operation, step,
5763 PSA_KEY_TYPE_NONE,
Janos Follathc5621512019-06-14 11:27:57 +01005764 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005765}
5766
Janos Follath51f4a0f2019-06-14 11:35:55 +01005767psa_status_t psa_key_derivation_input_key(
5768 psa_key_derivation_operation_t *operation,
5769 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005770 mbedtls_svc_key_id_t key )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005771{
5772 psa_key_slot_t *slot;
5773 psa_status_t status;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005774
Ronald Croncf56a0a2020-08-04 09:51:30 +02005775 status = psa_get_transparent_key( key, &slot,
5776 PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005777 if( status != PSA_SUCCESS )
Gilles Peskine593773d2019-09-23 18:17:40 +02005778 {
5779 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005780 return( status );
Gilles Peskine593773d2019-09-23 18:17:40 +02005781 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005782
5783 /* Passing a key object as a SECRET input unlocks the permission
5784 * to output to a key object. */
5785 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5786 operation->can_output_key = 1;
5787
Janos Follathb80a94e2019-06-12 15:54:46 +01005788 return( psa_key_derivation_input_internal( operation,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005789 step, slot->attr.type,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02005790 slot->data.key.data,
5791 slot->data.key.bytes ) );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005792}
Gilles Peskineea0fb492018-07-12 17:17:20 +02005793
5794
5795
5796/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02005797/* Key agreement */
5798/****************************************************************/
5799
Gilles Peskinea05219c2018-11-16 16:02:56 +01005800#if defined(MBEDTLS_ECDH_C)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005801static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
5802 size_t peer_key_length,
5803 const mbedtls_ecp_keypair *our_key,
5804 uint8_t *shared_secret,
5805 size_t shared_secret_size,
5806 size_t *shared_secret_length )
5807{
Steven Cooremand4867872020-08-05 16:31:39 +02005808 mbedtls_ecp_keypair *their_key = NULL;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005809 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00005810 psa_status_t status;
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005811 size_t bits = 0;
Paul Elliott8ff510a2020-06-02 17:19:28 +01005812 psa_ecc_family_t curve = mbedtls_ecc_group_to_psa( our_key->grp.id, &bits );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005813 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005814
Steven Cooreman4fed4552020-08-03 14:46:03 +02005815 status = psa_load_ecp_representation( PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve),
5816 peer_key,
Steven Cooreman7f391872020-07-30 14:57:44 +02005817 peer_key_length,
Steven Cooreman7f391872020-07-30 14:57:44 +02005818 &their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00005819 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005820 goto exit;
5821
Jaeden Amero97271b32019-01-10 19:38:51 +00005822 status = mbedtls_to_psa_error(
Steven Cooremana2371e52020-07-28 14:30:39 +02005823 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
Jaeden Amero97271b32019-01-10 19:38:51 +00005824 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005825 goto exit;
Jaeden Amero97271b32019-01-10 19:38:51 +00005826 status = mbedtls_to_psa_error(
5827 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
5828 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005829 goto exit;
5830
Jaeden Amero97271b32019-01-10 19:38:51 +00005831 status = mbedtls_to_psa_error(
5832 mbedtls_ecdh_calc_secret( &ecdh,
5833 shared_secret_length,
5834 shared_secret, shared_secret_size,
5835 mbedtls_ctr_drbg_random,
5836 &global_data.ctr_drbg ) );
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005837 if( status != PSA_SUCCESS )
5838 goto exit;
5839 if( PSA_BITS_TO_BYTES( bits ) != *shared_secret_length )
5840 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005841
5842exit:
Gilles Peskine3e819b72019-12-20 14:09:55 +01005843 if( status != PSA_SUCCESS )
5844 mbedtls_platform_zeroize( shared_secret, shared_secret_size );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005845 mbedtls_ecdh_free( &ecdh );
Steven Cooremana2371e52020-07-28 14:30:39 +02005846 mbedtls_ecp_keypair_free( their_key );
Steven Cooreman6d839f02020-07-30 11:36:45 +02005847 mbedtls_free( their_key );
Steven Cooremana2371e52020-07-28 14:30:39 +02005848
Jaeden Amero97271b32019-01-10 19:38:51 +00005849 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005850}
Gilles Peskinea05219c2018-11-16 16:02:56 +01005851#endif /* MBEDTLS_ECDH_C */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005852
Gilles Peskine01d718c2018-09-18 12:01:02 +02005853#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
5854
Gilles Peskine0216fe12019-04-11 21:23:21 +02005855static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
5856 psa_key_slot_t *private_key,
5857 const uint8_t *peer_key,
5858 size_t peer_key_length,
5859 uint8_t *shared_secret,
5860 size_t shared_secret_size,
5861 size_t *shared_secret_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005862{
Gilles Peskine0216fe12019-04-11 21:23:21 +02005863 switch( alg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005864 {
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005865#if defined(MBEDTLS_ECDH_C)
Gilles Peskine0216fe12019-04-11 21:23:21 +02005866 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02005867 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005868 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremana2371e52020-07-28 14:30:39 +02005869 mbedtls_ecp_keypair *ecp = NULL;
Steven Cooreman7f391872020-07-30 14:57:44 +02005870 psa_status_t status = psa_load_ecp_representation(
Steven Cooreman4fed4552020-08-03 14:46:03 +02005871 private_key->attr.type,
Steven Cooreman7f391872020-07-30 14:57:44 +02005872 private_key->data.key.data,
5873 private_key->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02005874 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02005875 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02005876 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02005877 status = psa_key_agreement_ecdh( peer_key, peer_key_length,
Steven Cooremana2371e52020-07-28 14:30:39 +02005878 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02005879 shared_secret, shared_secret_size,
5880 shared_secret_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02005881 mbedtls_ecp_keypair_free( ecp );
5882 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02005883 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005884#endif /* MBEDTLS_ECDH_C */
Gilles Peskine01d718c2018-09-18 12:01:02 +02005885 default:
Gilles Peskine93f85002018-11-16 16:43:31 +01005886 (void) private_key;
5887 (void) peer_key;
5888 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02005889 (void) shared_secret;
5890 (void) shared_secret_size;
5891 (void) shared_secret_length;
Gilles Peskine01d718c2018-09-18 12:01:02 +02005892 return( PSA_ERROR_NOT_SUPPORTED );
5893 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02005894}
5895
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005896/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02005897 * to potentially free embedded data structures and wipe confidential data.
5898 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005899static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005900 psa_key_derivation_step_t step,
Gilles Peskine01d718c2018-09-18 12:01:02 +02005901 psa_key_slot_t *private_key,
5902 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005903 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005904{
5905 psa_status_t status;
5906 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
5907 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005908 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005909
5910 /* Step 1: run the secret agreement algorithm to generate the shared
5911 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02005912 status = psa_key_agreement_raw_internal( ka_alg,
5913 private_key,
5914 peer_key, peer_key_length,
itayzafrir0adf0fc2018-09-06 16:24:41 +03005915 shared_secret,
5916 sizeof( shared_secret ),
Gilles Peskine05d69892018-06-19 22:00:52 +02005917 &shared_secret_length );
Gilles Peskine53d991e2018-07-12 01:14:59 +02005918 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005919 goto exit;
5920
Gilles Peskineb0b255c2018-07-06 17:01:38 +02005921 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02005922 * the shared secret. A shared secret is permitted wherever a key
5923 * of type DERIVE is permitted. */
Janos Follathb80a94e2019-06-12 15:54:46 +01005924 status = psa_key_derivation_input_internal( operation, step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005925 PSA_KEY_TYPE_DERIVE,
Janos Follathb80a94e2019-06-12 15:54:46 +01005926 shared_secret,
5927 shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005928exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01005929 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005930 return( status );
5931}
5932
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005933psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005934 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005935 mbedtls_svc_key_id_t private_key,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005936 const uint8_t *peer_key,
5937 size_t peer_key_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005938{
Gilles Peskine2f060a82018-12-04 17:12:32 +01005939 psa_key_slot_t *slot;
Gilles Peskine08542d82018-07-19 17:05:42 +02005940 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005941 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005942 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine28f8f302019-07-24 13:30:31 +02005943 status = psa_get_transparent_key( private_key, &slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02005944 PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005945 if( status != PSA_SUCCESS )
5946 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005947 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01005948 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005949 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01005950 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005951 psa_key_derivation_abort( operation );
Steven Cooremanfa5e6312020-10-15 17:07:12 +02005952 else
5953 {
5954 /* If a private key has been added as SECRET, we allow the derived
5955 * key material to be used as a key in PSA Crypto. */
5956 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5957 operation->can_output_key = 1;
5958 }
Gilles Peskine346797d2018-11-16 16:05:06 +01005959 return( status );
Gilles Peskineaf3baab2018-06-27 22:55:52 +02005960}
5961
Gilles Peskinebe697d82019-05-16 18:00:41 +02005962psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005963 mbedtls_svc_key_id_t private_key,
Gilles Peskinebe697d82019-05-16 18:00:41 +02005964 const uint8_t *peer_key,
5965 size_t peer_key_length,
5966 uint8_t *output,
5967 size_t output_size,
5968 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02005969{
5970 psa_key_slot_t *slot;
5971 psa_status_t status;
5972
5973 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
5974 {
5975 status = PSA_ERROR_INVALID_ARGUMENT;
5976 goto exit;
5977 }
Gilles Peskine28f8f302019-07-24 13:30:31 +02005978 status = psa_get_transparent_key( private_key, &slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02005979 PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02005980 if( status != PSA_SUCCESS )
5981 goto exit;
5982
5983 status = psa_key_agreement_raw_internal( alg, slot,
5984 peer_key, peer_key_length,
5985 output, output_size,
5986 output_length );
5987
5988exit:
5989 if( status != PSA_SUCCESS )
5990 {
5991 /* If an error happens and is not handled properly, the output
5992 * may be used as a key to protect sensitive data. Arrange for such
5993 * a key to be random, which is likely to result in decryption or
5994 * verification errors. This is better than filling the buffer with
5995 * some constant data such as zeros, which would result in the data
5996 * being protected with a reproducible, easily knowable key.
5997 */
5998 psa_generate_random( output, output_size );
5999 *output_length = output_size;
6000 }
6001 return( status );
6002}
Gilles Peskine86a440b2018-11-12 18:39:40 +01006003
6004
6005/****************************************************************/
6006/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02006007/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02006008
Gilles Peskine4c317f42018-07-12 01:24:09 +02006009psa_status_t psa_generate_random( uint8_t *output,
Gilles Peskine53d991e2018-07-12 01:14:59 +02006010 size_t output_size )
Gilles Peskine12313cd2018-06-20 00:20:32 +02006011{
Janos Follath24eed8d2019-11-22 13:21:35 +00006012 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006013 GUARD_MODULE_INITIALIZED;
6014
Gilles Peskinef181eca2019-08-07 13:49:00 +02006015 while( output_size > MBEDTLS_CTR_DRBG_MAX_REQUEST )
6016 {
6017 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg,
6018 output,
6019 MBEDTLS_CTR_DRBG_MAX_REQUEST );
6020 if( ret != 0 )
6021 return( mbedtls_to_psa_error( ret ) );
6022 output += MBEDTLS_CTR_DRBG_MAX_REQUEST;
6023 output_size -= MBEDTLS_CTR_DRBG_MAX_REQUEST;
6024 }
6025
Gilles Peskinee59236f2018-01-27 23:32:46 +01006026 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg, output, output_size );
6027 return( mbedtls_to_psa_error( ret ) );
6028}
6029
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01006030#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
6031#include "mbedtls/entropy_poll.h"
6032
Gilles Peskine7228da22019-07-15 11:06:15 +02006033psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006034 size_t seed_size )
6035{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006036 if( global_data.initialized )
6037 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02006038
6039 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
6040 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
6041 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
6042 return( PSA_ERROR_INVALID_ARGUMENT );
6043
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01006044 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006045}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01006046#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006047
Gilles Peskinee56e8782019-04-26 17:34:02 +02006048#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_GENPRIME)
6049static psa_status_t psa_read_rsa_exponent( const uint8_t *domain_parameters,
6050 size_t domain_parameters_size,
6051 int *exponent )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006052{
Gilles Peskinee56e8782019-04-26 17:34:02 +02006053 size_t i;
6054 uint32_t acc = 0;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006055
Gilles Peskinee56e8782019-04-26 17:34:02 +02006056 if( domain_parameters_size == 0 )
6057 {
6058 *exponent = 65537;
6059 return( PSA_SUCCESS );
6060 }
6061
6062 /* Mbed TLS encodes the public exponent as an int. For simplicity, only
6063 * support values that fit in a 32-bit integer, which is larger than
6064 * int on just about every platform anyway. */
6065 if( domain_parameters_size > sizeof( acc ) )
6066 return( PSA_ERROR_NOT_SUPPORTED );
6067 for( i = 0; i < domain_parameters_size; i++ )
6068 acc = ( acc << 8 ) | domain_parameters[i];
6069 if( acc > INT_MAX )
6070 return( PSA_ERROR_NOT_SUPPORTED );
6071 *exponent = acc;
6072 return( PSA_SUCCESS );
6073}
6074#endif /* MBEDTLS_RSA_C && MBEDTLS_GENPRIME */
6075
Gilles Peskine35ef36b2019-05-16 19:42:05 +02006076static psa_status_t psa_generate_key_internal(
Gilles Peskinee56e8782019-04-26 17:34:02 +02006077 psa_key_slot_t *slot, size_t bits,
6078 const uint8_t *domain_parameters, size_t domain_parameters_size )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006079{
Gilles Peskine8e338702019-07-30 20:06:31 +02006080 psa_key_type_t type = slot->attr.type;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006081
Gilles Peskinee56e8782019-04-26 17:34:02 +02006082 if( domain_parameters == NULL && domain_parameters_size != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006083 return( PSA_ERROR_INVALID_ARGUMENT );
6084
Gilles Peskinee59236f2018-01-27 23:32:46 +01006085 if( key_type_is_raw_bytes( type ) )
6086 {
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006087 psa_status_t status;
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006088
6089 status = validate_unstructured_key_bit_size( slot->attr.type, bits );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006090 if( status != PSA_SUCCESS )
6091 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006092
6093 /* Allocate memory for the key */
Steven Cooreman75b74362020-07-28 14:30:13 +02006094 status = psa_allocate_buffer_to_slot( slot, PSA_BITS_TO_BYTES( bits ) );
6095 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02006096 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006097
Steven Cooreman71fd80d2020-07-07 21:12:27 +02006098 status = psa_generate_random( slot->data.key.data,
6099 slot->data.key.bytes );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006100 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006101 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006102
6103 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006104#if defined(MBEDTLS_DES_C)
6105 if( type == PSA_KEY_TYPE_DES )
Steven Cooreman71fd80d2020-07-07 21:12:27 +02006106 psa_des_set_key_parity( slot->data.key.data,
6107 slot->data.key.bytes );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006108#endif /* MBEDTLS_DES_C */
6109 }
6110 else
6111
6112#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_GENPRIME)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02006113 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006114 {
Steven Cooremana01795d2020-07-24 22:48:15 +02006115 mbedtls_rsa_context rsa;
Janos Follath24eed8d2019-11-22 13:21:35 +00006116 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee56e8782019-04-26 17:34:02 +02006117 int exponent;
6118 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006119 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
6120 return( PSA_ERROR_NOT_SUPPORTED );
6121 /* Accept only byte-aligned keys, for the same reasons as
6122 * in psa_import_rsa_key(). */
6123 if( bits % 8 != 0 )
6124 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinee56e8782019-04-26 17:34:02 +02006125 status = psa_read_rsa_exponent( domain_parameters,
6126 domain_parameters_size,
6127 &exponent );
6128 if( status != PSA_SUCCESS )
6129 return( status );
Steven Cooremana01795d2020-07-24 22:48:15 +02006130 mbedtls_rsa_init( &rsa, MBEDTLS_RSA_PKCS_V15, MBEDTLS_MD_NONE );
6131 ret = mbedtls_rsa_gen_key( &rsa,
Gilles Peskinee59236f2018-01-27 23:32:46 +01006132 mbedtls_ctr_drbg_random,
6133 &global_data.ctr_drbg,
6134 (unsigned int) bits,
6135 exponent );
6136 if( ret != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006137 return( mbedtls_to_psa_error( ret ) );
Steven Cooremana01795d2020-07-24 22:48:15 +02006138
6139 /* Make sure to always have an export representation available */
6140 size_t bytes = PSA_KEY_EXPORT_RSA_KEY_PAIR_MAX_SIZE( bits );
6141
Steven Cooreman75b74362020-07-28 14:30:13 +02006142 status = psa_allocate_buffer_to_slot( slot, bytes );
6143 if( status != PSA_SUCCESS )
Steven Cooremana01795d2020-07-24 22:48:15 +02006144 {
6145 mbedtls_rsa_free( &rsa );
Steven Cooreman29149862020-08-05 15:43:42 +02006146 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006147 }
Steven Cooremana01795d2020-07-24 22:48:15 +02006148
6149 status = psa_export_rsa_key( type,
6150 &rsa,
6151 slot->data.key.data,
6152 bytes,
6153 &slot->data.key.bytes );
6154 mbedtls_rsa_free( &rsa );
6155 if( status != PSA_SUCCESS )
Steven Cooremana01795d2020-07-24 22:48:15 +02006156 psa_remove_key_data_from_memory( slot );
Steven Cooreman560c28a2020-07-24 23:20:24 +02006157 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006158 }
6159 else
6160#endif /* MBEDTLS_RSA_C && MBEDTLS_GENPRIME */
6161
6162#if defined(MBEDTLS_ECP_C)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02006163 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006164 {
Paul Elliott8ff510a2020-06-02 17:19:28 +01006165 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY( type );
Gilles Peskine4295e8b2019-12-02 21:39:10 +01006166 mbedtls_ecp_group_id grp_id =
6167 mbedtls_ecc_group_of_psa( curve, PSA_BITS_TO_BYTES( bits ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006168 const mbedtls_ecp_curve_info *curve_info =
6169 mbedtls_ecp_curve_info_from_grp_id( grp_id );
Steven Cooremanacda8342020-07-24 23:09:52 +02006170 mbedtls_ecp_keypair ecp;
Janos Follath24eed8d2019-11-22 13:21:35 +00006171 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee56e8782019-04-26 17:34:02 +02006172 if( domain_parameters_size != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006173 return( PSA_ERROR_NOT_SUPPORTED );
6174 if( grp_id == MBEDTLS_ECP_DP_NONE || curve_info == NULL )
6175 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooremanacda8342020-07-24 23:09:52 +02006176 mbedtls_ecp_keypair_init( &ecp );
6177 ret = mbedtls_ecp_gen_key( grp_id, &ecp,
Gilles Peskinee59236f2018-01-27 23:32:46 +01006178 mbedtls_ctr_drbg_random,
6179 &global_data.ctr_drbg );
6180 if( ret != 0 )
6181 {
Steven Cooremanacda8342020-07-24 23:09:52 +02006182 mbedtls_ecp_keypair_free( &ecp );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006183 return( mbedtls_to_psa_error( ret ) );
6184 }
Steven Cooremanacda8342020-07-24 23:09:52 +02006185
6186
6187 /* Make sure to always have an export representation available */
6188 size_t bytes = PSA_BITS_TO_BYTES( bits );
Steven Cooreman75b74362020-07-28 14:30:13 +02006189 psa_status_t status = psa_allocate_buffer_to_slot( slot, bytes );
6190 if( status != PSA_SUCCESS )
Steven Cooremanacda8342020-07-24 23:09:52 +02006191 {
6192 mbedtls_ecp_keypair_free( &ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02006193 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02006194 }
Steven Cooreman75b74362020-07-28 14:30:13 +02006195
6196 status = mbedtls_to_psa_error(
Steven Cooremanacda8342020-07-24 23:09:52 +02006197 mbedtls_ecp_write_key( &ecp, slot->data.key.data, bytes ) );
6198
6199 mbedtls_ecp_keypair_free( &ecp );
Steven Cooremanb7f6dea2020-08-05 16:07:20 +02006200 if( status != PSA_SUCCESS ) {
6201 memset( slot->data.key.data, 0, bytes );
Steven Cooremanacda8342020-07-24 23:09:52 +02006202 psa_remove_key_data_from_memory( slot );
Steven Cooremanb7f6dea2020-08-05 16:07:20 +02006203 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02006204 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006205 }
6206 else
6207#endif /* MBEDTLS_ECP_C */
Steven Cooreman29149862020-08-05 15:43:42 +02006208 {
Gilles Peskinee59236f2018-01-27 23:32:46 +01006209 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman29149862020-08-05 15:43:42 +02006210 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01006211
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006212 return( PSA_SUCCESS );
6213}
Darryl Green0c6575a2018-11-07 16:05:30 +00006214
Gilles Peskine35ef36b2019-05-16 19:42:05 +02006215psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02006216 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006217{
6218 psa_status_t status;
6219 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02006220 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine11792082019-08-06 18:36:36 +02006221
Gilles Peskine0f84d622019-09-12 19:03:13 +02006222 /* Reject any attempt to create a zero-length key so that we don't
6223 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
6224 if( psa_get_key_bits( attributes ) == 0 )
6225 return( PSA_ERROR_INVALID_ARGUMENT );
6226
Gilles Peskinedf179142019-07-15 22:02:14 +02006227 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE,
Ronald Croncf56a0a2020-08-04 09:51:30 +02006228 attributes, key, &slot, &driver );
Gilles Peskine11792082019-08-06 18:36:36 +02006229 if( status != PSA_SUCCESS )
6230 goto exit;
6231
Steven Cooreman2a1664c2020-07-20 15:33:08 +02006232 status = psa_driver_wrapper_generate_key( attributes,
6233 slot );
6234 if( status != PSA_ERROR_NOT_SUPPORTED ||
6235 psa_key_lifetime_is_external( attributes->core.lifetime ) )
6236 goto exit;
6237
6238 status = psa_generate_key_internal(
6239 slot, attributes->core.bits,
6240 attributes->domain_parameters, attributes->domain_parameters_size );
Gilles Peskine11792082019-08-06 18:36:36 +02006241
6242exit:
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006243 if( status == PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02006244 status = psa_finish_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006245 if( status != PSA_SUCCESS )
6246 {
Gilles Peskine011e4282019-06-26 18:34:38 +02006247 psa_fail_key_creation( slot, driver );
Ronald Croncf56a0a2020-08-04 09:51:30 +02006248 *key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006249 }
Darryl Green0c6575a2018-11-07 16:05:30 +00006250 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006251}
6252
6253
Gilles Peskinee59236f2018-01-27 23:32:46 +01006254
6255/****************************************************************/
6256/* Module setup */
6257/****************************************************************/
6258
Gilles Peskine5e769522018-11-20 21:59:56 +01006259psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
6260 void (* entropy_init )( mbedtls_entropy_context *ctx ),
6261 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
6262{
6263 if( global_data.rng_state != RNG_NOT_INITIALIZED )
6264 return( PSA_ERROR_BAD_STATE );
6265 global_data.entropy_init = entropy_init;
6266 global_data.entropy_free = entropy_free;
6267 return( PSA_SUCCESS );
6268}
6269
Gilles Peskinee59236f2018-01-27 23:32:46 +01006270void mbedtls_psa_crypto_free( void )
6271{
Gilles Peskine66fb1262018-12-10 16:29:04 +01006272 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006273 if( global_data.rng_state != RNG_NOT_INITIALIZED )
6274 {
6275 mbedtls_ctr_drbg_free( &global_data.ctr_drbg );
Gilles Peskine5e769522018-11-20 21:59:56 +01006276 global_data.entropy_free( &global_data.entropy );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006277 }
6278 /* Wipe all remaining data, including configuration.
6279 * In particular, this sets all state indicator to the value
6280 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01006281 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Gilles Peskinea8ade162019-06-26 11:24:49 +02006282#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +02006283 /* Unregister all secure element drivers, so that we restart from
6284 * a pristine state. */
6285 psa_unregister_all_se_drivers( );
Gilles Peskinea8ade162019-06-26 11:24:49 +02006286#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006287}
6288
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006289#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
6290/** Recover a transaction that was interrupted by a power failure.
6291 *
6292 * This function is called during initialization, before psa_crypto_init()
6293 * returns. If this function returns a failure status, the initialization
6294 * fails.
6295 */
6296static psa_status_t psa_crypto_recover_transaction(
6297 const psa_crypto_transaction_t *transaction )
6298{
6299 switch( transaction->unknown.type )
6300 {
6301 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
6302 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01006303 /* TODO - fall through to the failure case until this
Gilles Peskinec9d7f942019-08-13 16:17:16 +02006304 * is implemented.
6305 * https://github.com/ARMmbed/mbed-crypto/issues/218
6306 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006307 default:
6308 /* We found an unsupported transaction in the storage.
6309 * We don't know what state the storage is in. Give up. */
6310 return( PSA_ERROR_STORAGE_FAILURE );
6311 }
6312}
6313#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
6314
Gilles Peskinee59236f2018-01-27 23:32:46 +01006315psa_status_t psa_crypto_init( void )
6316{
Gilles Peskine66fb1262018-12-10 16:29:04 +01006317 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006318 const unsigned char drbg_seed[] = "PSA";
6319
Gilles Peskinec6b69072018-11-20 21:42:52 +01006320 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006321 if( global_data.initialized != 0 )
6322 return( PSA_SUCCESS );
6323
Gilles Peskine5e769522018-11-20 21:59:56 +01006324 /* Set default configuration if
6325 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
6326 if( global_data.entropy_init == NULL )
6327 global_data.entropy_init = mbedtls_entropy_init;
6328 if( global_data.entropy_free == NULL )
6329 global_data.entropy_free = mbedtls_entropy_free;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006330
Gilles Peskinec6b69072018-11-20 21:42:52 +01006331 /* Initialize the random generator. */
Gilles Peskine5e769522018-11-20 21:59:56 +01006332 global_data.entropy_init( &global_data.entropy );
Jaeden Amero76541612019-06-04 17:14:43 +01006333#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
6334 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
6335 /* The PSA entropy injection feature depends on using NV seed as an entropy
6336 * source. Add NV seed as an entropy source for PSA entropy injection. */
6337 mbedtls_entropy_add_source( &global_data.entropy,
6338 mbedtls_nv_seed_poll, NULL,
6339 MBEDTLS_ENTROPY_BLOCK_SIZE,
6340 MBEDTLS_ENTROPY_SOURCE_STRONG );
6341#endif
Gilles Peskinee59236f2018-01-27 23:32:46 +01006342 mbedtls_ctr_drbg_init( &global_data.ctr_drbg );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006343 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine66fb1262018-12-10 16:29:04 +01006344 status = mbedtls_to_psa_error(
6345 mbedtls_ctr_drbg_seed( &global_data.ctr_drbg,
6346 mbedtls_entropy_func,
6347 &global_data.entropy,
6348 drbg_seed, sizeof( drbg_seed ) - 1 ) );
6349 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006350 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01006351 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006352
Gilles Peskine66fb1262018-12-10 16:29:04 +01006353 status = psa_initialize_key_slots( );
6354 if( status != PSA_SUCCESS )
6355 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01006356
Gilles Peskined9348f22019-10-01 15:22:29 +02006357#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
6358 status = psa_init_all_se_drivers( );
6359 if( status != PSA_SUCCESS )
6360 goto exit;
6361#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
6362
Gilles Peskine4b734222019-07-24 15:56:31 +02006363#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02006364 status = psa_crypto_load_transaction( );
6365 if( status == PSA_SUCCESS )
6366 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006367 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
6368 if( status != PSA_SUCCESS )
6369 goto exit;
6370 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02006371 }
6372 else if( status == PSA_ERROR_DOES_NOT_EXIST )
6373 {
6374 /* There's no transaction to complete. It's all good. */
6375 status = PSA_SUCCESS;
6376 }
Gilles Peskine4b734222019-07-24 15:56:31 +02006377#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02006378
Gilles Peskinec6b69072018-11-20 21:42:52 +01006379 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006380 global_data.initialized = 1;
6381
6382exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01006383 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006384 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01006385 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006386}
6387
6388#endif /* MBEDTLS_PSA_CRYPTO_C */