blob: 635114137e37abac70163474f11fa83a96d68525 [file] [log] [blame]
Gilles Peskinee59236f2018-01-27 23:32:46 +01001/* BEGIN_HEADER */
itayzafrir3e02b3b2018-06-12 17:06:52 +03002#include <stdint.h>
mohammad160327010052018-07-03 13:16:15 +03003
Gilles Peskinedd2f95b2018-08-11 01:22:42 +02004#include "mbedtls/asn1.h"
Gilles Peskine0b352bc2018-06-28 00:16:11 +02005#include "mbedtls/asn1write.h"
Gilles Peskinedd2f95b2018-08-11 01:22:42 +02006#include "mbedtls/oid.h"
7
Gilles Peskinebdc96fd2019-08-07 12:08:04 +02008/* For MBEDTLS_CTR_DRBG_MAX_REQUEST, knowing that psa_generate_random()
9 * uses mbedtls_ctr_drbg internally. */
10#include "mbedtls/ctr_drbg.h"
11
Ronald Cron02c78b72020-05-27 09:22:32 +020012#include "test/psa_crypto_helpers.h"
itayzafrir3e02b3b2018-06-12 17:06:52 +030013
Gilles Peskinec744d992019-07-30 17:26:54 +020014/* Tests that require more than 128kB of RAM plus change have this symbol
15 * as a dependency. Currently we always define this symbol, so the tests
16 * are always executed. In the future we should make this conditional
17 * so that tests that require a lot of memory are skipped on constrained
18 * platforms. */
Gilles Peskine49232e82019-08-07 11:01:30 +020019#define HAVE_RAM_AVAILABLE_128K
Gilles Peskinec744d992019-07-30 17:26:54 +020020
Gilles Peskinebdc96fd2019-08-07 12:08:04 +020021#include "psa/crypto.h"
22
Jaeden Amerof24c7f82018-06-27 17:20:43 +010023/** An invalid export length that will never be set by psa_export_key(). */
24static const size_t INVALID_EXPORT_LENGTH = ~0U;
25
Gilles Peskinef426e0f2019-02-25 17:42:03 +010026/* A hash algorithm that is known to be supported.
27 *
28 * This is used in some smoke tests.
29 */
30#if defined(MBEDTLS_MD2_C)
31#define KNOWN_SUPPORTED_HASH_ALG PSA_ALG_MD2
32#elif defined(MBEDTLS_MD4_C)
33#define KNOWN_SUPPORTED_HASH_ALG PSA_ALG_MD4
34#elif defined(MBEDTLS_MD5_C)
35#define KNOWN_SUPPORTED_HASH_ALG PSA_ALG_MD5
36/* MBEDTLS_RIPEMD160_C omitted. This is necessary for the sake of
37 * exercise_signature_key() because Mbed TLS doesn't support RIPEMD160
38 * in RSA PKCS#1v1.5 signatures. A RIPEMD160-only configuration would be
39 * implausible anyway. */
40#elif defined(MBEDTLS_SHA1_C)
41#define KNOWN_SUPPORTED_HASH_ALG PSA_ALG_SHA_1
42#elif defined(MBEDTLS_SHA256_C)
43#define KNOWN_SUPPORTED_HASH_ALG PSA_ALG_SHA_256
44#elif defined(MBEDTLS_SHA512_C)
45#define KNOWN_SUPPORTED_HASH_ALG PSA_ALG_SHA_384
46#elif defined(MBEDTLS_SHA3_C)
47#define KNOWN_SUPPORTED_HASH_ALG PSA_ALG_SHA3_256
48#else
49#undef KNOWN_SUPPORTED_HASH_ALG
50#endif
51
52/* A block cipher that is known to be supported.
53 *
54 * For simplicity's sake, stick to block ciphers with 16-byte blocks.
55 */
56#if defined(MBEDTLS_AES_C)
57#define KNOWN_SUPPORTED_BLOCK_CIPHER PSA_KEY_TYPE_AES
58#elif defined(MBEDTLS_ARIA_C)
59#define KNOWN_SUPPORTED_BLOCK_CIPHER PSA_KEY_TYPE_ARIA
60#elif defined(MBEDTLS_CAMELLIA_C)
61#define KNOWN_SUPPORTED_BLOCK_CIPHER PSA_KEY_TYPE_CAMELLIA
62#undef KNOWN_SUPPORTED_BLOCK_CIPHER
63#endif
64
65/* A MAC mode that is known to be supported.
66 *
67 * It must either be HMAC with #KNOWN_SUPPORTED_HASH_ALG or
68 * a block cipher-based MAC with #KNOWN_SUPPORTED_BLOCK_CIPHER.
69 *
70 * This is used in some smoke tests.
71 */
72#if defined(KNOWN_SUPPORTED_HASH_ALG)
73#define KNOWN_SUPPORTED_MAC_ALG ( PSA_ALG_HMAC( KNOWN_SUPPORTED_HASH_ALG ) )
74#define KNOWN_SUPPORTED_MAC_KEY_TYPE PSA_KEY_TYPE_HMAC
75#elif defined(KNOWN_SUPPORTED_BLOCK_CIPHER) && defined(MBEDTLS_CMAC_C)
76#define KNOWN_SUPPORTED_MAC_ALG PSA_ALG_CMAC
77#define KNOWN_SUPPORTED_MAC_KEY_TYPE KNOWN_SUPPORTED_BLOCK_CIPHER
78#else
79#undef KNOWN_SUPPORTED_MAC_ALG
80#undef KNOWN_SUPPORTED_MAC_KEY_TYPE
81#endif
82
83/* A cipher algorithm and key type that are known to be supported.
84 *
85 * This is used in some smoke tests.
86 */
87#if defined(KNOWN_SUPPORTED_BLOCK_CIPHER) && defined(MBEDTLS_CIPHER_MODE_CTR)
88#define KNOWN_SUPPORTED_BLOCK_CIPHER_ALG PSA_ALG_CTR
89#elif defined(KNOWN_SUPPORTED_BLOCK_CIPHER) && defined(MBEDTLS_CIPHER_MODE_CBC)
90#define KNOWN_SUPPORTED_BLOCK_CIPHER_ALG PSA_ALG_CBC_NO_PADDING
91#elif defined(KNOWN_SUPPORTED_BLOCK_CIPHER) && defined(MBEDTLS_CIPHER_MODE_CFB)
92#define KNOWN_SUPPORTED_BLOCK_CIPHER_ALG PSA_ALG_CFB
93#elif defined(KNOWN_SUPPORTED_BLOCK_CIPHER) && defined(MBEDTLS_CIPHER_MODE_OFB)
94#define KNOWN_SUPPORTED_BLOCK_CIPHER_ALG PSA_ALG_OFB
95#else
96#undef KNOWN_SUPPORTED_BLOCK_CIPHER_ALG
97#endif
98#if defined(KNOWN_SUPPORTED_BLOCK_CIPHER_ALG)
99#define KNOWN_SUPPORTED_CIPHER_ALG KNOWN_SUPPORTED_BLOCK_CIPHER_ALG
100#define KNOWN_SUPPORTED_CIPHER_KEY_TYPE KNOWN_SUPPORTED_BLOCK_CIPHER
101#elif defined(MBEDTLS_RC4_C)
102#define KNOWN_SUPPORTED_CIPHER_ALG PSA_ALG_RC4
103#define KNOWN_SUPPORTED_CIPHER_KEY_TYPE PSA_KEY_TYPE_RC4
104#else
105#undef KNOWN_SUPPORTED_CIPHER_ALG
106#undef KNOWN_SUPPORTED_CIPHER_KEY_TYPE
107#endif
108
Gilles Peskine667c1112019-12-03 19:03:20 +0100109#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
110int lifetime_is_secure_element( psa_key_lifetime_t lifetime )
111{
112 /* At the moment, anything that isn't a built-in lifetime is either
113 * a secure element or unassigned. */
114 return( lifetime != PSA_KEY_LIFETIME_VOLATILE &&
115 lifetime != PSA_KEY_LIFETIME_PERSISTENT );
116}
117#else
118int lifetime_is_secure_element( psa_key_lifetime_t lifetime )
119{
120 (void) lifetime;
121 return( 0 );
122}
123#endif
124
Gilles Peskinea7aa4422018-08-14 15:17:54 +0200125/** Test if a buffer contains a constant byte value.
126 *
127 * `mem_is_char(buffer, c, size)` is true after `memset(buffer, c, size)`.
Gilles Peskinee66ca3b2018-06-20 00:11:45 +0200128 *
129 * \param buffer Pointer to the beginning of the buffer.
Gilles Peskinea7aa4422018-08-14 15:17:54 +0200130 * \param c Expected value of every byte.
Gilles Peskinee66ca3b2018-06-20 00:11:45 +0200131 * \param size Size of the buffer in bytes.
132 *
Gilles Peskine3f669c32018-06-21 09:21:51 +0200133 * \return 1 if the buffer is all-bits-zero.
134 * \return 0 if there is at least one nonzero byte.
Gilles Peskinee66ca3b2018-06-20 00:11:45 +0200135 */
Gilles Peskinea7aa4422018-08-14 15:17:54 +0200136static int mem_is_char( void *buffer, unsigned char c, size_t size )
Gilles Peskinee66ca3b2018-06-20 00:11:45 +0200137{
138 size_t i;
139 for( i = 0; i < size; i++ )
140 {
Gilles Peskinea7aa4422018-08-14 15:17:54 +0200141 if( ( (unsigned char *) buffer )[i] != c )
Gilles Peskine3f669c32018-06-21 09:21:51 +0200142 return( 0 );
Gilles Peskinee66ca3b2018-06-20 00:11:45 +0200143 }
Gilles Peskine3f669c32018-06-21 09:21:51 +0200144 return( 1 );
Gilles Peskinee66ca3b2018-06-20 00:11:45 +0200145}
Gilles Peskine818ca122018-06-20 18:16:48 +0200146
Gilles Peskine0b352bc2018-06-28 00:16:11 +0200147/* Write the ASN.1 INTEGER with the value 2^(bits-1)+x backwards from *p. */
148static int asn1_write_10x( unsigned char **p,
149 unsigned char *start,
150 size_t bits,
151 unsigned char x )
152{
153 int ret;
154 int len = bits / 8 + 1;
Gilles Peskine480416a2018-06-28 19:04:07 +0200155 if( bits == 0 )
156 return( MBEDTLS_ERR_ASN1_INVALID_DATA );
157 if( bits <= 8 && x >= 1 << ( bits - 1 ) )
Gilles Peskine0b352bc2018-06-28 00:16:11 +0200158 return( MBEDTLS_ERR_ASN1_INVALID_DATA );
Moran Pekercb088e72018-07-17 17:36:59 +0300159 if( *p < start || *p - start < (ptrdiff_t) len )
Gilles Peskine0b352bc2018-06-28 00:16:11 +0200160 return( MBEDTLS_ERR_ASN1_BUF_TOO_SMALL );
161 *p -= len;
162 ( *p )[len-1] = x;
163 if( bits % 8 == 0 )
164 ( *p )[1] |= 1;
165 else
166 ( *p )[0] |= 1 << ( bits % 8 );
167 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_len( p, start, len ) );
168 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_tag( p, start,
169 MBEDTLS_ASN1_INTEGER ) );
170 return( len );
171}
172
173static int construct_fake_rsa_key( unsigned char *buffer,
174 size_t buffer_size,
175 unsigned char **p,
176 size_t bits,
177 int keypair )
178{
179 size_t half_bits = ( bits + 1 ) / 2;
180 int ret;
181 int len = 0;
182 /* Construct something that looks like a DER encoding of
183 * as defined by PKCS#1 v2.2 (RFC 8017) section A.1.2:
184 * RSAPrivateKey ::= SEQUENCE {
185 * version Version,
186 * modulus INTEGER, -- n
187 * publicExponent INTEGER, -- e
188 * privateExponent INTEGER, -- d
189 * prime1 INTEGER, -- p
190 * prime2 INTEGER, -- q
191 * exponent1 INTEGER, -- d mod (p-1)
192 * exponent2 INTEGER, -- d mod (q-1)
193 * coefficient INTEGER, -- (inverse of q) mod p
194 * otherPrimeInfos OtherPrimeInfos OPTIONAL
195 * }
196 * Or, for a public key, the same structure with only
197 * version, modulus and publicExponent.
198 */
199 *p = buffer + buffer_size;
200 if( keypair )
201 {
202 MBEDTLS_ASN1_CHK_ADD( len, /* pq */
203 asn1_write_10x( p, buffer, half_bits, 1 ) );
204 MBEDTLS_ASN1_CHK_ADD( len, /* dq */
205 asn1_write_10x( p, buffer, half_bits, 1 ) );
206 MBEDTLS_ASN1_CHK_ADD( len, /* dp */
207 asn1_write_10x( p, buffer, half_bits, 1 ) );
208 MBEDTLS_ASN1_CHK_ADD( len, /* q */
209 asn1_write_10x( p, buffer, half_bits, 1 ) );
210 MBEDTLS_ASN1_CHK_ADD( len, /* p != q to pass mbedtls sanity checks */
211 asn1_write_10x( p, buffer, half_bits, 3 ) );
212 MBEDTLS_ASN1_CHK_ADD( len, /* d */
213 asn1_write_10x( p, buffer, bits, 1 ) );
214 }
215 MBEDTLS_ASN1_CHK_ADD( len, /* e = 65537 */
216 asn1_write_10x( p, buffer, 17, 1 ) );
217 MBEDTLS_ASN1_CHK_ADD( len, /* n */
218 asn1_write_10x( p, buffer, bits, 1 ) );
219 if( keypair )
220 MBEDTLS_ASN1_CHK_ADD( len, /* version = 0 */
221 mbedtls_asn1_write_int( p, buffer, 0 ) );
222 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_len( p, buffer, len ) );
223 {
224 const unsigned char tag =
225 MBEDTLS_ASN1_CONSTRUCTED | MBEDTLS_ASN1_SEQUENCE;
226 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_tag( p, buffer, tag ) );
227 }
228 return( len );
229}
230
Gilles Peskine667c1112019-12-03 19:03:20 +0100231int check_key_attributes_sanity( psa_key_handle_t key )
232{
233 int ok = 0;
234 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
235 psa_key_lifetime_t lifetime;
236 psa_key_id_t id;
237 psa_key_type_t type;
238 psa_key_type_t bits;
239
240 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
241 lifetime = psa_get_key_lifetime( &attributes );
242 id = psa_get_key_id( &attributes );
243 type = psa_get_key_type( &attributes );
244 bits = psa_get_key_bits( &attributes );
245
246 /* Persistence */
247 if( lifetime == PSA_KEY_LIFETIME_VOLATILE )
248 TEST_ASSERT( id == 0 );
249 else
250 {
251 TEST_ASSERT(
252 ( PSA_KEY_ID_USER_MIN <= id && id <= PSA_KEY_ID_USER_MAX ) ||
253 ( PSA_KEY_ID_USER_MIN <= id && id <= PSA_KEY_ID_USER_MAX ) );
254 }
255#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
256 /* randomly-generated 64-bit constant, should never appear in test data */
257 psa_key_slot_number_t slot_number = 0xec94d4a5058a1a21;
258 psa_status_t status = psa_get_key_slot_number( &attributes, &slot_number );
259 if( lifetime_is_secure_element( lifetime ) )
260 {
261 /* Mbed Crypto currently always exposes the slot number to
262 * applications. This is not mandated by the PSA specification
263 * and may change in future versions. */
264 TEST_EQUAL( status, 0 );
265 TEST_ASSERT( slot_number != 0xec94d4a5058a1a21 );
266 }
267 else
268 {
269 TEST_EQUAL( status, PSA_ERROR_INVALID_ARGUMENT );
270 }
271#endif
272
273 /* Type and size */
274 TEST_ASSERT( type != 0 );
275 TEST_ASSERT( bits != 0 );
276 TEST_ASSERT( bits <= PSA_MAX_KEY_BITS );
277 if( PSA_KEY_TYPE_IS_UNSTRUCTURED( type ) )
278 TEST_ASSERT( bits % 8 == 0 );
279
280 /* MAX macros concerning specific key types */
281 if( PSA_KEY_TYPE_IS_ECC( type ) )
282 TEST_ASSERT( bits <= PSA_VENDOR_ECC_MAX_CURVE_BITS );
283 else if( PSA_KEY_TYPE_IS_RSA( type ) )
284 TEST_ASSERT( bits <= PSA_VENDOR_RSA_MAX_KEY_BITS );
285 TEST_ASSERT( PSA_BLOCK_CIPHER_BLOCK_SIZE( type ) <= PSA_MAX_BLOCK_CIPHER_BLOCK_SIZE );
286
287 ok = 1;
288
289exit:
290 psa_reset_key_attributes( &attributes );
291 return( ok );
292}
293
Gilles Peskinef426e0f2019-02-25 17:42:03 +0100294int exercise_mac_setup( psa_key_type_t key_type,
295 const unsigned char *key_bytes,
296 size_t key_length,
297 psa_algorithm_t alg,
298 psa_mac_operation_t *operation,
299 psa_status_t *status )
300{
301 psa_key_handle_t handle = 0;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +0200302 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskinef426e0f2019-02-25 17:42:03 +0100303
Gilles Peskine89d8c5c2019-11-26 17:01:59 +0100304 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_HASH );
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +0200305 psa_set_key_algorithm( &attributes, alg );
306 psa_set_key_type( &attributes, key_type );
Gilles Peskine049c7532019-05-15 20:22:09 +0200307 PSA_ASSERT( psa_import_key( &attributes, key_bytes, key_length,
308 &handle ) );
Gilles Peskinef426e0f2019-02-25 17:42:03 +0100309
310 *status = psa_mac_sign_setup( operation, handle, alg );
Gilles Peskine9e0a4a52019-02-25 22:11:18 +0100311 /* Whether setup succeeded or failed, abort must succeed. */
312 PSA_ASSERT( psa_mac_abort( operation ) );
313 /* If setup failed, reproduce the failure, so that the caller can
314 * test the resulting state of the operation object. */
315 if( *status != PSA_SUCCESS )
Gilles Peskinef426e0f2019-02-25 17:42:03 +0100316 {
Gilles Peskine9e0a4a52019-02-25 22:11:18 +0100317 TEST_EQUAL( psa_mac_sign_setup( operation, handle, alg ),
318 *status );
Gilles Peskinef426e0f2019-02-25 17:42:03 +0100319 }
320
321 psa_destroy_key( handle );
322 return( 1 );
323
324exit:
325 psa_destroy_key( handle );
326 return( 0 );
327}
328
329int exercise_cipher_setup( psa_key_type_t key_type,
330 const unsigned char *key_bytes,
331 size_t key_length,
332 psa_algorithm_t alg,
333 psa_cipher_operation_t *operation,
334 psa_status_t *status )
335{
336 psa_key_handle_t handle = 0;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +0200337 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskinef426e0f2019-02-25 17:42:03 +0100338
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +0200339 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
340 psa_set_key_algorithm( &attributes, alg );
341 psa_set_key_type( &attributes, key_type );
Gilles Peskine049c7532019-05-15 20:22:09 +0200342 PSA_ASSERT( psa_import_key( &attributes, key_bytes, key_length,
343 &handle ) );
Gilles Peskinef426e0f2019-02-25 17:42:03 +0100344
345 *status = psa_cipher_encrypt_setup( operation, handle, alg );
Gilles Peskine9e0a4a52019-02-25 22:11:18 +0100346 /* Whether setup succeeded or failed, abort must succeed. */
347 PSA_ASSERT( psa_cipher_abort( operation ) );
348 /* If setup failed, reproduce the failure, so that the caller can
349 * test the resulting state of the operation object. */
350 if( *status != PSA_SUCCESS )
Gilles Peskinef426e0f2019-02-25 17:42:03 +0100351 {
Gilles Peskine9e0a4a52019-02-25 22:11:18 +0100352 TEST_EQUAL( psa_cipher_encrypt_setup( operation, handle, alg ),
353 *status );
Gilles Peskinef426e0f2019-02-25 17:42:03 +0100354 }
355
356 psa_destroy_key( handle );
357 return( 1 );
358
359exit:
360 psa_destroy_key( handle );
361 return( 0 );
362}
363
Gilles Peskinebdf309c2018-12-03 15:36:32 +0100364static int exercise_mac_key( psa_key_handle_t handle,
Gilles Peskine818ca122018-06-20 18:16:48 +0200365 psa_key_usage_t usage,
366 psa_algorithm_t alg )
367{
Jaeden Amero769ce272019-01-04 11:48:03 +0000368 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
Gilles Peskine818ca122018-06-20 18:16:48 +0200369 const unsigned char input[] = "foo";
Gilles Peskine69c12672018-06-28 00:07:19 +0200370 unsigned char mac[PSA_MAC_MAX_SIZE] = {0};
Gilles Peskine818ca122018-06-20 18:16:48 +0200371 size_t mac_length = sizeof( mac );
372
Gilles Peskine89d8c5c2019-11-26 17:01:59 +0100373 if( usage & PSA_KEY_USAGE_SIGN_HASH )
Gilles Peskine818ca122018-06-20 18:16:48 +0200374 {
Gilles Peskine8817f612018-12-18 00:18:46 +0100375 PSA_ASSERT( psa_mac_sign_setup( &operation,
376 handle, alg ) );
377 PSA_ASSERT( psa_mac_update( &operation,
378 input, sizeof( input ) ) );
379 PSA_ASSERT( psa_mac_sign_finish( &operation,
380 mac, sizeof( mac ),
381 &mac_length ) );
Gilles Peskine818ca122018-06-20 18:16:48 +0200382 }
383
Gilles Peskine89d8c5c2019-11-26 17:01:59 +0100384 if( usage & PSA_KEY_USAGE_VERIFY_HASH )
Gilles Peskine818ca122018-06-20 18:16:48 +0200385 {
386 psa_status_t verify_status =
Gilles Peskine89d8c5c2019-11-26 17:01:59 +0100387 ( usage & PSA_KEY_USAGE_SIGN_HASH ?
Gilles Peskine818ca122018-06-20 18:16:48 +0200388 PSA_SUCCESS :
389 PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine8817f612018-12-18 00:18:46 +0100390 PSA_ASSERT( psa_mac_verify_setup( &operation,
391 handle, alg ) );
392 PSA_ASSERT( psa_mac_update( &operation,
393 input, sizeof( input ) ) );
Gilles Peskinef812dcf2018-12-18 00:33:25 +0100394 TEST_EQUAL( psa_mac_verify_finish( &operation, mac, mac_length ),
395 verify_status );
Gilles Peskine818ca122018-06-20 18:16:48 +0200396 }
397
398 return( 1 );
399
400exit:
401 psa_mac_abort( &operation );
402 return( 0 );
403}
404
Gilles Peskinebdf309c2018-12-03 15:36:32 +0100405static int exercise_cipher_key( psa_key_handle_t handle,
Gilles Peskine818ca122018-06-20 18:16:48 +0200406 psa_key_usage_t usage,
407 psa_algorithm_t alg )
408{
Jaeden Amero5bae2272019-01-04 11:48:27 +0000409 psa_cipher_operation_t operation = PSA_CIPHER_OPERATION_INIT;
Gilles Peskine818ca122018-06-20 18:16:48 +0200410 unsigned char iv[16] = {0};
411 size_t iv_length = sizeof( iv );
412 const unsigned char plaintext[16] = "Hello, world...";
413 unsigned char ciphertext[32] = "(wabblewebblewibblewobblewubble)";
414 size_t ciphertext_length = sizeof( ciphertext );
415 unsigned char decrypted[sizeof( ciphertext )];
416 size_t part_length;
417
418 if( usage & PSA_KEY_USAGE_ENCRYPT )
419 {
Gilles Peskine8817f612018-12-18 00:18:46 +0100420 PSA_ASSERT( psa_cipher_encrypt_setup( &operation,
421 handle, alg ) );
422 PSA_ASSERT( psa_cipher_generate_iv( &operation,
423 iv, sizeof( iv ),
424 &iv_length ) );
425 PSA_ASSERT( psa_cipher_update( &operation,
426 plaintext, sizeof( plaintext ),
427 ciphertext, sizeof( ciphertext ),
428 &ciphertext_length ) );
429 PSA_ASSERT( psa_cipher_finish( &operation,
430 ciphertext + ciphertext_length,
431 sizeof( ciphertext ) - ciphertext_length,
432 &part_length ) );
Gilles Peskine818ca122018-06-20 18:16:48 +0200433 ciphertext_length += part_length;
434 }
435
436 if( usage & PSA_KEY_USAGE_DECRYPT )
437 {
438 psa_status_t status;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +0200439 int maybe_invalid_padding = 0;
Gilles Peskine818ca122018-06-20 18:16:48 +0200440 if( ! ( usage & PSA_KEY_USAGE_ENCRYPT ) )
441 {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +0200442 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
443 PSA_ASSERT( psa_get_key_attributes( handle, &attributes ) );
444 /* This should be PSA_CIPHER_GET_IV_SIZE but the API doesn't
445 * have this macro yet. */
446 iv_length = PSA_BLOCK_CIPHER_BLOCK_SIZE(
447 psa_get_key_type( &attributes ) );
448 maybe_invalid_padding = ! PSA_ALG_IS_STREAM_CIPHER( alg );
Gilles Peskine818ca122018-06-20 18:16:48 +0200449 }
Gilles Peskine8817f612018-12-18 00:18:46 +0100450 PSA_ASSERT( psa_cipher_decrypt_setup( &operation,
451 handle, alg ) );
452 PSA_ASSERT( psa_cipher_set_iv( &operation,
453 iv, iv_length ) );
454 PSA_ASSERT( psa_cipher_update( &operation,
455 ciphertext, ciphertext_length,
456 decrypted, sizeof( decrypted ),
457 &part_length ) );
Gilles Peskine818ca122018-06-20 18:16:48 +0200458 status = psa_cipher_finish( &operation,
459 decrypted + part_length,
460 sizeof( decrypted ) - part_length,
461 &part_length );
462 /* For a stream cipher, all inputs are valid. For a block cipher,
463 * if the input is some aribtrary data rather than an actual
464 ciphertext, a padding error is likely. */
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +0200465 if( maybe_invalid_padding )
Gilles Peskine818ca122018-06-20 18:16:48 +0200466 TEST_ASSERT( status == PSA_SUCCESS ||
467 status == PSA_ERROR_INVALID_PADDING );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +0200468 else
469 PSA_ASSERT( status );
Gilles Peskine818ca122018-06-20 18:16:48 +0200470 }
471
472 return( 1 );
473
474exit:
475 psa_cipher_abort( &operation );
476 return( 0 );
477}
478
Gilles Peskinebdf309c2018-12-03 15:36:32 +0100479static int exercise_aead_key( psa_key_handle_t handle,
Gilles Peskine818ca122018-06-20 18:16:48 +0200480 psa_key_usage_t usage,
481 psa_algorithm_t alg )
482{
483 unsigned char nonce[16] = {0};
484 size_t nonce_length = sizeof( nonce );
485 unsigned char plaintext[16] = "Hello, world...";
486 unsigned char ciphertext[48] = "(wabblewebblewibblewobblewubble)";
487 size_t ciphertext_length = sizeof( ciphertext );
488 size_t plaintext_length = sizeof( ciphertext );
489
490 if( usage & PSA_KEY_USAGE_ENCRYPT )
491 {
Gilles Peskine8817f612018-12-18 00:18:46 +0100492 PSA_ASSERT( psa_aead_encrypt( handle, alg,
493 nonce, nonce_length,
494 NULL, 0,
495 plaintext, sizeof( plaintext ),
496 ciphertext, sizeof( ciphertext ),
497 &ciphertext_length ) );
Gilles Peskine818ca122018-06-20 18:16:48 +0200498 }
499
500 if( usage & PSA_KEY_USAGE_DECRYPT )
501 {
502 psa_status_t verify_status =
503 ( usage & PSA_KEY_USAGE_ENCRYPT ?
504 PSA_SUCCESS :
505 PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskinefe11b722018-12-18 00:24:04 +0100506 TEST_EQUAL( psa_aead_decrypt( handle, alg,
507 nonce, nonce_length,
508 NULL, 0,
509 ciphertext, ciphertext_length,
510 plaintext, sizeof( plaintext ),
Gilles Peskinef812dcf2018-12-18 00:33:25 +0100511 &plaintext_length ),
512 verify_status );
Gilles Peskine818ca122018-06-20 18:16:48 +0200513 }
514
515 return( 1 );
516
517exit:
518 return( 0 );
519}
520
Gilles Peskinebdf309c2018-12-03 15:36:32 +0100521static int exercise_signature_key( psa_key_handle_t handle,
Gilles Peskine818ca122018-06-20 18:16:48 +0200522 psa_key_usage_t usage,
523 psa_algorithm_t alg )
524{
Gilles Peskinef969b3a2018-06-30 00:20:25 +0200525 unsigned char payload[PSA_HASH_MAX_SIZE] = {1};
526 size_t payload_length = 16;
Gilles Peskine89d8c5c2019-11-26 17:01:59 +0100527 unsigned char signature[PSA_SIGNATURE_MAX_SIZE] = {0};
Gilles Peskine818ca122018-06-20 18:16:48 +0200528 size_t signature_length = sizeof( signature );
Gilles Peskine57ab7212019-01-28 13:03:09 +0100529 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
530
531 /* If the policy allows signing with any hash, just pick one. */
532 if( PSA_ALG_IS_HASH_AND_SIGN( alg ) && hash_alg == PSA_ALG_ANY_HASH )
533 {
Gilles Peskinef426e0f2019-02-25 17:42:03 +0100534#if defined(KNOWN_SUPPORTED_HASH_ALG)
535 hash_alg = KNOWN_SUPPORTED_HASH_ALG;
536 alg ^= PSA_ALG_ANY_HASH ^ hash_alg;
Gilles Peskine57ab7212019-01-28 13:03:09 +0100537#else
538 test_fail( "No hash algorithm for hash-and-sign testing", __LINE__, __FILE__ );
Gilles Peskinef426e0f2019-02-25 17:42:03 +0100539 return( 1 );
Gilles Peskine57ab7212019-01-28 13:03:09 +0100540#endif
Gilles Peskine57ab7212019-01-28 13:03:09 +0100541 }
Gilles Peskine818ca122018-06-20 18:16:48 +0200542
Gilles Peskine89d8c5c2019-11-26 17:01:59 +0100543 if( usage & PSA_KEY_USAGE_SIGN_HASH )
Gilles Peskine818ca122018-06-20 18:16:48 +0200544 {
Gilles Peskinef969b3a2018-06-30 00:20:25 +0200545 /* Some algorithms require the payload to have the size of
546 * the hash encoded in the algorithm. Use this input size
547 * even for algorithms that allow other input sizes. */
Gilles Peskinef969b3a2018-06-30 00:20:25 +0200548 if( hash_alg != 0 )
549 payload_length = PSA_HASH_SIZE( hash_alg );
Gilles Peskine89d8c5c2019-11-26 17:01:59 +0100550 PSA_ASSERT( psa_sign_hash( handle, alg,
551 payload, payload_length,
552 signature, sizeof( signature ),
553 &signature_length ) );
Gilles Peskine818ca122018-06-20 18:16:48 +0200554 }
555
Gilles Peskine89d8c5c2019-11-26 17:01:59 +0100556 if( usage & PSA_KEY_USAGE_VERIFY_HASH )
Gilles Peskine818ca122018-06-20 18:16:48 +0200557 {
558 psa_status_t verify_status =
Gilles Peskine89d8c5c2019-11-26 17:01:59 +0100559 ( usage & PSA_KEY_USAGE_SIGN_HASH ?
Gilles Peskine818ca122018-06-20 18:16:48 +0200560 PSA_SUCCESS :
561 PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine89d8c5c2019-11-26 17:01:59 +0100562 TEST_EQUAL( psa_verify_hash( handle, alg,
563 payload, payload_length,
564 signature, signature_length ),
Gilles Peskinefe11b722018-12-18 00:24:04 +0100565 verify_status );
Gilles Peskine818ca122018-06-20 18:16:48 +0200566 }
567
568 return( 1 );
569
570exit:
571 return( 0 );
572}
573
Gilles Peskinebdf309c2018-12-03 15:36:32 +0100574static int exercise_asymmetric_encryption_key( psa_key_handle_t handle,
Gilles Peskine818ca122018-06-20 18:16:48 +0200575 psa_key_usage_t usage,
576 psa_algorithm_t alg )
577{
578 unsigned char plaintext[256] = "Hello, world...";
579 unsigned char ciphertext[256] = "(wabblewebblewibblewobblewubble)";
580 size_t ciphertext_length = sizeof( ciphertext );
581 size_t plaintext_length = 16;
582
583 if( usage & PSA_KEY_USAGE_ENCRYPT )
584 {
Gilles Peskinef812dcf2018-12-18 00:33:25 +0100585 PSA_ASSERT( psa_asymmetric_encrypt( handle, alg,
586 plaintext, plaintext_length,
587 NULL, 0,
588 ciphertext, sizeof( ciphertext ),
589 &ciphertext_length ) );
Gilles Peskine818ca122018-06-20 18:16:48 +0200590 }
591
592 if( usage & PSA_KEY_USAGE_DECRYPT )
593 {
594 psa_status_t status =
Gilles Peskinebdf309c2018-12-03 15:36:32 +0100595 psa_asymmetric_decrypt( handle, alg,
Gilles Peskine818ca122018-06-20 18:16:48 +0200596 ciphertext, ciphertext_length,
597 NULL, 0,
598 plaintext, sizeof( plaintext ),
599 &plaintext_length );
600 TEST_ASSERT( status == PSA_SUCCESS ||
601 ( ( usage & PSA_KEY_USAGE_ENCRYPT ) == 0 &&
602 ( status == PSA_ERROR_INVALID_ARGUMENT ||
603 status == PSA_ERROR_INVALID_PADDING ) ) );
604 }
605
606 return( 1 );
607
608exit:
609 return( 0 );
610}
Gilles Peskine02b75072018-07-01 22:31:34 +0200611
Janos Follathf2815ea2019-07-03 12:41:36 +0100612static int setup_key_derivation_wrap( psa_key_derivation_operation_t* operation,
613 psa_key_handle_t handle,
614 psa_algorithm_t alg,
615 unsigned char* input1, size_t input1_length,
616 unsigned char* input2, size_t input2_length,
617 size_t capacity )
618{
619 PSA_ASSERT( psa_key_derivation_setup( operation, alg ) );
620 if( PSA_ALG_IS_HKDF( alg ) )
621 {
622 PSA_ASSERT( psa_key_derivation_input_bytes( operation,
623 PSA_KEY_DERIVATION_INPUT_SALT,
624 input1, input1_length ) );
625 PSA_ASSERT( psa_key_derivation_input_key( operation,
626 PSA_KEY_DERIVATION_INPUT_SECRET,
627 handle ) );
628 PSA_ASSERT( psa_key_derivation_input_bytes( operation,
629 PSA_KEY_DERIVATION_INPUT_INFO,
630 input2,
631 input2_length ) );
632 }
633 else if( PSA_ALG_IS_TLS12_PRF( alg ) ||
634 PSA_ALG_IS_TLS12_PSK_TO_MS( alg ) )
635 {
636 PSA_ASSERT( psa_key_derivation_input_bytes( operation,
637 PSA_KEY_DERIVATION_INPUT_SEED,
638 input1, input1_length ) );
639 PSA_ASSERT( psa_key_derivation_input_key( operation,
640 PSA_KEY_DERIVATION_INPUT_SECRET,
641 handle ) );
642 PSA_ASSERT( psa_key_derivation_input_bytes( operation,
643 PSA_KEY_DERIVATION_INPUT_LABEL,
644 input2, input2_length ) );
645 }
646 else
647 {
648 TEST_ASSERT( ! "Key derivation algorithm not supported" );
649 }
650
Gilles Peskinec744d992019-07-30 17:26:54 +0200651 if( capacity != SIZE_MAX )
652 PSA_ASSERT( psa_key_derivation_set_capacity( operation, capacity ) );
Janos Follathf2815ea2019-07-03 12:41:36 +0100653
654 return( 1 );
655
656exit:
657 return( 0 );
658}
659
660
Gilles Peskinebdf309c2018-12-03 15:36:32 +0100661static int exercise_key_derivation_key( psa_key_handle_t handle,
Gilles Peskineea0fb492018-07-12 17:17:20 +0200662 psa_key_usage_t usage,
663 psa_algorithm_t alg )
664{
Gilles Peskine51ae0e42019-05-16 17:31:03 +0200665 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Janos Follathf2815ea2019-07-03 12:41:36 +0100666 unsigned char input1[] = "Input 1";
667 size_t input1_length = sizeof( input1 );
668 unsigned char input2[] = "Input 2";
669 size_t input2_length = sizeof( input2 );
Gilles Peskineea0fb492018-07-12 17:17:20 +0200670 unsigned char output[1];
Janos Follathf2815ea2019-07-03 12:41:36 +0100671 size_t capacity = sizeof( output );
Gilles Peskineea0fb492018-07-12 17:17:20 +0200672
673 if( usage & PSA_KEY_USAGE_DERIVE )
674 {
Janos Follathf2815ea2019-07-03 12:41:36 +0100675 if( !setup_key_derivation_wrap( &operation, handle, alg,
676 input1, input1_length,
677 input2, input2_length, capacity ) )
678 goto exit;
Gilles Peskine7607cd62019-05-29 17:35:00 +0200679
Gilles Peskine51ae0e42019-05-16 17:31:03 +0200680 PSA_ASSERT( psa_key_derivation_output_bytes( &operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +0200681 output,
Janos Follathf2815ea2019-07-03 12:41:36 +0100682 capacity ) );
Gilles Peskine51ae0e42019-05-16 17:31:03 +0200683 PSA_ASSERT( psa_key_derivation_abort( &operation ) );
Gilles Peskineea0fb492018-07-12 17:17:20 +0200684 }
685
686 return( 1 );
687
688exit:
689 return( 0 );
690}
691
Gilles Peskinec7998b72018-11-07 18:45:02 +0100692/* We need two keys to exercise key agreement. Exercise the
693 * private key against its own public key. */
Gilles Peskinecf7292e2019-05-16 17:53:40 +0200694static psa_status_t key_agreement_with_self(
695 psa_key_derivation_operation_t *operation,
696 psa_key_handle_t handle )
Gilles Peskinec7998b72018-11-07 18:45:02 +0100697{
698 psa_key_type_t private_key_type;
699 psa_key_type_t public_key_type;
700 size_t key_bits;
701 uint8_t *public_key = NULL;
702 size_t public_key_length;
David Saadab4ecc272019-02-14 13:48:10 +0200703 /* Return GENERIC_ERROR if something other than the final call to
Gilles Peskinecf7292e2019-05-16 17:53:40 +0200704 * psa_key_derivation_key_agreement fails. This isn't fully satisfactory,
705 * but it's good enough: callers will report it as a failed test anyway. */
David Saadab4ecc272019-02-14 13:48:10 +0200706 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +0200707 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskinec7998b72018-11-07 18:45:02 +0100708
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +0200709 PSA_ASSERT( psa_get_key_attributes( handle, &attributes ) );
710 private_key_type = psa_get_key_type( &attributes );
711 key_bits = psa_get_key_bits( &attributes );
Gilles Peskinec93b80c2019-05-16 19:39:54 +0200712 public_key_type = PSA_KEY_TYPE_PUBLIC_KEY_OF_KEY_PAIR( private_key_type );
Gilles Peskinec7998b72018-11-07 18:45:02 +0100713 public_key_length = PSA_KEY_EXPORT_MAX_SIZE( public_key_type, key_bits );
714 ASSERT_ALLOC( public_key, public_key_length );
Gilles Peskine8817f612018-12-18 00:18:46 +0100715 PSA_ASSERT( psa_export_public_key( handle,
716 public_key, public_key_length,
717 &public_key_length ) );
Gilles Peskinec7998b72018-11-07 18:45:02 +0100718
Gilles Peskinecf7292e2019-05-16 17:53:40 +0200719 status = psa_key_derivation_key_agreement(
720 operation, PSA_KEY_DERIVATION_INPUT_SECRET, handle,
721 public_key, public_key_length );
Gilles Peskinec7998b72018-11-07 18:45:02 +0100722exit:
723 mbedtls_free( public_key );
Gilles Peskinea1ace9c2019-04-26 16:03:33 +0200724 psa_reset_key_attributes( &attributes );
Gilles Peskinec7998b72018-11-07 18:45:02 +0100725 return( status );
726}
727
Gilles Peskine2e46e9c2019-04-11 21:24:55 +0200728/* We need two keys to exercise key agreement. Exercise the
729 * private key against its own public key. */
730static psa_status_t raw_key_agreement_with_self( psa_algorithm_t alg,
731 psa_key_handle_t handle )
732{
733 psa_key_type_t private_key_type;
734 psa_key_type_t public_key_type;
735 size_t key_bits;
736 uint8_t *public_key = NULL;
737 size_t public_key_length;
738 uint8_t output[1024];
739 size_t output_length;
740 /* Return GENERIC_ERROR if something other than the final call to
Gilles Peskinecf7292e2019-05-16 17:53:40 +0200741 * psa_key_derivation_key_agreement fails. This isn't fully satisfactory,
742 * but it's good enough: callers will report it as a failed test anyway. */
Gilles Peskine2e46e9c2019-04-11 21:24:55 +0200743 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +0200744 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine2e46e9c2019-04-11 21:24:55 +0200745
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +0200746 PSA_ASSERT( psa_get_key_attributes( handle, &attributes ) );
747 private_key_type = psa_get_key_type( &attributes );
748 key_bits = psa_get_key_bits( &attributes );
Gilles Peskinec93b80c2019-05-16 19:39:54 +0200749 public_key_type = PSA_KEY_TYPE_PUBLIC_KEY_OF_KEY_PAIR( private_key_type );
Gilles Peskine2e46e9c2019-04-11 21:24:55 +0200750 public_key_length = PSA_KEY_EXPORT_MAX_SIZE( public_key_type, key_bits );
751 ASSERT_ALLOC( public_key, public_key_length );
752 PSA_ASSERT( psa_export_public_key( handle,
753 public_key, public_key_length,
754 &public_key_length ) );
755
Gilles Peskinebe697d82019-05-16 18:00:41 +0200756 status = psa_raw_key_agreement( alg, handle,
757 public_key, public_key_length,
758 output, sizeof( output ), &output_length );
Gilles Peskine2e46e9c2019-04-11 21:24:55 +0200759exit:
760 mbedtls_free( public_key );
Gilles Peskinea1ace9c2019-04-26 16:03:33 +0200761 psa_reset_key_attributes( &attributes );
Gilles Peskine2e46e9c2019-04-11 21:24:55 +0200762 return( status );
763}
764
765static int exercise_raw_key_agreement_key( psa_key_handle_t handle,
766 psa_key_usage_t usage,
767 psa_algorithm_t alg )
768{
769 int ok = 0;
770
771 if( usage & PSA_KEY_USAGE_DERIVE )
772 {
773 /* We need two keys to exercise key agreement. Exercise the
774 * private key against its own public key. */
775 PSA_ASSERT( raw_key_agreement_with_self( alg, handle ) );
776 }
777 ok = 1;
778
779exit:
780 return( ok );
781}
782
Gilles Peskinebdf309c2018-12-03 15:36:32 +0100783static int exercise_key_agreement_key( psa_key_handle_t handle,
Gilles Peskine01d718c2018-09-18 12:01:02 +0200784 psa_key_usage_t usage,
785 psa_algorithm_t alg )
786{
Gilles Peskine51ae0e42019-05-16 17:31:03 +0200787 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Gilles Peskine01d718c2018-09-18 12:01:02 +0200788 unsigned char output[1];
789 int ok = 0;
790
791 if( usage & PSA_KEY_USAGE_DERIVE )
792 {
793 /* We need two keys to exercise key agreement. Exercise the
794 * private key against its own public key. */
Gilles Peskine51ae0e42019-05-16 17:31:03 +0200795 PSA_ASSERT( psa_key_derivation_setup( &operation, alg ) );
796 PSA_ASSERT( key_agreement_with_self( &operation, handle ) );
797 PSA_ASSERT( psa_key_derivation_output_bytes( &operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +0200798 output,
799 sizeof( output ) ) );
Gilles Peskine51ae0e42019-05-16 17:31:03 +0200800 PSA_ASSERT( psa_key_derivation_abort( &operation ) );
Gilles Peskine01d718c2018-09-18 12:01:02 +0200801 }
802 ok = 1;
803
804exit:
Gilles Peskine01d718c2018-09-18 12:01:02 +0200805 return( ok );
806}
807
Jaeden Amerof7dca862019-06-27 17:31:33 +0100808int asn1_skip_integer( unsigned char **p, const unsigned char *end,
809 size_t min_bits, size_t max_bits,
810 int must_be_odd )
Gilles Peskinedd2f95b2018-08-11 01:22:42 +0200811{
812 size_t len;
813 size_t actual_bits;
814 unsigned char msb;
Gilles Peskinefe11b722018-12-18 00:24:04 +0100815 TEST_EQUAL( mbedtls_asn1_get_tag( p, end, &len,
Gilles Peskinef812dcf2018-12-18 00:33:25 +0100816 MBEDTLS_ASN1_INTEGER ),
817 0 );
k-stachowiak9b88efc2019-09-13 15:26:53 +0200818
819 /* Check if the retrieved length doesn't extend the actual buffer's size.
820 * It is assumed here, that end >= p, which validates casting to size_t. */
821 TEST_ASSERT( len <= (size_t)( end - *p) );
822
Gilles Peskinedd2f95b2018-08-11 01:22:42 +0200823 /* Tolerate a slight departure from DER encoding:
824 * - 0 may be represented by an empty string or a 1-byte string.
825 * - The sign bit may be used as a value bit. */
826 if( ( len == 1 && ( *p )[0] == 0 ) ||
827 ( len > 1 && ( *p )[0] == 0 && ( ( *p )[1] & 0x80 ) != 0 ) )
828 {
829 ++( *p );
830 --len;
831 }
832 if( min_bits == 0 && len == 0 )
833 return( 1 );
834 msb = ( *p )[0];
835 TEST_ASSERT( msb != 0 );
836 actual_bits = 8 * ( len - 1 );
837 while( msb != 0 )
838 {
839 msb >>= 1;
840 ++actual_bits;
841 }
842 TEST_ASSERT( actual_bits >= min_bits );
843 TEST_ASSERT( actual_bits <= max_bits );
844 if( must_be_odd )
845 TEST_ASSERT( ( ( *p )[len-1] & 1 ) != 0 );
846 *p += len;
847 return( 1 );
848exit:
849 return( 0 );
850}
851
Gilles Peskinedd2f95b2018-08-11 01:22:42 +0200852static int exported_key_sanity_check( psa_key_type_t type, size_t bits,
853 uint8_t *exported, size_t exported_length )
854{
855 if( PSA_KEY_TYPE_IS_UNSTRUCTURED( type ) )
Gilles Peskinefe11b722018-12-18 00:24:04 +0100856 TEST_EQUAL( exported_length, ( bits + 7 ) / 8 );
Gilles Peskinedd2f95b2018-08-11 01:22:42 +0200857 else
858 TEST_ASSERT( exported_length <= PSA_KEY_EXPORT_MAX_SIZE( type, bits ) );
Gilles Peskined14664a2018-08-10 19:07:32 +0200859
860#if defined(MBEDTLS_DES_C)
861 if( type == PSA_KEY_TYPE_DES )
862 {
863 /* Check the parity bits. */
864 unsigned i;
865 for( i = 0; i < bits / 8; i++ )
866 {
867 unsigned bit_count = 0;
868 unsigned m;
869 for( m = 1; m <= 0x100; m <<= 1 )
870 {
871 if( exported[i] & m )
872 ++bit_count;
873 }
874 TEST_ASSERT( bit_count % 2 != 0 );
875 }
876 }
Gilles Peskinedd2f95b2018-08-11 01:22:42 +0200877 else
Gilles Peskined14664a2018-08-10 19:07:32 +0200878#endif
879
880#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PK_PARSE_C)
Gilles Peskinec93b80c2019-05-16 19:39:54 +0200881 if( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskined14664a2018-08-10 19:07:32 +0200882 {
Gilles Peskinedd2f95b2018-08-11 01:22:42 +0200883 uint8_t *p = exported;
884 uint8_t *end = exported + exported_length;
885 size_t len;
886 /* RSAPrivateKey ::= SEQUENCE {
Gilles Peskinedea46cf2018-08-21 16:12:54 +0200887 * version INTEGER, -- must be 0
Gilles Peskinedd2f95b2018-08-11 01:22:42 +0200888 * modulus INTEGER, -- n
889 * publicExponent INTEGER, -- e
890 * privateExponent INTEGER, -- d
891 * prime1 INTEGER, -- p
892 * prime2 INTEGER, -- q
893 * exponent1 INTEGER, -- d mod (p-1)
894 * exponent2 INTEGER, -- d mod (q-1)
895 * coefficient INTEGER, -- (inverse of q) mod p
896 * }
897 */
Gilles Peskinefe11b722018-12-18 00:24:04 +0100898 TEST_EQUAL( mbedtls_asn1_get_tag( &p, end, &len,
899 MBEDTLS_ASN1_SEQUENCE |
900 MBEDTLS_ASN1_CONSTRUCTED ), 0 );
901 TEST_EQUAL( p + len, end );
Gilles Peskinedd2f95b2018-08-11 01:22:42 +0200902 if( ! asn1_skip_integer( &p, end, 0, 0, 0 ) )
903 goto exit;
904 if( ! asn1_skip_integer( &p, end, bits, bits, 1 ) )
905 goto exit;
906 if( ! asn1_skip_integer( &p, end, 2, bits, 1 ) )
907 goto exit;
908 /* Require d to be at least half the size of n. */
909 if( ! asn1_skip_integer( &p, end, bits / 2, bits, 1 ) )
910 goto exit;
911 /* Require p and q to be at most half the size of n, rounded up. */
912 if( ! asn1_skip_integer( &p, end, bits / 2, bits / 2 + 1, 1 ) )
913 goto exit;
914 if( ! asn1_skip_integer( &p, end, bits / 2, bits / 2 + 1, 1 ) )
915 goto exit;
916 if( ! asn1_skip_integer( &p, end, 1, bits / 2 + 1, 0 ) )
917 goto exit;
918 if( ! asn1_skip_integer( &p, end, 1, bits / 2 + 1, 0 ) )
919 goto exit;
920 if( ! asn1_skip_integer( &p, end, 1, bits / 2 + 1, 0 ) )
921 goto exit;
Gilles Peskinefe11b722018-12-18 00:24:04 +0100922 TEST_EQUAL( p, end );
Gilles Peskine0f915f12018-12-17 23:35:42 +0100923 }
Gilles Peskinedd2f95b2018-08-11 01:22:42 +0200924 else
Gilles Peskined14664a2018-08-10 19:07:32 +0200925#endif /* MBEDTLS_RSA_C */
926
927#if defined(MBEDTLS_ECP_C)
Gilles Peskinec93b80c2019-05-16 19:39:54 +0200928 if( PSA_KEY_TYPE_IS_ECC_KEY_PAIR( type ) )
Gilles Peskined14664a2018-08-10 19:07:32 +0200929 {
Gilles Peskine5b802a32018-10-29 19:21:41 +0100930 /* Just the secret value */
Gilles Peskinefe11b722018-12-18 00:24:04 +0100931 TEST_EQUAL( exported_length, PSA_BITS_TO_BYTES( bits ) );
Gilles Peskine5b802a32018-10-29 19:21:41 +0100932 }
Gilles Peskinedd2f95b2018-08-11 01:22:42 +0200933 else
Gilles Peskined14664a2018-08-10 19:07:32 +0200934#endif /* MBEDTLS_ECP_C */
935
Gilles Peskinedd2f95b2018-08-11 01:22:42 +0200936 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) )
937 {
938 uint8_t *p = exported;
939 uint8_t *end = exported + exported_length;
Gilles Peskinedd2f95b2018-08-11 01:22:42 +0200940#if defined(MBEDTLS_RSA_C)
941 if( type == PSA_KEY_TYPE_RSA_PUBLIC_KEY )
942 {
Jaeden Amerof7dca862019-06-27 17:31:33 +0100943 size_t len;
Gilles Peskinedd2f95b2018-08-11 01:22:42 +0200944 /* RSAPublicKey ::= SEQUENCE {
945 * modulus INTEGER, -- n
946 * publicExponent INTEGER } -- e
947 */
Gilles Peskinefe11b722018-12-18 00:24:04 +0100948 TEST_EQUAL( mbedtls_asn1_get_tag( &p, end, &len,
949 MBEDTLS_ASN1_SEQUENCE |
Gilles Peskinef812dcf2018-12-18 00:33:25 +0100950 MBEDTLS_ASN1_CONSTRUCTED ),
951 0 );
Gilles Peskinefe11b722018-12-18 00:24:04 +0100952 TEST_EQUAL( p + len, end );
Gilles Peskinedd2f95b2018-08-11 01:22:42 +0200953 if( ! asn1_skip_integer( &p, end, bits, bits, 1 ) )
954 goto exit;
955 if( ! asn1_skip_integer( &p, end, 2, bits, 1 ) )
956 goto exit;
Gilles Peskinefe11b722018-12-18 00:24:04 +0100957 TEST_EQUAL( p, end );
Gilles Peskinedd2f95b2018-08-11 01:22:42 +0200958 }
959 else
960#endif /* MBEDTLS_RSA_C */
961#if defined(MBEDTLS_ECP_C)
962 if( PSA_KEY_TYPE_IS_ECC_PUBLIC_KEY( type ) )
963 {
Steven Cooreman3fa684e2020-07-30 15:04:07 +0200964 if( PSA_KEY_TYPE_ECC_GET_FAMILY( type ) == PSA_ECC_FAMILY_MONTGOMERY )
965 {
966 /* The representation of an ECC Montgomery public key is
967 * the raw compressed point */
968 TEST_EQUAL( p + PSA_BITS_TO_BYTES( bits ), end );
969 }
970 else
971 {
972 /* The representation of an ECC Weierstrass public key is:
973 * - The byte 0x04;
974 * - `x_P` as a `ceiling(m/8)`-byte string, big-endian;
975 * - `y_P` as a `ceiling(m/8)`-byte string, big-endian;
976 * - where m is the bit size associated with the curve.
977 */
978 TEST_EQUAL( p + 1 + 2 * PSA_BITS_TO_BYTES( bits ), end );
979 TEST_EQUAL( p[0], 4 );
980 }
Gilles Peskinedd2f95b2018-08-11 01:22:42 +0200981 }
982 else
983#endif /* MBEDTLS_ECP_C */
984 {
Jaeden Amero594a3302018-10-26 17:07:22 +0100985 char message[47];
Gilles Peskinedd2f95b2018-08-11 01:22:42 +0200986 mbedtls_snprintf( message, sizeof( message ),
987 "No sanity check for public key type=0x%08lx",
988 (unsigned long) type );
989 test_fail( message, __LINE__, __FILE__ );
Gilles Peskineb16841e2019-10-10 20:36:12 +0200990 (void) p;
991 (void) end;
Gilles Peskinedd2f95b2018-08-11 01:22:42 +0200992 return( 0 );
993 }
994 }
995 else
996
997 {
998 /* No sanity checks for other types */
999 }
1000
1001 return( 1 );
Gilles Peskined14664a2018-08-10 19:07:32 +02001002
1003exit:
Gilles Peskinedd2f95b2018-08-11 01:22:42 +02001004 return( 0 );
Gilles Peskined14664a2018-08-10 19:07:32 +02001005}
1006
Gilles Peskinebdf309c2018-12-03 15:36:32 +01001007static int exercise_export_key( psa_key_handle_t handle,
Gilles Peskined14664a2018-08-10 19:07:32 +02001008 psa_key_usage_t usage )
1009{
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001010 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskined14664a2018-08-10 19:07:32 +02001011 uint8_t *exported = NULL;
1012 size_t exported_size = 0;
1013 size_t exported_length = 0;
1014 int ok = 0;
1015
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001016 PSA_ASSERT( psa_get_key_attributes( handle, &attributes ) );
Gilles Peskineacec7b6f2018-09-13 20:34:11 +02001017
1018 if( ( usage & PSA_KEY_USAGE_EXPORT ) == 0 &&
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001019 ! PSA_KEY_TYPE_IS_PUBLIC_KEY( psa_get_key_type( &attributes ) ) )
Gilles Peskined14664a2018-08-10 19:07:32 +02001020 {
Gilles Peskinefe11b722018-12-18 00:24:04 +01001021 TEST_EQUAL( psa_export_key( handle, NULL, 0, &exported_length ),
1022 PSA_ERROR_NOT_PERMITTED );
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02001023 ok = 1;
1024 goto exit;
Gilles Peskined14664a2018-08-10 19:07:32 +02001025 }
1026
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001027 exported_size = PSA_KEY_EXPORT_MAX_SIZE( psa_get_key_type( &attributes ),
1028 psa_get_key_bits( &attributes ) );
Gilles Peskine8cebbba2018-09-27 13:54:18 +02001029 ASSERT_ALLOC( exported, exported_size );
Gilles Peskined14664a2018-08-10 19:07:32 +02001030
Gilles Peskine8817f612018-12-18 00:18:46 +01001031 PSA_ASSERT( psa_export_key( handle,
1032 exported, exported_size,
1033 &exported_length ) );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001034 ok = exported_key_sanity_check( psa_get_key_type( &attributes ),
1035 psa_get_key_bits( &attributes ),
1036 exported, exported_length );
Gilles Peskined14664a2018-08-10 19:07:32 +02001037
1038exit:
1039 mbedtls_free( exported );
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02001040 psa_reset_key_attributes( &attributes );
Gilles Peskined14664a2018-08-10 19:07:32 +02001041 return( ok );
1042}
1043
Gilles Peskinebdf309c2018-12-03 15:36:32 +01001044static int exercise_export_public_key( psa_key_handle_t handle )
Gilles Peskined14664a2018-08-10 19:07:32 +02001045{
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001046 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskined14664a2018-08-10 19:07:32 +02001047 psa_key_type_t public_type;
Gilles Peskined14664a2018-08-10 19:07:32 +02001048 uint8_t *exported = NULL;
1049 size_t exported_size = 0;
1050 size_t exported_length = 0;
1051 int ok = 0;
1052
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001053 PSA_ASSERT( psa_get_key_attributes( handle, &attributes ) );
1054 if( ! PSA_KEY_TYPE_IS_ASYMMETRIC( psa_get_key_type( &attributes ) ) )
Gilles Peskined14664a2018-08-10 19:07:32 +02001055 {
Gilles Peskinef812dcf2018-12-18 00:33:25 +01001056 TEST_EQUAL( psa_export_public_key( handle, NULL, 0, &exported_length ),
Gilles Peskinefe11b722018-12-18 00:24:04 +01001057 PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskined14664a2018-08-10 19:07:32 +02001058 return( 1 );
1059 }
1060
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001061 public_type = PSA_KEY_TYPE_PUBLIC_KEY_OF_KEY_PAIR(
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001062 psa_get_key_type( &attributes ) );
1063 exported_size = PSA_KEY_EXPORT_MAX_SIZE( public_type,
1064 psa_get_key_bits( &attributes ) );
Gilles Peskine8cebbba2018-09-27 13:54:18 +02001065 ASSERT_ALLOC( exported, exported_size );
Gilles Peskined14664a2018-08-10 19:07:32 +02001066
Gilles Peskine8817f612018-12-18 00:18:46 +01001067 PSA_ASSERT( psa_export_public_key( handle,
1068 exported, exported_size,
1069 &exported_length ) );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001070 ok = exported_key_sanity_check( public_type,
1071 psa_get_key_bits( &attributes ),
Gilles Peskined14664a2018-08-10 19:07:32 +02001072 exported, exported_length );
1073
1074exit:
1075 mbedtls_free( exported );
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02001076 psa_reset_key_attributes( &attributes );
Gilles Peskined14664a2018-08-10 19:07:32 +02001077 return( ok );
1078}
1079
Gilles Peskinec9516fb2019-02-05 20:32:06 +01001080/** Do smoke tests on a key.
1081 *
1082 * Perform one of each operation indicated by \p alg (decrypt/encrypt,
1083 * sign/verify, or derivation) that is permitted according to \p usage.
1084 * \p usage and \p alg should correspond to the expected policy on the
1085 * key.
1086 *
1087 * Export the key if permitted by \p usage, and check that the output
1088 * looks sensible. If \p usage forbids export, check that
1089 * \p psa_export_key correctly rejects the attempt. If the key is
1090 * asymmetric, also check \p psa_export_public_key.
1091 *
1092 * If the key fails the tests, this function calls the test framework's
1093 * `test_fail` function and returns false. Otherwise this function returns
1094 * true. Therefore it should be used as follows:
1095 * ```
1096 * if( ! exercise_key( ... ) ) goto exit;
1097 * ```
1098 *
1099 * \param handle The key to exercise. It should be capable of performing
1100 * \p alg.
1101 * \param usage The usage flags to assume.
1102 * \param alg The algorithm to exercise.
1103 *
1104 * \retval 0 The key failed the smoke tests.
1105 * \retval 1 The key passed the smoke tests.
1106 */
Gilles Peskinebdf309c2018-12-03 15:36:32 +01001107static int exercise_key( psa_key_handle_t handle,
Gilles Peskine02b75072018-07-01 22:31:34 +02001108 psa_key_usage_t usage,
1109 psa_algorithm_t alg )
1110{
1111 int ok;
Gilles Peskine667c1112019-12-03 19:03:20 +01001112
1113 if( ! check_key_attributes_sanity( handle ) )
1114 return( 0 );
1115
Gilles Peskine02b75072018-07-01 22:31:34 +02001116 if( alg == 0 )
1117 ok = 1; /* If no algorihm, do nothing (used for raw data "keys"). */
1118 else if( PSA_ALG_IS_MAC( alg ) )
Gilles Peskinebdf309c2018-12-03 15:36:32 +01001119 ok = exercise_mac_key( handle, usage, alg );
Gilles Peskine02b75072018-07-01 22:31:34 +02001120 else if( PSA_ALG_IS_CIPHER( alg ) )
Gilles Peskinebdf309c2018-12-03 15:36:32 +01001121 ok = exercise_cipher_key( handle, usage, alg );
Gilles Peskine02b75072018-07-01 22:31:34 +02001122 else if( PSA_ALG_IS_AEAD( alg ) )
Gilles Peskinebdf309c2018-12-03 15:36:32 +01001123 ok = exercise_aead_key( handle, usage, alg );
Gilles Peskine02b75072018-07-01 22:31:34 +02001124 else if( PSA_ALG_IS_SIGN( alg ) )
Gilles Peskinebdf309c2018-12-03 15:36:32 +01001125 ok = exercise_signature_key( handle, usage, alg );
Gilles Peskine02b75072018-07-01 22:31:34 +02001126 else if( PSA_ALG_IS_ASYMMETRIC_ENCRYPTION( alg ) )
Gilles Peskinebdf309c2018-12-03 15:36:32 +01001127 ok = exercise_asymmetric_encryption_key( handle, usage, alg );
Gilles Peskineea0fb492018-07-12 17:17:20 +02001128 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
Gilles Peskinebdf309c2018-12-03 15:36:32 +01001129 ok = exercise_key_derivation_key( handle, usage, alg );
Gilles Peskine2e46e9c2019-04-11 21:24:55 +02001130 else if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
1131 ok = exercise_raw_key_agreement_key( handle, usage, alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02001132 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskinebdf309c2018-12-03 15:36:32 +01001133 ok = exercise_key_agreement_key( handle, usage, alg );
Gilles Peskine02b75072018-07-01 22:31:34 +02001134 else
1135 {
1136 char message[40];
1137 mbedtls_snprintf( message, sizeof( message ),
1138 "No code to exercise alg=0x%08lx",
1139 (unsigned long) alg );
1140 test_fail( message, __LINE__, __FILE__ );
1141 ok = 0;
1142 }
Gilles Peskined14664a2018-08-10 19:07:32 +02001143
Gilles Peskinebdf309c2018-12-03 15:36:32 +01001144 ok = ok && exercise_export_key( handle, usage );
1145 ok = ok && exercise_export_public_key( handle );
Gilles Peskined14664a2018-08-10 19:07:32 +02001146
Gilles Peskine02b75072018-07-01 22:31:34 +02001147 return( ok );
1148}
1149
Gilles Peskine10df3412018-10-25 22:35:43 +02001150static psa_key_usage_t usage_to_exercise( psa_key_type_t type,
1151 psa_algorithm_t alg )
1152{
1153 if( PSA_ALG_IS_MAC( alg ) || PSA_ALG_IS_SIGN( alg ) )
1154 {
1155 return( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) ?
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001156 PSA_KEY_USAGE_VERIFY_HASH :
1157 PSA_KEY_USAGE_SIGN_HASH | PSA_KEY_USAGE_VERIFY_HASH );
Gilles Peskine10df3412018-10-25 22:35:43 +02001158 }
1159 else if( PSA_ALG_IS_CIPHER( alg ) || PSA_ALG_IS_AEAD( alg ) ||
1160 PSA_ALG_IS_ASYMMETRIC_ENCRYPTION( alg ) )
1161 {
1162 return( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) ?
1163 PSA_KEY_USAGE_ENCRYPT :
1164 PSA_KEY_USAGE_ENCRYPT | PSA_KEY_USAGE_DECRYPT );
1165 }
1166 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) ||
1167 PSA_ALG_IS_KEY_AGREEMENT( alg ) )
1168 {
1169 return( PSA_KEY_USAGE_DERIVE );
1170 }
1171 else
1172 {
1173 return( 0 );
1174 }
1175
1176}
Darryl Green0c6575a2018-11-07 16:05:30 +00001177
Gilles Peskine4cf3a432019-04-18 22:28:52 +02001178static int test_operations_on_invalid_handle( psa_key_handle_t handle )
1179{
1180 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
1181 uint8_t buffer[1];
1182 size_t length;
1183 int ok = 0;
1184
Gilles Peskinec87af662019-05-15 16:12:22 +02001185 psa_set_key_id( &attributes, 0x6964 );
Gilles Peskine4cf3a432019-04-18 22:28:52 +02001186 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
1187 psa_set_key_algorithm( &attributes, PSA_ALG_CTR );
1188 psa_set_key_type( &attributes, PSA_KEY_TYPE_AES );
1189 TEST_EQUAL( psa_get_key_attributes( handle, &attributes ),
1190 PSA_ERROR_INVALID_HANDLE );
1191 TEST_EQUAL( psa_get_key_id( &attributes ), 0 );
Gilles Peskine5c648ab2019-04-19 14:06:53 +02001192 TEST_EQUAL( psa_get_key_lifetime( &attributes ), 0 );
Gilles Peskine4cf3a432019-04-18 22:28:52 +02001193 TEST_EQUAL( psa_get_key_usage_flags( &attributes ), 0 );
1194 TEST_EQUAL( psa_get_key_algorithm( &attributes ), 0 );
1195 TEST_EQUAL( psa_get_key_type( &attributes ), 0 );
1196 TEST_EQUAL( psa_get_key_bits( &attributes ), 0 );
1197
1198 TEST_EQUAL( psa_export_key( handle,
1199 buffer, sizeof( buffer ), &length ),
1200 PSA_ERROR_INVALID_HANDLE );
1201 TEST_EQUAL( psa_export_public_key( handle,
1202 buffer, sizeof( buffer ), &length ),
1203 PSA_ERROR_INVALID_HANDLE );
1204
Gilles Peskine4cf3a432019-04-18 22:28:52 +02001205 ok = 1;
1206
1207exit:
1208 psa_reset_key_attributes( &attributes );
1209 return( ok );
1210}
1211
Gilles Peskine5fe5e272019-08-02 20:30:01 +02001212/* Assert that a key isn't reported as having a slot number. */
1213#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1214#define ASSERT_NO_SLOT_NUMBER( attributes ) \
1215 do \
1216 { \
1217 psa_key_slot_number_t ASSERT_NO_SLOT_NUMBER_slot_number; \
1218 TEST_EQUAL( psa_get_key_slot_number( \
1219 attributes, \
1220 &ASSERT_NO_SLOT_NUMBER_slot_number ), \
1221 PSA_ERROR_INVALID_ARGUMENT ); \
1222 } \
1223 while( 0 )
1224#else /* MBEDTLS_PSA_CRYPTO_SE_C */
1225#define ASSERT_NO_SLOT_NUMBER( attributes ) \
1226 ( (void) 0 )
1227#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1228
Gilles Peskinebdf309c2018-12-03 15:36:32 +01001229/* An overapproximation of the amount of storage needed for a key of the
1230 * given type and with the given content. The API doesn't make it easy
1231 * to find a good value for the size. The current implementation doesn't
1232 * care about the value anyway. */
1233#define KEY_BITS_FROM_DATA( type, data ) \
1234 ( data )->len
1235
Darryl Green0c6575a2018-11-07 16:05:30 +00001236typedef enum {
1237 IMPORT_KEY = 0,
1238 GENERATE_KEY = 1,
1239 DERIVE_KEY = 2
1240} generate_method;
1241
Gilles Peskinee59236f2018-01-27 23:32:46 +01001242/* END_HEADER */
1243
1244/* BEGIN_DEPENDENCIES
1245 * depends_on:MBEDTLS_PSA_CRYPTO_C
1246 * END_DEPENDENCIES
1247 */
1248
1249/* BEGIN_CASE */
Gilles Peskinee1f2d7d2018-08-21 14:54:54 +02001250void static_checks( )
1251{
1252 size_t max_truncated_mac_size =
1253 PSA_ALG_MAC_TRUNCATION_MASK >> PSA_MAC_TRUNCATION_OFFSET;
1254
1255 /* Check that the length for a truncated MAC always fits in the algorithm
1256 * encoding. The shifted mask is the maximum truncated value. The
1257 * untruncated algorithm may be one byte larger. */
1258 TEST_ASSERT( PSA_MAC_MAX_SIZE <= 1 + max_truncated_mac_size );
Gilles Peskine841b14b2019-11-26 17:37:37 +01001259
1260#if defined(MBEDTLS_TEST_DEPRECATED)
1261 /* Check deprecated constants. */
1262 TEST_EQUAL( PSA_ERROR_UNKNOWN_ERROR, PSA_ERROR_GENERIC_ERROR );
1263 TEST_EQUAL( PSA_ERROR_OCCUPIED_SLOT, PSA_ERROR_ALREADY_EXISTS );
1264 TEST_EQUAL( PSA_ERROR_EMPTY_SLOT, PSA_ERROR_DOES_NOT_EXIST );
1265 TEST_EQUAL( PSA_ERROR_INSUFFICIENT_CAPACITY, PSA_ERROR_INSUFFICIENT_DATA );
1266 TEST_EQUAL( PSA_ERROR_TAMPERING_DETECTED, PSA_ERROR_CORRUPTION_DETECTED );
1267 TEST_EQUAL( PSA_KEY_USAGE_SIGN, PSA_KEY_USAGE_SIGN_HASH );
1268 TEST_EQUAL( PSA_KEY_USAGE_VERIFY, PSA_KEY_USAGE_VERIFY_HASH );
1269 TEST_EQUAL( PSA_ASYMMETRIC_SIGNATURE_MAX_SIZE, PSA_SIGNATURE_MAX_SIZE );
Gilles Peskineb87b7192019-12-04 16:24:10 +01001270
Paul Elliott8ff510a2020-06-02 17:19:28 +01001271 TEST_EQUAL( PSA_ECC_CURVE_SECP160K1, PSA_ECC_FAMILY_SECP_K1 );
1272 TEST_EQUAL( PSA_ECC_CURVE_SECP192K1, PSA_ECC_FAMILY_SECP_K1 );
1273 TEST_EQUAL( PSA_ECC_CURVE_SECP224K1, PSA_ECC_FAMILY_SECP_K1 );
1274 TEST_EQUAL( PSA_ECC_CURVE_SECP256K1, PSA_ECC_FAMILY_SECP_K1 );
1275 TEST_EQUAL( PSA_ECC_CURVE_SECP160R1, PSA_ECC_FAMILY_SECP_R1 );
1276 TEST_EQUAL( PSA_ECC_CURVE_SECP192R1, PSA_ECC_FAMILY_SECP_R1 );
1277 TEST_EQUAL( PSA_ECC_CURVE_SECP224R1, PSA_ECC_FAMILY_SECP_R1 );
1278 TEST_EQUAL( PSA_ECC_CURVE_SECP256R1, PSA_ECC_FAMILY_SECP_R1 );
1279 TEST_EQUAL( PSA_ECC_CURVE_SECP384R1, PSA_ECC_FAMILY_SECP_R1 );
1280 TEST_EQUAL( PSA_ECC_CURVE_SECP521R1, PSA_ECC_FAMILY_SECP_R1 );
1281 TEST_EQUAL( PSA_ECC_CURVE_SECP160R2, PSA_ECC_FAMILY_SECP_R2 );
1282 TEST_EQUAL( PSA_ECC_CURVE_SECT163K1, PSA_ECC_FAMILY_SECT_K1 );
1283 TEST_EQUAL( PSA_ECC_CURVE_SECT233K1, PSA_ECC_FAMILY_SECT_K1 );
1284 TEST_EQUAL( PSA_ECC_CURVE_SECT239K1, PSA_ECC_FAMILY_SECT_K1 );
1285 TEST_EQUAL( PSA_ECC_CURVE_SECT283K1, PSA_ECC_FAMILY_SECT_K1 );
1286 TEST_EQUAL( PSA_ECC_CURVE_SECT409K1, PSA_ECC_FAMILY_SECT_K1 );
1287 TEST_EQUAL( PSA_ECC_CURVE_SECT571K1, PSA_ECC_FAMILY_SECT_K1 );
1288 TEST_EQUAL( PSA_ECC_CURVE_SECT163R1, PSA_ECC_FAMILY_SECT_R1 );
1289 TEST_EQUAL( PSA_ECC_CURVE_SECT193R1, PSA_ECC_FAMILY_SECT_R1 );
1290 TEST_EQUAL( PSA_ECC_CURVE_SECT233R1, PSA_ECC_FAMILY_SECT_R1 );
1291 TEST_EQUAL( PSA_ECC_CURVE_SECT283R1, PSA_ECC_FAMILY_SECT_R1 );
1292 TEST_EQUAL( PSA_ECC_CURVE_SECT409R1, PSA_ECC_FAMILY_SECT_R1 );
1293 TEST_EQUAL( PSA_ECC_CURVE_SECT571R1, PSA_ECC_FAMILY_SECT_R1 );
1294 TEST_EQUAL( PSA_ECC_CURVE_SECT163R2, PSA_ECC_FAMILY_SECT_R2 );
1295 TEST_EQUAL( PSA_ECC_CURVE_SECT193R2, PSA_ECC_FAMILY_SECT_R2 );
1296 TEST_EQUAL( PSA_ECC_CURVE_BRAINPOOL_P256R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1 );
1297 TEST_EQUAL( PSA_ECC_CURVE_BRAINPOOL_P384R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1 );
1298 TEST_EQUAL( PSA_ECC_CURVE_BRAINPOOL_P512R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1 );
1299 TEST_EQUAL( PSA_ECC_CURVE_CURVE25519, PSA_ECC_FAMILY_MONTGOMERY );
1300 TEST_EQUAL( PSA_ECC_CURVE_CURVE448, PSA_ECC_FAMILY_MONTGOMERY );
1301
1302 TEST_EQUAL( PSA_ECC_CURVE_SECP_K1, PSA_ECC_FAMILY_SECP_K1 );
1303 TEST_EQUAL( PSA_ECC_CURVE_SECP_R1, PSA_ECC_FAMILY_SECP_R1 );
1304 TEST_EQUAL( PSA_ECC_CURVE_SECP_R2, PSA_ECC_FAMILY_SECP_R2 );
1305 TEST_EQUAL( PSA_ECC_CURVE_SECT_K1, PSA_ECC_FAMILY_SECT_K1 );
1306 TEST_EQUAL( PSA_ECC_CURVE_SECT_R1, PSA_ECC_FAMILY_SECT_R1 );
1307 TEST_EQUAL( PSA_ECC_CURVE_SECT_R2, PSA_ECC_FAMILY_SECT_R2 );
1308 TEST_EQUAL( PSA_ECC_CURVE_BRAINPOOL_P_R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1 );
1309 TEST_EQUAL( PSA_ECC_CURVE_MONTGOMERY, PSA_ECC_FAMILY_MONTGOMERY );
Gilles Peskineb87b7192019-12-04 16:24:10 +01001310
Paul Elliott75e27032020-06-03 15:17:39 +01001311 TEST_EQUAL( PSA_DH_GROUP_FFDHE2048, PSA_DH_FAMILY_RFC7919 );
1312 TEST_EQUAL( PSA_DH_GROUP_FFDHE3072, PSA_DH_FAMILY_RFC7919 );
1313 TEST_EQUAL( PSA_DH_GROUP_FFDHE4096, PSA_DH_FAMILY_RFC7919 );
1314 TEST_EQUAL( PSA_DH_GROUP_FFDHE6144, PSA_DH_FAMILY_RFC7919 );
1315 TEST_EQUAL( PSA_DH_GROUP_FFDHE8192, PSA_DH_FAMILY_RFC7919 );
1316
1317 TEST_EQUAL( PSA_DH_GROUP_RFC7919, PSA_DH_FAMILY_RFC7919 );
1318 TEST_EQUAL( PSA_DH_GROUP_CUSTOM, PSA_DH_FAMILY_CUSTOM );
Gilles Peskineb87b7192019-12-04 16:24:10 +01001319#endif
Gilles Peskinee1f2d7d2018-08-21 14:54:54 +02001320}
1321/* END_CASE */
1322
1323/* BEGIN_CASE */
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001324void attributes_set_get( int id_arg, int lifetime_arg,
1325 int usage_flags_arg, int alg_arg,
Gilles Peskine3a4f1f82019-04-26 13:49:28 +02001326 int type_arg, int bits_arg )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001327{
Gilles Peskine4747d192019-04-17 15:05:45 +02001328 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001329 psa_key_id_t id = id_arg;
1330 psa_key_lifetime_t lifetime = lifetime_arg;
1331 psa_key_usage_t usage_flags = usage_flags_arg;
1332 psa_algorithm_t alg = alg_arg;
1333 psa_key_type_t type = type_arg;
Gilles Peskine3a4f1f82019-04-26 13:49:28 +02001334 size_t bits = bits_arg;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001335
1336 TEST_EQUAL( psa_get_key_id( &attributes ), 0 );
1337 TEST_EQUAL( psa_get_key_lifetime( &attributes ), 0 );
1338 TEST_EQUAL( psa_get_key_usage_flags( &attributes ), 0 );
1339 TEST_EQUAL( psa_get_key_algorithm( &attributes ), 0 );
1340 TEST_EQUAL( psa_get_key_type( &attributes ), 0 );
Gilles Peskine3a4f1f82019-04-26 13:49:28 +02001341 TEST_EQUAL( psa_get_key_bits( &attributes ), 0 );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001342
Gilles Peskinec87af662019-05-15 16:12:22 +02001343 psa_set_key_id( &attributes, id );
1344 psa_set_key_lifetime( &attributes, lifetime );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001345 psa_set_key_usage_flags( &attributes, usage_flags );
1346 psa_set_key_algorithm( &attributes, alg );
1347 psa_set_key_type( &attributes, type );
Gilles Peskine3a4f1f82019-04-26 13:49:28 +02001348 psa_set_key_bits( &attributes, bits );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001349
1350 TEST_EQUAL( psa_get_key_id( &attributes ), id );
1351 TEST_EQUAL( psa_get_key_lifetime( &attributes ), lifetime );
1352 TEST_EQUAL( psa_get_key_usage_flags( &attributes ), usage_flags );
1353 TEST_EQUAL( psa_get_key_algorithm( &attributes ), alg );
1354 TEST_EQUAL( psa_get_key_type( &attributes ), type );
Gilles Peskine3a4f1f82019-04-26 13:49:28 +02001355 TEST_EQUAL( psa_get_key_bits( &attributes ), bits );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001356
1357 psa_reset_key_attributes( &attributes );
1358
1359 TEST_EQUAL( psa_get_key_id( &attributes ), 0 );
1360 TEST_EQUAL( psa_get_key_lifetime( &attributes ), 0 );
1361 TEST_EQUAL( psa_get_key_usage_flags( &attributes ), 0 );
1362 TEST_EQUAL( psa_get_key_algorithm( &attributes ), 0 );
1363 TEST_EQUAL( psa_get_key_type( &attributes ), 0 );
Gilles Peskine3a4f1f82019-04-26 13:49:28 +02001364 TEST_EQUAL( psa_get_key_bits( &attributes ), 0 );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001365}
1366/* END_CASE */
1367
1368/* BEGIN_CASE */
Gilles Peskinedd835cb2019-05-15 16:14:57 +02001369void persistence_attributes( int id1_arg, int lifetime_arg, int id2_arg,
1370 int expected_id_arg, int expected_lifetime_arg )
1371{
1372 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
1373 psa_key_id_t id1 = id1_arg;
1374 psa_key_lifetime_t lifetime = lifetime_arg;
1375 psa_key_id_t id2 = id2_arg;
1376 psa_key_id_t expected_id = expected_id_arg;
1377 psa_key_lifetime_t expected_lifetime = expected_lifetime_arg;
1378
1379 if( id1_arg != -1 )
1380 psa_set_key_id( &attributes, id1 );
1381 if( lifetime_arg != -1 )
1382 psa_set_key_lifetime( &attributes, lifetime );
1383 if( id2_arg != -1 )
1384 psa_set_key_id( &attributes, id2 );
1385
1386 TEST_EQUAL( psa_get_key_id( &attributes ), expected_id );
1387 TEST_EQUAL( psa_get_key_lifetime( &attributes ), expected_lifetime );
1388}
1389/* END_CASE */
1390
Gilles Peskine5fe5e272019-08-02 20:30:01 +02001391/* BEGIN_CASE depends_on:MBEDTLS_PSA_CRYPTO_SE_C */
1392void slot_number_attribute( )
1393{
1394 psa_key_slot_number_t slot_number = 0xdeadbeef;
1395 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
1396
1397 /* Initially, there is no slot number. */
1398 TEST_EQUAL( psa_get_key_slot_number( &attributes, &slot_number ),
1399 PSA_ERROR_INVALID_ARGUMENT );
1400
1401 /* Test setting a slot number. */
1402 psa_set_key_slot_number( &attributes, 0 );
1403 PSA_ASSERT( psa_get_key_slot_number( &attributes, &slot_number ) );
1404 TEST_EQUAL( slot_number, 0 );
1405
1406 /* Test changing the slot number. */
1407 psa_set_key_slot_number( &attributes, 42 );
1408 PSA_ASSERT( psa_get_key_slot_number( &attributes, &slot_number ) );
1409 TEST_EQUAL( slot_number, 42 );
1410
1411 /* Test clearing the slot number. */
1412 psa_clear_key_slot_number( &attributes );
1413 TEST_EQUAL( psa_get_key_slot_number( &attributes, &slot_number ),
1414 PSA_ERROR_INVALID_ARGUMENT );
1415
1416 /* Clearing again should have no effect. */
1417 psa_clear_key_slot_number( &attributes );
1418 TEST_EQUAL( psa_get_key_slot_number( &attributes, &slot_number ),
1419 PSA_ERROR_INVALID_ARGUMENT );
1420
1421 /* Test that reset clears the slot number. */
1422 psa_set_key_slot_number( &attributes, 42 );
1423 PSA_ASSERT( psa_get_key_slot_number( &attributes, &slot_number ) );
1424 TEST_EQUAL( slot_number, 42 );
1425 psa_reset_key_attributes( &attributes );
1426 TEST_EQUAL( psa_get_key_slot_number( &attributes, &slot_number ),
1427 PSA_ERROR_INVALID_ARGUMENT );
1428}
1429/* END_CASE */
1430
Gilles Peskinedd835cb2019-05-15 16:14:57 +02001431/* BEGIN_CASE */
Gilles Peskine6edfa292019-07-31 15:53:45 +02001432void import_with_policy( int type_arg,
1433 int usage_arg, int alg_arg,
1434 int expected_status_arg )
1435{
1436 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
1437 psa_key_attributes_t got_attributes = PSA_KEY_ATTRIBUTES_INIT;
1438 psa_key_handle_t handle = 0;
1439 psa_key_type_t type = type_arg;
1440 psa_key_usage_t usage = usage_arg;
1441 psa_algorithm_t alg = alg_arg;
1442 psa_status_t expected_status = expected_status_arg;
1443 const uint8_t key_material[16] = {0};
1444 psa_status_t status;
1445
1446 PSA_ASSERT( psa_crypto_init( ) );
1447
1448 psa_set_key_type( &attributes, type );
1449 psa_set_key_usage_flags( &attributes, usage );
1450 psa_set_key_algorithm( &attributes, alg );
1451
1452 status = psa_import_key( &attributes,
1453 key_material, sizeof( key_material ),
1454 &handle );
1455 TEST_EQUAL( status, expected_status );
1456 if( status != PSA_SUCCESS )
1457 goto exit;
1458
1459 PSA_ASSERT( psa_get_key_attributes( handle, &got_attributes ) );
1460 TEST_EQUAL( psa_get_key_type( &got_attributes ), type );
1461 TEST_EQUAL( psa_get_key_usage_flags( &got_attributes ), usage );
1462 TEST_EQUAL( psa_get_key_algorithm( &got_attributes ), alg );
Gilles Peskine5fe5e272019-08-02 20:30:01 +02001463 ASSERT_NO_SLOT_NUMBER( &got_attributes );
Gilles Peskine6edfa292019-07-31 15:53:45 +02001464
1465 PSA_ASSERT( psa_destroy_key( handle ) );
1466 test_operations_on_invalid_handle( handle );
1467
1468exit:
1469 psa_destroy_key( handle );
1470 psa_reset_key_attributes( &got_attributes );
1471 PSA_DONE( );
1472}
1473/* END_CASE */
1474
1475/* BEGIN_CASE */
1476void import_with_data( data_t *data, int type_arg,
1477 int attr_bits_arg,
1478 int expected_status_arg )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001479{
1480 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
1481 psa_key_attributes_t got_attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskinebdf309c2018-12-03 15:36:32 +01001482 psa_key_handle_t handle = 0;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001483 psa_key_type_t type = type_arg;
Gilles Peskine8fb3a9e2019-05-03 16:59:21 +02001484 size_t attr_bits = attr_bits_arg;
Gilles Peskineb866e2b2018-06-21 09:25:10 +02001485 psa_status_t expected_status = expected_status_arg;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001486 psa_status_t status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001487
Gilles Peskine8817f612018-12-18 00:18:46 +01001488 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001489
Gilles Peskine4747d192019-04-17 15:05:45 +02001490 psa_set_key_type( &attributes, type );
Gilles Peskine8fb3a9e2019-05-03 16:59:21 +02001491 psa_set_key_bits( &attributes, attr_bits );
Gilles Peskine6edfa292019-07-31 15:53:45 +02001492
Gilles Peskine73676cb2019-05-15 20:15:10 +02001493 status = psa_import_key( &attributes, data->x, data->len, &handle );
Gilles Peskinefe11b722018-12-18 00:24:04 +01001494 TEST_EQUAL( status, expected_status );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001495 if( status != PSA_SUCCESS )
1496 goto exit;
1497
1498 PSA_ASSERT( psa_get_key_attributes( handle, &got_attributes ) );
1499 TEST_EQUAL( psa_get_key_type( &got_attributes ), type );
Gilles Peskine8fb3a9e2019-05-03 16:59:21 +02001500 if( attr_bits != 0 )
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001501 TEST_EQUAL( attr_bits, psa_get_key_bits( &got_attributes ) );
Gilles Peskine5fe5e272019-08-02 20:30:01 +02001502 ASSERT_NO_SLOT_NUMBER( &got_attributes );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001503
1504 PSA_ASSERT( psa_destroy_key( handle ) );
Gilles Peskine4cf3a432019-04-18 22:28:52 +02001505 test_operations_on_invalid_handle( handle );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001506
1507exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001508 psa_destroy_key( handle );
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02001509 psa_reset_key_attributes( &got_attributes );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02001510 PSA_DONE( );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001511}
1512/* END_CASE */
1513
1514/* BEGIN_CASE */
Gilles Peskinec744d992019-07-30 17:26:54 +02001515void import_large_key( int type_arg, int byte_size_arg,
1516 int expected_status_arg )
1517{
1518 psa_key_type_t type = type_arg;
1519 size_t byte_size = byte_size_arg;
1520 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
1521 psa_status_t expected_status = expected_status_arg;
1522 psa_key_handle_t handle = 0;
1523 psa_status_t status;
1524 uint8_t *buffer = NULL;
1525 size_t buffer_size = byte_size + 1;
1526 size_t n;
1527
1528 /* It would be better to skip the test than fail it if the allocation
1529 * fails, but the test framework doesn't support this yet. */
1530 ASSERT_ALLOC( buffer, buffer_size );
1531 memset( buffer, 'K', byte_size );
1532
1533 PSA_ASSERT( psa_crypto_init( ) );
1534
1535 /* Try importing the key */
1536 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_EXPORT );
1537 psa_set_key_type( &attributes, type );
1538 status = psa_import_key( &attributes, buffer, byte_size, &handle );
1539 TEST_EQUAL( status, expected_status );
1540
1541 if( status == PSA_SUCCESS )
1542 {
1543 PSA_ASSERT( psa_get_key_attributes( handle, &attributes ) );
1544 TEST_EQUAL( psa_get_key_type( &attributes ), type );
1545 TEST_EQUAL( psa_get_key_bits( &attributes ),
1546 PSA_BYTES_TO_BITS( byte_size ) );
Gilles Peskine5fe5e272019-08-02 20:30:01 +02001547 ASSERT_NO_SLOT_NUMBER( &attributes );
Gilles Peskinec744d992019-07-30 17:26:54 +02001548 memset( buffer, 0, byte_size + 1 );
1549 PSA_ASSERT( psa_export_key( handle, buffer, byte_size, &n ) );
1550 for( n = 0; n < byte_size; n++ )
1551 TEST_EQUAL( buffer[n], 'K' );
1552 for( n = byte_size; n < buffer_size; n++ )
1553 TEST_EQUAL( buffer[n], 0 );
1554 }
1555
1556exit:
1557 psa_destroy_key( handle );
1558 PSA_DONE( );
1559 mbedtls_free( buffer );
1560}
1561/* END_CASE */
1562
1563/* BEGIN_CASE */
Gilles Peskine0b352bc2018-06-28 00:16:11 +02001564void import_rsa_made_up( int bits_arg, int keypair, int expected_status_arg )
1565{
Gilles Peskinebdf309c2018-12-03 15:36:32 +01001566 psa_key_handle_t handle = 0;
Gilles Peskine0b352bc2018-06-28 00:16:11 +02001567 size_t bits = bits_arg;
1568 psa_status_t expected_status = expected_status_arg;
1569 psa_status_t status;
1570 psa_key_type_t type =
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001571 keypair ? PSA_KEY_TYPE_RSA_KEY_PAIR : PSA_KEY_TYPE_RSA_PUBLIC_KEY;
Gilles Peskine0b352bc2018-06-28 00:16:11 +02001572 size_t buffer_size = /* Slight overapproximations */
1573 keypair ? bits * 9 / 16 + 80 : bits / 8 + 20;
Gilles Peskine8cebbba2018-09-27 13:54:18 +02001574 unsigned char *buffer = NULL;
Gilles Peskine0b352bc2018-06-28 00:16:11 +02001575 unsigned char *p;
1576 int ret;
1577 size_t length;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001578 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine0b352bc2018-06-28 00:16:11 +02001579
Gilles Peskine8817f612018-12-18 00:18:46 +01001580 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine8cebbba2018-09-27 13:54:18 +02001581 ASSERT_ALLOC( buffer, buffer_size );
Gilles Peskine0b352bc2018-06-28 00:16:11 +02001582
1583 TEST_ASSERT( ( ret = construct_fake_rsa_key( buffer, buffer_size, &p,
1584 bits, keypair ) ) >= 0 );
1585 length = ret;
1586
1587 /* Try importing the key */
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001588 psa_set_key_type( &attributes, type );
Gilles Peskine73676cb2019-05-15 20:15:10 +02001589 status = psa_import_key( &attributes, p, length, &handle );
Gilles Peskinefe11b722018-12-18 00:24:04 +01001590 TEST_EQUAL( status, expected_status );
Gilles Peskine76b29a72019-05-28 14:08:50 +02001591
Gilles Peskine0b352bc2018-06-28 00:16:11 +02001592 if( status == PSA_SUCCESS )
Gilles Peskine8817f612018-12-18 00:18:46 +01001593 PSA_ASSERT( psa_destroy_key( handle ) );
Gilles Peskine0b352bc2018-06-28 00:16:11 +02001594
1595exit:
1596 mbedtls_free( buffer );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02001597 PSA_DONE( );
Gilles Peskine0b352bc2018-06-28 00:16:11 +02001598}
1599/* END_CASE */
1600
1601/* BEGIN_CASE */
itayzafrir3e02b3b2018-06-12 17:06:52 +03001602void import_export( data_t *data,
Moran Pekera964a8f2018-06-04 18:42:36 +03001603 int type_arg,
Gilles Peskine1ecf92c22019-05-24 15:00:06 +02001604 int usage_arg, int alg_arg,
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001605 int expected_bits,
1606 int export_size_delta,
Gilles Peskineb866e2b2018-06-21 09:25:10 +02001607 int expected_export_status_arg,
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001608 int canonical_input )
1609{
Gilles Peskinebdf309c2018-12-03 15:36:32 +01001610 psa_key_handle_t handle = 0;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001611 psa_key_type_t type = type_arg;
Gilles Peskine4abf7412018-06-18 16:35:34 +02001612 psa_algorithm_t alg = alg_arg;
Gilles Peskineb866e2b2018-06-21 09:25:10 +02001613 psa_status_t expected_export_status = expected_export_status_arg;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001614 psa_status_t status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001615 unsigned char *exported = NULL;
1616 unsigned char *reexported = NULL;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001617 size_t export_size;
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001618 size_t exported_length = INVALID_EXPORT_LENGTH;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001619 size_t reexported_length;
Gilles Peskine4747d192019-04-17 15:05:45 +02001620 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001621 psa_key_attributes_t got_attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001622
Moran Pekercb088e72018-07-17 17:36:59 +03001623 export_size = (ptrdiff_t) data->len + export_size_delta;
Gilles Peskine8cebbba2018-09-27 13:54:18 +02001624 ASSERT_ALLOC( exported, export_size );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001625 if( ! canonical_input )
Gilles Peskine8cebbba2018-09-27 13:54:18 +02001626 ASSERT_ALLOC( reexported, export_size );
Gilles Peskine8817f612018-12-18 00:18:46 +01001627 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001628
Gilles Peskine4747d192019-04-17 15:05:45 +02001629 psa_set_key_usage_flags( &attributes, usage_arg );
1630 psa_set_key_algorithm( &attributes, alg );
1631 psa_set_key_type( &attributes, type );
mohammad1603a97cb8c2018-03-28 03:46:26 -07001632
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001633 /* Import the key */
Gilles Peskine73676cb2019-05-15 20:15:10 +02001634 PSA_ASSERT( psa_import_key( &attributes, data->x, data->len, &handle ) );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001635
1636 /* Test the key information */
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001637 PSA_ASSERT( psa_get_key_attributes( handle, &got_attributes ) );
1638 TEST_EQUAL( psa_get_key_type( &got_attributes ), type );
1639 TEST_EQUAL( psa_get_key_bits( &got_attributes ), (size_t) expected_bits );
Gilles Peskine5fe5e272019-08-02 20:30:01 +02001640 ASSERT_NO_SLOT_NUMBER( &got_attributes );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001641
1642 /* Export the key */
Gilles Peskinebdf309c2018-12-03 15:36:32 +01001643 status = psa_export_key( handle,
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001644 exported, export_size,
1645 &exported_length );
Gilles Peskinefe11b722018-12-18 00:24:04 +01001646 TEST_EQUAL( status, expected_export_status );
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001647
1648 /* The exported length must be set by psa_export_key() to a value between 0
1649 * and export_size. On errors, the exported length must be 0. */
1650 TEST_ASSERT( exported_length != INVALID_EXPORT_LENGTH );
1651 TEST_ASSERT( status == PSA_SUCCESS || exported_length == 0 );
1652 TEST_ASSERT( exported_length <= export_size );
1653
Gilles Peskinea7aa4422018-08-14 15:17:54 +02001654 TEST_ASSERT( mem_is_char( exported + exported_length, 0,
Gilles Peskine3f669c32018-06-21 09:21:51 +02001655 export_size - exported_length ) );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001656 if( status != PSA_SUCCESS )
Gilles Peskinee66ca3b2018-06-20 00:11:45 +02001657 {
Gilles Peskinefe11b722018-12-18 00:24:04 +01001658 TEST_EQUAL( exported_length, 0 );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001659 goto destroy;
Gilles Peskinee66ca3b2018-06-20 00:11:45 +02001660 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001661
Gilles Peskinebdf309c2018-12-03 15:36:32 +01001662 if( ! exercise_export_key( handle, usage_arg ) )
Gilles Peskine8f609232018-08-11 01:24:55 +02001663 goto exit;
1664
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001665 if( canonical_input )
Gilles Peskinebd7dea92018-09-27 13:57:19 +02001666 ASSERT_COMPARE( data->x, data->len, exported, exported_length );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001667 else
1668 {
Gilles Peskinebdf309c2018-12-03 15:36:32 +01001669 psa_key_handle_t handle2;
Gilles Peskine049c7532019-05-15 20:22:09 +02001670 PSA_ASSERT( psa_import_key( &attributes, exported, exported_length,
1671 &handle2 ) );
Gilles Peskine8817f612018-12-18 00:18:46 +01001672 PSA_ASSERT( psa_export_key( handle2,
1673 reexported,
1674 export_size,
1675 &reexported_length ) );
Gilles Peskinebd7dea92018-09-27 13:57:19 +02001676 ASSERT_COMPARE( exported, exported_length,
1677 reexported, reexported_length );
Gilles Peskine8817f612018-12-18 00:18:46 +01001678 PSA_ASSERT( psa_close_key( handle2 ) );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001679 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001680 TEST_ASSERT( exported_length <= PSA_KEY_EXPORT_MAX_SIZE( type, psa_get_key_bits( &got_attributes ) ) );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001681
1682destroy:
1683 /* Destroy the key */
Gilles Peskine8817f612018-12-18 00:18:46 +01001684 PSA_ASSERT( psa_destroy_key( handle ) );
Gilles Peskine4cf3a432019-04-18 22:28:52 +02001685 test_operations_on_invalid_handle( handle );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001686
1687exit:
itayzafrir3e02b3b2018-06-12 17:06:52 +03001688 mbedtls_free( exported );
1689 mbedtls_free( reexported );
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02001690 psa_reset_key_attributes( &got_attributes );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02001691 PSA_DONE( );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001692}
1693/* END_CASE */
Gilles Peskine20035e32018-02-03 22:44:14 +01001694
Moran Pekerf709f4a2018-06-06 17:26:04 +03001695/* BEGIN_CASE */
itayzafrir3e02b3b2018-06-12 17:06:52 +03001696void import_export_public_key( data_t *data,
Gilles Peskine2d277862018-06-18 15:41:12 +02001697 int type_arg,
1698 int alg_arg,
Gilles Peskine49c25912018-10-29 15:15:31 +01001699 int export_size_delta,
1700 int expected_export_status_arg,
1701 data_t *expected_public_key )
Moran Pekerf709f4a2018-06-06 17:26:04 +03001702{
Gilles Peskinebdf309c2018-12-03 15:36:32 +01001703 psa_key_handle_t handle = 0;
Moran Pekerf709f4a2018-06-06 17:26:04 +03001704 psa_key_type_t type = type_arg;
Gilles Peskine4abf7412018-06-18 16:35:34 +02001705 psa_algorithm_t alg = alg_arg;
Gilles Peskineb866e2b2018-06-21 09:25:10 +02001706 psa_status_t expected_export_status = expected_export_status_arg;
Moran Pekerf709f4a2018-06-06 17:26:04 +03001707 psa_status_t status;
Moran Pekerf709f4a2018-06-06 17:26:04 +03001708 unsigned char *exported = NULL;
Gilles Peskine49c25912018-10-29 15:15:31 +01001709 size_t export_size = expected_public_key->len + export_size_delta;
Jaeden Amero2a671e92018-06-27 17:47:40 +01001710 size_t exported_length = INVALID_EXPORT_LENGTH;
Gilles Peskine4747d192019-04-17 15:05:45 +02001711 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Moran Pekerf709f4a2018-06-06 17:26:04 +03001712
Gilles Peskine8817f612018-12-18 00:18:46 +01001713 PSA_ASSERT( psa_crypto_init( ) );
Moran Pekerf709f4a2018-06-06 17:26:04 +03001714
Gilles Peskine4747d192019-04-17 15:05:45 +02001715 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_EXPORT );
1716 psa_set_key_algorithm( &attributes, alg );
1717 psa_set_key_type( &attributes, type );
Moran Pekerf709f4a2018-06-06 17:26:04 +03001718
1719 /* Import the key */
Gilles Peskine73676cb2019-05-15 20:15:10 +02001720 PSA_ASSERT( psa_import_key( &attributes, data->x, data->len, &handle ) );
Moran Pekerf709f4a2018-06-06 17:26:04 +03001721
Gilles Peskine49c25912018-10-29 15:15:31 +01001722 /* Export the public key */
1723 ASSERT_ALLOC( exported, export_size );
Gilles Peskinebdf309c2018-12-03 15:36:32 +01001724 status = psa_export_public_key( handle,
Gilles Peskine2d277862018-06-18 15:41:12 +02001725 exported, export_size,
1726 &exported_length );
Gilles Peskinefe11b722018-12-18 00:24:04 +01001727 TEST_EQUAL( status, expected_export_status );
Gilles Peskine49c25912018-10-29 15:15:31 +01001728 if( status == PSA_SUCCESS )
Gilles Peskined8b7d4f2018-10-29 15:18:41 +01001729 {
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001730 psa_key_type_t public_type = PSA_KEY_TYPE_PUBLIC_KEY_OF_KEY_PAIR( type );
Gilles Peskined8b7d4f2018-10-29 15:18:41 +01001731 size_t bits;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001732 PSA_ASSERT( psa_get_key_attributes( handle, &attributes ) );
1733 bits = psa_get_key_bits( &attributes );
Gilles Peskined8b7d4f2018-10-29 15:18:41 +01001734 TEST_ASSERT( expected_public_key->len <=
1735 PSA_KEY_EXPORT_MAX_SIZE( public_type, bits ) );
Gilles Peskine49c25912018-10-29 15:15:31 +01001736 ASSERT_COMPARE( expected_public_key->x, expected_public_key->len,
1737 exported, exported_length );
Gilles Peskined8b7d4f2018-10-29 15:18:41 +01001738 }
Moran Pekerf709f4a2018-06-06 17:26:04 +03001739
1740exit:
itayzafrir3e02b3b2018-06-12 17:06:52 +03001741 mbedtls_free( exported );
Gilles Peskinebdf309c2018-12-03 15:36:32 +01001742 psa_destroy_key( handle );
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02001743 psa_reset_key_attributes( &attributes );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02001744 PSA_DONE( );
Moran Pekerf709f4a2018-06-06 17:26:04 +03001745}
1746/* END_CASE */
1747
Gilles Peskine20035e32018-02-03 22:44:14 +01001748/* BEGIN_CASE */
Gilles Peskinea680c7a2018-06-26 16:12:43 +02001749void import_and_exercise_key( data_t *data,
1750 int type_arg,
1751 int bits_arg,
1752 int alg_arg )
1753{
Gilles Peskinebdf309c2018-12-03 15:36:32 +01001754 psa_key_handle_t handle = 0;
Gilles Peskinea680c7a2018-06-26 16:12:43 +02001755 psa_key_type_t type = type_arg;
1756 size_t bits = bits_arg;
1757 psa_algorithm_t alg = alg_arg;
Gilles Peskine10df3412018-10-25 22:35:43 +02001758 psa_key_usage_t usage = usage_to_exercise( type, alg );
Gilles Peskine4747d192019-04-17 15:05:45 +02001759 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001760 psa_key_attributes_t got_attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskinea680c7a2018-06-26 16:12:43 +02001761
Gilles Peskine8817f612018-12-18 00:18:46 +01001762 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskinea680c7a2018-06-26 16:12:43 +02001763
Gilles Peskine4747d192019-04-17 15:05:45 +02001764 psa_set_key_usage_flags( &attributes, usage );
1765 psa_set_key_algorithm( &attributes, alg );
1766 psa_set_key_type( &attributes, type );
Gilles Peskinea680c7a2018-06-26 16:12:43 +02001767
1768 /* Import the key */
Gilles Peskine73676cb2019-05-15 20:15:10 +02001769 PSA_ASSERT( psa_import_key( &attributes, data->x, data->len, &handle ) );
Gilles Peskinea680c7a2018-06-26 16:12:43 +02001770
1771 /* Test the key information */
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001772 PSA_ASSERT( psa_get_key_attributes( handle, &got_attributes ) );
1773 TEST_EQUAL( psa_get_key_type( &got_attributes ), type );
1774 TEST_EQUAL( psa_get_key_bits( &got_attributes ), bits );
Gilles Peskinea680c7a2018-06-26 16:12:43 +02001775
1776 /* Do something with the key according to its type and permitted usage. */
Gilles Peskinebdf309c2018-12-03 15:36:32 +01001777 if( ! exercise_key( handle, usage, alg ) )
Gilles Peskine02b75072018-07-01 22:31:34 +02001778 goto exit;
Gilles Peskinea680c7a2018-06-26 16:12:43 +02001779
Gilles Peskine4cf3a432019-04-18 22:28:52 +02001780 PSA_ASSERT( psa_destroy_key( handle ) );
1781 test_operations_on_invalid_handle( handle );
1782
Gilles Peskinea680c7a2018-06-26 16:12:43 +02001783exit:
Gilles Peskinebdf309c2018-12-03 15:36:32 +01001784 psa_destroy_key( handle );
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02001785 psa_reset_key_attributes( &got_attributes );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02001786 PSA_DONE( );
Gilles Peskinea680c7a2018-06-26 16:12:43 +02001787}
1788/* END_CASE */
1789
1790/* BEGIN_CASE */
Gilles Peskine06c28892019-11-26 18:07:46 +01001791void effective_key_attributes( int type_arg, int expected_type_arg,
1792 int bits_arg, int expected_bits_arg,
1793 int usage_arg, int expected_usage_arg,
1794 int alg_arg, int expected_alg_arg )
Gilles Peskined5b33222018-06-18 22:20:03 +02001795{
Gilles Peskinebdf309c2018-12-03 15:36:32 +01001796 psa_key_handle_t handle = 0;
Gilles Peskine1a960492019-11-26 17:12:21 +01001797 psa_key_type_t key_type = type_arg;
Gilles Peskine06c28892019-11-26 18:07:46 +01001798 psa_key_type_t expected_key_type = expected_type_arg;
Gilles Peskine1a960492019-11-26 17:12:21 +01001799 size_t bits = bits_arg;
Gilles Peskine06c28892019-11-26 18:07:46 +01001800 size_t expected_bits = expected_bits_arg;
Gilles Peskined5b33222018-06-18 22:20:03 +02001801 psa_algorithm_t alg = alg_arg;
Gilles Peskine06c28892019-11-26 18:07:46 +01001802 psa_algorithm_t expected_alg = expected_alg_arg;
Gilles Peskined5b33222018-06-18 22:20:03 +02001803 psa_key_usage_t usage = usage_arg;
Gilles Peskine06c28892019-11-26 18:07:46 +01001804 psa_key_usage_t expected_usage = expected_usage_arg;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001805 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskined5b33222018-06-18 22:20:03 +02001806
Gilles Peskine8817f612018-12-18 00:18:46 +01001807 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskined5b33222018-06-18 22:20:03 +02001808
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001809 psa_set_key_usage_flags( &attributes, usage );
1810 psa_set_key_algorithm( &attributes, alg );
1811 psa_set_key_type( &attributes, key_type );
Gilles Peskine1a960492019-11-26 17:12:21 +01001812 psa_set_key_bits( &attributes, bits );
Gilles Peskined5b33222018-06-18 22:20:03 +02001813
Gilles Peskine1a960492019-11-26 17:12:21 +01001814 PSA_ASSERT( psa_generate_key( &attributes, &handle ) );
1815 psa_reset_key_attributes( &attributes );
Gilles Peskined5b33222018-06-18 22:20:03 +02001816
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001817 PSA_ASSERT( psa_get_key_attributes( handle, &attributes ) );
Gilles Peskine06c28892019-11-26 18:07:46 +01001818 TEST_EQUAL( psa_get_key_type( &attributes ), expected_key_type );
1819 TEST_EQUAL( psa_get_key_bits( &attributes ), expected_bits );
1820 TEST_EQUAL( psa_get_key_usage_flags( &attributes ), expected_usage );
1821 TEST_EQUAL( psa_get_key_algorithm( &attributes ), expected_alg );
Gilles Peskined5b33222018-06-18 22:20:03 +02001822
1823exit:
Gilles Peskinebdf309c2018-12-03 15:36:32 +01001824 psa_destroy_key( handle );
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02001825 psa_reset_key_attributes( &attributes );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02001826 PSA_DONE( );
Gilles Peskined5b33222018-06-18 22:20:03 +02001827}
1828/* END_CASE */
1829
1830/* BEGIN_CASE */
Gilles Peskine06c28892019-11-26 18:07:46 +01001831void check_key_policy( int type_arg, int bits_arg,
1832 int usage_arg, int alg_arg )
1833{
1834 test_effective_key_attributes( type_arg, type_arg, bits_arg, bits_arg,
1835 usage_arg, usage_arg, alg_arg, alg_arg );
1836 goto exit;
1837}
1838/* END_CASE */
1839
1840/* BEGIN_CASE */
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001841void key_attributes_init( )
Jaeden Amero70261c52019-01-04 11:47:20 +00001842{
1843 /* Test each valid way of initializing the object, except for `= {0}`, as
1844 * Clang 5 complains when `-Wmissing-field-initializers` is used, even
1845 * though it's OK by the C standard. We could test for this, but we'd need
1846 * to supress the Clang warning for the test. */
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001847 psa_key_attributes_t func = psa_key_attributes_init( );
1848 psa_key_attributes_t init = PSA_KEY_ATTRIBUTES_INIT;
1849 psa_key_attributes_t zero;
Jaeden Amero70261c52019-01-04 11:47:20 +00001850
1851 memset( &zero, 0, sizeof( zero ) );
1852
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001853 TEST_EQUAL( psa_get_key_lifetime( &func ), PSA_KEY_LIFETIME_VOLATILE );
1854 TEST_EQUAL( psa_get_key_lifetime( &init ), PSA_KEY_LIFETIME_VOLATILE );
1855 TEST_EQUAL( psa_get_key_lifetime( &zero ), PSA_KEY_LIFETIME_VOLATILE );
Jaeden Amero5229bbb2019-02-07 16:33:37 +00001856
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001857 TEST_EQUAL( psa_get_key_type( &func ), 0 );
1858 TEST_EQUAL( psa_get_key_type( &init ), 0 );
1859 TEST_EQUAL( psa_get_key_type( &zero ), 0 );
1860
1861 TEST_EQUAL( psa_get_key_bits( &func ), 0 );
1862 TEST_EQUAL( psa_get_key_bits( &init ), 0 );
1863 TEST_EQUAL( psa_get_key_bits( &zero ), 0 );
1864
1865 TEST_EQUAL( psa_get_key_usage_flags( &func ), 0 );
1866 TEST_EQUAL( psa_get_key_usage_flags( &init ), 0 );
1867 TEST_EQUAL( psa_get_key_usage_flags( &zero ), 0 );
1868
1869 TEST_EQUAL( psa_get_key_algorithm( &func ), 0 );
1870 TEST_EQUAL( psa_get_key_algorithm( &init ), 0 );
1871 TEST_EQUAL( psa_get_key_algorithm( &zero ), 0 );
Jaeden Amero70261c52019-01-04 11:47:20 +00001872}
1873/* END_CASE */
1874
1875/* BEGIN_CASE */
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001876void mac_key_policy( int policy_usage,
1877 int policy_alg,
1878 int key_type,
1879 data_t *key_data,
1880 int exercise_alg )
Gilles Peskined5b33222018-06-18 22:20:03 +02001881{
Gilles Peskinebdf309c2018-12-03 15:36:32 +01001882 psa_key_handle_t handle = 0;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001883 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Jaeden Amero769ce272019-01-04 11:48:03 +00001884 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001885 psa_status_t status;
1886 unsigned char mac[PSA_MAC_MAX_SIZE];
Gilles Peskined5b33222018-06-18 22:20:03 +02001887
Gilles Peskine8817f612018-12-18 00:18:46 +01001888 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskined5b33222018-06-18 22:20:03 +02001889
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001890 psa_set_key_usage_flags( &attributes, policy_usage );
1891 psa_set_key_algorithm( &attributes, policy_alg );
1892 psa_set_key_type( &attributes, key_type );
Gilles Peskined5b33222018-06-18 22:20:03 +02001893
Gilles Peskine049c7532019-05-15 20:22:09 +02001894 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
1895 &handle ) );
Gilles Peskined5b33222018-06-18 22:20:03 +02001896
Gilles Peskinebdf309c2018-12-03 15:36:32 +01001897 status = psa_mac_sign_setup( &operation, handle, exercise_alg );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001898 if( policy_alg == exercise_alg &&
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001899 ( policy_usage & PSA_KEY_USAGE_SIGN_HASH ) != 0 )
Gilles Peskine8817f612018-12-18 00:18:46 +01001900 PSA_ASSERT( status );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001901 else
Gilles Peskinefe11b722018-12-18 00:24:04 +01001902 TEST_EQUAL( status, PSA_ERROR_NOT_PERMITTED );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001903 psa_mac_abort( &operation );
Gilles Peskined5b33222018-06-18 22:20:03 +02001904
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001905 memset( mac, 0, sizeof( mac ) );
Gilles Peskinebdf309c2018-12-03 15:36:32 +01001906 status = psa_mac_verify_setup( &operation, handle, exercise_alg );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001907 if( policy_alg == exercise_alg &&
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001908 ( policy_usage & PSA_KEY_USAGE_VERIFY_HASH ) != 0 )
Gilles Peskine8817f612018-12-18 00:18:46 +01001909 PSA_ASSERT( status );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001910 else
Gilles Peskinefe11b722018-12-18 00:24:04 +01001911 TEST_EQUAL( status, PSA_ERROR_NOT_PERMITTED );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001912
1913exit:
1914 psa_mac_abort( &operation );
Gilles Peskinebdf309c2018-12-03 15:36:32 +01001915 psa_destroy_key( handle );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02001916 PSA_DONE( );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001917}
1918/* END_CASE */
1919
1920/* BEGIN_CASE */
1921void cipher_key_policy( int policy_usage,
1922 int policy_alg,
1923 int key_type,
1924 data_t *key_data,
1925 int exercise_alg )
1926{
Gilles Peskinebdf309c2018-12-03 15:36:32 +01001927 psa_key_handle_t handle = 0;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001928 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Jaeden Amero5bae2272019-01-04 11:48:27 +00001929 psa_cipher_operation_t operation = PSA_CIPHER_OPERATION_INIT;
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001930 psa_status_t status;
1931
Gilles Peskine8817f612018-12-18 00:18:46 +01001932 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001933
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001934 psa_set_key_usage_flags( &attributes, policy_usage );
1935 psa_set_key_algorithm( &attributes, policy_alg );
1936 psa_set_key_type( &attributes, key_type );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001937
Gilles Peskine049c7532019-05-15 20:22:09 +02001938 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
1939 &handle ) );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001940
Gilles Peskinebdf309c2018-12-03 15:36:32 +01001941 status = psa_cipher_encrypt_setup( &operation, handle, exercise_alg );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001942 if( policy_alg == exercise_alg &&
1943 ( policy_usage & PSA_KEY_USAGE_ENCRYPT ) != 0 )
Gilles Peskine8817f612018-12-18 00:18:46 +01001944 PSA_ASSERT( status );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001945 else
Gilles Peskinefe11b722018-12-18 00:24:04 +01001946 TEST_EQUAL( status, PSA_ERROR_NOT_PERMITTED );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001947 psa_cipher_abort( &operation );
1948
Gilles Peskinebdf309c2018-12-03 15:36:32 +01001949 status = psa_cipher_decrypt_setup( &operation, handle, exercise_alg );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001950 if( policy_alg == exercise_alg &&
1951 ( policy_usage & PSA_KEY_USAGE_DECRYPT ) != 0 )
Gilles Peskine8817f612018-12-18 00:18:46 +01001952 PSA_ASSERT( status );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001953 else
Gilles Peskinefe11b722018-12-18 00:24:04 +01001954 TEST_EQUAL( status, PSA_ERROR_NOT_PERMITTED );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001955
1956exit:
1957 psa_cipher_abort( &operation );
Gilles Peskinebdf309c2018-12-03 15:36:32 +01001958 psa_destroy_key( handle );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02001959 PSA_DONE( );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001960}
1961/* END_CASE */
1962
1963/* BEGIN_CASE */
1964void aead_key_policy( int policy_usage,
1965 int policy_alg,
1966 int key_type,
1967 data_t *key_data,
1968 int nonce_length_arg,
1969 int tag_length_arg,
1970 int exercise_alg )
1971{
Gilles Peskinebdf309c2018-12-03 15:36:32 +01001972 psa_key_handle_t handle = 0;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001973 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001974 psa_status_t status;
1975 unsigned char nonce[16] = {0};
1976 size_t nonce_length = nonce_length_arg;
1977 unsigned char tag[16];
1978 size_t tag_length = tag_length_arg;
1979 size_t output_length;
1980
1981 TEST_ASSERT( nonce_length <= sizeof( nonce ) );
1982 TEST_ASSERT( tag_length <= sizeof( tag ) );
1983
Gilles Peskine8817f612018-12-18 00:18:46 +01001984 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001985
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001986 psa_set_key_usage_flags( &attributes, policy_usage );
1987 psa_set_key_algorithm( &attributes, policy_alg );
1988 psa_set_key_type( &attributes, key_type );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001989
Gilles Peskine049c7532019-05-15 20:22:09 +02001990 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
1991 &handle ) );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001992
Gilles Peskinebdf309c2018-12-03 15:36:32 +01001993 status = psa_aead_encrypt( handle, exercise_alg,
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001994 nonce, nonce_length,
1995 NULL, 0,
1996 NULL, 0,
1997 tag, tag_length,
1998 &output_length );
1999 if( policy_alg == exercise_alg &&
2000 ( policy_usage & PSA_KEY_USAGE_ENCRYPT ) != 0 )
Gilles Peskine8817f612018-12-18 00:18:46 +01002001 PSA_ASSERT( status );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02002002 else
Gilles Peskinefe11b722018-12-18 00:24:04 +01002003 TEST_EQUAL( status, PSA_ERROR_NOT_PERMITTED );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02002004
2005 memset( tag, 0, sizeof( tag ) );
Gilles Peskinebdf309c2018-12-03 15:36:32 +01002006 status = psa_aead_decrypt( handle, exercise_alg,
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02002007 nonce, nonce_length,
2008 NULL, 0,
2009 tag, tag_length,
2010 NULL, 0,
2011 &output_length );
2012 if( policy_alg == exercise_alg &&
2013 ( policy_usage & PSA_KEY_USAGE_DECRYPT ) != 0 )
Gilles Peskinefe11b722018-12-18 00:24:04 +01002014 TEST_EQUAL( status, PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02002015 else
Gilles Peskinefe11b722018-12-18 00:24:04 +01002016 TEST_EQUAL( status, PSA_ERROR_NOT_PERMITTED );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02002017
2018exit:
Gilles Peskinebdf309c2018-12-03 15:36:32 +01002019 psa_destroy_key( handle );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02002020 PSA_DONE( );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02002021}
2022/* END_CASE */
2023
2024/* BEGIN_CASE */
2025void asymmetric_encryption_key_policy( int policy_usage,
2026 int policy_alg,
2027 int key_type,
2028 data_t *key_data,
2029 int exercise_alg )
2030{
Gilles Peskinebdf309c2018-12-03 15:36:32 +01002031 psa_key_handle_t handle = 0;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02002032 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02002033 psa_status_t status;
2034 size_t key_bits;
2035 size_t buffer_length;
2036 unsigned char *buffer = NULL;
2037 size_t output_length;
2038
Gilles Peskine8817f612018-12-18 00:18:46 +01002039 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02002040
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02002041 psa_set_key_usage_flags( &attributes, policy_usage );
2042 psa_set_key_algorithm( &attributes, policy_alg );
2043 psa_set_key_type( &attributes, key_type );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02002044
Gilles Peskine049c7532019-05-15 20:22:09 +02002045 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
2046 &handle ) );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02002047
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002048 PSA_ASSERT( psa_get_key_attributes( handle, &attributes ) );
2049 key_bits = psa_get_key_bits( &attributes );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02002050 buffer_length = PSA_ASYMMETRIC_ENCRYPT_OUTPUT_SIZE( key_type, key_bits,
2051 exercise_alg );
Gilles Peskine8cebbba2018-09-27 13:54:18 +02002052 ASSERT_ALLOC( buffer, buffer_length );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02002053
Gilles Peskinebdf309c2018-12-03 15:36:32 +01002054 status = psa_asymmetric_encrypt( handle, exercise_alg,
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02002055 NULL, 0,
2056 NULL, 0,
2057 buffer, buffer_length,
2058 &output_length );
2059 if( policy_alg == exercise_alg &&
2060 ( policy_usage & PSA_KEY_USAGE_ENCRYPT ) != 0 )
Gilles Peskine8817f612018-12-18 00:18:46 +01002061 PSA_ASSERT( status );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02002062 else
Gilles Peskinefe11b722018-12-18 00:24:04 +01002063 TEST_EQUAL( status, PSA_ERROR_NOT_PERMITTED );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02002064
Gilles Peskinef7ab5ad2018-09-26 18:19:24 +02002065 if( buffer_length != 0 )
2066 memset( buffer, 0, buffer_length );
Gilles Peskinebdf309c2018-12-03 15:36:32 +01002067 status = psa_asymmetric_decrypt( handle, exercise_alg,
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02002068 buffer, buffer_length,
2069 NULL, 0,
2070 buffer, buffer_length,
2071 &output_length );
2072 if( policy_alg == exercise_alg &&
2073 ( policy_usage & PSA_KEY_USAGE_DECRYPT ) != 0 )
Gilles Peskinefe11b722018-12-18 00:24:04 +01002074 TEST_EQUAL( status, PSA_ERROR_INVALID_PADDING );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02002075 else
Gilles Peskinefe11b722018-12-18 00:24:04 +01002076 TEST_EQUAL( status, PSA_ERROR_NOT_PERMITTED );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02002077
2078exit:
Gilles Peskinebdf309c2018-12-03 15:36:32 +01002079 psa_destroy_key( handle );
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02002080 psa_reset_key_attributes( &attributes );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02002081 PSA_DONE( );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02002082 mbedtls_free( buffer );
2083}
2084/* END_CASE */
2085
2086/* BEGIN_CASE */
2087void asymmetric_signature_key_policy( int policy_usage,
2088 int policy_alg,
2089 int key_type,
2090 data_t *key_data,
Gilles Peskine30f77cd2019-01-14 16:06:39 +01002091 int exercise_alg,
2092 int payload_length_arg )
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02002093{
Gilles Peskinebdf309c2018-12-03 15:36:32 +01002094 psa_key_handle_t handle = 0;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02002095 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02002096 psa_status_t status;
Gilles Peskine30f77cd2019-01-14 16:06:39 +01002097 unsigned char payload[PSA_HASH_MAX_SIZE] = {1};
2098 /* If `payload_length_arg > 0`, `exercise_alg` is supposed to be
2099 * compatible with the policy and `payload_length_arg` is supposed to be
2100 * a valid input length to sign. If `payload_length_arg <= 0`,
2101 * `exercise_alg` is supposed to be forbidden by the policy. */
2102 int compatible_alg = payload_length_arg > 0;
2103 size_t payload_length = compatible_alg ? payload_length_arg : 0;
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01002104 unsigned char signature[PSA_SIGNATURE_MAX_SIZE] = {0};
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02002105 size_t signature_length;
2106
Gilles Peskine8817f612018-12-18 00:18:46 +01002107 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02002108
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02002109 psa_set_key_usage_flags( &attributes, policy_usage );
2110 psa_set_key_algorithm( &attributes, policy_alg );
2111 psa_set_key_type( &attributes, key_type );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02002112
Gilles Peskine049c7532019-05-15 20:22:09 +02002113 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
2114 &handle ) );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02002115
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01002116 status = psa_sign_hash( handle, exercise_alg,
2117 payload, payload_length,
2118 signature, sizeof( signature ),
2119 &signature_length );
2120 if( compatible_alg && ( policy_usage & PSA_KEY_USAGE_SIGN_HASH ) != 0 )
Gilles Peskine8817f612018-12-18 00:18:46 +01002121 PSA_ASSERT( status );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02002122 else
Gilles Peskinefe11b722018-12-18 00:24:04 +01002123 TEST_EQUAL( status, PSA_ERROR_NOT_PERMITTED );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02002124
2125 memset( signature, 0, sizeof( signature ) );
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01002126 status = psa_verify_hash( handle, exercise_alg,
2127 payload, payload_length,
2128 signature, sizeof( signature ) );
2129 if( compatible_alg && ( policy_usage & PSA_KEY_USAGE_VERIFY_HASH ) != 0 )
Gilles Peskinefe11b722018-12-18 00:24:04 +01002130 TEST_EQUAL( status, PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02002131 else
Gilles Peskinefe11b722018-12-18 00:24:04 +01002132 TEST_EQUAL( status, PSA_ERROR_NOT_PERMITTED );
Gilles Peskined5b33222018-06-18 22:20:03 +02002133
2134exit:
Gilles Peskinebdf309c2018-12-03 15:36:32 +01002135 psa_destroy_key( handle );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02002136 PSA_DONE( );
Gilles Peskined5b33222018-06-18 22:20:03 +02002137}
2138/* END_CASE */
2139
Janos Follathba3fab92019-06-11 14:50:16 +01002140/* BEGIN_CASE */
Gilles Peskineea0fb492018-07-12 17:17:20 +02002141void derive_key_policy( int policy_usage,
2142 int policy_alg,
2143 int key_type,
2144 data_t *key_data,
2145 int exercise_alg )
2146{
Gilles Peskinebdf309c2018-12-03 15:36:32 +01002147 psa_key_handle_t handle = 0;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02002148 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02002149 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Gilles Peskineea0fb492018-07-12 17:17:20 +02002150 psa_status_t status;
2151
Gilles Peskine8817f612018-12-18 00:18:46 +01002152 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskineea0fb492018-07-12 17:17:20 +02002153
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02002154 psa_set_key_usage_flags( &attributes, policy_usage );
2155 psa_set_key_algorithm( &attributes, policy_alg );
2156 psa_set_key_type( &attributes, key_type );
Gilles Peskineea0fb492018-07-12 17:17:20 +02002157
Gilles Peskine049c7532019-05-15 20:22:09 +02002158 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
2159 &handle ) );
Gilles Peskineea0fb492018-07-12 17:17:20 +02002160
Janos Follathba3fab92019-06-11 14:50:16 +01002161 PSA_ASSERT( psa_key_derivation_setup( &operation, exercise_alg ) );
2162
2163 if( PSA_ALG_IS_TLS12_PRF( exercise_alg ) ||
2164 PSA_ALG_IS_TLS12_PSK_TO_MS( exercise_alg ) )
Janos Follath0c1ed842019-06-28 13:35:36 +01002165 {
Janos Follathba3fab92019-06-11 14:50:16 +01002166 PSA_ASSERT( psa_key_derivation_input_bytes(
2167 &operation,
2168 PSA_KEY_DERIVATION_INPUT_SEED,
2169 (const uint8_t*) "", 0) );
Janos Follath0c1ed842019-06-28 13:35:36 +01002170 }
Janos Follathba3fab92019-06-11 14:50:16 +01002171
2172 status = psa_key_derivation_input_key( &operation,
2173 PSA_KEY_DERIVATION_INPUT_SECRET,
2174 handle );
2175
Gilles Peskineea0fb492018-07-12 17:17:20 +02002176 if( policy_alg == exercise_alg &&
2177 ( policy_usage & PSA_KEY_USAGE_DERIVE ) != 0 )
Gilles Peskine8817f612018-12-18 00:18:46 +01002178 PSA_ASSERT( status );
Gilles Peskineea0fb492018-07-12 17:17:20 +02002179 else
Gilles Peskinefe11b722018-12-18 00:24:04 +01002180 TEST_EQUAL( status, PSA_ERROR_NOT_PERMITTED );
Gilles Peskineea0fb492018-07-12 17:17:20 +02002181
2182exit:
Gilles Peskine51ae0e42019-05-16 17:31:03 +02002183 psa_key_derivation_abort( &operation );
Gilles Peskinebdf309c2018-12-03 15:36:32 +01002184 psa_destroy_key( handle );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02002185 PSA_DONE( );
Gilles Peskineea0fb492018-07-12 17:17:20 +02002186}
2187/* END_CASE */
2188
2189/* BEGIN_CASE */
Gilles Peskine01d718c2018-09-18 12:01:02 +02002190void agreement_key_policy( int policy_usage,
2191 int policy_alg,
2192 int key_type_arg,
2193 data_t *key_data,
2194 int exercise_alg )
2195{
Gilles Peskinebdf309c2018-12-03 15:36:32 +01002196 psa_key_handle_t handle = 0;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02002197 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine01d718c2018-09-18 12:01:02 +02002198 psa_key_type_t key_type = key_type_arg;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02002199 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Gilles Peskine01d718c2018-09-18 12:01:02 +02002200 psa_status_t status;
2201
Gilles Peskine8817f612018-12-18 00:18:46 +01002202 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine01d718c2018-09-18 12:01:02 +02002203
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02002204 psa_set_key_usage_flags( &attributes, policy_usage );
2205 psa_set_key_algorithm( &attributes, policy_alg );
2206 psa_set_key_type( &attributes, key_type );
Gilles Peskine01d718c2018-09-18 12:01:02 +02002207
Gilles Peskine049c7532019-05-15 20:22:09 +02002208 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
2209 &handle ) );
Gilles Peskine01d718c2018-09-18 12:01:02 +02002210
Gilles Peskine51ae0e42019-05-16 17:31:03 +02002211 PSA_ASSERT( psa_key_derivation_setup( &operation, exercise_alg ) );
2212 status = key_agreement_with_self( &operation, handle );
Gilles Peskine01d718c2018-09-18 12:01:02 +02002213
Gilles Peskine01d718c2018-09-18 12:01:02 +02002214 if( policy_alg == exercise_alg &&
2215 ( policy_usage & PSA_KEY_USAGE_DERIVE ) != 0 )
Gilles Peskine8817f612018-12-18 00:18:46 +01002216 PSA_ASSERT( status );
Gilles Peskine01d718c2018-09-18 12:01:02 +02002217 else
Gilles Peskinefe11b722018-12-18 00:24:04 +01002218 TEST_EQUAL( status, PSA_ERROR_NOT_PERMITTED );
Gilles Peskine01d718c2018-09-18 12:01:02 +02002219
2220exit:
Gilles Peskine51ae0e42019-05-16 17:31:03 +02002221 psa_key_derivation_abort( &operation );
Gilles Peskinebdf309c2018-12-03 15:36:32 +01002222 psa_destroy_key( handle );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02002223 PSA_DONE( );
Gilles Peskine01d718c2018-09-18 12:01:02 +02002224}
2225/* END_CASE */
2226
2227/* BEGIN_CASE */
Gilles Peskine96f0b3b2019-05-10 19:33:38 +02002228void key_policy_alg2( int key_type_arg, data_t *key_data,
2229 int usage_arg, int alg_arg, int alg2_arg )
2230{
2231 psa_key_handle_t handle = 0;
2232 psa_key_type_t key_type = key_type_arg;
2233 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
2234 psa_key_attributes_t got_attributes = PSA_KEY_ATTRIBUTES_INIT;
2235 psa_key_usage_t usage = usage_arg;
2236 psa_algorithm_t alg = alg_arg;
2237 psa_algorithm_t alg2 = alg2_arg;
2238
2239 PSA_ASSERT( psa_crypto_init( ) );
2240
2241 psa_set_key_usage_flags( &attributes, usage );
2242 psa_set_key_algorithm( &attributes, alg );
2243 psa_set_key_enrollment_algorithm( &attributes, alg2 );
2244 psa_set_key_type( &attributes, key_type );
2245 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
2246 &handle ) );
2247
2248 PSA_ASSERT( psa_get_key_attributes( handle, &got_attributes ) );
2249 TEST_EQUAL( psa_get_key_usage_flags( &got_attributes ), usage );
2250 TEST_EQUAL( psa_get_key_algorithm( &got_attributes ), alg );
2251 TEST_EQUAL( psa_get_key_enrollment_algorithm( &got_attributes ), alg2 );
2252
2253 if( ! exercise_key( handle, usage, alg ) )
2254 goto exit;
2255 if( ! exercise_key( handle, usage, alg2 ) )
2256 goto exit;
2257
2258exit:
2259 psa_destroy_key( handle );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02002260 PSA_DONE( );
Gilles Peskine96f0b3b2019-05-10 19:33:38 +02002261}
2262/* END_CASE */
2263
2264/* BEGIN_CASE */
Gilles Peskine04ee2d22019-04-11 21:25:46 +02002265void raw_agreement_key_policy( int policy_usage,
2266 int policy_alg,
2267 int key_type_arg,
2268 data_t *key_data,
2269 int exercise_alg )
2270{
2271 psa_key_handle_t handle = 0;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02002272 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine04ee2d22019-04-11 21:25:46 +02002273 psa_key_type_t key_type = key_type_arg;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02002274 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Gilles Peskine04ee2d22019-04-11 21:25:46 +02002275 psa_status_t status;
2276
2277 PSA_ASSERT( psa_crypto_init( ) );
2278
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02002279 psa_set_key_usage_flags( &attributes, policy_usage );
2280 psa_set_key_algorithm( &attributes, policy_alg );
2281 psa_set_key_type( &attributes, key_type );
Gilles Peskine04ee2d22019-04-11 21:25:46 +02002282
Gilles Peskine049c7532019-05-15 20:22:09 +02002283 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
2284 &handle ) );
Gilles Peskine04ee2d22019-04-11 21:25:46 +02002285
2286 status = raw_key_agreement_with_self( exercise_alg, handle );
2287
2288 if( policy_alg == exercise_alg &&
2289 ( policy_usage & PSA_KEY_USAGE_DERIVE ) != 0 )
2290 PSA_ASSERT( status );
2291 else
2292 TEST_EQUAL( status, PSA_ERROR_NOT_PERMITTED );
2293
2294exit:
Gilles Peskine51ae0e42019-05-16 17:31:03 +02002295 psa_key_derivation_abort( &operation );
Gilles Peskine04ee2d22019-04-11 21:25:46 +02002296 psa_destroy_key( handle );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02002297 PSA_DONE( );
Gilles Peskine04ee2d22019-04-11 21:25:46 +02002298}
2299/* END_CASE */
2300
2301/* BEGIN_CASE */
Gilles Peskinebcdd44b2019-05-20 17:28:11 +02002302void copy_success( int source_usage_arg,
2303 int source_alg_arg, int source_alg2_arg,
Gilles Peskine4a644642019-05-03 17:14:08 +02002304 int type_arg, data_t *material,
2305 int copy_attributes,
Gilles Peskinebcdd44b2019-05-20 17:28:11 +02002306 int target_usage_arg,
2307 int target_alg_arg, int target_alg2_arg,
2308 int expected_usage_arg,
2309 int expected_alg_arg, int expected_alg2_arg )
Gilles Peskine57ab7212019-01-28 13:03:09 +01002310{
Gilles Peskineca25db92019-04-19 11:43:08 +02002311 psa_key_attributes_t source_attributes = PSA_KEY_ATTRIBUTES_INIT;
2312 psa_key_attributes_t target_attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine57ab7212019-01-28 13:03:09 +01002313 psa_key_usage_t expected_usage = expected_usage_arg;
2314 psa_algorithm_t expected_alg = expected_alg_arg;
Gilles Peskinebcdd44b2019-05-20 17:28:11 +02002315 psa_algorithm_t expected_alg2 = expected_alg2_arg;
Gilles Peskineca25db92019-04-19 11:43:08 +02002316 psa_key_handle_t source_handle = 0;
2317 psa_key_handle_t target_handle = 0;
Gilles Peskine57ab7212019-01-28 13:03:09 +01002318 uint8_t *export_buffer = NULL;
2319
Gilles Peskine57ab7212019-01-28 13:03:09 +01002320 PSA_ASSERT( psa_crypto_init( ) );
2321
Gilles Peskineca25db92019-04-19 11:43:08 +02002322 /* Prepare the source key. */
2323 psa_set_key_usage_flags( &source_attributes, source_usage_arg );
2324 psa_set_key_algorithm( &source_attributes, source_alg_arg );
Gilles Peskinebcdd44b2019-05-20 17:28:11 +02002325 psa_set_key_enrollment_algorithm( &source_attributes, source_alg2_arg );
Gilles Peskineca25db92019-04-19 11:43:08 +02002326 psa_set_key_type( &source_attributes, type_arg );
Gilles Peskine049c7532019-05-15 20:22:09 +02002327 PSA_ASSERT( psa_import_key( &source_attributes,
2328 material->x, material->len,
2329 &source_handle ) );
Gilles Peskineca25db92019-04-19 11:43:08 +02002330 PSA_ASSERT( psa_get_key_attributes( source_handle, &source_attributes ) );
Gilles Peskine57ab7212019-01-28 13:03:09 +01002331
Gilles Peskineca25db92019-04-19 11:43:08 +02002332 /* Prepare the target attributes. */
2333 if( copy_attributes )
2334 target_attributes = source_attributes;
2335 if( target_usage_arg != -1 )
2336 psa_set_key_usage_flags( &target_attributes, target_usage_arg );
2337 if( target_alg_arg != -1 )
2338 psa_set_key_algorithm( &target_attributes, target_alg_arg );
Gilles Peskinebcdd44b2019-05-20 17:28:11 +02002339 if( target_alg2_arg != -1 )
2340 psa_set_key_enrollment_algorithm( &target_attributes, target_alg2_arg );
Gilles Peskine57ab7212019-01-28 13:03:09 +01002341
2342 /* Copy the key. */
Gilles Peskine4a644642019-05-03 17:14:08 +02002343 PSA_ASSERT( psa_copy_key( source_handle,
2344 &target_attributes, &target_handle ) );
Gilles Peskine57ab7212019-01-28 13:03:09 +01002345
2346 /* Destroy the source to ensure that this doesn't affect the target. */
2347 PSA_ASSERT( psa_destroy_key( source_handle ) );
2348
2349 /* Test that the target slot has the expected content and policy. */
Gilles Peskineca25db92019-04-19 11:43:08 +02002350 PSA_ASSERT( psa_get_key_attributes( target_handle, &target_attributes ) );
2351 TEST_EQUAL( psa_get_key_type( &source_attributes ),
2352 psa_get_key_type( &target_attributes ) );
2353 TEST_EQUAL( psa_get_key_bits( &source_attributes ),
2354 psa_get_key_bits( &target_attributes ) );
2355 TEST_EQUAL( expected_usage, psa_get_key_usage_flags( &target_attributes ) );
2356 TEST_EQUAL( expected_alg, psa_get_key_algorithm( &target_attributes ) );
Gilles Peskinebcdd44b2019-05-20 17:28:11 +02002357 TEST_EQUAL( expected_alg2,
2358 psa_get_key_enrollment_algorithm( &target_attributes ) );
Gilles Peskine57ab7212019-01-28 13:03:09 +01002359 if( expected_usage & PSA_KEY_USAGE_EXPORT )
2360 {
2361 size_t length;
2362 ASSERT_ALLOC( export_buffer, material->len );
2363 PSA_ASSERT( psa_export_key( target_handle, export_buffer,
2364 material->len, &length ) );
2365 ASSERT_COMPARE( material->x, material->len,
2366 export_buffer, length );
2367 }
2368 if( ! exercise_key( target_handle, expected_usage, expected_alg ) )
2369 goto exit;
Gilles Peskinebcdd44b2019-05-20 17:28:11 +02002370 if( ! exercise_key( target_handle, expected_usage, expected_alg2 ) )
2371 goto exit;
Gilles Peskine57ab7212019-01-28 13:03:09 +01002372
2373 PSA_ASSERT( psa_close_key( target_handle ) );
2374
2375exit:
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02002376 psa_reset_key_attributes( &source_attributes );
2377 psa_reset_key_attributes( &target_attributes );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02002378 PSA_DONE( );
Gilles Peskine57ab7212019-01-28 13:03:09 +01002379 mbedtls_free( export_buffer );
2380}
2381/* END_CASE */
2382
2383/* BEGIN_CASE */
Gilles Peskinebcdd44b2019-05-20 17:28:11 +02002384void copy_fail( int source_usage_arg,
2385 int source_alg_arg, int source_alg2_arg,
Gilles Peskine4a644642019-05-03 17:14:08 +02002386 int type_arg, data_t *material,
2387 int target_type_arg, int target_bits_arg,
Gilles Peskinebcdd44b2019-05-20 17:28:11 +02002388 int target_usage_arg,
2389 int target_alg_arg, int target_alg2_arg,
Gilles Peskine4a644642019-05-03 17:14:08 +02002390 int expected_status_arg )
2391{
2392 psa_key_attributes_t source_attributes = PSA_KEY_ATTRIBUTES_INIT;
2393 psa_key_attributes_t target_attributes = PSA_KEY_ATTRIBUTES_INIT;
2394 psa_key_handle_t source_handle = 0;
2395 psa_key_handle_t target_handle = 0;
2396
2397 PSA_ASSERT( psa_crypto_init( ) );
2398
2399 /* Prepare the source key. */
2400 psa_set_key_usage_flags( &source_attributes, source_usage_arg );
2401 psa_set_key_algorithm( &source_attributes, source_alg_arg );
Gilles Peskinebcdd44b2019-05-20 17:28:11 +02002402 psa_set_key_enrollment_algorithm( &source_attributes, source_alg2_arg );
Gilles Peskine4a644642019-05-03 17:14:08 +02002403 psa_set_key_type( &source_attributes, type_arg );
Gilles Peskine049c7532019-05-15 20:22:09 +02002404 PSA_ASSERT( psa_import_key( &source_attributes,
2405 material->x, material->len,
2406 &source_handle ) );
Gilles Peskine4a644642019-05-03 17:14:08 +02002407
2408 /* Prepare the target attributes. */
2409 psa_set_key_type( &target_attributes, target_type_arg );
2410 psa_set_key_bits( &target_attributes, target_bits_arg );
2411 psa_set_key_usage_flags( &target_attributes, target_usage_arg );
2412 psa_set_key_algorithm( &target_attributes, target_alg_arg );
Gilles Peskinebcdd44b2019-05-20 17:28:11 +02002413 psa_set_key_enrollment_algorithm( &target_attributes, target_alg2_arg );
Gilles Peskine4a644642019-05-03 17:14:08 +02002414
2415 /* Try to copy the key. */
2416 TEST_EQUAL( psa_copy_key( source_handle,
2417 &target_attributes, &target_handle ),
2418 expected_status_arg );
Gilles Peskine76b29a72019-05-28 14:08:50 +02002419
2420 PSA_ASSERT( psa_destroy_key( source_handle ) );
2421
Gilles Peskine4a644642019-05-03 17:14:08 +02002422exit:
2423 psa_reset_key_attributes( &source_attributes );
2424 psa_reset_key_attributes( &target_attributes );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02002425 PSA_DONE( );
Gilles Peskine4a644642019-05-03 17:14:08 +02002426}
2427/* END_CASE */
2428
2429/* BEGIN_CASE */
Jaeden Amero6a25b412019-01-04 11:47:44 +00002430void hash_operation_init( )
2431{
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002432 const uint8_t input[1] = { 0 };
Jaeden Amero6a25b412019-01-04 11:47:44 +00002433 /* Test each valid way of initializing the object, except for `= {0}`, as
2434 * Clang 5 complains when `-Wmissing-field-initializers` is used, even
2435 * though it's OK by the C standard. We could test for this, but we'd need
2436 * to supress the Clang warning for the test. */
2437 psa_hash_operation_t func = psa_hash_operation_init( );
2438 psa_hash_operation_t init = PSA_HASH_OPERATION_INIT;
2439 psa_hash_operation_t zero;
2440
2441 memset( &zero, 0, sizeof( zero ) );
2442
Jaeden Amero11aa7ee2019-02-19 11:44:55 +00002443 /* A freshly-initialized hash operation should not be usable. */
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002444 TEST_EQUAL( psa_hash_update( &func, input, sizeof( input ) ),
2445 PSA_ERROR_BAD_STATE );
2446 TEST_EQUAL( psa_hash_update( &init, input, sizeof( input ) ),
2447 PSA_ERROR_BAD_STATE );
2448 TEST_EQUAL( psa_hash_update( &zero, input, sizeof( input ) ),
2449 PSA_ERROR_BAD_STATE );
2450
Jaeden Amero5229bbb2019-02-07 16:33:37 +00002451 /* A default hash operation should be abortable without error. */
2452 PSA_ASSERT( psa_hash_abort( &func ) );
2453 PSA_ASSERT( psa_hash_abort( &init ) );
2454 PSA_ASSERT( psa_hash_abort( &zero ) );
Jaeden Amero6a25b412019-01-04 11:47:44 +00002455}
2456/* END_CASE */
2457
2458/* BEGIN_CASE */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002459void hash_setup( int alg_arg,
2460 int expected_status_arg )
2461{
2462 psa_algorithm_t alg = alg_arg;
Gilles Peskineb866e2b2018-06-21 09:25:10 +02002463 psa_status_t expected_status = expected_status_arg;
Jaeden Amero6a25b412019-01-04 11:47:44 +00002464 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002465 psa_status_t status;
2466
Gilles Peskine8817f612018-12-18 00:18:46 +01002467 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002468
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002469 status = psa_hash_setup( &operation, alg );
Gilles Peskinefe11b722018-12-18 00:24:04 +01002470 TEST_EQUAL( status, expected_status );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002471
Gilles Peskine9e0a4a52019-02-25 22:11:18 +01002472 /* Whether setup succeeded or failed, abort must succeed. */
2473 PSA_ASSERT( psa_hash_abort( &operation ) );
2474
2475 /* If setup failed, reproduce the failure, so as to
2476 * test the resulting state of the operation object. */
2477 if( status != PSA_SUCCESS )
2478 TEST_EQUAL( psa_hash_setup( &operation, alg ), status );
2479
Gilles Peskinef426e0f2019-02-25 17:42:03 +01002480 /* Now the operation object should be reusable. */
2481#if defined(KNOWN_SUPPORTED_HASH_ALG)
2482 PSA_ASSERT( psa_hash_setup( &operation, KNOWN_SUPPORTED_HASH_ALG ) );
2483 PSA_ASSERT( psa_hash_abort( &operation ) );
2484#endif
2485
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002486exit:
Gilles Peskine1153e7b2019-05-28 15:10:21 +02002487 PSA_DONE( );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002488}
2489/* END_CASE */
2490
2491/* BEGIN_CASE */
Gilles Peskine0a749c82019-11-28 19:33:58 +01002492void hash_compute_fail( int alg_arg, data_t *input,
2493 int output_size_arg, int expected_status_arg )
2494{
2495 psa_algorithm_t alg = alg_arg;
2496 uint8_t *output = NULL;
2497 size_t output_size = output_size_arg;
2498 size_t output_length = INVALID_EXPORT_LENGTH;
2499 psa_status_t expected_status = expected_status_arg;
2500 psa_status_t status;
2501
2502 ASSERT_ALLOC( output, output_size );
2503
2504 PSA_ASSERT( psa_crypto_init( ) );
2505
2506 status = psa_hash_compute( alg, input->x, input->len,
2507 output, output_size, &output_length );
2508 TEST_EQUAL( status, expected_status );
2509 TEST_ASSERT( output_length <= output_size );
2510
2511exit:
2512 mbedtls_free( output );
2513 PSA_DONE( );
2514}
2515/* END_CASE */
2516
2517/* BEGIN_CASE */
Gilles Peskine88e08462020-01-28 20:43:00 +01002518void hash_compare_fail( int alg_arg, data_t *input,
2519 data_t *reference_hash,
2520 int expected_status_arg )
2521{
2522 psa_algorithm_t alg = alg_arg;
2523 psa_status_t expected_status = expected_status_arg;
2524 psa_status_t status;
2525
2526 PSA_ASSERT( psa_crypto_init( ) );
2527
2528 status = psa_hash_compare( alg, input->x, input->len,
2529 reference_hash->x, reference_hash->len );
2530 TEST_EQUAL( status, expected_status );
2531
2532exit:
2533 PSA_DONE( );
2534}
2535/* END_CASE */
2536
2537/* BEGIN_CASE */
Gilles Peskine0a749c82019-11-28 19:33:58 +01002538void hash_compute_compare( int alg_arg, data_t *input,
2539 data_t *expected_output )
2540{
2541 psa_algorithm_t alg = alg_arg;
2542 uint8_t output[PSA_HASH_MAX_SIZE + 1];
2543 size_t output_length = INVALID_EXPORT_LENGTH;
2544 size_t i;
2545
2546 PSA_ASSERT( psa_crypto_init( ) );
2547
2548 /* Compute with tight buffer */
2549 PSA_ASSERT( psa_hash_compute( alg, input->x, input->len,
2550 output, PSA_HASH_SIZE( alg ),
2551 &output_length ) );
2552 TEST_EQUAL( output_length, PSA_HASH_SIZE( alg ) );
2553 ASSERT_COMPARE( output, output_length,
2554 expected_output->x, expected_output->len );
2555
2556 /* Compute with larger buffer */
2557 PSA_ASSERT( psa_hash_compute( alg, input->x, input->len,
2558 output, sizeof( output ),
2559 &output_length ) );
2560 TEST_EQUAL( output_length, PSA_HASH_SIZE( alg ) );
2561 ASSERT_COMPARE( output, output_length,
2562 expected_output->x, expected_output->len );
2563
2564 /* Compare with correct hash */
2565 PSA_ASSERT( psa_hash_compare( alg, input->x, input->len,
2566 output, output_length ) );
2567
2568 /* Compare with trailing garbage */
2569 TEST_EQUAL( psa_hash_compare( alg, input->x, input->len,
2570 output, output_length + 1 ),
2571 PSA_ERROR_INVALID_SIGNATURE );
2572
2573 /* Compare with truncated hash */
2574 TEST_EQUAL( psa_hash_compare( alg, input->x, input->len,
2575 output, output_length - 1 ),
2576 PSA_ERROR_INVALID_SIGNATURE );
2577
2578 /* Compare with corrupted value */
2579 for( i = 0; i < output_length; i++ )
2580 {
2581 test_set_step( i );
2582 output[i] ^= 1;
2583 TEST_EQUAL( psa_hash_compare( alg, input->x, input->len,
2584 output, output_length ),
2585 PSA_ERROR_INVALID_SIGNATURE );
2586 output[i] ^= 1;
2587 }
2588
2589exit:
2590 PSA_DONE( );
2591}
2592/* END_CASE */
2593
2594/* BEGIN_CASE */
itayzafrirf86548d2018-11-01 10:44:32 +02002595void hash_bad_order( )
2596{
Jaeden Amero11aa7ee2019-02-19 11:44:55 +00002597 psa_algorithm_t alg = PSA_ALG_SHA_256;
itayzafrirf86548d2018-11-01 10:44:32 +02002598 unsigned char input[] = "";
2599 /* SHA-256 hash of an empty string */
Jaeden Amero11aa7ee2019-02-19 11:44:55 +00002600 const unsigned char valid_hash[] = {
itayzafrirf86548d2018-11-01 10:44:32 +02002601 0xe3, 0xb0, 0xc4, 0x42, 0x98, 0xfc, 0x1c, 0x14, 0x9a, 0xfb, 0xf4, 0xc8,
2602 0x99, 0x6f, 0xb9, 0x24, 0x27, 0xae, 0x41, 0xe4, 0x64, 0x9b, 0x93, 0x4c,
2603 0xa4, 0x95, 0x99, 0x1b, 0x78, 0x52, 0xb8, 0x55 };
Jaeden Amero11aa7ee2019-02-19 11:44:55 +00002604 unsigned char hash[sizeof(valid_hash)] = { 0 };
itayzafrirf86548d2018-11-01 10:44:32 +02002605 size_t hash_len;
Jaeden Amero6a25b412019-01-04 11:47:44 +00002606 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
itayzafrirf86548d2018-11-01 10:44:32 +02002607
Gilles Peskine8817f612018-12-18 00:18:46 +01002608 PSA_ASSERT( psa_crypto_init( ) );
itayzafrirf86548d2018-11-01 10:44:32 +02002609
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002610 /* Call setup twice in a row. */
2611 PSA_ASSERT( psa_hash_setup( &operation, alg ) );
2612 TEST_EQUAL( psa_hash_setup( &operation, alg ),
2613 PSA_ERROR_BAD_STATE );
2614 PSA_ASSERT( psa_hash_abort( &operation ) );
2615
Jaeden Amero11aa7ee2019-02-19 11:44:55 +00002616 /* Call update without calling setup beforehand. */
Gilles Peskinef812dcf2018-12-18 00:33:25 +01002617 TEST_EQUAL( psa_hash_update( &operation, input, sizeof( input ) ),
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002618 PSA_ERROR_BAD_STATE );
Jaeden Amero11aa7ee2019-02-19 11:44:55 +00002619 PSA_ASSERT( psa_hash_abort( &operation ) );
itayzafrirf86548d2018-11-01 10:44:32 +02002620
Jaeden Amero11aa7ee2019-02-19 11:44:55 +00002621 /* Call update after finish. */
2622 PSA_ASSERT( psa_hash_setup( &operation, alg ) );
2623 PSA_ASSERT( psa_hash_finish( &operation,
2624 hash, sizeof( hash ), &hash_len ) );
2625 TEST_EQUAL( psa_hash_update( &operation, input, sizeof( input ) ),
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002626 PSA_ERROR_BAD_STATE );
Jaeden Amero11aa7ee2019-02-19 11:44:55 +00002627 PSA_ASSERT( psa_hash_abort( &operation ) );
itayzafrirf86548d2018-11-01 10:44:32 +02002628
Jaeden Amero11aa7ee2019-02-19 11:44:55 +00002629 /* Call verify without calling setup beforehand. */
2630 TEST_EQUAL( psa_hash_verify( &operation,
2631 valid_hash, sizeof( valid_hash ) ),
2632 PSA_ERROR_BAD_STATE );
2633 PSA_ASSERT( psa_hash_abort( &operation ) );
2634
2635 /* Call verify after finish. */
2636 PSA_ASSERT( psa_hash_setup( &operation, alg ) );
2637 PSA_ASSERT( psa_hash_finish( &operation,
2638 hash, sizeof( hash ), &hash_len ) );
2639 TEST_EQUAL( psa_hash_verify( &operation,
2640 valid_hash, sizeof( valid_hash ) ),
2641 PSA_ERROR_BAD_STATE );
2642 PSA_ASSERT( psa_hash_abort( &operation ) );
2643
2644 /* Call verify twice in a row. */
2645 PSA_ASSERT( psa_hash_setup( &operation, alg ) );
2646 PSA_ASSERT( psa_hash_verify( &operation,
2647 valid_hash, sizeof( valid_hash ) ) );
2648 TEST_EQUAL( psa_hash_verify( &operation,
2649 valid_hash, sizeof( valid_hash ) ),
2650 PSA_ERROR_BAD_STATE );
2651 PSA_ASSERT( psa_hash_abort( &operation ) );
2652
2653 /* Call finish without calling setup beforehand. */
Gilles Peskinefe11b722018-12-18 00:24:04 +01002654 TEST_EQUAL( psa_hash_finish( &operation,
2655 hash, sizeof( hash ), &hash_len ),
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002656 PSA_ERROR_BAD_STATE );
Jaeden Amero11aa7ee2019-02-19 11:44:55 +00002657 PSA_ASSERT( psa_hash_abort( &operation ) );
2658
2659 /* Call finish twice in a row. */
2660 PSA_ASSERT( psa_hash_setup( &operation, alg ) );
2661 PSA_ASSERT( psa_hash_finish( &operation,
2662 hash, sizeof( hash ), &hash_len ) );
2663 TEST_EQUAL( psa_hash_finish( &operation,
2664 hash, sizeof( hash ), &hash_len ),
2665 PSA_ERROR_BAD_STATE );
2666 PSA_ASSERT( psa_hash_abort( &operation ) );
2667
2668 /* Call finish after calling verify. */
2669 PSA_ASSERT( psa_hash_setup( &operation, alg ) );
2670 PSA_ASSERT( psa_hash_verify( &operation,
2671 valid_hash, sizeof( valid_hash ) ) );
2672 TEST_EQUAL( psa_hash_finish( &operation,
2673 hash, sizeof( hash ), &hash_len ),
2674 PSA_ERROR_BAD_STATE );
2675 PSA_ASSERT( psa_hash_abort( &operation ) );
itayzafrirf86548d2018-11-01 10:44:32 +02002676
2677exit:
Gilles Peskine1153e7b2019-05-28 15:10:21 +02002678 PSA_DONE( );
itayzafrirf86548d2018-11-01 10:44:32 +02002679}
2680/* END_CASE */
2681
itayzafrir27e69452018-11-01 14:26:34 +02002682/* BEGIN_CASE depends_on:MBEDTLS_SHA256_C */
2683void hash_verify_bad_args( )
itayzafrirec93d302018-10-18 18:01:10 +03002684{
2685 psa_algorithm_t alg = PSA_ALG_SHA_256;
itayzafrir27e69452018-11-01 14:26:34 +02002686 /* SHA-256 hash of an empty string with 2 extra bytes (0xaa and 0xbb)
2687 * appended to it */
2688 unsigned char hash[] = {
2689 0xe3, 0xb0, 0xc4, 0x42, 0x98, 0xfc, 0x1c, 0x14, 0x9a, 0xfb, 0xf4, 0xc8,
2690 0x99, 0x6f, 0xb9, 0x24, 0x27, 0xae, 0x41, 0xe4, 0x64, 0x9b, 0x93, 0x4c,
2691 0xa4, 0x95, 0x99, 0x1b, 0x78, 0x52, 0xb8, 0x55, 0xaa, 0xbb };
itayzafrirec93d302018-10-18 18:01:10 +03002692 size_t expected_size = PSA_HASH_SIZE( alg );
Jaeden Amero6a25b412019-01-04 11:47:44 +00002693 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
itayzafrirec93d302018-10-18 18:01:10 +03002694
Gilles Peskine8817f612018-12-18 00:18:46 +01002695 PSA_ASSERT( psa_crypto_init( ) );
itayzafrirec93d302018-10-18 18:01:10 +03002696
itayzafrir27e69452018-11-01 14:26:34 +02002697 /* psa_hash_verify with a smaller hash than expected */
Gilles Peskine8817f612018-12-18 00:18:46 +01002698 PSA_ASSERT( psa_hash_setup( &operation, alg ) );
Gilles Peskinef812dcf2018-12-18 00:33:25 +01002699 TEST_EQUAL( psa_hash_verify( &operation, hash, expected_size - 1 ),
Gilles Peskinefe11b722018-12-18 00:24:04 +01002700 PSA_ERROR_INVALID_SIGNATURE );
itayzafrirec93d302018-10-18 18:01:10 +03002701
itayzafrir27e69452018-11-01 14:26:34 +02002702 /* psa_hash_verify with a non-matching hash */
Gilles Peskine8817f612018-12-18 00:18:46 +01002703 PSA_ASSERT( psa_hash_setup( &operation, alg ) );
Gilles Peskinef812dcf2018-12-18 00:33:25 +01002704 TEST_EQUAL( psa_hash_verify( &operation, hash + 1, expected_size ),
Gilles Peskinefe11b722018-12-18 00:24:04 +01002705 PSA_ERROR_INVALID_SIGNATURE );
itayzafrirec93d302018-10-18 18:01:10 +03002706
itayzafrir27e69452018-11-01 14:26:34 +02002707 /* psa_hash_verify with a hash longer than expected */
Gilles Peskine8817f612018-12-18 00:18:46 +01002708 PSA_ASSERT( psa_hash_setup( &operation, alg ) );
Gilles Peskinef812dcf2018-12-18 00:33:25 +01002709 TEST_EQUAL( psa_hash_verify( &operation, hash, sizeof( hash ) ),
Gilles Peskinefe11b722018-12-18 00:24:04 +01002710 PSA_ERROR_INVALID_SIGNATURE );
itayzafrir4271df92018-10-24 18:16:19 +03002711
itayzafrirec93d302018-10-18 18:01:10 +03002712exit:
Gilles Peskine1153e7b2019-05-28 15:10:21 +02002713 PSA_DONE( );
itayzafrirec93d302018-10-18 18:01:10 +03002714}
2715/* END_CASE */
2716
itayzafrirb2dd5ed2018-11-01 11:58:59 +02002717/* BEGIN_CASE depends_on:MBEDTLS_SHA256_C */
2718void hash_finish_bad_args( )
itayzafrir58028322018-10-25 10:22:01 +03002719{
2720 psa_algorithm_t alg = PSA_ALG_SHA_256;
itayzafrirb2dd5ed2018-11-01 11:58:59 +02002721 unsigned char hash[PSA_HASH_MAX_SIZE];
itayzafrir58028322018-10-25 10:22:01 +03002722 size_t expected_size = PSA_HASH_SIZE( alg );
Jaeden Amero6a25b412019-01-04 11:47:44 +00002723 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
itayzafrir58028322018-10-25 10:22:01 +03002724 size_t hash_len;
2725
Gilles Peskine8817f612018-12-18 00:18:46 +01002726 PSA_ASSERT( psa_crypto_init( ) );
itayzafrir58028322018-10-25 10:22:01 +03002727
itayzafrir58028322018-10-25 10:22:01 +03002728 /* psa_hash_finish with a smaller hash buffer than expected */
Gilles Peskine8817f612018-12-18 00:18:46 +01002729 PSA_ASSERT( psa_hash_setup( &operation, alg ) );
Gilles Peskinefe11b722018-12-18 00:24:04 +01002730 TEST_EQUAL( psa_hash_finish( &operation,
Gilles Peskinef812dcf2018-12-18 00:33:25 +01002731 hash, expected_size - 1, &hash_len ),
2732 PSA_ERROR_BUFFER_TOO_SMALL );
itayzafrir58028322018-10-25 10:22:01 +03002733
2734exit:
Gilles Peskine1153e7b2019-05-28 15:10:21 +02002735 PSA_DONE( );
itayzafrir58028322018-10-25 10:22:01 +03002736}
2737/* END_CASE */
2738
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002739/* BEGIN_CASE depends_on:MBEDTLS_SHA256_C */
2740void hash_clone_source_state( )
2741{
2742 psa_algorithm_t alg = PSA_ALG_SHA_256;
2743 unsigned char hash[PSA_HASH_MAX_SIZE];
2744 psa_hash_operation_t op_source = PSA_HASH_OPERATION_INIT;
2745 psa_hash_operation_t op_init = PSA_HASH_OPERATION_INIT;
2746 psa_hash_operation_t op_setup = PSA_HASH_OPERATION_INIT;
2747 psa_hash_operation_t op_finished = PSA_HASH_OPERATION_INIT;
2748 psa_hash_operation_t op_aborted = PSA_HASH_OPERATION_INIT;
2749 size_t hash_len;
2750
2751 PSA_ASSERT( psa_crypto_init( ) );
2752 PSA_ASSERT( psa_hash_setup( &op_source, alg ) );
2753
2754 PSA_ASSERT( psa_hash_setup( &op_setup, alg ) );
2755 PSA_ASSERT( psa_hash_setup( &op_finished, alg ) );
2756 PSA_ASSERT( psa_hash_finish( &op_finished,
2757 hash, sizeof( hash ), &hash_len ) );
2758 PSA_ASSERT( psa_hash_setup( &op_aborted, alg ) );
2759 PSA_ASSERT( psa_hash_abort( &op_aborted ) );
2760
2761 TEST_EQUAL( psa_hash_clone( &op_source, &op_setup ),
2762 PSA_ERROR_BAD_STATE );
2763
2764 PSA_ASSERT( psa_hash_clone( &op_source, &op_init ) );
2765 PSA_ASSERT( psa_hash_finish( &op_init,
2766 hash, sizeof( hash ), &hash_len ) );
2767 PSA_ASSERT( psa_hash_clone( &op_source, &op_finished ) );
2768 PSA_ASSERT( psa_hash_finish( &op_finished,
2769 hash, sizeof( hash ), &hash_len ) );
2770 PSA_ASSERT( psa_hash_clone( &op_source, &op_aborted ) );
2771 PSA_ASSERT( psa_hash_finish( &op_aborted,
2772 hash, sizeof( hash ), &hash_len ) );
2773
2774exit:
2775 psa_hash_abort( &op_source );
2776 psa_hash_abort( &op_init );
2777 psa_hash_abort( &op_setup );
2778 psa_hash_abort( &op_finished );
2779 psa_hash_abort( &op_aborted );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02002780 PSA_DONE( );
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002781}
2782/* END_CASE */
2783
2784/* BEGIN_CASE depends_on:MBEDTLS_SHA256_C */
2785void hash_clone_target_state( )
2786{
2787 psa_algorithm_t alg = PSA_ALG_SHA_256;
2788 unsigned char hash[PSA_HASH_MAX_SIZE];
2789 psa_hash_operation_t op_init = PSA_HASH_OPERATION_INIT;
2790 psa_hash_operation_t op_setup = PSA_HASH_OPERATION_INIT;
2791 psa_hash_operation_t op_finished = PSA_HASH_OPERATION_INIT;
2792 psa_hash_operation_t op_aborted = PSA_HASH_OPERATION_INIT;
2793 psa_hash_operation_t op_target = PSA_HASH_OPERATION_INIT;
2794 size_t hash_len;
2795
2796 PSA_ASSERT( psa_crypto_init( ) );
2797
2798 PSA_ASSERT( psa_hash_setup( &op_setup, alg ) );
2799 PSA_ASSERT( psa_hash_setup( &op_finished, alg ) );
2800 PSA_ASSERT( psa_hash_finish( &op_finished,
2801 hash, sizeof( hash ), &hash_len ) );
2802 PSA_ASSERT( psa_hash_setup( &op_aborted, alg ) );
2803 PSA_ASSERT( psa_hash_abort( &op_aborted ) );
2804
2805 PSA_ASSERT( psa_hash_clone( &op_setup, &op_target ) );
2806 PSA_ASSERT( psa_hash_finish( &op_target,
2807 hash, sizeof( hash ), &hash_len ) );
2808
2809 TEST_EQUAL( psa_hash_clone( &op_init, &op_target ), PSA_ERROR_BAD_STATE );
2810 TEST_EQUAL( psa_hash_clone( &op_finished, &op_target ),
2811 PSA_ERROR_BAD_STATE );
2812 TEST_EQUAL( psa_hash_clone( &op_aborted, &op_target ),
2813 PSA_ERROR_BAD_STATE );
2814
2815exit:
2816 psa_hash_abort( &op_target );
2817 psa_hash_abort( &op_init );
2818 psa_hash_abort( &op_setup );
2819 psa_hash_abort( &op_finished );
2820 psa_hash_abort( &op_aborted );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02002821 PSA_DONE( );
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002822}
2823/* END_CASE */
2824
itayzafrir58028322018-10-25 10:22:01 +03002825/* BEGIN_CASE */
Jaeden Amero769ce272019-01-04 11:48:03 +00002826void mac_operation_init( )
2827{
Jaeden Amero252ef282019-02-15 14:05:35 +00002828 const uint8_t input[1] = { 0 };
2829
Jaeden Amero769ce272019-01-04 11:48:03 +00002830 /* Test each valid way of initializing the object, except for `= {0}`, as
2831 * Clang 5 complains when `-Wmissing-field-initializers` is used, even
2832 * though it's OK by the C standard. We could test for this, but we'd need
2833 * to supress the Clang warning for the test. */
2834 psa_mac_operation_t func = psa_mac_operation_init( );
2835 psa_mac_operation_t init = PSA_MAC_OPERATION_INIT;
2836 psa_mac_operation_t zero;
2837
2838 memset( &zero, 0, sizeof( zero ) );
2839
Jaeden Amero252ef282019-02-15 14:05:35 +00002840 /* A freshly-initialized MAC operation should not be usable. */
2841 TEST_EQUAL( psa_mac_update( &func,
2842 input, sizeof( input ) ),
2843 PSA_ERROR_BAD_STATE );
2844 TEST_EQUAL( psa_mac_update( &init,
2845 input, sizeof( input ) ),
2846 PSA_ERROR_BAD_STATE );
2847 TEST_EQUAL( psa_mac_update( &zero,
2848 input, sizeof( input ) ),
2849 PSA_ERROR_BAD_STATE );
2850
Jaeden Amero5229bbb2019-02-07 16:33:37 +00002851 /* A default MAC operation should be abortable without error. */
2852 PSA_ASSERT( psa_mac_abort( &func ) );
2853 PSA_ASSERT( psa_mac_abort( &init ) );
2854 PSA_ASSERT( psa_mac_abort( &zero ) );
Jaeden Amero769ce272019-01-04 11:48:03 +00002855}
2856/* END_CASE */
2857
2858/* BEGIN_CASE */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002859void mac_setup( int key_type_arg,
2860 data_t *key,
2861 int alg_arg,
2862 int expected_status_arg )
2863{
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002864 psa_key_type_t key_type = key_type_arg;
2865 psa_algorithm_t alg = alg_arg;
Gilles Peskineb866e2b2018-06-21 09:25:10 +02002866 psa_status_t expected_status = expected_status_arg;
Jaeden Amero769ce272019-01-04 11:48:03 +00002867 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
Gilles Peskinef426e0f2019-02-25 17:42:03 +01002868 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
2869#if defined(KNOWN_SUPPORTED_MAC_ALG)
2870 const uint8_t smoke_test_key_data[16] = "kkkkkkkkkkkkkkkk";
2871#endif
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002872
Gilles Peskine8817f612018-12-18 00:18:46 +01002873 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002874
Gilles Peskinef426e0f2019-02-25 17:42:03 +01002875 if( ! exercise_mac_setup( key_type, key->x, key->len, alg,
2876 &operation, &status ) )
2877 goto exit;
Gilles Peskinefe11b722018-12-18 00:24:04 +01002878 TEST_EQUAL( status, expected_status );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002879
Gilles Peskinef426e0f2019-02-25 17:42:03 +01002880 /* The operation object should be reusable. */
2881#if defined(KNOWN_SUPPORTED_MAC_ALG)
2882 if( ! exercise_mac_setup( KNOWN_SUPPORTED_MAC_KEY_TYPE,
2883 smoke_test_key_data,
2884 sizeof( smoke_test_key_data ),
2885 KNOWN_SUPPORTED_MAC_ALG,
2886 &operation, &status ) )
2887 goto exit;
2888 TEST_EQUAL( status, PSA_SUCCESS );
2889#endif
2890
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002891exit:
Gilles Peskine1153e7b2019-05-28 15:10:21 +02002892 PSA_DONE( );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002893}
2894/* END_CASE */
2895
2896/* BEGIN_CASE */
Jaeden Amero252ef282019-02-15 14:05:35 +00002897void mac_bad_order( )
2898{
2899 psa_key_handle_t handle = 0;
2900 psa_key_type_t key_type = PSA_KEY_TYPE_HMAC;
2901 psa_algorithm_t alg = PSA_ALG_HMAC(PSA_ALG_SHA_256);
2902 const uint8_t key[] = {
2903 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa,
2904 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa,
2905 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa };
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02002906 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Jaeden Amero252ef282019-02-15 14:05:35 +00002907 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
2908 uint8_t sign_mac[PSA_MAC_MAX_SIZE + 10] = { 0 };
2909 size_t sign_mac_length = 0;
2910 const uint8_t input[] = { 0xbb, 0xbb, 0xbb, 0xbb };
2911 const uint8_t verify_mac[] = {
2912 0x74, 0x65, 0x93, 0x8c, 0xeb, 0x1d, 0xb3, 0x76, 0x5a, 0x38, 0xe7, 0xdd,
2913 0x85, 0xc5, 0xad, 0x4f, 0x07, 0xe7, 0xd5, 0xb2, 0x64, 0xf0, 0x1a, 0x1a,
2914 0x2c, 0xf9, 0x18, 0xca, 0x59, 0x7e, 0x5d, 0xf6 };
2915
2916 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01002917 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_HASH | PSA_KEY_USAGE_VERIFY_HASH );
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02002918 psa_set_key_algorithm( &attributes, alg );
2919 psa_set_key_type( &attributes, key_type );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002920
Gilles Peskine73676cb2019-05-15 20:15:10 +02002921 PSA_ASSERT( psa_import_key( &attributes, key, sizeof( key ), &handle ) );
Gilles Peskine4abf7412018-06-18 16:35:34 +02002922
Jaeden Amero252ef282019-02-15 14:05:35 +00002923 /* Call update without calling setup beforehand. */
2924 TEST_EQUAL( psa_mac_update( &operation, input, sizeof( input ) ),
2925 PSA_ERROR_BAD_STATE );
2926 PSA_ASSERT( psa_mac_abort( &operation ) );
2927
2928 /* Call sign finish without calling setup beforehand. */
2929 TEST_EQUAL( psa_mac_sign_finish( &operation, sign_mac, sizeof( sign_mac ),
2930 &sign_mac_length),
2931 PSA_ERROR_BAD_STATE );
2932 PSA_ASSERT( psa_mac_abort( &operation ) );
2933
2934 /* Call verify finish without calling setup beforehand. */
2935 TEST_EQUAL( psa_mac_verify_finish( &operation,
2936 verify_mac, sizeof( verify_mac ) ),
2937 PSA_ERROR_BAD_STATE );
2938 PSA_ASSERT( psa_mac_abort( &operation ) );
2939
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002940 /* Call setup twice in a row. */
2941 PSA_ASSERT( psa_mac_sign_setup( &operation,
2942 handle, alg ) );
2943 TEST_EQUAL( psa_mac_sign_setup( &operation,
2944 handle, alg ),
2945 PSA_ERROR_BAD_STATE );
2946 PSA_ASSERT( psa_mac_abort( &operation ) );
2947
Jaeden Amero252ef282019-02-15 14:05:35 +00002948 /* Call update after sign finish. */
2949 PSA_ASSERT( psa_mac_sign_setup( &operation,
2950 handle, alg ) );
2951 PSA_ASSERT( psa_mac_update( &operation, input, sizeof( input ) ) );
2952 PSA_ASSERT( psa_mac_sign_finish( &operation,
2953 sign_mac, sizeof( sign_mac ),
2954 &sign_mac_length ) );
2955 TEST_EQUAL( psa_mac_update( &operation, input, sizeof( input ) ),
2956 PSA_ERROR_BAD_STATE );
2957 PSA_ASSERT( psa_mac_abort( &operation ) );
2958
2959 /* Call update after verify finish. */
2960 PSA_ASSERT( psa_mac_verify_setup( &operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02002961 handle, alg ) );
Jaeden Amero252ef282019-02-15 14:05:35 +00002962 PSA_ASSERT( psa_mac_update( &operation, input, sizeof( input ) ) );
2963 PSA_ASSERT( psa_mac_verify_finish( &operation,
2964 verify_mac, sizeof( verify_mac ) ) );
2965 TEST_EQUAL( psa_mac_update( &operation, input, sizeof( input ) ),
2966 PSA_ERROR_BAD_STATE );
2967 PSA_ASSERT( psa_mac_abort( &operation ) );
2968
2969 /* Call sign finish twice in a row. */
2970 PSA_ASSERT( psa_mac_sign_setup( &operation,
2971 handle, alg ) );
2972 PSA_ASSERT( psa_mac_update( &operation, input, sizeof( input ) ) );
2973 PSA_ASSERT( psa_mac_sign_finish( &operation,
2974 sign_mac, sizeof( sign_mac ),
2975 &sign_mac_length ) );
2976 TEST_EQUAL( psa_mac_sign_finish( &operation,
2977 sign_mac, sizeof( sign_mac ),
2978 &sign_mac_length ),
2979 PSA_ERROR_BAD_STATE );
2980 PSA_ASSERT( psa_mac_abort( &operation ) );
2981
2982 /* Call verify finish twice in a row. */
2983 PSA_ASSERT( psa_mac_verify_setup( &operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02002984 handle, alg ) );
Jaeden Amero252ef282019-02-15 14:05:35 +00002985 PSA_ASSERT( psa_mac_update( &operation, input, sizeof( input ) ) );
2986 PSA_ASSERT( psa_mac_verify_finish( &operation,
2987 verify_mac, sizeof( verify_mac ) ) );
2988 TEST_EQUAL( psa_mac_verify_finish( &operation,
2989 verify_mac, sizeof( verify_mac ) ),
2990 PSA_ERROR_BAD_STATE );
2991 PSA_ASSERT( psa_mac_abort( &operation ) );
2992
2993 /* Setup sign but try verify. */
2994 PSA_ASSERT( psa_mac_sign_setup( &operation,
2995 handle, alg ) );
2996 PSA_ASSERT( psa_mac_update( &operation, input, sizeof( input ) ) );
2997 TEST_EQUAL( psa_mac_verify_finish( &operation,
2998 verify_mac, sizeof( verify_mac ) ),
2999 PSA_ERROR_BAD_STATE );
3000 PSA_ASSERT( psa_mac_abort( &operation ) );
3001
3002 /* Setup verify but try sign. */
3003 PSA_ASSERT( psa_mac_verify_setup( &operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02003004 handle, alg ) );
Jaeden Amero252ef282019-02-15 14:05:35 +00003005 PSA_ASSERT( psa_mac_update( &operation, input, sizeof( input ) ) );
3006 TEST_EQUAL( psa_mac_sign_finish( &operation,
3007 sign_mac, sizeof( sign_mac ),
3008 &sign_mac_length ),
3009 PSA_ERROR_BAD_STATE );
3010 PSA_ASSERT( psa_mac_abort( &operation ) );
Gilles Peskine4abf7412018-06-18 16:35:34 +02003011
Gilles Peskine76b29a72019-05-28 14:08:50 +02003012 PSA_ASSERT( psa_destroy_key( handle ) );
3013
Gilles Peskine9ef733f2018-02-07 21:05:37 +01003014exit:
Gilles Peskine1153e7b2019-05-28 15:10:21 +02003015 PSA_DONE( );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01003016}
3017/* END_CASE */
3018
3019/* BEGIN_CASE */
Gilles Peskinea7aa4422018-08-14 15:17:54 +02003020void mac_sign( int key_type_arg,
3021 data_t *key,
3022 int alg_arg,
3023 data_t *input,
3024 data_t *expected_mac )
3025{
Gilles Peskinebdf309c2018-12-03 15:36:32 +01003026 psa_key_handle_t handle = 0;
Gilles Peskinea7aa4422018-08-14 15:17:54 +02003027 psa_key_type_t key_type = key_type_arg;
3028 psa_algorithm_t alg = alg_arg;
Jaeden Amero769ce272019-01-04 11:48:03 +00003029 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02003030 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskinea7aa4422018-08-14 15:17:54 +02003031 /* Leave a little extra room in the output buffer. At the end of the
3032 * test, we'll check that the implementation didn't overwrite onto
3033 * this extra room. */
3034 uint8_t actual_mac[PSA_MAC_MAX_SIZE + 10];
3035 size_t mac_buffer_size =
3036 PSA_MAC_FINAL_SIZE( key_type, PSA_BYTES_TO_BITS( key->len ), alg );
3037 size_t mac_length = 0;
3038
3039 memset( actual_mac, '+', sizeof( actual_mac ) );
3040 TEST_ASSERT( mac_buffer_size <= PSA_MAC_MAX_SIZE );
3041 TEST_ASSERT( expected_mac->len <= mac_buffer_size );
3042
Gilles Peskine8817f612018-12-18 00:18:46 +01003043 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskinea7aa4422018-08-14 15:17:54 +02003044
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003045 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_HASH );
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02003046 psa_set_key_algorithm( &attributes, alg );
3047 psa_set_key_type( &attributes, key_type );
Gilles Peskinea7aa4422018-08-14 15:17:54 +02003048
Gilles Peskine73676cb2019-05-15 20:15:10 +02003049 PSA_ASSERT( psa_import_key( &attributes, key->x, key->len, &handle ) );
Gilles Peskinea7aa4422018-08-14 15:17:54 +02003050
3051 /* Calculate the MAC. */
Gilles Peskine8817f612018-12-18 00:18:46 +01003052 PSA_ASSERT( psa_mac_sign_setup( &operation,
3053 handle, alg ) );
3054 PSA_ASSERT( psa_mac_update( &operation,
3055 input->x, input->len ) );
3056 PSA_ASSERT( psa_mac_sign_finish( &operation,
3057 actual_mac, mac_buffer_size,
3058 &mac_length ) );
Gilles Peskinea7aa4422018-08-14 15:17:54 +02003059
3060 /* Compare with the expected value. */
Gilles Peskine0dfba2d2018-12-18 00:40:50 +01003061 ASSERT_COMPARE( expected_mac->x, expected_mac->len,
3062 actual_mac, mac_length );
Gilles Peskinea7aa4422018-08-14 15:17:54 +02003063
3064 /* Verify that the end of the buffer is untouched. */
3065 TEST_ASSERT( mem_is_char( actual_mac + mac_length, '+',
3066 sizeof( actual_mac ) - mac_length ) );
3067
3068exit:
Gilles Peskine64f13ef2020-08-25 23:15:20 +02003069 psa_mac_abort( &operation );
Gilles Peskinebdf309c2018-12-03 15:36:32 +01003070 psa_destroy_key( handle );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02003071 PSA_DONE( );
Gilles Peskinea7aa4422018-08-14 15:17:54 +02003072}
3073/* END_CASE */
3074
3075/* BEGIN_CASE */
Gilles Peskinec0ec9722018-06-18 17:03:37 +02003076void mac_verify( int key_type_arg,
3077 data_t *key,
3078 int alg_arg,
3079 data_t *input,
3080 data_t *expected_mac )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003081{
Gilles Peskinebdf309c2018-12-03 15:36:32 +01003082 psa_key_handle_t handle = 0;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003083 psa_key_type_t key_type = key_type_arg;
3084 psa_algorithm_t alg = alg_arg;
Jaeden Amero769ce272019-01-04 11:48:03 +00003085 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02003086 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003087
Gilles Peskine69c12672018-06-28 00:07:19 +02003088 TEST_ASSERT( expected_mac->len <= PSA_MAC_MAX_SIZE );
3089
Gilles Peskine8817f612018-12-18 00:18:46 +01003090 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003091
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003092 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_VERIFY_HASH );
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02003093 psa_set_key_algorithm( &attributes, alg );
3094 psa_set_key_type( &attributes, key_type );
mohammad16036df908f2018-04-02 08:34:15 -07003095
Gilles Peskine73676cb2019-05-15 20:15:10 +02003096 PSA_ASSERT( psa_import_key( &attributes, key->x, key->len, &handle ) );
Gilles Peskinec0ec9722018-06-18 17:03:37 +02003097
Gilles Peskine8817f612018-12-18 00:18:46 +01003098 PSA_ASSERT( psa_mac_verify_setup( &operation,
3099 handle, alg ) );
3100 PSA_ASSERT( psa_destroy_key( handle ) );
3101 PSA_ASSERT( psa_mac_update( &operation,
3102 input->x, input->len ) );
3103 PSA_ASSERT( psa_mac_verify_finish( &operation,
3104 expected_mac->x,
3105 expected_mac->len ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003106
3107exit:
Gilles Peskine64f13ef2020-08-25 23:15:20 +02003108 psa_mac_abort( &operation );
Gilles Peskinebdf309c2018-12-03 15:36:32 +01003109 psa_destroy_key( handle );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02003110 PSA_DONE( );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003111}
3112/* END_CASE */
3113
3114/* BEGIN_CASE */
Jaeden Amero5bae2272019-01-04 11:48:27 +00003115void cipher_operation_init( )
3116{
Jaeden Ameroab439972019-02-15 14:12:05 +00003117 const uint8_t input[1] = { 0 };
3118 unsigned char output[1] = { 0 };
3119 size_t output_length;
Jaeden Amero5bae2272019-01-04 11:48:27 +00003120 /* Test each valid way of initializing the object, except for `= {0}`, as
3121 * Clang 5 complains when `-Wmissing-field-initializers` is used, even
3122 * though it's OK by the C standard. We could test for this, but we'd need
3123 * to supress the Clang warning for the test. */
3124 psa_cipher_operation_t func = psa_cipher_operation_init( );
3125 psa_cipher_operation_t init = PSA_CIPHER_OPERATION_INIT;
3126 psa_cipher_operation_t zero;
3127
3128 memset( &zero, 0, sizeof( zero ) );
3129
Jaeden Ameroab439972019-02-15 14:12:05 +00003130 /* A freshly-initialized cipher operation should not be usable. */
3131 TEST_EQUAL( psa_cipher_update( &func,
3132 input, sizeof( input ),
3133 output, sizeof( output ),
3134 &output_length ),
3135 PSA_ERROR_BAD_STATE );
3136 TEST_EQUAL( psa_cipher_update( &init,
3137 input, sizeof( input ),
3138 output, sizeof( output ),
3139 &output_length ),
3140 PSA_ERROR_BAD_STATE );
3141 TEST_EQUAL( psa_cipher_update( &zero,
3142 input, sizeof( input ),
3143 output, sizeof( output ),
3144 &output_length ),
3145 PSA_ERROR_BAD_STATE );
3146
Jaeden Amero5229bbb2019-02-07 16:33:37 +00003147 /* A default cipher operation should be abortable without error. */
3148 PSA_ASSERT( psa_cipher_abort( &func ) );
3149 PSA_ASSERT( psa_cipher_abort( &init ) );
3150 PSA_ASSERT( psa_cipher_abort( &zero ) );
Jaeden Amero5bae2272019-01-04 11:48:27 +00003151}
3152/* END_CASE */
3153
3154/* BEGIN_CASE */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003155void cipher_setup( int key_type_arg,
3156 data_t *key,
3157 int alg_arg,
3158 int expected_status_arg )
3159{
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003160 psa_key_type_t key_type = key_type_arg;
3161 psa_algorithm_t alg = alg_arg;
Gilles Peskineb866e2b2018-06-21 09:25:10 +02003162 psa_status_t expected_status = expected_status_arg;
Jaeden Amero5bae2272019-01-04 11:48:27 +00003163 psa_cipher_operation_t operation = PSA_CIPHER_OPERATION_INIT;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003164 psa_status_t status;
Gilles Peskinef426e0f2019-02-25 17:42:03 +01003165#if defined(KNOWN_SUPPORTED_MAC_ALG)
3166 const uint8_t smoke_test_key_data[16] = "kkkkkkkkkkkkkkkk";
3167#endif
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003168
Gilles Peskine8817f612018-12-18 00:18:46 +01003169 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003170
Gilles Peskinef426e0f2019-02-25 17:42:03 +01003171 if( ! exercise_cipher_setup( key_type, key->x, key->len, alg,
3172 &operation, &status ) )
3173 goto exit;
Gilles Peskinefe11b722018-12-18 00:24:04 +01003174 TEST_EQUAL( status, expected_status );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003175
Gilles Peskinef426e0f2019-02-25 17:42:03 +01003176 /* The operation object should be reusable. */
3177#if defined(KNOWN_SUPPORTED_CIPHER_ALG)
3178 if( ! exercise_cipher_setup( KNOWN_SUPPORTED_CIPHER_KEY_TYPE,
3179 smoke_test_key_data,
3180 sizeof( smoke_test_key_data ),
3181 KNOWN_SUPPORTED_CIPHER_ALG,
3182 &operation, &status ) )
3183 goto exit;
3184 TEST_EQUAL( status, PSA_SUCCESS );
3185#endif
3186
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003187exit:
Gilles Peskine64f13ef2020-08-25 23:15:20 +02003188 psa_cipher_abort( &operation );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02003189 PSA_DONE( );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003190}
3191/* END_CASE */
3192
3193/* BEGIN_CASE */
Jaeden Ameroab439972019-02-15 14:12:05 +00003194void cipher_bad_order( )
3195{
3196 psa_key_handle_t handle = 0;
3197 psa_key_type_t key_type = PSA_KEY_TYPE_AES;
3198 psa_algorithm_t alg = PSA_ALG_CBC_PKCS7;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02003199 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Jaeden Ameroab439972019-02-15 14:12:05 +00003200 psa_cipher_operation_t operation = PSA_CIPHER_OPERATION_INIT;
3201 unsigned char iv[PSA_BLOCK_CIPHER_BLOCK_SIZE(PSA_KEY_TYPE_AES)] = { 0 };
3202 const uint8_t key[] = {
3203 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa,
3204 0xaa, 0xaa, 0xaa, 0xaa };
3205 const uint8_t text[] = {
3206 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb,
3207 0xbb, 0xbb, 0xbb, 0xbb };
3208 uint8_t buffer[PSA_BLOCK_CIPHER_BLOCK_SIZE(PSA_KEY_TYPE_AES)] = { 0 };
3209 size_t length = 0;
3210
3211 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02003212 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT | PSA_KEY_USAGE_DECRYPT );
3213 psa_set_key_algorithm( &attributes, alg );
3214 psa_set_key_type( &attributes, key_type );
Gilles Peskine73676cb2019-05-15 20:15:10 +02003215 PSA_ASSERT( psa_import_key( &attributes, key, sizeof( key ), &handle ) );
Jaeden Ameroab439972019-02-15 14:12:05 +00003216
3217
Jaeden Amero36ee5d02019-02-19 09:25:10 +00003218 /* Call encrypt setup twice in a row. */
3219 PSA_ASSERT( psa_cipher_encrypt_setup( &operation, handle, alg ) );
3220 TEST_EQUAL( psa_cipher_encrypt_setup( &operation, handle, alg ),
3221 PSA_ERROR_BAD_STATE );
3222 PSA_ASSERT( psa_cipher_abort( &operation ) );
3223
3224 /* Call decrypt setup twice in a row. */
3225 PSA_ASSERT( psa_cipher_decrypt_setup( &operation, handle, alg ) );
3226 TEST_EQUAL( psa_cipher_decrypt_setup( &operation, handle, alg ),
3227 PSA_ERROR_BAD_STATE );
3228 PSA_ASSERT( psa_cipher_abort( &operation ) );
3229
Jaeden Ameroab439972019-02-15 14:12:05 +00003230 /* Generate an IV without calling setup beforehand. */
3231 TEST_EQUAL( psa_cipher_generate_iv( &operation,
3232 buffer, sizeof( buffer ),
3233 &length ),
3234 PSA_ERROR_BAD_STATE );
3235 PSA_ASSERT( psa_cipher_abort( &operation ) );
3236
3237 /* Generate an IV twice in a row. */
3238 PSA_ASSERT( psa_cipher_encrypt_setup( &operation, handle, alg ) );
3239 PSA_ASSERT( psa_cipher_generate_iv( &operation,
3240 buffer, sizeof( buffer ),
3241 &length ) );
3242 TEST_EQUAL( psa_cipher_generate_iv( &operation,
3243 buffer, sizeof( buffer ),
3244 &length ),
3245 PSA_ERROR_BAD_STATE );
3246 PSA_ASSERT( psa_cipher_abort( &operation ) );
3247
3248 /* Generate an IV after it's already set. */
3249 PSA_ASSERT( psa_cipher_encrypt_setup( &operation, handle, alg ) );
3250 PSA_ASSERT( psa_cipher_set_iv( &operation,
3251 iv, sizeof( iv ) ) );
3252 TEST_EQUAL( psa_cipher_generate_iv( &operation,
3253 buffer, sizeof( buffer ),
3254 &length ),
3255 PSA_ERROR_BAD_STATE );
3256 PSA_ASSERT( psa_cipher_abort( &operation ) );
3257
3258 /* Set an IV without calling setup beforehand. */
3259 TEST_EQUAL( psa_cipher_set_iv( &operation,
3260 iv, sizeof( iv ) ),
3261 PSA_ERROR_BAD_STATE );
3262 PSA_ASSERT( psa_cipher_abort( &operation ) );
3263
3264 /* Set an IV after it's already set. */
3265 PSA_ASSERT( psa_cipher_encrypt_setup( &operation, handle, alg ) );
3266 PSA_ASSERT( psa_cipher_set_iv( &operation,
3267 iv, sizeof( iv ) ) );
3268 TEST_EQUAL( psa_cipher_set_iv( &operation,
3269 iv, sizeof( iv ) ),
3270 PSA_ERROR_BAD_STATE );
3271 PSA_ASSERT( psa_cipher_abort( &operation ) );
3272
3273 /* Set an IV after it's already generated. */
3274 PSA_ASSERT( psa_cipher_encrypt_setup( &operation, handle, alg ) );
3275 PSA_ASSERT( psa_cipher_generate_iv( &operation,
3276 buffer, sizeof( buffer ),
3277 &length ) );
3278 TEST_EQUAL( psa_cipher_set_iv( &operation,
3279 iv, sizeof( iv ) ),
3280 PSA_ERROR_BAD_STATE );
3281 PSA_ASSERT( psa_cipher_abort( &operation ) );
3282
3283 /* Call update without calling setup beforehand. */
3284 TEST_EQUAL( psa_cipher_update( &operation,
3285 text, sizeof( text ),
3286 buffer, sizeof( buffer ),
3287 &length ),
3288 PSA_ERROR_BAD_STATE );
3289 PSA_ASSERT( psa_cipher_abort( &operation ) );
3290
3291 /* Call update without an IV where an IV is required. */
3292 TEST_EQUAL( psa_cipher_update( &operation,
3293 text, sizeof( text ),
3294 buffer, sizeof( buffer ),
3295 &length ),
3296 PSA_ERROR_BAD_STATE );
3297 PSA_ASSERT( psa_cipher_abort( &operation ) );
3298
3299 /* Call update after finish. */
3300 PSA_ASSERT( psa_cipher_encrypt_setup( &operation, handle, alg ) );
3301 PSA_ASSERT( psa_cipher_set_iv( &operation,
3302 iv, sizeof( iv ) ) );
3303 PSA_ASSERT( psa_cipher_finish( &operation,
3304 buffer, sizeof( buffer ), &length ) );
3305 TEST_EQUAL( psa_cipher_update( &operation,
3306 text, sizeof( text ),
3307 buffer, sizeof( buffer ),
3308 &length ),
3309 PSA_ERROR_BAD_STATE );
3310 PSA_ASSERT( psa_cipher_abort( &operation ) );
3311
3312 /* Call finish without calling setup beforehand. */
3313 TEST_EQUAL( psa_cipher_finish( &operation,
3314 buffer, sizeof( buffer ), &length ),
3315 PSA_ERROR_BAD_STATE );
3316 PSA_ASSERT( psa_cipher_abort( &operation ) );
3317
3318 /* Call finish without an IV where an IV is required. */
3319 PSA_ASSERT( psa_cipher_encrypt_setup( &operation, handle, alg ) );
3320 /* Not calling update means we are encrypting an empty buffer, which is OK
3321 * for cipher modes with padding. */
3322 TEST_EQUAL( psa_cipher_finish( &operation,
3323 buffer, sizeof( buffer ), &length ),
3324 PSA_ERROR_BAD_STATE );
3325 PSA_ASSERT( psa_cipher_abort( &operation ) );
3326
3327 /* Call finish twice in a row. */
3328 PSA_ASSERT( psa_cipher_encrypt_setup( &operation, handle, alg ) );
3329 PSA_ASSERT( psa_cipher_set_iv( &operation,
3330 iv, sizeof( iv ) ) );
3331 PSA_ASSERT( psa_cipher_finish( &operation,
3332 buffer, sizeof( buffer ), &length ) );
3333 TEST_EQUAL( psa_cipher_finish( &operation,
3334 buffer, sizeof( buffer ), &length ),
3335 PSA_ERROR_BAD_STATE );
3336 PSA_ASSERT( psa_cipher_abort( &operation ) );
3337
Gilles Peskine76b29a72019-05-28 14:08:50 +02003338 PSA_ASSERT( psa_destroy_key( handle ) );
3339
Jaeden Ameroab439972019-02-15 14:12:05 +00003340exit:
Gilles Peskine64f13ef2020-08-25 23:15:20 +02003341 psa_cipher_abort( &operation );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02003342 PSA_DONE( );
Gilles Peskine50e586b2018-06-08 14:28:46 +02003343}
3344/* END_CASE */
Gilles Peskine50e586b2018-06-08 14:28:46 +02003345
Gilles Peskine50e586b2018-06-08 14:28:46 +02003346/* BEGIN_CASE */
Gilles Peskine50e586b2018-06-08 14:28:46 +02003347void cipher_encrypt( int alg_arg, int key_type_arg,
Gilles Peskine423005e2019-05-06 15:22:57 +02003348 data_t *key, data_t *iv,
Gilles Peskine50e586b2018-06-08 14:28:46 +02003349 data_t *input, data_t *expected_output,
Gilles Peskineb866e2b2018-06-21 09:25:10 +02003350 int expected_status_arg )
Gilles Peskine50e586b2018-06-08 14:28:46 +02003351{
Gilles Peskinebdf309c2018-12-03 15:36:32 +01003352 psa_key_handle_t handle = 0;
Gilles Peskine50e586b2018-06-08 14:28:46 +02003353 psa_status_t status;
3354 psa_key_type_t key_type = key_type_arg;
3355 psa_algorithm_t alg = alg_arg;
Gilles Peskineb866e2b2018-06-21 09:25:10 +02003356 psa_status_t expected_status = expected_status_arg;
Gilles Peskine50e586b2018-06-08 14:28:46 +02003357 unsigned char *output = NULL;
3358 size_t output_buffer_size = 0;
3359 size_t function_output_length = 0;
3360 size_t total_output_length = 0;
Jaeden Amero5bae2272019-01-04 11:48:27 +00003361 psa_cipher_operation_t operation = PSA_CIPHER_OPERATION_INIT;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02003362 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine50e586b2018-06-08 14:28:46 +02003363
Gilles Peskine8817f612018-12-18 00:18:46 +01003364 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine50e586b2018-06-08 14:28:46 +02003365
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02003366 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
3367 psa_set_key_algorithm( &attributes, alg );
3368 psa_set_key_type( &attributes, key_type );
Moran Pekered346952018-07-05 15:22:45 +03003369
Gilles Peskine73676cb2019-05-15 20:15:10 +02003370 PSA_ASSERT( psa_import_key( &attributes, key->x, key->len, &handle ) );
Gilles Peskine50e586b2018-06-08 14:28:46 +02003371
Gilles Peskine8817f612018-12-18 00:18:46 +01003372 PSA_ASSERT( psa_cipher_encrypt_setup( &operation,
3373 handle, alg ) );
Gilles Peskine50e586b2018-06-08 14:28:46 +02003374
Gilles Peskine423005e2019-05-06 15:22:57 +02003375 PSA_ASSERT( psa_cipher_set_iv( &operation, iv->x, iv->len ) );
Gilles Peskine9d8eea72018-12-17 23:34:57 +01003376 output_buffer_size = ( (size_t) input->len +
3377 PSA_BLOCK_CIPHER_BLOCK_SIZE( key_type ) );
Gilles Peskine8cebbba2018-09-27 13:54:18 +02003378 ASSERT_ALLOC( output, output_buffer_size );
Gilles Peskine50e586b2018-06-08 14:28:46 +02003379
Gilles Peskine8817f612018-12-18 00:18:46 +01003380 PSA_ASSERT( psa_cipher_update( &operation,
3381 input->x, input->len,
3382 output, output_buffer_size,
3383 &function_output_length ) );
Gilles Peskine50e586b2018-06-08 14:28:46 +02003384 total_output_length += function_output_length;
3385 status = psa_cipher_finish( &operation,
Gilles Peskineee46fe72019-02-19 19:05:33 +01003386 output + total_output_length,
3387 output_buffer_size - total_output_length,
Gilles Peskine50e586b2018-06-08 14:28:46 +02003388 &function_output_length );
3389 total_output_length += function_output_length;
3390
Gilles Peskinefe11b722018-12-18 00:24:04 +01003391 TEST_EQUAL( status, expected_status );
Gilles Peskine50e586b2018-06-08 14:28:46 +02003392 if( expected_status == PSA_SUCCESS )
3393 {
Gilles Peskine8817f612018-12-18 00:18:46 +01003394 PSA_ASSERT( psa_cipher_abort( &operation ) );
Gilles Peskinebd7dea92018-09-27 13:57:19 +02003395 ASSERT_COMPARE( expected_output->x, expected_output->len,
3396 output, total_output_length );
Gilles Peskine50e586b2018-06-08 14:28:46 +02003397 }
3398
3399exit:
Gilles Peskine64f13ef2020-08-25 23:15:20 +02003400 psa_cipher_abort( &operation );
Gilles Peskine50e586b2018-06-08 14:28:46 +02003401 mbedtls_free( output );
Gilles Peskinebdf309c2018-12-03 15:36:32 +01003402 psa_destroy_key( handle );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02003403 PSA_DONE( );
Gilles Peskine50e586b2018-06-08 14:28:46 +02003404}
3405/* END_CASE */
3406
3407/* BEGIN_CASE */
3408void cipher_encrypt_multipart( int alg_arg, int key_type_arg,
Gilles Peskine423005e2019-05-06 15:22:57 +02003409 data_t *key, data_t *iv,
Gilles Peskine50e586b2018-06-08 14:28:46 +02003410 data_t *input,
Gilles Peskinee0866522019-02-19 19:44:00 +01003411 int first_part_size_arg,
3412 int output1_length_arg, int output2_length_arg,
Gilles Peskine50e586b2018-06-08 14:28:46 +02003413 data_t *expected_output )
3414{
Gilles Peskinebdf309c2018-12-03 15:36:32 +01003415 psa_key_handle_t handle = 0;
Gilles Peskine50e586b2018-06-08 14:28:46 +02003416 psa_key_type_t key_type = key_type_arg;
3417 psa_algorithm_t alg = alg_arg;
Gilles Peskinee0866522019-02-19 19:44:00 +01003418 size_t first_part_size = first_part_size_arg;
3419 size_t output1_length = output1_length_arg;
3420 size_t output2_length = output2_length_arg;
Gilles Peskine50e586b2018-06-08 14:28:46 +02003421 unsigned char *output = NULL;
3422 size_t output_buffer_size = 0;
3423 size_t function_output_length = 0;
3424 size_t total_output_length = 0;
Jaeden Amero5bae2272019-01-04 11:48:27 +00003425 psa_cipher_operation_t operation = PSA_CIPHER_OPERATION_INIT;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02003426 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine50e586b2018-06-08 14:28:46 +02003427
Gilles Peskine8817f612018-12-18 00:18:46 +01003428 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine50e586b2018-06-08 14:28:46 +02003429
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02003430 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
3431 psa_set_key_algorithm( &attributes, alg );
3432 psa_set_key_type( &attributes, key_type );
Moran Pekered346952018-07-05 15:22:45 +03003433
Gilles Peskine73676cb2019-05-15 20:15:10 +02003434 PSA_ASSERT( psa_import_key( &attributes, key->x, key->len, &handle ) );
Gilles Peskine50e586b2018-06-08 14:28:46 +02003435
Gilles Peskine8817f612018-12-18 00:18:46 +01003436 PSA_ASSERT( psa_cipher_encrypt_setup( &operation,
3437 handle, alg ) );
Gilles Peskine50e586b2018-06-08 14:28:46 +02003438
Gilles Peskine423005e2019-05-06 15:22:57 +02003439 PSA_ASSERT( psa_cipher_set_iv( &operation, iv->x, iv->len ) );
Gilles Peskine9d8eea72018-12-17 23:34:57 +01003440 output_buffer_size = ( (size_t) input->len +
3441 PSA_BLOCK_CIPHER_BLOCK_SIZE( key_type ) );
Gilles Peskine8cebbba2018-09-27 13:54:18 +02003442 ASSERT_ALLOC( output, output_buffer_size );
Gilles Peskine50e586b2018-06-08 14:28:46 +02003443
Gilles Peskinee0866522019-02-19 19:44:00 +01003444 TEST_ASSERT( first_part_size <= input->len );
Gilles Peskine8817f612018-12-18 00:18:46 +01003445 PSA_ASSERT( psa_cipher_update( &operation, input->x, first_part_size,
3446 output, output_buffer_size,
3447 &function_output_length ) );
Gilles Peskinee0866522019-02-19 19:44:00 +01003448 TEST_ASSERT( function_output_length == output1_length );
Gilles Peskinea7ec95f2018-06-08 14:40:59 +02003449 total_output_length += function_output_length;
Gilles Peskine8817f612018-12-18 00:18:46 +01003450 PSA_ASSERT( psa_cipher_update( &operation,
3451 input->x + first_part_size,
3452 input->len - first_part_size,
Gilles Peskineee46fe72019-02-19 19:05:33 +01003453 output + total_output_length,
3454 output_buffer_size - total_output_length,
Gilles Peskine8817f612018-12-18 00:18:46 +01003455 &function_output_length ) );
Gilles Peskinee0866522019-02-19 19:44:00 +01003456 TEST_ASSERT( function_output_length == output2_length );
Gilles Peskinea7ec95f2018-06-08 14:40:59 +02003457 total_output_length += function_output_length;
Gilles Peskine8817f612018-12-18 00:18:46 +01003458 PSA_ASSERT( psa_cipher_finish( &operation,
Gilles Peskineee46fe72019-02-19 19:05:33 +01003459 output + total_output_length,
3460 output_buffer_size - total_output_length,
Gilles Peskine8817f612018-12-18 00:18:46 +01003461 &function_output_length ) );
Gilles Peskinea7ec95f2018-06-08 14:40:59 +02003462 total_output_length += function_output_length;
Gilles Peskine8817f612018-12-18 00:18:46 +01003463 PSA_ASSERT( psa_cipher_abort( &operation ) );
Gilles Peskine50e586b2018-06-08 14:28:46 +02003464
Gilles Peskinebd7dea92018-09-27 13:57:19 +02003465 ASSERT_COMPARE( expected_output->x, expected_output->len,
3466 output, total_output_length );
Gilles Peskine50e586b2018-06-08 14:28:46 +02003467
3468exit:
Gilles Peskine64f13ef2020-08-25 23:15:20 +02003469 psa_cipher_abort( &operation );
itayzafrir3e02b3b2018-06-12 17:06:52 +03003470 mbedtls_free( output );
Gilles Peskinebdf309c2018-12-03 15:36:32 +01003471 psa_destroy_key( handle );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02003472 PSA_DONE( );
Gilles Peskine50e586b2018-06-08 14:28:46 +02003473}
3474/* END_CASE */
3475
3476/* BEGIN_CASE */
3477void cipher_decrypt_multipart( int alg_arg, int key_type_arg,
Gilles Peskine423005e2019-05-06 15:22:57 +02003478 data_t *key, data_t *iv,
itayzafrir3e02b3b2018-06-12 17:06:52 +03003479 data_t *input,
Gilles Peskinee0866522019-02-19 19:44:00 +01003480 int first_part_size_arg,
3481 int output1_length_arg, int output2_length_arg,
itayzafrir3e02b3b2018-06-12 17:06:52 +03003482 data_t *expected_output )
Gilles Peskine50e586b2018-06-08 14:28:46 +02003483{
Gilles Peskinebdf309c2018-12-03 15:36:32 +01003484 psa_key_handle_t handle = 0;
Gilles Peskine50e586b2018-06-08 14:28:46 +02003485
3486 psa_key_type_t key_type = key_type_arg;
3487 psa_algorithm_t alg = alg_arg;
Gilles Peskinee0866522019-02-19 19:44:00 +01003488 size_t first_part_size = first_part_size_arg;
3489 size_t output1_length = output1_length_arg;
3490 size_t output2_length = output2_length_arg;
itayzafrir3e02b3b2018-06-12 17:06:52 +03003491 unsigned char *output = NULL;
Gilles Peskine50e586b2018-06-08 14:28:46 +02003492 size_t output_buffer_size = 0;
3493 size_t function_output_length = 0;
Gilles Peskinea7ec95f2018-06-08 14:40:59 +02003494 size_t total_output_length = 0;
Jaeden Amero5bae2272019-01-04 11:48:27 +00003495 psa_cipher_operation_t operation = PSA_CIPHER_OPERATION_INIT;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02003496 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine50e586b2018-06-08 14:28:46 +02003497
Gilles Peskine8817f612018-12-18 00:18:46 +01003498 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine50e586b2018-06-08 14:28:46 +02003499
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02003500 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DECRYPT );
3501 psa_set_key_algorithm( &attributes, alg );
3502 psa_set_key_type( &attributes, key_type );
Moran Pekered346952018-07-05 15:22:45 +03003503
Gilles Peskine73676cb2019-05-15 20:15:10 +02003504 PSA_ASSERT( psa_import_key( &attributes, key->x, key->len, &handle ) );
Gilles Peskine50e586b2018-06-08 14:28:46 +02003505
Gilles Peskine8817f612018-12-18 00:18:46 +01003506 PSA_ASSERT( psa_cipher_decrypt_setup( &operation,
3507 handle, alg ) );
Gilles Peskine50e586b2018-06-08 14:28:46 +02003508
Gilles Peskine423005e2019-05-06 15:22:57 +02003509 PSA_ASSERT( psa_cipher_set_iv( &operation, iv->x, iv->len ) );
Gilles Peskine50e586b2018-06-08 14:28:46 +02003510
Gilles Peskine9d8eea72018-12-17 23:34:57 +01003511 output_buffer_size = ( (size_t) input->len +
3512 PSA_BLOCK_CIPHER_BLOCK_SIZE( key_type ) );
Gilles Peskine8cebbba2018-09-27 13:54:18 +02003513 ASSERT_ALLOC( output, output_buffer_size );
Gilles Peskine50e586b2018-06-08 14:28:46 +02003514
Gilles Peskinee0866522019-02-19 19:44:00 +01003515 TEST_ASSERT( first_part_size <= input->len );
Gilles Peskine8817f612018-12-18 00:18:46 +01003516 PSA_ASSERT( psa_cipher_update( &operation,
3517 input->x, first_part_size,
3518 output, output_buffer_size,
3519 &function_output_length ) );
Gilles Peskinee0866522019-02-19 19:44:00 +01003520 TEST_ASSERT( function_output_length == output1_length );
Gilles Peskinea7ec95f2018-06-08 14:40:59 +02003521 total_output_length += function_output_length;
Gilles Peskine8817f612018-12-18 00:18:46 +01003522 PSA_ASSERT( psa_cipher_update( &operation,
3523 input->x + first_part_size,
3524 input->len - first_part_size,
Gilles Peskineee46fe72019-02-19 19:05:33 +01003525 output + total_output_length,
3526 output_buffer_size - total_output_length,
Gilles Peskine8817f612018-12-18 00:18:46 +01003527 &function_output_length ) );
Gilles Peskinee0866522019-02-19 19:44:00 +01003528 TEST_ASSERT( function_output_length == output2_length );
Gilles Peskinea7ec95f2018-06-08 14:40:59 +02003529 total_output_length += function_output_length;
Gilles Peskine8817f612018-12-18 00:18:46 +01003530 PSA_ASSERT( psa_cipher_finish( &operation,
Gilles Peskineee46fe72019-02-19 19:05:33 +01003531 output + total_output_length,
3532 output_buffer_size - total_output_length,
Gilles Peskine8817f612018-12-18 00:18:46 +01003533 &function_output_length ) );
Gilles Peskinea7ec95f2018-06-08 14:40:59 +02003534 total_output_length += function_output_length;
Gilles Peskine8817f612018-12-18 00:18:46 +01003535 PSA_ASSERT( psa_cipher_abort( &operation ) );
Gilles Peskine50e586b2018-06-08 14:28:46 +02003536
Gilles Peskinebd7dea92018-09-27 13:57:19 +02003537 ASSERT_COMPARE( expected_output->x, expected_output->len,
3538 output, total_output_length );
Gilles Peskine50e586b2018-06-08 14:28:46 +02003539
3540exit:
Gilles Peskine64f13ef2020-08-25 23:15:20 +02003541 psa_cipher_abort( &operation );
itayzafrir3e02b3b2018-06-12 17:06:52 +03003542 mbedtls_free( output );
Gilles Peskinebdf309c2018-12-03 15:36:32 +01003543 psa_destroy_key( handle );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02003544 PSA_DONE( );
Gilles Peskine50e586b2018-06-08 14:28:46 +02003545}
3546/* END_CASE */
3547
Gilles Peskine50e586b2018-06-08 14:28:46 +02003548/* BEGIN_CASE */
3549void cipher_decrypt( int alg_arg, int key_type_arg,
Gilles Peskine423005e2019-05-06 15:22:57 +02003550 data_t *key, data_t *iv,
itayzafrir3e02b3b2018-06-12 17:06:52 +03003551 data_t *input, data_t *expected_output,
Gilles Peskineb866e2b2018-06-21 09:25:10 +02003552 int expected_status_arg )
Gilles Peskine50e586b2018-06-08 14:28:46 +02003553{
Gilles Peskinebdf309c2018-12-03 15:36:32 +01003554 psa_key_handle_t handle = 0;
Gilles Peskine50e586b2018-06-08 14:28:46 +02003555 psa_status_t status;
3556 psa_key_type_t key_type = key_type_arg;
3557 psa_algorithm_t alg = alg_arg;
Gilles Peskineb866e2b2018-06-21 09:25:10 +02003558 psa_status_t expected_status = expected_status_arg;
itayzafrir3e02b3b2018-06-12 17:06:52 +03003559 unsigned char *output = NULL;
Gilles Peskine50e586b2018-06-08 14:28:46 +02003560 size_t output_buffer_size = 0;
3561 size_t function_output_length = 0;
Gilles Peskinea7ec95f2018-06-08 14:40:59 +02003562 size_t total_output_length = 0;
Jaeden Amero5bae2272019-01-04 11:48:27 +00003563 psa_cipher_operation_t operation = PSA_CIPHER_OPERATION_INIT;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02003564 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine50e586b2018-06-08 14:28:46 +02003565
Gilles Peskine8817f612018-12-18 00:18:46 +01003566 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine50e586b2018-06-08 14:28:46 +02003567
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02003568 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DECRYPT );
3569 psa_set_key_algorithm( &attributes, alg );
3570 psa_set_key_type( &attributes, key_type );
Moran Pekered346952018-07-05 15:22:45 +03003571
Gilles Peskine73676cb2019-05-15 20:15:10 +02003572 PSA_ASSERT( psa_import_key( &attributes, key->x, key->len, &handle ) );
Gilles Peskine50e586b2018-06-08 14:28:46 +02003573
Gilles Peskine8817f612018-12-18 00:18:46 +01003574 PSA_ASSERT( psa_cipher_decrypt_setup( &operation,
3575 handle, alg ) );
Gilles Peskine50e586b2018-06-08 14:28:46 +02003576
Gilles Peskine423005e2019-05-06 15:22:57 +02003577 PSA_ASSERT( psa_cipher_set_iv( &operation, iv->x, iv->len ) );
Gilles Peskine50e586b2018-06-08 14:28:46 +02003578
Gilles Peskine9d8eea72018-12-17 23:34:57 +01003579 output_buffer_size = ( (size_t) input->len +
3580 PSA_BLOCK_CIPHER_BLOCK_SIZE( key_type ) );
Gilles Peskine8cebbba2018-09-27 13:54:18 +02003581 ASSERT_ALLOC( output, output_buffer_size );
Gilles Peskine50e586b2018-06-08 14:28:46 +02003582
Gilles Peskine8817f612018-12-18 00:18:46 +01003583 PSA_ASSERT( psa_cipher_update( &operation,
3584 input->x, input->len,
3585 output, output_buffer_size,
3586 &function_output_length ) );
Gilles Peskinea7ec95f2018-06-08 14:40:59 +02003587 total_output_length += function_output_length;
Gilles Peskine50e586b2018-06-08 14:28:46 +02003588 status = psa_cipher_finish( &operation,
Gilles Peskineee46fe72019-02-19 19:05:33 +01003589 output + total_output_length,
3590 output_buffer_size - total_output_length,
Gilles Peskine50e586b2018-06-08 14:28:46 +02003591 &function_output_length );
Gilles Peskinea7ec95f2018-06-08 14:40:59 +02003592 total_output_length += function_output_length;
Gilles Peskinefe11b722018-12-18 00:24:04 +01003593 TEST_EQUAL( status, expected_status );
Gilles Peskine50e586b2018-06-08 14:28:46 +02003594
3595 if( expected_status == PSA_SUCCESS )
3596 {
Gilles Peskine8817f612018-12-18 00:18:46 +01003597 PSA_ASSERT( psa_cipher_abort( &operation ) );
Gilles Peskinebd7dea92018-09-27 13:57:19 +02003598 ASSERT_COMPARE( expected_output->x, expected_output->len,
3599 output, total_output_length );
Gilles Peskine50e586b2018-06-08 14:28:46 +02003600 }
3601
Gilles Peskine50e586b2018-06-08 14:28:46 +02003602exit:
Gilles Peskine64f13ef2020-08-25 23:15:20 +02003603 psa_cipher_abort( &operation );
itayzafrir3e02b3b2018-06-12 17:06:52 +03003604 mbedtls_free( output );
Gilles Peskinebdf309c2018-12-03 15:36:32 +01003605 psa_destroy_key( handle );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02003606 PSA_DONE( );
Gilles Peskine50e586b2018-06-08 14:28:46 +02003607}
3608/* END_CASE */
3609
Gilles Peskine50e586b2018-06-08 14:28:46 +02003610/* BEGIN_CASE */
3611void cipher_verify_output( int alg_arg, int key_type_arg,
itayzafrir3e02b3b2018-06-12 17:06:52 +03003612 data_t *key,
3613 data_t *input )
mohammad1603d7d7ba52018-03-12 18:51:53 +02003614{
Gilles Peskinebdf309c2018-12-03 15:36:32 +01003615 psa_key_handle_t handle = 0;
mohammad1603d7d7ba52018-03-12 18:51:53 +02003616 psa_key_type_t key_type = key_type_arg;
3617 psa_algorithm_t alg = alg_arg;
mohammad1603e6b67a12018-03-12 10:38:49 -07003618 unsigned char iv[16] = {0};
mohammad1603d7d7ba52018-03-12 18:51:53 +02003619 size_t iv_size = 16;
3620 size_t iv_length = 0;
itayzafrir3e02b3b2018-06-12 17:06:52 +03003621 unsigned char *output1 = NULL;
mohammad1603d7d7ba52018-03-12 18:51:53 +02003622 size_t output1_size = 0;
3623 size_t output1_length = 0;
itayzafrir3e02b3b2018-06-12 17:06:52 +03003624 unsigned char *output2 = NULL;
mohammad1603d7d7ba52018-03-12 18:51:53 +02003625 size_t output2_size = 0;
3626 size_t output2_length = 0;
Gilles Peskine048b7f02018-06-08 14:20:49 +02003627 size_t function_output_length = 0;
Jaeden Amero5bae2272019-01-04 11:48:27 +00003628 psa_cipher_operation_t operation1 = PSA_CIPHER_OPERATION_INIT;
3629 psa_cipher_operation_t operation2 = PSA_CIPHER_OPERATION_INIT;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02003630 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
mohammad1603d7d7ba52018-03-12 18:51:53 +02003631
Gilles Peskine8817f612018-12-18 00:18:46 +01003632 PSA_ASSERT( psa_crypto_init( ) );
mohammad1603d7d7ba52018-03-12 18:51:53 +02003633
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02003634 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT | PSA_KEY_USAGE_DECRYPT );
3635 psa_set_key_algorithm( &attributes, alg );
3636 psa_set_key_type( &attributes, key_type );
Moran Pekered346952018-07-05 15:22:45 +03003637
Gilles Peskine73676cb2019-05-15 20:15:10 +02003638 PSA_ASSERT( psa_import_key( &attributes, key->x, key->len, &handle ) );
mohammad1603d7d7ba52018-03-12 18:51:53 +02003639
Gilles Peskine8817f612018-12-18 00:18:46 +01003640 PSA_ASSERT( psa_cipher_encrypt_setup( &operation1,
3641 handle, alg ) );
3642 PSA_ASSERT( psa_cipher_decrypt_setup( &operation2,
3643 handle, alg ) );
mohammad1603d7d7ba52018-03-12 18:51:53 +02003644
Gilles Peskine8817f612018-12-18 00:18:46 +01003645 PSA_ASSERT( psa_cipher_generate_iv( &operation1,
3646 iv, iv_size,
3647 &iv_length ) );
Gilles Peskine9d8eea72018-12-17 23:34:57 +01003648 output1_size = ( (size_t) input->len +
3649 PSA_BLOCK_CIPHER_BLOCK_SIZE( key_type ) );
Gilles Peskine8cebbba2018-09-27 13:54:18 +02003650 ASSERT_ALLOC( output1, output1_size );
Moran Pekerded84402018-06-06 16:36:50 +03003651
Gilles Peskine8817f612018-12-18 00:18:46 +01003652 PSA_ASSERT( psa_cipher_update( &operation1, input->x, input->len,
3653 output1, output1_size,
3654 &output1_length ) );
3655 PSA_ASSERT( psa_cipher_finish( &operation1,
Gilles Peskineee46fe72019-02-19 19:05:33 +01003656 output1 + output1_length,
3657 output1_size - output1_length,
Gilles Peskine8817f612018-12-18 00:18:46 +01003658 &function_output_length ) );
Gilles Peskine4ca9c3f2018-06-06 18:44:09 +02003659
Gilles Peskine048b7f02018-06-08 14:20:49 +02003660 output1_length += function_output_length;
Moran Pekerded84402018-06-06 16:36:50 +03003661
Gilles Peskine8817f612018-12-18 00:18:46 +01003662 PSA_ASSERT( psa_cipher_abort( &operation1 ) );
Moran Pekerded84402018-06-06 16:36:50 +03003663
3664 output2_size = output1_length;
Gilles Peskine8cebbba2018-09-27 13:54:18 +02003665 ASSERT_ALLOC( output2, output2_size );
Moran Pekerded84402018-06-06 16:36:50 +03003666
Gilles Peskine8817f612018-12-18 00:18:46 +01003667 PSA_ASSERT( psa_cipher_set_iv( &operation2,
3668 iv, iv_length ) );
3669 PSA_ASSERT( psa_cipher_update( &operation2, output1, output1_length,
3670 output2, output2_size,
3671 &output2_length ) );
Gilles Peskine048b7f02018-06-08 14:20:49 +02003672 function_output_length = 0;
Gilles Peskine8817f612018-12-18 00:18:46 +01003673 PSA_ASSERT( psa_cipher_finish( &operation2,
3674 output2 + output2_length,
Gilles Peskineee46fe72019-02-19 19:05:33 +01003675 output2_size - output2_length,
Gilles Peskine8817f612018-12-18 00:18:46 +01003676 &function_output_length ) );
Moran Pekerded84402018-06-06 16:36:50 +03003677
Gilles Peskine048b7f02018-06-08 14:20:49 +02003678 output2_length += function_output_length;
Gilles Peskine4ca9c3f2018-06-06 18:44:09 +02003679
Gilles Peskine8817f612018-12-18 00:18:46 +01003680 PSA_ASSERT( psa_cipher_abort( &operation2 ) );
Moran Pekerded84402018-06-06 16:36:50 +03003681
Gilles Peskinebd7dea92018-09-27 13:57:19 +02003682 ASSERT_COMPARE( input->x, input->len, output2, output2_length );
Moran Pekerded84402018-06-06 16:36:50 +03003683
3684exit:
Gilles Peskine64f13ef2020-08-25 23:15:20 +02003685 psa_cipher_abort( &operation1 );
3686 psa_cipher_abort( &operation2 );
itayzafrir3e02b3b2018-06-12 17:06:52 +03003687 mbedtls_free( output1 );
3688 mbedtls_free( output2 );
Gilles Peskinebdf309c2018-12-03 15:36:32 +01003689 psa_destroy_key( handle );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02003690 PSA_DONE( );
Moran Pekerded84402018-06-06 16:36:50 +03003691}
3692/* END_CASE */
3693
3694/* BEGIN_CASE */
Gilles Peskine50e586b2018-06-08 14:28:46 +02003695void cipher_verify_output_multipart( int alg_arg,
3696 int key_type_arg,
itayzafrir3e02b3b2018-06-12 17:06:52 +03003697 data_t *key,
3698 data_t *input,
Gilles Peskinee0866522019-02-19 19:44:00 +01003699 int first_part_size_arg )
Moran Pekerded84402018-06-06 16:36:50 +03003700{
Gilles Peskinebdf309c2018-12-03 15:36:32 +01003701 psa_key_handle_t handle = 0;
Moran Pekerded84402018-06-06 16:36:50 +03003702 psa_key_type_t key_type = key_type_arg;
3703 psa_algorithm_t alg = alg_arg;
Gilles Peskinee0866522019-02-19 19:44:00 +01003704 size_t first_part_size = first_part_size_arg;
Moran Pekerded84402018-06-06 16:36:50 +03003705 unsigned char iv[16] = {0};
3706 size_t iv_size = 16;
3707 size_t iv_length = 0;
itayzafrir3e02b3b2018-06-12 17:06:52 +03003708 unsigned char *output1 = NULL;
Gilles Peskine048b7f02018-06-08 14:20:49 +02003709 size_t output1_buffer_size = 0;
Moran Pekerded84402018-06-06 16:36:50 +03003710 size_t output1_length = 0;
itayzafrir3e02b3b2018-06-12 17:06:52 +03003711 unsigned char *output2 = NULL;
Gilles Peskine048b7f02018-06-08 14:20:49 +02003712 size_t output2_buffer_size = 0;
Moran Pekerded84402018-06-06 16:36:50 +03003713 size_t output2_length = 0;
Gilles Peskine048b7f02018-06-08 14:20:49 +02003714 size_t function_output_length;
Jaeden Amero5bae2272019-01-04 11:48:27 +00003715 psa_cipher_operation_t operation1 = PSA_CIPHER_OPERATION_INIT;
3716 psa_cipher_operation_t operation2 = PSA_CIPHER_OPERATION_INIT;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02003717 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Moran Pekerded84402018-06-06 16:36:50 +03003718
Gilles Peskine8817f612018-12-18 00:18:46 +01003719 PSA_ASSERT( psa_crypto_init( ) );
Moran Pekerded84402018-06-06 16:36:50 +03003720
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02003721 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT | PSA_KEY_USAGE_DECRYPT );
3722 psa_set_key_algorithm( &attributes, alg );
3723 psa_set_key_type( &attributes, key_type );
Moran Pekered346952018-07-05 15:22:45 +03003724
Gilles Peskine73676cb2019-05-15 20:15:10 +02003725 PSA_ASSERT( psa_import_key( &attributes, key->x, key->len, &handle ) );
Moran Pekerded84402018-06-06 16:36:50 +03003726
Gilles Peskine8817f612018-12-18 00:18:46 +01003727 PSA_ASSERT( psa_cipher_encrypt_setup( &operation1,
3728 handle, alg ) );
3729 PSA_ASSERT( psa_cipher_decrypt_setup( &operation2,
3730 handle, alg ) );
Moran Pekerded84402018-06-06 16:36:50 +03003731
Gilles Peskine8817f612018-12-18 00:18:46 +01003732 PSA_ASSERT( psa_cipher_generate_iv( &operation1,
3733 iv, iv_size,
3734 &iv_length ) );
Gilles Peskine9d8eea72018-12-17 23:34:57 +01003735 output1_buffer_size = ( (size_t) input->len +
3736 PSA_BLOCK_CIPHER_BLOCK_SIZE( key_type ) );
Gilles Peskine8cebbba2018-09-27 13:54:18 +02003737 ASSERT_ALLOC( output1, output1_buffer_size );
Moran Pekerded84402018-06-06 16:36:50 +03003738
Gilles Peskinee0866522019-02-19 19:44:00 +01003739 TEST_ASSERT( first_part_size <= input->len );
Gilles Peskine4ca9c3f2018-06-06 18:44:09 +02003740
Gilles Peskine8817f612018-12-18 00:18:46 +01003741 PSA_ASSERT( psa_cipher_update( &operation1, input->x, first_part_size,
3742 output1, output1_buffer_size,
3743 &function_output_length ) );
Gilles Peskine048b7f02018-06-08 14:20:49 +02003744 output1_length += function_output_length;
Moran Pekerded84402018-06-06 16:36:50 +03003745
Gilles Peskine8817f612018-12-18 00:18:46 +01003746 PSA_ASSERT( psa_cipher_update( &operation1,
3747 input->x + first_part_size,
3748 input->len - first_part_size,
3749 output1, output1_buffer_size,
3750 &function_output_length ) );
Gilles Peskine048b7f02018-06-08 14:20:49 +02003751 output1_length += function_output_length;
Moran Pekerded84402018-06-06 16:36:50 +03003752
Gilles Peskine8817f612018-12-18 00:18:46 +01003753 PSA_ASSERT( psa_cipher_finish( &operation1,
3754 output1 + output1_length,
3755 output1_buffer_size - output1_length,
3756 &function_output_length ) );
Gilles Peskine048b7f02018-06-08 14:20:49 +02003757 output1_length += function_output_length;
mohammad1603d7d7ba52018-03-12 18:51:53 +02003758
Gilles Peskine8817f612018-12-18 00:18:46 +01003759 PSA_ASSERT( psa_cipher_abort( &operation1 ) );
mohammad1603d7d7ba52018-03-12 18:51:53 +02003760
Gilles Peskine048b7f02018-06-08 14:20:49 +02003761 output2_buffer_size = output1_length;
Gilles Peskine8cebbba2018-09-27 13:54:18 +02003762 ASSERT_ALLOC( output2, output2_buffer_size );
mohammad1603d7d7ba52018-03-12 18:51:53 +02003763
Gilles Peskine8817f612018-12-18 00:18:46 +01003764 PSA_ASSERT( psa_cipher_set_iv( &operation2,
3765 iv, iv_length ) );
Moran Pekerded84402018-06-06 16:36:50 +03003766
Gilles Peskine8817f612018-12-18 00:18:46 +01003767 PSA_ASSERT( psa_cipher_update( &operation2, output1, first_part_size,
3768 output2, output2_buffer_size,
3769 &function_output_length ) );
Gilles Peskine048b7f02018-06-08 14:20:49 +02003770 output2_length += function_output_length;
Moran Pekerded84402018-06-06 16:36:50 +03003771
Gilles Peskine8817f612018-12-18 00:18:46 +01003772 PSA_ASSERT( psa_cipher_update( &operation2,
3773 output1 + first_part_size,
3774 output1_length - first_part_size,
3775 output2, output2_buffer_size,
3776 &function_output_length ) );
Gilles Peskine048b7f02018-06-08 14:20:49 +02003777 output2_length += function_output_length;
Moran Pekerded84402018-06-06 16:36:50 +03003778
Gilles Peskine8817f612018-12-18 00:18:46 +01003779 PSA_ASSERT( psa_cipher_finish( &operation2,
3780 output2 + output2_length,
3781 output2_buffer_size - output2_length,
3782 &function_output_length ) );
Gilles Peskine048b7f02018-06-08 14:20:49 +02003783 output2_length += function_output_length;
Gilles Peskine4ca9c3f2018-06-06 18:44:09 +02003784
Gilles Peskine8817f612018-12-18 00:18:46 +01003785 PSA_ASSERT( psa_cipher_abort( &operation2 ) );
mohammad1603d7d7ba52018-03-12 18:51:53 +02003786
Gilles Peskinebd7dea92018-09-27 13:57:19 +02003787 ASSERT_COMPARE( input->x, input->len, output2, output2_length );
mohammad1603d7d7ba52018-03-12 18:51:53 +02003788
3789exit:
Gilles Peskine64f13ef2020-08-25 23:15:20 +02003790 psa_cipher_abort( &operation1 );
3791 psa_cipher_abort( &operation2 );
itayzafrir3e02b3b2018-06-12 17:06:52 +03003792 mbedtls_free( output1 );
3793 mbedtls_free( output2 );
Gilles Peskinebdf309c2018-12-03 15:36:32 +01003794 psa_destroy_key( handle );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02003795 PSA_DONE( );
mohammad1603d7d7ba52018-03-12 18:51:53 +02003796}
3797/* END_CASE */
Gilles Peskine7268afc2018-06-06 15:19:24 +02003798
Gilles Peskine20035e32018-02-03 22:44:14 +01003799/* BEGIN_CASE */
Gilles Peskine7da96b02018-08-17 18:45:42 +02003800void aead_encrypt_decrypt( int key_type_arg, data_t *key_data,
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02003801 int alg_arg,
Gilles Peskine7da96b02018-08-17 18:45:42 +02003802 data_t *nonce,
3803 data_t *additional_data,
3804 data_t *input_data,
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02003805 int expected_result_arg )
Gilles Peskinea1cac842018-06-11 19:33:02 +02003806{
Gilles Peskinebdf309c2018-12-03 15:36:32 +01003807 psa_key_handle_t handle = 0;
Gilles Peskinea1cac842018-06-11 19:33:02 +02003808 psa_key_type_t key_type = key_type_arg;
3809 psa_algorithm_t alg = alg_arg;
Gilles Peskinea1cac842018-06-11 19:33:02 +02003810 unsigned char *output_data = NULL;
3811 size_t output_size = 0;
3812 size_t output_length = 0;
3813 unsigned char *output_data2 = NULL;
3814 size_t output_length2 = 0;
Gilles Peskine003a4a92019-05-14 16:09:40 +02003815 size_t tag_length = PSA_AEAD_TAG_LENGTH( alg );
Gilles Peskine4abf7412018-06-18 16:35:34 +02003816 psa_status_t expected_result = expected_result_arg;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02003817 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskinea1cac842018-06-11 19:33:02 +02003818
Gilles Peskine4abf7412018-06-18 16:35:34 +02003819 output_size = input_data->len + tag_length;
Gilles Peskine003a4a92019-05-14 16:09:40 +02003820 /* For all currently defined algorithms, PSA_AEAD_ENCRYPT_OUTPUT_SIZE
3821 * should be exact. */
3822 if( expected_result != PSA_ERROR_INVALID_ARGUMENT )
3823 TEST_EQUAL( output_size,
3824 PSA_AEAD_ENCRYPT_OUTPUT_SIZE( alg, input_data->len ) );
Gilles Peskine8cebbba2018-09-27 13:54:18 +02003825 ASSERT_ALLOC( output_data, output_size );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003826
Gilles Peskine8817f612018-12-18 00:18:46 +01003827 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003828
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02003829 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT | PSA_KEY_USAGE_DECRYPT );
3830 psa_set_key_algorithm( &attributes, alg );
3831 psa_set_key_type( &attributes, key_type );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003832
Gilles Peskine049c7532019-05-15 20:22:09 +02003833 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
3834 &handle ) );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003835
Gilles Peskinefe11b722018-12-18 00:24:04 +01003836 TEST_EQUAL( psa_aead_encrypt( handle, alg,
3837 nonce->x, nonce->len,
3838 additional_data->x,
3839 additional_data->len,
3840 input_data->x, input_data->len,
3841 output_data, output_size,
Gilles Peskinef812dcf2018-12-18 00:33:25 +01003842 &output_length ),
3843 expected_result );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003844
3845 if( PSA_SUCCESS == expected_result )
3846 {
Gilles Peskine8cebbba2018-09-27 13:54:18 +02003847 ASSERT_ALLOC( output_data2, output_length );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003848
Gilles Peskine003a4a92019-05-14 16:09:40 +02003849 /* For all currently defined algorithms, PSA_AEAD_DECRYPT_OUTPUT_SIZE
3850 * should be exact. */
3851 TEST_EQUAL( input_data->len,
3852 PSA_AEAD_DECRYPT_OUTPUT_SIZE( alg, output_length ) );
3853
Gilles Peskinefe11b722018-12-18 00:24:04 +01003854 TEST_EQUAL( psa_aead_decrypt( handle, alg,
3855 nonce->x, nonce->len,
3856 additional_data->x,
3857 additional_data->len,
3858 output_data, output_length,
3859 output_data2, output_length,
Gilles Peskinef812dcf2018-12-18 00:33:25 +01003860 &output_length2 ),
3861 expected_result );
Gilles Peskine2d277862018-06-18 15:41:12 +02003862
Gilles Peskinebd7dea92018-09-27 13:57:19 +02003863 ASSERT_COMPARE( input_data->x, input_data->len,
3864 output_data2, output_length2 );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003865 }
Gilles Peskine2d277862018-06-18 15:41:12 +02003866
Gilles Peskinea1cac842018-06-11 19:33:02 +02003867exit:
Gilles Peskinebdf309c2018-12-03 15:36:32 +01003868 psa_destroy_key( handle );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003869 mbedtls_free( output_data );
3870 mbedtls_free( output_data2 );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02003871 PSA_DONE( );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003872}
3873/* END_CASE */
3874
3875/* BEGIN_CASE */
Gilles Peskine7da96b02018-08-17 18:45:42 +02003876void aead_encrypt( int key_type_arg, data_t *key_data,
3877 int alg_arg,
3878 data_t *nonce,
3879 data_t *additional_data,
3880 data_t *input_data,
3881 data_t *expected_result )
Gilles Peskinea1cac842018-06-11 19:33:02 +02003882{
Gilles Peskinebdf309c2018-12-03 15:36:32 +01003883 psa_key_handle_t handle = 0;
Gilles Peskinea1cac842018-06-11 19:33:02 +02003884 psa_key_type_t key_type = key_type_arg;
3885 psa_algorithm_t alg = alg_arg;
Gilles Peskinea1cac842018-06-11 19:33:02 +02003886 unsigned char *output_data = NULL;
3887 size_t output_size = 0;
3888 size_t output_length = 0;
Gilles Peskine003a4a92019-05-14 16:09:40 +02003889 size_t tag_length = PSA_AEAD_TAG_LENGTH( alg );
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02003890 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskinea1cac842018-06-11 19:33:02 +02003891
Gilles Peskine4abf7412018-06-18 16:35:34 +02003892 output_size = input_data->len + tag_length;
Gilles Peskine003a4a92019-05-14 16:09:40 +02003893 /* For all currently defined algorithms, PSA_AEAD_ENCRYPT_OUTPUT_SIZE
3894 * should be exact. */
3895 TEST_EQUAL( output_size,
3896 PSA_AEAD_ENCRYPT_OUTPUT_SIZE( alg, input_data->len ) );
Gilles Peskine8cebbba2018-09-27 13:54:18 +02003897 ASSERT_ALLOC( output_data, output_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02003898
Gilles Peskine8817f612018-12-18 00:18:46 +01003899 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003900
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02003901 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
3902 psa_set_key_algorithm( &attributes, alg );
3903 psa_set_key_type( &attributes, key_type );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003904
Gilles Peskine049c7532019-05-15 20:22:09 +02003905 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
3906 &handle ) );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003907
Gilles Peskine8817f612018-12-18 00:18:46 +01003908 PSA_ASSERT( psa_aead_encrypt( handle, alg,
3909 nonce->x, nonce->len,
3910 additional_data->x, additional_data->len,
3911 input_data->x, input_data->len,
3912 output_data, output_size,
3913 &output_length ) );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003914
Gilles Peskinebd7dea92018-09-27 13:57:19 +02003915 ASSERT_COMPARE( expected_result->x, expected_result->len,
3916 output_data, output_length );
Gilles Peskine2d277862018-06-18 15:41:12 +02003917
Gilles Peskinea1cac842018-06-11 19:33:02 +02003918exit:
Gilles Peskinebdf309c2018-12-03 15:36:32 +01003919 psa_destroy_key( handle );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003920 mbedtls_free( output_data );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02003921 PSA_DONE( );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003922}
3923/* END_CASE */
3924
3925/* BEGIN_CASE */
Gilles Peskine7da96b02018-08-17 18:45:42 +02003926void aead_decrypt( int key_type_arg, data_t *key_data,
3927 int alg_arg,
3928 data_t *nonce,
3929 data_t *additional_data,
3930 data_t *input_data,
3931 data_t *expected_data,
3932 int expected_result_arg )
Gilles Peskinea1cac842018-06-11 19:33:02 +02003933{
Gilles Peskinebdf309c2018-12-03 15:36:32 +01003934 psa_key_handle_t handle = 0;
Gilles Peskinea1cac842018-06-11 19:33:02 +02003935 psa_key_type_t key_type = key_type_arg;
3936 psa_algorithm_t alg = alg_arg;
Gilles Peskinea1cac842018-06-11 19:33:02 +02003937 unsigned char *output_data = NULL;
3938 size_t output_size = 0;
3939 size_t output_length = 0;
Gilles Peskine003a4a92019-05-14 16:09:40 +02003940 size_t tag_length = PSA_AEAD_TAG_LENGTH( alg );
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02003941 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine4abf7412018-06-18 16:35:34 +02003942 psa_status_t expected_result = expected_result_arg;
Gilles Peskinea1cac842018-06-11 19:33:02 +02003943
Gilles Peskine003a4a92019-05-14 16:09:40 +02003944 output_size = input_data->len - tag_length;
3945 /* For all currently defined algorithms, PSA_AEAD_DECRYPT_OUTPUT_SIZE
3946 * should be exact. */
3947 if( expected_result != PSA_ERROR_INVALID_ARGUMENT )
3948 TEST_EQUAL( output_size,
3949 PSA_AEAD_DECRYPT_OUTPUT_SIZE( alg, input_data->len ) );
Gilles Peskine8cebbba2018-09-27 13:54:18 +02003950 ASSERT_ALLOC( output_data, output_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02003951
Gilles Peskine8817f612018-12-18 00:18:46 +01003952 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003953
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02003954 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DECRYPT );
3955 psa_set_key_algorithm( &attributes, alg );
3956 psa_set_key_type( &attributes, key_type );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003957
Gilles Peskine049c7532019-05-15 20:22:09 +02003958 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
3959 &handle ) );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003960
Gilles Peskinefe11b722018-12-18 00:24:04 +01003961 TEST_EQUAL( psa_aead_decrypt( handle, alg,
3962 nonce->x, nonce->len,
3963 additional_data->x,
3964 additional_data->len,
3965 input_data->x, input_data->len,
3966 output_data, output_size,
Gilles Peskinef812dcf2018-12-18 00:33:25 +01003967 &output_length ),
3968 expected_result );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003969
Gilles Peskine2d277862018-06-18 15:41:12 +02003970 if( expected_result == PSA_SUCCESS )
Gilles Peskinebd7dea92018-09-27 13:57:19 +02003971 ASSERT_COMPARE( expected_data->x, expected_data->len,
3972 output_data, output_length );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003973
Gilles Peskinea1cac842018-06-11 19:33:02 +02003974exit:
Gilles Peskinebdf309c2018-12-03 15:36:32 +01003975 psa_destroy_key( handle );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003976 mbedtls_free( output_data );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02003977 PSA_DONE( );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003978}
3979/* END_CASE */
3980
3981/* BEGIN_CASE */
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02003982void signature_size( int type_arg,
3983 int bits,
3984 int alg_arg,
3985 int expected_size_arg )
Gilles Peskinee59236f2018-01-27 23:32:46 +01003986{
3987 psa_key_type_t type = type_arg;
3988 psa_algorithm_t alg = alg_arg;
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003989 size_t actual_size = PSA_SIGN_OUTPUT_SIZE( type, bits, alg );
Gilles Peskine841b14b2019-11-26 17:37:37 +01003990
Gilles Peskinefe11b722018-12-18 00:24:04 +01003991 TEST_EQUAL( actual_size, (size_t) expected_size_arg );
Gilles Peskine841b14b2019-11-26 17:37:37 +01003992#if defined(MBEDTLS_TEST_DEPRECATED)
3993 TEST_EQUAL( actual_size,
3994 PSA_ASYMMETRIC_SIGN_OUTPUT_SIZE( type, bits, alg ) );
3995#endif /* MBEDTLS_TEST_DEPRECATED */
3996
Gilles Peskinee59236f2018-01-27 23:32:46 +01003997exit:
3998 ;
3999}
4000/* END_CASE */
4001
4002/* BEGIN_CASE */
itayzafrir3e02b3b2018-06-12 17:06:52 +03004003void sign_deterministic( int key_type_arg, data_t *key_data,
4004 int alg_arg, data_t *input_data,
4005 data_t *output_data )
Gilles Peskinee59236f2018-01-27 23:32:46 +01004006{
Gilles Peskinebdf309c2018-12-03 15:36:32 +01004007 psa_key_handle_t handle = 0;
Gilles Peskinee59236f2018-01-27 23:32:46 +01004008 psa_key_type_t key_type = key_type_arg;
4009 psa_algorithm_t alg = alg_arg;
Gilles Peskine20035e32018-02-03 22:44:14 +01004010 size_t key_bits;
Gilles Peskine20035e32018-02-03 22:44:14 +01004011 unsigned char *signature = NULL;
4012 size_t signature_size;
4013 size_t signature_length = 0xdeadbeef;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02004014 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine20035e32018-02-03 22:44:14 +01004015
Gilles Peskine8817f612018-12-18 00:18:46 +01004016 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine20035e32018-02-03 22:44:14 +01004017
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01004018 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_HASH );
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02004019 psa_set_key_algorithm( &attributes, alg );
4020 psa_set_key_type( &attributes, key_type );
mohammad1603a97cb8c2018-03-28 03:46:26 -07004021
Gilles Peskine049c7532019-05-15 20:22:09 +02004022 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
4023 &handle ) );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02004024 PSA_ASSERT( psa_get_key_attributes( handle, &attributes ) );
4025 key_bits = psa_get_key_bits( &attributes );
Gilles Peskine20035e32018-02-03 22:44:14 +01004026
Gilles Peskine860ce9d2018-06-28 12:23:00 +02004027 /* Allocate a buffer which has the size advertized by the
4028 * library. */
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01004029 signature_size = PSA_SIGN_OUTPUT_SIZE( key_type,
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02004030 key_bits, alg );
Gilles Peskine20035e32018-02-03 22:44:14 +01004031 TEST_ASSERT( signature_size != 0 );
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01004032 TEST_ASSERT( signature_size <= PSA_SIGNATURE_MAX_SIZE );
Gilles Peskine8cebbba2018-09-27 13:54:18 +02004033 ASSERT_ALLOC( signature, signature_size );
Gilles Peskine20035e32018-02-03 22:44:14 +01004034
Gilles Peskine860ce9d2018-06-28 12:23:00 +02004035 /* Perform the signature. */
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01004036 PSA_ASSERT( psa_sign_hash( handle, alg,
4037 input_data->x, input_data->len,
4038 signature, signature_size,
4039 &signature_length ) );
Gilles Peskine9911b022018-06-29 17:30:48 +02004040 /* Verify that the signature is what is expected. */
Gilles Peskinebd7dea92018-09-27 13:57:19 +02004041 ASSERT_COMPARE( output_data->x, output_data->len,
4042 signature, signature_length );
Gilles Peskine20035e32018-02-03 22:44:14 +01004043
Gilles Peskine0627f982019-11-26 19:12:16 +01004044#if defined(MBEDTLS_TEST_DEPRECATED)
Gilles Peskine895242b2019-11-29 12:15:40 +01004045 memset( signature, 0, signature_size );
4046 signature_length = INVALID_EXPORT_LENGTH;
Gilles Peskine0627f982019-11-26 19:12:16 +01004047 PSA_ASSERT( psa_asymmetric_sign( handle, alg,
4048 input_data->x, input_data->len,
4049 signature, signature_size,
4050 &signature_length ) );
4051 ASSERT_COMPARE( output_data->x, output_data->len,
4052 signature, signature_length );
4053#endif /* MBEDTLS_TEST_DEPRECATED */
4054
Gilles Peskine20035e32018-02-03 22:44:14 +01004055exit:
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02004056 psa_reset_key_attributes( &attributes );
Gilles Peskinebdf309c2018-12-03 15:36:32 +01004057 psa_destroy_key( handle );
Gilles Peskine0189e752018-02-03 23:57:22 +01004058 mbedtls_free( signature );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02004059 PSA_DONE( );
Gilles Peskine20035e32018-02-03 22:44:14 +01004060}
4061/* END_CASE */
4062
4063/* BEGIN_CASE */
itayzafrir3e02b3b2018-06-12 17:06:52 +03004064void sign_fail( int key_type_arg, data_t *key_data,
4065 int alg_arg, data_t *input_data,
Gilles Peskine860ce9d2018-06-28 12:23:00 +02004066 int signature_size_arg, int expected_status_arg )
Gilles Peskine20035e32018-02-03 22:44:14 +01004067{
Gilles Peskinebdf309c2018-12-03 15:36:32 +01004068 psa_key_handle_t handle = 0;
Gilles Peskine20035e32018-02-03 22:44:14 +01004069 psa_key_type_t key_type = key_type_arg;
4070 psa_algorithm_t alg = alg_arg;
Gilles Peskine860ce9d2018-06-28 12:23:00 +02004071 size_t signature_size = signature_size_arg;
Gilles Peskine20035e32018-02-03 22:44:14 +01004072 psa_status_t actual_status;
4073 psa_status_t expected_status = expected_status_arg;
Gilles Peskine40f68b92018-03-07 16:43:36 +01004074 unsigned char *signature = NULL;
Gilles Peskine93aa0332018-02-03 23:58:03 +01004075 size_t signature_length = 0xdeadbeef;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02004076 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine20035e32018-02-03 22:44:14 +01004077
Gilles Peskine8cebbba2018-09-27 13:54:18 +02004078 ASSERT_ALLOC( signature, signature_size );
Gilles Peskine20035e32018-02-03 22:44:14 +01004079
Gilles Peskine8817f612018-12-18 00:18:46 +01004080 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine20035e32018-02-03 22:44:14 +01004081
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01004082 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_HASH );
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02004083 psa_set_key_algorithm( &attributes, alg );
4084 psa_set_key_type( &attributes, key_type );
mohammad1603a97cb8c2018-03-28 03:46:26 -07004085
Gilles Peskine049c7532019-05-15 20:22:09 +02004086 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
4087 &handle ) );
Gilles Peskine20035e32018-02-03 22:44:14 +01004088
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01004089 actual_status = psa_sign_hash( handle, alg,
4090 input_data->x, input_data->len,
4091 signature, signature_size,
4092 &signature_length );
Gilles Peskinefe11b722018-12-18 00:24:04 +01004093 TEST_EQUAL( actual_status, expected_status );
Gilles Peskine860ce9d2018-06-28 12:23:00 +02004094 /* The value of *signature_length is unspecified on error, but
4095 * whatever it is, it should be less than signature_size, so that
4096 * if the caller tries to read *signature_length bytes without
4097 * checking the error code then they don't overflow a buffer. */
4098 TEST_ASSERT( signature_length <= signature_size );
Gilles Peskine20035e32018-02-03 22:44:14 +01004099
Gilles Peskine895242b2019-11-29 12:15:40 +01004100#if defined(MBEDTLS_TEST_DEPRECATED)
4101 signature_length = INVALID_EXPORT_LENGTH;
4102 TEST_EQUAL( psa_asymmetric_sign( handle, alg,
4103 input_data->x, input_data->len,
4104 signature, signature_size,
4105 &signature_length ),
4106 expected_status );
4107 TEST_ASSERT( signature_length <= signature_size );
4108#endif /* MBEDTLS_TEST_DEPRECATED */
4109
Gilles Peskine20035e32018-02-03 22:44:14 +01004110exit:
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02004111 psa_reset_key_attributes( &attributes );
Gilles Peskinebdf309c2018-12-03 15:36:32 +01004112 psa_destroy_key( handle );
Gilles Peskine20035e32018-02-03 22:44:14 +01004113 mbedtls_free( signature );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02004114 PSA_DONE( );
Gilles Peskine20035e32018-02-03 22:44:14 +01004115}
4116/* END_CASE */
mohammad16038cc1cee2018-03-28 01:21:33 +03004117
4118/* BEGIN_CASE */
Gilles Peskine9911b022018-06-29 17:30:48 +02004119void sign_verify( int key_type_arg, data_t *key_data,
4120 int alg_arg, data_t *input_data )
4121{
Gilles Peskinebdf309c2018-12-03 15:36:32 +01004122 psa_key_handle_t handle = 0;
Gilles Peskine9911b022018-06-29 17:30:48 +02004123 psa_key_type_t key_type = key_type_arg;
4124 psa_algorithm_t alg = alg_arg;
4125 size_t key_bits;
4126 unsigned char *signature = NULL;
4127 size_t signature_size;
4128 size_t signature_length = 0xdeadbeef;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02004129 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine9911b022018-06-29 17:30:48 +02004130
Gilles Peskine8817f612018-12-18 00:18:46 +01004131 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine9911b022018-06-29 17:30:48 +02004132
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01004133 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_HASH | PSA_KEY_USAGE_VERIFY_HASH );
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02004134 psa_set_key_algorithm( &attributes, alg );
4135 psa_set_key_type( &attributes, key_type );
Gilles Peskine9911b022018-06-29 17:30:48 +02004136
Gilles Peskine049c7532019-05-15 20:22:09 +02004137 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
4138 &handle ) );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02004139 PSA_ASSERT( psa_get_key_attributes( handle, &attributes ) );
4140 key_bits = psa_get_key_bits( &attributes );
Gilles Peskine9911b022018-06-29 17:30:48 +02004141
4142 /* Allocate a buffer which has the size advertized by the
4143 * library. */
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01004144 signature_size = PSA_SIGN_OUTPUT_SIZE( key_type,
Gilles Peskine9911b022018-06-29 17:30:48 +02004145 key_bits, alg );
4146 TEST_ASSERT( signature_size != 0 );
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01004147 TEST_ASSERT( signature_size <= PSA_SIGNATURE_MAX_SIZE );
Gilles Peskine8cebbba2018-09-27 13:54:18 +02004148 ASSERT_ALLOC( signature, signature_size );
Gilles Peskine9911b022018-06-29 17:30:48 +02004149
4150 /* Perform the signature. */
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01004151 PSA_ASSERT( psa_sign_hash( handle, alg,
4152 input_data->x, input_data->len,
4153 signature, signature_size,
4154 &signature_length ) );
Gilles Peskine9911b022018-06-29 17:30:48 +02004155 /* Check that the signature length looks sensible. */
4156 TEST_ASSERT( signature_length <= signature_size );
4157 TEST_ASSERT( signature_length > 0 );
4158
4159 /* Use the library to verify that the signature is correct. */
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01004160 PSA_ASSERT( psa_verify_hash( handle, alg,
4161 input_data->x, input_data->len,
4162 signature, signature_length ) );
Gilles Peskine9911b022018-06-29 17:30:48 +02004163
4164 if( input_data->len != 0 )
4165 {
4166 /* Flip a bit in the input and verify that the signature is now
4167 * detected as invalid. Flip a bit at the beginning, not at the end,
4168 * because ECDSA may ignore the last few bits of the input. */
4169 input_data->x[0] ^= 1;
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01004170 TEST_EQUAL( psa_verify_hash( handle, alg,
4171 input_data->x, input_data->len,
4172 signature, signature_length ),
Gilles Peskinef812dcf2018-12-18 00:33:25 +01004173 PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine9911b022018-06-29 17:30:48 +02004174 }
4175
4176exit:
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02004177 psa_reset_key_attributes( &attributes );
Gilles Peskinebdf309c2018-12-03 15:36:32 +01004178 psa_destroy_key( handle );
Gilles Peskine9911b022018-06-29 17:30:48 +02004179 mbedtls_free( signature );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02004180 PSA_DONE( );
Gilles Peskine9911b022018-06-29 17:30:48 +02004181}
4182/* END_CASE */
4183
4184/* BEGIN_CASE */
itayzafrir3e02b3b2018-06-12 17:06:52 +03004185void asymmetric_verify( int key_type_arg, data_t *key_data,
4186 int alg_arg, data_t *hash_data,
4187 data_t *signature_data )
itayzafrir5c753392018-05-08 11:18:38 +03004188{
Gilles Peskinebdf309c2018-12-03 15:36:32 +01004189 psa_key_handle_t handle = 0;
itayzafrir5c753392018-05-08 11:18:38 +03004190 psa_key_type_t key_type = key_type_arg;
4191 psa_algorithm_t alg = alg_arg;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02004192 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
itayzafrir5c753392018-05-08 11:18:38 +03004193
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01004194 TEST_ASSERT( signature_data->len <= PSA_SIGNATURE_MAX_SIZE );
Gilles Peskine69c12672018-06-28 00:07:19 +02004195
Gilles Peskine8817f612018-12-18 00:18:46 +01004196 PSA_ASSERT( psa_crypto_init( ) );
itayzafrir5c753392018-05-08 11:18:38 +03004197
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01004198 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_VERIFY_HASH );
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02004199 psa_set_key_algorithm( &attributes, alg );
4200 psa_set_key_type( &attributes, key_type );
itayzafrir5c753392018-05-08 11:18:38 +03004201
Gilles Peskine049c7532019-05-15 20:22:09 +02004202 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
4203 &handle ) );
itayzafrir5c753392018-05-08 11:18:38 +03004204
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01004205 PSA_ASSERT( psa_verify_hash( handle, alg,
4206 hash_data->x, hash_data->len,
4207 signature_data->x, signature_data->len ) );
Gilles Peskine0627f982019-11-26 19:12:16 +01004208
4209#if defined(MBEDTLS_TEST_DEPRECATED)
4210 PSA_ASSERT( psa_asymmetric_verify( handle, alg,
4211 hash_data->x, hash_data->len,
4212 signature_data->x,
4213 signature_data->len ) );
4214
4215#endif /* MBEDTLS_TEST_DEPRECATED */
4216
itayzafrir5c753392018-05-08 11:18:38 +03004217exit:
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02004218 psa_reset_key_attributes( &attributes );
Gilles Peskinebdf309c2018-12-03 15:36:32 +01004219 psa_destroy_key( handle );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02004220 PSA_DONE( );
itayzafrir5c753392018-05-08 11:18:38 +03004221}
4222/* END_CASE */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004223
4224/* BEGIN_CASE */
itayzafrir3e02b3b2018-06-12 17:06:52 +03004225void asymmetric_verify_fail( int key_type_arg, data_t *key_data,
4226 int alg_arg, data_t *hash_data,
4227 data_t *signature_data,
4228 int expected_status_arg )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004229{
Gilles Peskinebdf309c2018-12-03 15:36:32 +01004230 psa_key_handle_t handle = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004231 psa_key_type_t key_type = key_type_arg;
4232 psa_algorithm_t alg = alg_arg;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004233 psa_status_t actual_status;
4234 psa_status_t expected_status = expected_status_arg;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02004235 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004236
Gilles Peskine8817f612018-12-18 00:18:46 +01004237 PSA_ASSERT( psa_crypto_init( ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004238
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01004239 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_VERIFY_HASH );
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02004240 psa_set_key_algorithm( &attributes, alg );
4241 psa_set_key_type( &attributes, key_type );
Nir Sonnenscheind7082602018-06-04 16:45:27 +03004242
Gilles Peskine049c7532019-05-15 20:22:09 +02004243 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
4244 &handle ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004245
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01004246 actual_status = psa_verify_hash( handle, alg,
4247 hash_data->x, hash_data->len,
4248 signature_data->x, signature_data->len );
Gilles Peskinefe11b722018-12-18 00:24:04 +01004249 TEST_EQUAL( actual_status, expected_status );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004250
Gilles Peskine895242b2019-11-29 12:15:40 +01004251#if defined(MBEDTLS_TEST_DEPRECATED)
4252 TEST_EQUAL( psa_asymmetric_verify( handle, alg,
4253 hash_data->x, hash_data->len,
4254 signature_data->x, signature_data->len ),
4255 expected_status );
4256#endif /* MBEDTLS_TEST_DEPRECATED */
4257
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004258exit:
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02004259 psa_reset_key_attributes( &attributes );
Gilles Peskinebdf309c2018-12-03 15:36:32 +01004260 psa_destroy_key( handle );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02004261 PSA_DONE( );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004262}
4263/* END_CASE */
4264
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004265/* BEGIN_CASE */
Gilles Peskine656896e2018-06-29 19:12:28 +02004266void asymmetric_encrypt( int key_type_arg,
4267 data_t *key_data,
4268 int alg_arg,
4269 data_t *input_data,
Gilles Peskine68428122018-06-30 18:42:41 +02004270 data_t *label,
Gilles Peskine656896e2018-06-29 19:12:28 +02004271 int expected_output_length_arg,
4272 int expected_status_arg )
4273{
Gilles Peskinebdf309c2018-12-03 15:36:32 +01004274 psa_key_handle_t handle = 0;
Gilles Peskine656896e2018-06-29 19:12:28 +02004275 psa_key_type_t key_type = key_type_arg;
4276 psa_algorithm_t alg = alg_arg;
4277 size_t expected_output_length = expected_output_length_arg;
4278 size_t key_bits;
4279 unsigned char *output = NULL;
4280 size_t output_size;
4281 size_t output_length = ~0;
4282 psa_status_t actual_status;
4283 psa_status_t expected_status = expected_status_arg;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02004284 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine656896e2018-06-29 19:12:28 +02004285
Gilles Peskine8817f612018-12-18 00:18:46 +01004286 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskinebdf309c2018-12-03 15:36:32 +01004287
Gilles Peskine656896e2018-06-29 19:12:28 +02004288 /* Import the key */
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02004289 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
4290 psa_set_key_algorithm( &attributes, alg );
4291 psa_set_key_type( &attributes, key_type );
Gilles Peskine049c7532019-05-15 20:22:09 +02004292 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
4293 &handle ) );
Gilles Peskine656896e2018-06-29 19:12:28 +02004294
4295 /* Determine the maximum output length */
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02004296 PSA_ASSERT( psa_get_key_attributes( handle, &attributes ) );
4297 key_bits = psa_get_key_bits( &attributes );
Gilles Peskine656896e2018-06-29 19:12:28 +02004298 output_size = PSA_ASYMMETRIC_ENCRYPT_OUTPUT_SIZE( key_type, key_bits, alg );
Gilles Peskine8cebbba2018-09-27 13:54:18 +02004299 ASSERT_ALLOC( output, output_size );
Gilles Peskine656896e2018-06-29 19:12:28 +02004300
4301 /* Encrypt the input */
Gilles Peskinebdf309c2018-12-03 15:36:32 +01004302 actual_status = psa_asymmetric_encrypt( handle, alg,
Gilles Peskine656896e2018-06-29 19:12:28 +02004303 input_data->x, input_data->len,
Gilles Peskine68428122018-06-30 18:42:41 +02004304 label->x, label->len,
Gilles Peskine656896e2018-06-29 19:12:28 +02004305 output, output_size,
4306 &output_length );
Gilles Peskinefe11b722018-12-18 00:24:04 +01004307 TEST_EQUAL( actual_status, expected_status );
4308 TEST_EQUAL( output_length, expected_output_length );
Gilles Peskine656896e2018-06-29 19:12:28 +02004309
Gilles Peskine68428122018-06-30 18:42:41 +02004310 /* If the label is empty, the test framework puts a non-null pointer
4311 * in label->x. Test that a null pointer works as well. */
4312 if( label->len == 0 )
4313 {
4314 output_length = ~0;
Gilles Peskinef7ab5ad2018-09-26 18:19:24 +02004315 if( output_size != 0 )
4316 memset( output, 0, output_size );
Gilles Peskinebdf309c2018-12-03 15:36:32 +01004317 actual_status = psa_asymmetric_encrypt( handle, alg,
Gilles Peskine68428122018-06-30 18:42:41 +02004318 input_data->x, input_data->len,
4319 NULL, label->len,
4320 output, output_size,
4321 &output_length );
Gilles Peskinefe11b722018-12-18 00:24:04 +01004322 TEST_EQUAL( actual_status, expected_status );
4323 TEST_EQUAL( output_length, expected_output_length );
Gilles Peskine68428122018-06-30 18:42:41 +02004324 }
4325
Gilles Peskine656896e2018-06-29 19:12:28 +02004326exit:
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02004327 psa_reset_key_attributes( &attributes );
Gilles Peskinebdf309c2018-12-03 15:36:32 +01004328 psa_destroy_key( handle );
Gilles Peskine656896e2018-06-29 19:12:28 +02004329 mbedtls_free( output );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02004330 PSA_DONE( );
Gilles Peskine656896e2018-06-29 19:12:28 +02004331}
4332/* END_CASE */
4333
4334/* BEGIN_CASE */
Gilles Peskine68428122018-06-30 18:42:41 +02004335void asymmetric_encrypt_decrypt( int key_type_arg,
4336 data_t *key_data,
4337 int alg_arg,
4338 data_t *input_data,
4339 data_t *label )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004340{
Gilles Peskinebdf309c2018-12-03 15:36:32 +01004341 psa_key_handle_t handle = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004342 psa_key_type_t key_type = key_type_arg;
4343 psa_algorithm_t alg = alg_arg;
Gilles Peskine55c94dd2018-06-30 18:54:48 +02004344 size_t key_bits;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004345 unsigned char *output = NULL;
Gilles Peskine55c94dd2018-06-30 18:54:48 +02004346 size_t output_size;
4347 size_t output_length = ~0;
Nir Sonnenschein0f3bdbd2018-05-02 23:56:12 +03004348 unsigned char *output2 = NULL;
Gilles Peskine55c94dd2018-06-30 18:54:48 +02004349 size_t output2_size;
4350 size_t output2_length = ~0;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02004351 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004352
Gilles Peskine8817f612018-12-18 00:18:46 +01004353 PSA_ASSERT( psa_crypto_init( ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004354
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02004355 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT | PSA_KEY_USAGE_DECRYPT );
4356 psa_set_key_algorithm( &attributes, alg );
4357 psa_set_key_type( &attributes, key_type );
Nir Sonnenscheind7082602018-06-04 16:45:27 +03004358
Gilles Peskine049c7532019-05-15 20:22:09 +02004359 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
4360 &handle ) );
Gilles Peskine55c94dd2018-06-30 18:54:48 +02004361
4362 /* Determine the maximum ciphertext length */
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02004363 PSA_ASSERT( psa_get_key_attributes( handle, &attributes ) );
4364 key_bits = psa_get_key_bits( &attributes );
Gilles Peskine55c94dd2018-06-30 18:54:48 +02004365 output_size = PSA_ASYMMETRIC_ENCRYPT_OUTPUT_SIZE( key_type, key_bits, alg );
Gilles Peskine8cebbba2018-09-27 13:54:18 +02004366 ASSERT_ALLOC( output, output_size );
Gilles Peskine55c94dd2018-06-30 18:54:48 +02004367 output2_size = input_data->len;
Gilles Peskine8cebbba2018-09-27 13:54:18 +02004368 ASSERT_ALLOC( output2, output2_size );
Gilles Peskine55c94dd2018-06-30 18:54:48 +02004369
Gilles Peskineeebd7382018-06-08 18:11:54 +02004370 /* We test encryption by checking that encrypt-then-decrypt gives back
4371 * the original plaintext because of the non-optional random
4372 * part of encryption process which prevents using fixed vectors. */
Gilles Peskine8817f612018-12-18 00:18:46 +01004373 PSA_ASSERT( psa_asymmetric_encrypt( handle, alg,
4374 input_data->x, input_data->len,
4375 label->x, label->len,
4376 output, output_size,
4377 &output_length ) );
Gilles Peskine55c94dd2018-06-30 18:54:48 +02004378 /* We don't know what ciphertext length to expect, but check that
4379 * it looks sensible. */
4380 TEST_ASSERT( output_length <= output_size );
Nir Sonnenschein0f3bdbd2018-05-02 23:56:12 +03004381
Gilles Peskine8817f612018-12-18 00:18:46 +01004382 PSA_ASSERT( psa_asymmetric_decrypt( handle, alg,
4383 output, output_length,
4384 label->x, label->len,
4385 output2, output2_size,
4386 &output2_length ) );
Gilles Peskinebd7dea92018-09-27 13:57:19 +02004387 ASSERT_COMPARE( input_data->x, input_data->len,
4388 output2, output2_length );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004389
4390exit:
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02004391 psa_reset_key_attributes( &attributes );
Gilles Peskinebdf309c2018-12-03 15:36:32 +01004392 psa_destroy_key( handle );
itayzafrir3e02b3b2018-06-12 17:06:52 +03004393 mbedtls_free( output );
4394 mbedtls_free( output2 );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02004395 PSA_DONE( );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004396}
4397/* END_CASE */
4398
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004399/* BEGIN_CASE */
Gilles Peskine68428122018-06-30 18:42:41 +02004400void asymmetric_decrypt( int key_type_arg,
4401 data_t *key_data,
4402 int alg_arg,
4403 data_t *input_data,
4404 data_t *label,
Gilles Peskine66763a02018-06-29 21:54:10 +02004405 data_t *expected_data )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004406{
Gilles Peskinebdf309c2018-12-03 15:36:32 +01004407 psa_key_handle_t handle = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004408 psa_key_type_t key_type = key_type_arg;
4409 psa_algorithm_t alg = alg_arg;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004410 unsigned char *output = NULL;
Nir Sonnenscheind70bc482018-06-04 16:31:13 +03004411 size_t output_size = 0;
Gilles Peskine55c94dd2018-06-30 18:54:48 +02004412 size_t output_length = ~0;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02004413 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004414
Jaeden Amero412654a2019-02-06 12:57:46 +00004415 output_size = expected_data->len;
Gilles Peskine8cebbba2018-09-27 13:54:18 +02004416 ASSERT_ALLOC( output, output_size );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02004417
Gilles Peskine8817f612018-12-18 00:18:46 +01004418 PSA_ASSERT( psa_crypto_init( ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004419
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02004420 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DECRYPT );
4421 psa_set_key_algorithm( &attributes, alg );
4422 psa_set_key_type( &attributes, key_type );
Nir Sonnenscheind7082602018-06-04 16:45:27 +03004423
Gilles Peskine049c7532019-05-15 20:22:09 +02004424 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
4425 &handle ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004426
Gilles Peskine8817f612018-12-18 00:18:46 +01004427 PSA_ASSERT( psa_asymmetric_decrypt( handle, alg,
4428 input_data->x, input_data->len,
4429 label->x, label->len,
4430 output,
4431 output_size,
4432 &output_length ) );
Gilles Peskinebd7dea92018-09-27 13:57:19 +02004433 ASSERT_COMPARE( expected_data->x, expected_data->len,
4434 output, output_length );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004435
Gilles Peskine68428122018-06-30 18:42:41 +02004436 /* If the label is empty, the test framework puts a non-null pointer
4437 * in label->x. Test that a null pointer works as well. */
4438 if( label->len == 0 )
4439 {
4440 output_length = ~0;
Gilles Peskinef7ab5ad2018-09-26 18:19:24 +02004441 if( output_size != 0 )
4442 memset( output, 0, output_size );
Gilles Peskine8817f612018-12-18 00:18:46 +01004443 PSA_ASSERT( psa_asymmetric_decrypt( handle, alg,
4444 input_data->x, input_data->len,
4445 NULL, label->len,
4446 output,
4447 output_size,
4448 &output_length ) );
Gilles Peskinebd7dea92018-09-27 13:57:19 +02004449 ASSERT_COMPARE( expected_data->x, expected_data->len,
4450 output, output_length );
Gilles Peskine68428122018-06-30 18:42:41 +02004451 }
4452
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004453exit:
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02004454 psa_reset_key_attributes( &attributes );
Gilles Peskinebdf309c2018-12-03 15:36:32 +01004455 psa_destroy_key( handle );
itayzafrir3e02b3b2018-06-12 17:06:52 +03004456 mbedtls_free( output );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02004457 PSA_DONE( );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004458}
4459/* END_CASE */
4460
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004461/* BEGIN_CASE */
Gilles Peskine68428122018-06-30 18:42:41 +02004462void asymmetric_decrypt_fail( int key_type_arg,
4463 data_t *key_data,
4464 int alg_arg,
4465 data_t *input_data,
4466 data_t *label,
Jaeden Amerof8daab72019-02-06 12:57:46 +00004467 int output_size_arg,
Gilles Peskine2d277862018-06-18 15:41:12 +02004468 int expected_status_arg )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004469{
Gilles Peskinebdf309c2018-12-03 15:36:32 +01004470 psa_key_handle_t handle = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004471 psa_key_type_t key_type = key_type_arg;
4472 psa_algorithm_t alg = alg_arg;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004473 unsigned char *output = NULL;
Jaeden Amerof8daab72019-02-06 12:57:46 +00004474 size_t output_size = output_size_arg;
Gilles Peskine55c94dd2018-06-30 18:54:48 +02004475 size_t output_length = ~0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004476 psa_status_t actual_status;
4477 psa_status_t expected_status = expected_status_arg;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02004478 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004479
Gilles Peskine8cebbba2018-09-27 13:54:18 +02004480 ASSERT_ALLOC( output, output_size );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02004481
Gilles Peskine8817f612018-12-18 00:18:46 +01004482 PSA_ASSERT( psa_crypto_init( ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004483
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02004484 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DECRYPT );
4485 psa_set_key_algorithm( &attributes, alg );
4486 psa_set_key_type( &attributes, key_type );
Nir Sonnenscheind7082602018-06-04 16:45:27 +03004487
Gilles Peskine049c7532019-05-15 20:22:09 +02004488 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
4489 &handle ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004490
Gilles Peskinebdf309c2018-12-03 15:36:32 +01004491 actual_status = psa_asymmetric_decrypt( handle, alg,
Gilles Peskine4abf7412018-06-18 16:35:34 +02004492 input_data->x, input_data->len,
Gilles Peskine68428122018-06-30 18:42:41 +02004493 label->x, label->len,
Gilles Peskine4abf7412018-06-18 16:35:34 +02004494 output, output_size,
Gilles Peskine2d277862018-06-18 15:41:12 +02004495 &output_length );
Gilles Peskinefe11b722018-12-18 00:24:04 +01004496 TEST_EQUAL( actual_status, expected_status );
Gilles Peskine55c94dd2018-06-30 18:54:48 +02004497 TEST_ASSERT( output_length <= output_size );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004498
Gilles Peskine68428122018-06-30 18:42:41 +02004499 /* If the label is empty, the test framework puts a non-null pointer
4500 * in label->x. Test that a null pointer works as well. */
4501 if( label->len == 0 )
4502 {
4503 output_length = ~0;
Gilles Peskinef7ab5ad2018-09-26 18:19:24 +02004504 if( output_size != 0 )
4505 memset( output, 0, output_size );
Gilles Peskinebdf309c2018-12-03 15:36:32 +01004506 actual_status = psa_asymmetric_decrypt( handle, alg,
Gilles Peskine68428122018-06-30 18:42:41 +02004507 input_data->x, input_data->len,
4508 NULL, label->len,
4509 output, output_size,
4510 &output_length );
Gilles Peskinefe11b722018-12-18 00:24:04 +01004511 TEST_EQUAL( actual_status, expected_status );
Gilles Peskine55c94dd2018-06-30 18:54:48 +02004512 TEST_ASSERT( output_length <= output_size );
Gilles Peskine68428122018-06-30 18:42:41 +02004513 }
4514
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004515exit:
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02004516 psa_reset_key_attributes( &attributes );
Gilles Peskinebdf309c2018-12-03 15:36:32 +01004517 psa_destroy_key( handle );
Gilles Peskine2d277862018-06-18 15:41:12 +02004518 mbedtls_free( output );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02004519 PSA_DONE( );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004520}
Gilles Peskine5b051bc2018-05-31 13:25:48 +02004521/* END_CASE */
Gilles Peskine05d69892018-06-19 22:00:52 +02004522
4523/* BEGIN_CASE */
Gilles Peskinecbe66502019-05-16 16:59:18 +02004524void key_derivation_init( )
Jaeden Amerod94d6712019-01-04 14:11:48 +00004525{
4526 /* Test each valid way of initializing the object, except for `= {0}`, as
4527 * Clang 5 complains when `-Wmissing-field-initializers` is used, even
4528 * though it's OK by the C standard. We could test for this, but we'd need
4529 * to supress the Clang warning for the test. */
Jaeden Amero5229bbb2019-02-07 16:33:37 +00004530 size_t capacity;
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004531 psa_key_derivation_operation_t func = psa_key_derivation_operation_init( );
4532 psa_key_derivation_operation_t init = PSA_KEY_DERIVATION_OPERATION_INIT;
4533 psa_key_derivation_operation_t zero;
Jaeden Amerod94d6712019-01-04 14:11:48 +00004534
4535 memset( &zero, 0, sizeof( zero ) );
4536
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004537 /* A default operation should not be able to report its capacity. */
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004538 TEST_EQUAL( psa_key_derivation_get_capacity( &func, &capacity ),
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004539 PSA_ERROR_BAD_STATE );
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004540 TEST_EQUAL( psa_key_derivation_get_capacity( &init, &capacity ),
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004541 PSA_ERROR_BAD_STATE );
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004542 TEST_EQUAL( psa_key_derivation_get_capacity( &zero, &capacity ),
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004543 PSA_ERROR_BAD_STATE );
Jaeden Amero5229bbb2019-02-07 16:33:37 +00004544
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004545 /* A default operation should be abortable without error. */
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004546 PSA_ASSERT( psa_key_derivation_abort(&func) );
4547 PSA_ASSERT( psa_key_derivation_abort(&init) );
4548 PSA_ASSERT( psa_key_derivation_abort(&zero) );
Jaeden Amerod94d6712019-01-04 14:11:48 +00004549}
4550/* END_CASE */
4551
Janos Follath16de4a42019-06-13 16:32:24 +01004552/* BEGIN_CASE */
4553void derive_setup( int alg_arg, int expected_status_arg )
Gilles Peskineea0fb492018-07-12 17:17:20 +02004554{
Gilles Peskineea0fb492018-07-12 17:17:20 +02004555 psa_algorithm_t alg = alg_arg;
Gilles Peskineea0fb492018-07-12 17:17:20 +02004556 psa_status_t expected_status = expected_status_arg;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004557 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Gilles Peskineea0fb492018-07-12 17:17:20 +02004558
Gilles Peskine8817f612018-12-18 00:18:46 +01004559 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskineea0fb492018-07-12 17:17:20 +02004560
Janos Follath16de4a42019-06-13 16:32:24 +01004561 TEST_EQUAL( psa_key_derivation_setup( &operation, alg ),
Gilles Peskinef812dcf2018-12-18 00:33:25 +01004562 expected_status );
Gilles Peskineea0fb492018-07-12 17:17:20 +02004563
4564exit:
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004565 psa_key_derivation_abort( &operation );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02004566 PSA_DONE( );
Gilles Peskineea0fb492018-07-12 17:17:20 +02004567}
4568/* END_CASE */
4569
Janos Follathaf3c2a02019-06-12 12:34:34 +01004570/* BEGIN_CASE */
Janos Follatha27c9272019-06-14 09:59:36 +01004571void derive_set_capacity( int alg_arg, int capacity_arg,
4572 int expected_status_arg )
4573{
4574 psa_algorithm_t alg = alg_arg;
4575 size_t capacity = capacity_arg;
4576 psa_status_t expected_status = expected_status_arg;
4577 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
4578
4579 PSA_ASSERT( psa_crypto_init( ) );
4580
4581 PSA_ASSERT( psa_key_derivation_setup( &operation, alg ) );
4582
4583 TEST_EQUAL( psa_key_derivation_set_capacity( &operation, capacity ),
4584 expected_status );
4585
4586exit:
4587 psa_key_derivation_abort( &operation );
4588 PSA_DONE( );
4589}
4590/* END_CASE */
4591
4592/* BEGIN_CASE */
Janos Follathaf3c2a02019-06-12 12:34:34 +01004593void derive_input( int alg_arg,
Gilles Peskine6842ba42019-09-23 13:49:33 +02004594 int step_arg1, int key_type_arg1, data_t *input1,
Janos Follathaf3c2a02019-06-12 12:34:34 +01004595 int expected_status_arg1,
Gilles Peskine2058c072019-09-24 17:19:33 +02004596 int step_arg2, int key_type_arg2, data_t *input2,
Janos Follathaf3c2a02019-06-12 12:34:34 +01004597 int expected_status_arg2,
Gilles Peskine2058c072019-09-24 17:19:33 +02004598 int step_arg3, int key_type_arg3, data_t *input3,
Gilles Peskine1a2904c2019-09-24 17:45:07 +02004599 int expected_status_arg3,
4600 int output_key_type_arg, int expected_output_status_arg )
Janos Follathaf3c2a02019-06-12 12:34:34 +01004601{
4602 psa_algorithm_t alg = alg_arg;
Gilles Peskine6842ba42019-09-23 13:49:33 +02004603 psa_key_derivation_step_t steps[] = {step_arg1, step_arg2, step_arg3};
4604 psa_key_type_t key_types[] = {key_type_arg1, key_type_arg2, key_type_arg3};
Janos Follathaf3c2a02019-06-12 12:34:34 +01004605 psa_status_t expected_statuses[] = {expected_status_arg1,
4606 expected_status_arg2,
4607 expected_status_arg3};
4608 data_t *inputs[] = {input1, input2, input3};
4609 psa_key_handle_t handles[] = {0, 0, 0};
4610 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
4611 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
4612 size_t i;
Gilles Peskine1a2904c2019-09-24 17:45:07 +02004613 psa_key_type_t output_key_type = output_key_type_arg;
4614 psa_key_handle_t output_handle = 0;
4615 psa_status_t expected_output_status = expected_output_status_arg;
4616 psa_status_t actual_output_status;
Janos Follathaf3c2a02019-06-12 12:34:34 +01004617
4618 PSA_ASSERT( psa_crypto_init( ) );
4619
4620 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DERIVE );
4621 psa_set_key_algorithm( &attributes, alg );
Janos Follathaf3c2a02019-06-12 12:34:34 +01004622
4623 PSA_ASSERT( psa_key_derivation_setup( &operation, alg ) );
4624
4625 for( i = 0; i < ARRAY_LENGTH( steps ); i++ )
4626 {
Gilles Peskineb8965192019-09-24 16:21:10 +02004627 if( key_types[i] != PSA_KEY_TYPE_NONE )
Janos Follathaf3c2a02019-06-12 12:34:34 +01004628 {
Gilles Peskine6842ba42019-09-23 13:49:33 +02004629 psa_set_key_type( &attributes, key_types[i] );
4630 PSA_ASSERT( psa_import_key( &attributes,
4631 inputs[i]->x, inputs[i]->len,
4632 &handles[i] ) );
4633 TEST_EQUAL( psa_key_derivation_input_key( &operation, steps[i],
4634 handles[i] ),
4635 expected_statuses[i] );
4636 }
4637 else
4638 {
4639 TEST_EQUAL( psa_key_derivation_input_bytes(
4640 &operation, steps[i],
4641 inputs[i]->x, inputs[i]->len ),
4642 expected_statuses[i] );
Janos Follathaf3c2a02019-06-12 12:34:34 +01004643 }
4644 }
4645
Gilles Peskine1a2904c2019-09-24 17:45:07 +02004646 if( output_key_type != PSA_KEY_TYPE_NONE )
4647 {
4648 psa_reset_key_attributes( &attributes );
4649 psa_set_key_type( &attributes, PSA_KEY_TYPE_RAW_DATA );
4650 psa_set_key_bits( &attributes, 8 );
4651 actual_output_status =
4652 psa_key_derivation_output_key( &attributes, &operation,
4653 &output_handle );
4654 }
4655 else
4656 {
4657 uint8_t buffer[1];
4658 actual_output_status =
4659 psa_key_derivation_output_bytes( &operation,
4660 buffer, sizeof( buffer ) );
4661 }
4662 TEST_EQUAL( actual_output_status, expected_output_status );
4663
Janos Follathaf3c2a02019-06-12 12:34:34 +01004664exit:
4665 psa_key_derivation_abort( &operation );
4666 for( i = 0; i < ARRAY_LENGTH( handles ); i++ )
4667 psa_destroy_key( handles[i] );
Gilles Peskine1a2904c2019-09-24 17:45:07 +02004668 psa_destroy_key( output_handle );
Janos Follathaf3c2a02019-06-12 12:34:34 +01004669 PSA_DONE( );
4670}
4671/* END_CASE */
4672
Janos Follathd958bb72019-07-03 15:02:16 +01004673/* BEGIN_CASE */
4674void test_derive_invalid_key_derivation_state( int alg_arg )
Nir Sonnenscheine5204c92018-10-22 17:24:55 +03004675{
Janos Follathd958bb72019-07-03 15:02:16 +01004676 psa_algorithm_t alg = alg_arg;
Gilles Peskinebdf309c2018-12-03 15:36:32 +01004677 psa_key_handle_t handle = 0;
Nir Sonnenschein4eda37b2018-10-31 12:15:58 +02004678 size_t key_type = PSA_KEY_TYPE_DERIVE;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004679 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Janos Follathd958bb72019-07-03 15:02:16 +01004680 unsigned char input1[] = "Input 1";
4681 size_t input1_length = sizeof( input1 );
4682 unsigned char input2[] = "Input 2";
4683 size_t input2_length = sizeof( input2 );
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03004684 uint8_t buffer[42];
Nir Sonnenschein1caf6d22018-11-01 12:27:20 +02004685 size_t capacity = sizeof( buffer );
Nir Sonnenscheindd69d8b2018-11-01 12:24:23 +02004686 const uint8_t key_data[22] = { 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b,
4687 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b,
4688 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b};
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02004689 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Nir Sonnenscheine5204c92018-10-22 17:24:55 +03004690
Gilles Peskine8817f612018-12-18 00:18:46 +01004691 PSA_ASSERT( psa_crypto_init( ) );
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03004692
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02004693 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DERIVE );
4694 psa_set_key_algorithm( &attributes, alg );
4695 psa_set_key_type( &attributes, key_type );
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03004696
Gilles Peskine73676cb2019-05-15 20:15:10 +02004697 PSA_ASSERT( psa_import_key( &attributes,
4698 key_data, sizeof( key_data ),
4699 &handle ) );
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03004700
4701 /* valid key derivation */
Janos Follathd958bb72019-07-03 15:02:16 +01004702 if( !setup_key_derivation_wrap( &operation, handle, alg,
4703 input1, input1_length,
4704 input2, input2_length,
4705 capacity ) )
4706 goto exit;
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03004707
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004708 /* state of operation shouldn't allow additional generation */
Janos Follathd958bb72019-07-03 15:02:16 +01004709 TEST_EQUAL( psa_key_derivation_setup( &operation, alg ),
Gilles Peskinef812dcf2018-12-18 00:33:25 +01004710 PSA_ERROR_BAD_STATE );
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03004711
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004712 PSA_ASSERT( psa_key_derivation_output_bytes( &operation, buffer, capacity ) );
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03004713
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004714 TEST_EQUAL( psa_key_derivation_output_bytes( &operation, buffer, capacity ),
David Saadab4ecc272019-02-14 13:48:10 +02004715 PSA_ERROR_INSUFFICIENT_DATA );
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03004716
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03004717exit:
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004718 psa_key_derivation_abort( &operation );
Gilles Peskinebdf309c2018-12-03 15:36:32 +01004719 psa_destroy_key( handle );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02004720 PSA_DONE( );
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03004721}
4722/* END_CASE */
4723
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03004724/* BEGIN_CASE */
Gilles Peskinecbe66502019-05-16 16:59:18 +02004725void test_derive_invalid_key_derivation_tests( )
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03004726{
4727 uint8_t output_buffer[16];
4728 size_t buffer_size = 16;
4729 size_t capacity = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004730 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03004731
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004732 TEST_ASSERT( psa_key_derivation_output_bytes( &operation,
4733 output_buffer, buffer_size )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004734 == PSA_ERROR_BAD_STATE );
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03004735
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004736 TEST_ASSERT( psa_key_derivation_get_capacity( &operation, &capacity )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004737 == PSA_ERROR_BAD_STATE );
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03004738
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004739 PSA_ASSERT( psa_key_derivation_abort( &operation ) );
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03004740
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004741 TEST_ASSERT( psa_key_derivation_output_bytes( &operation,
4742 output_buffer, buffer_size )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004743 == PSA_ERROR_BAD_STATE );
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03004744
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004745 TEST_ASSERT( psa_key_derivation_get_capacity( &operation, &capacity )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004746 == PSA_ERROR_BAD_STATE );
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03004747
4748exit:
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004749 psa_key_derivation_abort( &operation );
Nir Sonnenscheine5204c92018-10-22 17:24:55 +03004750}
4751/* END_CASE */
4752
4753/* BEGIN_CASE */
Gilles Peskine96ee5c72018-07-12 17:24:54 +02004754void derive_output( int alg_arg,
Gilles Peskine1468da72019-05-29 17:35:49 +02004755 int step1_arg, data_t *input1,
4756 int step2_arg, data_t *input2,
4757 int step3_arg, data_t *input3,
Gilles Peskine96ee5c72018-07-12 17:24:54 +02004758 int requested_capacity_arg,
4759 data_t *expected_output1,
4760 data_t *expected_output2 )
4761{
Gilles Peskine96ee5c72018-07-12 17:24:54 +02004762 psa_algorithm_t alg = alg_arg;
Gilles Peskine1468da72019-05-29 17:35:49 +02004763 psa_key_derivation_step_t steps[] = {step1_arg, step2_arg, step3_arg};
4764 data_t *inputs[] = {input1, input2, input3};
4765 psa_key_handle_t handles[] = {0, 0, 0};
Gilles Peskine96ee5c72018-07-12 17:24:54 +02004766 size_t requested_capacity = requested_capacity_arg;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004767 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Gilles Peskine96ee5c72018-07-12 17:24:54 +02004768 uint8_t *expected_outputs[2] =
4769 {expected_output1->x, expected_output2->x};
4770 size_t output_sizes[2] =
4771 {expected_output1->len, expected_output2->len};
4772 size_t output_buffer_size = 0;
4773 uint8_t *output_buffer = NULL;
4774 size_t expected_capacity;
4775 size_t current_capacity;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004776 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine96ee5c72018-07-12 17:24:54 +02004777 psa_status_t status;
Gilles Peskine1468da72019-05-29 17:35:49 +02004778 size_t i;
Gilles Peskine96ee5c72018-07-12 17:24:54 +02004779
4780 for( i = 0; i < ARRAY_LENGTH( expected_outputs ); i++ )
4781 {
4782 if( output_sizes[i] > output_buffer_size )
4783 output_buffer_size = output_sizes[i];
4784 if( output_sizes[i] == 0 )
4785 expected_outputs[i] = NULL;
4786 }
Gilles Peskine8cebbba2018-09-27 13:54:18 +02004787 ASSERT_ALLOC( output_buffer, output_buffer_size );
Gilles Peskine8817f612018-12-18 00:18:46 +01004788 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine96ee5c72018-07-12 17:24:54 +02004789
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004790 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DERIVE );
4791 psa_set_key_algorithm( &attributes, alg );
4792 psa_set_key_type( &attributes, PSA_KEY_TYPE_DERIVE );
Gilles Peskine96ee5c72018-07-12 17:24:54 +02004793
Gilles Peskine96ee5c72018-07-12 17:24:54 +02004794 /* Extraction phase. */
Gilles Peskine1468da72019-05-29 17:35:49 +02004795 PSA_ASSERT( psa_key_derivation_setup( &operation, alg ) );
4796 PSA_ASSERT( psa_key_derivation_set_capacity( &operation,
4797 requested_capacity ) );
4798 for( i = 0; i < ARRAY_LENGTH( steps ); i++ )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004799 {
Gilles Peskine1468da72019-05-29 17:35:49 +02004800 switch( steps[i] )
4801 {
4802 case 0:
4803 break;
4804 case PSA_KEY_DERIVATION_INPUT_SECRET:
4805 PSA_ASSERT( psa_import_key( &attributes,
4806 inputs[i]->x, inputs[i]->len,
4807 &handles[i] ) );
4808 PSA_ASSERT( psa_key_derivation_input_key(
4809 &operation, steps[i],
4810 handles[i] ) );
4811 break;
4812 default:
4813 PSA_ASSERT( psa_key_derivation_input_bytes(
4814 &operation, steps[i],
4815 inputs[i]->x, inputs[i]->len ) );
4816 break;
4817 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004818 }
Gilles Peskine1468da72019-05-29 17:35:49 +02004819
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004820 PSA_ASSERT( psa_key_derivation_get_capacity( &operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004821 &current_capacity ) );
Gilles Peskinefe11b722018-12-18 00:24:04 +01004822 TEST_EQUAL( current_capacity, requested_capacity );
Gilles Peskine96ee5c72018-07-12 17:24:54 +02004823 expected_capacity = requested_capacity;
4824
4825 /* Expansion phase. */
4826 for( i = 0; i < ARRAY_LENGTH( expected_outputs ); i++ )
4827 {
4828 /* Read some bytes. */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004829 status = psa_key_derivation_output_bytes( &operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004830 output_buffer, output_sizes[i] );
Gilles Peskine96ee5c72018-07-12 17:24:54 +02004831 if( expected_capacity == 0 && output_sizes[i] == 0 )
4832 {
4833 /* Reading 0 bytes when 0 bytes are available can go either way. */
4834 TEST_ASSERT( status == PSA_SUCCESS ||
David Saadab4ecc272019-02-14 13:48:10 +02004835 status == PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskine96ee5c72018-07-12 17:24:54 +02004836 continue;
4837 }
4838 else if( expected_capacity == 0 ||
4839 output_sizes[i] > expected_capacity )
4840 {
4841 /* Capacity exceeded. */
David Saadab4ecc272019-02-14 13:48:10 +02004842 TEST_EQUAL( status, PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskine96ee5c72018-07-12 17:24:54 +02004843 expected_capacity = 0;
4844 continue;
4845 }
4846 /* Success. Check the read data. */
Gilles Peskine8817f612018-12-18 00:18:46 +01004847 PSA_ASSERT( status );
Gilles Peskine96ee5c72018-07-12 17:24:54 +02004848 if( output_sizes[i] != 0 )
Gilles Peskine0dfba2d2018-12-18 00:40:50 +01004849 ASSERT_COMPARE( output_buffer, output_sizes[i],
4850 expected_outputs[i], output_sizes[i] );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004851 /* Check the operation status. */
Gilles Peskine96ee5c72018-07-12 17:24:54 +02004852 expected_capacity -= output_sizes[i];
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004853 PSA_ASSERT( psa_key_derivation_get_capacity( &operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004854 &current_capacity ) );
Gilles Peskinefe11b722018-12-18 00:24:04 +01004855 TEST_EQUAL( expected_capacity, current_capacity );
Gilles Peskine96ee5c72018-07-12 17:24:54 +02004856 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004857 PSA_ASSERT( psa_key_derivation_abort( &operation ) );
Gilles Peskine96ee5c72018-07-12 17:24:54 +02004858
4859exit:
4860 mbedtls_free( output_buffer );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004861 psa_key_derivation_abort( &operation );
Gilles Peskine1468da72019-05-29 17:35:49 +02004862 for( i = 0; i < ARRAY_LENGTH( handles ); i++ )
4863 psa_destroy_key( handles[i] );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02004864 PSA_DONE( );
Gilles Peskine96ee5c72018-07-12 17:24:54 +02004865}
4866/* END_CASE */
4867
4868/* BEGIN_CASE */
Gilles Peskined54931c2018-07-17 21:06:59 +02004869void derive_full( int alg_arg,
4870 data_t *key_data,
Janos Follath47f27ed2019-06-25 13:24:52 +01004871 data_t *input1,
4872 data_t *input2,
Gilles Peskined54931c2018-07-17 21:06:59 +02004873 int requested_capacity_arg )
4874{
Gilles Peskinebdf309c2018-12-03 15:36:32 +01004875 psa_key_handle_t handle = 0;
Gilles Peskined54931c2018-07-17 21:06:59 +02004876 psa_algorithm_t alg = alg_arg;
4877 size_t requested_capacity = requested_capacity_arg;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004878 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Gilles Peskined54931c2018-07-17 21:06:59 +02004879 unsigned char output_buffer[16];
4880 size_t expected_capacity = requested_capacity;
4881 size_t current_capacity;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004882 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskined54931c2018-07-17 21:06:59 +02004883
Gilles Peskine8817f612018-12-18 00:18:46 +01004884 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskined54931c2018-07-17 21:06:59 +02004885
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004886 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DERIVE );
4887 psa_set_key_algorithm( &attributes, alg );
4888 psa_set_key_type( &attributes, PSA_KEY_TYPE_DERIVE );
Gilles Peskined54931c2018-07-17 21:06:59 +02004889
Gilles Peskine049c7532019-05-15 20:22:09 +02004890 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
4891 &handle ) );
Gilles Peskined54931c2018-07-17 21:06:59 +02004892
Janos Follathf2815ea2019-07-03 12:41:36 +01004893 if( !setup_key_derivation_wrap( &operation, handle, alg,
4894 input1->x, input1->len,
4895 input2->x, input2->len,
4896 requested_capacity ) )
4897 goto exit;
Janos Follath47f27ed2019-06-25 13:24:52 +01004898
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004899 PSA_ASSERT( psa_key_derivation_get_capacity( &operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004900 &current_capacity ) );
Gilles Peskinefe11b722018-12-18 00:24:04 +01004901 TEST_EQUAL( current_capacity, expected_capacity );
Gilles Peskined54931c2018-07-17 21:06:59 +02004902
4903 /* Expansion phase. */
4904 while( current_capacity > 0 )
4905 {
4906 size_t read_size = sizeof( output_buffer );
4907 if( read_size > current_capacity )
4908 read_size = current_capacity;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004909 PSA_ASSERT( psa_key_derivation_output_bytes( &operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004910 output_buffer,
4911 read_size ) );
Gilles Peskined54931c2018-07-17 21:06:59 +02004912 expected_capacity -= read_size;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004913 PSA_ASSERT( psa_key_derivation_get_capacity( &operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004914 &current_capacity ) );
Gilles Peskinefe11b722018-12-18 00:24:04 +01004915 TEST_EQUAL( current_capacity, expected_capacity );
Gilles Peskined54931c2018-07-17 21:06:59 +02004916 }
4917
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004918 /* Check that the operation refuses to go over capacity. */
4919 TEST_EQUAL( psa_key_derivation_output_bytes( &operation, output_buffer, 1 ),
David Saadab4ecc272019-02-14 13:48:10 +02004920 PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskined54931c2018-07-17 21:06:59 +02004921
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004922 PSA_ASSERT( psa_key_derivation_abort( &operation ) );
Gilles Peskined54931c2018-07-17 21:06:59 +02004923
4924exit:
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004925 psa_key_derivation_abort( &operation );
Gilles Peskinebdf309c2018-12-03 15:36:32 +01004926 psa_destroy_key( handle );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02004927 PSA_DONE( );
Gilles Peskined54931c2018-07-17 21:06:59 +02004928}
4929/* END_CASE */
4930
Janos Follathe60c9052019-07-03 13:51:30 +01004931/* BEGIN_CASE */
Gilles Peskine0386fba2018-07-12 17:29:22 +02004932void derive_key_exercise( int alg_arg,
4933 data_t *key_data,
Janos Follathe60c9052019-07-03 13:51:30 +01004934 data_t *input1,
4935 data_t *input2,
Gilles Peskine0386fba2018-07-12 17:29:22 +02004936 int derived_type_arg,
4937 int derived_bits_arg,
4938 int derived_usage_arg,
4939 int derived_alg_arg )
4940{
Gilles Peskinebdf309c2018-12-03 15:36:32 +01004941 psa_key_handle_t base_handle = 0;
4942 psa_key_handle_t derived_handle = 0;
Gilles Peskine0386fba2018-07-12 17:29:22 +02004943 psa_algorithm_t alg = alg_arg;
4944 psa_key_type_t derived_type = derived_type_arg;
4945 size_t derived_bits = derived_bits_arg;
4946 psa_key_usage_t derived_usage = derived_usage_arg;
4947 psa_algorithm_t derived_alg = derived_alg_arg;
4948 size_t capacity = PSA_BITS_TO_BYTES( derived_bits );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004949 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004950 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02004951 psa_key_attributes_t got_attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine0386fba2018-07-12 17:29:22 +02004952
Gilles Peskine8817f612018-12-18 00:18:46 +01004953 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine0386fba2018-07-12 17:29:22 +02004954
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004955 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DERIVE );
4956 psa_set_key_algorithm( &attributes, alg );
4957 psa_set_key_type( &attributes, PSA_KEY_TYPE_DERIVE );
Gilles Peskine049c7532019-05-15 20:22:09 +02004958 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
4959 &base_handle ) );
Gilles Peskine0386fba2018-07-12 17:29:22 +02004960
4961 /* Derive a key. */
Janos Follathe60c9052019-07-03 13:51:30 +01004962 if ( setup_key_derivation_wrap( &operation, base_handle, alg,
4963 input1->x, input1->len,
4964 input2->x, input2->len, capacity ) )
4965 goto exit;
4966
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004967 psa_set_key_usage_flags( &attributes, derived_usage );
4968 psa_set_key_algorithm( &attributes, derived_alg );
4969 psa_set_key_type( &attributes, derived_type );
Gilles Peskine3a4f1f82019-04-26 13:49:28 +02004970 psa_set_key_bits( &attributes, derived_bits );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004971 PSA_ASSERT( psa_key_derivation_output_key( &attributes, &operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004972 &derived_handle ) );
Gilles Peskine0386fba2018-07-12 17:29:22 +02004973
4974 /* Test the key information */
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02004975 PSA_ASSERT( psa_get_key_attributes( derived_handle, &got_attributes ) );
4976 TEST_EQUAL( psa_get_key_type( &got_attributes ), derived_type );
4977 TEST_EQUAL( psa_get_key_bits( &got_attributes ), derived_bits );
Gilles Peskine0386fba2018-07-12 17:29:22 +02004978
4979 /* Exercise the derived key. */
Gilles Peskinebdf309c2018-12-03 15:36:32 +01004980 if( ! exercise_key( derived_handle, derived_usage, derived_alg ) )
Gilles Peskine0386fba2018-07-12 17:29:22 +02004981 goto exit;
4982
4983exit:
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004984 psa_key_derivation_abort( &operation );
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02004985 psa_reset_key_attributes( &got_attributes );
Gilles Peskinebdf309c2018-12-03 15:36:32 +01004986 psa_destroy_key( base_handle );
4987 psa_destroy_key( derived_handle );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02004988 PSA_DONE( );
Gilles Peskine0386fba2018-07-12 17:29:22 +02004989}
4990/* END_CASE */
4991
Janos Follath42fd8882019-07-03 14:17:09 +01004992/* BEGIN_CASE */
Gilles Peskine0386fba2018-07-12 17:29:22 +02004993void derive_key_export( int alg_arg,
4994 data_t *key_data,
Janos Follath42fd8882019-07-03 14:17:09 +01004995 data_t *input1,
4996 data_t *input2,
Gilles Peskine0386fba2018-07-12 17:29:22 +02004997 int bytes1_arg,
4998 int bytes2_arg )
4999{
Gilles Peskinebdf309c2018-12-03 15:36:32 +01005000 psa_key_handle_t base_handle = 0;
5001 psa_key_handle_t derived_handle = 0;
Gilles Peskine0386fba2018-07-12 17:29:22 +02005002 psa_algorithm_t alg = alg_arg;
5003 size_t bytes1 = bytes1_arg;
5004 size_t bytes2 = bytes2_arg;
5005 size_t capacity = bytes1 + bytes2;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005006 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Gilles Peskine8cebbba2018-09-27 13:54:18 +02005007 uint8_t *output_buffer = NULL;
5008 uint8_t *export_buffer = NULL;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005009 psa_key_attributes_t base_attributes = PSA_KEY_ATTRIBUTES_INIT;
5010 psa_key_attributes_t derived_attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine0386fba2018-07-12 17:29:22 +02005011 size_t length;
5012
Gilles Peskine8cebbba2018-09-27 13:54:18 +02005013 ASSERT_ALLOC( output_buffer, capacity );
5014 ASSERT_ALLOC( export_buffer, capacity );
Gilles Peskine8817f612018-12-18 00:18:46 +01005015 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine0386fba2018-07-12 17:29:22 +02005016
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005017 psa_set_key_usage_flags( &base_attributes, PSA_KEY_USAGE_DERIVE );
5018 psa_set_key_algorithm( &base_attributes, alg );
5019 psa_set_key_type( &base_attributes, PSA_KEY_TYPE_DERIVE );
Gilles Peskine049c7532019-05-15 20:22:09 +02005020 PSA_ASSERT( psa_import_key( &base_attributes, key_data->x, key_data->len,
5021 &base_handle ) );
Gilles Peskine0386fba2018-07-12 17:29:22 +02005022
5023 /* Derive some material and output it. */
Janos Follath42fd8882019-07-03 14:17:09 +01005024 if( !setup_key_derivation_wrap( &operation, base_handle, alg,
5025 input1->x, input1->len,
5026 input2->x, input2->len, capacity ) )
5027 goto exit;
5028
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005029 PSA_ASSERT( psa_key_derivation_output_bytes( &operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005030 output_buffer,
5031 capacity ) );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005032 PSA_ASSERT( psa_key_derivation_abort( &operation ) );
Gilles Peskine0386fba2018-07-12 17:29:22 +02005033
5034 /* Derive the same output again, but this time store it in key objects. */
Janos Follath42fd8882019-07-03 14:17:09 +01005035 if( !setup_key_derivation_wrap( &operation, base_handle, alg,
5036 input1->x, input1->len,
5037 input2->x, input2->len, capacity ) )
5038 goto exit;
5039
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005040 psa_set_key_usage_flags( &derived_attributes, PSA_KEY_USAGE_EXPORT );
5041 psa_set_key_algorithm( &derived_attributes, 0 );
5042 psa_set_key_type( &derived_attributes, PSA_KEY_TYPE_RAW_DATA );
Gilles Peskine3a4f1f82019-04-26 13:49:28 +02005043 psa_set_key_bits( &derived_attributes, PSA_BYTES_TO_BITS( bytes1 ) );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005044 PSA_ASSERT( psa_key_derivation_output_key( &derived_attributes, &operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005045 &derived_handle ) );
Gilles Peskine8817f612018-12-18 00:18:46 +01005046 PSA_ASSERT( psa_export_key( derived_handle,
5047 export_buffer, bytes1,
5048 &length ) );
Gilles Peskinefe11b722018-12-18 00:24:04 +01005049 TEST_EQUAL( length, bytes1 );
Gilles Peskine8817f612018-12-18 00:18:46 +01005050 PSA_ASSERT( psa_destroy_key( derived_handle ) );
Gilles Peskine3a4f1f82019-04-26 13:49:28 +02005051 psa_set_key_bits( &derived_attributes, PSA_BYTES_TO_BITS( bytes2 ) );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005052 PSA_ASSERT( psa_key_derivation_output_key( &derived_attributes, &operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005053 &derived_handle ) );
Gilles Peskine8817f612018-12-18 00:18:46 +01005054 PSA_ASSERT( psa_export_key( derived_handle,
5055 export_buffer + bytes1, bytes2,
5056 &length ) );
Gilles Peskinefe11b722018-12-18 00:24:04 +01005057 TEST_EQUAL( length, bytes2 );
Gilles Peskine0386fba2018-07-12 17:29:22 +02005058
5059 /* Compare the outputs from the two runs. */
Gilles Peskine0dfba2d2018-12-18 00:40:50 +01005060 ASSERT_COMPARE( output_buffer, bytes1 + bytes2,
5061 export_buffer, capacity );
Gilles Peskine0386fba2018-07-12 17:29:22 +02005062
5063exit:
5064 mbedtls_free( output_buffer );
5065 mbedtls_free( export_buffer );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005066 psa_key_derivation_abort( &operation );
Gilles Peskinebdf309c2018-12-03 15:36:32 +01005067 psa_destroy_key( base_handle );
5068 psa_destroy_key( derived_handle );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02005069 PSA_DONE( );
Gilles Peskine0386fba2018-07-12 17:29:22 +02005070}
5071/* END_CASE */
5072
5073/* BEGIN_CASE */
Gilles Peskine7c227ae2019-07-31 15:14:44 +02005074void derive_key( int alg_arg,
5075 data_t *key_data, data_t *input1, data_t *input2,
5076 int type_arg, int bits_arg,
5077 int expected_status_arg )
Gilles Peskinec744d992019-07-30 17:26:54 +02005078{
5079 psa_key_handle_t base_handle = 0;
5080 psa_key_handle_t derived_handle = 0;
5081 psa_algorithm_t alg = alg_arg;
Gilles Peskine7c227ae2019-07-31 15:14:44 +02005082 psa_key_type_t type = type_arg;
Gilles Peskinec744d992019-07-30 17:26:54 +02005083 size_t bits = bits_arg;
5084 psa_status_t expected_status = expected_status_arg;
5085 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
5086 psa_key_attributes_t base_attributes = PSA_KEY_ATTRIBUTES_INIT;
5087 psa_key_attributes_t derived_attributes = PSA_KEY_ATTRIBUTES_INIT;
5088
5089 PSA_ASSERT( psa_crypto_init( ) );
5090
5091 psa_set_key_usage_flags( &base_attributes, PSA_KEY_USAGE_DERIVE );
5092 psa_set_key_algorithm( &base_attributes, alg );
5093 psa_set_key_type( &base_attributes, PSA_KEY_TYPE_DERIVE );
5094 PSA_ASSERT( psa_import_key( &base_attributes, key_data->x, key_data->len,
5095 &base_handle ) );
5096
5097 if( !setup_key_derivation_wrap( &operation, base_handle, alg,
5098 input1->x, input1->len,
5099 input2->x, input2->len, SIZE_MAX ) )
5100 goto exit;
5101
5102 psa_set_key_usage_flags( &derived_attributes, PSA_KEY_USAGE_EXPORT );
5103 psa_set_key_algorithm( &derived_attributes, 0 );
Gilles Peskine7c227ae2019-07-31 15:14:44 +02005104 psa_set_key_type( &derived_attributes, type );
Gilles Peskinec744d992019-07-30 17:26:54 +02005105 psa_set_key_bits( &derived_attributes, bits );
5106 TEST_EQUAL( psa_key_derivation_output_key( &derived_attributes, &operation,
5107 &derived_handle ),
5108 expected_status );
5109
5110exit:
5111 psa_key_derivation_abort( &operation );
5112 psa_destroy_key( base_handle );
5113 psa_destroy_key( derived_handle );
5114 PSA_DONE( );
5115}
5116/* END_CASE */
5117
5118/* BEGIN_CASE */
Gilles Peskine01d718c2018-09-18 12:01:02 +02005119void key_agreement_setup( int alg_arg,
5120 int our_key_type_arg, data_t *our_key_data,
5121 data_t *peer_key_data,
5122 int expected_status_arg )
5123{
Gilles Peskinebdf309c2018-12-03 15:36:32 +01005124 psa_key_handle_t our_key = 0;
Gilles Peskine01d718c2018-09-18 12:01:02 +02005125 psa_algorithm_t alg = alg_arg;
5126 psa_key_type_t our_key_type = our_key_type_arg;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005127 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005128 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine77f40d82019-04-11 21:27:06 +02005129 psa_status_t expected_status = expected_status_arg;
5130 psa_status_t status;
Gilles Peskine01d718c2018-09-18 12:01:02 +02005131
Gilles Peskine8817f612018-12-18 00:18:46 +01005132 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005133
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005134 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DERIVE );
5135 psa_set_key_algorithm( &attributes, alg );
5136 psa_set_key_type( &attributes, our_key_type );
Gilles Peskine049c7532019-05-15 20:22:09 +02005137 PSA_ASSERT( psa_import_key( &attributes,
5138 our_key_data->x, our_key_data->len,
5139 &our_key ) );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005140
Gilles Peskine77f40d82019-04-11 21:27:06 +02005141 /* The tests currently include inputs that should fail at either step.
5142 * Test cases that fail at the setup step should be changed to call
5143 * key_derivation_setup instead, and this function should be renamed
5144 * to key_agreement_fail. */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005145 status = psa_key_derivation_setup( &operation, alg );
Gilles Peskine77f40d82019-04-11 21:27:06 +02005146 if( status == PSA_SUCCESS )
5147 {
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005148 TEST_EQUAL( psa_key_derivation_key_agreement(
5149 &operation, PSA_KEY_DERIVATION_INPUT_SECRET,
5150 our_key,
5151 peer_key_data->x, peer_key_data->len ),
Gilles Peskine77f40d82019-04-11 21:27:06 +02005152 expected_status );
5153 }
5154 else
5155 {
5156 TEST_ASSERT( status == expected_status );
5157 }
Gilles Peskine01d718c2018-09-18 12:01:02 +02005158
5159exit:
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005160 psa_key_derivation_abort( &operation );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005161 psa_destroy_key( our_key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02005162 PSA_DONE( );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005163}
5164/* END_CASE */
5165
5166/* BEGIN_CASE */
Gilles Peskinef0cba732019-04-11 22:12:38 +02005167void raw_key_agreement( int alg_arg,
5168 int our_key_type_arg, data_t *our_key_data,
5169 data_t *peer_key_data,
5170 data_t *expected_output )
5171{
5172 psa_key_handle_t our_key = 0;
5173 psa_algorithm_t alg = alg_arg;
5174 psa_key_type_t our_key_type = our_key_type_arg;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005175 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskinef0cba732019-04-11 22:12:38 +02005176 unsigned char *output = NULL;
5177 size_t output_length = ~0;
5178
5179 ASSERT_ALLOC( output, expected_output->len );
5180 PSA_ASSERT( psa_crypto_init( ) );
5181
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005182 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DERIVE );
5183 psa_set_key_algorithm( &attributes, alg );
5184 psa_set_key_type( &attributes, our_key_type );
Gilles Peskine049c7532019-05-15 20:22:09 +02005185 PSA_ASSERT( psa_import_key( &attributes,
5186 our_key_data->x, our_key_data->len,
5187 &our_key ) );
Gilles Peskinef0cba732019-04-11 22:12:38 +02005188
Gilles Peskinebe697d82019-05-16 18:00:41 +02005189 PSA_ASSERT( psa_raw_key_agreement( alg, our_key,
5190 peer_key_data->x, peer_key_data->len,
5191 output, expected_output->len,
5192 &output_length ) );
Gilles Peskinef0cba732019-04-11 22:12:38 +02005193 ASSERT_COMPARE( output, output_length,
5194 expected_output->x, expected_output->len );
5195
5196exit:
5197 mbedtls_free( output );
5198 psa_destroy_key( our_key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02005199 PSA_DONE( );
Gilles Peskinef0cba732019-04-11 22:12:38 +02005200}
5201/* END_CASE */
5202
5203/* BEGIN_CASE */
Gilles Peskine59685592018-09-18 12:11:34 +02005204void key_agreement_capacity( int alg_arg,
5205 int our_key_type_arg, data_t *our_key_data,
5206 data_t *peer_key_data,
5207 int expected_capacity_arg )
5208{
Gilles Peskinebdf309c2018-12-03 15:36:32 +01005209 psa_key_handle_t our_key = 0;
Gilles Peskine59685592018-09-18 12:11:34 +02005210 psa_algorithm_t alg = alg_arg;
5211 psa_key_type_t our_key_type = our_key_type_arg;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005212 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005213 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine59685592018-09-18 12:11:34 +02005214 size_t actual_capacity;
Gilles Peskinebf491972018-10-25 22:36:12 +02005215 unsigned char output[16];
Gilles Peskine59685592018-09-18 12:11:34 +02005216
Gilles Peskine8817f612018-12-18 00:18:46 +01005217 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine59685592018-09-18 12:11:34 +02005218
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005219 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DERIVE );
5220 psa_set_key_algorithm( &attributes, alg );
5221 psa_set_key_type( &attributes, our_key_type );
Gilles Peskine049c7532019-05-15 20:22:09 +02005222 PSA_ASSERT( psa_import_key( &attributes,
5223 our_key_data->x, our_key_data->len,
5224 &our_key ) );
Gilles Peskine59685592018-09-18 12:11:34 +02005225
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005226 PSA_ASSERT( psa_key_derivation_setup( &operation, alg ) );
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005227 PSA_ASSERT( psa_key_derivation_key_agreement(
5228 &operation,
5229 PSA_KEY_DERIVATION_INPUT_SECRET, our_key,
5230 peer_key_data->x, peer_key_data->len ) );
Gilles Peskinef8a9d942019-04-11 22:13:20 +02005231 if( PSA_ALG_IS_HKDF( PSA_ALG_KEY_AGREEMENT_GET_KDF( alg ) ) )
5232 {
5233 /* The test data is for info="" */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005234 PSA_ASSERT( psa_key_derivation_input_bytes( &operation,
Gilles Peskine03410b52019-05-16 16:05:19 +02005235 PSA_KEY_DERIVATION_INPUT_INFO,
Gilles Peskinef8a9d942019-04-11 22:13:20 +02005236 NULL, 0 ) );
5237 }
Gilles Peskine59685592018-09-18 12:11:34 +02005238
Gilles Peskinebf491972018-10-25 22:36:12 +02005239 /* Test the advertized capacity. */
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005240 PSA_ASSERT( psa_key_derivation_get_capacity(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005241 &operation, &actual_capacity ) );
Gilles Peskinefe11b722018-12-18 00:24:04 +01005242 TEST_EQUAL( actual_capacity, (size_t) expected_capacity_arg );
Gilles Peskine59685592018-09-18 12:11:34 +02005243
Gilles Peskinebf491972018-10-25 22:36:12 +02005244 /* Test the actual capacity by reading the output. */
5245 while( actual_capacity > sizeof( output ) )
5246 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005247 PSA_ASSERT( psa_key_derivation_output_bytes( &operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005248 output, sizeof( output ) ) );
Gilles Peskinebf491972018-10-25 22:36:12 +02005249 actual_capacity -= sizeof( output );
5250 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005251 PSA_ASSERT( psa_key_derivation_output_bytes( &operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005252 output, actual_capacity ) );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005253 TEST_EQUAL( psa_key_derivation_output_bytes( &operation, output, 1 ),
David Saadab4ecc272019-02-14 13:48:10 +02005254 PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskinebf491972018-10-25 22:36:12 +02005255
Gilles Peskine59685592018-09-18 12:11:34 +02005256exit:
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005257 psa_key_derivation_abort( &operation );
Gilles Peskine59685592018-09-18 12:11:34 +02005258 psa_destroy_key( our_key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02005259 PSA_DONE( );
Gilles Peskine59685592018-09-18 12:11:34 +02005260}
5261/* END_CASE */
5262
5263/* BEGIN_CASE */
5264void key_agreement_output( int alg_arg,
5265 int our_key_type_arg, data_t *our_key_data,
5266 data_t *peer_key_data,
Gilles Peskine3ec8ed82018-10-25 22:37:15 +02005267 data_t *expected_output1, data_t *expected_output2 )
Gilles Peskine59685592018-09-18 12:11:34 +02005268{
Gilles Peskinebdf309c2018-12-03 15:36:32 +01005269 psa_key_handle_t our_key = 0;
Gilles Peskine59685592018-09-18 12:11:34 +02005270 psa_algorithm_t alg = alg_arg;
5271 psa_key_type_t our_key_type = our_key_type_arg;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005272 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005273 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine3ec8ed82018-10-25 22:37:15 +02005274 uint8_t *actual_output = NULL;
Gilles Peskine59685592018-09-18 12:11:34 +02005275
Gilles Peskine3ec8ed82018-10-25 22:37:15 +02005276 ASSERT_ALLOC( actual_output, MAX( expected_output1->len,
5277 expected_output2->len ) );
Gilles Peskine59685592018-09-18 12:11:34 +02005278
Gilles Peskine8817f612018-12-18 00:18:46 +01005279 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine59685592018-09-18 12:11:34 +02005280
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005281 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DERIVE );
5282 psa_set_key_algorithm( &attributes, alg );
5283 psa_set_key_type( &attributes, our_key_type );
Gilles Peskine049c7532019-05-15 20:22:09 +02005284 PSA_ASSERT( psa_import_key( &attributes,
5285 our_key_data->x, our_key_data->len,
5286 &our_key ) );
Gilles Peskine59685592018-09-18 12:11:34 +02005287
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005288 PSA_ASSERT( psa_key_derivation_setup( &operation, alg ) );
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005289 PSA_ASSERT( psa_key_derivation_key_agreement(
5290 &operation,
5291 PSA_KEY_DERIVATION_INPUT_SECRET, our_key,
5292 peer_key_data->x, peer_key_data->len ) );
Gilles Peskinef8a9d942019-04-11 22:13:20 +02005293 if( PSA_ALG_IS_HKDF( PSA_ALG_KEY_AGREEMENT_GET_KDF( alg ) ) )
5294 {
5295 /* The test data is for info="" */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005296 PSA_ASSERT( psa_key_derivation_input_bytes( &operation,
Gilles Peskine03410b52019-05-16 16:05:19 +02005297 PSA_KEY_DERIVATION_INPUT_INFO,
Gilles Peskinef8a9d942019-04-11 22:13:20 +02005298 NULL, 0 ) );
5299 }
Gilles Peskine59685592018-09-18 12:11:34 +02005300
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005301 PSA_ASSERT( psa_key_derivation_output_bytes( &operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005302 actual_output,
5303 expected_output1->len ) );
Gilles Peskine0dfba2d2018-12-18 00:40:50 +01005304 ASSERT_COMPARE( actual_output, expected_output1->len,
5305 expected_output1->x, expected_output1->len );
Gilles Peskine3ec8ed82018-10-25 22:37:15 +02005306 if( expected_output2->len != 0 )
5307 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005308 PSA_ASSERT( psa_key_derivation_output_bytes( &operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005309 actual_output,
5310 expected_output2->len ) );
Gilles Peskine0dfba2d2018-12-18 00:40:50 +01005311 ASSERT_COMPARE( actual_output, expected_output2->len,
5312 expected_output2->x, expected_output2->len );
Gilles Peskine3ec8ed82018-10-25 22:37:15 +02005313 }
Gilles Peskine59685592018-09-18 12:11:34 +02005314
5315exit:
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005316 psa_key_derivation_abort( &operation );
Gilles Peskine59685592018-09-18 12:11:34 +02005317 psa_destroy_key( our_key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02005318 PSA_DONE( );
Gilles Peskine59685592018-09-18 12:11:34 +02005319 mbedtls_free( actual_output );
5320}
5321/* END_CASE */
5322
5323/* BEGIN_CASE */
Gilles Peskinea50d7392018-06-21 10:22:13 +02005324void generate_random( int bytes_arg )
Gilles Peskine05d69892018-06-19 22:00:52 +02005325{
Gilles Peskinea50d7392018-06-21 10:22:13 +02005326 size_t bytes = bytes_arg;
5327 const unsigned char trail[] = "don't overwrite me";
Gilles Peskine8cebbba2018-09-27 13:54:18 +02005328 unsigned char *output = NULL;
5329 unsigned char *changed = NULL;
Gilles Peskinea50d7392018-06-21 10:22:13 +02005330 size_t i;
5331 unsigned run;
Gilles Peskine05d69892018-06-19 22:00:52 +02005332
Simon Butcher49f8e312020-03-03 15:51:50 +00005333 TEST_ASSERT( bytes_arg >= 0 );
5334
Gilles Peskine8cebbba2018-09-27 13:54:18 +02005335 ASSERT_ALLOC( output, bytes + sizeof( trail ) );
5336 ASSERT_ALLOC( changed, bytes );
Gilles Peskinea50d7392018-06-21 10:22:13 +02005337 memcpy( output + bytes, trail, sizeof( trail ) );
Gilles Peskine05d69892018-06-19 22:00:52 +02005338
Gilles Peskine8817f612018-12-18 00:18:46 +01005339 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine05d69892018-06-19 22:00:52 +02005340
Gilles Peskinea50d7392018-06-21 10:22:13 +02005341 /* Run several times, to ensure that every output byte will be
5342 * nonzero at least once with overwhelming probability
5343 * (2^(-8*number_of_runs)). */
5344 for( run = 0; run < 10; run++ )
Gilles Peskine05d69892018-06-19 22:00:52 +02005345 {
Gilles Peskinef7ab5ad2018-09-26 18:19:24 +02005346 if( bytes != 0 )
5347 memset( output, 0, bytes );
Gilles Peskine8817f612018-12-18 00:18:46 +01005348 PSA_ASSERT( psa_generate_random( output, bytes ) );
Gilles Peskinea50d7392018-06-21 10:22:13 +02005349
5350 /* Check that no more than bytes have been overwritten */
Gilles Peskine0dfba2d2018-12-18 00:40:50 +01005351 ASSERT_COMPARE( output + bytes, sizeof( trail ),
5352 trail, sizeof( trail ) );
Gilles Peskinea50d7392018-06-21 10:22:13 +02005353
5354 for( i = 0; i < bytes; i++ )
5355 {
5356 if( output[i] != 0 )
5357 ++changed[i];
5358 }
Gilles Peskine05d69892018-06-19 22:00:52 +02005359 }
Gilles Peskinea50d7392018-06-21 10:22:13 +02005360
5361 /* Check that every byte was changed to nonzero at least once. This
5362 * validates that psa_generate_random is overwriting every byte of
5363 * the output buffer. */
5364 for( i = 0; i < bytes; i++ )
5365 {
5366 TEST_ASSERT( changed[i] != 0 );
5367 }
Gilles Peskine05d69892018-06-19 22:00:52 +02005368
5369exit:
Gilles Peskine1153e7b2019-05-28 15:10:21 +02005370 PSA_DONE( );
Gilles Peskinea50d7392018-06-21 10:22:13 +02005371 mbedtls_free( output );
5372 mbedtls_free( changed );
Gilles Peskine05d69892018-06-19 22:00:52 +02005373}
5374/* END_CASE */
Gilles Peskine12313cd2018-06-20 00:20:32 +02005375
5376/* BEGIN_CASE */
5377void generate_key( int type_arg,
5378 int bits_arg,
5379 int usage_arg,
5380 int alg_arg,
5381 int expected_status_arg )
5382{
Gilles Peskinebdf309c2018-12-03 15:36:32 +01005383 psa_key_handle_t handle = 0;
Gilles Peskine12313cd2018-06-20 00:20:32 +02005384 psa_key_type_t type = type_arg;
5385 psa_key_usage_t usage = usage_arg;
5386 size_t bits = bits_arg;
5387 psa_algorithm_t alg = alg_arg;
5388 psa_status_t expected_status = expected_status_arg;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005389 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02005390 psa_key_attributes_t got_attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine12313cd2018-06-20 00:20:32 +02005391
Gilles Peskine8817f612018-12-18 00:18:46 +01005392 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005393
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005394 psa_set_key_usage_flags( &attributes, usage );
5395 psa_set_key_algorithm( &attributes, alg );
5396 psa_set_key_type( &attributes, type );
Gilles Peskine3a4f1f82019-04-26 13:49:28 +02005397 psa_set_key_bits( &attributes, bits );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005398
5399 /* Generate a key */
Gilles Peskine35ef36b2019-05-16 19:42:05 +02005400 TEST_EQUAL( psa_generate_key( &attributes, &handle ), expected_status );
Gilles Peskinee56e8782019-04-26 17:34:02 +02005401 if( expected_status != PSA_SUCCESS )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005402 goto exit;
Gilles Peskine12313cd2018-06-20 00:20:32 +02005403
5404 /* Test the key information */
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02005405 PSA_ASSERT( psa_get_key_attributes( handle, &got_attributes ) );
5406 TEST_EQUAL( psa_get_key_type( &got_attributes ), type );
5407 TEST_EQUAL( psa_get_key_bits( &got_attributes ), bits );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005408
Gilles Peskine818ca122018-06-20 18:16:48 +02005409 /* Do something with the key according to its type and permitted usage. */
Gilles Peskinebdf309c2018-12-03 15:36:32 +01005410 if( ! exercise_key( handle, usage, alg ) )
Gilles Peskine02b75072018-07-01 22:31:34 +02005411 goto exit;
Gilles Peskine12313cd2018-06-20 00:20:32 +02005412
5413exit:
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02005414 psa_reset_key_attributes( &got_attributes );
Gilles Peskinebdf309c2018-12-03 15:36:32 +01005415 psa_destroy_key( handle );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02005416 PSA_DONE( );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005417}
5418/* END_CASE */
itayzafrir0adf0fc2018-09-06 16:24:41 +03005419
Gilles Peskinee56e8782019-04-26 17:34:02 +02005420/* BEGIN_CASE depends_on:MBEDTLS_RSA_C:MBEDTLS_GENPRIME:MBEDTLS_PKCS1_V15 */
5421void generate_key_rsa( int bits_arg,
5422 data_t *e_arg,
5423 int expected_status_arg )
5424{
5425 psa_key_handle_t handle = 0;
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005426 psa_key_type_t type = PSA_KEY_TYPE_RSA_KEY_PAIR;
Gilles Peskinee56e8782019-04-26 17:34:02 +02005427 size_t bits = bits_arg;
5428 psa_key_usage_t usage = PSA_KEY_USAGE_ENCRYPT | PSA_KEY_USAGE_DECRYPT;
5429 psa_algorithm_t alg = PSA_ALG_RSA_PKCS1V15_SIGN_RAW;
5430 psa_status_t expected_status = expected_status_arg;
5431 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
5432 uint8_t *exported = NULL;
5433 size_t exported_size =
5434 PSA_KEY_EXPORT_MAX_SIZE( PSA_KEY_TYPE_RSA_PUBLIC_KEY, bits );
5435 size_t exported_length = SIZE_MAX;
5436 uint8_t *e_read_buffer = NULL;
5437 int is_default_public_exponent = 0;
Gilles Peskineaa02c172019-04-28 11:44:17 +02005438 size_t e_read_size = PSA_KEY_DOMAIN_PARAMETERS_SIZE( type, bits );
Gilles Peskinee56e8782019-04-26 17:34:02 +02005439 size_t e_read_length = SIZE_MAX;
5440
5441 if( e_arg->len == 0 ||
5442 ( e_arg->len == 3 &&
5443 e_arg->x[0] == 1 && e_arg->x[1] == 0 && e_arg->x[2] == 1 ) )
5444 {
5445 is_default_public_exponent = 1;
5446 e_read_size = 0;
5447 }
5448 ASSERT_ALLOC( e_read_buffer, e_read_size );
5449 ASSERT_ALLOC( exported, exported_size );
5450
5451 PSA_ASSERT( psa_crypto_init( ) );
5452
5453 psa_set_key_usage_flags( &attributes, usage );
5454 psa_set_key_algorithm( &attributes, alg );
5455 PSA_ASSERT( psa_set_key_domain_parameters( &attributes, type,
5456 e_arg->x, e_arg->len ) );
5457 psa_set_key_bits( &attributes, bits );
5458
5459 /* Generate a key */
Gilles Peskine35ef36b2019-05-16 19:42:05 +02005460 TEST_EQUAL( psa_generate_key( &attributes, &handle ), expected_status );
Gilles Peskinee56e8782019-04-26 17:34:02 +02005461 if( expected_status != PSA_SUCCESS )
5462 goto exit;
5463
5464 /* Test the key information */
5465 PSA_ASSERT( psa_get_key_attributes( handle, &attributes ) );
5466 TEST_EQUAL( psa_get_key_type( &attributes ), type );
5467 TEST_EQUAL( psa_get_key_bits( &attributes ), bits );
5468 PSA_ASSERT( psa_get_key_domain_parameters( &attributes,
5469 e_read_buffer, e_read_size,
5470 &e_read_length ) );
5471 if( is_default_public_exponent )
5472 TEST_EQUAL( e_read_length, 0 );
5473 else
5474 ASSERT_COMPARE( e_read_buffer, e_read_length, e_arg->x, e_arg->len );
5475
5476 /* Do something with the key according to its type and permitted usage. */
5477 if( ! exercise_key( handle, usage, alg ) )
5478 goto exit;
5479
5480 /* Export the key and check the public exponent. */
5481 PSA_ASSERT( psa_export_public_key( handle,
5482 exported, exported_size,
5483 &exported_length ) );
5484 {
5485 uint8_t *p = exported;
5486 uint8_t *end = exported + exported_length;
5487 size_t len;
5488 /* RSAPublicKey ::= SEQUENCE {
5489 * modulus INTEGER, -- n
5490 * publicExponent INTEGER } -- e
5491 */
5492 TEST_EQUAL( 0, mbedtls_asn1_get_tag( &p, end, &len,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005493 MBEDTLS_ASN1_SEQUENCE |
5494 MBEDTLS_ASN1_CONSTRUCTED ) );
Gilles Peskinee56e8782019-04-26 17:34:02 +02005495 TEST_ASSERT( asn1_skip_integer( &p, end, bits, bits, 1 ) );
5496 TEST_EQUAL( 0, mbedtls_asn1_get_tag( &p, end, &len,
5497 MBEDTLS_ASN1_INTEGER ) );
5498 if( len >= 1 && p[0] == 0 )
5499 {
5500 ++p;
5501 --len;
5502 }
5503 if( e_arg->len == 0 )
5504 {
5505 TEST_EQUAL( len, 3 );
5506 TEST_EQUAL( p[0], 1 );
5507 TEST_EQUAL( p[1], 0 );
5508 TEST_EQUAL( p[2], 1 );
5509 }
5510 else
5511 ASSERT_COMPARE( p, len, e_arg->x, e_arg->len );
5512 }
5513
5514exit:
5515 psa_reset_key_attributes( &attributes );
5516 psa_destroy_key( handle );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02005517 PSA_DONE( );
Gilles Peskinee56e8782019-04-26 17:34:02 +02005518 mbedtls_free( e_read_buffer );
5519 mbedtls_free( exported );
5520}
5521/* END_CASE */
5522
Darryl Greend49a4992018-06-18 17:27:26 +01005523/* BEGIN_CASE depends_on:MBEDTLS_PSA_CRYPTO_STORAGE_C */
Gilles Peskine5c648ab2019-04-19 14:06:53 +02005524void persistent_key_load_key_from_storage( data_t *data,
5525 int type_arg, int bits_arg,
5526 int usage_flags_arg, int alg_arg,
5527 int generation_method )
Darryl Greend49a4992018-06-18 17:27:26 +01005528{
Gilles Peskine5c648ab2019-04-19 14:06:53 +02005529 psa_key_id_t key_id = 1;
5530 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskinebdf309c2018-12-03 15:36:32 +01005531 psa_key_handle_t handle = 0;
Gilles Peskine5c648ab2019-04-19 14:06:53 +02005532 psa_key_handle_t base_key = 0;
5533 psa_key_type_t type = type_arg;
5534 size_t bits = bits_arg;
5535 psa_key_usage_t usage_flags = usage_flags_arg;
5536 psa_algorithm_t alg = alg_arg;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005537 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Darryl Greend49a4992018-06-18 17:27:26 +01005538 unsigned char *first_export = NULL;
5539 unsigned char *second_export = NULL;
5540 size_t export_size = PSA_KEY_EXPORT_MAX_SIZE( type, bits );
5541 size_t first_exported_length;
5542 size_t second_exported_length;
5543
Gilles Peskine5c648ab2019-04-19 14:06:53 +02005544 if( usage_flags & PSA_KEY_USAGE_EXPORT )
5545 {
5546 ASSERT_ALLOC( first_export, export_size );
5547 ASSERT_ALLOC( second_export, export_size );
5548 }
Darryl Greend49a4992018-06-18 17:27:26 +01005549
Gilles Peskine8817f612018-12-18 00:18:46 +01005550 PSA_ASSERT( psa_crypto_init() );
Darryl Greend49a4992018-06-18 17:27:26 +01005551
Gilles Peskinec87af662019-05-15 16:12:22 +02005552 psa_set_key_id( &attributes, key_id );
Gilles Peskine5c648ab2019-04-19 14:06:53 +02005553 psa_set_key_usage_flags( &attributes, usage_flags );
5554 psa_set_key_algorithm( &attributes, alg );
5555 psa_set_key_type( &attributes, type );
Gilles Peskine3a4f1f82019-04-26 13:49:28 +02005556 psa_set_key_bits( &attributes, bits );
Darryl Greend49a4992018-06-18 17:27:26 +01005557
Darryl Green0c6575a2018-11-07 16:05:30 +00005558 switch( generation_method )
5559 {
5560 case IMPORT_KEY:
5561 /* Import the key */
Gilles Peskine049c7532019-05-15 20:22:09 +02005562 PSA_ASSERT( psa_import_key( &attributes, data->x, data->len,
5563 &handle ) );
Darryl Green0c6575a2018-11-07 16:05:30 +00005564 break;
Darryl Greend49a4992018-06-18 17:27:26 +01005565
Darryl Green0c6575a2018-11-07 16:05:30 +00005566 case GENERATE_KEY:
5567 /* Generate a key */
Gilles Peskine35ef36b2019-05-16 19:42:05 +02005568 PSA_ASSERT( psa_generate_key( &attributes, &handle ) );
Darryl Green0c6575a2018-11-07 16:05:30 +00005569 break;
5570
5571 case DERIVE_KEY:
Gilles Peskine5c648ab2019-04-19 14:06:53 +02005572 {
5573 /* Create base key */
5574 psa_algorithm_t derive_alg = PSA_ALG_HKDF( PSA_ALG_SHA_256 );
5575 psa_key_attributes_t base_attributes = PSA_KEY_ATTRIBUTES_INIT;
5576 psa_set_key_usage_flags( &base_attributes,
5577 PSA_KEY_USAGE_DERIVE );
5578 psa_set_key_algorithm( &base_attributes, derive_alg );
5579 psa_set_key_type( &base_attributes, PSA_KEY_TYPE_DERIVE );
Gilles Peskine049c7532019-05-15 20:22:09 +02005580 PSA_ASSERT( psa_import_key( &base_attributes,
5581 data->x, data->len,
5582 &base_key ) );
Gilles Peskine5c648ab2019-04-19 14:06:53 +02005583 /* Derive a key. */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005584 PSA_ASSERT( psa_key_derivation_setup( &operation, derive_alg ) );
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005585 PSA_ASSERT( psa_key_derivation_input_key(
5586 &operation,
5587 PSA_KEY_DERIVATION_INPUT_SECRET, base_key ) );
Gilles Peskine5c648ab2019-04-19 14:06:53 +02005588 PSA_ASSERT( psa_key_derivation_input_bytes(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005589 &operation, PSA_KEY_DERIVATION_INPUT_INFO,
Gilles Peskine5c648ab2019-04-19 14:06:53 +02005590 NULL, 0 ) );
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005591 PSA_ASSERT( psa_key_derivation_output_key( &attributes,
5592 &operation,
5593 &handle ) );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005594 PSA_ASSERT( psa_key_derivation_abort( &operation ) );
Gilles Peskine5c648ab2019-04-19 14:06:53 +02005595 PSA_ASSERT( psa_destroy_key( base_key ) );
5596 base_key = 0;
5597 }
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005598 break;
Darryl Green0c6575a2018-11-07 16:05:30 +00005599 }
Gilles Peskine5c648ab2019-04-19 14:06:53 +02005600 psa_reset_key_attributes( &attributes );
Darryl Greend49a4992018-06-18 17:27:26 +01005601
Gilles Peskine5c648ab2019-04-19 14:06:53 +02005602 /* Export the key if permitted by the key policy. */
5603 if( usage_flags & PSA_KEY_USAGE_EXPORT )
5604 {
5605 PSA_ASSERT( psa_export_key( handle,
5606 first_export, export_size,
5607 &first_exported_length ) );
5608 if( generation_method == IMPORT_KEY )
5609 ASSERT_COMPARE( data->x, data->len,
5610 first_export, first_exported_length );
5611 }
Darryl Greend49a4992018-06-18 17:27:26 +01005612
5613 /* Shutdown and restart */
Gilles Peskine76b29a72019-05-28 14:08:50 +02005614 PSA_ASSERT( psa_close_key( handle ) );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02005615 PSA_DONE();
Gilles Peskine8817f612018-12-18 00:18:46 +01005616 PSA_ASSERT( psa_crypto_init() );
Darryl Greend49a4992018-06-18 17:27:26 +01005617
Darryl Greend49a4992018-06-18 17:27:26 +01005618 /* Check key slot still contains key data */
Gilles Peskine225010f2019-05-06 18:44:55 +02005619 PSA_ASSERT( psa_open_key( key_id, &handle ) );
Gilles Peskine5c648ab2019-04-19 14:06:53 +02005620 PSA_ASSERT( psa_get_key_attributes( handle, &attributes ) );
5621 TEST_EQUAL( psa_get_key_id( &attributes ), key_id );
5622 TEST_EQUAL( psa_get_key_lifetime( &attributes ),
5623 PSA_KEY_LIFETIME_PERSISTENT );
5624 TEST_EQUAL( psa_get_key_type( &attributes ), type );
5625 TEST_EQUAL( psa_get_key_bits( &attributes ), bits );
5626 TEST_EQUAL( psa_get_key_usage_flags( &attributes ), usage_flags );
5627 TEST_EQUAL( psa_get_key_algorithm( &attributes ), alg );
Darryl Greend49a4992018-06-18 17:27:26 +01005628
Gilles Peskine5c648ab2019-04-19 14:06:53 +02005629 /* Export the key again if permitted by the key policy. */
5630 if( usage_flags & PSA_KEY_USAGE_EXPORT )
Darryl Green0c6575a2018-11-07 16:05:30 +00005631 {
Gilles Peskine5c648ab2019-04-19 14:06:53 +02005632 PSA_ASSERT( psa_export_key( handle,
5633 second_export, export_size,
5634 &second_exported_length ) );
Darryl Green0c6575a2018-11-07 16:05:30 +00005635 ASSERT_COMPARE( first_export, first_exported_length,
5636 second_export, second_exported_length );
Darryl Green0c6575a2018-11-07 16:05:30 +00005637 }
5638
5639 /* Do something with the key according to its type and permitted usage. */
Gilles Peskine5c648ab2019-04-19 14:06:53 +02005640 if( ! exercise_key( handle, usage_flags, alg ) )
Darryl Green0c6575a2018-11-07 16:05:30 +00005641 goto exit;
Darryl Greend49a4992018-06-18 17:27:26 +01005642
5643exit:
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02005644 psa_reset_key_attributes( &attributes );
Darryl Greend49a4992018-06-18 17:27:26 +01005645 mbedtls_free( first_export );
5646 mbedtls_free( second_export );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005647 psa_key_derivation_abort( &operation );
Gilles Peskine5c648ab2019-04-19 14:06:53 +02005648 psa_destroy_key( base_key );
5649 if( handle == 0 )
5650 {
5651 /* In case there was a test failure after creating the persistent key
5652 * but while it was not open, try to re-open the persistent key
5653 * to delete it. */
Gilles Peskine225010f2019-05-06 18:44:55 +02005654 psa_open_key( key_id, &handle );
Gilles Peskine5c648ab2019-04-19 14:06:53 +02005655 }
Gilles Peskinebdf309c2018-12-03 15:36:32 +01005656 psa_destroy_key( handle );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02005657 PSA_DONE();
Darryl Greend49a4992018-06-18 17:27:26 +01005658}
5659/* END_CASE */