blob: 525c7e886889a59793a8383778c43f3d0d483988 [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"
Archana4d7ae1d2021-07-07 02:50:22 +053018#if defined(PSA_CRYPTO_DRIVER_TEST)
19#include "test/drivers/test_driver.h"
Archana8a180362021-07-05 02:18:48 +053020#define TEST_DRIVER_LOCATION PSA_CRYPTO_TEST_DRIVER_LOCATION
21#else
22#define TEST_DRIVER_LOCATION 0x7fffff
Archana4d7ae1d2021-07-07 02:50:22 +053023#endif
Ronald Cron28a45ed2021-02-09 20:35:42 +010024
Gilles Peskine4023c012021-05-27 13:21:20 +020025/* If this comes up, it's a bug in the test code or in the test data. */
26#define UNUSED 0xdeadbeef
27
Dave Rodgman647791d2021-06-23 12:49:59 +010028/* Assert that an operation is (not) active.
29 * This serves as a proxy for checking if the operation is aborted. */
30#define ASSERT_OPERATION_IS_ACTIVE( operation ) TEST_ASSERT( operation.id != 0 )
31#define ASSERT_OPERATION_IS_INACTIVE( operation ) TEST_ASSERT( operation.id == 0 )
Gilles Peskinef426e0f2019-02-25 17:42:03 +010032
33/** An invalid export length that will never be set by psa_export_key(). */
34static const size_t INVALID_EXPORT_LENGTH = ~0U;
35
Gilles Peskinea7aa4422018-08-14 15:17:54 +020036/** Test if a buffer contains a constant byte value.
37 *
38 * `mem_is_char(buffer, c, size)` is true after `memset(buffer, c, size)`.
Gilles Peskinee66ca3b2018-06-20 00:11:45 +020039 *
40 * \param buffer Pointer to the beginning of the buffer.
Gilles Peskinea7aa4422018-08-14 15:17:54 +020041 * \param c Expected value of every byte.
Gilles Peskinee66ca3b2018-06-20 00:11:45 +020042 * \param size Size of the buffer in bytes.
43 *
Gilles Peskine3f669c32018-06-21 09:21:51 +020044 * \return 1 if the buffer is all-bits-zero.
45 * \return 0 if there is at least one nonzero byte.
Gilles Peskinee66ca3b2018-06-20 00:11:45 +020046 */
Gilles Peskinea7aa4422018-08-14 15:17:54 +020047static int mem_is_char( void *buffer, unsigned char c, size_t size )
Gilles Peskinee66ca3b2018-06-20 00:11:45 +020048{
49 size_t i;
50 for( i = 0; i < size; i++ )
51 {
Gilles Peskinea7aa4422018-08-14 15:17:54 +020052 if( ( (unsigned char *) buffer )[i] != c )
Gilles Peskine3f669c32018-06-21 09:21:51 +020053 return( 0 );
Gilles Peskinee66ca3b2018-06-20 00:11:45 +020054 }
Gilles Peskine3f669c32018-06-21 09:21:51 +020055 return( 1 );
Gilles Peskinee66ca3b2018-06-20 00:11:45 +020056}
Andrzej Kurek77b8e092022-01-17 15:29:38 +010057#if defined(MBEDTLS_ASN1_WRITE_C)
Gilles Peskine0b352bc2018-06-28 00:16:11 +020058/* Write the ASN.1 INTEGER with the value 2^(bits-1)+x backwards from *p. */
59static int asn1_write_10x( unsigned char **p,
60 unsigned char *start,
61 size_t bits,
62 unsigned char x )
63{
64 int ret;
65 int len = bits / 8 + 1;
Gilles Peskine480416a2018-06-28 19:04:07 +020066 if( bits == 0 )
67 return( MBEDTLS_ERR_ASN1_INVALID_DATA );
68 if( bits <= 8 && x >= 1 << ( bits - 1 ) )
Gilles Peskine0b352bc2018-06-28 00:16:11 +020069 return( MBEDTLS_ERR_ASN1_INVALID_DATA );
Moran Pekercb088e72018-07-17 17:36:59 +030070 if( *p < start || *p - start < (ptrdiff_t) len )
Gilles Peskine0b352bc2018-06-28 00:16:11 +020071 return( MBEDTLS_ERR_ASN1_BUF_TOO_SMALL );
72 *p -= len;
73 ( *p )[len-1] = x;
74 if( bits % 8 == 0 )
75 ( *p )[1] |= 1;
76 else
77 ( *p )[0] |= 1 << ( bits % 8 );
78 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_len( p, start, len ) );
79 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_tag( p, start,
80 MBEDTLS_ASN1_INTEGER ) );
81 return( len );
82}
83
84static int construct_fake_rsa_key( unsigned char *buffer,
85 size_t buffer_size,
86 unsigned char **p,
87 size_t bits,
88 int keypair )
89{
90 size_t half_bits = ( bits + 1 ) / 2;
91 int ret;
92 int len = 0;
93 /* Construct something that looks like a DER encoding of
94 * as defined by PKCS#1 v2.2 (RFC 8017) section A.1.2:
95 * RSAPrivateKey ::= SEQUENCE {
96 * version Version,
97 * modulus INTEGER, -- n
98 * publicExponent INTEGER, -- e
99 * privateExponent INTEGER, -- d
100 * prime1 INTEGER, -- p
101 * prime2 INTEGER, -- q
102 * exponent1 INTEGER, -- d mod (p-1)
103 * exponent2 INTEGER, -- d mod (q-1)
104 * coefficient INTEGER, -- (inverse of q) mod p
105 * otherPrimeInfos OtherPrimeInfos OPTIONAL
106 * }
107 * Or, for a public key, the same structure with only
108 * version, modulus and publicExponent.
109 */
110 *p = buffer + buffer_size;
111 if( keypair )
112 {
113 MBEDTLS_ASN1_CHK_ADD( len, /* pq */
114 asn1_write_10x( p, buffer, half_bits, 1 ) );
115 MBEDTLS_ASN1_CHK_ADD( len, /* dq */
116 asn1_write_10x( p, buffer, half_bits, 1 ) );
117 MBEDTLS_ASN1_CHK_ADD( len, /* dp */
118 asn1_write_10x( p, buffer, half_bits, 1 ) );
119 MBEDTLS_ASN1_CHK_ADD( len, /* q */
120 asn1_write_10x( p, buffer, half_bits, 1 ) );
121 MBEDTLS_ASN1_CHK_ADD( len, /* p != q to pass mbedtls sanity checks */
122 asn1_write_10x( p, buffer, half_bits, 3 ) );
123 MBEDTLS_ASN1_CHK_ADD( len, /* d */
124 asn1_write_10x( p, buffer, bits, 1 ) );
125 }
126 MBEDTLS_ASN1_CHK_ADD( len, /* e = 65537 */
127 asn1_write_10x( p, buffer, 17, 1 ) );
128 MBEDTLS_ASN1_CHK_ADD( len, /* n */
129 asn1_write_10x( p, buffer, bits, 1 ) );
130 if( keypair )
131 MBEDTLS_ASN1_CHK_ADD( len, /* version = 0 */
132 mbedtls_asn1_write_int( p, buffer, 0 ) );
133 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_len( p, buffer, len ) );
134 {
135 const unsigned char tag =
136 MBEDTLS_ASN1_CONSTRUCTED | MBEDTLS_ASN1_SEQUENCE;
137 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_tag( p, buffer, tag ) );
138 }
139 return( len );
140}
Andrzej Kurek77b8e092022-01-17 15:29:38 +0100141#endif /* MBEDTLS_ASN1_WRITE_C */
Gilles Peskine0b352bc2018-06-28 00:16:11 +0200142
Gilles Peskinef426e0f2019-02-25 17:42:03 +0100143int exercise_mac_setup( psa_key_type_t key_type,
144 const unsigned char *key_bytes,
145 size_t key_length,
146 psa_algorithm_t alg,
147 psa_mac_operation_t *operation,
148 psa_status_t *status )
149{
Ronald Cron5425a212020-08-04 14:58:35 +0200150 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +0200151 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskinef426e0f2019-02-25 17:42:03 +0100152
Gilles Peskine89d8c5c2019-11-26 17:01:59 +0100153 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_HASH );
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +0200154 psa_set_key_algorithm( &attributes, alg );
155 psa_set_key_type( &attributes, key_type );
Ronald Cron5425a212020-08-04 14:58:35 +0200156 PSA_ASSERT( psa_import_key( &attributes, key_bytes, key_length, &key ) );
Gilles Peskinef426e0f2019-02-25 17:42:03 +0100157
Ronald Cron5425a212020-08-04 14:58:35 +0200158 *status = psa_mac_sign_setup( operation, key, alg );
Gilles Peskine9e0a4a52019-02-25 22:11:18 +0100159 /* Whether setup succeeded or failed, abort must succeed. */
160 PSA_ASSERT( psa_mac_abort( operation ) );
161 /* If setup failed, reproduce the failure, so that the caller can
162 * test the resulting state of the operation object. */
163 if( *status != PSA_SUCCESS )
Gilles Peskinef426e0f2019-02-25 17:42:03 +0100164 {
Ronald Cron5425a212020-08-04 14:58:35 +0200165 TEST_EQUAL( psa_mac_sign_setup( operation, key, alg ), *status );
Gilles Peskinef426e0f2019-02-25 17:42:03 +0100166 }
167
Ronald Cron5425a212020-08-04 14:58:35 +0200168 psa_destroy_key( key );
Gilles Peskinef426e0f2019-02-25 17:42:03 +0100169 return( 1 );
170
171exit:
Ronald Cron5425a212020-08-04 14:58:35 +0200172 psa_destroy_key( key );
Gilles Peskinef426e0f2019-02-25 17:42:03 +0100173 return( 0 );
174}
175
176int exercise_cipher_setup( psa_key_type_t key_type,
177 const unsigned char *key_bytes,
178 size_t key_length,
179 psa_algorithm_t alg,
180 psa_cipher_operation_t *operation,
181 psa_status_t *status )
182{
Ronald Cron5425a212020-08-04 14:58:35 +0200183 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +0200184 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskinef426e0f2019-02-25 17:42:03 +0100185
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +0200186 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
187 psa_set_key_algorithm( &attributes, alg );
188 psa_set_key_type( &attributes, key_type );
Ronald Cron5425a212020-08-04 14:58:35 +0200189 PSA_ASSERT( psa_import_key( &attributes, key_bytes, key_length, &key ) );
Gilles Peskinef426e0f2019-02-25 17:42:03 +0100190
Ronald Cron5425a212020-08-04 14:58:35 +0200191 *status = psa_cipher_encrypt_setup( operation, key, alg );
Gilles Peskine9e0a4a52019-02-25 22:11:18 +0100192 /* Whether setup succeeded or failed, abort must succeed. */
193 PSA_ASSERT( psa_cipher_abort( operation ) );
194 /* If setup failed, reproduce the failure, so that the caller can
195 * test the resulting state of the operation object. */
196 if( *status != PSA_SUCCESS )
Gilles Peskinef426e0f2019-02-25 17:42:03 +0100197 {
Ronald Cron5425a212020-08-04 14:58:35 +0200198 TEST_EQUAL( psa_cipher_encrypt_setup( operation, key, alg ),
Gilles Peskine9e0a4a52019-02-25 22:11:18 +0100199 *status );
Gilles Peskinef426e0f2019-02-25 17:42:03 +0100200 }
201
Ronald Cron5425a212020-08-04 14:58:35 +0200202 psa_destroy_key( key );
Gilles Peskinef426e0f2019-02-25 17:42:03 +0100203 return( 1 );
204
205exit:
Ronald Cron5425a212020-08-04 14:58:35 +0200206 psa_destroy_key( key );
Gilles Peskinef426e0f2019-02-25 17:42:03 +0100207 return( 0 );
208}
209
Ronald Cron5425a212020-08-04 14:58:35 +0200210static int test_operations_on_invalid_key( mbedtls_svc_key_id_t key )
Gilles Peskine4cf3a432019-04-18 22:28:52 +0200211{
212 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Ronald Cronecfb2372020-07-23 17:13:42 +0200213 mbedtls_svc_key_id_t key_id = mbedtls_svc_key_id_make( 1, 0x6964 );
Gilles Peskine4cf3a432019-04-18 22:28:52 +0200214 uint8_t buffer[1];
215 size_t length;
216 int ok = 0;
217
Ronald Cronecfb2372020-07-23 17:13:42 +0200218 psa_set_key_id( &attributes, key_id );
Gilles Peskine4cf3a432019-04-18 22:28:52 +0200219 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
220 psa_set_key_algorithm( &attributes, PSA_ALG_CTR );
221 psa_set_key_type( &attributes, PSA_KEY_TYPE_AES );
Ronald Cron5425a212020-08-04 14:58:35 +0200222 TEST_EQUAL( psa_get_key_attributes( key, &attributes ),
Maulik Patel3240c9d2021-03-17 16:11:05 +0000223 PSA_ERROR_INVALID_HANDLE );
Ronald Cronecfb2372020-07-23 17:13:42 +0200224 TEST_EQUAL(
225 MBEDTLS_SVC_KEY_ID_GET_KEY_ID( psa_get_key_id( &attributes ) ), 0 );
226 TEST_EQUAL(
227 MBEDTLS_SVC_KEY_ID_GET_OWNER_ID( psa_get_key_id( &attributes ) ), 0 );
Gilles Peskine5c648ab2019-04-19 14:06:53 +0200228 TEST_EQUAL( psa_get_key_lifetime( &attributes ), 0 );
Gilles Peskine4cf3a432019-04-18 22:28:52 +0200229 TEST_EQUAL( psa_get_key_usage_flags( &attributes ), 0 );
230 TEST_EQUAL( psa_get_key_algorithm( &attributes ), 0 );
231 TEST_EQUAL( psa_get_key_type( &attributes ), 0 );
232 TEST_EQUAL( psa_get_key_bits( &attributes ), 0 );
233
Ronald Cron5425a212020-08-04 14:58:35 +0200234 TEST_EQUAL( psa_export_key( key, buffer, sizeof( buffer ), &length ),
Maulik Patel3240c9d2021-03-17 16:11:05 +0000235 PSA_ERROR_INVALID_HANDLE );
Ronald Cron5425a212020-08-04 14:58:35 +0200236 TEST_EQUAL( psa_export_public_key( key,
Gilles Peskine4cf3a432019-04-18 22:28:52 +0200237 buffer, sizeof( buffer ), &length ),
Maulik Patel3240c9d2021-03-17 16:11:05 +0000238 PSA_ERROR_INVALID_HANDLE );
Gilles Peskine4cf3a432019-04-18 22:28:52 +0200239
Gilles Peskine4cf3a432019-04-18 22:28:52 +0200240 ok = 1;
241
242exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +0100243 /*
244 * Key attributes may have been returned by psa_get_key_attributes()
245 * thus reset them as required.
246 */
Gilles Peskine4cf3a432019-04-18 22:28:52 +0200247 psa_reset_key_attributes( &attributes );
Ronald Cron3a4f0e32020-11-19 17:55:23 +0100248
Gilles Peskine4cf3a432019-04-18 22:28:52 +0200249 return( ok );
250}
251
Gilles Peskine5fe5e272019-08-02 20:30:01 +0200252/* Assert that a key isn't reported as having a slot number. */
253#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
254#define ASSERT_NO_SLOT_NUMBER( attributes ) \
255 do \
256 { \
257 psa_key_slot_number_t ASSERT_NO_SLOT_NUMBER_slot_number; \
258 TEST_EQUAL( psa_get_key_slot_number( \
259 attributes, \
260 &ASSERT_NO_SLOT_NUMBER_slot_number ), \
261 PSA_ERROR_INVALID_ARGUMENT ); \
262 } \
263 while( 0 )
264#else /* MBEDTLS_PSA_CRYPTO_SE_C */
265#define ASSERT_NO_SLOT_NUMBER( attributes ) \
266 ( (void) 0 )
267#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
268
Gilles Peskinebdf309c2018-12-03 15:36:32 +0100269/* An overapproximation of the amount of storage needed for a key of the
270 * given type and with the given content. The API doesn't make it easy
271 * to find a good value for the size. The current implementation doesn't
272 * care about the value anyway. */
273#define KEY_BITS_FROM_DATA( type, data ) \
274 ( data )->len
275
Darryl Green0c6575a2018-11-07 16:05:30 +0000276typedef enum {
277 IMPORT_KEY = 0,
278 GENERATE_KEY = 1,
279 DERIVE_KEY = 2
280} generate_method;
281
Paul Elliott33746aa2021-09-15 16:40:40 +0100282typedef enum
283{
284 DO_NOT_SET_LENGTHS = 0,
285 SET_LENGTHS_BEFORE_NONCE = 1,
286 SET_LENGTHS_AFTER_NONCE = 2
Paul Elliottbb979e72021-09-22 12:54:42 +0100287} set_lengths_method_t;
Paul Elliott33746aa2021-09-15 16:40:40 +0100288
Paul Elliott1c67e0b2021-09-19 13:11:50 +0100289typedef enum
290{
291 USE_NULL_TAG = 0,
292 USE_GIVEN_TAG = 1,
Paul Elliottbb979e72021-09-22 12:54:42 +0100293} tag_usage_method_t;
Paul Elliott1c67e0b2021-09-19 13:11:50 +0100294
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100295/*!
296 * \brief Internal Function for AEAD multipart tests.
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100297 * \param key_type_arg Type of key passed in
298 * \param key_data The encryption / decryption key data
299 * \param alg_arg The type of algorithm used
300 * \param nonce Nonce data
301 * \param additional_data Additional data
Paul Elliott8eec8d42021-09-19 22:38:27 +0100302 * \param ad_part_len_arg If not -1, the length of chunks to
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100303 * feed additional data in to be encrypted /
304 * decrypted. If -1, no chunking.
305 * \param input_data Data to encrypt / decrypt
Paul Elliott8eec8d42021-09-19 22:38:27 +0100306 * \param data_part_len_arg If not -1, the length of chunks to feed
307 * the data in to be encrypted / decrypted. If
308 * -1, no chunking
Paul Elliottbb979e72021-09-22 12:54:42 +0100309 * \param set_lengths_method A member of the set_lengths_method_t enum is
Paul Elliott8eec8d42021-09-19 22:38:27 +0100310 * expected here, this controls whether or not
311 * to set lengths, and in what order with
312 * respect to set nonce.
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100313 * \param expected_output Expected output
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100314 * \param is_encrypt If non-zero this is an encryption operation.
Paul Elliott41ffae12021-07-22 21:52:01 +0100315 * \param do_zero_parts If non-zero, interleave zero length chunks
Paul Elliott8eec8d42021-09-19 22:38:27 +0100316 * with normal length chunks.
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100317 * \return int Zero on failure, non-zero on success.
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100318 */
319static int aead_multipart_internal_func( int key_type_arg, data_t *key_data,
320 int alg_arg,
321 data_t *nonce,
322 data_t *additional_data,
Paul Elliott6bfd0fb2021-09-15 14:15:55 +0100323 int ad_part_len_arg,
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100324 data_t *input_data,
Paul Elliott6bfd0fb2021-09-15 14:15:55 +0100325 int data_part_len_arg,
Paul Elliottbb979e72021-09-22 12:54:42 +0100326 set_lengths_method_t set_lengths_method,
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100327 data_t *expected_output,
Paul Elliott329d5382021-07-22 17:10:45 +0100328 int is_encrypt,
Paul Elliott33746aa2021-09-15 16:40:40 +0100329 int do_zero_parts )
Paul Elliottd3f82412021-06-16 16:52:21 +0100330{
331 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
332 psa_key_type_t key_type = key_type_arg;
333 psa_algorithm_t alg = alg_arg;
Paul Elliottfbb4c6d2021-09-22 16:44:21 +0100334 psa_aead_operation_t operation = PSA_AEAD_OPERATION_INIT;
Paul Elliottd3f82412021-06-16 16:52:21 +0100335 unsigned char *output_data = NULL;
336 unsigned char *part_data = NULL;
337 unsigned char *final_data = NULL;
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100338 size_t data_true_size = 0;
Paul Elliottd3f82412021-06-16 16:52:21 +0100339 size_t part_data_size = 0;
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100340 size_t output_size = 0;
341 size_t final_output_size = 0;
Paul Elliottd3f82412021-06-16 16:52:21 +0100342 size_t output_length = 0;
343 size_t key_bits = 0;
344 size_t tag_length = 0;
Paul Elliott6bfd0fb2021-09-15 14:15:55 +0100345 size_t part_offset = 0;
Paul Elliottd3f82412021-06-16 16:52:21 +0100346 size_t part_length = 0;
347 size_t output_part_length = 0;
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100348 size_t tag_size = 0;
Paul Elliott6bfd0fb2021-09-15 14:15:55 +0100349 size_t ad_part_len = 0;
350 size_t data_part_len = 0;
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100351 uint8_t tag_buffer[PSA_AEAD_TAG_MAX_SIZE];
Paul Elliottd3f82412021-06-16 16:52:21 +0100352 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
353 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
354
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100355 int test_ok = 0;
Paul Elliott6bfd0fb2021-09-15 14:15:55 +0100356 size_t part_count = 0;
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100357
Paul Elliottd3f82412021-06-16 16:52:21 +0100358 PSA_ASSERT( psa_crypto_init( ) );
359
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100360 if( is_encrypt )
361 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
362 else
363 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DECRYPT );
364
Paul Elliottd3f82412021-06-16 16:52:21 +0100365 psa_set_key_algorithm( &attributes, alg );
366 psa_set_key_type( &attributes, key_type );
367
368 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
369 &key ) );
370
371 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
372 key_bits = psa_get_key_bits( &attributes );
373
374 tag_length = PSA_AEAD_TAG_LENGTH( key_type, key_bits, alg );
375
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100376 if( is_encrypt )
377 {
378 /* Tag gets written at end of buffer. */
379 output_size = PSA_AEAD_UPDATE_OUTPUT_SIZE( key_type, alg,
380 ( input_data->len +
381 tag_length ) );
382 data_true_size = input_data->len;
383 }
384 else
385 {
386 output_size = PSA_AEAD_UPDATE_OUTPUT_SIZE( key_type, alg,
387 ( input_data->len -
388 tag_length ) );
Paul Elliottd3f82412021-06-16 16:52:21 +0100389
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100390 /* Do not want to attempt to decrypt tag. */
391 data_true_size = input_data->len - tag_length;
392 }
Paul Elliottd3f82412021-06-16 16:52:21 +0100393
394 ASSERT_ALLOC( output_data, output_size );
395
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100396 if( is_encrypt )
397 {
Paul Elliott5a9642f2021-09-13 19:13:22 +0100398 final_output_size = PSA_AEAD_FINISH_OUTPUT_SIZE( key_type, alg );
399 TEST_ASSERT( final_output_size <= PSA_AEAD_FINISH_OUTPUT_MAX_SIZE );
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100400 }
401 else
402 {
Paul Elliott5a9642f2021-09-13 19:13:22 +0100403 final_output_size = PSA_AEAD_VERIFY_OUTPUT_SIZE( key_type, alg );
404 TEST_ASSERT( final_output_size <= PSA_AEAD_VERIFY_OUTPUT_MAX_SIZE );
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100405 }
Paul Elliottd3f82412021-06-16 16:52:21 +0100406
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100407 ASSERT_ALLOC( final_data, final_output_size );
Paul Elliottd3f82412021-06-16 16:52:21 +0100408
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100409 if( is_encrypt )
410 status = psa_aead_encrypt_setup( &operation, key, alg );
411 else
412 status = psa_aead_decrypt_setup( &operation, key, alg );
Paul Elliottd3f82412021-06-16 16:52:21 +0100413
414 /* If the operation is not supported, just skip and not fail in case the
415 * encryption involves a common limitation of cryptography hardwares and
416 * an alternative implementation. */
417 if( status == PSA_ERROR_NOT_SUPPORTED )
418 {
419 MBEDTLS_TEST_PSA_SKIP_IF_ALT_AES_192( key_type, key_data->len * 8 );
420 MBEDTLS_TEST_PSA_SKIP_IF_ALT_GCM_NOT_12BYTES_NONCE( alg, nonce->len );
421 }
422
423 PSA_ASSERT( status );
424
Paul Elliott33746aa2021-09-15 16:40:40 +0100425 if( set_lengths_method == DO_NOT_SET_LENGTHS )
426 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
427 else if( set_lengths_method == SET_LENGTHS_BEFORE_NONCE )
Paul Elliottd3f82412021-06-16 16:52:21 +0100428 {
Paul Elliott33746aa2021-09-15 16:40:40 +0100429 PSA_ASSERT( psa_aead_set_lengths( &operation, additional_data->len,
430 data_true_size ) );
Paul Elliottebf91632021-07-22 17:54:42 +0100431 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
432 }
Paul Elliott33746aa2021-09-15 16:40:40 +0100433 else if( set_lengths_method == SET_LENGTHS_AFTER_NONCE )
Paul Elliottebf91632021-07-22 17:54:42 +0100434 {
435 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
436
Paul Elliott33746aa2021-09-15 16:40:40 +0100437 PSA_ASSERT( psa_aead_set_lengths( &operation, additional_data->len,
438 data_true_size ) );
Paul Elliottd3f82412021-06-16 16:52:21 +0100439 }
Paul Elliottd3f82412021-06-16 16:52:21 +0100440
Paul Elliott6bfd0fb2021-09-15 14:15:55 +0100441 if( ad_part_len_arg != -1 )
Paul Elliottd3f82412021-06-16 16:52:21 +0100442 {
443 /* Pass additional data in parts */
Paul Elliott6bfd0fb2021-09-15 14:15:55 +0100444 ad_part_len = (size_t) ad_part_len_arg;
Paul Elliottd3f82412021-06-16 16:52:21 +0100445
Paul Elliott4e4d71a2021-09-15 16:50:01 +0100446 for( part_offset = 0, part_count = 0;
447 part_offset < additional_data->len;
448 part_offset += part_length, part_count++ )
Paul Elliottd3f82412021-06-16 16:52:21 +0100449 {
Paul Elliott4e4d71a2021-09-15 16:50:01 +0100450 if( do_zero_parts && ( part_count & 0x01 ) )
Paul Elliottd3f82412021-06-16 16:52:21 +0100451 {
Paul Elliott329d5382021-07-22 17:10:45 +0100452 part_length = 0;
Paul Elliottd3f82412021-06-16 16:52:21 +0100453 }
Paul Elliotte49fe452021-09-15 16:52:11 +0100454 else if( additional_data->len - part_offset < ad_part_len )
455 {
456 part_length = additional_data->len - part_offset;
457 }
Paul Elliottd3f82412021-06-16 16:52:21 +0100458 else
459 {
Paul Elliotte49fe452021-09-15 16:52:11 +0100460 part_length = ad_part_len;
Paul Elliottd3f82412021-06-16 16:52:21 +0100461 }
462
463 PSA_ASSERT( psa_aead_update_ad( &operation,
464 additional_data->x + part_offset,
465 part_length ) );
466
Paul Elliottd3f82412021-06-16 16:52:21 +0100467 }
468 }
469 else
470 {
471 /* Pass additional data in one go. */
472 PSA_ASSERT( psa_aead_update_ad( &operation, additional_data->x,
473 additional_data->len ) );
474 }
475
Paul Elliott6bfd0fb2021-09-15 14:15:55 +0100476 if( data_part_len_arg != -1 )
Paul Elliottd3f82412021-06-16 16:52:21 +0100477 {
478 /* Pass data in parts */
Paul Elliott6bfd0fb2021-09-15 14:15:55 +0100479 data_part_len = ( size_t ) data_part_len_arg;
Paul Elliottd3f82412021-06-16 16:52:21 +0100480 part_data_size = PSA_AEAD_UPDATE_OUTPUT_SIZE( key_type, alg,
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100481 ( size_t ) data_part_len );
Paul Elliottd3f82412021-06-16 16:52:21 +0100482
483 ASSERT_ALLOC( part_data, part_data_size );
484
Paul Elliott4e4d71a2021-09-15 16:50:01 +0100485 for( part_offset = 0, part_count = 0;
486 part_offset < data_true_size;
487 part_offset += part_length, part_count++ )
Paul Elliottd3f82412021-06-16 16:52:21 +0100488 {
Paul Elliott4e4d71a2021-09-15 16:50:01 +0100489 if( do_zero_parts && ( part_count & 0x01 ) )
Paul Elliottd3f82412021-06-16 16:52:21 +0100490 {
Paul Elliott329d5382021-07-22 17:10:45 +0100491 part_length = 0;
Paul Elliottd3f82412021-06-16 16:52:21 +0100492 }
Paul Elliotte49fe452021-09-15 16:52:11 +0100493 else if( ( data_true_size - part_offset ) < data_part_len )
494 {
495 part_length = ( data_true_size - part_offset );
496 }
Paul Elliottd3f82412021-06-16 16:52:21 +0100497 else
498 {
Paul Elliotte49fe452021-09-15 16:52:11 +0100499 part_length = data_part_len;
Paul Elliottd3f82412021-06-16 16:52:21 +0100500 }
501
502 PSA_ASSERT( psa_aead_update( &operation,
503 ( input_data->x + part_offset ),
504 part_length, part_data,
505 part_data_size,
506 &output_part_length ) );
507
508 if( output_data && output_part_length )
509 {
510 memcpy( ( output_data + part_offset ), part_data,
511 output_part_length );
512 }
513
Paul Elliottd3f82412021-06-16 16:52:21 +0100514 output_length += output_part_length;
515 }
516 }
517 else
518 {
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100519 /* Pass all data in one go. */
Paul Elliottd3f82412021-06-16 16:52:21 +0100520 PSA_ASSERT( psa_aead_update( &operation, input_data->x,
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100521 data_true_size, output_data,
Paul Elliottd3f82412021-06-16 16:52:21 +0100522 output_size, &output_length ) );
523 }
524
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100525 if( is_encrypt )
526 PSA_ASSERT( psa_aead_finish( &operation, final_data,
527 final_output_size,
528 &output_part_length,
529 tag_buffer, tag_length,
530 &tag_size ) );
531 else
Paul Elliottd3f82412021-06-16 16:52:21 +0100532 {
Paul Elliott9961a662021-09-17 19:19:02 +0100533 PSA_ASSERT( psa_aead_verify( &operation, final_data,
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100534 final_output_size,
535 &output_part_length,
536 ( input_data->x + data_true_size ),
Paul Elliott9961a662021-09-17 19:19:02 +0100537 tag_length ) );
Paul Elliottd3f82412021-06-16 16:52:21 +0100538 }
539
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100540 if( output_data && output_part_length )
541 memcpy( ( output_data + output_length ), final_data,
542 output_part_length );
Paul Elliottd3f82412021-06-16 16:52:21 +0100543
544 output_length += output_part_length;
545
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100546
547 /* For all currently defined algorithms, PSA_AEAD_xxx_OUTPUT_SIZE
548 * should be exact.*/
549 if( is_encrypt )
Paul Elliottd3f82412021-06-16 16:52:21 +0100550 {
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100551 TEST_EQUAL( tag_length, tag_size );
552
553 if( output_data && tag_length )
554 memcpy( ( output_data + output_length ), tag_buffer,
555 tag_length );
556
557 output_length += tag_length;
558
559 TEST_EQUAL( output_length,
560 PSA_AEAD_ENCRYPT_OUTPUT_SIZE( key_type, alg,
561 input_data->len ) );
562 TEST_ASSERT( output_length <=
563 PSA_AEAD_ENCRYPT_OUTPUT_MAX_SIZE( input_data->len ) );
564 }
565 else
566 {
567 TEST_EQUAL( output_length,
568 PSA_AEAD_DECRYPT_OUTPUT_SIZE( key_type, alg,
569 input_data->len ) );
570 TEST_ASSERT( output_length <=
571 PSA_AEAD_DECRYPT_OUTPUT_MAX_SIZE( input_data->len ) );
Paul Elliottd3f82412021-06-16 16:52:21 +0100572 }
573
Paul Elliottd3f82412021-06-16 16:52:21 +0100574
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100575 ASSERT_COMPARE( expected_output->x, expected_output->len,
Paul Elliottd3f82412021-06-16 16:52:21 +0100576 output_data, output_length );
577
Paul Elliottd3f82412021-06-16 16:52:21 +0100578
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100579 test_ok = 1;
Paul Elliottd3f82412021-06-16 16:52:21 +0100580
581exit:
582 psa_destroy_key( key );
583 psa_aead_abort( &operation );
584 mbedtls_free( output_data );
585 mbedtls_free( part_data );
586 mbedtls_free( final_data );
587 PSA_DONE( );
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100588
589 return( test_ok );
Paul Elliottd3f82412021-06-16 16:52:21 +0100590}
591
Gilles Peskinee59236f2018-01-27 23:32:46 +0100592/* END_HEADER */
593
594/* BEGIN_DEPENDENCIES
595 * depends_on:MBEDTLS_PSA_CRYPTO_C
596 * END_DEPENDENCIES
597 */
598
599/* BEGIN_CASE */
Gilles Peskinee1f2d7d2018-08-21 14:54:54 +0200600void static_checks( )
601{
602 size_t max_truncated_mac_size =
603 PSA_ALG_MAC_TRUNCATION_MASK >> PSA_MAC_TRUNCATION_OFFSET;
604
605 /* Check that the length for a truncated MAC always fits in the algorithm
606 * encoding. The shifted mask is the maximum truncated value. The
607 * untruncated algorithm may be one byte larger. */
608 TEST_ASSERT( PSA_MAC_MAX_SIZE <= 1 + max_truncated_mac_size );
609}
610/* END_CASE */
611
612/* BEGIN_CASE */
Gilles Peskine6edfa292019-07-31 15:53:45 +0200613void import_with_policy( int type_arg,
614 int usage_arg, int alg_arg,
615 int expected_status_arg )
616{
617 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
618 psa_key_attributes_t got_attributes = PSA_KEY_ATTRIBUTES_INIT;
Ronald Cron5425a212020-08-04 14:58:35 +0200619 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine6edfa292019-07-31 15:53:45 +0200620 psa_key_type_t type = type_arg;
621 psa_key_usage_t usage = usage_arg;
622 psa_algorithm_t alg = alg_arg;
623 psa_status_t expected_status = expected_status_arg;
624 const uint8_t key_material[16] = {0};
625 psa_status_t status;
626
627 PSA_ASSERT( psa_crypto_init( ) );
628
629 psa_set_key_type( &attributes, type );
630 psa_set_key_usage_flags( &attributes, usage );
631 psa_set_key_algorithm( &attributes, alg );
632
633 status = psa_import_key( &attributes,
634 key_material, sizeof( key_material ),
Ronald Cron5425a212020-08-04 14:58:35 +0200635 &key );
Gilles Peskine6edfa292019-07-31 15:53:45 +0200636 TEST_EQUAL( status, expected_status );
637 if( status != PSA_SUCCESS )
638 goto exit;
639
Ronald Cron5425a212020-08-04 14:58:35 +0200640 PSA_ASSERT( psa_get_key_attributes( key, &got_attributes ) );
Gilles Peskine6edfa292019-07-31 15:53:45 +0200641 TEST_EQUAL( psa_get_key_type( &got_attributes ), type );
gabor-mezei-arm4ff73032021-05-13 12:05:01 +0200642 TEST_EQUAL( psa_get_key_usage_flags( &got_attributes ),
gabor-mezei-arm98a34352021-06-28 14:05:00 +0200643 mbedtls_test_update_key_usage_flags( usage ) );
Gilles Peskine6edfa292019-07-31 15:53:45 +0200644 TEST_EQUAL( psa_get_key_algorithm( &got_attributes ), alg );
Gilles Peskine5fe5e272019-08-02 20:30:01 +0200645 ASSERT_NO_SLOT_NUMBER( &got_attributes );
Gilles Peskine6edfa292019-07-31 15:53:45 +0200646
Ronald Cron5425a212020-08-04 14:58:35 +0200647 PSA_ASSERT( psa_destroy_key( key ) );
648 test_operations_on_invalid_key( key );
Gilles Peskine6edfa292019-07-31 15:53:45 +0200649
650exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +0100651 /*
652 * Key attributes may have been returned by psa_get_key_attributes()
653 * thus reset them as required.
654 */
Gilles Peskine6edfa292019-07-31 15:53:45 +0200655 psa_reset_key_attributes( &got_attributes );
Ronald Cron3a4f0e32020-11-19 17:55:23 +0100656
657 psa_destroy_key( key );
Gilles Peskine6edfa292019-07-31 15:53:45 +0200658 PSA_DONE( );
659}
660/* END_CASE */
661
662/* BEGIN_CASE */
663void import_with_data( data_t *data, int type_arg,
664 int attr_bits_arg,
665 int expected_status_arg )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +0200666{
667 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
668 psa_key_attributes_t got_attributes = PSA_KEY_ATTRIBUTES_INIT;
Ronald Cron5425a212020-08-04 14:58:35 +0200669 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +0200670 psa_key_type_t type = type_arg;
Gilles Peskine8fb3a9e2019-05-03 16:59:21 +0200671 size_t attr_bits = attr_bits_arg;
Gilles Peskineb866e2b2018-06-21 09:25:10 +0200672 psa_status_t expected_status = expected_status_arg;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100673 psa_status_t status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100674
Gilles Peskine8817f612018-12-18 00:18:46 +0100675 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100676
Gilles Peskine4747d192019-04-17 15:05:45 +0200677 psa_set_key_type( &attributes, type );
Gilles Peskine8fb3a9e2019-05-03 16:59:21 +0200678 psa_set_key_bits( &attributes, attr_bits );
Gilles Peskine6edfa292019-07-31 15:53:45 +0200679
Ronald Cron5425a212020-08-04 14:58:35 +0200680 status = psa_import_key( &attributes, data->x, data->len, &key );
Gilles Peskinefe11b722018-12-18 00:24:04 +0100681 TEST_EQUAL( status, expected_status );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +0200682 if( status != PSA_SUCCESS )
683 goto exit;
684
Ronald Cron5425a212020-08-04 14:58:35 +0200685 PSA_ASSERT( psa_get_key_attributes( key, &got_attributes ) );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +0200686 TEST_EQUAL( psa_get_key_type( &got_attributes ), type );
Gilles Peskine8fb3a9e2019-05-03 16:59:21 +0200687 if( attr_bits != 0 )
Gilles Peskine7e0cff92019-07-30 13:48:52 +0200688 TEST_EQUAL( attr_bits, psa_get_key_bits( &got_attributes ) );
Gilles Peskine5fe5e272019-08-02 20:30:01 +0200689 ASSERT_NO_SLOT_NUMBER( &got_attributes );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +0200690
Ronald Cron5425a212020-08-04 14:58:35 +0200691 PSA_ASSERT( psa_destroy_key( key ) );
692 test_operations_on_invalid_key( key );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100693
694exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +0100695 /*
696 * Key attributes may have been returned by psa_get_key_attributes()
697 * thus reset them as required.
698 */
Gilles Peskinea1ace9c2019-04-26 16:03:33 +0200699 psa_reset_key_attributes( &got_attributes );
Ronald Cron3a4f0e32020-11-19 17:55:23 +0100700
701 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +0200702 PSA_DONE( );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100703}
704/* END_CASE */
705
706/* BEGIN_CASE */
Gilles Peskinec744d992019-07-30 17:26:54 +0200707void import_large_key( int type_arg, int byte_size_arg,
708 int expected_status_arg )
709{
710 psa_key_type_t type = type_arg;
711 size_t byte_size = byte_size_arg;
712 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
713 psa_status_t expected_status = expected_status_arg;
Ronald Cron5425a212020-08-04 14:58:35 +0200714 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskinec744d992019-07-30 17:26:54 +0200715 psa_status_t status;
716 uint8_t *buffer = NULL;
717 size_t buffer_size = byte_size + 1;
718 size_t n;
719
Steven Cooreman69967ce2021-01-18 18:01:08 +0100720 /* Skip the test case if the target running the test cannot
721 * accomodate large keys due to heap size constraints */
722 ASSERT_ALLOC_WEAK( buffer, buffer_size );
Gilles Peskinec744d992019-07-30 17:26:54 +0200723 memset( buffer, 'K', byte_size );
724
725 PSA_ASSERT( psa_crypto_init( ) );
726
727 /* Try importing the key */
728 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_EXPORT );
729 psa_set_key_type( &attributes, type );
Ronald Cron5425a212020-08-04 14:58:35 +0200730 status = psa_import_key( &attributes, buffer, byte_size, &key );
Steven Cooreman83fdb702021-01-21 14:24:39 +0100731 TEST_ASSUME( status != PSA_ERROR_INSUFFICIENT_MEMORY );
Gilles Peskinec744d992019-07-30 17:26:54 +0200732 TEST_EQUAL( status, expected_status );
733
734 if( status == PSA_SUCCESS )
735 {
Ronald Cron5425a212020-08-04 14:58:35 +0200736 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
Gilles Peskinec744d992019-07-30 17:26:54 +0200737 TEST_EQUAL( psa_get_key_type( &attributes ), type );
738 TEST_EQUAL( psa_get_key_bits( &attributes ),
739 PSA_BYTES_TO_BITS( byte_size ) );
Gilles Peskine5fe5e272019-08-02 20:30:01 +0200740 ASSERT_NO_SLOT_NUMBER( &attributes );
Gilles Peskinec744d992019-07-30 17:26:54 +0200741 memset( buffer, 0, byte_size + 1 );
Ronald Cron5425a212020-08-04 14:58:35 +0200742 PSA_ASSERT( psa_export_key( key, buffer, byte_size, &n ) );
Gilles Peskinec744d992019-07-30 17:26:54 +0200743 for( n = 0; n < byte_size; n++ )
744 TEST_EQUAL( buffer[n], 'K' );
745 for( n = byte_size; n < buffer_size; n++ )
746 TEST_EQUAL( buffer[n], 0 );
747 }
748
749exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +0100750 /*
751 * Key attributes may have been returned by psa_get_key_attributes()
752 * thus reset them as required.
753 */
754 psa_reset_key_attributes( &attributes );
755
Ronald Cron5425a212020-08-04 14:58:35 +0200756 psa_destroy_key( key );
Gilles Peskinec744d992019-07-30 17:26:54 +0200757 PSA_DONE( );
758 mbedtls_free( buffer );
759}
760/* END_CASE */
761
Andrzej Kurek77b8e092022-01-17 15:29:38 +0100762/* BEGIN_CASE depends_on:MBEDTLS_ASN1_WRITE_C */
Gilles Peskine0b352bc2018-06-28 00:16:11 +0200763void import_rsa_made_up( int bits_arg, int keypair, int expected_status_arg )
764{
Ronald Cron5425a212020-08-04 14:58:35 +0200765 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine0b352bc2018-06-28 00:16:11 +0200766 size_t bits = bits_arg;
767 psa_status_t expected_status = expected_status_arg;
768 psa_status_t status;
769 psa_key_type_t type =
Gilles Peskinec93b80c2019-05-16 19:39:54 +0200770 keypair ? PSA_KEY_TYPE_RSA_KEY_PAIR : PSA_KEY_TYPE_RSA_PUBLIC_KEY;
Gilles Peskine0b352bc2018-06-28 00:16:11 +0200771 size_t buffer_size = /* Slight overapproximations */
772 keypair ? bits * 9 / 16 + 80 : bits / 8 + 20;
Gilles Peskine8cebbba2018-09-27 13:54:18 +0200773 unsigned char *buffer = NULL;
Gilles Peskine0b352bc2018-06-28 00:16:11 +0200774 unsigned char *p;
775 int ret;
776 size_t length;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +0200777 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine0b352bc2018-06-28 00:16:11 +0200778
Gilles Peskine8817f612018-12-18 00:18:46 +0100779 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine8cebbba2018-09-27 13:54:18 +0200780 ASSERT_ALLOC( buffer, buffer_size );
Gilles Peskine0b352bc2018-06-28 00:16:11 +0200781
782 TEST_ASSERT( ( ret = construct_fake_rsa_key( buffer, buffer_size, &p,
783 bits, keypair ) ) >= 0 );
784 length = ret;
785
786 /* Try importing the key */
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +0200787 psa_set_key_type( &attributes, type );
Ronald Cron5425a212020-08-04 14:58:35 +0200788 status = psa_import_key( &attributes, p, length, &key );
Gilles Peskinefe11b722018-12-18 00:24:04 +0100789 TEST_EQUAL( status, expected_status );
Gilles Peskine76b29a72019-05-28 14:08:50 +0200790
Gilles Peskine0b352bc2018-06-28 00:16:11 +0200791 if( status == PSA_SUCCESS )
Ronald Cron5425a212020-08-04 14:58:35 +0200792 PSA_ASSERT( psa_destroy_key( key ) );
Gilles Peskine0b352bc2018-06-28 00:16:11 +0200793
794exit:
795 mbedtls_free( buffer );
Gilles Peskine1153e7b2019-05-28 15:10:21 +0200796 PSA_DONE( );
Gilles Peskine0b352bc2018-06-28 00:16:11 +0200797}
798/* END_CASE */
799
800/* BEGIN_CASE */
itayzafrir3e02b3b2018-06-12 17:06:52 +0300801void import_export( data_t *data,
Moran Pekera964a8f2018-06-04 18:42:36 +0300802 int type_arg,
Gilles Peskine1ecf92c22019-05-24 15:00:06 +0200803 int usage_arg, int alg_arg,
Archana4d7ae1d2021-07-07 02:50:22 +0530804 int lifetime_arg,
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100805 int expected_bits,
806 int export_size_delta,
Gilles Peskineb866e2b2018-06-21 09:25:10 +0200807 int expected_export_status_arg,
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100808 int canonical_input )
809{
Ronald Cron5425a212020-08-04 14:58:35 +0200810 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100811 psa_key_type_t type = type_arg;
Gilles Peskine4abf7412018-06-18 16:35:34 +0200812 psa_algorithm_t alg = alg_arg;
Gilles Peskineb866e2b2018-06-21 09:25:10 +0200813 psa_status_t expected_export_status = expected_export_status_arg;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100814 psa_status_t status;
Archana4d7ae1d2021-07-07 02:50:22 +0530815 psa_key_lifetime_t lifetime = lifetime_arg;
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
Archana4d7ae1d2021-07-07 02:50:22 +0530830 psa_set_key_lifetime( &attributes, lifetime );
Gilles Peskine4747d192019-04-17 15:05:45 +0200831 psa_set_key_usage_flags( &attributes, usage_arg );
832 psa_set_key_algorithm( &attributes, alg );
833 psa_set_key_type( &attributes, type );
mohammad1603a97cb8c2018-03-28 03:46:26 -0700834
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100835 /* Import the key */
Ronald Cron5425a212020-08-04 14:58:35 +0200836 PSA_ASSERT( psa_import_key( &attributes, data->x, data->len, &key ) );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100837
838 /* Test the key information */
Ronald Cron5425a212020-08-04 14:58:35 +0200839 PSA_ASSERT( psa_get_key_attributes( key, &got_attributes ) );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +0200840 TEST_EQUAL( psa_get_key_type( &got_attributes ), type );
841 TEST_EQUAL( psa_get_key_bits( &got_attributes ), (size_t) expected_bits );
Gilles Peskine5fe5e272019-08-02 20:30:01 +0200842 ASSERT_NO_SLOT_NUMBER( &got_attributes );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100843
844 /* Export the key */
Ronald Cron5425a212020-08-04 14:58:35 +0200845 status = psa_export_key( key, exported, export_size, &exported_length );
Gilles Peskinefe11b722018-12-18 00:24:04 +0100846 TEST_EQUAL( status, expected_export_status );
Jaeden Amerof24c7f82018-06-27 17:20:43 +0100847
848 /* The exported length must be set by psa_export_key() to a value between 0
849 * and export_size. On errors, the exported length must be 0. */
850 TEST_ASSERT( exported_length != INVALID_EXPORT_LENGTH );
851 TEST_ASSERT( status == PSA_SUCCESS || exported_length == 0 );
852 TEST_ASSERT( exported_length <= export_size );
853
Gilles Peskinea7aa4422018-08-14 15:17:54 +0200854 TEST_ASSERT( mem_is_char( exported + exported_length, 0,
Gilles Peskine3f669c32018-06-21 09:21:51 +0200855 export_size - exported_length ) );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100856 if( status != PSA_SUCCESS )
Gilles Peskinee66ca3b2018-06-20 00:11:45 +0200857 {
Gilles Peskinefe11b722018-12-18 00:24:04 +0100858 TEST_EQUAL( exported_length, 0 );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100859 goto destroy;
Gilles Peskinee66ca3b2018-06-20 00:11:45 +0200860 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100861
Gilles Peskineea38a922021-02-13 00:05:16 +0100862 /* Run sanity checks on the exported key. For non-canonical inputs,
863 * this validates the canonical representations. For canonical inputs,
864 * this doesn't directly validate the implementation, but it still helps
865 * by cross-validating the test data with the sanity check code. */
Archana4d7ae1d2021-07-07 02:50:22 +0530866 if( !psa_key_lifetime_is_external( lifetime ) )
867 {
868 if( ! mbedtls_test_psa_exercise_key( key, usage_arg, 0 ) )
869 goto exit;
870 }
Gilles Peskine8f609232018-08-11 01:24:55 +0200871
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100872 if( canonical_input )
Gilles Peskinebd7dea92018-09-27 13:57:19 +0200873 ASSERT_COMPARE( data->x, data->len, exported, exported_length );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100874 else
875 {
Ronald Cron5425a212020-08-04 14:58:35 +0200876 mbedtls_svc_key_id_t key2 = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine049c7532019-05-15 20:22:09 +0200877 PSA_ASSERT( psa_import_key( &attributes, exported, exported_length,
Ronald Cron5425a212020-08-04 14:58:35 +0200878 &key2 ) );
879 PSA_ASSERT( psa_export_key( key2,
Gilles Peskine8817f612018-12-18 00:18:46 +0100880 reexported,
881 export_size,
882 &reexported_length ) );
Gilles Peskinebd7dea92018-09-27 13:57:19 +0200883 ASSERT_COMPARE( exported, exported_length,
Archana4d7ae1d2021-07-07 02:50:22 +0530884 reexported, reexported_length );
Ronald Cron5425a212020-08-04 14:58:35 +0200885 PSA_ASSERT( psa_destroy_key( key2 ) );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100886 }
gabor-mezei-armceface22021-01-21 12:26:17 +0100887 TEST_ASSERT( exported_length <=
Archana4d7ae1d2021-07-07 02:50:22 +0530888 PSA_EXPORT_KEY_OUTPUT_SIZE( type,
Archana9d17bf42021-09-10 06:22:44 +0530889 psa_get_key_bits( &got_attributes ) ) );
gabor-mezei-armceface22021-01-21 12:26:17 +0100890 TEST_ASSERT( exported_length <= PSA_EXPORT_KEY_PAIR_MAX_SIZE );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100891
892destroy:
893 /* Destroy the key */
Ronald Cron5425a212020-08-04 14:58:35 +0200894 PSA_ASSERT( psa_destroy_key( key ) );
895 test_operations_on_invalid_key( key );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100896
897exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +0100898 /*
899 * Key attributes may have been returned by psa_get_key_attributes()
900 * thus reset them as required.
901 */
902 psa_reset_key_attributes( &got_attributes );
Archana4d7ae1d2021-07-07 02:50:22 +0530903 psa_destroy_key( key ) ;
itayzafrir3e02b3b2018-06-12 17:06:52 +0300904 mbedtls_free( exported );
905 mbedtls_free( reexported );
Gilles Peskine1153e7b2019-05-28 15:10:21 +0200906 PSA_DONE( );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100907}
908/* END_CASE */
Gilles Peskine20035e32018-02-03 22:44:14 +0100909
Moran Pekerf709f4a2018-06-06 17:26:04 +0300910/* BEGIN_CASE */
itayzafrir3e02b3b2018-06-12 17:06:52 +0300911void import_export_public_key( data_t *data,
Gilles Peskine2d277862018-06-18 15:41:12 +0200912 int type_arg,
913 int alg_arg,
Archana4d7ae1d2021-07-07 02:50:22 +0530914 int lifetime_arg,
Gilles Peskine49c25912018-10-29 15:15:31 +0100915 int export_size_delta,
916 int expected_export_status_arg,
917 data_t *expected_public_key )
Moran Pekerf709f4a2018-06-06 17:26:04 +0300918{
Ronald Cron5425a212020-08-04 14:58:35 +0200919 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Moran Pekerf709f4a2018-06-06 17:26:04 +0300920 psa_key_type_t type = type_arg;
Gilles Peskine4abf7412018-06-18 16:35:34 +0200921 psa_algorithm_t alg = alg_arg;
Gilles Peskineb866e2b2018-06-21 09:25:10 +0200922 psa_status_t expected_export_status = expected_export_status_arg;
Moran Pekerf709f4a2018-06-06 17:26:04 +0300923 psa_status_t status;
Archana4d7ae1d2021-07-07 02:50:22 +0530924 psa_key_lifetime_t lifetime = lifetime_arg;
Moran Pekerf709f4a2018-06-06 17:26:04 +0300925 unsigned char *exported = NULL;
Gilles Peskine49c25912018-10-29 15:15:31 +0100926 size_t export_size = expected_public_key->len + export_size_delta;
Jaeden Amero2a671e92018-06-27 17:47:40 +0100927 size_t exported_length = INVALID_EXPORT_LENGTH;
Gilles Peskine4747d192019-04-17 15:05:45 +0200928 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Moran Pekerf709f4a2018-06-06 17:26:04 +0300929
Gilles Peskine8817f612018-12-18 00:18:46 +0100930 PSA_ASSERT( psa_crypto_init( ) );
Moran Pekerf709f4a2018-06-06 17:26:04 +0300931
Archana4d7ae1d2021-07-07 02:50:22 +0530932 psa_set_key_lifetime( &attributes, lifetime );
Gilles Peskine4747d192019-04-17 15:05:45 +0200933 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_EXPORT );
934 psa_set_key_algorithm( &attributes, alg );
935 psa_set_key_type( &attributes, type );
Moran Pekerf709f4a2018-06-06 17:26:04 +0300936
937 /* Import the key */
Ronald Cron5425a212020-08-04 14:58:35 +0200938 PSA_ASSERT( psa_import_key( &attributes, data->x, data->len, &key ) );
Moran Pekerf709f4a2018-06-06 17:26:04 +0300939
Gilles Peskine49c25912018-10-29 15:15:31 +0100940 /* Export the public key */
941 ASSERT_ALLOC( exported, export_size );
Ronald Cron5425a212020-08-04 14:58:35 +0200942 status = psa_export_public_key( key,
Gilles Peskine2d277862018-06-18 15:41:12 +0200943 exported, export_size,
944 &exported_length );
Gilles Peskinefe11b722018-12-18 00:24:04 +0100945 TEST_EQUAL( status, expected_export_status );
Gilles Peskine49c25912018-10-29 15:15:31 +0100946 if( status == PSA_SUCCESS )
Gilles Peskined8b7d4f2018-10-29 15:18:41 +0100947 {
Gilles Peskinec93b80c2019-05-16 19:39:54 +0200948 psa_key_type_t public_type = PSA_KEY_TYPE_PUBLIC_KEY_OF_KEY_PAIR( type );
Gilles Peskined8b7d4f2018-10-29 15:18:41 +0100949 size_t bits;
Ronald Cron5425a212020-08-04 14:58:35 +0200950 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +0200951 bits = psa_get_key_bits( &attributes );
Gilles Peskined8b7d4f2018-10-29 15:18:41 +0100952 TEST_ASSERT( expected_public_key->len <=
gabor-mezei-armcbcec212020-12-18 14:23:51 +0100953 PSA_EXPORT_KEY_OUTPUT_SIZE( public_type, bits ) );
gabor-mezei-armceface22021-01-21 12:26:17 +0100954 TEST_ASSERT( expected_public_key->len <=
955 PSA_EXPORT_PUBLIC_KEY_OUTPUT_SIZE( public_type, bits ) );
956 TEST_ASSERT( expected_public_key->len <=
957 PSA_EXPORT_PUBLIC_KEY_MAX_SIZE );
Gilles Peskine49c25912018-10-29 15:15:31 +0100958 ASSERT_COMPARE( expected_public_key->x, expected_public_key->len,
959 exported, exported_length );
Gilles Peskined8b7d4f2018-10-29 15:18:41 +0100960 }
Moran Pekerf709f4a2018-06-06 17:26:04 +0300961exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +0100962 /*
963 * Key attributes may have been returned by psa_get_key_attributes()
964 * thus reset them as required.
965 */
966 psa_reset_key_attributes( &attributes );
967
itayzafrir3e02b3b2018-06-12 17:06:52 +0300968 mbedtls_free( exported );
Ronald Cron5425a212020-08-04 14:58:35 +0200969 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +0200970 PSA_DONE( );
Moran Pekerf709f4a2018-06-06 17:26:04 +0300971}
972/* END_CASE */
973
Gilles Peskine20035e32018-02-03 22:44:14 +0100974/* BEGIN_CASE */
Gilles Peskinea680c7a2018-06-26 16:12:43 +0200975void import_and_exercise_key( data_t *data,
976 int type_arg,
977 int bits_arg,
978 int alg_arg )
979{
Ronald Cron5425a212020-08-04 14:58:35 +0200980 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskinea680c7a2018-06-26 16:12:43 +0200981 psa_key_type_t type = type_arg;
982 size_t bits = bits_arg;
983 psa_algorithm_t alg = alg_arg;
Gilles Peskinec18e25f2021-02-12 23:48:20 +0100984 psa_key_usage_t usage = mbedtls_test_psa_usage_to_exercise( type, alg );
Gilles Peskine4747d192019-04-17 15:05:45 +0200985 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +0200986 psa_key_attributes_t got_attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskinea680c7a2018-06-26 16:12:43 +0200987
Gilles Peskine8817f612018-12-18 00:18:46 +0100988 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskinea680c7a2018-06-26 16:12:43 +0200989
Gilles Peskine4747d192019-04-17 15:05:45 +0200990 psa_set_key_usage_flags( &attributes, usage );
991 psa_set_key_algorithm( &attributes, alg );
992 psa_set_key_type( &attributes, type );
Gilles Peskinea680c7a2018-06-26 16:12:43 +0200993
994 /* Import the key */
Ronald Cron5425a212020-08-04 14:58:35 +0200995 PSA_ASSERT( psa_import_key( &attributes, data->x, data->len, &key ) );
Gilles Peskinea680c7a2018-06-26 16:12:43 +0200996
997 /* Test the key information */
Ronald Cron5425a212020-08-04 14:58:35 +0200998 PSA_ASSERT( psa_get_key_attributes( key, &got_attributes ) );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +0200999 TEST_EQUAL( psa_get_key_type( &got_attributes ), type );
1000 TEST_EQUAL( psa_get_key_bits( &got_attributes ), bits );
Gilles Peskinea680c7a2018-06-26 16:12:43 +02001001
1002 /* Do something with the key according to its type and permitted usage. */
Gilles Peskinec18e25f2021-02-12 23:48:20 +01001003 if( ! mbedtls_test_psa_exercise_key( key, usage, alg ) )
Gilles Peskine02b75072018-07-01 22:31:34 +02001004 goto exit;
Gilles Peskinea680c7a2018-06-26 16:12:43 +02001005
Ronald Cron5425a212020-08-04 14:58:35 +02001006 PSA_ASSERT( psa_destroy_key( key ) );
1007 test_operations_on_invalid_key( key );
Gilles Peskine4cf3a432019-04-18 22:28:52 +02001008
Gilles Peskinea680c7a2018-06-26 16:12:43 +02001009exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +01001010 /*
1011 * Key attributes may have been returned by psa_get_key_attributes()
1012 * thus reset them as required.
1013 */
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02001014 psa_reset_key_attributes( &got_attributes );
Ronald Cron3a4f0e32020-11-19 17:55:23 +01001015
1016 psa_reset_key_attributes( &attributes );
1017 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02001018 PSA_DONE( );
Gilles Peskinea680c7a2018-06-26 16:12:43 +02001019}
1020/* END_CASE */
1021
1022/* BEGIN_CASE */
Gilles Peskine06c28892019-11-26 18:07:46 +01001023void effective_key_attributes( int type_arg, int expected_type_arg,
1024 int bits_arg, int expected_bits_arg,
1025 int usage_arg, int expected_usage_arg,
1026 int alg_arg, int expected_alg_arg )
Gilles Peskined5b33222018-06-18 22:20:03 +02001027{
Ronald Cron5425a212020-08-04 14:58:35 +02001028 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine1a960492019-11-26 17:12:21 +01001029 psa_key_type_t key_type = type_arg;
Gilles Peskine06c28892019-11-26 18:07:46 +01001030 psa_key_type_t expected_key_type = expected_type_arg;
Gilles Peskine1a960492019-11-26 17:12:21 +01001031 size_t bits = bits_arg;
Gilles Peskine06c28892019-11-26 18:07:46 +01001032 size_t expected_bits = expected_bits_arg;
Gilles Peskined5b33222018-06-18 22:20:03 +02001033 psa_algorithm_t alg = alg_arg;
Gilles Peskine06c28892019-11-26 18:07:46 +01001034 psa_algorithm_t expected_alg = expected_alg_arg;
Gilles Peskined5b33222018-06-18 22:20:03 +02001035 psa_key_usage_t usage = usage_arg;
Gilles Peskine06c28892019-11-26 18:07:46 +01001036 psa_key_usage_t expected_usage = expected_usage_arg;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001037 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskined5b33222018-06-18 22:20:03 +02001038
Gilles Peskine8817f612018-12-18 00:18:46 +01001039 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskined5b33222018-06-18 22:20:03 +02001040
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001041 psa_set_key_usage_flags( &attributes, usage );
1042 psa_set_key_algorithm( &attributes, alg );
1043 psa_set_key_type( &attributes, key_type );
Gilles Peskine1a960492019-11-26 17:12:21 +01001044 psa_set_key_bits( &attributes, bits );
Gilles Peskined5b33222018-06-18 22:20:03 +02001045
Ronald Cron5425a212020-08-04 14:58:35 +02001046 PSA_ASSERT( psa_generate_key( &attributes, &key ) );
Gilles Peskine1a960492019-11-26 17:12:21 +01001047 psa_reset_key_attributes( &attributes );
Gilles Peskined5b33222018-06-18 22:20:03 +02001048
Ronald Cron5425a212020-08-04 14:58:35 +02001049 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
Gilles Peskine06c28892019-11-26 18:07:46 +01001050 TEST_EQUAL( psa_get_key_type( &attributes ), expected_key_type );
1051 TEST_EQUAL( psa_get_key_bits( &attributes ), expected_bits );
1052 TEST_EQUAL( psa_get_key_usage_flags( &attributes ), expected_usage );
1053 TEST_EQUAL( psa_get_key_algorithm( &attributes ), expected_alg );
Gilles Peskined5b33222018-06-18 22:20:03 +02001054
1055exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +01001056 /*
1057 * Key attributes may have been returned by psa_get_key_attributes()
1058 * thus reset them as required.
1059 */
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02001060 psa_reset_key_attributes( &attributes );
Ronald Cron3a4f0e32020-11-19 17:55:23 +01001061
1062 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02001063 PSA_DONE( );
Gilles Peskined5b33222018-06-18 22:20:03 +02001064}
1065/* END_CASE */
1066
1067/* BEGIN_CASE */
Gilles Peskine06c28892019-11-26 18:07:46 +01001068void check_key_policy( int type_arg, int bits_arg,
1069 int usage_arg, int alg_arg )
1070{
1071 test_effective_key_attributes( type_arg, type_arg, bits_arg, bits_arg,
gabor-mezei-armff8264c2021-06-28 14:36:03 +02001072 usage_arg,
1073 mbedtls_test_update_key_usage_flags( usage_arg ),
gabor-mezei-armedf2df82021-05-13 16:17:16 +02001074 alg_arg, alg_arg );
Gilles Peskine06c28892019-11-26 18:07:46 +01001075 goto exit;
1076}
1077/* END_CASE */
1078
1079/* BEGIN_CASE */
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001080void key_attributes_init( )
Jaeden Amero70261c52019-01-04 11:47:20 +00001081{
1082 /* Test each valid way of initializing the object, except for `= {0}`, as
1083 * Clang 5 complains when `-Wmissing-field-initializers` is used, even
1084 * though it's OK by the C standard. We could test for this, but we'd need
1085 * to supress the Clang warning for the test. */
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001086 psa_key_attributes_t func = psa_key_attributes_init( );
1087 psa_key_attributes_t init = PSA_KEY_ATTRIBUTES_INIT;
1088 psa_key_attributes_t zero;
Jaeden Amero70261c52019-01-04 11:47:20 +00001089
1090 memset( &zero, 0, sizeof( zero ) );
1091
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001092 TEST_EQUAL( psa_get_key_lifetime( &func ), PSA_KEY_LIFETIME_VOLATILE );
1093 TEST_EQUAL( psa_get_key_lifetime( &init ), PSA_KEY_LIFETIME_VOLATILE );
1094 TEST_EQUAL( psa_get_key_lifetime( &zero ), PSA_KEY_LIFETIME_VOLATILE );
Jaeden Amero5229bbb2019-02-07 16:33:37 +00001095
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001096 TEST_EQUAL( psa_get_key_type( &func ), 0 );
1097 TEST_EQUAL( psa_get_key_type( &init ), 0 );
1098 TEST_EQUAL( psa_get_key_type( &zero ), 0 );
1099
1100 TEST_EQUAL( psa_get_key_bits( &func ), 0 );
1101 TEST_EQUAL( psa_get_key_bits( &init ), 0 );
1102 TEST_EQUAL( psa_get_key_bits( &zero ), 0 );
1103
1104 TEST_EQUAL( psa_get_key_usage_flags( &func ), 0 );
1105 TEST_EQUAL( psa_get_key_usage_flags( &init ), 0 );
1106 TEST_EQUAL( psa_get_key_usage_flags( &zero ), 0 );
1107
1108 TEST_EQUAL( psa_get_key_algorithm( &func ), 0 );
1109 TEST_EQUAL( psa_get_key_algorithm( &init ), 0 );
1110 TEST_EQUAL( psa_get_key_algorithm( &zero ), 0 );
Jaeden Amero70261c52019-01-04 11:47:20 +00001111}
1112/* END_CASE */
1113
1114/* BEGIN_CASE */
gabor-mezei-armedf2df82021-05-13 16:17:16 +02001115void mac_key_policy( int policy_usage_arg,
1116 int policy_alg_arg,
1117 int key_type_arg,
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001118 data_t *key_data,
gabor-mezei-armedf2df82021-05-13 16:17:16 +02001119 int exercise_alg_arg,
Mateusz Starzykd07f4fc2021-08-24 11:01:23 +02001120 int expected_status_sign_arg,
1121 int expected_status_verify_arg )
Gilles Peskined5b33222018-06-18 22:20:03 +02001122{
Ronald Cron5425a212020-08-04 14:58:35 +02001123 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001124 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Jaeden Amero769ce272019-01-04 11:48:03 +00001125 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
gabor-mezei-armedf2df82021-05-13 16:17:16 +02001126 psa_key_type_t key_type = key_type_arg;
1127 psa_algorithm_t policy_alg = policy_alg_arg;
1128 psa_algorithm_t exercise_alg = exercise_alg_arg;
1129 psa_key_usage_t policy_usage = policy_usage_arg;
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001130 psa_status_t status;
Mateusz Starzykd07f4fc2021-08-24 11:01:23 +02001131 psa_status_t expected_status_sign = expected_status_sign_arg;
1132 psa_status_t expected_status_verify = expected_status_verify_arg;
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001133 unsigned char mac[PSA_MAC_MAX_SIZE];
Gilles Peskined5b33222018-06-18 22:20:03 +02001134
Gilles Peskine8817f612018-12-18 00:18:46 +01001135 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskined5b33222018-06-18 22:20:03 +02001136
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001137 psa_set_key_usage_flags( &attributes, policy_usage );
1138 psa_set_key_algorithm( &attributes, policy_alg );
1139 psa_set_key_type( &attributes, key_type );
Gilles Peskined5b33222018-06-18 22:20:03 +02001140
Gilles Peskine049c7532019-05-15 20:22:09 +02001141 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02001142 &key ) );
Gilles Peskined5b33222018-06-18 22:20:03 +02001143
gabor-mezei-arm40d5cd82021-06-29 11:06:16 +02001144 TEST_EQUAL( psa_get_key_usage_flags( &attributes ),
1145 mbedtls_test_update_key_usage_flags( policy_usage ) );
gabor-mezei-armedf2df82021-05-13 16:17:16 +02001146
Ronald Cron5425a212020-08-04 14:58:35 +02001147 status = psa_mac_sign_setup( &operation, key, exercise_alg );
Mateusz Starzykd07f4fc2021-08-24 11:01:23 +02001148 TEST_EQUAL( status, expected_status_sign );
Steven Cooremanb3ce8152021-02-18 12:03:50 +01001149
Mateusz Starzyk1ebcd552021-08-30 17:09:03 +02001150 /* Calculate the MAC, one-shot case. */
1151 uint8_t input[128] = {0};
1152 size_t mac_len;
1153 TEST_EQUAL( psa_mac_compute( key, exercise_alg,
1154 input, 128,
1155 mac, PSA_MAC_MAX_SIZE, &mac_len ),
1156 expected_status_sign );
1157
1158 /* Verify correct MAC, one-shot case. */
1159 status = psa_mac_verify( key, exercise_alg, input, 128,
1160 mac, mac_len );
1161
1162 if( expected_status_sign != PSA_SUCCESS && expected_status_verify == PSA_SUCCESS )
1163 TEST_EQUAL( status, PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine8817f612018-12-18 00:18:46 +01001164 else
Mateusz Starzyk1ebcd552021-08-30 17:09:03 +02001165 TEST_EQUAL( status, expected_status_verify );
Gilles Peskinefe11b722018-12-18 00:24:04 +01001166
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001167 psa_mac_abort( &operation );
Gilles Peskined5b33222018-06-18 22:20:03 +02001168
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001169 memset( mac, 0, sizeof( mac ) );
Ronald Cron5425a212020-08-04 14:58:35 +02001170 status = psa_mac_verify_setup( &operation, key, exercise_alg );
Mateusz Starzykd07f4fc2021-08-24 11:01:23 +02001171 TEST_EQUAL( status, expected_status_verify );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001172
1173exit:
1174 psa_mac_abort( &operation );
Ronald Cron5425a212020-08-04 14:58:35 +02001175 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02001176 PSA_DONE( );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001177}
1178/* END_CASE */
1179
1180/* BEGIN_CASE */
gabor-mezei-armedf2df82021-05-13 16:17:16 +02001181void cipher_key_policy( int policy_usage_arg,
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001182 int policy_alg,
1183 int key_type,
1184 data_t *key_data,
1185 int exercise_alg )
1186{
Ronald Cron5425a212020-08-04 14:58:35 +02001187 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001188 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Jaeden Amero5bae2272019-01-04 11:48:27 +00001189 psa_cipher_operation_t operation = PSA_CIPHER_OPERATION_INIT;
gabor-mezei-armedf2df82021-05-13 16:17:16 +02001190 psa_key_usage_t policy_usage = policy_usage_arg;
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001191 psa_status_t status;
1192
Gilles Peskine8817f612018-12-18 00:18:46 +01001193 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001194
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001195 psa_set_key_usage_flags( &attributes, policy_usage );
1196 psa_set_key_algorithm( &attributes, policy_alg );
1197 psa_set_key_type( &attributes, key_type );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001198
Gilles Peskine049c7532019-05-15 20:22:09 +02001199 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02001200 &key ) );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001201
gabor-mezei-arm98a34352021-06-28 14:05:00 +02001202 /* Check if no key usage flag implication is done */
1203 TEST_EQUAL( policy_usage,
1204 mbedtls_test_update_key_usage_flags( policy_usage ) );
gabor-mezei-armedf2df82021-05-13 16:17:16 +02001205
Ronald Cron5425a212020-08-04 14:58:35 +02001206 status = psa_cipher_encrypt_setup( &operation, key, exercise_alg );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001207 if( policy_alg == exercise_alg &&
1208 ( policy_usage & PSA_KEY_USAGE_ENCRYPT ) != 0 )
Gilles Peskine8817f612018-12-18 00:18:46 +01001209 PSA_ASSERT( status );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001210 else
Gilles Peskinefe11b722018-12-18 00:24:04 +01001211 TEST_EQUAL( status, PSA_ERROR_NOT_PERMITTED );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001212 psa_cipher_abort( &operation );
1213
Ronald Cron5425a212020-08-04 14:58:35 +02001214 status = psa_cipher_decrypt_setup( &operation, key, exercise_alg );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001215 if( policy_alg == exercise_alg &&
1216 ( policy_usage & PSA_KEY_USAGE_DECRYPT ) != 0 )
Gilles Peskine8817f612018-12-18 00:18:46 +01001217 PSA_ASSERT( status );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001218 else
Gilles Peskinefe11b722018-12-18 00:24:04 +01001219 TEST_EQUAL( status, PSA_ERROR_NOT_PERMITTED );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001220
1221exit:
1222 psa_cipher_abort( &operation );
Ronald Cron5425a212020-08-04 14:58:35 +02001223 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02001224 PSA_DONE( );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001225}
1226/* END_CASE */
1227
1228/* BEGIN_CASE */
gabor-mezei-armedf2df82021-05-13 16:17:16 +02001229void aead_key_policy( int policy_usage_arg,
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001230 int policy_alg,
1231 int key_type,
1232 data_t *key_data,
1233 int nonce_length_arg,
1234 int tag_length_arg,
Steven Cooremanb3ce8152021-02-18 12:03:50 +01001235 int exercise_alg,
1236 int expected_status_arg )
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001237{
Ronald Cron5425a212020-08-04 14:58:35 +02001238 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001239 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
gabor-mezei-armedf2df82021-05-13 16:17:16 +02001240 psa_key_usage_t policy_usage = policy_usage_arg;
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001241 psa_status_t status;
Steven Cooremanb3ce8152021-02-18 12:03:50 +01001242 psa_status_t expected_status = expected_status_arg;
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001243 unsigned char nonce[16] = {0};
1244 size_t nonce_length = nonce_length_arg;
1245 unsigned char tag[16];
1246 size_t tag_length = tag_length_arg;
1247 size_t output_length;
1248
1249 TEST_ASSERT( nonce_length <= sizeof( nonce ) );
1250 TEST_ASSERT( tag_length <= sizeof( tag ) );
1251
Gilles Peskine8817f612018-12-18 00:18:46 +01001252 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001253
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001254 psa_set_key_usage_flags( &attributes, policy_usage );
1255 psa_set_key_algorithm( &attributes, policy_alg );
1256 psa_set_key_type( &attributes, key_type );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001257
Gilles Peskine049c7532019-05-15 20:22:09 +02001258 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02001259 &key ) );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001260
gabor-mezei-arm98a34352021-06-28 14:05:00 +02001261 /* Check if no key usage implication is done */
1262 TEST_EQUAL( policy_usage,
1263 mbedtls_test_update_key_usage_flags( policy_usage ) );
gabor-mezei-armedf2df82021-05-13 16:17:16 +02001264
Ronald Cron5425a212020-08-04 14:58:35 +02001265 status = psa_aead_encrypt( key, exercise_alg,
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001266 nonce, nonce_length,
1267 NULL, 0,
1268 NULL, 0,
1269 tag, tag_length,
1270 &output_length );
Steven Cooremanb3ce8152021-02-18 12:03:50 +01001271 if( ( policy_usage & PSA_KEY_USAGE_ENCRYPT ) != 0 )
1272 TEST_EQUAL( status, expected_status );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001273 else
Gilles Peskinefe11b722018-12-18 00:24:04 +01001274 TEST_EQUAL( status, PSA_ERROR_NOT_PERMITTED );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001275
1276 memset( tag, 0, sizeof( tag ) );
Ronald Cron5425a212020-08-04 14:58:35 +02001277 status = psa_aead_decrypt( key, exercise_alg,
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001278 nonce, nonce_length,
1279 NULL, 0,
1280 tag, tag_length,
1281 NULL, 0,
1282 &output_length );
Steven Cooremanb3ce8152021-02-18 12:03:50 +01001283 if( ( policy_usage & PSA_KEY_USAGE_DECRYPT ) == 0 )
1284 TEST_EQUAL( status, PSA_ERROR_NOT_PERMITTED );
1285 else if( expected_status == PSA_SUCCESS )
Gilles Peskinefe11b722018-12-18 00:24:04 +01001286 TEST_EQUAL( status, PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001287 else
Steven Cooremanb3ce8152021-02-18 12:03:50 +01001288 TEST_EQUAL( status, expected_status );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001289
1290exit:
Ronald Cron5425a212020-08-04 14:58:35 +02001291 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02001292 PSA_DONE( );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001293}
1294/* END_CASE */
1295
1296/* BEGIN_CASE */
gabor-mezei-armedf2df82021-05-13 16:17:16 +02001297void asymmetric_encryption_key_policy( int policy_usage_arg,
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001298 int policy_alg,
1299 int key_type,
1300 data_t *key_data,
1301 int exercise_alg )
1302{
Ronald Cron5425a212020-08-04 14:58:35 +02001303 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001304 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
gabor-mezei-armedf2df82021-05-13 16:17:16 +02001305 psa_key_usage_t policy_usage = policy_usage_arg;
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001306 psa_status_t status;
1307 size_t key_bits;
1308 size_t buffer_length;
1309 unsigned char *buffer = NULL;
1310 size_t output_length;
1311
Gilles Peskine8817f612018-12-18 00:18:46 +01001312 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001313
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001314 psa_set_key_usage_flags( &attributes, policy_usage );
1315 psa_set_key_algorithm( &attributes, policy_alg );
1316 psa_set_key_type( &attributes, key_type );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001317
Gilles Peskine049c7532019-05-15 20:22:09 +02001318 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02001319 &key ) );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001320
gabor-mezei-arm98a34352021-06-28 14:05:00 +02001321 /* Check if no key usage implication is done */
1322 TEST_EQUAL( policy_usage,
1323 mbedtls_test_update_key_usage_flags( policy_usage ) );
gabor-mezei-armedf2df82021-05-13 16:17:16 +02001324
Ronald Cron5425a212020-08-04 14:58:35 +02001325 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001326 key_bits = psa_get_key_bits( &attributes );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001327 buffer_length = PSA_ASYMMETRIC_ENCRYPT_OUTPUT_SIZE( key_type, key_bits,
1328 exercise_alg );
Gilles Peskine8cebbba2018-09-27 13:54:18 +02001329 ASSERT_ALLOC( buffer, buffer_length );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001330
Ronald Cron5425a212020-08-04 14:58:35 +02001331 status = psa_asymmetric_encrypt( key, exercise_alg,
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001332 NULL, 0,
1333 NULL, 0,
1334 buffer, buffer_length,
1335 &output_length );
1336 if( policy_alg == exercise_alg &&
1337 ( policy_usage & PSA_KEY_USAGE_ENCRYPT ) != 0 )
Gilles Peskine8817f612018-12-18 00:18:46 +01001338 PSA_ASSERT( status );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001339 else
Gilles Peskinefe11b722018-12-18 00:24:04 +01001340 TEST_EQUAL( status, PSA_ERROR_NOT_PERMITTED );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001341
Gilles Peskinef7ab5ad2018-09-26 18:19:24 +02001342 if( buffer_length != 0 )
1343 memset( buffer, 0, buffer_length );
Ronald Cron5425a212020-08-04 14:58:35 +02001344 status = psa_asymmetric_decrypt( key, exercise_alg,
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001345 buffer, buffer_length,
1346 NULL, 0,
1347 buffer, buffer_length,
1348 &output_length );
1349 if( policy_alg == exercise_alg &&
1350 ( policy_usage & PSA_KEY_USAGE_DECRYPT ) != 0 )
Gilles Peskinefe11b722018-12-18 00:24:04 +01001351 TEST_EQUAL( status, PSA_ERROR_INVALID_PADDING );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001352 else
Gilles Peskinefe11b722018-12-18 00:24:04 +01001353 TEST_EQUAL( status, PSA_ERROR_NOT_PERMITTED );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001354
1355exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +01001356 /*
1357 * Key attributes may have been returned by psa_get_key_attributes()
1358 * thus reset them as required.
1359 */
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02001360 psa_reset_key_attributes( &attributes );
Ronald Cron3a4f0e32020-11-19 17:55:23 +01001361
1362 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02001363 PSA_DONE( );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001364 mbedtls_free( buffer );
1365}
1366/* END_CASE */
1367
1368/* BEGIN_CASE */
gabor-mezei-armedf2df82021-05-13 16:17:16 +02001369void asymmetric_signature_key_policy( int policy_usage_arg,
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001370 int policy_alg,
1371 int key_type,
1372 data_t *key_data,
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001373 int exercise_alg,
gabor-mezei-armedf2df82021-05-13 16:17:16 +02001374 int payload_length_arg,
gabor-mezei-armedf2df82021-05-13 16:17:16 +02001375 int expected_usage_arg )
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001376{
Ronald Cron5425a212020-08-04 14:58:35 +02001377 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001378 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
gabor-mezei-armedf2df82021-05-13 16:17:16 +02001379 psa_key_usage_t policy_usage = policy_usage_arg;
1380 psa_key_usage_t expected_usage = expected_usage_arg;
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001381 psa_status_t status;
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001382 unsigned char payload[PSA_HASH_MAX_SIZE] = {1};
1383 /* If `payload_length_arg > 0`, `exercise_alg` is supposed to be
1384 * compatible with the policy and `payload_length_arg` is supposed to be
1385 * a valid input length to sign. If `payload_length_arg <= 0`,
1386 * `exercise_alg` is supposed to be forbidden by the policy. */
1387 int compatible_alg = payload_length_arg > 0;
1388 size_t payload_length = compatible_alg ? payload_length_arg : 0;
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001389 unsigned char signature[PSA_SIGNATURE_MAX_SIZE] = {0};
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001390 size_t signature_length;
1391
gabor-mezei-arm98a34352021-06-28 14:05:00 +02001392 /* Check if all implicit usage flags are deployed
gabor-mezei-armedf2df82021-05-13 16:17:16 +02001393 in the expected usage flags. */
gabor-mezei-arm98a34352021-06-28 14:05:00 +02001394 TEST_EQUAL( expected_usage,
1395 mbedtls_test_update_key_usage_flags( policy_usage ) );
gabor-mezei-armedf2df82021-05-13 16:17:16 +02001396
Gilles Peskine8817f612018-12-18 00:18:46 +01001397 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001398
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001399 psa_set_key_usage_flags( &attributes, policy_usage );
1400 psa_set_key_algorithm( &attributes, policy_alg );
1401 psa_set_key_type( &attributes, key_type );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001402
Gilles Peskine049c7532019-05-15 20:22:09 +02001403 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02001404 &key ) );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001405
gabor-mezei-armedf2df82021-05-13 16:17:16 +02001406 TEST_EQUAL( psa_get_key_usage_flags( &attributes ), expected_usage );
1407
Ronald Cron5425a212020-08-04 14:58:35 +02001408 status = psa_sign_hash( key, exercise_alg,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001409 payload, payload_length,
1410 signature, sizeof( signature ),
1411 &signature_length );
gabor-mezei-armedf2df82021-05-13 16:17:16 +02001412 if( compatible_alg && ( expected_usage & PSA_KEY_USAGE_SIGN_HASH ) != 0 )
Gilles Peskine8817f612018-12-18 00:18:46 +01001413 PSA_ASSERT( status );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001414 else
Gilles Peskinefe11b722018-12-18 00:24:04 +01001415 TEST_EQUAL( status, PSA_ERROR_NOT_PERMITTED );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001416
1417 memset( signature, 0, sizeof( signature ) );
Ronald Cron5425a212020-08-04 14:58:35 +02001418 status = psa_verify_hash( key, exercise_alg,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001419 payload, payload_length,
1420 signature, sizeof( signature ) );
gabor-mezei-armedf2df82021-05-13 16:17:16 +02001421 if( compatible_alg && ( expected_usage & PSA_KEY_USAGE_VERIFY_HASH ) != 0 )
Gilles Peskinefe11b722018-12-18 00:24:04 +01001422 TEST_EQUAL( status, PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001423 else
Gilles Peskinefe11b722018-12-18 00:24:04 +01001424 TEST_EQUAL( status, PSA_ERROR_NOT_PERMITTED );
Gilles Peskined5b33222018-06-18 22:20:03 +02001425
Gilles Peskinef7b41372021-09-22 16:15:05 +02001426 if( PSA_ALG_IS_SIGN_HASH( exercise_alg ) &&
gabor-mezei-armd851d682021-06-28 14:53:49 +02001427 PSA_ALG_IS_HASH( PSA_ALG_SIGN_GET_HASH( exercise_alg ) ) )
gabor-mezei-armedf2df82021-05-13 16:17:16 +02001428 {
1429 status = psa_sign_message( key, exercise_alg,
1430 payload, payload_length,
1431 signature, sizeof( signature ),
1432 &signature_length );
1433 if( compatible_alg && ( expected_usage & PSA_KEY_USAGE_SIGN_MESSAGE ) != 0 )
1434 PSA_ASSERT( status );
1435 else
1436 TEST_EQUAL( status, PSA_ERROR_NOT_PERMITTED );
1437
1438 memset( signature, 0, sizeof( signature ) );
1439 status = psa_verify_message( key, exercise_alg,
1440 payload, payload_length,
1441 signature, sizeof( signature ) );
1442 if( compatible_alg && ( expected_usage & PSA_KEY_USAGE_VERIFY_MESSAGE ) != 0 )
1443 TEST_EQUAL( status, PSA_ERROR_INVALID_SIGNATURE );
1444 else
1445 TEST_EQUAL( status, PSA_ERROR_NOT_PERMITTED );
1446 }
1447
Gilles Peskined5b33222018-06-18 22:20:03 +02001448exit:
Ronald Cron5425a212020-08-04 14:58:35 +02001449 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02001450 PSA_DONE( );
Gilles Peskined5b33222018-06-18 22:20:03 +02001451}
1452/* END_CASE */
1453
Janos Follathba3fab92019-06-11 14:50:16 +01001454/* BEGIN_CASE */
Gilles Peskineea0fb492018-07-12 17:17:20 +02001455void derive_key_policy( int policy_usage,
1456 int policy_alg,
1457 int key_type,
1458 data_t *key_data,
1459 int exercise_alg )
1460{
Ronald Cron5425a212020-08-04 14:58:35 +02001461 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001462 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02001463 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Gilles Peskineea0fb492018-07-12 17:17:20 +02001464 psa_status_t status;
1465
Gilles Peskine8817f612018-12-18 00:18:46 +01001466 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskineea0fb492018-07-12 17:17:20 +02001467
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001468 psa_set_key_usage_flags( &attributes, policy_usage );
1469 psa_set_key_algorithm( &attributes, policy_alg );
1470 psa_set_key_type( &attributes, key_type );
Gilles Peskineea0fb492018-07-12 17:17:20 +02001471
Gilles Peskine049c7532019-05-15 20:22:09 +02001472 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02001473 &key ) );
Gilles Peskineea0fb492018-07-12 17:17:20 +02001474
Janos Follathba3fab92019-06-11 14:50:16 +01001475 PSA_ASSERT( psa_key_derivation_setup( &operation, exercise_alg ) );
1476
1477 if( PSA_ALG_IS_TLS12_PRF( exercise_alg ) ||
1478 PSA_ALG_IS_TLS12_PSK_TO_MS( exercise_alg ) )
Janos Follath0c1ed842019-06-28 13:35:36 +01001479 {
Janos Follathba3fab92019-06-11 14:50:16 +01001480 PSA_ASSERT( psa_key_derivation_input_bytes(
1481 &operation,
1482 PSA_KEY_DERIVATION_INPUT_SEED,
1483 (const uint8_t*) "", 0) );
Janos Follath0c1ed842019-06-28 13:35:36 +01001484 }
Janos Follathba3fab92019-06-11 14:50:16 +01001485
1486 status = psa_key_derivation_input_key( &operation,
1487 PSA_KEY_DERIVATION_INPUT_SECRET,
Ronald Cron5425a212020-08-04 14:58:35 +02001488 key );
Janos Follathba3fab92019-06-11 14:50:16 +01001489
Gilles Peskineea0fb492018-07-12 17:17:20 +02001490 if( policy_alg == exercise_alg &&
1491 ( policy_usage & PSA_KEY_USAGE_DERIVE ) != 0 )
Gilles Peskine8817f612018-12-18 00:18:46 +01001492 PSA_ASSERT( status );
Gilles Peskineea0fb492018-07-12 17:17:20 +02001493 else
Gilles Peskinefe11b722018-12-18 00:24:04 +01001494 TEST_EQUAL( status, PSA_ERROR_NOT_PERMITTED );
Gilles Peskineea0fb492018-07-12 17:17:20 +02001495
1496exit:
Gilles Peskine51ae0e42019-05-16 17:31:03 +02001497 psa_key_derivation_abort( &operation );
Ronald Cron5425a212020-08-04 14:58:35 +02001498 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02001499 PSA_DONE( );
Gilles Peskineea0fb492018-07-12 17:17:20 +02001500}
1501/* END_CASE */
1502
1503/* BEGIN_CASE */
Gilles Peskine01d718c2018-09-18 12:01:02 +02001504void agreement_key_policy( int policy_usage,
1505 int policy_alg,
1506 int key_type_arg,
1507 data_t *key_data,
Steven Cooremance48e852020-10-05 16:02:45 +02001508 int exercise_alg,
1509 int expected_status_arg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02001510{
Ronald Cron5425a212020-08-04 14:58:35 +02001511 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001512 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine01d718c2018-09-18 12:01:02 +02001513 psa_key_type_t key_type = key_type_arg;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02001514 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Gilles Peskine01d718c2018-09-18 12:01:02 +02001515 psa_status_t status;
Steven Cooremance48e852020-10-05 16:02:45 +02001516 psa_status_t expected_status = expected_status_arg;
Gilles Peskine01d718c2018-09-18 12:01:02 +02001517
Gilles Peskine8817f612018-12-18 00:18:46 +01001518 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine01d718c2018-09-18 12:01:02 +02001519
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001520 psa_set_key_usage_flags( &attributes, policy_usage );
1521 psa_set_key_algorithm( &attributes, policy_alg );
1522 psa_set_key_type( &attributes, key_type );
Gilles Peskine01d718c2018-09-18 12:01:02 +02001523
Gilles Peskine049c7532019-05-15 20:22:09 +02001524 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02001525 &key ) );
Gilles Peskine01d718c2018-09-18 12:01:02 +02001526
Gilles Peskine51ae0e42019-05-16 17:31:03 +02001527 PSA_ASSERT( psa_key_derivation_setup( &operation, exercise_alg ) );
Gilles Peskinec18e25f2021-02-12 23:48:20 +01001528 status = mbedtls_test_psa_key_agreement_with_self( &operation, key );
Gilles Peskine01d718c2018-09-18 12:01:02 +02001529
Steven Cooremance48e852020-10-05 16:02:45 +02001530 TEST_EQUAL( status, expected_status );
Gilles Peskine01d718c2018-09-18 12:01:02 +02001531
1532exit:
Gilles Peskine51ae0e42019-05-16 17:31:03 +02001533 psa_key_derivation_abort( &operation );
Ronald Cron5425a212020-08-04 14:58:35 +02001534 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02001535 PSA_DONE( );
Gilles Peskine01d718c2018-09-18 12:01:02 +02001536}
1537/* END_CASE */
1538
1539/* BEGIN_CASE */
Gilles Peskine96f0b3b2019-05-10 19:33:38 +02001540void key_policy_alg2( int key_type_arg, data_t *key_data,
1541 int usage_arg, int alg_arg, int alg2_arg )
1542{
Ronald Cron5425a212020-08-04 14:58:35 +02001543 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine96f0b3b2019-05-10 19:33:38 +02001544 psa_key_type_t key_type = key_type_arg;
1545 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
1546 psa_key_attributes_t got_attributes = PSA_KEY_ATTRIBUTES_INIT;
1547 psa_key_usage_t usage = usage_arg;
1548 psa_algorithm_t alg = alg_arg;
1549 psa_algorithm_t alg2 = alg2_arg;
1550
1551 PSA_ASSERT( psa_crypto_init( ) );
1552
1553 psa_set_key_usage_flags( &attributes, usage );
1554 psa_set_key_algorithm( &attributes, alg );
1555 psa_set_key_enrollment_algorithm( &attributes, alg2 );
1556 psa_set_key_type( &attributes, key_type );
1557 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02001558 &key ) );
Gilles Peskine96f0b3b2019-05-10 19:33:38 +02001559
gabor-mezei-arm98a34352021-06-28 14:05:00 +02001560 /* Update the usage flags to obtain implicit usage flags */
1561 usage = mbedtls_test_update_key_usage_flags( usage );
Ronald Cron5425a212020-08-04 14:58:35 +02001562 PSA_ASSERT( psa_get_key_attributes( key, &got_attributes ) );
Gilles Peskine96f0b3b2019-05-10 19:33:38 +02001563 TEST_EQUAL( psa_get_key_usage_flags( &got_attributes ), usage );
1564 TEST_EQUAL( psa_get_key_algorithm( &got_attributes ), alg );
1565 TEST_EQUAL( psa_get_key_enrollment_algorithm( &got_attributes ), alg2 );
1566
Gilles Peskinec18e25f2021-02-12 23:48:20 +01001567 if( ! mbedtls_test_psa_exercise_key( key, usage, alg ) )
Gilles Peskine96f0b3b2019-05-10 19:33:38 +02001568 goto exit;
Gilles Peskinec18e25f2021-02-12 23:48:20 +01001569 if( ! mbedtls_test_psa_exercise_key( key, usage, alg2 ) )
Gilles Peskine96f0b3b2019-05-10 19:33:38 +02001570 goto exit;
1571
1572exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +01001573 /*
1574 * Key attributes may have been returned by psa_get_key_attributes()
1575 * thus reset them as required.
1576 */
1577 psa_reset_key_attributes( &got_attributes );
1578
Ronald Cron5425a212020-08-04 14:58:35 +02001579 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02001580 PSA_DONE( );
Gilles Peskine96f0b3b2019-05-10 19:33:38 +02001581}
1582/* END_CASE */
1583
1584/* BEGIN_CASE */
Gilles Peskine04ee2d22019-04-11 21:25:46 +02001585void raw_agreement_key_policy( int policy_usage,
1586 int policy_alg,
1587 int key_type_arg,
1588 data_t *key_data,
Steven Cooremance48e852020-10-05 16:02:45 +02001589 int exercise_alg,
1590 int expected_status_arg )
Gilles Peskine04ee2d22019-04-11 21:25:46 +02001591{
Ronald Cron5425a212020-08-04 14:58:35 +02001592 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001593 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine04ee2d22019-04-11 21:25:46 +02001594 psa_key_type_t key_type = key_type_arg;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02001595 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Gilles Peskine04ee2d22019-04-11 21:25:46 +02001596 psa_status_t status;
Steven Cooremance48e852020-10-05 16:02:45 +02001597 psa_status_t expected_status = expected_status_arg;
Gilles Peskine04ee2d22019-04-11 21:25:46 +02001598
1599 PSA_ASSERT( psa_crypto_init( ) );
1600
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001601 psa_set_key_usage_flags( &attributes, policy_usage );
1602 psa_set_key_algorithm( &attributes, policy_alg );
1603 psa_set_key_type( &attributes, key_type );
Gilles Peskine04ee2d22019-04-11 21:25:46 +02001604
Gilles Peskine049c7532019-05-15 20:22:09 +02001605 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02001606 &key ) );
Gilles Peskine04ee2d22019-04-11 21:25:46 +02001607
Gilles Peskinec18e25f2021-02-12 23:48:20 +01001608 status = mbedtls_test_psa_raw_key_agreement_with_self( exercise_alg, key );
Gilles Peskine04ee2d22019-04-11 21:25:46 +02001609
Steven Cooremance48e852020-10-05 16:02:45 +02001610 TEST_EQUAL( status, expected_status );
Gilles Peskine04ee2d22019-04-11 21:25:46 +02001611
1612exit:
Gilles Peskine51ae0e42019-05-16 17:31:03 +02001613 psa_key_derivation_abort( &operation );
Ronald Cron5425a212020-08-04 14:58:35 +02001614 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02001615 PSA_DONE( );
Gilles Peskine04ee2d22019-04-11 21:25:46 +02001616}
1617/* END_CASE */
1618
1619/* BEGIN_CASE */
Gilles Peskinebcdd44b2019-05-20 17:28:11 +02001620void copy_success( int source_usage_arg,
1621 int source_alg_arg, int source_alg2_arg,
Archana8a180362021-07-05 02:18:48 +05301622 unsigned int source_lifetime_arg,
Gilles Peskine4a644642019-05-03 17:14:08 +02001623 int type_arg, data_t *material,
1624 int copy_attributes,
Gilles Peskinebcdd44b2019-05-20 17:28:11 +02001625 int target_usage_arg,
1626 int target_alg_arg, int target_alg2_arg,
Archana8a180362021-07-05 02:18:48 +05301627 unsigned int target_lifetime_arg,
Gilles Peskinebcdd44b2019-05-20 17:28:11 +02001628 int expected_usage_arg,
1629 int expected_alg_arg, int expected_alg2_arg )
Gilles Peskine57ab7212019-01-28 13:03:09 +01001630{
Gilles Peskineca25db92019-04-19 11:43:08 +02001631 psa_key_attributes_t source_attributes = PSA_KEY_ATTRIBUTES_INIT;
1632 psa_key_attributes_t target_attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine57ab7212019-01-28 13:03:09 +01001633 psa_key_usage_t expected_usage = expected_usage_arg;
1634 psa_algorithm_t expected_alg = expected_alg_arg;
Gilles Peskinebcdd44b2019-05-20 17:28:11 +02001635 psa_algorithm_t expected_alg2 = expected_alg2_arg;
Archana8a180362021-07-05 02:18:48 +05301636 psa_key_lifetime_t source_lifetime = source_lifetime_arg;
1637 psa_key_lifetime_t target_lifetime = target_lifetime_arg;
Ronald Cron5425a212020-08-04 14:58:35 +02001638 mbedtls_svc_key_id_t source_key = MBEDTLS_SVC_KEY_ID_INIT;
1639 mbedtls_svc_key_id_t target_key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine57ab7212019-01-28 13:03:09 +01001640 uint8_t *export_buffer = NULL;
1641
Gilles Peskine57ab7212019-01-28 13:03:09 +01001642 PSA_ASSERT( psa_crypto_init( ) );
1643
Gilles Peskineca25db92019-04-19 11:43:08 +02001644 /* Prepare the source key. */
1645 psa_set_key_usage_flags( &source_attributes, source_usage_arg );
1646 psa_set_key_algorithm( &source_attributes, source_alg_arg );
Gilles Peskinebcdd44b2019-05-20 17:28:11 +02001647 psa_set_key_enrollment_algorithm( &source_attributes, source_alg2_arg );
Gilles Peskineca25db92019-04-19 11:43:08 +02001648 psa_set_key_type( &source_attributes, type_arg );
Archana8a180362021-07-05 02:18:48 +05301649 psa_set_key_lifetime( &source_attributes, source_lifetime);
Gilles Peskine049c7532019-05-15 20:22:09 +02001650 PSA_ASSERT( psa_import_key( &source_attributes,
1651 material->x, material->len,
Ronald Cron5425a212020-08-04 14:58:35 +02001652 &source_key ) );
1653 PSA_ASSERT( psa_get_key_attributes( source_key, &source_attributes ) );
Gilles Peskine57ab7212019-01-28 13:03:09 +01001654
Gilles Peskineca25db92019-04-19 11:43:08 +02001655 /* Prepare the target attributes. */
1656 if( copy_attributes )
Ronald Cron65f38a32020-10-23 17:11:13 +02001657 {
Gilles Peskineca25db92019-04-19 11:43:08 +02001658 target_attributes = source_attributes;
Ronald Cron65f38a32020-10-23 17:11:13 +02001659 }
Archana8a180362021-07-05 02:18:48 +05301660 psa_set_key_lifetime( &target_attributes, target_lifetime);
Ronald Cron65f38a32020-10-23 17:11:13 +02001661
Gilles Peskineca25db92019-04-19 11:43:08 +02001662 if( target_usage_arg != -1 )
1663 psa_set_key_usage_flags( &target_attributes, target_usage_arg );
1664 if( target_alg_arg != -1 )
1665 psa_set_key_algorithm( &target_attributes, target_alg_arg );
Gilles Peskinebcdd44b2019-05-20 17:28:11 +02001666 if( target_alg2_arg != -1 )
1667 psa_set_key_enrollment_algorithm( &target_attributes, target_alg2_arg );
Gilles Peskine57ab7212019-01-28 13:03:09 +01001668
Archana8a180362021-07-05 02:18:48 +05301669
Gilles Peskine57ab7212019-01-28 13:03:09 +01001670 /* Copy the key. */
Ronald Cron5425a212020-08-04 14:58:35 +02001671 PSA_ASSERT( psa_copy_key( source_key,
1672 &target_attributes, &target_key ) );
Gilles Peskine57ab7212019-01-28 13:03:09 +01001673
1674 /* Destroy the source to ensure that this doesn't affect the target. */
Ronald Cron5425a212020-08-04 14:58:35 +02001675 PSA_ASSERT( psa_destroy_key( source_key ) );
Gilles Peskine57ab7212019-01-28 13:03:09 +01001676
1677 /* Test that the target slot has the expected content and policy. */
Ronald Cron5425a212020-08-04 14:58:35 +02001678 PSA_ASSERT( psa_get_key_attributes( target_key, &target_attributes ) );
Gilles Peskineca25db92019-04-19 11:43:08 +02001679 TEST_EQUAL( psa_get_key_type( &source_attributes ),
1680 psa_get_key_type( &target_attributes ) );
1681 TEST_EQUAL( psa_get_key_bits( &source_attributes ),
1682 psa_get_key_bits( &target_attributes ) );
1683 TEST_EQUAL( expected_usage, psa_get_key_usage_flags( &target_attributes ) );
1684 TEST_EQUAL( expected_alg, psa_get_key_algorithm( &target_attributes ) );
Gilles Peskinebcdd44b2019-05-20 17:28:11 +02001685 TEST_EQUAL( expected_alg2,
1686 psa_get_key_enrollment_algorithm( &target_attributes ) );
Gilles Peskine57ab7212019-01-28 13:03:09 +01001687 if( expected_usage & PSA_KEY_USAGE_EXPORT )
1688 {
1689 size_t length;
1690 ASSERT_ALLOC( export_buffer, material->len );
Ronald Cron5425a212020-08-04 14:58:35 +02001691 PSA_ASSERT( psa_export_key( target_key, export_buffer,
Gilles Peskine57ab7212019-01-28 13:03:09 +01001692 material->len, &length ) );
1693 ASSERT_COMPARE( material->x, material->len,
1694 export_buffer, length );
1695 }
Steven Cooremanb3ce8152021-02-18 12:03:50 +01001696
Archana8a180362021-07-05 02:18:48 +05301697 if( !psa_key_lifetime_is_external( target_lifetime ) )
1698 {
1699 if( ! mbedtls_test_psa_exercise_key( target_key, expected_usage, expected_alg ) )
1700 goto exit;
1701 if( ! mbedtls_test_psa_exercise_key( target_key, expected_usage, expected_alg2 ) )
1702 goto exit;
1703 }
Gilles Peskine57ab7212019-01-28 13:03:09 +01001704
Ronald Cron5425a212020-08-04 14:58:35 +02001705 PSA_ASSERT( psa_destroy_key( target_key ) );
Gilles Peskine57ab7212019-01-28 13:03:09 +01001706
1707exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +01001708 /*
1709 * Source and target key attributes may have been returned by
1710 * psa_get_key_attributes() thus reset them as required.
1711 */
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02001712 psa_reset_key_attributes( &source_attributes );
1713 psa_reset_key_attributes( &target_attributes );
Ronald Cron3a4f0e32020-11-19 17:55:23 +01001714
Gilles Peskine1153e7b2019-05-28 15:10:21 +02001715 PSA_DONE( );
Gilles Peskine57ab7212019-01-28 13:03:09 +01001716 mbedtls_free( export_buffer );
1717}
1718/* END_CASE */
1719
1720/* BEGIN_CASE */
Gilles Peskinebcdd44b2019-05-20 17:28:11 +02001721void copy_fail( int source_usage_arg,
1722 int source_alg_arg, int source_alg2_arg,
Archana8a180362021-07-05 02:18:48 +05301723 int source_lifetime_arg,
Gilles Peskine4a644642019-05-03 17:14:08 +02001724 int type_arg, data_t *material,
1725 int target_type_arg, int target_bits_arg,
Gilles Peskinebcdd44b2019-05-20 17:28:11 +02001726 int target_usage_arg,
1727 int target_alg_arg, int target_alg2_arg,
Ronald Cron88a55462021-03-31 09:39:07 +02001728 int target_id_arg, int target_lifetime_arg,
Gilles Peskine4a644642019-05-03 17:14:08 +02001729 int expected_status_arg )
1730{
1731 psa_key_attributes_t source_attributes = PSA_KEY_ATTRIBUTES_INIT;
1732 psa_key_attributes_t target_attributes = PSA_KEY_ATTRIBUTES_INIT;
Ronald Cron5425a212020-08-04 14:58:35 +02001733 mbedtls_svc_key_id_t source_key = MBEDTLS_SVC_KEY_ID_INIT;
1734 mbedtls_svc_key_id_t target_key = MBEDTLS_SVC_KEY_ID_INIT;
Ronald Cron88a55462021-03-31 09:39:07 +02001735 mbedtls_svc_key_id_t key_id = mbedtls_svc_key_id_make( 1, target_id_arg );
Gilles Peskine4a644642019-05-03 17:14:08 +02001736
1737 PSA_ASSERT( psa_crypto_init( ) );
1738
1739 /* Prepare the source key. */
1740 psa_set_key_usage_flags( &source_attributes, source_usage_arg );
1741 psa_set_key_algorithm( &source_attributes, source_alg_arg );
Gilles Peskinebcdd44b2019-05-20 17:28:11 +02001742 psa_set_key_enrollment_algorithm( &source_attributes, source_alg2_arg );
Gilles Peskine4a644642019-05-03 17:14:08 +02001743 psa_set_key_type( &source_attributes, type_arg );
Archana8a180362021-07-05 02:18:48 +05301744 psa_set_key_lifetime( &source_attributes, source_lifetime_arg );
Gilles Peskine049c7532019-05-15 20:22:09 +02001745 PSA_ASSERT( psa_import_key( &source_attributes,
1746 material->x, material->len,
Ronald Cron5425a212020-08-04 14:58:35 +02001747 &source_key ) );
Gilles Peskine4a644642019-05-03 17:14:08 +02001748
1749 /* Prepare the target attributes. */
Ronald Cron88a55462021-03-31 09:39:07 +02001750 psa_set_key_id( &target_attributes, key_id );
1751 psa_set_key_lifetime( &target_attributes, target_lifetime_arg );
Gilles Peskine4a644642019-05-03 17:14:08 +02001752 psa_set_key_type( &target_attributes, target_type_arg );
1753 psa_set_key_bits( &target_attributes, target_bits_arg );
1754 psa_set_key_usage_flags( &target_attributes, target_usage_arg );
1755 psa_set_key_algorithm( &target_attributes, target_alg_arg );
Gilles Peskinebcdd44b2019-05-20 17:28:11 +02001756 psa_set_key_enrollment_algorithm( &target_attributes, target_alg2_arg );
Gilles Peskine4a644642019-05-03 17:14:08 +02001757
1758 /* Try to copy the key. */
Ronald Cron5425a212020-08-04 14:58:35 +02001759 TEST_EQUAL( psa_copy_key( source_key,
1760 &target_attributes, &target_key ),
Gilles Peskine4a644642019-05-03 17:14:08 +02001761 expected_status_arg );
Gilles Peskine76b29a72019-05-28 14:08:50 +02001762
Ronald Cron5425a212020-08-04 14:58:35 +02001763 PSA_ASSERT( psa_destroy_key( source_key ) );
Gilles Peskine76b29a72019-05-28 14:08:50 +02001764
Gilles Peskine4a644642019-05-03 17:14:08 +02001765exit:
1766 psa_reset_key_attributes( &source_attributes );
1767 psa_reset_key_attributes( &target_attributes );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02001768 PSA_DONE( );
Gilles Peskine4a644642019-05-03 17:14:08 +02001769}
1770/* END_CASE */
1771
1772/* BEGIN_CASE */
Jaeden Amero6a25b412019-01-04 11:47:44 +00001773void hash_operation_init( )
1774{
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00001775 const uint8_t input[1] = { 0 };
Jaeden Amero6a25b412019-01-04 11:47:44 +00001776 /* Test each valid way of initializing the object, except for `= {0}`, as
1777 * Clang 5 complains when `-Wmissing-field-initializers` is used, even
1778 * though it's OK by the C standard. We could test for this, but we'd need
1779 * to supress the Clang warning for the test. */
1780 psa_hash_operation_t func = psa_hash_operation_init( );
1781 psa_hash_operation_t init = PSA_HASH_OPERATION_INIT;
1782 psa_hash_operation_t zero;
1783
1784 memset( &zero, 0, sizeof( zero ) );
1785
Jaeden Amero11aa7ee2019-02-19 11:44:55 +00001786 /* A freshly-initialized hash operation should not be usable. */
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00001787 TEST_EQUAL( psa_hash_update( &func, input, sizeof( input ) ),
1788 PSA_ERROR_BAD_STATE );
1789 TEST_EQUAL( psa_hash_update( &init, input, sizeof( input ) ),
1790 PSA_ERROR_BAD_STATE );
1791 TEST_EQUAL( psa_hash_update( &zero, input, sizeof( input ) ),
1792 PSA_ERROR_BAD_STATE );
1793
Jaeden Amero5229bbb2019-02-07 16:33:37 +00001794 /* A default hash operation should be abortable without error. */
1795 PSA_ASSERT( psa_hash_abort( &func ) );
1796 PSA_ASSERT( psa_hash_abort( &init ) );
1797 PSA_ASSERT( psa_hash_abort( &zero ) );
Jaeden Amero6a25b412019-01-04 11:47:44 +00001798}
1799/* END_CASE */
1800
1801/* BEGIN_CASE */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02001802void hash_setup( int alg_arg,
1803 int expected_status_arg )
1804{
1805 psa_algorithm_t alg = alg_arg;
Gilles Peskineb866e2b2018-06-21 09:25:10 +02001806 psa_status_t expected_status = expected_status_arg;
Jaeden Amero6a25b412019-01-04 11:47:44 +00001807 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02001808 psa_status_t status;
1809
Gilles Peskine8817f612018-12-18 00:18:46 +01001810 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02001811
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02001812 status = psa_hash_setup( &operation, alg );
Gilles Peskinefe11b722018-12-18 00:24:04 +01001813 TEST_EQUAL( status, expected_status );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02001814
Gilles Peskine9e0a4a52019-02-25 22:11:18 +01001815 /* Whether setup succeeded or failed, abort must succeed. */
1816 PSA_ASSERT( psa_hash_abort( &operation ) );
1817
1818 /* If setup failed, reproduce the failure, so as to
1819 * test the resulting state of the operation object. */
1820 if( status != PSA_SUCCESS )
1821 TEST_EQUAL( psa_hash_setup( &operation, alg ), status );
1822
Gilles Peskinef426e0f2019-02-25 17:42:03 +01001823 /* Now the operation object should be reusable. */
1824#if defined(KNOWN_SUPPORTED_HASH_ALG)
1825 PSA_ASSERT( psa_hash_setup( &operation, KNOWN_SUPPORTED_HASH_ALG ) );
1826 PSA_ASSERT( psa_hash_abort( &operation ) );
1827#endif
1828
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02001829exit:
Gilles Peskine1153e7b2019-05-28 15:10:21 +02001830 PSA_DONE( );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02001831}
1832/* END_CASE */
1833
1834/* BEGIN_CASE */
Gilles Peskine0a749c82019-11-28 19:33:58 +01001835void hash_compute_fail( int alg_arg, data_t *input,
1836 int output_size_arg, int expected_status_arg )
1837{
1838 psa_algorithm_t alg = alg_arg;
1839 uint8_t *output = NULL;
1840 size_t output_size = output_size_arg;
1841 size_t output_length = INVALID_EXPORT_LENGTH;
1842 psa_status_t expected_status = expected_status_arg;
1843 psa_status_t status;
1844
1845 ASSERT_ALLOC( output, output_size );
1846
1847 PSA_ASSERT( psa_crypto_init( ) );
1848
1849 status = psa_hash_compute( alg, input->x, input->len,
1850 output, output_size, &output_length );
1851 TEST_EQUAL( status, expected_status );
1852 TEST_ASSERT( output_length <= output_size );
1853
1854exit:
1855 mbedtls_free( output );
1856 PSA_DONE( );
1857}
1858/* END_CASE */
1859
1860/* BEGIN_CASE */
Gilles Peskine88e08462020-01-28 20:43:00 +01001861void hash_compare_fail( int alg_arg, data_t *input,
1862 data_t *reference_hash,
1863 int expected_status_arg )
1864{
1865 psa_algorithm_t alg = alg_arg;
1866 psa_status_t expected_status = expected_status_arg;
1867 psa_status_t status;
1868
1869 PSA_ASSERT( psa_crypto_init( ) );
1870
1871 status = psa_hash_compare( alg, input->x, input->len,
1872 reference_hash->x, reference_hash->len );
1873 TEST_EQUAL( status, expected_status );
1874
1875exit:
1876 PSA_DONE( );
1877}
1878/* END_CASE */
1879
1880/* BEGIN_CASE */
Gilles Peskine0a749c82019-11-28 19:33:58 +01001881void hash_compute_compare( int alg_arg, data_t *input,
1882 data_t *expected_output )
1883{
1884 psa_algorithm_t alg = alg_arg;
1885 uint8_t output[PSA_HASH_MAX_SIZE + 1];
1886 size_t output_length = INVALID_EXPORT_LENGTH;
1887 size_t i;
1888
1889 PSA_ASSERT( psa_crypto_init( ) );
1890
1891 /* Compute with tight buffer */
1892 PSA_ASSERT( psa_hash_compute( alg, input->x, input->len,
gabor-mezei-armcbcec212020-12-18 14:23:51 +01001893 output, PSA_HASH_LENGTH( alg ),
Gilles Peskine0a749c82019-11-28 19:33:58 +01001894 &output_length ) );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01001895 TEST_EQUAL( output_length, PSA_HASH_LENGTH( alg ) );
Gilles Peskine0a749c82019-11-28 19:33:58 +01001896 ASSERT_COMPARE( output, output_length,
1897 expected_output->x, expected_output->len );
1898
1899 /* Compute with larger buffer */
1900 PSA_ASSERT( psa_hash_compute( alg, input->x, input->len,
1901 output, sizeof( output ),
1902 &output_length ) );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01001903 TEST_EQUAL( output_length, PSA_HASH_LENGTH( alg ) );
Gilles Peskine0a749c82019-11-28 19:33:58 +01001904 ASSERT_COMPARE( output, output_length,
1905 expected_output->x, expected_output->len );
1906
1907 /* Compare with correct hash */
1908 PSA_ASSERT( psa_hash_compare( alg, input->x, input->len,
1909 output, output_length ) );
1910
1911 /* Compare with trailing garbage */
1912 TEST_EQUAL( psa_hash_compare( alg, input->x, input->len,
1913 output, output_length + 1 ),
1914 PSA_ERROR_INVALID_SIGNATURE );
1915
1916 /* Compare with truncated hash */
1917 TEST_EQUAL( psa_hash_compare( alg, input->x, input->len,
1918 output, output_length - 1 ),
1919 PSA_ERROR_INVALID_SIGNATURE );
1920
1921 /* Compare with corrupted value */
1922 for( i = 0; i < output_length; i++ )
1923 {
Chris Jones9634bb12021-01-20 15:56:42 +00001924 mbedtls_test_set_step( i );
Gilles Peskine0a749c82019-11-28 19:33:58 +01001925 output[i] ^= 1;
1926 TEST_EQUAL( psa_hash_compare( alg, input->x, input->len,
1927 output, output_length ),
1928 PSA_ERROR_INVALID_SIGNATURE );
1929 output[i] ^= 1;
1930 }
1931
1932exit:
1933 PSA_DONE( );
1934}
1935/* END_CASE */
1936
Gilles Peskined6dc40c2021-01-12 12:55:31 +01001937/* BEGIN_CASE depends_on:PSA_WANT_ALG_SHA_256 */
itayzafrirf86548d2018-11-01 10:44:32 +02001938void hash_bad_order( )
1939{
Jaeden Amero11aa7ee2019-02-19 11:44:55 +00001940 psa_algorithm_t alg = PSA_ALG_SHA_256;
itayzafrirf86548d2018-11-01 10:44:32 +02001941 unsigned char input[] = "";
1942 /* SHA-256 hash of an empty string */
Jaeden Amero11aa7ee2019-02-19 11:44:55 +00001943 const unsigned char valid_hash[] = {
itayzafrirf86548d2018-11-01 10:44:32 +02001944 0xe3, 0xb0, 0xc4, 0x42, 0x98, 0xfc, 0x1c, 0x14, 0x9a, 0xfb, 0xf4, 0xc8,
1945 0x99, 0x6f, 0xb9, 0x24, 0x27, 0xae, 0x41, 0xe4, 0x64, 0x9b, 0x93, 0x4c,
1946 0xa4, 0x95, 0x99, 0x1b, 0x78, 0x52, 0xb8, 0x55 };
Jaeden Amero11aa7ee2019-02-19 11:44:55 +00001947 unsigned char hash[sizeof(valid_hash)] = { 0 };
itayzafrirf86548d2018-11-01 10:44:32 +02001948 size_t hash_len;
Jaeden Amero6a25b412019-01-04 11:47:44 +00001949 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
itayzafrirf86548d2018-11-01 10:44:32 +02001950
Gilles Peskine8817f612018-12-18 00:18:46 +01001951 PSA_ASSERT( psa_crypto_init( ) );
itayzafrirf86548d2018-11-01 10:44:32 +02001952
Jaeden Amero36ee5d02019-02-19 09:25:10 +00001953 /* Call setup twice in a row. */
1954 PSA_ASSERT( psa_hash_setup( &operation, alg ) );
Dave Rodgman5ae6f752021-06-24 11:36:14 +01001955 ASSERT_OPERATION_IS_ACTIVE( operation );
Jaeden Amero36ee5d02019-02-19 09:25:10 +00001956 TEST_EQUAL( psa_hash_setup( &operation, alg ),
1957 PSA_ERROR_BAD_STATE );
Dave Rodgman5ae6f752021-06-24 11:36:14 +01001958 ASSERT_OPERATION_IS_INACTIVE( operation );
Jaeden Amero36ee5d02019-02-19 09:25:10 +00001959 PSA_ASSERT( psa_hash_abort( &operation ) );
Dave Rodgman5ae6f752021-06-24 11:36:14 +01001960 ASSERT_OPERATION_IS_INACTIVE( operation );
Jaeden Amero36ee5d02019-02-19 09:25:10 +00001961
Jaeden Amero11aa7ee2019-02-19 11:44:55 +00001962 /* Call update without calling setup beforehand. */
Gilles Peskinef812dcf2018-12-18 00:33:25 +01001963 TEST_EQUAL( psa_hash_update( &operation, input, sizeof( input ) ),
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00001964 PSA_ERROR_BAD_STATE );
Jaeden Amero11aa7ee2019-02-19 11:44:55 +00001965 PSA_ASSERT( psa_hash_abort( &operation ) );
itayzafrirf86548d2018-11-01 10:44:32 +02001966
Dave Rodgman5ae6f752021-06-24 11:36:14 +01001967 /* Check that update calls abort on error. */
1968 PSA_ASSERT( psa_hash_setup( &operation, alg ) );
Dave Rodgman6f710582021-06-24 18:14:52 +01001969 operation.id = UINT_MAX;
Dave Rodgman5ae6f752021-06-24 11:36:14 +01001970 ASSERT_OPERATION_IS_ACTIVE( operation );
1971 TEST_EQUAL( psa_hash_update( &operation, input, sizeof( input ) ),
1972 PSA_ERROR_BAD_STATE );
1973 ASSERT_OPERATION_IS_INACTIVE( operation );
1974 PSA_ASSERT( psa_hash_abort( &operation ) );
1975 ASSERT_OPERATION_IS_INACTIVE( operation );
1976
Jaeden Amero11aa7ee2019-02-19 11:44:55 +00001977 /* Call update after finish. */
1978 PSA_ASSERT( psa_hash_setup( &operation, alg ) );
1979 PSA_ASSERT( psa_hash_finish( &operation,
1980 hash, sizeof( hash ), &hash_len ) );
1981 TEST_EQUAL( psa_hash_update( &operation, input, sizeof( input ) ),
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00001982 PSA_ERROR_BAD_STATE );
Jaeden Amero11aa7ee2019-02-19 11:44:55 +00001983 PSA_ASSERT( psa_hash_abort( &operation ) );
itayzafrirf86548d2018-11-01 10:44:32 +02001984
Jaeden Amero11aa7ee2019-02-19 11:44:55 +00001985 /* Call verify without calling setup beforehand. */
1986 TEST_EQUAL( psa_hash_verify( &operation,
1987 valid_hash, sizeof( valid_hash ) ),
1988 PSA_ERROR_BAD_STATE );
1989 PSA_ASSERT( psa_hash_abort( &operation ) );
1990
1991 /* Call verify after finish. */
1992 PSA_ASSERT( psa_hash_setup( &operation, alg ) );
1993 PSA_ASSERT( psa_hash_finish( &operation,
1994 hash, sizeof( hash ), &hash_len ) );
1995 TEST_EQUAL( psa_hash_verify( &operation,
1996 valid_hash, sizeof( valid_hash ) ),
1997 PSA_ERROR_BAD_STATE );
1998 PSA_ASSERT( psa_hash_abort( &operation ) );
1999
2000 /* Call verify twice in a row. */
2001 PSA_ASSERT( psa_hash_setup( &operation, alg ) );
Dave Rodgman5ae6f752021-06-24 11:36:14 +01002002 ASSERT_OPERATION_IS_ACTIVE( operation );
Jaeden Amero11aa7ee2019-02-19 11:44:55 +00002003 PSA_ASSERT( psa_hash_verify( &operation,
2004 valid_hash, sizeof( valid_hash ) ) );
Dave Rodgman5ae6f752021-06-24 11:36:14 +01002005 ASSERT_OPERATION_IS_INACTIVE( operation );
Jaeden Amero11aa7ee2019-02-19 11:44:55 +00002006 TEST_EQUAL( psa_hash_verify( &operation,
2007 valid_hash, sizeof( valid_hash ) ),
2008 PSA_ERROR_BAD_STATE );
Dave Rodgman5ae6f752021-06-24 11:36:14 +01002009 ASSERT_OPERATION_IS_INACTIVE( operation );
Jaeden Amero11aa7ee2019-02-19 11:44:55 +00002010 PSA_ASSERT( psa_hash_abort( &operation ) );
2011
2012 /* Call finish without calling setup beforehand. */
Gilles Peskinefe11b722018-12-18 00:24:04 +01002013 TEST_EQUAL( psa_hash_finish( &operation,
2014 hash, sizeof( hash ), &hash_len ),
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002015 PSA_ERROR_BAD_STATE );
Jaeden Amero11aa7ee2019-02-19 11:44:55 +00002016 PSA_ASSERT( psa_hash_abort( &operation ) );
2017
2018 /* Call finish twice in a row. */
2019 PSA_ASSERT( psa_hash_setup( &operation, alg ) );
2020 PSA_ASSERT( psa_hash_finish( &operation,
2021 hash, sizeof( hash ), &hash_len ) );
2022 TEST_EQUAL( psa_hash_finish( &operation,
2023 hash, sizeof( hash ), &hash_len ),
2024 PSA_ERROR_BAD_STATE );
2025 PSA_ASSERT( psa_hash_abort( &operation ) );
2026
2027 /* Call finish after calling verify. */
2028 PSA_ASSERT( psa_hash_setup( &operation, alg ) );
2029 PSA_ASSERT( psa_hash_verify( &operation,
2030 valid_hash, sizeof( valid_hash ) ) );
2031 TEST_EQUAL( psa_hash_finish( &operation,
2032 hash, sizeof( hash ), &hash_len ),
2033 PSA_ERROR_BAD_STATE );
2034 PSA_ASSERT( psa_hash_abort( &operation ) );
itayzafrirf86548d2018-11-01 10:44:32 +02002035
2036exit:
Gilles Peskine1153e7b2019-05-28 15:10:21 +02002037 PSA_DONE( );
itayzafrirf86548d2018-11-01 10:44:32 +02002038}
2039/* END_CASE */
2040
Gilles Peskined6dc40c2021-01-12 12:55:31 +01002041/* BEGIN_CASE depends_on:PSA_WANT_ALG_SHA_256 */
itayzafrir27e69452018-11-01 14:26:34 +02002042void hash_verify_bad_args( )
itayzafrirec93d302018-10-18 18:01:10 +03002043{
2044 psa_algorithm_t alg = PSA_ALG_SHA_256;
itayzafrir27e69452018-11-01 14:26:34 +02002045 /* SHA-256 hash of an empty string with 2 extra bytes (0xaa and 0xbb)
2046 * appended to it */
2047 unsigned char hash[] = {
2048 0xe3, 0xb0, 0xc4, 0x42, 0x98, 0xfc, 0x1c, 0x14, 0x9a, 0xfb, 0xf4, 0xc8,
2049 0x99, 0x6f, 0xb9, 0x24, 0x27, 0xae, 0x41, 0xe4, 0x64, 0x9b, 0x93, 0x4c,
2050 0xa4, 0x95, 0x99, 0x1b, 0x78, 0x52, 0xb8, 0x55, 0xaa, 0xbb };
gabor-mezei-armcbcec212020-12-18 14:23:51 +01002051 size_t expected_size = PSA_HASH_LENGTH( alg );
Jaeden Amero6a25b412019-01-04 11:47:44 +00002052 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
itayzafrirec93d302018-10-18 18:01:10 +03002053
Gilles Peskine8817f612018-12-18 00:18:46 +01002054 PSA_ASSERT( psa_crypto_init( ) );
itayzafrirec93d302018-10-18 18:01:10 +03002055
itayzafrir27e69452018-11-01 14:26:34 +02002056 /* psa_hash_verify with a smaller hash than expected */
Gilles Peskine8817f612018-12-18 00:18:46 +01002057 PSA_ASSERT( psa_hash_setup( &operation, alg ) );
Dave Rodgman5ae6f752021-06-24 11:36:14 +01002058 ASSERT_OPERATION_IS_ACTIVE( operation );
Gilles Peskinef812dcf2018-12-18 00:33:25 +01002059 TEST_EQUAL( psa_hash_verify( &operation, hash, expected_size - 1 ),
Gilles Peskinefe11b722018-12-18 00:24:04 +01002060 PSA_ERROR_INVALID_SIGNATURE );
Dave Rodgman5ae6f752021-06-24 11:36:14 +01002061 ASSERT_OPERATION_IS_INACTIVE( operation );
2062 PSA_ASSERT( psa_hash_abort( &operation ) );
2063 ASSERT_OPERATION_IS_INACTIVE( operation );
itayzafrirec93d302018-10-18 18:01:10 +03002064
itayzafrir27e69452018-11-01 14:26:34 +02002065 /* psa_hash_verify with a non-matching hash */
Gilles Peskine8817f612018-12-18 00:18:46 +01002066 PSA_ASSERT( psa_hash_setup( &operation, alg ) );
Gilles Peskinef812dcf2018-12-18 00:33:25 +01002067 TEST_EQUAL( psa_hash_verify( &operation, hash + 1, expected_size ),
Gilles Peskinefe11b722018-12-18 00:24:04 +01002068 PSA_ERROR_INVALID_SIGNATURE );
itayzafrirec93d302018-10-18 18:01:10 +03002069
itayzafrir27e69452018-11-01 14:26:34 +02002070 /* psa_hash_verify with a hash longer than expected */
Gilles Peskine8817f612018-12-18 00:18:46 +01002071 PSA_ASSERT( psa_hash_setup( &operation, alg ) );
Gilles Peskinef812dcf2018-12-18 00:33:25 +01002072 TEST_EQUAL( psa_hash_verify( &operation, hash, sizeof( hash ) ),
Gilles Peskinefe11b722018-12-18 00:24:04 +01002073 PSA_ERROR_INVALID_SIGNATURE );
itayzafrir4271df92018-10-24 18:16:19 +03002074
itayzafrirec93d302018-10-18 18:01:10 +03002075exit:
Gilles Peskine1153e7b2019-05-28 15:10:21 +02002076 PSA_DONE( );
itayzafrirec93d302018-10-18 18:01:10 +03002077}
2078/* END_CASE */
2079
Ronald Cronee414c72021-03-18 18:50:08 +01002080/* BEGIN_CASE depends_on:PSA_WANT_ALG_SHA_256 */
itayzafrirb2dd5ed2018-11-01 11:58:59 +02002081void hash_finish_bad_args( )
itayzafrir58028322018-10-25 10:22:01 +03002082{
2083 psa_algorithm_t alg = PSA_ALG_SHA_256;
itayzafrirb2dd5ed2018-11-01 11:58:59 +02002084 unsigned char hash[PSA_HASH_MAX_SIZE];
gabor-mezei-armcbcec212020-12-18 14:23:51 +01002085 size_t expected_size = PSA_HASH_LENGTH( alg );
Jaeden Amero6a25b412019-01-04 11:47:44 +00002086 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
itayzafrir58028322018-10-25 10:22:01 +03002087 size_t hash_len;
2088
Gilles Peskine8817f612018-12-18 00:18:46 +01002089 PSA_ASSERT( psa_crypto_init( ) );
itayzafrir58028322018-10-25 10:22:01 +03002090
itayzafrir58028322018-10-25 10:22:01 +03002091 /* psa_hash_finish with a smaller hash buffer than expected */
Gilles Peskine8817f612018-12-18 00:18:46 +01002092 PSA_ASSERT( psa_hash_setup( &operation, alg ) );
Gilles Peskinefe11b722018-12-18 00:24:04 +01002093 TEST_EQUAL( psa_hash_finish( &operation,
Gilles Peskinef812dcf2018-12-18 00:33:25 +01002094 hash, expected_size - 1, &hash_len ),
2095 PSA_ERROR_BUFFER_TOO_SMALL );
itayzafrir58028322018-10-25 10:22:01 +03002096
2097exit:
Gilles Peskine1153e7b2019-05-28 15:10:21 +02002098 PSA_DONE( );
itayzafrir58028322018-10-25 10:22:01 +03002099}
2100/* END_CASE */
2101
Ronald Cronee414c72021-03-18 18:50:08 +01002102/* BEGIN_CASE depends_on:PSA_WANT_ALG_SHA_256 */
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002103void hash_clone_source_state( )
2104{
2105 psa_algorithm_t alg = PSA_ALG_SHA_256;
2106 unsigned char hash[PSA_HASH_MAX_SIZE];
2107 psa_hash_operation_t op_source = PSA_HASH_OPERATION_INIT;
2108 psa_hash_operation_t op_init = PSA_HASH_OPERATION_INIT;
2109 psa_hash_operation_t op_setup = PSA_HASH_OPERATION_INIT;
2110 psa_hash_operation_t op_finished = PSA_HASH_OPERATION_INIT;
2111 psa_hash_operation_t op_aborted = PSA_HASH_OPERATION_INIT;
2112 size_t hash_len;
2113
2114 PSA_ASSERT( psa_crypto_init( ) );
2115 PSA_ASSERT( psa_hash_setup( &op_source, alg ) );
2116
2117 PSA_ASSERT( psa_hash_setup( &op_setup, alg ) );
2118 PSA_ASSERT( psa_hash_setup( &op_finished, alg ) );
2119 PSA_ASSERT( psa_hash_finish( &op_finished,
2120 hash, sizeof( hash ), &hash_len ) );
2121 PSA_ASSERT( psa_hash_setup( &op_aborted, alg ) );
2122 PSA_ASSERT( psa_hash_abort( &op_aborted ) );
2123
2124 TEST_EQUAL( psa_hash_clone( &op_source, &op_setup ),
2125 PSA_ERROR_BAD_STATE );
2126
2127 PSA_ASSERT( psa_hash_clone( &op_source, &op_init ) );
2128 PSA_ASSERT( psa_hash_finish( &op_init,
2129 hash, sizeof( hash ), &hash_len ) );
2130 PSA_ASSERT( psa_hash_clone( &op_source, &op_finished ) );
2131 PSA_ASSERT( psa_hash_finish( &op_finished,
2132 hash, sizeof( hash ), &hash_len ) );
2133 PSA_ASSERT( psa_hash_clone( &op_source, &op_aborted ) );
2134 PSA_ASSERT( psa_hash_finish( &op_aborted,
2135 hash, sizeof( hash ), &hash_len ) );
2136
2137exit:
2138 psa_hash_abort( &op_source );
2139 psa_hash_abort( &op_init );
2140 psa_hash_abort( &op_setup );
2141 psa_hash_abort( &op_finished );
2142 psa_hash_abort( &op_aborted );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02002143 PSA_DONE( );
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002144}
2145/* END_CASE */
2146
Ronald Cronee414c72021-03-18 18:50:08 +01002147/* BEGIN_CASE depends_on:PSA_WANT_ALG_SHA_256 */
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002148void hash_clone_target_state( )
2149{
2150 psa_algorithm_t alg = PSA_ALG_SHA_256;
2151 unsigned char hash[PSA_HASH_MAX_SIZE];
2152 psa_hash_operation_t op_init = PSA_HASH_OPERATION_INIT;
2153 psa_hash_operation_t op_setup = PSA_HASH_OPERATION_INIT;
2154 psa_hash_operation_t op_finished = PSA_HASH_OPERATION_INIT;
2155 psa_hash_operation_t op_aborted = PSA_HASH_OPERATION_INIT;
2156 psa_hash_operation_t op_target = PSA_HASH_OPERATION_INIT;
2157 size_t hash_len;
2158
2159 PSA_ASSERT( psa_crypto_init( ) );
2160
2161 PSA_ASSERT( psa_hash_setup( &op_setup, alg ) );
2162 PSA_ASSERT( psa_hash_setup( &op_finished, alg ) );
2163 PSA_ASSERT( psa_hash_finish( &op_finished,
2164 hash, sizeof( hash ), &hash_len ) );
2165 PSA_ASSERT( psa_hash_setup( &op_aborted, alg ) );
2166 PSA_ASSERT( psa_hash_abort( &op_aborted ) );
2167
2168 PSA_ASSERT( psa_hash_clone( &op_setup, &op_target ) );
2169 PSA_ASSERT( psa_hash_finish( &op_target,
2170 hash, sizeof( hash ), &hash_len ) );
2171
2172 TEST_EQUAL( psa_hash_clone( &op_init, &op_target ), PSA_ERROR_BAD_STATE );
2173 TEST_EQUAL( psa_hash_clone( &op_finished, &op_target ),
2174 PSA_ERROR_BAD_STATE );
2175 TEST_EQUAL( psa_hash_clone( &op_aborted, &op_target ),
2176 PSA_ERROR_BAD_STATE );
2177
2178exit:
2179 psa_hash_abort( &op_target );
2180 psa_hash_abort( &op_init );
2181 psa_hash_abort( &op_setup );
2182 psa_hash_abort( &op_finished );
2183 psa_hash_abort( &op_aborted );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02002184 PSA_DONE( );
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002185}
2186/* END_CASE */
2187
itayzafrir58028322018-10-25 10:22:01 +03002188/* BEGIN_CASE */
Jaeden Amero769ce272019-01-04 11:48:03 +00002189void mac_operation_init( )
2190{
Jaeden Amero252ef282019-02-15 14:05:35 +00002191 const uint8_t input[1] = { 0 };
2192
Jaeden Amero769ce272019-01-04 11:48:03 +00002193 /* Test each valid way of initializing the object, except for `= {0}`, as
2194 * Clang 5 complains when `-Wmissing-field-initializers` is used, even
2195 * though it's OK by the C standard. We could test for this, but we'd need
2196 * to supress the Clang warning for the test. */
2197 psa_mac_operation_t func = psa_mac_operation_init( );
2198 psa_mac_operation_t init = PSA_MAC_OPERATION_INIT;
2199 psa_mac_operation_t zero;
2200
2201 memset( &zero, 0, sizeof( zero ) );
2202
Jaeden Amero252ef282019-02-15 14:05:35 +00002203 /* A freshly-initialized MAC operation should not be usable. */
2204 TEST_EQUAL( psa_mac_update( &func,
2205 input, sizeof( input ) ),
2206 PSA_ERROR_BAD_STATE );
2207 TEST_EQUAL( psa_mac_update( &init,
2208 input, sizeof( input ) ),
2209 PSA_ERROR_BAD_STATE );
2210 TEST_EQUAL( psa_mac_update( &zero,
2211 input, sizeof( input ) ),
2212 PSA_ERROR_BAD_STATE );
2213
Jaeden Amero5229bbb2019-02-07 16:33:37 +00002214 /* A default MAC operation should be abortable without error. */
2215 PSA_ASSERT( psa_mac_abort( &func ) );
2216 PSA_ASSERT( psa_mac_abort( &init ) );
2217 PSA_ASSERT( psa_mac_abort( &zero ) );
Jaeden Amero769ce272019-01-04 11:48:03 +00002218}
2219/* END_CASE */
2220
2221/* BEGIN_CASE */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002222void mac_setup( int key_type_arg,
2223 data_t *key,
2224 int alg_arg,
2225 int expected_status_arg )
2226{
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002227 psa_key_type_t key_type = key_type_arg;
2228 psa_algorithm_t alg = alg_arg;
Gilles Peskineb866e2b2018-06-21 09:25:10 +02002229 psa_status_t expected_status = expected_status_arg;
Jaeden Amero769ce272019-01-04 11:48:03 +00002230 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
Gilles Peskinef426e0f2019-02-25 17:42:03 +01002231 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
2232#if defined(KNOWN_SUPPORTED_MAC_ALG)
2233 const uint8_t smoke_test_key_data[16] = "kkkkkkkkkkkkkkkk";
2234#endif
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002235
Gilles Peskine8817f612018-12-18 00:18:46 +01002236 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002237
Gilles Peskinef426e0f2019-02-25 17:42:03 +01002238 if( ! exercise_mac_setup( key_type, key->x, key->len, alg,
2239 &operation, &status ) )
2240 goto exit;
Gilles Peskinefe11b722018-12-18 00:24:04 +01002241 TEST_EQUAL( status, expected_status );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002242
Gilles Peskinef426e0f2019-02-25 17:42:03 +01002243 /* The operation object should be reusable. */
2244#if defined(KNOWN_SUPPORTED_MAC_ALG)
2245 if( ! exercise_mac_setup( KNOWN_SUPPORTED_MAC_KEY_TYPE,
2246 smoke_test_key_data,
2247 sizeof( smoke_test_key_data ),
2248 KNOWN_SUPPORTED_MAC_ALG,
2249 &operation, &status ) )
2250 goto exit;
2251 TEST_EQUAL( status, PSA_SUCCESS );
2252#endif
2253
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002254exit:
Gilles Peskine1153e7b2019-05-28 15:10:21 +02002255 PSA_DONE( );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002256}
2257/* END_CASE */
2258
Gilles Peskined6dc40c2021-01-12 12:55:31 +01002259/* 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 +00002260void mac_bad_order( )
2261{
Ronald Cron5425a212020-08-04 14:58:35 +02002262 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Jaeden Amero252ef282019-02-15 14:05:35 +00002263 psa_key_type_t key_type = PSA_KEY_TYPE_HMAC;
2264 psa_algorithm_t alg = PSA_ALG_HMAC(PSA_ALG_SHA_256);
Ronald Cron5425a212020-08-04 14:58:35 +02002265 const uint8_t key_data[] = {
Jaeden Amero252ef282019-02-15 14:05:35 +00002266 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa,
2267 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa,
2268 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa };
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02002269 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Jaeden Amero252ef282019-02-15 14:05:35 +00002270 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
2271 uint8_t sign_mac[PSA_MAC_MAX_SIZE + 10] = { 0 };
2272 size_t sign_mac_length = 0;
2273 const uint8_t input[] = { 0xbb, 0xbb, 0xbb, 0xbb };
2274 const uint8_t verify_mac[] = {
2275 0x74, 0x65, 0x93, 0x8c, 0xeb, 0x1d, 0xb3, 0x76, 0x5a, 0x38, 0xe7, 0xdd,
2276 0x85, 0xc5, 0xad, 0x4f, 0x07, 0xe7, 0xd5, 0xb2, 0x64, 0xf0, 0x1a, 0x1a,
2277 0x2c, 0xf9, 0x18, 0xca, 0x59, 0x7e, 0x5d, 0xf6 };
2278
2279 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01002280 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_HASH | PSA_KEY_USAGE_VERIFY_HASH );
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02002281 psa_set_key_algorithm( &attributes, alg );
2282 psa_set_key_type( &attributes, key_type );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002283
Ronald Cron5425a212020-08-04 14:58:35 +02002284 PSA_ASSERT( psa_import_key( &attributes, key_data, sizeof( key_data ),
2285 &key ) );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002286
Jaeden Amero252ef282019-02-15 14:05:35 +00002287 /* Call update without calling setup beforehand. */
2288 TEST_EQUAL( psa_mac_update( &operation, input, sizeof( input ) ),
2289 PSA_ERROR_BAD_STATE );
2290 PSA_ASSERT( psa_mac_abort( &operation ) );
2291
2292 /* Call sign finish without calling setup beforehand. */
2293 TEST_EQUAL( psa_mac_sign_finish( &operation, sign_mac, sizeof( sign_mac ),
2294 &sign_mac_length),
2295 PSA_ERROR_BAD_STATE );
2296 PSA_ASSERT( psa_mac_abort( &operation ) );
2297
2298 /* Call verify finish without calling setup beforehand. */
2299 TEST_EQUAL( psa_mac_verify_finish( &operation,
2300 verify_mac, sizeof( verify_mac ) ),
2301 PSA_ERROR_BAD_STATE );
2302 PSA_ASSERT( psa_mac_abort( &operation ) );
2303
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002304 /* Call setup twice in a row. */
Ronald Cron5425a212020-08-04 14:58:35 +02002305 PSA_ASSERT( psa_mac_sign_setup( &operation, key, alg ) );
Dave Rodgman5ae6f752021-06-24 11:36:14 +01002306 ASSERT_OPERATION_IS_ACTIVE( operation );
Ronald Cron5425a212020-08-04 14:58:35 +02002307 TEST_EQUAL( psa_mac_sign_setup( &operation, key, alg ),
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002308 PSA_ERROR_BAD_STATE );
Dave Rodgman5ae6f752021-06-24 11:36:14 +01002309 ASSERT_OPERATION_IS_INACTIVE( operation );
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002310 PSA_ASSERT( psa_mac_abort( &operation ) );
Dave Rodgman5ae6f752021-06-24 11:36:14 +01002311 ASSERT_OPERATION_IS_INACTIVE( operation );
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002312
Jaeden Amero252ef282019-02-15 14:05:35 +00002313 /* Call update after sign finish. */
Ronald Cron5425a212020-08-04 14:58:35 +02002314 PSA_ASSERT( psa_mac_sign_setup( &operation, key, alg ) );
Jaeden Amero252ef282019-02-15 14:05:35 +00002315 PSA_ASSERT( psa_mac_update( &operation, input, sizeof( input ) ) );
2316 PSA_ASSERT( psa_mac_sign_finish( &operation,
2317 sign_mac, sizeof( sign_mac ),
2318 &sign_mac_length ) );
2319 TEST_EQUAL( psa_mac_update( &operation, input, sizeof( input ) ),
2320 PSA_ERROR_BAD_STATE );
2321 PSA_ASSERT( psa_mac_abort( &operation ) );
2322
2323 /* Call update after verify finish. */
Ronald Cron5425a212020-08-04 14:58:35 +02002324 PSA_ASSERT( psa_mac_verify_setup( &operation, key, alg ) );
Jaeden Amero252ef282019-02-15 14:05:35 +00002325 PSA_ASSERT( psa_mac_update( &operation, input, sizeof( input ) ) );
2326 PSA_ASSERT( psa_mac_verify_finish( &operation,
2327 verify_mac, sizeof( verify_mac ) ) );
2328 TEST_EQUAL( psa_mac_update( &operation, input, sizeof( input ) ),
2329 PSA_ERROR_BAD_STATE );
2330 PSA_ASSERT( psa_mac_abort( &operation ) );
2331
2332 /* Call sign finish twice in a row. */
Ronald Cron5425a212020-08-04 14:58:35 +02002333 PSA_ASSERT( psa_mac_sign_setup( &operation, key, alg ) );
Jaeden Amero252ef282019-02-15 14:05:35 +00002334 PSA_ASSERT( psa_mac_update( &operation, input, sizeof( input ) ) );
2335 PSA_ASSERT( psa_mac_sign_finish( &operation,
2336 sign_mac, sizeof( sign_mac ),
2337 &sign_mac_length ) );
2338 TEST_EQUAL( psa_mac_sign_finish( &operation,
2339 sign_mac, sizeof( sign_mac ),
2340 &sign_mac_length ),
2341 PSA_ERROR_BAD_STATE );
2342 PSA_ASSERT( psa_mac_abort( &operation ) );
2343
2344 /* Call verify finish twice in a row. */
Ronald Cron5425a212020-08-04 14:58:35 +02002345 PSA_ASSERT( psa_mac_verify_setup( &operation, key, alg ) );
Jaeden Amero252ef282019-02-15 14:05:35 +00002346 PSA_ASSERT( psa_mac_update( &operation, input, sizeof( input ) ) );
2347 PSA_ASSERT( psa_mac_verify_finish( &operation,
2348 verify_mac, sizeof( verify_mac ) ) );
2349 TEST_EQUAL( psa_mac_verify_finish( &operation,
2350 verify_mac, sizeof( verify_mac ) ),
2351 PSA_ERROR_BAD_STATE );
2352 PSA_ASSERT( psa_mac_abort( &operation ) );
2353
2354 /* Setup sign but try verify. */
Ronald Cron5425a212020-08-04 14:58:35 +02002355 PSA_ASSERT( psa_mac_sign_setup( &operation, key, alg ) );
Jaeden Amero252ef282019-02-15 14:05:35 +00002356 PSA_ASSERT( psa_mac_update( &operation, input, sizeof( input ) ) );
Dave Rodgman647791d2021-06-23 12:49:59 +01002357 ASSERT_OPERATION_IS_ACTIVE( operation );
Jaeden Amero252ef282019-02-15 14:05:35 +00002358 TEST_EQUAL( psa_mac_verify_finish( &operation,
2359 verify_mac, sizeof( verify_mac ) ),
2360 PSA_ERROR_BAD_STATE );
Dave Rodgman647791d2021-06-23 12:49:59 +01002361 ASSERT_OPERATION_IS_INACTIVE( operation );
Jaeden Amero252ef282019-02-15 14:05:35 +00002362 PSA_ASSERT( psa_mac_abort( &operation ) );
Dave Rodgman647791d2021-06-23 12:49:59 +01002363 ASSERT_OPERATION_IS_INACTIVE( operation );
Jaeden Amero252ef282019-02-15 14:05:35 +00002364
2365 /* Setup verify but try sign. */
Ronald Cron5425a212020-08-04 14:58:35 +02002366 PSA_ASSERT( psa_mac_verify_setup( &operation, key, alg ) );
Jaeden Amero252ef282019-02-15 14:05:35 +00002367 PSA_ASSERT( psa_mac_update( &operation, input, sizeof( input ) ) );
Dave Rodgman647791d2021-06-23 12:49:59 +01002368 ASSERT_OPERATION_IS_ACTIVE( operation );
Jaeden Amero252ef282019-02-15 14:05:35 +00002369 TEST_EQUAL( psa_mac_sign_finish( &operation,
2370 sign_mac, sizeof( sign_mac ),
2371 &sign_mac_length ),
2372 PSA_ERROR_BAD_STATE );
Dave Rodgman647791d2021-06-23 12:49:59 +01002373 ASSERT_OPERATION_IS_INACTIVE( operation );
Jaeden Amero252ef282019-02-15 14:05:35 +00002374 PSA_ASSERT( psa_mac_abort( &operation ) );
Dave Rodgman647791d2021-06-23 12:49:59 +01002375 ASSERT_OPERATION_IS_INACTIVE( operation );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002376
Ronald Cron5425a212020-08-04 14:58:35 +02002377 PSA_ASSERT( psa_destroy_key( key ) );
Gilles Peskine76b29a72019-05-28 14:08:50 +02002378
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002379exit:
Gilles Peskine1153e7b2019-05-28 15:10:21 +02002380 PSA_DONE( );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002381}
2382/* END_CASE */
2383
2384/* BEGIN_CASE */
Gilles Peskinea7aa4422018-08-14 15:17:54 +02002385void mac_sign( int key_type_arg,
Ronald Cron5425a212020-08-04 14:58:35 +02002386 data_t *key_data,
Gilles Peskinea7aa4422018-08-14 15:17:54 +02002387 int alg_arg,
2388 data_t *input,
2389 data_t *expected_mac )
2390{
Ronald Cron5425a212020-08-04 14:58:35 +02002391 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskinea7aa4422018-08-14 15:17:54 +02002392 psa_key_type_t key_type = key_type_arg;
2393 psa_algorithm_t alg = alg_arg;
Jaeden Amero769ce272019-01-04 11:48:03 +00002394 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02002395 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine5e65cec2020-08-25 23:38:39 +02002396 uint8_t *actual_mac = NULL;
Gilles Peskinea7aa4422018-08-14 15:17:54 +02002397 size_t mac_buffer_size =
gabor-mezei-armcbcec212020-12-18 14:23:51 +01002398 PSA_MAC_LENGTH( key_type, PSA_BYTES_TO_BITS( key_data->len ), alg );
Gilles Peskinea7aa4422018-08-14 15:17:54 +02002399 size_t mac_length = 0;
Gilles Peskine8b356b52020-08-25 23:44:59 +02002400 const size_t output_sizes_to_test[] = {
2401 0,
2402 1,
2403 expected_mac->len - 1,
2404 expected_mac->len,
2405 expected_mac->len + 1,
2406 };
Gilles Peskinea7aa4422018-08-14 15:17:54 +02002407
Gilles Peskinea7aa4422018-08-14 15:17:54 +02002408 TEST_ASSERT( mac_buffer_size <= PSA_MAC_MAX_SIZE );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01002409 /* We expect PSA_MAC_LENGTH to be exact. */
Gilles Peskine3d404d62020-08-25 23:47:36 +02002410 TEST_ASSERT( expected_mac->len == mac_buffer_size );
Gilles Peskinea7aa4422018-08-14 15:17:54 +02002411
Gilles Peskine8817f612018-12-18 00:18:46 +01002412 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskinea7aa4422018-08-14 15:17:54 +02002413
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01002414 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_HASH );
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02002415 psa_set_key_algorithm( &attributes, alg );
2416 psa_set_key_type( &attributes, key_type );
Gilles Peskinea7aa4422018-08-14 15:17:54 +02002417
Ronald Cron5425a212020-08-04 14:58:35 +02002418 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
2419 &key ) );
Gilles Peskinea7aa4422018-08-14 15:17:54 +02002420
Gilles Peskine8b356b52020-08-25 23:44:59 +02002421 for( size_t i = 0; i < ARRAY_LENGTH( output_sizes_to_test ); i++ )
2422 {
2423 const size_t output_size = output_sizes_to_test[i];
2424 psa_status_t expected_status =
2425 ( output_size >= expected_mac->len ? PSA_SUCCESS :
2426 PSA_ERROR_BUFFER_TOO_SMALL );
Gilles Peskine5e65cec2020-08-25 23:38:39 +02002427
Chris Jones9634bb12021-01-20 15:56:42 +00002428 mbedtls_test_set_step( output_size );
Gilles Peskine8b356b52020-08-25 23:44:59 +02002429 ASSERT_ALLOC( actual_mac, output_size );
Gilles Peskinea7aa4422018-08-14 15:17:54 +02002430
gabor-mezei-arm534bb992021-03-01 15:35:48 +01002431 /* Calculate the MAC, one-shot case. */
2432 TEST_EQUAL( psa_mac_compute( key, alg,
2433 input->x, input->len,
2434 actual_mac, output_size, &mac_length ),
2435 expected_status );
2436 if( expected_status == PSA_SUCCESS )
2437 {
2438 ASSERT_COMPARE( expected_mac->x, expected_mac->len,
2439 actual_mac, mac_length );
2440 }
2441
2442 if( output_size > 0 )
2443 memset( actual_mac, 0, output_size );
2444
2445 /* Calculate the MAC, multi-part case. */
Ronald Cron5425a212020-08-04 14:58:35 +02002446 PSA_ASSERT( psa_mac_sign_setup( &operation, key, alg ) );
Gilles Peskine8b356b52020-08-25 23:44:59 +02002447 PSA_ASSERT( psa_mac_update( &operation,
2448 input->x, input->len ) );
2449 TEST_EQUAL( psa_mac_sign_finish( &operation,
2450 actual_mac, output_size,
2451 &mac_length ),
2452 expected_status );
2453 PSA_ASSERT( psa_mac_abort( &operation ) );
2454
2455 if( expected_status == PSA_SUCCESS )
2456 {
2457 ASSERT_COMPARE( expected_mac->x, expected_mac->len,
2458 actual_mac, mac_length );
2459 }
2460 mbedtls_free( actual_mac );
2461 actual_mac = NULL;
2462 }
Gilles Peskinea7aa4422018-08-14 15:17:54 +02002463
Gilles Peskinea7aa4422018-08-14 15:17:54 +02002464exit:
Gilles Peskine64f13ef2020-08-25 23:15:20 +02002465 psa_mac_abort( &operation );
Ronald Cron5425a212020-08-04 14:58:35 +02002466 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02002467 PSA_DONE( );
Gilles Peskine5e65cec2020-08-25 23:38:39 +02002468 mbedtls_free( actual_mac );
Gilles Peskinea7aa4422018-08-14 15:17:54 +02002469}
2470/* END_CASE */
2471
2472/* BEGIN_CASE */
Gilles Peskinec0ec9722018-06-18 17:03:37 +02002473void mac_verify( int key_type_arg,
Ronald Cron5425a212020-08-04 14:58:35 +02002474 data_t *key_data,
Gilles Peskinec0ec9722018-06-18 17:03:37 +02002475 int alg_arg,
2476 data_t *input,
2477 data_t *expected_mac )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002478{
Ronald Cron5425a212020-08-04 14:58:35 +02002479 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002480 psa_key_type_t key_type = key_type_arg;
2481 psa_algorithm_t alg = alg_arg;
Jaeden Amero769ce272019-01-04 11:48:03 +00002482 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02002483 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine29c4a6c2020-08-26 00:01:39 +02002484 uint8_t *perturbed_mac = NULL;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002485
Gilles Peskine69c12672018-06-28 00:07:19 +02002486 TEST_ASSERT( expected_mac->len <= PSA_MAC_MAX_SIZE );
2487
Gilles Peskine8817f612018-12-18 00:18:46 +01002488 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002489
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01002490 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_VERIFY_HASH );
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02002491 psa_set_key_algorithm( &attributes, alg );
2492 psa_set_key_type( &attributes, key_type );
mohammad16036df908f2018-04-02 08:34:15 -07002493
Ronald Cron5425a212020-08-04 14:58:35 +02002494 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
2495 &key ) );
Gilles Peskinec0ec9722018-06-18 17:03:37 +02002496
gabor-mezei-arm534bb992021-03-01 15:35:48 +01002497 /* Verify correct MAC, one-shot case. */
2498 PSA_ASSERT( psa_mac_verify( key, alg, input->x, input->len,
2499 expected_mac->x, expected_mac->len ) );
2500
2501 /* Verify correct MAC, multi-part case. */
Ronald Cron5425a212020-08-04 14:58:35 +02002502 PSA_ASSERT( psa_mac_verify_setup( &operation, key, alg ) );
Gilles Peskine8817f612018-12-18 00:18:46 +01002503 PSA_ASSERT( psa_mac_update( &operation,
2504 input->x, input->len ) );
2505 PSA_ASSERT( psa_mac_verify_finish( &operation,
2506 expected_mac->x,
2507 expected_mac->len ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002508
gabor-mezei-arm534bb992021-03-01 15:35:48 +01002509 /* Test a MAC that's too short, one-shot case. */
2510 TEST_EQUAL( psa_mac_verify( key, alg,
2511 input->x, input->len,
2512 expected_mac->x,
2513 expected_mac->len - 1 ),
2514 PSA_ERROR_INVALID_SIGNATURE );
2515
2516 /* Test a MAC that's too short, multi-part case. */
Ronald Cron5425a212020-08-04 14:58:35 +02002517 PSA_ASSERT( psa_mac_verify_setup( &operation, key, alg ) );
Gilles Peskine29c4a6c2020-08-26 00:01:39 +02002518 PSA_ASSERT( psa_mac_update( &operation,
2519 input->x, input->len ) );
2520 TEST_EQUAL( psa_mac_verify_finish( &operation,
2521 expected_mac->x,
2522 expected_mac->len - 1 ),
2523 PSA_ERROR_INVALID_SIGNATURE );
2524
gabor-mezei-arm534bb992021-03-01 15:35:48 +01002525 /* Test a MAC that's too long, one-shot case. */
Gilles Peskine29c4a6c2020-08-26 00:01:39 +02002526 ASSERT_ALLOC( perturbed_mac, expected_mac->len + 1 );
2527 memcpy( perturbed_mac, expected_mac->x, expected_mac->len );
gabor-mezei-arm534bb992021-03-01 15:35:48 +01002528 TEST_EQUAL( psa_mac_verify( key, alg,
2529 input->x, input->len,
2530 perturbed_mac, expected_mac->len + 1 ),
2531 PSA_ERROR_INVALID_SIGNATURE );
2532
2533 /* Test a MAC that's too long, multi-part case. */
Ronald Cron5425a212020-08-04 14:58:35 +02002534 PSA_ASSERT( psa_mac_verify_setup( &operation, key, alg ) );
Gilles Peskine29c4a6c2020-08-26 00:01:39 +02002535 PSA_ASSERT( psa_mac_update( &operation,
2536 input->x, input->len ) );
2537 TEST_EQUAL( psa_mac_verify_finish( &operation,
2538 perturbed_mac,
2539 expected_mac->len + 1 ),
2540 PSA_ERROR_INVALID_SIGNATURE );
2541
2542 /* Test changing one byte. */
2543 for( size_t i = 0; i < expected_mac->len; i++ )
2544 {
Chris Jones9634bb12021-01-20 15:56:42 +00002545 mbedtls_test_set_step( i );
Gilles Peskine29c4a6c2020-08-26 00:01:39 +02002546 perturbed_mac[i] ^= 1;
gabor-mezei-arm534bb992021-03-01 15:35:48 +01002547
2548 TEST_EQUAL( psa_mac_verify( key, alg,
2549 input->x, input->len,
2550 perturbed_mac, expected_mac->len ),
2551 PSA_ERROR_INVALID_SIGNATURE );
2552
Ronald Cron5425a212020-08-04 14:58:35 +02002553 PSA_ASSERT( psa_mac_verify_setup( &operation, key, alg ) );
Gilles Peskine29c4a6c2020-08-26 00:01:39 +02002554 PSA_ASSERT( psa_mac_update( &operation,
2555 input->x, input->len ) );
2556 TEST_EQUAL( psa_mac_verify_finish( &operation,
2557 perturbed_mac,
2558 expected_mac->len ),
2559 PSA_ERROR_INVALID_SIGNATURE );
2560 perturbed_mac[i] ^= 1;
2561 }
2562
Gilles Peskine8c9def32018-02-08 10:02:12 +01002563exit:
Gilles Peskine64f13ef2020-08-25 23:15:20 +02002564 psa_mac_abort( &operation );
Ronald Cron5425a212020-08-04 14:58:35 +02002565 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02002566 PSA_DONE( );
Gilles Peskine29c4a6c2020-08-26 00:01:39 +02002567 mbedtls_free( perturbed_mac );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002568}
2569/* END_CASE */
2570
2571/* BEGIN_CASE */
Jaeden Amero5bae2272019-01-04 11:48:27 +00002572void cipher_operation_init( )
2573{
Jaeden Ameroab439972019-02-15 14:12:05 +00002574 const uint8_t input[1] = { 0 };
2575 unsigned char output[1] = { 0 };
2576 size_t output_length;
Jaeden Amero5bae2272019-01-04 11:48:27 +00002577 /* Test each valid way of initializing the object, except for `= {0}`, as
2578 * Clang 5 complains when `-Wmissing-field-initializers` is used, even
2579 * though it's OK by the C standard. We could test for this, but we'd need
2580 * to supress the Clang warning for the test. */
2581 psa_cipher_operation_t func = psa_cipher_operation_init( );
2582 psa_cipher_operation_t init = PSA_CIPHER_OPERATION_INIT;
2583 psa_cipher_operation_t zero;
2584
2585 memset( &zero, 0, sizeof( zero ) );
2586
Jaeden Ameroab439972019-02-15 14:12:05 +00002587 /* A freshly-initialized cipher operation should not be usable. */
2588 TEST_EQUAL( psa_cipher_update( &func,
2589 input, sizeof( input ),
2590 output, sizeof( output ),
2591 &output_length ),
2592 PSA_ERROR_BAD_STATE );
2593 TEST_EQUAL( psa_cipher_update( &init,
2594 input, sizeof( input ),
2595 output, sizeof( output ),
2596 &output_length ),
2597 PSA_ERROR_BAD_STATE );
2598 TEST_EQUAL( psa_cipher_update( &zero,
2599 input, sizeof( input ),
2600 output, sizeof( output ),
2601 &output_length ),
2602 PSA_ERROR_BAD_STATE );
2603
Jaeden Amero5229bbb2019-02-07 16:33:37 +00002604 /* A default cipher operation should be abortable without error. */
2605 PSA_ASSERT( psa_cipher_abort( &func ) );
2606 PSA_ASSERT( psa_cipher_abort( &init ) );
2607 PSA_ASSERT( psa_cipher_abort( &zero ) );
Jaeden Amero5bae2272019-01-04 11:48:27 +00002608}
2609/* END_CASE */
2610
2611/* BEGIN_CASE */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002612void cipher_setup( int key_type_arg,
2613 data_t *key,
2614 int alg_arg,
2615 int expected_status_arg )
2616{
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002617 psa_key_type_t key_type = key_type_arg;
2618 psa_algorithm_t alg = alg_arg;
Gilles Peskineb866e2b2018-06-21 09:25:10 +02002619 psa_status_t expected_status = expected_status_arg;
Jaeden Amero5bae2272019-01-04 11:48:27 +00002620 psa_cipher_operation_t operation = PSA_CIPHER_OPERATION_INIT;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002621 psa_status_t status;
Gilles Peskine612ffd22021-01-20 18:51:00 +01002622#if defined(KNOWN_SUPPORTED_CIPHER_ALG)
Gilles Peskinef426e0f2019-02-25 17:42:03 +01002623 const uint8_t smoke_test_key_data[16] = "kkkkkkkkkkkkkkkk";
2624#endif
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002625
Gilles Peskine8817f612018-12-18 00:18:46 +01002626 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002627
Gilles Peskinef426e0f2019-02-25 17:42:03 +01002628 if( ! exercise_cipher_setup( key_type, key->x, key->len, alg,
2629 &operation, &status ) )
2630 goto exit;
Gilles Peskinefe11b722018-12-18 00:24:04 +01002631 TEST_EQUAL( status, expected_status );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002632
Gilles Peskinef426e0f2019-02-25 17:42:03 +01002633 /* The operation object should be reusable. */
2634#if defined(KNOWN_SUPPORTED_CIPHER_ALG)
2635 if( ! exercise_cipher_setup( KNOWN_SUPPORTED_CIPHER_KEY_TYPE,
2636 smoke_test_key_data,
2637 sizeof( smoke_test_key_data ),
2638 KNOWN_SUPPORTED_CIPHER_ALG,
2639 &operation, &status ) )
2640 goto exit;
2641 TEST_EQUAL( status, PSA_SUCCESS );
2642#endif
2643
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002644exit:
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
Ronald Cronee414c72021-03-18 18:50:08 +01002650/* BEGIN_CASE depends_on:PSA_WANT_KEY_TYPE_AES:PSA_WANT_ALG_CBC_PKCS7 */
Jaeden Ameroab439972019-02-15 14:12:05 +00002651void cipher_bad_order( )
2652{
Ronald Cron5425a212020-08-04 14:58:35 +02002653 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Jaeden Ameroab439972019-02-15 14:12:05 +00002654 psa_key_type_t key_type = PSA_KEY_TYPE_AES;
2655 psa_algorithm_t alg = PSA_ALG_CBC_PKCS7;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02002656 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Jaeden Ameroab439972019-02-15 14:12:05 +00002657 psa_cipher_operation_t operation = PSA_CIPHER_OPERATION_INIT;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01002658 unsigned char iv[PSA_BLOCK_CIPHER_BLOCK_LENGTH(PSA_KEY_TYPE_AES)] = { 0 };
Ronald Cron5425a212020-08-04 14:58:35 +02002659 const uint8_t key_data[] = {
Jaeden Ameroab439972019-02-15 14:12:05 +00002660 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa,
2661 0xaa, 0xaa, 0xaa, 0xaa };
2662 const uint8_t text[] = {
2663 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb,
2664 0xbb, 0xbb, 0xbb, 0xbb };
gabor-mezei-armcbcec212020-12-18 14:23:51 +01002665 uint8_t buffer[PSA_BLOCK_CIPHER_BLOCK_LENGTH(PSA_KEY_TYPE_AES)] = { 0 };
Jaeden Ameroab439972019-02-15 14:12:05 +00002666 size_t length = 0;
2667
2668 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02002669 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT | PSA_KEY_USAGE_DECRYPT );
2670 psa_set_key_algorithm( &attributes, alg );
2671 psa_set_key_type( &attributes, key_type );
Ronald Cron5425a212020-08-04 14:58:35 +02002672 PSA_ASSERT( psa_import_key( &attributes, key_data, sizeof( key_data ),
2673 &key ) );
Jaeden Ameroab439972019-02-15 14:12:05 +00002674
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002675 /* Call encrypt setup twice in a row. */
Ronald Cron5425a212020-08-04 14:58:35 +02002676 PSA_ASSERT( psa_cipher_encrypt_setup( &operation, key, alg ) );
Dave Rodgman5ae6f752021-06-24 11:36:14 +01002677 ASSERT_OPERATION_IS_ACTIVE( operation );
Ronald Cron5425a212020-08-04 14:58:35 +02002678 TEST_EQUAL( psa_cipher_encrypt_setup( &operation, key, alg ),
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002679 PSA_ERROR_BAD_STATE );
Dave Rodgman5ae6f752021-06-24 11:36:14 +01002680 ASSERT_OPERATION_IS_INACTIVE( operation );
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002681 PSA_ASSERT( psa_cipher_abort( &operation ) );
Dave Rodgman5ae6f752021-06-24 11:36:14 +01002682 ASSERT_OPERATION_IS_INACTIVE( operation );
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002683
2684 /* Call decrypt setup twice in a row. */
Ronald Cron5425a212020-08-04 14:58:35 +02002685 PSA_ASSERT( psa_cipher_decrypt_setup( &operation, key, alg ) );
Dave Rodgman5ae6f752021-06-24 11:36:14 +01002686 ASSERT_OPERATION_IS_ACTIVE( operation );
Ronald Cron5425a212020-08-04 14:58:35 +02002687 TEST_EQUAL( psa_cipher_decrypt_setup( &operation, key, alg ),
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002688 PSA_ERROR_BAD_STATE );
Dave Rodgman5ae6f752021-06-24 11:36:14 +01002689 ASSERT_OPERATION_IS_INACTIVE( operation );
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002690 PSA_ASSERT( psa_cipher_abort( &operation ) );
Dave Rodgman5ae6f752021-06-24 11:36:14 +01002691 ASSERT_OPERATION_IS_INACTIVE( operation );
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002692
Jaeden Ameroab439972019-02-15 14:12:05 +00002693 /* Generate an IV without calling setup beforehand. */
2694 TEST_EQUAL( psa_cipher_generate_iv( &operation,
2695 buffer, sizeof( buffer ),
2696 &length ),
2697 PSA_ERROR_BAD_STATE );
2698 PSA_ASSERT( psa_cipher_abort( &operation ) );
2699
2700 /* Generate an IV twice in a row. */
Ronald Cron5425a212020-08-04 14:58:35 +02002701 PSA_ASSERT( psa_cipher_encrypt_setup( &operation, key, alg ) );
Jaeden Ameroab439972019-02-15 14:12:05 +00002702 PSA_ASSERT( psa_cipher_generate_iv( &operation,
2703 buffer, sizeof( buffer ),
2704 &length ) );
Dave Rodgman647791d2021-06-23 12:49:59 +01002705 ASSERT_OPERATION_IS_ACTIVE( operation );
Jaeden Ameroab439972019-02-15 14:12:05 +00002706 TEST_EQUAL( psa_cipher_generate_iv( &operation,
2707 buffer, sizeof( buffer ),
2708 &length ),
2709 PSA_ERROR_BAD_STATE );
Dave Rodgman647791d2021-06-23 12:49:59 +01002710 ASSERT_OPERATION_IS_INACTIVE( operation );
Jaeden Ameroab439972019-02-15 14:12:05 +00002711 PSA_ASSERT( psa_cipher_abort( &operation ) );
Dave Rodgman647791d2021-06-23 12:49:59 +01002712 ASSERT_OPERATION_IS_INACTIVE( operation );
Jaeden Ameroab439972019-02-15 14:12:05 +00002713
2714 /* Generate an IV after it's already set. */
Ronald Cron5425a212020-08-04 14:58:35 +02002715 PSA_ASSERT( psa_cipher_encrypt_setup( &operation, key, alg ) );
Jaeden Ameroab439972019-02-15 14:12:05 +00002716 PSA_ASSERT( psa_cipher_set_iv( &operation,
2717 iv, sizeof( iv ) ) );
2718 TEST_EQUAL( psa_cipher_generate_iv( &operation,
2719 buffer, sizeof( buffer ),
2720 &length ),
2721 PSA_ERROR_BAD_STATE );
2722 PSA_ASSERT( psa_cipher_abort( &operation ) );
2723
2724 /* Set an IV without calling setup beforehand. */
2725 TEST_EQUAL( psa_cipher_set_iv( &operation,
2726 iv, sizeof( iv ) ),
2727 PSA_ERROR_BAD_STATE );
2728 PSA_ASSERT( psa_cipher_abort( &operation ) );
2729
2730 /* Set an IV after it's already set. */
Ronald Cron5425a212020-08-04 14:58:35 +02002731 PSA_ASSERT( psa_cipher_encrypt_setup( &operation, key, alg ) );
Jaeden Ameroab439972019-02-15 14:12:05 +00002732 PSA_ASSERT( psa_cipher_set_iv( &operation,
2733 iv, sizeof( iv ) ) );
Dave Rodgman647791d2021-06-23 12:49:59 +01002734 ASSERT_OPERATION_IS_ACTIVE( operation );
Jaeden Ameroab439972019-02-15 14:12:05 +00002735 TEST_EQUAL( psa_cipher_set_iv( &operation,
2736 iv, sizeof( iv ) ),
2737 PSA_ERROR_BAD_STATE );
Dave Rodgman647791d2021-06-23 12:49:59 +01002738 ASSERT_OPERATION_IS_INACTIVE( operation );
Jaeden Ameroab439972019-02-15 14:12:05 +00002739 PSA_ASSERT( psa_cipher_abort( &operation ) );
Dave Rodgman647791d2021-06-23 12:49:59 +01002740 ASSERT_OPERATION_IS_INACTIVE( operation );
Jaeden Ameroab439972019-02-15 14:12:05 +00002741
2742 /* Set an IV after it's already generated. */
Ronald Cron5425a212020-08-04 14:58:35 +02002743 PSA_ASSERT( psa_cipher_encrypt_setup( &operation, key, alg ) );
Jaeden Ameroab439972019-02-15 14:12:05 +00002744 PSA_ASSERT( psa_cipher_generate_iv( &operation,
2745 buffer, sizeof( buffer ),
2746 &length ) );
2747 TEST_EQUAL( psa_cipher_set_iv( &operation,
2748 iv, sizeof( iv ) ),
2749 PSA_ERROR_BAD_STATE );
2750 PSA_ASSERT( psa_cipher_abort( &operation ) );
2751
2752 /* Call update without calling setup beforehand. */
2753 TEST_EQUAL( psa_cipher_update( &operation,
2754 text, sizeof( text ),
2755 buffer, sizeof( buffer ),
2756 &length ),
2757 PSA_ERROR_BAD_STATE );
2758 PSA_ASSERT( psa_cipher_abort( &operation ) );
2759
2760 /* Call update without an IV where an IV is required. */
Dave Rodgman095dadc2021-06-23 12:48:52 +01002761 PSA_ASSERT( psa_cipher_encrypt_setup( &operation, key, alg ) );
Dave Rodgman647791d2021-06-23 12:49:59 +01002762 ASSERT_OPERATION_IS_ACTIVE( operation );
Jaeden Ameroab439972019-02-15 14:12:05 +00002763 TEST_EQUAL( psa_cipher_update( &operation,
2764 text, sizeof( text ),
2765 buffer, sizeof( buffer ),
2766 &length ),
2767 PSA_ERROR_BAD_STATE );
Dave Rodgman647791d2021-06-23 12:49:59 +01002768 ASSERT_OPERATION_IS_INACTIVE( operation );
Jaeden Ameroab439972019-02-15 14:12:05 +00002769 PSA_ASSERT( psa_cipher_abort( &operation ) );
Dave Rodgman647791d2021-06-23 12:49:59 +01002770 ASSERT_OPERATION_IS_INACTIVE( operation );
Jaeden Ameroab439972019-02-15 14:12:05 +00002771
2772 /* Call update after finish. */
Ronald Cron5425a212020-08-04 14:58:35 +02002773 PSA_ASSERT( psa_cipher_encrypt_setup( &operation, key, alg ) );
Jaeden Ameroab439972019-02-15 14:12:05 +00002774 PSA_ASSERT( psa_cipher_set_iv( &operation,
2775 iv, sizeof( iv ) ) );
2776 PSA_ASSERT( psa_cipher_finish( &operation,
2777 buffer, sizeof( buffer ), &length ) );
2778 TEST_EQUAL( psa_cipher_update( &operation,
2779 text, sizeof( text ),
2780 buffer, sizeof( buffer ),
2781 &length ),
2782 PSA_ERROR_BAD_STATE );
2783 PSA_ASSERT( psa_cipher_abort( &operation ) );
2784
2785 /* Call finish without calling setup beforehand. */
2786 TEST_EQUAL( psa_cipher_finish( &operation,
2787 buffer, sizeof( buffer ), &length ),
2788 PSA_ERROR_BAD_STATE );
2789 PSA_ASSERT( psa_cipher_abort( &operation ) );
2790
2791 /* Call finish without an IV where an IV is required. */
Ronald Cron5425a212020-08-04 14:58:35 +02002792 PSA_ASSERT( psa_cipher_encrypt_setup( &operation, key, alg ) );
Jaeden Ameroab439972019-02-15 14:12:05 +00002793 /* Not calling update means we are encrypting an empty buffer, which is OK
2794 * for cipher modes with padding. */
Dave Rodgman647791d2021-06-23 12:49:59 +01002795 ASSERT_OPERATION_IS_ACTIVE( operation );
Jaeden Ameroab439972019-02-15 14:12:05 +00002796 TEST_EQUAL( psa_cipher_finish( &operation,
2797 buffer, sizeof( buffer ), &length ),
2798 PSA_ERROR_BAD_STATE );
Dave Rodgman647791d2021-06-23 12:49:59 +01002799 ASSERT_OPERATION_IS_INACTIVE( operation );
Jaeden Ameroab439972019-02-15 14:12:05 +00002800 PSA_ASSERT( psa_cipher_abort( &operation ) );
Dave Rodgman647791d2021-06-23 12:49:59 +01002801 ASSERT_OPERATION_IS_INACTIVE( operation );
Jaeden Ameroab439972019-02-15 14:12:05 +00002802
2803 /* Call finish twice in a row. */
Ronald Cron5425a212020-08-04 14:58:35 +02002804 PSA_ASSERT( psa_cipher_encrypt_setup( &operation, key, alg ) );
Jaeden Ameroab439972019-02-15 14:12:05 +00002805 PSA_ASSERT( psa_cipher_set_iv( &operation,
2806 iv, sizeof( iv ) ) );
2807 PSA_ASSERT( psa_cipher_finish( &operation,
2808 buffer, sizeof( buffer ), &length ) );
2809 TEST_EQUAL( psa_cipher_finish( &operation,
2810 buffer, sizeof( buffer ), &length ),
2811 PSA_ERROR_BAD_STATE );
2812 PSA_ASSERT( psa_cipher_abort( &operation ) );
2813
Ronald Cron5425a212020-08-04 14:58:35 +02002814 PSA_ASSERT( psa_destroy_key( key ) );
Gilles Peskine76b29a72019-05-28 14:08:50 +02002815
Jaeden Ameroab439972019-02-15 14:12:05 +00002816exit:
Gilles Peskine64f13ef2020-08-25 23:15:20 +02002817 psa_cipher_abort( &operation );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02002818 PSA_DONE( );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002819}
2820/* END_CASE */
2821
2822/* BEGIN_CASE */
gabor-mezei-arma56756e2021-06-25 15:49:14 +02002823void cipher_encrypt_fail( int alg_arg,
2824 int key_type_arg,
2825 data_t *key_data,
2826 data_t *input,
2827 int expected_status_arg )
Gilles Peskine50e586b2018-06-08 14:28:46 +02002828{
Ronald Cron5425a212020-08-04 14:58:35 +02002829 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine50e586b2018-06-08 14:28:46 +02002830 psa_status_t status;
2831 psa_key_type_t key_type = key_type_arg;
2832 psa_algorithm_t alg = alg_arg;
Gilles Peskineb866e2b2018-06-21 09:25:10 +02002833 psa_status_t expected_status = expected_status_arg;
itayzafrir3e02b3b2018-06-12 17:06:52 +03002834 unsigned char *output = NULL;
Gilles Peskine50e586b2018-06-08 14:28:46 +02002835 size_t output_buffer_size = 0;
gabor-mezei-armf494bcd2021-03-01 15:11:46 +01002836 size_t output_length = 0;
2837 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
2838
2839 if ( PSA_ERROR_BAD_STATE != expected_status )
2840 {
2841 PSA_ASSERT( psa_crypto_init( ) );
2842
2843 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
2844 psa_set_key_algorithm( &attributes, alg );
2845 psa_set_key_type( &attributes, key_type );
2846
2847 output_buffer_size = PSA_CIPHER_ENCRYPT_OUTPUT_SIZE( key_type, alg,
2848 input->len );
2849 ASSERT_ALLOC( output, output_buffer_size );
2850
2851 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
2852 &key ) );
2853 }
2854
2855 status = psa_cipher_encrypt( key, alg, input->x, input->len, output,
2856 output_buffer_size, &output_length );
2857
2858 TEST_EQUAL( status, expected_status );
2859
2860exit:
2861 mbedtls_free( output );
2862 psa_destroy_key( key );
2863 PSA_DONE( );
2864}
2865/* END_CASE */
2866
2867/* BEGIN_CASE */
Mateusz Starzyked71e922021-10-21 10:04:57 +02002868void cipher_encrypt_validate_iv_length( int alg, int key_type, data_t* key_data,
2869 data_t *input, int iv_length,
2870 int expected_result )
2871{
2872 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
2873 psa_cipher_operation_t operation = PSA_CIPHER_OPERATION_INIT;
2874 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
2875 size_t output_buffer_size = 0;
2876 unsigned char *output = NULL;
2877
2878 output_buffer_size = PSA_CIPHER_ENCRYPT_OUTPUT_SIZE( key_type, alg, input->len );
2879 ASSERT_ALLOC( output, output_buffer_size );
2880
2881 PSA_ASSERT( psa_crypto_init( ) );
2882
2883 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
2884 psa_set_key_algorithm( &attributes, alg );
2885 psa_set_key_type( &attributes, key_type );
2886
2887 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
2888 &key ) );
2889 PSA_ASSERT( psa_cipher_encrypt_setup( &operation, key, alg ) );
2890 TEST_EQUAL( expected_result, psa_cipher_set_iv( &operation, output,
2891 iv_length ) );
2892
2893exit:
2894 psa_cipher_abort( &operation );
2895 mbedtls_free( output );
2896 psa_destroy_key( key );
2897 PSA_DONE( );
2898}
2899/* END_CASE */
2900
2901/* BEGIN_CASE */
gabor-mezei-arma56756e2021-06-25 15:49:14 +02002902void cipher_encrypt_alg_without_iv( int alg_arg,
2903 int key_type_arg,
2904 data_t *key_data,
2905 data_t *input,
2906 data_t *expected_output )
gabor-mezei-armf494bcd2021-03-01 15:11:46 +01002907{
2908 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
2909 psa_key_type_t key_type = key_type_arg;
2910 psa_algorithm_t alg = alg_arg;
Ronald Cron6c9bb0f2021-07-15 09:38:11 +02002911 psa_cipher_operation_t operation = PSA_CIPHER_OPERATION_INIT;
2912 uint8_t iv[1] = { 0x5a };
2913 size_t iv_length;
gabor-mezei-armf494bcd2021-03-01 15:11:46 +01002914 unsigned char *output = NULL;
2915 size_t output_buffer_size = 0;
2916 size_t output_length = 0;
2917 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
2918
2919 PSA_ASSERT( psa_crypto_init( ) );
2920
2921 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
2922 psa_set_key_algorithm( &attributes, alg );
2923 psa_set_key_type( &attributes, key_type );
2924
2925 output_buffer_size = PSA_CIPHER_ENCRYPT_OUTPUT_SIZE( key_type, alg, input->len );
2926 ASSERT_ALLOC( output, output_buffer_size );
2927
2928 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
2929 &key ) );
2930
Ronald Cron6c9bb0f2021-07-15 09:38:11 +02002931 PSA_ASSERT( psa_cipher_encrypt_setup( &operation, key, alg ) );
2932 TEST_EQUAL( psa_cipher_set_iv( &operation, iv, sizeof( iv ) ),
2933 PSA_ERROR_BAD_STATE );
2934 PSA_ASSERT( psa_cipher_encrypt_setup( &operation, key, alg ) );
2935 TEST_EQUAL( psa_cipher_generate_iv( &operation, iv, sizeof( iv ),
2936 &iv_length ),
2937 PSA_ERROR_BAD_STATE );
2938
gabor-mezei-armf494bcd2021-03-01 15:11:46 +01002939 PSA_ASSERT( psa_cipher_encrypt( key, alg, input->x, input->len, output,
2940 output_buffer_size, &output_length ) );
2941 TEST_ASSERT( output_length <=
2942 PSA_CIPHER_ENCRYPT_OUTPUT_SIZE( key_type, alg, input->len ) );
2943 TEST_ASSERT( output_length <=
2944 PSA_CIPHER_ENCRYPT_OUTPUT_MAX_SIZE( input->len ) );
2945
2946 ASSERT_COMPARE( expected_output->x, expected_output->len,
2947 output, output_length );
2948exit:
2949 mbedtls_free( output );
2950 psa_destroy_key( key );
2951 PSA_DONE( );
2952}
2953/* END_CASE */
2954
2955/* BEGIN_CASE */
Paul Elliotta417f562021-07-14 12:31:21 +01002956void cipher_bad_key( int alg_arg, int key_type_arg, data_t *key_data )
2957{
2958 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
2959 psa_algorithm_t alg = alg_arg;
2960 psa_key_type_t key_type = key_type_arg;
2961 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
2962 psa_cipher_operation_t operation = PSA_CIPHER_OPERATION_INIT;
2963 psa_status_t status;
2964
2965 PSA_ASSERT( psa_crypto_init( ) );
2966
2967 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
2968 psa_set_key_algorithm( &attributes, alg );
2969 psa_set_key_type( &attributes, key_type );
2970
2971 /* Usage of either of these two size macros would cause divide by zero
2972 * with incorrect key types previously. Input length should be irrelevant
2973 * here. */
2974 TEST_EQUAL( PSA_CIPHER_ENCRYPT_OUTPUT_SIZE( key_type, alg, 16 ),
2975 0 );
2976 TEST_EQUAL( PSA_CIPHER_UPDATE_OUTPUT_SIZE( key_type, alg, 16 ), 0 );
2977
2978
2979 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
2980 &key ) );
2981
2982 /* Should fail due to invalid alg type (to support invalid key type).
2983 * Encrypt or decrypt will end up in the same place. */
2984 status = psa_cipher_encrypt_setup( &operation, key, alg );
2985
2986 TEST_EQUAL( status, PSA_ERROR_INVALID_ARGUMENT );
2987
2988exit:
2989 psa_cipher_abort( &operation );
2990 psa_destroy_key( key );
2991 PSA_DONE( );
2992}
2993/* END_CASE */
2994
2995/* BEGIN_CASE */
gabor-mezei-armf494bcd2021-03-01 15:11:46 +01002996void cipher_encrypt_validation( int alg_arg,
2997 int key_type_arg,
2998 data_t *key_data,
2999 data_t *input )
3000{
3001 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
3002 psa_key_type_t key_type = key_type_arg;
3003 psa_algorithm_t alg = alg_arg;
3004 size_t iv_size = PSA_CIPHER_IV_LENGTH ( key_type, alg );
3005 unsigned char *output1 = NULL;
3006 size_t output1_buffer_size = 0;
3007 size_t output1_length = 0;
3008 unsigned char *output2 = NULL;
3009 size_t output2_buffer_size = 0;
3010 size_t output2_length = 0;
Gilles Peskine50e586b2018-06-08 14:28:46 +02003011 size_t function_output_length = 0;
Jaeden Amero5bae2272019-01-04 11:48:27 +00003012 psa_cipher_operation_t operation = PSA_CIPHER_OPERATION_INIT;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02003013 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine50e586b2018-06-08 14:28:46 +02003014
Gilles Peskine8817f612018-12-18 00:18:46 +01003015 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine50e586b2018-06-08 14:28:46 +02003016
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02003017 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
3018 psa_set_key_algorithm( &attributes, alg );
3019 psa_set_key_type( &attributes, key_type );
Moran Pekered346952018-07-05 15:22:45 +03003020
gabor-mezei-armf494bcd2021-03-01 15:11:46 +01003021 output1_buffer_size = PSA_CIPHER_ENCRYPT_OUTPUT_SIZE( key_type, alg, input->len );
3022 output2_buffer_size = PSA_CIPHER_UPDATE_OUTPUT_SIZE( key_type, alg, input->len ) +
3023 PSA_CIPHER_FINISH_OUTPUT_SIZE( key_type, alg );
3024 ASSERT_ALLOC( output1, output1_buffer_size );
3025 ASSERT_ALLOC( output2, output2_buffer_size );
3026
Ronald Cron5425a212020-08-04 14:58:35 +02003027 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
3028 &key ) );
Gilles Peskine50e586b2018-06-08 14:28:46 +02003029
gabor-mezei-arm50c86cf2021-06-25 15:47:50 +02003030 /* The one-shot cipher encryption uses generated iv so validating
3031 the output is not possible. Validating with multipart encryption. */
gabor-mezei-armf494bcd2021-03-01 15:11:46 +01003032 PSA_ASSERT( psa_cipher_encrypt( key, alg, input->x, input->len, output1,
3033 output1_buffer_size, &output1_length ) );
3034 TEST_ASSERT( output1_length <=
3035 PSA_CIPHER_ENCRYPT_OUTPUT_SIZE( key_type, alg, input->len ) );
3036 TEST_ASSERT( output1_length <=
gabor-mezei-armceface22021-01-21 12:26:17 +01003037 PSA_CIPHER_ENCRYPT_OUTPUT_MAX_SIZE( input->len ) );
gabor-mezei-armf494bcd2021-03-01 15:11:46 +01003038
3039 PSA_ASSERT( psa_cipher_encrypt_setup( &operation, key, alg ) );
3040 PSA_ASSERT( psa_cipher_set_iv( &operation, output1, iv_size ) );
Gilles Peskine50e586b2018-06-08 14:28:46 +02003041
Gilles Peskine8817f612018-12-18 00:18:46 +01003042 PSA_ASSERT( psa_cipher_update( &operation,
3043 input->x, input->len,
gabor-mezei-armf494bcd2021-03-01 15:11:46 +01003044 output2, output2_buffer_size,
Gilles Peskine8817f612018-12-18 00:18:46 +01003045 &function_output_length ) );
gabor-mezei-armceface22021-01-21 12:26:17 +01003046 TEST_ASSERT( function_output_length <=
3047 PSA_CIPHER_UPDATE_OUTPUT_SIZE( key_type, alg, input->len ) );
3048 TEST_ASSERT( function_output_length <=
3049 PSA_CIPHER_UPDATE_OUTPUT_MAX_SIZE( input->len ) );
gabor-mezei-armf494bcd2021-03-01 15:11:46 +01003050 output2_length += function_output_length;
gabor-mezei-armceface22021-01-21 12:26:17 +01003051
gabor-mezei-armf494bcd2021-03-01 15:11:46 +01003052 PSA_ASSERT( psa_cipher_finish( &operation,
3053 output2 + output2_length,
3054 output2_buffer_size - output2_length,
3055 &function_output_length ) );
gabor-mezei-armceface22021-01-21 12:26:17 +01003056 TEST_ASSERT( function_output_length <=
3057 PSA_CIPHER_FINISH_OUTPUT_SIZE( key_type, alg ) );
3058 TEST_ASSERT( function_output_length <=
3059 PSA_CIPHER_FINISH_OUTPUT_MAX_SIZE );
gabor-mezei-armf494bcd2021-03-01 15:11:46 +01003060 output2_length += function_output_length;
Gilles Peskinea7ec95f2018-06-08 14:40:59 +02003061
gabor-mezei-armf494bcd2021-03-01 15:11:46 +01003062 PSA_ASSERT( psa_cipher_abort( &operation ) );
3063 ASSERT_COMPARE( output1 + iv_size, output1_length - iv_size,
3064 output2, output2_length );
Gilles Peskinea7ec95f2018-06-08 14:40:59 +02003065
Gilles Peskine50e586b2018-06-08 14:28:46 +02003066exit:
Gilles Peskine64f13ef2020-08-25 23:15:20 +02003067 psa_cipher_abort( &operation );
gabor-mezei-armf494bcd2021-03-01 15:11:46 +01003068 mbedtls_free( output1 );
3069 mbedtls_free( output2 );
Ronald Cron5425a212020-08-04 14:58:35 +02003070 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02003071 PSA_DONE( );
Gilles Peskine50e586b2018-06-08 14:28:46 +02003072}
3073/* END_CASE */
3074
3075/* BEGIN_CASE */
3076void cipher_encrypt_multipart( int alg_arg, int key_type_arg,
Ronald Cron5425a212020-08-04 14:58:35 +02003077 data_t *key_data, data_t *iv,
itayzafrir3e02b3b2018-06-12 17:06:52 +03003078 data_t *input,
Gilles Peskinee0866522019-02-19 19:44:00 +01003079 int first_part_size_arg,
3080 int output1_length_arg, int output2_length_arg,
gabor-mezei-arm95aad832021-06-25 18:21:33 +02003081 data_t *expected_output,
3082 int expected_status_arg )
Gilles Peskine50e586b2018-06-08 14:28:46 +02003083{
Ronald Cron5425a212020-08-04 14:58:35 +02003084 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine50e586b2018-06-08 14:28:46 +02003085 psa_key_type_t key_type = key_type_arg;
3086 psa_algorithm_t alg = alg_arg;
gabor-mezei-arm95aad832021-06-25 18:21:33 +02003087 psa_status_t status;
3088 psa_status_t expected_status = expected_status_arg;
Gilles Peskinee0866522019-02-19 19:44:00 +01003089 size_t first_part_size = first_part_size_arg;
3090 size_t output1_length = output1_length_arg;
3091 size_t output2_length = output2_length_arg;
itayzafrir3e02b3b2018-06-12 17:06:52 +03003092 unsigned char *output = NULL;
Gilles Peskine50e586b2018-06-08 14:28:46 +02003093 size_t output_buffer_size = 0;
3094 size_t function_output_length = 0;
Gilles Peskinea7ec95f2018-06-08 14:40:59 +02003095 size_t total_output_length = 0;
Jaeden Amero5bae2272019-01-04 11:48:27 +00003096 psa_cipher_operation_t operation = PSA_CIPHER_OPERATION_INIT;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02003097 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine50e586b2018-06-08 14:28:46 +02003098
Gilles Peskine8817f612018-12-18 00:18:46 +01003099 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine50e586b2018-06-08 14:28:46 +02003100
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02003101 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
3102 psa_set_key_algorithm( &attributes, alg );
3103 psa_set_key_type( &attributes, key_type );
Moran Pekered346952018-07-05 15:22:45 +03003104
Ronald Cron5425a212020-08-04 14:58:35 +02003105 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
3106 &key ) );
Gilles Peskine50e586b2018-06-08 14:28:46 +02003107
Ronald Cron5425a212020-08-04 14:58:35 +02003108 PSA_ASSERT( psa_cipher_encrypt_setup( &operation, key, alg ) );
Gilles Peskine50e586b2018-06-08 14:28:46 +02003109
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02003110 if( iv->len > 0 )
3111 {
Steven Cooremana6033e92020-08-25 11:47:50 +02003112 PSA_ASSERT( psa_cipher_set_iv( &operation, iv->x, iv->len ) );
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02003113 }
3114
gabor-mezei-armf494bcd2021-03-01 15:11:46 +01003115 output_buffer_size = PSA_CIPHER_UPDATE_OUTPUT_SIZE( key_type, alg, input->len ) +
3116 PSA_CIPHER_FINISH_OUTPUT_SIZE( key_type, alg );
Gilles Peskine8cebbba2018-09-27 13:54:18 +02003117 ASSERT_ALLOC( output, output_buffer_size );
Gilles Peskine50e586b2018-06-08 14:28:46 +02003118
Gilles Peskinee0866522019-02-19 19:44:00 +01003119 TEST_ASSERT( first_part_size <= input->len );
Gilles Peskine8817f612018-12-18 00:18:46 +01003120 PSA_ASSERT( psa_cipher_update( &operation, input->x, first_part_size,
3121 output, output_buffer_size,
3122 &function_output_length ) );
Gilles Peskinee0866522019-02-19 19:44:00 +01003123 TEST_ASSERT( function_output_length == output1_length );
gabor-mezei-armceface22021-01-21 12:26:17 +01003124 TEST_ASSERT( function_output_length <=
3125 PSA_CIPHER_UPDATE_OUTPUT_SIZE( key_type, alg, first_part_size ) );
3126 TEST_ASSERT( function_output_length <=
3127 PSA_CIPHER_UPDATE_OUTPUT_MAX_SIZE( first_part_size) );
Gilles Peskinea7ec95f2018-06-08 14:40:59 +02003128 total_output_length += function_output_length;
gabor-mezei-armceface22021-01-21 12:26:17 +01003129
gabor-mezei-arm95aad832021-06-25 18:21:33 +02003130 if( first_part_size < input->len )
3131 {
3132 PSA_ASSERT( psa_cipher_update( &operation,
3133 input->x + first_part_size,
3134 input->len - first_part_size,
3135 ( output_buffer_size == 0 ? NULL :
3136 output + total_output_length ),
3137 output_buffer_size - total_output_length,
3138 &function_output_length ) );
3139 TEST_ASSERT( function_output_length == output2_length );
3140 TEST_ASSERT( function_output_length <=
3141 PSA_CIPHER_UPDATE_OUTPUT_SIZE( key_type,
3142 alg,
3143 input->len - first_part_size ) );
3144 TEST_ASSERT( function_output_length <=
3145 PSA_CIPHER_UPDATE_OUTPUT_MAX_SIZE( input->len ) );
3146 total_output_length += function_output_length;
3147 }
gabor-mezei-armceface22021-01-21 12:26:17 +01003148
gabor-mezei-arm95aad832021-06-25 18:21:33 +02003149 status = psa_cipher_finish( &operation,
3150 ( output_buffer_size == 0 ? NULL :
3151 output + total_output_length ),
3152 output_buffer_size - total_output_length,
3153 &function_output_length );
gabor-mezei-armceface22021-01-21 12:26:17 +01003154 TEST_ASSERT( function_output_length <=
3155 PSA_CIPHER_FINISH_OUTPUT_SIZE( key_type, alg ) );
3156 TEST_ASSERT( function_output_length <=
3157 PSA_CIPHER_FINISH_OUTPUT_MAX_SIZE );
Gilles Peskinea7ec95f2018-06-08 14:40:59 +02003158 total_output_length += function_output_length;
gabor-mezei-arm95aad832021-06-25 18:21:33 +02003159 TEST_EQUAL( status, expected_status );
Gilles Peskine50e586b2018-06-08 14:28:46 +02003160
gabor-mezei-arm95aad832021-06-25 18:21:33 +02003161 if( expected_status == PSA_SUCCESS )
3162 {
3163 PSA_ASSERT( psa_cipher_abort( &operation ) );
3164
3165 ASSERT_COMPARE( expected_output->x, expected_output->len,
3166 output, total_output_length );
3167 }
Gilles Peskine50e586b2018-06-08 14:28:46 +02003168
3169exit:
Gilles Peskine64f13ef2020-08-25 23:15:20 +02003170 psa_cipher_abort( &operation );
itayzafrir3e02b3b2018-06-12 17:06:52 +03003171 mbedtls_free( output );
Ronald Cron5425a212020-08-04 14:58:35 +02003172 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02003173 PSA_DONE( );
Gilles Peskine50e586b2018-06-08 14:28:46 +02003174}
3175/* END_CASE */
3176
3177/* BEGIN_CASE */
3178void cipher_decrypt_multipart( int alg_arg, int key_type_arg,
Ronald Cron5425a212020-08-04 14:58:35 +02003179 data_t *key_data, data_t *iv,
itayzafrir3e02b3b2018-06-12 17:06:52 +03003180 data_t *input,
Gilles Peskinee0866522019-02-19 19:44:00 +01003181 int first_part_size_arg,
3182 int output1_length_arg, int output2_length_arg,
gabor-mezei-arm95aad832021-06-25 18:21:33 +02003183 data_t *expected_output,
3184 int expected_status_arg )
Gilles Peskine50e586b2018-06-08 14:28:46 +02003185{
Ronald Cron5425a212020-08-04 14:58:35 +02003186 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine50e586b2018-06-08 14:28:46 +02003187 psa_key_type_t key_type = key_type_arg;
3188 psa_algorithm_t alg = alg_arg;
gabor-mezei-arm95aad832021-06-25 18:21:33 +02003189 psa_status_t status;
3190 psa_status_t expected_status = expected_status_arg;
Gilles Peskinee0866522019-02-19 19:44:00 +01003191 size_t first_part_size = first_part_size_arg;
3192 size_t output1_length = output1_length_arg;
3193 size_t output2_length = output2_length_arg;
itayzafrir3e02b3b2018-06-12 17:06:52 +03003194 unsigned char *output = NULL;
Gilles Peskine50e586b2018-06-08 14:28:46 +02003195 size_t output_buffer_size = 0;
3196 size_t function_output_length = 0;
Gilles Peskinea7ec95f2018-06-08 14:40:59 +02003197 size_t total_output_length = 0;
Jaeden Amero5bae2272019-01-04 11:48:27 +00003198 psa_cipher_operation_t operation = PSA_CIPHER_OPERATION_INIT;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02003199 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine50e586b2018-06-08 14:28:46 +02003200
Gilles Peskine8817f612018-12-18 00:18:46 +01003201 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine50e586b2018-06-08 14:28:46 +02003202
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02003203 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DECRYPT );
3204 psa_set_key_algorithm( &attributes, alg );
3205 psa_set_key_type( &attributes, key_type );
Moran Pekered346952018-07-05 15:22:45 +03003206
Ronald Cron5425a212020-08-04 14:58:35 +02003207 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
3208 &key ) );
Gilles Peskine50e586b2018-06-08 14:28:46 +02003209
Ronald Cron5425a212020-08-04 14:58:35 +02003210 PSA_ASSERT( psa_cipher_decrypt_setup( &operation, key, alg ) );
Gilles Peskine50e586b2018-06-08 14:28:46 +02003211
Steven Cooreman177deba2020-09-07 17:14:14 +02003212 if( iv->len > 0 )
3213 {
Steven Cooremana6033e92020-08-25 11:47:50 +02003214 PSA_ASSERT( psa_cipher_set_iv( &operation, iv->x, iv->len ) );
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02003215 }
Gilles Peskine50e586b2018-06-08 14:28:46 +02003216
gabor-mezei-armf494bcd2021-03-01 15:11:46 +01003217 output_buffer_size = PSA_CIPHER_UPDATE_OUTPUT_SIZE( key_type, alg, input->len ) +
3218 PSA_CIPHER_FINISH_OUTPUT_SIZE( key_type, alg );
Gilles Peskine8cebbba2018-09-27 13:54:18 +02003219 ASSERT_ALLOC( output, output_buffer_size );
Gilles Peskine50e586b2018-06-08 14:28:46 +02003220
Gilles Peskinee0866522019-02-19 19:44:00 +01003221 TEST_ASSERT( first_part_size <= input->len );
Gilles Peskine8817f612018-12-18 00:18:46 +01003222 PSA_ASSERT( psa_cipher_update( &operation,
3223 input->x, first_part_size,
3224 output, output_buffer_size,
3225 &function_output_length ) );
Gilles Peskinee0866522019-02-19 19:44:00 +01003226 TEST_ASSERT( function_output_length == output1_length );
gabor-mezei-armceface22021-01-21 12:26:17 +01003227 TEST_ASSERT( function_output_length <=
3228 PSA_CIPHER_UPDATE_OUTPUT_SIZE( key_type, alg, first_part_size ) );
3229 TEST_ASSERT( function_output_length <=
3230 PSA_CIPHER_UPDATE_OUTPUT_MAX_SIZE( first_part_size ) );
Gilles Peskinea7ec95f2018-06-08 14:40:59 +02003231 total_output_length += function_output_length;
gabor-mezei-armceface22021-01-21 12:26:17 +01003232
gabor-mezei-arm95aad832021-06-25 18:21:33 +02003233 if( first_part_size < input->len )
Steven Cooreman177deba2020-09-07 17:14:14 +02003234 {
gabor-mezei-arm95aad832021-06-25 18:21:33 +02003235 PSA_ASSERT( psa_cipher_update( &operation,
3236 input->x + first_part_size,
3237 input->len - first_part_size,
3238 ( output_buffer_size == 0 ? NULL :
3239 output + total_output_length ),
3240 output_buffer_size - total_output_length,
3241 &function_output_length ) );
3242 TEST_ASSERT( function_output_length == output2_length );
3243 TEST_ASSERT( function_output_length <=
3244 PSA_CIPHER_UPDATE_OUTPUT_SIZE( key_type,
3245 alg,
3246 input->len - first_part_size ) );
3247 TEST_ASSERT( function_output_length <=
3248 PSA_CIPHER_UPDATE_OUTPUT_MAX_SIZE( input->len ) );
3249 total_output_length += function_output_length;
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02003250 }
Gilles Peskine50e586b2018-06-08 14:28:46 +02003251
Gilles Peskine50e586b2018-06-08 14:28:46 +02003252 status = psa_cipher_finish( &operation,
Gilles Peskine0c510f32021-03-24 00:41:51 +01003253 ( output_buffer_size == 0 ? NULL :
3254 output + total_output_length ),
Gilles Peskineee46fe72019-02-19 19:05:33 +01003255 output_buffer_size - total_output_length,
Gilles Peskine50e586b2018-06-08 14:28:46 +02003256 &function_output_length );
gabor-mezei-armceface22021-01-21 12:26:17 +01003257 TEST_ASSERT( function_output_length <=
3258 PSA_CIPHER_FINISH_OUTPUT_SIZE( key_type, alg ) );
3259 TEST_ASSERT( function_output_length <=
3260 PSA_CIPHER_FINISH_OUTPUT_MAX_SIZE );
Gilles Peskinea7ec95f2018-06-08 14:40:59 +02003261 total_output_length += function_output_length;
Gilles Peskinefe11b722018-12-18 00:24:04 +01003262 TEST_EQUAL( status, expected_status );
Gilles Peskine50e586b2018-06-08 14:28:46 +02003263
3264 if( expected_status == PSA_SUCCESS )
3265 {
Gilles Peskine8817f612018-12-18 00:18:46 +01003266 PSA_ASSERT( psa_cipher_abort( &operation ) );
gabor-mezei-arm95aad832021-06-25 18:21:33 +02003267
Gilles Peskinebd7dea92018-09-27 13:57:19 +02003268 ASSERT_COMPARE( expected_output->x, expected_output->len,
3269 output, total_output_length );
Gilles Peskine50e586b2018-06-08 14:28:46 +02003270 }
3271
Gilles Peskine50e586b2018-06-08 14:28:46 +02003272exit:
Gilles Peskine64f13ef2020-08-25 23:15:20 +02003273 psa_cipher_abort( &operation );
itayzafrir3e02b3b2018-06-12 17:06:52 +03003274 mbedtls_free( output );
Ronald Cron5425a212020-08-04 14:58:35 +02003275 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02003276 PSA_DONE( );
Gilles Peskine50e586b2018-06-08 14:28:46 +02003277}
3278/* END_CASE */
3279
Gilles Peskine50e586b2018-06-08 14:28:46 +02003280/* BEGIN_CASE */
gabor-mezei-arma56756e2021-06-25 15:49:14 +02003281void cipher_decrypt_fail( int alg_arg,
3282 int key_type_arg,
3283 data_t *key_data,
3284 data_t *iv,
3285 data_t *input_arg,
3286 int expected_status_arg )
gabor-mezei-armf494bcd2021-03-01 15:11:46 +01003287{
3288 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
3289 psa_status_t status;
3290 psa_key_type_t key_type = key_type_arg;
3291 psa_algorithm_t alg = alg_arg;
3292 psa_status_t expected_status = expected_status_arg;
3293 unsigned char *input = NULL;
3294 size_t input_buffer_size = 0;
3295 unsigned char *output = NULL;
3296 size_t output_buffer_size = 0;
3297 size_t output_length = 0;
3298 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
3299
3300 if ( PSA_ERROR_BAD_STATE != expected_status )
3301 {
3302 PSA_ASSERT( psa_crypto_init( ) );
3303
3304 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DECRYPT );
3305 psa_set_key_algorithm( &attributes, alg );
3306 psa_set_key_type( &attributes, key_type );
3307
3308 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
3309 &key ) );
3310 }
3311
3312 /* Allocate input buffer and copy the iv and the plaintext */
3313 input_buffer_size = ( (size_t) input_arg->len + (size_t) iv->len );
3314 if ( input_buffer_size > 0 )
3315 {
3316 ASSERT_ALLOC( input, input_buffer_size );
3317 memcpy( input, iv->x, iv->len );
3318 memcpy( input + iv->len, input_arg->x, input_arg->len );
3319 }
3320
3321 output_buffer_size = PSA_CIPHER_DECRYPT_OUTPUT_SIZE( key_type, alg, input_buffer_size );
3322 ASSERT_ALLOC( output, output_buffer_size );
3323
3324 status = psa_cipher_decrypt( key, alg, input, input_buffer_size, output,
3325 output_buffer_size, &output_length );
3326 TEST_EQUAL( status, expected_status );
3327
3328exit:
3329 mbedtls_free( input );
3330 mbedtls_free( output );
3331 psa_destroy_key( key );
3332 PSA_DONE( );
3333}
3334/* END_CASE */
3335
3336/* BEGIN_CASE */
3337void cipher_decrypt( int alg_arg,
3338 int key_type_arg,
3339 data_t *key_data,
3340 data_t *iv,
3341 data_t *input_arg,
3342 data_t *expected_output )
3343{
3344 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
3345 psa_key_type_t key_type = key_type_arg;
3346 psa_algorithm_t alg = alg_arg;
3347 unsigned char *input = NULL;
3348 size_t input_buffer_size = 0;
3349 unsigned char *output = NULL;
3350 size_t output_buffer_size = 0;
3351 size_t output_length = 0;
3352 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
3353
3354 PSA_ASSERT( psa_crypto_init( ) );
3355
3356 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DECRYPT );
3357 psa_set_key_algorithm( &attributes, alg );
3358 psa_set_key_type( &attributes, key_type );
3359
3360 /* Allocate input buffer and copy the iv and the plaintext */
3361 input_buffer_size = ( (size_t) input_arg->len + (size_t) iv->len );
3362 if ( input_buffer_size > 0 )
3363 {
3364 ASSERT_ALLOC( input, input_buffer_size );
3365 memcpy( input, iv->x, iv->len );
3366 memcpy( input + iv->len, input_arg->x, input_arg->len );
3367 }
3368
3369 output_buffer_size = PSA_CIPHER_DECRYPT_OUTPUT_SIZE( key_type, alg, input_buffer_size );
3370 ASSERT_ALLOC( output, output_buffer_size );
3371
3372 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
3373 &key ) );
3374
3375 PSA_ASSERT( psa_cipher_decrypt( key, alg, input, input_buffer_size, output,
3376 output_buffer_size, &output_length ) );
3377 TEST_ASSERT( output_length <=
3378 PSA_CIPHER_DECRYPT_OUTPUT_SIZE( key_type, alg, input_buffer_size ) );
3379 TEST_ASSERT( output_length <=
3380 PSA_CIPHER_DECRYPT_OUTPUT_MAX_SIZE( input_buffer_size ) );
3381
3382 ASSERT_COMPARE( expected_output->x, expected_output->len,
3383 output, output_length );
3384exit:
3385 mbedtls_free( input );
3386 mbedtls_free( output );
3387 psa_destroy_key( key );
3388 PSA_DONE( );
3389}
3390/* END_CASE */
3391
3392/* BEGIN_CASE */
3393void cipher_verify_output( int alg_arg,
3394 int key_type_arg,
Ronald Cron5425a212020-08-04 14:58:35 +02003395 data_t *key_data,
itayzafrir3e02b3b2018-06-12 17:06:52 +03003396 data_t *input )
mohammad1603d7d7ba52018-03-12 18:51:53 +02003397{
Ronald Cron5425a212020-08-04 14:58:35 +02003398 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
mohammad1603d7d7ba52018-03-12 18:51:53 +02003399 psa_key_type_t key_type = key_type_arg;
3400 psa_algorithm_t alg = alg_arg;
itayzafrir3e02b3b2018-06-12 17:06:52 +03003401 unsigned char *output1 = NULL;
mohammad1603d7d7ba52018-03-12 18:51:53 +02003402 size_t output1_size = 0;
3403 size_t output1_length = 0;
itayzafrir3e02b3b2018-06-12 17:06:52 +03003404 unsigned char *output2 = NULL;
mohammad1603d7d7ba52018-03-12 18:51:53 +02003405 size_t output2_size = 0;
3406 size_t output2_length = 0;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02003407 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
mohammad1603d7d7ba52018-03-12 18:51:53 +02003408
Gilles Peskine8817f612018-12-18 00:18:46 +01003409 PSA_ASSERT( psa_crypto_init( ) );
mohammad1603d7d7ba52018-03-12 18:51:53 +02003410
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02003411 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT | PSA_KEY_USAGE_DECRYPT );
3412 psa_set_key_algorithm( &attributes, alg );
3413 psa_set_key_type( &attributes, key_type );
Moran Pekered346952018-07-05 15:22:45 +03003414
Ronald Cron5425a212020-08-04 14:58:35 +02003415 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
3416 &key ) );
gabor-mezei-armceface22021-01-21 12:26:17 +01003417 output1_size = PSA_CIPHER_ENCRYPT_OUTPUT_SIZE( key_type, alg, input->len );
Gilles Peskine8cebbba2018-09-27 13:54:18 +02003418 ASSERT_ALLOC( output1, output1_size );
Moran Pekerded84402018-06-06 16:36:50 +03003419
gabor-mezei-armf494bcd2021-03-01 15:11:46 +01003420 PSA_ASSERT( psa_cipher_encrypt( key, alg, input->x, input->len,
3421 output1, output1_size,
3422 &output1_length ) );
gabor-mezei-armceface22021-01-21 12:26:17 +01003423 TEST_ASSERT( output1_length <=
gabor-mezei-armf494bcd2021-03-01 15:11:46 +01003424 PSA_CIPHER_ENCRYPT_OUTPUT_SIZE( key_type, alg, input->len ) );
gabor-mezei-armceface22021-01-21 12:26:17 +01003425 TEST_ASSERT( output1_length <=
gabor-mezei-armf494bcd2021-03-01 15:11:46 +01003426 PSA_CIPHER_ENCRYPT_OUTPUT_MAX_SIZE( input->len ) );
Moran Pekerded84402018-06-06 16:36:50 +03003427
3428 output2_size = output1_length;
Gilles Peskine8cebbba2018-09-27 13:54:18 +02003429 ASSERT_ALLOC( output2, output2_size );
Moran Pekerded84402018-06-06 16:36:50 +03003430
gabor-mezei-armf494bcd2021-03-01 15:11:46 +01003431 PSA_ASSERT( psa_cipher_decrypt( key, alg, output1, output1_length,
3432 output2, output2_size,
3433 &output2_length ) );
gabor-mezei-armceface22021-01-21 12:26:17 +01003434 TEST_ASSERT( output2_length <=
gabor-mezei-armf494bcd2021-03-01 15:11:46 +01003435 PSA_CIPHER_DECRYPT_OUTPUT_SIZE( key_type, alg, output1_length ) );
gabor-mezei-armceface22021-01-21 12:26:17 +01003436 TEST_ASSERT( output2_length <=
gabor-mezei-armf494bcd2021-03-01 15:11:46 +01003437 PSA_CIPHER_DECRYPT_OUTPUT_MAX_SIZE( output1_length ) );
Moran Pekerded84402018-06-06 16:36:50 +03003438
Gilles Peskinebd7dea92018-09-27 13:57:19 +02003439 ASSERT_COMPARE( input->x, input->len, output2, output2_length );
Moran Pekerded84402018-06-06 16:36:50 +03003440
3441exit:
itayzafrir3e02b3b2018-06-12 17:06:52 +03003442 mbedtls_free( output1 );
3443 mbedtls_free( output2 );
Ronald Cron5425a212020-08-04 14:58:35 +02003444 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02003445 PSA_DONE( );
Moran Pekerded84402018-06-06 16:36:50 +03003446}
3447/* END_CASE */
3448
3449/* BEGIN_CASE */
Gilles Peskine50e586b2018-06-08 14:28:46 +02003450void cipher_verify_output_multipart( int alg_arg,
3451 int key_type_arg,
Ronald Cron5425a212020-08-04 14:58:35 +02003452 data_t *key_data,
itayzafrir3e02b3b2018-06-12 17:06:52 +03003453 data_t *input,
Gilles Peskinee0866522019-02-19 19:44:00 +01003454 int first_part_size_arg )
Moran Pekerded84402018-06-06 16:36:50 +03003455{
Ronald Cron5425a212020-08-04 14:58:35 +02003456 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Moran Pekerded84402018-06-06 16:36:50 +03003457 psa_key_type_t key_type = key_type_arg;
3458 psa_algorithm_t alg = alg_arg;
Gilles Peskinee0866522019-02-19 19:44:00 +01003459 size_t first_part_size = first_part_size_arg;
Moran Pekerded84402018-06-06 16:36:50 +03003460 unsigned char iv[16] = {0};
3461 size_t iv_size = 16;
3462 size_t iv_length = 0;
itayzafrir3e02b3b2018-06-12 17:06:52 +03003463 unsigned char *output1 = NULL;
Gilles Peskine048b7f02018-06-08 14:20:49 +02003464 size_t output1_buffer_size = 0;
Moran Pekerded84402018-06-06 16:36:50 +03003465 size_t output1_length = 0;
itayzafrir3e02b3b2018-06-12 17:06:52 +03003466 unsigned char *output2 = NULL;
Gilles Peskine048b7f02018-06-08 14:20:49 +02003467 size_t output2_buffer_size = 0;
Moran Pekerded84402018-06-06 16:36:50 +03003468 size_t output2_length = 0;
Gilles Peskine048b7f02018-06-08 14:20:49 +02003469 size_t function_output_length;
Jaeden Amero5bae2272019-01-04 11:48:27 +00003470 psa_cipher_operation_t operation1 = PSA_CIPHER_OPERATION_INIT;
3471 psa_cipher_operation_t operation2 = PSA_CIPHER_OPERATION_INIT;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02003472 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Moran Pekerded84402018-06-06 16:36:50 +03003473
Gilles Peskine8817f612018-12-18 00:18:46 +01003474 PSA_ASSERT( psa_crypto_init( ) );
Moran Pekerded84402018-06-06 16:36:50 +03003475
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02003476 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT | PSA_KEY_USAGE_DECRYPT );
3477 psa_set_key_algorithm( &attributes, alg );
3478 psa_set_key_type( &attributes, key_type );
Moran Pekered346952018-07-05 15:22:45 +03003479
Ronald Cron5425a212020-08-04 14:58:35 +02003480 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
3481 &key ) );
Moran Pekerded84402018-06-06 16:36:50 +03003482
Ronald Cron5425a212020-08-04 14:58:35 +02003483 PSA_ASSERT( psa_cipher_encrypt_setup( &operation1, key, alg ) );
3484 PSA_ASSERT( psa_cipher_decrypt_setup( &operation2, key, alg ) );
Moran Pekerded84402018-06-06 16:36:50 +03003485
Steven Cooreman177deba2020-09-07 17:14:14 +02003486 if( alg != PSA_ALG_ECB_NO_PADDING )
3487 {
Steven Cooremana6033e92020-08-25 11:47:50 +02003488 PSA_ASSERT( psa_cipher_generate_iv( &operation1,
3489 iv, iv_size,
3490 &iv_length ) );
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02003491 }
3492
gabor-mezei-armceface22021-01-21 12:26:17 +01003493 output1_buffer_size = PSA_CIPHER_ENCRYPT_OUTPUT_SIZE( key_type, alg, input->len );
3494 TEST_ASSERT( output1_buffer_size <=
3495 PSA_CIPHER_ENCRYPT_OUTPUT_MAX_SIZE( input->len ) );
Gilles Peskine8cebbba2018-09-27 13:54:18 +02003496 ASSERT_ALLOC( output1, output1_buffer_size );
Moran Pekerded84402018-06-06 16:36:50 +03003497
Gilles Peskinee0866522019-02-19 19:44:00 +01003498 TEST_ASSERT( first_part_size <= input->len );
Gilles Peskine4ca9c3f2018-06-06 18:44:09 +02003499
Gilles Peskine8817f612018-12-18 00:18:46 +01003500 PSA_ASSERT( psa_cipher_update( &operation1, input->x, first_part_size,
3501 output1, output1_buffer_size,
3502 &function_output_length ) );
gabor-mezei-armceface22021-01-21 12:26:17 +01003503 TEST_ASSERT( function_output_length <=
3504 PSA_CIPHER_UPDATE_OUTPUT_SIZE( key_type, alg, first_part_size ) );
3505 TEST_ASSERT( function_output_length <=
3506 PSA_CIPHER_UPDATE_OUTPUT_MAX_SIZE( first_part_size ) );
Gilles Peskine048b7f02018-06-08 14:20:49 +02003507 output1_length += function_output_length;
Moran Pekerded84402018-06-06 16:36:50 +03003508
Gilles Peskine8817f612018-12-18 00:18:46 +01003509 PSA_ASSERT( psa_cipher_update( &operation1,
3510 input->x + first_part_size,
3511 input->len - first_part_size,
3512 output1, output1_buffer_size,
3513 &function_output_length ) );
gabor-mezei-armceface22021-01-21 12:26:17 +01003514 TEST_ASSERT( function_output_length <=
3515 PSA_CIPHER_UPDATE_OUTPUT_SIZE( key_type,
3516 alg,
3517 input->len - first_part_size ) );
3518 TEST_ASSERT( function_output_length <=
3519 PSA_CIPHER_UPDATE_OUTPUT_MAX_SIZE( input->len - first_part_size ) );
Gilles Peskine048b7f02018-06-08 14:20:49 +02003520 output1_length += function_output_length;
Moran Pekerded84402018-06-06 16:36:50 +03003521
Gilles Peskine8817f612018-12-18 00:18:46 +01003522 PSA_ASSERT( psa_cipher_finish( &operation1,
3523 output1 + output1_length,
3524 output1_buffer_size - output1_length,
3525 &function_output_length ) );
gabor-mezei-armceface22021-01-21 12:26:17 +01003526 TEST_ASSERT( function_output_length <=
3527 PSA_CIPHER_FINISH_OUTPUT_SIZE( key_type, alg ) );
3528 TEST_ASSERT( function_output_length <=
3529 PSA_CIPHER_FINISH_OUTPUT_MAX_SIZE );
Gilles Peskine048b7f02018-06-08 14:20:49 +02003530 output1_length += function_output_length;
mohammad1603d7d7ba52018-03-12 18:51:53 +02003531
Gilles Peskine8817f612018-12-18 00:18:46 +01003532 PSA_ASSERT( psa_cipher_abort( &operation1 ) );
mohammad1603d7d7ba52018-03-12 18:51:53 +02003533
Gilles Peskine048b7f02018-06-08 14:20:49 +02003534 output2_buffer_size = output1_length;
gabor-mezei-armceface22021-01-21 12:26:17 +01003535 TEST_ASSERT( output2_buffer_size <=
3536 PSA_CIPHER_DECRYPT_OUTPUT_SIZE( key_type, alg, output1_length ) );
3537 TEST_ASSERT( output2_buffer_size <=
3538 PSA_CIPHER_DECRYPT_OUTPUT_MAX_SIZE( output1_length ) );
Gilles Peskine8cebbba2018-09-27 13:54:18 +02003539 ASSERT_ALLOC( output2, output2_buffer_size );
mohammad1603d7d7ba52018-03-12 18:51:53 +02003540
Steven Cooreman177deba2020-09-07 17:14:14 +02003541 if( iv_length > 0 )
3542 {
Steven Cooremana6033e92020-08-25 11:47:50 +02003543 PSA_ASSERT( psa_cipher_set_iv( &operation2,
3544 iv, iv_length ) );
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02003545 }
Moran Pekerded84402018-06-06 16:36:50 +03003546
Gilles Peskine8817f612018-12-18 00:18:46 +01003547 PSA_ASSERT( psa_cipher_update( &operation2, output1, first_part_size,
3548 output2, output2_buffer_size,
3549 &function_output_length ) );
gabor-mezei-armceface22021-01-21 12:26:17 +01003550 TEST_ASSERT( function_output_length <=
3551 PSA_CIPHER_UPDATE_OUTPUT_SIZE( key_type, alg, first_part_size ) );
3552 TEST_ASSERT( function_output_length <=
3553 PSA_CIPHER_UPDATE_OUTPUT_MAX_SIZE( first_part_size ) );
Gilles Peskine048b7f02018-06-08 14:20:49 +02003554 output2_length += function_output_length;
Moran Pekerded84402018-06-06 16:36:50 +03003555
Gilles Peskine8817f612018-12-18 00:18:46 +01003556 PSA_ASSERT( psa_cipher_update( &operation2,
3557 output1 + first_part_size,
3558 output1_length - first_part_size,
3559 output2, output2_buffer_size,
3560 &function_output_length ) );
gabor-mezei-armceface22021-01-21 12:26:17 +01003561 TEST_ASSERT( function_output_length <=
3562 PSA_CIPHER_UPDATE_OUTPUT_SIZE( key_type,
3563 alg,
3564 output1_length - first_part_size ) );
3565 TEST_ASSERT( function_output_length <=
3566 PSA_CIPHER_UPDATE_OUTPUT_MAX_SIZE( output1_length - first_part_size ) );
Gilles Peskine048b7f02018-06-08 14:20:49 +02003567 output2_length += function_output_length;
Moran Pekerded84402018-06-06 16:36:50 +03003568
Gilles Peskine8817f612018-12-18 00:18:46 +01003569 PSA_ASSERT( psa_cipher_finish( &operation2,
3570 output2 + output2_length,
3571 output2_buffer_size - output2_length,
3572 &function_output_length ) );
gabor-mezei-armceface22021-01-21 12:26:17 +01003573 TEST_ASSERT( function_output_length <=
3574 PSA_CIPHER_FINISH_OUTPUT_SIZE( key_type, alg ) );
3575 TEST_ASSERT( function_output_length <=
3576 PSA_CIPHER_FINISH_OUTPUT_MAX_SIZE );
Gilles Peskine048b7f02018-06-08 14:20:49 +02003577 output2_length += function_output_length;
Gilles Peskine4ca9c3f2018-06-06 18:44:09 +02003578
Gilles Peskine8817f612018-12-18 00:18:46 +01003579 PSA_ASSERT( psa_cipher_abort( &operation2 ) );
mohammad1603d7d7ba52018-03-12 18:51:53 +02003580
Gilles Peskinebd7dea92018-09-27 13:57:19 +02003581 ASSERT_COMPARE( input->x, input->len, output2, output2_length );
mohammad1603d7d7ba52018-03-12 18:51:53 +02003582
3583exit:
Gilles Peskine64f13ef2020-08-25 23:15:20 +02003584 psa_cipher_abort( &operation1 );
3585 psa_cipher_abort( &operation2 );
itayzafrir3e02b3b2018-06-12 17:06:52 +03003586 mbedtls_free( output1 );
3587 mbedtls_free( output2 );
Ronald Cron5425a212020-08-04 14:58:35 +02003588 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02003589 PSA_DONE( );
mohammad1603d7d7ba52018-03-12 18:51:53 +02003590}
3591/* END_CASE */
Gilles Peskine7268afc2018-06-06 15:19:24 +02003592
Gilles Peskine20035e32018-02-03 22:44:14 +01003593/* BEGIN_CASE */
Gilles Peskine7da96b02018-08-17 18:45:42 +02003594void aead_encrypt_decrypt( int key_type_arg, data_t *key_data,
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02003595 int alg_arg,
Gilles Peskine7da96b02018-08-17 18:45:42 +02003596 data_t *nonce,
3597 data_t *additional_data,
3598 data_t *input_data,
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02003599 int expected_result_arg )
Gilles Peskinea1cac842018-06-11 19:33:02 +02003600{
Ronald Cron5425a212020-08-04 14:58:35 +02003601 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskinea1cac842018-06-11 19:33:02 +02003602 psa_key_type_t key_type = key_type_arg;
3603 psa_algorithm_t alg = alg_arg;
Bence Szépkútiec174e22021-03-19 18:46:15 +01003604 size_t key_bits;
Gilles Peskinea1cac842018-06-11 19:33:02 +02003605 unsigned char *output_data = NULL;
3606 size_t output_size = 0;
3607 size_t output_length = 0;
3608 unsigned char *output_data2 = NULL;
3609 size_t output_length2 = 0;
Steven Cooremanf49478b2021-02-15 15:19:25 +01003610 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Gilles Peskine4abf7412018-06-18 16:35:34 +02003611 psa_status_t expected_result = expected_result_arg;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02003612 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskinea1cac842018-06-11 19:33:02 +02003613
Gilles Peskine8817f612018-12-18 00:18:46 +01003614 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003615
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02003616 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT | PSA_KEY_USAGE_DECRYPT );
3617 psa_set_key_algorithm( &attributes, alg );
3618 psa_set_key_type( &attributes, key_type );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003619
Gilles Peskine049c7532019-05-15 20:22:09 +02003620 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02003621 &key ) );
Bence Szépkútiec174e22021-03-19 18:46:15 +01003622 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
3623 key_bits = psa_get_key_bits( &attributes );
3624
3625 output_size = input_data->len + PSA_AEAD_TAG_LENGTH( key_type, key_bits,
3626 alg );
3627 /* For all currently defined algorithms, PSA_AEAD_ENCRYPT_OUTPUT_SIZE
3628 * should be exact. */
3629 if( expected_result != PSA_ERROR_INVALID_ARGUMENT &&
3630 expected_result != PSA_ERROR_NOT_SUPPORTED )
3631 {
3632 TEST_EQUAL( output_size,
3633 PSA_AEAD_ENCRYPT_OUTPUT_SIZE( key_type, alg, input_data->len ) );
3634 TEST_ASSERT( output_size <=
3635 PSA_AEAD_ENCRYPT_OUTPUT_MAX_SIZE( input_data->len ) );
3636 }
3637 ASSERT_ALLOC( output_data, output_size );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003638
Steven Cooremanf49478b2021-02-15 15:19:25 +01003639 status = psa_aead_encrypt( key, alg,
3640 nonce->x, nonce->len,
3641 additional_data->x,
3642 additional_data->len,
3643 input_data->x, input_data->len,
3644 output_data, output_size,
3645 &output_length );
3646
3647 /* If the operation is not supported, just skip and not fail in case the
3648 * encryption involves a common limitation of cryptography hardwares and
3649 * an alternative implementation. */
3650 if( status == PSA_ERROR_NOT_SUPPORTED )
3651 {
3652 MBEDTLS_TEST_PSA_SKIP_IF_ALT_AES_192( key_type, key_data->len * 8 );
3653 MBEDTLS_TEST_PSA_SKIP_IF_ALT_GCM_NOT_12BYTES_NONCE( alg, nonce->len );
3654 }
3655
3656 TEST_EQUAL( status, expected_result );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003657
3658 if( PSA_SUCCESS == expected_result )
3659 {
Gilles Peskine8cebbba2018-09-27 13:54:18 +02003660 ASSERT_ALLOC( output_data2, output_length );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003661
Gilles Peskine003a4a92019-05-14 16:09:40 +02003662 /* For all currently defined algorithms, PSA_AEAD_DECRYPT_OUTPUT_SIZE
3663 * should be exact. */
3664 TEST_EQUAL( input_data->len,
Bence Szépkútiec174e22021-03-19 18:46:15 +01003665 PSA_AEAD_DECRYPT_OUTPUT_SIZE( key_type, alg, output_length ) );
Gilles Peskine003a4a92019-05-14 16:09:40 +02003666
gabor-mezei-armceface22021-01-21 12:26:17 +01003667 TEST_ASSERT( input_data->len <=
3668 PSA_AEAD_DECRYPT_OUTPUT_MAX_SIZE( output_length ) );
3669
Ronald Cron5425a212020-08-04 14:58:35 +02003670 TEST_EQUAL( psa_aead_decrypt( key, alg,
Gilles Peskinefe11b722018-12-18 00:24:04 +01003671 nonce->x, nonce->len,
3672 additional_data->x,
3673 additional_data->len,
3674 output_data, output_length,
3675 output_data2, output_length,
Gilles Peskinef812dcf2018-12-18 00:33:25 +01003676 &output_length2 ),
3677 expected_result );
Gilles Peskine2d277862018-06-18 15:41:12 +02003678
Gilles Peskinebd7dea92018-09-27 13:57:19 +02003679 ASSERT_COMPARE( input_data->x, input_data->len,
3680 output_data2, output_length2 );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003681 }
Gilles Peskine2d277862018-06-18 15:41:12 +02003682
Gilles Peskinea1cac842018-06-11 19:33:02 +02003683exit:
Ronald Cron5425a212020-08-04 14:58:35 +02003684 psa_destroy_key( key );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003685 mbedtls_free( output_data );
3686 mbedtls_free( output_data2 );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02003687 PSA_DONE( );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003688}
3689/* END_CASE */
3690
3691/* BEGIN_CASE */
Gilles Peskine7da96b02018-08-17 18:45:42 +02003692void aead_encrypt( int key_type_arg, data_t *key_data,
3693 int alg_arg,
3694 data_t *nonce,
3695 data_t *additional_data,
3696 data_t *input_data,
3697 data_t *expected_result )
Gilles Peskinea1cac842018-06-11 19:33:02 +02003698{
Ronald Cron5425a212020-08-04 14:58:35 +02003699 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskinea1cac842018-06-11 19:33:02 +02003700 psa_key_type_t key_type = key_type_arg;
3701 psa_algorithm_t alg = alg_arg;
Bence Szépkútiec174e22021-03-19 18:46:15 +01003702 size_t key_bits;
Gilles Peskinea1cac842018-06-11 19:33:02 +02003703 unsigned char *output_data = NULL;
3704 size_t output_size = 0;
3705 size_t output_length = 0;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02003706 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Steven Cooremand588ea12021-01-11 19:36:04 +01003707 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Gilles Peskinea1cac842018-06-11 19:33:02 +02003708
Gilles Peskine8817f612018-12-18 00:18:46 +01003709 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003710
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02003711 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
3712 psa_set_key_algorithm( &attributes, alg );
3713 psa_set_key_type( &attributes, key_type );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003714
Gilles Peskine049c7532019-05-15 20:22:09 +02003715 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02003716 &key ) );
Bence Szépkútiec174e22021-03-19 18:46:15 +01003717 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
3718 key_bits = psa_get_key_bits( &attributes );
3719
3720 output_size = input_data->len + PSA_AEAD_TAG_LENGTH( key_type, key_bits,
3721 alg );
3722 /* For all currently defined algorithms, PSA_AEAD_ENCRYPT_OUTPUT_SIZE
3723 * should be exact. */
3724 TEST_EQUAL( output_size,
3725 PSA_AEAD_ENCRYPT_OUTPUT_SIZE( key_type, alg, input_data->len ) );
3726 TEST_ASSERT( output_size <=
3727 PSA_AEAD_ENCRYPT_OUTPUT_MAX_SIZE( input_data->len ) );
3728 ASSERT_ALLOC( output_data, output_size );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003729
Steven Cooremand588ea12021-01-11 19:36:04 +01003730 status = psa_aead_encrypt( key, alg,
3731 nonce->x, nonce->len,
3732 additional_data->x, additional_data->len,
3733 input_data->x, input_data->len,
3734 output_data, output_size,
3735 &output_length );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003736
Ronald Cron28a45ed2021-02-09 20:35:42 +01003737 /* If the operation is not supported, just skip and not fail in case the
3738 * encryption involves a common limitation of cryptography hardwares and
3739 * an alternative implementation. */
3740 if( status == PSA_ERROR_NOT_SUPPORTED )
Steven Cooremand588ea12021-01-11 19:36:04 +01003741 {
Ronald Cron28a45ed2021-02-09 20:35:42 +01003742 MBEDTLS_TEST_PSA_SKIP_IF_ALT_AES_192( key_type, key_data->len * 8 );
3743 MBEDTLS_TEST_PSA_SKIP_IF_ALT_GCM_NOT_12BYTES_NONCE( alg, nonce->len );
Steven Cooremand588ea12021-01-11 19:36:04 +01003744 }
Steven Cooremand588ea12021-01-11 19:36:04 +01003745
3746 PSA_ASSERT( status );
Gilles Peskinebd7dea92018-09-27 13:57:19 +02003747 ASSERT_COMPARE( expected_result->x, expected_result->len,
3748 output_data, output_length );
Gilles Peskine2d277862018-06-18 15:41:12 +02003749
Gilles Peskinea1cac842018-06-11 19:33:02 +02003750exit:
Ronald Cron5425a212020-08-04 14:58:35 +02003751 psa_destroy_key( key );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003752 mbedtls_free( output_data );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02003753 PSA_DONE( );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003754}
3755/* END_CASE */
3756
3757/* BEGIN_CASE */
Gilles Peskine7da96b02018-08-17 18:45:42 +02003758void aead_decrypt( int key_type_arg, data_t *key_data,
3759 int alg_arg,
3760 data_t *nonce,
3761 data_t *additional_data,
3762 data_t *input_data,
3763 data_t *expected_data,
3764 int expected_result_arg )
Gilles Peskinea1cac842018-06-11 19:33:02 +02003765{
Ronald Cron5425a212020-08-04 14:58:35 +02003766 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskinea1cac842018-06-11 19:33:02 +02003767 psa_key_type_t key_type = key_type_arg;
3768 psa_algorithm_t alg = alg_arg;
Bence Szépkútiec174e22021-03-19 18:46:15 +01003769 size_t key_bits;
Gilles Peskinea1cac842018-06-11 19:33:02 +02003770 unsigned char *output_data = NULL;
3771 size_t output_size = 0;
3772 size_t output_length = 0;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02003773 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine4abf7412018-06-18 16:35:34 +02003774 psa_status_t expected_result = expected_result_arg;
Steven Cooremand588ea12021-01-11 19:36:04 +01003775 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Gilles Peskinea1cac842018-06-11 19:33:02 +02003776
Gilles Peskine8817f612018-12-18 00:18:46 +01003777 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003778
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02003779 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DECRYPT );
3780 psa_set_key_algorithm( &attributes, alg );
3781 psa_set_key_type( &attributes, key_type );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003782
Gilles Peskine049c7532019-05-15 20:22:09 +02003783 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02003784 &key ) );
Bence Szépkútiec174e22021-03-19 18:46:15 +01003785 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
3786 key_bits = psa_get_key_bits( &attributes );
3787
3788 output_size = input_data->len - PSA_AEAD_TAG_LENGTH( key_type, key_bits,
3789 alg );
3790 if( expected_result != PSA_ERROR_INVALID_ARGUMENT &&
3791 expected_result != PSA_ERROR_NOT_SUPPORTED )
3792 {
3793 /* For all currently defined algorithms, PSA_AEAD_DECRYPT_OUTPUT_SIZE
3794 * should be exact. */
3795 TEST_EQUAL( output_size,
3796 PSA_AEAD_DECRYPT_OUTPUT_SIZE( key_type, alg, input_data->len ) );
3797 TEST_ASSERT( output_size <=
3798 PSA_AEAD_DECRYPT_OUTPUT_MAX_SIZE( input_data->len ) );
3799 }
3800 ASSERT_ALLOC( output_data, output_size );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003801
Steven Cooremand588ea12021-01-11 19:36:04 +01003802 status = psa_aead_decrypt( key, alg,
3803 nonce->x, nonce->len,
3804 additional_data->x,
3805 additional_data->len,
3806 input_data->x, input_data->len,
3807 output_data, output_size,
3808 &output_length );
3809
Ronald Cron28a45ed2021-02-09 20:35:42 +01003810 /* If the operation is not supported, just skip and not fail in case the
3811 * decryption involves a common limitation of cryptography hardwares and
3812 * an alternative implementation. */
3813 if( status == PSA_ERROR_NOT_SUPPORTED )
Steven Cooremand588ea12021-01-11 19:36:04 +01003814 {
Ronald Cron28a45ed2021-02-09 20:35:42 +01003815 MBEDTLS_TEST_PSA_SKIP_IF_ALT_AES_192( key_type, key_data->len * 8 );
3816 MBEDTLS_TEST_PSA_SKIP_IF_ALT_GCM_NOT_12BYTES_NONCE( alg, nonce->len );
Steven Cooremand588ea12021-01-11 19:36:04 +01003817 }
Steven Cooremand588ea12021-01-11 19:36:04 +01003818
3819 TEST_EQUAL( status, expected_result );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003820
Gilles Peskine2d277862018-06-18 15:41:12 +02003821 if( expected_result == PSA_SUCCESS )
Gilles Peskinebd7dea92018-09-27 13:57:19 +02003822 ASSERT_COMPARE( expected_data->x, expected_data->len,
3823 output_data, output_length );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003824
Gilles Peskinea1cac842018-06-11 19:33:02 +02003825exit:
Ronald Cron5425a212020-08-04 14:58:35 +02003826 psa_destroy_key( key );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003827 mbedtls_free( output_data );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02003828 PSA_DONE( );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003829}
3830/* END_CASE */
3831
3832/* BEGIN_CASE */
Paul Elliott0023e0a2021-04-27 10:06:22 +01003833void aead_multipart_encrypt( int key_type_arg, data_t *key_data,
3834 int alg_arg,
3835 data_t *nonce,
3836 data_t *additional_data,
Paul Elliott0023e0a2021-04-27 10:06:22 +01003837 data_t *input_data,
Paul Elliott97fd1ba2021-07-21 18:46:06 +01003838 int do_set_lengths,
3839 data_t *expected_output )
Paul Elliott0023e0a2021-04-27 10:06:22 +01003840{
Paul Elliottd3f82412021-06-16 16:52:21 +01003841 size_t ad_part_len = 0;
3842 size_t data_part_len = 0;
Paul Elliottbb979e72021-09-22 12:54:42 +01003843 set_lengths_method_t set_lengths_method = DO_NOT_SET_LENGTHS;
Paul Elliott0023e0a2021-04-27 10:06:22 +01003844
Paul Elliott32f46ba2021-09-23 18:24:36 +01003845 for( ad_part_len = 1; ad_part_len <= additional_data->len; ad_part_len++ )
Paul Elliott0023e0a2021-04-27 10:06:22 +01003846 {
Paul Elliott32f46ba2021-09-23 18:24:36 +01003847 mbedtls_test_set_step( ad_part_len );
3848
3849 if( do_set_lengths )
Paul Elliott0023e0a2021-04-27 10:06:22 +01003850 {
Paul Elliott32f46ba2021-09-23 18:24:36 +01003851 if( ad_part_len & 0x01 )
3852 set_lengths_method = SET_LENGTHS_AFTER_NONCE;
3853 else
3854 set_lengths_method = SET_LENGTHS_BEFORE_NONCE;
Paul Elliott0023e0a2021-04-27 10:06:22 +01003855 }
Paul Elliott32f46ba2021-09-23 18:24:36 +01003856
3857 /* Split ad into length(ad_part_len) parts. */
3858 if( !aead_multipart_internal_func( key_type_arg, key_data,
3859 alg_arg, nonce,
3860 additional_data,
3861 ad_part_len,
3862 input_data, -1,
3863 set_lengths_method,
3864 expected_output,
3865 1, 0 ) )
3866 break;
3867
3868 /* length(0) part, length(ad_part_len) part, length(0) part... */
3869 mbedtls_test_set_step( 1000 + ad_part_len );
3870
3871 if( !aead_multipart_internal_func( key_type_arg, key_data,
3872 alg_arg, nonce,
3873 additional_data,
3874 ad_part_len,
3875 input_data, -1,
3876 set_lengths_method,
3877 expected_output,
3878 1, 1 ) )
3879 break;
Paul Elliott0023e0a2021-04-27 10:06:22 +01003880 }
Paul Elliottd3f82412021-06-16 16:52:21 +01003881
Paul Elliott32f46ba2021-09-23 18:24:36 +01003882 for( data_part_len = 1; data_part_len <= input_data->len; data_part_len++ )
Paul Elliott0023e0a2021-04-27 10:06:22 +01003883 {
Paul Elliott32f46ba2021-09-23 18:24:36 +01003884 /* Split data into length(data_part_len) parts. */
3885 mbedtls_test_set_step( 2000 + data_part_len );
3886
3887 if( do_set_lengths )
Paul Elliott0023e0a2021-04-27 10:06:22 +01003888 {
Paul Elliott32f46ba2021-09-23 18:24:36 +01003889 if( data_part_len & 0x01 )
3890 set_lengths_method = SET_LENGTHS_AFTER_NONCE;
3891 else
3892 set_lengths_method = SET_LENGTHS_BEFORE_NONCE;
Paul Elliott0023e0a2021-04-27 10:06:22 +01003893 }
Paul Elliott0023e0a2021-04-27 10:06:22 +01003894
Paul Elliott32f46ba2021-09-23 18:24:36 +01003895 if( !aead_multipart_internal_func( key_type_arg, key_data,
3896 alg_arg, nonce,
3897 additional_data, -1,
3898 input_data, data_part_len,
3899 set_lengths_method,
3900 expected_output,
3901 1, 0 ) )
3902 break;
3903
3904 /* length(0) part, length(data_part_len) part, length(0) part... */
3905 mbedtls_test_set_step( 3000 + data_part_len );
3906
3907 if( !aead_multipart_internal_func( key_type_arg, key_data,
3908 alg_arg, nonce,
3909 additional_data, -1,
3910 input_data, data_part_len,
3911 set_lengths_method,
3912 expected_output,
3913 1, 1 ) )
3914 break;
3915 }
Paul Elliott0023e0a2021-04-27 10:06:22 +01003916
Paul Elliott8fc45162021-06-23 16:06:01 +01003917 /* Goto is required to silence warnings about unused labels, as we
3918 * don't actually do any test assertions in this function. */
3919 goto exit;
Paul Elliott0023e0a2021-04-27 10:06:22 +01003920}
3921/* END_CASE */
3922
3923/* BEGIN_CASE */
Paul Elliott0023e0a2021-04-27 10:06:22 +01003924void aead_multipart_decrypt( int key_type_arg, data_t *key_data,
3925 int alg_arg,
3926 data_t *nonce,
3927 data_t *additional_data,
Paul Elliott0023e0a2021-04-27 10:06:22 +01003928 data_t *input_data,
Paul Elliott97fd1ba2021-07-21 18:46:06 +01003929 int do_set_lengths,
Paul Elliott9961a662021-09-17 19:19:02 +01003930 data_t *expected_output )
Paul Elliott0023e0a2021-04-27 10:06:22 +01003931{
Paul Elliottd3f82412021-06-16 16:52:21 +01003932 size_t ad_part_len = 0;
3933 size_t data_part_len = 0;
Paul Elliottbb979e72021-09-22 12:54:42 +01003934 set_lengths_method_t set_lengths_method = DO_NOT_SET_LENGTHS;
Paul Elliott0023e0a2021-04-27 10:06:22 +01003935
Paul Elliott32f46ba2021-09-23 18:24:36 +01003936 for( ad_part_len = 1; ad_part_len <= additional_data->len; ad_part_len++ )
Paul Elliott0023e0a2021-04-27 10:06:22 +01003937 {
Paul Elliott32f46ba2021-09-23 18:24:36 +01003938 /* Split ad into length(ad_part_len) parts. */
3939 mbedtls_test_set_step( ad_part_len );
3940
3941 if( do_set_lengths )
Paul Elliott0023e0a2021-04-27 10:06:22 +01003942 {
Paul Elliott32f46ba2021-09-23 18:24:36 +01003943 if( ad_part_len & 0x01 )
3944 set_lengths_method = SET_LENGTHS_AFTER_NONCE;
3945 else
3946 set_lengths_method = SET_LENGTHS_BEFORE_NONCE;
Paul Elliott0023e0a2021-04-27 10:06:22 +01003947 }
Paul Elliott32f46ba2021-09-23 18:24:36 +01003948
3949 if( !aead_multipart_internal_func( key_type_arg, key_data,
3950 alg_arg, nonce,
3951 additional_data,
3952 ad_part_len,
3953 input_data, -1,
3954 set_lengths_method,
3955 expected_output,
3956 0, 0 ) )
3957 break;
3958
3959 /* length(0) part, length(ad_part_len) part, length(0) part... */
3960 mbedtls_test_set_step( 1000 + ad_part_len );
3961
3962 if( !aead_multipart_internal_func( key_type_arg, key_data,
3963 alg_arg, nonce,
3964 additional_data,
3965 ad_part_len,
3966 input_data, -1,
3967 set_lengths_method,
3968 expected_output,
3969 0, 1 ) )
3970 break;
Paul Elliott0023e0a2021-04-27 10:06:22 +01003971 }
3972
Paul Elliott32f46ba2021-09-23 18:24:36 +01003973 for( data_part_len = 1; data_part_len <= input_data->len; data_part_len++ )
Paul Elliott0023e0a2021-04-27 10:06:22 +01003974 {
Paul Elliott32f46ba2021-09-23 18:24:36 +01003975 /* Split data into length(data_part_len) parts. */
3976 mbedtls_test_set_step( 2000 + data_part_len );
3977
3978 if( do_set_lengths )
Paul Elliott0023e0a2021-04-27 10:06:22 +01003979 {
Paul Elliott32f46ba2021-09-23 18:24:36 +01003980 if( data_part_len & 0x01 )
3981 set_lengths_method = SET_LENGTHS_AFTER_NONCE;
3982 else
3983 set_lengths_method = SET_LENGTHS_BEFORE_NONCE;
Paul Elliott0023e0a2021-04-27 10:06:22 +01003984 }
Paul Elliott32f46ba2021-09-23 18:24:36 +01003985
3986 if( !aead_multipart_internal_func( key_type_arg, key_data,
3987 alg_arg, nonce,
3988 additional_data, -1,
3989 input_data, data_part_len,
3990 set_lengths_method,
3991 expected_output,
3992 0, 0 ) )
3993 break;
3994
3995 /* length(0) part, length(data_part_len) part, length(0) part... */
3996 mbedtls_test_set_step( 3000 + data_part_len );
3997
3998 if( !aead_multipart_internal_func( key_type_arg, key_data,
3999 alg_arg, nonce,
4000 additional_data, -1,
4001 input_data, data_part_len,
4002 set_lengths_method,
4003 expected_output,
4004 0, 1 ) )
4005 break;
Paul Elliott0023e0a2021-04-27 10:06:22 +01004006 }
4007
Paul Elliott8fc45162021-06-23 16:06:01 +01004008 /* Goto is required to silence warnings about unused labels, as we
4009 * don't actually do any test assertions in this function. */
Paul Elliottd3f82412021-06-16 16:52:21 +01004010 goto exit;
Paul Elliott0023e0a2021-04-27 10:06:22 +01004011}
4012/* END_CASE */
4013
4014/* BEGIN_CASE */
Paul Elliott8eb9daf2021-06-04 16:42:21 +01004015void aead_multipart_generate_nonce( int key_type_arg, data_t *key_data,
4016 int alg_arg,
Paul Elliottf1277632021-08-24 18:11:37 +01004017 int nonce_length,
4018 int expected_nonce_length_arg,
Paul Elliott3bd5dba2021-06-23 17:14:40 +01004019 data_t *additional_data,
4020 data_t *input_data,
4021 int expected_status_arg )
Paul Elliott8eb9daf2021-06-04 16:42:21 +01004022{
4023
4024 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
4025 psa_key_type_t key_type = key_type_arg;
4026 psa_algorithm_t alg = alg_arg;
Paul Elliottfbb4c6d2021-09-22 16:44:21 +01004027 psa_aead_operation_t operation = PSA_AEAD_OPERATION_INIT;
Paul Elliott8eb9daf2021-06-04 16:42:21 +01004028 uint8_t nonce_buffer[PSA_AEAD_NONCE_MAX_SIZE];
4029 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
4030 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Paul Elliott693bf312021-07-23 17:40:41 +01004031 psa_status_t expected_status = expected_status_arg;
Paul Elliottf1277632021-08-24 18:11:37 +01004032 size_t actual_nonce_length = 0;
4033 size_t expected_nonce_length = expected_nonce_length_arg;
4034 unsigned char *output = NULL;
4035 unsigned char *ciphertext = NULL;
Paul Elliott3bd5dba2021-06-23 17:14:40 +01004036 size_t output_size = 0;
Paul Elliottf1277632021-08-24 18:11:37 +01004037 size_t ciphertext_size = 0;
4038 size_t ciphertext_length = 0;
Paul Elliott3bd5dba2021-06-23 17:14:40 +01004039 size_t tag_length = 0;
4040 uint8_t tag_buffer[PSA_AEAD_TAG_MAX_SIZE];
Paul Elliott8eb9daf2021-06-04 16:42:21 +01004041
4042 PSA_ASSERT( psa_crypto_init( ) );
4043
4044 psa_set_key_usage_flags( & attributes, PSA_KEY_USAGE_ENCRYPT );
4045 psa_set_key_algorithm( & attributes, alg );
4046 psa_set_key_type( & attributes, key_type );
4047
4048 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
4049 &key ) );
4050
4051 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
4052
Paul Elliott3bd5dba2021-06-23 17:14:40 +01004053 output_size = PSA_AEAD_UPDATE_OUTPUT_SIZE( key_type, alg, input_data->len );
4054
Paul Elliottf1277632021-08-24 18:11:37 +01004055 ASSERT_ALLOC( output, output_size );
Paul Elliott3bd5dba2021-06-23 17:14:40 +01004056
Paul Elliottf1277632021-08-24 18:11:37 +01004057 ciphertext_size = PSA_AEAD_FINISH_OUTPUT_SIZE( key_type, alg );
Paul Elliott3bd5dba2021-06-23 17:14:40 +01004058
Paul Elliottf1277632021-08-24 18:11:37 +01004059 TEST_ASSERT( ciphertext_size <= PSA_AEAD_FINISH_OUTPUT_MAX_SIZE );
Paul Elliott3bd5dba2021-06-23 17:14:40 +01004060
Paul Elliottf1277632021-08-24 18:11:37 +01004061 ASSERT_ALLOC( ciphertext, ciphertext_size );
Paul Elliott3bd5dba2021-06-23 17:14:40 +01004062
Paul Elliott8eb9daf2021-06-04 16:42:21 +01004063 status = psa_aead_encrypt_setup( &operation, key, alg );
4064
4065 /* If the operation is not supported, just skip and not fail in case the
4066 * encryption involves a common limitation of cryptography hardwares and
4067 * an alternative implementation. */
4068 if( status == PSA_ERROR_NOT_SUPPORTED )
4069 {
4070 MBEDTLS_TEST_PSA_SKIP_IF_ALT_AES_192( key_type, key_data->len * 8 );
Paul Elliottf1277632021-08-24 18:11:37 +01004071 MBEDTLS_TEST_PSA_SKIP_IF_ALT_GCM_NOT_12BYTES_NONCE( alg, nonce_length );
Paul Elliott8eb9daf2021-06-04 16:42:21 +01004072 }
4073
4074 PSA_ASSERT( status );
4075
Paul Elliott8eb9daf2021-06-04 16:42:21 +01004076 status = psa_aead_generate_nonce( &operation, nonce_buffer,
Paul Elliottf1277632021-08-24 18:11:37 +01004077 nonce_length,
4078 &actual_nonce_length );
Paul Elliott8eb9daf2021-06-04 16:42:21 +01004079
Paul Elliott693bf312021-07-23 17:40:41 +01004080 TEST_EQUAL( status, expected_status );
Paul Elliott3bd5dba2021-06-23 17:14:40 +01004081
Paul Elliottf1277632021-08-24 18:11:37 +01004082 TEST_EQUAL( actual_nonce_length, expected_nonce_length );
Paul Elliottd85f5472021-07-16 18:20:16 +01004083
Paul Elliott88ecbe12021-09-22 17:23:03 +01004084 if( expected_status == PSA_SUCCESS )
4085 TEST_EQUAL( actual_nonce_length, PSA_AEAD_NONCE_LENGTH( key_type,
4086 alg ) );
4087
Paul Elliottd79c5c52021-10-06 21:49:41 +01004088 TEST_ASSERT( actual_nonce_length <= PSA_AEAD_NONCE_MAX_SIZE );
Paul Elliotte0fcb3b2021-07-16 18:52:03 +01004089
Paul Elliott693bf312021-07-23 17:40:41 +01004090 if( expected_status == PSA_SUCCESS )
Paul Elliott3bd5dba2021-06-23 17:14:40 +01004091 {
Paul Elliott3bd5dba2021-06-23 17:14:40 +01004092 /* Ensure we can still complete operation. */
Paul Elliottd79c5c52021-10-06 21:49:41 +01004093 PSA_ASSERT( psa_aead_set_lengths( &operation, additional_data->len,
4094 input_data->len ) );
Paul Elliott3bd5dba2021-06-23 17:14:40 +01004095
4096 PSA_ASSERT( psa_aead_update_ad( &operation, additional_data->x,
4097 additional_data->len ) );
4098
4099 PSA_ASSERT( psa_aead_update( &operation, input_data->x, input_data->len,
Paul Elliottf1277632021-08-24 18:11:37 +01004100 output, output_size,
4101 &ciphertext_length ) );
Paul Elliott3bd5dba2021-06-23 17:14:40 +01004102
Paul Elliottf1277632021-08-24 18:11:37 +01004103 PSA_ASSERT( psa_aead_finish( &operation, ciphertext, ciphertext_size,
4104 &ciphertext_length, tag_buffer,
Paul Elliott3bd5dba2021-06-23 17:14:40 +01004105 PSA_AEAD_TAG_MAX_SIZE, &tag_length ) );
4106 }
Paul Elliott8eb9daf2021-06-04 16:42:21 +01004107
4108exit:
4109 psa_destroy_key( key );
Paul Elliottf1277632021-08-24 18:11:37 +01004110 mbedtls_free( output );
4111 mbedtls_free( ciphertext );
Paul Elliott8eb9daf2021-06-04 16:42:21 +01004112 psa_aead_abort( &operation );
4113 PSA_DONE( );
4114}
4115/* END_CASE */
4116
4117/* BEGIN_CASE */
Paul Elliott863864a2021-07-23 17:28:31 +01004118void aead_multipart_set_nonce( int key_type_arg, data_t *key_data,
4119 int alg_arg,
Paul Elliott4023ffd2021-09-10 16:21:22 +01004120 int nonce_length_arg,
Paul Elliott863864a2021-07-23 17:28:31 +01004121 data_t *additional_data,
4122 data_t *input_data,
4123 int expected_status_arg )
4124{
4125
4126 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
4127 psa_key_type_t key_type = key_type_arg;
4128 psa_algorithm_t alg = alg_arg;
Paul Elliottfbb4c6d2021-09-22 16:44:21 +01004129 psa_aead_operation_t operation = PSA_AEAD_OPERATION_INIT;
Paul Elliott863864a2021-07-23 17:28:31 +01004130 uint8_t *nonce_buffer = NULL;
4131 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
4132 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
4133 psa_status_t expected_status = expected_status_arg;
Paul Elliott6f0e7202021-08-25 12:57:18 +01004134 unsigned char *output = NULL;
4135 unsigned char *ciphertext = NULL;
Paul Elliott4023ffd2021-09-10 16:21:22 +01004136 size_t nonce_length;
Paul Elliott863864a2021-07-23 17:28:31 +01004137 size_t output_size = 0;
Paul Elliott6f0e7202021-08-25 12:57:18 +01004138 size_t ciphertext_size = 0;
4139 size_t ciphertext_length = 0;
Paul Elliott863864a2021-07-23 17:28:31 +01004140 size_t tag_length = 0;
4141 uint8_t tag_buffer[PSA_AEAD_TAG_MAX_SIZE];
Paul Elliott4023ffd2021-09-10 16:21:22 +01004142 size_t index = 0;
Paul Elliott863864a2021-07-23 17:28:31 +01004143
4144 PSA_ASSERT( psa_crypto_init( ) );
4145
4146 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
4147 psa_set_key_algorithm( &attributes, alg );
4148 psa_set_key_type( &attributes, key_type );
4149
4150 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
4151 &key ) );
4152
4153 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
4154
4155 output_size = PSA_AEAD_UPDATE_OUTPUT_SIZE( key_type, alg, input_data->len );
4156
Paul Elliott6f0e7202021-08-25 12:57:18 +01004157 ASSERT_ALLOC( output, output_size );
Paul Elliott863864a2021-07-23 17:28:31 +01004158
Paul Elliott6f0e7202021-08-25 12:57:18 +01004159 ciphertext_size = PSA_AEAD_FINISH_OUTPUT_SIZE( key_type, alg );
Paul Elliott863864a2021-07-23 17:28:31 +01004160
Paul Elliott6f0e7202021-08-25 12:57:18 +01004161 TEST_ASSERT( ciphertext_size <= PSA_AEAD_FINISH_OUTPUT_MAX_SIZE );
Paul Elliott863864a2021-07-23 17:28:31 +01004162
Paul Elliott6f0e7202021-08-25 12:57:18 +01004163 ASSERT_ALLOC( ciphertext, ciphertext_size );
Paul Elliott863864a2021-07-23 17:28:31 +01004164
Paul Elliott863864a2021-07-23 17:28:31 +01004165 status = psa_aead_encrypt_setup( &operation, key, alg );
4166
4167 /* If the operation is not supported, just skip and not fail in case the
4168 * encryption involves a common limitation of cryptography hardwares and
4169 * an alternative implementation. */
4170 if( status == PSA_ERROR_NOT_SUPPORTED )
4171 {
4172 MBEDTLS_TEST_PSA_SKIP_IF_ALT_AES_192( key_type, key_data->len * 8 );
Paul Elliott4023ffd2021-09-10 16:21:22 +01004173 MBEDTLS_TEST_PSA_SKIP_IF_ALT_GCM_NOT_12BYTES_NONCE( alg, nonce_length_arg );
Paul Elliott863864a2021-07-23 17:28:31 +01004174 }
4175
4176 PSA_ASSERT( status );
4177
Paul Elliott4023ffd2021-09-10 16:21:22 +01004178 /* -1 == zero length and valid buffer, 0 = zero length and NULL buffer. */
4179 if( nonce_length_arg == -1 )
Paul Elliott863864a2021-07-23 17:28:31 +01004180 {
Paul Elliott5e69aa52021-08-25 17:24:37 +01004181 /* Arbitrary size buffer, to test zero length valid buffer. */
4182 ASSERT_ALLOC( nonce_buffer, 4 );
Paul Elliott4023ffd2021-09-10 16:21:22 +01004183 nonce_length = 0;
Paul Elliott66696b52021-08-16 18:42:41 +01004184 }
4185 else
4186 {
Paul Elliott4023ffd2021-09-10 16:21:22 +01004187 /* If length is zero, then this will return NULL. */
4188 nonce_length = ( size_t ) nonce_length_arg;
Paul Elliott6f0e7202021-08-25 12:57:18 +01004189 ASSERT_ALLOC( nonce_buffer, nonce_length );
Paul Elliott66696b52021-08-16 18:42:41 +01004190
Paul Elliott4023ffd2021-09-10 16:21:22 +01004191 if( nonce_buffer )
Paul Elliott66696b52021-08-16 18:42:41 +01004192 {
Paul Elliott4023ffd2021-09-10 16:21:22 +01004193 for( index = 0; index < nonce_length - 1; ++index )
4194 {
4195 nonce_buffer[index] = 'a' + index;
4196 }
Paul Elliott66696b52021-08-16 18:42:41 +01004197 }
Paul Elliott863864a2021-07-23 17:28:31 +01004198 }
4199
Paul Elliott6f0e7202021-08-25 12:57:18 +01004200 status = psa_aead_set_nonce( &operation, nonce_buffer, nonce_length );
Paul Elliott863864a2021-07-23 17:28:31 +01004201
Paul Elliott693bf312021-07-23 17:40:41 +01004202 TEST_EQUAL( status, expected_status );
Paul Elliott863864a2021-07-23 17:28:31 +01004203
4204 if( expected_status == PSA_SUCCESS )
4205 {
4206 /* Ensure we can still complete operation. */
Paul Elliotte4c08ed2021-10-06 18:53:04 +01004207 PSA_ASSERT( psa_aead_set_lengths( &operation, additional_data->len,
4208 input_data->len ) );
Paul Elliott863864a2021-07-23 17:28:31 +01004209
4210 PSA_ASSERT( psa_aead_update_ad( &operation, additional_data->x,
4211 additional_data->len ) );
4212
4213 PSA_ASSERT( psa_aead_update( &operation, input_data->x, input_data->len,
Paul Elliott6f0e7202021-08-25 12:57:18 +01004214 output, output_size,
4215 &ciphertext_length ) );
Paul Elliott863864a2021-07-23 17:28:31 +01004216
Paul Elliott6f0e7202021-08-25 12:57:18 +01004217 PSA_ASSERT( psa_aead_finish( &operation, ciphertext, ciphertext_size,
4218 &ciphertext_length, tag_buffer,
Paul Elliott863864a2021-07-23 17:28:31 +01004219 PSA_AEAD_TAG_MAX_SIZE, &tag_length ) );
4220 }
4221
4222exit:
4223 psa_destroy_key( key );
Paul Elliott6f0e7202021-08-25 12:57:18 +01004224 mbedtls_free( output );
4225 mbedtls_free( ciphertext );
Paul Elliott863864a2021-07-23 17:28:31 +01004226 mbedtls_free( nonce_buffer );
4227 psa_aead_abort( &operation );
4228 PSA_DONE( );
4229}
4230/* END_CASE */
4231
4232/* BEGIN_CASE */
Paul Elliott43fbda62021-07-23 18:30:59 +01004233void aead_multipart_update_buffer_test( int key_type_arg, data_t *key_data,
4234 int alg_arg,
Paul Elliottc6d11d02021-09-01 12:04:23 +01004235 int output_size_arg,
Paul Elliott43fbda62021-07-23 18:30:59 +01004236 data_t *nonce,
4237 data_t *additional_data,
4238 data_t *input_data,
4239 int expected_status_arg )
4240{
4241
4242 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
4243 psa_key_type_t key_type = key_type_arg;
4244 psa_algorithm_t alg = alg_arg;
Paul Elliottfbb4c6d2021-09-22 16:44:21 +01004245 psa_aead_operation_t operation = PSA_AEAD_OPERATION_INIT;
Paul Elliott43fbda62021-07-23 18:30:59 +01004246 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
4247 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
4248 psa_status_t expected_status = expected_status_arg;
Paul Elliottc6d11d02021-09-01 12:04:23 +01004249 unsigned char *output = NULL;
4250 unsigned char *ciphertext = NULL;
4251 size_t output_size = output_size_arg;
4252 size_t ciphertext_size = 0;
4253 size_t ciphertext_length = 0;
Paul Elliott43fbda62021-07-23 18:30:59 +01004254 size_t tag_length = 0;
4255 uint8_t tag_buffer[PSA_AEAD_TAG_MAX_SIZE];
4256
4257 PSA_ASSERT( psa_crypto_init( ) );
4258
4259 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
4260 psa_set_key_algorithm( &attributes, alg );
4261 psa_set_key_type( &attributes, key_type );
4262
4263 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
4264 &key ) );
4265
4266 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
4267
Paul Elliottc6d11d02021-09-01 12:04:23 +01004268 ASSERT_ALLOC( output, output_size );
Paul Elliott43fbda62021-07-23 18:30:59 +01004269
Paul Elliottc6d11d02021-09-01 12:04:23 +01004270 ciphertext_size = PSA_AEAD_FINISH_OUTPUT_SIZE( key_type, alg );
Paul Elliott43fbda62021-07-23 18:30:59 +01004271
Paul Elliottc6d11d02021-09-01 12:04:23 +01004272 ASSERT_ALLOC( ciphertext, ciphertext_size );
Paul Elliott43fbda62021-07-23 18:30:59 +01004273
Paul Elliott43fbda62021-07-23 18:30:59 +01004274 status = psa_aead_encrypt_setup( &operation, key, alg );
4275
4276 /* If the operation is not supported, just skip and not fail in case the
4277 * encryption involves a common limitation of cryptography hardwares and
4278 * an alternative implementation. */
4279 if( status == PSA_ERROR_NOT_SUPPORTED )
4280 {
4281 MBEDTLS_TEST_PSA_SKIP_IF_ALT_AES_192( key_type, key_data->len * 8 );
4282 MBEDTLS_TEST_PSA_SKIP_IF_ALT_GCM_NOT_12BYTES_NONCE( alg, nonce->len );
4283 }
4284
4285 PSA_ASSERT( status );
4286
Paul Elliott47b9a142021-10-07 15:04:57 +01004287 PSA_ASSERT( psa_aead_set_lengths( &operation, additional_data->len,
4288 input_data->len ) );
4289
Paul Elliott43fbda62021-07-23 18:30:59 +01004290 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
4291
4292 PSA_ASSERT( psa_aead_update_ad( &operation, additional_data->x,
4293 additional_data->len ) );
4294
4295 status = psa_aead_update( &operation, input_data->x, input_data->len,
Paul Elliottc6d11d02021-09-01 12:04:23 +01004296 output, output_size, &ciphertext_length );
Paul Elliott43fbda62021-07-23 18:30:59 +01004297
4298 TEST_EQUAL( status, expected_status );
4299
4300 if( expected_status == PSA_SUCCESS )
4301 {
4302 /* Ensure we can still complete operation. */
Paul Elliottc6d11d02021-09-01 12:04:23 +01004303 PSA_ASSERT( psa_aead_finish( &operation, ciphertext, ciphertext_size,
4304 &ciphertext_length, tag_buffer,
Paul Elliott43fbda62021-07-23 18:30:59 +01004305 PSA_AEAD_TAG_MAX_SIZE, &tag_length ) );
4306 }
4307
4308exit:
4309 psa_destroy_key( key );
Paul Elliottc6d11d02021-09-01 12:04:23 +01004310 mbedtls_free( output );
4311 mbedtls_free( ciphertext );
Paul Elliott43fbda62021-07-23 18:30:59 +01004312 psa_aead_abort( &operation );
4313 PSA_DONE( );
4314}
4315/* END_CASE */
4316
Paul Elliott91b021e2021-07-23 18:52:31 +01004317/* BEGIN_CASE */
4318void aead_multipart_finish_buffer_test( int key_type_arg, data_t *key_data,
4319 int alg_arg,
Paul Elliotte58cb1e2021-09-10 18:36:00 +01004320 int finish_ciphertext_size_arg,
Paul Elliott719c1322021-09-13 18:27:22 +01004321 int tag_size_arg,
Paul Elliott91b021e2021-07-23 18:52:31 +01004322 data_t *nonce,
4323 data_t *additional_data,
4324 data_t *input_data,
4325 int expected_status_arg )
4326{
4327
4328 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
4329 psa_key_type_t key_type = key_type_arg;
4330 psa_algorithm_t alg = alg_arg;
Paul Elliottfbb4c6d2021-09-22 16:44:21 +01004331 psa_aead_operation_t operation = PSA_AEAD_OPERATION_INIT;
Paul Elliott91b021e2021-07-23 18:52:31 +01004332 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
4333 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
4334 psa_status_t expected_status = expected_status_arg;
Paul Elliotte58cb1e2021-09-10 18:36:00 +01004335 unsigned char *ciphertext = NULL;
4336 unsigned char *finish_ciphertext = NULL;
Paul Elliott719c1322021-09-13 18:27:22 +01004337 unsigned char *tag_buffer = NULL;
Paul Elliotte58cb1e2021-09-10 18:36:00 +01004338 size_t ciphertext_size = 0;
4339 size_t ciphertext_length = 0;
4340 size_t finish_ciphertext_size = ( size_t ) finish_ciphertext_size_arg;
Paul Elliott719c1322021-09-13 18:27:22 +01004341 size_t tag_size = ( size_t ) tag_size_arg;
Paul Elliott91b021e2021-07-23 18:52:31 +01004342 size_t tag_length = 0;
Paul Elliott91b021e2021-07-23 18:52:31 +01004343
4344 PSA_ASSERT( psa_crypto_init( ) );
4345
4346 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
4347 psa_set_key_algorithm( &attributes, alg );
4348 psa_set_key_type( &attributes, key_type );
4349
4350 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
4351 &key ) );
4352
4353 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
4354
Paul Elliotte58cb1e2021-09-10 18:36:00 +01004355 ciphertext_size = PSA_AEAD_UPDATE_OUTPUT_SIZE( key_type, alg, input_data->len );
Paul Elliott91b021e2021-07-23 18:52:31 +01004356
Paul Elliotte58cb1e2021-09-10 18:36:00 +01004357 ASSERT_ALLOC( ciphertext, ciphertext_size );
Paul Elliott91b021e2021-07-23 18:52:31 +01004358
Paul Elliotte58cb1e2021-09-10 18:36:00 +01004359 ASSERT_ALLOC( finish_ciphertext, finish_ciphertext_size );
Paul Elliott91b021e2021-07-23 18:52:31 +01004360
Paul Elliott719c1322021-09-13 18:27:22 +01004361 ASSERT_ALLOC( tag_buffer, tag_size );
4362
Paul Elliott91b021e2021-07-23 18:52:31 +01004363 status = psa_aead_encrypt_setup( &operation, key, alg );
4364
4365 /* If the operation is not supported, just skip and not fail in case the
4366 * encryption involves a common limitation of cryptography hardwares and
4367 * an alternative implementation. */
4368 if( status == PSA_ERROR_NOT_SUPPORTED )
4369 {
4370 MBEDTLS_TEST_PSA_SKIP_IF_ALT_AES_192( key_type, key_data->len * 8 );
4371 MBEDTLS_TEST_PSA_SKIP_IF_ALT_GCM_NOT_12BYTES_NONCE( alg, nonce->len );
4372 }
4373
4374 PSA_ASSERT( status );
4375
4376 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
4377
Paul Elliott76bda482021-10-07 17:07:23 +01004378 PSA_ASSERT( psa_aead_set_lengths( &operation, additional_data->len,
4379 input_data->len ) );
4380
Paul Elliott91b021e2021-07-23 18:52:31 +01004381 PSA_ASSERT( psa_aead_update_ad( &operation, additional_data->x,
4382 additional_data->len ) );
4383
4384 PSA_ASSERT( psa_aead_update( &operation, input_data->x, input_data->len,
Paul Elliotte58cb1e2021-09-10 18:36:00 +01004385 ciphertext, ciphertext_size, &ciphertext_length ) );
Paul Elliott91b021e2021-07-23 18:52:31 +01004386
4387 /* Ensure we can still complete operation. */
Paul Elliotte58cb1e2021-09-10 18:36:00 +01004388 status = psa_aead_finish( &operation, finish_ciphertext,
4389 finish_ciphertext_size,
4390 &ciphertext_length, tag_buffer,
Paul Elliott719c1322021-09-13 18:27:22 +01004391 tag_size, &tag_length );
Paul Elliott91b021e2021-07-23 18:52:31 +01004392
4393 TEST_EQUAL( status, expected_status );
4394
4395exit:
4396 psa_destroy_key( key );
Paul Elliotte58cb1e2021-09-10 18:36:00 +01004397 mbedtls_free( ciphertext );
4398 mbedtls_free( finish_ciphertext );
Paul Elliott4a760882021-09-20 09:42:21 +01004399 mbedtls_free( tag_buffer );
Paul Elliott91b021e2021-07-23 18:52:31 +01004400 psa_aead_abort( &operation );
4401 PSA_DONE( );
4402}
4403/* END_CASE */
Paul Elliott43fbda62021-07-23 18:30:59 +01004404
4405/* BEGIN_CASE */
Paul Elliott9961a662021-09-17 19:19:02 +01004406void aead_multipart_verify( int key_type_arg, data_t *key_data,
4407 int alg_arg,
4408 data_t *nonce,
4409 data_t *additional_data,
4410 data_t *input_data,
4411 data_t *tag,
Paul Elliott1c67e0b2021-09-19 13:11:50 +01004412 int tag_usage_arg,
Paul Elliott9961a662021-09-17 19:19:02 +01004413 int expected_status_arg )
4414{
4415 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
4416 psa_key_type_t key_type = key_type_arg;
4417 psa_algorithm_t alg = alg_arg;
Paul Elliottfbb4c6d2021-09-22 16:44:21 +01004418 psa_aead_operation_t operation = PSA_AEAD_OPERATION_INIT;
Paul Elliott9961a662021-09-17 19:19:02 +01004419 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
4420 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
4421 psa_status_t expected_status = expected_status_arg;
4422 unsigned char *plaintext = NULL;
4423 unsigned char *finish_plaintext = NULL;
4424 size_t plaintext_size = 0;
4425 size_t plaintext_length = 0;
4426 size_t verify_plaintext_size = 0;
Paul Elliottbb979e72021-09-22 12:54:42 +01004427 tag_usage_method_t tag_usage = tag_usage_arg;
Paul Elliott1c67e0b2021-09-19 13:11:50 +01004428 unsigned char *tag_buffer = NULL;
4429 size_t tag_size = 0;
Paul Elliott9961a662021-09-17 19:19:02 +01004430
4431 PSA_ASSERT( psa_crypto_init( ) );
4432
4433 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DECRYPT );
4434 psa_set_key_algorithm( &attributes, alg );
4435 psa_set_key_type( &attributes, key_type );
4436
4437 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
4438 &key ) );
4439
4440 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
4441
4442 plaintext_size = PSA_AEAD_UPDATE_OUTPUT_SIZE( key_type, alg,
4443 input_data->len );
4444
4445 ASSERT_ALLOC( plaintext, plaintext_size );
4446
4447 verify_plaintext_size = PSA_AEAD_VERIFY_OUTPUT_SIZE( key_type, alg );
4448
4449 ASSERT_ALLOC( finish_plaintext, verify_plaintext_size );
4450
Paul Elliott9961a662021-09-17 19:19:02 +01004451 status = psa_aead_decrypt_setup( &operation, key, alg );
4452
4453 /* If the operation is not supported, just skip and not fail in case the
4454 * encryption involves a common limitation of cryptography hardwares and
4455 * an alternative implementation. */
4456 if( status == PSA_ERROR_NOT_SUPPORTED )
4457 {
4458 MBEDTLS_TEST_PSA_SKIP_IF_ALT_AES_192( key_type, key_data->len * 8 );
4459 MBEDTLS_TEST_PSA_SKIP_IF_ALT_GCM_NOT_12BYTES_NONCE( alg, nonce->len );
4460 }
4461
4462 PSA_ASSERT( status );
4463
4464 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
4465
Paul Elliottfec6f372021-10-06 17:15:02 +01004466 status = psa_aead_set_lengths( &operation, additional_data->len,
4467 input_data->len );
4468
4469 if( status != PSA_SUCCESS )
4470 {
4471 /* Invalid tag lengths are detected in CCM at this point, as they
Paul Elliott37ec16b2021-12-08 20:14:49 +00004472 * would be written into the first block. They should really be
4473 * detected in psa_aead_encrypt/decrypt_setup, and will be fixed
4474 * to do so in the future, until that point, this is a
4475 * workaround.*/
Paul Elliottfec6f372021-10-06 17:15:02 +01004476 TEST_EQUAL( status, expected_status );
4477 goto exit;
4478 }
4479
Paul Elliott9961a662021-09-17 19:19:02 +01004480 PSA_ASSERT( psa_aead_update_ad( &operation, additional_data->x,
4481 additional_data->len ) );
4482
4483 PSA_ASSERT( psa_aead_update( &operation, input_data->x,
4484 input_data->len,
4485 plaintext, plaintext_size,
4486 &plaintext_length ) );
4487
Paul Elliott1c67e0b2021-09-19 13:11:50 +01004488 if( tag_usage == USE_GIVEN_TAG )
4489 {
4490 tag_buffer = tag->x;
4491 tag_size = tag->len;
4492 }
4493
Paul Elliott9961a662021-09-17 19:19:02 +01004494 status = psa_aead_verify( &operation, finish_plaintext,
4495 verify_plaintext_size,
4496 &plaintext_length,
Paul Elliott1c67e0b2021-09-19 13:11:50 +01004497 tag_buffer, tag_size );
Paul Elliott9961a662021-09-17 19:19:02 +01004498
4499 TEST_EQUAL( status, expected_status );
4500
4501exit:
4502 psa_destroy_key( key );
4503 mbedtls_free( plaintext );
4504 mbedtls_free( finish_plaintext );
4505 psa_aead_abort( &operation );
4506 PSA_DONE( );
4507}
4508/* END_CASE */
4509
Paul Elliott9961a662021-09-17 19:19:02 +01004510/* BEGIN_CASE */
Paul Elliott5221ef62021-09-19 17:33:03 +01004511void aead_multipart_setup( int key_type_arg, data_t *key_data,
4512 int alg_arg, int expected_status_arg )
4513{
4514 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
4515 psa_key_type_t key_type = key_type_arg;
4516 psa_algorithm_t alg = alg_arg;
Paul Elliottfbb4c6d2021-09-22 16:44:21 +01004517 psa_aead_operation_t operation = PSA_AEAD_OPERATION_INIT;
Paul Elliott5221ef62021-09-19 17:33:03 +01004518 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
4519 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
4520 psa_status_t expected_status = expected_status_arg;
4521
4522 PSA_ASSERT( psa_crypto_init( ) );
4523
4524 psa_set_key_usage_flags( &attributes,
4525 PSA_KEY_USAGE_ENCRYPT | PSA_KEY_USAGE_DECRYPT );
4526 psa_set_key_algorithm( &attributes, alg );
4527 psa_set_key_type( &attributes, key_type );
4528
4529 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
4530 &key ) );
4531
Paul Elliott5221ef62021-09-19 17:33:03 +01004532 status = psa_aead_encrypt_setup( &operation, key, alg );
4533
4534 TEST_EQUAL( status, expected_status );
4535
4536 psa_aead_abort( &operation );
4537
Paul Elliott5221ef62021-09-19 17:33:03 +01004538 status = psa_aead_decrypt_setup( &operation, key, alg );
4539
4540 TEST_EQUAL(status, expected_status );
4541
4542exit:
4543 psa_destroy_key( key );
4544 psa_aead_abort( &operation );
4545 PSA_DONE( );
4546}
4547/* END_CASE */
4548
4549/* BEGIN_CASE */
Paul Elliottc23a9a02021-06-21 18:32:46 +01004550void aead_multipart_state_test( int key_type_arg, data_t *key_data,
4551 int alg_arg,
4552 data_t *nonce,
4553 data_t *additional_data,
4554 data_t *input_data )
4555{
4556 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
4557 psa_key_type_t key_type = key_type_arg;
4558 psa_algorithm_t alg = alg_arg;
Paul Elliottfbb4c6d2021-09-22 16:44:21 +01004559 psa_aead_operation_t operation = PSA_AEAD_OPERATION_INIT;
Paul Elliottc23a9a02021-06-21 18:32:46 +01004560 unsigned char *output_data = NULL;
4561 unsigned char *final_data = NULL;
4562 size_t output_size = 0;
4563 size_t finish_output_size = 0;
4564 size_t output_length = 0;
4565 size_t key_bits = 0;
4566 size_t tag_length = 0;
4567 size_t tag_size = 0;
4568 size_t nonce_length = 0;
4569 uint8_t nonce_buffer[PSA_AEAD_NONCE_MAX_SIZE];
4570 uint8_t tag_buffer[PSA_AEAD_TAG_MAX_SIZE];
4571 size_t output_part_length = 0;
4572 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
4573
4574 PSA_ASSERT( psa_crypto_init( ) );
4575
4576 psa_set_key_usage_flags( & attributes,
4577 PSA_KEY_USAGE_ENCRYPT | PSA_KEY_USAGE_DECRYPT );
4578 psa_set_key_algorithm( & attributes, alg );
4579 psa_set_key_type( & attributes, key_type );
4580
4581 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
4582 &key ) );
4583
4584 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
4585 key_bits = psa_get_key_bits( &attributes );
4586
4587 tag_length = PSA_AEAD_TAG_LENGTH( key_type, key_bits, alg );
4588
4589 TEST_ASSERT( tag_length <= PSA_AEAD_TAG_MAX_SIZE );
4590
4591 output_size = PSA_AEAD_UPDATE_OUTPUT_SIZE( key_type, alg, input_data->len );
4592
4593 ASSERT_ALLOC( output_data, output_size );
4594
4595 finish_output_size = PSA_AEAD_FINISH_OUTPUT_SIZE( key_type, alg );
4596
4597 TEST_ASSERT( finish_output_size <= PSA_AEAD_FINISH_OUTPUT_MAX_SIZE );
4598
4599 ASSERT_ALLOC( final_data, finish_output_size );
4600
4601 /* Test all operations error without calling setup first. */
4602
Paul Elliottc23a9a02021-06-21 18:32:46 +01004603 TEST_EQUAL( psa_aead_set_nonce( &operation, nonce->x, nonce->len ),
4604 PSA_ERROR_BAD_STATE );
4605
4606 psa_aead_abort( &operation );
4607
Paul Elliottc23a9a02021-06-21 18:32:46 +01004608 TEST_EQUAL( psa_aead_generate_nonce( &operation, nonce_buffer,
4609 PSA_AEAD_NONCE_MAX_SIZE,
4610 &nonce_length ),
4611 PSA_ERROR_BAD_STATE );
4612
4613 psa_aead_abort( &operation );
4614
Paul Elliott481be342021-07-16 17:38:47 +01004615 /* ------------------------------------------------------- */
4616
Paul Elliottc23a9a02021-06-21 18:32:46 +01004617 TEST_EQUAL( psa_aead_set_lengths( &operation, additional_data->len,
4618 input_data->len ),
4619 PSA_ERROR_BAD_STATE );
4620
4621 psa_aead_abort( &operation );
4622
Paul Elliott481be342021-07-16 17:38:47 +01004623 /* ------------------------------------------------------- */
4624
Paul Elliottc23a9a02021-06-21 18:32:46 +01004625 TEST_EQUAL( psa_aead_update_ad( &operation, additional_data->x,
4626 additional_data->len ),
4627 PSA_ERROR_BAD_STATE );
4628
4629 psa_aead_abort( &operation );
4630
Paul Elliott481be342021-07-16 17:38:47 +01004631 /* ------------------------------------------------------- */
4632
Paul Elliottc23a9a02021-06-21 18:32:46 +01004633 TEST_EQUAL( psa_aead_update( &operation, input_data->x,
4634 input_data->len, output_data,
4635 output_size, &output_length ),
4636 PSA_ERROR_BAD_STATE );
4637
4638 psa_aead_abort( &operation );
4639
Paul Elliott481be342021-07-16 17:38:47 +01004640 /* ------------------------------------------------------- */
4641
Paul Elliottc23a9a02021-06-21 18:32:46 +01004642 TEST_EQUAL( psa_aead_finish( &operation, final_data,
4643 finish_output_size,
4644 &output_part_length,
4645 tag_buffer, tag_length,
4646 &tag_size ),
4647 PSA_ERROR_BAD_STATE );
4648
4649 psa_aead_abort( &operation );
4650
Paul Elliott481be342021-07-16 17:38:47 +01004651 /* ------------------------------------------------------- */
4652
Paul Elliottc23a9a02021-06-21 18:32:46 +01004653 TEST_EQUAL( psa_aead_verify( &operation, final_data,
4654 finish_output_size,
4655 &output_part_length,
4656 tag_buffer,
4657 tag_length ),
4658 PSA_ERROR_BAD_STATE );
4659
4660 psa_aead_abort( &operation );
4661
4662 /* Test for double setups. */
4663
Paul Elliottc23a9a02021-06-21 18:32:46 +01004664 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
4665
4666 TEST_EQUAL( psa_aead_encrypt_setup( &operation, key, alg ),
4667 PSA_ERROR_BAD_STATE );
4668
4669 psa_aead_abort( &operation );
4670
Paul Elliott481be342021-07-16 17:38:47 +01004671 /* ------------------------------------------------------- */
4672
Paul Elliottc23a9a02021-06-21 18:32:46 +01004673 PSA_ASSERT( psa_aead_decrypt_setup( &operation, key, alg ) );
4674
4675 TEST_EQUAL( psa_aead_decrypt_setup( &operation, key, alg ),
4676 PSA_ERROR_BAD_STATE );
4677
4678 psa_aead_abort( &operation );
4679
Paul Elliott374a2be2021-07-16 17:53:40 +01004680 /* ------------------------------------------------------- */
4681
Paul Elliott374a2be2021-07-16 17:53:40 +01004682 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
4683
4684 TEST_EQUAL( psa_aead_decrypt_setup( &operation, key, alg ),
4685 PSA_ERROR_BAD_STATE );
4686
4687 psa_aead_abort( &operation );
4688
4689 /* ------------------------------------------------------- */
4690
Paul Elliott374a2be2021-07-16 17:53:40 +01004691 PSA_ASSERT( psa_aead_decrypt_setup( &operation, key, alg ) );
4692
4693 TEST_EQUAL( psa_aead_encrypt_setup( &operation, key, alg ),
4694 PSA_ERROR_BAD_STATE );
4695
4696 psa_aead_abort( &operation );
4697
Paul Elliottc23a9a02021-06-21 18:32:46 +01004698 /* Test for not setting a nonce. */
4699
Paul Elliottc23a9a02021-06-21 18:32:46 +01004700 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
4701
4702 TEST_EQUAL( psa_aead_update_ad( &operation, additional_data->x,
4703 additional_data->len ),
4704 PSA_ERROR_BAD_STATE );
4705
4706 psa_aead_abort( &operation );
4707
Paul Elliott7f628422021-09-01 12:08:29 +01004708 /* ------------------------------------------------------- */
4709
Paul Elliott7f628422021-09-01 12:08:29 +01004710 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
4711
4712 TEST_EQUAL( psa_aead_update( &operation, input_data->x,
4713 input_data->len, output_data,
4714 output_size, &output_length ),
4715 PSA_ERROR_BAD_STATE );
4716
4717 psa_aead_abort( &operation );
4718
Paul Elliottbdc2c682021-09-21 18:37:10 +01004719 /* ------------------------------------------------------- */
4720
Paul Elliottbdc2c682021-09-21 18:37:10 +01004721 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
4722
4723 TEST_EQUAL( psa_aead_finish( &operation, final_data,
4724 finish_output_size,
4725 &output_part_length,
4726 tag_buffer, tag_length,
4727 &tag_size ),
4728 PSA_ERROR_BAD_STATE );
4729
4730 psa_aead_abort( &operation );
4731
4732 /* ------------------------------------------------------- */
4733
Paul Elliottbdc2c682021-09-21 18:37:10 +01004734 PSA_ASSERT( psa_aead_decrypt_setup( &operation, key, alg ) );
4735
4736 TEST_EQUAL( psa_aead_verify( &operation, final_data,
4737 finish_output_size,
4738 &output_part_length,
4739 tag_buffer,
4740 tag_length ),
4741 PSA_ERROR_BAD_STATE );
4742
4743 psa_aead_abort( &operation );
4744
Paul Elliottc23a9a02021-06-21 18:32:46 +01004745 /* Test for double setting nonce. */
4746
Paul Elliottc23a9a02021-06-21 18:32:46 +01004747 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
4748
4749 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
4750
4751 TEST_EQUAL( psa_aead_set_nonce( &operation, nonce->x, nonce->len ),
4752 PSA_ERROR_BAD_STATE );
4753
4754 psa_aead_abort( &operation );
4755
Paul Elliott374a2be2021-07-16 17:53:40 +01004756 /* Test for double generating nonce. */
4757
Paul Elliott374a2be2021-07-16 17:53:40 +01004758 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
4759
4760 PSA_ASSERT( psa_aead_generate_nonce( &operation, nonce_buffer,
4761 PSA_AEAD_NONCE_MAX_SIZE,
4762 &nonce_length ) );
4763
4764 TEST_EQUAL( psa_aead_generate_nonce( &operation, nonce_buffer,
4765 PSA_AEAD_NONCE_MAX_SIZE,
4766 &nonce_length ),
4767 PSA_ERROR_BAD_STATE );
4768
4769
4770 psa_aead_abort( &operation );
4771
4772 /* Test for generate nonce then set and vice versa */
4773
Paul Elliott374a2be2021-07-16 17:53:40 +01004774 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
4775
4776 PSA_ASSERT( psa_aead_generate_nonce( &operation, nonce_buffer,
4777 PSA_AEAD_NONCE_MAX_SIZE,
4778 &nonce_length ) );
4779
4780 TEST_EQUAL( psa_aead_set_nonce( &operation, nonce->x, nonce->len ),
4781 PSA_ERROR_BAD_STATE );
4782
4783 psa_aead_abort( &operation );
4784
Andrzej Kurekad837522021-12-15 15:28:49 +01004785 /* Test for generating nonce after calling set lengths */
4786
4787 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
4788
4789 PSA_ASSERT( psa_aead_set_lengths( &operation, additional_data->len,
4790 input_data->len ) );
4791
4792 PSA_ASSERT( psa_aead_generate_nonce( &operation, nonce_buffer,
4793 PSA_AEAD_NONCE_MAX_SIZE,
4794 &nonce_length ) );
4795
4796 psa_aead_abort( &operation );
4797
4798 /* Test for generating nonce after calling set lengths with UINT32_MAX length */
4799
4800 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
4801
4802 if( operation.alg == PSA_ALG_CCM )
4803 {
4804 TEST_EQUAL( psa_aead_set_lengths( &operation, UINT32_MAX,
4805 input_data->len ),
4806 PSA_ERROR_INVALID_ARGUMENT );
4807 TEST_EQUAL( psa_aead_generate_nonce( &operation, nonce_buffer,
4808 PSA_AEAD_NONCE_MAX_SIZE,
4809 &nonce_length ),
4810 PSA_ERROR_BAD_STATE );
4811 }
4812 else
4813 {
4814 PSA_ASSERT( psa_aead_set_lengths( &operation, UINT32_MAX,
4815 input_data->len ) );
4816 PSA_ASSERT( psa_aead_generate_nonce( &operation, nonce_buffer,
4817 PSA_AEAD_NONCE_MAX_SIZE,
4818 &nonce_length ) );
4819 }
4820
4821 psa_aead_abort( &operation );
4822
4823 /* Test for generating nonce after calling set lengths with SIZE_MAX length */
4824#if SIZE_MAX > UINT32_MAX
4825 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
4826
4827 if( operation.alg == PSA_ALG_CCM || operation.alg == PSA_ALG_GCM )
4828 {
4829 TEST_EQUAL( psa_aead_set_lengths( &operation, SIZE_MAX,
4830 input_data->len ),
4831 PSA_ERROR_INVALID_ARGUMENT );
4832 TEST_EQUAL( psa_aead_generate_nonce( &operation, nonce_buffer,
4833 PSA_AEAD_NONCE_MAX_SIZE,
4834 &nonce_length ),
4835 PSA_ERROR_BAD_STATE );
4836 }
4837 else
4838 {
4839 PSA_ASSERT( psa_aead_set_lengths( &operation, SIZE_MAX,
4840 input_data->len ) );
4841 PSA_ASSERT( psa_aead_generate_nonce( &operation, nonce_buffer,
4842 PSA_AEAD_NONCE_MAX_SIZE,
4843 &nonce_length ) );
4844 }
4845
4846 psa_aead_abort( &operation );
4847#endif
4848
4849 /* Test for calling set lengths with a length too long, after generating nonce */
4850
4851 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
4852
4853 PSA_ASSERT( psa_aead_generate_nonce( &operation, nonce_buffer,
4854 PSA_AEAD_NONCE_MAX_SIZE,
4855 &nonce_length ) );
4856
4857 if( operation.alg == PSA_ALG_CCM )
4858 {
4859 TEST_EQUAL( psa_aead_set_lengths( &operation, UINT32_MAX,
4860 input_data->len ),
4861 PSA_ERROR_INVALID_ARGUMENT );
4862 }
4863 else
4864 {
4865 PSA_ASSERT( psa_aead_set_lengths( &operation, UINT32_MAX,
4866 input_data->len ) );
4867 }
4868
4869 psa_aead_abort( &operation );
4870
4871
Paul Elliott374a2be2021-07-16 17:53:40 +01004872 /* ------------------------------------------------------- */
4873
Paul Elliott374a2be2021-07-16 17:53:40 +01004874 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
4875
4876 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
4877
4878 TEST_EQUAL( psa_aead_generate_nonce( &operation, nonce_buffer,
4879 PSA_AEAD_NONCE_MAX_SIZE,
4880 &nonce_length ),
4881 PSA_ERROR_BAD_STATE );
4882
4883 psa_aead_abort( &operation );
4884
Paul Elliott7220cae2021-06-22 17:25:57 +01004885 /* Test for generating nonce in decrypt setup. */
4886
Paul Elliott7220cae2021-06-22 17:25:57 +01004887 PSA_ASSERT( psa_aead_decrypt_setup( &operation, key, alg ) );
4888
4889 TEST_EQUAL( psa_aead_generate_nonce( &operation, nonce_buffer,
4890 PSA_AEAD_NONCE_MAX_SIZE,
4891 &nonce_length ),
4892 PSA_ERROR_BAD_STATE );
4893
4894 psa_aead_abort( &operation );
4895
Paul Elliottc23a9a02021-06-21 18:32:46 +01004896 /* Test for setting lengths twice. */
4897
Paul Elliottc23a9a02021-06-21 18:32:46 +01004898 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
4899
4900 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
4901
4902 PSA_ASSERT( psa_aead_set_lengths( &operation, additional_data->len,
4903 input_data->len ) );
4904
4905 TEST_EQUAL( psa_aead_set_lengths( &operation, additional_data->len,
4906 input_data->len ),
4907 PSA_ERROR_BAD_STATE );
4908
4909 psa_aead_abort( &operation );
4910
Andrzej Kurekad837522021-12-15 15:28:49 +01004911 /* Test for setting lengths after setting nonce + already starting data. */
Paul Elliottc23a9a02021-06-21 18:32:46 +01004912
Paul Elliottc23a9a02021-06-21 18:32:46 +01004913 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
4914
4915 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
4916
Andrzej Kurekad837522021-12-15 15:28:49 +01004917 if( operation.alg == PSA_ALG_CCM )
4918 {
Paul Elliottf94bd992021-09-19 18:15:59 +01004919
Andrzej Kurekad837522021-12-15 15:28:49 +01004920 TEST_EQUAL( psa_aead_update_ad( &operation, additional_data->x,
4921 additional_data->len ),
4922 PSA_ERROR_BAD_STATE );
4923 }
4924 else
4925 {
4926 PSA_ASSERT( psa_aead_update_ad( &operation, additional_data->x,
4927 additional_data->len ) );
Paul Elliottf94bd992021-09-19 18:15:59 +01004928
Andrzej Kurekad837522021-12-15 15:28:49 +01004929 TEST_EQUAL( psa_aead_set_lengths( &operation, additional_data->len,
4930 input_data->len ),
4931 PSA_ERROR_BAD_STATE );
4932 }
Paul Elliottf94bd992021-09-19 18:15:59 +01004933 psa_aead_abort( &operation );
4934
4935 /* ------------------------------------------------------- */
4936
Paul Elliottf94bd992021-09-19 18:15:59 +01004937 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
4938
4939 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
4940
Andrzej Kurekad837522021-12-15 15:28:49 +01004941 if( operation.alg == PSA_ALG_CCM )
4942 {
4943 TEST_EQUAL( psa_aead_update( &operation, input_data->x,
4944 input_data->len, output_data,
4945 output_size, &output_length ),
4946 PSA_ERROR_BAD_STATE );
Paul Elliottc23a9a02021-06-21 18:32:46 +01004947
Andrzej Kurekad837522021-12-15 15:28:49 +01004948 }
4949 else
4950 {
4951 PSA_ASSERT( psa_aead_update( &operation, input_data->x,
4952 input_data->len, output_data,
4953 output_size, &output_length ) );
Paul Elliottc23a9a02021-06-21 18:32:46 +01004954
Andrzej Kurekad837522021-12-15 15:28:49 +01004955 TEST_EQUAL( psa_aead_set_lengths( &operation, additional_data->len,
4956 input_data->len ),
4957 PSA_ERROR_BAD_STATE );
4958 }
4959 psa_aead_abort( &operation );
4960
4961 /* ------------------------------------------------------- */
4962
4963 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
4964
4965 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
4966
4967 if( operation.alg == PSA_ALG_CCM )
4968 {
4969 PSA_ASSERT( psa_aead_finish( &operation, final_data,
4970 finish_output_size,
4971 &output_part_length,
4972 tag_buffer, tag_length,
4973 &tag_size ) );
4974 }
4975 else
4976 {
4977 PSA_ASSERT( psa_aead_finish( &operation, final_data,
4978 finish_output_size,
4979 &output_part_length,
4980 tag_buffer, tag_length,
4981 &tag_size ) );
4982
4983 TEST_EQUAL( psa_aead_set_lengths( &operation, additional_data->len,
4984 input_data->len ),
4985 PSA_ERROR_BAD_STATE );
4986 }
4987 psa_aead_abort( &operation );
4988
4989 /* Test for setting lengths after generating nonce + already starting data. */
4990
4991 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
4992
4993 PSA_ASSERT( psa_aead_generate_nonce( &operation, nonce_buffer,
4994 PSA_AEAD_NONCE_MAX_SIZE,
4995 &nonce_length ) );
4996 if( operation.alg == PSA_ALG_CCM )
4997 {
4998
4999 TEST_EQUAL( psa_aead_update_ad( &operation, additional_data->x,
5000 additional_data->len ),
5001 PSA_ERROR_BAD_STATE );
5002 }
5003 else
5004 {
5005 PSA_ASSERT( psa_aead_update_ad( &operation, additional_data->x,
5006 additional_data->len ) );
5007
5008 TEST_EQUAL( psa_aead_set_lengths( &operation, additional_data->len,
5009 input_data->len ),
5010 PSA_ERROR_BAD_STATE );
5011 }
5012 psa_aead_abort( &operation );
5013
5014 /* ------------------------------------------------------- */
5015
5016 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
5017
5018 PSA_ASSERT( psa_aead_generate_nonce( &operation, nonce_buffer,
5019 PSA_AEAD_NONCE_MAX_SIZE,
5020 &nonce_length ) );
5021 if( operation.alg == PSA_ALG_CCM )
5022 {
5023 TEST_EQUAL( psa_aead_update( &operation, input_data->x,
5024 input_data->len, output_data,
5025 output_size, &output_length ),
5026 PSA_ERROR_BAD_STATE );
5027
5028 }
5029 else
5030 {
5031 PSA_ASSERT( psa_aead_update( &operation, input_data->x,
5032 input_data->len, output_data,
5033 output_size, &output_length ) );
5034
5035 TEST_EQUAL( psa_aead_set_lengths( &operation, additional_data->len,
5036 input_data->len ),
5037 PSA_ERROR_BAD_STATE );
5038 }
5039 psa_aead_abort( &operation );
5040
5041 /* ------------------------------------------------------- */
5042
5043 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
5044
5045 PSA_ASSERT( psa_aead_generate_nonce( &operation, nonce_buffer,
5046 PSA_AEAD_NONCE_MAX_SIZE,
5047 &nonce_length ) );
5048 if( operation.alg == PSA_ALG_CCM )
5049 {
5050 PSA_ASSERT( psa_aead_finish( &operation, final_data,
5051 finish_output_size,
5052 &output_part_length,
5053 tag_buffer, tag_length,
5054 &tag_size ) );
5055 }
5056 else
5057 {
5058 PSA_ASSERT( psa_aead_finish( &operation, final_data,
5059 finish_output_size,
5060 &output_part_length,
5061 tag_buffer, tag_length,
5062 &tag_size ) );
5063
5064 TEST_EQUAL( psa_aead_set_lengths( &operation, additional_data->len,
5065 input_data->len ),
5066 PSA_ERROR_BAD_STATE );
5067 }
Paul Elliottc23a9a02021-06-21 18:32:46 +01005068 psa_aead_abort( &operation );
5069
Paul Elliott243080c2021-07-21 19:01:17 +01005070 /* Test for not sending any additional data or data after setting non zero
5071 * lengths for them. (encrypt) */
Paul Elliottc23a9a02021-06-21 18:32:46 +01005072
Paul Elliottc23a9a02021-06-21 18:32:46 +01005073 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
5074
5075 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
5076
5077 PSA_ASSERT( psa_aead_set_lengths( &operation, additional_data->len,
5078 input_data->len ) );
5079
5080 TEST_EQUAL( psa_aead_finish( &operation, final_data,
5081 finish_output_size,
5082 &output_part_length,
5083 tag_buffer, tag_length,
5084 &tag_size ),
5085 PSA_ERROR_INVALID_ARGUMENT );
5086
5087 psa_aead_abort( &operation );
5088
Paul Elliott243080c2021-07-21 19:01:17 +01005089 /* Test for not sending any additional data or data after setting non-zero
5090 * lengths for them. (decrypt) */
Paul Elliottc23a9a02021-06-21 18:32:46 +01005091
Paul Elliottc23a9a02021-06-21 18:32:46 +01005092 PSA_ASSERT( psa_aead_decrypt_setup( &operation, key, alg ) );
5093
5094 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
5095
5096 PSA_ASSERT( psa_aead_set_lengths( &operation, additional_data->len,
5097 input_data->len ) );
5098
5099 TEST_EQUAL( psa_aead_verify( &operation, final_data,
5100 finish_output_size,
5101 &output_part_length,
5102 tag_buffer,
5103 tag_length ),
5104 PSA_ERROR_INVALID_ARGUMENT );
5105
5106 psa_aead_abort( &operation );
5107
Paul Elliott243080c2021-07-21 19:01:17 +01005108 /* Test for not sending any additional data after setting a non-zero length
5109 * for it. */
Paul Elliottc23a9a02021-06-21 18:32:46 +01005110
Paul Elliottc23a9a02021-06-21 18:32:46 +01005111 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
5112
5113 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
5114
5115 PSA_ASSERT( psa_aead_set_lengths( &operation, additional_data->len,
5116 input_data->len ) );
5117
5118 TEST_EQUAL( psa_aead_update( &operation, input_data->x,
5119 input_data->len, output_data,
5120 output_size, &output_length ),
5121 PSA_ERROR_INVALID_ARGUMENT );
5122
5123 psa_aead_abort( &operation );
5124
Paul Elliottf94bd992021-09-19 18:15:59 +01005125 /* Test for not sending any data after setting a non-zero length for it.*/
5126
Paul Elliottf94bd992021-09-19 18:15:59 +01005127 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
5128
5129 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
5130
5131 PSA_ASSERT( psa_aead_set_lengths( &operation, additional_data->len,
5132 input_data->len ) );
5133
5134 PSA_ASSERT( psa_aead_update_ad( &operation, additional_data->x,
5135 additional_data->len ) );
5136
5137 TEST_EQUAL( psa_aead_finish( &operation, final_data,
5138 finish_output_size,
5139 &output_part_length,
5140 tag_buffer, tag_length,
5141 &tag_size ),
5142 PSA_ERROR_INVALID_ARGUMENT );
5143
5144 psa_aead_abort( &operation );
5145
Paul Elliottb0450fe2021-09-01 15:06:26 +01005146 /* Test for sending too much additional data after setting lengths. */
5147
Paul Elliottb0450fe2021-09-01 15:06:26 +01005148 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
5149
5150 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
5151
5152 PSA_ASSERT( psa_aead_set_lengths( &operation, 0, 0 ) );
5153
5154
5155 TEST_EQUAL( psa_aead_update_ad( &operation, additional_data->x,
5156 additional_data->len ),
5157 PSA_ERROR_INVALID_ARGUMENT );
5158
5159 psa_aead_abort( &operation );
5160
Paul Elliotta2a09b02021-09-22 14:56:40 +01005161 /* ------------------------------------------------------- */
Paul Elliottfd0c154c2021-09-17 18:03:52 +01005162
5163 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
5164
5165 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
5166
5167 PSA_ASSERT( psa_aead_set_lengths( &operation, additional_data->len,
5168 input_data->len ) );
5169
5170 PSA_ASSERT( psa_aead_update_ad( &operation, additional_data->x,
5171 additional_data->len ) );
5172
5173 TEST_EQUAL( psa_aead_update_ad( &operation, additional_data->x,
5174 1 ),
5175 PSA_ERROR_INVALID_ARGUMENT );
5176
5177 psa_aead_abort( &operation );
5178
Paul Elliottb0450fe2021-09-01 15:06:26 +01005179 /* Test for sending too much data after setting lengths. */
5180
Paul Elliottb0450fe2021-09-01 15:06:26 +01005181 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
5182
5183 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
5184
5185 PSA_ASSERT( psa_aead_set_lengths( &operation, 0, 0 ) );
5186
5187 TEST_EQUAL( psa_aead_update( &operation, input_data->x,
5188 input_data->len, output_data,
5189 output_size, &output_length ),
5190 PSA_ERROR_INVALID_ARGUMENT );
5191
5192 psa_aead_abort( &operation );
5193
Paul Elliotta2a09b02021-09-22 14:56:40 +01005194 /* ------------------------------------------------------- */
Paul Elliottfd0c154c2021-09-17 18:03:52 +01005195
5196 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
5197
5198 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
5199
5200 PSA_ASSERT( psa_aead_set_lengths( &operation, additional_data->len,
5201 input_data->len ) );
5202
5203 PSA_ASSERT( psa_aead_update_ad( &operation, additional_data->x,
5204 additional_data->len ) );
5205
5206 PSA_ASSERT( psa_aead_update( &operation, input_data->x,
5207 input_data->len, output_data,
5208 output_size, &output_length ) );
5209
5210 TEST_EQUAL( psa_aead_update( &operation, input_data->x,
5211 1, output_data,
5212 output_size, &output_length ),
5213 PSA_ERROR_INVALID_ARGUMENT );
5214
5215 psa_aead_abort( &operation );
5216
Paul Elliottc23a9a02021-06-21 18:32:46 +01005217 /* Test sending additional data after data. */
5218
Paul Elliottc23a9a02021-06-21 18:32:46 +01005219 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
5220
5221 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
5222
Andrzej Kurekad837522021-12-15 15:28:49 +01005223 if( operation.alg != PSA_ALG_CCM )
5224 {
5225 PSA_ASSERT( psa_aead_update( &operation, input_data->x,
5226 input_data->len, output_data,
5227 output_size, &output_length ) );
Paul Elliottc23a9a02021-06-21 18:32:46 +01005228
Andrzej Kurekad837522021-12-15 15:28:49 +01005229 TEST_EQUAL( psa_aead_update_ad( &operation, additional_data->x,
5230 additional_data->len ),
5231 PSA_ERROR_BAD_STATE );
5232 }
Paul Elliottc23a9a02021-06-21 18:32:46 +01005233 psa_aead_abort( &operation );
5234
Paul Elliott534d0b42021-06-22 19:15:20 +01005235 /* Test calling finish on decryption. */
5236
Paul Elliott534d0b42021-06-22 19:15:20 +01005237 PSA_ASSERT( psa_aead_decrypt_setup( &operation, key, alg ) );
5238
5239 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
5240
5241 TEST_EQUAL( psa_aead_finish( &operation, final_data,
5242 finish_output_size,
5243 &output_part_length,
5244 tag_buffer, tag_length,
5245 &tag_size ),
5246 PSA_ERROR_BAD_STATE );
5247
5248 psa_aead_abort( &operation );
5249
5250 /* Test calling verify on encryption. */
5251
Paul Elliott534d0b42021-06-22 19:15:20 +01005252 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
5253
5254 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
5255
5256 TEST_EQUAL( psa_aead_verify( &operation, final_data,
5257 finish_output_size,
5258 &output_part_length,
5259 tag_buffer,
5260 tag_length ),
Paul Elliott5b065cb2021-06-23 08:33:22 +01005261 PSA_ERROR_BAD_STATE );
Paul Elliott534d0b42021-06-22 19:15:20 +01005262
5263 psa_aead_abort( &operation );
5264
5265
Paul Elliottc23a9a02021-06-21 18:32:46 +01005266exit:
5267 psa_destroy_key( key );
5268 psa_aead_abort( &operation );
5269 mbedtls_free( output_data );
5270 mbedtls_free( final_data );
5271 PSA_DONE( );
5272}
5273/* END_CASE */
5274
5275/* BEGIN_CASE */
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02005276void signature_size( int type_arg,
5277 int bits,
5278 int alg_arg,
5279 int expected_size_arg )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005280{
5281 psa_key_type_t type = type_arg;
5282 psa_algorithm_t alg = alg_arg;
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01005283 size_t actual_size = PSA_SIGN_OUTPUT_SIZE( type, bits, alg );
Gilles Peskine841b14b2019-11-26 17:37:37 +01005284
Gilles Peskinefe11b722018-12-18 00:24:04 +01005285 TEST_EQUAL( actual_size, (size_t) expected_size_arg );
Gilles Peskine841b14b2019-11-26 17:37:37 +01005286
Gilles Peskinee59236f2018-01-27 23:32:46 +01005287exit:
5288 ;
5289}
5290/* END_CASE */
5291
5292/* BEGIN_CASE */
gabor-mezei-armb9530232021-04-16 14:21:21 +02005293void sign_hash_deterministic( int key_type_arg, data_t *key_data,
5294 int alg_arg, data_t *input_data,
5295 data_t *output_data )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005296{
Ronald Cron5425a212020-08-04 14:58:35 +02005297 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005298 psa_key_type_t key_type = key_type_arg;
5299 psa_algorithm_t alg = alg_arg;
Gilles Peskine20035e32018-02-03 22:44:14 +01005300 size_t key_bits;
Gilles Peskine20035e32018-02-03 22:44:14 +01005301 unsigned char *signature = NULL;
5302 size_t signature_size;
5303 size_t signature_length = 0xdeadbeef;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02005304 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine20035e32018-02-03 22:44:14 +01005305
Gilles Peskine8817f612018-12-18 00:18:46 +01005306 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine20035e32018-02-03 22:44:14 +01005307
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01005308 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_HASH );
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02005309 psa_set_key_algorithm( &attributes, alg );
5310 psa_set_key_type( &attributes, key_type );
mohammad1603a97cb8c2018-03-28 03:46:26 -07005311
Gilles Peskine049c7532019-05-15 20:22:09 +02005312 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02005313 &key ) );
5314 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02005315 key_bits = psa_get_key_bits( &attributes );
Gilles Peskine20035e32018-02-03 22:44:14 +01005316
Gilles Peskine860ce9d2018-06-28 12:23:00 +02005317 /* Allocate a buffer which has the size advertized by the
5318 * library. */
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01005319 signature_size = PSA_SIGN_OUTPUT_SIZE( key_type,
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02005320 key_bits, alg );
Gilles Peskine20035e32018-02-03 22:44:14 +01005321 TEST_ASSERT( signature_size != 0 );
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01005322 TEST_ASSERT( signature_size <= PSA_SIGNATURE_MAX_SIZE );
Gilles Peskine8cebbba2018-09-27 13:54:18 +02005323 ASSERT_ALLOC( signature, signature_size );
Gilles Peskine20035e32018-02-03 22:44:14 +01005324
Gilles Peskine860ce9d2018-06-28 12:23:00 +02005325 /* Perform the signature. */
Ronald Cron5425a212020-08-04 14:58:35 +02005326 PSA_ASSERT( psa_sign_hash( key, alg,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01005327 input_data->x, input_data->len,
5328 signature, signature_size,
5329 &signature_length ) );
Gilles Peskine9911b022018-06-29 17:30:48 +02005330 /* Verify that the signature is what is expected. */
Gilles Peskinebd7dea92018-09-27 13:57:19 +02005331 ASSERT_COMPARE( output_data->x, output_data->len,
5332 signature, signature_length );
Gilles Peskine20035e32018-02-03 22:44:14 +01005333
5334exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +01005335 /*
5336 * Key attributes may have been returned by psa_get_key_attributes()
5337 * thus reset them as required.
5338 */
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02005339 psa_reset_key_attributes( &attributes );
Ronald Cron3a4f0e32020-11-19 17:55:23 +01005340
Ronald Cron5425a212020-08-04 14:58:35 +02005341 psa_destroy_key( key );
Gilles Peskine0189e752018-02-03 23:57:22 +01005342 mbedtls_free( signature );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02005343 PSA_DONE( );
Gilles Peskine20035e32018-02-03 22:44:14 +01005344}
5345/* END_CASE */
5346
5347/* BEGIN_CASE */
gabor-mezei-armb9530232021-04-16 14:21:21 +02005348void sign_hash_fail( int key_type_arg, data_t *key_data,
5349 int alg_arg, data_t *input_data,
5350 int signature_size_arg, int expected_status_arg )
Gilles Peskine20035e32018-02-03 22:44:14 +01005351{
Ronald Cron5425a212020-08-04 14:58:35 +02005352 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine20035e32018-02-03 22:44:14 +01005353 psa_key_type_t key_type = key_type_arg;
5354 psa_algorithm_t alg = alg_arg;
Gilles Peskine860ce9d2018-06-28 12:23:00 +02005355 size_t signature_size = signature_size_arg;
Gilles Peskine20035e32018-02-03 22:44:14 +01005356 psa_status_t actual_status;
5357 psa_status_t expected_status = expected_status_arg;
Gilles Peskine40f68b92018-03-07 16:43:36 +01005358 unsigned char *signature = NULL;
Gilles Peskine93aa0332018-02-03 23:58:03 +01005359 size_t signature_length = 0xdeadbeef;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02005360 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine20035e32018-02-03 22:44:14 +01005361
Gilles Peskine8cebbba2018-09-27 13:54:18 +02005362 ASSERT_ALLOC( signature, signature_size );
Gilles Peskine20035e32018-02-03 22:44:14 +01005363
Gilles Peskine8817f612018-12-18 00:18:46 +01005364 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine20035e32018-02-03 22:44:14 +01005365
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01005366 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_HASH );
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02005367 psa_set_key_algorithm( &attributes, alg );
5368 psa_set_key_type( &attributes, key_type );
mohammad1603a97cb8c2018-03-28 03:46:26 -07005369
Gilles Peskine049c7532019-05-15 20:22:09 +02005370 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02005371 &key ) );
Gilles Peskine20035e32018-02-03 22:44:14 +01005372
Ronald Cron5425a212020-08-04 14:58:35 +02005373 actual_status = psa_sign_hash( key, alg,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01005374 input_data->x, input_data->len,
5375 signature, signature_size,
5376 &signature_length );
Gilles Peskinefe11b722018-12-18 00:24:04 +01005377 TEST_EQUAL( actual_status, expected_status );
Gilles Peskine860ce9d2018-06-28 12:23:00 +02005378 /* The value of *signature_length is unspecified on error, but
5379 * whatever it is, it should be less than signature_size, so that
5380 * if the caller tries to read *signature_length bytes without
5381 * checking the error code then they don't overflow a buffer. */
5382 TEST_ASSERT( signature_length <= signature_size );
Gilles Peskine20035e32018-02-03 22:44:14 +01005383
5384exit:
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02005385 psa_reset_key_attributes( &attributes );
Ronald Cron5425a212020-08-04 14:58:35 +02005386 psa_destroy_key( key );
Gilles Peskine20035e32018-02-03 22:44:14 +01005387 mbedtls_free( signature );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02005388 PSA_DONE( );
Gilles Peskine20035e32018-02-03 22:44:14 +01005389}
5390/* END_CASE */
mohammad16038cc1cee2018-03-28 01:21:33 +03005391
5392/* BEGIN_CASE */
gabor-mezei-armb9530232021-04-16 14:21:21 +02005393void sign_verify_hash( int key_type_arg, data_t *key_data,
5394 int alg_arg, data_t *input_data )
Gilles Peskine9911b022018-06-29 17:30:48 +02005395{
Ronald Cron5425a212020-08-04 14:58:35 +02005396 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine9911b022018-06-29 17:30:48 +02005397 psa_key_type_t key_type = key_type_arg;
5398 psa_algorithm_t alg = alg_arg;
5399 size_t key_bits;
5400 unsigned char *signature = NULL;
5401 size_t signature_size;
5402 size_t signature_length = 0xdeadbeef;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02005403 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine9911b022018-06-29 17:30:48 +02005404
Gilles Peskine8817f612018-12-18 00:18:46 +01005405 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine9911b022018-06-29 17:30:48 +02005406
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01005407 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_HASH | PSA_KEY_USAGE_VERIFY_HASH );
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02005408 psa_set_key_algorithm( &attributes, alg );
5409 psa_set_key_type( &attributes, key_type );
Gilles Peskine9911b022018-06-29 17:30:48 +02005410
Gilles Peskine049c7532019-05-15 20:22:09 +02005411 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02005412 &key ) );
5413 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02005414 key_bits = psa_get_key_bits( &attributes );
Gilles Peskine9911b022018-06-29 17:30:48 +02005415
5416 /* Allocate a buffer which has the size advertized by the
5417 * library. */
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01005418 signature_size = PSA_SIGN_OUTPUT_SIZE( key_type,
Gilles Peskine9911b022018-06-29 17:30:48 +02005419 key_bits, alg );
5420 TEST_ASSERT( signature_size != 0 );
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01005421 TEST_ASSERT( signature_size <= PSA_SIGNATURE_MAX_SIZE );
Gilles Peskine8cebbba2018-09-27 13:54:18 +02005422 ASSERT_ALLOC( signature, signature_size );
Gilles Peskine9911b022018-06-29 17:30:48 +02005423
5424 /* Perform the signature. */
Ronald Cron5425a212020-08-04 14:58:35 +02005425 PSA_ASSERT( psa_sign_hash( key, alg,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01005426 input_data->x, input_data->len,
5427 signature, signature_size,
5428 &signature_length ) );
Gilles Peskine9911b022018-06-29 17:30:48 +02005429 /* Check that the signature length looks sensible. */
5430 TEST_ASSERT( signature_length <= signature_size );
5431 TEST_ASSERT( signature_length > 0 );
5432
5433 /* Use the library to verify that the signature is correct. */
Ronald Cron5425a212020-08-04 14:58:35 +02005434 PSA_ASSERT( psa_verify_hash( key, alg,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01005435 input_data->x, input_data->len,
5436 signature, signature_length ) );
Gilles Peskine9911b022018-06-29 17:30:48 +02005437
5438 if( input_data->len != 0 )
5439 {
5440 /* Flip a bit in the input and verify that the signature is now
5441 * detected as invalid. Flip a bit at the beginning, not at the end,
5442 * because ECDSA may ignore the last few bits of the input. */
5443 input_data->x[0] ^= 1;
Ronald Cron5425a212020-08-04 14:58:35 +02005444 TEST_EQUAL( psa_verify_hash( key, alg,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01005445 input_data->x, input_data->len,
5446 signature, signature_length ),
Gilles Peskinef812dcf2018-12-18 00:33:25 +01005447 PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine9911b022018-06-29 17:30:48 +02005448 }
5449
5450exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +01005451 /*
5452 * Key attributes may have been returned by psa_get_key_attributes()
5453 * thus reset them as required.
5454 */
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02005455 psa_reset_key_attributes( &attributes );
Ronald Cron3a4f0e32020-11-19 17:55:23 +01005456
Ronald Cron5425a212020-08-04 14:58:35 +02005457 psa_destroy_key( key );
Gilles Peskine9911b022018-06-29 17:30:48 +02005458 mbedtls_free( signature );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02005459 PSA_DONE( );
Gilles Peskine9911b022018-06-29 17:30:48 +02005460}
5461/* END_CASE */
5462
5463/* BEGIN_CASE */
gabor-mezei-armb9530232021-04-16 14:21:21 +02005464void verify_hash( int key_type_arg, data_t *key_data,
5465 int alg_arg, data_t *hash_data,
5466 data_t *signature_data )
itayzafrir5c753392018-05-08 11:18:38 +03005467{
Ronald Cron5425a212020-08-04 14:58:35 +02005468 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
itayzafrir5c753392018-05-08 11:18:38 +03005469 psa_key_type_t key_type = key_type_arg;
5470 psa_algorithm_t alg = alg_arg;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02005471 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
itayzafrir5c753392018-05-08 11:18:38 +03005472
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01005473 TEST_ASSERT( signature_data->len <= PSA_SIGNATURE_MAX_SIZE );
Gilles Peskine69c12672018-06-28 00:07:19 +02005474
Gilles Peskine8817f612018-12-18 00:18:46 +01005475 PSA_ASSERT( psa_crypto_init( ) );
itayzafrir5c753392018-05-08 11:18:38 +03005476
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01005477 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_VERIFY_HASH );
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02005478 psa_set_key_algorithm( &attributes, alg );
5479 psa_set_key_type( &attributes, key_type );
itayzafrir5c753392018-05-08 11:18:38 +03005480
Gilles Peskine049c7532019-05-15 20:22:09 +02005481 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02005482 &key ) );
itayzafrir5c753392018-05-08 11:18:38 +03005483
Ronald Cron5425a212020-08-04 14:58:35 +02005484 PSA_ASSERT( psa_verify_hash( key, alg,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01005485 hash_data->x, hash_data->len,
5486 signature_data->x, signature_data->len ) );
Gilles Peskine0627f982019-11-26 19:12:16 +01005487
itayzafrir5c753392018-05-08 11:18:38 +03005488exit:
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02005489 psa_reset_key_attributes( &attributes );
Ronald Cron5425a212020-08-04 14:58:35 +02005490 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02005491 PSA_DONE( );
itayzafrir5c753392018-05-08 11:18:38 +03005492}
5493/* END_CASE */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005494
5495/* BEGIN_CASE */
gabor-mezei-armb9530232021-04-16 14:21:21 +02005496void verify_hash_fail( int key_type_arg, data_t *key_data,
5497 int alg_arg, data_t *hash_data,
5498 data_t *signature_data,
5499 int expected_status_arg )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005500{
Ronald Cron5425a212020-08-04 14:58:35 +02005501 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005502 psa_key_type_t key_type = key_type_arg;
5503 psa_algorithm_t alg = alg_arg;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005504 psa_status_t actual_status;
5505 psa_status_t expected_status = expected_status_arg;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02005506 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005507
Gilles Peskine8817f612018-12-18 00:18:46 +01005508 PSA_ASSERT( psa_crypto_init( ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005509
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01005510 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_VERIFY_HASH );
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02005511 psa_set_key_algorithm( &attributes, alg );
5512 psa_set_key_type( &attributes, key_type );
Nir Sonnenscheind7082602018-06-04 16:45:27 +03005513
Gilles Peskine049c7532019-05-15 20:22:09 +02005514 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02005515 &key ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005516
Ronald Cron5425a212020-08-04 14:58:35 +02005517 actual_status = psa_verify_hash( key, alg,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01005518 hash_data->x, hash_data->len,
5519 signature_data->x, signature_data->len );
Gilles Peskinefe11b722018-12-18 00:24:04 +01005520 TEST_EQUAL( actual_status, expected_status );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005521
5522exit:
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02005523 psa_reset_key_attributes( &attributes );
Ronald Cron5425a212020-08-04 14:58:35 +02005524 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02005525 PSA_DONE( );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005526}
5527/* END_CASE */
5528
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005529/* BEGIN_CASE */
gabor-mezei-arm53028482021-04-15 18:19:50 +02005530void sign_message_deterministic( int key_type_arg,
5531 data_t *key_data,
5532 int alg_arg,
5533 data_t *input_data,
5534 data_t *output_data )
5535{
5536 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
5537 psa_key_type_t key_type = key_type_arg;
5538 psa_algorithm_t alg = alg_arg;
5539 size_t key_bits;
5540 unsigned char *signature = NULL;
5541 size_t signature_size;
5542 size_t signature_length = 0xdeadbeef;
5543 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
5544
5545 PSA_ASSERT( psa_crypto_init( ) );
5546
5547 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_MESSAGE );
5548 psa_set_key_algorithm( &attributes, alg );
5549 psa_set_key_type( &attributes, key_type );
5550
5551 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
5552 &key ) );
5553 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
5554 key_bits = psa_get_key_bits( &attributes );
5555
5556 signature_size = PSA_SIGN_OUTPUT_SIZE( key_type, key_bits, alg );
5557 TEST_ASSERT( signature_size != 0 );
5558 TEST_ASSERT( signature_size <= PSA_SIGNATURE_MAX_SIZE );
5559 ASSERT_ALLOC( signature, signature_size );
5560
5561 PSA_ASSERT( psa_sign_message( key, alg,
5562 input_data->x, input_data->len,
5563 signature, signature_size,
5564 &signature_length ) );
5565
5566 ASSERT_COMPARE( output_data->x, output_data->len,
5567 signature, signature_length );
5568
5569exit:
5570 psa_reset_key_attributes( &attributes );
5571
5572 psa_destroy_key( key );
5573 mbedtls_free( signature );
5574 PSA_DONE( );
5575
5576}
5577/* END_CASE */
5578
5579/* BEGIN_CASE */
5580void sign_message_fail( int key_type_arg,
5581 data_t *key_data,
5582 int alg_arg,
5583 data_t *input_data,
5584 int signature_size_arg,
5585 int expected_status_arg )
5586{
5587 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
5588 psa_key_type_t key_type = key_type_arg;
5589 psa_algorithm_t alg = alg_arg;
5590 size_t signature_size = signature_size_arg;
5591 psa_status_t actual_status;
5592 psa_status_t expected_status = expected_status_arg;
5593 unsigned char *signature = NULL;
5594 size_t signature_length = 0xdeadbeef;
5595 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
5596
5597 ASSERT_ALLOC( signature, signature_size );
5598
5599 PSA_ASSERT( psa_crypto_init( ) );
5600
5601 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_MESSAGE );
5602 psa_set_key_algorithm( &attributes, alg );
5603 psa_set_key_type( &attributes, key_type );
5604
5605 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
5606 &key ) );
5607
5608 actual_status = psa_sign_message( key, alg,
5609 input_data->x, input_data->len,
5610 signature, signature_size,
5611 &signature_length );
5612 TEST_EQUAL( actual_status, expected_status );
5613 /* The value of *signature_length is unspecified on error, but
5614 * whatever it is, it should be less than signature_size, so that
5615 * if the caller tries to read *signature_length bytes without
5616 * checking the error code then they don't overflow a buffer. */
5617 TEST_ASSERT( signature_length <= signature_size );
5618
5619exit:
5620 psa_reset_key_attributes( &attributes );
5621 psa_destroy_key( key );
5622 mbedtls_free( signature );
5623 PSA_DONE( );
5624}
5625/* END_CASE */
5626
5627/* BEGIN_CASE */
5628void sign_verify_message( int key_type_arg,
5629 data_t *key_data,
5630 int alg_arg,
5631 data_t *input_data )
5632{
5633 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
5634 psa_key_type_t key_type = key_type_arg;
5635 psa_algorithm_t alg = alg_arg;
5636 size_t key_bits;
5637 unsigned char *signature = NULL;
5638 size_t signature_size;
5639 size_t signature_length = 0xdeadbeef;
5640 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
5641
5642 PSA_ASSERT( psa_crypto_init( ) );
5643
5644 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_MESSAGE |
5645 PSA_KEY_USAGE_VERIFY_MESSAGE );
5646 psa_set_key_algorithm( &attributes, alg );
5647 psa_set_key_type( &attributes, key_type );
5648
5649 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
5650 &key ) );
5651 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
5652 key_bits = psa_get_key_bits( &attributes );
5653
5654 signature_size = PSA_SIGN_OUTPUT_SIZE( key_type, key_bits, alg );
5655 TEST_ASSERT( signature_size != 0 );
5656 TEST_ASSERT( signature_size <= PSA_SIGNATURE_MAX_SIZE );
5657 ASSERT_ALLOC( signature, signature_size );
5658
5659 PSA_ASSERT( psa_sign_message( key, alg,
5660 input_data->x, input_data->len,
5661 signature, signature_size,
5662 &signature_length ) );
5663 TEST_ASSERT( signature_length <= signature_size );
5664 TEST_ASSERT( signature_length > 0 );
5665
5666 PSA_ASSERT( psa_verify_message( key, alg,
5667 input_data->x, input_data->len,
5668 signature, signature_length ) );
5669
5670 if( input_data->len != 0 )
5671 {
5672 /* Flip a bit in the input and verify that the signature is now
5673 * detected as invalid. Flip a bit at the beginning, not at the end,
5674 * because ECDSA may ignore the last few bits of the input. */
5675 input_data->x[0] ^= 1;
5676 TEST_EQUAL( psa_verify_message( key, alg,
5677 input_data->x, input_data->len,
5678 signature, signature_length ),
5679 PSA_ERROR_INVALID_SIGNATURE );
5680 }
5681
5682exit:
5683 psa_reset_key_attributes( &attributes );
5684
5685 psa_destroy_key( key );
5686 mbedtls_free( signature );
5687 PSA_DONE( );
5688}
5689/* END_CASE */
5690
5691/* BEGIN_CASE */
5692void verify_message( int key_type_arg,
5693 data_t *key_data,
5694 int alg_arg,
5695 data_t *input_data,
5696 data_t *signature_data )
5697{
5698 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
5699 psa_key_type_t key_type = key_type_arg;
5700 psa_algorithm_t alg = alg_arg;
5701 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
5702
5703 TEST_ASSERT( signature_data->len <= PSA_SIGNATURE_MAX_SIZE );
5704
5705 PSA_ASSERT( psa_crypto_init( ) );
5706
5707 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_VERIFY_MESSAGE );
5708 psa_set_key_algorithm( &attributes, alg );
5709 psa_set_key_type( &attributes, key_type );
5710
5711 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
5712 &key ) );
5713
5714 PSA_ASSERT( psa_verify_message( key, alg,
5715 input_data->x, input_data->len,
5716 signature_data->x, signature_data->len ) );
5717
5718exit:
5719 psa_reset_key_attributes( &attributes );
5720 psa_destroy_key( key );
5721 PSA_DONE( );
5722}
5723/* END_CASE */
5724
5725/* BEGIN_CASE */
5726void verify_message_fail( int key_type_arg,
5727 data_t *key_data,
5728 int alg_arg,
5729 data_t *hash_data,
5730 data_t *signature_data,
5731 int expected_status_arg )
5732{
5733 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
5734 psa_key_type_t key_type = key_type_arg;
5735 psa_algorithm_t alg = alg_arg;
5736 psa_status_t actual_status;
5737 psa_status_t expected_status = expected_status_arg;
5738 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
5739
5740 PSA_ASSERT( psa_crypto_init( ) );
5741
5742 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_VERIFY_MESSAGE );
5743 psa_set_key_algorithm( &attributes, alg );
5744 psa_set_key_type( &attributes, key_type );
5745
5746 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
5747 &key ) );
5748
5749 actual_status = psa_verify_message( key, alg,
5750 hash_data->x, hash_data->len,
5751 signature_data->x,
5752 signature_data->len );
5753 TEST_EQUAL( actual_status, expected_status );
5754
5755exit:
5756 psa_reset_key_attributes( &attributes );
5757 psa_destroy_key( key );
5758 PSA_DONE( );
5759}
5760/* END_CASE */
5761
5762/* BEGIN_CASE */
Gilles Peskine656896e2018-06-29 19:12:28 +02005763void asymmetric_encrypt( int key_type_arg,
5764 data_t *key_data,
5765 int alg_arg,
5766 data_t *input_data,
Gilles Peskine68428122018-06-30 18:42:41 +02005767 data_t *label,
Gilles Peskine656896e2018-06-29 19:12:28 +02005768 int expected_output_length_arg,
5769 int expected_status_arg )
5770{
Ronald Cron5425a212020-08-04 14:58:35 +02005771 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine656896e2018-06-29 19:12:28 +02005772 psa_key_type_t key_type = key_type_arg;
5773 psa_algorithm_t alg = alg_arg;
5774 size_t expected_output_length = expected_output_length_arg;
5775 size_t key_bits;
5776 unsigned char *output = NULL;
5777 size_t output_size;
5778 size_t output_length = ~0;
5779 psa_status_t actual_status;
5780 psa_status_t expected_status = expected_status_arg;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02005781 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine656896e2018-06-29 19:12:28 +02005782
Gilles Peskine8817f612018-12-18 00:18:46 +01005783 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskinebdf309c2018-12-03 15:36:32 +01005784
Gilles Peskine656896e2018-06-29 19:12:28 +02005785 /* Import the key */
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02005786 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
5787 psa_set_key_algorithm( &attributes, alg );
5788 psa_set_key_type( &attributes, key_type );
Gilles Peskine049c7532019-05-15 20:22:09 +02005789 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02005790 &key ) );
Gilles Peskine656896e2018-06-29 19:12:28 +02005791
5792 /* Determine the maximum output length */
Ronald Cron5425a212020-08-04 14:58:35 +02005793 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02005794 key_bits = psa_get_key_bits( &attributes );
gabor-mezei-armceface22021-01-21 12:26:17 +01005795
Gilles Peskine656896e2018-06-29 19:12:28 +02005796 output_size = PSA_ASYMMETRIC_ENCRYPT_OUTPUT_SIZE( key_type, key_bits, alg );
gabor-mezei-armceface22021-01-21 12:26:17 +01005797 TEST_ASSERT( output_size <= PSA_ASYMMETRIC_ENCRYPT_OUTPUT_MAX_SIZE );
Gilles Peskine8cebbba2018-09-27 13:54:18 +02005798 ASSERT_ALLOC( output, output_size );
Gilles Peskine656896e2018-06-29 19:12:28 +02005799
5800 /* Encrypt the input */
Ronald Cron5425a212020-08-04 14:58:35 +02005801 actual_status = psa_asymmetric_encrypt( key, alg,
Gilles Peskine656896e2018-06-29 19:12:28 +02005802 input_data->x, input_data->len,
Gilles Peskine68428122018-06-30 18:42:41 +02005803 label->x, label->len,
Gilles Peskine656896e2018-06-29 19:12:28 +02005804 output, output_size,
5805 &output_length );
Gilles Peskinefe11b722018-12-18 00:24:04 +01005806 TEST_EQUAL( actual_status, expected_status );
5807 TEST_EQUAL( output_length, expected_output_length );
Gilles Peskine656896e2018-06-29 19:12:28 +02005808
Gilles Peskine68428122018-06-30 18:42:41 +02005809 /* If the label is empty, the test framework puts a non-null pointer
5810 * in label->x. Test that a null pointer works as well. */
5811 if( label->len == 0 )
5812 {
5813 output_length = ~0;
Gilles Peskinef7ab5ad2018-09-26 18:19:24 +02005814 if( output_size != 0 )
5815 memset( output, 0, output_size );
Ronald Cron5425a212020-08-04 14:58:35 +02005816 actual_status = psa_asymmetric_encrypt( key, alg,
Gilles Peskine68428122018-06-30 18:42:41 +02005817 input_data->x, input_data->len,
5818 NULL, label->len,
5819 output, output_size,
5820 &output_length );
Gilles Peskinefe11b722018-12-18 00:24:04 +01005821 TEST_EQUAL( actual_status, expected_status );
5822 TEST_EQUAL( output_length, expected_output_length );
Gilles Peskine68428122018-06-30 18:42:41 +02005823 }
5824
Gilles Peskine656896e2018-06-29 19:12:28 +02005825exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +01005826 /*
5827 * Key attributes may have been returned by psa_get_key_attributes()
5828 * thus reset them as required.
5829 */
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02005830 psa_reset_key_attributes( &attributes );
Ronald Cron3a4f0e32020-11-19 17:55:23 +01005831
Ronald Cron5425a212020-08-04 14:58:35 +02005832 psa_destroy_key( key );
Gilles Peskine656896e2018-06-29 19:12:28 +02005833 mbedtls_free( output );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02005834 PSA_DONE( );
Gilles Peskine656896e2018-06-29 19:12:28 +02005835}
5836/* END_CASE */
5837
5838/* BEGIN_CASE */
Gilles Peskine68428122018-06-30 18:42:41 +02005839void asymmetric_encrypt_decrypt( int key_type_arg,
5840 data_t *key_data,
5841 int alg_arg,
5842 data_t *input_data,
5843 data_t *label )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005844{
Ronald Cron5425a212020-08-04 14:58:35 +02005845 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005846 psa_key_type_t key_type = key_type_arg;
5847 psa_algorithm_t alg = alg_arg;
Gilles Peskine55c94dd2018-06-30 18:54:48 +02005848 size_t key_bits;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005849 unsigned char *output = NULL;
Gilles Peskine55c94dd2018-06-30 18:54:48 +02005850 size_t output_size;
5851 size_t output_length = ~0;
Nir Sonnenschein0f3bdbd2018-05-02 23:56:12 +03005852 unsigned char *output2 = NULL;
Gilles Peskine55c94dd2018-06-30 18:54:48 +02005853 size_t output2_size;
5854 size_t output2_length = ~0;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02005855 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005856
Gilles Peskine8817f612018-12-18 00:18:46 +01005857 PSA_ASSERT( psa_crypto_init( ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005858
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02005859 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT | PSA_KEY_USAGE_DECRYPT );
5860 psa_set_key_algorithm( &attributes, alg );
5861 psa_set_key_type( &attributes, key_type );
Nir Sonnenscheind7082602018-06-04 16:45:27 +03005862
Gilles Peskine049c7532019-05-15 20:22:09 +02005863 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02005864 &key ) );
Gilles Peskine55c94dd2018-06-30 18:54:48 +02005865
5866 /* Determine the maximum ciphertext length */
Ronald Cron5425a212020-08-04 14:58:35 +02005867 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02005868 key_bits = psa_get_key_bits( &attributes );
gabor-mezei-armceface22021-01-21 12:26:17 +01005869
Gilles Peskine55c94dd2018-06-30 18:54:48 +02005870 output_size = PSA_ASYMMETRIC_ENCRYPT_OUTPUT_SIZE( key_type, key_bits, alg );
gabor-mezei-armceface22021-01-21 12:26:17 +01005871 TEST_ASSERT( output_size <= PSA_ASYMMETRIC_ENCRYPT_OUTPUT_MAX_SIZE );
Gilles Peskine8cebbba2018-09-27 13:54:18 +02005872 ASSERT_ALLOC( output, output_size );
gabor-mezei-armceface22021-01-21 12:26:17 +01005873
Gilles Peskine55c94dd2018-06-30 18:54:48 +02005874 output2_size = input_data->len;
gabor-mezei-armceface22021-01-21 12:26:17 +01005875 TEST_ASSERT( output2_size <=
5876 PSA_ASYMMETRIC_DECRYPT_OUTPUT_SIZE( key_type, key_bits, alg ) );
5877 TEST_ASSERT( output2_size <= PSA_ASYMMETRIC_DECRYPT_OUTPUT_MAX_SIZE );
Gilles Peskine8cebbba2018-09-27 13:54:18 +02005878 ASSERT_ALLOC( output2, output2_size );
Gilles Peskine55c94dd2018-06-30 18:54:48 +02005879
Gilles Peskineeebd7382018-06-08 18:11:54 +02005880 /* We test encryption by checking that encrypt-then-decrypt gives back
5881 * the original plaintext because of the non-optional random
5882 * part of encryption process which prevents using fixed vectors. */
Ronald Cron5425a212020-08-04 14:58:35 +02005883 PSA_ASSERT( psa_asymmetric_encrypt( key, alg,
Gilles Peskine8817f612018-12-18 00:18:46 +01005884 input_data->x, input_data->len,
5885 label->x, label->len,
5886 output, output_size,
5887 &output_length ) );
Gilles Peskine55c94dd2018-06-30 18:54:48 +02005888 /* We don't know what ciphertext length to expect, but check that
5889 * it looks sensible. */
5890 TEST_ASSERT( output_length <= output_size );
Nir Sonnenschein0f3bdbd2018-05-02 23:56:12 +03005891
Ronald Cron5425a212020-08-04 14:58:35 +02005892 PSA_ASSERT( psa_asymmetric_decrypt( key, alg,
Gilles Peskine8817f612018-12-18 00:18:46 +01005893 output, output_length,
5894 label->x, label->len,
5895 output2, output2_size,
5896 &output2_length ) );
Gilles Peskinebd7dea92018-09-27 13:57:19 +02005897 ASSERT_COMPARE( input_data->x, input_data->len,
5898 output2, output2_length );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005899
5900exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +01005901 /*
5902 * Key attributes may have been returned by psa_get_key_attributes()
5903 * thus reset them as required.
5904 */
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02005905 psa_reset_key_attributes( &attributes );
Ronald Cron3a4f0e32020-11-19 17:55:23 +01005906
Ronald Cron5425a212020-08-04 14:58:35 +02005907 psa_destroy_key( key );
itayzafrir3e02b3b2018-06-12 17:06:52 +03005908 mbedtls_free( output );
5909 mbedtls_free( output2 );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02005910 PSA_DONE( );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005911}
5912/* END_CASE */
5913
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005914/* BEGIN_CASE */
Gilles Peskine68428122018-06-30 18:42:41 +02005915void asymmetric_decrypt( int key_type_arg,
5916 data_t *key_data,
5917 int alg_arg,
5918 data_t *input_data,
5919 data_t *label,
Gilles Peskine66763a02018-06-29 21:54:10 +02005920 data_t *expected_data )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005921{
Ronald Cron5425a212020-08-04 14:58:35 +02005922 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005923 psa_key_type_t key_type = key_type_arg;
5924 psa_algorithm_t alg = alg_arg;
gabor-mezei-armceface22021-01-21 12:26:17 +01005925 size_t key_bits;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005926 unsigned char *output = NULL;
Nir Sonnenscheind70bc482018-06-04 16:31:13 +03005927 size_t output_size = 0;
Gilles Peskine55c94dd2018-06-30 18:54:48 +02005928 size_t output_length = ~0;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02005929 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005930
Gilles Peskine8817f612018-12-18 00:18:46 +01005931 PSA_ASSERT( psa_crypto_init( ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005932
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02005933 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DECRYPT );
5934 psa_set_key_algorithm( &attributes, alg );
5935 psa_set_key_type( &attributes, key_type );
Nir Sonnenscheind7082602018-06-04 16:45:27 +03005936
Gilles Peskine049c7532019-05-15 20:22:09 +02005937 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02005938 &key ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005939
gabor-mezei-armceface22021-01-21 12:26:17 +01005940 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
5941 key_bits = psa_get_key_bits( &attributes );
5942
5943 /* Determine the maximum ciphertext length */
5944 output_size = PSA_ASYMMETRIC_DECRYPT_OUTPUT_SIZE( key_type, key_bits, alg );
5945 TEST_ASSERT( output_size <= PSA_ASYMMETRIC_DECRYPT_OUTPUT_MAX_SIZE );
5946 ASSERT_ALLOC( output, output_size );
5947
Ronald Cron5425a212020-08-04 14:58:35 +02005948 PSA_ASSERT( psa_asymmetric_decrypt( key, alg,
Gilles Peskine8817f612018-12-18 00:18:46 +01005949 input_data->x, input_data->len,
5950 label->x, label->len,
5951 output,
5952 output_size,
5953 &output_length ) );
Gilles Peskinebd7dea92018-09-27 13:57:19 +02005954 ASSERT_COMPARE( expected_data->x, expected_data->len,
5955 output, output_length );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005956
Gilles Peskine68428122018-06-30 18:42:41 +02005957 /* If the label is empty, the test framework puts a non-null pointer
5958 * in label->x. Test that a null pointer works as well. */
5959 if( label->len == 0 )
5960 {
5961 output_length = ~0;
Gilles Peskinef7ab5ad2018-09-26 18:19:24 +02005962 if( output_size != 0 )
5963 memset( output, 0, output_size );
Ronald Cron5425a212020-08-04 14:58:35 +02005964 PSA_ASSERT( psa_asymmetric_decrypt( key, alg,
Gilles Peskine8817f612018-12-18 00:18:46 +01005965 input_data->x, input_data->len,
5966 NULL, label->len,
5967 output,
5968 output_size,
5969 &output_length ) );
Gilles Peskinebd7dea92018-09-27 13:57:19 +02005970 ASSERT_COMPARE( expected_data->x, expected_data->len,
5971 output, output_length );
Gilles Peskine68428122018-06-30 18:42:41 +02005972 }
5973
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005974exit:
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02005975 psa_reset_key_attributes( &attributes );
Ronald Cron5425a212020-08-04 14:58:35 +02005976 psa_destroy_key( key );
itayzafrir3e02b3b2018-06-12 17:06:52 +03005977 mbedtls_free( output );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02005978 PSA_DONE( );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005979}
5980/* END_CASE */
5981
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005982/* BEGIN_CASE */
Gilles Peskine68428122018-06-30 18:42:41 +02005983void asymmetric_decrypt_fail( int key_type_arg,
5984 data_t *key_data,
5985 int alg_arg,
5986 data_t *input_data,
5987 data_t *label,
Jaeden Amerof8daab72019-02-06 12:57:46 +00005988 int output_size_arg,
Gilles Peskine2d277862018-06-18 15:41:12 +02005989 int expected_status_arg )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005990{
Ronald Cron5425a212020-08-04 14:58:35 +02005991 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005992 psa_key_type_t key_type = key_type_arg;
5993 psa_algorithm_t alg = alg_arg;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005994 unsigned char *output = NULL;
Jaeden Amerof8daab72019-02-06 12:57:46 +00005995 size_t output_size = output_size_arg;
Gilles Peskine55c94dd2018-06-30 18:54:48 +02005996 size_t output_length = ~0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005997 psa_status_t actual_status;
5998 psa_status_t expected_status = expected_status_arg;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02005999 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03006000
Gilles Peskine8cebbba2018-09-27 13:54:18 +02006001 ASSERT_ALLOC( output, output_size );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02006002
Gilles Peskine8817f612018-12-18 00:18:46 +01006003 PSA_ASSERT( psa_crypto_init( ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03006004
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02006005 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DECRYPT );
6006 psa_set_key_algorithm( &attributes, alg );
6007 psa_set_key_type( &attributes, key_type );
Nir Sonnenscheind7082602018-06-04 16:45:27 +03006008
Gilles Peskine049c7532019-05-15 20:22:09 +02006009 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02006010 &key ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03006011
Ronald Cron5425a212020-08-04 14:58:35 +02006012 actual_status = psa_asymmetric_decrypt( key, alg,
Gilles Peskine4abf7412018-06-18 16:35:34 +02006013 input_data->x, input_data->len,
Gilles Peskine68428122018-06-30 18:42:41 +02006014 label->x, label->len,
Gilles Peskine4abf7412018-06-18 16:35:34 +02006015 output, output_size,
Gilles Peskine2d277862018-06-18 15:41:12 +02006016 &output_length );
Gilles Peskinefe11b722018-12-18 00:24:04 +01006017 TEST_EQUAL( actual_status, expected_status );
Gilles Peskine55c94dd2018-06-30 18:54:48 +02006018 TEST_ASSERT( output_length <= output_size );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03006019
Gilles Peskine68428122018-06-30 18:42:41 +02006020 /* If the label is empty, the test framework puts a non-null pointer
6021 * in label->x. Test that a null pointer works as well. */
6022 if( label->len == 0 )
6023 {
6024 output_length = ~0;
Gilles Peskinef7ab5ad2018-09-26 18:19:24 +02006025 if( output_size != 0 )
6026 memset( output, 0, output_size );
Ronald Cron5425a212020-08-04 14:58:35 +02006027 actual_status = psa_asymmetric_decrypt( key, alg,
Gilles Peskine68428122018-06-30 18:42:41 +02006028 input_data->x, input_data->len,
6029 NULL, label->len,
6030 output, output_size,
6031 &output_length );
Gilles Peskinefe11b722018-12-18 00:24:04 +01006032 TEST_EQUAL( actual_status, expected_status );
Gilles Peskine55c94dd2018-06-30 18:54:48 +02006033 TEST_ASSERT( output_length <= output_size );
Gilles Peskine68428122018-06-30 18:42:41 +02006034 }
6035
Nir Sonnenschein39e59142018-05-02 23:16:26 +03006036exit:
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02006037 psa_reset_key_attributes( &attributes );
Ronald Cron5425a212020-08-04 14:58:35 +02006038 psa_destroy_key( key );
Gilles Peskine2d277862018-06-18 15:41:12 +02006039 mbedtls_free( output );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02006040 PSA_DONE( );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03006041}
Gilles Peskine5b051bc2018-05-31 13:25:48 +02006042/* END_CASE */
Gilles Peskine05d69892018-06-19 22:00:52 +02006043
6044/* BEGIN_CASE */
Gilles Peskinecbe66502019-05-16 16:59:18 +02006045void key_derivation_init( )
Jaeden Amerod94d6712019-01-04 14:11:48 +00006046{
6047 /* Test each valid way of initializing the object, except for `= {0}`, as
6048 * Clang 5 complains when `-Wmissing-field-initializers` is used, even
6049 * though it's OK by the C standard. We could test for this, but we'd need
6050 * to supress the Clang warning for the test. */
Jaeden Amero5229bbb2019-02-07 16:33:37 +00006051 size_t capacity;
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02006052 psa_key_derivation_operation_t func = psa_key_derivation_operation_init( );
6053 psa_key_derivation_operation_t init = PSA_KEY_DERIVATION_OPERATION_INIT;
6054 psa_key_derivation_operation_t zero;
Jaeden Amerod94d6712019-01-04 14:11:48 +00006055
6056 memset( &zero, 0, sizeof( zero ) );
6057
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006058 /* A default operation should not be able to report its capacity. */
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02006059 TEST_EQUAL( psa_key_derivation_get_capacity( &func, &capacity ),
Jaeden Amerocf2010c2019-02-15 13:05:49 +00006060 PSA_ERROR_BAD_STATE );
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02006061 TEST_EQUAL( psa_key_derivation_get_capacity( &init, &capacity ),
Jaeden Amerocf2010c2019-02-15 13:05:49 +00006062 PSA_ERROR_BAD_STATE );
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02006063 TEST_EQUAL( psa_key_derivation_get_capacity( &zero, &capacity ),
Jaeden Amerocf2010c2019-02-15 13:05:49 +00006064 PSA_ERROR_BAD_STATE );
Jaeden Amero5229bbb2019-02-07 16:33:37 +00006065
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006066 /* A default operation should be abortable without error. */
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02006067 PSA_ASSERT( psa_key_derivation_abort(&func) );
6068 PSA_ASSERT( psa_key_derivation_abort(&init) );
6069 PSA_ASSERT( psa_key_derivation_abort(&zero) );
Jaeden Amerod94d6712019-01-04 14:11:48 +00006070}
6071/* END_CASE */
6072
Janos Follath16de4a42019-06-13 16:32:24 +01006073/* BEGIN_CASE */
6074void derive_setup( int alg_arg, int expected_status_arg )
Gilles Peskineea0fb492018-07-12 17:17:20 +02006075{
Gilles Peskineea0fb492018-07-12 17:17:20 +02006076 psa_algorithm_t alg = alg_arg;
Gilles Peskineea0fb492018-07-12 17:17:20 +02006077 psa_status_t expected_status = expected_status_arg;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006078 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Gilles Peskineea0fb492018-07-12 17:17:20 +02006079
Gilles Peskine8817f612018-12-18 00:18:46 +01006080 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskineea0fb492018-07-12 17:17:20 +02006081
Janos Follath16de4a42019-06-13 16:32:24 +01006082 TEST_EQUAL( psa_key_derivation_setup( &operation, alg ),
Gilles Peskinef812dcf2018-12-18 00:33:25 +01006083 expected_status );
Gilles Peskineea0fb492018-07-12 17:17:20 +02006084
6085exit:
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006086 psa_key_derivation_abort( &operation );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02006087 PSA_DONE( );
Gilles Peskineea0fb492018-07-12 17:17:20 +02006088}
6089/* END_CASE */
6090
Janos Follathaf3c2a02019-06-12 12:34:34 +01006091/* BEGIN_CASE */
Janos Follatha27c9272019-06-14 09:59:36 +01006092void derive_set_capacity( int alg_arg, int capacity_arg,
6093 int expected_status_arg )
6094{
6095 psa_algorithm_t alg = alg_arg;
6096 size_t capacity = capacity_arg;
6097 psa_status_t expected_status = expected_status_arg;
6098 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
6099
6100 PSA_ASSERT( psa_crypto_init( ) );
6101
6102 PSA_ASSERT( psa_key_derivation_setup( &operation, alg ) );
6103
6104 TEST_EQUAL( psa_key_derivation_set_capacity( &operation, capacity ),
6105 expected_status );
6106
6107exit:
6108 psa_key_derivation_abort( &operation );
6109 PSA_DONE( );
6110}
6111/* END_CASE */
6112
6113/* BEGIN_CASE */
Janos Follathaf3c2a02019-06-12 12:34:34 +01006114void derive_input( int alg_arg,
Gilles Peskine6842ba42019-09-23 13:49:33 +02006115 int step_arg1, int key_type_arg1, data_t *input1,
Janos Follathaf3c2a02019-06-12 12:34:34 +01006116 int expected_status_arg1,
Gilles Peskine2058c072019-09-24 17:19:33 +02006117 int step_arg2, int key_type_arg2, data_t *input2,
Janos Follathaf3c2a02019-06-12 12:34:34 +01006118 int expected_status_arg2,
Gilles Peskine2058c072019-09-24 17:19:33 +02006119 int step_arg3, int key_type_arg3, data_t *input3,
Gilles Peskine1a2904c2019-09-24 17:45:07 +02006120 int expected_status_arg3,
6121 int output_key_type_arg, int expected_output_status_arg )
Janos Follathaf3c2a02019-06-12 12:34:34 +01006122{
6123 psa_algorithm_t alg = alg_arg;
Gilles Peskine6842ba42019-09-23 13:49:33 +02006124 psa_key_derivation_step_t steps[] = {step_arg1, step_arg2, step_arg3};
6125 psa_key_type_t key_types[] = {key_type_arg1, key_type_arg2, key_type_arg3};
Janos Follathaf3c2a02019-06-12 12:34:34 +01006126 psa_status_t expected_statuses[] = {expected_status_arg1,
6127 expected_status_arg2,
6128 expected_status_arg3};
6129 data_t *inputs[] = {input1, input2, input3};
Ronald Cron5425a212020-08-04 14:58:35 +02006130 mbedtls_svc_key_id_t keys[] = { MBEDTLS_SVC_KEY_ID_INIT,
6131 MBEDTLS_SVC_KEY_ID_INIT,
6132 MBEDTLS_SVC_KEY_ID_INIT };
Janos Follathaf3c2a02019-06-12 12:34:34 +01006133 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
6134 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
6135 size_t i;
Gilles Peskine1a2904c2019-09-24 17:45:07 +02006136 psa_key_type_t output_key_type = output_key_type_arg;
Ronald Cron5425a212020-08-04 14:58:35 +02006137 mbedtls_svc_key_id_t output_key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine1a2904c2019-09-24 17:45:07 +02006138 psa_status_t expected_output_status = expected_output_status_arg;
6139 psa_status_t actual_output_status;
Janos Follathaf3c2a02019-06-12 12:34:34 +01006140
6141 PSA_ASSERT( psa_crypto_init( ) );
6142
6143 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DERIVE );
6144 psa_set_key_algorithm( &attributes, alg );
Janos Follathaf3c2a02019-06-12 12:34:34 +01006145
6146 PSA_ASSERT( psa_key_derivation_setup( &operation, alg ) );
6147
6148 for( i = 0; i < ARRAY_LENGTH( steps ); i++ )
6149 {
Gilles Peskine4023c012021-05-27 13:21:20 +02006150 mbedtls_test_set_step( i );
6151 if( steps[i] == 0 )
6152 {
6153 /* Skip this step */
6154 }
6155 else if( key_types[i] != PSA_KEY_TYPE_NONE )
Janos Follathaf3c2a02019-06-12 12:34:34 +01006156 {
Gilles Peskine6842ba42019-09-23 13:49:33 +02006157 psa_set_key_type( &attributes, key_types[i] );
6158 PSA_ASSERT( psa_import_key( &attributes,
6159 inputs[i]->x, inputs[i]->len,
Ronald Cron5425a212020-08-04 14:58:35 +02006160 &keys[i] ) );
Steven Cooreman0ee0d522020-10-05 16:03:42 +02006161 if( PSA_KEY_TYPE_IS_KEY_PAIR( key_types[i] ) &&
6162 steps[i] == PSA_KEY_DERIVATION_INPUT_SECRET )
6163 {
6164 // When taking a private key as secret input, use key agreement
6165 // to add the shared secret to the derivation
Gilles Peskinec18e25f2021-02-12 23:48:20 +01006166 TEST_EQUAL( mbedtls_test_psa_key_agreement_with_self(
6167 &operation, keys[i] ),
Steven Cooreman0ee0d522020-10-05 16:03:42 +02006168 expected_statuses[i] );
6169 }
6170 else
6171 {
6172 TEST_EQUAL( psa_key_derivation_input_key( &operation, steps[i],
Ronald Cron5425a212020-08-04 14:58:35 +02006173 keys[i] ),
Steven Cooreman0ee0d522020-10-05 16:03:42 +02006174 expected_statuses[i] );
6175 }
Gilles Peskine6842ba42019-09-23 13:49:33 +02006176 }
6177 else
6178 {
6179 TEST_EQUAL( psa_key_derivation_input_bytes(
6180 &operation, steps[i],
6181 inputs[i]->x, inputs[i]->len ),
6182 expected_statuses[i] );
Janos Follathaf3c2a02019-06-12 12:34:34 +01006183 }
6184 }
6185
Gilles Peskine1a2904c2019-09-24 17:45:07 +02006186 if( output_key_type != PSA_KEY_TYPE_NONE )
6187 {
6188 psa_reset_key_attributes( &attributes );
Dave Rodgman491d8492021-11-16 12:12:49 +00006189 psa_set_key_type( &attributes, output_key_type );
Gilles Peskine1a2904c2019-09-24 17:45:07 +02006190 psa_set_key_bits( &attributes, 8 );
6191 actual_output_status =
6192 psa_key_derivation_output_key( &attributes, &operation,
Ronald Cron5425a212020-08-04 14:58:35 +02006193 &output_key );
Gilles Peskine1a2904c2019-09-24 17:45:07 +02006194 }
6195 else
6196 {
6197 uint8_t buffer[1];
6198 actual_output_status =
6199 psa_key_derivation_output_bytes( &operation,
6200 buffer, sizeof( buffer ) );
6201 }
6202 TEST_EQUAL( actual_output_status, expected_output_status );
6203
Janos Follathaf3c2a02019-06-12 12:34:34 +01006204exit:
6205 psa_key_derivation_abort( &operation );
Ronald Cron5425a212020-08-04 14:58:35 +02006206 for( i = 0; i < ARRAY_LENGTH( keys ); i++ )
6207 psa_destroy_key( keys[i] );
6208 psa_destroy_key( output_key );
Janos Follathaf3c2a02019-06-12 12:34:34 +01006209 PSA_DONE( );
6210}
6211/* END_CASE */
6212
Janos Follathd958bb72019-07-03 15:02:16 +01006213/* BEGIN_CASE */
Gilles Peskine1c77edd2021-05-27 11:55:02 +02006214void derive_over_capacity( int alg_arg )
Nir Sonnenscheine5204c92018-10-22 17:24:55 +03006215{
Janos Follathd958bb72019-07-03 15:02:16 +01006216 psa_algorithm_t alg = alg_arg;
Ronald Cron5425a212020-08-04 14:58:35 +02006217 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Nir Sonnenschein4eda37b2018-10-31 12:15:58 +02006218 size_t key_type = PSA_KEY_TYPE_DERIVE;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006219 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Janos Follathd958bb72019-07-03 15:02:16 +01006220 unsigned char input1[] = "Input 1";
6221 size_t input1_length = sizeof( input1 );
6222 unsigned char input2[] = "Input 2";
6223 size_t input2_length = sizeof( input2 );
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03006224 uint8_t buffer[42];
Nir Sonnenschein1caf6d22018-11-01 12:27:20 +02006225 size_t capacity = sizeof( buffer );
Nir Sonnenscheindd69d8b2018-11-01 12:24:23 +02006226 const uint8_t key_data[22] = { 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b,
6227 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b,
6228 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b};
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02006229 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Nir Sonnenscheine5204c92018-10-22 17:24:55 +03006230
Gilles Peskine8817f612018-12-18 00:18:46 +01006231 PSA_ASSERT( psa_crypto_init( ) );
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03006232
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02006233 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DERIVE );
6234 psa_set_key_algorithm( &attributes, alg );
6235 psa_set_key_type( &attributes, key_type );
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03006236
Gilles Peskine73676cb2019-05-15 20:15:10 +02006237 PSA_ASSERT( psa_import_key( &attributes,
6238 key_data, sizeof( key_data ),
Ronald Cron5425a212020-08-04 14:58:35 +02006239 &key ) );
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03006240
6241 /* valid key derivation */
Gilles Peskinec18e25f2021-02-12 23:48:20 +01006242 if( !mbedtls_test_psa_setup_key_derivation_wrap( &operation, key, alg,
6243 input1, input1_length,
6244 input2, input2_length,
6245 capacity ) )
Janos Follathd958bb72019-07-03 15:02:16 +01006246 goto exit;
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03006247
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006248 /* state of operation shouldn't allow additional generation */
Janos Follathd958bb72019-07-03 15:02:16 +01006249 TEST_EQUAL( psa_key_derivation_setup( &operation, alg ),
Gilles Peskinef812dcf2018-12-18 00:33:25 +01006250 PSA_ERROR_BAD_STATE );
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03006251
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006252 PSA_ASSERT( psa_key_derivation_output_bytes( &operation, buffer, capacity ) );
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03006253
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006254 TEST_EQUAL( psa_key_derivation_output_bytes( &operation, buffer, capacity ),
David Saadab4ecc272019-02-14 13:48:10 +02006255 PSA_ERROR_INSUFFICIENT_DATA );
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03006256
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03006257exit:
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006258 psa_key_derivation_abort( &operation );
Ronald Cron5425a212020-08-04 14:58:35 +02006259 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02006260 PSA_DONE( );
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03006261}
6262/* END_CASE */
6263
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03006264/* BEGIN_CASE */
Gilles Peskine1c77edd2021-05-27 11:55:02 +02006265void derive_actions_without_setup( )
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03006266{
6267 uint8_t output_buffer[16];
6268 size_t buffer_size = 16;
6269 size_t capacity = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006270 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03006271
Gilles Peskinecf7292e2019-05-16 17:53:40 +02006272 TEST_ASSERT( psa_key_derivation_output_bytes( &operation,
6273 output_buffer, buffer_size )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00006274 == PSA_ERROR_BAD_STATE );
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03006275
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006276 TEST_ASSERT( psa_key_derivation_get_capacity( &operation, &capacity )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00006277 == PSA_ERROR_BAD_STATE );
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03006278
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006279 PSA_ASSERT( psa_key_derivation_abort( &operation ) );
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03006280
Gilles Peskinecf7292e2019-05-16 17:53:40 +02006281 TEST_ASSERT( psa_key_derivation_output_bytes( &operation,
6282 output_buffer, buffer_size )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00006283 == PSA_ERROR_BAD_STATE );
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03006284
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006285 TEST_ASSERT( psa_key_derivation_get_capacity( &operation, &capacity )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00006286 == PSA_ERROR_BAD_STATE );
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03006287
6288exit:
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006289 psa_key_derivation_abort( &operation );
Nir Sonnenscheine5204c92018-10-22 17:24:55 +03006290}
6291/* END_CASE */
6292
6293/* BEGIN_CASE */
Gilles Peskine96ee5c72018-07-12 17:24:54 +02006294void derive_output( int alg_arg,
Gilles Peskine1468da72019-05-29 17:35:49 +02006295 int step1_arg, data_t *input1,
6296 int step2_arg, data_t *input2,
6297 int step3_arg, data_t *input3,
Gilles Peskine96ee5c72018-07-12 17:24:54 +02006298 int requested_capacity_arg,
6299 data_t *expected_output1,
6300 data_t *expected_output2 )
6301{
Gilles Peskine96ee5c72018-07-12 17:24:54 +02006302 psa_algorithm_t alg = alg_arg;
Gilles Peskine1468da72019-05-29 17:35:49 +02006303 psa_key_derivation_step_t steps[] = {step1_arg, step2_arg, step3_arg};
6304 data_t *inputs[] = {input1, input2, input3};
Ronald Cron5425a212020-08-04 14:58:35 +02006305 mbedtls_svc_key_id_t keys[] = { MBEDTLS_SVC_KEY_ID_INIT,
6306 MBEDTLS_SVC_KEY_ID_INIT,
6307 MBEDTLS_SVC_KEY_ID_INIT };
Gilles Peskine96ee5c72018-07-12 17:24:54 +02006308 size_t requested_capacity = requested_capacity_arg;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006309 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Gilles Peskine96ee5c72018-07-12 17:24:54 +02006310 uint8_t *expected_outputs[2] =
6311 {expected_output1->x, expected_output2->x};
6312 size_t output_sizes[2] =
6313 {expected_output1->len, expected_output2->len};
6314 size_t output_buffer_size = 0;
6315 uint8_t *output_buffer = NULL;
6316 size_t expected_capacity;
6317 size_t current_capacity;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006318 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine96ee5c72018-07-12 17:24:54 +02006319 psa_status_t status;
Gilles Peskine1468da72019-05-29 17:35:49 +02006320 size_t i;
Gilles Peskine96ee5c72018-07-12 17:24:54 +02006321
6322 for( i = 0; i < ARRAY_LENGTH( expected_outputs ); i++ )
6323 {
6324 if( output_sizes[i] > output_buffer_size )
6325 output_buffer_size = output_sizes[i];
6326 if( output_sizes[i] == 0 )
6327 expected_outputs[i] = NULL;
6328 }
Gilles Peskine8cebbba2018-09-27 13:54:18 +02006329 ASSERT_ALLOC( output_buffer, output_buffer_size );
Gilles Peskine8817f612018-12-18 00:18:46 +01006330 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine96ee5c72018-07-12 17:24:54 +02006331
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006332 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DERIVE );
6333 psa_set_key_algorithm( &attributes, alg );
6334 psa_set_key_type( &attributes, PSA_KEY_TYPE_DERIVE );
Gilles Peskine96ee5c72018-07-12 17:24:54 +02006335
Gilles Peskine96ee5c72018-07-12 17:24:54 +02006336 /* Extraction phase. */
Gilles Peskine1468da72019-05-29 17:35:49 +02006337 PSA_ASSERT( psa_key_derivation_setup( &operation, alg ) );
6338 PSA_ASSERT( psa_key_derivation_set_capacity( &operation,
6339 requested_capacity ) );
6340 for( i = 0; i < ARRAY_LENGTH( steps ); i++ )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006341 {
Gilles Peskine1468da72019-05-29 17:35:49 +02006342 switch( steps[i] )
6343 {
6344 case 0:
6345 break;
6346 case PSA_KEY_DERIVATION_INPUT_SECRET:
6347 PSA_ASSERT( psa_import_key( &attributes,
6348 inputs[i]->x, inputs[i]->len,
Ronald Cron5425a212020-08-04 14:58:35 +02006349 &keys[i] ) );
gabor-mezei-armceface22021-01-21 12:26:17 +01006350
6351 if ( PSA_ALG_IS_TLS12_PSK_TO_MS( alg ) )
6352 {
6353 PSA_ASSERT( psa_get_key_attributes( keys[i], &attributes ) );
6354 TEST_ASSERT( PSA_BITS_TO_BYTES( psa_get_key_bits( &attributes ) ) <=
6355 PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE );
6356 }
6357
Gilles Peskine1468da72019-05-29 17:35:49 +02006358 PSA_ASSERT( psa_key_derivation_input_key(
Ronald Cron5425a212020-08-04 14:58:35 +02006359 &operation, steps[i], keys[i] ) );
Gilles Peskine1468da72019-05-29 17:35:49 +02006360 break;
6361 default:
6362 PSA_ASSERT( psa_key_derivation_input_bytes(
6363 &operation, steps[i],
6364 inputs[i]->x, inputs[i]->len ) );
6365 break;
6366 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006367 }
Gilles Peskine1468da72019-05-29 17:35:49 +02006368
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006369 PSA_ASSERT( psa_key_derivation_get_capacity( &operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02006370 &current_capacity ) );
Gilles Peskinefe11b722018-12-18 00:24:04 +01006371 TEST_EQUAL( current_capacity, requested_capacity );
Gilles Peskine96ee5c72018-07-12 17:24:54 +02006372 expected_capacity = requested_capacity;
6373
6374 /* Expansion phase. */
6375 for( i = 0; i < ARRAY_LENGTH( expected_outputs ); i++ )
6376 {
6377 /* Read some bytes. */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006378 status = psa_key_derivation_output_bytes( &operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02006379 output_buffer, output_sizes[i] );
Gilles Peskine96ee5c72018-07-12 17:24:54 +02006380 if( expected_capacity == 0 && output_sizes[i] == 0 )
6381 {
6382 /* Reading 0 bytes when 0 bytes are available can go either way. */
6383 TEST_ASSERT( status == PSA_SUCCESS ||
David Saadab4ecc272019-02-14 13:48:10 +02006384 status == PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskine96ee5c72018-07-12 17:24:54 +02006385 continue;
6386 }
6387 else if( expected_capacity == 0 ||
6388 output_sizes[i] > expected_capacity )
6389 {
6390 /* Capacity exceeded. */
David Saadab4ecc272019-02-14 13:48:10 +02006391 TEST_EQUAL( status, PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskine96ee5c72018-07-12 17:24:54 +02006392 expected_capacity = 0;
6393 continue;
6394 }
6395 /* Success. Check the read data. */
Gilles Peskine8817f612018-12-18 00:18:46 +01006396 PSA_ASSERT( status );
Gilles Peskine96ee5c72018-07-12 17:24:54 +02006397 if( output_sizes[i] != 0 )
Gilles Peskine0dfba2d2018-12-18 00:40:50 +01006398 ASSERT_COMPARE( output_buffer, output_sizes[i],
6399 expected_outputs[i], output_sizes[i] );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006400 /* Check the operation status. */
Gilles Peskine96ee5c72018-07-12 17:24:54 +02006401 expected_capacity -= output_sizes[i];
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006402 PSA_ASSERT( psa_key_derivation_get_capacity( &operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02006403 &current_capacity ) );
Gilles Peskinefe11b722018-12-18 00:24:04 +01006404 TEST_EQUAL( expected_capacity, current_capacity );
Gilles Peskine96ee5c72018-07-12 17:24:54 +02006405 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006406 PSA_ASSERT( psa_key_derivation_abort( &operation ) );
Gilles Peskine96ee5c72018-07-12 17:24:54 +02006407
6408exit:
6409 mbedtls_free( output_buffer );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006410 psa_key_derivation_abort( &operation );
Ronald Cron5425a212020-08-04 14:58:35 +02006411 for( i = 0; i < ARRAY_LENGTH( keys ); i++ )
6412 psa_destroy_key( keys[i] );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02006413 PSA_DONE( );
Gilles Peskine96ee5c72018-07-12 17:24:54 +02006414}
6415/* END_CASE */
6416
6417/* BEGIN_CASE */
Gilles Peskined54931c2018-07-17 21:06:59 +02006418void derive_full( int alg_arg,
6419 data_t *key_data,
Janos Follath47f27ed2019-06-25 13:24:52 +01006420 data_t *input1,
6421 data_t *input2,
Gilles Peskined54931c2018-07-17 21:06:59 +02006422 int requested_capacity_arg )
6423{
Ronald Cron5425a212020-08-04 14:58:35 +02006424 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined54931c2018-07-17 21:06:59 +02006425 psa_algorithm_t alg = alg_arg;
6426 size_t requested_capacity = requested_capacity_arg;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006427 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Gilles Peskined54931c2018-07-17 21:06:59 +02006428 unsigned char output_buffer[16];
6429 size_t expected_capacity = requested_capacity;
6430 size_t current_capacity;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006431 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskined54931c2018-07-17 21:06:59 +02006432
Gilles Peskine8817f612018-12-18 00:18:46 +01006433 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskined54931c2018-07-17 21:06:59 +02006434
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006435 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DERIVE );
6436 psa_set_key_algorithm( &attributes, alg );
6437 psa_set_key_type( &attributes, PSA_KEY_TYPE_DERIVE );
Gilles Peskined54931c2018-07-17 21:06:59 +02006438
Gilles Peskine049c7532019-05-15 20:22:09 +02006439 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02006440 &key ) );
Gilles Peskined54931c2018-07-17 21:06:59 +02006441
Gilles Peskinec18e25f2021-02-12 23:48:20 +01006442 if( !mbedtls_test_psa_setup_key_derivation_wrap( &operation, key, alg,
6443 input1->x, input1->len,
6444 input2->x, input2->len,
6445 requested_capacity ) )
Janos Follathf2815ea2019-07-03 12:41:36 +01006446 goto exit;
Janos Follath47f27ed2019-06-25 13:24:52 +01006447
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006448 PSA_ASSERT( psa_key_derivation_get_capacity( &operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02006449 &current_capacity ) );
Gilles Peskinefe11b722018-12-18 00:24:04 +01006450 TEST_EQUAL( current_capacity, expected_capacity );
Gilles Peskined54931c2018-07-17 21:06:59 +02006451
6452 /* Expansion phase. */
6453 while( current_capacity > 0 )
6454 {
6455 size_t read_size = sizeof( output_buffer );
6456 if( read_size > current_capacity )
6457 read_size = current_capacity;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006458 PSA_ASSERT( psa_key_derivation_output_bytes( &operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02006459 output_buffer,
6460 read_size ) );
Gilles Peskined54931c2018-07-17 21:06:59 +02006461 expected_capacity -= read_size;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006462 PSA_ASSERT( psa_key_derivation_get_capacity( &operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02006463 &current_capacity ) );
Gilles Peskinefe11b722018-12-18 00:24:04 +01006464 TEST_EQUAL( current_capacity, expected_capacity );
Gilles Peskined54931c2018-07-17 21:06:59 +02006465 }
6466
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006467 /* Check that the operation refuses to go over capacity. */
6468 TEST_EQUAL( psa_key_derivation_output_bytes( &operation, output_buffer, 1 ),
David Saadab4ecc272019-02-14 13:48:10 +02006469 PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskined54931c2018-07-17 21:06:59 +02006470
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006471 PSA_ASSERT( psa_key_derivation_abort( &operation ) );
Gilles Peskined54931c2018-07-17 21:06:59 +02006472
6473exit:
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006474 psa_key_derivation_abort( &operation );
Ronald Cron5425a212020-08-04 14:58:35 +02006475 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02006476 PSA_DONE( );
Gilles Peskined54931c2018-07-17 21:06:59 +02006477}
6478/* END_CASE */
6479
Janos Follathe60c9052019-07-03 13:51:30 +01006480/* BEGIN_CASE */
Gilles Peskine0386fba2018-07-12 17:29:22 +02006481void derive_key_exercise( int alg_arg,
6482 data_t *key_data,
Janos Follathe60c9052019-07-03 13:51:30 +01006483 data_t *input1,
6484 data_t *input2,
Gilles Peskine0386fba2018-07-12 17:29:22 +02006485 int derived_type_arg,
6486 int derived_bits_arg,
6487 int derived_usage_arg,
6488 int derived_alg_arg )
6489{
Ronald Cron5425a212020-08-04 14:58:35 +02006490 mbedtls_svc_key_id_t base_key = MBEDTLS_SVC_KEY_ID_INIT;
6491 mbedtls_svc_key_id_t derived_key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine0386fba2018-07-12 17:29:22 +02006492 psa_algorithm_t alg = alg_arg;
6493 psa_key_type_t derived_type = derived_type_arg;
6494 size_t derived_bits = derived_bits_arg;
6495 psa_key_usage_t derived_usage = derived_usage_arg;
6496 psa_algorithm_t derived_alg = derived_alg_arg;
6497 size_t capacity = PSA_BITS_TO_BYTES( derived_bits );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006498 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006499 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02006500 psa_key_attributes_t got_attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine0386fba2018-07-12 17:29:22 +02006501
Gilles Peskine8817f612018-12-18 00:18:46 +01006502 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine0386fba2018-07-12 17:29:22 +02006503
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006504 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DERIVE );
6505 psa_set_key_algorithm( &attributes, alg );
6506 psa_set_key_type( &attributes, PSA_KEY_TYPE_DERIVE );
Gilles Peskine049c7532019-05-15 20:22:09 +02006507 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02006508 &base_key ) );
Gilles Peskine0386fba2018-07-12 17:29:22 +02006509
6510 /* Derive a key. */
Gilles Peskinec18e25f2021-02-12 23:48:20 +01006511 if ( mbedtls_test_psa_setup_key_derivation_wrap( &operation, base_key, alg,
6512 input1->x, input1->len,
6513 input2->x, input2->len,
6514 capacity ) )
Janos Follathe60c9052019-07-03 13:51:30 +01006515 goto exit;
6516
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006517 psa_set_key_usage_flags( &attributes, derived_usage );
6518 psa_set_key_algorithm( &attributes, derived_alg );
6519 psa_set_key_type( &attributes, derived_type );
Gilles Peskine3a4f1f82019-04-26 13:49:28 +02006520 psa_set_key_bits( &attributes, derived_bits );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006521 PSA_ASSERT( psa_key_derivation_output_key( &attributes, &operation,
Ronald Cron5425a212020-08-04 14:58:35 +02006522 &derived_key ) );
Gilles Peskine0386fba2018-07-12 17:29:22 +02006523
6524 /* Test the key information */
Ronald Cron5425a212020-08-04 14:58:35 +02006525 PSA_ASSERT( psa_get_key_attributes( derived_key, &got_attributes ) );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02006526 TEST_EQUAL( psa_get_key_type( &got_attributes ), derived_type );
6527 TEST_EQUAL( psa_get_key_bits( &got_attributes ), derived_bits );
Gilles Peskine0386fba2018-07-12 17:29:22 +02006528
6529 /* Exercise the derived key. */
Gilles Peskinec18e25f2021-02-12 23:48:20 +01006530 if( ! mbedtls_test_psa_exercise_key( derived_key, derived_usage, derived_alg ) )
Gilles Peskine0386fba2018-07-12 17:29:22 +02006531 goto exit;
6532
6533exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +01006534 /*
6535 * Key attributes may have been returned by psa_get_key_attributes()
6536 * thus reset them as required.
6537 */
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02006538 psa_reset_key_attributes( &got_attributes );
Ronald Cron3a4f0e32020-11-19 17:55:23 +01006539
6540 psa_key_derivation_abort( &operation );
Ronald Cron5425a212020-08-04 14:58:35 +02006541 psa_destroy_key( base_key );
6542 psa_destroy_key( derived_key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02006543 PSA_DONE( );
Gilles Peskine0386fba2018-07-12 17:29:22 +02006544}
6545/* END_CASE */
6546
Janos Follath42fd8882019-07-03 14:17:09 +01006547/* BEGIN_CASE */
Gilles Peskine0386fba2018-07-12 17:29:22 +02006548void derive_key_export( int alg_arg,
6549 data_t *key_data,
Janos Follath42fd8882019-07-03 14:17:09 +01006550 data_t *input1,
6551 data_t *input2,
Gilles Peskine0386fba2018-07-12 17:29:22 +02006552 int bytes1_arg,
6553 int bytes2_arg )
6554{
Ronald Cron5425a212020-08-04 14:58:35 +02006555 mbedtls_svc_key_id_t base_key = MBEDTLS_SVC_KEY_ID_INIT;
6556 mbedtls_svc_key_id_t derived_key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine0386fba2018-07-12 17:29:22 +02006557 psa_algorithm_t alg = alg_arg;
6558 size_t bytes1 = bytes1_arg;
6559 size_t bytes2 = bytes2_arg;
6560 size_t capacity = bytes1 + bytes2;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006561 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Gilles Peskine8cebbba2018-09-27 13:54:18 +02006562 uint8_t *output_buffer = NULL;
6563 uint8_t *export_buffer = NULL;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006564 psa_key_attributes_t base_attributes = PSA_KEY_ATTRIBUTES_INIT;
6565 psa_key_attributes_t derived_attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine0386fba2018-07-12 17:29:22 +02006566 size_t length;
6567
Gilles Peskine8cebbba2018-09-27 13:54:18 +02006568 ASSERT_ALLOC( output_buffer, capacity );
6569 ASSERT_ALLOC( export_buffer, capacity );
Gilles Peskine8817f612018-12-18 00:18:46 +01006570 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine0386fba2018-07-12 17:29:22 +02006571
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006572 psa_set_key_usage_flags( &base_attributes, PSA_KEY_USAGE_DERIVE );
6573 psa_set_key_algorithm( &base_attributes, alg );
6574 psa_set_key_type( &base_attributes, PSA_KEY_TYPE_DERIVE );
Gilles Peskine049c7532019-05-15 20:22:09 +02006575 PSA_ASSERT( psa_import_key( &base_attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02006576 &base_key ) );
Gilles Peskine0386fba2018-07-12 17:29:22 +02006577
6578 /* Derive some material and output it. */
Gilles Peskinec18e25f2021-02-12 23:48:20 +01006579 if( !mbedtls_test_psa_setup_key_derivation_wrap( &operation, base_key, alg,
6580 input1->x, input1->len,
6581 input2->x, input2->len,
6582 capacity ) )
Janos Follath42fd8882019-07-03 14:17:09 +01006583 goto exit;
6584
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006585 PSA_ASSERT( psa_key_derivation_output_bytes( &operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02006586 output_buffer,
6587 capacity ) );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006588 PSA_ASSERT( psa_key_derivation_abort( &operation ) );
Gilles Peskine0386fba2018-07-12 17:29:22 +02006589
6590 /* Derive the same output again, but this time store it in key objects. */
Gilles Peskinec18e25f2021-02-12 23:48:20 +01006591 if( !mbedtls_test_psa_setup_key_derivation_wrap( &operation, base_key, alg,
6592 input1->x, input1->len,
6593 input2->x, input2->len,
6594 capacity ) )
Janos Follath42fd8882019-07-03 14:17:09 +01006595 goto exit;
6596
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006597 psa_set_key_usage_flags( &derived_attributes, PSA_KEY_USAGE_EXPORT );
6598 psa_set_key_algorithm( &derived_attributes, 0 );
6599 psa_set_key_type( &derived_attributes, PSA_KEY_TYPE_RAW_DATA );
Gilles Peskine3a4f1f82019-04-26 13:49:28 +02006600 psa_set_key_bits( &derived_attributes, PSA_BYTES_TO_BITS( bytes1 ) );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006601 PSA_ASSERT( psa_key_derivation_output_key( &derived_attributes, &operation,
Ronald Cron5425a212020-08-04 14:58:35 +02006602 &derived_key ) );
6603 PSA_ASSERT( psa_export_key( derived_key,
Gilles Peskine8817f612018-12-18 00:18:46 +01006604 export_buffer, bytes1,
6605 &length ) );
Gilles Peskinefe11b722018-12-18 00:24:04 +01006606 TEST_EQUAL( length, bytes1 );
Ronald Cron5425a212020-08-04 14:58:35 +02006607 PSA_ASSERT( psa_destroy_key( derived_key ) );
Gilles Peskine3a4f1f82019-04-26 13:49:28 +02006608 psa_set_key_bits( &derived_attributes, PSA_BYTES_TO_BITS( bytes2 ) );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006609 PSA_ASSERT( psa_key_derivation_output_key( &derived_attributes, &operation,
Ronald Cron5425a212020-08-04 14:58:35 +02006610 &derived_key ) );
6611 PSA_ASSERT( psa_export_key( derived_key,
Gilles Peskine8817f612018-12-18 00:18:46 +01006612 export_buffer + bytes1, bytes2,
6613 &length ) );
Gilles Peskinefe11b722018-12-18 00:24:04 +01006614 TEST_EQUAL( length, bytes2 );
Gilles Peskine0386fba2018-07-12 17:29:22 +02006615
6616 /* Compare the outputs from the two runs. */
Gilles Peskine0dfba2d2018-12-18 00:40:50 +01006617 ASSERT_COMPARE( output_buffer, bytes1 + bytes2,
6618 export_buffer, capacity );
Gilles Peskine0386fba2018-07-12 17:29:22 +02006619
6620exit:
6621 mbedtls_free( output_buffer );
6622 mbedtls_free( export_buffer );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006623 psa_key_derivation_abort( &operation );
Ronald Cron5425a212020-08-04 14:58:35 +02006624 psa_destroy_key( base_key );
6625 psa_destroy_key( derived_key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02006626 PSA_DONE( );
Gilles Peskine0386fba2018-07-12 17:29:22 +02006627}
6628/* END_CASE */
6629
6630/* BEGIN_CASE */
Gilles Peskine7c227ae2019-07-31 15:14:44 +02006631void derive_key( int alg_arg,
6632 data_t *key_data, data_t *input1, data_t *input2,
6633 int type_arg, int bits_arg,
Steven Cooreman83fdb702021-01-21 14:24:39 +01006634 int expected_status_arg,
6635 int is_large_output )
Gilles Peskinec744d992019-07-30 17:26:54 +02006636{
Ronald Cron5425a212020-08-04 14:58:35 +02006637 mbedtls_svc_key_id_t base_key = MBEDTLS_SVC_KEY_ID_INIT;
6638 mbedtls_svc_key_id_t derived_key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskinec744d992019-07-30 17:26:54 +02006639 psa_algorithm_t alg = alg_arg;
Gilles Peskine7c227ae2019-07-31 15:14:44 +02006640 psa_key_type_t type = type_arg;
Gilles Peskinec744d992019-07-30 17:26:54 +02006641 size_t bits = bits_arg;
6642 psa_status_t expected_status = expected_status_arg;
6643 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
6644 psa_key_attributes_t base_attributes = PSA_KEY_ATTRIBUTES_INIT;
6645 psa_key_attributes_t derived_attributes = PSA_KEY_ATTRIBUTES_INIT;
6646
6647 PSA_ASSERT( psa_crypto_init( ) );
6648
6649 psa_set_key_usage_flags( &base_attributes, PSA_KEY_USAGE_DERIVE );
6650 psa_set_key_algorithm( &base_attributes, alg );
6651 psa_set_key_type( &base_attributes, PSA_KEY_TYPE_DERIVE );
6652 PSA_ASSERT( psa_import_key( &base_attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02006653 &base_key ) );
Gilles Peskinec744d992019-07-30 17:26:54 +02006654
Gilles Peskinec18e25f2021-02-12 23:48:20 +01006655 if( !mbedtls_test_psa_setup_key_derivation_wrap( &operation, base_key, alg,
6656 input1->x, input1->len,
6657 input2->x, input2->len,
6658 SIZE_MAX ) )
Gilles Peskinec744d992019-07-30 17:26:54 +02006659 goto exit;
6660
6661 psa_set_key_usage_flags( &derived_attributes, PSA_KEY_USAGE_EXPORT );
6662 psa_set_key_algorithm( &derived_attributes, 0 );
Gilles Peskine7c227ae2019-07-31 15:14:44 +02006663 psa_set_key_type( &derived_attributes, type );
Gilles Peskinec744d992019-07-30 17:26:54 +02006664 psa_set_key_bits( &derived_attributes, bits );
Steven Cooreman83fdb702021-01-21 14:24:39 +01006665
6666 psa_status_t status =
6667 psa_key_derivation_output_key( &derived_attributes,
6668 &operation,
6669 &derived_key );
6670 if( is_large_output > 0 )
6671 TEST_ASSUME( status != PSA_ERROR_INSUFFICIENT_MEMORY );
6672 TEST_EQUAL( status, expected_status );
Gilles Peskinec744d992019-07-30 17:26:54 +02006673
6674exit:
6675 psa_key_derivation_abort( &operation );
Ronald Cron5425a212020-08-04 14:58:35 +02006676 psa_destroy_key( base_key );
6677 psa_destroy_key( derived_key );
Gilles Peskinec744d992019-07-30 17:26:54 +02006678 PSA_DONE( );
6679}
6680/* END_CASE */
6681
6682/* BEGIN_CASE */
Gilles Peskine01d718c2018-09-18 12:01:02 +02006683void key_agreement_setup( int alg_arg,
Steven Cooremance48e852020-10-05 16:02:45 +02006684 int our_key_type_arg, int our_key_alg_arg,
6685 data_t *our_key_data, data_t *peer_key_data,
Gilles Peskine01d718c2018-09-18 12:01:02 +02006686 int expected_status_arg )
6687{
Ronald Cron5425a212020-08-04 14:58:35 +02006688 mbedtls_svc_key_id_t our_key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine01d718c2018-09-18 12:01:02 +02006689 psa_algorithm_t alg = alg_arg;
Steven Cooremanfa5e6312020-10-15 17:07:12 +02006690 psa_algorithm_t our_key_alg = our_key_alg_arg;
Gilles Peskine01d718c2018-09-18 12:01:02 +02006691 psa_key_type_t our_key_type = our_key_type_arg;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006692 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006693 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine77f40d82019-04-11 21:27:06 +02006694 psa_status_t expected_status = expected_status_arg;
6695 psa_status_t status;
Gilles Peskine01d718c2018-09-18 12:01:02 +02006696
Gilles Peskine8817f612018-12-18 00:18:46 +01006697 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine01d718c2018-09-18 12:01:02 +02006698
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006699 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DERIVE );
Steven Cooremanfa5e6312020-10-15 17:07:12 +02006700 psa_set_key_algorithm( &attributes, our_key_alg );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006701 psa_set_key_type( &attributes, our_key_type );
Gilles Peskine049c7532019-05-15 20:22:09 +02006702 PSA_ASSERT( psa_import_key( &attributes,
6703 our_key_data->x, our_key_data->len,
6704 &our_key ) );
Gilles Peskine01d718c2018-09-18 12:01:02 +02006705
Gilles Peskine77f40d82019-04-11 21:27:06 +02006706 /* The tests currently include inputs that should fail at either step.
6707 * Test cases that fail at the setup step should be changed to call
6708 * key_derivation_setup instead, and this function should be renamed
6709 * to key_agreement_fail. */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006710 status = psa_key_derivation_setup( &operation, alg );
Gilles Peskine77f40d82019-04-11 21:27:06 +02006711 if( status == PSA_SUCCESS )
6712 {
Gilles Peskinecf7292e2019-05-16 17:53:40 +02006713 TEST_EQUAL( psa_key_derivation_key_agreement(
6714 &operation, PSA_KEY_DERIVATION_INPUT_SECRET,
6715 our_key,
6716 peer_key_data->x, peer_key_data->len ),
Gilles Peskine77f40d82019-04-11 21:27:06 +02006717 expected_status );
6718 }
6719 else
6720 {
6721 TEST_ASSERT( status == expected_status );
6722 }
Gilles Peskine01d718c2018-09-18 12:01:02 +02006723
6724exit:
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006725 psa_key_derivation_abort( &operation );
Gilles Peskine01d718c2018-09-18 12:01:02 +02006726 psa_destroy_key( our_key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02006727 PSA_DONE( );
Gilles Peskine01d718c2018-09-18 12:01:02 +02006728}
6729/* END_CASE */
6730
6731/* BEGIN_CASE */
Gilles Peskinef0cba732019-04-11 22:12:38 +02006732void raw_key_agreement( int alg_arg,
6733 int our_key_type_arg, data_t *our_key_data,
6734 data_t *peer_key_data,
6735 data_t *expected_output )
6736{
Ronald Cron5425a212020-08-04 14:58:35 +02006737 mbedtls_svc_key_id_t our_key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskinef0cba732019-04-11 22:12:38 +02006738 psa_algorithm_t alg = alg_arg;
6739 psa_key_type_t our_key_type = our_key_type_arg;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006740 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskinef0cba732019-04-11 22:12:38 +02006741 unsigned char *output = NULL;
6742 size_t output_length = ~0;
gabor-mezei-armceface22021-01-21 12:26:17 +01006743 size_t key_bits;
Gilles Peskinef0cba732019-04-11 22:12:38 +02006744
6745 ASSERT_ALLOC( output, expected_output->len );
6746 PSA_ASSERT( psa_crypto_init( ) );
6747
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006748 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DERIVE );
6749 psa_set_key_algorithm( &attributes, alg );
6750 psa_set_key_type( &attributes, our_key_type );
Gilles Peskine049c7532019-05-15 20:22:09 +02006751 PSA_ASSERT( psa_import_key( &attributes,
6752 our_key_data->x, our_key_data->len,
6753 &our_key ) );
Gilles Peskinef0cba732019-04-11 22:12:38 +02006754
gabor-mezei-armceface22021-01-21 12:26:17 +01006755 PSA_ASSERT( psa_get_key_attributes( our_key, &attributes ) );
6756 key_bits = psa_get_key_bits( &attributes );
6757
Gilles Peskinebe697d82019-05-16 18:00:41 +02006758 PSA_ASSERT( psa_raw_key_agreement( alg, our_key,
6759 peer_key_data->x, peer_key_data->len,
6760 output, expected_output->len,
6761 &output_length ) );
Gilles Peskinef0cba732019-04-11 22:12:38 +02006762 ASSERT_COMPARE( output, output_length,
6763 expected_output->x, expected_output->len );
gabor-mezei-armceface22021-01-21 12:26:17 +01006764 TEST_ASSERT( output_length <=
6765 PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE( our_key_type, key_bits ) );
6766 TEST_ASSERT( output_length <=
6767 PSA_RAW_KEY_AGREEMENT_OUTPUT_MAX_SIZE );
Gilles Peskinef0cba732019-04-11 22:12:38 +02006768
6769exit:
6770 mbedtls_free( output );
6771 psa_destroy_key( our_key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02006772 PSA_DONE( );
Gilles Peskinef0cba732019-04-11 22:12:38 +02006773}
6774/* END_CASE */
6775
6776/* BEGIN_CASE */
Gilles Peskine59685592018-09-18 12:11:34 +02006777void key_agreement_capacity( int alg_arg,
6778 int our_key_type_arg, data_t *our_key_data,
6779 data_t *peer_key_data,
6780 int expected_capacity_arg )
6781{
Ronald Cron5425a212020-08-04 14:58:35 +02006782 mbedtls_svc_key_id_t our_key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine59685592018-09-18 12:11:34 +02006783 psa_algorithm_t alg = alg_arg;
6784 psa_key_type_t our_key_type = our_key_type_arg;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006785 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006786 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine59685592018-09-18 12:11:34 +02006787 size_t actual_capacity;
Gilles Peskinebf491972018-10-25 22:36:12 +02006788 unsigned char output[16];
Gilles Peskine59685592018-09-18 12:11:34 +02006789
Gilles Peskine8817f612018-12-18 00:18:46 +01006790 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine59685592018-09-18 12:11:34 +02006791
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006792 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DERIVE );
6793 psa_set_key_algorithm( &attributes, alg );
6794 psa_set_key_type( &attributes, our_key_type );
Gilles Peskine049c7532019-05-15 20:22:09 +02006795 PSA_ASSERT( psa_import_key( &attributes,
6796 our_key_data->x, our_key_data->len,
6797 &our_key ) );
Gilles Peskine59685592018-09-18 12:11:34 +02006798
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006799 PSA_ASSERT( psa_key_derivation_setup( &operation, alg ) );
Gilles Peskinecf7292e2019-05-16 17:53:40 +02006800 PSA_ASSERT( psa_key_derivation_key_agreement(
6801 &operation,
6802 PSA_KEY_DERIVATION_INPUT_SECRET, our_key,
6803 peer_key_data->x, peer_key_data->len ) );
Gilles Peskinef8a9d942019-04-11 22:13:20 +02006804 if( PSA_ALG_IS_HKDF( PSA_ALG_KEY_AGREEMENT_GET_KDF( alg ) ) )
6805 {
6806 /* The test data is for info="" */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006807 PSA_ASSERT( psa_key_derivation_input_bytes( &operation,
Gilles Peskine03410b52019-05-16 16:05:19 +02006808 PSA_KEY_DERIVATION_INPUT_INFO,
Gilles Peskinef8a9d942019-04-11 22:13:20 +02006809 NULL, 0 ) );
6810 }
Gilles Peskine59685592018-09-18 12:11:34 +02006811
Gilles Peskinebf491972018-10-25 22:36:12 +02006812 /* Test the advertized capacity. */
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02006813 PSA_ASSERT( psa_key_derivation_get_capacity(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006814 &operation, &actual_capacity ) );
Gilles Peskinefe11b722018-12-18 00:24:04 +01006815 TEST_EQUAL( actual_capacity, (size_t) expected_capacity_arg );
Gilles Peskine59685592018-09-18 12:11:34 +02006816
Gilles Peskinebf491972018-10-25 22:36:12 +02006817 /* Test the actual capacity by reading the output. */
6818 while( actual_capacity > sizeof( output ) )
6819 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006820 PSA_ASSERT( psa_key_derivation_output_bytes( &operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02006821 output, sizeof( output ) ) );
Gilles Peskinebf491972018-10-25 22:36:12 +02006822 actual_capacity -= sizeof( output );
6823 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006824 PSA_ASSERT( psa_key_derivation_output_bytes( &operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02006825 output, actual_capacity ) );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006826 TEST_EQUAL( psa_key_derivation_output_bytes( &operation, output, 1 ),
David Saadab4ecc272019-02-14 13:48:10 +02006827 PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskinebf491972018-10-25 22:36:12 +02006828
Gilles Peskine59685592018-09-18 12:11:34 +02006829exit:
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006830 psa_key_derivation_abort( &operation );
Gilles Peskine59685592018-09-18 12:11:34 +02006831 psa_destroy_key( our_key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02006832 PSA_DONE( );
Gilles Peskine59685592018-09-18 12:11:34 +02006833}
6834/* END_CASE */
6835
6836/* BEGIN_CASE */
6837void key_agreement_output( int alg_arg,
6838 int our_key_type_arg, data_t *our_key_data,
6839 data_t *peer_key_data,
Gilles Peskine3ec8ed82018-10-25 22:37:15 +02006840 data_t *expected_output1, data_t *expected_output2 )
Gilles Peskine59685592018-09-18 12:11:34 +02006841{
Ronald Cron5425a212020-08-04 14:58:35 +02006842 mbedtls_svc_key_id_t our_key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine59685592018-09-18 12:11:34 +02006843 psa_algorithm_t alg = alg_arg;
6844 psa_key_type_t our_key_type = our_key_type_arg;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006845 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006846 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine3ec8ed82018-10-25 22:37:15 +02006847 uint8_t *actual_output = NULL;
Gilles Peskine59685592018-09-18 12:11:34 +02006848
Gilles Peskine3ec8ed82018-10-25 22:37:15 +02006849 ASSERT_ALLOC( actual_output, MAX( expected_output1->len,
6850 expected_output2->len ) );
Gilles Peskine59685592018-09-18 12:11:34 +02006851
Gilles Peskine8817f612018-12-18 00:18:46 +01006852 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine59685592018-09-18 12:11:34 +02006853
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006854 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DERIVE );
6855 psa_set_key_algorithm( &attributes, alg );
6856 psa_set_key_type( &attributes, our_key_type );
Gilles Peskine049c7532019-05-15 20:22:09 +02006857 PSA_ASSERT( psa_import_key( &attributes,
6858 our_key_data->x, our_key_data->len,
6859 &our_key ) );
Gilles Peskine59685592018-09-18 12:11:34 +02006860
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006861 PSA_ASSERT( psa_key_derivation_setup( &operation, alg ) );
Gilles Peskinecf7292e2019-05-16 17:53:40 +02006862 PSA_ASSERT( psa_key_derivation_key_agreement(
6863 &operation,
6864 PSA_KEY_DERIVATION_INPUT_SECRET, our_key,
6865 peer_key_data->x, peer_key_data->len ) );
Gilles Peskinef8a9d942019-04-11 22:13:20 +02006866 if( PSA_ALG_IS_HKDF( PSA_ALG_KEY_AGREEMENT_GET_KDF( alg ) ) )
6867 {
6868 /* The test data is for info="" */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006869 PSA_ASSERT( psa_key_derivation_input_bytes( &operation,
Gilles Peskine03410b52019-05-16 16:05:19 +02006870 PSA_KEY_DERIVATION_INPUT_INFO,
Gilles Peskinef8a9d942019-04-11 22:13:20 +02006871 NULL, 0 ) );
6872 }
Gilles Peskine59685592018-09-18 12:11:34 +02006873
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006874 PSA_ASSERT( psa_key_derivation_output_bytes( &operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02006875 actual_output,
6876 expected_output1->len ) );
Gilles Peskine0dfba2d2018-12-18 00:40:50 +01006877 ASSERT_COMPARE( actual_output, expected_output1->len,
6878 expected_output1->x, expected_output1->len );
Gilles Peskine3ec8ed82018-10-25 22:37:15 +02006879 if( expected_output2->len != 0 )
6880 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006881 PSA_ASSERT( psa_key_derivation_output_bytes( &operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02006882 actual_output,
6883 expected_output2->len ) );
Gilles Peskine0dfba2d2018-12-18 00:40:50 +01006884 ASSERT_COMPARE( actual_output, expected_output2->len,
6885 expected_output2->x, expected_output2->len );
Gilles Peskine3ec8ed82018-10-25 22:37:15 +02006886 }
Gilles Peskine59685592018-09-18 12:11:34 +02006887
6888exit:
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006889 psa_key_derivation_abort( &operation );
Gilles Peskine59685592018-09-18 12:11:34 +02006890 psa_destroy_key( our_key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02006891 PSA_DONE( );
Gilles Peskine59685592018-09-18 12:11:34 +02006892 mbedtls_free( actual_output );
6893}
6894/* END_CASE */
6895
6896/* BEGIN_CASE */
Gilles Peskinea50d7392018-06-21 10:22:13 +02006897void generate_random( int bytes_arg )
Gilles Peskine05d69892018-06-19 22:00:52 +02006898{
Gilles Peskinea50d7392018-06-21 10:22:13 +02006899 size_t bytes = bytes_arg;
Gilles Peskine8cebbba2018-09-27 13:54:18 +02006900 unsigned char *output = NULL;
6901 unsigned char *changed = NULL;
Gilles Peskinea50d7392018-06-21 10:22:13 +02006902 size_t i;
6903 unsigned run;
Gilles Peskine05d69892018-06-19 22:00:52 +02006904
Simon Butcher49f8e312020-03-03 15:51:50 +00006905 TEST_ASSERT( bytes_arg >= 0 );
6906
Gilles Peskine91892022021-02-08 19:50:26 +01006907 ASSERT_ALLOC( output, bytes );
Gilles Peskine8cebbba2018-09-27 13:54:18 +02006908 ASSERT_ALLOC( changed, bytes );
Gilles Peskine05d69892018-06-19 22:00:52 +02006909
Gilles Peskine8817f612018-12-18 00:18:46 +01006910 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine05d69892018-06-19 22:00:52 +02006911
Gilles Peskinea50d7392018-06-21 10:22:13 +02006912 /* Run several times, to ensure that every output byte will be
6913 * nonzero at least once with overwhelming probability
6914 * (2^(-8*number_of_runs)). */
6915 for( run = 0; run < 10; run++ )
Gilles Peskine05d69892018-06-19 22:00:52 +02006916 {
Gilles Peskinef7ab5ad2018-09-26 18:19:24 +02006917 if( bytes != 0 )
6918 memset( output, 0, bytes );
Gilles Peskine8817f612018-12-18 00:18:46 +01006919 PSA_ASSERT( psa_generate_random( output, bytes ) );
Gilles Peskinea50d7392018-06-21 10:22:13 +02006920
Gilles Peskinea50d7392018-06-21 10:22:13 +02006921 for( i = 0; i < bytes; i++ )
6922 {
6923 if( output[i] != 0 )
6924 ++changed[i];
6925 }
Gilles Peskine05d69892018-06-19 22:00:52 +02006926 }
Gilles Peskinea50d7392018-06-21 10:22:13 +02006927
6928 /* Check that every byte was changed to nonzero at least once. This
6929 * validates that psa_generate_random is overwriting every byte of
6930 * the output buffer. */
6931 for( i = 0; i < bytes; i++ )
6932 {
6933 TEST_ASSERT( changed[i] != 0 );
6934 }
Gilles Peskine05d69892018-06-19 22:00:52 +02006935
6936exit:
Gilles Peskine1153e7b2019-05-28 15:10:21 +02006937 PSA_DONE( );
Gilles Peskinea50d7392018-06-21 10:22:13 +02006938 mbedtls_free( output );
6939 mbedtls_free( changed );
Gilles Peskine05d69892018-06-19 22:00:52 +02006940}
6941/* END_CASE */
Gilles Peskine12313cd2018-06-20 00:20:32 +02006942
6943/* BEGIN_CASE */
6944void generate_key( int type_arg,
6945 int bits_arg,
6946 int usage_arg,
6947 int alg_arg,
Steven Cooreman83fdb702021-01-21 14:24:39 +01006948 int expected_status_arg,
6949 int is_large_key )
Gilles Peskine12313cd2018-06-20 00:20:32 +02006950{
Ronald Cron5425a212020-08-04 14:58:35 +02006951 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine12313cd2018-06-20 00:20:32 +02006952 psa_key_type_t type = type_arg;
6953 psa_key_usage_t usage = usage_arg;
6954 size_t bits = bits_arg;
6955 psa_algorithm_t alg = alg_arg;
6956 psa_status_t expected_status = expected_status_arg;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006957 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02006958 psa_key_attributes_t got_attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine12313cd2018-06-20 00:20:32 +02006959
Gilles Peskine8817f612018-12-18 00:18:46 +01006960 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine12313cd2018-06-20 00:20:32 +02006961
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006962 psa_set_key_usage_flags( &attributes, usage );
6963 psa_set_key_algorithm( &attributes, alg );
6964 psa_set_key_type( &attributes, type );
Gilles Peskine3a4f1f82019-04-26 13:49:28 +02006965 psa_set_key_bits( &attributes, bits );
Gilles Peskine12313cd2018-06-20 00:20:32 +02006966
6967 /* Generate a key */
Steven Cooreman83fdb702021-01-21 14:24:39 +01006968 psa_status_t status = psa_generate_key( &attributes, &key );
6969
6970 if( is_large_key > 0 )
6971 TEST_ASSUME( status != PSA_ERROR_INSUFFICIENT_MEMORY );
6972 TEST_EQUAL( status , expected_status );
Gilles Peskinee56e8782019-04-26 17:34:02 +02006973 if( expected_status != PSA_SUCCESS )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006974 goto exit;
Gilles Peskine12313cd2018-06-20 00:20:32 +02006975
6976 /* Test the key information */
Ronald Cron5425a212020-08-04 14:58:35 +02006977 PSA_ASSERT( psa_get_key_attributes( key, &got_attributes ) );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02006978 TEST_EQUAL( psa_get_key_type( &got_attributes ), type );
6979 TEST_EQUAL( psa_get_key_bits( &got_attributes ), bits );
Gilles Peskine12313cd2018-06-20 00:20:32 +02006980
Gilles Peskine818ca122018-06-20 18:16:48 +02006981 /* Do something with the key according to its type and permitted usage. */
Gilles Peskinec18e25f2021-02-12 23:48:20 +01006982 if( ! mbedtls_test_psa_exercise_key( key, usage, alg ) )
Gilles Peskine02b75072018-07-01 22:31:34 +02006983 goto exit;
Gilles Peskine12313cd2018-06-20 00:20:32 +02006984
6985exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +01006986 /*
6987 * Key attributes may have been returned by psa_get_key_attributes()
6988 * thus reset them as required.
6989 */
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02006990 psa_reset_key_attributes( &got_attributes );
Ronald Cron3a4f0e32020-11-19 17:55:23 +01006991
Ronald Cron5425a212020-08-04 14:58:35 +02006992 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02006993 PSA_DONE( );
Gilles Peskine12313cd2018-06-20 00:20:32 +02006994}
6995/* END_CASE */
itayzafrir0adf0fc2018-09-06 16:24:41 +03006996
Ronald Cronee414c72021-03-18 18:50:08 +01006997/* 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 +02006998void generate_key_rsa( int bits_arg,
6999 data_t *e_arg,
7000 int expected_status_arg )
7001{
Ronald Cron5425a212020-08-04 14:58:35 +02007002 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskinec93b80c2019-05-16 19:39:54 +02007003 psa_key_type_t type = PSA_KEY_TYPE_RSA_KEY_PAIR;
Gilles Peskinee56e8782019-04-26 17:34:02 +02007004 size_t bits = bits_arg;
7005 psa_key_usage_t usage = PSA_KEY_USAGE_ENCRYPT | PSA_KEY_USAGE_DECRYPT;
7006 psa_algorithm_t alg = PSA_ALG_RSA_PKCS1V15_SIGN_RAW;
7007 psa_status_t expected_status = expected_status_arg;
7008 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
7009 uint8_t *exported = NULL;
7010 size_t exported_size =
gabor-mezei-armcbcec212020-12-18 14:23:51 +01007011 PSA_EXPORT_KEY_OUTPUT_SIZE( PSA_KEY_TYPE_RSA_PUBLIC_KEY, bits );
Gilles Peskinee56e8782019-04-26 17:34:02 +02007012 size_t exported_length = SIZE_MAX;
7013 uint8_t *e_read_buffer = NULL;
7014 int is_default_public_exponent = 0;
Gilles Peskineaa02c172019-04-28 11:44:17 +02007015 size_t e_read_size = PSA_KEY_DOMAIN_PARAMETERS_SIZE( type, bits );
Gilles Peskinee56e8782019-04-26 17:34:02 +02007016 size_t e_read_length = SIZE_MAX;
7017
7018 if( e_arg->len == 0 ||
7019 ( e_arg->len == 3 &&
7020 e_arg->x[0] == 1 && e_arg->x[1] == 0 && e_arg->x[2] == 1 ) )
7021 {
7022 is_default_public_exponent = 1;
7023 e_read_size = 0;
7024 }
7025 ASSERT_ALLOC( e_read_buffer, e_read_size );
7026 ASSERT_ALLOC( exported, exported_size );
7027
7028 PSA_ASSERT( psa_crypto_init( ) );
7029
7030 psa_set_key_usage_flags( &attributes, usage );
7031 psa_set_key_algorithm( &attributes, alg );
7032 PSA_ASSERT( psa_set_key_domain_parameters( &attributes, type,
7033 e_arg->x, e_arg->len ) );
7034 psa_set_key_bits( &attributes, bits );
7035
7036 /* Generate a key */
Ronald Cron5425a212020-08-04 14:58:35 +02007037 TEST_EQUAL( psa_generate_key( &attributes, &key ), expected_status );
Gilles Peskinee56e8782019-04-26 17:34:02 +02007038 if( expected_status != PSA_SUCCESS )
7039 goto exit;
7040
7041 /* Test the key information */
Ronald Cron5425a212020-08-04 14:58:35 +02007042 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
Gilles Peskinee56e8782019-04-26 17:34:02 +02007043 TEST_EQUAL( psa_get_key_type( &attributes ), type );
7044 TEST_EQUAL( psa_get_key_bits( &attributes ), bits );
7045 PSA_ASSERT( psa_get_key_domain_parameters( &attributes,
7046 e_read_buffer, e_read_size,
7047 &e_read_length ) );
7048 if( is_default_public_exponent )
7049 TEST_EQUAL( e_read_length, 0 );
7050 else
7051 ASSERT_COMPARE( e_read_buffer, e_read_length, e_arg->x, e_arg->len );
7052
7053 /* Do something with the key according to its type and permitted usage. */
Gilles Peskinec18e25f2021-02-12 23:48:20 +01007054 if( ! mbedtls_test_psa_exercise_key( key, usage, alg ) )
Gilles Peskinee56e8782019-04-26 17:34:02 +02007055 goto exit;
7056
7057 /* Export the key and check the public exponent. */
Ronald Cron5425a212020-08-04 14:58:35 +02007058 PSA_ASSERT( psa_export_public_key( key,
Gilles Peskinee56e8782019-04-26 17:34:02 +02007059 exported, exported_size,
7060 &exported_length ) );
7061 {
7062 uint8_t *p = exported;
7063 uint8_t *end = exported + exported_length;
7064 size_t len;
7065 /* RSAPublicKey ::= SEQUENCE {
7066 * modulus INTEGER, -- n
7067 * publicExponent INTEGER } -- e
7068 */
7069 TEST_EQUAL( 0, mbedtls_asn1_get_tag( &p, end, &len,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02007070 MBEDTLS_ASN1_SEQUENCE |
7071 MBEDTLS_ASN1_CONSTRUCTED ) );
Gilles Peskine8e94efe2021-02-13 00:25:53 +01007072 TEST_ASSERT( mbedtls_test_asn1_skip_integer( &p, end, bits, bits, 1 ) );
Gilles Peskinee56e8782019-04-26 17:34:02 +02007073 TEST_EQUAL( 0, mbedtls_asn1_get_tag( &p, end, &len,
7074 MBEDTLS_ASN1_INTEGER ) );
7075 if( len >= 1 && p[0] == 0 )
7076 {
7077 ++p;
7078 --len;
7079 }
7080 if( e_arg->len == 0 )
7081 {
7082 TEST_EQUAL( len, 3 );
7083 TEST_EQUAL( p[0], 1 );
7084 TEST_EQUAL( p[1], 0 );
7085 TEST_EQUAL( p[2], 1 );
7086 }
7087 else
7088 ASSERT_COMPARE( p, len, e_arg->x, e_arg->len );
7089 }
7090
7091exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +01007092 /*
7093 * Key attributes may have been returned by psa_get_key_attributes() or
7094 * set by psa_set_key_domain_parameters() thus reset them as required.
7095 */
Gilles Peskinee56e8782019-04-26 17:34:02 +02007096 psa_reset_key_attributes( &attributes );
Ronald Cron3a4f0e32020-11-19 17:55:23 +01007097
Ronald Cron5425a212020-08-04 14:58:35 +02007098 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02007099 PSA_DONE( );
Gilles Peskinee56e8782019-04-26 17:34:02 +02007100 mbedtls_free( e_read_buffer );
7101 mbedtls_free( exported );
7102}
7103/* END_CASE */
7104
Darryl Greend49a4992018-06-18 17:27:26 +01007105/* BEGIN_CASE depends_on:MBEDTLS_PSA_CRYPTO_STORAGE_C */
Gilles Peskine5c648ab2019-04-19 14:06:53 +02007106void persistent_key_load_key_from_storage( data_t *data,
7107 int type_arg, int bits_arg,
7108 int usage_flags_arg, int alg_arg,
7109 int generation_method )
Darryl Greend49a4992018-06-18 17:27:26 +01007110{
Ronald Cron71016a92020-08-28 19:01:50 +02007111 mbedtls_svc_key_id_t key_id = mbedtls_svc_key_id_make( 1, 1 );
Gilles Peskine5c648ab2019-04-19 14:06:53 +02007112 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Ronald Cron5425a212020-08-04 14:58:35 +02007113 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
7114 mbedtls_svc_key_id_t base_key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine5c648ab2019-04-19 14:06:53 +02007115 psa_key_type_t type = type_arg;
7116 size_t bits = bits_arg;
7117 psa_key_usage_t usage_flags = usage_flags_arg;
7118 psa_algorithm_t alg = alg_arg;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007119 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Darryl Greend49a4992018-06-18 17:27:26 +01007120 unsigned char *first_export = NULL;
7121 unsigned char *second_export = NULL;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01007122 size_t export_size = PSA_EXPORT_KEY_OUTPUT_SIZE( type, bits );
Darryl Greend49a4992018-06-18 17:27:26 +01007123 size_t first_exported_length;
7124 size_t second_exported_length;
7125
Gilles Peskine5c648ab2019-04-19 14:06:53 +02007126 if( usage_flags & PSA_KEY_USAGE_EXPORT )
7127 {
7128 ASSERT_ALLOC( first_export, export_size );
7129 ASSERT_ALLOC( second_export, export_size );
7130 }
Darryl Greend49a4992018-06-18 17:27:26 +01007131
Gilles Peskine8817f612018-12-18 00:18:46 +01007132 PSA_ASSERT( psa_crypto_init() );
Darryl Greend49a4992018-06-18 17:27:26 +01007133
Gilles Peskinec87af662019-05-15 16:12:22 +02007134 psa_set_key_id( &attributes, key_id );
Gilles Peskine5c648ab2019-04-19 14:06:53 +02007135 psa_set_key_usage_flags( &attributes, usage_flags );
7136 psa_set_key_algorithm( &attributes, alg );
7137 psa_set_key_type( &attributes, type );
Gilles Peskine3a4f1f82019-04-26 13:49:28 +02007138 psa_set_key_bits( &attributes, bits );
Darryl Greend49a4992018-06-18 17:27:26 +01007139
Darryl Green0c6575a2018-11-07 16:05:30 +00007140 switch( generation_method )
7141 {
7142 case IMPORT_KEY:
7143 /* Import the key */
Gilles Peskine049c7532019-05-15 20:22:09 +02007144 PSA_ASSERT( psa_import_key( &attributes, data->x, data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02007145 &key ) );
Darryl Green0c6575a2018-11-07 16:05:30 +00007146 break;
Darryl Greend49a4992018-06-18 17:27:26 +01007147
Darryl Green0c6575a2018-11-07 16:05:30 +00007148 case GENERATE_KEY:
7149 /* Generate a key */
Ronald Cron5425a212020-08-04 14:58:35 +02007150 PSA_ASSERT( psa_generate_key( &attributes, &key ) );
Darryl Green0c6575a2018-11-07 16:05:30 +00007151 break;
7152
7153 case DERIVE_KEY:
Steven Cooreman70f654a2021-02-15 10:51:43 +01007154#if defined(PSA_WANT_ALG_HKDF) && defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine5c648ab2019-04-19 14:06:53 +02007155 {
7156 /* Create base key */
7157 psa_algorithm_t derive_alg = PSA_ALG_HKDF( PSA_ALG_SHA_256 );
7158 psa_key_attributes_t base_attributes = PSA_KEY_ATTRIBUTES_INIT;
7159 psa_set_key_usage_flags( &base_attributes,
7160 PSA_KEY_USAGE_DERIVE );
7161 psa_set_key_algorithm( &base_attributes, derive_alg );
7162 psa_set_key_type( &base_attributes, PSA_KEY_TYPE_DERIVE );
Gilles Peskine049c7532019-05-15 20:22:09 +02007163 PSA_ASSERT( psa_import_key( &base_attributes,
7164 data->x, data->len,
7165 &base_key ) );
Gilles Peskine5c648ab2019-04-19 14:06:53 +02007166 /* Derive a key. */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007167 PSA_ASSERT( psa_key_derivation_setup( &operation, derive_alg ) );
Gilles Peskinecf7292e2019-05-16 17:53:40 +02007168 PSA_ASSERT( psa_key_derivation_input_key(
7169 &operation,
7170 PSA_KEY_DERIVATION_INPUT_SECRET, base_key ) );
Gilles Peskine5c648ab2019-04-19 14:06:53 +02007171 PSA_ASSERT( psa_key_derivation_input_bytes(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007172 &operation, PSA_KEY_DERIVATION_INPUT_INFO,
Gilles Peskine5c648ab2019-04-19 14:06:53 +02007173 NULL, 0 ) );
Gilles Peskinecf7292e2019-05-16 17:53:40 +02007174 PSA_ASSERT( psa_key_derivation_output_key( &attributes,
7175 &operation,
Ronald Cron5425a212020-08-04 14:58:35 +02007176 &key ) );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007177 PSA_ASSERT( psa_key_derivation_abort( &operation ) );
Gilles Peskine5c648ab2019-04-19 14:06:53 +02007178 PSA_ASSERT( psa_destroy_key( base_key ) );
Ronald Cron5425a212020-08-04 14:58:35 +02007179 base_key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine5c648ab2019-04-19 14:06:53 +02007180 }
Gilles Peskine6fea21d2021-01-12 00:02:15 +01007181#else
7182 TEST_ASSUME( ! "KDF not supported in this configuration" );
7183#endif
7184 break;
7185
7186 default:
7187 TEST_ASSERT( ! "generation_method not implemented in test" );
7188 break;
Darryl Green0c6575a2018-11-07 16:05:30 +00007189 }
Gilles Peskine5c648ab2019-04-19 14:06:53 +02007190 psa_reset_key_attributes( &attributes );
Darryl Greend49a4992018-06-18 17:27:26 +01007191
Gilles Peskine5c648ab2019-04-19 14:06:53 +02007192 /* Export the key if permitted by the key policy. */
7193 if( usage_flags & PSA_KEY_USAGE_EXPORT )
7194 {
Ronald Cron5425a212020-08-04 14:58:35 +02007195 PSA_ASSERT( psa_export_key( key,
Gilles Peskine5c648ab2019-04-19 14:06:53 +02007196 first_export, export_size,
7197 &first_exported_length ) );
7198 if( generation_method == IMPORT_KEY )
7199 ASSERT_COMPARE( data->x, data->len,
7200 first_export, first_exported_length );
7201 }
Darryl Greend49a4992018-06-18 17:27:26 +01007202
7203 /* Shutdown and restart */
Ronald Cron5425a212020-08-04 14:58:35 +02007204 PSA_ASSERT( psa_purge_key( key ) );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02007205 PSA_DONE();
Gilles Peskine8817f612018-12-18 00:18:46 +01007206 PSA_ASSERT( psa_crypto_init() );
Darryl Greend49a4992018-06-18 17:27:26 +01007207
Darryl Greend49a4992018-06-18 17:27:26 +01007208 /* Check key slot still contains key data */
Ronald Cron5425a212020-08-04 14:58:35 +02007209 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
Ronald Cronecfb2372020-07-23 17:13:42 +02007210 TEST_ASSERT( mbedtls_svc_key_id_equal(
7211 psa_get_key_id( &attributes ), key_id ) );
Gilles Peskine5c648ab2019-04-19 14:06:53 +02007212 TEST_EQUAL( psa_get_key_lifetime( &attributes ),
7213 PSA_KEY_LIFETIME_PERSISTENT );
7214 TEST_EQUAL( psa_get_key_type( &attributes ), type );
7215 TEST_EQUAL( psa_get_key_bits( &attributes ), bits );
gabor-mezei-arm4ff73032021-05-13 12:05:01 +02007216 TEST_EQUAL( psa_get_key_usage_flags( &attributes ),
gabor-mezei-arm98a34352021-06-28 14:05:00 +02007217 mbedtls_test_update_key_usage_flags( usage_flags ) );
Gilles Peskine5c648ab2019-04-19 14:06:53 +02007218 TEST_EQUAL( psa_get_key_algorithm( &attributes ), alg );
Darryl Greend49a4992018-06-18 17:27:26 +01007219
Gilles Peskine5c648ab2019-04-19 14:06:53 +02007220 /* Export the key again if permitted by the key policy. */
7221 if( usage_flags & PSA_KEY_USAGE_EXPORT )
Darryl Green0c6575a2018-11-07 16:05:30 +00007222 {
Ronald Cron5425a212020-08-04 14:58:35 +02007223 PSA_ASSERT( psa_export_key( key,
Gilles Peskine5c648ab2019-04-19 14:06:53 +02007224 second_export, export_size,
7225 &second_exported_length ) );
Darryl Green0c6575a2018-11-07 16:05:30 +00007226 ASSERT_COMPARE( first_export, first_exported_length,
7227 second_export, second_exported_length );
Darryl Green0c6575a2018-11-07 16:05:30 +00007228 }
7229
7230 /* Do something with the key according to its type and permitted usage. */
Gilles Peskinec18e25f2021-02-12 23:48:20 +01007231 if( ! mbedtls_test_psa_exercise_key( key, usage_flags, alg ) )
Darryl Green0c6575a2018-11-07 16:05:30 +00007232 goto exit;
Darryl Greend49a4992018-06-18 17:27:26 +01007233
7234exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +01007235 /*
7236 * Key attributes may have been returned by psa_get_key_attributes()
7237 * thus reset them as required.
7238 */
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02007239 psa_reset_key_attributes( &attributes );
Ronald Cron3a4f0e32020-11-19 17:55:23 +01007240
Darryl Greend49a4992018-06-18 17:27:26 +01007241 mbedtls_free( first_export );
7242 mbedtls_free( second_export );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007243 psa_key_derivation_abort( &operation );
Gilles Peskine5c648ab2019-04-19 14:06:53 +02007244 psa_destroy_key( base_key );
Ronald Cron5425a212020-08-04 14:58:35 +02007245 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02007246 PSA_DONE();
Darryl Greend49a4992018-06-18 17:27:26 +01007247}
7248/* END_CASE */