blob: e45c52e0b1336c7efa1bf96a15d42918d3fc58a4 [file] [log] [blame]
Gilles Peskinee59236f2018-01-27 23:32:46 +01001/*
2 * PSA crypto layer on top of Mbed TLS crypto
3 */
Bence Szépkúti86974652020-06-15 11:59:37 +02004/*
Bence Szépkúti1e148272020-08-07 13:07:28 +02005 * Copyright The Mbed TLS Contributors
Gilles Peskinee59236f2018-01-27 23:32:46 +01006 * SPDX-License-Identifier: Apache-2.0
7 *
8 * Licensed under the Apache License, Version 2.0 (the "License"); you may
9 * not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
Gilles Peskinee59236f2018-01-27 23:32:46 +010019 */
20
Gilles Peskinedb09ef62020-06-03 01:43:33 +020021#include "common.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010022
23#if defined(MBEDTLS_PSA_CRYPTO_C)
mohammad160327010052018-07-03 13:16:15 +030024
itayzafrir7723ab12019-02-14 10:28:02 +020025#include "psa_crypto_service_integration.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010026#include "psa/crypto.h"
27
Gilles Peskine039b90c2018-12-07 18:24:41 +010028#include "psa_crypto_core.h"
Gilles Peskine5e769522018-11-20 21:59:56 +010029#include "psa_crypto_invasive.h"
Steven Cooremancd84cb42020-07-16 20:28:36 +020030#include "psa_crypto_driver_wrappers.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020031#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +020032#include "psa_crypto_se.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020033#endif
Gilles Peskine961849f2018-11-30 18:54:54 +010034#include "psa_crypto_slot_management.h"
Darryl Greend49a4992018-06-18 17:27:26 +010035/* Include internal declarations that are useful for implementing persistently
36 * stored keys. */
37#include "psa_crypto_storage.h"
38
Gilles Peskineb46bef22019-07-30 21:32:04 +020039#include <assert.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010040#include <stdlib.h>
41#include <string.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010042#include "mbedtls/platform.h"
Gilles Peskineff2d2002019-05-06 15:26:23 +020043#if !defined(MBEDTLS_PLATFORM_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010044#define mbedtls_calloc calloc
45#define mbedtls_free free
46#endif
47
Gilles Peskinea5905292018-02-07 20:59:33 +010048#include "mbedtls/arc4.h"
Gilles Peskine9a944802018-06-21 09:35:35 +020049#include "mbedtls/asn1.h"
Jaeden Amero25384a22019-01-10 10:23:21 +000050#include "mbedtls/asn1write.h"
Gilles Peskinea81d85b2018-06-26 16:10:23 +020051#include "mbedtls/bignum.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010052#include "mbedtls/blowfish.h"
53#include "mbedtls/camellia.h"
Gilles Peskine26869f22019-05-06 15:25:00 +020054#include "mbedtls/chacha20.h"
55#include "mbedtls/chachapoly.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010056#include "mbedtls/cipher.h"
57#include "mbedtls/ccm.h"
58#include "mbedtls/cmac.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010059#include "mbedtls/ctr_drbg.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010060#include "mbedtls/des.h"
Gilles Peskineb7ecdf02018-09-18 12:11:27 +020061#include "mbedtls/ecdh.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010062#include "mbedtls/ecp.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010063#include "mbedtls/entropy.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010064#include "mbedtls/error.h"
65#include "mbedtls/gcm.h"
66#include "mbedtls/md2.h"
67#include "mbedtls/md4.h"
68#include "mbedtls/md5.h"
Gilles Peskine20035e32018-02-03 22:44:14 +010069#include "mbedtls/md.h"
70#include "mbedtls/md_internal.h"
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010071#include "mbedtls/pk.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010072#include "mbedtls/pk_internal.h"
Gilles Peskine3f108122018-12-07 18:14:53 +010073#include "mbedtls/platform_util.h"
Janos Follath24eed8d2019-11-22 13:21:35 +000074#include "mbedtls/error.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010075#include "mbedtls/ripemd160.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010076#include "mbedtls/rsa.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010077#include "mbedtls/sha1.h"
78#include "mbedtls/sha256.h"
79#include "mbedtls/sha512.h"
80#include "mbedtls/xtea.h"
81
Gilles Peskine996deb12018-08-01 15:45:45 +020082#define ARRAY_LENGTH( array ) ( sizeof( array ) / sizeof( *( array ) ) )
83
Gilles Peskine9ef733f2018-02-07 21:05:37 +010084/* constant-time buffer comparison */
85static inline int safer_memcmp( const uint8_t *a, const uint8_t *b, size_t n )
86{
87 size_t i;
88 unsigned char diff = 0;
89
90 for( i = 0; i < n; i++ )
91 diff |= a[i] ^ b[i];
92
93 return( diff );
94}
95
96
97
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010098/****************************************************************/
99/* Global data, support functions and library management */
100/****************************************************************/
101
Gilles Peskine48c0ea12018-06-21 14:15:31 +0200102static int key_type_is_raw_bytes( psa_key_type_t type )
103{
Gilles Peskine78b3bb62018-08-10 16:03:41 +0200104 return( PSA_KEY_TYPE_IS_UNSTRUCTURED( type ) );
Gilles Peskine48c0ea12018-06-21 14:15:31 +0200105}
106
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100107/* Values for psa_global_data_t::rng_state */
108#define RNG_NOT_INITIALIZED 0
109#define RNG_INITIALIZED 1
110#define RNG_SEEDED 2
Gilles Peskinec6b69072018-11-20 21:42:52 +0100111
Gilles Peskine2d277862018-06-18 15:41:12 +0200112typedef struct
113{
Gilles Peskine5e769522018-11-20 21:59:56 +0100114 void (* entropy_init )( mbedtls_entropy_context *ctx );
115 void (* entropy_free )( mbedtls_entropy_context *ctx );
Gilles Peskinee59236f2018-01-27 23:32:46 +0100116 mbedtls_entropy_context entropy;
117 mbedtls_ctr_drbg_context ctr_drbg;
Gilles Peskinec6b69072018-11-20 21:42:52 +0100118 unsigned initialized : 1;
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100119 unsigned rng_state : 2;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100120} psa_global_data_t;
121
122static psa_global_data_t global_data;
123
itayzafrir0adf0fc2018-09-06 16:24:41 +0300124#define GUARD_MODULE_INITIALIZED \
125 if( global_data.initialized == 0 ) \
126 return( PSA_ERROR_BAD_STATE );
127
Steven Cooreman01164162020-07-20 15:31:37 +0200128psa_status_t mbedtls_to_psa_error( int ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100129{
Gilles Peskinea5905292018-02-07 20:59:33 +0100130 /* If there's both a high-level code and low-level code, dispatch on
131 * the high-level code. */
132 switch( ret < -0x7f ? - ( -ret & 0x7f80 ) : ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100133 {
134 case 0:
135 return( PSA_SUCCESS );
Gilles Peskinea5905292018-02-07 20:59:33 +0100136
137 case MBEDTLS_ERR_AES_INVALID_KEY_LENGTH:
138 case MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH:
139 case MBEDTLS_ERR_AES_FEATURE_UNAVAILABLE:
140 return( PSA_ERROR_NOT_SUPPORTED );
141 case MBEDTLS_ERR_AES_HW_ACCEL_FAILED:
142 return( PSA_ERROR_HARDWARE_FAILURE );
143
144 case MBEDTLS_ERR_ARC4_HW_ACCEL_FAILED:
145 return( PSA_ERROR_HARDWARE_FAILURE );
146
Gilles Peskine9a944802018-06-21 09:35:35 +0200147 case MBEDTLS_ERR_ASN1_OUT_OF_DATA:
148 case MBEDTLS_ERR_ASN1_UNEXPECTED_TAG:
149 case MBEDTLS_ERR_ASN1_INVALID_LENGTH:
150 case MBEDTLS_ERR_ASN1_LENGTH_MISMATCH:
151 case MBEDTLS_ERR_ASN1_INVALID_DATA:
152 return( PSA_ERROR_INVALID_ARGUMENT );
153 case MBEDTLS_ERR_ASN1_ALLOC_FAILED:
154 return( PSA_ERROR_INSUFFICIENT_MEMORY );
155 case MBEDTLS_ERR_ASN1_BUF_TOO_SMALL:
156 return( PSA_ERROR_BUFFER_TOO_SMALL );
157
Jaeden Amero93e21112019-02-20 13:57:28 +0000158#if defined(MBEDTLS_ERR_BLOWFISH_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000159 case MBEDTLS_ERR_BLOWFISH_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000160#elif defined(MBEDTLS_ERR_BLOWFISH_INVALID_KEY_LENGTH)
161 case MBEDTLS_ERR_BLOWFISH_INVALID_KEY_LENGTH:
162#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100163 case MBEDTLS_ERR_BLOWFISH_INVALID_INPUT_LENGTH:
164 return( PSA_ERROR_NOT_SUPPORTED );
165 case MBEDTLS_ERR_BLOWFISH_HW_ACCEL_FAILED:
166 return( PSA_ERROR_HARDWARE_FAILURE );
167
Jaeden Amero93e21112019-02-20 13:57:28 +0000168#if defined(MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000169 case MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000170#elif defined(MBEDTLS_ERR_CAMELLIA_INVALID_KEY_LENGTH)
171 case MBEDTLS_ERR_CAMELLIA_INVALID_KEY_LENGTH:
172#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100173 case MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH:
174 return( PSA_ERROR_NOT_SUPPORTED );
175 case MBEDTLS_ERR_CAMELLIA_HW_ACCEL_FAILED:
176 return( PSA_ERROR_HARDWARE_FAILURE );
177
178 case MBEDTLS_ERR_CCM_BAD_INPUT:
179 return( PSA_ERROR_INVALID_ARGUMENT );
180 case MBEDTLS_ERR_CCM_AUTH_FAILED:
181 return( PSA_ERROR_INVALID_SIGNATURE );
182 case MBEDTLS_ERR_CCM_HW_ACCEL_FAILED:
183 return( PSA_ERROR_HARDWARE_FAILURE );
184
Gilles Peskine26869f22019-05-06 15:25:00 +0200185 case MBEDTLS_ERR_CHACHA20_BAD_INPUT_DATA:
186 return( PSA_ERROR_INVALID_ARGUMENT );
187
188 case MBEDTLS_ERR_CHACHAPOLY_BAD_STATE:
189 return( PSA_ERROR_BAD_STATE );
190 case MBEDTLS_ERR_CHACHAPOLY_AUTH_FAILED:
191 return( PSA_ERROR_INVALID_SIGNATURE );
192
Gilles Peskinea5905292018-02-07 20:59:33 +0100193 case MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE:
194 return( PSA_ERROR_NOT_SUPPORTED );
195 case MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA:
196 return( PSA_ERROR_INVALID_ARGUMENT );
197 case MBEDTLS_ERR_CIPHER_ALLOC_FAILED:
198 return( PSA_ERROR_INSUFFICIENT_MEMORY );
199 case MBEDTLS_ERR_CIPHER_INVALID_PADDING:
200 return( PSA_ERROR_INVALID_PADDING );
201 case MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED:
Fredrik Strupef90e3012020-09-28 16:11:33 +0200202 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100203 case MBEDTLS_ERR_CIPHER_AUTH_FAILED:
204 return( PSA_ERROR_INVALID_SIGNATURE );
205 case MBEDTLS_ERR_CIPHER_INVALID_CONTEXT:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200206 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100207 case MBEDTLS_ERR_CIPHER_HW_ACCEL_FAILED:
208 return( PSA_ERROR_HARDWARE_FAILURE );
209
210 case MBEDTLS_ERR_CMAC_HW_ACCEL_FAILED:
211 return( PSA_ERROR_HARDWARE_FAILURE );
212
213 case MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED:
214 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
215 case MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG:
216 case MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG:
217 return( PSA_ERROR_NOT_SUPPORTED );
218 case MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR:
219 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
220
221 case MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH:
222 return( PSA_ERROR_NOT_SUPPORTED );
223 case MBEDTLS_ERR_DES_HW_ACCEL_FAILED:
224 return( PSA_ERROR_HARDWARE_FAILURE );
225
Gilles Peskinee59236f2018-01-27 23:32:46 +0100226 case MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED:
227 case MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE:
228 case MBEDTLS_ERR_ENTROPY_SOURCE_FAILED:
229 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskinea5905292018-02-07 20:59:33 +0100230
231 case MBEDTLS_ERR_GCM_AUTH_FAILED:
232 return( PSA_ERROR_INVALID_SIGNATURE );
233 case MBEDTLS_ERR_GCM_BAD_INPUT:
Gilles Peskine8cac2e62018-08-21 15:07:38 +0200234 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100235 case MBEDTLS_ERR_GCM_HW_ACCEL_FAILED:
236 return( PSA_ERROR_HARDWARE_FAILURE );
237
238 case MBEDTLS_ERR_MD2_HW_ACCEL_FAILED:
239 case MBEDTLS_ERR_MD4_HW_ACCEL_FAILED:
240 case MBEDTLS_ERR_MD5_HW_ACCEL_FAILED:
241 return( PSA_ERROR_HARDWARE_FAILURE );
242
243 case MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE:
244 return( PSA_ERROR_NOT_SUPPORTED );
245 case MBEDTLS_ERR_MD_BAD_INPUT_DATA:
246 return( PSA_ERROR_INVALID_ARGUMENT );
247 case MBEDTLS_ERR_MD_ALLOC_FAILED:
248 return( PSA_ERROR_INSUFFICIENT_MEMORY );
249 case MBEDTLS_ERR_MD_FILE_IO_ERROR:
250 return( PSA_ERROR_STORAGE_FAILURE );
251 case MBEDTLS_ERR_MD_HW_ACCEL_FAILED:
252 return( PSA_ERROR_HARDWARE_FAILURE );
253
Gilles Peskinef76aa772018-10-29 19:24:33 +0100254 case MBEDTLS_ERR_MPI_FILE_IO_ERROR:
255 return( PSA_ERROR_STORAGE_FAILURE );
256 case MBEDTLS_ERR_MPI_BAD_INPUT_DATA:
257 return( PSA_ERROR_INVALID_ARGUMENT );
258 case MBEDTLS_ERR_MPI_INVALID_CHARACTER:
259 return( PSA_ERROR_INVALID_ARGUMENT );
260 case MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL:
261 return( PSA_ERROR_BUFFER_TOO_SMALL );
262 case MBEDTLS_ERR_MPI_NEGATIVE_VALUE:
263 return( PSA_ERROR_INVALID_ARGUMENT );
264 case MBEDTLS_ERR_MPI_DIVISION_BY_ZERO:
265 return( PSA_ERROR_INVALID_ARGUMENT );
266 case MBEDTLS_ERR_MPI_NOT_ACCEPTABLE:
267 return( PSA_ERROR_INVALID_ARGUMENT );
268 case MBEDTLS_ERR_MPI_ALLOC_FAILED:
269 return( PSA_ERROR_INSUFFICIENT_MEMORY );
270
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100271 case MBEDTLS_ERR_PK_ALLOC_FAILED:
272 return( PSA_ERROR_INSUFFICIENT_MEMORY );
273 case MBEDTLS_ERR_PK_TYPE_MISMATCH:
274 case MBEDTLS_ERR_PK_BAD_INPUT_DATA:
275 return( PSA_ERROR_INVALID_ARGUMENT );
276 case MBEDTLS_ERR_PK_FILE_IO_ERROR:
Gilles Peskinea5905292018-02-07 20:59:33 +0100277 return( PSA_ERROR_STORAGE_FAILURE );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100278 case MBEDTLS_ERR_PK_KEY_INVALID_VERSION:
279 case MBEDTLS_ERR_PK_KEY_INVALID_FORMAT:
280 return( PSA_ERROR_INVALID_ARGUMENT );
281 case MBEDTLS_ERR_PK_UNKNOWN_PK_ALG:
282 return( PSA_ERROR_NOT_SUPPORTED );
283 case MBEDTLS_ERR_PK_PASSWORD_REQUIRED:
284 case MBEDTLS_ERR_PK_PASSWORD_MISMATCH:
285 return( PSA_ERROR_NOT_PERMITTED );
286 case MBEDTLS_ERR_PK_INVALID_PUBKEY:
287 return( PSA_ERROR_INVALID_ARGUMENT );
288 case MBEDTLS_ERR_PK_INVALID_ALG:
289 case MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE:
290 case MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE:
291 return( PSA_ERROR_NOT_SUPPORTED );
292 case MBEDTLS_ERR_PK_SIG_LEN_MISMATCH:
293 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskinea5905292018-02-07 20:59:33 +0100294 case MBEDTLS_ERR_PK_HW_ACCEL_FAILED:
295 return( PSA_ERROR_HARDWARE_FAILURE );
296
Gilles Peskineff2d2002019-05-06 15:26:23 +0200297 case MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED:
298 return( PSA_ERROR_HARDWARE_FAILURE );
299 case MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED:
300 return( PSA_ERROR_NOT_SUPPORTED );
301
Gilles Peskinea5905292018-02-07 20:59:33 +0100302 case MBEDTLS_ERR_RIPEMD160_HW_ACCEL_FAILED:
303 return( PSA_ERROR_HARDWARE_FAILURE );
304
305 case MBEDTLS_ERR_RSA_BAD_INPUT_DATA:
306 return( PSA_ERROR_INVALID_ARGUMENT );
307 case MBEDTLS_ERR_RSA_INVALID_PADDING:
308 return( PSA_ERROR_INVALID_PADDING );
309 case MBEDTLS_ERR_RSA_KEY_GEN_FAILED:
310 return( PSA_ERROR_HARDWARE_FAILURE );
311 case MBEDTLS_ERR_RSA_KEY_CHECK_FAILED:
312 return( PSA_ERROR_INVALID_ARGUMENT );
313 case MBEDTLS_ERR_RSA_PUBLIC_FAILED:
314 case MBEDTLS_ERR_RSA_PRIVATE_FAILED:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200315 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100316 case MBEDTLS_ERR_RSA_VERIFY_FAILED:
317 return( PSA_ERROR_INVALID_SIGNATURE );
318 case MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE:
319 return( PSA_ERROR_BUFFER_TOO_SMALL );
320 case MBEDTLS_ERR_RSA_RNG_FAILED:
321 return( PSA_ERROR_INSUFFICIENT_MEMORY );
322 case MBEDTLS_ERR_RSA_UNSUPPORTED_OPERATION:
323 return( PSA_ERROR_NOT_SUPPORTED );
324 case MBEDTLS_ERR_RSA_HW_ACCEL_FAILED:
325 return( PSA_ERROR_HARDWARE_FAILURE );
326
327 case MBEDTLS_ERR_SHA1_HW_ACCEL_FAILED:
328 case MBEDTLS_ERR_SHA256_HW_ACCEL_FAILED:
329 case MBEDTLS_ERR_SHA512_HW_ACCEL_FAILED:
330 return( PSA_ERROR_HARDWARE_FAILURE );
331
332 case MBEDTLS_ERR_XTEA_INVALID_INPUT_LENGTH:
333 return( PSA_ERROR_INVALID_ARGUMENT );
334 case MBEDTLS_ERR_XTEA_HW_ACCEL_FAILED:
335 return( PSA_ERROR_HARDWARE_FAILURE );
336
itayzafrir5c753392018-05-08 11:18:38 +0300337 case MBEDTLS_ERR_ECP_BAD_INPUT_DATA:
itayzafrir7b30f8b2018-05-09 16:07:36 +0300338 case MBEDTLS_ERR_ECP_INVALID_KEY:
itayzafrir5c753392018-05-08 11:18:38 +0300339 return( PSA_ERROR_INVALID_ARGUMENT );
itayzafrir7b30f8b2018-05-09 16:07:36 +0300340 case MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL:
341 return( PSA_ERROR_BUFFER_TOO_SMALL );
342 case MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE:
343 return( PSA_ERROR_NOT_SUPPORTED );
344 case MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH:
345 case MBEDTLS_ERR_ECP_VERIFY_FAILED:
346 return( PSA_ERROR_INVALID_SIGNATURE );
347 case MBEDTLS_ERR_ECP_ALLOC_FAILED:
348 return( PSA_ERROR_INSUFFICIENT_MEMORY );
349 case MBEDTLS_ERR_ECP_HW_ACCEL_FAILED:
350 return( PSA_ERROR_HARDWARE_FAILURE );
Janos Follatha13b9052019-11-22 12:48:59 +0000351 case MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED:
352 return( PSA_ERROR_CORRUPTION_DETECTED );
itayzafrir5c753392018-05-08 11:18:38 +0300353
Gilles Peskinee59236f2018-01-27 23:32:46 +0100354 default:
David Saadab4ecc272019-02-14 13:48:10 +0200355 return( PSA_ERROR_GENERIC_ERROR );
Gilles Peskinee59236f2018-01-27 23:32:46 +0100356 }
357}
358
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200359
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +0200360
361
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100362/****************************************************************/
363/* Key management */
364/****************************************************************/
365
Gilles Peskine73167e12019-07-12 23:44:37 +0200366#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
367static inline int psa_key_slot_is_external( const psa_key_slot_t *slot )
368{
Gilles Peskine8e338702019-07-30 20:06:31 +0200369 return( psa_key_lifetime_is_external( slot->attr.lifetime ) );
Gilles Peskine73167e12019-07-12 23:44:37 +0200370}
371#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
372
Darryl Green8f8aa8f2018-07-24 15:44:51 +0100373#if defined(MBEDTLS_ECP_C)
Paul Elliott8ff510a2020-06-02 17:19:28 +0100374mbedtls_ecp_group_id mbedtls_ecc_group_of_psa( psa_ecc_family_t curve,
Gilles Peskine5055b232019-12-12 17:49:31 +0100375 size_t byte_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +0200376{
377 switch( curve )
378 {
Paul Elliott8ff510a2020-06-02 17:19:28 +0100379 case PSA_ECC_FAMILY_SECP_R1:
Gilles Peskine228abc52019-12-03 17:24:19 +0100380 switch( byte_length )
381 {
382 case PSA_BITS_TO_BYTES( 192 ):
383 return( MBEDTLS_ECP_DP_SECP192R1 );
384 case PSA_BITS_TO_BYTES( 224 ):
385 return( MBEDTLS_ECP_DP_SECP224R1 );
386 case PSA_BITS_TO_BYTES( 256 ):
387 return( MBEDTLS_ECP_DP_SECP256R1 );
388 case PSA_BITS_TO_BYTES( 384 ):
389 return( MBEDTLS_ECP_DP_SECP384R1 );
390 case PSA_BITS_TO_BYTES( 521 ):
391 return( MBEDTLS_ECP_DP_SECP521R1 );
392 default:
393 return( MBEDTLS_ECP_DP_NONE );
394 }
395 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100396
Paul Elliott8ff510a2020-06-02 17:19:28 +0100397 case PSA_ECC_FAMILY_BRAINPOOL_P_R1:
Gilles Peskine228abc52019-12-03 17:24:19 +0100398 switch( byte_length )
399 {
400 case PSA_BITS_TO_BYTES( 256 ):
401 return( MBEDTLS_ECP_DP_BP256R1 );
402 case PSA_BITS_TO_BYTES( 384 ):
403 return( MBEDTLS_ECP_DP_BP384R1 );
404 case PSA_BITS_TO_BYTES( 512 ):
405 return( MBEDTLS_ECP_DP_BP512R1 );
406 default:
407 return( MBEDTLS_ECP_DP_NONE );
408 }
409 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100410
Paul Elliott8ff510a2020-06-02 17:19:28 +0100411 case PSA_ECC_FAMILY_MONTGOMERY:
Gilles Peskine228abc52019-12-03 17:24:19 +0100412 switch( byte_length )
413 {
414 case PSA_BITS_TO_BYTES( 255 ):
415 return( MBEDTLS_ECP_DP_CURVE25519 );
416 case PSA_BITS_TO_BYTES( 448 ):
417 return( MBEDTLS_ECP_DP_CURVE448 );
418 default:
419 return( MBEDTLS_ECP_DP_NONE );
420 }
421 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100422
Paul Elliott8ff510a2020-06-02 17:19:28 +0100423 case PSA_ECC_FAMILY_SECP_K1:
Gilles Peskine228abc52019-12-03 17:24:19 +0100424 switch( byte_length )
425 {
426 case PSA_BITS_TO_BYTES( 192 ):
427 return( MBEDTLS_ECP_DP_SECP192K1 );
428 case PSA_BITS_TO_BYTES( 224 ):
429 return( MBEDTLS_ECP_DP_SECP224K1 );
430 case PSA_BITS_TO_BYTES( 256 ):
431 return( MBEDTLS_ECP_DP_SECP256K1 );
432 default:
433 return( MBEDTLS_ECP_DP_NONE );
434 }
435 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100436
Gilles Peskine12313cd2018-06-20 00:20:32 +0200437 default:
438 return( MBEDTLS_ECP_DP_NONE );
439 }
440}
Darryl Green8f8aa8f2018-07-24 15:44:51 +0100441#endif /* defined(MBEDTLS_ECP_C) */
Gilles Peskine12313cd2018-06-20 00:20:32 +0200442
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200443static psa_status_t validate_unstructured_key_bit_size( psa_key_type_t type,
444 size_t bits )
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200445{
446 /* Check that the bit size is acceptable for the key type */
447 switch( type )
448 {
449 case PSA_KEY_TYPE_RAW_DATA:
450#if defined(MBEDTLS_MD_C)
451 case PSA_KEY_TYPE_HMAC:
Gilles Peskine46f1fd72018-06-28 19:31:31 +0200452#endif
Gilles Peskineea0fb492018-07-12 17:17:20 +0200453 case PSA_KEY_TYPE_DERIVE:
454 break;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200455#if defined(MBEDTLS_AES_C)
456 case PSA_KEY_TYPE_AES:
457 if( bits != 128 && bits != 192 && bits != 256 )
458 return( PSA_ERROR_INVALID_ARGUMENT );
459 break;
460#endif
461#if defined(MBEDTLS_CAMELLIA_C)
462 case PSA_KEY_TYPE_CAMELLIA:
463 if( bits != 128 && bits != 192 && bits != 256 )
464 return( PSA_ERROR_INVALID_ARGUMENT );
465 break;
466#endif
467#if defined(MBEDTLS_DES_C)
468 case PSA_KEY_TYPE_DES:
469 if( bits != 64 && bits != 128 && bits != 192 )
470 return( PSA_ERROR_INVALID_ARGUMENT );
471 break;
472#endif
473#if defined(MBEDTLS_ARC4_C)
474 case PSA_KEY_TYPE_ARC4:
475 if( bits < 8 || bits > 2048 )
476 return( PSA_ERROR_INVALID_ARGUMENT );
477 break;
478#endif
Gilles Peskine26869f22019-05-06 15:25:00 +0200479#if defined(MBEDTLS_CHACHA20_C)
480 case PSA_KEY_TYPE_CHACHA20:
481 if( bits != 256 )
482 return( PSA_ERROR_INVALID_ARGUMENT );
483 break;
484#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200485 default:
486 return( PSA_ERROR_NOT_SUPPORTED );
487 }
Gilles Peskineb54979a2018-06-21 09:32:47 +0200488 if( bits % 8 != 0 )
489 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200490
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200491 return( PSA_SUCCESS );
492}
493
Steven Cooremana01795d2020-07-24 22:48:15 +0200494#if defined(MBEDTLS_RSA_C)
495
496#if defined(MBEDTLS_PK_PARSE_C)
Gilles Peskine86a440b2018-11-12 18:39:40 +0100497/* Mbed TLS doesn't support non-byte-aligned key sizes (i.e. key sizes
498 * that are not a multiple of 8) well. For example, there is only
499 * mbedtls_rsa_get_len(), which returns a number of bytes, and no
500 * way to return the exact bit size of a key.
501 * To keep things simple, reject non-byte-aligned key sizes. */
502static psa_status_t psa_check_rsa_key_byte_aligned(
503 const mbedtls_rsa_context *rsa )
504{
505 mbedtls_mpi n;
506 psa_status_t status;
507 mbedtls_mpi_init( &n );
508 status = mbedtls_to_psa_error(
509 mbedtls_rsa_export( rsa, &n, NULL, NULL, NULL, NULL ) );
510 if( status == PSA_SUCCESS )
511 {
512 if( mbedtls_mpi_bitlen( &n ) % 8 != 0 )
513 status = PSA_ERROR_NOT_SUPPORTED;
514 }
515 mbedtls_mpi_free( &n );
516 return( status );
517}
Steven Cooremana01795d2020-07-24 22:48:15 +0200518#endif /* MBEDTLS_PK_PARSE_C */
Gilles Peskine86a440b2018-11-12 18:39:40 +0100519
Steven Cooreman7f391872020-07-30 14:57:44 +0200520/** Load the contents of a key buffer into an internal RSA representation
Steven Cooremana01795d2020-07-24 22:48:15 +0200521 *
Steven Cooreman4fed4552020-08-03 14:46:03 +0200522 * \param[in] type The type of key contained in \p data.
523 * \param[in] data The buffer from which to load the representation.
524 * \param[in] data_length The size in bytes of \p data.
525 * \param[out] p_rsa Returns a pointer to an RSA context on success.
526 * The caller is responsible for freeing both the
527 * contents of the context and the context itself
528 * when done.
Steven Cooremana01795d2020-07-24 22:48:15 +0200529 */
Steven Cooreman4fed4552020-08-03 14:46:03 +0200530static psa_status_t psa_load_rsa_representation( psa_key_type_t type,
531 const uint8_t *data,
532 size_t data_length,
Steven Cooremana2371e52020-07-28 14:30:39 +0200533 mbedtls_rsa_context **p_rsa )
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200534{
Steven Cooremana01795d2020-07-24 22:48:15 +0200535#if defined(MBEDTLS_PK_PARSE_C)
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000536 psa_status_t status;
Steven Cooremana01795d2020-07-24 22:48:15 +0200537 mbedtls_pk_context ctx;
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000538 size_t bits;
Steven Cooremana01795d2020-07-24 22:48:15 +0200539 mbedtls_pk_init( &ctx );
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000540
541 /* Parse the data. */
Steven Cooreman7f391872020-07-30 14:57:44 +0200542 if( PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000543 status = mbedtls_to_psa_error(
Steven Cooreman4fed4552020-08-03 14:46:03 +0200544 mbedtls_pk_parse_key( &ctx, data, data_length, NULL, 0 ) );
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200545 else
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000546 status = mbedtls_to_psa_error(
Steven Cooreman4fed4552020-08-03 14:46:03 +0200547 mbedtls_pk_parse_public_key( &ctx, data, data_length ) );
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000548 if( status != PSA_SUCCESS )
549 goto exit;
550
551 /* We have something that the pkparse module recognizes. If it is a
552 * valid RSA key, store it. */
Steven Cooremana01795d2020-07-24 22:48:15 +0200553 if( mbedtls_pk_get_type( &ctx ) != MBEDTLS_PK_RSA )
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200554 {
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000555 status = PSA_ERROR_INVALID_ARGUMENT;
556 goto exit;
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200557 }
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000558
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000559 /* The size of an RSA key doesn't have to be a multiple of 8. Mbed TLS
560 * supports non-byte-aligned key sizes, but not well. For example,
561 * mbedtls_rsa_get_len() returns the key size in bytes, not in bits. */
Steven Cooremana01795d2020-07-24 22:48:15 +0200562 bits = PSA_BYTES_TO_BITS( mbedtls_rsa_get_len( mbedtls_pk_rsa( ctx ) ) );
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000563 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
564 {
565 status = PSA_ERROR_NOT_SUPPORTED;
566 goto exit;
567 }
Steven Cooremana01795d2020-07-24 22:48:15 +0200568 status = psa_check_rsa_key_byte_aligned( mbedtls_pk_rsa( ctx ) );
Steven Cooremana01795d2020-07-24 22:48:15 +0200569 if( status != PSA_SUCCESS )
570 goto exit;
571
Steven Cooremana2371e52020-07-28 14:30:39 +0200572 /* Copy out the pointer to the RSA context, and reset the PK context
573 * such that pk_free doesn't free the RSA context we just grabbed. */
574 *p_rsa = mbedtls_pk_rsa( ctx );
575 ctx.pk_info = NULL;
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000576
577exit:
Steven Cooremana01795d2020-07-24 22:48:15 +0200578 mbedtls_pk_free( &ctx );
579 return( status );
580#else
Steven Cooreman4fed4552020-08-03 14:46:03 +0200581 (void) data;
582 (void) data_length;
Steven Cooreman7f391872020-07-30 14:57:44 +0200583 (void) type;
Steven Cooremana01795d2020-07-24 22:48:15 +0200584 (void) rsa;
585 return( PSA_ERROR_NOT_SUPPORTED );
586#endif /* MBEDTLS_PK_PARSE_C */
587}
588
589/** Export an RSA key to export representation
590 *
591 * \param[in] type The type of key (public/private) to export
592 * \param[in] rsa The internal RSA representation from which to export
593 * \param[out] data The buffer to export to
594 * \param[in] data_size The length of the buffer to export to
595 * \param[out] data_length The amount of bytes written to \p data
596 */
597static psa_status_t psa_export_rsa_key( psa_key_type_t type,
598 mbedtls_rsa_context *rsa,
599 uint8_t *data,
600 size_t data_size,
601 size_t *data_length )
602{
603#if defined(MBEDTLS_PK_WRITE_C)
604 int ret;
605 mbedtls_pk_context pk;
606 uint8_t *pos = data + data_size;
607
608 mbedtls_pk_init( &pk );
609 pk.pk_info = &mbedtls_rsa_info;
610 pk.pk_ctx = rsa;
611
612 /* PSA Crypto API defines the format of an RSA key as a DER-encoded
Steven Cooreman75b74362020-07-28 14:30:13 +0200613 * representation of the non-encrypted PKCS#1 RSAPrivateKey for a
614 * private key and of the RFC3279 RSAPublicKey for a public key. */
Steven Cooremana01795d2020-07-24 22:48:15 +0200615 if( PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
616 ret = mbedtls_pk_write_key_der( &pk, data, data_size );
617 else
618 ret = mbedtls_pk_write_pubkey( &pos, data, &pk );
619
620 if( ret < 0 )
Steven Cooreman4fed4552020-08-03 14:46:03 +0200621 {
622 /* Clean up in case pk_write failed halfway through. */
623 memset( data, 0, data_size );
Steven Cooreman29149862020-08-05 15:43:42 +0200624 return( mbedtls_to_psa_error( ret ) );
Steven Cooreman4fed4552020-08-03 14:46:03 +0200625 }
Steven Cooremana01795d2020-07-24 22:48:15 +0200626
627 /* The mbedtls_pk_xxx functions write to the end of the buffer.
628 * Move the data to the beginning and erase remaining data
629 * at the original location. */
630 if( 2 * (size_t) ret <= data_size )
631 {
632 memcpy( data, data + data_size - ret, ret );
633 memset( data + data_size - ret, 0, ret );
634 }
635 else if( (size_t) ret < data_size )
636 {
637 memmove( data, data + data_size - ret, ret );
638 memset( data + ret, 0, data_size - ret );
639 }
640
641 *data_length = ret;
642 return( PSA_SUCCESS );
643#else
644 (void) type;
645 (void) rsa;
646 (void) data;
647 (void) data_size;
648 (void) data_length;
649 return( PSA_ERROR_NOT_SUPPORTED );
650#endif /* MBEDTLS_PK_WRITE_C */
651}
652
653/** Import an RSA key from import representation to a slot
654 *
655 * \param[in,out] slot The slot where to store the export representation to
656 * \param[in] data The buffer containing the import representation
657 * \param[in] data_length The amount of bytes in \p data
658 */
659static psa_status_t psa_import_rsa_key( psa_key_slot_t *slot,
660 const uint8_t *data,
661 size_t data_length )
662{
663 psa_status_t status;
664 uint8_t* output = NULL;
Steven Cooremana2371e52020-07-28 14:30:39 +0200665 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +0200666
Steven Cooremana01795d2020-07-24 22:48:15 +0200667 /* Parse input */
Steven Cooreman4fed4552020-08-03 14:46:03 +0200668 status = psa_load_rsa_representation( slot->attr.type,
669 data,
Steven Cooreman7f391872020-07-30 14:57:44 +0200670 data_length,
Steven Cooreman7f391872020-07-30 14:57:44 +0200671 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +0200672 if( status != PSA_SUCCESS )
673 goto exit;
674
675 slot->attr.bits = (psa_key_bits_t) PSA_BYTES_TO_BITS(
Steven Cooremana2371e52020-07-28 14:30:39 +0200676 mbedtls_rsa_get_len( rsa ) );
Steven Cooremana01795d2020-07-24 22:48:15 +0200677
Steven Cooreman75b74362020-07-28 14:30:13 +0200678 /* Re-export the data to PSA export format, such that we can store export
679 * representation in the key slot. Export representation in case of RSA is
680 * the smallest representation that's allowed as input, so a straight-up
681 * allocation of the same size as the input buffer will be large enough. */
Steven Cooremana01795d2020-07-24 22:48:15 +0200682 output = mbedtls_calloc( 1, data_length );
Steven Cooremana01795d2020-07-24 22:48:15 +0200683 if( output == NULL )
684 {
685 status = PSA_ERROR_INSUFFICIENT_MEMORY;
686 goto exit;
687 }
688
Steven Cooremana01795d2020-07-24 22:48:15 +0200689 status = psa_export_rsa_key( slot->attr.type,
Steven Cooremana2371e52020-07-28 14:30:39 +0200690 rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +0200691 output,
692 data_length,
693 &data_length);
Steven Cooremana01795d2020-07-24 22:48:15 +0200694exit:
695 /* Always free the RSA object */
Steven Cooremana2371e52020-07-28 14:30:39 +0200696 mbedtls_rsa_free( rsa );
Steven Cooreman6d839f02020-07-30 11:36:45 +0200697 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +0200698
699 /* Free the allocated buffer only on error. */
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000700 if( status != PSA_SUCCESS )
701 {
Steven Cooremana01795d2020-07-24 22:48:15 +0200702 mbedtls_free( output );
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000703 return( status );
704 }
705
Steven Cooremana01795d2020-07-24 22:48:15 +0200706 /* On success, store the allocated export-formatted key. */
707 slot->data.key.data = output;
708 slot->data.key.bytes = data_length;
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000709
710 return( PSA_SUCCESS );
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200711}
Steven Cooremana01795d2020-07-24 22:48:15 +0200712#endif /* defined(MBEDTLS_RSA_C) */
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200713
Jaeden Ameroccdce902019-01-10 11:42:27 +0000714#if defined(MBEDTLS_ECP_C)
Steven Cooreman7f391872020-07-30 14:57:44 +0200715/** Load the contents of a key buffer into an internal ECP representation
Steven Cooremana2371e52020-07-28 14:30:39 +0200716 *
Steven Cooreman4fed4552020-08-03 14:46:03 +0200717 * \param[in] type The type of key contained in \p data.
718 * \param[in] data The buffer from which to load the representation.
719 * \param[in] data_length The size in bytes of \p data.
720 * \param[out] p_ecp Returns a pointer to an ECP context on success.
721 * The caller is responsible for freeing both the
722 * contents of the context and the context itself
723 * when done.
Steven Cooremana2371e52020-07-28 14:30:39 +0200724 */
Steven Cooreman4fed4552020-08-03 14:46:03 +0200725static psa_status_t psa_load_ecp_representation( psa_key_type_t type,
726 const uint8_t *data,
727 size_t data_length,
Steven Cooremana2371e52020-07-28 14:30:39 +0200728 mbedtls_ecp_keypair **p_ecp )
Gilles Peskine4cd32772019-12-02 20:49:42 +0100729{
730 mbedtls_ecp_group_id grp_id = MBEDTLS_ECP_DP_NONE;
Steven Cooremanacda8342020-07-24 23:09:52 +0200731 psa_status_t status;
Steven Cooreman6d839f02020-07-30 11:36:45 +0200732 mbedtls_ecp_keypair *ecp = NULL;
Steven Cooreman4fed4552020-08-03 14:46:03 +0200733 size_t curve_size = data_length;
Gilles Peskine4cd32772019-12-02 20:49:42 +0100734
Steven Cooreman4fed4552020-08-03 14:46:03 +0200735 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) &&
736 PSA_KEY_TYPE_ECC_GET_FAMILY( type ) != PSA_ECC_FAMILY_MONTGOMERY )
Gilles Peskine4295e8b2019-12-02 21:39:10 +0100737 {
Steven Cooreman4fed4552020-08-03 14:46:03 +0200738 /* A Weierstrass public key is represented as:
739 * - The byte 0x04;
740 * - `x_P` as a `ceiling(m/8)`-byte string, big-endian;
741 * - `y_P` as a `ceiling(m/8)`-byte string, big-endian.
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200742 * So its data length is 2m+1 where m is the curve size in bits.
Steven Cooreman4fed4552020-08-03 14:46:03 +0200743 */
744 if( ( data_length & 1 ) == 0 )
745 return( PSA_ERROR_INVALID_ARGUMENT );
746 curve_size = data_length / 2;
747
748 /* Montgomery public keys are represented in compressed format, meaning
749 * their curve_size is equal to the amount of input. */
750
751 /* Private keys are represented in uncompressed private random integer
752 * format, meaning their curve_size is equal to the amount of input. */
Gilles Peskine4295e8b2019-12-02 21:39:10 +0100753 }
754
Steven Cooreman6d839f02020-07-30 11:36:45 +0200755 /* Allocate and initialize a key representation. */
Steven Cooreman29149862020-08-05 15:43:42 +0200756 ecp = mbedtls_calloc( 1, sizeof( mbedtls_ecp_keypair ) );
Steven Cooreman6d839f02020-07-30 11:36:45 +0200757 if( ecp == NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200758 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Steven Cooremana2371e52020-07-28 14:30:39 +0200759 mbedtls_ecp_keypair_init( ecp );
760
Gilles Peskine4cd32772019-12-02 20:49:42 +0100761 /* Load the group. */
Steven Cooreman7f391872020-07-30 14:57:44 +0200762 grp_id = mbedtls_ecc_group_of_psa( PSA_KEY_TYPE_ECC_GET_FAMILY( type ),
763 curve_size );
Gilles Peskine4295e8b2019-12-02 21:39:10 +0100764 if( grp_id == MBEDTLS_ECP_DP_NONE )
Steven Cooreman6d839f02020-07-30 11:36:45 +0200765 {
766 status = PSA_ERROR_INVALID_ARGUMENT;
767 goto exit;
768 }
769
Steven Cooremanacda8342020-07-24 23:09:52 +0200770 status = mbedtls_to_psa_error(
771 mbedtls_ecp_group_load( &ecp->grp, grp_id ) );
772 if( status != PSA_SUCCESS )
Steven Cooreman6d839f02020-07-30 11:36:45 +0200773 goto exit;
Steven Cooremanacda8342020-07-24 23:09:52 +0200774
Steven Cooreman6d839f02020-07-30 11:36:45 +0200775 /* Load the key material. */
Steven Cooreman7f391872020-07-30 14:57:44 +0200776 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) )
Steven Cooremanacda8342020-07-24 23:09:52 +0200777 {
778 /* Load the public value. */
779 status = mbedtls_to_psa_error(
780 mbedtls_ecp_point_read_binary( &ecp->grp, &ecp->Q,
Steven Cooreman4fed4552020-08-03 14:46:03 +0200781 data,
782 data_length ) );
Steven Cooremanacda8342020-07-24 23:09:52 +0200783 if( status != PSA_SUCCESS )
784 goto exit;
785
786 /* Check that the point is on the curve. */
787 status = mbedtls_to_psa_error(
788 mbedtls_ecp_check_pubkey( &ecp->grp, &ecp->Q ) );
789 if( status != PSA_SUCCESS )
790 goto exit;
791 }
792 else
793 {
Steven Cooreman6d839f02020-07-30 11:36:45 +0200794 /* Load and validate the secret value. */
Steven Cooremanacda8342020-07-24 23:09:52 +0200795 status = mbedtls_to_psa_error(
796 mbedtls_ecp_read_key( ecp->grp.id,
797 ecp,
Steven Cooreman4fed4552020-08-03 14:46:03 +0200798 data,
799 data_length ) );
Steven Cooremanacda8342020-07-24 23:09:52 +0200800 if( status != PSA_SUCCESS )
801 goto exit;
Steven Cooremanacda8342020-07-24 23:09:52 +0200802 }
Steven Cooremana2371e52020-07-28 14:30:39 +0200803
804 *p_ecp = ecp;
Steven Cooremanacda8342020-07-24 23:09:52 +0200805exit:
806 if( status != PSA_SUCCESS )
Steven Cooremana2371e52020-07-28 14:30:39 +0200807 {
Steven Cooremanacda8342020-07-24 23:09:52 +0200808 mbedtls_ecp_keypair_free( ecp );
Steven Cooremana2371e52020-07-28 14:30:39 +0200809 mbedtls_free( ecp );
810 }
811
Steven Cooreman29149862020-08-05 15:43:42 +0200812 return( status );
Gilles Peskine4cd32772019-12-02 20:49:42 +0100813}
Jaeden Ameroccdce902019-01-10 11:42:27 +0000814
Steven Cooreman4fed4552020-08-03 14:46:03 +0200815/** Export an ECP key to export representation
816 *
817 * \param[in] type The type of key (public/private) to export
818 * \param[in] ecp The internal ECP representation from which to export
819 * \param[out] data The buffer to export to
820 * \param[in] data_size The length of the buffer to export to
821 * \param[out] data_length The amount of bytes written to \p data
822 */
Steven Cooremanacda8342020-07-24 23:09:52 +0200823static psa_status_t psa_export_ecp_key( psa_key_type_t type,
824 mbedtls_ecp_keypair *ecp,
825 uint8_t *data,
826 size_t data_size,
827 size_t *data_length )
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200828{
Steven Cooremanacda8342020-07-24 23:09:52 +0200829 psa_status_t status;
Jaeden Ameroccdce902019-01-10 11:42:27 +0000830
Steven Cooremanacda8342020-07-24 23:09:52 +0200831 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) )
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200832 {
Steven Cooremanacda8342020-07-24 23:09:52 +0200833 /* Check whether the public part is loaded */
834 if( mbedtls_ecp_is_zero( &ecp->Q ) )
835 {
836 /* Calculate the public key */
837 status = mbedtls_to_psa_error(
838 mbedtls_ecp_mul( &ecp->grp, &ecp->Q, &ecp->d, &ecp->grp.G,
839 mbedtls_ctr_drbg_random, &global_data.ctr_drbg ) );
840 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +0200841 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +0200842 }
843
Steven Cooreman4fed4552020-08-03 14:46:03 +0200844 status = mbedtls_to_psa_error(
Steven Cooremanacda8342020-07-24 23:09:52 +0200845 mbedtls_ecp_point_write_binary( &ecp->grp, &ecp->Q,
846 MBEDTLS_ECP_PF_UNCOMPRESSED,
847 data_length,
848 data,
Steven Cooreman4fed4552020-08-03 14:46:03 +0200849 data_size ) );
Steven Cooreman4fed4552020-08-03 14:46:03 +0200850 if( status != PSA_SUCCESS )
851 memset( data, 0, data_size );
852
Steven Cooreman29149862020-08-05 15:43:42 +0200853 return( status );
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200854 }
Steven Cooremanacda8342020-07-24 23:09:52 +0200855 else
856 {
Steven Cooreman29149862020-08-05 15:43:42 +0200857 if( data_size < PSA_BITS_TO_BYTES( ecp->grp.nbits ) )
Steven Cooremanacda8342020-07-24 23:09:52 +0200858 return( PSA_ERROR_BUFFER_TOO_SMALL );
859
860 status = mbedtls_to_psa_error(
861 mbedtls_ecp_write_key( ecp,
862 data,
Steven Cooreman29149862020-08-05 15:43:42 +0200863 PSA_BITS_TO_BYTES( ecp->grp.nbits ) ) );
Steven Cooremanacda8342020-07-24 23:09:52 +0200864 if( status == PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +0200865 *data_length = PSA_BITS_TO_BYTES( ecp->grp.nbits );
Steven Cooremanb7f6dea2020-08-05 16:07:20 +0200866 else
867 memset( data, 0, data_size );
Steven Cooremanacda8342020-07-24 23:09:52 +0200868
869 return( status );
870 }
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200871}
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200872
Steven Cooreman4fed4552020-08-03 14:46:03 +0200873/** Import an ECP key from import representation to a slot
874 *
875 * \param[in,out] slot The slot where to store the export representation to
876 * \param[in] data The buffer containing the import representation
877 * \param[in] data_length The amount of bytes in \p data
878 */
Steven Cooremanacda8342020-07-24 23:09:52 +0200879static psa_status_t psa_import_ecp_key( psa_key_slot_t *slot,
880 const uint8_t *data,
881 size_t data_length )
Gilles Peskinef76aa772018-10-29 19:24:33 +0100882{
Steven Cooremanacda8342020-07-24 23:09:52 +0200883 psa_status_t status;
884 uint8_t* output = NULL;
Steven Cooremana2371e52020-07-28 14:30:39 +0200885 mbedtls_ecp_keypair *ecp = NULL;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100886
Steven Cooremanacda8342020-07-24 23:09:52 +0200887 /* Parse input */
Steven Cooreman4fed4552020-08-03 14:46:03 +0200888 status = psa_load_ecp_representation( slot->attr.type,
889 data,
Steven Cooreman7f391872020-07-30 14:57:44 +0200890 data_length,
Steven Cooreman7f391872020-07-30 14:57:44 +0200891 &ecp );
Gilles Peskinef76aa772018-10-29 19:24:33 +0100892 if( status != PSA_SUCCESS )
893 goto exit;
Gilles Peskine4cd32772019-12-02 20:49:42 +0100894
Steven Cooremanacda8342020-07-24 23:09:52 +0200895 if( PSA_KEY_TYPE_ECC_GET_FAMILY( slot->attr.type ) == PSA_ECC_FAMILY_MONTGOMERY)
Steven Cooremana2371e52020-07-28 14:30:39 +0200896 slot->attr.bits = (psa_key_bits_t) ecp->grp.nbits + 1;
Steven Cooremanacda8342020-07-24 23:09:52 +0200897 else
Steven Cooremana2371e52020-07-28 14:30:39 +0200898 slot->attr.bits = (psa_key_bits_t) ecp->grp.nbits;
Steven Cooremane3fd3922020-06-11 16:50:36 +0200899
Steven Cooremanacda8342020-07-24 23:09:52 +0200900 /* Re-export the data to PSA export format. There is currently no support
901 * for other input formats then the export format, so this is a 1-1
902 * copy operation. */
903 output = mbedtls_calloc( 1, data_length );
Steven Cooremanacda8342020-07-24 23:09:52 +0200904 if( output == NULL )
905 {
906 status = PSA_ERROR_INSUFFICIENT_MEMORY;
907 goto exit;
908 }
909
910 status = psa_export_ecp_key( slot->attr.type,
Steven Cooremana2371e52020-07-28 14:30:39 +0200911 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +0200912 output,
913 data_length,
914 &data_length);
Gilles Peskinef76aa772018-10-29 19:24:33 +0100915exit:
Steven Cooremana2371e52020-07-28 14:30:39 +0200916 /* Always free the PK object (will also free contained ECP context) */
917 mbedtls_ecp_keypair_free( ecp );
Steven Cooreman6d839f02020-07-30 11:36:45 +0200918 mbedtls_free( ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +0200919
920 /* Free the allocated buffer only on error. */
921 if( status != PSA_SUCCESS )
Gilles Peskinef76aa772018-10-29 19:24:33 +0100922 {
Steven Cooremanacda8342020-07-24 23:09:52 +0200923 mbedtls_free( output );
Steven Cooremanacda8342020-07-24 23:09:52 +0200924 return( status );
Gilles Peskinef76aa772018-10-29 19:24:33 +0100925 }
Steven Cooremanacda8342020-07-24 23:09:52 +0200926
927 /* On success, store the allocated export-formatted key. */
928 slot->data.key.data = output;
929 slot->data.key.bytes = data_length;
930
931 return( PSA_SUCCESS );
Gilles Peskinef76aa772018-10-29 19:24:33 +0100932}
933#endif /* defined(MBEDTLS_ECP_C) */
934
Gilles Peskineb46bef22019-07-30 21:32:04 +0200935/** Return the size of the key in the given slot, in bits.
936 *
937 * \param[in] slot A key slot.
938 *
939 * \return The key size in bits, read from the metadata in the slot.
940 */
941static inline size_t psa_get_key_slot_bits( const psa_key_slot_t *slot )
942{
943 return( slot->attr.bits );
944}
945
Steven Cooreman75b74362020-07-28 14:30:13 +0200946/** Try to allocate a buffer to an empty key slot.
947 *
948 * \param[in,out] slot Key slot to attach buffer to.
949 * \param[in] buffer_length Requested size of the buffer.
950 *
951 * \retval #PSA_SUCCESS
952 * The buffer has been successfully allocated.
953 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
954 * Not enough memory was available for allocation.
955 * \retval #PSA_ERROR_ALREADY_EXISTS
956 * Trying to allocate a buffer to a non-empty key slot.
957 */
958static psa_status_t psa_allocate_buffer_to_slot( psa_key_slot_t *slot,
959 size_t buffer_length )
960{
961 if( slot->data.key.data != NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200962 return( PSA_ERROR_ALREADY_EXISTS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200963
964 slot->data.key.data = mbedtls_calloc( 1, buffer_length );
965 if( slot->data.key.data == NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200966 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Steven Cooreman75b74362020-07-28 14:30:13 +0200967
968 slot->data.key.bytes = buffer_length;
Steven Cooreman29149862020-08-05 15:43:42 +0200969 return( PSA_SUCCESS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200970}
971
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200972psa_status_t psa_copy_key_material_into_slot( psa_key_slot_t *slot,
973 const uint8_t* data,
974 size_t data_length )
975{
976 psa_status_t status = psa_allocate_buffer_to_slot( slot,
977 data_length );
978 if( status != PSA_SUCCESS )
979 return( status );
980
981 memcpy( slot->data.key.data, data, data_length );
982 return( PSA_SUCCESS );
983}
984
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200985/** Import key data into a slot.
986 *
987 * `slot->type` must have been set previously.
988 * This function assumes that the slot does not contain any key material yet.
989 * On failure, the slot content is unchanged.
990 *
991 * Persistent storage is not affected.
992 *
993 * \param[in,out] slot The key slot to import data into.
994 * Its `type` field must have previously been set to
995 * the desired key type.
996 * It must not contain any key material yet.
997 * \param[in] data Buffer containing the key material to parse and import.
998 * \param data_length Size of \p data in bytes.
999 *
1000 * \retval #PSA_SUCCESS
1001 * \retval #PSA_ERROR_INVALID_ARGUMENT
1002 * \retval #PSA_ERROR_NOT_SUPPORTED
1003 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
1004 */
1005static psa_status_t psa_import_key_into_slot( psa_key_slot_t *slot,
1006 const uint8_t *data,
1007 size_t data_length )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001008{
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001009 psa_status_t status = PSA_SUCCESS;
Steven Cooreman04524762020-10-13 17:43:44 +02001010 size_t bit_size;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001011
Steven Cooreman81be2fa2020-07-24 22:04:59 +02001012 /* zero-length keys are never supported. */
1013 if( data_length == 0 )
1014 return( PSA_ERROR_NOT_SUPPORTED );
1015
Gilles Peskine8e338702019-07-30 20:06:31 +02001016 if( key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001017 {
Steven Cooreman04524762020-10-13 17:43:44 +02001018 bit_size = PSA_BYTES_TO_BITS( data_length );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02001019
Steven Cooreman75b74362020-07-28 14:30:13 +02001020 /* Ensure that the bytes-to-bits conversion hasn't overflown. */
1021 if( data_length > SIZE_MAX / 8 )
1022 return( PSA_ERROR_NOT_SUPPORTED );
1023
Gilles Peskine1b9505c2019-08-07 10:59:45 +02001024 /* Enforce a size limit, and in particular ensure that the bit
1025 * size fits in its representation type. */
Gilles Peskinec744d992019-07-30 17:26:54 +02001026 if( bit_size > PSA_MAX_KEY_BITS )
1027 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02001028
1029 status = validate_unstructured_key_bit_size( slot->attr.type, bit_size );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +02001030 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001031 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02001032
1033 /* Allocate memory for the key */
Steven Cooremanf7cebd42020-10-13 20:27:40 +02001034 status = psa_copy_key_material_into_slot( slot, data, data_length );
Steven Cooreman75b74362020-07-28 14:30:13 +02001035 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001036 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02001037
Steven Cooreman81be2fa2020-07-24 22:04:59 +02001038 /* Write the actual key size to the slot.
1039 * psa_start_key_creation() wrote the size declared by the
1040 * caller, which may be 0 (meaning unspecified) or wrong. */
1041 slot->attr.bits = (psa_key_bits_t) bit_size;
Steven Cooreman40120f62020-10-29 11:42:22 +01001042
1043 return( PSA_SUCCESS );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001044 }
Steven Cooreman3ea0ce42020-10-23 11:37:05 +02001045 else if( PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
Steven Cooreman19fd5742020-07-24 23:31:01 +02001046 {
Steven Cooreman3ea0ce42020-10-23 11:37:05 +02001047 /* Try validation through accelerators first. */
1048 bit_size = slot->attr.bits;
1049 psa_key_attributes_t attributes = {
1050 .core = slot->attr
1051 };
1052 status = psa_driver_wrapper_validate_key( &attributes,
1053 data,
1054 data_length,
1055 &bit_size );
1056 if( status == PSA_SUCCESS )
1057 {
1058 /* Key has been validated successfully by an accelerator.
1059 * Copy key material into slot. */
1060 status = psa_copy_key_material_into_slot( slot, data, data_length );
1061 if( status != PSA_SUCCESS )
1062 return( status );
1063
1064 slot->attr.bits = (psa_key_bits_t) bit_size;
1065 return( PSA_SUCCESS );
1066 }
1067 else if( status != PSA_ERROR_NOT_SUPPORTED )
1068 return( status );
1069
1070 /* Key format is not supported by any accelerator, try software fallback
1071 * if present. */
Gilles Peskinef76aa772018-10-29 19:24:33 +01001072#if defined(MBEDTLS_ECP_C)
Steven Cooreman3ea0ce42020-10-23 11:37:05 +02001073 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
1074 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001075 return( psa_import_ecp_key( slot, data, data_length ) );
1076 }
Steven Cooreman19fd5742020-07-24 23:31:01 +02001077#endif /* defined(MBEDTLS_ECP_C) */
Steven Cooreman19fd5742020-07-24 23:31:01 +02001078#if defined(MBEDTLS_RSA_C)
Steven Cooreman40120f62020-10-29 11:42:22 +01001079 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +02001080 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001081 return( psa_import_rsa_key( slot, data, data_length ) );
Steven Cooreman3ea0ce42020-10-23 11:37:05 +02001082 }
Steven Cooreman19fd5742020-07-24 23:31:01 +02001083#endif /* defined(MBEDTLS_RSA_C) */
Steven Cooreman40120f62020-10-29 11:42:22 +01001084
1085 /* Fell through the fallback as well, so have nothing else to try. */
1086 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001087 }
1088 else
Gilles Peskinec66ea6a2018-02-03 22:43:28 +01001089 {
Steven Cooreman19fd5742020-07-24 23:31:01 +02001090 /* Unknown key type */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001091 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969ac722018-01-28 18:16:59 +01001092 }
Darryl Green06fd18d2018-07-16 11:21:11 +01001093}
1094
Gilles Peskinef603c712019-01-19 13:40:11 +01001095/** Calculate the intersection of two algorithm usage policies.
1096 *
1097 * Return 0 (which allows no operation) on incompatibility.
1098 */
1099static psa_algorithm_t psa_key_policy_algorithm_intersection(
1100 psa_algorithm_t alg1,
1101 psa_algorithm_t alg2 )
1102{
Gilles Peskine549ea862019-05-22 11:45:59 +02001103 /* Common case: both sides actually specify the same policy. */
Gilles Peskinef603c712019-01-19 13:40:11 +01001104 if( alg1 == alg2 )
1105 return( alg1 );
1106 /* If the policies are from the same hash-and-sign family, check
1107 * if one is a wildcard. If so the other has the specific algorithm. */
1108 if( PSA_ALG_IS_HASH_AND_SIGN( alg1 ) &&
1109 PSA_ALG_IS_HASH_AND_SIGN( alg2 ) &&
1110 ( alg1 & ~PSA_ALG_HASH_MASK ) == ( alg2 & ~PSA_ALG_HASH_MASK ) )
1111 {
1112 if( PSA_ALG_SIGN_GET_HASH( alg1 ) == PSA_ALG_ANY_HASH )
1113 return( alg2 );
1114 if( PSA_ALG_SIGN_GET_HASH( alg2 ) == PSA_ALG_ANY_HASH )
1115 return( alg1 );
1116 }
1117 /* If the policies are incompatible, allow nothing. */
1118 return( 0 );
1119}
1120
Gilles Peskined6f371b2019-05-10 19:33:38 +02001121static int psa_key_algorithm_permits( psa_algorithm_t policy_alg,
1122 psa_algorithm_t requested_alg )
1123{
Gilles Peskine549ea862019-05-22 11:45:59 +02001124 /* Common case: the policy only allows requested_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +02001125 if( requested_alg == policy_alg )
1126 return( 1 );
1127 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
Gilles Peskine549ea862019-05-22 11:45:59 +02001128 * and requested_alg is the same hash-and-sign family with any hash,
1129 * then requested_alg is compliant with policy_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +02001130 if( PSA_ALG_IS_HASH_AND_SIGN( requested_alg ) &&
1131 PSA_ALG_SIGN_GET_HASH( policy_alg ) == PSA_ALG_ANY_HASH )
1132 {
1133 return( ( policy_alg & ~PSA_ALG_HASH_MASK ) ==
1134 ( requested_alg & ~PSA_ALG_HASH_MASK ) );
1135 }
Steven Cooremance48e852020-10-05 16:02:45 +02001136 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +02001137 * a key derivation with that key agreement should also be allowed. This
1138 * behaviour is expected to be defined in a future specification version. */
Steven Cooremance48e852020-10-05 16:02:45 +02001139 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( policy_alg ) &&
1140 PSA_ALG_IS_KEY_AGREEMENT( requested_alg ) )
1141 {
1142 return( PSA_ALG_KEY_AGREEMENT_GET_BASE( requested_alg ) ==
1143 policy_alg );
1144 }
Gilles Peskined6f371b2019-05-10 19:33:38 +02001145 /* If it isn't permitted, it's forbidden. */
1146 return( 0 );
1147}
1148
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001149/** Test whether a policy permits an algorithm.
1150 *
1151 * The caller must test usage flags separately.
1152 */
1153static int psa_key_policy_permits( const psa_key_policy_t *policy,
1154 psa_algorithm_t alg )
1155{
Gilles Peskined6f371b2019-05-10 19:33:38 +02001156 return( psa_key_algorithm_permits( policy->alg, alg ) ||
1157 psa_key_algorithm_permits( policy->alg2, alg ) );
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001158}
1159
Gilles Peskinef603c712019-01-19 13:40:11 +01001160/** Restrict a key policy based on a constraint.
1161 *
1162 * \param[in,out] policy The policy to restrict.
1163 * \param[in] constraint The policy constraint to apply.
1164 *
1165 * \retval #PSA_SUCCESS
1166 * \c *policy contains the intersection of the original value of
1167 * \c *policy and \c *constraint.
1168 * \retval #PSA_ERROR_INVALID_ARGUMENT
1169 * \c *policy and \c *constraint are incompatible.
1170 * \c *policy is unchanged.
1171 */
1172static psa_status_t psa_restrict_key_policy(
1173 psa_key_policy_t *policy,
1174 const psa_key_policy_t *constraint )
1175{
1176 psa_algorithm_t intersection_alg =
1177 psa_key_policy_algorithm_intersection( policy->alg, constraint->alg );
Gilles Peskined6f371b2019-05-10 19:33:38 +02001178 psa_algorithm_t intersection_alg2 =
1179 psa_key_policy_algorithm_intersection( policy->alg2, constraint->alg2 );
Gilles Peskinef603c712019-01-19 13:40:11 +01001180 if( intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0 )
1181 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskined6f371b2019-05-10 19:33:38 +02001182 if( intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0 )
1183 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinef603c712019-01-19 13:40:11 +01001184 policy->usage &= constraint->usage;
1185 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +02001186 policy->alg2 = intersection_alg2;
Gilles Peskinef603c712019-01-19 13:40:11 +01001187 return( PSA_SUCCESS );
1188}
1189
Darryl Green06fd18d2018-07-16 11:21:11 +01001190/** Retrieve a slot which must contain a key. The key must have allow all the
1191 * usage flags set in \p usage. If \p alg is nonzero, the key must allow
1192 * operations with this algorithm. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001193static psa_status_t psa_get_key_from_slot( mbedtls_svc_key_id_t key,
Gilles Peskine2f060a82018-12-04 17:12:32 +01001194 psa_key_slot_t **p_slot,
Darryl Green06fd18d2018-07-16 11:21:11 +01001195 psa_key_usage_t usage,
1196 psa_algorithm_t alg )
1197{
1198 psa_status_t status;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001199 psa_key_slot_t *slot = NULL;
Darryl Green06fd18d2018-07-16 11:21:11 +01001200
1201 *p_slot = NULL;
1202
Ronald Croncf56a0a2020-08-04 09:51:30 +02001203 status = psa_get_key_slot( key, &slot );
Darryl Green06fd18d2018-07-16 11:21:11 +01001204 if( status != PSA_SUCCESS )
1205 return( status );
Darryl Green06fd18d2018-07-16 11:21:11 +01001206
1207 /* Enforce that usage policy for the key slot contains all the flags
1208 * required by the usage parameter. There is one exception: public
1209 * keys can always be exported, so we treat public key objects as
1210 * if they had the export flag. */
Gilles Peskine8e338702019-07-30 20:06:31 +02001211 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Darryl Green06fd18d2018-07-16 11:21:11 +01001212 usage &= ~PSA_KEY_USAGE_EXPORT;
Gilles Peskine8e338702019-07-30 20:06:31 +02001213 if( ( slot->attr.policy.usage & usage ) != usage )
Darryl Green06fd18d2018-07-16 11:21:11 +01001214 return( PSA_ERROR_NOT_PERMITTED );
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001215
1216 /* Enforce that the usage policy permits the requested algortihm. */
Gilles Peskine8e338702019-07-30 20:06:31 +02001217 if( alg != 0 && ! psa_key_policy_permits( &slot->attr.policy, alg ) )
Darryl Green06fd18d2018-07-16 11:21:11 +01001218 return( PSA_ERROR_NOT_PERMITTED );
1219
1220 *p_slot = slot;
1221 return( PSA_SUCCESS );
1222}
Darryl Green940d72c2018-07-13 13:18:51 +01001223
Gilles Peskine28f8f302019-07-24 13:30:31 +02001224/** Retrieve a slot which must contain a transparent key.
1225 *
1226 * A transparent key is a key for which the key material is directly
1227 * available, as opposed to a key in a secure element.
1228 *
Gilles Peskine60450a42019-07-25 11:32:45 +02001229 * This is a temporary function to use instead of psa_get_key_from_slot()
1230 * until secure element support is fully implemented.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001231 */
1232#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Ronald Croncf56a0a2020-08-04 09:51:30 +02001233static psa_status_t psa_get_transparent_key( mbedtls_svc_key_id_t key,
Gilles Peskine28f8f302019-07-24 13:30:31 +02001234 psa_key_slot_t **p_slot,
1235 psa_key_usage_t usage,
1236 psa_algorithm_t alg )
1237{
Ronald Croncf56a0a2020-08-04 09:51:30 +02001238 psa_status_t status = psa_get_key_from_slot( key, p_slot, usage, alg );
Gilles Peskine28f8f302019-07-24 13:30:31 +02001239 if( status != PSA_SUCCESS )
1240 return( status );
Gilles Peskineadad8132019-07-25 11:31:23 +02001241 if( psa_key_slot_is_external( *p_slot ) )
Gilles Peskine28f8f302019-07-24 13:30:31 +02001242 {
1243 *p_slot = NULL;
1244 return( PSA_ERROR_NOT_SUPPORTED );
1245 }
1246 return( PSA_SUCCESS );
1247}
1248#else /* MBEDTLS_PSA_CRYPTO_SE_C */
1249/* With no secure element support, all keys are transparent. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001250#define psa_get_transparent_key( key, p_slot, usage, alg ) \
1251 psa_get_key_from_slot( key, p_slot, usage, alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +02001252#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1253
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001254/** Wipe key data from a slot. Preserve metadata such as the policy. */
Gilles Peskine2f060a82018-12-04 17:12:32 +01001255static psa_status_t psa_remove_key_data_from_memory( psa_key_slot_t *slot )
Darryl Green40225ba2018-11-15 14:48:15 +00001256{
Gilles Peskine73167e12019-07-12 23:44:37 +02001257#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1258 if( psa_key_slot_is_external( slot ) )
Darryl Green40225ba2018-11-15 14:48:15 +00001259 {
1260 /* No key material to clean. */
1261 }
Gilles Peskine73167e12019-07-12 23:44:37 +02001262 else
1263#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Darryl Green40225ba2018-11-15 14:48:15 +00001264 {
Steven Cooremanfd4d69a2020-08-05 15:46:33 +02001265 /* Data pointer will always be either a valid pointer or NULL in an
1266 * initialized slot, so we can just free it. */
1267 if( slot->data.key.data != NULL )
1268 mbedtls_platform_zeroize( slot->data.key.data, slot->data.key.bytes);
Steven Cooremana01795d2020-07-24 22:48:15 +02001269 mbedtls_free( slot->data.key.data );
1270 slot->data.key.data = NULL;
1271 slot->data.key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +00001272 }
Darryl Green40225ba2018-11-15 14:48:15 +00001273
1274 return( PSA_SUCCESS );
1275}
1276
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001277/** Completely wipe a slot in memory, including its policy.
1278 * Persistent storage is not affected. */
Gilles Peskine66fb1262018-12-10 16:29:04 +01001279psa_status_t psa_wipe_key_slot( psa_key_slot_t *slot )
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001280{
1281 psa_status_t status = psa_remove_key_data_from_memory( slot );
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001282 /* Multipart operations may still be using the key. This is safe
1283 * because all multipart operation objects are independent from
1284 * the key slot: if they need to access the key after the setup
1285 * phase, they have a copy of the key. Note that this means that
1286 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001287 /* At this point, key material and other type-specific content has
1288 * been wiped. Clear remaining metadata. We can call memset and not
1289 * zeroize because the metadata is not particularly sensitive. */
1290 memset( slot, 0, sizeof( *slot ) );
1291 return( status );
1292}
1293
Ronald Croncf56a0a2020-08-04 09:51:30 +02001294psa_status_t psa_destroy_key( mbedtls_svc_key_id_t key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001295{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001296 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001297 psa_status_t status; /* status of the last operation */
1298 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001299#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1300 psa_se_drv_table_entry_t *driver;
1301#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001302
Ronald Croncf56a0a2020-08-04 09:51:30 +02001303 if( mbedtls_svc_key_id_is_null( key ) )
Gilles Peskine1841cf42019-10-08 15:48:25 +02001304 return( PSA_SUCCESS );
1305
Ronald Croncf56a0a2020-08-04 09:51:30 +02001306 status = psa_get_key_slot( key, &slot );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001307 if( status != PSA_SUCCESS )
1308 return( status );
Gilles Peskine354f7672019-07-12 23:46:38 +02001309
1310#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001311 driver = psa_get_se_driver_entry( slot->attr.lifetime );
Gilles Peskine354f7672019-07-12 23:46:38 +02001312 if( driver != NULL )
Gilles Peskinefc762652019-07-22 19:30:34 +02001313 {
Gilles Peskine60450a42019-07-25 11:32:45 +02001314 /* For a key in a secure element, we need to do three things:
1315 * remove the key file in internal storage, destroy the
1316 * key inside the secure element, and update the driver's
1317 * persistent data. Start a transaction that will encompass these
1318 * three actions. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001319 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_DESTROY_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +02001320 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Gilles Peskinefc762652019-07-22 19:30:34 +02001321 psa_crypto_transaction.key.slot = slot->data.se.slot_number;
Gilles Peskine8e338702019-07-30 20:06:31 +02001322 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskinefc762652019-07-22 19:30:34 +02001323 status = psa_crypto_save_transaction( );
1324 if( status != PSA_SUCCESS )
1325 {
Gilles Peskine66be51c2019-07-25 18:02:52 +02001326 (void) psa_crypto_stop_transaction( );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001327 /* We should still try to destroy the key in the secure
1328 * element and the key metadata in storage. This is especially
1329 * important if the error is that the storage is full.
1330 * But how to do it exactly without risking an inconsistent
1331 * state after a reset?
1332 * https://github.com/ARMmbed/mbed-crypto/issues/215
1333 */
1334 overall_status = status;
1335 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001336 }
1337
Gilles Peskine354f7672019-07-12 23:46:38 +02001338 status = psa_destroy_se_key( driver, slot->data.se.slot_number );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001339 if( overall_status == PSA_SUCCESS )
1340 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001341 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001342#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1343
Darryl Greend49a4992018-06-18 17:27:26 +01001344#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Ronald Crond98059d2020-10-23 18:00:55 +02001345 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Darryl Greend49a4992018-06-18 17:27:26 +01001346 {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001347 status = psa_destroy_persistent_key( slot->attr.id );
1348 if( overall_status == PSA_SUCCESS )
1349 overall_status = status;
1350
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001351 /* TODO: other slots may have a copy of the same key. We should
1352 * invalidate them.
1353 * https://github.com/ARMmbed/mbed-crypto/issues/214
1354 */
Darryl Greend49a4992018-06-18 17:27:26 +01001355 }
1356#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001357
Gilles Peskinefc762652019-07-22 19:30:34 +02001358#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1359 if( driver != NULL )
1360 {
Gilles Peskine725f22a2019-07-25 11:31:48 +02001361 status = psa_save_se_persistent_data( driver );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001362 if( overall_status == PSA_SUCCESS )
1363 overall_status = status;
1364 status = psa_crypto_stop_transaction( );
1365 if( overall_status == PSA_SUCCESS )
1366 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001367 }
1368#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1369
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001370#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1371exit:
1372#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001373 status = psa_wipe_key_slot( slot );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001374 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
1375 if( overall_status == PSA_SUCCESS )
1376 overall_status = status;
1377 return( overall_status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001378}
1379
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001380void psa_reset_key_attributes( psa_key_attributes_t *attributes )
Gilles Peskineb870b182018-07-06 16:02:09 +02001381{
Gilles Peskineb699f072019-04-26 16:06:02 +02001382 mbedtls_free( attributes->domain_parameters );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001383 memset( attributes, 0, sizeof( *attributes ) );
Gilles Peskineb870b182018-07-06 16:02:09 +02001384}
1385
Gilles Peskineb699f072019-04-26 16:06:02 +02001386psa_status_t psa_set_key_domain_parameters( psa_key_attributes_t *attributes,
1387 psa_key_type_t type,
1388 const uint8_t *data,
1389 size_t data_length )
1390{
1391 uint8_t *copy = NULL;
1392
1393 if( data_length != 0 )
1394 {
1395 copy = mbedtls_calloc( 1, data_length );
1396 if( copy == NULL )
1397 return( PSA_ERROR_INSUFFICIENT_MEMORY );
1398 memcpy( copy, data, data_length );
1399 }
1400 /* After this point, this function is guaranteed to succeed, so it
1401 * can start modifying `*attributes`. */
1402
1403 if( attributes->domain_parameters != NULL )
1404 {
1405 mbedtls_free( attributes->domain_parameters );
1406 attributes->domain_parameters = NULL;
1407 attributes->domain_parameters_size = 0;
1408 }
1409
1410 attributes->domain_parameters = copy;
1411 attributes->domain_parameters_size = data_length;
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001412 attributes->core.type = type;
Gilles Peskineb699f072019-04-26 16:06:02 +02001413 return( PSA_SUCCESS );
1414}
1415
1416psa_status_t psa_get_key_domain_parameters(
1417 const psa_key_attributes_t *attributes,
1418 uint8_t *data, size_t data_size, size_t *data_length )
1419{
1420 if( attributes->domain_parameters_size > data_size )
1421 return( PSA_ERROR_BUFFER_TOO_SMALL );
1422 *data_length = attributes->domain_parameters_size;
1423 if( attributes->domain_parameters_size != 0 )
1424 memcpy( data, attributes->domain_parameters,
1425 attributes->domain_parameters_size );
1426 return( PSA_SUCCESS );
1427}
1428
1429#if defined(MBEDTLS_RSA_C)
1430static psa_status_t psa_get_rsa_public_exponent(
1431 const mbedtls_rsa_context *rsa,
1432 psa_key_attributes_t *attributes )
1433{
1434 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001435 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001436 uint8_t *buffer = NULL;
1437 size_t buflen;
1438 mbedtls_mpi_init( &mpi );
1439
1440 ret = mbedtls_rsa_export( rsa, NULL, NULL, NULL, NULL, &mpi );
1441 if( ret != 0 )
1442 goto exit;
Gilles Peskine772c8b12019-04-26 17:37:21 +02001443 if( mbedtls_mpi_cmp_int( &mpi, 65537 ) == 0 )
1444 {
1445 /* It's the default value, which is reported as an empty string,
1446 * so there's nothing to do. */
1447 goto exit;
1448 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001449
1450 buflen = mbedtls_mpi_size( &mpi );
1451 buffer = mbedtls_calloc( 1, buflen );
1452 if( buffer == NULL )
1453 {
1454 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1455 goto exit;
1456 }
1457 ret = mbedtls_mpi_write_binary( &mpi, buffer, buflen );
1458 if( ret != 0 )
1459 goto exit;
1460 attributes->domain_parameters = buffer;
1461 attributes->domain_parameters_size = buflen;
1462
1463exit:
1464 mbedtls_mpi_free( &mpi );
1465 if( ret != 0 )
1466 mbedtls_free( buffer );
1467 return( mbedtls_to_psa_error( ret ) );
1468}
1469#endif /* MBEDTLS_RSA_C */
1470
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001471/** Retrieve all the publicly-accessible attributes of a key.
1472 */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001473psa_status_t psa_get_key_attributes( mbedtls_svc_key_id_t key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001474 psa_key_attributes_t *attributes )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001475{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001476 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001477 psa_status_t status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001478
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001479 psa_reset_key_attributes( attributes );
1480
Ronald Croncf56a0a2020-08-04 09:51:30 +02001481 status = psa_get_key_from_slot( key, &slot, 0, 0 );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001482 if( status != PSA_SUCCESS )
1483 return( status );
Gilles Peskineb870b182018-07-06 16:02:09 +02001484
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001485 attributes->core = slot->attr;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001486 attributes->core.flags &= ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1487 MBEDTLS_PSA_KA_MASK_DUAL_USE );
1488
1489#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1490 if( psa_key_slot_is_external( slot ) )
1491 psa_set_key_slot_number( attributes, slot->data.se.slot_number );
1492#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001493
Gilles Peskine8e338702019-07-30 20:06:31 +02001494 switch( slot->attr.type )
Gilles Peskineb699f072019-04-26 16:06:02 +02001495 {
1496#if defined(MBEDTLS_RSA_C)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001497 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001498 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001499#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001500 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001501 * is not yet implemented.
1502 * https://github.com/ARMmbed/mbed-crypto/issues/216
1503 */
Gilles Peskinec8000c02019-08-02 20:15:51 +02001504 if( psa_key_slot_is_external( slot ) )
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001505 break;
1506#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Steven Cooremana01795d2020-07-24 22:48:15 +02001507 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001508 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001509
Steven Cooreman4fed4552020-08-03 14:46:03 +02001510 status = psa_load_rsa_representation( slot->attr.type,
1511 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02001512 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02001513 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001514 if( status != PSA_SUCCESS )
1515 break;
1516
Steven Cooremana2371e52020-07-28 14:30:39 +02001517 status = psa_get_rsa_public_exponent( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02001518 attributes );
Steven Cooremana2371e52020-07-28 14:30:39 +02001519 mbedtls_rsa_free( rsa );
1520 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001521 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001522 break;
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001523#endif /* MBEDTLS_RSA_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001524 default:
1525 /* Nothing else to do. */
1526 break;
1527 }
1528
1529 if( status != PSA_SUCCESS )
1530 psa_reset_key_attributes( attributes );
1531 return( status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001532}
1533
Gilles Peskinec8000c02019-08-02 20:15:51 +02001534#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1535psa_status_t psa_get_key_slot_number(
1536 const psa_key_attributes_t *attributes,
1537 psa_key_slot_number_t *slot_number )
1538{
1539 if( attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER )
1540 {
1541 *slot_number = attributes->slot_number;
1542 return( PSA_SUCCESS );
1543 }
1544 else
1545 return( PSA_ERROR_INVALID_ARGUMENT );
1546}
1547#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1548
Steven Cooremana01795d2020-07-24 22:48:15 +02001549static psa_status_t psa_internal_export_key_buffer( const psa_key_slot_t *slot,
1550 uint8_t *data,
1551 size_t data_size,
1552 size_t *data_length )
1553{
1554 if( slot->data.key.bytes > data_size )
1555 return( PSA_ERROR_BUFFER_TOO_SMALL );
1556 memcpy( data, slot->data.key.data, slot->data.key.bytes );
1557 memset( data + slot->data.key.bytes, 0,
1558 data_size - slot->data.key.bytes );
1559 *data_length = slot->data.key.bytes;
1560 return( PSA_SUCCESS );
1561}
1562
Gilles Peskinef603c712019-01-19 13:40:11 +01001563static psa_status_t psa_internal_export_key( const psa_key_slot_t *slot,
1564 uint8_t *data,
1565 size_t data_size,
1566 size_t *data_length,
1567 int export_public_key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001568{
Gilles Peskine5d309672019-07-12 23:47:28 +02001569#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1570 const psa_drv_se_t *drv;
1571 psa_drv_se_context_t *drv_context;
1572#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1573
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001574 *data_length = 0;
1575
Gilles Peskine8e338702019-07-30 20:06:31 +02001576 if( export_public_key && ! PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
Moran Pekera998bc62018-04-16 18:16:20 +03001577 return( PSA_ERROR_INVALID_ARGUMENT );
mohammad160306e79202018-03-28 13:17:44 +03001578
Gilles Peskinef9168942019-09-12 19:20:29 +02001579 /* Reject a zero-length output buffer now, since this can never be a
1580 * valid key representation. This way we know that data must be a valid
1581 * pointer and we can do things like memset(data, ..., data_size). */
1582 if( data_size == 0 )
1583 return( PSA_ERROR_BUFFER_TOO_SMALL );
1584
Gilles Peskine5d309672019-07-12 23:47:28 +02001585#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001586 if( psa_get_se_driver( slot->attr.lifetime, &drv, &drv_context ) )
Gilles Peskine5d309672019-07-12 23:47:28 +02001587 {
1588 psa_drv_se_export_key_t method;
1589 if( drv->key_management == NULL )
1590 return( PSA_ERROR_NOT_SUPPORTED );
1591 method = ( export_public_key ?
1592 drv->key_management->p_export_public :
1593 drv->key_management->p_export );
1594 if( method == NULL )
1595 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine2e0f3882019-07-25 11:34:33 +02001596 return( method( drv_context,
1597 slot->data.se.slot_number,
1598 data, data_size, data_length ) );
Gilles Peskine5d309672019-07-12 23:47:28 +02001599 }
1600#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1601
Gilles Peskine8e338702019-07-30 20:06:31 +02001602 if( key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001603 {
Steven Cooremanacda8342020-07-24 23:09:52 +02001604 return( psa_internal_export_key_buffer( slot, data, data_size, data_length ) );
Gilles Peskine188c71e2018-10-29 19:26:02 +01001605 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001606 else if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) ||
1607 PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
Moran Peker17e36e12018-05-02 12:55:20 +03001608 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001609 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Gilles Peskine969ac722018-01-28 18:16:59 +01001610 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001611 /* Exporting public -> public */
1612 return( psa_internal_export_key_buffer( slot, data, data_size, data_length ) );
1613 }
1614 else if( !export_public_key )
1615 {
1616 /* Exporting private -> private */
1617 return( psa_internal_export_key_buffer( slot, data, data_size, data_length ) );
1618 }
1619 /* Need to export the public part of a private key,
1620 * so conversion is needed */
1621 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
1622 {
Darryl Green9e2d7a02018-07-24 16:33:30 +01001623#if defined(MBEDTLS_RSA_C)
Steven Cooremana2371e52020-07-28 14:30:39 +02001624 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman7f391872020-07-30 14:57:44 +02001625 psa_status_t status = psa_load_rsa_representation(
Steven Cooreman4fed4552020-08-03 14:46:03 +02001626 slot->attr.type,
Steven Cooreman7f391872020-07-30 14:57:44 +02001627 slot->data.key.data,
1628 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02001629 &rsa );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001630 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001631 return( status );
Steven Cooremana01795d2020-07-24 22:48:15 +02001632
Steven Cooreman560c28a2020-07-24 23:20:24 +02001633 status = psa_export_rsa_key( PSA_KEY_TYPE_RSA_PUBLIC_KEY,
Steven Cooremana2371e52020-07-28 14:30:39 +02001634 rsa,
Steven Cooreman560c28a2020-07-24 23:20:24 +02001635 data,
1636 data_size,
1637 data_length );
Steven Cooremana01795d2020-07-24 22:48:15 +02001638
Steven Cooremana2371e52020-07-28 14:30:39 +02001639 mbedtls_rsa_free( rsa );
1640 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001641
Steven Cooreman560c28a2020-07-24 23:20:24 +02001642 return( status );
Darryl Green9e2d7a02018-07-24 16:33:30 +01001643#else
Steven Cooreman560c28a2020-07-24 23:20:24 +02001644 /* We don't know how to convert a private RSA key to public. */
1645 return( PSA_ERROR_NOT_SUPPORTED );
Darryl Green9e2d7a02018-07-24 16:33:30 +01001646#endif
Gilles Peskine969ac722018-01-28 18:16:59 +01001647 }
1648 else
Moran Pekera998bc62018-04-16 18:16:20 +03001649 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001650#if defined(MBEDTLS_ECP_C)
Steven Cooremana2371e52020-07-28 14:30:39 +02001651 mbedtls_ecp_keypair *ecp = NULL;
Steven Cooreman7f391872020-07-30 14:57:44 +02001652 psa_status_t status = psa_load_ecp_representation(
Steven Cooreman4fed4552020-08-03 14:46:03 +02001653 slot->attr.type,
Steven Cooreman7f391872020-07-30 14:57:44 +02001654 slot->data.key.data,
1655 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02001656 &ecp );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001657 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001658 return( status );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001659
1660 status = psa_export_ecp_key( PSA_KEY_TYPE_ECC_PUBLIC_KEY(
1661 PSA_KEY_TYPE_ECC_GET_FAMILY(
1662 slot->attr.type ) ),
Steven Cooremana2371e52020-07-28 14:30:39 +02001663 ecp,
Steven Cooreman560c28a2020-07-24 23:20:24 +02001664 data,
1665 data_size,
1666 data_length );
1667
Steven Cooremana2371e52020-07-28 14:30:39 +02001668 mbedtls_ecp_keypair_free( ecp );
1669 mbedtls_free( ecp );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001670 return( status );
1671#else
1672 /* We don't know how to convert a private ECC key to public */
Moran Pekera998bc62018-04-16 18:16:20 +03001673 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001674#endif
Moran Pekera998bc62018-04-16 18:16:20 +03001675 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001676 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001677 else
1678 {
1679 /* This shouldn't happen in the reference implementation, but
1680 it is valid for a special-purpose implementation to omit
1681 support for exporting certain key types. */
1682 return( PSA_ERROR_NOT_SUPPORTED );
1683 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001684}
1685
Ronald Croncf56a0a2020-08-04 09:51:30 +02001686psa_status_t psa_export_key( mbedtls_svc_key_id_t key,
Gilles Peskine2d277862018-06-18 15:41:12 +02001687 uint8_t *data,
1688 size_t data_size,
1689 size_t *data_length )
Moran Pekera998bc62018-04-16 18:16:20 +03001690{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001691 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001692 psa_status_t status;
1693
1694 /* Set the key to empty now, so that even when there are errors, we always
1695 * set data_length to a value between 0 and data_size. On error, setting
1696 * the key to empty is a good choice because an empty key representation is
1697 * unlikely to be accepted anywhere. */
1698 *data_length = 0;
1699
1700 /* Export requires the EXPORT flag. There is an exception for public keys,
1701 * which don't require any flag, but psa_get_key_from_slot takes
1702 * care of this. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001703 status = psa_get_key_from_slot( key, &slot, PSA_KEY_USAGE_EXPORT, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001704 if( status != PSA_SUCCESS )
1705 return( status );
1706 return( psa_internal_export_key( slot, data, data_size,
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02001707 data_length, 0 ) );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001708}
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001709
Ronald Croncf56a0a2020-08-04 09:51:30 +02001710psa_status_t psa_export_public_key( mbedtls_svc_key_id_t key,
Gilles Peskine2d277862018-06-18 15:41:12 +02001711 uint8_t *data,
1712 size_t data_size,
1713 size_t *data_length )
Moran Pekerdd4ea382018-04-03 15:30:03 +03001714{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001715 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001716 psa_status_t status;
1717
1718 /* Set the key to empty now, so that even when there are errors, we always
1719 * set data_length to a value between 0 and data_size. On error, setting
1720 * the key to empty is a good choice because an empty key representation is
1721 * unlikely to be accepted anywhere. */
1722 *data_length = 0;
1723
1724 /* Exporting a public key doesn't require a usage flag. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001725 status = psa_get_key_from_slot( key, &slot, 0, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001726 if( status != PSA_SUCCESS )
1727 return( status );
1728 return( psa_internal_export_key( slot, data, data_size,
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02001729 data_length, 1 ) );
Moran Pekerdd4ea382018-04-03 15:30:03 +03001730}
1731
Gilles Peskine91e8c332019-08-02 19:19:39 +02001732#if defined(static_assert)
1733static_assert( ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
1734 "One or more key attribute flag is listed as both external-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001735static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
Gilles Peskine094dac12019-08-07 18:19:46 +02001736 "One or more key attribute flag is listed as both internal-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001737static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY ) == 0,
Gilles Peskine91e8c332019-08-02 19:19:39 +02001738 "One or more key attribute flag is listed as both internal-only and external-only" );
1739#endif
1740
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001741/** Validate that a key policy is internally well-formed.
1742 *
1743 * This function only rejects invalid policies. It does not validate the
1744 * consistency of the policy with respect to other attributes of the key
1745 * such as the key type.
1746 */
1747static psa_status_t psa_validate_key_policy( const psa_key_policy_t *policy )
Gilles Peskine4747d192019-04-17 15:05:45 +02001748{
1749 if( ( policy->usage & ~( PSA_KEY_USAGE_EXPORT |
Gilles Peskine8e0206a2019-05-14 14:24:28 +02001750 PSA_KEY_USAGE_COPY |
Gilles Peskine4747d192019-04-17 15:05:45 +02001751 PSA_KEY_USAGE_ENCRYPT |
1752 PSA_KEY_USAGE_DECRYPT |
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001753 PSA_KEY_USAGE_SIGN_HASH |
1754 PSA_KEY_USAGE_VERIFY_HASH |
Gilles Peskine4747d192019-04-17 15:05:45 +02001755 PSA_KEY_USAGE_DERIVE ) ) != 0 )
1756 return( PSA_ERROR_INVALID_ARGUMENT );
1757
Gilles Peskine4747d192019-04-17 15:05:45 +02001758 return( PSA_SUCCESS );
1759}
1760
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001761/** Validate the internal consistency of key attributes.
1762 *
1763 * This function only rejects invalid attribute values. If does not
1764 * validate the consistency of the attributes with any key data that may
1765 * be involved in the creation of the key.
1766 *
1767 * Call this function early in the key creation process.
1768 *
1769 * \param[in] attributes Key attributes for the new key.
1770 * \param[out] p_drv On any return, the driver for the key, if any.
1771 * NULL for a transparent key.
1772 *
1773 */
1774static psa_status_t psa_validate_key_attributes(
1775 const psa_key_attributes_t *attributes,
1776 psa_se_drv_table_entry_t **p_drv )
Darryl Green0c6575a2018-11-07 16:05:30 +00001777{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001778 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Ronald Crond2ed4812020-07-17 16:11:30 +02001779 psa_key_lifetime_t lifetime = psa_get_key_lifetime( attributes );
Ronald Cron65f38a32020-10-23 17:11:13 +02001780 mbedtls_svc_key_id_t key = psa_get_key_id( attributes );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001781
Steven Cooreman8c1e7592020-06-17 14:52:05 +02001782 status = psa_validate_key_location( psa_get_key_lifetime( attributes ),
1783 p_drv );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001784 if( status != PSA_SUCCESS )
1785 return( status );
1786
Ronald Crond2ed4812020-07-17 16:11:30 +02001787 status = psa_validate_key_persistence( lifetime );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001788 if( status != PSA_SUCCESS )
1789 return( status );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001790
Ronald Cron65f38a32020-10-23 17:11:13 +02001791 if ( PSA_KEY_LIFETIME_IS_VOLATILE( lifetime ) )
1792 {
1793 if( MBEDTLS_SVC_KEY_ID_GET_KEY_ID( key ) != 0 )
1794 return( PSA_ERROR_INVALID_ARGUMENT );
1795 }
1796 else
Ronald Crond2ed4812020-07-17 16:11:30 +02001797 {
1798 status = psa_validate_key_id(
1799 psa_get_key_id( attributes ),
Ronald Cronfc9c5562020-10-15 19:24:49 +02001800 psa_key_lifetime_is_external( lifetime ), 0 );
Ronald Crond2ed4812020-07-17 16:11:30 +02001801
1802 if( status != PSA_SUCCESS )
1803 return( status );
1804 }
1805
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001806 status = psa_validate_key_policy( &attributes->core.policy );
Darryl Green0c6575a2018-11-07 16:05:30 +00001807 if( status != PSA_SUCCESS )
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001808 return( status );
1809
1810 /* Refuse to create overly large keys.
1811 * Note that this doesn't trigger on import if the attributes don't
1812 * explicitly specify a size (so psa_get_key_bits returns 0), so
1813 * psa_import_key() needs its own checks. */
1814 if( psa_get_key_bits( attributes ) > PSA_MAX_KEY_BITS )
1815 return( PSA_ERROR_NOT_SUPPORTED );
1816
Gilles Peskine91e8c332019-08-02 19:19:39 +02001817 /* Reject invalid flags. These should not be reachable through the API. */
1818 if( attributes->core.flags & ~ ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1819 MBEDTLS_PSA_KA_MASK_DUAL_USE ) )
1820 return( PSA_ERROR_INVALID_ARGUMENT );
1821
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001822 return( PSA_SUCCESS );
1823}
1824
Gilles Peskine4747d192019-04-17 15:05:45 +02001825/** Prepare a key slot to receive key material.
1826 *
1827 * This function allocates a key slot and sets its metadata.
1828 *
1829 * If this function fails, call psa_fail_key_creation().
1830 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001831 * This function is intended to be used as follows:
1832 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001833 * it with the specified attributes, and in case of a volatile key assign it
1834 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001835 * -# Populate the slot with the key material.
1836 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1837 * In case of failure at any step, stop the sequence and call
1838 * psa_fail_key_creation().
1839 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001840 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001841 * \param[in] attributes Key attributes for the new key.
Ronald Cron3c76a422020-10-16 12:17:04 +02001842 * \param[out] key On success, identifier of the key. Note that the
1843 * key identifier is also stored in the prepared
1844 * slot.
Gilles Peskine011e4282019-06-26 18:34:38 +02001845 * \param[out] p_slot On success, a pointer to the prepared slot.
1846 * \param[out] p_drv On any return, the driver for the key, if any.
1847 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001848 *
1849 * \retval #PSA_SUCCESS
1850 * The key slot is ready to receive key material.
1851 * \return If this function fails, the key slot is an invalid state.
1852 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001853 */
1854static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001855 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001856 const psa_key_attributes_t *attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02001857 mbedtls_svc_key_id_t *key,
Gilles Peskine011e4282019-06-26 18:34:38 +02001858 psa_key_slot_t **p_slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001859 psa_se_drv_table_entry_t **p_drv )
Gilles Peskine4747d192019-04-17 15:05:45 +02001860{
1861 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001862 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001863 psa_key_slot_t *slot;
1864
Gilles Peskinedf179142019-07-15 22:02:14 +02001865 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001866 *p_drv = NULL;
1867
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001868 status = psa_validate_key_attributes( attributes, p_drv );
1869 if( status != PSA_SUCCESS )
1870 return( status );
1871
Ronald Cronc4d1b512020-07-31 11:26:37 +02001872 status = psa_get_empty_key_slot( &volatile_key_id, p_slot );
Gilles Peskine4747d192019-04-17 15:05:45 +02001873 if( status != PSA_SUCCESS )
1874 return( status );
1875 slot = *p_slot;
1876
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001877 /* We're storing the declared bit-size of the key. It's up to each
1878 * creation mechanism to verify that this information is correct.
1879 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001880 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001881 * is optional (import, copy). In case of a volatile key, assign it the
1882 * volatile key identifier associated to the slot returned to contain its
1883 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001884
1885 slot->attr = attributes->core;
Ronald Cronc4d1b512020-07-31 11:26:37 +02001886 if( PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
1887 {
1888#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1889 slot->attr.id = volatile_key_id;
1890#else
1891 slot->attr.id.key_id = volatile_key_id;
1892#endif
1893 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001894
Gilles Peskine91e8c332019-08-02 19:19:39 +02001895 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001896 * external-only flags, query `attributes`. Thanks to the check
1897 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001898 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001899 * may have set. */
1900 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001901
Gilles Peskinecbaff462019-07-12 23:46:04 +02001902#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001903 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001904 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001905 * create the key file in internal storage, create the
1906 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001907 * persistent data. This is done by starting a transaction that will
1908 * encompass these three actions.
1909 * For registering a volatile key, we just need to find an appropriate
1910 * slot number inside the SE. Since the key is designated volatile, creating
1911 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001912 /* The first thing to do is to find a slot number for the new key.
1913 * We save the slot number in persistent storage as part of the
1914 * transaction data. It will be needed to recover if the power
1915 * fails during the key creation process, to clean up on the secure
1916 * element side after restarting. Obtaining a slot number from the
1917 * secure element driver updates its persistent state, but we do not yet
1918 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001919 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001920 if( *p_drv != NULL )
Darryl Green0c6575a2018-11-07 16:05:30 +00001921 {
Gilles Peskinee88c2c12019-08-05 16:44:14 +02001922 status = psa_find_se_slot_for_key( attributes, method, *p_drv,
Gilles Peskinecbaff462019-07-12 23:46:04 +02001923 &slot->data.se.slot_number );
1924 if( status != PSA_SUCCESS )
1925 return( status );
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001926
1927 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( attributes->core.lifetime ) )
Gilles Peskine66be51c2019-07-25 18:02:52 +02001928 {
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001929 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_CREATE_KEY );
1930 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
1931 psa_crypto_transaction.key.slot = slot->data.se.slot_number;
1932 psa_crypto_transaction.key.id = slot->attr.id;
1933 status = psa_crypto_save_transaction( );
1934 if( status != PSA_SUCCESS )
1935 {
1936 (void) psa_crypto_stop_transaction( );
1937 return( status );
1938 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001939 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001940 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001941
1942 if( *p_drv == NULL && method == PSA_KEY_CREATION_REGISTER )
1943 {
1944 /* Key registration only makes sense with a secure element. */
1945 return( PSA_ERROR_INVALID_ARGUMENT );
1946 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001947#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1948
Ronald Croncf56a0a2020-08-04 09:51:30 +02001949 *key = slot->attr.id;
Ronald Cronc4d1b512020-07-31 11:26:37 +02001950
1951 return( PSA_SUCCESS );
Darryl Green0c6575a2018-11-07 16:05:30 +00001952}
Gilles Peskine4747d192019-04-17 15:05:45 +02001953
1954/** Finalize the creation of a key once its key material has been set.
1955 *
1956 * This entails writing the key to persistent storage.
1957 *
1958 * If this function fails, call psa_fail_key_creation().
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 Peskine9bc88c62019-04-28 11:37:03 +02001965 *
1966 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001967 * The key was successfully created.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001968 * \return If this function fails, the key slot is an invalid state.
1969 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001970 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001971static psa_status_t psa_finish_key_creation(
1972 psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001973 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001974{
1975 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001976 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001977 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001978
1979#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Steven Cooremanc59de6a2020-06-08 18:28:25 +02001980 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Gilles Peskine4747d192019-04-17 15:05:45 +02001981 {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001982#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1983 if( driver != NULL )
1984 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001985 psa_se_key_data_storage_t data;
1986#if defined(static_assert)
1987 static_assert( sizeof( slot->data.se.slot_number ) ==
1988 sizeof( data.slot_number ),
1989 "Slot number size does not match psa_se_key_data_storage_t" );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001990#endif
1991 memcpy( &data.slot_number, &slot->data.se.slot_number,
1992 sizeof( slot->data.se.slot_number ) );
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001993 status = psa_save_persistent_key( &slot->attr,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001994 (uint8_t*) &data,
1995 sizeof( data ) );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001996 }
1997 else
1998#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1999 {
Steven Cooreman40120f62020-10-29 11:42:22 +01002000 /* Key material is saved in export representation in the slot, so
2001 * just pass the slot buffer for storage. */
2002 status = psa_save_persistent_key( &slot->attr,
2003 slot->data.key.data,
2004 slot->data.key.bytes );
Gilles Peskine1df83d42019-07-23 16:13:14 +02002005 }
Gilles Peskine4747d192019-04-17 15:05:45 +02002006 }
Darryl Green0c6575a2018-11-07 16:05:30 +00002007#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
2008
Gilles Peskinecbaff462019-07-12 23:46:04 +02002009#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02002010 /* Finish the transaction for a key creation. This does not
2011 * happen when registering an existing key. Detect this case
2012 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02002013 * creation of a persistent key in a secure element requires a transaction,
2014 * but registration or volatile key creation doesn't use one). */
Gilles Peskined7729582019-08-05 15:55:54 +02002015 if( driver != NULL &&
2016 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY )
Gilles Peskinecbaff462019-07-12 23:46:04 +02002017 {
2018 status = psa_save_se_persistent_data( driver );
2019 if( status != PSA_SUCCESS )
2020 {
Gilles Peskine8e338702019-07-30 20:06:31 +02002021 psa_destroy_persistent_key( slot->attr.id );
Gilles Peskinecbaff462019-07-12 23:46:04 +02002022 return( status );
2023 }
Gilles Peskinefc762652019-07-22 19:30:34 +02002024 status = psa_crypto_stop_transaction( );
2025 if( status != PSA_SUCCESS )
2026 return( status );
Gilles Peskinecbaff462019-07-12 23:46:04 +02002027 }
2028#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2029
Gilles Peskine4747d192019-04-17 15:05:45 +02002030 return( status );
2031}
2032
2033/** Abort the creation of a key.
2034 *
2035 * You may call this function after calling psa_start_key_creation(),
2036 * or after psa_finish_key_creation() fails. In other circumstances, this
2037 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02002038 * See the documentation of psa_start_key_creation() for the intended use
2039 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02002040 *
Gilles Peskine011e4282019-06-26 18:34:38 +02002041 * \param[in,out] slot Pointer to the slot with key material.
2042 * \param[in] driver The secure element driver for the key,
2043 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02002044 */
Gilles Peskine011e4282019-06-26 18:34:38 +02002045static void psa_fail_key_creation( psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002046 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02002047{
Gilles Peskine011e4282019-06-26 18:34:38 +02002048 (void) driver;
2049
Gilles Peskine4747d192019-04-17 15:05:45 +02002050 if( slot == NULL )
2051 return;
Gilles Peskine011e4282019-06-26 18:34:38 +02002052
2053#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01002054 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02002055 * element, and the failure happened later (when saving metadata
2056 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02002057 * element.
2058 * https://github.com/ARMmbed/mbed-crypto/issues/217
2059 */
Gilles Peskinefc762652019-07-22 19:30:34 +02002060
Gilles Peskined7729582019-08-05 15:55:54 +02002061 /* Abort the ongoing transaction if any (there may not be one if
2062 * the creation process failed before starting one, or if the
2063 * key creation is a registration of a key in a secure element).
2064 * Earlier functions must already have done what it takes to undo any
2065 * partial creation. All that's left is to update the transaction data
2066 * itself. */
Gilles Peskinefc762652019-07-22 19:30:34 +02002067 (void) psa_crypto_stop_transaction( );
Gilles Peskine011e4282019-06-26 18:34:38 +02002068#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2069
Gilles Peskine4747d192019-04-17 15:05:45 +02002070 psa_wipe_key_slot( slot );
2071}
2072
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002073/** Validate optional attributes during key creation.
2074 *
2075 * Some key attributes are optional during key creation. If they are
2076 * specified in the attributes structure, check that they are consistent
2077 * with the data in the slot.
2078 *
2079 * This function should be called near the end of key creation, after
2080 * the slot in memory is fully populated but before saving persistent data.
2081 */
2082static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002083 const psa_key_slot_t *slot,
2084 const psa_key_attributes_t *attributes )
2085{
Gilles Peskine7e0cff92019-07-30 13:48:52 +02002086 if( attributes->core.type != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002087 {
Gilles Peskine8e338702019-07-30 20:06:31 +02002088 if( attributes->core.type != slot->attr.type )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002089 return( PSA_ERROR_INVALID_ARGUMENT );
2090 }
2091
2092 if( attributes->domain_parameters_size != 0 )
2093 {
2094#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02002095 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002096 {
Steven Cooremana2371e52020-07-28 14:30:39 +02002097 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02002098 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02002099 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02002100
Steven Cooreman7f391872020-07-30 14:57:44 +02002101 psa_status_t status = psa_load_rsa_representation(
Steven Cooreman4fed4552020-08-03 14:46:03 +02002102 slot->attr.type,
Steven Cooreman7f391872020-07-30 14:57:44 +02002103 slot->data.key.data,
2104 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02002105 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02002106 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02002107 return( status );
Steven Cooreman75b74362020-07-28 14:30:13 +02002108
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002109 mbedtls_mpi_init( &actual );
2110 mbedtls_mpi_init( &required );
Steven Cooremana2371e52020-07-28 14:30:39 +02002111 ret = mbedtls_rsa_export( rsa,
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002112 NULL, NULL, NULL, NULL, &actual );
Steven Cooremana2371e52020-07-28 14:30:39 +02002113 mbedtls_rsa_free( rsa );
2114 mbedtls_free( rsa );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002115 if( ret != 0 )
2116 goto rsa_exit;
2117 ret = mbedtls_mpi_read_binary( &required,
2118 attributes->domain_parameters,
2119 attributes->domain_parameters_size );
2120 if( ret != 0 )
2121 goto rsa_exit;
2122 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
2123 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
2124 rsa_exit:
2125 mbedtls_mpi_free( &actual );
2126 mbedtls_mpi_free( &required );
2127 if( ret != 0)
2128 return( mbedtls_to_psa_error( ret ) );
2129 }
2130 else
2131#endif
2132 {
2133 return( PSA_ERROR_INVALID_ARGUMENT );
2134 }
2135 }
2136
Gilles Peskine7e0cff92019-07-30 13:48:52 +02002137 if( attributes->core.bits != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002138 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02002139 if( attributes->core.bits != slot->attr.bits )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002140 return( PSA_ERROR_INVALID_ARGUMENT );
2141 }
2142
2143 return( PSA_SUCCESS );
2144}
2145
Gilles Peskine4747d192019-04-17 15:05:45 +02002146psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02002147 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02002148 size_t data_length,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002149 mbedtls_svc_key_id_t *key )
Gilles Peskine4747d192019-04-17 15:05:45 +02002150{
2151 psa_status_t status;
2152 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002153 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002154
Gilles Peskine0f84d622019-09-12 19:03:13 +02002155 /* Reject zero-length symmetric keys (including raw data key objects).
2156 * This also rejects any key which might be encoded as an empty string,
2157 * which is never valid. */
2158 if( data_length == 0 )
2159 return( PSA_ERROR_INVALID_ARGUMENT );
2160
Gilles Peskinedf179142019-07-15 22:02:14 +02002161 status = psa_start_key_creation( PSA_KEY_CREATION_IMPORT, attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002162 key, &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002163 if( status != PSA_SUCCESS )
2164 goto exit;
2165
Gilles Peskine5d309672019-07-12 23:47:28 +02002166#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2167 if( driver != NULL )
2168 {
2169 const psa_drv_se_t *drv = psa_get_se_driver_methods( driver );
Darryl Green0892d0f2019-08-20 09:50:14 +01002170 /* The driver should set the number of key bits, however in
2171 * case it doesn't, we initialize bits to an invalid value. */
2172 size_t bits = PSA_MAX_KEY_BITS + 1;
Gilles Peskine5d309672019-07-12 23:47:28 +02002173 if( drv->key_management == NULL ||
2174 drv->key_management->p_import == NULL )
2175 {
2176 status = PSA_ERROR_NOT_SUPPORTED;
2177 goto exit;
2178 }
2179 status = drv->key_management->p_import(
2180 psa_get_se_driver_context( driver ),
Gilles Peskinef3801ff2019-08-06 17:32:04 +02002181 slot->data.se.slot_number, attributes, data, data_length,
Gilles Peskineb46bef22019-07-30 21:32:04 +02002182 &bits );
2183 if( status != PSA_SUCCESS )
2184 goto exit;
2185 if( bits > PSA_MAX_KEY_BITS )
2186 {
2187 status = PSA_ERROR_NOT_SUPPORTED;
2188 goto exit;
2189 }
2190 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskine5d309672019-07-12 23:47:28 +02002191 }
2192 else
2193#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2194 {
2195 status = psa_import_key_into_slot( slot, data, data_length );
2196 if( status != PSA_SUCCESS )
2197 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02002198 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002199 status = psa_validate_optional_attributes( slot, attributes );
Gilles Peskine18017402019-07-24 20:25:59 +02002200 if( status != PSA_SUCCESS )
2201 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002202
Gilles Peskine011e4282019-06-26 18:34:38 +02002203 status = psa_finish_key_creation( slot, driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002204exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02002205 if( status != PSA_SUCCESS )
2206 {
Gilles Peskine011e4282019-06-26 18:34:38 +02002207 psa_fail_key_creation( slot, driver );
Ronald Croncf56a0a2020-08-04 09:51:30 +02002208 *key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine4747d192019-04-17 15:05:45 +02002209 }
2210 return( status );
2211}
2212
Gilles Peskined7729582019-08-05 15:55:54 +02002213#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2214psa_status_t mbedtls_psa_register_se_key(
2215 const psa_key_attributes_t *attributes )
2216{
2217 psa_status_t status;
2218 psa_key_slot_t *slot = NULL;
2219 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02002220 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02002221
2222 /* Leaving attributes unspecified is not currently supported.
2223 * It could make sense to query the key type and size from the
2224 * secure element, but not all secure elements support this
2225 * and the driver HAL doesn't currently support it. */
2226 if( psa_get_key_type( attributes ) == PSA_KEY_TYPE_NONE )
2227 return( PSA_ERROR_NOT_SUPPORTED );
2228 if( psa_get_key_bits( attributes ) == 0 )
2229 return( PSA_ERROR_NOT_SUPPORTED );
2230
2231 status = psa_start_key_creation( PSA_KEY_CREATION_REGISTER, attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002232 &key, &slot, &driver );
Gilles Peskined7729582019-08-05 15:55:54 +02002233 if( status != PSA_SUCCESS )
2234 goto exit;
2235
Gilles Peskined7729582019-08-05 15:55:54 +02002236 status = psa_finish_key_creation( slot, driver );
2237
2238exit:
2239 if( status != PSA_SUCCESS )
2240 {
2241 psa_fail_key_creation( slot, driver );
2242 }
2243 /* Registration doesn't keep the key in RAM. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02002244 psa_close_key( key );
Gilles Peskined7729582019-08-05 15:55:54 +02002245 return( status );
2246}
2247#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2248
Gilles Peskinef603c712019-01-19 13:40:11 +01002249static psa_status_t psa_copy_key_material( const psa_key_slot_t *source,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002250 psa_key_slot_t *target )
Gilles Peskinef603c712019-01-19 13:40:11 +01002251{
Steven Cooremanf7cebd42020-10-13 20:27:40 +02002252 psa_status_t status = psa_copy_key_material_into_slot( target,
2253 source->data.key.data,
2254 source->data.key.bytes );
Gilles Peskinef603c712019-01-19 13:40:11 +01002255 if( status != PSA_SUCCESS )
Steven Cooreman398aee52020-10-13 14:35:45 +02002256 return( status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002257
Steven Cooreman398aee52020-10-13 14:35:45 +02002258 target->attr.type = source->attr.type;
2259 target->attr.bits = source->attr.bits;
2260
2261 return( PSA_SUCCESS );
Gilles Peskinef603c712019-01-19 13:40:11 +01002262}
2263
Ronald Croncf56a0a2020-08-04 09:51:30 +02002264psa_status_t psa_copy_key( mbedtls_svc_key_id_t source_key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002265 const psa_key_attributes_t *specified_attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002266 mbedtls_svc_key_id_t *target_key )
Gilles Peskinef603c712019-01-19 13:40:11 +01002267{
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002268 psa_status_t status;
Gilles Peskinef603c712019-01-19 13:40:11 +01002269 psa_key_slot_t *source_slot = NULL;
2270 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002271 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002272 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskinef603c712019-01-19 13:40:11 +01002273
Ronald Croncf56a0a2020-08-04 09:51:30 +02002274 status = psa_get_transparent_key( source_key, &source_slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02002275 PSA_KEY_USAGE_COPY, 0 );
Gilles Peskinef603c712019-01-19 13:40:11 +01002276 if( status != PSA_SUCCESS )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002277 goto exit;
2278
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002279 status = psa_validate_optional_attributes( source_slot,
2280 specified_attributes );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002281 if( status != PSA_SUCCESS )
2282 goto exit;
2283
Gilles Peskine7e0cff92019-07-30 13:48:52 +02002284 status = psa_restrict_key_policy( &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02002285 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002286 if( status != PSA_SUCCESS )
2287 goto exit;
2288
Gilles Peskinedf179142019-07-15 22:02:14 +02002289 status = psa_start_key_creation( PSA_KEY_CREATION_COPY,
2290 &actual_attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002291 target_key, &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002292 if( status != PSA_SUCCESS )
2293 goto exit;
2294
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002295#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2296 if( driver != NULL )
Gilles Peskinef603c712019-01-19 13:40:11 +01002297 {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002298 /* Copying to a secure element is not implemented yet. */
2299 status = PSA_ERROR_NOT_SUPPORTED;
2300 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002301 }
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002302#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef603c712019-01-19 13:40:11 +01002303
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002304 status = psa_copy_key_material( source_slot, target_slot );
Gilles Peskinef603c712019-01-19 13:40:11 +01002305 if( status != PSA_SUCCESS )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002306 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002307
Gilles Peskine011e4282019-06-26 18:34:38 +02002308 status = psa_finish_key_creation( target_slot, driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002309exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002310 if( status != PSA_SUCCESS )
2311 {
Gilles Peskine011e4282019-06-26 18:34:38 +02002312 psa_fail_key_creation( target_slot, driver );
Ronald Croncf56a0a2020-08-04 09:51:30 +02002313 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002314 }
2315 return( status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002316}
2317
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002318
2319
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002320/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002321/* Message digests */
2322/****************************************************************/
2323
John Durkop0ea39e02020-10-13 19:58:20 -07002324#if defined(MBEDTLS_RSA_C) || defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinedc2fc842018-03-07 16:42:59 +01002325static const mbedtls_md_info_t *mbedtls_md_info_from_psa( psa_algorithm_t alg )
Gilles Peskine20035e32018-02-03 22:44:14 +01002326{
2327 switch( alg )
2328 {
2329#if defined(MBEDTLS_MD2_C)
2330 case PSA_ALG_MD2:
2331 return( &mbedtls_md2_info );
2332#endif
2333#if defined(MBEDTLS_MD4_C)
2334 case PSA_ALG_MD4:
2335 return( &mbedtls_md4_info );
2336#endif
2337#if defined(MBEDTLS_MD5_C)
2338 case PSA_ALG_MD5:
2339 return( &mbedtls_md5_info );
2340#endif
2341#if defined(MBEDTLS_RIPEMD160_C)
2342 case PSA_ALG_RIPEMD160:
2343 return( &mbedtls_ripemd160_info );
2344#endif
2345#if defined(MBEDTLS_SHA1_C)
2346 case PSA_ALG_SHA_1:
2347 return( &mbedtls_sha1_info );
2348#endif
2349#if defined(MBEDTLS_SHA256_C)
2350 case PSA_ALG_SHA_224:
2351 return( &mbedtls_sha224_info );
2352 case PSA_ALG_SHA_256:
2353 return( &mbedtls_sha256_info );
2354#endif
2355#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnardd6020842019-07-17 16:28:21 +02002356#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine20035e32018-02-03 22:44:14 +01002357 case PSA_ALG_SHA_384:
2358 return( &mbedtls_sha384_info );
Manuel Pégourié-Gonnardd6020842019-07-17 16:28:21 +02002359#endif
Gilles Peskine20035e32018-02-03 22:44:14 +01002360 case PSA_ALG_SHA_512:
2361 return( &mbedtls_sha512_info );
2362#endif
2363 default:
2364 return( NULL );
2365 }
2366}
John Durkop0ea39e02020-10-13 19:58:20 -07002367#endif /* defined(MBEDTLS_RSA_C) || defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine20035e32018-02-03 22:44:14 +01002368
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002369psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
2370{
2371 switch( operation->alg )
2372 {
Gilles Peskine81736312018-06-26 15:04:31 +02002373 case 0:
2374 /* The object has (apparently) been initialized but it is not
2375 * in use. It's ok to call abort on such an object, and there's
2376 * nothing to do. */
2377 break;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002378#if defined(MBEDTLS_MD2_C)
2379 case PSA_ALG_MD2:
2380 mbedtls_md2_free( &operation->ctx.md2 );
2381 break;
2382#endif
2383#if defined(MBEDTLS_MD4_C)
2384 case PSA_ALG_MD4:
2385 mbedtls_md4_free( &operation->ctx.md4 );
2386 break;
2387#endif
2388#if defined(MBEDTLS_MD5_C)
2389 case PSA_ALG_MD5:
2390 mbedtls_md5_free( &operation->ctx.md5 );
2391 break;
2392#endif
2393#if defined(MBEDTLS_RIPEMD160_C)
2394 case PSA_ALG_RIPEMD160:
2395 mbedtls_ripemd160_free( &operation->ctx.ripemd160 );
2396 break;
2397#endif
2398#if defined(MBEDTLS_SHA1_C)
2399 case PSA_ALG_SHA_1:
2400 mbedtls_sha1_free( &operation->ctx.sha1 );
2401 break;
2402#endif
2403#if defined(MBEDTLS_SHA256_C)
2404 case PSA_ALG_SHA_224:
2405 case PSA_ALG_SHA_256:
2406 mbedtls_sha256_free( &operation->ctx.sha256 );
2407 break;
2408#endif
2409#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002410#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002411 case PSA_ALG_SHA_384:
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002412#endif
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002413 case PSA_ALG_SHA_512:
2414 mbedtls_sha512_free( &operation->ctx.sha512 );
2415 break;
2416#endif
2417 default:
Gilles Peskinef9c2c092018-06-21 16:57:07 +02002418 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002419 }
2420 operation->alg = 0;
2421 return( PSA_SUCCESS );
2422}
2423
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002424psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002425 psa_algorithm_t alg )
2426{
Janos Follath24eed8d2019-11-22 13:21:35 +00002427 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002428
2429 /* A context must be freshly initialized before it can be set up. */
2430 if( operation->alg != 0 )
2431 {
2432 return( PSA_ERROR_BAD_STATE );
2433 }
2434
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002435 switch( alg )
2436 {
2437#if defined(MBEDTLS_MD2_C)
2438 case PSA_ALG_MD2:
2439 mbedtls_md2_init( &operation->ctx.md2 );
2440 ret = mbedtls_md2_starts_ret( &operation->ctx.md2 );
2441 break;
2442#endif
2443#if defined(MBEDTLS_MD4_C)
2444 case PSA_ALG_MD4:
2445 mbedtls_md4_init( &operation->ctx.md4 );
2446 ret = mbedtls_md4_starts_ret( &operation->ctx.md4 );
2447 break;
2448#endif
2449#if defined(MBEDTLS_MD5_C)
2450 case PSA_ALG_MD5:
2451 mbedtls_md5_init( &operation->ctx.md5 );
2452 ret = mbedtls_md5_starts_ret( &operation->ctx.md5 );
2453 break;
2454#endif
2455#if defined(MBEDTLS_RIPEMD160_C)
2456 case PSA_ALG_RIPEMD160:
2457 mbedtls_ripemd160_init( &operation->ctx.ripemd160 );
2458 ret = mbedtls_ripemd160_starts_ret( &operation->ctx.ripemd160 );
2459 break;
2460#endif
2461#if defined(MBEDTLS_SHA1_C)
2462 case PSA_ALG_SHA_1:
2463 mbedtls_sha1_init( &operation->ctx.sha1 );
2464 ret = mbedtls_sha1_starts_ret( &operation->ctx.sha1 );
2465 break;
2466#endif
2467#if defined(MBEDTLS_SHA256_C)
2468 case PSA_ALG_SHA_224:
2469 mbedtls_sha256_init( &operation->ctx.sha256 );
2470 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 1 );
2471 break;
2472 case PSA_ALG_SHA_256:
2473 mbedtls_sha256_init( &operation->ctx.sha256 );
2474 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 0 );
2475 break;
2476#endif
2477#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002478#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002479 case PSA_ALG_SHA_384:
2480 mbedtls_sha512_init( &operation->ctx.sha512 );
2481 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 1 );
2482 break;
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002483#endif
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002484 case PSA_ALG_SHA_512:
2485 mbedtls_sha512_init( &operation->ctx.sha512 );
2486 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 0 );
2487 break;
2488#endif
2489 default:
Gilles Peskinec06e0712018-06-20 16:21:04 +02002490 return( PSA_ALG_IS_HASH( alg ) ?
2491 PSA_ERROR_NOT_SUPPORTED :
2492 PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002493 }
2494 if( ret == 0 )
2495 operation->alg = alg;
2496 else
2497 psa_hash_abort( operation );
2498 return( mbedtls_to_psa_error( ret ) );
2499}
2500
2501psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2502 const uint8_t *input,
2503 size_t input_length )
2504{
Janos Follath24eed8d2019-11-22 13:21:35 +00002505 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine94e44542018-07-12 16:58:43 +02002506
2507 /* Don't require hash implementations to behave correctly on a
2508 * zero-length input, which may have an invalid pointer. */
2509 if( input_length == 0 )
2510 return( PSA_SUCCESS );
2511
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002512 switch( operation->alg )
2513 {
2514#if defined(MBEDTLS_MD2_C)
2515 case PSA_ALG_MD2:
2516 ret = mbedtls_md2_update_ret( &operation->ctx.md2,
2517 input, input_length );
2518 break;
2519#endif
2520#if defined(MBEDTLS_MD4_C)
2521 case PSA_ALG_MD4:
2522 ret = mbedtls_md4_update_ret( &operation->ctx.md4,
2523 input, input_length );
2524 break;
2525#endif
2526#if defined(MBEDTLS_MD5_C)
2527 case PSA_ALG_MD5:
2528 ret = mbedtls_md5_update_ret( &operation->ctx.md5,
2529 input, input_length );
2530 break;
2531#endif
2532#if defined(MBEDTLS_RIPEMD160_C)
2533 case PSA_ALG_RIPEMD160:
2534 ret = mbedtls_ripemd160_update_ret( &operation->ctx.ripemd160,
2535 input, input_length );
2536 break;
2537#endif
2538#if defined(MBEDTLS_SHA1_C)
2539 case PSA_ALG_SHA_1:
2540 ret = mbedtls_sha1_update_ret( &operation->ctx.sha1,
2541 input, input_length );
2542 break;
2543#endif
2544#if defined(MBEDTLS_SHA256_C)
2545 case PSA_ALG_SHA_224:
2546 case PSA_ALG_SHA_256:
2547 ret = mbedtls_sha256_update_ret( &operation->ctx.sha256,
2548 input, input_length );
2549 break;
2550#endif
2551#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002552#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002553 case PSA_ALG_SHA_384:
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002554#endif
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002555 case PSA_ALG_SHA_512:
2556 ret = mbedtls_sha512_update_ret( &operation->ctx.sha512,
2557 input, input_length );
2558 break;
2559#endif
2560 default:
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002561 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002562 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002563
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002564 if( ret != 0 )
2565 psa_hash_abort( operation );
2566 return( mbedtls_to_psa_error( ret ) );
2567}
2568
2569psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2570 uint8_t *hash,
2571 size_t hash_size,
2572 size_t *hash_length )
2573{
itayzafrir40835d42018-08-02 13:14:17 +03002574 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00002575 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine71bb7b72018-04-19 08:29:59 +02002576 size_t actual_hash_length = PSA_HASH_SIZE( operation->alg );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002577
2578 /* Fill the output buffer with something that isn't a valid hash
2579 * (barring an attack on the hash and deliberately-crafted input),
2580 * in case the caller doesn't check the return status properly. */
Gilles Peskineaee13332018-07-02 12:15:28 +02002581 *hash_length = hash_size;
Gilles Peskine46f1fd72018-06-28 19:31:31 +02002582 /* If hash_size is 0 then hash may be NULL and then the
2583 * call to memset would have undefined behavior. */
2584 if( hash_size != 0 )
2585 memset( hash, '!', hash_size );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002586
2587 if( hash_size < actual_hash_length )
itayzafrir40835d42018-08-02 13:14:17 +03002588 {
2589 status = PSA_ERROR_BUFFER_TOO_SMALL;
2590 goto exit;
2591 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002592
2593 switch( operation->alg )
2594 {
2595#if defined(MBEDTLS_MD2_C)
2596 case PSA_ALG_MD2:
2597 ret = mbedtls_md2_finish_ret( &operation->ctx.md2, hash );
2598 break;
2599#endif
2600#if defined(MBEDTLS_MD4_C)
2601 case PSA_ALG_MD4:
2602 ret = mbedtls_md4_finish_ret( &operation->ctx.md4, hash );
2603 break;
2604#endif
2605#if defined(MBEDTLS_MD5_C)
2606 case PSA_ALG_MD5:
2607 ret = mbedtls_md5_finish_ret( &operation->ctx.md5, hash );
2608 break;
2609#endif
2610#if defined(MBEDTLS_RIPEMD160_C)
2611 case PSA_ALG_RIPEMD160:
2612 ret = mbedtls_ripemd160_finish_ret( &operation->ctx.ripemd160, hash );
2613 break;
2614#endif
2615#if defined(MBEDTLS_SHA1_C)
2616 case PSA_ALG_SHA_1:
2617 ret = mbedtls_sha1_finish_ret( &operation->ctx.sha1, hash );
2618 break;
2619#endif
2620#if defined(MBEDTLS_SHA256_C)
2621 case PSA_ALG_SHA_224:
2622 case PSA_ALG_SHA_256:
2623 ret = mbedtls_sha256_finish_ret( &operation->ctx.sha256, hash );
2624 break;
2625#endif
2626#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002627#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002628 case PSA_ALG_SHA_384:
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002629#endif
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002630 case PSA_ALG_SHA_512:
2631 ret = mbedtls_sha512_finish_ret( &operation->ctx.sha512, hash );
2632 break;
2633#endif
2634 default:
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002635 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002636 }
itayzafrir40835d42018-08-02 13:14:17 +03002637 status = mbedtls_to_psa_error( ret );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002638
itayzafrir40835d42018-08-02 13:14:17 +03002639exit:
2640 if( status == PSA_SUCCESS )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002641 {
Gilles Peskineaee13332018-07-02 12:15:28 +02002642 *hash_length = actual_hash_length;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002643 return( psa_hash_abort( operation ) );
2644 }
2645 else
2646 {
2647 psa_hash_abort( operation );
itayzafrir40835d42018-08-02 13:14:17 +03002648 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002649 }
2650}
2651
Gilles Peskine2d277862018-06-18 15:41:12 +02002652psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2653 const uint8_t *hash,
2654 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002655{
2656 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2657 size_t actual_hash_length;
2658 psa_status_t status = psa_hash_finish( operation,
2659 actual_hash, sizeof( actual_hash ),
2660 &actual_hash_length );
2661 if( status != PSA_SUCCESS )
2662 return( status );
2663 if( actual_hash_length != hash_length )
2664 return( PSA_ERROR_INVALID_SIGNATURE );
2665 if( safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
2666 return( PSA_ERROR_INVALID_SIGNATURE );
2667 return( PSA_SUCCESS );
2668}
2669
Gilles Peskine0a749c82019-11-28 19:33:58 +01002670psa_status_t psa_hash_compute( psa_algorithm_t alg,
2671 const uint8_t *input, size_t input_length,
2672 uint8_t *hash, size_t hash_size,
2673 size_t *hash_length )
2674{
2675 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
2676 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2677
2678 *hash_length = hash_size;
2679 status = psa_hash_setup( &operation, alg );
2680 if( status != PSA_SUCCESS )
2681 goto exit;
2682 status = psa_hash_update( &operation, input, input_length );
2683 if( status != PSA_SUCCESS )
2684 goto exit;
2685 status = psa_hash_finish( &operation, hash, hash_size, hash_length );
2686 if( status != PSA_SUCCESS )
2687 goto exit;
2688
2689exit:
2690 if( status == PSA_SUCCESS )
2691 status = psa_hash_abort( &operation );
2692 else
2693 psa_hash_abort( &operation );
2694 return( status );
2695}
2696
2697psa_status_t psa_hash_compare( psa_algorithm_t alg,
2698 const uint8_t *input, size_t input_length,
2699 const uint8_t *hash, size_t hash_length )
2700{
2701 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
2702 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2703
2704 status = psa_hash_setup( &operation, alg );
2705 if( status != PSA_SUCCESS )
2706 goto exit;
2707 status = psa_hash_update( &operation, input, input_length );
2708 if( status != PSA_SUCCESS )
2709 goto exit;
2710 status = psa_hash_verify( &operation, hash, hash_length );
2711 if( status != PSA_SUCCESS )
2712 goto exit;
2713
2714exit:
2715 if( status == PSA_SUCCESS )
2716 status = psa_hash_abort( &operation );
2717 else
2718 psa_hash_abort( &operation );
2719 return( status );
2720}
2721
Gilles Peskineeb35d782019-01-22 17:56:16 +01002722psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2723 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002724{
2725 if( target_operation->alg != 0 )
2726 return( PSA_ERROR_BAD_STATE );
2727
2728 switch( source_operation->alg )
2729 {
2730 case 0:
2731 return( PSA_ERROR_BAD_STATE );
2732#if defined(MBEDTLS_MD2_C)
2733 case PSA_ALG_MD2:
2734 mbedtls_md2_clone( &target_operation->ctx.md2,
2735 &source_operation->ctx.md2 );
2736 break;
2737#endif
2738#if defined(MBEDTLS_MD4_C)
2739 case PSA_ALG_MD4:
2740 mbedtls_md4_clone( &target_operation->ctx.md4,
2741 &source_operation->ctx.md4 );
2742 break;
2743#endif
2744#if defined(MBEDTLS_MD5_C)
2745 case PSA_ALG_MD5:
2746 mbedtls_md5_clone( &target_operation->ctx.md5,
2747 &source_operation->ctx.md5 );
2748 break;
2749#endif
2750#if defined(MBEDTLS_RIPEMD160_C)
2751 case PSA_ALG_RIPEMD160:
2752 mbedtls_ripemd160_clone( &target_operation->ctx.ripemd160,
2753 &source_operation->ctx.ripemd160 );
2754 break;
2755#endif
2756#if defined(MBEDTLS_SHA1_C)
2757 case PSA_ALG_SHA_1:
2758 mbedtls_sha1_clone( &target_operation->ctx.sha1,
2759 &source_operation->ctx.sha1 );
2760 break;
2761#endif
2762#if defined(MBEDTLS_SHA256_C)
2763 case PSA_ALG_SHA_224:
2764 case PSA_ALG_SHA_256:
2765 mbedtls_sha256_clone( &target_operation->ctx.sha256,
2766 &source_operation->ctx.sha256 );
2767 break;
2768#endif
2769#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002770#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002771 case PSA_ALG_SHA_384:
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002772#endif
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002773 case PSA_ALG_SHA_512:
2774 mbedtls_sha512_clone( &target_operation->ctx.sha512,
2775 &source_operation->ctx.sha512 );
2776 break;
2777#endif
2778 default:
2779 return( PSA_ERROR_NOT_SUPPORTED );
2780 }
2781
2782 target_operation->alg = source_operation->alg;
2783 return( PSA_SUCCESS );
2784}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002785
2786
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002787/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002788/* MAC */
2789/****************************************************************/
2790
Gilles Peskinedc2fc842018-03-07 16:42:59 +01002791static const mbedtls_cipher_info_t *mbedtls_cipher_info_from_psa(
Gilles Peskine8c9def32018-02-08 10:02:12 +01002792 psa_algorithm_t alg,
2793 psa_key_type_t key_type,
Gilles Peskine2d277862018-06-18 15:41:12 +02002794 size_t key_bits,
mohammad1603f4f0d612018-06-03 15:04:51 +03002795 mbedtls_cipher_id_t* cipher_id )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002796{
Gilles Peskine8c9def32018-02-08 10:02:12 +01002797 mbedtls_cipher_mode_t mode;
mohammad1603f4f0d612018-06-03 15:04:51 +03002798 mbedtls_cipher_id_t cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002799
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002800 if( PSA_ALG_IS_AEAD( alg ) )
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002801 alg = PSA_ALG_AEAD_WITH_TAG_LENGTH( alg, 0 );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002802
Gilles Peskine8c9def32018-02-08 10:02:12 +01002803 if( PSA_ALG_IS_CIPHER( alg ) || PSA_ALG_IS_AEAD( alg ) )
2804 {
Nir Sonnenscheine9664c32018-06-17 14:41:30 +03002805 switch( alg )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002806 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002807 case PSA_ALG_ARC4:
Gilles Peskine26869f22019-05-06 15:25:00 +02002808 case PSA_ALG_CHACHA20:
Gilles Peskine8c9def32018-02-08 10:02:12 +01002809 mode = MBEDTLS_MODE_STREAM;
2810 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002811 case PSA_ALG_CTR:
2812 mode = MBEDTLS_MODE_CTR;
2813 break;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002814 case PSA_ALG_CFB:
2815 mode = MBEDTLS_MODE_CFB;
2816 break;
2817 case PSA_ALG_OFB:
2818 mode = MBEDTLS_MODE_OFB;
2819 break;
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02002820 case PSA_ALG_ECB_NO_PADDING:
2821 mode = MBEDTLS_MODE_ECB;
2822 break;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002823 case PSA_ALG_CBC_NO_PADDING:
2824 mode = MBEDTLS_MODE_CBC;
2825 break;
2826 case PSA_ALG_CBC_PKCS7:
2827 mode = MBEDTLS_MODE_CBC;
2828 break;
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002829 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002830 mode = MBEDTLS_MODE_CCM;
2831 break;
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002832 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_GCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002833 mode = MBEDTLS_MODE_GCM;
2834 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02002835 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CHACHA20_POLY1305, 0 ):
2836 mode = MBEDTLS_MODE_CHACHAPOLY;
2837 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002838 default:
2839 return( NULL );
2840 }
2841 }
2842 else if( alg == PSA_ALG_CMAC )
2843 mode = MBEDTLS_MODE_ECB;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002844 else
2845 return( NULL );
2846
2847 switch( key_type )
2848 {
2849 case PSA_KEY_TYPE_AES:
mohammad1603f4f0d612018-06-03 15:04:51 +03002850 cipher_id_tmp = MBEDTLS_CIPHER_ID_AES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002851 break;
2852 case PSA_KEY_TYPE_DES:
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002853 /* key_bits is 64 for Single-DES, 128 for two-key Triple-DES,
2854 * and 192 for three-key Triple-DES. */
Gilles Peskine8c9def32018-02-08 10:02:12 +01002855 if( key_bits == 64 )
mohammad1603f4f0d612018-06-03 15:04:51 +03002856 cipher_id_tmp = MBEDTLS_CIPHER_ID_DES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002857 else
mohammad1603f4f0d612018-06-03 15:04:51 +03002858 cipher_id_tmp = MBEDTLS_CIPHER_ID_3DES;
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002859 /* mbedtls doesn't recognize two-key Triple-DES as an algorithm,
2860 * but two-key Triple-DES is functionally three-key Triple-DES
2861 * with K1=K3, so that's how we present it to mbedtls. */
2862 if( key_bits == 128 )
2863 key_bits = 192;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002864 break;
2865 case PSA_KEY_TYPE_CAMELLIA:
mohammad1603f4f0d612018-06-03 15:04:51 +03002866 cipher_id_tmp = MBEDTLS_CIPHER_ID_CAMELLIA;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002867 break;
2868 case PSA_KEY_TYPE_ARC4:
mohammad1603f4f0d612018-06-03 15:04:51 +03002869 cipher_id_tmp = MBEDTLS_CIPHER_ID_ARC4;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002870 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02002871 case PSA_KEY_TYPE_CHACHA20:
2872 cipher_id_tmp = MBEDTLS_CIPHER_ID_CHACHA20;
2873 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002874 default:
2875 return( NULL );
2876 }
mohammad1603f4f0d612018-06-03 15:04:51 +03002877 if( cipher_id != NULL )
mohammad160360a64d02018-06-03 17:20:42 +03002878 *cipher_id = cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002879
Jaeden Amero23bbb752018-06-26 14:16:54 +01002880 return( mbedtls_cipher_info_from_values( cipher_id_tmp,
2881 (int) key_bits, mode ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002882}
2883
Gilles Peskinea05219c2018-11-16 16:02:56 +01002884#if defined(MBEDTLS_MD_C)
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002885static size_t psa_get_hash_block_size( psa_algorithm_t alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002886{
Gilles Peskine2d277862018-06-18 15:41:12 +02002887 switch( alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002888 {
2889 case PSA_ALG_MD2:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002890 return( 16 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002891 case PSA_ALG_MD4:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002892 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002893 case PSA_ALG_MD5:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002894 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002895 case PSA_ALG_RIPEMD160:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002896 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002897 case PSA_ALG_SHA_1:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002898 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002899 case PSA_ALG_SHA_224:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002900 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002901 case PSA_ALG_SHA_256:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002902 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002903 case PSA_ALG_SHA_384:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002904 return( 128 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002905 case PSA_ALG_SHA_512:
Gilles Peskine2d277862018-06-18 15:41:12 +02002906 return( 128 );
2907 default:
2908 return( 0 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002909 }
2910}
Gilles Peskinea05219c2018-11-16 16:02:56 +01002911#endif /* MBEDTLS_MD_C */
Nir Sonnenschein0c9ec532018-06-07 13:27:47 +03002912
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002913/* Initialize the MAC operation structure. Once this function has been
2914 * called, psa_mac_abort can run and will do the right thing. */
2915static psa_status_t psa_mac_init( psa_mac_operation_t *operation,
2916 psa_algorithm_t alg )
2917{
2918 psa_status_t status = PSA_ERROR_NOT_SUPPORTED;
2919
2920 operation->alg = alg;
2921 operation->key_set = 0;
2922 operation->iv_set = 0;
2923 operation->iv_required = 0;
2924 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002925 operation->is_sign = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002926
2927#if defined(MBEDTLS_CMAC_C)
2928 if( alg == PSA_ALG_CMAC )
2929 {
2930 operation->iv_required = 0;
2931 mbedtls_cipher_init( &operation->ctx.cmac );
2932 status = PSA_SUCCESS;
2933 }
2934 else
2935#endif /* MBEDTLS_CMAC_C */
2936#if defined(MBEDTLS_MD_C)
2937 if( PSA_ALG_IS_HMAC( operation->alg ) )
2938 {
Gilles Peskineff94abd2018-07-12 17:07:52 +02002939 /* We'll set up the hash operation later in psa_hmac_setup_internal. */
2940 operation->ctx.hmac.hash_ctx.alg = 0;
2941 status = PSA_SUCCESS;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002942 }
2943 else
2944#endif /* MBEDTLS_MD_C */
2945 {
Gilles Peskinec06e0712018-06-20 16:21:04 +02002946 if( ! PSA_ALG_IS_MAC( alg ) )
2947 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002948 }
2949
2950 if( status != PSA_SUCCESS )
2951 memset( operation, 0, sizeof( *operation ) );
2952 return( status );
2953}
2954
Gilles Peskine01126fa2018-07-12 17:04:55 +02002955#if defined(MBEDTLS_MD_C)
2956static psa_status_t psa_hmac_abort_internal( psa_hmac_internal_data *hmac )
2957{
Gilles Peskine3f108122018-12-07 18:14:53 +01002958 mbedtls_platform_zeroize( hmac->opad, sizeof( hmac->opad ) );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002959 return( psa_hash_abort( &hmac->hash_ctx ) );
2960}
2961#endif /* MBEDTLS_MD_C */
2962
Gilles Peskine8c9def32018-02-08 10:02:12 +01002963psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
2964{
Gilles Peskinefbfac682018-07-08 20:51:54 +02002965 if( operation->alg == 0 )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002966 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02002967 /* The object has (apparently) been initialized but it is not
2968 * in use. It's ok to call abort on such an object, and there's
2969 * nothing to do. */
2970 return( PSA_SUCCESS );
2971 }
2972 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002973#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002974 if( operation->alg == PSA_ALG_CMAC )
2975 {
2976 mbedtls_cipher_free( &operation->ctx.cmac );
2977 }
2978 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002979#endif /* MBEDTLS_CMAC_C */
Gilles Peskine8c9def32018-02-08 10:02:12 +01002980#if defined(MBEDTLS_MD_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002981 if( PSA_ALG_IS_HMAC( operation->alg ) )
2982 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02002983 psa_hmac_abort_internal( &operation->ctx.hmac );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002984 }
2985 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002986#endif /* MBEDTLS_MD_C */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002987 {
2988 /* Sanity check (shouldn't happen: operation->alg should
2989 * always have been initialized to a valid value). */
2990 goto bad_state;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002991 }
Moran Peker41deec42018-04-04 15:43:05 +03002992
Gilles Peskine8c9def32018-02-08 10:02:12 +01002993 operation->alg = 0;
2994 operation->key_set = 0;
2995 operation->iv_set = 0;
2996 operation->iv_required = 0;
2997 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002998 operation->is_sign = 0;
Moran Peker41deec42018-04-04 15:43:05 +03002999
Gilles Peskine8c9def32018-02-08 10:02:12 +01003000 return( PSA_SUCCESS );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003001
3002bad_state:
3003 /* If abort is called on an uninitialized object, we can't trust
3004 * anything. Wipe the object in case it contains confidential data.
3005 * This may result in a memory leak if a pointer gets overwritten,
3006 * but it's too late to do anything about this. */
3007 memset( operation, 0, sizeof( *operation ) );
3008 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003009}
3010
Gilles Peskinee3b07d82018-06-19 11:57:35 +02003011#if defined(MBEDTLS_CMAC_C)
Gilles Peskine89167cb2018-07-08 20:12:23 +02003012static int psa_cmac_setup( psa_mac_operation_t *operation,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003013 size_t key_bits,
Gilles Peskine2f060a82018-12-04 17:12:32 +01003014 psa_key_slot_t *slot,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003015 const mbedtls_cipher_info_t *cipher_info )
3016{
Janos Follath24eed8d2019-11-22 13:21:35 +00003017 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003018
3019 operation->mac_size = cipher_info->block_size;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003020
3021 ret = mbedtls_cipher_setup( &operation->ctx.cmac, cipher_info );
3022 if( ret != 0 )
3023 return( ret );
3024
3025 ret = mbedtls_cipher_cmac_starts( &operation->ctx.cmac,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02003026 slot->data.key.data,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003027 key_bits );
3028 return( ret );
3029}
Gilles Peskinee3b07d82018-06-19 11:57:35 +02003030#endif /* MBEDTLS_CMAC_C */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003031
Gilles Peskine248051a2018-06-20 16:09:38 +02003032#if defined(MBEDTLS_MD_C)
Gilles Peskine01126fa2018-07-12 17:04:55 +02003033static psa_status_t psa_hmac_setup_internal( psa_hmac_internal_data *hmac,
3034 const uint8_t *key,
3035 size_t key_length,
3036 psa_algorithm_t hash_alg )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003037{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02003038 uint8_t ipad[PSA_HMAC_MAX_HASH_BLOCK_SIZE];
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003039 size_t i;
Gilles Peskine9aa369e2018-07-16 00:36:29 +02003040 size_t hash_size = PSA_HASH_SIZE( hash_alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003041 size_t block_size = psa_get_hash_block_size( hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003042 psa_status_t status;
3043
Gilles Peskine9aa369e2018-07-16 00:36:29 +02003044 /* Sanity checks on block_size, to guarantee that there won't be a buffer
3045 * overflow below. This should never trigger if the hash algorithm
3046 * is implemented correctly. */
3047 /* The size checks against the ipad and opad buffers cannot be written
3048 * `block_size > sizeof( ipad ) || block_size > sizeof( hmac->opad )`
3049 * because that triggers -Wlogical-op on GCC 7.3. */
3050 if( block_size > sizeof( ipad ) )
3051 return( PSA_ERROR_NOT_SUPPORTED );
3052 if( block_size > sizeof( hmac->opad ) )
3053 return( PSA_ERROR_NOT_SUPPORTED );
3054 if( block_size < hash_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003055 return( PSA_ERROR_NOT_SUPPORTED );
3056
Gilles Peskined223b522018-06-11 18:12:58 +02003057 if( key_length > block_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003058 {
Gilles Peskine84b8fc82019-11-28 20:07:20 +01003059 status = psa_hash_compute( hash_alg, key, key_length,
3060 ipad, sizeof( ipad ), &key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003061 if( status != PSA_SUCCESS )
Gilles Peskineb8be2882018-07-17 16:24:34 +02003062 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003063 }
Gilles Peskine96889972018-07-12 17:07:03 +02003064 /* A 0-length key is not commonly used in HMAC when used as a MAC,
3065 * but it is permitted. It is common when HMAC is used in HKDF, for
3066 * example. Don't call `memcpy` in the 0-length because `key` could be
3067 * an invalid pointer which would make the behavior undefined. */
3068 else if( key_length != 0 )
Gilles Peskine01126fa2018-07-12 17:04:55 +02003069 memcpy( ipad, key, key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003070
Gilles Peskined223b522018-06-11 18:12:58 +02003071 /* ipad contains the key followed by garbage. Xor and fill with 0x36
3072 * to create the ipad value. */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003073 for( i = 0; i < key_length; i++ )
Gilles Peskined223b522018-06-11 18:12:58 +02003074 ipad[i] ^= 0x36;
3075 memset( ipad + key_length, 0x36, block_size - key_length );
3076
3077 /* Copy the key material from ipad to opad, flipping the requisite bits,
3078 * and filling the rest of opad with the requisite constant. */
3079 for( i = 0; i < key_length; i++ )
Gilles Peskine01126fa2018-07-12 17:04:55 +02003080 hmac->opad[i] = ipad[i] ^ 0x36 ^ 0x5C;
3081 memset( hmac->opad + key_length, 0x5C, block_size - key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003082
Gilles Peskine01126fa2018-07-12 17:04:55 +02003083 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003084 if( status != PSA_SUCCESS )
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003085 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003086
Gilles Peskine01126fa2018-07-12 17:04:55 +02003087 status = psa_hash_update( &hmac->hash_ctx, ipad, block_size );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003088
3089cleanup:
Steven Cooreman29149862020-08-05 15:43:42 +02003090 mbedtls_platform_zeroize( ipad, sizeof( ipad ) );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003091
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003092 return( status );
3093}
Gilles Peskine248051a2018-06-20 16:09:38 +02003094#endif /* MBEDTLS_MD_C */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003095
Gilles Peskine89167cb2018-07-08 20:12:23 +02003096static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003097 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02003098 psa_algorithm_t alg,
3099 int is_sign )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003100{
Gilles Peskine8c9def32018-02-08 10:02:12 +01003101 psa_status_t status;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003102 psa_key_slot_t *slot;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003103 size_t key_bits;
Gilles Peskine89167cb2018-07-08 20:12:23 +02003104 psa_key_usage_t usage =
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003105 is_sign ? PSA_KEY_USAGE_SIGN_HASH : PSA_KEY_USAGE_VERIFY_HASH;
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02003106 uint8_t truncated = PSA_MAC_TRUNCATED_LENGTH( alg );
Gilles Peskinee0e9c7c2018-10-17 18:28:05 +02003107 psa_algorithm_t full_length_alg = PSA_ALG_FULL_LENGTH_MAC( alg );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003108
Jaeden Amero36ee5d02019-02-19 09:25:10 +00003109 /* A context must be freshly initialized before it can be set up. */
3110 if( operation->alg != 0 )
3111 {
3112 return( PSA_ERROR_BAD_STATE );
3113 }
3114
Gilles Peskined911eb72018-08-14 15:18:45 +02003115 status = psa_mac_init( operation, full_length_alg );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003116 if( status != PSA_SUCCESS )
3117 return( status );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003118 if( is_sign )
3119 operation->is_sign = 1;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003120
Ronald Croncf56a0a2020-08-04 09:51:30 +02003121 status = psa_get_transparent_key( key, &slot, usage, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003122 if( status != PSA_SUCCESS )
Gilles Peskinefbfac682018-07-08 20:51:54 +02003123 goto exit;
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02003124 key_bits = psa_get_key_slot_bits( slot );
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02003125
Gilles Peskine8c9def32018-02-08 10:02:12 +01003126#if defined(MBEDTLS_CMAC_C)
Gilles Peskined911eb72018-08-14 15:18:45 +02003127 if( full_length_alg == PSA_ALG_CMAC )
Gilles Peskinefbfac682018-07-08 20:51:54 +02003128 {
3129 const mbedtls_cipher_info_t *cipher_info =
Gilles Peskined911eb72018-08-14 15:18:45 +02003130 mbedtls_cipher_info_from_psa( full_length_alg,
Gilles Peskine8e338702019-07-30 20:06:31 +02003131 slot->attr.type, key_bits, NULL );
Janos Follath24eed8d2019-11-22 13:21:35 +00003132 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinefbfac682018-07-08 20:51:54 +02003133 if( cipher_info == NULL )
3134 {
3135 status = PSA_ERROR_NOT_SUPPORTED;
3136 goto exit;
3137 }
3138 operation->mac_size = cipher_info->block_size;
3139 ret = psa_cmac_setup( operation, key_bits, slot, cipher_info );
3140 status = mbedtls_to_psa_error( ret );
3141 }
3142 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01003143#endif /* MBEDTLS_CMAC_C */
Gilles Peskine8c9def32018-02-08 10:02:12 +01003144#if defined(MBEDTLS_MD_C)
Gilles Peskined911eb72018-08-14 15:18:45 +02003145 if( PSA_ALG_IS_HMAC( full_length_alg ) )
Gilles Peskinefbfac682018-07-08 20:51:54 +02003146 {
Gilles Peskine00709fa2018-08-22 18:25:41 +02003147 psa_algorithm_t hash_alg = PSA_ALG_HMAC_GET_HASH( alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003148 if( hash_alg == 0 )
3149 {
3150 status = PSA_ERROR_NOT_SUPPORTED;
3151 goto exit;
3152 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02003153
3154 operation->mac_size = PSA_HASH_SIZE( hash_alg );
3155 /* Sanity check. This shouldn't fail on a valid configuration. */
3156 if( operation->mac_size == 0 ||
3157 operation->mac_size > sizeof( operation->ctx.hmac.opad ) )
3158 {
3159 status = PSA_ERROR_NOT_SUPPORTED;
3160 goto exit;
3161 }
3162
Gilles Peskine8e338702019-07-30 20:06:31 +02003163 if( slot->attr.type != PSA_KEY_TYPE_HMAC )
Gilles Peskine01126fa2018-07-12 17:04:55 +02003164 {
3165 status = PSA_ERROR_INVALID_ARGUMENT;
3166 goto exit;
3167 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02003168
Gilles Peskine01126fa2018-07-12 17:04:55 +02003169 status = psa_hmac_setup_internal( &operation->ctx.hmac,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02003170 slot->data.key.data,
3171 slot->data.key.bytes,
Gilles Peskine01126fa2018-07-12 17:04:55 +02003172 hash_alg );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003173 }
3174 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01003175#endif /* MBEDTLS_MD_C */
Gilles Peskinefbfac682018-07-08 20:51:54 +02003176 {
Jaeden Amero82df32e2018-11-23 15:11:20 +00003177 (void) key_bits;
Gilles Peskinefbfac682018-07-08 20:51:54 +02003178 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003179 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003180
Gilles Peskined911eb72018-08-14 15:18:45 +02003181 if( truncated == 0 )
3182 {
3183 /* The "normal" case: untruncated algorithm. Nothing to do. */
3184 }
3185 else if( truncated < 4 )
3186 {
Gilles Peskine6d72ff92018-08-21 14:55:08 +02003187 /* A very short MAC is too short for security since it can be
3188 * brute-forced. Ancient protocols with 32-bit MACs do exist,
3189 * so we make this our minimum, even though 32 bits is still
3190 * too small for security. */
Gilles Peskined911eb72018-08-14 15:18:45 +02003191 status = PSA_ERROR_NOT_SUPPORTED;
3192 }
3193 else if( truncated > operation->mac_size )
3194 {
3195 /* It's impossible to "truncate" to a larger length. */
3196 status = PSA_ERROR_INVALID_ARGUMENT;
3197 }
3198 else
3199 operation->mac_size = truncated;
3200
Gilles Peskinefbfac682018-07-08 20:51:54 +02003201exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003202 if( status != PSA_SUCCESS )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003203 {
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003204 psa_mac_abort( operation );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003205 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003206 else
3207 {
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003208 operation->key_set = 1;
3209 }
3210 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003211}
3212
Gilles Peskine89167cb2018-07-08 20:12:23 +02003213psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003214 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02003215 psa_algorithm_t alg )
3216{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003217 return( psa_mac_setup( operation, key, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003218}
3219
3220psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003221 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02003222 psa_algorithm_t alg )
3223{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003224 return( psa_mac_setup( operation, key, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003225}
3226
Gilles Peskine8c9def32018-02-08 10:02:12 +01003227psa_status_t psa_mac_update( psa_mac_operation_t *operation,
3228 const uint8_t *input,
3229 size_t input_length )
3230{
Gilles Peskinefbfac682018-07-08 20:51:54 +02003231 psa_status_t status = PSA_ERROR_BAD_STATE;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003232 if( ! operation->key_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003233 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003234 if( operation->iv_required && ! operation->iv_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003235 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003236 operation->has_input = 1;
3237
Gilles Peskine8c9def32018-02-08 10:02:12 +01003238#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003239 if( operation->alg == PSA_ALG_CMAC )
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03003240 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02003241 int ret = mbedtls_cipher_cmac_update( &operation->ctx.cmac,
3242 input, input_length );
3243 status = mbedtls_to_psa_error( ret );
3244 }
3245 else
3246#endif /* MBEDTLS_CMAC_C */
3247#if defined(MBEDTLS_MD_C)
3248 if( PSA_ALG_IS_HMAC( operation->alg ) )
3249 {
3250 status = psa_hash_update( &operation->ctx.hmac.hash_ctx, input,
3251 input_length );
3252 }
3253 else
3254#endif /* MBEDTLS_MD_C */
3255 {
3256 /* This shouldn't happen if `operation` was initialized by
3257 * a setup function. */
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003258 return( PSA_ERROR_BAD_STATE );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03003259 }
3260
Gilles Peskinefbfac682018-07-08 20:51:54 +02003261 if( status != PSA_SUCCESS )
3262 psa_mac_abort( operation );
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02003263 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003264}
3265
Gilles Peskine01126fa2018-07-12 17:04:55 +02003266#if defined(MBEDTLS_MD_C)
3267static psa_status_t psa_hmac_finish_internal( psa_hmac_internal_data *hmac,
3268 uint8_t *mac,
3269 size_t mac_size )
3270{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02003271 uint8_t tmp[MBEDTLS_MD_MAX_SIZE];
Gilles Peskine01126fa2018-07-12 17:04:55 +02003272 psa_algorithm_t hash_alg = hmac->hash_ctx.alg;
3273 size_t hash_size = 0;
3274 size_t block_size = psa_get_hash_block_size( hash_alg );
3275 psa_status_t status;
3276
Gilles Peskine01126fa2018-07-12 17:04:55 +02003277 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
3278 if( status != PSA_SUCCESS )
3279 return( status );
3280 /* From here on, tmp needs to be wiped. */
3281
3282 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
3283 if( status != PSA_SUCCESS )
3284 goto exit;
3285
3286 status = psa_hash_update( &hmac->hash_ctx, hmac->opad, block_size );
3287 if( status != PSA_SUCCESS )
3288 goto exit;
3289
3290 status = psa_hash_update( &hmac->hash_ctx, tmp, hash_size );
3291 if( status != PSA_SUCCESS )
3292 goto exit;
3293
Gilles Peskined911eb72018-08-14 15:18:45 +02003294 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
3295 if( status != PSA_SUCCESS )
3296 goto exit;
3297
3298 memcpy( mac, tmp, mac_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003299
3300exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01003301 mbedtls_platform_zeroize( tmp, hash_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003302 return( status );
3303}
3304#endif /* MBEDTLS_MD_C */
3305
mohammad16036df908f2018-04-02 08:34:15 -07003306static psa_status_t psa_mac_finish_internal( psa_mac_operation_t *operation,
Gilles Peskine2d277862018-06-18 15:41:12 +02003307 uint8_t *mac,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003308 size_t mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003309{
Gilles Peskine1d96fff2018-07-02 12:15:39 +02003310 if( ! operation->key_set )
3311 return( PSA_ERROR_BAD_STATE );
3312 if( operation->iv_required && ! operation->iv_set )
3313 return( PSA_ERROR_BAD_STATE );
3314
Gilles Peskine8c9def32018-02-08 10:02:12 +01003315 if( mac_size < operation->mac_size )
3316 return( PSA_ERROR_BUFFER_TOO_SMALL );
3317
Gilles Peskine8c9def32018-02-08 10:02:12 +01003318#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003319 if( operation->alg == PSA_ALG_CMAC )
3320 {
Gilles Peskined911eb72018-08-14 15:18:45 +02003321 uint8_t tmp[PSA_MAX_BLOCK_CIPHER_BLOCK_SIZE];
3322 int ret = mbedtls_cipher_cmac_finish( &operation->ctx.cmac, tmp );
3323 if( ret == 0 )
Gilles Peskine87b0ac42018-08-21 14:55:49 +02003324 memcpy( mac, tmp, operation->mac_size );
Gilles Peskine3f108122018-12-07 18:14:53 +01003325 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003326 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003327 }
Gilles Peskinefbfac682018-07-08 20:51:54 +02003328 else
3329#endif /* MBEDTLS_CMAC_C */
3330#if defined(MBEDTLS_MD_C)
3331 if( PSA_ALG_IS_HMAC( operation->alg ) )
3332 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02003333 return( psa_hmac_finish_internal( &operation->ctx.hmac,
Gilles Peskined911eb72018-08-14 15:18:45 +02003334 mac, operation->mac_size ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003335 }
3336 else
3337#endif /* MBEDTLS_MD_C */
3338 {
3339 /* This shouldn't happen if `operation` was initialized by
3340 * a setup function. */
3341 return( PSA_ERROR_BAD_STATE );
3342 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01003343}
3344
Gilles Peskineacd4be32018-07-08 19:56:25 +02003345psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
3346 uint8_t *mac,
3347 size_t mac_size,
3348 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07003349{
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003350 psa_status_t status;
3351
Jaeden Amero252ef282019-02-15 14:05:35 +00003352 if( operation->alg == 0 )
3353 {
3354 return( PSA_ERROR_BAD_STATE );
3355 }
3356
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003357 /* Fill the output buffer with something that isn't a valid mac
3358 * (barring an attack on the mac and deliberately-crafted input),
3359 * in case the caller doesn't check the return status properly. */
3360 *mac_length = mac_size;
3361 /* If mac_size is 0 then mac may be NULL and then the
3362 * call to memset would have undefined behavior. */
3363 if( mac_size != 0 )
3364 memset( mac, '!', mac_size );
3365
Gilles Peskine89167cb2018-07-08 20:12:23 +02003366 if( ! operation->is_sign )
3367 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003368 return( PSA_ERROR_BAD_STATE );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003369 }
mohammad16036df908f2018-04-02 08:34:15 -07003370
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003371 status = psa_mac_finish_internal( operation, mac, mac_size );
3372
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003373 if( status == PSA_SUCCESS )
3374 {
3375 status = psa_mac_abort( operation );
3376 if( status == PSA_SUCCESS )
3377 *mac_length = operation->mac_size;
3378 else
3379 memset( mac, '!', mac_size );
3380 }
3381 else
3382 psa_mac_abort( operation );
3383 return( status );
mohammad16036df908f2018-04-02 08:34:15 -07003384}
3385
Gilles Peskineacd4be32018-07-08 19:56:25 +02003386psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
3387 const uint8_t *mac,
3388 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003389{
Gilles Peskine828ed142018-06-18 23:25:51 +02003390 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
mohammad16036df908f2018-04-02 08:34:15 -07003391 psa_status_t status;
3392
Jaeden Amero252ef282019-02-15 14:05:35 +00003393 if( operation->alg == 0 )
3394 {
3395 return( PSA_ERROR_BAD_STATE );
3396 }
3397
Gilles Peskine89167cb2018-07-08 20:12:23 +02003398 if( operation->is_sign )
3399 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003400 return( PSA_ERROR_BAD_STATE );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003401 }
3402 if( operation->mac_size != mac_length )
3403 {
3404 status = PSA_ERROR_INVALID_SIGNATURE;
3405 goto cleanup;
Gilles Peskine89167cb2018-07-08 20:12:23 +02003406 }
mohammad16036df908f2018-04-02 08:34:15 -07003407
3408 status = psa_mac_finish_internal( operation,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003409 actual_mac, sizeof( actual_mac ) );
Gilles Peskine28cd4162020-01-20 16:31:06 +01003410 if( status != PSA_SUCCESS )
3411 goto cleanup;
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003412
3413 if( safer_memcmp( mac, actual_mac, mac_length ) != 0 )
3414 status = PSA_ERROR_INVALID_SIGNATURE;
3415
3416cleanup:
3417 if( status == PSA_SUCCESS )
3418 status = psa_mac_abort( operation );
3419 else
3420 psa_mac_abort( operation );
3421
Gilles Peskine3f108122018-12-07 18:14:53 +01003422 mbedtls_platform_zeroize( actual_mac, sizeof( actual_mac ) );
Gilles Peskined911eb72018-08-14 15:18:45 +02003423
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003424 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003425}
3426
3427
Gilles Peskine20035e32018-02-03 22:44:14 +01003428
Gilles Peskine20035e32018-02-03 22:44:14 +01003429/****************************************************************/
3430/* Asymmetric cryptography */
3431/****************************************************************/
3432
Gilles Peskine2b450e32018-06-27 15:42:46 +02003433#if defined(MBEDTLS_RSA_C)
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02003434/* Decode the hash algorithm from alg and store the mbedtls encoding in
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003435 * md_alg. Verify that the hash length is acceptable. */
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02003436static psa_status_t psa_rsa_decode_md_type( psa_algorithm_t alg,
3437 size_t hash_length,
3438 mbedtls_md_type_t *md_alg )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003439{
Gilles Peskine7ed29c52018-06-26 15:50:08 +02003440 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003441 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003442 *md_alg = mbedtls_md_get_type( md_info );
3443
3444 /* The Mbed TLS RSA module uses an unsigned int for hash length
3445 * parameters. Validate that it fits so that we don't risk an
3446 * overflow later. */
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003447#if SIZE_MAX > UINT_MAX
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003448 if( hash_length > UINT_MAX )
3449 return( PSA_ERROR_INVALID_ARGUMENT );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003450#endif
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003451
3452#if defined(MBEDTLS_PKCS1_V15)
3453 /* For PKCS#1 v1.5 signature, if using a hash, the hash length
3454 * must be correct. */
3455 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) &&
3456 alg != PSA_ALG_RSA_PKCS1V15_SIGN_RAW )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003457 {
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003458 if( md_info == NULL )
3459 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003460 if( mbedtls_md_get_size( md_info ) != hash_length )
3461 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003462 }
3463#endif /* MBEDTLS_PKCS1_V15 */
3464
3465#if defined(MBEDTLS_PKCS1_V21)
3466 /* PSS requires a hash internally. */
3467 if( PSA_ALG_IS_RSA_PSS( alg ) )
3468 {
Gilles Peskine61b91d42018-06-08 16:09:36 +02003469 if( md_info == NULL )
3470 return( PSA_ERROR_NOT_SUPPORTED );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003471 }
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003472#endif /* MBEDTLS_PKCS1_V21 */
3473
Gilles Peskine61b91d42018-06-08 16:09:36 +02003474 return( PSA_SUCCESS );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003475}
3476
Gilles Peskine2b450e32018-06-27 15:42:46 +02003477static psa_status_t psa_rsa_sign( mbedtls_rsa_context *rsa,
3478 psa_algorithm_t alg,
3479 const uint8_t *hash,
3480 size_t hash_length,
3481 uint8_t *signature,
3482 size_t signature_size,
3483 size_t *signature_length )
3484{
3485 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00003486 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003487 mbedtls_md_type_t md_alg;
3488
3489 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
3490 if( status != PSA_SUCCESS )
3491 return( status );
3492
Gilles Peskine630a18a2018-06-29 17:49:35 +02003493 if( signature_size < mbedtls_rsa_get_len( rsa ) )
Gilles Peskine2b450e32018-06-27 15:42:46 +02003494 return( PSA_ERROR_BUFFER_TOO_SMALL );
3495
3496#if defined(MBEDTLS_PKCS1_V15)
3497 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
3498 {
3499 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
3500 MBEDTLS_MD_NONE );
3501 ret = mbedtls_rsa_pkcs1_sign( rsa,
3502 mbedtls_ctr_drbg_random,
3503 &global_data.ctr_drbg,
3504 MBEDTLS_RSA_PRIVATE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003505 md_alg,
3506 (unsigned int) hash_length,
3507 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003508 signature );
3509 }
3510 else
3511#endif /* MBEDTLS_PKCS1_V15 */
3512#if defined(MBEDTLS_PKCS1_V21)
3513 if( PSA_ALG_IS_RSA_PSS( alg ) )
3514 {
3515 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3516 ret = mbedtls_rsa_rsassa_pss_sign( rsa,
3517 mbedtls_ctr_drbg_random,
3518 &global_data.ctr_drbg,
3519 MBEDTLS_RSA_PRIVATE,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003520 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003521 (unsigned int) hash_length,
3522 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003523 signature );
3524 }
3525 else
3526#endif /* MBEDTLS_PKCS1_V21 */
3527 {
3528 return( PSA_ERROR_INVALID_ARGUMENT );
3529 }
3530
3531 if( ret == 0 )
Gilles Peskine630a18a2018-06-29 17:49:35 +02003532 *signature_length = mbedtls_rsa_get_len( rsa );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003533 return( mbedtls_to_psa_error( ret ) );
3534}
3535
3536static psa_status_t psa_rsa_verify( mbedtls_rsa_context *rsa,
3537 psa_algorithm_t alg,
3538 const uint8_t *hash,
3539 size_t hash_length,
3540 const uint8_t *signature,
3541 size_t signature_length )
3542{
3543 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00003544 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003545 mbedtls_md_type_t md_alg;
3546
3547 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
3548 if( status != PSA_SUCCESS )
3549 return( status );
3550
Gilles Peskine89cc74f2019-09-12 22:08:23 +02003551 if( signature_length != mbedtls_rsa_get_len( rsa ) )
3552 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003553
3554#if defined(MBEDTLS_PKCS1_V15)
3555 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
3556 {
3557 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
3558 MBEDTLS_MD_NONE );
3559 ret = mbedtls_rsa_pkcs1_verify( rsa,
3560 mbedtls_ctr_drbg_random,
3561 &global_data.ctr_drbg,
3562 MBEDTLS_RSA_PUBLIC,
3563 md_alg,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003564 (unsigned int) hash_length,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003565 hash,
3566 signature );
3567 }
3568 else
3569#endif /* MBEDTLS_PKCS1_V15 */
3570#if defined(MBEDTLS_PKCS1_V21)
3571 if( PSA_ALG_IS_RSA_PSS( alg ) )
3572 {
3573 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3574 ret = mbedtls_rsa_rsassa_pss_verify( rsa,
3575 mbedtls_ctr_drbg_random,
3576 &global_data.ctr_drbg,
3577 MBEDTLS_RSA_PUBLIC,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003578 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003579 (unsigned int) hash_length,
3580 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003581 signature );
3582 }
3583 else
3584#endif /* MBEDTLS_PKCS1_V21 */
3585 {
3586 return( PSA_ERROR_INVALID_ARGUMENT );
3587 }
Gilles Peskineef12c632018-09-13 20:37:48 +02003588
3589 /* Mbed TLS distinguishes "invalid padding" from "valid padding but
3590 * the rest of the signature is invalid". This has little use in
3591 * practice and PSA doesn't report this distinction. */
3592 if( ret == MBEDTLS_ERR_RSA_INVALID_PADDING )
3593 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003594 return( mbedtls_to_psa_error( ret ) );
3595}
3596#endif /* MBEDTLS_RSA_C */
3597
John Durkopf87e3ae2020-10-26 15:25:23 -07003598#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003599/* `ecp` cannot be const because `ecp->grp` needs to be non-const
3600 * for mbedtls_ecdsa_sign() and mbedtls_ecdsa_sign_det()
3601 * (even though these functions don't modify it). */
3602static psa_status_t psa_ecdsa_sign( mbedtls_ecp_keypair *ecp,
3603 psa_algorithm_t alg,
3604 const uint8_t *hash,
3605 size_t hash_length,
3606 uint8_t *signature,
3607 size_t signature_size,
3608 size_t *signature_length )
3609{
Janos Follath24eed8d2019-11-22 13:21:35 +00003610 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003611 mbedtls_mpi r, s;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003612 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003613 mbedtls_mpi_init( &r );
3614 mbedtls_mpi_init( &s );
3615
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003616 if( signature_size < 2 * curve_bytes )
3617 {
3618 ret = MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL;
3619 goto cleanup;
3620 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003621
John Durkop0ea39e02020-10-13 19:58:20 -07003622#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003623 if( PSA_ALG_DSA_IS_DETERMINISTIC( alg ) )
3624 {
3625 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
3626 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3627 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
Darryl Green5e843fa2019-09-05 14:06:34 +01003628 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign_det_ext( &ecp->grp, &r, &s,
3629 &ecp->d, hash,
3630 hash_length, md_alg,
3631 mbedtls_ctr_drbg_random,
3632 &global_data.ctr_drbg ) );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003633 }
3634 else
John Durkop0ea39e02020-10-13 19:58:20 -07003635#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003636 {
Gilles Peskinea05219c2018-11-16 16:02:56 +01003637 (void) alg;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003638 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign( &ecp->grp, &r, &s, &ecp->d,
3639 hash, hash_length,
3640 mbedtls_ctr_drbg_random,
3641 &global_data.ctr_drbg ) );
3642 }
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003643
3644 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &r,
3645 signature,
3646 curve_bytes ) );
3647 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &s,
3648 signature + curve_bytes,
3649 curve_bytes ) );
3650
3651cleanup:
3652 mbedtls_mpi_free( &r );
3653 mbedtls_mpi_free( &s );
3654 if( ret == 0 )
3655 *signature_length = 2 * curve_bytes;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003656 return( mbedtls_to_psa_error( ret ) );
3657}
3658
3659static psa_status_t psa_ecdsa_verify( mbedtls_ecp_keypair *ecp,
3660 const uint8_t *hash,
3661 size_t hash_length,
3662 const uint8_t *signature,
3663 size_t signature_length )
3664{
Janos Follath24eed8d2019-11-22 13:21:35 +00003665 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003666 mbedtls_mpi r, s;
3667 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
3668 mbedtls_mpi_init( &r );
3669 mbedtls_mpi_init( &s );
3670
3671 if( signature_length != 2 * curve_bytes )
3672 return( PSA_ERROR_INVALID_SIGNATURE );
3673
3674 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &r,
3675 signature,
3676 curve_bytes ) );
3677 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &s,
3678 signature + curve_bytes,
3679 curve_bytes ) );
3680
Steven Cooremanacda8342020-07-24 23:09:52 +02003681 /* Check whether the public part is loaded. If not, load it. */
3682 if( mbedtls_ecp_is_zero( &ecp->Q ) )
3683 {
3684 MBEDTLS_MPI_CHK(
3685 mbedtls_ecp_mul( &ecp->grp, &ecp->Q, &ecp->d, &ecp->grp.G,
3686 mbedtls_ctr_drbg_random, &global_data.ctr_drbg ) );
3687 }
3688
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003689 ret = mbedtls_ecdsa_verify( &ecp->grp, hash, hash_length,
3690 &ecp->Q, &r, &s );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003691
3692cleanup:
3693 mbedtls_mpi_free( &r );
3694 mbedtls_mpi_free( &s );
3695 return( mbedtls_to_psa_error( ret ) );
3696}
John Durkopf87e3ae2020-10-26 15:25:23 -07003697#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003698
Ronald Croncf56a0a2020-08-04 09:51:30 +02003699psa_status_t psa_sign_hash( mbedtls_svc_key_id_t key,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003700 psa_algorithm_t alg,
3701 const uint8_t *hash,
3702 size_t hash_length,
3703 uint8_t *signature,
3704 size_t signature_size,
3705 size_t *signature_length )
Gilles Peskine20035e32018-02-03 22:44:14 +01003706{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003707 psa_key_slot_t *slot;
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003708 psa_status_t status;
3709
3710 *signature_length = signature_size;
Gilles Peskine4019f0e2019-09-12 22:05:59 +02003711 /* Immediately reject a zero-length signature buffer. This guarantees
3712 * that signature must be a valid pointer. (On the other hand, the hash
3713 * buffer can in principle be empty since it doesn't actually have
3714 * to be a hash.) */
3715 if( signature_size == 0 )
3716 return( PSA_ERROR_BUFFER_TOO_SMALL );
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003717
Ronald Croncf56a0a2020-08-04 09:51:30 +02003718 status = psa_get_key_from_slot( key, &slot, PSA_KEY_USAGE_SIGN_HASH, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003719 if( status != PSA_SUCCESS )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003720 goto exit;
Gilles Peskine8e338702019-07-30 20:06:31 +02003721 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003722 {
3723 status = PSA_ERROR_INVALID_ARGUMENT;
3724 goto exit;
3725 }
Gilles Peskine20035e32018-02-03 22:44:14 +01003726
Steven Cooremancd84cb42020-07-16 20:28:36 +02003727 /* Try any of the available accelerators first */
3728 status = psa_driver_wrapper_sign_hash( slot,
3729 alg,
3730 hash,
3731 hash_length,
3732 signature,
3733 signature_size,
3734 signature_length );
Steven Cooreman8d2bde72020-09-04 13:06:39 +02003735 if( status != PSA_ERROR_NOT_SUPPORTED ||
3736 psa_key_lifetime_is_external( slot->attr.lifetime ) )
Steven Cooremancd84cb42020-07-16 20:28:36 +02003737 goto exit;
3738
Steven Cooreman7a250572020-07-17 16:43:05 +02003739 /* If the operation was not supported by any accelerator, try fallback. */
Gilles Peskine20035e32018-02-03 22:44:14 +01003740#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003741 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskine20035e32018-02-03 22:44:14 +01003742 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003743 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02003744
Steven Cooreman4fed4552020-08-03 14:46:03 +02003745 status = psa_load_rsa_representation( slot->attr.type,
3746 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02003747 slot->data.key.bytes,
Steven Cooremana01795d2020-07-24 22:48:15 +02003748 &rsa );
3749 if( status != PSA_SUCCESS )
3750 goto exit;
3751
Steven Cooremana2371e52020-07-28 14:30:39 +02003752 status = psa_rsa_sign( rsa,
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003753 alg,
3754 hash, hash_length,
3755 signature, signature_size,
3756 signature_length );
Steven Cooremana01795d2020-07-24 22:48:15 +02003757
Steven Cooremana2371e52020-07-28 14:30:39 +02003758 mbedtls_rsa_free( rsa );
3759 mbedtls_free( rsa );
Gilles Peskine20035e32018-02-03 22:44:14 +01003760 }
3761 else
3762#endif /* defined(MBEDTLS_RSA_C) */
3763#if defined(MBEDTLS_ECP_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003764 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
Gilles Peskine20035e32018-02-03 22:44:14 +01003765 {
John Durkop0ea39e02020-10-13 19:58:20 -07003766#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA)
Gilles Peskinea05219c2018-11-16 16:02:56 +01003767 if(
John Durkop0ea39e02020-10-13 19:58:20 -07003768#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea05219c2018-11-16 16:02:56 +01003769 PSA_ALG_IS_ECDSA( alg )
3770#else
3771 PSA_ALG_IS_RANDOMIZED_ECDSA( alg )
3772#endif
3773 )
Steven Cooremanacda8342020-07-24 23:09:52 +02003774 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003775 mbedtls_ecp_keypair *ecp = NULL;
Steven Cooreman4fed4552020-08-03 14:46:03 +02003776 status = psa_load_ecp_representation( slot->attr.type,
3777 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02003778 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02003779 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003780 if( status != PSA_SUCCESS )
3781 goto exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003782 status = psa_ecdsa_sign( ecp,
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003783 alg,
3784 hash, hash_length,
3785 signature, signature_size,
3786 signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02003787 mbedtls_ecp_keypair_free( ecp );
3788 mbedtls_free( ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003789 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003790 else
John Durkop0ea39e02020-10-13 19:58:20 -07003791#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003792 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003793 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003794 }
itayzafrir5c753392018-05-08 11:18:38 +03003795 }
3796 else
3797#endif /* defined(MBEDTLS_ECP_C) */
3798 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003799 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine20035e32018-02-03 22:44:14 +01003800 }
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003801
3802exit:
3803 /* Fill the unused part of the output buffer (the whole buffer on error,
3804 * the trailing part on success) with something that isn't a valid mac
3805 * (barring an attack on the mac and deliberately-crafted input),
3806 * in case the caller doesn't check the return status properly. */
3807 if( status == PSA_SUCCESS )
3808 memset( signature + *signature_length, '!',
3809 signature_size - *signature_length );
Gilles Peskine4019f0e2019-09-12 22:05:59 +02003810 else
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003811 memset( signature, '!', signature_size );
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003812 /* If signature_size is 0 then we have nothing to do. We must not call
3813 * memset because signature may be NULL in this case. */
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003814 return( status );
itayzafrir5c753392018-05-08 11:18:38 +03003815}
3816
Ronald Croncf56a0a2020-08-04 09:51:30 +02003817psa_status_t psa_verify_hash( mbedtls_svc_key_id_t key,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003818 psa_algorithm_t alg,
3819 const uint8_t *hash,
3820 size_t hash_length,
3821 const uint8_t *signature,
3822 size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03003823{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003824 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003825 psa_status_t status;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003826
Ronald Croncf56a0a2020-08-04 09:51:30 +02003827 status = psa_get_key_from_slot( key, &slot,
3828 PSA_KEY_USAGE_VERIFY_HASH, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003829 if( status != PSA_SUCCESS )
3830 return( status );
itayzafrir5c753392018-05-08 11:18:38 +03003831
Steven Cooreman55ae2172020-07-17 19:46:15 +02003832 /* Try any of the available accelerators first */
3833 status = psa_driver_wrapper_verify_hash( slot,
3834 alg,
3835 hash,
3836 hash_length,
3837 signature,
3838 signature_length );
Steven Cooreman8d2bde72020-09-04 13:06:39 +02003839 if( status != PSA_ERROR_NOT_SUPPORTED ||
3840 psa_key_lifetime_is_external( slot->attr.lifetime ) )
Steven Cooreman55ae2172020-07-17 19:46:15 +02003841 return status;
3842
Gilles Peskine61b91d42018-06-08 16:09:36 +02003843#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003844 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003845 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003846 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02003847
Steven Cooreman4fed4552020-08-03 14:46:03 +02003848 status = psa_load_rsa_representation( slot->attr.type,
3849 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02003850 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02003851 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003852 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02003853 return( status );
Steven Cooremana01795d2020-07-24 22:48:15 +02003854
Steven Cooremana2371e52020-07-28 14:30:39 +02003855 status = psa_rsa_verify( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02003856 alg,
3857 hash, hash_length,
3858 signature, signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02003859 mbedtls_rsa_free( rsa );
3860 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003861 return( status );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003862 }
3863 else
3864#endif /* defined(MBEDTLS_RSA_C) */
itayzafrir5c753392018-05-08 11:18:38 +03003865#if defined(MBEDTLS_ECP_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003866 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
itayzafrir5c753392018-05-08 11:18:38 +03003867 {
John Durkopf87e3ae2020-10-26 15:25:23 -07003868#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003869 if( PSA_ALG_IS_ECDSA( alg ) )
Steven Cooremanacda8342020-07-24 23:09:52 +02003870 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003871 mbedtls_ecp_keypair *ecp = NULL;
Steven Cooreman4fed4552020-08-03 14:46:03 +02003872 status = psa_load_ecp_representation( slot->attr.type,
3873 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02003874 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02003875 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003876 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02003877 return( status );
Steven Cooremana2371e52020-07-28 14:30:39 +02003878 status = psa_ecdsa_verify( ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02003879 hash, hash_length,
3880 signature, signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02003881 mbedtls_ecp_keypair_free( ecp );
3882 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02003883 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02003884 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003885 else
John Durkopf87e3ae2020-10-26 15:25:23 -07003886#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003887 {
3888 return( PSA_ERROR_INVALID_ARGUMENT );
3889 }
itayzafrir5c753392018-05-08 11:18:38 +03003890 }
Gilles Peskine20035e32018-02-03 22:44:14 +01003891 else
3892#endif /* defined(MBEDTLS_ECP_C) */
3893 {
3894 return( PSA_ERROR_NOT_SUPPORTED );
3895 }
3896}
3897
Gilles Peskine072ac562018-06-30 00:21:29 +02003898#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PKCS1_V21)
3899static void psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
3900 mbedtls_rsa_context *rsa )
3901{
3902 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
3903 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3904 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
3905 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3906}
3907#endif /* defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PKCS1_V21) */
3908
Ronald Croncf56a0a2020-08-04 09:51:30 +02003909psa_status_t psa_asymmetric_encrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003910 psa_algorithm_t alg,
3911 const uint8_t *input,
3912 size_t input_length,
3913 const uint8_t *salt,
3914 size_t salt_length,
3915 uint8_t *output,
3916 size_t output_size,
3917 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003918{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003919 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003920 psa_status_t status;
3921
Darryl Green5cc689a2018-07-24 15:34:10 +01003922 (void) input;
3923 (void) input_length;
3924 (void) salt;
3925 (void) output;
3926 (void) output_size;
3927
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003928 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003929
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003930 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3931 return( PSA_ERROR_INVALID_ARGUMENT );
3932
Ronald Croncf56a0a2020-08-04 09:51:30 +02003933 status = psa_get_transparent_key( key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003934 if( status != PSA_SUCCESS )
3935 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003936 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
3937 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003938 return( PSA_ERROR_INVALID_ARGUMENT );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003939
3940#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003941 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003942 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003943 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman4fed4552020-08-03 14:46:03 +02003944 status = psa_load_rsa_representation( slot->attr.type,
3945 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02003946 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02003947 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003948 if( status != PSA_SUCCESS )
Steven Cooreman4fed4552020-08-03 14:46:03 +02003949 goto rsa_exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003950
3951 if( output_size < mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003952 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003953 status = PSA_ERROR_BUFFER_TOO_SMALL;
3954 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003955 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003956#if defined(MBEDTLS_PKCS1_V15)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003957 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003958 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003959 status = mbedtls_to_psa_error(
3960 mbedtls_rsa_pkcs1_encrypt( rsa,
3961 mbedtls_ctr_drbg_random,
3962 &global_data.ctr_drbg,
3963 MBEDTLS_RSA_PUBLIC,
3964 input_length,
3965 input,
3966 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003967 }
3968 else
3969#endif /* MBEDTLS_PKCS1_V15 */
3970#if defined(MBEDTLS_PKCS1_V21)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003971 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003972 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003973 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02003974 status = mbedtls_to_psa_error(
3975 mbedtls_rsa_rsaes_oaep_encrypt( rsa,
3976 mbedtls_ctr_drbg_random,
3977 &global_data.ctr_drbg,
3978 MBEDTLS_RSA_PUBLIC,
3979 salt, salt_length,
3980 input_length,
3981 input,
3982 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003983 }
3984 else
3985#endif /* MBEDTLS_PKCS1_V21 */
3986 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003987 status = PSA_ERROR_INVALID_ARGUMENT;
3988 goto rsa_exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003989 }
Steven Cooreman4fed4552020-08-03 14:46:03 +02003990rsa_exit:
3991 if( status == PSA_SUCCESS )
Steven Cooremana2371e52020-07-28 14:30:39 +02003992 *output_length = mbedtls_rsa_get_len( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003993
Steven Cooremana2371e52020-07-28 14:30:39 +02003994 mbedtls_rsa_free( rsa );
3995 mbedtls_free( rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02003996 return( status );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003997 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003998 else
Gilles Peskineb75e4f12018-06-08 17:44:47 +02003999#endif /* defined(MBEDTLS_RSA_C) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004000 {
4001 return( PSA_ERROR_NOT_SUPPORTED );
4002 }
Gilles Peskine5b051bc2018-05-31 13:25:48 +02004003}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004004
Ronald Croncf56a0a2020-08-04 09:51:30 +02004005psa_status_t psa_asymmetric_decrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02004006 psa_algorithm_t alg,
4007 const uint8_t *input,
4008 size_t input_length,
4009 const uint8_t *salt,
4010 size_t salt_length,
4011 uint8_t *output,
4012 size_t output_size,
4013 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004014{
Gilles Peskine2f060a82018-12-04 17:12:32 +01004015 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004016 psa_status_t status;
4017
Darryl Green5cc689a2018-07-24 15:34:10 +01004018 (void) input;
4019 (void) input_length;
4020 (void) salt;
4021 (void) output;
4022 (void) output_size;
4023
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03004024 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004025
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02004026 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
4027 return( PSA_ERROR_INVALID_ARGUMENT );
4028
Ronald Croncf56a0a2020-08-04 09:51:30 +02004029 status = psa_get_transparent_key( key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004030 if( status != PSA_SUCCESS )
4031 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02004032 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004033 return( PSA_ERROR_INVALID_ARGUMENT );
4034
4035#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02004036 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004037 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004038 mbedtls_rsa_context *rsa = NULL;
4039 status = psa_load_rsa_representation( slot->attr.type,
4040 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02004041 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02004042 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02004043 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02004044 return( status );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004045
Steven Cooremana2371e52020-07-28 14:30:39 +02004046 if( input_length != mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02004047 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004048 status = PSA_ERROR_INVALID_ARGUMENT;
4049 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02004050 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004051
4052#if defined(MBEDTLS_PKCS1_V15)
Gilles Peskine6afe7892018-05-31 13:16:08 +02004053 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004054 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004055 status = mbedtls_to_psa_error(
4056 mbedtls_rsa_pkcs1_decrypt( rsa,
4057 mbedtls_ctr_drbg_random,
4058 &global_data.ctr_drbg,
4059 MBEDTLS_RSA_PRIVATE,
4060 output_length,
4061 input,
4062 output,
4063 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004064 }
4065 else
4066#endif /* MBEDTLS_PKCS1_V15 */
4067#if defined(MBEDTLS_PKCS1_V21)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02004068 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004069 {
Steven Cooremana2371e52020-07-28 14:30:39 +02004070 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02004071 status = mbedtls_to_psa_error(
4072 mbedtls_rsa_rsaes_oaep_decrypt( rsa,
4073 mbedtls_ctr_drbg_random,
4074 &global_data.ctr_drbg,
4075 MBEDTLS_RSA_PRIVATE,
4076 salt, salt_length,
4077 output_length,
4078 input,
4079 output,
4080 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004081 }
4082 else
4083#endif /* MBEDTLS_PKCS1_V21 */
4084 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004085 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004086 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03004087
Steven Cooreman4fed4552020-08-03 14:46:03 +02004088rsa_exit:
Steven Cooremana2371e52020-07-28 14:30:39 +02004089 mbedtls_rsa_free( rsa );
4090 mbedtls_free( rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02004091 return( status );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004092 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004093 else
Gilles Peskineb75e4f12018-06-08 17:44:47 +02004094#endif /* defined(MBEDTLS_RSA_C) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004095 {
4096 return( PSA_ERROR_NOT_SUPPORTED );
4097 }
Gilles Peskine5b051bc2018-05-31 13:25:48 +02004098}
Gilles Peskine20035e32018-02-03 22:44:14 +01004099
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004100
4101
mohammad1603503973b2018-03-12 15:59:30 +02004102/****************************************************************/
4103/* Symmetric cryptography */
4104/****************************************************************/
4105
Gilles Peskinee553c652018-06-04 16:22:46 +02004106static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004107 mbedtls_svc_key_id_t key,
Gilles Peskine7e928852018-06-04 16:23:10 +02004108 psa_algorithm_t alg,
4109 mbedtls_operation_t cipher_operation )
mohammad1603503973b2018-03-12 15:59:30 +02004110{
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004111 int ret = 0;
4112 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Gilles Peskine2f060a82018-12-04 17:12:32 +01004113 psa_key_slot_t *slot;
mohammad1603503973b2018-03-12 15:59:30 +02004114 size_t key_bits;
4115 const mbedtls_cipher_info_t *cipher_info = NULL;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004116 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
4117 PSA_KEY_USAGE_ENCRYPT :
4118 PSA_KEY_USAGE_DECRYPT );
mohammad1603503973b2018-03-12 15:59:30 +02004119
Steven Cooremand3feccd2020-09-01 15:56:14 +02004120 /* A context must be freshly initialized before it can be set up. */
4121 if( operation->alg != 0 )
4122 return( PSA_ERROR_BAD_STATE );
4123
Steven Cooremana07b9972020-09-10 14:54:14 +02004124 /* The requested algorithm must be one that can be processed by cipher. */
4125 if( ! PSA_ALG_IS_CIPHER( alg ) )
Steven Cooremana07b9972020-09-10 14:54:14 +02004126 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremand3feccd2020-09-01 15:56:14 +02004127
Steven Cooremanef8575e2020-09-11 11:44:50 +02004128 /* Fetch key material from key storage. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02004129 status = psa_get_key_from_slot( key, &slot, usage, alg );
Steven Cooremanef8575e2020-09-11 11:44:50 +02004130 if( status != PSA_SUCCESS )
4131 goto exit;
4132
4133 /* Initialize the operation struct members, except for alg. The alg member
4134 * is used to indicate to psa_cipher_abort that there are resources to free,
4135 * so we only set it after resources have been allocated/initialized. */
Steven Cooremana07b9972020-09-10 14:54:14 +02004136 operation->key_set = 0;
4137 operation->iv_set = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004138 operation->mbedtls_in_use = 0;
Steven Cooremana07b9972020-09-10 14:54:14 +02004139 operation->iv_size = 0;
4140 operation->block_size = 0;
4141 if( alg == PSA_ALG_ECB_NO_PADDING )
4142 operation->iv_required = 0;
4143 else
4144 operation->iv_required = 1;
4145
Steven Cooremana07b9972020-09-10 14:54:14 +02004146 /* Try doing the operation through a driver before using software fallback. */
Steven Cooreman37941cb2020-07-28 18:49:51 +02004147 if( cipher_operation == MBEDTLS_ENCRYPT )
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004148 status = psa_driver_wrapper_cipher_encrypt_setup( &operation->ctx.driver,
Steven Cooreman37941cb2020-07-28 18:49:51 +02004149 slot,
4150 alg );
4151 else
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004152 status = psa_driver_wrapper_cipher_decrypt_setup( &operation->ctx.driver,
Steven Cooreman37941cb2020-07-28 18:49:51 +02004153 slot,
4154 alg );
4155
Steven Cooremanef8575e2020-09-11 11:44:50 +02004156 if( status == PSA_SUCCESS )
Steven Cooreman6d81f7e2020-09-14 13:14:31 +02004157 {
Steven Cooremanef8575e2020-09-11 11:44:50 +02004158 /* Once the driver context is initialised, it needs to be freed using
4159 * psa_cipher_abort. Indicate this through setting alg. */
4160 operation->alg = alg;
Steven Cooreman6d81f7e2020-09-14 13:14:31 +02004161 }
Steven Cooremanef8575e2020-09-11 11:44:50 +02004162
Steven Cooremand3feccd2020-09-01 15:56:14 +02004163 if( status != PSA_ERROR_NOT_SUPPORTED ||
4164 psa_key_lifetime_is_external( slot->attr.lifetime ) )
4165 goto exit;
4166
Steven Cooremana07b9972020-09-10 14:54:14 +02004167 /* Proceed with initializing an mbed TLS cipher context if no driver is
Steven Cooremand3feccd2020-09-01 15:56:14 +02004168 * available for the given algorithm & key. */
4169 mbedtls_cipher_init( &operation->ctx.cipher );
mohammad1603503973b2018-03-12 15:59:30 +02004170
Steven Cooremana07b9972020-09-10 14:54:14 +02004171 /* Once the cipher context is initialised, it needs to be freed using
Steven Cooremanef8575e2020-09-11 11:44:50 +02004172 * psa_cipher_abort. Indicate there is something to be freed through setting
4173 * alg, and indicate the operation is being done using mbedtls crypto through
4174 * setting mbedtls_in_use. */
Steven Cooremana07b9972020-09-10 14:54:14 +02004175 operation->alg = alg;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004176 operation->mbedtls_in_use = 1;
Steven Cooremana07b9972020-09-10 14:54:14 +02004177
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02004178 key_bits = psa_get_key_slot_bits( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +02004179 cipher_info = mbedtls_cipher_info_from_psa( alg, slot->attr.type, key_bits, NULL );
mohammad1603503973b2018-03-12 15:59:30 +02004180 if( cipher_info == NULL )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004181 {
4182 status = PSA_ERROR_NOT_SUPPORTED;
4183 goto exit;
4184 }
mohammad1603503973b2018-03-12 15:59:30 +02004185
mohammad1603503973b2018-03-12 15:59:30 +02004186 ret = mbedtls_cipher_setup( &operation->ctx.cipher, cipher_info );
Moran Peker41deec42018-04-04 15:43:05 +03004187 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004188 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004189
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004190#if defined(MBEDTLS_DES_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02004191 if( slot->attr.type == PSA_KEY_TYPE_DES && key_bits == 128 )
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004192 {
4193 /* Two-key Triple-DES is 3-key Triple-DES with K1=K3 */
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02004194 uint8_t keys[24];
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004195 memcpy( keys, slot->data.key.data, 16 );
4196 memcpy( keys + 16, slot->data.key.data, 8 );
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004197 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
4198 keys,
4199 192, cipher_operation );
4200 }
4201 else
4202#endif
4203 {
4204 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004205 slot->data.key.data,
Jaeden Amero23bbb752018-06-26 14:16:54 +01004206 (int) key_bits, cipher_operation );
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004207 }
Moran Peker41deec42018-04-04 15:43:05 +03004208 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004209 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004210
mohammad16038481e742018-03-18 13:57:31 +02004211#if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004212 switch( alg )
mohammad16038481e742018-03-18 13:57:31 +02004213 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004214 case PSA_ALG_CBC_NO_PADDING:
4215 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
4216 MBEDTLS_PADDING_NONE );
4217 break;
4218 case PSA_ALG_CBC_PKCS7:
4219 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
4220 MBEDTLS_PADDING_PKCS7 );
4221 break;
4222 default:
4223 /* The algorithm doesn't involve padding. */
4224 ret = 0;
4225 break;
4226 }
4227 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004228 goto exit;
mohammad16038481e742018-03-18 13:57:31 +02004229#endif //MBEDTLS_CIPHER_MODE_WITH_PADDING
4230
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004231 operation->block_size = ( PSA_ALG_IS_STREAM_CIPHER( alg ) ? 1 :
Gilles Peskine8e338702019-07-30 20:06:31 +02004232 PSA_BLOCK_CIPHER_BLOCK_SIZE( slot->attr.type ) );
Steven Cooremana6033e92020-08-25 11:47:50 +02004233 if( ( alg & PSA_ALG_CIPHER_FROM_BLOCK_FLAG ) != 0 &&
4234 alg != PSA_ALG_ECB_NO_PADDING )
mohammad16038481e742018-03-18 13:57:31 +02004235 {
Gilles Peskine8e338702019-07-30 20:06:31 +02004236 operation->iv_size = PSA_BLOCK_CIPHER_BLOCK_SIZE( slot->attr.type );
mohammad16038481e742018-03-18 13:57:31 +02004237 }
Gilles Peskine26869f22019-05-06 15:25:00 +02004238#if defined(MBEDTLS_CHACHA20_C)
4239 else
4240 if( alg == PSA_ALG_CHACHA20 )
4241 operation->iv_size = 12;
4242#endif
mohammad1603503973b2018-03-12 15:59:30 +02004243
Steven Cooreman7df02922020-09-09 15:28:49 +02004244 status = PSA_SUCCESS;
4245
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004246exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02004247 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004248 status = mbedtls_to_psa_error( ret );
Steven Cooreman7df02922020-09-09 15:28:49 +02004249 if( status == PSA_SUCCESS )
4250 {
4251 /* Update operation flags for both driver and software implementations */
4252 operation->key_set = 1;
4253 }
4254 else
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004255 psa_cipher_abort( operation );
4256 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004257}
4258
Gilles Peskinefe119512018-07-08 21:39:34 +02004259psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004260 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02004261 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02004262{
Ronald Croncf56a0a2020-08-04 09:51:30 +02004263 return( psa_cipher_setup( operation, key, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02004264}
4265
Gilles Peskinefe119512018-07-08 21:39:34 +02004266psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004267 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02004268 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02004269{
Ronald Croncf56a0a2020-08-04 09:51:30 +02004270 return( psa_cipher_setup( operation, key, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02004271}
4272
Gilles Peskinefe119512018-07-08 21:39:34 +02004273psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004274 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02004275 size_t iv_size,
4276 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02004277{
itayzafrir534bd7c2018-08-02 13:56:32 +03004278 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00004279 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooreman7df02922020-09-09 15:28:49 +02004280 if( operation->iv_set || ! operation->iv_required )
4281 {
4282 return( PSA_ERROR_BAD_STATE );
4283 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004284
Steven Cooremanef8575e2020-09-11 11:44:50 +02004285 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004286 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004287 status = psa_driver_wrapper_cipher_generate_iv( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004288 iv,
4289 iv_size,
4290 iv_length );
4291 goto exit;
4292 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004293
Moran Peker41deec42018-04-04 15:43:05 +03004294 if( iv_size < operation->iv_size )
mohammad1603503973b2018-03-12 15:59:30 +02004295 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004296 status = PSA_ERROR_BUFFER_TOO_SMALL;
Moran Peker41deec42018-04-04 15:43:05 +03004297 goto exit;
4298 }
Gilles Peskine7e928852018-06-04 16:23:10 +02004299 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg,
4300 iv, operation->iv_size );
Moran Peker41deec42018-04-04 15:43:05 +03004301 if( ret != 0 )
4302 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004303 status = mbedtls_to_psa_error( ret );
Gilles Peskinee553c652018-06-04 16:22:46 +02004304 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004305 }
Gilles Peskinee553c652018-06-04 16:22:46 +02004306
mohammad16038481e742018-03-18 13:57:31 +02004307 *iv_length = operation->iv_size;
itayzafrir534bd7c2018-08-02 13:56:32 +03004308 status = psa_cipher_set_iv( operation, iv, *iv_length );
Moran Peker41deec42018-04-04 15:43:05 +03004309
Moran Peker395db872018-05-31 14:07:14 +03004310exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02004311 if( status == PSA_SUCCESS )
4312 operation->iv_set = 1;
4313 else
Moran Peker395db872018-05-31 14:07:14 +03004314 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004315 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004316}
4317
Gilles Peskinefe119512018-07-08 21:39:34 +02004318psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004319 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02004320 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02004321{
itayzafrir534bd7c2018-08-02 13:56:32 +03004322 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00004323 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooreman7df02922020-09-09 15:28:49 +02004324 if( operation->iv_set || ! operation->iv_required )
4325 {
4326 return( PSA_ERROR_BAD_STATE );
4327 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004328
Steven Cooremanef8575e2020-09-11 11:44:50 +02004329 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004330 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004331 status = psa_driver_wrapper_cipher_set_iv( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004332 iv,
4333 iv_length );
4334 goto exit;
4335 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004336
Moran Pekera28258c2018-05-29 16:25:04 +03004337 if( iv_length != operation->iv_size )
Moran Peker71f19ae2018-04-22 20:23:16 +03004338 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004339 status = PSA_ERROR_INVALID_ARGUMENT;
4340 goto exit;
Moran Peker71f19ae2018-04-22 20:23:16 +03004341 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004342 ret = mbedtls_cipher_set_iv( &operation->ctx.cipher, iv, iv_length );
4343 status = mbedtls_to_psa_error( ret );
4344exit:
4345 if( status == PSA_SUCCESS )
4346 operation->iv_set = 1;
4347 else
mohammad1603503973b2018-03-12 15:59:30 +02004348 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004349 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004350}
4351
Steven Cooreman177deba2020-09-07 17:14:14 +02004352/* Process input for which the algorithm is set to ECB mode. This requires
4353 * manual processing, since the PSA API is defined as being able to process
4354 * arbitrary-length calls to psa_cipher_update() with ECB mode, but the
4355 * underlying mbedtls_cipher_update only takes full blocks. */
4356static psa_status_t psa_cipher_update_ecb_internal(
4357 mbedtls_cipher_context_t *ctx,
4358 const uint8_t *input,
4359 size_t input_length,
4360 uint8_t *output,
4361 size_t output_size,
4362 size_t *output_length )
4363{
4364 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4365 size_t block_size = ctx->cipher_info->block_size;
4366 size_t internal_output_length = 0;
4367 *output_length = 0;
4368
4369 if( input_length == 0 )
4370 {
4371 status = PSA_SUCCESS;
4372 goto exit;
4373 }
4374
4375 if( ctx->unprocessed_len > 0 )
4376 {
4377 /* Fill up to block size, and run the block if there's a full one. */
4378 size_t bytes_to_copy = block_size - ctx->unprocessed_len;
4379
4380 if( input_length < bytes_to_copy )
4381 bytes_to_copy = input_length;
4382
4383 memcpy( &( ctx->unprocessed_data[ctx->unprocessed_len] ),
4384 input, bytes_to_copy );
4385 input_length -= bytes_to_copy;
4386 input += bytes_to_copy;
4387 ctx->unprocessed_len += bytes_to_copy;
4388
4389 if( ctx->unprocessed_len == block_size )
4390 {
4391 status = mbedtls_to_psa_error(
4392 mbedtls_cipher_update( ctx,
4393 ctx->unprocessed_data,
4394 block_size,
4395 output, &internal_output_length ) );
4396
4397 if( status != PSA_SUCCESS )
4398 goto exit;
4399
4400 output += internal_output_length;
4401 output_size -= internal_output_length;
4402 *output_length += internal_output_length;
4403 ctx->unprocessed_len = 0;
4404 }
4405 }
4406
4407 while( input_length >= block_size )
4408 {
4409 /* Run all full blocks we have, one by one */
4410 status = mbedtls_to_psa_error(
4411 mbedtls_cipher_update( ctx, input,
4412 block_size,
4413 output, &internal_output_length ) );
4414
4415 if( status != PSA_SUCCESS )
4416 goto exit;
4417
4418 input_length -= block_size;
4419 input += block_size;
4420
4421 output += internal_output_length;
4422 output_size -= internal_output_length;
4423 *output_length += internal_output_length;
4424 }
4425
4426 if( input_length > 0 )
4427 {
4428 /* Save unprocessed bytes for later processing */
4429 memcpy( &( ctx->unprocessed_data[ctx->unprocessed_len] ),
4430 input, input_length );
4431 ctx->unprocessed_len += input_length;
4432 }
4433
4434 status = PSA_SUCCESS;
4435
4436exit:
4437 return( status );
4438}
4439
Gilles Peskinee553c652018-06-04 16:22:46 +02004440psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
4441 const uint8_t *input,
4442 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004443 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02004444 size_t output_size,
4445 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02004446{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004447 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine89d789c2018-06-04 17:17:16 +02004448 size_t expected_output_size;
Steven Cooreman7df02922020-09-09 15:28:49 +02004449 if( operation->alg == 0 )
4450 {
4451 return( PSA_ERROR_BAD_STATE );
4452 }
4453 if( operation->iv_required && ! operation->iv_set )
4454 {
4455 return( PSA_ERROR_BAD_STATE );
4456 }
Jaeden Ameroab439972019-02-15 14:12:05 +00004457
Steven Cooremanef8575e2020-09-11 11:44:50 +02004458 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004459 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004460 status = psa_driver_wrapper_cipher_update( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004461 input,
4462 input_length,
4463 output,
4464 output_size,
4465 output_length );
4466 goto exit;
4467 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004468
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004469 if( ! PSA_ALG_IS_STREAM_CIPHER( operation->alg ) )
Gilles Peskine89d789c2018-06-04 17:17:16 +02004470 {
4471 /* Take the unprocessed partial block left over from previous
4472 * update calls, if any, plus the input to this call. Remove
4473 * the last partial block, if any. You get the data that will be
4474 * output in this call. */
4475 expected_output_size =
4476 ( operation->ctx.cipher.unprocessed_len + input_length )
4477 / operation->block_size * operation->block_size;
4478 }
4479 else
4480 {
4481 expected_output_size = input_length;
4482 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004483
Gilles Peskine89d789c2018-06-04 17:17:16 +02004484 if( output_size < expected_output_size )
itayzafrir534bd7c2018-08-02 13:56:32 +03004485 {
4486 status = PSA_ERROR_BUFFER_TOO_SMALL;
4487 goto exit;
4488 }
mohammad160382759612018-03-12 18:16:40 +02004489
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004490 if( operation->alg == PSA_ALG_ECB_NO_PADDING )
4491 {
4492 /* mbedtls_cipher_update has an API inconsistency: it will only
4493 * process a single block at a time in ECB mode. Abstract away that
4494 * inconsistency here to match the PSA API behaviour. */
Steven Cooreman177deba2020-09-07 17:14:14 +02004495 status = psa_cipher_update_ecb_internal( &operation->ctx.cipher,
4496 input,
4497 input_length,
4498 output,
4499 output_size,
4500 output_length );
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004501 }
4502 else
4503 {
4504 status = mbedtls_to_psa_error(
4505 mbedtls_cipher_update( &operation->ctx.cipher, input,
4506 input_length, output, output_length ) );
4507 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004508exit:
4509 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02004510 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004511 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004512}
4513
Gilles Peskinee553c652018-06-04 16:22:46 +02004514psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
4515 uint8_t *output,
4516 size_t output_size,
4517 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02004518{
David Saadab4ecc272019-02-14 13:48:10 +02004519 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Gilles Peskinee553c652018-06-04 16:22:46 +02004520 uint8_t temp_output_buffer[MBEDTLS_MAX_BLOCK_LENGTH];
Steven Cooreman7df02922020-09-09 15:28:49 +02004521 if( operation->alg == 0 )
4522 {
4523 return( PSA_ERROR_BAD_STATE );
4524 }
4525 if( operation->iv_required && ! operation->iv_set )
4526 {
4527 return( PSA_ERROR_BAD_STATE );
4528 }
Moran Pekerbed71a22018-04-22 20:19:20 +03004529
Steven Cooremanef8575e2020-09-11 11:44:50 +02004530 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004531 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004532 status = psa_driver_wrapper_cipher_finish( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004533 output,
4534 output_size,
4535 output_length );
Steven Cooremanef8575e2020-09-11 11:44:50 +02004536 goto exit;
Steven Cooreman8b122252020-09-03 15:30:32 +02004537 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004538
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004539 if( operation->ctx.cipher.unprocessed_len != 0 )
Moran Peker7cb22b82018-06-05 11:40:02 +03004540 {
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004541 if( operation->alg == PSA_ALG_ECB_NO_PADDING ||
Fredrik Strupef90e3012020-09-28 16:11:33 +02004542 operation->alg == PSA_ALG_CBC_NO_PADDING )
Steven Cooremana6033e92020-08-25 11:47:50 +02004543 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004544 status = PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004545 goto exit;
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004546 }
Moran Pekerdc38ebc2018-04-30 15:45:34 +03004547 }
4548
Steven Cooremanef8575e2020-09-11 11:44:50 +02004549 status = mbedtls_to_psa_error(
4550 mbedtls_cipher_finish( &operation->ctx.cipher,
4551 temp_output_buffer,
4552 output_length ) );
4553 if( status != PSA_SUCCESS )
4554 goto exit;
Janos Follath315b51c2018-07-09 16:04:51 +01004555
Gilles Peskine46f1fd72018-06-28 19:31:31 +02004556 if( *output_length == 0 )
Janos Follath315b51c2018-07-09 16:04:51 +01004557 ; /* Nothing to copy. Note that output may be NULL in this case. */
Gilles Peskine46f1fd72018-06-28 19:31:31 +02004558 else if( output_size >= *output_length )
Moran Pekerdc38ebc2018-04-30 15:45:34 +03004559 memcpy( output, temp_output_buffer, *output_length );
4560 else
Janos Follath315b51c2018-07-09 16:04:51 +01004561 status = PSA_ERROR_BUFFER_TOO_SMALL;
mohammad1603503973b2018-03-12 15:59:30 +02004562
Steven Cooremanef8575e2020-09-11 11:44:50 +02004563exit:
4564 if( operation->mbedtls_in_use == 1 )
4565 mbedtls_platform_zeroize( temp_output_buffer, sizeof( temp_output_buffer ) );
Janos Follath315b51c2018-07-09 16:04:51 +01004566
Steven Cooremanef8575e2020-09-11 11:44:50 +02004567 if( status == PSA_SUCCESS )
4568 return( psa_cipher_abort( operation ) );
4569 else
4570 {
4571 *output_length = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004572 (void) psa_cipher_abort( operation );
Janos Follath315b51c2018-07-09 16:04:51 +01004573
Steven Cooremanef8575e2020-09-11 11:44:50 +02004574 return( status );
4575 }
mohammad1603503973b2018-03-12 15:59:30 +02004576}
4577
Gilles Peskinee553c652018-06-04 16:22:46 +02004578psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
4579{
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004580 if( operation->alg == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02004581 {
Steven Cooremana07b9972020-09-10 14:54:14 +02004582 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02004583 * in use. It's ok to call abort on such an object, and there's
4584 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004585 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02004586 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004587
Gilles Peskinef9c2c092018-06-21 16:57:07 +02004588 /* Sanity check (shouldn't happen: operation->alg should
4589 * always have been initialized to a valid value). */
4590 if( ! PSA_ALG_IS_CIPHER( operation->alg ) )
4591 return( PSA_ERROR_BAD_STATE );
4592
Steven Cooremanef8575e2020-09-11 11:44:50 +02004593 if( operation->mbedtls_in_use == 0 )
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004594 psa_driver_wrapper_cipher_abort( &operation->ctx.driver );
Steven Cooremand3feccd2020-09-01 15:56:14 +02004595 else
4596 mbedtls_cipher_free( &operation->ctx.cipher );
Gilles Peskinee553c652018-06-04 16:22:46 +02004597
Moran Peker41deec42018-04-04 15:43:05 +03004598 operation->alg = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004599 operation->key_set = 0;
4600 operation->iv_set = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004601 operation->mbedtls_in_use = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004602 operation->iv_size = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004603 operation->block_size = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004604 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004605
Moran Peker395db872018-05-31 14:07:14 +03004606 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02004607}
4608
Gilles Peskinea0655c32018-04-30 17:06:50 +02004609
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004610
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004611
mohammad16035955c982018-04-26 00:53:03 +03004612/****************************************************************/
4613/* AEAD */
4614/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004615
Gilles Peskineedf9a652018-08-17 18:11:56 +02004616typedef struct
4617{
Gilles Peskine2f060a82018-12-04 17:12:32 +01004618 psa_key_slot_t *slot;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004619 const mbedtls_cipher_info_t *cipher_info;
4620 union
4621 {
4622#if defined(MBEDTLS_CCM_C)
4623 mbedtls_ccm_context ccm;
4624#endif /* MBEDTLS_CCM_C */
4625#if defined(MBEDTLS_GCM_C)
4626 mbedtls_gcm_context gcm;
4627#endif /* MBEDTLS_GCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004628#if defined(MBEDTLS_CHACHAPOLY_C)
4629 mbedtls_chachapoly_context chachapoly;
4630#endif /* MBEDTLS_CHACHAPOLY_C */
Gilles Peskineedf9a652018-08-17 18:11:56 +02004631 } ctx;
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004632 psa_algorithm_t core_alg;
4633 uint8_t full_tag_length;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004634 uint8_t tag_length;
4635} aead_operation_t;
4636
Gilles Peskine30a9e412019-01-14 18:36:12 +01004637static void psa_aead_abort_internal( aead_operation_t *operation )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004638{
Gilles Peskinef8a8fe62018-08-21 16:38:05 +02004639 switch( operation->core_alg )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004640 {
4641#if defined(MBEDTLS_CCM_C)
4642 case PSA_ALG_CCM:
4643 mbedtls_ccm_free( &operation->ctx.ccm );
4644 break;
4645#endif /* MBEDTLS_CCM_C */
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004646#if defined(MBEDTLS_GCM_C)
Gilles Peskineedf9a652018-08-17 18:11:56 +02004647 case PSA_ALG_GCM:
4648 mbedtls_gcm_free( &operation->ctx.gcm );
4649 break;
4650#endif /* MBEDTLS_GCM_C */
4651 }
4652}
4653
4654static psa_status_t psa_aead_setup( aead_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004655 mbedtls_svc_key_id_t key,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004656 psa_key_usage_t usage,
4657 psa_algorithm_t alg )
4658{
4659 psa_status_t status;
4660 size_t key_bits;
4661 mbedtls_cipher_id_t cipher_id;
4662
Ronald Croncf56a0a2020-08-04 09:51:30 +02004663 status = psa_get_transparent_key( key, &operation->slot, usage, alg );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004664 if( status != PSA_SUCCESS )
4665 return( status );
4666
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02004667 key_bits = psa_get_key_slot_bits( operation->slot );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004668
4669 operation->cipher_info =
Gilles Peskine8e338702019-07-30 20:06:31 +02004670 mbedtls_cipher_info_from_psa( alg, operation->slot->attr.type, key_bits,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004671 &cipher_id );
4672 if( operation->cipher_info == NULL )
4673 return( PSA_ERROR_NOT_SUPPORTED );
4674
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004675 switch( PSA_ALG_AEAD_WITH_TAG_LENGTH( alg, 0 ) )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004676 {
4677#if defined(MBEDTLS_CCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004678 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CCM, 0 ):
4679 operation->core_alg = PSA_ALG_CCM;
4680 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004681 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.
4682 * The call to mbedtls_ccm_encrypt_and_tag or
4683 * mbedtls_ccm_auth_decrypt will validate the tag length. */
Gilles Peskine8e338702019-07-30 20:06:31 +02004684 if( PSA_BLOCK_CIPHER_BLOCK_SIZE( operation->slot->attr.type ) != 16 )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004685 return( PSA_ERROR_INVALID_ARGUMENT );
4686 mbedtls_ccm_init( &operation->ctx.ccm );
4687 status = mbedtls_to_psa_error(
4688 mbedtls_ccm_setkey( &operation->ctx.ccm, cipher_id,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004689 operation->slot->data.key.data,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004690 (unsigned int) key_bits ) );
4691 if( status != 0 )
4692 goto cleanup;
4693 break;
4694#endif /* MBEDTLS_CCM_C */
4695
4696#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004697 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_GCM, 0 ):
4698 operation->core_alg = PSA_ALG_GCM;
4699 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004700 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16.
4701 * The call to mbedtls_gcm_crypt_and_tag or
4702 * mbedtls_gcm_auth_decrypt will validate the tag length. */
Gilles Peskine8e338702019-07-30 20:06:31 +02004703 if( PSA_BLOCK_CIPHER_BLOCK_SIZE( operation->slot->attr.type ) != 16 )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004704 return( PSA_ERROR_INVALID_ARGUMENT );
4705 mbedtls_gcm_init( &operation->ctx.gcm );
4706 status = mbedtls_to_psa_error(
4707 mbedtls_gcm_setkey( &operation->ctx.gcm, cipher_id,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004708 operation->slot->data.key.data,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004709 (unsigned int) key_bits ) );
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004710 if( status != 0 )
4711 goto cleanup;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004712 break;
4713#endif /* MBEDTLS_GCM_C */
4714
Gilles Peskine26869f22019-05-06 15:25:00 +02004715#if defined(MBEDTLS_CHACHAPOLY_C)
4716 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CHACHA20_POLY1305, 0 ):
4717 operation->core_alg = PSA_ALG_CHACHA20_POLY1305;
4718 operation->full_tag_length = 16;
4719 /* We only support the default tag length. */
4720 if( alg != PSA_ALG_CHACHA20_POLY1305 )
4721 return( PSA_ERROR_NOT_SUPPORTED );
4722 mbedtls_chachapoly_init( &operation->ctx.chachapoly );
4723 status = mbedtls_to_psa_error(
4724 mbedtls_chachapoly_setkey( &operation->ctx.chachapoly,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004725 operation->slot->data.key.data ) );
Gilles Peskine26869f22019-05-06 15:25:00 +02004726 if( status != 0 )
4727 goto cleanup;
4728 break;
4729#endif /* MBEDTLS_CHACHAPOLY_C */
4730
Gilles Peskineedf9a652018-08-17 18:11:56 +02004731 default:
4732 return( PSA_ERROR_NOT_SUPPORTED );
4733 }
4734
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004735 if( PSA_AEAD_TAG_LENGTH( alg ) > operation->full_tag_length )
4736 {
4737 status = PSA_ERROR_INVALID_ARGUMENT;
4738 goto cleanup;
4739 }
4740 operation->tag_length = PSA_AEAD_TAG_LENGTH( alg );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004741
Gilles Peskineedf9a652018-08-17 18:11:56 +02004742 return( PSA_SUCCESS );
4743
4744cleanup:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004745 psa_aead_abort_internal( operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004746 return( status );
4747}
4748
Ronald Croncf56a0a2020-08-04 09:51:30 +02004749psa_status_t psa_aead_encrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03004750 psa_algorithm_t alg,
4751 const uint8_t *nonce,
4752 size_t nonce_length,
4753 const uint8_t *additional_data,
4754 size_t additional_data_length,
4755 const uint8_t *plaintext,
4756 size_t plaintext_length,
4757 uint8_t *ciphertext,
4758 size_t ciphertext_size,
4759 size_t *ciphertext_length )
4760{
mohammad16035955c982018-04-26 00:53:03 +03004761 psa_status_t status;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004762 aead_operation_t operation;
mohammad160315223a82018-06-03 17:19:55 +03004763 uint8_t *tag;
Gilles Peskine2d277862018-06-18 15:41:12 +02004764
mohammad1603f08a5502018-06-03 15:05:47 +03004765 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004766
Ronald Croncf56a0a2020-08-04 09:51:30 +02004767 status = psa_aead_setup( &operation, key, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004768 if( status != PSA_SUCCESS )
4769 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004770
Gilles Peskineedf9a652018-08-17 18:11:56 +02004771 /* For all currently supported modes, the tag is at the end of the
4772 * ciphertext. */
4773 if( ciphertext_size < ( plaintext_length + operation.tag_length ) )
4774 {
4775 status = PSA_ERROR_BUFFER_TOO_SMALL;
4776 goto exit;
4777 }
4778 tag = ciphertext + plaintext_length;
mohammad16035955c982018-04-26 00:53:03 +03004779
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004780#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004781 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03004782 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004783 status = mbedtls_to_psa_error(
4784 mbedtls_gcm_crypt_and_tag( &operation.ctx.gcm,
4785 MBEDTLS_GCM_ENCRYPT,
4786 plaintext_length,
4787 nonce, nonce_length,
4788 additional_data, additional_data_length,
4789 plaintext, ciphertext,
4790 operation.tag_length, tag ) );
mohammad16035955c982018-04-26 00:53:03 +03004791 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004792 else
4793#endif /* MBEDTLS_GCM_C */
4794#if defined(MBEDTLS_CCM_C)
4795 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03004796 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004797 status = mbedtls_to_psa_error(
4798 mbedtls_ccm_encrypt_and_tag( &operation.ctx.ccm,
4799 plaintext_length,
4800 nonce, nonce_length,
4801 additional_data,
4802 additional_data_length,
4803 plaintext, ciphertext,
4804 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03004805 }
mohammad16035c8845f2018-05-09 05:40:09 -07004806 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004807#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004808#if defined(MBEDTLS_CHACHAPOLY_C)
4809 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
4810 {
4811 if( nonce_length != 12 || operation.tag_length != 16 )
4812 {
4813 status = PSA_ERROR_NOT_SUPPORTED;
4814 goto exit;
4815 }
4816 status = mbedtls_to_psa_error(
4817 mbedtls_chachapoly_encrypt_and_tag( &operation.ctx.chachapoly,
4818 plaintext_length,
4819 nonce,
4820 additional_data,
4821 additional_data_length,
4822 plaintext,
4823 ciphertext,
4824 tag ) );
4825 }
4826 else
4827#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad16035c8845f2018-05-09 05:40:09 -07004828 {
mohammad1603554faad2018-06-03 15:07:38 +03004829 return( PSA_ERROR_NOT_SUPPORTED );
mohammad16035c8845f2018-05-09 05:40:09 -07004830 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004831
Gilles Peskineedf9a652018-08-17 18:11:56 +02004832 if( status != PSA_SUCCESS && ciphertext_size != 0 )
4833 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02004834
Gilles Peskineedf9a652018-08-17 18:11:56 +02004835exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004836 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004837 if( status == PSA_SUCCESS )
4838 *ciphertext_length = plaintext_length + operation.tag_length;
4839 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004840}
4841
Gilles Peskineee652a32018-06-01 19:23:52 +02004842/* Locate the tag in a ciphertext buffer containing the encrypted data
4843 * followed by the tag. Return the length of the part preceding the tag in
4844 * *plaintext_length. This is the size of the plaintext in modes where
4845 * the encrypted data has the same size as the plaintext, such as
4846 * CCM and GCM. */
4847static psa_status_t psa_aead_unpadded_locate_tag( size_t tag_length,
4848 const uint8_t *ciphertext,
4849 size_t ciphertext_length,
4850 size_t plaintext_size,
Gilles Peskineee652a32018-06-01 19:23:52 +02004851 const uint8_t **p_tag )
4852{
4853 size_t payload_length;
4854 if( tag_length > ciphertext_length )
4855 return( PSA_ERROR_INVALID_ARGUMENT );
4856 payload_length = ciphertext_length - tag_length;
4857 if( payload_length > plaintext_size )
4858 return( PSA_ERROR_BUFFER_TOO_SMALL );
4859 *p_tag = ciphertext + payload_length;
Gilles Peskineee652a32018-06-01 19:23:52 +02004860 return( PSA_SUCCESS );
4861}
4862
Ronald Croncf56a0a2020-08-04 09:51:30 +02004863psa_status_t psa_aead_decrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03004864 psa_algorithm_t alg,
4865 const uint8_t *nonce,
4866 size_t nonce_length,
4867 const uint8_t *additional_data,
4868 size_t additional_data_length,
4869 const uint8_t *ciphertext,
4870 size_t ciphertext_length,
4871 uint8_t *plaintext,
4872 size_t plaintext_size,
4873 size_t *plaintext_length )
4874{
mohammad16035955c982018-04-26 00:53:03 +03004875 psa_status_t status;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004876 aead_operation_t operation;
4877 const uint8_t *tag = NULL;
Gilles Peskine2d277862018-06-18 15:41:12 +02004878
Gilles Peskineee652a32018-06-01 19:23:52 +02004879 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004880
Ronald Croncf56a0a2020-08-04 09:51:30 +02004881 status = psa_aead_setup( &operation, key, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004882 if( status != PSA_SUCCESS )
4883 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004884
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004885 status = psa_aead_unpadded_locate_tag( operation.tag_length,
4886 ciphertext, ciphertext_length,
4887 plaintext_size, &tag );
4888 if( status != PSA_SUCCESS )
4889 goto exit;
4890
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004891#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004892 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03004893 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004894 status = mbedtls_to_psa_error(
4895 mbedtls_gcm_auth_decrypt( &operation.ctx.gcm,
4896 ciphertext_length - operation.tag_length,
4897 nonce, nonce_length,
4898 additional_data,
4899 additional_data_length,
4900 tag, operation.tag_length,
4901 ciphertext, plaintext ) );
mohammad16035955c982018-04-26 00:53:03 +03004902 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004903 else
4904#endif /* MBEDTLS_GCM_C */
4905#if defined(MBEDTLS_CCM_C)
4906 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03004907 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004908 status = mbedtls_to_psa_error(
4909 mbedtls_ccm_auth_decrypt( &operation.ctx.ccm,
4910 ciphertext_length - operation.tag_length,
4911 nonce, nonce_length,
4912 additional_data,
4913 additional_data_length,
4914 ciphertext, plaintext,
4915 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03004916 }
mohammad160339574652018-06-01 04:39:53 -07004917 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004918#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004919#if defined(MBEDTLS_CHACHAPOLY_C)
4920 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
4921 {
4922 if( nonce_length != 12 || operation.tag_length != 16 )
4923 {
4924 status = PSA_ERROR_NOT_SUPPORTED;
4925 goto exit;
4926 }
4927 status = mbedtls_to_psa_error(
4928 mbedtls_chachapoly_auth_decrypt( &operation.ctx.chachapoly,
4929 ciphertext_length - operation.tag_length,
4930 nonce,
4931 additional_data,
4932 additional_data_length,
4933 tag,
4934 ciphertext,
4935 plaintext ) );
4936 }
4937 else
4938#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad160339574652018-06-01 04:39:53 -07004939 {
mohammad1603554faad2018-06-03 15:07:38 +03004940 return( PSA_ERROR_NOT_SUPPORTED );
mohammad160339574652018-06-01 04:39:53 -07004941 }
Gilles Peskinea40d7742018-06-01 16:28:30 +02004942
Gilles Peskineedf9a652018-08-17 18:11:56 +02004943 if( status != PSA_SUCCESS && plaintext_size != 0 )
4944 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03004945
Gilles Peskineedf9a652018-08-17 18:11:56 +02004946exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004947 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004948 if( status == PSA_SUCCESS )
4949 *plaintext_length = ciphertext_length - operation.tag_length;
4950 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004951}
4952
Gilles Peskinea0655c32018-04-30 17:06:50 +02004953
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004954
Gilles Peskine20035e32018-02-03 22:44:14 +01004955/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02004956/* Generators */
4957/****************************************************************/
4958
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004959#define HKDF_STATE_INIT 0 /* no input yet */
4960#define HKDF_STATE_STARTED 1 /* got salt */
4961#define HKDF_STATE_KEYED 2 /* got key */
4962#define HKDF_STATE_OUTPUT 3 /* output started */
4963
Gilles Peskinecbe66502019-05-16 16:59:18 +02004964static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004965 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004966{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004967 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
4968 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004969 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004970 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004971}
4972
4973
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004974psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004975{
4976 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004977 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004978 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004979 {
4980 /* The object has (apparently) been initialized but it is not
4981 * in use. It's ok to call abort on such an object, and there's
4982 * nothing to do. */
4983 }
4984 else
Gilles Peskinebef7f142018-07-12 17:22:21 +02004985#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004986 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004987 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004988 mbedtls_free( operation->ctx.hkdf.info );
4989 status = psa_hmac_abort_internal( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004990 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01004991 else if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004992 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004993 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004994 {
Janos Follath6a1d2622019-06-11 10:37:28 +01004995 if( operation->ctx.tls12_prf.seed != NULL )
4996 {
4997 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
4998 operation->ctx.tls12_prf.seed_length );
4999 mbedtls_free( operation->ctx.tls12_prf.seed );
5000 }
5001
5002 if( operation->ctx.tls12_prf.label != NULL )
5003 {
5004 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
5005 operation->ctx.tls12_prf.label_length );
5006 mbedtls_free( operation->ctx.tls12_prf.label );
5007 }
5008
5009 status = psa_hmac_abort_internal( &operation->ctx.tls12_prf.hmac );
5010
5011 /* We leave the fields Ai and output_block to be erased safely by the
5012 * mbedtls_platform_zeroize() in the end of this function. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005013 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005014 else
5015#endif /* MBEDTLS_MD_C */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005016 {
5017 status = PSA_ERROR_BAD_STATE;
5018 }
Janos Follath083036a2019-06-11 10:22:26 +01005019 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005020 return( status );
5021}
5022
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005023psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02005024 size_t *capacity)
5025{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005026 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005027 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005028 /* This is a blank key derivation operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02005029 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005030 }
5031
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005032 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005033 return( PSA_SUCCESS );
5034}
5035
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005036psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005037 size_t capacity )
5038{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005039 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005040 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005041 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005042 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005043 operation->capacity = capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005044 return( PSA_SUCCESS );
5045}
5046
Gilles Peskinebef7f142018-07-12 17:22:21 +02005047#if defined(MBEDTLS_MD_C)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005048/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02005049 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02005050static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskinebef7f142018-07-12 17:22:21 +02005051 psa_algorithm_t hash_alg,
5052 uint8_t *output,
5053 size_t output_length )
5054{
5055 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
5056 psa_status_t status;
5057
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005058 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
5059 return( PSA_ERROR_BAD_STATE );
5060 hkdf->state = HKDF_STATE_OUTPUT;
5061
Gilles Peskinebef7f142018-07-12 17:22:21 +02005062 while( output_length != 0 )
5063 {
5064 /* Copy what remains of the current block */
5065 uint8_t n = hash_length - hkdf->offset_in_block;
5066 if( n > output_length )
5067 n = (uint8_t) output_length;
5068 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
5069 output += n;
5070 output_length -= n;
5071 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02005072 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02005073 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02005074 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005075 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005076 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02005077 * object was corrupted or if this function is called directly
5078 * inside the library. */
5079 if( hkdf->block_number == 0xff )
5080 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02005081
5082 /* We need a new block */
5083 ++hkdf->block_number;
5084 hkdf->offset_in_block = 0;
5085 status = psa_hmac_setup_internal( &hkdf->hmac,
5086 hkdf->prk, hash_length,
5087 hash_alg );
5088 if( status != PSA_SUCCESS )
5089 return( status );
5090 if( hkdf->block_number != 1 )
5091 {
5092 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5093 hkdf->output_block,
5094 hash_length );
5095 if( status != PSA_SUCCESS )
5096 return( status );
5097 }
5098 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5099 hkdf->info,
5100 hkdf->info_length );
5101 if( status != PSA_SUCCESS )
5102 return( status );
5103 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5104 &hkdf->block_number, 1 );
5105 if( status != PSA_SUCCESS )
5106 return( status );
5107 status = psa_hmac_finish_internal( &hkdf->hmac,
5108 hkdf->output_block,
5109 sizeof( hkdf->output_block ) );
5110 if( status != PSA_SUCCESS )
5111 return( status );
5112 }
5113
5114 return( PSA_SUCCESS );
5115}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005116
Janos Follath7742fee2019-06-17 12:58:10 +01005117static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
5118 psa_tls12_prf_key_derivation_t *tls12_prf,
5119 psa_algorithm_t alg )
5120{
5121 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
5122 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
Janos Follathea29bfb2019-06-19 12:21:20 +01005123 psa_hash_operation_t backup = PSA_HASH_OPERATION_INIT;
5124 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005125
Janos Follath7742fee2019-06-17 12:58:10 +01005126 /* We can't be wanting more output after block 0xff, otherwise
5127 * the capacity check in psa_key_derivation_output_bytes() would have
5128 * prevented this call. It could happen only if the operation
5129 * object was corrupted or if this function is called directly
5130 * inside the library. */
5131 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01005132 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01005133
5134 /* We need a new block */
5135 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01005136 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01005137
5138 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
5139 *
5140 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
5141 *
5142 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
5143 * HMAC_hash(secret, A(2) + seed) +
5144 * HMAC_hash(secret, A(3) + seed) + ...
5145 *
5146 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01005147 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01005148 *
Janos Follathea29bfb2019-06-19 12:21:20 +01005149 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01005150 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01005151 * is currently extracted as `output_block` and where i is
5152 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01005153 */
5154
Janos Follathea29bfb2019-06-19 12:21:20 +01005155 /* Save the hash context before using it, to preserve the hash state with
5156 * only the inner padding in it. We need this, because inner padding depends
5157 * on the key (secret in the RFC's terminology). */
5158 status = psa_hash_clone( &tls12_prf->hmac.hash_ctx, &backup );
5159 if( status != PSA_SUCCESS )
5160 goto cleanup;
5161
5162 /* Calculate A(i) where i = tls12_prf->block_number. */
5163 if( tls12_prf->block_number == 1 )
5164 {
5165 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
5166 * the variable seed and in this instance means it in the context of the
5167 * P_hash function, where seed = label + seed.) */
5168 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5169 tls12_prf->label, tls12_prf->label_length );
5170 if( status != PSA_SUCCESS )
5171 goto cleanup;
5172 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5173 tls12_prf->seed, tls12_prf->seed_length );
5174 if( status != PSA_SUCCESS )
5175 goto cleanup;
5176 }
5177 else
5178 {
5179 /* A(i) = HMAC_hash(secret, A(i-1)) */
5180 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5181 tls12_prf->Ai, hash_length );
5182 if( status != PSA_SUCCESS )
5183 goto cleanup;
5184 }
5185
5186 status = psa_hmac_finish_internal( &tls12_prf->hmac,
5187 tls12_prf->Ai, hash_length );
5188 if( status != PSA_SUCCESS )
5189 goto cleanup;
5190 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
5191 if( status != PSA_SUCCESS )
5192 goto cleanup;
5193
5194 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
5195 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5196 tls12_prf->Ai, hash_length );
5197 if( status != PSA_SUCCESS )
5198 goto cleanup;
5199 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5200 tls12_prf->label, tls12_prf->label_length );
5201 if( status != PSA_SUCCESS )
5202 goto cleanup;
5203 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5204 tls12_prf->seed, tls12_prf->seed_length );
5205 if( status != PSA_SUCCESS )
5206 goto cleanup;
5207 status = psa_hmac_finish_internal( &tls12_prf->hmac,
5208 tls12_prf->output_block, hash_length );
5209 if( status != PSA_SUCCESS )
5210 goto cleanup;
5211 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
5212 if( status != PSA_SUCCESS )
5213 goto cleanup;
5214
Janos Follath7742fee2019-06-17 12:58:10 +01005215
5216cleanup:
5217
Janos Follathea29bfb2019-06-19 12:21:20 +01005218 cleanup_status = psa_hash_abort( &backup );
5219 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
5220 status = cleanup_status;
5221
5222 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01005223}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005224
Janos Follath844eb0e2019-06-19 12:10:49 +01005225static psa_status_t psa_key_derivation_tls12_prf_read(
5226 psa_tls12_prf_key_derivation_t *tls12_prf,
5227 psa_algorithm_t alg,
5228 uint8_t *output,
5229 size_t output_length )
5230{
5231 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
5232 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
5233 psa_status_t status;
5234 uint8_t offset, length;
5235
5236 while( output_length != 0 )
5237 {
5238 /* Check if we have fully processed the current block. */
5239 if( tls12_prf->left_in_block == 0 )
5240 {
5241 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
5242 alg );
5243 if( status != PSA_SUCCESS )
5244 return( status );
5245
5246 continue;
5247 }
5248
5249 if( tls12_prf->left_in_block > output_length )
5250 length = (uint8_t) output_length;
5251 else
5252 length = tls12_prf->left_in_block;
5253
5254 offset = hash_length - tls12_prf->left_in_block;
5255 memcpy( output, tls12_prf->output_block + offset, length );
5256 output += length;
5257 output_length -= length;
5258 tls12_prf->left_in_block -= length;
5259 }
5260
5261 return( PSA_SUCCESS );
5262}
Gilles Peskinebef7f142018-07-12 17:22:21 +02005263#endif /* MBEDTLS_MD_C */
5264
Janos Follath6c6c8fc2019-06-17 12:38:20 +01005265psa_status_t psa_key_derivation_output_bytes(
5266 psa_key_derivation_operation_t *operation,
5267 uint8_t *output,
5268 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005269{
5270 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005271 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005272
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005273 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005274 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005275 /* This is a blank operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02005276 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005277 }
5278
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005279 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005280 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005281 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005282 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005283 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02005284 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005285 goto exit;
5286 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005287 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005288 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005289 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005290 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02005291 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
5292 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005293 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02005294 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02005295 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005296 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005297 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005298
Gilles Peskinebef7f142018-07-12 17:22:21 +02005299#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005300 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02005301 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01005302 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005303 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02005304 output, output_length );
5305 }
Janos Follathadbec812019-06-14 11:05:39 +01005306 else
Janos Follathadbec812019-06-14 11:05:39 +01005307 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine969c5d62019-01-16 15:53:06 +01005308 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005309 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005310 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005311 kdf_alg, output,
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005312 output_length );
5313 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005314 else
5315#endif /* MBEDTLS_MD_C */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005316 {
5317 return( PSA_ERROR_BAD_STATE );
5318 }
5319
5320exit:
5321 if( status != PSA_SUCCESS )
5322 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005323 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005324 * This allows us to differentiate between exhausted operations and
5325 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
5326 * operations. */
5327 psa_algorithm_t alg = operation->alg;
5328 psa_key_derivation_abort( operation );
5329 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005330 memset( output, '!', output_length );
5331 }
5332 return( status );
5333}
5334
Gilles Peskine08542d82018-07-19 17:05:42 +02005335#if defined(MBEDTLS_DES_C)
5336static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
5337{
5338 if( data_size >= 8 )
5339 mbedtls_des_key_set_parity( data );
5340 if( data_size >= 16 )
5341 mbedtls_des_key_set_parity( data + 8 );
5342 if( data_size >= 24 )
5343 mbedtls_des_key_set_parity( data + 16 );
5344}
5345#endif /* MBEDTLS_DES_C */
5346
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005347static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005348 psa_key_slot_t *slot,
5349 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005350 psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005351{
5352 uint8_t *data = NULL;
5353 size_t bytes = PSA_BITS_TO_BYTES( bits );
5354 psa_status_t status;
5355
Gilles Peskine8e338702019-07-30 20:06:31 +02005356 if( ! key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005357 return( PSA_ERROR_INVALID_ARGUMENT );
5358 if( bits % 8 != 0 )
5359 return( PSA_ERROR_INVALID_ARGUMENT );
5360 data = mbedtls_calloc( 1, bytes );
5361 if( data == NULL )
5362 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5363
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005364 status = psa_key_derivation_output_bytes( operation, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005365 if( status != PSA_SUCCESS )
5366 goto exit;
Gilles Peskine08542d82018-07-19 17:05:42 +02005367#if defined(MBEDTLS_DES_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02005368 if( slot->attr.type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02005369 psa_des_set_key_parity( data, bytes );
5370#endif /* MBEDTLS_DES_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005371 status = psa_import_key_into_slot( slot, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005372
5373exit:
5374 mbedtls_free( data );
5375 return( status );
5376}
5377
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005378psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005379 psa_key_derivation_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005380 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005381{
5382 psa_status_t status;
5383 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005384 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02005385
5386 /* Reject any attempt to create a zero-length key so that we don't
5387 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
5388 if( psa_get_key_bits( attributes ) == 0 )
5389 return( PSA_ERROR_INVALID_ARGUMENT );
5390
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005391 if( ! operation->can_output_key )
5392 return( PSA_ERROR_NOT_PERMITTED );
5393
Gilles Peskinedf179142019-07-15 22:02:14 +02005394 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005395 attributes, key, &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02005396#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
5397 if( driver != NULL )
5398 {
5399 /* Deriving a key in a secure element is not implemented yet. */
5400 status = PSA_ERROR_NOT_SUPPORTED;
5401 }
5402#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005403 if( status == PSA_SUCCESS )
5404 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005405 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02005406 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005407 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005408 }
5409 if( status == PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02005410 status = psa_finish_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005411 if( status != PSA_SUCCESS )
5412 {
Gilles Peskine011e4282019-06-26 18:34:38 +02005413 psa_fail_key_creation( slot, driver );
Ronald Croncf56a0a2020-08-04 09:51:30 +02005414 *key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005415 }
5416 return( status );
5417}
5418
Gilles Peskineeab56e42018-07-12 17:12:33 +02005419
5420
5421/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02005422/* Key derivation */
5423/****************************************************************/
5424
Gilles Peskine969c5d62019-01-16 15:53:06 +01005425static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005426 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005427 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005428{
Janos Follath5fe19732019-06-20 15:09:30 +01005429 /* Make sure that operation->ctx is properly zero-initialised. (Macro
5430 * initialisers for this union leave some bytes unspecified.) */
5431 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
5432
Gilles Peskine969c5d62019-01-16 15:53:06 +01005433 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005434#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005435 if( PSA_ALG_IS_HKDF( kdf_alg ) ||
5436 PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
5437 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005438 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01005439 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005440 size_t hash_size = PSA_HASH_SIZE( hash_alg );
5441 if( hash_size == 0 )
5442 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005443 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
5444 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02005445 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005446 {
5447 return( PSA_ERROR_NOT_SUPPORTED );
5448 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005449 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01005450 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005451 }
5452#endif /* MBEDTLS_MD_C */
Gilles Peskine969c5d62019-01-16 15:53:06 +01005453 else
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005454 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005455}
5456
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005457psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005458 psa_algorithm_t alg )
5459{
5460 psa_status_t status;
5461
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005462 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005463 return( PSA_ERROR_BAD_STATE );
5464
Gilles Peskine6843c292019-01-18 16:44:49 +01005465 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
5466 return( PSA_ERROR_INVALID_ARGUMENT );
5467 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005468 {
5469 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005470 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005471 }
5472 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
5473 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005474 status = psa_key_derivation_setup_kdf( operation, alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005475 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005476 else
5477 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005478
5479 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005480 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01005481 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005482}
5483
5484#if defined(MBEDTLS_MD_C)
Gilles Peskinecbe66502019-05-16 16:59:18 +02005485static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005486 psa_algorithm_t hash_alg,
5487 psa_key_derivation_step_t step,
5488 const uint8_t *data,
5489 size_t data_length )
5490{
5491 psa_status_t status;
5492 switch( step )
5493 {
Gilles Peskine03410b52019-05-16 16:05:19 +02005494 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02005495 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005496 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005497 status = psa_hmac_setup_internal( &hkdf->hmac,
5498 data, data_length,
5499 hash_alg );
5500 if( status != PSA_SUCCESS )
5501 return( status );
5502 hkdf->state = HKDF_STATE_STARTED;
5503 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02005504 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005505 /* If no salt was provided, use an empty salt. */
5506 if( hkdf->state == HKDF_STATE_INIT )
5507 {
5508 status = psa_hmac_setup_internal( &hkdf->hmac,
5509 NULL, 0,
Gilles Peskinef9ee6332019-04-11 21:22:52 +02005510 hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005511 if( status != PSA_SUCCESS )
5512 return( status );
5513 hkdf->state = HKDF_STATE_STARTED;
5514 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02005515 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005516 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005517 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5518 data, data_length );
5519 if( status != PSA_SUCCESS )
5520 return( status );
5521 status = psa_hmac_finish_internal( &hkdf->hmac,
5522 hkdf->prk,
5523 sizeof( hkdf->prk ) );
5524 if( status != PSA_SUCCESS )
5525 return( status );
5526 hkdf->offset_in_block = PSA_HASH_SIZE( hash_alg );
5527 hkdf->block_number = 0;
5528 hkdf->state = HKDF_STATE_KEYED;
5529 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02005530 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005531 if( hkdf->state == HKDF_STATE_OUTPUT )
5532 return( PSA_ERROR_BAD_STATE );
5533 if( hkdf->info_set )
5534 return( PSA_ERROR_BAD_STATE );
5535 hkdf->info_length = data_length;
5536 if( data_length != 0 )
5537 {
5538 hkdf->info = mbedtls_calloc( 1, data_length );
5539 if( hkdf->info == NULL )
5540 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5541 memcpy( hkdf->info, data, data_length );
5542 }
5543 hkdf->info_set = 1;
5544 return( PSA_SUCCESS );
5545 default:
5546 return( PSA_ERROR_INVALID_ARGUMENT );
5547 }
5548}
Janos Follathb03233e2019-06-11 15:30:30 +01005549
Janos Follathf08e2652019-06-13 09:05:41 +01005550static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
5551 const uint8_t *data,
5552 size_t data_length )
5553{
5554 if( prf->state != TLS12_PRF_STATE_INIT )
5555 return( PSA_ERROR_BAD_STATE );
5556
Janos Follathd6dce9f2019-07-04 09:11:38 +01005557 if( data_length != 0 )
5558 {
5559 prf->seed = mbedtls_calloc( 1, data_length );
5560 if( prf->seed == NULL )
5561 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01005562
Janos Follathd6dce9f2019-07-04 09:11:38 +01005563 memcpy( prf->seed, data, data_length );
5564 prf->seed_length = data_length;
5565 }
Janos Follathf08e2652019-06-13 09:05:41 +01005566
5567 prf->state = TLS12_PRF_STATE_SEED_SET;
5568
5569 return( PSA_SUCCESS );
5570}
5571
Janos Follath81550542019-06-13 14:26:34 +01005572static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
5573 psa_algorithm_t hash_alg,
5574 const uint8_t *data,
5575 size_t data_length )
5576{
5577 psa_status_t status;
5578 if( prf->state != TLS12_PRF_STATE_SEED_SET )
5579 return( PSA_ERROR_BAD_STATE );
5580
5581 status = psa_hmac_setup_internal( &prf->hmac, data, data_length, hash_alg );
5582 if( status != PSA_SUCCESS )
5583 return( status );
5584
5585 prf->state = TLS12_PRF_STATE_KEY_SET;
5586
5587 return( PSA_SUCCESS );
5588}
5589
Janos Follath6660f0e2019-06-17 08:44:03 +01005590static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
5591 psa_tls12_prf_key_derivation_t *prf,
5592 psa_algorithm_t hash_alg,
5593 const uint8_t *data,
5594 size_t data_length )
5595{
5596 psa_status_t status;
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02005597 uint8_t pms[ 4 + 2 * PSA_ALG_TLS12_PSK_TO_MS_MAX_PSK_LEN ];
5598 uint8_t *cur = pms;
Janos Follath6660f0e2019-06-17 08:44:03 +01005599
5600 if( data_length > PSA_ALG_TLS12_PSK_TO_MS_MAX_PSK_LEN )
5601 return( PSA_ERROR_INVALID_ARGUMENT );
5602
5603 /* Quoting RFC 4279, Section 2:
5604 *
5605 * The premaster secret is formed as follows: if the PSK is N octets
5606 * long, concatenate a uint16 with the value N, N zero octets, a second
5607 * uint16 with the value N, and the PSK itself.
5608 */
5609
Janos Follath40e13932019-06-26 13:22:29 +01005610 *cur++ = ( data_length >> 8 ) & 0xff;
5611 *cur++ = ( data_length >> 0 ) & 0xff;
5612 memset( cur, 0, data_length );
5613 cur += data_length;
5614 *cur++ = pms[0];
5615 *cur++ = pms[1];
5616 memcpy( cur, data, data_length );
5617 cur += data_length;
Janos Follath6660f0e2019-06-17 08:44:03 +01005618
Janos Follath40e13932019-06-26 13:22:29 +01005619 status = psa_tls12_prf_set_key( prf, hash_alg, pms, cur - pms );
Janos Follath6660f0e2019-06-17 08:44:03 +01005620
5621 mbedtls_platform_zeroize( pms, sizeof( pms ) );
5622 return( status );
5623}
5624
Janos Follath63028dd2019-06-13 09:15:47 +01005625static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
5626 const uint8_t *data,
5627 size_t data_length )
5628{
5629 if( prf->state != TLS12_PRF_STATE_KEY_SET )
5630 return( PSA_ERROR_BAD_STATE );
5631
Janos Follathd6dce9f2019-07-04 09:11:38 +01005632 if( data_length != 0 )
5633 {
5634 prf->label = mbedtls_calloc( 1, data_length );
5635 if( prf->label == NULL )
5636 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01005637
Janos Follathd6dce9f2019-07-04 09:11:38 +01005638 memcpy( prf->label, data, data_length );
5639 prf->label_length = data_length;
5640 }
Janos Follath63028dd2019-06-13 09:15:47 +01005641
5642 prf->state = TLS12_PRF_STATE_LABEL_SET;
5643
5644 return( PSA_SUCCESS );
5645}
5646
Janos Follathb03233e2019-06-11 15:30:30 +01005647static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
5648 psa_algorithm_t hash_alg,
5649 psa_key_derivation_step_t step,
5650 const uint8_t *data,
5651 size_t data_length )
5652{
Janos Follathb03233e2019-06-11 15:30:30 +01005653 switch( step )
5654 {
Janos Follathf08e2652019-06-13 09:05:41 +01005655 case PSA_KEY_DERIVATION_INPUT_SEED:
5656 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01005657 case PSA_KEY_DERIVATION_INPUT_SECRET:
5658 return( psa_tls12_prf_set_key( prf, hash_alg, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01005659 case PSA_KEY_DERIVATION_INPUT_LABEL:
5660 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01005661 default:
5662 return( PSA_ERROR_INVALID_ARGUMENT );
5663 }
5664}
Janos Follath6660f0e2019-06-17 08:44:03 +01005665
5666static psa_status_t psa_tls12_prf_psk_to_ms_input(
5667 psa_tls12_prf_key_derivation_t *prf,
5668 psa_algorithm_t hash_alg,
5669 psa_key_derivation_step_t step,
5670 const uint8_t *data,
5671 size_t data_length )
5672{
5673 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01005674 {
Janos Follath6660f0e2019-06-17 08:44:03 +01005675 return( psa_tls12_prf_psk_to_ms_set_key( prf, hash_alg,
5676 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01005677 }
Janos Follath6660f0e2019-06-17 08:44:03 +01005678
5679 return( psa_tls12_prf_input( prf, hash_alg, step, data, data_length ) );
5680}
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005681#endif /* MBEDTLS_MD_C */
5682
Gilles Peskineb8965192019-09-24 16:21:10 +02005683/** Check whether the given key type is acceptable for the given
5684 * input step of a key derivation.
5685 *
5686 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
5687 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
5688 * Both secret and non-secret inputs can alternatively have the type
5689 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
5690 * that the input was passed as a buffer rather than via a key object.
5691 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02005692static int psa_key_derivation_check_input_type(
5693 psa_key_derivation_step_t step,
5694 psa_key_type_t key_type )
5695{
5696 switch( step )
5697 {
5698 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb8965192019-09-24 16:21:10 +02005699 if( key_type == PSA_KEY_TYPE_DERIVE )
5700 return( PSA_SUCCESS );
5701 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005702 return( PSA_SUCCESS );
5703 break;
5704 case PSA_KEY_DERIVATION_INPUT_LABEL:
5705 case PSA_KEY_DERIVATION_INPUT_SALT:
5706 case PSA_KEY_DERIVATION_INPUT_INFO:
5707 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskineb8965192019-09-24 16:21:10 +02005708 if( key_type == PSA_KEY_TYPE_RAW_DATA )
5709 return( PSA_SUCCESS );
5710 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005711 return( PSA_SUCCESS );
5712 break;
5713 }
5714 return( PSA_ERROR_INVALID_ARGUMENT );
5715}
5716
Janos Follathb80a94e2019-06-12 15:54:46 +01005717static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005718 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005719 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005720 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005721 const uint8_t *data,
5722 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005723{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02005724 psa_status_t status;
5725 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
5726
5727 status = psa_key_derivation_check_input_type( step, key_type );
Gilles Peskine224b0d62019-09-23 18:13:17 +02005728 if( status != PSA_SUCCESS )
5729 goto exit;
5730
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005731#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005732 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005733 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005734 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005735 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005736 step, data, data_length );
5737 }
k-stachowiak012dcc42019-08-13 14:55:03 +02005738 else if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005739 {
Janos Follathb03233e2019-06-11 15:30:30 +01005740 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
5741 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5742 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01005743 }
5744 else if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
5745 {
5746 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
5747 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5748 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005749 }
5750 else
5751#endif /* MBEDTLS_MD_C */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005752 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005753 /* This can't happen unless the operation object was not initialized */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005754 return( PSA_ERROR_BAD_STATE );
5755 }
5756
Gilles Peskine224b0d62019-09-23 18:13:17 +02005757exit:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005758 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005759 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005760 return( status );
5761}
5762
Janos Follath51f4a0f2019-06-14 11:35:55 +01005763psa_status_t psa_key_derivation_input_bytes(
5764 psa_key_derivation_operation_t *operation,
5765 psa_key_derivation_step_t step,
5766 const uint8_t *data,
5767 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005768{
Gilles Peskineb8965192019-09-24 16:21:10 +02005769 return( psa_key_derivation_input_internal( operation, step,
5770 PSA_KEY_TYPE_NONE,
Janos Follathc5621512019-06-14 11:27:57 +01005771 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005772}
5773
Janos Follath51f4a0f2019-06-14 11:35:55 +01005774psa_status_t psa_key_derivation_input_key(
5775 psa_key_derivation_operation_t *operation,
5776 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005777 mbedtls_svc_key_id_t key )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005778{
5779 psa_key_slot_t *slot;
5780 psa_status_t status;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005781
Ronald Croncf56a0a2020-08-04 09:51:30 +02005782 status = psa_get_transparent_key( key, &slot,
5783 PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005784 if( status != PSA_SUCCESS )
Gilles Peskine593773d2019-09-23 18:17:40 +02005785 {
5786 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005787 return( status );
Gilles Peskine593773d2019-09-23 18:17:40 +02005788 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005789
5790 /* Passing a key object as a SECRET input unlocks the permission
5791 * to output to a key object. */
5792 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5793 operation->can_output_key = 1;
5794
Janos Follathb80a94e2019-06-12 15:54:46 +01005795 return( psa_key_derivation_input_internal( operation,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005796 step, slot->attr.type,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02005797 slot->data.key.data,
5798 slot->data.key.bytes ) );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005799}
Gilles Peskineea0fb492018-07-12 17:17:20 +02005800
5801
5802
5803/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02005804/* Key agreement */
5805/****************************************************************/
5806
Gilles Peskinea05219c2018-11-16 16:02:56 +01005807#if defined(MBEDTLS_ECDH_C)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005808static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
5809 size_t peer_key_length,
5810 const mbedtls_ecp_keypair *our_key,
5811 uint8_t *shared_secret,
5812 size_t shared_secret_size,
5813 size_t *shared_secret_length )
5814{
Steven Cooremand4867872020-08-05 16:31:39 +02005815 mbedtls_ecp_keypair *their_key = NULL;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005816 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00005817 psa_status_t status;
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005818 size_t bits = 0;
Paul Elliott8ff510a2020-06-02 17:19:28 +01005819 psa_ecc_family_t curve = mbedtls_ecc_group_to_psa( our_key->grp.id, &bits );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005820 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005821
Steven Cooreman4fed4552020-08-03 14:46:03 +02005822 status = psa_load_ecp_representation( PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve),
5823 peer_key,
Steven Cooreman7f391872020-07-30 14:57:44 +02005824 peer_key_length,
Steven Cooreman7f391872020-07-30 14:57:44 +02005825 &their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00005826 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005827 goto exit;
5828
Jaeden Amero97271b32019-01-10 19:38:51 +00005829 status = mbedtls_to_psa_error(
Steven Cooremana2371e52020-07-28 14:30:39 +02005830 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
Jaeden Amero97271b32019-01-10 19:38:51 +00005831 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005832 goto exit;
Jaeden Amero97271b32019-01-10 19:38:51 +00005833 status = mbedtls_to_psa_error(
5834 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
5835 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005836 goto exit;
5837
Jaeden Amero97271b32019-01-10 19:38:51 +00005838 status = mbedtls_to_psa_error(
5839 mbedtls_ecdh_calc_secret( &ecdh,
5840 shared_secret_length,
5841 shared_secret, shared_secret_size,
5842 mbedtls_ctr_drbg_random,
5843 &global_data.ctr_drbg ) );
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005844 if( status != PSA_SUCCESS )
5845 goto exit;
5846 if( PSA_BITS_TO_BYTES( bits ) != *shared_secret_length )
5847 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005848
5849exit:
Gilles Peskine3e819b72019-12-20 14:09:55 +01005850 if( status != PSA_SUCCESS )
5851 mbedtls_platform_zeroize( shared_secret, shared_secret_size );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005852 mbedtls_ecdh_free( &ecdh );
Steven Cooremana2371e52020-07-28 14:30:39 +02005853 mbedtls_ecp_keypair_free( their_key );
Steven Cooreman6d839f02020-07-30 11:36:45 +02005854 mbedtls_free( their_key );
Steven Cooremana2371e52020-07-28 14:30:39 +02005855
Jaeden Amero97271b32019-01-10 19:38:51 +00005856 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005857}
Gilles Peskinea05219c2018-11-16 16:02:56 +01005858#endif /* MBEDTLS_ECDH_C */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005859
Gilles Peskine01d718c2018-09-18 12:01:02 +02005860#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
5861
Gilles Peskine0216fe12019-04-11 21:23:21 +02005862static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
5863 psa_key_slot_t *private_key,
5864 const uint8_t *peer_key,
5865 size_t peer_key_length,
5866 uint8_t *shared_secret,
5867 size_t shared_secret_size,
5868 size_t *shared_secret_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005869{
Gilles Peskine0216fe12019-04-11 21:23:21 +02005870 switch( alg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005871 {
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005872#if defined(MBEDTLS_ECDH_C)
Gilles Peskine0216fe12019-04-11 21:23:21 +02005873 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02005874 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005875 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremana2371e52020-07-28 14:30:39 +02005876 mbedtls_ecp_keypair *ecp = NULL;
Steven Cooreman7f391872020-07-30 14:57:44 +02005877 psa_status_t status = psa_load_ecp_representation(
Steven Cooreman4fed4552020-08-03 14:46:03 +02005878 private_key->attr.type,
Steven Cooreman7f391872020-07-30 14:57:44 +02005879 private_key->data.key.data,
5880 private_key->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02005881 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02005882 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02005883 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02005884 status = psa_key_agreement_ecdh( peer_key, peer_key_length,
Steven Cooremana2371e52020-07-28 14:30:39 +02005885 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02005886 shared_secret, shared_secret_size,
5887 shared_secret_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02005888 mbedtls_ecp_keypair_free( ecp );
5889 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02005890 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005891#endif /* MBEDTLS_ECDH_C */
Gilles Peskine01d718c2018-09-18 12:01:02 +02005892 default:
Gilles Peskine93f85002018-11-16 16:43:31 +01005893 (void) private_key;
5894 (void) peer_key;
5895 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02005896 (void) shared_secret;
5897 (void) shared_secret_size;
5898 (void) shared_secret_length;
Gilles Peskine01d718c2018-09-18 12:01:02 +02005899 return( PSA_ERROR_NOT_SUPPORTED );
5900 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02005901}
5902
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005903/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02005904 * to potentially free embedded data structures and wipe confidential data.
5905 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005906static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005907 psa_key_derivation_step_t step,
Gilles Peskine01d718c2018-09-18 12:01:02 +02005908 psa_key_slot_t *private_key,
5909 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005910 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005911{
5912 psa_status_t status;
5913 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
5914 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005915 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005916
5917 /* Step 1: run the secret agreement algorithm to generate the shared
5918 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02005919 status = psa_key_agreement_raw_internal( ka_alg,
5920 private_key,
5921 peer_key, peer_key_length,
itayzafrir0adf0fc2018-09-06 16:24:41 +03005922 shared_secret,
5923 sizeof( shared_secret ),
Gilles Peskine05d69892018-06-19 22:00:52 +02005924 &shared_secret_length );
Gilles Peskine53d991e2018-07-12 01:14:59 +02005925 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005926 goto exit;
5927
Gilles Peskineb0b255c2018-07-06 17:01:38 +02005928 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02005929 * the shared secret. A shared secret is permitted wherever a key
5930 * of type DERIVE is permitted. */
Janos Follathb80a94e2019-06-12 15:54:46 +01005931 status = psa_key_derivation_input_internal( operation, step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005932 PSA_KEY_TYPE_DERIVE,
Janos Follathb80a94e2019-06-12 15:54:46 +01005933 shared_secret,
5934 shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005935exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01005936 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005937 return( status );
5938}
5939
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005940psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005941 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005942 mbedtls_svc_key_id_t private_key,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005943 const uint8_t *peer_key,
5944 size_t peer_key_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005945{
Gilles Peskine2f060a82018-12-04 17:12:32 +01005946 psa_key_slot_t *slot;
Gilles Peskine08542d82018-07-19 17:05:42 +02005947 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005948 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005949 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine28f8f302019-07-24 13:30:31 +02005950 status = psa_get_transparent_key( private_key, &slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02005951 PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005952 if( status != PSA_SUCCESS )
5953 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005954 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01005955 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005956 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01005957 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005958 psa_key_derivation_abort( operation );
Steven Cooremanfa5e6312020-10-15 17:07:12 +02005959 else
5960 {
5961 /* If a private key has been added as SECRET, we allow the derived
5962 * key material to be used as a key in PSA Crypto. */
5963 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5964 operation->can_output_key = 1;
5965 }
Gilles Peskine346797d2018-11-16 16:05:06 +01005966 return( status );
Gilles Peskineaf3baab2018-06-27 22:55:52 +02005967}
5968
Gilles Peskinebe697d82019-05-16 18:00:41 +02005969psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005970 mbedtls_svc_key_id_t private_key,
Gilles Peskinebe697d82019-05-16 18:00:41 +02005971 const uint8_t *peer_key,
5972 size_t peer_key_length,
5973 uint8_t *output,
5974 size_t output_size,
5975 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02005976{
5977 psa_key_slot_t *slot;
5978 psa_status_t status;
5979
5980 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
5981 {
5982 status = PSA_ERROR_INVALID_ARGUMENT;
5983 goto exit;
5984 }
Gilles Peskine28f8f302019-07-24 13:30:31 +02005985 status = psa_get_transparent_key( private_key, &slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02005986 PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02005987 if( status != PSA_SUCCESS )
5988 goto exit;
5989
5990 status = psa_key_agreement_raw_internal( alg, slot,
5991 peer_key, peer_key_length,
5992 output, output_size,
5993 output_length );
5994
5995exit:
5996 if( status != PSA_SUCCESS )
5997 {
5998 /* If an error happens and is not handled properly, the output
5999 * may be used as a key to protect sensitive data. Arrange for such
6000 * a key to be random, which is likely to result in decryption or
6001 * verification errors. This is better than filling the buffer with
6002 * some constant data such as zeros, which would result in the data
6003 * being protected with a reproducible, easily knowable key.
6004 */
6005 psa_generate_random( output, output_size );
6006 *output_length = output_size;
6007 }
6008 return( status );
6009}
Gilles Peskine86a440b2018-11-12 18:39:40 +01006010
6011
6012/****************************************************************/
6013/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02006014/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02006015
Gilles Peskine4c317f42018-07-12 01:24:09 +02006016psa_status_t psa_generate_random( uint8_t *output,
Gilles Peskine53d991e2018-07-12 01:14:59 +02006017 size_t output_size )
Gilles Peskine12313cd2018-06-20 00:20:32 +02006018{
Janos Follath24eed8d2019-11-22 13:21:35 +00006019 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006020 GUARD_MODULE_INITIALIZED;
6021
Gilles Peskinef181eca2019-08-07 13:49:00 +02006022 while( output_size > MBEDTLS_CTR_DRBG_MAX_REQUEST )
6023 {
6024 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg,
6025 output,
6026 MBEDTLS_CTR_DRBG_MAX_REQUEST );
6027 if( ret != 0 )
6028 return( mbedtls_to_psa_error( ret ) );
6029 output += MBEDTLS_CTR_DRBG_MAX_REQUEST;
6030 output_size -= MBEDTLS_CTR_DRBG_MAX_REQUEST;
6031 }
6032
Gilles Peskinee59236f2018-01-27 23:32:46 +01006033 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg, output, output_size );
6034 return( mbedtls_to_psa_error( ret ) );
6035}
6036
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01006037#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
6038#include "mbedtls/entropy_poll.h"
6039
Gilles Peskine7228da22019-07-15 11:06:15 +02006040psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006041 size_t seed_size )
6042{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006043 if( global_data.initialized )
6044 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02006045
6046 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
6047 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
6048 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
6049 return( PSA_ERROR_INVALID_ARGUMENT );
6050
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01006051 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006052}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01006053#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006054
Gilles Peskinee56e8782019-04-26 17:34:02 +02006055#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_GENPRIME)
6056static psa_status_t psa_read_rsa_exponent( const uint8_t *domain_parameters,
6057 size_t domain_parameters_size,
6058 int *exponent )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006059{
Gilles Peskinee56e8782019-04-26 17:34:02 +02006060 size_t i;
6061 uint32_t acc = 0;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006062
Gilles Peskinee56e8782019-04-26 17:34:02 +02006063 if( domain_parameters_size == 0 )
6064 {
6065 *exponent = 65537;
6066 return( PSA_SUCCESS );
6067 }
6068
6069 /* Mbed TLS encodes the public exponent as an int. For simplicity, only
6070 * support values that fit in a 32-bit integer, which is larger than
6071 * int on just about every platform anyway. */
6072 if( domain_parameters_size > sizeof( acc ) )
6073 return( PSA_ERROR_NOT_SUPPORTED );
6074 for( i = 0; i < domain_parameters_size; i++ )
6075 acc = ( acc << 8 ) | domain_parameters[i];
6076 if( acc > INT_MAX )
6077 return( PSA_ERROR_NOT_SUPPORTED );
6078 *exponent = acc;
6079 return( PSA_SUCCESS );
6080}
6081#endif /* MBEDTLS_RSA_C && MBEDTLS_GENPRIME */
6082
Gilles Peskine35ef36b2019-05-16 19:42:05 +02006083static psa_status_t psa_generate_key_internal(
Gilles Peskinee56e8782019-04-26 17:34:02 +02006084 psa_key_slot_t *slot, size_t bits,
6085 const uint8_t *domain_parameters, size_t domain_parameters_size )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006086{
Gilles Peskine8e338702019-07-30 20:06:31 +02006087 psa_key_type_t type = slot->attr.type;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006088
Gilles Peskinee56e8782019-04-26 17:34:02 +02006089 if( domain_parameters == NULL && domain_parameters_size != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006090 return( PSA_ERROR_INVALID_ARGUMENT );
6091
Gilles Peskinee59236f2018-01-27 23:32:46 +01006092 if( key_type_is_raw_bytes( type ) )
6093 {
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006094 psa_status_t status;
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006095
6096 status = validate_unstructured_key_bit_size( slot->attr.type, bits );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006097 if( status != PSA_SUCCESS )
6098 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006099
6100 /* Allocate memory for the key */
Steven Cooreman75b74362020-07-28 14:30:13 +02006101 status = psa_allocate_buffer_to_slot( slot, PSA_BITS_TO_BYTES( bits ) );
6102 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02006103 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006104
Steven Cooreman71fd80d2020-07-07 21:12:27 +02006105 status = psa_generate_random( slot->data.key.data,
6106 slot->data.key.bytes );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006107 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006108 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006109
6110 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006111#if defined(MBEDTLS_DES_C)
6112 if( type == PSA_KEY_TYPE_DES )
Steven Cooreman71fd80d2020-07-07 21:12:27 +02006113 psa_des_set_key_parity( slot->data.key.data,
6114 slot->data.key.bytes );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006115#endif /* MBEDTLS_DES_C */
6116 }
6117 else
6118
6119#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_GENPRIME)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02006120 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006121 {
Steven Cooremana01795d2020-07-24 22:48:15 +02006122 mbedtls_rsa_context rsa;
Janos Follath24eed8d2019-11-22 13:21:35 +00006123 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee56e8782019-04-26 17:34:02 +02006124 int exponent;
6125 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006126 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
6127 return( PSA_ERROR_NOT_SUPPORTED );
6128 /* Accept only byte-aligned keys, for the same reasons as
6129 * in psa_import_rsa_key(). */
6130 if( bits % 8 != 0 )
6131 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinee56e8782019-04-26 17:34:02 +02006132 status = psa_read_rsa_exponent( domain_parameters,
6133 domain_parameters_size,
6134 &exponent );
6135 if( status != PSA_SUCCESS )
6136 return( status );
Steven Cooremana01795d2020-07-24 22:48:15 +02006137 mbedtls_rsa_init( &rsa, MBEDTLS_RSA_PKCS_V15, MBEDTLS_MD_NONE );
6138 ret = mbedtls_rsa_gen_key( &rsa,
Gilles Peskinee59236f2018-01-27 23:32:46 +01006139 mbedtls_ctr_drbg_random,
6140 &global_data.ctr_drbg,
6141 (unsigned int) bits,
6142 exponent );
6143 if( ret != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006144 return( mbedtls_to_psa_error( ret ) );
Steven Cooremana01795d2020-07-24 22:48:15 +02006145
6146 /* Make sure to always have an export representation available */
6147 size_t bytes = PSA_KEY_EXPORT_RSA_KEY_PAIR_MAX_SIZE( bits );
6148
Steven Cooreman75b74362020-07-28 14:30:13 +02006149 status = psa_allocate_buffer_to_slot( slot, bytes );
6150 if( status != PSA_SUCCESS )
Steven Cooremana01795d2020-07-24 22:48:15 +02006151 {
6152 mbedtls_rsa_free( &rsa );
Steven Cooreman29149862020-08-05 15:43:42 +02006153 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006154 }
Steven Cooremana01795d2020-07-24 22:48:15 +02006155
6156 status = psa_export_rsa_key( type,
6157 &rsa,
6158 slot->data.key.data,
6159 bytes,
6160 &slot->data.key.bytes );
6161 mbedtls_rsa_free( &rsa );
6162 if( status != PSA_SUCCESS )
Steven Cooremana01795d2020-07-24 22:48:15 +02006163 psa_remove_key_data_from_memory( slot );
Steven Cooreman560c28a2020-07-24 23:20:24 +02006164 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006165 }
6166 else
6167#endif /* MBEDTLS_RSA_C && MBEDTLS_GENPRIME */
6168
6169#if defined(MBEDTLS_ECP_C)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02006170 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006171 {
Paul Elliott8ff510a2020-06-02 17:19:28 +01006172 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY( type );
Gilles Peskine4295e8b2019-12-02 21:39:10 +01006173 mbedtls_ecp_group_id grp_id =
6174 mbedtls_ecc_group_of_psa( curve, PSA_BITS_TO_BYTES( bits ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006175 const mbedtls_ecp_curve_info *curve_info =
6176 mbedtls_ecp_curve_info_from_grp_id( grp_id );
Steven Cooremanacda8342020-07-24 23:09:52 +02006177 mbedtls_ecp_keypair ecp;
Janos Follath24eed8d2019-11-22 13:21:35 +00006178 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee56e8782019-04-26 17:34:02 +02006179 if( domain_parameters_size != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006180 return( PSA_ERROR_NOT_SUPPORTED );
6181 if( grp_id == MBEDTLS_ECP_DP_NONE || curve_info == NULL )
6182 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooremanacda8342020-07-24 23:09:52 +02006183 mbedtls_ecp_keypair_init( &ecp );
6184 ret = mbedtls_ecp_gen_key( grp_id, &ecp,
Gilles Peskinee59236f2018-01-27 23:32:46 +01006185 mbedtls_ctr_drbg_random,
6186 &global_data.ctr_drbg );
6187 if( ret != 0 )
6188 {
Steven Cooremanacda8342020-07-24 23:09:52 +02006189 mbedtls_ecp_keypair_free( &ecp );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006190 return( mbedtls_to_psa_error( ret ) );
6191 }
Steven Cooremanacda8342020-07-24 23:09:52 +02006192
6193
6194 /* Make sure to always have an export representation available */
6195 size_t bytes = PSA_BITS_TO_BYTES( bits );
Steven Cooreman75b74362020-07-28 14:30:13 +02006196 psa_status_t status = psa_allocate_buffer_to_slot( slot, bytes );
6197 if( status != PSA_SUCCESS )
Steven Cooremanacda8342020-07-24 23:09:52 +02006198 {
6199 mbedtls_ecp_keypair_free( &ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02006200 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02006201 }
Steven Cooreman75b74362020-07-28 14:30:13 +02006202
6203 status = mbedtls_to_psa_error(
Steven Cooremanacda8342020-07-24 23:09:52 +02006204 mbedtls_ecp_write_key( &ecp, slot->data.key.data, bytes ) );
6205
6206 mbedtls_ecp_keypair_free( &ecp );
Steven Cooremanb7f6dea2020-08-05 16:07:20 +02006207 if( status != PSA_SUCCESS ) {
6208 memset( slot->data.key.data, 0, bytes );
Steven Cooremanacda8342020-07-24 23:09:52 +02006209 psa_remove_key_data_from_memory( slot );
Steven Cooremanb7f6dea2020-08-05 16:07:20 +02006210 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02006211 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006212 }
6213 else
6214#endif /* MBEDTLS_ECP_C */
Steven Cooreman29149862020-08-05 15:43:42 +02006215 {
Gilles Peskinee59236f2018-01-27 23:32:46 +01006216 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman29149862020-08-05 15:43:42 +02006217 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01006218
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006219 return( PSA_SUCCESS );
6220}
Darryl Green0c6575a2018-11-07 16:05:30 +00006221
Gilles Peskine35ef36b2019-05-16 19:42:05 +02006222psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02006223 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006224{
6225 psa_status_t status;
6226 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02006227 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine11792082019-08-06 18:36:36 +02006228
Gilles Peskine0f84d622019-09-12 19:03:13 +02006229 /* Reject any attempt to create a zero-length key so that we don't
6230 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
6231 if( psa_get_key_bits( attributes ) == 0 )
6232 return( PSA_ERROR_INVALID_ARGUMENT );
6233
Gilles Peskinedf179142019-07-15 22:02:14 +02006234 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE,
Ronald Croncf56a0a2020-08-04 09:51:30 +02006235 attributes, key, &slot, &driver );
Gilles Peskine11792082019-08-06 18:36:36 +02006236 if( status != PSA_SUCCESS )
6237 goto exit;
6238
Steven Cooreman2a1664c2020-07-20 15:33:08 +02006239 status = psa_driver_wrapper_generate_key( attributes,
6240 slot );
6241 if( status != PSA_ERROR_NOT_SUPPORTED ||
6242 psa_key_lifetime_is_external( attributes->core.lifetime ) )
6243 goto exit;
6244
6245 status = psa_generate_key_internal(
6246 slot, attributes->core.bits,
6247 attributes->domain_parameters, attributes->domain_parameters_size );
Gilles Peskine11792082019-08-06 18:36:36 +02006248
6249exit:
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006250 if( status == PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02006251 status = psa_finish_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006252 if( status != PSA_SUCCESS )
6253 {
Gilles Peskine011e4282019-06-26 18:34:38 +02006254 psa_fail_key_creation( slot, driver );
Ronald Croncf56a0a2020-08-04 09:51:30 +02006255 *key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006256 }
Darryl Green0c6575a2018-11-07 16:05:30 +00006257 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006258}
6259
6260
Gilles Peskinee59236f2018-01-27 23:32:46 +01006261
6262/****************************************************************/
6263/* Module setup */
6264/****************************************************************/
6265
Gilles Peskine5e769522018-11-20 21:59:56 +01006266psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
6267 void (* entropy_init )( mbedtls_entropy_context *ctx ),
6268 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
6269{
6270 if( global_data.rng_state != RNG_NOT_INITIALIZED )
6271 return( PSA_ERROR_BAD_STATE );
6272 global_data.entropy_init = entropy_init;
6273 global_data.entropy_free = entropy_free;
6274 return( PSA_SUCCESS );
6275}
6276
Gilles Peskinee59236f2018-01-27 23:32:46 +01006277void mbedtls_psa_crypto_free( void )
6278{
Gilles Peskine66fb1262018-12-10 16:29:04 +01006279 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006280 if( global_data.rng_state != RNG_NOT_INITIALIZED )
6281 {
6282 mbedtls_ctr_drbg_free( &global_data.ctr_drbg );
Gilles Peskine5e769522018-11-20 21:59:56 +01006283 global_data.entropy_free( &global_data.entropy );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006284 }
6285 /* Wipe all remaining data, including configuration.
6286 * In particular, this sets all state indicator to the value
6287 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01006288 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Gilles Peskinea8ade162019-06-26 11:24:49 +02006289#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +02006290 /* Unregister all secure element drivers, so that we restart from
6291 * a pristine state. */
6292 psa_unregister_all_se_drivers( );
Gilles Peskinea8ade162019-06-26 11:24:49 +02006293#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006294}
6295
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006296#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
6297/** Recover a transaction that was interrupted by a power failure.
6298 *
6299 * This function is called during initialization, before psa_crypto_init()
6300 * returns. If this function returns a failure status, the initialization
6301 * fails.
6302 */
6303static psa_status_t psa_crypto_recover_transaction(
6304 const psa_crypto_transaction_t *transaction )
6305{
6306 switch( transaction->unknown.type )
6307 {
6308 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
6309 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01006310 /* TODO - fall through to the failure case until this
Gilles Peskinec9d7f942019-08-13 16:17:16 +02006311 * is implemented.
6312 * https://github.com/ARMmbed/mbed-crypto/issues/218
6313 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006314 default:
6315 /* We found an unsupported transaction in the storage.
6316 * We don't know what state the storage is in. Give up. */
6317 return( PSA_ERROR_STORAGE_FAILURE );
6318 }
6319}
6320#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
6321
Gilles Peskinee59236f2018-01-27 23:32:46 +01006322psa_status_t psa_crypto_init( void )
6323{
Gilles Peskine66fb1262018-12-10 16:29:04 +01006324 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006325 const unsigned char drbg_seed[] = "PSA";
6326
Gilles Peskinec6b69072018-11-20 21:42:52 +01006327 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006328 if( global_data.initialized != 0 )
6329 return( PSA_SUCCESS );
6330
Gilles Peskine5e769522018-11-20 21:59:56 +01006331 /* Set default configuration if
6332 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
6333 if( global_data.entropy_init == NULL )
6334 global_data.entropy_init = mbedtls_entropy_init;
6335 if( global_data.entropy_free == NULL )
6336 global_data.entropy_free = mbedtls_entropy_free;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006337
Gilles Peskinec6b69072018-11-20 21:42:52 +01006338 /* Initialize the random generator. */
Gilles Peskine5e769522018-11-20 21:59:56 +01006339 global_data.entropy_init( &global_data.entropy );
Jaeden Amero76541612019-06-04 17:14:43 +01006340#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
6341 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
6342 /* The PSA entropy injection feature depends on using NV seed as an entropy
6343 * source. Add NV seed as an entropy source for PSA entropy injection. */
6344 mbedtls_entropy_add_source( &global_data.entropy,
6345 mbedtls_nv_seed_poll, NULL,
6346 MBEDTLS_ENTROPY_BLOCK_SIZE,
6347 MBEDTLS_ENTROPY_SOURCE_STRONG );
6348#endif
Gilles Peskinee59236f2018-01-27 23:32:46 +01006349 mbedtls_ctr_drbg_init( &global_data.ctr_drbg );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006350 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine66fb1262018-12-10 16:29:04 +01006351 status = mbedtls_to_psa_error(
6352 mbedtls_ctr_drbg_seed( &global_data.ctr_drbg,
6353 mbedtls_entropy_func,
6354 &global_data.entropy,
6355 drbg_seed, sizeof( drbg_seed ) - 1 ) );
6356 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006357 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01006358 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006359
Gilles Peskine66fb1262018-12-10 16:29:04 +01006360 status = psa_initialize_key_slots( );
6361 if( status != PSA_SUCCESS )
6362 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01006363
Gilles Peskined9348f22019-10-01 15:22:29 +02006364#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
6365 status = psa_init_all_se_drivers( );
6366 if( status != PSA_SUCCESS )
6367 goto exit;
6368#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
6369
Gilles Peskine4b734222019-07-24 15:56:31 +02006370#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02006371 status = psa_crypto_load_transaction( );
6372 if( status == PSA_SUCCESS )
6373 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006374 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
6375 if( status != PSA_SUCCESS )
6376 goto exit;
6377 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02006378 }
6379 else if( status == PSA_ERROR_DOES_NOT_EXIST )
6380 {
6381 /* There's no transaction to complete. It's all good. */
6382 status = PSA_SUCCESS;
6383 }
Gilles Peskine4b734222019-07-24 15:56:31 +02006384#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02006385
Gilles Peskinec6b69072018-11-20 21:42:52 +01006386 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006387 global_data.initialized = 1;
6388
6389exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01006390 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006391 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01006392 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006393}
6394
6395#endif /* MBEDTLS_PSA_CRYPTO_C */