blob: e01c49588eb60137ecab1a63f658d23f2ea71c9b [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,
Paul Elliottf1277632021-08-24 18:11:37 +01003674 int nonce_length,
3675 int expected_nonce_length_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;
Paul Elliott693bf312021-07-23 17:40:41 +01003688 psa_status_t expected_status = expected_status_arg;
Paul Elliottf1277632021-08-24 18:11:37 +01003689 size_t actual_nonce_length = 0;
3690 size_t expected_nonce_length = expected_nonce_length_arg;
3691 unsigned char *output = NULL;
3692 unsigned char *ciphertext = NULL;
Paul Elliott3bd5dba2021-06-23 17:14:40 +01003693 size_t output_size = 0;
Paul Elliottf1277632021-08-24 18:11:37 +01003694 size_t ciphertext_size = 0;
3695 size_t ciphertext_length = 0;
Paul Elliott3bd5dba2021-06-23 17:14:40 +01003696 size_t tag_length = 0;
3697 uint8_t tag_buffer[PSA_AEAD_TAG_MAX_SIZE];
Paul Elliott8eb9daf2021-06-04 16:42:21 +01003698
3699 PSA_ASSERT( psa_crypto_init( ) );
3700
3701 psa_set_key_usage_flags( & attributes, PSA_KEY_USAGE_ENCRYPT );
3702 psa_set_key_algorithm( & attributes, alg );
3703 psa_set_key_type( & attributes, key_type );
3704
3705 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
3706 &key ) );
3707
3708 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
3709
Paul Elliott3bd5dba2021-06-23 17:14:40 +01003710 output_size = PSA_AEAD_UPDATE_OUTPUT_SIZE( key_type, alg, input_data->len );
3711
Paul Elliottf1277632021-08-24 18:11:37 +01003712 ASSERT_ALLOC( output, output_size );
Paul Elliott3bd5dba2021-06-23 17:14:40 +01003713
Paul Elliottf1277632021-08-24 18:11:37 +01003714 ciphertext_size = PSA_AEAD_FINISH_OUTPUT_SIZE( key_type, alg );
Paul Elliott3bd5dba2021-06-23 17:14:40 +01003715
Paul Elliottf1277632021-08-24 18:11:37 +01003716 TEST_ASSERT( ciphertext_size <= PSA_AEAD_FINISH_OUTPUT_MAX_SIZE );
Paul Elliott3bd5dba2021-06-23 17:14:40 +01003717
Paul Elliottf1277632021-08-24 18:11:37 +01003718 ASSERT_ALLOC( ciphertext, ciphertext_size );
Paul Elliott3bd5dba2021-06-23 17:14:40 +01003719
Paul Elliott8eb9daf2021-06-04 16:42:21 +01003720 operation = psa_aead_operation_init( );
3721
3722 status = psa_aead_encrypt_setup( &operation, key, alg );
3723
3724 /* If the operation is not supported, just skip and not fail in case the
3725 * encryption involves a common limitation of cryptography hardwares and
3726 * an alternative implementation. */
3727 if( status == PSA_ERROR_NOT_SUPPORTED )
3728 {
3729 MBEDTLS_TEST_PSA_SKIP_IF_ALT_AES_192( key_type, key_data->len * 8 );
Paul Elliottf1277632021-08-24 18:11:37 +01003730 MBEDTLS_TEST_PSA_SKIP_IF_ALT_GCM_NOT_12BYTES_NONCE( alg, nonce_length );
Paul Elliott8eb9daf2021-06-04 16:42:21 +01003731 }
3732
3733 PSA_ASSERT( status );
3734
Paul Elliott8eb9daf2021-06-04 16:42:21 +01003735 status = psa_aead_generate_nonce( &operation, nonce_buffer,
Paul Elliottf1277632021-08-24 18:11:37 +01003736 nonce_length,
3737 &actual_nonce_length );
Paul Elliott8eb9daf2021-06-04 16:42:21 +01003738
Paul Elliott693bf312021-07-23 17:40:41 +01003739 TEST_EQUAL( status, expected_status );
Paul Elliott3bd5dba2021-06-23 17:14:40 +01003740
Paul Elliottf1277632021-08-24 18:11:37 +01003741 TEST_EQUAL( actual_nonce_length, expected_nonce_length );
Paul Elliottd85f5472021-07-16 18:20:16 +01003742
Paul Elliottf1277632021-08-24 18:11:37 +01003743 TEST_ASSERT( actual_nonce_length < PSA_AEAD_NONCE_MAX_SIZE );
Paul Elliotte0fcb3b2021-07-16 18:52:03 +01003744
Paul Elliott693bf312021-07-23 17:40:41 +01003745 if( expected_status == PSA_SUCCESS )
Paul Elliott3bd5dba2021-06-23 17:14:40 +01003746 {
3747
3748 /* Ensure we can still complete operation. */
3749
3750 PSA_ASSERT( psa_aead_update_ad( &operation, additional_data->x,
3751 additional_data->len ) );
3752
3753 PSA_ASSERT( psa_aead_update( &operation, input_data->x, input_data->len,
Paul Elliottf1277632021-08-24 18:11:37 +01003754 output, output_size,
3755 &ciphertext_length ) );
Paul Elliott3bd5dba2021-06-23 17:14:40 +01003756
Paul Elliottf1277632021-08-24 18:11:37 +01003757 PSA_ASSERT( psa_aead_finish( &operation, ciphertext, ciphertext_size,
3758 &ciphertext_length, tag_buffer,
Paul Elliott3bd5dba2021-06-23 17:14:40 +01003759 PSA_AEAD_TAG_MAX_SIZE, &tag_length ) );
3760 }
Paul Elliott8eb9daf2021-06-04 16:42:21 +01003761
3762exit:
3763 psa_destroy_key( key );
Paul Elliottf1277632021-08-24 18:11:37 +01003764 mbedtls_free( output );
3765 mbedtls_free( ciphertext );
Paul Elliott8eb9daf2021-06-04 16:42:21 +01003766 psa_aead_abort( &operation );
3767 PSA_DONE( );
3768}
3769/* END_CASE */
3770
3771/* BEGIN_CASE */
Paul Elliott863864a2021-07-23 17:28:31 +01003772void aead_multipart_set_nonce( int key_type_arg, data_t *key_data,
3773 int alg_arg,
Paul Elliott6f0e7202021-08-25 12:57:18 +01003774 int nonce_length,
Paul Elliott863864a2021-07-23 17:28:31 +01003775 data_t *additional_data,
3776 data_t *input_data,
3777 int expected_status_arg )
3778{
3779
3780 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
3781 psa_key_type_t key_type = key_type_arg;
3782 psa_algorithm_t alg = alg_arg;
3783 psa_aead_operation_t operation;
3784 uint8_t *nonce_buffer = NULL;
3785 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
3786 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
3787 psa_status_t expected_status = expected_status_arg;
Paul Elliott6f0e7202021-08-25 12:57:18 +01003788 unsigned char *output = NULL;
3789 unsigned char *ciphertext = NULL;
Paul Elliott863864a2021-07-23 17:28:31 +01003790 size_t output_size = 0;
Paul Elliott6f0e7202021-08-25 12:57:18 +01003791 size_t ciphertext_size = 0;
3792 size_t ciphertext_length = 0;
Paul Elliott863864a2021-07-23 17:28:31 +01003793 size_t tag_length = 0;
3794 uint8_t tag_buffer[PSA_AEAD_TAG_MAX_SIZE];
3795 int index = 0;
3796
3797 PSA_ASSERT( psa_crypto_init( ) );
3798
3799 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
3800 psa_set_key_algorithm( &attributes, alg );
3801 psa_set_key_type( &attributes, key_type );
3802
3803 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
3804 &key ) );
3805
3806 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
3807
3808 output_size = PSA_AEAD_UPDATE_OUTPUT_SIZE( key_type, alg, input_data->len );
3809
Paul Elliott6f0e7202021-08-25 12:57:18 +01003810 ASSERT_ALLOC( output, output_size );
Paul Elliott863864a2021-07-23 17:28:31 +01003811
Paul Elliott6f0e7202021-08-25 12:57:18 +01003812 ciphertext_size = PSA_AEAD_FINISH_OUTPUT_SIZE( key_type, alg );
Paul Elliott863864a2021-07-23 17:28:31 +01003813
Paul Elliott6f0e7202021-08-25 12:57:18 +01003814 TEST_ASSERT( ciphertext_size <= PSA_AEAD_FINISH_OUTPUT_MAX_SIZE );
Paul Elliott863864a2021-07-23 17:28:31 +01003815
Paul Elliott6f0e7202021-08-25 12:57:18 +01003816 ASSERT_ALLOC( ciphertext, ciphertext_size );
Paul Elliott863864a2021-07-23 17:28:31 +01003817
3818 operation = psa_aead_operation_init( );
3819
3820 status = psa_aead_encrypt_setup( &operation, key, alg );
3821
3822 /* If the operation is not supported, just skip and not fail in case the
3823 * encryption involves a common limitation of cryptography hardwares and
3824 * an alternative implementation. */
3825 if( status == PSA_ERROR_NOT_SUPPORTED )
3826 {
3827 MBEDTLS_TEST_PSA_SKIP_IF_ALT_AES_192( key_type, key_data->len * 8 );
Paul Elliott6f0e7202021-08-25 12:57:18 +01003828 MBEDTLS_TEST_PSA_SKIP_IF_ALT_GCM_NOT_12BYTES_NONCE( alg, nonce_length );
Paul Elliott863864a2021-07-23 17:28:31 +01003829 }
3830
3831 PSA_ASSERT( status );
3832
Paul Elliott6f0e7202021-08-25 12:57:18 +01003833 if( nonce_length == 0 )
Paul Elliott863864a2021-07-23 17:28:31 +01003834 {
Paul Elliott5e69aa52021-08-25 17:24:37 +01003835 /* Arbitrary size buffer, to test zero length valid buffer. */
3836 ASSERT_ALLOC( nonce_buffer, 4 );
Paul Elliott66696b52021-08-16 18:42:41 +01003837 }
3838 else
3839 {
Paul Elliott6f0e7202021-08-25 12:57:18 +01003840 ASSERT_ALLOC( nonce_buffer, nonce_length );
Paul Elliott66696b52021-08-16 18:42:41 +01003841
Paul Elliott6f0e7202021-08-25 12:57:18 +01003842 for( index = 0; index < nonce_length - 1; ++index)
Paul Elliott66696b52021-08-16 18:42:41 +01003843 {
3844 nonce_buffer[index] = 'a' + index;
3845 }
Paul Elliott863864a2021-07-23 17:28:31 +01003846 }
3847
Paul Elliott6f0e7202021-08-25 12:57:18 +01003848 status = psa_aead_set_nonce( &operation, nonce_buffer, nonce_length );
Paul Elliott863864a2021-07-23 17:28:31 +01003849
Paul Elliott693bf312021-07-23 17:40:41 +01003850 TEST_EQUAL( status, expected_status );
Paul Elliott863864a2021-07-23 17:28:31 +01003851
3852 if( expected_status == PSA_SUCCESS )
3853 {
3854 /* Ensure we can still complete operation. */
3855
3856 PSA_ASSERT( psa_aead_update_ad( &operation, additional_data->x,
3857 additional_data->len ) );
3858
3859 PSA_ASSERT( psa_aead_update( &operation, input_data->x, input_data->len,
Paul Elliott6f0e7202021-08-25 12:57:18 +01003860 output, output_size,
3861 &ciphertext_length ) );
Paul Elliott863864a2021-07-23 17:28:31 +01003862
Paul Elliott6f0e7202021-08-25 12:57:18 +01003863 PSA_ASSERT( psa_aead_finish( &operation, ciphertext, ciphertext_size,
3864 &ciphertext_length, tag_buffer,
Paul Elliott863864a2021-07-23 17:28:31 +01003865 PSA_AEAD_TAG_MAX_SIZE, &tag_length ) );
3866 }
3867
3868exit:
3869 psa_destroy_key( key );
Paul Elliott6f0e7202021-08-25 12:57:18 +01003870 mbedtls_free( output );
3871 mbedtls_free( ciphertext );
Paul Elliott863864a2021-07-23 17:28:31 +01003872 mbedtls_free( nonce_buffer );
3873 psa_aead_abort( &operation );
3874 PSA_DONE( );
3875}
3876/* END_CASE */
3877
3878/* BEGIN_CASE */
Paul Elliott43fbda62021-07-23 18:30:59 +01003879void aead_multipart_update_buffer_test( int key_type_arg, data_t *key_data,
3880 int alg_arg,
Paul Elliottc6d11d02021-09-01 12:04:23 +01003881 int output_size_arg,
Paul Elliott43fbda62021-07-23 18:30:59 +01003882 data_t *nonce,
3883 data_t *additional_data,
3884 data_t *input_data,
3885 int expected_status_arg )
3886{
3887
3888 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
3889 psa_key_type_t key_type = key_type_arg;
3890 psa_algorithm_t alg = alg_arg;
3891 psa_aead_operation_t operation;
3892 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
3893 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
3894 psa_status_t expected_status = expected_status_arg;
Paul Elliottc6d11d02021-09-01 12:04:23 +01003895 unsigned char *output = NULL;
3896 unsigned char *ciphertext = NULL;
3897 size_t output_size = output_size_arg;
3898 size_t ciphertext_size = 0;
3899 size_t ciphertext_length = 0;
Paul Elliott43fbda62021-07-23 18:30:59 +01003900 size_t tag_length = 0;
3901 uint8_t tag_buffer[PSA_AEAD_TAG_MAX_SIZE];
3902
3903 PSA_ASSERT( psa_crypto_init( ) );
3904
3905 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
3906 psa_set_key_algorithm( &attributes, alg );
3907 psa_set_key_type( &attributes, key_type );
3908
3909 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
3910 &key ) );
3911
3912 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
3913
Paul Elliottc6d11d02021-09-01 12:04:23 +01003914 ASSERT_ALLOC( output, output_size );
Paul Elliott43fbda62021-07-23 18:30:59 +01003915
Paul Elliottc6d11d02021-09-01 12:04:23 +01003916 ciphertext_size = PSA_AEAD_FINISH_OUTPUT_SIZE( key_type, alg );
Paul Elliott43fbda62021-07-23 18:30:59 +01003917
Paul Elliottc6d11d02021-09-01 12:04:23 +01003918 ASSERT_ALLOC( ciphertext, ciphertext_size );
Paul Elliott43fbda62021-07-23 18:30:59 +01003919
3920 operation = psa_aead_operation_init( );
3921
3922 status = psa_aead_encrypt_setup( &operation, key, alg );
3923
3924 /* If the operation is not supported, just skip and not fail in case the
3925 * encryption involves a common limitation of cryptography hardwares and
3926 * an alternative implementation. */
3927 if( status == PSA_ERROR_NOT_SUPPORTED )
3928 {
3929 MBEDTLS_TEST_PSA_SKIP_IF_ALT_AES_192( key_type, key_data->len * 8 );
3930 MBEDTLS_TEST_PSA_SKIP_IF_ALT_GCM_NOT_12BYTES_NONCE( alg, nonce->len );
3931 }
3932
3933 PSA_ASSERT( status );
3934
3935 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
3936
3937 PSA_ASSERT( psa_aead_update_ad( &operation, additional_data->x,
3938 additional_data->len ) );
3939
3940 status = psa_aead_update( &operation, input_data->x, input_data->len,
Paul Elliottc6d11d02021-09-01 12:04:23 +01003941 output, output_size, &ciphertext_length );
Paul Elliott43fbda62021-07-23 18:30:59 +01003942
3943 TEST_EQUAL( status, expected_status );
3944
3945 if( expected_status == PSA_SUCCESS )
3946 {
3947 /* Ensure we can still complete operation. */
Paul Elliottc6d11d02021-09-01 12:04:23 +01003948 PSA_ASSERT( psa_aead_finish( &operation, ciphertext, ciphertext_size,
3949 &ciphertext_length, tag_buffer,
Paul Elliott43fbda62021-07-23 18:30:59 +01003950 PSA_AEAD_TAG_MAX_SIZE, &tag_length ) );
3951 }
3952
3953exit:
3954 psa_destroy_key( key );
Paul Elliottc6d11d02021-09-01 12:04:23 +01003955 mbedtls_free( output );
3956 mbedtls_free( ciphertext );
Paul Elliott43fbda62021-07-23 18:30:59 +01003957 psa_aead_abort( &operation );
3958 PSA_DONE( );
3959}
3960/* END_CASE */
3961
Paul Elliott91b021e2021-07-23 18:52:31 +01003962/* BEGIN_CASE */
3963void aead_multipart_finish_buffer_test( int key_type_arg, data_t *key_data,
3964 int alg_arg,
3965 int buffer_size,
3966 data_t *nonce,
3967 data_t *additional_data,
3968 data_t *input_data,
3969 int expected_status_arg )
3970{
3971
3972 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
3973 psa_key_type_t key_type = key_type_arg;
3974 psa_algorithm_t alg = alg_arg;
3975 psa_aead_operation_t operation;
3976 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
3977 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
3978 psa_status_t expected_status = expected_status_arg;
3979 unsigned char *output_data = NULL;
3980 unsigned char *final_data = NULL;
3981 size_t output_size = 0;
3982 size_t output_length = 0;
3983 size_t tag_length = 0;
3984 uint8_t tag_buffer[PSA_AEAD_TAG_MAX_SIZE];
3985
3986 PSA_ASSERT( psa_crypto_init( ) );
3987
3988 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
3989 psa_set_key_algorithm( &attributes, alg );
3990 psa_set_key_type( &attributes, key_type );
3991
3992 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
3993 &key ) );
3994
3995 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
3996
3997 output_size = PSA_AEAD_UPDATE_OUTPUT_SIZE( key_type, alg, input_data->len );
3998
3999 ASSERT_ALLOC( output_data, output_size );
4000
4001 TEST_ASSERT( buffer_size <= PSA_AEAD_FINISH_OUTPUT_MAX_SIZE );
4002
4003 ASSERT_ALLOC( final_data, buffer_size );
4004
4005 operation = psa_aead_operation_init( );
4006
4007 status = psa_aead_encrypt_setup( &operation, key, alg );
4008
4009 /* If the operation is not supported, just skip and not fail in case the
4010 * encryption involves a common limitation of cryptography hardwares and
4011 * an alternative implementation. */
4012 if( status == PSA_ERROR_NOT_SUPPORTED )
4013 {
4014 MBEDTLS_TEST_PSA_SKIP_IF_ALT_AES_192( key_type, key_data->len * 8 );
4015 MBEDTLS_TEST_PSA_SKIP_IF_ALT_GCM_NOT_12BYTES_NONCE( alg, nonce->len );
4016 }
4017
4018 PSA_ASSERT( status );
4019
4020 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
4021
4022 PSA_ASSERT( psa_aead_update_ad( &operation, additional_data->x,
4023 additional_data->len ) );
4024
4025 PSA_ASSERT( psa_aead_update( &operation, input_data->x, input_data->len,
4026 output_data, output_size, &output_length ) );
4027
4028 /* Ensure we can still complete operation. */
4029 status = psa_aead_finish( &operation, final_data, buffer_size,
4030 &output_length, tag_buffer,
4031 PSA_AEAD_TAG_MAX_SIZE, &tag_length );
4032
4033 TEST_EQUAL( status, expected_status );
4034
4035exit:
4036 psa_destroy_key( key );
4037 mbedtls_free( output_data );
4038 mbedtls_free( final_data );
4039 psa_aead_abort( &operation );
4040 PSA_DONE( );
4041}
4042/* END_CASE */
Paul Elliott43fbda62021-07-23 18:30:59 +01004043
4044/* BEGIN_CASE */
Paul Elliottc23a9a02021-06-21 18:32:46 +01004045void aead_multipart_state_test( int key_type_arg, data_t *key_data,
4046 int alg_arg,
4047 data_t *nonce,
4048 data_t *additional_data,
4049 data_t *input_data )
4050{
4051 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
4052 psa_key_type_t key_type = key_type_arg;
4053 psa_algorithm_t alg = alg_arg;
4054 psa_aead_operation_t operation;
4055 unsigned char *output_data = NULL;
4056 unsigned char *final_data = NULL;
4057 size_t output_size = 0;
4058 size_t finish_output_size = 0;
4059 size_t output_length = 0;
4060 size_t key_bits = 0;
4061 size_t tag_length = 0;
4062 size_t tag_size = 0;
4063 size_t nonce_length = 0;
4064 uint8_t nonce_buffer[PSA_AEAD_NONCE_MAX_SIZE];
4065 uint8_t tag_buffer[PSA_AEAD_TAG_MAX_SIZE];
4066 size_t output_part_length = 0;
4067 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
4068
4069 PSA_ASSERT( psa_crypto_init( ) );
4070
4071 psa_set_key_usage_flags( & attributes,
4072 PSA_KEY_USAGE_ENCRYPT | PSA_KEY_USAGE_DECRYPT );
4073 psa_set_key_algorithm( & attributes, alg );
4074 psa_set_key_type( & attributes, key_type );
4075
4076 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
4077 &key ) );
4078
4079 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
4080 key_bits = psa_get_key_bits( &attributes );
4081
4082 tag_length = PSA_AEAD_TAG_LENGTH( key_type, key_bits, alg );
4083
4084 TEST_ASSERT( tag_length <= PSA_AEAD_TAG_MAX_SIZE );
4085
4086 output_size = PSA_AEAD_UPDATE_OUTPUT_SIZE( key_type, alg, input_data->len );
4087
4088 ASSERT_ALLOC( output_data, output_size );
4089
4090 finish_output_size = PSA_AEAD_FINISH_OUTPUT_SIZE( key_type, alg );
4091
4092 TEST_ASSERT( finish_output_size <= PSA_AEAD_FINISH_OUTPUT_MAX_SIZE );
4093
4094 ASSERT_ALLOC( final_data, finish_output_size );
4095
4096 /* Test all operations error without calling setup first. */
4097
4098 operation = psa_aead_operation_init( );
4099
4100 TEST_EQUAL( psa_aead_set_nonce( &operation, nonce->x, nonce->len ),
4101 PSA_ERROR_BAD_STATE );
4102
4103 psa_aead_abort( &operation );
4104
4105 operation = psa_aead_operation_init( );
4106
4107 TEST_EQUAL( psa_aead_generate_nonce( &operation, nonce_buffer,
4108 PSA_AEAD_NONCE_MAX_SIZE,
4109 &nonce_length ),
4110 PSA_ERROR_BAD_STATE );
4111
4112 psa_aead_abort( &operation );
4113
Paul Elliott481be342021-07-16 17:38:47 +01004114 /* ------------------------------------------------------- */
4115
Paul Elliottc23a9a02021-06-21 18:32:46 +01004116 operation = psa_aead_operation_init( );
4117
4118 TEST_EQUAL( psa_aead_set_lengths( &operation, additional_data->len,
4119 input_data->len ),
4120 PSA_ERROR_BAD_STATE );
4121
4122 psa_aead_abort( &operation );
4123
Paul Elliott481be342021-07-16 17:38:47 +01004124 /* ------------------------------------------------------- */
4125
Paul Elliottc23a9a02021-06-21 18:32:46 +01004126 operation = psa_aead_operation_init( );
4127
4128 TEST_EQUAL( psa_aead_update_ad( &operation, additional_data->x,
4129 additional_data->len ),
4130 PSA_ERROR_BAD_STATE );
4131
4132 psa_aead_abort( &operation );
4133
Paul Elliott481be342021-07-16 17:38:47 +01004134 /* ------------------------------------------------------- */
4135
Paul Elliottc23a9a02021-06-21 18:32:46 +01004136 operation = psa_aead_operation_init( );
4137
4138 TEST_EQUAL( psa_aead_update( &operation, input_data->x,
4139 input_data->len, output_data,
4140 output_size, &output_length ),
4141 PSA_ERROR_BAD_STATE );
4142
4143 psa_aead_abort( &operation );
4144
Paul Elliott481be342021-07-16 17:38:47 +01004145 /* ------------------------------------------------------- */
4146
Paul Elliottc23a9a02021-06-21 18:32:46 +01004147 operation = psa_aead_operation_init( );
4148
4149 TEST_EQUAL( psa_aead_finish( &operation, final_data,
4150 finish_output_size,
4151 &output_part_length,
4152 tag_buffer, tag_length,
4153 &tag_size ),
4154 PSA_ERROR_BAD_STATE );
4155
4156 psa_aead_abort( &operation );
4157
Paul Elliott481be342021-07-16 17:38:47 +01004158 /* ------------------------------------------------------- */
4159
Paul Elliottc23a9a02021-06-21 18:32:46 +01004160 operation = psa_aead_operation_init( );
4161
4162 TEST_EQUAL( psa_aead_verify( &operation, final_data,
4163 finish_output_size,
4164 &output_part_length,
4165 tag_buffer,
4166 tag_length ),
4167 PSA_ERROR_BAD_STATE );
4168
4169 psa_aead_abort( &operation );
4170
4171 /* Test for double setups. */
4172
4173 operation = psa_aead_operation_init( );
4174
4175 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
4176
4177 TEST_EQUAL( psa_aead_encrypt_setup( &operation, key, alg ),
4178 PSA_ERROR_BAD_STATE );
4179
4180 psa_aead_abort( &operation );
4181
Paul Elliott481be342021-07-16 17:38:47 +01004182 /* ------------------------------------------------------- */
4183
Paul Elliottc23a9a02021-06-21 18:32:46 +01004184 operation = psa_aead_operation_init( );
4185
4186 PSA_ASSERT( psa_aead_decrypt_setup( &operation, key, alg ) );
4187
4188 TEST_EQUAL( psa_aead_decrypt_setup( &operation, key, alg ),
4189 PSA_ERROR_BAD_STATE );
4190
4191 psa_aead_abort( &operation );
4192
Paul Elliott374a2be2021-07-16 17:53:40 +01004193 /* ------------------------------------------------------- */
4194
4195 operation = psa_aead_operation_init( );
4196
4197 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
4198
4199 TEST_EQUAL( psa_aead_decrypt_setup( &operation, key, alg ),
4200 PSA_ERROR_BAD_STATE );
4201
4202 psa_aead_abort( &operation );
4203
4204 /* ------------------------------------------------------- */
4205
4206 operation = psa_aead_operation_init( );
4207
4208 PSA_ASSERT( psa_aead_decrypt_setup( &operation, key, alg ) );
4209
4210 TEST_EQUAL( psa_aead_encrypt_setup( &operation, key, alg ),
4211 PSA_ERROR_BAD_STATE );
4212
4213 psa_aead_abort( &operation );
4214
Paul Elliottc23a9a02021-06-21 18:32:46 +01004215 /* Test for not setting a nonce. */
4216
4217 operation = psa_aead_operation_init( );
4218
4219 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
4220
4221 TEST_EQUAL( psa_aead_update_ad( &operation, additional_data->x,
4222 additional_data->len ),
4223 PSA_ERROR_BAD_STATE );
4224
4225 psa_aead_abort( &operation );
4226
4227 /* Test for double setting nonce. */
4228
4229 operation = psa_aead_operation_init( );
4230
4231 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
4232
4233 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
4234
4235 TEST_EQUAL( psa_aead_set_nonce( &operation, nonce->x, nonce->len ),
4236 PSA_ERROR_BAD_STATE );
4237
4238 psa_aead_abort( &operation );
4239
Paul Elliott374a2be2021-07-16 17:53:40 +01004240 /* Test for double generating nonce. */
4241
4242 operation = psa_aead_operation_init( );
4243
4244 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
4245
4246 PSA_ASSERT( psa_aead_generate_nonce( &operation, nonce_buffer,
4247 PSA_AEAD_NONCE_MAX_SIZE,
4248 &nonce_length ) );
4249
4250 TEST_EQUAL( psa_aead_generate_nonce( &operation, nonce_buffer,
4251 PSA_AEAD_NONCE_MAX_SIZE,
4252 &nonce_length ),
4253 PSA_ERROR_BAD_STATE );
4254
4255
4256 psa_aead_abort( &operation );
4257
4258 /* Test for generate nonce then set and vice versa */
4259
4260 operation = psa_aead_operation_init( );
4261
4262 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
4263
4264 PSA_ASSERT( psa_aead_generate_nonce( &operation, nonce_buffer,
4265 PSA_AEAD_NONCE_MAX_SIZE,
4266 &nonce_length ) );
4267
4268 TEST_EQUAL( psa_aead_set_nonce( &operation, nonce->x, nonce->len ),
4269 PSA_ERROR_BAD_STATE );
4270
4271 psa_aead_abort( &operation );
4272
4273 /* ------------------------------------------------------- */
4274
4275 operation = psa_aead_operation_init( );
4276
4277 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
4278
4279 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
4280
4281 TEST_EQUAL( psa_aead_generate_nonce( &operation, nonce_buffer,
4282 PSA_AEAD_NONCE_MAX_SIZE,
4283 &nonce_length ),
4284 PSA_ERROR_BAD_STATE );
4285
4286 psa_aead_abort( &operation );
4287
Paul Elliott7220cae2021-06-22 17:25:57 +01004288 /* Test for generating nonce in decrypt setup. */
4289
4290 operation = psa_aead_operation_init( );
4291
4292 PSA_ASSERT( psa_aead_decrypt_setup( &operation, key, alg ) );
4293
4294 TEST_EQUAL( psa_aead_generate_nonce( &operation, nonce_buffer,
4295 PSA_AEAD_NONCE_MAX_SIZE,
4296 &nonce_length ),
4297 PSA_ERROR_BAD_STATE );
4298
4299 psa_aead_abort( &operation );
4300
Paul Elliottc23a9a02021-06-21 18:32:46 +01004301 /* Test for setting lengths twice. */
4302
4303 operation = psa_aead_operation_init( );
4304
4305 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
4306
4307 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
4308
4309 PSA_ASSERT( psa_aead_set_lengths( &operation, additional_data->len,
4310 input_data->len ) );
4311
4312 TEST_EQUAL( psa_aead_set_lengths( &operation, additional_data->len,
4313 input_data->len ),
4314 PSA_ERROR_BAD_STATE );
4315
4316 psa_aead_abort( &operation );
4317
4318 /* Test for setting lengths after already starting data. */
4319
4320 operation = psa_aead_operation_init( );
4321
4322 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
4323
4324 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
4325
4326 PSA_ASSERT( psa_aead_update( &operation, input_data->x,
4327 input_data->len, output_data,
4328 output_size, &output_length ) );
4329
4330 TEST_EQUAL( psa_aead_set_lengths( &operation, additional_data->len,
4331 input_data->len ),
4332 PSA_ERROR_BAD_STATE );
4333
4334 psa_aead_abort( &operation );
4335
Paul Elliott243080c2021-07-21 19:01:17 +01004336 /* Test for not sending any additional data or data after setting non zero
4337 * lengths for them. (encrypt) */
Paul Elliottc23a9a02021-06-21 18:32:46 +01004338
4339 operation = psa_aead_operation_init( );
4340
4341 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
4342
4343 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
4344
4345 PSA_ASSERT( psa_aead_set_lengths( &operation, additional_data->len,
4346 input_data->len ) );
4347
4348 TEST_EQUAL( psa_aead_finish( &operation, final_data,
4349 finish_output_size,
4350 &output_part_length,
4351 tag_buffer, tag_length,
4352 &tag_size ),
4353 PSA_ERROR_INVALID_ARGUMENT );
4354
4355 psa_aead_abort( &operation );
4356
Paul Elliott243080c2021-07-21 19:01:17 +01004357 /* Test for not sending any additional data or data after setting non-zero
4358 * lengths for them. (decrypt) */
Paul Elliottc23a9a02021-06-21 18:32:46 +01004359
4360 operation = psa_aead_operation_init( );
4361
4362 PSA_ASSERT( psa_aead_decrypt_setup( &operation, key, alg ) );
4363
4364 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
4365
4366 PSA_ASSERT( psa_aead_set_lengths( &operation, additional_data->len,
4367 input_data->len ) );
4368
4369 TEST_EQUAL( psa_aead_verify( &operation, final_data,
4370 finish_output_size,
4371 &output_part_length,
4372 tag_buffer,
4373 tag_length ),
4374 PSA_ERROR_INVALID_ARGUMENT );
4375
4376 psa_aead_abort( &operation );
4377
Paul Elliott243080c2021-07-21 19:01:17 +01004378 /* Test for not sending any additional data after setting a non-zero length
4379 * for it. */
Paul Elliottc23a9a02021-06-21 18:32:46 +01004380
4381 operation = psa_aead_operation_init( );
4382
4383 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
4384
4385 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
4386
4387 PSA_ASSERT( psa_aead_set_lengths( &operation, additional_data->len,
4388 input_data->len ) );
4389
4390 TEST_EQUAL( psa_aead_update( &operation, input_data->x,
4391 input_data->len, output_data,
4392 output_size, &output_length ),
4393 PSA_ERROR_INVALID_ARGUMENT );
4394
4395 psa_aead_abort( &operation );
4396
4397 /* Test sending additional data after data. */
4398
4399 operation = psa_aead_operation_init( );
4400
4401 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
4402
4403 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
4404
4405 PSA_ASSERT( psa_aead_update( &operation, input_data->x,
4406 input_data->len, output_data,
4407 output_size, &output_length ) );
4408
4409 TEST_EQUAL( psa_aead_update_ad( &operation, additional_data->x,
4410 additional_data->len ),
4411 PSA_ERROR_BAD_STATE );
4412
4413 psa_aead_abort( &operation );
4414
Paul Elliott534d0b42021-06-22 19:15:20 +01004415 /* Test calling finish on decryption. */
4416
4417 operation = psa_aead_operation_init( );
4418
4419 PSA_ASSERT( psa_aead_decrypt_setup( &operation, key, alg ) );
4420
4421 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
4422
4423 TEST_EQUAL( psa_aead_finish( &operation, final_data,
4424 finish_output_size,
4425 &output_part_length,
4426 tag_buffer, tag_length,
4427 &tag_size ),
4428 PSA_ERROR_BAD_STATE );
4429
4430 psa_aead_abort( &operation );
4431
4432 /* Test calling verify on encryption. */
4433
4434 operation = psa_aead_operation_init( );
4435
4436 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
4437
4438 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
4439
4440 TEST_EQUAL( psa_aead_verify( &operation, final_data,
4441 finish_output_size,
4442 &output_part_length,
4443 tag_buffer,
4444 tag_length ),
Paul Elliott5b065cb2021-06-23 08:33:22 +01004445 PSA_ERROR_BAD_STATE );
Paul Elliott534d0b42021-06-22 19:15:20 +01004446
4447 psa_aead_abort( &operation );
4448
4449
Paul Elliottc23a9a02021-06-21 18:32:46 +01004450exit:
4451 psa_destroy_key( key );
4452 psa_aead_abort( &operation );
4453 mbedtls_free( output_data );
4454 mbedtls_free( final_data );
4455 PSA_DONE( );
4456}
4457/* END_CASE */
4458
4459/* BEGIN_CASE */
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02004460void signature_size( int type_arg,
4461 int bits,
4462 int alg_arg,
4463 int expected_size_arg )
Gilles Peskinee59236f2018-01-27 23:32:46 +01004464{
4465 psa_key_type_t type = type_arg;
4466 psa_algorithm_t alg = alg_arg;
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01004467 size_t actual_size = PSA_SIGN_OUTPUT_SIZE( type, bits, alg );
Gilles Peskine841b14b2019-11-26 17:37:37 +01004468
Gilles Peskinefe11b722018-12-18 00:24:04 +01004469 TEST_EQUAL( actual_size, (size_t) expected_size_arg );
Gilles Peskine841b14b2019-11-26 17:37:37 +01004470
Gilles Peskinee59236f2018-01-27 23:32:46 +01004471exit:
4472 ;
4473}
4474/* END_CASE */
4475
4476/* BEGIN_CASE */
gabor-mezei-armb9530232021-04-16 14:21:21 +02004477void sign_hash_deterministic( int key_type_arg, data_t *key_data,
4478 int alg_arg, data_t *input_data,
4479 data_t *output_data )
Gilles Peskinee59236f2018-01-27 23:32:46 +01004480{
Ronald Cron5425a212020-08-04 14:58:35 +02004481 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskinee59236f2018-01-27 23:32:46 +01004482 psa_key_type_t key_type = key_type_arg;
4483 psa_algorithm_t alg = alg_arg;
Gilles Peskine20035e32018-02-03 22:44:14 +01004484 size_t key_bits;
Gilles Peskine20035e32018-02-03 22:44:14 +01004485 unsigned char *signature = NULL;
4486 size_t signature_size;
4487 size_t signature_length = 0xdeadbeef;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02004488 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine20035e32018-02-03 22:44:14 +01004489
Gilles Peskine8817f612018-12-18 00:18:46 +01004490 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine20035e32018-02-03 22:44:14 +01004491
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01004492 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_HASH );
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02004493 psa_set_key_algorithm( &attributes, alg );
4494 psa_set_key_type( &attributes, key_type );
mohammad1603a97cb8c2018-03-28 03:46:26 -07004495
Gilles Peskine049c7532019-05-15 20:22:09 +02004496 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02004497 &key ) );
4498 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02004499 key_bits = psa_get_key_bits( &attributes );
Gilles Peskine20035e32018-02-03 22:44:14 +01004500
Gilles Peskine860ce9d2018-06-28 12:23:00 +02004501 /* Allocate a buffer which has the size advertized by the
4502 * library. */
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01004503 signature_size = PSA_SIGN_OUTPUT_SIZE( key_type,
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02004504 key_bits, alg );
Gilles Peskine20035e32018-02-03 22:44:14 +01004505 TEST_ASSERT( signature_size != 0 );
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01004506 TEST_ASSERT( signature_size <= PSA_SIGNATURE_MAX_SIZE );
Gilles Peskine8cebbba2018-09-27 13:54:18 +02004507 ASSERT_ALLOC( signature, signature_size );
Gilles Peskine20035e32018-02-03 22:44:14 +01004508
Gilles Peskine860ce9d2018-06-28 12:23:00 +02004509 /* Perform the signature. */
Ronald Cron5425a212020-08-04 14:58:35 +02004510 PSA_ASSERT( psa_sign_hash( key, alg,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01004511 input_data->x, input_data->len,
4512 signature, signature_size,
4513 &signature_length ) );
Gilles Peskine9911b022018-06-29 17:30:48 +02004514 /* Verify that the signature is what is expected. */
Gilles Peskinebd7dea92018-09-27 13:57:19 +02004515 ASSERT_COMPARE( output_data->x, output_data->len,
4516 signature, signature_length );
Gilles Peskine20035e32018-02-03 22:44:14 +01004517
4518exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +01004519 /*
4520 * Key attributes may have been returned by psa_get_key_attributes()
4521 * thus reset them as required.
4522 */
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02004523 psa_reset_key_attributes( &attributes );
Ronald Cron3a4f0e32020-11-19 17:55:23 +01004524
Ronald Cron5425a212020-08-04 14:58:35 +02004525 psa_destroy_key( key );
Gilles Peskine0189e752018-02-03 23:57:22 +01004526 mbedtls_free( signature );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02004527 PSA_DONE( );
Gilles Peskine20035e32018-02-03 22:44:14 +01004528}
4529/* END_CASE */
4530
4531/* BEGIN_CASE */
gabor-mezei-armb9530232021-04-16 14:21:21 +02004532void sign_hash_fail( int key_type_arg, data_t *key_data,
4533 int alg_arg, data_t *input_data,
4534 int signature_size_arg, int expected_status_arg )
Gilles Peskine20035e32018-02-03 22:44:14 +01004535{
Ronald Cron5425a212020-08-04 14:58:35 +02004536 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine20035e32018-02-03 22:44:14 +01004537 psa_key_type_t key_type = key_type_arg;
4538 psa_algorithm_t alg = alg_arg;
Gilles Peskine860ce9d2018-06-28 12:23:00 +02004539 size_t signature_size = signature_size_arg;
Gilles Peskine20035e32018-02-03 22:44:14 +01004540 psa_status_t actual_status;
4541 psa_status_t expected_status = expected_status_arg;
Gilles Peskine40f68b92018-03-07 16:43:36 +01004542 unsigned char *signature = NULL;
Gilles Peskine93aa0332018-02-03 23:58:03 +01004543 size_t signature_length = 0xdeadbeef;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02004544 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine20035e32018-02-03 22:44:14 +01004545
Gilles Peskine8cebbba2018-09-27 13:54:18 +02004546 ASSERT_ALLOC( signature, signature_size );
Gilles Peskine20035e32018-02-03 22:44:14 +01004547
Gilles Peskine8817f612018-12-18 00:18:46 +01004548 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine20035e32018-02-03 22:44:14 +01004549
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01004550 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_HASH );
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02004551 psa_set_key_algorithm( &attributes, alg );
4552 psa_set_key_type( &attributes, key_type );
mohammad1603a97cb8c2018-03-28 03:46:26 -07004553
Gilles Peskine049c7532019-05-15 20:22:09 +02004554 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02004555 &key ) );
Gilles Peskine20035e32018-02-03 22:44:14 +01004556
Ronald Cron5425a212020-08-04 14:58:35 +02004557 actual_status = psa_sign_hash( key, alg,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01004558 input_data->x, input_data->len,
4559 signature, signature_size,
4560 &signature_length );
Gilles Peskinefe11b722018-12-18 00:24:04 +01004561 TEST_EQUAL( actual_status, expected_status );
Gilles Peskine860ce9d2018-06-28 12:23:00 +02004562 /* The value of *signature_length is unspecified on error, but
4563 * whatever it is, it should be less than signature_size, so that
4564 * if the caller tries to read *signature_length bytes without
4565 * checking the error code then they don't overflow a buffer. */
4566 TEST_ASSERT( signature_length <= signature_size );
Gilles Peskine20035e32018-02-03 22:44:14 +01004567
4568exit:
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02004569 psa_reset_key_attributes( &attributes );
Ronald Cron5425a212020-08-04 14:58:35 +02004570 psa_destroy_key( key );
Gilles Peskine20035e32018-02-03 22:44:14 +01004571 mbedtls_free( signature );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02004572 PSA_DONE( );
Gilles Peskine20035e32018-02-03 22:44:14 +01004573}
4574/* END_CASE */
mohammad16038cc1cee2018-03-28 01:21:33 +03004575
4576/* BEGIN_CASE */
gabor-mezei-armb9530232021-04-16 14:21:21 +02004577void sign_verify_hash( int key_type_arg, data_t *key_data,
4578 int alg_arg, data_t *input_data )
Gilles Peskine9911b022018-06-29 17:30:48 +02004579{
Ronald Cron5425a212020-08-04 14:58:35 +02004580 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine9911b022018-06-29 17:30:48 +02004581 psa_key_type_t key_type = key_type_arg;
4582 psa_algorithm_t alg = alg_arg;
4583 size_t key_bits;
4584 unsigned char *signature = NULL;
4585 size_t signature_size;
4586 size_t signature_length = 0xdeadbeef;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02004587 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine9911b022018-06-29 17:30:48 +02004588
Gilles Peskine8817f612018-12-18 00:18:46 +01004589 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine9911b022018-06-29 17:30:48 +02004590
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01004591 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_HASH | PSA_KEY_USAGE_VERIFY_HASH );
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02004592 psa_set_key_algorithm( &attributes, alg );
4593 psa_set_key_type( &attributes, key_type );
Gilles Peskine9911b022018-06-29 17:30:48 +02004594
Gilles Peskine049c7532019-05-15 20:22:09 +02004595 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02004596 &key ) );
4597 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02004598 key_bits = psa_get_key_bits( &attributes );
Gilles Peskine9911b022018-06-29 17:30:48 +02004599
4600 /* Allocate a buffer which has the size advertized by the
4601 * library. */
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01004602 signature_size = PSA_SIGN_OUTPUT_SIZE( key_type,
Gilles Peskine9911b022018-06-29 17:30:48 +02004603 key_bits, alg );
4604 TEST_ASSERT( signature_size != 0 );
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01004605 TEST_ASSERT( signature_size <= PSA_SIGNATURE_MAX_SIZE );
Gilles Peskine8cebbba2018-09-27 13:54:18 +02004606 ASSERT_ALLOC( signature, signature_size );
Gilles Peskine9911b022018-06-29 17:30:48 +02004607
4608 /* Perform the signature. */
Ronald Cron5425a212020-08-04 14:58:35 +02004609 PSA_ASSERT( psa_sign_hash( key, alg,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01004610 input_data->x, input_data->len,
4611 signature, signature_size,
4612 &signature_length ) );
Gilles Peskine9911b022018-06-29 17:30:48 +02004613 /* Check that the signature length looks sensible. */
4614 TEST_ASSERT( signature_length <= signature_size );
4615 TEST_ASSERT( signature_length > 0 );
4616
4617 /* Use the library to verify that the signature is correct. */
Ronald Cron5425a212020-08-04 14:58:35 +02004618 PSA_ASSERT( psa_verify_hash( key, alg,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01004619 input_data->x, input_data->len,
4620 signature, signature_length ) );
Gilles Peskine9911b022018-06-29 17:30:48 +02004621
4622 if( input_data->len != 0 )
4623 {
4624 /* Flip a bit in the input and verify that the signature is now
4625 * detected as invalid. Flip a bit at the beginning, not at the end,
4626 * because ECDSA may ignore the last few bits of the input. */
4627 input_data->x[0] ^= 1;
Ronald Cron5425a212020-08-04 14:58:35 +02004628 TEST_EQUAL( psa_verify_hash( key, alg,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01004629 input_data->x, input_data->len,
4630 signature, signature_length ),
Gilles Peskinef812dcf2018-12-18 00:33:25 +01004631 PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine9911b022018-06-29 17:30:48 +02004632 }
4633
4634exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +01004635 /*
4636 * Key attributes may have been returned by psa_get_key_attributes()
4637 * thus reset them as required.
4638 */
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02004639 psa_reset_key_attributes( &attributes );
Ronald Cron3a4f0e32020-11-19 17:55:23 +01004640
Ronald Cron5425a212020-08-04 14:58:35 +02004641 psa_destroy_key( key );
Gilles Peskine9911b022018-06-29 17:30:48 +02004642 mbedtls_free( signature );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02004643 PSA_DONE( );
Gilles Peskine9911b022018-06-29 17:30:48 +02004644}
4645/* END_CASE */
4646
4647/* BEGIN_CASE */
gabor-mezei-armb9530232021-04-16 14:21:21 +02004648void verify_hash( int key_type_arg, data_t *key_data,
4649 int alg_arg, data_t *hash_data,
4650 data_t *signature_data )
itayzafrir5c753392018-05-08 11:18:38 +03004651{
Ronald Cron5425a212020-08-04 14:58:35 +02004652 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
itayzafrir5c753392018-05-08 11:18:38 +03004653 psa_key_type_t key_type = key_type_arg;
4654 psa_algorithm_t alg = alg_arg;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02004655 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
itayzafrir5c753392018-05-08 11:18:38 +03004656
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01004657 TEST_ASSERT( signature_data->len <= PSA_SIGNATURE_MAX_SIZE );
Gilles Peskine69c12672018-06-28 00:07:19 +02004658
Gilles Peskine8817f612018-12-18 00:18:46 +01004659 PSA_ASSERT( psa_crypto_init( ) );
itayzafrir5c753392018-05-08 11:18:38 +03004660
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01004661 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_VERIFY_HASH );
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02004662 psa_set_key_algorithm( &attributes, alg );
4663 psa_set_key_type( &attributes, key_type );
itayzafrir5c753392018-05-08 11:18:38 +03004664
Gilles Peskine049c7532019-05-15 20:22:09 +02004665 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02004666 &key ) );
itayzafrir5c753392018-05-08 11:18:38 +03004667
Ronald Cron5425a212020-08-04 14:58:35 +02004668 PSA_ASSERT( psa_verify_hash( key, alg,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01004669 hash_data->x, hash_data->len,
4670 signature_data->x, signature_data->len ) );
Gilles Peskine0627f982019-11-26 19:12:16 +01004671
itayzafrir5c753392018-05-08 11:18:38 +03004672exit:
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02004673 psa_reset_key_attributes( &attributes );
Ronald Cron5425a212020-08-04 14:58:35 +02004674 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02004675 PSA_DONE( );
itayzafrir5c753392018-05-08 11:18:38 +03004676}
4677/* END_CASE */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004678
4679/* BEGIN_CASE */
gabor-mezei-armb9530232021-04-16 14:21:21 +02004680void verify_hash_fail( int key_type_arg, data_t *key_data,
4681 int alg_arg, data_t *hash_data,
4682 data_t *signature_data,
4683 int expected_status_arg )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004684{
Ronald Cron5425a212020-08-04 14:58:35 +02004685 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004686 psa_key_type_t key_type = key_type_arg;
4687 psa_algorithm_t alg = alg_arg;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004688 psa_status_t actual_status;
4689 psa_status_t expected_status = expected_status_arg;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02004690 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004691
Gilles Peskine8817f612018-12-18 00:18:46 +01004692 PSA_ASSERT( psa_crypto_init( ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004693
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01004694 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_VERIFY_HASH );
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02004695 psa_set_key_algorithm( &attributes, alg );
4696 psa_set_key_type( &attributes, key_type );
Nir Sonnenscheind7082602018-06-04 16:45:27 +03004697
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 ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004700
Ronald Cron5425a212020-08-04 14:58:35 +02004701 actual_status = psa_verify_hash( key, alg,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01004702 hash_data->x, hash_data->len,
4703 signature_data->x, signature_data->len );
Gilles Peskinefe11b722018-12-18 00:24:04 +01004704 TEST_EQUAL( actual_status, expected_status );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004705
4706exit:
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02004707 psa_reset_key_attributes( &attributes );
Ronald Cron5425a212020-08-04 14:58:35 +02004708 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02004709 PSA_DONE( );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004710}
4711/* END_CASE */
4712
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004713/* BEGIN_CASE */
gabor-mezei-arm53028482021-04-15 18:19:50 +02004714void sign_message_deterministic( int key_type_arg,
4715 data_t *key_data,
4716 int alg_arg,
4717 data_t *input_data,
4718 data_t *output_data )
4719{
4720 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
4721 psa_key_type_t key_type = key_type_arg;
4722 psa_algorithm_t alg = alg_arg;
4723 size_t key_bits;
4724 unsigned char *signature = NULL;
4725 size_t signature_size;
4726 size_t signature_length = 0xdeadbeef;
4727 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
4728
4729 PSA_ASSERT( psa_crypto_init( ) );
4730
4731 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_MESSAGE );
4732 psa_set_key_algorithm( &attributes, alg );
4733 psa_set_key_type( &attributes, key_type );
4734
4735 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
4736 &key ) );
4737 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
4738 key_bits = psa_get_key_bits( &attributes );
4739
4740 signature_size = PSA_SIGN_OUTPUT_SIZE( key_type, key_bits, alg );
4741 TEST_ASSERT( signature_size != 0 );
4742 TEST_ASSERT( signature_size <= PSA_SIGNATURE_MAX_SIZE );
4743 ASSERT_ALLOC( signature, signature_size );
4744
4745 PSA_ASSERT( psa_sign_message( key, alg,
4746 input_data->x, input_data->len,
4747 signature, signature_size,
4748 &signature_length ) );
4749
4750 ASSERT_COMPARE( output_data->x, output_data->len,
4751 signature, signature_length );
4752
4753exit:
4754 psa_reset_key_attributes( &attributes );
4755
4756 psa_destroy_key( key );
4757 mbedtls_free( signature );
4758 PSA_DONE( );
4759
4760}
4761/* END_CASE */
4762
4763/* BEGIN_CASE */
4764void sign_message_fail( int key_type_arg,
4765 data_t *key_data,
4766 int alg_arg,
4767 data_t *input_data,
4768 int signature_size_arg,
4769 int expected_status_arg )
4770{
4771 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
4772 psa_key_type_t key_type = key_type_arg;
4773 psa_algorithm_t alg = alg_arg;
4774 size_t signature_size = signature_size_arg;
4775 psa_status_t actual_status;
4776 psa_status_t expected_status = expected_status_arg;
4777 unsigned char *signature = NULL;
4778 size_t signature_length = 0xdeadbeef;
4779 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
4780
4781 ASSERT_ALLOC( signature, signature_size );
4782
4783 PSA_ASSERT( psa_crypto_init( ) );
4784
4785 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_MESSAGE );
4786 psa_set_key_algorithm( &attributes, alg );
4787 psa_set_key_type( &attributes, key_type );
4788
4789 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
4790 &key ) );
4791
4792 actual_status = psa_sign_message( key, alg,
4793 input_data->x, input_data->len,
4794 signature, signature_size,
4795 &signature_length );
4796 TEST_EQUAL( actual_status, expected_status );
4797 /* The value of *signature_length is unspecified on error, but
4798 * whatever it is, it should be less than signature_size, so that
4799 * if the caller tries to read *signature_length bytes without
4800 * checking the error code then they don't overflow a buffer. */
4801 TEST_ASSERT( signature_length <= signature_size );
4802
4803exit:
4804 psa_reset_key_attributes( &attributes );
4805 psa_destroy_key( key );
4806 mbedtls_free( signature );
4807 PSA_DONE( );
4808}
4809/* END_CASE */
4810
4811/* BEGIN_CASE */
4812void sign_verify_message( int key_type_arg,
4813 data_t *key_data,
4814 int alg_arg,
4815 data_t *input_data )
4816{
4817 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
4818 psa_key_type_t key_type = key_type_arg;
4819 psa_algorithm_t alg = alg_arg;
4820 size_t key_bits;
4821 unsigned char *signature = NULL;
4822 size_t signature_size;
4823 size_t signature_length = 0xdeadbeef;
4824 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
4825
4826 PSA_ASSERT( psa_crypto_init( ) );
4827
4828 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_MESSAGE |
4829 PSA_KEY_USAGE_VERIFY_MESSAGE );
4830 psa_set_key_algorithm( &attributes, alg );
4831 psa_set_key_type( &attributes, key_type );
4832
4833 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
4834 &key ) );
4835 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
4836 key_bits = psa_get_key_bits( &attributes );
4837
4838 signature_size = PSA_SIGN_OUTPUT_SIZE( key_type, key_bits, alg );
4839 TEST_ASSERT( signature_size != 0 );
4840 TEST_ASSERT( signature_size <= PSA_SIGNATURE_MAX_SIZE );
4841 ASSERT_ALLOC( signature, signature_size );
4842
4843 PSA_ASSERT( psa_sign_message( key, alg,
4844 input_data->x, input_data->len,
4845 signature, signature_size,
4846 &signature_length ) );
4847 TEST_ASSERT( signature_length <= signature_size );
4848 TEST_ASSERT( signature_length > 0 );
4849
4850 PSA_ASSERT( psa_verify_message( key, alg,
4851 input_data->x, input_data->len,
4852 signature, signature_length ) );
4853
4854 if( input_data->len != 0 )
4855 {
4856 /* Flip a bit in the input and verify that the signature is now
4857 * detected as invalid. Flip a bit at the beginning, not at the end,
4858 * because ECDSA may ignore the last few bits of the input. */
4859 input_data->x[0] ^= 1;
4860 TEST_EQUAL( psa_verify_message( key, alg,
4861 input_data->x, input_data->len,
4862 signature, signature_length ),
4863 PSA_ERROR_INVALID_SIGNATURE );
4864 }
4865
4866exit:
4867 psa_reset_key_attributes( &attributes );
4868
4869 psa_destroy_key( key );
4870 mbedtls_free( signature );
4871 PSA_DONE( );
4872}
4873/* END_CASE */
4874
4875/* BEGIN_CASE */
4876void verify_message( int key_type_arg,
4877 data_t *key_data,
4878 int alg_arg,
4879 data_t *input_data,
4880 data_t *signature_data )
4881{
4882 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
4883 psa_key_type_t key_type = key_type_arg;
4884 psa_algorithm_t alg = alg_arg;
4885 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
4886
4887 TEST_ASSERT( signature_data->len <= PSA_SIGNATURE_MAX_SIZE );
4888
4889 PSA_ASSERT( psa_crypto_init( ) );
4890
4891 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_VERIFY_MESSAGE );
4892 psa_set_key_algorithm( &attributes, alg );
4893 psa_set_key_type( &attributes, key_type );
4894
4895 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
4896 &key ) );
4897
4898 PSA_ASSERT( psa_verify_message( key, alg,
4899 input_data->x, input_data->len,
4900 signature_data->x, signature_data->len ) );
4901
4902exit:
4903 psa_reset_key_attributes( &attributes );
4904 psa_destroy_key( key );
4905 PSA_DONE( );
4906}
4907/* END_CASE */
4908
4909/* BEGIN_CASE */
4910void verify_message_fail( int key_type_arg,
4911 data_t *key_data,
4912 int alg_arg,
4913 data_t *hash_data,
4914 data_t *signature_data,
4915 int expected_status_arg )
4916{
4917 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
4918 psa_key_type_t key_type = key_type_arg;
4919 psa_algorithm_t alg = alg_arg;
4920 psa_status_t actual_status;
4921 psa_status_t expected_status = expected_status_arg;
4922 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
4923
4924 PSA_ASSERT( psa_crypto_init( ) );
4925
4926 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_VERIFY_MESSAGE );
4927 psa_set_key_algorithm( &attributes, alg );
4928 psa_set_key_type( &attributes, key_type );
4929
4930 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
4931 &key ) );
4932
4933 actual_status = psa_verify_message( key, alg,
4934 hash_data->x, hash_data->len,
4935 signature_data->x,
4936 signature_data->len );
4937 TEST_EQUAL( actual_status, expected_status );
4938
4939exit:
4940 psa_reset_key_attributes( &attributes );
4941 psa_destroy_key( key );
4942 PSA_DONE( );
4943}
4944/* END_CASE */
4945
4946/* BEGIN_CASE */
Gilles Peskine656896e2018-06-29 19:12:28 +02004947void asymmetric_encrypt( int key_type_arg,
4948 data_t *key_data,
4949 int alg_arg,
4950 data_t *input_data,
Gilles Peskine68428122018-06-30 18:42:41 +02004951 data_t *label,
Gilles Peskine656896e2018-06-29 19:12:28 +02004952 int expected_output_length_arg,
4953 int expected_status_arg )
4954{
Ronald Cron5425a212020-08-04 14:58:35 +02004955 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine656896e2018-06-29 19:12:28 +02004956 psa_key_type_t key_type = key_type_arg;
4957 psa_algorithm_t alg = alg_arg;
4958 size_t expected_output_length = expected_output_length_arg;
4959 size_t key_bits;
4960 unsigned char *output = NULL;
4961 size_t output_size;
4962 size_t output_length = ~0;
4963 psa_status_t actual_status;
4964 psa_status_t expected_status = expected_status_arg;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02004965 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine656896e2018-06-29 19:12:28 +02004966
Gilles Peskine8817f612018-12-18 00:18:46 +01004967 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskinebdf309c2018-12-03 15:36:32 +01004968
Gilles Peskine656896e2018-06-29 19:12:28 +02004969 /* Import the key */
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02004970 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
4971 psa_set_key_algorithm( &attributes, alg );
4972 psa_set_key_type( &attributes, key_type );
Gilles Peskine049c7532019-05-15 20:22:09 +02004973 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02004974 &key ) );
Gilles Peskine656896e2018-06-29 19:12:28 +02004975
4976 /* Determine the maximum output length */
Ronald Cron5425a212020-08-04 14:58:35 +02004977 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02004978 key_bits = psa_get_key_bits( &attributes );
gabor-mezei-armceface22021-01-21 12:26:17 +01004979
Gilles Peskine656896e2018-06-29 19:12:28 +02004980 output_size = PSA_ASYMMETRIC_ENCRYPT_OUTPUT_SIZE( key_type, key_bits, alg );
gabor-mezei-armceface22021-01-21 12:26:17 +01004981 TEST_ASSERT( output_size <= PSA_ASYMMETRIC_ENCRYPT_OUTPUT_MAX_SIZE );
Gilles Peskine8cebbba2018-09-27 13:54:18 +02004982 ASSERT_ALLOC( output, output_size );
Gilles Peskine656896e2018-06-29 19:12:28 +02004983
4984 /* Encrypt the input */
Ronald Cron5425a212020-08-04 14:58:35 +02004985 actual_status = psa_asymmetric_encrypt( key, alg,
Gilles Peskine656896e2018-06-29 19:12:28 +02004986 input_data->x, input_data->len,
Gilles Peskine68428122018-06-30 18:42:41 +02004987 label->x, label->len,
Gilles Peskine656896e2018-06-29 19:12:28 +02004988 output, output_size,
4989 &output_length );
Gilles Peskinefe11b722018-12-18 00:24:04 +01004990 TEST_EQUAL( actual_status, expected_status );
4991 TEST_EQUAL( output_length, expected_output_length );
Gilles Peskine656896e2018-06-29 19:12:28 +02004992
Gilles Peskine68428122018-06-30 18:42:41 +02004993 /* If the label is empty, the test framework puts a non-null pointer
4994 * in label->x. Test that a null pointer works as well. */
4995 if( label->len == 0 )
4996 {
4997 output_length = ~0;
Gilles Peskinef7ab5ad2018-09-26 18:19:24 +02004998 if( output_size != 0 )
4999 memset( output, 0, output_size );
Ronald Cron5425a212020-08-04 14:58:35 +02005000 actual_status = psa_asymmetric_encrypt( key, alg,
Gilles Peskine68428122018-06-30 18:42:41 +02005001 input_data->x, input_data->len,
5002 NULL, label->len,
5003 output, output_size,
5004 &output_length );
Gilles Peskinefe11b722018-12-18 00:24:04 +01005005 TEST_EQUAL( actual_status, expected_status );
5006 TEST_EQUAL( output_length, expected_output_length );
Gilles Peskine68428122018-06-30 18:42:41 +02005007 }
5008
Gilles Peskine656896e2018-06-29 19:12:28 +02005009exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +01005010 /*
5011 * Key attributes may have been returned by psa_get_key_attributes()
5012 * thus reset them as required.
5013 */
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02005014 psa_reset_key_attributes( &attributes );
Ronald Cron3a4f0e32020-11-19 17:55:23 +01005015
Ronald Cron5425a212020-08-04 14:58:35 +02005016 psa_destroy_key( key );
Gilles Peskine656896e2018-06-29 19:12:28 +02005017 mbedtls_free( output );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02005018 PSA_DONE( );
Gilles Peskine656896e2018-06-29 19:12:28 +02005019}
5020/* END_CASE */
5021
5022/* BEGIN_CASE */
Gilles Peskine68428122018-06-30 18:42:41 +02005023void asymmetric_encrypt_decrypt( int key_type_arg,
5024 data_t *key_data,
5025 int alg_arg,
5026 data_t *input_data,
5027 data_t *label )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005028{
Ronald Cron5425a212020-08-04 14:58:35 +02005029 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005030 psa_key_type_t key_type = key_type_arg;
5031 psa_algorithm_t alg = alg_arg;
Gilles Peskine55c94dd2018-06-30 18:54:48 +02005032 size_t key_bits;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005033 unsigned char *output = NULL;
Gilles Peskine55c94dd2018-06-30 18:54:48 +02005034 size_t output_size;
5035 size_t output_length = ~0;
Nir Sonnenschein0f3bdbd2018-05-02 23:56:12 +03005036 unsigned char *output2 = NULL;
Gilles Peskine55c94dd2018-06-30 18:54:48 +02005037 size_t output2_size;
5038 size_t output2_length = ~0;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02005039 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005040
Gilles Peskine8817f612018-12-18 00:18:46 +01005041 PSA_ASSERT( psa_crypto_init( ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005042
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02005043 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT | PSA_KEY_USAGE_DECRYPT );
5044 psa_set_key_algorithm( &attributes, alg );
5045 psa_set_key_type( &attributes, key_type );
Nir Sonnenscheind7082602018-06-04 16:45:27 +03005046
Gilles Peskine049c7532019-05-15 20:22:09 +02005047 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02005048 &key ) );
Gilles Peskine55c94dd2018-06-30 18:54:48 +02005049
5050 /* Determine the maximum ciphertext length */
Ronald Cron5425a212020-08-04 14:58:35 +02005051 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02005052 key_bits = psa_get_key_bits( &attributes );
gabor-mezei-armceface22021-01-21 12:26:17 +01005053
Gilles Peskine55c94dd2018-06-30 18:54:48 +02005054 output_size = PSA_ASYMMETRIC_ENCRYPT_OUTPUT_SIZE( key_type, key_bits, alg );
gabor-mezei-armceface22021-01-21 12:26:17 +01005055 TEST_ASSERT( output_size <= PSA_ASYMMETRIC_ENCRYPT_OUTPUT_MAX_SIZE );
Gilles Peskine8cebbba2018-09-27 13:54:18 +02005056 ASSERT_ALLOC( output, output_size );
gabor-mezei-armceface22021-01-21 12:26:17 +01005057
Gilles Peskine55c94dd2018-06-30 18:54:48 +02005058 output2_size = input_data->len;
gabor-mezei-armceface22021-01-21 12:26:17 +01005059 TEST_ASSERT( output2_size <=
5060 PSA_ASYMMETRIC_DECRYPT_OUTPUT_SIZE( key_type, key_bits, alg ) );
5061 TEST_ASSERT( output2_size <= PSA_ASYMMETRIC_DECRYPT_OUTPUT_MAX_SIZE );
Gilles Peskine8cebbba2018-09-27 13:54:18 +02005062 ASSERT_ALLOC( output2, output2_size );
Gilles Peskine55c94dd2018-06-30 18:54:48 +02005063
Gilles Peskineeebd7382018-06-08 18:11:54 +02005064 /* We test encryption by checking that encrypt-then-decrypt gives back
5065 * the original plaintext because of the non-optional random
5066 * part of encryption process which prevents using fixed vectors. */
Ronald Cron5425a212020-08-04 14:58:35 +02005067 PSA_ASSERT( psa_asymmetric_encrypt( key, alg,
Gilles Peskine8817f612018-12-18 00:18:46 +01005068 input_data->x, input_data->len,
5069 label->x, label->len,
5070 output, output_size,
5071 &output_length ) );
Gilles Peskine55c94dd2018-06-30 18:54:48 +02005072 /* We don't know what ciphertext length to expect, but check that
5073 * it looks sensible. */
5074 TEST_ASSERT( output_length <= output_size );
Nir Sonnenschein0f3bdbd2018-05-02 23:56:12 +03005075
Ronald Cron5425a212020-08-04 14:58:35 +02005076 PSA_ASSERT( psa_asymmetric_decrypt( key, alg,
Gilles Peskine8817f612018-12-18 00:18:46 +01005077 output, output_length,
5078 label->x, label->len,
5079 output2, output2_size,
5080 &output2_length ) );
Gilles Peskinebd7dea92018-09-27 13:57:19 +02005081 ASSERT_COMPARE( input_data->x, input_data->len,
5082 output2, output2_length );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005083
5084exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +01005085 /*
5086 * Key attributes may have been returned by psa_get_key_attributes()
5087 * thus reset them as required.
5088 */
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02005089 psa_reset_key_attributes( &attributes );
Ronald Cron3a4f0e32020-11-19 17:55:23 +01005090
Ronald Cron5425a212020-08-04 14:58:35 +02005091 psa_destroy_key( key );
itayzafrir3e02b3b2018-06-12 17:06:52 +03005092 mbedtls_free( output );
5093 mbedtls_free( output2 );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02005094 PSA_DONE( );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005095}
5096/* END_CASE */
5097
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005098/* BEGIN_CASE */
Gilles Peskine68428122018-06-30 18:42:41 +02005099void asymmetric_decrypt( int key_type_arg,
5100 data_t *key_data,
5101 int alg_arg,
5102 data_t *input_data,
5103 data_t *label,
Gilles Peskine66763a02018-06-29 21:54:10 +02005104 data_t *expected_data )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005105{
Ronald Cron5425a212020-08-04 14:58:35 +02005106 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005107 psa_key_type_t key_type = key_type_arg;
5108 psa_algorithm_t alg = alg_arg;
gabor-mezei-armceface22021-01-21 12:26:17 +01005109 size_t key_bits;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005110 unsigned char *output = NULL;
Nir Sonnenscheind70bc482018-06-04 16:31:13 +03005111 size_t output_size = 0;
Gilles Peskine55c94dd2018-06-30 18:54:48 +02005112 size_t output_length = ~0;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02005113 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005114
Gilles Peskine8817f612018-12-18 00:18:46 +01005115 PSA_ASSERT( psa_crypto_init( ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005116
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02005117 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DECRYPT );
5118 psa_set_key_algorithm( &attributes, alg );
5119 psa_set_key_type( &attributes, key_type );
Nir Sonnenscheind7082602018-06-04 16:45:27 +03005120
Gilles Peskine049c7532019-05-15 20:22:09 +02005121 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02005122 &key ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005123
gabor-mezei-armceface22021-01-21 12:26:17 +01005124 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
5125 key_bits = psa_get_key_bits( &attributes );
5126
5127 /* Determine the maximum ciphertext length */
5128 output_size = PSA_ASYMMETRIC_DECRYPT_OUTPUT_SIZE( key_type, key_bits, alg );
5129 TEST_ASSERT( output_size <= PSA_ASYMMETRIC_DECRYPT_OUTPUT_MAX_SIZE );
5130 ASSERT_ALLOC( output, output_size );
5131
Ronald Cron5425a212020-08-04 14:58:35 +02005132 PSA_ASSERT( psa_asymmetric_decrypt( key, alg,
Gilles Peskine8817f612018-12-18 00:18:46 +01005133 input_data->x, input_data->len,
5134 label->x, label->len,
5135 output,
5136 output_size,
5137 &output_length ) );
Gilles Peskinebd7dea92018-09-27 13:57:19 +02005138 ASSERT_COMPARE( expected_data->x, expected_data->len,
5139 output, output_length );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005140
Gilles Peskine68428122018-06-30 18:42:41 +02005141 /* If the label is empty, the test framework puts a non-null pointer
5142 * in label->x. Test that a null pointer works as well. */
5143 if( label->len == 0 )
5144 {
5145 output_length = ~0;
Gilles Peskinef7ab5ad2018-09-26 18:19:24 +02005146 if( output_size != 0 )
5147 memset( output, 0, output_size );
Ronald Cron5425a212020-08-04 14:58:35 +02005148 PSA_ASSERT( psa_asymmetric_decrypt( key, alg,
Gilles Peskine8817f612018-12-18 00:18:46 +01005149 input_data->x, input_data->len,
5150 NULL, label->len,
5151 output,
5152 output_size,
5153 &output_length ) );
Gilles Peskinebd7dea92018-09-27 13:57:19 +02005154 ASSERT_COMPARE( expected_data->x, expected_data->len,
5155 output, output_length );
Gilles Peskine68428122018-06-30 18:42:41 +02005156 }
5157
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005158exit:
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02005159 psa_reset_key_attributes( &attributes );
Ronald Cron5425a212020-08-04 14:58:35 +02005160 psa_destroy_key( key );
itayzafrir3e02b3b2018-06-12 17:06:52 +03005161 mbedtls_free( output );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02005162 PSA_DONE( );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005163}
5164/* END_CASE */
5165
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005166/* BEGIN_CASE */
Gilles Peskine68428122018-06-30 18:42:41 +02005167void asymmetric_decrypt_fail( int key_type_arg,
5168 data_t *key_data,
5169 int alg_arg,
5170 data_t *input_data,
5171 data_t *label,
Jaeden Amerof8daab72019-02-06 12:57:46 +00005172 int output_size_arg,
Gilles Peskine2d277862018-06-18 15:41:12 +02005173 int expected_status_arg )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005174{
Ronald Cron5425a212020-08-04 14:58:35 +02005175 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005176 psa_key_type_t key_type = key_type_arg;
5177 psa_algorithm_t alg = alg_arg;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005178 unsigned char *output = NULL;
Jaeden Amerof8daab72019-02-06 12:57:46 +00005179 size_t output_size = output_size_arg;
Gilles Peskine55c94dd2018-06-30 18:54:48 +02005180 size_t output_length = ~0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005181 psa_status_t actual_status;
5182 psa_status_t expected_status = expected_status_arg;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02005183 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005184
Gilles Peskine8cebbba2018-09-27 13:54:18 +02005185 ASSERT_ALLOC( output, output_size );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02005186
Gilles Peskine8817f612018-12-18 00:18:46 +01005187 PSA_ASSERT( psa_crypto_init( ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005188
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02005189 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DECRYPT );
5190 psa_set_key_algorithm( &attributes, alg );
5191 psa_set_key_type( &attributes, key_type );
Nir Sonnenscheind7082602018-06-04 16:45:27 +03005192
Gilles Peskine049c7532019-05-15 20:22:09 +02005193 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02005194 &key ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005195
Ronald Cron5425a212020-08-04 14:58:35 +02005196 actual_status = psa_asymmetric_decrypt( key, alg,
Gilles Peskine4abf7412018-06-18 16:35:34 +02005197 input_data->x, input_data->len,
Gilles Peskine68428122018-06-30 18:42:41 +02005198 label->x, label->len,
Gilles Peskine4abf7412018-06-18 16:35:34 +02005199 output, output_size,
Gilles Peskine2d277862018-06-18 15:41:12 +02005200 &output_length );
Gilles Peskinefe11b722018-12-18 00:24:04 +01005201 TEST_EQUAL( actual_status, expected_status );
Gilles Peskine55c94dd2018-06-30 18:54:48 +02005202 TEST_ASSERT( output_length <= output_size );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005203
Gilles Peskine68428122018-06-30 18:42:41 +02005204 /* If the label is empty, the test framework puts a non-null pointer
5205 * in label->x. Test that a null pointer works as well. */
5206 if( label->len == 0 )
5207 {
5208 output_length = ~0;
Gilles Peskinef7ab5ad2018-09-26 18:19:24 +02005209 if( output_size != 0 )
5210 memset( output, 0, output_size );
Ronald Cron5425a212020-08-04 14:58:35 +02005211 actual_status = psa_asymmetric_decrypt( key, alg,
Gilles Peskine68428122018-06-30 18:42:41 +02005212 input_data->x, input_data->len,
5213 NULL, label->len,
5214 output, output_size,
5215 &output_length );
Gilles Peskinefe11b722018-12-18 00:24:04 +01005216 TEST_EQUAL( actual_status, expected_status );
Gilles Peskine55c94dd2018-06-30 18:54:48 +02005217 TEST_ASSERT( output_length <= output_size );
Gilles Peskine68428122018-06-30 18:42:41 +02005218 }
5219
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005220exit:
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02005221 psa_reset_key_attributes( &attributes );
Ronald Cron5425a212020-08-04 14:58:35 +02005222 psa_destroy_key( key );
Gilles Peskine2d277862018-06-18 15:41:12 +02005223 mbedtls_free( output );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02005224 PSA_DONE( );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005225}
Gilles Peskine5b051bc2018-05-31 13:25:48 +02005226/* END_CASE */
Gilles Peskine05d69892018-06-19 22:00:52 +02005227
5228/* BEGIN_CASE */
Gilles Peskinecbe66502019-05-16 16:59:18 +02005229void key_derivation_init( )
Jaeden Amerod94d6712019-01-04 14:11:48 +00005230{
5231 /* Test each valid way of initializing the object, except for `= {0}`, as
5232 * Clang 5 complains when `-Wmissing-field-initializers` is used, even
5233 * though it's OK by the C standard. We could test for this, but we'd need
5234 * to supress the Clang warning for the test. */
Jaeden Amero5229bbb2019-02-07 16:33:37 +00005235 size_t capacity;
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005236 psa_key_derivation_operation_t func = psa_key_derivation_operation_init( );
5237 psa_key_derivation_operation_t init = PSA_KEY_DERIVATION_OPERATION_INIT;
5238 psa_key_derivation_operation_t zero;
Jaeden Amerod94d6712019-01-04 14:11:48 +00005239
5240 memset( &zero, 0, sizeof( zero ) );
5241
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005242 /* A default operation should not be able to report its capacity. */
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005243 TEST_EQUAL( psa_key_derivation_get_capacity( &func, &capacity ),
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005244 PSA_ERROR_BAD_STATE );
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005245 TEST_EQUAL( psa_key_derivation_get_capacity( &init, &capacity ),
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005246 PSA_ERROR_BAD_STATE );
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005247 TEST_EQUAL( psa_key_derivation_get_capacity( &zero, &capacity ),
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005248 PSA_ERROR_BAD_STATE );
Jaeden Amero5229bbb2019-02-07 16:33:37 +00005249
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005250 /* A default operation should be abortable without error. */
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005251 PSA_ASSERT( psa_key_derivation_abort(&func) );
5252 PSA_ASSERT( psa_key_derivation_abort(&init) );
5253 PSA_ASSERT( psa_key_derivation_abort(&zero) );
Jaeden Amerod94d6712019-01-04 14:11:48 +00005254}
5255/* END_CASE */
5256
Janos Follath16de4a42019-06-13 16:32:24 +01005257/* BEGIN_CASE */
5258void derive_setup( int alg_arg, int expected_status_arg )
Gilles Peskineea0fb492018-07-12 17:17:20 +02005259{
Gilles Peskineea0fb492018-07-12 17:17:20 +02005260 psa_algorithm_t alg = alg_arg;
Gilles Peskineea0fb492018-07-12 17:17:20 +02005261 psa_status_t expected_status = expected_status_arg;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005262 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Gilles Peskineea0fb492018-07-12 17:17:20 +02005263
Gilles Peskine8817f612018-12-18 00:18:46 +01005264 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskineea0fb492018-07-12 17:17:20 +02005265
Janos Follath16de4a42019-06-13 16:32:24 +01005266 TEST_EQUAL( psa_key_derivation_setup( &operation, alg ),
Gilles Peskinef812dcf2018-12-18 00:33:25 +01005267 expected_status );
Gilles Peskineea0fb492018-07-12 17:17:20 +02005268
5269exit:
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005270 psa_key_derivation_abort( &operation );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02005271 PSA_DONE( );
Gilles Peskineea0fb492018-07-12 17:17:20 +02005272}
5273/* END_CASE */
5274
Janos Follathaf3c2a02019-06-12 12:34:34 +01005275/* BEGIN_CASE */
Janos Follatha27c9272019-06-14 09:59:36 +01005276void derive_set_capacity( int alg_arg, int capacity_arg,
5277 int expected_status_arg )
5278{
5279 psa_algorithm_t alg = alg_arg;
5280 size_t capacity = capacity_arg;
5281 psa_status_t expected_status = expected_status_arg;
5282 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
5283
5284 PSA_ASSERT( psa_crypto_init( ) );
5285
5286 PSA_ASSERT( psa_key_derivation_setup( &operation, alg ) );
5287
5288 TEST_EQUAL( psa_key_derivation_set_capacity( &operation, capacity ),
5289 expected_status );
5290
5291exit:
5292 psa_key_derivation_abort( &operation );
5293 PSA_DONE( );
5294}
5295/* END_CASE */
5296
5297/* BEGIN_CASE */
Janos Follathaf3c2a02019-06-12 12:34:34 +01005298void derive_input( int alg_arg,
Gilles Peskine6842ba42019-09-23 13:49:33 +02005299 int step_arg1, int key_type_arg1, data_t *input1,
Janos Follathaf3c2a02019-06-12 12:34:34 +01005300 int expected_status_arg1,
Gilles Peskine2058c072019-09-24 17:19:33 +02005301 int step_arg2, int key_type_arg2, data_t *input2,
Janos Follathaf3c2a02019-06-12 12:34:34 +01005302 int expected_status_arg2,
Gilles Peskine2058c072019-09-24 17:19:33 +02005303 int step_arg3, int key_type_arg3, data_t *input3,
Gilles Peskine1a2904c2019-09-24 17:45:07 +02005304 int expected_status_arg3,
5305 int output_key_type_arg, int expected_output_status_arg )
Janos Follathaf3c2a02019-06-12 12:34:34 +01005306{
5307 psa_algorithm_t alg = alg_arg;
Gilles Peskine6842ba42019-09-23 13:49:33 +02005308 psa_key_derivation_step_t steps[] = {step_arg1, step_arg2, step_arg3};
5309 psa_key_type_t key_types[] = {key_type_arg1, key_type_arg2, key_type_arg3};
Janos Follathaf3c2a02019-06-12 12:34:34 +01005310 psa_status_t expected_statuses[] = {expected_status_arg1,
5311 expected_status_arg2,
5312 expected_status_arg3};
5313 data_t *inputs[] = {input1, input2, input3};
Ronald Cron5425a212020-08-04 14:58:35 +02005314 mbedtls_svc_key_id_t keys[] = { MBEDTLS_SVC_KEY_ID_INIT,
5315 MBEDTLS_SVC_KEY_ID_INIT,
5316 MBEDTLS_SVC_KEY_ID_INIT };
Janos Follathaf3c2a02019-06-12 12:34:34 +01005317 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
5318 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
5319 size_t i;
Gilles Peskine1a2904c2019-09-24 17:45:07 +02005320 psa_key_type_t output_key_type = output_key_type_arg;
Ronald Cron5425a212020-08-04 14:58:35 +02005321 mbedtls_svc_key_id_t output_key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine1a2904c2019-09-24 17:45:07 +02005322 psa_status_t expected_output_status = expected_output_status_arg;
5323 psa_status_t actual_output_status;
Janos Follathaf3c2a02019-06-12 12:34:34 +01005324
5325 PSA_ASSERT( psa_crypto_init( ) );
5326
5327 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DERIVE );
5328 psa_set_key_algorithm( &attributes, alg );
Janos Follathaf3c2a02019-06-12 12:34:34 +01005329
5330 PSA_ASSERT( psa_key_derivation_setup( &operation, alg ) );
5331
5332 for( i = 0; i < ARRAY_LENGTH( steps ); i++ )
5333 {
Gilles Peskineb8965192019-09-24 16:21:10 +02005334 if( key_types[i] != PSA_KEY_TYPE_NONE )
Janos Follathaf3c2a02019-06-12 12:34:34 +01005335 {
Gilles Peskine6842ba42019-09-23 13:49:33 +02005336 psa_set_key_type( &attributes, key_types[i] );
5337 PSA_ASSERT( psa_import_key( &attributes,
5338 inputs[i]->x, inputs[i]->len,
Ronald Cron5425a212020-08-04 14:58:35 +02005339 &keys[i] ) );
Steven Cooreman0ee0d522020-10-05 16:03:42 +02005340 if( PSA_KEY_TYPE_IS_KEY_PAIR( key_types[i] ) &&
5341 steps[i] == PSA_KEY_DERIVATION_INPUT_SECRET )
5342 {
5343 // When taking a private key as secret input, use key agreement
5344 // to add the shared secret to the derivation
Gilles Peskinec18e25f2021-02-12 23:48:20 +01005345 TEST_EQUAL( mbedtls_test_psa_key_agreement_with_self(
5346 &operation, keys[i] ),
Steven Cooreman0ee0d522020-10-05 16:03:42 +02005347 expected_statuses[i] );
5348 }
5349 else
5350 {
5351 TEST_EQUAL( psa_key_derivation_input_key( &operation, steps[i],
Ronald Cron5425a212020-08-04 14:58:35 +02005352 keys[i] ),
Steven Cooreman0ee0d522020-10-05 16:03:42 +02005353 expected_statuses[i] );
5354 }
Gilles Peskine6842ba42019-09-23 13:49:33 +02005355 }
5356 else
5357 {
5358 TEST_EQUAL( psa_key_derivation_input_bytes(
5359 &operation, steps[i],
5360 inputs[i]->x, inputs[i]->len ),
5361 expected_statuses[i] );
Janos Follathaf3c2a02019-06-12 12:34:34 +01005362 }
5363 }
5364
Gilles Peskine1a2904c2019-09-24 17:45:07 +02005365 if( output_key_type != PSA_KEY_TYPE_NONE )
5366 {
5367 psa_reset_key_attributes( &attributes );
5368 psa_set_key_type( &attributes, PSA_KEY_TYPE_RAW_DATA );
5369 psa_set_key_bits( &attributes, 8 );
5370 actual_output_status =
5371 psa_key_derivation_output_key( &attributes, &operation,
Ronald Cron5425a212020-08-04 14:58:35 +02005372 &output_key );
Gilles Peskine1a2904c2019-09-24 17:45:07 +02005373 }
5374 else
5375 {
5376 uint8_t buffer[1];
5377 actual_output_status =
5378 psa_key_derivation_output_bytes( &operation,
5379 buffer, sizeof( buffer ) );
5380 }
5381 TEST_EQUAL( actual_output_status, expected_output_status );
5382
Janos Follathaf3c2a02019-06-12 12:34:34 +01005383exit:
5384 psa_key_derivation_abort( &operation );
Ronald Cron5425a212020-08-04 14:58:35 +02005385 for( i = 0; i < ARRAY_LENGTH( keys ); i++ )
5386 psa_destroy_key( keys[i] );
5387 psa_destroy_key( output_key );
Janos Follathaf3c2a02019-06-12 12:34:34 +01005388 PSA_DONE( );
5389}
5390/* END_CASE */
5391
Janos Follathd958bb72019-07-03 15:02:16 +01005392/* BEGIN_CASE */
5393void test_derive_invalid_key_derivation_state( int alg_arg )
Nir Sonnenscheine5204c92018-10-22 17:24:55 +03005394{
Janos Follathd958bb72019-07-03 15:02:16 +01005395 psa_algorithm_t alg = alg_arg;
Ronald Cron5425a212020-08-04 14:58:35 +02005396 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Nir Sonnenschein4eda37b2018-10-31 12:15:58 +02005397 size_t key_type = PSA_KEY_TYPE_DERIVE;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005398 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Janos Follathd958bb72019-07-03 15:02:16 +01005399 unsigned char input1[] = "Input 1";
5400 size_t input1_length = sizeof( input1 );
5401 unsigned char input2[] = "Input 2";
5402 size_t input2_length = sizeof( input2 );
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03005403 uint8_t buffer[42];
Nir Sonnenschein1caf6d22018-11-01 12:27:20 +02005404 size_t capacity = sizeof( buffer );
Nir Sonnenscheindd69d8b2018-11-01 12:24:23 +02005405 const uint8_t key_data[22] = { 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b,
5406 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b,
5407 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b};
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02005408 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Nir Sonnenscheine5204c92018-10-22 17:24:55 +03005409
Gilles Peskine8817f612018-12-18 00:18:46 +01005410 PSA_ASSERT( psa_crypto_init( ) );
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03005411
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02005412 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DERIVE );
5413 psa_set_key_algorithm( &attributes, alg );
5414 psa_set_key_type( &attributes, key_type );
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03005415
Gilles Peskine73676cb2019-05-15 20:15:10 +02005416 PSA_ASSERT( psa_import_key( &attributes,
5417 key_data, sizeof( key_data ),
Ronald Cron5425a212020-08-04 14:58:35 +02005418 &key ) );
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03005419
5420 /* valid key derivation */
Gilles Peskinec18e25f2021-02-12 23:48:20 +01005421 if( !mbedtls_test_psa_setup_key_derivation_wrap( &operation, key, alg,
5422 input1, input1_length,
5423 input2, input2_length,
5424 capacity ) )
Janos Follathd958bb72019-07-03 15:02:16 +01005425 goto exit;
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03005426
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005427 /* state of operation shouldn't allow additional generation */
Janos Follathd958bb72019-07-03 15:02:16 +01005428 TEST_EQUAL( psa_key_derivation_setup( &operation, alg ),
Gilles Peskinef812dcf2018-12-18 00:33:25 +01005429 PSA_ERROR_BAD_STATE );
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03005430
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005431 PSA_ASSERT( psa_key_derivation_output_bytes( &operation, buffer, capacity ) );
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03005432
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005433 TEST_EQUAL( psa_key_derivation_output_bytes( &operation, buffer, capacity ),
David Saadab4ecc272019-02-14 13:48:10 +02005434 PSA_ERROR_INSUFFICIENT_DATA );
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03005435
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03005436exit:
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005437 psa_key_derivation_abort( &operation );
Ronald Cron5425a212020-08-04 14:58:35 +02005438 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02005439 PSA_DONE( );
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03005440}
5441/* END_CASE */
5442
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03005443/* BEGIN_CASE */
Gilles Peskinecbe66502019-05-16 16:59:18 +02005444void test_derive_invalid_key_derivation_tests( )
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03005445{
5446 uint8_t output_buffer[16];
5447 size_t buffer_size = 16;
5448 size_t capacity = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005449 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03005450
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005451 TEST_ASSERT( psa_key_derivation_output_bytes( &operation,
5452 output_buffer, buffer_size )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005453 == PSA_ERROR_BAD_STATE );
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03005454
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005455 TEST_ASSERT( psa_key_derivation_get_capacity( &operation, &capacity )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005456 == PSA_ERROR_BAD_STATE );
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03005457
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005458 PSA_ASSERT( psa_key_derivation_abort( &operation ) );
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03005459
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005460 TEST_ASSERT( psa_key_derivation_output_bytes( &operation,
5461 output_buffer, buffer_size )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005462 == PSA_ERROR_BAD_STATE );
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03005463
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005464 TEST_ASSERT( psa_key_derivation_get_capacity( &operation, &capacity )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005465 == PSA_ERROR_BAD_STATE );
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03005466
5467exit:
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005468 psa_key_derivation_abort( &operation );
Nir Sonnenscheine5204c92018-10-22 17:24:55 +03005469}
5470/* END_CASE */
5471
5472/* BEGIN_CASE */
Gilles Peskine96ee5c72018-07-12 17:24:54 +02005473void derive_output( int alg_arg,
Gilles Peskine1468da72019-05-29 17:35:49 +02005474 int step1_arg, data_t *input1,
5475 int step2_arg, data_t *input2,
5476 int step3_arg, data_t *input3,
Gilles Peskine96ee5c72018-07-12 17:24:54 +02005477 int requested_capacity_arg,
5478 data_t *expected_output1,
5479 data_t *expected_output2 )
5480{
Gilles Peskine96ee5c72018-07-12 17:24:54 +02005481 psa_algorithm_t alg = alg_arg;
Gilles Peskine1468da72019-05-29 17:35:49 +02005482 psa_key_derivation_step_t steps[] = {step1_arg, step2_arg, step3_arg};
5483 data_t *inputs[] = {input1, input2, input3};
Ronald Cron5425a212020-08-04 14:58:35 +02005484 mbedtls_svc_key_id_t keys[] = { MBEDTLS_SVC_KEY_ID_INIT,
5485 MBEDTLS_SVC_KEY_ID_INIT,
5486 MBEDTLS_SVC_KEY_ID_INIT };
Gilles Peskine96ee5c72018-07-12 17:24:54 +02005487 size_t requested_capacity = requested_capacity_arg;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005488 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Gilles Peskine96ee5c72018-07-12 17:24:54 +02005489 uint8_t *expected_outputs[2] =
5490 {expected_output1->x, expected_output2->x};
5491 size_t output_sizes[2] =
5492 {expected_output1->len, expected_output2->len};
5493 size_t output_buffer_size = 0;
5494 uint8_t *output_buffer = NULL;
5495 size_t expected_capacity;
5496 size_t current_capacity;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005497 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine96ee5c72018-07-12 17:24:54 +02005498 psa_status_t status;
Gilles Peskine1468da72019-05-29 17:35:49 +02005499 size_t i;
Gilles Peskine96ee5c72018-07-12 17:24:54 +02005500
5501 for( i = 0; i < ARRAY_LENGTH( expected_outputs ); i++ )
5502 {
5503 if( output_sizes[i] > output_buffer_size )
5504 output_buffer_size = output_sizes[i];
5505 if( output_sizes[i] == 0 )
5506 expected_outputs[i] = NULL;
5507 }
Gilles Peskine8cebbba2018-09-27 13:54:18 +02005508 ASSERT_ALLOC( output_buffer, output_buffer_size );
Gilles Peskine8817f612018-12-18 00:18:46 +01005509 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine96ee5c72018-07-12 17:24:54 +02005510
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005511 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DERIVE );
5512 psa_set_key_algorithm( &attributes, alg );
5513 psa_set_key_type( &attributes, PSA_KEY_TYPE_DERIVE );
Gilles Peskine96ee5c72018-07-12 17:24:54 +02005514
Gilles Peskine96ee5c72018-07-12 17:24:54 +02005515 /* Extraction phase. */
Gilles Peskine1468da72019-05-29 17:35:49 +02005516 PSA_ASSERT( psa_key_derivation_setup( &operation, alg ) );
5517 PSA_ASSERT( psa_key_derivation_set_capacity( &operation,
5518 requested_capacity ) );
5519 for( i = 0; i < ARRAY_LENGTH( steps ); i++ )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005520 {
Gilles Peskine1468da72019-05-29 17:35:49 +02005521 switch( steps[i] )
5522 {
5523 case 0:
5524 break;
5525 case PSA_KEY_DERIVATION_INPUT_SECRET:
5526 PSA_ASSERT( psa_import_key( &attributes,
5527 inputs[i]->x, inputs[i]->len,
Ronald Cron5425a212020-08-04 14:58:35 +02005528 &keys[i] ) );
gabor-mezei-armceface22021-01-21 12:26:17 +01005529
5530 if ( PSA_ALG_IS_TLS12_PSK_TO_MS( alg ) )
5531 {
5532 PSA_ASSERT( psa_get_key_attributes( keys[i], &attributes ) );
5533 TEST_ASSERT( PSA_BITS_TO_BYTES( psa_get_key_bits( &attributes ) ) <=
5534 PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE );
5535 }
5536
Gilles Peskine1468da72019-05-29 17:35:49 +02005537 PSA_ASSERT( psa_key_derivation_input_key(
Ronald Cron5425a212020-08-04 14:58:35 +02005538 &operation, steps[i], keys[i] ) );
Gilles Peskine1468da72019-05-29 17:35:49 +02005539 break;
5540 default:
5541 PSA_ASSERT( psa_key_derivation_input_bytes(
5542 &operation, steps[i],
5543 inputs[i]->x, inputs[i]->len ) );
5544 break;
5545 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005546 }
Gilles Peskine1468da72019-05-29 17:35:49 +02005547
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005548 PSA_ASSERT( psa_key_derivation_get_capacity( &operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005549 &current_capacity ) );
Gilles Peskinefe11b722018-12-18 00:24:04 +01005550 TEST_EQUAL( current_capacity, requested_capacity );
Gilles Peskine96ee5c72018-07-12 17:24:54 +02005551 expected_capacity = requested_capacity;
5552
5553 /* Expansion phase. */
5554 for( i = 0; i < ARRAY_LENGTH( expected_outputs ); i++ )
5555 {
5556 /* Read some bytes. */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005557 status = psa_key_derivation_output_bytes( &operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005558 output_buffer, output_sizes[i] );
Gilles Peskine96ee5c72018-07-12 17:24:54 +02005559 if( expected_capacity == 0 && output_sizes[i] == 0 )
5560 {
5561 /* Reading 0 bytes when 0 bytes are available can go either way. */
5562 TEST_ASSERT( status == PSA_SUCCESS ||
David Saadab4ecc272019-02-14 13:48:10 +02005563 status == PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskine96ee5c72018-07-12 17:24:54 +02005564 continue;
5565 }
5566 else if( expected_capacity == 0 ||
5567 output_sizes[i] > expected_capacity )
5568 {
5569 /* Capacity exceeded. */
David Saadab4ecc272019-02-14 13:48:10 +02005570 TEST_EQUAL( status, PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskine96ee5c72018-07-12 17:24:54 +02005571 expected_capacity = 0;
5572 continue;
5573 }
5574 /* Success. Check the read data. */
Gilles Peskine8817f612018-12-18 00:18:46 +01005575 PSA_ASSERT( status );
Gilles Peskine96ee5c72018-07-12 17:24:54 +02005576 if( output_sizes[i] != 0 )
Gilles Peskine0dfba2d2018-12-18 00:40:50 +01005577 ASSERT_COMPARE( output_buffer, output_sizes[i],
5578 expected_outputs[i], output_sizes[i] );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005579 /* Check the operation status. */
Gilles Peskine96ee5c72018-07-12 17:24:54 +02005580 expected_capacity -= output_sizes[i];
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005581 PSA_ASSERT( psa_key_derivation_get_capacity( &operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005582 &current_capacity ) );
Gilles Peskinefe11b722018-12-18 00:24:04 +01005583 TEST_EQUAL( expected_capacity, current_capacity );
Gilles Peskine96ee5c72018-07-12 17:24:54 +02005584 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005585 PSA_ASSERT( psa_key_derivation_abort( &operation ) );
Gilles Peskine96ee5c72018-07-12 17:24:54 +02005586
5587exit:
5588 mbedtls_free( output_buffer );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005589 psa_key_derivation_abort( &operation );
Ronald Cron5425a212020-08-04 14:58:35 +02005590 for( i = 0; i < ARRAY_LENGTH( keys ); i++ )
5591 psa_destroy_key( keys[i] );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02005592 PSA_DONE( );
Gilles Peskine96ee5c72018-07-12 17:24:54 +02005593}
5594/* END_CASE */
5595
5596/* BEGIN_CASE */
Gilles Peskined54931c2018-07-17 21:06:59 +02005597void derive_full( int alg_arg,
5598 data_t *key_data,
Janos Follath47f27ed2019-06-25 13:24:52 +01005599 data_t *input1,
5600 data_t *input2,
Gilles Peskined54931c2018-07-17 21:06:59 +02005601 int requested_capacity_arg )
5602{
Ronald Cron5425a212020-08-04 14:58:35 +02005603 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined54931c2018-07-17 21:06:59 +02005604 psa_algorithm_t alg = alg_arg;
5605 size_t requested_capacity = requested_capacity_arg;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005606 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Gilles Peskined54931c2018-07-17 21:06:59 +02005607 unsigned char output_buffer[16];
5608 size_t expected_capacity = requested_capacity;
5609 size_t current_capacity;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005610 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskined54931c2018-07-17 21:06:59 +02005611
Gilles Peskine8817f612018-12-18 00:18:46 +01005612 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskined54931c2018-07-17 21:06:59 +02005613
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005614 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DERIVE );
5615 psa_set_key_algorithm( &attributes, alg );
5616 psa_set_key_type( &attributes, PSA_KEY_TYPE_DERIVE );
Gilles Peskined54931c2018-07-17 21:06:59 +02005617
Gilles Peskine049c7532019-05-15 20:22:09 +02005618 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02005619 &key ) );
Gilles Peskined54931c2018-07-17 21:06:59 +02005620
Gilles Peskinec18e25f2021-02-12 23:48:20 +01005621 if( !mbedtls_test_psa_setup_key_derivation_wrap( &operation, key, alg,
5622 input1->x, input1->len,
5623 input2->x, input2->len,
5624 requested_capacity ) )
Janos Follathf2815ea2019-07-03 12:41:36 +01005625 goto exit;
Janos Follath47f27ed2019-06-25 13:24:52 +01005626
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005627 PSA_ASSERT( psa_key_derivation_get_capacity( &operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005628 &current_capacity ) );
Gilles Peskinefe11b722018-12-18 00:24:04 +01005629 TEST_EQUAL( current_capacity, expected_capacity );
Gilles Peskined54931c2018-07-17 21:06:59 +02005630
5631 /* Expansion phase. */
5632 while( current_capacity > 0 )
5633 {
5634 size_t read_size = sizeof( output_buffer );
5635 if( read_size > current_capacity )
5636 read_size = current_capacity;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005637 PSA_ASSERT( psa_key_derivation_output_bytes( &operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005638 output_buffer,
5639 read_size ) );
Gilles Peskined54931c2018-07-17 21:06:59 +02005640 expected_capacity -= read_size;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005641 PSA_ASSERT( psa_key_derivation_get_capacity( &operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005642 &current_capacity ) );
Gilles Peskinefe11b722018-12-18 00:24:04 +01005643 TEST_EQUAL( current_capacity, expected_capacity );
Gilles Peskined54931c2018-07-17 21:06:59 +02005644 }
5645
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005646 /* Check that the operation refuses to go over capacity. */
5647 TEST_EQUAL( psa_key_derivation_output_bytes( &operation, output_buffer, 1 ),
David Saadab4ecc272019-02-14 13:48:10 +02005648 PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskined54931c2018-07-17 21:06:59 +02005649
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005650 PSA_ASSERT( psa_key_derivation_abort( &operation ) );
Gilles Peskined54931c2018-07-17 21:06:59 +02005651
5652exit:
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005653 psa_key_derivation_abort( &operation );
Ronald Cron5425a212020-08-04 14:58:35 +02005654 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02005655 PSA_DONE( );
Gilles Peskined54931c2018-07-17 21:06:59 +02005656}
5657/* END_CASE */
5658
Janos Follathe60c9052019-07-03 13:51:30 +01005659/* BEGIN_CASE */
Gilles Peskine0386fba2018-07-12 17:29:22 +02005660void derive_key_exercise( int alg_arg,
5661 data_t *key_data,
Janos Follathe60c9052019-07-03 13:51:30 +01005662 data_t *input1,
5663 data_t *input2,
Gilles Peskine0386fba2018-07-12 17:29:22 +02005664 int derived_type_arg,
5665 int derived_bits_arg,
5666 int derived_usage_arg,
5667 int derived_alg_arg )
5668{
Ronald Cron5425a212020-08-04 14:58:35 +02005669 mbedtls_svc_key_id_t base_key = MBEDTLS_SVC_KEY_ID_INIT;
5670 mbedtls_svc_key_id_t derived_key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine0386fba2018-07-12 17:29:22 +02005671 psa_algorithm_t alg = alg_arg;
5672 psa_key_type_t derived_type = derived_type_arg;
5673 size_t derived_bits = derived_bits_arg;
5674 psa_key_usage_t derived_usage = derived_usage_arg;
5675 psa_algorithm_t derived_alg = derived_alg_arg;
5676 size_t capacity = PSA_BITS_TO_BYTES( derived_bits );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005677 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005678 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02005679 psa_key_attributes_t got_attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine0386fba2018-07-12 17:29:22 +02005680
Gilles Peskine8817f612018-12-18 00:18:46 +01005681 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine0386fba2018-07-12 17:29:22 +02005682
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005683 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DERIVE );
5684 psa_set_key_algorithm( &attributes, alg );
5685 psa_set_key_type( &attributes, PSA_KEY_TYPE_DERIVE );
Gilles Peskine049c7532019-05-15 20:22:09 +02005686 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02005687 &base_key ) );
Gilles Peskine0386fba2018-07-12 17:29:22 +02005688
5689 /* Derive a key. */
Gilles Peskinec18e25f2021-02-12 23:48:20 +01005690 if ( mbedtls_test_psa_setup_key_derivation_wrap( &operation, base_key, alg,
5691 input1->x, input1->len,
5692 input2->x, input2->len,
5693 capacity ) )
Janos Follathe60c9052019-07-03 13:51:30 +01005694 goto exit;
5695
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005696 psa_set_key_usage_flags( &attributes, derived_usage );
5697 psa_set_key_algorithm( &attributes, derived_alg );
5698 psa_set_key_type( &attributes, derived_type );
Gilles Peskine3a4f1f82019-04-26 13:49:28 +02005699 psa_set_key_bits( &attributes, derived_bits );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005700 PSA_ASSERT( psa_key_derivation_output_key( &attributes, &operation,
Ronald Cron5425a212020-08-04 14:58:35 +02005701 &derived_key ) );
Gilles Peskine0386fba2018-07-12 17:29:22 +02005702
5703 /* Test the key information */
Ronald Cron5425a212020-08-04 14:58:35 +02005704 PSA_ASSERT( psa_get_key_attributes( derived_key, &got_attributes ) );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02005705 TEST_EQUAL( psa_get_key_type( &got_attributes ), derived_type );
5706 TEST_EQUAL( psa_get_key_bits( &got_attributes ), derived_bits );
Gilles Peskine0386fba2018-07-12 17:29:22 +02005707
5708 /* Exercise the derived key. */
Gilles Peskinec18e25f2021-02-12 23:48:20 +01005709 if( ! mbedtls_test_psa_exercise_key( derived_key, derived_usage, derived_alg ) )
Gilles Peskine0386fba2018-07-12 17:29:22 +02005710 goto exit;
5711
5712exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +01005713 /*
5714 * Key attributes may have been returned by psa_get_key_attributes()
5715 * thus reset them as required.
5716 */
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02005717 psa_reset_key_attributes( &got_attributes );
Ronald Cron3a4f0e32020-11-19 17:55:23 +01005718
5719 psa_key_derivation_abort( &operation );
Ronald Cron5425a212020-08-04 14:58:35 +02005720 psa_destroy_key( base_key );
5721 psa_destroy_key( derived_key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02005722 PSA_DONE( );
Gilles Peskine0386fba2018-07-12 17:29:22 +02005723}
5724/* END_CASE */
5725
Janos Follath42fd8882019-07-03 14:17:09 +01005726/* BEGIN_CASE */
Gilles Peskine0386fba2018-07-12 17:29:22 +02005727void derive_key_export( int alg_arg,
5728 data_t *key_data,
Janos Follath42fd8882019-07-03 14:17:09 +01005729 data_t *input1,
5730 data_t *input2,
Gilles Peskine0386fba2018-07-12 17:29:22 +02005731 int bytes1_arg,
5732 int bytes2_arg )
5733{
Ronald Cron5425a212020-08-04 14:58:35 +02005734 mbedtls_svc_key_id_t base_key = MBEDTLS_SVC_KEY_ID_INIT;
5735 mbedtls_svc_key_id_t derived_key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine0386fba2018-07-12 17:29:22 +02005736 psa_algorithm_t alg = alg_arg;
5737 size_t bytes1 = bytes1_arg;
5738 size_t bytes2 = bytes2_arg;
5739 size_t capacity = bytes1 + bytes2;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005740 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Gilles Peskine8cebbba2018-09-27 13:54:18 +02005741 uint8_t *output_buffer = NULL;
5742 uint8_t *export_buffer = NULL;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005743 psa_key_attributes_t base_attributes = PSA_KEY_ATTRIBUTES_INIT;
5744 psa_key_attributes_t derived_attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine0386fba2018-07-12 17:29:22 +02005745 size_t length;
5746
Gilles Peskine8cebbba2018-09-27 13:54:18 +02005747 ASSERT_ALLOC( output_buffer, capacity );
5748 ASSERT_ALLOC( export_buffer, capacity );
Gilles Peskine8817f612018-12-18 00:18:46 +01005749 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine0386fba2018-07-12 17:29:22 +02005750
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005751 psa_set_key_usage_flags( &base_attributes, PSA_KEY_USAGE_DERIVE );
5752 psa_set_key_algorithm( &base_attributes, alg );
5753 psa_set_key_type( &base_attributes, PSA_KEY_TYPE_DERIVE );
Gilles Peskine049c7532019-05-15 20:22:09 +02005754 PSA_ASSERT( psa_import_key( &base_attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02005755 &base_key ) );
Gilles Peskine0386fba2018-07-12 17:29:22 +02005756
5757 /* Derive some material and output it. */
Gilles Peskinec18e25f2021-02-12 23:48:20 +01005758 if( !mbedtls_test_psa_setup_key_derivation_wrap( &operation, base_key, alg,
5759 input1->x, input1->len,
5760 input2->x, input2->len,
5761 capacity ) )
Janos Follath42fd8882019-07-03 14:17:09 +01005762 goto exit;
5763
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005764 PSA_ASSERT( psa_key_derivation_output_bytes( &operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005765 output_buffer,
5766 capacity ) );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005767 PSA_ASSERT( psa_key_derivation_abort( &operation ) );
Gilles Peskine0386fba2018-07-12 17:29:22 +02005768
5769 /* Derive the same output again, but this time store it in key objects. */
Gilles Peskinec18e25f2021-02-12 23:48:20 +01005770 if( !mbedtls_test_psa_setup_key_derivation_wrap( &operation, base_key, alg,
5771 input1->x, input1->len,
5772 input2->x, input2->len,
5773 capacity ) )
Janos Follath42fd8882019-07-03 14:17:09 +01005774 goto exit;
5775
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005776 psa_set_key_usage_flags( &derived_attributes, PSA_KEY_USAGE_EXPORT );
5777 psa_set_key_algorithm( &derived_attributes, 0 );
5778 psa_set_key_type( &derived_attributes, PSA_KEY_TYPE_RAW_DATA );
Gilles Peskine3a4f1f82019-04-26 13:49:28 +02005779 psa_set_key_bits( &derived_attributes, PSA_BYTES_TO_BITS( bytes1 ) );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005780 PSA_ASSERT( psa_key_derivation_output_key( &derived_attributes, &operation,
Ronald Cron5425a212020-08-04 14:58:35 +02005781 &derived_key ) );
5782 PSA_ASSERT( psa_export_key( derived_key,
Gilles Peskine8817f612018-12-18 00:18:46 +01005783 export_buffer, bytes1,
5784 &length ) );
Gilles Peskinefe11b722018-12-18 00:24:04 +01005785 TEST_EQUAL( length, bytes1 );
Ronald Cron5425a212020-08-04 14:58:35 +02005786 PSA_ASSERT( psa_destroy_key( derived_key ) );
Gilles Peskine3a4f1f82019-04-26 13:49:28 +02005787 psa_set_key_bits( &derived_attributes, PSA_BYTES_TO_BITS( bytes2 ) );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005788 PSA_ASSERT( psa_key_derivation_output_key( &derived_attributes, &operation,
Ronald Cron5425a212020-08-04 14:58:35 +02005789 &derived_key ) );
5790 PSA_ASSERT( psa_export_key( derived_key,
Gilles Peskine8817f612018-12-18 00:18:46 +01005791 export_buffer + bytes1, bytes2,
5792 &length ) );
Gilles Peskinefe11b722018-12-18 00:24:04 +01005793 TEST_EQUAL( length, bytes2 );
Gilles Peskine0386fba2018-07-12 17:29:22 +02005794
5795 /* Compare the outputs from the two runs. */
Gilles Peskine0dfba2d2018-12-18 00:40:50 +01005796 ASSERT_COMPARE( output_buffer, bytes1 + bytes2,
5797 export_buffer, capacity );
Gilles Peskine0386fba2018-07-12 17:29:22 +02005798
5799exit:
5800 mbedtls_free( output_buffer );
5801 mbedtls_free( export_buffer );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005802 psa_key_derivation_abort( &operation );
Ronald Cron5425a212020-08-04 14:58:35 +02005803 psa_destroy_key( base_key );
5804 psa_destroy_key( derived_key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02005805 PSA_DONE( );
Gilles Peskine0386fba2018-07-12 17:29:22 +02005806}
5807/* END_CASE */
5808
5809/* BEGIN_CASE */
Gilles Peskine7c227ae2019-07-31 15:14:44 +02005810void derive_key( int alg_arg,
5811 data_t *key_data, data_t *input1, data_t *input2,
5812 int type_arg, int bits_arg,
Steven Cooreman83fdb702021-01-21 14:24:39 +01005813 int expected_status_arg,
5814 int is_large_output )
Gilles Peskinec744d992019-07-30 17:26:54 +02005815{
Ronald Cron5425a212020-08-04 14:58:35 +02005816 mbedtls_svc_key_id_t base_key = MBEDTLS_SVC_KEY_ID_INIT;
5817 mbedtls_svc_key_id_t derived_key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskinec744d992019-07-30 17:26:54 +02005818 psa_algorithm_t alg = alg_arg;
Gilles Peskine7c227ae2019-07-31 15:14:44 +02005819 psa_key_type_t type = type_arg;
Gilles Peskinec744d992019-07-30 17:26:54 +02005820 size_t bits = bits_arg;
5821 psa_status_t expected_status = expected_status_arg;
5822 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
5823 psa_key_attributes_t base_attributes = PSA_KEY_ATTRIBUTES_INIT;
5824 psa_key_attributes_t derived_attributes = PSA_KEY_ATTRIBUTES_INIT;
5825
5826 PSA_ASSERT( psa_crypto_init( ) );
5827
5828 psa_set_key_usage_flags( &base_attributes, PSA_KEY_USAGE_DERIVE );
5829 psa_set_key_algorithm( &base_attributes, alg );
5830 psa_set_key_type( &base_attributes, PSA_KEY_TYPE_DERIVE );
5831 PSA_ASSERT( psa_import_key( &base_attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02005832 &base_key ) );
Gilles Peskinec744d992019-07-30 17:26:54 +02005833
Gilles Peskinec18e25f2021-02-12 23:48:20 +01005834 if( !mbedtls_test_psa_setup_key_derivation_wrap( &operation, base_key, alg,
5835 input1->x, input1->len,
5836 input2->x, input2->len,
5837 SIZE_MAX ) )
Gilles Peskinec744d992019-07-30 17:26:54 +02005838 goto exit;
5839
5840 psa_set_key_usage_flags( &derived_attributes, PSA_KEY_USAGE_EXPORT );
5841 psa_set_key_algorithm( &derived_attributes, 0 );
Gilles Peskine7c227ae2019-07-31 15:14:44 +02005842 psa_set_key_type( &derived_attributes, type );
Gilles Peskinec744d992019-07-30 17:26:54 +02005843 psa_set_key_bits( &derived_attributes, bits );
Steven Cooreman83fdb702021-01-21 14:24:39 +01005844
5845 psa_status_t status =
5846 psa_key_derivation_output_key( &derived_attributes,
5847 &operation,
5848 &derived_key );
5849 if( is_large_output > 0 )
5850 TEST_ASSUME( status != PSA_ERROR_INSUFFICIENT_MEMORY );
5851 TEST_EQUAL( status, expected_status );
Gilles Peskinec744d992019-07-30 17:26:54 +02005852
5853exit:
5854 psa_key_derivation_abort( &operation );
Ronald Cron5425a212020-08-04 14:58:35 +02005855 psa_destroy_key( base_key );
5856 psa_destroy_key( derived_key );
Gilles Peskinec744d992019-07-30 17:26:54 +02005857 PSA_DONE( );
5858}
5859/* END_CASE */
5860
5861/* BEGIN_CASE */
Gilles Peskine01d718c2018-09-18 12:01:02 +02005862void key_agreement_setup( int alg_arg,
Steven Cooremance48e852020-10-05 16:02:45 +02005863 int our_key_type_arg, int our_key_alg_arg,
5864 data_t *our_key_data, data_t *peer_key_data,
Gilles Peskine01d718c2018-09-18 12:01:02 +02005865 int expected_status_arg )
5866{
Ronald Cron5425a212020-08-04 14:58:35 +02005867 mbedtls_svc_key_id_t our_key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine01d718c2018-09-18 12:01:02 +02005868 psa_algorithm_t alg = alg_arg;
Steven Cooremanfa5e6312020-10-15 17:07:12 +02005869 psa_algorithm_t our_key_alg = our_key_alg_arg;
Gilles Peskine01d718c2018-09-18 12:01:02 +02005870 psa_key_type_t our_key_type = our_key_type_arg;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005871 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005872 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine77f40d82019-04-11 21:27:06 +02005873 psa_status_t expected_status = expected_status_arg;
5874 psa_status_t status;
Gilles Peskine01d718c2018-09-18 12:01:02 +02005875
Gilles Peskine8817f612018-12-18 00:18:46 +01005876 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005877
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005878 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DERIVE );
Steven Cooremanfa5e6312020-10-15 17:07:12 +02005879 psa_set_key_algorithm( &attributes, our_key_alg );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005880 psa_set_key_type( &attributes, our_key_type );
Gilles Peskine049c7532019-05-15 20:22:09 +02005881 PSA_ASSERT( psa_import_key( &attributes,
5882 our_key_data->x, our_key_data->len,
5883 &our_key ) );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005884
Gilles Peskine77f40d82019-04-11 21:27:06 +02005885 /* The tests currently include inputs that should fail at either step.
5886 * Test cases that fail at the setup step should be changed to call
5887 * key_derivation_setup instead, and this function should be renamed
5888 * to key_agreement_fail. */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005889 status = psa_key_derivation_setup( &operation, alg );
Gilles Peskine77f40d82019-04-11 21:27:06 +02005890 if( status == PSA_SUCCESS )
5891 {
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005892 TEST_EQUAL( psa_key_derivation_key_agreement(
5893 &operation, PSA_KEY_DERIVATION_INPUT_SECRET,
5894 our_key,
5895 peer_key_data->x, peer_key_data->len ),
Gilles Peskine77f40d82019-04-11 21:27:06 +02005896 expected_status );
5897 }
5898 else
5899 {
5900 TEST_ASSERT( status == expected_status );
5901 }
Gilles Peskine01d718c2018-09-18 12:01:02 +02005902
5903exit:
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005904 psa_key_derivation_abort( &operation );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005905 psa_destroy_key( our_key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02005906 PSA_DONE( );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005907}
5908/* END_CASE */
5909
5910/* BEGIN_CASE */
Gilles Peskinef0cba732019-04-11 22:12:38 +02005911void raw_key_agreement( int alg_arg,
5912 int our_key_type_arg, data_t *our_key_data,
5913 data_t *peer_key_data,
5914 data_t *expected_output )
5915{
Ronald Cron5425a212020-08-04 14:58:35 +02005916 mbedtls_svc_key_id_t our_key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskinef0cba732019-04-11 22:12:38 +02005917 psa_algorithm_t alg = alg_arg;
5918 psa_key_type_t our_key_type = our_key_type_arg;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005919 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskinef0cba732019-04-11 22:12:38 +02005920 unsigned char *output = NULL;
5921 size_t output_length = ~0;
gabor-mezei-armceface22021-01-21 12:26:17 +01005922 size_t key_bits;
Gilles Peskinef0cba732019-04-11 22:12:38 +02005923
5924 ASSERT_ALLOC( output, expected_output->len );
5925 PSA_ASSERT( psa_crypto_init( ) );
5926
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005927 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DERIVE );
5928 psa_set_key_algorithm( &attributes, alg );
5929 psa_set_key_type( &attributes, our_key_type );
Gilles Peskine049c7532019-05-15 20:22:09 +02005930 PSA_ASSERT( psa_import_key( &attributes,
5931 our_key_data->x, our_key_data->len,
5932 &our_key ) );
Gilles Peskinef0cba732019-04-11 22:12:38 +02005933
gabor-mezei-armceface22021-01-21 12:26:17 +01005934 PSA_ASSERT( psa_get_key_attributes( our_key, &attributes ) );
5935 key_bits = psa_get_key_bits( &attributes );
5936
Gilles Peskinebe697d82019-05-16 18:00:41 +02005937 PSA_ASSERT( psa_raw_key_agreement( alg, our_key,
5938 peer_key_data->x, peer_key_data->len,
5939 output, expected_output->len,
5940 &output_length ) );
Gilles Peskinef0cba732019-04-11 22:12:38 +02005941 ASSERT_COMPARE( output, output_length,
5942 expected_output->x, expected_output->len );
gabor-mezei-armceface22021-01-21 12:26:17 +01005943 TEST_ASSERT( output_length <=
5944 PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE( our_key_type, key_bits ) );
5945 TEST_ASSERT( output_length <=
5946 PSA_RAW_KEY_AGREEMENT_OUTPUT_MAX_SIZE );
Gilles Peskinef0cba732019-04-11 22:12:38 +02005947
5948exit:
5949 mbedtls_free( output );
5950 psa_destroy_key( our_key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02005951 PSA_DONE( );
Gilles Peskinef0cba732019-04-11 22:12:38 +02005952}
5953/* END_CASE */
5954
5955/* BEGIN_CASE */
Gilles Peskine59685592018-09-18 12:11:34 +02005956void key_agreement_capacity( int alg_arg,
5957 int our_key_type_arg, data_t *our_key_data,
5958 data_t *peer_key_data,
5959 int expected_capacity_arg )
5960{
Ronald Cron5425a212020-08-04 14:58:35 +02005961 mbedtls_svc_key_id_t our_key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine59685592018-09-18 12:11:34 +02005962 psa_algorithm_t alg = alg_arg;
5963 psa_key_type_t our_key_type = our_key_type_arg;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005964 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005965 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine59685592018-09-18 12:11:34 +02005966 size_t actual_capacity;
Gilles Peskinebf491972018-10-25 22:36:12 +02005967 unsigned char output[16];
Gilles Peskine59685592018-09-18 12:11:34 +02005968
Gilles Peskine8817f612018-12-18 00:18:46 +01005969 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine59685592018-09-18 12:11:34 +02005970
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005971 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DERIVE );
5972 psa_set_key_algorithm( &attributes, alg );
5973 psa_set_key_type( &attributes, our_key_type );
Gilles Peskine049c7532019-05-15 20:22:09 +02005974 PSA_ASSERT( psa_import_key( &attributes,
5975 our_key_data->x, our_key_data->len,
5976 &our_key ) );
Gilles Peskine59685592018-09-18 12:11:34 +02005977
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005978 PSA_ASSERT( psa_key_derivation_setup( &operation, alg ) );
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005979 PSA_ASSERT( psa_key_derivation_key_agreement(
5980 &operation,
5981 PSA_KEY_DERIVATION_INPUT_SECRET, our_key,
5982 peer_key_data->x, peer_key_data->len ) );
Gilles Peskinef8a9d942019-04-11 22:13:20 +02005983 if( PSA_ALG_IS_HKDF( PSA_ALG_KEY_AGREEMENT_GET_KDF( alg ) ) )
5984 {
5985 /* The test data is for info="" */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005986 PSA_ASSERT( psa_key_derivation_input_bytes( &operation,
Gilles Peskine03410b52019-05-16 16:05:19 +02005987 PSA_KEY_DERIVATION_INPUT_INFO,
Gilles Peskinef8a9d942019-04-11 22:13:20 +02005988 NULL, 0 ) );
5989 }
Gilles Peskine59685592018-09-18 12:11:34 +02005990
Gilles Peskinebf491972018-10-25 22:36:12 +02005991 /* Test the advertized capacity. */
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005992 PSA_ASSERT( psa_key_derivation_get_capacity(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005993 &operation, &actual_capacity ) );
Gilles Peskinefe11b722018-12-18 00:24:04 +01005994 TEST_EQUAL( actual_capacity, (size_t) expected_capacity_arg );
Gilles Peskine59685592018-09-18 12:11:34 +02005995
Gilles Peskinebf491972018-10-25 22:36:12 +02005996 /* Test the actual capacity by reading the output. */
5997 while( actual_capacity > sizeof( output ) )
5998 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005999 PSA_ASSERT( psa_key_derivation_output_bytes( &operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02006000 output, sizeof( output ) ) );
Gilles Peskinebf491972018-10-25 22:36:12 +02006001 actual_capacity -= sizeof( output );
6002 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006003 PSA_ASSERT( psa_key_derivation_output_bytes( &operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02006004 output, actual_capacity ) );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006005 TEST_EQUAL( psa_key_derivation_output_bytes( &operation, output, 1 ),
David Saadab4ecc272019-02-14 13:48:10 +02006006 PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskinebf491972018-10-25 22:36:12 +02006007
Gilles Peskine59685592018-09-18 12:11:34 +02006008exit:
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006009 psa_key_derivation_abort( &operation );
Gilles Peskine59685592018-09-18 12:11:34 +02006010 psa_destroy_key( our_key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02006011 PSA_DONE( );
Gilles Peskine59685592018-09-18 12:11:34 +02006012}
6013/* END_CASE */
6014
6015/* BEGIN_CASE */
6016void key_agreement_output( int alg_arg,
6017 int our_key_type_arg, data_t *our_key_data,
6018 data_t *peer_key_data,
Gilles Peskine3ec8ed82018-10-25 22:37:15 +02006019 data_t *expected_output1, data_t *expected_output2 )
Gilles Peskine59685592018-09-18 12:11:34 +02006020{
Ronald Cron5425a212020-08-04 14:58:35 +02006021 mbedtls_svc_key_id_t our_key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine59685592018-09-18 12:11:34 +02006022 psa_algorithm_t alg = alg_arg;
6023 psa_key_type_t our_key_type = our_key_type_arg;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006024 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006025 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine3ec8ed82018-10-25 22:37:15 +02006026 uint8_t *actual_output = NULL;
Gilles Peskine59685592018-09-18 12:11:34 +02006027
Gilles Peskine3ec8ed82018-10-25 22:37:15 +02006028 ASSERT_ALLOC( actual_output, MAX( expected_output1->len,
6029 expected_output2->len ) );
Gilles Peskine59685592018-09-18 12:11:34 +02006030
Gilles Peskine8817f612018-12-18 00:18:46 +01006031 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine59685592018-09-18 12:11:34 +02006032
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006033 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DERIVE );
6034 psa_set_key_algorithm( &attributes, alg );
6035 psa_set_key_type( &attributes, our_key_type );
Gilles Peskine049c7532019-05-15 20:22:09 +02006036 PSA_ASSERT( psa_import_key( &attributes,
6037 our_key_data->x, our_key_data->len,
6038 &our_key ) );
Gilles Peskine59685592018-09-18 12:11:34 +02006039
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006040 PSA_ASSERT( psa_key_derivation_setup( &operation, alg ) );
Gilles Peskinecf7292e2019-05-16 17:53:40 +02006041 PSA_ASSERT( psa_key_derivation_key_agreement(
6042 &operation,
6043 PSA_KEY_DERIVATION_INPUT_SECRET, our_key,
6044 peer_key_data->x, peer_key_data->len ) );
Gilles Peskinef8a9d942019-04-11 22:13:20 +02006045 if( PSA_ALG_IS_HKDF( PSA_ALG_KEY_AGREEMENT_GET_KDF( alg ) ) )
6046 {
6047 /* The test data is for info="" */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006048 PSA_ASSERT( psa_key_derivation_input_bytes( &operation,
Gilles Peskine03410b52019-05-16 16:05:19 +02006049 PSA_KEY_DERIVATION_INPUT_INFO,
Gilles Peskinef8a9d942019-04-11 22:13:20 +02006050 NULL, 0 ) );
6051 }
Gilles Peskine59685592018-09-18 12:11:34 +02006052
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006053 PSA_ASSERT( psa_key_derivation_output_bytes( &operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02006054 actual_output,
6055 expected_output1->len ) );
Gilles Peskine0dfba2d2018-12-18 00:40:50 +01006056 ASSERT_COMPARE( actual_output, expected_output1->len,
6057 expected_output1->x, expected_output1->len );
Gilles Peskine3ec8ed82018-10-25 22:37:15 +02006058 if( expected_output2->len != 0 )
6059 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006060 PSA_ASSERT( psa_key_derivation_output_bytes( &operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02006061 actual_output,
6062 expected_output2->len ) );
Gilles Peskine0dfba2d2018-12-18 00:40:50 +01006063 ASSERT_COMPARE( actual_output, expected_output2->len,
6064 expected_output2->x, expected_output2->len );
Gilles Peskine3ec8ed82018-10-25 22:37:15 +02006065 }
Gilles Peskine59685592018-09-18 12:11:34 +02006066
6067exit:
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006068 psa_key_derivation_abort( &operation );
Gilles Peskine59685592018-09-18 12:11:34 +02006069 psa_destroy_key( our_key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02006070 PSA_DONE( );
Gilles Peskine59685592018-09-18 12:11:34 +02006071 mbedtls_free( actual_output );
6072}
6073/* END_CASE */
6074
6075/* BEGIN_CASE */
Gilles Peskinea50d7392018-06-21 10:22:13 +02006076void generate_random( int bytes_arg )
Gilles Peskine05d69892018-06-19 22:00:52 +02006077{
Gilles Peskinea50d7392018-06-21 10:22:13 +02006078 size_t bytes = bytes_arg;
Gilles Peskine8cebbba2018-09-27 13:54:18 +02006079 unsigned char *output = NULL;
6080 unsigned char *changed = NULL;
Gilles Peskinea50d7392018-06-21 10:22:13 +02006081 size_t i;
6082 unsigned run;
Gilles Peskine05d69892018-06-19 22:00:52 +02006083
Simon Butcher49f8e312020-03-03 15:51:50 +00006084 TEST_ASSERT( bytes_arg >= 0 );
6085
Gilles Peskine91892022021-02-08 19:50:26 +01006086 ASSERT_ALLOC( output, bytes );
Gilles Peskine8cebbba2018-09-27 13:54:18 +02006087 ASSERT_ALLOC( changed, bytes );
Gilles Peskine05d69892018-06-19 22:00:52 +02006088
Gilles Peskine8817f612018-12-18 00:18:46 +01006089 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine05d69892018-06-19 22:00:52 +02006090
Gilles Peskinea50d7392018-06-21 10:22:13 +02006091 /* Run several times, to ensure that every output byte will be
6092 * nonzero at least once with overwhelming probability
6093 * (2^(-8*number_of_runs)). */
6094 for( run = 0; run < 10; run++ )
Gilles Peskine05d69892018-06-19 22:00:52 +02006095 {
Gilles Peskinef7ab5ad2018-09-26 18:19:24 +02006096 if( bytes != 0 )
6097 memset( output, 0, bytes );
Gilles Peskine8817f612018-12-18 00:18:46 +01006098 PSA_ASSERT( psa_generate_random( output, bytes ) );
Gilles Peskinea50d7392018-06-21 10:22:13 +02006099
Gilles Peskinea50d7392018-06-21 10:22:13 +02006100 for( i = 0; i < bytes; i++ )
6101 {
6102 if( output[i] != 0 )
6103 ++changed[i];
6104 }
Gilles Peskine05d69892018-06-19 22:00:52 +02006105 }
Gilles Peskinea50d7392018-06-21 10:22:13 +02006106
6107 /* Check that every byte was changed to nonzero at least once. This
6108 * validates that psa_generate_random is overwriting every byte of
6109 * the output buffer. */
6110 for( i = 0; i < bytes; i++ )
6111 {
6112 TEST_ASSERT( changed[i] != 0 );
6113 }
Gilles Peskine05d69892018-06-19 22:00:52 +02006114
6115exit:
Gilles Peskine1153e7b2019-05-28 15:10:21 +02006116 PSA_DONE( );
Gilles Peskinea50d7392018-06-21 10:22:13 +02006117 mbedtls_free( output );
6118 mbedtls_free( changed );
Gilles Peskine05d69892018-06-19 22:00:52 +02006119}
6120/* END_CASE */
Gilles Peskine12313cd2018-06-20 00:20:32 +02006121
6122/* BEGIN_CASE */
6123void generate_key( int type_arg,
6124 int bits_arg,
6125 int usage_arg,
6126 int alg_arg,
Steven Cooreman83fdb702021-01-21 14:24:39 +01006127 int expected_status_arg,
6128 int is_large_key )
Gilles Peskine12313cd2018-06-20 00:20:32 +02006129{
Ronald Cron5425a212020-08-04 14:58:35 +02006130 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine12313cd2018-06-20 00:20:32 +02006131 psa_key_type_t type = type_arg;
6132 psa_key_usage_t usage = usage_arg;
6133 size_t bits = bits_arg;
6134 psa_algorithm_t alg = alg_arg;
6135 psa_status_t expected_status = expected_status_arg;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006136 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02006137 psa_key_attributes_t got_attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine12313cd2018-06-20 00:20:32 +02006138
Gilles Peskine8817f612018-12-18 00:18:46 +01006139 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine12313cd2018-06-20 00:20:32 +02006140
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006141 psa_set_key_usage_flags( &attributes, usage );
6142 psa_set_key_algorithm( &attributes, alg );
6143 psa_set_key_type( &attributes, type );
Gilles Peskine3a4f1f82019-04-26 13:49:28 +02006144 psa_set_key_bits( &attributes, bits );
Gilles Peskine12313cd2018-06-20 00:20:32 +02006145
6146 /* Generate a key */
Steven Cooreman83fdb702021-01-21 14:24:39 +01006147 psa_status_t status = psa_generate_key( &attributes, &key );
6148
6149 if( is_large_key > 0 )
6150 TEST_ASSUME( status != PSA_ERROR_INSUFFICIENT_MEMORY );
6151 TEST_EQUAL( status , expected_status );
Gilles Peskinee56e8782019-04-26 17:34:02 +02006152 if( expected_status != PSA_SUCCESS )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006153 goto exit;
Gilles Peskine12313cd2018-06-20 00:20:32 +02006154
6155 /* Test the key information */
Ronald Cron5425a212020-08-04 14:58:35 +02006156 PSA_ASSERT( psa_get_key_attributes( key, &got_attributes ) );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02006157 TEST_EQUAL( psa_get_key_type( &got_attributes ), type );
6158 TEST_EQUAL( psa_get_key_bits( &got_attributes ), bits );
Gilles Peskine12313cd2018-06-20 00:20:32 +02006159
Gilles Peskine818ca122018-06-20 18:16:48 +02006160 /* Do something with the key according to its type and permitted usage. */
Gilles Peskinec18e25f2021-02-12 23:48:20 +01006161 if( ! mbedtls_test_psa_exercise_key( key, usage, alg ) )
Gilles Peskine02b75072018-07-01 22:31:34 +02006162 goto exit;
Gilles Peskine12313cd2018-06-20 00:20:32 +02006163
6164exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +01006165 /*
6166 * Key attributes may have been returned by psa_get_key_attributes()
6167 * thus reset them as required.
6168 */
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02006169 psa_reset_key_attributes( &got_attributes );
Ronald Cron3a4f0e32020-11-19 17:55:23 +01006170
Ronald Cron5425a212020-08-04 14:58:35 +02006171 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02006172 PSA_DONE( );
Gilles Peskine12313cd2018-06-20 00:20:32 +02006173}
6174/* END_CASE */
itayzafrir0adf0fc2018-09-06 16:24:41 +03006175
Ronald Cronee414c72021-03-18 18:50:08 +01006176/* 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 +02006177void generate_key_rsa( int bits_arg,
6178 data_t *e_arg,
6179 int expected_status_arg )
6180{
Ronald Cron5425a212020-08-04 14:58:35 +02006181 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskinec93b80c2019-05-16 19:39:54 +02006182 psa_key_type_t type = PSA_KEY_TYPE_RSA_KEY_PAIR;
Gilles Peskinee56e8782019-04-26 17:34:02 +02006183 size_t bits = bits_arg;
6184 psa_key_usage_t usage = PSA_KEY_USAGE_ENCRYPT | PSA_KEY_USAGE_DECRYPT;
6185 psa_algorithm_t alg = PSA_ALG_RSA_PKCS1V15_SIGN_RAW;
6186 psa_status_t expected_status = expected_status_arg;
6187 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
6188 uint8_t *exported = NULL;
6189 size_t exported_size =
gabor-mezei-armcbcec212020-12-18 14:23:51 +01006190 PSA_EXPORT_KEY_OUTPUT_SIZE( PSA_KEY_TYPE_RSA_PUBLIC_KEY, bits );
Gilles Peskinee56e8782019-04-26 17:34:02 +02006191 size_t exported_length = SIZE_MAX;
6192 uint8_t *e_read_buffer = NULL;
6193 int is_default_public_exponent = 0;
Gilles Peskineaa02c172019-04-28 11:44:17 +02006194 size_t e_read_size = PSA_KEY_DOMAIN_PARAMETERS_SIZE( type, bits );
Gilles Peskinee56e8782019-04-26 17:34:02 +02006195 size_t e_read_length = SIZE_MAX;
6196
6197 if( e_arg->len == 0 ||
6198 ( e_arg->len == 3 &&
6199 e_arg->x[0] == 1 && e_arg->x[1] == 0 && e_arg->x[2] == 1 ) )
6200 {
6201 is_default_public_exponent = 1;
6202 e_read_size = 0;
6203 }
6204 ASSERT_ALLOC( e_read_buffer, e_read_size );
6205 ASSERT_ALLOC( exported, exported_size );
6206
6207 PSA_ASSERT( psa_crypto_init( ) );
6208
6209 psa_set_key_usage_flags( &attributes, usage );
6210 psa_set_key_algorithm( &attributes, alg );
6211 PSA_ASSERT( psa_set_key_domain_parameters( &attributes, type,
6212 e_arg->x, e_arg->len ) );
6213 psa_set_key_bits( &attributes, bits );
6214
6215 /* Generate a key */
Ronald Cron5425a212020-08-04 14:58:35 +02006216 TEST_EQUAL( psa_generate_key( &attributes, &key ), expected_status );
Gilles Peskinee56e8782019-04-26 17:34:02 +02006217 if( expected_status != PSA_SUCCESS )
6218 goto exit;
6219
6220 /* Test the key information */
Ronald Cron5425a212020-08-04 14:58:35 +02006221 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
Gilles Peskinee56e8782019-04-26 17:34:02 +02006222 TEST_EQUAL( psa_get_key_type( &attributes ), type );
6223 TEST_EQUAL( psa_get_key_bits( &attributes ), bits );
6224 PSA_ASSERT( psa_get_key_domain_parameters( &attributes,
6225 e_read_buffer, e_read_size,
6226 &e_read_length ) );
6227 if( is_default_public_exponent )
6228 TEST_EQUAL( e_read_length, 0 );
6229 else
6230 ASSERT_COMPARE( e_read_buffer, e_read_length, e_arg->x, e_arg->len );
6231
6232 /* Do something with the key according to its type and permitted usage. */
Gilles Peskinec18e25f2021-02-12 23:48:20 +01006233 if( ! mbedtls_test_psa_exercise_key( key, usage, alg ) )
Gilles Peskinee56e8782019-04-26 17:34:02 +02006234 goto exit;
6235
6236 /* Export the key and check the public exponent. */
Ronald Cron5425a212020-08-04 14:58:35 +02006237 PSA_ASSERT( psa_export_public_key( key,
Gilles Peskinee56e8782019-04-26 17:34:02 +02006238 exported, exported_size,
6239 &exported_length ) );
6240 {
6241 uint8_t *p = exported;
6242 uint8_t *end = exported + exported_length;
6243 size_t len;
6244 /* RSAPublicKey ::= SEQUENCE {
6245 * modulus INTEGER, -- n
6246 * publicExponent INTEGER } -- e
6247 */
6248 TEST_EQUAL( 0, mbedtls_asn1_get_tag( &p, end, &len,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02006249 MBEDTLS_ASN1_SEQUENCE |
6250 MBEDTLS_ASN1_CONSTRUCTED ) );
Gilles Peskine8e94efe2021-02-13 00:25:53 +01006251 TEST_ASSERT( mbedtls_test_asn1_skip_integer( &p, end, bits, bits, 1 ) );
Gilles Peskinee56e8782019-04-26 17:34:02 +02006252 TEST_EQUAL( 0, mbedtls_asn1_get_tag( &p, end, &len,
6253 MBEDTLS_ASN1_INTEGER ) );
6254 if( len >= 1 && p[0] == 0 )
6255 {
6256 ++p;
6257 --len;
6258 }
6259 if( e_arg->len == 0 )
6260 {
6261 TEST_EQUAL( len, 3 );
6262 TEST_EQUAL( p[0], 1 );
6263 TEST_EQUAL( p[1], 0 );
6264 TEST_EQUAL( p[2], 1 );
6265 }
6266 else
6267 ASSERT_COMPARE( p, len, e_arg->x, e_arg->len );
6268 }
6269
6270exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +01006271 /*
6272 * Key attributes may have been returned by psa_get_key_attributes() or
6273 * set by psa_set_key_domain_parameters() thus reset them as required.
6274 */
Gilles Peskinee56e8782019-04-26 17:34:02 +02006275 psa_reset_key_attributes( &attributes );
Ronald Cron3a4f0e32020-11-19 17:55:23 +01006276
Ronald Cron5425a212020-08-04 14:58:35 +02006277 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02006278 PSA_DONE( );
Gilles Peskinee56e8782019-04-26 17:34:02 +02006279 mbedtls_free( e_read_buffer );
6280 mbedtls_free( exported );
6281}
6282/* END_CASE */
6283
Darryl Greend49a4992018-06-18 17:27:26 +01006284/* BEGIN_CASE depends_on:MBEDTLS_PSA_CRYPTO_STORAGE_C */
Gilles Peskine5c648ab2019-04-19 14:06:53 +02006285void persistent_key_load_key_from_storage( data_t *data,
6286 int type_arg, int bits_arg,
6287 int usage_flags_arg, int alg_arg,
6288 int generation_method )
Darryl Greend49a4992018-06-18 17:27:26 +01006289{
Ronald Cron71016a92020-08-28 19:01:50 +02006290 mbedtls_svc_key_id_t key_id = mbedtls_svc_key_id_make( 1, 1 );
Gilles Peskine5c648ab2019-04-19 14:06:53 +02006291 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Ronald Cron5425a212020-08-04 14:58:35 +02006292 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
6293 mbedtls_svc_key_id_t base_key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine5c648ab2019-04-19 14:06:53 +02006294 psa_key_type_t type = type_arg;
6295 size_t bits = bits_arg;
6296 psa_key_usage_t usage_flags = usage_flags_arg;
6297 psa_algorithm_t alg = alg_arg;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006298 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Darryl Greend49a4992018-06-18 17:27:26 +01006299 unsigned char *first_export = NULL;
6300 unsigned char *second_export = NULL;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01006301 size_t export_size = PSA_EXPORT_KEY_OUTPUT_SIZE( type, bits );
Darryl Greend49a4992018-06-18 17:27:26 +01006302 size_t first_exported_length;
6303 size_t second_exported_length;
6304
Gilles Peskine5c648ab2019-04-19 14:06:53 +02006305 if( usage_flags & PSA_KEY_USAGE_EXPORT )
6306 {
6307 ASSERT_ALLOC( first_export, export_size );
6308 ASSERT_ALLOC( second_export, export_size );
6309 }
Darryl Greend49a4992018-06-18 17:27:26 +01006310
Gilles Peskine8817f612018-12-18 00:18:46 +01006311 PSA_ASSERT( psa_crypto_init() );
Darryl Greend49a4992018-06-18 17:27:26 +01006312
Gilles Peskinec87af662019-05-15 16:12:22 +02006313 psa_set_key_id( &attributes, key_id );
Gilles Peskine5c648ab2019-04-19 14:06:53 +02006314 psa_set_key_usage_flags( &attributes, usage_flags );
6315 psa_set_key_algorithm( &attributes, alg );
6316 psa_set_key_type( &attributes, type );
Gilles Peskine3a4f1f82019-04-26 13:49:28 +02006317 psa_set_key_bits( &attributes, bits );
Darryl Greend49a4992018-06-18 17:27:26 +01006318
Darryl Green0c6575a2018-11-07 16:05:30 +00006319 switch( generation_method )
6320 {
6321 case IMPORT_KEY:
6322 /* Import the key */
Gilles Peskine049c7532019-05-15 20:22:09 +02006323 PSA_ASSERT( psa_import_key( &attributes, data->x, data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02006324 &key ) );
Darryl Green0c6575a2018-11-07 16:05:30 +00006325 break;
Darryl Greend49a4992018-06-18 17:27:26 +01006326
Darryl Green0c6575a2018-11-07 16:05:30 +00006327 case GENERATE_KEY:
6328 /* Generate a key */
Ronald Cron5425a212020-08-04 14:58:35 +02006329 PSA_ASSERT( psa_generate_key( &attributes, &key ) );
Darryl Green0c6575a2018-11-07 16:05:30 +00006330 break;
6331
6332 case DERIVE_KEY:
Steven Cooreman70f654a2021-02-15 10:51:43 +01006333#if defined(PSA_WANT_ALG_HKDF) && defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine5c648ab2019-04-19 14:06:53 +02006334 {
6335 /* Create base key */
6336 psa_algorithm_t derive_alg = PSA_ALG_HKDF( PSA_ALG_SHA_256 );
6337 psa_key_attributes_t base_attributes = PSA_KEY_ATTRIBUTES_INIT;
6338 psa_set_key_usage_flags( &base_attributes,
6339 PSA_KEY_USAGE_DERIVE );
6340 psa_set_key_algorithm( &base_attributes, derive_alg );
6341 psa_set_key_type( &base_attributes, PSA_KEY_TYPE_DERIVE );
Gilles Peskine049c7532019-05-15 20:22:09 +02006342 PSA_ASSERT( psa_import_key( &base_attributes,
6343 data->x, data->len,
6344 &base_key ) );
Gilles Peskine5c648ab2019-04-19 14:06:53 +02006345 /* Derive a key. */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006346 PSA_ASSERT( psa_key_derivation_setup( &operation, derive_alg ) );
Gilles Peskinecf7292e2019-05-16 17:53:40 +02006347 PSA_ASSERT( psa_key_derivation_input_key(
6348 &operation,
6349 PSA_KEY_DERIVATION_INPUT_SECRET, base_key ) );
Gilles Peskine5c648ab2019-04-19 14:06:53 +02006350 PSA_ASSERT( psa_key_derivation_input_bytes(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006351 &operation, PSA_KEY_DERIVATION_INPUT_INFO,
Gilles Peskine5c648ab2019-04-19 14:06:53 +02006352 NULL, 0 ) );
Gilles Peskinecf7292e2019-05-16 17:53:40 +02006353 PSA_ASSERT( psa_key_derivation_output_key( &attributes,
6354 &operation,
Ronald Cron5425a212020-08-04 14:58:35 +02006355 &key ) );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006356 PSA_ASSERT( psa_key_derivation_abort( &operation ) );
Gilles Peskine5c648ab2019-04-19 14:06:53 +02006357 PSA_ASSERT( psa_destroy_key( base_key ) );
Ronald Cron5425a212020-08-04 14:58:35 +02006358 base_key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine5c648ab2019-04-19 14:06:53 +02006359 }
Gilles Peskine6fea21d2021-01-12 00:02:15 +01006360#else
6361 TEST_ASSUME( ! "KDF not supported in this configuration" );
6362#endif
6363 break;
6364
6365 default:
6366 TEST_ASSERT( ! "generation_method not implemented in test" );
6367 break;
Darryl Green0c6575a2018-11-07 16:05:30 +00006368 }
Gilles Peskine5c648ab2019-04-19 14:06:53 +02006369 psa_reset_key_attributes( &attributes );
Darryl Greend49a4992018-06-18 17:27:26 +01006370
Gilles Peskine5c648ab2019-04-19 14:06:53 +02006371 /* Export the key if permitted by the key policy. */
6372 if( usage_flags & PSA_KEY_USAGE_EXPORT )
6373 {
Ronald Cron5425a212020-08-04 14:58:35 +02006374 PSA_ASSERT( psa_export_key( key,
Gilles Peskine5c648ab2019-04-19 14:06:53 +02006375 first_export, export_size,
6376 &first_exported_length ) );
6377 if( generation_method == IMPORT_KEY )
6378 ASSERT_COMPARE( data->x, data->len,
6379 first_export, first_exported_length );
6380 }
Darryl Greend49a4992018-06-18 17:27:26 +01006381
6382 /* Shutdown and restart */
Ronald Cron5425a212020-08-04 14:58:35 +02006383 PSA_ASSERT( psa_purge_key( key ) );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02006384 PSA_DONE();
Gilles Peskine8817f612018-12-18 00:18:46 +01006385 PSA_ASSERT( psa_crypto_init() );
Darryl Greend49a4992018-06-18 17:27:26 +01006386
Darryl Greend49a4992018-06-18 17:27:26 +01006387 /* Check key slot still contains key data */
Ronald Cron5425a212020-08-04 14:58:35 +02006388 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
Ronald Cronecfb2372020-07-23 17:13:42 +02006389 TEST_ASSERT( mbedtls_svc_key_id_equal(
6390 psa_get_key_id( &attributes ), key_id ) );
Gilles Peskine5c648ab2019-04-19 14:06:53 +02006391 TEST_EQUAL( psa_get_key_lifetime( &attributes ),
6392 PSA_KEY_LIFETIME_PERSISTENT );
6393 TEST_EQUAL( psa_get_key_type( &attributes ), type );
6394 TEST_EQUAL( psa_get_key_bits( &attributes ), bits );
6395 TEST_EQUAL( psa_get_key_usage_flags( &attributes ), usage_flags );
6396 TEST_EQUAL( psa_get_key_algorithm( &attributes ), alg );
Darryl Greend49a4992018-06-18 17:27:26 +01006397
Gilles Peskine5c648ab2019-04-19 14:06:53 +02006398 /* Export the key again if permitted by the key policy. */
6399 if( usage_flags & PSA_KEY_USAGE_EXPORT )
Darryl Green0c6575a2018-11-07 16:05:30 +00006400 {
Ronald Cron5425a212020-08-04 14:58:35 +02006401 PSA_ASSERT( psa_export_key( key,
Gilles Peskine5c648ab2019-04-19 14:06:53 +02006402 second_export, export_size,
6403 &second_exported_length ) );
Darryl Green0c6575a2018-11-07 16:05:30 +00006404 ASSERT_COMPARE( first_export, first_exported_length,
6405 second_export, second_exported_length );
Darryl Green0c6575a2018-11-07 16:05:30 +00006406 }
6407
6408 /* Do something with the key according to its type and permitted usage. */
Gilles Peskinec18e25f2021-02-12 23:48:20 +01006409 if( ! mbedtls_test_psa_exercise_key( key, usage_flags, alg ) )
Darryl Green0c6575a2018-11-07 16:05:30 +00006410 goto exit;
Darryl Greend49a4992018-06-18 17:27:26 +01006411
6412exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +01006413 /*
6414 * Key attributes may have been returned by psa_get_key_attributes()
6415 * thus reset them as required.
6416 */
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02006417 psa_reset_key_attributes( &attributes );
Ronald Cron3a4f0e32020-11-19 17:55:23 +01006418
Darryl Greend49a4992018-06-18 17:27:26 +01006419 mbedtls_free( first_export );
6420 mbedtls_free( second_export );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006421 psa_key_derivation_abort( &operation );
Gilles Peskine5c648ab2019-04-19 14:06:53 +02006422 psa_destroy_key( base_key );
Ronald Cron5425a212020-08-04 14:58:35 +02006423 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02006424 PSA_DONE();
Darryl Greend49a4992018-06-18 17:27:26 +01006425}
6426/* END_CASE */