blob: ff7654a8fad3fe3aa6bb4c6b5959e474f5952e48 [file] [log] [blame]
Gilles Peskinee59236f2018-01-27 23:32:46 +01001/*
2 * PSA crypto layer on top of Mbed TLS crypto
3 */
4/* Copyright (C) 2018, ARM Limited, All Rights Reserved
5 * SPDX-License-Identifier: Apache-2.0
6 *
7 * Licensed under the Apache License, Version 2.0 (the "License"); you may
8 * not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
15 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 *
19 * This file is part of mbed TLS (https://tls.mbed.org)
20 */
21
22#if !defined(MBEDTLS_CONFIG_FILE)
23#include "mbedtls/config.h"
24#else
25#include MBEDTLS_CONFIG_FILE
26#endif
27
28#if defined(MBEDTLS_PSA_CRYPTO_C)
mohammad160327010052018-07-03 13:16:15 +030029
itayzafrir7723ab12019-02-14 10:28:02 +020030#include "psa_crypto_service_integration.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010031#include "psa/crypto.h"
32
Gilles Peskine039b90c2018-12-07 18:24:41 +010033#include "psa_crypto_core.h"
Gilles Peskine5e769522018-11-20 21:59:56 +010034#include "psa_crypto_invasive.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020035#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +020036#include "psa_crypto_se.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020037#endif
Gilles Peskine961849f2018-11-30 18:54:54 +010038#include "psa_crypto_slot_management.h"
Darryl Greend49a4992018-06-18 17:27:26 +010039/* Include internal declarations that are useful for implementing persistently
40 * stored keys. */
41#include "psa_crypto_storage.h"
42
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010043#include <stdlib.h>
44#include <string.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010045#include "mbedtls/platform.h"
Gilles Peskineff2d2002019-05-06 15:26:23 +020046#if !defined(MBEDTLS_PLATFORM_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010047#define mbedtls_calloc calloc
48#define mbedtls_free free
49#endif
50
Gilles Peskinea5905292018-02-07 20:59:33 +010051#include "mbedtls/arc4.h"
Gilles Peskine9a944802018-06-21 09:35:35 +020052#include "mbedtls/asn1.h"
Jaeden Amero6b196002019-01-10 10:23:21 +000053#include "mbedtls/asn1write.h"
Gilles Peskinea81d85b2018-06-26 16:10:23 +020054#include "mbedtls/bignum.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010055#include "mbedtls/blowfish.h"
56#include "mbedtls/camellia.h"
Gilles Peskine26869f22019-05-06 15:25:00 +020057#include "mbedtls/chacha20.h"
58#include "mbedtls/chachapoly.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010059#include "mbedtls/cipher.h"
60#include "mbedtls/ccm.h"
61#include "mbedtls/cmac.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010062#include "mbedtls/ctr_drbg.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010063#include "mbedtls/des.h"
Gilles Peskineb7ecdf02018-09-18 12:11:27 +020064#include "mbedtls/ecdh.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010065#include "mbedtls/ecp.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010066#include "mbedtls/entropy.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010067#include "mbedtls/error.h"
68#include "mbedtls/gcm.h"
69#include "mbedtls/md2.h"
70#include "mbedtls/md4.h"
71#include "mbedtls/md5.h"
Gilles Peskine20035e32018-02-03 22:44:14 +010072#include "mbedtls/md.h"
73#include "mbedtls/md_internal.h"
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010074#include "mbedtls/pk.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010075#include "mbedtls/pk_internal.h"
Gilles Peskine3f108122018-12-07 18:14:53 +010076#include "mbedtls/platform_util.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010077#include "mbedtls/ripemd160.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010078#include "mbedtls/rsa.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010079#include "mbedtls/sha1.h"
80#include "mbedtls/sha256.h"
81#include "mbedtls/sha512.h"
82#include "mbedtls/xtea.h"
83
Gilles Peskine996deb12018-08-01 15:45:45 +020084#define ARRAY_LENGTH( array ) ( sizeof( array ) / sizeof( *( array ) ) )
85
Gilles Peskine9ef733f2018-02-07 21:05:37 +010086/* constant-time buffer comparison */
87static inline int safer_memcmp( const uint8_t *a, const uint8_t *b, size_t n )
88{
89 size_t i;
90 unsigned char diff = 0;
91
92 for( i = 0; i < n; i++ )
93 diff |= a[i] ^ b[i];
94
95 return( diff );
96}
97
98
99
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100100/****************************************************************/
101/* Global data, support functions and library management */
102/****************************************************************/
103
Gilles Peskine48c0ea12018-06-21 14:15:31 +0200104static int key_type_is_raw_bytes( psa_key_type_t type )
105{
Gilles Peskine78b3bb62018-08-10 16:03:41 +0200106 return( PSA_KEY_TYPE_IS_UNSTRUCTURED( type ) );
Gilles Peskine48c0ea12018-06-21 14:15:31 +0200107}
108
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100109/* Values for psa_global_data_t::rng_state */
110#define RNG_NOT_INITIALIZED 0
111#define RNG_INITIALIZED 1
112#define RNG_SEEDED 2
Gilles Peskinec6b69072018-11-20 21:42:52 +0100113
Gilles Peskine2d277862018-06-18 15:41:12 +0200114typedef struct
115{
Gilles Peskine5e769522018-11-20 21:59:56 +0100116 void (* entropy_init )( mbedtls_entropy_context *ctx );
117 void (* entropy_free )( mbedtls_entropy_context *ctx );
Gilles Peskinee59236f2018-01-27 23:32:46 +0100118 mbedtls_entropy_context entropy;
119 mbedtls_ctr_drbg_context ctr_drbg;
Gilles Peskinec6b69072018-11-20 21:42:52 +0100120 unsigned initialized : 1;
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100121 unsigned rng_state : 2;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100122} psa_global_data_t;
123
124static psa_global_data_t global_data;
125
itayzafrir0adf0fc2018-09-06 16:24:41 +0300126#define GUARD_MODULE_INITIALIZED \
127 if( global_data.initialized == 0 ) \
128 return( PSA_ERROR_BAD_STATE );
129
Gilles Peskinee59236f2018-01-27 23:32:46 +0100130static psa_status_t mbedtls_to_psa_error( int ret )
131{
Gilles Peskinea5905292018-02-07 20:59:33 +0100132 /* If there's both a high-level code and low-level code, dispatch on
133 * the high-level code. */
134 switch( ret < -0x7f ? - ( -ret & 0x7f80 ) : ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100135 {
136 case 0:
137 return( PSA_SUCCESS );
Gilles Peskinea5905292018-02-07 20:59:33 +0100138
139 case MBEDTLS_ERR_AES_INVALID_KEY_LENGTH:
140 case MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH:
141 case MBEDTLS_ERR_AES_FEATURE_UNAVAILABLE:
142 return( PSA_ERROR_NOT_SUPPORTED );
143 case MBEDTLS_ERR_AES_HW_ACCEL_FAILED:
144 return( PSA_ERROR_HARDWARE_FAILURE );
145
146 case MBEDTLS_ERR_ARC4_HW_ACCEL_FAILED:
147 return( PSA_ERROR_HARDWARE_FAILURE );
148
Gilles Peskine9a944802018-06-21 09:35:35 +0200149 case MBEDTLS_ERR_ASN1_OUT_OF_DATA:
150 case MBEDTLS_ERR_ASN1_UNEXPECTED_TAG:
151 case MBEDTLS_ERR_ASN1_INVALID_LENGTH:
152 case MBEDTLS_ERR_ASN1_LENGTH_MISMATCH:
153 case MBEDTLS_ERR_ASN1_INVALID_DATA:
154 return( PSA_ERROR_INVALID_ARGUMENT );
155 case MBEDTLS_ERR_ASN1_ALLOC_FAILED:
156 return( PSA_ERROR_INSUFFICIENT_MEMORY );
157 case MBEDTLS_ERR_ASN1_BUF_TOO_SMALL:
158 return( PSA_ERROR_BUFFER_TOO_SMALL );
159
Jaeden Amero93e21112019-02-20 13:57:28 +0000160#if defined(MBEDTLS_ERR_BLOWFISH_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000161 case MBEDTLS_ERR_BLOWFISH_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000162#elif defined(MBEDTLS_ERR_BLOWFISH_INVALID_KEY_LENGTH)
Gilles Peskinea5905292018-02-07 20:59:33 +0100163 case MBEDTLS_ERR_BLOWFISH_INVALID_KEY_LENGTH:
Jaeden Amero93e21112019-02-20 13:57:28 +0000164#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100165 case MBEDTLS_ERR_BLOWFISH_INVALID_INPUT_LENGTH:
166 return( PSA_ERROR_NOT_SUPPORTED );
167 case MBEDTLS_ERR_BLOWFISH_HW_ACCEL_FAILED:
168 return( PSA_ERROR_HARDWARE_FAILURE );
169
Jaeden Amero93e21112019-02-20 13:57:28 +0000170#if defined(MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000171 case MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000172#elif defined(MBEDTLS_ERR_CAMELLIA_INVALID_KEY_LENGTH)
Gilles Peskinea5905292018-02-07 20:59:33 +0100173 case MBEDTLS_ERR_CAMELLIA_INVALID_KEY_LENGTH:
Jaeden Amero93e21112019-02-20 13:57:28 +0000174#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100175 case MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH:
176 return( PSA_ERROR_NOT_SUPPORTED );
177 case MBEDTLS_ERR_CAMELLIA_HW_ACCEL_FAILED:
178 return( PSA_ERROR_HARDWARE_FAILURE );
179
180 case MBEDTLS_ERR_CCM_BAD_INPUT:
181 return( PSA_ERROR_INVALID_ARGUMENT );
182 case MBEDTLS_ERR_CCM_AUTH_FAILED:
183 return( PSA_ERROR_INVALID_SIGNATURE );
184 case MBEDTLS_ERR_CCM_HW_ACCEL_FAILED:
185 return( PSA_ERROR_HARDWARE_FAILURE );
186
Gilles Peskine26869f22019-05-06 15:25:00 +0200187 case MBEDTLS_ERR_CHACHA20_BAD_INPUT_DATA:
188 return( PSA_ERROR_INVALID_ARGUMENT );
189
190 case MBEDTLS_ERR_CHACHAPOLY_BAD_STATE:
191 return( PSA_ERROR_BAD_STATE );
192 case MBEDTLS_ERR_CHACHAPOLY_AUTH_FAILED:
193 return( PSA_ERROR_INVALID_SIGNATURE );
194
Gilles Peskinea5905292018-02-07 20:59:33 +0100195 case MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE:
196 return( PSA_ERROR_NOT_SUPPORTED );
197 case MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA:
198 return( PSA_ERROR_INVALID_ARGUMENT );
199 case MBEDTLS_ERR_CIPHER_ALLOC_FAILED:
200 return( PSA_ERROR_INSUFFICIENT_MEMORY );
201 case MBEDTLS_ERR_CIPHER_INVALID_PADDING:
202 return( PSA_ERROR_INVALID_PADDING );
203 case MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED:
204 return( PSA_ERROR_BAD_STATE );
205 case MBEDTLS_ERR_CIPHER_AUTH_FAILED:
206 return( PSA_ERROR_INVALID_SIGNATURE );
207 case MBEDTLS_ERR_CIPHER_INVALID_CONTEXT:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200208 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100209 case MBEDTLS_ERR_CIPHER_HW_ACCEL_FAILED:
210 return( PSA_ERROR_HARDWARE_FAILURE );
211
212 case MBEDTLS_ERR_CMAC_HW_ACCEL_FAILED:
213 return( PSA_ERROR_HARDWARE_FAILURE );
214
215 case MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED:
216 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
217 case MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG:
218 case MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG:
219 return( PSA_ERROR_NOT_SUPPORTED );
220 case MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR:
221 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
222
223 case MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH:
224 return( PSA_ERROR_NOT_SUPPORTED );
225 case MBEDTLS_ERR_DES_HW_ACCEL_FAILED:
226 return( PSA_ERROR_HARDWARE_FAILURE );
227
Gilles Peskinee59236f2018-01-27 23:32:46 +0100228 case MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED:
229 case MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE:
230 case MBEDTLS_ERR_ENTROPY_SOURCE_FAILED:
231 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskinea5905292018-02-07 20:59:33 +0100232
233 case MBEDTLS_ERR_GCM_AUTH_FAILED:
234 return( PSA_ERROR_INVALID_SIGNATURE );
235 case MBEDTLS_ERR_GCM_BAD_INPUT:
Gilles Peskine8cac2e62018-08-21 15:07:38 +0200236 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100237 case MBEDTLS_ERR_GCM_HW_ACCEL_FAILED:
238 return( PSA_ERROR_HARDWARE_FAILURE );
239
240 case MBEDTLS_ERR_MD2_HW_ACCEL_FAILED:
241 case MBEDTLS_ERR_MD4_HW_ACCEL_FAILED:
242 case MBEDTLS_ERR_MD5_HW_ACCEL_FAILED:
243 return( PSA_ERROR_HARDWARE_FAILURE );
244
245 case MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE:
246 return( PSA_ERROR_NOT_SUPPORTED );
247 case MBEDTLS_ERR_MD_BAD_INPUT_DATA:
248 return( PSA_ERROR_INVALID_ARGUMENT );
249 case MBEDTLS_ERR_MD_ALLOC_FAILED:
250 return( PSA_ERROR_INSUFFICIENT_MEMORY );
251 case MBEDTLS_ERR_MD_FILE_IO_ERROR:
252 return( PSA_ERROR_STORAGE_FAILURE );
253 case MBEDTLS_ERR_MD_HW_ACCEL_FAILED:
254 return( PSA_ERROR_HARDWARE_FAILURE );
255
Gilles Peskinef76aa772018-10-29 19:24:33 +0100256 case MBEDTLS_ERR_MPI_FILE_IO_ERROR:
257 return( PSA_ERROR_STORAGE_FAILURE );
258 case MBEDTLS_ERR_MPI_BAD_INPUT_DATA:
259 return( PSA_ERROR_INVALID_ARGUMENT );
260 case MBEDTLS_ERR_MPI_INVALID_CHARACTER:
261 return( PSA_ERROR_INVALID_ARGUMENT );
262 case MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL:
263 return( PSA_ERROR_BUFFER_TOO_SMALL );
264 case MBEDTLS_ERR_MPI_NEGATIVE_VALUE:
265 return( PSA_ERROR_INVALID_ARGUMENT );
266 case MBEDTLS_ERR_MPI_DIVISION_BY_ZERO:
267 return( PSA_ERROR_INVALID_ARGUMENT );
268 case MBEDTLS_ERR_MPI_NOT_ACCEPTABLE:
269 return( PSA_ERROR_INVALID_ARGUMENT );
270 case MBEDTLS_ERR_MPI_ALLOC_FAILED:
271 return( PSA_ERROR_INSUFFICIENT_MEMORY );
272
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100273 case MBEDTLS_ERR_PK_ALLOC_FAILED:
274 return( PSA_ERROR_INSUFFICIENT_MEMORY );
275 case MBEDTLS_ERR_PK_TYPE_MISMATCH:
276 case MBEDTLS_ERR_PK_BAD_INPUT_DATA:
277 return( PSA_ERROR_INVALID_ARGUMENT );
278 case MBEDTLS_ERR_PK_FILE_IO_ERROR:
Gilles Peskinea5905292018-02-07 20:59:33 +0100279 return( PSA_ERROR_STORAGE_FAILURE );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100280 case MBEDTLS_ERR_PK_KEY_INVALID_VERSION:
281 case MBEDTLS_ERR_PK_KEY_INVALID_FORMAT:
282 return( PSA_ERROR_INVALID_ARGUMENT );
283 case MBEDTLS_ERR_PK_UNKNOWN_PK_ALG:
284 return( PSA_ERROR_NOT_SUPPORTED );
285 case MBEDTLS_ERR_PK_PASSWORD_REQUIRED:
286 case MBEDTLS_ERR_PK_PASSWORD_MISMATCH:
287 return( PSA_ERROR_NOT_PERMITTED );
288 case MBEDTLS_ERR_PK_INVALID_PUBKEY:
289 return( PSA_ERROR_INVALID_ARGUMENT );
290 case MBEDTLS_ERR_PK_INVALID_ALG:
291 case MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE:
292 case MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE:
293 return( PSA_ERROR_NOT_SUPPORTED );
294 case MBEDTLS_ERR_PK_SIG_LEN_MISMATCH:
295 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskinea5905292018-02-07 20:59:33 +0100296 case MBEDTLS_ERR_PK_HW_ACCEL_FAILED:
297 return( PSA_ERROR_HARDWARE_FAILURE );
298
Gilles Peskineff2d2002019-05-06 15:26:23 +0200299 case MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED:
300 return( PSA_ERROR_HARDWARE_FAILURE );
301 case MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED:
302 return( PSA_ERROR_NOT_SUPPORTED );
303
Gilles Peskinea5905292018-02-07 20:59:33 +0100304 case MBEDTLS_ERR_RIPEMD160_HW_ACCEL_FAILED:
305 return( PSA_ERROR_HARDWARE_FAILURE );
306
307 case MBEDTLS_ERR_RSA_BAD_INPUT_DATA:
308 return( PSA_ERROR_INVALID_ARGUMENT );
309 case MBEDTLS_ERR_RSA_INVALID_PADDING:
310 return( PSA_ERROR_INVALID_PADDING );
311 case MBEDTLS_ERR_RSA_KEY_GEN_FAILED:
312 return( PSA_ERROR_HARDWARE_FAILURE );
313 case MBEDTLS_ERR_RSA_KEY_CHECK_FAILED:
314 return( PSA_ERROR_INVALID_ARGUMENT );
315 case MBEDTLS_ERR_RSA_PUBLIC_FAILED:
316 case MBEDTLS_ERR_RSA_PRIVATE_FAILED:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200317 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100318 case MBEDTLS_ERR_RSA_VERIFY_FAILED:
319 return( PSA_ERROR_INVALID_SIGNATURE );
320 case MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE:
321 return( PSA_ERROR_BUFFER_TOO_SMALL );
322 case MBEDTLS_ERR_RSA_RNG_FAILED:
323 return( PSA_ERROR_INSUFFICIENT_MEMORY );
324 case MBEDTLS_ERR_RSA_UNSUPPORTED_OPERATION:
325 return( PSA_ERROR_NOT_SUPPORTED );
326 case MBEDTLS_ERR_RSA_HW_ACCEL_FAILED:
327 return( PSA_ERROR_HARDWARE_FAILURE );
328
329 case MBEDTLS_ERR_SHA1_HW_ACCEL_FAILED:
330 case MBEDTLS_ERR_SHA256_HW_ACCEL_FAILED:
331 case MBEDTLS_ERR_SHA512_HW_ACCEL_FAILED:
332 return( PSA_ERROR_HARDWARE_FAILURE );
333
334 case MBEDTLS_ERR_XTEA_INVALID_INPUT_LENGTH:
335 return( PSA_ERROR_INVALID_ARGUMENT );
336 case MBEDTLS_ERR_XTEA_HW_ACCEL_FAILED:
337 return( PSA_ERROR_HARDWARE_FAILURE );
338
itayzafrir5c753392018-05-08 11:18:38 +0300339 case MBEDTLS_ERR_ECP_BAD_INPUT_DATA:
itayzafrir7b30f8b2018-05-09 16:07:36 +0300340 case MBEDTLS_ERR_ECP_INVALID_KEY:
itayzafrir5c753392018-05-08 11:18:38 +0300341 return( PSA_ERROR_INVALID_ARGUMENT );
itayzafrir7b30f8b2018-05-09 16:07:36 +0300342 case MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL:
343 return( PSA_ERROR_BUFFER_TOO_SMALL );
344 case MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE:
345 return( PSA_ERROR_NOT_SUPPORTED );
346 case MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH:
347 case MBEDTLS_ERR_ECP_VERIFY_FAILED:
348 return( PSA_ERROR_INVALID_SIGNATURE );
349 case MBEDTLS_ERR_ECP_ALLOC_FAILED:
350 return( PSA_ERROR_INSUFFICIENT_MEMORY );
351 case MBEDTLS_ERR_ECP_HW_ACCEL_FAILED:
352 return( PSA_ERROR_HARDWARE_FAILURE );
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
Darryl Green8f8aa8f2018-07-24 15:44:51 +0100366#if defined(MBEDTLS_ECP_C)
Gilles Peskine34ef7f52018-06-18 20:47:51 +0200367static psa_ecc_curve_t mbedtls_ecc_group_to_psa( mbedtls_ecp_group_id grpid )
368{
369 switch( grpid )
370 {
371 case MBEDTLS_ECP_DP_SECP192R1:
372 return( PSA_ECC_CURVE_SECP192R1 );
373 case MBEDTLS_ECP_DP_SECP224R1:
374 return( PSA_ECC_CURVE_SECP224R1 );
375 case MBEDTLS_ECP_DP_SECP256R1:
376 return( PSA_ECC_CURVE_SECP256R1 );
377 case MBEDTLS_ECP_DP_SECP384R1:
378 return( PSA_ECC_CURVE_SECP384R1 );
379 case MBEDTLS_ECP_DP_SECP521R1:
380 return( PSA_ECC_CURVE_SECP521R1 );
381 case MBEDTLS_ECP_DP_BP256R1:
382 return( PSA_ECC_CURVE_BRAINPOOL_P256R1 );
383 case MBEDTLS_ECP_DP_BP384R1:
384 return( PSA_ECC_CURVE_BRAINPOOL_P384R1 );
385 case MBEDTLS_ECP_DP_BP512R1:
386 return( PSA_ECC_CURVE_BRAINPOOL_P512R1 );
387 case MBEDTLS_ECP_DP_CURVE25519:
388 return( PSA_ECC_CURVE_CURVE25519 );
389 case MBEDTLS_ECP_DP_SECP192K1:
390 return( PSA_ECC_CURVE_SECP192K1 );
391 case MBEDTLS_ECP_DP_SECP224K1:
392 return( PSA_ECC_CURVE_SECP224K1 );
393 case MBEDTLS_ECP_DP_SECP256K1:
394 return( PSA_ECC_CURVE_SECP256K1 );
395 case MBEDTLS_ECP_DP_CURVE448:
396 return( PSA_ECC_CURVE_CURVE448 );
397 default:
398 return( 0 );
399 }
400}
401
Gilles Peskine12313cd2018-06-20 00:20:32 +0200402static mbedtls_ecp_group_id mbedtls_ecc_group_of_psa( psa_ecc_curve_t curve )
403{
404 switch( curve )
405 {
406 case PSA_ECC_CURVE_SECP192R1:
407 return( MBEDTLS_ECP_DP_SECP192R1 );
408 case PSA_ECC_CURVE_SECP224R1:
409 return( MBEDTLS_ECP_DP_SECP224R1 );
410 case PSA_ECC_CURVE_SECP256R1:
411 return( MBEDTLS_ECP_DP_SECP256R1 );
412 case PSA_ECC_CURVE_SECP384R1:
413 return( MBEDTLS_ECP_DP_SECP384R1 );
414 case PSA_ECC_CURVE_SECP521R1:
415 return( MBEDTLS_ECP_DP_SECP521R1 );
416 case PSA_ECC_CURVE_BRAINPOOL_P256R1:
417 return( MBEDTLS_ECP_DP_BP256R1 );
418 case PSA_ECC_CURVE_BRAINPOOL_P384R1:
419 return( MBEDTLS_ECP_DP_BP384R1 );
420 case PSA_ECC_CURVE_BRAINPOOL_P512R1:
421 return( MBEDTLS_ECP_DP_BP512R1 );
422 case PSA_ECC_CURVE_CURVE25519:
423 return( MBEDTLS_ECP_DP_CURVE25519 );
424 case PSA_ECC_CURVE_SECP192K1:
425 return( MBEDTLS_ECP_DP_SECP192K1 );
426 case PSA_ECC_CURVE_SECP224K1:
427 return( MBEDTLS_ECP_DP_SECP224K1 );
428 case PSA_ECC_CURVE_SECP256K1:
429 return( MBEDTLS_ECP_DP_SECP256K1 );
430 case PSA_ECC_CURVE_CURVE448:
431 return( MBEDTLS_ECP_DP_CURVE448 );
432 default:
433 return( MBEDTLS_ECP_DP_NONE );
434 }
435}
Darryl Green8f8aa8f2018-07-24 15:44:51 +0100436#endif /* defined(MBEDTLS_ECP_C) */
Gilles Peskine12313cd2018-06-20 00:20:32 +0200437
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200438static psa_status_t prepare_raw_data_slot( psa_key_type_t type,
439 size_t bits,
440 struct raw_data *raw )
441{
442 /* Check that the bit size is acceptable for the key type */
443 switch( type )
444 {
445 case PSA_KEY_TYPE_RAW_DATA:
Gilles Peskine46f1fd72018-06-28 19:31:31 +0200446 if( bits == 0 )
447 {
448 raw->bytes = 0;
449 raw->data = NULL;
450 return( PSA_SUCCESS );
451 }
452 break;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200453#if defined(MBEDTLS_MD_C)
454 case PSA_KEY_TYPE_HMAC:
Gilles Peskine46f1fd72018-06-28 19:31:31 +0200455#endif
Gilles Peskineea0fb492018-07-12 17:17:20 +0200456 case PSA_KEY_TYPE_DERIVE:
457 break;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200458#if defined(MBEDTLS_AES_C)
459 case PSA_KEY_TYPE_AES:
460 if( bits != 128 && bits != 192 && bits != 256 )
461 return( PSA_ERROR_INVALID_ARGUMENT );
462 break;
463#endif
464#if defined(MBEDTLS_CAMELLIA_C)
465 case PSA_KEY_TYPE_CAMELLIA:
466 if( bits != 128 && bits != 192 && bits != 256 )
467 return( PSA_ERROR_INVALID_ARGUMENT );
468 break;
469#endif
470#if defined(MBEDTLS_DES_C)
471 case PSA_KEY_TYPE_DES:
472 if( bits != 64 && bits != 128 && bits != 192 )
473 return( PSA_ERROR_INVALID_ARGUMENT );
474 break;
475#endif
476#if defined(MBEDTLS_ARC4_C)
477 case PSA_KEY_TYPE_ARC4:
478 if( bits < 8 || bits > 2048 )
479 return( PSA_ERROR_INVALID_ARGUMENT );
480 break;
481#endif
Gilles Peskine26869f22019-05-06 15:25:00 +0200482#if defined(MBEDTLS_CHACHA20_C)
483 case PSA_KEY_TYPE_CHACHA20:
484 if( bits != 256 )
485 return( PSA_ERROR_INVALID_ARGUMENT );
486 break;
487#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200488 default:
489 return( PSA_ERROR_NOT_SUPPORTED );
490 }
Gilles Peskineb54979a2018-06-21 09:32:47 +0200491 if( bits % 8 != 0 )
492 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200493
494 /* Allocate memory for the key */
495 raw->bytes = PSA_BITS_TO_BYTES( bits );
496 raw->data = mbedtls_calloc( 1, raw->bytes );
497 if( raw->data == NULL )
498 {
499 raw->bytes = 0;
500 return( PSA_ERROR_INSUFFICIENT_MEMORY );
501 }
502 return( PSA_SUCCESS );
503}
504
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200505#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PK_PARSE_C)
Gilles Peskine86a440b2018-11-12 18:39:40 +0100506/* Mbed TLS doesn't support non-byte-aligned key sizes (i.e. key sizes
507 * that are not a multiple of 8) well. For example, there is only
508 * mbedtls_rsa_get_len(), which returns a number of bytes, and no
509 * way to return the exact bit size of a key.
510 * To keep things simple, reject non-byte-aligned key sizes. */
511static psa_status_t psa_check_rsa_key_byte_aligned(
512 const mbedtls_rsa_context *rsa )
513{
514 mbedtls_mpi n;
515 psa_status_t status;
516 mbedtls_mpi_init( &n );
517 status = mbedtls_to_psa_error(
518 mbedtls_rsa_export( rsa, &n, NULL, NULL, NULL, NULL ) );
519 if( status == PSA_SUCCESS )
520 {
521 if( mbedtls_mpi_bitlen( &n ) % 8 != 0 )
522 status = PSA_ERROR_NOT_SUPPORTED;
523 }
524 mbedtls_mpi_free( &n );
525 return( status );
526}
527
Jaeden Ameroec6ff862019-01-11 17:53:05 +0000528static psa_status_t psa_import_rsa_key( psa_key_type_t type,
529 const uint8_t *data,
530 size_t data_length,
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200531 mbedtls_rsa_context **p_rsa )
532{
Jaeden Ameroec6ff862019-01-11 17:53:05 +0000533 psa_status_t status;
534 mbedtls_pk_context pk;
535 mbedtls_rsa_context *rsa;
536 size_t bits;
537
538 mbedtls_pk_init( &pk );
539
540 /* Parse the data. */
Gilles Peskinec93b80c2019-05-16 19:39:54 +0200541 if( PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Jaeden Ameroec6ff862019-01-11 17:53:05 +0000542 status = mbedtls_to_psa_error(
543 mbedtls_pk_parse_key( &pk, data, data_length, NULL, 0 ) );
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200544 else
Jaeden Ameroec6ff862019-01-11 17:53:05 +0000545 status = mbedtls_to_psa_error(
546 mbedtls_pk_parse_public_key( &pk, data, data_length ) );
547 if( status != PSA_SUCCESS )
548 goto exit;
549
550 /* We have something that the pkparse module recognizes. If it is a
551 * valid RSA key, store it. */
552 if( mbedtls_pk_get_type( &pk ) != MBEDTLS_PK_RSA )
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200553 {
Jaeden Ameroec6ff862019-01-11 17:53:05 +0000554 status = PSA_ERROR_INVALID_ARGUMENT;
555 goto exit;
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200556 }
Jaeden Ameroec6ff862019-01-11 17:53:05 +0000557
558 rsa = mbedtls_pk_rsa( pk );
559 /* 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. */
562 bits = PSA_BYTES_TO_BITS( mbedtls_rsa_get_len( rsa ) );
563 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
564 {
565 status = PSA_ERROR_NOT_SUPPORTED;
566 goto exit;
567 }
568 status = psa_check_rsa_key_byte_aligned( rsa );
569
570exit:
571 /* Free the content of the pk object only on error. */
572 if( status != PSA_SUCCESS )
573 {
574 mbedtls_pk_free( &pk );
575 return( status );
576 }
577
578 /* On success, store the content of the object in the RSA context. */
579 *p_rsa = rsa;
580
581 return( PSA_SUCCESS );
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200582}
583#endif /* defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PK_PARSE_C) */
584
Jaeden Amero0ae445f2019-01-10 11:42:27 +0000585#if defined(MBEDTLS_ECP_C)
586
587/* Import a public key given as the uncompressed representation defined by SEC1
588 * 2.3.3 as the content of an ECPoint. */
589static psa_status_t psa_import_ec_public_key( psa_ecc_curve_t curve,
590 const uint8_t *data,
591 size_t data_length,
592 mbedtls_ecp_keypair **p_ecp )
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200593{
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200594 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jaeden Amero0ae445f2019-01-10 11:42:27 +0000595 mbedtls_ecp_keypair *ecp = NULL;
596 mbedtls_ecp_group_id grp_id = mbedtls_ecc_group_of_psa( curve );
597
598 *p_ecp = NULL;
599 ecp = mbedtls_calloc( 1, sizeof( *ecp ) );
600 if( ecp == NULL )
601 return( PSA_ERROR_INSUFFICIENT_MEMORY );
602 mbedtls_ecp_keypair_init( ecp );
603
604 /* Load the group. */
605 status = mbedtls_to_psa_error(
606 mbedtls_ecp_group_load( &ecp->grp, grp_id ) );
607 if( status != PSA_SUCCESS )
608 goto exit;
609 /* Load the public value. */
610 status = mbedtls_to_psa_error(
611 mbedtls_ecp_point_read_binary( &ecp->grp, &ecp->Q,
612 data, data_length ) );
613 if( status != PSA_SUCCESS )
614 goto exit;
615
616 /* Check that the point is on the curve. */
617 status = mbedtls_to_psa_error(
618 mbedtls_ecp_check_pubkey( &ecp->grp, &ecp->Q ) );
619 if( status != PSA_SUCCESS )
620 goto exit;
621
622 *p_ecp = ecp;
623 return( PSA_SUCCESS );
624
625exit:
626 if( ecp != NULL )
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200627 {
Jaeden Amero0ae445f2019-01-10 11:42:27 +0000628 mbedtls_ecp_keypair_free( ecp );
629 mbedtls_free( ecp );
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200630 }
Jaeden Amero0ae445f2019-01-10 11:42:27 +0000631 return( status );
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200632}
Jaeden Amero0ae445f2019-01-10 11:42:27 +0000633#endif /* defined(MBEDTLS_ECP_C) */
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200634
Gilles Peskinef76aa772018-10-29 19:24:33 +0100635#if defined(MBEDTLS_ECP_C)
636/* Import a private key given as a byte string which is the private value
637 * in big-endian order. */
638static psa_status_t psa_import_ec_private_key( psa_ecc_curve_t curve,
639 const uint8_t *data,
640 size_t data_length,
641 mbedtls_ecp_keypair **p_ecp )
642{
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200643 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100644 mbedtls_ecp_keypair *ecp = NULL;
645 mbedtls_ecp_group_id grp_id = mbedtls_ecc_group_of_psa( curve );
646
Gilles Peskinec9d910b2019-05-13 14:21:57 +0200647 if( PSA_BITS_TO_BYTES( PSA_ECC_CURVE_BITS( curve ) ) != data_length )
648 return( PSA_ERROR_INVALID_ARGUMENT );
649
Gilles Peskinef76aa772018-10-29 19:24:33 +0100650 *p_ecp = NULL;
651 ecp = mbedtls_calloc( 1, sizeof( mbedtls_ecp_keypair ) );
652 if( ecp == NULL )
653 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Jaeden Amero83d29392019-01-10 20:17:42 +0000654 mbedtls_ecp_keypair_init( ecp );
Gilles Peskinef76aa772018-10-29 19:24:33 +0100655
656 /* Load the group. */
657 status = mbedtls_to_psa_error(
658 mbedtls_ecp_group_load( &ecp->grp, grp_id ) );
659 if( status != PSA_SUCCESS )
660 goto exit;
661 /* Load the secret value. */
662 status = mbedtls_to_psa_error(
663 mbedtls_mpi_read_binary( &ecp->d, data, data_length ) );
664 if( status != PSA_SUCCESS )
665 goto exit;
666 /* Validate the private key. */
667 status = mbedtls_to_psa_error(
668 mbedtls_ecp_check_privkey( &ecp->grp, &ecp->d ) );
669 if( status != PSA_SUCCESS )
670 goto exit;
671 /* Calculate the public key from the private key. */
672 status = mbedtls_to_psa_error(
673 mbedtls_ecp_mul( &ecp->grp, &ecp->Q, &ecp->d, &ecp->grp.G,
674 mbedtls_ctr_drbg_random, &global_data.ctr_drbg ) );
675 if( status != PSA_SUCCESS )
676 goto exit;
677
678 *p_ecp = ecp;
679 return( PSA_SUCCESS );
680
681exit:
682 if( ecp != NULL )
683 {
684 mbedtls_ecp_keypair_free( ecp );
685 mbedtls_free( ecp );
686 }
687 return( status );
688}
689#endif /* defined(MBEDTLS_ECP_C) */
690
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100691/** Import key data into a slot. `slot->type` must have been set
692 * previously. This function assumes that the slot does not contain
693 * any key material yet. On failure, the slot content is unchanged. */
Gilles Peskinefa4135b2018-12-10 16:48:53 +0100694psa_status_t psa_import_key_into_slot( psa_key_slot_t *slot,
695 const uint8_t *data,
696 size_t data_length )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100697{
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200698 psa_status_t status = PSA_SUCCESS;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100699
Darryl Green940d72c2018-07-13 13:18:51 +0100700 if( key_type_is_raw_bytes( slot->type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100701 {
Gilles Peskine6d912132018-03-07 16:41:37 +0100702 /* Ensure that a bytes-to-bit conversion won't overflow. */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100703 if( data_length > SIZE_MAX / 8 )
704 return( PSA_ERROR_NOT_SUPPORTED );
Darryl Green940d72c2018-07-13 13:18:51 +0100705 status = prepare_raw_data_slot( slot->type,
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200706 PSA_BYTES_TO_BITS( data_length ),
707 &slot->data.raw );
708 if( status != PSA_SUCCESS )
709 return( status );
Gilles Peskine46f1fd72018-06-28 19:31:31 +0200710 if( data_length != 0 )
711 memcpy( slot->data.raw.data, data, data_length );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100712 }
713 else
Gilles Peskinef76aa772018-10-29 19:24:33 +0100714#if defined(MBEDTLS_ECP_C)
Gilles Peskinec93b80c2019-05-16 19:39:54 +0200715 if( PSA_KEY_TYPE_IS_ECC_KEY_PAIR( slot->type ) )
Gilles Peskinef76aa772018-10-29 19:24:33 +0100716 {
Darryl Green940d72c2018-07-13 13:18:51 +0100717 status = psa_import_ec_private_key( PSA_KEY_TYPE_GET_CURVE( slot->type ),
Gilles Peskinef76aa772018-10-29 19:24:33 +0100718 data, data_length,
719 &slot->data.ecp );
Gilles Peskinef76aa772018-10-29 19:24:33 +0100720 }
Jaeden Amero0ae445f2019-01-10 11:42:27 +0000721 else if( PSA_KEY_TYPE_IS_ECC_PUBLIC_KEY( slot->type ) )
722 {
723 status = psa_import_ec_public_key(
724 PSA_KEY_TYPE_GET_CURVE( slot->type ),
725 data, data_length,
726 &slot->data.ecp );
Jaeden Amero0ae445f2019-01-10 11:42:27 +0000727 }
Gilles Peskinef76aa772018-10-29 19:24:33 +0100728 else
729#endif /* MBEDTLS_ECP_C */
Jaeden Amero0ae445f2019-01-10 11:42:27 +0000730#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PK_PARSE_C)
731 if( PSA_KEY_TYPE_IS_RSA( slot->type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100732 {
Jaeden Ameroec6ff862019-01-11 17:53:05 +0000733 status = psa_import_rsa_key( slot->type,
734 data, data_length,
735 &slot->data.rsa );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100736 }
737 else
Jaeden Amero0ae445f2019-01-10 11:42:27 +0000738#endif /* defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PK_PARSE_C) */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100739 {
740 return( PSA_ERROR_NOT_SUPPORTED );
741 }
Jaeden Amero08ad3272019-01-14 13:12:39 +0000742 return( status );
Darryl Green940d72c2018-07-13 13:18:51 +0100743}
744
Gilles Peskine4cb9dde2019-01-19 13:40:11 +0100745/** Calculate the intersection of two algorithm usage policies.
746 *
747 * Return 0 (which allows no operation) on incompatibility.
748 */
749static psa_algorithm_t psa_key_policy_algorithm_intersection(
750 psa_algorithm_t alg1,
751 psa_algorithm_t alg2 )
752{
Gilles Peskinef25c9ec2019-05-22 11:45:59 +0200753 /* Common case: both sides actually specify the same policy. */
Gilles Peskine4cb9dde2019-01-19 13:40:11 +0100754 if( alg1 == alg2 )
755 return( alg1 );
756 /* If the policies are from the same hash-and-sign family, check
Gilles Peskinef603c712019-01-19 13:40:11 +0100757 * if one is a wildcard. If so the other has the specific algorithm. */
Gilles Peskine4cb9dde2019-01-19 13:40:11 +0100758 if( PSA_ALG_IS_HASH_AND_SIGN( alg1 ) &&
759 PSA_ALG_IS_HASH_AND_SIGN( alg2 ) &&
760 ( alg1 & ~PSA_ALG_HASH_MASK ) == ( alg2 & ~PSA_ALG_HASH_MASK ) )
761 {
762 if( PSA_ALG_SIGN_GET_HASH( alg1 ) == PSA_ALG_ANY_HASH )
763 return( alg2 );
Gilles Peskinef603c712019-01-19 13:40:11 +0100764 if( PSA_ALG_SIGN_GET_HASH( alg2 ) == PSA_ALG_ANY_HASH )
Gilles Peskine4cb9dde2019-01-19 13:40:11 +0100765 return( alg1 );
766 }
767 /* If the policies are incompatible, allow nothing. */
768 return( 0 );
769}
770
Gilles Peskine96f0b3b2019-05-10 19:33:38 +0200771static int psa_key_algorithm_permits( psa_algorithm_t policy_alg,
772 psa_algorithm_t requested_alg )
773{
Gilles Peskinef25c9ec2019-05-22 11:45:59 +0200774 /* Common case: the policy only allows requested_alg. */
Gilles Peskine96f0b3b2019-05-10 19:33:38 +0200775 if( requested_alg == policy_alg )
776 return( 1 );
777 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
Gilles Peskinef25c9ec2019-05-22 11:45:59 +0200778 * and requested_alg is the same hash-and-sign family with any hash,
779 * then requested_alg is compliant with policy_alg. */
Gilles Peskine96f0b3b2019-05-10 19:33:38 +0200780 if( PSA_ALG_IS_HASH_AND_SIGN( requested_alg ) &&
781 PSA_ALG_SIGN_GET_HASH( policy_alg ) == PSA_ALG_ANY_HASH )
782 {
783 return( ( policy_alg & ~PSA_ALG_HASH_MASK ) ==
784 ( requested_alg & ~PSA_ALG_HASH_MASK ) );
785 }
786 /* If it isn't permitted, it's forbidden. */
787 return( 0 );
788}
789
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100790/** Test whether a policy permits an algorithm.
791 *
792 * The caller must test usage flags separately.
793 */
794static int psa_key_policy_permits( const psa_key_policy_t *policy,
795 psa_algorithm_t alg )
796{
Gilles Peskine96f0b3b2019-05-10 19:33:38 +0200797 return( psa_key_algorithm_permits( policy->alg, alg ) ||
798 psa_key_algorithm_permits( policy->alg2, alg ) );
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100799}
800
Gilles Peskinef603c712019-01-19 13:40:11 +0100801/** Restrict a key policy based on a constraint.
802 *
803 * \param[in,out] policy The policy to restrict.
804 * \param[in] constraint The policy constraint to apply.
805 *
806 * \retval #PSA_SUCCESS
807 * \c *policy contains the intersection of the original value of
808 * \c *policy and \c *constraint.
809 * \retval #PSA_ERROR_INVALID_ARGUMENT
810 * \c *policy and \c *constraint are incompatible.
811 * \c *policy is unchanged.
812 */
Gilles Peskine4cb9dde2019-01-19 13:40:11 +0100813static psa_status_t psa_restrict_key_policy(
814 psa_key_policy_t *policy,
815 const psa_key_policy_t *constraint )
816{
817 psa_algorithm_t intersection_alg =
818 psa_key_policy_algorithm_intersection( policy->alg, constraint->alg );
Gilles Peskine96f0b3b2019-05-10 19:33:38 +0200819 psa_algorithm_t intersection_alg2 =
820 psa_key_policy_algorithm_intersection( policy->alg2, constraint->alg2 );
Gilles Peskine4cb9dde2019-01-19 13:40:11 +0100821 if( intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0 )
822 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine96f0b3b2019-05-10 19:33:38 +0200823 if( intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0 )
824 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine4cb9dde2019-01-19 13:40:11 +0100825 policy->usage &= constraint->usage;
Gilles Peskinef603c712019-01-19 13:40:11 +0100826 policy->alg = intersection_alg;
Gilles Peskine96f0b3b2019-05-10 19:33:38 +0200827 policy->alg2 = intersection_alg2;
Gilles Peskine4cb9dde2019-01-19 13:40:11 +0100828 return( PSA_SUCCESS );
829}
830
Darryl Green06fd18d2018-07-16 11:21:11 +0100831/** Retrieve a slot which must contain a key. The key must have allow all the
832 * usage flags set in \p usage. If \p alg is nonzero, the key must allow
833 * operations with this algorithm. */
Gilles Peskinec5487a82018-12-03 18:08:14 +0100834static psa_status_t psa_get_key_from_slot( psa_key_handle_t handle,
Gilles Peskine2f060a82018-12-04 17:12:32 +0100835 psa_key_slot_t **p_slot,
Darryl Green06fd18d2018-07-16 11:21:11 +0100836 psa_key_usage_t usage,
837 psa_algorithm_t alg )
838{
839 psa_status_t status;
Gilles Peskine2f060a82018-12-04 17:12:32 +0100840 psa_key_slot_t *slot = NULL;
Darryl Green06fd18d2018-07-16 11:21:11 +0100841
842 *p_slot = NULL;
843
Gilles Peskinec5487a82018-12-03 18:08:14 +0100844 status = psa_get_key_slot( handle, &slot );
Darryl Green06fd18d2018-07-16 11:21:11 +0100845 if( status != PSA_SUCCESS )
846 return( status );
847 if( slot->type == PSA_KEY_TYPE_NONE )
David Saadab4ecc272019-02-14 13:48:10 +0200848 return( PSA_ERROR_DOES_NOT_EXIST );
Darryl Green06fd18d2018-07-16 11:21:11 +0100849
850 /* Enforce that usage policy for the key slot contains all the flags
851 * required by the usage parameter. There is one exception: public
852 * keys can always be exported, so we treat public key objects as
853 * if they had the export flag. */
854 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->type ) )
855 usage &= ~PSA_KEY_USAGE_EXPORT;
856 if( ( slot->policy.usage & usage ) != usage )
857 return( PSA_ERROR_NOT_PERMITTED );
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100858
859 /* Enforce that the usage policy permits the requested algortihm. */
860 if( alg != 0 && ! psa_key_policy_permits( &slot->policy, alg ) )
Darryl Green06fd18d2018-07-16 11:21:11 +0100861 return( PSA_ERROR_NOT_PERMITTED );
862
863 *p_slot = slot;
864 return( PSA_SUCCESS );
865}
Darryl Green940d72c2018-07-13 13:18:51 +0100866
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100867/** Wipe key data from a slot. Preserve metadata such as the policy. */
Gilles Peskine2f060a82018-12-04 17:12:32 +0100868static psa_status_t psa_remove_key_data_from_memory( psa_key_slot_t *slot )
Darryl Green40225ba2018-11-15 14:48:15 +0000869{
870 if( slot->type == PSA_KEY_TYPE_NONE )
871 {
872 /* No key material to clean. */
873 }
874 else if( key_type_is_raw_bytes( slot->type ) )
875 {
876 mbedtls_free( slot->data.raw.data );
877 }
878 else
879#if defined(MBEDTLS_RSA_C)
880 if( PSA_KEY_TYPE_IS_RSA( slot->type ) )
881 {
882 mbedtls_rsa_free( slot->data.rsa );
883 mbedtls_free( slot->data.rsa );
884 }
885 else
886#endif /* defined(MBEDTLS_RSA_C) */
887#if defined(MBEDTLS_ECP_C)
888 if( PSA_KEY_TYPE_IS_ECC( slot->type ) )
889 {
890 mbedtls_ecp_keypair_free( slot->data.ecp );
891 mbedtls_free( slot->data.ecp );
892 }
893 else
894#endif /* defined(MBEDTLS_ECP_C) */
895 {
896 /* Shouldn't happen: the key type is not any type that we
897 * put in. */
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200898 return( PSA_ERROR_CORRUPTION_DETECTED );
Darryl Green40225ba2018-11-15 14:48:15 +0000899 }
900
901 return( PSA_SUCCESS );
902}
903
Gilles Peskine5f25dd02019-01-14 18:24:53 +0100904static void psa_abort_operations_using_key( psa_key_slot_t *slot )
905{
Gilles Peskinec88644d2019-04-12 15:03:38 +0200906 /*FIXME how to implement this?*/
Gilles Peskine5f25dd02019-01-14 18:24:53 +0100907 (void) slot;
908}
909
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100910/** Completely wipe a slot in memory, including its policy.
911 * Persistent storage is not affected. */
Gilles Peskine66fb1262018-12-10 16:29:04 +0100912psa_status_t psa_wipe_key_slot( psa_key_slot_t *slot )
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100913{
914 psa_status_t status = psa_remove_key_data_from_memory( slot );
Gilles Peskine5f25dd02019-01-14 18:24:53 +0100915 psa_abort_operations_using_key( slot );
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100916 /* At this point, key material and other type-specific content has
917 * been wiped. Clear remaining metadata. We can call memset and not
918 * zeroize because the metadata is not particularly sensitive. */
919 memset( slot, 0, sizeof( *slot ) );
920 return( status );
921}
922
Gilles Peskinec5487a82018-12-03 18:08:14 +0100923psa_status_t psa_destroy_key( psa_key_handle_t handle )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100924{
Gilles Peskine2f060a82018-12-04 17:12:32 +0100925 psa_key_slot_t *slot;
Darryl Greend49a4992018-06-18 17:27:26 +0100926 psa_status_t status = PSA_SUCCESS;
927 psa_status_t storage_status = PSA_SUCCESS;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100928
Gilles Peskinec5487a82018-12-03 18:08:14 +0100929 status = psa_get_key_slot( handle, &slot );
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200930 if( status != PSA_SUCCESS )
931 return( status );
Darryl Greend49a4992018-06-18 17:27:26 +0100932#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
933 if( slot->lifetime == PSA_KEY_LIFETIME_PERSISTENT )
934 {
Gilles Peskine69f976b2018-11-30 18:46:56 +0100935 storage_status =
936 psa_destroy_persistent_key( slot->persistent_storage_id );
Darryl Greend49a4992018-06-18 17:27:26 +0100937 }
938#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100939 status = psa_wipe_key_slot( slot );
Darryl Greend49a4992018-06-18 17:27:26 +0100940 if( status != PSA_SUCCESS )
941 return( status );
942 return( storage_status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100943}
944
Gilles Peskineb870b182018-07-06 16:02:09 +0200945/* Return the size of the key in the given slot, in bits. */
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +0200946static size_t psa_get_key_slot_bits( const psa_key_slot_t *slot )
Gilles Peskineb870b182018-07-06 16:02:09 +0200947{
948 if( key_type_is_raw_bytes( slot->type ) )
949 return( slot->data.raw.bytes * 8 );
950#if defined(MBEDTLS_RSA_C)
Gilles Peskined8008d62018-06-29 19:51:51 +0200951 if( PSA_KEY_TYPE_IS_RSA( slot->type ) )
Gilles Peskineaac64a22018-11-12 18:37:42 +0100952 return( PSA_BYTES_TO_BITS( mbedtls_rsa_get_len( slot->data.rsa ) ) );
Gilles Peskineb870b182018-07-06 16:02:09 +0200953#endif /* defined(MBEDTLS_RSA_C) */
954#if defined(MBEDTLS_ECP_C)
955 if( PSA_KEY_TYPE_IS_ECC( slot->type ) )
956 return( slot->data.ecp->grp.pbits );
957#endif /* defined(MBEDTLS_ECP_C) */
958 /* Shouldn't happen except on an empty slot. */
959 return( 0 );
960}
961
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +0200962void psa_reset_key_attributes( psa_key_attributes_t *attributes )
963{
Gilles Peskineb699f072019-04-26 16:06:02 +0200964 mbedtls_free( attributes->domain_parameters );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +0200965 memset( attributes, 0, sizeof( *attributes ) );
966}
967
Gilles Peskineb699f072019-04-26 16:06:02 +0200968psa_status_t psa_set_key_domain_parameters( psa_key_attributes_t *attributes,
969 psa_key_type_t type,
970 const uint8_t *data,
971 size_t data_length )
972{
973 uint8_t *copy = NULL;
974
975 if( data_length != 0 )
976 {
977 copy = mbedtls_calloc( 1, data_length );
978 if( copy == NULL )
979 return( PSA_ERROR_INSUFFICIENT_MEMORY );
980 memcpy( copy, data, data_length );
981 }
982 /* After this point, this function is guaranteed to succeed, so it
983 * can start modifying `*attributes`. */
984
985 if( attributes->domain_parameters != NULL )
986 {
987 mbedtls_free( attributes->domain_parameters );
988 attributes->domain_parameters = NULL;
989 attributes->domain_parameters_size = 0;
990 }
991
992 attributes->domain_parameters = copy;
993 attributes->domain_parameters_size = data_length;
994 attributes->type = type;
995 return( PSA_SUCCESS );
996}
997
998psa_status_t psa_get_key_domain_parameters(
999 const psa_key_attributes_t *attributes,
1000 uint8_t *data, size_t data_size, size_t *data_length )
1001{
1002 if( attributes->domain_parameters_size > data_size )
1003 return( PSA_ERROR_BUFFER_TOO_SMALL );
1004 *data_length = attributes->domain_parameters_size;
1005 if( attributes->domain_parameters_size != 0 )
1006 memcpy( data, attributes->domain_parameters,
1007 attributes->domain_parameters_size );
1008 return( PSA_SUCCESS );
1009}
1010
1011#if defined(MBEDTLS_RSA_C)
1012static psa_status_t psa_get_rsa_public_exponent(
1013 const mbedtls_rsa_context *rsa,
1014 psa_key_attributes_t *attributes )
1015{
1016 mbedtls_mpi mpi;
1017 int ret;
1018 uint8_t *buffer = NULL;
1019 size_t buflen;
1020 mbedtls_mpi_init( &mpi );
1021
1022 ret = mbedtls_rsa_export( rsa, NULL, NULL, NULL, NULL, &mpi );
1023 if( ret != 0 )
1024 goto exit;
Gilles Peskine772c8b12019-04-26 17:37:21 +02001025 if( mbedtls_mpi_cmp_int( &mpi, 65537 ) == 0 )
1026 {
1027 /* It's the default value, which is reported as an empty string,
1028 * so there's nothing to do. */
1029 goto exit;
1030 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001031
1032 buflen = mbedtls_mpi_size( &mpi );
1033 buffer = mbedtls_calloc( 1, buflen );
1034 if( buffer == NULL )
1035 {
1036 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1037 goto exit;
1038 }
1039 ret = mbedtls_mpi_write_binary( &mpi, buffer, buflen );
1040 if( ret != 0 )
1041 goto exit;
1042 attributes->domain_parameters = buffer;
1043 attributes->domain_parameters_size = buflen;
1044
1045exit:
1046 mbedtls_mpi_free( &mpi );
1047 if( ret != 0 )
1048 mbedtls_free( buffer );
1049 return( mbedtls_to_psa_error( ret ) );
1050}
1051#endif /* MBEDTLS_RSA_C */
1052
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001053psa_status_t psa_get_key_attributes( psa_key_handle_t handle,
1054 psa_key_attributes_t *attributes )
1055{
1056 psa_key_slot_t *slot;
1057 psa_status_t status;
1058
1059 psa_reset_key_attributes( attributes );
1060
1061 status = psa_get_key_slot( handle, &slot );
1062 if( status != PSA_SUCCESS )
1063 return( status );
1064
1065 attributes->id = slot->persistent_storage_id;
1066 attributes->lifetime = slot->lifetime;
1067 attributes->policy = slot->policy;
1068 attributes->type = slot->type;
1069 attributes->bits = psa_get_key_slot_bits( slot );
Gilles Peskineb699f072019-04-26 16:06:02 +02001070
1071 switch( slot->type )
1072 {
1073#if defined(MBEDTLS_RSA_C)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001074 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001075 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
1076 status = psa_get_rsa_public_exponent( slot->data.rsa, attributes );
1077 break;
1078#endif
1079 default:
1080 /* Nothing else to do. */
1081 break;
1082 }
1083
1084 if( status != PSA_SUCCESS )
1085 psa_reset_key_attributes( attributes );
1086 return( status );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001087}
1088
Jaeden Amero0ae445f2019-01-10 11:42:27 +00001089#if defined(MBEDTLS_RSA_C) || defined(MBEDTLS_ECP_C)
Jaeden Amero6b196002019-01-10 10:23:21 +00001090static int pk_write_pubkey_simple( mbedtls_pk_context *key,
1091 unsigned char *buf, size_t size )
1092{
1093 int ret;
1094 unsigned char *c;
1095 size_t len = 0;
1096
1097 c = buf + size;
1098
1099 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_pk_write_pubkey( &c, buf, key ) );
1100
1101 return( (int) len );
1102}
Jaeden Amero0ae445f2019-01-10 11:42:27 +00001103#endif /* defined(MBEDTLS_RSA_C) || defined(MBEDTLS_ECP_C) */
Jaeden Amero6b196002019-01-10 10:23:21 +00001104
Gilles Peskine4cb9dde2019-01-19 13:40:11 +01001105static psa_status_t psa_internal_export_key( const psa_key_slot_t *slot,
1106 uint8_t *data,
1107 size_t data_size,
1108 size_t *data_length,
1109 int export_public_key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001110{
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001111 *data_length = 0;
1112
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02001113 if( export_public_key && ! PSA_KEY_TYPE_IS_ASYMMETRIC( slot->type ) )
Moran Pekera998bc62018-04-16 18:16:20 +03001114 return( PSA_ERROR_INVALID_ARGUMENT );
mohammad160306e79202018-03-28 13:17:44 +03001115
Gilles Peskine48c0ea12018-06-21 14:15:31 +02001116 if( key_type_is_raw_bytes( slot->type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001117 {
1118 if( slot->data.raw.bytes > data_size )
1119 return( PSA_ERROR_BUFFER_TOO_SMALL );
Gilles Peskine52b90182018-10-29 19:26:27 +01001120 if( data_size != 0 )
1121 {
Gilles Peskine46f1fd72018-06-28 19:31:31 +02001122 memcpy( data, slot->data.raw.data, slot->data.raw.bytes );
Gilles Peskine52b90182018-10-29 19:26:27 +01001123 memset( data + slot->data.raw.bytes, 0,
1124 data_size - slot->data.raw.bytes );
1125 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001126 *data_length = slot->data.raw.bytes;
1127 return( PSA_SUCCESS );
1128 }
Gilles Peskine188c71e2018-10-29 19:26:02 +01001129#if defined(MBEDTLS_ECP_C)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001130 if( PSA_KEY_TYPE_IS_ECC_KEY_PAIR( slot->type ) && !export_public_key )
Gilles Peskine188c71e2018-10-29 19:26:02 +01001131 {
Darryl Greendd8fb772018-11-07 16:00:44 +00001132 psa_status_t status;
1133
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02001134 size_t bytes = PSA_BITS_TO_BYTES( psa_get_key_slot_bits( slot ) );
Gilles Peskine188c71e2018-10-29 19:26:02 +01001135 if( bytes > data_size )
1136 return( PSA_ERROR_BUFFER_TOO_SMALL );
1137 status = mbedtls_to_psa_error(
1138 mbedtls_mpi_write_binary( &slot->data.ecp->d, data, bytes ) );
1139 if( status != PSA_SUCCESS )
1140 return( status );
1141 memset( data + bytes, 0, data_size - bytes );
1142 *data_length = bytes;
1143 return( PSA_SUCCESS );
1144 }
1145#endif
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001146 else
Moran Peker17e36e12018-05-02 12:55:20 +03001147 {
Gilles Peskine969ac722018-01-28 18:16:59 +01001148#if defined(MBEDTLS_PK_WRITE_C)
Gilles Peskined8008d62018-06-29 19:51:51 +02001149 if( PSA_KEY_TYPE_IS_RSA( slot->type ) ||
Moran Pekera998bc62018-04-16 18:16:20 +03001150 PSA_KEY_TYPE_IS_ECC( slot->type ) )
Gilles Peskine969ac722018-01-28 18:16:59 +01001151 {
Moran Pekera998bc62018-04-16 18:16:20 +03001152 mbedtls_pk_context pk;
1153 int ret;
Gilles Peskined8008d62018-06-29 19:51:51 +02001154 if( PSA_KEY_TYPE_IS_RSA( slot->type ) )
Moran Pekera998bc62018-04-16 18:16:20 +03001155 {
Darryl Green9e2d7a02018-07-24 16:33:30 +01001156#if defined(MBEDTLS_RSA_C)
1157 mbedtls_pk_init( &pk );
Moran Pekera998bc62018-04-16 18:16:20 +03001158 pk.pk_info = &mbedtls_rsa_info;
1159 pk.pk_ctx = slot->data.rsa;
Darryl Green9e2d7a02018-07-24 16:33:30 +01001160#else
1161 return( PSA_ERROR_NOT_SUPPORTED );
1162#endif
Moran Pekera998bc62018-04-16 18:16:20 +03001163 }
1164 else
1165 {
Darryl Green9e2d7a02018-07-24 16:33:30 +01001166#if defined(MBEDTLS_ECP_C)
1167 mbedtls_pk_init( &pk );
Moran Pekera998bc62018-04-16 18:16:20 +03001168 pk.pk_info = &mbedtls_eckey_info;
1169 pk.pk_ctx = slot->data.ecp;
Darryl Green9e2d7a02018-07-24 16:33:30 +01001170#else
1171 return( PSA_ERROR_NOT_SUPPORTED );
1172#endif
Moran Pekera998bc62018-04-16 18:16:20 +03001173 }
Moran Pekerd7326592018-05-29 16:56:39 +03001174 if( export_public_key || PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->type ) )
Jaeden Amero6b196002019-01-10 10:23:21 +00001175 {
Jaeden Amero0ae445f2019-01-10 11:42:27 +00001176 ret = pk_write_pubkey_simple( &pk, data, data_size );
Jaeden Amero6b196002019-01-10 10:23:21 +00001177 }
Moran Peker17e36e12018-05-02 12:55:20 +03001178 else
Jaeden Amero6b196002019-01-10 10:23:21 +00001179 {
Moran Peker17e36e12018-05-02 12:55:20 +03001180 ret = mbedtls_pk_write_key_der( &pk, data, data_size );
Jaeden Amero6b196002019-01-10 10:23:21 +00001181 }
Moran Peker60364322018-04-29 11:34:58 +03001182 if( ret < 0 )
Gilles Peskinee66ca3b2018-06-20 00:11:45 +02001183 {
Gilles Peskine46f1fd72018-06-28 19:31:31 +02001184 /* If data_size is 0 then data may be NULL and then the
1185 * call to memset would have undefined behavior. */
1186 if( data_size != 0 )
1187 memset( data, 0, data_size );
Moran Pekera998bc62018-04-16 18:16:20 +03001188 return( mbedtls_to_psa_error( ret ) );
Gilles Peskinee66ca3b2018-06-20 00:11:45 +02001189 }
Gilles Peskine0e231582018-06-20 00:11:07 +02001190 /* The mbedtls_pk_xxx functions write to the end of the buffer.
1191 * Move the data to the beginning and erase remaining data
1192 * at the original location. */
1193 if( 2 * (size_t) ret <= data_size )
1194 {
1195 memcpy( data, data + data_size - ret, ret );
Gilles Peskinee66ca3b2018-06-20 00:11:45 +02001196 memset( data + data_size - ret, 0, ret );
Gilles Peskine0e231582018-06-20 00:11:07 +02001197 }
1198 else if( (size_t) ret < data_size )
1199 {
1200 memmove( data, data + data_size - ret, ret );
Gilles Peskinee66ca3b2018-06-20 00:11:45 +02001201 memset( data + ret, 0, data_size - ret );
Gilles Peskine0e231582018-06-20 00:11:07 +02001202 }
Moran Pekera998bc62018-04-16 18:16:20 +03001203 *data_length = ret;
1204 return( PSA_SUCCESS );
Gilles Peskine969ac722018-01-28 18:16:59 +01001205 }
1206 else
Gilles Peskine6d912132018-03-07 16:41:37 +01001207#endif /* defined(MBEDTLS_PK_WRITE_C) */
Moran Pekera998bc62018-04-16 18:16:20 +03001208 {
1209 /* This shouldn't happen in the reference implementation, but
Gilles Peskine785fd552018-06-04 15:08:56 +02001210 it is valid for a special-purpose implementation to omit
1211 support for exporting certain key types. */
Moran Pekera998bc62018-04-16 18:16:20 +03001212 return( PSA_ERROR_NOT_SUPPORTED );
1213 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001214 }
1215}
1216
Gilles Peskinec5487a82018-12-03 18:08:14 +01001217psa_status_t psa_export_key( psa_key_handle_t handle,
Gilles Peskine2d277862018-06-18 15:41:12 +02001218 uint8_t *data,
1219 size_t data_size,
1220 size_t *data_length )
Moran Pekera998bc62018-04-16 18:16:20 +03001221{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001222 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001223 psa_status_t status;
1224
1225 /* Set the key to empty now, so that even when there are errors, we always
1226 * set data_length to a value between 0 and data_size. On error, setting
1227 * the key to empty is a good choice because an empty key representation is
1228 * unlikely to be accepted anywhere. */
1229 *data_length = 0;
1230
1231 /* Export requires the EXPORT flag. There is an exception for public keys,
1232 * which don't require any flag, but psa_get_key_from_slot takes
1233 * care of this. */
Gilles Peskinec5487a82018-12-03 18:08:14 +01001234 status = psa_get_key_from_slot( handle, &slot, PSA_KEY_USAGE_EXPORT, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001235 if( status != PSA_SUCCESS )
1236 return( status );
1237 return( psa_internal_export_key( slot, data, data_size,
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02001238 data_length, 0 ) );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001239}
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001240
Gilles Peskinec5487a82018-12-03 18:08:14 +01001241psa_status_t psa_export_public_key( psa_key_handle_t handle,
Gilles Peskine2d277862018-06-18 15:41:12 +02001242 uint8_t *data,
1243 size_t data_size,
1244 size_t *data_length )
Moran Pekerdd4ea382018-04-03 15:30:03 +03001245{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001246 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001247 psa_status_t status;
1248
1249 /* Set the key to empty now, so that even when there are errors, we always
1250 * set data_length to a value between 0 and data_size. On error, setting
1251 * the key to empty is a good choice because an empty key representation is
1252 * unlikely to be accepted anywhere. */
1253 *data_length = 0;
1254
1255 /* Exporting a public key doesn't require a usage flag. */
Gilles Peskinec5487a82018-12-03 18:08:14 +01001256 status = psa_get_key_from_slot( handle, &slot, 0, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001257 if( status != PSA_SUCCESS )
1258 return( status );
1259 return( psa_internal_export_key( slot, data, data_size,
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02001260 data_length, 1 ) );
Moran Pekerdd4ea382018-04-03 15:30:03 +03001261}
1262
Gilles Peskine4747d192019-04-17 15:05:45 +02001263static psa_status_t psa_set_key_policy_internal(
1264 psa_key_slot_t *slot,
1265 const psa_key_policy_t *policy )
1266{
1267 if( ( policy->usage & ~( PSA_KEY_USAGE_EXPORT |
Gilles Peskine8e0206a2019-05-14 14:24:28 +02001268 PSA_KEY_USAGE_COPY |
Gilles Peskine4747d192019-04-17 15:05:45 +02001269 PSA_KEY_USAGE_ENCRYPT |
1270 PSA_KEY_USAGE_DECRYPT |
1271 PSA_KEY_USAGE_SIGN |
1272 PSA_KEY_USAGE_VERIFY |
1273 PSA_KEY_USAGE_DERIVE ) ) != 0 )
1274 return( PSA_ERROR_INVALID_ARGUMENT );
1275
1276 slot->policy = *policy;
1277 return( PSA_SUCCESS );
1278}
1279
1280/** Prepare a key slot to receive key material.
1281 *
1282 * This function allocates a key slot and sets its metadata.
1283 *
1284 * If this function fails, call psa_fail_key_creation().
1285 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001286 * This function is intended to be used as follows:
1287 * -# Call psa_start_key_creation() to allocate a key slot, prepare
1288 * it with the specified attributes, and assign it a handle.
1289 * -# Populate the slot with the key material.
1290 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1291 * In case of failure at any step, stop the sequence and call
1292 * psa_fail_key_creation().
1293 *
Gilles Peskine4747d192019-04-17 15:05:45 +02001294 * \param attributes Key attributes for the new key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001295 * \param handle On success, a handle for the allocated slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001296 * \param p_slot On success, a pointer to the prepared slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001297 *
1298 * \retval #PSA_SUCCESS
1299 * The key slot is ready to receive key material.
1300 * \return If this function fails, the key slot is an invalid state.
1301 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001302 */
1303static psa_status_t psa_start_key_creation(
1304 const psa_key_attributes_t *attributes,
1305 psa_key_handle_t *handle,
1306 psa_key_slot_t **p_slot )
1307{
1308 psa_status_t status;
1309 psa_key_slot_t *slot;
1310
Gilles Peskine267c6562019-05-27 19:01:54 +02001311 status = psa_internal_allocate_key_slot( handle, p_slot );
Gilles Peskine4747d192019-04-17 15:05:45 +02001312 if( status != PSA_SUCCESS )
1313 return( status );
1314 slot = *p_slot;
1315
1316 status = psa_set_key_policy_internal( slot, &attributes->policy );
1317 if( status != PSA_SUCCESS )
1318 return( status );
1319 slot->lifetime = attributes->lifetime;
1320 if( attributes->lifetime != PSA_KEY_LIFETIME_VOLATILE )
Gilles Peskined167b942019-04-19 18:19:40 +02001321 {
1322 status = psa_validate_persistent_key_parameters( attributes->lifetime,
Gilles Peskinef9666592019-05-06 18:56:30 +02001323 attributes->id, 1 );
Gilles Peskined167b942019-04-19 18:19:40 +02001324 if( status != PSA_SUCCESS )
1325 return( status );
Gilles Peskine4747d192019-04-17 15:05:45 +02001326 slot->persistent_storage_id = attributes->id;
Gilles Peskined167b942019-04-19 18:19:40 +02001327 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001328 slot->type = attributes->type;
1329
1330 return( status );
1331}
1332
1333/** Finalize the creation of a key once its key material has been set.
1334 *
1335 * This entails writing the key to persistent storage.
1336 *
1337 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001338 * See the documentation of psa_start_key_creation() for the intended use
1339 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001340 *
1341 * \param slot Pointer to the slot with key material.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001342 *
1343 * \retval #PSA_SUCCESS
1344 * The key was successfully created. The handle is now valid.
1345 * \return If this function fails, the key slot is an invalid state.
1346 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001347 */
1348static psa_status_t psa_finish_key_creation( psa_key_slot_t *slot )
1349{
1350 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001351 (void) slot;
Gilles Peskine4747d192019-04-17 15:05:45 +02001352
1353#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
1354 if( slot->lifetime == PSA_KEY_LIFETIME_PERSISTENT )
1355 {
1356 uint8_t *buffer = NULL;
1357 size_t buffer_size = 0;
1358 size_t length;
1359
1360 buffer_size = PSA_KEY_EXPORT_MAX_SIZE( slot->type,
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02001361 psa_get_key_slot_bits( slot ) );
Gilles Peskine4747d192019-04-17 15:05:45 +02001362 buffer = mbedtls_calloc( 1, buffer_size );
1363 if( buffer == NULL && buffer_size != 0 )
1364 return( PSA_ERROR_INSUFFICIENT_MEMORY );
1365 status = psa_internal_export_key( slot,
1366 buffer, buffer_size, &length,
1367 0 );
1368
1369 if( status == PSA_SUCCESS )
1370 {
1371 status = psa_save_persistent_key( slot->persistent_storage_id,
1372 slot->type, &slot->policy,
1373 buffer, length );
1374 }
1375
1376 if( buffer_size != 0 )
1377 mbedtls_platform_zeroize( buffer, buffer_size );
1378 mbedtls_free( buffer );
1379 }
1380#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1381
1382 return( status );
1383}
1384
1385/** Abort the creation of a key.
1386 *
1387 * You may call this function after calling psa_start_key_creation(),
1388 * or after psa_finish_key_creation() fails. In other circumstances, this
1389 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001390 * See the documentation of psa_start_key_creation() for the intended use
1391 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001392 *
1393 * \param slot Pointer to the slot with key material.
1394 */
1395static void psa_fail_key_creation( psa_key_slot_t *slot )
1396{
1397 if( slot == NULL )
1398 return;
1399 psa_wipe_key_slot( slot );
1400}
1401
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001402static psa_status_t psa_check_key_slot_attributes(
1403 const psa_key_slot_t *slot,
1404 const psa_key_attributes_t *attributes )
1405{
1406 if( attributes->type != 0 )
1407 {
1408 if( attributes->type != slot->type )
1409 return( PSA_ERROR_INVALID_ARGUMENT );
1410 }
1411
1412 if( attributes->domain_parameters_size != 0 )
1413 {
1414#if defined(MBEDTLS_RSA_C)
1415 if( PSA_KEY_TYPE_IS_RSA( slot->type ) )
1416 {
1417 mbedtls_mpi actual, required;
1418 int ret;
1419 mbedtls_mpi_init( &actual );
1420 mbedtls_mpi_init( &required );
1421 ret = mbedtls_rsa_export( slot->data.rsa,
1422 NULL, NULL, NULL, NULL, &actual );
1423 if( ret != 0 )
1424 goto rsa_exit;
1425 ret = mbedtls_mpi_read_binary( &required,
1426 attributes->domain_parameters,
1427 attributes->domain_parameters_size );
1428 if( ret != 0 )
1429 goto rsa_exit;
1430 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
1431 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
1432 rsa_exit:
1433 mbedtls_mpi_free( &actual );
1434 mbedtls_mpi_free( &required );
1435 if( ret != 0)
1436 return( mbedtls_to_psa_error( ret ) );
1437 }
1438 else
1439#endif
1440 {
1441 return( PSA_ERROR_INVALID_ARGUMENT );
1442 }
1443 }
1444
1445 if( attributes->bits != 0 )
1446 {
1447 if( attributes->bits != psa_get_key_slot_bits( slot ) )
1448 return( PSA_ERROR_INVALID_ARGUMENT );
1449 }
1450
1451 return( PSA_SUCCESS );
1452}
1453
Gilles Peskine4747d192019-04-17 15:05:45 +02001454psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02001455 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02001456 size_t data_length,
1457 psa_key_handle_t *handle )
Gilles Peskine4747d192019-04-17 15:05:45 +02001458{
1459 psa_status_t status;
1460 psa_key_slot_t *slot = NULL;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001461
Gilles Peskine4747d192019-04-17 15:05:45 +02001462 status = psa_start_key_creation( attributes, handle, &slot );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001463 if( status != PSA_SUCCESS )
1464 goto exit;
1465
1466 status = psa_import_key_into_slot( slot, data, data_length );
1467 if( status != PSA_SUCCESS )
1468 goto exit;
1469 status = psa_check_key_slot_attributes( slot, attributes );
1470 if( status != PSA_SUCCESS )
1471 goto exit;
1472
1473 status = psa_finish_key_creation( slot );
1474exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02001475 if( status != PSA_SUCCESS )
1476 {
1477 psa_fail_key_creation( slot );
1478 *handle = 0;
1479 }
1480 return( status );
1481}
1482
Gilles Peskine4cb9dde2019-01-19 13:40:11 +01001483static psa_status_t psa_copy_key_material( const psa_key_slot_t *source,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001484 psa_key_slot_t *target )
Gilles Peskine4cb9dde2019-01-19 13:40:11 +01001485{
1486 psa_status_t status;
1487 uint8_t *buffer = NULL;
1488 size_t buffer_size = 0;
1489 size_t length;
1490
1491 buffer_size = PSA_KEY_EXPORT_MAX_SIZE( source->type,
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02001492 psa_get_key_slot_bits( source ) );
Gilles Peskine4cb9dde2019-01-19 13:40:11 +01001493 buffer = mbedtls_calloc( 1, buffer_size );
Darryl Green8593bca2019-02-11 11:45:58 +00001494 if( buffer == NULL && buffer_size != 0 )
Gilles Peskine122d0022019-01-23 10:55:43 +01001495 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Gilles Peskine4cb9dde2019-01-19 13:40:11 +01001496 status = psa_internal_export_key( source, buffer, buffer_size, &length, 0 );
1497 if( status != PSA_SUCCESS )
1498 goto exit;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001499 target->type = source->type;
1500 status = psa_import_key_into_slot( target, buffer, length );
Gilles Peskine4cb9dde2019-01-19 13:40:11 +01001501
1502exit:
Darryl Green8096caf2019-02-11 14:03:03 +00001503 if( buffer_size != 0 )
1504 mbedtls_platform_zeroize( buffer, buffer_size );
Gilles Peskine122d0022019-01-23 10:55:43 +01001505 mbedtls_free( buffer );
Gilles Peskine4cb9dde2019-01-19 13:40:11 +01001506 return( status );
1507}
1508
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001509psa_status_t psa_copy_key( psa_key_handle_t source_handle,
1510 const psa_key_attributes_t *specified_attributes,
1511 psa_key_handle_t *target_handle )
1512{
1513 psa_status_t status;
1514 psa_key_slot_t *source_slot = NULL;
1515 psa_key_slot_t *target_slot = NULL;
1516 psa_key_attributes_t actual_attributes = *specified_attributes;
1517
Gilles Peskinec160d9e2019-05-14 14:32:03 +02001518 status = psa_get_key_from_slot( source_handle, &source_slot,
1519 PSA_KEY_USAGE_COPY, 0 );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001520 if( status != PSA_SUCCESS )
1521 goto exit;
1522
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001523 status = psa_check_key_slot_attributes( source_slot, specified_attributes );
1524 if( status != PSA_SUCCESS )
1525 goto exit;
1526
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001527 status = psa_restrict_key_policy( &actual_attributes.policy,
1528 &source_slot->policy );
1529 if( status != PSA_SUCCESS )
1530 goto exit;
1531
1532 status = psa_start_key_creation( &actual_attributes,
1533 target_handle, &target_slot );
1534 if( status != PSA_SUCCESS )
1535 goto exit;
1536
1537 status = psa_copy_key_material( source_slot, target_slot );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001538 if( status != PSA_SUCCESS )
1539 goto exit;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001540
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001541 status = psa_finish_key_creation( target_slot );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001542exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001543 if( status != PSA_SUCCESS )
1544 {
1545 psa_fail_key_creation( target_slot );
1546 *target_handle = 0;
1547 }
1548 return( status );
1549}
1550
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02001551
1552
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001553/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01001554/* Message digests */
1555/****************************************************************/
1556
Gilles Peskinedc2fc842018-03-07 16:42:59 +01001557static const mbedtls_md_info_t *mbedtls_md_info_from_psa( psa_algorithm_t alg )
Gilles Peskine20035e32018-02-03 22:44:14 +01001558{
1559 switch( alg )
1560 {
1561#if defined(MBEDTLS_MD2_C)
1562 case PSA_ALG_MD2:
1563 return( &mbedtls_md2_info );
1564#endif
1565#if defined(MBEDTLS_MD4_C)
1566 case PSA_ALG_MD4:
1567 return( &mbedtls_md4_info );
1568#endif
1569#if defined(MBEDTLS_MD5_C)
1570 case PSA_ALG_MD5:
1571 return( &mbedtls_md5_info );
1572#endif
1573#if defined(MBEDTLS_RIPEMD160_C)
1574 case PSA_ALG_RIPEMD160:
1575 return( &mbedtls_ripemd160_info );
1576#endif
1577#if defined(MBEDTLS_SHA1_C)
1578 case PSA_ALG_SHA_1:
1579 return( &mbedtls_sha1_info );
1580#endif
1581#if defined(MBEDTLS_SHA256_C)
1582 case PSA_ALG_SHA_224:
1583 return( &mbedtls_sha224_info );
1584 case PSA_ALG_SHA_256:
1585 return( &mbedtls_sha256_info );
1586#endif
1587#if defined(MBEDTLS_SHA512_C)
1588 case PSA_ALG_SHA_384:
1589 return( &mbedtls_sha384_info );
1590 case PSA_ALG_SHA_512:
1591 return( &mbedtls_sha512_info );
1592#endif
1593 default:
1594 return( NULL );
1595 }
1596}
1597
Gilles Peskine9ef733f2018-02-07 21:05:37 +01001598psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
1599{
1600 switch( operation->alg )
1601 {
Gilles Peskine81736312018-06-26 15:04:31 +02001602 case 0:
1603 /* The object has (apparently) been initialized but it is not
1604 * in use. It's ok to call abort on such an object, and there's
1605 * nothing to do. */
1606 break;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01001607#if defined(MBEDTLS_MD2_C)
1608 case PSA_ALG_MD2:
1609 mbedtls_md2_free( &operation->ctx.md2 );
1610 break;
1611#endif
1612#if defined(MBEDTLS_MD4_C)
1613 case PSA_ALG_MD4:
1614 mbedtls_md4_free( &operation->ctx.md4 );
1615 break;
1616#endif
1617#if defined(MBEDTLS_MD5_C)
1618 case PSA_ALG_MD5:
1619 mbedtls_md5_free( &operation->ctx.md5 );
1620 break;
1621#endif
1622#if defined(MBEDTLS_RIPEMD160_C)
1623 case PSA_ALG_RIPEMD160:
1624 mbedtls_ripemd160_free( &operation->ctx.ripemd160 );
1625 break;
1626#endif
1627#if defined(MBEDTLS_SHA1_C)
1628 case PSA_ALG_SHA_1:
1629 mbedtls_sha1_free( &operation->ctx.sha1 );
1630 break;
1631#endif
1632#if defined(MBEDTLS_SHA256_C)
1633 case PSA_ALG_SHA_224:
1634 case PSA_ALG_SHA_256:
1635 mbedtls_sha256_free( &operation->ctx.sha256 );
1636 break;
1637#endif
1638#if defined(MBEDTLS_SHA512_C)
1639 case PSA_ALG_SHA_384:
1640 case PSA_ALG_SHA_512:
1641 mbedtls_sha512_free( &operation->ctx.sha512 );
1642 break;
1643#endif
1644 default:
Gilles Peskinef9c2c092018-06-21 16:57:07 +02001645 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01001646 }
1647 operation->alg = 0;
1648 return( PSA_SUCCESS );
1649}
1650
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02001651psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01001652 psa_algorithm_t alg )
1653{
1654 int ret;
Jaeden Amero36ee5d02019-02-19 09:25:10 +00001655
1656 /* A context must be freshly initialized before it can be set up. */
1657 if( operation->alg != 0 )
1658 {
1659 return( PSA_ERROR_BAD_STATE );
1660 }
1661
Gilles Peskine9ef733f2018-02-07 21:05:37 +01001662 switch( alg )
1663 {
1664#if defined(MBEDTLS_MD2_C)
1665 case PSA_ALG_MD2:
1666 mbedtls_md2_init( &operation->ctx.md2 );
1667 ret = mbedtls_md2_starts_ret( &operation->ctx.md2 );
1668 break;
1669#endif
1670#if defined(MBEDTLS_MD4_C)
1671 case PSA_ALG_MD4:
1672 mbedtls_md4_init( &operation->ctx.md4 );
1673 ret = mbedtls_md4_starts_ret( &operation->ctx.md4 );
1674 break;
1675#endif
1676#if defined(MBEDTLS_MD5_C)
1677 case PSA_ALG_MD5:
1678 mbedtls_md5_init( &operation->ctx.md5 );
1679 ret = mbedtls_md5_starts_ret( &operation->ctx.md5 );
1680 break;
1681#endif
1682#if defined(MBEDTLS_RIPEMD160_C)
1683 case PSA_ALG_RIPEMD160:
1684 mbedtls_ripemd160_init( &operation->ctx.ripemd160 );
1685 ret = mbedtls_ripemd160_starts_ret( &operation->ctx.ripemd160 );
1686 break;
1687#endif
1688#if defined(MBEDTLS_SHA1_C)
1689 case PSA_ALG_SHA_1:
1690 mbedtls_sha1_init( &operation->ctx.sha1 );
1691 ret = mbedtls_sha1_starts_ret( &operation->ctx.sha1 );
1692 break;
1693#endif
1694#if defined(MBEDTLS_SHA256_C)
1695 case PSA_ALG_SHA_224:
1696 mbedtls_sha256_init( &operation->ctx.sha256 );
1697 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 1 );
1698 break;
1699 case PSA_ALG_SHA_256:
1700 mbedtls_sha256_init( &operation->ctx.sha256 );
1701 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 0 );
1702 break;
1703#endif
1704#if defined(MBEDTLS_SHA512_C)
1705 case PSA_ALG_SHA_384:
1706 mbedtls_sha512_init( &operation->ctx.sha512 );
1707 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 1 );
1708 break;
1709 case PSA_ALG_SHA_512:
1710 mbedtls_sha512_init( &operation->ctx.sha512 );
1711 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 0 );
1712 break;
1713#endif
1714 default:
Gilles Peskinec06e0712018-06-20 16:21:04 +02001715 return( PSA_ALG_IS_HASH( alg ) ?
1716 PSA_ERROR_NOT_SUPPORTED :
1717 PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01001718 }
1719 if( ret == 0 )
1720 operation->alg = alg;
1721 else
1722 psa_hash_abort( operation );
1723 return( mbedtls_to_psa_error( ret ) );
1724}
1725
1726psa_status_t psa_hash_update( psa_hash_operation_t *operation,
1727 const uint8_t *input,
1728 size_t input_length )
1729{
1730 int ret;
Gilles Peskine94e44542018-07-12 16:58:43 +02001731
1732 /* Don't require hash implementations to behave correctly on a
1733 * zero-length input, which may have an invalid pointer. */
1734 if( input_length == 0 )
1735 return( PSA_SUCCESS );
1736
Gilles Peskine9ef733f2018-02-07 21:05:37 +01001737 switch( operation->alg )
1738 {
1739#if defined(MBEDTLS_MD2_C)
1740 case PSA_ALG_MD2:
1741 ret = mbedtls_md2_update_ret( &operation->ctx.md2,
1742 input, input_length );
1743 break;
1744#endif
1745#if defined(MBEDTLS_MD4_C)
1746 case PSA_ALG_MD4:
1747 ret = mbedtls_md4_update_ret( &operation->ctx.md4,
1748 input, input_length );
1749 break;
1750#endif
1751#if defined(MBEDTLS_MD5_C)
1752 case PSA_ALG_MD5:
1753 ret = mbedtls_md5_update_ret( &operation->ctx.md5,
1754 input, input_length );
1755 break;
1756#endif
1757#if defined(MBEDTLS_RIPEMD160_C)
1758 case PSA_ALG_RIPEMD160:
1759 ret = mbedtls_ripemd160_update_ret( &operation->ctx.ripemd160,
1760 input, input_length );
1761 break;
1762#endif
1763#if defined(MBEDTLS_SHA1_C)
1764 case PSA_ALG_SHA_1:
1765 ret = mbedtls_sha1_update_ret( &operation->ctx.sha1,
1766 input, input_length );
1767 break;
1768#endif
1769#if defined(MBEDTLS_SHA256_C)
1770 case PSA_ALG_SHA_224:
1771 case PSA_ALG_SHA_256:
1772 ret = mbedtls_sha256_update_ret( &operation->ctx.sha256,
1773 input, input_length );
1774 break;
1775#endif
1776#if defined(MBEDTLS_SHA512_C)
1777 case PSA_ALG_SHA_384:
1778 case PSA_ALG_SHA_512:
1779 ret = mbedtls_sha512_update_ret( &operation->ctx.sha512,
1780 input, input_length );
1781 break;
1782#endif
1783 default:
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00001784 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01001785 }
Gilles Peskine94e44542018-07-12 16:58:43 +02001786
Gilles Peskine9ef733f2018-02-07 21:05:37 +01001787 if( ret != 0 )
1788 psa_hash_abort( operation );
1789 return( mbedtls_to_psa_error( ret ) );
1790}
1791
1792psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
1793 uint8_t *hash,
1794 size_t hash_size,
1795 size_t *hash_length )
1796{
itayzafrir40835d42018-08-02 13:14:17 +03001797 psa_status_t status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01001798 int ret;
Gilles Peskine71bb7b72018-04-19 08:29:59 +02001799 size_t actual_hash_length = PSA_HASH_SIZE( operation->alg );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01001800
1801 /* Fill the output buffer with something that isn't a valid hash
1802 * (barring an attack on the hash and deliberately-crafted input),
1803 * in case the caller doesn't check the return status properly. */
Gilles Peskineaee13332018-07-02 12:15:28 +02001804 *hash_length = hash_size;
Gilles Peskine46f1fd72018-06-28 19:31:31 +02001805 /* If hash_size is 0 then hash may be NULL and then the
1806 * call to memset would have undefined behavior. */
1807 if( hash_size != 0 )
1808 memset( hash, '!', hash_size );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01001809
1810 if( hash_size < actual_hash_length )
itayzafrir40835d42018-08-02 13:14:17 +03001811 {
1812 status = PSA_ERROR_BUFFER_TOO_SMALL;
1813 goto exit;
1814 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01001815
1816 switch( operation->alg )
1817 {
1818#if defined(MBEDTLS_MD2_C)
1819 case PSA_ALG_MD2:
1820 ret = mbedtls_md2_finish_ret( &operation->ctx.md2, hash );
1821 break;
1822#endif
1823#if defined(MBEDTLS_MD4_C)
1824 case PSA_ALG_MD4:
1825 ret = mbedtls_md4_finish_ret( &operation->ctx.md4, hash );
1826 break;
1827#endif
1828#if defined(MBEDTLS_MD5_C)
1829 case PSA_ALG_MD5:
1830 ret = mbedtls_md5_finish_ret( &operation->ctx.md5, hash );
1831 break;
1832#endif
1833#if defined(MBEDTLS_RIPEMD160_C)
1834 case PSA_ALG_RIPEMD160:
1835 ret = mbedtls_ripemd160_finish_ret( &operation->ctx.ripemd160, hash );
1836 break;
1837#endif
1838#if defined(MBEDTLS_SHA1_C)
1839 case PSA_ALG_SHA_1:
1840 ret = mbedtls_sha1_finish_ret( &operation->ctx.sha1, hash );
1841 break;
1842#endif
1843#if defined(MBEDTLS_SHA256_C)
1844 case PSA_ALG_SHA_224:
1845 case PSA_ALG_SHA_256:
1846 ret = mbedtls_sha256_finish_ret( &operation->ctx.sha256, hash );
1847 break;
1848#endif
1849#if defined(MBEDTLS_SHA512_C)
1850 case PSA_ALG_SHA_384:
1851 case PSA_ALG_SHA_512:
1852 ret = mbedtls_sha512_finish_ret( &operation->ctx.sha512, hash );
1853 break;
1854#endif
1855 default:
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00001856 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01001857 }
itayzafrir40835d42018-08-02 13:14:17 +03001858 status = mbedtls_to_psa_error( ret );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01001859
itayzafrir40835d42018-08-02 13:14:17 +03001860exit:
1861 if( status == PSA_SUCCESS )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01001862 {
Gilles Peskineaee13332018-07-02 12:15:28 +02001863 *hash_length = actual_hash_length;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01001864 return( psa_hash_abort( operation ) );
1865 }
1866 else
1867 {
1868 psa_hash_abort( operation );
itayzafrir40835d42018-08-02 13:14:17 +03001869 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01001870 }
1871}
1872
Gilles Peskine2d277862018-06-18 15:41:12 +02001873psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
1874 const uint8_t *hash,
1875 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01001876{
1877 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
1878 size_t actual_hash_length;
1879 psa_status_t status = psa_hash_finish( operation,
1880 actual_hash, sizeof( actual_hash ),
1881 &actual_hash_length );
1882 if( status != PSA_SUCCESS )
1883 return( status );
1884 if( actual_hash_length != hash_length )
1885 return( PSA_ERROR_INVALID_SIGNATURE );
1886 if( safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
1887 return( PSA_ERROR_INVALID_SIGNATURE );
1888 return( PSA_SUCCESS );
1889}
1890
Gilles Peskineeb35d782019-01-22 17:56:16 +01001891psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
1892 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01001893{
1894 if( target_operation->alg != 0 )
1895 return( PSA_ERROR_BAD_STATE );
1896
1897 switch( source_operation->alg )
1898 {
1899 case 0:
1900 return( PSA_ERROR_BAD_STATE );
1901#if defined(MBEDTLS_MD2_C)
1902 case PSA_ALG_MD2:
1903 mbedtls_md2_clone( &target_operation->ctx.md2,
1904 &source_operation->ctx.md2 );
1905 break;
1906#endif
1907#if defined(MBEDTLS_MD4_C)
1908 case PSA_ALG_MD4:
1909 mbedtls_md4_clone( &target_operation->ctx.md4,
1910 &source_operation->ctx.md4 );
1911 break;
1912#endif
1913#if defined(MBEDTLS_MD5_C)
1914 case PSA_ALG_MD5:
1915 mbedtls_md5_clone( &target_operation->ctx.md5,
1916 &source_operation->ctx.md5 );
1917 break;
1918#endif
1919#if defined(MBEDTLS_RIPEMD160_C)
1920 case PSA_ALG_RIPEMD160:
1921 mbedtls_ripemd160_clone( &target_operation->ctx.ripemd160,
1922 &source_operation->ctx.ripemd160 );
1923 break;
1924#endif
1925#if defined(MBEDTLS_SHA1_C)
1926 case PSA_ALG_SHA_1:
1927 mbedtls_sha1_clone( &target_operation->ctx.sha1,
1928 &source_operation->ctx.sha1 );
1929 break;
1930#endif
1931#if defined(MBEDTLS_SHA256_C)
1932 case PSA_ALG_SHA_224:
1933 case PSA_ALG_SHA_256:
1934 mbedtls_sha256_clone( &target_operation->ctx.sha256,
1935 &source_operation->ctx.sha256 );
1936 break;
1937#endif
1938#if defined(MBEDTLS_SHA512_C)
1939 case PSA_ALG_SHA_384:
1940 case PSA_ALG_SHA_512:
1941 mbedtls_sha512_clone( &target_operation->ctx.sha512,
1942 &source_operation->ctx.sha512 );
1943 break;
1944#endif
1945 default:
1946 return( PSA_ERROR_NOT_SUPPORTED );
1947 }
1948
1949 target_operation->alg = source_operation->alg;
1950 return( PSA_SUCCESS );
1951}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01001952
1953
Gilles Peskine9ef733f2018-02-07 21:05:37 +01001954/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01001955/* MAC */
1956/****************************************************************/
1957
Gilles Peskinedc2fc842018-03-07 16:42:59 +01001958static const mbedtls_cipher_info_t *mbedtls_cipher_info_from_psa(
Gilles Peskine8c9def32018-02-08 10:02:12 +01001959 psa_algorithm_t alg,
1960 psa_key_type_t key_type,
Gilles Peskine2d277862018-06-18 15:41:12 +02001961 size_t key_bits,
mohammad1603f4f0d612018-06-03 15:04:51 +03001962 mbedtls_cipher_id_t* cipher_id )
Gilles Peskine8c9def32018-02-08 10:02:12 +01001963{
Gilles Peskine8c9def32018-02-08 10:02:12 +01001964 mbedtls_cipher_mode_t mode;
mohammad1603f4f0d612018-06-03 15:04:51 +03001965 mbedtls_cipher_id_t cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01001966
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02001967 if( PSA_ALG_IS_AEAD( alg ) )
Gilles Peskine57fbdb12018-10-17 18:29:17 +02001968 alg = PSA_ALG_AEAD_WITH_TAG_LENGTH( alg, 0 );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02001969
Gilles Peskine8c9def32018-02-08 10:02:12 +01001970 if( PSA_ALG_IS_CIPHER( alg ) || PSA_ALG_IS_AEAD( alg ) )
1971 {
Nir Sonnenscheine9664c32018-06-17 14:41:30 +03001972 switch( alg )
Gilles Peskine8c9def32018-02-08 10:02:12 +01001973 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02001974 case PSA_ALG_ARC4:
Gilles Peskine26869f22019-05-06 15:25:00 +02001975 case PSA_ALG_CHACHA20:
Gilles Peskine8c9def32018-02-08 10:02:12 +01001976 mode = MBEDTLS_MODE_STREAM;
1977 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01001978 case PSA_ALG_CTR:
1979 mode = MBEDTLS_MODE_CTR;
1980 break;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02001981 case PSA_ALG_CFB:
1982 mode = MBEDTLS_MODE_CFB;
1983 break;
1984 case PSA_ALG_OFB:
1985 mode = MBEDTLS_MODE_OFB;
1986 break;
1987 case PSA_ALG_CBC_NO_PADDING:
1988 mode = MBEDTLS_MODE_CBC;
1989 break;
1990 case PSA_ALG_CBC_PKCS7:
1991 mode = MBEDTLS_MODE_CBC;
1992 break;
Gilles Peskine57fbdb12018-10-17 18:29:17 +02001993 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01001994 mode = MBEDTLS_MODE_CCM;
1995 break;
Gilles Peskine57fbdb12018-10-17 18:29:17 +02001996 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_GCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01001997 mode = MBEDTLS_MODE_GCM;
1998 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02001999 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CHACHA20_POLY1305, 0 ):
2000 mode = MBEDTLS_MODE_CHACHAPOLY;
2001 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002002 default:
2003 return( NULL );
2004 }
2005 }
2006 else if( alg == PSA_ALG_CMAC )
2007 mode = MBEDTLS_MODE_ECB;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002008 else
2009 return( NULL );
2010
2011 switch( key_type )
2012 {
2013 case PSA_KEY_TYPE_AES:
mohammad1603f4f0d612018-06-03 15:04:51 +03002014 cipher_id_tmp = MBEDTLS_CIPHER_ID_AES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002015 break;
2016 case PSA_KEY_TYPE_DES:
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002017 /* key_bits is 64 for Single-DES, 128 for two-key Triple-DES,
2018 * and 192 for three-key Triple-DES. */
Gilles Peskine8c9def32018-02-08 10:02:12 +01002019 if( key_bits == 64 )
mohammad1603f4f0d612018-06-03 15:04:51 +03002020 cipher_id_tmp = MBEDTLS_CIPHER_ID_DES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002021 else
mohammad1603f4f0d612018-06-03 15:04:51 +03002022 cipher_id_tmp = MBEDTLS_CIPHER_ID_3DES;
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002023 /* mbedtls doesn't recognize two-key Triple-DES as an algorithm,
2024 * but two-key Triple-DES is functionally three-key Triple-DES
2025 * with K1=K3, so that's how we present it to mbedtls. */
2026 if( key_bits == 128 )
2027 key_bits = 192;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002028 break;
2029 case PSA_KEY_TYPE_CAMELLIA:
mohammad1603f4f0d612018-06-03 15:04:51 +03002030 cipher_id_tmp = MBEDTLS_CIPHER_ID_CAMELLIA;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002031 break;
2032 case PSA_KEY_TYPE_ARC4:
mohammad1603f4f0d612018-06-03 15:04:51 +03002033 cipher_id_tmp = MBEDTLS_CIPHER_ID_ARC4;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002034 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02002035 case PSA_KEY_TYPE_CHACHA20:
2036 cipher_id_tmp = MBEDTLS_CIPHER_ID_CHACHA20;
2037 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002038 default:
2039 return( NULL );
2040 }
mohammad1603f4f0d612018-06-03 15:04:51 +03002041 if( cipher_id != NULL )
mohammad160360a64d02018-06-03 17:20:42 +03002042 *cipher_id = cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002043
Jaeden Amero23bbb752018-06-26 14:16:54 +01002044 return( mbedtls_cipher_info_from_values( cipher_id_tmp,
2045 (int) key_bits, mode ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002046}
2047
Gilles Peskinea05219c2018-11-16 16:02:56 +01002048#if defined(MBEDTLS_MD_C)
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002049static size_t psa_get_hash_block_size( psa_algorithm_t alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002050{
Gilles Peskine2d277862018-06-18 15:41:12 +02002051 switch( alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002052 {
2053 case PSA_ALG_MD2:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002054 return( 16 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002055 case PSA_ALG_MD4:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002056 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002057 case PSA_ALG_MD5:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002058 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002059 case PSA_ALG_RIPEMD160:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002060 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002061 case PSA_ALG_SHA_1:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002062 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002063 case PSA_ALG_SHA_224:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002064 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002065 case PSA_ALG_SHA_256:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002066 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002067 case PSA_ALG_SHA_384:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002068 return( 128 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002069 case PSA_ALG_SHA_512:
Gilles Peskine2d277862018-06-18 15:41:12 +02002070 return( 128 );
2071 default:
2072 return( 0 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002073 }
2074}
Gilles Peskinea05219c2018-11-16 16:02:56 +01002075#endif /* MBEDTLS_MD_C */
Nir Sonnenschein0c9ec532018-06-07 13:27:47 +03002076
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002077/* Initialize the MAC operation structure. Once this function has been
2078 * called, psa_mac_abort can run and will do the right thing. */
2079static psa_status_t psa_mac_init( psa_mac_operation_t *operation,
2080 psa_algorithm_t alg )
2081{
2082 psa_status_t status = PSA_ERROR_NOT_SUPPORTED;
2083
2084 operation->alg = alg;
2085 operation->key_set = 0;
2086 operation->iv_set = 0;
2087 operation->iv_required = 0;
2088 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002089 operation->is_sign = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002090
2091#if defined(MBEDTLS_CMAC_C)
2092 if( alg == PSA_ALG_CMAC )
2093 {
2094 operation->iv_required = 0;
2095 mbedtls_cipher_init( &operation->ctx.cmac );
2096 status = PSA_SUCCESS;
2097 }
2098 else
2099#endif /* MBEDTLS_CMAC_C */
2100#if defined(MBEDTLS_MD_C)
2101 if( PSA_ALG_IS_HMAC( operation->alg ) )
2102 {
Gilles Peskineff94abd2018-07-12 17:07:52 +02002103 /* We'll set up the hash operation later in psa_hmac_setup_internal. */
2104 operation->ctx.hmac.hash_ctx.alg = 0;
2105 status = PSA_SUCCESS;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002106 }
2107 else
2108#endif /* MBEDTLS_MD_C */
2109 {
Gilles Peskinec06e0712018-06-20 16:21:04 +02002110 if( ! PSA_ALG_IS_MAC( alg ) )
2111 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002112 }
2113
2114 if( status != PSA_SUCCESS )
2115 memset( operation, 0, sizeof( *operation ) );
2116 return( status );
2117}
2118
Gilles Peskine01126fa2018-07-12 17:04:55 +02002119#if defined(MBEDTLS_MD_C)
2120static psa_status_t psa_hmac_abort_internal( psa_hmac_internal_data *hmac )
2121{
Gilles Peskine3f108122018-12-07 18:14:53 +01002122 mbedtls_platform_zeroize( hmac->opad, sizeof( hmac->opad ) );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002123 return( psa_hash_abort( &hmac->hash_ctx ) );
2124}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01002125
Janos Follath999f6482019-06-11 12:04:10 +01002126#if defined(PSA_PRE_1_0_KEY_DERIVATION)
Hanno Beckerc8a41d72018-10-09 17:33:01 +01002127static void psa_hmac_init_internal( psa_hmac_internal_data *hmac )
2128{
2129 /* Instances of psa_hash_operation_s can be initialized by zeroization. */
2130 memset( hmac, 0, sizeof( *hmac ) );
2131}
Janos Follath999f6482019-06-11 12:04:10 +01002132#endif /* PSA_PRE_1_0_KEY_DERIVATION */
Gilles Peskine01126fa2018-07-12 17:04:55 +02002133#endif /* MBEDTLS_MD_C */
2134
Gilles Peskine8c9def32018-02-08 10:02:12 +01002135psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
2136{
Gilles Peskinefbfac682018-07-08 20:51:54 +02002137 if( operation->alg == 0 )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002138 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02002139 /* The object has (apparently) been initialized but it is not
2140 * in use. It's ok to call abort on such an object, and there's
2141 * nothing to do. */
2142 return( PSA_SUCCESS );
2143 }
2144 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002145#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002146 if( operation->alg == PSA_ALG_CMAC )
2147 {
2148 mbedtls_cipher_free( &operation->ctx.cmac );
2149 }
2150 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002151#endif /* MBEDTLS_CMAC_C */
Gilles Peskine8c9def32018-02-08 10:02:12 +01002152#if defined(MBEDTLS_MD_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002153 if( PSA_ALG_IS_HMAC( operation->alg ) )
2154 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02002155 psa_hmac_abort_internal( &operation->ctx.hmac );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002156 }
2157 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002158#endif /* MBEDTLS_MD_C */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002159 {
2160 /* Sanity check (shouldn't happen: operation->alg should
2161 * always have been initialized to a valid value). */
2162 goto bad_state;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002163 }
Moran Peker41deec42018-04-04 15:43:05 +03002164
Gilles Peskine8c9def32018-02-08 10:02:12 +01002165 operation->alg = 0;
2166 operation->key_set = 0;
2167 operation->iv_set = 0;
2168 operation->iv_required = 0;
2169 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002170 operation->is_sign = 0;
Moran Peker41deec42018-04-04 15:43:05 +03002171
Gilles Peskine8c9def32018-02-08 10:02:12 +01002172 return( PSA_SUCCESS );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002173
2174bad_state:
2175 /* If abort is called on an uninitialized object, we can't trust
2176 * anything. Wipe the object in case it contains confidential data.
2177 * This may result in a memory leak if a pointer gets overwritten,
2178 * but it's too late to do anything about this. */
2179 memset( operation, 0, sizeof( *operation ) );
2180 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002181}
2182
Gilles Peskinee3b07d82018-06-19 11:57:35 +02002183#if defined(MBEDTLS_CMAC_C)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002184static int psa_cmac_setup( psa_mac_operation_t *operation,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002185 size_t key_bits,
Gilles Peskine2f060a82018-12-04 17:12:32 +01002186 psa_key_slot_t *slot,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002187 const mbedtls_cipher_info_t *cipher_info )
2188{
2189 int ret;
2190
2191 operation->mac_size = cipher_info->block_size;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002192
2193 ret = mbedtls_cipher_setup( &operation->ctx.cmac, cipher_info );
2194 if( ret != 0 )
2195 return( ret );
2196
2197 ret = mbedtls_cipher_cmac_starts( &operation->ctx.cmac,
2198 slot->data.raw.data,
2199 key_bits );
2200 return( ret );
2201}
Gilles Peskinee3b07d82018-06-19 11:57:35 +02002202#endif /* MBEDTLS_CMAC_C */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002203
Gilles Peskine248051a2018-06-20 16:09:38 +02002204#if defined(MBEDTLS_MD_C)
Gilles Peskine01126fa2018-07-12 17:04:55 +02002205static psa_status_t psa_hmac_setup_internal( psa_hmac_internal_data *hmac,
2206 const uint8_t *key,
2207 size_t key_length,
2208 psa_algorithm_t hash_alg )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002209{
Gilles Peskineb3e6e5d2018-06-18 22:16:43 +02002210 unsigned char ipad[PSA_HMAC_MAX_HASH_BLOCK_SIZE];
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002211 size_t i;
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002212 size_t hash_size = PSA_HASH_SIZE( hash_alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002213 size_t block_size = psa_get_hash_block_size( hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002214 psa_status_t status;
2215
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002216 /* Sanity checks on block_size, to guarantee that there won't be a buffer
2217 * overflow below. This should never trigger if the hash algorithm
2218 * is implemented correctly. */
2219 /* The size checks against the ipad and opad buffers cannot be written
2220 * `block_size > sizeof( ipad ) || block_size > sizeof( hmac->opad )`
2221 * because that triggers -Wlogical-op on GCC 7.3. */
2222 if( block_size > sizeof( ipad ) )
2223 return( PSA_ERROR_NOT_SUPPORTED );
2224 if( block_size > sizeof( hmac->opad ) )
2225 return( PSA_ERROR_NOT_SUPPORTED );
2226 if( block_size < hash_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002227 return( PSA_ERROR_NOT_SUPPORTED );
2228
Gilles Peskined223b522018-06-11 18:12:58 +02002229 if( key_length > block_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002230 {
Gilles Peskine1e6bfdf2018-07-17 16:22:47 +02002231 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002232 if( status != PSA_SUCCESS )
Gilles Peskine1e6bfdf2018-07-17 16:22:47 +02002233 goto cleanup;
Gilles Peskine01126fa2018-07-12 17:04:55 +02002234 status = psa_hash_update( &hmac->hash_ctx, key, key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002235 if( status != PSA_SUCCESS )
Gilles Peskineb8be2882018-07-17 16:24:34 +02002236 goto cleanup;
Gilles Peskine01126fa2018-07-12 17:04:55 +02002237 status = psa_hash_finish( &hmac->hash_ctx,
Gilles Peskined223b522018-06-11 18:12:58 +02002238 ipad, sizeof( ipad ), &key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002239 if( status != PSA_SUCCESS )
Gilles Peskineb8be2882018-07-17 16:24:34 +02002240 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002241 }
Gilles Peskine96889972018-07-12 17:07:03 +02002242 /* A 0-length key is not commonly used in HMAC when used as a MAC,
2243 * but it is permitted. It is common when HMAC is used in HKDF, for
2244 * example. Don't call `memcpy` in the 0-length because `key` could be
2245 * an invalid pointer which would make the behavior undefined. */
2246 else if( key_length != 0 )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002247 memcpy( ipad, key, key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002248
Gilles Peskined223b522018-06-11 18:12:58 +02002249 /* ipad contains the key followed by garbage. Xor and fill with 0x36
2250 * to create the ipad value. */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002251 for( i = 0; i < key_length; i++ )
Gilles Peskined223b522018-06-11 18:12:58 +02002252 ipad[i] ^= 0x36;
2253 memset( ipad + key_length, 0x36, block_size - key_length );
2254
2255 /* Copy the key material from ipad to opad, flipping the requisite bits,
2256 * and filling the rest of opad with the requisite constant. */
2257 for( i = 0; i < key_length; i++ )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002258 hmac->opad[i] = ipad[i] ^ 0x36 ^ 0x5C;
2259 memset( hmac->opad + key_length, 0x5C, block_size - key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002260
Gilles Peskine01126fa2018-07-12 17:04:55 +02002261 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002262 if( status != PSA_SUCCESS )
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002263 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002264
Gilles Peskine01126fa2018-07-12 17:04:55 +02002265 status = psa_hash_update( &hmac->hash_ctx, ipad, block_size );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002266
2267cleanup:
Gilles Peskine3f108122018-12-07 18:14:53 +01002268 mbedtls_platform_zeroize( ipad, key_length );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002269
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002270 return( status );
2271}
Gilles Peskine248051a2018-06-20 16:09:38 +02002272#endif /* MBEDTLS_MD_C */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002273
Gilles Peskine89167cb2018-07-08 20:12:23 +02002274static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01002275 psa_key_handle_t handle,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002276 psa_algorithm_t alg,
2277 int is_sign )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002278{
Gilles Peskine8c9def32018-02-08 10:02:12 +01002279 psa_status_t status;
Gilles Peskine2f060a82018-12-04 17:12:32 +01002280 psa_key_slot_t *slot;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002281 size_t key_bits;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002282 psa_key_usage_t usage =
2283 is_sign ? PSA_KEY_USAGE_SIGN : PSA_KEY_USAGE_VERIFY;
Gilles Peskined911eb72018-08-14 15:18:45 +02002284 unsigned char truncated = PSA_MAC_TRUNCATED_LENGTH( alg );
Gilles Peskinee0e9c7c2018-10-17 18:28:05 +02002285 psa_algorithm_t full_length_alg = PSA_ALG_FULL_LENGTH_MAC( alg );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002286
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002287 /* A context must be freshly initialized before it can be set up. */
2288 if( operation->alg != 0 )
2289 {
2290 return( PSA_ERROR_BAD_STATE );
2291 }
2292
Gilles Peskined911eb72018-08-14 15:18:45 +02002293 status = psa_mac_init( operation, full_length_alg );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002294 if( status != PSA_SUCCESS )
2295 return( status );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002296 if( is_sign )
2297 operation->is_sign = 1;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002298
Gilles Peskinec5487a82018-12-03 18:08:14 +01002299 status = psa_get_key_from_slot( handle, &slot, usage, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02002300 if( status != PSA_SUCCESS )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002301 goto exit;
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02002302 key_bits = psa_get_key_slot_bits( slot );
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002303
Gilles Peskine8c9def32018-02-08 10:02:12 +01002304#if defined(MBEDTLS_CMAC_C)
Gilles Peskined911eb72018-08-14 15:18:45 +02002305 if( full_length_alg == PSA_ALG_CMAC )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002306 {
2307 const mbedtls_cipher_info_t *cipher_info =
Gilles Peskined911eb72018-08-14 15:18:45 +02002308 mbedtls_cipher_info_from_psa( full_length_alg,
2309 slot->type, key_bits, NULL );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002310 int ret;
2311 if( cipher_info == NULL )
2312 {
2313 status = PSA_ERROR_NOT_SUPPORTED;
2314 goto exit;
2315 }
2316 operation->mac_size = cipher_info->block_size;
2317 ret = psa_cmac_setup( operation, key_bits, slot, cipher_info );
2318 status = mbedtls_to_psa_error( ret );
2319 }
2320 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002321#endif /* MBEDTLS_CMAC_C */
Gilles Peskine8c9def32018-02-08 10:02:12 +01002322#if defined(MBEDTLS_MD_C)
Gilles Peskined911eb72018-08-14 15:18:45 +02002323 if( PSA_ALG_IS_HMAC( full_length_alg ) )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002324 {
Gilles Peskine00709fa2018-08-22 18:25:41 +02002325 psa_algorithm_t hash_alg = PSA_ALG_HMAC_GET_HASH( alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002326 if( hash_alg == 0 )
2327 {
2328 status = PSA_ERROR_NOT_SUPPORTED;
2329 goto exit;
2330 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002331
2332 operation->mac_size = PSA_HASH_SIZE( hash_alg );
2333 /* Sanity check. This shouldn't fail on a valid configuration. */
2334 if( operation->mac_size == 0 ||
2335 operation->mac_size > sizeof( operation->ctx.hmac.opad ) )
2336 {
2337 status = PSA_ERROR_NOT_SUPPORTED;
2338 goto exit;
2339 }
2340
Gilles Peskine01126fa2018-07-12 17:04:55 +02002341 if( slot->type != PSA_KEY_TYPE_HMAC )
2342 {
2343 status = PSA_ERROR_INVALID_ARGUMENT;
2344 goto exit;
2345 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002346
Gilles Peskine01126fa2018-07-12 17:04:55 +02002347 status = psa_hmac_setup_internal( &operation->ctx.hmac,
2348 slot->data.raw.data,
2349 slot->data.raw.bytes,
2350 hash_alg );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002351 }
2352 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002353#endif /* MBEDTLS_MD_C */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002354 {
Jaeden Amero82df32e2018-11-23 15:11:20 +00002355 (void) key_bits;
Gilles Peskinefbfac682018-07-08 20:51:54 +02002356 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002357 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002358
Gilles Peskined911eb72018-08-14 15:18:45 +02002359 if( truncated == 0 )
2360 {
2361 /* The "normal" case: untruncated algorithm. Nothing to do. */
2362 }
2363 else if( truncated < 4 )
2364 {
Gilles Peskine6d72ff92018-08-21 14:55:08 +02002365 /* A very short MAC is too short for security since it can be
2366 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2367 * so we make this our minimum, even though 32 bits is still
2368 * too small for security. */
Gilles Peskined911eb72018-08-14 15:18:45 +02002369 status = PSA_ERROR_NOT_SUPPORTED;
2370 }
2371 else if( truncated > operation->mac_size )
2372 {
2373 /* It's impossible to "truncate" to a larger length. */
2374 status = PSA_ERROR_INVALID_ARGUMENT;
2375 }
2376 else
2377 operation->mac_size = truncated;
2378
Gilles Peskinefbfac682018-07-08 20:51:54 +02002379exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002380 if( status != PSA_SUCCESS )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002381 {
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002382 psa_mac_abort( operation );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002383 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002384 else
2385 {
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002386 operation->key_set = 1;
2387 }
2388 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002389}
2390
Gilles Peskine89167cb2018-07-08 20:12:23 +02002391psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01002392 psa_key_handle_t handle,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002393 psa_algorithm_t alg )
2394{
Gilles Peskinec5487a82018-12-03 18:08:14 +01002395 return( psa_mac_setup( operation, handle, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002396}
2397
2398psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01002399 psa_key_handle_t handle,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002400 psa_algorithm_t alg )
2401{
Gilles Peskinec5487a82018-12-03 18:08:14 +01002402 return( psa_mac_setup( operation, handle, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002403}
2404
Gilles Peskine8c9def32018-02-08 10:02:12 +01002405psa_status_t psa_mac_update( psa_mac_operation_t *operation,
2406 const uint8_t *input,
2407 size_t input_length )
2408{
Gilles Peskinefbfac682018-07-08 20:51:54 +02002409 psa_status_t status = PSA_ERROR_BAD_STATE;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002410 if( ! operation->key_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002411 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002412 if( operation->iv_required && ! operation->iv_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002413 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002414 operation->has_input = 1;
2415
Gilles Peskine8c9def32018-02-08 10:02:12 +01002416#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002417 if( operation->alg == PSA_ALG_CMAC )
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002418 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02002419 int ret = mbedtls_cipher_cmac_update( &operation->ctx.cmac,
2420 input, input_length );
2421 status = mbedtls_to_psa_error( ret );
2422 }
2423 else
2424#endif /* MBEDTLS_CMAC_C */
2425#if defined(MBEDTLS_MD_C)
2426 if( PSA_ALG_IS_HMAC( operation->alg ) )
2427 {
2428 status = psa_hash_update( &operation->ctx.hmac.hash_ctx, input,
2429 input_length );
2430 }
2431 else
2432#endif /* MBEDTLS_MD_C */
2433 {
2434 /* This shouldn't happen if `operation` was initialized by
2435 * a setup function. */
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002436 return( PSA_ERROR_BAD_STATE );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002437 }
2438
Gilles Peskinefbfac682018-07-08 20:51:54 +02002439 if( status != PSA_SUCCESS )
2440 psa_mac_abort( operation );
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02002441 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002442}
2443
Gilles Peskine01126fa2018-07-12 17:04:55 +02002444#if defined(MBEDTLS_MD_C)
2445static psa_status_t psa_hmac_finish_internal( psa_hmac_internal_data *hmac,
2446 uint8_t *mac,
2447 size_t mac_size )
2448{
2449 unsigned char tmp[MBEDTLS_MD_MAX_SIZE];
2450 psa_algorithm_t hash_alg = hmac->hash_ctx.alg;
2451 size_t hash_size = 0;
2452 size_t block_size = psa_get_hash_block_size( hash_alg );
2453 psa_status_t status;
2454
Gilles Peskine01126fa2018-07-12 17:04:55 +02002455 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
2456 if( status != PSA_SUCCESS )
2457 return( status );
2458 /* From here on, tmp needs to be wiped. */
2459
2460 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
2461 if( status != PSA_SUCCESS )
2462 goto exit;
2463
2464 status = psa_hash_update( &hmac->hash_ctx, hmac->opad, block_size );
2465 if( status != PSA_SUCCESS )
2466 goto exit;
2467
2468 status = psa_hash_update( &hmac->hash_ctx, tmp, hash_size );
2469 if( status != PSA_SUCCESS )
2470 goto exit;
2471
Gilles Peskined911eb72018-08-14 15:18:45 +02002472 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
2473 if( status != PSA_SUCCESS )
2474 goto exit;
2475
2476 memcpy( mac, tmp, mac_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002477
2478exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01002479 mbedtls_platform_zeroize( tmp, hash_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002480 return( status );
2481}
2482#endif /* MBEDTLS_MD_C */
2483
mohammad16036df908f2018-04-02 08:34:15 -07002484static psa_status_t psa_mac_finish_internal( psa_mac_operation_t *operation,
Gilles Peskine2d277862018-06-18 15:41:12 +02002485 uint8_t *mac,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002486 size_t mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002487{
Gilles Peskine1d96fff2018-07-02 12:15:39 +02002488 if( ! operation->key_set )
2489 return( PSA_ERROR_BAD_STATE );
2490 if( operation->iv_required && ! operation->iv_set )
2491 return( PSA_ERROR_BAD_STATE );
2492
Gilles Peskine8c9def32018-02-08 10:02:12 +01002493 if( mac_size < operation->mac_size )
2494 return( PSA_ERROR_BUFFER_TOO_SMALL );
2495
Gilles Peskine8c9def32018-02-08 10:02:12 +01002496#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002497 if( operation->alg == PSA_ALG_CMAC )
2498 {
Gilles Peskined911eb72018-08-14 15:18:45 +02002499 uint8_t tmp[PSA_MAX_BLOCK_CIPHER_BLOCK_SIZE];
2500 int ret = mbedtls_cipher_cmac_finish( &operation->ctx.cmac, tmp );
2501 if( ret == 0 )
Gilles Peskine87b0ac42018-08-21 14:55:49 +02002502 memcpy( mac, tmp, operation->mac_size );
Gilles Peskine3f108122018-12-07 18:14:53 +01002503 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002504 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002505 }
Gilles Peskinefbfac682018-07-08 20:51:54 +02002506 else
2507#endif /* MBEDTLS_CMAC_C */
2508#if defined(MBEDTLS_MD_C)
2509 if( PSA_ALG_IS_HMAC( operation->alg ) )
2510 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02002511 return( psa_hmac_finish_internal( &operation->ctx.hmac,
Gilles Peskined911eb72018-08-14 15:18:45 +02002512 mac, operation->mac_size ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002513 }
2514 else
2515#endif /* MBEDTLS_MD_C */
2516 {
2517 /* This shouldn't happen if `operation` was initialized by
2518 * a setup function. */
2519 return( PSA_ERROR_BAD_STATE );
2520 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002521}
2522
Gilles Peskineacd4be32018-07-08 19:56:25 +02002523psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
2524 uint8_t *mac,
2525 size_t mac_size,
2526 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07002527{
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002528 psa_status_t status;
2529
Jaeden Amero252ef282019-02-15 14:05:35 +00002530 if( operation->alg == 0 )
2531 {
2532 return( PSA_ERROR_BAD_STATE );
2533 }
2534
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002535 /* Fill the output buffer with something that isn't a valid mac
2536 * (barring an attack on the mac and deliberately-crafted input),
2537 * in case the caller doesn't check the return status properly. */
2538 *mac_length = mac_size;
2539 /* If mac_size is 0 then mac may be NULL and then the
2540 * call to memset would have undefined behavior. */
2541 if( mac_size != 0 )
2542 memset( mac, '!', mac_size );
2543
Gilles Peskine89167cb2018-07-08 20:12:23 +02002544 if( ! operation->is_sign )
2545 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002546 return( PSA_ERROR_BAD_STATE );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002547 }
mohammad16036df908f2018-04-02 08:34:15 -07002548
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002549 status = psa_mac_finish_internal( operation, mac, mac_size );
2550
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002551 if( status == PSA_SUCCESS )
2552 {
2553 status = psa_mac_abort( operation );
2554 if( status == PSA_SUCCESS )
2555 *mac_length = operation->mac_size;
2556 else
2557 memset( mac, '!', mac_size );
2558 }
2559 else
2560 psa_mac_abort( operation );
2561 return( status );
mohammad16036df908f2018-04-02 08:34:15 -07002562}
2563
Gilles Peskineacd4be32018-07-08 19:56:25 +02002564psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
2565 const uint8_t *mac,
2566 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002567{
Gilles Peskine828ed142018-06-18 23:25:51 +02002568 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
mohammad16036df908f2018-04-02 08:34:15 -07002569 psa_status_t status;
2570
Jaeden Amero252ef282019-02-15 14:05:35 +00002571 if( operation->alg == 0 )
2572 {
2573 return( PSA_ERROR_BAD_STATE );
2574 }
2575
Gilles Peskine89167cb2018-07-08 20:12:23 +02002576 if( operation->is_sign )
2577 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002578 return( PSA_ERROR_BAD_STATE );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002579 }
2580 if( operation->mac_size != mac_length )
2581 {
2582 status = PSA_ERROR_INVALID_SIGNATURE;
2583 goto cleanup;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002584 }
mohammad16036df908f2018-04-02 08:34:15 -07002585
2586 status = psa_mac_finish_internal( operation,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002587 actual_mac, sizeof( actual_mac ) );
2588
2589 if( safer_memcmp( mac, actual_mac, mac_length ) != 0 )
2590 status = PSA_ERROR_INVALID_SIGNATURE;
2591
2592cleanup:
2593 if( status == PSA_SUCCESS )
2594 status = psa_mac_abort( operation );
2595 else
2596 psa_mac_abort( operation );
2597
Gilles Peskine3f108122018-12-07 18:14:53 +01002598 mbedtls_platform_zeroize( actual_mac, sizeof( actual_mac ) );
Gilles Peskined911eb72018-08-14 15:18:45 +02002599
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002600 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002601}
2602
2603
Gilles Peskine20035e32018-02-03 22:44:14 +01002604
Gilles Peskine20035e32018-02-03 22:44:14 +01002605/****************************************************************/
2606/* Asymmetric cryptography */
2607/****************************************************************/
2608
Gilles Peskine2b450e32018-06-27 15:42:46 +02002609#if defined(MBEDTLS_RSA_C)
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02002610/* Decode the hash algorithm from alg and store the mbedtls encoding in
Gilles Peskine71ac7b12018-06-29 23:36:35 +02002611 * md_alg. Verify that the hash length is acceptable. */
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02002612static psa_status_t psa_rsa_decode_md_type( psa_algorithm_t alg,
2613 size_t hash_length,
2614 mbedtls_md_type_t *md_alg )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03002615{
Gilles Peskine7ed29c52018-06-26 15:50:08 +02002616 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
Gilles Peskine61b91d42018-06-08 16:09:36 +02002617 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02002618 *md_alg = mbedtls_md_get_type( md_info );
2619
2620 /* The Mbed TLS RSA module uses an unsigned int for hash length
2621 * parameters. Validate that it fits so that we don't risk an
2622 * overflow later. */
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03002623#if SIZE_MAX > UINT_MAX
Gilles Peskine71ac7b12018-06-29 23:36:35 +02002624 if( hash_length > UINT_MAX )
2625 return( PSA_ERROR_INVALID_ARGUMENT );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03002626#endif
Gilles Peskine71ac7b12018-06-29 23:36:35 +02002627
2628#if defined(MBEDTLS_PKCS1_V15)
2629 /* For PKCS#1 v1.5 signature, if using a hash, the hash length
2630 * must be correct. */
2631 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) &&
2632 alg != PSA_ALG_RSA_PKCS1V15_SIGN_RAW )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03002633 {
Gilles Peskine71ac7b12018-06-29 23:36:35 +02002634 if( md_info == NULL )
2635 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine61b91d42018-06-08 16:09:36 +02002636 if( mbedtls_md_get_size( md_info ) != hash_length )
2637 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02002638 }
2639#endif /* MBEDTLS_PKCS1_V15 */
2640
2641#if defined(MBEDTLS_PKCS1_V21)
2642 /* PSS requires a hash internally. */
2643 if( PSA_ALG_IS_RSA_PSS( alg ) )
2644 {
Gilles Peskine61b91d42018-06-08 16:09:36 +02002645 if( md_info == NULL )
2646 return( PSA_ERROR_NOT_SUPPORTED );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03002647 }
Gilles Peskine71ac7b12018-06-29 23:36:35 +02002648#endif /* MBEDTLS_PKCS1_V21 */
2649
Gilles Peskine61b91d42018-06-08 16:09:36 +02002650 return( PSA_SUCCESS );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03002651}
2652
Gilles Peskine2b450e32018-06-27 15:42:46 +02002653static psa_status_t psa_rsa_sign( mbedtls_rsa_context *rsa,
2654 psa_algorithm_t alg,
2655 const uint8_t *hash,
2656 size_t hash_length,
2657 uint8_t *signature,
2658 size_t signature_size,
2659 size_t *signature_length )
2660{
2661 psa_status_t status;
2662 int ret;
2663 mbedtls_md_type_t md_alg;
2664
2665 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
2666 if( status != PSA_SUCCESS )
2667 return( status );
2668
Gilles Peskine630a18a2018-06-29 17:49:35 +02002669 if( signature_size < mbedtls_rsa_get_len( rsa ) )
Gilles Peskine2b450e32018-06-27 15:42:46 +02002670 return( PSA_ERROR_BUFFER_TOO_SMALL );
2671
2672#if defined(MBEDTLS_PKCS1_V15)
2673 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
2674 {
2675 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
2676 MBEDTLS_MD_NONE );
2677 ret = mbedtls_rsa_pkcs1_sign( rsa,
2678 mbedtls_ctr_drbg_random,
2679 &global_data.ctr_drbg,
2680 MBEDTLS_RSA_PRIVATE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01002681 md_alg,
2682 (unsigned int) hash_length,
2683 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02002684 signature );
2685 }
2686 else
2687#endif /* MBEDTLS_PKCS1_V15 */
2688#if defined(MBEDTLS_PKCS1_V21)
2689 if( PSA_ALG_IS_RSA_PSS( alg ) )
2690 {
2691 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
2692 ret = mbedtls_rsa_rsassa_pss_sign( rsa,
2693 mbedtls_ctr_drbg_random,
2694 &global_data.ctr_drbg,
2695 MBEDTLS_RSA_PRIVATE,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02002696 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01002697 (unsigned int) hash_length,
2698 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02002699 signature );
2700 }
2701 else
2702#endif /* MBEDTLS_PKCS1_V21 */
2703 {
2704 return( PSA_ERROR_INVALID_ARGUMENT );
2705 }
2706
2707 if( ret == 0 )
Gilles Peskine630a18a2018-06-29 17:49:35 +02002708 *signature_length = mbedtls_rsa_get_len( rsa );
Gilles Peskine2b450e32018-06-27 15:42:46 +02002709 return( mbedtls_to_psa_error( ret ) );
2710}
2711
2712static psa_status_t psa_rsa_verify( mbedtls_rsa_context *rsa,
2713 psa_algorithm_t alg,
2714 const uint8_t *hash,
2715 size_t hash_length,
2716 const uint8_t *signature,
2717 size_t signature_length )
2718{
2719 psa_status_t status;
2720 int ret;
2721 mbedtls_md_type_t md_alg;
2722
2723 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
2724 if( status != PSA_SUCCESS )
2725 return( status );
2726
Gilles Peskine630a18a2018-06-29 17:49:35 +02002727 if( signature_length < mbedtls_rsa_get_len( rsa ) )
Gilles Peskine2b450e32018-06-27 15:42:46 +02002728 return( PSA_ERROR_BUFFER_TOO_SMALL );
2729
2730#if defined(MBEDTLS_PKCS1_V15)
2731 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
2732 {
2733 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
2734 MBEDTLS_MD_NONE );
2735 ret = mbedtls_rsa_pkcs1_verify( rsa,
2736 mbedtls_ctr_drbg_random,
2737 &global_data.ctr_drbg,
2738 MBEDTLS_RSA_PUBLIC,
2739 md_alg,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01002740 (unsigned int) hash_length,
Gilles Peskine2b450e32018-06-27 15:42:46 +02002741 hash,
2742 signature );
2743 }
2744 else
2745#endif /* MBEDTLS_PKCS1_V15 */
2746#if defined(MBEDTLS_PKCS1_V21)
2747 if( PSA_ALG_IS_RSA_PSS( alg ) )
2748 {
2749 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
2750 ret = mbedtls_rsa_rsassa_pss_verify( rsa,
2751 mbedtls_ctr_drbg_random,
2752 &global_data.ctr_drbg,
2753 MBEDTLS_RSA_PUBLIC,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02002754 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01002755 (unsigned int) hash_length,
2756 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02002757 signature );
2758 }
2759 else
2760#endif /* MBEDTLS_PKCS1_V21 */
2761 {
2762 return( PSA_ERROR_INVALID_ARGUMENT );
2763 }
Gilles Peskineef12c632018-09-13 20:37:48 +02002764
2765 /* Mbed TLS distinguishes "invalid padding" from "valid padding but
2766 * the rest of the signature is invalid". This has little use in
2767 * practice and PSA doesn't report this distinction. */
2768 if( ret == MBEDTLS_ERR_RSA_INVALID_PADDING )
2769 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine2b450e32018-06-27 15:42:46 +02002770 return( mbedtls_to_psa_error( ret ) );
2771}
2772#endif /* MBEDTLS_RSA_C */
2773
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002774#if defined(MBEDTLS_ECDSA_C)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002775/* `ecp` cannot be const because `ecp->grp` needs to be non-const
2776 * for mbedtls_ecdsa_sign() and mbedtls_ecdsa_sign_det()
2777 * (even though these functions don't modify it). */
2778static psa_status_t psa_ecdsa_sign( mbedtls_ecp_keypair *ecp,
2779 psa_algorithm_t alg,
2780 const uint8_t *hash,
2781 size_t hash_length,
2782 uint8_t *signature,
2783 size_t signature_size,
2784 size_t *signature_length )
2785{
2786 int ret;
2787 mbedtls_mpi r, s;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02002788 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002789 mbedtls_mpi_init( &r );
2790 mbedtls_mpi_init( &s );
2791
Gilles Peskineeae6eee2018-06-28 13:56:01 +02002792 if( signature_size < 2 * curve_bytes )
2793 {
2794 ret = MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL;
2795 goto cleanup;
2796 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002797
Gilles Peskinea05219c2018-11-16 16:02:56 +01002798#if defined(MBEDTLS_ECDSA_DETERMINISTIC)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002799 if( PSA_ALG_DSA_IS_DETERMINISTIC( alg ) )
2800 {
2801 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
2802 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
2803 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
2804 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign_det( &ecp->grp, &r, &s, &ecp->d,
2805 hash, hash_length,
2806 md_alg ) );
2807 }
2808 else
Gilles Peskinea05219c2018-11-16 16:02:56 +01002809#endif /* MBEDTLS_ECDSA_DETERMINISTIC */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002810 {
Gilles Peskinea05219c2018-11-16 16:02:56 +01002811 (void) alg;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002812 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign( &ecp->grp, &r, &s, &ecp->d,
2813 hash, hash_length,
2814 mbedtls_ctr_drbg_random,
2815 &global_data.ctr_drbg ) );
2816 }
Gilles Peskineeae6eee2018-06-28 13:56:01 +02002817
2818 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &r,
2819 signature,
2820 curve_bytes ) );
2821 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &s,
2822 signature + curve_bytes,
2823 curve_bytes ) );
2824
2825cleanup:
2826 mbedtls_mpi_free( &r );
2827 mbedtls_mpi_free( &s );
2828 if( ret == 0 )
2829 *signature_length = 2 * curve_bytes;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02002830 return( mbedtls_to_psa_error( ret ) );
2831}
2832
2833static psa_status_t psa_ecdsa_verify( mbedtls_ecp_keypair *ecp,
2834 const uint8_t *hash,
2835 size_t hash_length,
2836 const uint8_t *signature,
2837 size_t signature_length )
2838{
2839 int ret;
2840 mbedtls_mpi r, s;
2841 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
2842 mbedtls_mpi_init( &r );
2843 mbedtls_mpi_init( &s );
2844
2845 if( signature_length != 2 * curve_bytes )
2846 return( PSA_ERROR_INVALID_SIGNATURE );
2847
2848 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &r,
2849 signature,
2850 curve_bytes ) );
2851 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &s,
2852 signature + curve_bytes,
2853 curve_bytes ) );
2854
2855 ret = mbedtls_ecdsa_verify( &ecp->grp, hash, hash_length,
2856 &ecp->Q, &r, &s );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002857
2858cleanup:
2859 mbedtls_mpi_free( &r );
2860 mbedtls_mpi_free( &s );
2861 return( mbedtls_to_psa_error( ret ) );
2862}
2863#endif /* MBEDTLS_ECDSA_C */
2864
Gilles Peskinec5487a82018-12-03 18:08:14 +01002865psa_status_t psa_asymmetric_sign( psa_key_handle_t handle,
Gilles Peskine61b91d42018-06-08 16:09:36 +02002866 psa_algorithm_t alg,
2867 const uint8_t *hash,
2868 size_t hash_length,
Gilles Peskine61b91d42018-06-08 16:09:36 +02002869 uint8_t *signature,
2870 size_t signature_size,
2871 size_t *signature_length )
Gilles Peskine20035e32018-02-03 22:44:14 +01002872{
Gilles Peskine2f060a82018-12-04 17:12:32 +01002873 psa_key_slot_t *slot;
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02002874 psa_status_t status;
2875
2876 *signature_length = signature_size;
2877
Gilles Peskinec5487a82018-12-03 18:08:14 +01002878 status = psa_get_key_from_slot( handle, &slot, PSA_KEY_USAGE_SIGN, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02002879 if( status != PSA_SUCCESS )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02002880 goto exit;
Gilles Peskinec93b80c2019-05-16 19:39:54 +02002881 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->type ) )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02002882 {
2883 status = PSA_ERROR_INVALID_ARGUMENT;
2884 goto exit;
2885 }
Gilles Peskine20035e32018-02-03 22:44:14 +01002886
Gilles Peskine20035e32018-02-03 22:44:14 +01002887#if defined(MBEDTLS_RSA_C)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02002888 if( slot->type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskine20035e32018-02-03 22:44:14 +01002889 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02002890 status = psa_rsa_sign( slot->data.rsa,
2891 alg,
2892 hash, hash_length,
2893 signature, signature_size,
2894 signature_length );
Gilles Peskine20035e32018-02-03 22:44:14 +01002895 }
2896 else
2897#endif /* defined(MBEDTLS_RSA_C) */
2898#if defined(MBEDTLS_ECP_C)
2899 if( PSA_KEY_TYPE_IS_ECC( slot->type ) )
2900 {
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002901#if defined(MBEDTLS_ECDSA_C)
Gilles Peskinea05219c2018-11-16 16:02:56 +01002902 if(
2903#if defined(MBEDTLS_ECDSA_DETERMINISTIC)
2904 PSA_ALG_IS_ECDSA( alg )
2905#else
2906 PSA_ALG_IS_RANDOMIZED_ECDSA( alg )
2907#endif
2908 )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02002909 status = psa_ecdsa_sign( slot->data.ecp,
2910 alg,
2911 hash, hash_length,
2912 signature, signature_size,
2913 signature_length );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002914 else
2915#endif /* defined(MBEDTLS_ECDSA_C) */
2916 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02002917 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002918 }
itayzafrir5c753392018-05-08 11:18:38 +03002919 }
2920 else
2921#endif /* defined(MBEDTLS_ECP_C) */
2922 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02002923 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine20035e32018-02-03 22:44:14 +01002924 }
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02002925
2926exit:
2927 /* Fill the unused part of the output buffer (the whole buffer on error,
2928 * the trailing part on success) with something that isn't a valid mac
2929 * (barring an attack on the mac and deliberately-crafted input),
2930 * in case the caller doesn't check the return status properly. */
2931 if( status == PSA_SUCCESS )
2932 memset( signature + *signature_length, '!',
2933 signature_size - *signature_length );
Gilles Peskine46f1fd72018-06-28 19:31:31 +02002934 else if( signature_size != 0 )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02002935 memset( signature, '!', signature_size );
Gilles Peskine46f1fd72018-06-28 19:31:31 +02002936 /* If signature_size is 0 then we have nothing to do. We must not call
2937 * memset because signature may be NULL in this case. */
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02002938 return( status );
itayzafrir5c753392018-05-08 11:18:38 +03002939}
2940
Gilles Peskinec5487a82018-12-03 18:08:14 +01002941psa_status_t psa_asymmetric_verify( psa_key_handle_t handle,
itayzafrir5c753392018-05-08 11:18:38 +03002942 psa_algorithm_t alg,
2943 const uint8_t *hash,
2944 size_t hash_length,
Gilles Peskinee9191ff2018-06-27 14:58:41 +02002945 const uint8_t *signature,
Gilles Peskine526fab02018-06-27 18:19:40 +02002946 size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03002947{
Gilles Peskine2f060a82018-12-04 17:12:32 +01002948 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02002949 psa_status_t status;
Gilles Peskine2b450e32018-06-27 15:42:46 +02002950
Gilles Peskinec5487a82018-12-03 18:08:14 +01002951 status = psa_get_key_from_slot( handle, &slot, PSA_KEY_USAGE_VERIFY, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02002952 if( status != PSA_SUCCESS )
2953 return( status );
itayzafrir5c753392018-05-08 11:18:38 +03002954
Gilles Peskine61b91d42018-06-08 16:09:36 +02002955#if defined(MBEDTLS_RSA_C)
Gilles Peskined8008d62018-06-29 19:51:51 +02002956 if( PSA_KEY_TYPE_IS_RSA( slot->type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002957 {
Gilles Peskine2b450e32018-06-27 15:42:46 +02002958 return( psa_rsa_verify( slot->data.rsa,
2959 alg,
2960 hash, hash_length,
2961 signature, signature_length ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002962 }
2963 else
2964#endif /* defined(MBEDTLS_RSA_C) */
itayzafrir5c753392018-05-08 11:18:38 +03002965#if defined(MBEDTLS_ECP_C)
2966 if( PSA_KEY_TYPE_IS_ECC( slot->type ) )
2967 {
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002968#if defined(MBEDTLS_ECDSA_C)
2969 if( PSA_ALG_IS_ECDSA( alg ) )
Gilles Peskineeae6eee2018-06-28 13:56:01 +02002970 return( psa_ecdsa_verify( slot->data.ecp,
2971 hash, hash_length,
2972 signature, signature_length ) );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002973 else
2974#endif /* defined(MBEDTLS_ECDSA_C) */
2975 {
2976 return( PSA_ERROR_INVALID_ARGUMENT );
2977 }
itayzafrir5c753392018-05-08 11:18:38 +03002978 }
Gilles Peskine20035e32018-02-03 22:44:14 +01002979 else
2980#endif /* defined(MBEDTLS_ECP_C) */
2981 {
2982 return( PSA_ERROR_NOT_SUPPORTED );
2983 }
2984}
2985
Gilles Peskine072ac562018-06-30 00:21:29 +02002986#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PKCS1_V21)
2987static void psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
2988 mbedtls_rsa_context *rsa )
2989{
2990 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
2991 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
2992 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
2993 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
2994}
2995#endif /* defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PKCS1_V21) */
2996
Gilles Peskinec5487a82018-12-03 18:08:14 +01002997psa_status_t psa_asymmetric_encrypt( psa_key_handle_t handle,
Gilles Peskine61b91d42018-06-08 16:09:36 +02002998 psa_algorithm_t alg,
2999 const uint8_t *input,
3000 size_t input_length,
3001 const uint8_t *salt,
3002 size_t salt_length,
3003 uint8_t *output,
3004 size_t output_size,
3005 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003006{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003007 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003008 psa_status_t status;
3009
Darryl Green5cc689a2018-07-24 15:34:10 +01003010 (void) input;
3011 (void) input_length;
3012 (void) salt;
3013 (void) output;
3014 (void) output_size;
3015
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003016 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003017
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003018 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3019 return( PSA_ERROR_INVALID_ARGUMENT );
3020
Gilles Peskinec5487a82018-12-03 18:08:14 +01003021 status = psa_get_key_from_slot( handle, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003022 if( status != PSA_SUCCESS )
3023 return( status );
Gilles Peskine35da9a22018-06-29 19:17:49 +02003024 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->type ) ||
Gilles Peskinec93b80c2019-05-16 19:39:54 +02003025 PSA_KEY_TYPE_IS_KEY_PAIR( slot->type ) ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003026 return( PSA_ERROR_INVALID_ARGUMENT );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003027
3028#if defined(MBEDTLS_RSA_C)
Gilles Peskined8008d62018-06-29 19:51:51 +02003029 if( PSA_KEY_TYPE_IS_RSA( slot->type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003030 {
3031 mbedtls_rsa_context *rsa = slot->data.rsa;
3032 int ret;
Gilles Peskine630a18a2018-06-29 17:49:35 +02003033 if( output_size < mbedtls_rsa_get_len( rsa ) )
Gilles Peskine61b91d42018-06-08 16:09:36 +02003034 return( PSA_ERROR_INVALID_ARGUMENT );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003035#if defined(MBEDTLS_PKCS1_V15)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003036 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003037 {
Gilles Peskine61b91d42018-06-08 16:09:36 +02003038 ret = mbedtls_rsa_pkcs1_encrypt( rsa,
3039 mbedtls_ctr_drbg_random,
3040 &global_data.ctr_drbg,
3041 MBEDTLS_RSA_PUBLIC,
3042 input_length,
3043 input,
3044 output );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003045 }
3046 else
3047#endif /* MBEDTLS_PKCS1_V15 */
3048#if defined(MBEDTLS_PKCS1_V21)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003049 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003050 {
Gilles Peskine072ac562018-06-30 00:21:29 +02003051 psa_rsa_oaep_set_padding_mode( alg, rsa );
3052 ret = mbedtls_rsa_rsaes_oaep_encrypt( rsa,
3053 mbedtls_ctr_drbg_random,
3054 &global_data.ctr_drbg,
3055 MBEDTLS_RSA_PUBLIC,
3056 salt, salt_length,
3057 input_length,
3058 input,
3059 output );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003060 }
3061 else
3062#endif /* MBEDTLS_PKCS1_V21 */
3063 {
3064 return( PSA_ERROR_INVALID_ARGUMENT );
3065 }
3066 if( ret == 0 )
Gilles Peskine630a18a2018-06-29 17:49:35 +02003067 *output_length = mbedtls_rsa_get_len( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003068 return( mbedtls_to_psa_error( ret ) );
3069 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003070 else
Gilles Peskineb75e4f12018-06-08 17:44:47 +02003071#endif /* defined(MBEDTLS_RSA_C) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003072 {
3073 return( PSA_ERROR_NOT_SUPPORTED );
3074 }
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003075}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003076
Gilles Peskinec5487a82018-12-03 18:08:14 +01003077psa_status_t psa_asymmetric_decrypt( psa_key_handle_t handle,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003078 psa_algorithm_t alg,
3079 const uint8_t *input,
3080 size_t input_length,
3081 const uint8_t *salt,
3082 size_t salt_length,
3083 uint8_t *output,
3084 size_t output_size,
3085 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003086{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003087 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003088 psa_status_t status;
3089
Darryl Green5cc689a2018-07-24 15:34:10 +01003090 (void) input;
3091 (void) input_length;
3092 (void) salt;
3093 (void) output;
3094 (void) output_size;
3095
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003096 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003097
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003098 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3099 return( PSA_ERROR_INVALID_ARGUMENT );
3100
Gilles Peskinec5487a82018-12-03 18:08:14 +01003101 status = psa_get_key_from_slot( handle, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003102 if( status != PSA_SUCCESS )
3103 return( status );
Gilles Peskinec93b80c2019-05-16 19:39:54 +02003104 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003105 return( PSA_ERROR_INVALID_ARGUMENT );
3106
3107#if defined(MBEDTLS_RSA_C)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02003108 if( slot->type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003109 {
3110 mbedtls_rsa_context *rsa = slot->data.rsa;
3111 int ret;
3112
Gilles Peskine630a18a2018-06-29 17:49:35 +02003113 if( input_length != mbedtls_rsa_get_len( rsa ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003114 return( PSA_ERROR_INVALID_ARGUMENT );
3115
3116#if defined(MBEDTLS_PKCS1_V15)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003117 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003118 {
Gilles Peskine61b91d42018-06-08 16:09:36 +02003119 ret = mbedtls_rsa_pkcs1_decrypt( rsa,
3120 mbedtls_ctr_drbg_random,
3121 &global_data.ctr_drbg,
3122 MBEDTLS_RSA_PRIVATE,
3123 output_length,
3124 input,
3125 output,
3126 output_size );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003127 }
3128 else
3129#endif /* MBEDTLS_PKCS1_V15 */
3130#if defined(MBEDTLS_PKCS1_V21)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003131 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003132 {
Gilles Peskine072ac562018-06-30 00:21:29 +02003133 psa_rsa_oaep_set_padding_mode( alg, rsa );
3134 ret = mbedtls_rsa_rsaes_oaep_decrypt( rsa,
3135 mbedtls_ctr_drbg_random,
3136 &global_data.ctr_drbg,
3137 MBEDTLS_RSA_PRIVATE,
3138 salt, salt_length,
3139 output_length,
3140 input,
3141 output,
3142 output_size );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003143 }
3144 else
3145#endif /* MBEDTLS_PKCS1_V21 */
3146 {
3147 return( PSA_ERROR_INVALID_ARGUMENT );
3148 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03003149
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003150 return( mbedtls_to_psa_error( ret ) );
3151 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003152 else
Gilles Peskineb75e4f12018-06-08 17:44:47 +02003153#endif /* defined(MBEDTLS_RSA_C) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003154 {
3155 return( PSA_ERROR_NOT_SUPPORTED );
3156 }
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003157}
Gilles Peskine20035e32018-02-03 22:44:14 +01003158
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003159
3160
mohammad1603503973b2018-03-12 15:59:30 +02003161/****************************************************************/
3162/* Symmetric cryptography */
3163/****************************************************************/
3164
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003165/* Initialize the cipher operation structure. Once this function has been
3166 * called, psa_cipher_abort can run and will do the right thing. */
3167static psa_status_t psa_cipher_init( psa_cipher_operation_t *operation,
3168 psa_algorithm_t alg )
3169{
Gilles Peskinec06e0712018-06-20 16:21:04 +02003170 if( ! PSA_ALG_IS_CIPHER( alg ) )
3171 {
3172 memset( operation, 0, sizeof( *operation ) );
3173 return( PSA_ERROR_INVALID_ARGUMENT );
3174 }
3175
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003176 operation->alg = alg;
3177 operation->key_set = 0;
3178 operation->iv_set = 0;
3179 operation->iv_required = 1;
3180 operation->iv_size = 0;
3181 operation->block_size = 0;
3182 mbedtls_cipher_init( &operation->ctx.cipher );
3183 return( PSA_SUCCESS );
3184}
3185
Gilles Peskinee553c652018-06-04 16:22:46 +02003186static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01003187 psa_key_handle_t handle,
Gilles Peskine7e928852018-06-04 16:23:10 +02003188 psa_algorithm_t alg,
3189 mbedtls_operation_t cipher_operation )
mohammad1603503973b2018-03-12 15:59:30 +02003190{
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003191 int ret = 0;
3192 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003193 psa_key_slot_t *slot;
mohammad1603503973b2018-03-12 15:59:30 +02003194 size_t key_bits;
3195 const mbedtls_cipher_info_t *cipher_info = NULL;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003196 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
3197 PSA_KEY_USAGE_ENCRYPT :
3198 PSA_KEY_USAGE_DECRYPT );
mohammad1603503973b2018-03-12 15:59:30 +02003199
Jaeden Amero36ee5d02019-02-19 09:25:10 +00003200 /* A context must be freshly initialized before it can be set up. */
3201 if( operation->alg != 0 )
3202 {
3203 return( PSA_ERROR_BAD_STATE );
3204 }
3205
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003206 status = psa_cipher_init( operation, alg );
3207 if( status != PSA_SUCCESS )
3208 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003209
Gilles Peskinec5487a82018-12-03 18:08:14 +01003210 status = psa_get_key_from_slot( handle, &slot, usage, alg);
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003211 if( status != PSA_SUCCESS )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003212 goto exit;
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02003213 key_bits = psa_get_key_slot_bits( slot );
mohammad1603503973b2018-03-12 15:59:30 +02003214
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02003215 cipher_info = mbedtls_cipher_info_from_psa( alg, slot->type, key_bits, NULL );
mohammad1603503973b2018-03-12 15:59:30 +02003216 if( cipher_info == NULL )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003217 {
3218 status = PSA_ERROR_NOT_SUPPORTED;
3219 goto exit;
3220 }
mohammad1603503973b2018-03-12 15:59:30 +02003221
mohammad1603503973b2018-03-12 15:59:30 +02003222 ret = mbedtls_cipher_setup( &operation->ctx.cipher, cipher_info );
Moran Peker41deec42018-04-04 15:43:05 +03003223 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003224 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02003225
Gilles Peskine9ad29e22018-06-21 09:40:04 +02003226#if defined(MBEDTLS_DES_C)
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02003227 if( slot->type == PSA_KEY_TYPE_DES && key_bits == 128 )
Gilles Peskine9ad29e22018-06-21 09:40:04 +02003228 {
3229 /* Two-key Triple-DES is 3-key Triple-DES with K1=K3 */
3230 unsigned char keys[24];
3231 memcpy( keys, slot->data.raw.data, 16 );
3232 memcpy( keys + 16, slot->data.raw.data, 8 );
3233 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
3234 keys,
3235 192, cipher_operation );
3236 }
3237 else
3238#endif
3239 {
3240 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
3241 slot->data.raw.data,
Jaeden Amero23bbb752018-06-26 14:16:54 +01003242 (int) key_bits, cipher_operation );
Gilles Peskine9ad29e22018-06-21 09:40:04 +02003243 }
Moran Peker41deec42018-04-04 15:43:05 +03003244 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003245 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02003246
mohammad16038481e742018-03-18 13:57:31 +02003247#if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003248 switch( alg )
mohammad16038481e742018-03-18 13:57:31 +02003249 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003250 case PSA_ALG_CBC_NO_PADDING:
3251 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
3252 MBEDTLS_PADDING_NONE );
3253 break;
3254 case PSA_ALG_CBC_PKCS7:
3255 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
3256 MBEDTLS_PADDING_PKCS7 );
3257 break;
3258 default:
3259 /* The algorithm doesn't involve padding. */
3260 ret = 0;
3261 break;
3262 }
3263 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003264 goto exit;
mohammad16038481e742018-03-18 13:57:31 +02003265#endif //MBEDTLS_CIPHER_MODE_WITH_PADDING
3266
mohammad1603503973b2018-03-12 15:59:30 +02003267 operation->key_set = 1;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003268 operation->block_size = ( PSA_ALG_IS_STREAM_CIPHER( alg ) ? 1 :
3269 PSA_BLOCK_CIPHER_BLOCK_SIZE( slot->type ) );
3270 if( alg & PSA_ALG_CIPHER_FROM_BLOCK_FLAG )
mohammad16038481e742018-03-18 13:57:31 +02003271 {
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02003272 operation->iv_size = PSA_BLOCK_CIPHER_BLOCK_SIZE( slot->type );
mohammad16038481e742018-03-18 13:57:31 +02003273 }
Gilles Peskine26869f22019-05-06 15:25:00 +02003274#if defined(MBEDTLS_CHACHA20_C)
3275 else
3276 if( alg == PSA_ALG_CHACHA20 )
3277 operation->iv_size = 12;
3278#endif
mohammad1603503973b2018-03-12 15:59:30 +02003279
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003280exit:
3281 if( status == 0 )
3282 status = mbedtls_to_psa_error( ret );
3283 if( status != 0 )
3284 psa_cipher_abort( operation );
3285 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003286}
3287
Gilles Peskinefe119512018-07-08 21:39:34 +02003288psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01003289 psa_key_handle_t handle,
Gilles Peskinefe119512018-07-08 21:39:34 +02003290 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003291{
Gilles Peskinec5487a82018-12-03 18:08:14 +01003292 return( psa_cipher_setup( operation, handle, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003293}
3294
Gilles Peskinefe119512018-07-08 21:39:34 +02003295psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01003296 psa_key_handle_t handle,
Gilles Peskinefe119512018-07-08 21:39:34 +02003297 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003298{
Gilles Peskinec5487a82018-12-03 18:08:14 +01003299 return( psa_cipher_setup( operation, handle, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003300}
3301
Gilles Peskinefe119512018-07-08 21:39:34 +02003302psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003303 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003304 size_t iv_size,
3305 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003306{
itayzafrir534bd7c2018-08-02 13:56:32 +03003307 psa_status_t status;
3308 int ret;
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02003309 if( operation->iv_set || ! operation->iv_required )
itayzafrir534bd7c2018-08-02 13:56:32 +03003310 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003311 return( PSA_ERROR_BAD_STATE );
itayzafrir534bd7c2018-08-02 13:56:32 +03003312 }
Moran Peker41deec42018-04-04 15:43:05 +03003313 if( iv_size < operation->iv_size )
mohammad1603503973b2018-03-12 15:59:30 +02003314 {
itayzafrir534bd7c2018-08-02 13:56:32 +03003315 status = PSA_ERROR_BUFFER_TOO_SMALL;
Moran Peker41deec42018-04-04 15:43:05 +03003316 goto exit;
3317 }
Gilles Peskine7e928852018-06-04 16:23:10 +02003318 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg,
3319 iv, operation->iv_size );
Moran Peker41deec42018-04-04 15:43:05 +03003320 if( ret != 0 )
3321 {
itayzafrir534bd7c2018-08-02 13:56:32 +03003322 status = mbedtls_to_psa_error( ret );
Gilles Peskinee553c652018-06-04 16:22:46 +02003323 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02003324 }
Gilles Peskinee553c652018-06-04 16:22:46 +02003325
mohammad16038481e742018-03-18 13:57:31 +02003326 *iv_length = operation->iv_size;
itayzafrir534bd7c2018-08-02 13:56:32 +03003327 status = psa_cipher_set_iv( operation, iv, *iv_length );
Moran Peker41deec42018-04-04 15:43:05 +03003328
Moran Peker395db872018-05-31 14:07:14 +03003329exit:
itayzafrir534bd7c2018-08-02 13:56:32 +03003330 if( status != PSA_SUCCESS )
Moran Peker395db872018-05-31 14:07:14 +03003331 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003332 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003333}
3334
Gilles Peskinefe119512018-07-08 21:39:34 +02003335psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003336 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003337 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003338{
itayzafrir534bd7c2018-08-02 13:56:32 +03003339 psa_status_t status;
3340 int ret;
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02003341 if( operation->iv_set || ! operation->iv_required )
itayzafrir534bd7c2018-08-02 13:56:32 +03003342 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003343 return( PSA_ERROR_BAD_STATE );
itayzafrir534bd7c2018-08-02 13:56:32 +03003344 }
Moran Pekera28258c2018-05-29 16:25:04 +03003345 if( iv_length != operation->iv_size )
Moran Peker71f19ae2018-04-22 20:23:16 +03003346 {
itayzafrir534bd7c2018-08-02 13:56:32 +03003347 status = PSA_ERROR_INVALID_ARGUMENT;
3348 goto exit;
Moran Peker71f19ae2018-04-22 20:23:16 +03003349 }
itayzafrir534bd7c2018-08-02 13:56:32 +03003350 ret = mbedtls_cipher_set_iv( &operation->ctx.cipher, iv, iv_length );
3351 status = mbedtls_to_psa_error( ret );
3352exit:
3353 if( status == PSA_SUCCESS )
3354 operation->iv_set = 1;
3355 else
mohammad1603503973b2018-03-12 15:59:30 +02003356 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003357 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003358}
3359
Gilles Peskinee553c652018-06-04 16:22:46 +02003360psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
3361 const uint8_t *input,
3362 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003363 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02003364 size_t output_size,
3365 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003366{
itayzafrir534bd7c2018-08-02 13:56:32 +03003367 psa_status_t status;
3368 int ret;
Gilles Peskine89d789c2018-06-04 17:17:16 +02003369 size_t expected_output_size;
Jaeden Ameroab439972019-02-15 14:12:05 +00003370
3371 if( operation->alg == 0 )
3372 {
3373 return( PSA_ERROR_BAD_STATE );
3374 }
3375
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003376 if( ! PSA_ALG_IS_STREAM_CIPHER( operation->alg ) )
Gilles Peskine89d789c2018-06-04 17:17:16 +02003377 {
3378 /* Take the unprocessed partial block left over from previous
3379 * update calls, if any, plus the input to this call. Remove
3380 * the last partial block, if any. You get the data that will be
3381 * output in this call. */
3382 expected_output_size =
3383 ( operation->ctx.cipher.unprocessed_len + input_length )
3384 / operation->block_size * operation->block_size;
3385 }
3386 else
3387 {
3388 expected_output_size = input_length;
3389 }
itayzafrir534bd7c2018-08-02 13:56:32 +03003390
Gilles Peskine89d789c2018-06-04 17:17:16 +02003391 if( output_size < expected_output_size )
itayzafrir534bd7c2018-08-02 13:56:32 +03003392 {
3393 status = PSA_ERROR_BUFFER_TOO_SMALL;
3394 goto exit;
3395 }
mohammad160382759612018-03-12 18:16:40 +02003396
mohammad1603503973b2018-03-12 15:59:30 +02003397 ret = mbedtls_cipher_update( &operation->ctx.cipher, input,
Gilles Peskinee553c652018-06-04 16:22:46 +02003398 input_length, output, output_length );
itayzafrir534bd7c2018-08-02 13:56:32 +03003399 status = mbedtls_to_psa_error( ret );
3400exit:
3401 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02003402 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003403 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003404}
3405
Gilles Peskinee553c652018-06-04 16:22:46 +02003406psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
3407 uint8_t *output,
3408 size_t output_size,
3409 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003410{
David Saadab4ecc272019-02-14 13:48:10 +02003411 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Janos Follath315b51c2018-07-09 16:04:51 +01003412 int cipher_ret = MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE;
Gilles Peskinee553c652018-06-04 16:22:46 +02003413 uint8_t temp_output_buffer[MBEDTLS_MAX_BLOCK_LENGTH];
Moran Pekerbed71a22018-04-22 20:19:20 +03003414
mohammad1603503973b2018-03-12 15:59:30 +02003415 if( ! operation->key_set )
Moran Pekerdc38ebc2018-04-30 15:45:34 +03003416 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003417 return( PSA_ERROR_BAD_STATE );
Moran Peker7cb22b82018-06-05 11:40:02 +03003418 }
3419 if( operation->iv_required && ! operation->iv_set )
3420 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003421 return( PSA_ERROR_BAD_STATE );
Moran Peker7cb22b82018-06-05 11:40:02 +03003422 }
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003423
Gilles Peskine2c5219a2018-06-06 15:12:32 +02003424 if( operation->ctx.cipher.operation == MBEDTLS_ENCRYPT &&
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003425 operation->alg == PSA_ALG_CBC_NO_PADDING &&
3426 operation->ctx.cipher.unprocessed_len != 0 )
Moran Peker7cb22b82018-06-05 11:40:02 +03003427 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003428 status = PSA_ERROR_INVALID_ARGUMENT;
Janos Follath315b51c2018-07-09 16:04:51 +01003429 goto error;
Moran Pekerdc38ebc2018-04-30 15:45:34 +03003430 }
3431
Janos Follath315b51c2018-07-09 16:04:51 +01003432 cipher_ret = mbedtls_cipher_finish( &operation->ctx.cipher,
3433 temp_output_buffer,
3434 output_length );
3435 if( cipher_ret != 0 )
mohammad1603503973b2018-03-12 15:59:30 +02003436 {
Janos Follath315b51c2018-07-09 16:04:51 +01003437 status = mbedtls_to_psa_error( cipher_ret );
3438 goto error;
mohammad1603503973b2018-03-12 15:59:30 +02003439 }
Janos Follath315b51c2018-07-09 16:04:51 +01003440
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003441 if( *output_length == 0 )
Janos Follath315b51c2018-07-09 16:04:51 +01003442 ; /* Nothing to copy. Note that output may be NULL in this case. */
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003443 else if( output_size >= *output_length )
Moran Pekerdc38ebc2018-04-30 15:45:34 +03003444 memcpy( output, temp_output_buffer, *output_length );
3445 else
3446 {
Janos Follath315b51c2018-07-09 16:04:51 +01003447 status = PSA_ERROR_BUFFER_TOO_SMALL;
3448 goto error;
Moran Pekerdc38ebc2018-04-30 15:45:34 +03003449 }
mohammad1603503973b2018-03-12 15:59:30 +02003450
Gilles Peskine3f108122018-12-07 18:14:53 +01003451 mbedtls_platform_zeroize( temp_output_buffer, sizeof( temp_output_buffer ) );
Janos Follath315b51c2018-07-09 16:04:51 +01003452 status = psa_cipher_abort( operation );
3453
3454 return( status );
3455
3456error:
3457
3458 *output_length = 0;
3459
Gilles Peskine3f108122018-12-07 18:14:53 +01003460 mbedtls_platform_zeroize( temp_output_buffer, sizeof( temp_output_buffer ) );
Janos Follath315b51c2018-07-09 16:04:51 +01003461 (void) psa_cipher_abort( operation );
3462
3463 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003464}
3465
Gilles Peskinee553c652018-06-04 16:22:46 +02003466psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
3467{
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003468 if( operation->alg == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02003469 {
3470 /* The object has (apparently) been initialized but it is not
3471 * in use. It's ok to call abort on such an object, and there's
3472 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003473 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02003474 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003475
Gilles Peskinef9c2c092018-06-21 16:57:07 +02003476 /* Sanity check (shouldn't happen: operation->alg should
3477 * always have been initialized to a valid value). */
3478 if( ! PSA_ALG_IS_CIPHER( operation->alg ) )
3479 return( PSA_ERROR_BAD_STATE );
3480
mohammad1603503973b2018-03-12 15:59:30 +02003481 mbedtls_cipher_free( &operation->ctx.cipher );
Gilles Peskinee553c652018-06-04 16:22:46 +02003482
Moran Peker41deec42018-04-04 15:43:05 +03003483 operation->alg = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003484 operation->key_set = 0;
3485 operation->iv_set = 0;
3486 operation->iv_size = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003487 operation->block_size = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003488 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003489
Moran Peker395db872018-05-31 14:07:14 +03003490 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02003491}
3492
Gilles Peskinea0655c32018-04-30 17:06:50 +02003493
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003494
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003495
mohammad16035955c982018-04-26 00:53:03 +03003496/****************************************************************/
3497/* AEAD */
3498/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003499
Gilles Peskineedf9a652018-08-17 18:11:56 +02003500typedef struct
3501{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003502 psa_key_slot_t *slot;
Gilles Peskineedf9a652018-08-17 18:11:56 +02003503 const mbedtls_cipher_info_t *cipher_info;
3504 union
3505 {
3506#if defined(MBEDTLS_CCM_C)
3507 mbedtls_ccm_context ccm;
3508#endif /* MBEDTLS_CCM_C */
3509#if defined(MBEDTLS_GCM_C)
3510 mbedtls_gcm_context gcm;
3511#endif /* MBEDTLS_GCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02003512#if defined(MBEDTLS_CHACHAPOLY_C)
3513 mbedtls_chachapoly_context chachapoly;
3514#endif /* MBEDTLS_CHACHAPOLY_C */
Gilles Peskineedf9a652018-08-17 18:11:56 +02003515 } ctx;
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02003516 psa_algorithm_t core_alg;
3517 uint8_t full_tag_length;
Gilles Peskineedf9a652018-08-17 18:11:56 +02003518 uint8_t tag_length;
3519} aead_operation_t;
3520
Gilles Peskine30a9e412019-01-14 18:36:12 +01003521static void psa_aead_abort_internal( aead_operation_t *operation )
Gilles Peskineedf9a652018-08-17 18:11:56 +02003522{
Gilles Peskinef8a8fe62018-08-21 16:38:05 +02003523 switch( operation->core_alg )
Gilles Peskineedf9a652018-08-17 18:11:56 +02003524 {
3525#if defined(MBEDTLS_CCM_C)
3526 case PSA_ALG_CCM:
3527 mbedtls_ccm_free( &operation->ctx.ccm );
3528 break;
3529#endif /* MBEDTLS_CCM_C */
Gilles Peskineb0b189f2018-11-28 17:30:58 +01003530#if defined(MBEDTLS_GCM_C)
Gilles Peskineedf9a652018-08-17 18:11:56 +02003531 case PSA_ALG_GCM:
3532 mbedtls_gcm_free( &operation->ctx.gcm );
3533 break;
3534#endif /* MBEDTLS_GCM_C */
3535 }
3536}
3537
3538static psa_status_t psa_aead_setup( aead_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01003539 psa_key_handle_t handle,
Gilles Peskineedf9a652018-08-17 18:11:56 +02003540 psa_key_usage_t usage,
3541 psa_algorithm_t alg )
3542{
3543 psa_status_t status;
3544 size_t key_bits;
3545 mbedtls_cipher_id_t cipher_id;
3546
Gilles Peskinec5487a82018-12-03 18:08:14 +01003547 status = psa_get_key_from_slot( handle, &operation->slot, usage, alg );
Gilles Peskineedf9a652018-08-17 18:11:56 +02003548 if( status != PSA_SUCCESS )
3549 return( status );
3550
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02003551 key_bits = psa_get_key_slot_bits( operation->slot );
Gilles Peskineedf9a652018-08-17 18:11:56 +02003552
3553 operation->cipher_info =
3554 mbedtls_cipher_info_from_psa( alg, operation->slot->type, key_bits,
3555 &cipher_id );
3556 if( operation->cipher_info == NULL )
3557 return( PSA_ERROR_NOT_SUPPORTED );
3558
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02003559 switch( PSA_ALG_AEAD_WITH_TAG_LENGTH( alg, 0 ) )
Gilles Peskineedf9a652018-08-17 18:11:56 +02003560 {
3561#if defined(MBEDTLS_CCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02003562 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CCM, 0 ):
3563 operation->core_alg = PSA_ALG_CCM;
3564 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02003565 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.
3566 * The call to mbedtls_ccm_encrypt_and_tag or
3567 * mbedtls_ccm_auth_decrypt will validate the tag length. */
Gilles Peskineedf9a652018-08-17 18:11:56 +02003568 if( PSA_BLOCK_CIPHER_BLOCK_SIZE( operation->slot->type ) != 16 )
3569 return( PSA_ERROR_INVALID_ARGUMENT );
3570 mbedtls_ccm_init( &operation->ctx.ccm );
3571 status = mbedtls_to_psa_error(
3572 mbedtls_ccm_setkey( &operation->ctx.ccm, cipher_id,
3573 operation->slot->data.raw.data,
3574 (unsigned int) key_bits ) );
3575 if( status != 0 )
3576 goto cleanup;
3577 break;
3578#endif /* MBEDTLS_CCM_C */
3579
3580#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02003581 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_GCM, 0 ):
3582 operation->core_alg = PSA_ALG_GCM;
3583 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02003584 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16.
3585 * The call to mbedtls_gcm_crypt_and_tag or
3586 * mbedtls_gcm_auth_decrypt will validate the tag length. */
Gilles Peskineedf9a652018-08-17 18:11:56 +02003587 if( PSA_BLOCK_CIPHER_BLOCK_SIZE( operation->slot->type ) != 16 )
3588 return( PSA_ERROR_INVALID_ARGUMENT );
3589 mbedtls_gcm_init( &operation->ctx.gcm );
3590 status = mbedtls_to_psa_error(
3591 mbedtls_gcm_setkey( &operation->ctx.gcm, cipher_id,
3592 operation->slot->data.raw.data,
3593 (unsigned int) key_bits ) );
Gilles Peskinef7e7b012019-05-06 15:27:16 +02003594 if( status != 0 )
3595 goto cleanup;
Gilles Peskineedf9a652018-08-17 18:11:56 +02003596 break;
3597#endif /* MBEDTLS_GCM_C */
3598
Gilles Peskine26869f22019-05-06 15:25:00 +02003599#if defined(MBEDTLS_CHACHAPOLY_C)
3600 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CHACHA20_POLY1305, 0 ):
3601 operation->core_alg = PSA_ALG_CHACHA20_POLY1305;
3602 operation->full_tag_length = 16;
3603 /* We only support the default tag length. */
3604 if( alg != PSA_ALG_CHACHA20_POLY1305 )
3605 return( PSA_ERROR_NOT_SUPPORTED );
3606 mbedtls_chachapoly_init( &operation->ctx.chachapoly );
3607 status = mbedtls_to_psa_error(
3608 mbedtls_chachapoly_setkey( &operation->ctx.chachapoly,
3609 operation->slot->data.raw.data ) );
3610 if( status != 0 )
3611 goto cleanup;
3612 break;
3613#endif /* MBEDTLS_CHACHAPOLY_C */
3614
Gilles Peskineedf9a652018-08-17 18:11:56 +02003615 default:
3616 return( PSA_ERROR_NOT_SUPPORTED );
3617 }
3618
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02003619 if( PSA_AEAD_TAG_LENGTH( alg ) > operation->full_tag_length )
3620 {
3621 status = PSA_ERROR_INVALID_ARGUMENT;
3622 goto cleanup;
3623 }
3624 operation->tag_length = PSA_AEAD_TAG_LENGTH( alg );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02003625
Gilles Peskineedf9a652018-08-17 18:11:56 +02003626 return( PSA_SUCCESS );
3627
3628cleanup:
Gilles Peskine30a9e412019-01-14 18:36:12 +01003629 psa_aead_abort_internal( operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02003630 return( status );
3631}
3632
Gilles Peskinec5487a82018-12-03 18:08:14 +01003633psa_status_t psa_aead_encrypt( psa_key_handle_t handle,
mohammad16035955c982018-04-26 00:53:03 +03003634 psa_algorithm_t alg,
3635 const uint8_t *nonce,
3636 size_t nonce_length,
3637 const uint8_t *additional_data,
3638 size_t additional_data_length,
3639 const uint8_t *plaintext,
3640 size_t plaintext_length,
3641 uint8_t *ciphertext,
3642 size_t ciphertext_size,
3643 size_t *ciphertext_length )
3644{
mohammad16035955c982018-04-26 00:53:03 +03003645 psa_status_t status;
Gilles Peskineedf9a652018-08-17 18:11:56 +02003646 aead_operation_t operation;
mohammad160315223a82018-06-03 17:19:55 +03003647 uint8_t *tag;
Gilles Peskine2d277862018-06-18 15:41:12 +02003648
mohammad1603f08a5502018-06-03 15:05:47 +03003649 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07003650
Gilles Peskinec5487a82018-12-03 18:08:14 +01003651 status = psa_aead_setup( &operation, handle, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003652 if( status != PSA_SUCCESS )
3653 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003654
Gilles Peskineedf9a652018-08-17 18:11:56 +02003655 /* For all currently supported modes, the tag is at the end of the
3656 * ciphertext. */
3657 if( ciphertext_size < ( plaintext_length + operation.tag_length ) )
3658 {
3659 status = PSA_ERROR_BUFFER_TOO_SMALL;
3660 goto exit;
3661 }
3662 tag = ciphertext + plaintext_length;
mohammad16035955c982018-04-26 00:53:03 +03003663
Gilles Peskineb0b189f2018-11-28 17:30:58 +01003664#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02003665 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03003666 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02003667 status = mbedtls_to_psa_error(
3668 mbedtls_gcm_crypt_and_tag( &operation.ctx.gcm,
3669 MBEDTLS_GCM_ENCRYPT,
3670 plaintext_length,
3671 nonce, nonce_length,
3672 additional_data, additional_data_length,
3673 plaintext, ciphertext,
3674 operation.tag_length, tag ) );
mohammad16035955c982018-04-26 00:53:03 +03003675 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01003676 else
3677#endif /* MBEDTLS_GCM_C */
3678#if defined(MBEDTLS_CCM_C)
3679 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03003680 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02003681 status = mbedtls_to_psa_error(
3682 mbedtls_ccm_encrypt_and_tag( &operation.ctx.ccm,
3683 plaintext_length,
3684 nonce, nonce_length,
3685 additional_data,
3686 additional_data_length,
3687 plaintext, ciphertext,
3688 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03003689 }
mohammad16035c8845f2018-05-09 05:40:09 -07003690 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01003691#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02003692#if defined(MBEDTLS_CHACHAPOLY_C)
3693 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
3694 {
3695 if( nonce_length != 12 || operation.tag_length != 16 )
3696 {
3697 status = PSA_ERROR_NOT_SUPPORTED;
3698 goto exit;
3699 }
3700 status = mbedtls_to_psa_error(
3701 mbedtls_chachapoly_encrypt_and_tag( &operation.ctx.chachapoly,
3702 plaintext_length,
3703 nonce,
3704 additional_data,
3705 additional_data_length,
3706 plaintext,
3707 ciphertext,
3708 tag ) );
3709 }
3710 else
3711#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad16035c8845f2018-05-09 05:40:09 -07003712 {
mohammad1603554faad2018-06-03 15:07:38 +03003713 return( PSA_ERROR_NOT_SUPPORTED );
mohammad16035c8845f2018-05-09 05:40:09 -07003714 }
Gilles Peskine2d277862018-06-18 15:41:12 +02003715
Gilles Peskineedf9a652018-08-17 18:11:56 +02003716 if( status != PSA_SUCCESS && ciphertext_size != 0 )
3717 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02003718
Gilles Peskineedf9a652018-08-17 18:11:56 +02003719exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01003720 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02003721 if( status == PSA_SUCCESS )
3722 *ciphertext_length = plaintext_length + operation.tag_length;
3723 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003724}
3725
Gilles Peskineee652a32018-06-01 19:23:52 +02003726/* Locate the tag in a ciphertext buffer containing the encrypted data
3727 * followed by the tag. Return the length of the part preceding the tag in
3728 * *plaintext_length. This is the size of the plaintext in modes where
3729 * the encrypted data has the same size as the plaintext, such as
3730 * CCM and GCM. */
3731static psa_status_t psa_aead_unpadded_locate_tag( size_t tag_length,
3732 const uint8_t *ciphertext,
3733 size_t ciphertext_length,
3734 size_t plaintext_size,
Gilles Peskineee652a32018-06-01 19:23:52 +02003735 const uint8_t **p_tag )
3736{
3737 size_t payload_length;
3738 if( tag_length > ciphertext_length )
3739 return( PSA_ERROR_INVALID_ARGUMENT );
3740 payload_length = ciphertext_length - tag_length;
3741 if( payload_length > plaintext_size )
3742 return( PSA_ERROR_BUFFER_TOO_SMALL );
3743 *p_tag = ciphertext + payload_length;
Gilles Peskineee652a32018-06-01 19:23:52 +02003744 return( PSA_SUCCESS );
3745}
3746
Gilles Peskinec5487a82018-12-03 18:08:14 +01003747psa_status_t psa_aead_decrypt( psa_key_handle_t handle,
mohammad16035955c982018-04-26 00:53:03 +03003748 psa_algorithm_t alg,
3749 const uint8_t *nonce,
3750 size_t nonce_length,
3751 const uint8_t *additional_data,
3752 size_t additional_data_length,
3753 const uint8_t *ciphertext,
3754 size_t ciphertext_length,
3755 uint8_t *plaintext,
3756 size_t plaintext_size,
3757 size_t *plaintext_length )
3758{
mohammad16035955c982018-04-26 00:53:03 +03003759 psa_status_t status;
Gilles Peskineedf9a652018-08-17 18:11:56 +02003760 aead_operation_t operation;
3761 const uint8_t *tag = NULL;
Gilles Peskine2d277862018-06-18 15:41:12 +02003762
Gilles Peskineee652a32018-06-01 19:23:52 +02003763 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03003764
Gilles Peskinec5487a82018-12-03 18:08:14 +01003765 status = psa_aead_setup( &operation, handle, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003766 if( status != PSA_SUCCESS )
3767 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003768
Gilles Peskinef7e7b012019-05-06 15:27:16 +02003769 status = psa_aead_unpadded_locate_tag( operation.tag_length,
3770 ciphertext, ciphertext_length,
3771 plaintext_size, &tag );
3772 if( status != PSA_SUCCESS )
3773 goto exit;
3774
Gilles Peskineb0b189f2018-11-28 17:30:58 +01003775#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02003776 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03003777 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02003778 status = mbedtls_to_psa_error(
3779 mbedtls_gcm_auth_decrypt( &operation.ctx.gcm,
3780 ciphertext_length - operation.tag_length,
3781 nonce, nonce_length,
3782 additional_data,
3783 additional_data_length,
3784 tag, operation.tag_length,
3785 ciphertext, plaintext ) );
mohammad16035955c982018-04-26 00:53:03 +03003786 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01003787 else
3788#endif /* MBEDTLS_GCM_C */
3789#if defined(MBEDTLS_CCM_C)
3790 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03003791 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02003792 status = mbedtls_to_psa_error(
3793 mbedtls_ccm_auth_decrypt( &operation.ctx.ccm,
3794 ciphertext_length - operation.tag_length,
3795 nonce, nonce_length,
3796 additional_data,
3797 additional_data_length,
3798 ciphertext, plaintext,
3799 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03003800 }
mohammad160339574652018-06-01 04:39:53 -07003801 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01003802#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02003803#if defined(MBEDTLS_CHACHAPOLY_C)
3804 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
3805 {
3806 if( nonce_length != 12 || operation.tag_length != 16 )
3807 {
3808 status = PSA_ERROR_NOT_SUPPORTED;
3809 goto exit;
3810 }
3811 status = mbedtls_to_psa_error(
3812 mbedtls_chachapoly_auth_decrypt( &operation.ctx.chachapoly,
3813 ciphertext_length - operation.tag_length,
3814 nonce,
3815 additional_data,
3816 additional_data_length,
3817 tag,
3818 ciphertext,
3819 plaintext ) );
3820 }
3821 else
3822#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad160339574652018-06-01 04:39:53 -07003823 {
mohammad1603554faad2018-06-03 15:07:38 +03003824 return( PSA_ERROR_NOT_SUPPORTED );
mohammad160339574652018-06-01 04:39:53 -07003825 }
Gilles Peskinea40d7742018-06-01 16:28:30 +02003826
Gilles Peskineedf9a652018-08-17 18:11:56 +02003827 if( status != PSA_SUCCESS && plaintext_size != 0 )
3828 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03003829
Gilles Peskineedf9a652018-08-17 18:11:56 +02003830exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01003831 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02003832 if( status == PSA_SUCCESS )
3833 *plaintext_length = ciphertext_length - operation.tag_length;
3834 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003835}
3836
Gilles Peskinea0655c32018-04-30 17:06:50 +02003837
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003838
Gilles Peskine20035e32018-02-03 22:44:14 +01003839/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02003840/* Generators */
3841/****************************************************************/
3842
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003843#define HKDF_STATE_INIT 0 /* no input yet */
3844#define HKDF_STATE_STARTED 1 /* got salt */
3845#define HKDF_STATE_KEYED 2 /* got key */
3846#define HKDF_STATE_OUTPUT 3 /* output started */
3847
Gilles Peskinecbe66502019-05-16 16:59:18 +02003848static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003849 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01003850{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003851 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
3852 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003853 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003854 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003855}
3856
3857
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003858psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003859{
3860 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003861 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003862 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003863 {
3864 /* The object has (apparently) been initialized but it is not
3865 * in use. It's ok to call abort on such an object, and there's
3866 * nothing to do. */
3867 }
3868 else
Gilles Peskinebef7f142018-07-12 17:22:21 +02003869#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01003870 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003871 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003872 mbedtls_free( operation->ctx.hkdf.info );
3873 status = psa_hmac_abort_internal( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003874 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01003875 else if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003876 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01003877 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003878 {
Janos Follath6a1d2622019-06-11 10:37:28 +01003879#if defined(PSA_PRE_1_0_KEY_DERIVATION)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003880 if( operation->ctx.tls12_prf.key != NULL )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003881 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003882 mbedtls_platform_zeroize( operation->ctx.tls12_prf.key,
3883 operation->ctx.tls12_prf.key_len );
3884 mbedtls_free( operation->ctx.tls12_prf.key );
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003885 }
Hanno Becker580fba12018-11-13 20:50:45 +00003886
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003887 if( operation->ctx.tls12_prf.Ai_with_seed != NULL )
Hanno Becker580fba12018-11-13 20:50:45 +00003888 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003889 mbedtls_platform_zeroize( operation->ctx.tls12_prf.Ai_with_seed,
3890 operation->ctx.tls12_prf.Ai_with_seed_len );
3891 mbedtls_free( operation->ctx.tls12_prf.Ai_with_seed );
Hanno Becker580fba12018-11-13 20:50:45 +00003892 }
Janos Follath6a1d2622019-06-11 10:37:28 +01003893#else
3894 if( operation->ctx.tls12_prf.seed != NULL )
3895 {
3896 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
3897 operation->ctx.tls12_prf.seed_length );
3898 mbedtls_free( operation->ctx.tls12_prf.seed );
3899 }
3900
3901 if( operation->ctx.tls12_prf.label != NULL )
3902 {
3903 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
3904 operation->ctx.tls12_prf.label_length );
3905 mbedtls_free( operation->ctx.tls12_prf.label );
3906 }
3907
3908 status = psa_hmac_abort_internal( &operation->ctx.tls12_prf.hmac );
3909
3910 /* We leave the fields Ai and output_block to be erased safely by the
3911 * mbedtls_platform_zeroize() in the end of this function. */
Janos Follath999f6482019-06-11 12:04:10 +01003912#endif /* PSA_PRE_1_0_KEY_DERIVATION */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003913 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02003914 else
3915#endif /* MBEDTLS_MD_C */
Gilles Peskineeab56e42018-07-12 17:12:33 +02003916 {
3917 status = PSA_ERROR_BAD_STATE;
3918 }
Janos Follath083036a2019-06-11 10:22:26 +01003919 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02003920 return( status );
3921}
3922
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003923psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02003924 size_t *capacity)
3925{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003926 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003927 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003928 /* This is a blank key derivation operation. */
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003929 return PSA_ERROR_BAD_STATE;
3930 }
3931
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003932 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003933 return( PSA_SUCCESS );
3934}
3935
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003936psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003937 size_t capacity )
3938{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003939 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003940 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003941 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003942 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003943 operation->capacity = capacity;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003944 return( PSA_SUCCESS );
3945}
3946
Gilles Peskinebef7f142018-07-12 17:22:21 +02003947#if defined(MBEDTLS_MD_C)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003948/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02003949 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02003950static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskinebef7f142018-07-12 17:22:21 +02003951 psa_algorithm_t hash_alg,
3952 uint8_t *output,
3953 size_t output_length )
3954{
3955 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
3956 psa_status_t status;
3957
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003958 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
3959 return( PSA_ERROR_BAD_STATE );
3960 hkdf->state = HKDF_STATE_OUTPUT;
3961
Gilles Peskinebef7f142018-07-12 17:22:21 +02003962 while( output_length != 0 )
3963 {
3964 /* Copy what remains of the current block */
3965 uint8_t n = hash_length - hkdf->offset_in_block;
3966 if( n > output_length )
3967 n = (uint8_t) output_length;
3968 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
3969 output += n;
3970 output_length -= n;
3971 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02003972 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003973 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02003974 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02003975 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003976 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02003977 * object was corrupted or if this function is called directly
3978 * inside the library. */
3979 if( hkdf->block_number == 0xff )
3980 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003981
3982 /* We need a new block */
3983 ++hkdf->block_number;
3984 hkdf->offset_in_block = 0;
3985 status = psa_hmac_setup_internal( &hkdf->hmac,
3986 hkdf->prk, hash_length,
3987 hash_alg );
3988 if( status != PSA_SUCCESS )
3989 return( status );
3990 if( hkdf->block_number != 1 )
3991 {
3992 status = psa_hash_update( &hkdf->hmac.hash_ctx,
3993 hkdf->output_block,
3994 hash_length );
3995 if( status != PSA_SUCCESS )
3996 return( status );
3997 }
3998 status = psa_hash_update( &hkdf->hmac.hash_ctx,
3999 hkdf->info,
4000 hkdf->info_length );
4001 if( status != PSA_SUCCESS )
4002 return( status );
4003 status = psa_hash_update( &hkdf->hmac.hash_ctx,
4004 &hkdf->block_number, 1 );
4005 if( status != PSA_SUCCESS )
4006 return( status );
4007 status = psa_hmac_finish_internal( &hkdf->hmac,
4008 hkdf->output_block,
4009 sizeof( hkdf->output_block ) );
4010 if( status != PSA_SUCCESS )
4011 return( status );
4012 }
4013
4014 return( PSA_SUCCESS );
4015}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004016
Janos Follath999f6482019-06-11 12:04:10 +01004017#if defined(PSA_PRE_1_0_KEY_DERIVATION)
Gilles Peskinecbe66502019-05-16 16:59:18 +02004018static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
4019 psa_tls12_prf_key_derivation_t *tls12_prf,
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004020 psa_algorithm_t alg )
4021{
4022 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
4023 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
4024 psa_hmac_internal_data hmac;
4025 psa_status_t status, cleanup_status;
4026
Hanno Becker3b339e22018-11-13 20:56:14 +00004027 unsigned char *Ai;
4028 size_t Ai_len;
4029
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004030 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004031 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004032 * prevented this call. It could happen only if the operation
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004033 * object was corrupted or if this function is called directly
4034 * inside the library. */
4035 if( tls12_prf->block_number == 0xff )
4036 return( PSA_ERROR_BAD_STATE );
4037
4038 /* We need a new block */
4039 ++tls12_prf->block_number;
4040 tls12_prf->offset_in_block = 0;
4041
4042 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
4043 *
4044 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
4045 *
4046 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
4047 * HMAC_hash(secret, A(2) + seed) +
4048 * HMAC_hash(secret, A(3) + seed) + ...
4049 *
4050 * A(0) = seed
4051 * A(i) = HMAC_hash( secret, A(i-1) )
4052 *
Gilles Peskinecbe66502019-05-16 16:59:18 +02004053 * The `psa_tls12_prf_key_derivation` structures saves the block
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004054 * `HMAC_hash(secret, A(i) + seed)` from which the output
4055 * is currently extracted as `output_block`, while
4056 * `A(i) + seed` is stored in `Ai_with_seed`.
4057 *
4058 * Generating a new block means recalculating `Ai_with_seed`
4059 * from the A(i)-part of it, and afterwards recalculating
4060 * `output_block`.
4061 *
4062 * A(0) is computed at setup time.
4063 *
4064 */
4065
4066 psa_hmac_init_internal( &hmac );
4067
4068 /* We must distinguish the calculation of A(1) from those
4069 * of A(2) and higher, because A(0)=seed has a different
4070 * length than the other A(i). */
4071 if( tls12_prf->block_number == 1 )
4072 {
Hanno Becker3b339e22018-11-13 20:56:14 +00004073 Ai = tls12_prf->Ai_with_seed + hash_length;
4074 Ai_len = tls12_prf->Ai_with_seed_len - hash_length;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004075 }
4076 else
4077 {
Hanno Becker3b339e22018-11-13 20:56:14 +00004078 Ai = tls12_prf->Ai_with_seed;
4079 Ai_len = hash_length;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004080 }
4081
Hanno Becker3b339e22018-11-13 20:56:14 +00004082 /* Compute A(i+1) = HMAC_hash(secret, A(i)) */
4083 status = psa_hmac_setup_internal( &hmac,
4084 tls12_prf->key,
4085 tls12_prf->key_len,
4086 hash_alg );
4087 if( status != PSA_SUCCESS )
4088 goto cleanup;
4089
4090 status = psa_hash_update( &hmac.hash_ctx,
4091 Ai, Ai_len );
4092 if( status != PSA_SUCCESS )
4093 goto cleanup;
4094
4095 status = psa_hmac_finish_internal( &hmac,
4096 tls12_prf->Ai_with_seed,
4097 hash_length );
4098 if( status != PSA_SUCCESS )
4099 goto cleanup;
4100
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004101 /* Compute the next block `HMAC_hash(secret, A(i+1) + seed)`. */
4102 status = psa_hmac_setup_internal( &hmac,
4103 tls12_prf->key,
4104 tls12_prf->key_len,
4105 hash_alg );
4106 if( status != PSA_SUCCESS )
4107 goto cleanup;
4108
4109 status = psa_hash_update( &hmac.hash_ctx,
4110 tls12_prf->Ai_with_seed,
Hanno Becker580fba12018-11-13 20:50:45 +00004111 tls12_prf->Ai_with_seed_len );
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004112 if( status != PSA_SUCCESS )
4113 goto cleanup;
4114
4115 status = psa_hmac_finish_internal( &hmac,
4116 tls12_prf->output_block,
4117 hash_length );
4118 if( status != PSA_SUCCESS )
4119 goto cleanup;
4120
4121cleanup:
4122
4123 cleanup_status = psa_hmac_abort_internal( &hmac );
4124 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
4125 status = cleanup_status;
4126
4127 return( status );
4128}
Janos Follath7742fee2019-06-17 12:58:10 +01004129#else
4130static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
4131 psa_tls12_prf_key_derivation_t *tls12_prf,
4132 psa_algorithm_t alg )
4133{
4134 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
4135 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
Janos Follathea29bfb2019-06-19 12:21:20 +01004136 psa_hash_operation_t backup = PSA_HASH_OPERATION_INIT;
4137 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004138
Janos Follath7742fee2019-06-17 12:58:10 +01004139 /* We can't be wanting more output after block 0xff, otherwise
4140 * the capacity check in psa_key_derivation_output_bytes() would have
4141 * prevented this call. It could happen only if the operation
4142 * object was corrupted or if this function is called directly
4143 * inside the library. */
4144 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01004145 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01004146
4147 /* We need a new block */
4148 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01004149 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01004150
4151 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
4152 *
4153 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
4154 *
4155 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
4156 * HMAC_hash(secret, A(2) + seed) +
4157 * HMAC_hash(secret, A(3) + seed) + ...
4158 *
4159 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01004160 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01004161 *
Janos Follathea29bfb2019-06-19 12:21:20 +01004162 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01004163 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01004164 * is currently extracted as `output_block` and where i is
4165 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01004166 */
4167
Janos Follathea29bfb2019-06-19 12:21:20 +01004168 /* Save the hash context before using it, to preserve the hash state with
4169 * only the inner padding in it. We need this, because inner padding depends
4170 * on the key (secret in the RFC's terminology). */
4171 status = psa_hash_clone( &tls12_prf->hmac.hash_ctx, &backup );
4172 if( status != PSA_SUCCESS )
4173 goto cleanup;
4174
4175 /* Calculate A(i) where i = tls12_prf->block_number. */
4176 if( tls12_prf->block_number == 1 )
4177 {
4178 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
4179 * the variable seed and in this instance means it in the context of the
4180 * P_hash function, where seed = label + seed.) */
4181 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4182 tls12_prf->label, tls12_prf->label_length );
4183 if( status != PSA_SUCCESS )
4184 goto cleanup;
4185 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4186 tls12_prf->seed, tls12_prf->seed_length );
4187 if( status != PSA_SUCCESS )
4188 goto cleanup;
4189 }
4190 else
4191 {
4192 /* A(i) = HMAC_hash(secret, A(i-1)) */
4193 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4194 tls12_prf->Ai, hash_length );
4195 if( status != PSA_SUCCESS )
4196 goto cleanup;
4197 }
4198
4199 status = psa_hmac_finish_internal( &tls12_prf->hmac,
4200 tls12_prf->Ai, hash_length );
4201 if( status != PSA_SUCCESS )
4202 goto cleanup;
4203 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
4204 if( status != PSA_SUCCESS )
4205 goto cleanup;
4206
4207 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
4208 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4209 tls12_prf->Ai, hash_length );
4210 if( status != PSA_SUCCESS )
4211 goto cleanup;
4212 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4213 tls12_prf->label, tls12_prf->label_length );
4214 if( status != PSA_SUCCESS )
4215 goto cleanup;
4216 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4217 tls12_prf->seed, tls12_prf->seed_length );
4218 if( status != PSA_SUCCESS )
4219 goto cleanup;
4220 status = psa_hmac_finish_internal( &tls12_prf->hmac,
4221 tls12_prf->output_block, hash_length );
4222 if( status != PSA_SUCCESS )
4223 goto cleanup;
4224 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
4225 if( status != PSA_SUCCESS )
4226 goto cleanup;
4227
Janos Follath7742fee2019-06-17 12:58:10 +01004228
4229cleanup:
4230
Janos Follathea29bfb2019-06-19 12:21:20 +01004231 cleanup_status = psa_hash_abort( &backup );
4232 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
4233 status = cleanup_status;
4234
4235 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01004236}
Janos Follath999f6482019-06-11 12:04:10 +01004237#endif /* PSA_PRE_1_0_KEY_DERIVATION */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004238
Janos Follath999f6482019-06-11 12:04:10 +01004239#if defined(PSA_PRE_1_0_KEY_DERIVATION)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004240/* Read some bytes from an TLS-1.2-PRF-based operation.
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004241 * See Section 5 of RFC 5246. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02004242static psa_status_t psa_key_derivation_tls12_prf_read(
Janos Follath6c6c8fc2019-06-17 12:38:20 +01004243 psa_tls12_prf_key_derivation_t *tls12_prf,
4244 psa_algorithm_t alg,
4245 uint8_t *output,
4246 size_t output_length )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004247{
4248 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
4249 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
4250 psa_status_t status;
4251
4252 while( output_length != 0 )
4253 {
4254 /* Copy what remains of the current block */
4255 uint8_t n = hash_length - tls12_prf->offset_in_block;
4256
4257 /* Check if we have fully processed the current block. */
4258 if( n == 0 )
4259 {
Gilles Peskinecbe66502019-05-16 16:59:18 +02004260 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
Janos Follath6c6c8fc2019-06-17 12:38:20 +01004261 alg );
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004262 if( status != PSA_SUCCESS )
4263 return( status );
4264
4265 continue;
4266 }
4267
4268 if( n > output_length )
4269 n = (uint8_t) output_length;
4270 memcpy( output, tls12_prf->output_block + tls12_prf->offset_in_block,
4271 n );
4272 output += n;
4273 output_length -= n;
4274 tls12_prf->offset_in_block += n;
4275 }
4276
4277 return( PSA_SUCCESS );
4278}
Janos Follath844eb0e2019-06-19 12:10:49 +01004279#else
4280static psa_status_t psa_key_derivation_tls12_prf_read(
4281 psa_tls12_prf_key_derivation_t *tls12_prf,
4282 psa_algorithm_t alg,
4283 uint8_t *output,
4284 size_t output_length )
4285{
4286 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
4287 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
4288 psa_status_t status;
4289 uint8_t offset, length;
4290
4291 while( output_length != 0 )
4292 {
4293 /* Check if we have fully processed the current block. */
4294 if( tls12_prf->left_in_block == 0 )
4295 {
4296 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
4297 alg );
4298 if( status != PSA_SUCCESS )
4299 return( status );
4300
4301 continue;
4302 }
4303
4304 if( tls12_prf->left_in_block > output_length )
4305 length = (uint8_t) output_length;
4306 else
4307 length = tls12_prf->left_in_block;
4308
4309 offset = hash_length - tls12_prf->left_in_block;
4310 memcpy( output, tls12_prf->output_block + offset, length );
4311 output += length;
4312 output_length -= length;
4313 tls12_prf->left_in_block -= length;
4314 }
4315
4316 return( PSA_SUCCESS );
4317}
Janos Follath999f6482019-06-11 12:04:10 +01004318#endif /* PSA_PRE_1_0_KEY_DERIVATION */
Gilles Peskinebef7f142018-07-12 17:22:21 +02004319#endif /* MBEDTLS_MD_C */
4320
Janos Follath6c6c8fc2019-06-17 12:38:20 +01004321psa_status_t psa_key_derivation_output_bytes(
4322 psa_key_derivation_operation_t *operation,
4323 uint8_t *output,
4324 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004325{
4326 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004327 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004328
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004329 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004330 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004331 /* This is a blank operation. */
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004332 return PSA_ERROR_BAD_STATE;
4333 }
4334
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004335 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004336 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004337 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004338 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004339 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02004340 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004341 goto exit;
4342 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004343 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004344 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004345 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004346 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02004347 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
4348 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004349 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02004350 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02004351 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004352 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004353 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004354
Gilles Peskinebef7f142018-07-12 17:22:21 +02004355#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004356 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004357 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004358 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004359 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02004360 output, output_length );
4361 }
Janos Follathadbec812019-06-14 11:05:39 +01004362 else
Janos Follathadbec812019-06-14 11:05:39 +01004363 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine969c5d62019-01-16 15:53:06 +01004364 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004365 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004366 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004367 kdf_alg, output,
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004368 output_length );
4369 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004370 else
4371#endif /* MBEDTLS_MD_C */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004372 {
4373 return( PSA_ERROR_BAD_STATE );
4374 }
4375
4376exit:
4377 if( status != PSA_SUCCESS )
4378 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004379 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004380 * This allows us to differentiate between exhausted operations and
4381 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
4382 * operations. */
4383 psa_algorithm_t alg = operation->alg;
4384 psa_key_derivation_abort( operation );
4385 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004386 memset( output, '!', output_length );
4387 }
4388 return( status );
4389}
4390
Gilles Peskine08542d82018-07-19 17:05:42 +02004391#if defined(MBEDTLS_DES_C)
4392static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
4393{
4394 if( data_size >= 8 )
4395 mbedtls_des_key_set_parity( data );
4396 if( data_size >= 16 )
4397 mbedtls_des_key_set_parity( data + 8 );
4398 if( data_size >= 24 )
4399 mbedtls_des_key_set_parity( data + 16 );
4400}
4401#endif /* MBEDTLS_DES_C */
4402
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004403static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004404 psa_key_slot_t *slot,
4405 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004406 psa_key_derivation_operation_t *operation )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004407{
4408 uint8_t *data = NULL;
4409 size_t bytes = PSA_BITS_TO_BYTES( bits );
4410 psa_status_t status;
4411
4412 if( ! key_type_is_raw_bytes( slot->type ) )
4413 return( PSA_ERROR_INVALID_ARGUMENT );
4414 if( bits % 8 != 0 )
4415 return( PSA_ERROR_INVALID_ARGUMENT );
4416 data = mbedtls_calloc( 1, bytes );
4417 if( data == NULL )
4418 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4419
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004420 status = psa_key_derivation_output_bytes( operation, data, bytes );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004421 if( status != PSA_SUCCESS )
4422 goto exit;
4423#if defined(MBEDTLS_DES_C)
4424 if( slot->type == PSA_KEY_TYPE_DES )
4425 psa_des_set_key_parity( data, bytes );
4426#endif /* MBEDTLS_DES_C */
4427 status = psa_import_key_into_slot( slot, data, bytes );
4428
4429exit:
4430 mbedtls_free( data );
4431 return( status );
4432}
4433
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004434psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004435 psa_key_derivation_operation_t *operation,
Gilles Peskine98dd7792019-05-15 19:43:49 +02004436 psa_key_handle_t *handle )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004437{
4438 psa_status_t status;
4439 psa_key_slot_t *slot = NULL;
4440 status = psa_start_key_creation( attributes, handle, &slot );
4441 if( status == PSA_SUCCESS )
4442 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004443 status = psa_generate_derived_key_internal( slot,
Gilles Peskine3a4f1f82019-04-26 13:49:28 +02004444 attributes->bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004445 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004446 }
4447 if( status == PSA_SUCCESS )
4448 status = psa_finish_key_creation( slot );
4449 if( status != PSA_SUCCESS )
4450 {
4451 psa_fail_key_creation( slot );
4452 *handle = 0;
4453 }
4454 return( status );
4455}
4456
Gilles Peskineeab56e42018-07-12 17:12:33 +02004457
4458
4459/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02004460/* Key derivation */
4461/****************************************************************/
4462
Gilles Peskinea05219c2018-11-16 16:02:56 +01004463#if defined(MBEDTLS_MD_C)
Janos Follath71a4c912019-06-11 09:14:47 +01004464#if defined(PSA_PRE_1_0_KEY_DERIVATION)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004465/* Set up an HKDF-based operation. This is exactly the extract phase
Gilles Peskine346797d2018-11-16 16:05:06 +01004466 * of the HKDF algorithm.
4467 *
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004468 * Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine346797d2018-11-16 16:05:06 +01004469 * to potentially free embedded data structures and wipe confidential data.
4470 */
Gilles Peskinecbe66502019-05-16 16:59:18 +02004471static psa_status_t psa_key_derivation_hkdf_setup( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004472 const uint8_t *secret,
4473 size_t secret_length,
4474 psa_algorithm_t hash_alg,
4475 const uint8_t *salt,
4476 size_t salt_length,
4477 const uint8_t *label,
4478 size_t label_length )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004479{
4480 psa_status_t status;
4481 status = psa_hmac_setup_internal( &hkdf->hmac,
4482 salt, salt_length,
Gilles Peskinef9ee6332019-04-11 21:22:52 +02004483 hash_alg );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004484 if( status != PSA_SUCCESS )
4485 return( status );
Gilles Peskinecce18ae2018-09-18 12:03:52 +02004486 status = psa_hash_update( &hkdf->hmac.hash_ctx, secret, secret_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004487 if( status != PSA_SUCCESS )
4488 return( status );
4489 status = psa_hmac_finish_internal( &hkdf->hmac,
4490 hkdf->prk,
4491 sizeof( hkdf->prk ) );
4492 if( status != PSA_SUCCESS )
4493 return( status );
4494 hkdf->offset_in_block = PSA_HASH_SIZE( hash_alg );
4495 hkdf->block_number = 0;
4496 hkdf->info_length = label_length;
4497 if( label_length != 0 )
4498 {
4499 hkdf->info = mbedtls_calloc( 1, label_length );
4500 if( hkdf->info == NULL )
4501 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4502 memcpy( hkdf->info, label, label_length );
4503 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004504 hkdf->state = HKDF_STATE_KEYED;
4505 hkdf->info_set = 1;
Gilles Peskinebef7f142018-07-12 17:22:21 +02004506 return( PSA_SUCCESS );
4507}
Janos Follath71a4c912019-06-11 09:14:47 +01004508#endif /* PSA_PRE_1_0_KEY_DERIVATION */
Gilles Peskinea05219c2018-11-16 16:02:56 +01004509#endif /* MBEDTLS_MD_C */
Gilles Peskinebef7f142018-07-12 17:22:21 +02004510
Gilles Peskinea05219c2018-11-16 16:02:56 +01004511#if defined(MBEDTLS_MD_C)
Janos Follath71a4c912019-06-11 09:14:47 +01004512#if defined(PSA_PRE_1_0_KEY_DERIVATION)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004513/* Set up a TLS-1.2-prf-based operation (see RFC 5246, Section 5).
Gilles Peskine346797d2018-11-16 16:05:06 +01004514 *
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004515 * Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine346797d2018-11-16 16:05:06 +01004516 * to potentially free embedded data structures and wipe confidential data.
4517 */
Gilles Peskinecbe66502019-05-16 16:59:18 +02004518static psa_status_t psa_key_derivation_tls12_prf_setup(
4519 psa_tls12_prf_key_derivation_t *tls12_prf,
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004520 const unsigned char *key,
4521 size_t key_len,
4522 psa_algorithm_t hash_alg,
4523 const uint8_t *salt,
4524 size_t salt_length,
4525 const uint8_t *label,
4526 size_t label_length )
4527{
4528 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
Hanno Becker580fba12018-11-13 20:50:45 +00004529 size_t Ai_with_seed_len = hash_length + salt_length + label_length;
4530 int overflow;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004531
4532 tls12_prf->key = mbedtls_calloc( 1, key_len );
4533 if( tls12_prf->key == NULL )
4534 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4535 tls12_prf->key_len = key_len;
4536 memcpy( tls12_prf->key, key, key_len );
4537
Hanno Becker580fba12018-11-13 20:50:45 +00004538 overflow = ( salt_length + label_length < salt_length ) ||
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004539 ( salt_length + label_length + hash_length < hash_length );
Hanno Becker580fba12018-11-13 20:50:45 +00004540 if( overflow )
4541 return( PSA_ERROR_INVALID_ARGUMENT );
4542
4543 tls12_prf->Ai_with_seed = mbedtls_calloc( 1, Ai_with_seed_len );
4544 if( tls12_prf->Ai_with_seed == NULL )
4545 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4546 tls12_prf->Ai_with_seed_len = Ai_with_seed_len;
4547
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004548 /* Write `label + seed' at the end of the `A(i) + seed` buffer,
4549 * leaving the initial `hash_length` bytes unspecified for now. */
Hanno Becker353e4532018-11-15 09:53:57 +00004550 if( label_length != 0 )
4551 {
4552 memcpy( tls12_prf->Ai_with_seed + hash_length,
4553 label, label_length );
4554 }
4555
4556 if( salt_length != 0 )
4557 {
4558 memcpy( tls12_prf->Ai_with_seed + hash_length + label_length,
4559 salt, salt_length );
4560 }
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004561
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004562 /* The first block gets generated when
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004563 * psa_key_derivation_output_bytes() is called. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004564 tls12_prf->block_number = 0;
4565 tls12_prf->offset_in_block = hash_length;
4566
4567 return( PSA_SUCCESS );
4568}
Janos Follath71a4c912019-06-11 09:14:47 +01004569#endif /* PSA_PRE_1_0_KEY_DERIVATION */
Hanno Becker1aaedc02018-11-16 11:35:34 +00004570
Janos Follath71a4c912019-06-11 09:14:47 +01004571#if defined(PSA_PRE_1_0_KEY_DERIVATION)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004572/* Set up a TLS-1.2-PSK-to-MS-based operation. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02004573static psa_status_t psa_key_derivation_tls12_psk_to_ms_setup(
4574 psa_tls12_prf_key_derivation_t *tls12_prf,
Hanno Becker1aaedc02018-11-16 11:35:34 +00004575 const unsigned char *psk,
4576 size_t psk_len,
4577 psa_algorithm_t hash_alg,
4578 const uint8_t *salt,
4579 size_t salt_length,
4580 const uint8_t *label,
4581 size_t label_length )
4582{
4583 psa_status_t status;
4584 unsigned char pms[ 4 + 2 * PSA_ALG_TLS12_PSK_TO_MS_MAX_PSK_LEN ];
4585
4586 if( psk_len > PSA_ALG_TLS12_PSK_TO_MS_MAX_PSK_LEN )
4587 return( PSA_ERROR_INVALID_ARGUMENT );
4588
4589 /* Quoting RFC 4279, Section 2:
4590 *
4591 * The premaster secret is formed as follows: if the PSK is N octets
4592 * long, concatenate a uint16 with the value N, N zero octets, a second
4593 * uint16 with the value N, and the PSK itself.
4594 */
4595
4596 pms[0] = ( psk_len >> 8 ) & 0xff;
4597 pms[1] = ( psk_len >> 0 ) & 0xff;
4598 memset( pms + 2, 0, psk_len );
4599 pms[2 + psk_len + 0] = pms[0];
4600 pms[2 + psk_len + 1] = pms[1];
4601 memcpy( pms + 4 + psk_len, psk, psk_len );
4602
Gilles Peskinecbe66502019-05-16 16:59:18 +02004603 status = psa_key_derivation_tls12_prf_setup( tls12_prf,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004604 pms, 4 + 2 * psk_len,
4605 hash_alg,
4606 salt, salt_length,
4607 label, label_length );
Hanno Becker1aaedc02018-11-16 11:35:34 +00004608
Gilles Peskine3f108122018-12-07 18:14:53 +01004609 mbedtls_platform_zeroize( pms, sizeof( pms ) );
Hanno Becker1aaedc02018-11-16 11:35:34 +00004610 return( status );
4611}
Janos Follath71a4c912019-06-11 09:14:47 +01004612#endif /* PSA_PRE_1_0_KEY_DERIVATION */
Gilles Peskinea05219c2018-11-16 16:02:56 +01004613#endif /* MBEDTLS_MD_C */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004614
Janos Follath71a4c912019-06-11 09:14:47 +01004615#if defined(PSA_PRE_1_0_KEY_DERIVATION)
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004616/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine346797d2018-11-16 16:05:06 +01004617 * to potentially free embedded data structures and wipe confidential data.
4618 */
Gilles Peskinecce18ae2018-09-18 12:03:52 +02004619static psa_status_t psa_key_derivation_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004620 psa_key_derivation_operation_t *operation,
Gilles Peskinecce18ae2018-09-18 12:03:52 +02004621 const uint8_t *secret, size_t secret_length,
4622 psa_algorithm_t alg,
4623 const uint8_t *salt, size_t salt_length,
4624 const uint8_t *label, size_t label_length,
4625 size_t capacity )
4626{
4627 psa_status_t status;
4628 size_t max_capacity;
4629
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004630 /* Set operation->alg even on failure so that abort knows what to do. */
4631 operation->alg = alg;
Gilles Peskinecce18ae2018-09-18 12:03:52 +02004632
4633#if defined(MBEDTLS_MD_C)
4634 if( PSA_ALG_IS_HKDF( alg ) )
4635 {
4636 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
4637 size_t hash_size = PSA_HASH_SIZE( hash_alg );
4638 if( hash_size == 0 )
4639 return( PSA_ERROR_NOT_SUPPORTED );
4640 max_capacity = 255 * hash_size;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004641 status = psa_key_derivation_hkdf_setup( &operation->ctx.hkdf,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004642 secret, secret_length,
4643 hash_alg,
4644 salt, salt_length,
4645 label, label_length );
Gilles Peskinecce18ae2018-09-18 12:03:52 +02004646 }
Hanno Becker1aaedc02018-11-16 11:35:34 +00004647 /* TLS-1.2 PRF and TLS-1.2 PSK-to-MS are very similar, so share code. */
4648 else if( PSA_ALG_IS_TLS12_PRF( alg ) ||
4649 PSA_ALG_IS_TLS12_PSK_TO_MS( alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004650 {
4651 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
4652 size_t hash_size = PSA_HASH_SIZE( hash_alg );
4653
4654 /* TLS-1.2 PRF supports only SHA-256 and SHA-384. */
4655 if( hash_alg != PSA_ALG_SHA_256 &&
4656 hash_alg != PSA_ALG_SHA_384 )
4657 {
4658 return( PSA_ERROR_NOT_SUPPORTED );
4659 }
4660
4661 max_capacity = 255 * hash_size;
Hanno Becker1aaedc02018-11-16 11:35:34 +00004662
4663 if( PSA_ALG_IS_TLS12_PRF( alg ) )
4664 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004665 status = psa_key_derivation_tls12_prf_setup( &operation->ctx.tls12_prf,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004666 secret, secret_length,
4667 hash_alg, salt, salt_length,
4668 label, label_length );
Hanno Becker1aaedc02018-11-16 11:35:34 +00004669 }
4670 else
4671 {
Gilles Peskinecbe66502019-05-16 16:59:18 +02004672 status = psa_key_derivation_tls12_psk_to_ms_setup(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004673 &operation->ctx.tls12_prf,
Hanno Becker1aaedc02018-11-16 11:35:34 +00004674 secret, secret_length,
4675 hash_alg, salt, salt_length,
4676 label, label_length );
4677 }
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004678 }
Gilles Peskinecce18ae2018-09-18 12:03:52 +02004679 else
4680#endif
4681 {
4682 return( PSA_ERROR_NOT_SUPPORTED );
4683 }
4684
4685 if( status != PSA_SUCCESS )
4686 return( status );
4687
4688 if( capacity <= max_capacity )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004689 operation->capacity = capacity;
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004690 else if( capacity == PSA_KEY_DERIVATION_UNLIMITED_CAPACITY )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004691 operation->capacity = max_capacity;
Gilles Peskinecce18ae2018-09-18 12:03:52 +02004692 else
4693 return( PSA_ERROR_INVALID_ARGUMENT );
4694
4695 return( PSA_SUCCESS );
4696}
Janos Follath71a4c912019-06-11 09:14:47 +01004697#endif /* PSA_PRE_1_0_KEY_DERIVATION */
Gilles Peskinecce18ae2018-09-18 12:03:52 +02004698
Janos Follath71a4c912019-06-11 09:14:47 +01004699#if defined(PSA_PRE_1_0_KEY_DERIVATION)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004700psa_status_t psa_key_derivation( psa_key_derivation_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01004701 psa_key_handle_t handle,
Gilles Peskineea0fb492018-07-12 17:17:20 +02004702 psa_algorithm_t alg,
4703 const uint8_t *salt,
4704 size_t salt_length,
4705 const uint8_t *label,
4706 size_t label_length,
4707 size_t capacity )
4708{
Gilles Peskine2f060a82018-12-04 17:12:32 +01004709 psa_key_slot_t *slot;
Gilles Peskineea0fb492018-07-12 17:17:20 +02004710 psa_status_t status;
4711
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004712 if( operation->alg != 0 )
Gilles Peskineea0fb492018-07-12 17:17:20 +02004713 return( PSA_ERROR_BAD_STATE );
4714
Gilles Peskinecce18ae2018-09-18 12:03:52 +02004715 /* Make sure that alg is a key derivation algorithm. This prevents
4716 * key selection algorithms, which psa_key_derivation_internal
4717 * accepts for the sake of key agreement. */
Gilles Peskineea0fb492018-07-12 17:17:20 +02004718 if( ! PSA_ALG_IS_KEY_DERIVATION( alg ) )
4719 return( PSA_ERROR_INVALID_ARGUMENT );
4720
Gilles Peskinec5487a82018-12-03 18:08:14 +01004721 status = psa_get_key_from_slot( handle, &slot, PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskinecce18ae2018-09-18 12:03:52 +02004722 if( status != PSA_SUCCESS )
4723 return( status );
Gilles Peskineea0fb492018-07-12 17:17:20 +02004724
Gilles Peskinecce18ae2018-09-18 12:03:52 +02004725 if( slot->type != PSA_KEY_TYPE_DERIVE )
4726 return( PSA_ERROR_INVALID_ARGUMENT );
4727
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004728 status = psa_key_derivation_internal( operation,
Gilles Peskinecce18ae2018-09-18 12:03:52 +02004729 slot->data.raw.data,
4730 slot->data.raw.bytes,
4731 alg,
4732 salt, salt_length,
4733 label, label_length,
4734 capacity );
4735 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004736 psa_key_derivation_abort( operation );
Gilles Peskineea0fb492018-07-12 17:17:20 +02004737 return( status );
4738}
Janos Follath71a4c912019-06-11 09:14:47 +01004739#endif /* PSA_PRE_1_0_KEY_DERIVATION */
Gilles Peskineea0fb492018-07-12 17:17:20 +02004740
Gilles Peskine969c5d62019-01-16 15:53:06 +01004741static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004742 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004743 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004744{
Janos Follath5fe19732019-06-20 15:09:30 +01004745 /* Make sure that operation->ctx is properly zero-initialised. (Macro
4746 * initialisers for this union leave some bytes unspecified.) */
4747 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
4748
Gilles Peskine969c5d62019-01-16 15:53:06 +01004749 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004750#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004751 if( PSA_ALG_IS_HKDF( kdf_alg ) ||
4752 PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
4753 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004754 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004755 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004756 size_t hash_size = PSA_HASH_SIZE( hash_alg );
4757 if( hash_size == 0 )
4758 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004759 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
4760 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02004761 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004762 {
4763 return( PSA_ERROR_NOT_SUPPORTED );
4764 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004765 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004766 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004767 }
4768#endif /* MBEDTLS_MD_C */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004769 else
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004770 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004771}
4772
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004773psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004774 psa_algorithm_t alg )
4775{
4776 psa_status_t status;
4777
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004778 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004779 return( PSA_ERROR_BAD_STATE );
4780
Gilles Peskine6843c292019-01-18 16:44:49 +01004781 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
4782 return( PSA_ERROR_INVALID_ARGUMENT );
4783 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004784 {
4785 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004786 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004787 }
4788 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
4789 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004790 status = psa_key_derivation_setup_kdf( operation, alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004791 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004792 else
4793 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004794
4795 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004796 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004797 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004798}
4799
4800#if defined(MBEDTLS_MD_C)
Gilles Peskinecbe66502019-05-16 16:59:18 +02004801static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004802 psa_algorithm_t hash_alg,
4803 psa_key_derivation_step_t step,
4804 const uint8_t *data,
4805 size_t data_length )
4806{
4807 psa_status_t status;
4808 switch( step )
4809 {
Gilles Peskine03410b52019-05-16 16:05:19 +02004810 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02004811 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004812 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004813 status = psa_hmac_setup_internal( &hkdf->hmac,
4814 data, data_length,
4815 hash_alg );
4816 if( status != PSA_SUCCESS )
4817 return( status );
4818 hkdf->state = HKDF_STATE_STARTED;
4819 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02004820 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004821 /* If no salt was provided, use an empty salt. */
4822 if( hkdf->state == HKDF_STATE_INIT )
4823 {
4824 status = psa_hmac_setup_internal( &hkdf->hmac,
4825 NULL, 0,
Gilles Peskinef9ee6332019-04-11 21:22:52 +02004826 hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004827 if( status != PSA_SUCCESS )
4828 return( status );
4829 hkdf->state = HKDF_STATE_STARTED;
4830 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02004831 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004832 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004833 status = psa_hash_update( &hkdf->hmac.hash_ctx,
4834 data, data_length );
4835 if( status != PSA_SUCCESS )
4836 return( status );
4837 status = psa_hmac_finish_internal( &hkdf->hmac,
4838 hkdf->prk,
4839 sizeof( hkdf->prk ) );
4840 if( status != PSA_SUCCESS )
4841 return( status );
4842 hkdf->offset_in_block = PSA_HASH_SIZE( hash_alg );
4843 hkdf->block_number = 0;
4844 hkdf->state = HKDF_STATE_KEYED;
4845 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02004846 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004847 if( hkdf->state == HKDF_STATE_OUTPUT )
4848 return( PSA_ERROR_BAD_STATE );
4849 if( hkdf->info_set )
4850 return( PSA_ERROR_BAD_STATE );
4851 hkdf->info_length = data_length;
4852 if( data_length != 0 )
4853 {
4854 hkdf->info = mbedtls_calloc( 1, data_length );
4855 if( hkdf->info == NULL )
4856 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4857 memcpy( hkdf->info, data, data_length );
4858 }
4859 hkdf->info_set = 1;
4860 return( PSA_SUCCESS );
4861 default:
4862 return( PSA_ERROR_INVALID_ARGUMENT );
4863 }
4864}
Janos Follathb03233e2019-06-11 15:30:30 +01004865
4866#if defined(PSA_PRE_1_0_KEY_DERIVATION)
4867static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
4868 psa_algorithm_t hash_alg,
4869 psa_key_derivation_step_t step,
4870 const uint8_t *data,
4871 size_t data_length )
4872{
4873 (void) prf;
4874 (void) hash_alg;
4875 (void) step;
4876 (void) data;
4877 (void) data_length;
4878
4879 return( PSA_ERROR_INVALID_ARGUMENT );
4880}
Janos Follath6660f0e2019-06-17 08:44:03 +01004881
4882static psa_status_t psa_tls12_prf_psk_to_ms_input(
4883 psa_tls12_prf_key_derivation_t *prf,
4884 psa_algorithm_t hash_alg,
4885 psa_key_derivation_step_t step,
4886 const uint8_t *data,
4887 size_t data_length )
4888{
4889 (void) prf;
4890 (void) hash_alg;
4891 (void) step;
4892 (void) data;
4893 (void) data_length;
4894
4895 return( PSA_ERROR_INVALID_ARGUMENT );
4896}
Janos Follathb03233e2019-06-11 15:30:30 +01004897#else
Janos Follathf08e2652019-06-13 09:05:41 +01004898static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
4899 const uint8_t *data,
4900 size_t data_length )
4901{
4902 if( prf->state != TLS12_PRF_STATE_INIT )
4903 return( PSA_ERROR_BAD_STATE );
4904
Janos Follathd6dce9f2019-07-04 09:11:38 +01004905 if( data_length != 0 )
4906 {
4907 prf->seed = mbedtls_calloc( 1, data_length );
4908 if( prf->seed == NULL )
4909 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01004910
Janos Follathd6dce9f2019-07-04 09:11:38 +01004911 memcpy( prf->seed, data, data_length );
4912 prf->seed_length = data_length;
4913 }
Janos Follathf08e2652019-06-13 09:05:41 +01004914
4915 prf->state = TLS12_PRF_STATE_SEED_SET;
4916
4917 return( PSA_SUCCESS );
4918}
4919
Janos Follath81550542019-06-13 14:26:34 +01004920static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
4921 psa_algorithm_t hash_alg,
4922 const uint8_t *data,
4923 size_t data_length )
4924{
4925 psa_status_t status;
4926 if( prf->state != TLS12_PRF_STATE_SEED_SET )
4927 return( PSA_ERROR_BAD_STATE );
4928
4929 status = psa_hmac_setup_internal( &prf->hmac, data, data_length, hash_alg );
4930 if( status != PSA_SUCCESS )
4931 return( status );
4932
4933 prf->state = TLS12_PRF_STATE_KEY_SET;
4934
4935 return( PSA_SUCCESS );
4936}
4937
Janos Follath6660f0e2019-06-17 08:44:03 +01004938static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
4939 psa_tls12_prf_key_derivation_t *prf,
4940 psa_algorithm_t hash_alg,
4941 const uint8_t *data,
4942 size_t data_length )
4943{
4944 psa_status_t status;
4945 unsigned char pms[ 4 + 2 * PSA_ALG_TLS12_PSK_TO_MS_MAX_PSK_LEN ];
Janos Follath40e13932019-06-26 13:22:29 +01004946 unsigned char* cur = pms;
Janos Follath6660f0e2019-06-17 08:44:03 +01004947
4948 if( data_length > PSA_ALG_TLS12_PSK_TO_MS_MAX_PSK_LEN )
4949 return( PSA_ERROR_INVALID_ARGUMENT );
4950
4951 /* Quoting RFC 4279, Section 2:
4952 *
4953 * The premaster secret is formed as follows: if the PSK is N octets
4954 * long, concatenate a uint16 with the value N, N zero octets, a second
4955 * uint16 with the value N, and the PSK itself.
4956 */
4957
Janos Follath40e13932019-06-26 13:22:29 +01004958 *cur++ = ( data_length >> 8 ) & 0xff;
4959 *cur++ = ( data_length >> 0 ) & 0xff;
4960 memset( cur, 0, data_length );
4961 cur += data_length;
4962 *cur++ = pms[0];
4963 *cur++ = pms[1];
4964 memcpy( cur, data, data_length );
4965 cur += data_length;
Janos Follath6660f0e2019-06-17 08:44:03 +01004966
Janos Follath40e13932019-06-26 13:22:29 +01004967 status = psa_tls12_prf_set_key( prf, hash_alg, pms, cur - pms );
Janos Follath6660f0e2019-06-17 08:44:03 +01004968
4969 mbedtls_platform_zeroize( pms, sizeof( pms ) );
4970 return( status );
4971}
4972
Janos Follath63028dd2019-06-13 09:15:47 +01004973static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
4974 const uint8_t *data,
4975 size_t data_length )
4976{
4977 if( prf->state != TLS12_PRF_STATE_KEY_SET )
4978 return( PSA_ERROR_BAD_STATE );
4979
Janos Follathd6dce9f2019-07-04 09:11:38 +01004980 if( data_length != 0 )
4981 {
4982 prf->label = mbedtls_calloc( 1, data_length );
4983 if( prf->label == NULL )
4984 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01004985
Janos Follathd6dce9f2019-07-04 09:11:38 +01004986 memcpy( prf->label, data, data_length );
4987 prf->label_length = data_length;
4988 }
Janos Follath63028dd2019-06-13 09:15:47 +01004989
4990 prf->state = TLS12_PRF_STATE_LABEL_SET;
4991
4992 return( PSA_SUCCESS );
4993}
4994
Janos Follathb03233e2019-06-11 15:30:30 +01004995static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
4996 psa_algorithm_t hash_alg,
4997 psa_key_derivation_step_t step,
4998 const uint8_t *data,
4999 size_t data_length )
5000{
Janos Follathb03233e2019-06-11 15:30:30 +01005001 switch( step )
5002 {
Janos Follathf08e2652019-06-13 09:05:41 +01005003 case PSA_KEY_DERIVATION_INPUT_SEED:
5004 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01005005 case PSA_KEY_DERIVATION_INPUT_SECRET:
5006 return( psa_tls12_prf_set_key( prf, hash_alg, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01005007 case PSA_KEY_DERIVATION_INPUT_LABEL:
5008 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01005009 default:
5010 return( PSA_ERROR_INVALID_ARGUMENT );
5011 }
5012}
Janos Follath6660f0e2019-06-17 08:44:03 +01005013
5014static psa_status_t psa_tls12_prf_psk_to_ms_input(
5015 psa_tls12_prf_key_derivation_t *prf,
5016 psa_algorithm_t hash_alg,
5017 psa_key_derivation_step_t step,
5018 const uint8_t *data,
5019 size_t data_length )
5020{
5021 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01005022 {
Janos Follath6660f0e2019-06-17 08:44:03 +01005023 return( psa_tls12_prf_psk_to_ms_set_key( prf, hash_alg,
5024 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01005025 }
Janos Follath6660f0e2019-06-17 08:44:03 +01005026
5027 return( psa_tls12_prf_input( prf, hash_alg, step, data, data_length ) );
5028}
Janos Follathb03233e2019-06-11 15:30:30 +01005029#endif /* PSA_PRE_1_0_KEY_DERIVATION */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005030#endif /* MBEDTLS_MD_C */
5031
Janos Follathb80a94e2019-06-12 15:54:46 +01005032static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005033 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005034 psa_key_derivation_step_t step,
5035 const uint8_t *data,
5036 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005037{
5038 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005039 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005040
5041#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005042 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005043 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005044 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005045 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005046 step, data, data_length );
5047 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01005048 else
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005049#endif /* MBEDTLS_MD_C */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005050#if defined(MBEDTLS_MD_C)
Janos Follath6660f0e2019-06-17 08:44:03 +01005051 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005052 {
Janos Follathb03233e2019-06-11 15:30:30 +01005053 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
5054 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5055 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01005056 }
5057 else if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
5058 {
5059 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
5060 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5061 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005062 }
5063 else
5064#endif /* MBEDTLS_MD_C */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005065 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005066 /* This can't happen unless the operation object was not initialized */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005067 return( PSA_ERROR_BAD_STATE );
5068 }
5069
5070 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005071 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005072 return( status );
5073}
5074
Janos Follath51f4a0f2019-06-14 11:35:55 +01005075psa_status_t psa_key_derivation_input_bytes(
5076 psa_key_derivation_operation_t *operation,
5077 psa_key_derivation_step_t step,
5078 const uint8_t *data,
5079 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005080{
Janos Follathc5621512019-06-14 11:27:57 +01005081 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5082 return( PSA_ERROR_INVALID_ARGUMENT );
5083
5084 return( psa_key_derivation_input_internal( operation, step,
5085 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005086}
5087
Janos Follath51f4a0f2019-06-14 11:35:55 +01005088psa_status_t psa_key_derivation_input_key(
5089 psa_key_derivation_operation_t *operation,
5090 psa_key_derivation_step_t step,
5091 psa_key_handle_t handle )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005092{
5093 psa_key_slot_t *slot;
5094 psa_status_t status;
5095 status = psa_get_key_from_slot( handle, &slot,
5096 PSA_KEY_USAGE_DERIVE,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005097 operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005098 if( status != PSA_SUCCESS )
5099 return( status );
5100 if( slot->type != PSA_KEY_TYPE_DERIVE )
5101 return( PSA_ERROR_INVALID_ARGUMENT );
5102 /* Don't allow a key to be used as an input that is usually public.
5103 * This is debatable. It's ok from a cryptographic perspective to
5104 * use secret material as an input that is usually public. However
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005105 * the material should be dedicated to a particular input step,
5106 * otherwise this may allow the key to be used in an unintended way
5107 * and leak values derived from the key. So be conservative. */
Gilles Peskine03410b52019-05-16 16:05:19 +02005108 if( step != PSA_KEY_DERIVATION_INPUT_SECRET )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005109 return( PSA_ERROR_INVALID_ARGUMENT );
Janos Follathb80a94e2019-06-12 15:54:46 +01005110 return( psa_key_derivation_input_internal( operation,
5111 step,
5112 slot->data.raw.data,
5113 slot->data.raw.bytes ) );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005114}
5115
Gilles Peskineea0fb492018-07-12 17:17:20 +02005116
5117
5118/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02005119/* Key agreement */
5120/****************************************************************/
5121
Gilles Peskinea05219c2018-11-16 16:02:56 +01005122#if defined(MBEDTLS_ECDH_C)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005123static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
5124 size_t peer_key_length,
5125 const mbedtls_ecp_keypair *our_key,
5126 uint8_t *shared_secret,
5127 size_t shared_secret_size,
5128 size_t *shared_secret_length )
5129{
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005130 mbedtls_ecp_keypair *their_key = NULL;
5131 mbedtls_ecdh_context ecdh;
Jaeden Amero1e5c2bd2019-01-10 19:38:51 +00005132 psa_status_t status;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005133 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005134
Jaeden Amero0ae445f2019-01-10 11:42:27 +00005135 status = psa_import_ec_public_key(
5136 mbedtls_ecc_group_to_psa( our_key->grp.id ),
5137 peer_key, peer_key_length,
5138 &their_key );
Jaeden Amero1e5c2bd2019-01-10 19:38:51 +00005139 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005140 goto exit;
Gilles Peskineb4086612018-11-14 20:51:23 +01005141
Jaeden Amero1e5c2bd2019-01-10 19:38:51 +00005142 status = mbedtls_to_psa_error(
5143 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
5144 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005145 goto exit;
Jaeden Amero1e5c2bd2019-01-10 19:38:51 +00005146 status = mbedtls_to_psa_error(
5147 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
5148 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005149 goto exit;
5150
Jaeden Amero1e5c2bd2019-01-10 19:38:51 +00005151 status = mbedtls_to_psa_error(
5152 mbedtls_ecdh_calc_secret( &ecdh,
5153 shared_secret_length,
5154 shared_secret, shared_secret_size,
5155 mbedtls_ctr_drbg_random,
5156 &global_data.ctr_drbg ) );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005157
5158exit:
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005159 mbedtls_ecdh_free( &ecdh );
Jaeden Amero0ae445f2019-01-10 11:42:27 +00005160 mbedtls_ecp_keypair_free( their_key );
5161 mbedtls_free( their_key );
Jaeden Amero1e5c2bd2019-01-10 19:38:51 +00005162 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005163}
Gilles Peskinea05219c2018-11-16 16:02:56 +01005164#endif /* MBEDTLS_ECDH_C */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005165
Gilles Peskine01d718c2018-09-18 12:01:02 +02005166#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
5167
Gilles Peskine0216fe12019-04-11 21:23:21 +02005168static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
5169 psa_key_slot_t *private_key,
5170 const uint8_t *peer_key,
5171 size_t peer_key_length,
5172 uint8_t *shared_secret,
5173 size_t shared_secret_size,
5174 size_t *shared_secret_length )
5175{
5176 switch( alg )
5177 {
5178#if defined(MBEDTLS_ECDH_C)
5179 case PSA_ALG_ECDH:
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005180 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->type ) )
Gilles Peskine0216fe12019-04-11 21:23:21 +02005181 return( PSA_ERROR_INVALID_ARGUMENT );
5182 return( psa_key_agreement_ecdh( peer_key, peer_key_length,
5183 private_key->data.ecp,
5184 shared_secret, shared_secret_size,
5185 shared_secret_length ) );
Gilles Peskine0216fe12019-04-11 21:23:21 +02005186#endif /* MBEDTLS_ECDH_C */
5187 default:
5188 (void) private_key;
5189 (void) peer_key;
5190 (void) peer_key_length;
5191 (void) shared_secret;
5192 (void) shared_secret_size;
5193 (void) shared_secret_length;
5194 return( PSA_ERROR_NOT_SUPPORTED );
5195 }
5196}
5197
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005198/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine346797d2018-11-16 16:05:06 +01005199 * to potentially free embedded data structures and wipe confidential data.
5200 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005201static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005202 psa_key_derivation_step_t step,
Gilles Peskine2f060a82018-12-04 17:12:32 +01005203 psa_key_slot_t *private_key,
Gilles Peskine01d718c2018-09-18 12:01:02 +02005204 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005205 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005206{
5207 psa_status_t status;
5208 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
5209 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005210 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005211
5212 /* Step 1: run the secret agreement algorithm to generate the shared
5213 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02005214 status = psa_key_agreement_raw_internal( ka_alg,
5215 private_key,
5216 peer_key, peer_key_length,
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005217 shared_secret,
5218 sizeof( shared_secret ),
5219 &shared_secret_length );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005220 if( status != PSA_SUCCESS )
5221 goto exit;
5222
5223 /* Step 2: set up the key derivation to generate key material from
5224 * the shared secret. */
Janos Follathb80a94e2019-06-12 15:54:46 +01005225 status = psa_key_derivation_input_internal( operation, step,
5226 shared_secret,
5227 shared_secret_length );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005228
Gilles Peskine01d718c2018-09-18 12:01:02 +02005229exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01005230 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005231 return( status );
5232}
5233
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005234psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005235 psa_key_derivation_step_t step,
5236 psa_key_handle_t private_key,
5237 const uint8_t *peer_key,
5238 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005239{
Gilles Peskine2f060a82018-12-04 17:12:32 +01005240 psa_key_slot_t *slot;
Gilles Peskine01d718c2018-09-18 12:01:02 +02005241 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005242 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005243 return( PSA_ERROR_INVALID_ARGUMENT );
5244 status = psa_get_key_from_slot( private_key, &slot,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005245 PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005246 if( status != PSA_SUCCESS )
5247 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005248 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01005249 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005250 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01005251 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005252 psa_key_derivation_abort( operation );
Gilles Peskine346797d2018-11-16 16:05:06 +01005253 return( status );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005254}
5255
Gilles Peskinebe697d82019-05-16 18:00:41 +02005256psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
5257 psa_key_handle_t private_key,
5258 const uint8_t *peer_key,
5259 size_t peer_key_length,
5260 uint8_t *output,
5261 size_t output_size,
5262 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02005263{
5264 psa_key_slot_t *slot;
5265 psa_status_t status;
5266
5267 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
5268 {
5269 status = PSA_ERROR_INVALID_ARGUMENT;
5270 goto exit;
5271 }
5272 status = psa_get_key_from_slot( private_key, &slot,
5273 PSA_KEY_USAGE_DERIVE, alg );
5274 if( status != PSA_SUCCESS )
5275 goto exit;
5276
5277 status = psa_key_agreement_raw_internal( alg, slot,
5278 peer_key, peer_key_length,
5279 output, output_size,
5280 output_length );
5281
5282exit:
5283 if( status != PSA_SUCCESS )
5284 {
5285 /* If an error happens and is not handled properly, the output
5286 * may be used as a key to protect sensitive data. Arrange for such
5287 * a key to be random, which is likely to result in decryption or
5288 * verification errors. This is better than filling the buffer with
5289 * some constant data such as zeros, which would result in the data
5290 * being protected with a reproducible, easily knowable key.
5291 */
5292 psa_generate_random( output, output_size );
5293 *output_length = output_size;
5294 }
5295 return( status );
5296}
Gilles Peskine01d718c2018-09-18 12:01:02 +02005297
5298
5299/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02005300/* Random generation */
Gilles Peskine05d69892018-06-19 22:00:52 +02005301/****************************************************************/
5302
5303psa_status_t psa_generate_random( uint8_t *output,
5304 size_t output_size )
5305{
itayzafrir0adf0fc2018-09-06 16:24:41 +03005306 int ret;
5307 GUARD_MODULE_INITIALIZED;
5308
5309 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg, output, output_size );
Gilles Peskine05d69892018-06-19 22:00:52 +02005310 return( mbedtls_to_psa_error( ret ) );
5311}
5312
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005313#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
5314#include "mbedtls/entropy_poll.h"
avolinski13beb102018-11-20 16:51:49 +02005315
Gilles Peskine7228da22019-07-15 11:06:15 +02005316psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005317 size_t seed_size )
5318{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005319 if( global_data.initialized )
5320 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02005321
5322 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
5323 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
5324 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
5325 return( PSA_ERROR_INVALID_ARGUMENT );
5326
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005327 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005328}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005329#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005330
Gilles Peskinee56e8782019-04-26 17:34:02 +02005331#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_GENPRIME)
5332static psa_status_t psa_read_rsa_exponent( const uint8_t *domain_parameters,
5333 size_t domain_parameters_size,
5334 int *exponent )
5335{
5336 size_t i;
5337 uint32_t acc = 0;
5338
5339 if( domain_parameters_size == 0 )
5340 {
5341 *exponent = 65537;
5342 return( PSA_SUCCESS );
5343 }
5344
5345 /* Mbed TLS encodes the public exponent as an int. For simplicity, only
5346 * support values that fit in a 32-bit integer, which is larger than
5347 * int on just about every platform anyway. */
5348 if( domain_parameters_size > sizeof( acc ) )
5349 return( PSA_ERROR_NOT_SUPPORTED );
5350 for( i = 0; i < domain_parameters_size; i++ )
5351 acc = ( acc << 8 ) | domain_parameters[i];
5352 if( acc > INT_MAX )
5353 return( PSA_ERROR_NOT_SUPPORTED );
5354 *exponent = acc;
5355 return( PSA_SUCCESS );
5356}
5357#endif /* MBEDTLS_RSA_C && MBEDTLS_GENPRIME */
5358
Gilles Peskine35ef36b2019-05-16 19:42:05 +02005359static psa_status_t psa_generate_key_internal(
Gilles Peskinee56e8782019-04-26 17:34:02 +02005360 psa_key_slot_t *slot, size_t bits,
5361 const uint8_t *domain_parameters, size_t domain_parameters_size )
Gilles Peskine05d69892018-06-19 22:00:52 +02005362{
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005363 psa_key_type_t type = slot->type;
Gilles Peskine12313cd2018-06-20 00:20:32 +02005364
Gilles Peskinee56e8782019-04-26 17:34:02 +02005365 if( domain_parameters == NULL && domain_parameters_size != 0 )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005366 return( PSA_ERROR_INVALID_ARGUMENT );
5367
Gilles Peskine48c0ea12018-06-21 14:15:31 +02005368 if( key_type_is_raw_bytes( type ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005369 {
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005370 psa_status_t status;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02005371 status = prepare_raw_data_slot( type, bits, &slot->data.raw );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005372 if( status != PSA_SUCCESS )
5373 return( status );
5374 status = psa_generate_random( slot->data.raw.data,
5375 slot->data.raw.bytes );
5376 if( status != PSA_SUCCESS )
5377 {
5378 mbedtls_free( slot->data.raw.data );
5379 return( status );
5380 }
5381#if defined(MBEDTLS_DES_C)
5382 if( type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02005383 psa_des_set_key_parity( slot->data.raw.data,
5384 slot->data.raw.bytes );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005385#endif /* MBEDTLS_DES_C */
5386 }
5387 else
5388
5389#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_GENPRIME)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005390 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005391 {
5392 mbedtls_rsa_context *rsa;
5393 int ret;
Gilles Peskinee56e8782019-04-26 17:34:02 +02005394 int exponent;
5395 psa_status_t status;
Gilles Peskineaf3baab2018-06-27 22:55:52 +02005396 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
5397 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine86a440b2018-11-12 18:39:40 +01005398 /* Accept only byte-aligned keys, for the same reasons as
5399 * in psa_import_rsa_key(). */
5400 if( bits % 8 != 0 )
5401 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinee56e8782019-04-26 17:34:02 +02005402 status = psa_read_rsa_exponent( domain_parameters,
5403 domain_parameters_size,
5404 &exponent );
5405 if( status != PSA_SUCCESS )
5406 return( status );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005407 rsa = mbedtls_calloc( 1, sizeof( *rsa ) );
5408 if( rsa == NULL )
5409 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5410 mbedtls_rsa_init( rsa, MBEDTLS_RSA_PKCS_V15, MBEDTLS_MD_NONE );
5411 ret = mbedtls_rsa_gen_key( rsa,
5412 mbedtls_ctr_drbg_random,
5413 &global_data.ctr_drbg,
Jaeden Amero23bbb752018-06-26 14:16:54 +01005414 (unsigned int) bits,
Gilles Peskine12313cd2018-06-20 00:20:32 +02005415 exponent );
5416 if( ret != 0 )
5417 {
5418 mbedtls_rsa_free( rsa );
5419 mbedtls_free( rsa );
5420 return( mbedtls_to_psa_error( ret ) );
5421 }
5422 slot->data.rsa = rsa;
5423 }
5424 else
5425#endif /* MBEDTLS_RSA_C && MBEDTLS_GENPRIME */
5426
5427#if defined(MBEDTLS_ECP_C)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005428 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005429 {
5430 psa_ecc_curve_t curve = PSA_KEY_TYPE_GET_CURVE( type );
5431 mbedtls_ecp_group_id grp_id = mbedtls_ecc_group_of_psa( curve );
5432 const mbedtls_ecp_curve_info *curve_info =
5433 mbedtls_ecp_curve_info_from_grp_id( grp_id );
5434 mbedtls_ecp_keypair *ecp;
5435 int ret;
Gilles Peskinee56e8782019-04-26 17:34:02 +02005436 if( domain_parameters_size != 0 )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005437 return( PSA_ERROR_NOT_SUPPORTED );
5438 if( grp_id == MBEDTLS_ECP_DP_NONE || curve_info == NULL )
5439 return( PSA_ERROR_NOT_SUPPORTED );
5440 if( curve_info->bit_size != bits )
5441 return( PSA_ERROR_INVALID_ARGUMENT );
5442 ecp = mbedtls_calloc( 1, sizeof( *ecp ) );
5443 if( ecp == NULL )
5444 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5445 mbedtls_ecp_keypair_init( ecp );
5446 ret = mbedtls_ecp_gen_key( grp_id, ecp,
5447 mbedtls_ctr_drbg_random,
5448 &global_data.ctr_drbg );
5449 if( ret != 0 )
5450 {
5451 mbedtls_ecp_keypair_free( ecp );
5452 mbedtls_free( ecp );
5453 return( mbedtls_to_psa_error( ret ) );
5454 }
5455 slot->data.ecp = ecp;
5456 }
5457 else
5458#endif /* MBEDTLS_ECP_C */
5459
5460 return( PSA_ERROR_NOT_SUPPORTED );
5461
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005462 return( PSA_SUCCESS );
5463}
5464
Gilles Peskine35ef36b2019-05-16 19:42:05 +02005465psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Gilles Peskinee56e8782019-04-26 17:34:02 +02005466 psa_key_handle_t *handle )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005467{
5468 psa_status_t status;
5469 psa_key_slot_t *slot = NULL;
5470 status = psa_start_key_creation( attributes, handle, &slot );
5471 if( status == PSA_SUCCESS )
5472 {
Gilles Peskine35ef36b2019-05-16 19:42:05 +02005473 status = psa_generate_key_internal(
Gilles Peskinee56e8782019-04-26 17:34:02 +02005474 slot, attributes->bits,
5475 attributes->domain_parameters, attributes->domain_parameters_size );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005476 }
5477 if( status == PSA_SUCCESS )
5478 status = psa_finish_key_creation( slot );
5479 if( status != PSA_SUCCESS )
5480 {
5481 psa_fail_key_creation( slot );
5482 *handle = 0;
5483 }
5484 return( status );
5485}
5486
5487
Gilles Peskine05d69892018-06-19 22:00:52 +02005488
5489/****************************************************************/
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01005490/* Module setup */
5491/****************************************************************/
5492
Gilles Peskine5e769522018-11-20 21:59:56 +01005493psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
5494 void (* entropy_init )( mbedtls_entropy_context *ctx ),
5495 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
5496{
5497 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5498 return( PSA_ERROR_BAD_STATE );
5499 global_data.entropy_init = entropy_init;
5500 global_data.entropy_free = entropy_free;
5501 return( PSA_SUCCESS );
5502}
5503
Gilles Peskinee59236f2018-01-27 23:32:46 +01005504void mbedtls_psa_crypto_free( void )
5505{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005506 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005507 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5508 {
5509 mbedtls_ctr_drbg_free( &global_data.ctr_drbg );
Gilles Peskine5e769522018-11-20 21:59:56 +01005510 global_data.entropy_free( &global_data.entropy );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005511 }
5512 /* Wipe all remaining data, including configuration.
5513 * In particular, this sets all state indicator to the value
5514 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01005515 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005516#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +02005517 /* Unregister all secure element drivers, so that we restart from
5518 * a pristine state. */
5519 psa_unregister_all_se_drivers( );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005520#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005521}
5522
5523psa_status_t psa_crypto_init( void )
5524{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005525 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005526 const unsigned char drbg_seed[] = "PSA";
5527
Gilles Peskinec6b69072018-11-20 21:42:52 +01005528 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005529 if( global_data.initialized != 0 )
5530 return( PSA_SUCCESS );
5531
Gilles Peskine5e769522018-11-20 21:59:56 +01005532 /* Set default configuration if
5533 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
5534 if( global_data.entropy_init == NULL )
5535 global_data.entropy_init = mbedtls_entropy_init;
5536 if( global_data.entropy_free == NULL )
5537 global_data.entropy_free = mbedtls_entropy_free;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005538
Gilles Peskinec6b69072018-11-20 21:42:52 +01005539 /* Initialize the random generator. */
Gilles Peskine5e769522018-11-20 21:59:56 +01005540 global_data.entropy_init( &global_data.entropy );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005541 mbedtls_ctr_drbg_init( &global_data.ctr_drbg );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005542 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine66fb1262018-12-10 16:29:04 +01005543 status = mbedtls_to_psa_error(
5544 mbedtls_ctr_drbg_seed( &global_data.ctr_drbg,
5545 mbedtls_entropy_func,
5546 &global_data.entropy,
5547 drbg_seed, sizeof( drbg_seed ) - 1 ) );
5548 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005549 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005550 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005551
Gilles Peskine66fb1262018-12-10 16:29:04 +01005552 status = psa_initialize_key_slots( );
5553 if( status != PSA_SUCCESS )
5554 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005555
5556 /* All done. */
Gilles Peskinee4ebc122018-03-07 14:16:44 +01005557 global_data.initialized = 1;
5558
Gilles Peskinee59236f2018-01-27 23:32:46 +01005559exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01005560 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005561 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005562 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005563}
5564
5565#endif /* MBEDTLS_PSA_CRYPTO_C */