blob: 3312f674fc4675fa58fa8f96dbd032fe9b416228 [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
Gilles Peskinebdc96fd2019-08-07 12:08:04 +020012#include "psa/crypto.h"
Ronald Cron41841072020-09-17 15:28:26 +020013#include "psa_crypto_slot_management.h"
Gilles Peskinebdc96fd2019-08-07 12:08:04 +020014
Gilles Peskine8e94efe2021-02-13 00:25:53 +010015#include "test/asn1_helpers.h"
Ronald Cron28a45ed2021-02-09 20:35:42 +010016#include "test/psa_crypto_helpers.h"
Gilles Peskinee78b0022021-02-13 00:41:11 +010017#include "test/psa_exercise_key.h"
Ronald Cron28a45ed2021-02-09 20:35:42 +010018
Jaeden Amerof24c7f82018-06-27 17:20:43 +010019/** An invalid export length that will never be set by psa_export_key(). */
20static const size_t INVALID_EXPORT_LENGTH = ~0U;
21
Gilles Peskinea7aa4422018-08-14 15:17:54 +020022/** Test if a buffer contains a constant byte value.
23 *
24 * `mem_is_char(buffer, c, size)` is true after `memset(buffer, c, size)`.
Gilles Peskinee66ca3b2018-06-20 00:11:45 +020025 *
26 * \param buffer Pointer to the beginning of the buffer.
Gilles Peskinea7aa4422018-08-14 15:17:54 +020027 * \param c Expected value of every byte.
Gilles Peskinee66ca3b2018-06-20 00:11:45 +020028 * \param size Size of the buffer in bytes.
29 *
Gilles Peskine3f669c32018-06-21 09:21:51 +020030 * \return 1 if the buffer is all-bits-zero.
31 * \return 0 if there is at least one nonzero byte.
Gilles Peskinee66ca3b2018-06-20 00:11:45 +020032 */
Gilles Peskinea7aa4422018-08-14 15:17:54 +020033static int mem_is_char( void *buffer, unsigned char c, size_t size )
Gilles Peskinee66ca3b2018-06-20 00:11:45 +020034{
35 size_t i;
36 for( i = 0; i < size; i++ )
37 {
Gilles Peskinea7aa4422018-08-14 15:17:54 +020038 if( ( (unsigned char *) buffer )[i] != c )
Gilles Peskine3f669c32018-06-21 09:21:51 +020039 return( 0 );
Gilles Peskinee66ca3b2018-06-20 00:11:45 +020040 }
Gilles Peskine3f669c32018-06-21 09:21:51 +020041 return( 1 );
Gilles Peskinee66ca3b2018-06-20 00:11:45 +020042}
Gilles Peskine818ca122018-06-20 18:16:48 +020043
Gilles Peskine0b352bc2018-06-28 00:16:11 +020044/* Write the ASN.1 INTEGER with the value 2^(bits-1)+x backwards from *p. */
45static int asn1_write_10x( unsigned char **p,
46 unsigned char *start,
47 size_t bits,
48 unsigned char x )
49{
50 int ret;
51 int len = bits / 8 + 1;
Gilles Peskine480416a2018-06-28 19:04:07 +020052 if( bits == 0 )
53 return( MBEDTLS_ERR_ASN1_INVALID_DATA );
54 if( bits <= 8 && x >= 1 << ( bits - 1 ) )
Gilles Peskine0b352bc2018-06-28 00:16:11 +020055 return( MBEDTLS_ERR_ASN1_INVALID_DATA );
Moran Pekercb088e72018-07-17 17:36:59 +030056 if( *p < start || *p - start < (ptrdiff_t) len )
Gilles Peskine0b352bc2018-06-28 00:16:11 +020057 return( MBEDTLS_ERR_ASN1_BUF_TOO_SMALL );
58 *p -= len;
59 ( *p )[len-1] = x;
60 if( bits % 8 == 0 )
61 ( *p )[1] |= 1;
62 else
63 ( *p )[0] |= 1 << ( bits % 8 );
64 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_len( p, start, len ) );
65 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_tag( p, start,
66 MBEDTLS_ASN1_INTEGER ) );
67 return( len );
68}
69
70static int construct_fake_rsa_key( unsigned char *buffer,
71 size_t buffer_size,
72 unsigned char **p,
73 size_t bits,
74 int keypair )
75{
76 size_t half_bits = ( bits + 1 ) / 2;
77 int ret;
78 int len = 0;
79 /* Construct something that looks like a DER encoding of
80 * as defined by PKCS#1 v2.2 (RFC 8017) section A.1.2:
81 * RSAPrivateKey ::= SEQUENCE {
82 * version Version,
83 * modulus INTEGER, -- n
84 * publicExponent INTEGER, -- e
85 * privateExponent INTEGER, -- d
86 * prime1 INTEGER, -- p
87 * prime2 INTEGER, -- q
88 * exponent1 INTEGER, -- d mod (p-1)
89 * exponent2 INTEGER, -- d mod (q-1)
90 * coefficient INTEGER, -- (inverse of q) mod p
91 * otherPrimeInfos OtherPrimeInfos OPTIONAL
92 * }
93 * Or, for a public key, the same structure with only
94 * version, modulus and publicExponent.
95 */
96 *p = buffer + buffer_size;
97 if( keypair )
98 {
99 MBEDTLS_ASN1_CHK_ADD( len, /* pq */
100 asn1_write_10x( p, buffer, half_bits, 1 ) );
101 MBEDTLS_ASN1_CHK_ADD( len, /* dq */
102 asn1_write_10x( p, buffer, half_bits, 1 ) );
103 MBEDTLS_ASN1_CHK_ADD( len, /* dp */
104 asn1_write_10x( p, buffer, half_bits, 1 ) );
105 MBEDTLS_ASN1_CHK_ADD( len, /* q */
106 asn1_write_10x( p, buffer, half_bits, 1 ) );
107 MBEDTLS_ASN1_CHK_ADD( len, /* p != q to pass mbedtls sanity checks */
108 asn1_write_10x( p, buffer, half_bits, 3 ) );
109 MBEDTLS_ASN1_CHK_ADD( len, /* d */
110 asn1_write_10x( p, buffer, bits, 1 ) );
111 }
112 MBEDTLS_ASN1_CHK_ADD( len, /* e = 65537 */
113 asn1_write_10x( p, buffer, 17, 1 ) );
114 MBEDTLS_ASN1_CHK_ADD( len, /* n */
115 asn1_write_10x( p, buffer, bits, 1 ) );
116 if( keypair )
117 MBEDTLS_ASN1_CHK_ADD( len, /* version = 0 */
118 mbedtls_asn1_write_int( p, buffer, 0 ) );
119 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_len( p, buffer, len ) );
120 {
121 const unsigned char tag =
122 MBEDTLS_ASN1_CONSTRUCTED | MBEDTLS_ASN1_SEQUENCE;
123 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_tag( p, buffer, tag ) );
124 }
125 return( len );
126}
127
Gilles Peskinef426e0f2019-02-25 17:42:03 +0100128int exercise_mac_setup( psa_key_type_t key_type,
129 const unsigned char *key_bytes,
130 size_t key_length,
131 psa_algorithm_t alg,
132 psa_mac_operation_t *operation,
133 psa_status_t *status )
134{
Ronald Cron5425a212020-08-04 14:58:35 +0200135 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +0200136 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskinef426e0f2019-02-25 17:42:03 +0100137
Gilles Peskine89d8c5c2019-11-26 17:01:59 +0100138 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_HASH );
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +0200139 psa_set_key_algorithm( &attributes, alg );
140 psa_set_key_type( &attributes, key_type );
Ronald Cron5425a212020-08-04 14:58:35 +0200141 PSA_ASSERT( psa_import_key( &attributes, key_bytes, key_length, &key ) );
Gilles Peskinef426e0f2019-02-25 17:42:03 +0100142
Ronald Cron5425a212020-08-04 14:58:35 +0200143 *status = psa_mac_sign_setup( operation, key, alg );
Gilles Peskine9e0a4a52019-02-25 22:11:18 +0100144 /* Whether setup succeeded or failed, abort must succeed. */
145 PSA_ASSERT( psa_mac_abort( operation ) );
146 /* If setup failed, reproduce the failure, so that the caller can
147 * test the resulting state of the operation object. */
148 if( *status != PSA_SUCCESS )
Gilles Peskinef426e0f2019-02-25 17:42:03 +0100149 {
Ronald Cron5425a212020-08-04 14:58:35 +0200150 TEST_EQUAL( psa_mac_sign_setup( operation, key, alg ), *status );
Gilles Peskinef426e0f2019-02-25 17:42:03 +0100151 }
152
Ronald Cron5425a212020-08-04 14:58:35 +0200153 psa_destroy_key( key );
Gilles Peskinef426e0f2019-02-25 17:42:03 +0100154 return( 1 );
155
156exit:
Ronald Cron5425a212020-08-04 14:58:35 +0200157 psa_destroy_key( key );
Gilles Peskinef426e0f2019-02-25 17:42:03 +0100158 return( 0 );
159}
160
161int exercise_cipher_setup( psa_key_type_t key_type,
162 const unsigned char *key_bytes,
163 size_t key_length,
164 psa_algorithm_t alg,
165 psa_cipher_operation_t *operation,
166 psa_status_t *status )
167{
Ronald Cron5425a212020-08-04 14:58:35 +0200168 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +0200169 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskinef426e0f2019-02-25 17:42:03 +0100170
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +0200171 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
172 psa_set_key_algorithm( &attributes, alg );
173 psa_set_key_type( &attributes, key_type );
Ronald Cron5425a212020-08-04 14:58:35 +0200174 PSA_ASSERT( psa_import_key( &attributes, key_bytes, key_length, &key ) );
Gilles Peskinef426e0f2019-02-25 17:42:03 +0100175
Ronald Cron5425a212020-08-04 14:58:35 +0200176 *status = psa_cipher_encrypt_setup( operation, key, alg );
Gilles Peskine9e0a4a52019-02-25 22:11:18 +0100177 /* Whether setup succeeded or failed, abort must succeed. */
178 PSA_ASSERT( psa_cipher_abort( operation ) );
179 /* If setup failed, reproduce the failure, so that the caller can
180 * test the resulting state of the operation object. */
181 if( *status != PSA_SUCCESS )
Gilles Peskinef426e0f2019-02-25 17:42:03 +0100182 {
Ronald Cron5425a212020-08-04 14:58:35 +0200183 TEST_EQUAL( psa_cipher_encrypt_setup( operation, key, alg ),
Gilles Peskine9e0a4a52019-02-25 22:11:18 +0100184 *status );
Gilles Peskinef426e0f2019-02-25 17:42:03 +0100185 }
186
Ronald Cron5425a212020-08-04 14:58:35 +0200187 psa_destroy_key( key );
Gilles Peskinef426e0f2019-02-25 17:42:03 +0100188 return( 1 );
189
190exit:
Ronald Cron5425a212020-08-04 14:58:35 +0200191 psa_destroy_key( key );
Gilles Peskinef426e0f2019-02-25 17:42:03 +0100192 return( 0 );
193}
194
Ronald Cron5425a212020-08-04 14:58:35 +0200195static int test_operations_on_invalid_key( mbedtls_svc_key_id_t key )
Gilles Peskine4cf3a432019-04-18 22:28:52 +0200196{
197 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Ronald Cronecfb2372020-07-23 17:13:42 +0200198 mbedtls_svc_key_id_t key_id = mbedtls_svc_key_id_make( 1, 0x6964 );
Gilles Peskine4cf3a432019-04-18 22:28:52 +0200199 uint8_t buffer[1];
200 size_t length;
201 int ok = 0;
202
Ronald Cronecfb2372020-07-23 17:13:42 +0200203 psa_set_key_id( &attributes, key_id );
Gilles Peskine4cf3a432019-04-18 22:28:52 +0200204 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
205 psa_set_key_algorithm( &attributes, PSA_ALG_CTR );
206 psa_set_key_type( &attributes, PSA_KEY_TYPE_AES );
Ronald Cron5425a212020-08-04 14:58:35 +0200207 TEST_EQUAL( psa_get_key_attributes( key, &attributes ),
Maulik Patel3240c9d2021-03-17 16:11:05 +0000208 PSA_ERROR_INVALID_HANDLE );
Ronald Cronecfb2372020-07-23 17:13:42 +0200209 TEST_EQUAL(
210 MBEDTLS_SVC_KEY_ID_GET_KEY_ID( psa_get_key_id( &attributes ) ), 0 );
211 TEST_EQUAL(
212 MBEDTLS_SVC_KEY_ID_GET_OWNER_ID( psa_get_key_id( &attributes ) ), 0 );
Gilles Peskine5c648ab2019-04-19 14:06:53 +0200213 TEST_EQUAL( psa_get_key_lifetime( &attributes ), 0 );
Gilles Peskine4cf3a432019-04-18 22:28:52 +0200214 TEST_EQUAL( psa_get_key_usage_flags( &attributes ), 0 );
215 TEST_EQUAL( psa_get_key_algorithm( &attributes ), 0 );
216 TEST_EQUAL( psa_get_key_type( &attributes ), 0 );
217 TEST_EQUAL( psa_get_key_bits( &attributes ), 0 );
218
Ronald Cron5425a212020-08-04 14:58:35 +0200219 TEST_EQUAL( psa_export_key( key, buffer, sizeof( buffer ), &length ),
Maulik Patel3240c9d2021-03-17 16:11:05 +0000220 PSA_ERROR_INVALID_HANDLE );
Ronald Cron5425a212020-08-04 14:58:35 +0200221 TEST_EQUAL( psa_export_public_key( key,
Gilles Peskine4cf3a432019-04-18 22:28:52 +0200222 buffer, sizeof( buffer ), &length ),
Maulik Patel3240c9d2021-03-17 16:11:05 +0000223 PSA_ERROR_INVALID_HANDLE );
Gilles Peskine4cf3a432019-04-18 22:28:52 +0200224
Gilles Peskine4cf3a432019-04-18 22:28:52 +0200225 ok = 1;
226
227exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +0100228 /*
229 * Key attributes may have been returned by psa_get_key_attributes()
230 * thus reset them as required.
231 */
Gilles Peskine4cf3a432019-04-18 22:28:52 +0200232 psa_reset_key_attributes( &attributes );
Ronald Cron3a4f0e32020-11-19 17:55:23 +0100233
Gilles Peskine4cf3a432019-04-18 22:28:52 +0200234 return( ok );
235}
236
Gilles Peskine5fe5e272019-08-02 20:30:01 +0200237/* Assert that a key isn't reported as having a slot number. */
238#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
239#define ASSERT_NO_SLOT_NUMBER( attributes ) \
240 do \
241 { \
242 psa_key_slot_number_t ASSERT_NO_SLOT_NUMBER_slot_number; \
243 TEST_EQUAL( psa_get_key_slot_number( \
244 attributes, \
245 &ASSERT_NO_SLOT_NUMBER_slot_number ), \
246 PSA_ERROR_INVALID_ARGUMENT ); \
247 } \
248 while( 0 )
249#else /* MBEDTLS_PSA_CRYPTO_SE_C */
250#define ASSERT_NO_SLOT_NUMBER( attributes ) \
251 ( (void) 0 )
252#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
253
Gilles Peskinebdf309c2018-12-03 15:36:32 +0100254/* An overapproximation of the amount of storage needed for a key of the
255 * given type and with the given content. The API doesn't make it easy
256 * to find a good value for the size. The current implementation doesn't
257 * care about the value anyway. */
258#define KEY_BITS_FROM_DATA( type, data ) \
259 ( data )->len
260
Darryl Green0c6575a2018-11-07 16:05:30 +0000261typedef enum {
262 IMPORT_KEY = 0,
263 GENERATE_KEY = 1,
264 DERIVE_KEY = 2
265} generate_method;
266
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100267/*!
268 * \brief Internal Function for AEAD multipart tests.
269 *
270 * \param key_type_arg Type of key passed in
271 * \param key_data The encryption / decryption key data
272 * \param alg_arg The type of algorithm used
273 * \param nonce Nonce data
274 * \param additional_data Additional data
275 * \param ad_part_len If not -1, the length of chunks to
276 * feed additional data in to be encrypted /
277 * decrypted. If -1, no chunking.
278 * \param input_data Data to encrypt / decrypt
279 * \param data_part_len If not -1, the length of chunks to feed the
280 * data in to be encrypted / decrypted. If -1,
281 * no chunking
282 * \param do_set_lengths If non-zero, then set lengths prior to
283 * calling encryption / decryption.
284 * \param expected_output Expected output
Paul Elliott41ffae12021-07-22 21:52:01 +0100285 * \param expect_valid_signature If non zero, we expect the signature to be
286 * valid
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100287 * \param is_encrypt If non-zero this is an encryption operation.
Paul Elliott41ffae12021-07-22 21:52:01 +0100288 * \param do_zero_parts If non-zero, interleave zero length chunks
289 * with normal length chunks
290 * \param swap_set_functions If non-zero, swap the order of set lengths
291 * and set nonce.
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100292 *
293 * \return int Zero on failure, non-zero on success.
294 *
295 */
296static int aead_multipart_internal_func( int key_type_arg, data_t *key_data,
297 int alg_arg,
298 data_t *nonce,
299 data_t *additional_data,
300 int ad_part_len,
301 data_t *input_data,
302 int data_part_len,
303 int do_set_lengths,
304 data_t *expected_output,
305 int expect_valid_signature,
Paul Elliott329d5382021-07-22 17:10:45 +0100306 int is_encrypt,
Paul Elliottebf91632021-07-22 17:54:42 +0100307 int do_zero_parts,
308 int swap_set_functions )
Paul Elliottd3f82412021-06-16 16:52:21 +0100309{
310 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
311 psa_key_type_t key_type = key_type_arg;
312 psa_algorithm_t alg = alg_arg;
313 psa_aead_operation_t operation;
314 unsigned char *output_data = NULL;
315 unsigned char *part_data = NULL;
316 unsigned char *final_data = NULL;
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100317 size_t data_true_size = 0;
Paul Elliottd3f82412021-06-16 16:52:21 +0100318 size_t part_data_size = 0;
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100319 size_t output_size = 0;
320 size_t final_output_size = 0;
Paul Elliottd3f82412021-06-16 16:52:21 +0100321 size_t output_length = 0;
322 size_t key_bits = 0;
323 size_t tag_length = 0;
Paul Elliottd3f82412021-06-16 16:52:21 +0100324 uint32_t part_offset = 0;
325 size_t part_length = 0;
326 size_t output_part_length = 0;
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100327 size_t tag_size = 0;
328 uint8_t tag_buffer[PSA_AEAD_TAG_MAX_SIZE];
Paul Elliottd3f82412021-06-16 16:52:21 +0100329 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
330 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
331
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100332 int test_ok = 0;
Paul Elliott329d5382021-07-22 17:10:45 +0100333 uint32_t part_count = 0;
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100334
Paul Elliottd3f82412021-06-16 16:52:21 +0100335 PSA_ASSERT( psa_crypto_init( ) );
336
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100337 if( is_encrypt )
338 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
339 else
340 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DECRYPT );
341
Paul Elliottd3f82412021-06-16 16:52:21 +0100342 psa_set_key_algorithm( &attributes, alg );
343 psa_set_key_type( &attributes, key_type );
344
345 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
346 &key ) );
347
348 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
349 key_bits = psa_get_key_bits( &attributes );
350
351 tag_length = PSA_AEAD_TAG_LENGTH( key_type, key_bits, alg );
352
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100353 if( is_encrypt )
354 {
355 /* Tag gets written at end of buffer. */
356 output_size = PSA_AEAD_UPDATE_OUTPUT_SIZE( key_type, alg,
357 ( input_data->len +
358 tag_length ) );
359 data_true_size = input_data->len;
360 }
361 else
362 {
363 output_size = PSA_AEAD_UPDATE_OUTPUT_SIZE( key_type, alg,
364 ( input_data->len -
365 tag_length ) );
Paul Elliottd3f82412021-06-16 16:52:21 +0100366
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100367 /* Do not want to attempt to decrypt tag. */
368 data_true_size = input_data->len - tag_length;
369 }
Paul Elliottd3f82412021-06-16 16:52:21 +0100370
371 ASSERT_ALLOC( output_data, output_size );
372
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100373 if( is_encrypt )
374 {
375 final_output_size = PSA_AEAD_VERIFY_OUTPUT_SIZE( key_type, alg );
376 TEST_ASSERT( final_output_size <= PSA_AEAD_VERIFY_OUTPUT_MAX_SIZE );
377 }
378 else
379 {
380 final_output_size = PSA_AEAD_FINISH_OUTPUT_SIZE( key_type, alg );
381 TEST_ASSERT( final_output_size <= PSA_AEAD_FINISH_OUTPUT_MAX_SIZE );
382 }
Paul Elliottd3f82412021-06-16 16:52:21 +0100383
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100384 ASSERT_ALLOC( final_data, final_output_size );
Paul Elliottd3f82412021-06-16 16:52:21 +0100385
386 operation = psa_aead_operation_init( );
387
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100388
389 if( is_encrypt )
390 status = psa_aead_encrypt_setup( &operation, key, alg );
391 else
392 status = psa_aead_decrypt_setup( &operation, key, alg );
Paul Elliottd3f82412021-06-16 16:52:21 +0100393
394 /* If the operation is not supported, just skip and not fail in case the
395 * encryption involves a common limitation of cryptography hardwares and
396 * an alternative implementation. */
397 if( status == PSA_ERROR_NOT_SUPPORTED )
398 {
399 MBEDTLS_TEST_PSA_SKIP_IF_ALT_AES_192( key_type, key_data->len * 8 );
400 MBEDTLS_TEST_PSA_SKIP_IF_ALT_GCM_NOT_12BYTES_NONCE( alg, nonce->len );
401 }
402
403 PSA_ASSERT( status );
404
Paul Elliottebf91632021-07-22 17:54:42 +0100405 if( swap_set_functions )
Paul Elliottd3f82412021-06-16 16:52:21 +0100406 {
Paul Elliottebf91632021-07-22 17:54:42 +0100407 if( do_set_lengths )
408 {
409 PSA_ASSERT( psa_aead_set_lengths( &operation, additional_data->len,
410 data_true_size ) );
411 }
412
413 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
414 }
415 else
416 {
417 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
418
419 if( do_set_lengths )
420 {
421 PSA_ASSERT( psa_aead_set_lengths( &operation, additional_data->len,
422 data_true_size ) );
423 }
Paul Elliottd3f82412021-06-16 16:52:21 +0100424 }
Paul Elliottd3f82412021-06-16 16:52:21 +0100425
426 if( ad_part_len != -1 )
427 {
428 /* Pass additional data in parts */
429 part_offset = 0;
430
431 while( part_offset < additional_data->len )
432 {
Paul Elliott329d5382021-07-22 17:10:45 +0100433 if( do_zero_parts && part_count++ & 0x01 )
Paul Elliottd3f82412021-06-16 16:52:21 +0100434 {
Paul Elliott329d5382021-07-22 17:10:45 +0100435 part_length = 0;
Paul Elliottd3f82412021-06-16 16:52:21 +0100436 }
437 else
438 {
Paul Elliott329d5382021-07-22 17:10:45 +0100439 if( additional_data->len - part_offset <
440 ( uint32_t ) ad_part_len )
441 {
442 part_length = additional_data->len - part_offset;
443 }
444 else
445 {
446 part_length = ad_part_len;
447 }
Paul Elliottd3f82412021-06-16 16:52:21 +0100448 }
449
450 PSA_ASSERT( psa_aead_update_ad( &operation,
451 additional_data->x + part_offset,
452 part_length ) );
453
454 part_offset += part_length;
455 }
456 }
457 else
458 {
459 /* Pass additional data in one go. */
460 PSA_ASSERT( psa_aead_update_ad( &operation, additional_data->x,
461 additional_data->len ) );
462 }
463
464 if( data_part_len != -1 )
465 {
466 /* Pass data in parts */
467 part_data_size = PSA_AEAD_UPDATE_OUTPUT_SIZE( key_type, alg,
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100468 ( size_t ) data_part_len );
Paul Elliottd3f82412021-06-16 16:52:21 +0100469
470 ASSERT_ALLOC( part_data, part_data_size );
471
472 part_offset = 0;
473
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100474 while( part_offset < data_true_size )
Paul Elliottd3f82412021-06-16 16:52:21 +0100475 {
Paul Elliott329d5382021-07-22 17:10:45 +0100476 if( do_zero_parts && part_count++ & 0x01 )
Paul Elliottd3f82412021-06-16 16:52:21 +0100477 {
Paul Elliott329d5382021-07-22 17:10:45 +0100478 part_length = 0;
Paul Elliottd3f82412021-06-16 16:52:21 +0100479 }
480 else
481 {
Paul Elliott329d5382021-07-22 17:10:45 +0100482 if( ( data_true_size - part_offset ) < ( uint32_t ) data_part_len )
483 {
484 part_length = ( data_true_size - part_offset );
485 }
486 else
487 {
488 part_length = data_part_len;
489 }
Paul Elliottd3f82412021-06-16 16:52:21 +0100490 }
491
492 PSA_ASSERT( psa_aead_update( &operation,
493 ( input_data->x + part_offset ),
494 part_length, part_data,
495 part_data_size,
496 &output_part_length ) );
497
498 if( output_data && output_part_length )
499 {
500 memcpy( ( output_data + part_offset ), part_data,
501 output_part_length );
502 }
503
504 part_offset += part_length;
505 output_length += output_part_length;
506 }
507 }
508 else
509 {
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100510 /* Pass all data in one go. */
Paul Elliottd3f82412021-06-16 16:52:21 +0100511 PSA_ASSERT( psa_aead_update( &operation, input_data->x,
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100512 data_true_size, output_data,
Paul Elliottd3f82412021-06-16 16:52:21 +0100513 output_size, &output_length ) );
514 }
515
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100516 if( is_encrypt )
517 PSA_ASSERT( psa_aead_finish( &operation, final_data,
518 final_output_size,
519 &output_part_length,
520 tag_buffer, tag_length,
521 &tag_size ) );
522 else
Paul Elliottd3f82412021-06-16 16:52:21 +0100523 {
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100524 status = psa_aead_verify( &operation, final_data,
525 final_output_size,
526 &output_part_length,
527 ( input_data->x + data_true_size ),
528 tag_length );
529
530 if( status != PSA_SUCCESS )
531 {
532 if( !expect_valid_signature )
533 {
534 /* Expected failure. */
535 test_ok = 1;
536 goto exit;
537 }
538 else
539 PSA_ASSERT( status );
540 }
Paul Elliottd3f82412021-06-16 16:52:21 +0100541 }
542
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100543 if( output_data && output_part_length )
544 memcpy( ( output_data + output_length ), final_data,
545 output_part_length );
Paul Elliottd3f82412021-06-16 16:52:21 +0100546
547 output_length += output_part_length;
548
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100549
550 /* For all currently defined algorithms, PSA_AEAD_xxx_OUTPUT_SIZE
551 * should be exact.*/
552 if( is_encrypt )
Paul Elliottd3f82412021-06-16 16:52:21 +0100553 {
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100554 TEST_EQUAL( tag_length, tag_size );
555
556 if( output_data && tag_length )
557 memcpy( ( output_data + output_length ), tag_buffer,
558 tag_length );
559
560 output_length += tag_length;
561
562 TEST_EQUAL( output_length,
563 PSA_AEAD_ENCRYPT_OUTPUT_SIZE( key_type, alg,
564 input_data->len ) );
565 TEST_ASSERT( output_length <=
566 PSA_AEAD_ENCRYPT_OUTPUT_MAX_SIZE( input_data->len ) );
567 }
568 else
569 {
570 TEST_EQUAL( output_length,
571 PSA_AEAD_DECRYPT_OUTPUT_SIZE( key_type, alg,
572 input_data->len ) );
573 TEST_ASSERT( output_length <=
574 PSA_AEAD_DECRYPT_OUTPUT_MAX_SIZE( input_data->len ) );
Paul Elliottd3f82412021-06-16 16:52:21 +0100575 }
576
Paul Elliottd3f82412021-06-16 16:52:21 +0100577
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100578 ASSERT_COMPARE( expected_output->x, expected_output->len,
Paul Elliottd3f82412021-06-16 16:52:21 +0100579 output_data, output_length );
580
Paul Elliottd3f82412021-06-16 16:52:21 +0100581
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100582 test_ok = 1;
Paul Elliottd3f82412021-06-16 16:52:21 +0100583
584exit:
585 psa_destroy_key( key );
586 psa_aead_abort( &operation );
587 mbedtls_free( output_data );
588 mbedtls_free( part_data );
589 mbedtls_free( final_data );
590 PSA_DONE( );
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100591
592 return( test_ok );
Paul Elliottd3f82412021-06-16 16:52:21 +0100593}
594
Gilles Peskinee59236f2018-01-27 23:32:46 +0100595/* END_HEADER */
596
597/* BEGIN_DEPENDENCIES
598 * depends_on:MBEDTLS_PSA_CRYPTO_C
599 * END_DEPENDENCIES
600 */
601
602/* BEGIN_CASE */
Gilles Peskinee1f2d7d2018-08-21 14:54:54 +0200603void static_checks( )
604{
605 size_t max_truncated_mac_size =
606 PSA_ALG_MAC_TRUNCATION_MASK >> PSA_MAC_TRUNCATION_OFFSET;
607
608 /* Check that the length for a truncated MAC always fits in the algorithm
609 * encoding. The shifted mask is the maximum truncated value. The
610 * untruncated algorithm may be one byte larger. */
611 TEST_ASSERT( PSA_MAC_MAX_SIZE <= 1 + max_truncated_mac_size );
612}
613/* END_CASE */
614
615/* BEGIN_CASE */
Gilles Peskine6edfa292019-07-31 15:53:45 +0200616void import_with_policy( int type_arg,
617 int usage_arg, int alg_arg,
618 int expected_status_arg )
619{
620 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
621 psa_key_attributes_t got_attributes = PSA_KEY_ATTRIBUTES_INIT;
Ronald Cron5425a212020-08-04 14:58:35 +0200622 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine6edfa292019-07-31 15:53:45 +0200623 psa_key_type_t type = type_arg;
624 psa_key_usage_t usage = usage_arg;
625 psa_algorithm_t alg = alg_arg;
626 psa_status_t expected_status = expected_status_arg;
627 const uint8_t key_material[16] = {0};
628 psa_status_t status;
629
630 PSA_ASSERT( psa_crypto_init( ) );
631
632 psa_set_key_type( &attributes, type );
633 psa_set_key_usage_flags( &attributes, usage );
634 psa_set_key_algorithm( &attributes, alg );
635
636 status = psa_import_key( &attributes,
637 key_material, sizeof( key_material ),
Ronald Cron5425a212020-08-04 14:58:35 +0200638 &key );
Gilles Peskine6edfa292019-07-31 15:53:45 +0200639 TEST_EQUAL( status, expected_status );
640 if( status != PSA_SUCCESS )
641 goto exit;
642
Ronald Cron5425a212020-08-04 14:58:35 +0200643 PSA_ASSERT( psa_get_key_attributes( key, &got_attributes ) );
Gilles Peskine6edfa292019-07-31 15:53:45 +0200644 TEST_EQUAL( psa_get_key_type( &got_attributes ), type );
645 TEST_EQUAL( psa_get_key_usage_flags( &got_attributes ), usage );
646 TEST_EQUAL( psa_get_key_algorithm( &got_attributes ), alg );
Gilles Peskine5fe5e272019-08-02 20:30:01 +0200647 ASSERT_NO_SLOT_NUMBER( &got_attributes );
Gilles Peskine6edfa292019-07-31 15:53:45 +0200648
Ronald Cron5425a212020-08-04 14:58:35 +0200649 PSA_ASSERT( psa_destroy_key( key ) );
650 test_operations_on_invalid_key( key );
Gilles Peskine6edfa292019-07-31 15:53:45 +0200651
652exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +0100653 /*
654 * Key attributes may have been returned by psa_get_key_attributes()
655 * thus reset them as required.
656 */
Gilles Peskine6edfa292019-07-31 15:53:45 +0200657 psa_reset_key_attributes( &got_attributes );
Ronald Cron3a4f0e32020-11-19 17:55:23 +0100658
659 psa_destroy_key( key );
Gilles Peskine6edfa292019-07-31 15:53:45 +0200660 PSA_DONE( );
661}
662/* END_CASE */
663
664/* BEGIN_CASE */
665void import_with_data( data_t *data, int type_arg,
666 int attr_bits_arg,
667 int expected_status_arg )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +0200668{
669 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
670 psa_key_attributes_t got_attributes = PSA_KEY_ATTRIBUTES_INIT;
Ronald Cron5425a212020-08-04 14:58:35 +0200671 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +0200672 psa_key_type_t type = type_arg;
Gilles Peskine8fb3a9e2019-05-03 16:59:21 +0200673 size_t attr_bits = attr_bits_arg;
Gilles Peskineb866e2b2018-06-21 09:25:10 +0200674 psa_status_t expected_status = expected_status_arg;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100675 psa_status_t status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100676
Gilles Peskine8817f612018-12-18 00:18:46 +0100677 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100678
Gilles Peskine4747d192019-04-17 15:05:45 +0200679 psa_set_key_type( &attributes, type );
Gilles Peskine8fb3a9e2019-05-03 16:59:21 +0200680 psa_set_key_bits( &attributes, attr_bits );
Gilles Peskine6edfa292019-07-31 15:53:45 +0200681
Ronald Cron5425a212020-08-04 14:58:35 +0200682 status = psa_import_key( &attributes, data->x, data->len, &key );
Gilles Peskinefe11b722018-12-18 00:24:04 +0100683 TEST_EQUAL( status, expected_status );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +0200684 if( status != PSA_SUCCESS )
685 goto exit;
686
Ronald Cron5425a212020-08-04 14:58:35 +0200687 PSA_ASSERT( psa_get_key_attributes( key, &got_attributes ) );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +0200688 TEST_EQUAL( psa_get_key_type( &got_attributes ), type );
Gilles Peskine8fb3a9e2019-05-03 16:59:21 +0200689 if( attr_bits != 0 )
Gilles Peskine7e0cff92019-07-30 13:48:52 +0200690 TEST_EQUAL( attr_bits, psa_get_key_bits( &got_attributes ) );
Gilles Peskine5fe5e272019-08-02 20:30:01 +0200691 ASSERT_NO_SLOT_NUMBER( &got_attributes );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +0200692
Ronald Cron5425a212020-08-04 14:58:35 +0200693 PSA_ASSERT( psa_destroy_key( key ) );
694 test_operations_on_invalid_key( key );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100695
696exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +0100697 /*
698 * Key attributes may have been returned by psa_get_key_attributes()
699 * thus reset them as required.
700 */
Gilles Peskinea1ace9c2019-04-26 16:03:33 +0200701 psa_reset_key_attributes( &got_attributes );
Ronald Cron3a4f0e32020-11-19 17:55:23 +0100702
703 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +0200704 PSA_DONE( );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100705}
706/* END_CASE */
707
708/* BEGIN_CASE */
Gilles Peskinec744d992019-07-30 17:26:54 +0200709void import_large_key( int type_arg, int byte_size_arg,
710 int expected_status_arg )
711{
712 psa_key_type_t type = type_arg;
713 size_t byte_size = byte_size_arg;
714 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
715 psa_status_t expected_status = expected_status_arg;
Ronald Cron5425a212020-08-04 14:58:35 +0200716 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskinec744d992019-07-30 17:26:54 +0200717 psa_status_t status;
718 uint8_t *buffer = NULL;
719 size_t buffer_size = byte_size + 1;
720 size_t n;
721
Steven Cooreman69967ce2021-01-18 18:01:08 +0100722 /* Skip the test case if the target running the test cannot
723 * accomodate large keys due to heap size constraints */
724 ASSERT_ALLOC_WEAK( buffer, buffer_size );
Gilles Peskinec744d992019-07-30 17:26:54 +0200725 memset( buffer, 'K', byte_size );
726
727 PSA_ASSERT( psa_crypto_init( ) );
728
729 /* Try importing the key */
730 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_EXPORT );
731 psa_set_key_type( &attributes, type );
Ronald Cron5425a212020-08-04 14:58:35 +0200732 status = psa_import_key( &attributes, buffer, byte_size, &key );
Steven Cooreman83fdb702021-01-21 14:24:39 +0100733 TEST_ASSUME( status != PSA_ERROR_INSUFFICIENT_MEMORY );
Gilles Peskinec744d992019-07-30 17:26:54 +0200734 TEST_EQUAL( status, expected_status );
735
736 if( status == PSA_SUCCESS )
737 {
Ronald Cron5425a212020-08-04 14:58:35 +0200738 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
Gilles Peskinec744d992019-07-30 17:26:54 +0200739 TEST_EQUAL( psa_get_key_type( &attributes ), type );
740 TEST_EQUAL( psa_get_key_bits( &attributes ),
741 PSA_BYTES_TO_BITS( byte_size ) );
Gilles Peskine5fe5e272019-08-02 20:30:01 +0200742 ASSERT_NO_SLOT_NUMBER( &attributes );
Gilles Peskinec744d992019-07-30 17:26:54 +0200743 memset( buffer, 0, byte_size + 1 );
Ronald Cron5425a212020-08-04 14:58:35 +0200744 PSA_ASSERT( psa_export_key( key, buffer, byte_size, &n ) );
Gilles Peskinec744d992019-07-30 17:26:54 +0200745 for( n = 0; n < byte_size; n++ )
746 TEST_EQUAL( buffer[n], 'K' );
747 for( n = byte_size; n < buffer_size; n++ )
748 TEST_EQUAL( buffer[n], 0 );
749 }
750
751exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +0100752 /*
753 * Key attributes may have been returned by psa_get_key_attributes()
754 * thus reset them as required.
755 */
756 psa_reset_key_attributes( &attributes );
757
Ronald Cron5425a212020-08-04 14:58:35 +0200758 psa_destroy_key( key );
Gilles Peskinec744d992019-07-30 17:26:54 +0200759 PSA_DONE( );
760 mbedtls_free( buffer );
761}
762/* END_CASE */
763
764/* BEGIN_CASE */
Gilles Peskine0b352bc2018-06-28 00:16:11 +0200765void import_rsa_made_up( int bits_arg, int keypair, int expected_status_arg )
766{
Ronald Cron5425a212020-08-04 14:58:35 +0200767 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine0b352bc2018-06-28 00:16:11 +0200768 size_t bits = bits_arg;
769 psa_status_t expected_status = expected_status_arg;
770 psa_status_t status;
771 psa_key_type_t type =
Gilles Peskinec93b80c2019-05-16 19:39:54 +0200772 keypair ? PSA_KEY_TYPE_RSA_KEY_PAIR : PSA_KEY_TYPE_RSA_PUBLIC_KEY;
Gilles Peskine0b352bc2018-06-28 00:16:11 +0200773 size_t buffer_size = /* Slight overapproximations */
774 keypair ? bits * 9 / 16 + 80 : bits / 8 + 20;
Gilles Peskine8cebbba2018-09-27 13:54:18 +0200775 unsigned char *buffer = NULL;
Gilles Peskine0b352bc2018-06-28 00:16:11 +0200776 unsigned char *p;
777 int ret;
778 size_t length;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +0200779 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine0b352bc2018-06-28 00:16:11 +0200780
Gilles Peskine8817f612018-12-18 00:18:46 +0100781 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine8cebbba2018-09-27 13:54:18 +0200782 ASSERT_ALLOC( buffer, buffer_size );
Gilles Peskine0b352bc2018-06-28 00:16:11 +0200783
784 TEST_ASSERT( ( ret = construct_fake_rsa_key( buffer, buffer_size, &p,
785 bits, keypair ) ) >= 0 );
786 length = ret;
787
788 /* Try importing the key */
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +0200789 psa_set_key_type( &attributes, type );
Ronald Cron5425a212020-08-04 14:58:35 +0200790 status = psa_import_key( &attributes, p, length, &key );
Gilles Peskinefe11b722018-12-18 00:24:04 +0100791 TEST_EQUAL( status, expected_status );
Gilles Peskine76b29a72019-05-28 14:08:50 +0200792
Gilles Peskine0b352bc2018-06-28 00:16:11 +0200793 if( status == PSA_SUCCESS )
Ronald Cron5425a212020-08-04 14:58:35 +0200794 PSA_ASSERT( psa_destroy_key( key ) );
Gilles Peskine0b352bc2018-06-28 00:16:11 +0200795
796exit:
797 mbedtls_free( buffer );
Gilles Peskine1153e7b2019-05-28 15:10:21 +0200798 PSA_DONE( );
Gilles Peskine0b352bc2018-06-28 00:16:11 +0200799}
800/* END_CASE */
801
802/* BEGIN_CASE */
itayzafrir3e02b3b2018-06-12 17:06:52 +0300803void import_export( data_t *data,
Moran Pekera964a8f2018-06-04 18:42:36 +0300804 int type_arg,
Gilles Peskine1ecf92c22019-05-24 15:00:06 +0200805 int usage_arg, int alg_arg,
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100806 int expected_bits,
807 int export_size_delta,
Gilles Peskineb866e2b2018-06-21 09:25:10 +0200808 int expected_export_status_arg,
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100809 int canonical_input )
810{
Ronald Cron5425a212020-08-04 14:58:35 +0200811 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100812 psa_key_type_t type = type_arg;
Gilles Peskine4abf7412018-06-18 16:35:34 +0200813 psa_algorithm_t alg = alg_arg;
Gilles Peskineb866e2b2018-06-21 09:25:10 +0200814 psa_status_t expected_export_status = expected_export_status_arg;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100815 psa_status_t status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100816 unsigned char *exported = NULL;
817 unsigned char *reexported = NULL;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100818 size_t export_size;
Jaeden Amerof24c7f82018-06-27 17:20:43 +0100819 size_t exported_length = INVALID_EXPORT_LENGTH;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100820 size_t reexported_length;
Gilles Peskine4747d192019-04-17 15:05:45 +0200821 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +0200822 psa_key_attributes_t got_attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100823
Moran Pekercb088e72018-07-17 17:36:59 +0300824 export_size = (ptrdiff_t) data->len + export_size_delta;
Gilles Peskine8cebbba2018-09-27 13:54:18 +0200825 ASSERT_ALLOC( exported, export_size );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100826 if( ! canonical_input )
Gilles Peskine8cebbba2018-09-27 13:54:18 +0200827 ASSERT_ALLOC( reexported, export_size );
Gilles Peskine8817f612018-12-18 00:18:46 +0100828 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100829
Gilles Peskine4747d192019-04-17 15:05:45 +0200830 psa_set_key_usage_flags( &attributes, usage_arg );
831 psa_set_key_algorithm( &attributes, alg );
832 psa_set_key_type( &attributes, type );
mohammad1603a97cb8c2018-03-28 03:46:26 -0700833
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100834 /* Import the key */
Ronald Cron5425a212020-08-04 14:58:35 +0200835 PSA_ASSERT( psa_import_key( &attributes, data->x, data->len, &key ) );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100836
837 /* Test the key information */
Ronald Cron5425a212020-08-04 14:58:35 +0200838 PSA_ASSERT( psa_get_key_attributes( key, &got_attributes ) );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +0200839 TEST_EQUAL( psa_get_key_type( &got_attributes ), type );
840 TEST_EQUAL( psa_get_key_bits( &got_attributes ), (size_t) expected_bits );
Gilles Peskine5fe5e272019-08-02 20:30:01 +0200841 ASSERT_NO_SLOT_NUMBER( &got_attributes );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100842
843 /* Export the key */
Ronald Cron5425a212020-08-04 14:58:35 +0200844 status = psa_export_key( key, exported, export_size, &exported_length );
Gilles Peskinefe11b722018-12-18 00:24:04 +0100845 TEST_EQUAL( status, expected_export_status );
Jaeden Amerof24c7f82018-06-27 17:20:43 +0100846
847 /* The exported length must be set by psa_export_key() to a value between 0
848 * and export_size. On errors, the exported length must be 0. */
849 TEST_ASSERT( exported_length != INVALID_EXPORT_LENGTH );
850 TEST_ASSERT( status == PSA_SUCCESS || exported_length == 0 );
851 TEST_ASSERT( exported_length <= export_size );
852
Gilles Peskinea7aa4422018-08-14 15:17:54 +0200853 TEST_ASSERT( mem_is_char( exported + exported_length, 0,
Gilles Peskine3f669c32018-06-21 09:21:51 +0200854 export_size - exported_length ) );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100855 if( status != PSA_SUCCESS )
Gilles Peskinee66ca3b2018-06-20 00:11:45 +0200856 {
Gilles Peskinefe11b722018-12-18 00:24:04 +0100857 TEST_EQUAL( exported_length, 0 );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100858 goto destroy;
Gilles Peskinee66ca3b2018-06-20 00:11:45 +0200859 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100860
Gilles Peskineea38a922021-02-13 00:05:16 +0100861 /* Run sanity checks on the exported key. For non-canonical inputs,
862 * this validates the canonical representations. For canonical inputs,
863 * this doesn't directly validate the implementation, but it still helps
864 * by cross-validating the test data with the sanity check code. */
865 if( ! mbedtls_test_psa_exercise_key( key, usage_arg, 0 ) )
Gilles Peskine8f609232018-08-11 01:24:55 +0200866 goto exit;
867
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100868 if( canonical_input )
Gilles Peskinebd7dea92018-09-27 13:57:19 +0200869 ASSERT_COMPARE( data->x, data->len, exported, exported_length );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100870 else
871 {
Ronald Cron5425a212020-08-04 14:58:35 +0200872 mbedtls_svc_key_id_t key2 = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine049c7532019-05-15 20:22:09 +0200873 PSA_ASSERT( psa_import_key( &attributes, exported, exported_length,
Ronald Cron5425a212020-08-04 14:58:35 +0200874 &key2 ) );
875 PSA_ASSERT( psa_export_key( key2,
Gilles Peskine8817f612018-12-18 00:18:46 +0100876 reexported,
877 export_size,
878 &reexported_length ) );
Gilles Peskinebd7dea92018-09-27 13:57:19 +0200879 ASSERT_COMPARE( exported, exported_length,
880 reexported, reexported_length );
Ronald Cron5425a212020-08-04 14:58:35 +0200881 PSA_ASSERT( psa_destroy_key( key2 ) );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100882 }
gabor-mezei-armceface22021-01-21 12:26:17 +0100883 TEST_ASSERT( exported_length <=
884 PSA_EXPORT_KEY_OUTPUT_SIZE( type,
885 psa_get_key_bits( &got_attributes ) ) );
886 TEST_ASSERT( exported_length <= PSA_EXPORT_KEY_PAIR_MAX_SIZE );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100887
888destroy:
889 /* Destroy the key */
Ronald Cron5425a212020-08-04 14:58:35 +0200890 PSA_ASSERT( psa_destroy_key( key ) );
891 test_operations_on_invalid_key( key );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100892
893exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +0100894 /*
895 * Key attributes may have been returned by psa_get_key_attributes()
896 * thus reset them as required.
897 */
898 psa_reset_key_attributes( &got_attributes );
899
itayzafrir3e02b3b2018-06-12 17:06:52 +0300900 mbedtls_free( exported );
901 mbedtls_free( reexported );
Gilles Peskine1153e7b2019-05-28 15:10:21 +0200902 PSA_DONE( );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100903}
904/* END_CASE */
Gilles Peskine20035e32018-02-03 22:44:14 +0100905
Moran Pekerf709f4a2018-06-06 17:26:04 +0300906/* BEGIN_CASE */
itayzafrir3e02b3b2018-06-12 17:06:52 +0300907void import_export_public_key( data_t *data,
Gilles Peskine2d277862018-06-18 15:41:12 +0200908 int type_arg,
909 int alg_arg,
Gilles Peskine49c25912018-10-29 15:15:31 +0100910 int export_size_delta,
911 int expected_export_status_arg,
912 data_t *expected_public_key )
Moran Pekerf709f4a2018-06-06 17:26:04 +0300913{
Ronald Cron5425a212020-08-04 14:58:35 +0200914 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Moran Pekerf709f4a2018-06-06 17:26:04 +0300915 psa_key_type_t type = type_arg;
Gilles Peskine4abf7412018-06-18 16:35:34 +0200916 psa_algorithm_t alg = alg_arg;
Gilles Peskineb866e2b2018-06-21 09:25:10 +0200917 psa_status_t expected_export_status = expected_export_status_arg;
Moran Pekerf709f4a2018-06-06 17:26:04 +0300918 psa_status_t status;
Moran Pekerf709f4a2018-06-06 17:26:04 +0300919 unsigned char *exported = NULL;
Gilles Peskine49c25912018-10-29 15:15:31 +0100920 size_t export_size = expected_public_key->len + export_size_delta;
Jaeden Amero2a671e92018-06-27 17:47:40 +0100921 size_t exported_length = INVALID_EXPORT_LENGTH;
Gilles Peskine4747d192019-04-17 15:05:45 +0200922 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Moran Pekerf709f4a2018-06-06 17:26:04 +0300923
Gilles Peskine8817f612018-12-18 00:18:46 +0100924 PSA_ASSERT( psa_crypto_init( ) );
Moran Pekerf709f4a2018-06-06 17:26:04 +0300925
Gilles Peskine4747d192019-04-17 15:05:45 +0200926 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_EXPORT );
927 psa_set_key_algorithm( &attributes, alg );
928 psa_set_key_type( &attributes, type );
Moran Pekerf709f4a2018-06-06 17:26:04 +0300929
930 /* Import the key */
Ronald Cron5425a212020-08-04 14:58:35 +0200931 PSA_ASSERT( psa_import_key( &attributes, data->x, data->len, &key ) );
Moran Pekerf709f4a2018-06-06 17:26:04 +0300932
Gilles Peskine49c25912018-10-29 15:15:31 +0100933 /* Export the public key */
934 ASSERT_ALLOC( exported, export_size );
Ronald Cron5425a212020-08-04 14:58:35 +0200935 status = psa_export_public_key( key,
Gilles Peskine2d277862018-06-18 15:41:12 +0200936 exported, export_size,
937 &exported_length );
Gilles Peskinefe11b722018-12-18 00:24:04 +0100938 TEST_EQUAL( status, expected_export_status );
Gilles Peskine49c25912018-10-29 15:15:31 +0100939 if( status == PSA_SUCCESS )
Gilles Peskined8b7d4f2018-10-29 15:18:41 +0100940 {
Gilles Peskinec93b80c2019-05-16 19:39:54 +0200941 psa_key_type_t public_type = PSA_KEY_TYPE_PUBLIC_KEY_OF_KEY_PAIR( type );
Gilles Peskined8b7d4f2018-10-29 15:18:41 +0100942 size_t bits;
Ronald Cron5425a212020-08-04 14:58:35 +0200943 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +0200944 bits = psa_get_key_bits( &attributes );
Gilles Peskined8b7d4f2018-10-29 15:18:41 +0100945 TEST_ASSERT( expected_public_key->len <=
gabor-mezei-armcbcec212020-12-18 14:23:51 +0100946 PSA_EXPORT_KEY_OUTPUT_SIZE( public_type, bits ) );
gabor-mezei-armceface22021-01-21 12:26:17 +0100947 TEST_ASSERT( expected_public_key->len <=
948 PSA_EXPORT_PUBLIC_KEY_OUTPUT_SIZE( public_type, bits ) );
949 TEST_ASSERT( expected_public_key->len <=
950 PSA_EXPORT_PUBLIC_KEY_MAX_SIZE );
Gilles Peskine49c25912018-10-29 15:15:31 +0100951 ASSERT_COMPARE( expected_public_key->x, expected_public_key->len,
952 exported, exported_length );
Gilles Peskined8b7d4f2018-10-29 15:18:41 +0100953 }
Moran Pekerf709f4a2018-06-06 17:26:04 +0300954
955exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +0100956 /*
957 * Key attributes may have been returned by psa_get_key_attributes()
958 * thus reset them as required.
959 */
960 psa_reset_key_attributes( &attributes );
961
itayzafrir3e02b3b2018-06-12 17:06:52 +0300962 mbedtls_free( exported );
Ronald Cron5425a212020-08-04 14:58:35 +0200963 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +0200964 PSA_DONE( );
Moran Pekerf709f4a2018-06-06 17:26:04 +0300965}
966/* END_CASE */
967
Gilles Peskine20035e32018-02-03 22:44:14 +0100968/* BEGIN_CASE */
Gilles Peskinea680c7a2018-06-26 16:12:43 +0200969void import_and_exercise_key( data_t *data,
970 int type_arg,
971 int bits_arg,
972 int alg_arg )
973{
Ronald Cron5425a212020-08-04 14:58:35 +0200974 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskinea680c7a2018-06-26 16:12:43 +0200975 psa_key_type_t type = type_arg;
976 size_t bits = bits_arg;
977 psa_algorithm_t alg = alg_arg;
Gilles Peskinec18e25f2021-02-12 23:48:20 +0100978 psa_key_usage_t usage = mbedtls_test_psa_usage_to_exercise( type, alg );
Gilles Peskine4747d192019-04-17 15:05:45 +0200979 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +0200980 psa_key_attributes_t got_attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskinea680c7a2018-06-26 16:12:43 +0200981
Gilles Peskine8817f612018-12-18 00:18:46 +0100982 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskinea680c7a2018-06-26 16:12:43 +0200983
Gilles Peskine4747d192019-04-17 15:05:45 +0200984 psa_set_key_usage_flags( &attributes, usage );
985 psa_set_key_algorithm( &attributes, alg );
986 psa_set_key_type( &attributes, type );
Gilles Peskinea680c7a2018-06-26 16:12:43 +0200987
988 /* Import the key */
Ronald Cron5425a212020-08-04 14:58:35 +0200989 PSA_ASSERT( psa_import_key( &attributes, data->x, data->len, &key ) );
Gilles Peskinea680c7a2018-06-26 16:12:43 +0200990
991 /* Test the key information */
Ronald Cron5425a212020-08-04 14:58:35 +0200992 PSA_ASSERT( psa_get_key_attributes( key, &got_attributes ) );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +0200993 TEST_EQUAL( psa_get_key_type( &got_attributes ), type );
994 TEST_EQUAL( psa_get_key_bits( &got_attributes ), bits );
Gilles Peskinea680c7a2018-06-26 16:12:43 +0200995
996 /* Do something with the key according to its type and permitted usage. */
Gilles Peskinec18e25f2021-02-12 23:48:20 +0100997 if( ! mbedtls_test_psa_exercise_key( key, usage, alg ) )
Gilles Peskine02b75072018-07-01 22:31:34 +0200998 goto exit;
Gilles Peskinea680c7a2018-06-26 16:12:43 +0200999
Ronald Cron5425a212020-08-04 14:58:35 +02001000 PSA_ASSERT( psa_destroy_key( key ) );
1001 test_operations_on_invalid_key( key );
Gilles Peskine4cf3a432019-04-18 22:28:52 +02001002
Gilles Peskinea680c7a2018-06-26 16:12:43 +02001003exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +01001004 /*
1005 * Key attributes may have been returned by psa_get_key_attributes()
1006 * thus reset them as required.
1007 */
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02001008 psa_reset_key_attributes( &got_attributes );
Ronald Cron3a4f0e32020-11-19 17:55:23 +01001009
1010 psa_reset_key_attributes( &attributes );
1011 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02001012 PSA_DONE( );
Gilles Peskinea680c7a2018-06-26 16:12:43 +02001013}
1014/* END_CASE */
1015
1016/* BEGIN_CASE */
Gilles Peskine06c28892019-11-26 18:07:46 +01001017void effective_key_attributes( int type_arg, int expected_type_arg,
1018 int bits_arg, int expected_bits_arg,
1019 int usage_arg, int expected_usage_arg,
1020 int alg_arg, int expected_alg_arg )
Gilles Peskined5b33222018-06-18 22:20:03 +02001021{
Ronald Cron5425a212020-08-04 14:58:35 +02001022 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine1a960492019-11-26 17:12:21 +01001023 psa_key_type_t key_type = type_arg;
Gilles Peskine06c28892019-11-26 18:07:46 +01001024 psa_key_type_t expected_key_type = expected_type_arg;
Gilles Peskine1a960492019-11-26 17:12:21 +01001025 size_t bits = bits_arg;
Gilles Peskine06c28892019-11-26 18:07:46 +01001026 size_t expected_bits = expected_bits_arg;
Gilles Peskined5b33222018-06-18 22:20:03 +02001027 psa_algorithm_t alg = alg_arg;
Gilles Peskine06c28892019-11-26 18:07:46 +01001028 psa_algorithm_t expected_alg = expected_alg_arg;
Gilles Peskined5b33222018-06-18 22:20:03 +02001029 psa_key_usage_t usage = usage_arg;
Gilles Peskine06c28892019-11-26 18:07:46 +01001030 psa_key_usage_t expected_usage = expected_usage_arg;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001031 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskined5b33222018-06-18 22:20:03 +02001032
Gilles Peskine8817f612018-12-18 00:18:46 +01001033 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskined5b33222018-06-18 22:20:03 +02001034
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001035 psa_set_key_usage_flags( &attributes, usage );
1036 psa_set_key_algorithm( &attributes, alg );
1037 psa_set_key_type( &attributes, key_type );
Gilles Peskine1a960492019-11-26 17:12:21 +01001038 psa_set_key_bits( &attributes, bits );
Gilles Peskined5b33222018-06-18 22:20:03 +02001039
Ronald Cron5425a212020-08-04 14:58:35 +02001040 PSA_ASSERT( psa_generate_key( &attributes, &key ) );
Gilles Peskine1a960492019-11-26 17:12:21 +01001041 psa_reset_key_attributes( &attributes );
Gilles Peskined5b33222018-06-18 22:20:03 +02001042
Ronald Cron5425a212020-08-04 14:58:35 +02001043 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
Gilles Peskine06c28892019-11-26 18:07:46 +01001044 TEST_EQUAL( psa_get_key_type( &attributes ), expected_key_type );
1045 TEST_EQUAL( psa_get_key_bits( &attributes ), expected_bits );
1046 TEST_EQUAL( psa_get_key_usage_flags( &attributes ), expected_usage );
1047 TEST_EQUAL( psa_get_key_algorithm( &attributes ), expected_alg );
Gilles Peskined5b33222018-06-18 22:20:03 +02001048
1049exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +01001050 /*
1051 * Key attributes may have been returned by psa_get_key_attributes()
1052 * thus reset them as required.
1053 */
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02001054 psa_reset_key_attributes( &attributes );
Ronald Cron3a4f0e32020-11-19 17:55:23 +01001055
1056 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02001057 PSA_DONE( );
Gilles Peskined5b33222018-06-18 22:20:03 +02001058}
1059/* END_CASE */
1060
1061/* BEGIN_CASE */
Gilles Peskine06c28892019-11-26 18:07:46 +01001062void check_key_policy( int type_arg, int bits_arg,
1063 int usage_arg, int alg_arg )
1064{
1065 test_effective_key_attributes( type_arg, type_arg, bits_arg, bits_arg,
1066 usage_arg, usage_arg, alg_arg, alg_arg );
1067 goto exit;
1068}
1069/* END_CASE */
1070
1071/* BEGIN_CASE */
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001072void key_attributes_init( )
Jaeden Amero70261c52019-01-04 11:47:20 +00001073{
1074 /* Test each valid way of initializing the object, except for `= {0}`, as
1075 * Clang 5 complains when `-Wmissing-field-initializers` is used, even
1076 * though it's OK by the C standard. We could test for this, but we'd need
1077 * to supress the Clang warning for the test. */
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001078 psa_key_attributes_t func = psa_key_attributes_init( );
1079 psa_key_attributes_t init = PSA_KEY_ATTRIBUTES_INIT;
1080 psa_key_attributes_t zero;
Jaeden Amero70261c52019-01-04 11:47:20 +00001081
1082 memset( &zero, 0, sizeof( zero ) );
1083
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001084 TEST_EQUAL( psa_get_key_lifetime( &func ), PSA_KEY_LIFETIME_VOLATILE );
1085 TEST_EQUAL( psa_get_key_lifetime( &init ), PSA_KEY_LIFETIME_VOLATILE );
1086 TEST_EQUAL( psa_get_key_lifetime( &zero ), PSA_KEY_LIFETIME_VOLATILE );
Jaeden Amero5229bbb2019-02-07 16:33:37 +00001087
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001088 TEST_EQUAL( psa_get_key_type( &func ), 0 );
1089 TEST_EQUAL( psa_get_key_type( &init ), 0 );
1090 TEST_EQUAL( psa_get_key_type( &zero ), 0 );
1091
1092 TEST_EQUAL( psa_get_key_bits( &func ), 0 );
1093 TEST_EQUAL( psa_get_key_bits( &init ), 0 );
1094 TEST_EQUAL( psa_get_key_bits( &zero ), 0 );
1095
1096 TEST_EQUAL( psa_get_key_usage_flags( &func ), 0 );
1097 TEST_EQUAL( psa_get_key_usage_flags( &init ), 0 );
1098 TEST_EQUAL( psa_get_key_usage_flags( &zero ), 0 );
1099
1100 TEST_EQUAL( psa_get_key_algorithm( &func ), 0 );
1101 TEST_EQUAL( psa_get_key_algorithm( &init ), 0 );
1102 TEST_EQUAL( psa_get_key_algorithm( &zero ), 0 );
Jaeden Amero70261c52019-01-04 11:47:20 +00001103}
1104/* END_CASE */
1105
1106/* BEGIN_CASE */
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001107void mac_key_policy( int policy_usage,
1108 int policy_alg,
1109 int key_type,
1110 data_t *key_data,
Steven Cooremanb3ce8152021-02-18 12:03:50 +01001111 int exercise_alg,
1112 int expected_status_arg )
Gilles Peskined5b33222018-06-18 22:20:03 +02001113{
Ronald Cron5425a212020-08-04 14:58:35 +02001114 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001115 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Jaeden Amero769ce272019-01-04 11:48:03 +00001116 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001117 psa_status_t status;
Steven Cooremanb3ce8152021-02-18 12:03:50 +01001118 psa_status_t expected_status = expected_status_arg;
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001119 unsigned char mac[PSA_MAC_MAX_SIZE];
Gilles Peskined5b33222018-06-18 22:20:03 +02001120
Gilles Peskine8817f612018-12-18 00:18:46 +01001121 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskined5b33222018-06-18 22:20:03 +02001122
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001123 psa_set_key_usage_flags( &attributes, policy_usage );
1124 psa_set_key_algorithm( &attributes, policy_alg );
1125 psa_set_key_type( &attributes, key_type );
Gilles Peskined5b33222018-06-18 22:20:03 +02001126
Gilles Peskine049c7532019-05-15 20:22:09 +02001127 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02001128 &key ) );
Gilles Peskined5b33222018-06-18 22:20:03 +02001129
Ronald Cron5425a212020-08-04 14:58:35 +02001130 status = psa_mac_sign_setup( &operation, key, exercise_alg );
Steven Cooremanb3ce8152021-02-18 12:03:50 +01001131 if( ( policy_usage & PSA_KEY_USAGE_SIGN_HASH ) == 0 )
Gilles Peskinefe11b722018-12-18 00:24:04 +01001132 TEST_EQUAL( status, PSA_ERROR_NOT_PERMITTED );
Steven Cooremanb3ce8152021-02-18 12:03:50 +01001133 else
1134 TEST_EQUAL( status, expected_status );
1135
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001136 psa_mac_abort( &operation );
Gilles Peskined5b33222018-06-18 22:20:03 +02001137
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001138 memset( mac, 0, sizeof( mac ) );
Ronald Cron5425a212020-08-04 14:58:35 +02001139 status = psa_mac_verify_setup( &operation, key, exercise_alg );
Steven Cooremanb3ce8152021-02-18 12:03:50 +01001140 if( ( policy_usage & PSA_KEY_USAGE_VERIFY_HASH ) == 0 )
Gilles Peskinefe11b722018-12-18 00:24:04 +01001141 TEST_EQUAL( status, PSA_ERROR_NOT_PERMITTED );
Steven Cooremanb3ce8152021-02-18 12:03:50 +01001142 else
1143 TEST_EQUAL( status, expected_status );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001144
1145exit:
1146 psa_mac_abort( &operation );
Ronald Cron5425a212020-08-04 14:58:35 +02001147 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02001148 PSA_DONE( );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001149}
1150/* END_CASE */
1151
1152/* BEGIN_CASE */
1153void cipher_key_policy( int policy_usage,
1154 int policy_alg,
1155 int key_type,
1156 data_t *key_data,
1157 int exercise_alg )
1158{
Ronald Cron5425a212020-08-04 14:58:35 +02001159 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001160 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Jaeden Amero5bae2272019-01-04 11:48:27 +00001161 psa_cipher_operation_t operation = PSA_CIPHER_OPERATION_INIT;
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001162 psa_status_t status;
1163
Gilles Peskine8817f612018-12-18 00:18:46 +01001164 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001165
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001166 psa_set_key_usage_flags( &attributes, policy_usage );
1167 psa_set_key_algorithm( &attributes, policy_alg );
1168 psa_set_key_type( &attributes, key_type );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001169
Gilles Peskine049c7532019-05-15 20:22:09 +02001170 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02001171 &key ) );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001172
Ronald Cron5425a212020-08-04 14:58:35 +02001173 status = psa_cipher_encrypt_setup( &operation, key, exercise_alg );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001174 if( policy_alg == exercise_alg &&
1175 ( policy_usage & PSA_KEY_USAGE_ENCRYPT ) != 0 )
Gilles Peskine8817f612018-12-18 00:18:46 +01001176 PSA_ASSERT( status );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001177 else
Gilles Peskinefe11b722018-12-18 00:24:04 +01001178 TEST_EQUAL( status, PSA_ERROR_NOT_PERMITTED );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001179 psa_cipher_abort( &operation );
1180
Ronald Cron5425a212020-08-04 14:58:35 +02001181 status = psa_cipher_decrypt_setup( &operation, key, exercise_alg );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001182 if( policy_alg == exercise_alg &&
1183 ( policy_usage & PSA_KEY_USAGE_DECRYPT ) != 0 )
Gilles Peskine8817f612018-12-18 00:18:46 +01001184 PSA_ASSERT( status );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001185 else
Gilles Peskinefe11b722018-12-18 00:24:04 +01001186 TEST_EQUAL( status, PSA_ERROR_NOT_PERMITTED );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001187
1188exit:
1189 psa_cipher_abort( &operation );
Ronald Cron5425a212020-08-04 14:58:35 +02001190 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02001191 PSA_DONE( );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001192}
1193/* END_CASE */
1194
1195/* BEGIN_CASE */
1196void aead_key_policy( int policy_usage,
1197 int policy_alg,
1198 int key_type,
1199 data_t *key_data,
1200 int nonce_length_arg,
1201 int tag_length_arg,
Steven Cooremanb3ce8152021-02-18 12:03:50 +01001202 int exercise_alg,
1203 int expected_status_arg )
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001204{
Ronald Cron5425a212020-08-04 14:58:35 +02001205 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001206 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001207 psa_status_t status;
Steven Cooremanb3ce8152021-02-18 12:03:50 +01001208 psa_status_t expected_status = expected_status_arg;
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001209 unsigned char nonce[16] = {0};
1210 size_t nonce_length = nonce_length_arg;
1211 unsigned char tag[16];
1212 size_t tag_length = tag_length_arg;
1213 size_t output_length;
1214
1215 TEST_ASSERT( nonce_length <= sizeof( nonce ) );
1216 TEST_ASSERT( tag_length <= sizeof( tag ) );
1217
Gilles Peskine8817f612018-12-18 00:18:46 +01001218 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001219
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001220 psa_set_key_usage_flags( &attributes, policy_usage );
1221 psa_set_key_algorithm( &attributes, policy_alg );
1222 psa_set_key_type( &attributes, key_type );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001223
Gilles Peskine049c7532019-05-15 20:22:09 +02001224 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02001225 &key ) );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001226
Ronald Cron5425a212020-08-04 14:58:35 +02001227 status = psa_aead_encrypt( key, exercise_alg,
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001228 nonce, nonce_length,
1229 NULL, 0,
1230 NULL, 0,
1231 tag, tag_length,
1232 &output_length );
Steven Cooremanb3ce8152021-02-18 12:03:50 +01001233 if( ( policy_usage & PSA_KEY_USAGE_ENCRYPT ) != 0 )
1234 TEST_EQUAL( status, expected_status );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001235 else
Gilles Peskinefe11b722018-12-18 00:24:04 +01001236 TEST_EQUAL( status, PSA_ERROR_NOT_PERMITTED );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001237
1238 memset( tag, 0, sizeof( tag ) );
Ronald Cron5425a212020-08-04 14:58:35 +02001239 status = psa_aead_decrypt( key, exercise_alg,
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001240 nonce, nonce_length,
1241 NULL, 0,
1242 tag, tag_length,
1243 NULL, 0,
1244 &output_length );
Steven Cooremanb3ce8152021-02-18 12:03:50 +01001245 if( ( policy_usage & PSA_KEY_USAGE_DECRYPT ) == 0 )
1246 TEST_EQUAL( status, PSA_ERROR_NOT_PERMITTED );
1247 else if( expected_status == PSA_SUCCESS )
Gilles Peskinefe11b722018-12-18 00:24:04 +01001248 TEST_EQUAL( status, PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001249 else
Steven Cooremanb3ce8152021-02-18 12:03:50 +01001250 TEST_EQUAL( status, expected_status );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001251
1252exit:
Ronald Cron5425a212020-08-04 14:58:35 +02001253 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02001254 PSA_DONE( );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001255}
1256/* END_CASE */
1257
1258/* BEGIN_CASE */
1259void asymmetric_encryption_key_policy( int policy_usage,
1260 int policy_alg,
1261 int key_type,
1262 data_t *key_data,
1263 int exercise_alg )
1264{
Ronald Cron5425a212020-08-04 14:58:35 +02001265 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001266 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001267 psa_status_t status;
1268 size_t key_bits;
1269 size_t buffer_length;
1270 unsigned char *buffer = NULL;
1271 size_t output_length;
1272
Gilles Peskine8817f612018-12-18 00:18:46 +01001273 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001274
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001275 psa_set_key_usage_flags( &attributes, policy_usage );
1276 psa_set_key_algorithm( &attributes, policy_alg );
1277 psa_set_key_type( &attributes, key_type );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001278
Gilles Peskine049c7532019-05-15 20:22:09 +02001279 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02001280 &key ) );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001281
Ronald Cron5425a212020-08-04 14:58:35 +02001282 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001283 key_bits = psa_get_key_bits( &attributes );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001284 buffer_length = PSA_ASYMMETRIC_ENCRYPT_OUTPUT_SIZE( key_type, key_bits,
1285 exercise_alg );
Gilles Peskine8cebbba2018-09-27 13:54:18 +02001286 ASSERT_ALLOC( buffer, buffer_length );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001287
Ronald Cron5425a212020-08-04 14:58:35 +02001288 status = psa_asymmetric_encrypt( key, exercise_alg,
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001289 NULL, 0,
1290 NULL, 0,
1291 buffer, buffer_length,
1292 &output_length );
1293 if( policy_alg == exercise_alg &&
1294 ( policy_usage & PSA_KEY_USAGE_ENCRYPT ) != 0 )
Gilles Peskine8817f612018-12-18 00:18:46 +01001295 PSA_ASSERT( status );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001296 else
Gilles Peskinefe11b722018-12-18 00:24:04 +01001297 TEST_EQUAL( status, PSA_ERROR_NOT_PERMITTED );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001298
Gilles Peskinef7ab5ad2018-09-26 18:19:24 +02001299 if( buffer_length != 0 )
1300 memset( buffer, 0, buffer_length );
Ronald Cron5425a212020-08-04 14:58:35 +02001301 status = psa_asymmetric_decrypt( key, exercise_alg,
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001302 buffer, buffer_length,
1303 NULL, 0,
1304 buffer, buffer_length,
1305 &output_length );
1306 if( policy_alg == exercise_alg &&
1307 ( policy_usage & PSA_KEY_USAGE_DECRYPT ) != 0 )
Gilles Peskinefe11b722018-12-18 00:24:04 +01001308 TEST_EQUAL( status, PSA_ERROR_INVALID_PADDING );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001309 else
Gilles Peskinefe11b722018-12-18 00:24:04 +01001310 TEST_EQUAL( status, PSA_ERROR_NOT_PERMITTED );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001311
1312exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +01001313 /*
1314 * Key attributes may have been returned by psa_get_key_attributes()
1315 * thus reset them as required.
1316 */
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02001317 psa_reset_key_attributes( &attributes );
Ronald Cron3a4f0e32020-11-19 17:55:23 +01001318
1319 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02001320 PSA_DONE( );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001321 mbedtls_free( buffer );
1322}
1323/* END_CASE */
1324
1325/* BEGIN_CASE */
1326void asymmetric_signature_key_policy( int policy_usage,
1327 int policy_alg,
1328 int key_type,
1329 data_t *key_data,
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001330 int exercise_alg,
1331 int payload_length_arg )
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001332{
Ronald Cron5425a212020-08-04 14:58:35 +02001333 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001334 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001335 psa_status_t status;
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001336 unsigned char payload[PSA_HASH_MAX_SIZE] = {1};
1337 /* If `payload_length_arg > 0`, `exercise_alg` is supposed to be
1338 * compatible with the policy and `payload_length_arg` is supposed to be
1339 * a valid input length to sign. If `payload_length_arg <= 0`,
1340 * `exercise_alg` is supposed to be forbidden by the policy. */
1341 int compatible_alg = payload_length_arg > 0;
1342 size_t payload_length = compatible_alg ? payload_length_arg : 0;
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001343 unsigned char signature[PSA_SIGNATURE_MAX_SIZE] = {0};
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001344 size_t signature_length;
1345
Gilles Peskine8817f612018-12-18 00:18:46 +01001346 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001347
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001348 psa_set_key_usage_flags( &attributes, policy_usage );
1349 psa_set_key_algorithm( &attributes, policy_alg );
1350 psa_set_key_type( &attributes, key_type );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001351
Gilles Peskine049c7532019-05-15 20:22:09 +02001352 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02001353 &key ) );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001354
Ronald Cron5425a212020-08-04 14:58:35 +02001355 status = psa_sign_hash( key, exercise_alg,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001356 payload, payload_length,
1357 signature, sizeof( signature ),
1358 &signature_length );
1359 if( compatible_alg && ( policy_usage & PSA_KEY_USAGE_SIGN_HASH ) != 0 )
Gilles Peskine8817f612018-12-18 00:18:46 +01001360 PSA_ASSERT( status );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001361 else
Gilles Peskinefe11b722018-12-18 00:24:04 +01001362 TEST_EQUAL( status, PSA_ERROR_NOT_PERMITTED );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001363
1364 memset( signature, 0, sizeof( signature ) );
Ronald Cron5425a212020-08-04 14:58:35 +02001365 status = psa_verify_hash( key, exercise_alg,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001366 payload, payload_length,
1367 signature, sizeof( signature ) );
1368 if( compatible_alg && ( policy_usage & PSA_KEY_USAGE_VERIFY_HASH ) != 0 )
Gilles Peskinefe11b722018-12-18 00:24:04 +01001369 TEST_EQUAL( status, PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001370 else
Gilles Peskinefe11b722018-12-18 00:24:04 +01001371 TEST_EQUAL( status, PSA_ERROR_NOT_PERMITTED );
Gilles Peskined5b33222018-06-18 22:20:03 +02001372
1373exit:
Ronald Cron5425a212020-08-04 14:58:35 +02001374 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02001375 PSA_DONE( );
Gilles Peskined5b33222018-06-18 22:20:03 +02001376}
1377/* END_CASE */
1378
Janos Follathba3fab92019-06-11 14:50:16 +01001379/* BEGIN_CASE */
Gilles Peskineea0fb492018-07-12 17:17:20 +02001380void derive_key_policy( int policy_usage,
1381 int policy_alg,
1382 int key_type,
1383 data_t *key_data,
1384 int exercise_alg )
1385{
Ronald Cron5425a212020-08-04 14:58:35 +02001386 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001387 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02001388 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Gilles Peskineea0fb492018-07-12 17:17:20 +02001389 psa_status_t status;
1390
Gilles Peskine8817f612018-12-18 00:18:46 +01001391 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskineea0fb492018-07-12 17:17:20 +02001392
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001393 psa_set_key_usage_flags( &attributes, policy_usage );
1394 psa_set_key_algorithm( &attributes, policy_alg );
1395 psa_set_key_type( &attributes, key_type );
Gilles Peskineea0fb492018-07-12 17:17:20 +02001396
Gilles Peskine049c7532019-05-15 20:22:09 +02001397 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02001398 &key ) );
Gilles Peskineea0fb492018-07-12 17:17:20 +02001399
Janos Follathba3fab92019-06-11 14:50:16 +01001400 PSA_ASSERT( psa_key_derivation_setup( &operation, exercise_alg ) );
1401
1402 if( PSA_ALG_IS_TLS12_PRF( exercise_alg ) ||
1403 PSA_ALG_IS_TLS12_PSK_TO_MS( exercise_alg ) )
Janos Follath0c1ed842019-06-28 13:35:36 +01001404 {
Janos Follathba3fab92019-06-11 14:50:16 +01001405 PSA_ASSERT( psa_key_derivation_input_bytes(
1406 &operation,
1407 PSA_KEY_DERIVATION_INPUT_SEED,
1408 (const uint8_t*) "", 0) );
Janos Follath0c1ed842019-06-28 13:35:36 +01001409 }
Janos Follathba3fab92019-06-11 14:50:16 +01001410
1411 status = psa_key_derivation_input_key( &operation,
1412 PSA_KEY_DERIVATION_INPUT_SECRET,
Ronald Cron5425a212020-08-04 14:58:35 +02001413 key );
Janos Follathba3fab92019-06-11 14:50:16 +01001414
Gilles Peskineea0fb492018-07-12 17:17:20 +02001415 if( policy_alg == exercise_alg &&
1416 ( policy_usage & PSA_KEY_USAGE_DERIVE ) != 0 )
Gilles Peskine8817f612018-12-18 00:18:46 +01001417 PSA_ASSERT( status );
Gilles Peskineea0fb492018-07-12 17:17:20 +02001418 else
Gilles Peskinefe11b722018-12-18 00:24:04 +01001419 TEST_EQUAL( status, PSA_ERROR_NOT_PERMITTED );
Gilles Peskineea0fb492018-07-12 17:17:20 +02001420
1421exit:
Gilles Peskine51ae0e42019-05-16 17:31:03 +02001422 psa_key_derivation_abort( &operation );
Ronald Cron5425a212020-08-04 14:58:35 +02001423 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02001424 PSA_DONE( );
Gilles Peskineea0fb492018-07-12 17:17:20 +02001425}
1426/* END_CASE */
1427
1428/* BEGIN_CASE */
Gilles Peskine01d718c2018-09-18 12:01:02 +02001429void agreement_key_policy( int policy_usage,
1430 int policy_alg,
1431 int key_type_arg,
1432 data_t *key_data,
Steven Cooremance48e852020-10-05 16:02:45 +02001433 int exercise_alg,
1434 int expected_status_arg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02001435{
Ronald Cron5425a212020-08-04 14:58:35 +02001436 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001437 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine01d718c2018-09-18 12:01:02 +02001438 psa_key_type_t key_type = key_type_arg;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02001439 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Gilles Peskine01d718c2018-09-18 12:01:02 +02001440 psa_status_t status;
Steven Cooremance48e852020-10-05 16:02:45 +02001441 psa_status_t expected_status = expected_status_arg;
Gilles Peskine01d718c2018-09-18 12:01:02 +02001442
Gilles Peskine8817f612018-12-18 00:18:46 +01001443 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine01d718c2018-09-18 12:01:02 +02001444
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001445 psa_set_key_usage_flags( &attributes, policy_usage );
1446 psa_set_key_algorithm( &attributes, policy_alg );
1447 psa_set_key_type( &attributes, key_type );
Gilles Peskine01d718c2018-09-18 12:01:02 +02001448
Gilles Peskine049c7532019-05-15 20:22:09 +02001449 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02001450 &key ) );
Gilles Peskine01d718c2018-09-18 12:01:02 +02001451
Gilles Peskine51ae0e42019-05-16 17:31:03 +02001452 PSA_ASSERT( psa_key_derivation_setup( &operation, exercise_alg ) );
Gilles Peskinec18e25f2021-02-12 23:48:20 +01001453 status = mbedtls_test_psa_key_agreement_with_self( &operation, key );
Gilles Peskine01d718c2018-09-18 12:01:02 +02001454
Steven Cooremance48e852020-10-05 16:02:45 +02001455 TEST_EQUAL( status, expected_status );
Gilles Peskine01d718c2018-09-18 12:01:02 +02001456
1457exit:
Gilles Peskine51ae0e42019-05-16 17:31:03 +02001458 psa_key_derivation_abort( &operation );
Ronald Cron5425a212020-08-04 14:58:35 +02001459 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02001460 PSA_DONE( );
Gilles Peskine01d718c2018-09-18 12:01:02 +02001461}
1462/* END_CASE */
1463
1464/* BEGIN_CASE */
Gilles Peskine96f0b3b2019-05-10 19:33:38 +02001465void key_policy_alg2( int key_type_arg, data_t *key_data,
1466 int usage_arg, int alg_arg, int alg2_arg )
1467{
Ronald Cron5425a212020-08-04 14:58:35 +02001468 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine96f0b3b2019-05-10 19:33:38 +02001469 psa_key_type_t key_type = key_type_arg;
1470 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
1471 psa_key_attributes_t got_attributes = PSA_KEY_ATTRIBUTES_INIT;
1472 psa_key_usage_t usage = usage_arg;
1473 psa_algorithm_t alg = alg_arg;
1474 psa_algorithm_t alg2 = alg2_arg;
1475
1476 PSA_ASSERT( psa_crypto_init( ) );
1477
1478 psa_set_key_usage_flags( &attributes, usage );
1479 psa_set_key_algorithm( &attributes, alg );
1480 psa_set_key_enrollment_algorithm( &attributes, alg2 );
1481 psa_set_key_type( &attributes, key_type );
1482 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02001483 &key ) );
Gilles Peskine96f0b3b2019-05-10 19:33:38 +02001484
Ronald Cron5425a212020-08-04 14:58:35 +02001485 PSA_ASSERT( psa_get_key_attributes( key, &got_attributes ) );
Gilles Peskine96f0b3b2019-05-10 19:33:38 +02001486 TEST_EQUAL( psa_get_key_usage_flags( &got_attributes ), usage );
1487 TEST_EQUAL( psa_get_key_algorithm( &got_attributes ), alg );
1488 TEST_EQUAL( psa_get_key_enrollment_algorithm( &got_attributes ), alg2 );
1489
Gilles Peskinec18e25f2021-02-12 23:48:20 +01001490 if( ! mbedtls_test_psa_exercise_key( key, usage, alg ) )
Gilles Peskine96f0b3b2019-05-10 19:33:38 +02001491 goto exit;
Gilles Peskinec18e25f2021-02-12 23:48:20 +01001492 if( ! mbedtls_test_psa_exercise_key( key, usage, alg2 ) )
Gilles Peskine96f0b3b2019-05-10 19:33:38 +02001493 goto exit;
1494
1495exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +01001496 /*
1497 * Key attributes may have been returned by psa_get_key_attributes()
1498 * thus reset them as required.
1499 */
1500 psa_reset_key_attributes( &got_attributes );
1501
Ronald Cron5425a212020-08-04 14:58:35 +02001502 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02001503 PSA_DONE( );
Gilles Peskine96f0b3b2019-05-10 19:33:38 +02001504}
1505/* END_CASE */
1506
1507/* BEGIN_CASE */
Gilles Peskine04ee2d22019-04-11 21:25:46 +02001508void raw_agreement_key_policy( int policy_usage,
1509 int policy_alg,
1510 int key_type_arg,
1511 data_t *key_data,
Steven Cooremance48e852020-10-05 16:02:45 +02001512 int exercise_alg,
1513 int expected_status_arg )
Gilles Peskine04ee2d22019-04-11 21:25:46 +02001514{
Ronald Cron5425a212020-08-04 14:58:35 +02001515 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001516 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine04ee2d22019-04-11 21:25:46 +02001517 psa_key_type_t key_type = key_type_arg;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02001518 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Gilles Peskine04ee2d22019-04-11 21:25:46 +02001519 psa_status_t status;
Steven Cooremance48e852020-10-05 16:02:45 +02001520 psa_status_t expected_status = expected_status_arg;
Gilles Peskine04ee2d22019-04-11 21:25:46 +02001521
1522 PSA_ASSERT( psa_crypto_init( ) );
1523
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001524 psa_set_key_usage_flags( &attributes, policy_usage );
1525 psa_set_key_algorithm( &attributes, policy_alg );
1526 psa_set_key_type( &attributes, key_type );
Gilles Peskine04ee2d22019-04-11 21:25:46 +02001527
Gilles Peskine049c7532019-05-15 20:22:09 +02001528 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02001529 &key ) );
Gilles Peskine04ee2d22019-04-11 21:25:46 +02001530
Gilles Peskinec18e25f2021-02-12 23:48:20 +01001531 status = mbedtls_test_psa_raw_key_agreement_with_self( exercise_alg, key );
Gilles Peskine04ee2d22019-04-11 21:25:46 +02001532
Steven Cooremance48e852020-10-05 16:02:45 +02001533 TEST_EQUAL( status, expected_status );
Gilles Peskine04ee2d22019-04-11 21:25:46 +02001534
1535exit:
Gilles Peskine51ae0e42019-05-16 17:31:03 +02001536 psa_key_derivation_abort( &operation );
Ronald Cron5425a212020-08-04 14:58:35 +02001537 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02001538 PSA_DONE( );
Gilles Peskine04ee2d22019-04-11 21:25:46 +02001539}
1540/* END_CASE */
1541
1542/* BEGIN_CASE */
Gilles Peskinebcdd44b2019-05-20 17:28:11 +02001543void copy_success( int source_usage_arg,
1544 int source_alg_arg, int source_alg2_arg,
Gilles Peskine4a644642019-05-03 17:14:08 +02001545 int type_arg, data_t *material,
1546 int copy_attributes,
Gilles Peskinebcdd44b2019-05-20 17:28:11 +02001547 int target_usage_arg,
1548 int target_alg_arg, int target_alg2_arg,
1549 int expected_usage_arg,
1550 int expected_alg_arg, int expected_alg2_arg )
Gilles Peskine57ab7212019-01-28 13:03:09 +01001551{
Gilles Peskineca25db92019-04-19 11:43:08 +02001552 psa_key_attributes_t source_attributes = PSA_KEY_ATTRIBUTES_INIT;
1553 psa_key_attributes_t target_attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine57ab7212019-01-28 13:03:09 +01001554 psa_key_usage_t expected_usage = expected_usage_arg;
1555 psa_algorithm_t expected_alg = expected_alg_arg;
Gilles Peskinebcdd44b2019-05-20 17:28:11 +02001556 psa_algorithm_t expected_alg2 = expected_alg2_arg;
Ronald Cron5425a212020-08-04 14:58:35 +02001557 mbedtls_svc_key_id_t source_key = MBEDTLS_SVC_KEY_ID_INIT;
1558 mbedtls_svc_key_id_t target_key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine57ab7212019-01-28 13:03:09 +01001559 uint8_t *export_buffer = NULL;
1560
Gilles Peskine57ab7212019-01-28 13:03:09 +01001561 PSA_ASSERT( psa_crypto_init( ) );
1562
Gilles Peskineca25db92019-04-19 11:43:08 +02001563 /* Prepare the source key. */
1564 psa_set_key_usage_flags( &source_attributes, source_usage_arg );
1565 psa_set_key_algorithm( &source_attributes, source_alg_arg );
Gilles Peskinebcdd44b2019-05-20 17:28:11 +02001566 psa_set_key_enrollment_algorithm( &source_attributes, source_alg2_arg );
Gilles Peskineca25db92019-04-19 11:43:08 +02001567 psa_set_key_type( &source_attributes, type_arg );
Gilles Peskine049c7532019-05-15 20:22:09 +02001568 PSA_ASSERT( psa_import_key( &source_attributes,
1569 material->x, material->len,
Ronald Cron5425a212020-08-04 14:58:35 +02001570 &source_key ) );
1571 PSA_ASSERT( psa_get_key_attributes( source_key, &source_attributes ) );
Gilles Peskine57ab7212019-01-28 13:03:09 +01001572
Gilles Peskineca25db92019-04-19 11:43:08 +02001573 /* Prepare the target attributes. */
1574 if( copy_attributes )
Ronald Cron65f38a32020-10-23 17:11:13 +02001575 {
Gilles Peskineca25db92019-04-19 11:43:08 +02001576 target_attributes = source_attributes;
Ronald Cron65f38a32020-10-23 17:11:13 +02001577 /* Set volatile lifetime to reset the key identifier to 0. */
1578 psa_set_key_lifetime( &target_attributes, PSA_KEY_LIFETIME_VOLATILE );
1579 }
1580
Gilles Peskineca25db92019-04-19 11:43:08 +02001581 if( target_usage_arg != -1 )
1582 psa_set_key_usage_flags( &target_attributes, target_usage_arg );
1583 if( target_alg_arg != -1 )
1584 psa_set_key_algorithm( &target_attributes, target_alg_arg );
Gilles Peskinebcdd44b2019-05-20 17:28:11 +02001585 if( target_alg2_arg != -1 )
1586 psa_set_key_enrollment_algorithm( &target_attributes, target_alg2_arg );
Gilles Peskine57ab7212019-01-28 13:03:09 +01001587
1588 /* Copy the key. */
Ronald Cron5425a212020-08-04 14:58:35 +02001589 PSA_ASSERT( psa_copy_key( source_key,
1590 &target_attributes, &target_key ) );
Gilles Peskine57ab7212019-01-28 13:03:09 +01001591
1592 /* Destroy the source to ensure that this doesn't affect the target. */
Ronald Cron5425a212020-08-04 14:58:35 +02001593 PSA_ASSERT( psa_destroy_key( source_key ) );
Gilles Peskine57ab7212019-01-28 13:03:09 +01001594
1595 /* Test that the target slot has the expected content and policy. */
Ronald Cron5425a212020-08-04 14:58:35 +02001596 PSA_ASSERT( psa_get_key_attributes( target_key, &target_attributes ) );
Gilles Peskineca25db92019-04-19 11:43:08 +02001597 TEST_EQUAL( psa_get_key_type( &source_attributes ),
1598 psa_get_key_type( &target_attributes ) );
1599 TEST_EQUAL( psa_get_key_bits( &source_attributes ),
1600 psa_get_key_bits( &target_attributes ) );
1601 TEST_EQUAL( expected_usage, psa_get_key_usage_flags( &target_attributes ) );
1602 TEST_EQUAL( expected_alg, psa_get_key_algorithm( &target_attributes ) );
Gilles Peskinebcdd44b2019-05-20 17:28:11 +02001603 TEST_EQUAL( expected_alg2,
1604 psa_get_key_enrollment_algorithm( &target_attributes ) );
Gilles Peskine57ab7212019-01-28 13:03:09 +01001605 if( expected_usage & PSA_KEY_USAGE_EXPORT )
1606 {
1607 size_t length;
1608 ASSERT_ALLOC( export_buffer, material->len );
Ronald Cron5425a212020-08-04 14:58:35 +02001609 PSA_ASSERT( psa_export_key( target_key, export_buffer,
Gilles Peskine57ab7212019-01-28 13:03:09 +01001610 material->len, &length ) );
1611 ASSERT_COMPARE( material->x, material->len,
1612 export_buffer, length );
1613 }
Steven Cooremanb3ce8152021-02-18 12:03:50 +01001614
Gilles Peskinec18e25f2021-02-12 23:48:20 +01001615 if( ! mbedtls_test_psa_exercise_key( target_key, expected_usage, expected_alg ) )
Gilles Peskine57ab7212019-01-28 13:03:09 +01001616 goto exit;
Gilles Peskinec18e25f2021-02-12 23:48:20 +01001617 if( ! mbedtls_test_psa_exercise_key( target_key, expected_usage, expected_alg2 ) )
Gilles Peskinebcdd44b2019-05-20 17:28:11 +02001618 goto exit;
Gilles Peskine57ab7212019-01-28 13:03:09 +01001619
Ronald Cron5425a212020-08-04 14:58:35 +02001620 PSA_ASSERT( psa_destroy_key( target_key ) );
Gilles Peskine57ab7212019-01-28 13:03:09 +01001621
1622exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +01001623 /*
1624 * Source and target key attributes may have been returned by
1625 * psa_get_key_attributes() thus reset them as required.
1626 */
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02001627 psa_reset_key_attributes( &source_attributes );
1628 psa_reset_key_attributes( &target_attributes );
Ronald Cron3a4f0e32020-11-19 17:55:23 +01001629
Gilles Peskine1153e7b2019-05-28 15:10:21 +02001630 PSA_DONE( );
Gilles Peskine57ab7212019-01-28 13:03:09 +01001631 mbedtls_free( export_buffer );
1632}
1633/* END_CASE */
1634
1635/* BEGIN_CASE */
Gilles Peskinebcdd44b2019-05-20 17:28:11 +02001636void copy_fail( int source_usage_arg,
1637 int source_alg_arg, int source_alg2_arg,
Gilles Peskine4a644642019-05-03 17:14:08 +02001638 int type_arg, data_t *material,
1639 int target_type_arg, int target_bits_arg,
Gilles Peskinebcdd44b2019-05-20 17:28:11 +02001640 int target_usage_arg,
1641 int target_alg_arg, int target_alg2_arg,
Ronald Cron88a55462021-03-31 09:39:07 +02001642 int target_id_arg, int target_lifetime_arg,
Gilles Peskine4a644642019-05-03 17:14:08 +02001643 int expected_status_arg )
1644{
1645 psa_key_attributes_t source_attributes = PSA_KEY_ATTRIBUTES_INIT;
1646 psa_key_attributes_t target_attributes = PSA_KEY_ATTRIBUTES_INIT;
Ronald Cron5425a212020-08-04 14:58:35 +02001647 mbedtls_svc_key_id_t source_key = MBEDTLS_SVC_KEY_ID_INIT;
1648 mbedtls_svc_key_id_t target_key = MBEDTLS_SVC_KEY_ID_INIT;
Ronald Cron88a55462021-03-31 09:39:07 +02001649 mbedtls_svc_key_id_t key_id = mbedtls_svc_key_id_make( 1, target_id_arg );
Gilles Peskine4a644642019-05-03 17:14:08 +02001650
1651 PSA_ASSERT( psa_crypto_init( ) );
1652
1653 /* Prepare the source key. */
1654 psa_set_key_usage_flags( &source_attributes, source_usage_arg );
1655 psa_set_key_algorithm( &source_attributes, source_alg_arg );
Gilles Peskinebcdd44b2019-05-20 17:28:11 +02001656 psa_set_key_enrollment_algorithm( &source_attributes, source_alg2_arg );
Gilles Peskine4a644642019-05-03 17:14:08 +02001657 psa_set_key_type( &source_attributes, type_arg );
Gilles Peskine049c7532019-05-15 20:22:09 +02001658 PSA_ASSERT( psa_import_key( &source_attributes,
1659 material->x, material->len,
Ronald Cron5425a212020-08-04 14:58:35 +02001660 &source_key ) );
Gilles Peskine4a644642019-05-03 17:14:08 +02001661
1662 /* Prepare the target attributes. */
Ronald Cron88a55462021-03-31 09:39:07 +02001663 psa_set_key_id( &target_attributes, key_id );
1664 psa_set_key_lifetime( &target_attributes, target_lifetime_arg );
Gilles Peskine4a644642019-05-03 17:14:08 +02001665 psa_set_key_type( &target_attributes, target_type_arg );
1666 psa_set_key_bits( &target_attributes, target_bits_arg );
1667 psa_set_key_usage_flags( &target_attributes, target_usage_arg );
1668 psa_set_key_algorithm( &target_attributes, target_alg_arg );
Gilles Peskinebcdd44b2019-05-20 17:28:11 +02001669 psa_set_key_enrollment_algorithm( &target_attributes, target_alg2_arg );
Gilles Peskine4a644642019-05-03 17:14:08 +02001670
1671 /* Try to copy the key. */
Ronald Cron5425a212020-08-04 14:58:35 +02001672 TEST_EQUAL( psa_copy_key( source_key,
1673 &target_attributes, &target_key ),
Gilles Peskine4a644642019-05-03 17:14:08 +02001674 expected_status_arg );
Gilles Peskine76b29a72019-05-28 14:08:50 +02001675
Ronald Cron5425a212020-08-04 14:58:35 +02001676 PSA_ASSERT( psa_destroy_key( source_key ) );
Gilles Peskine76b29a72019-05-28 14:08:50 +02001677
Gilles Peskine4a644642019-05-03 17:14:08 +02001678exit:
1679 psa_reset_key_attributes( &source_attributes );
1680 psa_reset_key_attributes( &target_attributes );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02001681 PSA_DONE( );
Gilles Peskine4a644642019-05-03 17:14:08 +02001682}
1683/* END_CASE */
1684
1685/* BEGIN_CASE */
Jaeden Amero6a25b412019-01-04 11:47:44 +00001686void hash_operation_init( )
1687{
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00001688 const uint8_t input[1] = { 0 };
Jaeden Amero6a25b412019-01-04 11:47:44 +00001689 /* Test each valid way of initializing the object, except for `= {0}`, as
1690 * Clang 5 complains when `-Wmissing-field-initializers` is used, even
1691 * though it's OK by the C standard. We could test for this, but we'd need
1692 * to supress the Clang warning for the test. */
1693 psa_hash_operation_t func = psa_hash_operation_init( );
1694 psa_hash_operation_t init = PSA_HASH_OPERATION_INIT;
1695 psa_hash_operation_t zero;
1696
1697 memset( &zero, 0, sizeof( zero ) );
1698
Jaeden Amero11aa7ee2019-02-19 11:44:55 +00001699 /* A freshly-initialized hash operation should not be usable. */
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00001700 TEST_EQUAL( psa_hash_update( &func, input, sizeof( input ) ),
1701 PSA_ERROR_BAD_STATE );
1702 TEST_EQUAL( psa_hash_update( &init, input, sizeof( input ) ),
1703 PSA_ERROR_BAD_STATE );
1704 TEST_EQUAL( psa_hash_update( &zero, input, sizeof( input ) ),
1705 PSA_ERROR_BAD_STATE );
1706
Jaeden Amero5229bbb2019-02-07 16:33:37 +00001707 /* A default hash operation should be abortable without error. */
1708 PSA_ASSERT( psa_hash_abort( &func ) );
1709 PSA_ASSERT( psa_hash_abort( &init ) );
1710 PSA_ASSERT( psa_hash_abort( &zero ) );
Jaeden Amero6a25b412019-01-04 11:47:44 +00001711}
1712/* END_CASE */
1713
1714/* BEGIN_CASE */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02001715void hash_setup( int alg_arg,
1716 int expected_status_arg )
1717{
1718 psa_algorithm_t alg = alg_arg;
Gilles Peskineb866e2b2018-06-21 09:25:10 +02001719 psa_status_t expected_status = expected_status_arg;
Jaeden Amero6a25b412019-01-04 11:47:44 +00001720 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02001721 psa_status_t status;
1722
Gilles Peskine8817f612018-12-18 00:18:46 +01001723 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02001724
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02001725 status = psa_hash_setup( &operation, alg );
Gilles Peskinefe11b722018-12-18 00:24:04 +01001726 TEST_EQUAL( status, expected_status );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02001727
Gilles Peskine9e0a4a52019-02-25 22:11:18 +01001728 /* Whether setup succeeded or failed, abort must succeed. */
1729 PSA_ASSERT( psa_hash_abort( &operation ) );
1730
1731 /* If setup failed, reproduce the failure, so as to
1732 * test the resulting state of the operation object. */
1733 if( status != PSA_SUCCESS )
1734 TEST_EQUAL( psa_hash_setup( &operation, alg ), status );
1735
Gilles Peskinef426e0f2019-02-25 17:42:03 +01001736 /* Now the operation object should be reusable. */
1737#if defined(KNOWN_SUPPORTED_HASH_ALG)
1738 PSA_ASSERT( psa_hash_setup( &operation, KNOWN_SUPPORTED_HASH_ALG ) );
1739 PSA_ASSERT( psa_hash_abort( &operation ) );
1740#endif
1741
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02001742exit:
Gilles Peskine1153e7b2019-05-28 15:10:21 +02001743 PSA_DONE( );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02001744}
1745/* END_CASE */
1746
1747/* BEGIN_CASE */
Gilles Peskine0a749c82019-11-28 19:33:58 +01001748void hash_compute_fail( int alg_arg, data_t *input,
1749 int output_size_arg, int expected_status_arg )
1750{
1751 psa_algorithm_t alg = alg_arg;
1752 uint8_t *output = NULL;
1753 size_t output_size = output_size_arg;
1754 size_t output_length = INVALID_EXPORT_LENGTH;
1755 psa_status_t expected_status = expected_status_arg;
1756 psa_status_t status;
1757
1758 ASSERT_ALLOC( output, output_size );
1759
1760 PSA_ASSERT( psa_crypto_init( ) );
1761
1762 status = psa_hash_compute( alg, input->x, input->len,
1763 output, output_size, &output_length );
1764 TEST_EQUAL( status, expected_status );
1765 TEST_ASSERT( output_length <= output_size );
1766
1767exit:
1768 mbedtls_free( output );
1769 PSA_DONE( );
1770}
1771/* END_CASE */
1772
1773/* BEGIN_CASE */
Gilles Peskine88e08462020-01-28 20:43:00 +01001774void hash_compare_fail( int alg_arg, data_t *input,
1775 data_t *reference_hash,
1776 int expected_status_arg )
1777{
1778 psa_algorithm_t alg = alg_arg;
1779 psa_status_t expected_status = expected_status_arg;
1780 psa_status_t status;
1781
1782 PSA_ASSERT( psa_crypto_init( ) );
1783
1784 status = psa_hash_compare( alg, input->x, input->len,
1785 reference_hash->x, reference_hash->len );
1786 TEST_EQUAL( status, expected_status );
1787
1788exit:
1789 PSA_DONE( );
1790}
1791/* END_CASE */
1792
1793/* BEGIN_CASE */
Gilles Peskine0a749c82019-11-28 19:33:58 +01001794void hash_compute_compare( int alg_arg, data_t *input,
1795 data_t *expected_output )
1796{
1797 psa_algorithm_t alg = alg_arg;
1798 uint8_t output[PSA_HASH_MAX_SIZE + 1];
1799 size_t output_length = INVALID_EXPORT_LENGTH;
1800 size_t i;
1801
1802 PSA_ASSERT( psa_crypto_init( ) );
1803
1804 /* Compute with tight buffer */
1805 PSA_ASSERT( psa_hash_compute( alg, input->x, input->len,
gabor-mezei-armcbcec212020-12-18 14:23:51 +01001806 output, PSA_HASH_LENGTH( alg ),
Gilles Peskine0a749c82019-11-28 19:33:58 +01001807 &output_length ) );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01001808 TEST_EQUAL( output_length, PSA_HASH_LENGTH( alg ) );
Gilles Peskine0a749c82019-11-28 19:33:58 +01001809 ASSERT_COMPARE( output, output_length,
1810 expected_output->x, expected_output->len );
1811
1812 /* Compute with larger buffer */
1813 PSA_ASSERT( psa_hash_compute( alg, input->x, input->len,
1814 output, sizeof( output ),
1815 &output_length ) );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01001816 TEST_EQUAL( output_length, PSA_HASH_LENGTH( alg ) );
Gilles Peskine0a749c82019-11-28 19:33:58 +01001817 ASSERT_COMPARE( output, output_length,
1818 expected_output->x, expected_output->len );
1819
1820 /* Compare with correct hash */
1821 PSA_ASSERT( psa_hash_compare( alg, input->x, input->len,
1822 output, output_length ) );
1823
1824 /* Compare with trailing garbage */
1825 TEST_EQUAL( psa_hash_compare( alg, input->x, input->len,
1826 output, output_length + 1 ),
1827 PSA_ERROR_INVALID_SIGNATURE );
1828
1829 /* Compare with truncated hash */
1830 TEST_EQUAL( psa_hash_compare( alg, input->x, input->len,
1831 output, output_length - 1 ),
1832 PSA_ERROR_INVALID_SIGNATURE );
1833
1834 /* Compare with corrupted value */
1835 for( i = 0; i < output_length; i++ )
1836 {
Chris Jones9634bb12021-01-20 15:56:42 +00001837 mbedtls_test_set_step( i );
Gilles Peskine0a749c82019-11-28 19:33:58 +01001838 output[i] ^= 1;
1839 TEST_EQUAL( psa_hash_compare( alg, input->x, input->len,
1840 output, output_length ),
1841 PSA_ERROR_INVALID_SIGNATURE );
1842 output[i] ^= 1;
1843 }
1844
1845exit:
1846 PSA_DONE( );
1847}
1848/* END_CASE */
1849
Gilles Peskined6dc40c2021-01-12 12:55:31 +01001850/* BEGIN_CASE depends_on:PSA_WANT_ALG_SHA_256 */
itayzafrirf86548d2018-11-01 10:44:32 +02001851void hash_bad_order( )
1852{
Jaeden Amero11aa7ee2019-02-19 11:44:55 +00001853 psa_algorithm_t alg = PSA_ALG_SHA_256;
itayzafrirf86548d2018-11-01 10:44:32 +02001854 unsigned char input[] = "";
1855 /* SHA-256 hash of an empty string */
Jaeden Amero11aa7ee2019-02-19 11:44:55 +00001856 const unsigned char valid_hash[] = {
itayzafrirf86548d2018-11-01 10:44:32 +02001857 0xe3, 0xb0, 0xc4, 0x42, 0x98, 0xfc, 0x1c, 0x14, 0x9a, 0xfb, 0xf4, 0xc8,
1858 0x99, 0x6f, 0xb9, 0x24, 0x27, 0xae, 0x41, 0xe4, 0x64, 0x9b, 0x93, 0x4c,
1859 0xa4, 0x95, 0x99, 0x1b, 0x78, 0x52, 0xb8, 0x55 };
Jaeden Amero11aa7ee2019-02-19 11:44:55 +00001860 unsigned char hash[sizeof(valid_hash)] = { 0 };
itayzafrirf86548d2018-11-01 10:44:32 +02001861 size_t hash_len;
Jaeden Amero6a25b412019-01-04 11:47:44 +00001862 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
itayzafrirf86548d2018-11-01 10:44:32 +02001863
Gilles Peskine8817f612018-12-18 00:18:46 +01001864 PSA_ASSERT( psa_crypto_init( ) );
itayzafrirf86548d2018-11-01 10:44:32 +02001865
Jaeden Amero36ee5d02019-02-19 09:25:10 +00001866 /* Call setup twice in a row. */
1867 PSA_ASSERT( psa_hash_setup( &operation, alg ) );
1868 TEST_EQUAL( psa_hash_setup( &operation, alg ),
1869 PSA_ERROR_BAD_STATE );
1870 PSA_ASSERT( psa_hash_abort( &operation ) );
1871
Jaeden Amero11aa7ee2019-02-19 11:44:55 +00001872 /* Call update without calling setup beforehand. */
Gilles Peskinef812dcf2018-12-18 00:33:25 +01001873 TEST_EQUAL( psa_hash_update( &operation, input, sizeof( input ) ),
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00001874 PSA_ERROR_BAD_STATE );
Jaeden Amero11aa7ee2019-02-19 11:44:55 +00001875 PSA_ASSERT( psa_hash_abort( &operation ) );
itayzafrirf86548d2018-11-01 10:44:32 +02001876
Jaeden Amero11aa7ee2019-02-19 11:44:55 +00001877 /* Call update after finish. */
1878 PSA_ASSERT( psa_hash_setup( &operation, alg ) );
1879 PSA_ASSERT( psa_hash_finish( &operation,
1880 hash, sizeof( hash ), &hash_len ) );
1881 TEST_EQUAL( psa_hash_update( &operation, input, sizeof( input ) ),
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00001882 PSA_ERROR_BAD_STATE );
Jaeden Amero11aa7ee2019-02-19 11:44:55 +00001883 PSA_ASSERT( psa_hash_abort( &operation ) );
itayzafrirf86548d2018-11-01 10:44:32 +02001884
Jaeden Amero11aa7ee2019-02-19 11:44:55 +00001885 /* Call verify without calling setup beforehand. */
1886 TEST_EQUAL( psa_hash_verify( &operation,
1887 valid_hash, sizeof( valid_hash ) ),
1888 PSA_ERROR_BAD_STATE );
1889 PSA_ASSERT( psa_hash_abort( &operation ) );
1890
1891 /* Call verify after finish. */
1892 PSA_ASSERT( psa_hash_setup( &operation, alg ) );
1893 PSA_ASSERT( psa_hash_finish( &operation,
1894 hash, sizeof( hash ), &hash_len ) );
1895 TEST_EQUAL( psa_hash_verify( &operation,
1896 valid_hash, sizeof( valid_hash ) ),
1897 PSA_ERROR_BAD_STATE );
1898 PSA_ASSERT( psa_hash_abort( &operation ) );
1899
1900 /* Call verify twice in a row. */
1901 PSA_ASSERT( psa_hash_setup( &operation, alg ) );
1902 PSA_ASSERT( psa_hash_verify( &operation,
1903 valid_hash, sizeof( valid_hash ) ) );
1904 TEST_EQUAL( psa_hash_verify( &operation,
1905 valid_hash, sizeof( valid_hash ) ),
1906 PSA_ERROR_BAD_STATE );
1907 PSA_ASSERT( psa_hash_abort( &operation ) );
1908
1909 /* Call finish without calling setup beforehand. */
Gilles Peskinefe11b722018-12-18 00:24:04 +01001910 TEST_EQUAL( psa_hash_finish( &operation,
1911 hash, sizeof( hash ), &hash_len ),
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00001912 PSA_ERROR_BAD_STATE );
Jaeden Amero11aa7ee2019-02-19 11:44:55 +00001913 PSA_ASSERT( psa_hash_abort( &operation ) );
1914
1915 /* Call finish twice in a row. */
1916 PSA_ASSERT( psa_hash_setup( &operation, alg ) );
1917 PSA_ASSERT( psa_hash_finish( &operation,
1918 hash, sizeof( hash ), &hash_len ) );
1919 TEST_EQUAL( psa_hash_finish( &operation,
1920 hash, sizeof( hash ), &hash_len ),
1921 PSA_ERROR_BAD_STATE );
1922 PSA_ASSERT( psa_hash_abort( &operation ) );
1923
1924 /* Call finish after calling verify. */
1925 PSA_ASSERT( psa_hash_setup( &operation, alg ) );
1926 PSA_ASSERT( psa_hash_verify( &operation,
1927 valid_hash, sizeof( valid_hash ) ) );
1928 TEST_EQUAL( psa_hash_finish( &operation,
1929 hash, sizeof( hash ), &hash_len ),
1930 PSA_ERROR_BAD_STATE );
1931 PSA_ASSERT( psa_hash_abort( &operation ) );
itayzafrirf86548d2018-11-01 10:44:32 +02001932
1933exit:
Gilles Peskine1153e7b2019-05-28 15:10:21 +02001934 PSA_DONE( );
itayzafrirf86548d2018-11-01 10:44:32 +02001935}
1936/* END_CASE */
1937
Gilles Peskined6dc40c2021-01-12 12:55:31 +01001938/* BEGIN_CASE depends_on:PSA_WANT_ALG_SHA_256 */
itayzafrir27e69452018-11-01 14:26:34 +02001939void hash_verify_bad_args( )
itayzafrirec93d302018-10-18 18:01:10 +03001940{
1941 psa_algorithm_t alg = PSA_ALG_SHA_256;
itayzafrir27e69452018-11-01 14:26:34 +02001942 /* SHA-256 hash of an empty string with 2 extra bytes (0xaa and 0xbb)
1943 * appended to it */
1944 unsigned char hash[] = {
1945 0xe3, 0xb0, 0xc4, 0x42, 0x98, 0xfc, 0x1c, 0x14, 0x9a, 0xfb, 0xf4, 0xc8,
1946 0x99, 0x6f, 0xb9, 0x24, 0x27, 0xae, 0x41, 0xe4, 0x64, 0x9b, 0x93, 0x4c,
1947 0xa4, 0x95, 0x99, 0x1b, 0x78, 0x52, 0xb8, 0x55, 0xaa, 0xbb };
gabor-mezei-armcbcec212020-12-18 14:23:51 +01001948 size_t expected_size = PSA_HASH_LENGTH( alg );
Jaeden Amero6a25b412019-01-04 11:47:44 +00001949 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
itayzafrirec93d302018-10-18 18:01:10 +03001950
Gilles Peskine8817f612018-12-18 00:18:46 +01001951 PSA_ASSERT( psa_crypto_init( ) );
itayzafrirec93d302018-10-18 18:01:10 +03001952
itayzafrir27e69452018-11-01 14:26:34 +02001953 /* psa_hash_verify with a smaller hash than expected */
Gilles Peskine8817f612018-12-18 00:18:46 +01001954 PSA_ASSERT( psa_hash_setup( &operation, alg ) );
Gilles Peskinef812dcf2018-12-18 00:33:25 +01001955 TEST_EQUAL( psa_hash_verify( &operation, hash, expected_size - 1 ),
Gilles Peskinefe11b722018-12-18 00:24:04 +01001956 PSA_ERROR_INVALID_SIGNATURE );
itayzafrirec93d302018-10-18 18:01:10 +03001957
itayzafrir27e69452018-11-01 14:26:34 +02001958 /* psa_hash_verify with a non-matching hash */
Gilles Peskine8817f612018-12-18 00:18:46 +01001959 PSA_ASSERT( psa_hash_setup( &operation, alg ) );
Gilles Peskinef812dcf2018-12-18 00:33:25 +01001960 TEST_EQUAL( psa_hash_verify( &operation, hash + 1, expected_size ),
Gilles Peskinefe11b722018-12-18 00:24:04 +01001961 PSA_ERROR_INVALID_SIGNATURE );
itayzafrirec93d302018-10-18 18:01:10 +03001962
itayzafrir27e69452018-11-01 14:26:34 +02001963 /* psa_hash_verify with a hash longer than expected */
Gilles Peskine8817f612018-12-18 00:18:46 +01001964 PSA_ASSERT( psa_hash_setup( &operation, alg ) );
Gilles Peskinef812dcf2018-12-18 00:33:25 +01001965 TEST_EQUAL( psa_hash_verify( &operation, hash, sizeof( hash ) ),
Gilles Peskinefe11b722018-12-18 00:24:04 +01001966 PSA_ERROR_INVALID_SIGNATURE );
itayzafrir4271df92018-10-24 18:16:19 +03001967
itayzafrirec93d302018-10-18 18:01:10 +03001968exit:
Gilles Peskine1153e7b2019-05-28 15:10:21 +02001969 PSA_DONE( );
itayzafrirec93d302018-10-18 18:01:10 +03001970}
1971/* END_CASE */
1972
Ronald Cronee414c72021-03-18 18:50:08 +01001973/* BEGIN_CASE depends_on:PSA_WANT_ALG_SHA_256 */
itayzafrirb2dd5ed2018-11-01 11:58:59 +02001974void hash_finish_bad_args( )
itayzafrir58028322018-10-25 10:22:01 +03001975{
1976 psa_algorithm_t alg = PSA_ALG_SHA_256;
itayzafrirb2dd5ed2018-11-01 11:58:59 +02001977 unsigned char hash[PSA_HASH_MAX_SIZE];
gabor-mezei-armcbcec212020-12-18 14:23:51 +01001978 size_t expected_size = PSA_HASH_LENGTH( alg );
Jaeden Amero6a25b412019-01-04 11:47:44 +00001979 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
itayzafrir58028322018-10-25 10:22:01 +03001980 size_t hash_len;
1981
Gilles Peskine8817f612018-12-18 00:18:46 +01001982 PSA_ASSERT( psa_crypto_init( ) );
itayzafrir58028322018-10-25 10:22:01 +03001983
itayzafrir58028322018-10-25 10:22:01 +03001984 /* psa_hash_finish with a smaller hash buffer than expected */
Gilles Peskine8817f612018-12-18 00:18:46 +01001985 PSA_ASSERT( psa_hash_setup( &operation, alg ) );
Gilles Peskinefe11b722018-12-18 00:24:04 +01001986 TEST_EQUAL( psa_hash_finish( &operation,
Gilles Peskinef812dcf2018-12-18 00:33:25 +01001987 hash, expected_size - 1, &hash_len ),
1988 PSA_ERROR_BUFFER_TOO_SMALL );
itayzafrir58028322018-10-25 10:22:01 +03001989
1990exit:
Gilles Peskine1153e7b2019-05-28 15:10:21 +02001991 PSA_DONE( );
itayzafrir58028322018-10-25 10:22:01 +03001992}
1993/* END_CASE */
1994
Ronald Cronee414c72021-03-18 18:50:08 +01001995/* BEGIN_CASE depends_on:PSA_WANT_ALG_SHA_256 */
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01001996void hash_clone_source_state( )
1997{
1998 psa_algorithm_t alg = PSA_ALG_SHA_256;
1999 unsigned char hash[PSA_HASH_MAX_SIZE];
2000 psa_hash_operation_t op_source = PSA_HASH_OPERATION_INIT;
2001 psa_hash_operation_t op_init = PSA_HASH_OPERATION_INIT;
2002 psa_hash_operation_t op_setup = PSA_HASH_OPERATION_INIT;
2003 psa_hash_operation_t op_finished = PSA_HASH_OPERATION_INIT;
2004 psa_hash_operation_t op_aborted = PSA_HASH_OPERATION_INIT;
2005 size_t hash_len;
2006
2007 PSA_ASSERT( psa_crypto_init( ) );
2008 PSA_ASSERT( psa_hash_setup( &op_source, alg ) );
2009
2010 PSA_ASSERT( psa_hash_setup( &op_setup, alg ) );
2011 PSA_ASSERT( psa_hash_setup( &op_finished, alg ) );
2012 PSA_ASSERT( psa_hash_finish( &op_finished,
2013 hash, sizeof( hash ), &hash_len ) );
2014 PSA_ASSERT( psa_hash_setup( &op_aborted, alg ) );
2015 PSA_ASSERT( psa_hash_abort( &op_aborted ) );
2016
2017 TEST_EQUAL( psa_hash_clone( &op_source, &op_setup ),
2018 PSA_ERROR_BAD_STATE );
2019
2020 PSA_ASSERT( psa_hash_clone( &op_source, &op_init ) );
2021 PSA_ASSERT( psa_hash_finish( &op_init,
2022 hash, sizeof( hash ), &hash_len ) );
2023 PSA_ASSERT( psa_hash_clone( &op_source, &op_finished ) );
2024 PSA_ASSERT( psa_hash_finish( &op_finished,
2025 hash, sizeof( hash ), &hash_len ) );
2026 PSA_ASSERT( psa_hash_clone( &op_source, &op_aborted ) );
2027 PSA_ASSERT( psa_hash_finish( &op_aborted,
2028 hash, sizeof( hash ), &hash_len ) );
2029
2030exit:
2031 psa_hash_abort( &op_source );
2032 psa_hash_abort( &op_init );
2033 psa_hash_abort( &op_setup );
2034 psa_hash_abort( &op_finished );
2035 psa_hash_abort( &op_aborted );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02002036 PSA_DONE( );
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002037}
2038/* END_CASE */
2039
Ronald Cronee414c72021-03-18 18:50:08 +01002040/* BEGIN_CASE depends_on:PSA_WANT_ALG_SHA_256 */
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002041void hash_clone_target_state( )
2042{
2043 psa_algorithm_t alg = PSA_ALG_SHA_256;
2044 unsigned char hash[PSA_HASH_MAX_SIZE];
2045 psa_hash_operation_t op_init = PSA_HASH_OPERATION_INIT;
2046 psa_hash_operation_t op_setup = PSA_HASH_OPERATION_INIT;
2047 psa_hash_operation_t op_finished = PSA_HASH_OPERATION_INIT;
2048 psa_hash_operation_t op_aborted = PSA_HASH_OPERATION_INIT;
2049 psa_hash_operation_t op_target = PSA_HASH_OPERATION_INIT;
2050 size_t hash_len;
2051
2052 PSA_ASSERT( psa_crypto_init( ) );
2053
2054 PSA_ASSERT( psa_hash_setup( &op_setup, alg ) );
2055 PSA_ASSERT( psa_hash_setup( &op_finished, alg ) );
2056 PSA_ASSERT( psa_hash_finish( &op_finished,
2057 hash, sizeof( hash ), &hash_len ) );
2058 PSA_ASSERT( psa_hash_setup( &op_aborted, alg ) );
2059 PSA_ASSERT( psa_hash_abort( &op_aborted ) );
2060
2061 PSA_ASSERT( psa_hash_clone( &op_setup, &op_target ) );
2062 PSA_ASSERT( psa_hash_finish( &op_target,
2063 hash, sizeof( hash ), &hash_len ) );
2064
2065 TEST_EQUAL( psa_hash_clone( &op_init, &op_target ), PSA_ERROR_BAD_STATE );
2066 TEST_EQUAL( psa_hash_clone( &op_finished, &op_target ),
2067 PSA_ERROR_BAD_STATE );
2068 TEST_EQUAL( psa_hash_clone( &op_aborted, &op_target ),
2069 PSA_ERROR_BAD_STATE );
2070
2071exit:
2072 psa_hash_abort( &op_target );
2073 psa_hash_abort( &op_init );
2074 psa_hash_abort( &op_setup );
2075 psa_hash_abort( &op_finished );
2076 psa_hash_abort( &op_aborted );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02002077 PSA_DONE( );
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002078}
2079/* END_CASE */
2080
itayzafrir58028322018-10-25 10:22:01 +03002081/* BEGIN_CASE */
Jaeden Amero769ce272019-01-04 11:48:03 +00002082void mac_operation_init( )
2083{
Jaeden Amero252ef282019-02-15 14:05:35 +00002084 const uint8_t input[1] = { 0 };
2085
Jaeden Amero769ce272019-01-04 11:48:03 +00002086 /* Test each valid way of initializing the object, except for `= {0}`, as
2087 * Clang 5 complains when `-Wmissing-field-initializers` is used, even
2088 * though it's OK by the C standard. We could test for this, but we'd need
2089 * to supress the Clang warning for the test. */
2090 psa_mac_operation_t func = psa_mac_operation_init( );
2091 psa_mac_operation_t init = PSA_MAC_OPERATION_INIT;
2092 psa_mac_operation_t zero;
2093
2094 memset( &zero, 0, sizeof( zero ) );
2095
Jaeden Amero252ef282019-02-15 14:05:35 +00002096 /* A freshly-initialized MAC operation should not be usable. */
2097 TEST_EQUAL( psa_mac_update( &func,
2098 input, sizeof( input ) ),
2099 PSA_ERROR_BAD_STATE );
2100 TEST_EQUAL( psa_mac_update( &init,
2101 input, sizeof( input ) ),
2102 PSA_ERROR_BAD_STATE );
2103 TEST_EQUAL( psa_mac_update( &zero,
2104 input, sizeof( input ) ),
2105 PSA_ERROR_BAD_STATE );
2106
Jaeden Amero5229bbb2019-02-07 16:33:37 +00002107 /* A default MAC operation should be abortable without error. */
2108 PSA_ASSERT( psa_mac_abort( &func ) );
2109 PSA_ASSERT( psa_mac_abort( &init ) );
2110 PSA_ASSERT( psa_mac_abort( &zero ) );
Jaeden Amero769ce272019-01-04 11:48:03 +00002111}
2112/* END_CASE */
2113
2114/* BEGIN_CASE */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002115void mac_setup( int key_type_arg,
2116 data_t *key,
2117 int alg_arg,
2118 int expected_status_arg )
2119{
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002120 psa_key_type_t key_type = key_type_arg;
2121 psa_algorithm_t alg = alg_arg;
Gilles Peskineb866e2b2018-06-21 09:25:10 +02002122 psa_status_t expected_status = expected_status_arg;
Jaeden Amero769ce272019-01-04 11:48:03 +00002123 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
Gilles Peskinef426e0f2019-02-25 17:42:03 +01002124 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
2125#if defined(KNOWN_SUPPORTED_MAC_ALG)
2126 const uint8_t smoke_test_key_data[16] = "kkkkkkkkkkkkkkkk";
2127#endif
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002128
Gilles Peskine8817f612018-12-18 00:18:46 +01002129 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002130
Gilles Peskinef426e0f2019-02-25 17:42:03 +01002131 if( ! exercise_mac_setup( key_type, key->x, key->len, alg,
2132 &operation, &status ) )
2133 goto exit;
Gilles Peskinefe11b722018-12-18 00:24:04 +01002134 TEST_EQUAL( status, expected_status );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002135
Gilles Peskinef426e0f2019-02-25 17:42:03 +01002136 /* The operation object should be reusable. */
2137#if defined(KNOWN_SUPPORTED_MAC_ALG)
2138 if( ! exercise_mac_setup( KNOWN_SUPPORTED_MAC_KEY_TYPE,
2139 smoke_test_key_data,
2140 sizeof( smoke_test_key_data ),
2141 KNOWN_SUPPORTED_MAC_ALG,
2142 &operation, &status ) )
2143 goto exit;
2144 TEST_EQUAL( status, PSA_SUCCESS );
2145#endif
2146
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002147exit:
Gilles Peskine1153e7b2019-05-28 15:10:21 +02002148 PSA_DONE( );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002149}
2150/* END_CASE */
2151
Gilles Peskined6dc40c2021-01-12 12:55:31 +01002152/* BEGIN_CASE depends_on:PSA_WANT_KEY_TYPE_HMAC:PSA_WANT_ALG_HMAC:PSA_WANT_ALG_SHA_256 */
Jaeden Amero252ef282019-02-15 14:05:35 +00002153void mac_bad_order( )
2154{
Ronald Cron5425a212020-08-04 14:58:35 +02002155 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Jaeden Amero252ef282019-02-15 14:05:35 +00002156 psa_key_type_t key_type = PSA_KEY_TYPE_HMAC;
2157 psa_algorithm_t alg = PSA_ALG_HMAC(PSA_ALG_SHA_256);
Ronald Cron5425a212020-08-04 14:58:35 +02002158 const uint8_t key_data[] = {
Jaeden Amero252ef282019-02-15 14:05:35 +00002159 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa,
2160 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa,
2161 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa };
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02002162 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Jaeden Amero252ef282019-02-15 14:05:35 +00002163 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
2164 uint8_t sign_mac[PSA_MAC_MAX_SIZE + 10] = { 0 };
2165 size_t sign_mac_length = 0;
2166 const uint8_t input[] = { 0xbb, 0xbb, 0xbb, 0xbb };
2167 const uint8_t verify_mac[] = {
2168 0x74, 0x65, 0x93, 0x8c, 0xeb, 0x1d, 0xb3, 0x76, 0x5a, 0x38, 0xe7, 0xdd,
2169 0x85, 0xc5, 0xad, 0x4f, 0x07, 0xe7, 0xd5, 0xb2, 0x64, 0xf0, 0x1a, 0x1a,
2170 0x2c, 0xf9, 0x18, 0xca, 0x59, 0x7e, 0x5d, 0xf6 };
2171
2172 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01002173 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_HASH | PSA_KEY_USAGE_VERIFY_HASH );
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02002174 psa_set_key_algorithm( &attributes, alg );
2175 psa_set_key_type( &attributes, key_type );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002176
Ronald Cron5425a212020-08-04 14:58:35 +02002177 PSA_ASSERT( psa_import_key( &attributes, key_data, sizeof( key_data ),
2178 &key ) );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002179
Jaeden Amero252ef282019-02-15 14:05:35 +00002180 /* Call update without calling setup beforehand. */
2181 TEST_EQUAL( psa_mac_update( &operation, input, sizeof( input ) ),
2182 PSA_ERROR_BAD_STATE );
2183 PSA_ASSERT( psa_mac_abort( &operation ) );
2184
2185 /* Call sign finish without calling setup beforehand. */
2186 TEST_EQUAL( psa_mac_sign_finish( &operation, sign_mac, sizeof( sign_mac ),
2187 &sign_mac_length),
2188 PSA_ERROR_BAD_STATE );
2189 PSA_ASSERT( psa_mac_abort( &operation ) );
2190
2191 /* Call verify finish without calling setup beforehand. */
2192 TEST_EQUAL( psa_mac_verify_finish( &operation,
2193 verify_mac, sizeof( verify_mac ) ),
2194 PSA_ERROR_BAD_STATE );
2195 PSA_ASSERT( psa_mac_abort( &operation ) );
2196
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002197 /* Call setup twice in a row. */
Ronald Cron5425a212020-08-04 14:58:35 +02002198 PSA_ASSERT( psa_mac_sign_setup( &operation, key, alg ) );
2199 TEST_EQUAL( psa_mac_sign_setup( &operation, key, alg ),
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002200 PSA_ERROR_BAD_STATE );
2201 PSA_ASSERT( psa_mac_abort( &operation ) );
2202
Jaeden Amero252ef282019-02-15 14:05:35 +00002203 /* Call update after sign finish. */
Ronald Cron5425a212020-08-04 14:58:35 +02002204 PSA_ASSERT( psa_mac_sign_setup( &operation, key, alg ) );
Jaeden Amero252ef282019-02-15 14:05:35 +00002205 PSA_ASSERT( psa_mac_update( &operation, input, sizeof( input ) ) );
2206 PSA_ASSERT( psa_mac_sign_finish( &operation,
2207 sign_mac, sizeof( sign_mac ),
2208 &sign_mac_length ) );
2209 TEST_EQUAL( psa_mac_update( &operation, input, sizeof( input ) ),
2210 PSA_ERROR_BAD_STATE );
2211 PSA_ASSERT( psa_mac_abort( &operation ) );
2212
2213 /* Call update after verify finish. */
Ronald Cron5425a212020-08-04 14:58:35 +02002214 PSA_ASSERT( psa_mac_verify_setup( &operation, key, alg ) );
Jaeden Amero252ef282019-02-15 14:05:35 +00002215 PSA_ASSERT( psa_mac_update( &operation, input, sizeof( input ) ) );
2216 PSA_ASSERT( psa_mac_verify_finish( &operation,
2217 verify_mac, sizeof( verify_mac ) ) );
2218 TEST_EQUAL( psa_mac_update( &operation, input, sizeof( input ) ),
2219 PSA_ERROR_BAD_STATE );
2220 PSA_ASSERT( psa_mac_abort( &operation ) );
2221
2222 /* Call sign finish twice in a row. */
Ronald Cron5425a212020-08-04 14:58:35 +02002223 PSA_ASSERT( psa_mac_sign_setup( &operation, key, alg ) );
Jaeden Amero252ef282019-02-15 14:05:35 +00002224 PSA_ASSERT( psa_mac_update( &operation, input, sizeof( input ) ) );
2225 PSA_ASSERT( psa_mac_sign_finish( &operation,
2226 sign_mac, sizeof( sign_mac ),
2227 &sign_mac_length ) );
2228 TEST_EQUAL( psa_mac_sign_finish( &operation,
2229 sign_mac, sizeof( sign_mac ),
2230 &sign_mac_length ),
2231 PSA_ERROR_BAD_STATE );
2232 PSA_ASSERT( psa_mac_abort( &operation ) );
2233
2234 /* Call verify finish twice in a row. */
Ronald Cron5425a212020-08-04 14:58:35 +02002235 PSA_ASSERT( psa_mac_verify_setup( &operation, key, alg ) );
Jaeden Amero252ef282019-02-15 14:05:35 +00002236 PSA_ASSERT( psa_mac_update( &operation, input, sizeof( input ) ) );
2237 PSA_ASSERT( psa_mac_verify_finish( &operation,
2238 verify_mac, sizeof( verify_mac ) ) );
2239 TEST_EQUAL( psa_mac_verify_finish( &operation,
2240 verify_mac, sizeof( verify_mac ) ),
2241 PSA_ERROR_BAD_STATE );
2242 PSA_ASSERT( psa_mac_abort( &operation ) );
2243
2244 /* Setup sign but try verify. */
Ronald Cron5425a212020-08-04 14:58:35 +02002245 PSA_ASSERT( psa_mac_sign_setup( &operation, key, alg ) );
Jaeden Amero252ef282019-02-15 14:05:35 +00002246 PSA_ASSERT( psa_mac_update( &operation, input, sizeof( input ) ) );
2247 TEST_EQUAL( psa_mac_verify_finish( &operation,
2248 verify_mac, sizeof( verify_mac ) ),
2249 PSA_ERROR_BAD_STATE );
2250 PSA_ASSERT( psa_mac_abort( &operation ) );
2251
2252 /* Setup verify but try sign. */
Ronald Cron5425a212020-08-04 14:58:35 +02002253 PSA_ASSERT( psa_mac_verify_setup( &operation, key, alg ) );
Jaeden Amero252ef282019-02-15 14:05:35 +00002254 PSA_ASSERT( psa_mac_update( &operation, input, sizeof( input ) ) );
2255 TEST_EQUAL( psa_mac_sign_finish( &operation,
2256 sign_mac, sizeof( sign_mac ),
2257 &sign_mac_length ),
2258 PSA_ERROR_BAD_STATE );
2259 PSA_ASSERT( psa_mac_abort( &operation ) );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002260
Ronald Cron5425a212020-08-04 14:58:35 +02002261 PSA_ASSERT( psa_destroy_key( key ) );
Gilles Peskine76b29a72019-05-28 14:08:50 +02002262
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002263exit:
Gilles Peskine1153e7b2019-05-28 15:10:21 +02002264 PSA_DONE( );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002265}
2266/* END_CASE */
2267
2268/* BEGIN_CASE */
Gilles Peskinea7aa4422018-08-14 15:17:54 +02002269void mac_sign( int key_type_arg,
Ronald Cron5425a212020-08-04 14:58:35 +02002270 data_t *key_data,
Gilles Peskinea7aa4422018-08-14 15:17:54 +02002271 int alg_arg,
2272 data_t *input,
2273 data_t *expected_mac )
2274{
Ronald Cron5425a212020-08-04 14:58:35 +02002275 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskinea7aa4422018-08-14 15:17:54 +02002276 psa_key_type_t key_type = key_type_arg;
2277 psa_algorithm_t alg = alg_arg;
Jaeden Amero769ce272019-01-04 11:48:03 +00002278 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02002279 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine5e65cec2020-08-25 23:38:39 +02002280 uint8_t *actual_mac = NULL;
Gilles Peskinea7aa4422018-08-14 15:17:54 +02002281 size_t mac_buffer_size =
gabor-mezei-armcbcec212020-12-18 14:23:51 +01002282 PSA_MAC_LENGTH( key_type, PSA_BYTES_TO_BITS( key_data->len ), alg );
Gilles Peskinea7aa4422018-08-14 15:17:54 +02002283 size_t mac_length = 0;
Gilles Peskine8b356b52020-08-25 23:44:59 +02002284 const size_t output_sizes_to_test[] = {
2285 0,
2286 1,
2287 expected_mac->len - 1,
2288 expected_mac->len,
2289 expected_mac->len + 1,
2290 };
Gilles Peskinea7aa4422018-08-14 15:17:54 +02002291
Gilles Peskinea7aa4422018-08-14 15:17:54 +02002292 TEST_ASSERT( mac_buffer_size <= PSA_MAC_MAX_SIZE );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01002293 /* We expect PSA_MAC_LENGTH to be exact. */
Gilles Peskine3d404d62020-08-25 23:47:36 +02002294 TEST_ASSERT( expected_mac->len == mac_buffer_size );
Gilles Peskinea7aa4422018-08-14 15:17:54 +02002295
Gilles Peskine8817f612018-12-18 00:18:46 +01002296 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskinea7aa4422018-08-14 15:17:54 +02002297
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01002298 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_HASH );
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02002299 psa_set_key_algorithm( &attributes, alg );
2300 psa_set_key_type( &attributes, key_type );
Gilles Peskinea7aa4422018-08-14 15:17:54 +02002301
Ronald Cron5425a212020-08-04 14:58:35 +02002302 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
2303 &key ) );
Gilles Peskinea7aa4422018-08-14 15:17:54 +02002304
Gilles Peskine8b356b52020-08-25 23:44:59 +02002305 for( size_t i = 0; i < ARRAY_LENGTH( output_sizes_to_test ); i++ )
2306 {
2307 const size_t output_size = output_sizes_to_test[i];
2308 psa_status_t expected_status =
2309 ( output_size >= expected_mac->len ? PSA_SUCCESS :
2310 PSA_ERROR_BUFFER_TOO_SMALL );
Gilles Peskine5e65cec2020-08-25 23:38:39 +02002311
Chris Jones9634bb12021-01-20 15:56:42 +00002312 mbedtls_test_set_step( output_size );
Gilles Peskine8b356b52020-08-25 23:44:59 +02002313 ASSERT_ALLOC( actual_mac, output_size );
Gilles Peskinea7aa4422018-08-14 15:17:54 +02002314
Gilles Peskine8b356b52020-08-25 23:44:59 +02002315 /* Calculate the MAC. */
Ronald Cron5425a212020-08-04 14:58:35 +02002316 PSA_ASSERT( psa_mac_sign_setup( &operation, key, alg ) );
Gilles Peskine8b356b52020-08-25 23:44:59 +02002317 PSA_ASSERT( psa_mac_update( &operation,
2318 input->x, input->len ) );
2319 TEST_EQUAL( psa_mac_sign_finish( &operation,
2320 actual_mac, output_size,
2321 &mac_length ),
2322 expected_status );
2323 PSA_ASSERT( psa_mac_abort( &operation ) );
2324
2325 if( expected_status == PSA_SUCCESS )
2326 {
2327 ASSERT_COMPARE( expected_mac->x, expected_mac->len,
2328 actual_mac, mac_length );
2329 }
2330 mbedtls_free( actual_mac );
2331 actual_mac = NULL;
2332 }
Gilles Peskinea7aa4422018-08-14 15:17:54 +02002333
Gilles Peskinea7aa4422018-08-14 15:17:54 +02002334exit:
Gilles Peskine64f13ef2020-08-25 23:15:20 +02002335 psa_mac_abort( &operation );
Ronald Cron5425a212020-08-04 14:58:35 +02002336 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02002337 PSA_DONE( );
Gilles Peskine5e65cec2020-08-25 23:38:39 +02002338 mbedtls_free( actual_mac );
Gilles Peskinea7aa4422018-08-14 15:17:54 +02002339}
2340/* END_CASE */
2341
2342/* BEGIN_CASE */
Gilles Peskinec0ec9722018-06-18 17:03:37 +02002343void mac_verify( int key_type_arg,
Ronald Cron5425a212020-08-04 14:58:35 +02002344 data_t *key_data,
Gilles Peskinec0ec9722018-06-18 17:03:37 +02002345 int alg_arg,
2346 data_t *input,
2347 data_t *expected_mac )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002348{
Ronald Cron5425a212020-08-04 14:58:35 +02002349 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002350 psa_key_type_t key_type = key_type_arg;
2351 psa_algorithm_t alg = alg_arg;
Jaeden Amero769ce272019-01-04 11:48:03 +00002352 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02002353 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine29c4a6c2020-08-26 00:01:39 +02002354 uint8_t *perturbed_mac = NULL;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002355
Gilles Peskine69c12672018-06-28 00:07:19 +02002356 TEST_ASSERT( expected_mac->len <= PSA_MAC_MAX_SIZE );
2357
Gilles Peskine8817f612018-12-18 00:18:46 +01002358 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002359
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01002360 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_VERIFY_HASH );
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02002361 psa_set_key_algorithm( &attributes, alg );
2362 psa_set_key_type( &attributes, key_type );
mohammad16036df908f2018-04-02 08:34:15 -07002363
Ronald Cron5425a212020-08-04 14:58:35 +02002364 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
2365 &key ) );
Gilles Peskinec0ec9722018-06-18 17:03:37 +02002366
Gilles Peskine29c4a6c2020-08-26 00:01:39 +02002367 /* Test the correct MAC. */
Ronald Cron5425a212020-08-04 14:58:35 +02002368 PSA_ASSERT( psa_mac_verify_setup( &operation, key, alg ) );
Gilles Peskine8817f612018-12-18 00:18:46 +01002369 PSA_ASSERT( psa_mac_update( &operation,
2370 input->x, input->len ) );
2371 PSA_ASSERT( psa_mac_verify_finish( &operation,
2372 expected_mac->x,
2373 expected_mac->len ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002374
Gilles Peskine29c4a6c2020-08-26 00:01:39 +02002375 /* Test a MAC that's too short. */
Ronald Cron5425a212020-08-04 14:58:35 +02002376 PSA_ASSERT( psa_mac_verify_setup( &operation, key, alg ) );
Gilles Peskine29c4a6c2020-08-26 00:01:39 +02002377 PSA_ASSERT( psa_mac_update( &operation,
2378 input->x, input->len ) );
2379 TEST_EQUAL( psa_mac_verify_finish( &operation,
2380 expected_mac->x,
2381 expected_mac->len - 1 ),
2382 PSA_ERROR_INVALID_SIGNATURE );
2383
2384 /* Test a MAC that's too long. */
2385 ASSERT_ALLOC( perturbed_mac, expected_mac->len + 1 );
2386 memcpy( perturbed_mac, expected_mac->x, expected_mac->len );
Ronald Cron5425a212020-08-04 14:58:35 +02002387 PSA_ASSERT( psa_mac_verify_setup( &operation, key, alg ) );
Gilles Peskine29c4a6c2020-08-26 00:01:39 +02002388 PSA_ASSERT( psa_mac_update( &operation,
2389 input->x, input->len ) );
2390 TEST_EQUAL( psa_mac_verify_finish( &operation,
2391 perturbed_mac,
2392 expected_mac->len + 1 ),
2393 PSA_ERROR_INVALID_SIGNATURE );
2394
2395 /* Test changing one byte. */
2396 for( size_t i = 0; i < expected_mac->len; i++ )
2397 {
Chris Jones9634bb12021-01-20 15:56:42 +00002398 mbedtls_test_set_step( i );
Gilles Peskine29c4a6c2020-08-26 00:01:39 +02002399 perturbed_mac[i] ^= 1;
Ronald Cron5425a212020-08-04 14:58:35 +02002400 PSA_ASSERT( psa_mac_verify_setup( &operation, key, alg ) );
Gilles Peskine29c4a6c2020-08-26 00:01:39 +02002401 PSA_ASSERT( psa_mac_update( &operation,
2402 input->x, input->len ) );
2403 TEST_EQUAL( psa_mac_verify_finish( &operation,
2404 perturbed_mac,
2405 expected_mac->len ),
2406 PSA_ERROR_INVALID_SIGNATURE );
2407 perturbed_mac[i] ^= 1;
2408 }
2409
Gilles Peskine8c9def32018-02-08 10:02:12 +01002410exit:
Gilles Peskine64f13ef2020-08-25 23:15:20 +02002411 psa_mac_abort( &operation );
Ronald Cron5425a212020-08-04 14:58:35 +02002412 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02002413 PSA_DONE( );
Gilles Peskine29c4a6c2020-08-26 00:01:39 +02002414 mbedtls_free( perturbed_mac );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002415}
2416/* END_CASE */
2417
2418/* BEGIN_CASE */
Jaeden Amero5bae2272019-01-04 11:48:27 +00002419void cipher_operation_init( )
2420{
Jaeden Ameroab439972019-02-15 14:12:05 +00002421 const uint8_t input[1] = { 0 };
2422 unsigned char output[1] = { 0 };
2423 size_t output_length;
Jaeden Amero5bae2272019-01-04 11:48:27 +00002424 /* Test each valid way of initializing the object, except for `= {0}`, as
2425 * Clang 5 complains when `-Wmissing-field-initializers` is used, even
2426 * though it's OK by the C standard. We could test for this, but we'd need
2427 * to supress the Clang warning for the test. */
2428 psa_cipher_operation_t func = psa_cipher_operation_init( );
2429 psa_cipher_operation_t init = PSA_CIPHER_OPERATION_INIT;
2430 psa_cipher_operation_t zero;
2431
2432 memset( &zero, 0, sizeof( zero ) );
2433
Jaeden Ameroab439972019-02-15 14:12:05 +00002434 /* A freshly-initialized cipher operation should not be usable. */
2435 TEST_EQUAL( psa_cipher_update( &func,
2436 input, sizeof( input ),
2437 output, sizeof( output ),
2438 &output_length ),
2439 PSA_ERROR_BAD_STATE );
2440 TEST_EQUAL( psa_cipher_update( &init,
2441 input, sizeof( input ),
2442 output, sizeof( output ),
2443 &output_length ),
2444 PSA_ERROR_BAD_STATE );
2445 TEST_EQUAL( psa_cipher_update( &zero,
2446 input, sizeof( input ),
2447 output, sizeof( output ),
2448 &output_length ),
2449 PSA_ERROR_BAD_STATE );
2450
Jaeden Amero5229bbb2019-02-07 16:33:37 +00002451 /* A default cipher operation should be abortable without error. */
2452 PSA_ASSERT( psa_cipher_abort( &func ) );
2453 PSA_ASSERT( psa_cipher_abort( &init ) );
2454 PSA_ASSERT( psa_cipher_abort( &zero ) );
Jaeden Amero5bae2272019-01-04 11:48:27 +00002455}
2456/* END_CASE */
2457
2458/* BEGIN_CASE */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002459void cipher_setup( int key_type_arg,
2460 data_t *key,
2461 int alg_arg,
2462 int expected_status_arg )
2463{
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002464 psa_key_type_t key_type = key_type_arg;
2465 psa_algorithm_t alg = alg_arg;
Gilles Peskineb866e2b2018-06-21 09:25:10 +02002466 psa_status_t expected_status = expected_status_arg;
Jaeden Amero5bae2272019-01-04 11:48:27 +00002467 psa_cipher_operation_t operation = PSA_CIPHER_OPERATION_INIT;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002468 psa_status_t status;
Gilles Peskine612ffd22021-01-20 18:51:00 +01002469#if defined(KNOWN_SUPPORTED_CIPHER_ALG)
Gilles Peskinef426e0f2019-02-25 17:42:03 +01002470 const uint8_t smoke_test_key_data[16] = "kkkkkkkkkkkkkkkk";
2471#endif
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002472
Gilles Peskine8817f612018-12-18 00:18:46 +01002473 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002474
Gilles Peskinef426e0f2019-02-25 17:42:03 +01002475 if( ! exercise_cipher_setup( key_type, key->x, key->len, alg,
2476 &operation, &status ) )
2477 goto exit;
Gilles Peskinefe11b722018-12-18 00:24:04 +01002478 TEST_EQUAL( status, expected_status );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002479
Gilles Peskinef426e0f2019-02-25 17:42:03 +01002480 /* The operation object should be reusable. */
2481#if defined(KNOWN_SUPPORTED_CIPHER_ALG)
2482 if( ! exercise_cipher_setup( KNOWN_SUPPORTED_CIPHER_KEY_TYPE,
2483 smoke_test_key_data,
2484 sizeof( smoke_test_key_data ),
2485 KNOWN_SUPPORTED_CIPHER_ALG,
2486 &operation, &status ) )
2487 goto exit;
2488 TEST_EQUAL( status, PSA_SUCCESS );
2489#endif
2490
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002491exit:
Gilles Peskine64f13ef2020-08-25 23:15:20 +02002492 psa_cipher_abort( &operation );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02002493 PSA_DONE( );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002494}
2495/* END_CASE */
2496
Ronald Cronee414c72021-03-18 18:50:08 +01002497/* BEGIN_CASE depends_on:PSA_WANT_KEY_TYPE_AES:PSA_WANT_ALG_CBC_PKCS7 */
Jaeden Ameroab439972019-02-15 14:12:05 +00002498void cipher_bad_order( )
2499{
Ronald Cron5425a212020-08-04 14:58:35 +02002500 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Jaeden Ameroab439972019-02-15 14:12:05 +00002501 psa_key_type_t key_type = PSA_KEY_TYPE_AES;
2502 psa_algorithm_t alg = PSA_ALG_CBC_PKCS7;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02002503 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Jaeden Ameroab439972019-02-15 14:12:05 +00002504 psa_cipher_operation_t operation = PSA_CIPHER_OPERATION_INIT;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01002505 unsigned char iv[PSA_BLOCK_CIPHER_BLOCK_LENGTH(PSA_KEY_TYPE_AES)] = { 0 };
Ronald Cron5425a212020-08-04 14:58:35 +02002506 const uint8_t key_data[] = {
Jaeden Ameroab439972019-02-15 14:12:05 +00002507 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa,
2508 0xaa, 0xaa, 0xaa, 0xaa };
2509 const uint8_t text[] = {
2510 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb,
2511 0xbb, 0xbb, 0xbb, 0xbb };
gabor-mezei-armcbcec212020-12-18 14:23:51 +01002512 uint8_t buffer[PSA_BLOCK_CIPHER_BLOCK_LENGTH(PSA_KEY_TYPE_AES)] = { 0 };
Jaeden Ameroab439972019-02-15 14:12:05 +00002513 size_t length = 0;
2514
2515 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02002516 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT | PSA_KEY_USAGE_DECRYPT );
2517 psa_set_key_algorithm( &attributes, alg );
2518 psa_set_key_type( &attributes, key_type );
Ronald Cron5425a212020-08-04 14:58:35 +02002519 PSA_ASSERT( psa_import_key( &attributes, key_data, sizeof( key_data ),
2520 &key ) );
Jaeden Ameroab439972019-02-15 14:12:05 +00002521
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002522 /* Call encrypt setup twice in a row. */
Ronald Cron5425a212020-08-04 14:58:35 +02002523 PSA_ASSERT( psa_cipher_encrypt_setup( &operation, key, alg ) );
2524 TEST_EQUAL( psa_cipher_encrypt_setup( &operation, key, alg ),
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002525 PSA_ERROR_BAD_STATE );
2526 PSA_ASSERT( psa_cipher_abort( &operation ) );
2527
2528 /* Call decrypt setup twice in a row. */
Ronald Cron5425a212020-08-04 14:58:35 +02002529 PSA_ASSERT( psa_cipher_decrypt_setup( &operation, key, alg ) );
2530 TEST_EQUAL( psa_cipher_decrypt_setup( &operation, key, alg ),
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002531 PSA_ERROR_BAD_STATE );
2532 PSA_ASSERT( psa_cipher_abort( &operation ) );
2533
Jaeden Ameroab439972019-02-15 14:12:05 +00002534 /* Generate an IV without calling setup beforehand. */
2535 TEST_EQUAL( psa_cipher_generate_iv( &operation,
2536 buffer, sizeof( buffer ),
2537 &length ),
2538 PSA_ERROR_BAD_STATE );
2539 PSA_ASSERT( psa_cipher_abort( &operation ) );
2540
2541 /* Generate an IV twice in a row. */
Ronald Cron5425a212020-08-04 14:58:35 +02002542 PSA_ASSERT( psa_cipher_encrypt_setup( &operation, key, alg ) );
Jaeden Ameroab439972019-02-15 14:12:05 +00002543 PSA_ASSERT( psa_cipher_generate_iv( &operation,
2544 buffer, sizeof( buffer ),
2545 &length ) );
2546 TEST_EQUAL( psa_cipher_generate_iv( &operation,
2547 buffer, sizeof( buffer ),
2548 &length ),
2549 PSA_ERROR_BAD_STATE );
2550 PSA_ASSERT( psa_cipher_abort( &operation ) );
2551
2552 /* Generate an IV after it's already set. */
Ronald Cron5425a212020-08-04 14:58:35 +02002553 PSA_ASSERT( psa_cipher_encrypt_setup( &operation, key, alg ) );
Jaeden Ameroab439972019-02-15 14:12:05 +00002554 PSA_ASSERT( psa_cipher_set_iv( &operation,
2555 iv, sizeof( iv ) ) );
2556 TEST_EQUAL( psa_cipher_generate_iv( &operation,
2557 buffer, sizeof( buffer ),
2558 &length ),
2559 PSA_ERROR_BAD_STATE );
2560 PSA_ASSERT( psa_cipher_abort( &operation ) );
2561
2562 /* Set an IV without calling setup beforehand. */
2563 TEST_EQUAL( psa_cipher_set_iv( &operation,
2564 iv, sizeof( iv ) ),
2565 PSA_ERROR_BAD_STATE );
2566 PSA_ASSERT( psa_cipher_abort( &operation ) );
2567
2568 /* Set an IV after it's already set. */
Ronald Cron5425a212020-08-04 14:58:35 +02002569 PSA_ASSERT( psa_cipher_encrypt_setup( &operation, key, alg ) );
Jaeden Ameroab439972019-02-15 14:12:05 +00002570 PSA_ASSERT( psa_cipher_set_iv( &operation,
2571 iv, sizeof( iv ) ) );
2572 TEST_EQUAL( psa_cipher_set_iv( &operation,
2573 iv, sizeof( iv ) ),
2574 PSA_ERROR_BAD_STATE );
2575 PSA_ASSERT( psa_cipher_abort( &operation ) );
2576
2577 /* Set an IV after it's already generated. */
Ronald Cron5425a212020-08-04 14:58:35 +02002578 PSA_ASSERT( psa_cipher_encrypt_setup( &operation, key, alg ) );
Jaeden Ameroab439972019-02-15 14:12:05 +00002579 PSA_ASSERT( psa_cipher_generate_iv( &operation,
2580 buffer, sizeof( buffer ),
2581 &length ) );
2582 TEST_EQUAL( psa_cipher_set_iv( &operation,
2583 iv, sizeof( iv ) ),
2584 PSA_ERROR_BAD_STATE );
2585 PSA_ASSERT( psa_cipher_abort( &operation ) );
2586
2587 /* Call update without calling setup beforehand. */
2588 TEST_EQUAL( psa_cipher_update( &operation,
2589 text, sizeof( text ),
2590 buffer, sizeof( buffer ),
2591 &length ),
2592 PSA_ERROR_BAD_STATE );
2593 PSA_ASSERT( psa_cipher_abort( &operation ) );
2594
2595 /* Call update without an IV where an IV is required. */
2596 TEST_EQUAL( psa_cipher_update( &operation,
2597 text, sizeof( text ),
2598 buffer, sizeof( buffer ),
2599 &length ),
2600 PSA_ERROR_BAD_STATE );
2601 PSA_ASSERT( psa_cipher_abort( &operation ) );
2602
2603 /* Call update after finish. */
Ronald Cron5425a212020-08-04 14:58:35 +02002604 PSA_ASSERT( psa_cipher_encrypt_setup( &operation, key, alg ) );
Jaeden Ameroab439972019-02-15 14:12:05 +00002605 PSA_ASSERT( psa_cipher_set_iv( &operation,
2606 iv, sizeof( iv ) ) );
2607 PSA_ASSERT( psa_cipher_finish( &operation,
2608 buffer, sizeof( buffer ), &length ) );
2609 TEST_EQUAL( psa_cipher_update( &operation,
2610 text, sizeof( text ),
2611 buffer, sizeof( buffer ),
2612 &length ),
2613 PSA_ERROR_BAD_STATE );
2614 PSA_ASSERT( psa_cipher_abort( &operation ) );
2615
2616 /* Call finish without calling setup beforehand. */
2617 TEST_EQUAL( psa_cipher_finish( &operation,
2618 buffer, sizeof( buffer ), &length ),
2619 PSA_ERROR_BAD_STATE );
2620 PSA_ASSERT( psa_cipher_abort( &operation ) );
2621
2622 /* Call finish without an IV where an IV is required. */
Ronald Cron5425a212020-08-04 14:58:35 +02002623 PSA_ASSERT( psa_cipher_encrypt_setup( &operation, key, alg ) );
Jaeden Ameroab439972019-02-15 14:12:05 +00002624 /* Not calling update means we are encrypting an empty buffer, which is OK
2625 * for cipher modes with padding. */
2626 TEST_EQUAL( psa_cipher_finish( &operation,
2627 buffer, sizeof( buffer ), &length ),
2628 PSA_ERROR_BAD_STATE );
2629 PSA_ASSERT( psa_cipher_abort( &operation ) );
2630
2631 /* Call finish twice in a row. */
Ronald Cron5425a212020-08-04 14:58:35 +02002632 PSA_ASSERT( psa_cipher_encrypt_setup( &operation, key, alg ) );
Jaeden Ameroab439972019-02-15 14:12:05 +00002633 PSA_ASSERT( psa_cipher_set_iv( &operation,
2634 iv, sizeof( iv ) ) );
2635 PSA_ASSERT( psa_cipher_finish( &operation,
2636 buffer, sizeof( buffer ), &length ) );
2637 TEST_EQUAL( psa_cipher_finish( &operation,
2638 buffer, sizeof( buffer ), &length ),
2639 PSA_ERROR_BAD_STATE );
2640 PSA_ASSERT( psa_cipher_abort( &operation ) );
2641
Ronald Cron5425a212020-08-04 14:58:35 +02002642 PSA_ASSERT( psa_destroy_key( key ) );
Gilles Peskine76b29a72019-05-28 14:08:50 +02002643
Jaeden Ameroab439972019-02-15 14:12:05 +00002644exit:
Gilles Peskine64f13ef2020-08-25 23:15:20 +02002645 psa_cipher_abort( &operation );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02002646 PSA_DONE( );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002647}
2648/* END_CASE */
2649
2650/* BEGIN_CASE */
Gilles Peskine50e586b2018-06-08 14:28:46 +02002651void cipher_encrypt( int alg_arg, int key_type_arg,
Ronald Cron5425a212020-08-04 14:58:35 +02002652 data_t *key_data, data_t *iv,
itayzafrir3e02b3b2018-06-12 17:06:52 +03002653 data_t *input, data_t *expected_output,
Gilles Peskineb866e2b2018-06-21 09:25:10 +02002654 int expected_status_arg )
Gilles Peskine50e586b2018-06-08 14:28:46 +02002655{
Ronald Cron5425a212020-08-04 14:58:35 +02002656 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine50e586b2018-06-08 14:28:46 +02002657 psa_status_t status;
2658 psa_key_type_t key_type = key_type_arg;
2659 psa_algorithm_t alg = alg_arg;
Gilles Peskineb866e2b2018-06-21 09:25:10 +02002660 psa_status_t expected_status = expected_status_arg;
itayzafrir3e02b3b2018-06-12 17:06:52 +03002661 unsigned char *output = NULL;
Gilles Peskine50e586b2018-06-08 14:28:46 +02002662 size_t output_buffer_size = 0;
2663 size_t function_output_length = 0;
Gilles Peskinea7ec95f2018-06-08 14:40:59 +02002664 size_t total_output_length = 0;
Jaeden Amero5bae2272019-01-04 11:48:27 +00002665 psa_cipher_operation_t operation = PSA_CIPHER_OPERATION_INIT;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02002666 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine50e586b2018-06-08 14:28:46 +02002667
Gilles Peskine8817f612018-12-18 00:18:46 +01002668 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine50e586b2018-06-08 14:28:46 +02002669
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02002670 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
2671 psa_set_key_algorithm( &attributes, alg );
2672 psa_set_key_type( &attributes, key_type );
Moran Pekered346952018-07-05 15:22:45 +03002673
Ronald Cron5425a212020-08-04 14:58:35 +02002674 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
2675 &key ) );
Gilles Peskine50e586b2018-06-08 14:28:46 +02002676
Ronald Cron5425a212020-08-04 14:58:35 +02002677 PSA_ASSERT( psa_cipher_encrypt_setup( &operation, key, alg ) );
Gilles Peskine50e586b2018-06-08 14:28:46 +02002678
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02002679 if( iv->len > 0 )
2680 {
Steven Cooremana6033e92020-08-25 11:47:50 +02002681 PSA_ASSERT( psa_cipher_set_iv( &operation, iv->x, iv->len ) );
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02002682 }
2683
gabor-mezei-armceface22021-01-21 12:26:17 +01002684 output_buffer_size = PSA_CIPHER_ENCRYPT_OUTPUT_SIZE( key_type, alg, input->len );
2685 TEST_ASSERT( output_buffer_size <=
2686 PSA_CIPHER_ENCRYPT_OUTPUT_MAX_SIZE( input->len ) );
Gilles Peskine8cebbba2018-09-27 13:54:18 +02002687 ASSERT_ALLOC( output, output_buffer_size );
Gilles Peskine50e586b2018-06-08 14:28:46 +02002688
Gilles Peskine8817f612018-12-18 00:18:46 +01002689 PSA_ASSERT( psa_cipher_update( &operation,
2690 input->x, input->len,
2691 output, output_buffer_size,
2692 &function_output_length ) );
gabor-mezei-armceface22021-01-21 12:26:17 +01002693 TEST_ASSERT( function_output_length <=
2694 PSA_CIPHER_UPDATE_OUTPUT_SIZE( key_type, alg, input->len ) );
2695 TEST_ASSERT( function_output_length <=
2696 PSA_CIPHER_UPDATE_OUTPUT_MAX_SIZE( input->len ) );
Gilles Peskinea7ec95f2018-06-08 14:40:59 +02002697 total_output_length += function_output_length;
gabor-mezei-armceface22021-01-21 12:26:17 +01002698
Gilles Peskine50e586b2018-06-08 14:28:46 +02002699 status = psa_cipher_finish( &operation,
Gilles Peskine0c510f32021-03-24 00:41:51 +01002700 ( output_buffer_size == 0 ? NULL :
2701 output + total_output_length ),
Gilles Peskineee46fe72019-02-19 19:05:33 +01002702 output_buffer_size - total_output_length,
Gilles Peskine50e586b2018-06-08 14:28:46 +02002703 &function_output_length );
gabor-mezei-armceface22021-01-21 12:26:17 +01002704 TEST_ASSERT( function_output_length <=
2705 PSA_CIPHER_FINISH_OUTPUT_SIZE( key_type, alg ) );
2706 TEST_ASSERT( function_output_length <=
2707 PSA_CIPHER_FINISH_OUTPUT_MAX_SIZE );
Gilles Peskinea7ec95f2018-06-08 14:40:59 +02002708 total_output_length += function_output_length;
2709
Gilles Peskinefe11b722018-12-18 00:24:04 +01002710 TEST_EQUAL( status, expected_status );
Gilles Peskine50e586b2018-06-08 14:28:46 +02002711 if( expected_status == PSA_SUCCESS )
2712 {
Gilles Peskine8817f612018-12-18 00:18:46 +01002713 PSA_ASSERT( psa_cipher_abort( &operation ) );
Gilles Peskinebd7dea92018-09-27 13:57:19 +02002714 ASSERT_COMPARE( expected_output->x, expected_output->len,
2715 output, total_output_length );
Gilles Peskine50e586b2018-06-08 14:28:46 +02002716 }
Gilles Peskinea7ec95f2018-06-08 14:40:59 +02002717
Gilles Peskine50e586b2018-06-08 14:28:46 +02002718exit:
Gilles Peskine64f13ef2020-08-25 23:15:20 +02002719 psa_cipher_abort( &operation );
itayzafrir3e02b3b2018-06-12 17:06:52 +03002720 mbedtls_free( output );
Ronald Cron5425a212020-08-04 14:58:35 +02002721 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02002722 PSA_DONE( );
Gilles Peskine50e586b2018-06-08 14:28:46 +02002723}
2724/* END_CASE */
2725
2726/* BEGIN_CASE */
2727void cipher_encrypt_multipart( int alg_arg, int key_type_arg,
Ronald Cron5425a212020-08-04 14:58:35 +02002728 data_t *key_data, data_t *iv,
itayzafrir3e02b3b2018-06-12 17:06:52 +03002729 data_t *input,
Gilles Peskinee0866522019-02-19 19:44:00 +01002730 int first_part_size_arg,
2731 int output1_length_arg, int output2_length_arg,
itayzafrir3e02b3b2018-06-12 17:06:52 +03002732 data_t *expected_output )
Gilles Peskine50e586b2018-06-08 14:28:46 +02002733{
Ronald Cron5425a212020-08-04 14:58:35 +02002734 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine50e586b2018-06-08 14:28:46 +02002735 psa_key_type_t key_type = key_type_arg;
2736 psa_algorithm_t alg = alg_arg;
Gilles Peskinee0866522019-02-19 19:44:00 +01002737 size_t first_part_size = first_part_size_arg;
2738 size_t output1_length = output1_length_arg;
2739 size_t output2_length = output2_length_arg;
itayzafrir3e02b3b2018-06-12 17:06:52 +03002740 unsigned char *output = NULL;
Gilles Peskine50e586b2018-06-08 14:28:46 +02002741 size_t output_buffer_size = 0;
2742 size_t function_output_length = 0;
Gilles Peskinea7ec95f2018-06-08 14:40:59 +02002743 size_t total_output_length = 0;
Jaeden Amero5bae2272019-01-04 11:48:27 +00002744 psa_cipher_operation_t operation = PSA_CIPHER_OPERATION_INIT;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02002745 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine50e586b2018-06-08 14:28:46 +02002746
Gilles Peskine8817f612018-12-18 00:18:46 +01002747 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine50e586b2018-06-08 14:28:46 +02002748
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02002749 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
2750 psa_set_key_algorithm( &attributes, alg );
2751 psa_set_key_type( &attributes, key_type );
Moran Pekered346952018-07-05 15:22:45 +03002752
Ronald Cron5425a212020-08-04 14:58:35 +02002753 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
2754 &key ) );
Gilles Peskine50e586b2018-06-08 14:28:46 +02002755
Ronald Cron5425a212020-08-04 14:58:35 +02002756 PSA_ASSERT( psa_cipher_encrypt_setup( &operation, key, alg ) );
Gilles Peskine50e586b2018-06-08 14:28:46 +02002757
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02002758 if( iv->len > 0 )
2759 {
Steven Cooremana6033e92020-08-25 11:47:50 +02002760 PSA_ASSERT( psa_cipher_set_iv( &operation, iv->x, iv->len ) );
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02002761 }
2762
gabor-mezei-armceface22021-01-21 12:26:17 +01002763 output_buffer_size = PSA_CIPHER_ENCRYPT_OUTPUT_SIZE( key_type, alg, input->len );
2764 TEST_ASSERT( output_buffer_size <=
2765 PSA_CIPHER_ENCRYPT_OUTPUT_MAX_SIZE( input->len ) );
Gilles Peskine8cebbba2018-09-27 13:54:18 +02002766 ASSERT_ALLOC( output, output_buffer_size );
Gilles Peskine50e586b2018-06-08 14:28:46 +02002767
Gilles Peskinee0866522019-02-19 19:44:00 +01002768 TEST_ASSERT( first_part_size <= input->len );
Gilles Peskine8817f612018-12-18 00:18:46 +01002769 PSA_ASSERT( psa_cipher_update( &operation, input->x, first_part_size,
2770 output, output_buffer_size,
2771 &function_output_length ) );
Gilles Peskinee0866522019-02-19 19:44:00 +01002772 TEST_ASSERT( function_output_length == output1_length );
gabor-mezei-armceface22021-01-21 12:26:17 +01002773 TEST_ASSERT( function_output_length <=
2774 PSA_CIPHER_UPDATE_OUTPUT_SIZE( key_type, alg, first_part_size ) );
2775 TEST_ASSERT( function_output_length <=
2776 PSA_CIPHER_UPDATE_OUTPUT_MAX_SIZE( first_part_size) );
Gilles Peskinea7ec95f2018-06-08 14:40:59 +02002777 total_output_length += function_output_length;
gabor-mezei-armceface22021-01-21 12:26:17 +01002778
Gilles Peskine8817f612018-12-18 00:18:46 +01002779 PSA_ASSERT( psa_cipher_update( &operation,
2780 input->x + first_part_size,
2781 input->len - first_part_size,
Gilles Peskine0c510f32021-03-24 00:41:51 +01002782 ( output_buffer_size == 0 ? NULL :
2783 output + total_output_length ),
Gilles Peskineee46fe72019-02-19 19:05:33 +01002784 output_buffer_size - total_output_length,
Gilles Peskine8817f612018-12-18 00:18:46 +01002785 &function_output_length ) );
Gilles Peskinee0866522019-02-19 19:44:00 +01002786 TEST_ASSERT( function_output_length == output2_length );
gabor-mezei-armceface22021-01-21 12:26:17 +01002787 TEST_ASSERT( function_output_length <=
2788 PSA_CIPHER_UPDATE_OUTPUT_SIZE( key_type,
2789 alg,
2790 input->len - first_part_size ) );
2791 TEST_ASSERT( function_output_length <=
2792 PSA_CIPHER_UPDATE_OUTPUT_MAX_SIZE( input->len ) );
Gilles Peskinea7ec95f2018-06-08 14:40:59 +02002793 total_output_length += function_output_length;
gabor-mezei-armceface22021-01-21 12:26:17 +01002794
Gilles Peskine8817f612018-12-18 00:18:46 +01002795 PSA_ASSERT( psa_cipher_finish( &operation,
Gilles Peskine0c510f32021-03-24 00:41:51 +01002796 ( output_buffer_size == 0 ? NULL :
2797 output + total_output_length ),
Gilles Peskineee46fe72019-02-19 19:05:33 +01002798 output_buffer_size - total_output_length,
Gilles Peskine8817f612018-12-18 00:18:46 +01002799 &function_output_length ) );
gabor-mezei-armceface22021-01-21 12:26:17 +01002800 TEST_ASSERT( function_output_length <=
2801 PSA_CIPHER_FINISH_OUTPUT_SIZE( key_type, alg ) );
2802 TEST_ASSERT( function_output_length <=
2803 PSA_CIPHER_FINISH_OUTPUT_MAX_SIZE );
Gilles Peskinea7ec95f2018-06-08 14:40:59 +02002804 total_output_length += function_output_length;
Gilles Peskine8817f612018-12-18 00:18:46 +01002805 PSA_ASSERT( psa_cipher_abort( &operation ) );
Gilles Peskine50e586b2018-06-08 14:28:46 +02002806
Gilles Peskinebd7dea92018-09-27 13:57:19 +02002807 ASSERT_COMPARE( expected_output->x, expected_output->len,
2808 output, total_output_length );
Gilles Peskine50e586b2018-06-08 14:28:46 +02002809
2810exit:
Gilles Peskine64f13ef2020-08-25 23:15:20 +02002811 psa_cipher_abort( &operation );
itayzafrir3e02b3b2018-06-12 17:06:52 +03002812 mbedtls_free( output );
Ronald Cron5425a212020-08-04 14:58:35 +02002813 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02002814 PSA_DONE( );
Gilles Peskine50e586b2018-06-08 14:28:46 +02002815}
2816/* END_CASE */
2817
2818/* BEGIN_CASE */
2819void cipher_decrypt_multipart( int alg_arg, int key_type_arg,
Ronald Cron5425a212020-08-04 14:58:35 +02002820 data_t *key_data, data_t *iv,
itayzafrir3e02b3b2018-06-12 17:06:52 +03002821 data_t *input,
Gilles Peskinee0866522019-02-19 19:44:00 +01002822 int first_part_size_arg,
2823 int output1_length_arg, int output2_length_arg,
itayzafrir3e02b3b2018-06-12 17:06:52 +03002824 data_t *expected_output )
Gilles Peskine50e586b2018-06-08 14:28:46 +02002825{
Ronald Cron5425a212020-08-04 14:58:35 +02002826 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine50e586b2018-06-08 14:28:46 +02002827 psa_key_type_t key_type = key_type_arg;
2828 psa_algorithm_t alg = alg_arg;
Gilles Peskinee0866522019-02-19 19:44:00 +01002829 size_t first_part_size = first_part_size_arg;
2830 size_t output1_length = output1_length_arg;
2831 size_t output2_length = output2_length_arg;
itayzafrir3e02b3b2018-06-12 17:06:52 +03002832 unsigned char *output = NULL;
Gilles Peskine50e586b2018-06-08 14:28:46 +02002833 size_t output_buffer_size = 0;
2834 size_t function_output_length = 0;
Gilles Peskinea7ec95f2018-06-08 14:40:59 +02002835 size_t total_output_length = 0;
Jaeden Amero5bae2272019-01-04 11:48:27 +00002836 psa_cipher_operation_t operation = PSA_CIPHER_OPERATION_INIT;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02002837 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine50e586b2018-06-08 14:28:46 +02002838
Gilles Peskine8817f612018-12-18 00:18:46 +01002839 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine50e586b2018-06-08 14:28:46 +02002840
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02002841 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DECRYPT );
2842 psa_set_key_algorithm( &attributes, alg );
2843 psa_set_key_type( &attributes, key_type );
Moran Pekered346952018-07-05 15:22:45 +03002844
Ronald Cron5425a212020-08-04 14:58:35 +02002845 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
2846 &key ) );
Gilles Peskine50e586b2018-06-08 14:28:46 +02002847
Ronald Cron5425a212020-08-04 14:58:35 +02002848 PSA_ASSERT( psa_cipher_decrypt_setup( &operation, key, alg ) );
Gilles Peskine50e586b2018-06-08 14:28:46 +02002849
Steven Cooreman177deba2020-09-07 17:14:14 +02002850 if( iv->len > 0 )
2851 {
Steven Cooremana6033e92020-08-25 11:47:50 +02002852 PSA_ASSERT( psa_cipher_set_iv( &operation, iv->x, iv->len ) );
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02002853 }
Gilles Peskine50e586b2018-06-08 14:28:46 +02002854
gabor-mezei-armceface22021-01-21 12:26:17 +01002855 output_buffer_size = PSA_CIPHER_DECRYPT_OUTPUT_SIZE( key_type, alg, input->len );
2856 TEST_ASSERT( output_buffer_size <=
2857 PSA_CIPHER_DECRYPT_OUTPUT_MAX_SIZE( input->len ) );
Gilles Peskine8cebbba2018-09-27 13:54:18 +02002858 ASSERT_ALLOC( output, output_buffer_size );
Gilles Peskine50e586b2018-06-08 14:28:46 +02002859
Gilles Peskinee0866522019-02-19 19:44:00 +01002860 TEST_ASSERT( first_part_size <= input->len );
Gilles Peskine8817f612018-12-18 00:18:46 +01002861 PSA_ASSERT( psa_cipher_update( &operation,
2862 input->x, first_part_size,
2863 output, output_buffer_size,
2864 &function_output_length ) );
Gilles Peskinee0866522019-02-19 19:44:00 +01002865 TEST_ASSERT( function_output_length == output1_length );
gabor-mezei-armceface22021-01-21 12:26:17 +01002866 TEST_ASSERT( function_output_length <=
2867 PSA_CIPHER_UPDATE_OUTPUT_SIZE( key_type, alg, first_part_size ) );
2868 TEST_ASSERT( function_output_length <=
2869 PSA_CIPHER_UPDATE_OUTPUT_MAX_SIZE( first_part_size ) );
Gilles Peskinea7ec95f2018-06-08 14:40:59 +02002870 total_output_length += function_output_length;
gabor-mezei-armceface22021-01-21 12:26:17 +01002871
Gilles Peskine8817f612018-12-18 00:18:46 +01002872 PSA_ASSERT( psa_cipher_update( &operation,
2873 input->x + first_part_size,
2874 input->len - first_part_size,
Gilles Peskine0c510f32021-03-24 00:41:51 +01002875 ( output_buffer_size == 0 ? NULL :
2876 output + total_output_length ),
Gilles Peskineee46fe72019-02-19 19:05:33 +01002877 output_buffer_size - total_output_length,
Gilles Peskine8817f612018-12-18 00:18:46 +01002878 &function_output_length ) );
Gilles Peskinee0866522019-02-19 19:44:00 +01002879 TEST_ASSERT( function_output_length == output2_length );
gabor-mezei-armceface22021-01-21 12:26:17 +01002880 TEST_ASSERT( function_output_length <=
2881 PSA_CIPHER_UPDATE_OUTPUT_SIZE( key_type,
2882 alg,
2883 input->len - first_part_size ) );
2884 TEST_ASSERT( function_output_length <=
2885 PSA_CIPHER_UPDATE_OUTPUT_MAX_SIZE( input->len ) );
Gilles Peskinea7ec95f2018-06-08 14:40:59 +02002886 total_output_length += function_output_length;
gabor-mezei-armceface22021-01-21 12:26:17 +01002887
Gilles Peskine8817f612018-12-18 00:18:46 +01002888 PSA_ASSERT( psa_cipher_finish( &operation,
Gilles Peskine0c510f32021-03-24 00:41:51 +01002889 ( output_buffer_size == 0 ? NULL :
2890 output + total_output_length ),
Gilles Peskineee46fe72019-02-19 19:05:33 +01002891 output_buffer_size - total_output_length,
Gilles Peskine8817f612018-12-18 00:18:46 +01002892 &function_output_length ) );
gabor-mezei-armceface22021-01-21 12:26:17 +01002893 TEST_ASSERT( function_output_length <=
2894 PSA_CIPHER_FINISH_OUTPUT_SIZE( key_type, alg ) );
2895 TEST_ASSERT( function_output_length <=
2896 PSA_CIPHER_FINISH_OUTPUT_MAX_SIZE );
Gilles Peskinea7ec95f2018-06-08 14:40:59 +02002897 total_output_length += function_output_length;
Gilles Peskine8817f612018-12-18 00:18:46 +01002898 PSA_ASSERT( psa_cipher_abort( &operation ) );
Gilles Peskine50e586b2018-06-08 14:28:46 +02002899
Gilles Peskinebd7dea92018-09-27 13:57:19 +02002900 ASSERT_COMPARE( expected_output->x, expected_output->len,
2901 output, total_output_length );
Gilles Peskine50e586b2018-06-08 14:28:46 +02002902
2903exit:
Gilles Peskine64f13ef2020-08-25 23:15:20 +02002904 psa_cipher_abort( &operation );
itayzafrir3e02b3b2018-06-12 17:06:52 +03002905 mbedtls_free( output );
Ronald Cron5425a212020-08-04 14:58:35 +02002906 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02002907 PSA_DONE( );
Gilles Peskine50e586b2018-06-08 14:28:46 +02002908}
2909/* END_CASE */
2910
Gilles Peskine50e586b2018-06-08 14:28:46 +02002911/* BEGIN_CASE */
2912void cipher_decrypt( int alg_arg, int key_type_arg,
Ronald Cron5425a212020-08-04 14:58:35 +02002913 data_t *key_data, data_t *iv,
itayzafrir3e02b3b2018-06-12 17:06:52 +03002914 data_t *input, data_t *expected_output,
Gilles Peskineb866e2b2018-06-21 09:25:10 +02002915 int expected_status_arg )
Gilles Peskine50e586b2018-06-08 14:28:46 +02002916{
Ronald Cron5425a212020-08-04 14:58:35 +02002917 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine50e586b2018-06-08 14:28:46 +02002918 psa_status_t status;
2919 psa_key_type_t key_type = key_type_arg;
2920 psa_algorithm_t alg = alg_arg;
Gilles Peskineb866e2b2018-06-21 09:25:10 +02002921 psa_status_t expected_status = expected_status_arg;
itayzafrir3e02b3b2018-06-12 17:06:52 +03002922 unsigned char *output = NULL;
Gilles Peskine50e586b2018-06-08 14:28:46 +02002923 size_t output_buffer_size = 0;
2924 size_t function_output_length = 0;
Gilles Peskinea7ec95f2018-06-08 14:40:59 +02002925 size_t total_output_length = 0;
Jaeden Amero5bae2272019-01-04 11:48:27 +00002926 psa_cipher_operation_t operation = PSA_CIPHER_OPERATION_INIT;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02002927 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine50e586b2018-06-08 14:28:46 +02002928
Gilles Peskine8817f612018-12-18 00:18:46 +01002929 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine50e586b2018-06-08 14:28:46 +02002930
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02002931 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DECRYPT );
2932 psa_set_key_algorithm( &attributes, alg );
2933 psa_set_key_type( &attributes, key_type );
Moran Pekered346952018-07-05 15:22:45 +03002934
Ronald Cron5425a212020-08-04 14:58:35 +02002935 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
2936 &key ) );
Gilles Peskine50e586b2018-06-08 14:28:46 +02002937
Ronald Cron5425a212020-08-04 14:58:35 +02002938 PSA_ASSERT( psa_cipher_decrypt_setup( &operation, key, alg ) );
Gilles Peskine50e586b2018-06-08 14:28:46 +02002939
Steven Cooreman177deba2020-09-07 17:14:14 +02002940 if( iv->len > 0 )
2941 {
Steven Cooremana6033e92020-08-25 11:47:50 +02002942 PSA_ASSERT( psa_cipher_set_iv( &operation, iv->x, iv->len ) );
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02002943 }
Gilles Peskine50e586b2018-06-08 14:28:46 +02002944
gabor-mezei-armceface22021-01-21 12:26:17 +01002945 output_buffer_size = PSA_CIPHER_DECRYPT_OUTPUT_SIZE( key_type, alg, input->len );
2946 TEST_ASSERT( output_buffer_size <=
2947 PSA_CIPHER_DECRYPT_OUTPUT_MAX_SIZE( input->len ) );
Gilles Peskine8cebbba2018-09-27 13:54:18 +02002948 ASSERT_ALLOC( output, output_buffer_size );
Gilles Peskine50e586b2018-06-08 14:28:46 +02002949
Gilles Peskine8817f612018-12-18 00:18:46 +01002950 PSA_ASSERT( psa_cipher_update( &operation,
2951 input->x, input->len,
2952 output, output_buffer_size,
2953 &function_output_length ) );
gabor-mezei-armceface22021-01-21 12:26:17 +01002954 TEST_ASSERT( function_output_length <=
2955 PSA_CIPHER_UPDATE_OUTPUT_SIZE( key_type, alg, input->len ) );
2956 TEST_ASSERT( function_output_length <=
2957 PSA_CIPHER_UPDATE_OUTPUT_MAX_SIZE( input->len ) );
Gilles Peskinea7ec95f2018-06-08 14:40:59 +02002958 total_output_length += function_output_length;
gabor-mezei-armceface22021-01-21 12:26:17 +01002959
Gilles Peskine50e586b2018-06-08 14:28:46 +02002960 status = psa_cipher_finish( &operation,
Gilles Peskine0c510f32021-03-24 00:41:51 +01002961 ( output_buffer_size == 0 ? NULL :
2962 output + total_output_length ),
Gilles Peskineee46fe72019-02-19 19:05:33 +01002963 output_buffer_size - total_output_length,
Gilles Peskine50e586b2018-06-08 14:28:46 +02002964 &function_output_length );
gabor-mezei-armceface22021-01-21 12:26:17 +01002965 TEST_ASSERT( function_output_length <=
2966 PSA_CIPHER_FINISH_OUTPUT_SIZE( key_type, alg ) );
2967 TEST_ASSERT( function_output_length <=
2968 PSA_CIPHER_FINISH_OUTPUT_MAX_SIZE );
Gilles Peskinea7ec95f2018-06-08 14:40:59 +02002969 total_output_length += function_output_length;
Gilles Peskinefe11b722018-12-18 00:24:04 +01002970 TEST_EQUAL( status, expected_status );
Gilles Peskine50e586b2018-06-08 14:28:46 +02002971
2972 if( expected_status == PSA_SUCCESS )
2973 {
Gilles Peskine8817f612018-12-18 00:18:46 +01002974 PSA_ASSERT( psa_cipher_abort( &operation ) );
Gilles Peskinebd7dea92018-09-27 13:57:19 +02002975 ASSERT_COMPARE( expected_output->x, expected_output->len,
2976 output, total_output_length );
Gilles Peskine50e586b2018-06-08 14:28:46 +02002977 }
2978
Gilles Peskine50e586b2018-06-08 14:28:46 +02002979exit:
Gilles Peskine64f13ef2020-08-25 23:15:20 +02002980 psa_cipher_abort( &operation );
itayzafrir3e02b3b2018-06-12 17:06:52 +03002981 mbedtls_free( output );
Ronald Cron5425a212020-08-04 14:58:35 +02002982 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02002983 PSA_DONE( );
Gilles Peskine50e586b2018-06-08 14:28:46 +02002984}
2985/* END_CASE */
2986
Gilles Peskine50e586b2018-06-08 14:28:46 +02002987/* BEGIN_CASE */
2988void cipher_verify_output( int alg_arg, int key_type_arg,
Ronald Cron5425a212020-08-04 14:58:35 +02002989 data_t *key_data,
itayzafrir3e02b3b2018-06-12 17:06:52 +03002990 data_t *input )
mohammad1603d7d7ba52018-03-12 18:51:53 +02002991{
Ronald Cron5425a212020-08-04 14:58:35 +02002992 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
mohammad1603d7d7ba52018-03-12 18:51:53 +02002993 psa_key_type_t key_type = key_type_arg;
2994 psa_algorithm_t alg = alg_arg;
mohammad1603e6b67a12018-03-12 10:38:49 -07002995 unsigned char iv[16] = {0};
mohammad1603d7d7ba52018-03-12 18:51:53 +02002996 size_t iv_size = 16;
2997 size_t iv_length = 0;
itayzafrir3e02b3b2018-06-12 17:06:52 +03002998 unsigned char *output1 = NULL;
mohammad1603d7d7ba52018-03-12 18:51:53 +02002999 size_t output1_size = 0;
3000 size_t output1_length = 0;
itayzafrir3e02b3b2018-06-12 17:06:52 +03003001 unsigned char *output2 = NULL;
mohammad1603d7d7ba52018-03-12 18:51:53 +02003002 size_t output2_size = 0;
3003 size_t output2_length = 0;
Gilles Peskine048b7f02018-06-08 14:20:49 +02003004 size_t function_output_length = 0;
Jaeden Amero5bae2272019-01-04 11:48:27 +00003005 psa_cipher_operation_t operation1 = PSA_CIPHER_OPERATION_INIT;
3006 psa_cipher_operation_t operation2 = PSA_CIPHER_OPERATION_INIT;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02003007 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
mohammad1603d7d7ba52018-03-12 18:51:53 +02003008
Gilles Peskine8817f612018-12-18 00:18:46 +01003009 PSA_ASSERT( psa_crypto_init( ) );
mohammad1603d7d7ba52018-03-12 18:51:53 +02003010
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02003011 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT | PSA_KEY_USAGE_DECRYPT );
3012 psa_set_key_algorithm( &attributes, alg );
3013 psa_set_key_type( &attributes, key_type );
Moran Pekered346952018-07-05 15:22:45 +03003014
Ronald Cron5425a212020-08-04 14:58:35 +02003015 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
3016 &key ) );
mohammad1603d7d7ba52018-03-12 18:51:53 +02003017
Ronald Cron5425a212020-08-04 14:58:35 +02003018 PSA_ASSERT( psa_cipher_encrypt_setup( &operation1, key, alg ) );
3019 PSA_ASSERT( psa_cipher_decrypt_setup( &operation2, key, alg ) );
mohammad1603d7d7ba52018-03-12 18:51:53 +02003020
Steven Cooreman177deba2020-09-07 17:14:14 +02003021 if( alg != PSA_ALG_ECB_NO_PADDING )
3022 {
Steven Cooremana6033e92020-08-25 11:47:50 +02003023 PSA_ASSERT( psa_cipher_generate_iv( &operation1,
3024 iv, iv_size,
3025 &iv_length ) );
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02003026 }
gabor-mezei-armceface22021-01-21 12:26:17 +01003027 output1_size = PSA_CIPHER_ENCRYPT_OUTPUT_SIZE( key_type, alg, input->len );
3028 TEST_ASSERT( output1_size <=
3029 PSA_CIPHER_ENCRYPT_OUTPUT_MAX_SIZE( input->len ) );
Gilles Peskine8cebbba2018-09-27 13:54:18 +02003030 ASSERT_ALLOC( output1, output1_size );
Moran Pekerded84402018-06-06 16:36:50 +03003031
Gilles Peskine8817f612018-12-18 00:18:46 +01003032 PSA_ASSERT( psa_cipher_update( &operation1, input->x, input->len,
3033 output1, output1_size,
3034 &output1_length ) );
gabor-mezei-armceface22021-01-21 12:26:17 +01003035 TEST_ASSERT( output1_length <=
3036 PSA_CIPHER_UPDATE_OUTPUT_SIZE( key_type, alg, input->len ) );
3037 TEST_ASSERT( output1_length <=
3038 PSA_CIPHER_UPDATE_OUTPUT_MAX_SIZE( input->len ) );
3039
Gilles Peskine8817f612018-12-18 00:18:46 +01003040 PSA_ASSERT( psa_cipher_finish( &operation1,
Gilles Peskineee46fe72019-02-19 19:05:33 +01003041 output1 + output1_length,
3042 output1_size - output1_length,
Gilles Peskine8817f612018-12-18 00:18:46 +01003043 &function_output_length ) );
gabor-mezei-armceface22021-01-21 12:26:17 +01003044 TEST_ASSERT( function_output_length <=
3045 PSA_CIPHER_FINISH_OUTPUT_SIZE( key_type, alg ) );
3046 TEST_ASSERT( function_output_length <=
3047 PSA_CIPHER_FINISH_OUTPUT_MAX_SIZE );
Gilles Peskine4ca9c3f2018-06-06 18:44:09 +02003048
Gilles Peskine048b7f02018-06-08 14:20:49 +02003049 output1_length += function_output_length;
Moran Pekerded84402018-06-06 16:36:50 +03003050
Gilles Peskine8817f612018-12-18 00:18:46 +01003051 PSA_ASSERT( psa_cipher_abort( &operation1 ) );
Moran Pekerded84402018-06-06 16:36:50 +03003052
3053 output2_size = output1_length;
gabor-mezei-armceface22021-01-21 12:26:17 +01003054 TEST_ASSERT( output2_size <=
3055 PSA_CIPHER_DECRYPT_OUTPUT_SIZE( key_type, alg, output1_length ) );
3056 TEST_ASSERT( output2_size <=
3057 PSA_CIPHER_DECRYPT_OUTPUT_MAX_SIZE( output1_length ) );
Gilles Peskine8cebbba2018-09-27 13:54:18 +02003058 ASSERT_ALLOC( output2, output2_size );
Moran Pekerded84402018-06-06 16:36:50 +03003059
Steven Cooreman177deba2020-09-07 17:14:14 +02003060 if( iv_length > 0 )
3061 {
Steven Cooremana6033e92020-08-25 11:47:50 +02003062 PSA_ASSERT( psa_cipher_set_iv( &operation2,
3063 iv, iv_length ) );
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02003064 }
3065
Gilles Peskine8817f612018-12-18 00:18:46 +01003066 PSA_ASSERT( psa_cipher_update( &operation2, output1, output1_length,
3067 output2, output2_size,
3068 &output2_length ) );
gabor-mezei-armceface22021-01-21 12:26:17 +01003069 TEST_ASSERT( output2_length <=
3070 PSA_CIPHER_UPDATE_OUTPUT_SIZE( key_type, alg, output1_length ) );
3071 TEST_ASSERT( output2_length <=
3072 PSA_CIPHER_UPDATE_OUTPUT_MAX_SIZE( output1_length ) );
3073
Gilles Peskine048b7f02018-06-08 14:20:49 +02003074 function_output_length = 0;
Gilles Peskine8817f612018-12-18 00:18:46 +01003075 PSA_ASSERT( psa_cipher_finish( &operation2,
3076 output2 + output2_length,
Gilles Peskineee46fe72019-02-19 19:05:33 +01003077 output2_size - output2_length,
Gilles Peskine8817f612018-12-18 00:18:46 +01003078 &function_output_length ) );
gabor-mezei-armceface22021-01-21 12:26:17 +01003079 TEST_ASSERT( function_output_length <=
3080 PSA_CIPHER_FINISH_OUTPUT_SIZE( key_type, alg ) );
3081 TEST_ASSERT( function_output_length <=
3082 PSA_CIPHER_FINISH_OUTPUT_MAX_SIZE );
Moran Pekerded84402018-06-06 16:36:50 +03003083
Gilles Peskine048b7f02018-06-08 14:20:49 +02003084 output2_length += function_output_length;
Gilles Peskine4ca9c3f2018-06-06 18:44:09 +02003085
Gilles Peskine8817f612018-12-18 00:18:46 +01003086 PSA_ASSERT( psa_cipher_abort( &operation2 ) );
Moran Pekerded84402018-06-06 16:36:50 +03003087
Gilles Peskinebd7dea92018-09-27 13:57:19 +02003088 ASSERT_COMPARE( input->x, input->len, output2, output2_length );
Moran Pekerded84402018-06-06 16:36:50 +03003089
3090exit:
Gilles Peskine64f13ef2020-08-25 23:15:20 +02003091 psa_cipher_abort( &operation1 );
3092 psa_cipher_abort( &operation2 );
itayzafrir3e02b3b2018-06-12 17:06:52 +03003093 mbedtls_free( output1 );
3094 mbedtls_free( output2 );
Ronald Cron5425a212020-08-04 14:58:35 +02003095 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02003096 PSA_DONE( );
Moran Pekerded84402018-06-06 16:36:50 +03003097}
3098/* END_CASE */
3099
3100/* BEGIN_CASE */
Gilles Peskine50e586b2018-06-08 14:28:46 +02003101void cipher_verify_output_multipart( int alg_arg,
3102 int key_type_arg,
Ronald Cron5425a212020-08-04 14:58:35 +02003103 data_t *key_data,
itayzafrir3e02b3b2018-06-12 17:06:52 +03003104 data_t *input,
Gilles Peskinee0866522019-02-19 19:44:00 +01003105 int first_part_size_arg )
Moran Pekerded84402018-06-06 16:36:50 +03003106{
Ronald Cron5425a212020-08-04 14:58:35 +02003107 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Moran Pekerded84402018-06-06 16:36:50 +03003108 psa_key_type_t key_type = key_type_arg;
3109 psa_algorithm_t alg = alg_arg;
Gilles Peskinee0866522019-02-19 19:44:00 +01003110 size_t first_part_size = first_part_size_arg;
Moran Pekerded84402018-06-06 16:36:50 +03003111 unsigned char iv[16] = {0};
3112 size_t iv_size = 16;
3113 size_t iv_length = 0;
itayzafrir3e02b3b2018-06-12 17:06:52 +03003114 unsigned char *output1 = NULL;
Gilles Peskine048b7f02018-06-08 14:20:49 +02003115 size_t output1_buffer_size = 0;
Moran Pekerded84402018-06-06 16:36:50 +03003116 size_t output1_length = 0;
itayzafrir3e02b3b2018-06-12 17:06:52 +03003117 unsigned char *output2 = NULL;
Gilles Peskine048b7f02018-06-08 14:20:49 +02003118 size_t output2_buffer_size = 0;
Moran Pekerded84402018-06-06 16:36:50 +03003119 size_t output2_length = 0;
Gilles Peskine048b7f02018-06-08 14:20:49 +02003120 size_t function_output_length;
Jaeden Amero5bae2272019-01-04 11:48:27 +00003121 psa_cipher_operation_t operation1 = PSA_CIPHER_OPERATION_INIT;
3122 psa_cipher_operation_t operation2 = PSA_CIPHER_OPERATION_INIT;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02003123 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Moran Pekerded84402018-06-06 16:36:50 +03003124
Gilles Peskine8817f612018-12-18 00:18:46 +01003125 PSA_ASSERT( psa_crypto_init( ) );
Moran Pekerded84402018-06-06 16:36:50 +03003126
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02003127 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT | PSA_KEY_USAGE_DECRYPT );
3128 psa_set_key_algorithm( &attributes, alg );
3129 psa_set_key_type( &attributes, key_type );
Moran Pekered346952018-07-05 15:22:45 +03003130
Ronald Cron5425a212020-08-04 14:58:35 +02003131 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
3132 &key ) );
Moran Pekerded84402018-06-06 16:36:50 +03003133
Ronald Cron5425a212020-08-04 14:58:35 +02003134 PSA_ASSERT( psa_cipher_encrypt_setup( &operation1, key, alg ) );
3135 PSA_ASSERT( psa_cipher_decrypt_setup( &operation2, key, alg ) );
Moran Pekerded84402018-06-06 16:36:50 +03003136
Steven Cooreman177deba2020-09-07 17:14:14 +02003137 if( alg != PSA_ALG_ECB_NO_PADDING )
3138 {
Steven Cooremana6033e92020-08-25 11:47:50 +02003139 PSA_ASSERT( psa_cipher_generate_iv( &operation1,
3140 iv, iv_size,
3141 &iv_length ) );
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02003142 }
3143
gabor-mezei-armceface22021-01-21 12:26:17 +01003144 output1_buffer_size = PSA_CIPHER_ENCRYPT_OUTPUT_SIZE( key_type, alg, input->len );
3145 TEST_ASSERT( output1_buffer_size <=
3146 PSA_CIPHER_ENCRYPT_OUTPUT_MAX_SIZE( input->len ) );
Gilles Peskine8cebbba2018-09-27 13:54:18 +02003147 ASSERT_ALLOC( output1, output1_buffer_size );
Moran Pekerded84402018-06-06 16:36:50 +03003148
Gilles Peskinee0866522019-02-19 19:44:00 +01003149 TEST_ASSERT( first_part_size <= input->len );
Gilles Peskine4ca9c3f2018-06-06 18:44:09 +02003150
Gilles Peskine8817f612018-12-18 00:18:46 +01003151 PSA_ASSERT( psa_cipher_update( &operation1, input->x, first_part_size,
3152 output1, output1_buffer_size,
3153 &function_output_length ) );
gabor-mezei-armceface22021-01-21 12:26:17 +01003154 TEST_ASSERT( function_output_length <=
3155 PSA_CIPHER_UPDATE_OUTPUT_SIZE( key_type, alg, first_part_size ) );
3156 TEST_ASSERT( function_output_length <=
3157 PSA_CIPHER_UPDATE_OUTPUT_MAX_SIZE( first_part_size ) );
Gilles Peskine048b7f02018-06-08 14:20:49 +02003158 output1_length += function_output_length;
Moran Pekerded84402018-06-06 16:36:50 +03003159
Gilles Peskine8817f612018-12-18 00:18:46 +01003160 PSA_ASSERT( psa_cipher_update( &operation1,
3161 input->x + first_part_size,
3162 input->len - first_part_size,
3163 output1, output1_buffer_size,
3164 &function_output_length ) );
gabor-mezei-armceface22021-01-21 12:26:17 +01003165 TEST_ASSERT( function_output_length <=
3166 PSA_CIPHER_UPDATE_OUTPUT_SIZE( key_type,
3167 alg,
3168 input->len - first_part_size ) );
3169 TEST_ASSERT( function_output_length <=
3170 PSA_CIPHER_UPDATE_OUTPUT_MAX_SIZE( input->len - first_part_size ) );
Gilles Peskine048b7f02018-06-08 14:20:49 +02003171 output1_length += function_output_length;
Moran Pekerded84402018-06-06 16:36:50 +03003172
Gilles Peskine8817f612018-12-18 00:18:46 +01003173 PSA_ASSERT( psa_cipher_finish( &operation1,
3174 output1 + output1_length,
3175 output1_buffer_size - output1_length,
3176 &function_output_length ) );
gabor-mezei-armceface22021-01-21 12:26:17 +01003177 TEST_ASSERT( function_output_length <=
3178 PSA_CIPHER_FINISH_OUTPUT_SIZE( key_type, alg ) );
3179 TEST_ASSERT( function_output_length <=
3180 PSA_CIPHER_FINISH_OUTPUT_MAX_SIZE );
Gilles Peskine048b7f02018-06-08 14:20:49 +02003181 output1_length += function_output_length;
mohammad1603d7d7ba52018-03-12 18:51:53 +02003182
Gilles Peskine8817f612018-12-18 00:18:46 +01003183 PSA_ASSERT( psa_cipher_abort( &operation1 ) );
mohammad1603d7d7ba52018-03-12 18:51:53 +02003184
Gilles Peskine048b7f02018-06-08 14:20:49 +02003185 output2_buffer_size = output1_length;
gabor-mezei-armceface22021-01-21 12:26:17 +01003186 TEST_ASSERT( output2_buffer_size <=
3187 PSA_CIPHER_DECRYPT_OUTPUT_SIZE( key_type, alg, output1_length ) );
3188 TEST_ASSERT( output2_buffer_size <=
3189 PSA_CIPHER_DECRYPT_OUTPUT_MAX_SIZE( output1_length ) );
Gilles Peskine8cebbba2018-09-27 13:54:18 +02003190 ASSERT_ALLOC( output2, output2_buffer_size );
mohammad1603d7d7ba52018-03-12 18:51:53 +02003191
Steven Cooreman177deba2020-09-07 17:14:14 +02003192 if( iv_length > 0 )
3193 {
Steven Cooremana6033e92020-08-25 11:47:50 +02003194 PSA_ASSERT( psa_cipher_set_iv( &operation2,
3195 iv, iv_length ) );
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02003196 }
Moran Pekerded84402018-06-06 16:36:50 +03003197
Gilles Peskine8817f612018-12-18 00:18:46 +01003198 PSA_ASSERT( psa_cipher_update( &operation2, output1, first_part_size,
3199 output2, output2_buffer_size,
3200 &function_output_length ) );
gabor-mezei-armceface22021-01-21 12:26:17 +01003201 TEST_ASSERT( function_output_length <=
3202 PSA_CIPHER_UPDATE_OUTPUT_SIZE( key_type, alg, first_part_size ) );
3203 TEST_ASSERT( function_output_length <=
3204 PSA_CIPHER_UPDATE_OUTPUT_MAX_SIZE( first_part_size ) );
Gilles Peskine048b7f02018-06-08 14:20:49 +02003205 output2_length += function_output_length;
Moran Pekerded84402018-06-06 16:36:50 +03003206
Gilles Peskine8817f612018-12-18 00:18:46 +01003207 PSA_ASSERT( psa_cipher_update( &operation2,
3208 output1 + first_part_size,
3209 output1_length - first_part_size,
3210 output2, output2_buffer_size,
3211 &function_output_length ) );
gabor-mezei-armceface22021-01-21 12:26:17 +01003212 TEST_ASSERT( function_output_length <=
3213 PSA_CIPHER_UPDATE_OUTPUT_SIZE( key_type,
3214 alg,
3215 output1_length - first_part_size ) );
3216 TEST_ASSERT( function_output_length <=
3217 PSA_CIPHER_UPDATE_OUTPUT_MAX_SIZE( output1_length - first_part_size ) );
Gilles Peskine048b7f02018-06-08 14:20:49 +02003218 output2_length += function_output_length;
Moran Pekerded84402018-06-06 16:36:50 +03003219
Gilles Peskine8817f612018-12-18 00:18:46 +01003220 PSA_ASSERT( psa_cipher_finish( &operation2,
3221 output2 + output2_length,
3222 output2_buffer_size - output2_length,
3223 &function_output_length ) );
gabor-mezei-armceface22021-01-21 12:26:17 +01003224 TEST_ASSERT( function_output_length <=
3225 PSA_CIPHER_FINISH_OUTPUT_SIZE( key_type, alg ) );
3226 TEST_ASSERT( function_output_length <=
3227 PSA_CIPHER_FINISH_OUTPUT_MAX_SIZE );
Gilles Peskine048b7f02018-06-08 14:20:49 +02003228 output2_length += function_output_length;
Gilles Peskine4ca9c3f2018-06-06 18:44:09 +02003229
Gilles Peskine8817f612018-12-18 00:18:46 +01003230 PSA_ASSERT( psa_cipher_abort( &operation2 ) );
mohammad1603d7d7ba52018-03-12 18:51:53 +02003231
Gilles Peskinebd7dea92018-09-27 13:57:19 +02003232 ASSERT_COMPARE( input->x, input->len, output2, output2_length );
mohammad1603d7d7ba52018-03-12 18:51:53 +02003233
3234exit:
Gilles Peskine64f13ef2020-08-25 23:15:20 +02003235 psa_cipher_abort( &operation1 );
3236 psa_cipher_abort( &operation2 );
itayzafrir3e02b3b2018-06-12 17:06:52 +03003237 mbedtls_free( output1 );
3238 mbedtls_free( output2 );
Ronald Cron5425a212020-08-04 14:58:35 +02003239 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02003240 PSA_DONE( );
mohammad1603d7d7ba52018-03-12 18:51:53 +02003241}
3242/* END_CASE */
Gilles Peskine7268afc2018-06-06 15:19:24 +02003243
Gilles Peskine20035e32018-02-03 22:44:14 +01003244/* BEGIN_CASE */
Gilles Peskine7da96b02018-08-17 18:45:42 +02003245void aead_encrypt_decrypt( int key_type_arg, data_t *key_data,
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02003246 int alg_arg,
Gilles Peskine7da96b02018-08-17 18:45:42 +02003247 data_t *nonce,
3248 data_t *additional_data,
3249 data_t *input_data,
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02003250 int expected_result_arg )
Gilles Peskinea1cac842018-06-11 19:33:02 +02003251{
Ronald Cron5425a212020-08-04 14:58:35 +02003252 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskinea1cac842018-06-11 19:33:02 +02003253 psa_key_type_t key_type = key_type_arg;
3254 psa_algorithm_t alg = alg_arg;
Bence Szépkútiec174e22021-03-19 18:46:15 +01003255 size_t key_bits;
Gilles Peskinea1cac842018-06-11 19:33:02 +02003256 unsigned char *output_data = NULL;
3257 size_t output_size = 0;
3258 size_t output_length = 0;
3259 unsigned char *output_data2 = NULL;
3260 size_t output_length2 = 0;
Steven Cooremanf49478b2021-02-15 15:19:25 +01003261 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Gilles Peskine4abf7412018-06-18 16:35:34 +02003262 psa_status_t expected_result = expected_result_arg;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02003263 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskinea1cac842018-06-11 19:33:02 +02003264
Gilles Peskine8817f612018-12-18 00:18:46 +01003265 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003266
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02003267 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT | PSA_KEY_USAGE_DECRYPT );
3268 psa_set_key_algorithm( &attributes, alg );
3269 psa_set_key_type( &attributes, key_type );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003270
Gilles Peskine049c7532019-05-15 20:22:09 +02003271 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02003272 &key ) );
Bence Szépkútiec174e22021-03-19 18:46:15 +01003273 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
3274 key_bits = psa_get_key_bits( &attributes );
3275
3276 output_size = input_data->len + PSA_AEAD_TAG_LENGTH( key_type, key_bits,
3277 alg );
3278 /* For all currently defined algorithms, PSA_AEAD_ENCRYPT_OUTPUT_SIZE
3279 * should be exact. */
3280 if( expected_result != PSA_ERROR_INVALID_ARGUMENT &&
3281 expected_result != PSA_ERROR_NOT_SUPPORTED )
3282 {
3283 TEST_EQUAL( output_size,
3284 PSA_AEAD_ENCRYPT_OUTPUT_SIZE( key_type, alg, input_data->len ) );
3285 TEST_ASSERT( output_size <=
3286 PSA_AEAD_ENCRYPT_OUTPUT_MAX_SIZE( input_data->len ) );
3287 }
3288 ASSERT_ALLOC( output_data, output_size );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003289
Steven Cooremanf49478b2021-02-15 15:19:25 +01003290 status = psa_aead_encrypt( key, alg,
3291 nonce->x, nonce->len,
3292 additional_data->x,
3293 additional_data->len,
3294 input_data->x, input_data->len,
3295 output_data, output_size,
3296 &output_length );
3297
3298 /* If the operation is not supported, just skip and not fail in case the
3299 * encryption involves a common limitation of cryptography hardwares and
3300 * an alternative implementation. */
3301 if( status == PSA_ERROR_NOT_SUPPORTED )
3302 {
3303 MBEDTLS_TEST_PSA_SKIP_IF_ALT_AES_192( key_type, key_data->len * 8 );
3304 MBEDTLS_TEST_PSA_SKIP_IF_ALT_GCM_NOT_12BYTES_NONCE( alg, nonce->len );
3305 }
3306
3307 TEST_EQUAL( status, expected_result );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003308
3309 if( PSA_SUCCESS == expected_result )
3310 {
Gilles Peskine8cebbba2018-09-27 13:54:18 +02003311 ASSERT_ALLOC( output_data2, output_length );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003312
Gilles Peskine003a4a92019-05-14 16:09:40 +02003313 /* For all currently defined algorithms, PSA_AEAD_DECRYPT_OUTPUT_SIZE
3314 * should be exact. */
3315 TEST_EQUAL( input_data->len,
Bence Szépkútiec174e22021-03-19 18:46:15 +01003316 PSA_AEAD_DECRYPT_OUTPUT_SIZE( key_type, alg, output_length ) );
Gilles Peskine003a4a92019-05-14 16:09:40 +02003317
gabor-mezei-armceface22021-01-21 12:26:17 +01003318 TEST_ASSERT( input_data->len <=
3319 PSA_AEAD_DECRYPT_OUTPUT_MAX_SIZE( output_length ) );
3320
Ronald Cron5425a212020-08-04 14:58:35 +02003321 TEST_EQUAL( psa_aead_decrypt( key, alg,
Gilles Peskinefe11b722018-12-18 00:24:04 +01003322 nonce->x, nonce->len,
3323 additional_data->x,
3324 additional_data->len,
3325 output_data, output_length,
3326 output_data2, output_length,
Gilles Peskinef812dcf2018-12-18 00:33:25 +01003327 &output_length2 ),
3328 expected_result );
Gilles Peskine2d277862018-06-18 15:41:12 +02003329
Gilles Peskinebd7dea92018-09-27 13:57:19 +02003330 ASSERT_COMPARE( input_data->x, input_data->len,
3331 output_data2, output_length2 );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003332 }
Gilles Peskine2d277862018-06-18 15:41:12 +02003333
Gilles Peskinea1cac842018-06-11 19:33:02 +02003334exit:
Ronald Cron5425a212020-08-04 14:58:35 +02003335 psa_destroy_key( key );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003336 mbedtls_free( output_data );
3337 mbedtls_free( output_data2 );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02003338 PSA_DONE( );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003339}
3340/* END_CASE */
3341
3342/* BEGIN_CASE */
Gilles Peskine7da96b02018-08-17 18:45:42 +02003343void aead_encrypt( int key_type_arg, data_t *key_data,
3344 int alg_arg,
3345 data_t *nonce,
3346 data_t *additional_data,
3347 data_t *input_data,
3348 data_t *expected_result )
Gilles Peskinea1cac842018-06-11 19:33:02 +02003349{
Ronald Cron5425a212020-08-04 14:58:35 +02003350 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskinea1cac842018-06-11 19:33:02 +02003351 psa_key_type_t key_type = key_type_arg;
3352 psa_algorithm_t alg = alg_arg;
Bence Szépkútiec174e22021-03-19 18:46:15 +01003353 size_t key_bits;
Gilles Peskinea1cac842018-06-11 19:33:02 +02003354 unsigned char *output_data = NULL;
3355 size_t output_size = 0;
3356 size_t output_length = 0;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02003357 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Steven Cooremand588ea12021-01-11 19:36:04 +01003358 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Gilles Peskinea1cac842018-06-11 19:33:02 +02003359
Gilles Peskine8817f612018-12-18 00:18:46 +01003360 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003361
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02003362 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
3363 psa_set_key_algorithm( &attributes, alg );
3364 psa_set_key_type( &attributes, key_type );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003365
Gilles Peskine049c7532019-05-15 20:22:09 +02003366 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02003367 &key ) );
Bence Szépkútiec174e22021-03-19 18:46:15 +01003368 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
3369 key_bits = psa_get_key_bits( &attributes );
3370
3371 output_size = input_data->len + PSA_AEAD_TAG_LENGTH( key_type, key_bits,
3372 alg );
3373 /* For all currently defined algorithms, PSA_AEAD_ENCRYPT_OUTPUT_SIZE
3374 * should be exact. */
3375 TEST_EQUAL( output_size,
3376 PSA_AEAD_ENCRYPT_OUTPUT_SIZE( key_type, alg, input_data->len ) );
3377 TEST_ASSERT( output_size <=
3378 PSA_AEAD_ENCRYPT_OUTPUT_MAX_SIZE( input_data->len ) );
3379 ASSERT_ALLOC( output_data, output_size );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003380
Steven Cooremand588ea12021-01-11 19:36:04 +01003381 status = psa_aead_encrypt( key, alg,
3382 nonce->x, nonce->len,
3383 additional_data->x, additional_data->len,
3384 input_data->x, input_data->len,
3385 output_data, output_size,
3386 &output_length );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003387
Ronald Cron28a45ed2021-02-09 20:35:42 +01003388 /* If the operation is not supported, just skip and not fail in case the
3389 * encryption involves a common limitation of cryptography hardwares and
3390 * an alternative implementation. */
3391 if( status == PSA_ERROR_NOT_SUPPORTED )
Steven Cooremand588ea12021-01-11 19:36:04 +01003392 {
Ronald Cron28a45ed2021-02-09 20:35:42 +01003393 MBEDTLS_TEST_PSA_SKIP_IF_ALT_AES_192( key_type, key_data->len * 8 );
3394 MBEDTLS_TEST_PSA_SKIP_IF_ALT_GCM_NOT_12BYTES_NONCE( alg, nonce->len );
Steven Cooremand588ea12021-01-11 19:36:04 +01003395 }
Steven Cooremand588ea12021-01-11 19:36:04 +01003396
3397 PSA_ASSERT( status );
Gilles Peskinebd7dea92018-09-27 13:57:19 +02003398 ASSERT_COMPARE( expected_result->x, expected_result->len,
3399 output_data, output_length );
Gilles Peskine2d277862018-06-18 15:41:12 +02003400
Gilles Peskinea1cac842018-06-11 19:33:02 +02003401exit:
Ronald Cron5425a212020-08-04 14:58:35 +02003402 psa_destroy_key( key );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003403 mbedtls_free( output_data );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02003404 PSA_DONE( );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003405}
3406/* END_CASE */
3407
3408/* BEGIN_CASE */
Gilles Peskine7da96b02018-08-17 18:45:42 +02003409void aead_decrypt( int key_type_arg, data_t *key_data,
3410 int alg_arg,
3411 data_t *nonce,
3412 data_t *additional_data,
3413 data_t *input_data,
3414 data_t *expected_data,
3415 int expected_result_arg )
Gilles Peskinea1cac842018-06-11 19:33:02 +02003416{
Ronald Cron5425a212020-08-04 14:58:35 +02003417 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskinea1cac842018-06-11 19:33:02 +02003418 psa_key_type_t key_type = key_type_arg;
3419 psa_algorithm_t alg = alg_arg;
Bence Szépkútiec174e22021-03-19 18:46:15 +01003420 size_t key_bits;
Gilles Peskinea1cac842018-06-11 19:33:02 +02003421 unsigned char *output_data = NULL;
3422 size_t output_size = 0;
3423 size_t output_length = 0;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02003424 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine4abf7412018-06-18 16:35:34 +02003425 psa_status_t expected_result = expected_result_arg;
Steven Cooremand588ea12021-01-11 19:36:04 +01003426 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Gilles Peskinea1cac842018-06-11 19:33:02 +02003427
Gilles Peskine8817f612018-12-18 00:18:46 +01003428 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003429
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02003430 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DECRYPT );
3431 psa_set_key_algorithm( &attributes, alg );
3432 psa_set_key_type( &attributes, key_type );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003433
Gilles Peskine049c7532019-05-15 20:22:09 +02003434 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02003435 &key ) );
Bence Szépkútiec174e22021-03-19 18:46:15 +01003436 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
3437 key_bits = psa_get_key_bits( &attributes );
3438
3439 output_size = input_data->len - PSA_AEAD_TAG_LENGTH( key_type, key_bits,
3440 alg );
3441 if( expected_result != PSA_ERROR_INVALID_ARGUMENT &&
3442 expected_result != PSA_ERROR_NOT_SUPPORTED )
3443 {
3444 /* For all currently defined algorithms, PSA_AEAD_DECRYPT_OUTPUT_SIZE
3445 * should be exact. */
3446 TEST_EQUAL( output_size,
3447 PSA_AEAD_DECRYPT_OUTPUT_SIZE( key_type, alg, input_data->len ) );
3448 TEST_ASSERT( output_size <=
3449 PSA_AEAD_DECRYPT_OUTPUT_MAX_SIZE( input_data->len ) );
3450 }
3451 ASSERT_ALLOC( output_data, output_size );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003452
Steven Cooremand588ea12021-01-11 19:36:04 +01003453 status = psa_aead_decrypt( key, alg,
3454 nonce->x, nonce->len,
3455 additional_data->x,
3456 additional_data->len,
3457 input_data->x, input_data->len,
3458 output_data, output_size,
3459 &output_length );
3460
Ronald Cron28a45ed2021-02-09 20:35:42 +01003461 /* If the operation is not supported, just skip and not fail in case the
3462 * decryption involves a common limitation of cryptography hardwares and
3463 * an alternative implementation. */
3464 if( status == PSA_ERROR_NOT_SUPPORTED )
Steven Cooremand588ea12021-01-11 19:36:04 +01003465 {
Ronald Cron28a45ed2021-02-09 20:35:42 +01003466 MBEDTLS_TEST_PSA_SKIP_IF_ALT_AES_192( key_type, key_data->len * 8 );
3467 MBEDTLS_TEST_PSA_SKIP_IF_ALT_GCM_NOT_12BYTES_NONCE( alg, nonce->len );
Steven Cooremand588ea12021-01-11 19:36:04 +01003468 }
Steven Cooremand588ea12021-01-11 19:36:04 +01003469
3470 TEST_EQUAL( status, expected_result );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003471
Gilles Peskine2d277862018-06-18 15:41:12 +02003472 if( expected_result == PSA_SUCCESS )
Gilles Peskinebd7dea92018-09-27 13:57:19 +02003473 ASSERT_COMPARE( expected_data->x, expected_data->len,
3474 output_data, output_length );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003475
Gilles Peskinea1cac842018-06-11 19:33:02 +02003476exit:
Ronald Cron5425a212020-08-04 14:58:35 +02003477 psa_destroy_key( key );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003478 mbedtls_free( output_data );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02003479 PSA_DONE( );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003480}
3481/* END_CASE */
3482
3483/* BEGIN_CASE */
Paul Elliott0023e0a2021-04-27 10:06:22 +01003484void aead_multipart_encrypt( int key_type_arg, data_t *key_data,
3485 int alg_arg,
3486 data_t *nonce,
3487 data_t *additional_data,
Paul Elliott97fd1ba2021-07-21 18:46:06 +01003488 int do_test_ad_chunked,
Paul Elliott0023e0a2021-04-27 10:06:22 +01003489 data_t *input_data,
Paul Elliott97fd1ba2021-07-21 18:46:06 +01003490 int do_test_data_chunked,
3491 int do_set_lengths,
3492 data_t *expected_output )
Paul Elliott0023e0a2021-04-27 10:06:22 +01003493{
Paul Elliottd3f82412021-06-16 16:52:21 +01003494 size_t ad_part_len = 0;
3495 size_t data_part_len = 0;
Paul Elliott0023e0a2021-04-27 10:06:22 +01003496
Paul Elliott97fd1ba2021-07-21 18:46:06 +01003497 TEST_ASSERT( do_test_ad_chunked || do_test_data_chunked );
3498
3499 /* Temporary whilst we have algorithms that cannot support chunking */
3500 if( do_test_ad_chunked == 1 )
Paul Elliott0023e0a2021-04-27 10:06:22 +01003501 {
Paul Elliottd3f82412021-06-16 16:52:21 +01003502 for( ad_part_len = 1; ad_part_len <= additional_data->len;
3503 ad_part_len++ )
Paul Elliott0023e0a2021-04-27 10:06:22 +01003504 {
Paul Elliottd3f82412021-06-16 16:52:21 +01003505 mbedtls_test_set_step( ad_part_len );
Paul Elliott0023e0a2021-04-27 10:06:22 +01003506
Paul Elliott329d5382021-07-22 17:10:45 +01003507 /* Split ad into length(ad_part_len) parts. */
Paul Elliott97fd1ba2021-07-21 18:46:06 +01003508 if( !aead_multipart_internal_func( key_type_arg, key_data,
3509 alg_arg, nonce,
3510 additional_data,
3511 ad_part_len,
3512 input_data, -1,
3513 do_set_lengths,
3514 expected_output,
Paul Elliottebf91632021-07-22 17:54:42 +01003515 1, 1, 0,
3516 ( ad_part_len & 0x01 ) ) )
Paul Elliott329d5382021-07-22 17:10:45 +01003517 break;
3518
3519 /* length(0) part, length(ad_part_len) part, length(0) part... */
3520 mbedtls_test_set_step( 1000 + ad_part_len );
3521
3522 if( !aead_multipart_internal_func( key_type_arg, key_data,
3523 alg_arg, nonce,
3524 additional_data,
3525 ad_part_len,
3526 input_data, -1,
3527 do_set_lengths,
3528 expected_output,
Paul Elliottebf91632021-07-22 17:54:42 +01003529 1, 1, 1,
3530 ( ad_part_len & 0x01 ) ) )
Paul Elliott97fd1ba2021-07-21 18:46:06 +01003531 break;
Paul Elliott0023e0a2021-04-27 10:06:22 +01003532 }
3533 }
Paul Elliottd3f82412021-06-16 16:52:21 +01003534
Paul Elliott97fd1ba2021-07-21 18:46:06 +01003535 /* Temporary whilst we have algorithms that cannot support chunking */
3536 if( do_test_data_chunked == 1 )
Paul Elliott0023e0a2021-04-27 10:06:22 +01003537 {
Paul Elliottd3f82412021-06-16 16:52:21 +01003538 for( data_part_len = 1; data_part_len <= input_data->len;
3539 data_part_len++ )
Paul Elliott0023e0a2021-04-27 10:06:22 +01003540 {
Paul Elliott329d5382021-07-22 17:10:45 +01003541 /* Split data into length(data_part_len) parts. */
3542 mbedtls_test_set_step( 2000 + data_part_len );
Paul Elliott97fd1ba2021-07-21 18:46:06 +01003543
3544 if( !aead_multipart_internal_func( key_type_arg, key_data,
3545 alg_arg, nonce,
3546 additional_data, -1,
3547 input_data, data_part_len,
3548 do_set_lengths,
3549 expected_output,
Paul Elliottebf91632021-07-22 17:54:42 +01003550 1, 1, 0,
3551 ( data_part_len & 0x01 ) ) )
Paul Elliott329d5382021-07-22 17:10:45 +01003552 break;
3553
3554 /* length(0) part, length(data_part_len) part, length(0) part... */
3555 mbedtls_test_set_step( 3000 + data_part_len );
3556
3557 if( !aead_multipart_internal_func( key_type_arg, key_data,
3558 alg_arg, nonce,
3559 additional_data, -1,
3560 input_data, data_part_len,
3561 do_set_lengths,
3562 expected_output,
Paul Elliottebf91632021-07-22 17:54:42 +01003563 1, 1, 1,
3564 ( data_part_len & 0x01 ) ) )
Paul Elliott97fd1ba2021-07-21 18:46:06 +01003565 break;
Paul Elliott0023e0a2021-04-27 10:06:22 +01003566 }
3567 }
Paul Elliott0023e0a2021-04-27 10:06:22 +01003568
Paul Elliott0023e0a2021-04-27 10:06:22 +01003569
Paul Elliott8fc45162021-06-23 16:06:01 +01003570 /* Goto is required to silence warnings about unused labels, as we
3571 * don't actually do any test assertions in this function. */
3572 goto exit;
Paul Elliott0023e0a2021-04-27 10:06:22 +01003573}
3574/* END_CASE */
3575
3576/* BEGIN_CASE */
Paul Elliott0023e0a2021-04-27 10:06:22 +01003577void aead_multipart_decrypt( int key_type_arg, data_t *key_data,
3578 int alg_arg,
3579 data_t *nonce,
3580 data_t *additional_data,
Paul Elliott97fd1ba2021-07-21 18:46:06 +01003581 int do_test_ad_chunked,
Paul Elliott0023e0a2021-04-27 10:06:22 +01003582 data_t *input_data,
Paul Elliott97fd1ba2021-07-21 18:46:06 +01003583 int do_test_data_chunked,
3584 int do_set_lengths,
3585 data_t *expected_output,
3586 int expect_valid_signature )
Paul Elliott0023e0a2021-04-27 10:06:22 +01003587{
Paul Elliottd3f82412021-06-16 16:52:21 +01003588 size_t ad_part_len = 0;
3589 size_t data_part_len = 0;
Paul Elliott0023e0a2021-04-27 10:06:22 +01003590
Paul Elliott97fd1ba2021-07-21 18:46:06 +01003591 /* Temporary whilst we have algorithms that cannot support chunking */
3592 if( do_test_ad_chunked == 1 )
Paul Elliott0023e0a2021-04-27 10:06:22 +01003593 {
Paul Elliottd3f82412021-06-16 16:52:21 +01003594 for( ad_part_len = 1; ad_part_len <= additional_data->len;
3595 ad_part_len++ )
Paul Elliott0023e0a2021-04-27 10:06:22 +01003596 {
Paul Elliott329d5382021-07-22 17:10:45 +01003597 /* Split ad into length(ad_part_len) parts. */
Paul Elliottd3f82412021-06-16 16:52:21 +01003598 mbedtls_test_set_step( ad_part_len );
Paul Elliott0023e0a2021-04-27 10:06:22 +01003599
Paul Elliott97fd1ba2021-07-21 18:46:06 +01003600 if( !aead_multipart_internal_func( key_type_arg, key_data,
3601 alg_arg, nonce,
3602 additional_data,
3603 ad_part_len,
3604 input_data, -1,
3605 do_set_lengths,
3606 expected_output,
3607 expect_valid_signature,
Paul Elliottebf91632021-07-22 17:54:42 +01003608 0, 0,
3609 ( ad_part_len & 0x01 ) ) )
Paul Elliott329d5382021-07-22 17:10:45 +01003610 break;
3611
3612 /* length(0) part, length(ad_part_len) part, length(0) part... */
3613 mbedtls_test_set_step( 1000 + ad_part_len );
3614
3615 if( !aead_multipart_internal_func( key_type_arg, key_data,
3616 alg_arg, nonce,
3617 additional_data,
3618 ad_part_len,
3619 input_data, -1,
3620 do_set_lengths,
3621 expected_output,
3622 expect_valid_signature,
Paul Elliottebf91632021-07-22 17:54:42 +01003623 0, 1,
3624 ( ad_part_len & 0x01 ) ) )
Paul Elliott97fd1ba2021-07-21 18:46:06 +01003625 break;
Paul Elliott0023e0a2021-04-27 10:06:22 +01003626 }
3627 }
3628
Paul Elliott97fd1ba2021-07-21 18:46:06 +01003629 /* Temporary whilst we have algorithms that cannot support chunking */
3630 if( do_test_data_chunked == 1 )
Paul Elliott0023e0a2021-04-27 10:06:22 +01003631 {
Paul Elliottd3f82412021-06-16 16:52:21 +01003632 for( data_part_len = 1; data_part_len <= input_data->len;
3633 data_part_len++ )
Paul Elliott0023e0a2021-04-27 10:06:22 +01003634 {
Paul Elliott329d5382021-07-22 17:10:45 +01003635 /* Split data into length(data_part_len) parts. */
3636 mbedtls_test_set_step( 2000 + data_part_len );
Paul Elliott97fd1ba2021-07-21 18:46:06 +01003637
3638 if( !aead_multipart_internal_func( key_type_arg, key_data,
3639 alg_arg, nonce,
3640 additional_data, -1,
3641 input_data, data_part_len,
3642 do_set_lengths,
3643 expected_output,
3644 expect_valid_signature,
Paul Elliottebf91632021-07-22 17:54:42 +01003645 0, 0,
3646 ( data_part_len & 0x01 ) ) )
Paul Elliott329d5382021-07-22 17:10:45 +01003647 break;
3648
3649 /* length(0) part, length(data_part_len) part, length(0) part... */
3650 mbedtls_test_set_step( 3000 + data_part_len );
3651
3652 if( !aead_multipart_internal_func( key_type_arg, key_data,
3653 alg_arg, nonce,
3654 additional_data, -1,
3655 input_data, data_part_len,
3656 do_set_lengths,
3657 expected_output,
3658 expect_valid_signature,
Paul Elliottebf91632021-07-22 17:54:42 +01003659 0, 1,
3660 ( data_part_len & 0x01 ) ) )
Paul Elliott97fd1ba2021-07-21 18:46:06 +01003661 break;
Paul Elliott0023e0a2021-04-27 10:06:22 +01003662 }
3663 }
3664
Paul Elliott8fc45162021-06-23 16:06:01 +01003665 /* Goto is required to silence warnings about unused labels, as we
3666 * don't actually do any test assertions in this function. */
Paul Elliottd3f82412021-06-16 16:52:21 +01003667 goto exit;
Paul Elliott0023e0a2021-04-27 10:06:22 +01003668}
3669/* END_CASE */
3670
3671/* BEGIN_CASE */
Paul Elliott8eb9daf2021-06-04 16:42:21 +01003672void aead_multipart_generate_nonce( int key_type_arg, data_t *key_data,
3673 int alg_arg,
3674 int nonce_len,
Paul Elliottd85f5472021-07-16 18:20:16 +01003675 int expected_generated_len_arg,
Paul Elliott3bd5dba2021-06-23 17:14:40 +01003676 data_t *additional_data,
3677 data_t *input_data,
3678 int expected_status_arg )
Paul Elliott8eb9daf2021-06-04 16:42:21 +01003679{
3680
3681 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
3682 psa_key_type_t key_type = key_type_arg;
3683 psa_algorithm_t alg = alg_arg;
3684 psa_aead_operation_t operation;
3685 uint8_t nonce_buffer[PSA_AEAD_NONCE_MAX_SIZE];
3686 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
3687 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
3688 size_t nonce_generated_len = 0;
Paul Elliottd85f5472021-07-16 18:20:16 +01003689 size_t expected_generated_len = expected_generated_len_arg;
Paul Elliott3bd5dba2021-06-23 17:14:40 +01003690 unsigned char *output_data = NULL;
3691 unsigned char *final_data = NULL;
3692 size_t output_size = 0;
3693 size_t finish_output_size = 0;
3694 size_t output_length = 0;
3695 size_t tag_length = 0;
3696 uint8_t tag_buffer[PSA_AEAD_TAG_MAX_SIZE];
Paul Elliott8eb9daf2021-06-04 16:42:21 +01003697
3698 PSA_ASSERT( psa_crypto_init( ) );
3699
3700 psa_set_key_usage_flags( & attributes, PSA_KEY_USAGE_ENCRYPT );
3701 psa_set_key_algorithm( & attributes, alg );
3702 psa_set_key_type( & attributes, key_type );
3703
3704 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
3705 &key ) );
3706
3707 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
3708
Paul Elliott3bd5dba2021-06-23 17:14:40 +01003709 output_size = PSA_AEAD_UPDATE_OUTPUT_SIZE( key_type, alg, input_data->len );
3710
3711 ASSERT_ALLOC( output_data, output_size );
3712
3713 finish_output_size = PSA_AEAD_FINISH_OUTPUT_SIZE( key_type, alg );
3714
3715 TEST_ASSERT( finish_output_size <= PSA_AEAD_FINISH_OUTPUT_MAX_SIZE );
3716
3717 ASSERT_ALLOC( final_data, finish_output_size );
3718
Paul Elliott8eb9daf2021-06-04 16:42:21 +01003719 operation = psa_aead_operation_init( );
3720
3721 status = psa_aead_encrypt_setup( &operation, key, alg );
3722
3723 /* If the operation is not supported, just skip and not fail in case the
3724 * encryption involves a common limitation of cryptography hardwares and
3725 * an alternative implementation. */
3726 if( status == PSA_ERROR_NOT_SUPPORTED )
3727 {
3728 MBEDTLS_TEST_PSA_SKIP_IF_ALT_AES_192( key_type, key_data->len * 8 );
3729 MBEDTLS_TEST_PSA_SKIP_IF_ALT_GCM_NOT_12BYTES_NONCE( alg, nonce_len );
3730 }
3731
3732 PSA_ASSERT( status );
3733
Paul Elliott8eb9daf2021-06-04 16:42:21 +01003734 status = psa_aead_generate_nonce( &operation, nonce_buffer,
3735 nonce_len,
3736 &nonce_generated_len );
3737
Paul Elliott3bd5dba2021-06-23 17:14:40 +01003738 TEST_ASSERT( status == expected_status_arg );
3739
Paul Elliottd85f5472021-07-16 18:20:16 +01003740 TEST_EQUAL( nonce_generated_len, expected_generated_len );
3741
Paul Elliotte0fcb3b2021-07-16 18:52:03 +01003742 TEST_ASSERT( nonce_generated_len < PSA_AEAD_NONCE_MAX_SIZE );
3743
Paul Elliott3bd5dba2021-06-23 17:14:40 +01003744 if( expected_status_arg == PSA_SUCCESS )
3745 {
3746
3747 /* Ensure we can still complete operation. */
3748
3749 PSA_ASSERT( psa_aead_update_ad( &operation, additional_data->x,
3750 additional_data->len ) );
3751
3752 PSA_ASSERT( psa_aead_update( &operation, input_data->x, input_data->len,
3753 output_data, output_size, &output_length ) );
3754
3755 PSA_ASSERT( psa_aead_finish( &operation, final_data, finish_output_size,
3756 &output_length, tag_buffer,
3757 PSA_AEAD_TAG_MAX_SIZE, &tag_length ) );
3758 }
Paul Elliott8eb9daf2021-06-04 16:42:21 +01003759
3760exit:
3761 psa_destroy_key( key );
Paul Elliott16906f92021-06-24 09:57:01 +01003762 mbedtls_free( output_data );
3763 mbedtls_free( final_data );
Paul Elliott8eb9daf2021-06-04 16:42:21 +01003764 psa_aead_abort( &operation );
3765 PSA_DONE( );
3766}
3767/* END_CASE */
3768
3769/* BEGIN_CASE */
Paul Elliottc23a9a02021-06-21 18:32:46 +01003770void aead_multipart_state_test( int key_type_arg, data_t *key_data,
3771 int alg_arg,
3772 data_t *nonce,
3773 data_t *additional_data,
3774 data_t *input_data )
3775{
3776 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
3777 psa_key_type_t key_type = key_type_arg;
3778 psa_algorithm_t alg = alg_arg;
3779 psa_aead_operation_t operation;
3780 unsigned char *output_data = NULL;
3781 unsigned char *final_data = NULL;
3782 size_t output_size = 0;
3783 size_t finish_output_size = 0;
3784 size_t output_length = 0;
3785 size_t key_bits = 0;
3786 size_t tag_length = 0;
3787 size_t tag_size = 0;
3788 size_t nonce_length = 0;
3789 uint8_t nonce_buffer[PSA_AEAD_NONCE_MAX_SIZE];
3790 uint8_t tag_buffer[PSA_AEAD_TAG_MAX_SIZE];
3791 size_t output_part_length = 0;
3792 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
3793
3794 PSA_ASSERT( psa_crypto_init( ) );
3795
3796 psa_set_key_usage_flags( & attributes,
3797 PSA_KEY_USAGE_ENCRYPT | PSA_KEY_USAGE_DECRYPT );
3798 psa_set_key_algorithm( & attributes, alg );
3799 psa_set_key_type( & attributes, key_type );
3800
3801 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
3802 &key ) );
3803
3804 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
3805 key_bits = psa_get_key_bits( &attributes );
3806
3807 tag_length = PSA_AEAD_TAG_LENGTH( key_type, key_bits, alg );
3808
3809 TEST_ASSERT( tag_length <= PSA_AEAD_TAG_MAX_SIZE );
3810
3811 output_size = PSA_AEAD_UPDATE_OUTPUT_SIZE( key_type, alg, input_data->len );
3812
3813 ASSERT_ALLOC( output_data, output_size );
3814
3815 finish_output_size = PSA_AEAD_FINISH_OUTPUT_SIZE( key_type, alg );
3816
3817 TEST_ASSERT( finish_output_size <= PSA_AEAD_FINISH_OUTPUT_MAX_SIZE );
3818
3819 ASSERT_ALLOC( final_data, finish_output_size );
3820
3821 /* Test all operations error without calling setup first. */
3822
3823 operation = psa_aead_operation_init( );
3824
3825 TEST_EQUAL( psa_aead_set_nonce( &operation, nonce->x, nonce->len ),
3826 PSA_ERROR_BAD_STATE );
3827
3828 psa_aead_abort( &operation );
3829
3830 operation = psa_aead_operation_init( );
3831
3832 TEST_EQUAL( psa_aead_generate_nonce( &operation, nonce_buffer,
3833 PSA_AEAD_NONCE_MAX_SIZE,
3834 &nonce_length ),
3835 PSA_ERROR_BAD_STATE );
3836
3837 psa_aead_abort( &operation );
3838
Paul Elliott481be342021-07-16 17:38:47 +01003839 /* ------------------------------------------------------- */
3840
Paul Elliottc23a9a02021-06-21 18:32:46 +01003841 operation = psa_aead_operation_init( );
3842
3843 TEST_EQUAL( psa_aead_set_lengths( &operation, additional_data->len,
3844 input_data->len ),
3845 PSA_ERROR_BAD_STATE );
3846
3847 psa_aead_abort( &operation );
3848
Paul Elliott481be342021-07-16 17:38:47 +01003849 /* ------------------------------------------------------- */
3850
Paul Elliottc23a9a02021-06-21 18:32:46 +01003851 operation = psa_aead_operation_init( );
3852
3853 TEST_EQUAL( psa_aead_update_ad( &operation, additional_data->x,
3854 additional_data->len ),
3855 PSA_ERROR_BAD_STATE );
3856
3857 psa_aead_abort( &operation );
3858
Paul Elliott481be342021-07-16 17:38:47 +01003859 /* ------------------------------------------------------- */
3860
Paul Elliottc23a9a02021-06-21 18:32:46 +01003861 operation = psa_aead_operation_init( );
3862
3863 TEST_EQUAL( psa_aead_update( &operation, input_data->x,
3864 input_data->len, output_data,
3865 output_size, &output_length ),
3866 PSA_ERROR_BAD_STATE );
3867
3868 psa_aead_abort( &operation );
3869
Paul Elliott481be342021-07-16 17:38:47 +01003870 /* ------------------------------------------------------- */
3871
Paul Elliottc23a9a02021-06-21 18:32:46 +01003872 operation = psa_aead_operation_init( );
3873
3874 TEST_EQUAL( psa_aead_finish( &operation, final_data,
3875 finish_output_size,
3876 &output_part_length,
3877 tag_buffer, tag_length,
3878 &tag_size ),
3879 PSA_ERROR_BAD_STATE );
3880
3881 psa_aead_abort( &operation );
3882
Paul Elliott481be342021-07-16 17:38:47 +01003883 /* ------------------------------------------------------- */
3884
Paul Elliottc23a9a02021-06-21 18:32:46 +01003885 operation = psa_aead_operation_init( );
3886
3887 TEST_EQUAL( psa_aead_verify( &operation, final_data,
3888 finish_output_size,
3889 &output_part_length,
3890 tag_buffer,
3891 tag_length ),
3892 PSA_ERROR_BAD_STATE );
3893
3894 psa_aead_abort( &operation );
3895
3896 /* Test for double setups. */
3897
3898 operation = psa_aead_operation_init( );
3899
3900 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
3901
3902 TEST_EQUAL( psa_aead_encrypt_setup( &operation, key, alg ),
3903 PSA_ERROR_BAD_STATE );
3904
3905 psa_aead_abort( &operation );
3906
Paul Elliott481be342021-07-16 17:38:47 +01003907 /* ------------------------------------------------------- */
3908
Paul Elliottc23a9a02021-06-21 18:32:46 +01003909 operation = psa_aead_operation_init( );
3910
3911 PSA_ASSERT( psa_aead_decrypt_setup( &operation, key, alg ) );
3912
3913 TEST_EQUAL( psa_aead_decrypt_setup( &operation, key, alg ),
3914 PSA_ERROR_BAD_STATE );
3915
3916 psa_aead_abort( &operation );
3917
Paul Elliott374a2be2021-07-16 17:53:40 +01003918 /* ------------------------------------------------------- */
3919
3920 operation = psa_aead_operation_init( );
3921
3922 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
3923
3924 TEST_EQUAL( psa_aead_decrypt_setup( &operation, key, alg ),
3925 PSA_ERROR_BAD_STATE );
3926
3927 psa_aead_abort( &operation );
3928
3929 /* ------------------------------------------------------- */
3930
3931 operation = psa_aead_operation_init( );
3932
3933 PSA_ASSERT( psa_aead_decrypt_setup( &operation, key, alg ) );
3934
3935 TEST_EQUAL( psa_aead_encrypt_setup( &operation, key, alg ),
3936 PSA_ERROR_BAD_STATE );
3937
3938 psa_aead_abort( &operation );
3939
Paul Elliottc23a9a02021-06-21 18:32:46 +01003940 /* Test for not setting a nonce. */
3941
3942 operation = psa_aead_operation_init( );
3943
3944 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
3945
3946 TEST_EQUAL( psa_aead_update_ad( &operation, additional_data->x,
3947 additional_data->len ),
3948 PSA_ERROR_BAD_STATE );
3949
3950 psa_aead_abort( &operation );
3951
3952 /* Test for double setting nonce. */
3953
3954 operation = psa_aead_operation_init( );
3955
3956 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
3957
3958 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
3959
3960 TEST_EQUAL( psa_aead_set_nonce( &operation, nonce->x, nonce->len ),
3961 PSA_ERROR_BAD_STATE );
3962
3963 psa_aead_abort( &operation );
3964
Paul Elliott374a2be2021-07-16 17:53:40 +01003965 /* Test for double generating nonce. */
3966
3967 operation = psa_aead_operation_init( );
3968
3969 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
3970
3971 PSA_ASSERT( psa_aead_generate_nonce( &operation, nonce_buffer,
3972 PSA_AEAD_NONCE_MAX_SIZE,
3973 &nonce_length ) );
3974
3975 TEST_EQUAL( psa_aead_generate_nonce( &operation, nonce_buffer,
3976 PSA_AEAD_NONCE_MAX_SIZE,
3977 &nonce_length ),
3978 PSA_ERROR_BAD_STATE );
3979
3980
3981 psa_aead_abort( &operation );
3982
3983 /* Test for generate nonce then set and vice versa */
3984
3985 operation = psa_aead_operation_init( );
3986
3987 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
3988
3989 PSA_ASSERT( psa_aead_generate_nonce( &operation, nonce_buffer,
3990 PSA_AEAD_NONCE_MAX_SIZE,
3991 &nonce_length ) );
3992
3993 TEST_EQUAL( psa_aead_set_nonce( &operation, nonce->x, nonce->len ),
3994 PSA_ERROR_BAD_STATE );
3995
3996 psa_aead_abort( &operation );
3997
3998 /* ------------------------------------------------------- */
3999
4000 operation = psa_aead_operation_init( );
4001
4002 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
4003
4004 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
4005
4006 TEST_EQUAL( psa_aead_generate_nonce( &operation, nonce_buffer,
4007 PSA_AEAD_NONCE_MAX_SIZE,
4008 &nonce_length ),
4009 PSA_ERROR_BAD_STATE );
4010
4011 psa_aead_abort( &operation );
4012
Paul Elliott7220cae2021-06-22 17:25:57 +01004013 /* Test for generating nonce in decrypt setup. */
4014
4015 operation = psa_aead_operation_init( );
4016
4017 PSA_ASSERT( psa_aead_decrypt_setup( &operation, key, alg ) );
4018
4019 TEST_EQUAL( psa_aead_generate_nonce( &operation, nonce_buffer,
4020 PSA_AEAD_NONCE_MAX_SIZE,
4021 &nonce_length ),
4022 PSA_ERROR_BAD_STATE );
4023
4024 psa_aead_abort( &operation );
4025
Paul Elliottc23a9a02021-06-21 18:32:46 +01004026 /* Test for setting lengths twice. */
4027
4028 operation = psa_aead_operation_init( );
4029
4030 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
4031
4032 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
4033
4034 PSA_ASSERT( psa_aead_set_lengths( &operation, additional_data->len,
4035 input_data->len ) );
4036
4037 TEST_EQUAL( psa_aead_set_lengths( &operation, additional_data->len,
4038 input_data->len ),
4039 PSA_ERROR_BAD_STATE );
4040
4041 psa_aead_abort( &operation );
4042
4043 /* Test for setting lengths after already starting data. */
4044
4045 operation = psa_aead_operation_init( );
4046
4047 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
4048
4049 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
4050
4051 PSA_ASSERT( psa_aead_update( &operation, input_data->x,
4052 input_data->len, output_data,
4053 output_size, &output_length ) );
4054
4055 TEST_EQUAL( psa_aead_set_lengths( &operation, additional_data->len,
4056 input_data->len ),
4057 PSA_ERROR_BAD_STATE );
4058
4059 psa_aead_abort( &operation );
4060
Paul Elliott243080c2021-07-21 19:01:17 +01004061 /* Test for not sending any additional data or data after setting non zero
4062 * lengths for them. (encrypt) */
Paul Elliottc23a9a02021-06-21 18:32:46 +01004063
4064 operation = psa_aead_operation_init( );
4065
4066 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
4067
4068 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
4069
4070 PSA_ASSERT( psa_aead_set_lengths( &operation, additional_data->len,
4071 input_data->len ) );
4072
4073 TEST_EQUAL( psa_aead_finish( &operation, final_data,
4074 finish_output_size,
4075 &output_part_length,
4076 tag_buffer, tag_length,
4077 &tag_size ),
4078 PSA_ERROR_INVALID_ARGUMENT );
4079
4080 psa_aead_abort( &operation );
4081
Paul Elliott243080c2021-07-21 19:01:17 +01004082 /* Test for not sending any additional data or data after setting non-zero
4083 * lengths for them. (decrypt) */
Paul Elliottc23a9a02021-06-21 18:32:46 +01004084
4085 operation = psa_aead_operation_init( );
4086
4087 PSA_ASSERT( psa_aead_decrypt_setup( &operation, key, alg ) );
4088
4089 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
4090
4091 PSA_ASSERT( psa_aead_set_lengths( &operation, additional_data->len,
4092 input_data->len ) );
4093
4094 TEST_EQUAL( psa_aead_verify( &operation, final_data,
4095 finish_output_size,
4096 &output_part_length,
4097 tag_buffer,
4098 tag_length ),
4099 PSA_ERROR_INVALID_ARGUMENT );
4100
4101 psa_aead_abort( &operation );
4102
Paul Elliott243080c2021-07-21 19:01:17 +01004103 /* Test for not sending any additional data after setting a non-zero length
4104 * for it. */
Paul Elliottc23a9a02021-06-21 18:32:46 +01004105
4106 operation = psa_aead_operation_init( );
4107
4108 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
4109
4110 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
4111
4112 PSA_ASSERT( psa_aead_set_lengths( &operation, additional_data->len,
4113 input_data->len ) );
4114
4115 TEST_EQUAL( psa_aead_update( &operation, input_data->x,
4116 input_data->len, output_data,
4117 output_size, &output_length ),
4118 PSA_ERROR_INVALID_ARGUMENT );
4119
4120 psa_aead_abort( &operation );
4121
4122 /* Test sending additional data after data. */
4123
4124 operation = psa_aead_operation_init( );
4125
4126 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
4127
4128 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
4129
4130 PSA_ASSERT( psa_aead_update( &operation, input_data->x,
4131 input_data->len, output_data,
4132 output_size, &output_length ) );
4133
4134 TEST_EQUAL( psa_aead_update_ad( &operation, additional_data->x,
4135 additional_data->len ),
4136 PSA_ERROR_BAD_STATE );
4137
4138 psa_aead_abort( &operation );
4139
Paul Elliott534d0b42021-06-22 19:15:20 +01004140 /* Test calling finish on decryption. */
4141
4142 operation = psa_aead_operation_init( );
4143
4144 PSA_ASSERT( psa_aead_decrypt_setup( &operation, key, alg ) );
4145
4146 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
4147
4148 TEST_EQUAL( psa_aead_finish( &operation, final_data,
4149 finish_output_size,
4150 &output_part_length,
4151 tag_buffer, tag_length,
4152 &tag_size ),
4153 PSA_ERROR_BAD_STATE );
4154
4155 psa_aead_abort( &operation );
4156
4157 /* Test calling verify on encryption. */
4158
4159 operation = psa_aead_operation_init( );
4160
4161 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
4162
4163 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
4164
4165 TEST_EQUAL( psa_aead_verify( &operation, final_data,
4166 finish_output_size,
4167 &output_part_length,
4168 tag_buffer,
4169 tag_length ),
Paul Elliott5b065cb2021-06-23 08:33:22 +01004170 PSA_ERROR_BAD_STATE );
Paul Elliott534d0b42021-06-22 19:15:20 +01004171
4172 psa_aead_abort( &operation );
4173
4174
Paul Elliottc23a9a02021-06-21 18:32:46 +01004175exit:
4176 psa_destroy_key( key );
4177 psa_aead_abort( &operation );
4178 mbedtls_free( output_data );
4179 mbedtls_free( final_data );
4180 PSA_DONE( );
4181}
4182/* END_CASE */
4183
4184/* BEGIN_CASE */
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02004185void signature_size( int type_arg,
4186 int bits,
4187 int alg_arg,
4188 int expected_size_arg )
Gilles Peskinee59236f2018-01-27 23:32:46 +01004189{
4190 psa_key_type_t type = type_arg;
4191 psa_algorithm_t alg = alg_arg;
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01004192 size_t actual_size = PSA_SIGN_OUTPUT_SIZE( type, bits, alg );
Gilles Peskine841b14b2019-11-26 17:37:37 +01004193
Gilles Peskinefe11b722018-12-18 00:24:04 +01004194 TEST_EQUAL( actual_size, (size_t) expected_size_arg );
Gilles Peskine841b14b2019-11-26 17:37:37 +01004195
Gilles Peskinee59236f2018-01-27 23:32:46 +01004196exit:
4197 ;
4198}
4199/* END_CASE */
4200
4201/* BEGIN_CASE */
gabor-mezei-armb9530232021-04-16 14:21:21 +02004202void sign_hash_deterministic( int key_type_arg, data_t *key_data,
4203 int alg_arg, data_t *input_data,
4204 data_t *output_data )
Gilles Peskinee59236f2018-01-27 23:32:46 +01004205{
Ronald Cron5425a212020-08-04 14:58:35 +02004206 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskinee59236f2018-01-27 23:32:46 +01004207 psa_key_type_t key_type = key_type_arg;
4208 psa_algorithm_t alg = alg_arg;
Gilles Peskine20035e32018-02-03 22:44:14 +01004209 size_t key_bits;
Gilles Peskine20035e32018-02-03 22:44:14 +01004210 unsigned char *signature = NULL;
4211 size_t signature_size;
4212 size_t signature_length = 0xdeadbeef;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02004213 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine20035e32018-02-03 22:44:14 +01004214
Gilles Peskine8817f612018-12-18 00:18:46 +01004215 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine20035e32018-02-03 22:44:14 +01004216
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01004217 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_HASH );
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02004218 psa_set_key_algorithm( &attributes, alg );
4219 psa_set_key_type( &attributes, key_type );
mohammad1603a97cb8c2018-03-28 03:46:26 -07004220
Gilles Peskine049c7532019-05-15 20:22:09 +02004221 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02004222 &key ) );
4223 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02004224 key_bits = psa_get_key_bits( &attributes );
Gilles Peskine20035e32018-02-03 22:44:14 +01004225
Gilles Peskine860ce9d2018-06-28 12:23:00 +02004226 /* Allocate a buffer which has the size advertized by the
4227 * library. */
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01004228 signature_size = PSA_SIGN_OUTPUT_SIZE( key_type,
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02004229 key_bits, alg );
Gilles Peskine20035e32018-02-03 22:44:14 +01004230 TEST_ASSERT( signature_size != 0 );
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01004231 TEST_ASSERT( signature_size <= PSA_SIGNATURE_MAX_SIZE );
Gilles Peskine8cebbba2018-09-27 13:54:18 +02004232 ASSERT_ALLOC( signature, signature_size );
Gilles Peskine20035e32018-02-03 22:44:14 +01004233
Gilles Peskine860ce9d2018-06-28 12:23:00 +02004234 /* Perform the signature. */
Ronald Cron5425a212020-08-04 14:58:35 +02004235 PSA_ASSERT( psa_sign_hash( key, alg,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01004236 input_data->x, input_data->len,
4237 signature, signature_size,
4238 &signature_length ) );
Gilles Peskine9911b022018-06-29 17:30:48 +02004239 /* Verify that the signature is what is expected. */
Gilles Peskinebd7dea92018-09-27 13:57:19 +02004240 ASSERT_COMPARE( output_data->x, output_data->len,
4241 signature, signature_length );
Gilles Peskine20035e32018-02-03 22:44:14 +01004242
4243exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +01004244 /*
4245 * Key attributes may have been returned by psa_get_key_attributes()
4246 * thus reset them as required.
4247 */
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02004248 psa_reset_key_attributes( &attributes );
Ronald Cron3a4f0e32020-11-19 17:55:23 +01004249
Ronald Cron5425a212020-08-04 14:58:35 +02004250 psa_destroy_key( key );
Gilles Peskine0189e752018-02-03 23:57:22 +01004251 mbedtls_free( signature );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02004252 PSA_DONE( );
Gilles Peskine20035e32018-02-03 22:44:14 +01004253}
4254/* END_CASE */
4255
4256/* BEGIN_CASE */
gabor-mezei-armb9530232021-04-16 14:21:21 +02004257void sign_hash_fail( int key_type_arg, data_t *key_data,
4258 int alg_arg, data_t *input_data,
4259 int signature_size_arg, int expected_status_arg )
Gilles Peskine20035e32018-02-03 22:44:14 +01004260{
Ronald Cron5425a212020-08-04 14:58:35 +02004261 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine20035e32018-02-03 22:44:14 +01004262 psa_key_type_t key_type = key_type_arg;
4263 psa_algorithm_t alg = alg_arg;
Gilles Peskine860ce9d2018-06-28 12:23:00 +02004264 size_t signature_size = signature_size_arg;
Gilles Peskine20035e32018-02-03 22:44:14 +01004265 psa_status_t actual_status;
4266 psa_status_t expected_status = expected_status_arg;
Gilles Peskine40f68b92018-03-07 16:43:36 +01004267 unsigned char *signature = NULL;
Gilles Peskine93aa0332018-02-03 23:58:03 +01004268 size_t signature_length = 0xdeadbeef;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02004269 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine20035e32018-02-03 22:44:14 +01004270
Gilles Peskine8cebbba2018-09-27 13:54:18 +02004271 ASSERT_ALLOC( signature, signature_size );
Gilles Peskine20035e32018-02-03 22:44:14 +01004272
Gilles Peskine8817f612018-12-18 00:18:46 +01004273 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine20035e32018-02-03 22:44:14 +01004274
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01004275 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_HASH );
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02004276 psa_set_key_algorithm( &attributes, alg );
4277 psa_set_key_type( &attributes, key_type );
mohammad1603a97cb8c2018-03-28 03:46:26 -07004278
Gilles Peskine049c7532019-05-15 20:22:09 +02004279 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02004280 &key ) );
Gilles Peskine20035e32018-02-03 22:44:14 +01004281
Ronald Cron5425a212020-08-04 14:58:35 +02004282 actual_status = psa_sign_hash( key, alg,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01004283 input_data->x, input_data->len,
4284 signature, signature_size,
4285 &signature_length );
Gilles Peskinefe11b722018-12-18 00:24:04 +01004286 TEST_EQUAL( actual_status, expected_status );
Gilles Peskine860ce9d2018-06-28 12:23:00 +02004287 /* The value of *signature_length is unspecified on error, but
4288 * whatever it is, it should be less than signature_size, so that
4289 * if the caller tries to read *signature_length bytes without
4290 * checking the error code then they don't overflow a buffer. */
4291 TEST_ASSERT( signature_length <= signature_size );
Gilles Peskine20035e32018-02-03 22:44:14 +01004292
4293exit:
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02004294 psa_reset_key_attributes( &attributes );
Ronald Cron5425a212020-08-04 14:58:35 +02004295 psa_destroy_key( key );
Gilles Peskine20035e32018-02-03 22:44:14 +01004296 mbedtls_free( signature );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02004297 PSA_DONE( );
Gilles Peskine20035e32018-02-03 22:44:14 +01004298}
4299/* END_CASE */
mohammad16038cc1cee2018-03-28 01:21:33 +03004300
4301/* BEGIN_CASE */
gabor-mezei-armb9530232021-04-16 14:21:21 +02004302void sign_verify_hash( int key_type_arg, data_t *key_data,
4303 int alg_arg, data_t *input_data )
Gilles Peskine9911b022018-06-29 17:30:48 +02004304{
Ronald Cron5425a212020-08-04 14:58:35 +02004305 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine9911b022018-06-29 17:30:48 +02004306 psa_key_type_t key_type = key_type_arg;
4307 psa_algorithm_t alg = alg_arg;
4308 size_t key_bits;
4309 unsigned char *signature = NULL;
4310 size_t signature_size;
4311 size_t signature_length = 0xdeadbeef;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02004312 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine9911b022018-06-29 17:30:48 +02004313
Gilles Peskine8817f612018-12-18 00:18:46 +01004314 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine9911b022018-06-29 17:30:48 +02004315
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01004316 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_HASH | PSA_KEY_USAGE_VERIFY_HASH );
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02004317 psa_set_key_algorithm( &attributes, alg );
4318 psa_set_key_type( &attributes, key_type );
Gilles Peskine9911b022018-06-29 17:30:48 +02004319
Gilles Peskine049c7532019-05-15 20:22:09 +02004320 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02004321 &key ) );
4322 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02004323 key_bits = psa_get_key_bits( &attributes );
Gilles Peskine9911b022018-06-29 17:30:48 +02004324
4325 /* Allocate a buffer which has the size advertized by the
4326 * library. */
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01004327 signature_size = PSA_SIGN_OUTPUT_SIZE( key_type,
Gilles Peskine9911b022018-06-29 17:30:48 +02004328 key_bits, alg );
4329 TEST_ASSERT( signature_size != 0 );
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01004330 TEST_ASSERT( signature_size <= PSA_SIGNATURE_MAX_SIZE );
Gilles Peskine8cebbba2018-09-27 13:54:18 +02004331 ASSERT_ALLOC( signature, signature_size );
Gilles Peskine9911b022018-06-29 17:30:48 +02004332
4333 /* Perform the signature. */
Ronald Cron5425a212020-08-04 14:58:35 +02004334 PSA_ASSERT( psa_sign_hash( key, alg,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01004335 input_data->x, input_data->len,
4336 signature, signature_size,
4337 &signature_length ) );
Gilles Peskine9911b022018-06-29 17:30:48 +02004338 /* Check that the signature length looks sensible. */
4339 TEST_ASSERT( signature_length <= signature_size );
4340 TEST_ASSERT( signature_length > 0 );
4341
4342 /* Use the library to verify that the signature is correct. */
Ronald Cron5425a212020-08-04 14:58:35 +02004343 PSA_ASSERT( psa_verify_hash( key, alg,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01004344 input_data->x, input_data->len,
4345 signature, signature_length ) );
Gilles Peskine9911b022018-06-29 17:30:48 +02004346
4347 if( input_data->len != 0 )
4348 {
4349 /* Flip a bit in the input and verify that the signature is now
4350 * detected as invalid. Flip a bit at the beginning, not at the end,
4351 * because ECDSA may ignore the last few bits of the input. */
4352 input_data->x[0] ^= 1;
Ronald Cron5425a212020-08-04 14:58:35 +02004353 TEST_EQUAL( psa_verify_hash( key, alg,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01004354 input_data->x, input_data->len,
4355 signature, signature_length ),
Gilles Peskinef812dcf2018-12-18 00:33:25 +01004356 PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine9911b022018-06-29 17:30:48 +02004357 }
4358
4359exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +01004360 /*
4361 * Key attributes may have been returned by psa_get_key_attributes()
4362 * thus reset them as required.
4363 */
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02004364 psa_reset_key_attributes( &attributes );
Ronald Cron3a4f0e32020-11-19 17:55:23 +01004365
Ronald Cron5425a212020-08-04 14:58:35 +02004366 psa_destroy_key( key );
Gilles Peskine9911b022018-06-29 17:30:48 +02004367 mbedtls_free( signature );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02004368 PSA_DONE( );
Gilles Peskine9911b022018-06-29 17:30:48 +02004369}
4370/* END_CASE */
4371
4372/* BEGIN_CASE */
gabor-mezei-armb9530232021-04-16 14:21:21 +02004373void verify_hash( int key_type_arg, data_t *key_data,
4374 int alg_arg, data_t *hash_data,
4375 data_t *signature_data )
itayzafrir5c753392018-05-08 11:18:38 +03004376{
Ronald Cron5425a212020-08-04 14:58:35 +02004377 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
itayzafrir5c753392018-05-08 11:18:38 +03004378 psa_key_type_t key_type = key_type_arg;
4379 psa_algorithm_t alg = alg_arg;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02004380 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
itayzafrir5c753392018-05-08 11:18:38 +03004381
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01004382 TEST_ASSERT( signature_data->len <= PSA_SIGNATURE_MAX_SIZE );
Gilles Peskine69c12672018-06-28 00:07:19 +02004383
Gilles Peskine8817f612018-12-18 00:18:46 +01004384 PSA_ASSERT( psa_crypto_init( ) );
itayzafrir5c753392018-05-08 11:18:38 +03004385
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01004386 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_VERIFY_HASH );
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02004387 psa_set_key_algorithm( &attributes, alg );
4388 psa_set_key_type( &attributes, key_type );
itayzafrir5c753392018-05-08 11:18:38 +03004389
Gilles Peskine049c7532019-05-15 20:22:09 +02004390 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02004391 &key ) );
itayzafrir5c753392018-05-08 11:18:38 +03004392
Ronald Cron5425a212020-08-04 14:58:35 +02004393 PSA_ASSERT( psa_verify_hash( key, alg,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01004394 hash_data->x, hash_data->len,
4395 signature_data->x, signature_data->len ) );
Gilles Peskine0627f982019-11-26 19:12:16 +01004396
itayzafrir5c753392018-05-08 11:18:38 +03004397exit:
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02004398 psa_reset_key_attributes( &attributes );
Ronald Cron5425a212020-08-04 14:58:35 +02004399 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02004400 PSA_DONE( );
itayzafrir5c753392018-05-08 11:18:38 +03004401}
4402/* END_CASE */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004403
4404/* BEGIN_CASE */
gabor-mezei-armb9530232021-04-16 14:21:21 +02004405void verify_hash_fail( int key_type_arg, data_t *key_data,
4406 int alg_arg, data_t *hash_data,
4407 data_t *signature_data,
4408 int expected_status_arg )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004409{
Ronald Cron5425a212020-08-04 14:58:35 +02004410 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004411 psa_key_type_t key_type = key_type_arg;
4412 psa_algorithm_t alg = alg_arg;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004413 psa_status_t actual_status;
4414 psa_status_t expected_status = expected_status_arg;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02004415 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004416
Gilles Peskine8817f612018-12-18 00:18:46 +01004417 PSA_ASSERT( psa_crypto_init( ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004418
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01004419 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_VERIFY_HASH );
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02004420 psa_set_key_algorithm( &attributes, alg );
4421 psa_set_key_type( &attributes, key_type );
Nir Sonnenscheind7082602018-06-04 16:45:27 +03004422
Gilles Peskine049c7532019-05-15 20:22:09 +02004423 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02004424 &key ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004425
Ronald Cron5425a212020-08-04 14:58:35 +02004426 actual_status = psa_verify_hash( key, alg,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01004427 hash_data->x, hash_data->len,
4428 signature_data->x, signature_data->len );
Gilles Peskinefe11b722018-12-18 00:24:04 +01004429 TEST_EQUAL( actual_status, expected_status );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004430
4431exit:
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02004432 psa_reset_key_attributes( &attributes );
Ronald Cron5425a212020-08-04 14:58:35 +02004433 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02004434 PSA_DONE( );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004435}
4436/* END_CASE */
4437
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004438/* BEGIN_CASE */
gabor-mezei-arm53028482021-04-15 18:19:50 +02004439void sign_message_deterministic( int key_type_arg,
4440 data_t *key_data,
4441 int alg_arg,
4442 data_t *input_data,
4443 data_t *output_data )
4444{
4445 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
4446 psa_key_type_t key_type = key_type_arg;
4447 psa_algorithm_t alg = alg_arg;
4448 size_t key_bits;
4449 unsigned char *signature = NULL;
4450 size_t signature_size;
4451 size_t signature_length = 0xdeadbeef;
4452 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
4453
4454 PSA_ASSERT( psa_crypto_init( ) );
4455
4456 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_MESSAGE );
4457 psa_set_key_algorithm( &attributes, alg );
4458 psa_set_key_type( &attributes, key_type );
4459
4460 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
4461 &key ) );
4462 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
4463 key_bits = psa_get_key_bits( &attributes );
4464
4465 signature_size = PSA_SIGN_OUTPUT_SIZE( key_type, key_bits, alg );
4466 TEST_ASSERT( signature_size != 0 );
4467 TEST_ASSERT( signature_size <= PSA_SIGNATURE_MAX_SIZE );
4468 ASSERT_ALLOC( signature, signature_size );
4469
4470 PSA_ASSERT( psa_sign_message( key, alg,
4471 input_data->x, input_data->len,
4472 signature, signature_size,
4473 &signature_length ) );
4474
4475 ASSERT_COMPARE( output_data->x, output_data->len,
4476 signature, signature_length );
4477
4478exit:
4479 psa_reset_key_attributes( &attributes );
4480
4481 psa_destroy_key( key );
4482 mbedtls_free( signature );
4483 PSA_DONE( );
4484
4485}
4486/* END_CASE */
4487
4488/* BEGIN_CASE */
4489void sign_message_fail( int key_type_arg,
4490 data_t *key_data,
4491 int alg_arg,
4492 data_t *input_data,
4493 int signature_size_arg,
4494 int expected_status_arg )
4495{
4496 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
4497 psa_key_type_t key_type = key_type_arg;
4498 psa_algorithm_t alg = alg_arg;
4499 size_t signature_size = signature_size_arg;
4500 psa_status_t actual_status;
4501 psa_status_t expected_status = expected_status_arg;
4502 unsigned char *signature = NULL;
4503 size_t signature_length = 0xdeadbeef;
4504 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
4505
4506 ASSERT_ALLOC( signature, signature_size );
4507
4508 PSA_ASSERT( psa_crypto_init( ) );
4509
4510 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_MESSAGE );
4511 psa_set_key_algorithm( &attributes, alg );
4512 psa_set_key_type( &attributes, key_type );
4513
4514 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
4515 &key ) );
4516
4517 actual_status = psa_sign_message( key, alg,
4518 input_data->x, input_data->len,
4519 signature, signature_size,
4520 &signature_length );
4521 TEST_EQUAL( actual_status, expected_status );
4522 /* The value of *signature_length is unspecified on error, but
4523 * whatever it is, it should be less than signature_size, so that
4524 * if the caller tries to read *signature_length bytes without
4525 * checking the error code then they don't overflow a buffer. */
4526 TEST_ASSERT( signature_length <= signature_size );
4527
4528exit:
4529 psa_reset_key_attributes( &attributes );
4530 psa_destroy_key( key );
4531 mbedtls_free( signature );
4532 PSA_DONE( );
4533}
4534/* END_CASE */
4535
4536/* BEGIN_CASE */
4537void sign_verify_message( int key_type_arg,
4538 data_t *key_data,
4539 int alg_arg,
4540 data_t *input_data )
4541{
4542 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
4543 psa_key_type_t key_type = key_type_arg;
4544 psa_algorithm_t alg = alg_arg;
4545 size_t key_bits;
4546 unsigned char *signature = NULL;
4547 size_t signature_size;
4548 size_t signature_length = 0xdeadbeef;
4549 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
4550
4551 PSA_ASSERT( psa_crypto_init( ) );
4552
4553 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_MESSAGE |
4554 PSA_KEY_USAGE_VERIFY_MESSAGE );
4555 psa_set_key_algorithm( &attributes, alg );
4556 psa_set_key_type( &attributes, key_type );
4557
4558 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
4559 &key ) );
4560 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
4561 key_bits = psa_get_key_bits( &attributes );
4562
4563 signature_size = PSA_SIGN_OUTPUT_SIZE( key_type, key_bits, alg );
4564 TEST_ASSERT( signature_size != 0 );
4565 TEST_ASSERT( signature_size <= PSA_SIGNATURE_MAX_SIZE );
4566 ASSERT_ALLOC( signature, signature_size );
4567
4568 PSA_ASSERT( psa_sign_message( key, alg,
4569 input_data->x, input_data->len,
4570 signature, signature_size,
4571 &signature_length ) );
4572 TEST_ASSERT( signature_length <= signature_size );
4573 TEST_ASSERT( signature_length > 0 );
4574
4575 PSA_ASSERT( psa_verify_message( key, alg,
4576 input_data->x, input_data->len,
4577 signature, signature_length ) );
4578
4579 if( input_data->len != 0 )
4580 {
4581 /* Flip a bit in the input and verify that the signature is now
4582 * detected as invalid. Flip a bit at the beginning, not at the end,
4583 * because ECDSA may ignore the last few bits of the input. */
4584 input_data->x[0] ^= 1;
4585 TEST_EQUAL( psa_verify_message( key, alg,
4586 input_data->x, input_data->len,
4587 signature, signature_length ),
4588 PSA_ERROR_INVALID_SIGNATURE );
4589 }
4590
4591exit:
4592 psa_reset_key_attributes( &attributes );
4593
4594 psa_destroy_key( key );
4595 mbedtls_free( signature );
4596 PSA_DONE( );
4597}
4598/* END_CASE */
4599
4600/* BEGIN_CASE */
4601void verify_message( int key_type_arg,
4602 data_t *key_data,
4603 int alg_arg,
4604 data_t *input_data,
4605 data_t *signature_data )
4606{
4607 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
4608 psa_key_type_t key_type = key_type_arg;
4609 psa_algorithm_t alg = alg_arg;
4610 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
4611
4612 TEST_ASSERT( signature_data->len <= PSA_SIGNATURE_MAX_SIZE );
4613
4614 PSA_ASSERT( psa_crypto_init( ) );
4615
4616 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_VERIFY_MESSAGE );
4617 psa_set_key_algorithm( &attributes, alg );
4618 psa_set_key_type( &attributes, key_type );
4619
4620 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
4621 &key ) );
4622
4623 PSA_ASSERT( psa_verify_message( key, alg,
4624 input_data->x, input_data->len,
4625 signature_data->x, signature_data->len ) );
4626
4627exit:
4628 psa_reset_key_attributes( &attributes );
4629 psa_destroy_key( key );
4630 PSA_DONE( );
4631}
4632/* END_CASE */
4633
4634/* BEGIN_CASE */
4635void verify_message_fail( int key_type_arg,
4636 data_t *key_data,
4637 int alg_arg,
4638 data_t *hash_data,
4639 data_t *signature_data,
4640 int expected_status_arg )
4641{
4642 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
4643 psa_key_type_t key_type = key_type_arg;
4644 psa_algorithm_t alg = alg_arg;
4645 psa_status_t actual_status;
4646 psa_status_t expected_status = expected_status_arg;
4647 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
4648
4649 PSA_ASSERT( psa_crypto_init( ) );
4650
4651 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_VERIFY_MESSAGE );
4652 psa_set_key_algorithm( &attributes, alg );
4653 psa_set_key_type( &attributes, key_type );
4654
4655 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
4656 &key ) );
4657
4658 actual_status = psa_verify_message( key, alg,
4659 hash_data->x, hash_data->len,
4660 signature_data->x,
4661 signature_data->len );
4662 TEST_EQUAL( actual_status, expected_status );
4663
4664exit:
4665 psa_reset_key_attributes( &attributes );
4666 psa_destroy_key( key );
4667 PSA_DONE( );
4668}
4669/* END_CASE */
4670
4671/* BEGIN_CASE */
Gilles Peskine656896e2018-06-29 19:12:28 +02004672void asymmetric_encrypt( int key_type_arg,
4673 data_t *key_data,
4674 int alg_arg,
4675 data_t *input_data,
Gilles Peskine68428122018-06-30 18:42:41 +02004676 data_t *label,
Gilles Peskine656896e2018-06-29 19:12:28 +02004677 int expected_output_length_arg,
4678 int expected_status_arg )
4679{
Ronald Cron5425a212020-08-04 14:58:35 +02004680 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine656896e2018-06-29 19:12:28 +02004681 psa_key_type_t key_type = key_type_arg;
4682 psa_algorithm_t alg = alg_arg;
4683 size_t expected_output_length = expected_output_length_arg;
4684 size_t key_bits;
4685 unsigned char *output = NULL;
4686 size_t output_size;
4687 size_t output_length = ~0;
4688 psa_status_t actual_status;
4689 psa_status_t expected_status = expected_status_arg;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02004690 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine656896e2018-06-29 19:12:28 +02004691
Gilles Peskine8817f612018-12-18 00:18:46 +01004692 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskinebdf309c2018-12-03 15:36:32 +01004693
Gilles Peskine656896e2018-06-29 19:12:28 +02004694 /* Import the key */
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02004695 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
4696 psa_set_key_algorithm( &attributes, alg );
4697 psa_set_key_type( &attributes, key_type );
Gilles Peskine049c7532019-05-15 20:22:09 +02004698 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02004699 &key ) );
Gilles Peskine656896e2018-06-29 19:12:28 +02004700
4701 /* Determine the maximum output length */
Ronald Cron5425a212020-08-04 14:58:35 +02004702 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02004703 key_bits = psa_get_key_bits( &attributes );
gabor-mezei-armceface22021-01-21 12:26:17 +01004704
Gilles Peskine656896e2018-06-29 19:12:28 +02004705 output_size = PSA_ASYMMETRIC_ENCRYPT_OUTPUT_SIZE( key_type, key_bits, alg );
gabor-mezei-armceface22021-01-21 12:26:17 +01004706 TEST_ASSERT( output_size <= PSA_ASYMMETRIC_ENCRYPT_OUTPUT_MAX_SIZE );
Gilles Peskine8cebbba2018-09-27 13:54:18 +02004707 ASSERT_ALLOC( output, output_size );
Gilles Peskine656896e2018-06-29 19:12:28 +02004708
4709 /* Encrypt the input */
Ronald Cron5425a212020-08-04 14:58:35 +02004710 actual_status = psa_asymmetric_encrypt( key, alg,
Gilles Peskine656896e2018-06-29 19:12:28 +02004711 input_data->x, input_data->len,
Gilles Peskine68428122018-06-30 18:42:41 +02004712 label->x, label->len,
Gilles Peskine656896e2018-06-29 19:12:28 +02004713 output, output_size,
4714 &output_length );
Gilles Peskinefe11b722018-12-18 00:24:04 +01004715 TEST_EQUAL( actual_status, expected_status );
4716 TEST_EQUAL( output_length, expected_output_length );
Gilles Peskine656896e2018-06-29 19:12:28 +02004717
Gilles Peskine68428122018-06-30 18:42:41 +02004718 /* If the label is empty, the test framework puts a non-null pointer
4719 * in label->x. Test that a null pointer works as well. */
4720 if( label->len == 0 )
4721 {
4722 output_length = ~0;
Gilles Peskinef7ab5ad2018-09-26 18:19:24 +02004723 if( output_size != 0 )
4724 memset( output, 0, output_size );
Ronald Cron5425a212020-08-04 14:58:35 +02004725 actual_status = psa_asymmetric_encrypt( key, alg,
Gilles Peskine68428122018-06-30 18:42:41 +02004726 input_data->x, input_data->len,
4727 NULL, label->len,
4728 output, output_size,
4729 &output_length );
Gilles Peskinefe11b722018-12-18 00:24:04 +01004730 TEST_EQUAL( actual_status, expected_status );
4731 TEST_EQUAL( output_length, expected_output_length );
Gilles Peskine68428122018-06-30 18:42:41 +02004732 }
4733
Gilles Peskine656896e2018-06-29 19:12:28 +02004734exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +01004735 /*
4736 * Key attributes may have been returned by psa_get_key_attributes()
4737 * thus reset them as required.
4738 */
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02004739 psa_reset_key_attributes( &attributes );
Ronald Cron3a4f0e32020-11-19 17:55:23 +01004740
Ronald Cron5425a212020-08-04 14:58:35 +02004741 psa_destroy_key( key );
Gilles Peskine656896e2018-06-29 19:12:28 +02004742 mbedtls_free( output );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02004743 PSA_DONE( );
Gilles Peskine656896e2018-06-29 19:12:28 +02004744}
4745/* END_CASE */
4746
4747/* BEGIN_CASE */
Gilles Peskine68428122018-06-30 18:42:41 +02004748void asymmetric_encrypt_decrypt( int key_type_arg,
4749 data_t *key_data,
4750 int alg_arg,
4751 data_t *input_data,
4752 data_t *label )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004753{
Ronald Cron5425a212020-08-04 14:58:35 +02004754 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004755 psa_key_type_t key_type = key_type_arg;
4756 psa_algorithm_t alg = alg_arg;
Gilles Peskine55c94dd2018-06-30 18:54:48 +02004757 size_t key_bits;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004758 unsigned char *output = NULL;
Gilles Peskine55c94dd2018-06-30 18:54:48 +02004759 size_t output_size;
4760 size_t output_length = ~0;
Nir Sonnenschein0f3bdbd2018-05-02 23:56:12 +03004761 unsigned char *output2 = NULL;
Gilles Peskine55c94dd2018-06-30 18:54:48 +02004762 size_t output2_size;
4763 size_t output2_length = ~0;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02004764 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004765
Gilles Peskine8817f612018-12-18 00:18:46 +01004766 PSA_ASSERT( psa_crypto_init( ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004767
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02004768 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT | PSA_KEY_USAGE_DECRYPT );
4769 psa_set_key_algorithm( &attributes, alg );
4770 psa_set_key_type( &attributes, key_type );
Nir Sonnenscheind7082602018-06-04 16:45:27 +03004771
Gilles Peskine049c7532019-05-15 20:22:09 +02004772 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02004773 &key ) );
Gilles Peskine55c94dd2018-06-30 18:54:48 +02004774
4775 /* Determine the maximum ciphertext length */
Ronald Cron5425a212020-08-04 14:58:35 +02004776 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02004777 key_bits = psa_get_key_bits( &attributes );
gabor-mezei-armceface22021-01-21 12:26:17 +01004778
Gilles Peskine55c94dd2018-06-30 18:54:48 +02004779 output_size = PSA_ASYMMETRIC_ENCRYPT_OUTPUT_SIZE( key_type, key_bits, alg );
gabor-mezei-armceface22021-01-21 12:26:17 +01004780 TEST_ASSERT( output_size <= PSA_ASYMMETRIC_ENCRYPT_OUTPUT_MAX_SIZE );
Gilles Peskine8cebbba2018-09-27 13:54:18 +02004781 ASSERT_ALLOC( output, output_size );
gabor-mezei-armceface22021-01-21 12:26:17 +01004782
Gilles Peskine55c94dd2018-06-30 18:54:48 +02004783 output2_size = input_data->len;
gabor-mezei-armceface22021-01-21 12:26:17 +01004784 TEST_ASSERT( output2_size <=
4785 PSA_ASYMMETRIC_DECRYPT_OUTPUT_SIZE( key_type, key_bits, alg ) );
4786 TEST_ASSERT( output2_size <= PSA_ASYMMETRIC_DECRYPT_OUTPUT_MAX_SIZE );
Gilles Peskine8cebbba2018-09-27 13:54:18 +02004787 ASSERT_ALLOC( output2, output2_size );
Gilles Peskine55c94dd2018-06-30 18:54:48 +02004788
Gilles Peskineeebd7382018-06-08 18:11:54 +02004789 /* We test encryption by checking that encrypt-then-decrypt gives back
4790 * the original plaintext because of the non-optional random
4791 * part of encryption process which prevents using fixed vectors. */
Ronald Cron5425a212020-08-04 14:58:35 +02004792 PSA_ASSERT( psa_asymmetric_encrypt( key, alg,
Gilles Peskine8817f612018-12-18 00:18:46 +01004793 input_data->x, input_data->len,
4794 label->x, label->len,
4795 output, output_size,
4796 &output_length ) );
Gilles Peskine55c94dd2018-06-30 18:54:48 +02004797 /* We don't know what ciphertext length to expect, but check that
4798 * it looks sensible. */
4799 TEST_ASSERT( output_length <= output_size );
Nir Sonnenschein0f3bdbd2018-05-02 23:56:12 +03004800
Ronald Cron5425a212020-08-04 14:58:35 +02004801 PSA_ASSERT( psa_asymmetric_decrypt( key, alg,
Gilles Peskine8817f612018-12-18 00:18:46 +01004802 output, output_length,
4803 label->x, label->len,
4804 output2, output2_size,
4805 &output2_length ) );
Gilles Peskinebd7dea92018-09-27 13:57:19 +02004806 ASSERT_COMPARE( input_data->x, input_data->len,
4807 output2, output2_length );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004808
4809exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +01004810 /*
4811 * Key attributes may have been returned by psa_get_key_attributes()
4812 * thus reset them as required.
4813 */
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02004814 psa_reset_key_attributes( &attributes );
Ronald Cron3a4f0e32020-11-19 17:55:23 +01004815
Ronald Cron5425a212020-08-04 14:58:35 +02004816 psa_destroy_key( key );
itayzafrir3e02b3b2018-06-12 17:06:52 +03004817 mbedtls_free( output );
4818 mbedtls_free( output2 );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02004819 PSA_DONE( );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004820}
4821/* END_CASE */
4822
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004823/* BEGIN_CASE */
Gilles Peskine68428122018-06-30 18:42:41 +02004824void asymmetric_decrypt( int key_type_arg,
4825 data_t *key_data,
4826 int alg_arg,
4827 data_t *input_data,
4828 data_t *label,
Gilles Peskine66763a02018-06-29 21:54:10 +02004829 data_t *expected_data )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004830{
Ronald Cron5425a212020-08-04 14:58:35 +02004831 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004832 psa_key_type_t key_type = key_type_arg;
4833 psa_algorithm_t alg = alg_arg;
gabor-mezei-armceface22021-01-21 12:26:17 +01004834 size_t key_bits;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004835 unsigned char *output = NULL;
Nir Sonnenscheind70bc482018-06-04 16:31:13 +03004836 size_t output_size = 0;
Gilles Peskine55c94dd2018-06-30 18:54:48 +02004837 size_t output_length = ~0;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02004838 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004839
Gilles Peskine8817f612018-12-18 00:18:46 +01004840 PSA_ASSERT( psa_crypto_init( ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004841
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02004842 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DECRYPT );
4843 psa_set_key_algorithm( &attributes, alg );
4844 psa_set_key_type( &attributes, key_type );
Nir Sonnenscheind7082602018-06-04 16:45:27 +03004845
Gilles Peskine049c7532019-05-15 20:22:09 +02004846 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02004847 &key ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004848
gabor-mezei-armceface22021-01-21 12:26:17 +01004849 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
4850 key_bits = psa_get_key_bits( &attributes );
4851
4852 /* Determine the maximum ciphertext length */
4853 output_size = PSA_ASYMMETRIC_DECRYPT_OUTPUT_SIZE( key_type, key_bits, alg );
4854 TEST_ASSERT( output_size <= PSA_ASYMMETRIC_DECRYPT_OUTPUT_MAX_SIZE );
4855 ASSERT_ALLOC( output, output_size );
4856
Ronald Cron5425a212020-08-04 14:58:35 +02004857 PSA_ASSERT( psa_asymmetric_decrypt( key, alg,
Gilles Peskine8817f612018-12-18 00:18:46 +01004858 input_data->x, input_data->len,
4859 label->x, label->len,
4860 output,
4861 output_size,
4862 &output_length ) );
Gilles Peskinebd7dea92018-09-27 13:57:19 +02004863 ASSERT_COMPARE( expected_data->x, expected_data->len,
4864 output, output_length );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004865
Gilles Peskine68428122018-06-30 18:42:41 +02004866 /* If the label is empty, the test framework puts a non-null pointer
4867 * in label->x. Test that a null pointer works as well. */
4868 if( label->len == 0 )
4869 {
4870 output_length = ~0;
Gilles Peskinef7ab5ad2018-09-26 18:19:24 +02004871 if( output_size != 0 )
4872 memset( output, 0, output_size );
Ronald Cron5425a212020-08-04 14:58:35 +02004873 PSA_ASSERT( psa_asymmetric_decrypt( key, alg,
Gilles Peskine8817f612018-12-18 00:18:46 +01004874 input_data->x, input_data->len,
4875 NULL, label->len,
4876 output,
4877 output_size,
4878 &output_length ) );
Gilles Peskinebd7dea92018-09-27 13:57:19 +02004879 ASSERT_COMPARE( expected_data->x, expected_data->len,
4880 output, output_length );
Gilles Peskine68428122018-06-30 18:42:41 +02004881 }
4882
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004883exit:
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02004884 psa_reset_key_attributes( &attributes );
Ronald Cron5425a212020-08-04 14:58:35 +02004885 psa_destroy_key( key );
itayzafrir3e02b3b2018-06-12 17:06:52 +03004886 mbedtls_free( output );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02004887 PSA_DONE( );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004888}
4889/* END_CASE */
4890
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004891/* BEGIN_CASE */
Gilles Peskine68428122018-06-30 18:42:41 +02004892void asymmetric_decrypt_fail( int key_type_arg,
4893 data_t *key_data,
4894 int alg_arg,
4895 data_t *input_data,
4896 data_t *label,
Jaeden Amerof8daab72019-02-06 12:57:46 +00004897 int output_size_arg,
Gilles Peskine2d277862018-06-18 15:41:12 +02004898 int expected_status_arg )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004899{
Ronald Cron5425a212020-08-04 14:58:35 +02004900 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004901 psa_key_type_t key_type = key_type_arg;
4902 psa_algorithm_t alg = alg_arg;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004903 unsigned char *output = NULL;
Jaeden Amerof8daab72019-02-06 12:57:46 +00004904 size_t output_size = output_size_arg;
Gilles Peskine55c94dd2018-06-30 18:54:48 +02004905 size_t output_length = ~0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004906 psa_status_t actual_status;
4907 psa_status_t expected_status = expected_status_arg;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02004908 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004909
Gilles Peskine8cebbba2018-09-27 13:54:18 +02004910 ASSERT_ALLOC( output, output_size );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02004911
Gilles Peskine8817f612018-12-18 00:18:46 +01004912 PSA_ASSERT( psa_crypto_init( ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004913
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02004914 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DECRYPT );
4915 psa_set_key_algorithm( &attributes, alg );
4916 psa_set_key_type( &attributes, key_type );
Nir Sonnenscheind7082602018-06-04 16:45:27 +03004917
Gilles Peskine049c7532019-05-15 20:22:09 +02004918 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02004919 &key ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004920
Ronald Cron5425a212020-08-04 14:58:35 +02004921 actual_status = psa_asymmetric_decrypt( key, alg,
Gilles Peskine4abf7412018-06-18 16:35:34 +02004922 input_data->x, input_data->len,
Gilles Peskine68428122018-06-30 18:42:41 +02004923 label->x, label->len,
Gilles Peskine4abf7412018-06-18 16:35:34 +02004924 output, output_size,
Gilles Peskine2d277862018-06-18 15:41:12 +02004925 &output_length );
Gilles Peskinefe11b722018-12-18 00:24:04 +01004926 TEST_EQUAL( actual_status, expected_status );
Gilles Peskine55c94dd2018-06-30 18:54:48 +02004927 TEST_ASSERT( output_length <= output_size );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004928
Gilles Peskine68428122018-06-30 18:42:41 +02004929 /* If the label is empty, the test framework puts a non-null pointer
4930 * in label->x. Test that a null pointer works as well. */
4931 if( label->len == 0 )
4932 {
4933 output_length = ~0;
Gilles Peskinef7ab5ad2018-09-26 18:19:24 +02004934 if( output_size != 0 )
4935 memset( output, 0, output_size );
Ronald Cron5425a212020-08-04 14:58:35 +02004936 actual_status = psa_asymmetric_decrypt( key, alg,
Gilles Peskine68428122018-06-30 18:42:41 +02004937 input_data->x, input_data->len,
4938 NULL, label->len,
4939 output, output_size,
4940 &output_length );
Gilles Peskinefe11b722018-12-18 00:24:04 +01004941 TEST_EQUAL( actual_status, expected_status );
Gilles Peskine55c94dd2018-06-30 18:54:48 +02004942 TEST_ASSERT( output_length <= output_size );
Gilles Peskine68428122018-06-30 18:42:41 +02004943 }
4944
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004945exit:
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02004946 psa_reset_key_attributes( &attributes );
Ronald Cron5425a212020-08-04 14:58:35 +02004947 psa_destroy_key( key );
Gilles Peskine2d277862018-06-18 15:41:12 +02004948 mbedtls_free( output );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02004949 PSA_DONE( );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004950}
Gilles Peskine5b051bc2018-05-31 13:25:48 +02004951/* END_CASE */
Gilles Peskine05d69892018-06-19 22:00:52 +02004952
4953/* BEGIN_CASE */
Gilles Peskinecbe66502019-05-16 16:59:18 +02004954void key_derivation_init( )
Jaeden Amerod94d6712019-01-04 14:11:48 +00004955{
4956 /* Test each valid way of initializing the object, except for `= {0}`, as
4957 * Clang 5 complains when `-Wmissing-field-initializers` is used, even
4958 * though it's OK by the C standard. We could test for this, but we'd need
4959 * to supress the Clang warning for the test. */
Jaeden Amero5229bbb2019-02-07 16:33:37 +00004960 size_t capacity;
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004961 psa_key_derivation_operation_t func = psa_key_derivation_operation_init( );
4962 psa_key_derivation_operation_t init = PSA_KEY_DERIVATION_OPERATION_INIT;
4963 psa_key_derivation_operation_t zero;
Jaeden Amerod94d6712019-01-04 14:11:48 +00004964
4965 memset( &zero, 0, sizeof( zero ) );
4966
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004967 /* A default operation should not be able to report its capacity. */
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004968 TEST_EQUAL( psa_key_derivation_get_capacity( &func, &capacity ),
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004969 PSA_ERROR_BAD_STATE );
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004970 TEST_EQUAL( psa_key_derivation_get_capacity( &init, &capacity ),
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004971 PSA_ERROR_BAD_STATE );
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004972 TEST_EQUAL( psa_key_derivation_get_capacity( &zero, &capacity ),
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004973 PSA_ERROR_BAD_STATE );
Jaeden Amero5229bbb2019-02-07 16:33:37 +00004974
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004975 /* A default operation should be abortable without error. */
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004976 PSA_ASSERT( psa_key_derivation_abort(&func) );
4977 PSA_ASSERT( psa_key_derivation_abort(&init) );
4978 PSA_ASSERT( psa_key_derivation_abort(&zero) );
Jaeden Amerod94d6712019-01-04 14:11:48 +00004979}
4980/* END_CASE */
4981
Janos Follath16de4a42019-06-13 16:32:24 +01004982/* BEGIN_CASE */
4983void derive_setup( int alg_arg, int expected_status_arg )
Gilles Peskineea0fb492018-07-12 17:17:20 +02004984{
Gilles Peskineea0fb492018-07-12 17:17:20 +02004985 psa_algorithm_t alg = alg_arg;
Gilles Peskineea0fb492018-07-12 17:17:20 +02004986 psa_status_t expected_status = expected_status_arg;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004987 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Gilles Peskineea0fb492018-07-12 17:17:20 +02004988
Gilles Peskine8817f612018-12-18 00:18:46 +01004989 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskineea0fb492018-07-12 17:17:20 +02004990
Janos Follath16de4a42019-06-13 16:32:24 +01004991 TEST_EQUAL( psa_key_derivation_setup( &operation, alg ),
Gilles Peskinef812dcf2018-12-18 00:33:25 +01004992 expected_status );
Gilles Peskineea0fb492018-07-12 17:17:20 +02004993
4994exit:
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004995 psa_key_derivation_abort( &operation );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02004996 PSA_DONE( );
Gilles Peskineea0fb492018-07-12 17:17:20 +02004997}
4998/* END_CASE */
4999
Janos Follathaf3c2a02019-06-12 12:34:34 +01005000/* BEGIN_CASE */
Janos Follatha27c9272019-06-14 09:59:36 +01005001void derive_set_capacity( int alg_arg, int capacity_arg,
5002 int expected_status_arg )
5003{
5004 psa_algorithm_t alg = alg_arg;
5005 size_t capacity = capacity_arg;
5006 psa_status_t expected_status = expected_status_arg;
5007 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
5008
5009 PSA_ASSERT( psa_crypto_init( ) );
5010
5011 PSA_ASSERT( psa_key_derivation_setup( &operation, alg ) );
5012
5013 TEST_EQUAL( psa_key_derivation_set_capacity( &operation, capacity ),
5014 expected_status );
5015
5016exit:
5017 psa_key_derivation_abort( &operation );
5018 PSA_DONE( );
5019}
5020/* END_CASE */
5021
5022/* BEGIN_CASE */
Janos Follathaf3c2a02019-06-12 12:34:34 +01005023void derive_input( int alg_arg,
Gilles Peskine6842ba42019-09-23 13:49:33 +02005024 int step_arg1, int key_type_arg1, data_t *input1,
Janos Follathaf3c2a02019-06-12 12:34:34 +01005025 int expected_status_arg1,
Gilles Peskine2058c072019-09-24 17:19:33 +02005026 int step_arg2, int key_type_arg2, data_t *input2,
Janos Follathaf3c2a02019-06-12 12:34:34 +01005027 int expected_status_arg2,
Gilles Peskine2058c072019-09-24 17:19:33 +02005028 int step_arg3, int key_type_arg3, data_t *input3,
Gilles Peskine1a2904c2019-09-24 17:45:07 +02005029 int expected_status_arg3,
5030 int output_key_type_arg, int expected_output_status_arg )
Janos Follathaf3c2a02019-06-12 12:34:34 +01005031{
5032 psa_algorithm_t alg = alg_arg;
Gilles Peskine6842ba42019-09-23 13:49:33 +02005033 psa_key_derivation_step_t steps[] = {step_arg1, step_arg2, step_arg3};
5034 psa_key_type_t key_types[] = {key_type_arg1, key_type_arg2, key_type_arg3};
Janos Follathaf3c2a02019-06-12 12:34:34 +01005035 psa_status_t expected_statuses[] = {expected_status_arg1,
5036 expected_status_arg2,
5037 expected_status_arg3};
5038 data_t *inputs[] = {input1, input2, input3};
Ronald Cron5425a212020-08-04 14:58:35 +02005039 mbedtls_svc_key_id_t keys[] = { MBEDTLS_SVC_KEY_ID_INIT,
5040 MBEDTLS_SVC_KEY_ID_INIT,
5041 MBEDTLS_SVC_KEY_ID_INIT };
Janos Follathaf3c2a02019-06-12 12:34:34 +01005042 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
5043 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
5044 size_t i;
Gilles Peskine1a2904c2019-09-24 17:45:07 +02005045 psa_key_type_t output_key_type = output_key_type_arg;
Ronald Cron5425a212020-08-04 14:58:35 +02005046 mbedtls_svc_key_id_t output_key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine1a2904c2019-09-24 17:45:07 +02005047 psa_status_t expected_output_status = expected_output_status_arg;
5048 psa_status_t actual_output_status;
Janos Follathaf3c2a02019-06-12 12:34:34 +01005049
5050 PSA_ASSERT( psa_crypto_init( ) );
5051
5052 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DERIVE );
5053 psa_set_key_algorithm( &attributes, alg );
Janos Follathaf3c2a02019-06-12 12:34:34 +01005054
5055 PSA_ASSERT( psa_key_derivation_setup( &operation, alg ) );
5056
5057 for( i = 0; i < ARRAY_LENGTH( steps ); i++ )
5058 {
Gilles Peskineb8965192019-09-24 16:21:10 +02005059 if( key_types[i] != PSA_KEY_TYPE_NONE )
Janos Follathaf3c2a02019-06-12 12:34:34 +01005060 {
Gilles Peskine6842ba42019-09-23 13:49:33 +02005061 psa_set_key_type( &attributes, key_types[i] );
5062 PSA_ASSERT( psa_import_key( &attributes,
5063 inputs[i]->x, inputs[i]->len,
Ronald Cron5425a212020-08-04 14:58:35 +02005064 &keys[i] ) );
Steven Cooreman0ee0d522020-10-05 16:03:42 +02005065 if( PSA_KEY_TYPE_IS_KEY_PAIR( key_types[i] ) &&
5066 steps[i] == PSA_KEY_DERIVATION_INPUT_SECRET )
5067 {
5068 // When taking a private key as secret input, use key agreement
5069 // to add the shared secret to the derivation
Gilles Peskinec18e25f2021-02-12 23:48:20 +01005070 TEST_EQUAL( mbedtls_test_psa_key_agreement_with_self(
5071 &operation, keys[i] ),
Steven Cooreman0ee0d522020-10-05 16:03:42 +02005072 expected_statuses[i] );
5073 }
5074 else
5075 {
5076 TEST_EQUAL( psa_key_derivation_input_key( &operation, steps[i],
Ronald Cron5425a212020-08-04 14:58:35 +02005077 keys[i] ),
Steven Cooreman0ee0d522020-10-05 16:03:42 +02005078 expected_statuses[i] );
5079 }
Gilles Peskine6842ba42019-09-23 13:49:33 +02005080 }
5081 else
5082 {
5083 TEST_EQUAL( psa_key_derivation_input_bytes(
5084 &operation, steps[i],
5085 inputs[i]->x, inputs[i]->len ),
5086 expected_statuses[i] );
Janos Follathaf3c2a02019-06-12 12:34:34 +01005087 }
5088 }
5089
Gilles Peskine1a2904c2019-09-24 17:45:07 +02005090 if( output_key_type != PSA_KEY_TYPE_NONE )
5091 {
5092 psa_reset_key_attributes( &attributes );
5093 psa_set_key_type( &attributes, PSA_KEY_TYPE_RAW_DATA );
5094 psa_set_key_bits( &attributes, 8 );
5095 actual_output_status =
5096 psa_key_derivation_output_key( &attributes, &operation,
Ronald Cron5425a212020-08-04 14:58:35 +02005097 &output_key );
Gilles Peskine1a2904c2019-09-24 17:45:07 +02005098 }
5099 else
5100 {
5101 uint8_t buffer[1];
5102 actual_output_status =
5103 psa_key_derivation_output_bytes( &operation,
5104 buffer, sizeof( buffer ) );
5105 }
5106 TEST_EQUAL( actual_output_status, expected_output_status );
5107
Janos Follathaf3c2a02019-06-12 12:34:34 +01005108exit:
5109 psa_key_derivation_abort( &operation );
Ronald Cron5425a212020-08-04 14:58:35 +02005110 for( i = 0; i < ARRAY_LENGTH( keys ); i++ )
5111 psa_destroy_key( keys[i] );
5112 psa_destroy_key( output_key );
Janos Follathaf3c2a02019-06-12 12:34:34 +01005113 PSA_DONE( );
5114}
5115/* END_CASE */
5116
Janos Follathd958bb72019-07-03 15:02:16 +01005117/* BEGIN_CASE */
5118void test_derive_invalid_key_derivation_state( int alg_arg )
Nir Sonnenscheine5204c92018-10-22 17:24:55 +03005119{
Janos Follathd958bb72019-07-03 15:02:16 +01005120 psa_algorithm_t alg = alg_arg;
Ronald Cron5425a212020-08-04 14:58:35 +02005121 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Nir Sonnenschein4eda37b2018-10-31 12:15:58 +02005122 size_t key_type = PSA_KEY_TYPE_DERIVE;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005123 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Janos Follathd958bb72019-07-03 15:02:16 +01005124 unsigned char input1[] = "Input 1";
5125 size_t input1_length = sizeof( input1 );
5126 unsigned char input2[] = "Input 2";
5127 size_t input2_length = sizeof( input2 );
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03005128 uint8_t buffer[42];
Nir Sonnenschein1caf6d22018-11-01 12:27:20 +02005129 size_t capacity = sizeof( buffer );
Nir Sonnenscheindd69d8b2018-11-01 12:24:23 +02005130 const uint8_t key_data[22] = { 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b,
5131 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b,
5132 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b};
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02005133 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Nir Sonnenscheine5204c92018-10-22 17:24:55 +03005134
Gilles Peskine8817f612018-12-18 00:18:46 +01005135 PSA_ASSERT( psa_crypto_init( ) );
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03005136
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02005137 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DERIVE );
5138 psa_set_key_algorithm( &attributes, alg );
5139 psa_set_key_type( &attributes, key_type );
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03005140
Gilles Peskine73676cb2019-05-15 20:15:10 +02005141 PSA_ASSERT( psa_import_key( &attributes,
5142 key_data, sizeof( key_data ),
Ronald Cron5425a212020-08-04 14:58:35 +02005143 &key ) );
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03005144
5145 /* valid key derivation */
Gilles Peskinec18e25f2021-02-12 23:48:20 +01005146 if( !mbedtls_test_psa_setup_key_derivation_wrap( &operation, key, alg,
5147 input1, input1_length,
5148 input2, input2_length,
5149 capacity ) )
Janos Follathd958bb72019-07-03 15:02:16 +01005150 goto exit;
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03005151
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005152 /* state of operation shouldn't allow additional generation */
Janos Follathd958bb72019-07-03 15:02:16 +01005153 TEST_EQUAL( psa_key_derivation_setup( &operation, alg ),
Gilles Peskinef812dcf2018-12-18 00:33:25 +01005154 PSA_ERROR_BAD_STATE );
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03005155
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005156 PSA_ASSERT( psa_key_derivation_output_bytes( &operation, buffer, capacity ) );
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03005157
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005158 TEST_EQUAL( psa_key_derivation_output_bytes( &operation, buffer, capacity ),
David Saadab4ecc272019-02-14 13:48:10 +02005159 PSA_ERROR_INSUFFICIENT_DATA );
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03005160
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03005161exit:
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005162 psa_key_derivation_abort( &operation );
Ronald Cron5425a212020-08-04 14:58:35 +02005163 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02005164 PSA_DONE( );
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03005165}
5166/* END_CASE */
5167
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03005168/* BEGIN_CASE */
Gilles Peskinecbe66502019-05-16 16:59:18 +02005169void test_derive_invalid_key_derivation_tests( )
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03005170{
5171 uint8_t output_buffer[16];
5172 size_t buffer_size = 16;
5173 size_t capacity = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005174 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03005175
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005176 TEST_ASSERT( psa_key_derivation_output_bytes( &operation,
5177 output_buffer, buffer_size )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005178 == PSA_ERROR_BAD_STATE );
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03005179
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005180 TEST_ASSERT( psa_key_derivation_get_capacity( &operation, &capacity )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005181 == PSA_ERROR_BAD_STATE );
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03005182
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005183 PSA_ASSERT( psa_key_derivation_abort( &operation ) );
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03005184
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005185 TEST_ASSERT( psa_key_derivation_output_bytes( &operation,
5186 output_buffer, buffer_size )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005187 == PSA_ERROR_BAD_STATE );
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03005188
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005189 TEST_ASSERT( psa_key_derivation_get_capacity( &operation, &capacity )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005190 == PSA_ERROR_BAD_STATE );
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03005191
5192exit:
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005193 psa_key_derivation_abort( &operation );
Nir Sonnenscheine5204c92018-10-22 17:24:55 +03005194}
5195/* END_CASE */
5196
5197/* BEGIN_CASE */
Gilles Peskine96ee5c72018-07-12 17:24:54 +02005198void derive_output( int alg_arg,
Gilles Peskine1468da72019-05-29 17:35:49 +02005199 int step1_arg, data_t *input1,
5200 int step2_arg, data_t *input2,
5201 int step3_arg, data_t *input3,
Gilles Peskine96ee5c72018-07-12 17:24:54 +02005202 int requested_capacity_arg,
5203 data_t *expected_output1,
5204 data_t *expected_output2 )
5205{
Gilles Peskine96ee5c72018-07-12 17:24:54 +02005206 psa_algorithm_t alg = alg_arg;
Gilles Peskine1468da72019-05-29 17:35:49 +02005207 psa_key_derivation_step_t steps[] = {step1_arg, step2_arg, step3_arg};
5208 data_t *inputs[] = {input1, input2, input3};
Ronald Cron5425a212020-08-04 14:58:35 +02005209 mbedtls_svc_key_id_t keys[] = { MBEDTLS_SVC_KEY_ID_INIT,
5210 MBEDTLS_SVC_KEY_ID_INIT,
5211 MBEDTLS_SVC_KEY_ID_INIT };
Gilles Peskine96ee5c72018-07-12 17:24:54 +02005212 size_t requested_capacity = requested_capacity_arg;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005213 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Gilles Peskine96ee5c72018-07-12 17:24:54 +02005214 uint8_t *expected_outputs[2] =
5215 {expected_output1->x, expected_output2->x};
5216 size_t output_sizes[2] =
5217 {expected_output1->len, expected_output2->len};
5218 size_t output_buffer_size = 0;
5219 uint8_t *output_buffer = NULL;
5220 size_t expected_capacity;
5221 size_t current_capacity;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005222 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine96ee5c72018-07-12 17:24:54 +02005223 psa_status_t status;
Gilles Peskine1468da72019-05-29 17:35:49 +02005224 size_t i;
Gilles Peskine96ee5c72018-07-12 17:24:54 +02005225
5226 for( i = 0; i < ARRAY_LENGTH( expected_outputs ); i++ )
5227 {
5228 if( output_sizes[i] > output_buffer_size )
5229 output_buffer_size = output_sizes[i];
5230 if( output_sizes[i] == 0 )
5231 expected_outputs[i] = NULL;
5232 }
Gilles Peskine8cebbba2018-09-27 13:54:18 +02005233 ASSERT_ALLOC( output_buffer, output_buffer_size );
Gilles Peskine8817f612018-12-18 00:18:46 +01005234 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine96ee5c72018-07-12 17:24:54 +02005235
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005236 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DERIVE );
5237 psa_set_key_algorithm( &attributes, alg );
5238 psa_set_key_type( &attributes, PSA_KEY_TYPE_DERIVE );
Gilles Peskine96ee5c72018-07-12 17:24:54 +02005239
Gilles Peskine96ee5c72018-07-12 17:24:54 +02005240 /* Extraction phase. */
Gilles Peskine1468da72019-05-29 17:35:49 +02005241 PSA_ASSERT( psa_key_derivation_setup( &operation, alg ) );
5242 PSA_ASSERT( psa_key_derivation_set_capacity( &operation,
5243 requested_capacity ) );
5244 for( i = 0; i < ARRAY_LENGTH( steps ); i++ )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005245 {
Gilles Peskine1468da72019-05-29 17:35:49 +02005246 switch( steps[i] )
5247 {
5248 case 0:
5249 break;
5250 case PSA_KEY_DERIVATION_INPUT_SECRET:
5251 PSA_ASSERT( psa_import_key( &attributes,
5252 inputs[i]->x, inputs[i]->len,
Ronald Cron5425a212020-08-04 14:58:35 +02005253 &keys[i] ) );
gabor-mezei-armceface22021-01-21 12:26:17 +01005254
5255 if ( PSA_ALG_IS_TLS12_PSK_TO_MS( alg ) )
5256 {
5257 PSA_ASSERT( psa_get_key_attributes( keys[i], &attributes ) );
5258 TEST_ASSERT( PSA_BITS_TO_BYTES( psa_get_key_bits( &attributes ) ) <=
5259 PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE );
5260 }
5261
Gilles Peskine1468da72019-05-29 17:35:49 +02005262 PSA_ASSERT( psa_key_derivation_input_key(
Ronald Cron5425a212020-08-04 14:58:35 +02005263 &operation, steps[i], keys[i] ) );
Gilles Peskine1468da72019-05-29 17:35:49 +02005264 break;
5265 default:
5266 PSA_ASSERT( psa_key_derivation_input_bytes(
5267 &operation, steps[i],
5268 inputs[i]->x, inputs[i]->len ) );
5269 break;
5270 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005271 }
Gilles Peskine1468da72019-05-29 17:35:49 +02005272
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005273 PSA_ASSERT( psa_key_derivation_get_capacity( &operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005274 &current_capacity ) );
Gilles Peskinefe11b722018-12-18 00:24:04 +01005275 TEST_EQUAL( current_capacity, requested_capacity );
Gilles Peskine96ee5c72018-07-12 17:24:54 +02005276 expected_capacity = requested_capacity;
5277
5278 /* Expansion phase. */
5279 for( i = 0; i < ARRAY_LENGTH( expected_outputs ); i++ )
5280 {
5281 /* Read some bytes. */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005282 status = psa_key_derivation_output_bytes( &operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005283 output_buffer, output_sizes[i] );
Gilles Peskine96ee5c72018-07-12 17:24:54 +02005284 if( expected_capacity == 0 && output_sizes[i] == 0 )
5285 {
5286 /* Reading 0 bytes when 0 bytes are available can go either way. */
5287 TEST_ASSERT( status == PSA_SUCCESS ||
David Saadab4ecc272019-02-14 13:48:10 +02005288 status == PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskine96ee5c72018-07-12 17:24:54 +02005289 continue;
5290 }
5291 else if( expected_capacity == 0 ||
5292 output_sizes[i] > expected_capacity )
5293 {
5294 /* Capacity exceeded. */
David Saadab4ecc272019-02-14 13:48:10 +02005295 TEST_EQUAL( status, PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskine96ee5c72018-07-12 17:24:54 +02005296 expected_capacity = 0;
5297 continue;
5298 }
5299 /* Success. Check the read data. */
Gilles Peskine8817f612018-12-18 00:18:46 +01005300 PSA_ASSERT( status );
Gilles Peskine96ee5c72018-07-12 17:24:54 +02005301 if( output_sizes[i] != 0 )
Gilles Peskine0dfba2d2018-12-18 00:40:50 +01005302 ASSERT_COMPARE( output_buffer, output_sizes[i],
5303 expected_outputs[i], output_sizes[i] );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005304 /* Check the operation status. */
Gilles Peskine96ee5c72018-07-12 17:24:54 +02005305 expected_capacity -= output_sizes[i];
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005306 PSA_ASSERT( psa_key_derivation_get_capacity( &operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005307 &current_capacity ) );
Gilles Peskinefe11b722018-12-18 00:24:04 +01005308 TEST_EQUAL( expected_capacity, current_capacity );
Gilles Peskine96ee5c72018-07-12 17:24:54 +02005309 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005310 PSA_ASSERT( psa_key_derivation_abort( &operation ) );
Gilles Peskine96ee5c72018-07-12 17:24:54 +02005311
5312exit:
5313 mbedtls_free( output_buffer );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005314 psa_key_derivation_abort( &operation );
Ronald Cron5425a212020-08-04 14:58:35 +02005315 for( i = 0; i < ARRAY_LENGTH( keys ); i++ )
5316 psa_destroy_key( keys[i] );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02005317 PSA_DONE( );
Gilles Peskine96ee5c72018-07-12 17:24:54 +02005318}
5319/* END_CASE */
5320
5321/* BEGIN_CASE */
Gilles Peskined54931c2018-07-17 21:06:59 +02005322void derive_full( int alg_arg,
5323 data_t *key_data,
Janos Follath47f27ed2019-06-25 13:24:52 +01005324 data_t *input1,
5325 data_t *input2,
Gilles Peskined54931c2018-07-17 21:06:59 +02005326 int requested_capacity_arg )
5327{
Ronald Cron5425a212020-08-04 14:58:35 +02005328 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined54931c2018-07-17 21:06:59 +02005329 psa_algorithm_t alg = alg_arg;
5330 size_t requested_capacity = requested_capacity_arg;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005331 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Gilles Peskined54931c2018-07-17 21:06:59 +02005332 unsigned char output_buffer[16];
5333 size_t expected_capacity = requested_capacity;
5334 size_t current_capacity;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005335 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskined54931c2018-07-17 21:06:59 +02005336
Gilles Peskine8817f612018-12-18 00:18:46 +01005337 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskined54931c2018-07-17 21:06:59 +02005338
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005339 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DERIVE );
5340 psa_set_key_algorithm( &attributes, alg );
5341 psa_set_key_type( &attributes, PSA_KEY_TYPE_DERIVE );
Gilles Peskined54931c2018-07-17 21:06:59 +02005342
Gilles Peskine049c7532019-05-15 20:22:09 +02005343 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02005344 &key ) );
Gilles Peskined54931c2018-07-17 21:06:59 +02005345
Gilles Peskinec18e25f2021-02-12 23:48:20 +01005346 if( !mbedtls_test_psa_setup_key_derivation_wrap( &operation, key, alg,
5347 input1->x, input1->len,
5348 input2->x, input2->len,
5349 requested_capacity ) )
Janos Follathf2815ea2019-07-03 12:41:36 +01005350 goto exit;
Janos Follath47f27ed2019-06-25 13:24:52 +01005351
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005352 PSA_ASSERT( psa_key_derivation_get_capacity( &operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005353 &current_capacity ) );
Gilles Peskinefe11b722018-12-18 00:24:04 +01005354 TEST_EQUAL( current_capacity, expected_capacity );
Gilles Peskined54931c2018-07-17 21:06:59 +02005355
5356 /* Expansion phase. */
5357 while( current_capacity > 0 )
5358 {
5359 size_t read_size = sizeof( output_buffer );
5360 if( read_size > current_capacity )
5361 read_size = current_capacity;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005362 PSA_ASSERT( psa_key_derivation_output_bytes( &operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005363 output_buffer,
5364 read_size ) );
Gilles Peskined54931c2018-07-17 21:06:59 +02005365 expected_capacity -= read_size;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005366 PSA_ASSERT( psa_key_derivation_get_capacity( &operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005367 &current_capacity ) );
Gilles Peskinefe11b722018-12-18 00:24:04 +01005368 TEST_EQUAL( current_capacity, expected_capacity );
Gilles Peskined54931c2018-07-17 21:06:59 +02005369 }
5370
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005371 /* Check that the operation refuses to go over capacity. */
5372 TEST_EQUAL( psa_key_derivation_output_bytes( &operation, output_buffer, 1 ),
David Saadab4ecc272019-02-14 13:48:10 +02005373 PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskined54931c2018-07-17 21:06:59 +02005374
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005375 PSA_ASSERT( psa_key_derivation_abort( &operation ) );
Gilles Peskined54931c2018-07-17 21:06:59 +02005376
5377exit:
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005378 psa_key_derivation_abort( &operation );
Ronald Cron5425a212020-08-04 14:58:35 +02005379 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02005380 PSA_DONE( );
Gilles Peskined54931c2018-07-17 21:06:59 +02005381}
5382/* END_CASE */
5383
Janos Follathe60c9052019-07-03 13:51:30 +01005384/* BEGIN_CASE */
Gilles Peskine0386fba2018-07-12 17:29:22 +02005385void derive_key_exercise( int alg_arg,
5386 data_t *key_data,
Janos Follathe60c9052019-07-03 13:51:30 +01005387 data_t *input1,
5388 data_t *input2,
Gilles Peskine0386fba2018-07-12 17:29:22 +02005389 int derived_type_arg,
5390 int derived_bits_arg,
5391 int derived_usage_arg,
5392 int derived_alg_arg )
5393{
Ronald Cron5425a212020-08-04 14:58:35 +02005394 mbedtls_svc_key_id_t base_key = MBEDTLS_SVC_KEY_ID_INIT;
5395 mbedtls_svc_key_id_t derived_key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine0386fba2018-07-12 17:29:22 +02005396 psa_algorithm_t alg = alg_arg;
5397 psa_key_type_t derived_type = derived_type_arg;
5398 size_t derived_bits = derived_bits_arg;
5399 psa_key_usage_t derived_usage = derived_usage_arg;
5400 psa_algorithm_t derived_alg = derived_alg_arg;
5401 size_t capacity = PSA_BITS_TO_BYTES( derived_bits );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005402 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005403 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02005404 psa_key_attributes_t got_attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine0386fba2018-07-12 17:29:22 +02005405
Gilles Peskine8817f612018-12-18 00:18:46 +01005406 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine0386fba2018-07-12 17:29:22 +02005407
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005408 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DERIVE );
5409 psa_set_key_algorithm( &attributes, alg );
5410 psa_set_key_type( &attributes, PSA_KEY_TYPE_DERIVE );
Gilles Peskine049c7532019-05-15 20:22:09 +02005411 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02005412 &base_key ) );
Gilles Peskine0386fba2018-07-12 17:29:22 +02005413
5414 /* Derive a key. */
Gilles Peskinec18e25f2021-02-12 23:48:20 +01005415 if ( mbedtls_test_psa_setup_key_derivation_wrap( &operation, base_key, alg,
5416 input1->x, input1->len,
5417 input2->x, input2->len,
5418 capacity ) )
Janos Follathe60c9052019-07-03 13:51:30 +01005419 goto exit;
5420
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005421 psa_set_key_usage_flags( &attributes, derived_usage );
5422 psa_set_key_algorithm( &attributes, derived_alg );
5423 psa_set_key_type( &attributes, derived_type );
Gilles Peskine3a4f1f82019-04-26 13:49:28 +02005424 psa_set_key_bits( &attributes, derived_bits );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005425 PSA_ASSERT( psa_key_derivation_output_key( &attributes, &operation,
Ronald Cron5425a212020-08-04 14:58:35 +02005426 &derived_key ) );
Gilles Peskine0386fba2018-07-12 17:29:22 +02005427
5428 /* Test the key information */
Ronald Cron5425a212020-08-04 14:58:35 +02005429 PSA_ASSERT( psa_get_key_attributes( derived_key, &got_attributes ) );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02005430 TEST_EQUAL( psa_get_key_type( &got_attributes ), derived_type );
5431 TEST_EQUAL( psa_get_key_bits( &got_attributes ), derived_bits );
Gilles Peskine0386fba2018-07-12 17:29:22 +02005432
5433 /* Exercise the derived key. */
Gilles Peskinec18e25f2021-02-12 23:48:20 +01005434 if( ! mbedtls_test_psa_exercise_key( derived_key, derived_usage, derived_alg ) )
Gilles Peskine0386fba2018-07-12 17:29:22 +02005435 goto exit;
5436
5437exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +01005438 /*
5439 * Key attributes may have been returned by psa_get_key_attributes()
5440 * thus reset them as required.
5441 */
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02005442 psa_reset_key_attributes( &got_attributes );
Ronald Cron3a4f0e32020-11-19 17:55:23 +01005443
5444 psa_key_derivation_abort( &operation );
Ronald Cron5425a212020-08-04 14:58:35 +02005445 psa_destroy_key( base_key );
5446 psa_destroy_key( derived_key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02005447 PSA_DONE( );
Gilles Peskine0386fba2018-07-12 17:29:22 +02005448}
5449/* END_CASE */
5450
Janos Follath42fd8882019-07-03 14:17:09 +01005451/* BEGIN_CASE */
Gilles Peskine0386fba2018-07-12 17:29:22 +02005452void derive_key_export( int alg_arg,
5453 data_t *key_data,
Janos Follath42fd8882019-07-03 14:17:09 +01005454 data_t *input1,
5455 data_t *input2,
Gilles Peskine0386fba2018-07-12 17:29:22 +02005456 int bytes1_arg,
5457 int bytes2_arg )
5458{
Ronald Cron5425a212020-08-04 14:58:35 +02005459 mbedtls_svc_key_id_t base_key = MBEDTLS_SVC_KEY_ID_INIT;
5460 mbedtls_svc_key_id_t derived_key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine0386fba2018-07-12 17:29:22 +02005461 psa_algorithm_t alg = alg_arg;
5462 size_t bytes1 = bytes1_arg;
5463 size_t bytes2 = bytes2_arg;
5464 size_t capacity = bytes1 + bytes2;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005465 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Gilles Peskine8cebbba2018-09-27 13:54:18 +02005466 uint8_t *output_buffer = NULL;
5467 uint8_t *export_buffer = NULL;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005468 psa_key_attributes_t base_attributes = PSA_KEY_ATTRIBUTES_INIT;
5469 psa_key_attributes_t derived_attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine0386fba2018-07-12 17:29:22 +02005470 size_t length;
5471
Gilles Peskine8cebbba2018-09-27 13:54:18 +02005472 ASSERT_ALLOC( output_buffer, capacity );
5473 ASSERT_ALLOC( export_buffer, capacity );
Gilles Peskine8817f612018-12-18 00:18:46 +01005474 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine0386fba2018-07-12 17:29:22 +02005475
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005476 psa_set_key_usage_flags( &base_attributes, PSA_KEY_USAGE_DERIVE );
5477 psa_set_key_algorithm( &base_attributes, alg );
5478 psa_set_key_type( &base_attributes, PSA_KEY_TYPE_DERIVE );
Gilles Peskine049c7532019-05-15 20:22:09 +02005479 PSA_ASSERT( psa_import_key( &base_attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02005480 &base_key ) );
Gilles Peskine0386fba2018-07-12 17:29:22 +02005481
5482 /* Derive some material and output it. */
Gilles Peskinec18e25f2021-02-12 23:48:20 +01005483 if( !mbedtls_test_psa_setup_key_derivation_wrap( &operation, base_key, alg,
5484 input1->x, input1->len,
5485 input2->x, input2->len,
5486 capacity ) )
Janos Follath42fd8882019-07-03 14:17:09 +01005487 goto exit;
5488
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005489 PSA_ASSERT( psa_key_derivation_output_bytes( &operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005490 output_buffer,
5491 capacity ) );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005492 PSA_ASSERT( psa_key_derivation_abort( &operation ) );
Gilles Peskine0386fba2018-07-12 17:29:22 +02005493
5494 /* Derive the same output again, but this time store it in key objects. */
Gilles Peskinec18e25f2021-02-12 23:48:20 +01005495 if( !mbedtls_test_psa_setup_key_derivation_wrap( &operation, base_key, alg,
5496 input1->x, input1->len,
5497 input2->x, input2->len,
5498 capacity ) )
Janos Follath42fd8882019-07-03 14:17:09 +01005499 goto exit;
5500
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005501 psa_set_key_usage_flags( &derived_attributes, PSA_KEY_USAGE_EXPORT );
5502 psa_set_key_algorithm( &derived_attributes, 0 );
5503 psa_set_key_type( &derived_attributes, PSA_KEY_TYPE_RAW_DATA );
Gilles Peskine3a4f1f82019-04-26 13:49:28 +02005504 psa_set_key_bits( &derived_attributes, PSA_BYTES_TO_BITS( bytes1 ) );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005505 PSA_ASSERT( psa_key_derivation_output_key( &derived_attributes, &operation,
Ronald Cron5425a212020-08-04 14:58:35 +02005506 &derived_key ) );
5507 PSA_ASSERT( psa_export_key( derived_key,
Gilles Peskine8817f612018-12-18 00:18:46 +01005508 export_buffer, bytes1,
5509 &length ) );
Gilles Peskinefe11b722018-12-18 00:24:04 +01005510 TEST_EQUAL( length, bytes1 );
Ronald Cron5425a212020-08-04 14:58:35 +02005511 PSA_ASSERT( psa_destroy_key( derived_key ) );
Gilles Peskine3a4f1f82019-04-26 13:49:28 +02005512 psa_set_key_bits( &derived_attributes, PSA_BYTES_TO_BITS( bytes2 ) );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005513 PSA_ASSERT( psa_key_derivation_output_key( &derived_attributes, &operation,
Ronald Cron5425a212020-08-04 14:58:35 +02005514 &derived_key ) );
5515 PSA_ASSERT( psa_export_key( derived_key,
Gilles Peskine8817f612018-12-18 00:18:46 +01005516 export_buffer + bytes1, bytes2,
5517 &length ) );
Gilles Peskinefe11b722018-12-18 00:24:04 +01005518 TEST_EQUAL( length, bytes2 );
Gilles Peskine0386fba2018-07-12 17:29:22 +02005519
5520 /* Compare the outputs from the two runs. */
Gilles Peskine0dfba2d2018-12-18 00:40:50 +01005521 ASSERT_COMPARE( output_buffer, bytes1 + bytes2,
5522 export_buffer, capacity );
Gilles Peskine0386fba2018-07-12 17:29:22 +02005523
5524exit:
5525 mbedtls_free( output_buffer );
5526 mbedtls_free( export_buffer );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005527 psa_key_derivation_abort( &operation );
Ronald Cron5425a212020-08-04 14:58:35 +02005528 psa_destroy_key( base_key );
5529 psa_destroy_key( derived_key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02005530 PSA_DONE( );
Gilles Peskine0386fba2018-07-12 17:29:22 +02005531}
5532/* END_CASE */
5533
5534/* BEGIN_CASE */
Gilles Peskine7c227ae2019-07-31 15:14:44 +02005535void derive_key( int alg_arg,
5536 data_t *key_data, data_t *input1, data_t *input2,
5537 int type_arg, int bits_arg,
Steven Cooreman83fdb702021-01-21 14:24:39 +01005538 int expected_status_arg,
5539 int is_large_output )
Gilles Peskinec744d992019-07-30 17:26:54 +02005540{
Ronald Cron5425a212020-08-04 14:58:35 +02005541 mbedtls_svc_key_id_t base_key = MBEDTLS_SVC_KEY_ID_INIT;
5542 mbedtls_svc_key_id_t derived_key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskinec744d992019-07-30 17:26:54 +02005543 psa_algorithm_t alg = alg_arg;
Gilles Peskine7c227ae2019-07-31 15:14:44 +02005544 psa_key_type_t type = type_arg;
Gilles Peskinec744d992019-07-30 17:26:54 +02005545 size_t bits = bits_arg;
5546 psa_status_t expected_status = expected_status_arg;
5547 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
5548 psa_key_attributes_t base_attributes = PSA_KEY_ATTRIBUTES_INIT;
5549 psa_key_attributes_t derived_attributes = PSA_KEY_ATTRIBUTES_INIT;
5550
5551 PSA_ASSERT( psa_crypto_init( ) );
5552
5553 psa_set_key_usage_flags( &base_attributes, PSA_KEY_USAGE_DERIVE );
5554 psa_set_key_algorithm( &base_attributes, alg );
5555 psa_set_key_type( &base_attributes, PSA_KEY_TYPE_DERIVE );
5556 PSA_ASSERT( psa_import_key( &base_attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02005557 &base_key ) );
Gilles Peskinec744d992019-07-30 17:26:54 +02005558
Gilles Peskinec18e25f2021-02-12 23:48:20 +01005559 if( !mbedtls_test_psa_setup_key_derivation_wrap( &operation, base_key, alg,
5560 input1->x, input1->len,
5561 input2->x, input2->len,
5562 SIZE_MAX ) )
Gilles Peskinec744d992019-07-30 17:26:54 +02005563 goto exit;
5564
5565 psa_set_key_usage_flags( &derived_attributes, PSA_KEY_USAGE_EXPORT );
5566 psa_set_key_algorithm( &derived_attributes, 0 );
Gilles Peskine7c227ae2019-07-31 15:14:44 +02005567 psa_set_key_type( &derived_attributes, type );
Gilles Peskinec744d992019-07-30 17:26:54 +02005568 psa_set_key_bits( &derived_attributes, bits );
Steven Cooreman83fdb702021-01-21 14:24:39 +01005569
5570 psa_status_t status =
5571 psa_key_derivation_output_key( &derived_attributes,
5572 &operation,
5573 &derived_key );
5574 if( is_large_output > 0 )
5575 TEST_ASSUME( status != PSA_ERROR_INSUFFICIENT_MEMORY );
5576 TEST_EQUAL( status, expected_status );
Gilles Peskinec744d992019-07-30 17:26:54 +02005577
5578exit:
5579 psa_key_derivation_abort( &operation );
Ronald Cron5425a212020-08-04 14:58:35 +02005580 psa_destroy_key( base_key );
5581 psa_destroy_key( derived_key );
Gilles Peskinec744d992019-07-30 17:26:54 +02005582 PSA_DONE( );
5583}
5584/* END_CASE */
5585
5586/* BEGIN_CASE */
Gilles Peskine01d718c2018-09-18 12:01:02 +02005587void key_agreement_setup( int alg_arg,
Steven Cooremance48e852020-10-05 16:02:45 +02005588 int our_key_type_arg, int our_key_alg_arg,
5589 data_t *our_key_data, data_t *peer_key_data,
Gilles Peskine01d718c2018-09-18 12:01:02 +02005590 int expected_status_arg )
5591{
Ronald Cron5425a212020-08-04 14:58:35 +02005592 mbedtls_svc_key_id_t our_key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine01d718c2018-09-18 12:01:02 +02005593 psa_algorithm_t alg = alg_arg;
Steven Cooremanfa5e6312020-10-15 17:07:12 +02005594 psa_algorithm_t our_key_alg = our_key_alg_arg;
Gilles Peskine01d718c2018-09-18 12:01:02 +02005595 psa_key_type_t our_key_type = our_key_type_arg;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005596 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005597 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine77f40d82019-04-11 21:27:06 +02005598 psa_status_t expected_status = expected_status_arg;
5599 psa_status_t status;
Gilles Peskine01d718c2018-09-18 12:01:02 +02005600
Gilles Peskine8817f612018-12-18 00:18:46 +01005601 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005602
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005603 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DERIVE );
Steven Cooremanfa5e6312020-10-15 17:07:12 +02005604 psa_set_key_algorithm( &attributes, our_key_alg );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005605 psa_set_key_type( &attributes, our_key_type );
Gilles Peskine049c7532019-05-15 20:22:09 +02005606 PSA_ASSERT( psa_import_key( &attributes,
5607 our_key_data->x, our_key_data->len,
5608 &our_key ) );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005609
Gilles Peskine77f40d82019-04-11 21:27:06 +02005610 /* The tests currently include inputs that should fail at either step.
5611 * Test cases that fail at the setup step should be changed to call
5612 * key_derivation_setup instead, and this function should be renamed
5613 * to key_agreement_fail. */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005614 status = psa_key_derivation_setup( &operation, alg );
Gilles Peskine77f40d82019-04-11 21:27:06 +02005615 if( status == PSA_SUCCESS )
5616 {
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005617 TEST_EQUAL( psa_key_derivation_key_agreement(
5618 &operation, PSA_KEY_DERIVATION_INPUT_SECRET,
5619 our_key,
5620 peer_key_data->x, peer_key_data->len ),
Gilles Peskine77f40d82019-04-11 21:27:06 +02005621 expected_status );
5622 }
5623 else
5624 {
5625 TEST_ASSERT( status == expected_status );
5626 }
Gilles Peskine01d718c2018-09-18 12:01:02 +02005627
5628exit:
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005629 psa_key_derivation_abort( &operation );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005630 psa_destroy_key( our_key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02005631 PSA_DONE( );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005632}
5633/* END_CASE */
5634
5635/* BEGIN_CASE */
Gilles Peskinef0cba732019-04-11 22:12:38 +02005636void raw_key_agreement( int alg_arg,
5637 int our_key_type_arg, data_t *our_key_data,
5638 data_t *peer_key_data,
5639 data_t *expected_output )
5640{
Ronald Cron5425a212020-08-04 14:58:35 +02005641 mbedtls_svc_key_id_t our_key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskinef0cba732019-04-11 22:12:38 +02005642 psa_algorithm_t alg = alg_arg;
5643 psa_key_type_t our_key_type = our_key_type_arg;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005644 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskinef0cba732019-04-11 22:12:38 +02005645 unsigned char *output = NULL;
5646 size_t output_length = ~0;
gabor-mezei-armceface22021-01-21 12:26:17 +01005647 size_t key_bits;
Gilles Peskinef0cba732019-04-11 22:12:38 +02005648
5649 ASSERT_ALLOC( output, expected_output->len );
5650 PSA_ASSERT( psa_crypto_init( ) );
5651
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005652 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DERIVE );
5653 psa_set_key_algorithm( &attributes, alg );
5654 psa_set_key_type( &attributes, our_key_type );
Gilles Peskine049c7532019-05-15 20:22:09 +02005655 PSA_ASSERT( psa_import_key( &attributes,
5656 our_key_data->x, our_key_data->len,
5657 &our_key ) );
Gilles Peskinef0cba732019-04-11 22:12:38 +02005658
gabor-mezei-armceface22021-01-21 12:26:17 +01005659 PSA_ASSERT( psa_get_key_attributes( our_key, &attributes ) );
5660 key_bits = psa_get_key_bits( &attributes );
5661
Gilles Peskinebe697d82019-05-16 18:00:41 +02005662 PSA_ASSERT( psa_raw_key_agreement( alg, our_key,
5663 peer_key_data->x, peer_key_data->len,
5664 output, expected_output->len,
5665 &output_length ) );
Gilles Peskinef0cba732019-04-11 22:12:38 +02005666 ASSERT_COMPARE( output, output_length,
5667 expected_output->x, expected_output->len );
gabor-mezei-armceface22021-01-21 12:26:17 +01005668 TEST_ASSERT( output_length <=
5669 PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE( our_key_type, key_bits ) );
5670 TEST_ASSERT( output_length <=
5671 PSA_RAW_KEY_AGREEMENT_OUTPUT_MAX_SIZE );
Gilles Peskinef0cba732019-04-11 22:12:38 +02005672
5673exit:
5674 mbedtls_free( output );
5675 psa_destroy_key( our_key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02005676 PSA_DONE( );
Gilles Peskinef0cba732019-04-11 22:12:38 +02005677}
5678/* END_CASE */
5679
5680/* BEGIN_CASE */
Gilles Peskine59685592018-09-18 12:11:34 +02005681void key_agreement_capacity( int alg_arg,
5682 int our_key_type_arg, data_t *our_key_data,
5683 data_t *peer_key_data,
5684 int expected_capacity_arg )
5685{
Ronald Cron5425a212020-08-04 14:58:35 +02005686 mbedtls_svc_key_id_t our_key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine59685592018-09-18 12:11:34 +02005687 psa_algorithm_t alg = alg_arg;
5688 psa_key_type_t our_key_type = our_key_type_arg;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005689 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005690 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine59685592018-09-18 12:11:34 +02005691 size_t actual_capacity;
Gilles Peskinebf491972018-10-25 22:36:12 +02005692 unsigned char output[16];
Gilles Peskine59685592018-09-18 12:11:34 +02005693
Gilles Peskine8817f612018-12-18 00:18:46 +01005694 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine59685592018-09-18 12:11:34 +02005695
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005696 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DERIVE );
5697 psa_set_key_algorithm( &attributes, alg );
5698 psa_set_key_type( &attributes, our_key_type );
Gilles Peskine049c7532019-05-15 20:22:09 +02005699 PSA_ASSERT( psa_import_key( &attributes,
5700 our_key_data->x, our_key_data->len,
5701 &our_key ) );
Gilles Peskine59685592018-09-18 12:11:34 +02005702
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005703 PSA_ASSERT( psa_key_derivation_setup( &operation, alg ) );
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005704 PSA_ASSERT( psa_key_derivation_key_agreement(
5705 &operation,
5706 PSA_KEY_DERIVATION_INPUT_SECRET, our_key,
5707 peer_key_data->x, peer_key_data->len ) );
Gilles Peskinef8a9d942019-04-11 22:13:20 +02005708 if( PSA_ALG_IS_HKDF( PSA_ALG_KEY_AGREEMENT_GET_KDF( alg ) ) )
5709 {
5710 /* The test data is for info="" */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005711 PSA_ASSERT( psa_key_derivation_input_bytes( &operation,
Gilles Peskine03410b52019-05-16 16:05:19 +02005712 PSA_KEY_DERIVATION_INPUT_INFO,
Gilles Peskinef8a9d942019-04-11 22:13:20 +02005713 NULL, 0 ) );
5714 }
Gilles Peskine59685592018-09-18 12:11:34 +02005715
Gilles Peskinebf491972018-10-25 22:36:12 +02005716 /* Test the advertized capacity. */
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005717 PSA_ASSERT( psa_key_derivation_get_capacity(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005718 &operation, &actual_capacity ) );
Gilles Peskinefe11b722018-12-18 00:24:04 +01005719 TEST_EQUAL( actual_capacity, (size_t) expected_capacity_arg );
Gilles Peskine59685592018-09-18 12:11:34 +02005720
Gilles Peskinebf491972018-10-25 22:36:12 +02005721 /* Test the actual capacity by reading the output. */
5722 while( actual_capacity > sizeof( output ) )
5723 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005724 PSA_ASSERT( psa_key_derivation_output_bytes( &operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005725 output, sizeof( output ) ) );
Gilles Peskinebf491972018-10-25 22:36:12 +02005726 actual_capacity -= sizeof( output );
5727 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005728 PSA_ASSERT( psa_key_derivation_output_bytes( &operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005729 output, actual_capacity ) );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005730 TEST_EQUAL( psa_key_derivation_output_bytes( &operation, output, 1 ),
David Saadab4ecc272019-02-14 13:48:10 +02005731 PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskinebf491972018-10-25 22:36:12 +02005732
Gilles Peskine59685592018-09-18 12:11:34 +02005733exit:
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005734 psa_key_derivation_abort( &operation );
Gilles Peskine59685592018-09-18 12:11:34 +02005735 psa_destroy_key( our_key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02005736 PSA_DONE( );
Gilles Peskine59685592018-09-18 12:11:34 +02005737}
5738/* END_CASE */
5739
5740/* BEGIN_CASE */
5741void key_agreement_output( int alg_arg,
5742 int our_key_type_arg, data_t *our_key_data,
5743 data_t *peer_key_data,
Gilles Peskine3ec8ed82018-10-25 22:37:15 +02005744 data_t *expected_output1, data_t *expected_output2 )
Gilles Peskine59685592018-09-18 12:11:34 +02005745{
Ronald Cron5425a212020-08-04 14:58:35 +02005746 mbedtls_svc_key_id_t our_key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine59685592018-09-18 12:11:34 +02005747 psa_algorithm_t alg = alg_arg;
5748 psa_key_type_t our_key_type = our_key_type_arg;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005749 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005750 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine3ec8ed82018-10-25 22:37:15 +02005751 uint8_t *actual_output = NULL;
Gilles Peskine59685592018-09-18 12:11:34 +02005752
Gilles Peskine3ec8ed82018-10-25 22:37:15 +02005753 ASSERT_ALLOC( actual_output, MAX( expected_output1->len,
5754 expected_output2->len ) );
Gilles Peskine59685592018-09-18 12:11:34 +02005755
Gilles Peskine8817f612018-12-18 00:18:46 +01005756 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine59685592018-09-18 12:11:34 +02005757
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005758 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DERIVE );
5759 psa_set_key_algorithm( &attributes, alg );
5760 psa_set_key_type( &attributes, our_key_type );
Gilles Peskine049c7532019-05-15 20:22:09 +02005761 PSA_ASSERT( psa_import_key( &attributes,
5762 our_key_data->x, our_key_data->len,
5763 &our_key ) );
Gilles Peskine59685592018-09-18 12:11:34 +02005764
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005765 PSA_ASSERT( psa_key_derivation_setup( &operation, alg ) );
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005766 PSA_ASSERT( psa_key_derivation_key_agreement(
5767 &operation,
5768 PSA_KEY_DERIVATION_INPUT_SECRET, our_key,
5769 peer_key_data->x, peer_key_data->len ) );
Gilles Peskinef8a9d942019-04-11 22:13:20 +02005770 if( PSA_ALG_IS_HKDF( PSA_ALG_KEY_AGREEMENT_GET_KDF( alg ) ) )
5771 {
5772 /* The test data is for info="" */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005773 PSA_ASSERT( psa_key_derivation_input_bytes( &operation,
Gilles Peskine03410b52019-05-16 16:05:19 +02005774 PSA_KEY_DERIVATION_INPUT_INFO,
Gilles Peskinef8a9d942019-04-11 22:13:20 +02005775 NULL, 0 ) );
5776 }
Gilles Peskine59685592018-09-18 12:11:34 +02005777
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005778 PSA_ASSERT( psa_key_derivation_output_bytes( &operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005779 actual_output,
5780 expected_output1->len ) );
Gilles Peskine0dfba2d2018-12-18 00:40:50 +01005781 ASSERT_COMPARE( actual_output, expected_output1->len,
5782 expected_output1->x, expected_output1->len );
Gilles Peskine3ec8ed82018-10-25 22:37:15 +02005783 if( expected_output2->len != 0 )
5784 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005785 PSA_ASSERT( psa_key_derivation_output_bytes( &operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005786 actual_output,
5787 expected_output2->len ) );
Gilles Peskine0dfba2d2018-12-18 00:40:50 +01005788 ASSERT_COMPARE( actual_output, expected_output2->len,
5789 expected_output2->x, expected_output2->len );
Gilles Peskine3ec8ed82018-10-25 22:37:15 +02005790 }
Gilles Peskine59685592018-09-18 12:11:34 +02005791
5792exit:
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005793 psa_key_derivation_abort( &operation );
Gilles Peskine59685592018-09-18 12:11:34 +02005794 psa_destroy_key( our_key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02005795 PSA_DONE( );
Gilles Peskine59685592018-09-18 12:11:34 +02005796 mbedtls_free( actual_output );
5797}
5798/* END_CASE */
5799
5800/* BEGIN_CASE */
Gilles Peskinea50d7392018-06-21 10:22:13 +02005801void generate_random( int bytes_arg )
Gilles Peskine05d69892018-06-19 22:00:52 +02005802{
Gilles Peskinea50d7392018-06-21 10:22:13 +02005803 size_t bytes = bytes_arg;
Gilles Peskine8cebbba2018-09-27 13:54:18 +02005804 unsigned char *output = NULL;
5805 unsigned char *changed = NULL;
Gilles Peskinea50d7392018-06-21 10:22:13 +02005806 size_t i;
5807 unsigned run;
Gilles Peskine05d69892018-06-19 22:00:52 +02005808
Simon Butcher49f8e312020-03-03 15:51:50 +00005809 TEST_ASSERT( bytes_arg >= 0 );
5810
Gilles Peskine91892022021-02-08 19:50:26 +01005811 ASSERT_ALLOC( output, bytes );
Gilles Peskine8cebbba2018-09-27 13:54:18 +02005812 ASSERT_ALLOC( changed, bytes );
Gilles Peskine05d69892018-06-19 22:00:52 +02005813
Gilles Peskine8817f612018-12-18 00:18:46 +01005814 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine05d69892018-06-19 22:00:52 +02005815
Gilles Peskinea50d7392018-06-21 10:22:13 +02005816 /* Run several times, to ensure that every output byte will be
5817 * nonzero at least once with overwhelming probability
5818 * (2^(-8*number_of_runs)). */
5819 for( run = 0; run < 10; run++ )
Gilles Peskine05d69892018-06-19 22:00:52 +02005820 {
Gilles Peskinef7ab5ad2018-09-26 18:19:24 +02005821 if( bytes != 0 )
5822 memset( output, 0, bytes );
Gilles Peskine8817f612018-12-18 00:18:46 +01005823 PSA_ASSERT( psa_generate_random( output, bytes ) );
Gilles Peskinea50d7392018-06-21 10:22:13 +02005824
Gilles Peskinea50d7392018-06-21 10:22:13 +02005825 for( i = 0; i < bytes; i++ )
5826 {
5827 if( output[i] != 0 )
5828 ++changed[i];
5829 }
Gilles Peskine05d69892018-06-19 22:00:52 +02005830 }
Gilles Peskinea50d7392018-06-21 10:22:13 +02005831
5832 /* Check that every byte was changed to nonzero at least once. This
5833 * validates that psa_generate_random is overwriting every byte of
5834 * the output buffer. */
5835 for( i = 0; i < bytes; i++ )
5836 {
5837 TEST_ASSERT( changed[i] != 0 );
5838 }
Gilles Peskine05d69892018-06-19 22:00:52 +02005839
5840exit:
Gilles Peskine1153e7b2019-05-28 15:10:21 +02005841 PSA_DONE( );
Gilles Peskinea50d7392018-06-21 10:22:13 +02005842 mbedtls_free( output );
5843 mbedtls_free( changed );
Gilles Peskine05d69892018-06-19 22:00:52 +02005844}
5845/* END_CASE */
Gilles Peskine12313cd2018-06-20 00:20:32 +02005846
5847/* BEGIN_CASE */
5848void generate_key( int type_arg,
5849 int bits_arg,
5850 int usage_arg,
5851 int alg_arg,
Steven Cooreman83fdb702021-01-21 14:24:39 +01005852 int expected_status_arg,
5853 int is_large_key )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005854{
Ronald Cron5425a212020-08-04 14:58:35 +02005855 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine12313cd2018-06-20 00:20:32 +02005856 psa_key_type_t type = type_arg;
5857 psa_key_usage_t usage = usage_arg;
5858 size_t bits = bits_arg;
5859 psa_algorithm_t alg = alg_arg;
5860 psa_status_t expected_status = expected_status_arg;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005861 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02005862 psa_key_attributes_t got_attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine12313cd2018-06-20 00:20:32 +02005863
Gilles Peskine8817f612018-12-18 00:18:46 +01005864 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005865
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005866 psa_set_key_usage_flags( &attributes, usage );
5867 psa_set_key_algorithm( &attributes, alg );
5868 psa_set_key_type( &attributes, type );
Gilles Peskine3a4f1f82019-04-26 13:49:28 +02005869 psa_set_key_bits( &attributes, bits );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005870
5871 /* Generate a key */
Steven Cooreman83fdb702021-01-21 14:24:39 +01005872 psa_status_t status = psa_generate_key( &attributes, &key );
5873
5874 if( is_large_key > 0 )
5875 TEST_ASSUME( status != PSA_ERROR_INSUFFICIENT_MEMORY );
5876 TEST_EQUAL( status , expected_status );
Gilles Peskinee56e8782019-04-26 17:34:02 +02005877 if( expected_status != PSA_SUCCESS )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005878 goto exit;
Gilles Peskine12313cd2018-06-20 00:20:32 +02005879
5880 /* Test the key information */
Ronald Cron5425a212020-08-04 14:58:35 +02005881 PSA_ASSERT( psa_get_key_attributes( key, &got_attributes ) );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02005882 TEST_EQUAL( psa_get_key_type( &got_attributes ), type );
5883 TEST_EQUAL( psa_get_key_bits( &got_attributes ), bits );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005884
Gilles Peskine818ca122018-06-20 18:16:48 +02005885 /* Do something with the key according to its type and permitted usage. */
Gilles Peskinec18e25f2021-02-12 23:48:20 +01005886 if( ! mbedtls_test_psa_exercise_key( key, usage, alg ) )
Gilles Peskine02b75072018-07-01 22:31:34 +02005887 goto exit;
Gilles Peskine12313cd2018-06-20 00:20:32 +02005888
5889exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +01005890 /*
5891 * Key attributes may have been returned by psa_get_key_attributes()
5892 * thus reset them as required.
5893 */
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02005894 psa_reset_key_attributes( &got_attributes );
Ronald Cron3a4f0e32020-11-19 17:55:23 +01005895
Ronald Cron5425a212020-08-04 14:58:35 +02005896 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02005897 PSA_DONE( );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005898}
5899/* END_CASE */
itayzafrir0adf0fc2018-09-06 16:24:41 +03005900
Ronald Cronee414c72021-03-18 18:50:08 +01005901/* BEGIN_CASE depends_on:PSA_WANT_KEY_TYPE_RSA_KEY_PAIR:PSA_WANT_ALG_RSA_PKCS1V15_CRYPT:PSA_WANT_ALG_RSA_PKCS1V15_SIGN:MBEDTLS_GENPRIME */
Gilles Peskinee56e8782019-04-26 17:34:02 +02005902void generate_key_rsa( int bits_arg,
5903 data_t *e_arg,
5904 int expected_status_arg )
5905{
Ronald Cron5425a212020-08-04 14:58:35 +02005906 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005907 psa_key_type_t type = PSA_KEY_TYPE_RSA_KEY_PAIR;
Gilles Peskinee56e8782019-04-26 17:34:02 +02005908 size_t bits = bits_arg;
5909 psa_key_usage_t usage = PSA_KEY_USAGE_ENCRYPT | PSA_KEY_USAGE_DECRYPT;
5910 psa_algorithm_t alg = PSA_ALG_RSA_PKCS1V15_SIGN_RAW;
5911 psa_status_t expected_status = expected_status_arg;
5912 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
5913 uint8_t *exported = NULL;
5914 size_t exported_size =
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005915 PSA_EXPORT_KEY_OUTPUT_SIZE( PSA_KEY_TYPE_RSA_PUBLIC_KEY, bits );
Gilles Peskinee56e8782019-04-26 17:34:02 +02005916 size_t exported_length = SIZE_MAX;
5917 uint8_t *e_read_buffer = NULL;
5918 int is_default_public_exponent = 0;
Gilles Peskineaa02c172019-04-28 11:44:17 +02005919 size_t e_read_size = PSA_KEY_DOMAIN_PARAMETERS_SIZE( type, bits );
Gilles Peskinee56e8782019-04-26 17:34:02 +02005920 size_t e_read_length = SIZE_MAX;
5921
5922 if( e_arg->len == 0 ||
5923 ( e_arg->len == 3 &&
5924 e_arg->x[0] == 1 && e_arg->x[1] == 0 && e_arg->x[2] == 1 ) )
5925 {
5926 is_default_public_exponent = 1;
5927 e_read_size = 0;
5928 }
5929 ASSERT_ALLOC( e_read_buffer, e_read_size );
5930 ASSERT_ALLOC( exported, exported_size );
5931
5932 PSA_ASSERT( psa_crypto_init( ) );
5933
5934 psa_set_key_usage_flags( &attributes, usage );
5935 psa_set_key_algorithm( &attributes, alg );
5936 PSA_ASSERT( psa_set_key_domain_parameters( &attributes, type,
5937 e_arg->x, e_arg->len ) );
5938 psa_set_key_bits( &attributes, bits );
5939
5940 /* Generate a key */
Ronald Cron5425a212020-08-04 14:58:35 +02005941 TEST_EQUAL( psa_generate_key( &attributes, &key ), expected_status );
Gilles Peskinee56e8782019-04-26 17:34:02 +02005942 if( expected_status != PSA_SUCCESS )
5943 goto exit;
5944
5945 /* Test the key information */
Ronald Cron5425a212020-08-04 14:58:35 +02005946 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
Gilles Peskinee56e8782019-04-26 17:34:02 +02005947 TEST_EQUAL( psa_get_key_type( &attributes ), type );
5948 TEST_EQUAL( psa_get_key_bits( &attributes ), bits );
5949 PSA_ASSERT( psa_get_key_domain_parameters( &attributes,
5950 e_read_buffer, e_read_size,
5951 &e_read_length ) );
5952 if( is_default_public_exponent )
5953 TEST_EQUAL( e_read_length, 0 );
5954 else
5955 ASSERT_COMPARE( e_read_buffer, e_read_length, e_arg->x, e_arg->len );
5956
5957 /* Do something with the key according to its type and permitted usage. */
Gilles Peskinec18e25f2021-02-12 23:48:20 +01005958 if( ! mbedtls_test_psa_exercise_key( key, usage, alg ) )
Gilles Peskinee56e8782019-04-26 17:34:02 +02005959 goto exit;
5960
5961 /* Export the key and check the public exponent. */
Ronald Cron5425a212020-08-04 14:58:35 +02005962 PSA_ASSERT( psa_export_public_key( key,
Gilles Peskinee56e8782019-04-26 17:34:02 +02005963 exported, exported_size,
5964 &exported_length ) );
5965 {
5966 uint8_t *p = exported;
5967 uint8_t *end = exported + exported_length;
5968 size_t len;
5969 /* RSAPublicKey ::= SEQUENCE {
5970 * modulus INTEGER, -- n
5971 * publicExponent INTEGER } -- e
5972 */
5973 TEST_EQUAL( 0, mbedtls_asn1_get_tag( &p, end, &len,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005974 MBEDTLS_ASN1_SEQUENCE |
5975 MBEDTLS_ASN1_CONSTRUCTED ) );
Gilles Peskine8e94efe2021-02-13 00:25:53 +01005976 TEST_ASSERT( mbedtls_test_asn1_skip_integer( &p, end, bits, bits, 1 ) );
Gilles Peskinee56e8782019-04-26 17:34:02 +02005977 TEST_EQUAL( 0, mbedtls_asn1_get_tag( &p, end, &len,
5978 MBEDTLS_ASN1_INTEGER ) );
5979 if( len >= 1 && p[0] == 0 )
5980 {
5981 ++p;
5982 --len;
5983 }
5984 if( e_arg->len == 0 )
5985 {
5986 TEST_EQUAL( len, 3 );
5987 TEST_EQUAL( p[0], 1 );
5988 TEST_EQUAL( p[1], 0 );
5989 TEST_EQUAL( p[2], 1 );
5990 }
5991 else
5992 ASSERT_COMPARE( p, len, e_arg->x, e_arg->len );
5993 }
5994
5995exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +01005996 /*
5997 * Key attributes may have been returned by psa_get_key_attributes() or
5998 * set by psa_set_key_domain_parameters() thus reset them as required.
5999 */
Gilles Peskinee56e8782019-04-26 17:34:02 +02006000 psa_reset_key_attributes( &attributes );
Ronald Cron3a4f0e32020-11-19 17:55:23 +01006001
Ronald Cron5425a212020-08-04 14:58:35 +02006002 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02006003 PSA_DONE( );
Gilles Peskinee56e8782019-04-26 17:34:02 +02006004 mbedtls_free( e_read_buffer );
6005 mbedtls_free( exported );
6006}
6007/* END_CASE */
6008
Darryl Greend49a4992018-06-18 17:27:26 +01006009/* BEGIN_CASE depends_on:MBEDTLS_PSA_CRYPTO_STORAGE_C */
Gilles Peskine5c648ab2019-04-19 14:06:53 +02006010void persistent_key_load_key_from_storage( data_t *data,
6011 int type_arg, int bits_arg,
6012 int usage_flags_arg, int alg_arg,
6013 int generation_method )
Darryl Greend49a4992018-06-18 17:27:26 +01006014{
Ronald Cron71016a92020-08-28 19:01:50 +02006015 mbedtls_svc_key_id_t key_id = mbedtls_svc_key_id_make( 1, 1 );
Gilles Peskine5c648ab2019-04-19 14:06:53 +02006016 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Ronald Cron5425a212020-08-04 14:58:35 +02006017 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
6018 mbedtls_svc_key_id_t base_key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine5c648ab2019-04-19 14:06:53 +02006019 psa_key_type_t type = type_arg;
6020 size_t bits = bits_arg;
6021 psa_key_usage_t usage_flags = usage_flags_arg;
6022 psa_algorithm_t alg = alg_arg;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006023 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Darryl Greend49a4992018-06-18 17:27:26 +01006024 unsigned char *first_export = NULL;
6025 unsigned char *second_export = NULL;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01006026 size_t export_size = PSA_EXPORT_KEY_OUTPUT_SIZE( type, bits );
Darryl Greend49a4992018-06-18 17:27:26 +01006027 size_t first_exported_length;
6028 size_t second_exported_length;
6029
Gilles Peskine5c648ab2019-04-19 14:06:53 +02006030 if( usage_flags & PSA_KEY_USAGE_EXPORT )
6031 {
6032 ASSERT_ALLOC( first_export, export_size );
6033 ASSERT_ALLOC( second_export, export_size );
6034 }
Darryl Greend49a4992018-06-18 17:27:26 +01006035
Gilles Peskine8817f612018-12-18 00:18:46 +01006036 PSA_ASSERT( psa_crypto_init() );
Darryl Greend49a4992018-06-18 17:27:26 +01006037
Gilles Peskinec87af662019-05-15 16:12:22 +02006038 psa_set_key_id( &attributes, key_id );
Gilles Peskine5c648ab2019-04-19 14:06:53 +02006039 psa_set_key_usage_flags( &attributes, usage_flags );
6040 psa_set_key_algorithm( &attributes, alg );
6041 psa_set_key_type( &attributes, type );
Gilles Peskine3a4f1f82019-04-26 13:49:28 +02006042 psa_set_key_bits( &attributes, bits );
Darryl Greend49a4992018-06-18 17:27:26 +01006043
Darryl Green0c6575a2018-11-07 16:05:30 +00006044 switch( generation_method )
6045 {
6046 case IMPORT_KEY:
6047 /* Import the key */
Gilles Peskine049c7532019-05-15 20:22:09 +02006048 PSA_ASSERT( psa_import_key( &attributes, data->x, data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02006049 &key ) );
Darryl Green0c6575a2018-11-07 16:05:30 +00006050 break;
Darryl Greend49a4992018-06-18 17:27:26 +01006051
Darryl Green0c6575a2018-11-07 16:05:30 +00006052 case GENERATE_KEY:
6053 /* Generate a key */
Ronald Cron5425a212020-08-04 14:58:35 +02006054 PSA_ASSERT( psa_generate_key( &attributes, &key ) );
Darryl Green0c6575a2018-11-07 16:05:30 +00006055 break;
6056
6057 case DERIVE_KEY:
Steven Cooreman70f654a2021-02-15 10:51:43 +01006058#if defined(PSA_WANT_ALG_HKDF) && defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine5c648ab2019-04-19 14:06:53 +02006059 {
6060 /* Create base key */
6061 psa_algorithm_t derive_alg = PSA_ALG_HKDF( PSA_ALG_SHA_256 );
6062 psa_key_attributes_t base_attributes = PSA_KEY_ATTRIBUTES_INIT;
6063 psa_set_key_usage_flags( &base_attributes,
6064 PSA_KEY_USAGE_DERIVE );
6065 psa_set_key_algorithm( &base_attributes, derive_alg );
6066 psa_set_key_type( &base_attributes, PSA_KEY_TYPE_DERIVE );
Gilles Peskine049c7532019-05-15 20:22:09 +02006067 PSA_ASSERT( psa_import_key( &base_attributes,
6068 data->x, data->len,
6069 &base_key ) );
Gilles Peskine5c648ab2019-04-19 14:06:53 +02006070 /* Derive a key. */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006071 PSA_ASSERT( psa_key_derivation_setup( &operation, derive_alg ) );
Gilles Peskinecf7292e2019-05-16 17:53:40 +02006072 PSA_ASSERT( psa_key_derivation_input_key(
6073 &operation,
6074 PSA_KEY_DERIVATION_INPUT_SECRET, base_key ) );
Gilles Peskine5c648ab2019-04-19 14:06:53 +02006075 PSA_ASSERT( psa_key_derivation_input_bytes(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006076 &operation, PSA_KEY_DERIVATION_INPUT_INFO,
Gilles Peskine5c648ab2019-04-19 14:06:53 +02006077 NULL, 0 ) );
Gilles Peskinecf7292e2019-05-16 17:53:40 +02006078 PSA_ASSERT( psa_key_derivation_output_key( &attributes,
6079 &operation,
Ronald Cron5425a212020-08-04 14:58:35 +02006080 &key ) );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006081 PSA_ASSERT( psa_key_derivation_abort( &operation ) );
Gilles Peskine5c648ab2019-04-19 14:06:53 +02006082 PSA_ASSERT( psa_destroy_key( base_key ) );
Ronald Cron5425a212020-08-04 14:58:35 +02006083 base_key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine5c648ab2019-04-19 14:06:53 +02006084 }
Gilles Peskine6fea21d2021-01-12 00:02:15 +01006085#else
6086 TEST_ASSUME( ! "KDF not supported in this configuration" );
6087#endif
6088 break;
6089
6090 default:
6091 TEST_ASSERT( ! "generation_method not implemented in test" );
6092 break;
Darryl Green0c6575a2018-11-07 16:05:30 +00006093 }
Gilles Peskine5c648ab2019-04-19 14:06:53 +02006094 psa_reset_key_attributes( &attributes );
Darryl Greend49a4992018-06-18 17:27:26 +01006095
Gilles Peskine5c648ab2019-04-19 14:06:53 +02006096 /* Export the key if permitted by the key policy. */
6097 if( usage_flags & PSA_KEY_USAGE_EXPORT )
6098 {
Ronald Cron5425a212020-08-04 14:58:35 +02006099 PSA_ASSERT( psa_export_key( key,
Gilles Peskine5c648ab2019-04-19 14:06:53 +02006100 first_export, export_size,
6101 &first_exported_length ) );
6102 if( generation_method == IMPORT_KEY )
6103 ASSERT_COMPARE( data->x, data->len,
6104 first_export, first_exported_length );
6105 }
Darryl Greend49a4992018-06-18 17:27:26 +01006106
6107 /* Shutdown and restart */
Ronald Cron5425a212020-08-04 14:58:35 +02006108 PSA_ASSERT( psa_purge_key( key ) );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02006109 PSA_DONE();
Gilles Peskine8817f612018-12-18 00:18:46 +01006110 PSA_ASSERT( psa_crypto_init() );
Darryl Greend49a4992018-06-18 17:27:26 +01006111
Darryl Greend49a4992018-06-18 17:27:26 +01006112 /* Check key slot still contains key data */
Ronald Cron5425a212020-08-04 14:58:35 +02006113 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
Ronald Cronecfb2372020-07-23 17:13:42 +02006114 TEST_ASSERT( mbedtls_svc_key_id_equal(
6115 psa_get_key_id( &attributes ), key_id ) );
Gilles Peskine5c648ab2019-04-19 14:06:53 +02006116 TEST_EQUAL( psa_get_key_lifetime( &attributes ),
6117 PSA_KEY_LIFETIME_PERSISTENT );
6118 TEST_EQUAL( psa_get_key_type( &attributes ), type );
6119 TEST_EQUAL( psa_get_key_bits( &attributes ), bits );
6120 TEST_EQUAL( psa_get_key_usage_flags( &attributes ), usage_flags );
6121 TEST_EQUAL( psa_get_key_algorithm( &attributes ), alg );
Darryl Greend49a4992018-06-18 17:27:26 +01006122
Gilles Peskine5c648ab2019-04-19 14:06:53 +02006123 /* Export the key again if permitted by the key policy. */
6124 if( usage_flags & PSA_KEY_USAGE_EXPORT )
Darryl Green0c6575a2018-11-07 16:05:30 +00006125 {
Ronald Cron5425a212020-08-04 14:58:35 +02006126 PSA_ASSERT( psa_export_key( key,
Gilles Peskine5c648ab2019-04-19 14:06:53 +02006127 second_export, export_size,
6128 &second_exported_length ) );
Darryl Green0c6575a2018-11-07 16:05:30 +00006129 ASSERT_COMPARE( first_export, first_exported_length,
6130 second_export, second_exported_length );
Darryl Green0c6575a2018-11-07 16:05:30 +00006131 }
6132
6133 /* Do something with the key according to its type and permitted usage. */
Gilles Peskinec18e25f2021-02-12 23:48:20 +01006134 if( ! mbedtls_test_psa_exercise_key( key, usage_flags, alg ) )
Darryl Green0c6575a2018-11-07 16:05:30 +00006135 goto exit;
Darryl Greend49a4992018-06-18 17:27:26 +01006136
6137exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +01006138 /*
6139 * Key attributes may have been returned by psa_get_key_attributes()
6140 * thus reset them as required.
6141 */
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02006142 psa_reset_key_attributes( &attributes );
Ronald Cron3a4f0e32020-11-19 17:55:23 +01006143
Darryl Greend49a4992018-06-18 17:27:26 +01006144 mbedtls_free( first_export );
6145 mbedtls_free( second_export );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006146 psa_key_derivation_abort( &operation );
Gilles Peskine5c648ab2019-04-19 14:06:53 +02006147 psa_destroy_key( base_key );
Ronald Cron5425a212020-08-04 14:58:35 +02006148 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02006149 PSA_DONE();
Darryl Greend49a4992018-06-18 17:27:26 +01006150}
6151/* END_CASE */