blob: a35af8e1550247fd7d10e1ab12cd5acac2a389f4 [file] [log] [blame]
Gilles Peskinee59236f2018-01-27 23:32:46 +01001/*
2 * PSA crypto layer on top of Mbed TLS crypto
3 */
Bence Szépkúti86974652020-06-15 11:59:37 +02004/*
Bence Szépkúti1e148272020-08-07 13:07:28 +02005 * Copyright The Mbed TLS Contributors
Gilles Peskinee59236f2018-01-27 23:32:46 +01006 * SPDX-License-Identifier: Apache-2.0
7 *
8 * Licensed under the Apache License, Version 2.0 (the "License"); you may
9 * not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
Gilles Peskinee59236f2018-01-27 23:32:46 +010019 */
20
Gilles Peskinedb09ef62020-06-03 01:43:33 +020021#include "common.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010022
23#if defined(MBEDTLS_PSA_CRYPTO_C)
mohammad160327010052018-07-03 13:16:15 +030024
itayzafrir7723ab12019-02-14 10:28:02 +020025#include "psa_crypto_service_integration.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010026#include "psa/crypto.h"
27
Gilles Peskine039b90c2018-12-07 18:24:41 +010028#include "psa_crypto_core.h"
Gilles Peskine5e769522018-11-20 21:59:56 +010029#include "psa_crypto_invasive.h"
Steven Cooremancd84cb42020-07-16 20:28:36 +020030#include "psa_crypto_driver_wrappers.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020031#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +020032#include "psa_crypto_se.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020033#endif
Gilles Peskine961849f2018-11-30 18:54:54 +010034#include "psa_crypto_slot_management.h"
Darryl Greend49a4992018-06-18 17:27:26 +010035/* Include internal declarations that are useful for implementing persistently
36 * stored keys. */
37#include "psa_crypto_storage.h"
38
Gilles Peskineb46bef22019-07-30 21:32:04 +020039#include <assert.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010040#include <stdlib.h>
41#include <string.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010042#include "mbedtls/platform.h"
Gilles Peskineff2d2002019-05-06 15:26:23 +020043#if !defined(MBEDTLS_PLATFORM_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010044#define mbedtls_calloc calloc
45#define mbedtls_free free
46#endif
47
Gilles Peskinea5905292018-02-07 20:59:33 +010048#include "mbedtls/arc4.h"
Gilles Peskine9a944802018-06-21 09:35:35 +020049#include "mbedtls/asn1.h"
Jaeden Amero25384a22019-01-10 10:23:21 +000050#include "mbedtls/asn1write.h"
Gilles Peskinea81d85b2018-06-26 16:10:23 +020051#include "mbedtls/bignum.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010052#include "mbedtls/blowfish.h"
53#include "mbedtls/camellia.h"
Gilles Peskine26869f22019-05-06 15:25:00 +020054#include "mbedtls/chacha20.h"
55#include "mbedtls/chachapoly.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010056#include "mbedtls/cipher.h"
57#include "mbedtls/ccm.h"
58#include "mbedtls/cmac.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010059#include "mbedtls/ctr_drbg.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010060#include "mbedtls/des.h"
Gilles Peskineb7ecdf02018-09-18 12:11:27 +020061#include "mbedtls/ecdh.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010062#include "mbedtls/ecp.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010063#include "mbedtls/entropy.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010064#include "mbedtls/error.h"
65#include "mbedtls/gcm.h"
66#include "mbedtls/md2.h"
67#include "mbedtls/md4.h"
68#include "mbedtls/md5.h"
Gilles Peskine20035e32018-02-03 22:44:14 +010069#include "mbedtls/md.h"
70#include "mbedtls/md_internal.h"
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010071#include "mbedtls/pk.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010072#include "mbedtls/pk_internal.h"
Gilles Peskine3f108122018-12-07 18:14:53 +010073#include "mbedtls/platform_util.h"
Janos Follath24eed8d2019-11-22 13:21:35 +000074#include "mbedtls/error.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010075#include "mbedtls/ripemd160.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010076#include "mbedtls/rsa.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010077#include "mbedtls/sha1.h"
78#include "mbedtls/sha256.h"
79#include "mbedtls/sha512.h"
80#include "mbedtls/xtea.h"
81
Gilles Peskine996deb12018-08-01 15:45:45 +020082#define ARRAY_LENGTH( array ) ( sizeof( array ) / sizeof( *( array ) ) )
83
Gilles Peskine9ef733f2018-02-07 21:05:37 +010084/* constant-time buffer comparison */
85static inline int safer_memcmp( const uint8_t *a, const uint8_t *b, size_t n )
86{
87 size_t i;
88 unsigned char diff = 0;
89
90 for( i = 0; i < n; i++ )
91 diff |= a[i] ^ b[i];
92
93 return( diff );
94}
95
96
97
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010098/****************************************************************/
99/* Global data, support functions and library management */
100/****************************************************************/
101
Gilles Peskine48c0ea12018-06-21 14:15:31 +0200102static int key_type_is_raw_bytes( psa_key_type_t type )
103{
Gilles Peskine78b3bb62018-08-10 16:03:41 +0200104 return( PSA_KEY_TYPE_IS_UNSTRUCTURED( type ) );
Gilles Peskine48c0ea12018-06-21 14:15:31 +0200105}
106
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100107/* Values for psa_global_data_t::rng_state */
108#define RNG_NOT_INITIALIZED 0
109#define RNG_INITIALIZED 1
110#define RNG_SEEDED 2
Gilles Peskinec6b69072018-11-20 21:42:52 +0100111
Gilles Peskine2d277862018-06-18 15:41:12 +0200112typedef struct
113{
Gilles Peskine5e769522018-11-20 21:59:56 +0100114 void (* entropy_init )( mbedtls_entropy_context *ctx );
115 void (* entropy_free )( mbedtls_entropy_context *ctx );
Gilles Peskinee59236f2018-01-27 23:32:46 +0100116 mbedtls_entropy_context entropy;
117 mbedtls_ctr_drbg_context ctr_drbg;
Gilles Peskinec6b69072018-11-20 21:42:52 +0100118 unsigned initialized : 1;
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100119 unsigned rng_state : 2;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100120} psa_global_data_t;
121
122static psa_global_data_t global_data;
123
itayzafrir0adf0fc2018-09-06 16:24:41 +0300124#define GUARD_MODULE_INITIALIZED \
125 if( global_data.initialized == 0 ) \
126 return( PSA_ERROR_BAD_STATE );
127
Steven Cooreman01164162020-07-20 15:31:37 +0200128psa_status_t mbedtls_to_psa_error( int ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100129{
Gilles Peskinea5905292018-02-07 20:59:33 +0100130 /* If there's both a high-level code and low-level code, dispatch on
131 * the high-level code. */
132 switch( ret < -0x7f ? - ( -ret & 0x7f80 ) : ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100133 {
134 case 0:
135 return( PSA_SUCCESS );
Gilles Peskinea5905292018-02-07 20:59:33 +0100136
137 case MBEDTLS_ERR_AES_INVALID_KEY_LENGTH:
138 case MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH:
139 case MBEDTLS_ERR_AES_FEATURE_UNAVAILABLE:
140 return( PSA_ERROR_NOT_SUPPORTED );
141 case MBEDTLS_ERR_AES_HW_ACCEL_FAILED:
142 return( PSA_ERROR_HARDWARE_FAILURE );
143
144 case MBEDTLS_ERR_ARC4_HW_ACCEL_FAILED:
145 return( PSA_ERROR_HARDWARE_FAILURE );
146
Gilles Peskine9a944802018-06-21 09:35:35 +0200147 case MBEDTLS_ERR_ASN1_OUT_OF_DATA:
148 case MBEDTLS_ERR_ASN1_UNEXPECTED_TAG:
149 case MBEDTLS_ERR_ASN1_INVALID_LENGTH:
150 case MBEDTLS_ERR_ASN1_LENGTH_MISMATCH:
151 case MBEDTLS_ERR_ASN1_INVALID_DATA:
152 return( PSA_ERROR_INVALID_ARGUMENT );
153 case MBEDTLS_ERR_ASN1_ALLOC_FAILED:
154 return( PSA_ERROR_INSUFFICIENT_MEMORY );
155 case MBEDTLS_ERR_ASN1_BUF_TOO_SMALL:
156 return( PSA_ERROR_BUFFER_TOO_SMALL );
157
Jaeden Amero93e21112019-02-20 13:57:28 +0000158#if defined(MBEDTLS_ERR_BLOWFISH_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000159 case MBEDTLS_ERR_BLOWFISH_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000160#elif defined(MBEDTLS_ERR_BLOWFISH_INVALID_KEY_LENGTH)
161 case MBEDTLS_ERR_BLOWFISH_INVALID_KEY_LENGTH:
162#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100163 case MBEDTLS_ERR_BLOWFISH_INVALID_INPUT_LENGTH:
164 return( PSA_ERROR_NOT_SUPPORTED );
165 case MBEDTLS_ERR_BLOWFISH_HW_ACCEL_FAILED:
166 return( PSA_ERROR_HARDWARE_FAILURE );
167
Jaeden Amero93e21112019-02-20 13:57:28 +0000168#if defined(MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000169 case MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000170#elif defined(MBEDTLS_ERR_CAMELLIA_INVALID_KEY_LENGTH)
171 case MBEDTLS_ERR_CAMELLIA_INVALID_KEY_LENGTH:
172#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100173 case MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH:
174 return( PSA_ERROR_NOT_SUPPORTED );
175 case MBEDTLS_ERR_CAMELLIA_HW_ACCEL_FAILED:
176 return( PSA_ERROR_HARDWARE_FAILURE );
177
178 case MBEDTLS_ERR_CCM_BAD_INPUT:
179 return( PSA_ERROR_INVALID_ARGUMENT );
180 case MBEDTLS_ERR_CCM_AUTH_FAILED:
181 return( PSA_ERROR_INVALID_SIGNATURE );
182 case MBEDTLS_ERR_CCM_HW_ACCEL_FAILED:
183 return( PSA_ERROR_HARDWARE_FAILURE );
184
Gilles Peskine26869f22019-05-06 15:25:00 +0200185 case MBEDTLS_ERR_CHACHA20_BAD_INPUT_DATA:
186 return( PSA_ERROR_INVALID_ARGUMENT );
187
188 case MBEDTLS_ERR_CHACHAPOLY_BAD_STATE:
189 return( PSA_ERROR_BAD_STATE );
190 case MBEDTLS_ERR_CHACHAPOLY_AUTH_FAILED:
191 return( PSA_ERROR_INVALID_SIGNATURE );
192
Gilles Peskinea5905292018-02-07 20:59:33 +0100193 case MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE:
194 return( PSA_ERROR_NOT_SUPPORTED );
195 case MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA:
196 return( PSA_ERROR_INVALID_ARGUMENT );
197 case MBEDTLS_ERR_CIPHER_ALLOC_FAILED:
198 return( PSA_ERROR_INSUFFICIENT_MEMORY );
199 case MBEDTLS_ERR_CIPHER_INVALID_PADDING:
200 return( PSA_ERROR_INVALID_PADDING );
201 case MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED:
202 return( PSA_ERROR_BAD_STATE );
203 case MBEDTLS_ERR_CIPHER_AUTH_FAILED:
204 return( PSA_ERROR_INVALID_SIGNATURE );
205 case MBEDTLS_ERR_CIPHER_INVALID_CONTEXT:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200206 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100207 case MBEDTLS_ERR_CIPHER_HW_ACCEL_FAILED:
208 return( PSA_ERROR_HARDWARE_FAILURE );
209
210 case MBEDTLS_ERR_CMAC_HW_ACCEL_FAILED:
211 return( PSA_ERROR_HARDWARE_FAILURE );
212
213 case MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED:
214 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
215 case MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG:
216 case MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG:
217 return( PSA_ERROR_NOT_SUPPORTED );
218 case MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR:
219 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
220
221 case MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH:
222 return( PSA_ERROR_NOT_SUPPORTED );
223 case MBEDTLS_ERR_DES_HW_ACCEL_FAILED:
224 return( PSA_ERROR_HARDWARE_FAILURE );
225
Gilles Peskinee59236f2018-01-27 23:32:46 +0100226 case MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED:
227 case MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE:
228 case MBEDTLS_ERR_ENTROPY_SOURCE_FAILED:
229 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskinea5905292018-02-07 20:59:33 +0100230
231 case MBEDTLS_ERR_GCM_AUTH_FAILED:
232 return( PSA_ERROR_INVALID_SIGNATURE );
233 case MBEDTLS_ERR_GCM_BAD_INPUT:
Gilles Peskine8cac2e62018-08-21 15:07:38 +0200234 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100235 case MBEDTLS_ERR_GCM_HW_ACCEL_FAILED:
236 return( PSA_ERROR_HARDWARE_FAILURE );
237
238 case MBEDTLS_ERR_MD2_HW_ACCEL_FAILED:
239 case MBEDTLS_ERR_MD4_HW_ACCEL_FAILED:
240 case MBEDTLS_ERR_MD5_HW_ACCEL_FAILED:
241 return( PSA_ERROR_HARDWARE_FAILURE );
242
243 case MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE:
244 return( PSA_ERROR_NOT_SUPPORTED );
245 case MBEDTLS_ERR_MD_BAD_INPUT_DATA:
246 return( PSA_ERROR_INVALID_ARGUMENT );
247 case MBEDTLS_ERR_MD_ALLOC_FAILED:
248 return( PSA_ERROR_INSUFFICIENT_MEMORY );
249 case MBEDTLS_ERR_MD_FILE_IO_ERROR:
250 return( PSA_ERROR_STORAGE_FAILURE );
251 case MBEDTLS_ERR_MD_HW_ACCEL_FAILED:
252 return( PSA_ERROR_HARDWARE_FAILURE );
253
Gilles Peskinef76aa772018-10-29 19:24:33 +0100254 case MBEDTLS_ERR_MPI_FILE_IO_ERROR:
255 return( PSA_ERROR_STORAGE_FAILURE );
256 case MBEDTLS_ERR_MPI_BAD_INPUT_DATA:
257 return( PSA_ERROR_INVALID_ARGUMENT );
258 case MBEDTLS_ERR_MPI_INVALID_CHARACTER:
259 return( PSA_ERROR_INVALID_ARGUMENT );
260 case MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL:
261 return( PSA_ERROR_BUFFER_TOO_SMALL );
262 case MBEDTLS_ERR_MPI_NEGATIVE_VALUE:
263 return( PSA_ERROR_INVALID_ARGUMENT );
264 case MBEDTLS_ERR_MPI_DIVISION_BY_ZERO:
265 return( PSA_ERROR_INVALID_ARGUMENT );
266 case MBEDTLS_ERR_MPI_NOT_ACCEPTABLE:
267 return( PSA_ERROR_INVALID_ARGUMENT );
268 case MBEDTLS_ERR_MPI_ALLOC_FAILED:
269 return( PSA_ERROR_INSUFFICIENT_MEMORY );
270
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100271 case MBEDTLS_ERR_PK_ALLOC_FAILED:
272 return( PSA_ERROR_INSUFFICIENT_MEMORY );
273 case MBEDTLS_ERR_PK_TYPE_MISMATCH:
274 case MBEDTLS_ERR_PK_BAD_INPUT_DATA:
275 return( PSA_ERROR_INVALID_ARGUMENT );
276 case MBEDTLS_ERR_PK_FILE_IO_ERROR:
Gilles Peskinea5905292018-02-07 20:59:33 +0100277 return( PSA_ERROR_STORAGE_FAILURE );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100278 case MBEDTLS_ERR_PK_KEY_INVALID_VERSION:
279 case MBEDTLS_ERR_PK_KEY_INVALID_FORMAT:
280 return( PSA_ERROR_INVALID_ARGUMENT );
281 case MBEDTLS_ERR_PK_UNKNOWN_PK_ALG:
282 return( PSA_ERROR_NOT_SUPPORTED );
283 case MBEDTLS_ERR_PK_PASSWORD_REQUIRED:
284 case MBEDTLS_ERR_PK_PASSWORD_MISMATCH:
285 return( PSA_ERROR_NOT_PERMITTED );
286 case MBEDTLS_ERR_PK_INVALID_PUBKEY:
287 return( PSA_ERROR_INVALID_ARGUMENT );
288 case MBEDTLS_ERR_PK_INVALID_ALG:
289 case MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE:
290 case MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE:
291 return( PSA_ERROR_NOT_SUPPORTED );
292 case MBEDTLS_ERR_PK_SIG_LEN_MISMATCH:
293 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskinea5905292018-02-07 20:59:33 +0100294 case MBEDTLS_ERR_PK_HW_ACCEL_FAILED:
295 return( PSA_ERROR_HARDWARE_FAILURE );
296
Gilles Peskineff2d2002019-05-06 15:26:23 +0200297 case MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED:
298 return( PSA_ERROR_HARDWARE_FAILURE );
299 case MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED:
300 return( PSA_ERROR_NOT_SUPPORTED );
301
Gilles Peskinea5905292018-02-07 20:59:33 +0100302 case MBEDTLS_ERR_RIPEMD160_HW_ACCEL_FAILED:
303 return( PSA_ERROR_HARDWARE_FAILURE );
304
305 case MBEDTLS_ERR_RSA_BAD_INPUT_DATA:
306 return( PSA_ERROR_INVALID_ARGUMENT );
307 case MBEDTLS_ERR_RSA_INVALID_PADDING:
308 return( PSA_ERROR_INVALID_PADDING );
309 case MBEDTLS_ERR_RSA_KEY_GEN_FAILED:
310 return( PSA_ERROR_HARDWARE_FAILURE );
311 case MBEDTLS_ERR_RSA_KEY_CHECK_FAILED:
312 return( PSA_ERROR_INVALID_ARGUMENT );
313 case MBEDTLS_ERR_RSA_PUBLIC_FAILED:
314 case MBEDTLS_ERR_RSA_PRIVATE_FAILED:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200315 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100316 case MBEDTLS_ERR_RSA_VERIFY_FAILED:
317 return( PSA_ERROR_INVALID_SIGNATURE );
318 case MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE:
319 return( PSA_ERROR_BUFFER_TOO_SMALL );
320 case MBEDTLS_ERR_RSA_RNG_FAILED:
321 return( PSA_ERROR_INSUFFICIENT_MEMORY );
322 case MBEDTLS_ERR_RSA_UNSUPPORTED_OPERATION:
323 return( PSA_ERROR_NOT_SUPPORTED );
324 case MBEDTLS_ERR_RSA_HW_ACCEL_FAILED:
325 return( PSA_ERROR_HARDWARE_FAILURE );
326
327 case MBEDTLS_ERR_SHA1_HW_ACCEL_FAILED:
328 case MBEDTLS_ERR_SHA256_HW_ACCEL_FAILED:
329 case MBEDTLS_ERR_SHA512_HW_ACCEL_FAILED:
330 return( PSA_ERROR_HARDWARE_FAILURE );
331
332 case MBEDTLS_ERR_XTEA_INVALID_INPUT_LENGTH:
333 return( PSA_ERROR_INVALID_ARGUMENT );
334 case MBEDTLS_ERR_XTEA_HW_ACCEL_FAILED:
335 return( PSA_ERROR_HARDWARE_FAILURE );
336
itayzafrir5c753392018-05-08 11:18:38 +0300337 case MBEDTLS_ERR_ECP_BAD_INPUT_DATA:
itayzafrir7b30f8b2018-05-09 16:07:36 +0300338 case MBEDTLS_ERR_ECP_INVALID_KEY:
itayzafrir5c753392018-05-08 11:18:38 +0300339 return( PSA_ERROR_INVALID_ARGUMENT );
itayzafrir7b30f8b2018-05-09 16:07:36 +0300340 case MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL:
341 return( PSA_ERROR_BUFFER_TOO_SMALL );
342 case MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE:
343 return( PSA_ERROR_NOT_SUPPORTED );
344 case MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH:
345 case MBEDTLS_ERR_ECP_VERIFY_FAILED:
346 return( PSA_ERROR_INVALID_SIGNATURE );
347 case MBEDTLS_ERR_ECP_ALLOC_FAILED:
348 return( PSA_ERROR_INSUFFICIENT_MEMORY );
349 case MBEDTLS_ERR_ECP_HW_ACCEL_FAILED:
350 return( PSA_ERROR_HARDWARE_FAILURE );
Janos Follatha13b9052019-11-22 12:48:59 +0000351 case MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED:
352 return( PSA_ERROR_CORRUPTION_DETECTED );
itayzafrir5c753392018-05-08 11:18:38 +0300353
Gilles Peskinee59236f2018-01-27 23:32:46 +0100354 default:
David Saadab4ecc272019-02-14 13:48:10 +0200355 return( PSA_ERROR_GENERIC_ERROR );
Gilles Peskinee59236f2018-01-27 23:32:46 +0100356 }
357}
358
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200359
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +0200360
361
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100362/****************************************************************/
363/* Key management */
364/****************************************************************/
365
Gilles Peskine73167e12019-07-12 23:44:37 +0200366#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
367static inline int psa_key_slot_is_external( const psa_key_slot_t *slot )
368{
Gilles Peskine8e338702019-07-30 20:06:31 +0200369 return( psa_key_lifetime_is_external( slot->attr.lifetime ) );
Gilles Peskine73167e12019-07-12 23:44:37 +0200370}
371#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
372
Darryl Green8f8aa8f2018-07-24 15:44:51 +0100373#if defined(MBEDTLS_ECP_C)
Paul Elliott8ff510a2020-06-02 17:19:28 +0100374mbedtls_ecp_group_id mbedtls_ecc_group_of_psa( psa_ecc_family_t curve,
Gilles Peskine5055b232019-12-12 17:49:31 +0100375 size_t byte_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +0200376{
377 switch( curve )
378 {
Paul Elliott8ff510a2020-06-02 17:19:28 +0100379 case PSA_ECC_FAMILY_SECP_R1:
Gilles Peskine228abc52019-12-03 17:24:19 +0100380 switch( byte_length )
381 {
382 case PSA_BITS_TO_BYTES( 192 ):
383 return( MBEDTLS_ECP_DP_SECP192R1 );
384 case PSA_BITS_TO_BYTES( 224 ):
385 return( MBEDTLS_ECP_DP_SECP224R1 );
386 case PSA_BITS_TO_BYTES( 256 ):
387 return( MBEDTLS_ECP_DP_SECP256R1 );
388 case PSA_BITS_TO_BYTES( 384 ):
389 return( MBEDTLS_ECP_DP_SECP384R1 );
390 case PSA_BITS_TO_BYTES( 521 ):
391 return( MBEDTLS_ECP_DP_SECP521R1 );
392 default:
393 return( MBEDTLS_ECP_DP_NONE );
394 }
395 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100396
Paul Elliott8ff510a2020-06-02 17:19:28 +0100397 case PSA_ECC_FAMILY_BRAINPOOL_P_R1:
Gilles Peskine228abc52019-12-03 17:24:19 +0100398 switch( byte_length )
399 {
400 case PSA_BITS_TO_BYTES( 256 ):
401 return( MBEDTLS_ECP_DP_BP256R1 );
402 case PSA_BITS_TO_BYTES( 384 ):
403 return( MBEDTLS_ECP_DP_BP384R1 );
404 case PSA_BITS_TO_BYTES( 512 ):
405 return( MBEDTLS_ECP_DP_BP512R1 );
406 default:
407 return( MBEDTLS_ECP_DP_NONE );
408 }
409 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100410
Paul Elliott8ff510a2020-06-02 17:19:28 +0100411 case PSA_ECC_FAMILY_MONTGOMERY:
Gilles Peskine228abc52019-12-03 17:24:19 +0100412 switch( byte_length )
413 {
414 case PSA_BITS_TO_BYTES( 255 ):
415 return( MBEDTLS_ECP_DP_CURVE25519 );
416 case PSA_BITS_TO_BYTES( 448 ):
417 return( MBEDTLS_ECP_DP_CURVE448 );
418 default:
419 return( MBEDTLS_ECP_DP_NONE );
420 }
421 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100422
Paul Elliott8ff510a2020-06-02 17:19:28 +0100423 case PSA_ECC_FAMILY_SECP_K1:
Gilles Peskine228abc52019-12-03 17:24:19 +0100424 switch( byte_length )
425 {
426 case PSA_BITS_TO_BYTES( 192 ):
427 return( MBEDTLS_ECP_DP_SECP192K1 );
428 case PSA_BITS_TO_BYTES( 224 ):
429 return( MBEDTLS_ECP_DP_SECP224K1 );
430 case PSA_BITS_TO_BYTES( 256 ):
431 return( MBEDTLS_ECP_DP_SECP256K1 );
432 default:
433 return( MBEDTLS_ECP_DP_NONE );
434 }
435 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100436
Gilles Peskine12313cd2018-06-20 00:20:32 +0200437 default:
438 return( MBEDTLS_ECP_DP_NONE );
439 }
440}
Darryl Green8f8aa8f2018-07-24 15:44:51 +0100441#endif /* defined(MBEDTLS_ECP_C) */
Gilles Peskine12313cd2018-06-20 00:20:32 +0200442
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200443static psa_status_t validate_unstructured_key_bit_size( psa_key_type_t type,
444 size_t bits )
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200445{
446 /* Check that the bit size is acceptable for the key type */
447 switch( type )
448 {
449 case PSA_KEY_TYPE_RAW_DATA:
450#if defined(MBEDTLS_MD_C)
451 case PSA_KEY_TYPE_HMAC:
Gilles Peskine46f1fd72018-06-28 19:31:31 +0200452#endif
Gilles Peskineea0fb492018-07-12 17:17:20 +0200453 case PSA_KEY_TYPE_DERIVE:
454 break;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200455#if defined(MBEDTLS_AES_C)
456 case PSA_KEY_TYPE_AES:
457 if( bits != 128 && bits != 192 && bits != 256 )
458 return( PSA_ERROR_INVALID_ARGUMENT );
459 break;
460#endif
461#if defined(MBEDTLS_CAMELLIA_C)
462 case PSA_KEY_TYPE_CAMELLIA:
463 if( bits != 128 && bits != 192 && bits != 256 )
464 return( PSA_ERROR_INVALID_ARGUMENT );
465 break;
466#endif
467#if defined(MBEDTLS_DES_C)
468 case PSA_KEY_TYPE_DES:
469 if( bits != 64 && bits != 128 && bits != 192 )
470 return( PSA_ERROR_INVALID_ARGUMENT );
471 break;
472#endif
473#if defined(MBEDTLS_ARC4_C)
474 case PSA_KEY_TYPE_ARC4:
475 if( bits < 8 || bits > 2048 )
476 return( PSA_ERROR_INVALID_ARGUMENT );
477 break;
478#endif
Gilles Peskine26869f22019-05-06 15:25:00 +0200479#if defined(MBEDTLS_CHACHA20_C)
480 case PSA_KEY_TYPE_CHACHA20:
481 if( bits != 256 )
482 return( PSA_ERROR_INVALID_ARGUMENT );
483 break;
484#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200485 default:
486 return( PSA_ERROR_NOT_SUPPORTED );
487 }
Gilles Peskineb54979a2018-06-21 09:32:47 +0200488 if( bits % 8 != 0 )
489 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200490
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200491 return( PSA_SUCCESS );
492}
493
Steven Cooremana01795d2020-07-24 22:48:15 +0200494#if defined(MBEDTLS_RSA_C)
495
496#if defined(MBEDTLS_PK_PARSE_C)
Gilles Peskine86a440b2018-11-12 18:39:40 +0100497/* Mbed TLS doesn't support non-byte-aligned key sizes (i.e. key sizes
498 * that are not a multiple of 8) well. For example, there is only
499 * mbedtls_rsa_get_len(), which returns a number of bytes, and no
500 * way to return the exact bit size of a key.
501 * To keep things simple, reject non-byte-aligned key sizes. */
502static psa_status_t psa_check_rsa_key_byte_aligned(
503 const mbedtls_rsa_context *rsa )
504{
505 mbedtls_mpi n;
506 psa_status_t status;
507 mbedtls_mpi_init( &n );
508 status = mbedtls_to_psa_error(
509 mbedtls_rsa_export( rsa, &n, NULL, NULL, NULL, NULL ) );
510 if( status == PSA_SUCCESS )
511 {
512 if( mbedtls_mpi_bitlen( &n ) % 8 != 0 )
513 status = PSA_ERROR_NOT_SUPPORTED;
514 }
515 mbedtls_mpi_free( &n );
516 return( status );
517}
Steven Cooremana01795d2020-07-24 22:48:15 +0200518#endif /* MBEDTLS_PK_PARSE_C */
Gilles Peskine86a440b2018-11-12 18:39:40 +0100519
Steven Cooreman7f391872020-07-30 14:57:44 +0200520/** Load the contents of a key buffer into an internal RSA representation
Steven Cooremana01795d2020-07-24 22:48:15 +0200521 *
Steven Cooreman4fed4552020-08-03 14:46:03 +0200522 * \param[in] type The type of key contained in \p data.
523 * \param[in] data The buffer from which to load the representation.
524 * \param[in] data_length The size in bytes of \p data.
525 * \param[out] p_rsa Returns a pointer to an RSA context on success.
526 * The caller is responsible for freeing both the
527 * contents of the context and the context itself
528 * when done.
Steven Cooremana01795d2020-07-24 22:48:15 +0200529 */
Steven Cooreman4fed4552020-08-03 14:46:03 +0200530static psa_status_t psa_load_rsa_representation( psa_key_type_t type,
531 const uint8_t *data,
532 size_t data_length,
Steven Cooremana2371e52020-07-28 14:30:39 +0200533 mbedtls_rsa_context **p_rsa )
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200534{
Steven Cooremana01795d2020-07-24 22:48:15 +0200535#if defined(MBEDTLS_PK_PARSE_C)
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000536 psa_status_t status;
Steven Cooremana01795d2020-07-24 22:48:15 +0200537 mbedtls_pk_context ctx;
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000538 size_t bits;
Steven Cooremana01795d2020-07-24 22:48:15 +0200539 mbedtls_pk_init( &ctx );
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000540
541 /* Parse the data. */
Steven Cooreman7f391872020-07-30 14:57:44 +0200542 if( PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000543 status = mbedtls_to_psa_error(
Steven Cooreman4fed4552020-08-03 14:46:03 +0200544 mbedtls_pk_parse_key( &ctx, data, data_length, NULL, 0 ) );
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200545 else
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000546 status = mbedtls_to_psa_error(
Steven Cooreman4fed4552020-08-03 14:46:03 +0200547 mbedtls_pk_parse_public_key( &ctx, data, data_length ) );
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000548 if( status != PSA_SUCCESS )
549 goto exit;
550
551 /* We have something that the pkparse module recognizes. If it is a
552 * valid RSA key, store it. */
Steven Cooremana01795d2020-07-24 22:48:15 +0200553 if( mbedtls_pk_get_type( &ctx ) != MBEDTLS_PK_RSA )
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200554 {
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000555 status = PSA_ERROR_INVALID_ARGUMENT;
556 goto exit;
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200557 }
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000558
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000559 /* The size of an RSA key doesn't have to be a multiple of 8. Mbed TLS
560 * supports non-byte-aligned key sizes, but not well. For example,
561 * mbedtls_rsa_get_len() returns the key size in bytes, not in bits. */
Steven Cooremana01795d2020-07-24 22:48:15 +0200562 bits = PSA_BYTES_TO_BITS( mbedtls_rsa_get_len( mbedtls_pk_rsa( ctx ) ) );
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000563 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
564 {
565 status = PSA_ERROR_NOT_SUPPORTED;
566 goto exit;
567 }
Steven Cooremana01795d2020-07-24 22:48:15 +0200568 status = psa_check_rsa_key_byte_aligned( mbedtls_pk_rsa( ctx ) );
Steven Cooremana01795d2020-07-24 22:48:15 +0200569 if( status != PSA_SUCCESS )
570 goto exit;
571
Steven Cooremana2371e52020-07-28 14:30:39 +0200572 /* Copy out the pointer to the RSA context, and reset the PK context
573 * such that pk_free doesn't free the RSA context we just grabbed. */
574 *p_rsa = mbedtls_pk_rsa( ctx );
575 ctx.pk_info = NULL;
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000576
577exit:
Steven Cooremana01795d2020-07-24 22:48:15 +0200578 mbedtls_pk_free( &ctx );
579 return( status );
580#else
Steven Cooreman4fed4552020-08-03 14:46:03 +0200581 (void) data;
582 (void) data_length;
Steven Cooreman7f391872020-07-30 14:57:44 +0200583 (void) type;
Steven Cooremana01795d2020-07-24 22:48:15 +0200584 (void) rsa;
585 return( PSA_ERROR_NOT_SUPPORTED );
586#endif /* MBEDTLS_PK_PARSE_C */
587}
588
589/** Export an RSA key to export representation
590 *
591 * \param[in] type The type of key (public/private) to export
592 * \param[in] rsa The internal RSA representation from which to export
593 * \param[out] data The buffer to export to
594 * \param[in] data_size The length of the buffer to export to
595 * \param[out] data_length The amount of bytes written to \p data
596 */
597static psa_status_t psa_export_rsa_key( psa_key_type_t type,
598 mbedtls_rsa_context *rsa,
599 uint8_t *data,
600 size_t data_size,
601 size_t *data_length )
602{
603#if defined(MBEDTLS_PK_WRITE_C)
604 int ret;
605 mbedtls_pk_context pk;
606 uint8_t *pos = data + data_size;
607
608 mbedtls_pk_init( &pk );
609 pk.pk_info = &mbedtls_rsa_info;
610 pk.pk_ctx = rsa;
611
612 /* PSA Crypto API defines the format of an RSA key as a DER-encoded
Steven Cooreman75b74362020-07-28 14:30:13 +0200613 * representation of the non-encrypted PKCS#1 RSAPrivateKey for a
614 * private key and of the RFC3279 RSAPublicKey for a public key. */
Steven Cooremana01795d2020-07-24 22:48:15 +0200615 if( PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
616 ret = mbedtls_pk_write_key_der( &pk, data, data_size );
617 else
618 ret = mbedtls_pk_write_pubkey( &pos, data, &pk );
619
620 if( ret < 0 )
Steven Cooreman4fed4552020-08-03 14:46:03 +0200621 {
622 /* Clean up in case pk_write failed halfway through. */
623 memset( data, 0, data_size );
Steven Cooreman29149862020-08-05 15:43:42 +0200624 return( mbedtls_to_psa_error( ret ) );
Steven Cooreman4fed4552020-08-03 14:46:03 +0200625 }
Steven Cooremana01795d2020-07-24 22:48:15 +0200626
627 /* The mbedtls_pk_xxx functions write to the end of the buffer.
628 * Move the data to the beginning and erase remaining data
629 * at the original location. */
630 if( 2 * (size_t) ret <= data_size )
631 {
632 memcpy( data, data + data_size - ret, ret );
633 memset( data + data_size - ret, 0, ret );
634 }
635 else if( (size_t) ret < data_size )
636 {
637 memmove( data, data + data_size - ret, ret );
638 memset( data + ret, 0, data_size - ret );
639 }
640
641 *data_length = ret;
642 return( PSA_SUCCESS );
643#else
644 (void) type;
645 (void) rsa;
646 (void) data;
647 (void) data_size;
648 (void) data_length;
649 return( PSA_ERROR_NOT_SUPPORTED );
650#endif /* MBEDTLS_PK_WRITE_C */
651}
652
653/** Import an RSA key from import representation to a slot
654 *
655 * \param[in,out] slot The slot where to store the export representation to
656 * \param[in] data The buffer containing the import representation
657 * \param[in] data_length The amount of bytes in \p data
658 */
659static psa_status_t psa_import_rsa_key( psa_key_slot_t *slot,
660 const uint8_t *data,
661 size_t data_length )
662{
663 psa_status_t status;
664 uint8_t* output = NULL;
Steven Cooremana2371e52020-07-28 14:30:39 +0200665 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +0200666
Steven Cooremana01795d2020-07-24 22:48:15 +0200667 /* Parse input */
Steven Cooreman4fed4552020-08-03 14:46:03 +0200668 status = psa_load_rsa_representation( slot->attr.type,
669 data,
Steven Cooreman7f391872020-07-30 14:57:44 +0200670 data_length,
Steven Cooreman7f391872020-07-30 14:57:44 +0200671 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +0200672 if( status != PSA_SUCCESS )
673 goto exit;
674
675 slot->attr.bits = (psa_key_bits_t) PSA_BYTES_TO_BITS(
Steven Cooremana2371e52020-07-28 14:30:39 +0200676 mbedtls_rsa_get_len( rsa ) );
Steven Cooremana01795d2020-07-24 22:48:15 +0200677
Steven Cooreman75b74362020-07-28 14:30:13 +0200678 /* Re-export the data to PSA export format, such that we can store export
679 * representation in the key slot. Export representation in case of RSA is
680 * the smallest representation that's allowed as input, so a straight-up
681 * allocation of the same size as the input buffer will be large enough. */
Steven Cooremana01795d2020-07-24 22:48:15 +0200682 output = mbedtls_calloc( 1, data_length );
Steven Cooremana01795d2020-07-24 22:48:15 +0200683 if( output == NULL )
684 {
685 status = PSA_ERROR_INSUFFICIENT_MEMORY;
686 goto exit;
687 }
688
Steven Cooremana01795d2020-07-24 22:48:15 +0200689 status = psa_export_rsa_key( slot->attr.type,
Steven Cooremana2371e52020-07-28 14:30:39 +0200690 rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +0200691 output,
692 data_length,
693 &data_length);
Steven Cooremana01795d2020-07-24 22:48:15 +0200694exit:
695 /* Always free the RSA object */
Steven Cooremana2371e52020-07-28 14:30:39 +0200696 mbedtls_rsa_free( rsa );
Steven Cooreman6d839f02020-07-30 11:36:45 +0200697 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +0200698
699 /* Free the allocated buffer only on error. */
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000700 if( status != PSA_SUCCESS )
701 {
Steven Cooremana01795d2020-07-24 22:48:15 +0200702 mbedtls_free( output );
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000703 return( status );
704 }
705
Steven Cooremana01795d2020-07-24 22:48:15 +0200706 /* On success, store the allocated export-formatted key. */
707 slot->data.key.data = output;
708 slot->data.key.bytes = data_length;
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000709
710 return( PSA_SUCCESS );
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200711}
Steven Cooremana01795d2020-07-24 22:48:15 +0200712#endif /* defined(MBEDTLS_RSA_C) */
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200713
Jaeden Ameroccdce902019-01-10 11:42:27 +0000714#if defined(MBEDTLS_ECP_C)
Steven Cooreman7f391872020-07-30 14:57:44 +0200715/** Load the contents of a key buffer into an internal ECP representation
Steven Cooremana2371e52020-07-28 14:30:39 +0200716 *
Steven Cooreman4fed4552020-08-03 14:46:03 +0200717 * \param[in] type The type of key contained in \p data.
718 * \param[in] data The buffer from which to load the representation.
719 * \param[in] data_length The size in bytes of \p data.
720 * \param[out] p_ecp Returns a pointer to an ECP context on success.
721 * The caller is responsible for freeing both the
722 * contents of the context and the context itself
723 * when done.
Steven Cooremana2371e52020-07-28 14:30:39 +0200724 */
Steven Cooreman4fed4552020-08-03 14:46:03 +0200725static psa_status_t psa_load_ecp_representation( psa_key_type_t type,
726 const uint8_t *data,
727 size_t data_length,
Steven Cooremana2371e52020-07-28 14:30:39 +0200728 mbedtls_ecp_keypair **p_ecp )
Gilles Peskine4cd32772019-12-02 20:49:42 +0100729{
730 mbedtls_ecp_group_id grp_id = MBEDTLS_ECP_DP_NONE;
Steven Cooremanacda8342020-07-24 23:09:52 +0200731 psa_status_t status;
Steven Cooreman6d839f02020-07-30 11:36:45 +0200732 mbedtls_ecp_keypair *ecp = NULL;
Steven Cooreman4fed4552020-08-03 14:46:03 +0200733 size_t curve_size = data_length;
Gilles Peskine4cd32772019-12-02 20:49:42 +0100734
Steven Cooreman4fed4552020-08-03 14:46:03 +0200735 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) &&
736 PSA_KEY_TYPE_ECC_GET_FAMILY( type ) != PSA_ECC_FAMILY_MONTGOMERY )
Gilles Peskine4295e8b2019-12-02 21:39:10 +0100737 {
Steven Cooreman4fed4552020-08-03 14:46:03 +0200738 /* A Weierstrass public key is represented as:
739 * - The byte 0x04;
740 * - `x_P` as a `ceiling(m/8)`-byte string, big-endian;
741 * - `y_P` as a `ceiling(m/8)`-byte string, big-endian.
742 * So its data length is 2m+1 where n is the key size in bits.
743 */
744 if( ( data_length & 1 ) == 0 )
745 return( PSA_ERROR_INVALID_ARGUMENT );
746 curve_size = data_length / 2;
747
748 /* Montgomery public keys are represented in compressed format, meaning
749 * their curve_size is equal to the amount of input. */
750
751 /* Private keys are represented in uncompressed private random integer
752 * format, meaning their curve_size is equal to the amount of input. */
Gilles Peskine4295e8b2019-12-02 21:39:10 +0100753 }
754
Steven Cooreman6d839f02020-07-30 11:36:45 +0200755 /* Allocate and initialize a key representation. */
Steven Cooreman29149862020-08-05 15:43:42 +0200756 ecp = mbedtls_calloc( 1, sizeof( mbedtls_ecp_keypair ) );
Steven Cooreman6d839f02020-07-30 11:36:45 +0200757 if( ecp == NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200758 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Steven Cooremana2371e52020-07-28 14:30:39 +0200759 mbedtls_ecp_keypair_init( ecp );
760
Gilles Peskine4cd32772019-12-02 20:49:42 +0100761 /* Load the group. */
Steven Cooreman7f391872020-07-30 14:57:44 +0200762 grp_id = mbedtls_ecc_group_of_psa( PSA_KEY_TYPE_ECC_GET_FAMILY( type ),
763 curve_size );
Gilles Peskine4295e8b2019-12-02 21:39:10 +0100764 if( grp_id == MBEDTLS_ECP_DP_NONE )
Steven Cooreman6d839f02020-07-30 11:36:45 +0200765 {
766 status = PSA_ERROR_INVALID_ARGUMENT;
767 goto exit;
768 }
769
Steven Cooremanacda8342020-07-24 23:09:52 +0200770 status = mbedtls_to_psa_error(
771 mbedtls_ecp_group_load( &ecp->grp, grp_id ) );
772 if( status != PSA_SUCCESS )
Steven Cooreman6d839f02020-07-30 11:36:45 +0200773 goto exit;
Steven Cooremanacda8342020-07-24 23:09:52 +0200774
Steven Cooreman6d839f02020-07-30 11:36:45 +0200775 /* Load the key material. */
Steven Cooreman7f391872020-07-30 14:57:44 +0200776 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) )
Steven Cooremanacda8342020-07-24 23:09:52 +0200777 {
778 /* Load the public value. */
779 status = mbedtls_to_psa_error(
780 mbedtls_ecp_point_read_binary( &ecp->grp, &ecp->Q,
Steven Cooreman4fed4552020-08-03 14:46:03 +0200781 data,
782 data_length ) );
Steven Cooremanacda8342020-07-24 23:09:52 +0200783 if( status != PSA_SUCCESS )
784 goto exit;
785
786 /* Check that the point is on the curve. */
787 status = mbedtls_to_psa_error(
788 mbedtls_ecp_check_pubkey( &ecp->grp, &ecp->Q ) );
789 if( status != PSA_SUCCESS )
790 goto exit;
791 }
792 else
793 {
Steven Cooreman6d839f02020-07-30 11:36:45 +0200794 /* Load and validate the secret value. */
Steven Cooremanacda8342020-07-24 23:09:52 +0200795 status = mbedtls_to_psa_error(
796 mbedtls_ecp_read_key( ecp->grp.id,
797 ecp,
Steven Cooreman4fed4552020-08-03 14:46:03 +0200798 data,
799 data_length ) );
Steven Cooremanacda8342020-07-24 23:09:52 +0200800 if( status != PSA_SUCCESS )
801 goto exit;
Steven Cooremanacda8342020-07-24 23:09:52 +0200802 }
Steven Cooremana2371e52020-07-28 14:30:39 +0200803
804 *p_ecp = ecp;
Steven Cooremanacda8342020-07-24 23:09:52 +0200805exit:
806 if( status != PSA_SUCCESS )
Steven Cooremana2371e52020-07-28 14:30:39 +0200807 {
Steven Cooremanacda8342020-07-24 23:09:52 +0200808 mbedtls_ecp_keypair_free( ecp );
Steven Cooremana2371e52020-07-28 14:30:39 +0200809 mbedtls_free( ecp );
810 }
811
Steven Cooreman29149862020-08-05 15:43:42 +0200812 return( status );
Gilles Peskine4cd32772019-12-02 20:49:42 +0100813}
Jaeden Ameroccdce902019-01-10 11:42:27 +0000814
Steven Cooreman4fed4552020-08-03 14:46:03 +0200815/** Export an ECP key to export representation
816 *
817 * \param[in] type The type of key (public/private) to export
818 * \param[in] ecp The internal ECP representation from which to export
819 * \param[out] data The buffer to export to
820 * \param[in] data_size The length of the buffer to export to
821 * \param[out] data_length The amount of bytes written to \p data
822 */
Steven Cooremanacda8342020-07-24 23:09:52 +0200823static psa_status_t psa_export_ecp_key( psa_key_type_t type,
824 mbedtls_ecp_keypair *ecp,
825 uint8_t *data,
826 size_t data_size,
827 size_t *data_length )
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200828{
Steven Cooremanacda8342020-07-24 23:09:52 +0200829 psa_status_t status;
Jaeden Ameroccdce902019-01-10 11:42:27 +0000830
Steven Cooremanacda8342020-07-24 23:09:52 +0200831 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) )
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200832 {
Steven Cooremanacda8342020-07-24 23:09:52 +0200833 /* Check whether the public part is loaded */
834 if( mbedtls_ecp_is_zero( &ecp->Q ) )
835 {
836 /* Calculate the public key */
837 status = mbedtls_to_psa_error(
838 mbedtls_ecp_mul( &ecp->grp, &ecp->Q, &ecp->d, &ecp->grp.G,
839 mbedtls_ctr_drbg_random, &global_data.ctr_drbg ) );
840 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +0200841 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +0200842 }
843
Steven Cooreman4fed4552020-08-03 14:46:03 +0200844 status = mbedtls_to_psa_error(
Steven Cooremanacda8342020-07-24 23:09:52 +0200845 mbedtls_ecp_point_write_binary( &ecp->grp, &ecp->Q,
846 MBEDTLS_ECP_PF_UNCOMPRESSED,
847 data_length,
848 data,
Steven Cooreman4fed4552020-08-03 14:46:03 +0200849 data_size ) );
Steven Cooreman4fed4552020-08-03 14:46:03 +0200850 if( status != PSA_SUCCESS )
851 memset( data, 0, data_size );
852
Steven Cooreman29149862020-08-05 15:43:42 +0200853 return( status );
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200854 }
Steven Cooremanacda8342020-07-24 23:09:52 +0200855 else
856 {
Steven Cooreman29149862020-08-05 15:43:42 +0200857 if( data_size < PSA_BITS_TO_BYTES( ecp->grp.nbits ) )
Steven Cooremanacda8342020-07-24 23:09:52 +0200858 return( PSA_ERROR_BUFFER_TOO_SMALL );
859
860 status = mbedtls_to_psa_error(
861 mbedtls_ecp_write_key( ecp,
862 data,
Steven Cooreman29149862020-08-05 15:43:42 +0200863 PSA_BITS_TO_BYTES( ecp->grp.nbits ) ) );
Steven Cooremanacda8342020-07-24 23:09:52 +0200864 if( status == PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +0200865 *data_length = PSA_BITS_TO_BYTES( ecp->grp.nbits );
Steven Cooremanb7f6dea2020-08-05 16:07:20 +0200866 else
867 memset( data, 0, data_size );
Steven Cooremanacda8342020-07-24 23:09:52 +0200868
869 return( status );
870 }
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200871}
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200872
Steven Cooreman4fed4552020-08-03 14:46:03 +0200873/** Import an ECP key from import representation to a slot
874 *
875 * \param[in,out] slot The slot where to store the export representation to
876 * \param[in] data The buffer containing the import representation
877 * \param[in] data_length The amount of bytes in \p data
878 */
Steven Cooremanacda8342020-07-24 23:09:52 +0200879static psa_status_t psa_import_ecp_key( psa_key_slot_t *slot,
880 const uint8_t *data,
881 size_t data_length )
Gilles Peskinef76aa772018-10-29 19:24:33 +0100882{
Steven Cooremanacda8342020-07-24 23:09:52 +0200883 psa_status_t status;
884 uint8_t* output = NULL;
Steven Cooremana2371e52020-07-28 14:30:39 +0200885 mbedtls_ecp_keypair *ecp = NULL;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100886
Steven Cooremanacda8342020-07-24 23:09:52 +0200887 /* Parse input */
Steven Cooreman4fed4552020-08-03 14:46:03 +0200888 status = psa_load_ecp_representation( slot->attr.type,
889 data,
Steven Cooreman7f391872020-07-30 14:57:44 +0200890 data_length,
Steven Cooreman7f391872020-07-30 14:57:44 +0200891 &ecp );
Gilles Peskinef76aa772018-10-29 19:24:33 +0100892 if( status != PSA_SUCCESS )
893 goto exit;
Gilles Peskine4cd32772019-12-02 20:49:42 +0100894
Steven Cooremanacda8342020-07-24 23:09:52 +0200895 if( PSA_KEY_TYPE_ECC_GET_FAMILY( slot->attr.type ) == PSA_ECC_FAMILY_MONTGOMERY)
Steven Cooremana2371e52020-07-28 14:30:39 +0200896 slot->attr.bits = (psa_key_bits_t) ecp->grp.nbits + 1;
Steven Cooremanacda8342020-07-24 23:09:52 +0200897 else
Steven Cooremana2371e52020-07-28 14:30:39 +0200898 slot->attr.bits = (psa_key_bits_t) ecp->grp.nbits;
Steven Cooremane3fd3922020-06-11 16:50:36 +0200899
Steven Cooremanacda8342020-07-24 23:09:52 +0200900 /* Re-export the data to PSA export format. There is currently no support
901 * for other input formats then the export format, so this is a 1-1
902 * copy operation. */
903 output = mbedtls_calloc( 1, data_length );
Steven Cooremanacda8342020-07-24 23:09:52 +0200904 if( output == NULL )
905 {
906 status = PSA_ERROR_INSUFFICIENT_MEMORY;
907 goto exit;
908 }
909
910 status = psa_export_ecp_key( slot->attr.type,
Steven Cooremana2371e52020-07-28 14:30:39 +0200911 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +0200912 output,
913 data_length,
914 &data_length);
Gilles Peskinef76aa772018-10-29 19:24:33 +0100915exit:
Steven Cooremana2371e52020-07-28 14:30:39 +0200916 /* Always free the PK object (will also free contained ECP context) */
917 mbedtls_ecp_keypair_free( ecp );
Steven Cooreman6d839f02020-07-30 11:36:45 +0200918 mbedtls_free( ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +0200919
920 /* Free the allocated buffer only on error. */
921 if( status != PSA_SUCCESS )
Gilles Peskinef76aa772018-10-29 19:24:33 +0100922 {
Steven Cooremanacda8342020-07-24 23:09:52 +0200923 mbedtls_free( output );
Steven Cooremanacda8342020-07-24 23:09:52 +0200924 return( status );
Gilles Peskinef76aa772018-10-29 19:24:33 +0100925 }
Steven Cooremanacda8342020-07-24 23:09:52 +0200926
927 /* On success, store the allocated export-formatted key. */
928 slot->data.key.data = output;
929 slot->data.key.bytes = data_length;
930
931 return( PSA_SUCCESS );
Gilles Peskinef76aa772018-10-29 19:24:33 +0100932}
933#endif /* defined(MBEDTLS_ECP_C) */
934
Gilles Peskineb46bef22019-07-30 21:32:04 +0200935/** Return the size of the key in the given slot, in bits.
936 *
937 * \param[in] slot A key slot.
938 *
939 * \return The key size in bits, read from the metadata in the slot.
940 */
941static inline size_t psa_get_key_slot_bits( const psa_key_slot_t *slot )
942{
943 return( slot->attr.bits );
944}
945
Steven Cooreman75b74362020-07-28 14:30:13 +0200946/** Try to allocate a buffer to an empty key slot.
947 *
948 * \param[in,out] slot Key slot to attach buffer to.
949 * \param[in] buffer_length Requested size of the buffer.
950 *
951 * \retval #PSA_SUCCESS
952 * The buffer has been successfully allocated.
953 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
954 * Not enough memory was available for allocation.
955 * \retval #PSA_ERROR_ALREADY_EXISTS
956 * Trying to allocate a buffer to a non-empty key slot.
957 */
958static psa_status_t psa_allocate_buffer_to_slot( psa_key_slot_t *slot,
959 size_t buffer_length )
960{
961 if( slot->data.key.data != NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200962 return( PSA_ERROR_ALREADY_EXISTS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200963
964 slot->data.key.data = mbedtls_calloc( 1, buffer_length );
965 if( slot->data.key.data == NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200966 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Steven Cooreman75b74362020-07-28 14:30:13 +0200967
968 slot->data.key.bytes = buffer_length;
Steven Cooreman29149862020-08-05 15:43:42 +0200969 return( PSA_SUCCESS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200970}
971
Gilles Peskine8e338702019-07-30 20:06:31 +0200972/** Import key data into a slot. `slot->attr.type` must have been set
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100973 * previously. This function assumes that the slot does not contain
974 * any key material yet. On failure, the slot content is unchanged. */
Gilles Peskinefa4135b2018-12-10 16:48:53 +0100975psa_status_t psa_import_key_into_slot( psa_key_slot_t *slot,
976 const uint8_t *data,
977 size_t data_length )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100978{
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200979 psa_status_t status = PSA_SUCCESS;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100980
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200981 /* zero-length keys are never supported. */
982 if( data_length == 0 )
983 return( PSA_ERROR_NOT_SUPPORTED );
984
Gilles Peskine8e338702019-07-30 20:06:31 +0200985 if( key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100986 {
Gilles Peskinec744d992019-07-30 17:26:54 +0200987 size_t bit_size = PSA_BYTES_TO_BITS( data_length );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200988
Steven Cooreman75b74362020-07-28 14:30:13 +0200989 /* Ensure that the bytes-to-bits conversion hasn't overflown. */
990 if( data_length > SIZE_MAX / 8 )
991 return( PSA_ERROR_NOT_SUPPORTED );
992
Gilles Peskine1b9505c2019-08-07 10:59:45 +0200993 /* Enforce a size limit, and in particular ensure that the bit
994 * size fits in its representation type. */
Gilles Peskinec744d992019-07-30 17:26:54 +0200995 if( bit_size > PSA_MAX_KEY_BITS )
996 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200997
998 status = validate_unstructured_key_bit_size( slot->attr.type, bit_size );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200999 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001000 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02001001
1002 /* Allocate memory for the key */
Steven Cooreman75b74362020-07-28 14:30:13 +02001003 status = psa_allocate_buffer_to_slot( slot, data_length );
1004 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001005 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02001006
1007 /* copy key into allocated buffer */
Steven Cooreman29149862020-08-05 15:43:42 +02001008 memcpy( slot->data.key.data, data, data_length );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02001009
1010 /* Write the actual key size to the slot.
1011 * psa_start_key_creation() wrote the size declared by the
1012 * caller, which may be 0 (meaning unspecified) or wrong. */
1013 slot->attr.bits = (psa_key_bits_t) bit_size;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001014 }
Steven Cooreman19fd5742020-07-24 23:31:01 +02001015 else if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
1016 {
Gilles Peskinef76aa772018-10-29 19:24:33 +01001017#if defined(MBEDTLS_ECP_C)
Steven Cooreman19fd5742020-07-24 23:31:01 +02001018 status = psa_import_ecp_key( slot,
1019 data, data_length );
1020#else
1021 /* No drivers have been implemented yet, so without mbed TLS backing
1022 * there's no way to do ECP with the current library. */
1023 return( PSA_ERROR_NOT_SUPPORTED );
1024#endif /* defined(MBEDTLS_ECP_C) */
1025 }
1026 else if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskinef76aa772018-10-29 19:24:33 +01001027 {
Steven Cooreman19fd5742020-07-24 23:31:01 +02001028#if defined(MBEDTLS_RSA_C)
1029 status = psa_import_rsa_key( slot,
1030 data, data_length );
1031#else
1032 /* No drivers have been implemented yet, so without mbed TLS backing
1033 * there's no way to do RSA with the current library. */
1034 status = PSA_ERROR_NOT_SUPPORTED;
1035#endif /* defined(MBEDTLS_RSA_C) */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001036 }
1037 else
Gilles Peskinec66ea6a2018-02-03 22:43:28 +01001038 {
Steven Cooreman19fd5742020-07-24 23:31:01 +02001039 /* Unknown key type */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001040 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969ac722018-01-28 18:16:59 +01001041 }
Darryl Green940d72c2018-07-13 13:18:51 +01001042
Darryl Green06fd18d2018-07-16 11:21:11 +01001043 return( status );
1044}
1045
Gilles Peskinef603c712019-01-19 13:40:11 +01001046/** Calculate the intersection of two algorithm usage policies.
1047 *
1048 * Return 0 (which allows no operation) on incompatibility.
1049 */
1050static psa_algorithm_t psa_key_policy_algorithm_intersection(
1051 psa_algorithm_t alg1,
1052 psa_algorithm_t alg2 )
1053{
Gilles Peskine549ea862019-05-22 11:45:59 +02001054 /* Common case: both sides actually specify the same policy. */
Gilles Peskinef603c712019-01-19 13:40:11 +01001055 if( alg1 == alg2 )
1056 return( alg1 );
1057 /* If the policies are from the same hash-and-sign family, check
1058 * if one is a wildcard. If so the other has the specific algorithm. */
1059 if( PSA_ALG_IS_HASH_AND_SIGN( alg1 ) &&
1060 PSA_ALG_IS_HASH_AND_SIGN( alg2 ) &&
1061 ( alg1 & ~PSA_ALG_HASH_MASK ) == ( alg2 & ~PSA_ALG_HASH_MASK ) )
1062 {
1063 if( PSA_ALG_SIGN_GET_HASH( alg1 ) == PSA_ALG_ANY_HASH )
1064 return( alg2 );
1065 if( PSA_ALG_SIGN_GET_HASH( alg2 ) == PSA_ALG_ANY_HASH )
1066 return( alg1 );
1067 }
1068 /* If the policies are incompatible, allow nothing. */
1069 return( 0 );
1070}
1071
Gilles Peskined6f371b2019-05-10 19:33:38 +02001072static int psa_key_algorithm_permits( psa_algorithm_t policy_alg,
1073 psa_algorithm_t requested_alg )
1074{
Gilles Peskine549ea862019-05-22 11:45:59 +02001075 /* Common case: the policy only allows requested_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +02001076 if( requested_alg == policy_alg )
1077 return( 1 );
1078 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
Gilles Peskine549ea862019-05-22 11:45:59 +02001079 * and requested_alg is the same hash-and-sign family with any hash,
1080 * then requested_alg is compliant with policy_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +02001081 if( PSA_ALG_IS_HASH_AND_SIGN( requested_alg ) &&
1082 PSA_ALG_SIGN_GET_HASH( policy_alg ) == PSA_ALG_ANY_HASH )
1083 {
1084 return( ( policy_alg & ~PSA_ALG_HASH_MASK ) ==
1085 ( requested_alg & ~PSA_ALG_HASH_MASK ) );
1086 }
1087 /* If it isn't permitted, it's forbidden. */
1088 return( 0 );
1089}
1090
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001091/** Test whether a policy permits an algorithm.
1092 *
1093 * The caller must test usage flags separately.
1094 */
1095static int psa_key_policy_permits( const psa_key_policy_t *policy,
1096 psa_algorithm_t alg )
1097{
Gilles Peskined6f371b2019-05-10 19:33:38 +02001098 return( psa_key_algorithm_permits( policy->alg, alg ) ||
1099 psa_key_algorithm_permits( policy->alg2, alg ) );
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001100}
1101
Gilles Peskinef603c712019-01-19 13:40:11 +01001102/** Restrict a key policy based on a constraint.
1103 *
1104 * \param[in,out] policy The policy to restrict.
1105 * \param[in] constraint The policy constraint to apply.
1106 *
1107 * \retval #PSA_SUCCESS
1108 * \c *policy contains the intersection of the original value of
1109 * \c *policy and \c *constraint.
1110 * \retval #PSA_ERROR_INVALID_ARGUMENT
1111 * \c *policy and \c *constraint are incompatible.
1112 * \c *policy is unchanged.
1113 */
1114static psa_status_t psa_restrict_key_policy(
1115 psa_key_policy_t *policy,
1116 const psa_key_policy_t *constraint )
1117{
1118 psa_algorithm_t intersection_alg =
1119 psa_key_policy_algorithm_intersection( policy->alg, constraint->alg );
Gilles Peskined6f371b2019-05-10 19:33:38 +02001120 psa_algorithm_t intersection_alg2 =
1121 psa_key_policy_algorithm_intersection( policy->alg2, constraint->alg2 );
Gilles Peskinef603c712019-01-19 13:40:11 +01001122 if( intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0 )
1123 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskined6f371b2019-05-10 19:33:38 +02001124 if( intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0 )
1125 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinef603c712019-01-19 13:40:11 +01001126 policy->usage &= constraint->usage;
1127 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +02001128 policy->alg2 = intersection_alg2;
Gilles Peskinef603c712019-01-19 13:40:11 +01001129 return( PSA_SUCCESS );
1130}
1131
Darryl Green06fd18d2018-07-16 11:21:11 +01001132/** Retrieve a slot which must contain a key. The key must have allow all the
1133 * usage flags set in \p usage. If \p alg is nonzero, the key must allow
1134 * operations with this algorithm. */
Gilles Peskinec5487a82018-12-03 18:08:14 +01001135static psa_status_t psa_get_key_from_slot( psa_key_handle_t handle,
Gilles Peskine2f060a82018-12-04 17:12:32 +01001136 psa_key_slot_t **p_slot,
Darryl Green06fd18d2018-07-16 11:21:11 +01001137 psa_key_usage_t usage,
1138 psa_algorithm_t alg )
1139{
1140 psa_status_t status;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001141 psa_key_slot_t *slot = NULL;
Darryl Green06fd18d2018-07-16 11:21:11 +01001142
1143 *p_slot = NULL;
1144
Gilles Peskinec5487a82018-12-03 18:08:14 +01001145 status = psa_get_key_slot( handle, &slot );
Darryl Green06fd18d2018-07-16 11:21:11 +01001146 if( status != PSA_SUCCESS )
1147 return( status );
Darryl Green06fd18d2018-07-16 11:21:11 +01001148
1149 /* Enforce that usage policy for the key slot contains all the flags
1150 * required by the usage parameter. There is one exception: public
1151 * keys can always be exported, so we treat public key objects as
1152 * if they had the export flag. */
Gilles Peskine8e338702019-07-30 20:06:31 +02001153 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Darryl Green06fd18d2018-07-16 11:21:11 +01001154 usage &= ~PSA_KEY_USAGE_EXPORT;
Gilles Peskine8e338702019-07-30 20:06:31 +02001155 if( ( slot->attr.policy.usage & usage ) != usage )
Darryl Green06fd18d2018-07-16 11:21:11 +01001156 return( PSA_ERROR_NOT_PERMITTED );
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001157
1158 /* Enforce that the usage policy permits the requested algortihm. */
Gilles Peskine8e338702019-07-30 20:06:31 +02001159 if( alg != 0 && ! psa_key_policy_permits( &slot->attr.policy, alg ) )
Darryl Green06fd18d2018-07-16 11:21:11 +01001160 return( PSA_ERROR_NOT_PERMITTED );
1161
1162 *p_slot = slot;
1163 return( PSA_SUCCESS );
1164}
Darryl Green940d72c2018-07-13 13:18:51 +01001165
Gilles Peskine28f8f302019-07-24 13:30:31 +02001166/** Retrieve a slot which must contain a transparent key.
1167 *
1168 * A transparent key is a key for which the key material is directly
1169 * available, as opposed to a key in a secure element.
1170 *
Gilles Peskine60450a42019-07-25 11:32:45 +02001171 * This is a temporary function to use instead of psa_get_key_from_slot()
1172 * until secure element support is fully implemented.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001173 */
1174#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1175static psa_status_t psa_get_transparent_key( psa_key_handle_t handle,
1176 psa_key_slot_t **p_slot,
1177 psa_key_usage_t usage,
1178 psa_algorithm_t alg )
1179{
1180 psa_status_t status = psa_get_key_from_slot( handle, p_slot, usage, alg );
1181 if( status != PSA_SUCCESS )
1182 return( status );
Gilles Peskineadad8132019-07-25 11:31:23 +02001183 if( psa_key_slot_is_external( *p_slot ) )
Gilles Peskine28f8f302019-07-24 13:30:31 +02001184 {
1185 *p_slot = NULL;
1186 return( PSA_ERROR_NOT_SUPPORTED );
1187 }
1188 return( PSA_SUCCESS );
1189}
1190#else /* MBEDTLS_PSA_CRYPTO_SE_C */
1191/* With no secure element support, all keys are transparent. */
1192#define psa_get_transparent_key( handle, p_slot, usage, alg ) \
1193 psa_get_key_from_slot( handle, p_slot, usage, alg )
1194#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1195
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001196/** Wipe key data from a slot. Preserve metadata such as the policy. */
Gilles Peskine2f060a82018-12-04 17:12:32 +01001197static psa_status_t psa_remove_key_data_from_memory( psa_key_slot_t *slot )
Darryl Green40225ba2018-11-15 14:48:15 +00001198{
Gilles Peskine73167e12019-07-12 23:44:37 +02001199#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1200 if( psa_key_slot_is_external( slot ) )
Darryl Green40225ba2018-11-15 14:48:15 +00001201 {
1202 /* No key material to clean. */
1203 }
Gilles Peskine73167e12019-07-12 23:44:37 +02001204 else
1205#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Darryl Green40225ba2018-11-15 14:48:15 +00001206 {
Steven Cooremanfd4d69a2020-08-05 15:46:33 +02001207 /* Data pointer will always be either a valid pointer or NULL in an
1208 * initialized slot, so we can just free it. */
1209 if( slot->data.key.data != NULL )
1210 mbedtls_platform_zeroize( slot->data.key.data, slot->data.key.bytes);
Steven Cooremana01795d2020-07-24 22:48:15 +02001211 mbedtls_free( slot->data.key.data );
1212 slot->data.key.data = NULL;
1213 slot->data.key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +00001214 }
Darryl Green40225ba2018-11-15 14:48:15 +00001215
1216 return( PSA_SUCCESS );
1217}
1218
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001219/** Completely wipe a slot in memory, including its policy.
1220 * Persistent storage is not affected. */
Gilles Peskine66fb1262018-12-10 16:29:04 +01001221psa_status_t psa_wipe_key_slot( psa_key_slot_t *slot )
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001222{
1223 psa_status_t status = psa_remove_key_data_from_memory( slot );
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001224 /* Multipart operations may still be using the key. This is safe
1225 * because all multipart operation objects are independent from
1226 * the key slot: if they need to access the key after the setup
1227 * phase, they have a copy of the key. Note that this means that
1228 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001229 /* At this point, key material and other type-specific content has
1230 * been wiped. Clear remaining metadata. We can call memset and not
1231 * zeroize because the metadata is not particularly sensitive. */
1232 memset( slot, 0, sizeof( *slot ) );
1233 return( status );
1234}
1235
Gilles Peskinec5487a82018-12-03 18:08:14 +01001236psa_status_t psa_destroy_key( psa_key_handle_t handle )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001237{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001238 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001239 psa_status_t status; /* status of the last operation */
1240 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001241#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1242 psa_se_drv_table_entry_t *driver;
1243#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001244
Gilles Peskine1841cf42019-10-08 15:48:25 +02001245 if( handle == 0 )
1246 return( PSA_SUCCESS );
1247
Gilles Peskinec5487a82018-12-03 18:08:14 +01001248 status = psa_get_key_slot( handle, &slot );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001249 if( status != PSA_SUCCESS )
1250 return( status );
Gilles Peskine354f7672019-07-12 23:46:38 +02001251
1252#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001253 driver = psa_get_se_driver_entry( slot->attr.lifetime );
Gilles Peskine354f7672019-07-12 23:46:38 +02001254 if( driver != NULL )
Gilles Peskinefc762652019-07-22 19:30:34 +02001255 {
Gilles Peskine60450a42019-07-25 11:32:45 +02001256 /* For a key in a secure element, we need to do three things:
1257 * remove the key file in internal storage, destroy the
1258 * key inside the secure element, and update the driver's
1259 * persistent data. Start a transaction that will encompass these
1260 * three actions. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001261 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_DESTROY_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +02001262 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Gilles Peskinefc762652019-07-22 19:30:34 +02001263 psa_crypto_transaction.key.slot = slot->data.se.slot_number;
Gilles Peskine8e338702019-07-30 20:06:31 +02001264 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskinefc762652019-07-22 19:30:34 +02001265 status = psa_crypto_save_transaction( );
1266 if( status != PSA_SUCCESS )
1267 {
Gilles Peskine66be51c2019-07-25 18:02:52 +02001268 (void) psa_crypto_stop_transaction( );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001269 /* We should still try to destroy the key in the secure
1270 * element and the key metadata in storage. This is especially
1271 * important if the error is that the storage is full.
1272 * But how to do it exactly without risking an inconsistent
1273 * state after a reset?
1274 * https://github.com/ARMmbed/mbed-crypto/issues/215
1275 */
1276 overall_status = status;
1277 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001278 }
1279
Gilles Peskine354f7672019-07-12 23:46:38 +02001280 status = psa_destroy_se_key( driver, slot->data.se.slot_number );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001281 if( overall_status == PSA_SUCCESS )
1282 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001283 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001284#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1285
Darryl Greend49a4992018-06-18 17:27:26 +01001286#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskinecaec2782019-08-13 15:11:49 +02001287 if( slot->attr.lifetime != PSA_KEY_LIFETIME_VOLATILE )
Darryl Greend49a4992018-06-18 17:27:26 +01001288 {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001289 status = psa_destroy_persistent_key( slot->attr.id );
1290 if( overall_status == PSA_SUCCESS )
1291 overall_status = status;
1292
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001293 /* TODO: other slots may have a copy of the same key. We should
1294 * invalidate them.
1295 * https://github.com/ARMmbed/mbed-crypto/issues/214
1296 */
Darryl Greend49a4992018-06-18 17:27:26 +01001297 }
1298#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001299
Gilles Peskinefc762652019-07-22 19:30:34 +02001300#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1301 if( driver != NULL )
1302 {
Gilles Peskine725f22a2019-07-25 11:31:48 +02001303 status = psa_save_se_persistent_data( driver );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001304 if( overall_status == PSA_SUCCESS )
1305 overall_status = status;
1306 status = psa_crypto_stop_transaction( );
1307 if( overall_status == PSA_SUCCESS )
1308 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001309 }
1310#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1311
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001312#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1313exit:
1314#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001315 status = psa_wipe_key_slot( slot );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001316 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
1317 if( overall_status == PSA_SUCCESS )
1318 overall_status = status;
1319 return( overall_status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001320}
1321
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001322void psa_reset_key_attributes( psa_key_attributes_t *attributes )
Gilles Peskineb870b182018-07-06 16:02:09 +02001323{
Gilles Peskineb699f072019-04-26 16:06:02 +02001324 mbedtls_free( attributes->domain_parameters );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001325 memset( attributes, 0, sizeof( *attributes ) );
Gilles Peskineb870b182018-07-06 16:02:09 +02001326}
1327
Gilles Peskineb699f072019-04-26 16:06:02 +02001328psa_status_t psa_set_key_domain_parameters( psa_key_attributes_t *attributes,
1329 psa_key_type_t type,
1330 const uint8_t *data,
1331 size_t data_length )
1332{
1333 uint8_t *copy = NULL;
1334
1335 if( data_length != 0 )
1336 {
1337 copy = mbedtls_calloc( 1, data_length );
1338 if( copy == NULL )
1339 return( PSA_ERROR_INSUFFICIENT_MEMORY );
1340 memcpy( copy, data, data_length );
1341 }
1342 /* After this point, this function is guaranteed to succeed, so it
1343 * can start modifying `*attributes`. */
1344
1345 if( attributes->domain_parameters != NULL )
1346 {
1347 mbedtls_free( attributes->domain_parameters );
1348 attributes->domain_parameters = NULL;
1349 attributes->domain_parameters_size = 0;
1350 }
1351
1352 attributes->domain_parameters = copy;
1353 attributes->domain_parameters_size = data_length;
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001354 attributes->core.type = type;
Gilles Peskineb699f072019-04-26 16:06:02 +02001355 return( PSA_SUCCESS );
1356}
1357
1358psa_status_t psa_get_key_domain_parameters(
1359 const psa_key_attributes_t *attributes,
1360 uint8_t *data, size_t data_size, size_t *data_length )
1361{
1362 if( attributes->domain_parameters_size > data_size )
1363 return( PSA_ERROR_BUFFER_TOO_SMALL );
1364 *data_length = attributes->domain_parameters_size;
1365 if( attributes->domain_parameters_size != 0 )
1366 memcpy( data, attributes->domain_parameters,
1367 attributes->domain_parameters_size );
1368 return( PSA_SUCCESS );
1369}
1370
1371#if defined(MBEDTLS_RSA_C)
1372static psa_status_t psa_get_rsa_public_exponent(
1373 const mbedtls_rsa_context *rsa,
1374 psa_key_attributes_t *attributes )
1375{
1376 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001377 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001378 uint8_t *buffer = NULL;
1379 size_t buflen;
1380 mbedtls_mpi_init( &mpi );
1381
1382 ret = mbedtls_rsa_export( rsa, NULL, NULL, NULL, NULL, &mpi );
1383 if( ret != 0 )
1384 goto exit;
Gilles Peskine772c8b12019-04-26 17:37:21 +02001385 if( mbedtls_mpi_cmp_int( &mpi, 65537 ) == 0 )
1386 {
1387 /* It's the default value, which is reported as an empty string,
1388 * so there's nothing to do. */
1389 goto exit;
1390 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001391
1392 buflen = mbedtls_mpi_size( &mpi );
1393 buffer = mbedtls_calloc( 1, buflen );
1394 if( buffer == NULL )
1395 {
1396 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1397 goto exit;
1398 }
1399 ret = mbedtls_mpi_write_binary( &mpi, buffer, buflen );
1400 if( ret != 0 )
1401 goto exit;
1402 attributes->domain_parameters = buffer;
1403 attributes->domain_parameters_size = buflen;
1404
1405exit:
1406 mbedtls_mpi_free( &mpi );
1407 if( ret != 0 )
1408 mbedtls_free( buffer );
1409 return( mbedtls_to_psa_error( ret ) );
1410}
1411#endif /* MBEDTLS_RSA_C */
1412
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001413/** Retrieve all the publicly-accessible attributes of a key.
1414 */
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001415psa_status_t psa_get_key_attributes( psa_key_handle_t handle,
1416 psa_key_attributes_t *attributes )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001417{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001418 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001419 psa_status_t status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001420
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001421 psa_reset_key_attributes( attributes );
1422
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001423 status = psa_get_key_from_slot( handle, &slot, 0, 0 );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001424 if( status != PSA_SUCCESS )
1425 return( status );
Gilles Peskineb870b182018-07-06 16:02:09 +02001426
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001427 attributes->core = slot->attr;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001428 attributes->core.flags &= ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1429 MBEDTLS_PSA_KA_MASK_DUAL_USE );
1430
1431#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1432 if( psa_key_slot_is_external( slot ) )
1433 psa_set_key_slot_number( attributes, slot->data.se.slot_number );
1434#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001435
Gilles Peskine8e338702019-07-30 20:06:31 +02001436 switch( slot->attr.type )
Gilles Peskineb699f072019-04-26 16:06:02 +02001437 {
1438#if defined(MBEDTLS_RSA_C)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001439 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001440 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001441#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001442 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001443 * is not yet implemented.
1444 * https://github.com/ARMmbed/mbed-crypto/issues/216
1445 */
Gilles Peskinec8000c02019-08-02 20:15:51 +02001446 if( psa_key_slot_is_external( slot ) )
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001447 break;
1448#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Steven Cooremana01795d2020-07-24 22:48:15 +02001449 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001450 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001451
Steven Cooreman4fed4552020-08-03 14:46:03 +02001452 status = psa_load_rsa_representation( slot->attr.type,
1453 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02001454 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02001455 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001456 if( status != PSA_SUCCESS )
1457 break;
1458
Steven Cooremana2371e52020-07-28 14:30:39 +02001459 status = psa_get_rsa_public_exponent( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02001460 attributes );
Steven Cooremana2371e52020-07-28 14:30:39 +02001461 mbedtls_rsa_free( rsa );
1462 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001463 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001464 break;
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001465#endif /* MBEDTLS_RSA_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001466 default:
1467 /* Nothing else to do. */
1468 break;
1469 }
1470
1471 if( status != PSA_SUCCESS )
1472 psa_reset_key_attributes( attributes );
1473 return( status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001474}
1475
Gilles Peskinec8000c02019-08-02 20:15:51 +02001476#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1477psa_status_t psa_get_key_slot_number(
1478 const psa_key_attributes_t *attributes,
1479 psa_key_slot_number_t *slot_number )
1480{
1481 if( attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER )
1482 {
1483 *slot_number = attributes->slot_number;
1484 return( PSA_SUCCESS );
1485 }
1486 else
1487 return( PSA_ERROR_INVALID_ARGUMENT );
1488}
1489#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1490
Steven Cooremana01795d2020-07-24 22:48:15 +02001491static psa_status_t psa_internal_export_key_buffer( const psa_key_slot_t *slot,
1492 uint8_t *data,
1493 size_t data_size,
1494 size_t *data_length )
1495{
1496 if( slot->data.key.bytes > data_size )
1497 return( PSA_ERROR_BUFFER_TOO_SMALL );
1498 memcpy( data, slot->data.key.data, slot->data.key.bytes );
1499 memset( data + slot->data.key.bytes, 0,
1500 data_size - slot->data.key.bytes );
1501 *data_length = slot->data.key.bytes;
1502 return( PSA_SUCCESS );
1503}
1504
Gilles Peskinef603c712019-01-19 13:40:11 +01001505static psa_status_t psa_internal_export_key( const psa_key_slot_t *slot,
1506 uint8_t *data,
1507 size_t data_size,
1508 size_t *data_length,
1509 int export_public_key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001510{
Gilles Peskine5d309672019-07-12 23:47:28 +02001511#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1512 const psa_drv_se_t *drv;
1513 psa_drv_se_context_t *drv_context;
1514#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1515
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001516 *data_length = 0;
1517
Gilles Peskine8e338702019-07-30 20:06:31 +02001518 if( export_public_key && ! PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
Moran Pekera998bc62018-04-16 18:16:20 +03001519 return( PSA_ERROR_INVALID_ARGUMENT );
mohammad160306e79202018-03-28 13:17:44 +03001520
Gilles Peskinef9168942019-09-12 19:20:29 +02001521 /* Reject a zero-length output buffer now, since this can never be a
1522 * valid key representation. This way we know that data must be a valid
1523 * pointer and we can do things like memset(data, ..., data_size). */
1524 if( data_size == 0 )
1525 return( PSA_ERROR_BUFFER_TOO_SMALL );
1526
Gilles Peskine5d309672019-07-12 23:47:28 +02001527#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001528 if( psa_get_se_driver( slot->attr.lifetime, &drv, &drv_context ) )
Gilles Peskine5d309672019-07-12 23:47:28 +02001529 {
1530 psa_drv_se_export_key_t method;
1531 if( drv->key_management == NULL )
1532 return( PSA_ERROR_NOT_SUPPORTED );
1533 method = ( export_public_key ?
1534 drv->key_management->p_export_public :
1535 drv->key_management->p_export );
1536 if( method == NULL )
1537 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine2e0f3882019-07-25 11:34:33 +02001538 return( method( drv_context,
1539 slot->data.se.slot_number,
1540 data, data_size, data_length ) );
Gilles Peskine5d309672019-07-12 23:47:28 +02001541 }
1542#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1543
Gilles Peskine8e338702019-07-30 20:06:31 +02001544 if( key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001545 {
Steven Cooremanacda8342020-07-24 23:09:52 +02001546 return( psa_internal_export_key_buffer( slot, data, data_size, data_length ) );
Gilles Peskine188c71e2018-10-29 19:26:02 +01001547 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001548 else if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) ||
1549 PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
Moran Peker17e36e12018-05-02 12:55:20 +03001550 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001551 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Gilles Peskine969ac722018-01-28 18:16:59 +01001552 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001553 /* Exporting public -> public */
1554 return( psa_internal_export_key_buffer( slot, data, data_size, data_length ) );
1555 }
1556 else if( !export_public_key )
1557 {
1558 /* Exporting private -> private */
1559 return( psa_internal_export_key_buffer( slot, data, data_size, data_length ) );
1560 }
1561 /* Need to export the public part of a private key,
1562 * so conversion is needed */
1563 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
1564 {
Darryl Green9e2d7a02018-07-24 16:33:30 +01001565#if defined(MBEDTLS_RSA_C)
Steven Cooremana2371e52020-07-28 14:30:39 +02001566 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman7f391872020-07-30 14:57:44 +02001567 psa_status_t status = psa_load_rsa_representation(
Steven Cooreman4fed4552020-08-03 14:46:03 +02001568 slot->attr.type,
Steven Cooreman7f391872020-07-30 14:57:44 +02001569 slot->data.key.data,
1570 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02001571 &rsa );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001572 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001573 return( status );
Steven Cooremana01795d2020-07-24 22:48:15 +02001574
Steven Cooreman560c28a2020-07-24 23:20:24 +02001575 status = psa_export_rsa_key( PSA_KEY_TYPE_RSA_PUBLIC_KEY,
Steven Cooremana2371e52020-07-28 14:30:39 +02001576 rsa,
Steven Cooreman560c28a2020-07-24 23:20:24 +02001577 data,
1578 data_size,
1579 data_length );
Steven Cooremana01795d2020-07-24 22:48:15 +02001580
Steven Cooremana2371e52020-07-28 14:30:39 +02001581 mbedtls_rsa_free( rsa );
1582 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001583
Steven Cooreman560c28a2020-07-24 23:20:24 +02001584 return( status );
Darryl Green9e2d7a02018-07-24 16:33:30 +01001585#else
Steven Cooreman560c28a2020-07-24 23:20:24 +02001586 /* We don't know how to convert a private RSA key to public. */
1587 return( PSA_ERROR_NOT_SUPPORTED );
Darryl Green9e2d7a02018-07-24 16:33:30 +01001588#endif
Gilles Peskine969ac722018-01-28 18:16:59 +01001589 }
1590 else
Moran Pekera998bc62018-04-16 18:16:20 +03001591 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001592#if defined(MBEDTLS_ECP_C)
Steven Cooremana2371e52020-07-28 14:30:39 +02001593 mbedtls_ecp_keypair *ecp = NULL;
Steven Cooreman7f391872020-07-30 14:57:44 +02001594 psa_status_t status = psa_load_ecp_representation(
Steven Cooreman4fed4552020-08-03 14:46:03 +02001595 slot->attr.type,
Steven Cooreman7f391872020-07-30 14:57:44 +02001596 slot->data.key.data,
1597 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02001598 &ecp );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001599 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001600 return( status );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001601
1602 status = psa_export_ecp_key( PSA_KEY_TYPE_ECC_PUBLIC_KEY(
1603 PSA_KEY_TYPE_ECC_GET_FAMILY(
1604 slot->attr.type ) ),
Steven Cooremana2371e52020-07-28 14:30:39 +02001605 ecp,
Steven Cooreman560c28a2020-07-24 23:20:24 +02001606 data,
1607 data_size,
1608 data_length );
1609
Steven Cooremana2371e52020-07-28 14:30:39 +02001610 mbedtls_ecp_keypair_free( ecp );
1611 mbedtls_free( ecp );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001612 return( status );
1613#else
1614 /* We don't know how to convert a private ECC key to public */
Moran Pekera998bc62018-04-16 18:16:20 +03001615 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001616#endif
Moran Pekera998bc62018-04-16 18:16:20 +03001617 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001618 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001619 else
1620 {
1621 /* This shouldn't happen in the reference implementation, but
1622 it is valid for a special-purpose implementation to omit
1623 support for exporting certain key types. */
1624 return( PSA_ERROR_NOT_SUPPORTED );
1625 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001626}
1627
Gilles Peskinec5487a82018-12-03 18:08:14 +01001628psa_status_t psa_export_key( psa_key_handle_t handle,
Gilles Peskine2d277862018-06-18 15:41:12 +02001629 uint8_t *data,
1630 size_t data_size,
1631 size_t *data_length )
Moran Pekera998bc62018-04-16 18:16:20 +03001632{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001633 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001634 psa_status_t status;
1635
1636 /* Set the key to empty now, so that even when there are errors, we always
1637 * set data_length to a value between 0 and data_size. On error, setting
1638 * the key to empty is a good choice because an empty key representation is
1639 * unlikely to be accepted anywhere. */
1640 *data_length = 0;
1641
1642 /* Export requires the EXPORT flag. There is an exception for public keys,
1643 * which don't require any flag, but psa_get_key_from_slot takes
1644 * care of this. */
Gilles Peskinec5487a82018-12-03 18:08:14 +01001645 status = psa_get_key_from_slot( handle, &slot, PSA_KEY_USAGE_EXPORT, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001646 if( status != PSA_SUCCESS )
1647 return( status );
1648 return( psa_internal_export_key( slot, data, data_size,
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02001649 data_length, 0 ) );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001650}
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001651
Gilles Peskinec5487a82018-12-03 18:08:14 +01001652psa_status_t psa_export_public_key( psa_key_handle_t handle,
Gilles Peskine2d277862018-06-18 15:41:12 +02001653 uint8_t *data,
1654 size_t data_size,
1655 size_t *data_length )
Moran Pekerdd4ea382018-04-03 15:30:03 +03001656{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001657 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001658 psa_status_t status;
1659
1660 /* Set the key to empty now, so that even when there are errors, we always
1661 * set data_length to a value between 0 and data_size. On error, setting
1662 * the key to empty is a good choice because an empty key representation is
1663 * unlikely to be accepted anywhere. */
1664 *data_length = 0;
1665
1666 /* Exporting a public key doesn't require a usage flag. */
Gilles Peskinec5487a82018-12-03 18:08:14 +01001667 status = psa_get_key_from_slot( handle, &slot, 0, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001668 if( status != PSA_SUCCESS )
1669 return( status );
1670 return( psa_internal_export_key( slot, data, data_size,
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02001671 data_length, 1 ) );
Moran Pekerdd4ea382018-04-03 15:30:03 +03001672}
1673
Gilles Peskine91e8c332019-08-02 19:19:39 +02001674#if defined(static_assert)
1675static_assert( ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
1676 "One or more key attribute flag is listed as both external-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001677static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
Gilles Peskine094dac12019-08-07 18:19:46 +02001678 "One or more key attribute flag is listed as both internal-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001679static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY ) == 0,
Gilles Peskine91e8c332019-08-02 19:19:39 +02001680 "One or more key attribute flag is listed as both internal-only and external-only" );
1681#endif
1682
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001683/** Validate that a key policy is internally well-formed.
1684 *
1685 * This function only rejects invalid policies. It does not validate the
1686 * consistency of the policy with respect to other attributes of the key
1687 * such as the key type.
1688 */
1689static psa_status_t psa_validate_key_policy( const psa_key_policy_t *policy )
Gilles Peskine4747d192019-04-17 15:05:45 +02001690{
1691 if( ( policy->usage & ~( PSA_KEY_USAGE_EXPORT |
Gilles Peskine8e0206a2019-05-14 14:24:28 +02001692 PSA_KEY_USAGE_COPY |
Gilles Peskine4747d192019-04-17 15:05:45 +02001693 PSA_KEY_USAGE_ENCRYPT |
1694 PSA_KEY_USAGE_DECRYPT |
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001695 PSA_KEY_USAGE_SIGN_HASH |
1696 PSA_KEY_USAGE_VERIFY_HASH |
Gilles Peskine4747d192019-04-17 15:05:45 +02001697 PSA_KEY_USAGE_DERIVE ) ) != 0 )
1698 return( PSA_ERROR_INVALID_ARGUMENT );
1699
Gilles Peskine4747d192019-04-17 15:05:45 +02001700 return( PSA_SUCCESS );
1701}
1702
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001703/** Validate the internal consistency of key attributes.
1704 *
1705 * This function only rejects invalid attribute values. If does not
1706 * validate the consistency of the attributes with any key data that may
1707 * be involved in the creation of the key.
1708 *
1709 * Call this function early in the key creation process.
1710 *
1711 * \param[in] attributes Key attributes for the new key.
1712 * \param[out] p_drv On any return, the driver for the key, if any.
1713 * NULL for a transparent key.
1714 *
1715 */
1716static psa_status_t psa_validate_key_attributes(
1717 const psa_key_attributes_t *attributes,
1718 psa_se_drv_table_entry_t **p_drv )
Darryl Green0c6575a2018-11-07 16:05:30 +00001719{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001720 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001721
Steven Cooreman8c1e7592020-06-17 14:52:05 +02001722 status = psa_validate_key_location( psa_get_key_lifetime( attributes ),
1723 p_drv );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001724 if( status != PSA_SUCCESS )
1725 return( status );
1726
Steven Cooreman8c1e7592020-06-17 14:52:05 +02001727 status = psa_validate_key_persistence( psa_get_key_lifetime( attributes ),
1728 psa_get_key_id( attributes ) );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001729 if( status != PSA_SUCCESS )
1730 return( status );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001731
1732 status = psa_validate_key_policy( &attributes->core.policy );
Darryl Green0c6575a2018-11-07 16:05:30 +00001733 if( status != PSA_SUCCESS )
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001734 return( status );
1735
1736 /* Refuse to create overly large keys.
1737 * Note that this doesn't trigger on import if the attributes don't
1738 * explicitly specify a size (so psa_get_key_bits returns 0), so
1739 * psa_import_key() needs its own checks. */
1740 if( psa_get_key_bits( attributes ) > PSA_MAX_KEY_BITS )
1741 return( PSA_ERROR_NOT_SUPPORTED );
1742
Gilles Peskine91e8c332019-08-02 19:19:39 +02001743 /* Reject invalid flags. These should not be reachable through the API. */
1744 if( attributes->core.flags & ~ ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1745 MBEDTLS_PSA_KA_MASK_DUAL_USE ) )
1746 return( PSA_ERROR_INVALID_ARGUMENT );
1747
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001748 return( PSA_SUCCESS );
1749}
1750
Gilles Peskine4747d192019-04-17 15:05:45 +02001751/** Prepare a key slot to receive key material.
1752 *
1753 * This function allocates a key slot and sets its metadata.
1754 *
1755 * If this function fails, call psa_fail_key_creation().
1756 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001757 * This function is intended to be used as follows:
1758 * -# Call psa_start_key_creation() to allocate a key slot, prepare
1759 * it with the specified attributes, and assign it a handle.
1760 * -# Populate the slot with the key material.
1761 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1762 * In case of failure at any step, stop the sequence and call
1763 * psa_fail_key_creation().
1764 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001765 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001766 * \param[in] attributes Key attributes for the new key.
1767 * \param[out] handle On success, a handle for the allocated slot.
1768 * \param[out] p_slot On success, a pointer to the prepared slot.
1769 * \param[out] p_drv On any return, the driver for the key, if any.
1770 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001771 *
1772 * \retval #PSA_SUCCESS
1773 * The key slot is ready to receive key material.
1774 * \return If this function fails, the key slot is an invalid state.
1775 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001776 */
1777static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001778 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001779 const psa_key_attributes_t *attributes,
1780 psa_key_handle_t *handle,
Gilles Peskine011e4282019-06-26 18:34:38 +02001781 psa_key_slot_t **p_slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001782 psa_se_drv_table_entry_t **p_drv )
Gilles Peskine4747d192019-04-17 15:05:45 +02001783{
1784 psa_status_t status;
1785 psa_key_slot_t *slot;
1786
Gilles Peskinedf179142019-07-15 22:02:14 +02001787 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001788 *p_drv = NULL;
1789
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001790 status = psa_validate_key_attributes( attributes, p_drv );
1791 if( status != PSA_SUCCESS )
1792 return( status );
1793
Gilles Peskineedbed562019-08-07 18:19:59 +02001794 status = psa_get_empty_key_slot( handle, p_slot );
Gilles Peskine4747d192019-04-17 15:05:45 +02001795 if( status != PSA_SUCCESS )
1796 return( status );
1797 slot = *p_slot;
1798
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001799 /* We're storing the declared bit-size of the key. It's up to each
1800 * creation mechanism to verify that this information is correct.
1801 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001802 * an input (generate, device) but not for those where the bit-size
1803 * is optional (import, copy). */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001804
1805 slot->attr = attributes->core;
Gilles Peskinec744d992019-07-30 17:26:54 +02001806
Gilles Peskine91e8c332019-08-02 19:19:39 +02001807 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001808 * external-only flags, query `attributes`. Thanks to the check
1809 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001810 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001811 * may have set. */
1812 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001813
Gilles Peskinecbaff462019-07-12 23:46:04 +02001814#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001815 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001816 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001817 * create the key file in internal storage, create the
1818 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001819 * persistent data. This is done by starting a transaction that will
1820 * encompass these three actions.
1821 * For registering a volatile key, we just need to find an appropriate
1822 * slot number inside the SE. Since the key is designated volatile, creating
1823 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001824 /* The first thing to do is to find a slot number for the new key.
1825 * We save the slot number in persistent storage as part of the
1826 * transaction data. It will be needed to recover if the power
1827 * fails during the key creation process, to clean up on the secure
1828 * element side after restarting. Obtaining a slot number from the
1829 * secure element driver updates its persistent state, but we do not yet
1830 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001831 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001832 if( *p_drv != NULL )
Darryl Green0c6575a2018-11-07 16:05:30 +00001833 {
Gilles Peskinee88c2c12019-08-05 16:44:14 +02001834 status = psa_find_se_slot_for_key( attributes, method, *p_drv,
Gilles Peskinecbaff462019-07-12 23:46:04 +02001835 &slot->data.se.slot_number );
1836 if( status != PSA_SUCCESS )
1837 return( status );
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001838
1839 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( attributes->core.lifetime ) )
Gilles Peskine66be51c2019-07-25 18:02:52 +02001840 {
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001841 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_CREATE_KEY );
1842 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
1843 psa_crypto_transaction.key.slot = slot->data.se.slot_number;
1844 psa_crypto_transaction.key.id = slot->attr.id;
1845 status = psa_crypto_save_transaction( );
1846 if( status != PSA_SUCCESS )
1847 {
1848 (void) psa_crypto_stop_transaction( );
1849 return( status );
1850 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001851 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001852 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001853
1854 if( *p_drv == NULL && method == PSA_KEY_CREATION_REGISTER )
1855 {
1856 /* Key registration only makes sense with a secure element. */
1857 return( PSA_ERROR_INVALID_ARGUMENT );
1858 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001859#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1860
Darryl Green0c6575a2018-11-07 16:05:30 +00001861 return( status );
1862}
Gilles Peskine4747d192019-04-17 15:05:45 +02001863
1864/** Finalize the creation of a key once its key material has been set.
1865 *
1866 * This entails writing the key to persistent storage.
1867 *
1868 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001869 * See the documentation of psa_start_key_creation() for the intended use
1870 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001871 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001872 * \param[in,out] slot Pointer to the slot with key material.
1873 * \param[in] driver The secure element driver for the key,
1874 * or NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001875 *
1876 * \retval #PSA_SUCCESS
1877 * The key was successfully created. The handle is now valid.
1878 * \return If this function fails, the key slot is an invalid state.
1879 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001880 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001881static psa_status_t psa_finish_key_creation(
1882 psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001883 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001884{
1885 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001886 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001887 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001888
1889#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Steven Cooremanc59de6a2020-06-08 18:28:25 +02001890 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Gilles Peskine4747d192019-04-17 15:05:45 +02001891 {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001892#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1893 if( driver != NULL )
1894 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001895 psa_se_key_data_storage_t data;
1896#if defined(static_assert)
1897 static_assert( sizeof( slot->data.se.slot_number ) ==
1898 sizeof( data.slot_number ),
1899 "Slot number size does not match psa_se_key_data_storage_t" );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001900#endif
1901 memcpy( &data.slot_number, &slot->data.se.slot_number,
1902 sizeof( slot->data.se.slot_number ) );
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001903 status = psa_save_persistent_key( &slot->attr,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001904 (uint8_t*) &data,
1905 sizeof( data ) );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001906 }
1907 else
1908#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1909 {
Gilles Peskinee60d1d02019-07-24 20:27:59 +02001910 size_t buffer_size =
Gilles Peskine8e338702019-07-30 20:06:31 +02001911 PSA_KEY_EXPORT_MAX_SIZE( slot->attr.type,
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001912 slot->attr.bits );
Gilles Peskinee60d1d02019-07-24 20:27:59 +02001913 uint8_t *buffer = mbedtls_calloc( 1, buffer_size );
1914 size_t length = 0;
Gilles Peskinef9168942019-09-12 19:20:29 +02001915 if( buffer == NULL )
Gilles Peskine1df83d42019-07-23 16:13:14 +02001916 return( PSA_ERROR_INSUFFICIENT_MEMORY );
1917 status = psa_internal_export_key( slot,
1918 buffer, buffer_size, &length,
1919 0 );
Gilles Peskinee60d1d02019-07-24 20:27:59 +02001920 if( status == PSA_SUCCESS )
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001921 status = psa_save_persistent_key( &slot->attr,
Gilles Peskine4ed0e6f2019-07-30 20:22:33 +02001922 buffer, length );
Gilles Peskine4747d192019-04-17 15:05:45 +02001923
Gilles Peskinef9168942019-09-12 19:20:29 +02001924 mbedtls_platform_zeroize( buffer, buffer_size );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001925 mbedtls_free( buffer );
1926 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001927 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001928#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1929
Gilles Peskinecbaff462019-07-12 23:46:04 +02001930#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001931 /* Finish the transaction for a key creation. This does not
1932 * happen when registering an existing key. Detect this case
1933 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001934 * creation of a persistent key in a secure element requires a transaction,
1935 * but registration or volatile key creation doesn't use one). */
Gilles Peskined7729582019-08-05 15:55:54 +02001936 if( driver != NULL &&
1937 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY )
Gilles Peskinecbaff462019-07-12 23:46:04 +02001938 {
1939 status = psa_save_se_persistent_data( driver );
1940 if( status != PSA_SUCCESS )
1941 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001942 psa_destroy_persistent_key( slot->attr.id );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001943 return( status );
1944 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001945 status = psa_crypto_stop_transaction( );
1946 if( status != PSA_SUCCESS )
1947 return( status );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001948 }
1949#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1950
Gilles Peskine4747d192019-04-17 15:05:45 +02001951 return( status );
1952}
1953
1954/** Abort the creation of a key.
1955 *
1956 * You may call this function after calling psa_start_key_creation(),
1957 * or after psa_finish_key_creation() fails. In other circumstances, this
1958 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001959 * See the documentation of psa_start_key_creation() for the intended use
1960 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001961 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001962 * \param[in,out] slot Pointer to the slot with key material.
1963 * \param[in] driver The secure element driver for the key,
1964 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001965 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001966static void psa_fail_key_creation( psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001967 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001968{
Gilles Peskine011e4282019-06-26 18:34:38 +02001969 (void) driver;
1970
Gilles Peskine4747d192019-04-17 15:05:45 +02001971 if( slot == NULL )
1972 return;
Gilles Peskine011e4282019-06-26 18:34:38 +02001973
1974#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001975 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001976 * element, and the failure happened later (when saving metadata
1977 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001978 * element.
1979 * https://github.com/ARMmbed/mbed-crypto/issues/217
1980 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001981
Gilles Peskined7729582019-08-05 15:55:54 +02001982 /* Abort the ongoing transaction if any (there may not be one if
1983 * the creation process failed before starting one, or if the
1984 * key creation is a registration of a key in a secure element).
1985 * Earlier functions must already have done what it takes to undo any
1986 * partial creation. All that's left is to update the transaction data
1987 * itself. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001988 (void) psa_crypto_stop_transaction( );
Gilles Peskine011e4282019-06-26 18:34:38 +02001989#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1990
Gilles Peskine4747d192019-04-17 15:05:45 +02001991 psa_wipe_key_slot( slot );
1992}
1993
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001994/** Validate optional attributes during key creation.
1995 *
1996 * Some key attributes are optional during key creation. If they are
1997 * specified in the attributes structure, check that they are consistent
1998 * with the data in the slot.
1999 *
2000 * This function should be called near the end of key creation, after
2001 * the slot in memory is fully populated but before saving persistent data.
2002 */
2003static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002004 const psa_key_slot_t *slot,
2005 const psa_key_attributes_t *attributes )
2006{
Gilles Peskine7e0cff92019-07-30 13:48:52 +02002007 if( attributes->core.type != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002008 {
Gilles Peskine8e338702019-07-30 20:06:31 +02002009 if( attributes->core.type != slot->attr.type )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002010 return( PSA_ERROR_INVALID_ARGUMENT );
2011 }
2012
2013 if( attributes->domain_parameters_size != 0 )
2014 {
2015#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02002016 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002017 {
Steven Cooremana2371e52020-07-28 14:30:39 +02002018 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02002019 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02002020 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02002021
Steven Cooreman7f391872020-07-30 14:57:44 +02002022 psa_status_t status = psa_load_rsa_representation(
Steven Cooreman4fed4552020-08-03 14:46:03 +02002023 slot->attr.type,
Steven Cooreman7f391872020-07-30 14:57:44 +02002024 slot->data.key.data,
2025 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02002026 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02002027 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02002028 return( status );
Steven Cooreman75b74362020-07-28 14:30:13 +02002029
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002030 mbedtls_mpi_init( &actual );
2031 mbedtls_mpi_init( &required );
Steven Cooremana2371e52020-07-28 14:30:39 +02002032 ret = mbedtls_rsa_export( rsa,
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002033 NULL, NULL, NULL, NULL, &actual );
Steven Cooremana2371e52020-07-28 14:30:39 +02002034 mbedtls_rsa_free( rsa );
2035 mbedtls_free( rsa );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002036 if( ret != 0 )
2037 goto rsa_exit;
2038 ret = mbedtls_mpi_read_binary( &required,
2039 attributes->domain_parameters,
2040 attributes->domain_parameters_size );
2041 if( ret != 0 )
2042 goto rsa_exit;
2043 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
2044 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
2045 rsa_exit:
2046 mbedtls_mpi_free( &actual );
2047 mbedtls_mpi_free( &required );
2048 if( ret != 0)
2049 return( mbedtls_to_psa_error( ret ) );
2050 }
2051 else
2052#endif
2053 {
2054 return( PSA_ERROR_INVALID_ARGUMENT );
2055 }
2056 }
2057
Gilles Peskine7e0cff92019-07-30 13:48:52 +02002058 if( attributes->core.bits != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002059 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02002060 if( attributes->core.bits != slot->attr.bits )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002061 return( PSA_ERROR_INVALID_ARGUMENT );
2062 }
2063
2064 return( PSA_SUCCESS );
2065}
2066
Gilles Peskine4747d192019-04-17 15:05:45 +02002067psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02002068 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02002069 size_t data_length,
2070 psa_key_handle_t *handle )
Gilles Peskine4747d192019-04-17 15:05:45 +02002071{
2072 psa_status_t status;
2073 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002074 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002075
Gilles Peskine0f84d622019-09-12 19:03:13 +02002076 /* Reject zero-length symmetric keys (including raw data key objects).
2077 * This also rejects any key which might be encoded as an empty string,
2078 * which is never valid. */
2079 if( data_length == 0 )
2080 return( PSA_ERROR_INVALID_ARGUMENT );
2081
Gilles Peskinedf179142019-07-15 22:02:14 +02002082 status = psa_start_key_creation( PSA_KEY_CREATION_IMPORT, attributes,
2083 handle, &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002084 if( status != PSA_SUCCESS )
2085 goto exit;
2086
Gilles Peskine5d309672019-07-12 23:47:28 +02002087#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2088 if( driver != NULL )
2089 {
2090 const psa_drv_se_t *drv = psa_get_se_driver_methods( driver );
Darryl Green0892d0f2019-08-20 09:50:14 +01002091 /* The driver should set the number of key bits, however in
2092 * case it doesn't, we initialize bits to an invalid value. */
2093 size_t bits = PSA_MAX_KEY_BITS + 1;
Gilles Peskine5d309672019-07-12 23:47:28 +02002094 if( drv->key_management == NULL ||
2095 drv->key_management->p_import == NULL )
2096 {
2097 status = PSA_ERROR_NOT_SUPPORTED;
2098 goto exit;
2099 }
2100 status = drv->key_management->p_import(
2101 psa_get_se_driver_context( driver ),
Gilles Peskinef3801ff2019-08-06 17:32:04 +02002102 slot->data.se.slot_number, attributes, data, data_length,
Gilles Peskineb46bef22019-07-30 21:32:04 +02002103 &bits );
2104 if( status != PSA_SUCCESS )
2105 goto exit;
2106 if( bits > PSA_MAX_KEY_BITS )
2107 {
2108 status = PSA_ERROR_NOT_SUPPORTED;
2109 goto exit;
2110 }
2111 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskine5d309672019-07-12 23:47:28 +02002112 }
2113 else
2114#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2115 {
2116 status = psa_import_key_into_slot( slot, data, data_length );
2117 if( status != PSA_SUCCESS )
2118 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02002119 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002120 status = psa_validate_optional_attributes( slot, attributes );
Gilles Peskine18017402019-07-24 20:25:59 +02002121 if( status != PSA_SUCCESS )
2122 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002123
Gilles Peskine011e4282019-06-26 18:34:38 +02002124 status = psa_finish_key_creation( slot, driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002125exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02002126 if( status != PSA_SUCCESS )
2127 {
Gilles Peskine011e4282019-06-26 18:34:38 +02002128 psa_fail_key_creation( slot, driver );
Gilles Peskine4747d192019-04-17 15:05:45 +02002129 *handle = 0;
2130 }
2131 return( status );
2132}
2133
Gilles Peskined7729582019-08-05 15:55:54 +02002134#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2135psa_status_t mbedtls_psa_register_se_key(
2136 const psa_key_attributes_t *attributes )
2137{
2138 psa_status_t status;
2139 psa_key_slot_t *slot = NULL;
2140 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskined7729582019-08-05 15:55:54 +02002141 psa_key_handle_t handle = 0;
2142
2143 /* Leaving attributes unspecified is not currently supported.
2144 * It could make sense to query the key type and size from the
2145 * secure element, but not all secure elements support this
2146 * and the driver HAL doesn't currently support it. */
2147 if( psa_get_key_type( attributes ) == PSA_KEY_TYPE_NONE )
2148 return( PSA_ERROR_NOT_SUPPORTED );
2149 if( psa_get_key_bits( attributes ) == 0 )
2150 return( PSA_ERROR_NOT_SUPPORTED );
2151
2152 status = psa_start_key_creation( PSA_KEY_CREATION_REGISTER, attributes,
2153 &handle, &slot, &driver );
2154 if( status != PSA_SUCCESS )
2155 goto exit;
2156
Gilles Peskined7729582019-08-05 15:55:54 +02002157 status = psa_finish_key_creation( slot, driver );
2158
2159exit:
2160 if( status != PSA_SUCCESS )
2161 {
2162 psa_fail_key_creation( slot, driver );
2163 }
2164 /* Registration doesn't keep the key in RAM. */
2165 psa_close_key( handle );
2166 return( status );
2167}
2168#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2169
Gilles Peskinef603c712019-01-19 13:40:11 +01002170static psa_status_t psa_copy_key_material( const psa_key_slot_t *source,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002171 psa_key_slot_t *target )
Gilles Peskinef603c712019-01-19 13:40:11 +01002172{
2173 psa_status_t status;
2174 uint8_t *buffer = NULL;
2175 size_t buffer_size = 0;
2176 size_t length;
2177
Gilles Peskine8e338702019-07-30 20:06:31 +02002178 buffer_size = PSA_KEY_EXPORT_MAX_SIZE( source->attr.type,
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02002179 psa_get_key_slot_bits( source ) );
Gilles Peskinef603c712019-01-19 13:40:11 +01002180 buffer = mbedtls_calloc( 1, buffer_size );
Gilles Peskinef9168942019-09-12 19:20:29 +02002181 if( buffer == NULL )
Gilles Peskine122d0022019-01-23 10:55:43 +01002182 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Gilles Peskinef603c712019-01-19 13:40:11 +01002183 status = psa_internal_export_key( source, buffer, buffer_size, &length, 0 );
2184 if( status != PSA_SUCCESS )
2185 goto exit;
Gilles Peskine8e338702019-07-30 20:06:31 +02002186 target->attr.type = source->attr.type;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002187 status = psa_import_key_into_slot( target, buffer, length );
Gilles Peskinef603c712019-01-19 13:40:11 +01002188
2189exit:
Gilles Peskinef9168942019-09-12 19:20:29 +02002190 mbedtls_platform_zeroize( buffer, buffer_size );
Gilles Peskine122d0022019-01-23 10:55:43 +01002191 mbedtls_free( buffer );
Gilles Peskinef603c712019-01-19 13:40:11 +01002192 return( status );
2193}
2194
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002195psa_status_t psa_copy_key( psa_key_handle_t source_handle,
2196 const psa_key_attributes_t *specified_attributes,
2197 psa_key_handle_t *target_handle )
Gilles Peskinef603c712019-01-19 13:40:11 +01002198{
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002199 psa_status_t status;
Gilles Peskinef603c712019-01-19 13:40:11 +01002200 psa_key_slot_t *source_slot = NULL;
2201 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002202 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002203 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskinef603c712019-01-19 13:40:11 +01002204
Gilles Peskine28f8f302019-07-24 13:30:31 +02002205 status = psa_get_transparent_key( source_handle, &source_slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02002206 PSA_KEY_USAGE_COPY, 0 );
Gilles Peskinef603c712019-01-19 13:40:11 +01002207 if( status != PSA_SUCCESS )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002208 goto exit;
2209
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002210 status = psa_validate_optional_attributes( source_slot,
2211 specified_attributes );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002212 if( status != PSA_SUCCESS )
2213 goto exit;
2214
Gilles Peskine7e0cff92019-07-30 13:48:52 +02002215 status = psa_restrict_key_policy( &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02002216 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002217 if( status != PSA_SUCCESS )
2218 goto exit;
2219
Gilles Peskinedf179142019-07-15 22:02:14 +02002220 status = psa_start_key_creation( PSA_KEY_CREATION_COPY,
2221 &actual_attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02002222 target_handle, &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002223 if( status != PSA_SUCCESS )
2224 goto exit;
2225
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002226#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2227 if( driver != NULL )
Gilles Peskinef603c712019-01-19 13:40:11 +01002228 {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002229 /* Copying to a secure element is not implemented yet. */
2230 status = PSA_ERROR_NOT_SUPPORTED;
2231 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002232 }
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002233#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef603c712019-01-19 13:40:11 +01002234
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002235 status = psa_copy_key_material( source_slot, target_slot );
Gilles Peskinef603c712019-01-19 13:40:11 +01002236 if( status != PSA_SUCCESS )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002237 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002238
Gilles Peskine011e4282019-06-26 18:34:38 +02002239 status = psa_finish_key_creation( target_slot, driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002240exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002241 if( status != PSA_SUCCESS )
2242 {
Gilles Peskine011e4282019-06-26 18:34:38 +02002243 psa_fail_key_creation( target_slot, driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002244 *target_handle = 0;
2245 }
2246 return( status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002247}
2248
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002249
2250
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002251/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002252/* Message digests */
2253/****************************************************************/
2254
Gilles Peskineb16841e2019-10-10 20:36:12 +02002255#if defined(MBEDTLS_RSA_C) || defined(MBEDTLS_ECDSA_DETERMINISTIC)
Gilles Peskinedc2fc842018-03-07 16:42:59 +01002256static const mbedtls_md_info_t *mbedtls_md_info_from_psa( psa_algorithm_t alg )
Gilles Peskine20035e32018-02-03 22:44:14 +01002257{
2258 switch( alg )
2259 {
2260#if defined(MBEDTLS_MD2_C)
2261 case PSA_ALG_MD2:
2262 return( &mbedtls_md2_info );
2263#endif
2264#if defined(MBEDTLS_MD4_C)
2265 case PSA_ALG_MD4:
2266 return( &mbedtls_md4_info );
2267#endif
2268#if defined(MBEDTLS_MD5_C)
2269 case PSA_ALG_MD5:
2270 return( &mbedtls_md5_info );
2271#endif
2272#if defined(MBEDTLS_RIPEMD160_C)
2273 case PSA_ALG_RIPEMD160:
2274 return( &mbedtls_ripemd160_info );
2275#endif
2276#if defined(MBEDTLS_SHA1_C)
2277 case PSA_ALG_SHA_1:
2278 return( &mbedtls_sha1_info );
2279#endif
2280#if defined(MBEDTLS_SHA256_C)
2281 case PSA_ALG_SHA_224:
2282 return( &mbedtls_sha224_info );
2283 case PSA_ALG_SHA_256:
2284 return( &mbedtls_sha256_info );
2285#endif
2286#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnardd6020842019-07-17 16:28:21 +02002287#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine20035e32018-02-03 22:44:14 +01002288 case PSA_ALG_SHA_384:
2289 return( &mbedtls_sha384_info );
Manuel Pégourié-Gonnardd6020842019-07-17 16:28:21 +02002290#endif
Gilles Peskine20035e32018-02-03 22:44:14 +01002291 case PSA_ALG_SHA_512:
2292 return( &mbedtls_sha512_info );
2293#endif
2294 default:
2295 return( NULL );
2296 }
2297}
Gilles Peskineb16841e2019-10-10 20:36:12 +02002298#endif
Gilles Peskine20035e32018-02-03 22:44:14 +01002299
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002300psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
2301{
2302 switch( operation->alg )
2303 {
Gilles Peskine81736312018-06-26 15:04:31 +02002304 case 0:
2305 /* The object has (apparently) been initialized but it is not
2306 * in use. It's ok to call abort on such an object, and there's
2307 * nothing to do. */
2308 break;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002309#if defined(MBEDTLS_MD2_C)
2310 case PSA_ALG_MD2:
2311 mbedtls_md2_free( &operation->ctx.md2 );
2312 break;
2313#endif
2314#if defined(MBEDTLS_MD4_C)
2315 case PSA_ALG_MD4:
2316 mbedtls_md4_free( &operation->ctx.md4 );
2317 break;
2318#endif
2319#if defined(MBEDTLS_MD5_C)
2320 case PSA_ALG_MD5:
2321 mbedtls_md5_free( &operation->ctx.md5 );
2322 break;
2323#endif
2324#if defined(MBEDTLS_RIPEMD160_C)
2325 case PSA_ALG_RIPEMD160:
2326 mbedtls_ripemd160_free( &operation->ctx.ripemd160 );
2327 break;
2328#endif
2329#if defined(MBEDTLS_SHA1_C)
2330 case PSA_ALG_SHA_1:
2331 mbedtls_sha1_free( &operation->ctx.sha1 );
2332 break;
2333#endif
2334#if defined(MBEDTLS_SHA256_C)
2335 case PSA_ALG_SHA_224:
2336 case PSA_ALG_SHA_256:
2337 mbedtls_sha256_free( &operation->ctx.sha256 );
2338 break;
2339#endif
2340#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002341#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002342 case PSA_ALG_SHA_384:
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002343#endif
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002344 case PSA_ALG_SHA_512:
2345 mbedtls_sha512_free( &operation->ctx.sha512 );
2346 break;
2347#endif
2348 default:
Gilles Peskinef9c2c092018-06-21 16:57:07 +02002349 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002350 }
2351 operation->alg = 0;
2352 return( PSA_SUCCESS );
2353}
2354
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002355psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002356 psa_algorithm_t alg )
2357{
Janos Follath24eed8d2019-11-22 13:21:35 +00002358 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002359
2360 /* A context must be freshly initialized before it can be set up. */
2361 if( operation->alg != 0 )
2362 {
2363 return( PSA_ERROR_BAD_STATE );
2364 }
2365
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002366 switch( alg )
2367 {
2368#if defined(MBEDTLS_MD2_C)
2369 case PSA_ALG_MD2:
2370 mbedtls_md2_init( &operation->ctx.md2 );
2371 ret = mbedtls_md2_starts_ret( &operation->ctx.md2 );
2372 break;
2373#endif
2374#if defined(MBEDTLS_MD4_C)
2375 case PSA_ALG_MD4:
2376 mbedtls_md4_init( &operation->ctx.md4 );
2377 ret = mbedtls_md4_starts_ret( &operation->ctx.md4 );
2378 break;
2379#endif
2380#if defined(MBEDTLS_MD5_C)
2381 case PSA_ALG_MD5:
2382 mbedtls_md5_init( &operation->ctx.md5 );
2383 ret = mbedtls_md5_starts_ret( &operation->ctx.md5 );
2384 break;
2385#endif
2386#if defined(MBEDTLS_RIPEMD160_C)
2387 case PSA_ALG_RIPEMD160:
2388 mbedtls_ripemd160_init( &operation->ctx.ripemd160 );
2389 ret = mbedtls_ripemd160_starts_ret( &operation->ctx.ripemd160 );
2390 break;
2391#endif
2392#if defined(MBEDTLS_SHA1_C)
2393 case PSA_ALG_SHA_1:
2394 mbedtls_sha1_init( &operation->ctx.sha1 );
2395 ret = mbedtls_sha1_starts_ret( &operation->ctx.sha1 );
2396 break;
2397#endif
2398#if defined(MBEDTLS_SHA256_C)
2399 case PSA_ALG_SHA_224:
2400 mbedtls_sha256_init( &operation->ctx.sha256 );
2401 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 1 );
2402 break;
2403 case PSA_ALG_SHA_256:
2404 mbedtls_sha256_init( &operation->ctx.sha256 );
2405 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 0 );
2406 break;
2407#endif
2408#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002409#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002410 case PSA_ALG_SHA_384:
2411 mbedtls_sha512_init( &operation->ctx.sha512 );
2412 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 1 );
2413 break;
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002414#endif
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002415 case PSA_ALG_SHA_512:
2416 mbedtls_sha512_init( &operation->ctx.sha512 );
2417 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 0 );
2418 break;
2419#endif
2420 default:
Gilles Peskinec06e0712018-06-20 16:21:04 +02002421 return( PSA_ALG_IS_HASH( alg ) ?
2422 PSA_ERROR_NOT_SUPPORTED :
2423 PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002424 }
2425 if( ret == 0 )
2426 operation->alg = alg;
2427 else
2428 psa_hash_abort( operation );
2429 return( mbedtls_to_psa_error( ret ) );
2430}
2431
2432psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2433 const uint8_t *input,
2434 size_t input_length )
2435{
Janos Follath24eed8d2019-11-22 13:21:35 +00002436 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine94e44542018-07-12 16:58:43 +02002437
2438 /* Don't require hash implementations to behave correctly on a
2439 * zero-length input, which may have an invalid pointer. */
2440 if( input_length == 0 )
2441 return( PSA_SUCCESS );
2442
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002443 switch( operation->alg )
2444 {
2445#if defined(MBEDTLS_MD2_C)
2446 case PSA_ALG_MD2:
2447 ret = mbedtls_md2_update_ret( &operation->ctx.md2,
2448 input, input_length );
2449 break;
2450#endif
2451#if defined(MBEDTLS_MD4_C)
2452 case PSA_ALG_MD4:
2453 ret = mbedtls_md4_update_ret( &operation->ctx.md4,
2454 input, input_length );
2455 break;
2456#endif
2457#if defined(MBEDTLS_MD5_C)
2458 case PSA_ALG_MD5:
2459 ret = mbedtls_md5_update_ret( &operation->ctx.md5,
2460 input, input_length );
2461 break;
2462#endif
2463#if defined(MBEDTLS_RIPEMD160_C)
2464 case PSA_ALG_RIPEMD160:
2465 ret = mbedtls_ripemd160_update_ret( &operation->ctx.ripemd160,
2466 input, input_length );
2467 break;
2468#endif
2469#if defined(MBEDTLS_SHA1_C)
2470 case PSA_ALG_SHA_1:
2471 ret = mbedtls_sha1_update_ret( &operation->ctx.sha1,
2472 input, input_length );
2473 break;
2474#endif
2475#if defined(MBEDTLS_SHA256_C)
2476 case PSA_ALG_SHA_224:
2477 case PSA_ALG_SHA_256:
2478 ret = mbedtls_sha256_update_ret( &operation->ctx.sha256,
2479 input, input_length );
2480 break;
2481#endif
2482#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002483#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002484 case PSA_ALG_SHA_384:
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002485#endif
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002486 case PSA_ALG_SHA_512:
2487 ret = mbedtls_sha512_update_ret( &operation->ctx.sha512,
2488 input, input_length );
2489 break;
2490#endif
2491 default:
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002492 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002493 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002494
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002495 if( ret != 0 )
2496 psa_hash_abort( operation );
2497 return( mbedtls_to_psa_error( ret ) );
2498}
2499
2500psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2501 uint8_t *hash,
2502 size_t hash_size,
2503 size_t *hash_length )
2504{
itayzafrir40835d42018-08-02 13:14:17 +03002505 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00002506 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine71bb7b72018-04-19 08:29:59 +02002507 size_t actual_hash_length = PSA_HASH_SIZE( operation->alg );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002508
2509 /* Fill the output buffer with something that isn't a valid hash
2510 * (barring an attack on the hash and deliberately-crafted input),
2511 * in case the caller doesn't check the return status properly. */
Gilles Peskineaee13332018-07-02 12:15:28 +02002512 *hash_length = hash_size;
Gilles Peskine46f1fd72018-06-28 19:31:31 +02002513 /* If hash_size is 0 then hash may be NULL and then the
2514 * call to memset would have undefined behavior. */
2515 if( hash_size != 0 )
2516 memset( hash, '!', hash_size );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002517
2518 if( hash_size < actual_hash_length )
itayzafrir40835d42018-08-02 13:14:17 +03002519 {
2520 status = PSA_ERROR_BUFFER_TOO_SMALL;
2521 goto exit;
2522 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002523
2524 switch( operation->alg )
2525 {
2526#if defined(MBEDTLS_MD2_C)
2527 case PSA_ALG_MD2:
2528 ret = mbedtls_md2_finish_ret( &operation->ctx.md2, hash );
2529 break;
2530#endif
2531#if defined(MBEDTLS_MD4_C)
2532 case PSA_ALG_MD4:
2533 ret = mbedtls_md4_finish_ret( &operation->ctx.md4, hash );
2534 break;
2535#endif
2536#if defined(MBEDTLS_MD5_C)
2537 case PSA_ALG_MD5:
2538 ret = mbedtls_md5_finish_ret( &operation->ctx.md5, hash );
2539 break;
2540#endif
2541#if defined(MBEDTLS_RIPEMD160_C)
2542 case PSA_ALG_RIPEMD160:
2543 ret = mbedtls_ripemd160_finish_ret( &operation->ctx.ripemd160, hash );
2544 break;
2545#endif
2546#if defined(MBEDTLS_SHA1_C)
2547 case PSA_ALG_SHA_1:
2548 ret = mbedtls_sha1_finish_ret( &operation->ctx.sha1, hash );
2549 break;
2550#endif
2551#if defined(MBEDTLS_SHA256_C)
2552 case PSA_ALG_SHA_224:
2553 case PSA_ALG_SHA_256:
2554 ret = mbedtls_sha256_finish_ret( &operation->ctx.sha256, hash );
2555 break;
2556#endif
2557#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002558#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002559 case PSA_ALG_SHA_384:
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002560#endif
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002561 case PSA_ALG_SHA_512:
2562 ret = mbedtls_sha512_finish_ret( &operation->ctx.sha512, hash );
2563 break;
2564#endif
2565 default:
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002566 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002567 }
itayzafrir40835d42018-08-02 13:14:17 +03002568 status = mbedtls_to_psa_error( ret );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002569
itayzafrir40835d42018-08-02 13:14:17 +03002570exit:
2571 if( status == PSA_SUCCESS )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002572 {
Gilles Peskineaee13332018-07-02 12:15:28 +02002573 *hash_length = actual_hash_length;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002574 return( psa_hash_abort( operation ) );
2575 }
2576 else
2577 {
2578 psa_hash_abort( operation );
itayzafrir40835d42018-08-02 13:14:17 +03002579 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002580 }
2581}
2582
Gilles Peskine2d277862018-06-18 15:41:12 +02002583psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2584 const uint8_t *hash,
2585 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002586{
2587 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2588 size_t actual_hash_length;
2589 psa_status_t status = psa_hash_finish( operation,
2590 actual_hash, sizeof( actual_hash ),
2591 &actual_hash_length );
2592 if( status != PSA_SUCCESS )
2593 return( status );
2594 if( actual_hash_length != hash_length )
2595 return( PSA_ERROR_INVALID_SIGNATURE );
2596 if( safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
2597 return( PSA_ERROR_INVALID_SIGNATURE );
2598 return( PSA_SUCCESS );
2599}
2600
Gilles Peskine0a749c82019-11-28 19:33:58 +01002601psa_status_t psa_hash_compute( psa_algorithm_t alg,
2602 const uint8_t *input, size_t input_length,
2603 uint8_t *hash, size_t hash_size,
2604 size_t *hash_length )
2605{
2606 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
2607 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2608
2609 *hash_length = hash_size;
2610 status = psa_hash_setup( &operation, alg );
2611 if( status != PSA_SUCCESS )
2612 goto exit;
2613 status = psa_hash_update( &operation, input, input_length );
2614 if( status != PSA_SUCCESS )
2615 goto exit;
2616 status = psa_hash_finish( &operation, hash, hash_size, hash_length );
2617 if( status != PSA_SUCCESS )
2618 goto exit;
2619
2620exit:
2621 if( status == PSA_SUCCESS )
2622 status = psa_hash_abort( &operation );
2623 else
2624 psa_hash_abort( &operation );
2625 return( status );
2626}
2627
2628psa_status_t psa_hash_compare( psa_algorithm_t alg,
2629 const uint8_t *input, size_t input_length,
2630 const uint8_t *hash, size_t hash_length )
2631{
2632 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
2633 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2634
2635 status = psa_hash_setup( &operation, alg );
2636 if( status != PSA_SUCCESS )
2637 goto exit;
2638 status = psa_hash_update( &operation, input, input_length );
2639 if( status != PSA_SUCCESS )
2640 goto exit;
2641 status = psa_hash_verify( &operation, hash, hash_length );
2642 if( status != PSA_SUCCESS )
2643 goto exit;
2644
2645exit:
2646 if( status == PSA_SUCCESS )
2647 status = psa_hash_abort( &operation );
2648 else
2649 psa_hash_abort( &operation );
2650 return( status );
2651}
2652
Gilles Peskineeb35d782019-01-22 17:56:16 +01002653psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2654 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002655{
2656 if( target_operation->alg != 0 )
2657 return( PSA_ERROR_BAD_STATE );
2658
2659 switch( source_operation->alg )
2660 {
2661 case 0:
2662 return( PSA_ERROR_BAD_STATE );
2663#if defined(MBEDTLS_MD2_C)
2664 case PSA_ALG_MD2:
2665 mbedtls_md2_clone( &target_operation->ctx.md2,
2666 &source_operation->ctx.md2 );
2667 break;
2668#endif
2669#if defined(MBEDTLS_MD4_C)
2670 case PSA_ALG_MD4:
2671 mbedtls_md4_clone( &target_operation->ctx.md4,
2672 &source_operation->ctx.md4 );
2673 break;
2674#endif
2675#if defined(MBEDTLS_MD5_C)
2676 case PSA_ALG_MD5:
2677 mbedtls_md5_clone( &target_operation->ctx.md5,
2678 &source_operation->ctx.md5 );
2679 break;
2680#endif
2681#if defined(MBEDTLS_RIPEMD160_C)
2682 case PSA_ALG_RIPEMD160:
2683 mbedtls_ripemd160_clone( &target_operation->ctx.ripemd160,
2684 &source_operation->ctx.ripemd160 );
2685 break;
2686#endif
2687#if defined(MBEDTLS_SHA1_C)
2688 case PSA_ALG_SHA_1:
2689 mbedtls_sha1_clone( &target_operation->ctx.sha1,
2690 &source_operation->ctx.sha1 );
2691 break;
2692#endif
2693#if defined(MBEDTLS_SHA256_C)
2694 case PSA_ALG_SHA_224:
2695 case PSA_ALG_SHA_256:
2696 mbedtls_sha256_clone( &target_operation->ctx.sha256,
2697 &source_operation->ctx.sha256 );
2698 break;
2699#endif
2700#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002701#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002702 case PSA_ALG_SHA_384:
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002703#endif
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002704 case PSA_ALG_SHA_512:
2705 mbedtls_sha512_clone( &target_operation->ctx.sha512,
2706 &source_operation->ctx.sha512 );
2707 break;
2708#endif
2709 default:
2710 return( PSA_ERROR_NOT_SUPPORTED );
2711 }
2712
2713 target_operation->alg = source_operation->alg;
2714 return( PSA_SUCCESS );
2715}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002716
2717
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002718/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002719/* MAC */
2720/****************************************************************/
2721
Gilles Peskinedc2fc842018-03-07 16:42:59 +01002722static const mbedtls_cipher_info_t *mbedtls_cipher_info_from_psa(
Gilles Peskine8c9def32018-02-08 10:02:12 +01002723 psa_algorithm_t alg,
2724 psa_key_type_t key_type,
Gilles Peskine2d277862018-06-18 15:41:12 +02002725 size_t key_bits,
mohammad1603f4f0d612018-06-03 15:04:51 +03002726 mbedtls_cipher_id_t* cipher_id )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002727{
Gilles Peskine8c9def32018-02-08 10:02:12 +01002728 mbedtls_cipher_mode_t mode;
mohammad1603f4f0d612018-06-03 15:04:51 +03002729 mbedtls_cipher_id_t cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002730
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002731 if( PSA_ALG_IS_AEAD( alg ) )
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002732 alg = PSA_ALG_AEAD_WITH_TAG_LENGTH( alg, 0 );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002733
Gilles Peskine8c9def32018-02-08 10:02:12 +01002734 if( PSA_ALG_IS_CIPHER( alg ) || PSA_ALG_IS_AEAD( alg ) )
2735 {
Nir Sonnenscheine9664c32018-06-17 14:41:30 +03002736 switch( alg )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002737 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002738 case PSA_ALG_ARC4:
Gilles Peskine26869f22019-05-06 15:25:00 +02002739 case PSA_ALG_CHACHA20:
Gilles Peskine8c9def32018-02-08 10:02:12 +01002740 mode = MBEDTLS_MODE_STREAM;
2741 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002742 case PSA_ALG_CTR:
2743 mode = MBEDTLS_MODE_CTR;
2744 break;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002745 case PSA_ALG_CFB:
2746 mode = MBEDTLS_MODE_CFB;
2747 break;
2748 case PSA_ALG_OFB:
2749 mode = MBEDTLS_MODE_OFB;
2750 break;
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02002751 case PSA_ALG_ECB_NO_PADDING:
2752 mode = MBEDTLS_MODE_ECB;
2753 break;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002754 case PSA_ALG_CBC_NO_PADDING:
2755 mode = MBEDTLS_MODE_CBC;
2756 break;
2757 case PSA_ALG_CBC_PKCS7:
2758 mode = MBEDTLS_MODE_CBC;
2759 break;
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002760 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002761 mode = MBEDTLS_MODE_CCM;
2762 break;
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002763 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_GCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002764 mode = MBEDTLS_MODE_GCM;
2765 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02002766 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CHACHA20_POLY1305, 0 ):
2767 mode = MBEDTLS_MODE_CHACHAPOLY;
2768 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002769 default:
2770 return( NULL );
2771 }
2772 }
2773 else if( alg == PSA_ALG_CMAC )
2774 mode = MBEDTLS_MODE_ECB;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002775 else
2776 return( NULL );
2777
2778 switch( key_type )
2779 {
2780 case PSA_KEY_TYPE_AES:
mohammad1603f4f0d612018-06-03 15:04:51 +03002781 cipher_id_tmp = MBEDTLS_CIPHER_ID_AES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002782 break;
2783 case PSA_KEY_TYPE_DES:
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002784 /* key_bits is 64 for Single-DES, 128 for two-key Triple-DES,
2785 * and 192 for three-key Triple-DES. */
Gilles Peskine8c9def32018-02-08 10:02:12 +01002786 if( key_bits == 64 )
mohammad1603f4f0d612018-06-03 15:04:51 +03002787 cipher_id_tmp = MBEDTLS_CIPHER_ID_DES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002788 else
mohammad1603f4f0d612018-06-03 15:04:51 +03002789 cipher_id_tmp = MBEDTLS_CIPHER_ID_3DES;
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002790 /* mbedtls doesn't recognize two-key Triple-DES as an algorithm,
2791 * but two-key Triple-DES is functionally three-key Triple-DES
2792 * with K1=K3, so that's how we present it to mbedtls. */
2793 if( key_bits == 128 )
2794 key_bits = 192;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002795 break;
2796 case PSA_KEY_TYPE_CAMELLIA:
mohammad1603f4f0d612018-06-03 15:04:51 +03002797 cipher_id_tmp = MBEDTLS_CIPHER_ID_CAMELLIA;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002798 break;
2799 case PSA_KEY_TYPE_ARC4:
mohammad1603f4f0d612018-06-03 15:04:51 +03002800 cipher_id_tmp = MBEDTLS_CIPHER_ID_ARC4;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002801 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02002802 case PSA_KEY_TYPE_CHACHA20:
2803 cipher_id_tmp = MBEDTLS_CIPHER_ID_CHACHA20;
2804 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002805 default:
2806 return( NULL );
2807 }
mohammad1603f4f0d612018-06-03 15:04:51 +03002808 if( cipher_id != NULL )
mohammad160360a64d02018-06-03 17:20:42 +03002809 *cipher_id = cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002810
Jaeden Amero23bbb752018-06-26 14:16:54 +01002811 return( mbedtls_cipher_info_from_values( cipher_id_tmp,
2812 (int) key_bits, mode ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002813}
2814
Gilles Peskinea05219c2018-11-16 16:02:56 +01002815#if defined(MBEDTLS_MD_C)
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002816static size_t psa_get_hash_block_size( psa_algorithm_t alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002817{
Gilles Peskine2d277862018-06-18 15:41:12 +02002818 switch( alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002819 {
2820 case PSA_ALG_MD2:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002821 return( 16 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002822 case PSA_ALG_MD4:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002823 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002824 case PSA_ALG_MD5:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002825 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002826 case PSA_ALG_RIPEMD160:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002827 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002828 case PSA_ALG_SHA_1:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002829 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002830 case PSA_ALG_SHA_224:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002831 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002832 case PSA_ALG_SHA_256:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002833 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002834 case PSA_ALG_SHA_384:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002835 return( 128 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002836 case PSA_ALG_SHA_512:
Gilles Peskine2d277862018-06-18 15:41:12 +02002837 return( 128 );
2838 default:
2839 return( 0 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002840 }
2841}
Gilles Peskinea05219c2018-11-16 16:02:56 +01002842#endif /* MBEDTLS_MD_C */
Nir Sonnenschein0c9ec532018-06-07 13:27:47 +03002843
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002844/* Initialize the MAC operation structure. Once this function has been
2845 * called, psa_mac_abort can run and will do the right thing. */
2846static psa_status_t psa_mac_init( psa_mac_operation_t *operation,
2847 psa_algorithm_t alg )
2848{
2849 psa_status_t status = PSA_ERROR_NOT_SUPPORTED;
2850
2851 operation->alg = alg;
2852 operation->key_set = 0;
2853 operation->iv_set = 0;
2854 operation->iv_required = 0;
2855 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002856 operation->is_sign = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002857
2858#if defined(MBEDTLS_CMAC_C)
2859 if( alg == PSA_ALG_CMAC )
2860 {
2861 operation->iv_required = 0;
2862 mbedtls_cipher_init( &operation->ctx.cmac );
2863 status = PSA_SUCCESS;
2864 }
2865 else
2866#endif /* MBEDTLS_CMAC_C */
2867#if defined(MBEDTLS_MD_C)
2868 if( PSA_ALG_IS_HMAC( operation->alg ) )
2869 {
Gilles Peskineff94abd2018-07-12 17:07:52 +02002870 /* We'll set up the hash operation later in psa_hmac_setup_internal. */
2871 operation->ctx.hmac.hash_ctx.alg = 0;
2872 status = PSA_SUCCESS;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002873 }
2874 else
2875#endif /* MBEDTLS_MD_C */
2876 {
Gilles Peskinec06e0712018-06-20 16:21:04 +02002877 if( ! PSA_ALG_IS_MAC( alg ) )
2878 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002879 }
2880
2881 if( status != PSA_SUCCESS )
2882 memset( operation, 0, sizeof( *operation ) );
2883 return( status );
2884}
2885
Gilles Peskine01126fa2018-07-12 17:04:55 +02002886#if defined(MBEDTLS_MD_C)
2887static psa_status_t psa_hmac_abort_internal( psa_hmac_internal_data *hmac )
2888{
Gilles Peskine3f108122018-12-07 18:14:53 +01002889 mbedtls_platform_zeroize( hmac->opad, sizeof( hmac->opad ) );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002890 return( psa_hash_abort( &hmac->hash_ctx ) );
2891}
2892#endif /* MBEDTLS_MD_C */
2893
Gilles Peskine8c9def32018-02-08 10:02:12 +01002894psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
2895{
Gilles Peskinefbfac682018-07-08 20:51:54 +02002896 if( operation->alg == 0 )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002897 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02002898 /* The object has (apparently) been initialized but it is not
2899 * in use. It's ok to call abort on such an object, and there's
2900 * nothing to do. */
2901 return( PSA_SUCCESS );
2902 }
2903 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002904#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002905 if( operation->alg == PSA_ALG_CMAC )
2906 {
2907 mbedtls_cipher_free( &operation->ctx.cmac );
2908 }
2909 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002910#endif /* MBEDTLS_CMAC_C */
Gilles Peskine8c9def32018-02-08 10:02:12 +01002911#if defined(MBEDTLS_MD_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002912 if( PSA_ALG_IS_HMAC( operation->alg ) )
2913 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02002914 psa_hmac_abort_internal( &operation->ctx.hmac );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002915 }
2916 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002917#endif /* MBEDTLS_MD_C */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002918 {
2919 /* Sanity check (shouldn't happen: operation->alg should
2920 * always have been initialized to a valid value). */
2921 goto bad_state;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002922 }
Moran Peker41deec42018-04-04 15:43:05 +03002923
Gilles Peskine8c9def32018-02-08 10:02:12 +01002924 operation->alg = 0;
2925 operation->key_set = 0;
2926 operation->iv_set = 0;
2927 operation->iv_required = 0;
2928 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002929 operation->is_sign = 0;
Moran Peker41deec42018-04-04 15:43:05 +03002930
Gilles Peskine8c9def32018-02-08 10:02:12 +01002931 return( PSA_SUCCESS );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002932
2933bad_state:
2934 /* If abort is called on an uninitialized object, we can't trust
2935 * anything. Wipe the object in case it contains confidential data.
2936 * This may result in a memory leak if a pointer gets overwritten,
2937 * but it's too late to do anything about this. */
2938 memset( operation, 0, sizeof( *operation ) );
2939 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002940}
2941
Gilles Peskinee3b07d82018-06-19 11:57:35 +02002942#if defined(MBEDTLS_CMAC_C)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002943static int psa_cmac_setup( psa_mac_operation_t *operation,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002944 size_t key_bits,
Gilles Peskine2f060a82018-12-04 17:12:32 +01002945 psa_key_slot_t *slot,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002946 const mbedtls_cipher_info_t *cipher_info )
2947{
Janos Follath24eed8d2019-11-22 13:21:35 +00002948 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002949
2950 operation->mac_size = cipher_info->block_size;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002951
2952 ret = mbedtls_cipher_setup( &operation->ctx.cmac, cipher_info );
2953 if( ret != 0 )
2954 return( ret );
2955
2956 ret = mbedtls_cipher_cmac_starts( &operation->ctx.cmac,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02002957 slot->data.key.data,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002958 key_bits );
2959 return( ret );
2960}
Gilles Peskinee3b07d82018-06-19 11:57:35 +02002961#endif /* MBEDTLS_CMAC_C */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002962
Gilles Peskine248051a2018-06-20 16:09:38 +02002963#if defined(MBEDTLS_MD_C)
Gilles Peskine01126fa2018-07-12 17:04:55 +02002964static psa_status_t psa_hmac_setup_internal( psa_hmac_internal_data *hmac,
2965 const uint8_t *key,
2966 size_t key_length,
2967 psa_algorithm_t hash_alg )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002968{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02002969 uint8_t ipad[PSA_HMAC_MAX_HASH_BLOCK_SIZE];
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002970 size_t i;
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002971 size_t hash_size = PSA_HASH_SIZE( hash_alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002972 size_t block_size = psa_get_hash_block_size( hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002973 psa_status_t status;
2974
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002975 /* Sanity checks on block_size, to guarantee that there won't be a buffer
2976 * overflow below. This should never trigger if the hash algorithm
2977 * is implemented correctly. */
2978 /* The size checks against the ipad and opad buffers cannot be written
2979 * `block_size > sizeof( ipad ) || block_size > sizeof( hmac->opad )`
2980 * because that triggers -Wlogical-op on GCC 7.3. */
2981 if( block_size > sizeof( ipad ) )
2982 return( PSA_ERROR_NOT_SUPPORTED );
2983 if( block_size > sizeof( hmac->opad ) )
2984 return( PSA_ERROR_NOT_SUPPORTED );
2985 if( block_size < hash_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002986 return( PSA_ERROR_NOT_SUPPORTED );
2987
Gilles Peskined223b522018-06-11 18:12:58 +02002988 if( key_length > block_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002989 {
Gilles Peskine84b8fc82019-11-28 20:07:20 +01002990 status = psa_hash_compute( hash_alg, key, key_length,
2991 ipad, sizeof( ipad ), &key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002992 if( status != PSA_SUCCESS )
Gilles Peskineb8be2882018-07-17 16:24:34 +02002993 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002994 }
Gilles Peskine96889972018-07-12 17:07:03 +02002995 /* A 0-length key is not commonly used in HMAC when used as a MAC,
2996 * but it is permitted. It is common when HMAC is used in HKDF, for
2997 * example. Don't call `memcpy` in the 0-length because `key` could be
2998 * an invalid pointer which would make the behavior undefined. */
2999 else if( key_length != 0 )
Gilles Peskine01126fa2018-07-12 17:04:55 +02003000 memcpy( ipad, key, key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003001
Gilles Peskined223b522018-06-11 18:12:58 +02003002 /* ipad contains the key followed by garbage. Xor and fill with 0x36
3003 * to create the ipad value. */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003004 for( i = 0; i < key_length; i++ )
Gilles Peskined223b522018-06-11 18:12:58 +02003005 ipad[i] ^= 0x36;
3006 memset( ipad + key_length, 0x36, block_size - key_length );
3007
3008 /* Copy the key material from ipad to opad, flipping the requisite bits,
3009 * and filling the rest of opad with the requisite constant. */
3010 for( i = 0; i < key_length; i++ )
Gilles Peskine01126fa2018-07-12 17:04:55 +02003011 hmac->opad[i] = ipad[i] ^ 0x36 ^ 0x5C;
3012 memset( hmac->opad + key_length, 0x5C, block_size - key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003013
Gilles Peskine01126fa2018-07-12 17:04:55 +02003014 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003015 if( status != PSA_SUCCESS )
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003016 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003017
Gilles Peskine01126fa2018-07-12 17:04:55 +02003018 status = psa_hash_update( &hmac->hash_ctx, ipad, block_size );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003019
3020cleanup:
Steven Cooreman29149862020-08-05 15:43:42 +02003021 mbedtls_platform_zeroize( ipad, sizeof( ipad ) );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003022
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003023 return( status );
3024}
Gilles Peskine248051a2018-06-20 16:09:38 +02003025#endif /* MBEDTLS_MD_C */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003026
Gilles Peskine89167cb2018-07-08 20:12:23 +02003027static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01003028 psa_key_handle_t handle,
Gilles Peskine89167cb2018-07-08 20:12:23 +02003029 psa_algorithm_t alg,
3030 int is_sign )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003031{
Gilles Peskine8c9def32018-02-08 10:02:12 +01003032 psa_status_t status;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003033 psa_key_slot_t *slot;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003034 size_t key_bits;
Gilles Peskine89167cb2018-07-08 20:12:23 +02003035 psa_key_usage_t usage =
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003036 is_sign ? PSA_KEY_USAGE_SIGN_HASH : PSA_KEY_USAGE_VERIFY_HASH;
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02003037 uint8_t truncated = PSA_MAC_TRUNCATED_LENGTH( alg );
Gilles Peskinee0e9c7c2018-10-17 18:28:05 +02003038 psa_algorithm_t full_length_alg = PSA_ALG_FULL_LENGTH_MAC( alg );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003039
Jaeden Amero36ee5d02019-02-19 09:25:10 +00003040 /* A context must be freshly initialized before it can be set up. */
3041 if( operation->alg != 0 )
3042 {
3043 return( PSA_ERROR_BAD_STATE );
3044 }
3045
Gilles Peskined911eb72018-08-14 15:18:45 +02003046 status = psa_mac_init( operation, full_length_alg );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003047 if( status != PSA_SUCCESS )
3048 return( status );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003049 if( is_sign )
3050 operation->is_sign = 1;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003051
Gilles Peskine28f8f302019-07-24 13:30:31 +02003052 status = psa_get_transparent_key( handle, &slot, usage, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003053 if( status != PSA_SUCCESS )
Gilles Peskinefbfac682018-07-08 20:51:54 +02003054 goto exit;
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02003055 key_bits = psa_get_key_slot_bits( slot );
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02003056
Gilles Peskine8c9def32018-02-08 10:02:12 +01003057#if defined(MBEDTLS_CMAC_C)
Gilles Peskined911eb72018-08-14 15:18:45 +02003058 if( full_length_alg == PSA_ALG_CMAC )
Gilles Peskinefbfac682018-07-08 20:51:54 +02003059 {
3060 const mbedtls_cipher_info_t *cipher_info =
Gilles Peskined911eb72018-08-14 15:18:45 +02003061 mbedtls_cipher_info_from_psa( full_length_alg,
Gilles Peskine8e338702019-07-30 20:06:31 +02003062 slot->attr.type, key_bits, NULL );
Janos Follath24eed8d2019-11-22 13:21:35 +00003063 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinefbfac682018-07-08 20:51:54 +02003064 if( cipher_info == NULL )
3065 {
3066 status = PSA_ERROR_NOT_SUPPORTED;
3067 goto exit;
3068 }
3069 operation->mac_size = cipher_info->block_size;
3070 ret = psa_cmac_setup( operation, key_bits, slot, cipher_info );
3071 status = mbedtls_to_psa_error( ret );
3072 }
3073 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01003074#endif /* MBEDTLS_CMAC_C */
Gilles Peskine8c9def32018-02-08 10:02:12 +01003075#if defined(MBEDTLS_MD_C)
Gilles Peskined911eb72018-08-14 15:18:45 +02003076 if( PSA_ALG_IS_HMAC( full_length_alg ) )
Gilles Peskinefbfac682018-07-08 20:51:54 +02003077 {
Gilles Peskine00709fa2018-08-22 18:25:41 +02003078 psa_algorithm_t hash_alg = PSA_ALG_HMAC_GET_HASH( alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003079 if( hash_alg == 0 )
3080 {
3081 status = PSA_ERROR_NOT_SUPPORTED;
3082 goto exit;
3083 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02003084
3085 operation->mac_size = PSA_HASH_SIZE( hash_alg );
3086 /* Sanity check. This shouldn't fail on a valid configuration. */
3087 if( operation->mac_size == 0 ||
3088 operation->mac_size > sizeof( operation->ctx.hmac.opad ) )
3089 {
3090 status = PSA_ERROR_NOT_SUPPORTED;
3091 goto exit;
3092 }
3093
Gilles Peskine8e338702019-07-30 20:06:31 +02003094 if( slot->attr.type != PSA_KEY_TYPE_HMAC )
Gilles Peskine01126fa2018-07-12 17:04:55 +02003095 {
3096 status = PSA_ERROR_INVALID_ARGUMENT;
3097 goto exit;
3098 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02003099
Gilles Peskine01126fa2018-07-12 17:04:55 +02003100 status = psa_hmac_setup_internal( &operation->ctx.hmac,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02003101 slot->data.key.data,
3102 slot->data.key.bytes,
Gilles Peskine01126fa2018-07-12 17:04:55 +02003103 hash_alg );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003104 }
3105 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01003106#endif /* MBEDTLS_MD_C */
Gilles Peskinefbfac682018-07-08 20:51:54 +02003107 {
Jaeden Amero82df32e2018-11-23 15:11:20 +00003108 (void) key_bits;
Gilles Peskinefbfac682018-07-08 20:51:54 +02003109 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003110 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003111
Gilles Peskined911eb72018-08-14 15:18:45 +02003112 if( truncated == 0 )
3113 {
3114 /* The "normal" case: untruncated algorithm. Nothing to do. */
3115 }
3116 else if( truncated < 4 )
3117 {
Gilles Peskine6d72ff92018-08-21 14:55:08 +02003118 /* A very short MAC is too short for security since it can be
3119 * brute-forced. Ancient protocols with 32-bit MACs do exist,
3120 * so we make this our minimum, even though 32 bits is still
3121 * too small for security. */
Gilles Peskined911eb72018-08-14 15:18:45 +02003122 status = PSA_ERROR_NOT_SUPPORTED;
3123 }
3124 else if( truncated > operation->mac_size )
3125 {
3126 /* It's impossible to "truncate" to a larger length. */
3127 status = PSA_ERROR_INVALID_ARGUMENT;
3128 }
3129 else
3130 operation->mac_size = truncated;
3131
Gilles Peskinefbfac682018-07-08 20:51:54 +02003132exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003133 if( status != PSA_SUCCESS )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003134 {
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003135 psa_mac_abort( operation );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003136 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003137 else
3138 {
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003139 operation->key_set = 1;
3140 }
3141 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003142}
3143
Gilles Peskine89167cb2018-07-08 20:12:23 +02003144psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01003145 psa_key_handle_t handle,
Gilles Peskine89167cb2018-07-08 20:12:23 +02003146 psa_algorithm_t alg )
3147{
Gilles Peskinec5487a82018-12-03 18:08:14 +01003148 return( psa_mac_setup( operation, handle, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003149}
3150
3151psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01003152 psa_key_handle_t handle,
Gilles Peskine89167cb2018-07-08 20:12:23 +02003153 psa_algorithm_t alg )
3154{
Gilles Peskinec5487a82018-12-03 18:08:14 +01003155 return( psa_mac_setup( operation, handle, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003156}
3157
Gilles Peskine8c9def32018-02-08 10:02:12 +01003158psa_status_t psa_mac_update( psa_mac_operation_t *operation,
3159 const uint8_t *input,
3160 size_t input_length )
3161{
Gilles Peskinefbfac682018-07-08 20:51:54 +02003162 psa_status_t status = PSA_ERROR_BAD_STATE;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003163 if( ! operation->key_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003164 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003165 if( operation->iv_required && ! operation->iv_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003166 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003167 operation->has_input = 1;
3168
Gilles Peskine8c9def32018-02-08 10:02:12 +01003169#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003170 if( operation->alg == PSA_ALG_CMAC )
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03003171 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02003172 int ret = mbedtls_cipher_cmac_update( &operation->ctx.cmac,
3173 input, input_length );
3174 status = mbedtls_to_psa_error( ret );
3175 }
3176 else
3177#endif /* MBEDTLS_CMAC_C */
3178#if defined(MBEDTLS_MD_C)
3179 if( PSA_ALG_IS_HMAC( operation->alg ) )
3180 {
3181 status = psa_hash_update( &operation->ctx.hmac.hash_ctx, input,
3182 input_length );
3183 }
3184 else
3185#endif /* MBEDTLS_MD_C */
3186 {
3187 /* This shouldn't happen if `operation` was initialized by
3188 * a setup function. */
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003189 return( PSA_ERROR_BAD_STATE );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03003190 }
3191
Gilles Peskinefbfac682018-07-08 20:51:54 +02003192 if( status != PSA_SUCCESS )
3193 psa_mac_abort( operation );
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02003194 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003195}
3196
Gilles Peskine01126fa2018-07-12 17:04:55 +02003197#if defined(MBEDTLS_MD_C)
3198static psa_status_t psa_hmac_finish_internal( psa_hmac_internal_data *hmac,
3199 uint8_t *mac,
3200 size_t mac_size )
3201{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02003202 uint8_t tmp[MBEDTLS_MD_MAX_SIZE];
Gilles Peskine01126fa2018-07-12 17:04:55 +02003203 psa_algorithm_t hash_alg = hmac->hash_ctx.alg;
3204 size_t hash_size = 0;
3205 size_t block_size = psa_get_hash_block_size( hash_alg );
3206 psa_status_t status;
3207
Gilles Peskine01126fa2018-07-12 17:04:55 +02003208 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
3209 if( status != PSA_SUCCESS )
3210 return( status );
3211 /* From here on, tmp needs to be wiped. */
3212
3213 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
3214 if( status != PSA_SUCCESS )
3215 goto exit;
3216
3217 status = psa_hash_update( &hmac->hash_ctx, hmac->opad, block_size );
3218 if( status != PSA_SUCCESS )
3219 goto exit;
3220
3221 status = psa_hash_update( &hmac->hash_ctx, tmp, hash_size );
3222 if( status != PSA_SUCCESS )
3223 goto exit;
3224
Gilles Peskined911eb72018-08-14 15:18:45 +02003225 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
3226 if( status != PSA_SUCCESS )
3227 goto exit;
3228
3229 memcpy( mac, tmp, mac_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003230
3231exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01003232 mbedtls_platform_zeroize( tmp, hash_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003233 return( status );
3234}
3235#endif /* MBEDTLS_MD_C */
3236
mohammad16036df908f2018-04-02 08:34:15 -07003237static psa_status_t psa_mac_finish_internal( psa_mac_operation_t *operation,
Gilles Peskine2d277862018-06-18 15:41:12 +02003238 uint8_t *mac,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003239 size_t mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003240{
Gilles Peskine1d96fff2018-07-02 12:15:39 +02003241 if( ! operation->key_set )
3242 return( PSA_ERROR_BAD_STATE );
3243 if( operation->iv_required && ! operation->iv_set )
3244 return( PSA_ERROR_BAD_STATE );
3245
Gilles Peskine8c9def32018-02-08 10:02:12 +01003246 if( mac_size < operation->mac_size )
3247 return( PSA_ERROR_BUFFER_TOO_SMALL );
3248
Gilles Peskine8c9def32018-02-08 10:02:12 +01003249#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003250 if( operation->alg == PSA_ALG_CMAC )
3251 {
Gilles Peskined911eb72018-08-14 15:18:45 +02003252 uint8_t tmp[PSA_MAX_BLOCK_CIPHER_BLOCK_SIZE];
3253 int ret = mbedtls_cipher_cmac_finish( &operation->ctx.cmac, tmp );
3254 if( ret == 0 )
Gilles Peskine87b0ac42018-08-21 14:55:49 +02003255 memcpy( mac, tmp, operation->mac_size );
Gilles Peskine3f108122018-12-07 18:14:53 +01003256 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003257 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003258 }
Gilles Peskinefbfac682018-07-08 20:51:54 +02003259 else
3260#endif /* MBEDTLS_CMAC_C */
3261#if defined(MBEDTLS_MD_C)
3262 if( PSA_ALG_IS_HMAC( operation->alg ) )
3263 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02003264 return( psa_hmac_finish_internal( &operation->ctx.hmac,
Gilles Peskined911eb72018-08-14 15:18:45 +02003265 mac, operation->mac_size ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003266 }
3267 else
3268#endif /* MBEDTLS_MD_C */
3269 {
3270 /* This shouldn't happen if `operation` was initialized by
3271 * a setup function. */
3272 return( PSA_ERROR_BAD_STATE );
3273 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01003274}
3275
Gilles Peskineacd4be32018-07-08 19:56:25 +02003276psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
3277 uint8_t *mac,
3278 size_t mac_size,
3279 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07003280{
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003281 psa_status_t status;
3282
Jaeden Amero252ef282019-02-15 14:05:35 +00003283 if( operation->alg == 0 )
3284 {
3285 return( PSA_ERROR_BAD_STATE );
3286 }
3287
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003288 /* Fill the output buffer with something that isn't a valid mac
3289 * (barring an attack on the mac and deliberately-crafted input),
3290 * in case the caller doesn't check the return status properly. */
3291 *mac_length = mac_size;
3292 /* If mac_size is 0 then mac may be NULL and then the
3293 * call to memset would have undefined behavior. */
3294 if( mac_size != 0 )
3295 memset( mac, '!', mac_size );
3296
Gilles Peskine89167cb2018-07-08 20:12:23 +02003297 if( ! operation->is_sign )
3298 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003299 return( PSA_ERROR_BAD_STATE );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003300 }
mohammad16036df908f2018-04-02 08:34:15 -07003301
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003302 status = psa_mac_finish_internal( operation, mac, mac_size );
3303
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003304 if( status == PSA_SUCCESS )
3305 {
3306 status = psa_mac_abort( operation );
3307 if( status == PSA_SUCCESS )
3308 *mac_length = operation->mac_size;
3309 else
3310 memset( mac, '!', mac_size );
3311 }
3312 else
3313 psa_mac_abort( operation );
3314 return( status );
mohammad16036df908f2018-04-02 08:34:15 -07003315}
3316
Gilles Peskineacd4be32018-07-08 19:56:25 +02003317psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
3318 const uint8_t *mac,
3319 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003320{
Gilles Peskine828ed142018-06-18 23:25:51 +02003321 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
mohammad16036df908f2018-04-02 08:34:15 -07003322 psa_status_t status;
3323
Jaeden Amero252ef282019-02-15 14:05:35 +00003324 if( operation->alg == 0 )
3325 {
3326 return( PSA_ERROR_BAD_STATE );
3327 }
3328
Gilles Peskine89167cb2018-07-08 20:12:23 +02003329 if( operation->is_sign )
3330 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003331 return( PSA_ERROR_BAD_STATE );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003332 }
3333 if( operation->mac_size != mac_length )
3334 {
3335 status = PSA_ERROR_INVALID_SIGNATURE;
3336 goto cleanup;
Gilles Peskine89167cb2018-07-08 20:12:23 +02003337 }
mohammad16036df908f2018-04-02 08:34:15 -07003338
3339 status = psa_mac_finish_internal( operation,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003340 actual_mac, sizeof( actual_mac ) );
Gilles Peskine28cd4162020-01-20 16:31:06 +01003341 if( status != PSA_SUCCESS )
3342 goto cleanup;
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003343
3344 if( safer_memcmp( mac, actual_mac, mac_length ) != 0 )
3345 status = PSA_ERROR_INVALID_SIGNATURE;
3346
3347cleanup:
3348 if( status == PSA_SUCCESS )
3349 status = psa_mac_abort( operation );
3350 else
3351 psa_mac_abort( operation );
3352
Gilles Peskine3f108122018-12-07 18:14:53 +01003353 mbedtls_platform_zeroize( actual_mac, sizeof( actual_mac ) );
Gilles Peskined911eb72018-08-14 15:18:45 +02003354
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003355 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003356}
3357
3358
Gilles Peskine20035e32018-02-03 22:44:14 +01003359
Gilles Peskine20035e32018-02-03 22:44:14 +01003360/****************************************************************/
3361/* Asymmetric cryptography */
3362/****************************************************************/
3363
Gilles Peskine2b450e32018-06-27 15:42:46 +02003364#if defined(MBEDTLS_RSA_C)
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02003365/* Decode the hash algorithm from alg and store the mbedtls encoding in
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003366 * md_alg. Verify that the hash length is acceptable. */
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02003367static psa_status_t psa_rsa_decode_md_type( psa_algorithm_t alg,
3368 size_t hash_length,
3369 mbedtls_md_type_t *md_alg )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003370{
Gilles Peskine7ed29c52018-06-26 15:50:08 +02003371 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003372 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003373 *md_alg = mbedtls_md_get_type( md_info );
3374
3375 /* The Mbed TLS RSA module uses an unsigned int for hash length
3376 * parameters. Validate that it fits so that we don't risk an
3377 * overflow later. */
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003378#if SIZE_MAX > UINT_MAX
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003379 if( hash_length > UINT_MAX )
3380 return( PSA_ERROR_INVALID_ARGUMENT );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003381#endif
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003382
3383#if defined(MBEDTLS_PKCS1_V15)
3384 /* For PKCS#1 v1.5 signature, if using a hash, the hash length
3385 * must be correct. */
3386 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) &&
3387 alg != PSA_ALG_RSA_PKCS1V15_SIGN_RAW )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003388 {
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003389 if( md_info == NULL )
3390 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003391 if( mbedtls_md_get_size( md_info ) != hash_length )
3392 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003393 }
3394#endif /* MBEDTLS_PKCS1_V15 */
3395
3396#if defined(MBEDTLS_PKCS1_V21)
3397 /* PSS requires a hash internally. */
3398 if( PSA_ALG_IS_RSA_PSS( alg ) )
3399 {
Gilles Peskine61b91d42018-06-08 16:09:36 +02003400 if( md_info == NULL )
3401 return( PSA_ERROR_NOT_SUPPORTED );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003402 }
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003403#endif /* MBEDTLS_PKCS1_V21 */
3404
Gilles Peskine61b91d42018-06-08 16:09:36 +02003405 return( PSA_SUCCESS );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003406}
3407
Gilles Peskine2b450e32018-06-27 15:42:46 +02003408static psa_status_t psa_rsa_sign( mbedtls_rsa_context *rsa,
3409 psa_algorithm_t alg,
3410 const uint8_t *hash,
3411 size_t hash_length,
3412 uint8_t *signature,
3413 size_t signature_size,
3414 size_t *signature_length )
3415{
3416 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00003417 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003418 mbedtls_md_type_t md_alg;
3419
3420 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
3421 if( status != PSA_SUCCESS )
3422 return( status );
3423
Gilles Peskine630a18a2018-06-29 17:49:35 +02003424 if( signature_size < mbedtls_rsa_get_len( rsa ) )
Gilles Peskine2b450e32018-06-27 15:42:46 +02003425 return( PSA_ERROR_BUFFER_TOO_SMALL );
3426
3427#if defined(MBEDTLS_PKCS1_V15)
3428 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
3429 {
3430 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
3431 MBEDTLS_MD_NONE );
3432 ret = mbedtls_rsa_pkcs1_sign( rsa,
3433 mbedtls_ctr_drbg_random,
3434 &global_data.ctr_drbg,
3435 MBEDTLS_RSA_PRIVATE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003436 md_alg,
3437 (unsigned int) hash_length,
3438 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003439 signature );
3440 }
3441 else
3442#endif /* MBEDTLS_PKCS1_V15 */
3443#if defined(MBEDTLS_PKCS1_V21)
3444 if( PSA_ALG_IS_RSA_PSS( alg ) )
3445 {
3446 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3447 ret = mbedtls_rsa_rsassa_pss_sign( rsa,
3448 mbedtls_ctr_drbg_random,
3449 &global_data.ctr_drbg,
3450 MBEDTLS_RSA_PRIVATE,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003451 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003452 (unsigned int) hash_length,
3453 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003454 signature );
3455 }
3456 else
3457#endif /* MBEDTLS_PKCS1_V21 */
3458 {
3459 return( PSA_ERROR_INVALID_ARGUMENT );
3460 }
3461
3462 if( ret == 0 )
Gilles Peskine630a18a2018-06-29 17:49:35 +02003463 *signature_length = mbedtls_rsa_get_len( rsa );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003464 return( mbedtls_to_psa_error( ret ) );
3465}
3466
3467static psa_status_t psa_rsa_verify( mbedtls_rsa_context *rsa,
3468 psa_algorithm_t alg,
3469 const uint8_t *hash,
3470 size_t hash_length,
3471 const uint8_t *signature,
3472 size_t signature_length )
3473{
3474 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00003475 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003476 mbedtls_md_type_t md_alg;
3477
3478 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
3479 if( status != PSA_SUCCESS )
3480 return( status );
3481
Gilles Peskine89cc74f2019-09-12 22:08:23 +02003482 if( signature_length != mbedtls_rsa_get_len( rsa ) )
3483 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003484
3485#if defined(MBEDTLS_PKCS1_V15)
3486 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
3487 {
3488 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
3489 MBEDTLS_MD_NONE );
3490 ret = mbedtls_rsa_pkcs1_verify( rsa,
3491 mbedtls_ctr_drbg_random,
3492 &global_data.ctr_drbg,
3493 MBEDTLS_RSA_PUBLIC,
3494 md_alg,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003495 (unsigned int) hash_length,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003496 hash,
3497 signature );
3498 }
3499 else
3500#endif /* MBEDTLS_PKCS1_V15 */
3501#if defined(MBEDTLS_PKCS1_V21)
3502 if( PSA_ALG_IS_RSA_PSS( alg ) )
3503 {
3504 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3505 ret = mbedtls_rsa_rsassa_pss_verify( rsa,
3506 mbedtls_ctr_drbg_random,
3507 &global_data.ctr_drbg,
3508 MBEDTLS_RSA_PUBLIC,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003509 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003510 (unsigned int) hash_length,
3511 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003512 signature );
3513 }
3514 else
3515#endif /* MBEDTLS_PKCS1_V21 */
3516 {
3517 return( PSA_ERROR_INVALID_ARGUMENT );
3518 }
Gilles Peskineef12c632018-09-13 20:37:48 +02003519
3520 /* Mbed TLS distinguishes "invalid padding" from "valid padding but
3521 * the rest of the signature is invalid". This has little use in
3522 * practice and PSA doesn't report this distinction. */
3523 if( ret == MBEDTLS_ERR_RSA_INVALID_PADDING )
3524 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003525 return( mbedtls_to_psa_error( ret ) );
3526}
3527#endif /* MBEDTLS_RSA_C */
3528
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003529#if defined(MBEDTLS_ECDSA_C)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003530/* `ecp` cannot be const because `ecp->grp` needs to be non-const
3531 * for mbedtls_ecdsa_sign() and mbedtls_ecdsa_sign_det()
3532 * (even though these functions don't modify it). */
3533static psa_status_t psa_ecdsa_sign( mbedtls_ecp_keypair *ecp,
3534 psa_algorithm_t alg,
3535 const uint8_t *hash,
3536 size_t hash_length,
3537 uint8_t *signature,
3538 size_t signature_size,
3539 size_t *signature_length )
3540{
Janos Follath24eed8d2019-11-22 13:21:35 +00003541 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003542 mbedtls_mpi r, s;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003543 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003544 mbedtls_mpi_init( &r );
3545 mbedtls_mpi_init( &s );
3546
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003547 if( signature_size < 2 * curve_bytes )
3548 {
3549 ret = MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL;
3550 goto cleanup;
3551 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003552
Gilles Peskinea05219c2018-11-16 16:02:56 +01003553#if defined(MBEDTLS_ECDSA_DETERMINISTIC)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003554 if( PSA_ALG_DSA_IS_DETERMINISTIC( alg ) )
3555 {
3556 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
3557 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3558 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
Darryl Green5e843fa2019-09-05 14:06:34 +01003559 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign_det_ext( &ecp->grp, &r, &s,
3560 &ecp->d, hash,
3561 hash_length, md_alg,
3562 mbedtls_ctr_drbg_random,
3563 &global_data.ctr_drbg ) );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003564 }
3565 else
Gilles Peskinea05219c2018-11-16 16:02:56 +01003566#endif /* MBEDTLS_ECDSA_DETERMINISTIC */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003567 {
Gilles Peskinea05219c2018-11-16 16:02:56 +01003568 (void) alg;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003569 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign( &ecp->grp, &r, &s, &ecp->d,
3570 hash, hash_length,
3571 mbedtls_ctr_drbg_random,
3572 &global_data.ctr_drbg ) );
3573 }
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003574
3575 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &r,
3576 signature,
3577 curve_bytes ) );
3578 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &s,
3579 signature + curve_bytes,
3580 curve_bytes ) );
3581
3582cleanup:
3583 mbedtls_mpi_free( &r );
3584 mbedtls_mpi_free( &s );
3585 if( ret == 0 )
3586 *signature_length = 2 * curve_bytes;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003587 return( mbedtls_to_psa_error( ret ) );
3588}
3589
3590static psa_status_t psa_ecdsa_verify( mbedtls_ecp_keypair *ecp,
3591 const uint8_t *hash,
3592 size_t hash_length,
3593 const uint8_t *signature,
3594 size_t signature_length )
3595{
Janos Follath24eed8d2019-11-22 13:21:35 +00003596 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003597 mbedtls_mpi r, s;
3598 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
3599 mbedtls_mpi_init( &r );
3600 mbedtls_mpi_init( &s );
3601
3602 if( signature_length != 2 * curve_bytes )
3603 return( PSA_ERROR_INVALID_SIGNATURE );
3604
3605 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &r,
3606 signature,
3607 curve_bytes ) );
3608 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &s,
3609 signature + curve_bytes,
3610 curve_bytes ) );
3611
Steven Cooremanacda8342020-07-24 23:09:52 +02003612 /* Check whether the public part is loaded. If not, load it. */
3613 if( mbedtls_ecp_is_zero( &ecp->Q ) )
3614 {
3615 MBEDTLS_MPI_CHK(
3616 mbedtls_ecp_mul( &ecp->grp, &ecp->Q, &ecp->d, &ecp->grp.G,
3617 mbedtls_ctr_drbg_random, &global_data.ctr_drbg ) );
3618 }
3619
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003620 ret = mbedtls_ecdsa_verify( &ecp->grp, hash, hash_length,
3621 &ecp->Q, &r, &s );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003622
3623cleanup:
3624 mbedtls_mpi_free( &r );
3625 mbedtls_mpi_free( &s );
3626 return( mbedtls_to_psa_error( ret ) );
3627}
3628#endif /* MBEDTLS_ECDSA_C */
3629
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003630psa_status_t psa_sign_hash( psa_key_handle_t handle,
3631 psa_algorithm_t alg,
3632 const uint8_t *hash,
3633 size_t hash_length,
3634 uint8_t *signature,
3635 size_t signature_size,
3636 size_t *signature_length )
Gilles Peskine20035e32018-02-03 22:44:14 +01003637{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003638 psa_key_slot_t *slot;
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003639 psa_status_t status;
3640
3641 *signature_length = signature_size;
Gilles Peskine4019f0e2019-09-12 22:05:59 +02003642 /* Immediately reject a zero-length signature buffer. This guarantees
3643 * that signature must be a valid pointer. (On the other hand, the hash
3644 * buffer can in principle be empty since it doesn't actually have
3645 * to be a hash.) */
3646 if( signature_size == 0 )
3647 return( PSA_ERROR_BUFFER_TOO_SMALL );
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003648
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003649 status = psa_get_key_from_slot( handle, &slot, PSA_KEY_USAGE_SIGN_HASH, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003650 if( status != PSA_SUCCESS )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003651 goto exit;
Gilles Peskine8e338702019-07-30 20:06:31 +02003652 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003653 {
3654 status = PSA_ERROR_INVALID_ARGUMENT;
3655 goto exit;
3656 }
Gilles Peskine20035e32018-02-03 22:44:14 +01003657
Steven Cooremancd84cb42020-07-16 20:28:36 +02003658 /* Try any of the available accelerators first */
3659 status = psa_driver_wrapper_sign_hash( slot,
3660 alg,
3661 hash,
3662 hash_length,
3663 signature,
3664 signature_size,
3665 signature_length );
Steven Cooreman8d2bde72020-09-04 13:06:39 +02003666 if( status != PSA_ERROR_NOT_SUPPORTED ||
3667 psa_key_lifetime_is_external( slot->attr.lifetime ) )
Steven Cooremancd84cb42020-07-16 20:28:36 +02003668 goto exit;
3669
Steven Cooreman7a250572020-07-17 16:43:05 +02003670 /* If the operation was not supported by any accelerator, try fallback. */
Gilles Peskine20035e32018-02-03 22:44:14 +01003671#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003672 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskine20035e32018-02-03 22:44:14 +01003673 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003674 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02003675
Steven Cooreman4fed4552020-08-03 14:46:03 +02003676 status = psa_load_rsa_representation( slot->attr.type,
3677 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02003678 slot->data.key.bytes,
Steven Cooremana01795d2020-07-24 22:48:15 +02003679 &rsa );
3680 if( status != PSA_SUCCESS )
3681 goto exit;
3682
Steven Cooremana2371e52020-07-28 14:30:39 +02003683 status = psa_rsa_sign( rsa,
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003684 alg,
3685 hash, hash_length,
3686 signature, signature_size,
3687 signature_length );
Steven Cooremana01795d2020-07-24 22:48:15 +02003688
Steven Cooremana2371e52020-07-28 14:30:39 +02003689 mbedtls_rsa_free( rsa );
3690 mbedtls_free( rsa );
Gilles Peskine20035e32018-02-03 22:44:14 +01003691 }
3692 else
3693#endif /* defined(MBEDTLS_RSA_C) */
3694#if defined(MBEDTLS_ECP_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003695 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
Gilles Peskine20035e32018-02-03 22:44:14 +01003696 {
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003697#if defined(MBEDTLS_ECDSA_C)
Gilles Peskinea05219c2018-11-16 16:02:56 +01003698 if(
3699#if defined(MBEDTLS_ECDSA_DETERMINISTIC)
3700 PSA_ALG_IS_ECDSA( alg )
3701#else
3702 PSA_ALG_IS_RANDOMIZED_ECDSA( alg )
3703#endif
3704 )
Steven Cooremanacda8342020-07-24 23:09:52 +02003705 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003706 mbedtls_ecp_keypair *ecp = NULL;
Steven Cooreman4fed4552020-08-03 14:46:03 +02003707 status = psa_load_ecp_representation( slot->attr.type,
3708 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02003709 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02003710 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003711 if( status != PSA_SUCCESS )
3712 goto exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003713 status = psa_ecdsa_sign( ecp,
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003714 alg,
3715 hash, hash_length,
3716 signature, signature_size,
3717 signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02003718 mbedtls_ecp_keypair_free( ecp );
3719 mbedtls_free( ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003720 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003721 else
3722#endif /* defined(MBEDTLS_ECDSA_C) */
3723 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003724 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003725 }
itayzafrir5c753392018-05-08 11:18:38 +03003726 }
3727 else
3728#endif /* defined(MBEDTLS_ECP_C) */
3729 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003730 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine20035e32018-02-03 22:44:14 +01003731 }
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003732
3733exit:
3734 /* Fill the unused part of the output buffer (the whole buffer on error,
3735 * the trailing part on success) with something that isn't a valid mac
3736 * (barring an attack on the mac and deliberately-crafted input),
3737 * in case the caller doesn't check the return status properly. */
3738 if( status == PSA_SUCCESS )
3739 memset( signature + *signature_length, '!',
3740 signature_size - *signature_length );
Gilles Peskine4019f0e2019-09-12 22:05:59 +02003741 else
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003742 memset( signature, '!', signature_size );
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003743 /* If signature_size is 0 then we have nothing to do. We must not call
3744 * memset because signature may be NULL in this case. */
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003745 return( status );
itayzafrir5c753392018-05-08 11:18:38 +03003746}
3747
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003748psa_status_t psa_verify_hash( psa_key_handle_t handle,
3749 psa_algorithm_t alg,
3750 const uint8_t *hash,
3751 size_t hash_length,
3752 const uint8_t *signature,
3753 size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03003754{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003755 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003756 psa_status_t status;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003757
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003758 status = psa_get_key_from_slot( handle, &slot, PSA_KEY_USAGE_VERIFY_HASH, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003759 if( status != PSA_SUCCESS )
3760 return( status );
itayzafrir5c753392018-05-08 11:18:38 +03003761
Steven Cooreman55ae2172020-07-17 19:46:15 +02003762 /* Try any of the available accelerators first */
3763 status = psa_driver_wrapper_verify_hash( slot,
3764 alg,
3765 hash,
3766 hash_length,
3767 signature,
3768 signature_length );
Steven Cooreman8d2bde72020-09-04 13:06:39 +02003769 if( status != PSA_ERROR_NOT_SUPPORTED ||
3770 psa_key_lifetime_is_external( slot->attr.lifetime ) )
Steven Cooreman55ae2172020-07-17 19:46:15 +02003771 return status;
3772
Gilles Peskine61b91d42018-06-08 16:09:36 +02003773#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003774 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003775 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003776 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02003777
Steven Cooreman4fed4552020-08-03 14:46:03 +02003778 status = psa_load_rsa_representation( slot->attr.type,
3779 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02003780 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02003781 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003782 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02003783 return( status );
Steven Cooremana01795d2020-07-24 22:48:15 +02003784
Steven Cooremana2371e52020-07-28 14:30:39 +02003785 status = psa_rsa_verify( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02003786 alg,
3787 hash, hash_length,
3788 signature, signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02003789 mbedtls_rsa_free( rsa );
3790 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003791 return( status );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003792 }
3793 else
3794#endif /* defined(MBEDTLS_RSA_C) */
itayzafrir5c753392018-05-08 11:18:38 +03003795#if defined(MBEDTLS_ECP_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003796 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
itayzafrir5c753392018-05-08 11:18:38 +03003797 {
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003798#if defined(MBEDTLS_ECDSA_C)
3799 if( PSA_ALG_IS_ECDSA( alg ) )
Steven Cooremanacda8342020-07-24 23:09:52 +02003800 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003801 mbedtls_ecp_keypair *ecp = NULL;
Steven Cooreman4fed4552020-08-03 14:46:03 +02003802 status = psa_load_ecp_representation( slot->attr.type,
3803 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02003804 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02003805 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003806 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02003807 return( status );
Steven Cooremana2371e52020-07-28 14:30:39 +02003808 status = psa_ecdsa_verify( ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02003809 hash, hash_length,
3810 signature, signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02003811 mbedtls_ecp_keypair_free( ecp );
3812 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02003813 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02003814 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003815 else
3816#endif /* defined(MBEDTLS_ECDSA_C) */
3817 {
3818 return( PSA_ERROR_INVALID_ARGUMENT );
3819 }
itayzafrir5c753392018-05-08 11:18:38 +03003820 }
Gilles Peskine20035e32018-02-03 22:44:14 +01003821 else
3822#endif /* defined(MBEDTLS_ECP_C) */
3823 {
3824 return( PSA_ERROR_NOT_SUPPORTED );
3825 }
3826}
3827
Gilles Peskine072ac562018-06-30 00:21:29 +02003828#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PKCS1_V21)
3829static void psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
3830 mbedtls_rsa_context *rsa )
3831{
3832 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
3833 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3834 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
3835 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3836}
3837#endif /* defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PKCS1_V21) */
3838
Gilles Peskinec5487a82018-12-03 18:08:14 +01003839psa_status_t psa_asymmetric_encrypt( psa_key_handle_t handle,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003840 psa_algorithm_t alg,
3841 const uint8_t *input,
3842 size_t input_length,
3843 const uint8_t *salt,
3844 size_t salt_length,
3845 uint8_t *output,
3846 size_t output_size,
3847 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003848{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003849 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003850 psa_status_t status;
3851
Darryl Green5cc689a2018-07-24 15:34:10 +01003852 (void) input;
3853 (void) input_length;
3854 (void) salt;
3855 (void) output;
3856 (void) output_size;
3857
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003858 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003859
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003860 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3861 return( PSA_ERROR_INVALID_ARGUMENT );
3862
Gilles Peskine28f8f302019-07-24 13:30:31 +02003863 status = psa_get_transparent_key( handle, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003864 if( status != PSA_SUCCESS )
3865 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003866 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
3867 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003868 return( PSA_ERROR_INVALID_ARGUMENT );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003869
3870#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003871 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003872 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003873 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman4fed4552020-08-03 14:46:03 +02003874 status = psa_load_rsa_representation( slot->attr.type,
3875 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02003876 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02003877 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003878 if( status != PSA_SUCCESS )
Steven Cooreman4fed4552020-08-03 14:46:03 +02003879 goto rsa_exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003880
3881 if( output_size < mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003882 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003883 status = PSA_ERROR_BUFFER_TOO_SMALL;
3884 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003885 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003886#if defined(MBEDTLS_PKCS1_V15)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003887 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003888 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003889 status = mbedtls_to_psa_error(
3890 mbedtls_rsa_pkcs1_encrypt( rsa,
3891 mbedtls_ctr_drbg_random,
3892 &global_data.ctr_drbg,
3893 MBEDTLS_RSA_PUBLIC,
3894 input_length,
3895 input,
3896 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003897 }
3898 else
3899#endif /* MBEDTLS_PKCS1_V15 */
3900#if defined(MBEDTLS_PKCS1_V21)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003901 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003902 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003903 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02003904 status = mbedtls_to_psa_error(
3905 mbedtls_rsa_rsaes_oaep_encrypt( rsa,
3906 mbedtls_ctr_drbg_random,
3907 &global_data.ctr_drbg,
3908 MBEDTLS_RSA_PUBLIC,
3909 salt, salt_length,
3910 input_length,
3911 input,
3912 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003913 }
3914 else
3915#endif /* MBEDTLS_PKCS1_V21 */
3916 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003917 status = PSA_ERROR_INVALID_ARGUMENT;
3918 goto rsa_exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003919 }
Steven Cooreman4fed4552020-08-03 14:46:03 +02003920rsa_exit:
3921 if( status == PSA_SUCCESS )
Steven Cooremana2371e52020-07-28 14:30:39 +02003922 *output_length = mbedtls_rsa_get_len( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003923
Steven Cooremana2371e52020-07-28 14:30:39 +02003924 mbedtls_rsa_free( rsa );
3925 mbedtls_free( rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02003926 return( status );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003927 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003928 else
Gilles Peskineb75e4f12018-06-08 17:44:47 +02003929#endif /* defined(MBEDTLS_RSA_C) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003930 {
3931 return( PSA_ERROR_NOT_SUPPORTED );
3932 }
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003933}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003934
Gilles Peskinec5487a82018-12-03 18:08:14 +01003935psa_status_t psa_asymmetric_decrypt( psa_key_handle_t handle,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003936 psa_algorithm_t alg,
3937 const uint8_t *input,
3938 size_t input_length,
3939 const uint8_t *salt,
3940 size_t salt_length,
3941 uint8_t *output,
3942 size_t output_size,
3943 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003944{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003945 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003946 psa_status_t status;
3947
Darryl Green5cc689a2018-07-24 15:34:10 +01003948 (void) input;
3949 (void) input_length;
3950 (void) salt;
3951 (void) output;
3952 (void) output_size;
3953
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003954 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003955
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003956 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3957 return( PSA_ERROR_INVALID_ARGUMENT );
3958
Gilles Peskine28f8f302019-07-24 13:30:31 +02003959 status = psa_get_transparent_key( handle, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003960 if( status != PSA_SUCCESS )
3961 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003962 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003963 return( PSA_ERROR_INVALID_ARGUMENT );
3964
3965#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003966 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003967 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003968 mbedtls_rsa_context *rsa = NULL;
3969 status = psa_load_rsa_representation( slot->attr.type,
3970 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02003971 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02003972 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003973 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02003974 return( status );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003975
Steven Cooremana2371e52020-07-28 14:30:39 +02003976 if( input_length != mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003977 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003978 status = PSA_ERROR_INVALID_ARGUMENT;
3979 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003980 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003981
3982#if defined(MBEDTLS_PKCS1_V15)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003983 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003984 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003985 status = mbedtls_to_psa_error(
3986 mbedtls_rsa_pkcs1_decrypt( rsa,
3987 mbedtls_ctr_drbg_random,
3988 &global_data.ctr_drbg,
3989 MBEDTLS_RSA_PRIVATE,
3990 output_length,
3991 input,
3992 output,
3993 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003994 }
3995 else
3996#endif /* MBEDTLS_PKCS1_V15 */
3997#if defined(MBEDTLS_PKCS1_V21)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003998 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003999 {
Steven Cooremana2371e52020-07-28 14:30:39 +02004000 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02004001 status = mbedtls_to_psa_error(
4002 mbedtls_rsa_rsaes_oaep_decrypt( rsa,
4003 mbedtls_ctr_drbg_random,
4004 &global_data.ctr_drbg,
4005 MBEDTLS_RSA_PRIVATE,
4006 salt, salt_length,
4007 output_length,
4008 input,
4009 output,
4010 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004011 }
4012 else
4013#endif /* MBEDTLS_PKCS1_V21 */
4014 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004015 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004016 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03004017
Steven Cooreman4fed4552020-08-03 14:46:03 +02004018rsa_exit:
Steven Cooremana2371e52020-07-28 14:30:39 +02004019 mbedtls_rsa_free( rsa );
4020 mbedtls_free( rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02004021 return( status );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004022 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004023 else
Gilles Peskineb75e4f12018-06-08 17:44:47 +02004024#endif /* defined(MBEDTLS_RSA_C) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004025 {
4026 return( PSA_ERROR_NOT_SUPPORTED );
4027 }
Gilles Peskine5b051bc2018-05-31 13:25:48 +02004028}
Gilles Peskine20035e32018-02-03 22:44:14 +01004029
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004030
4031
mohammad1603503973b2018-03-12 15:59:30 +02004032/****************************************************************/
4033/* Symmetric cryptography */
4034/****************************************************************/
4035
Gilles Peskinee553c652018-06-04 16:22:46 +02004036static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01004037 psa_key_handle_t handle,
Gilles Peskine7e928852018-06-04 16:23:10 +02004038 psa_algorithm_t alg,
4039 mbedtls_operation_t cipher_operation )
mohammad1603503973b2018-03-12 15:59:30 +02004040{
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004041 int ret = 0;
4042 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Gilles Peskine2f060a82018-12-04 17:12:32 +01004043 psa_key_slot_t *slot;
mohammad1603503973b2018-03-12 15:59:30 +02004044 size_t key_bits;
4045 const mbedtls_cipher_info_t *cipher_info = NULL;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004046 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
4047 PSA_KEY_USAGE_ENCRYPT :
4048 PSA_KEY_USAGE_DECRYPT );
mohammad1603503973b2018-03-12 15:59:30 +02004049
Steven Cooremand3feccd2020-09-01 15:56:14 +02004050 /* A context must be freshly initialized before it can be set up. */
4051 if( operation->alg != 0 )
4052 return( PSA_ERROR_BAD_STATE );
4053
Steven Cooremana07b9972020-09-10 14:54:14 +02004054 /* The requested algorithm must be one that can be processed by cipher. */
4055 if( ! PSA_ALG_IS_CIPHER( alg ) )
Steven Cooremana07b9972020-09-10 14:54:14 +02004056 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremand3feccd2020-09-01 15:56:14 +02004057
Steven Cooremanef8575e2020-09-11 11:44:50 +02004058 /* Fetch key material from key storage. */
4059 status = psa_get_key_from_slot( handle, &slot, usage, alg );
4060 if( status != PSA_SUCCESS )
4061 goto exit;
4062
4063 /* Initialize the operation struct members, except for alg. The alg member
4064 * is used to indicate to psa_cipher_abort that there are resources to free,
4065 * so we only set it after resources have been allocated/initialized. */
Steven Cooremana07b9972020-09-10 14:54:14 +02004066 operation->key_set = 0;
4067 operation->iv_set = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004068 operation->mbedtls_in_use = 0;
Steven Cooremana07b9972020-09-10 14:54:14 +02004069 operation->iv_size = 0;
4070 operation->block_size = 0;
4071 if( alg == PSA_ALG_ECB_NO_PADDING )
4072 operation->iv_required = 0;
4073 else
4074 operation->iv_required = 1;
4075
Steven Cooremana07b9972020-09-10 14:54:14 +02004076 /* Try doing the operation through a driver before using software fallback. */
Steven Cooreman37941cb2020-07-28 18:49:51 +02004077 if( cipher_operation == MBEDTLS_ENCRYPT )
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004078 status = psa_driver_wrapper_cipher_encrypt_setup( &operation->ctx.driver,
Steven Cooreman37941cb2020-07-28 18:49:51 +02004079 slot,
4080 alg );
4081 else
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004082 status = psa_driver_wrapper_cipher_decrypt_setup( &operation->ctx.driver,
Steven Cooreman37941cb2020-07-28 18:49:51 +02004083 slot,
4084 alg );
4085
Steven Cooremanef8575e2020-09-11 11:44:50 +02004086 if( status == PSA_SUCCESS )
Steven Cooreman6d81f7e2020-09-14 13:14:31 +02004087 {
Steven Cooremanef8575e2020-09-11 11:44:50 +02004088 /* Once the driver context is initialised, it needs to be freed using
4089 * psa_cipher_abort. Indicate this through setting alg. */
4090 operation->alg = alg;
Steven Cooreman6d81f7e2020-09-14 13:14:31 +02004091 }
Steven Cooremanef8575e2020-09-11 11:44:50 +02004092
Steven Cooremand3feccd2020-09-01 15:56:14 +02004093 if( status != PSA_ERROR_NOT_SUPPORTED ||
4094 psa_key_lifetime_is_external( slot->attr.lifetime ) )
4095 goto exit;
4096
Steven Cooremana07b9972020-09-10 14:54:14 +02004097 /* Proceed with initializing an mbed TLS cipher context if no driver is
Steven Cooremand3feccd2020-09-01 15:56:14 +02004098 * available for the given algorithm & key. */
4099 mbedtls_cipher_init( &operation->ctx.cipher );
mohammad1603503973b2018-03-12 15:59:30 +02004100
Steven Cooremana07b9972020-09-10 14:54:14 +02004101 /* Once the cipher context is initialised, it needs to be freed using
Steven Cooremanef8575e2020-09-11 11:44:50 +02004102 * psa_cipher_abort. Indicate there is something to be freed through setting
4103 * alg, and indicate the operation is being done using mbedtls crypto through
4104 * setting mbedtls_in_use. */
Steven Cooremana07b9972020-09-10 14:54:14 +02004105 operation->alg = alg;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004106 operation->mbedtls_in_use = 1;
Steven Cooremana07b9972020-09-10 14:54:14 +02004107
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02004108 key_bits = psa_get_key_slot_bits( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +02004109 cipher_info = mbedtls_cipher_info_from_psa( alg, slot->attr.type, key_bits, NULL );
mohammad1603503973b2018-03-12 15:59:30 +02004110 if( cipher_info == NULL )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004111 {
4112 status = PSA_ERROR_NOT_SUPPORTED;
4113 goto exit;
4114 }
mohammad1603503973b2018-03-12 15:59:30 +02004115
mohammad1603503973b2018-03-12 15:59:30 +02004116 ret = mbedtls_cipher_setup( &operation->ctx.cipher, cipher_info );
Moran Peker41deec42018-04-04 15:43:05 +03004117 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004118 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004119
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004120#if defined(MBEDTLS_DES_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02004121 if( slot->attr.type == PSA_KEY_TYPE_DES && key_bits == 128 )
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004122 {
4123 /* Two-key Triple-DES is 3-key Triple-DES with K1=K3 */
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02004124 uint8_t keys[24];
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004125 memcpy( keys, slot->data.key.data, 16 );
4126 memcpy( keys + 16, slot->data.key.data, 8 );
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004127 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
4128 keys,
4129 192, cipher_operation );
4130 }
4131 else
4132#endif
4133 {
4134 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004135 slot->data.key.data,
Jaeden Amero23bbb752018-06-26 14:16:54 +01004136 (int) key_bits, cipher_operation );
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004137 }
Moran Peker41deec42018-04-04 15:43:05 +03004138 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004139 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004140
mohammad16038481e742018-03-18 13:57:31 +02004141#if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004142 switch( alg )
mohammad16038481e742018-03-18 13:57:31 +02004143 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004144 case PSA_ALG_CBC_NO_PADDING:
4145 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
4146 MBEDTLS_PADDING_NONE );
4147 break;
4148 case PSA_ALG_CBC_PKCS7:
4149 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
4150 MBEDTLS_PADDING_PKCS7 );
4151 break;
4152 default:
4153 /* The algorithm doesn't involve padding. */
4154 ret = 0;
4155 break;
4156 }
4157 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004158 goto exit;
mohammad16038481e742018-03-18 13:57:31 +02004159#endif //MBEDTLS_CIPHER_MODE_WITH_PADDING
4160
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004161 operation->block_size = ( PSA_ALG_IS_STREAM_CIPHER( alg ) ? 1 :
Gilles Peskine8e338702019-07-30 20:06:31 +02004162 PSA_BLOCK_CIPHER_BLOCK_SIZE( slot->attr.type ) );
Steven Cooremana6033e92020-08-25 11:47:50 +02004163 if( ( alg & PSA_ALG_CIPHER_FROM_BLOCK_FLAG ) != 0 &&
4164 alg != PSA_ALG_ECB_NO_PADDING )
mohammad16038481e742018-03-18 13:57:31 +02004165 {
Gilles Peskine8e338702019-07-30 20:06:31 +02004166 operation->iv_size = PSA_BLOCK_CIPHER_BLOCK_SIZE( slot->attr.type );
mohammad16038481e742018-03-18 13:57:31 +02004167 }
Gilles Peskine26869f22019-05-06 15:25:00 +02004168#if defined(MBEDTLS_CHACHA20_C)
4169 else
4170 if( alg == PSA_ALG_CHACHA20 )
4171 operation->iv_size = 12;
4172#endif
mohammad1603503973b2018-03-12 15:59:30 +02004173
Steven Cooreman7df02922020-09-09 15:28:49 +02004174 status = PSA_SUCCESS;
4175
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004176exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02004177 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004178 status = mbedtls_to_psa_error( ret );
Steven Cooreman7df02922020-09-09 15:28:49 +02004179 if( status == PSA_SUCCESS )
4180 {
4181 /* Update operation flags for both driver and software implementations */
4182 operation->key_set = 1;
4183 }
4184 else
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004185 psa_cipher_abort( operation );
4186 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004187}
4188
Gilles Peskinefe119512018-07-08 21:39:34 +02004189psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01004190 psa_key_handle_t handle,
Gilles Peskinefe119512018-07-08 21:39:34 +02004191 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02004192{
Gilles Peskinec5487a82018-12-03 18:08:14 +01004193 return( psa_cipher_setup( operation, handle, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02004194}
4195
Gilles Peskinefe119512018-07-08 21:39:34 +02004196psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01004197 psa_key_handle_t handle,
Gilles Peskinefe119512018-07-08 21:39:34 +02004198 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02004199{
Gilles Peskinec5487a82018-12-03 18:08:14 +01004200 return( psa_cipher_setup( operation, handle, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02004201}
4202
Gilles Peskinefe119512018-07-08 21:39:34 +02004203psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004204 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02004205 size_t iv_size,
4206 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02004207{
itayzafrir534bd7c2018-08-02 13:56:32 +03004208 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00004209 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooreman7df02922020-09-09 15:28:49 +02004210 if( operation->iv_set || ! operation->iv_required )
4211 {
4212 return( PSA_ERROR_BAD_STATE );
4213 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004214
Steven Cooremanef8575e2020-09-11 11:44:50 +02004215 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004216 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004217 status = psa_driver_wrapper_cipher_generate_iv( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004218 iv,
4219 iv_size,
4220 iv_length );
4221 goto exit;
4222 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004223
Moran Peker41deec42018-04-04 15:43:05 +03004224 if( iv_size < operation->iv_size )
mohammad1603503973b2018-03-12 15:59:30 +02004225 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004226 status = PSA_ERROR_BUFFER_TOO_SMALL;
Moran Peker41deec42018-04-04 15:43:05 +03004227 goto exit;
4228 }
Gilles Peskine7e928852018-06-04 16:23:10 +02004229 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg,
4230 iv, operation->iv_size );
Moran Peker41deec42018-04-04 15:43:05 +03004231 if( ret != 0 )
4232 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004233 status = mbedtls_to_psa_error( ret );
Gilles Peskinee553c652018-06-04 16:22:46 +02004234 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004235 }
Gilles Peskinee553c652018-06-04 16:22:46 +02004236
mohammad16038481e742018-03-18 13:57:31 +02004237 *iv_length = operation->iv_size;
itayzafrir534bd7c2018-08-02 13:56:32 +03004238 status = psa_cipher_set_iv( operation, iv, *iv_length );
Moran Peker41deec42018-04-04 15:43:05 +03004239
Moran Peker395db872018-05-31 14:07:14 +03004240exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02004241 if( status == PSA_SUCCESS )
4242 operation->iv_set = 1;
4243 else
Moran Peker395db872018-05-31 14:07:14 +03004244 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004245 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004246}
4247
Gilles Peskinefe119512018-07-08 21:39:34 +02004248psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004249 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02004250 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02004251{
itayzafrir534bd7c2018-08-02 13:56:32 +03004252 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00004253 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooreman7df02922020-09-09 15:28:49 +02004254 if( operation->iv_set || ! operation->iv_required )
4255 {
4256 return( PSA_ERROR_BAD_STATE );
4257 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004258
Steven Cooremanef8575e2020-09-11 11:44:50 +02004259 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004260 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004261 status = psa_driver_wrapper_cipher_set_iv( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004262 iv,
4263 iv_length );
4264 goto exit;
4265 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004266
Moran Pekera28258c2018-05-29 16:25:04 +03004267 if( iv_length != operation->iv_size )
Moran Peker71f19ae2018-04-22 20:23:16 +03004268 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004269 status = PSA_ERROR_INVALID_ARGUMENT;
4270 goto exit;
Moran Peker71f19ae2018-04-22 20:23:16 +03004271 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004272 ret = mbedtls_cipher_set_iv( &operation->ctx.cipher, iv, iv_length );
4273 status = mbedtls_to_psa_error( ret );
4274exit:
4275 if( status == PSA_SUCCESS )
4276 operation->iv_set = 1;
4277 else
mohammad1603503973b2018-03-12 15:59:30 +02004278 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004279 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004280}
4281
Steven Cooreman177deba2020-09-07 17:14:14 +02004282/* Process input for which the algorithm is set to ECB mode. This requires
4283 * manual processing, since the PSA API is defined as being able to process
4284 * arbitrary-length calls to psa_cipher_update() with ECB mode, but the
4285 * underlying mbedtls_cipher_update only takes full blocks. */
4286static psa_status_t psa_cipher_update_ecb_internal(
4287 mbedtls_cipher_context_t *ctx,
4288 const uint8_t *input,
4289 size_t input_length,
4290 uint8_t *output,
4291 size_t output_size,
4292 size_t *output_length )
4293{
4294 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4295 size_t block_size = ctx->cipher_info->block_size;
4296 size_t internal_output_length = 0;
4297 *output_length = 0;
4298
4299 if( input_length == 0 )
4300 {
4301 status = PSA_SUCCESS;
4302 goto exit;
4303 }
4304
4305 if( ctx->unprocessed_len > 0 )
4306 {
4307 /* Fill up to block size, and run the block if there's a full one. */
4308 size_t bytes_to_copy = block_size - ctx->unprocessed_len;
4309
4310 if( input_length < bytes_to_copy )
4311 bytes_to_copy = input_length;
4312
4313 memcpy( &( ctx->unprocessed_data[ctx->unprocessed_len] ),
4314 input, bytes_to_copy );
4315 input_length -= bytes_to_copy;
4316 input += bytes_to_copy;
4317 ctx->unprocessed_len += bytes_to_copy;
4318
4319 if( ctx->unprocessed_len == block_size )
4320 {
4321 status = mbedtls_to_psa_error(
4322 mbedtls_cipher_update( ctx,
4323 ctx->unprocessed_data,
4324 block_size,
4325 output, &internal_output_length ) );
4326
4327 if( status != PSA_SUCCESS )
4328 goto exit;
4329
4330 output += internal_output_length;
4331 output_size -= internal_output_length;
4332 *output_length += internal_output_length;
4333 ctx->unprocessed_len = 0;
4334 }
4335 }
4336
4337 while( input_length >= block_size )
4338 {
4339 /* Run all full blocks we have, one by one */
4340 status = mbedtls_to_psa_error(
4341 mbedtls_cipher_update( ctx, input,
4342 block_size,
4343 output, &internal_output_length ) );
4344
4345 if( status != PSA_SUCCESS )
4346 goto exit;
4347
4348 input_length -= block_size;
4349 input += block_size;
4350
4351 output += internal_output_length;
4352 output_size -= internal_output_length;
4353 *output_length += internal_output_length;
4354 }
4355
4356 if( input_length > 0 )
4357 {
4358 /* Save unprocessed bytes for later processing */
4359 memcpy( &( ctx->unprocessed_data[ctx->unprocessed_len] ),
4360 input, input_length );
4361 ctx->unprocessed_len += input_length;
4362 }
4363
4364 status = PSA_SUCCESS;
4365
4366exit:
4367 return( status );
4368}
4369
Gilles Peskinee553c652018-06-04 16:22:46 +02004370psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
4371 const uint8_t *input,
4372 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004373 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02004374 size_t output_size,
4375 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02004376{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004377 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine89d789c2018-06-04 17:17:16 +02004378 size_t expected_output_size;
Steven Cooreman7df02922020-09-09 15:28:49 +02004379 if( operation->alg == 0 )
4380 {
4381 return( PSA_ERROR_BAD_STATE );
4382 }
4383 if( operation->iv_required && ! operation->iv_set )
4384 {
4385 return( PSA_ERROR_BAD_STATE );
4386 }
Jaeden Ameroab439972019-02-15 14:12:05 +00004387
Steven Cooremanef8575e2020-09-11 11:44:50 +02004388 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004389 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004390 status = psa_driver_wrapper_cipher_update( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004391 input,
4392 input_length,
4393 output,
4394 output_size,
4395 output_length );
4396 goto exit;
4397 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004398
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004399 if( ! PSA_ALG_IS_STREAM_CIPHER( operation->alg ) )
Gilles Peskine89d789c2018-06-04 17:17:16 +02004400 {
4401 /* Take the unprocessed partial block left over from previous
4402 * update calls, if any, plus the input to this call. Remove
4403 * the last partial block, if any. You get the data that will be
4404 * output in this call. */
4405 expected_output_size =
4406 ( operation->ctx.cipher.unprocessed_len + input_length )
4407 / operation->block_size * operation->block_size;
4408 }
4409 else
4410 {
4411 expected_output_size = input_length;
4412 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004413
Gilles Peskine89d789c2018-06-04 17:17:16 +02004414 if( output_size < expected_output_size )
itayzafrir534bd7c2018-08-02 13:56:32 +03004415 {
4416 status = PSA_ERROR_BUFFER_TOO_SMALL;
4417 goto exit;
4418 }
mohammad160382759612018-03-12 18:16:40 +02004419
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004420 if( operation->alg == PSA_ALG_ECB_NO_PADDING )
4421 {
4422 /* mbedtls_cipher_update has an API inconsistency: it will only
4423 * process a single block at a time in ECB mode. Abstract away that
4424 * inconsistency here to match the PSA API behaviour. */
Steven Cooreman177deba2020-09-07 17:14:14 +02004425 status = psa_cipher_update_ecb_internal( &operation->ctx.cipher,
4426 input,
4427 input_length,
4428 output,
4429 output_size,
4430 output_length );
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004431 }
4432 else
4433 {
4434 status = mbedtls_to_psa_error(
4435 mbedtls_cipher_update( &operation->ctx.cipher, input,
4436 input_length, output, output_length ) );
4437 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004438exit:
4439 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02004440 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004441 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004442}
4443
Gilles Peskinee553c652018-06-04 16:22:46 +02004444psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
4445 uint8_t *output,
4446 size_t output_size,
4447 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02004448{
David Saadab4ecc272019-02-14 13:48:10 +02004449 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Gilles Peskinee553c652018-06-04 16:22:46 +02004450 uint8_t temp_output_buffer[MBEDTLS_MAX_BLOCK_LENGTH];
Steven Cooreman7df02922020-09-09 15:28:49 +02004451 if( operation->alg == 0 )
4452 {
4453 return( PSA_ERROR_BAD_STATE );
4454 }
4455 if( operation->iv_required && ! operation->iv_set )
4456 {
4457 return( PSA_ERROR_BAD_STATE );
4458 }
Moran Pekerbed71a22018-04-22 20:19:20 +03004459
Steven Cooremanef8575e2020-09-11 11:44:50 +02004460 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004461 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004462 status = psa_driver_wrapper_cipher_finish( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004463 output,
4464 output_size,
4465 output_length );
Steven Cooremanef8575e2020-09-11 11:44:50 +02004466 goto exit;
Steven Cooreman8b122252020-09-03 15:30:32 +02004467 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004468
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004469 if( operation->ctx.cipher.unprocessed_len != 0 )
Moran Peker7cb22b82018-06-05 11:40:02 +03004470 {
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004471 if( operation->alg == PSA_ALG_ECB_NO_PADDING ||
4472 ( operation->alg == PSA_ALG_CBC_NO_PADDING &&
Steven Cooremana6033e92020-08-25 11:47:50 +02004473 operation->ctx.cipher.operation == MBEDTLS_ENCRYPT ) )
4474 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004475 status = PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004476 goto exit;
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004477 }
Moran Pekerdc38ebc2018-04-30 15:45:34 +03004478 }
4479
Steven Cooremanef8575e2020-09-11 11:44:50 +02004480 status = mbedtls_to_psa_error(
4481 mbedtls_cipher_finish( &operation->ctx.cipher,
4482 temp_output_buffer,
4483 output_length ) );
4484 if( status != PSA_SUCCESS )
4485 goto exit;
Janos Follath315b51c2018-07-09 16:04:51 +01004486
Gilles Peskine46f1fd72018-06-28 19:31:31 +02004487 if( *output_length == 0 )
Janos Follath315b51c2018-07-09 16:04:51 +01004488 ; /* Nothing to copy. Note that output may be NULL in this case. */
Gilles Peskine46f1fd72018-06-28 19:31:31 +02004489 else if( output_size >= *output_length )
Moran Pekerdc38ebc2018-04-30 15:45:34 +03004490 memcpy( output, temp_output_buffer, *output_length );
4491 else
Janos Follath315b51c2018-07-09 16:04:51 +01004492 status = PSA_ERROR_BUFFER_TOO_SMALL;
mohammad1603503973b2018-03-12 15:59:30 +02004493
Steven Cooremanef8575e2020-09-11 11:44:50 +02004494exit:
4495 if( operation->mbedtls_in_use == 1 )
4496 mbedtls_platform_zeroize( temp_output_buffer, sizeof( temp_output_buffer ) );
Janos Follath315b51c2018-07-09 16:04:51 +01004497
Steven Cooremanef8575e2020-09-11 11:44:50 +02004498 if( status == PSA_SUCCESS )
4499 return( psa_cipher_abort( operation ) );
4500 else
4501 {
4502 *output_length = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004503 (void) psa_cipher_abort( operation );
Janos Follath315b51c2018-07-09 16:04:51 +01004504
Steven Cooremanef8575e2020-09-11 11:44:50 +02004505 return( status );
4506 }
mohammad1603503973b2018-03-12 15:59:30 +02004507}
4508
Gilles Peskinee553c652018-06-04 16:22:46 +02004509psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
4510{
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004511 if( operation->alg == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02004512 {
Steven Cooremana07b9972020-09-10 14:54:14 +02004513 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02004514 * in use. It's ok to call abort on such an object, and there's
4515 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004516 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02004517 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004518
Gilles Peskinef9c2c092018-06-21 16:57:07 +02004519 /* Sanity check (shouldn't happen: operation->alg should
4520 * always have been initialized to a valid value). */
4521 if( ! PSA_ALG_IS_CIPHER( operation->alg ) )
4522 return( PSA_ERROR_BAD_STATE );
4523
Steven Cooremanef8575e2020-09-11 11:44:50 +02004524 if( operation->mbedtls_in_use == 0 )
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004525 psa_driver_wrapper_cipher_abort( &operation->ctx.driver );
Steven Cooremand3feccd2020-09-01 15:56:14 +02004526 else
4527 mbedtls_cipher_free( &operation->ctx.cipher );
Gilles Peskinee553c652018-06-04 16:22:46 +02004528
Moran Peker41deec42018-04-04 15:43:05 +03004529 operation->alg = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004530 operation->key_set = 0;
4531 operation->iv_set = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004532 operation->mbedtls_in_use = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004533 operation->iv_size = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004534 operation->block_size = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004535 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004536
Moran Peker395db872018-05-31 14:07:14 +03004537 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02004538}
4539
Gilles Peskinea0655c32018-04-30 17:06:50 +02004540
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004541
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004542
mohammad16035955c982018-04-26 00:53:03 +03004543/****************************************************************/
4544/* AEAD */
4545/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004546
Gilles Peskineedf9a652018-08-17 18:11:56 +02004547typedef struct
4548{
Gilles Peskine2f060a82018-12-04 17:12:32 +01004549 psa_key_slot_t *slot;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004550 const mbedtls_cipher_info_t *cipher_info;
4551 union
4552 {
4553#if defined(MBEDTLS_CCM_C)
4554 mbedtls_ccm_context ccm;
4555#endif /* MBEDTLS_CCM_C */
4556#if defined(MBEDTLS_GCM_C)
4557 mbedtls_gcm_context gcm;
4558#endif /* MBEDTLS_GCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004559#if defined(MBEDTLS_CHACHAPOLY_C)
4560 mbedtls_chachapoly_context chachapoly;
4561#endif /* MBEDTLS_CHACHAPOLY_C */
Gilles Peskineedf9a652018-08-17 18:11:56 +02004562 } ctx;
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004563 psa_algorithm_t core_alg;
4564 uint8_t full_tag_length;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004565 uint8_t tag_length;
4566} aead_operation_t;
4567
Gilles Peskine30a9e412019-01-14 18:36:12 +01004568static void psa_aead_abort_internal( aead_operation_t *operation )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004569{
Gilles Peskinef8a8fe62018-08-21 16:38:05 +02004570 switch( operation->core_alg )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004571 {
4572#if defined(MBEDTLS_CCM_C)
4573 case PSA_ALG_CCM:
4574 mbedtls_ccm_free( &operation->ctx.ccm );
4575 break;
4576#endif /* MBEDTLS_CCM_C */
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004577#if defined(MBEDTLS_GCM_C)
Gilles Peskineedf9a652018-08-17 18:11:56 +02004578 case PSA_ALG_GCM:
4579 mbedtls_gcm_free( &operation->ctx.gcm );
4580 break;
4581#endif /* MBEDTLS_GCM_C */
4582 }
4583}
4584
4585static psa_status_t psa_aead_setup( aead_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01004586 psa_key_handle_t handle,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004587 psa_key_usage_t usage,
4588 psa_algorithm_t alg )
4589{
4590 psa_status_t status;
4591 size_t key_bits;
4592 mbedtls_cipher_id_t cipher_id;
4593
Gilles Peskine28f8f302019-07-24 13:30:31 +02004594 status = psa_get_transparent_key( handle, &operation->slot, usage, alg );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004595 if( status != PSA_SUCCESS )
4596 return( status );
4597
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02004598 key_bits = psa_get_key_slot_bits( operation->slot );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004599
4600 operation->cipher_info =
Gilles Peskine8e338702019-07-30 20:06:31 +02004601 mbedtls_cipher_info_from_psa( alg, operation->slot->attr.type, key_bits,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004602 &cipher_id );
4603 if( operation->cipher_info == NULL )
4604 return( PSA_ERROR_NOT_SUPPORTED );
4605
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004606 switch( PSA_ALG_AEAD_WITH_TAG_LENGTH( alg, 0 ) )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004607 {
4608#if defined(MBEDTLS_CCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004609 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CCM, 0 ):
4610 operation->core_alg = PSA_ALG_CCM;
4611 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004612 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.
4613 * The call to mbedtls_ccm_encrypt_and_tag or
4614 * mbedtls_ccm_auth_decrypt will validate the tag length. */
Gilles Peskine8e338702019-07-30 20:06:31 +02004615 if( PSA_BLOCK_CIPHER_BLOCK_SIZE( operation->slot->attr.type ) != 16 )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004616 return( PSA_ERROR_INVALID_ARGUMENT );
4617 mbedtls_ccm_init( &operation->ctx.ccm );
4618 status = mbedtls_to_psa_error(
4619 mbedtls_ccm_setkey( &operation->ctx.ccm, cipher_id,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004620 operation->slot->data.key.data,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004621 (unsigned int) key_bits ) );
4622 if( status != 0 )
4623 goto cleanup;
4624 break;
4625#endif /* MBEDTLS_CCM_C */
4626
4627#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004628 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_GCM, 0 ):
4629 operation->core_alg = PSA_ALG_GCM;
4630 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004631 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16.
4632 * The call to mbedtls_gcm_crypt_and_tag or
4633 * mbedtls_gcm_auth_decrypt will validate the tag length. */
Gilles Peskine8e338702019-07-30 20:06:31 +02004634 if( PSA_BLOCK_CIPHER_BLOCK_SIZE( operation->slot->attr.type ) != 16 )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004635 return( PSA_ERROR_INVALID_ARGUMENT );
4636 mbedtls_gcm_init( &operation->ctx.gcm );
4637 status = mbedtls_to_psa_error(
4638 mbedtls_gcm_setkey( &operation->ctx.gcm, cipher_id,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004639 operation->slot->data.key.data,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004640 (unsigned int) key_bits ) );
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004641 if( status != 0 )
4642 goto cleanup;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004643 break;
4644#endif /* MBEDTLS_GCM_C */
4645
Gilles Peskine26869f22019-05-06 15:25:00 +02004646#if defined(MBEDTLS_CHACHAPOLY_C)
4647 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CHACHA20_POLY1305, 0 ):
4648 operation->core_alg = PSA_ALG_CHACHA20_POLY1305;
4649 operation->full_tag_length = 16;
4650 /* We only support the default tag length. */
4651 if( alg != PSA_ALG_CHACHA20_POLY1305 )
4652 return( PSA_ERROR_NOT_SUPPORTED );
4653 mbedtls_chachapoly_init( &operation->ctx.chachapoly );
4654 status = mbedtls_to_psa_error(
4655 mbedtls_chachapoly_setkey( &operation->ctx.chachapoly,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004656 operation->slot->data.key.data ) );
Gilles Peskine26869f22019-05-06 15:25:00 +02004657 if( status != 0 )
4658 goto cleanup;
4659 break;
4660#endif /* MBEDTLS_CHACHAPOLY_C */
4661
Gilles Peskineedf9a652018-08-17 18:11:56 +02004662 default:
4663 return( PSA_ERROR_NOT_SUPPORTED );
4664 }
4665
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004666 if( PSA_AEAD_TAG_LENGTH( alg ) > operation->full_tag_length )
4667 {
4668 status = PSA_ERROR_INVALID_ARGUMENT;
4669 goto cleanup;
4670 }
4671 operation->tag_length = PSA_AEAD_TAG_LENGTH( alg );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004672
Gilles Peskineedf9a652018-08-17 18:11:56 +02004673 return( PSA_SUCCESS );
4674
4675cleanup:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004676 psa_aead_abort_internal( operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004677 return( status );
4678}
4679
Gilles Peskinec5487a82018-12-03 18:08:14 +01004680psa_status_t psa_aead_encrypt( psa_key_handle_t handle,
mohammad16035955c982018-04-26 00:53:03 +03004681 psa_algorithm_t alg,
4682 const uint8_t *nonce,
4683 size_t nonce_length,
4684 const uint8_t *additional_data,
4685 size_t additional_data_length,
4686 const uint8_t *plaintext,
4687 size_t plaintext_length,
4688 uint8_t *ciphertext,
4689 size_t ciphertext_size,
4690 size_t *ciphertext_length )
4691{
mohammad16035955c982018-04-26 00:53:03 +03004692 psa_status_t status;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004693 aead_operation_t operation;
mohammad160315223a82018-06-03 17:19:55 +03004694 uint8_t *tag;
Gilles Peskine2d277862018-06-18 15:41:12 +02004695
mohammad1603f08a5502018-06-03 15:05:47 +03004696 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004697
Gilles Peskinec5487a82018-12-03 18:08:14 +01004698 status = psa_aead_setup( &operation, handle, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004699 if( status != PSA_SUCCESS )
4700 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004701
Gilles Peskineedf9a652018-08-17 18:11:56 +02004702 /* For all currently supported modes, the tag is at the end of the
4703 * ciphertext. */
4704 if( ciphertext_size < ( plaintext_length + operation.tag_length ) )
4705 {
4706 status = PSA_ERROR_BUFFER_TOO_SMALL;
4707 goto exit;
4708 }
4709 tag = ciphertext + plaintext_length;
mohammad16035955c982018-04-26 00:53:03 +03004710
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004711#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004712 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03004713 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004714 status = mbedtls_to_psa_error(
4715 mbedtls_gcm_crypt_and_tag( &operation.ctx.gcm,
4716 MBEDTLS_GCM_ENCRYPT,
4717 plaintext_length,
4718 nonce, nonce_length,
4719 additional_data, additional_data_length,
4720 plaintext, ciphertext,
4721 operation.tag_length, tag ) );
mohammad16035955c982018-04-26 00:53:03 +03004722 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004723 else
4724#endif /* MBEDTLS_GCM_C */
4725#if defined(MBEDTLS_CCM_C)
4726 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03004727 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004728 status = mbedtls_to_psa_error(
4729 mbedtls_ccm_encrypt_and_tag( &operation.ctx.ccm,
4730 plaintext_length,
4731 nonce, nonce_length,
4732 additional_data,
4733 additional_data_length,
4734 plaintext, ciphertext,
4735 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03004736 }
mohammad16035c8845f2018-05-09 05:40:09 -07004737 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004738#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004739#if defined(MBEDTLS_CHACHAPOLY_C)
4740 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
4741 {
4742 if( nonce_length != 12 || operation.tag_length != 16 )
4743 {
4744 status = PSA_ERROR_NOT_SUPPORTED;
4745 goto exit;
4746 }
4747 status = mbedtls_to_psa_error(
4748 mbedtls_chachapoly_encrypt_and_tag( &operation.ctx.chachapoly,
4749 plaintext_length,
4750 nonce,
4751 additional_data,
4752 additional_data_length,
4753 plaintext,
4754 ciphertext,
4755 tag ) );
4756 }
4757 else
4758#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad16035c8845f2018-05-09 05:40:09 -07004759 {
mohammad1603554faad2018-06-03 15:07:38 +03004760 return( PSA_ERROR_NOT_SUPPORTED );
mohammad16035c8845f2018-05-09 05:40:09 -07004761 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004762
Gilles Peskineedf9a652018-08-17 18:11:56 +02004763 if( status != PSA_SUCCESS && ciphertext_size != 0 )
4764 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02004765
Gilles Peskineedf9a652018-08-17 18:11:56 +02004766exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004767 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004768 if( status == PSA_SUCCESS )
4769 *ciphertext_length = plaintext_length + operation.tag_length;
4770 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004771}
4772
Gilles Peskineee652a32018-06-01 19:23:52 +02004773/* Locate the tag in a ciphertext buffer containing the encrypted data
4774 * followed by the tag. Return the length of the part preceding the tag in
4775 * *plaintext_length. This is the size of the plaintext in modes where
4776 * the encrypted data has the same size as the plaintext, such as
4777 * CCM and GCM. */
4778static psa_status_t psa_aead_unpadded_locate_tag( size_t tag_length,
4779 const uint8_t *ciphertext,
4780 size_t ciphertext_length,
4781 size_t plaintext_size,
Gilles Peskineee652a32018-06-01 19:23:52 +02004782 const uint8_t **p_tag )
4783{
4784 size_t payload_length;
4785 if( tag_length > ciphertext_length )
4786 return( PSA_ERROR_INVALID_ARGUMENT );
4787 payload_length = ciphertext_length - tag_length;
4788 if( payload_length > plaintext_size )
4789 return( PSA_ERROR_BUFFER_TOO_SMALL );
4790 *p_tag = ciphertext + payload_length;
Gilles Peskineee652a32018-06-01 19:23:52 +02004791 return( PSA_SUCCESS );
4792}
4793
Gilles Peskinec5487a82018-12-03 18:08:14 +01004794psa_status_t psa_aead_decrypt( psa_key_handle_t handle,
mohammad16035955c982018-04-26 00:53:03 +03004795 psa_algorithm_t alg,
4796 const uint8_t *nonce,
4797 size_t nonce_length,
4798 const uint8_t *additional_data,
4799 size_t additional_data_length,
4800 const uint8_t *ciphertext,
4801 size_t ciphertext_length,
4802 uint8_t *plaintext,
4803 size_t plaintext_size,
4804 size_t *plaintext_length )
4805{
mohammad16035955c982018-04-26 00:53:03 +03004806 psa_status_t status;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004807 aead_operation_t operation;
4808 const uint8_t *tag = NULL;
Gilles Peskine2d277862018-06-18 15:41:12 +02004809
Gilles Peskineee652a32018-06-01 19:23:52 +02004810 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004811
Gilles Peskinec5487a82018-12-03 18:08:14 +01004812 status = psa_aead_setup( &operation, handle, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004813 if( status != PSA_SUCCESS )
4814 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004815
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004816 status = psa_aead_unpadded_locate_tag( operation.tag_length,
4817 ciphertext, ciphertext_length,
4818 plaintext_size, &tag );
4819 if( status != PSA_SUCCESS )
4820 goto exit;
4821
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004822#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004823 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03004824 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004825 status = mbedtls_to_psa_error(
4826 mbedtls_gcm_auth_decrypt( &operation.ctx.gcm,
4827 ciphertext_length - operation.tag_length,
4828 nonce, nonce_length,
4829 additional_data,
4830 additional_data_length,
4831 tag, operation.tag_length,
4832 ciphertext, plaintext ) );
mohammad16035955c982018-04-26 00:53:03 +03004833 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004834 else
4835#endif /* MBEDTLS_GCM_C */
4836#if defined(MBEDTLS_CCM_C)
4837 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03004838 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004839 status = mbedtls_to_psa_error(
4840 mbedtls_ccm_auth_decrypt( &operation.ctx.ccm,
4841 ciphertext_length - operation.tag_length,
4842 nonce, nonce_length,
4843 additional_data,
4844 additional_data_length,
4845 ciphertext, plaintext,
4846 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03004847 }
mohammad160339574652018-06-01 04:39:53 -07004848 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004849#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004850#if defined(MBEDTLS_CHACHAPOLY_C)
4851 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
4852 {
4853 if( nonce_length != 12 || operation.tag_length != 16 )
4854 {
4855 status = PSA_ERROR_NOT_SUPPORTED;
4856 goto exit;
4857 }
4858 status = mbedtls_to_psa_error(
4859 mbedtls_chachapoly_auth_decrypt( &operation.ctx.chachapoly,
4860 ciphertext_length - operation.tag_length,
4861 nonce,
4862 additional_data,
4863 additional_data_length,
4864 tag,
4865 ciphertext,
4866 plaintext ) );
4867 }
4868 else
4869#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad160339574652018-06-01 04:39:53 -07004870 {
mohammad1603554faad2018-06-03 15:07:38 +03004871 return( PSA_ERROR_NOT_SUPPORTED );
mohammad160339574652018-06-01 04:39:53 -07004872 }
Gilles Peskinea40d7742018-06-01 16:28:30 +02004873
Gilles Peskineedf9a652018-08-17 18:11:56 +02004874 if( status != PSA_SUCCESS && plaintext_size != 0 )
4875 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03004876
Gilles Peskineedf9a652018-08-17 18:11:56 +02004877exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004878 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004879 if( status == PSA_SUCCESS )
4880 *plaintext_length = ciphertext_length - operation.tag_length;
4881 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004882}
4883
Gilles Peskinea0655c32018-04-30 17:06:50 +02004884
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004885
Gilles Peskine20035e32018-02-03 22:44:14 +01004886/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02004887/* Generators */
4888/****************************************************************/
4889
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004890#define HKDF_STATE_INIT 0 /* no input yet */
4891#define HKDF_STATE_STARTED 1 /* got salt */
4892#define HKDF_STATE_KEYED 2 /* got key */
4893#define HKDF_STATE_OUTPUT 3 /* output started */
4894
Gilles Peskinecbe66502019-05-16 16:59:18 +02004895static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004896 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004897{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004898 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
4899 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004900 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004901 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004902}
4903
4904
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004905psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004906{
4907 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004908 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004909 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004910 {
4911 /* The object has (apparently) been initialized but it is not
4912 * in use. It's ok to call abort on such an object, and there's
4913 * nothing to do. */
4914 }
4915 else
Gilles Peskinebef7f142018-07-12 17:22:21 +02004916#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004917 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004918 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004919 mbedtls_free( operation->ctx.hkdf.info );
4920 status = psa_hmac_abort_internal( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004921 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01004922 else if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004923 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004924 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004925 {
Janos Follath6a1d2622019-06-11 10:37:28 +01004926 if( operation->ctx.tls12_prf.seed != NULL )
4927 {
4928 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
4929 operation->ctx.tls12_prf.seed_length );
4930 mbedtls_free( operation->ctx.tls12_prf.seed );
4931 }
4932
4933 if( operation->ctx.tls12_prf.label != NULL )
4934 {
4935 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
4936 operation->ctx.tls12_prf.label_length );
4937 mbedtls_free( operation->ctx.tls12_prf.label );
4938 }
4939
4940 status = psa_hmac_abort_internal( &operation->ctx.tls12_prf.hmac );
4941
4942 /* We leave the fields Ai and output_block to be erased safely by the
4943 * mbedtls_platform_zeroize() in the end of this function. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004944 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004945 else
4946#endif /* MBEDTLS_MD_C */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004947 {
4948 status = PSA_ERROR_BAD_STATE;
4949 }
Janos Follath083036a2019-06-11 10:22:26 +01004950 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004951 return( status );
4952}
4953
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004954psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02004955 size_t *capacity)
4956{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004957 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004958 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004959 /* This is a blank key derivation operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02004960 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004961 }
4962
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004963 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004964 return( PSA_SUCCESS );
4965}
4966
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004967psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004968 size_t capacity )
4969{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004970 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004971 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004972 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004973 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004974 operation->capacity = capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004975 return( PSA_SUCCESS );
4976}
4977
Gilles Peskinebef7f142018-07-12 17:22:21 +02004978#if defined(MBEDTLS_MD_C)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004979/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02004980 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02004981static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskinebef7f142018-07-12 17:22:21 +02004982 psa_algorithm_t hash_alg,
4983 uint8_t *output,
4984 size_t output_length )
4985{
4986 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
4987 psa_status_t status;
4988
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004989 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
4990 return( PSA_ERROR_BAD_STATE );
4991 hkdf->state = HKDF_STATE_OUTPUT;
4992
Gilles Peskinebef7f142018-07-12 17:22:21 +02004993 while( output_length != 0 )
4994 {
4995 /* Copy what remains of the current block */
4996 uint8_t n = hash_length - hkdf->offset_in_block;
4997 if( n > output_length )
4998 n = (uint8_t) output_length;
4999 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
5000 output += n;
5001 output_length -= n;
5002 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02005003 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02005004 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02005005 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005006 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005007 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02005008 * object was corrupted or if this function is called directly
5009 * inside the library. */
5010 if( hkdf->block_number == 0xff )
5011 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02005012
5013 /* We need a new block */
5014 ++hkdf->block_number;
5015 hkdf->offset_in_block = 0;
5016 status = psa_hmac_setup_internal( &hkdf->hmac,
5017 hkdf->prk, hash_length,
5018 hash_alg );
5019 if( status != PSA_SUCCESS )
5020 return( status );
5021 if( hkdf->block_number != 1 )
5022 {
5023 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5024 hkdf->output_block,
5025 hash_length );
5026 if( status != PSA_SUCCESS )
5027 return( status );
5028 }
5029 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5030 hkdf->info,
5031 hkdf->info_length );
5032 if( status != PSA_SUCCESS )
5033 return( status );
5034 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5035 &hkdf->block_number, 1 );
5036 if( status != PSA_SUCCESS )
5037 return( status );
5038 status = psa_hmac_finish_internal( &hkdf->hmac,
5039 hkdf->output_block,
5040 sizeof( hkdf->output_block ) );
5041 if( status != PSA_SUCCESS )
5042 return( status );
5043 }
5044
5045 return( PSA_SUCCESS );
5046}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005047
Janos Follath7742fee2019-06-17 12:58:10 +01005048static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
5049 psa_tls12_prf_key_derivation_t *tls12_prf,
5050 psa_algorithm_t alg )
5051{
5052 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
5053 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
Janos Follathea29bfb2019-06-19 12:21:20 +01005054 psa_hash_operation_t backup = PSA_HASH_OPERATION_INIT;
5055 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005056
Janos Follath7742fee2019-06-17 12:58:10 +01005057 /* We can't be wanting more output after block 0xff, otherwise
5058 * the capacity check in psa_key_derivation_output_bytes() would have
5059 * prevented this call. It could happen only if the operation
5060 * object was corrupted or if this function is called directly
5061 * inside the library. */
5062 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01005063 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01005064
5065 /* We need a new block */
5066 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01005067 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01005068
5069 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
5070 *
5071 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
5072 *
5073 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
5074 * HMAC_hash(secret, A(2) + seed) +
5075 * HMAC_hash(secret, A(3) + seed) + ...
5076 *
5077 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01005078 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01005079 *
Janos Follathea29bfb2019-06-19 12:21:20 +01005080 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01005081 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01005082 * is currently extracted as `output_block` and where i is
5083 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01005084 */
5085
Janos Follathea29bfb2019-06-19 12:21:20 +01005086 /* Save the hash context before using it, to preserve the hash state with
5087 * only the inner padding in it. We need this, because inner padding depends
5088 * on the key (secret in the RFC's terminology). */
5089 status = psa_hash_clone( &tls12_prf->hmac.hash_ctx, &backup );
5090 if( status != PSA_SUCCESS )
5091 goto cleanup;
5092
5093 /* Calculate A(i) where i = tls12_prf->block_number. */
5094 if( tls12_prf->block_number == 1 )
5095 {
5096 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
5097 * the variable seed and in this instance means it in the context of the
5098 * P_hash function, where seed = label + seed.) */
5099 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5100 tls12_prf->label, tls12_prf->label_length );
5101 if( status != PSA_SUCCESS )
5102 goto cleanup;
5103 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5104 tls12_prf->seed, tls12_prf->seed_length );
5105 if( status != PSA_SUCCESS )
5106 goto cleanup;
5107 }
5108 else
5109 {
5110 /* A(i) = HMAC_hash(secret, A(i-1)) */
5111 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5112 tls12_prf->Ai, hash_length );
5113 if( status != PSA_SUCCESS )
5114 goto cleanup;
5115 }
5116
5117 status = psa_hmac_finish_internal( &tls12_prf->hmac,
5118 tls12_prf->Ai, hash_length );
5119 if( status != PSA_SUCCESS )
5120 goto cleanup;
5121 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
5122 if( status != PSA_SUCCESS )
5123 goto cleanup;
5124
5125 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
5126 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5127 tls12_prf->Ai, hash_length );
5128 if( status != PSA_SUCCESS )
5129 goto cleanup;
5130 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5131 tls12_prf->label, tls12_prf->label_length );
5132 if( status != PSA_SUCCESS )
5133 goto cleanup;
5134 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5135 tls12_prf->seed, tls12_prf->seed_length );
5136 if( status != PSA_SUCCESS )
5137 goto cleanup;
5138 status = psa_hmac_finish_internal( &tls12_prf->hmac,
5139 tls12_prf->output_block, hash_length );
5140 if( status != PSA_SUCCESS )
5141 goto cleanup;
5142 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
5143 if( status != PSA_SUCCESS )
5144 goto cleanup;
5145
Janos Follath7742fee2019-06-17 12:58:10 +01005146
5147cleanup:
5148
Janos Follathea29bfb2019-06-19 12:21:20 +01005149 cleanup_status = psa_hash_abort( &backup );
5150 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
5151 status = cleanup_status;
5152
5153 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01005154}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005155
Janos Follath844eb0e2019-06-19 12:10:49 +01005156static psa_status_t psa_key_derivation_tls12_prf_read(
5157 psa_tls12_prf_key_derivation_t *tls12_prf,
5158 psa_algorithm_t alg,
5159 uint8_t *output,
5160 size_t output_length )
5161{
5162 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
5163 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
5164 psa_status_t status;
5165 uint8_t offset, length;
5166
5167 while( output_length != 0 )
5168 {
5169 /* Check if we have fully processed the current block. */
5170 if( tls12_prf->left_in_block == 0 )
5171 {
5172 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
5173 alg );
5174 if( status != PSA_SUCCESS )
5175 return( status );
5176
5177 continue;
5178 }
5179
5180 if( tls12_prf->left_in_block > output_length )
5181 length = (uint8_t) output_length;
5182 else
5183 length = tls12_prf->left_in_block;
5184
5185 offset = hash_length - tls12_prf->left_in_block;
5186 memcpy( output, tls12_prf->output_block + offset, length );
5187 output += length;
5188 output_length -= length;
5189 tls12_prf->left_in_block -= length;
5190 }
5191
5192 return( PSA_SUCCESS );
5193}
Gilles Peskinebef7f142018-07-12 17:22:21 +02005194#endif /* MBEDTLS_MD_C */
5195
Janos Follath6c6c8fc2019-06-17 12:38:20 +01005196psa_status_t psa_key_derivation_output_bytes(
5197 psa_key_derivation_operation_t *operation,
5198 uint8_t *output,
5199 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005200{
5201 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005202 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005203
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005204 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005205 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005206 /* This is a blank operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02005207 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005208 }
5209
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005210 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005211 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005212 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005213 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005214 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02005215 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005216 goto exit;
5217 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005218 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005219 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005220 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005221 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02005222 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
5223 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005224 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02005225 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02005226 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005227 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005228 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005229
Gilles Peskinebef7f142018-07-12 17:22:21 +02005230#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005231 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02005232 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01005233 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005234 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02005235 output, output_length );
5236 }
Janos Follathadbec812019-06-14 11:05:39 +01005237 else
Janos Follathadbec812019-06-14 11:05:39 +01005238 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine969c5d62019-01-16 15:53:06 +01005239 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005240 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005241 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005242 kdf_alg, output,
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005243 output_length );
5244 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005245 else
5246#endif /* MBEDTLS_MD_C */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005247 {
5248 return( PSA_ERROR_BAD_STATE );
5249 }
5250
5251exit:
5252 if( status != PSA_SUCCESS )
5253 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005254 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005255 * This allows us to differentiate between exhausted operations and
5256 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
5257 * operations. */
5258 psa_algorithm_t alg = operation->alg;
5259 psa_key_derivation_abort( operation );
5260 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005261 memset( output, '!', output_length );
5262 }
5263 return( status );
5264}
5265
Gilles Peskine08542d82018-07-19 17:05:42 +02005266#if defined(MBEDTLS_DES_C)
5267static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
5268{
5269 if( data_size >= 8 )
5270 mbedtls_des_key_set_parity( data );
5271 if( data_size >= 16 )
5272 mbedtls_des_key_set_parity( data + 8 );
5273 if( data_size >= 24 )
5274 mbedtls_des_key_set_parity( data + 16 );
5275}
5276#endif /* MBEDTLS_DES_C */
5277
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005278static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005279 psa_key_slot_t *slot,
5280 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005281 psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005282{
5283 uint8_t *data = NULL;
5284 size_t bytes = PSA_BITS_TO_BYTES( bits );
5285 psa_status_t status;
5286
Gilles Peskine8e338702019-07-30 20:06:31 +02005287 if( ! key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005288 return( PSA_ERROR_INVALID_ARGUMENT );
5289 if( bits % 8 != 0 )
5290 return( PSA_ERROR_INVALID_ARGUMENT );
5291 data = mbedtls_calloc( 1, bytes );
5292 if( data == NULL )
5293 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5294
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005295 status = psa_key_derivation_output_bytes( operation, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005296 if( status != PSA_SUCCESS )
5297 goto exit;
Gilles Peskine08542d82018-07-19 17:05:42 +02005298#if defined(MBEDTLS_DES_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02005299 if( slot->attr.type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02005300 psa_des_set_key_parity( data, bytes );
5301#endif /* MBEDTLS_DES_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005302 status = psa_import_key_into_slot( slot, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005303
5304exit:
5305 mbedtls_free( data );
5306 return( status );
5307}
5308
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005309psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005310 psa_key_derivation_operation_t *operation,
Gilles Peskine98dd7792019-05-15 19:43:49 +02005311 psa_key_handle_t *handle )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005312{
5313 psa_status_t status;
5314 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005315 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02005316
5317 /* Reject any attempt to create a zero-length key so that we don't
5318 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
5319 if( psa_get_key_bits( attributes ) == 0 )
5320 return( PSA_ERROR_INVALID_ARGUMENT );
5321
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005322 if( ! operation->can_output_key )
5323 return( PSA_ERROR_NOT_PERMITTED );
5324
Gilles Peskinedf179142019-07-15 22:02:14 +02005325 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE,
5326 attributes, handle, &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02005327#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
5328 if( driver != NULL )
5329 {
5330 /* Deriving a key in a secure element is not implemented yet. */
5331 status = PSA_ERROR_NOT_SUPPORTED;
5332 }
5333#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005334 if( status == PSA_SUCCESS )
5335 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005336 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02005337 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005338 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005339 }
5340 if( status == PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02005341 status = psa_finish_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005342 if( status != PSA_SUCCESS )
5343 {
Gilles Peskine011e4282019-06-26 18:34:38 +02005344 psa_fail_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005345 *handle = 0;
5346 }
5347 return( status );
5348}
5349
Gilles Peskineeab56e42018-07-12 17:12:33 +02005350
5351
5352/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02005353/* Key derivation */
5354/****************************************************************/
5355
Gilles Peskine969c5d62019-01-16 15:53:06 +01005356static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005357 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005358 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005359{
Janos Follath5fe19732019-06-20 15:09:30 +01005360 /* Make sure that operation->ctx is properly zero-initialised. (Macro
5361 * initialisers for this union leave some bytes unspecified.) */
5362 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
5363
Gilles Peskine969c5d62019-01-16 15:53:06 +01005364 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005365#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005366 if( PSA_ALG_IS_HKDF( kdf_alg ) ||
5367 PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
5368 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005369 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01005370 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005371 size_t hash_size = PSA_HASH_SIZE( hash_alg );
5372 if( hash_size == 0 )
5373 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005374 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
5375 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02005376 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005377 {
5378 return( PSA_ERROR_NOT_SUPPORTED );
5379 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005380 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01005381 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005382 }
5383#endif /* MBEDTLS_MD_C */
Gilles Peskine969c5d62019-01-16 15:53:06 +01005384 else
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005385 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005386}
5387
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005388psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005389 psa_algorithm_t alg )
5390{
5391 psa_status_t status;
5392
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005393 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005394 return( PSA_ERROR_BAD_STATE );
5395
Gilles Peskine6843c292019-01-18 16:44:49 +01005396 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
5397 return( PSA_ERROR_INVALID_ARGUMENT );
5398 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005399 {
5400 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005401 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005402 }
5403 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
5404 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005405 status = psa_key_derivation_setup_kdf( operation, alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005406 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005407 else
5408 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005409
5410 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005411 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01005412 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005413}
5414
5415#if defined(MBEDTLS_MD_C)
Gilles Peskinecbe66502019-05-16 16:59:18 +02005416static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005417 psa_algorithm_t hash_alg,
5418 psa_key_derivation_step_t step,
5419 const uint8_t *data,
5420 size_t data_length )
5421{
5422 psa_status_t status;
5423 switch( step )
5424 {
Gilles Peskine03410b52019-05-16 16:05:19 +02005425 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02005426 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005427 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005428 status = psa_hmac_setup_internal( &hkdf->hmac,
5429 data, data_length,
5430 hash_alg );
5431 if( status != PSA_SUCCESS )
5432 return( status );
5433 hkdf->state = HKDF_STATE_STARTED;
5434 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02005435 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005436 /* If no salt was provided, use an empty salt. */
5437 if( hkdf->state == HKDF_STATE_INIT )
5438 {
5439 status = psa_hmac_setup_internal( &hkdf->hmac,
5440 NULL, 0,
Gilles Peskinef9ee6332019-04-11 21:22:52 +02005441 hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005442 if( status != PSA_SUCCESS )
5443 return( status );
5444 hkdf->state = HKDF_STATE_STARTED;
5445 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02005446 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005447 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005448 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5449 data, data_length );
5450 if( status != PSA_SUCCESS )
5451 return( status );
5452 status = psa_hmac_finish_internal( &hkdf->hmac,
5453 hkdf->prk,
5454 sizeof( hkdf->prk ) );
5455 if( status != PSA_SUCCESS )
5456 return( status );
5457 hkdf->offset_in_block = PSA_HASH_SIZE( hash_alg );
5458 hkdf->block_number = 0;
5459 hkdf->state = HKDF_STATE_KEYED;
5460 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02005461 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005462 if( hkdf->state == HKDF_STATE_OUTPUT )
5463 return( PSA_ERROR_BAD_STATE );
5464 if( hkdf->info_set )
5465 return( PSA_ERROR_BAD_STATE );
5466 hkdf->info_length = data_length;
5467 if( data_length != 0 )
5468 {
5469 hkdf->info = mbedtls_calloc( 1, data_length );
5470 if( hkdf->info == NULL )
5471 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5472 memcpy( hkdf->info, data, data_length );
5473 }
5474 hkdf->info_set = 1;
5475 return( PSA_SUCCESS );
5476 default:
5477 return( PSA_ERROR_INVALID_ARGUMENT );
5478 }
5479}
Janos Follathb03233e2019-06-11 15:30:30 +01005480
Janos Follathf08e2652019-06-13 09:05:41 +01005481static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
5482 const uint8_t *data,
5483 size_t data_length )
5484{
5485 if( prf->state != TLS12_PRF_STATE_INIT )
5486 return( PSA_ERROR_BAD_STATE );
5487
Janos Follathd6dce9f2019-07-04 09:11:38 +01005488 if( data_length != 0 )
5489 {
5490 prf->seed = mbedtls_calloc( 1, data_length );
5491 if( prf->seed == NULL )
5492 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01005493
Janos Follathd6dce9f2019-07-04 09:11:38 +01005494 memcpy( prf->seed, data, data_length );
5495 prf->seed_length = data_length;
5496 }
Janos Follathf08e2652019-06-13 09:05:41 +01005497
5498 prf->state = TLS12_PRF_STATE_SEED_SET;
5499
5500 return( PSA_SUCCESS );
5501}
5502
Janos Follath81550542019-06-13 14:26:34 +01005503static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
5504 psa_algorithm_t hash_alg,
5505 const uint8_t *data,
5506 size_t data_length )
5507{
5508 psa_status_t status;
5509 if( prf->state != TLS12_PRF_STATE_SEED_SET )
5510 return( PSA_ERROR_BAD_STATE );
5511
5512 status = psa_hmac_setup_internal( &prf->hmac, data, data_length, hash_alg );
5513 if( status != PSA_SUCCESS )
5514 return( status );
5515
5516 prf->state = TLS12_PRF_STATE_KEY_SET;
5517
5518 return( PSA_SUCCESS );
5519}
5520
Janos Follath6660f0e2019-06-17 08:44:03 +01005521static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
5522 psa_tls12_prf_key_derivation_t *prf,
5523 psa_algorithm_t hash_alg,
5524 const uint8_t *data,
5525 size_t data_length )
5526{
5527 psa_status_t status;
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02005528 uint8_t pms[ 4 + 2 * PSA_ALG_TLS12_PSK_TO_MS_MAX_PSK_LEN ];
5529 uint8_t *cur = pms;
Janos Follath6660f0e2019-06-17 08:44:03 +01005530
5531 if( data_length > PSA_ALG_TLS12_PSK_TO_MS_MAX_PSK_LEN )
5532 return( PSA_ERROR_INVALID_ARGUMENT );
5533
5534 /* Quoting RFC 4279, Section 2:
5535 *
5536 * The premaster secret is formed as follows: if the PSK is N octets
5537 * long, concatenate a uint16 with the value N, N zero octets, a second
5538 * uint16 with the value N, and the PSK itself.
5539 */
5540
Janos Follath40e13932019-06-26 13:22:29 +01005541 *cur++ = ( data_length >> 8 ) & 0xff;
5542 *cur++ = ( data_length >> 0 ) & 0xff;
5543 memset( cur, 0, data_length );
5544 cur += data_length;
5545 *cur++ = pms[0];
5546 *cur++ = pms[1];
5547 memcpy( cur, data, data_length );
5548 cur += data_length;
Janos Follath6660f0e2019-06-17 08:44:03 +01005549
Janos Follath40e13932019-06-26 13:22:29 +01005550 status = psa_tls12_prf_set_key( prf, hash_alg, pms, cur - pms );
Janos Follath6660f0e2019-06-17 08:44:03 +01005551
5552 mbedtls_platform_zeroize( pms, sizeof( pms ) );
5553 return( status );
5554}
5555
Janos Follath63028dd2019-06-13 09:15:47 +01005556static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
5557 const uint8_t *data,
5558 size_t data_length )
5559{
5560 if( prf->state != TLS12_PRF_STATE_KEY_SET )
5561 return( PSA_ERROR_BAD_STATE );
5562
Janos Follathd6dce9f2019-07-04 09:11:38 +01005563 if( data_length != 0 )
5564 {
5565 prf->label = mbedtls_calloc( 1, data_length );
5566 if( prf->label == NULL )
5567 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01005568
Janos Follathd6dce9f2019-07-04 09:11:38 +01005569 memcpy( prf->label, data, data_length );
5570 prf->label_length = data_length;
5571 }
Janos Follath63028dd2019-06-13 09:15:47 +01005572
5573 prf->state = TLS12_PRF_STATE_LABEL_SET;
5574
5575 return( PSA_SUCCESS );
5576}
5577
Janos Follathb03233e2019-06-11 15:30:30 +01005578static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
5579 psa_algorithm_t hash_alg,
5580 psa_key_derivation_step_t step,
5581 const uint8_t *data,
5582 size_t data_length )
5583{
Janos Follathb03233e2019-06-11 15:30:30 +01005584 switch( step )
5585 {
Janos Follathf08e2652019-06-13 09:05:41 +01005586 case PSA_KEY_DERIVATION_INPUT_SEED:
5587 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01005588 case PSA_KEY_DERIVATION_INPUT_SECRET:
5589 return( psa_tls12_prf_set_key( prf, hash_alg, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01005590 case PSA_KEY_DERIVATION_INPUT_LABEL:
5591 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01005592 default:
5593 return( PSA_ERROR_INVALID_ARGUMENT );
5594 }
5595}
Janos Follath6660f0e2019-06-17 08:44:03 +01005596
5597static psa_status_t psa_tls12_prf_psk_to_ms_input(
5598 psa_tls12_prf_key_derivation_t *prf,
5599 psa_algorithm_t hash_alg,
5600 psa_key_derivation_step_t step,
5601 const uint8_t *data,
5602 size_t data_length )
5603{
5604 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01005605 {
Janos Follath6660f0e2019-06-17 08:44:03 +01005606 return( psa_tls12_prf_psk_to_ms_set_key( prf, hash_alg,
5607 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01005608 }
Janos Follath6660f0e2019-06-17 08:44:03 +01005609
5610 return( psa_tls12_prf_input( prf, hash_alg, step, data, data_length ) );
5611}
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005612#endif /* MBEDTLS_MD_C */
5613
Gilles Peskineb8965192019-09-24 16:21:10 +02005614/** Check whether the given key type is acceptable for the given
5615 * input step of a key derivation.
5616 *
5617 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
5618 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
5619 * Both secret and non-secret inputs can alternatively have the type
5620 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
5621 * that the input was passed as a buffer rather than via a key object.
5622 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02005623static int psa_key_derivation_check_input_type(
5624 psa_key_derivation_step_t step,
5625 psa_key_type_t key_type )
5626{
5627 switch( step )
5628 {
5629 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb8965192019-09-24 16:21:10 +02005630 if( key_type == PSA_KEY_TYPE_DERIVE )
5631 return( PSA_SUCCESS );
5632 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005633 return( PSA_SUCCESS );
5634 break;
5635 case PSA_KEY_DERIVATION_INPUT_LABEL:
5636 case PSA_KEY_DERIVATION_INPUT_SALT:
5637 case PSA_KEY_DERIVATION_INPUT_INFO:
5638 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskineb8965192019-09-24 16:21:10 +02005639 if( key_type == PSA_KEY_TYPE_RAW_DATA )
5640 return( PSA_SUCCESS );
5641 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005642 return( PSA_SUCCESS );
5643 break;
5644 }
5645 return( PSA_ERROR_INVALID_ARGUMENT );
5646}
5647
Janos Follathb80a94e2019-06-12 15:54:46 +01005648static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005649 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005650 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005651 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005652 const uint8_t *data,
5653 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005654{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02005655 psa_status_t status;
5656 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
5657
5658 status = psa_key_derivation_check_input_type( step, key_type );
Gilles Peskine224b0d62019-09-23 18:13:17 +02005659 if( status != PSA_SUCCESS )
5660 goto exit;
5661
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005662#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005663 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005664 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005665 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005666 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005667 step, data, data_length );
5668 }
k-stachowiak012dcc42019-08-13 14:55:03 +02005669 else if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005670 {
Janos Follathb03233e2019-06-11 15:30:30 +01005671 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
5672 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5673 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01005674 }
5675 else if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
5676 {
5677 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
5678 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5679 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005680 }
5681 else
5682#endif /* MBEDTLS_MD_C */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005683 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005684 /* This can't happen unless the operation object was not initialized */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005685 return( PSA_ERROR_BAD_STATE );
5686 }
5687
Gilles Peskine224b0d62019-09-23 18:13:17 +02005688exit:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005689 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005690 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005691 return( status );
5692}
5693
Janos Follath51f4a0f2019-06-14 11:35:55 +01005694psa_status_t psa_key_derivation_input_bytes(
5695 psa_key_derivation_operation_t *operation,
5696 psa_key_derivation_step_t step,
5697 const uint8_t *data,
5698 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005699{
Gilles Peskineb8965192019-09-24 16:21:10 +02005700 return( psa_key_derivation_input_internal( operation, step,
5701 PSA_KEY_TYPE_NONE,
Janos Follathc5621512019-06-14 11:27:57 +01005702 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005703}
5704
Janos Follath51f4a0f2019-06-14 11:35:55 +01005705psa_status_t psa_key_derivation_input_key(
5706 psa_key_derivation_operation_t *operation,
5707 psa_key_derivation_step_t step,
5708 psa_key_handle_t handle )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005709{
5710 psa_key_slot_t *slot;
5711 psa_status_t status;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005712
Gilles Peskine28f8f302019-07-24 13:30:31 +02005713 status = psa_get_transparent_key( handle, &slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02005714 PSA_KEY_USAGE_DERIVE,
5715 operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005716 if( status != PSA_SUCCESS )
Gilles Peskine593773d2019-09-23 18:17:40 +02005717 {
5718 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005719 return( status );
Gilles Peskine593773d2019-09-23 18:17:40 +02005720 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005721
5722 /* Passing a key object as a SECRET input unlocks the permission
5723 * to output to a key object. */
5724 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5725 operation->can_output_key = 1;
5726
Janos Follathb80a94e2019-06-12 15:54:46 +01005727 return( psa_key_derivation_input_internal( operation,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005728 step, slot->attr.type,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02005729 slot->data.key.data,
5730 slot->data.key.bytes ) );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005731}
Gilles Peskineea0fb492018-07-12 17:17:20 +02005732
5733
5734
5735/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02005736/* Key agreement */
5737/****************************************************************/
5738
Gilles Peskinea05219c2018-11-16 16:02:56 +01005739#if defined(MBEDTLS_ECDH_C)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005740static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
5741 size_t peer_key_length,
5742 const mbedtls_ecp_keypair *our_key,
5743 uint8_t *shared_secret,
5744 size_t shared_secret_size,
5745 size_t *shared_secret_length )
5746{
Steven Cooremand4867872020-08-05 16:31:39 +02005747 mbedtls_ecp_keypair *their_key = NULL;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005748 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00005749 psa_status_t status;
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005750 size_t bits = 0;
Paul Elliott8ff510a2020-06-02 17:19:28 +01005751 psa_ecc_family_t curve = mbedtls_ecc_group_to_psa( our_key->grp.id, &bits );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005752 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005753
Steven Cooreman4fed4552020-08-03 14:46:03 +02005754 status = psa_load_ecp_representation( PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve),
5755 peer_key,
Steven Cooreman7f391872020-07-30 14:57:44 +02005756 peer_key_length,
Steven Cooreman7f391872020-07-30 14:57:44 +02005757 &their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00005758 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005759 goto exit;
5760
Jaeden Amero97271b32019-01-10 19:38:51 +00005761 status = mbedtls_to_psa_error(
Steven Cooremana2371e52020-07-28 14:30:39 +02005762 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
Jaeden Amero97271b32019-01-10 19:38:51 +00005763 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005764 goto exit;
Jaeden Amero97271b32019-01-10 19:38:51 +00005765 status = mbedtls_to_psa_error(
5766 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
5767 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005768 goto exit;
5769
Jaeden Amero97271b32019-01-10 19:38:51 +00005770 status = mbedtls_to_psa_error(
5771 mbedtls_ecdh_calc_secret( &ecdh,
5772 shared_secret_length,
5773 shared_secret, shared_secret_size,
5774 mbedtls_ctr_drbg_random,
5775 &global_data.ctr_drbg ) );
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005776 if( status != PSA_SUCCESS )
5777 goto exit;
5778 if( PSA_BITS_TO_BYTES( bits ) != *shared_secret_length )
5779 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005780
5781exit:
Gilles Peskine3e819b72019-12-20 14:09:55 +01005782 if( status != PSA_SUCCESS )
5783 mbedtls_platform_zeroize( shared_secret, shared_secret_size );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005784 mbedtls_ecdh_free( &ecdh );
Steven Cooremana2371e52020-07-28 14:30:39 +02005785 mbedtls_ecp_keypair_free( their_key );
Steven Cooreman6d839f02020-07-30 11:36:45 +02005786 mbedtls_free( their_key );
Steven Cooremana2371e52020-07-28 14:30:39 +02005787
Jaeden Amero97271b32019-01-10 19:38:51 +00005788 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005789}
Gilles Peskinea05219c2018-11-16 16:02:56 +01005790#endif /* MBEDTLS_ECDH_C */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005791
Gilles Peskine01d718c2018-09-18 12:01:02 +02005792#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
5793
Gilles Peskine0216fe12019-04-11 21:23:21 +02005794static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
5795 psa_key_slot_t *private_key,
5796 const uint8_t *peer_key,
5797 size_t peer_key_length,
5798 uint8_t *shared_secret,
5799 size_t shared_secret_size,
5800 size_t *shared_secret_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005801{
Gilles Peskine0216fe12019-04-11 21:23:21 +02005802 switch( alg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005803 {
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005804#if defined(MBEDTLS_ECDH_C)
Gilles Peskine0216fe12019-04-11 21:23:21 +02005805 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02005806 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005807 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremana2371e52020-07-28 14:30:39 +02005808 mbedtls_ecp_keypair *ecp = NULL;
Steven Cooreman7f391872020-07-30 14:57:44 +02005809 psa_status_t status = psa_load_ecp_representation(
Steven Cooreman4fed4552020-08-03 14:46:03 +02005810 private_key->attr.type,
Steven Cooreman7f391872020-07-30 14:57:44 +02005811 private_key->data.key.data,
5812 private_key->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02005813 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02005814 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02005815 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02005816 status = psa_key_agreement_ecdh( peer_key, peer_key_length,
Steven Cooremana2371e52020-07-28 14:30:39 +02005817 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02005818 shared_secret, shared_secret_size,
5819 shared_secret_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02005820 mbedtls_ecp_keypair_free( ecp );
5821 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02005822 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005823#endif /* MBEDTLS_ECDH_C */
Gilles Peskine01d718c2018-09-18 12:01:02 +02005824 default:
Gilles Peskine93f85002018-11-16 16:43:31 +01005825 (void) private_key;
5826 (void) peer_key;
5827 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02005828 (void) shared_secret;
5829 (void) shared_secret_size;
5830 (void) shared_secret_length;
Gilles Peskine01d718c2018-09-18 12:01:02 +02005831 return( PSA_ERROR_NOT_SUPPORTED );
5832 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02005833}
5834
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005835/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02005836 * to potentially free embedded data structures and wipe confidential data.
5837 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005838static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005839 psa_key_derivation_step_t step,
Gilles Peskine01d718c2018-09-18 12:01:02 +02005840 psa_key_slot_t *private_key,
5841 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005842 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005843{
5844 psa_status_t status;
5845 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
5846 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005847 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005848
5849 /* Step 1: run the secret agreement algorithm to generate the shared
5850 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02005851 status = psa_key_agreement_raw_internal( ka_alg,
5852 private_key,
5853 peer_key, peer_key_length,
itayzafrir0adf0fc2018-09-06 16:24:41 +03005854 shared_secret,
5855 sizeof( shared_secret ),
Gilles Peskine05d69892018-06-19 22:00:52 +02005856 &shared_secret_length );
Gilles Peskine53d991e2018-07-12 01:14:59 +02005857 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005858 goto exit;
5859
Gilles Peskineb0b255c2018-07-06 17:01:38 +02005860 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02005861 * the shared secret. A shared secret is permitted wherever a key
5862 * of type DERIVE is permitted. */
Janos Follathb80a94e2019-06-12 15:54:46 +01005863 status = psa_key_derivation_input_internal( operation, step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005864 PSA_KEY_TYPE_DERIVE,
Janos Follathb80a94e2019-06-12 15:54:46 +01005865 shared_secret,
5866 shared_secret_length );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005867
Gilles Peskine12313cd2018-06-20 00:20:32 +02005868exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01005869 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005870 return( status );
5871}
5872
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005873psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005874 psa_key_derivation_step_t step,
5875 psa_key_handle_t private_key,
5876 const uint8_t *peer_key,
5877 size_t peer_key_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005878{
Gilles Peskine2f060a82018-12-04 17:12:32 +01005879 psa_key_slot_t *slot;
Gilles Peskine08542d82018-07-19 17:05:42 +02005880 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005881 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005882 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine28f8f302019-07-24 13:30:31 +02005883 status = psa_get_transparent_key( private_key, &slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02005884 PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005885 if( status != PSA_SUCCESS )
5886 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005887 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01005888 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005889 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01005890 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005891 psa_key_derivation_abort( operation );
Gilles Peskine346797d2018-11-16 16:05:06 +01005892 return( status );
Gilles Peskineaf3baab2018-06-27 22:55:52 +02005893}
5894
Gilles Peskinebe697d82019-05-16 18:00:41 +02005895psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
5896 psa_key_handle_t private_key,
5897 const uint8_t *peer_key,
5898 size_t peer_key_length,
5899 uint8_t *output,
5900 size_t output_size,
5901 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02005902{
5903 psa_key_slot_t *slot;
5904 psa_status_t status;
5905
5906 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
5907 {
5908 status = PSA_ERROR_INVALID_ARGUMENT;
5909 goto exit;
5910 }
Gilles Peskine28f8f302019-07-24 13:30:31 +02005911 status = psa_get_transparent_key( private_key, &slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02005912 PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02005913 if( status != PSA_SUCCESS )
5914 goto exit;
5915
5916 status = psa_key_agreement_raw_internal( alg, slot,
5917 peer_key, peer_key_length,
5918 output, output_size,
5919 output_length );
5920
5921exit:
5922 if( status != PSA_SUCCESS )
5923 {
5924 /* If an error happens and is not handled properly, the output
5925 * may be used as a key to protect sensitive data. Arrange for such
5926 * a key to be random, which is likely to result in decryption or
5927 * verification errors. This is better than filling the buffer with
5928 * some constant data such as zeros, which would result in the data
5929 * being protected with a reproducible, easily knowable key.
5930 */
5931 psa_generate_random( output, output_size );
5932 *output_length = output_size;
5933 }
5934 return( status );
5935}
Gilles Peskine86a440b2018-11-12 18:39:40 +01005936
5937
5938/****************************************************************/
5939/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02005940/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02005941
Gilles Peskine4c317f42018-07-12 01:24:09 +02005942psa_status_t psa_generate_random( uint8_t *output,
Gilles Peskine53d991e2018-07-12 01:14:59 +02005943 size_t output_size )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005944{
Janos Follath24eed8d2019-11-22 13:21:35 +00005945 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005946 GUARD_MODULE_INITIALIZED;
5947
Gilles Peskinef181eca2019-08-07 13:49:00 +02005948 while( output_size > MBEDTLS_CTR_DRBG_MAX_REQUEST )
5949 {
5950 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg,
5951 output,
5952 MBEDTLS_CTR_DRBG_MAX_REQUEST );
5953 if( ret != 0 )
5954 return( mbedtls_to_psa_error( ret ) );
5955 output += MBEDTLS_CTR_DRBG_MAX_REQUEST;
5956 output_size -= MBEDTLS_CTR_DRBG_MAX_REQUEST;
5957 }
5958
Gilles Peskinee59236f2018-01-27 23:32:46 +01005959 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg, output, output_size );
5960 return( mbedtls_to_psa_error( ret ) );
5961}
5962
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005963#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
5964#include "mbedtls/entropy_poll.h"
5965
Gilles Peskine7228da22019-07-15 11:06:15 +02005966psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005967 size_t seed_size )
5968{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005969 if( global_data.initialized )
5970 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02005971
5972 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
5973 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
5974 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
5975 return( PSA_ERROR_INVALID_ARGUMENT );
5976
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005977 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005978}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005979#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005980
Gilles Peskinee56e8782019-04-26 17:34:02 +02005981#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_GENPRIME)
5982static psa_status_t psa_read_rsa_exponent( const uint8_t *domain_parameters,
5983 size_t domain_parameters_size,
5984 int *exponent )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005985{
Gilles Peskinee56e8782019-04-26 17:34:02 +02005986 size_t i;
5987 uint32_t acc = 0;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005988
Gilles Peskinee56e8782019-04-26 17:34:02 +02005989 if( domain_parameters_size == 0 )
5990 {
5991 *exponent = 65537;
5992 return( PSA_SUCCESS );
5993 }
5994
5995 /* Mbed TLS encodes the public exponent as an int. For simplicity, only
5996 * support values that fit in a 32-bit integer, which is larger than
5997 * int on just about every platform anyway. */
5998 if( domain_parameters_size > sizeof( acc ) )
5999 return( PSA_ERROR_NOT_SUPPORTED );
6000 for( i = 0; i < domain_parameters_size; i++ )
6001 acc = ( acc << 8 ) | domain_parameters[i];
6002 if( acc > INT_MAX )
6003 return( PSA_ERROR_NOT_SUPPORTED );
6004 *exponent = acc;
6005 return( PSA_SUCCESS );
6006}
6007#endif /* MBEDTLS_RSA_C && MBEDTLS_GENPRIME */
6008
Gilles Peskine35ef36b2019-05-16 19:42:05 +02006009static psa_status_t psa_generate_key_internal(
Gilles Peskinee56e8782019-04-26 17:34:02 +02006010 psa_key_slot_t *slot, size_t bits,
6011 const uint8_t *domain_parameters, size_t domain_parameters_size )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006012{
Gilles Peskine8e338702019-07-30 20:06:31 +02006013 psa_key_type_t type = slot->attr.type;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006014
Gilles Peskinee56e8782019-04-26 17:34:02 +02006015 if( domain_parameters == NULL && domain_parameters_size != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006016 return( PSA_ERROR_INVALID_ARGUMENT );
6017
Gilles Peskinee59236f2018-01-27 23:32:46 +01006018 if( key_type_is_raw_bytes( type ) )
6019 {
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006020 psa_status_t status;
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006021
6022 status = validate_unstructured_key_bit_size( slot->attr.type, bits );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006023 if( status != PSA_SUCCESS )
6024 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006025
6026 /* Allocate memory for the key */
Steven Cooreman75b74362020-07-28 14:30:13 +02006027 status = psa_allocate_buffer_to_slot( slot, PSA_BITS_TO_BYTES( bits ) );
6028 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02006029 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006030
Steven Cooreman71fd80d2020-07-07 21:12:27 +02006031 status = psa_generate_random( slot->data.key.data,
6032 slot->data.key.bytes );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006033 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006034 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006035
6036 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006037#if defined(MBEDTLS_DES_C)
6038 if( type == PSA_KEY_TYPE_DES )
Steven Cooreman71fd80d2020-07-07 21:12:27 +02006039 psa_des_set_key_parity( slot->data.key.data,
6040 slot->data.key.bytes );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006041#endif /* MBEDTLS_DES_C */
6042 }
6043 else
6044
6045#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_GENPRIME)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02006046 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006047 {
Steven Cooremana01795d2020-07-24 22:48:15 +02006048 mbedtls_rsa_context rsa;
Janos Follath24eed8d2019-11-22 13:21:35 +00006049 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee56e8782019-04-26 17:34:02 +02006050 int exponent;
6051 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006052 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
6053 return( PSA_ERROR_NOT_SUPPORTED );
6054 /* Accept only byte-aligned keys, for the same reasons as
6055 * in psa_import_rsa_key(). */
6056 if( bits % 8 != 0 )
6057 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinee56e8782019-04-26 17:34:02 +02006058 status = psa_read_rsa_exponent( domain_parameters,
6059 domain_parameters_size,
6060 &exponent );
6061 if( status != PSA_SUCCESS )
6062 return( status );
Steven Cooremana01795d2020-07-24 22:48:15 +02006063 mbedtls_rsa_init( &rsa, MBEDTLS_RSA_PKCS_V15, MBEDTLS_MD_NONE );
6064 ret = mbedtls_rsa_gen_key( &rsa,
Gilles Peskinee59236f2018-01-27 23:32:46 +01006065 mbedtls_ctr_drbg_random,
6066 &global_data.ctr_drbg,
6067 (unsigned int) bits,
6068 exponent );
6069 if( ret != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006070 return( mbedtls_to_psa_error( ret ) );
Steven Cooremana01795d2020-07-24 22:48:15 +02006071
6072 /* Make sure to always have an export representation available */
6073 size_t bytes = PSA_KEY_EXPORT_RSA_KEY_PAIR_MAX_SIZE( bits );
6074
Steven Cooreman75b74362020-07-28 14:30:13 +02006075 status = psa_allocate_buffer_to_slot( slot, bytes );
6076 if( status != PSA_SUCCESS )
Steven Cooremana01795d2020-07-24 22:48:15 +02006077 {
6078 mbedtls_rsa_free( &rsa );
Steven Cooreman29149862020-08-05 15:43:42 +02006079 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006080 }
Steven Cooremana01795d2020-07-24 22:48:15 +02006081
6082 status = psa_export_rsa_key( type,
6083 &rsa,
6084 slot->data.key.data,
6085 bytes,
6086 &slot->data.key.bytes );
6087 mbedtls_rsa_free( &rsa );
6088 if( status != PSA_SUCCESS )
Steven Cooremana01795d2020-07-24 22:48:15 +02006089 psa_remove_key_data_from_memory( slot );
Steven Cooreman560c28a2020-07-24 23:20:24 +02006090 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006091 }
6092 else
6093#endif /* MBEDTLS_RSA_C && MBEDTLS_GENPRIME */
6094
6095#if defined(MBEDTLS_ECP_C)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02006096 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006097 {
Paul Elliott8ff510a2020-06-02 17:19:28 +01006098 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY( type );
Gilles Peskine4295e8b2019-12-02 21:39:10 +01006099 mbedtls_ecp_group_id grp_id =
6100 mbedtls_ecc_group_of_psa( curve, PSA_BITS_TO_BYTES( bits ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006101 const mbedtls_ecp_curve_info *curve_info =
6102 mbedtls_ecp_curve_info_from_grp_id( grp_id );
Steven Cooremanacda8342020-07-24 23:09:52 +02006103 mbedtls_ecp_keypair ecp;
Janos Follath24eed8d2019-11-22 13:21:35 +00006104 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee56e8782019-04-26 17:34:02 +02006105 if( domain_parameters_size != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006106 return( PSA_ERROR_NOT_SUPPORTED );
6107 if( grp_id == MBEDTLS_ECP_DP_NONE || curve_info == NULL )
6108 return( PSA_ERROR_NOT_SUPPORTED );
6109 if( curve_info->bit_size != bits )
6110 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremanacda8342020-07-24 23:09:52 +02006111 mbedtls_ecp_keypair_init( &ecp );
6112 ret = mbedtls_ecp_gen_key( grp_id, &ecp,
Gilles Peskinee59236f2018-01-27 23:32:46 +01006113 mbedtls_ctr_drbg_random,
6114 &global_data.ctr_drbg );
6115 if( ret != 0 )
6116 {
Steven Cooremanacda8342020-07-24 23:09:52 +02006117 mbedtls_ecp_keypair_free( &ecp );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006118 return( mbedtls_to_psa_error( ret ) );
6119 }
Steven Cooremanacda8342020-07-24 23:09:52 +02006120
6121
6122 /* Make sure to always have an export representation available */
6123 size_t bytes = PSA_BITS_TO_BYTES( bits );
Steven Cooreman75b74362020-07-28 14:30:13 +02006124 psa_status_t status = psa_allocate_buffer_to_slot( slot, bytes );
6125 if( status != PSA_SUCCESS )
Steven Cooremanacda8342020-07-24 23:09:52 +02006126 {
6127 mbedtls_ecp_keypair_free( &ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02006128 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02006129 }
Steven Cooreman75b74362020-07-28 14:30:13 +02006130
6131 status = mbedtls_to_psa_error(
Steven Cooremanacda8342020-07-24 23:09:52 +02006132 mbedtls_ecp_write_key( &ecp, slot->data.key.data, bytes ) );
6133
6134 mbedtls_ecp_keypair_free( &ecp );
Steven Cooremanb7f6dea2020-08-05 16:07:20 +02006135 if( status != PSA_SUCCESS ) {
6136 memset( slot->data.key.data, 0, bytes );
Steven Cooremanacda8342020-07-24 23:09:52 +02006137 psa_remove_key_data_from_memory( slot );
Steven Cooremanb7f6dea2020-08-05 16:07:20 +02006138 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02006139 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006140 }
6141 else
6142#endif /* MBEDTLS_ECP_C */
Steven Cooreman29149862020-08-05 15:43:42 +02006143 {
Gilles Peskinee59236f2018-01-27 23:32:46 +01006144 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman29149862020-08-05 15:43:42 +02006145 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01006146
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006147 return( PSA_SUCCESS );
6148}
Darryl Green0c6575a2018-11-07 16:05:30 +00006149
Gilles Peskine35ef36b2019-05-16 19:42:05 +02006150psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Gilles Peskinee56e8782019-04-26 17:34:02 +02006151 psa_key_handle_t *handle )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006152{
6153 psa_status_t status;
6154 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02006155 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine11792082019-08-06 18:36:36 +02006156
Gilles Peskine0f84d622019-09-12 19:03:13 +02006157 /* Reject any attempt to create a zero-length key so that we don't
6158 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
6159 if( psa_get_key_bits( attributes ) == 0 )
6160 return( PSA_ERROR_INVALID_ARGUMENT );
6161
Gilles Peskinedf179142019-07-15 22:02:14 +02006162 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE,
6163 attributes, handle, &slot, &driver );
Gilles Peskine11792082019-08-06 18:36:36 +02006164 if( status != PSA_SUCCESS )
6165 goto exit;
6166
Steven Cooreman2a1664c2020-07-20 15:33:08 +02006167 status = psa_driver_wrapper_generate_key( attributes,
6168 slot );
6169 if( status != PSA_ERROR_NOT_SUPPORTED ||
6170 psa_key_lifetime_is_external( attributes->core.lifetime ) )
6171 goto exit;
6172
6173 status = psa_generate_key_internal(
6174 slot, attributes->core.bits,
6175 attributes->domain_parameters, attributes->domain_parameters_size );
Gilles Peskine11792082019-08-06 18:36:36 +02006176
6177exit:
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006178 if( status == PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02006179 status = psa_finish_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006180 if( status != PSA_SUCCESS )
6181 {
Gilles Peskine011e4282019-06-26 18:34:38 +02006182 psa_fail_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006183 *handle = 0;
6184 }
Darryl Green0c6575a2018-11-07 16:05:30 +00006185 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006186}
6187
6188
Gilles Peskinee59236f2018-01-27 23:32:46 +01006189
6190/****************************************************************/
6191/* Module setup */
6192/****************************************************************/
6193
Gilles Peskine5e769522018-11-20 21:59:56 +01006194psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
6195 void (* entropy_init )( mbedtls_entropy_context *ctx ),
6196 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
6197{
6198 if( global_data.rng_state != RNG_NOT_INITIALIZED )
6199 return( PSA_ERROR_BAD_STATE );
6200 global_data.entropy_init = entropy_init;
6201 global_data.entropy_free = entropy_free;
6202 return( PSA_SUCCESS );
6203}
6204
Gilles Peskinee59236f2018-01-27 23:32:46 +01006205void mbedtls_psa_crypto_free( void )
6206{
Gilles Peskine66fb1262018-12-10 16:29:04 +01006207 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006208 if( global_data.rng_state != RNG_NOT_INITIALIZED )
6209 {
6210 mbedtls_ctr_drbg_free( &global_data.ctr_drbg );
Gilles Peskine5e769522018-11-20 21:59:56 +01006211 global_data.entropy_free( &global_data.entropy );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006212 }
6213 /* Wipe all remaining data, including configuration.
6214 * In particular, this sets all state indicator to the value
6215 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01006216 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Gilles Peskinea8ade162019-06-26 11:24:49 +02006217#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +02006218 /* Unregister all secure element drivers, so that we restart from
6219 * a pristine state. */
6220 psa_unregister_all_se_drivers( );
Gilles Peskinea8ade162019-06-26 11:24:49 +02006221#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006222}
6223
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006224#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
6225/** Recover a transaction that was interrupted by a power failure.
6226 *
6227 * This function is called during initialization, before psa_crypto_init()
6228 * returns. If this function returns a failure status, the initialization
6229 * fails.
6230 */
6231static psa_status_t psa_crypto_recover_transaction(
6232 const psa_crypto_transaction_t *transaction )
6233{
6234 switch( transaction->unknown.type )
6235 {
6236 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
6237 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01006238 /* TODO - fall through to the failure case until this
Gilles Peskinec9d7f942019-08-13 16:17:16 +02006239 * is implemented.
6240 * https://github.com/ARMmbed/mbed-crypto/issues/218
6241 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006242 default:
6243 /* We found an unsupported transaction in the storage.
6244 * We don't know what state the storage is in. Give up. */
6245 return( PSA_ERROR_STORAGE_FAILURE );
6246 }
6247}
6248#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
6249
Gilles Peskinee59236f2018-01-27 23:32:46 +01006250psa_status_t psa_crypto_init( void )
6251{
Gilles Peskine66fb1262018-12-10 16:29:04 +01006252 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006253 const unsigned char drbg_seed[] = "PSA";
6254
Gilles Peskinec6b69072018-11-20 21:42:52 +01006255 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006256 if( global_data.initialized != 0 )
6257 return( PSA_SUCCESS );
6258
Gilles Peskine5e769522018-11-20 21:59:56 +01006259 /* Set default configuration if
6260 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
6261 if( global_data.entropy_init == NULL )
6262 global_data.entropy_init = mbedtls_entropy_init;
6263 if( global_data.entropy_free == NULL )
6264 global_data.entropy_free = mbedtls_entropy_free;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006265
Gilles Peskinec6b69072018-11-20 21:42:52 +01006266 /* Initialize the random generator. */
Gilles Peskine5e769522018-11-20 21:59:56 +01006267 global_data.entropy_init( &global_data.entropy );
Jaeden Amero76541612019-06-04 17:14:43 +01006268#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
6269 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
6270 /* The PSA entropy injection feature depends on using NV seed as an entropy
6271 * source. Add NV seed as an entropy source for PSA entropy injection. */
6272 mbedtls_entropy_add_source( &global_data.entropy,
6273 mbedtls_nv_seed_poll, NULL,
6274 MBEDTLS_ENTROPY_BLOCK_SIZE,
6275 MBEDTLS_ENTROPY_SOURCE_STRONG );
6276#endif
Gilles Peskinee59236f2018-01-27 23:32:46 +01006277 mbedtls_ctr_drbg_init( &global_data.ctr_drbg );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006278 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine66fb1262018-12-10 16:29:04 +01006279 status = mbedtls_to_psa_error(
6280 mbedtls_ctr_drbg_seed( &global_data.ctr_drbg,
6281 mbedtls_entropy_func,
6282 &global_data.entropy,
6283 drbg_seed, sizeof( drbg_seed ) - 1 ) );
6284 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006285 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01006286 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006287
Gilles Peskine66fb1262018-12-10 16:29:04 +01006288 status = psa_initialize_key_slots( );
6289 if( status != PSA_SUCCESS )
6290 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01006291
Gilles Peskined9348f22019-10-01 15:22:29 +02006292#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
6293 status = psa_init_all_se_drivers( );
6294 if( status != PSA_SUCCESS )
6295 goto exit;
6296#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
6297
Gilles Peskine4b734222019-07-24 15:56:31 +02006298#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02006299 status = psa_crypto_load_transaction( );
6300 if( status == PSA_SUCCESS )
6301 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006302 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
6303 if( status != PSA_SUCCESS )
6304 goto exit;
6305 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02006306 }
6307 else if( status == PSA_ERROR_DOES_NOT_EXIST )
6308 {
6309 /* There's no transaction to complete. It's all good. */
6310 status = PSA_SUCCESS;
6311 }
Gilles Peskine4b734222019-07-24 15:56:31 +02006312#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02006313
Gilles Peskinec6b69072018-11-20 21:42:52 +01006314 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006315 global_data.initialized = 1;
6316
6317exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01006318 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006319 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01006320 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006321}
6322
6323#endif /* MBEDTLS_PSA_CRYPTO_C */