blob: 6a07cbd0b3b5ac971b6bc651821f33be25c5d1be [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
Ronald Cron5c522922020-11-14 16:35:34 +01001190/** Get the description of a key given its identifier and policy constraints
1191 * and lock it.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001192 *
Ronald Cron5c522922020-11-14 16:35:34 +01001193 * The key must have allow all the usage flags set in \p usage. If \p alg is
1194 * nonzero, the key must allow operations with this algorithm.
Ronald Cron7587ae42020-11-11 15:04:25 +01001195 *
Ronald Cron5c522922020-11-14 16:35:34 +01001196 * In case of a persistent key, the function loads the description of the key
1197 * into a key slot if not already done.
1198 *
1199 * On success, the returned key slot is locked. It is the responsibility of
1200 * the caller to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001201 */
Ronald Cron5c522922020-11-14 16:35:34 +01001202static psa_status_t psa_get_and_lock_key_slot_with_policy(
1203 mbedtls_svc_key_id_t key,
1204 psa_key_slot_t **p_slot,
1205 psa_key_usage_t usage,
1206 psa_algorithm_t alg )
Darryl Green06fd18d2018-07-16 11:21:11 +01001207{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001208 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1209 psa_key_slot_t *slot;
Darryl Green06fd18d2018-07-16 11:21:11 +01001210
Ronald Cron5c522922020-11-14 16:35:34 +01001211 status = psa_get_and_lock_key_slot( key, p_slot );
Darryl Green06fd18d2018-07-16 11:21:11 +01001212 if( status != PSA_SUCCESS )
1213 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001214 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +01001215
1216 /* Enforce that usage policy for the key slot contains all the flags
1217 * required by the usage parameter. There is one exception: public
1218 * keys can always be exported, so we treat public key objects as
1219 * if they had the export flag. */
Gilles Peskine8e338702019-07-30 20:06:31 +02001220 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Darryl Green06fd18d2018-07-16 11:21:11 +01001221 usage &= ~PSA_KEY_USAGE_EXPORT;
Ronald Cronf95a2b12020-10-22 15:24:49 +02001222
1223 status = PSA_ERROR_NOT_PERMITTED;
Gilles Peskine8e338702019-07-30 20:06:31 +02001224 if( ( slot->attr.policy.usage & usage ) != usage )
Ronald Cronf95a2b12020-10-22 15:24:49 +02001225 goto error;
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001226
1227 /* Enforce that the usage policy permits the requested algortihm. */
Gilles Peskine8e338702019-07-30 20:06:31 +02001228 if( alg != 0 && ! psa_key_policy_permits( &slot->attr.policy, alg ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02001229 goto error;
Darryl Green06fd18d2018-07-16 11:21:11 +01001230
Darryl Green06fd18d2018-07-16 11:21:11 +01001231 return( PSA_SUCCESS );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001232
1233error:
1234 *p_slot = NULL;
Ronald Cron5c522922020-11-14 16:35:34 +01001235 psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001236
1237 return( status );
Darryl Green06fd18d2018-07-16 11:21:11 +01001238}
Darryl Green940d72c2018-07-13 13:18:51 +01001239
Ronald Cron5c522922020-11-14 16:35:34 +01001240/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001241 *
1242 * A transparent key is a key for which the key material is directly
1243 * available, as opposed to a key in a secure element.
1244 *
Ronald Cron5c522922020-11-14 16:35:34 +01001245 * This is a temporary function to use instead of
1246 * psa_get_and_lock_key_slot_with_policy() until secure element support is
1247 * fully implemented.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001248 *
Ronald Cron5c522922020-11-14 16:35:34 +01001249 * On success, the returned key slot is locked. It is the responsibility of the
1250 * caller to unlock the key slot when it does not access it anymore.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001251 */
1252#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Ronald Cron5c522922020-11-14 16:35:34 +01001253static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
1254 mbedtls_svc_key_id_t key,
1255 psa_key_slot_t **p_slot,
1256 psa_key_usage_t usage,
1257 psa_algorithm_t alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +02001258{
Ronald Cron5c522922020-11-14 16:35:34 +01001259 psa_status_t status = psa_get_and_lock_key_slot_with_policy( key, p_slot,
1260 usage, alg );
Gilles Peskine28f8f302019-07-24 13:30:31 +02001261 if( status != PSA_SUCCESS )
1262 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001263
Gilles Peskineadad8132019-07-25 11:31:23 +02001264 if( psa_key_slot_is_external( *p_slot ) )
Gilles Peskine28f8f302019-07-24 13:30:31 +02001265 {
Ronald Cron5c522922020-11-14 16:35:34 +01001266 psa_unlock_key_slot( *p_slot );
Gilles Peskine28f8f302019-07-24 13:30:31 +02001267 *p_slot = NULL;
1268 return( PSA_ERROR_NOT_SUPPORTED );
1269 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001270
Gilles Peskine28f8f302019-07-24 13:30:31 +02001271 return( PSA_SUCCESS );
1272}
1273#else /* MBEDTLS_PSA_CRYPTO_SE_C */
1274/* With no secure element support, all keys are transparent. */
Ronald Cron5c522922020-11-14 16:35:34 +01001275#define psa_get_and_lock_transparent_key_slot_with_policy( key, p_slot, usage, alg ) \
1276 psa_get_and_lock_key_slot_with_policy( key, p_slot, usage, alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +02001277#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1278
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001279/** Wipe key data from a slot. Preserve metadata such as the policy. */
Gilles Peskine2f060a82018-12-04 17:12:32 +01001280static psa_status_t psa_remove_key_data_from_memory( psa_key_slot_t *slot )
Darryl Green40225ba2018-11-15 14:48:15 +00001281{
Gilles Peskine73167e12019-07-12 23:44:37 +02001282#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1283 if( psa_key_slot_is_external( slot ) )
Darryl Green40225ba2018-11-15 14:48:15 +00001284 {
1285 /* No key material to clean. */
1286 }
Gilles Peskine73167e12019-07-12 23:44:37 +02001287 else
1288#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Darryl Green40225ba2018-11-15 14:48:15 +00001289 {
Steven Cooremanfd4d69a2020-08-05 15:46:33 +02001290 /* Data pointer will always be either a valid pointer or NULL in an
1291 * initialized slot, so we can just free it. */
1292 if( slot->data.key.data != NULL )
1293 mbedtls_platform_zeroize( slot->data.key.data, slot->data.key.bytes);
Steven Cooremana01795d2020-07-24 22:48:15 +02001294 mbedtls_free( slot->data.key.data );
1295 slot->data.key.data = NULL;
1296 slot->data.key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +00001297 }
Darryl Green40225ba2018-11-15 14:48:15 +00001298
1299 return( PSA_SUCCESS );
1300}
1301
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001302/** Completely wipe a slot in memory, including its policy.
1303 * Persistent storage is not affected. */
Gilles Peskine66fb1262018-12-10 16:29:04 +01001304psa_status_t psa_wipe_key_slot( psa_key_slot_t *slot )
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001305{
1306 psa_status_t status = psa_remove_key_data_from_memory( slot );
Ronald Cronddd3d052020-10-30 14:07:07 +01001307
1308 /*
1309 * As the return error code may not be handled in case of multiple errors,
Ronald Cron5c522922020-11-14 16:35:34 +01001310 * do our best to report an unexpected lock counter: if available
Ronald Cronddd3d052020-10-30 14:07:07 +01001311 * call MBEDTLS_PARAM_FAILED that may terminate execution (if called as
1312 * part of the execution of a test suite this will stop the test suite
Ronald Cron4640c152020-11-13 10:11:01 +01001313 * execution).
Ronald Cronddd3d052020-10-30 14:07:07 +01001314 */
Ronald Cron5c522922020-11-14 16:35:34 +01001315 if( slot->lock_count != 1 )
Ronald Cronddd3d052020-10-30 14:07:07 +01001316 {
1317#ifdef MBEDTLS_CHECK_PARAMS
Ronald Cron5c522922020-11-14 16:35:34 +01001318 MBEDTLS_PARAM_FAILED( slot->lock_count == 1 );
Ronald Cronddd3d052020-10-30 14:07:07 +01001319#endif
Ronald Cronddd3d052020-10-30 14:07:07 +01001320 status = PSA_ERROR_CORRUPTION_DETECTED;
1321 }
1322
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001323 /* Multipart operations may still be using the key. This is safe
1324 * because all multipart operation objects are independent from
1325 * the key slot: if they need to access the key after the setup
1326 * phase, they have a copy of the key. Note that this means that
1327 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001328 /* At this point, key material and other type-specific content has
1329 * been wiped. Clear remaining metadata. We can call memset and not
1330 * zeroize because the metadata is not particularly sensitive. */
1331 memset( slot, 0, sizeof( *slot ) );
1332 return( status );
1333}
1334
Ronald Croncf56a0a2020-08-04 09:51:30 +02001335psa_status_t psa_destroy_key( mbedtls_svc_key_id_t key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001336{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001337 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001338 psa_status_t status; /* status of the last operation */
1339 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001340#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1341 psa_se_drv_table_entry_t *driver;
1342#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001343
Ronald Croncf56a0a2020-08-04 09:51:30 +02001344 if( mbedtls_svc_key_id_is_null( key ) )
Gilles Peskine1841cf42019-10-08 15:48:25 +02001345 return( PSA_SUCCESS );
1346
Ronald Cronf2911112020-10-29 17:51:10 +01001347 /*
Ronald Cron19daca92020-11-10 18:08:03 +01001348 * Get the description of the key in a key slot. In case of a persistent
Ronald Cronf2911112020-10-29 17:51:10 +01001349 * key, this will load the key description from persistent memory if not
1350 * done yet. We cannot avoid this loading as without it we don't know if
1351 * the key is operated by an SE or not and this information is needed by
1352 * the current implementation.
1353 */
Ronald Cron5c522922020-11-14 16:35:34 +01001354 status = psa_get_and_lock_key_slot( key, &slot );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001355 if( status != PSA_SUCCESS )
1356 return( status );
Gilles Peskine354f7672019-07-12 23:46:38 +02001357
Ronald Cronf2911112020-10-29 17:51:10 +01001358 /*
1359 * If the key slot containing the key description is under access by the
1360 * library (apart from the present access), the key cannot be destroyed
1361 * yet. For the time being, just return in error. Eventually (to be
1362 * implemented), the key should be destroyed when all accesses have
1363 * stopped.
1364 */
Ronald Cron5c522922020-11-14 16:35:34 +01001365 if( slot->lock_count > 1 )
Ronald Cronf2911112020-10-29 17:51:10 +01001366 {
Ronald Cron5c522922020-11-14 16:35:34 +01001367 psa_unlock_key_slot( slot );
Ronald Cronf2911112020-10-29 17:51:10 +01001368 return( PSA_ERROR_GENERIC_ERROR );
1369 }
1370
Gilles Peskine354f7672019-07-12 23:46:38 +02001371#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001372 driver = psa_get_se_driver_entry( slot->attr.lifetime );
Gilles Peskine354f7672019-07-12 23:46:38 +02001373 if( driver != NULL )
Gilles Peskinefc762652019-07-22 19:30:34 +02001374 {
Gilles Peskine60450a42019-07-25 11:32:45 +02001375 /* For a key in a secure element, we need to do three things:
1376 * remove the key file in internal storage, destroy the
1377 * key inside the secure element, and update the driver's
1378 * persistent data. Start a transaction that will encompass these
1379 * three actions. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001380 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_DESTROY_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +02001381 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Gilles Peskinefc762652019-07-22 19:30:34 +02001382 psa_crypto_transaction.key.slot = slot->data.se.slot_number;
Gilles Peskine8e338702019-07-30 20:06:31 +02001383 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskinefc762652019-07-22 19:30:34 +02001384 status = psa_crypto_save_transaction( );
1385 if( status != PSA_SUCCESS )
1386 {
Gilles Peskine66be51c2019-07-25 18:02:52 +02001387 (void) psa_crypto_stop_transaction( );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001388 /* We should still try to destroy the key in the secure
1389 * element and the key metadata in storage. This is especially
1390 * important if the error is that the storage is full.
1391 * But how to do it exactly without risking an inconsistent
1392 * state after a reset?
1393 * https://github.com/ARMmbed/mbed-crypto/issues/215
1394 */
1395 overall_status = status;
1396 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001397 }
1398
Gilles Peskine354f7672019-07-12 23:46:38 +02001399 status = psa_destroy_se_key( driver, slot->data.se.slot_number );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001400 if( overall_status == PSA_SUCCESS )
1401 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001402 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001403#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1404
Darryl Greend49a4992018-06-18 17:27:26 +01001405#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Ronald Crond98059d2020-10-23 18:00:55 +02001406 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Darryl Greend49a4992018-06-18 17:27:26 +01001407 {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001408 status = psa_destroy_persistent_key( slot->attr.id );
1409 if( overall_status == PSA_SUCCESS )
1410 overall_status = status;
1411
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001412 /* TODO: other slots may have a copy of the same key. We should
1413 * invalidate them.
1414 * https://github.com/ARMmbed/mbed-crypto/issues/214
1415 */
Darryl Greend49a4992018-06-18 17:27:26 +01001416 }
1417#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001418
Gilles Peskinefc762652019-07-22 19:30:34 +02001419#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1420 if( driver != NULL )
1421 {
Gilles Peskine725f22a2019-07-25 11:31:48 +02001422 status = psa_save_se_persistent_data( driver );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001423 if( overall_status == PSA_SUCCESS )
1424 overall_status = status;
1425 status = psa_crypto_stop_transaction( );
1426 if( overall_status == PSA_SUCCESS )
1427 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001428 }
1429#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1430
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001431#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1432exit:
1433#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001434 status = psa_wipe_key_slot( slot );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001435 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
1436 if( overall_status == PSA_SUCCESS )
1437 overall_status = status;
1438 return( overall_status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001439}
1440
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001441void psa_reset_key_attributes( psa_key_attributes_t *attributes )
Gilles Peskineb870b182018-07-06 16:02:09 +02001442{
Gilles Peskineb699f072019-04-26 16:06:02 +02001443 mbedtls_free( attributes->domain_parameters );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001444 memset( attributes, 0, sizeof( *attributes ) );
Gilles Peskineb870b182018-07-06 16:02:09 +02001445}
1446
Gilles Peskineb699f072019-04-26 16:06:02 +02001447psa_status_t psa_set_key_domain_parameters( psa_key_attributes_t *attributes,
1448 psa_key_type_t type,
1449 const uint8_t *data,
1450 size_t data_length )
1451{
1452 uint8_t *copy = NULL;
1453
1454 if( data_length != 0 )
1455 {
1456 copy = mbedtls_calloc( 1, data_length );
1457 if( copy == NULL )
1458 return( PSA_ERROR_INSUFFICIENT_MEMORY );
1459 memcpy( copy, data, data_length );
1460 }
1461 /* After this point, this function is guaranteed to succeed, so it
1462 * can start modifying `*attributes`. */
1463
1464 if( attributes->domain_parameters != NULL )
1465 {
1466 mbedtls_free( attributes->domain_parameters );
1467 attributes->domain_parameters = NULL;
1468 attributes->domain_parameters_size = 0;
1469 }
1470
1471 attributes->domain_parameters = copy;
1472 attributes->domain_parameters_size = data_length;
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001473 attributes->core.type = type;
Gilles Peskineb699f072019-04-26 16:06:02 +02001474 return( PSA_SUCCESS );
1475}
1476
1477psa_status_t psa_get_key_domain_parameters(
1478 const psa_key_attributes_t *attributes,
1479 uint8_t *data, size_t data_size, size_t *data_length )
1480{
1481 if( attributes->domain_parameters_size > data_size )
1482 return( PSA_ERROR_BUFFER_TOO_SMALL );
1483 *data_length = attributes->domain_parameters_size;
1484 if( attributes->domain_parameters_size != 0 )
1485 memcpy( data, attributes->domain_parameters,
1486 attributes->domain_parameters_size );
1487 return( PSA_SUCCESS );
1488}
1489
1490#if defined(MBEDTLS_RSA_C)
1491static psa_status_t psa_get_rsa_public_exponent(
1492 const mbedtls_rsa_context *rsa,
1493 psa_key_attributes_t *attributes )
1494{
1495 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001496 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001497 uint8_t *buffer = NULL;
1498 size_t buflen;
1499 mbedtls_mpi_init( &mpi );
1500
1501 ret = mbedtls_rsa_export( rsa, NULL, NULL, NULL, NULL, &mpi );
1502 if( ret != 0 )
1503 goto exit;
Gilles Peskine772c8b12019-04-26 17:37:21 +02001504 if( mbedtls_mpi_cmp_int( &mpi, 65537 ) == 0 )
1505 {
1506 /* It's the default value, which is reported as an empty string,
1507 * so there's nothing to do. */
1508 goto exit;
1509 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001510
1511 buflen = mbedtls_mpi_size( &mpi );
1512 buffer = mbedtls_calloc( 1, buflen );
1513 if( buffer == NULL )
1514 {
1515 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1516 goto exit;
1517 }
1518 ret = mbedtls_mpi_write_binary( &mpi, buffer, buflen );
1519 if( ret != 0 )
1520 goto exit;
1521 attributes->domain_parameters = buffer;
1522 attributes->domain_parameters_size = buflen;
1523
1524exit:
1525 mbedtls_mpi_free( &mpi );
1526 if( ret != 0 )
1527 mbedtls_free( buffer );
1528 return( mbedtls_to_psa_error( ret ) );
1529}
1530#endif /* MBEDTLS_RSA_C */
1531
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001532/** Retrieve all the publicly-accessible attributes of a key.
1533 */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001534psa_status_t psa_get_key_attributes( mbedtls_svc_key_id_t key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001535 psa_key_attributes_t *attributes )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001536{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001537 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001538 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001539 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001540
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001541 psa_reset_key_attributes( attributes );
1542
Ronald Cron5c522922020-11-14 16:35:34 +01001543 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001544 if( status != PSA_SUCCESS )
1545 return( status );
Gilles Peskineb870b182018-07-06 16:02:09 +02001546
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001547 attributes->core = slot->attr;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001548 attributes->core.flags &= ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1549 MBEDTLS_PSA_KA_MASK_DUAL_USE );
1550
1551#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1552 if( psa_key_slot_is_external( slot ) )
1553 psa_set_key_slot_number( attributes, slot->data.se.slot_number );
1554#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001555
Gilles Peskine8e338702019-07-30 20:06:31 +02001556 switch( slot->attr.type )
Gilles Peskineb699f072019-04-26 16:06:02 +02001557 {
1558#if defined(MBEDTLS_RSA_C)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001559 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001560 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001561#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001562 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001563 * is not yet implemented.
1564 * https://github.com/ARMmbed/mbed-crypto/issues/216
1565 */
Gilles Peskinec8000c02019-08-02 20:15:51 +02001566 if( psa_key_slot_is_external( slot ) )
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001567 break;
1568#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Steven Cooremana01795d2020-07-24 22:48:15 +02001569 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001570 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001571
Steven Cooreman4fed4552020-08-03 14:46:03 +02001572 status = psa_load_rsa_representation( slot->attr.type,
1573 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02001574 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02001575 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001576 if( status != PSA_SUCCESS )
1577 break;
1578
Steven Cooremana2371e52020-07-28 14:30:39 +02001579 status = psa_get_rsa_public_exponent( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02001580 attributes );
Steven Cooremana2371e52020-07-28 14:30:39 +02001581 mbedtls_rsa_free( rsa );
1582 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001583 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001584 break;
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001585#endif /* MBEDTLS_RSA_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001586 default:
1587 /* Nothing else to do. */
1588 break;
1589 }
1590
1591 if( status != PSA_SUCCESS )
1592 psa_reset_key_attributes( attributes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001593
Ronald Cron5c522922020-11-14 16:35:34 +01001594 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001595
Ronald Cron5c522922020-11-14 16:35:34 +01001596 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001597}
1598
Gilles Peskinec8000c02019-08-02 20:15:51 +02001599#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1600psa_status_t psa_get_key_slot_number(
1601 const psa_key_attributes_t *attributes,
1602 psa_key_slot_number_t *slot_number )
1603{
1604 if( attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER )
1605 {
1606 *slot_number = attributes->slot_number;
1607 return( PSA_SUCCESS );
1608 }
1609 else
1610 return( PSA_ERROR_INVALID_ARGUMENT );
1611}
1612#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1613
Steven Cooremana01795d2020-07-24 22:48:15 +02001614static psa_status_t psa_internal_export_key_buffer( const psa_key_slot_t *slot,
1615 uint8_t *data,
1616 size_t data_size,
1617 size_t *data_length )
1618{
1619 if( slot->data.key.bytes > data_size )
1620 return( PSA_ERROR_BUFFER_TOO_SMALL );
1621 memcpy( data, slot->data.key.data, slot->data.key.bytes );
1622 memset( data + slot->data.key.bytes, 0,
1623 data_size - slot->data.key.bytes );
1624 *data_length = slot->data.key.bytes;
1625 return( PSA_SUCCESS );
1626}
1627
Gilles Peskinef603c712019-01-19 13:40:11 +01001628static psa_status_t psa_internal_export_key( const psa_key_slot_t *slot,
1629 uint8_t *data,
1630 size_t data_size,
1631 size_t *data_length,
1632 int export_public_key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001633{
Gilles Peskine5d309672019-07-12 23:47:28 +02001634#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1635 const psa_drv_se_t *drv;
1636 psa_drv_se_context_t *drv_context;
1637#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1638
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001639 *data_length = 0;
1640
Gilles Peskine8e338702019-07-30 20:06:31 +02001641 if( export_public_key && ! PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
Moran Pekera998bc62018-04-16 18:16:20 +03001642 return( PSA_ERROR_INVALID_ARGUMENT );
mohammad160306e79202018-03-28 13:17:44 +03001643
Gilles Peskinef9168942019-09-12 19:20:29 +02001644 /* Reject a zero-length output buffer now, since this can never be a
1645 * valid key representation. This way we know that data must be a valid
1646 * pointer and we can do things like memset(data, ..., data_size). */
1647 if( data_size == 0 )
1648 return( PSA_ERROR_BUFFER_TOO_SMALL );
1649
Gilles Peskine5d309672019-07-12 23:47:28 +02001650#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001651 if( psa_get_se_driver( slot->attr.lifetime, &drv, &drv_context ) )
Gilles Peskine5d309672019-07-12 23:47:28 +02001652 {
1653 psa_drv_se_export_key_t method;
1654 if( drv->key_management == NULL )
1655 return( PSA_ERROR_NOT_SUPPORTED );
1656 method = ( export_public_key ?
1657 drv->key_management->p_export_public :
1658 drv->key_management->p_export );
1659 if( method == NULL )
1660 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine2e0f3882019-07-25 11:34:33 +02001661 return( method( drv_context,
1662 slot->data.se.slot_number,
1663 data, data_size, data_length ) );
Gilles Peskine5d309672019-07-12 23:47:28 +02001664 }
1665#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1666
Gilles Peskine8e338702019-07-30 20:06:31 +02001667 if( key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001668 {
Steven Cooremanacda8342020-07-24 23:09:52 +02001669 return( psa_internal_export_key_buffer( slot, data, data_size, data_length ) );
Gilles Peskine188c71e2018-10-29 19:26:02 +01001670 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001671 else if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) ||
1672 PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
Moran Peker17e36e12018-05-02 12:55:20 +03001673 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001674 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Gilles Peskine969ac722018-01-28 18:16:59 +01001675 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001676 /* Exporting public -> public */
1677 return( psa_internal_export_key_buffer( slot, data, data_size, data_length ) );
1678 }
1679 else if( !export_public_key )
1680 {
1681 /* Exporting private -> private */
1682 return( psa_internal_export_key_buffer( slot, data, data_size, data_length ) );
1683 }
1684 /* Need to export the public part of a private key,
1685 * so conversion is needed */
1686 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
1687 {
Darryl Green9e2d7a02018-07-24 16:33:30 +01001688#if defined(MBEDTLS_RSA_C)
Steven Cooremana2371e52020-07-28 14:30:39 +02001689 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman7f391872020-07-30 14:57:44 +02001690 psa_status_t status = psa_load_rsa_representation(
Steven Cooreman4fed4552020-08-03 14:46:03 +02001691 slot->attr.type,
Steven Cooreman7f391872020-07-30 14:57:44 +02001692 slot->data.key.data,
1693 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02001694 &rsa );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001695 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001696 return( status );
Steven Cooremana01795d2020-07-24 22:48:15 +02001697
Steven Cooreman560c28a2020-07-24 23:20:24 +02001698 status = psa_export_rsa_key( PSA_KEY_TYPE_RSA_PUBLIC_KEY,
Steven Cooremana2371e52020-07-28 14:30:39 +02001699 rsa,
Steven Cooreman560c28a2020-07-24 23:20:24 +02001700 data,
1701 data_size,
1702 data_length );
Steven Cooremana01795d2020-07-24 22:48:15 +02001703
Steven Cooremana2371e52020-07-28 14:30:39 +02001704 mbedtls_rsa_free( rsa );
1705 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001706
Steven Cooreman560c28a2020-07-24 23:20:24 +02001707 return( status );
Darryl Green9e2d7a02018-07-24 16:33:30 +01001708#else
Steven Cooreman560c28a2020-07-24 23:20:24 +02001709 /* We don't know how to convert a private RSA key to public. */
1710 return( PSA_ERROR_NOT_SUPPORTED );
Darryl Green9e2d7a02018-07-24 16:33:30 +01001711#endif
Gilles Peskine969ac722018-01-28 18:16:59 +01001712 }
1713 else
Moran Pekera998bc62018-04-16 18:16:20 +03001714 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001715#if defined(MBEDTLS_ECP_C)
Steven Cooremana2371e52020-07-28 14:30:39 +02001716 mbedtls_ecp_keypair *ecp = NULL;
Steven Cooreman7f391872020-07-30 14:57:44 +02001717 psa_status_t status = psa_load_ecp_representation(
Steven Cooreman4fed4552020-08-03 14:46:03 +02001718 slot->attr.type,
Steven Cooreman7f391872020-07-30 14:57:44 +02001719 slot->data.key.data,
1720 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02001721 &ecp );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001722 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001723 return( status );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001724
1725 status = psa_export_ecp_key( PSA_KEY_TYPE_ECC_PUBLIC_KEY(
1726 PSA_KEY_TYPE_ECC_GET_FAMILY(
1727 slot->attr.type ) ),
Steven Cooremana2371e52020-07-28 14:30:39 +02001728 ecp,
Steven Cooreman560c28a2020-07-24 23:20:24 +02001729 data,
1730 data_size,
1731 data_length );
1732
Steven Cooremana2371e52020-07-28 14:30:39 +02001733 mbedtls_ecp_keypair_free( ecp );
1734 mbedtls_free( ecp );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001735 return( status );
1736#else
1737 /* We don't know how to convert a private ECC key to public */
Moran Pekera998bc62018-04-16 18:16:20 +03001738 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001739#endif
Moran Pekera998bc62018-04-16 18:16:20 +03001740 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001741 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001742 else
1743 {
1744 /* This shouldn't happen in the reference implementation, but
1745 it is valid for a special-purpose implementation to omit
1746 support for exporting certain key types. */
1747 return( PSA_ERROR_NOT_SUPPORTED );
1748 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001749}
1750
Ronald Croncf56a0a2020-08-04 09:51:30 +02001751psa_status_t psa_export_key( mbedtls_svc_key_id_t key,
Gilles Peskine2d277862018-06-18 15:41:12 +02001752 uint8_t *data,
1753 size_t data_size,
1754 size_t *data_length )
Moran Pekera998bc62018-04-16 18:16:20 +03001755{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001756 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001757 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001758 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001759
1760 /* Set the key to empty now, so that even when there are errors, we always
1761 * set data_length to a value between 0 and data_size. On error, setting
1762 * the key to empty is a good choice because an empty key representation is
1763 * unlikely to be accepted anywhere. */
1764 *data_length = 0;
1765
1766 /* Export requires the EXPORT flag. There is an exception for public keys,
Ronald Cron5c522922020-11-14 16:35:34 +01001767 * which don't require any flag, but
1768 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1769 */
1770 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
1771 PSA_KEY_USAGE_EXPORT, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001772 if( status != PSA_SUCCESS )
1773 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001774
1775 status = psa_internal_export_key( slot, data, data_size, data_length, 0 );
Ronald Cron5c522922020-11-14 16:35:34 +01001776 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001777
Ronald Cron5c522922020-11-14 16:35:34 +01001778 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001779}
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001780
Ronald Croncf56a0a2020-08-04 09:51:30 +02001781psa_status_t psa_export_public_key( mbedtls_svc_key_id_t key,
Gilles Peskine2d277862018-06-18 15:41:12 +02001782 uint8_t *data,
1783 size_t data_size,
1784 size_t *data_length )
Moran Pekerdd4ea382018-04-03 15:30:03 +03001785{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001786 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001787 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001788 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001789
1790 /* Set the key to empty now, so that even when there are errors, we always
1791 * set data_length to a value between 0 and data_size. On error, setting
1792 * the key to empty is a good choice because an empty key representation is
1793 * unlikely to be accepted anywhere. */
1794 *data_length = 0;
1795
1796 /* Exporting a public key doesn't require a usage flag. */
Ronald Cron5c522922020-11-14 16:35:34 +01001797 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001798 if( status != PSA_SUCCESS )
1799 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001800
1801 status = psa_internal_export_key( slot, data, data_size, data_length, 1 );
Ronald Cron5c522922020-11-14 16:35:34 +01001802 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001803
Ronald Cron5c522922020-11-14 16:35:34 +01001804 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Moran Pekerdd4ea382018-04-03 15:30:03 +03001805}
1806
Gilles Peskine91e8c332019-08-02 19:19:39 +02001807#if defined(static_assert)
1808static_assert( ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
1809 "One or more key attribute flag is listed as both external-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001810static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
Gilles Peskine094dac12019-08-07 18:19:46 +02001811 "One or more key attribute flag is listed as both internal-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001812static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY ) == 0,
Gilles Peskine91e8c332019-08-02 19:19:39 +02001813 "One or more key attribute flag is listed as both internal-only and external-only" );
1814#endif
1815
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001816/** Validate that a key policy is internally well-formed.
1817 *
1818 * This function only rejects invalid policies. It does not validate the
1819 * consistency of the policy with respect to other attributes of the key
1820 * such as the key type.
1821 */
1822static psa_status_t psa_validate_key_policy( const psa_key_policy_t *policy )
Gilles Peskine4747d192019-04-17 15:05:45 +02001823{
1824 if( ( policy->usage & ~( PSA_KEY_USAGE_EXPORT |
Gilles Peskine8e0206a2019-05-14 14:24:28 +02001825 PSA_KEY_USAGE_COPY |
Gilles Peskine4747d192019-04-17 15:05:45 +02001826 PSA_KEY_USAGE_ENCRYPT |
1827 PSA_KEY_USAGE_DECRYPT |
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001828 PSA_KEY_USAGE_SIGN_HASH |
1829 PSA_KEY_USAGE_VERIFY_HASH |
Gilles Peskine4747d192019-04-17 15:05:45 +02001830 PSA_KEY_USAGE_DERIVE ) ) != 0 )
1831 return( PSA_ERROR_INVALID_ARGUMENT );
1832
Gilles Peskine4747d192019-04-17 15:05:45 +02001833 return( PSA_SUCCESS );
1834}
1835
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001836/** Validate the internal consistency of key attributes.
1837 *
1838 * This function only rejects invalid attribute values. If does not
1839 * validate the consistency of the attributes with any key data that may
1840 * be involved in the creation of the key.
1841 *
1842 * Call this function early in the key creation process.
1843 *
1844 * \param[in] attributes Key attributes for the new key.
1845 * \param[out] p_drv On any return, the driver for the key, if any.
1846 * NULL for a transparent key.
1847 *
1848 */
1849static psa_status_t psa_validate_key_attributes(
1850 const psa_key_attributes_t *attributes,
1851 psa_se_drv_table_entry_t **p_drv )
Darryl Green0c6575a2018-11-07 16:05:30 +00001852{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001853 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Ronald Crond2ed4812020-07-17 16:11:30 +02001854 psa_key_lifetime_t lifetime = psa_get_key_lifetime( attributes );
Ronald Cron65f38a32020-10-23 17:11:13 +02001855 mbedtls_svc_key_id_t key = psa_get_key_id( attributes );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001856
Ronald Cron54b90082020-10-29 15:26:43 +01001857 status = psa_validate_key_location( lifetime, p_drv );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001858 if( status != PSA_SUCCESS )
1859 return( status );
1860
Ronald Crond2ed4812020-07-17 16:11:30 +02001861 status = psa_validate_key_persistence( lifetime );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001862 if( status != PSA_SUCCESS )
1863 return( status );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001864
Ronald Cron65f38a32020-10-23 17:11:13 +02001865 if ( PSA_KEY_LIFETIME_IS_VOLATILE( lifetime ) )
1866 {
1867 if( MBEDTLS_SVC_KEY_ID_GET_KEY_ID( key ) != 0 )
1868 return( PSA_ERROR_INVALID_ARGUMENT );
1869 }
1870 else
Ronald Crond2ed4812020-07-17 16:11:30 +02001871 {
Ronald Croncbd7bea2020-11-11 14:57:44 +01001872 status = psa_validate_key_id( psa_get_key_id( attributes ), 0 );
Ronald Crond2ed4812020-07-17 16:11:30 +02001873 if( status != PSA_SUCCESS )
1874 return( status );
1875 }
1876
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001877 status = psa_validate_key_policy( &attributes->core.policy );
Darryl Green0c6575a2018-11-07 16:05:30 +00001878 if( status != PSA_SUCCESS )
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001879 return( status );
1880
1881 /* Refuse to create overly large keys.
1882 * Note that this doesn't trigger on import if the attributes don't
1883 * explicitly specify a size (so psa_get_key_bits returns 0), so
1884 * psa_import_key() needs its own checks. */
1885 if( psa_get_key_bits( attributes ) > PSA_MAX_KEY_BITS )
1886 return( PSA_ERROR_NOT_SUPPORTED );
1887
Gilles Peskine91e8c332019-08-02 19:19:39 +02001888 /* Reject invalid flags. These should not be reachable through the API. */
1889 if( attributes->core.flags & ~ ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1890 MBEDTLS_PSA_KA_MASK_DUAL_USE ) )
1891 return( PSA_ERROR_INVALID_ARGUMENT );
1892
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001893 return( PSA_SUCCESS );
1894}
1895
Gilles Peskine4747d192019-04-17 15:05:45 +02001896/** Prepare a key slot to receive key material.
1897 *
1898 * This function allocates a key slot and sets its metadata.
1899 *
1900 * If this function fails, call psa_fail_key_creation().
1901 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001902 * This function is intended to be used as follows:
1903 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001904 * it with the specified attributes, and in case of a volatile key assign it
1905 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001906 * -# Populate the slot with the key material.
1907 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1908 * In case of failure at any step, stop the sequence and call
1909 * psa_fail_key_creation().
1910 *
Ronald Cron5c522922020-11-14 16:35:34 +01001911 * On success, the key slot is locked. It is the responsibility of the caller
1912 * to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001913 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001914 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001915 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001916 * \param[out] p_slot On success, a pointer to the prepared slot.
1917 * \param[out] p_drv On any return, the driver for the key, if any.
1918 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001919 *
1920 * \retval #PSA_SUCCESS
1921 * The key slot is ready to receive key material.
1922 * \return If this function fails, the key slot is an invalid state.
1923 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001924 */
1925static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001926 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001927 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001928 psa_key_slot_t **p_slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001929 psa_se_drv_table_entry_t **p_drv )
Gilles Peskine4747d192019-04-17 15:05:45 +02001930{
1931 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001932 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001933 psa_key_slot_t *slot;
1934
Gilles Peskinedf179142019-07-15 22:02:14 +02001935 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001936 *p_drv = NULL;
1937
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001938 status = psa_validate_key_attributes( attributes, p_drv );
1939 if( status != PSA_SUCCESS )
1940 return( status );
1941
Ronald Cronc4d1b512020-07-31 11:26:37 +02001942 status = psa_get_empty_key_slot( &volatile_key_id, p_slot );
Gilles Peskine4747d192019-04-17 15:05:45 +02001943 if( status != PSA_SUCCESS )
1944 return( status );
1945 slot = *p_slot;
1946
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001947 /* We're storing the declared bit-size of the key. It's up to each
1948 * creation mechanism to verify that this information is correct.
1949 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001950 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001951 * is optional (import, copy). In case of a volatile key, assign it the
1952 * volatile key identifier associated to the slot returned to contain its
1953 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001954
1955 slot->attr = attributes->core;
Ronald Cronc4d1b512020-07-31 11:26:37 +02001956 if( PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
1957 {
1958#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1959 slot->attr.id = volatile_key_id;
1960#else
1961 slot->attr.id.key_id = volatile_key_id;
1962#endif
1963 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001964
Gilles Peskine91e8c332019-08-02 19:19:39 +02001965 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001966 * external-only flags, query `attributes`. Thanks to the check
1967 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001968 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001969 * may have set. */
1970 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001971
Gilles Peskinecbaff462019-07-12 23:46:04 +02001972#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001973 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001974 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001975 * create the key file in internal storage, create the
1976 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001977 * persistent data. This is done by starting a transaction that will
1978 * encompass these three actions.
1979 * For registering a volatile key, we just need to find an appropriate
1980 * slot number inside the SE. Since the key is designated volatile, creating
1981 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001982 /* The first thing to do is to find a slot number for the new key.
1983 * We save the slot number in persistent storage as part of the
1984 * transaction data. It will be needed to recover if the power
1985 * fails during the key creation process, to clean up on the secure
1986 * element side after restarting. Obtaining a slot number from the
1987 * secure element driver updates its persistent state, but we do not yet
1988 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001989 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001990 if( *p_drv != NULL )
Darryl Green0c6575a2018-11-07 16:05:30 +00001991 {
Gilles Peskinee88c2c12019-08-05 16:44:14 +02001992 status = psa_find_se_slot_for_key( attributes, method, *p_drv,
Gilles Peskinecbaff462019-07-12 23:46:04 +02001993 &slot->data.se.slot_number );
1994 if( status != PSA_SUCCESS )
1995 return( status );
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001996
1997 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( attributes->core.lifetime ) )
Gilles Peskine66be51c2019-07-25 18:02:52 +02001998 {
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001999 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_CREATE_KEY );
2000 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
2001 psa_crypto_transaction.key.slot = slot->data.se.slot_number;
2002 psa_crypto_transaction.key.id = slot->attr.id;
2003 status = psa_crypto_save_transaction( );
2004 if( status != PSA_SUCCESS )
2005 {
2006 (void) psa_crypto_stop_transaction( );
2007 return( status );
2008 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02002009 }
Darryl Green0c6575a2018-11-07 16:05:30 +00002010 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02002011
2012 if( *p_drv == NULL && method == PSA_KEY_CREATION_REGISTER )
2013 {
2014 /* Key registration only makes sense with a secure element. */
2015 return( PSA_ERROR_INVALID_ARGUMENT );
2016 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02002017#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2018
Ronald Cronc4d1b512020-07-31 11:26:37 +02002019 return( PSA_SUCCESS );
Darryl Green0c6575a2018-11-07 16:05:30 +00002020}
Gilles Peskine4747d192019-04-17 15:05:45 +02002021
2022/** Finalize the creation of a key once its key material has been set.
2023 *
2024 * This entails writing the key to persistent storage.
2025 *
2026 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02002027 * See the documentation of psa_start_key_creation() for the intended use
2028 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02002029 *
Ronald Cron5c522922020-11-14 16:35:34 +01002030 * If the finalization succeeds, the function unlocks the key slot (it was
2031 * locked by psa_start_key_creation()) and the key slot cannot be accessed
2032 * anymore as part of the key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01002033 *
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.
Ronald Cron81709fc2020-11-14 12:10:32 +01002037 * \param[out] key On success, identifier of the key. Note that the
2038 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02002039 *
2040 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02002041 * The key was successfully created.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02002042 * \return If this function fails, the key slot is an invalid state.
2043 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02002044 */
Gilles Peskine011e4282019-06-26 18:34:38 +02002045static psa_status_t psa_finish_key_creation(
2046 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01002047 psa_se_drv_table_entry_t *driver,
2048 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02002049{
2050 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02002051 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02002052 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02002053
2054#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Steven Cooremanc59de6a2020-06-08 18:28:25 +02002055 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Gilles Peskine4747d192019-04-17 15:05:45 +02002056 {
Gilles Peskine1df83d42019-07-23 16:13:14 +02002057#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2058 if( driver != NULL )
2059 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02002060 psa_se_key_data_storage_t data;
2061#if defined(static_assert)
2062 static_assert( sizeof( slot->data.se.slot_number ) ==
2063 sizeof( data.slot_number ),
2064 "Slot number size does not match psa_se_key_data_storage_t" );
Gilles Peskineb46bef22019-07-30 21:32:04 +02002065#endif
2066 memcpy( &data.slot_number, &slot->data.se.slot_number,
2067 sizeof( slot->data.se.slot_number ) );
Gilles Peskine76aa09c2019-07-31 14:15:34 +02002068 status = psa_save_persistent_key( &slot->attr,
Gilles Peskineb46bef22019-07-30 21:32:04 +02002069 (uint8_t*) &data,
2070 sizeof( data ) );
Gilles Peskine1df83d42019-07-23 16:13:14 +02002071 }
2072 else
2073#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2074 {
Steven Cooreman40120f62020-10-29 11:42:22 +01002075 /* Key material is saved in export representation in the slot, so
2076 * just pass the slot buffer for storage. */
2077 status = psa_save_persistent_key( &slot->attr,
2078 slot->data.key.data,
2079 slot->data.key.bytes );
Gilles Peskine1df83d42019-07-23 16:13:14 +02002080 }
Gilles Peskine4747d192019-04-17 15:05:45 +02002081 }
Darryl Green0c6575a2018-11-07 16:05:30 +00002082#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
2083
Gilles Peskinecbaff462019-07-12 23:46:04 +02002084#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02002085 /* Finish the transaction for a key creation. This does not
2086 * happen when registering an existing key. Detect this case
2087 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02002088 * creation of a persistent key in a secure element requires a transaction,
2089 * but registration or volatile key creation doesn't use one). */
Gilles Peskined7729582019-08-05 15:55:54 +02002090 if( driver != NULL &&
2091 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY )
Gilles Peskinecbaff462019-07-12 23:46:04 +02002092 {
2093 status = psa_save_se_persistent_data( driver );
2094 if( status != PSA_SUCCESS )
2095 {
Gilles Peskine8e338702019-07-30 20:06:31 +02002096 psa_destroy_persistent_key( slot->attr.id );
Gilles Peskinecbaff462019-07-12 23:46:04 +02002097 return( status );
2098 }
Gilles Peskinefc762652019-07-22 19:30:34 +02002099 status = psa_crypto_stop_transaction( );
Gilles Peskinecbaff462019-07-12 23:46:04 +02002100 }
2101#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2102
Ronald Cron50972942020-11-14 11:28:25 +01002103 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01002104 {
2105 *key = slot->attr.id;
Ronald Cron5c522922020-11-14 16:35:34 +01002106 status = psa_unlock_key_slot( slot );
Ronald Cron81709fc2020-11-14 12:10:32 +01002107 if( status != PSA_SUCCESS )
2108 *key = MBEDTLS_SVC_KEY_ID_INIT;
2109 }
Ronald Cron50972942020-11-14 11:28:25 +01002110
Gilles Peskine4747d192019-04-17 15:05:45 +02002111 return( status );
2112}
2113
2114/** Abort the creation of a key.
2115 *
2116 * You may call this function after calling psa_start_key_creation(),
2117 * or after psa_finish_key_creation() fails. In other circumstances, this
2118 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02002119 * See the documentation of psa_start_key_creation() for the intended use
2120 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02002121 *
Gilles Peskine011e4282019-06-26 18:34:38 +02002122 * \param[in,out] slot Pointer to the slot with key material.
2123 * \param[in] driver The secure element driver for the key,
2124 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02002125 */
Gilles Peskine011e4282019-06-26 18:34:38 +02002126static void psa_fail_key_creation( psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002127 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02002128{
Gilles Peskine011e4282019-06-26 18:34:38 +02002129 (void) driver;
2130
Gilles Peskine4747d192019-04-17 15:05:45 +02002131 if( slot == NULL )
2132 return;
Gilles Peskine011e4282019-06-26 18:34:38 +02002133
2134#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01002135 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02002136 * element, and the failure happened later (when saving metadata
2137 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02002138 * element.
2139 * https://github.com/ARMmbed/mbed-crypto/issues/217
2140 */
Gilles Peskinefc762652019-07-22 19:30:34 +02002141
Gilles Peskined7729582019-08-05 15:55:54 +02002142 /* Abort the ongoing transaction if any (there may not be one if
2143 * the creation process failed before starting one, or if the
2144 * key creation is a registration of a key in a secure element).
2145 * Earlier functions must already have done what it takes to undo any
2146 * partial creation. All that's left is to update the transaction data
2147 * itself. */
Gilles Peskinefc762652019-07-22 19:30:34 +02002148 (void) psa_crypto_stop_transaction( );
Gilles Peskine011e4282019-06-26 18:34:38 +02002149#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2150
Gilles Peskine4747d192019-04-17 15:05:45 +02002151 psa_wipe_key_slot( slot );
2152}
2153
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002154/** Validate optional attributes during key creation.
2155 *
2156 * Some key attributes are optional during key creation. If they are
2157 * specified in the attributes structure, check that they are consistent
2158 * with the data in the slot.
2159 *
2160 * This function should be called near the end of key creation, after
2161 * the slot in memory is fully populated but before saving persistent data.
2162 */
2163static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002164 const psa_key_slot_t *slot,
2165 const psa_key_attributes_t *attributes )
2166{
Gilles Peskine7e0cff92019-07-30 13:48:52 +02002167 if( attributes->core.type != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002168 {
Gilles Peskine8e338702019-07-30 20:06:31 +02002169 if( attributes->core.type != slot->attr.type )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002170 return( PSA_ERROR_INVALID_ARGUMENT );
2171 }
2172
2173 if( attributes->domain_parameters_size != 0 )
2174 {
2175#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02002176 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002177 {
Steven Cooremana2371e52020-07-28 14:30:39 +02002178 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02002179 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02002180 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02002181
Steven Cooreman7f391872020-07-30 14:57:44 +02002182 psa_status_t status = psa_load_rsa_representation(
Steven Cooreman4fed4552020-08-03 14:46:03 +02002183 slot->attr.type,
Steven Cooreman7f391872020-07-30 14:57:44 +02002184 slot->data.key.data,
2185 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02002186 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02002187 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02002188 return( status );
Steven Cooreman75b74362020-07-28 14:30:13 +02002189
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002190 mbedtls_mpi_init( &actual );
2191 mbedtls_mpi_init( &required );
Steven Cooremana2371e52020-07-28 14:30:39 +02002192 ret = mbedtls_rsa_export( rsa,
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002193 NULL, NULL, NULL, NULL, &actual );
Steven Cooremana2371e52020-07-28 14:30:39 +02002194 mbedtls_rsa_free( rsa );
2195 mbedtls_free( rsa );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002196 if( ret != 0 )
2197 goto rsa_exit;
2198 ret = mbedtls_mpi_read_binary( &required,
2199 attributes->domain_parameters,
2200 attributes->domain_parameters_size );
2201 if( ret != 0 )
2202 goto rsa_exit;
2203 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
2204 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
2205 rsa_exit:
2206 mbedtls_mpi_free( &actual );
2207 mbedtls_mpi_free( &required );
2208 if( ret != 0)
2209 return( mbedtls_to_psa_error( ret ) );
2210 }
2211 else
2212#endif
2213 {
2214 return( PSA_ERROR_INVALID_ARGUMENT );
2215 }
2216 }
2217
Gilles Peskine7e0cff92019-07-30 13:48:52 +02002218 if( attributes->core.bits != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002219 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02002220 if( attributes->core.bits != slot->attr.bits )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002221 return( PSA_ERROR_INVALID_ARGUMENT );
2222 }
2223
2224 return( PSA_SUCCESS );
2225}
2226
Gilles Peskine4747d192019-04-17 15:05:45 +02002227psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02002228 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02002229 size_t data_length,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002230 mbedtls_svc_key_id_t *key )
Gilles Peskine4747d192019-04-17 15:05:45 +02002231{
2232 psa_status_t status;
2233 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002234 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002235
Ronald Cron81709fc2020-11-14 12:10:32 +01002236 *key = MBEDTLS_SVC_KEY_ID_INIT;
2237
Gilles Peskine0f84d622019-09-12 19:03:13 +02002238 /* Reject zero-length symmetric keys (including raw data key objects).
2239 * This also rejects any key which might be encoded as an empty string,
2240 * which is never valid. */
2241 if( data_length == 0 )
2242 return( PSA_ERROR_INVALID_ARGUMENT );
2243
Gilles Peskinedf179142019-07-15 22:02:14 +02002244 status = psa_start_key_creation( PSA_KEY_CREATION_IMPORT, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01002245 &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002246 if( status != PSA_SUCCESS )
2247 goto exit;
2248
Gilles Peskine5d309672019-07-12 23:47:28 +02002249#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2250 if( driver != NULL )
2251 {
2252 const psa_drv_se_t *drv = psa_get_se_driver_methods( driver );
Darryl Green0892d0f2019-08-20 09:50:14 +01002253 /* The driver should set the number of key bits, however in
2254 * case it doesn't, we initialize bits to an invalid value. */
2255 size_t bits = PSA_MAX_KEY_BITS + 1;
Gilles Peskine5d309672019-07-12 23:47:28 +02002256 if( drv->key_management == NULL ||
2257 drv->key_management->p_import == NULL )
2258 {
2259 status = PSA_ERROR_NOT_SUPPORTED;
2260 goto exit;
2261 }
2262 status = drv->key_management->p_import(
2263 psa_get_se_driver_context( driver ),
Gilles Peskinef3801ff2019-08-06 17:32:04 +02002264 slot->data.se.slot_number, attributes, data, data_length,
Gilles Peskineb46bef22019-07-30 21:32:04 +02002265 &bits );
2266 if( status != PSA_SUCCESS )
2267 goto exit;
2268 if( bits > PSA_MAX_KEY_BITS )
2269 {
2270 status = PSA_ERROR_NOT_SUPPORTED;
2271 goto exit;
2272 }
2273 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskine5d309672019-07-12 23:47:28 +02002274 }
2275 else
2276#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2277 {
2278 status = psa_import_key_into_slot( slot, data, data_length );
2279 if( status != PSA_SUCCESS )
2280 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02002281 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002282 status = psa_validate_optional_attributes( slot, attributes );
Gilles Peskine18017402019-07-24 20:25:59 +02002283 if( status != PSA_SUCCESS )
2284 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002285
Ronald Cron81709fc2020-11-14 12:10:32 +01002286 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002287exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02002288 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02002289 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002290
Gilles Peskine4747d192019-04-17 15:05:45 +02002291 return( status );
2292}
2293
Gilles Peskined7729582019-08-05 15:55:54 +02002294#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2295psa_status_t mbedtls_psa_register_se_key(
2296 const psa_key_attributes_t *attributes )
2297{
2298 psa_status_t status;
2299 psa_key_slot_t *slot = NULL;
2300 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02002301 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02002302
2303 /* Leaving attributes unspecified is not currently supported.
2304 * It could make sense to query the key type and size from the
2305 * secure element, but not all secure elements support this
2306 * and the driver HAL doesn't currently support it. */
2307 if( psa_get_key_type( attributes ) == PSA_KEY_TYPE_NONE )
2308 return( PSA_ERROR_NOT_SUPPORTED );
2309 if( psa_get_key_bits( attributes ) == 0 )
2310 return( PSA_ERROR_NOT_SUPPORTED );
2311
2312 status = psa_start_key_creation( PSA_KEY_CREATION_REGISTER, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01002313 &slot, &driver );
Gilles Peskined7729582019-08-05 15:55:54 +02002314 if( status != PSA_SUCCESS )
2315 goto exit;
2316
Ronald Cron81709fc2020-11-14 12:10:32 +01002317 status = psa_finish_key_creation( slot, driver, &key );
Gilles Peskined7729582019-08-05 15:55:54 +02002318
2319exit:
2320 if( status != PSA_SUCCESS )
Gilles Peskined7729582019-08-05 15:55:54 +02002321 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002322
Gilles Peskined7729582019-08-05 15:55:54 +02002323 /* Registration doesn't keep the key in RAM. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02002324 psa_close_key( key );
Gilles Peskined7729582019-08-05 15:55:54 +02002325 return( status );
2326}
2327#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2328
Gilles Peskinef603c712019-01-19 13:40:11 +01002329static psa_status_t psa_copy_key_material( const psa_key_slot_t *source,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002330 psa_key_slot_t *target )
Gilles Peskinef603c712019-01-19 13:40:11 +01002331{
Steven Cooremanf7cebd42020-10-13 20:27:40 +02002332 psa_status_t status = psa_copy_key_material_into_slot( target,
2333 source->data.key.data,
2334 source->data.key.bytes );
Gilles Peskinef603c712019-01-19 13:40:11 +01002335 if( status != PSA_SUCCESS )
Steven Cooreman398aee52020-10-13 14:35:45 +02002336 return( status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002337
Steven Cooreman398aee52020-10-13 14:35:45 +02002338 target->attr.type = source->attr.type;
2339 target->attr.bits = source->attr.bits;
2340
2341 return( PSA_SUCCESS );
Gilles Peskinef603c712019-01-19 13:40:11 +01002342}
2343
Ronald Croncf56a0a2020-08-04 09:51:30 +02002344psa_status_t psa_copy_key( mbedtls_svc_key_id_t source_key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002345 const psa_key_attributes_t *specified_attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002346 mbedtls_svc_key_id_t *target_key )
Gilles Peskinef603c712019-01-19 13:40:11 +01002347{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002348 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002349 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002350 psa_key_slot_t *source_slot = NULL;
2351 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002352 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002353 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskinef603c712019-01-19 13:40:11 +01002354
Ronald Cron81709fc2020-11-14 12:10:32 +01002355 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2356
Ronald Cron5c522922020-11-14 16:35:34 +01002357 status = psa_get_and_lock_transparent_key_slot_with_policy(
2358 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0 );
Gilles Peskinef603c712019-01-19 13:40:11 +01002359 if( status != PSA_SUCCESS )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002360 goto exit;
2361
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002362 status = psa_validate_optional_attributes( source_slot,
2363 specified_attributes );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002364 if( status != PSA_SUCCESS )
2365 goto exit;
2366
Gilles Peskine7e0cff92019-07-30 13:48:52 +02002367 status = psa_restrict_key_policy( &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02002368 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002369 if( status != PSA_SUCCESS )
2370 goto exit;
2371
Ronald Cron81709fc2020-11-14 12:10:32 +01002372 status = psa_start_key_creation( PSA_KEY_CREATION_COPY, &actual_attributes,
2373 &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002374 if( status != PSA_SUCCESS )
2375 goto exit;
2376
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002377#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2378 if( driver != NULL )
Gilles Peskinef603c712019-01-19 13:40:11 +01002379 {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002380 /* Copying to a secure element is not implemented yet. */
2381 status = PSA_ERROR_NOT_SUPPORTED;
2382 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002383 }
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002384#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef603c712019-01-19 13:40:11 +01002385
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002386 status = psa_copy_key_material( source_slot, target_slot );
Gilles Peskinef603c712019-01-19 13:40:11 +01002387 if( status != PSA_SUCCESS )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002388 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002389
Ronald Cron81709fc2020-11-14 12:10:32 +01002390 status = psa_finish_key_creation( target_slot, driver, target_key );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002391exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002392 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02002393 psa_fail_key_creation( target_slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002394
Ronald Cron5c522922020-11-14 16:35:34 +01002395 unlock_status = psa_unlock_key_slot( source_slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002396
Ronald Cron5c522922020-11-14 16:35:34 +01002397 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002398}
2399
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002400
2401
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002402/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002403/* Message digests */
2404/****************************************************************/
2405
John Durkop0ea39e02020-10-13 19:58:20 -07002406#if defined(MBEDTLS_RSA_C) || defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinedc2fc842018-03-07 16:42:59 +01002407static const mbedtls_md_info_t *mbedtls_md_info_from_psa( psa_algorithm_t alg )
Gilles Peskine20035e32018-02-03 22:44:14 +01002408{
2409 switch( alg )
2410 {
2411#if defined(MBEDTLS_MD2_C)
2412 case PSA_ALG_MD2:
2413 return( &mbedtls_md2_info );
2414#endif
2415#if defined(MBEDTLS_MD4_C)
2416 case PSA_ALG_MD4:
2417 return( &mbedtls_md4_info );
2418#endif
2419#if defined(MBEDTLS_MD5_C)
2420 case PSA_ALG_MD5:
2421 return( &mbedtls_md5_info );
2422#endif
2423#if defined(MBEDTLS_RIPEMD160_C)
2424 case PSA_ALG_RIPEMD160:
2425 return( &mbedtls_ripemd160_info );
2426#endif
2427#if defined(MBEDTLS_SHA1_C)
2428 case PSA_ALG_SHA_1:
2429 return( &mbedtls_sha1_info );
2430#endif
2431#if defined(MBEDTLS_SHA256_C)
2432 case PSA_ALG_SHA_224:
2433 return( &mbedtls_sha224_info );
2434 case PSA_ALG_SHA_256:
2435 return( &mbedtls_sha256_info );
2436#endif
2437#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnardd6020842019-07-17 16:28:21 +02002438#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine20035e32018-02-03 22:44:14 +01002439 case PSA_ALG_SHA_384:
2440 return( &mbedtls_sha384_info );
Manuel Pégourié-Gonnardd6020842019-07-17 16:28:21 +02002441#endif
Gilles Peskine20035e32018-02-03 22:44:14 +01002442 case PSA_ALG_SHA_512:
2443 return( &mbedtls_sha512_info );
2444#endif
2445 default:
2446 return( NULL );
2447 }
2448}
John Durkop0ea39e02020-10-13 19:58:20 -07002449#endif /* defined(MBEDTLS_RSA_C) || defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine20035e32018-02-03 22:44:14 +01002450
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002451psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
2452{
2453 switch( operation->alg )
2454 {
Gilles Peskine81736312018-06-26 15:04:31 +02002455 case 0:
2456 /* The object has (apparently) been initialized but it is not
2457 * in use. It's ok to call abort on such an object, and there's
2458 * nothing to do. */
2459 break;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002460#if defined(MBEDTLS_MD2_C)
2461 case PSA_ALG_MD2:
2462 mbedtls_md2_free( &operation->ctx.md2 );
2463 break;
2464#endif
2465#if defined(MBEDTLS_MD4_C)
2466 case PSA_ALG_MD4:
2467 mbedtls_md4_free( &operation->ctx.md4 );
2468 break;
2469#endif
2470#if defined(MBEDTLS_MD5_C)
2471 case PSA_ALG_MD5:
2472 mbedtls_md5_free( &operation->ctx.md5 );
2473 break;
2474#endif
2475#if defined(MBEDTLS_RIPEMD160_C)
2476 case PSA_ALG_RIPEMD160:
2477 mbedtls_ripemd160_free( &operation->ctx.ripemd160 );
2478 break;
2479#endif
2480#if defined(MBEDTLS_SHA1_C)
2481 case PSA_ALG_SHA_1:
2482 mbedtls_sha1_free( &operation->ctx.sha1 );
2483 break;
2484#endif
2485#if defined(MBEDTLS_SHA256_C)
2486 case PSA_ALG_SHA_224:
2487 case PSA_ALG_SHA_256:
2488 mbedtls_sha256_free( &operation->ctx.sha256 );
2489 break;
2490#endif
2491#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002492#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002493 case PSA_ALG_SHA_384:
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002494#endif
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002495 case PSA_ALG_SHA_512:
2496 mbedtls_sha512_free( &operation->ctx.sha512 );
2497 break;
2498#endif
2499 default:
Gilles Peskinef9c2c092018-06-21 16:57:07 +02002500 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002501 }
2502 operation->alg = 0;
2503 return( PSA_SUCCESS );
2504}
2505
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002506psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002507 psa_algorithm_t alg )
2508{
Janos Follath24eed8d2019-11-22 13:21:35 +00002509 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002510
2511 /* A context must be freshly initialized before it can be set up. */
2512 if( operation->alg != 0 )
2513 {
2514 return( PSA_ERROR_BAD_STATE );
2515 }
2516
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002517 switch( alg )
2518 {
2519#if defined(MBEDTLS_MD2_C)
2520 case PSA_ALG_MD2:
2521 mbedtls_md2_init( &operation->ctx.md2 );
2522 ret = mbedtls_md2_starts_ret( &operation->ctx.md2 );
2523 break;
2524#endif
2525#if defined(MBEDTLS_MD4_C)
2526 case PSA_ALG_MD4:
2527 mbedtls_md4_init( &operation->ctx.md4 );
2528 ret = mbedtls_md4_starts_ret( &operation->ctx.md4 );
2529 break;
2530#endif
2531#if defined(MBEDTLS_MD5_C)
2532 case PSA_ALG_MD5:
2533 mbedtls_md5_init( &operation->ctx.md5 );
2534 ret = mbedtls_md5_starts_ret( &operation->ctx.md5 );
2535 break;
2536#endif
2537#if defined(MBEDTLS_RIPEMD160_C)
2538 case PSA_ALG_RIPEMD160:
2539 mbedtls_ripemd160_init( &operation->ctx.ripemd160 );
2540 ret = mbedtls_ripemd160_starts_ret( &operation->ctx.ripemd160 );
2541 break;
2542#endif
2543#if defined(MBEDTLS_SHA1_C)
2544 case PSA_ALG_SHA_1:
2545 mbedtls_sha1_init( &operation->ctx.sha1 );
2546 ret = mbedtls_sha1_starts_ret( &operation->ctx.sha1 );
2547 break;
2548#endif
2549#if defined(MBEDTLS_SHA256_C)
2550 case PSA_ALG_SHA_224:
2551 mbedtls_sha256_init( &operation->ctx.sha256 );
2552 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 1 );
2553 break;
2554 case PSA_ALG_SHA_256:
2555 mbedtls_sha256_init( &operation->ctx.sha256 );
2556 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 0 );
2557 break;
2558#endif
2559#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002560#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002561 case PSA_ALG_SHA_384:
2562 mbedtls_sha512_init( &operation->ctx.sha512 );
2563 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 1 );
2564 break;
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002565#endif
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002566 case PSA_ALG_SHA_512:
2567 mbedtls_sha512_init( &operation->ctx.sha512 );
2568 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 0 );
2569 break;
2570#endif
2571 default:
Gilles Peskinec06e0712018-06-20 16:21:04 +02002572 return( PSA_ALG_IS_HASH( alg ) ?
2573 PSA_ERROR_NOT_SUPPORTED :
2574 PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002575 }
2576 if( ret == 0 )
2577 operation->alg = alg;
2578 else
2579 psa_hash_abort( operation );
2580 return( mbedtls_to_psa_error( ret ) );
2581}
2582
2583psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2584 const uint8_t *input,
2585 size_t input_length )
2586{
Janos Follath24eed8d2019-11-22 13:21:35 +00002587 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine94e44542018-07-12 16:58:43 +02002588
2589 /* Don't require hash implementations to behave correctly on a
2590 * zero-length input, which may have an invalid pointer. */
2591 if( input_length == 0 )
2592 return( PSA_SUCCESS );
2593
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002594 switch( operation->alg )
2595 {
2596#if defined(MBEDTLS_MD2_C)
2597 case PSA_ALG_MD2:
2598 ret = mbedtls_md2_update_ret( &operation->ctx.md2,
2599 input, input_length );
2600 break;
2601#endif
2602#if defined(MBEDTLS_MD4_C)
2603 case PSA_ALG_MD4:
2604 ret = mbedtls_md4_update_ret( &operation->ctx.md4,
2605 input, input_length );
2606 break;
2607#endif
2608#if defined(MBEDTLS_MD5_C)
2609 case PSA_ALG_MD5:
2610 ret = mbedtls_md5_update_ret( &operation->ctx.md5,
2611 input, input_length );
2612 break;
2613#endif
2614#if defined(MBEDTLS_RIPEMD160_C)
2615 case PSA_ALG_RIPEMD160:
2616 ret = mbedtls_ripemd160_update_ret( &operation->ctx.ripemd160,
2617 input, input_length );
2618 break;
2619#endif
2620#if defined(MBEDTLS_SHA1_C)
2621 case PSA_ALG_SHA_1:
2622 ret = mbedtls_sha1_update_ret( &operation->ctx.sha1,
2623 input, input_length );
2624 break;
2625#endif
2626#if defined(MBEDTLS_SHA256_C)
2627 case PSA_ALG_SHA_224:
2628 case PSA_ALG_SHA_256:
2629 ret = mbedtls_sha256_update_ret( &operation->ctx.sha256,
2630 input, input_length );
2631 break;
2632#endif
2633#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002634#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002635 case PSA_ALG_SHA_384:
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002636#endif
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002637 case PSA_ALG_SHA_512:
2638 ret = mbedtls_sha512_update_ret( &operation->ctx.sha512,
2639 input, input_length );
2640 break;
2641#endif
2642 default:
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002643 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002644 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002645
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002646 if( ret != 0 )
2647 psa_hash_abort( operation );
2648 return( mbedtls_to_psa_error( ret ) );
2649}
2650
2651psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2652 uint8_t *hash,
2653 size_t hash_size,
2654 size_t *hash_length )
2655{
itayzafrir40835d42018-08-02 13:14:17 +03002656 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00002657 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine71bb7b72018-04-19 08:29:59 +02002658 size_t actual_hash_length = PSA_HASH_SIZE( operation->alg );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002659
2660 /* Fill the output buffer with something that isn't a valid hash
2661 * (barring an attack on the hash and deliberately-crafted input),
2662 * in case the caller doesn't check the return status properly. */
Gilles Peskineaee13332018-07-02 12:15:28 +02002663 *hash_length = hash_size;
Gilles Peskine46f1fd72018-06-28 19:31:31 +02002664 /* If hash_size is 0 then hash may be NULL and then the
2665 * call to memset would have undefined behavior. */
2666 if( hash_size != 0 )
2667 memset( hash, '!', hash_size );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002668
2669 if( hash_size < actual_hash_length )
itayzafrir40835d42018-08-02 13:14:17 +03002670 {
2671 status = PSA_ERROR_BUFFER_TOO_SMALL;
2672 goto exit;
2673 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002674
2675 switch( operation->alg )
2676 {
2677#if defined(MBEDTLS_MD2_C)
2678 case PSA_ALG_MD2:
2679 ret = mbedtls_md2_finish_ret( &operation->ctx.md2, hash );
2680 break;
2681#endif
2682#if defined(MBEDTLS_MD4_C)
2683 case PSA_ALG_MD4:
2684 ret = mbedtls_md4_finish_ret( &operation->ctx.md4, hash );
2685 break;
2686#endif
2687#if defined(MBEDTLS_MD5_C)
2688 case PSA_ALG_MD5:
2689 ret = mbedtls_md5_finish_ret( &operation->ctx.md5, hash );
2690 break;
2691#endif
2692#if defined(MBEDTLS_RIPEMD160_C)
2693 case PSA_ALG_RIPEMD160:
2694 ret = mbedtls_ripemd160_finish_ret( &operation->ctx.ripemd160, hash );
2695 break;
2696#endif
2697#if defined(MBEDTLS_SHA1_C)
2698 case PSA_ALG_SHA_1:
2699 ret = mbedtls_sha1_finish_ret( &operation->ctx.sha1, hash );
2700 break;
2701#endif
2702#if defined(MBEDTLS_SHA256_C)
2703 case PSA_ALG_SHA_224:
2704 case PSA_ALG_SHA_256:
2705 ret = mbedtls_sha256_finish_ret( &operation->ctx.sha256, hash );
2706 break;
2707#endif
2708#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002709#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002710 case PSA_ALG_SHA_384:
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002711#endif
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002712 case PSA_ALG_SHA_512:
2713 ret = mbedtls_sha512_finish_ret( &operation->ctx.sha512, hash );
2714 break;
2715#endif
2716 default:
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002717 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002718 }
itayzafrir40835d42018-08-02 13:14:17 +03002719 status = mbedtls_to_psa_error( ret );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002720
itayzafrir40835d42018-08-02 13:14:17 +03002721exit:
2722 if( status == PSA_SUCCESS )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002723 {
Gilles Peskineaee13332018-07-02 12:15:28 +02002724 *hash_length = actual_hash_length;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002725 return( psa_hash_abort( operation ) );
2726 }
2727 else
2728 {
2729 psa_hash_abort( operation );
itayzafrir40835d42018-08-02 13:14:17 +03002730 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002731 }
2732}
2733
Gilles Peskine2d277862018-06-18 15:41:12 +02002734psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2735 const uint8_t *hash,
2736 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002737{
2738 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2739 size_t actual_hash_length;
2740 psa_status_t status = psa_hash_finish( operation,
2741 actual_hash, sizeof( actual_hash ),
2742 &actual_hash_length );
2743 if( status != PSA_SUCCESS )
2744 return( status );
2745 if( actual_hash_length != hash_length )
2746 return( PSA_ERROR_INVALID_SIGNATURE );
2747 if( safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
2748 return( PSA_ERROR_INVALID_SIGNATURE );
2749 return( PSA_SUCCESS );
2750}
2751
Gilles Peskine0a749c82019-11-28 19:33:58 +01002752psa_status_t psa_hash_compute( psa_algorithm_t alg,
2753 const uint8_t *input, size_t input_length,
2754 uint8_t *hash, size_t hash_size,
2755 size_t *hash_length )
2756{
2757 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
2758 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2759
2760 *hash_length = hash_size;
2761 status = psa_hash_setup( &operation, alg );
2762 if( status != PSA_SUCCESS )
2763 goto exit;
2764 status = psa_hash_update( &operation, input, input_length );
2765 if( status != PSA_SUCCESS )
2766 goto exit;
2767 status = psa_hash_finish( &operation, hash, hash_size, hash_length );
2768 if( status != PSA_SUCCESS )
2769 goto exit;
2770
2771exit:
2772 if( status == PSA_SUCCESS )
2773 status = psa_hash_abort( &operation );
2774 else
2775 psa_hash_abort( &operation );
2776 return( status );
2777}
2778
2779psa_status_t psa_hash_compare( psa_algorithm_t alg,
2780 const uint8_t *input, size_t input_length,
2781 const uint8_t *hash, size_t hash_length )
2782{
2783 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
2784 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2785
2786 status = psa_hash_setup( &operation, alg );
2787 if( status != PSA_SUCCESS )
2788 goto exit;
2789 status = psa_hash_update( &operation, input, input_length );
2790 if( status != PSA_SUCCESS )
2791 goto exit;
2792 status = psa_hash_verify( &operation, hash, hash_length );
2793 if( status != PSA_SUCCESS )
2794 goto exit;
2795
2796exit:
2797 if( status == PSA_SUCCESS )
2798 status = psa_hash_abort( &operation );
2799 else
2800 psa_hash_abort( &operation );
2801 return( status );
2802}
2803
Gilles Peskineeb35d782019-01-22 17:56:16 +01002804psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2805 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002806{
2807 if( target_operation->alg != 0 )
2808 return( PSA_ERROR_BAD_STATE );
2809
2810 switch( source_operation->alg )
2811 {
2812 case 0:
2813 return( PSA_ERROR_BAD_STATE );
2814#if defined(MBEDTLS_MD2_C)
2815 case PSA_ALG_MD2:
2816 mbedtls_md2_clone( &target_operation->ctx.md2,
2817 &source_operation->ctx.md2 );
2818 break;
2819#endif
2820#if defined(MBEDTLS_MD4_C)
2821 case PSA_ALG_MD4:
2822 mbedtls_md4_clone( &target_operation->ctx.md4,
2823 &source_operation->ctx.md4 );
2824 break;
2825#endif
2826#if defined(MBEDTLS_MD5_C)
2827 case PSA_ALG_MD5:
2828 mbedtls_md5_clone( &target_operation->ctx.md5,
2829 &source_operation->ctx.md5 );
2830 break;
2831#endif
2832#if defined(MBEDTLS_RIPEMD160_C)
2833 case PSA_ALG_RIPEMD160:
2834 mbedtls_ripemd160_clone( &target_operation->ctx.ripemd160,
2835 &source_operation->ctx.ripemd160 );
2836 break;
2837#endif
2838#if defined(MBEDTLS_SHA1_C)
2839 case PSA_ALG_SHA_1:
2840 mbedtls_sha1_clone( &target_operation->ctx.sha1,
2841 &source_operation->ctx.sha1 );
2842 break;
2843#endif
2844#if defined(MBEDTLS_SHA256_C)
2845 case PSA_ALG_SHA_224:
2846 case PSA_ALG_SHA_256:
2847 mbedtls_sha256_clone( &target_operation->ctx.sha256,
2848 &source_operation->ctx.sha256 );
2849 break;
2850#endif
2851#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002852#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002853 case PSA_ALG_SHA_384:
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002854#endif
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002855 case PSA_ALG_SHA_512:
2856 mbedtls_sha512_clone( &target_operation->ctx.sha512,
2857 &source_operation->ctx.sha512 );
2858 break;
2859#endif
2860 default:
2861 return( PSA_ERROR_NOT_SUPPORTED );
2862 }
2863
2864 target_operation->alg = source_operation->alg;
2865 return( PSA_SUCCESS );
2866}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002867
2868
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002869/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002870/* MAC */
2871/****************************************************************/
2872
Gilles Peskinedc2fc842018-03-07 16:42:59 +01002873static const mbedtls_cipher_info_t *mbedtls_cipher_info_from_psa(
Gilles Peskine8c9def32018-02-08 10:02:12 +01002874 psa_algorithm_t alg,
2875 psa_key_type_t key_type,
Gilles Peskine2d277862018-06-18 15:41:12 +02002876 size_t key_bits,
mohammad1603f4f0d612018-06-03 15:04:51 +03002877 mbedtls_cipher_id_t* cipher_id )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002878{
Gilles Peskine8c9def32018-02-08 10:02:12 +01002879 mbedtls_cipher_mode_t mode;
mohammad1603f4f0d612018-06-03 15:04:51 +03002880 mbedtls_cipher_id_t cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002881
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002882 if( PSA_ALG_IS_AEAD( alg ) )
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002883 alg = PSA_ALG_AEAD_WITH_TAG_LENGTH( alg, 0 );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002884
Gilles Peskine8c9def32018-02-08 10:02:12 +01002885 if( PSA_ALG_IS_CIPHER( alg ) || PSA_ALG_IS_AEAD( alg ) )
2886 {
Nir Sonnenscheine9664c32018-06-17 14:41:30 +03002887 switch( alg )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002888 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002889 case PSA_ALG_ARC4:
Gilles Peskine26869f22019-05-06 15:25:00 +02002890 case PSA_ALG_CHACHA20:
Gilles Peskine8c9def32018-02-08 10:02:12 +01002891 mode = MBEDTLS_MODE_STREAM;
2892 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002893 case PSA_ALG_CTR:
2894 mode = MBEDTLS_MODE_CTR;
2895 break;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002896 case PSA_ALG_CFB:
2897 mode = MBEDTLS_MODE_CFB;
2898 break;
2899 case PSA_ALG_OFB:
2900 mode = MBEDTLS_MODE_OFB;
2901 break;
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02002902 case PSA_ALG_ECB_NO_PADDING:
2903 mode = MBEDTLS_MODE_ECB;
2904 break;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002905 case PSA_ALG_CBC_NO_PADDING:
2906 mode = MBEDTLS_MODE_CBC;
2907 break;
2908 case PSA_ALG_CBC_PKCS7:
2909 mode = MBEDTLS_MODE_CBC;
2910 break;
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002911 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002912 mode = MBEDTLS_MODE_CCM;
2913 break;
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002914 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_GCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002915 mode = MBEDTLS_MODE_GCM;
2916 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02002917 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CHACHA20_POLY1305, 0 ):
2918 mode = MBEDTLS_MODE_CHACHAPOLY;
2919 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002920 default:
2921 return( NULL );
2922 }
2923 }
2924 else if( alg == PSA_ALG_CMAC )
2925 mode = MBEDTLS_MODE_ECB;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002926 else
2927 return( NULL );
2928
2929 switch( key_type )
2930 {
2931 case PSA_KEY_TYPE_AES:
mohammad1603f4f0d612018-06-03 15:04:51 +03002932 cipher_id_tmp = MBEDTLS_CIPHER_ID_AES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002933 break;
2934 case PSA_KEY_TYPE_DES:
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002935 /* key_bits is 64 for Single-DES, 128 for two-key Triple-DES,
2936 * and 192 for three-key Triple-DES. */
Gilles Peskine8c9def32018-02-08 10:02:12 +01002937 if( key_bits == 64 )
mohammad1603f4f0d612018-06-03 15:04:51 +03002938 cipher_id_tmp = MBEDTLS_CIPHER_ID_DES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002939 else
mohammad1603f4f0d612018-06-03 15:04:51 +03002940 cipher_id_tmp = MBEDTLS_CIPHER_ID_3DES;
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002941 /* mbedtls doesn't recognize two-key Triple-DES as an algorithm,
2942 * but two-key Triple-DES is functionally three-key Triple-DES
2943 * with K1=K3, so that's how we present it to mbedtls. */
2944 if( key_bits == 128 )
2945 key_bits = 192;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002946 break;
2947 case PSA_KEY_TYPE_CAMELLIA:
mohammad1603f4f0d612018-06-03 15:04:51 +03002948 cipher_id_tmp = MBEDTLS_CIPHER_ID_CAMELLIA;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002949 break;
2950 case PSA_KEY_TYPE_ARC4:
mohammad1603f4f0d612018-06-03 15:04:51 +03002951 cipher_id_tmp = MBEDTLS_CIPHER_ID_ARC4;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002952 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02002953 case PSA_KEY_TYPE_CHACHA20:
2954 cipher_id_tmp = MBEDTLS_CIPHER_ID_CHACHA20;
2955 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002956 default:
2957 return( NULL );
2958 }
mohammad1603f4f0d612018-06-03 15:04:51 +03002959 if( cipher_id != NULL )
mohammad160360a64d02018-06-03 17:20:42 +03002960 *cipher_id = cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002961
Jaeden Amero23bbb752018-06-26 14:16:54 +01002962 return( mbedtls_cipher_info_from_values( cipher_id_tmp,
2963 (int) key_bits, mode ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002964}
2965
Gilles Peskinea05219c2018-11-16 16:02:56 +01002966#if defined(MBEDTLS_MD_C)
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002967static size_t psa_get_hash_block_size( psa_algorithm_t alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002968{
Gilles Peskine2d277862018-06-18 15:41:12 +02002969 switch( alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002970 {
2971 case PSA_ALG_MD2:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002972 return( 16 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002973 case PSA_ALG_MD4:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002974 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002975 case PSA_ALG_MD5:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002976 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002977 case PSA_ALG_RIPEMD160:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002978 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002979 case PSA_ALG_SHA_1:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002980 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002981 case PSA_ALG_SHA_224:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002982 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002983 case PSA_ALG_SHA_256:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002984 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002985 case PSA_ALG_SHA_384:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002986 return( 128 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002987 case PSA_ALG_SHA_512:
Gilles Peskine2d277862018-06-18 15:41:12 +02002988 return( 128 );
2989 default:
2990 return( 0 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002991 }
2992}
Gilles Peskinea05219c2018-11-16 16:02:56 +01002993#endif /* MBEDTLS_MD_C */
Nir Sonnenschein0c9ec532018-06-07 13:27:47 +03002994
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002995/* Initialize the MAC operation structure. Once this function has been
2996 * called, psa_mac_abort can run and will do the right thing. */
2997static psa_status_t psa_mac_init( psa_mac_operation_t *operation,
2998 psa_algorithm_t alg )
2999{
3000 psa_status_t status = PSA_ERROR_NOT_SUPPORTED;
3001
3002 operation->alg = alg;
3003 operation->key_set = 0;
3004 operation->iv_set = 0;
3005 operation->iv_required = 0;
3006 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02003007 operation->is_sign = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003008
3009#if defined(MBEDTLS_CMAC_C)
3010 if( alg == PSA_ALG_CMAC )
3011 {
3012 operation->iv_required = 0;
3013 mbedtls_cipher_init( &operation->ctx.cmac );
3014 status = PSA_SUCCESS;
3015 }
3016 else
3017#endif /* MBEDTLS_CMAC_C */
3018#if defined(MBEDTLS_MD_C)
3019 if( PSA_ALG_IS_HMAC( operation->alg ) )
3020 {
Gilles Peskineff94abd2018-07-12 17:07:52 +02003021 /* We'll set up the hash operation later in psa_hmac_setup_internal. */
3022 operation->ctx.hmac.hash_ctx.alg = 0;
3023 status = PSA_SUCCESS;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003024 }
3025 else
3026#endif /* MBEDTLS_MD_C */
3027 {
Gilles Peskinec06e0712018-06-20 16:21:04 +02003028 if( ! PSA_ALG_IS_MAC( alg ) )
3029 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003030 }
3031
3032 if( status != PSA_SUCCESS )
3033 memset( operation, 0, sizeof( *operation ) );
3034 return( status );
3035}
3036
Gilles Peskine01126fa2018-07-12 17:04:55 +02003037#if defined(MBEDTLS_MD_C)
3038static psa_status_t psa_hmac_abort_internal( psa_hmac_internal_data *hmac )
3039{
Gilles Peskine3f108122018-12-07 18:14:53 +01003040 mbedtls_platform_zeroize( hmac->opad, sizeof( hmac->opad ) );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003041 return( psa_hash_abort( &hmac->hash_ctx ) );
3042}
3043#endif /* MBEDTLS_MD_C */
3044
Gilles Peskine8c9def32018-02-08 10:02:12 +01003045psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
3046{
Gilles Peskinefbfac682018-07-08 20:51:54 +02003047 if( operation->alg == 0 )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003048 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02003049 /* The object has (apparently) been initialized but it is not
3050 * in use. It's ok to call abort on such an object, and there's
3051 * nothing to do. */
3052 return( PSA_SUCCESS );
3053 }
3054 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01003055#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003056 if( operation->alg == PSA_ALG_CMAC )
3057 {
3058 mbedtls_cipher_free( &operation->ctx.cmac );
3059 }
3060 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01003061#endif /* MBEDTLS_CMAC_C */
Gilles Peskine8c9def32018-02-08 10:02:12 +01003062#if defined(MBEDTLS_MD_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003063 if( PSA_ALG_IS_HMAC( operation->alg ) )
3064 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02003065 psa_hmac_abort_internal( &operation->ctx.hmac );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003066 }
3067 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01003068#endif /* MBEDTLS_MD_C */
Gilles Peskinefbfac682018-07-08 20:51:54 +02003069 {
3070 /* Sanity check (shouldn't happen: operation->alg should
3071 * always have been initialized to a valid value). */
3072 goto bad_state;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003073 }
Moran Peker41deec42018-04-04 15:43:05 +03003074
Gilles Peskine8c9def32018-02-08 10:02:12 +01003075 operation->alg = 0;
3076 operation->key_set = 0;
3077 operation->iv_set = 0;
3078 operation->iv_required = 0;
3079 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02003080 operation->is_sign = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003081
Gilles Peskine8c9def32018-02-08 10:02:12 +01003082 return( PSA_SUCCESS );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003083
3084bad_state:
3085 /* If abort is called on an uninitialized object, we can't trust
3086 * anything. Wipe the object in case it contains confidential data.
3087 * This may result in a memory leak if a pointer gets overwritten,
3088 * but it's too late to do anything about this. */
3089 memset( operation, 0, sizeof( *operation ) );
3090 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003091}
3092
Gilles Peskinee3b07d82018-06-19 11:57:35 +02003093#if defined(MBEDTLS_CMAC_C)
Gilles Peskine89167cb2018-07-08 20:12:23 +02003094static int psa_cmac_setup( psa_mac_operation_t *operation,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003095 size_t key_bits,
Gilles Peskine2f060a82018-12-04 17:12:32 +01003096 psa_key_slot_t *slot,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003097 const mbedtls_cipher_info_t *cipher_info )
3098{
Janos Follath24eed8d2019-11-22 13:21:35 +00003099 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003100
3101 operation->mac_size = cipher_info->block_size;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003102
3103 ret = mbedtls_cipher_setup( &operation->ctx.cmac, cipher_info );
3104 if( ret != 0 )
3105 return( ret );
3106
3107 ret = mbedtls_cipher_cmac_starts( &operation->ctx.cmac,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02003108 slot->data.key.data,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003109 key_bits );
3110 return( ret );
3111}
Gilles Peskinee3b07d82018-06-19 11:57:35 +02003112#endif /* MBEDTLS_CMAC_C */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003113
Gilles Peskine248051a2018-06-20 16:09:38 +02003114#if defined(MBEDTLS_MD_C)
Gilles Peskine01126fa2018-07-12 17:04:55 +02003115static psa_status_t psa_hmac_setup_internal( psa_hmac_internal_data *hmac,
3116 const uint8_t *key,
3117 size_t key_length,
3118 psa_algorithm_t hash_alg )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003119{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02003120 uint8_t ipad[PSA_HMAC_MAX_HASH_BLOCK_SIZE];
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003121 size_t i;
Gilles Peskine9aa369e2018-07-16 00:36:29 +02003122 size_t hash_size = PSA_HASH_SIZE( hash_alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003123 size_t block_size = psa_get_hash_block_size( hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003124 psa_status_t status;
3125
Gilles Peskine9aa369e2018-07-16 00:36:29 +02003126 /* Sanity checks on block_size, to guarantee that there won't be a buffer
3127 * overflow below. This should never trigger if the hash algorithm
3128 * is implemented correctly. */
3129 /* The size checks against the ipad and opad buffers cannot be written
3130 * `block_size > sizeof( ipad ) || block_size > sizeof( hmac->opad )`
3131 * because that triggers -Wlogical-op on GCC 7.3. */
3132 if( block_size > sizeof( ipad ) )
3133 return( PSA_ERROR_NOT_SUPPORTED );
3134 if( block_size > sizeof( hmac->opad ) )
3135 return( PSA_ERROR_NOT_SUPPORTED );
3136 if( block_size < hash_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003137 return( PSA_ERROR_NOT_SUPPORTED );
3138
Gilles Peskined223b522018-06-11 18:12:58 +02003139 if( key_length > block_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003140 {
Gilles Peskine84b8fc82019-11-28 20:07:20 +01003141 status = psa_hash_compute( hash_alg, key, key_length,
3142 ipad, sizeof( ipad ), &key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003143 if( status != PSA_SUCCESS )
Gilles Peskineb8be2882018-07-17 16:24:34 +02003144 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003145 }
Gilles Peskine96889972018-07-12 17:07:03 +02003146 /* A 0-length key is not commonly used in HMAC when used as a MAC,
3147 * but it is permitted. It is common when HMAC is used in HKDF, for
3148 * example. Don't call `memcpy` in the 0-length because `key` could be
3149 * an invalid pointer which would make the behavior undefined. */
3150 else if( key_length != 0 )
Gilles Peskine01126fa2018-07-12 17:04:55 +02003151 memcpy( ipad, key, key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003152
Gilles Peskined223b522018-06-11 18:12:58 +02003153 /* ipad contains the key followed by garbage. Xor and fill with 0x36
3154 * to create the ipad value. */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003155 for( i = 0; i < key_length; i++ )
Gilles Peskined223b522018-06-11 18:12:58 +02003156 ipad[i] ^= 0x36;
3157 memset( ipad + key_length, 0x36, block_size - key_length );
3158
3159 /* Copy the key material from ipad to opad, flipping the requisite bits,
3160 * and filling the rest of opad with the requisite constant. */
3161 for( i = 0; i < key_length; i++ )
Gilles Peskine01126fa2018-07-12 17:04:55 +02003162 hmac->opad[i] = ipad[i] ^ 0x36 ^ 0x5C;
3163 memset( hmac->opad + key_length, 0x5C, block_size - key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003164
Gilles Peskine01126fa2018-07-12 17:04:55 +02003165 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003166 if( status != PSA_SUCCESS )
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003167 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003168
Gilles Peskine01126fa2018-07-12 17:04:55 +02003169 status = psa_hash_update( &hmac->hash_ctx, ipad, block_size );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003170
3171cleanup:
Steven Cooreman29149862020-08-05 15:43:42 +02003172 mbedtls_platform_zeroize( ipad, sizeof( ipad ) );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003173
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003174 return( status );
3175}
Gilles Peskine248051a2018-06-20 16:09:38 +02003176#endif /* MBEDTLS_MD_C */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003177
Gilles Peskine89167cb2018-07-08 20:12:23 +02003178static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003179 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02003180 psa_algorithm_t alg,
3181 int is_sign )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003182{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003183 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003184 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003185 psa_key_slot_t *slot;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003186 size_t key_bits;
Gilles Peskine89167cb2018-07-08 20:12:23 +02003187 psa_key_usage_t usage =
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003188 is_sign ? PSA_KEY_USAGE_SIGN_HASH : PSA_KEY_USAGE_VERIFY_HASH;
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02003189 uint8_t truncated = PSA_MAC_TRUNCATED_LENGTH( alg );
Gilles Peskinee0e9c7c2018-10-17 18:28:05 +02003190 psa_algorithm_t full_length_alg = PSA_ALG_FULL_LENGTH_MAC( alg );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003191
Jaeden Amero36ee5d02019-02-19 09:25:10 +00003192 /* A context must be freshly initialized before it can be set up. */
3193 if( operation->alg != 0 )
3194 {
3195 return( PSA_ERROR_BAD_STATE );
3196 }
3197
Gilles Peskined911eb72018-08-14 15:18:45 +02003198 status = psa_mac_init( operation, full_length_alg );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003199 if( status != PSA_SUCCESS )
3200 return( status );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003201 if( is_sign )
3202 operation->is_sign = 1;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003203
Ronald Cron5c522922020-11-14 16:35:34 +01003204 status = psa_get_and_lock_transparent_key_slot_with_policy(
3205 key, &slot, usage, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003206 if( status != PSA_SUCCESS )
Gilles Peskinefbfac682018-07-08 20:51:54 +02003207 goto exit;
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02003208 key_bits = psa_get_key_slot_bits( slot );
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02003209
Gilles Peskine8c9def32018-02-08 10:02:12 +01003210#if defined(MBEDTLS_CMAC_C)
Gilles Peskined911eb72018-08-14 15:18:45 +02003211 if( full_length_alg == PSA_ALG_CMAC )
Gilles Peskinefbfac682018-07-08 20:51:54 +02003212 {
3213 const mbedtls_cipher_info_t *cipher_info =
Gilles Peskined911eb72018-08-14 15:18:45 +02003214 mbedtls_cipher_info_from_psa( full_length_alg,
Gilles Peskine8e338702019-07-30 20:06:31 +02003215 slot->attr.type, key_bits, NULL );
Janos Follath24eed8d2019-11-22 13:21:35 +00003216 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinefbfac682018-07-08 20:51:54 +02003217 if( cipher_info == NULL )
3218 {
3219 status = PSA_ERROR_NOT_SUPPORTED;
3220 goto exit;
3221 }
3222 operation->mac_size = cipher_info->block_size;
3223 ret = psa_cmac_setup( operation, key_bits, slot, cipher_info );
3224 status = mbedtls_to_psa_error( ret );
3225 }
3226 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01003227#endif /* MBEDTLS_CMAC_C */
Gilles Peskine8c9def32018-02-08 10:02:12 +01003228#if defined(MBEDTLS_MD_C)
Gilles Peskined911eb72018-08-14 15:18:45 +02003229 if( PSA_ALG_IS_HMAC( full_length_alg ) )
Gilles Peskinefbfac682018-07-08 20:51:54 +02003230 {
Gilles Peskine00709fa2018-08-22 18:25:41 +02003231 psa_algorithm_t hash_alg = PSA_ALG_HMAC_GET_HASH( alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003232 if( hash_alg == 0 )
3233 {
3234 status = PSA_ERROR_NOT_SUPPORTED;
3235 goto exit;
3236 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02003237
3238 operation->mac_size = PSA_HASH_SIZE( hash_alg );
3239 /* Sanity check. This shouldn't fail on a valid configuration. */
3240 if( operation->mac_size == 0 ||
3241 operation->mac_size > sizeof( operation->ctx.hmac.opad ) )
3242 {
3243 status = PSA_ERROR_NOT_SUPPORTED;
3244 goto exit;
3245 }
3246
Gilles Peskine8e338702019-07-30 20:06:31 +02003247 if( slot->attr.type != PSA_KEY_TYPE_HMAC )
Gilles Peskine01126fa2018-07-12 17:04:55 +02003248 {
3249 status = PSA_ERROR_INVALID_ARGUMENT;
3250 goto exit;
3251 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02003252
Gilles Peskine01126fa2018-07-12 17:04:55 +02003253 status = psa_hmac_setup_internal( &operation->ctx.hmac,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02003254 slot->data.key.data,
3255 slot->data.key.bytes,
Gilles Peskine01126fa2018-07-12 17:04:55 +02003256 hash_alg );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003257 }
3258 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01003259#endif /* MBEDTLS_MD_C */
Gilles Peskinefbfac682018-07-08 20:51:54 +02003260 {
Jaeden Amero82df32e2018-11-23 15:11:20 +00003261 (void) key_bits;
Gilles Peskinefbfac682018-07-08 20:51:54 +02003262 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003263 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003264
Gilles Peskined911eb72018-08-14 15:18:45 +02003265 if( truncated == 0 )
3266 {
3267 /* The "normal" case: untruncated algorithm. Nothing to do. */
3268 }
3269 else if( truncated < 4 )
3270 {
Gilles Peskine6d72ff92018-08-21 14:55:08 +02003271 /* A very short MAC is too short for security since it can be
3272 * brute-forced. Ancient protocols with 32-bit MACs do exist,
3273 * so we make this our minimum, even though 32 bits is still
3274 * too small for security. */
Gilles Peskined911eb72018-08-14 15:18:45 +02003275 status = PSA_ERROR_NOT_SUPPORTED;
3276 }
3277 else if( truncated > operation->mac_size )
3278 {
3279 /* It's impossible to "truncate" to a larger length. */
3280 status = PSA_ERROR_INVALID_ARGUMENT;
3281 }
3282 else
3283 operation->mac_size = truncated;
3284
Gilles Peskinefbfac682018-07-08 20:51:54 +02003285exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003286 if( status != PSA_SUCCESS )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003287 {
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003288 psa_mac_abort( operation );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003289 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003290 else
3291 {
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003292 operation->key_set = 1;
3293 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003294
Ronald Cron5c522922020-11-14 16:35:34 +01003295 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003296
Ronald Cron5c522922020-11-14 16:35:34 +01003297 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003298}
3299
Gilles Peskine89167cb2018-07-08 20:12:23 +02003300psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003301 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02003302 psa_algorithm_t alg )
3303{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003304 return( psa_mac_setup( operation, key, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003305}
3306
3307psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003308 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02003309 psa_algorithm_t alg )
3310{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003311 return( psa_mac_setup( operation, key, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003312}
3313
Gilles Peskine8c9def32018-02-08 10:02:12 +01003314psa_status_t psa_mac_update( psa_mac_operation_t *operation,
3315 const uint8_t *input,
3316 size_t input_length )
3317{
Gilles Peskinefbfac682018-07-08 20:51:54 +02003318 psa_status_t status = PSA_ERROR_BAD_STATE;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003319 if( ! operation->key_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003320 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003321 if( operation->iv_required && ! operation->iv_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003322 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003323 operation->has_input = 1;
3324
Gilles Peskine8c9def32018-02-08 10:02:12 +01003325#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003326 if( operation->alg == PSA_ALG_CMAC )
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03003327 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02003328 int ret = mbedtls_cipher_cmac_update( &operation->ctx.cmac,
3329 input, input_length );
3330 status = mbedtls_to_psa_error( ret );
3331 }
3332 else
3333#endif /* MBEDTLS_CMAC_C */
3334#if defined(MBEDTLS_MD_C)
3335 if( PSA_ALG_IS_HMAC( operation->alg ) )
3336 {
3337 status = psa_hash_update( &operation->ctx.hmac.hash_ctx, input,
3338 input_length );
3339 }
3340 else
3341#endif /* MBEDTLS_MD_C */
3342 {
3343 /* This shouldn't happen if `operation` was initialized by
3344 * a setup function. */
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003345 return( PSA_ERROR_BAD_STATE );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03003346 }
3347
Gilles Peskinefbfac682018-07-08 20:51:54 +02003348 if( status != PSA_SUCCESS )
3349 psa_mac_abort( operation );
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02003350 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003351}
3352
Gilles Peskine01126fa2018-07-12 17:04:55 +02003353#if defined(MBEDTLS_MD_C)
3354static psa_status_t psa_hmac_finish_internal( psa_hmac_internal_data *hmac,
3355 uint8_t *mac,
3356 size_t mac_size )
3357{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02003358 uint8_t tmp[MBEDTLS_MD_MAX_SIZE];
Gilles Peskine01126fa2018-07-12 17:04:55 +02003359 psa_algorithm_t hash_alg = hmac->hash_ctx.alg;
3360 size_t hash_size = 0;
3361 size_t block_size = psa_get_hash_block_size( hash_alg );
3362 psa_status_t status;
3363
Gilles Peskine01126fa2018-07-12 17:04:55 +02003364 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
3365 if( status != PSA_SUCCESS )
3366 return( status );
3367 /* From here on, tmp needs to be wiped. */
3368
3369 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
3370 if( status != PSA_SUCCESS )
3371 goto exit;
3372
3373 status = psa_hash_update( &hmac->hash_ctx, hmac->opad, block_size );
3374 if( status != PSA_SUCCESS )
3375 goto exit;
3376
3377 status = psa_hash_update( &hmac->hash_ctx, tmp, hash_size );
3378 if( status != PSA_SUCCESS )
3379 goto exit;
3380
Gilles Peskined911eb72018-08-14 15:18:45 +02003381 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
3382 if( status != PSA_SUCCESS )
3383 goto exit;
3384
3385 memcpy( mac, tmp, mac_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003386
3387exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01003388 mbedtls_platform_zeroize( tmp, hash_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003389 return( status );
3390}
3391#endif /* MBEDTLS_MD_C */
3392
mohammad16036df908f2018-04-02 08:34:15 -07003393static psa_status_t psa_mac_finish_internal( psa_mac_operation_t *operation,
Gilles Peskine2d277862018-06-18 15:41:12 +02003394 uint8_t *mac,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003395 size_t mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003396{
Gilles Peskine1d96fff2018-07-02 12:15:39 +02003397 if( ! operation->key_set )
3398 return( PSA_ERROR_BAD_STATE );
3399 if( operation->iv_required && ! operation->iv_set )
3400 return( PSA_ERROR_BAD_STATE );
3401
Gilles Peskine8c9def32018-02-08 10:02:12 +01003402 if( mac_size < operation->mac_size )
3403 return( PSA_ERROR_BUFFER_TOO_SMALL );
3404
Gilles Peskine8c9def32018-02-08 10:02:12 +01003405#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003406 if( operation->alg == PSA_ALG_CMAC )
3407 {
Gilles Peskined911eb72018-08-14 15:18:45 +02003408 uint8_t tmp[PSA_MAX_BLOCK_CIPHER_BLOCK_SIZE];
3409 int ret = mbedtls_cipher_cmac_finish( &operation->ctx.cmac, tmp );
3410 if( ret == 0 )
Gilles Peskine87b0ac42018-08-21 14:55:49 +02003411 memcpy( mac, tmp, operation->mac_size );
Gilles Peskine3f108122018-12-07 18:14:53 +01003412 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003413 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003414 }
Gilles Peskinefbfac682018-07-08 20:51:54 +02003415 else
3416#endif /* MBEDTLS_CMAC_C */
3417#if defined(MBEDTLS_MD_C)
3418 if( PSA_ALG_IS_HMAC( operation->alg ) )
3419 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02003420 return( psa_hmac_finish_internal( &operation->ctx.hmac,
Gilles Peskined911eb72018-08-14 15:18:45 +02003421 mac, operation->mac_size ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003422 }
3423 else
3424#endif /* MBEDTLS_MD_C */
3425 {
3426 /* This shouldn't happen if `operation` was initialized by
3427 * a setup function. */
3428 return( PSA_ERROR_BAD_STATE );
3429 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01003430}
3431
Gilles Peskineacd4be32018-07-08 19:56:25 +02003432psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
3433 uint8_t *mac,
3434 size_t mac_size,
3435 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07003436{
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003437 psa_status_t status;
3438
Jaeden Amero252ef282019-02-15 14:05:35 +00003439 if( operation->alg == 0 )
3440 {
3441 return( PSA_ERROR_BAD_STATE );
3442 }
3443
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003444 /* Fill the output buffer with something that isn't a valid mac
3445 * (barring an attack on the mac and deliberately-crafted input),
3446 * in case the caller doesn't check the return status properly. */
3447 *mac_length = mac_size;
3448 /* If mac_size is 0 then mac may be NULL and then the
3449 * call to memset would have undefined behavior. */
3450 if( mac_size != 0 )
3451 memset( mac, '!', mac_size );
3452
Gilles Peskine89167cb2018-07-08 20:12:23 +02003453 if( ! operation->is_sign )
3454 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003455 return( PSA_ERROR_BAD_STATE );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003456 }
mohammad16036df908f2018-04-02 08:34:15 -07003457
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003458 status = psa_mac_finish_internal( operation, mac, mac_size );
3459
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003460 if( status == PSA_SUCCESS )
3461 {
3462 status = psa_mac_abort( operation );
3463 if( status == PSA_SUCCESS )
3464 *mac_length = operation->mac_size;
3465 else
3466 memset( mac, '!', mac_size );
3467 }
3468 else
3469 psa_mac_abort( operation );
3470 return( status );
mohammad16036df908f2018-04-02 08:34:15 -07003471}
3472
Gilles Peskineacd4be32018-07-08 19:56:25 +02003473psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
3474 const uint8_t *mac,
3475 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003476{
Gilles Peskine828ed142018-06-18 23:25:51 +02003477 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
mohammad16036df908f2018-04-02 08:34:15 -07003478 psa_status_t status;
3479
Jaeden Amero252ef282019-02-15 14:05:35 +00003480 if( operation->alg == 0 )
3481 {
3482 return( PSA_ERROR_BAD_STATE );
3483 }
3484
Gilles Peskine89167cb2018-07-08 20:12:23 +02003485 if( operation->is_sign )
3486 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003487 return( PSA_ERROR_BAD_STATE );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003488 }
3489 if( operation->mac_size != mac_length )
3490 {
3491 status = PSA_ERROR_INVALID_SIGNATURE;
3492 goto cleanup;
Gilles Peskine89167cb2018-07-08 20:12:23 +02003493 }
mohammad16036df908f2018-04-02 08:34:15 -07003494
3495 status = psa_mac_finish_internal( operation,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003496 actual_mac, sizeof( actual_mac ) );
Gilles Peskine28cd4162020-01-20 16:31:06 +01003497 if( status != PSA_SUCCESS )
3498 goto cleanup;
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003499
3500 if( safer_memcmp( mac, actual_mac, mac_length ) != 0 )
3501 status = PSA_ERROR_INVALID_SIGNATURE;
3502
3503cleanup:
3504 if( status == PSA_SUCCESS )
3505 status = psa_mac_abort( operation );
3506 else
3507 psa_mac_abort( operation );
3508
Gilles Peskine3f108122018-12-07 18:14:53 +01003509 mbedtls_platform_zeroize( actual_mac, sizeof( actual_mac ) );
Gilles Peskined911eb72018-08-14 15:18:45 +02003510
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003511 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003512}
3513
3514
Gilles Peskine20035e32018-02-03 22:44:14 +01003515
Gilles Peskine20035e32018-02-03 22:44:14 +01003516/****************************************************************/
3517/* Asymmetric cryptography */
3518/****************************************************************/
3519
Gilles Peskine2b450e32018-06-27 15:42:46 +02003520#if defined(MBEDTLS_RSA_C)
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02003521/* Decode the hash algorithm from alg and store the mbedtls encoding in
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003522 * md_alg. Verify that the hash length is acceptable. */
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02003523static psa_status_t psa_rsa_decode_md_type( psa_algorithm_t alg,
3524 size_t hash_length,
3525 mbedtls_md_type_t *md_alg )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003526{
Gilles Peskine7ed29c52018-06-26 15:50:08 +02003527 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003528 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003529 *md_alg = mbedtls_md_get_type( md_info );
3530
3531 /* The Mbed TLS RSA module uses an unsigned int for hash length
3532 * parameters. Validate that it fits so that we don't risk an
3533 * overflow later. */
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003534#if SIZE_MAX > UINT_MAX
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003535 if( hash_length > UINT_MAX )
3536 return( PSA_ERROR_INVALID_ARGUMENT );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003537#endif
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003538
3539#if defined(MBEDTLS_PKCS1_V15)
3540 /* For PKCS#1 v1.5 signature, if using a hash, the hash length
3541 * must be correct. */
3542 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) &&
3543 alg != PSA_ALG_RSA_PKCS1V15_SIGN_RAW )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003544 {
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003545 if( md_info == NULL )
3546 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003547 if( mbedtls_md_get_size( md_info ) != hash_length )
3548 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003549 }
3550#endif /* MBEDTLS_PKCS1_V15 */
3551
3552#if defined(MBEDTLS_PKCS1_V21)
3553 /* PSS requires a hash internally. */
3554 if( PSA_ALG_IS_RSA_PSS( alg ) )
3555 {
Gilles Peskine61b91d42018-06-08 16:09:36 +02003556 if( md_info == NULL )
3557 return( PSA_ERROR_NOT_SUPPORTED );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003558 }
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003559#endif /* MBEDTLS_PKCS1_V21 */
3560
Gilles Peskine61b91d42018-06-08 16:09:36 +02003561 return( PSA_SUCCESS );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003562}
3563
Gilles Peskine2b450e32018-06-27 15:42:46 +02003564static psa_status_t psa_rsa_sign( mbedtls_rsa_context *rsa,
3565 psa_algorithm_t alg,
3566 const uint8_t *hash,
3567 size_t hash_length,
3568 uint8_t *signature,
3569 size_t signature_size,
3570 size_t *signature_length )
3571{
3572 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00003573 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003574 mbedtls_md_type_t md_alg;
3575
3576 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
3577 if( status != PSA_SUCCESS )
3578 return( status );
3579
Gilles Peskine630a18a2018-06-29 17:49:35 +02003580 if( signature_size < mbedtls_rsa_get_len( rsa ) )
Gilles Peskine2b450e32018-06-27 15:42:46 +02003581 return( PSA_ERROR_BUFFER_TOO_SMALL );
3582
3583#if defined(MBEDTLS_PKCS1_V15)
3584 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
3585 {
3586 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
3587 MBEDTLS_MD_NONE );
3588 ret = mbedtls_rsa_pkcs1_sign( rsa,
3589 mbedtls_ctr_drbg_random,
3590 &global_data.ctr_drbg,
3591 MBEDTLS_RSA_PRIVATE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003592 md_alg,
3593 (unsigned int) hash_length,
3594 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003595 signature );
3596 }
3597 else
3598#endif /* MBEDTLS_PKCS1_V15 */
3599#if defined(MBEDTLS_PKCS1_V21)
3600 if( PSA_ALG_IS_RSA_PSS( alg ) )
3601 {
3602 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3603 ret = mbedtls_rsa_rsassa_pss_sign( rsa,
3604 mbedtls_ctr_drbg_random,
3605 &global_data.ctr_drbg,
3606 MBEDTLS_RSA_PRIVATE,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003607 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003608 (unsigned int) hash_length,
3609 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003610 signature );
3611 }
3612 else
3613#endif /* MBEDTLS_PKCS1_V21 */
3614 {
3615 return( PSA_ERROR_INVALID_ARGUMENT );
3616 }
3617
3618 if( ret == 0 )
Gilles Peskine630a18a2018-06-29 17:49:35 +02003619 *signature_length = mbedtls_rsa_get_len( rsa );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003620 return( mbedtls_to_psa_error( ret ) );
3621}
3622
3623static psa_status_t psa_rsa_verify( mbedtls_rsa_context *rsa,
3624 psa_algorithm_t alg,
3625 const uint8_t *hash,
3626 size_t hash_length,
3627 const uint8_t *signature,
3628 size_t signature_length )
3629{
3630 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00003631 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003632 mbedtls_md_type_t md_alg;
3633
3634 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
3635 if( status != PSA_SUCCESS )
3636 return( status );
3637
Gilles Peskine89cc74f2019-09-12 22:08:23 +02003638 if( signature_length != mbedtls_rsa_get_len( rsa ) )
3639 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003640
3641#if defined(MBEDTLS_PKCS1_V15)
3642 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
3643 {
3644 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
3645 MBEDTLS_MD_NONE );
3646 ret = mbedtls_rsa_pkcs1_verify( rsa,
3647 mbedtls_ctr_drbg_random,
3648 &global_data.ctr_drbg,
3649 MBEDTLS_RSA_PUBLIC,
3650 md_alg,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003651 (unsigned int) hash_length,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003652 hash,
3653 signature );
3654 }
3655 else
3656#endif /* MBEDTLS_PKCS1_V15 */
3657#if defined(MBEDTLS_PKCS1_V21)
3658 if( PSA_ALG_IS_RSA_PSS( alg ) )
3659 {
3660 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3661 ret = mbedtls_rsa_rsassa_pss_verify( rsa,
3662 mbedtls_ctr_drbg_random,
3663 &global_data.ctr_drbg,
3664 MBEDTLS_RSA_PUBLIC,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003665 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003666 (unsigned int) hash_length,
3667 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003668 signature );
3669 }
3670 else
3671#endif /* MBEDTLS_PKCS1_V21 */
3672 {
3673 return( PSA_ERROR_INVALID_ARGUMENT );
3674 }
Gilles Peskineef12c632018-09-13 20:37:48 +02003675
3676 /* Mbed TLS distinguishes "invalid padding" from "valid padding but
3677 * the rest of the signature is invalid". This has little use in
3678 * practice and PSA doesn't report this distinction. */
3679 if( ret == MBEDTLS_ERR_RSA_INVALID_PADDING )
3680 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003681 return( mbedtls_to_psa_error( ret ) );
3682}
3683#endif /* MBEDTLS_RSA_C */
3684
John Durkopf87e3ae2020-10-26 15:25:23 -07003685#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003686/* `ecp` cannot be const because `ecp->grp` needs to be non-const
3687 * for mbedtls_ecdsa_sign() and mbedtls_ecdsa_sign_det()
3688 * (even though these functions don't modify it). */
3689static psa_status_t psa_ecdsa_sign( mbedtls_ecp_keypair *ecp,
3690 psa_algorithm_t alg,
3691 const uint8_t *hash,
3692 size_t hash_length,
3693 uint8_t *signature,
3694 size_t signature_size,
3695 size_t *signature_length )
3696{
Janos Follath24eed8d2019-11-22 13:21:35 +00003697 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003698 mbedtls_mpi r, s;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003699 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003700 mbedtls_mpi_init( &r );
3701 mbedtls_mpi_init( &s );
3702
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003703 if( signature_size < 2 * curve_bytes )
3704 {
3705 ret = MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL;
3706 goto cleanup;
3707 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003708
John Durkop0ea39e02020-10-13 19:58:20 -07003709#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003710 if( PSA_ALG_DSA_IS_DETERMINISTIC( alg ) )
3711 {
3712 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
3713 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3714 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
Darryl Green5e843fa2019-09-05 14:06:34 +01003715 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign_det_ext( &ecp->grp, &r, &s,
3716 &ecp->d, hash,
3717 hash_length, md_alg,
3718 mbedtls_ctr_drbg_random,
3719 &global_data.ctr_drbg ) );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003720 }
3721 else
John Durkop0ea39e02020-10-13 19:58:20 -07003722#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003723 {
Gilles Peskinea05219c2018-11-16 16:02:56 +01003724 (void) alg;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003725 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign( &ecp->grp, &r, &s, &ecp->d,
3726 hash, hash_length,
3727 mbedtls_ctr_drbg_random,
3728 &global_data.ctr_drbg ) );
3729 }
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003730
3731 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &r,
3732 signature,
3733 curve_bytes ) );
3734 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &s,
3735 signature + curve_bytes,
3736 curve_bytes ) );
3737
3738cleanup:
3739 mbedtls_mpi_free( &r );
3740 mbedtls_mpi_free( &s );
3741 if( ret == 0 )
3742 *signature_length = 2 * curve_bytes;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003743 return( mbedtls_to_psa_error( ret ) );
3744}
3745
3746static psa_status_t psa_ecdsa_verify( mbedtls_ecp_keypair *ecp,
3747 const uint8_t *hash,
3748 size_t hash_length,
3749 const uint8_t *signature,
3750 size_t signature_length )
3751{
Janos Follath24eed8d2019-11-22 13:21:35 +00003752 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003753 mbedtls_mpi r, s;
3754 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
3755 mbedtls_mpi_init( &r );
3756 mbedtls_mpi_init( &s );
3757
3758 if( signature_length != 2 * curve_bytes )
3759 return( PSA_ERROR_INVALID_SIGNATURE );
3760
3761 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &r,
3762 signature,
3763 curve_bytes ) );
3764 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &s,
3765 signature + curve_bytes,
3766 curve_bytes ) );
3767
Steven Cooremanacda8342020-07-24 23:09:52 +02003768 /* Check whether the public part is loaded. If not, load it. */
3769 if( mbedtls_ecp_is_zero( &ecp->Q ) )
3770 {
3771 MBEDTLS_MPI_CHK(
3772 mbedtls_ecp_mul( &ecp->grp, &ecp->Q, &ecp->d, &ecp->grp.G,
3773 mbedtls_ctr_drbg_random, &global_data.ctr_drbg ) );
3774 }
3775
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003776 ret = mbedtls_ecdsa_verify( &ecp->grp, hash, hash_length,
3777 &ecp->Q, &r, &s );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003778
3779cleanup:
3780 mbedtls_mpi_free( &r );
3781 mbedtls_mpi_free( &s );
3782 return( mbedtls_to_psa_error( ret ) );
3783}
John Durkopf87e3ae2020-10-26 15:25:23 -07003784#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003785
Ronald Croncf56a0a2020-08-04 09:51:30 +02003786psa_status_t psa_sign_hash( mbedtls_svc_key_id_t key,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003787 psa_algorithm_t alg,
3788 const uint8_t *hash,
3789 size_t hash_length,
3790 uint8_t *signature,
3791 size_t signature_size,
3792 size_t *signature_length )
Gilles Peskine20035e32018-02-03 22:44:14 +01003793{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003794 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003795 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003796 psa_key_slot_t *slot;
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003797
3798 *signature_length = signature_size;
Gilles Peskine4019f0e2019-09-12 22:05:59 +02003799 /* Immediately reject a zero-length signature buffer. This guarantees
3800 * that signature must be a valid pointer. (On the other hand, the hash
3801 * buffer can in principle be empty since it doesn't actually have
3802 * to be a hash.) */
3803 if( signature_size == 0 )
3804 return( PSA_ERROR_BUFFER_TOO_SMALL );
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003805
Ronald Cron5c522922020-11-14 16:35:34 +01003806 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3807 PSA_KEY_USAGE_SIGN_HASH,
3808 alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003809 if( status != PSA_SUCCESS )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003810 goto exit;
Gilles Peskine8e338702019-07-30 20:06:31 +02003811 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003812 {
3813 status = PSA_ERROR_INVALID_ARGUMENT;
3814 goto exit;
3815 }
Gilles Peskine20035e32018-02-03 22:44:14 +01003816
Steven Cooremancd84cb42020-07-16 20:28:36 +02003817 /* Try any of the available accelerators first */
3818 status = psa_driver_wrapper_sign_hash( slot,
3819 alg,
3820 hash,
3821 hash_length,
3822 signature,
3823 signature_size,
3824 signature_length );
Steven Cooreman8d2bde72020-09-04 13:06:39 +02003825 if( status != PSA_ERROR_NOT_SUPPORTED ||
3826 psa_key_lifetime_is_external( slot->attr.lifetime ) )
Steven Cooremancd84cb42020-07-16 20:28:36 +02003827 goto exit;
3828
Steven Cooreman7a250572020-07-17 16:43:05 +02003829 /* If the operation was not supported by any accelerator, try fallback. */
Gilles Peskine20035e32018-02-03 22:44:14 +01003830#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003831 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskine20035e32018-02-03 22:44:14 +01003832 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003833 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02003834
Steven Cooreman4fed4552020-08-03 14:46:03 +02003835 status = psa_load_rsa_representation( slot->attr.type,
3836 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02003837 slot->data.key.bytes,
Steven Cooremana01795d2020-07-24 22:48:15 +02003838 &rsa );
3839 if( status != PSA_SUCCESS )
3840 goto exit;
3841
Steven Cooremana2371e52020-07-28 14:30:39 +02003842 status = psa_rsa_sign( rsa,
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003843 alg,
3844 hash, hash_length,
3845 signature, signature_size,
3846 signature_length );
Steven Cooremana01795d2020-07-24 22:48:15 +02003847
Steven Cooremana2371e52020-07-28 14:30:39 +02003848 mbedtls_rsa_free( rsa );
3849 mbedtls_free( rsa );
Gilles Peskine20035e32018-02-03 22:44:14 +01003850 }
3851 else
3852#endif /* defined(MBEDTLS_RSA_C) */
3853#if defined(MBEDTLS_ECP_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003854 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
Gilles Peskine20035e32018-02-03 22:44:14 +01003855 {
John Durkop0ea39e02020-10-13 19:58:20 -07003856#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA)
Gilles Peskinea05219c2018-11-16 16:02:56 +01003857 if(
John Durkop0ea39e02020-10-13 19:58:20 -07003858#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea05219c2018-11-16 16:02:56 +01003859 PSA_ALG_IS_ECDSA( alg )
3860#else
3861 PSA_ALG_IS_RANDOMIZED_ECDSA( alg )
3862#endif
3863 )
Steven Cooremanacda8342020-07-24 23:09:52 +02003864 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003865 mbedtls_ecp_keypair *ecp = NULL;
Steven Cooreman4fed4552020-08-03 14:46:03 +02003866 status = psa_load_ecp_representation( slot->attr.type,
3867 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02003868 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02003869 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003870 if( status != PSA_SUCCESS )
3871 goto exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003872 status = psa_ecdsa_sign( ecp,
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003873 alg,
3874 hash, hash_length,
3875 signature, signature_size,
3876 signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02003877 mbedtls_ecp_keypair_free( ecp );
3878 mbedtls_free( ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003879 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003880 else
John Durkop0ea39e02020-10-13 19:58:20 -07003881#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003882 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003883 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003884 }
itayzafrir5c753392018-05-08 11:18:38 +03003885 }
3886 else
3887#endif /* defined(MBEDTLS_ECP_C) */
3888 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003889 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine20035e32018-02-03 22:44:14 +01003890 }
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003891
3892exit:
3893 /* Fill the unused part of the output buffer (the whole buffer on error,
3894 * the trailing part on success) with something that isn't a valid mac
3895 * (barring an attack on the mac and deliberately-crafted input),
3896 * in case the caller doesn't check the return status properly. */
3897 if( status == PSA_SUCCESS )
3898 memset( signature + *signature_length, '!',
3899 signature_size - *signature_length );
Gilles Peskine4019f0e2019-09-12 22:05:59 +02003900 else
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003901 memset( signature, '!', signature_size );
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003902 /* If signature_size is 0 then we have nothing to do. We must not call
3903 * memset because signature may be NULL in this case. */
Ronald Cronf95a2b12020-10-22 15:24:49 +02003904
Ronald Cron5c522922020-11-14 16:35:34 +01003905 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003906
Ronald Cron5c522922020-11-14 16:35:34 +01003907 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
itayzafrir5c753392018-05-08 11:18:38 +03003908}
3909
Ronald Croncf56a0a2020-08-04 09:51:30 +02003910psa_status_t psa_verify_hash( mbedtls_svc_key_id_t key,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003911 psa_algorithm_t alg,
3912 const uint8_t *hash,
3913 size_t hash_length,
3914 const uint8_t *signature,
3915 size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03003916{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003917 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003918 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003919 psa_key_slot_t *slot;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003920
Ronald Cron5c522922020-11-14 16:35:34 +01003921 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3922 PSA_KEY_USAGE_VERIFY_HASH,
3923 alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003924 if( status != PSA_SUCCESS )
3925 return( status );
itayzafrir5c753392018-05-08 11:18:38 +03003926
Steven Cooreman55ae2172020-07-17 19:46:15 +02003927 /* Try any of the available accelerators first */
3928 status = psa_driver_wrapper_verify_hash( slot,
3929 alg,
3930 hash,
3931 hash_length,
3932 signature,
3933 signature_length );
Steven Cooreman8d2bde72020-09-04 13:06:39 +02003934 if( status != PSA_ERROR_NOT_SUPPORTED ||
3935 psa_key_lifetime_is_external( slot->attr.lifetime ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003936 goto exit;
Steven Cooreman55ae2172020-07-17 19:46:15 +02003937
Gilles Peskine61b91d42018-06-08 16:09:36 +02003938#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003939 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003940 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003941 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02003942
Steven Cooreman4fed4552020-08-03 14:46:03 +02003943 status = psa_load_rsa_representation( slot->attr.type,
3944 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02003945 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02003946 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003947 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003948 goto exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003949
Steven Cooremana2371e52020-07-28 14:30:39 +02003950 status = psa_rsa_verify( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02003951 alg,
3952 hash, hash_length,
3953 signature, signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02003954 mbedtls_rsa_free( rsa );
3955 mbedtls_free( rsa );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003956 goto exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003957 }
3958 else
3959#endif /* defined(MBEDTLS_RSA_C) */
itayzafrir5c753392018-05-08 11:18:38 +03003960#if defined(MBEDTLS_ECP_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003961 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
itayzafrir5c753392018-05-08 11:18:38 +03003962 {
John Durkopf87e3ae2020-10-26 15:25:23 -07003963#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003964 if( PSA_ALG_IS_ECDSA( alg ) )
Steven Cooremanacda8342020-07-24 23:09:52 +02003965 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003966 mbedtls_ecp_keypair *ecp = NULL;
Steven Cooreman4fed4552020-08-03 14:46:03 +02003967 status = psa_load_ecp_representation( slot->attr.type,
3968 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02003969 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02003970 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003971 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003972 goto exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003973 status = psa_ecdsa_verify( ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02003974 hash, hash_length,
3975 signature, signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02003976 mbedtls_ecp_keypair_free( ecp );
3977 mbedtls_free( ecp );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003978 goto exit;
Steven Cooremanacda8342020-07-24 23:09:52 +02003979 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003980 else
John Durkopf87e3ae2020-10-26 15:25:23 -07003981#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003982 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003983 status = PSA_ERROR_INVALID_ARGUMENT;
3984 goto exit;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003985 }
itayzafrir5c753392018-05-08 11:18:38 +03003986 }
Gilles Peskine20035e32018-02-03 22:44:14 +01003987 else
3988#endif /* defined(MBEDTLS_ECP_C) */
3989 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003990 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine20035e32018-02-03 22:44:14 +01003991 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003992
3993exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003994 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003995
Ronald Cron5c522922020-11-14 16:35:34 +01003996 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine20035e32018-02-03 22:44:14 +01003997}
3998
Gilles Peskine072ac562018-06-30 00:21:29 +02003999#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PKCS1_V21)
4000static void psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
4001 mbedtls_rsa_context *rsa )
4002{
4003 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
4004 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
4005 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
4006 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
4007}
4008#endif /* defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PKCS1_V21) */
4009
Ronald Croncf56a0a2020-08-04 09:51:30 +02004010psa_status_t psa_asymmetric_encrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02004011 psa_algorithm_t alg,
4012 const uint8_t *input,
4013 size_t input_length,
4014 const uint8_t *salt,
4015 size_t salt_length,
4016 uint8_t *output,
4017 size_t output_size,
4018 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004019{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004020 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004021 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01004022 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004023
Darryl Green5cc689a2018-07-24 15:34:10 +01004024 (void) input;
4025 (void) input_length;
4026 (void) salt;
4027 (void) output;
4028 (void) output_size;
4029
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03004030 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004031
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02004032 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
4033 return( PSA_ERROR_INVALID_ARGUMENT );
4034
Ronald Cron5c522922020-11-14 16:35:34 +01004035 status = psa_get_and_lock_transparent_key_slot_with_policy(
4036 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004037 if( status != PSA_SUCCESS )
4038 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02004039 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
4040 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004041 {
4042 status = PSA_ERROR_INVALID_ARGUMENT;
4043 goto exit;
4044 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004045
4046#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02004047 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004048 {
Steven Cooremana2371e52020-07-28 14:30:39 +02004049 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman4fed4552020-08-03 14:46:03 +02004050 status = psa_load_rsa_representation( slot->attr.type,
4051 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02004052 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02004053 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02004054 if( status != PSA_SUCCESS )
Steven Cooreman4fed4552020-08-03 14:46:03 +02004055 goto rsa_exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02004056
4057 if( output_size < mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02004058 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004059 status = PSA_ERROR_BUFFER_TOO_SMALL;
4060 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02004061 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004062#if defined(MBEDTLS_PKCS1_V15)
Gilles Peskine6afe7892018-05-31 13:16:08 +02004063 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004064 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004065 status = mbedtls_to_psa_error(
4066 mbedtls_rsa_pkcs1_encrypt( rsa,
4067 mbedtls_ctr_drbg_random,
4068 &global_data.ctr_drbg,
4069 MBEDTLS_RSA_PUBLIC,
4070 input_length,
4071 input,
4072 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004073 }
4074 else
4075#endif /* MBEDTLS_PKCS1_V15 */
4076#if defined(MBEDTLS_PKCS1_V21)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02004077 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004078 {
Steven Cooremana2371e52020-07-28 14:30:39 +02004079 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02004080 status = mbedtls_to_psa_error(
4081 mbedtls_rsa_rsaes_oaep_encrypt( rsa,
4082 mbedtls_ctr_drbg_random,
4083 &global_data.ctr_drbg,
4084 MBEDTLS_RSA_PUBLIC,
4085 salt, salt_length,
4086 input_length,
4087 input,
4088 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004089 }
4090 else
4091#endif /* MBEDTLS_PKCS1_V21 */
4092 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004093 status = PSA_ERROR_INVALID_ARGUMENT;
4094 goto rsa_exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004095 }
Steven Cooreman4fed4552020-08-03 14:46:03 +02004096rsa_exit:
4097 if( status == PSA_SUCCESS )
Steven Cooremana2371e52020-07-28 14:30:39 +02004098 *output_length = mbedtls_rsa_get_len( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02004099
Steven Cooremana2371e52020-07-28 14:30:39 +02004100 mbedtls_rsa_free( rsa );
4101 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004102 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004103 else
Gilles Peskineb75e4f12018-06-08 17:44:47 +02004104#endif /* defined(MBEDTLS_RSA_C) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004105 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02004106 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004107 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004108
4109exit:
Ronald Cron5c522922020-11-14 16:35:34 +01004110 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004111
Ronald Cron5c522922020-11-14 16:35:34 +01004112 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02004113}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004114
Ronald Croncf56a0a2020-08-04 09:51:30 +02004115psa_status_t psa_asymmetric_decrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02004116 psa_algorithm_t alg,
4117 const uint8_t *input,
4118 size_t input_length,
4119 const uint8_t *salt,
4120 size_t salt_length,
4121 uint8_t *output,
4122 size_t output_size,
4123 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004124{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004125 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004126 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01004127 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004128
Darryl Green5cc689a2018-07-24 15:34:10 +01004129 (void) input;
4130 (void) input_length;
4131 (void) salt;
4132 (void) output;
4133 (void) output_size;
4134
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03004135 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004136
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02004137 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
4138 return( PSA_ERROR_INVALID_ARGUMENT );
4139
Ronald Cron5c522922020-11-14 16:35:34 +01004140 status = psa_get_and_lock_transparent_key_slot_with_policy(
4141 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004142 if( status != PSA_SUCCESS )
4143 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02004144 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004145 {
4146 status = PSA_ERROR_INVALID_ARGUMENT;
4147 goto exit;
4148 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004149
4150#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02004151 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004152 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004153 mbedtls_rsa_context *rsa = NULL;
4154 status = psa_load_rsa_representation( slot->attr.type,
4155 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02004156 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02004157 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02004158 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004159 goto exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004160
Steven Cooremana2371e52020-07-28 14:30:39 +02004161 if( input_length != mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02004162 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004163 status = PSA_ERROR_INVALID_ARGUMENT;
4164 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02004165 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004166
4167#if defined(MBEDTLS_PKCS1_V15)
Gilles Peskine6afe7892018-05-31 13:16:08 +02004168 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004169 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004170 status = mbedtls_to_psa_error(
4171 mbedtls_rsa_pkcs1_decrypt( rsa,
4172 mbedtls_ctr_drbg_random,
4173 &global_data.ctr_drbg,
4174 MBEDTLS_RSA_PRIVATE,
4175 output_length,
4176 input,
4177 output,
4178 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004179 }
4180 else
4181#endif /* MBEDTLS_PKCS1_V15 */
4182#if defined(MBEDTLS_PKCS1_V21)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02004183 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004184 {
Steven Cooremana2371e52020-07-28 14:30:39 +02004185 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02004186 status = mbedtls_to_psa_error(
4187 mbedtls_rsa_rsaes_oaep_decrypt( rsa,
4188 mbedtls_ctr_drbg_random,
4189 &global_data.ctr_drbg,
4190 MBEDTLS_RSA_PRIVATE,
4191 salt, salt_length,
4192 output_length,
4193 input,
4194 output,
4195 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004196 }
4197 else
4198#endif /* MBEDTLS_PKCS1_V21 */
4199 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004200 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004201 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03004202
Steven Cooreman4fed4552020-08-03 14:46:03 +02004203rsa_exit:
Steven Cooremana2371e52020-07-28 14:30:39 +02004204 mbedtls_rsa_free( rsa );
4205 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004206 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004207 else
Gilles Peskineb75e4f12018-06-08 17:44:47 +02004208#endif /* defined(MBEDTLS_RSA_C) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004209 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02004210 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004211 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004212
4213exit:
Ronald Cron5c522922020-11-14 16:35:34 +01004214 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004215
Ronald Cron5c522922020-11-14 16:35:34 +01004216 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02004217}
Gilles Peskine20035e32018-02-03 22:44:14 +01004218
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004219
4220
mohammad1603503973b2018-03-12 15:59:30 +02004221/****************************************************************/
4222/* Symmetric cryptography */
4223/****************************************************************/
4224
Gilles Peskinee553c652018-06-04 16:22:46 +02004225static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004226 mbedtls_svc_key_id_t key,
Gilles Peskine7e928852018-06-04 16:23:10 +02004227 psa_algorithm_t alg,
4228 mbedtls_operation_t cipher_operation )
mohammad1603503973b2018-03-12 15:59:30 +02004229{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004230 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004231 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004232 int ret = 0;
Gilles Peskine2f060a82018-12-04 17:12:32 +01004233 psa_key_slot_t *slot;
mohammad1603503973b2018-03-12 15:59:30 +02004234 size_t key_bits;
4235 const mbedtls_cipher_info_t *cipher_info = NULL;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004236 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
4237 PSA_KEY_USAGE_ENCRYPT :
4238 PSA_KEY_USAGE_DECRYPT );
mohammad1603503973b2018-03-12 15:59:30 +02004239
Steven Cooremand3feccd2020-09-01 15:56:14 +02004240 /* A context must be freshly initialized before it can be set up. */
4241 if( operation->alg != 0 )
4242 return( PSA_ERROR_BAD_STATE );
4243
Steven Cooremana07b9972020-09-10 14:54:14 +02004244 /* The requested algorithm must be one that can be processed by cipher. */
4245 if( ! PSA_ALG_IS_CIPHER( alg ) )
Steven Cooremana07b9972020-09-10 14:54:14 +02004246 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremand3feccd2020-09-01 15:56:14 +02004247
Steven Cooremanef8575e2020-09-11 11:44:50 +02004248 /* Fetch key material from key storage. */
Ronald Cron5c522922020-11-14 16:35:34 +01004249 status = psa_get_and_lock_key_slot_with_policy( key, &slot, usage, alg );
Steven Cooremanef8575e2020-09-11 11:44:50 +02004250 if( status != PSA_SUCCESS )
4251 goto exit;
4252
4253 /* Initialize the operation struct members, except for alg. The alg member
4254 * is used to indicate to psa_cipher_abort that there are resources to free,
4255 * so we only set it after resources have been allocated/initialized. */
Steven Cooremana07b9972020-09-10 14:54:14 +02004256 operation->key_set = 0;
4257 operation->iv_set = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004258 operation->mbedtls_in_use = 0;
Steven Cooremana07b9972020-09-10 14:54:14 +02004259 operation->iv_size = 0;
4260 operation->block_size = 0;
4261 if( alg == PSA_ALG_ECB_NO_PADDING )
4262 operation->iv_required = 0;
4263 else
4264 operation->iv_required = 1;
4265
Steven Cooremana07b9972020-09-10 14:54:14 +02004266 /* Try doing the operation through a driver before using software fallback. */
Steven Cooreman37941cb2020-07-28 18:49:51 +02004267 if( cipher_operation == MBEDTLS_ENCRYPT )
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004268 status = psa_driver_wrapper_cipher_encrypt_setup( &operation->ctx.driver,
Steven Cooreman37941cb2020-07-28 18:49:51 +02004269 slot,
4270 alg );
4271 else
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004272 status = psa_driver_wrapper_cipher_decrypt_setup( &operation->ctx.driver,
Steven Cooreman37941cb2020-07-28 18:49:51 +02004273 slot,
4274 alg );
4275
Steven Cooremanef8575e2020-09-11 11:44:50 +02004276 if( status == PSA_SUCCESS )
Steven Cooreman6d81f7e2020-09-14 13:14:31 +02004277 {
Steven Cooremanef8575e2020-09-11 11:44:50 +02004278 /* Once the driver context is initialised, it needs to be freed using
4279 * psa_cipher_abort. Indicate this through setting alg. */
4280 operation->alg = alg;
Steven Cooreman6d81f7e2020-09-14 13:14:31 +02004281 }
Steven Cooremanef8575e2020-09-11 11:44:50 +02004282
Steven Cooremand3feccd2020-09-01 15:56:14 +02004283 if( status != PSA_ERROR_NOT_SUPPORTED ||
4284 psa_key_lifetime_is_external( slot->attr.lifetime ) )
4285 goto exit;
4286
Steven Cooremana07b9972020-09-10 14:54:14 +02004287 /* Proceed with initializing an mbed TLS cipher context if no driver is
Steven Cooremand3feccd2020-09-01 15:56:14 +02004288 * available for the given algorithm & key. */
4289 mbedtls_cipher_init( &operation->ctx.cipher );
mohammad1603503973b2018-03-12 15:59:30 +02004290
Steven Cooremana07b9972020-09-10 14:54:14 +02004291 /* Once the cipher context is initialised, it needs to be freed using
Steven Cooremanef8575e2020-09-11 11:44:50 +02004292 * psa_cipher_abort. Indicate there is something to be freed through setting
4293 * alg, and indicate the operation is being done using mbedtls crypto through
4294 * setting mbedtls_in_use. */
Steven Cooremana07b9972020-09-10 14:54:14 +02004295 operation->alg = alg;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004296 operation->mbedtls_in_use = 1;
Steven Cooremana07b9972020-09-10 14:54:14 +02004297
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02004298 key_bits = psa_get_key_slot_bits( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +02004299 cipher_info = mbedtls_cipher_info_from_psa( alg, slot->attr.type, key_bits, NULL );
mohammad1603503973b2018-03-12 15:59:30 +02004300 if( cipher_info == NULL )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004301 {
4302 status = PSA_ERROR_NOT_SUPPORTED;
4303 goto exit;
4304 }
mohammad1603503973b2018-03-12 15:59:30 +02004305
mohammad1603503973b2018-03-12 15:59:30 +02004306 ret = mbedtls_cipher_setup( &operation->ctx.cipher, cipher_info );
Moran Peker41deec42018-04-04 15:43:05 +03004307 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004308 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004309
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004310#if defined(MBEDTLS_DES_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02004311 if( slot->attr.type == PSA_KEY_TYPE_DES && key_bits == 128 )
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004312 {
4313 /* Two-key Triple-DES is 3-key Triple-DES with K1=K3 */
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02004314 uint8_t keys[24];
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004315 memcpy( keys, slot->data.key.data, 16 );
4316 memcpy( keys + 16, slot->data.key.data, 8 );
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004317 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
4318 keys,
4319 192, cipher_operation );
4320 }
4321 else
4322#endif
4323 {
4324 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004325 slot->data.key.data,
Jaeden Amero23bbb752018-06-26 14:16:54 +01004326 (int) key_bits, cipher_operation );
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004327 }
Moran Peker41deec42018-04-04 15:43:05 +03004328 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004329 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004330
mohammad16038481e742018-03-18 13:57:31 +02004331#if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004332 switch( alg )
mohammad16038481e742018-03-18 13:57:31 +02004333 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004334 case PSA_ALG_CBC_NO_PADDING:
4335 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
4336 MBEDTLS_PADDING_NONE );
4337 break;
4338 case PSA_ALG_CBC_PKCS7:
4339 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
4340 MBEDTLS_PADDING_PKCS7 );
4341 break;
4342 default:
4343 /* The algorithm doesn't involve padding. */
4344 ret = 0;
4345 break;
4346 }
4347 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004348 goto exit;
mohammad16038481e742018-03-18 13:57:31 +02004349#endif //MBEDTLS_CIPHER_MODE_WITH_PADDING
4350
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004351 operation->block_size = ( PSA_ALG_IS_STREAM_CIPHER( alg ) ? 1 :
Gilles Peskine8e338702019-07-30 20:06:31 +02004352 PSA_BLOCK_CIPHER_BLOCK_SIZE( slot->attr.type ) );
Steven Cooremana6033e92020-08-25 11:47:50 +02004353 if( ( alg & PSA_ALG_CIPHER_FROM_BLOCK_FLAG ) != 0 &&
4354 alg != PSA_ALG_ECB_NO_PADDING )
mohammad16038481e742018-03-18 13:57:31 +02004355 {
Gilles Peskine8e338702019-07-30 20:06:31 +02004356 operation->iv_size = PSA_BLOCK_CIPHER_BLOCK_SIZE( slot->attr.type );
mohammad16038481e742018-03-18 13:57:31 +02004357 }
Gilles Peskine26869f22019-05-06 15:25:00 +02004358#if defined(MBEDTLS_CHACHA20_C)
4359 else
4360 if( alg == PSA_ALG_CHACHA20 )
4361 operation->iv_size = 12;
4362#endif
mohammad1603503973b2018-03-12 15:59:30 +02004363
Steven Cooreman7df02922020-09-09 15:28:49 +02004364 status = PSA_SUCCESS;
4365
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004366exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02004367 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004368 status = mbedtls_to_psa_error( ret );
Steven Cooreman7df02922020-09-09 15:28:49 +02004369 if( status == PSA_SUCCESS )
4370 {
4371 /* Update operation flags for both driver and software implementations */
4372 operation->key_set = 1;
4373 }
4374 else
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004375 psa_cipher_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004376
Ronald Cron5c522922020-11-14 16:35:34 +01004377 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004378
Ronald Cron5c522922020-11-14 16:35:34 +01004379 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
mohammad1603503973b2018-03-12 15:59:30 +02004380}
4381
Gilles Peskinefe119512018-07-08 21:39:34 +02004382psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004383 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02004384 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02004385{
Ronald Croncf56a0a2020-08-04 09:51:30 +02004386 return( psa_cipher_setup( operation, key, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02004387}
4388
Gilles Peskinefe119512018-07-08 21:39:34 +02004389psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004390 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02004391 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02004392{
Ronald Croncf56a0a2020-08-04 09:51:30 +02004393 return( psa_cipher_setup( operation, key, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02004394}
4395
Gilles Peskinefe119512018-07-08 21:39:34 +02004396psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004397 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02004398 size_t iv_size,
4399 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02004400{
itayzafrir534bd7c2018-08-02 13:56:32 +03004401 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00004402 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooreman7df02922020-09-09 15:28:49 +02004403 if( operation->iv_set || ! operation->iv_required )
4404 {
4405 return( PSA_ERROR_BAD_STATE );
4406 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004407
Steven Cooremanef8575e2020-09-11 11:44:50 +02004408 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004409 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004410 status = psa_driver_wrapper_cipher_generate_iv( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004411 iv,
4412 iv_size,
4413 iv_length );
4414 goto exit;
4415 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004416
Moran Peker41deec42018-04-04 15:43:05 +03004417 if( iv_size < operation->iv_size )
mohammad1603503973b2018-03-12 15:59:30 +02004418 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004419 status = PSA_ERROR_BUFFER_TOO_SMALL;
Moran Peker41deec42018-04-04 15:43:05 +03004420 goto exit;
4421 }
Gilles Peskine7e928852018-06-04 16:23:10 +02004422 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg,
4423 iv, operation->iv_size );
Moran Peker41deec42018-04-04 15:43:05 +03004424 if( ret != 0 )
4425 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004426 status = mbedtls_to_psa_error( ret );
Gilles Peskinee553c652018-06-04 16:22:46 +02004427 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004428 }
Gilles Peskinee553c652018-06-04 16:22:46 +02004429
mohammad16038481e742018-03-18 13:57:31 +02004430 *iv_length = operation->iv_size;
itayzafrir534bd7c2018-08-02 13:56:32 +03004431 status = psa_cipher_set_iv( operation, iv, *iv_length );
Moran Peker41deec42018-04-04 15:43:05 +03004432
Moran Peker395db872018-05-31 14:07:14 +03004433exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02004434 if( status == PSA_SUCCESS )
4435 operation->iv_set = 1;
4436 else
Moran Peker395db872018-05-31 14:07:14 +03004437 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004438 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004439}
4440
Gilles Peskinefe119512018-07-08 21:39:34 +02004441psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004442 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02004443 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02004444{
itayzafrir534bd7c2018-08-02 13:56:32 +03004445 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00004446 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooreman7df02922020-09-09 15:28:49 +02004447 if( operation->iv_set || ! operation->iv_required )
4448 {
4449 return( PSA_ERROR_BAD_STATE );
4450 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004451
Steven Cooremanef8575e2020-09-11 11:44:50 +02004452 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004453 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004454 status = psa_driver_wrapper_cipher_set_iv( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004455 iv,
4456 iv_length );
4457 goto exit;
4458 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004459
Moran Pekera28258c2018-05-29 16:25:04 +03004460 if( iv_length != operation->iv_size )
Moran Peker71f19ae2018-04-22 20:23:16 +03004461 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004462 status = PSA_ERROR_INVALID_ARGUMENT;
4463 goto exit;
Moran Peker71f19ae2018-04-22 20:23:16 +03004464 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004465 ret = mbedtls_cipher_set_iv( &operation->ctx.cipher, iv, iv_length );
4466 status = mbedtls_to_psa_error( ret );
4467exit:
4468 if( status == PSA_SUCCESS )
4469 operation->iv_set = 1;
4470 else
mohammad1603503973b2018-03-12 15:59:30 +02004471 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004472 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004473}
4474
Steven Cooreman177deba2020-09-07 17:14:14 +02004475/* Process input for which the algorithm is set to ECB mode. This requires
4476 * manual processing, since the PSA API is defined as being able to process
4477 * arbitrary-length calls to psa_cipher_update() with ECB mode, but the
4478 * underlying mbedtls_cipher_update only takes full blocks. */
4479static psa_status_t psa_cipher_update_ecb_internal(
4480 mbedtls_cipher_context_t *ctx,
4481 const uint8_t *input,
4482 size_t input_length,
4483 uint8_t *output,
4484 size_t output_size,
4485 size_t *output_length )
4486{
4487 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4488 size_t block_size = ctx->cipher_info->block_size;
4489 size_t internal_output_length = 0;
4490 *output_length = 0;
4491
4492 if( input_length == 0 )
4493 {
4494 status = PSA_SUCCESS;
4495 goto exit;
4496 }
4497
4498 if( ctx->unprocessed_len > 0 )
4499 {
4500 /* Fill up to block size, and run the block if there's a full one. */
4501 size_t bytes_to_copy = block_size - ctx->unprocessed_len;
4502
4503 if( input_length < bytes_to_copy )
4504 bytes_to_copy = input_length;
4505
4506 memcpy( &( ctx->unprocessed_data[ctx->unprocessed_len] ),
4507 input, bytes_to_copy );
4508 input_length -= bytes_to_copy;
4509 input += bytes_to_copy;
4510 ctx->unprocessed_len += bytes_to_copy;
4511
4512 if( ctx->unprocessed_len == block_size )
4513 {
4514 status = mbedtls_to_psa_error(
4515 mbedtls_cipher_update( ctx,
4516 ctx->unprocessed_data,
4517 block_size,
4518 output, &internal_output_length ) );
4519
4520 if( status != PSA_SUCCESS )
4521 goto exit;
4522
4523 output += internal_output_length;
4524 output_size -= internal_output_length;
4525 *output_length += internal_output_length;
4526 ctx->unprocessed_len = 0;
4527 }
4528 }
4529
4530 while( input_length >= block_size )
4531 {
4532 /* Run all full blocks we have, one by one */
4533 status = mbedtls_to_psa_error(
4534 mbedtls_cipher_update( ctx, input,
4535 block_size,
4536 output, &internal_output_length ) );
4537
4538 if( status != PSA_SUCCESS )
4539 goto exit;
4540
4541 input_length -= block_size;
4542 input += block_size;
4543
4544 output += internal_output_length;
4545 output_size -= internal_output_length;
4546 *output_length += internal_output_length;
4547 }
4548
4549 if( input_length > 0 )
4550 {
4551 /* Save unprocessed bytes for later processing */
4552 memcpy( &( ctx->unprocessed_data[ctx->unprocessed_len] ),
4553 input, input_length );
4554 ctx->unprocessed_len += input_length;
4555 }
4556
4557 status = PSA_SUCCESS;
4558
4559exit:
4560 return( status );
4561}
4562
Gilles Peskinee553c652018-06-04 16:22:46 +02004563psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
4564 const uint8_t *input,
4565 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004566 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02004567 size_t output_size,
4568 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02004569{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004570 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine89d789c2018-06-04 17:17:16 +02004571 size_t expected_output_size;
Steven Cooreman7df02922020-09-09 15:28:49 +02004572 if( operation->alg == 0 )
4573 {
4574 return( PSA_ERROR_BAD_STATE );
4575 }
4576 if( operation->iv_required && ! operation->iv_set )
4577 {
4578 return( PSA_ERROR_BAD_STATE );
4579 }
Jaeden Ameroab439972019-02-15 14:12:05 +00004580
Steven Cooremanef8575e2020-09-11 11:44:50 +02004581 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004582 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004583 status = psa_driver_wrapper_cipher_update( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004584 input,
4585 input_length,
4586 output,
4587 output_size,
4588 output_length );
4589 goto exit;
4590 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004591
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004592 if( ! PSA_ALG_IS_STREAM_CIPHER( operation->alg ) )
Gilles Peskine89d789c2018-06-04 17:17:16 +02004593 {
4594 /* Take the unprocessed partial block left over from previous
4595 * update calls, if any, plus the input to this call. Remove
4596 * the last partial block, if any. You get the data that will be
4597 * output in this call. */
4598 expected_output_size =
4599 ( operation->ctx.cipher.unprocessed_len + input_length )
4600 / operation->block_size * operation->block_size;
4601 }
4602 else
4603 {
4604 expected_output_size = input_length;
4605 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004606
Gilles Peskine89d789c2018-06-04 17:17:16 +02004607 if( output_size < expected_output_size )
itayzafrir534bd7c2018-08-02 13:56:32 +03004608 {
4609 status = PSA_ERROR_BUFFER_TOO_SMALL;
4610 goto exit;
4611 }
mohammad160382759612018-03-12 18:16:40 +02004612
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004613 if( operation->alg == PSA_ALG_ECB_NO_PADDING )
4614 {
4615 /* mbedtls_cipher_update has an API inconsistency: it will only
4616 * process a single block at a time in ECB mode. Abstract away that
4617 * inconsistency here to match the PSA API behaviour. */
Steven Cooreman177deba2020-09-07 17:14:14 +02004618 status = psa_cipher_update_ecb_internal( &operation->ctx.cipher,
4619 input,
4620 input_length,
4621 output,
4622 output_size,
4623 output_length );
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004624 }
4625 else
4626 {
4627 status = mbedtls_to_psa_error(
4628 mbedtls_cipher_update( &operation->ctx.cipher, input,
4629 input_length, output, output_length ) );
4630 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004631exit:
4632 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02004633 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004634 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004635}
4636
Gilles Peskinee553c652018-06-04 16:22:46 +02004637psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
4638 uint8_t *output,
4639 size_t output_size,
4640 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02004641{
David Saadab4ecc272019-02-14 13:48:10 +02004642 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Gilles Peskinee553c652018-06-04 16:22:46 +02004643 uint8_t temp_output_buffer[MBEDTLS_MAX_BLOCK_LENGTH];
Steven Cooreman7df02922020-09-09 15:28:49 +02004644 if( operation->alg == 0 )
4645 {
4646 return( PSA_ERROR_BAD_STATE );
4647 }
4648 if( operation->iv_required && ! operation->iv_set )
4649 {
4650 return( PSA_ERROR_BAD_STATE );
4651 }
Moran Pekerbed71a22018-04-22 20:19:20 +03004652
Steven Cooremanef8575e2020-09-11 11:44:50 +02004653 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004654 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004655 status = psa_driver_wrapper_cipher_finish( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004656 output,
4657 output_size,
4658 output_length );
Steven Cooremanef8575e2020-09-11 11:44:50 +02004659 goto exit;
Steven Cooreman8b122252020-09-03 15:30:32 +02004660 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004661
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004662 if( operation->ctx.cipher.unprocessed_len != 0 )
Moran Peker7cb22b82018-06-05 11:40:02 +03004663 {
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004664 if( operation->alg == PSA_ALG_ECB_NO_PADDING ||
Fredrik Strupef90e3012020-09-28 16:11:33 +02004665 operation->alg == PSA_ALG_CBC_NO_PADDING )
Steven Cooremana6033e92020-08-25 11:47:50 +02004666 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004667 status = PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004668 goto exit;
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004669 }
Moran Pekerdc38ebc2018-04-30 15:45:34 +03004670 }
4671
Steven Cooremanef8575e2020-09-11 11:44:50 +02004672 status = mbedtls_to_psa_error(
4673 mbedtls_cipher_finish( &operation->ctx.cipher,
4674 temp_output_buffer,
4675 output_length ) );
4676 if( status != PSA_SUCCESS )
4677 goto exit;
Janos Follath315b51c2018-07-09 16:04:51 +01004678
Gilles Peskine46f1fd72018-06-28 19:31:31 +02004679 if( *output_length == 0 )
Janos Follath315b51c2018-07-09 16:04:51 +01004680 ; /* Nothing to copy. Note that output may be NULL in this case. */
Gilles Peskine46f1fd72018-06-28 19:31:31 +02004681 else if( output_size >= *output_length )
Moran Pekerdc38ebc2018-04-30 15:45:34 +03004682 memcpy( output, temp_output_buffer, *output_length );
4683 else
Janos Follath315b51c2018-07-09 16:04:51 +01004684 status = PSA_ERROR_BUFFER_TOO_SMALL;
mohammad1603503973b2018-03-12 15:59:30 +02004685
Steven Cooremanef8575e2020-09-11 11:44:50 +02004686exit:
4687 if( operation->mbedtls_in_use == 1 )
4688 mbedtls_platform_zeroize( temp_output_buffer, sizeof( temp_output_buffer ) );
Janos Follath315b51c2018-07-09 16:04:51 +01004689
Steven Cooremanef8575e2020-09-11 11:44:50 +02004690 if( status == PSA_SUCCESS )
4691 return( psa_cipher_abort( operation ) );
4692 else
4693 {
4694 *output_length = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004695 (void) psa_cipher_abort( operation );
Janos Follath315b51c2018-07-09 16:04:51 +01004696
Steven Cooremanef8575e2020-09-11 11:44:50 +02004697 return( status );
4698 }
mohammad1603503973b2018-03-12 15:59:30 +02004699}
4700
Gilles Peskinee553c652018-06-04 16:22:46 +02004701psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
4702{
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004703 if( operation->alg == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02004704 {
Steven Cooremana07b9972020-09-10 14:54:14 +02004705 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02004706 * in use. It's ok to call abort on such an object, and there's
4707 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004708 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02004709 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004710
Gilles Peskinef9c2c092018-06-21 16:57:07 +02004711 /* Sanity check (shouldn't happen: operation->alg should
4712 * always have been initialized to a valid value). */
4713 if( ! PSA_ALG_IS_CIPHER( operation->alg ) )
4714 return( PSA_ERROR_BAD_STATE );
4715
Steven Cooremanef8575e2020-09-11 11:44:50 +02004716 if( operation->mbedtls_in_use == 0 )
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004717 psa_driver_wrapper_cipher_abort( &operation->ctx.driver );
Steven Cooremand3feccd2020-09-01 15:56:14 +02004718 else
4719 mbedtls_cipher_free( &operation->ctx.cipher );
Gilles Peskinee553c652018-06-04 16:22:46 +02004720
Moran Peker41deec42018-04-04 15:43:05 +03004721 operation->alg = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004722 operation->key_set = 0;
4723 operation->iv_set = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004724 operation->mbedtls_in_use = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004725 operation->iv_size = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004726 operation->block_size = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004727 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004728
Moran Peker395db872018-05-31 14:07:14 +03004729 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02004730}
4731
Gilles Peskinea0655c32018-04-30 17:06:50 +02004732
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004733
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004734
mohammad16035955c982018-04-26 00:53:03 +03004735/****************************************************************/
4736/* AEAD */
4737/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004738
Gilles Peskineedf9a652018-08-17 18:11:56 +02004739typedef struct
4740{
Gilles Peskine2f060a82018-12-04 17:12:32 +01004741 psa_key_slot_t *slot;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004742 const mbedtls_cipher_info_t *cipher_info;
4743 union
4744 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02004745 unsigned dummy; /* Make the union non-empty even with no supported algorithms. */
Gilles Peskineedf9a652018-08-17 18:11:56 +02004746#if defined(MBEDTLS_CCM_C)
4747 mbedtls_ccm_context ccm;
4748#endif /* MBEDTLS_CCM_C */
4749#if defined(MBEDTLS_GCM_C)
4750 mbedtls_gcm_context gcm;
4751#endif /* MBEDTLS_GCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004752#if defined(MBEDTLS_CHACHAPOLY_C)
4753 mbedtls_chachapoly_context chachapoly;
4754#endif /* MBEDTLS_CHACHAPOLY_C */
Gilles Peskineedf9a652018-08-17 18:11:56 +02004755 } ctx;
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004756 psa_algorithm_t core_alg;
4757 uint8_t full_tag_length;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004758 uint8_t tag_length;
4759} aead_operation_t;
4760
Ronald Cronf95a2b12020-10-22 15:24:49 +02004761#define AEAD_OPERATION_INIT {0, 0, {0}, 0, 0, 0}
4762
Gilles Peskine30a9e412019-01-14 18:36:12 +01004763static void psa_aead_abort_internal( aead_operation_t *operation )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004764{
Gilles Peskinef8a8fe62018-08-21 16:38:05 +02004765 switch( operation->core_alg )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004766 {
4767#if defined(MBEDTLS_CCM_C)
4768 case PSA_ALG_CCM:
4769 mbedtls_ccm_free( &operation->ctx.ccm );
4770 break;
4771#endif /* MBEDTLS_CCM_C */
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004772#if defined(MBEDTLS_GCM_C)
Gilles Peskineedf9a652018-08-17 18:11:56 +02004773 case PSA_ALG_GCM:
4774 mbedtls_gcm_free( &operation->ctx.gcm );
4775 break;
4776#endif /* MBEDTLS_GCM_C */
4777 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004778
Ronald Cron5c522922020-11-14 16:35:34 +01004779 psa_unlock_key_slot( operation->slot );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004780}
4781
4782static psa_status_t psa_aead_setup( aead_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004783 mbedtls_svc_key_id_t key,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004784 psa_key_usage_t usage,
4785 psa_algorithm_t alg )
4786{
4787 psa_status_t status;
4788 size_t key_bits;
4789 mbedtls_cipher_id_t cipher_id;
4790
Ronald Cron5c522922020-11-14 16:35:34 +01004791 status = psa_get_and_lock_transparent_key_slot_with_policy(
4792 key, &operation->slot, usage, alg );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004793 if( status != PSA_SUCCESS )
4794 return( status );
4795
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02004796 key_bits = psa_get_key_slot_bits( operation->slot );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004797
4798 operation->cipher_info =
Gilles Peskine8e338702019-07-30 20:06:31 +02004799 mbedtls_cipher_info_from_psa( alg, operation->slot->attr.type, key_bits,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004800 &cipher_id );
4801 if( operation->cipher_info == NULL )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004802 {
4803 status = PSA_ERROR_NOT_SUPPORTED;
4804 goto cleanup;
4805 }
Gilles Peskineedf9a652018-08-17 18:11:56 +02004806
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004807 switch( PSA_ALG_AEAD_WITH_TAG_LENGTH( alg, 0 ) )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004808 {
4809#if defined(MBEDTLS_CCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004810 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CCM, 0 ):
4811 operation->core_alg = PSA_ALG_CCM;
4812 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004813 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.
4814 * The call to mbedtls_ccm_encrypt_and_tag or
4815 * mbedtls_ccm_auth_decrypt will validate the tag length. */
Gilles Peskine8e338702019-07-30 20:06:31 +02004816 if( PSA_BLOCK_CIPHER_BLOCK_SIZE( operation->slot->attr.type ) != 16 )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004817 {
4818 status = PSA_ERROR_INVALID_ARGUMENT;
4819 goto cleanup;
4820 }
Gilles Peskineedf9a652018-08-17 18:11:56 +02004821 mbedtls_ccm_init( &operation->ctx.ccm );
4822 status = mbedtls_to_psa_error(
4823 mbedtls_ccm_setkey( &operation->ctx.ccm, cipher_id,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004824 operation->slot->data.key.data,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004825 (unsigned int) key_bits ) );
4826 if( status != 0 )
4827 goto cleanup;
4828 break;
4829#endif /* MBEDTLS_CCM_C */
4830
4831#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004832 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_GCM, 0 ):
4833 operation->core_alg = PSA_ALG_GCM;
4834 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004835 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16.
4836 * The call to mbedtls_gcm_crypt_and_tag or
4837 * mbedtls_gcm_auth_decrypt will validate the tag length. */
Gilles Peskine8e338702019-07-30 20:06:31 +02004838 if( PSA_BLOCK_CIPHER_BLOCK_SIZE( operation->slot->attr.type ) != 16 )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004839 {
4840 status = PSA_ERROR_INVALID_ARGUMENT;
4841 goto cleanup;
4842 }
Gilles Peskineedf9a652018-08-17 18:11:56 +02004843 mbedtls_gcm_init( &operation->ctx.gcm );
4844 status = mbedtls_to_psa_error(
4845 mbedtls_gcm_setkey( &operation->ctx.gcm, cipher_id,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004846 operation->slot->data.key.data,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004847 (unsigned int) key_bits ) );
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004848 if( status != 0 )
4849 goto cleanup;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004850 break;
4851#endif /* MBEDTLS_GCM_C */
4852
Gilles Peskine26869f22019-05-06 15:25:00 +02004853#if defined(MBEDTLS_CHACHAPOLY_C)
4854 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CHACHA20_POLY1305, 0 ):
4855 operation->core_alg = PSA_ALG_CHACHA20_POLY1305;
4856 operation->full_tag_length = 16;
4857 /* We only support the default tag length. */
4858 if( alg != PSA_ALG_CHACHA20_POLY1305 )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004859 {
4860 status = PSA_ERROR_NOT_SUPPORTED;
4861 goto cleanup;
4862 }
Gilles Peskine26869f22019-05-06 15:25:00 +02004863 mbedtls_chachapoly_init( &operation->ctx.chachapoly );
4864 status = mbedtls_to_psa_error(
4865 mbedtls_chachapoly_setkey( &operation->ctx.chachapoly,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004866 operation->slot->data.key.data ) );
Gilles Peskine26869f22019-05-06 15:25:00 +02004867 if( status != 0 )
4868 goto cleanup;
4869 break;
4870#endif /* MBEDTLS_CHACHAPOLY_C */
4871
Gilles Peskineedf9a652018-08-17 18:11:56 +02004872 default:
Ronald Cronf95a2b12020-10-22 15:24:49 +02004873 status = PSA_ERROR_NOT_SUPPORTED;
4874 goto cleanup;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004875 }
4876
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004877 if( PSA_AEAD_TAG_LENGTH( alg ) > operation->full_tag_length )
4878 {
4879 status = PSA_ERROR_INVALID_ARGUMENT;
4880 goto cleanup;
4881 }
4882 operation->tag_length = PSA_AEAD_TAG_LENGTH( alg );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004883
Gilles Peskineedf9a652018-08-17 18:11:56 +02004884 return( PSA_SUCCESS );
4885
4886cleanup:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004887 psa_aead_abort_internal( operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004888 return( status );
4889}
4890
Ronald Croncf56a0a2020-08-04 09:51:30 +02004891psa_status_t psa_aead_encrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03004892 psa_algorithm_t alg,
4893 const uint8_t *nonce,
4894 size_t nonce_length,
4895 const uint8_t *additional_data,
4896 size_t additional_data_length,
4897 const uint8_t *plaintext,
4898 size_t plaintext_length,
4899 uint8_t *ciphertext,
4900 size_t ciphertext_size,
4901 size_t *ciphertext_length )
4902{
mohammad16035955c982018-04-26 00:53:03 +03004903 psa_status_t status;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004904 aead_operation_t operation = AEAD_OPERATION_INIT;
mohammad160315223a82018-06-03 17:19:55 +03004905 uint8_t *tag;
Gilles Peskine2d277862018-06-18 15:41:12 +02004906
mohammad1603f08a5502018-06-03 15:05:47 +03004907 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004908
Ronald Croncf56a0a2020-08-04 09:51:30 +02004909 status = psa_aead_setup( &operation, key, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004910 if( status != PSA_SUCCESS )
4911 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004912
Gilles Peskineedf9a652018-08-17 18:11:56 +02004913 /* For all currently supported modes, the tag is at the end of the
4914 * ciphertext. */
4915 if( ciphertext_size < ( plaintext_length + operation.tag_length ) )
4916 {
4917 status = PSA_ERROR_BUFFER_TOO_SMALL;
4918 goto exit;
4919 }
4920 tag = ciphertext + plaintext_length;
mohammad16035955c982018-04-26 00:53:03 +03004921
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004922#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004923 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03004924 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004925 status = mbedtls_to_psa_error(
4926 mbedtls_gcm_crypt_and_tag( &operation.ctx.gcm,
4927 MBEDTLS_GCM_ENCRYPT,
4928 plaintext_length,
4929 nonce, nonce_length,
4930 additional_data, additional_data_length,
4931 plaintext, ciphertext,
4932 operation.tag_length, tag ) );
mohammad16035955c982018-04-26 00:53:03 +03004933 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004934 else
4935#endif /* MBEDTLS_GCM_C */
4936#if defined(MBEDTLS_CCM_C)
4937 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03004938 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004939 status = mbedtls_to_psa_error(
4940 mbedtls_ccm_encrypt_and_tag( &operation.ctx.ccm,
4941 plaintext_length,
4942 nonce, nonce_length,
4943 additional_data,
4944 additional_data_length,
4945 plaintext, ciphertext,
4946 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03004947 }
mohammad16035c8845f2018-05-09 05:40:09 -07004948 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004949#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004950#if defined(MBEDTLS_CHACHAPOLY_C)
4951 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
4952 {
4953 if( nonce_length != 12 || operation.tag_length != 16 )
4954 {
4955 status = PSA_ERROR_NOT_SUPPORTED;
4956 goto exit;
4957 }
4958 status = mbedtls_to_psa_error(
4959 mbedtls_chachapoly_encrypt_and_tag( &operation.ctx.chachapoly,
4960 plaintext_length,
4961 nonce,
4962 additional_data,
4963 additional_data_length,
4964 plaintext,
4965 ciphertext,
4966 tag ) );
4967 }
4968 else
4969#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad16035c8845f2018-05-09 05:40:09 -07004970 {
mohammad1603554faad2018-06-03 15:07:38 +03004971 return( PSA_ERROR_NOT_SUPPORTED );
mohammad16035c8845f2018-05-09 05:40:09 -07004972 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004973
Gilles Peskineedf9a652018-08-17 18:11:56 +02004974 if( status != PSA_SUCCESS && ciphertext_size != 0 )
4975 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02004976
Gilles Peskineedf9a652018-08-17 18:11:56 +02004977exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004978 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004979 if( status == PSA_SUCCESS )
4980 *ciphertext_length = plaintext_length + operation.tag_length;
4981 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004982}
4983
Gilles Peskineee652a32018-06-01 19:23:52 +02004984/* Locate the tag in a ciphertext buffer containing the encrypted data
4985 * followed by the tag. Return the length of the part preceding the tag in
4986 * *plaintext_length. This is the size of the plaintext in modes where
4987 * the encrypted data has the same size as the plaintext, such as
4988 * CCM and GCM. */
4989static psa_status_t psa_aead_unpadded_locate_tag( size_t tag_length,
4990 const uint8_t *ciphertext,
4991 size_t ciphertext_length,
4992 size_t plaintext_size,
Gilles Peskineee652a32018-06-01 19:23:52 +02004993 const uint8_t **p_tag )
4994{
4995 size_t payload_length;
4996 if( tag_length > ciphertext_length )
4997 return( PSA_ERROR_INVALID_ARGUMENT );
4998 payload_length = ciphertext_length - tag_length;
4999 if( payload_length > plaintext_size )
5000 return( PSA_ERROR_BUFFER_TOO_SMALL );
5001 *p_tag = ciphertext + payload_length;
Gilles Peskineee652a32018-06-01 19:23:52 +02005002 return( PSA_SUCCESS );
5003}
5004
Ronald Croncf56a0a2020-08-04 09:51:30 +02005005psa_status_t psa_aead_decrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03005006 psa_algorithm_t alg,
5007 const uint8_t *nonce,
5008 size_t nonce_length,
5009 const uint8_t *additional_data,
5010 size_t additional_data_length,
5011 const uint8_t *ciphertext,
5012 size_t ciphertext_length,
5013 uint8_t *plaintext,
5014 size_t plaintext_size,
5015 size_t *plaintext_length )
5016{
mohammad16035955c982018-04-26 00:53:03 +03005017 psa_status_t status;
Ronald Cronf95a2b12020-10-22 15:24:49 +02005018 aead_operation_t operation = AEAD_OPERATION_INIT;
Gilles Peskineedf9a652018-08-17 18:11:56 +02005019 const uint8_t *tag = NULL;
Gilles Peskine2d277862018-06-18 15:41:12 +02005020
Gilles Peskineee652a32018-06-01 19:23:52 +02005021 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03005022
Ronald Croncf56a0a2020-08-04 09:51:30 +02005023 status = psa_aead_setup( &operation, key, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02005024 if( status != PSA_SUCCESS )
5025 return( status );
mohammad16035955c982018-04-26 00:53:03 +03005026
Gilles Peskinef7e7b012019-05-06 15:27:16 +02005027 status = psa_aead_unpadded_locate_tag( operation.tag_length,
5028 ciphertext, ciphertext_length,
5029 plaintext_size, &tag );
5030 if( status != PSA_SUCCESS )
5031 goto exit;
5032
Gilles Peskineb0b189f2018-11-28 17:30:58 +01005033#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02005034 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03005035 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02005036 status = mbedtls_to_psa_error(
5037 mbedtls_gcm_auth_decrypt( &operation.ctx.gcm,
5038 ciphertext_length - operation.tag_length,
5039 nonce, nonce_length,
5040 additional_data,
5041 additional_data_length,
5042 tag, operation.tag_length,
5043 ciphertext, plaintext ) );
mohammad16035955c982018-04-26 00:53:03 +03005044 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01005045 else
5046#endif /* MBEDTLS_GCM_C */
5047#if defined(MBEDTLS_CCM_C)
5048 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03005049 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02005050 status = mbedtls_to_psa_error(
5051 mbedtls_ccm_auth_decrypt( &operation.ctx.ccm,
5052 ciphertext_length - operation.tag_length,
5053 nonce, nonce_length,
5054 additional_data,
5055 additional_data_length,
5056 ciphertext, plaintext,
5057 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03005058 }
mohammad160339574652018-06-01 04:39:53 -07005059 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01005060#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02005061#if defined(MBEDTLS_CHACHAPOLY_C)
5062 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
5063 {
5064 if( nonce_length != 12 || operation.tag_length != 16 )
5065 {
5066 status = PSA_ERROR_NOT_SUPPORTED;
5067 goto exit;
5068 }
5069 status = mbedtls_to_psa_error(
5070 mbedtls_chachapoly_auth_decrypt( &operation.ctx.chachapoly,
5071 ciphertext_length - operation.tag_length,
5072 nonce,
5073 additional_data,
5074 additional_data_length,
5075 tag,
5076 ciphertext,
5077 plaintext ) );
5078 }
5079 else
5080#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad160339574652018-06-01 04:39:53 -07005081 {
mohammad1603554faad2018-06-03 15:07:38 +03005082 return( PSA_ERROR_NOT_SUPPORTED );
mohammad160339574652018-06-01 04:39:53 -07005083 }
Gilles Peskinea40d7742018-06-01 16:28:30 +02005084
Gilles Peskineedf9a652018-08-17 18:11:56 +02005085 if( status != PSA_SUCCESS && plaintext_size != 0 )
5086 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03005087
Gilles Peskineedf9a652018-08-17 18:11:56 +02005088exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01005089 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02005090 if( status == PSA_SUCCESS )
5091 *plaintext_length = ciphertext_length - operation.tag_length;
5092 return( status );
mohammad16035955c982018-04-26 00:53:03 +03005093}
5094
Gilles Peskinea0655c32018-04-30 17:06:50 +02005095
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02005096
Gilles Peskine20035e32018-02-03 22:44:14 +01005097/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02005098/* Generators */
5099/****************************************************************/
5100
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005101#define HKDF_STATE_INIT 0 /* no input yet */
5102#define HKDF_STATE_STARTED 1 /* got salt */
5103#define HKDF_STATE_KEYED 2 /* got key */
5104#define HKDF_STATE_OUTPUT 3 /* output started */
5105
Gilles Peskinecbe66502019-05-16 16:59:18 +02005106static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005107 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005108{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005109 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
5110 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005111 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005112 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005113}
5114
5115
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005116psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005117{
5118 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005119 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005120 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005121 {
5122 /* The object has (apparently) been initialized but it is not
5123 * in use. It's ok to call abort on such an object, and there's
5124 * nothing to do. */
5125 }
5126 else
Gilles Peskinebef7f142018-07-12 17:22:21 +02005127#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005128 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02005129 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005130 mbedtls_free( operation->ctx.hkdf.info );
5131 status = psa_hmac_abort_internal( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02005132 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01005133 else if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005134 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01005135 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005136 {
Janos Follath6a1d2622019-06-11 10:37:28 +01005137 if( operation->ctx.tls12_prf.seed != NULL )
5138 {
5139 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
5140 operation->ctx.tls12_prf.seed_length );
5141 mbedtls_free( operation->ctx.tls12_prf.seed );
5142 }
5143
5144 if( operation->ctx.tls12_prf.label != NULL )
5145 {
5146 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
5147 operation->ctx.tls12_prf.label_length );
5148 mbedtls_free( operation->ctx.tls12_prf.label );
5149 }
5150
5151 status = psa_hmac_abort_internal( &operation->ctx.tls12_prf.hmac );
5152
5153 /* We leave the fields Ai and output_block to be erased safely by the
5154 * mbedtls_platform_zeroize() in the end of this function. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005155 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005156 else
5157#endif /* MBEDTLS_MD_C */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005158 {
5159 status = PSA_ERROR_BAD_STATE;
5160 }
Janos Follath083036a2019-06-11 10:22:26 +01005161 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005162 return( status );
5163}
5164
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005165psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02005166 size_t *capacity)
5167{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005168 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005169 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005170 /* This is a blank key derivation operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02005171 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005172 }
5173
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005174 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005175 return( PSA_SUCCESS );
5176}
5177
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005178psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005179 size_t capacity )
5180{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005181 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005182 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005183 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005184 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005185 operation->capacity = capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005186 return( PSA_SUCCESS );
5187}
5188
Gilles Peskinebef7f142018-07-12 17:22:21 +02005189#if defined(MBEDTLS_MD_C)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005190/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02005191 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02005192static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskinebef7f142018-07-12 17:22:21 +02005193 psa_algorithm_t hash_alg,
5194 uint8_t *output,
5195 size_t output_length )
5196{
5197 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
5198 psa_status_t status;
5199
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005200 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
5201 return( PSA_ERROR_BAD_STATE );
5202 hkdf->state = HKDF_STATE_OUTPUT;
5203
Gilles Peskinebef7f142018-07-12 17:22:21 +02005204 while( output_length != 0 )
5205 {
5206 /* Copy what remains of the current block */
5207 uint8_t n = hash_length - hkdf->offset_in_block;
5208 if( n > output_length )
5209 n = (uint8_t) output_length;
5210 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
5211 output += n;
5212 output_length -= n;
5213 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02005214 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02005215 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02005216 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005217 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005218 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02005219 * object was corrupted or if this function is called directly
5220 * inside the library. */
5221 if( hkdf->block_number == 0xff )
5222 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02005223
5224 /* We need a new block */
5225 ++hkdf->block_number;
5226 hkdf->offset_in_block = 0;
5227 status = psa_hmac_setup_internal( &hkdf->hmac,
5228 hkdf->prk, hash_length,
5229 hash_alg );
5230 if( status != PSA_SUCCESS )
5231 return( status );
5232 if( hkdf->block_number != 1 )
5233 {
5234 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5235 hkdf->output_block,
5236 hash_length );
5237 if( status != PSA_SUCCESS )
5238 return( status );
5239 }
5240 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5241 hkdf->info,
5242 hkdf->info_length );
5243 if( status != PSA_SUCCESS )
5244 return( status );
5245 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5246 &hkdf->block_number, 1 );
5247 if( status != PSA_SUCCESS )
5248 return( status );
5249 status = psa_hmac_finish_internal( &hkdf->hmac,
5250 hkdf->output_block,
5251 sizeof( hkdf->output_block ) );
5252 if( status != PSA_SUCCESS )
5253 return( status );
5254 }
5255
5256 return( PSA_SUCCESS );
5257}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005258
Janos Follath7742fee2019-06-17 12:58:10 +01005259static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
5260 psa_tls12_prf_key_derivation_t *tls12_prf,
5261 psa_algorithm_t alg )
5262{
5263 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
5264 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
Janos Follathea29bfb2019-06-19 12:21:20 +01005265 psa_hash_operation_t backup = PSA_HASH_OPERATION_INIT;
5266 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005267
Janos Follath7742fee2019-06-17 12:58:10 +01005268 /* We can't be wanting more output after block 0xff, otherwise
5269 * the capacity check in psa_key_derivation_output_bytes() would have
5270 * prevented this call. It could happen only if the operation
5271 * object was corrupted or if this function is called directly
5272 * inside the library. */
5273 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01005274 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01005275
5276 /* We need a new block */
5277 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01005278 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01005279
5280 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
5281 *
5282 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
5283 *
5284 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
5285 * HMAC_hash(secret, A(2) + seed) +
5286 * HMAC_hash(secret, A(3) + seed) + ...
5287 *
5288 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01005289 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01005290 *
Janos Follathea29bfb2019-06-19 12:21:20 +01005291 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01005292 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01005293 * is currently extracted as `output_block` and where i is
5294 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01005295 */
5296
Janos Follathea29bfb2019-06-19 12:21:20 +01005297 /* Save the hash context before using it, to preserve the hash state with
5298 * only the inner padding in it. We need this, because inner padding depends
5299 * on the key (secret in the RFC's terminology). */
5300 status = psa_hash_clone( &tls12_prf->hmac.hash_ctx, &backup );
5301 if( status != PSA_SUCCESS )
5302 goto cleanup;
5303
5304 /* Calculate A(i) where i = tls12_prf->block_number. */
5305 if( tls12_prf->block_number == 1 )
5306 {
5307 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
5308 * the variable seed and in this instance means it in the context of the
5309 * P_hash function, where seed = label + seed.) */
5310 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5311 tls12_prf->label, tls12_prf->label_length );
5312 if( status != PSA_SUCCESS )
5313 goto cleanup;
5314 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5315 tls12_prf->seed, tls12_prf->seed_length );
5316 if( status != PSA_SUCCESS )
5317 goto cleanup;
5318 }
5319 else
5320 {
5321 /* A(i) = HMAC_hash(secret, A(i-1)) */
5322 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5323 tls12_prf->Ai, hash_length );
5324 if( status != PSA_SUCCESS )
5325 goto cleanup;
5326 }
5327
5328 status = psa_hmac_finish_internal( &tls12_prf->hmac,
5329 tls12_prf->Ai, hash_length );
5330 if( status != PSA_SUCCESS )
5331 goto cleanup;
5332 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
5333 if( status != PSA_SUCCESS )
5334 goto cleanup;
5335
5336 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
5337 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5338 tls12_prf->Ai, hash_length );
5339 if( status != PSA_SUCCESS )
5340 goto cleanup;
5341 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5342 tls12_prf->label, tls12_prf->label_length );
5343 if( status != PSA_SUCCESS )
5344 goto cleanup;
5345 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5346 tls12_prf->seed, tls12_prf->seed_length );
5347 if( status != PSA_SUCCESS )
5348 goto cleanup;
5349 status = psa_hmac_finish_internal( &tls12_prf->hmac,
5350 tls12_prf->output_block, hash_length );
5351 if( status != PSA_SUCCESS )
5352 goto cleanup;
5353 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
5354 if( status != PSA_SUCCESS )
5355 goto cleanup;
5356
Janos Follath7742fee2019-06-17 12:58:10 +01005357
5358cleanup:
5359
Janos Follathea29bfb2019-06-19 12:21:20 +01005360 cleanup_status = psa_hash_abort( &backup );
5361 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
5362 status = cleanup_status;
5363
5364 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01005365}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005366
Janos Follath844eb0e2019-06-19 12:10:49 +01005367static psa_status_t psa_key_derivation_tls12_prf_read(
5368 psa_tls12_prf_key_derivation_t *tls12_prf,
5369 psa_algorithm_t alg,
5370 uint8_t *output,
5371 size_t output_length )
5372{
5373 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
5374 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
5375 psa_status_t status;
5376 uint8_t offset, length;
5377
5378 while( output_length != 0 )
5379 {
5380 /* Check if we have fully processed the current block. */
5381 if( tls12_prf->left_in_block == 0 )
5382 {
5383 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
5384 alg );
5385 if( status != PSA_SUCCESS )
5386 return( status );
5387
5388 continue;
5389 }
5390
5391 if( tls12_prf->left_in_block > output_length )
5392 length = (uint8_t) output_length;
5393 else
5394 length = tls12_prf->left_in_block;
5395
5396 offset = hash_length - tls12_prf->left_in_block;
5397 memcpy( output, tls12_prf->output_block + offset, length );
5398 output += length;
5399 output_length -= length;
5400 tls12_prf->left_in_block -= length;
5401 }
5402
5403 return( PSA_SUCCESS );
5404}
Gilles Peskinebef7f142018-07-12 17:22:21 +02005405#endif /* MBEDTLS_MD_C */
5406
Janos Follath6c6c8fc2019-06-17 12:38:20 +01005407psa_status_t psa_key_derivation_output_bytes(
5408 psa_key_derivation_operation_t *operation,
5409 uint8_t *output,
5410 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005411{
5412 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005413 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005414
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005415 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005416 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005417 /* This is a blank operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02005418 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005419 }
5420
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005421 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005422 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005423 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005424 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005425 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02005426 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005427 goto exit;
5428 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005429 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005430 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005431 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005432 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02005433 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
5434 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005435 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02005436 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02005437 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005438 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005439 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005440
Gilles Peskinebef7f142018-07-12 17:22:21 +02005441#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005442 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02005443 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01005444 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005445 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02005446 output, output_length );
5447 }
Janos Follathadbec812019-06-14 11:05:39 +01005448 else
Janos Follathadbec812019-06-14 11:05:39 +01005449 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine969c5d62019-01-16 15:53:06 +01005450 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005451 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005452 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005453 kdf_alg, output,
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005454 output_length );
5455 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005456 else
5457#endif /* MBEDTLS_MD_C */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005458 {
5459 return( PSA_ERROR_BAD_STATE );
5460 }
5461
5462exit:
5463 if( status != PSA_SUCCESS )
5464 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005465 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005466 * This allows us to differentiate between exhausted operations and
5467 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
5468 * operations. */
5469 psa_algorithm_t alg = operation->alg;
5470 psa_key_derivation_abort( operation );
5471 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005472 memset( output, '!', output_length );
5473 }
5474 return( status );
5475}
5476
Gilles Peskine08542d82018-07-19 17:05:42 +02005477#if defined(MBEDTLS_DES_C)
5478static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
5479{
5480 if( data_size >= 8 )
5481 mbedtls_des_key_set_parity( data );
5482 if( data_size >= 16 )
5483 mbedtls_des_key_set_parity( data + 8 );
5484 if( data_size >= 24 )
5485 mbedtls_des_key_set_parity( data + 16 );
5486}
5487#endif /* MBEDTLS_DES_C */
5488
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005489static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005490 psa_key_slot_t *slot,
5491 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005492 psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005493{
5494 uint8_t *data = NULL;
5495 size_t bytes = PSA_BITS_TO_BYTES( bits );
5496 psa_status_t status;
5497
Gilles Peskine8e338702019-07-30 20:06:31 +02005498 if( ! key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005499 return( PSA_ERROR_INVALID_ARGUMENT );
5500 if( bits % 8 != 0 )
5501 return( PSA_ERROR_INVALID_ARGUMENT );
5502 data = mbedtls_calloc( 1, bytes );
5503 if( data == NULL )
5504 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5505
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005506 status = psa_key_derivation_output_bytes( operation, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005507 if( status != PSA_SUCCESS )
5508 goto exit;
Gilles Peskine08542d82018-07-19 17:05:42 +02005509#if defined(MBEDTLS_DES_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02005510 if( slot->attr.type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02005511 psa_des_set_key_parity( data, bytes );
5512#endif /* MBEDTLS_DES_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005513 status = psa_import_key_into_slot( slot, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005514
5515exit:
5516 mbedtls_free( data );
5517 return( status );
5518}
5519
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005520psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005521 psa_key_derivation_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005522 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005523{
5524 psa_status_t status;
5525 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005526 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02005527
Ronald Cron81709fc2020-11-14 12:10:32 +01005528 *key = MBEDTLS_SVC_KEY_ID_INIT;
5529
Gilles Peskine0f84d622019-09-12 19:03:13 +02005530 /* Reject any attempt to create a zero-length key so that we don't
5531 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
5532 if( psa_get_key_bits( attributes ) == 0 )
5533 return( PSA_ERROR_INVALID_ARGUMENT );
5534
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005535 if( ! operation->can_output_key )
5536 return( PSA_ERROR_NOT_PERMITTED );
5537
Ronald Cron81709fc2020-11-14 12:10:32 +01005538 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE, attributes,
5539 &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02005540#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
5541 if( driver != NULL )
5542 {
5543 /* Deriving a key in a secure element is not implemented yet. */
5544 status = PSA_ERROR_NOT_SUPPORTED;
5545 }
5546#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005547 if( status == PSA_SUCCESS )
5548 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005549 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02005550 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005551 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005552 }
5553 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01005554 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005555 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02005556 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005557
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005558 return( status );
5559}
5560
Gilles Peskineeab56e42018-07-12 17:12:33 +02005561
5562
5563/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02005564/* Key derivation */
5565/****************************************************************/
5566
Gilles Peskine969c5d62019-01-16 15:53:06 +01005567static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005568 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005569 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005570{
Janos Follath5fe19732019-06-20 15:09:30 +01005571 /* Make sure that operation->ctx is properly zero-initialised. (Macro
5572 * initialisers for this union leave some bytes unspecified.) */
5573 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
5574
Gilles Peskine969c5d62019-01-16 15:53:06 +01005575 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005576#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005577 if( PSA_ALG_IS_HKDF( kdf_alg ) ||
5578 PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
5579 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005580 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01005581 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005582 size_t hash_size = PSA_HASH_SIZE( hash_alg );
5583 if( hash_size == 0 )
5584 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005585 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
5586 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02005587 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005588 {
5589 return( PSA_ERROR_NOT_SUPPORTED );
5590 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005591 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01005592 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005593 }
5594#endif /* MBEDTLS_MD_C */
Gilles Peskine969c5d62019-01-16 15:53:06 +01005595 else
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005596 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005597}
5598
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005599psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005600 psa_algorithm_t alg )
5601{
5602 psa_status_t status;
5603
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005604 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005605 return( PSA_ERROR_BAD_STATE );
5606
Gilles Peskine6843c292019-01-18 16:44:49 +01005607 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
5608 return( PSA_ERROR_INVALID_ARGUMENT );
5609 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005610 {
5611 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005612 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005613 }
5614 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
5615 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005616 status = psa_key_derivation_setup_kdf( operation, alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005617 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005618 else
5619 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005620
5621 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005622 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01005623 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005624}
5625
5626#if defined(MBEDTLS_MD_C)
Gilles Peskinecbe66502019-05-16 16:59:18 +02005627static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005628 psa_algorithm_t hash_alg,
5629 psa_key_derivation_step_t step,
5630 const uint8_t *data,
5631 size_t data_length )
5632{
5633 psa_status_t status;
5634 switch( step )
5635 {
Gilles Peskine03410b52019-05-16 16:05:19 +02005636 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02005637 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005638 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005639 status = psa_hmac_setup_internal( &hkdf->hmac,
5640 data, data_length,
5641 hash_alg );
5642 if( status != PSA_SUCCESS )
5643 return( status );
5644 hkdf->state = HKDF_STATE_STARTED;
5645 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02005646 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005647 /* If no salt was provided, use an empty salt. */
5648 if( hkdf->state == HKDF_STATE_INIT )
5649 {
5650 status = psa_hmac_setup_internal( &hkdf->hmac,
5651 NULL, 0,
Gilles Peskinef9ee6332019-04-11 21:22:52 +02005652 hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005653 if( status != PSA_SUCCESS )
5654 return( status );
5655 hkdf->state = HKDF_STATE_STARTED;
5656 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02005657 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005658 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005659 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5660 data, data_length );
5661 if( status != PSA_SUCCESS )
5662 return( status );
5663 status = psa_hmac_finish_internal( &hkdf->hmac,
5664 hkdf->prk,
5665 sizeof( hkdf->prk ) );
5666 if( status != PSA_SUCCESS )
5667 return( status );
5668 hkdf->offset_in_block = PSA_HASH_SIZE( hash_alg );
5669 hkdf->block_number = 0;
5670 hkdf->state = HKDF_STATE_KEYED;
5671 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02005672 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005673 if( hkdf->state == HKDF_STATE_OUTPUT )
5674 return( PSA_ERROR_BAD_STATE );
5675 if( hkdf->info_set )
5676 return( PSA_ERROR_BAD_STATE );
5677 hkdf->info_length = data_length;
5678 if( data_length != 0 )
5679 {
5680 hkdf->info = mbedtls_calloc( 1, data_length );
5681 if( hkdf->info == NULL )
5682 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5683 memcpy( hkdf->info, data, data_length );
5684 }
5685 hkdf->info_set = 1;
5686 return( PSA_SUCCESS );
5687 default:
5688 return( PSA_ERROR_INVALID_ARGUMENT );
5689 }
5690}
Janos Follathb03233e2019-06-11 15:30:30 +01005691
Janos Follathf08e2652019-06-13 09:05:41 +01005692static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
5693 const uint8_t *data,
5694 size_t data_length )
5695{
5696 if( prf->state != TLS12_PRF_STATE_INIT )
5697 return( PSA_ERROR_BAD_STATE );
5698
Janos Follathd6dce9f2019-07-04 09:11:38 +01005699 if( data_length != 0 )
5700 {
5701 prf->seed = mbedtls_calloc( 1, data_length );
5702 if( prf->seed == NULL )
5703 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01005704
Janos Follathd6dce9f2019-07-04 09:11:38 +01005705 memcpy( prf->seed, data, data_length );
5706 prf->seed_length = data_length;
5707 }
Janos Follathf08e2652019-06-13 09:05:41 +01005708
5709 prf->state = TLS12_PRF_STATE_SEED_SET;
5710
5711 return( PSA_SUCCESS );
5712}
5713
Janos Follath81550542019-06-13 14:26:34 +01005714static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
5715 psa_algorithm_t hash_alg,
5716 const uint8_t *data,
5717 size_t data_length )
5718{
5719 psa_status_t status;
5720 if( prf->state != TLS12_PRF_STATE_SEED_SET )
5721 return( PSA_ERROR_BAD_STATE );
5722
5723 status = psa_hmac_setup_internal( &prf->hmac, data, data_length, hash_alg );
5724 if( status != PSA_SUCCESS )
5725 return( status );
5726
5727 prf->state = TLS12_PRF_STATE_KEY_SET;
5728
5729 return( PSA_SUCCESS );
5730}
5731
Janos Follath6660f0e2019-06-17 08:44:03 +01005732static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
5733 psa_tls12_prf_key_derivation_t *prf,
5734 psa_algorithm_t hash_alg,
5735 const uint8_t *data,
5736 size_t data_length )
5737{
5738 psa_status_t status;
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02005739 uint8_t pms[ 4 + 2 * PSA_ALG_TLS12_PSK_TO_MS_MAX_PSK_LEN ];
5740 uint8_t *cur = pms;
Janos Follath6660f0e2019-06-17 08:44:03 +01005741
5742 if( data_length > PSA_ALG_TLS12_PSK_TO_MS_MAX_PSK_LEN )
5743 return( PSA_ERROR_INVALID_ARGUMENT );
5744
5745 /* Quoting RFC 4279, Section 2:
5746 *
5747 * The premaster secret is formed as follows: if the PSK is N octets
5748 * long, concatenate a uint16 with the value N, N zero octets, a second
5749 * uint16 with the value N, and the PSK itself.
5750 */
5751
Janos Follath40e13932019-06-26 13:22:29 +01005752 *cur++ = ( data_length >> 8 ) & 0xff;
5753 *cur++ = ( data_length >> 0 ) & 0xff;
5754 memset( cur, 0, data_length );
5755 cur += data_length;
5756 *cur++ = pms[0];
5757 *cur++ = pms[1];
5758 memcpy( cur, data, data_length );
5759 cur += data_length;
Janos Follath6660f0e2019-06-17 08:44:03 +01005760
Janos Follath40e13932019-06-26 13:22:29 +01005761 status = psa_tls12_prf_set_key( prf, hash_alg, pms, cur - pms );
Janos Follath6660f0e2019-06-17 08:44:03 +01005762
5763 mbedtls_platform_zeroize( pms, sizeof( pms ) );
5764 return( status );
5765}
5766
Janos Follath63028dd2019-06-13 09:15:47 +01005767static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
5768 const uint8_t *data,
5769 size_t data_length )
5770{
5771 if( prf->state != TLS12_PRF_STATE_KEY_SET )
5772 return( PSA_ERROR_BAD_STATE );
5773
Janos Follathd6dce9f2019-07-04 09:11:38 +01005774 if( data_length != 0 )
5775 {
5776 prf->label = mbedtls_calloc( 1, data_length );
5777 if( prf->label == NULL )
5778 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01005779
Janos Follathd6dce9f2019-07-04 09:11:38 +01005780 memcpy( prf->label, data, data_length );
5781 prf->label_length = data_length;
5782 }
Janos Follath63028dd2019-06-13 09:15:47 +01005783
5784 prf->state = TLS12_PRF_STATE_LABEL_SET;
5785
5786 return( PSA_SUCCESS );
5787}
5788
Janos Follathb03233e2019-06-11 15:30:30 +01005789static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
5790 psa_algorithm_t hash_alg,
5791 psa_key_derivation_step_t step,
5792 const uint8_t *data,
5793 size_t data_length )
5794{
Janos Follathb03233e2019-06-11 15:30:30 +01005795 switch( step )
5796 {
Janos Follathf08e2652019-06-13 09:05:41 +01005797 case PSA_KEY_DERIVATION_INPUT_SEED:
5798 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01005799 case PSA_KEY_DERIVATION_INPUT_SECRET:
5800 return( psa_tls12_prf_set_key( prf, hash_alg, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01005801 case PSA_KEY_DERIVATION_INPUT_LABEL:
5802 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01005803 default:
5804 return( PSA_ERROR_INVALID_ARGUMENT );
5805 }
5806}
Janos Follath6660f0e2019-06-17 08:44:03 +01005807
5808static psa_status_t psa_tls12_prf_psk_to_ms_input(
5809 psa_tls12_prf_key_derivation_t *prf,
5810 psa_algorithm_t hash_alg,
5811 psa_key_derivation_step_t step,
5812 const uint8_t *data,
5813 size_t data_length )
5814{
5815 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01005816 {
Janos Follath6660f0e2019-06-17 08:44:03 +01005817 return( psa_tls12_prf_psk_to_ms_set_key( prf, hash_alg,
5818 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01005819 }
Janos Follath6660f0e2019-06-17 08:44:03 +01005820
5821 return( psa_tls12_prf_input( prf, hash_alg, step, data, data_length ) );
5822}
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005823#endif /* MBEDTLS_MD_C */
5824
Gilles Peskineb8965192019-09-24 16:21:10 +02005825/** Check whether the given key type is acceptable for the given
5826 * input step of a key derivation.
5827 *
5828 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
5829 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
5830 * Both secret and non-secret inputs can alternatively have the type
5831 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
5832 * that the input was passed as a buffer rather than via a key object.
5833 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02005834static int psa_key_derivation_check_input_type(
5835 psa_key_derivation_step_t step,
5836 psa_key_type_t key_type )
5837{
5838 switch( step )
5839 {
5840 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb8965192019-09-24 16:21:10 +02005841 if( key_type == PSA_KEY_TYPE_DERIVE )
5842 return( PSA_SUCCESS );
5843 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005844 return( PSA_SUCCESS );
5845 break;
5846 case PSA_KEY_DERIVATION_INPUT_LABEL:
5847 case PSA_KEY_DERIVATION_INPUT_SALT:
5848 case PSA_KEY_DERIVATION_INPUT_INFO:
5849 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskineb8965192019-09-24 16:21:10 +02005850 if( key_type == PSA_KEY_TYPE_RAW_DATA )
5851 return( PSA_SUCCESS );
5852 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005853 return( PSA_SUCCESS );
5854 break;
5855 }
5856 return( PSA_ERROR_INVALID_ARGUMENT );
5857}
5858
Janos Follathb80a94e2019-06-12 15:54:46 +01005859static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005860 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005861 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005862 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005863 const uint8_t *data,
5864 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005865{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02005866 psa_status_t status;
5867 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
5868
5869 status = psa_key_derivation_check_input_type( step, key_type );
Gilles Peskine224b0d62019-09-23 18:13:17 +02005870 if( status != PSA_SUCCESS )
5871 goto exit;
5872
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005873#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005874 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005875 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005876 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005877 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005878 step, data, data_length );
5879 }
k-stachowiak012dcc42019-08-13 14:55:03 +02005880 else if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005881 {
Janos Follathb03233e2019-06-11 15:30:30 +01005882 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
5883 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5884 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01005885 }
5886 else if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
5887 {
5888 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
5889 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5890 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005891 }
5892 else
5893#endif /* MBEDTLS_MD_C */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005894 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005895 /* This can't happen unless the operation object was not initialized */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005896 return( PSA_ERROR_BAD_STATE );
5897 }
5898
Gilles Peskine224b0d62019-09-23 18:13:17 +02005899exit:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005900 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005901 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005902 return( status );
5903}
5904
Janos Follath51f4a0f2019-06-14 11:35:55 +01005905psa_status_t psa_key_derivation_input_bytes(
5906 psa_key_derivation_operation_t *operation,
5907 psa_key_derivation_step_t step,
5908 const uint8_t *data,
5909 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005910{
Gilles Peskineb8965192019-09-24 16:21:10 +02005911 return( psa_key_derivation_input_internal( operation, step,
5912 PSA_KEY_TYPE_NONE,
Janos Follathc5621512019-06-14 11:27:57 +01005913 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005914}
5915
Janos Follath51f4a0f2019-06-14 11:35:55 +01005916psa_status_t psa_key_derivation_input_key(
5917 psa_key_derivation_operation_t *operation,
5918 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005919 mbedtls_svc_key_id_t key )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005920{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005921 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005922 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005923 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005924
Ronald Cron5c522922020-11-14 16:35:34 +01005925 status = psa_get_and_lock_transparent_key_slot_with_policy(
5926 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005927 if( status != PSA_SUCCESS )
Gilles Peskine593773d2019-09-23 18:17:40 +02005928 {
5929 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005930 return( status );
Gilles Peskine593773d2019-09-23 18:17:40 +02005931 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005932
5933 /* Passing a key object as a SECRET input unlocks the permission
5934 * to output to a key object. */
5935 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5936 operation->can_output_key = 1;
5937
Ronald Cronf95a2b12020-10-22 15:24:49 +02005938 status = psa_key_derivation_input_internal( operation,
5939 step, slot->attr.type,
5940 slot->data.key.data,
5941 slot->data.key.bytes );
5942
Ronald Cron5c522922020-11-14 16:35:34 +01005943 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005944
Ronald Cron5c522922020-11-14 16:35:34 +01005945 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005946}
Gilles Peskineea0fb492018-07-12 17:17:20 +02005947
5948
5949
5950/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02005951/* Key agreement */
5952/****************************************************************/
5953
Gilles Peskinea05219c2018-11-16 16:02:56 +01005954#if defined(MBEDTLS_ECDH_C)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005955static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
5956 size_t peer_key_length,
5957 const mbedtls_ecp_keypair *our_key,
5958 uint8_t *shared_secret,
5959 size_t shared_secret_size,
5960 size_t *shared_secret_length )
5961{
Steven Cooremand4867872020-08-05 16:31:39 +02005962 mbedtls_ecp_keypair *their_key = NULL;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005963 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00005964 psa_status_t status;
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005965 size_t bits = 0;
Paul Elliott8ff510a2020-06-02 17:19:28 +01005966 psa_ecc_family_t curve = mbedtls_ecc_group_to_psa( our_key->grp.id, &bits );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005967 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005968
Steven Cooreman4fed4552020-08-03 14:46:03 +02005969 status = psa_load_ecp_representation( PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve),
5970 peer_key,
Steven Cooreman7f391872020-07-30 14:57:44 +02005971 peer_key_length,
Steven Cooreman7f391872020-07-30 14:57:44 +02005972 &their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00005973 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005974 goto exit;
5975
Jaeden Amero97271b32019-01-10 19:38:51 +00005976 status = mbedtls_to_psa_error(
Steven Cooremana2371e52020-07-28 14:30:39 +02005977 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
Jaeden Amero97271b32019-01-10 19:38:51 +00005978 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005979 goto exit;
Jaeden Amero97271b32019-01-10 19:38:51 +00005980 status = mbedtls_to_psa_error(
5981 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
5982 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005983 goto exit;
5984
Jaeden Amero97271b32019-01-10 19:38:51 +00005985 status = mbedtls_to_psa_error(
5986 mbedtls_ecdh_calc_secret( &ecdh,
5987 shared_secret_length,
5988 shared_secret, shared_secret_size,
5989 mbedtls_ctr_drbg_random,
5990 &global_data.ctr_drbg ) );
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005991 if( status != PSA_SUCCESS )
5992 goto exit;
5993 if( PSA_BITS_TO_BYTES( bits ) != *shared_secret_length )
5994 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005995
5996exit:
Gilles Peskine3e819b72019-12-20 14:09:55 +01005997 if( status != PSA_SUCCESS )
5998 mbedtls_platform_zeroize( shared_secret, shared_secret_size );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005999 mbedtls_ecdh_free( &ecdh );
Steven Cooremana2371e52020-07-28 14:30:39 +02006000 mbedtls_ecp_keypair_free( their_key );
Steven Cooreman6d839f02020-07-30 11:36:45 +02006001 mbedtls_free( their_key );
Steven Cooremana2371e52020-07-28 14:30:39 +02006002
Jaeden Amero97271b32019-01-10 19:38:51 +00006003 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006004}
Gilles Peskinea05219c2018-11-16 16:02:56 +01006005#endif /* MBEDTLS_ECDH_C */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006006
Gilles Peskine01d718c2018-09-18 12:01:02 +02006007#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
6008
Gilles Peskine0216fe12019-04-11 21:23:21 +02006009static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
6010 psa_key_slot_t *private_key,
6011 const uint8_t *peer_key,
6012 size_t peer_key_length,
6013 uint8_t *shared_secret,
6014 size_t shared_secret_size,
6015 size_t *shared_secret_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02006016{
Gilles Peskine0216fe12019-04-11 21:23:21 +02006017 switch( alg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02006018 {
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006019#if defined(MBEDTLS_ECDH_C)
Gilles Peskine0216fe12019-04-11 21:23:21 +02006020 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02006021 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006022 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremana2371e52020-07-28 14:30:39 +02006023 mbedtls_ecp_keypair *ecp = NULL;
Steven Cooreman7f391872020-07-30 14:57:44 +02006024 psa_status_t status = psa_load_ecp_representation(
Steven Cooreman4fed4552020-08-03 14:46:03 +02006025 private_key->attr.type,
Steven Cooreman7f391872020-07-30 14:57:44 +02006026 private_key->data.key.data,
6027 private_key->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02006028 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02006029 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02006030 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02006031 status = psa_key_agreement_ecdh( peer_key, peer_key_length,
Steven Cooremana2371e52020-07-28 14:30:39 +02006032 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02006033 shared_secret, shared_secret_size,
6034 shared_secret_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02006035 mbedtls_ecp_keypair_free( ecp );
6036 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02006037 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006038#endif /* MBEDTLS_ECDH_C */
Gilles Peskine01d718c2018-09-18 12:01:02 +02006039 default:
Gilles Peskine93f85002018-11-16 16:43:31 +01006040 (void) private_key;
6041 (void) peer_key;
6042 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02006043 (void) shared_secret;
6044 (void) shared_secret_size;
6045 (void) shared_secret_length;
Gilles Peskine01d718c2018-09-18 12:01:02 +02006046 return( PSA_ERROR_NOT_SUPPORTED );
6047 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02006048}
6049
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02006050/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02006051 * to potentially free embedded data structures and wipe confidential data.
6052 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006053static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01006054 psa_key_derivation_step_t step,
Gilles Peskine01d718c2018-09-18 12:01:02 +02006055 psa_key_slot_t *private_key,
6056 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01006057 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02006058{
6059 psa_status_t status;
6060 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
6061 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006062 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02006063
6064 /* Step 1: run the secret agreement algorithm to generate the shared
6065 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02006066 status = psa_key_agreement_raw_internal( ka_alg,
6067 private_key,
6068 peer_key, peer_key_length,
itayzafrir0adf0fc2018-09-06 16:24:41 +03006069 shared_secret,
6070 sizeof( shared_secret ),
Gilles Peskine05d69892018-06-19 22:00:52 +02006071 &shared_secret_length );
Gilles Peskine53d991e2018-07-12 01:14:59 +02006072 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02006073 goto exit;
6074
Gilles Peskineb0b255c2018-07-06 17:01:38 +02006075 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02006076 * the shared secret. A shared secret is permitted wherever a key
6077 * of type DERIVE is permitted. */
Janos Follathb80a94e2019-06-12 15:54:46 +01006078 status = psa_key_derivation_input_internal( operation, step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02006079 PSA_KEY_TYPE_DERIVE,
Janos Follathb80a94e2019-06-12 15:54:46 +01006080 shared_secret,
6081 shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02006082exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01006083 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02006084 return( status );
6085}
6086
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006087psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02006088 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02006089 mbedtls_svc_key_id_t private_key,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02006090 const uint8_t *peer_key,
6091 size_t peer_key_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +02006092{
Ronald Cronf95a2b12020-10-22 15:24:49 +02006093 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01006094 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01006095 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02006096
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006097 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02006098 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Cron5c522922020-11-14 16:35:34 +01006099 status = psa_get_and_lock_transparent_key_slot_with_policy(
6100 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine12313cd2018-06-20 00:20:32 +02006101 if( status != PSA_SUCCESS )
6102 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006103 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01006104 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01006105 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01006106 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006107 psa_key_derivation_abort( operation );
Steven Cooremanfa5e6312020-10-15 17:07:12 +02006108 else
6109 {
6110 /* If a private key has been added as SECRET, we allow the derived
6111 * key material to be used as a key in PSA Crypto. */
6112 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
6113 operation->can_output_key = 1;
6114 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02006115
Ronald Cron5c522922020-11-14 16:35:34 +01006116 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02006117
Ronald Cron5c522922020-11-14 16:35:34 +01006118 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineaf3baab2018-06-27 22:55:52 +02006119}
6120
Gilles Peskinebe697d82019-05-16 18:00:41 +02006121psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
Ronald Croncf56a0a2020-08-04 09:51:30 +02006122 mbedtls_svc_key_id_t private_key,
Gilles Peskinebe697d82019-05-16 18:00:41 +02006123 const uint8_t *peer_key,
6124 size_t peer_key_length,
6125 uint8_t *output,
6126 size_t output_size,
6127 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02006128{
Ronald Cronf95a2b12020-10-22 15:24:49 +02006129 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01006130 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02006131 psa_key_slot_t *slot = NULL;
Gilles Peskine0216fe12019-04-11 21:23:21 +02006132
6133 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
6134 {
6135 status = PSA_ERROR_INVALID_ARGUMENT;
6136 goto exit;
6137 }
Ronald Cron5c522922020-11-14 16:35:34 +01006138 status = psa_get_and_lock_transparent_key_slot_with_policy(
6139 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02006140 if( status != PSA_SUCCESS )
6141 goto exit;
6142
6143 status = psa_key_agreement_raw_internal( alg, slot,
6144 peer_key, peer_key_length,
6145 output, output_size,
6146 output_length );
6147
6148exit:
6149 if( status != PSA_SUCCESS )
6150 {
6151 /* If an error happens and is not handled properly, the output
6152 * may be used as a key to protect sensitive data. Arrange for such
6153 * a key to be random, which is likely to result in decryption or
6154 * verification errors. This is better than filling the buffer with
6155 * some constant data such as zeros, which would result in the data
6156 * being protected with a reproducible, easily knowable key.
6157 */
6158 psa_generate_random( output, output_size );
6159 *output_length = output_size;
6160 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02006161
Ronald Cron5c522922020-11-14 16:35:34 +01006162 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02006163
Ronald Cron5c522922020-11-14 16:35:34 +01006164 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine0216fe12019-04-11 21:23:21 +02006165}
Gilles Peskine86a440b2018-11-12 18:39:40 +01006166
6167
6168/****************************************************************/
6169/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02006170/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02006171
Gilles Peskine4c317f42018-07-12 01:24:09 +02006172psa_status_t psa_generate_random( uint8_t *output,
Gilles Peskine53d991e2018-07-12 01:14:59 +02006173 size_t output_size )
Gilles Peskine12313cd2018-06-20 00:20:32 +02006174{
Janos Follath24eed8d2019-11-22 13:21:35 +00006175 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006176 GUARD_MODULE_INITIALIZED;
6177
Gilles Peskinef181eca2019-08-07 13:49:00 +02006178 while( output_size > MBEDTLS_CTR_DRBG_MAX_REQUEST )
6179 {
6180 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg,
6181 output,
6182 MBEDTLS_CTR_DRBG_MAX_REQUEST );
6183 if( ret != 0 )
6184 return( mbedtls_to_psa_error( ret ) );
6185 output += MBEDTLS_CTR_DRBG_MAX_REQUEST;
6186 output_size -= MBEDTLS_CTR_DRBG_MAX_REQUEST;
6187 }
6188
Gilles Peskinee59236f2018-01-27 23:32:46 +01006189 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg, output, output_size );
6190 return( mbedtls_to_psa_error( ret ) );
6191}
6192
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01006193#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
6194#include "mbedtls/entropy_poll.h"
6195
Gilles Peskine7228da22019-07-15 11:06:15 +02006196psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006197 size_t seed_size )
6198{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006199 if( global_data.initialized )
6200 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02006201
6202 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
6203 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
6204 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
6205 return( PSA_ERROR_INVALID_ARGUMENT );
6206
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01006207 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006208}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01006209#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006210
Gilles Peskinee56e8782019-04-26 17:34:02 +02006211#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_GENPRIME)
6212static psa_status_t psa_read_rsa_exponent( const uint8_t *domain_parameters,
6213 size_t domain_parameters_size,
6214 int *exponent )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006215{
Gilles Peskinee56e8782019-04-26 17:34:02 +02006216 size_t i;
6217 uint32_t acc = 0;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006218
Gilles Peskinee56e8782019-04-26 17:34:02 +02006219 if( domain_parameters_size == 0 )
6220 {
6221 *exponent = 65537;
6222 return( PSA_SUCCESS );
6223 }
6224
6225 /* Mbed TLS encodes the public exponent as an int. For simplicity, only
6226 * support values that fit in a 32-bit integer, which is larger than
6227 * int on just about every platform anyway. */
6228 if( domain_parameters_size > sizeof( acc ) )
6229 return( PSA_ERROR_NOT_SUPPORTED );
6230 for( i = 0; i < domain_parameters_size; i++ )
6231 acc = ( acc << 8 ) | domain_parameters[i];
6232 if( acc > INT_MAX )
6233 return( PSA_ERROR_NOT_SUPPORTED );
6234 *exponent = acc;
6235 return( PSA_SUCCESS );
6236}
6237#endif /* MBEDTLS_RSA_C && MBEDTLS_GENPRIME */
6238
Gilles Peskine35ef36b2019-05-16 19:42:05 +02006239static psa_status_t psa_generate_key_internal(
Gilles Peskinee56e8782019-04-26 17:34:02 +02006240 psa_key_slot_t *slot, size_t bits,
6241 const uint8_t *domain_parameters, size_t domain_parameters_size )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006242{
Gilles Peskine8e338702019-07-30 20:06:31 +02006243 psa_key_type_t type = slot->attr.type;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006244
Gilles Peskinee56e8782019-04-26 17:34:02 +02006245 if( domain_parameters == NULL && domain_parameters_size != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006246 return( PSA_ERROR_INVALID_ARGUMENT );
6247
Gilles Peskinee59236f2018-01-27 23:32:46 +01006248 if( key_type_is_raw_bytes( type ) )
6249 {
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006250 psa_status_t status;
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006251
6252 status = validate_unstructured_key_bit_size( slot->attr.type, bits );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006253 if( status != PSA_SUCCESS )
6254 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006255
6256 /* Allocate memory for the key */
Steven Cooreman75b74362020-07-28 14:30:13 +02006257 status = psa_allocate_buffer_to_slot( slot, PSA_BITS_TO_BYTES( bits ) );
6258 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02006259 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006260
Steven Cooreman71fd80d2020-07-07 21:12:27 +02006261 status = psa_generate_random( slot->data.key.data,
6262 slot->data.key.bytes );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006263 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006264 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006265
6266 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006267#if defined(MBEDTLS_DES_C)
6268 if( type == PSA_KEY_TYPE_DES )
Steven Cooreman71fd80d2020-07-07 21:12:27 +02006269 psa_des_set_key_parity( slot->data.key.data,
6270 slot->data.key.bytes );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006271#endif /* MBEDTLS_DES_C */
6272 }
6273 else
6274
6275#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_GENPRIME)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02006276 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006277 {
Steven Cooremana01795d2020-07-24 22:48:15 +02006278 mbedtls_rsa_context rsa;
Janos Follath24eed8d2019-11-22 13:21:35 +00006279 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee56e8782019-04-26 17:34:02 +02006280 int exponent;
6281 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006282 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
6283 return( PSA_ERROR_NOT_SUPPORTED );
6284 /* Accept only byte-aligned keys, for the same reasons as
6285 * in psa_import_rsa_key(). */
6286 if( bits % 8 != 0 )
6287 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinee56e8782019-04-26 17:34:02 +02006288 status = psa_read_rsa_exponent( domain_parameters,
6289 domain_parameters_size,
6290 &exponent );
6291 if( status != PSA_SUCCESS )
6292 return( status );
Steven Cooremana01795d2020-07-24 22:48:15 +02006293 mbedtls_rsa_init( &rsa, MBEDTLS_RSA_PKCS_V15, MBEDTLS_MD_NONE );
6294 ret = mbedtls_rsa_gen_key( &rsa,
Gilles Peskinee59236f2018-01-27 23:32:46 +01006295 mbedtls_ctr_drbg_random,
6296 &global_data.ctr_drbg,
6297 (unsigned int) bits,
6298 exponent );
6299 if( ret != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006300 return( mbedtls_to_psa_error( ret ) );
Steven Cooremana01795d2020-07-24 22:48:15 +02006301
6302 /* Make sure to always have an export representation available */
6303 size_t bytes = PSA_KEY_EXPORT_RSA_KEY_PAIR_MAX_SIZE( bits );
6304
Steven Cooreman75b74362020-07-28 14:30:13 +02006305 status = psa_allocate_buffer_to_slot( slot, bytes );
6306 if( status != PSA_SUCCESS )
Steven Cooremana01795d2020-07-24 22:48:15 +02006307 {
6308 mbedtls_rsa_free( &rsa );
Steven Cooreman29149862020-08-05 15:43:42 +02006309 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006310 }
Steven Cooremana01795d2020-07-24 22:48:15 +02006311
6312 status = psa_export_rsa_key( type,
6313 &rsa,
6314 slot->data.key.data,
6315 bytes,
6316 &slot->data.key.bytes );
6317 mbedtls_rsa_free( &rsa );
6318 if( status != PSA_SUCCESS )
Steven Cooremana01795d2020-07-24 22:48:15 +02006319 psa_remove_key_data_from_memory( slot );
Steven Cooreman560c28a2020-07-24 23:20:24 +02006320 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006321 }
6322 else
6323#endif /* MBEDTLS_RSA_C && MBEDTLS_GENPRIME */
6324
6325#if defined(MBEDTLS_ECP_C)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02006326 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006327 {
Paul Elliott8ff510a2020-06-02 17:19:28 +01006328 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY( type );
Gilles Peskine4295e8b2019-12-02 21:39:10 +01006329 mbedtls_ecp_group_id grp_id =
6330 mbedtls_ecc_group_of_psa( curve, PSA_BITS_TO_BYTES( bits ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006331 const mbedtls_ecp_curve_info *curve_info =
6332 mbedtls_ecp_curve_info_from_grp_id( grp_id );
Steven Cooremanacda8342020-07-24 23:09:52 +02006333 mbedtls_ecp_keypair ecp;
Janos Follath24eed8d2019-11-22 13:21:35 +00006334 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee56e8782019-04-26 17:34:02 +02006335 if( domain_parameters_size != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006336 return( PSA_ERROR_NOT_SUPPORTED );
6337 if( grp_id == MBEDTLS_ECP_DP_NONE || curve_info == NULL )
6338 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooremanacda8342020-07-24 23:09:52 +02006339 mbedtls_ecp_keypair_init( &ecp );
6340 ret = mbedtls_ecp_gen_key( grp_id, &ecp,
Gilles Peskinee59236f2018-01-27 23:32:46 +01006341 mbedtls_ctr_drbg_random,
6342 &global_data.ctr_drbg );
6343 if( ret != 0 )
6344 {
Steven Cooremanacda8342020-07-24 23:09:52 +02006345 mbedtls_ecp_keypair_free( &ecp );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006346 return( mbedtls_to_psa_error( ret ) );
6347 }
Steven Cooremanacda8342020-07-24 23:09:52 +02006348
6349
6350 /* Make sure to always have an export representation available */
6351 size_t bytes = PSA_BITS_TO_BYTES( bits );
Steven Cooreman75b74362020-07-28 14:30:13 +02006352 psa_status_t status = psa_allocate_buffer_to_slot( slot, bytes );
6353 if( status != PSA_SUCCESS )
Steven Cooremanacda8342020-07-24 23:09:52 +02006354 {
6355 mbedtls_ecp_keypair_free( &ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02006356 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02006357 }
Steven Cooreman75b74362020-07-28 14:30:13 +02006358
6359 status = mbedtls_to_psa_error(
Steven Cooremanacda8342020-07-24 23:09:52 +02006360 mbedtls_ecp_write_key( &ecp, slot->data.key.data, bytes ) );
6361
6362 mbedtls_ecp_keypair_free( &ecp );
Steven Cooremanb7f6dea2020-08-05 16:07:20 +02006363 if( status != PSA_SUCCESS ) {
6364 memset( slot->data.key.data, 0, bytes );
Steven Cooremanacda8342020-07-24 23:09:52 +02006365 psa_remove_key_data_from_memory( slot );
Steven Cooremanb7f6dea2020-08-05 16:07:20 +02006366 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02006367 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006368 }
6369 else
6370#endif /* MBEDTLS_ECP_C */
Steven Cooreman29149862020-08-05 15:43:42 +02006371 {
Gilles Peskinee59236f2018-01-27 23:32:46 +01006372 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman29149862020-08-05 15:43:42 +02006373 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01006374
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006375 return( PSA_SUCCESS );
6376}
Darryl Green0c6575a2018-11-07 16:05:30 +00006377
Gilles Peskine35ef36b2019-05-16 19:42:05 +02006378psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02006379 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006380{
6381 psa_status_t status;
6382 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02006383 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine11792082019-08-06 18:36:36 +02006384
Ronald Cron81709fc2020-11-14 12:10:32 +01006385 *key = MBEDTLS_SVC_KEY_ID_INIT;
6386
Gilles Peskine0f84d622019-09-12 19:03:13 +02006387 /* Reject any attempt to create a zero-length key so that we don't
6388 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
6389 if( psa_get_key_bits( attributes ) == 0 )
6390 return( PSA_ERROR_INVALID_ARGUMENT );
6391
Ronald Cron81709fc2020-11-14 12:10:32 +01006392 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE, attributes,
6393 &slot, &driver );
Gilles Peskine11792082019-08-06 18:36:36 +02006394 if( status != PSA_SUCCESS )
6395 goto exit;
6396
Steven Cooreman2a1664c2020-07-20 15:33:08 +02006397 status = psa_driver_wrapper_generate_key( attributes,
6398 slot );
6399 if( status != PSA_ERROR_NOT_SUPPORTED ||
6400 psa_key_lifetime_is_external( attributes->core.lifetime ) )
6401 goto exit;
6402
6403 status = psa_generate_key_internal(
6404 slot, attributes->core.bits,
6405 attributes->domain_parameters, attributes->domain_parameters_size );
Gilles Peskine11792082019-08-06 18:36:36 +02006406
6407exit:
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006408 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01006409 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006410 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02006411 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02006412
Darryl Green0c6575a2018-11-07 16:05:30 +00006413 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006414}
6415
6416
Gilles Peskinee59236f2018-01-27 23:32:46 +01006417
6418/****************************************************************/
6419/* Module setup */
6420/****************************************************************/
6421
Gilles Peskine5e769522018-11-20 21:59:56 +01006422psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
6423 void (* entropy_init )( mbedtls_entropy_context *ctx ),
6424 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
6425{
6426 if( global_data.rng_state != RNG_NOT_INITIALIZED )
6427 return( PSA_ERROR_BAD_STATE );
6428 global_data.entropy_init = entropy_init;
6429 global_data.entropy_free = entropy_free;
6430 return( PSA_SUCCESS );
6431}
6432
Gilles Peskinee59236f2018-01-27 23:32:46 +01006433void mbedtls_psa_crypto_free( void )
6434{
Gilles Peskine66fb1262018-12-10 16:29:04 +01006435 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006436 if( global_data.rng_state != RNG_NOT_INITIALIZED )
6437 {
6438 mbedtls_ctr_drbg_free( &global_data.ctr_drbg );
Gilles Peskine5e769522018-11-20 21:59:56 +01006439 global_data.entropy_free( &global_data.entropy );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006440 }
6441 /* Wipe all remaining data, including configuration.
6442 * In particular, this sets all state indicator to the value
6443 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01006444 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Gilles Peskinea8ade162019-06-26 11:24:49 +02006445#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +02006446 /* Unregister all secure element drivers, so that we restart from
6447 * a pristine state. */
6448 psa_unregister_all_se_drivers( );
Gilles Peskinea8ade162019-06-26 11:24:49 +02006449#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006450}
6451
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006452#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
6453/** Recover a transaction that was interrupted by a power failure.
6454 *
6455 * This function is called during initialization, before psa_crypto_init()
6456 * returns. If this function returns a failure status, the initialization
6457 * fails.
6458 */
6459static psa_status_t psa_crypto_recover_transaction(
6460 const psa_crypto_transaction_t *transaction )
6461{
6462 switch( transaction->unknown.type )
6463 {
6464 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
6465 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01006466 /* TODO - fall through to the failure case until this
Gilles Peskinec9d7f942019-08-13 16:17:16 +02006467 * is implemented.
6468 * https://github.com/ARMmbed/mbed-crypto/issues/218
6469 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006470 default:
6471 /* We found an unsupported transaction in the storage.
6472 * We don't know what state the storage is in. Give up. */
6473 return( PSA_ERROR_STORAGE_FAILURE );
6474 }
6475}
6476#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
6477
Gilles Peskinee59236f2018-01-27 23:32:46 +01006478psa_status_t psa_crypto_init( void )
6479{
Gilles Peskine66fb1262018-12-10 16:29:04 +01006480 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006481 const unsigned char drbg_seed[] = "PSA";
6482
Gilles Peskinec6b69072018-11-20 21:42:52 +01006483 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006484 if( global_data.initialized != 0 )
6485 return( PSA_SUCCESS );
6486
Gilles Peskine5e769522018-11-20 21:59:56 +01006487 /* Set default configuration if
6488 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
6489 if( global_data.entropy_init == NULL )
6490 global_data.entropy_init = mbedtls_entropy_init;
6491 if( global_data.entropy_free == NULL )
6492 global_data.entropy_free = mbedtls_entropy_free;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006493
Gilles Peskinec6b69072018-11-20 21:42:52 +01006494 /* Initialize the random generator. */
Gilles Peskine5e769522018-11-20 21:59:56 +01006495 global_data.entropy_init( &global_data.entropy );
Jaeden Amero76541612019-06-04 17:14:43 +01006496#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
6497 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
6498 /* The PSA entropy injection feature depends on using NV seed as an entropy
6499 * source. Add NV seed as an entropy source for PSA entropy injection. */
6500 mbedtls_entropy_add_source( &global_data.entropy,
6501 mbedtls_nv_seed_poll, NULL,
6502 MBEDTLS_ENTROPY_BLOCK_SIZE,
6503 MBEDTLS_ENTROPY_SOURCE_STRONG );
6504#endif
Gilles Peskinee59236f2018-01-27 23:32:46 +01006505 mbedtls_ctr_drbg_init( &global_data.ctr_drbg );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006506 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine66fb1262018-12-10 16:29:04 +01006507 status = mbedtls_to_psa_error(
6508 mbedtls_ctr_drbg_seed( &global_data.ctr_drbg,
6509 mbedtls_entropy_func,
6510 &global_data.entropy,
6511 drbg_seed, sizeof( drbg_seed ) - 1 ) );
6512 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006513 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01006514 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006515
Gilles Peskine66fb1262018-12-10 16:29:04 +01006516 status = psa_initialize_key_slots( );
6517 if( status != PSA_SUCCESS )
6518 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01006519
Gilles Peskined9348f22019-10-01 15:22:29 +02006520#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
6521 status = psa_init_all_se_drivers( );
6522 if( status != PSA_SUCCESS )
6523 goto exit;
6524#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
6525
Gilles Peskine4b734222019-07-24 15:56:31 +02006526#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02006527 status = psa_crypto_load_transaction( );
6528 if( status == PSA_SUCCESS )
6529 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006530 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
6531 if( status != PSA_SUCCESS )
6532 goto exit;
6533 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02006534 }
6535 else if( status == PSA_ERROR_DOES_NOT_EXIST )
6536 {
6537 /* There's no transaction to complete. It's all good. */
6538 status = PSA_SUCCESS;
6539 }
Gilles Peskine4b734222019-07-24 15:56:31 +02006540#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02006541
Gilles Peskinec6b69072018-11-20 21:42:52 +01006542 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006543 global_data.initialized = 1;
6544
6545exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01006546 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006547 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01006548 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006549}
6550
6551#endif /* MBEDTLS_PSA_CRYPTO_C */