blob: 0d9543d7b161483340bb43dd1a74dcef234471d0 [file] [log] [blame]
Gilles Peskinee59236f2018-01-27 23:32:46 +01001/* BEGIN_HEADER */
itayzafrir3e02b3b2018-06-12 17:06:52 +03002#include <stdint.h>
mohammad160327010052018-07-03 13:16:15 +03003
Gilles Peskinedd2f95b2018-08-11 01:22:42 +02004#include "mbedtls/asn1.h"
Gilles Peskine0b352bc2018-06-28 00:16:11 +02005#include "mbedtls/asn1write.h"
Gilles Peskinedd2f95b2018-08-11 01:22:42 +02006#include "mbedtls/oid.h"
7
Gilles Peskinebdc96fd2019-08-07 12:08:04 +02008/* For MBEDTLS_CTR_DRBG_MAX_REQUEST, knowing that psa_generate_random()
9 * uses mbedtls_ctr_drbg internally. */
10#include "mbedtls/ctr_drbg.h"
11
Gilles Peskinebdc96fd2019-08-07 12:08:04 +020012#include "psa/crypto.h"
Ronald Cron41841072020-09-17 15:28:26 +020013#include "psa_crypto_slot_management.h"
Gilles Peskinebdc96fd2019-08-07 12:08:04 +020014
Gilles Peskine8e94efe2021-02-13 00:25:53 +010015#include "test/asn1_helpers.h"
Ronald Cron28a45ed2021-02-09 20:35:42 +010016#include "test/psa_crypto_helpers.h"
Gilles Peskinee78b0022021-02-13 00:41:11 +010017#include "test/psa_exercise_key.h"
Ronald Cron28a45ed2021-02-09 20:35:42 +010018
Jaeden Amerof24c7f82018-06-27 17:20:43 +010019/** An invalid export length that will never be set by psa_export_key(). */
20static const size_t INVALID_EXPORT_LENGTH = ~0U;
21
Gilles Peskinea7aa4422018-08-14 15:17:54 +020022/** Test if a buffer contains a constant byte value.
23 *
24 * `mem_is_char(buffer, c, size)` is true after `memset(buffer, c, size)`.
Gilles Peskinee66ca3b2018-06-20 00:11:45 +020025 *
26 * \param buffer Pointer to the beginning of the buffer.
Gilles Peskinea7aa4422018-08-14 15:17:54 +020027 * \param c Expected value of every byte.
Gilles Peskinee66ca3b2018-06-20 00:11:45 +020028 * \param size Size of the buffer in bytes.
29 *
Gilles Peskine3f669c32018-06-21 09:21:51 +020030 * \return 1 if the buffer is all-bits-zero.
31 * \return 0 if there is at least one nonzero byte.
Gilles Peskinee66ca3b2018-06-20 00:11:45 +020032 */
Gilles Peskinea7aa4422018-08-14 15:17:54 +020033static int mem_is_char( void *buffer, unsigned char c, size_t size )
Gilles Peskinee66ca3b2018-06-20 00:11:45 +020034{
35 size_t i;
36 for( i = 0; i < size; i++ )
37 {
Gilles Peskinea7aa4422018-08-14 15:17:54 +020038 if( ( (unsigned char *) buffer )[i] != c )
Gilles Peskine3f669c32018-06-21 09:21:51 +020039 return( 0 );
Gilles Peskinee66ca3b2018-06-20 00:11:45 +020040 }
Gilles Peskine3f669c32018-06-21 09:21:51 +020041 return( 1 );
Gilles Peskinee66ca3b2018-06-20 00:11:45 +020042}
Gilles Peskine818ca122018-06-20 18:16:48 +020043
Gilles Peskine0b352bc2018-06-28 00:16:11 +020044/* Write the ASN.1 INTEGER with the value 2^(bits-1)+x backwards from *p. */
45static int asn1_write_10x( unsigned char **p,
46 unsigned char *start,
47 size_t bits,
48 unsigned char x )
49{
50 int ret;
51 int len = bits / 8 + 1;
Gilles Peskine480416a2018-06-28 19:04:07 +020052 if( bits == 0 )
53 return( MBEDTLS_ERR_ASN1_INVALID_DATA );
54 if( bits <= 8 && x >= 1 << ( bits - 1 ) )
Gilles Peskine0b352bc2018-06-28 00:16:11 +020055 return( MBEDTLS_ERR_ASN1_INVALID_DATA );
Moran Pekercb088e72018-07-17 17:36:59 +030056 if( *p < start || *p - start < (ptrdiff_t) len )
Gilles Peskine0b352bc2018-06-28 00:16:11 +020057 return( MBEDTLS_ERR_ASN1_BUF_TOO_SMALL );
58 *p -= len;
59 ( *p )[len-1] = x;
60 if( bits % 8 == 0 )
61 ( *p )[1] |= 1;
62 else
63 ( *p )[0] |= 1 << ( bits % 8 );
64 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_len( p, start, len ) );
65 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_tag( p, start,
66 MBEDTLS_ASN1_INTEGER ) );
67 return( len );
68}
69
70static int construct_fake_rsa_key( unsigned char *buffer,
71 size_t buffer_size,
72 unsigned char **p,
73 size_t bits,
74 int keypair )
75{
76 size_t half_bits = ( bits + 1 ) / 2;
77 int ret;
78 int len = 0;
79 /* Construct something that looks like a DER encoding of
80 * as defined by PKCS#1 v2.2 (RFC 8017) section A.1.2:
81 * RSAPrivateKey ::= SEQUENCE {
82 * version Version,
83 * modulus INTEGER, -- n
84 * publicExponent INTEGER, -- e
85 * privateExponent INTEGER, -- d
86 * prime1 INTEGER, -- p
87 * prime2 INTEGER, -- q
88 * exponent1 INTEGER, -- d mod (p-1)
89 * exponent2 INTEGER, -- d mod (q-1)
90 * coefficient INTEGER, -- (inverse of q) mod p
91 * otherPrimeInfos OtherPrimeInfos OPTIONAL
92 * }
93 * Or, for a public key, the same structure with only
94 * version, modulus and publicExponent.
95 */
96 *p = buffer + buffer_size;
97 if( keypair )
98 {
99 MBEDTLS_ASN1_CHK_ADD( len, /* pq */
100 asn1_write_10x( p, buffer, half_bits, 1 ) );
101 MBEDTLS_ASN1_CHK_ADD( len, /* dq */
102 asn1_write_10x( p, buffer, half_bits, 1 ) );
103 MBEDTLS_ASN1_CHK_ADD( len, /* dp */
104 asn1_write_10x( p, buffer, half_bits, 1 ) );
105 MBEDTLS_ASN1_CHK_ADD( len, /* q */
106 asn1_write_10x( p, buffer, half_bits, 1 ) );
107 MBEDTLS_ASN1_CHK_ADD( len, /* p != q to pass mbedtls sanity checks */
108 asn1_write_10x( p, buffer, half_bits, 3 ) );
109 MBEDTLS_ASN1_CHK_ADD( len, /* d */
110 asn1_write_10x( p, buffer, bits, 1 ) );
111 }
112 MBEDTLS_ASN1_CHK_ADD( len, /* e = 65537 */
113 asn1_write_10x( p, buffer, 17, 1 ) );
114 MBEDTLS_ASN1_CHK_ADD( len, /* n */
115 asn1_write_10x( p, buffer, bits, 1 ) );
116 if( keypair )
117 MBEDTLS_ASN1_CHK_ADD( len, /* version = 0 */
118 mbedtls_asn1_write_int( p, buffer, 0 ) );
119 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_len( p, buffer, len ) );
120 {
121 const unsigned char tag =
122 MBEDTLS_ASN1_CONSTRUCTED | MBEDTLS_ASN1_SEQUENCE;
123 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_tag( p, buffer, tag ) );
124 }
125 return( len );
126}
127
Gilles Peskinef426e0f2019-02-25 17:42:03 +0100128int exercise_mac_setup( psa_key_type_t key_type,
129 const unsigned char *key_bytes,
130 size_t key_length,
131 psa_algorithm_t alg,
132 psa_mac_operation_t *operation,
133 psa_status_t *status )
134{
Ronald Cron5425a212020-08-04 14:58:35 +0200135 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +0200136 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskinef426e0f2019-02-25 17:42:03 +0100137
Gilles Peskine89d8c5c2019-11-26 17:01:59 +0100138 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_HASH );
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +0200139 psa_set_key_algorithm( &attributes, alg );
140 psa_set_key_type( &attributes, key_type );
Ronald Cron5425a212020-08-04 14:58:35 +0200141 PSA_ASSERT( psa_import_key( &attributes, key_bytes, key_length, &key ) );
Gilles Peskinef426e0f2019-02-25 17:42:03 +0100142
Ronald Cron5425a212020-08-04 14:58:35 +0200143 *status = psa_mac_sign_setup( operation, key, alg );
Gilles Peskine9e0a4a52019-02-25 22:11:18 +0100144 /* Whether setup succeeded or failed, abort must succeed. */
145 PSA_ASSERT( psa_mac_abort( operation ) );
146 /* If setup failed, reproduce the failure, so that the caller can
147 * test the resulting state of the operation object. */
148 if( *status != PSA_SUCCESS )
Gilles Peskinef426e0f2019-02-25 17:42:03 +0100149 {
Ronald Cron5425a212020-08-04 14:58:35 +0200150 TEST_EQUAL( psa_mac_sign_setup( operation, key, alg ), *status );
Gilles Peskinef426e0f2019-02-25 17:42:03 +0100151 }
152
Ronald Cron5425a212020-08-04 14:58:35 +0200153 psa_destroy_key( key );
Gilles Peskinef426e0f2019-02-25 17:42:03 +0100154 return( 1 );
155
156exit:
Ronald Cron5425a212020-08-04 14:58:35 +0200157 psa_destroy_key( key );
Gilles Peskinef426e0f2019-02-25 17:42:03 +0100158 return( 0 );
159}
160
161int exercise_cipher_setup( psa_key_type_t key_type,
162 const unsigned char *key_bytes,
163 size_t key_length,
164 psa_algorithm_t alg,
165 psa_cipher_operation_t *operation,
166 psa_status_t *status )
167{
Ronald Cron5425a212020-08-04 14:58:35 +0200168 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +0200169 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskinef426e0f2019-02-25 17:42:03 +0100170
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +0200171 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
172 psa_set_key_algorithm( &attributes, alg );
173 psa_set_key_type( &attributes, key_type );
Ronald Cron5425a212020-08-04 14:58:35 +0200174 PSA_ASSERT( psa_import_key( &attributes, key_bytes, key_length, &key ) );
Gilles Peskinef426e0f2019-02-25 17:42:03 +0100175
Ronald Cron5425a212020-08-04 14:58:35 +0200176 *status = psa_cipher_encrypt_setup( operation, key, alg );
Gilles Peskine9e0a4a52019-02-25 22:11:18 +0100177 /* Whether setup succeeded or failed, abort must succeed. */
178 PSA_ASSERT( psa_cipher_abort( operation ) );
179 /* If setup failed, reproduce the failure, so that the caller can
180 * test the resulting state of the operation object. */
181 if( *status != PSA_SUCCESS )
Gilles Peskinef426e0f2019-02-25 17:42:03 +0100182 {
Ronald Cron5425a212020-08-04 14:58:35 +0200183 TEST_EQUAL( psa_cipher_encrypt_setup( operation, key, alg ),
Gilles Peskine9e0a4a52019-02-25 22:11:18 +0100184 *status );
Gilles Peskinef426e0f2019-02-25 17:42:03 +0100185 }
186
Ronald Cron5425a212020-08-04 14:58:35 +0200187 psa_destroy_key( key );
Gilles Peskinef426e0f2019-02-25 17:42:03 +0100188 return( 1 );
189
190exit:
Ronald Cron5425a212020-08-04 14:58:35 +0200191 psa_destroy_key( key );
Gilles Peskinef426e0f2019-02-25 17:42:03 +0100192 return( 0 );
193}
194
Ronald Cron5425a212020-08-04 14:58:35 +0200195static int test_operations_on_invalid_key( mbedtls_svc_key_id_t key )
Gilles Peskine4cf3a432019-04-18 22:28:52 +0200196{
197 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Ronald Cronecfb2372020-07-23 17:13:42 +0200198 mbedtls_svc_key_id_t key_id = mbedtls_svc_key_id_make( 1, 0x6964 );
Gilles Peskine4cf3a432019-04-18 22:28:52 +0200199 uint8_t buffer[1];
200 size_t length;
201 int ok = 0;
202
Ronald Cronecfb2372020-07-23 17:13:42 +0200203 psa_set_key_id( &attributes, key_id );
Gilles Peskine4cf3a432019-04-18 22:28:52 +0200204 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
205 psa_set_key_algorithm( &attributes, PSA_ALG_CTR );
206 psa_set_key_type( &attributes, PSA_KEY_TYPE_AES );
Ronald Cron5425a212020-08-04 14:58:35 +0200207 TEST_EQUAL( psa_get_key_attributes( key, &attributes ),
Maulik Patel3240c9d2021-03-17 16:11:05 +0000208 PSA_ERROR_INVALID_HANDLE );
Ronald Cronecfb2372020-07-23 17:13:42 +0200209 TEST_EQUAL(
210 MBEDTLS_SVC_KEY_ID_GET_KEY_ID( psa_get_key_id( &attributes ) ), 0 );
211 TEST_EQUAL(
212 MBEDTLS_SVC_KEY_ID_GET_OWNER_ID( psa_get_key_id( &attributes ) ), 0 );
Gilles Peskine5c648ab2019-04-19 14:06:53 +0200213 TEST_EQUAL( psa_get_key_lifetime( &attributes ), 0 );
Gilles Peskine4cf3a432019-04-18 22:28:52 +0200214 TEST_EQUAL( psa_get_key_usage_flags( &attributes ), 0 );
215 TEST_EQUAL( psa_get_key_algorithm( &attributes ), 0 );
216 TEST_EQUAL( psa_get_key_type( &attributes ), 0 );
217 TEST_EQUAL( psa_get_key_bits( &attributes ), 0 );
218
Ronald Cron5425a212020-08-04 14:58:35 +0200219 TEST_EQUAL( psa_export_key( key, buffer, sizeof( buffer ), &length ),
Maulik Patel3240c9d2021-03-17 16:11:05 +0000220 PSA_ERROR_INVALID_HANDLE );
Ronald Cron5425a212020-08-04 14:58:35 +0200221 TEST_EQUAL( psa_export_public_key( key,
Gilles Peskine4cf3a432019-04-18 22:28:52 +0200222 buffer, sizeof( buffer ), &length ),
Maulik Patel3240c9d2021-03-17 16:11:05 +0000223 PSA_ERROR_INVALID_HANDLE );
Gilles Peskine4cf3a432019-04-18 22:28:52 +0200224
Gilles Peskine4cf3a432019-04-18 22:28:52 +0200225 ok = 1;
226
227exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +0100228 /*
229 * Key attributes may have been returned by psa_get_key_attributes()
230 * thus reset them as required.
231 */
Gilles Peskine4cf3a432019-04-18 22:28:52 +0200232 psa_reset_key_attributes( &attributes );
Ronald Cron3a4f0e32020-11-19 17:55:23 +0100233
Gilles Peskine4cf3a432019-04-18 22:28:52 +0200234 return( ok );
235}
236
Gilles Peskine5fe5e272019-08-02 20:30:01 +0200237/* Assert that a key isn't reported as having a slot number. */
238#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
239#define ASSERT_NO_SLOT_NUMBER( attributes ) \
240 do \
241 { \
242 psa_key_slot_number_t ASSERT_NO_SLOT_NUMBER_slot_number; \
243 TEST_EQUAL( psa_get_key_slot_number( \
244 attributes, \
245 &ASSERT_NO_SLOT_NUMBER_slot_number ), \
246 PSA_ERROR_INVALID_ARGUMENT ); \
247 } \
248 while( 0 )
249#else /* MBEDTLS_PSA_CRYPTO_SE_C */
250#define ASSERT_NO_SLOT_NUMBER( attributes ) \
251 ( (void) 0 )
252#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
253
Gilles Peskinebdf309c2018-12-03 15:36:32 +0100254/* An overapproximation of the amount of storage needed for a key of the
255 * given type and with the given content. The API doesn't make it easy
256 * to find a good value for the size. The current implementation doesn't
257 * care about the value anyway. */
258#define KEY_BITS_FROM_DATA( type, data ) \
259 ( data )->len
260
Darryl Green0c6575a2018-11-07 16:05:30 +0000261typedef enum {
262 IMPORT_KEY = 0,
263 GENERATE_KEY = 1,
264 DERIVE_KEY = 2
265} generate_method;
266
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100267/*!
268 * \brief Internal Function for AEAD multipart tests.
269 *
270 * \param key_type_arg Type of key passed in
271 * \param key_data The encryption / decryption key data
272 * \param alg_arg The type of algorithm used
273 * \param nonce Nonce data
274 * \param additional_data Additional data
275 * \param ad_part_len If not -1, the length of chunks to
276 * feed additional data in to be encrypted /
277 * decrypted. If -1, no chunking.
278 * \param input_data Data to encrypt / decrypt
279 * \param data_part_len If not -1, the length of chunks to feed the
280 * data in to be encrypted / decrypted. If -1,
281 * no chunking
282 * \param do_set_lengths If non-zero, then set lengths prior to
283 * calling encryption / decryption.
284 * \param expected_output Expected output
Paul Elliott41ffae12021-07-22 21:52:01 +0100285 * \param expect_valid_signature If non zero, we expect the signature to be
286 * valid
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100287 * \param is_encrypt If non-zero this is an encryption operation.
Paul Elliott41ffae12021-07-22 21:52:01 +0100288 * \param do_zero_parts If non-zero, interleave zero length chunks
289 * with normal length chunks
290 * \param swap_set_functions If non-zero, swap the order of set lengths
291 * and set nonce.
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100292 *
293 * \return int Zero on failure, non-zero on success.
294 *
295 */
296static int aead_multipart_internal_func( int key_type_arg, data_t *key_data,
297 int alg_arg,
298 data_t *nonce,
299 data_t *additional_data,
300 int ad_part_len,
301 data_t *input_data,
302 int data_part_len,
303 int do_set_lengths,
304 data_t *expected_output,
305 int expect_valid_signature,
Paul Elliott329d5382021-07-22 17:10:45 +0100306 int is_encrypt,
Paul Elliottebf91632021-07-22 17:54:42 +0100307 int do_zero_parts,
308 int swap_set_functions )
Paul Elliottd3f82412021-06-16 16:52:21 +0100309{
310 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
311 psa_key_type_t key_type = key_type_arg;
312 psa_algorithm_t alg = alg_arg;
313 psa_aead_operation_t operation;
314 unsigned char *output_data = NULL;
315 unsigned char *part_data = NULL;
316 unsigned char *final_data = NULL;
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100317 size_t data_true_size = 0;
Paul Elliottd3f82412021-06-16 16:52:21 +0100318 size_t part_data_size = 0;
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100319 size_t output_size = 0;
320 size_t final_output_size = 0;
Paul Elliottd3f82412021-06-16 16:52:21 +0100321 size_t output_length = 0;
322 size_t key_bits = 0;
323 size_t tag_length = 0;
Paul Elliottd3f82412021-06-16 16:52:21 +0100324 uint32_t part_offset = 0;
325 size_t part_length = 0;
326 size_t output_part_length = 0;
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100327 size_t tag_size = 0;
328 uint8_t tag_buffer[PSA_AEAD_TAG_MAX_SIZE];
Paul Elliottd3f82412021-06-16 16:52:21 +0100329 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
330 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
331
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100332 int test_ok = 0;
Paul Elliott329d5382021-07-22 17:10:45 +0100333 uint32_t part_count = 0;
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100334
Paul Elliottd3f82412021-06-16 16:52:21 +0100335 PSA_ASSERT( psa_crypto_init( ) );
336
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100337 if( is_encrypt )
338 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
339 else
340 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DECRYPT );
341
Paul Elliottd3f82412021-06-16 16:52:21 +0100342 psa_set_key_algorithm( &attributes, alg );
343 psa_set_key_type( &attributes, key_type );
344
345 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
346 &key ) );
347
348 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
349 key_bits = psa_get_key_bits( &attributes );
350
351 tag_length = PSA_AEAD_TAG_LENGTH( key_type, key_bits, alg );
352
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100353 if( is_encrypt )
354 {
355 /* Tag gets written at end of buffer. */
356 output_size = PSA_AEAD_UPDATE_OUTPUT_SIZE( key_type, alg,
357 ( input_data->len +
358 tag_length ) );
359 data_true_size = input_data->len;
360 }
361 else
362 {
363 output_size = PSA_AEAD_UPDATE_OUTPUT_SIZE( key_type, alg,
364 ( input_data->len -
365 tag_length ) );
Paul Elliottd3f82412021-06-16 16:52:21 +0100366
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100367 /* Do not want to attempt to decrypt tag. */
368 data_true_size = input_data->len - tag_length;
369 }
Paul Elliottd3f82412021-06-16 16:52:21 +0100370
371 ASSERT_ALLOC( output_data, output_size );
372
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100373 if( is_encrypt )
374 {
375 final_output_size = PSA_AEAD_VERIFY_OUTPUT_SIZE( key_type, alg );
376 TEST_ASSERT( final_output_size <= PSA_AEAD_VERIFY_OUTPUT_MAX_SIZE );
377 }
378 else
379 {
380 final_output_size = PSA_AEAD_FINISH_OUTPUT_SIZE( key_type, alg );
381 TEST_ASSERT( final_output_size <= PSA_AEAD_FINISH_OUTPUT_MAX_SIZE );
382 }
Paul Elliottd3f82412021-06-16 16:52:21 +0100383
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100384 ASSERT_ALLOC( final_data, final_output_size );
Paul Elliottd3f82412021-06-16 16:52:21 +0100385
386 operation = psa_aead_operation_init( );
387
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100388
389 if( is_encrypt )
390 status = psa_aead_encrypt_setup( &operation, key, alg );
391 else
392 status = psa_aead_decrypt_setup( &operation, key, alg );
Paul Elliottd3f82412021-06-16 16:52:21 +0100393
394 /* If the operation is not supported, just skip and not fail in case the
395 * encryption involves a common limitation of cryptography hardwares and
396 * an alternative implementation. */
397 if( status == PSA_ERROR_NOT_SUPPORTED )
398 {
399 MBEDTLS_TEST_PSA_SKIP_IF_ALT_AES_192( key_type, key_data->len * 8 );
400 MBEDTLS_TEST_PSA_SKIP_IF_ALT_GCM_NOT_12BYTES_NONCE( alg, nonce->len );
401 }
402
403 PSA_ASSERT( status );
404
Paul Elliottebf91632021-07-22 17:54:42 +0100405 if( swap_set_functions )
Paul Elliottd3f82412021-06-16 16:52:21 +0100406 {
Paul Elliottebf91632021-07-22 17:54:42 +0100407 if( do_set_lengths )
408 {
409 PSA_ASSERT( psa_aead_set_lengths( &operation, additional_data->len,
410 data_true_size ) );
411 }
412
413 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
414 }
415 else
416 {
417 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
418
419 if( do_set_lengths )
420 {
421 PSA_ASSERT( psa_aead_set_lengths( &operation, additional_data->len,
422 data_true_size ) );
423 }
Paul Elliottd3f82412021-06-16 16:52:21 +0100424 }
Paul Elliottd3f82412021-06-16 16:52:21 +0100425
426 if( ad_part_len != -1 )
427 {
428 /* Pass additional data in parts */
429 part_offset = 0;
430
431 while( part_offset < additional_data->len )
432 {
Paul Elliott329d5382021-07-22 17:10:45 +0100433 if( do_zero_parts && part_count++ & 0x01 )
Paul Elliottd3f82412021-06-16 16:52:21 +0100434 {
Paul Elliott329d5382021-07-22 17:10:45 +0100435 part_length = 0;
Paul Elliottd3f82412021-06-16 16:52:21 +0100436 }
437 else
438 {
Paul Elliott329d5382021-07-22 17:10:45 +0100439 if( additional_data->len - part_offset <
440 ( uint32_t ) ad_part_len )
441 {
442 part_length = additional_data->len - part_offset;
443 }
444 else
445 {
446 part_length = ad_part_len;
447 }
Paul Elliottd3f82412021-06-16 16:52:21 +0100448 }
449
450 PSA_ASSERT( psa_aead_update_ad( &operation,
451 additional_data->x + part_offset,
452 part_length ) );
453
454 part_offset += part_length;
455 }
456 }
457 else
458 {
459 /* Pass additional data in one go. */
460 PSA_ASSERT( psa_aead_update_ad( &operation, additional_data->x,
461 additional_data->len ) );
462 }
463
464 if( data_part_len != -1 )
465 {
466 /* Pass data in parts */
467 part_data_size = PSA_AEAD_UPDATE_OUTPUT_SIZE( key_type, alg,
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100468 ( size_t ) data_part_len );
Paul Elliottd3f82412021-06-16 16:52:21 +0100469
470 ASSERT_ALLOC( part_data, part_data_size );
471
472 part_offset = 0;
473
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100474 while( part_offset < data_true_size )
Paul Elliottd3f82412021-06-16 16:52:21 +0100475 {
Paul Elliott329d5382021-07-22 17:10:45 +0100476 if( do_zero_parts && part_count++ & 0x01 )
Paul Elliottd3f82412021-06-16 16:52:21 +0100477 {
Paul Elliott329d5382021-07-22 17:10:45 +0100478 part_length = 0;
Paul Elliottd3f82412021-06-16 16:52:21 +0100479 }
480 else
481 {
Paul Elliott329d5382021-07-22 17:10:45 +0100482 if( ( data_true_size - part_offset ) < ( uint32_t ) data_part_len )
483 {
484 part_length = ( data_true_size - part_offset );
485 }
486 else
487 {
488 part_length = data_part_len;
489 }
Paul Elliottd3f82412021-06-16 16:52:21 +0100490 }
491
492 PSA_ASSERT( psa_aead_update( &operation,
493 ( input_data->x + part_offset ),
494 part_length, part_data,
495 part_data_size,
496 &output_part_length ) );
497
498 if( output_data && output_part_length )
499 {
500 memcpy( ( output_data + part_offset ), part_data,
501 output_part_length );
502 }
503
504 part_offset += part_length;
505 output_length += output_part_length;
506 }
507 }
508 else
509 {
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100510 /* Pass all data in one go. */
Paul Elliottd3f82412021-06-16 16:52:21 +0100511 PSA_ASSERT( psa_aead_update( &operation, input_data->x,
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100512 data_true_size, output_data,
Paul Elliottd3f82412021-06-16 16:52:21 +0100513 output_size, &output_length ) );
514 }
515
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100516 if( is_encrypt )
517 PSA_ASSERT( psa_aead_finish( &operation, final_data,
518 final_output_size,
519 &output_part_length,
520 tag_buffer, tag_length,
521 &tag_size ) );
522 else
Paul Elliottd3f82412021-06-16 16:52:21 +0100523 {
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100524 status = psa_aead_verify( &operation, final_data,
525 final_output_size,
526 &output_part_length,
527 ( input_data->x + data_true_size ),
528 tag_length );
529
530 if( status != PSA_SUCCESS )
531 {
532 if( !expect_valid_signature )
533 {
534 /* Expected failure. */
535 test_ok = 1;
536 goto exit;
537 }
538 else
539 PSA_ASSERT( status );
540 }
Paul Elliottd3f82412021-06-16 16:52:21 +0100541 }
542
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100543 if( output_data && output_part_length )
544 memcpy( ( output_data + output_length ), final_data,
545 output_part_length );
Paul Elliottd3f82412021-06-16 16:52:21 +0100546
547 output_length += output_part_length;
548
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100549
550 /* For all currently defined algorithms, PSA_AEAD_xxx_OUTPUT_SIZE
551 * should be exact.*/
552 if( is_encrypt )
Paul Elliottd3f82412021-06-16 16:52:21 +0100553 {
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100554 TEST_EQUAL( tag_length, tag_size );
555
556 if( output_data && tag_length )
557 memcpy( ( output_data + output_length ), tag_buffer,
558 tag_length );
559
560 output_length += tag_length;
561
562 TEST_EQUAL( output_length,
563 PSA_AEAD_ENCRYPT_OUTPUT_SIZE( key_type, alg,
564 input_data->len ) );
565 TEST_ASSERT( output_length <=
566 PSA_AEAD_ENCRYPT_OUTPUT_MAX_SIZE( input_data->len ) );
567 }
568 else
569 {
570 TEST_EQUAL( output_length,
571 PSA_AEAD_DECRYPT_OUTPUT_SIZE( key_type, alg,
572 input_data->len ) );
573 TEST_ASSERT( output_length <=
574 PSA_AEAD_DECRYPT_OUTPUT_MAX_SIZE( input_data->len ) );
Paul Elliottd3f82412021-06-16 16:52:21 +0100575 }
576
Paul Elliottd3f82412021-06-16 16:52:21 +0100577
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100578 ASSERT_COMPARE( expected_output->x, expected_output->len,
Paul Elliottd3f82412021-06-16 16:52:21 +0100579 output_data, output_length );
580
Paul Elliottd3f82412021-06-16 16:52:21 +0100581
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100582 test_ok = 1;
Paul Elliottd3f82412021-06-16 16:52:21 +0100583
584exit:
585 psa_destroy_key( key );
586 psa_aead_abort( &operation );
587 mbedtls_free( output_data );
588 mbedtls_free( part_data );
589 mbedtls_free( final_data );
590 PSA_DONE( );
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100591
592 return( test_ok );
Paul Elliottd3f82412021-06-16 16:52:21 +0100593}
594
Gilles Peskinee59236f2018-01-27 23:32:46 +0100595/* END_HEADER */
596
597/* BEGIN_DEPENDENCIES
598 * depends_on:MBEDTLS_PSA_CRYPTO_C
599 * END_DEPENDENCIES
600 */
601
602/* BEGIN_CASE */
Gilles Peskinee1f2d7d2018-08-21 14:54:54 +0200603void static_checks( )
604{
605 size_t max_truncated_mac_size =
606 PSA_ALG_MAC_TRUNCATION_MASK >> PSA_MAC_TRUNCATION_OFFSET;
607
608 /* Check that the length for a truncated MAC always fits in the algorithm
609 * encoding. The shifted mask is the maximum truncated value. The
610 * untruncated algorithm may be one byte larger. */
611 TEST_ASSERT( PSA_MAC_MAX_SIZE <= 1 + max_truncated_mac_size );
612}
613/* END_CASE */
614
615/* BEGIN_CASE */
Gilles Peskine6edfa292019-07-31 15:53:45 +0200616void import_with_policy( int type_arg,
617 int usage_arg, int alg_arg,
618 int expected_status_arg )
619{
620 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
621 psa_key_attributes_t got_attributes = PSA_KEY_ATTRIBUTES_INIT;
Ronald Cron5425a212020-08-04 14:58:35 +0200622 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine6edfa292019-07-31 15:53:45 +0200623 psa_key_type_t type = type_arg;
624 psa_key_usage_t usage = usage_arg;
625 psa_algorithm_t alg = alg_arg;
626 psa_status_t expected_status = expected_status_arg;
627 const uint8_t key_material[16] = {0};
628 psa_status_t status;
629
630 PSA_ASSERT( psa_crypto_init( ) );
631
632 psa_set_key_type( &attributes, type );
633 psa_set_key_usage_flags( &attributes, usage );
634 psa_set_key_algorithm( &attributes, alg );
635
636 status = psa_import_key( &attributes,
637 key_material, sizeof( key_material ),
Ronald Cron5425a212020-08-04 14:58:35 +0200638 &key );
Gilles Peskine6edfa292019-07-31 15:53:45 +0200639 TEST_EQUAL( status, expected_status );
640 if( status != PSA_SUCCESS )
641 goto exit;
642
Ronald Cron5425a212020-08-04 14:58:35 +0200643 PSA_ASSERT( psa_get_key_attributes( key, &got_attributes ) );
Gilles Peskine6edfa292019-07-31 15:53:45 +0200644 TEST_EQUAL( psa_get_key_type( &got_attributes ), type );
645 TEST_EQUAL( psa_get_key_usage_flags( &got_attributes ), usage );
646 TEST_EQUAL( psa_get_key_algorithm( &got_attributes ), alg );
Gilles Peskine5fe5e272019-08-02 20:30:01 +0200647 ASSERT_NO_SLOT_NUMBER( &got_attributes );
Gilles Peskine6edfa292019-07-31 15:53:45 +0200648
Ronald Cron5425a212020-08-04 14:58:35 +0200649 PSA_ASSERT( psa_destroy_key( key ) );
650 test_operations_on_invalid_key( key );
Gilles Peskine6edfa292019-07-31 15:53:45 +0200651
652exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +0100653 /*
654 * Key attributes may have been returned by psa_get_key_attributes()
655 * thus reset them as required.
656 */
Gilles Peskine6edfa292019-07-31 15:53:45 +0200657 psa_reset_key_attributes( &got_attributes );
Ronald Cron3a4f0e32020-11-19 17:55:23 +0100658
659 psa_destroy_key( key );
Gilles Peskine6edfa292019-07-31 15:53:45 +0200660 PSA_DONE( );
661}
662/* END_CASE */
663
664/* BEGIN_CASE */
665void import_with_data( data_t *data, int type_arg,
666 int attr_bits_arg,
667 int expected_status_arg )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +0200668{
669 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
670 psa_key_attributes_t got_attributes = PSA_KEY_ATTRIBUTES_INIT;
Ronald Cron5425a212020-08-04 14:58:35 +0200671 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +0200672 psa_key_type_t type = type_arg;
Gilles Peskine8fb3a9e2019-05-03 16:59:21 +0200673 size_t attr_bits = attr_bits_arg;
Gilles Peskineb866e2b2018-06-21 09:25:10 +0200674 psa_status_t expected_status = expected_status_arg;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100675 psa_status_t status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100676
Gilles Peskine8817f612018-12-18 00:18:46 +0100677 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100678
Gilles Peskine4747d192019-04-17 15:05:45 +0200679 psa_set_key_type( &attributes, type );
Gilles Peskine8fb3a9e2019-05-03 16:59:21 +0200680 psa_set_key_bits( &attributes, attr_bits );
Gilles Peskine6edfa292019-07-31 15:53:45 +0200681
Ronald Cron5425a212020-08-04 14:58:35 +0200682 status = psa_import_key( &attributes, data->x, data->len, &key );
Gilles Peskinefe11b722018-12-18 00:24:04 +0100683 TEST_EQUAL( status, expected_status );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +0200684 if( status != PSA_SUCCESS )
685 goto exit;
686
Ronald Cron5425a212020-08-04 14:58:35 +0200687 PSA_ASSERT( psa_get_key_attributes( key, &got_attributes ) );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +0200688 TEST_EQUAL( psa_get_key_type( &got_attributes ), type );
Gilles Peskine8fb3a9e2019-05-03 16:59:21 +0200689 if( attr_bits != 0 )
Gilles Peskine7e0cff92019-07-30 13:48:52 +0200690 TEST_EQUAL( attr_bits, psa_get_key_bits( &got_attributes ) );
Gilles Peskine5fe5e272019-08-02 20:30:01 +0200691 ASSERT_NO_SLOT_NUMBER( &got_attributes );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +0200692
Ronald Cron5425a212020-08-04 14:58:35 +0200693 PSA_ASSERT( psa_destroy_key( key ) );
694 test_operations_on_invalid_key( key );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100695
696exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +0100697 /*
698 * Key attributes may have been returned by psa_get_key_attributes()
699 * thus reset them as required.
700 */
Gilles Peskinea1ace9c2019-04-26 16:03:33 +0200701 psa_reset_key_attributes( &got_attributes );
Ronald Cron3a4f0e32020-11-19 17:55:23 +0100702
703 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +0200704 PSA_DONE( );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100705}
706/* END_CASE */
707
708/* BEGIN_CASE */
Gilles Peskinec744d992019-07-30 17:26:54 +0200709void import_large_key( int type_arg, int byte_size_arg,
710 int expected_status_arg )
711{
712 psa_key_type_t type = type_arg;
713 size_t byte_size = byte_size_arg;
714 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
715 psa_status_t expected_status = expected_status_arg;
Ronald Cron5425a212020-08-04 14:58:35 +0200716 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskinec744d992019-07-30 17:26:54 +0200717 psa_status_t status;
718 uint8_t *buffer = NULL;
719 size_t buffer_size = byte_size + 1;
720 size_t n;
721
Steven Cooreman69967ce2021-01-18 18:01:08 +0100722 /* Skip the test case if the target running the test cannot
723 * accomodate large keys due to heap size constraints */
724 ASSERT_ALLOC_WEAK( buffer, buffer_size );
Gilles Peskinec744d992019-07-30 17:26:54 +0200725 memset( buffer, 'K', byte_size );
726
727 PSA_ASSERT( psa_crypto_init( ) );
728
729 /* Try importing the key */
730 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_EXPORT );
731 psa_set_key_type( &attributes, type );
Ronald Cron5425a212020-08-04 14:58:35 +0200732 status = psa_import_key( &attributes, buffer, byte_size, &key );
Steven Cooreman83fdb702021-01-21 14:24:39 +0100733 TEST_ASSUME( status != PSA_ERROR_INSUFFICIENT_MEMORY );
Gilles Peskinec744d992019-07-30 17:26:54 +0200734 TEST_EQUAL( status, expected_status );
735
736 if( status == PSA_SUCCESS )
737 {
Ronald Cron5425a212020-08-04 14:58:35 +0200738 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
Gilles Peskinec744d992019-07-30 17:26:54 +0200739 TEST_EQUAL( psa_get_key_type( &attributes ), type );
740 TEST_EQUAL( psa_get_key_bits( &attributes ),
741 PSA_BYTES_TO_BITS( byte_size ) );
Gilles Peskine5fe5e272019-08-02 20:30:01 +0200742 ASSERT_NO_SLOT_NUMBER( &attributes );
Gilles Peskinec744d992019-07-30 17:26:54 +0200743 memset( buffer, 0, byte_size + 1 );
Ronald Cron5425a212020-08-04 14:58:35 +0200744 PSA_ASSERT( psa_export_key( key, buffer, byte_size, &n ) );
Gilles Peskinec744d992019-07-30 17:26:54 +0200745 for( n = 0; n < byte_size; n++ )
746 TEST_EQUAL( buffer[n], 'K' );
747 for( n = byte_size; n < buffer_size; n++ )
748 TEST_EQUAL( buffer[n], 0 );
749 }
750
751exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +0100752 /*
753 * Key attributes may have been returned by psa_get_key_attributes()
754 * thus reset them as required.
755 */
756 psa_reset_key_attributes( &attributes );
757
Ronald Cron5425a212020-08-04 14:58:35 +0200758 psa_destroy_key( key );
Gilles Peskinec744d992019-07-30 17:26:54 +0200759 PSA_DONE( );
760 mbedtls_free( buffer );
761}
762/* END_CASE */
763
764/* BEGIN_CASE */
Gilles Peskine0b352bc2018-06-28 00:16:11 +0200765void import_rsa_made_up( int bits_arg, int keypair, int expected_status_arg )
766{
Ronald Cron5425a212020-08-04 14:58:35 +0200767 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine0b352bc2018-06-28 00:16:11 +0200768 size_t bits = bits_arg;
769 psa_status_t expected_status = expected_status_arg;
770 psa_status_t status;
771 psa_key_type_t type =
Gilles Peskinec93b80c2019-05-16 19:39:54 +0200772 keypair ? PSA_KEY_TYPE_RSA_KEY_PAIR : PSA_KEY_TYPE_RSA_PUBLIC_KEY;
Gilles Peskine0b352bc2018-06-28 00:16:11 +0200773 size_t buffer_size = /* Slight overapproximations */
774 keypair ? bits * 9 / 16 + 80 : bits / 8 + 20;
Gilles Peskine8cebbba2018-09-27 13:54:18 +0200775 unsigned char *buffer = NULL;
Gilles Peskine0b352bc2018-06-28 00:16:11 +0200776 unsigned char *p;
777 int ret;
778 size_t length;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +0200779 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine0b352bc2018-06-28 00:16:11 +0200780
Gilles Peskine8817f612018-12-18 00:18:46 +0100781 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine8cebbba2018-09-27 13:54:18 +0200782 ASSERT_ALLOC( buffer, buffer_size );
Gilles Peskine0b352bc2018-06-28 00:16:11 +0200783
784 TEST_ASSERT( ( ret = construct_fake_rsa_key( buffer, buffer_size, &p,
785 bits, keypair ) ) >= 0 );
786 length = ret;
787
788 /* Try importing the key */
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +0200789 psa_set_key_type( &attributes, type );
Ronald Cron5425a212020-08-04 14:58:35 +0200790 status = psa_import_key( &attributes, p, length, &key );
Gilles Peskinefe11b722018-12-18 00:24:04 +0100791 TEST_EQUAL( status, expected_status );
Gilles Peskine76b29a72019-05-28 14:08:50 +0200792
Gilles Peskine0b352bc2018-06-28 00:16:11 +0200793 if( status == PSA_SUCCESS )
Ronald Cron5425a212020-08-04 14:58:35 +0200794 PSA_ASSERT( psa_destroy_key( key ) );
Gilles Peskine0b352bc2018-06-28 00:16:11 +0200795
796exit:
797 mbedtls_free( buffer );
Gilles Peskine1153e7b2019-05-28 15:10:21 +0200798 PSA_DONE( );
Gilles Peskine0b352bc2018-06-28 00:16:11 +0200799}
800/* END_CASE */
801
802/* BEGIN_CASE */
itayzafrir3e02b3b2018-06-12 17:06:52 +0300803void import_export( data_t *data,
Moran Pekera964a8f2018-06-04 18:42:36 +0300804 int type_arg,
Gilles Peskine1ecf92c22019-05-24 15:00:06 +0200805 int usage_arg, int alg_arg,
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100806 int expected_bits,
807 int export_size_delta,
Gilles Peskineb866e2b2018-06-21 09:25:10 +0200808 int expected_export_status_arg,
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100809 int canonical_input )
810{
Ronald Cron5425a212020-08-04 14:58:35 +0200811 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100812 psa_key_type_t type = type_arg;
Gilles Peskine4abf7412018-06-18 16:35:34 +0200813 psa_algorithm_t alg = alg_arg;
Gilles Peskineb866e2b2018-06-21 09:25:10 +0200814 psa_status_t expected_export_status = expected_export_status_arg;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100815 psa_status_t status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100816 unsigned char *exported = NULL;
817 unsigned char *reexported = NULL;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100818 size_t export_size;
Jaeden Amerof24c7f82018-06-27 17:20:43 +0100819 size_t exported_length = INVALID_EXPORT_LENGTH;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100820 size_t reexported_length;
Gilles Peskine4747d192019-04-17 15:05:45 +0200821 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +0200822 psa_key_attributes_t got_attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100823
Moran Pekercb088e72018-07-17 17:36:59 +0300824 export_size = (ptrdiff_t) data->len + export_size_delta;
Gilles Peskine8cebbba2018-09-27 13:54:18 +0200825 ASSERT_ALLOC( exported, export_size );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100826 if( ! canonical_input )
Gilles Peskine8cebbba2018-09-27 13:54:18 +0200827 ASSERT_ALLOC( reexported, export_size );
Gilles Peskine8817f612018-12-18 00:18:46 +0100828 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100829
Gilles Peskine4747d192019-04-17 15:05:45 +0200830 psa_set_key_usage_flags( &attributes, usage_arg );
831 psa_set_key_algorithm( &attributes, alg );
832 psa_set_key_type( &attributes, type );
mohammad1603a97cb8c2018-03-28 03:46:26 -0700833
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100834 /* Import the key */
Ronald Cron5425a212020-08-04 14:58:35 +0200835 PSA_ASSERT( psa_import_key( &attributes, data->x, data->len, &key ) );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100836
837 /* Test the key information */
Ronald Cron5425a212020-08-04 14:58:35 +0200838 PSA_ASSERT( psa_get_key_attributes( key, &got_attributes ) );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +0200839 TEST_EQUAL( psa_get_key_type( &got_attributes ), type );
840 TEST_EQUAL( psa_get_key_bits( &got_attributes ), (size_t) expected_bits );
Gilles Peskine5fe5e272019-08-02 20:30:01 +0200841 ASSERT_NO_SLOT_NUMBER( &got_attributes );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100842
843 /* Export the key */
Ronald Cron5425a212020-08-04 14:58:35 +0200844 status = psa_export_key( key, exported, export_size, &exported_length );
Gilles Peskinefe11b722018-12-18 00:24:04 +0100845 TEST_EQUAL( status, expected_export_status );
Jaeden Amerof24c7f82018-06-27 17:20:43 +0100846
847 /* The exported length must be set by psa_export_key() to a value between 0
848 * and export_size. On errors, the exported length must be 0. */
849 TEST_ASSERT( exported_length != INVALID_EXPORT_LENGTH );
850 TEST_ASSERT( status == PSA_SUCCESS || exported_length == 0 );
851 TEST_ASSERT( exported_length <= export_size );
852
Gilles Peskinea7aa4422018-08-14 15:17:54 +0200853 TEST_ASSERT( mem_is_char( exported + exported_length, 0,
Gilles Peskine3f669c32018-06-21 09:21:51 +0200854 export_size - exported_length ) );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100855 if( status != PSA_SUCCESS )
Gilles Peskinee66ca3b2018-06-20 00:11:45 +0200856 {
Gilles Peskinefe11b722018-12-18 00:24:04 +0100857 TEST_EQUAL( exported_length, 0 );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100858 goto destroy;
Gilles Peskinee66ca3b2018-06-20 00:11:45 +0200859 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100860
Gilles Peskineea38a922021-02-13 00:05:16 +0100861 /* Run sanity checks on the exported key. For non-canonical inputs,
862 * this validates the canonical representations. For canonical inputs,
863 * this doesn't directly validate the implementation, but it still helps
864 * by cross-validating the test data with the sanity check code. */
865 if( ! mbedtls_test_psa_exercise_key( key, usage_arg, 0 ) )
Gilles Peskine8f609232018-08-11 01:24:55 +0200866 goto exit;
867
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100868 if( canonical_input )
Gilles Peskinebd7dea92018-09-27 13:57:19 +0200869 ASSERT_COMPARE( data->x, data->len, exported, exported_length );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100870 else
871 {
Ronald Cron5425a212020-08-04 14:58:35 +0200872 mbedtls_svc_key_id_t key2 = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine049c7532019-05-15 20:22:09 +0200873 PSA_ASSERT( psa_import_key( &attributes, exported, exported_length,
Ronald Cron5425a212020-08-04 14:58:35 +0200874 &key2 ) );
875 PSA_ASSERT( psa_export_key( key2,
Gilles Peskine8817f612018-12-18 00:18:46 +0100876 reexported,
877 export_size,
878 &reexported_length ) );
Gilles Peskinebd7dea92018-09-27 13:57:19 +0200879 ASSERT_COMPARE( exported, exported_length,
880 reexported, reexported_length );
Ronald Cron5425a212020-08-04 14:58:35 +0200881 PSA_ASSERT( psa_destroy_key( key2 ) );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100882 }
gabor-mezei-armceface22021-01-21 12:26:17 +0100883 TEST_ASSERT( exported_length <=
884 PSA_EXPORT_KEY_OUTPUT_SIZE( type,
885 psa_get_key_bits( &got_attributes ) ) );
886 TEST_ASSERT( exported_length <= PSA_EXPORT_KEY_PAIR_MAX_SIZE );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100887
888destroy:
889 /* Destroy the key */
Ronald Cron5425a212020-08-04 14:58:35 +0200890 PSA_ASSERT( psa_destroy_key( key ) );
891 test_operations_on_invalid_key( key );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100892
893exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +0100894 /*
895 * Key attributes may have been returned by psa_get_key_attributes()
896 * thus reset them as required.
897 */
898 psa_reset_key_attributes( &got_attributes );
899
itayzafrir3e02b3b2018-06-12 17:06:52 +0300900 mbedtls_free( exported );
901 mbedtls_free( reexported );
Gilles Peskine1153e7b2019-05-28 15:10:21 +0200902 PSA_DONE( );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100903}
904/* END_CASE */
Gilles Peskine20035e32018-02-03 22:44:14 +0100905
Moran Pekerf709f4a2018-06-06 17:26:04 +0300906/* BEGIN_CASE */
itayzafrir3e02b3b2018-06-12 17:06:52 +0300907void import_export_public_key( data_t *data,
Gilles Peskine2d277862018-06-18 15:41:12 +0200908 int type_arg,
909 int alg_arg,
Gilles Peskine49c25912018-10-29 15:15:31 +0100910 int export_size_delta,
911 int expected_export_status_arg,
912 data_t *expected_public_key )
Moran Pekerf709f4a2018-06-06 17:26:04 +0300913{
Ronald Cron5425a212020-08-04 14:58:35 +0200914 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Moran Pekerf709f4a2018-06-06 17:26:04 +0300915 psa_key_type_t type = type_arg;
Gilles Peskine4abf7412018-06-18 16:35:34 +0200916 psa_algorithm_t alg = alg_arg;
Gilles Peskineb866e2b2018-06-21 09:25:10 +0200917 psa_status_t expected_export_status = expected_export_status_arg;
Moran Pekerf709f4a2018-06-06 17:26:04 +0300918 psa_status_t status;
Moran Pekerf709f4a2018-06-06 17:26:04 +0300919 unsigned char *exported = NULL;
Gilles Peskine49c25912018-10-29 15:15:31 +0100920 size_t export_size = expected_public_key->len + export_size_delta;
Jaeden Amero2a671e92018-06-27 17:47:40 +0100921 size_t exported_length = INVALID_EXPORT_LENGTH;
Gilles Peskine4747d192019-04-17 15:05:45 +0200922 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Moran Pekerf709f4a2018-06-06 17:26:04 +0300923
Gilles Peskine8817f612018-12-18 00:18:46 +0100924 PSA_ASSERT( psa_crypto_init( ) );
Moran Pekerf709f4a2018-06-06 17:26:04 +0300925
Gilles Peskine4747d192019-04-17 15:05:45 +0200926 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_EXPORT );
927 psa_set_key_algorithm( &attributes, alg );
928 psa_set_key_type( &attributes, type );
Moran Pekerf709f4a2018-06-06 17:26:04 +0300929
930 /* Import the key */
Ronald Cron5425a212020-08-04 14:58:35 +0200931 PSA_ASSERT( psa_import_key( &attributes, data->x, data->len, &key ) );
Moran Pekerf709f4a2018-06-06 17:26:04 +0300932
Gilles Peskine49c25912018-10-29 15:15:31 +0100933 /* Export the public key */
934 ASSERT_ALLOC( exported, export_size );
Ronald Cron5425a212020-08-04 14:58:35 +0200935 status = psa_export_public_key( key,
Gilles Peskine2d277862018-06-18 15:41:12 +0200936 exported, export_size,
937 &exported_length );
Gilles Peskinefe11b722018-12-18 00:24:04 +0100938 TEST_EQUAL( status, expected_export_status );
Gilles Peskine49c25912018-10-29 15:15:31 +0100939 if( status == PSA_SUCCESS )
Gilles Peskined8b7d4f2018-10-29 15:18:41 +0100940 {
Gilles Peskinec93b80c2019-05-16 19:39:54 +0200941 psa_key_type_t public_type = PSA_KEY_TYPE_PUBLIC_KEY_OF_KEY_PAIR( type );
Gilles Peskined8b7d4f2018-10-29 15:18:41 +0100942 size_t bits;
Ronald Cron5425a212020-08-04 14:58:35 +0200943 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +0200944 bits = psa_get_key_bits( &attributes );
Gilles Peskined8b7d4f2018-10-29 15:18:41 +0100945 TEST_ASSERT( expected_public_key->len <=
gabor-mezei-armcbcec212020-12-18 14:23:51 +0100946 PSA_EXPORT_KEY_OUTPUT_SIZE( public_type, bits ) );
gabor-mezei-armceface22021-01-21 12:26:17 +0100947 TEST_ASSERT( expected_public_key->len <=
948 PSA_EXPORT_PUBLIC_KEY_OUTPUT_SIZE( public_type, bits ) );
949 TEST_ASSERT( expected_public_key->len <=
950 PSA_EXPORT_PUBLIC_KEY_MAX_SIZE );
Gilles Peskine49c25912018-10-29 15:15:31 +0100951 ASSERT_COMPARE( expected_public_key->x, expected_public_key->len,
952 exported, exported_length );
Gilles Peskined8b7d4f2018-10-29 15:18:41 +0100953 }
Moran Pekerf709f4a2018-06-06 17:26:04 +0300954
955exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +0100956 /*
957 * Key attributes may have been returned by psa_get_key_attributes()
958 * thus reset them as required.
959 */
960 psa_reset_key_attributes( &attributes );
961
itayzafrir3e02b3b2018-06-12 17:06:52 +0300962 mbedtls_free( exported );
Ronald Cron5425a212020-08-04 14:58:35 +0200963 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +0200964 PSA_DONE( );
Moran Pekerf709f4a2018-06-06 17:26:04 +0300965}
966/* END_CASE */
967
Gilles Peskine20035e32018-02-03 22:44:14 +0100968/* BEGIN_CASE */
Gilles Peskinea680c7a2018-06-26 16:12:43 +0200969void import_and_exercise_key( data_t *data,
970 int type_arg,
971 int bits_arg,
972 int alg_arg )
973{
Ronald Cron5425a212020-08-04 14:58:35 +0200974 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskinea680c7a2018-06-26 16:12:43 +0200975 psa_key_type_t type = type_arg;
976 size_t bits = bits_arg;
977 psa_algorithm_t alg = alg_arg;
Gilles Peskinec18e25f2021-02-12 23:48:20 +0100978 psa_key_usage_t usage = mbedtls_test_psa_usage_to_exercise( type, alg );
Gilles Peskine4747d192019-04-17 15:05:45 +0200979 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +0200980 psa_key_attributes_t got_attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskinea680c7a2018-06-26 16:12:43 +0200981
Gilles Peskine8817f612018-12-18 00:18:46 +0100982 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskinea680c7a2018-06-26 16:12:43 +0200983
Gilles Peskine4747d192019-04-17 15:05:45 +0200984 psa_set_key_usage_flags( &attributes, usage );
985 psa_set_key_algorithm( &attributes, alg );
986 psa_set_key_type( &attributes, type );
Gilles Peskinea680c7a2018-06-26 16:12:43 +0200987
988 /* Import the key */
Ronald Cron5425a212020-08-04 14:58:35 +0200989 PSA_ASSERT( psa_import_key( &attributes, data->x, data->len, &key ) );
Gilles Peskinea680c7a2018-06-26 16:12:43 +0200990
991 /* Test the key information */
Ronald Cron5425a212020-08-04 14:58:35 +0200992 PSA_ASSERT( psa_get_key_attributes( key, &got_attributes ) );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +0200993 TEST_EQUAL( psa_get_key_type( &got_attributes ), type );
994 TEST_EQUAL( psa_get_key_bits( &got_attributes ), bits );
Gilles Peskinea680c7a2018-06-26 16:12:43 +0200995
996 /* Do something with the key according to its type and permitted usage. */
Gilles Peskinec18e25f2021-02-12 23:48:20 +0100997 if( ! mbedtls_test_psa_exercise_key( key, usage, alg ) )
Gilles Peskine02b75072018-07-01 22:31:34 +0200998 goto exit;
Gilles Peskinea680c7a2018-06-26 16:12:43 +0200999
Ronald Cron5425a212020-08-04 14:58:35 +02001000 PSA_ASSERT( psa_destroy_key( key ) );
1001 test_operations_on_invalid_key( key );
Gilles Peskine4cf3a432019-04-18 22:28:52 +02001002
Gilles Peskinea680c7a2018-06-26 16:12:43 +02001003exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +01001004 /*
1005 * Key attributes may have been returned by psa_get_key_attributes()
1006 * thus reset them as required.
1007 */
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02001008 psa_reset_key_attributes( &got_attributes );
Ronald Cron3a4f0e32020-11-19 17:55:23 +01001009
1010 psa_reset_key_attributes( &attributes );
1011 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02001012 PSA_DONE( );
Gilles Peskinea680c7a2018-06-26 16:12:43 +02001013}
1014/* END_CASE */
1015
1016/* BEGIN_CASE */
Gilles Peskine06c28892019-11-26 18:07:46 +01001017void effective_key_attributes( int type_arg, int expected_type_arg,
1018 int bits_arg, int expected_bits_arg,
1019 int usage_arg, int expected_usage_arg,
1020 int alg_arg, int expected_alg_arg )
Gilles Peskined5b33222018-06-18 22:20:03 +02001021{
Ronald Cron5425a212020-08-04 14:58:35 +02001022 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine1a960492019-11-26 17:12:21 +01001023 psa_key_type_t key_type = type_arg;
Gilles Peskine06c28892019-11-26 18:07:46 +01001024 psa_key_type_t expected_key_type = expected_type_arg;
Gilles Peskine1a960492019-11-26 17:12:21 +01001025 size_t bits = bits_arg;
Gilles Peskine06c28892019-11-26 18:07:46 +01001026 size_t expected_bits = expected_bits_arg;
Gilles Peskined5b33222018-06-18 22:20:03 +02001027 psa_algorithm_t alg = alg_arg;
Gilles Peskine06c28892019-11-26 18:07:46 +01001028 psa_algorithm_t expected_alg = expected_alg_arg;
Gilles Peskined5b33222018-06-18 22:20:03 +02001029 psa_key_usage_t usage = usage_arg;
Gilles Peskine06c28892019-11-26 18:07:46 +01001030 psa_key_usage_t expected_usage = expected_usage_arg;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001031 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskined5b33222018-06-18 22:20:03 +02001032
Gilles Peskine8817f612018-12-18 00:18:46 +01001033 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskined5b33222018-06-18 22:20:03 +02001034
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001035 psa_set_key_usage_flags( &attributes, usage );
1036 psa_set_key_algorithm( &attributes, alg );
1037 psa_set_key_type( &attributes, key_type );
Gilles Peskine1a960492019-11-26 17:12:21 +01001038 psa_set_key_bits( &attributes, bits );
Gilles Peskined5b33222018-06-18 22:20:03 +02001039
Ronald Cron5425a212020-08-04 14:58:35 +02001040 PSA_ASSERT( psa_generate_key( &attributes, &key ) );
Gilles Peskine1a960492019-11-26 17:12:21 +01001041 psa_reset_key_attributes( &attributes );
Gilles Peskined5b33222018-06-18 22:20:03 +02001042
Ronald Cron5425a212020-08-04 14:58:35 +02001043 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
Gilles Peskine06c28892019-11-26 18:07:46 +01001044 TEST_EQUAL( psa_get_key_type( &attributes ), expected_key_type );
1045 TEST_EQUAL( psa_get_key_bits( &attributes ), expected_bits );
1046 TEST_EQUAL( psa_get_key_usage_flags( &attributes ), expected_usage );
1047 TEST_EQUAL( psa_get_key_algorithm( &attributes ), expected_alg );
Gilles Peskined5b33222018-06-18 22:20:03 +02001048
1049exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +01001050 /*
1051 * Key attributes may have been returned by psa_get_key_attributes()
1052 * thus reset them as required.
1053 */
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02001054 psa_reset_key_attributes( &attributes );
Ronald Cron3a4f0e32020-11-19 17:55:23 +01001055
1056 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02001057 PSA_DONE( );
Gilles Peskined5b33222018-06-18 22:20:03 +02001058}
1059/* END_CASE */
1060
1061/* BEGIN_CASE */
Gilles Peskine06c28892019-11-26 18:07:46 +01001062void check_key_policy( int type_arg, int bits_arg,
1063 int usage_arg, int alg_arg )
1064{
1065 test_effective_key_attributes( type_arg, type_arg, bits_arg, bits_arg,
1066 usage_arg, usage_arg, alg_arg, alg_arg );
1067 goto exit;
1068}
1069/* END_CASE */
1070
1071/* BEGIN_CASE */
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001072void key_attributes_init( )
Jaeden Amero70261c52019-01-04 11:47:20 +00001073{
1074 /* Test each valid way of initializing the object, except for `= {0}`, as
1075 * Clang 5 complains when `-Wmissing-field-initializers` is used, even
1076 * though it's OK by the C standard. We could test for this, but we'd need
1077 * to supress the Clang warning for the test. */
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001078 psa_key_attributes_t func = psa_key_attributes_init( );
1079 psa_key_attributes_t init = PSA_KEY_ATTRIBUTES_INIT;
1080 psa_key_attributes_t zero;
Jaeden Amero70261c52019-01-04 11:47:20 +00001081
1082 memset( &zero, 0, sizeof( zero ) );
1083
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001084 TEST_EQUAL( psa_get_key_lifetime( &func ), PSA_KEY_LIFETIME_VOLATILE );
1085 TEST_EQUAL( psa_get_key_lifetime( &init ), PSA_KEY_LIFETIME_VOLATILE );
1086 TEST_EQUAL( psa_get_key_lifetime( &zero ), PSA_KEY_LIFETIME_VOLATILE );
Jaeden Amero5229bbb2019-02-07 16:33:37 +00001087
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001088 TEST_EQUAL( psa_get_key_type( &func ), 0 );
1089 TEST_EQUAL( psa_get_key_type( &init ), 0 );
1090 TEST_EQUAL( psa_get_key_type( &zero ), 0 );
1091
1092 TEST_EQUAL( psa_get_key_bits( &func ), 0 );
1093 TEST_EQUAL( psa_get_key_bits( &init ), 0 );
1094 TEST_EQUAL( psa_get_key_bits( &zero ), 0 );
1095
1096 TEST_EQUAL( psa_get_key_usage_flags( &func ), 0 );
1097 TEST_EQUAL( psa_get_key_usage_flags( &init ), 0 );
1098 TEST_EQUAL( psa_get_key_usage_flags( &zero ), 0 );
1099
1100 TEST_EQUAL( psa_get_key_algorithm( &func ), 0 );
1101 TEST_EQUAL( psa_get_key_algorithm( &init ), 0 );
1102 TEST_EQUAL( psa_get_key_algorithm( &zero ), 0 );
Jaeden Amero70261c52019-01-04 11:47:20 +00001103}
1104/* END_CASE */
1105
1106/* BEGIN_CASE */
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001107void mac_key_policy( int policy_usage,
1108 int policy_alg,
1109 int key_type,
1110 data_t *key_data,
Steven Cooremanb3ce8152021-02-18 12:03:50 +01001111 int exercise_alg,
1112 int expected_status_arg )
Gilles Peskined5b33222018-06-18 22:20:03 +02001113{
Ronald Cron5425a212020-08-04 14:58:35 +02001114 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001115 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Jaeden Amero769ce272019-01-04 11:48:03 +00001116 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001117 psa_status_t status;
Steven Cooremanb3ce8152021-02-18 12:03:50 +01001118 psa_status_t expected_status = expected_status_arg;
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001119 unsigned char mac[PSA_MAC_MAX_SIZE];
Gilles Peskined5b33222018-06-18 22:20:03 +02001120
Gilles Peskine8817f612018-12-18 00:18:46 +01001121 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskined5b33222018-06-18 22:20:03 +02001122
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001123 psa_set_key_usage_flags( &attributes, policy_usage );
1124 psa_set_key_algorithm( &attributes, policy_alg );
1125 psa_set_key_type( &attributes, key_type );
Gilles Peskined5b33222018-06-18 22:20:03 +02001126
Gilles Peskine049c7532019-05-15 20:22:09 +02001127 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02001128 &key ) );
Gilles Peskined5b33222018-06-18 22:20:03 +02001129
Ronald Cron5425a212020-08-04 14:58:35 +02001130 status = psa_mac_sign_setup( &operation, key, exercise_alg );
Steven Cooremanb3ce8152021-02-18 12:03:50 +01001131 if( ( policy_usage & PSA_KEY_USAGE_SIGN_HASH ) == 0 )
Gilles Peskinefe11b722018-12-18 00:24:04 +01001132 TEST_EQUAL( status, PSA_ERROR_NOT_PERMITTED );
Steven Cooremanb3ce8152021-02-18 12:03:50 +01001133 else
1134 TEST_EQUAL( status, expected_status );
1135
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001136 psa_mac_abort( &operation );
Gilles Peskined5b33222018-06-18 22:20:03 +02001137
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001138 memset( mac, 0, sizeof( mac ) );
Ronald Cron5425a212020-08-04 14:58:35 +02001139 status = psa_mac_verify_setup( &operation, key, exercise_alg );
Steven Cooremanb3ce8152021-02-18 12:03:50 +01001140 if( ( policy_usage & PSA_KEY_USAGE_VERIFY_HASH ) == 0 )
Gilles Peskinefe11b722018-12-18 00:24:04 +01001141 TEST_EQUAL( status, PSA_ERROR_NOT_PERMITTED );
Steven Cooremanb3ce8152021-02-18 12:03:50 +01001142 else
1143 TEST_EQUAL( status, expected_status );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001144
1145exit:
1146 psa_mac_abort( &operation );
Ronald Cron5425a212020-08-04 14:58:35 +02001147 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02001148 PSA_DONE( );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001149}
1150/* END_CASE */
1151
1152/* BEGIN_CASE */
1153void cipher_key_policy( int policy_usage,
1154 int policy_alg,
1155 int key_type,
1156 data_t *key_data,
1157 int exercise_alg )
1158{
Ronald Cron5425a212020-08-04 14:58:35 +02001159 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001160 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Jaeden Amero5bae2272019-01-04 11:48:27 +00001161 psa_cipher_operation_t operation = PSA_CIPHER_OPERATION_INIT;
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001162 psa_status_t status;
1163
Gilles Peskine8817f612018-12-18 00:18:46 +01001164 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001165
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001166 psa_set_key_usage_flags( &attributes, policy_usage );
1167 psa_set_key_algorithm( &attributes, policy_alg );
1168 psa_set_key_type( &attributes, key_type );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001169
Gilles Peskine049c7532019-05-15 20:22:09 +02001170 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02001171 &key ) );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001172
Ronald Cron5425a212020-08-04 14:58:35 +02001173 status = psa_cipher_encrypt_setup( &operation, key, exercise_alg );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001174 if( policy_alg == exercise_alg &&
1175 ( policy_usage & PSA_KEY_USAGE_ENCRYPT ) != 0 )
Gilles Peskine8817f612018-12-18 00:18:46 +01001176 PSA_ASSERT( status );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001177 else
Gilles Peskinefe11b722018-12-18 00:24:04 +01001178 TEST_EQUAL( status, PSA_ERROR_NOT_PERMITTED );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001179 psa_cipher_abort( &operation );
1180
Ronald Cron5425a212020-08-04 14:58:35 +02001181 status = psa_cipher_decrypt_setup( &operation, key, exercise_alg );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001182 if( policy_alg == exercise_alg &&
1183 ( policy_usage & PSA_KEY_USAGE_DECRYPT ) != 0 )
Gilles Peskine8817f612018-12-18 00:18:46 +01001184 PSA_ASSERT( status );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001185 else
Gilles Peskinefe11b722018-12-18 00:24:04 +01001186 TEST_EQUAL( status, PSA_ERROR_NOT_PERMITTED );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001187
1188exit:
1189 psa_cipher_abort( &operation );
Ronald Cron5425a212020-08-04 14:58:35 +02001190 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02001191 PSA_DONE( );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001192}
1193/* END_CASE */
1194
1195/* BEGIN_CASE */
1196void aead_key_policy( int policy_usage,
1197 int policy_alg,
1198 int key_type,
1199 data_t *key_data,
1200 int nonce_length_arg,
1201 int tag_length_arg,
Steven Cooremanb3ce8152021-02-18 12:03:50 +01001202 int exercise_alg,
1203 int expected_status_arg )
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001204{
Ronald Cron5425a212020-08-04 14:58:35 +02001205 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001206 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001207 psa_status_t status;
Steven Cooremanb3ce8152021-02-18 12:03:50 +01001208 psa_status_t expected_status = expected_status_arg;
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001209 unsigned char nonce[16] = {0};
1210 size_t nonce_length = nonce_length_arg;
1211 unsigned char tag[16];
1212 size_t tag_length = tag_length_arg;
1213 size_t output_length;
1214
1215 TEST_ASSERT( nonce_length <= sizeof( nonce ) );
1216 TEST_ASSERT( tag_length <= sizeof( tag ) );
1217
Gilles Peskine8817f612018-12-18 00:18:46 +01001218 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001219
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001220 psa_set_key_usage_flags( &attributes, policy_usage );
1221 psa_set_key_algorithm( &attributes, policy_alg );
1222 psa_set_key_type( &attributes, key_type );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001223
Gilles Peskine049c7532019-05-15 20:22:09 +02001224 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02001225 &key ) );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001226
Ronald Cron5425a212020-08-04 14:58:35 +02001227 status = psa_aead_encrypt( key, exercise_alg,
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001228 nonce, nonce_length,
1229 NULL, 0,
1230 NULL, 0,
1231 tag, tag_length,
1232 &output_length );
Steven Cooremanb3ce8152021-02-18 12:03:50 +01001233 if( ( policy_usage & PSA_KEY_USAGE_ENCRYPT ) != 0 )
1234 TEST_EQUAL( status, expected_status );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001235 else
Gilles Peskinefe11b722018-12-18 00:24:04 +01001236 TEST_EQUAL( status, PSA_ERROR_NOT_PERMITTED );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001237
1238 memset( tag, 0, sizeof( tag ) );
Ronald Cron5425a212020-08-04 14:58:35 +02001239 status = psa_aead_decrypt( key, exercise_alg,
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001240 nonce, nonce_length,
1241 NULL, 0,
1242 tag, tag_length,
1243 NULL, 0,
1244 &output_length );
Steven Cooremanb3ce8152021-02-18 12:03:50 +01001245 if( ( policy_usage & PSA_KEY_USAGE_DECRYPT ) == 0 )
1246 TEST_EQUAL( status, PSA_ERROR_NOT_PERMITTED );
1247 else if( expected_status == PSA_SUCCESS )
Gilles Peskinefe11b722018-12-18 00:24:04 +01001248 TEST_EQUAL( status, PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001249 else
Steven Cooremanb3ce8152021-02-18 12:03:50 +01001250 TEST_EQUAL( status, expected_status );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001251
1252exit:
Ronald Cron5425a212020-08-04 14:58:35 +02001253 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02001254 PSA_DONE( );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001255}
1256/* END_CASE */
1257
1258/* BEGIN_CASE */
1259void asymmetric_encryption_key_policy( int policy_usage,
1260 int policy_alg,
1261 int key_type,
1262 data_t *key_data,
1263 int exercise_alg )
1264{
Ronald Cron5425a212020-08-04 14:58:35 +02001265 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001266 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001267 psa_status_t status;
1268 size_t key_bits;
1269 size_t buffer_length;
1270 unsigned char *buffer = NULL;
1271 size_t output_length;
1272
Gilles Peskine8817f612018-12-18 00:18:46 +01001273 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001274
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001275 psa_set_key_usage_flags( &attributes, policy_usage );
1276 psa_set_key_algorithm( &attributes, policy_alg );
1277 psa_set_key_type( &attributes, key_type );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001278
Gilles Peskine049c7532019-05-15 20:22:09 +02001279 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02001280 &key ) );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001281
Ronald Cron5425a212020-08-04 14:58:35 +02001282 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001283 key_bits = psa_get_key_bits( &attributes );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001284 buffer_length = PSA_ASYMMETRIC_ENCRYPT_OUTPUT_SIZE( key_type, key_bits,
1285 exercise_alg );
Gilles Peskine8cebbba2018-09-27 13:54:18 +02001286 ASSERT_ALLOC( buffer, buffer_length );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001287
Ronald Cron5425a212020-08-04 14:58:35 +02001288 status = psa_asymmetric_encrypt( key, exercise_alg,
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001289 NULL, 0,
1290 NULL, 0,
1291 buffer, buffer_length,
1292 &output_length );
1293 if( policy_alg == exercise_alg &&
1294 ( policy_usage & PSA_KEY_USAGE_ENCRYPT ) != 0 )
Gilles Peskine8817f612018-12-18 00:18:46 +01001295 PSA_ASSERT( status );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001296 else
Gilles Peskinefe11b722018-12-18 00:24:04 +01001297 TEST_EQUAL( status, PSA_ERROR_NOT_PERMITTED );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001298
Gilles Peskinef7ab5ad2018-09-26 18:19:24 +02001299 if( buffer_length != 0 )
1300 memset( buffer, 0, buffer_length );
Ronald Cron5425a212020-08-04 14:58:35 +02001301 status = psa_asymmetric_decrypt( key, exercise_alg,
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001302 buffer, buffer_length,
1303 NULL, 0,
1304 buffer, buffer_length,
1305 &output_length );
1306 if( policy_alg == exercise_alg &&
1307 ( policy_usage & PSA_KEY_USAGE_DECRYPT ) != 0 )
Gilles Peskinefe11b722018-12-18 00:24:04 +01001308 TEST_EQUAL( status, PSA_ERROR_INVALID_PADDING );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001309 else
Gilles Peskinefe11b722018-12-18 00:24:04 +01001310 TEST_EQUAL( status, PSA_ERROR_NOT_PERMITTED );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001311
1312exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +01001313 /*
1314 * Key attributes may have been returned by psa_get_key_attributes()
1315 * thus reset them as required.
1316 */
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02001317 psa_reset_key_attributes( &attributes );
Ronald Cron3a4f0e32020-11-19 17:55:23 +01001318
1319 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02001320 PSA_DONE( );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001321 mbedtls_free( buffer );
1322}
1323/* END_CASE */
1324
1325/* BEGIN_CASE */
1326void asymmetric_signature_key_policy( int policy_usage,
1327 int policy_alg,
1328 int key_type,
1329 data_t *key_data,
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001330 int exercise_alg,
1331 int payload_length_arg )
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001332{
Ronald Cron5425a212020-08-04 14:58:35 +02001333 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001334 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001335 psa_status_t status;
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001336 unsigned char payload[PSA_HASH_MAX_SIZE] = {1};
1337 /* If `payload_length_arg > 0`, `exercise_alg` is supposed to be
1338 * compatible with the policy and `payload_length_arg` is supposed to be
1339 * a valid input length to sign. If `payload_length_arg <= 0`,
1340 * `exercise_alg` is supposed to be forbidden by the policy. */
1341 int compatible_alg = payload_length_arg > 0;
1342 size_t payload_length = compatible_alg ? payload_length_arg : 0;
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001343 unsigned char signature[PSA_SIGNATURE_MAX_SIZE] = {0};
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001344 size_t signature_length;
1345
Gilles Peskine8817f612018-12-18 00:18:46 +01001346 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001347
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001348 psa_set_key_usage_flags( &attributes, policy_usage );
1349 psa_set_key_algorithm( &attributes, policy_alg );
1350 psa_set_key_type( &attributes, key_type );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001351
Gilles Peskine049c7532019-05-15 20:22:09 +02001352 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02001353 &key ) );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001354
Ronald Cron5425a212020-08-04 14:58:35 +02001355 status = psa_sign_hash( key, exercise_alg,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001356 payload, payload_length,
1357 signature, sizeof( signature ),
1358 &signature_length );
1359 if( compatible_alg && ( policy_usage & PSA_KEY_USAGE_SIGN_HASH ) != 0 )
Gilles Peskine8817f612018-12-18 00:18:46 +01001360 PSA_ASSERT( status );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001361 else
Gilles Peskinefe11b722018-12-18 00:24:04 +01001362 TEST_EQUAL( status, PSA_ERROR_NOT_PERMITTED );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001363
1364 memset( signature, 0, sizeof( signature ) );
Ronald Cron5425a212020-08-04 14:58:35 +02001365 status = psa_verify_hash( key, exercise_alg,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001366 payload, payload_length,
1367 signature, sizeof( signature ) );
1368 if( compatible_alg && ( policy_usage & PSA_KEY_USAGE_VERIFY_HASH ) != 0 )
Gilles Peskinefe11b722018-12-18 00:24:04 +01001369 TEST_EQUAL( status, PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001370 else
Gilles Peskinefe11b722018-12-18 00:24:04 +01001371 TEST_EQUAL( status, PSA_ERROR_NOT_PERMITTED );
Gilles Peskined5b33222018-06-18 22:20:03 +02001372
1373exit:
Ronald Cron5425a212020-08-04 14:58:35 +02001374 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02001375 PSA_DONE( );
Gilles Peskined5b33222018-06-18 22:20:03 +02001376}
1377/* END_CASE */
1378
Janos Follathba3fab92019-06-11 14:50:16 +01001379/* BEGIN_CASE */
Gilles Peskineea0fb492018-07-12 17:17:20 +02001380void derive_key_policy( int policy_usage,
1381 int policy_alg,
1382 int key_type,
1383 data_t *key_data,
1384 int exercise_alg )
1385{
Ronald Cron5425a212020-08-04 14:58:35 +02001386 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001387 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02001388 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Gilles Peskineea0fb492018-07-12 17:17:20 +02001389 psa_status_t status;
1390
Gilles Peskine8817f612018-12-18 00:18:46 +01001391 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskineea0fb492018-07-12 17:17:20 +02001392
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001393 psa_set_key_usage_flags( &attributes, policy_usage );
1394 psa_set_key_algorithm( &attributes, policy_alg );
1395 psa_set_key_type( &attributes, key_type );
Gilles Peskineea0fb492018-07-12 17:17:20 +02001396
Gilles Peskine049c7532019-05-15 20:22:09 +02001397 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02001398 &key ) );
Gilles Peskineea0fb492018-07-12 17:17:20 +02001399
Janos Follathba3fab92019-06-11 14:50:16 +01001400 PSA_ASSERT( psa_key_derivation_setup( &operation, exercise_alg ) );
1401
1402 if( PSA_ALG_IS_TLS12_PRF( exercise_alg ) ||
1403 PSA_ALG_IS_TLS12_PSK_TO_MS( exercise_alg ) )
Janos Follath0c1ed842019-06-28 13:35:36 +01001404 {
Janos Follathba3fab92019-06-11 14:50:16 +01001405 PSA_ASSERT( psa_key_derivation_input_bytes(
1406 &operation,
1407 PSA_KEY_DERIVATION_INPUT_SEED,
1408 (const uint8_t*) "", 0) );
Janos Follath0c1ed842019-06-28 13:35:36 +01001409 }
Janos Follathba3fab92019-06-11 14:50:16 +01001410
1411 status = psa_key_derivation_input_key( &operation,
1412 PSA_KEY_DERIVATION_INPUT_SECRET,
Ronald Cron5425a212020-08-04 14:58:35 +02001413 key );
Janos Follathba3fab92019-06-11 14:50:16 +01001414
Gilles Peskineea0fb492018-07-12 17:17:20 +02001415 if( policy_alg == exercise_alg &&
1416 ( policy_usage & PSA_KEY_USAGE_DERIVE ) != 0 )
Gilles Peskine8817f612018-12-18 00:18:46 +01001417 PSA_ASSERT( status );
Gilles Peskineea0fb492018-07-12 17:17:20 +02001418 else
Gilles Peskinefe11b722018-12-18 00:24:04 +01001419 TEST_EQUAL( status, PSA_ERROR_NOT_PERMITTED );
Gilles Peskineea0fb492018-07-12 17:17:20 +02001420
1421exit:
Gilles Peskine51ae0e42019-05-16 17:31:03 +02001422 psa_key_derivation_abort( &operation );
Ronald Cron5425a212020-08-04 14:58:35 +02001423 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02001424 PSA_DONE( );
Gilles Peskineea0fb492018-07-12 17:17:20 +02001425}
1426/* END_CASE */
1427
1428/* BEGIN_CASE */
Gilles Peskine01d718c2018-09-18 12:01:02 +02001429void agreement_key_policy( int policy_usage,
1430 int policy_alg,
1431 int key_type_arg,
1432 data_t *key_data,
Steven Cooremance48e852020-10-05 16:02:45 +02001433 int exercise_alg,
1434 int expected_status_arg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02001435{
Ronald Cron5425a212020-08-04 14:58:35 +02001436 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001437 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine01d718c2018-09-18 12:01:02 +02001438 psa_key_type_t key_type = key_type_arg;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02001439 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Gilles Peskine01d718c2018-09-18 12:01:02 +02001440 psa_status_t status;
Steven Cooremance48e852020-10-05 16:02:45 +02001441 psa_status_t expected_status = expected_status_arg;
Gilles Peskine01d718c2018-09-18 12:01:02 +02001442
Gilles Peskine8817f612018-12-18 00:18:46 +01001443 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine01d718c2018-09-18 12:01:02 +02001444
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001445 psa_set_key_usage_flags( &attributes, policy_usage );
1446 psa_set_key_algorithm( &attributes, policy_alg );
1447 psa_set_key_type( &attributes, key_type );
Gilles Peskine01d718c2018-09-18 12:01:02 +02001448
Gilles Peskine049c7532019-05-15 20:22:09 +02001449 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02001450 &key ) );
Gilles Peskine01d718c2018-09-18 12:01:02 +02001451
Gilles Peskine51ae0e42019-05-16 17:31:03 +02001452 PSA_ASSERT( psa_key_derivation_setup( &operation, exercise_alg ) );
Gilles Peskinec18e25f2021-02-12 23:48:20 +01001453 status = mbedtls_test_psa_key_agreement_with_self( &operation, key );
Gilles Peskine01d718c2018-09-18 12:01:02 +02001454
Steven Cooremance48e852020-10-05 16:02:45 +02001455 TEST_EQUAL( status, expected_status );
Gilles Peskine01d718c2018-09-18 12:01:02 +02001456
1457exit:
Gilles Peskine51ae0e42019-05-16 17:31:03 +02001458 psa_key_derivation_abort( &operation );
Ronald Cron5425a212020-08-04 14:58:35 +02001459 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02001460 PSA_DONE( );
Gilles Peskine01d718c2018-09-18 12:01:02 +02001461}
1462/* END_CASE */
1463
1464/* BEGIN_CASE */
Gilles Peskine96f0b3b2019-05-10 19:33:38 +02001465void key_policy_alg2( int key_type_arg, data_t *key_data,
1466 int usage_arg, int alg_arg, int alg2_arg )
1467{
Ronald Cron5425a212020-08-04 14:58:35 +02001468 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine96f0b3b2019-05-10 19:33:38 +02001469 psa_key_type_t key_type = key_type_arg;
1470 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
1471 psa_key_attributes_t got_attributes = PSA_KEY_ATTRIBUTES_INIT;
1472 psa_key_usage_t usage = usage_arg;
1473 psa_algorithm_t alg = alg_arg;
1474 psa_algorithm_t alg2 = alg2_arg;
1475
1476 PSA_ASSERT( psa_crypto_init( ) );
1477
1478 psa_set_key_usage_flags( &attributes, usage );
1479 psa_set_key_algorithm( &attributes, alg );
1480 psa_set_key_enrollment_algorithm( &attributes, alg2 );
1481 psa_set_key_type( &attributes, key_type );
1482 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02001483 &key ) );
Gilles Peskine96f0b3b2019-05-10 19:33:38 +02001484
Ronald Cron5425a212020-08-04 14:58:35 +02001485 PSA_ASSERT( psa_get_key_attributes( key, &got_attributes ) );
Gilles Peskine96f0b3b2019-05-10 19:33:38 +02001486 TEST_EQUAL( psa_get_key_usage_flags( &got_attributes ), usage );
1487 TEST_EQUAL( psa_get_key_algorithm( &got_attributes ), alg );
1488 TEST_EQUAL( psa_get_key_enrollment_algorithm( &got_attributes ), alg2 );
1489
Gilles Peskinec18e25f2021-02-12 23:48:20 +01001490 if( ! mbedtls_test_psa_exercise_key( key, usage, alg ) )
Gilles Peskine96f0b3b2019-05-10 19:33:38 +02001491 goto exit;
Gilles Peskinec18e25f2021-02-12 23:48:20 +01001492 if( ! mbedtls_test_psa_exercise_key( key, usage, alg2 ) )
Gilles Peskine96f0b3b2019-05-10 19:33:38 +02001493 goto exit;
1494
1495exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +01001496 /*
1497 * Key attributes may have been returned by psa_get_key_attributes()
1498 * thus reset them as required.
1499 */
1500 psa_reset_key_attributes( &got_attributes );
1501
Ronald Cron5425a212020-08-04 14:58:35 +02001502 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02001503 PSA_DONE( );
Gilles Peskine96f0b3b2019-05-10 19:33:38 +02001504}
1505/* END_CASE */
1506
1507/* BEGIN_CASE */
Gilles Peskine04ee2d22019-04-11 21:25:46 +02001508void raw_agreement_key_policy( int policy_usage,
1509 int policy_alg,
1510 int key_type_arg,
1511 data_t *key_data,
Steven Cooremance48e852020-10-05 16:02:45 +02001512 int exercise_alg,
1513 int expected_status_arg )
Gilles Peskine04ee2d22019-04-11 21:25:46 +02001514{
Ronald Cron5425a212020-08-04 14:58:35 +02001515 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001516 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine04ee2d22019-04-11 21:25:46 +02001517 psa_key_type_t key_type = key_type_arg;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02001518 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Gilles Peskine04ee2d22019-04-11 21:25:46 +02001519 psa_status_t status;
Steven Cooremance48e852020-10-05 16:02:45 +02001520 psa_status_t expected_status = expected_status_arg;
Gilles Peskine04ee2d22019-04-11 21:25:46 +02001521
1522 PSA_ASSERT( psa_crypto_init( ) );
1523
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001524 psa_set_key_usage_flags( &attributes, policy_usage );
1525 psa_set_key_algorithm( &attributes, policy_alg );
1526 psa_set_key_type( &attributes, key_type );
Gilles Peskine04ee2d22019-04-11 21:25:46 +02001527
Gilles Peskine049c7532019-05-15 20:22:09 +02001528 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02001529 &key ) );
Gilles Peskine04ee2d22019-04-11 21:25:46 +02001530
Gilles Peskinec18e25f2021-02-12 23:48:20 +01001531 status = mbedtls_test_psa_raw_key_agreement_with_self( exercise_alg, key );
Gilles Peskine04ee2d22019-04-11 21:25:46 +02001532
Steven Cooremance48e852020-10-05 16:02:45 +02001533 TEST_EQUAL( status, expected_status );
Gilles Peskine04ee2d22019-04-11 21:25:46 +02001534
1535exit:
Gilles Peskine51ae0e42019-05-16 17:31:03 +02001536 psa_key_derivation_abort( &operation );
Ronald Cron5425a212020-08-04 14:58:35 +02001537 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02001538 PSA_DONE( );
Gilles Peskine04ee2d22019-04-11 21:25:46 +02001539}
1540/* END_CASE */
1541
1542/* BEGIN_CASE */
Gilles Peskinebcdd44b2019-05-20 17:28:11 +02001543void copy_success( int source_usage_arg,
1544 int source_alg_arg, int source_alg2_arg,
Gilles Peskine4a644642019-05-03 17:14:08 +02001545 int type_arg, data_t *material,
1546 int copy_attributes,
Gilles Peskinebcdd44b2019-05-20 17:28:11 +02001547 int target_usage_arg,
1548 int target_alg_arg, int target_alg2_arg,
1549 int expected_usage_arg,
1550 int expected_alg_arg, int expected_alg2_arg )
Gilles Peskine57ab7212019-01-28 13:03:09 +01001551{
Gilles Peskineca25db92019-04-19 11:43:08 +02001552 psa_key_attributes_t source_attributes = PSA_KEY_ATTRIBUTES_INIT;
1553 psa_key_attributes_t target_attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine57ab7212019-01-28 13:03:09 +01001554 psa_key_usage_t expected_usage = expected_usage_arg;
1555 psa_algorithm_t expected_alg = expected_alg_arg;
Gilles Peskinebcdd44b2019-05-20 17:28:11 +02001556 psa_algorithm_t expected_alg2 = expected_alg2_arg;
Ronald Cron5425a212020-08-04 14:58:35 +02001557 mbedtls_svc_key_id_t source_key = MBEDTLS_SVC_KEY_ID_INIT;
1558 mbedtls_svc_key_id_t target_key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine57ab7212019-01-28 13:03:09 +01001559 uint8_t *export_buffer = NULL;
1560
Gilles Peskine57ab7212019-01-28 13:03:09 +01001561 PSA_ASSERT( psa_crypto_init( ) );
1562
Gilles Peskineca25db92019-04-19 11:43:08 +02001563 /* Prepare the source key. */
1564 psa_set_key_usage_flags( &source_attributes, source_usage_arg );
1565 psa_set_key_algorithm( &source_attributes, source_alg_arg );
Gilles Peskinebcdd44b2019-05-20 17:28:11 +02001566 psa_set_key_enrollment_algorithm( &source_attributes, source_alg2_arg );
Gilles Peskineca25db92019-04-19 11:43:08 +02001567 psa_set_key_type( &source_attributes, type_arg );
Gilles Peskine049c7532019-05-15 20:22:09 +02001568 PSA_ASSERT( psa_import_key( &source_attributes,
1569 material->x, material->len,
Ronald Cron5425a212020-08-04 14:58:35 +02001570 &source_key ) );
1571 PSA_ASSERT( psa_get_key_attributes( source_key, &source_attributes ) );
Gilles Peskine57ab7212019-01-28 13:03:09 +01001572
Gilles Peskineca25db92019-04-19 11:43:08 +02001573 /* Prepare the target attributes. */
1574 if( copy_attributes )
Ronald Cron65f38a32020-10-23 17:11:13 +02001575 {
Gilles Peskineca25db92019-04-19 11:43:08 +02001576 target_attributes = source_attributes;
Ronald Cron65f38a32020-10-23 17:11:13 +02001577 /* Set volatile lifetime to reset the key identifier to 0. */
1578 psa_set_key_lifetime( &target_attributes, PSA_KEY_LIFETIME_VOLATILE );
1579 }
1580
Gilles Peskineca25db92019-04-19 11:43:08 +02001581 if( target_usage_arg != -1 )
1582 psa_set_key_usage_flags( &target_attributes, target_usage_arg );
1583 if( target_alg_arg != -1 )
1584 psa_set_key_algorithm( &target_attributes, target_alg_arg );
Gilles Peskinebcdd44b2019-05-20 17:28:11 +02001585 if( target_alg2_arg != -1 )
1586 psa_set_key_enrollment_algorithm( &target_attributes, target_alg2_arg );
Gilles Peskine57ab7212019-01-28 13:03:09 +01001587
1588 /* Copy the key. */
Ronald Cron5425a212020-08-04 14:58:35 +02001589 PSA_ASSERT( psa_copy_key( source_key,
1590 &target_attributes, &target_key ) );
Gilles Peskine57ab7212019-01-28 13:03:09 +01001591
1592 /* Destroy the source to ensure that this doesn't affect the target. */
Ronald Cron5425a212020-08-04 14:58:35 +02001593 PSA_ASSERT( psa_destroy_key( source_key ) );
Gilles Peskine57ab7212019-01-28 13:03:09 +01001594
1595 /* Test that the target slot has the expected content and policy. */
Ronald Cron5425a212020-08-04 14:58:35 +02001596 PSA_ASSERT( psa_get_key_attributes( target_key, &target_attributes ) );
Gilles Peskineca25db92019-04-19 11:43:08 +02001597 TEST_EQUAL( psa_get_key_type( &source_attributes ),
1598 psa_get_key_type( &target_attributes ) );
1599 TEST_EQUAL( psa_get_key_bits( &source_attributes ),
1600 psa_get_key_bits( &target_attributes ) );
1601 TEST_EQUAL( expected_usage, psa_get_key_usage_flags( &target_attributes ) );
1602 TEST_EQUAL( expected_alg, psa_get_key_algorithm( &target_attributes ) );
Gilles Peskinebcdd44b2019-05-20 17:28:11 +02001603 TEST_EQUAL( expected_alg2,
1604 psa_get_key_enrollment_algorithm( &target_attributes ) );
Gilles Peskine57ab7212019-01-28 13:03:09 +01001605 if( expected_usage & PSA_KEY_USAGE_EXPORT )
1606 {
1607 size_t length;
1608 ASSERT_ALLOC( export_buffer, material->len );
Ronald Cron5425a212020-08-04 14:58:35 +02001609 PSA_ASSERT( psa_export_key( target_key, export_buffer,
Gilles Peskine57ab7212019-01-28 13:03:09 +01001610 material->len, &length ) );
1611 ASSERT_COMPARE( material->x, material->len,
1612 export_buffer, length );
1613 }
Steven Cooremanb3ce8152021-02-18 12:03:50 +01001614
Gilles Peskinec18e25f2021-02-12 23:48:20 +01001615 if( ! mbedtls_test_psa_exercise_key( target_key, expected_usage, expected_alg ) )
Gilles Peskine57ab7212019-01-28 13:03:09 +01001616 goto exit;
Gilles Peskinec18e25f2021-02-12 23:48:20 +01001617 if( ! mbedtls_test_psa_exercise_key( target_key, expected_usage, expected_alg2 ) )
Gilles Peskinebcdd44b2019-05-20 17:28:11 +02001618 goto exit;
Gilles Peskine57ab7212019-01-28 13:03:09 +01001619
Ronald Cron5425a212020-08-04 14:58:35 +02001620 PSA_ASSERT( psa_destroy_key( target_key ) );
Gilles Peskine57ab7212019-01-28 13:03:09 +01001621
1622exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +01001623 /*
1624 * Source and target key attributes may have been returned by
1625 * psa_get_key_attributes() thus reset them as required.
1626 */
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02001627 psa_reset_key_attributes( &source_attributes );
1628 psa_reset_key_attributes( &target_attributes );
Ronald Cron3a4f0e32020-11-19 17:55:23 +01001629
Gilles Peskine1153e7b2019-05-28 15:10:21 +02001630 PSA_DONE( );
Gilles Peskine57ab7212019-01-28 13:03:09 +01001631 mbedtls_free( export_buffer );
1632}
1633/* END_CASE */
1634
1635/* BEGIN_CASE */
Gilles Peskinebcdd44b2019-05-20 17:28:11 +02001636void copy_fail( int source_usage_arg,
1637 int source_alg_arg, int source_alg2_arg,
Gilles Peskine4a644642019-05-03 17:14:08 +02001638 int type_arg, data_t *material,
1639 int target_type_arg, int target_bits_arg,
Gilles Peskinebcdd44b2019-05-20 17:28:11 +02001640 int target_usage_arg,
1641 int target_alg_arg, int target_alg2_arg,
Ronald Cron88a55462021-03-31 09:39:07 +02001642 int target_id_arg, int target_lifetime_arg,
Gilles Peskine4a644642019-05-03 17:14:08 +02001643 int expected_status_arg )
1644{
1645 psa_key_attributes_t source_attributes = PSA_KEY_ATTRIBUTES_INIT;
1646 psa_key_attributes_t target_attributes = PSA_KEY_ATTRIBUTES_INIT;
Ronald Cron5425a212020-08-04 14:58:35 +02001647 mbedtls_svc_key_id_t source_key = MBEDTLS_SVC_KEY_ID_INIT;
1648 mbedtls_svc_key_id_t target_key = MBEDTLS_SVC_KEY_ID_INIT;
Ronald Cron88a55462021-03-31 09:39:07 +02001649 mbedtls_svc_key_id_t key_id = mbedtls_svc_key_id_make( 1, target_id_arg );
Gilles Peskine4a644642019-05-03 17:14:08 +02001650
1651 PSA_ASSERT( psa_crypto_init( ) );
1652
1653 /* Prepare the source key. */
1654 psa_set_key_usage_flags( &source_attributes, source_usage_arg );
1655 psa_set_key_algorithm( &source_attributes, source_alg_arg );
Gilles Peskinebcdd44b2019-05-20 17:28:11 +02001656 psa_set_key_enrollment_algorithm( &source_attributes, source_alg2_arg );
Gilles Peskine4a644642019-05-03 17:14:08 +02001657 psa_set_key_type( &source_attributes, type_arg );
Gilles Peskine049c7532019-05-15 20:22:09 +02001658 PSA_ASSERT( psa_import_key( &source_attributes,
1659 material->x, material->len,
Ronald Cron5425a212020-08-04 14:58:35 +02001660 &source_key ) );
Gilles Peskine4a644642019-05-03 17:14:08 +02001661
1662 /* Prepare the target attributes. */
Ronald Cron88a55462021-03-31 09:39:07 +02001663 psa_set_key_id( &target_attributes, key_id );
1664 psa_set_key_lifetime( &target_attributes, target_lifetime_arg );
Gilles Peskine4a644642019-05-03 17:14:08 +02001665 psa_set_key_type( &target_attributes, target_type_arg );
1666 psa_set_key_bits( &target_attributes, target_bits_arg );
1667 psa_set_key_usage_flags( &target_attributes, target_usage_arg );
1668 psa_set_key_algorithm( &target_attributes, target_alg_arg );
Gilles Peskinebcdd44b2019-05-20 17:28:11 +02001669 psa_set_key_enrollment_algorithm( &target_attributes, target_alg2_arg );
Gilles Peskine4a644642019-05-03 17:14:08 +02001670
1671 /* Try to copy the key. */
Ronald Cron5425a212020-08-04 14:58:35 +02001672 TEST_EQUAL( psa_copy_key( source_key,
1673 &target_attributes, &target_key ),
Gilles Peskine4a644642019-05-03 17:14:08 +02001674 expected_status_arg );
Gilles Peskine76b29a72019-05-28 14:08:50 +02001675
Ronald Cron5425a212020-08-04 14:58:35 +02001676 PSA_ASSERT( psa_destroy_key( source_key ) );
Gilles Peskine76b29a72019-05-28 14:08:50 +02001677
Gilles Peskine4a644642019-05-03 17:14:08 +02001678exit:
1679 psa_reset_key_attributes( &source_attributes );
1680 psa_reset_key_attributes( &target_attributes );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02001681 PSA_DONE( );
Gilles Peskine4a644642019-05-03 17:14:08 +02001682}
1683/* END_CASE */
1684
1685/* BEGIN_CASE */
Jaeden Amero6a25b412019-01-04 11:47:44 +00001686void hash_operation_init( )
1687{
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00001688 const uint8_t input[1] = { 0 };
Jaeden Amero6a25b412019-01-04 11:47:44 +00001689 /* Test each valid way of initializing the object, except for `= {0}`, as
1690 * Clang 5 complains when `-Wmissing-field-initializers` is used, even
1691 * though it's OK by the C standard. We could test for this, but we'd need
1692 * to supress the Clang warning for the test. */
1693 psa_hash_operation_t func = psa_hash_operation_init( );
1694 psa_hash_operation_t init = PSA_HASH_OPERATION_INIT;
1695 psa_hash_operation_t zero;
1696
1697 memset( &zero, 0, sizeof( zero ) );
1698
Jaeden Amero11aa7ee2019-02-19 11:44:55 +00001699 /* A freshly-initialized hash operation should not be usable. */
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00001700 TEST_EQUAL( psa_hash_update( &func, input, sizeof( input ) ),
1701 PSA_ERROR_BAD_STATE );
1702 TEST_EQUAL( psa_hash_update( &init, input, sizeof( input ) ),
1703 PSA_ERROR_BAD_STATE );
1704 TEST_EQUAL( psa_hash_update( &zero, input, sizeof( input ) ),
1705 PSA_ERROR_BAD_STATE );
1706
Jaeden Amero5229bbb2019-02-07 16:33:37 +00001707 /* A default hash operation should be abortable without error. */
1708 PSA_ASSERT( psa_hash_abort( &func ) );
1709 PSA_ASSERT( psa_hash_abort( &init ) );
1710 PSA_ASSERT( psa_hash_abort( &zero ) );
Jaeden Amero6a25b412019-01-04 11:47:44 +00001711}
1712/* END_CASE */
1713
1714/* BEGIN_CASE */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02001715void hash_setup( int alg_arg,
1716 int expected_status_arg )
1717{
1718 psa_algorithm_t alg = alg_arg;
Gilles Peskineb866e2b2018-06-21 09:25:10 +02001719 psa_status_t expected_status = expected_status_arg;
Jaeden Amero6a25b412019-01-04 11:47:44 +00001720 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02001721 psa_status_t status;
1722
Gilles Peskine8817f612018-12-18 00:18:46 +01001723 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02001724
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02001725 status = psa_hash_setup( &operation, alg );
Gilles Peskinefe11b722018-12-18 00:24:04 +01001726 TEST_EQUAL( status, expected_status );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02001727
Gilles Peskine9e0a4a52019-02-25 22:11:18 +01001728 /* Whether setup succeeded or failed, abort must succeed. */
1729 PSA_ASSERT( psa_hash_abort( &operation ) );
1730
1731 /* If setup failed, reproduce the failure, so as to
1732 * test the resulting state of the operation object. */
1733 if( status != PSA_SUCCESS )
1734 TEST_EQUAL( psa_hash_setup( &operation, alg ), status );
1735
Gilles Peskinef426e0f2019-02-25 17:42:03 +01001736 /* Now the operation object should be reusable. */
1737#if defined(KNOWN_SUPPORTED_HASH_ALG)
1738 PSA_ASSERT( psa_hash_setup( &operation, KNOWN_SUPPORTED_HASH_ALG ) );
1739 PSA_ASSERT( psa_hash_abort( &operation ) );
1740#endif
1741
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02001742exit:
Gilles Peskine1153e7b2019-05-28 15:10:21 +02001743 PSA_DONE( );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02001744}
1745/* END_CASE */
1746
1747/* BEGIN_CASE */
Gilles Peskine0a749c82019-11-28 19:33:58 +01001748void hash_compute_fail( int alg_arg, data_t *input,
1749 int output_size_arg, int expected_status_arg )
1750{
1751 psa_algorithm_t alg = alg_arg;
1752 uint8_t *output = NULL;
1753 size_t output_size = output_size_arg;
1754 size_t output_length = INVALID_EXPORT_LENGTH;
1755 psa_status_t expected_status = expected_status_arg;
1756 psa_status_t status;
1757
1758 ASSERT_ALLOC( output, output_size );
1759
1760 PSA_ASSERT( psa_crypto_init( ) );
1761
1762 status = psa_hash_compute( alg, input->x, input->len,
1763 output, output_size, &output_length );
1764 TEST_EQUAL( status, expected_status );
1765 TEST_ASSERT( output_length <= output_size );
1766
1767exit:
1768 mbedtls_free( output );
1769 PSA_DONE( );
1770}
1771/* END_CASE */
1772
1773/* BEGIN_CASE */
Gilles Peskine88e08462020-01-28 20:43:00 +01001774void hash_compare_fail( int alg_arg, data_t *input,
1775 data_t *reference_hash,
1776 int expected_status_arg )
1777{
1778 psa_algorithm_t alg = alg_arg;
1779 psa_status_t expected_status = expected_status_arg;
1780 psa_status_t status;
1781
1782 PSA_ASSERT( psa_crypto_init( ) );
1783
1784 status = psa_hash_compare( alg, input->x, input->len,
1785 reference_hash->x, reference_hash->len );
1786 TEST_EQUAL( status, expected_status );
1787
1788exit:
1789 PSA_DONE( );
1790}
1791/* END_CASE */
1792
1793/* BEGIN_CASE */
Gilles Peskine0a749c82019-11-28 19:33:58 +01001794void hash_compute_compare( int alg_arg, data_t *input,
1795 data_t *expected_output )
1796{
1797 psa_algorithm_t alg = alg_arg;
1798 uint8_t output[PSA_HASH_MAX_SIZE + 1];
1799 size_t output_length = INVALID_EXPORT_LENGTH;
1800 size_t i;
1801
1802 PSA_ASSERT( psa_crypto_init( ) );
1803
1804 /* Compute with tight buffer */
1805 PSA_ASSERT( psa_hash_compute( alg, input->x, input->len,
gabor-mezei-armcbcec212020-12-18 14:23:51 +01001806 output, PSA_HASH_LENGTH( alg ),
Gilles Peskine0a749c82019-11-28 19:33:58 +01001807 &output_length ) );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01001808 TEST_EQUAL( output_length, PSA_HASH_LENGTH( alg ) );
Gilles Peskine0a749c82019-11-28 19:33:58 +01001809 ASSERT_COMPARE( output, output_length,
1810 expected_output->x, expected_output->len );
1811
1812 /* Compute with larger buffer */
1813 PSA_ASSERT( psa_hash_compute( alg, input->x, input->len,
1814 output, sizeof( output ),
1815 &output_length ) );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01001816 TEST_EQUAL( output_length, PSA_HASH_LENGTH( alg ) );
Gilles Peskine0a749c82019-11-28 19:33:58 +01001817 ASSERT_COMPARE( output, output_length,
1818 expected_output->x, expected_output->len );
1819
1820 /* Compare with correct hash */
1821 PSA_ASSERT( psa_hash_compare( alg, input->x, input->len,
1822 output, output_length ) );
1823
1824 /* Compare with trailing garbage */
1825 TEST_EQUAL( psa_hash_compare( alg, input->x, input->len,
1826 output, output_length + 1 ),
1827 PSA_ERROR_INVALID_SIGNATURE );
1828
1829 /* Compare with truncated hash */
1830 TEST_EQUAL( psa_hash_compare( alg, input->x, input->len,
1831 output, output_length - 1 ),
1832 PSA_ERROR_INVALID_SIGNATURE );
1833
1834 /* Compare with corrupted value */
1835 for( i = 0; i < output_length; i++ )
1836 {
Chris Jones9634bb12021-01-20 15:56:42 +00001837 mbedtls_test_set_step( i );
Gilles Peskine0a749c82019-11-28 19:33:58 +01001838 output[i] ^= 1;
1839 TEST_EQUAL( psa_hash_compare( alg, input->x, input->len,
1840 output, output_length ),
1841 PSA_ERROR_INVALID_SIGNATURE );
1842 output[i] ^= 1;
1843 }
1844
1845exit:
1846 PSA_DONE( );
1847}
1848/* END_CASE */
1849
Gilles Peskined6dc40c2021-01-12 12:55:31 +01001850/* BEGIN_CASE depends_on:PSA_WANT_ALG_SHA_256 */
itayzafrirf86548d2018-11-01 10:44:32 +02001851void hash_bad_order( )
1852{
Jaeden Amero11aa7ee2019-02-19 11:44:55 +00001853 psa_algorithm_t alg = PSA_ALG_SHA_256;
itayzafrirf86548d2018-11-01 10:44:32 +02001854 unsigned char input[] = "";
1855 /* SHA-256 hash of an empty string */
Jaeden Amero11aa7ee2019-02-19 11:44:55 +00001856 const unsigned char valid_hash[] = {
itayzafrirf86548d2018-11-01 10:44:32 +02001857 0xe3, 0xb0, 0xc4, 0x42, 0x98, 0xfc, 0x1c, 0x14, 0x9a, 0xfb, 0xf4, 0xc8,
1858 0x99, 0x6f, 0xb9, 0x24, 0x27, 0xae, 0x41, 0xe4, 0x64, 0x9b, 0x93, 0x4c,
1859 0xa4, 0x95, 0x99, 0x1b, 0x78, 0x52, 0xb8, 0x55 };
Jaeden Amero11aa7ee2019-02-19 11:44:55 +00001860 unsigned char hash[sizeof(valid_hash)] = { 0 };
itayzafrirf86548d2018-11-01 10:44:32 +02001861 size_t hash_len;
Jaeden Amero6a25b412019-01-04 11:47:44 +00001862 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
itayzafrirf86548d2018-11-01 10:44:32 +02001863
Gilles Peskine8817f612018-12-18 00:18:46 +01001864 PSA_ASSERT( psa_crypto_init( ) );
itayzafrirf86548d2018-11-01 10:44:32 +02001865
Jaeden Amero36ee5d02019-02-19 09:25:10 +00001866 /* Call setup twice in a row. */
1867 PSA_ASSERT( psa_hash_setup( &operation, alg ) );
1868 TEST_EQUAL( psa_hash_setup( &operation, alg ),
1869 PSA_ERROR_BAD_STATE );
1870 PSA_ASSERT( psa_hash_abort( &operation ) );
1871
Jaeden Amero11aa7ee2019-02-19 11:44:55 +00001872 /* Call update without calling setup beforehand. */
Gilles Peskinef812dcf2018-12-18 00:33:25 +01001873 TEST_EQUAL( psa_hash_update( &operation, input, sizeof( input ) ),
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00001874 PSA_ERROR_BAD_STATE );
Jaeden Amero11aa7ee2019-02-19 11:44:55 +00001875 PSA_ASSERT( psa_hash_abort( &operation ) );
itayzafrirf86548d2018-11-01 10:44:32 +02001876
Jaeden Amero11aa7ee2019-02-19 11:44:55 +00001877 /* Call update after finish. */
1878 PSA_ASSERT( psa_hash_setup( &operation, alg ) );
1879 PSA_ASSERT( psa_hash_finish( &operation,
1880 hash, sizeof( hash ), &hash_len ) );
1881 TEST_EQUAL( psa_hash_update( &operation, input, sizeof( input ) ),
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00001882 PSA_ERROR_BAD_STATE );
Jaeden Amero11aa7ee2019-02-19 11:44:55 +00001883 PSA_ASSERT( psa_hash_abort( &operation ) );
itayzafrirf86548d2018-11-01 10:44:32 +02001884
Jaeden Amero11aa7ee2019-02-19 11:44:55 +00001885 /* Call verify without calling setup beforehand. */
1886 TEST_EQUAL( psa_hash_verify( &operation,
1887 valid_hash, sizeof( valid_hash ) ),
1888 PSA_ERROR_BAD_STATE );
1889 PSA_ASSERT( psa_hash_abort( &operation ) );
1890
1891 /* Call verify after finish. */
1892 PSA_ASSERT( psa_hash_setup( &operation, alg ) );
1893 PSA_ASSERT( psa_hash_finish( &operation,
1894 hash, sizeof( hash ), &hash_len ) );
1895 TEST_EQUAL( psa_hash_verify( &operation,
1896 valid_hash, sizeof( valid_hash ) ),
1897 PSA_ERROR_BAD_STATE );
1898 PSA_ASSERT( psa_hash_abort( &operation ) );
1899
1900 /* Call verify twice in a row. */
1901 PSA_ASSERT( psa_hash_setup( &operation, alg ) );
1902 PSA_ASSERT( psa_hash_verify( &operation,
1903 valid_hash, sizeof( valid_hash ) ) );
1904 TEST_EQUAL( psa_hash_verify( &operation,
1905 valid_hash, sizeof( valid_hash ) ),
1906 PSA_ERROR_BAD_STATE );
1907 PSA_ASSERT( psa_hash_abort( &operation ) );
1908
1909 /* Call finish without calling setup beforehand. */
Gilles Peskinefe11b722018-12-18 00:24:04 +01001910 TEST_EQUAL( psa_hash_finish( &operation,
1911 hash, sizeof( hash ), &hash_len ),
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00001912 PSA_ERROR_BAD_STATE );
Jaeden Amero11aa7ee2019-02-19 11:44:55 +00001913 PSA_ASSERT( psa_hash_abort( &operation ) );
1914
1915 /* Call finish twice in a row. */
1916 PSA_ASSERT( psa_hash_setup( &operation, alg ) );
1917 PSA_ASSERT( psa_hash_finish( &operation,
1918 hash, sizeof( hash ), &hash_len ) );
1919 TEST_EQUAL( psa_hash_finish( &operation,
1920 hash, sizeof( hash ), &hash_len ),
1921 PSA_ERROR_BAD_STATE );
1922 PSA_ASSERT( psa_hash_abort( &operation ) );
1923
1924 /* Call finish after calling verify. */
1925 PSA_ASSERT( psa_hash_setup( &operation, alg ) );
1926 PSA_ASSERT( psa_hash_verify( &operation,
1927 valid_hash, sizeof( valid_hash ) ) );
1928 TEST_EQUAL( psa_hash_finish( &operation,
1929 hash, sizeof( hash ), &hash_len ),
1930 PSA_ERROR_BAD_STATE );
1931 PSA_ASSERT( psa_hash_abort( &operation ) );
itayzafrirf86548d2018-11-01 10:44:32 +02001932
1933exit:
Gilles Peskine1153e7b2019-05-28 15:10:21 +02001934 PSA_DONE( );
itayzafrirf86548d2018-11-01 10:44:32 +02001935}
1936/* END_CASE */
1937
Gilles Peskined6dc40c2021-01-12 12:55:31 +01001938/* BEGIN_CASE depends_on:PSA_WANT_ALG_SHA_256 */
itayzafrir27e69452018-11-01 14:26:34 +02001939void hash_verify_bad_args( )
itayzafrirec93d302018-10-18 18:01:10 +03001940{
1941 psa_algorithm_t alg = PSA_ALG_SHA_256;
itayzafrir27e69452018-11-01 14:26:34 +02001942 /* SHA-256 hash of an empty string with 2 extra bytes (0xaa and 0xbb)
1943 * appended to it */
1944 unsigned char hash[] = {
1945 0xe3, 0xb0, 0xc4, 0x42, 0x98, 0xfc, 0x1c, 0x14, 0x9a, 0xfb, 0xf4, 0xc8,
1946 0x99, 0x6f, 0xb9, 0x24, 0x27, 0xae, 0x41, 0xe4, 0x64, 0x9b, 0x93, 0x4c,
1947 0xa4, 0x95, 0x99, 0x1b, 0x78, 0x52, 0xb8, 0x55, 0xaa, 0xbb };
gabor-mezei-armcbcec212020-12-18 14:23:51 +01001948 size_t expected_size = PSA_HASH_LENGTH( alg );
Jaeden Amero6a25b412019-01-04 11:47:44 +00001949 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
itayzafrirec93d302018-10-18 18:01:10 +03001950
Gilles Peskine8817f612018-12-18 00:18:46 +01001951 PSA_ASSERT( psa_crypto_init( ) );
itayzafrirec93d302018-10-18 18:01:10 +03001952
itayzafrir27e69452018-11-01 14:26:34 +02001953 /* psa_hash_verify with a smaller hash than expected */
Gilles Peskine8817f612018-12-18 00:18:46 +01001954 PSA_ASSERT( psa_hash_setup( &operation, alg ) );
Gilles Peskinef812dcf2018-12-18 00:33:25 +01001955 TEST_EQUAL( psa_hash_verify( &operation, hash, expected_size - 1 ),
Gilles Peskinefe11b722018-12-18 00:24:04 +01001956 PSA_ERROR_INVALID_SIGNATURE );
itayzafrirec93d302018-10-18 18:01:10 +03001957
itayzafrir27e69452018-11-01 14:26:34 +02001958 /* psa_hash_verify with a non-matching hash */
Gilles Peskine8817f612018-12-18 00:18:46 +01001959 PSA_ASSERT( psa_hash_setup( &operation, alg ) );
Gilles Peskinef812dcf2018-12-18 00:33:25 +01001960 TEST_EQUAL( psa_hash_verify( &operation, hash + 1, expected_size ),
Gilles Peskinefe11b722018-12-18 00:24:04 +01001961 PSA_ERROR_INVALID_SIGNATURE );
itayzafrirec93d302018-10-18 18:01:10 +03001962
itayzafrir27e69452018-11-01 14:26:34 +02001963 /* psa_hash_verify with a hash longer than expected */
Gilles Peskine8817f612018-12-18 00:18:46 +01001964 PSA_ASSERT( psa_hash_setup( &operation, alg ) );
Gilles Peskinef812dcf2018-12-18 00:33:25 +01001965 TEST_EQUAL( psa_hash_verify( &operation, hash, sizeof( hash ) ),
Gilles Peskinefe11b722018-12-18 00:24:04 +01001966 PSA_ERROR_INVALID_SIGNATURE );
itayzafrir4271df92018-10-24 18:16:19 +03001967
itayzafrirec93d302018-10-18 18:01:10 +03001968exit:
Gilles Peskine1153e7b2019-05-28 15:10:21 +02001969 PSA_DONE( );
itayzafrirec93d302018-10-18 18:01:10 +03001970}
1971/* END_CASE */
1972
Ronald Cronee414c72021-03-18 18:50:08 +01001973/* BEGIN_CASE depends_on:PSA_WANT_ALG_SHA_256 */
itayzafrirb2dd5ed2018-11-01 11:58:59 +02001974void hash_finish_bad_args( )
itayzafrir58028322018-10-25 10:22:01 +03001975{
1976 psa_algorithm_t alg = PSA_ALG_SHA_256;
itayzafrirb2dd5ed2018-11-01 11:58:59 +02001977 unsigned char hash[PSA_HASH_MAX_SIZE];
gabor-mezei-armcbcec212020-12-18 14:23:51 +01001978 size_t expected_size = PSA_HASH_LENGTH( alg );
Jaeden Amero6a25b412019-01-04 11:47:44 +00001979 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
itayzafrir58028322018-10-25 10:22:01 +03001980 size_t hash_len;
1981
Gilles Peskine8817f612018-12-18 00:18:46 +01001982 PSA_ASSERT( psa_crypto_init( ) );
itayzafrir58028322018-10-25 10:22:01 +03001983
itayzafrir58028322018-10-25 10:22:01 +03001984 /* psa_hash_finish with a smaller hash buffer than expected */
Gilles Peskine8817f612018-12-18 00:18:46 +01001985 PSA_ASSERT( psa_hash_setup( &operation, alg ) );
Gilles Peskinefe11b722018-12-18 00:24:04 +01001986 TEST_EQUAL( psa_hash_finish( &operation,
Gilles Peskinef812dcf2018-12-18 00:33:25 +01001987 hash, expected_size - 1, &hash_len ),
1988 PSA_ERROR_BUFFER_TOO_SMALL );
itayzafrir58028322018-10-25 10:22:01 +03001989
1990exit:
Gilles Peskine1153e7b2019-05-28 15:10:21 +02001991 PSA_DONE( );
itayzafrir58028322018-10-25 10:22:01 +03001992}
1993/* END_CASE */
1994
Ronald Cronee414c72021-03-18 18:50:08 +01001995/* BEGIN_CASE depends_on:PSA_WANT_ALG_SHA_256 */
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01001996void hash_clone_source_state( )
1997{
1998 psa_algorithm_t alg = PSA_ALG_SHA_256;
1999 unsigned char hash[PSA_HASH_MAX_SIZE];
2000 psa_hash_operation_t op_source = PSA_HASH_OPERATION_INIT;
2001 psa_hash_operation_t op_init = PSA_HASH_OPERATION_INIT;
2002 psa_hash_operation_t op_setup = PSA_HASH_OPERATION_INIT;
2003 psa_hash_operation_t op_finished = PSA_HASH_OPERATION_INIT;
2004 psa_hash_operation_t op_aborted = PSA_HASH_OPERATION_INIT;
2005 size_t hash_len;
2006
2007 PSA_ASSERT( psa_crypto_init( ) );
2008 PSA_ASSERT( psa_hash_setup( &op_source, alg ) );
2009
2010 PSA_ASSERT( psa_hash_setup( &op_setup, alg ) );
2011 PSA_ASSERT( psa_hash_setup( &op_finished, alg ) );
2012 PSA_ASSERT( psa_hash_finish( &op_finished,
2013 hash, sizeof( hash ), &hash_len ) );
2014 PSA_ASSERT( psa_hash_setup( &op_aborted, alg ) );
2015 PSA_ASSERT( psa_hash_abort( &op_aborted ) );
2016
2017 TEST_EQUAL( psa_hash_clone( &op_source, &op_setup ),
2018 PSA_ERROR_BAD_STATE );
2019
2020 PSA_ASSERT( psa_hash_clone( &op_source, &op_init ) );
2021 PSA_ASSERT( psa_hash_finish( &op_init,
2022 hash, sizeof( hash ), &hash_len ) );
2023 PSA_ASSERT( psa_hash_clone( &op_source, &op_finished ) );
2024 PSA_ASSERT( psa_hash_finish( &op_finished,
2025 hash, sizeof( hash ), &hash_len ) );
2026 PSA_ASSERT( psa_hash_clone( &op_source, &op_aborted ) );
2027 PSA_ASSERT( psa_hash_finish( &op_aborted,
2028 hash, sizeof( hash ), &hash_len ) );
2029
2030exit:
2031 psa_hash_abort( &op_source );
2032 psa_hash_abort( &op_init );
2033 psa_hash_abort( &op_setup );
2034 psa_hash_abort( &op_finished );
2035 psa_hash_abort( &op_aborted );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02002036 PSA_DONE( );
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002037}
2038/* END_CASE */
2039
Ronald Cronee414c72021-03-18 18:50:08 +01002040/* BEGIN_CASE depends_on:PSA_WANT_ALG_SHA_256 */
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002041void hash_clone_target_state( )
2042{
2043 psa_algorithm_t alg = PSA_ALG_SHA_256;
2044 unsigned char hash[PSA_HASH_MAX_SIZE];
2045 psa_hash_operation_t op_init = PSA_HASH_OPERATION_INIT;
2046 psa_hash_operation_t op_setup = PSA_HASH_OPERATION_INIT;
2047 psa_hash_operation_t op_finished = PSA_HASH_OPERATION_INIT;
2048 psa_hash_operation_t op_aborted = PSA_HASH_OPERATION_INIT;
2049 psa_hash_operation_t op_target = PSA_HASH_OPERATION_INIT;
2050 size_t hash_len;
2051
2052 PSA_ASSERT( psa_crypto_init( ) );
2053
2054 PSA_ASSERT( psa_hash_setup( &op_setup, alg ) );
2055 PSA_ASSERT( psa_hash_setup( &op_finished, alg ) );
2056 PSA_ASSERT( psa_hash_finish( &op_finished,
2057 hash, sizeof( hash ), &hash_len ) );
2058 PSA_ASSERT( psa_hash_setup( &op_aborted, alg ) );
2059 PSA_ASSERT( psa_hash_abort( &op_aborted ) );
2060
2061 PSA_ASSERT( psa_hash_clone( &op_setup, &op_target ) );
2062 PSA_ASSERT( psa_hash_finish( &op_target,
2063 hash, sizeof( hash ), &hash_len ) );
2064
2065 TEST_EQUAL( psa_hash_clone( &op_init, &op_target ), PSA_ERROR_BAD_STATE );
2066 TEST_EQUAL( psa_hash_clone( &op_finished, &op_target ),
2067 PSA_ERROR_BAD_STATE );
2068 TEST_EQUAL( psa_hash_clone( &op_aborted, &op_target ),
2069 PSA_ERROR_BAD_STATE );
2070
2071exit:
2072 psa_hash_abort( &op_target );
2073 psa_hash_abort( &op_init );
2074 psa_hash_abort( &op_setup );
2075 psa_hash_abort( &op_finished );
2076 psa_hash_abort( &op_aborted );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02002077 PSA_DONE( );
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002078}
2079/* END_CASE */
2080
itayzafrir58028322018-10-25 10:22:01 +03002081/* BEGIN_CASE */
Jaeden Amero769ce272019-01-04 11:48:03 +00002082void mac_operation_init( )
2083{
Jaeden Amero252ef282019-02-15 14:05:35 +00002084 const uint8_t input[1] = { 0 };
2085
Jaeden Amero769ce272019-01-04 11:48:03 +00002086 /* Test each valid way of initializing the object, except for `= {0}`, as
2087 * Clang 5 complains when `-Wmissing-field-initializers` is used, even
2088 * though it's OK by the C standard. We could test for this, but we'd need
2089 * to supress the Clang warning for the test. */
2090 psa_mac_operation_t func = psa_mac_operation_init( );
2091 psa_mac_operation_t init = PSA_MAC_OPERATION_INIT;
2092 psa_mac_operation_t zero;
2093
2094 memset( &zero, 0, sizeof( zero ) );
2095
Jaeden Amero252ef282019-02-15 14:05:35 +00002096 /* A freshly-initialized MAC operation should not be usable. */
2097 TEST_EQUAL( psa_mac_update( &func,
2098 input, sizeof( input ) ),
2099 PSA_ERROR_BAD_STATE );
2100 TEST_EQUAL( psa_mac_update( &init,
2101 input, sizeof( input ) ),
2102 PSA_ERROR_BAD_STATE );
2103 TEST_EQUAL( psa_mac_update( &zero,
2104 input, sizeof( input ) ),
2105 PSA_ERROR_BAD_STATE );
2106
Jaeden Amero5229bbb2019-02-07 16:33:37 +00002107 /* A default MAC operation should be abortable without error. */
2108 PSA_ASSERT( psa_mac_abort( &func ) );
2109 PSA_ASSERT( psa_mac_abort( &init ) );
2110 PSA_ASSERT( psa_mac_abort( &zero ) );
Jaeden Amero769ce272019-01-04 11:48:03 +00002111}
2112/* END_CASE */
2113
2114/* BEGIN_CASE */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002115void mac_setup( int key_type_arg,
2116 data_t *key,
2117 int alg_arg,
2118 int expected_status_arg )
2119{
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002120 psa_key_type_t key_type = key_type_arg;
2121 psa_algorithm_t alg = alg_arg;
Gilles Peskineb866e2b2018-06-21 09:25:10 +02002122 psa_status_t expected_status = expected_status_arg;
Jaeden Amero769ce272019-01-04 11:48:03 +00002123 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
Gilles Peskinef426e0f2019-02-25 17:42:03 +01002124 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
2125#if defined(KNOWN_SUPPORTED_MAC_ALG)
2126 const uint8_t smoke_test_key_data[16] = "kkkkkkkkkkkkkkkk";
2127#endif
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002128
Gilles Peskine8817f612018-12-18 00:18:46 +01002129 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002130
Gilles Peskinef426e0f2019-02-25 17:42:03 +01002131 if( ! exercise_mac_setup( key_type, key->x, key->len, alg,
2132 &operation, &status ) )
2133 goto exit;
Gilles Peskinefe11b722018-12-18 00:24:04 +01002134 TEST_EQUAL( status, expected_status );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002135
Gilles Peskinef426e0f2019-02-25 17:42:03 +01002136 /* The operation object should be reusable. */
2137#if defined(KNOWN_SUPPORTED_MAC_ALG)
2138 if( ! exercise_mac_setup( KNOWN_SUPPORTED_MAC_KEY_TYPE,
2139 smoke_test_key_data,
2140 sizeof( smoke_test_key_data ),
2141 KNOWN_SUPPORTED_MAC_ALG,
2142 &operation, &status ) )
2143 goto exit;
2144 TEST_EQUAL( status, PSA_SUCCESS );
2145#endif
2146
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002147exit:
Gilles Peskine1153e7b2019-05-28 15:10:21 +02002148 PSA_DONE( );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002149}
2150/* END_CASE */
2151
Gilles Peskined6dc40c2021-01-12 12:55:31 +01002152/* BEGIN_CASE depends_on:PSA_WANT_KEY_TYPE_HMAC:PSA_WANT_ALG_HMAC:PSA_WANT_ALG_SHA_256 */
Jaeden Amero252ef282019-02-15 14:05:35 +00002153void mac_bad_order( )
2154{
Ronald Cron5425a212020-08-04 14:58:35 +02002155 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Jaeden Amero252ef282019-02-15 14:05:35 +00002156 psa_key_type_t key_type = PSA_KEY_TYPE_HMAC;
2157 psa_algorithm_t alg = PSA_ALG_HMAC(PSA_ALG_SHA_256);
Ronald Cron5425a212020-08-04 14:58:35 +02002158 const uint8_t key_data[] = {
Jaeden Amero252ef282019-02-15 14:05:35 +00002159 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa,
2160 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa,
2161 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa };
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02002162 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Jaeden Amero252ef282019-02-15 14:05:35 +00002163 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
2164 uint8_t sign_mac[PSA_MAC_MAX_SIZE + 10] = { 0 };
2165 size_t sign_mac_length = 0;
2166 const uint8_t input[] = { 0xbb, 0xbb, 0xbb, 0xbb };
2167 const uint8_t verify_mac[] = {
2168 0x74, 0x65, 0x93, 0x8c, 0xeb, 0x1d, 0xb3, 0x76, 0x5a, 0x38, 0xe7, 0xdd,
2169 0x85, 0xc5, 0xad, 0x4f, 0x07, 0xe7, 0xd5, 0xb2, 0x64, 0xf0, 0x1a, 0x1a,
2170 0x2c, 0xf9, 0x18, 0xca, 0x59, 0x7e, 0x5d, 0xf6 };
2171
2172 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01002173 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_HASH | PSA_KEY_USAGE_VERIFY_HASH );
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02002174 psa_set_key_algorithm( &attributes, alg );
2175 psa_set_key_type( &attributes, key_type );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002176
Ronald Cron5425a212020-08-04 14:58:35 +02002177 PSA_ASSERT( psa_import_key( &attributes, key_data, sizeof( key_data ),
2178 &key ) );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002179
Jaeden Amero252ef282019-02-15 14:05:35 +00002180 /* Call update without calling setup beforehand. */
2181 TEST_EQUAL( psa_mac_update( &operation, input, sizeof( input ) ),
2182 PSA_ERROR_BAD_STATE );
2183 PSA_ASSERT( psa_mac_abort( &operation ) );
2184
2185 /* Call sign finish without calling setup beforehand. */
2186 TEST_EQUAL( psa_mac_sign_finish( &operation, sign_mac, sizeof( sign_mac ),
2187 &sign_mac_length),
2188 PSA_ERROR_BAD_STATE );
2189 PSA_ASSERT( psa_mac_abort( &operation ) );
2190
2191 /* Call verify finish without calling setup beforehand. */
2192 TEST_EQUAL( psa_mac_verify_finish( &operation,
2193 verify_mac, sizeof( verify_mac ) ),
2194 PSA_ERROR_BAD_STATE );
2195 PSA_ASSERT( psa_mac_abort( &operation ) );
2196
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002197 /* Call setup twice in a row. */
Ronald Cron5425a212020-08-04 14:58:35 +02002198 PSA_ASSERT( psa_mac_sign_setup( &operation, key, alg ) );
2199 TEST_EQUAL( psa_mac_sign_setup( &operation, key, alg ),
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002200 PSA_ERROR_BAD_STATE );
2201 PSA_ASSERT( psa_mac_abort( &operation ) );
2202
Jaeden Amero252ef282019-02-15 14:05:35 +00002203 /* Call update after sign finish. */
Ronald Cron5425a212020-08-04 14:58:35 +02002204 PSA_ASSERT( psa_mac_sign_setup( &operation, key, alg ) );
Jaeden Amero252ef282019-02-15 14:05:35 +00002205 PSA_ASSERT( psa_mac_update( &operation, input, sizeof( input ) ) );
2206 PSA_ASSERT( psa_mac_sign_finish( &operation,
2207 sign_mac, sizeof( sign_mac ),
2208 &sign_mac_length ) );
2209 TEST_EQUAL( psa_mac_update( &operation, input, sizeof( input ) ),
2210 PSA_ERROR_BAD_STATE );
2211 PSA_ASSERT( psa_mac_abort( &operation ) );
2212
2213 /* Call update after verify finish. */
Ronald Cron5425a212020-08-04 14:58:35 +02002214 PSA_ASSERT( psa_mac_verify_setup( &operation, key, alg ) );
Jaeden Amero252ef282019-02-15 14:05:35 +00002215 PSA_ASSERT( psa_mac_update( &operation, input, sizeof( input ) ) );
2216 PSA_ASSERT( psa_mac_verify_finish( &operation,
2217 verify_mac, sizeof( verify_mac ) ) );
2218 TEST_EQUAL( psa_mac_update( &operation, input, sizeof( input ) ),
2219 PSA_ERROR_BAD_STATE );
2220 PSA_ASSERT( psa_mac_abort( &operation ) );
2221
2222 /* Call sign finish twice in a row. */
Ronald Cron5425a212020-08-04 14:58:35 +02002223 PSA_ASSERT( psa_mac_sign_setup( &operation, key, alg ) );
Jaeden Amero252ef282019-02-15 14:05:35 +00002224 PSA_ASSERT( psa_mac_update( &operation, input, sizeof( input ) ) );
2225 PSA_ASSERT( psa_mac_sign_finish( &operation,
2226 sign_mac, sizeof( sign_mac ),
2227 &sign_mac_length ) );
2228 TEST_EQUAL( psa_mac_sign_finish( &operation,
2229 sign_mac, sizeof( sign_mac ),
2230 &sign_mac_length ),
2231 PSA_ERROR_BAD_STATE );
2232 PSA_ASSERT( psa_mac_abort( &operation ) );
2233
2234 /* Call verify finish twice in a row. */
Ronald Cron5425a212020-08-04 14:58:35 +02002235 PSA_ASSERT( psa_mac_verify_setup( &operation, key, alg ) );
Jaeden Amero252ef282019-02-15 14:05:35 +00002236 PSA_ASSERT( psa_mac_update( &operation, input, sizeof( input ) ) );
2237 PSA_ASSERT( psa_mac_verify_finish( &operation,
2238 verify_mac, sizeof( verify_mac ) ) );
2239 TEST_EQUAL( psa_mac_verify_finish( &operation,
2240 verify_mac, sizeof( verify_mac ) ),
2241 PSA_ERROR_BAD_STATE );
2242 PSA_ASSERT( psa_mac_abort( &operation ) );
2243
2244 /* Setup sign but try verify. */
Ronald Cron5425a212020-08-04 14:58:35 +02002245 PSA_ASSERT( psa_mac_sign_setup( &operation, key, alg ) );
Jaeden Amero252ef282019-02-15 14:05:35 +00002246 PSA_ASSERT( psa_mac_update( &operation, input, sizeof( input ) ) );
2247 TEST_EQUAL( psa_mac_verify_finish( &operation,
2248 verify_mac, sizeof( verify_mac ) ),
2249 PSA_ERROR_BAD_STATE );
2250 PSA_ASSERT( psa_mac_abort( &operation ) );
2251
2252 /* Setup verify but try sign. */
Ronald Cron5425a212020-08-04 14:58:35 +02002253 PSA_ASSERT( psa_mac_verify_setup( &operation, key, alg ) );
Jaeden Amero252ef282019-02-15 14:05:35 +00002254 PSA_ASSERT( psa_mac_update( &operation, input, sizeof( input ) ) );
2255 TEST_EQUAL( psa_mac_sign_finish( &operation,
2256 sign_mac, sizeof( sign_mac ),
2257 &sign_mac_length ),
2258 PSA_ERROR_BAD_STATE );
2259 PSA_ASSERT( psa_mac_abort( &operation ) );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002260
Ronald Cron5425a212020-08-04 14:58:35 +02002261 PSA_ASSERT( psa_destroy_key( key ) );
Gilles Peskine76b29a72019-05-28 14:08:50 +02002262
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002263exit:
Gilles Peskine1153e7b2019-05-28 15:10:21 +02002264 PSA_DONE( );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002265}
2266/* END_CASE */
2267
2268/* BEGIN_CASE */
Gilles Peskinea7aa4422018-08-14 15:17:54 +02002269void mac_sign( int key_type_arg,
Ronald Cron5425a212020-08-04 14:58:35 +02002270 data_t *key_data,
Gilles Peskinea7aa4422018-08-14 15:17:54 +02002271 int alg_arg,
2272 data_t *input,
2273 data_t *expected_mac )
2274{
Ronald Cron5425a212020-08-04 14:58:35 +02002275 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskinea7aa4422018-08-14 15:17:54 +02002276 psa_key_type_t key_type = key_type_arg;
2277 psa_algorithm_t alg = alg_arg;
Jaeden Amero769ce272019-01-04 11:48:03 +00002278 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02002279 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine5e65cec2020-08-25 23:38:39 +02002280 uint8_t *actual_mac = NULL;
Gilles Peskinea7aa4422018-08-14 15:17:54 +02002281 size_t mac_buffer_size =
gabor-mezei-armcbcec212020-12-18 14:23:51 +01002282 PSA_MAC_LENGTH( key_type, PSA_BYTES_TO_BITS( key_data->len ), alg );
Gilles Peskinea7aa4422018-08-14 15:17:54 +02002283 size_t mac_length = 0;
Gilles Peskine8b356b52020-08-25 23:44:59 +02002284 const size_t output_sizes_to_test[] = {
2285 0,
2286 1,
2287 expected_mac->len - 1,
2288 expected_mac->len,
2289 expected_mac->len + 1,
2290 };
Gilles Peskinea7aa4422018-08-14 15:17:54 +02002291
Gilles Peskinea7aa4422018-08-14 15:17:54 +02002292 TEST_ASSERT( mac_buffer_size <= PSA_MAC_MAX_SIZE );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01002293 /* We expect PSA_MAC_LENGTH to be exact. */
Gilles Peskine3d404d62020-08-25 23:47:36 +02002294 TEST_ASSERT( expected_mac->len == mac_buffer_size );
Gilles Peskinea7aa4422018-08-14 15:17:54 +02002295
Gilles Peskine8817f612018-12-18 00:18:46 +01002296 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskinea7aa4422018-08-14 15:17:54 +02002297
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01002298 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_HASH );
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02002299 psa_set_key_algorithm( &attributes, alg );
2300 psa_set_key_type( &attributes, key_type );
Gilles Peskinea7aa4422018-08-14 15:17:54 +02002301
Ronald Cron5425a212020-08-04 14:58:35 +02002302 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
2303 &key ) );
Gilles Peskinea7aa4422018-08-14 15:17:54 +02002304
Gilles Peskine8b356b52020-08-25 23:44:59 +02002305 for( size_t i = 0; i < ARRAY_LENGTH( output_sizes_to_test ); i++ )
2306 {
2307 const size_t output_size = output_sizes_to_test[i];
2308 psa_status_t expected_status =
2309 ( output_size >= expected_mac->len ? PSA_SUCCESS :
2310 PSA_ERROR_BUFFER_TOO_SMALL );
Gilles Peskine5e65cec2020-08-25 23:38:39 +02002311
Chris Jones9634bb12021-01-20 15:56:42 +00002312 mbedtls_test_set_step( output_size );
Gilles Peskine8b356b52020-08-25 23:44:59 +02002313 ASSERT_ALLOC( actual_mac, output_size );
Gilles Peskinea7aa4422018-08-14 15:17:54 +02002314
Gilles Peskine8b356b52020-08-25 23:44:59 +02002315 /* Calculate the MAC. */
Ronald Cron5425a212020-08-04 14:58:35 +02002316 PSA_ASSERT( psa_mac_sign_setup( &operation, key, alg ) );
Gilles Peskine8b356b52020-08-25 23:44:59 +02002317 PSA_ASSERT( psa_mac_update( &operation,
2318 input->x, input->len ) );
2319 TEST_EQUAL( psa_mac_sign_finish( &operation,
2320 actual_mac, output_size,
2321 &mac_length ),
2322 expected_status );
2323 PSA_ASSERT( psa_mac_abort( &operation ) );
2324
2325 if( expected_status == PSA_SUCCESS )
2326 {
2327 ASSERT_COMPARE( expected_mac->x, expected_mac->len,
2328 actual_mac, mac_length );
2329 }
2330 mbedtls_free( actual_mac );
2331 actual_mac = NULL;
2332 }
Gilles Peskinea7aa4422018-08-14 15:17:54 +02002333
Gilles Peskinea7aa4422018-08-14 15:17:54 +02002334exit:
Gilles Peskine64f13ef2020-08-25 23:15:20 +02002335 psa_mac_abort( &operation );
Ronald Cron5425a212020-08-04 14:58:35 +02002336 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02002337 PSA_DONE( );
Gilles Peskine5e65cec2020-08-25 23:38:39 +02002338 mbedtls_free( actual_mac );
Gilles Peskinea7aa4422018-08-14 15:17:54 +02002339}
2340/* END_CASE */
2341
2342/* BEGIN_CASE */
Gilles Peskinec0ec9722018-06-18 17:03:37 +02002343void mac_verify( int key_type_arg,
Ronald Cron5425a212020-08-04 14:58:35 +02002344 data_t *key_data,
Gilles Peskinec0ec9722018-06-18 17:03:37 +02002345 int alg_arg,
2346 data_t *input,
2347 data_t *expected_mac )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002348{
Ronald Cron5425a212020-08-04 14:58:35 +02002349 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002350 psa_key_type_t key_type = key_type_arg;
2351 psa_algorithm_t alg = alg_arg;
Jaeden Amero769ce272019-01-04 11:48:03 +00002352 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02002353 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine29c4a6c2020-08-26 00:01:39 +02002354 uint8_t *perturbed_mac = NULL;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002355
Gilles Peskine69c12672018-06-28 00:07:19 +02002356 TEST_ASSERT( expected_mac->len <= PSA_MAC_MAX_SIZE );
2357
Gilles Peskine8817f612018-12-18 00:18:46 +01002358 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002359
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01002360 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_VERIFY_HASH );
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02002361 psa_set_key_algorithm( &attributes, alg );
2362 psa_set_key_type( &attributes, key_type );
mohammad16036df908f2018-04-02 08:34:15 -07002363
Ronald Cron5425a212020-08-04 14:58:35 +02002364 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
2365 &key ) );
Gilles Peskinec0ec9722018-06-18 17:03:37 +02002366
Gilles Peskine29c4a6c2020-08-26 00:01:39 +02002367 /* Test the correct MAC. */
Ronald Cron5425a212020-08-04 14:58:35 +02002368 PSA_ASSERT( psa_mac_verify_setup( &operation, key, alg ) );
Gilles Peskine8817f612018-12-18 00:18:46 +01002369 PSA_ASSERT( psa_mac_update( &operation,
2370 input->x, input->len ) );
2371 PSA_ASSERT( psa_mac_verify_finish( &operation,
2372 expected_mac->x,
2373 expected_mac->len ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002374
Gilles Peskine29c4a6c2020-08-26 00:01:39 +02002375 /* Test a MAC that's too short. */
Ronald Cron5425a212020-08-04 14:58:35 +02002376 PSA_ASSERT( psa_mac_verify_setup( &operation, key, alg ) );
Gilles Peskine29c4a6c2020-08-26 00:01:39 +02002377 PSA_ASSERT( psa_mac_update( &operation,
2378 input->x, input->len ) );
2379 TEST_EQUAL( psa_mac_verify_finish( &operation,
2380 expected_mac->x,
2381 expected_mac->len - 1 ),
2382 PSA_ERROR_INVALID_SIGNATURE );
2383
2384 /* Test a MAC that's too long. */
2385 ASSERT_ALLOC( perturbed_mac, expected_mac->len + 1 );
2386 memcpy( perturbed_mac, expected_mac->x, expected_mac->len );
Ronald Cron5425a212020-08-04 14:58:35 +02002387 PSA_ASSERT( psa_mac_verify_setup( &operation, key, alg ) );
Gilles Peskine29c4a6c2020-08-26 00:01:39 +02002388 PSA_ASSERT( psa_mac_update( &operation,
2389 input->x, input->len ) );
2390 TEST_EQUAL( psa_mac_verify_finish( &operation,
2391 perturbed_mac,
2392 expected_mac->len + 1 ),
2393 PSA_ERROR_INVALID_SIGNATURE );
2394
2395 /* Test changing one byte. */
2396 for( size_t i = 0; i < expected_mac->len; i++ )
2397 {
Chris Jones9634bb12021-01-20 15:56:42 +00002398 mbedtls_test_set_step( i );
Gilles Peskine29c4a6c2020-08-26 00:01:39 +02002399 perturbed_mac[i] ^= 1;
Ronald Cron5425a212020-08-04 14:58:35 +02002400 PSA_ASSERT( psa_mac_verify_setup( &operation, key, alg ) );
Gilles Peskine29c4a6c2020-08-26 00:01:39 +02002401 PSA_ASSERT( psa_mac_update( &operation,
2402 input->x, input->len ) );
2403 TEST_EQUAL( psa_mac_verify_finish( &operation,
2404 perturbed_mac,
2405 expected_mac->len ),
2406 PSA_ERROR_INVALID_SIGNATURE );
2407 perturbed_mac[i] ^= 1;
2408 }
2409
Gilles Peskine8c9def32018-02-08 10:02:12 +01002410exit:
Gilles Peskine64f13ef2020-08-25 23:15:20 +02002411 psa_mac_abort( &operation );
Ronald Cron5425a212020-08-04 14:58:35 +02002412 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02002413 PSA_DONE( );
Gilles Peskine29c4a6c2020-08-26 00:01:39 +02002414 mbedtls_free( perturbed_mac );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002415}
2416/* END_CASE */
2417
2418/* BEGIN_CASE */
Jaeden Amero5bae2272019-01-04 11:48:27 +00002419void cipher_operation_init( )
2420{
Jaeden Ameroab439972019-02-15 14:12:05 +00002421 const uint8_t input[1] = { 0 };
2422 unsigned char output[1] = { 0 };
2423 size_t output_length;
Jaeden Amero5bae2272019-01-04 11:48:27 +00002424 /* Test each valid way of initializing the object, except for `= {0}`, as
2425 * Clang 5 complains when `-Wmissing-field-initializers` is used, even
2426 * though it's OK by the C standard. We could test for this, but we'd need
2427 * to supress the Clang warning for the test. */
2428 psa_cipher_operation_t func = psa_cipher_operation_init( );
2429 psa_cipher_operation_t init = PSA_CIPHER_OPERATION_INIT;
2430 psa_cipher_operation_t zero;
2431
2432 memset( &zero, 0, sizeof( zero ) );
2433
Jaeden Ameroab439972019-02-15 14:12:05 +00002434 /* A freshly-initialized cipher operation should not be usable. */
2435 TEST_EQUAL( psa_cipher_update( &func,
2436 input, sizeof( input ),
2437 output, sizeof( output ),
2438 &output_length ),
2439 PSA_ERROR_BAD_STATE );
2440 TEST_EQUAL( psa_cipher_update( &init,
2441 input, sizeof( input ),
2442 output, sizeof( output ),
2443 &output_length ),
2444 PSA_ERROR_BAD_STATE );
2445 TEST_EQUAL( psa_cipher_update( &zero,
2446 input, sizeof( input ),
2447 output, sizeof( output ),
2448 &output_length ),
2449 PSA_ERROR_BAD_STATE );
2450
Jaeden Amero5229bbb2019-02-07 16:33:37 +00002451 /* A default cipher operation should be abortable without error. */
2452 PSA_ASSERT( psa_cipher_abort( &func ) );
2453 PSA_ASSERT( psa_cipher_abort( &init ) );
2454 PSA_ASSERT( psa_cipher_abort( &zero ) );
Jaeden Amero5bae2272019-01-04 11:48:27 +00002455}
2456/* END_CASE */
2457
2458/* BEGIN_CASE */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002459void cipher_setup( int key_type_arg,
2460 data_t *key,
2461 int alg_arg,
2462 int expected_status_arg )
2463{
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002464 psa_key_type_t key_type = key_type_arg;
2465 psa_algorithm_t alg = alg_arg;
Gilles Peskineb866e2b2018-06-21 09:25:10 +02002466 psa_status_t expected_status = expected_status_arg;
Jaeden Amero5bae2272019-01-04 11:48:27 +00002467 psa_cipher_operation_t operation = PSA_CIPHER_OPERATION_INIT;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002468 psa_status_t status;
Gilles Peskine612ffd22021-01-20 18:51:00 +01002469#if defined(KNOWN_SUPPORTED_CIPHER_ALG)
Gilles Peskinef426e0f2019-02-25 17:42:03 +01002470 const uint8_t smoke_test_key_data[16] = "kkkkkkkkkkkkkkkk";
2471#endif
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002472
Gilles Peskine8817f612018-12-18 00:18:46 +01002473 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002474
Gilles Peskinef426e0f2019-02-25 17:42:03 +01002475 if( ! exercise_cipher_setup( key_type, key->x, key->len, alg,
2476 &operation, &status ) )
2477 goto exit;
Gilles Peskinefe11b722018-12-18 00:24:04 +01002478 TEST_EQUAL( status, expected_status );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002479
Gilles Peskinef426e0f2019-02-25 17:42:03 +01002480 /* The operation object should be reusable. */
2481#if defined(KNOWN_SUPPORTED_CIPHER_ALG)
2482 if( ! exercise_cipher_setup( KNOWN_SUPPORTED_CIPHER_KEY_TYPE,
2483 smoke_test_key_data,
2484 sizeof( smoke_test_key_data ),
2485 KNOWN_SUPPORTED_CIPHER_ALG,
2486 &operation, &status ) )
2487 goto exit;
2488 TEST_EQUAL( status, PSA_SUCCESS );
2489#endif
2490
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002491exit:
Gilles Peskine64f13ef2020-08-25 23:15:20 +02002492 psa_cipher_abort( &operation );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02002493 PSA_DONE( );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002494}
2495/* END_CASE */
2496
Ronald Cronee414c72021-03-18 18:50:08 +01002497/* BEGIN_CASE depends_on:PSA_WANT_KEY_TYPE_AES:PSA_WANT_ALG_CBC_PKCS7 */
Jaeden Ameroab439972019-02-15 14:12:05 +00002498void cipher_bad_order( )
2499{
Ronald Cron5425a212020-08-04 14:58:35 +02002500 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Jaeden Ameroab439972019-02-15 14:12:05 +00002501 psa_key_type_t key_type = PSA_KEY_TYPE_AES;
2502 psa_algorithm_t alg = PSA_ALG_CBC_PKCS7;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02002503 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Jaeden Ameroab439972019-02-15 14:12:05 +00002504 psa_cipher_operation_t operation = PSA_CIPHER_OPERATION_INIT;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01002505 unsigned char iv[PSA_BLOCK_CIPHER_BLOCK_LENGTH(PSA_KEY_TYPE_AES)] = { 0 };
Ronald Cron5425a212020-08-04 14:58:35 +02002506 const uint8_t key_data[] = {
Jaeden Ameroab439972019-02-15 14:12:05 +00002507 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa,
2508 0xaa, 0xaa, 0xaa, 0xaa };
2509 const uint8_t text[] = {
2510 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb,
2511 0xbb, 0xbb, 0xbb, 0xbb };
gabor-mezei-armcbcec212020-12-18 14:23:51 +01002512 uint8_t buffer[PSA_BLOCK_CIPHER_BLOCK_LENGTH(PSA_KEY_TYPE_AES)] = { 0 };
Jaeden Ameroab439972019-02-15 14:12:05 +00002513 size_t length = 0;
2514
2515 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02002516 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT | PSA_KEY_USAGE_DECRYPT );
2517 psa_set_key_algorithm( &attributes, alg );
2518 psa_set_key_type( &attributes, key_type );
Ronald Cron5425a212020-08-04 14:58:35 +02002519 PSA_ASSERT( psa_import_key( &attributes, key_data, sizeof( key_data ),
2520 &key ) );
Jaeden Ameroab439972019-02-15 14:12:05 +00002521
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002522 /* Call encrypt setup twice in a row. */
Ronald Cron5425a212020-08-04 14:58:35 +02002523 PSA_ASSERT( psa_cipher_encrypt_setup( &operation, key, alg ) );
2524 TEST_EQUAL( psa_cipher_encrypt_setup( &operation, key, alg ),
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002525 PSA_ERROR_BAD_STATE );
2526 PSA_ASSERT( psa_cipher_abort( &operation ) );
2527
2528 /* Call decrypt setup twice in a row. */
Ronald Cron5425a212020-08-04 14:58:35 +02002529 PSA_ASSERT( psa_cipher_decrypt_setup( &operation, key, alg ) );
2530 TEST_EQUAL( psa_cipher_decrypt_setup( &operation, key, alg ),
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002531 PSA_ERROR_BAD_STATE );
2532 PSA_ASSERT( psa_cipher_abort( &operation ) );
2533
Jaeden Ameroab439972019-02-15 14:12:05 +00002534 /* Generate an IV without calling setup beforehand. */
2535 TEST_EQUAL( psa_cipher_generate_iv( &operation,
2536 buffer, sizeof( buffer ),
2537 &length ),
2538 PSA_ERROR_BAD_STATE );
2539 PSA_ASSERT( psa_cipher_abort( &operation ) );
2540
2541 /* Generate an IV twice in a row. */
Ronald Cron5425a212020-08-04 14:58:35 +02002542 PSA_ASSERT( psa_cipher_encrypt_setup( &operation, key, alg ) );
Jaeden Ameroab439972019-02-15 14:12:05 +00002543 PSA_ASSERT( psa_cipher_generate_iv( &operation,
2544 buffer, sizeof( buffer ),
2545 &length ) );
2546 TEST_EQUAL( psa_cipher_generate_iv( &operation,
2547 buffer, sizeof( buffer ),
2548 &length ),
2549 PSA_ERROR_BAD_STATE );
2550 PSA_ASSERT( psa_cipher_abort( &operation ) );
2551
2552 /* Generate an IV after it's already set. */
Ronald Cron5425a212020-08-04 14:58:35 +02002553 PSA_ASSERT( psa_cipher_encrypt_setup( &operation, key, alg ) );
Jaeden Ameroab439972019-02-15 14:12:05 +00002554 PSA_ASSERT( psa_cipher_set_iv( &operation,
2555 iv, sizeof( iv ) ) );
2556 TEST_EQUAL( psa_cipher_generate_iv( &operation,
2557 buffer, sizeof( buffer ),
2558 &length ),
2559 PSA_ERROR_BAD_STATE );
2560 PSA_ASSERT( psa_cipher_abort( &operation ) );
2561
2562 /* Set an IV without calling setup beforehand. */
2563 TEST_EQUAL( psa_cipher_set_iv( &operation,
2564 iv, sizeof( iv ) ),
2565 PSA_ERROR_BAD_STATE );
2566 PSA_ASSERT( psa_cipher_abort( &operation ) );
2567
2568 /* Set an IV after it's already set. */
Ronald Cron5425a212020-08-04 14:58:35 +02002569 PSA_ASSERT( psa_cipher_encrypt_setup( &operation, key, alg ) );
Jaeden Ameroab439972019-02-15 14:12:05 +00002570 PSA_ASSERT( psa_cipher_set_iv( &operation,
2571 iv, sizeof( iv ) ) );
2572 TEST_EQUAL( psa_cipher_set_iv( &operation,
2573 iv, sizeof( iv ) ),
2574 PSA_ERROR_BAD_STATE );
2575 PSA_ASSERT( psa_cipher_abort( &operation ) );
2576
2577 /* Set an IV after it's already generated. */
Ronald Cron5425a212020-08-04 14:58:35 +02002578 PSA_ASSERT( psa_cipher_encrypt_setup( &operation, key, alg ) );
Jaeden Ameroab439972019-02-15 14:12:05 +00002579 PSA_ASSERT( psa_cipher_generate_iv( &operation,
2580 buffer, sizeof( buffer ),
2581 &length ) );
2582 TEST_EQUAL( psa_cipher_set_iv( &operation,
2583 iv, sizeof( iv ) ),
2584 PSA_ERROR_BAD_STATE );
2585 PSA_ASSERT( psa_cipher_abort( &operation ) );
2586
2587 /* Call update without calling setup beforehand. */
2588 TEST_EQUAL( psa_cipher_update( &operation,
2589 text, sizeof( text ),
2590 buffer, sizeof( buffer ),
2591 &length ),
2592 PSA_ERROR_BAD_STATE );
2593 PSA_ASSERT( psa_cipher_abort( &operation ) );
2594
2595 /* Call update without an IV where an IV is required. */
2596 TEST_EQUAL( psa_cipher_update( &operation,
2597 text, sizeof( text ),
2598 buffer, sizeof( buffer ),
2599 &length ),
2600 PSA_ERROR_BAD_STATE );
2601 PSA_ASSERT( psa_cipher_abort( &operation ) );
2602
2603 /* Call update after finish. */
Ronald Cron5425a212020-08-04 14:58:35 +02002604 PSA_ASSERT( psa_cipher_encrypt_setup( &operation, key, alg ) );
Jaeden Ameroab439972019-02-15 14:12:05 +00002605 PSA_ASSERT( psa_cipher_set_iv( &operation,
2606 iv, sizeof( iv ) ) );
2607 PSA_ASSERT( psa_cipher_finish( &operation,
2608 buffer, sizeof( buffer ), &length ) );
2609 TEST_EQUAL( psa_cipher_update( &operation,
2610 text, sizeof( text ),
2611 buffer, sizeof( buffer ),
2612 &length ),
2613 PSA_ERROR_BAD_STATE );
2614 PSA_ASSERT( psa_cipher_abort( &operation ) );
2615
2616 /* Call finish without calling setup beforehand. */
2617 TEST_EQUAL( psa_cipher_finish( &operation,
2618 buffer, sizeof( buffer ), &length ),
2619 PSA_ERROR_BAD_STATE );
2620 PSA_ASSERT( psa_cipher_abort( &operation ) );
2621
2622 /* Call finish without an IV where an IV is required. */
Ronald Cron5425a212020-08-04 14:58:35 +02002623 PSA_ASSERT( psa_cipher_encrypt_setup( &operation, key, alg ) );
Jaeden Ameroab439972019-02-15 14:12:05 +00002624 /* Not calling update means we are encrypting an empty buffer, which is OK
2625 * for cipher modes with padding. */
2626 TEST_EQUAL( psa_cipher_finish( &operation,
2627 buffer, sizeof( buffer ), &length ),
2628 PSA_ERROR_BAD_STATE );
2629 PSA_ASSERT( psa_cipher_abort( &operation ) );
2630
2631 /* Call finish twice in a row. */
Ronald Cron5425a212020-08-04 14:58:35 +02002632 PSA_ASSERT( psa_cipher_encrypt_setup( &operation, key, alg ) );
Jaeden Ameroab439972019-02-15 14:12:05 +00002633 PSA_ASSERT( psa_cipher_set_iv( &operation,
2634 iv, sizeof( iv ) ) );
2635 PSA_ASSERT( psa_cipher_finish( &operation,
2636 buffer, sizeof( buffer ), &length ) );
2637 TEST_EQUAL( psa_cipher_finish( &operation,
2638 buffer, sizeof( buffer ), &length ),
2639 PSA_ERROR_BAD_STATE );
2640 PSA_ASSERT( psa_cipher_abort( &operation ) );
2641
Ronald Cron5425a212020-08-04 14:58:35 +02002642 PSA_ASSERT( psa_destroy_key( key ) );
Gilles Peskine76b29a72019-05-28 14:08:50 +02002643
Jaeden Ameroab439972019-02-15 14:12:05 +00002644exit:
Gilles Peskine64f13ef2020-08-25 23:15:20 +02002645 psa_cipher_abort( &operation );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02002646 PSA_DONE( );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002647}
2648/* END_CASE */
2649
2650/* BEGIN_CASE */
Gilles Peskine50e586b2018-06-08 14:28:46 +02002651void cipher_encrypt( int alg_arg, int key_type_arg,
Ronald Cron5425a212020-08-04 14:58:35 +02002652 data_t *key_data, data_t *iv,
itayzafrir3e02b3b2018-06-12 17:06:52 +03002653 data_t *input, data_t *expected_output,
Gilles Peskineb866e2b2018-06-21 09:25:10 +02002654 int expected_status_arg )
Gilles Peskine50e586b2018-06-08 14:28:46 +02002655{
Ronald Cron5425a212020-08-04 14:58:35 +02002656 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine50e586b2018-06-08 14:28:46 +02002657 psa_status_t status;
2658 psa_key_type_t key_type = key_type_arg;
2659 psa_algorithm_t alg = alg_arg;
Gilles Peskineb866e2b2018-06-21 09:25:10 +02002660 psa_status_t expected_status = expected_status_arg;
itayzafrir3e02b3b2018-06-12 17:06:52 +03002661 unsigned char *output = NULL;
Gilles Peskine50e586b2018-06-08 14:28:46 +02002662 size_t output_buffer_size = 0;
2663 size_t function_output_length = 0;
Gilles Peskinea7ec95f2018-06-08 14:40:59 +02002664 size_t total_output_length = 0;
Jaeden Amero5bae2272019-01-04 11:48:27 +00002665 psa_cipher_operation_t operation = PSA_CIPHER_OPERATION_INIT;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02002666 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine50e586b2018-06-08 14:28:46 +02002667
Gilles Peskine8817f612018-12-18 00:18:46 +01002668 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine50e586b2018-06-08 14:28:46 +02002669
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02002670 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
2671 psa_set_key_algorithm( &attributes, alg );
2672 psa_set_key_type( &attributes, key_type );
Moran Pekered346952018-07-05 15:22:45 +03002673
Ronald Cron5425a212020-08-04 14:58:35 +02002674 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
2675 &key ) );
Gilles Peskine50e586b2018-06-08 14:28:46 +02002676
Ronald Cron5425a212020-08-04 14:58:35 +02002677 PSA_ASSERT( psa_cipher_encrypt_setup( &operation, key, alg ) );
Gilles Peskine50e586b2018-06-08 14:28:46 +02002678
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02002679 if( iv->len > 0 )
2680 {
Steven Cooremana6033e92020-08-25 11:47:50 +02002681 PSA_ASSERT( psa_cipher_set_iv( &operation, iv->x, iv->len ) );
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02002682 }
2683
gabor-mezei-armceface22021-01-21 12:26:17 +01002684 output_buffer_size = PSA_CIPHER_ENCRYPT_OUTPUT_SIZE( key_type, alg, input->len );
2685 TEST_ASSERT( output_buffer_size <=
2686 PSA_CIPHER_ENCRYPT_OUTPUT_MAX_SIZE( input->len ) );
Gilles Peskine8cebbba2018-09-27 13:54:18 +02002687 ASSERT_ALLOC( output, output_buffer_size );
Gilles Peskine50e586b2018-06-08 14:28:46 +02002688
Gilles Peskine8817f612018-12-18 00:18:46 +01002689 PSA_ASSERT( psa_cipher_update( &operation,
2690 input->x, input->len,
2691 output, output_buffer_size,
2692 &function_output_length ) );
gabor-mezei-armceface22021-01-21 12:26:17 +01002693 TEST_ASSERT( function_output_length <=
2694 PSA_CIPHER_UPDATE_OUTPUT_SIZE( key_type, alg, input->len ) );
2695 TEST_ASSERT( function_output_length <=
2696 PSA_CIPHER_UPDATE_OUTPUT_MAX_SIZE( input->len ) );
Gilles Peskinea7ec95f2018-06-08 14:40:59 +02002697 total_output_length += function_output_length;
gabor-mezei-armceface22021-01-21 12:26:17 +01002698
Gilles Peskine50e586b2018-06-08 14:28:46 +02002699 status = psa_cipher_finish( &operation,
Gilles Peskine0c510f32021-03-24 00:41:51 +01002700 ( output_buffer_size == 0 ? NULL :
2701 output + total_output_length ),
Gilles Peskineee46fe72019-02-19 19:05:33 +01002702 output_buffer_size - total_output_length,
Gilles Peskine50e586b2018-06-08 14:28:46 +02002703 &function_output_length );
gabor-mezei-armceface22021-01-21 12:26:17 +01002704 TEST_ASSERT( function_output_length <=
2705 PSA_CIPHER_FINISH_OUTPUT_SIZE( key_type, alg ) );
2706 TEST_ASSERT( function_output_length <=
2707 PSA_CIPHER_FINISH_OUTPUT_MAX_SIZE );
Gilles Peskinea7ec95f2018-06-08 14:40:59 +02002708 total_output_length += function_output_length;
2709
Gilles Peskinefe11b722018-12-18 00:24:04 +01002710 TEST_EQUAL( status, expected_status );
Gilles Peskine50e586b2018-06-08 14:28:46 +02002711 if( expected_status == PSA_SUCCESS )
2712 {
Gilles Peskine8817f612018-12-18 00:18:46 +01002713 PSA_ASSERT( psa_cipher_abort( &operation ) );
Gilles Peskinebd7dea92018-09-27 13:57:19 +02002714 ASSERT_COMPARE( expected_output->x, expected_output->len,
2715 output, total_output_length );
Gilles Peskine50e586b2018-06-08 14:28:46 +02002716 }
Gilles Peskinea7ec95f2018-06-08 14:40:59 +02002717
Gilles Peskine50e586b2018-06-08 14:28:46 +02002718exit:
Gilles Peskine64f13ef2020-08-25 23:15:20 +02002719 psa_cipher_abort( &operation );
itayzafrir3e02b3b2018-06-12 17:06:52 +03002720 mbedtls_free( output );
Ronald Cron5425a212020-08-04 14:58:35 +02002721 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02002722 PSA_DONE( );
Gilles Peskine50e586b2018-06-08 14:28:46 +02002723}
2724/* END_CASE */
2725
2726/* BEGIN_CASE */
2727void cipher_encrypt_multipart( int alg_arg, int key_type_arg,
Ronald Cron5425a212020-08-04 14:58:35 +02002728 data_t *key_data, data_t *iv,
itayzafrir3e02b3b2018-06-12 17:06:52 +03002729 data_t *input,
Gilles Peskinee0866522019-02-19 19:44:00 +01002730 int first_part_size_arg,
2731 int output1_length_arg, int output2_length_arg,
itayzafrir3e02b3b2018-06-12 17:06:52 +03002732 data_t *expected_output )
Gilles Peskine50e586b2018-06-08 14:28:46 +02002733{
Ronald Cron5425a212020-08-04 14:58:35 +02002734 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine50e586b2018-06-08 14:28:46 +02002735 psa_key_type_t key_type = key_type_arg;
2736 psa_algorithm_t alg = alg_arg;
Gilles Peskinee0866522019-02-19 19:44:00 +01002737 size_t first_part_size = first_part_size_arg;
2738 size_t output1_length = output1_length_arg;
2739 size_t output2_length = output2_length_arg;
itayzafrir3e02b3b2018-06-12 17:06:52 +03002740 unsigned char *output = NULL;
Gilles Peskine50e586b2018-06-08 14:28:46 +02002741 size_t output_buffer_size = 0;
2742 size_t function_output_length = 0;
Gilles Peskinea7ec95f2018-06-08 14:40:59 +02002743 size_t total_output_length = 0;
Jaeden Amero5bae2272019-01-04 11:48:27 +00002744 psa_cipher_operation_t operation = PSA_CIPHER_OPERATION_INIT;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02002745 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine50e586b2018-06-08 14:28:46 +02002746
Gilles Peskine8817f612018-12-18 00:18:46 +01002747 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine50e586b2018-06-08 14:28:46 +02002748
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02002749 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
2750 psa_set_key_algorithm( &attributes, alg );
2751 psa_set_key_type( &attributes, key_type );
Moran Pekered346952018-07-05 15:22:45 +03002752
Ronald Cron5425a212020-08-04 14:58:35 +02002753 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
2754 &key ) );
Gilles Peskine50e586b2018-06-08 14:28:46 +02002755
Ronald Cron5425a212020-08-04 14:58:35 +02002756 PSA_ASSERT( psa_cipher_encrypt_setup( &operation, key, alg ) );
Gilles Peskine50e586b2018-06-08 14:28:46 +02002757
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02002758 if( iv->len > 0 )
2759 {
Steven Cooremana6033e92020-08-25 11:47:50 +02002760 PSA_ASSERT( psa_cipher_set_iv( &operation, iv->x, iv->len ) );
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02002761 }
2762
gabor-mezei-armceface22021-01-21 12:26:17 +01002763 output_buffer_size = PSA_CIPHER_ENCRYPT_OUTPUT_SIZE( key_type, alg, input->len );
2764 TEST_ASSERT( output_buffer_size <=
2765 PSA_CIPHER_ENCRYPT_OUTPUT_MAX_SIZE( input->len ) );
Gilles Peskine8cebbba2018-09-27 13:54:18 +02002766 ASSERT_ALLOC( output, output_buffer_size );
Gilles Peskine50e586b2018-06-08 14:28:46 +02002767
Gilles Peskinee0866522019-02-19 19:44:00 +01002768 TEST_ASSERT( first_part_size <= input->len );
Gilles Peskine8817f612018-12-18 00:18:46 +01002769 PSA_ASSERT( psa_cipher_update( &operation, input->x, first_part_size,
2770 output, output_buffer_size,
2771 &function_output_length ) );
Gilles Peskinee0866522019-02-19 19:44:00 +01002772 TEST_ASSERT( function_output_length == output1_length );
gabor-mezei-armceface22021-01-21 12:26:17 +01002773 TEST_ASSERT( function_output_length <=
2774 PSA_CIPHER_UPDATE_OUTPUT_SIZE( key_type, alg, first_part_size ) );
2775 TEST_ASSERT( function_output_length <=
2776 PSA_CIPHER_UPDATE_OUTPUT_MAX_SIZE( first_part_size) );
Gilles Peskinea7ec95f2018-06-08 14:40:59 +02002777 total_output_length += function_output_length;
gabor-mezei-armceface22021-01-21 12:26:17 +01002778
Gilles Peskine8817f612018-12-18 00:18:46 +01002779 PSA_ASSERT( psa_cipher_update( &operation,
2780 input->x + first_part_size,
2781 input->len - first_part_size,
Gilles Peskine0c510f32021-03-24 00:41:51 +01002782 ( output_buffer_size == 0 ? NULL :
2783 output + total_output_length ),
Gilles Peskineee46fe72019-02-19 19:05:33 +01002784 output_buffer_size - total_output_length,
Gilles Peskine8817f612018-12-18 00:18:46 +01002785 &function_output_length ) );
Gilles Peskinee0866522019-02-19 19:44:00 +01002786 TEST_ASSERT( function_output_length == output2_length );
gabor-mezei-armceface22021-01-21 12:26:17 +01002787 TEST_ASSERT( function_output_length <=
2788 PSA_CIPHER_UPDATE_OUTPUT_SIZE( key_type,
2789 alg,
2790 input->len - first_part_size ) );
2791 TEST_ASSERT( function_output_length <=
2792 PSA_CIPHER_UPDATE_OUTPUT_MAX_SIZE( input->len ) );
Gilles Peskinea7ec95f2018-06-08 14:40:59 +02002793 total_output_length += function_output_length;
gabor-mezei-armceface22021-01-21 12:26:17 +01002794
Gilles Peskine8817f612018-12-18 00:18:46 +01002795 PSA_ASSERT( psa_cipher_finish( &operation,
Gilles Peskine0c510f32021-03-24 00:41:51 +01002796 ( output_buffer_size == 0 ? NULL :
2797 output + total_output_length ),
Gilles Peskineee46fe72019-02-19 19:05:33 +01002798 output_buffer_size - total_output_length,
Gilles Peskine8817f612018-12-18 00:18:46 +01002799 &function_output_length ) );
gabor-mezei-armceface22021-01-21 12:26:17 +01002800 TEST_ASSERT( function_output_length <=
2801 PSA_CIPHER_FINISH_OUTPUT_SIZE( key_type, alg ) );
2802 TEST_ASSERT( function_output_length <=
2803 PSA_CIPHER_FINISH_OUTPUT_MAX_SIZE );
Gilles Peskinea7ec95f2018-06-08 14:40:59 +02002804 total_output_length += function_output_length;
Gilles Peskine8817f612018-12-18 00:18:46 +01002805 PSA_ASSERT( psa_cipher_abort( &operation ) );
Gilles Peskine50e586b2018-06-08 14:28:46 +02002806
Gilles Peskinebd7dea92018-09-27 13:57:19 +02002807 ASSERT_COMPARE( expected_output->x, expected_output->len,
2808 output, total_output_length );
Gilles Peskine50e586b2018-06-08 14:28:46 +02002809
2810exit:
Gilles Peskine64f13ef2020-08-25 23:15:20 +02002811 psa_cipher_abort( &operation );
itayzafrir3e02b3b2018-06-12 17:06:52 +03002812 mbedtls_free( output );
Ronald Cron5425a212020-08-04 14:58:35 +02002813 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02002814 PSA_DONE( );
Gilles Peskine50e586b2018-06-08 14:28:46 +02002815}
2816/* END_CASE */
2817
2818/* BEGIN_CASE */
2819void cipher_decrypt_multipart( int alg_arg, int key_type_arg,
Ronald Cron5425a212020-08-04 14:58:35 +02002820 data_t *key_data, data_t *iv,
itayzafrir3e02b3b2018-06-12 17:06:52 +03002821 data_t *input,
Gilles Peskinee0866522019-02-19 19:44:00 +01002822 int first_part_size_arg,
2823 int output1_length_arg, int output2_length_arg,
itayzafrir3e02b3b2018-06-12 17:06:52 +03002824 data_t *expected_output )
Gilles Peskine50e586b2018-06-08 14:28:46 +02002825{
Ronald Cron5425a212020-08-04 14:58:35 +02002826 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine50e586b2018-06-08 14:28:46 +02002827 psa_key_type_t key_type = key_type_arg;
2828 psa_algorithm_t alg = alg_arg;
Gilles Peskinee0866522019-02-19 19:44:00 +01002829 size_t first_part_size = first_part_size_arg;
2830 size_t output1_length = output1_length_arg;
2831 size_t output2_length = output2_length_arg;
itayzafrir3e02b3b2018-06-12 17:06:52 +03002832 unsigned char *output = NULL;
Gilles Peskine50e586b2018-06-08 14:28:46 +02002833 size_t output_buffer_size = 0;
2834 size_t function_output_length = 0;
Gilles Peskinea7ec95f2018-06-08 14:40:59 +02002835 size_t total_output_length = 0;
Jaeden Amero5bae2272019-01-04 11:48:27 +00002836 psa_cipher_operation_t operation = PSA_CIPHER_OPERATION_INIT;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02002837 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine50e586b2018-06-08 14:28:46 +02002838
Gilles Peskine8817f612018-12-18 00:18:46 +01002839 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine50e586b2018-06-08 14:28:46 +02002840
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02002841 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DECRYPT );
2842 psa_set_key_algorithm( &attributes, alg );
2843 psa_set_key_type( &attributes, key_type );
Moran Pekered346952018-07-05 15:22:45 +03002844
Ronald Cron5425a212020-08-04 14:58:35 +02002845 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
2846 &key ) );
Gilles Peskine50e586b2018-06-08 14:28:46 +02002847
Ronald Cron5425a212020-08-04 14:58:35 +02002848 PSA_ASSERT( psa_cipher_decrypt_setup( &operation, key, alg ) );
Gilles Peskine50e586b2018-06-08 14:28:46 +02002849
Steven Cooreman177deba2020-09-07 17:14:14 +02002850 if( iv->len > 0 )
2851 {
Steven Cooremana6033e92020-08-25 11:47:50 +02002852 PSA_ASSERT( psa_cipher_set_iv( &operation, iv->x, iv->len ) );
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02002853 }
Gilles Peskine50e586b2018-06-08 14:28:46 +02002854
gabor-mezei-armceface22021-01-21 12:26:17 +01002855 output_buffer_size = PSA_CIPHER_DECRYPT_OUTPUT_SIZE( key_type, alg, input->len );
2856 TEST_ASSERT( output_buffer_size <=
2857 PSA_CIPHER_DECRYPT_OUTPUT_MAX_SIZE( input->len ) );
Gilles Peskine8cebbba2018-09-27 13:54:18 +02002858 ASSERT_ALLOC( output, output_buffer_size );
Gilles Peskine50e586b2018-06-08 14:28:46 +02002859
Gilles Peskinee0866522019-02-19 19:44:00 +01002860 TEST_ASSERT( first_part_size <= input->len );
Gilles Peskine8817f612018-12-18 00:18:46 +01002861 PSA_ASSERT( psa_cipher_update( &operation,
2862 input->x, first_part_size,
2863 output, output_buffer_size,
2864 &function_output_length ) );
Gilles Peskinee0866522019-02-19 19:44:00 +01002865 TEST_ASSERT( function_output_length == output1_length );
gabor-mezei-armceface22021-01-21 12:26:17 +01002866 TEST_ASSERT( function_output_length <=
2867 PSA_CIPHER_UPDATE_OUTPUT_SIZE( key_type, alg, first_part_size ) );
2868 TEST_ASSERT( function_output_length <=
2869 PSA_CIPHER_UPDATE_OUTPUT_MAX_SIZE( first_part_size ) );
Gilles Peskinea7ec95f2018-06-08 14:40:59 +02002870 total_output_length += function_output_length;
gabor-mezei-armceface22021-01-21 12:26:17 +01002871
Gilles Peskine8817f612018-12-18 00:18:46 +01002872 PSA_ASSERT( psa_cipher_update( &operation,
2873 input->x + first_part_size,
2874 input->len - first_part_size,
Gilles Peskine0c510f32021-03-24 00:41:51 +01002875 ( output_buffer_size == 0 ? NULL :
2876 output + total_output_length ),
Gilles Peskineee46fe72019-02-19 19:05:33 +01002877 output_buffer_size - total_output_length,
Gilles Peskine8817f612018-12-18 00:18:46 +01002878 &function_output_length ) );
Gilles Peskinee0866522019-02-19 19:44:00 +01002879 TEST_ASSERT( function_output_length == output2_length );
gabor-mezei-armceface22021-01-21 12:26:17 +01002880 TEST_ASSERT( function_output_length <=
2881 PSA_CIPHER_UPDATE_OUTPUT_SIZE( key_type,
2882 alg,
2883 input->len - first_part_size ) );
2884 TEST_ASSERT( function_output_length <=
2885 PSA_CIPHER_UPDATE_OUTPUT_MAX_SIZE( input->len ) );
Gilles Peskinea7ec95f2018-06-08 14:40:59 +02002886 total_output_length += function_output_length;
gabor-mezei-armceface22021-01-21 12:26:17 +01002887
Gilles Peskine8817f612018-12-18 00:18:46 +01002888 PSA_ASSERT( psa_cipher_finish( &operation,
Gilles Peskine0c510f32021-03-24 00:41:51 +01002889 ( output_buffer_size == 0 ? NULL :
2890 output + total_output_length ),
Gilles Peskineee46fe72019-02-19 19:05:33 +01002891 output_buffer_size - total_output_length,
Gilles Peskine8817f612018-12-18 00:18:46 +01002892 &function_output_length ) );
gabor-mezei-armceface22021-01-21 12:26:17 +01002893 TEST_ASSERT( function_output_length <=
2894 PSA_CIPHER_FINISH_OUTPUT_SIZE( key_type, alg ) );
2895 TEST_ASSERT( function_output_length <=
2896 PSA_CIPHER_FINISH_OUTPUT_MAX_SIZE );
Gilles Peskinea7ec95f2018-06-08 14:40:59 +02002897 total_output_length += function_output_length;
Gilles Peskine8817f612018-12-18 00:18:46 +01002898 PSA_ASSERT( psa_cipher_abort( &operation ) );
Gilles Peskine50e586b2018-06-08 14:28:46 +02002899
Gilles Peskinebd7dea92018-09-27 13:57:19 +02002900 ASSERT_COMPARE( expected_output->x, expected_output->len,
2901 output, total_output_length );
Gilles Peskine50e586b2018-06-08 14:28:46 +02002902
2903exit:
Gilles Peskine64f13ef2020-08-25 23:15:20 +02002904 psa_cipher_abort( &operation );
itayzafrir3e02b3b2018-06-12 17:06:52 +03002905 mbedtls_free( output );
Ronald Cron5425a212020-08-04 14:58:35 +02002906 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02002907 PSA_DONE( );
Gilles Peskine50e586b2018-06-08 14:28:46 +02002908}
2909/* END_CASE */
2910
Gilles Peskine50e586b2018-06-08 14:28:46 +02002911/* BEGIN_CASE */
2912void cipher_decrypt( int alg_arg, int key_type_arg,
Ronald Cron5425a212020-08-04 14:58:35 +02002913 data_t *key_data, data_t *iv,
itayzafrir3e02b3b2018-06-12 17:06:52 +03002914 data_t *input, data_t *expected_output,
Gilles Peskineb866e2b2018-06-21 09:25:10 +02002915 int expected_status_arg )
Gilles Peskine50e586b2018-06-08 14:28:46 +02002916{
Ronald Cron5425a212020-08-04 14:58:35 +02002917 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine50e586b2018-06-08 14:28:46 +02002918 psa_status_t status;
2919 psa_key_type_t key_type = key_type_arg;
2920 psa_algorithm_t alg = alg_arg;
Gilles Peskineb866e2b2018-06-21 09:25:10 +02002921 psa_status_t expected_status = expected_status_arg;
itayzafrir3e02b3b2018-06-12 17:06:52 +03002922 unsigned char *output = NULL;
Gilles Peskine50e586b2018-06-08 14:28:46 +02002923 size_t output_buffer_size = 0;
2924 size_t function_output_length = 0;
Gilles Peskinea7ec95f2018-06-08 14:40:59 +02002925 size_t total_output_length = 0;
Jaeden Amero5bae2272019-01-04 11:48:27 +00002926 psa_cipher_operation_t operation = PSA_CIPHER_OPERATION_INIT;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02002927 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine50e586b2018-06-08 14:28:46 +02002928
Gilles Peskine8817f612018-12-18 00:18:46 +01002929 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine50e586b2018-06-08 14:28:46 +02002930
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02002931 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DECRYPT );
2932 psa_set_key_algorithm( &attributes, alg );
2933 psa_set_key_type( &attributes, key_type );
Moran Pekered346952018-07-05 15:22:45 +03002934
Ronald Cron5425a212020-08-04 14:58:35 +02002935 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
2936 &key ) );
Gilles Peskine50e586b2018-06-08 14:28:46 +02002937
Ronald Cron5425a212020-08-04 14:58:35 +02002938 PSA_ASSERT( psa_cipher_decrypt_setup( &operation, key, alg ) );
Gilles Peskine50e586b2018-06-08 14:28:46 +02002939
Steven Cooreman177deba2020-09-07 17:14:14 +02002940 if( iv->len > 0 )
2941 {
Steven Cooremana6033e92020-08-25 11:47:50 +02002942 PSA_ASSERT( psa_cipher_set_iv( &operation, iv->x, iv->len ) );
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02002943 }
Gilles Peskine50e586b2018-06-08 14:28:46 +02002944
gabor-mezei-armceface22021-01-21 12:26:17 +01002945 output_buffer_size = PSA_CIPHER_DECRYPT_OUTPUT_SIZE( key_type, alg, input->len );
2946 TEST_ASSERT( output_buffer_size <=
2947 PSA_CIPHER_DECRYPT_OUTPUT_MAX_SIZE( input->len ) );
Gilles Peskine8cebbba2018-09-27 13:54:18 +02002948 ASSERT_ALLOC( output, output_buffer_size );
Gilles Peskine50e586b2018-06-08 14:28:46 +02002949
Gilles Peskine8817f612018-12-18 00:18:46 +01002950 PSA_ASSERT( psa_cipher_update( &operation,
2951 input->x, input->len,
2952 output, output_buffer_size,
2953 &function_output_length ) );
gabor-mezei-armceface22021-01-21 12:26:17 +01002954 TEST_ASSERT( function_output_length <=
2955 PSA_CIPHER_UPDATE_OUTPUT_SIZE( key_type, alg, input->len ) );
2956 TEST_ASSERT( function_output_length <=
2957 PSA_CIPHER_UPDATE_OUTPUT_MAX_SIZE( input->len ) );
Gilles Peskinea7ec95f2018-06-08 14:40:59 +02002958 total_output_length += function_output_length;
gabor-mezei-armceface22021-01-21 12:26:17 +01002959
Gilles Peskine50e586b2018-06-08 14:28:46 +02002960 status = psa_cipher_finish( &operation,
Gilles Peskine0c510f32021-03-24 00:41:51 +01002961 ( output_buffer_size == 0 ? NULL :
2962 output + total_output_length ),
Gilles Peskineee46fe72019-02-19 19:05:33 +01002963 output_buffer_size - total_output_length,
Gilles Peskine50e586b2018-06-08 14:28:46 +02002964 &function_output_length );
gabor-mezei-armceface22021-01-21 12:26:17 +01002965 TEST_ASSERT( function_output_length <=
2966 PSA_CIPHER_FINISH_OUTPUT_SIZE( key_type, alg ) );
2967 TEST_ASSERT( function_output_length <=
2968 PSA_CIPHER_FINISH_OUTPUT_MAX_SIZE );
Gilles Peskinea7ec95f2018-06-08 14:40:59 +02002969 total_output_length += function_output_length;
Gilles Peskinefe11b722018-12-18 00:24:04 +01002970 TEST_EQUAL( status, expected_status );
Gilles Peskine50e586b2018-06-08 14:28:46 +02002971
2972 if( expected_status == PSA_SUCCESS )
2973 {
Gilles Peskine8817f612018-12-18 00:18:46 +01002974 PSA_ASSERT( psa_cipher_abort( &operation ) );
Gilles Peskinebd7dea92018-09-27 13:57:19 +02002975 ASSERT_COMPARE( expected_output->x, expected_output->len,
2976 output, total_output_length );
Gilles Peskine50e586b2018-06-08 14:28:46 +02002977 }
2978
Gilles Peskine50e586b2018-06-08 14:28:46 +02002979exit:
Gilles Peskine64f13ef2020-08-25 23:15:20 +02002980 psa_cipher_abort( &operation );
itayzafrir3e02b3b2018-06-12 17:06:52 +03002981 mbedtls_free( output );
Ronald Cron5425a212020-08-04 14:58:35 +02002982 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02002983 PSA_DONE( );
Gilles Peskine50e586b2018-06-08 14:28:46 +02002984}
2985/* END_CASE */
2986
Gilles Peskine50e586b2018-06-08 14:28:46 +02002987/* BEGIN_CASE */
2988void cipher_verify_output( int alg_arg, int key_type_arg,
Ronald Cron5425a212020-08-04 14:58:35 +02002989 data_t *key_data,
itayzafrir3e02b3b2018-06-12 17:06:52 +03002990 data_t *input )
mohammad1603d7d7ba52018-03-12 18:51:53 +02002991{
Ronald Cron5425a212020-08-04 14:58:35 +02002992 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
mohammad1603d7d7ba52018-03-12 18:51:53 +02002993 psa_key_type_t key_type = key_type_arg;
2994 psa_algorithm_t alg = alg_arg;
mohammad1603e6b67a12018-03-12 10:38:49 -07002995 unsigned char iv[16] = {0};
mohammad1603d7d7ba52018-03-12 18:51:53 +02002996 size_t iv_size = 16;
2997 size_t iv_length = 0;
itayzafrir3e02b3b2018-06-12 17:06:52 +03002998 unsigned char *output1 = NULL;
mohammad1603d7d7ba52018-03-12 18:51:53 +02002999 size_t output1_size = 0;
3000 size_t output1_length = 0;
itayzafrir3e02b3b2018-06-12 17:06:52 +03003001 unsigned char *output2 = NULL;
mohammad1603d7d7ba52018-03-12 18:51:53 +02003002 size_t output2_size = 0;
3003 size_t output2_length = 0;
Gilles Peskine048b7f02018-06-08 14:20:49 +02003004 size_t function_output_length = 0;
Jaeden Amero5bae2272019-01-04 11:48:27 +00003005 psa_cipher_operation_t operation1 = PSA_CIPHER_OPERATION_INIT;
3006 psa_cipher_operation_t operation2 = PSA_CIPHER_OPERATION_INIT;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02003007 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
mohammad1603d7d7ba52018-03-12 18:51:53 +02003008
Gilles Peskine8817f612018-12-18 00:18:46 +01003009 PSA_ASSERT( psa_crypto_init( ) );
mohammad1603d7d7ba52018-03-12 18:51:53 +02003010
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02003011 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT | PSA_KEY_USAGE_DECRYPT );
3012 psa_set_key_algorithm( &attributes, alg );
3013 psa_set_key_type( &attributes, key_type );
Moran Pekered346952018-07-05 15:22:45 +03003014
Ronald Cron5425a212020-08-04 14:58:35 +02003015 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
3016 &key ) );
mohammad1603d7d7ba52018-03-12 18:51:53 +02003017
Ronald Cron5425a212020-08-04 14:58:35 +02003018 PSA_ASSERT( psa_cipher_encrypt_setup( &operation1, key, alg ) );
3019 PSA_ASSERT( psa_cipher_decrypt_setup( &operation2, key, alg ) );
mohammad1603d7d7ba52018-03-12 18:51:53 +02003020
Steven Cooreman177deba2020-09-07 17:14:14 +02003021 if( alg != PSA_ALG_ECB_NO_PADDING )
3022 {
Steven Cooremana6033e92020-08-25 11:47:50 +02003023 PSA_ASSERT( psa_cipher_generate_iv( &operation1,
3024 iv, iv_size,
3025 &iv_length ) );
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02003026 }
gabor-mezei-armceface22021-01-21 12:26:17 +01003027 output1_size = PSA_CIPHER_ENCRYPT_OUTPUT_SIZE( key_type, alg, input->len );
3028 TEST_ASSERT( output1_size <=
3029 PSA_CIPHER_ENCRYPT_OUTPUT_MAX_SIZE( input->len ) );
Gilles Peskine8cebbba2018-09-27 13:54:18 +02003030 ASSERT_ALLOC( output1, output1_size );
Moran Pekerded84402018-06-06 16:36:50 +03003031
Gilles Peskine8817f612018-12-18 00:18:46 +01003032 PSA_ASSERT( psa_cipher_update( &operation1, input->x, input->len,
3033 output1, output1_size,
3034 &output1_length ) );
gabor-mezei-armceface22021-01-21 12:26:17 +01003035 TEST_ASSERT( output1_length <=
3036 PSA_CIPHER_UPDATE_OUTPUT_SIZE( key_type, alg, input->len ) );
3037 TEST_ASSERT( output1_length <=
3038 PSA_CIPHER_UPDATE_OUTPUT_MAX_SIZE( input->len ) );
3039
Gilles Peskine8817f612018-12-18 00:18:46 +01003040 PSA_ASSERT( psa_cipher_finish( &operation1,
Gilles Peskineee46fe72019-02-19 19:05:33 +01003041 output1 + output1_length,
3042 output1_size - output1_length,
Gilles Peskine8817f612018-12-18 00:18:46 +01003043 &function_output_length ) );
gabor-mezei-armceface22021-01-21 12:26:17 +01003044 TEST_ASSERT( function_output_length <=
3045 PSA_CIPHER_FINISH_OUTPUT_SIZE( key_type, alg ) );
3046 TEST_ASSERT( function_output_length <=
3047 PSA_CIPHER_FINISH_OUTPUT_MAX_SIZE );
Gilles Peskine4ca9c3f2018-06-06 18:44:09 +02003048
Gilles Peskine048b7f02018-06-08 14:20:49 +02003049 output1_length += function_output_length;
Moran Pekerded84402018-06-06 16:36:50 +03003050
Gilles Peskine8817f612018-12-18 00:18:46 +01003051 PSA_ASSERT( psa_cipher_abort( &operation1 ) );
Moran Pekerded84402018-06-06 16:36:50 +03003052
3053 output2_size = output1_length;
gabor-mezei-armceface22021-01-21 12:26:17 +01003054 TEST_ASSERT( output2_size <=
3055 PSA_CIPHER_DECRYPT_OUTPUT_SIZE( key_type, alg, output1_length ) );
3056 TEST_ASSERT( output2_size <=
3057 PSA_CIPHER_DECRYPT_OUTPUT_MAX_SIZE( output1_length ) );
Gilles Peskine8cebbba2018-09-27 13:54:18 +02003058 ASSERT_ALLOC( output2, output2_size );
Moran Pekerded84402018-06-06 16:36:50 +03003059
Steven Cooreman177deba2020-09-07 17:14:14 +02003060 if( iv_length > 0 )
3061 {
Steven Cooremana6033e92020-08-25 11:47:50 +02003062 PSA_ASSERT( psa_cipher_set_iv( &operation2,
3063 iv, iv_length ) );
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02003064 }
3065
Gilles Peskine8817f612018-12-18 00:18:46 +01003066 PSA_ASSERT( psa_cipher_update( &operation2, output1, output1_length,
3067 output2, output2_size,
3068 &output2_length ) );
gabor-mezei-armceface22021-01-21 12:26:17 +01003069 TEST_ASSERT( output2_length <=
3070 PSA_CIPHER_UPDATE_OUTPUT_SIZE( key_type, alg, output1_length ) );
3071 TEST_ASSERT( output2_length <=
3072 PSA_CIPHER_UPDATE_OUTPUT_MAX_SIZE( output1_length ) );
3073
Gilles Peskine048b7f02018-06-08 14:20:49 +02003074 function_output_length = 0;
Gilles Peskine8817f612018-12-18 00:18:46 +01003075 PSA_ASSERT( psa_cipher_finish( &operation2,
3076 output2 + output2_length,
Gilles Peskineee46fe72019-02-19 19:05:33 +01003077 output2_size - output2_length,
Gilles Peskine8817f612018-12-18 00:18:46 +01003078 &function_output_length ) );
gabor-mezei-armceface22021-01-21 12:26:17 +01003079 TEST_ASSERT( function_output_length <=
3080 PSA_CIPHER_FINISH_OUTPUT_SIZE( key_type, alg ) );
3081 TEST_ASSERT( function_output_length <=
3082 PSA_CIPHER_FINISH_OUTPUT_MAX_SIZE );
Moran Pekerded84402018-06-06 16:36:50 +03003083
Gilles Peskine048b7f02018-06-08 14:20:49 +02003084 output2_length += function_output_length;
Gilles Peskine4ca9c3f2018-06-06 18:44:09 +02003085
Gilles Peskine8817f612018-12-18 00:18:46 +01003086 PSA_ASSERT( psa_cipher_abort( &operation2 ) );
Moran Pekerded84402018-06-06 16:36:50 +03003087
Gilles Peskinebd7dea92018-09-27 13:57:19 +02003088 ASSERT_COMPARE( input->x, input->len, output2, output2_length );
Moran Pekerded84402018-06-06 16:36:50 +03003089
3090exit:
Gilles Peskine64f13ef2020-08-25 23:15:20 +02003091 psa_cipher_abort( &operation1 );
3092 psa_cipher_abort( &operation2 );
itayzafrir3e02b3b2018-06-12 17:06:52 +03003093 mbedtls_free( output1 );
3094 mbedtls_free( output2 );
Ronald Cron5425a212020-08-04 14:58:35 +02003095 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02003096 PSA_DONE( );
Moran Pekerded84402018-06-06 16:36:50 +03003097}
3098/* END_CASE */
3099
3100/* BEGIN_CASE */
Gilles Peskine50e586b2018-06-08 14:28:46 +02003101void cipher_verify_output_multipart( int alg_arg,
3102 int key_type_arg,
Ronald Cron5425a212020-08-04 14:58:35 +02003103 data_t *key_data,
itayzafrir3e02b3b2018-06-12 17:06:52 +03003104 data_t *input,
Gilles Peskinee0866522019-02-19 19:44:00 +01003105 int first_part_size_arg )
Moran Pekerded84402018-06-06 16:36:50 +03003106{
Ronald Cron5425a212020-08-04 14:58:35 +02003107 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Moran Pekerded84402018-06-06 16:36:50 +03003108 psa_key_type_t key_type = key_type_arg;
3109 psa_algorithm_t alg = alg_arg;
Gilles Peskinee0866522019-02-19 19:44:00 +01003110 size_t first_part_size = first_part_size_arg;
Moran Pekerded84402018-06-06 16:36:50 +03003111 unsigned char iv[16] = {0};
3112 size_t iv_size = 16;
3113 size_t iv_length = 0;
itayzafrir3e02b3b2018-06-12 17:06:52 +03003114 unsigned char *output1 = NULL;
Gilles Peskine048b7f02018-06-08 14:20:49 +02003115 size_t output1_buffer_size = 0;
Moran Pekerded84402018-06-06 16:36:50 +03003116 size_t output1_length = 0;
itayzafrir3e02b3b2018-06-12 17:06:52 +03003117 unsigned char *output2 = NULL;
Gilles Peskine048b7f02018-06-08 14:20:49 +02003118 size_t output2_buffer_size = 0;
Moran Pekerded84402018-06-06 16:36:50 +03003119 size_t output2_length = 0;
Gilles Peskine048b7f02018-06-08 14:20:49 +02003120 size_t function_output_length;
Jaeden Amero5bae2272019-01-04 11:48:27 +00003121 psa_cipher_operation_t operation1 = PSA_CIPHER_OPERATION_INIT;
3122 psa_cipher_operation_t operation2 = PSA_CIPHER_OPERATION_INIT;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02003123 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Moran Pekerded84402018-06-06 16:36:50 +03003124
Gilles Peskine8817f612018-12-18 00:18:46 +01003125 PSA_ASSERT( psa_crypto_init( ) );
Moran Pekerded84402018-06-06 16:36:50 +03003126
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02003127 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT | PSA_KEY_USAGE_DECRYPT );
3128 psa_set_key_algorithm( &attributes, alg );
3129 psa_set_key_type( &attributes, key_type );
Moran Pekered346952018-07-05 15:22:45 +03003130
Ronald Cron5425a212020-08-04 14:58:35 +02003131 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
3132 &key ) );
Moran Pekerded84402018-06-06 16:36:50 +03003133
Ronald Cron5425a212020-08-04 14:58:35 +02003134 PSA_ASSERT( psa_cipher_encrypt_setup( &operation1, key, alg ) );
3135 PSA_ASSERT( psa_cipher_decrypt_setup( &operation2, key, alg ) );
Moran Pekerded84402018-06-06 16:36:50 +03003136
Steven Cooreman177deba2020-09-07 17:14:14 +02003137 if( alg != PSA_ALG_ECB_NO_PADDING )
3138 {
Steven Cooremana6033e92020-08-25 11:47:50 +02003139 PSA_ASSERT( psa_cipher_generate_iv( &operation1,
3140 iv, iv_size,
3141 &iv_length ) );
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02003142 }
3143
gabor-mezei-armceface22021-01-21 12:26:17 +01003144 output1_buffer_size = PSA_CIPHER_ENCRYPT_OUTPUT_SIZE( key_type, alg, input->len );
3145 TEST_ASSERT( output1_buffer_size <=
3146 PSA_CIPHER_ENCRYPT_OUTPUT_MAX_SIZE( input->len ) );
Gilles Peskine8cebbba2018-09-27 13:54:18 +02003147 ASSERT_ALLOC( output1, output1_buffer_size );
Moran Pekerded84402018-06-06 16:36:50 +03003148
Gilles Peskinee0866522019-02-19 19:44:00 +01003149 TEST_ASSERT( first_part_size <= input->len );
Gilles Peskine4ca9c3f2018-06-06 18:44:09 +02003150
Gilles Peskine8817f612018-12-18 00:18:46 +01003151 PSA_ASSERT( psa_cipher_update( &operation1, input->x, first_part_size,
3152 output1, output1_buffer_size,
3153 &function_output_length ) );
gabor-mezei-armceface22021-01-21 12:26:17 +01003154 TEST_ASSERT( function_output_length <=
3155 PSA_CIPHER_UPDATE_OUTPUT_SIZE( key_type, alg, first_part_size ) );
3156 TEST_ASSERT( function_output_length <=
3157 PSA_CIPHER_UPDATE_OUTPUT_MAX_SIZE( first_part_size ) );
Gilles Peskine048b7f02018-06-08 14:20:49 +02003158 output1_length += function_output_length;
Moran Pekerded84402018-06-06 16:36:50 +03003159
Gilles Peskine8817f612018-12-18 00:18:46 +01003160 PSA_ASSERT( psa_cipher_update( &operation1,
3161 input->x + first_part_size,
3162 input->len - first_part_size,
3163 output1, output1_buffer_size,
3164 &function_output_length ) );
gabor-mezei-armceface22021-01-21 12:26:17 +01003165 TEST_ASSERT( function_output_length <=
3166 PSA_CIPHER_UPDATE_OUTPUT_SIZE( key_type,
3167 alg,
3168 input->len - first_part_size ) );
3169 TEST_ASSERT( function_output_length <=
3170 PSA_CIPHER_UPDATE_OUTPUT_MAX_SIZE( input->len - first_part_size ) );
Gilles Peskine048b7f02018-06-08 14:20:49 +02003171 output1_length += function_output_length;
Moran Pekerded84402018-06-06 16:36:50 +03003172
Gilles Peskine8817f612018-12-18 00:18:46 +01003173 PSA_ASSERT( psa_cipher_finish( &operation1,
3174 output1 + output1_length,
3175 output1_buffer_size - output1_length,
3176 &function_output_length ) );
gabor-mezei-armceface22021-01-21 12:26:17 +01003177 TEST_ASSERT( function_output_length <=
3178 PSA_CIPHER_FINISH_OUTPUT_SIZE( key_type, alg ) );
3179 TEST_ASSERT( function_output_length <=
3180 PSA_CIPHER_FINISH_OUTPUT_MAX_SIZE );
Gilles Peskine048b7f02018-06-08 14:20:49 +02003181 output1_length += function_output_length;
mohammad1603d7d7ba52018-03-12 18:51:53 +02003182
Gilles Peskine8817f612018-12-18 00:18:46 +01003183 PSA_ASSERT( psa_cipher_abort( &operation1 ) );
mohammad1603d7d7ba52018-03-12 18:51:53 +02003184
Gilles Peskine048b7f02018-06-08 14:20:49 +02003185 output2_buffer_size = output1_length;
gabor-mezei-armceface22021-01-21 12:26:17 +01003186 TEST_ASSERT( output2_buffer_size <=
3187 PSA_CIPHER_DECRYPT_OUTPUT_SIZE( key_type, alg, output1_length ) );
3188 TEST_ASSERT( output2_buffer_size <=
3189 PSA_CIPHER_DECRYPT_OUTPUT_MAX_SIZE( output1_length ) );
Gilles Peskine8cebbba2018-09-27 13:54:18 +02003190 ASSERT_ALLOC( output2, output2_buffer_size );
mohammad1603d7d7ba52018-03-12 18:51:53 +02003191
Steven Cooreman177deba2020-09-07 17:14:14 +02003192 if( iv_length > 0 )
3193 {
Steven Cooremana6033e92020-08-25 11:47:50 +02003194 PSA_ASSERT( psa_cipher_set_iv( &operation2,
3195 iv, iv_length ) );
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02003196 }
Moran Pekerded84402018-06-06 16:36:50 +03003197
Gilles Peskine8817f612018-12-18 00:18:46 +01003198 PSA_ASSERT( psa_cipher_update( &operation2, output1, first_part_size,
3199 output2, output2_buffer_size,
3200 &function_output_length ) );
gabor-mezei-armceface22021-01-21 12:26:17 +01003201 TEST_ASSERT( function_output_length <=
3202 PSA_CIPHER_UPDATE_OUTPUT_SIZE( key_type, alg, first_part_size ) );
3203 TEST_ASSERT( function_output_length <=
3204 PSA_CIPHER_UPDATE_OUTPUT_MAX_SIZE( first_part_size ) );
Gilles Peskine048b7f02018-06-08 14:20:49 +02003205 output2_length += function_output_length;
Moran Pekerded84402018-06-06 16:36:50 +03003206
Gilles Peskine8817f612018-12-18 00:18:46 +01003207 PSA_ASSERT( psa_cipher_update( &operation2,
3208 output1 + first_part_size,
3209 output1_length - first_part_size,
3210 output2, output2_buffer_size,
3211 &function_output_length ) );
gabor-mezei-armceface22021-01-21 12:26:17 +01003212 TEST_ASSERT( function_output_length <=
3213 PSA_CIPHER_UPDATE_OUTPUT_SIZE( key_type,
3214 alg,
3215 output1_length - first_part_size ) );
3216 TEST_ASSERT( function_output_length <=
3217 PSA_CIPHER_UPDATE_OUTPUT_MAX_SIZE( output1_length - first_part_size ) );
Gilles Peskine048b7f02018-06-08 14:20:49 +02003218 output2_length += function_output_length;
Moran Pekerded84402018-06-06 16:36:50 +03003219
Gilles Peskine8817f612018-12-18 00:18:46 +01003220 PSA_ASSERT( psa_cipher_finish( &operation2,
3221 output2 + output2_length,
3222 output2_buffer_size - output2_length,
3223 &function_output_length ) );
gabor-mezei-armceface22021-01-21 12:26:17 +01003224 TEST_ASSERT( function_output_length <=
3225 PSA_CIPHER_FINISH_OUTPUT_SIZE( key_type, alg ) );
3226 TEST_ASSERT( function_output_length <=
3227 PSA_CIPHER_FINISH_OUTPUT_MAX_SIZE );
Gilles Peskine048b7f02018-06-08 14:20:49 +02003228 output2_length += function_output_length;
Gilles Peskine4ca9c3f2018-06-06 18:44:09 +02003229
Gilles Peskine8817f612018-12-18 00:18:46 +01003230 PSA_ASSERT( psa_cipher_abort( &operation2 ) );
mohammad1603d7d7ba52018-03-12 18:51:53 +02003231
Gilles Peskinebd7dea92018-09-27 13:57:19 +02003232 ASSERT_COMPARE( input->x, input->len, output2, output2_length );
mohammad1603d7d7ba52018-03-12 18:51:53 +02003233
3234exit:
Gilles Peskine64f13ef2020-08-25 23:15:20 +02003235 psa_cipher_abort( &operation1 );
3236 psa_cipher_abort( &operation2 );
itayzafrir3e02b3b2018-06-12 17:06:52 +03003237 mbedtls_free( output1 );
3238 mbedtls_free( output2 );
Ronald Cron5425a212020-08-04 14:58:35 +02003239 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02003240 PSA_DONE( );
mohammad1603d7d7ba52018-03-12 18:51:53 +02003241}
3242/* END_CASE */
Gilles Peskine7268afc2018-06-06 15:19:24 +02003243
Gilles Peskine20035e32018-02-03 22:44:14 +01003244/* BEGIN_CASE */
Gilles Peskine7da96b02018-08-17 18:45:42 +02003245void aead_encrypt_decrypt( int key_type_arg, data_t *key_data,
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02003246 int alg_arg,
Gilles Peskine7da96b02018-08-17 18:45:42 +02003247 data_t *nonce,
3248 data_t *additional_data,
3249 data_t *input_data,
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02003250 int expected_result_arg )
Gilles Peskinea1cac842018-06-11 19:33:02 +02003251{
Ronald Cron5425a212020-08-04 14:58:35 +02003252 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskinea1cac842018-06-11 19:33:02 +02003253 psa_key_type_t key_type = key_type_arg;
3254 psa_algorithm_t alg = alg_arg;
Bence Szépkútiec174e22021-03-19 18:46:15 +01003255 size_t key_bits;
Gilles Peskinea1cac842018-06-11 19:33:02 +02003256 unsigned char *output_data = NULL;
3257 size_t output_size = 0;
3258 size_t output_length = 0;
3259 unsigned char *output_data2 = NULL;
3260 size_t output_length2 = 0;
Steven Cooremanf49478b2021-02-15 15:19:25 +01003261 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Gilles Peskine4abf7412018-06-18 16:35:34 +02003262 psa_status_t expected_result = expected_result_arg;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02003263 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskinea1cac842018-06-11 19:33:02 +02003264
Gilles Peskine8817f612018-12-18 00:18:46 +01003265 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003266
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02003267 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT | PSA_KEY_USAGE_DECRYPT );
3268 psa_set_key_algorithm( &attributes, alg );
3269 psa_set_key_type( &attributes, key_type );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003270
Gilles Peskine049c7532019-05-15 20:22:09 +02003271 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02003272 &key ) );
Bence Szépkútiec174e22021-03-19 18:46:15 +01003273 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
3274 key_bits = psa_get_key_bits( &attributes );
3275
3276 output_size = input_data->len + PSA_AEAD_TAG_LENGTH( key_type, key_bits,
3277 alg );
3278 /* For all currently defined algorithms, PSA_AEAD_ENCRYPT_OUTPUT_SIZE
3279 * should be exact. */
3280 if( expected_result != PSA_ERROR_INVALID_ARGUMENT &&
3281 expected_result != PSA_ERROR_NOT_SUPPORTED )
3282 {
3283 TEST_EQUAL( output_size,
3284 PSA_AEAD_ENCRYPT_OUTPUT_SIZE( key_type, alg, input_data->len ) );
3285 TEST_ASSERT( output_size <=
3286 PSA_AEAD_ENCRYPT_OUTPUT_MAX_SIZE( input_data->len ) );
3287 }
3288 ASSERT_ALLOC( output_data, output_size );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003289
Steven Cooremanf49478b2021-02-15 15:19:25 +01003290 status = psa_aead_encrypt( key, alg,
3291 nonce->x, nonce->len,
3292 additional_data->x,
3293 additional_data->len,
3294 input_data->x, input_data->len,
3295 output_data, output_size,
3296 &output_length );
3297
3298 /* If the operation is not supported, just skip and not fail in case the
3299 * encryption involves a common limitation of cryptography hardwares and
3300 * an alternative implementation. */
3301 if( status == PSA_ERROR_NOT_SUPPORTED )
3302 {
3303 MBEDTLS_TEST_PSA_SKIP_IF_ALT_AES_192( key_type, key_data->len * 8 );
3304 MBEDTLS_TEST_PSA_SKIP_IF_ALT_GCM_NOT_12BYTES_NONCE( alg, nonce->len );
3305 }
3306
3307 TEST_EQUAL( status, expected_result );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003308
3309 if( PSA_SUCCESS == expected_result )
3310 {
Gilles Peskine8cebbba2018-09-27 13:54:18 +02003311 ASSERT_ALLOC( output_data2, output_length );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003312
Gilles Peskine003a4a92019-05-14 16:09:40 +02003313 /* For all currently defined algorithms, PSA_AEAD_DECRYPT_OUTPUT_SIZE
3314 * should be exact. */
3315 TEST_EQUAL( input_data->len,
Bence Szépkútiec174e22021-03-19 18:46:15 +01003316 PSA_AEAD_DECRYPT_OUTPUT_SIZE( key_type, alg, output_length ) );
Gilles Peskine003a4a92019-05-14 16:09:40 +02003317
gabor-mezei-armceface22021-01-21 12:26:17 +01003318 TEST_ASSERT( input_data->len <=
3319 PSA_AEAD_DECRYPT_OUTPUT_MAX_SIZE( output_length ) );
3320
Ronald Cron5425a212020-08-04 14:58:35 +02003321 TEST_EQUAL( psa_aead_decrypt( key, alg,
Gilles Peskinefe11b722018-12-18 00:24:04 +01003322 nonce->x, nonce->len,
3323 additional_data->x,
3324 additional_data->len,
3325 output_data, output_length,
3326 output_data2, output_length,
Gilles Peskinef812dcf2018-12-18 00:33:25 +01003327 &output_length2 ),
3328 expected_result );
Gilles Peskine2d277862018-06-18 15:41:12 +02003329
Gilles Peskinebd7dea92018-09-27 13:57:19 +02003330 ASSERT_COMPARE( input_data->x, input_data->len,
3331 output_data2, output_length2 );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003332 }
Gilles Peskine2d277862018-06-18 15:41:12 +02003333
Gilles Peskinea1cac842018-06-11 19:33:02 +02003334exit:
Ronald Cron5425a212020-08-04 14:58:35 +02003335 psa_destroy_key( key );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003336 mbedtls_free( output_data );
3337 mbedtls_free( output_data2 );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02003338 PSA_DONE( );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003339}
3340/* END_CASE */
3341
3342/* BEGIN_CASE */
Gilles Peskine7da96b02018-08-17 18:45:42 +02003343void aead_encrypt( int key_type_arg, data_t *key_data,
3344 int alg_arg,
3345 data_t *nonce,
3346 data_t *additional_data,
3347 data_t *input_data,
3348 data_t *expected_result )
Gilles Peskinea1cac842018-06-11 19:33:02 +02003349{
Ronald Cron5425a212020-08-04 14:58:35 +02003350 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskinea1cac842018-06-11 19:33:02 +02003351 psa_key_type_t key_type = key_type_arg;
3352 psa_algorithm_t alg = alg_arg;
Bence Szépkútiec174e22021-03-19 18:46:15 +01003353 size_t key_bits;
Gilles Peskinea1cac842018-06-11 19:33:02 +02003354 unsigned char *output_data = NULL;
3355 size_t output_size = 0;
3356 size_t output_length = 0;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02003357 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Steven Cooremand588ea12021-01-11 19:36:04 +01003358 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Gilles Peskinea1cac842018-06-11 19:33:02 +02003359
Gilles Peskine8817f612018-12-18 00:18:46 +01003360 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003361
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02003362 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
3363 psa_set_key_algorithm( &attributes, alg );
3364 psa_set_key_type( &attributes, key_type );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003365
Gilles Peskine049c7532019-05-15 20:22:09 +02003366 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02003367 &key ) );
Bence Szépkútiec174e22021-03-19 18:46:15 +01003368 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
3369 key_bits = psa_get_key_bits( &attributes );
3370
3371 output_size = input_data->len + PSA_AEAD_TAG_LENGTH( key_type, key_bits,
3372 alg );
3373 /* For all currently defined algorithms, PSA_AEAD_ENCRYPT_OUTPUT_SIZE
3374 * should be exact. */
3375 TEST_EQUAL( output_size,
3376 PSA_AEAD_ENCRYPT_OUTPUT_SIZE( key_type, alg, input_data->len ) );
3377 TEST_ASSERT( output_size <=
3378 PSA_AEAD_ENCRYPT_OUTPUT_MAX_SIZE( input_data->len ) );
3379 ASSERT_ALLOC( output_data, output_size );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003380
Steven Cooremand588ea12021-01-11 19:36:04 +01003381 status = psa_aead_encrypt( key, alg,
3382 nonce->x, nonce->len,
3383 additional_data->x, additional_data->len,
3384 input_data->x, input_data->len,
3385 output_data, output_size,
3386 &output_length );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003387
Ronald Cron28a45ed2021-02-09 20:35:42 +01003388 /* If the operation is not supported, just skip and not fail in case the
3389 * encryption involves a common limitation of cryptography hardwares and
3390 * an alternative implementation. */
3391 if( status == PSA_ERROR_NOT_SUPPORTED )
Steven Cooremand588ea12021-01-11 19:36:04 +01003392 {
Ronald Cron28a45ed2021-02-09 20:35:42 +01003393 MBEDTLS_TEST_PSA_SKIP_IF_ALT_AES_192( key_type, key_data->len * 8 );
3394 MBEDTLS_TEST_PSA_SKIP_IF_ALT_GCM_NOT_12BYTES_NONCE( alg, nonce->len );
Steven Cooremand588ea12021-01-11 19:36:04 +01003395 }
Steven Cooremand588ea12021-01-11 19:36:04 +01003396
3397 PSA_ASSERT( status );
Gilles Peskinebd7dea92018-09-27 13:57:19 +02003398 ASSERT_COMPARE( expected_result->x, expected_result->len,
3399 output_data, output_length );
Gilles Peskine2d277862018-06-18 15:41:12 +02003400
Gilles Peskinea1cac842018-06-11 19:33:02 +02003401exit:
Ronald Cron5425a212020-08-04 14:58:35 +02003402 psa_destroy_key( key );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003403 mbedtls_free( output_data );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02003404 PSA_DONE( );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003405}
3406/* END_CASE */
3407
3408/* BEGIN_CASE */
Gilles Peskine7da96b02018-08-17 18:45:42 +02003409void aead_decrypt( int key_type_arg, data_t *key_data,
3410 int alg_arg,
3411 data_t *nonce,
3412 data_t *additional_data,
3413 data_t *input_data,
3414 data_t *expected_data,
3415 int expected_result_arg )
Gilles Peskinea1cac842018-06-11 19:33:02 +02003416{
Ronald Cron5425a212020-08-04 14:58:35 +02003417 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskinea1cac842018-06-11 19:33:02 +02003418 psa_key_type_t key_type = key_type_arg;
3419 psa_algorithm_t alg = alg_arg;
Bence Szépkútiec174e22021-03-19 18:46:15 +01003420 size_t key_bits;
Gilles Peskinea1cac842018-06-11 19:33:02 +02003421 unsigned char *output_data = NULL;
3422 size_t output_size = 0;
3423 size_t output_length = 0;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02003424 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine4abf7412018-06-18 16:35:34 +02003425 psa_status_t expected_result = expected_result_arg;
Steven Cooremand588ea12021-01-11 19:36:04 +01003426 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Gilles Peskinea1cac842018-06-11 19:33:02 +02003427
Gilles Peskine8817f612018-12-18 00:18:46 +01003428 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003429
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02003430 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DECRYPT );
3431 psa_set_key_algorithm( &attributes, alg );
3432 psa_set_key_type( &attributes, key_type );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003433
Gilles Peskine049c7532019-05-15 20:22:09 +02003434 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02003435 &key ) );
Bence Szépkútiec174e22021-03-19 18:46:15 +01003436 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
3437 key_bits = psa_get_key_bits( &attributes );
3438
3439 output_size = input_data->len - PSA_AEAD_TAG_LENGTH( key_type, key_bits,
3440 alg );
3441 if( expected_result != PSA_ERROR_INVALID_ARGUMENT &&
3442 expected_result != PSA_ERROR_NOT_SUPPORTED )
3443 {
3444 /* For all currently defined algorithms, PSA_AEAD_DECRYPT_OUTPUT_SIZE
3445 * should be exact. */
3446 TEST_EQUAL( output_size,
3447 PSA_AEAD_DECRYPT_OUTPUT_SIZE( key_type, alg, input_data->len ) );
3448 TEST_ASSERT( output_size <=
3449 PSA_AEAD_DECRYPT_OUTPUT_MAX_SIZE( input_data->len ) );
3450 }
3451 ASSERT_ALLOC( output_data, output_size );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003452
Steven Cooremand588ea12021-01-11 19:36:04 +01003453 status = psa_aead_decrypt( key, alg,
3454 nonce->x, nonce->len,
3455 additional_data->x,
3456 additional_data->len,
3457 input_data->x, input_data->len,
3458 output_data, output_size,
3459 &output_length );
3460
Ronald Cron28a45ed2021-02-09 20:35:42 +01003461 /* If the operation is not supported, just skip and not fail in case the
3462 * decryption involves a common limitation of cryptography hardwares and
3463 * an alternative implementation. */
3464 if( status == PSA_ERROR_NOT_SUPPORTED )
Steven Cooremand588ea12021-01-11 19:36:04 +01003465 {
Ronald Cron28a45ed2021-02-09 20:35:42 +01003466 MBEDTLS_TEST_PSA_SKIP_IF_ALT_AES_192( key_type, key_data->len * 8 );
3467 MBEDTLS_TEST_PSA_SKIP_IF_ALT_GCM_NOT_12BYTES_NONCE( alg, nonce->len );
Steven Cooremand588ea12021-01-11 19:36:04 +01003468 }
Steven Cooremand588ea12021-01-11 19:36:04 +01003469
3470 TEST_EQUAL( status, expected_result );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003471
Gilles Peskine2d277862018-06-18 15:41:12 +02003472 if( expected_result == PSA_SUCCESS )
Gilles Peskinebd7dea92018-09-27 13:57:19 +02003473 ASSERT_COMPARE( expected_data->x, expected_data->len,
3474 output_data, output_length );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003475
Gilles Peskinea1cac842018-06-11 19:33:02 +02003476exit:
Ronald Cron5425a212020-08-04 14:58:35 +02003477 psa_destroy_key( key );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003478 mbedtls_free( output_data );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02003479 PSA_DONE( );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003480}
3481/* END_CASE */
3482
3483/* BEGIN_CASE */
Paul Elliott0023e0a2021-04-27 10:06:22 +01003484void aead_multipart_encrypt( int key_type_arg, data_t *key_data,
3485 int alg_arg,
3486 data_t *nonce,
3487 data_t *additional_data,
Paul Elliott97fd1ba2021-07-21 18:46:06 +01003488 int do_test_ad_chunked,
Paul Elliott0023e0a2021-04-27 10:06:22 +01003489 data_t *input_data,
Paul Elliott97fd1ba2021-07-21 18:46:06 +01003490 int do_test_data_chunked,
3491 int do_set_lengths,
3492 data_t *expected_output )
Paul Elliott0023e0a2021-04-27 10:06:22 +01003493{
Paul Elliottd3f82412021-06-16 16:52:21 +01003494 size_t ad_part_len = 0;
3495 size_t data_part_len = 0;
Paul Elliott0023e0a2021-04-27 10:06:22 +01003496
Paul Elliott97fd1ba2021-07-21 18:46:06 +01003497 TEST_ASSERT( do_test_ad_chunked || do_test_data_chunked );
3498
3499 /* Temporary whilst we have algorithms that cannot support chunking */
3500 if( do_test_ad_chunked == 1 )
Paul Elliott0023e0a2021-04-27 10:06:22 +01003501 {
Paul Elliottd3f82412021-06-16 16:52:21 +01003502 for( ad_part_len = 1; ad_part_len <= additional_data->len;
3503 ad_part_len++ )
Paul Elliott0023e0a2021-04-27 10:06:22 +01003504 {
Paul Elliottd3f82412021-06-16 16:52:21 +01003505 mbedtls_test_set_step( ad_part_len );
Paul Elliott0023e0a2021-04-27 10:06:22 +01003506
Paul Elliott329d5382021-07-22 17:10:45 +01003507 /* Split ad into length(ad_part_len) parts. */
Paul Elliott97fd1ba2021-07-21 18:46:06 +01003508 if( !aead_multipart_internal_func( key_type_arg, key_data,
3509 alg_arg, nonce,
3510 additional_data,
3511 ad_part_len,
3512 input_data, -1,
3513 do_set_lengths,
3514 expected_output,
Paul Elliottebf91632021-07-22 17:54:42 +01003515 1, 1, 0,
3516 ( ad_part_len & 0x01 ) ) )
Paul Elliott329d5382021-07-22 17:10:45 +01003517 break;
3518
3519 /* length(0) part, length(ad_part_len) part, length(0) part... */
3520 mbedtls_test_set_step( 1000 + ad_part_len );
3521
3522 if( !aead_multipart_internal_func( key_type_arg, key_data,
3523 alg_arg, nonce,
3524 additional_data,
3525 ad_part_len,
3526 input_data, -1,
3527 do_set_lengths,
3528 expected_output,
Paul Elliottebf91632021-07-22 17:54:42 +01003529 1, 1, 1,
3530 ( ad_part_len & 0x01 ) ) )
Paul Elliott97fd1ba2021-07-21 18:46:06 +01003531 break;
Paul Elliott0023e0a2021-04-27 10:06:22 +01003532 }
3533 }
Paul Elliottd3f82412021-06-16 16:52:21 +01003534
Paul Elliott97fd1ba2021-07-21 18:46:06 +01003535 /* Temporary whilst we have algorithms that cannot support chunking */
3536 if( do_test_data_chunked == 1 )
Paul Elliott0023e0a2021-04-27 10:06:22 +01003537 {
Paul Elliottd3f82412021-06-16 16:52:21 +01003538 for( data_part_len = 1; data_part_len <= input_data->len;
3539 data_part_len++ )
Paul Elliott0023e0a2021-04-27 10:06:22 +01003540 {
Paul Elliott329d5382021-07-22 17:10:45 +01003541 /* Split data into length(data_part_len) parts. */
3542 mbedtls_test_set_step( 2000 + data_part_len );
Paul Elliott97fd1ba2021-07-21 18:46:06 +01003543
3544 if( !aead_multipart_internal_func( key_type_arg, key_data,
3545 alg_arg, nonce,
3546 additional_data, -1,
3547 input_data, data_part_len,
3548 do_set_lengths,
3549 expected_output,
Paul Elliottebf91632021-07-22 17:54:42 +01003550 1, 1, 0,
3551 ( data_part_len & 0x01 ) ) )
Paul Elliott329d5382021-07-22 17:10:45 +01003552 break;
3553
3554 /* length(0) part, length(data_part_len) part, length(0) part... */
3555 mbedtls_test_set_step( 3000 + data_part_len );
3556
3557 if( !aead_multipart_internal_func( key_type_arg, key_data,
3558 alg_arg, nonce,
3559 additional_data, -1,
3560 input_data, data_part_len,
3561 do_set_lengths,
3562 expected_output,
Paul Elliottebf91632021-07-22 17:54:42 +01003563 1, 1, 1,
3564 ( data_part_len & 0x01 ) ) )
Paul Elliott97fd1ba2021-07-21 18:46:06 +01003565 break;
Paul Elliott0023e0a2021-04-27 10:06:22 +01003566 }
3567 }
Paul Elliott0023e0a2021-04-27 10:06:22 +01003568
Paul Elliott0023e0a2021-04-27 10:06:22 +01003569
Paul Elliott8fc45162021-06-23 16:06:01 +01003570 /* Goto is required to silence warnings about unused labels, as we
3571 * don't actually do any test assertions in this function. */
3572 goto exit;
Paul Elliott0023e0a2021-04-27 10:06:22 +01003573}
3574/* END_CASE */
3575
3576/* BEGIN_CASE */
Paul Elliott0023e0a2021-04-27 10:06:22 +01003577void aead_multipart_decrypt( int key_type_arg, data_t *key_data,
3578 int alg_arg,
3579 data_t *nonce,
3580 data_t *additional_data,
Paul Elliott97fd1ba2021-07-21 18:46:06 +01003581 int do_test_ad_chunked,
Paul Elliott0023e0a2021-04-27 10:06:22 +01003582 data_t *input_data,
Paul Elliott97fd1ba2021-07-21 18:46:06 +01003583 int do_test_data_chunked,
3584 int do_set_lengths,
3585 data_t *expected_output,
3586 int expect_valid_signature )
Paul Elliott0023e0a2021-04-27 10:06:22 +01003587{
Paul Elliottd3f82412021-06-16 16:52:21 +01003588 size_t ad_part_len = 0;
3589 size_t data_part_len = 0;
Paul Elliott0023e0a2021-04-27 10:06:22 +01003590
Paul Elliott97fd1ba2021-07-21 18:46:06 +01003591 /* Temporary whilst we have algorithms that cannot support chunking */
3592 if( do_test_ad_chunked == 1 )
Paul Elliott0023e0a2021-04-27 10:06:22 +01003593 {
Paul Elliottd3f82412021-06-16 16:52:21 +01003594 for( ad_part_len = 1; ad_part_len <= additional_data->len;
3595 ad_part_len++ )
Paul Elliott0023e0a2021-04-27 10:06:22 +01003596 {
Paul Elliott329d5382021-07-22 17:10:45 +01003597 /* Split ad into length(ad_part_len) parts. */
Paul Elliottd3f82412021-06-16 16:52:21 +01003598 mbedtls_test_set_step( ad_part_len );
Paul Elliott0023e0a2021-04-27 10:06:22 +01003599
Paul Elliott97fd1ba2021-07-21 18:46:06 +01003600 if( !aead_multipart_internal_func( key_type_arg, key_data,
3601 alg_arg, nonce,
3602 additional_data,
3603 ad_part_len,
3604 input_data, -1,
3605 do_set_lengths,
3606 expected_output,
3607 expect_valid_signature,
Paul Elliottebf91632021-07-22 17:54:42 +01003608 0, 0,
3609 ( ad_part_len & 0x01 ) ) )
Paul Elliott329d5382021-07-22 17:10:45 +01003610 break;
3611
3612 /* length(0) part, length(ad_part_len) part, length(0) part... */
3613 mbedtls_test_set_step( 1000 + ad_part_len );
3614
3615 if( !aead_multipart_internal_func( key_type_arg, key_data,
3616 alg_arg, nonce,
3617 additional_data,
3618 ad_part_len,
3619 input_data, -1,
3620 do_set_lengths,
3621 expected_output,
3622 expect_valid_signature,
Paul Elliottebf91632021-07-22 17:54:42 +01003623 0, 1,
3624 ( ad_part_len & 0x01 ) ) )
Paul Elliott97fd1ba2021-07-21 18:46:06 +01003625 break;
Paul Elliott0023e0a2021-04-27 10:06:22 +01003626 }
3627 }
3628
Paul Elliott97fd1ba2021-07-21 18:46:06 +01003629 /* Temporary whilst we have algorithms that cannot support chunking */
3630 if( do_test_data_chunked == 1 )
Paul Elliott0023e0a2021-04-27 10:06:22 +01003631 {
Paul Elliottd3f82412021-06-16 16:52:21 +01003632 for( data_part_len = 1; data_part_len <= input_data->len;
3633 data_part_len++ )
Paul Elliott0023e0a2021-04-27 10:06:22 +01003634 {
Paul Elliott329d5382021-07-22 17:10:45 +01003635 /* Split data into length(data_part_len) parts. */
3636 mbedtls_test_set_step( 2000 + data_part_len );
Paul Elliott97fd1ba2021-07-21 18:46:06 +01003637
3638 if( !aead_multipart_internal_func( key_type_arg, key_data,
3639 alg_arg, nonce,
3640 additional_data, -1,
3641 input_data, data_part_len,
3642 do_set_lengths,
3643 expected_output,
3644 expect_valid_signature,
Paul Elliottebf91632021-07-22 17:54:42 +01003645 0, 0,
3646 ( data_part_len & 0x01 ) ) )
Paul Elliott329d5382021-07-22 17:10:45 +01003647 break;
3648
3649 /* length(0) part, length(data_part_len) part, length(0) part... */
3650 mbedtls_test_set_step( 3000 + data_part_len );
3651
3652 if( !aead_multipart_internal_func( key_type_arg, key_data,
3653 alg_arg, nonce,
3654 additional_data, -1,
3655 input_data, data_part_len,
3656 do_set_lengths,
3657 expected_output,
3658 expect_valid_signature,
Paul Elliottebf91632021-07-22 17:54:42 +01003659 0, 1,
3660 ( data_part_len & 0x01 ) ) )
Paul Elliott97fd1ba2021-07-21 18:46:06 +01003661 break;
Paul Elliott0023e0a2021-04-27 10:06:22 +01003662 }
3663 }
3664
Paul Elliott8fc45162021-06-23 16:06:01 +01003665 /* Goto is required to silence warnings about unused labels, as we
3666 * don't actually do any test assertions in this function. */
Paul Elliottd3f82412021-06-16 16:52:21 +01003667 goto exit;
Paul Elliott0023e0a2021-04-27 10:06:22 +01003668}
3669/* END_CASE */
3670
3671/* BEGIN_CASE */
Paul Elliott8eb9daf2021-06-04 16:42:21 +01003672void aead_multipart_generate_nonce( int key_type_arg, data_t *key_data,
3673 int alg_arg,
3674 int nonce_len,
Paul Elliottd85f5472021-07-16 18:20:16 +01003675 int expected_generated_len_arg,
Paul Elliott3bd5dba2021-06-23 17:14:40 +01003676 data_t *additional_data,
3677 data_t *input_data,
3678 int expected_status_arg )
Paul Elliott8eb9daf2021-06-04 16:42:21 +01003679{
3680
3681 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
3682 psa_key_type_t key_type = key_type_arg;
3683 psa_algorithm_t alg = alg_arg;
3684 psa_aead_operation_t operation;
3685 uint8_t nonce_buffer[PSA_AEAD_NONCE_MAX_SIZE];
3686 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
3687 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
3688 size_t nonce_generated_len = 0;
Paul Elliottd85f5472021-07-16 18:20:16 +01003689 size_t expected_generated_len = expected_generated_len_arg;
Paul Elliott3bd5dba2021-06-23 17:14:40 +01003690 unsigned char *output_data = NULL;
3691 unsigned char *final_data = NULL;
3692 size_t output_size = 0;
3693 size_t finish_output_size = 0;
3694 size_t output_length = 0;
3695 size_t tag_length = 0;
3696 uint8_t tag_buffer[PSA_AEAD_TAG_MAX_SIZE];
Paul Elliott8eb9daf2021-06-04 16:42:21 +01003697
3698 PSA_ASSERT( psa_crypto_init( ) );
3699
3700 psa_set_key_usage_flags( & attributes, PSA_KEY_USAGE_ENCRYPT );
3701 psa_set_key_algorithm( & attributes, alg );
3702 psa_set_key_type( & attributes, key_type );
3703
3704 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
3705 &key ) );
3706
3707 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
3708
Paul Elliott3bd5dba2021-06-23 17:14:40 +01003709 output_size = PSA_AEAD_UPDATE_OUTPUT_SIZE( key_type, alg, input_data->len );
3710
3711 ASSERT_ALLOC( output_data, output_size );
3712
3713 finish_output_size = PSA_AEAD_FINISH_OUTPUT_SIZE( key_type, alg );
3714
3715 TEST_ASSERT( finish_output_size <= PSA_AEAD_FINISH_OUTPUT_MAX_SIZE );
3716
3717 ASSERT_ALLOC( final_data, finish_output_size );
3718
Paul Elliott8eb9daf2021-06-04 16:42:21 +01003719 operation = psa_aead_operation_init( );
3720
3721 status = psa_aead_encrypt_setup( &operation, key, alg );
3722
3723 /* If the operation is not supported, just skip and not fail in case the
3724 * encryption involves a common limitation of cryptography hardwares and
3725 * an alternative implementation. */
3726 if( status == PSA_ERROR_NOT_SUPPORTED )
3727 {
3728 MBEDTLS_TEST_PSA_SKIP_IF_ALT_AES_192( key_type, key_data->len * 8 );
3729 MBEDTLS_TEST_PSA_SKIP_IF_ALT_GCM_NOT_12BYTES_NONCE( alg, nonce_len );
3730 }
3731
3732 PSA_ASSERT( status );
3733
Paul Elliott8eb9daf2021-06-04 16:42:21 +01003734 status = psa_aead_generate_nonce( &operation, nonce_buffer,
3735 nonce_len,
3736 &nonce_generated_len );
3737
Paul Elliott3bd5dba2021-06-23 17:14:40 +01003738 TEST_ASSERT( status == expected_status_arg );
3739
Paul Elliottd85f5472021-07-16 18:20:16 +01003740 TEST_EQUAL( nonce_generated_len, expected_generated_len );
3741
Paul Elliotte0fcb3b2021-07-16 18:52:03 +01003742 TEST_ASSERT( nonce_generated_len < PSA_AEAD_NONCE_MAX_SIZE );
3743
Paul Elliott3bd5dba2021-06-23 17:14:40 +01003744 if( expected_status_arg == PSA_SUCCESS )
3745 {
3746
3747 /* Ensure we can still complete operation. */
3748
3749 PSA_ASSERT( psa_aead_update_ad( &operation, additional_data->x,
3750 additional_data->len ) );
3751
3752 PSA_ASSERT( psa_aead_update( &operation, input_data->x, input_data->len,
3753 output_data, output_size, &output_length ) );
3754
3755 PSA_ASSERT( psa_aead_finish( &operation, final_data, finish_output_size,
3756 &output_length, tag_buffer,
3757 PSA_AEAD_TAG_MAX_SIZE, &tag_length ) );
3758 }
Paul Elliott8eb9daf2021-06-04 16:42:21 +01003759
3760exit:
3761 psa_destroy_key( key );
Paul Elliott16906f92021-06-24 09:57:01 +01003762 mbedtls_free( output_data );
3763 mbedtls_free( final_data );
Paul Elliott8eb9daf2021-06-04 16:42:21 +01003764 psa_aead_abort( &operation );
3765 PSA_DONE( );
3766}
3767/* END_CASE */
3768
3769/* BEGIN_CASE */
Paul Elliott863864a2021-07-23 17:28:31 +01003770void aead_multipart_set_nonce( int key_type_arg, data_t *key_data,
3771 int alg_arg,
3772 int nonce_len,
3773 data_t *additional_data,
3774 data_t *input_data,
3775 int expected_status_arg )
3776{
3777
3778 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
3779 psa_key_type_t key_type = key_type_arg;
3780 psa_algorithm_t alg = alg_arg;
3781 psa_aead_operation_t operation;
3782 uint8_t *nonce_buffer = NULL;
3783 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
3784 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
3785 psa_status_t expected_status = expected_status_arg;
3786 unsigned char *output_data = NULL;
3787 unsigned char *final_data = NULL;
3788 size_t output_size = 0;
3789 size_t finish_output_size = 0;
3790 size_t output_length = 0;
3791 size_t tag_length = 0;
3792 uint8_t tag_buffer[PSA_AEAD_TAG_MAX_SIZE];
3793 int index = 0;
3794
3795 PSA_ASSERT( psa_crypto_init( ) );
3796
3797 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
3798 psa_set_key_algorithm( &attributes, alg );
3799 psa_set_key_type( &attributes, key_type );
3800
3801 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
3802 &key ) );
3803
3804 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
3805
3806 output_size = PSA_AEAD_UPDATE_OUTPUT_SIZE( key_type, alg, input_data->len );
3807
3808 ASSERT_ALLOC( output_data, output_size );
3809
3810 finish_output_size = PSA_AEAD_FINISH_OUTPUT_SIZE( key_type, alg );
3811
3812 TEST_ASSERT( finish_output_size <= PSA_AEAD_FINISH_OUTPUT_MAX_SIZE );
3813
3814 ASSERT_ALLOC( final_data, finish_output_size );
3815
3816 operation = psa_aead_operation_init( );
3817
3818 status = psa_aead_encrypt_setup( &operation, key, alg );
3819
3820 /* If the operation is not supported, just skip and not fail in case the
3821 * encryption involves a common limitation of cryptography hardwares and
3822 * an alternative implementation. */
3823 if( status == PSA_ERROR_NOT_SUPPORTED )
3824 {
3825 MBEDTLS_TEST_PSA_SKIP_IF_ALT_AES_192( key_type, key_data->len * 8 );
3826 MBEDTLS_TEST_PSA_SKIP_IF_ALT_GCM_NOT_12BYTES_NONCE( alg, nonce_len );
3827 }
3828
3829 PSA_ASSERT( status );
3830
3831 ASSERT_ALLOC( nonce_buffer, nonce_len );
3832
3833 for( index = 0; index < nonce_len - 1; ++index)
3834 {
3835 nonce_buffer[index] = 'a' + index;
3836 }
3837
3838 status = psa_aead_set_nonce( &operation, nonce_buffer, nonce_len );
3839
3840 TEST_ASSERT( status == expected_status );
3841
3842 if( expected_status == PSA_SUCCESS )
3843 {
3844 /* Ensure we can still complete operation. */
3845
3846 PSA_ASSERT( psa_aead_update_ad( &operation, additional_data->x,
3847 additional_data->len ) );
3848
3849 PSA_ASSERT( psa_aead_update( &operation, input_data->x, input_data->len,
3850 output_data, output_size, &output_length ) );
3851
3852 PSA_ASSERT( psa_aead_finish( &operation, final_data, finish_output_size,
3853 &output_length, tag_buffer,
3854 PSA_AEAD_TAG_MAX_SIZE, &tag_length ) );
3855 }
3856
3857exit:
3858 psa_destroy_key( key );
3859 mbedtls_free( output_data );
3860 mbedtls_free( final_data );
3861 mbedtls_free( nonce_buffer );
3862 psa_aead_abort( &operation );
3863 PSA_DONE( );
3864}
3865/* END_CASE */
3866
3867/* BEGIN_CASE */
Paul Elliottc23a9a02021-06-21 18:32:46 +01003868void aead_multipart_state_test( int key_type_arg, data_t *key_data,
3869 int alg_arg,
3870 data_t *nonce,
3871 data_t *additional_data,
3872 data_t *input_data )
3873{
3874 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
3875 psa_key_type_t key_type = key_type_arg;
3876 psa_algorithm_t alg = alg_arg;
3877 psa_aead_operation_t operation;
3878 unsigned char *output_data = NULL;
3879 unsigned char *final_data = NULL;
3880 size_t output_size = 0;
3881 size_t finish_output_size = 0;
3882 size_t output_length = 0;
3883 size_t key_bits = 0;
3884 size_t tag_length = 0;
3885 size_t tag_size = 0;
3886 size_t nonce_length = 0;
3887 uint8_t nonce_buffer[PSA_AEAD_NONCE_MAX_SIZE];
3888 uint8_t tag_buffer[PSA_AEAD_TAG_MAX_SIZE];
3889 size_t output_part_length = 0;
3890 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
3891
3892 PSA_ASSERT( psa_crypto_init( ) );
3893
3894 psa_set_key_usage_flags( & attributes,
3895 PSA_KEY_USAGE_ENCRYPT | PSA_KEY_USAGE_DECRYPT );
3896 psa_set_key_algorithm( & attributes, alg );
3897 psa_set_key_type( & attributes, key_type );
3898
3899 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
3900 &key ) );
3901
3902 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
3903 key_bits = psa_get_key_bits( &attributes );
3904
3905 tag_length = PSA_AEAD_TAG_LENGTH( key_type, key_bits, alg );
3906
3907 TEST_ASSERT( tag_length <= PSA_AEAD_TAG_MAX_SIZE );
3908
3909 output_size = PSA_AEAD_UPDATE_OUTPUT_SIZE( key_type, alg, input_data->len );
3910
3911 ASSERT_ALLOC( output_data, output_size );
3912
3913 finish_output_size = PSA_AEAD_FINISH_OUTPUT_SIZE( key_type, alg );
3914
3915 TEST_ASSERT( finish_output_size <= PSA_AEAD_FINISH_OUTPUT_MAX_SIZE );
3916
3917 ASSERT_ALLOC( final_data, finish_output_size );
3918
3919 /* Test all operations error without calling setup first. */
3920
3921 operation = psa_aead_operation_init( );
3922
3923 TEST_EQUAL( psa_aead_set_nonce( &operation, nonce->x, nonce->len ),
3924 PSA_ERROR_BAD_STATE );
3925
3926 psa_aead_abort( &operation );
3927
3928 operation = psa_aead_operation_init( );
3929
3930 TEST_EQUAL( psa_aead_generate_nonce( &operation, nonce_buffer,
3931 PSA_AEAD_NONCE_MAX_SIZE,
3932 &nonce_length ),
3933 PSA_ERROR_BAD_STATE );
3934
3935 psa_aead_abort( &operation );
3936
Paul Elliott481be342021-07-16 17:38:47 +01003937 /* ------------------------------------------------------- */
3938
Paul Elliottc23a9a02021-06-21 18:32:46 +01003939 operation = psa_aead_operation_init( );
3940
3941 TEST_EQUAL( psa_aead_set_lengths( &operation, additional_data->len,
3942 input_data->len ),
3943 PSA_ERROR_BAD_STATE );
3944
3945 psa_aead_abort( &operation );
3946
Paul Elliott481be342021-07-16 17:38:47 +01003947 /* ------------------------------------------------------- */
3948
Paul Elliottc23a9a02021-06-21 18:32:46 +01003949 operation = psa_aead_operation_init( );
3950
3951 TEST_EQUAL( psa_aead_update_ad( &operation, additional_data->x,
3952 additional_data->len ),
3953 PSA_ERROR_BAD_STATE );
3954
3955 psa_aead_abort( &operation );
3956
Paul Elliott481be342021-07-16 17:38:47 +01003957 /* ------------------------------------------------------- */
3958
Paul Elliottc23a9a02021-06-21 18:32:46 +01003959 operation = psa_aead_operation_init( );
3960
3961 TEST_EQUAL( psa_aead_update( &operation, input_data->x,
3962 input_data->len, output_data,
3963 output_size, &output_length ),
3964 PSA_ERROR_BAD_STATE );
3965
3966 psa_aead_abort( &operation );
3967
Paul Elliott481be342021-07-16 17:38:47 +01003968 /* ------------------------------------------------------- */
3969
Paul Elliottc23a9a02021-06-21 18:32:46 +01003970 operation = psa_aead_operation_init( );
3971
3972 TEST_EQUAL( psa_aead_finish( &operation, final_data,
3973 finish_output_size,
3974 &output_part_length,
3975 tag_buffer, tag_length,
3976 &tag_size ),
3977 PSA_ERROR_BAD_STATE );
3978
3979 psa_aead_abort( &operation );
3980
Paul Elliott481be342021-07-16 17:38:47 +01003981 /* ------------------------------------------------------- */
3982
Paul Elliottc23a9a02021-06-21 18:32:46 +01003983 operation = psa_aead_operation_init( );
3984
3985 TEST_EQUAL( psa_aead_verify( &operation, final_data,
3986 finish_output_size,
3987 &output_part_length,
3988 tag_buffer,
3989 tag_length ),
3990 PSA_ERROR_BAD_STATE );
3991
3992 psa_aead_abort( &operation );
3993
3994 /* Test for double setups. */
3995
3996 operation = psa_aead_operation_init( );
3997
3998 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
3999
4000 TEST_EQUAL( psa_aead_encrypt_setup( &operation, key, alg ),
4001 PSA_ERROR_BAD_STATE );
4002
4003 psa_aead_abort( &operation );
4004
Paul Elliott481be342021-07-16 17:38:47 +01004005 /* ------------------------------------------------------- */
4006
Paul Elliottc23a9a02021-06-21 18:32:46 +01004007 operation = psa_aead_operation_init( );
4008
4009 PSA_ASSERT( psa_aead_decrypt_setup( &operation, key, alg ) );
4010
4011 TEST_EQUAL( psa_aead_decrypt_setup( &operation, key, alg ),
4012 PSA_ERROR_BAD_STATE );
4013
4014 psa_aead_abort( &operation );
4015
Paul Elliott374a2be2021-07-16 17:53:40 +01004016 /* ------------------------------------------------------- */
4017
4018 operation = psa_aead_operation_init( );
4019
4020 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
4021
4022 TEST_EQUAL( psa_aead_decrypt_setup( &operation, key, alg ),
4023 PSA_ERROR_BAD_STATE );
4024
4025 psa_aead_abort( &operation );
4026
4027 /* ------------------------------------------------------- */
4028
4029 operation = psa_aead_operation_init( );
4030
4031 PSA_ASSERT( psa_aead_decrypt_setup( &operation, key, alg ) );
4032
4033 TEST_EQUAL( psa_aead_encrypt_setup( &operation, key, alg ),
4034 PSA_ERROR_BAD_STATE );
4035
4036 psa_aead_abort( &operation );
4037
Paul Elliottc23a9a02021-06-21 18:32:46 +01004038 /* Test for not setting a nonce. */
4039
4040 operation = psa_aead_operation_init( );
4041
4042 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
4043
4044 TEST_EQUAL( psa_aead_update_ad( &operation, additional_data->x,
4045 additional_data->len ),
4046 PSA_ERROR_BAD_STATE );
4047
4048 psa_aead_abort( &operation );
4049
4050 /* Test for double setting nonce. */
4051
4052 operation = psa_aead_operation_init( );
4053
4054 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
4055
4056 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
4057
4058 TEST_EQUAL( psa_aead_set_nonce( &operation, nonce->x, nonce->len ),
4059 PSA_ERROR_BAD_STATE );
4060
4061 psa_aead_abort( &operation );
4062
Paul Elliott374a2be2021-07-16 17:53:40 +01004063 /* Test for double generating nonce. */
4064
4065 operation = psa_aead_operation_init( );
4066
4067 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
4068
4069 PSA_ASSERT( psa_aead_generate_nonce( &operation, nonce_buffer,
4070 PSA_AEAD_NONCE_MAX_SIZE,
4071 &nonce_length ) );
4072
4073 TEST_EQUAL( psa_aead_generate_nonce( &operation, nonce_buffer,
4074 PSA_AEAD_NONCE_MAX_SIZE,
4075 &nonce_length ),
4076 PSA_ERROR_BAD_STATE );
4077
4078
4079 psa_aead_abort( &operation );
4080
4081 /* Test for generate nonce then set and vice versa */
4082
4083 operation = psa_aead_operation_init( );
4084
4085 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
4086
4087 PSA_ASSERT( psa_aead_generate_nonce( &operation, nonce_buffer,
4088 PSA_AEAD_NONCE_MAX_SIZE,
4089 &nonce_length ) );
4090
4091 TEST_EQUAL( psa_aead_set_nonce( &operation, nonce->x, nonce->len ),
4092 PSA_ERROR_BAD_STATE );
4093
4094 psa_aead_abort( &operation );
4095
4096 /* ------------------------------------------------------- */
4097
4098 operation = psa_aead_operation_init( );
4099
4100 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
4101
4102 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
4103
4104 TEST_EQUAL( psa_aead_generate_nonce( &operation, nonce_buffer,
4105 PSA_AEAD_NONCE_MAX_SIZE,
4106 &nonce_length ),
4107 PSA_ERROR_BAD_STATE );
4108
4109 psa_aead_abort( &operation );
4110
Paul Elliott7220cae2021-06-22 17:25:57 +01004111 /* Test for generating nonce in decrypt setup. */
4112
4113 operation = psa_aead_operation_init( );
4114
4115 PSA_ASSERT( psa_aead_decrypt_setup( &operation, key, alg ) );
4116
4117 TEST_EQUAL( psa_aead_generate_nonce( &operation, nonce_buffer,
4118 PSA_AEAD_NONCE_MAX_SIZE,
4119 &nonce_length ),
4120 PSA_ERROR_BAD_STATE );
4121
4122 psa_aead_abort( &operation );
4123
Paul Elliottc23a9a02021-06-21 18:32:46 +01004124 /* Test for setting lengths twice. */
4125
4126 operation = psa_aead_operation_init( );
4127
4128 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
4129
4130 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
4131
4132 PSA_ASSERT( psa_aead_set_lengths( &operation, additional_data->len,
4133 input_data->len ) );
4134
4135 TEST_EQUAL( psa_aead_set_lengths( &operation, additional_data->len,
4136 input_data->len ),
4137 PSA_ERROR_BAD_STATE );
4138
4139 psa_aead_abort( &operation );
4140
4141 /* Test for setting lengths after already starting data. */
4142
4143 operation = psa_aead_operation_init( );
4144
4145 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
4146
4147 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
4148
4149 PSA_ASSERT( psa_aead_update( &operation, input_data->x,
4150 input_data->len, output_data,
4151 output_size, &output_length ) );
4152
4153 TEST_EQUAL( psa_aead_set_lengths( &operation, additional_data->len,
4154 input_data->len ),
4155 PSA_ERROR_BAD_STATE );
4156
4157 psa_aead_abort( &operation );
4158
Paul Elliott243080c2021-07-21 19:01:17 +01004159 /* Test for not sending any additional data or data after setting non zero
4160 * lengths for them. (encrypt) */
Paul Elliottc23a9a02021-06-21 18:32:46 +01004161
4162 operation = psa_aead_operation_init( );
4163
4164 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
4165
4166 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
4167
4168 PSA_ASSERT( psa_aead_set_lengths( &operation, additional_data->len,
4169 input_data->len ) );
4170
4171 TEST_EQUAL( psa_aead_finish( &operation, final_data,
4172 finish_output_size,
4173 &output_part_length,
4174 tag_buffer, tag_length,
4175 &tag_size ),
4176 PSA_ERROR_INVALID_ARGUMENT );
4177
4178 psa_aead_abort( &operation );
4179
Paul Elliott243080c2021-07-21 19:01:17 +01004180 /* Test for not sending any additional data or data after setting non-zero
4181 * lengths for them. (decrypt) */
Paul Elliottc23a9a02021-06-21 18:32:46 +01004182
4183 operation = psa_aead_operation_init( );
4184
4185 PSA_ASSERT( psa_aead_decrypt_setup( &operation, key, alg ) );
4186
4187 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
4188
4189 PSA_ASSERT( psa_aead_set_lengths( &operation, additional_data->len,
4190 input_data->len ) );
4191
4192 TEST_EQUAL( psa_aead_verify( &operation, final_data,
4193 finish_output_size,
4194 &output_part_length,
4195 tag_buffer,
4196 tag_length ),
4197 PSA_ERROR_INVALID_ARGUMENT );
4198
4199 psa_aead_abort( &operation );
4200
Paul Elliott243080c2021-07-21 19:01:17 +01004201 /* Test for not sending any additional data after setting a non-zero length
4202 * for it. */
Paul Elliottc23a9a02021-06-21 18:32:46 +01004203
4204 operation = psa_aead_operation_init( );
4205
4206 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
4207
4208 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
4209
4210 PSA_ASSERT( psa_aead_set_lengths( &operation, additional_data->len,
4211 input_data->len ) );
4212
4213 TEST_EQUAL( psa_aead_update( &operation, input_data->x,
4214 input_data->len, output_data,
4215 output_size, &output_length ),
4216 PSA_ERROR_INVALID_ARGUMENT );
4217
4218 psa_aead_abort( &operation );
4219
4220 /* Test sending additional data after data. */
4221
4222 operation = psa_aead_operation_init( );
4223
4224 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
4225
4226 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
4227
4228 PSA_ASSERT( psa_aead_update( &operation, input_data->x,
4229 input_data->len, output_data,
4230 output_size, &output_length ) );
4231
4232 TEST_EQUAL( psa_aead_update_ad( &operation, additional_data->x,
4233 additional_data->len ),
4234 PSA_ERROR_BAD_STATE );
4235
4236 psa_aead_abort( &operation );
4237
Paul Elliott534d0b42021-06-22 19:15:20 +01004238 /* Test calling finish on decryption. */
4239
4240 operation = psa_aead_operation_init( );
4241
4242 PSA_ASSERT( psa_aead_decrypt_setup( &operation, key, alg ) );
4243
4244 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
4245
4246 TEST_EQUAL( psa_aead_finish( &operation, final_data,
4247 finish_output_size,
4248 &output_part_length,
4249 tag_buffer, tag_length,
4250 &tag_size ),
4251 PSA_ERROR_BAD_STATE );
4252
4253 psa_aead_abort( &operation );
4254
4255 /* Test calling verify on encryption. */
4256
4257 operation = psa_aead_operation_init( );
4258
4259 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
4260
4261 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
4262
4263 TEST_EQUAL( psa_aead_verify( &operation, final_data,
4264 finish_output_size,
4265 &output_part_length,
4266 tag_buffer,
4267 tag_length ),
Paul Elliott5b065cb2021-06-23 08:33:22 +01004268 PSA_ERROR_BAD_STATE );
Paul Elliott534d0b42021-06-22 19:15:20 +01004269
4270 psa_aead_abort( &operation );
4271
4272
Paul Elliottc23a9a02021-06-21 18:32:46 +01004273exit:
4274 psa_destroy_key( key );
4275 psa_aead_abort( &operation );
4276 mbedtls_free( output_data );
4277 mbedtls_free( final_data );
4278 PSA_DONE( );
4279}
4280/* END_CASE */
4281
4282/* BEGIN_CASE */
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02004283void signature_size( int type_arg,
4284 int bits,
4285 int alg_arg,
4286 int expected_size_arg )
Gilles Peskinee59236f2018-01-27 23:32:46 +01004287{
4288 psa_key_type_t type = type_arg;
4289 psa_algorithm_t alg = alg_arg;
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01004290 size_t actual_size = PSA_SIGN_OUTPUT_SIZE( type, bits, alg );
Gilles Peskine841b14b2019-11-26 17:37:37 +01004291
Gilles Peskinefe11b722018-12-18 00:24:04 +01004292 TEST_EQUAL( actual_size, (size_t) expected_size_arg );
Gilles Peskine841b14b2019-11-26 17:37:37 +01004293
Gilles Peskinee59236f2018-01-27 23:32:46 +01004294exit:
4295 ;
4296}
4297/* END_CASE */
4298
4299/* BEGIN_CASE */
gabor-mezei-armb9530232021-04-16 14:21:21 +02004300void sign_hash_deterministic( int key_type_arg, data_t *key_data,
4301 int alg_arg, data_t *input_data,
4302 data_t *output_data )
Gilles Peskinee59236f2018-01-27 23:32:46 +01004303{
Ronald Cron5425a212020-08-04 14:58:35 +02004304 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskinee59236f2018-01-27 23:32:46 +01004305 psa_key_type_t key_type = key_type_arg;
4306 psa_algorithm_t alg = alg_arg;
Gilles Peskine20035e32018-02-03 22:44:14 +01004307 size_t key_bits;
Gilles Peskine20035e32018-02-03 22:44:14 +01004308 unsigned char *signature = NULL;
4309 size_t signature_size;
4310 size_t signature_length = 0xdeadbeef;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02004311 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine20035e32018-02-03 22:44:14 +01004312
Gilles Peskine8817f612018-12-18 00:18:46 +01004313 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine20035e32018-02-03 22:44:14 +01004314
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01004315 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_HASH );
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02004316 psa_set_key_algorithm( &attributes, alg );
4317 psa_set_key_type( &attributes, key_type );
mohammad1603a97cb8c2018-03-28 03:46:26 -07004318
Gilles Peskine049c7532019-05-15 20:22:09 +02004319 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02004320 &key ) );
4321 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02004322 key_bits = psa_get_key_bits( &attributes );
Gilles Peskine20035e32018-02-03 22:44:14 +01004323
Gilles Peskine860ce9d2018-06-28 12:23:00 +02004324 /* Allocate a buffer which has the size advertized by the
4325 * library. */
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01004326 signature_size = PSA_SIGN_OUTPUT_SIZE( key_type,
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02004327 key_bits, alg );
Gilles Peskine20035e32018-02-03 22:44:14 +01004328 TEST_ASSERT( signature_size != 0 );
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01004329 TEST_ASSERT( signature_size <= PSA_SIGNATURE_MAX_SIZE );
Gilles Peskine8cebbba2018-09-27 13:54:18 +02004330 ASSERT_ALLOC( signature, signature_size );
Gilles Peskine20035e32018-02-03 22:44:14 +01004331
Gilles Peskine860ce9d2018-06-28 12:23:00 +02004332 /* Perform the signature. */
Ronald Cron5425a212020-08-04 14:58:35 +02004333 PSA_ASSERT( psa_sign_hash( key, alg,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01004334 input_data->x, input_data->len,
4335 signature, signature_size,
4336 &signature_length ) );
Gilles Peskine9911b022018-06-29 17:30:48 +02004337 /* Verify that the signature is what is expected. */
Gilles Peskinebd7dea92018-09-27 13:57:19 +02004338 ASSERT_COMPARE( output_data->x, output_data->len,
4339 signature, signature_length );
Gilles Peskine20035e32018-02-03 22:44:14 +01004340
4341exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +01004342 /*
4343 * Key attributes may have been returned by psa_get_key_attributes()
4344 * thus reset them as required.
4345 */
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02004346 psa_reset_key_attributes( &attributes );
Ronald Cron3a4f0e32020-11-19 17:55:23 +01004347
Ronald Cron5425a212020-08-04 14:58:35 +02004348 psa_destroy_key( key );
Gilles Peskine0189e752018-02-03 23:57:22 +01004349 mbedtls_free( signature );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02004350 PSA_DONE( );
Gilles Peskine20035e32018-02-03 22:44:14 +01004351}
4352/* END_CASE */
4353
4354/* BEGIN_CASE */
gabor-mezei-armb9530232021-04-16 14:21:21 +02004355void sign_hash_fail( int key_type_arg, data_t *key_data,
4356 int alg_arg, data_t *input_data,
4357 int signature_size_arg, int expected_status_arg )
Gilles Peskine20035e32018-02-03 22:44:14 +01004358{
Ronald Cron5425a212020-08-04 14:58:35 +02004359 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine20035e32018-02-03 22:44:14 +01004360 psa_key_type_t key_type = key_type_arg;
4361 psa_algorithm_t alg = alg_arg;
Gilles Peskine860ce9d2018-06-28 12:23:00 +02004362 size_t signature_size = signature_size_arg;
Gilles Peskine20035e32018-02-03 22:44:14 +01004363 psa_status_t actual_status;
4364 psa_status_t expected_status = expected_status_arg;
Gilles Peskine40f68b92018-03-07 16:43:36 +01004365 unsigned char *signature = NULL;
Gilles Peskine93aa0332018-02-03 23:58:03 +01004366 size_t signature_length = 0xdeadbeef;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02004367 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine20035e32018-02-03 22:44:14 +01004368
Gilles Peskine8cebbba2018-09-27 13:54:18 +02004369 ASSERT_ALLOC( signature, signature_size );
Gilles Peskine20035e32018-02-03 22:44:14 +01004370
Gilles Peskine8817f612018-12-18 00:18:46 +01004371 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine20035e32018-02-03 22:44:14 +01004372
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01004373 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_HASH );
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02004374 psa_set_key_algorithm( &attributes, alg );
4375 psa_set_key_type( &attributes, key_type );
mohammad1603a97cb8c2018-03-28 03:46:26 -07004376
Gilles Peskine049c7532019-05-15 20:22:09 +02004377 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02004378 &key ) );
Gilles Peskine20035e32018-02-03 22:44:14 +01004379
Ronald Cron5425a212020-08-04 14:58:35 +02004380 actual_status = psa_sign_hash( key, alg,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01004381 input_data->x, input_data->len,
4382 signature, signature_size,
4383 &signature_length );
Gilles Peskinefe11b722018-12-18 00:24:04 +01004384 TEST_EQUAL( actual_status, expected_status );
Gilles Peskine860ce9d2018-06-28 12:23:00 +02004385 /* The value of *signature_length is unspecified on error, but
4386 * whatever it is, it should be less than signature_size, so that
4387 * if the caller tries to read *signature_length bytes without
4388 * checking the error code then they don't overflow a buffer. */
4389 TEST_ASSERT( signature_length <= signature_size );
Gilles Peskine20035e32018-02-03 22:44:14 +01004390
4391exit:
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02004392 psa_reset_key_attributes( &attributes );
Ronald Cron5425a212020-08-04 14:58:35 +02004393 psa_destroy_key( key );
Gilles Peskine20035e32018-02-03 22:44:14 +01004394 mbedtls_free( signature );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02004395 PSA_DONE( );
Gilles Peskine20035e32018-02-03 22:44:14 +01004396}
4397/* END_CASE */
mohammad16038cc1cee2018-03-28 01:21:33 +03004398
4399/* BEGIN_CASE */
gabor-mezei-armb9530232021-04-16 14:21:21 +02004400void sign_verify_hash( int key_type_arg, data_t *key_data,
4401 int alg_arg, data_t *input_data )
Gilles Peskine9911b022018-06-29 17:30:48 +02004402{
Ronald Cron5425a212020-08-04 14:58:35 +02004403 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine9911b022018-06-29 17:30:48 +02004404 psa_key_type_t key_type = key_type_arg;
4405 psa_algorithm_t alg = alg_arg;
4406 size_t key_bits;
4407 unsigned char *signature = NULL;
4408 size_t signature_size;
4409 size_t signature_length = 0xdeadbeef;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02004410 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine9911b022018-06-29 17:30:48 +02004411
Gilles Peskine8817f612018-12-18 00:18:46 +01004412 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine9911b022018-06-29 17:30:48 +02004413
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01004414 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_HASH | PSA_KEY_USAGE_VERIFY_HASH );
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02004415 psa_set_key_algorithm( &attributes, alg );
4416 psa_set_key_type( &attributes, key_type );
Gilles Peskine9911b022018-06-29 17:30:48 +02004417
Gilles Peskine049c7532019-05-15 20:22:09 +02004418 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02004419 &key ) );
4420 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02004421 key_bits = psa_get_key_bits( &attributes );
Gilles Peskine9911b022018-06-29 17:30:48 +02004422
4423 /* Allocate a buffer which has the size advertized by the
4424 * library. */
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01004425 signature_size = PSA_SIGN_OUTPUT_SIZE( key_type,
Gilles Peskine9911b022018-06-29 17:30:48 +02004426 key_bits, alg );
4427 TEST_ASSERT( signature_size != 0 );
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01004428 TEST_ASSERT( signature_size <= PSA_SIGNATURE_MAX_SIZE );
Gilles Peskine8cebbba2018-09-27 13:54:18 +02004429 ASSERT_ALLOC( signature, signature_size );
Gilles Peskine9911b022018-06-29 17:30:48 +02004430
4431 /* Perform the signature. */
Ronald Cron5425a212020-08-04 14:58:35 +02004432 PSA_ASSERT( psa_sign_hash( key, alg,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01004433 input_data->x, input_data->len,
4434 signature, signature_size,
4435 &signature_length ) );
Gilles Peskine9911b022018-06-29 17:30:48 +02004436 /* Check that the signature length looks sensible. */
4437 TEST_ASSERT( signature_length <= signature_size );
4438 TEST_ASSERT( signature_length > 0 );
4439
4440 /* Use the library to verify that the signature is correct. */
Ronald Cron5425a212020-08-04 14:58:35 +02004441 PSA_ASSERT( psa_verify_hash( key, alg,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01004442 input_data->x, input_data->len,
4443 signature, signature_length ) );
Gilles Peskine9911b022018-06-29 17:30:48 +02004444
4445 if( input_data->len != 0 )
4446 {
4447 /* Flip a bit in the input and verify that the signature is now
4448 * detected as invalid. Flip a bit at the beginning, not at the end,
4449 * because ECDSA may ignore the last few bits of the input. */
4450 input_data->x[0] ^= 1;
Ronald Cron5425a212020-08-04 14:58:35 +02004451 TEST_EQUAL( psa_verify_hash( key, alg,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01004452 input_data->x, input_data->len,
4453 signature, signature_length ),
Gilles Peskinef812dcf2018-12-18 00:33:25 +01004454 PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine9911b022018-06-29 17:30:48 +02004455 }
4456
4457exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +01004458 /*
4459 * Key attributes may have been returned by psa_get_key_attributes()
4460 * thus reset them as required.
4461 */
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02004462 psa_reset_key_attributes( &attributes );
Ronald Cron3a4f0e32020-11-19 17:55:23 +01004463
Ronald Cron5425a212020-08-04 14:58:35 +02004464 psa_destroy_key( key );
Gilles Peskine9911b022018-06-29 17:30:48 +02004465 mbedtls_free( signature );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02004466 PSA_DONE( );
Gilles Peskine9911b022018-06-29 17:30:48 +02004467}
4468/* END_CASE */
4469
4470/* BEGIN_CASE */
gabor-mezei-armb9530232021-04-16 14:21:21 +02004471void verify_hash( int key_type_arg, data_t *key_data,
4472 int alg_arg, data_t *hash_data,
4473 data_t *signature_data )
itayzafrir5c753392018-05-08 11:18:38 +03004474{
Ronald Cron5425a212020-08-04 14:58:35 +02004475 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
itayzafrir5c753392018-05-08 11:18:38 +03004476 psa_key_type_t key_type = key_type_arg;
4477 psa_algorithm_t alg = alg_arg;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02004478 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
itayzafrir5c753392018-05-08 11:18:38 +03004479
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01004480 TEST_ASSERT( signature_data->len <= PSA_SIGNATURE_MAX_SIZE );
Gilles Peskine69c12672018-06-28 00:07:19 +02004481
Gilles Peskine8817f612018-12-18 00:18:46 +01004482 PSA_ASSERT( psa_crypto_init( ) );
itayzafrir5c753392018-05-08 11:18:38 +03004483
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01004484 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_VERIFY_HASH );
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02004485 psa_set_key_algorithm( &attributes, alg );
4486 psa_set_key_type( &attributes, key_type );
itayzafrir5c753392018-05-08 11:18:38 +03004487
Gilles Peskine049c7532019-05-15 20:22:09 +02004488 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02004489 &key ) );
itayzafrir5c753392018-05-08 11:18:38 +03004490
Ronald Cron5425a212020-08-04 14:58:35 +02004491 PSA_ASSERT( psa_verify_hash( key, alg,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01004492 hash_data->x, hash_data->len,
4493 signature_data->x, signature_data->len ) );
Gilles Peskine0627f982019-11-26 19:12:16 +01004494
itayzafrir5c753392018-05-08 11:18:38 +03004495exit:
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02004496 psa_reset_key_attributes( &attributes );
Ronald Cron5425a212020-08-04 14:58:35 +02004497 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02004498 PSA_DONE( );
itayzafrir5c753392018-05-08 11:18:38 +03004499}
4500/* END_CASE */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004501
4502/* BEGIN_CASE */
gabor-mezei-armb9530232021-04-16 14:21:21 +02004503void verify_hash_fail( int key_type_arg, data_t *key_data,
4504 int alg_arg, data_t *hash_data,
4505 data_t *signature_data,
4506 int expected_status_arg )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004507{
Ronald Cron5425a212020-08-04 14:58:35 +02004508 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004509 psa_key_type_t key_type = key_type_arg;
4510 psa_algorithm_t alg = alg_arg;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004511 psa_status_t actual_status;
4512 psa_status_t expected_status = expected_status_arg;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02004513 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004514
Gilles Peskine8817f612018-12-18 00:18:46 +01004515 PSA_ASSERT( psa_crypto_init( ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004516
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01004517 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_VERIFY_HASH );
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02004518 psa_set_key_algorithm( &attributes, alg );
4519 psa_set_key_type( &attributes, key_type );
Nir Sonnenscheind7082602018-06-04 16:45:27 +03004520
Gilles Peskine049c7532019-05-15 20:22:09 +02004521 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02004522 &key ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004523
Ronald Cron5425a212020-08-04 14:58:35 +02004524 actual_status = psa_verify_hash( key, alg,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01004525 hash_data->x, hash_data->len,
4526 signature_data->x, signature_data->len );
Gilles Peskinefe11b722018-12-18 00:24:04 +01004527 TEST_EQUAL( actual_status, expected_status );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004528
4529exit:
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02004530 psa_reset_key_attributes( &attributes );
Ronald Cron5425a212020-08-04 14:58:35 +02004531 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02004532 PSA_DONE( );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004533}
4534/* END_CASE */
4535
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004536/* BEGIN_CASE */
gabor-mezei-arm53028482021-04-15 18:19:50 +02004537void sign_message_deterministic( int key_type_arg,
4538 data_t *key_data,
4539 int alg_arg,
4540 data_t *input_data,
4541 data_t *output_data )
4542{
4543 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
4544 psa_key_type_t key_type = key_type_arg;
4545 psa_algorithm_t alg = alg_arg;
4546 size_t key_bits;
4547 unsigned char *signature = NULL;
4548 size_t signature_size;
4549 size_t signature_length = 0xdeadbeef;
4550 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
4551
4552 PSA_ASSERT( psa_crypto_init( ) );
4553
4554 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_MESSAGE );
4555 psa_set_key_algorithm( &attributes, alg );
4556 psa_set_key_type( &attributes, key_type );
4557
4558 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
4559 &key ) );
4560 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
4561 key_bits = psa_get_key_bits( &attributes );
4562
4563 signature_size = PSA_SIGN_OUTPUT_SIZE( key_type, key_bits, alg );
4564 TEST_ASSERT( signature_size != 0 );
4565 TEST_ASSERT( signature_size <= PSA_SIGNATURE_MAX_SIZE );
4566 ASSERT_ALLOC( signature, signature_size );
4567
4568 PSA_ASSERT( psa_sign_message( key, alg,
4569 input_data->x, input_data->len,
4570 signature, signature_size,
4571 &signature_length ) );
4572
4573 ASSERT_COMPARE( output_data->x, output_data->len,
4574 signature, signature_length );
4575
4576exit:
4577 psa_reset_key_attributes( &attributes );
4578
4579 psa_destroy_key( key );
4580 mbedtls_free( signature );
4581 PSA_DONE( );
4582
4583}
4584/* END_CASE */
4585
4586/* BEGIN_CASE */
4587void sign_message_fail( int key_type_arg,
4588 data_t *key_data,
4589 int alg_arg,
4590 data_t *input_data,
4591 int signature_size_arg,
4592 int expected_status_arg )
4593{
4594 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
4595 psa_key_type_t key_type = key_type_arg;
4596 psa_algorithm_t alg = alg_arg;
4597 size_t signature_size = signature_size_arg;
4598 psa_status_t actual_status;
4599 psa_status_t expected_status = expected_status_arg;
4600 unsigned char *signature = NULL;
4601 size_t signature_length = 0xdeadbeef;
4602 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
4603
4604 ASSERT_ALLOC( signature, signature_size );
4605
4606 PSA_ASSERT( psa_crypto_init( ) );
4607
4608 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_MESSAGE );
4609 psa_set_key_algorithm( &attributes, alg );
4610 psa_set_key_type( &attributes, key_type );
4611
4612 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
4613 &key ) );
4614
4615 actual_status = psa_sign_message( key, alg,
4616 input_data->x, input_data->len,
4617 signature, signature_size,
4618 &signature_length );
4619 TEST_EQUAL( actual_status, expected_status );
4620 /* The value of *signature_length is unspecified on error, but
4621 * whatever it is, it should be less than signature_size, so that
4622 * if the caller tries to read *signature_length bytes without
4623 * checking the error code then they don't overflow a buffer. */
4624 TEST_ASSERT( signature_length <= signature_size );
4625
4626exit:
4627 psa_reset_key_attributes( &attributes );
4628 psa_destroy_key( key );
4629 mbedtls_free( signature );
4630 PSA_DONE( );
4631}
4632/* END_CASE */
4633
4634/* BEGIN_CASE */
4635void sign_verify_message( int key_type_arg,
4636 data_t *key_data,
4637 int alg_arg,
4638 data_t *input_data )
4639{
4640 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
4641 psa_key_type_t key_type = key_type_arg;
4642 psa_algorithm_t alg = alg_arg;
4643 size_t key_bits;
4644 unsigned char *signature = NULL;
4645 size_t signature_size;
4646 size_t signature_length = 0xdeadbeef;
4647 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
4648
4649 PSA_ASSERT( psa_crypto_init( ) );
4650
4651 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_MESSAGE |
4652 PSA_KEY_USAGE_VERIFY_MESSAGE );
4653 psa_set_key_algorithm( &attributes, alg );
4654 psa_set_key_type( &attributes, key_type );
4655
4656 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
4657 &key ) );
4658 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
4659 key_bits = psa_get_key_bits( &attributes );
4660
4661 signature_size = PSA_SIGN_OUTPUT_SIZE( key_type, key_bits, alg );
4662 TEST_ASSERT( signature_size != 0 );
4663 TEST_ASSERT( signature_size <= PSA_SIGNATURE_MAX_SIZE );
4664 ASSERT_ALLOC( signature, signature_size );
4665
4666 PSA_ASSERT( psa_sign_message( key, alg,
4667 input_data->x, input_data->len,
4668 signature, signature_size,
4669 &signature_length ) );
4670 TEST_ASSERT( signature_length <= signature_size );
4671 TEST_ASSERT( signature_length > 0 );
4672
4673 PSA_ASSERT( psa_verify_message( key, alg,
4674 input_data->x, input_data->len,
4675 signature, signature_length ) );
4676
4677 if( input_data->len != 0 )
4678 {
4679 /* Flip a bit in the input and verify that the signature is now
4680 * detected as invalid. Flip a bit at the beginning, not at the end,
4681 * because ECDSA may ignore the last few bits of the input. */
4682 input_data->x[0] ^= 1;
4683 TEST_EQUAL( psa_verify_message( key, alg,
4684 input_data->x, input_data->len,
4685 signature, signature_length ),
4686 PSA_ERROR_INVALID_SIGNATURE );
4687 }
4688
4689exit:
4690 psa_reset_key_attributes( &attributes );
4691
4692 psa_destroy_key( key );
4693 mbedtls_free( signature );
4694 PSA_DONE( );
4695}
4696/* END_CASE */
4697
4698/* BEGIN_CASE */
4699void verify_message( int key_type_arg,
4700 data_t *key_data,
4701 int alg_arg,
4702 data_t *input_data,
4703 data_t *signature_data )
4704{
4705 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
4706 psa_key_type_t key_type = key_type_arg;
4707 psa_algorithm_t alg = alg_arg;
4708 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
4709
4710 TEST_ASSERT( signature_data->len <= PSA_SIGNATURE_MAX_SIZE );
4711
4712 PSA_ASSERT( psa_crypto_init( ) );
4713
4714 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_VERIFY_MESSAGE );
4715 psa_set_key_algorithm( &attributes, alg );
4716 psa_set_key_type( &attributes, key_type );
4717
4718 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
4719 &key ) );
4720
4721 PSA_ASSERT( psa_verify_message( key, alg,
4722 input_data->x, input_data->len,
4723 signature_data->x, signature_data->len ) );
4724
4725exit:
4726 psa_reset_key_attributes( &attributes );
4727 psa_destroy_key( key );
4728 PSA_DONE( );
4729}
4730/* END_CASE */
4731
4732/* BEGIN_CASE */
4733void verify_message_fail( int key_type_arg,
4734 data_t *key_data,
4735 int alg_arg,
4736 data_t *hash_data,
4737 data_t *signature_data,
4738 int expected_status_arg )
4739{
4740 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
4741 psa_key_type_t key_type = key_type_arg;
4742 psa_algorithm_t alg = alg_arg;
4743 psa_status_t actual_status;
4744 psa_status_t expected_status = expected_status_arg;
4745 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
4746
4747 PSA_ASSERT( psa_crypto_init( ) );
4748
4749 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_VERIFY_MESSAGE );
4750 psa_set_key_algorithm( &attributes, alg );
4751 psa_set_key_type( &attributes, key_type );
4752
4753 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
4754 &key ) );
4755
4756 actual_status = psa_verify_message( key, alg,
4757 hash_data->x, hash_data->len,
4758 signature_data->x,
4759 signature_data->len );
4760 TEST_EQUAL( actual_status, expected_status );
4761
4762exit:
4763 psa_reset_key_attributes( &attributes );
4764 psa_destroy_key( key );
4765 PSA_DONE( );
4766}
4767/* END_CASE */
4768
4769/* BEGIN_CASE */
Gilles Peskine656896e2018-06-29 19:12:28 +02004770void asymmetric_encrypt( int key_type_arg,
4771 data_t *key_data,
4772 int alg_arg,
4773 data_t *input_data,
Gilles Peskine68428122018-06-30 18:42:41 +02004774 data_t *label,
Gilles Peskine656896e2018-06-29 19:12:28 +02004775 int expected_output_length_arg,
4776 int expected_status_arg )
4777{
Ronald Cron5425a212020-08-04 14:58:35 +02004778 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine656896e2018-06-29 19:12:28 +02004779 psa_key_type_t key_type = key_type_arg;
4780 psa_algorithm_t alg = alg_arg;
4781 size_t expected_output_length = expected_output_length_arg;
4782 size_t key_bits;
4783 unsigned char *output = NULL;
4784 size_t output_size;
4785 size_t output_length = ~0;
4786 psa_status_t actual_status;
4787 psa_status_t expected_status = expected_status_arg;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02004788 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine656896e2018-06-29 19:12:28 +02004789
Gilles Peskine8817f612018-12-18 00:18:46 +01004790 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskinebdf309c2018-12-03 15:36:32 +01004791
Gilles Peskine656896e2018-06-29 19:12:28 +02004792 /* Import the key */
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02004793 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
4794 psa_set_key_algorithm( &attributes, alg );
4795 psa_set_key_type( &attributes, key_type );
Gilles Peskine049c7532019-05-15 20:22:09 +02004796 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02004797 &key ) );
Gilles Peskine656896e2018-06-29 19:12:28 +02004798
4799 /* Determine the maximum output length */
Ronald Cron5425a212020-08-04 14:58:35 +02004800 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02004801 key_bits = psa_get_key_bits( &attributes );
gabor-mezei-armceface22021-01-21 12:26:17 +01004802
Gilles Peskine656896e2018-06-29 19:12:28 +02004803 output_size = PSA_ASYMMETRIC_ENCRYPT_OUTPUT_SIZE( key_type, key_bits, alg );
gabor-mezei-armceface22021-01-21 12:26:17 +01004804 TEST_ASSERT( output_size <= PSA_ASYMMETRIC_ENCRYPT_OUTPUT_MAX_SIZE );
Gilles Peskine8cebbba2018-09-27 13:54:18 +02004805 ASSERT_ALLOC( output, output_size );
Gilles Peskine656896e2018-06-29 19:12:28 +02004806
4807 /* Encrypt the input */
Ronald Cron5425a212020-08-04 14:58:35 +02004808 actual_status = psa_asymmetric_encrypt( key, alg,
Gilles Peskine656896e2018-06-29 19:12:28 +02004809 input_data->x, input_data->len,
Gilles Peskine68428122018-06-30 18:42:41 +02004810 label->x, label->len,
Gilles Peskine656896e2018-06-29 19:12:28 +02004811 output, output_size,
4812 &output_length );
Gilles Peskinefe11b722018-12-18 00:24:04 +01004813 TEST_EQUAL( actual_status, expected_status );
4814 TEST_EQUAL( output_length, expected_output_length );
Gilles Peskine656896e2018-06-29 19:12:28 +02004815
Gilles Peskine68428122018-06-30 18:42:41 +02004816 /* If the label is empty, the test framework puts a non-null pointer
4817 * in label->x. Test that a null pointer works as well. */
4818 if( label->len == 0 )
4819 {
4820 output_length = ~0;
Gilles Peskinef7ab5ad2018-09-26 18:19:24 +02004821 if( output_size != 0 )
4822 memset( output, 0, output_size );
Ronald Cron5425a212020-08-04 14:58:35 +02004823 actual_status = psa_asymmetric_encrypt( key, alg,
Gilles Peskine68428122018-06-30 18:42:41 +02004824 input_data->x, input_data->len,
4825 NULL, label->len,
4826 output, output_size,
4827 &output_length );
Gilles Peskinefe11b722018-12-18 00:24:04 +01004828 TEST_EQUAL( actual_status, expected_status );
4829 TEST_EQUAL( output_length, expected_output_length );
Gilles Peskine68428122018-06-30 18:42:41 +02004830 }
4831
Gilles Peskine656896e2018-06-29 19:12:28 +02004832exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +01004833 /*
4834 * Key attributes may have been returned by psa_get_key_attributes()
4835 * thus reset them as required.
4836 */
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02004837 psa_reset_key_attributes( &attributes );
Ronald Cron3a4f0e32020-11-19 17:55:23 +01004838
Ronald Cron5425a212020-08-04 14:58:35 +02004839 psa_destroy_key( key );
Gilles Peskine656896e2018-06-29 19:12:28 +02004840 mbedtls_free( output );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02004841 PSA_DONE( );
Gilles Peskine656896e2018-06-29 19:12:28 +02004842}
4843/* END_CASE */
4844
4845/* BEGIN_CASE */
Gilles Peskine68428122018-06-30 18:42:41 +02004846void asymmetric_encrypt_decrypt( int key_type_arg,
4847 data_t *key_data,
4848 int alg_arg,
4849 data_t *input_data,
4850 data_t *label )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004851{
Ronald Cron5425a212020-08-04 14:58:35 +02004852 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004853 psa_key_type_t key_type = key_type_arg;
4854 psa_algorithm_t alg = alg_arg;
Gilles Peskine55c94dd2018-06-30 18:54:48 +02004855 size_t key_bits;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004856 unsigned char *output = NULL;
Gilles Peskine55c94dd2018-06-30 18:54:48 +02004857 size_t output_size;
4858 size_t output_length = ~0;
Nir Sonnenschein0f3bdbd2018-05-02 23:56:12 +03004859 unsigned char *output2 = NULL;
Gilles Peskine55c94dd2018-06-30 18:54:48 +02004860 size_t output2_size;
4861 size_t output2_length = ~0;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02004862 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004863
Gilles Peskine8817f612018-12-18 00:18:46 +01004864 PSA_ASSERT( psa_crypto_init( ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004865
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02004866 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT | PSA_KEY_USAGE_DECRYPT );
4867 psa_set_key_algorithm( &attributes, alg );
4868 psa_set_key_type( &attributes, key_type );
Nir Sonnenscheind7082602018-06-04 16:45:27 +03004869
Gilles Peskine049c7532019-05-15 20:22:09 +02004870 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02004871 &key ) );
Gilles Peskine55c94dd2018-06-30 18:54:48 +02004872
4873 /* Determine the maximum ciphertext length */
Ronald Cron5425a212020-08-04 14:58:35 +02004874 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02004875 key_bits = psa_get_key_bits( &attributes );
gabor-mezei-armceface22021-01-21 12:26:17 +01004876
Gilles Peskine55c94dd2018-06-30 18:54:48 +02004877 output_size = PSA_ASYMMETRIC_ENCRYPT_OUTPUT_SIZE( key_type, key_bits, alg );
gabor-mezei-armceface22021-01-21 12:26:17 +01004878 TEST_ASSERT( output_size <= PSA_ASYMMETRIC_ENCRYPT_OUTPUT_MAX_SIZE );
Gilles Peskine8cebbba2018-09-27 13:54:18 +02004879 ASSERT_ALLOC( output, output_size );
gabor-mezei-armceface22021-01-21 12:26:17 +01004880
Gilles Peskine55c94dd2018-06-30 18:54:48 +02004881 output2_size = input_data->len;
gabor-mezei-armceface22021-01-21 12:26:17 +01004882 TEST_ASSERT( output2_size <=
4883 PSA_ASYMMETRIC_DECRYPT_OUTPUT_SIZE( key_type, key_bits, alg ) );
4884 TEST_ASSERT( output2_size <= PSA_ASYMMETRIC_DECRYPT_OUTPUT_MAX_SIZE );
Gilles Peskine8cebbba2018-09-27 13:54:18 +02004885 ASSERT_ALLOC( output2, output2_size );
Gilles Peskine55c94dd2018-06-30 18:54:48 +02004886
Gilles Peskineeebd7382018-06-08 18:11:54 +02004887 /* We test encryption by checking that encrypt-then-decrypt gives back
4888 * the original plaintext because of the non-optional random
4889 * part of encryption process which prevents using fixed vectors. */
Ronald Cron5425a212020-08-04 14:58:35 +02004890 PSA_ASSERT( psa_asymmetric_encrypt( key, alg,
Gilles Peskine8817f612018-12-18 00:18:46 +01004891 input_data->x, input_data->len,
4892 label->x, label->len,
4893 output, output_size,
4894 &output_length ) );
Gilles Peskine55c94dd2018-06-30 18:54:48 +02004895 /* We don't know what ciphertext length to expect, but check that
4896 * it looks sensible. */
4897 TEST_ASSERT( output_length <= output_size );
Nir Sonnenschein0f3bdbd2018-05-02 23:56:12 +03004898
Ronald Cron5425a212020-08-04 14:58:35 +02004899 PSA_ASSERT( psa_asymmetric_decrypt( key, alg,
Gilles Peskine8817f612018-12-18 00:18:46 +01004900 output, output_length,
4901 label->x, label->len,
4902 output2, output2_size,
4903 &output2_length ) );
Gilles Peskinebd7dea92018-09-27 13:57:19 +02004904 ASSERT_COMPARE( input_data->x, input_data->len,
4905 output2, output2_length );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004906
4907exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +01004908 /*
4909 * Key attributes may have been returned by psa_get_key_attributes()
4910 * thus reset them as required.
4911 */
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02004912 psa_reset_key_attributes( &attributes );
Ronald Cron3a4f0e32020-11-19 17:55:23 +01004913
Ronald Cron5425a212020-08-04 14:58:35 +02004914 psa_destroy_key( key );
itayzafrir3e02b3b2018-06-12 17:06:52 +03004915 mbedtls_free( output );
4916 mbedtls_free( output2 );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02004917 PSA_DONE( );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004918}
4919/* END_CASE */
4920
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004921/* BEGIN_CASE */
Gilles Peskine68428122018-06-30 18:42:41 +02004922void asymmetric_decrypt( int key_type_arg,
4923 data_t *key_data,
4924 int alg_arg,
4925 data_t *input_data,
4926 data_t *label,
Gilles Peskine66763a02018-06-29 21:54:10 +02004927 data_t *expected_data )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004928{
Ronald Cron5425a212020-08-04 14:58:35 +02004929 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004930 psa_key_type_t key_type = key_type_arg;
4931 psa_algorithm_t alg = alg_arg;
gabor-mezei-armceface22021-01-21 12:26:17 +01004932 size_t key_bits;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004933 unsigned char *output = NULL;
Nir Sonnenscheind70bc482018-06-04 16:31:13 +03004934 size_t output_size = 0;
Gilles Peskine55c94dd2018-06-30 18:54:48 +02004935 size_t output_length = ~0;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02004936 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004937
Gilles Peskine8817f612018-12-18 00:18:46 +01004938 PSA_ASSERT( psa_crypto_init( ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004939
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02004940 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DECRYPT );
4941 psa_set_key_algorithm( &attributes, alg );
4942 psa_set_key_type( &attributes, key_type );
Nir Sonnenscheind7082602018-06-04 16:45:27 +03004943
Gilles Peskine049c7532019-05-15 20:22:09 +02004944 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02004945 &key ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004946
gabor-mezei-armceface22021-01-21 12:26:17 +01004947 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
4948 key_bits = psa_get_key_bits( &attributes );
4949
4950 /* Determine the maximum ciphertext length */
4951 output_size = PSA_ASYMMETRIC_DECRYPT_OUTPUT_SIZE( key_type, key_bits, alg );
4952 TEST_ASSERT( output_size <= PSA_ASYMMETRIC_DECRYPT_OUTPUT_MAX_SIZE );
4953 ASSERT_ALLOC( output, output_size );
4954
Ronald Cron5425a212020-08-04 14:58:35 +02004955 PSA_ASSERT( psa_asymmetric_decrypt( key, alg,
Gilles Peskine8817f612018-12-18 00:18:46 +01004956 input_data->x, input_data->len,
4957 label->x, label->len,
4958 output,
4959 output_size,
4960 &output_length ) );
Gilles Peskinebd7dea92018-09-27 13:57:19 +02004961 ASSERT_COMPARE( expected_data->x, expected_data->len,
4962 output, output_length );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004963
Gilles Peskine68428122018-06-30 18:42:41 +02004964 /* If the label is empty, the test framework puts a non-null pointer
4965 * in label->x. Test that a null pointer works as well. */
4966 if( label->len == 0 )
4967 {
4968 output_length = ~0;
Gilles Peskinef7ab5ad2018-09-26 18:19:24 +02004969 if( output_size != 0 )
4970 memset( output, 0, output_size );
Ronald Cron5425a212020-08-04 14:58:35 +02004971 PSA_ASSERT( psa_asymmetric_decrypt( key, alg,
Gilles Peskine8817f612018-12-18 00:18:46 +01004972 input_data->x, input_data->len,
4973 NULL, label->len,
4974 output,
4975 output_size,
4976 &output_length ) );
Gilles Peskinebd7dea92018-09-27 13:57:19 +02004977 ASSERT_COMPARE( expected_data->x, expected_data->len,
4978 output, output_length );
Gilles Peskine68428122018-06-30 18:42:41 +02004979 }
4980
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004981exit:
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02004982 psa_reset_key_attributes( &attributes );
Ronald Cron5425a212020-08-04 14:58:35 +02004983 psa_destroy_key( key );
itayzafrir3e02b3b2018-06-12 17:06:52 +03004984 mbedtls_free( output );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02004985 PSA_DONE( );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004986}
4987/* END_CASE */
4988
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004989/* BEGIN_CASE */
Gilles Peskine68428122018-06-30 18:42:41 +02004990void asymmetric_decrypt_fail( int key_type_arg,
4991 data_t *key_data,
4992 int alg_arg,
4993 data_t *input_data,
4994 data_t *label,
Jaeden Amerof8daab72019-02-06 12:57:46 +00004995 int output_size_arg,
Gilles Peskine2d277862018-06-18 15:41:12 +02004996 int expected_status_arg )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004997{
Ronald Cron5425a212020-08-04 14:58:35 +02004998 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004999 psa_key_type_t key_type = key_type_arg;
5000 psa_algorithm_t alg = alg_arg;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005001 unsigned char *output = NULL;
Jaeden Amerof8daab72019-02-06 12:57:46 +00005002 size_t output_size = output_size_arg;
Gilles Peskine55c94dd2018-06-30 18:54:48 +02005003 size_t output_length = ~0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005004 psa_status_t actual_status;
5005 psa_status_t expected_status = expected_status_arg;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02005006 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005007
Gilles Peskine8cebbba2018-09-27 13:54:18 +02005008 ASSERT_ALLOC( output, output_size );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02005009
Gilles Peskine8817f612018-12-18 00:18:46 +01005010 PSA_ASSERT( psa_crypto_init( ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005011
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02005012 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DECRYPT );
5013 psa_set_key_algorithm( &attributes, alg );
5014 psa_set_key_type( &attributes, key_type );
Nir Sonnenscheind7082602018-06-04 16:45:27 +03005015
Gilles Peskine049c7532019-05-15 20:22:09 +02005016 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02005017 &key ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005018
Ronald Cron5425a212020-08-04 14:58:35 +02005019 actual_status = psa_asymmetric_decrypt( key, alg,
Gilles Peskine4abf7412018-06-18 16:35:34 +02005020 input_data->x, input_data->len,
Gilles Peskine68428122018-06-30 18:42:41 +02005021 label->x, label->len,
Gilles Peskine4abf7412018-06-18 16:35:34 +02005022 output, output_size,
Gilles Peskine2d277862018-06-18 15:41:12 +02005023 &output_length );
Gilles Peskinefe11b722018-12-18 00:24:04 +01005024 TEST_EQUAL( actual_status, expected_status );
Gilles Peskine55c94dd2018-06-30 18:54:48 +02005025 TEST_ASSERT( output_length <= output_size );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005026
Gilles Peskine68428122018-06-30 18:42:41 +02005027 /* If the label is empty, the test framework puts a non-null pointer
5028 * in label->x. Test that a null pointer works as well. */
5029 if( label->len == 0 )
5030 {
5031 output_length = ~0;
Gilles Peskinef7ab5ad2018-09-26 18:19:24 +02005032 if( output_size != 0 )
5033 memset( output, 0, output_size );
Ronald Cron5425a212020-08-04 14:58:35 +02005034 actual_status = psa_asymmetric_decrypt( key, alg,
Gilles Peskine68428122018-06-30 18:42:41 +02005035 input_data->x, input_data->len,
5036 NULL, label->len,
5037 output, output_size,
5038 &output_length );
Gilles Peskinefe11b722018-12-18 00:24:04 +01005039 TEST_EQUAL( actual_status, expected_status );
Gilles Peskine55c94dd2018-06-30 18:54:48 +02005040 TEST_ASSERT( output_length <= output_size );
Gilles Peskine68428122018-06-30 18:42:41 +02005041 }
5042
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005043exit:
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02005044 psa_reset_key_attributes( &attributes );
Ronald Cron5425a212020-08-04 14:58:35 +02005045 psa_destroy_key( key );
Gilles Peskine2d277862018-06-18 15:41:12 +02005046 mbedtls_free( output );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02005047 PSA_DONE( );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005048}
Gilles Peskine5b051bc2018-05-31 13:25:48 +02005049/* END_CASE */
Gilles Peskine05d69892018-06-19 22:00:52 +02005050
5051/* BEGIN_CASE */
Gilles Peskinecbe66502019-05-16 16:59:18 +02005052void key_derivation_init( )
Jaeden Amerod94d6712019-01-04 14:11:48 +00005053{
5054 /* Test each valid way of initializing the object, except for `= {0}`, as
5055 * Clang 5 complains when `-Wmissing-field-initializers` is used, even
5056 * though it's OK by the C standard. We could test for this, but we'd need
5057 * to supress the Clang warning for the test. */
Jaeden Amero5229bbb2019-02-07 16:33:37 +00005058 size_t capacity;
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005059 psa_key_derivation_operation_t func = psa_key_derivation_operation_init( );
5060 psa_key_derivation_operation_t init = PSA_KEY_DERIVATION_OPERATION_INIT;
5061 psa_key_derivation_operation_t zero;
Jaeden Amerod94d6712019-01-04 14:11:48 +00005062
5063 memset( &zero, 0, sizeof( zero ) );
5064
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005065 /* A default operation should not be able to report its capacity. */
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005066 TEST_EQUAL( psa_key_derivation_get_capacity( &func, &capacity ),
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005067 PSA_ERROR_BAD_STATE );
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005068 TEST_EQUAL( psa_key_derivation_get_capacity( &init, &capacity ),
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005069 PSA_ERROR_BAD_STATE );
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005070 TEST_EQUAL( psa_key_derivation_get_capacity( &zero, &capacity ),
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005071 PSA_ERROR_BAD_STATE );
Jaeden Amero5229bbb2019-02-07 16:33:37 +00005072
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005073 /* A default operation should be abortable without error. */
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005074 PSA_ASSERT( psa_key_derivation_abort(&func) );
5075 PSA_ASSERT( psa_key_derivation_abort(&init) );
5076 PSA_ASSERT( psa_key_derivation_abort(&zero) );
Jaeden Amerod94d6712019-01-04 14:11:48 +00005077}
5078/* END_CASE */
5079
Janos Follath16de4a42019-06-13 16:32:24 +01005080/* BEGIN_CASE */
5081void derive_setup( int alg_arg, int expected_status_arg )
Gilles Peskineea0fb492018-07-12 17:17:20 +02005082{
Gilles Peskineea0fb492018-07-12 17:17:20 +02005083 psa_algorithm_t alg = alg_arg;
Gilles Peskineea0fb492018-07-12 17:17:20 +02005084 psa_status_t expected_status = expected_status_arg;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005085 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Gilles Peskineea0fb492018-07-12 17:17:20 +02005086
Gilles Peskine8817f612018-12-18 00:18:46 +01005087 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskineea0fb492018-07-12 17:17:20 +02005088
Janos Follath16de4a42019-06-13 16:32:24 +01005089 TEST_EQUAL( psa_key_derivation_setup( &operation, alg ),
Gilles Peskinef812dcf2018-12-18 00:33:25 +01005090 expected_status );
Gilles Peskineea0fb492018-07-12 17:17:20 +02005091
5092exit:
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005093 psa_key_derivation_abort( &operation );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02005094 PSA_DONE( );
Gilles Peskineea0fb492018-07-12 17:17:20 +02005095}
5096/* END_CASE */
5097
Janos Follathaf3c2a02019-06-12 12:34:34 +01005098/* BEGIN_CASE */
Janos Follatha27c9272019-06-14 09:59:36 +01005099void derive_set_capacity( int alg_arg, int capacity_arg,
5100 int expected_status_arg )
5101{
5102 psa_algorithm_t alg = alg_arg;
5103 size_t capacity = capacity_arg;
5104 psa_status_t expected_status = expected_status_arg;
5105 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
5106
5107 PSA_ASSERT( psa_crypto_init( ) );
5108
5109 PSA_ASSERT( psa_key_derivation_setup( &operation, alg ) );
5110
5111 TEST_EQUAL( psa_key_derivation_set_capacity( &operation, capacity ),
5112 expected_status );
5113
5114exit:
5115 psa_key_derivation_abort( &operation );
5116 PSA_DONE( );
5117}
5118/* END_CASE */
5119
5120/* BEGIN_CASE */
Janos Follathaf3c2a02019-06-12 12:34:34 +01005121void derive_input( int alg_arg,
Gilles Peskine6842ba42019-09-23 13:49:33 +02005122 int step_arg1, int key_type_arg1, data_t *input1,
Janos Follathaf3c2a02019-06-12 12:34:34 +01005123 int expected_status_arg1,
Gilles Peskine2058c072019-09-24 17:19:33 +02005124 int step_arg2, int key_type_arg2, data_t *input2,
Janos Follathaf3c2a02019-06-12 12:34:34 +01005125 int expected_status_arg2,
Gilles Peskine2058c072019-09-24 17:19:33 +02005126 int step_arg3, int key_type_arg3, data_t *input3,
Gilles Peskine1a2904c2019-09-24 17:45:07 +02005127 int expected_status_arg3,
5128 int output_key_type_arg, int expected_output_status_arg )
Janos Follathaf3c2a02019-06-12 12:34:34 +01005129{
5130 psa_algorithm_t alg = alg_arg;
Gilles Peskine6842ba42019-09-23 13:49:33 +02005131 psa_key_derivation_step_t steps[] = {step_arg1, step_arg2, step_arg3};
5132 psa_key_type_t key_types[] = {key_type_arg1, key_type_arg2, key_type_arg3};
Janos Follathaf3c2a02019-06-12 12:34:34 +01005133 psa_status_t expected_statuses[] = {expected_status_arg1,
5134 expected_status_arg2,
5135 expected_status_arg3};
5136 data_t *inputs[] = {input1, input2, input3};
Ronald Cron5425a212020-08-04 14:58:35 +02005137 mbedtls_svc_key_id_t keys[] = { MBEDTLS_SVC_KEY_ID_INIT,
5138 MBEDTLS_SVC_KEY_ID_INIT,
5139 MBEDTLS_SVC_KEY_ID_INIT };
Janos Follathaf3c2a02019-06-12 12:34:34 +01005140 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
5141 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
5142 size_t i;
Gilles Peskine1a2904c2019-09-24 17:45:07 +02005143 psa_key_type_t output_key_type = output_key_type_arg;
Ronald Cron5425a212020-08-04 14:58:35 +02005144 mbedtls_svc_key_id_t output_key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine1a2904c2019-09-24 17:45:07 +02005145 psa_status_t expected_output_status = expected_output_status_arg;
5146 psa_status_t actual_output_status;
Janos Follathaf3c2a02019-06-12 12:34:34 +01005147
5148 PSA_ASSERT( psa_crypto_init( ) );
5149
5150 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DERIVE );
5151 psa_set_key_algorithm( &attributes, alg );
Janos Follathaf3c2a02019-06-12 12:34:34 +01005152
5153 PSA_ASSERT( psa_key_derivation_setup( &operation, alg ) );
5154
5155 for( i = 0; i < ARRAY_LENGTH( steps ); i++ )
5156 {
Gilles Peskineb8965192019-09-24 16:21:10 +02005157 if( key_types[i] != PSA_KEY_TYPE_NONE )
Janos Follathaf3c2a02019-06-12 12:34:34 +01005158 {
Gilles Peskine6842ba42019-09-23 13:49:33 +02005159 psa_set_key_type( &attributes, key_types[i] );
5160 PSA_ASSERT( psa_import_key( &attributes,
5161 inputs[i]->x, inputs[i]->len,
Ronald Cron5425a212020-08-04 14:58:35 +02005162 &keys[i] ) );
Steven Cooreman0ee0d522020-10-05 16:03:42 +02005163 if( PSA_KEY_TYPE_IS_KEY_PAIR( key_types[i] ) &&
5164 steps[i] == PSA_KEY_DERIVATION_INPUT_SECRET )
5165 {
5166 // When taking a private key as secret input, use key agreement
5167 // to add the shared secret to the derivation
Gilles Peskinec18e25f2021-02-12 23:48:20 +01005168 TEST_EQUAL( mbedtls_test_psa_key_agreement_with_self(
5169 &operation, keys[i] ),
Steven Cooreman0ee0d522020-10-05 16:03:42 +02005170 expected_statuses[i] );
5171 }
5172 else
5173 {
5174 TEST_EQUAL( psa_key_derivation_input_key( &operation, steps[i],
Ronald Cron5425a212020-08-04 14:58:35 +02005175 keys[i] ),
Steven Cooreman0ee0d522020-10-05 16:03:42 +02005176 expected_statuses[i] );
5177 }
Gilles Peskine6842ba42019-09-23 13:49:33 +02005178 }
5179 else
5180 {
5181 TEST_EQUAL( psa_key_derivation_input_bytes(
5182 &operation, steps[i],
5183 inputs[i]->x, inputs[i]->len ),
5184 expected_statuses[i] );
Janos Follathaf3c2a02019-06-12 12:34:34 +01005185 }
5186 }
5187
Gilles Peskine1a2904c2019-09-24 17:45:07 +02005188 if( output_key_type != PSA_KEY_TYPE_NONE )
5189 {
5190 psa_reset_key_attributes( &attributes );
5191 psa_set_key_type( &attributes, PSA_KEY_TYPE_RAW_DATA );
5192 psa_set_key_bits( &attributes, 8 );
5193 actual_output_status =
5194 psa_key_derivation_output_key( &attributes, &operation,
Ronald Cron5425a212020-08-04 14:58:35 +02005195 &output_key );
Gilles Peskine1a2904c2019-09-24 17:45:07 +02005196 }
5197 else
5198 {
5199 uint8_t buffer[1];
5200 actual_output_status =
5201 psa_key_derivation_output_bytes( &operation,
5202 buffer, sizeof( buffer ) );
5203 }
5204 TEST_EQUAL( actual_output_status, expected_output_status );
5205
Janos Follathaf3c2a02019-06-12 12:34:34 +01005206exit:
5207 psa_key_derivation_abort( &operation );
Ronald Cron5425a212020-08-04 14:58:35 +02005208 for( i = 0; i < ARRAY_LENGTH( keys ); i++ )
5209 psa_destroy_key( keys[i] );
5210 psa_destroy_key( output_key );
Janos Follathaf3c2a02019-06-12 12:34:34 +01005211 PSA_DONE( );
5212}
5213/* END_CASE */
5214
Janos Follathd958bb72019-07-03 15:02:16 +01005215/* BEGIN_CASE */
5216void test_derive_invalid_key_derivation_state( int alg_arg )
Nir Sonnenscheine5204c92018-10-22 17:24:55 +03005217{
Janos Follathd958bb72019-07-03 15:02:16 +01005218 psa_algorithm_t alg = alg_arg;
Ronald Cron5425a212020-08-04 14:58:35 +02005219 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Nir Sonnenschein4eda37b2018-10-31 12:15:58 +02005220 size_t key_type = PSA_KEY_TYPE_DERIVE;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005221 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Janos Follathd958bb72019-07-03 15:02:16 +01005222 unsigned char input1[] = "Input 1";
5223 size_t input1_length = sizeof( input1 );
5224 unsigned char input2[] = "Input 2";
5225 size_t input2_length = sizeof( input2 );
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03005226 uint8_t buffer[42];
Nir Sonnenschein1caf6d22018-11-01 12:27:20 +02005227 size_t capacity = sizeof( buffer );
Nir Sonnenscheindd69d8b2018-11-01 12:24:23 +02005228 const uint8_t key_data[22] = { 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b,
5229 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b,
5230 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b};
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02005231 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Nir Sonnenscheine5204c92018-10-22 17:24:55 +03005232
Gilles Peskine8817f612018-12-18 00:18:46 +01005233 PSA_ASSERT( psa_crypto_init( ) );
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03005234
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02005235 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DERIVE );
5236 psa_set_key_algorithm( &attributes, alg );
5237 psa_set_key_type( &attributes, key_type );
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03005238
Gilles Peskine73676cb2019-05-15 20:15:10 +02005239 PSA_ASSERT( psa_import_key( &attributes,
5240 key_data, sizeof( key_data ),
Ronald Cron5425a212020-08-04 14:58:35 +02005241 &key ) );
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03005242
5243 /* valid key derivation */
Gilles Peskinec18e25f2021-02-12 23:48:20 +01005244 if( !mbedtls_test_psa_setup_key_derivation_wrap( &operation, key, alg,
5245 input1, input1_length,
5246 input2, input2_length,
5247 capacity ) )
Janos Follathd958bb72019-07-03 15:02:16 +01005248 goto exit;
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03005249
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005250 /* state of operation shouldn't allow additional generation */
Janos Follathd958bb72019-07-03 15:02:16 +01005251 TEST_EQUAL( psa_key_derivation_setup( &operation, alg ),
Gilles Peskinef812dcf2018-12-18 00:33:25 +01005252 PSA_ERROR_BAD_STATE );
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03005253
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005254 PSA_ASSERT( psa_key_derivation_output_bytes( &operation, buffer, capacity ) );
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03005255
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005256 TEST_EQUAL( psa_key_derivation_output_bytes( &operation, buffer, capacity ),
David Saadab4ecc272019-02-14 13:48:10 +02005257 PSA_ERROR_INSUFFICIENT_DATA );
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03005258
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03005259exit:
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005260 psa_key_derivation_abort( &operation );
Ronald Cron5425a212020-08-04 14:58:35 +02005261 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02005262 PSA_DONE( );
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03005263}
5264/* END_CASE */
5265
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03005266/* BEGIN_CASE */
Gilles Peskinecbe66502019-05-16 16:59:18 +02005267void test_derive_invalid_key_derivation_tests( )
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03005268{
5269 uint8_t output_buffer[16];
5270 size_t buffer_size = 16;
5271 size_t capacity = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005272 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03005273
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005274 TEST_ASSERT( psa_key_derivation_output_bytes( &operation,
5275 output_buffer, buffer_size )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005276 == PSA_ERROR_BAD_STATE );
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03005277
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005278 TEST_ASSERT( psa_key_derivation_get_capacity( &operation, &capacity )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005279 == PSA_ERROR_BAD_STATE );
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03005280
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005281 PSA_ASSERT( psa_key_derivation_abort( &operation ) );
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03005282
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005283 TEST_ASSERT( psa_key_derivation_output_bytes( &operation,
5284 output_buffer, buffer_size )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005285 == PSA_ERROR_BAD_STATE );
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03005286
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005287 TEST_ASSERT( psa_key_derivation_get_capacity( &operation, &capacity )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005288 == PSA_ERROR_BAD_STATE );
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03005289
5290exit:
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005291 psa_key_derivation_abort( &operation );
Nir Sonnenscheine5204c92018-10-22 17:24:55 +03005292}
5293/* END_CASE */
5294
5295/* BEGIN_CASE */
Gilles Peskine96ee5c72018-07-12 17:24:54 +02005296void derive_output( int alg_arg,
Gilles Peskine1468da72019-05-29 17:35:49 +02005297 int step1_arg, data_t *input1,
5298 int step2_arg, data_t *input2,
5299 int step3_arg, data_t *input3,
Gilles Peskine96ee5c72018-07-12 17:24:54 +02005300 int requested_capacity_arg,
5301 data_t *expected_output1,
5302 data_t *expected_output2 )
5303{
Gilles Peskine96ee5c72018-07-12 17:24:54 +02005304 psa_algorithm_t alg = alg_arg;
Gilles Peskine1468da72019-05-29 17:35:49 +02005305 psa_key_derivation_step_t steps[] = {step1_arg, step2_arg, step3_arg};
5306 data_t *inputs[] = {input1, input2, input3};
Ronald Cron5425a212020-08-04 14:58:35 +02005307 mbedtls_svc_key_id_t keys[] = { MBEDTLS_SVC_KEY_ID_INIT,
5308 MBEDTLS_SVC_KEY_ID_INIT,
5309 MBEDTLS_SVC_KEY_ID_INIT };
Gilles Peskine96ee5c72018-07-12 17:24:54 +02005310 size_t requested_capacity = requested_capacity_arg;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005311 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Gilles Peskine96ee5c72018-07-12 17:24:54 +02005312 uint8_t *expected_outputs[2] =
5313 {expected_output1->x, expected_output2->x};
5314 size_t output_sizes[2] =
5315 {expected_output1->len, expected_output2->len};
5316 size_t output_buffer_size = 0;
5317 uint8_t *output_buffer = NULL;
5318 size_t expected_capacity;
5319 size_t current_capacity;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005320 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine96ee5c72018-07-12 17:24:54 +02005321 psa_status_t status;
Gilles Peskine1468da72019-05-29 17:35:49 +02005322 size_t i;
Gilles Peskine96ee5c72018-07-12 17:24:54 +02005323
5324 for( i = 0; i < ARRAY_LENGTH( expected_outputs ); i++ )
5325 {
5326 if( output_sizes[i] > output_buffer_size )
5327 output_buffer_size = output_sizes[i];
5328 if( output_sizes[i] == 0 )
5329 expected_outputs[i] = NULL;
5330 }
Gilles Peskine8cebbba2018-09-27 13:54:18 +02005331 ASSERT_ALLOC( output_buffer, output_buffer_size );
Gilles Peskine8817f612018-12-18 00:18:46 +01005332 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine96ee5c72018-07-12 17:24:54 +02005333
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005334 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DERIVE );
5335 psa_set_key_algorithm( &attributes, alg );
5336 psa_set_key_type( &attributes, PSA_KEY_TYPE_DERIVE );
Gilles Peskine96ee5c72018-07-12 17:24:54 +02005337
Gilles Peskine96ee5c72018-07-12 17:24:54 +02005338 /* Extraction phase. */
Gilles Peskine1468da72019-05-29 17:35:49 +02005339 PSA_ASSERT( psa_key_derivation_setup( &operation, alg ) );
5340 PSA_ASSERT( psa_key_derivation_set_capacity( &operation,
5341 requested_capacity ) );
5342 for( i = 0; i < ARRAY_LENGTH( steps ); i++ )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005343 {
Gilles Peskine1468da72019-05-29 17:35:49 +02005344 switch( steps[i] )
5345 {
5346 case 0:
5347 break;
5348 case PSA_KEY_DERIVATION_INPUT_SECRET:
5349 PSA_ASSERT( psa_import_key( &attributes,
5350 inputs[i]->x, inputs[i]->len,
Ronald Cron5425a212020-08-04 14:58:35 +02005351 &keys[i] ) );
gabor-mezei-armceface22021-01-21 12:26:17 +01005352
5353 if ( PSA_ALG_IS_TLS12_PSK_TO_MS( alg ) )
5354 {
5355 PSA_ASSERT( psa_get_key_attributes( keys[i], &attributes ) );
5356 TEST_ASSERT( PSA_BITS_TO_BYTES( psa_get_key_bits( &attributes ) ) <=
5357 PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE );
5358 }
5359
Gilles Peskine1468da72019-05-29 17:35:49 +02005360 PSA_ASSERT( psa_key_derivation_input_key(
Ronald Cron5425a212020-08-04 14:58:35 +02005361 &operation, steps[i], keys[i] ) );
Gilles Peskine1468da72019-05-29 17:35:49 +02005362 break;
5363 default:
5364 PSA_ASSERT( psa_key_derivation_input_bytes(
5365 &operation, steps[i],
5366 inputs[i]->x, inputs[i]->len ) );
5367 break;
5368 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005369 }
Gilles Peskine1468da72019-05-29 17:35:49 +02005370
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005371 PSA_ASSERT( psa_key_derivation_get_capacity( &operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005372 &current_capacity ) );
Gilles Peskinefe11b722018-12-18 00:24:04 +01005373 TEST_EQUAL( current_capacity, requested_capacity );
Gilles Peskine96ee5c72018-07-12 17:24:54 +02005374 expected_capacity = requested_capacity;
5375
5376 /* Expansion phase. */
5377 for( i = 0; i < ARRAY_LENGTH( expected_outputs ); i++ )
5378 {
5379 /* Read some bytes. */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005380 status = psa_key_derivation_output_bytes( &operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005381 output_buffer, output_sizes[i] );
Gilles Peskine96ee5c72018-07-12 17:24:54 +02005382 if( expected_capacity == 0 && output_sizes[i] == 0 )
5383 {
5384 /* Reading 0 bytes when 0 bytes are available can go either way. */
5385 TEST_ASSERT( status == PSA_SUCCESS ||
David Saadab4ecc272019-02-14 13:48:10 +02005386 status == PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskine96ee5c72018-07-12 17:24:54 +02005387 continue;
5388 }
5389 else if( expected_capacity == 0 ||
5390 output_sizes[i] > expected_capacity )
5391 {
5392 /* Capacity exceeded. */
David Saadab4ecc272019-02-14 13:48:10 +02005393 TEST_EQUAL( status, PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskine96ee5c72018-07-12 17:24:54 +02005394 expected_capacity = 0;
5395 continue;
5396 }
5397 /* Success. Check the read data. */
Gilles Peskine8817f612018-12-18 00:18:46 +01005398 PSA_ASSERT( status );
Gilles Peskine96ee5c72018-07-12 17:24:54 +02005399 if( output_sizes[i] != 0 )
Gilles Peskine0dfba2d2018-12-18 00:40:50 +01005400 ASSERT_COMPARE( output_buffer, output_sizes[i],
5401 expected_outputs[i], output_sizes[i] );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005402 /* Check the operation status. */
Gilles Peskine96ee5c72018-07-12 17:24:54 +02005403 expected_capacity -= output_sizes[i];
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005404 PSA_ASSERT( psa_key_derivation_get_capacity( &operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005405 &current_capacity ) );
Gilles Peskinefe11b722018-12-18 00:24:04 +01005406 TEST_EQUAL( expected_capacity, current_capacity );
Gilles Peskine96ee5c72018-07-12 17:24:54 +02005407 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005408 PSA_ASSERT( psa_key_derivation_abort( &operation ) );
Gilles Peskine96ee5c72018-07-12 17:24:54 +02005409
5410exit:
5411 mbedtls_free( output_buffer );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005412 psa_key_derivation_abort( &operation );
Ronald Cron5425a212020-08-04 14:58:35 +02005413 for( i = 0; i < ARRAY_LENGTH( keys ); i++ )
5414 psa_destroy_key( keys[i] );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02005415 PSA_DONE( );
Gilles Peskine96ee5c72018-07-12 17:24:54 +02005416}
5417/* END_CASE */
5418
5419/* BEGIN_CASE */
Gilles Peskined54931c2018-07-17 21:06:59 +02005420void derive_full( int alg_arg,
5421 data_t *key_data,
Janos Follath47f27ed2019-06-25 13:24:52 +01005422 data_t *input1,
5423 data_t *input2,
Gilles Peskined54931c2018-07-17 21:06:59 +02005424 int requested_capacity_arg )
5425{
Ronald Cron5425a212020-08-04 14:58:35 +02005426 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined54931c2018-07-17 21:06:59 +02005427 psa_algorithm_t alg = alg_arg;
5428 size_t requested_capacity = requested_capacity_arg;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005429 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Gilles Peskined54931c2018-07-17 21:06:59 +02005430 unsigned char output_buffer[16];
5431 size_t expected_capacity = requested_capacity;
5432 size_t current_capacity;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005433 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskined54931c2018-07-17 21:06:59 +02005434
Gilles Peskine8817f612018-12-18 00:18:46 +01005435 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskined54931c2018-07-17 21:06:59 +02005436
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005437 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DERIVE );
5438 psa_set_key_algorithm( &attributes, alg );
5439 psa_set_key_type( &attributes, PSA_KEY_TYPE_DERIVE );
Gilles Peskined54931c2018-07-17 21:06:59 +02005440
Gilles Peskine049c7532019-05-15 20:22:09 +02005441 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02005442 &key ) );
Gilles Peskined54931c2018-07-17 21:06:59 +02005443
Gilles Peskinec18e25f2021-02-12 23:48:20 +01005444 if( !mbedtls_test_psa_setup_key_derivation_wrap( &operation, key, alg,
5445 input1->x, input1->len,
5446 input2->x, input2->len,
5447 requested_capacity ) )
Janos Follathf2815ea2019-07-03 12:41:36 +01005448 goto exit;
Janos Follath47f27ed2019-06-25 13:24:52 +01005449
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005450 PSA_ASSERT( psa_key_derivation_get_capacity( &operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005451 &current_capacity ) );
Gilles Peskinefe11b722018-12-18 00:24:04 +01005452 TEST_EQUAL( current_capacity, expected_capacity );
Gilles Peskined54931c2018-07-17 21:06:59 +02005453
5454 /* Expansion phase. */
5455 while( current_capacity > 0 )
5456 {
5457 size_t read_size = sizeof( output_buffer );
5458 if( read_size > current_capacity )
5459 read_size = current_capacity;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005460 PSA_ASSERT( psa_key_derivation_output_bytes( &operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005461 output_buffer,
5462 read_size ) );
Gilles Peskined54931c2018-07-17 21:06:59 +02005463 expected_capacity -= read_size;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005464 PSA_ASSERT( psa_key_derivation_get_capacity( &operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005465 &current_capacity ) );
Gilles Peskinefe11b722018-12-18 00:24:04 +01005466 TEST_EQUAL( current_capacity, expected_capacity );
Gilles Peskined54931c2018-07-17 21:06:59 +02005467 }
5468
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005469 /* Check that the operation refuses to go over capacity. */
5470 TEST_EQUAL( psa_key_derivation_output_bytes( &operation, output_buffer, 1 ),
David Saadab4ecc272019-02-14 13:48:10 +02005471 PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskined54931c2018-07-17 21:06:59 +02005472
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005473 PSA_ASSERT( psa_key_derivation_abort( &operation ) );
Gilles Peskined54931c2018-07-17 21:06:59 +02005474
5475exit:
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005476 psa_key_derivation_abort( &operation );
Ronald Cron5425a212020-08-04 14:58:35 +02005477 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02005478 PSA_DONE( );
Gilles Peskined54931c2018-07-17 21:06:59 +02005479}
5480/* END_CASE */
5481
Janos Follathe60c9052019-07-03 13:51:30 +01005482/* BEGIN_CASE */
Gilles Peskine0386fba2018-07-12 17:29:22 +02005483void derive_key_exercise( int alg_arg,
5484 data_t *key_data,
Janos Follathe60c9052019-07-03 13:51:30 +01005485 data_t *input1,
5486 data_t *input2,
Gilles Peskine0386fba2018-07-12 17:29:22 +02005487 int derived_type_arg,
5488 int derived_bits_arg,
5489 int derived_usage_arg,
5490 int derived_alg_arg )
5491{
Ronald Cron5425a212020-08-04 14:58:35 +02005492 mbedtls_svc_key_id_t base_key = MBEDTLS_SVC_KEY_ID_INIT;
5493 mbedtls_svc_key_id_t derived_key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine0386fba2018-07-12 17:29:22 +02005494 psa_algorithm_t alg = alg_arg;
5495 psa_key_type_t derived_type = derived_type_arg;
5496 size_t derived_bits = derived_bits_arg;
5497 psa_key_usage_t derived_usage = derived_usage_arg;
5498 psa_algorithm_t derived_alg = derived_alg_arg;
5499 size_t capacity = PSA_BITS_TO_BYTES( derived_bits );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005500 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005501 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02005502 psa_key_attributes_t got_attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine0386fba2018-07-12 17:29:22 +02005503
Gilles Peskine8817f612018-12-18 00:18:46 +01005504 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine0386fba2018-07-12 17:29:22 +02005505
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005506 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DERIVE );
5507 psa_set_key_algorithm( &attributes, alg );
5508 psa_set_key_type( &attributes, PSA_KEY_TYPE_DERIVE );
Gilles Peskine049c7532019-05-15 20:22:09 +02005509 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02005510 &base_key ) );
Gilles Peskine0386fba2018-07-12 17:29:22 +02005511
5512 /* Derive a key. */
Gilles Peskinec18e25f2021-02-12 23:48:20 +01005513 if ( mbedtls_test_psa_setup_key_derivation_wrap( &operation, base_key, alg,
5514 input1->x, input1->len,
5515 input2->x, input2->len,
5516 capacity ) )
Janos Follathe60c9052019-07-03 13:51:30 +01005517 goto exit;
5518
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005519 psa_set_key_usage_flags( &attributes, derived_usage );
5520 psa_set_key_algorithm( &attributes, derived_alg );
5521 psa_set_key_type( &attributes, derived_type );
Gilles Peskine3a4f1f82019-04-26 13:49:28 +02005522 psa_set_key_bits( &attributes, derived_bits );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005523 PSA_ASSERT( psa_key_derivation_output_key( &attributes, &operation,
Ronald Cron5425a212020-08-04 14:58:35 +02005524 &derived_key ) );
Gilles Peskine0386fba2018-07-12 17:29:22 +02005525
5526 /* Test the key information */
Ronald Cron5425a212020-08-04 14:58:35 +02005527 PSA_ASSERT( psa_get_key_attributes( derived_key, &got_attributes ) );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02005528 TEST_EQUAL( psa_get_key_type( &got_attributes ), derived_type );
5529 TEST_EQUAL( psa_get_key_bits( &got_attributes ), derived_bits );
Gilles Peskine0386fba2018-07-12 17:29:22 +02005530
5531 /* Exercise the derived key. */
Gilles Peskinec18e25f2021-02-12 23:48:20 +01005532 if( ! mbedtls_test_psa_exercise_key( derived_key, derived_usage, derived_alg ) )
Gilles Peskine0386fba2018-07-12 17:29:22 +02005533 goto exit;
5534
5535exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +01005536 /*
5537 * Key attributes may have been returned by psa_get_key_attributes()
5538 * thus reset them as required.
5539 */
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02005540 psa_reset_key_attributes( &got_attributes );
Ronald Cron3a4f0e32020-11-19 17:55:23 +01005541
5542 psa_key_derivation_abort( &operation );
Ronald Cron5425a212020-08-04 14:58:35 +02005543 psa_destroy_key( base_key );
5544 psa_destroy_key( derived_key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02005545 PSA_DONE( );
Gilles Peskine0386fba2018-07-12 17:29:22 +02005546}
5547/* END_CASE */
5548
Janos Follath42fd8882019-07-03 14:17:09 +01005549/* BEGIN_CASE */
Gilles Peskine0386fba2018-07-12 17:29:22 +02005550void derive_key_export( int alg_arg,
5551 data_t *key_data,
Janos Follath42fd8882019-07-03 14:17:09 +01005552 data_t *input1,
5553 data_t *input2,
Gilles Peskine0386fba2018-07-12 17:29:22 +02005554 int bytes1_arg,
5555 int bytes2_arg )
5556{
Ronald Cron5425a212020-08-04 14:58:35 +02005557 mbedtls_svc_key_id_t base_key = MBEDTLS_SVC_KEY_ID_INIT;
5558 mbedtls_svc_key_id_t derived_key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine0386fba2018-07-12 17:29:22 +02005559 psa_algorithm_t alg = alg_arg;
5560 size_t bytes1 = bytes1_arg;
5561 size_t bytes2 = bytes2_arg;
5562 size_t capacity = bytes1 + bytes2;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005563 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Gilles Peskine8cebbba2018-09-27 13:54:18 +02005564 uint8_t *output_buffer = NULL;
5565 uint8_t *export_buffer = NULL;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005566 psa_key_attributes_t base_attributes = PSA_KEY_ATTRIBUTES_INIT;
5567 psa_key_attributes_t derived_attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine0386fba2018-07-12 17:29:22 +02005568 size_t length;
5569
Gilles Peskine8cebbba2018-09-27 13:54:18 +02005570 ASSERT_ALLOC( output_buffer, capacity );
5571 ASSERT_ALLOC( export_buffer, capacity );
Gilles Peskine8817f612018-12-18 00:18:46 +01005572 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine0386fba2018-07-12 17:29:22 +02005573
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005574 psa_set_key_usage_flags( &base_attributes, PSA_KEY_USAGE_DERIVE );
5575 psa_set_key_algorithm( &base_attributes, alg );
5576 psa_set_key_type( &base_attributes, PSA_KEY_TYPE_DERIVE );
Gilles Peskine049c7532019-05-15 20:22:09 +02005577 PSA_ASSERT( psa_import_key( &base_attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02005578 &base_key ) );
Gilles Peskine0386fba2018-07-12 17:29:22 +02005579
5580 /* Derive some material and output it. */
Gilles Peskinec18e25f2021-02-12 23:48:20 +01005581 if( !mbedtls_test_psa_setup_key_derivation_wrap( &operation, base_key, alg,
5582 input1->x, input1->len,
5583 input2->x, input2->len,
5584 capacity ) )
Janos Follath42fd8882019-07-03 14:17:09 +01005585 goto exit;
5586
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005587 PSA_ASSERT( psa_key_derivation_output_bytes( &operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005588 output_buffer,
5589 capacity ) );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005590 PSA_ASSERT( psa_key_derivation_abort( &operation ) );
Gilles Peskine0386fba2018-07-12 17:29:22 +02005591
5592 /* Derive the same output again, but this time store it in key objects. */
Gilles Peskinec18e25f2021-02-12 23:48:20 +01005593 if( !mbedtls_test_psa_setup_key_derivation_wrap( &operation, base_key, alg,
5594 input1->x, input1->len,
5595 input2->x, input2->len,
5596 capacity ) )
Janos Follath42fd8882019-07-03 14:17:09 +01005597 goto exit;
5598
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005599 psa_set_key_usage_flags( &derived_attributes, PSA_KEY_USAGE_EXPORT );
5600 psa_set_key_algorithm( &derived_attributes, 0 );
5601 psa_set_key_type( &derived_attributes, PSA_KEY_TYPE_RAW_DATA );
Gilles Peskine3a4f1f82019-04-26 13:49:28 +02005602 psa_set_key_bits( &derived_attributes, PSA_BYTES_TO_BITS( bytes1 ) );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005603 PSA_ASSERT( psa_key_derivation_output_key( &derived_attributes, &operation,
Ronald Cron5425a212020-08-04 14:58:35 +02005604 &derived_key ) );
5605 PSA_ASSERT( psa_export_key( derived_key,
Gilles Peskine8817f612018-12-18 00:18:46 +01005606 export_buffer, bytes1,
5607 &length ) );
Gilles Peskinefe11b722018-12-18 00:24:04 +01005608 TEST_EQUAL( length, bytes1 );
Ronald Cron5425a212020-08-04 14:58:35 +02005609 PSA_ASSERT( psa_destroy_key( derived_key ) );
Gilles Peskine3a4f1f82019-04-26 13:49:28 +02005610 psa_set_key_bits( &derived_attributes, PSA_BYTES_TO_BITS( bytes2 ) );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005611 PSA_ASSERT( psa_key_derivation_output_key( &derived_attributes, &operation,
Ronald Cron5425a212020-08-04 14:58:35 +02005612 &derived_key ) );
5613 PSA_ASSERT( psa_export_key( derived_key,
Gilles Peskine8817f612018-12-18 00:18:46 +01005614 export_buffer + bytes1, bytes2,
5615 &length ) );
Gilles Peskinefe11b722018-12-18 00:24:04 +01005616 TEST_EQUAL( length, bytes2 );
Gilles Peskine0386fba2018-07-12 17:29:22 +02005617
5618 /* Compare the outputs from the two runs. */
Gilles Peskine0dfba2d2018-12-18 00:40:50 +01005619 ASSERT_COMPARE( output_buffer, bytes1 + bytes2,
5620 export_buffer, capacity );
Gilles Peskine0386fba2018-07-12 17:29:22 +02005621
5622exit:
5623 mbedtls_free( output_buffer );
5624 mbedtls_free( export_buffer );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005625 psa_key_derivation_abort( &operation );
Ronald Cron5425a212020-08-04 14:58:35 +02005626 psa_destroy_key( base_key );
5627 psa_destroy_key( derived_key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02005628 PSA_DONE( );
Gilles Peskine0386fba2018-07-12 17:29:22 +02005629}
5630/* END_CASE */
5631
5632/* BEGIN_CASE */
Gilles Peskine7c227ae2019-07-31 15:14:44 +02005633void derive_key( int alg_arg,
5634 data_t *key_data, data_t *input1, data_t *input2,
5635 int type_arg, int bits_arg,
Steven Cooreman83fdb702021-01-21 14:24:39 +01005636 int expected_status_arg,
5637 int is_large_output )
Gilles Peskinec744d992019-07-30 17:26:54 +02005638{
Ronald Cron5425a212020-08-04 14:58:35 +02005639 mbedtls_svc_key_id_t base_key = MBEDTLS_SVC_KEY_ID_INIT;
5640 mbedtls_svc_key_id_t derived_key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskinec744d992019-07-30 17:26:54 +02005641 psa_algorithm_t alg = alg_arg;
Gilles Peskine7c227ae2019-07-31 15:14:44 +02005642 psa_key_type_t type = type_arg;
Gilles Peskinec744d992019-07-30 17:26:54 +02005643 size_t bits = bits_arg;
5644 psa_status_t expected_status = expected_status_arg;
5645 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
5646 psa_key_attributes_t base_attributes = PSA_KEY_ATTRIBUTES_INIT;
5647 psa_key_attributes_t derived_attributes = PSA_KEY_ATTRIBUTES_INIT;
5648
5649 PSA_ASSERT( psa_crypto_init( ) );
5650
5651 psa_set_key_usage_flags( &base_attributes, PSA_KEY_USAGE_DERIVE );
5652 psa_set_key_algorithm( &base_attributes, alg );
5653 psa_set_key_type( &base_attributes, PSA_KEY_TYPE_DERIVE );
5654 PSA_ASSERT( psa_import_key( &base_attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02005655 &base_key ) );
Gilles Peskinec744d992019-07-30 17:26:54 +02005656
Gilles Peskinec18e25f2021-02-12 23:48:20 +01005657 if( !mbedtls_test_psa_setup_key_derivation_wrap( &operation, base_key, alg,
5658 input1->x, input1->len,
5659 input2->x, input2->len,
5660 SIZE_MAX ) )
Gilles Peskinec744d992019-07-30 17:26:54 +02005661 goto exit;
5662
5663 psa_set_key_usage_flags( &derived_attributes, PSA_KEY_USAGE_EXPORT );
5664 psa_set_key_algorithm( &derived_attributes, 0 );
Gilles Peskine7c227ae2019-07-31 15:14:44 +02005665 psa_set_key_type( &derived_attributes, type );
Gilles Peskinec744d992019-07-30 17:26:54 +02005666 psa_set_key_bits( &derived_attributes, bits );
Steven Cooreman83fdb702021-01-21 14:24:39 +01005667
5668 psa_status_t status =
5669 psa_key_derivation_output_key( &derived_attributes,
5670 &operation,
5671 &derived_key );
5672 if( is_large_output > 0 )
5673 TEST_ASSUME( status != PSA_ERROR_INSUFFICIENT_MEMORY );
5674 TEST_EQUAL( status, expected_status );
Gilles Peskinec744d992019-07-30 17:26:54 +02005675
5676exit:
5677 psa_key_derivation_abort( &operation );
Ronald Cron5425a212020-08-04 14:58:35 +02005678 psa_destroy_key( base_key );
5679 psa_destroy_key( derived_key );
Gilles Peskinec744d992019-07-30 17:26:54 +02005680 PSA_DONE( );
5681}
5682/* END_CASE */
5683
5684/* BEGIN_CASE */
Gilles Peskine01d718c2018-09-18 12:01:02 +02005685void key_agreement_setup( int alg_arg,
Steven Cooremance48e852020-10-05 16:02:45 +02005686 int our_key_type_arg, int our_key_alg_arg,
5687 data_t *our_key_data, data_t *peer_key_data,
Gilles Peskine01d718c2018-09-18 12:01:02 +02005688 int expected_status_arg )
5689{
Ronald Cron5425a212020-08-04 14:58:35 +02005690 mbedtls_svc_key_id_t our_key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine01d718c2018-09-18 12:01:02 +02005691 psa_algorithm_t alg = alg_arg;
Steven Cooremanfa5e6312020-10-15 17:07:12 +02005692 psa_algorithm_t our_key_alg = our_key_alg_arg;
Gilles Peskine01d718c2018-09-18 12:01:02 +02005693 psa_key_type_t our_key_type = our_key_type_arg;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005694 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005695 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine77f40d82019-04-11 21:27:06 +02005696 psa_status_t expected_status = expected_status_arg;
5697 psa_status_t status;
Gilles Peskine01d718c2018-09-18 12:01:02 +02005698
Gilles Peskine8817f612018-12-18 00:18:46 +01005699 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005700
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005701 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DERIVE );
Steven Cooremanfa5e6312020-10-15 17:07:12 +02005702 psa_set_key_algorithm( &attributes, our_key_alg );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005703 psa_set_key_type( &attributes, our_key_type );
Gilles Peskine049c7532019-05-15 20:22:09 +02005704 PSA_ASSERT( psa_import_key( &attributes,
5705 our_key_data->x, our_key_data->len,
5706 &our_key ) );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005707
Gilles Peskine77f40d82019-04-11 21:27:06 +02005708 /* The tests currently include inputs that should fail at either step.
5709 * Test cases that fail at the setup step should be changed to call
5710 * key_derivation_setup instead, and this function should be renamed
5711 * to key_agreement_fail. */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005712 status = psa_key_derivation_setup( &operation, alg );
Gilles Peskine77f40d82019-04-11 21:27:06 +02005713 if( status == PSA_SUCCESS )
5714 {
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005715 TEST_EQUAL( psa_key_derivation_key_agreement(
5716 &operation, PSA_KEY_DERIVATION_INPUT_SECRET,
5717 our_key,
5718 peer_key_data->x, peer_key_data->len ),
Gilles Peskine77f40d82019-04-11 21:27:06 +02005719 expected_status );
5720 }
5721 else
5722 {
5723 TEST_ASSERT( status == expected_status );
5724 }
Gilles Peskine01d718c2018-09-18 12:01:02 +02005725
5726exit:
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005727 psa_key_derivation_abort( &operation );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005728 psa_destroy_key( our_key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02005729 PSA_DONE( );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005730}
5731/* END_CASE */
5732
5733/* BEGIN_CASE */
Gilles Peskinef0cba732019-04-11 22:12:38 +02005734void raw_key_agreement( int alg_arg,
5735 int our_key_type_arg, data_t *our_key_data,
5736 data_t *peer_key_data,
5737 data_t *expected_output )
5738{
Ronald Cron5425a212020-08-04 14:58:35 +02005739 mbedtls_svc_key_id_t our_key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskinef0cba732019-04-11 22:12:38 +02005740 psa_algorithm_t alg = alg_arg;
5741 psa_key_type_t our_key_type = our_key_type_arg;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005742 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskinef0cba732019-04-11 22:12:38 +02005743 unsigned char *output = NULL;
5744 size_t output_length = ~0;
gabor-mezei-armceface22021-01-21 12:26:17 +01005745 size_t key_bits;
Gilles Peskinef0cba732019-04-11 22:12:38 +02005746
5747 ASSERT_ALLOC( output, expected_output->len );
5748 PSA_ASSERT( psa_crypto_init( ) );
5749
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005750 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DERIVE );
5751 psa_set_key_algorithm( &attributes, alg );
5752 psa_set_key_type( &attributes, our_key_type );
Gilles Peskine049c7532019-05-15 20:22:09 +02005753 PSA_ASSERT( psa_import_key( &attributes,
5754 our_key_data->x, our_key_data->len,
5755 &our_key ) );
Gilles Peskinef0cba732019-04-11 22:12:38 +02005756
gabor-mezei-armceface22021-01-21 12:26:17 +01005757 PSA_ASSERT( psa_get_key_attributes( our_key, &attributes ) );
5758 key_bits = psa_get_key_bits( &attributes );
5759
Gilles Peskinebe697d82019-05-16 18:00:41 +02005760 PSA_ASSERT( psa_raw_key_agreement( alg, our_key,
5761 peer_key_data->x, peer_key_data->len,
5762 output, expected_output->len,
5763 &output_length ) );
Gilles Peskinef0cba732019-04-11 22:12:38 +02005764 ASSERT_COMPARE( output, output_length,
5765 expected_output->x, expected_output->len );
gabor-mezei-armceface22021-01-21 12:26:17 +01005766 TEST_ASSERT( output_length <=
5767 PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE( our_key_type, key_bits ) );
5768 TEST_ASSERT( output_length <=
5769 PSA_RAW_KEY_AGREEMENT_OUTPUT_MAX_SIZE );
Gilles Peskinef0cba732019-04-11 22:12:38 +02005770
5771exit:
5772 mbedtls_free( output );
5773 psa_destroy_key( our_key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02005774 PSA_DONE( );
Gilles Peskinef0cba732019-04-11 22:12:38 +02005775}
5776/* END_CASE */
5777
5778/* BEGIN_CASE */
Gilles Peskine59685592018-09-18 12:11:34 +02005779void key_agreement_capacity( int alg_arg,
5780 int our_key_type_arg, data_t *our_key_data,
5781 data_t *peer_key_data,
5782 int expected_capacity_arg )
5783{
Ronald Cron5425a212020-08-04 14:58:35 +02005784 mbedtls_svc_key_id_t our_key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine59685592018-09-18 12:11:34 +02005785 psa_algorithm_t alg = alg_arg;
5786 psa_key_type_t our_key_type = our_key_type_arg;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005787 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005788 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine59685592018-09-18 12:11:34 +02005789 size_t actual_capacity;
Gilles Peskinebf491972018-10-25 22:36:12 +02005790 unsigned char output[16];
Gilles Peskine59685592018-09-18 12:11:34 +02005791
Gilles Peskine8817f612018-12-18 00:18:46 +01005792 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine59685592018-09-18 12:11:34 +02005793
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005794 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DERIVE );
5795 psa_set_key_algorithm( &attributes, alg );
5796 psa_set_key_type( &attributes, our_key_type );
Gilles Peskine049c7532019-05-15 20:22:09 +02005797 PSA_ASSERT( psa_import_key( &attributes,
5798 our_key_data->x, our_key_data->len,
5799 &our_key ) );
Gilles Peskine59685592018-09-18 12:11:34 +02005800
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005801 PSA_ASSERT( psa_key_derivation_setup( &operation, alg ) );
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005802 PSA_ASSERT( psa_key_derivation_key_agreement(
5803 &operation,
5804 PSA_KEY_DERIVATION_INPUT_SECRET, our_key,
5805 peer_key_data->x, peer_key_data->len ) );
Gilles Peskinef8a9d942019-04-11 22:13:20 +02005806 if( PSA_ALG_IS_HKDF( PSA_ALG_KEY_AGREEMENT_GET_KDF( alg ) ) )
5807 {
5808 /* The test data is for info="" */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005809 PSA_ASSERT( psa_key_derivation_input_bytes( &operation,
Gilles Peskine03410b52019-05-16 16:05:19 +02005810 PSA_KEY_DERIVATION_INPUT_INFO,
Gilles Peskinef8a9d942019-04-11 22:13:20 +02005811 NULL, 0 ) );
5812 }
Gilles Peskine59685592018-09-18 12:11:34 +02005813
Gilles Peskinebf491972018-10-25 22:36:12 +02005814 /* Test the advertized capacity. */
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005815 PSA_ASSERT( psa_key_derivation_get_capacity(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005816 &operation, &actual_capacity ) );
Gilles Peskinefe11b722018-12-18 00:24:04 +01005817 TEST_EQUAL( actual_capacity, (size_t) expected_capacity_arg );
Gilles Peskine59685592018-09-18 12:11:34 +02005818
Gilles Peskinebf491972018-10-25 22:36:12 +02005819 /* Test the actual capacity by reading the output. */
5820 while( actual_capacity > sizeof( output ) )
5821 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005822 PSA_ASSERT( psa_key_derivation_output_bytes( &operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005823 output, sizeof( output ) ) );
Gilles Peskinebf491972018-10-25 22:36:12 +02005824 actual_capacity -= sizeof( output );
5825 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005826 PSA_ASSERT( psa_key_derivation_output_bytes( &operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005827 output, actual_capacity ) );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005828 TEST_EQUAL( psa_key_derivation_output_bytes( &operation, output, 1 ),
David Saadab4ecc272019-02-14 13:48:10 +02005829 PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskinebf491972018-10-25 22:36:12 +02005830
Gilles Peskine59685592018-09-18 12:11:34 +02005831exit:
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005832 psa_key_derivation_abort( &operation );
Gilles Peskine59685592018-09-18 12:11:34 +02005833 psa_destroy_key( our_key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02005834 PSA_DONE( );
Gilles Peskine59685592018-09-18 12:11:34 +02005835}
5836/* END_CASE */
5837
5838/* BEGIN_CASE */
5839void key_agreement_output( int alg_arg,
5840 int our_key_type_arg, data_t *our_key_data,
5841 data_t *peer_key_data,
Gilles Peskine3ec8ed82018-10-25 22:37:15 +02005842 data_t *expected_output1, data_t *expected_output2 )
Gilles Peskine59685592018-09-18 12:11:34 +02005843{
Ronald Cron5425a212020-08-04 14:58:35 +02005844 mbedtls_svc_key_id_t our_key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine59685592018-09-18 12:11:34 +02005845 psa_algorithm_t alg = alg_arg;
5846 psa_key_type_t our_key_type = our_key_type_arg;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005847 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005848 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine3ec8ed82018-10-25 22:37:15 +02005849 uint8_t *actual_output = NULL;
Gilles Peskine59685592018-09-18 12:11:34 +02005850
Gilles Peskine3ec8ed82018-10-25 22:37:15 +02005851 ASSERT_ALLOC( actual_output, MAX( expected_output1->len,
5852 expected_output2->len ) );
Gilles Peskine59685592018-09-18 12:11:34 +02005853
Gilles Peskine8817f612018-12-18 00:18:46 +01005854 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine59685592018-09-18 12:11:34 +02005855
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005856 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DERIVE );
5857 psa_set_key_algorithm( &attributes, alg );
5858 psa_set_key_type( &attributes, our_key_type );
Gilles Peskine049c7532019-05-15 20:22:09 +02005859 PSA_ASSERT( psa_import_key( &attributes,
5860 our_key_data->x, our_key_data->len,
5861 &our_key ) );
Gilles Peskine59685592018-09-18 12:11:34 +02005862
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005863 PSA_ASSERT( psa_key_derivation_setup( &operation, alg ) );
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005864 PSA_ASSERT( psa_key_derivation_key_agreement(
5865 &operation,
5866 PSA_KEY_DERIVATION_INPUT_SECRET, our_key,
5867 peer_key_data->x, peer_key_data->len ) );
Gilles Peskinef8a9d942019-04-11 22:13:20 +02005868 if( PSA_ALG_IS_HKDF( PSA_ALG_KEY_AGREEMENT_GET_KDF( alg ) ) )
5869 {
5870 /* The test data is for info="" */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005871 PSA_ASSERT( psa_key_derivation_input_bytes( &operation,
Gilles Peskine03410b52019-05-16 16:05:19 +02005872 PSA_KEY_DERIVATION_INPUT_INFO,
Gilles Peskinef8a9d942019-04-11 22:13:20 +02005873 NULL, 0 ) );
5874 }
Gilles Peskine59685592018-09-18 12:11:34 +02005875
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005876 PSA_ASSERT( psa_key_derivation_output_bytes( &operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005877 actual_output,
5878 expected_output1->len ) );
Gilles Peskine0dfba2d2018-12-18 00:40:50 +01005879 ASSERT_COMPARE( actual_output, expected_output1->len,
5880 expected_output1->x, expected_output1->len );
Gilles Peskine3ec8ed82018-10-25 22:37:15 +02005881 if( expected_output2->len != 0 )
5882 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005883 PSA_ASSERT( psa_key_derivation_output_bytes( &operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005884 actual_output,
5885 expected_output2->len ) );
Gilles Peskine0dfba2d2018-12-18 00:40:50 +01005886 ASSERT_COMPARE( actual_output, expected_output2->len,
5887 expected_output2->x, expected_output2->len );
Gilles Peskine3ec8ed82018-10-25 22:37:15 +02005888 }
Gilles Peskine59685592018-09-18 12:11:34 +02005889
5890exit:
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005891 psa_key_derivation_abort( &operation );
Gilles Peskine59685592018-09-18 12:11:34 +02005892 psa_destroy_key( our_key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02005893 PSA_DONE( );
Gilles Peskine59685592018-09-18 12:11:34 +02005894 mbedtls_free( actual_output );
5895}
5896/* END_CASE */
5897
5898/* BEGIN_CASE */
Gilles Peskinea50d7392018-06-21 10:22:13 +02005899void generate_random( int bytes_arg )
Gilles Peskine05d69892018-06-19 22:00:52 +02005900{
Gilles Peskinea50d7392018-06-21 10:22:13 +02005901 size_t bytes = bytes_arg;
Gilles Peskine8cebbba2018-09-27 13:54:18 +02005902 unsigned char *output = NULL;
5903 unsigned char *changed = NULL;
Gilles Peskinea50d7392018-06-21 10:22:13 +02005904 size_t i;
5905 unsigned run;
Gilles Peskine05d69892018-06-19 22:00:52 +02005906
Simon Butcher49f8e312020-03-03 15:51:50 +00005907 TEST_ASSERT( bytes_arg >= 0 );
5908
Gilles Peskine91892022021-02-08 19:50:26 +01005909 ASSERT_ALLOC( output, bytes );
Gilles Peskine8cebbba2018-09-27 13:54:18 +02005910 ASSERT_ALLOC( changed, bytes );
Gilles Peskine05d69892018-06-19 22:00:52 +02005911
Gilles Peskine8817f612018-12-18 00:18:46 +01005912 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine05d69892018-06-19 22:00:52 +02005913
Gilles Peskinea50d7392018-06-21 10:22:13 +02005914 /* Run several times, to ensure that every output byte will be
5915 * nonzero at least once with overwhelming probability
5916 * (2^(-8*number_of_runs)). */
5917 for( run = 0; run < 10; run++ )
Gilles Peskine05d69892018-06-19 22:00:52 +02005918 {
Gilles Peskinef7ab5ad2018-09-26 18:19:24 +02005919 if( bytes != 0 )
5920 memset( output, 0, bytes );
Gilles Peskine8817f612018-12-18 00:18:46 +01005921 PSA_ASSERT( psa_generate_random( output, bytes ) );
Gilles Peskinea50d7392018-06-21 10:22:13 +02005922
Gilles Peskinea50d7392018-06-21 10:22:13 +02005923 for( i = 0; i < bytes; i++ )
5924 {
5925 if( output[i] != 0 )
5926 ++changed[i];
5927 }
Gilles Peskine05d69892018-06-19 22:00:52 +02005928 }
Gilles Peskinea50d7392018-06-21 10:22:13 +02005929
5930 /* Check that every byte was changed to nonzero at least once. This
5931 * validates that psa_generate_random is overwriting every byte of
5932 * the output buffer. */
5933 for( i = 0; i < bytes; i++ )
5934 {
5935 TEST_ASSERT( changed[i] != 0 );
5936 }
Gilles Peskine05d69892018-06-19 22:00:52 +02005937
5938exit:
Gilles Peskine1153e7b2019-05-28 15:10:21 +02005939 PSA_DONE( );
Gilles Peskinea50d7392018-06-21 10:22:13 +02005940 mbedtls_free( output );
5941 mbedtls_free( changed );
Gilles Peskine05d69892018-06-19 22:00:52 +02005942}
5943/* END_CASE */
Gilles Peskine12313cd2018-06-20 00:20:32 +02005944
5945/* BEGIN_CASE */
5946void generate_key( int type_arg,
5947 int bits_arg,
5948 int usage_arg,
5949 int alg_arg,
Steven Cooreman83fdb702021-01-21 14:24:39 +01005950 int expected_status_arg,
5951 int is_large_key )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005952{
Ronald Cron5425a212020-08-04 14:58:35 +02005953 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine12313cd2018-06-20 00:20:32 +02005954 psa_key_type_t type = type_arg;
5955 psa_key_usage_t usage = usage_arg;
5956 size_t bits = bits_arg;
5957 psa_algorithm_t alg = alg_arg;
5958 psa_status_t expected_status = expected_status_arg;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005959 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02005960 psa_key_attributes_t got_attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine12313cd2018-06-20 00:20:32 +02005961
Gilles Peskine8817f612018-12-18 00:18:46 +01005962 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005963
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005964 psa_set_key_usage_flags( &attributes, usage );
5965 psa_set_key_algorithm( &attributes, alg );
5966 psa_set_key_type( &attributes, type );
Gilles Peskine3a4f1f82019-04-26 13:49:28 +02005967 psa_set_key_bits( &attributes, bits );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005968
5969 /* Generate a key */
Steven Cooreman83fdb702021-01-21 14:24:39 +01005970 psa_status_t status = psa_generate_key( &attributes, &key );
5971
5972 if( is_large_key > 0 )
5973 TEST_ASSUME( status != PSA_ERROR_INSUFFICIENT_MEMORY );
5974 TEST_EQUAL( status , expected_status );
Gilles Peskinee56e8782019-04-26 17:34:02 +02005975 if( expected_status != PSA_SUCCESS )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005976 goto exit;
Gilles Peskine12313cd2018-06-20 00:20:32 +02005977
5978 /* Test the key information */
Ronald Cron5425a212020-08-04 14:58:35 +02005979 PSA_ASSERT( psa_get_key_attributes( key, &got_attributes ) );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02005980 TEST_EQUAL( psa_get_key_type( &got_attributes ), type );
5981 TEST_EQUAL( psa_get_key_bits( &got_attributes ), bits );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005982
Gilles Peskine818ca122018-06-20 18:16:48 +02005983 /* Do something with the key according to its type and permitted usage. */
Gilles Peskinec18e25f2021-02-12 23:48:20 +01005984 if( ! mbedtls_test_psa_exercise_key( key, usage, alg ) )
Gilles Peskine02b75072018-07-01 22:31:34 +02005985 goto exit;
Gilles Peskine12313cd2018-06-20 00:20:32 +02005986
5987exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +01005988 /*
5989 * Key attributes may have been returned by psa_get_key_attributes()
5990 * thus reset them as required.
5991 */
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02005992 psa_reset_key_attributes( &got_attributes );
Ronald Cron3a4f0e32020-11-19 17:55:23 +01005993
Ronald Cron5425a212020-08-04 14:58:35 +02005994 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02005995 PSA_DONE( );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005996}
5997/* END_CASE */
itayzafrir0adf0fc2018-09-06 16:24:41 +03005998
Ronald Cronee414c72021-03-18 18:50:08 +01005999/* 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 +02006000void generate_key_rsa( int bits_arg,
6001 data_t *e_arg,
6002 int expected_status_arg )
6003{
Ronald Cron5425a212020-08-04 14:58:35 +02006004 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskinec93b80c2019-05-16 19:39:54 +02006005 psa_key_type_t type = PSA_KEY_TYPE_RSA_KEY_PAIR;
Gilles Peskinee56e8782019-04-26 17:34:02 +02006006 size_t bits = bits_arg;
6007 psa_key_usage_t usage = PSA_KEY_USAGE_ENCRYPT | PSA_KEY_USAGE_DECRYPT;
6008 psa_algorithm_t alg = PSA_ALG_RSA_PKCS1V15_SIGN_RAW;
6009 psa_status_t expected_status = expected_status_arg;
6010 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
6011 uint8_t *exported = NULL;
6012 size_t exported_size =
gabor-mezei-armcbcec212020-12-18 14:23:51 +01006013 PSA_EXPORT_KEY_OUTPUT_SIZE( PSA_KEY_TYPE_RSA_PUBLIC_KEY, bits );
Gilles Peskinee56e8782019-04-26 17:34:02 +02006014 size_t exported_length = SIZE_MAX;
6015 uint8_t *e_read_buffer = NULL;
6016 int is_default_public_exponent = 0;
Gilles Peskineaa02c172019-04-28 11:44:17 +02006017 size_t e_read_size = PSA_KEY_DOMAIN_PARAMETERS_SIZE( type, bits );
Gilles Peskinee56e8782019-04-26 17:34:02 +02006018 size_t e_read_length = SIZE_MAX;
6019
6020 if( e_arg->len == 0 ||
6021 ( e_arg->len == 3 &&
6022 e_arg->x[0] == 1 && e_arg->x[1] == 0 && e_arg->x[2] == 1 ) )
6023 {
6024 is_default_public_exponent = 1;
6025 e_read_size = 0;
6026 }
6027 ASSERT_ALLOC( e_read_buffer, e_read_size );
6028 ASSERT_ALLOC( exported, exported_size );
6029
6030 PSA_ASSERT( psa_crypto_init( ) );
6031
6032 psa_set_key_usage_flags( &attributes, usage );
6033 psa_set_key_algorithm( &attributes, alg );
6034 PSA_ASSERT( psa_set_key_domain_parameters( &attributes, type,
6035 e_arg->x, e_arg->len ) );
6036 psa_set_key_bits( &attributes, bits );
6037
6038 /* Generate a key */
Ronald Cron5425a212020-08-04 14:58:35 +02006039 TEST_EQUAL( psa_generate_key( &attributes, &key ), expected_status );
Gilles Peskinee56e8782019-04-26 17:34:02 +02006040 if( expected_status != PSA_SUCCESS )
6041 goto exit;
6042
6043 /* Test the key information */
Ronald Cron5425a212020-08-04 14:58:35 +02006044 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
Gilles Peskinee56e8782019-04-26 17:34:02 +02006045 TEST_EQUAL( psa_get_key_type( &attributes ), type );
6046 TEST_EQUAL( psa_get_key_bits( &attributes ), bits );
6047 PSA_ASSERT( psa_get_key_domain_parameters( &attributes,
6048 e_read_buffer, e_read_size,
6049 &e_read_length ) );
6050 if( is_default_public_exponent )
6051 TEST_EQUAL( e_read_length, 0 );
6052 else
6053 ASSERT_COMPARE( e_read_buffer, e_read_length, e_arg->x, e_arg->len );
6054
6055 /* Do something with the key according to its type and permitted usage. */
Gilles Peskinec18e25f2021-02-12 23:48:20 +01006056 if( ! mbedtls_test_psa_exercise_key( key, usage, alg ) )
Gilles Peskinee56e8782019-04-26 17:34:02 +02006057 goto exit;
6058
6059 /* Export the key and check the public exponent. */
Ronald Cron5425a212020-08-04 14:58:35 +02006060 PSA_ASSERT( psa_export_public_key( key,
Gilles Peskinee56e8782019-04-26 17:34:02 +02006061 exported, exported_size,
6062 &exported_length ) );
6063 {
6064 uint8_t *p = exported;
6065 uint8_t *end = exported + exported_length;
6066 size_t len;
6067 /* RSAPublicKey ::= SEQUENCE {
6068 * modulus INTEGER, -- n
6069 * publicExponent INTEGER } -- e
6070 */
6071 TEST_EQUAL( 0, mbedtls_asn1_get_tag( &p, end, &len,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02006072 MBEDTLS_ASN1_SEQUENCE |
6073 MBEDTLS_ASN1_CONSTRUCTED ) );
Gilles Peskine8e94efe2021-02-13 00:25:53 +01006074 TEST_ASSERT( mbedtls_test_asn1_skip_integer( &p, end, bits, bits, 1 ) );
Gilles Peskinee56e8782019-04-26 17:34:02 +02006075 TEST_EQUAL( 0, mbedtls_asn1_get_tag( &p, end, &len,
6076 MBEDTLS_ASN1_INTEGER ) );
6077 if( len >= 1 && p[0] == 0 )
6078 {
6079 ++p;
6080 --len;
6081 }
6082 if( e_arg->len == 0 )
6083 {
6084 TEST_EQUAL( len, 3 );
6085 TEST_EQUAL( p[0], 1 );
6086 TEST_EQUAL( p[1], 0 );
6087 TEST_EQUAL( p[2], 1 );
6088 }
6089 else
6090 ASSERT_COMPARE( p, len, e_arg->x, e_arg->len );
6091 }
6092
6093exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +01006094 /*
6095 * Key attributes may have been returned by psa_get_key_attributes() or
6096 * set by psa_set_key_domain_parameters() thus reset them as required.
6097 */
Gilles Peskinee56e8782019-04-26 17:34:02 +02006098 psa_reset_key_attributes( &attributes );
Ronald Cron3a4f0e32020-11-19 17:55:23 +01006099
Ronald Cron5425a212020-08-04 14:58:35 +02006100 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02006101 PSA_DONE( );
Gilles Peskinee56e8782019-04-26 17:34:02 +02006102 mbedtls_free( e_read_buffer );
6103 mbedtls_free( exported );
6104}
6105/* END_CASE */
6106
Darryl Greend49a4992018-06-18 17:27:26 +01006107/* BEGIN_CASE depends_on:MBEDTLS_PSA_CRYPTO_STORAGE_C */
Gilles Peskine5c648ab2019-04-19 14:06:53 +02006108void persistent_key_load_key_from_storage( data_t *data,
6109 int type_arg, int bits_arg,
6110 int usage_flags_arg, int alg_arg,
6111 int generation_method )
Darryl Greend49a4992018-06-18 17:27:26 +01006112{
Ronald Cron71016a92020-08-28 19:01:50 +02006113 mbedtls_svc_key_id_t key_id = mbedtls_svc_key_id_make( 1, 1 );
Gilles Peskine5c648ab2019-04-19 14:06:53 +02006114 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Ronald Cron5425a212020-08-04 14:58:35 +02006115 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
6116 mbedtls_svc_key_id_t base_key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine5c648ab2019-04-19 14:06:53 +02006117 psa_key_type_t type = type_arg;
6118 size_t bits = bits_arg;
6119 psa_key_usage_t usage_flags = usage_flags_arg;
6120 psa_algorithm_t alg = alg_arg;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006121 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Darryl Greend49a4992018-06-18 17:27:26 +01006122 unsigned char *first_export = NULL;
6123 unsigned char *second_export = NULL;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01006124 size_t export_size = PSA_EXPORT_KEY_OUTPUT_SIZE( type, bits );
Darryl Greend49a4992018-06-18 17:27:26 +01006125 size_t first_exported_length;
6126 size_t second_exported_length;
6127
Gilles Peskine5c648ab2019-04-19 14:06:53 +02006128 if( usage_flags & PSA_KEY_USAGE_EXPORT )
6129 {
6130 ASSERT_ALLOC( first_export, export_size );
6131 ASSERT_ALLOC( second_export, export_size );
6132 }
Darryl Greend49a4992018-06-18 17:27:26 +01006133
Gilles Peskine8817f612018-12-18 00:18:46 +01006134 PSA_ASSERT( psa_crypto_init() );
Darryl Greend49a4992018-06-18 17:27:26 +01006135
Gilles Peskinec87af662019-05-15 16:12:22 +02006136 psa_set_key_id( &attributes, key_id );
Gilles Peskine5c648ab2019-04-19 14:06:53 +02006137 psa_set_key_usage_flags( &attributes, usage_flags );
6138 psa_set_key_algorithm( &attributes, alg );
6139 psa_set_key_type( &attributes, type );
Gilles Peskine3a4f1f82019-04-26 13:49:28 +02006140 psa_set_key_bits( &attributes, bits );
Darryl Greend49a4992018-06-18 17:27:26 +01006141
Darryl Green0c6575a2018-11-07 16:05:30 +00006142 switch( generation_method )
6143 {
6144 case IMPORT_KEY:
6145 /* Import the key */
Gilles Peskine049c7532019-05-15 20:22:09 +02006146 PSA_ASSERT( psa_import_key( &attributes, data->x, data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02006147 &key ) );
Darryl Green0c6575a2018-11-07 16:05:30 +00006148 break;
Darryl Greend49a4992018-06-18 17:27:26 +01006149
Darryl Green0c6575a2018-11-07 16:05:30 +00006150 case GENERATE_KEY:
6151 /* Generate a key */
Ronald Cron5425a212020-08-04 14:58:35 +02006152 PSA_ASSERT( psa_generate_key( &attributes, &key ) );
Darryl Green0c6575a2018-11-07 16:05:30 +00006153 break;
6154
6155 case DERIVE_KEY:
Steven Cooreman70f654a2021-02-15 10:51:43 +01006156#if defined(PSA_WANT_ALG_HKDF) && defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine5c648ab2019-04-19 14:06:53 +02006157 {
6158 /* Create base key */
6159 psa_algorithm_t derive_alg = PSA_ALG_HKDF( PSA_ALG_SHA_256 );
6160 psa_key_attributes_t base_attributes = PSA_KEY_ATTRIBUTES_INIT;
6161 psa_set_key_usage_flags( &base_attributes,
6162 PSA_KEY_USAGE_DERIVE );
6163 psa_set_key_algorithm( &base_attributes, derive_alg );
6164 psa_set_key_type( &base_attributes, PSA_KEY_TYPE_DERIVE );
Gilles Peskine049c7532019-05-15 20:22:09 +02006165 PSA_ASSERT( psa_import_key( &base_attributes,
6166 data->x, data->len,
6167 &base_key ) );
Gilles Peskine5c648ab2019-04-19 14:06:53 +02006168 /* Derive a key. */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006169 PSA_ASSERT( psa_key_derivation_setup( &operation, derive_alg ) );
Gilles Peskinecf7292e2019-05-16 17:53:40 +02006170 PSA_ASSERT( psa_key_derivation_input_key(
6171 &operation,
6172 PSA_KEY_DERIVATION_INPUT_SECRET, base_key ) );
Gilles Peskine5c648ab2019-04-19 14:06:53 +02006173 PSA_ASSERT( psa_key_derivation_input_bytes(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006174 &operation, PSA_KEY_DERIVATION_INPUT_INFO,
Gilles Peskine5c648ab2019-04-19 14:06:53 +02006175 NULL, 0 ) );
Gilles Peskinecf7292e2019-05-16 17:53:40 +02006176 PSA_ASSERT( psa_key_derivation_output_key( &attributes,
6177 &operation,
Ronald Cron5425a212020-08-04 14:58:35 +02006178 &key ) );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006179 PSA_ASSERT( psa_key_derivation_abort( &operation ) );
Gilles Peskine5c648ab2019-04-19 14:06:53 +02006180 PSA_ASSERT( psa_destroy_key( base_key ) );
Ronald Cron5425a212020-08-04 14:58:35 +02006181 base_key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine5c648ab2019-04-19 14:06:53 +02006182 }
Gilles Peskine6fea21d2021-01-12 00:02:15 +01006183#else
6184 TEST_ASSUME( ! "KDF not supported in this configuration" );
6185#endif
6186 break;
6187
6188 default:
6189 TEST_ASSERT( ! "generation_method not implemented in test" );
6190 break;
Darryl Green0c6575a2018-11-07 16:05:30 +00006191 }
Gilles Peskine5c648ab2019-04-19 14:06:53 +02006192 psa_reset_key_attributes( &attributes );
Darryl Greend49a4992018-06-18 17:27:26 +01006193
Gilles Peskine5c648ab2019-04-19 14:06:53 +02006194 /* Export the key if permitted by the key policy. */
6195 if( usage_flags & PSA_KEY_USAGE_EXPORT )
6196 {
Ronald Cron5425a212020-08-04 14:58:35 +02006197 PSA_ASSERT( psa_export_key( key,
Gilles Peskine5c648ab2019-04-19 14:06:53 +02006198 first_export, export_size,
6199 &first_exported_length ) );
6200 if( generation_method == IMPORT_KEY )
6201 ASSERT_COMPARE( data->x, data->len,
6202 first_export, first_exported_length );
6203 }
Darryl Greend49a4992018-06-18 17:27:26 +01006204
6205 /* Shutdown and restart */
Ronald Cron5425a212020-08-04 14:58:35 +02006206 PSA_ASSERT( psa_purge_key( key ) );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02006207 PSA_DONE();
Gilles Peskine8817f612018-12-18 00:18:46 +01006208 PSA_ASSERT( psa_crypto_init() );
Darryl Greend49a4992018-06-18 17:27:26 +01006209
Darryl Greend49a4992018-06-18 17:27:26 +01006210 /* Check key slot still contains key data */
Ronald Cron5425a212020-08-04 14:58:35 +02006211 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
Ronald Cronecfb2372020-07-23 17:13:42 +02006212 TEST_ASSERT( mbedtls_svc_key_id_equal(
6213 psa_get_key_id( &attributes ), key_id ) );
Gilles Peskine5c648ab2019-04-19 14:06:53 +02006214 TEST_EQUAL( psa_get_key_lifetime( &attributes ),
6215 PSA_KEY_LIFETIME_PERSISTENT );
6216 TEST_EQUAL( psa_get_key_type( &attributes ), type );
6217 TEST_EQUAL( psa_get_key_bits( &attributes ), bits );
6218 TEST_EQUAL( psa_get_key_usage_flags( &attributes ), usage_flags );
6219 TEST_EQUAL( psa_get_key_algorithm( &attributes ), alg );
Darryl Greend49a4992018-06-18 17:27:26 +01006220
Gilles Peskine5c648ab2019-04-19 14:06:53 +02006221 /* Export the key again if permitted by the key policy. */
6222 if( usage_flags & PSA_KEY_USAGE_EXPORT )
Darryl Green0c6575a2018-11-07 16:05:30 +00006223 {
Ronald Cron5425a212020-08-04 14:58:35 +02006224 PSA_ASSERT( psa_export_key( key,
Gilles Peskine5c648ab2019-04-19 14:06:53 +02006225 second_export, export_size,
6226 &second_exported_length ) );
Darryl Green0c6575a2018-11-07 16:05:30 +00006227 ASSERT_COMPARE( first_export, first_exported_length,
6228 second_export, second_exported_length );
Darryl Green0c6575a2018-11-07 16:05:30 +00006229 }
6230
6231 /* Do something with the key according to its type and permitted usage. */
Gilles Peskinec18e25f2021-02-12 23:48:20 +01006232 if( ! mbedtls_test_psa_exercise_key( key, usage_flags, alg ) )
Darryl Green0c6575a2018-11-07 16:05:30 +00006233 goto exit;
Darryl Greend49a4992018-06-18 17:27:26 +01006234
6235exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +01006236 /*
6237 * Key attributes may have been returned by psa_get_key_attributes()
6238 * thus reset them as required.
6239 */
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02006240 psa_reset_key_attributes( &attributes );
Ronald Cron3a4f0e32020-11-19 17:55:23 +01006241
Darryl Greend49a4992018-06-18 17:27:26 +01006242 mbedtls_free( first_export );
6243 mbedtls_free( second_export );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006244 psa_key_derivation_abort( &operation );
Gilles Peskine5c648ab2019-04-19 14:06:53 +02006245 psa_destroy_key( base_key );
Ronald Cron5425a212020-08-04 14:58:35 +02006246 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02006247 PSA_DONE();
Darryl Greend49a4992018-06-18 17:27:26 +01006248}
6249/* END_CASE */