blob: 958d2c3c0e299a01b1b6b17348a6801f5d10d239 [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}
Gilles Peskine818ca122018-06-20 18:16:48 +020057
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}
141
Gilles Peskinef426e0f2019-02-25 17:42:03 +0100142int exercise_mac_setup( psa_key_type_t key_type,
143 const unsigned char *key_bytes,
144 size_t key_length,
145 psa_algorithm_t alg,
146 psa_mac_operation_t *operation,
147 psa_status_t *status )
148{
Ronald Cron5425a212020-08-04 14:58:35 +0200149 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +0200150 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskinef426e0f2019-02-25 17:42:03 +0100151
Gilles Peskine89d8c5c2019-11-26 17:01:59 +0100152 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_HASH );
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +0200153 psa_set_key_algorithm( &attributes, alg );
154 psa_set_key_type( &attributes, key_type );
Ronald Cron5425a212020-08-04 14:58:35 +0200155 PSA_ASSERT( psa_import_key( &attributes, key_bytes, key_length, &key ) );
Gilles Peskinef426e0f2019-02-25 17:42:03 +0100156
Ronald Cron5425a212020-08-04 14:58:35 +0200157 *status = psa_mac_sign_setup( operation, key, alg );
Gilles Peskine9e0a4a52019-02-25 22:11:18 +0100158 /* Whether setup succeeded or failed, abort must succeed. */
159 PSA_ASSERT( psa_mac_abort( operation ) );
160 /* If setup failed, reproduce the failure, so that the caller can
161 * test the resulting state of the operation object. */
162 if( *status != PSA_SUCCESS )
Gilles Peskinef426e0f2019-02-25 17:42:03 +0100163 {
Ronald Cron5425a212020-08-04 14:58:35 +0200164 TEST_EQUAL( psa_mac_sign_setup( operation, key, alg ), *status );
Gilles Peskinef426e0f2019-02-25 17:42:03 +0100165 }
166
Ronald Cron5425a212020-08-04 14:58:35 +0200167 psa_destroy_key( key );
Gilles Peskinef426e0f2019-02-25 17:42:03 +0100168 return( 1 );
169
170exit:
Ronald Cron5425a212020-08-04 14:58:35 +0200171 psa_destroy_key( key );
Gilles Peskinef426e0f2019-02-25 17:42:03 +0100172 return( 0 );
173}
174
175int exercise_cipher_setup( psa_key_type_t key_type,
176 const unsigned char *key_bytes,
177 size_t key_length,
178 psa_algorithm_t alg,
179 psa_cipher_operation_t *operation,
180 psa_status_t *status )
181{
Ronald Cron5425a212020-08-04 14:58:35 +0200182 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +0200183 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskinef426e0f2019-02-25 17:42:03 +0100184
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +0200185 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
186 psa_set_key_algorithm( &attributes, alg );
187 psa_set_key_type( &attributes, key_type );
Ronald Cron5425a212020-08-04 14:58:35 +0200188 PSA_ASSERT( psa_import_key( &attributes, key_bytes, key_length, &key ) );
Gilles Peskinef426e0f2019-02-25 17:42:03 +0100189
Ronald Cron5425a212020-08-04 14:58:35 +0200190 *status = psa_cipher_encrypt_setup( operation, key, alg );
Gilles Peskine9e0a4a52019-02-25 22:11:18 +0100191 /* Whether setup succeeded or failed, abort must succeed. */
192 PSA_ASSERT( psa_cipher_abort( operation ) );
193 /* If setup failed, reproduce the failure, so that the caller can
194 * test the resulting state of the operation object. */
195 if( *status != PSA_SUCCESS )
Gilles Peskinef426e0f2019-02-25 17:42:03 +0100196 {
Ronald Cron5425a212020-08-04 14:58:35 +0200197 TEST_EQUAL( psa_cipher_encrypt_setup( operation, key, alg ),
Gilles Peskine9e0a4a52019-02-25 22:11:18 +0100198 *status );
Gilles Peskinef426e0f2019-02-25 17:42:03 +0100199 }
200
Ronald Cron5425a212020-08-04 14:58:35 +0200201 psa_destroy_key( key );
Gilles Peskinef426e0f2019-02-25 17:42:03 +0100202 return( 1 );
203
204exit:
Ronald Cron5425a212020-08-04 14:58:35 +0200205 psa_destroy_key( key );
Gilles Peskinef426e0f2019-02-25 17:42:03 +0100206 return( 0 );
207}
208
Ronald Cron5425a212020-08-04 14:58:35 +0200209static int test_operations_on_invalid_key( mbedtls_svc_key_id_t key )
Gilles Peskine4cf3a432019-04-18 22:28:52 +0200210{
211 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Ronald Cronecfb2372020-07-23 17:13:42 +0200212 mbedtls_svc_key_id_t key_id = mbedtls_svc_key_id_make( 1, 0x6964 );
Gilles Peskine4cf3a432019-04-18 22:28:52 +0200213 uint8_t buffer[1];
214 size_t length;
215 int ok = 0;
216
Ronald Cronecfb2372020-07-23 17:13:42 +0200217 psa_set_key_id( &attributes, key_id );
Gilles Peskine4cf3a432019-04-18 22:28:52 +0200218 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
219 psa_set_key_algorithm( &attributes, PSA_ALG_CTR );
220 psa_set_key_type( &attributes, PSA_KEY_TYPE_AES );
Ronald Cron5425a212020-08-04 14:58:35 +0200221 TEST_EQUAL( psa_get_key_attributes( key, &attributes ),
Maulik Patel3240c9d2021-03-17 16:11:05 +0000222 PSA_ERROR_INVALID_HANDLE );
Ronald Cronecfb2372020-07-23 17:13:42 +0200223 TEST_EQUAL(
224 MBEDTLS_SVC_KEY_ID_GET_KEY_ID( psa_get_key_id( &attributes ) ), 0 );
225 TEST_EQUAL(
226 MBEDTLS_SVC_KEY_ID_GET_OWNER_ID( psa_get_key_id( &attributes ) ), 0 );
Gilles Peskine5c648ab2019-04-19 14:06:53 +0200227 TEST_EQUAL( psa_get_key_lifetime( &attributes ), 0 );
Gilles Peskine4cf3a432019-04-18 22:28:52 +0200228 TEST_EQUAL( psa_get_key_usage_flags( &attributes ), 0 );
229 TEST_EQUAL( psa_get_key_algorithm( &attributes ), 0 );
230 TEST_EQUAL( psa_get_key_type( &attributes ), 0 );
231 TEST_EQUAL( psa_get_key_bits( &attributes ), 0 );
232
Ronald Cron5425a212020-08-04 14:58:35 +0200233 TEST_EQUAL( psa_export_key( key, buffer, sizeof( buffer ), &length ),
Maulik Patel3240c9d2021-03-17 16:11:05 +0000234 PSA_ERROR_INVALID_HANDLE );
Ronald Cron5425a212020-08-04 14:58:35 +0200235 TEST_EQUAL( psa_export_public_key( key,
Gilles Peskine4cf3a432019-04-18 22:28:52 +0200236 buffer, sizeof( buffer ), &length ),
Maulik Patel3240c9d2021-03-17 16:11:05 +0000237 PSA_ERROR_INVALID_HANDLE );
Gilles Peskine4cf3a432019-04-18 22:28:52 +0200238
Gilles Peskine4cf3a432019-04-18 22:28:52 +0200239 ok = 1;
240
241exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +0100242 /*
243 * Key attributes may have been returned by psa_get_key_attributes()
244 * thus reset them as required.
245 */
Gilles Peskine4cf3a432019-04-18 22:28:52 +0200246 psa_reset_key_attributes( &attributes );
Ronald Cron3a4f0e32020-11-19 17:55:23 +0100247
Gilles Peskine4cf3a432019-04-18 22:28:52 +0200248 return( ok );
249}
250
Gilles Peskine5fe5e272019-08-02 20:30:01 +0200251/* Assert that a key isn't reported as having a slot number. */
252#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
253#define ASSERT_NO_SLOT_NUMBER( attributes ) \
254 do \
255 { \
256 psa_key_slot_number_t ASSERT_NO_SLOT_NUMBER_slot_number; \
257 TEST_EQUAL( psa_get_key_slot_number( \
258 attributes, \
259 &ASSERT_NO_SLOT_NUMBER_slot_number ), \
260 PSA_ERROR_INVALID_ARGUMENT ); \
261 } \
262 while( 0 )
263#else /* MBEDTLS_PSA_CRYPTO_SE_C */
264#define ASSERT_NO_SLOT_NUMBER( attributes ) \
265 ( (void) 0 )
266#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
267
Gilles Peskinebdf309c2018-12-03 15:36:32 +0100268/* An overapproximation of the amount of storage needed for a key of the
269 * given type and with the given content. The API doesn't make it easy
270 * to find a good value for the size. The current implementation doesn't
271 * care about the value anyway. */
272#define KEY_BITS_FROM_DATA( type, data ) \
273 ( data )->len
274
Darryl Green0c6575a2018-11-07 16:05:30 +0000275typedef enum {
276 IMPORT_KEY = 0,
277 GENERATE_KEY = 1,
278 DERIVE_KEY = 2
279} generate_method;
280
Paul Elliott33746aa2021-09-15 16:40:40 +0100281typedef enum
282{
283 DO_NOT_SET_LENGTHS = 0,
284 SET_LENGTHS_BEFORE_NONCE = 1,
285 SET_LENGTHS_AFTER_NONCE = 2
Paul Elliottbb979e72021-09-22 12:54:42 +0100286} set_lengths_method_t;
Paul Elliott33746aa2021-09-15 16:40:40 +0100287
Paul Elliott1c67e0b2021-09-19 13:11:50 +0100288typedef enum
289{
290 USE_NULL_TAG = 0,
291 USE_GIVEN_TAG = 1,
Paul Elliottbb979e72021-09-22 12:54:42 +0100292} tag_usage_method_t;
Paul Elliott1c67e0b2021-09-19 13:11:50 +0100293
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100294/*!
295 * \brief Internal Function for AEAD multipart tests.
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100296 * \param key_type_arg Type of key passed in
297 * \param key_data The encryption / decryption key data
298 * \param alg_arg The type of algorithm used
299 * \param nonce Nonce data
300 * \param additional_data Additional data
Paul Elliott8eec8d42021-09-19 22:38:27 +0100301 * \param ad_part_len_arg If not -1, the length of chunks to
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100302 * feed additional data in to be encrypted /
303 * decrypted. If -1, no chunking.
304 * \param input_data Data to encrypt / decrypt
Paul Elliott8eec8d42021-09-19 22:38:27 +0100305 * \param data_part_len_arg If not -1, the length of chunks to feed
306 * the data in to be encrypted / decrypted. If
307 * -1, no chunking
Paul Elliottbb979e72021-09-22 12:54:42 +0100308 * \param set_lengths_method A member of the set_lengths_method_t enum is
Paul Elliott8eec8d42021-09-19 22:38:27 +0100309 * expected here, this controls whether or not
310 * to set lengths, and in what order with
311 * respect to set nonce.
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100312 * \param expected_output Expected output
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100313 * \param is_encrypt If non-zero this is an encryption operation.
Paul Elliott41ffae12021-07-22 21:52:01 +0100314 * \param do_zero_parts If non-zero, interleave zero length chunks
Paul Elliott8eec8d42021-09-19 22:38:27 +0100315 * with normal length chunks.
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100316 * \return int Zero on failure, non-zero on success.
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100317 */
318static int aead_multipart_internal_func( int key_type_arg, data_t *key_data,
319 int alg_arg,
320 data_t *nonce,
321 data_t *additional_data,
Paul Elliott6bfd0fb2021-09-15 14:15:55 +0100322 int ad_part_len_arg,
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100323 data_t *input_data,
Paul Elliott6bfd0fb2021-09-15 14:15:55 +0100324 int data_part_len_arg,
Paul Elliottbb979e72021-09-22 12:54:42 +0100325 set_lengths_method_t set_lengths_method,
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100326 data_t *expected_output,
Paul Elliott329d5382021-07-22 17:10:45 +0100327 int is_encrypt,
Paul Elliott33746aa2021-09-15 16:40:40 +0100328 int do_zero_parts )
Paul Elliottd3f82412021-06-16 16:52:21 +0100329{
330 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
331 psa_key_type_t key_type = key_type_arg;
332 psa_algorithm_t alg = alg_arg;
Paul Elliottfbb4c6d2021-09-22 16:44:21 +0100333 psa_aead_operation_t operation = PSA_AEAD_OPERATION_INIT;
Paul Elliottd3f82412021-06-16 16:52:21 +0100334 unsigned char *output_data = NULL;
335 unsigned char *part_data = NULL;
336 unsigned char *final_data = NULL;
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100337 size_t data_true_size = 0;
Paul Elliottd3f82412021-06-16 16:52:21 +0100338 size_t part_data_size = 0;
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100339 size_t output_size = 0;
340 size_t final_output_size = 0;
Paul Elliottd3f82412021-06-16 16:52:21 +0100341 size_t output_length = 0;
342 size_t key_bits = 0;
343 size_t tag_length = 0;
Paul Elliott6bfd0fb2021-09-15 14:15:55 +0100344 size_t part_offset = 0;
Paul Elliottd3f82412021-06-16 16:52:21 +0100345 size_t part_length = 0;
346 size_t output_part_length = 0;
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100347 size_t tag_size = 0;
Paul Elliott6bfd0fb2021-09-15 14:15:55 +0100348 size_t ad_part_len = 0;
349 size_t data_part_len = 0;
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100350 uint8_t tag_buffer[PSA_AEAD_TAG_MAX_SIZE];
Paul Elliottd3f82412021-06-16 16:52:21 +0100351 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
352 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
353
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100354 int test_ok = 0;
Paul Elliott6bfd0fb2021-09-15 14:15:55 +0100355 size_t part_count = 0;
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100356
Paul Elliottd3f82412021-06-16 16:52:21 +0100357 PSA_ASSERT( psa_crypto_init( ) );
358
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100359 if( is_encrypt )
360 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
361 else
362 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DECRYPT );
363
Paul Elliottd3f82412021-06-16 16:52:21 +0100364 psa_set_key_algorithm( &attributes, alg );
365 psa_set_key_type( &attributes, key_type );
366
367 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
368 &key ) );
369
370 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
371 key_bits = psa_get_key_bits( &attributes );
372
373 tag_length = PSA_AEAD_TAG_LENGTH( key_type, key_bits, alg );
374
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100375 if( is_encrypt )
376 {
377 /* Tag gets written at end of buffer. */
378 output_size = PSA_AEAD_UPDATE_OUTPUT_SIZE( key_type, alg,
379 ( input_data->len +
380 tag_length ) );
381 data_true_size = input_data->len;
382 }
383 else
384 {
385 output_size = PSA_AEAD_UPDATE_OUTPUT_SIZE( key_type, alg,
386 ( input_data->len -
387 tag_length ) );
Paul Elliottd3f82412021-06-16 16:52:21 +0100388
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100389 /* Do not want to attempt to decrypt tag. */
390 data_true_size = input_data->len - tag_length;
391 }
Paul Elliottd3f82412021-06-16 16:52:21 +0100392
393 ASSERT_ALLOC( output_data, output_size );
394
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100395 if( is_encrypt )
396 {
Paul Elliott5a9642f2021-09-13 19:13:22 +0100397 final_output_size = PSA_AEAD_FINISH_OUTPUT_SIZE( key_type, alg );
398 TEST_ASSERT( final_output_size <= PSA_AEAD_FINISH_OUTPUT_MAX_SIZE );
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100399 }
400 else
401 {
Paul Elliott5a9642f2021-09-13 19:13:22 +0100402 final_output_size = PSA_AEAD_VERIFY_OUTPUT_SIZE( key_type, alg );
403 TEST_ASSERT( final_output_size <= PSA_AEAD_VERIFY_OUTPUT_MAX_SIZE );
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100404 }
Paul Elliottd3f82412021-06-16 16:52:21 +0100405
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100406 ASSERT_ALLOC( final_data, final_output_size );
Paul Elliottd3f82412021-06-16 16:52:21 +0100407
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100408 if( is_encrypt )
409 status = psa_aead_encrypt_setup( &operation, key, alg );
410 else
411 status = psa_aead_decrypt_setup( &operation, key, alg );
Paul Elliottd3f82412021-06-16 16:52:21 +0100412
413 /* If the operation is not supported, just skip and not fail in case the
414 * encryption involves a common limitation of cryptography hardwares and
415 * an alternative implementation. */
416 if( status == PSA_ERROR_NOT_SUPPORTED )
417 {
418 MBEDTLS_TEST_PSA_SKIP_IF_ALT_AES_192( key_type, key_data->len * 8 );
419 MBEDTLS_TEST_PSA_SKIP_IF_ALT_GCM_NOT_12BYTES_NONCE( alg, nonce->len );
420 }
421
422 PSA_ASSERT( status );
423
Paul Elliott33746aa2021-09-15 16:40:40 +0100424 if( set_lengths_method == DO_NOT_SET_LENGTHS )
425 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
426 else if( set_lengths_method == SET_LENGTHS_BEFORE_NONCE )
Paul Elliottd3f82412021-06-16 16:52:21 +0100427 {
Paul Elliott33746aa2021-09-15 16:40:40 +0100428 PSA_ASSERT( psa_aead_set_lengths( &operation, additional_data->len,
429 data_true_size ) );
Paul Elliottebf91632021-07-22 17:54:42 +0100430 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
431 }
Paul Elliott33746aa2021-09-15 16:40:40 +0100432 else if( set_lengths_method == SET_LENGTHS_AFTER_NONCE )
Paul Elliottebf91632021-07-22 17:54:42 +0100433 {
434 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
435
Paul Elliott33746aa2021-09-15 16:40:40 +0100436 PSA_ASSERT( psa_aead_set_lengths( &operation, additional_data->len,
437 data_true_size ) );
Paul Elliottd3f82412021-06-16 16:52:21 +0100438 }
Paul Elliottd3f82412021-06-16 16:52:21 +0100439
Paul Elliott6bfd0fb2021-09-15 14:15:55 +0100440 if( ad_part_len_arg != -1 )
Paul Elliottd3f82412021-06-16 16:52:21 +0100441 {
442 /* Pass additional data in parts */
Paul Elliott6bfd0fb2021-09-15 14:15:55 +0100443 ad_part_len = (size_t) ad_part_len_arg;
Paul Elliottd3f82412021-06-16 16:52:21 +0100444
Paul Elliott4e4d71a2021-09-15 16:50:01 +0100445 for( part_offset = 0, part_count = 0;
446 part_offset < additional_data->len;
447 part_offset += part_length, part_count++ )
Paul Elliottd3f82412021-06-16 16:52:21 +0100448 {
Paul Elliott4e4d71a2021-09-15 16:50:01 +0100449 if( do_zero_parts && ( part_count & 0x01 ) )
Paul Elliottd3f82412021-06-16 16:52:21 +0100450 {
Paul Elliott329d5382021-07-22 17:10:45 +0100451 part_length = 0;
Paul Elliottd3f82412021-06-16 16:52:21 +0100452 }
Paul Elliotte49fe452021-09-15 16:52:11 +0100453 else if( additional_data->len - part_offset < ad_part_len )
454 {
455 part_length = additional_data->len - part_offset;
456 }
Paul Elliottd3f82412021-06-16 16:52:21 +0100457 else
458 {
Paul Elliotte49fe452021-09-15 16:52:11 +0100459 part_length = ad_part_len;
Paul Elliottd3f82412021-06-16 16:52:21 +0100460 }
461
462 PSA_ASSERT( psa_aead_update_ad( &operation,
463 additional_data->x + part_offset,
464 part_length ) );
465
Paul Elliottd3f82412021-06-16 16:52:21 +0100466 }
467 }
468 else
469 {
470 /* Pass additional data in one go. */
471 PSA_ASSERT( psa_aead_update_ad( &operation, additional_data->x,
472 additional_data->len ) );
473 }
474
Paul Elliott6bfd0fb2021-09-15 14:15:55 +0100475 if( data_part_len_arg != -1 )
Paul Elliottd3f82412021-06-16 16:52:21 +0100476 {
477 /* Pass data in parts */
Paul Elliott6bfd0fb2021-09-15 14:15:55 +0100478 data_part_len = ( size_t ) data_part_len_arg;
Paul Elliottd3f82412021-06-16 16:52:21 +0100479 part_data_size = PSA_AEAD_UPDATE_OUTPUT_SIZE( key_type, alg,
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100480 ( size_t ) data_part_len );
Paul Elliottd3f82412021-06-16 16:52:21 +0100481
482 ASSERT_ALLOC( part_data, part_data_size );
483
Paul Elliott4e4d71a2021-09-15 16:50:01 +0100484 for( part_offset = 0, part_count = 0;
485 part_offset < data_true_size;
486 part_offset += part_length, part_count++ )
Paul Elliottd3f82412021-06-16 16:52:21 +0100487 {
Paul Elliott4e4d71a2021-09-15 16:50:01 +0100488 if( do_zero_parts && ( part_count & 0x01 ) )
Paul Elliottd3f82412021-06-16 16:52:21 +0100489 {
Paul Elliott329d5382021-07-22 17:10:45 +0100490 part_length = 0;
Paul Elliottd3f82412021-06-16 16:52:21 +0100491 }
Paul Elliotte49fe452021-09-15 16:52:11 +0100492 else if( ( data_true_size - part_offset ) < data_part_len )
493 {
494 part_length = ( data_true_size - part_offset );
495 }
Paul Elliottd3f82412021-06-16 16:52:21 +0100496 else
497 {
Paul Elliotte49fe452021-09-15 16:52:11 +0100498 part_length = data_part_len;
Paul Elliottd3f82412021-06-16 16:52:21 +0100499 }
500
501 PSA_ASSERT( psa_aead_update( &operation,
502 ( input_data->x + part_offset ),
503 part_length, part_data,
504 part_data_size,
505 &output_part_length ) );
506
507 if( output_data && output_part_length )
508 {
509 memcpy( ( output_data + part_offset ), part_data,
510 output_part_length );
511 }
512
Paul Elliottd3f82412021-06-16 16:52:21 +0100513 output_length += output_part_length;
514 }
515 }
516 else
517 {
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100518 /* Pass all data in one go. */
Paul Elliottd3f82412021-06-16 16:52:21 +0100519 PSA_ASSERT( psa_aead_update( &operation, input_data->x,
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100520 data_true_size, output_data,
Paul Elliottd3f82412021-06-16 16:52:21 +0100521 output_size, &output_length ) );
522 }
523
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100524 if( is_encrypt )
525 PSA_ASSERT( psa_aead_finish( &operation, final_data,
526 final_output_size,
527 &output_part_length,
528 tag_buffer, tag_length,
529 &tag_size ) );
530 else
Paul Elliottd3f82412021-06-16 16:52:21 +0100531 {
Paul Elliott9961a662021-09-17 19:19:02 +0100532 PSA_ASSERT( psa_aead_verify( &operation, final_data,
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100533 final_output_size,
534 &output_part_length,
535 ( input_data->x + data_true_size ),
Paul Elliott9961a662021-09-17 19:19:02 +0100536 tag_length ) );
Paul Elliottd3f82412021-06-16 16:52:21 +0100537 }
538
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100539 if( output_data && output_part_length )
540 memcpy( ( output_data + output_length ), final_data,
541 output_part_length );
Paul Elliottd3f82412021-06-16 16:52:21 +0100542
543 output_length += output_part_length;
544
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100545
546 /* For all currently defined algorithms, PSA_AEAD_xxx_OUTPUT_SIZE
547 * should be exact.*/
548 if( is_encrypt )
Paul Elliottd3f82412021-06-16 16:52:21 +0100549 {
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100550 TEST_EQUAL( tag_length, tag_size );
551
552 if( output_data && tag_length )
553 memcpy( ( output_data + output_length ), tag_buffer,
554 tag_length );
555
556 output_length += tag_length;
557
558 TEST_EQUAL( output_length,
559 PSA_AEAD_ENCRYPT_OUTPUT_SIZE( key_type, alg,
560 input_data->len ) );
561 TEST_ASSERT( output_length <=
562 PSA_AEAD_ENCRYPT_OUTPUT_MAX_SIZE( input_data->len ) );
563 }
564 else
565 {
566 TEST_EQUAL( output_length,
567 PSA_AEAD_DECRYPT_OUTPUT_SIZE( key_type, alg,
568 input_data->len ) );
569 TEST_ASSERT( output_length <=
570 PSA_AEAD_DECRYPT_OUTPUT_MAX_SIZE( input_data->len ) );
Paul Elliottd3f82412021-06-16 16:52:21 +0100571 }
572
Paul Elliottd3f82412021-06-16 16:52:21 +0100573
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100574 ASSERT_COMPARE( expected_output->x, expected_output->len,
Paul Elliottd3f82412021-06-16 16:52:21 +0100575 output_data, output_length );
576
Paul Elliottd3f82412021-06-16 16:52:21 +0100577
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100578 test_ok = 1;
Paul Elliottd3f82412021-06-16 16:52:21 +0100579
580exit:
581 psa_destroy_key( key );
582 psa_aead_abort( &operation );
583 mbedtls_free( output_data );
584 mbedtls_free( part_data );
585 mbedtls_free( final_data );
586 PSA_DONE( );
Paul Elliott97fd1ba2021-07-21 18:46:06 +0100587
588 return( test_ok );
Paul Elliottd3f82412021-06-16 16:52:21 +0100589}
590
Gilles Peskinee59236f2018-01-27 23:32:46 +0100591/* END_HEADER */
592
593/* BEGIN_DEPENDENCIES
594 * depends_on:MBEDTLS_PSA_CRYPTO_C
595 * END_DEPENDENCIES
596 */
597
598/* BEGIN_CASE */
Gilles Peskinee1f2d7d2018-08-21 14:54:54 +0200599void static_checks( )
600{
601 size_t max_truncated_mac_size =
602 PSA_ALG_MAC_TRUNCATION_MASK >> PSA_MAC_TRUNCATION_OFFSET;
603
604 /* Check that the length for a truncated MAC always fits in the algorithm
605 * encoding. The shifted mask is the maximum truncated value. The
606 * untruncated algorithm may be one byte larger. */
607 TEST_ASSERT( PSA_MAC_MAX_SIZE <= 1 + max_truncated_mac_size );
608}
609/* END_CASE */
610
611/* BEGIN_CASE */
Gilles Peskine6edfa292019-07-31 15:53:45 +0200612void import_with_policy( int type_arg,
613 int usage_arg, int alg_arg,
614 int expected_status_arg )
615{
616 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
617 psa_key_attributes_t got_attributes = PSA_KEY_ATTRIBUTES_INIT;
Ronald Cron5425a212020-08-04 14:58:35 +0200618 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine6edfa292019-07-31 15:53:45 +0200619 psa_key_type_t type = type_arg;
620 psa_key_usage_t usage = usage_arg;
621 psa_algorithm_t alg = alg_arg;
622 psa_status_t expected_status = expected_status_arg;
623 const uint8_t key_material[16] = {0};
624 psa_status_t status;
625
626 PSA_ASSERT( psa_crypto_init( ) );
627
628 psa_set_key_type( &attributes, type );
629 psa_set_key_usage_flags( &attributes, usage );
630 psa_set_key_algorithm( &attributes, alg );
631
632 status = psa_import_key( &attributes,
633 key_material, sizeof( key_material ),
Ronald Cron5425a212020-08-04 14:58:35 +0200634 &key );
Gilles Peskine6edfa292019-07-31 15:53:45 +0200635 TEST_EQUAL( status, expected_status );
636 if( status != PSA_SUCCESS )
637 goto exit;
638
Ronald Cron5425a212020-08-04 14:58:35 +0200639 PSA_ASSERT( psa_get_key_attributes( key, &got_attributes ) );
Gilles Peskine6edfa292019-07-31 15:53:45 +0200640 TEST_EQUAL( psa_get_key_type( &got_attributes ), type );
gabor-mezei-arm4ff73032021-05-13 12:05:01 +0200641 TEST_EQUAL( psa_get_key_usage_flags( &got_attributes ),
gabor-mezei-arm98a34352021-06-28 14:05:00 +0200642 mbedtls_test_update_key_usage_flags( usage ) );
Gilles Peskine6edfa292019-07-31 15:53:45 +0200643 TEST_EQUAL( psa_get_key_algorithm( &got_attributes ), alg );
Gilles Peskine5fe5e272019-08-02 20:30:01 +0200644 ASSERT_NO_SLOT_NUMBER( &got_attributes );
Gilles Peskine6edfa292019-07-31 15:53:45 +0200645
Ronald Cron5425a212020-08-04 14:58:35 +0200646 PSA_ASSERT( psa_destroy_key( key ) );
647 test_operations_on_invalid_key( key );
Gilles Peskine6edfa292019-07-31 15:53:45 +0200648
649exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +0100650 /*
651 * Key attributes may have been returned by psa_get_key_attributes()
652 * thus reset them as required.
653 */
Gilles Peskine6edfa292019-07-31 15:53:45 +0200654 psa_reset_key_attributes( &got_attributes );
Ronald Cron3a4f0e32020-11-19 17:55:23 +0100655
656 psa_destroy_key( key );
Gilles Peskine6edfa292019-07-31 15:53:45 +0200657 PSA_DONE( );
658}
659/* END_CASE */
660
661/* BEGIN_CASE */
662void import_with_data( data_t *data, int type_arg,
663 int attr_bits_arg,
664 int expected_status_arg )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +0200665{
666 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
667 psa_key_attributes_t got_attributes = PSA_KEY_ATTRIBUTES_INIT;
Ronald Cron5425a212020-08-04 14:58:35 +0200668 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +0200669 psa_key_type_t type = type_arg;
Gilles Peskine8fb3a9e2019-05-03 16:59:21 +0200670 size_t attr_bits = attr_bits_arg;
Gilles Peskineb866e2b2018-06-21 09:25:10 +0200671 psa_status_t expected_status = expected_status_arg;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100672 psa_status_t status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100673
Gilles Peskine8817f612018-12-18 00:18:46 +0100674 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100675
Gilles Peskine4747d192019-04-17 15:05:45 +0200676 psa_set_key_type( &attributes, type );
Gilles Peskine8fb3a9e2019-05-03 16:59:21 +0200677 psa_set_key_bits( &attributes, attr_bits );
Gilles Peskine6edfa292019-07-31 15:53:45 +0200678
Ronald Cron5425a212020-08-04 14:58:35 +0200679 status = psa_import_key( &attributes, data->x, data->len, &key );
Gilles Peskinefe11b722018-12-18 00:24:04 +0100680 TEST_EQUAL( status, expected_status );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +0200681 if( status != PSA_SUCCESS )
682 goto exit;
683
Ronald Cron5425a212020-08-04 14:58:35 +0200684 PSA_ASSERT( psa_get_key_attributes( key, &got_attributes ) );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +0200685 TEST_EQUAL( psa_get_key_type( &got_attributes ), type );
Gilles Peskine8fb3a9e2019-05-03 16:59:21 +0200686 if( attr_bits != 0 )
Gilles Peskine7e0cff92019-07-30 13:48:52 +0200687 TEST_EQUAL( attr_bits, psa_get_key_bits( &got_attributes ) );
Gilles Peskine5fe5e272019-08-02 20:30:01 +0200688 ASSERT_NO_SLOT_NUMBER( &got_attributes );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +0200689
Ronald Cron5425a212020-08-04 14:58:35 +0200690 PSA_ASSERT( psa_destroy_key( key ) );
691 test_operations_on_invalid_key( key );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100692
693exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +0100694 /*
695 * Key attributes may have been returned by psa_get_key_attributes()
696 * thus reset them as required.
697 */
Gilles Peskinea1ace9c2019-04-26 16:03:33 +0200698 psa_reset_key_attributes( &got_attributes );
Ronald Cron3a4f0e32020-11-19 17:55:23 +0100699
700 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +0200701 PSA_DONE( );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100702}
703/* END_CASE */
704
705/* BEGIN_CASE */
Gilles Peskinec744d992019-07-30 17:26:54 +0200706void import_large_key( int type_arg, int byte_size_arg,
707 int expected_status_arg )
708{
709 psa_key_type_t type = type_arg;
710 size_t byte_size = byte_size_arg;
711 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
712 psa_status_t expected_status = expected_status_arg;
Ronald Cron5425a212020-08-04 14:58:35 +0200713 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskinec744d992019-07-30 17:26:54 +0200714 psa_status_t status;
715 uint8_t *buffer = NULL;
716 size_t buffer_size = byte_size + 1;
717 size_t n;
718
Steven Cooreman69967ce2021-01-18 18:01:08 +0100719 /* Skip the test case if the target running the test cannot
720 * accomodate large keys due to heap size constraints */
721 ASSERT_ALLOC_WEAK( buffer, buffer_size );
Gilles Peskinec744d992019-07-30 17:26:54 +0200722 memset( buffer, 'K', byte_size );
723
724 PSA_ASSERT( psa_crypto_init( ) );
725
726 /* Try importing the key */
727 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_EXPORT );
728 psa_set_key_type( &attributes, type );
Ronald Cron5425a212020-08-04 14:58:35 +0200729 status = psa_import_key( &attributes, buffer, byte_size, &key );
Steven Cooreman83fdb702021-01-21 14:24:39 +0100730 TEST_ASSUME( status != PSA_ERROR_INSUFFICIENT_MEMORY );
Gilles Peskinec744d992019-07-30 17:26:54 +0200731 TEST_EQUAL( status, expected_status );
732
733 if( status == PSA_SUCCESS )
734 {
Ronald Cron5425a212020-08-04 14:58:35 +0200735 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
Gilles Peskinec744d992019-07-30 17:26:54 +0200736 TEST_EQUAL( psa_get_key_type( &attributes ), type );
737 TEST_EQUAL( psa_get_key_bits( &attributes ),
738 PSA_BYTES_TO_BITS( byte_size ) );
Gilles Peskine5fe5e272019-08-02 20:30:01 +0200739 ASSERT_NO_SLOT_NUMBER( &attributes );
Gilles Peskinec744d992019-07-30 17:26:54 +0200740 memset( buffer, 0, byte_size + 1 );
Ronald Cron5425a212020-08-04 14:58:35 +0200741 PSA_ASSERT( psa_export_key( key, buffer, byte_size, &n ) );
Gilles Peskinec744d992019-07-30 17:26:54 +0200742 for( n = 0; n < byte_size; n++ )
743 TEST_EQUAL( buffer[n], 'K' );
744 for( n = byte_size; n < buffer_size; n++ )
745 TEST_EQUAL( buffer[n], 0 );
746 }
747
748exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +0100749 /*
750 * Key attributes may have been returned by psa_get_key_attributes()
751 * thus reset them as required.
752 */
753 psa_reset_key_attributes( &attributes );
754
Ronald Cron5425a212020-08-04 14:58:35 +0200755 psa_destroy_key( key );
Gilles Peskinec744d992019-07-30 17:26:54 +0200756 PSA_DONE( );
757 mbedtls_free( buffer );
758}
759/* END_CASE */
760
761/* BEGIN_CASE */
Gilles Peskine0b352bc2018-06-28 00:16:11 +0200762void import_rsa_made_up( int bits_arg, int keypair, int expected_status_arg )
763{
Ronald Cron5425a212020-08-04 14:58:35 +0200764 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine0b352bc2018-06-28 00:16:11 +0200765 size_t bits = bits_arg;
766 psa_status_t expected_status = expected_status_arg;
767 psa_status_t status;
768 psa_key_type_t type =
Gilles Peskinec93b80c2019-05-16 19:39:54 +0200769 keypair ? PSA_KEY_TYPE_RSA_KEY_PAIR : PSA_KEY_TYPE_RSA_PUBLIC_KEY;
Gilles Peskine0b352bc2018-06-28 00:16:11 +0200770 size_t buffer_size = /* Slight overapproximations */
771 keypair ? bits * 9 / 16 + 80 : bits / 8 + 20;
Gilles Peskine8cebbba2018-09-27 13:54:18 +0200772 unsigned char *buffer = NULL;
Gilles Peskine0b352bc2018-06-28 00:16:11 +0200773 unsigned char *p;
774 int ret;
775 size_t length;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +0200776 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine0b352bc2018-06-28 00:16:11 +0200777
Gilles Peskine8817f612018-12-18 00:18:46 +0100778 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine8cebbba2018-09-27 13:54:18 +0200779 ASSERT_ALLOC( buffer, buffer_size );
Gilles Peskine0b352bc2018-06-28 00:16:11 +0200780
781 TEST_ASSERT( ( ret = construct_fake_rsa_key( buffer, buffer_size, &p,
782 bits, keypair ) ) >= 0 );
783 length = ret;
784
785 /* Try importing the key */
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +0200786 psa_set_key_type( &attributes, type );
Ronald Cron5425a212020-08-04 14:58:35 +0200787 status = psa_import_key( &attributes, p, length, &key );
Gilles Peskinefe11b722018-12-18 00:24:04 +0100788 TEST_EQUAL( status, expected_status );
Gilles Peskine76b29a72019-05-28 14:08:50 +0200789
Gilles Peskine0b352bc2018-06-28 00:16:11 +0200790 if( status == PSA_SUCCESS )
Ronald Cron5425a212020-08-04 14:58:35 +0200791 PSA_ASSERT( psa_destroy_key( key ) );
Gilles Peskine0b352bc2018-06-28 00:16:11 +0200792
793exit:
794 mbedtls_free( buffer );
Gilles Peskine1153e7b2019-05-28 15:10:21 +0200795 PSA_DONE( );
Gilles Peskine0b352bc2018-06-28 00:16:11 +0200796}
797/* END_CASE */
798
799/* BEGIN_CASE */
itayzafrir3e02b3b2018-06-12 17:06:52 +0300800void import_export( data_t *data,
Moran Pekera964a8f2018-06-04 18:42:36 +0300801 int type_arg,
Gilles Peskine1ecf92c22019-05-24 15:00:06 +0200802 int usage_arg, int alg_arg,
Archana4d7ae1d2021-07-07 02:50:22 +0530803 int lifetime_arg,
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100804 int expected_bits,
805 int export_size_delta,
Gilles Peskineb866e2b2018-06-21 09:25:10 +0200806 int expected_export_status_arg,
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100807 int canonical_input )
808{
Ronald Cron5425a212020-08-04 14:58:35 +0200809 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100810 psa_key_type_t type = type_arg;
Gilles Peskine4abf7412018-06-18 16:35:34 +0200811 psa_algorithm_t alg = alg_arg;
Gilles Peskineb866e2b2018-06-21 09:25:10 +0200812 psa_status_t expected_export_status = expected_export_status_arg;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100813 psa_status_t status;
Archana4d7ae1d2021-07-07 02:50:22 +0530814 psa_key_lifetime_t lifetime = lifetime_arg;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100815 unsigned char *exported = NULL;
816 unsigned char *reexported = NULL;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100817 size_t export_size;
Jaeden Amerof24c7f82018-06-27 17:20:43 +0100818 size_t exported_length = INVALID_EXPORT_LENGTH;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100819 size_t reexported_length;
Gilles Peskine4747d192019-04-17 15:05:45 +0200820 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +0200821 psa_key_attributes_t got_attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100822
Moran Pekercb088e72018-07-17 17:36:59 +0300823 export_size = (ptrdiff_t) data->len + export_size_delta;
Gilles Peskine8cebbba2018-09-27 13:54:18 +0200824 ASSERT_ALLOC( exported, export_size );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100825 if( ! canonical_input )
Gilles Peskine8cebbba2018-09-27 13:54:18 +0200826 ASSERT_ALLOC( reexported, export_size );
Gilles Peskine8817f612018-12-18 00:18:46 +0100827 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100828
Archana4d7ae1d2021-07-07 02:50:22 +0530829 psa_set_key_lifetime( &attributes, lifetime );
Gilles Peskine4747d192019-04-17 15:05:45 +0200830 psa_set_key_usage_flags( &attributes, usage_arg );
831 psa_set_key_algorithm( &attributes, alg );
832 psa_set_key_type( &attributes, type );
mohammad1603a97cb8c2018-03-28 03:46:26 -0700833
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100834 /* Import the key */
Ronald Cron5425a212020-08-04 14:58:35 +0200835 PSA_ASSERT( psa_import_key( &attributes, data->x, data->len, &key ) );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100836
837 /* Test the key information */
Ronald Cron5425a212020-08-04 14:58:35 +0200838 PSA_ASSERT( psa_get_key_attributes( key, &got_attributes ) );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +0200839 TEST_EQUAL( psa_get_key_type( &got_attributes ), type );
840 TEST_EQUAL( psa_get_key_bits( &got_attributes ), (size_t) expected_bits );
Gilles Peskine5fe5e272019-08-02 20:30:01 +0200841 ASSERT_NO_SLOT_NUMBER( &got_attributes );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100842
843 /* Export the key */
Ronald Cron5425a212020-08-04 14:58:35 +0200844 status = psa_export_key( key, exported, export_size, &exported_length );
Gilles Peskinefe11b722018-12-18 00:24:04 +0100845 TEST_EQUAL( status, expected_export_status );
Jaeden Amerof24c7f82018-06-27 17:20:43 +0100846
847 /* The exported length must be set by psa_export_key() to a value between 0
848 * and export_size. On errors, the exported length must be 0. */
849 TEST_ASSERT( exported_length != INVALID_EXPORT_LENGTH );
850 TEST_ASSERT( status == PSA_SUCCESS || exported_length == 0 );
851 TEST_ASSERT( exported_length <= export_size );
852
Gilles Peskinea7aa4422018-08-14 15:17:54 +0200853 TEST_ASSERT( mem_is_char( exported + exported_length, 0,
Gilles Peskine3f669c32018-06-21 09:21:51 +0200854 export_size - exported_length ) );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100855 if( status != PSA_SUCCESS )
Gilles Peskinee66ca3b2018-06-20 00:11:45 +0200856 {
Gilles Peskinefe11b722018-12-18 00:24:04 +0100857 TEST_EQUAL( exported_length, 0 );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100858 goto destroy;
Gilles Peskinee66ca3b2018-06-20 00:11:45 +0200859 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100860
Gilles Peskineea38a922021-02-13 00:05:16 +0100861 /* Run sanity checks on the exported key. For non-canonical inputs,
862 * this validates the canonical representations. For canonical inputs,
863 * this doesn't directly validate the implementation, but it still helps
864 * by cross-validating the test data with the sanity check code. */
Archana4d7ae1d2021-07-07 02:50:22 +0530865 if( !psa_key_lifetime_is_external( lifetime ) )
866 {
867 if( ! mbedtls_test_psa_exercise_key( key, usage_arg, 0 ) )
868 goto exit;
869 }
Gilles Peskine8f609232018-08-11 01:24:55 +0200870
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100871 if( canonical_input )
Gilles Peskinebd7dea92018-09-27 13:57:19 +0200872 ASSERT_COMPARE( data->x, data->len, exported, exported_length );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100873 else
874 {
Ronald Cron5425a212020-08-04 14:58:35 +0200875 mbedtls_svc_key_id_t key2 = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine049c7532019-05-15 20:22:09 +0200876 PSA_ASSERT( psa_import_key( &attributes, exported, exported_length,
Ronald Cron5425a212020-08-04 14:58:35 +0200877 &key2 ) );
878 PSA_ASSERT( psa_export_key( key2,
Gilles Peskine8817f612018-12-18 00:18:46 +0100879 reexported,
880 export_size,
881 &reexported_length ) );
Gilles Peskinebd7dea92018-09-27 13:57:19 +0200882 ASSERT_COMPARE( exported, exported_length,
Archana4d7ae1d2021-07-07 02:50:22 +0530883 reexported, reexported_length );
Ronald Cron5425a212020-08-04 14:58:35 +0200884 PSA_ASSERT( psa_destroy_key( key2 ) );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100885 }
gabor-mezei-armceface22021-01-21 12:26:17 +0100886 TEST_ASSERT( exported_length <=
Archana4d7ae1d2021-07-07 02:50:22 +0530887 PSA_EXPORT_KEY_OUTPUT_SIZE( type,
Archana9d17bf42021-09-10 06:22:44 +0530888 psa_get_key_bits( &got_attributes ) ) );
gabor-mezei-armceface22021-01-21 12:26:17 +0100889 TEST_ASSERT( exported_length <= PSA_EXPORT_KEY_PAIR_MAX_SIZE );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100890
891destroy:
892 /* Destroy the key */
Ronald Cron5425a212020-08-04 14:58:35 +0200893 PSA_ASSERT( psa_destroy_key( key ) );
894 test_operations_on_invalid_key( key );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100895
896exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +0100897 /*
898 * Key attributes may have been returned by psa_get_key_attributes()
899 * thus reset them as required.
900 */
901 psa_reset_key_attributes( &got_attributes );
Archana4d7ae1d2021-07-07 02:50:22 +0530902 psa_destroy_key( key ) ;
itayzafrir3e02b3b2018-06-12 17:06:52 +0300903 mbedtls_free( exported );
904 mbedtls_free( reexported );
Gilles Peskine1153e7b2019-05-28 15:10:21 +0200905 PSA_DONE( );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100906}
907/* END_CASE */
Gilles Peskine20035e32018-02-03 22:44:14 +0100908
Moran Pekerf709f4a2018-06-06 17:26:04 +0300909/* BEGIN_CASE */
itayzafrir3e02b3b2018-06-12 17:06:52 +0300910void import_export_public_key( data_t *data,
Gilles Peskine2d277862018-06-18 15:41:12 +0200911 int type_arg,
912 int alg_arg,
Archana4d7ae1d2021-07-07 02:50:22 +0530913 int lifetime_arg,
Gilles Peskine49c25912018-10-29 15:15:31 +0100914 int export_size_delta,
915 int expected_export_status_arg,
916 data_t *expected_public_key )
Moran Pekerf709f4a2018-06-06 17:26:04 +0300917{
Ronald Cron5425a212020-08-04 14:58:35 +0200918 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Moran Pekerf709f4a2018-06-06 17:26:04 +0300919 psa_key_type_t type = type_arg;
Gilles Peskine4abf7412018-06-18 16:35:34 +0200920 psa_algorithm_t alg = alg_arg;
Gilles Peskineb866e2b2018-06-21 09:25:10 +0200921 psa_status_t expected_export_status = expected_export_status_arg;
Moran Pekerf709f4a2018-06-06 17:26:04 +0300922 psa_status_t status;
Archana4d7ae1d2021-07-07 02:50:22 +0530923 psa_key_lifetime_t lifetime = lifetime_arg;
Moran Pekerf709f4a2018-06-06 17:26:04 +0300924 unsigned char *exported = NULL;
Gilles Peskine49c25912018-10-29 15:15:31 +0100925 size_t export_size = expected_public_key->len + export_size_delta;
Jaeden Amero2a671e92018-06-27 17:47:40 +0100926 size_t exported_length = INVALID_EXPORT_LENGTH;
Gilles Peskine4747d192019-04-17 15:05:45 +0200927 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Moran Pekerf709f4a2018-06-06 17:26:04 +0300928
Gilles Peskine8817f612018-12-18 00:18:46 +0100929 PSA_ASSERT( psa_crypto_init( ) );
Moran Pekerf709f4a2018-06-06 17:26:04 +0300930
Archana4d7ae1d2021-07-07 02:50:22 +0530931 psa_set_key_lifetime( &attributes, lifetime );
Gilles Peskine4747d192019-04-17 15:05:45 +0200932 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_EXPORT );
933 psa_set_key_algorithm( &attributes, alg );
934 psa_set_key_type( &attributes, type );
Moran Pekerf709f4a2018-06-06 17:26:04 +0300935
936 /* Import the key */
Ronald Cron5425a212020-08-04 14:58:35 +0200937 PSA_ASSERT( psa_import_key( &attributes, data->x, data->len, &key ) );
Moran Pekerf709f4a2018-06-06 17:26:04 +0300938
Gilles Peskine49c25912018-10-29 15:15:31 +0100939 /* Export the public key */
940 ASSERT_ALLOC( exported, export_size );
Ronald Cron5425a212020-08-04 14:58:35 +0200941 status = psa_export_public_key( key,
Gilles Peskine2d277862018-06-18 15:41:12 +0200942 exported, export_size,
943 &exported_length );
Gilles Peskinefe11b722018-12-18 00:24:04 +0100944 TEST_EQUAL( status, expected_export_status );
Gilles Peskine49c25912018-10-29 15:15:31 +0100945 if( status == PSA_SUCCESS )
Gilles Peskined8b7d4f2018-10-29 15:18:41 +0100946 {
Gilles Peskinec93b80c2019-05-16 19:39:54 +0200947 psa_key_type_t public_type = PSA_KEY_TYPE_PUBLIC_KEY_OF_KEY_PAIR( type );
Gilles Peskined8b7d4f2018-10-29 15:18:41 +0100948 size_t bits;
Ronald Cron5425a212020-08-04 14:58:35 +0200949 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +0200950 bits = psa_get_key_bits( &attributes );
Gilles Peskined8b7d4f2018-10-29 15:18:41 +0100951 TEST_ASSERT( expected_public_key->len <=
gabor-mezei-armcbcec212020-12-18 14:23:51 +0100952 PSA_EXPORT_KEY_OUTPUT_SIZE( public_type, bits ) );
gabor-mezei-armceface22021-01-21 12:26:17 +0100953 TEST_ASSERT( expected_public_key->len <=
954 PSA_EXPORT_PUBLIC_KEY_OUTPUT_SIZE( public_type, bits ) );
955 TEST_ASSERT( expected_public_key->len <=
956 PSA_EXPORT_PUBLIC_KEY_MAX_SIZE );
Gilles Peskine49c25912018-10-29 15:15:31 +0100957 ASSERT_COMPARE( expected_public_key->x, expected_public_key->len,
958 exported, exported_length );
Gilles Peskined8b7d4f2018-10-29 15:18:41 +0100959 }
Moran Pekerf709f4a2018-06-06 17:26:04 +0300960exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +0100961 /*
962 * Key attributes may have been returned by psa_get_key_attributes()
963 * thus reset them as required.
964 */
965 psa_reset_key_attributes( &attributes );
966
itayzafrir3e02b3b2018-06-12 17:06:52 +0300967 mbedtls_free( exported );
Ronald Cron5425a212020-08-04 14:58:35 +0200968 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +0200969 PSA_DONE( );
Moran Pekerf709f4a2018-06-06 17:26:04 +0300970}
971/* END_CASE */
972
Gilles Peskine20035e32018-02-03 22:44:14 +0100973/* BEGIN_CASE */
Gilles Peskinea680c7a2018-06-26 16:12:43 +0200974void import_and_exercise_key( data_t *data,
975 int type_arg,
976 int bits_arg,
977 int alg_arg )
978{
Ronald Cron5425a212020-08-04 14:58:35 +0200979 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskinea680c7a2018-06-26 16:12:43 +0200980 psa_key_type_t type = type_arg;
981 size_t bits = bits_arg;
982 psa_algorithm_t alg = alg_arg;
Gilles Peskinec18e25f2021-02-12 23:48:20 +0100983 psa_key_usage_t usage = mbedtls_test_psa_usage_to_exercise( type, alg );
Gilles Peskine4747d192019-04-17 15:05:45 +0200984 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +0200985 psa_key_attributes_t got_attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskinea680c7a2018-06-26 16:12:43 +0200986
Gilles Peskine8817f612018-12-18 00:18:46 +0100987 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskinea680c7a2018-06-26 16:12:43 +0200988
Gilles Peskine4747d192019-04-17 15:05:45 +0200989 psa_set_key_usage_flags( &attributes, usage );
990 psa_set_key_algorithm( &attributes, alg );
991 psa_set_key_type( &attributes, type );
Gilles Peskinea680c7a2018-06-26 16:12:43 +0200992
993 /* Import the key */
Ronald Cron5425a212020-08-04 14:58:35 +0200994 PSA_ASSERT( psa_import_key( &attributes, data->x, data->len, &key ) );
Gilles Peskinea680c7a2018-06-26 16:12:43 +0200995
996 /* Test the key information */
Ronald Cron5425a212020-08-04 14:58:35 +0200997 PSA_ASSERT( psa_get_key_attributes( key, &got_attributes ) );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +0200998 TEST_EQUAL( psa_get_key_type( &got_attributes ), type );
999 TEST_EQUAL( psa_get_key_bits( &got_attributes ), bits );
Gilles Peskinea680c7a2018-06-26 16:12:43 +02001000
1001 /* Do something with the key according to its type and permitted usage. */
Gilles Peskinec18e25f2021-02-12 23:48:20 +01001002 if( ! mbedtls_test_psa_exercise_key( key, usage, alg ) )
Gilles Peskine02b75072018-07-01 22:31:34 +02001003 goto exit;
Gilles Peskinea680c7a2018-06-26 16:12:43 +02001004
Ronald Cron5425a212020-08-04 14:58:35 +02001005 PSA_ASSERT( psa_destroy_key( key ) );
1006 test_operations_on_invalid_key( key );
Gilles Peskine4cf3a432019-04-18 22:28:52 +02001007
Gilles Peskinea680c7a2018-06-26 16:12:43 +02001008exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +01001009 /*
1010 * Key attributes may have been returned by psa_get_key_attributes()
1011 * thus reset them as required.
1012 */
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02001013 psa_reset_key_attributes( &got_attributes );
Ronald Cron3a4f0e32020-11-19 17:55:23 +01001014
1015 psa_reset_key_attributes( &attributes );
1016 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02001017 PSA_DONE( );
Gilles Peskinea680c7a2018-06-26 16:12:43 +02001018}
1019/* END_CASE */
1020
1021/* BEGIN_CASE */
Gilles Peskine06c28892019-11-26 18:07:46 +01001022void effective_key_attributes( int type_arg, int expected_type_arg,
1023 int bits_arg, int expected_bits_arg,
1024 int usage_arg, int expected_usage_arg,
1025 int alg_arg, int expected_alg_arg )
Gilles Peskined5b33222018-06-18 22:20:03 +02001026{
Ronald Cron5425a212020-08-04 14:58:35 +02001027 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine1a960492019-11-26 17:12:21 +01001028 psa_key_type_t key_type = type_arg;
Gilles Peskine06c28892019-11-26 18:07:46 +01001029 psa_key_type_t expected_key_type = expected_type_arg;
Gilles Peskine1a960492019-11-26 17:12:21 +01001030 size_t bits = bits_arg;
Gilles Peskine06c28892019-11-26 18:07:46 +01001031 size_t expected_bits = expected_bits_arg;
Gilles Peskined5b33222018-06-18 22:20:03 +02001032 psa_algorithm_t alg = alg_arg;
Gilles Peskine06c28892019-11-26 18:07:46 +01001033 psa_algorithm_t expected_alg = expected_alg_arg;
Gilles Peskined5b33222018-06-18 22:20:03 +02001034 psa_key_usage_t usage = usage_arg;
Gilles Peskine06c28892019-11-26 18:07:46 +01001035 psa_key_usage_t expected_usage = expected_usage_arg;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001036 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskined5b33222018-06-18 22:20:03 +02001037
Gilles Peskine8817f612018-12-18 00:18:46 +01001038 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskined5b33222018-06-18 22:20:03 +02001039
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001040 psa_set_key_usage_flags( &attributes, usage );
1041 psa_set_key_algorithm( &attributes, alg );
1042 psa_set_key_type( &attributes, key_type );
Gilles Peskine1a960492019-11-26 17:12:21 +01001043 psa_set_key_bits( &attributes, bits );
Gilles Peskined5b33222018-06-18 22:20:03 +02001044
Ronald Cron5425a212020-08-04 14:58:35 +02001045 PSA_ASSERT( psa_generate_key( &attributes, &key ) );
Gilles Peskine1a960492019-11-26 17:12:21 +01001046 psa_reset_key_attributes( &attributes );
Gilles Peskined5b33222018-06-18 22:20:03 +02001047
Ronald Cron5425a212020-08-04 14:58:35 +02001048 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
Gilles Peskine06c28892019-11-26 18:07:46 +01001049 TEST_EQUAL( psa_get_key_type( &attributes ), expected_key_type );
1050 TEST_EQUAL( psa_get_key_bits( &attributes ), expected_bits );
1051 TEST_EQUAL( psa_get_key_usage_flags( &attributes ), expected_usage );
1052 TEST_EQUAL( psa_get_key_algorithm( &attributes ), expected_alg );
Gilles Peskined5b33222018-06-18 22:20:03 +02001053
1054exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +01001055 /*
1056 * Key attributes may have been returned by psa_get_key_attributes()
1057 * thus reset them as required.
1058 */
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02001059 psa_reset_key_attributes( &attributes );
Ronald Cron3a4f0e32020-11-19 17:55:23 +01001060
1061 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02001062 PSA_DONE( );
Gilles Peskined5b33222018-06-18 22:20:03 +02001063}
1064/* END_CASE */
1065
1066/* BEGIN_CASE */
Gilles Peskine06c28892019-11-26 18:07:46 +01001067void check_key_policy( int type_arg, int bits_arg,
1068 int usage_arg, int alg_arg )
1069{
1070 test_effective_key_attributes( type_arg, type_arg, bits_arg, bits_arg,
gabor-mezei-armff8264c2021-06-28 14:36:03 +02001071 usage_arg,
1072 mbedtls_test_update_key_usage_flags( usage_arg ),
gabor-mezei-armedf2df82021-05-13 16:17:16 +02001073 alg_arg, alg_arg );
Gilles Peskine06c28892019-11-26 18:07:46 +01001074 goto exit;
1075}
1076/* END_CASE */
1077
1078/* BEGIN_CASE */
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001079void key_attributes_init( )
Jaeden Amero70261c52019-01-04 11:47:20 +00001080{
1081 /* Test each valid way of initializing the object, except for `= {0}`, as
1082 * Clang 5 complains when `-Wmissing-field-initializers` is used, even
1083 * though it's OK by the C standard. We could test for this, but we'd need
1084 * to supress the Clang warning for the test. */
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001085 psa_key_attributes_t func = psa_key_attributes_init( );
1086 psa_key_attributes_t init = PSA_KEY_ATTRIBUTES_INIT;
1087 psa_key_attributes_t zero;
Jaeden Amero70261c52019-01-04 11:47:20 +00001088
1089 memset( &zero, 0, sizeof( zero ) );
1090
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001091 TEST_EQUAL( psa_get_key_lifetime( &func ), PSA_KEY_LIFETIME_VOLATILE );
1092 TEST_EQUAL( psa_get_key_lifetime( &init ), PSA_KEY_LIFETIME_VOLATILE );
1093 TEST_EQUAL( psa_get_key_lifetime( &zero ), PSA_KEY_LIFETIME_VOLATILE );
Jaeden Amero5229bbb2019-02-07 16:33:37 +00001094
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001095 TEST_EQUAL( psa_get_key_type( &func ), 0 );
1096 TEST_EQUAL( psa_get_key_type( &init ), 0 );
1097 TEST_EQUAL( psa_get_key_type( &zero ), 0 );
1098
1099 TEST_EQUAL( psa_get_key_bits( &func ), 0 );
1100 TEST_EQUAL( psa_get_key_bits( &init ), 0 );
1101 TEST_EQUAL( psa_get_key_bits( &zero ), 0 );
1102
1103 TEST_EQUAL( psa_get_key_usage_flags( &func ), 0 );
1104 TEST_EQUAL( psa_get_key_usage_flags( &init ), 0 );
1105 TEST_EQUAL( psa_get_key_usage_flags( &zero ), 0 );
1106
1107 TEST_EQUAL( psa_get_key_algorithm( &func ), 0 );
1108 TEST_EQUAL( psa_get_key_algorithm( &init ), 0 );
1109 TEST_EQUAL( psa_get_key_algorithm( &zero ), 0 );
Jaeden Amero70261c52019-01-04 11:47:20 +00001110}
1111/* END_CASE */
1112
1113/* BEGIN_CASE */
gabor-mezei-armedf2df82021-05-13 16:17:16 +02001114void mac_key_policy( int policy_usage_arg,
1115 int policy_alg_arg,
1116 int key_type_arg,
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001117 data_t *key_data,
gabor-mezei-armedf2df82021-05-13 16:17:16 +02001118 int exercise_alg_arg,
Mateusz Starzykd07f4fc2021-08-24 11:01:23 +02001119 int expected_status_sign_arg,
1120 int expected_status_verify_arg )
Gilles Peskined5b33222018-06-18 22:20:03 +02001121{
Ronald Cron5425a212020-08-04 14:58:35 +02001122 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001123 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Jaeden Amero769ce272019-01-04 11:48:03 +00001124 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
gabor-mezei-armedf2df82021-05-13 16:17:16 +02001125 psa_key_type_t key_type = key_type_arg;
1126 psa_algorithm_t policy_alg = policy_alg_arg;
1127 psa_algorithm_t exercise_alg = exercise_alg_arg;
1128 psa_key_usage_t policy_usage = policy_usage_arg;
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001129 psa_status_t status;
Mateusz Starzykd07f4fc2021-08-24 11:01:23 +02001130 psa_status_t expected_status_sign = expected_status_sign_arg;
1131 psa_status_t expected_status_verify = expected_status_verify_arg;
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001132 unsigned char mac[PSA_MAC_MAX_SIZE];
Gilles Peskined5b33222018-06-18 22:20:03 +02001133
Gilles Peskine8817f612018-12-18 00:18:46 +01001134 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskined5b33222018-06-18 22:20:03 +02001135
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001136 psa_set_key_usage_flags( &attributes, policy_usage );
1137 psa_set_key_algorithm( &attributes, policy_alg );
1138 psa_set_key_type( &attributes, key_type );
Gilles Peskined5b33222018-06-18 22:20:03 +02001139
Gilles Peskine049c7532019-05-15 20:22:09 +02001140 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02001141 &key ) );
Gilles Peskined5b33222018-06-18 22:20:03 +02001142
gabor-mezei-arm40d5cd82021-06-29 11:06:16 +02001143 TEST_EQUAL( psa_get_key_usage_flags( &attributes ),
1144 mbedtls_test_update_key_usage_flags( policy_usage ) );
gabor-mezei-armedf2df82021-05-13 16:17:16 +02001145
Ronald Cron5425a212020-08-04 14:58:35 +02001146 status = psa_mac_sign_setup( &operation, key, exercise_alg );
Mateusz Starzykd07f4fc2021-08-24 11:01:23 +02001147 TEST_EQUAL( status, expected_status_sign );
Steven Cooremanb3ce8152021-02-18 12:03:50 +01001148
Mateusz Starzyk1ebcd552021-08-30 17:09:03 +02001149 /* Calculate the MAC, one-shot case. */
1150 uint8_t input[128] = {0};
1151 size_t mac_len;
1152 TEST_EQUAL( psa_mac_compute( key, exercise_alg,
1153 input, 128,
1154 mac, PSA_MAC_MAX_SIZE, &mac_len ),
1155 expected_status_sign );
1156
1157 /* Verify correct MAC, one-shot case. */
1158 status = psa_mac_verify( key, exercise_alg, input, 128,
1159 mac, mac_len );
1160
1161 if( expected_status_sign != PSA_SUCCESS && expected_status_verify == PSA_SUCCESS )
1162 TEST_EQUAL( status, PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine8817f612018-12-18 00:18:46 +01001163 else
Mateusz Starzyk1ebcd552021-08-30 17:09:03 +02001164 TEST_EQUAL( status, expected_status_verify );
Gilles Peskinefe11b722018-12-18 00:24:04 +01001165
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001166 psa_mac_abort( &operation );
Gilles Peskined5b33222018-06-18 22:20:03 +02001167
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001168 memset( mac, 0, sizeof( mac ) );
Ronald Cron5425a212020-08-04 14:58:35 +02001169 status = psa_mac_verify_setup( &operation, key, exercise_alg );
Mateusz Starzykd07f4fc2021-08-24 11:01:23 +02001170 TEST_EQUAL( status, expected_status_verify );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001171
1172exit:
1173 psa_mac_abort( &operation );
Ronald Cron5425a212020-08-04 14:58:35 +02001174 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02001175 PSA_DONE( );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001176}
1177/* END_CASE */
1178
1179/* BEGIN_CASE */
gabor-mezei-armedf2df82021-05-13 16:17:16 +02001180void cipher_key_policy( int policy_usage_arg,
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001181 int policy_alg,
1182 int key_type,
1183 data_t *key_data,
1184 int exercise_alg )
1185{
Ronald Cron5425a212020-08-04 14:58:35 +02001186 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001187 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Jaeden Amero5bae2272019-01-04 11:48:27 +00001188 psa_cipher_operation_t operation = PSA_CIPHER_OPERATION_INIT;
gabor-mezei-armedf2df82021-05-13 16:17:16 +02001189 psa_key_usage_t policy_usage = policy_usage_arg;
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001190 psa_status_t status;
1191
Gilles Peskine8817f612018-12-18 00:18:46 +01001192 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001193
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001194 psa_set_key_usage_flags( &attributes, policy_usage );
1195 psa_set_key_algorithm( &attributes, policy_alg );
1196 psa_set_key_type( &attributes, key_type );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001197
Gilles Peskine049c7532019-05-15 20:22:09 +02001198 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02001199 &key ) );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001200
gabor-mezei-arm98a34352021-06-28 14:05:00 +02001201 /* Check if no key usage flag implication is done */
1202 TEST_EQUAL( policy_usage,
1203 mbedtls_test_update_key_usage_flags( policy_usage ) );
gabor-mezei-armedf2df82021-05-13 16:17:16 +02001204
Ronald Cron5425a212020-08-04 14:58:35 +02001205 status = psa_cipher_encrypt_setup( &operation, key, exercise_alg );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001206 if( policy_alg == exercise_alg &&
1207 ( policy_usage & PSA_KEY_USAGE_ENCRYPT ) != 0 )
Gilles Peskine8817f612018-12-18 00:18:46 +01001208 PSA_ASSERT( status );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001209 else
Gilles Peskinefe11b722018-12-18 00:24:04 +01001210 TEST_EQUAL( status, PSA_ERROR_NOT_PERMITTED );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001211 psa_cipher_abort( &operation );
1212
Ronald Cron5425a212020-08-04 14:58:35 +02001213 status = psa_cipher_decrypt_setup( &operation, key, exercise_alg );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001214 if( policy_alg == exercise_alg &&
1215 ( policy_usage & PSA_KEY_USAGE_DECRYPT ) != 0 )
Gilles Peskine8817f612018-12-18 00:18:46 +01001216 PSA_ASSERT( status );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001217 else
Gilles Peskinefe11b722018-12-18 00:24:04 +01001218 TEST_EQUAL( status, PSA_ERROR_NOT_PERMITTED );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001219
1220exit:
1221 psa_cipher_abort( &operation );
Ronald Cron5425a212020-08-04 14:58:35 +02001222 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02001223 PSA_DONE( );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001224}
1225/* END_CASE */
1226
1227/* BEGIN_CASE */
gabor-mezei-armedf2df82021-05-13 16:17:16 +02001228void aead_key_policy( int policy_usage_arg,
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001229 int policy_alg,
1230 int key_type,
1231 data_t *key_data,
1232 int nonce_length_arg,
1233 int tag_length_arg,
Steven Cooremanb3ce8152021-02-18 12:03:50 +01001234 int exercise_alg,
1235 int expected_status_arg )
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001236{
Ronald Cron5425a212020-08-04 14:58:35 +02001237 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001238 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
gabor-mezei-armedf2df82021-05-13 16:17:16 +02001239 psa_key_usage_t policy_usage = policy_usage_arg;
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001240 psa_status_t status;
Steven Cooremanb3ce8152021-02-18 12:03:50 +01001241 psa_status_t expected_status = expected_status_arg;
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001242 unsigned char nonce[16] = {0};
1243 size_t nonce_length = nonce_length_arg;
1244 unsigned char tag[16];
1245 size_t tag_length = tag_length_arg;
1246 size_t output_length;
1247
1248 TEST_ASSERT( nonce_length <= sizeof( nonce ) );
1249 TEST_ASSERT( tag_length <= sizeof( tag ) );
1250
Gilles Peskine8817f612018-12-18 00:18:46 +01001251 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001252
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001253 psa_set_key_usage_flags( &attributes, policy_usage );
1254 psa_set_key_algorithm( &attributes, policy_alg );
1255 psa_set_key_type( &attributes, key_type );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001256
Gilles Peskine049c7532019-05-15 20:22:09 +02001257 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02001258 &key ) );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001259
gabor-mezei-arm98a34352021-06-28 14:05:00 +02001260 /* Check if no key usage implication is done */
1261 TEST_EQUAL( policy_usage,
1262 mbedtls_test_update_key_usage_flags( policy_usage ) );
gabor-mezei-armedf2df82021-05-13 16:17:16 +02001263
Ronald Cron5425a212020-08-04 14:58:35 +02001264 status = psa_aead_encrypt( key, exercise_alg,
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001265 nonce, nonce_length,
1266 NULL, 0,
1267 NULL, 0,
1268 tag, tag_length,
1269 &output_length );
Steven Cooremanb3ce8152021-02-18 12:03:50 +01001270 if( ( policy_usage & PSA_KEY_USAGE_ENCRYPT ) != 0 )
1271 TEST_EQUAL( status, expected_status );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001272 else
Gilles Peskinefe11b722018-12-18 00:24:04 +01001273 TEST_EQUAL( status, PSA_ERROR_NOT_PERMITTED );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001274
1275 memset( tag, 0, sizeof( tag ) );
Ronald Cron5425a212020-08-04 14:58:35 +02001276 status = psa_aead_decrypt( key, exercise_alg,
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001277 nonce, nonce_length,
1278 NULL, 0,
1279 tag, tag_length,
1280 NULL, 0,
1281 &output_length );
Steven Cooremanb3ce8152021-02-18 12:03:50 +01001282 if( ( policy_usage & PSA_KEY_USAGE_DECRYPT ) == 0 )
1283 TEST_EQUAL( status, PSA_ERROR_NOT_PERMITTED );
1284 else if( expected_status == PSA_SUCCESS )
Gilles Peskinefe11b722018-12-18 00:24:04 +01001285 TEST_EQUAL( status, PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001286 else
Steven Cooremanb3ce8152021-02-18 12:03:50 +01001287 TEST_EQUAL( status, expected_status );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001288
1289exit:
Ronald Cron5425a212020-08-04 14:58:35 +02001290 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02001291 PSA_DONE( );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001292}
1293/* END_CASE */
1294
1295/* BEGIN_CASE */
gabor-mezei-armedf2df82021-05-13 16:17:16 +02001296void asymmetric_encryption_key_policy( int policy_usage_arg,
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001297 int policy_alg,
1298 int key_type,
1299 data_t *key_data,
1300 int exercise_alg )
1301{
Ronald Cron5425a212020-08-04 14:58:35 +02001302 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001303 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
gabor-mezei-armedf2df82021-05-13 16:17:16 +02001304 psa_key_usage_t policy_usage = policy_usage_arg;
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001305 psa_status_t status;
1306 size_t key_bits;
1307 size_t buffer_length;
1308 unsigned char *buffer = NULL;
1309 size_t output_length;
1310
Gilles Peskine8817f612018-12-18 00:18:46 +01001311 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001312
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001313 psa_set_key_usage_flags( &attributes, policy_usage );
1314 psa_set_key_algorithm( &attributes, policy_alg );
1315 psa_set_key_type( &attributes, key_type );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001316
Gilles Peskine049c7532019-05-15 20:22:09 +02001317 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02001318 &key ) );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001319
gabor-mezei-arm98a34352021-06-28 14:05:00 +02001320 /* Check if no key usage implication is done */
1321 TEST_EQUAL( policy_usage,
1322 mbedtls_test_update_key_usage_flags( policy_usage ) );
gabor-mezei-armedf2df82021-05-13 16:17:16 +02001323
Ronald Cron5425a212020-08-04 14:58:35 +02001324 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001325 key_bits = psa_get_key_bits( &attributes );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001326 buffer_length = PSA_ASYMMETRIC_ENCRYPT_OUTPUT_SIZE( key_type, key_bits,
1327 exercise_alg );
Gilles Peskine8cebbba2018-09-27 13:54:18 +02001328 ASSERT_ALLOC( buffer, buffer_length );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001329
Ronald Cron5425a212020-08-04 14:58:35 +02001330 status = psa_asymmetric_encrypt( key, exercise_alg,
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001331 NULL, 0,
1332 NULL, 0,
1333 buffer, buffer_length,
1334 &output_length );
1335 if( policy_alg == exercise_alg &&
1336 ( policy_usage & PSA_KEY_USAGE_ENCRYPT ) != 0 )
Gilles Peskine8817f612018-12-18 00:18:46 +01001337 PSA_ASSERT( status );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001338 else
Gilles Peskinefe11b722018-12-18 00:24:04 +01001339 TEST_EQUAL( status, PSA_ERROR_NOT_PERMITTED );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001340
Gilles Peskinef7ab5ad2018-09-26 18:19:24 +02001341 if( buffer_length != 0 )
1342 memset( buffer, 0, buffer_length );
Ronald Cron5425a212020-08-04 14:58:35 +02001343 status = psa_asymmetric_decrypt( key, exercise_alg,
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001344 buffer, buffer_length,
1345 NULL, 0,
1346 buffer, buffer_length,
1347 &output_length );
1348 if( policy_alg == exercise_alg &&
1349 ( policy_usage & PSA_KEY_USAGE_DECRYPT ) != 0 )
Gilles Peskinefe11b722018-12-18 00:24:04 +01001350 TEST_EQUAL( status, PSA_ERROR_INVALID_PADDING );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001351 else
Gilles Peskinefe11b722018-12-18 00:24:04 +01001352 TEST_EQUAL( status, PSA_ERROR_NOT_PERMITTED );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001353
1354exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +01001355 /*
1356 * Key attributes may have been returned by psa_get_key_attributes()
1357 * thus reset them as required.
1358 */
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02001359 psa_reset_key_attributes( &attributes );
Ronald Cron3a4f0e32020-11-19 17:55:23 +01001360
1361 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02001362 PSA_DONE( );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001363 mbedtls_free( buffer );
1364}
1365/* END_CASE */
1366
1367/* BEGIN_CASE */
gabor-mezei-armedf2df82021-05-13 16:17:16 +02001368void asymmetric_signature_key_policy( int policy_usage_arg,
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001369 int policy_alg,
1370 int key_type,
1371 data_t *key_data,
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001372 int exercise_alg,
gabor-mezei-armedf2df82021-05-13 16:17:16 +02001373 int payload_length_arg,
gabor-mezei-armedf2df82021-05-13 16:17:16 +02001374 int expected_usage_arg )
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001375{
Ronald Cron5425a212020-08-04 14:58:35 +02001376 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001377 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
gabor-mezei-armedf2df82021-05-13 16:17:16 +02001378 psa_key_usage_t policy_usage = policy_usage_arg;
1379 psa_key_usage_t expected_usage = expected_usage_arg;
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001380 psa_status_t status;
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001381 unsigned char payload[PSA_HASH_MAX_SIZE] = {1};
1382 /* If `payload_length_arg > 0`, `exercise_alg` is supposed to be
1383 * compatible with the policy and `payload_length_arg` is supposed to be
1384 * a valid input length to sign. If `payload_length_arg <= 0`,
1385 * `exercise_alg` is supposed to be forbidden by the policy. */
1386 int compatible_alg = payload_length_arg > 0;
1387 size_t payload_length = compatible_alg ? payload_length_arg : 0;
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001388 unsigned char signature[PSA_SIGNATURE_MAX_SIZE] = {0};
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001389 size_t signature_length;
1390
gabor-mezei-arm98a34352021-06-28 14:05:00 +02001391 /* Check if all implicit usage flags are deployed
gabor-mezei-armedf2df82021-05-13 16:17:16 +02001392 in the expected usage flags. */
gabor-mezei-arm98a34352021-06-28 14:05:00 +02001393 TEST_EQUAL( expected_usage,
1394 mbedtls_test_update_key_usage_flags( policy_usage ) );
gabor-mezei-armedf2df82021-05-13 16:17:16 +02001395
Gilles Peskine8817f612018-12-18 00:18:46 +01001396 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001397
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001398 psa_set_key_usage_flags( &attributes, policy_usage );
1399 psa_set_key_algorithm( &attributes, policy_alg );
1400 psa_set_key_type( &attributes, key_type );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001401
Gilles Peskine049c7532019-05-15 20:22:09 +02001402 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02001403 &key ) );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001404
gabor-mezei-armedf2df82021-05-13 16:17:16 +02001405 TEST_EQUAL( psa_get_key_usage_flags( &attributes ), expected_usage );
1406
Ronald Cron5425a212020-08-04 14:58:35 +02001407 status = psa_sign_hash( key, exercise_alg,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001408 payload, payload_length,
1409 signature, sizeof( signature ),
1410 &signature_length );
gabor-mezei-armedf2df82021-05-13 16:17:16 +02001411 if( compatible_alg && ( expected_usage & PSA_KEY_USAGE_SIGN_HASH ) != 0 )
Gilles Peskine8817f612018-12-18 00:18:46 +01001412 PSA_ASSERT( status );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001413 else
Gilles Peskinefe11b722018-12-18 00:24:04 +01001414 TEST_EQUAL( status, PSA_ERROR_NOT_PERMITTED );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001415
1416 memset( signature, 0, sizeof( signature ) );
Ronald Cron5425a212020-08-04 14:58:35 +02001417 status = psa_verify_hash( key, exercise_alg,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001418 payload, payload_length,
1419 signature, sizeof( signature ) );
gabor-mezei-armedf2df82021-05-13 16:17:16 +02001420 if( compatible_alg && ( expected_usage & PSA_KEY_USAGE_VERIFY_HASH ) != 0 )
Gilles Peskinefe11b722018-12-18 00:24:04 +01001421 TEST_EQUAL( status, PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine76f5c7b2018-07-06 16:53:09 +02001422 else
Gilles Peskinefe11b722018-12-18 00:24:04 +01001423 TEST_EQUAL( status, PSA_ERROR_NOT_PERMITTED );
Gilles Peskined5b33222018-06-18 22:20:03 +02001424
Gilles Peskinef7b41372021-09-22 16:15:05 +02001425 if( PSA_ALG_IS_SIGN_HASH( exercise_alg ) &&
gabor-mezei-armd851d682021-06-28 14:53:49 +02001426 PSA_ALG_IS_HASH( PSA_ALG_SIGN_GET_HASH( exercise_alg ) ) )
gabor-mezei-armedf2df82021-05-13 16:17:16 +02001427 {
1428 status = psa_sign_message( key, exercise_alg,
1429 payload, payload_length,
1430 signature, sizeof( signature ),
1431 &signature_length );
1432 if( compatible_alg && ( expected_usage & PSA_KEY_USAGE_SIGN_MESSAGE ) != 0 )
1433 PSA_ASSERT( status );
1434 else
1435 TEST_EQUAL( status, PSA_ERROR_NOT_PERMITTED );
1436
1437 memset( signature, 0, sizeof( signature ) );
1438 status = psa_verify_message( key, exercise_alg,
1439 payload, payload_length,
1440 signature, sizeof( signature ) );
1441 if( compatible_alg && ( expected_usage & PSA_KEY_USAGE_VERIFY_MESSAGE ) != 0 )
1442 TEST_EQUAL( status, PSA_ERROR_INVALID_SIGNATURE );
1443 else
1444 TEST_EQUAL( status, PSA_ERROR_NOT_PERMITTED );
1445 }
1446
Gilles Peskined5b33222018-06-18 22:20:03 +02001447exit:
Ronald Cron5425a212020-08-04 14:58:35 +02001448 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02001449 PSA_DONE( );
Gilles Peskined5b33222018-06-18 22:20:03 +02001450}
1451/* END_CASE */
1452
Janos Follathba3fab92019-06-11 14:50:16 +01001453/* BEGIN_CASE */
Gilles Peskineea0fb492018-07-12 17:17:20 +02001454void derive_key_policy( int policy_usage,
1455 int policy_alg,
1456 int key_type,
1457 data_t *key_data,
1458 int exercise_alg )
1459{
Ronald Cron5425a212020-08-04 14:58:35 +02001460 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001461 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02001462 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Gilles Peskineea0fb492018-07-12 17:17:20 +02001463 psa_status_t status;
1464
Gilles Peskine8817f612018-12-18 00:18:46 +01001465 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskineea0fb492018-07-12 17:17:20 +02001466
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001467 psa_set_key_usage_flags( &attributes, policy_usage );
1468 psa_set_key_algorithm( &attributes, policy_alg );
1469 psa_set_key_type( &attributes, key_type );
Gilles Peskineea0fb492018-07-12 17:17:20 +02001470
Gilles Peskine049c7532019-05-15 20:22:09 +02001471 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02001472 &key ) );
Gilles Peskineea0fb492018-07-12 17:17:20 +02001473
Janos Follathba3fab92019-06-11 14:50:16 +01001474 PSA_ASSERT( psa_key_derivation_setup( &operation, exercise_alg ) );
1475
1476 if( PSA_ALG_IS_TLS12_PRF( exercise_alg ) ||
1477 PSA_ALG_IS_TLS12_PSK_TO_MS( exercise_alg ) )
Janos Follath0c1ed842019-06-28 13:35:36 +01001478 {
Janos Follathba3fab92019-06-11 14:50:16 +01001479 PSA_ASSERT( psa_key_derivation_input_bytes(
1480 &operation,
1481 PSA_KEY_DERIVATION_INPUT_SEED,
1482 (const uint8_t*) "", 0) );
Janos Follath0c1ed842019-06-28 13:35:36 +01001483 }
Janos Follathba3fab92019-06-11 14:50:16 +01001484
1485 status = psa_key_derivation_input_key( &operation,
1486 PSA_KEY_DERIVATION_INPUT_SECRET,
Ronald Cron5425a212020-08-04 14:58:35 +02001487 key );
Janos Follathba3fab92019-06-11 14:50:16 +01001488
Gilles Peskineea0fb492018-07-12 17:17:20 +02001489 if( policy_alg == exercise_alg &&
1490 ( policy_usage & PSA_KEY_USAGE_DERIVE ) != 0 )
Gilles Peskine8817f612018-12-18 00:18:46 +01001491 PSA_ASSERT( status );
Gilles Peskineea0fb492018-07-12 17:17:20 +02001492 else
Gilles Peskinefe11b722018-12-18 00:24:04 +01001493 TEST_EQUAL( status, PSA_ERROR_NOT_PERMITTED );
Gilles Peskineea0fb492018-07-12 17:17:20 +02001494
1495exit:
Gilles Peskine51ae0e42019-05-16 17:31:03 +02001496 psa_key_derivation_abort( &operation );
Ronald Cron5425a212020-08-04 14:58:35 +02001497 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02001498 PSA_DONE( );
Gilles Peskineea0fb492018-07-12 17:17:20 +02001499}
1500/* END_CASE */
1501
1502/* BEGIN_CASE */
Gilles Peskine01d718c2018-09-18 12:01:02 +02001503void agreement_key_policy( int policy_usage,
1504 int policy_alg,
1505 int key_type_arg,
1506 data_t *key_data,
Steven Cooremance48e852020-10-05 16:02:45 +02001507 int exercise_alg,
1508 int expected_status_arg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02001509{
Ronald Cron5425a212020-08-04 14:58:35 +02001510 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001511 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine01d718c2018-09-18 12:01:02 +02001512 psa_key_type_t key_type = key_type_arg;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02001513 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Gilles Peskine01d718c2018-09-18 12:01:02 +02001514 psa_status_t status;
Steven Cooremance48e852020-10-05 16:02:45 +02001515 psa_status_t expected_status = expected_status_arg;
Gilles Peskine01d718c2018-09-18 12:01:02 +02001516
Gilles Peskine8817f612018-12-18 00:18:46 +01001517 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine01d718c2018-09-18 12:01:02 +02001518
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001519 psa_set_key_usage_flags( &attributes, policy_usage );
1520 psa_set_key_algorithm( &attributes, policy_alg );
1521 psa_set_key_type( &attributes, key_type );
Gilles Peskine01d718c2018-09-18 12:01:02 +02001522
Gilles Peskine049c7532019-05-15 20:22:09 +02001523 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02001524 &key ) );
Gilles Peskine01d718c2018-09-18 12:01:02 +02001525
Gilles Peskine51ae0e42019-05-16 17:31:03 +02001526 PSA_ASSERT( psa_key_derivation_setup( &operation, exercise_alg ) );
Gilles Peskinec18e25f2021-02-12 23:48:20 +01001527 status = mbedtls_test_psa_key_agreement_with_self( &operation, key );
Gilles Peskine01d718c2018-09-18 12:01:02 +02001528
Steven Cooremance48e852020-10-05 16:02:45 +02001529 TEST_EQUAL( status, expected_status );
Gilles Peskine01d718c2018-09-18 12:01:02 +02001530
1531exit:
Gilles Peskine51ae0e42019-05-16 17:31:03 +02001532 psa_key_derivation_abort( &operation );
Ronald Cron5425a212020-08-04 14:58:35 +02001533 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02001534 PSA_DONE( );
Gilles Peskine01d718c2018-09-18 12:01:02 +02001535}
1536/* END_CASE */
1537
1538/* BEGIN_CASE */
Gilles Peskine96f0b3b2019-05-10 19:33:38 +02001539void key_policy_alg2( int key_type_arg, data_t *key_data,
1540 int usage_arg, int alg_arg, int alg2_arg )
1541{
Ronald Cron5425a212020-08-04 14:58:35 +02001542 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine96f0b3b2019-05-10 19:33:38 +02001543 psa_key_type_t key_type = key_type_arg;
1544 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
1545 psa_key_attributes_t got_attributes = PSA_KEY_ATTRIBUTES_INIT;
1546 psa_key_usage_t usage = usage_arg;
1547 psa_algorithm_t alg = alg_arg;
1548 psa_algorithm_t alg2 = alg2_arg;
1549
1550 PSA_ASSERT( psa_crypto_init( ) );
1551
1552 psa_set_key_usage_flags( &attributes, usage );
1553 psa_set_key_algorithm( &attributes, alg );
1554 psa_set_key_enrollment_algorithm( &attributes, alg2 );
1555 psa_set_key_type( &attributes, key_type );
1556 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02001557 &key ) );
Gilles Peskine96f0b3b2019-05-10 19:33:38 +02001558
gabor-mezei-arm98a34352021-06-28 14:05:00 +02001559 /* Update the usage flags to obtain implicit usage flags */
1560 usage = mbedtls_test_update_key_usage_flags( usage );
Ronald Cron5425a212020-08-04 14:58:35 +02001561 PSA_ASSERT( psa_get_key_attributes( key, &got_attributes ) );
Gilles Peskine96f0b3b2019-05-10 19:33:38 +02001562 TEST_EQUAL( psa_get_key_usage_flags( &got_attributes ), usage );
1563 TEST_EQUAL( psa_get_key_algorithm( &got_attributes ), alg );
1564 TEST_EQUAL( psa_get_key_enrollment_algorithm( &got_attributes ), alg2 );
1565
Gilles Peskinec18e25f2021-02-12 23:48:20 +01001566 if( ! mbedtls_test_psa_exercise_key( key, usage, alg ) )
Gilles Peskine96f0b3b2019-05-10 19:33:38 +02001567 goto exit;
Gilles Peskinec18e25f2021-02-12 23:48:20 +01001568 if( ! mbedtls_test_psa_exercise_key( key, usage, alg2 ) )
Gilles Peskine96f0b3b2019-05-10 19:33:38 +02001569 goto exit;
1570
1571exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +01001572 /*
1573 * Key attributes may have been returned by psa_get_key_attributes()
1574 * thus reset them as required.
1575 */
1576 psa_reset_key_attributes( &got_attributes );
1577
Ronald Cron5425a212020-08-04 14:58:35 +02001578 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02001579 PSA_DONE( );
Gilles Peskine96f0b3b2019-05-10 19:33:38 +02001580}
1581/* END_CASE */
1582
1583/* BEGIN_CASE */
Gilles Peskine04ee2d22019-04-11 21:25:46 +02001584void raw_agreement_key_policy( int policy_usage,
1585 int policy_alg,
1586 int key_type_arg,
1587 data_t *key_data,
Steven Cooremance48e852020-10-05 16:02:45 +02001588 int exercise_alg,
1589 int expected_status_arg )
Gilles Peskine04ee2d22019-04-11 21:25:46 +02001590{
Ronald Cron5425a212020-08-04 14:58:35 +02001591 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001592 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine04ee2d22019-04-11 21:25:46 +02001593 psa_key_type_t key_type = key_type_arg;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02001594 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Gilles Peskine04ee2d22019-04-11 21:25:46 +02001595 psa_status_t status;
Steven Cooremance48e852020-10-05 16:02:45 +02001596 psa_status_t expected_status = expected_status_arg;
Gilles Peskine04ee2d22019-04-11 21:25:46 +02001597
1598 PSA_ASSERT( psa_crypto_init( ) );
1599
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02001600 psa_set_key_usage_flags( &attributes, policy_usage );
1601 psa_set_key_algorithm( &attributes, policy_alg );
1602 psa_set_key_type( &attributes, key_type );
Gilles Peskine04ee2d22019-04-11 21:25:46 +02001603
Gilles Peskine049c7532019-05-15 20:22:09 +02001604 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02001605 &key ) );
Gilles Peskine04ee2d22019-04-11 21:25:46 +02001606
Gilles Peskinec18e25f2021-02-12 23:48:20 +01001607 status = mbedtls_test_psa_raw_key_agreement_with_self( exercise_alg, key );
Gilles Peskine04ee2d22019-04-11 21:25:46 +02001608
Steven Cooremance48e852020-10-05 16:02:45 +02001609 TEST_EQUAL( status, expected_status );
Gilles Peskine04ee2d22019-04-11 21:25:46 +02001610
1611exit:
Gilles Peskine51ae0e42019-05-16 17:31:03 +02001612 psa_key_derivation_abort( &operation );
Ronald Cron5425a212020-08-04 14:58:35 +02001613 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02001614 PSA_DONE( );
Gilles Peskine04ee2d22019-04-11 21:25:46 +02001615}
1616/* END_CASE */
1617
1618/* BEGIN_CASE */
Gilles Peskinebcdd44b2019-05-20 17:28:11 +02001619void copy_success( int source_usage_arg,
1620 int source_alg_arg, int source_alg2_arg,
Archana8a180362021-07-05 02:18:48 +05301621 unsigned int source_lifetime_arg,
Gilles Peskine4a644642019-05-03 17:14:08 +02001622 int type_arg, data_t *material,
1623 int copy_attributes,
Gilles Peskinebcdd44b2019-05-20 17:28:11 +02001624 int target_usage_arg,
1625 int target_alg_arg, int target_alg2_arg,
Archana8a180362021-07-05 02:18:48 +05301626 unsigned int target_lifetime_arg,
Gilles Peskinebcdd44b2019-05-20 17:28:11 +02001627 int expected_usage_arg,
1628 int expected_alg_arg, int expected_alg2_arg )
Gilles Peskine57ab7212019-01-28 13:03:09 +01001629{
Gilles Peskineca25db92019-04-19 11:43:08 +02001630 psa_key_attributes_t source_attributes = PSA_KEY_ATTRIBUTES_INIT;
1631 psa_key_attributes_t target_attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine57ab7212019-01-28 13:03:09 +01001632 psa_key_usage_t expected_usage = expected_usage_arg;
1633 psa_algorithm_t expected_alg = expected_alg_arg;
Gilles Peskinebcdd44b2019-05-20 17:28:11 +02001634 psa_algorithm_t expected_alg2 = expected_alg2_arg;
Archana8a180362021-07-05 02:18:48 +05301635 psa_key_lifetime_t source_lifetime = source_lifetime_arg;
1636 psa_key_lifetime_t target_lifetime = target_lifetime_arg;
Ronald Cron5425a212020-08-04 14:58:35 +02001637 mbedtls_svc_key_id_t source_key = MBEDTLS_SVC_KEY_ID_INIT;
1638 mbedtls_svc_key_id_t target_key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine57ab7212019-01-28 13:03:09 +01001639 uint8_t *export_buffer = NULL;
1640
Gilles Peskine57ab7212019-01-28 13:03:09 +01001641 PSA_ASSERT( psa_crypto_init( ) );
1642
Gilles Peskineca25db92019-04-19 11:43:08 +02001643 /* Prepare the source key. */
1644 psa_set_key_usage_flags( &source_attributes, source_usage_arg );
1645 psa_set_key_algorithm( &source_attributes, source_alg_arg );
Gilles Peskinebcdd44b2019-05-20 17:28:11 +02001646 psa_set_key_enrollment_algorithm( &source_attributes, source_alg2_arg );
Gilles Peskineca25db92019-04-19 11:43:08 +02001647 psa_set_key_type( &source_attributes, type_arg );
Archana8a180362021-07-05 02:18:48 +05301648 psa_set_key_lifetime( &source_attributes, source_lifetime);
Gilles Peskine049c7532019-05-15 20:22:09 +02001649 PSA_ASSERT( psa_import_key( &source_attributes,
1650 material->x, material->len,
Ronald Cron5425a212020-08-04 14:58:35 +02001651 &source_key ) );
1652 PSA_ASSERT( psa_get_key_attributes( source_key, &source_attributes ) );
Gilles Peskine57ab7212019-01-28 13:03:09 +01001653
Gilles Peskineca25db92019-04-19 11:43:08 +02001654 /* Prepare the target attributes. */
1655 if( copy_attributes )
Ronald Cron65f38a32020-10-23 17:11:13 +02001656 {
Gilles Peskineca25db92019-04-19 11:43:08 +02001657 target_attributes = source_attributes;
Ronald Cron65f38a32020-10-23 17:11:13 +02001658 }
Archana8a180362021-07-05 02:18:48 +05301659 psa_set_key_lifetime( &target_attributes, target_lifetime);
Ronald Cron65f38a32020-10-23 17:11:13 +02001660
Gilles Peskineca25db92019-04-19 11:43:08 +02001661 if( target_usage_arg != -1 )
1662 psa_set_key_usage_flags( &target_attributes, target_usage_arg );
1663 if( target_alg_arg != -1 )
1664 psa_set_key_algorithm( &target_attributes, target_alg_arg );
Gilles Peskinebcdd44b2019-05-20 17:28:11 +02001665 if( target_alg2_arg != -1 )
1666 psa_set_key_enrollment_algorithm( &target_attributes, target_alg2_arg );
Gilles Peskine57ab7212019-01-28 13:03:09 +01001667
Archana8a180362021-07-05 02:18:48 +05301668
Gilles Peskine57ab7212019-01-28 13:03:09 +01001669 /* Copy the key. */
Ronald Cron5425a212020-08-04 14:58:35 +02001670 PSA_ASSERT( psa_copy_key( source_key,
1671 &target_attributes, &target_key ) );
Gilles Peskine57ab7212019-01-28 13:03:09 +01001672
1673 /* Destroy the source to ensure that this doesn't affect the target. */
Ronald Cron5425a212020-08-04 14:58:35 +02001674 PSA_ASSERT( psa_destroy_key( source_key ) );
Gilles Peskine57ab7212019-01-28 13:03:09 +01001675
1676 /* Test that the target slot has the expected content and policy. */
Ronald Cron5425a212020-08-04 14:58:35 +02001677 PSA_ASSERT( psa_get_key_attributes( target_key, &target_attributes ) );
Gilles Peskineca25db92019-04-19 11:43:08 +02001678 TEST_EQUAL( psa_get_key_type( &source_attributes ),
1679 psa_get_key_type( &target_attributes ) );
1680 TEST_EQUAL( psa_get_key_bits( &source_attributes ),
1681 psa_get_key_bits( &target_attributes ) );
1682 TEST_EQUAL( expected_usage, psa_get_key_usage_flags( &target_attributes ) );
1683 TEST_EQUAL( expected_alg, psa_get_key_algorithm( &target_attributes ) );
Gilles Peskinebcdd44b2019-05-20 17:28:11 +02001684 TEST_EQUAL( expected_alg2,
1685 psa_get_key_enrollment_algorithm( &target_attributes ) );
Gilles Peskine57ab7212019-01-28 13:03:09 +01001686 if( expected_usage & PSA_KEY_USAGE_EXPORT )
1687 {
1688 size_t length;
1689 ASSERT_ALLOC( export_buffer, material->len );
Ronald Cron5425a212020-08-04 14:58:35 +02001690 PSA_ASSERT( psa_export_key( target_key, export_buffer,
Gilles Peskine57ab7212019-01-28 13:03:09 +01001691 material->len, &length ) );
1692 ASSERT_COMPARE( material->x, material->len,
1693 export_buffer, length );
1694 }
Steven Cooremanb3ce8152021-02-18 12:03:50 +01001695
Archana8a180362021-07-05 02:18:48 +05301696 if( !psa_key_lifetime_is_external( target_lifetime ) )
1697 {
1698 if( ! mbedtls_test_psa_exercise_key( target_key, expected_usage, expected_alg ) )
1699 goto exit;
1700 if( ! mbedtls_test_psa_exercise_key( target_key, expected_usage, expected_alg2 ) )
1701 goto exit;
1702 }
Gilles Peskine57ab7212019-01-28 13:03:09 +01001703
Ronald Cron5425a212020-08-04 14:58:35 +02001704 PSA_ASSERT( psa_destroy_key( target_key ) );
Gilles Peskine57ab7212019-01-28 13:03:09 +01001705
1706exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +01001707 /*
1708 * Source and target key attributes may have been returned by
1709 * psa_get_key_attributes() thus reset them as required.
1710 */
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02001711 psa_reset_key_attributes( &source_attributes );
1712 psa_reset_key_attributes( &target_attributes );
Ronald Cron3a4f0e32020-11-19 17:55:23 +01001713
Gilles Peskine1153e7b2019-05-28 15:10:21 +02001714 PSA_DONE( );
Gilles Peskine57ab7212019-01-28 13:03:09 +01001715 mbedtls_free( export_buffer );
1716}
1717/* END_CASE */
1718
1719/* BEGIN_CASE */
Gilles Peskinebcdd44b2019-05-20 17:28:11 +02001720void copy_fail( int source_usage_arg,
1721 int source_alg_arg, int source_alg2_arg,
Archana8a180362021-07-05 02:18:48 +05301722 int source_lifetime_arg,
Gilles Peskine4a644642019-05-03 17:14:08 +02001723 int type_arg, data_t *material,
1724 int target_type_arg, int target_bits_arg,
Gilles Peskinebcdd44b2019-05-20 17:28:11 +02001725 int target_usage_arg,
1726 int target_alg_arg, int target_alg2_arg,
Ronald Cron88a55462021-03-31 09:39:07 +02001727 int target_id_arg, int target_lifetime_arg,
Gilles Peskine4a644642019-05-03 17:14:08 +02001728 int expected_status_arg )
1729{
1730 psa_key_attributes_t source_attributes = PSA_KEY_ATTRIBUTES_INIT;
1731 psa_key_attributes_t target_attributes = PSA_KEY_ATTRIBUTES_INIT;
Ronald Cron5425a212020-08-04 14:58:35 +02001732 mbedtls_svc_key_id_t source_key = MBEDTLS_SVC_KEY_ID_INIT;
1733 mbedtls_svc_key_id_t target_key = MBEDTLS_SVC_KEY_ID_INIT;
Ronald Cron88a55462021-03-31 09:39:07 +02001734 mbedtls_svc_key_id_t key_id = mbedtls_svc_key_id_make( 1, target_id_arg );
Gilles Peskine4a644642019-05-03 17:14:08 +02001735
1736 PSA_ASSERT( psa_crypto_init( ) );
1737
1738 /* Prepare the source key. */
1739 psa_set_key_usage_flags( &source_attributes, source_usage_arg );
1740 psa_set_key_algorithm( &source_attributes, source_alg_arg );
Gilles Peskinebcdd44b2019-05-20 17:28:11 +02001741 psa_set_key_enrollment_algorithm( &source_attributes, source_alg2_arg );
Gilles Peskine4a644642019-05-03 17:14:08 +02001742 psa_set_key_type( &source_attributes, type_arg );
Archana8a180362021-07-05 02:18:48 +05301743 psa_set_key_lifetime( &source_attributes, source_lifetime_arg );
Gilles Peskine049c7532019-05-15 20:22:09 +02001744 PSA_ASSERT( psa_import_key( &source_attributes,
1745 material->x, material->len,
Ronald Cron5425a212020-08-04 14:58:35 +02001746 &source_key ) );
Gilles Peskine4a644642019-05-03 17:14:08 +02001747
1748 /* Prepare the target attributes. */
Ronald Cron88a55462021-03-31 09:39:07 +02001749 psa_set_key_id( &target_attributes, key_id );
1750 psa_set_key_lifetime( &target_attributes, target_lifetime_arg );
Gilles Peskine4a644642019-05-03 17:14:08 +02001751 psa_set_key_type( &target_attributes, target_type_arg );
1752 psa_set_key_bits( &target_attributes, target_bits_arg );
1753 psa_set_key_usage_flags( &target_attributes, target_usage_arg );
1754 psa_set_key_algorithm( &target_attributes, target_alg_arg );
Gilles Peskinebcdd44b2019-05-20 17:28:11 +02001755 psa_set_key_enrollment_algorithm( &target_attributes, target_alg2_arg );
Gilles Peskine4a644642019-05-03 17:14:08 +02001756
1757 /* Try to copy the key. */
Ronald Cron5425a212020-08-04 14:58:35 +02001758 TEST_EQUAL( psa_copy_key( source_key,
1759 &target_attributes, &target_key ),
Gilles Peskine4a644642019-05-03 17:14:08 +02001760 expected_status_arg );
Gilles Peskine76b29a72019-05-28 14:08:50 +02001761
Ronald Cron5425a212020-08-04 14:58:35 +02001762 PSA_ASSERT( psa_destroy_key( source_key ) );
Gilles Peskine76b29a72019-05-28 14:08:50 +02001763
Gilles Peskine4a644642019-05-03 17:14:08 +02001764exit:
1765 psa_reset_key_attributes( &source_attributes );
1766 psa_reset_key_attributes( &target_attributes );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02001767 PSA_DONE( );
Gilles Peskine4a644642019-05-03 17:14:08 +02001768}
1769/* END_CASE */
1770
1771/* BEGIN_CASE */
Jaeden Amero6a25b412019-01-04 11:47:44 +00001772void hash_operation_init( )
1773{
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00001774 const uint8_t input[1] = { 0 };
Jaeden Amero6a25b412019-01-04 11:47:44 +00001775 /* Test each valid way of initializing the object, except for `= {0}`, as
1776 * Clang 5 complains when `-Wmissing-field-initializers` is used, even
1777 * though it's OK by the C standard. We could test for this, but we'd need
1778 * to supress the Clang warning for the test. */
1779 psa_hash_operation_t func = psa_hash_operation_init( );
1780 psa_hash_operation_t init = PSA_HASH_OPERATION_INIT;
1781 psa_hash_operation_t zero;
1782
1783 memset( &zero, 0, sizeof( zero ) );
1784
Jaeden Amero11aa7ee2019-02-19 11:44:55 +00001785 /* A freshly-initialized hash operation should not be usable. */
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00001786 TEST_EQUAL( psa_hash_update( &func, input, sizeof( input ) ),
1787 PSA_ERROR_BAD_STATE );
1788 TEST_EQUAL( psa_hash_update( &init, input, sizeof( input ) ),
1789 PSA_ERROR_BAD_STATE );
1790 TEST_EQUAL( psa_hash_update( &zero, input, sizeof( input ) ),
1791 PSA_ERROR_BAD_STATE );
1792
Jaeden Amero5229bbb2019-02-07 16:33:37 +00001793 /* A default hash operation should be abortable without error. */
1794 PSA_ASSERT( psa_hash_abort( &func ) );
1795 PSA_ASSERT( psa_hash_abort( &init ) );
1796 PSA_ASSERT( psa_hash_abort( &zero ) );
Jaeden Amero6a25b412019-01-04 11:47:44 +00001797}
1798/* END_CASE */
1799
1800/* BEGIN_CASE */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02001801void hash_setup( int alg_arg,
1802 int expected_status_arg )
1803{
1804 psa_algorithm_t alg = alg_arg;
Gilles Peskineb866e2b2018-06-21 09:25:10 +02001805 psa_status_t expected_status = expected_status_arg;
Jaeden Amero6a25b412019-01-04 11:47:44 +00001806 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02001807 psa_status_t status;
1808
Gilles Peskine8817f612018-12-18 00:18:46 +01001809 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02001810
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02001811 status = psa_hash_setup( &operation, alg );
Gilles Peskinefe11b722018-12-18 00:24:04 +01001812 TEST_EQUAL( status, expected_status );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02001813
Gilles Peskine9e0a4a52019-02-25 22:11:18 +01001814 /* Whether setup succeeded or failed, abort must succeed. */
1815 PSA_ASSERT( psa_hash_abort( &operation ) );
1816
1817 /* If setup failed, reproduce the failure, so as to
1818 * test the resulting state of the operation object. */
1819 if( status != PSA_SUCCESS )
1820 TEST_EQUAL( psa_hash_setup( &operation, alg ), status );
1821
Gilles Peskinef426e0f2019-02-25 17:42:03 +01001822 /* Now the operation object should be reusable. */
1823#if defined(KNOWN_SUPPORTED_HASH_ALG)
1824 PSA_ASSERT( psa_hash_setup( &operation, KNOWN_SUPPORTED_HASH_ALG ) );
1825 PSA_ASSERT( psa_hash_abort( &operation ) );
1826#endif
1827
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02001828exit:
Gilles Peskine1153e7b2019-05-28 15:10:21 +02001829 PSA_DONE( );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02001830}
1831/* END_CASE */
1832
1833/* BEGIN_CASE */
Gilles Peskine0a749c82019-11-28 19:33:58 +01001834void hash_compute_fail( int alg_arg, data_t *input,
1835 int output_size_arg, int expected_status_arg )
1836{
1837 psa_algorithm_t alg = alg_arg;
1838 uint8_t *output = NULL;
1839 size_t output_size = output_size_arg;
1840 size_t output_length = INVALID_EXPORT_LENGTH;
1841 psa_status_t expected_status = expected_status_arg;
1842 psa_status_t status;
1843
1844 ASSERT_ALLOC( output, output_size );
1845
1846 PSA_ASSERT( psa_crypto_init( ) );
1847
1848 status = psa_hash_compute( alg, input->x, input->len,
1849 output, output_size, &output_length );
1850 TEST_EQUAL( status, expected_status );
1851 TEST_ASSERT( output_length <= output_size );
1852
1853exit:
1854 mbedtls_free( output );
1855 PSA_DONE( );
1856}
1857/* END_CASE */
1858
1859/* BEGIN_CASE */
Gilles Peskine88e08462020-01-28 20:43:00 +01001860void hash_compare_fail( int alg_arg, data_t *input,
1861 data_t *reference_hash,
1862 int expected_status_arg )
1863{
1864 psa_algorithm_t alg = alg_arg;
1865 psa_status_t expected_status = expected_status_arg;
1866 psa_status_t status;
1867
1868 PSA_ASSERT( psa_crypto_init( ) );
1869
1870 status = psa_hash_compare( alg, input->x, input->len,
1871 reference_hash->x, reference_hash->len );
1872 TEST_EQUAL( status, expected_status );
1873
1874exit:
1875 PSA_DONE( );
1876}
1877/* END_CASE */
1878
1879/* BEGIN_CASE */
Gilles Peskine0a749c82019-11-28 19:33:58 +01001880void hash_compute_compare( int alg_arg, data_t *input,
1881 data_t *expected_output )
1882{
1883 psa_algorithm_t alg = alg_arg;
1884 uint8_t output[PSA_HASH_MAX_SIZE + 1];
1885 size_t output_length = INVALID_EXPORT_LENGTH;
1886 size_t i;
1887
1888 PSA_ASSERT( psa_crypto_init( ) );
1889
1890 /* Compute with tight buffer */
1891 PSA_ASSERT( psa_hash_compute( alg, input->x, input->len,
gabor-mezei-armcbcec212020-12-18 14:23:51 +01001892 output, PSA_HASH_LENGTH( alg ),
Gilles Peskine0a749c82019-11-28 19:33:58 +01001893 &output_length ) );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01001894 TEST_EQUAL( output_length, PSA_HASH_LENGTH( alg ) );
Gilles Peskine0a749c82019-11-28 19:33:58 +01001895 ASSERT_COMPARE( output, output_length,
1896 expected_output->x, expected_output->len );
1897
1898 /* Compute with larger buffer */
1899 PSA_ASSERT( psa_hash_compute( alg, input->x, input->len,
1900 output, sizeof( output ),
1901 &output_length ) );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01001902 TEST_EQUAL( output_length, PSA_HASH_LENGTH( alg ) );
Gilles Peskine0a749c82019-11-28 19:33:58 +01001903 ASSERT_COMPARE( output, output_length,
1904 expected_output->x, expected_output->len );
1905
1906 /* Compare with correct hash */
1907 PSA_ASSERT( psa_hash_compare( alg, input->x, input->len,
1908 output, output_length ) );
1909
1910 /* Compare with trailing garbage */
1911 TEST_EQUAL( psa_hash_compare( alg, input->x, input->len,
1912 output, output_length + 1 ),
1913 PSA_ERROR_INVALID_SIGNATURE );
1914
1915 /* Compare with truncated hash */
1916 TEST_EQUAL( psa_hash_compare( alg, input->x, input->len,
1917 output, output_length - 1 ),
1918 PSA_ERROR_INVALID_SIGNATURE );
1919
1920 /* Compare with corrupted value */
1921 for( i = 0; i < output_length; i++ )
1922 {
Chris Jones9634bb12021-01-20 15:56:42 +00001923 mbedtls_test_set_step( i );
Gilles Peskine0a749c82019-11-28 19:33:58 +01001924 output[i] ^= 1;
1925 TEST_EQUAL( psa_hash_compare( alg, input->x, input->len,
1926 output, output_length ),
1927 PSA_ERROR_INVALID_SIGNATURE );
1928 output[i] ^= 1;
1929 }
1930
1931exit:
1932 PSA_DONE( );
1933}
1934/* END_CASE */
1935
Gilles Peskined6dc40c2021-01-12 12:55:31 +01001936/* BEGIN_CASE depends_on:PSA_WANT_ALG_SHA_256 */
itayzafrirf86548d2018-11-01 10:44:32 +02001937void hash_bad_order( )
1938{
Jaeden Amero11aa7ee2019-02-19 11:44:55 +00001939 psa_algorithm_t alg = PSA_ALG_SHA_256;
itayzafrirf86548d2018-11-01 10:44:32 +02001940 unsigned char input[] = "";
1941 /* SHA-256 hash of an empty string */
Jaeden Amero11aa7ee2019-02-19 11:44:55 +00001942 const unsigned char valid_hash[] = {
itayzafrirf86548d2018-11-01 10:44:32 +02001943 0xe3, 0xb0, 0xc4, 0x42, 0x98, 0xfc, 0x1c, 0x14, 0x9a, 0xfb, 0xf4, 0xc8,
1944 0x99, 0x6f, 0xb9, 0x24, 0x27, 0xae, 0x41, 0xe4, 0x64, 0x9b, 0x93, 0x4c,
1945 0xa4, 0x95, 0x99, 0x1b, 0x78, 0x52, 0xb8, 0x55 };
Jaeden Amero11aa7ee2019-02-19 11:44:55 +00001946 unsigned char hash[sizeof(valid_hash)] = { 0 };
itayzafrirf86548d2018-11-01 10:44:32 +02001947 size_t hash_len;
Jaeden Amero6a25b412019-01-04 11:47:44 +00001948 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
itayzafrirf86548d2018-11-01 10:44:32 +02001949
Gilles Peskine8817f612018-12-18 00:18:46 +01001950 PSA_ASSERT( psa_crypto_init( ) );
itayzafrirf86548d2018-11-01 10:44:32 +02001951
Jaeden Amero36ee5d02019-02-19 09:25:10 +00001952 /* Call setup twice in a row. */
1953 PSA_ASSERT( psa_hash_setup( &operation, alg ) );
Dave Rodgman5ae6f752021-06-24 11:36:14 +01001954 ASSERT_OPERATION_IS_ACTIVE( operation );
Jaeden Amero36ee5d02019-02-19 09:25:10 +00001955 TEST_EQUAL( psa_hash_setup( &operation, alg ),
1956 PSA_ERROR_BAD_STATE );
Dave Rodgman5ae6f752021-06-24 11:36:14 +01001957 ASSERT_OPERATION_IS_INACTIVE( operation );
Jaeden Amero36ee5d02019-02-19 09:25:10 +00001958 PSA_ASSERT( psa_hash_abort( &operation ) );
Dave Rodgman5ae6f752021-06-24 11:36:14 +01001959 ASSERT_OPERATION_IS_INACTIVE( operation );
Jaeden Amero36ee5d02019-02-19 09:25:10 +00001960
Jaeden Amero11aa7ee2019-02-19 11:44:55 +00001961 /* Call update without calling setup beforehand. */
Gilles Peskinef812dcf2018-12-18 00:33:25 +01001962 TEST_EQUAL( psa_hash_update( &operation, input, sizeof( input ) ),
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00001963 PSA_ERROR_BAD_STATE );
Jaeden Amero11aa7ee2019-02-19 11:44:55 +00001964 PSA_ASSERT( psa_hash_abort( &operation ) );
itayzafrirf86548d2018-11-01 10:44:32 +02001965
Dave Rodgman5ae6f752021-06-24 11:36:14 +01001966 /* Check that update calls abort on error. */
1967 PSA_ASSERT( psa_hash_setup( &operation, alg ) );
Dave Rodgman6f710582021-06-24 18:14:52 +01001968 operation.id = UINT_MAX;
Dave Rodgman5ae6f752021-06-24 11:36:14 +01001969 ASSERT_OPERATION_IS_ACTIVE( operation );
1970 TEST_EQUAL( psa_hash_update( &operation, input, sizeof( input ) ),
1971 PSA_ERROR_BAD_STATE );
1972 ASSERT_OPERATION_IS_INACTIVE( operation );
1973 PSA_ASSERT( psa_hash_abort( &operation ) );
1974 ASSERT_OPERATION_IS_INACTIVE( operation );
1975
Jaeden Amero11aa7ee2019-02-19 11:44:55 +00001976 /* Call update after finish. */
1977 PSA_ASSERT( psa_hash_setup( &operation, alg ) );
1978 PSA_ASSERT( psa_hash_finish( &operation,
1979 hash, sizeof( hash ), &hash_len ) );
1980 TEST_EQUAL( psa_hash_update( &operation, input, sizeof( input ) ),
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00001981 PSA_ERROR_BAD_STATE );
Jaeden Amero11aa7ee2019-02-19 11:44:55 +00001982 PSA_ASSERT( psa_hash_abort( &operation ) );
itayzafrirf86548d2018-11-01 10:44:32 +02001983
Jaeden Amero11aa7ee2019-02-19 11:44:55 +00001984 /* Call verify without calling setup beforehand. */
1985 TEST_EQUAL( psa_hash_verify( &operation,
1986 valid_hash, sizeof( valid_hash ) ),
1987 PSA_ERROR_BAD_STATE );
1988 PSA_ASSERT( psa_hash_abort( &operation ) );
1989
1990 /* Call verify after finish. */
1991 PSA_ASSERT( psa_hash_setup( &operation, alg ) );
1992 PSA_ASSERT( psa_hash_finish( &operation,
1993 hash, sizeof( hash ), &hash_len ) );
1994 TEST_EQUAL( psa_hash_verify( &operation,
1995 valid_hash, sizeof( valid_hash ) ),
1996 PSA_ERROR_BAD_STATE );
1997 PSA_ASSERT( psa_hash_abort( &operation ) );
1998
1999 /* Call verify twice in a row. */
2000 PSA_ASSERT( psa_hash_setup( &operation, alg ) );
Dave Rodgman5ae6f752021-06-24 11:36:14 +01002001 ASSERT_OPERATION_IS_ACTIVE( operation );
Jaeden Amero11aa7ee2019-02-19 11:44:55 +00002002 PSA_ASSERT( psa_hash_verify( &operation,
2003 valid_hash, sizeof( valid_hash ) ) );
Dave Rodgman5ae6f752021-06-24 11:36:14 +01002004 ASSERT_OPERATION_IS_INACTIVE( operation );
Jaeden Amero11aa7ee2019-02-19 11:44:55 +00002005 TEST_EQUAL( psa_hash_verify( &operation,
2006 valid_hash, sizeof( valid_hash ) ),
2007 PSA_ERROR_BAD_STATE );
Dave Rodgman5ae6f752021-06-24 11:36:14 +01002008 ASSERT_OPERATION_IS_INACTIVE( operation );
Jaeden Amero11aa7ee2019-02-19 11:44:55 +00002009 PSA_ASSERT( psa_hash_abort( &operation ) );
2010
2011 /* Call finish without calling setup beforehand. */
Gilles Peskinefe11b722018-12-18 00:24:04 +01002012 TEST_EQUAL( psa_hash_finish( &operation,
2013 hash, sizeof( hash ), &hash_len ),
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002014 PSA_ERROR_BAD_STATE );
Jaeden Amero11aa7ee2019-02-19 11:44:55 +00002015 PSA_ASSERT( psa_hash_abort( &operation ) );
2016
2017 /* Call finish twice in a row. */
2018 PSA_ASSERT( psa_hash_setup( &operation, alg ) );
2019 PSA_ASSERT( psa_hash_finish( &operation,
2020 hash, sizeof( hash ), &hash_len ) );
2021 TEST_EQUAL( psa_hash_finish( &operation,
2022 hash, sizeof( hash ), &hash_len ),
2023 PSA_ERROR_BAD_STATE );
2024 PSA_ASSERT( psa_hash_abort( &operation ) );
2025
2026 /* Call finish after calling verify. */
2027 PSA_ASSERT( psa_hash_setup( &operation, alg ) );
2028 PSA_ASSERT( psa_hash_verify( &operation,
2029 valid_hash, sizeof( valid_hash ) ) );
2030 TEST_EQUAL( psa_hash_finish( &operation,
2031 hash, sizeof( hash ), &hash_len ),
2032 PSA_ERROR_BAD_STATE );
2033 PSA_ASSERT( psa_hash_abort( &operation ) );
itayzafrirf86548d2018-11-01 10:44:32 +02002034
2035exit:
Gilles Peskine1153e7b2019-05-28 15:10:21 +02002036 PSA_DONE( );
itayzafrirf86548d2018-11-01 10:44:32 +02002037}
2038/* END_CASE */
2039
Gilles Peskined6dc40c2021-01-12 12:55:31 +01002040/* BEGIN_CASE depends_on:PSA_WANT_ALG_SHA_256 */
itayzafrir27e69452018-11-01 14:26:34 +02002041void hash_verify_bad_args( )
itayzafrirec93d302018-10-18 18:01:10 +03002042{
2043 psa_algorithm_t alg = PSA_ALG_SHA_256;
itayzafrir27e69452018-11-01 14:26:34 +02002044 /* SHA-256 hash of an empty string with 2 extra bytes (0xaa and 0xbb)
2045 * appended to it */
2046 unsigned char hash[] = {
2047 0xe3, 0xb0, 0xc4, 0x42, 0x98, 0xfc, 0x1c, 0x14, 0x9a, 0xfb, 0xf4, 0xc8,
2048 0x99, 0x6f, 0xb9, 0x24, 0x27, 0xae, 0x41, 0xe4, 0x64, 0x9b, 0x93, 0x4c,
2049 0xa4, 0x95, 0x99, 0x1b, 0x78, 0x52, 0xb8, 0x55, 0xaa, 0xbb };
gabor-mezei-armcbcec212020-12-18 14:23:51 +01002050 size_t expected_size = PSA_HASH_LENGTH( alg );
Jaeden Amero6a25b412019-01-04 11:47:44 +00002051 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
itayzafrirec93d302018-10-18 18:01:10 +03002052
Gilles Peskine8817f612018-12-18 00:18:46 +01002053 PSA_ASSERT( psa_crypto_init( ) );
itayzafrirec93d302018-10-18 18:01:10 +03002054
itayzafrir27e69452018-11-01 14:26:34 +02002055 /* psa_hash_verify with a smaller hash than expected */
Gilles Peskine8817f612018-12-18 00:18:46 +01002056 PSA_ASSERT( psa_hash_setup( &operation, alg ) );
Dave Rodgman5ae6f752021-06-24 11:36:14 +01002057 ASSERT_OPERATION_IS_ACTIVE( operation );
Gilles Peskinef812dcf2018-12-18 00:33:25 +01002058 TEST_EQUAL( psa_hash_verify( &operation, hash, expected_size - 1 ),
Gilles Peskinefe11b722018-12-18 00:24:04 +01002059 PSA_ERROR_INVALID_SIGNATURE );
Dave Rodgman5ae6f752021-06-24 11:36:14 +01002060 ASSERT_OPERATION_IS_INACTIVE( operation );
2061 PSA_ASSERT( psa_hash_abort( &operation ) );
2062 ASSERT_OPERATION_IS_INACTIVE( operation );
itayzafrirec93d302018-10-18 18:01:10 +03002063
itayzafrir27e69452018-11-01 14:26:34 +02002064 /* psa_hash_verify with a non-matching hash */
Gilles Peskine8817f612018-12-18 00:18:46 +01002065 PSA_ASSERT( psa_hash_setup( &operation, alg ) );
Gilles Peskinef812dcf2018-12-18 00:33:25 +01002066 TEST_EQUAL( psa_hash_verify( &operation, hash + 1, expected_size ),
Gilles Peskinefe11b722018-12-18 00:24:04 +01002067 PSA_ERROR_INVALID_SIGNATURE );
itayzafrirec93d302018-10-18 18:01:10 +03002068
itayzafrir27e69452018-11-01 14:26:34 +02002069 /* psa_hash_verify with a hash longer than expected */
Gilles Peskine8817f612018-12-18 00:18:46 +01002070 PSA_ASSERT( psa_hash_setup( &operation, alg ) );
Gilles Peskinef812dcf2018-12-18 00:33:25 +01002071 TEST_EQUAL( psa_hash_verify( &operation, hash, sizeof( hash ) ),
Gilles Peskinefe11b722018-12-18 00:24:04 +01002072 PSA_ERROR_INVALID_SIGNATURE );
itayzafrir4271df92018-10-24 18:16:19 +03002073
itayzafrirec93d302018-10-18 18:01:10 +03002074exit:
Gilles Peskine1153e7b2019-05-28 15:10:21 +02002075 PSA_DONE( );
itayzafrirec93d302018-10-18 18:01:10 +03002076}
2077/* END_CASE */
2078
Ronald Cronee414c72021-03-18 18:50:08 +01002079/* BEGIN_CASE depends_on:PSA_WANT_ALG_SHA_256 */
itayzafrirb2dd5ed2018-11-01 11:58:59 +02002080void hash_finish_bad_args( )
itayzafrir58028322018-10-25 10:22:01 +03002081{
2082 psa_algorithm_t alg = PSA_ALG_SHA_256;
itayzafrirb2dd5ed2018-11-01 11:58:59 +02002083 unsigned char hash[PSA_HASH_MAX_SIZE];
gabor-mezei-armcbcec212020-12-18 14:23:51 +01002084 size_t expected_size = PSA_HASH_LENGTH( alg );
Jaeden Amero6a25b412019-01-04 11:47:44 +00002085 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
itayzafrir58028322018-10-25 10:22:01 +03002086 size_t hash_len;
2087
Gilles Peskine8817f612018-12-18 00:18:46 +01002088 PSA_ASSERT( psa_crypto_init( ) );
itayzafrir58028322018-10-25 10:22:01 +03002089
itayzafrir58028322018-10-25 10:22:01 +03002090 /* psa_hash_finish with a smaller hash buffer than expected */
Gilles Peskine8817f612018-12-18 00:18:46 +01002091 PSA_ASSERT( psa_hash_setup( &operation, alg ) );
Gilles Peskinefe11b722018-12-18 00:24:04 +01002092 TEST_EQUAL( psa_hash_finish( &operation,
Gilles Peskinef812dcf2018-12-18 00:33:25 +01002093 hash, expected_size - 1, &hash_len ),
2094 PSA_ERROR_BUFFER_TOO_SMALL );
itayzafrir58028322018-10-25 10:22:01 +03002095
2096exit:
Gilles Peskine1153e7b2019-05-28 15:10:21 +02002097 PSA_DONE( );
itayzafrir58028322018-10-25 10:22:01 +03002098}
2099/* END_CASE */
2100
Ronald Cronee414c72021-03-18 18:50:08 +01002101/* BEGIN_CASE depends_on:PSA_WANT_ALG_SHA_256 */
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002102void hash_clone_source_state( )
2103{
2104 psa_algorithm_t alg = PSA_ALG_SHA_256;
2105 unsigned char hash[PSA_HASH_MAX_SIZE];
2106 psa_hash_operation_t op_source = PSA_HASH_OPERATION_INIT;
2107 psa_hash_operation_t op_init = PSA_HASH_OPERATION_INIT;
2108 psa_hash_operation_t op_setup = PSA_HASH_OPERATION_INIT;
2109 psa_hash_operation_t op_finished = PSA_HASH_OPERATION_INIT;
2110 psa_hash_operation_t op_aborted = PSA_HASH_OPERATION_INIT;
2111 size_t hash_len;
2112
2113 PSA_ASSERT( psa_crypto_init( ) );
2114 PSA_ASSERT( psa_hash_setup( &op_source, alg ) );
2115
2116 PSA_ASSERT( psa_hash_setup( &op_setup, alg ) );
2117 PSA_ASSERT( psa_hash_setup( &op_finished, alg ) );
2118 PSA_ASSERT( psa_hash_finish( &op_finished,
2119 hash, sizeof( hash ), &hash_len ) );
2120 PSA_ASSERT( psa_hash_setup( &op_aborted, alg ) );
2121 PSA_ASSERT( psa_hash_abort( &op_aborted ) );
2122
2123 TEST_EQUAL( psa_hash_clone( &op_source, &op_setup ),
2124 PSA_ERROR_BAD_STATE );
2125
2126 PSA_ASSERT( psa_hash_clone( &op_source, &op_init ) );
2127 PSA_ASSERT( psa_hash_finish( &op_init,
2128 hash, sizeof( hash ), &hash_len ) );
2129 PSA_ASSERT( psa_hash_clone( &op_source, &op_finished ) );
2130 PSA_ASSERT( psa_hash_finish( &op_finished,
2131 hash, sizeof( hash ), &hash_len ) );
2132 PSA_ASSERT( psa_hash_clone( &op_source, &op_aborted ) );
2133 PSA_ASSERT( psa_hash_finish( &op_aborted,
2134 hash, sizeof( hash ), &hash_len ) );
2135
2136exit:
2137 psa_hash_abort( &op_source );
2138 psa_hash_abort( &op_init );
2139 psa_hash_abort( &op_setup );
2140 psa_hash_abort( &op_finished );
2141 psa_hash_abort( &op_aborted );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02002142 PSA_DONE( );
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002143}
2144/* END_CASE */
2145
Ronald Cronee414c72021-03-18 18:50:08 +01002146/* BEGIN_CASE depends_on:PSA_WANT_ALG_SHA_256 */
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002147void hash_clone_target_state( )
2148{
2149 psa_algorithm_t alg = PSA_ALG_SHA_256;
2150 unsigned char hash[PSA_HASH_MAX_SIZE];
2151 psa_hash_operation_t op_init = PSA_HASH_OPERATION_INIT;
2152 psa_hash_operation_t op_setup = PSA_HASH_OPERATION_INIT;
2153 psa_hash_operation_t op_finished = PSA_HASH_OPERATION_INIT;
2154 psa_hash_operation_t op_aborted = PSA_HASH_OPERATION_INIT;
2155 psa_hash_operation_t op_target = PSA_HASH_OPERATION_INIT;
2156 size_t hash_len;
2157
2158 PSA_ASSERT( psa_crypto_init( ) );
2159
2160 PSA_ASSERT( psa_hash_setup( &op_setup, alg ) );
2161 PSA_ASSERT( psa_hash_setup( &op_finished, alg ) );
2162 PSA_ASSERT( psa_hash_finish( &op_finished,
2163 hash, sizeof( hash ), &hash_len ) );
2164 PSA_ASSERT( psa_hash_setup( &op_aborted, alg ) );
2165 PSA_ASSERT( psa_hash_abort( &op_aborted ) );
2166
2167 PSA_ASSERT( psa_hash_clone( &op_setup, &op_target ) );
2168 PSA_ASSERT( psa_hash_finish( &op_target,
2169 hash, sizeof( hash ), &hash_len ) );
2170
2171 TEST_EQUAL( psa_hash_clone( &op_init, &op_target ), PSA_ERROR_BAD_STATE );
2172 TEST_EQUAL( psa_hash_clone( &op_finished, &op_target ),
2173 PSA_ERROR_BAD_STATE );
2174 TEST_EQUAL( psa_hash_clone( &op_aborted, &op_target ),
2175 PSA_ERROR_BAD_STATE );
2176
2177exit:
2178 psa_hash_abort( &op_target );
2179 psa_hash_abort( &op_init );
2180 psa_hash_abort( &op_setup );
2181 psa_hash_abort( &op_finished );
2182 psa_hash_abort( &op_aborted );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02002183 PSA_DONE( );
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002184}
2185/* END_CASE */
2186
itayzafrir58028322018-10-25 10:22:01 +03002187/* BEGIN_CASE */
Jaeden Amero769ce272019-01-04 11:48:03 +00002188void mac_operation_init( )
2189{
Jaeden Amero252ef282019-02-15 14:05:35 +00002190 const uint8_t input[1] = { 0 };
2191
Jaeden Amero769ce272019-01-04 11:48:03 +00002192 /* Test each valid way of initializing the object, except for `= {0}`, as
2193 * Clang 5 complains when `-Wmissing-field-initializers` is used, even
2194 * though it's OK by the C standard. We could test for this, but we'd need
2195 * to supress the Clang warning for the test. */
2196 psa_mac_operation_t func = psa_mac_operation_init( );
2197 psa_mac_operation_t init = PSA_MAC_OPERATION_INIT;
2198 psa_mac_operation_t zero;
2199
2200 memset( &zero, 0, sizeof( zero ) );
2201
Jaeden Amero252ef282019-02-15 14:05:35 +00002202 /* A freshly-initialized MAC operation should not be usable. */
2203 TEST_EQUAL( psa_mac_update( &func,
2204 input, sizeof( input ) ),
2205 PSA_ERROR_BAD_STATE );
2206 TEST_EQUAL( psa_mac_update( &init,
2207 input, sizeof( input ) ),
2208 PSA_ERROR_BAD_STATE );
2209 TEST_EQUAL( psa_mac_update( &zero,
2210 input, sizeof( input ) ),
2211 PSA_ERROR_BAD_STATE );
2212
Jaeden Amero5229bbb2019-02-07 16:33:37 +00002213 /* A default MAC operation should be abortable without error. */
2214 PSA_ASSERT( psa_mac_abort( &func ) );
2215 PSA_ASSERT( psa_mac_abort( &init ) );
2216 PSA_ASSERT( psa_mac_abort( &zero ) );
Jaeden Amero769ce272019-01-04 11:48:03 +00002217}
2218/* END_CASE */
2219
2220/* BEGIN_CASE */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002221void mac_setup( int key_type_arg,
2222 data_t *key,
2223 int alg_arg,
2224 int expected_status_arg )
2225{
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002226 psa_key_type_t key_type = key_type_arg;
2227 psa_algorithm_t alg = alg_arg;
Gilles Peskineb866e2b2018-06-21 09:25:10 +02002228 psa_status_t expected_status = expected_status_arg;
Jaeden Amero769ce272019-01-04 11:48:03 +00002229 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
Gilles Peskinef426e0f2019-02-25 17:42:03 +01002230 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
2231#if defined(KNOWN_SUPPORTED_MAC_ALG)
2232 const uint8_t smoke_test_key_data[16] = "kkkkkkkkkkkkkkkk";
2233#endif
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002234
Gilles Peskine8817f612018-12-18 00:18:46 +01002235 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002236
Gilles Peskinef426e0f2019-02-25 17:42:03 +01002237 if( ! exercise_mac_setup( key_type, key->x, key->len, alg,
2238 &operation, &status ) )
2239 goto exit;
Gilles Peskinefe11b722018-12-18 00:24:04 +01002240 TEST_EQUAL( status, expected_status );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002241
Gilles Peskinef426e0f2019-02-25 17:42:03 +01002242 /* The operation object should be reusable. */
2243#if defined(KNOWN_SUPPORTED_MAC_ALG)
2244 if( ! exercise_mac_setup( KNOWN_SUPPORTED_MAC_KEY_TYPE,
2245 smoke_test_key_data,
2246 sizeof( smoke_test_key_data ),
2247 KNOWN_SUPPORTED_MAC_ALG,
2248 &operation, &status ) )
2249 goto exit;
2250 TEST_EQUAL( status, PSA_SUCCESS );
2251#endif
2252
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002253exit:
Gilles Peskine1153e7b2019-05-28 15:10:21 +02002254 PSA_DONE( );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002255}
2256/* END_CASE */
2257
Gilles Peskined6dc40c2021-01-12 12:55:31 +01002258/* 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 +00002259void mac_bad_order( )
2260{
Ronald Cron5425a212020-08-04 14:58:35 +02002261 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Jaeden Amero252ef282019-02-15 14:05:35 +00002262 psa_key_type_t key_type = PSA_KEY_TYPE_HMAC;
2263 psa_algorithm_t alg = PSA_ALG_HMAC(PSA_ALG_SHA_256);
Ronald Cron5425a212020-08-04 14:58:35 +02002264 const uint8_t key_data[] = {
Jaeden Amero252ef282019-02-15 14:05:35 +00002265 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa,
2266 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa,
2267 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa };
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02002268 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Jaeden Amero252ef282019-02-15 14:05:35 +00002269 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
2270 uint8_t sign_mac[PSA_MAC_MAX_SIZE + 10] = { 0 };
2271 size_t sign_mac_length = 0;
2272 const uint8_t input[] = { 0xbb, 0xbb, 0xbb, 0xbb };
2273 const uint8_t verify_mac[] = {
2274 0x74, 0x65, 0x93, 0x8c, 0xeb, 0x1d, 0xb3, 0x76, 0x5a, 0x38, 0xe7, 0xdd,
2275 0x85, 0xc5, 0xad, 0x4f, 0x07, 0xe7, 0xd5, 0xb2, 0x64, 0xf0, 0x1a, 0x1a,
2276 0x2c, 0xf9, 0x18, 0xca, 0x59, 0x7e, 0x5d, 0xf6 };
2277
2278 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01002279 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_HASH | PSA_KEY_USAGE_VERIFY_HASH );
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02002280 psa_set_key_algorithm( &attributes, alg );
2281 psa_set_key_type( &attributes, key_type );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002282
Ronald Cron5425a212020-08-04 14:58:35 +02002283 PSA_ASSERT( psa_import_key( &attributes, key_data, sizeof( key_data ),
2284 &key ) );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002285
Jaeden Amero252ef282019-02-15 14:05:35 +00002286 /* Call update without calling setup beforehand. */
2287 TEST_EQUAL( psa_mac_update( &operation, input, sizeof( input ) ),
2288 PSA_ERROR_BAD_STATE );
2289 PSA_ASSERT( psa_mac_abort( &operation ) );
2290
2291 /* Call sign finish without calling setup beforehand. */
2292 TEST_EQUAL( psa_mac_sign_finish( &operation, sign_mac, sizeof( sign_mac ),
2293 &sign_mac_length),
2294 PSA_ERROR_BAD_STATE );
2295 PSA_ASSERT( psa_mac_abort( &operation ) );
2296
2297 /* Call verify finish without calling setup beforehand. */
2298 TEST_EQUAL( psa_mac_verify_finish( &operation,
2299 verify_mac, sizeof( verify_mac ) ),
2300 PSA_ERROR_BAD_STATE );
2301 PSA_ASSERT( psa_mac_abort( &operation ) );
2302
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002303 /* Call setup twice in a row. */
Ronald Cron5425a212020-08-04 14:58:35 +02002304 PSA_ASSERT( psa_mac_sign_setup( &operation, key, alg ) );
Dave Rodgman5ae6f752021-06-24 11:36:14 +01002305 ASSERT_OPERATION_IS_ACTIVE( operation );
Ronald Cron5425a212020-08-04 14:58:35 +02002306 TEST_EQUAL( psa_mac_sign_setup( &operation, key, alg ),
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002307 PSA_ERROR_BAD_STATE );
Dave Rodgman5ae6f752021-06-24 11:36:14 +01002308 ASSERT_OPERATION_IS_INACTIVE( operation );
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002309 PSA_ASSERT( psa_mac_abort( &operation ) );
Dave Rodgman5ae6f752021-06-24 11:36:14 +01002310 ASSERT_OPERATION_IS_INACTIVE( operation );
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002311
Jaeden Amero252ef282019-02-15 14:05:35 +00002312 /* Call update after sign finish. */
Ronald Cron5425a212020-08-04 14:58:35 +02002313 PSA_ASSERT( psa_mac_sign_setup( &operation, key, alg ) );
Jaeden Amero252ef282019-02-15 14:05:35 +00002314 PSA_ASSERT( psa_mac_update( &operation, input, sizeof( input ) ) );
2315 PSA_ASSERT( psa_mac_sign_finish( &operation,
2316 sign_mac, sizeof( sign_mac ),
2317 &sign_mac_length ) );
2318 TEST_EQUAL( psa_mac_update( &operation, input, sizeof( input ) ),
2319 PSA_ERROR_BAD_STATE );
2320 PSA_ASSERT( psa_mac_abort( &operation ) );
2321
2322 /* Call update after verify finish. */
Ronald Cron5425a212020-08-04 14:58:35 +02002323 PSA_ASSERT( psa_mac_verify_setup( &operation, key, alg ) );
Jaeden Amero252ef282019-02-15 14:05:35 +00002324 PSA_ASSERT( psa_mac_update( &operation, input, sizeof( input ) ) );
2325 PSA_ASSERT( psa_mac_verify_finish( &operation,
2326 verify_mac, sizeof( verify_mac ) ) );
2327 TEST_EQUAL( psa_mac_update( &operation, input, sizeof( input ) ),
2328 PSA_ERROR_BAD_STATE );
2329 PSA_ASSERT( psa_mac_abort( &operation ) );
2330
2331 /* Call sign finish twice in a row. */
Ronald Cron5425a212020-08-04 14:58:35 +02002332 PSA_ASSERT( psa_mac_sign_setup( &operation, key, alg ) );
Jaeden Amero252ef282019-02-15 14:05:35 +00002333 PSA_ASSERT( psa_mac_update( &operation, input, sizeof( input ) ) );
2334 PSA_ASSERT( psa_mac_sign_finish( &operation,
2335 sign_mac, sizeof( sign_mac ),
2336 &sign_mac_length ) );
2337 TEST_EQUAL( psa_mac_sign_finish( &operation,
2338 sign_mac, sizeof( sign_mac ),
2339 &sign_mac_length ),
2340 PSA_ERROR_BAD_STATE );
2341 PSA_ASSERT( psa_mac_abort( &operation ) );
2342
2343 /* Call verify finish twice in a row. */
Ronald Cron5425a212020-08-04 14:58:35 +02002344 PSA_ASSERT( psa_mac_verify_setup( &operation, key, alg ) );
Jaeden Amero252ef282019-02-15 14:05:35 +00002345 PSA_ASSERT( psa_mac_update( &operation, input, sizeof( input ) ) );
2346 PSA_ASSERT( psa_mac_verify_finish( &operation,
2347 verify_mac, sizeof( verify_mac ) ) );
2348 TEST_EQUAL( psa_mac_verify_finish( &operation,
2349 verify_mac, sizeof( verify_mac ) ),
2350 PSA_ERROR_BAD_STATE );
2351 PSA_ASSERT( psa_mac_abort( &operation ) );
2352
2353 /* Setup sign but try verify. */
Ronald Cron5425a212020-08-04 14:58:35 +02002354 PSA_ASSERT( psa_mac_sign_setup( &operation, key, alg ) );
Jaeden Amero252ef282019-02-15 14:05:35 +00002355 PSA_ASSERT( psa_mac_update( &operation, input, sizeof( input ) ) );
Dave Rodgman647791d2021-06-23 12:49:59 +01002356 ASSERT_OPERATION_IS_ACTIVE( operation );
Jaeden Amero252ef282019-02-15 14:05:35 +00002357 TEST_EQUAL( psa_mac_verify_finish( &operation,
2358 verify_mac, sizeof( verify_mac ) ),
2359 PSA_ERROR_BAD_STATE );
Dave Rodgman647791d2021-06-23 12:49:59 +01002360 ASSERT_OPERATION_IS_INACTIVE( operation );
Jaeden Amero252ef282019-02-15 14:05:35 +00002361 PSA_ASSERT( psa_mac_abort( &operation ) );
Dave Rodgman647791d2021-06-23 12:49:59 +01002362 ASSERT_OPERATION_IS_INACTIVE( operation );
Jaeden Amero252ef282019-02-15 14:05:35 +00002363
2364 /* Setup verify but try sign. */
Ronald Cron5425a212020-08-04 14:58:35 +02002365 PSA_ASSERT( psa_mac_verify_setup( &operation, key, alg ) );
Jaeden Amero252ef282019-02-15 14:05:35 +00002366 PSA_ASSERT( psa_mac_update( &operation, input, sizeof( input ) ) );
Dave Rodgman647791d2021-06-23 12:49:59 +01002367 ASSERT_OPERATION_IS_ACTIVE( operation );
Jaeden Amero252ef282019-02-15 14:05:35 +00002368 TEST_EQUAL( psa_mac_sign_finish( &operation,
2369 sign_mac, sizeof( sign_mac ),
2370 &sign_mac_length ),
2371 PSA_ERROR_BAD_STATE );
Dave Rodgman647791d2021-06-23 12:49:59 +01002372 ASSERT_OPERATION_IS_INACTIVE( operation );
Jaeden Amero252ef282019-02-15 14:05:35 +00002373 PSA_ASSERT( psa_mac_abort( &operation ) );
Dave Rodgman647791d2021-06-23 12:49:59 +01002374 ASSERT_OPERATION_IS_INACTIVE( operation );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002375
Ronald Cron5425a212020-08-04 14:58:35 +02002376 PSA_ASSERT( psa_destroy_key( key ) );
Gilles Peskine76b29a72019-05-28 14:08:50 +02002377
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002378exit:
Gilles Peskine1153e7b2019-05-28 15:10:21 +02002379 PSA_DONE( );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002380}
2381/* END_CASE */
2382
2383/* BEGIN_CASE */
Gilles Peskinea7aa4422018-08-14 15:17:54 +02002384void mac_sign( int key_type_arg,
Ronald Cron5425a212020-08-04 14:58:35 +02002385 data_t *key_data,
Gilles Peskinea7aa4422018-08-14 15:17:54 +02002386 int alg_arg,
2387 data_t *input,
2388 data_t *expected_mac )
2389{
Ronald Cron5425a212020-08-04 14:58:35 +02002390 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskinea7aa4422018-08-14 15:17:54 +02002391 psa_key_type_t key_type = key_type_arg;
2392 psa_algorithm_t alg = alg_arg;
Jaeden Amero769ce272019-01-04 11:48:03 +00002393 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02002394 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine5e65cec2020-08-25 23:38:39 +02002395 uint8_t *actual_mac = NULL;
Gilles Peskinea7aa4422018-08-14 15:17:54 +02002396 size_t mac_buffer_size =
gabor-mezei-armcbcec212020-12-18 14:23:51 +01002397 PSA_MAC_LENGTH( key_type, PSA_BYTES_TO_BITS( key_data->len ), alg );
Gilles Peskinea7aa4422018-08-14 15:17:54 +02002398 size_t mac_length = 0;
Gilles Peskine8b356b52020-08-25 23:44:59 +02002399 const size_t output_sizes_to_test[] = {
2400 0,
2401 1,
2402 expected_mac->len - 1,
2403 expected_mac->len,
2404 expected_mac->len + 1,
2405 };
Gilles Peskinea7aa4422018-08-14 15:17:54 +02002406
Gilles Peskinea7aa4422018-08-14 15:17:54 +02002407 TEST_ASSERT( mac_buffer_size <= PSA_MAC_MAX_SIZE );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01002408 /* We expect PSA_MAC_LENGTH to be exact. */
Gilles Peskine3d404d62020-08-25 23:47:36 +02002409 TEST_ASSERT( expected_mac->len == mac_buffer_size );
Gilles Peskinea7aa4422018-08-14 15:17:54 +02002410
Gilles Peskine8817f612018-12-18 00:18:46 +01002411 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskinea7aa4422018-08-14 15:17:54 +02002412
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01002413 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_HASH );
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02002414 psa_set_key_algorithm( &attributes, alg );
2415 psa_set_key_type( &attributes, key_type );
Gilles Peskinea7aa4422018-08-14 15:17:54 +02002416
Ronald Cron5425a212020-08-04 14:58:35 +02002417 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
2418 &key ) );
Gilles Peskinea7aa4422018-08-14 15:17:54 +02002419
Gilles Peskine8b356b52020-08-25 23:44:59 +02002420 for( size_t i = 0; i < ARRAY_LENGTH( output_sizes_to_test ); i++ )
2421 {
2422 const size_t output_size = output_sizes_to_test[i];
2423 psa_status_t expected_status =
2424 ( output_size >= expected_mac->len ? PSA_SUCCESS :
2425 PSA_ERROR_BUFFER_TOO_SMALL );
Gilles Peskine5e65cec2020-08-25 23:38:39 +02002426
Chris Jones9634bb12021-01-20 15:56:42 +00002427 mbedtls_test_set_step( output_size );
Gilles Peskine8b356b52020-08-25 23:44:59 +02002428 ASSERT_ALLOC( actual_mac, output_size );
Gilles Peskinea7aa4422018-08-14 15:17:54 +02002429
gabor-mezei-arm534bb992021-03-01 15:35:48 +01002430 /* Calculate the MAC, one-shot case. */
2431 TEST_EQUAL( psa_mac_compute( key, alg,
2432 input->x, input->len,
2433 actual_mac, output_size, &mac_length ),
2434 expected_status );
2435 if( expected_status == PSA_SUCCESS )
2436 {
2437 ASSERT_COMPARE( expected_mac->x, expected_mac->len,
2438 actual_mac, mac_length );
2439 }
2440
2441 if( output_size > 0 )
2442 memset( actual_mac, 0, output_size );
2443
2444 /* Calculate the MAC, multi-part case. */
Ronald Cron5425a212020-08-04 14:58:35 +02002445 PSA_ASSERT( psa_mac_sign_setup( &operation, key, alg ) );
Gilles Peskine8b356b52020-08-25 23:44:59 +02002446 PSA_ASSERT( psa_mac_update( &operation,
2447 input->x, input->len ) );
2448 TEST_EQUAL( psa_mac_sign_finish( &operation,
2449 actual_mac, output_size,
2450 &mac_length ),
2451 expected_status );
2452 PSA_ASSERT( psa_mac_abort( &operation ) );
2453
2454 if( expected_status == PSA_SUCCESS )
2455 {
2456 ASSERT_COMPARE( expected_mac->x, expected_mac->len,
2457 actual_mac, mac_length );
2458 }
2459 mbedtls_free( actual_mac );
2460 actual_mac = NULL;
2461 }
Gilles Peskinea7aa4422018-08-14 15:17:54 +02002462
Gilles Peskinea7aa4422018-08-14 15:17:54 +02002463exit:
Gilles Peskine64f13ef2020-08-25 23:15:20 +02002464 psa_mac_abort( &operation );
Ronald Cron5425a212020-08-04 14:58:35 +02002465 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02002466 PSA_DONE( );
Gilles Peskine5e65cec2020-08-25 23:38:39 +02002467 mbedtls_free( actual_mac );
Gilles Peskinea7aa4422018-08-14 15:17:54 +02002468}
2469/* END_CASE */
2470
2471/* BEGIN_CASE */
Gilles Peskinec0ec9722018-06-18 17:03:37 +02002472void mac_verify( int key_type_arg,
Ronald Cron5425a212020-08-04 14:58:35 +02002473 data_t *key_data,
Gilles Peskinec0ec9722018-06-18 17:03:37 +02002474 int alg_arg,
2475 data_t *input,
2476 data_t *expected_mac )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002477{
Ronald Cron5425a212020-08-04 14:58:35 +02002478 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002479 psa_key_type_t key_type = key_type_arg;
2480 psa_algorithm_t alg = alg_arg;
Jaeden Amero769ce272019-01-04 11:48:03 +00002481 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02002482 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine29c4a6c2020-08-26 00:01:39 +02002483 uint8_t *perturbed_mac = NULL;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002484
Gilles Peskine69c12672018-06-28 00:07:19 +02002485 TEST_ASSERT( expected_mac->len <= PSA_MAC_MAX_SIZE );
2486
Gilles Peskine8817f612018-12-18 00:18:46 +01002487 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002488
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01002489 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_VERIFY_HASH );
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02002490 psa_set_key_algorithm( &attributes, alg );
2491 psa_set_key_type( &attributes, key_type );
mohammad16036df908f2018-04-02 08:34:15 -07002492
Ronald Cron5425a212020-08-04 14:58:35 +02002493 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
2494 &key ) );
Gilles Peskinec0ec9722018-06-18 17:03:37 +02002495
gabor-mezei-arm534bb992021-03-01 15:35:48 +01002496 /* Verify correct MAC, one-shot case. */
2497 PSA_ASSERT( psa_mac_verify( key, alg, input->x, input->len,
2498 expected_mac->x, expected_mac->len ) );
2499
2500 /* Verify correct MAC, multi-part case. */
Ronald Cron5425a212020-08-04 14:58:35 +02002501 PSA_ASSERT( psa_mac_verify_setup( &operation, key, alg ) );
Gilles Peskine8817f612018-12-18 00:18:46 +01002502 PSA_ASSERT( psa_mac_update( &operation,
2503 input->x, input->len ) );
2504 PSA_ASSERT( psa_mac_verify_finish( &operation,
2505 expected_mac->x,
2506 expected_mac->len ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002507
gabor-mezei-arm534bb992021-03-01 15:35:48 +01002508 /* Test a MAC that's too short, one-shot case. */
2509 TEST_EQUAL( psa_mac_verify( key, alg,
2510 input->x, input->len,
2511 expected_mac->x,
2512 expected_mac->len - 1 ),
2513 PSA_ERROR_INVALID_SIGNATURE );
2514
2515 /* Test a MAC that's too short, multi-part case. */
Ronald Cron5425a212020-08-04 14:58:35 +02002516 PSA_ASSERT( psa_mac_verify_setup( &operation, key, alg ) );
Gilles Peskine29c4a6c2020-08-26 00:01:39 +02002517 PSA_ASSERT( psa_mac_update( &operation,
2518 input->x, input->len ) );
2519 TEST_EQUAL( psa_mac_verify_finish( &operation,
2520 expected_mac->x,
2521 expected_mac->len - 1 ),
2522 PSA_ERROR_INVALID_SIGNATURE );
2523
gabor-mezei-arm534bb992021-03-01 15:35:48 +01002524 /* Test a MAC that's too long, one-shot case. */
Gilles Peskine29c4a6c2020-08-26 00:01:39 +02002525 ASSERT_ALLOC( perturbed_mac, expected_mac->len + 1 );
2526 memcpy( perturbed_mac, expected_mac->x, expected_mac->len );
gabor-mezei-arm534bb992021-03-01 15:35:48 +01002527 TEST_EQUAL( psa_mac_verify( key, alg,
2528 input->x, input->len,
2529 perturbed_mac, expected_mac->len + 1 ),
2530 PSA_ERROR_INVALID_SIGNATURE );
2531
2532 /* Test a MAC that's too long, multi-part case. */
Ronald Cron5425a212020-08-04 14:58:35 +02002533 PSA_ASSERT( psa_mac_verify_setup( &operation, key, alg ) );
Gilles Peskine29c4a6c2020-08-26 00:01:39 +02002534 PSA_ASSERT( psa_mac_update( &operation,
2535 input->x, input->len ) );
2536 TEST_EQUAL( psa_mac_verify_finish( &operation,
2537 perturbed_mac,
2538 expected_mac->len + 1 ),
2539 PSA_ERROR_INVALID_SIGNATURE );
2540
2541 /* Test changing one byte. */
2542 for( size_t i = 0; i < expected_mac->len; i++ )
2543 {
Chris Jones9634bb12021-01-20 15:56:42 +00002544 mbedtls_test_set_step( i );
Gilles Peskine29c4a6c2020-08-26 00:01:39 +02002545 perturbed_mac[i] ^= 1;
gabor-mezei-arm534bb992021-03-01 15:35:48 +01002546
2547 TEST_EQUAL( psa_mac_verify( key, alg,
2548 input->x, input->len,
2549 perturbed_mac, expected_mac->len ),
2550 PSA_ERROR_INVALID_SIGNATURE );
2551
Ronald Cron5425a212020-08-04 14:58:35 +02002552 PSA_ASSERT( psa_mac_verify_setup( &operation, key, alg ) );
Gilles Peskine29c4a6c2020-08-26 00:01:39 +02002553 PSA_ASSERT( psa_mac_update( &operation,
2554 input->x, input->len ) );
2555 TEST_EQUAL( psa_mac_verify_finish( &operation,
2556 perturbed_mac,
2557 expected_mac->len ),
2558 PSA_ERROR_INVALID_SIGNATURE );
2559 perturbed_mac[i] ^= 1;
2560 }
2561
Gilles Peskine8c9def32018-02-08 10:02:12 +01002562exit:
Gilles Peskine64f13ef2020-08-25 23:15:20 +02002563 psa_mac_abort( &operation );
Ronald Cron5425a212020-08-04 14:58:35 +02002564 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02002565 PSA_DONE( );
Gilles Peskine29c4a6c2020-08-26 00:01:39 +02002566 mbedtls_free( perturbed_mac );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002567}
2568/* END_CASE */
2569
2570/* BEGIN_CASE */
Jaeden Amero5bae2272019-01-04 11:48:27 +00002571void cipher_operation_init( )
2572{
Jaeden Ameroab439972019-02-15 14:12:05 +00002573 const uint8_t input[1] = { 0 };
2574 unsigned char output[1] = { 0 };
2575 size_t output_length;
Jaeden Amero5bae2272019-01-04 11:48:27 +00002576 /* Test each valid way of initializing the object, except for `= {0}`, as
2577 * Clang 5 complains when `-Wmissing-field-initializers` is used, even
2578 * though it's OK by the C standard. We could test for this, but we'd need
2579 * to supress the Clang warning for the test. */
2580 psa_cipher_operation_t func = psa_cipher_operation_init( );
2581 psa_cipher_operation_t init = PSA_CIPHER_OPERATION_INIT;
2582 psa_cipher_operation_t zero;
2583
2584 memset( &zero, 0, sizeof( zero ) );
2585
Jaeden Ameroab439972019-02-15 14:12:05 +00002586 /* A freshly-initialized cipher operation should not be usable. */
2587 TEST_EQUAL( psa_cipher_update( &func,
2588 input, sizeof( input ),
2589 output, sizeof( output ),
2590 &output_length ),
2591 PSA_ERROR_BAD_STATE );
2592 TEST_EQUAL( psa_cipher_update( &init,
2593 input, sizeof( input ),
2594 output, sizeof( output ),
2595 &output_length ),
2596 PSA_ERROR_BAD_STATE );
2597 TEST_EQUAL( psa_cipher_update( &zero,
2598 input, sizeof( input ),
2599 output, sizeof( output ),
2600 &output_length ),
2601 PSA_ERROR_BAD_STATE );
2602
Jaeden Amero5229bbb2019-02-07 16:33:37 +00002603 /* A default cipher operation should be abortable without error. */
2604 PSA_ASSERT( psa_cipher_abort( &func ) );
2605 PSA_ASSERT( psa_cipher_abort( &init ) );
2606 PSA_ASSERT( psa_cipher_abort( &zero ) );
Jaeden Amero5bae2272019-01-04 11:48:27 +00002607}
2608/* END_CASE */
2609
2610/* BEGIN_CASE */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002611void cipher_setup( int key_type_arg,
2612 data_t *key,
2613 int alg_arg,
2614 int expected_status_arg )
2615{
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002616 psa_key_type_t key_type = key_type_arg;
2617 psa_algorithm_t alg = alg_arg;
Gilles Peskineb866e2b2018-06-21 09:25:10 +02002618 psa_status_t expected_status = expected_status_arg;
Jaeden Amero5bae2272019-01-04 11:48:27 +00002619 psa_cipher_operation_t operation = PSA_CIPHER_OPERATION_INIT;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002620 psa_status_t status;
Gilles Peskine612ffd22021-01-20 18:51:00 +01002621#if defined(KNOWN_SUPPORTED_CIPHER_ALG)
Gilles Peskinef426e0f2019-02-25 17:42:03 +01002622 const uint8_t smoke_test_key_data[16] = "kkkkkkkkkkkkkkkk";
2623#endif
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002624
Gilles Peskine8817f612018-12-18 00:18:46 +01002625 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002626
Gilles Peskinef426e0f2019-02-25 17:42:03 +01002627 if( ! exercise_cipher_setup( key_type, key->x, key->len, alg,
2628 &operation, &status ) )
2629 goto exit;
Gilles Peskinefe11b722018-12-18 00:24:04 +01002630 TEST_EQUAL( status, expected_status );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002631
Gilles Peskinef426e0f2019-02-25 17:42:03 +01002632 /* The operation object should be reusable. */
2633#if defined(KNOWN_SUPPORTED_CIPHER_ALG)
2634 if( ! exercise_cipher_setup( KNOWN_SUPPORTED_CIPHER_KEY_TYPE,
2635 smoke_test_key_data,
2636 sizeof( smoke_test_key_data ),
2637 KNOWN_SUPPORTED_CIPHER_ALG,
2638 &operation, &status ) )
2639 goto exit;
2640 TEST_EQUAL( status, PSA_SUCCESS );
2641#endif
2642
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002643exit:
Gilles Peskine64f13ef2020-08-25 23:15:20 +02002644 psa_cipher_abort( &operation );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02002645 PSA_DONE( );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002646}
2647/* END_CASE */
2648
Ronald Cronee414c72021-03-18 18:50:08 +01002649/* BEGIN_CASE depends_on:PSA_WANT_KEY_TYPE_AES:PSA_WANT_ALG_CBC_PKCS7 */
Jaeden Ameroab439972019-02-15 14:12:05 +00002650void cipher_bad_order( )
2651{
Ronald Cron5425a212020-08-04 14:58:35 +02002652 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Jaeden Ameroab439972019-02-15 14:12:05 +00002653 psa_key_type_t key_type = PSA_KEY_TYPE_AES;
2654 psa_algorithm_t alg = PSA_ALG_CBC_PKCS7;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02002655 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Jaeden Ameroab439972019-02-15 14:12:05 +00002656 psa_cipher_operation_t operation = PSA_CIPHER_OPERATION_INIT;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01002657 unsigned char iv[PSA_BLOCK_CIPHER_BLOCK_LENGTH(PSA_KEY_TYPE_AES)] = { 0 };
Ronald Cron5425a212020-08-04 14:58:35 +02002658 const uint8_t key_data[] = {
Jaeden Ameroab439972019-02-15 14:12:05 +00002659 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa,
2660 0xaa, 0xaa, 0xaa, 0xaa };
2661 const uint8_t text[] = {
2662 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb,
2663 0xbb, 0xbb, 0xbb, 0xbb };
gabor-mezei-armcbcec212020-12-18 14:23:51 +01002664 uint8_t buffer[PSA_BLOCK_CIPHER_BLOCK_LENGTH(PSA_KEY_TYPE_AES)] = { 0 };
Jaeden Ameroab439972019-02-15 14:12:05 +00002665 size_t length = 0;
2666
2667 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02002668 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT | PSA_KEY_USAGE_DECRYPT );
2669 psa_set_key_algorithm( &attributes, alg );
2670 psa_set_key_type( &attributes, key_type );
Ronald Cron5425a212020-08-04 14:58:35 +02002671 PSA_ASSERT( psa_import_key( &attributes, key_data, sizeof( key_data ),
2672 &key ) );
Jaeden Ameroab439972019-02-15 14:12:05 +00002673
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002674 /* Call encrypt setup twice in a row. */
Ronald Cron5425a212020-08-04 14:58:35 +02002675 PSA_ASSERT( psa_cipher_encrypt_setup( &operation, key, alg ) );
Dave Rodgman5ae6f752021-06-24 11:36:14 +01002676 ASSERT_OPERATION_IS_ACTIVE( operation );
Ronald Cron5425a212020-08-04 14:58:35 +02002677 TEST_EQUAL( psa_cipher_encrypt_setup( &operation, key, alg ),
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002678 PSA_ERROR_BAD_STATE );
Dave Rodgman5ae6f752021-06-24 11:36:14 +01002679 ASSERT_OPERATION_IS_INACTIVE( operation );
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002680 PSA_ASSERT( psa_cipher_abort( &operation ) );
Dave Rodgman5ae6f752021-06-24 11:36:14 +01002681 ASSERT_OPERATION_IS_INACTIVE( operation );
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002682
2683 /* Call decrypt setup twice in a row. */
Ronald Cron5425a212020-08-04 14:58:35 +02002684 PSA_ASSERT( psa_cipher_decrypt_setup( &operation, key, alg ) );
Dave Rodgman5ae6f752021-06-24 11:36:14 +01002685 ASSERT_OPERATION_IS_ACTIVE( operation );
Ronald Cron5425a212020-08-04 14:58:35 +02002686 TEST_EQUAL( psa_cipher_decrypt_setup( &operation, key, alg ),
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002687 PSA_ERROR_BAD_STATE );
Dave Rodgman5ae6f752021-06-24 11:36:14 +01002688 ASSERT_OPERATION_IS_INACTIVE( operation );
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002689 PSA_ASSERT( psa_cipher_abort( &operation ) );
Dave Rodgman5ae6f752021-06-24 11:36:14 +01002690 ASSERT_OPERATION_IS_INACTIVE( operation );
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002691
Jaeden Ameroab439972019-02-15 14:12:05 +00002692 /* Generate an IV without calling setup beforehand. */
2693 TEST_EQUAL( psa_cipher_generate_iv( &operation,
2694 buffer, sizeof( buffer ),
2695 &length ),
2696 PSA_ERROR_BAD_STATE );
2697 PSA_ASSERT( psa_cipher_abort( &operation ) );
2698
2699 /* Generate an IV twice in a row. */
Ronald Cron5425a212020-08-04 14:58:35 +02002700 PSA_ASSERT( psa_cipher_encrypt_setup( &operation, key, alg ) );
Jaeden Ameroab439972019-02-15 14:12:05 +00002701 PSA_ASSERT( psa_cipher_generate_iv( &operation,
2702 buffer, sizeof( buffer ),
2703 &length ) );
Dave Rodgman647791d2021-06-23 12:49:59 +01002704 ASSERT_OPERATION_IS_ACTIVE( operation );
Jaeden Ameroab439972019-02-15 14:12:05 +00002705 TEST_EQUAL( psa_cipher_generate_iv( &operation,
2706 buffer, sizeof( buffer ),
2707 &length ),
2708 PSA_ERROR_BAD_STATE );
Dave Rodgman647791d2021-06-23 12:49:59 +01002709 ASSERT_OPERATION_IS_INACTIVE( operation );
Jaeden Ameroab439972019-02-15 14:12:05 +00002710 PSA_ASSERT( psa_cipher_abort( &operation ) );
Dave Rodgman647791d2021-06-23 12:49:59 +01002711 ASSERT_OPERATION_IS_INACTIVE( operation );
Jaeden Ameroab439972019-02-15 14:12:05 +00002712
2713 /* Generate an IV after it's already set. */
Ronald Cron5425a212020-08-04 14:58:35 +02002714 PSA_ASSERT( psa_cipher_encrypt_setup( &operation, key, alg ) );
Jaeden Ameroab439972019-02-15 14:12:05 +00002715 PSA_ASSERT( psa_cipher_set_iv( &operation,
2716 iv, sizeof( iv ) ) );
2717 TEST_EQUAL( psa_cipher_generate_iv( &operation,
2718 buffer, sizeof( buffer ),
2719 &length ),
2720 PSA_ERROR_BAD_STATE );
2721 PSA_ASSERT( psa_cipher_abort( &operation ) );
2722
2723 /* Set an IV without calling setup beforehand. */
2724 TEST_EQUAL( psa_cipher_set_iv( &operation,
2725 iv, sizeof( iv ) ),
2726 PSA_ERROR_BAD_STATE );
2727 PSA_ASSERT( psa_cipher_abort( &operation ) );
2728
2729 /* Set an IV after it's already set. */
Ronald Cron5425a212020-08-04 14:58:35 +02002730 PSA_ASSERT( psa_cipher_encrypt_setup( &operation, key, alg ) );
Jaeden Ameroab439972019-02-15 14:12:05 +00002731 PSA_ASSERT( psa_cipher_set_iv( &operation,
2732 iv, sizeof( iv ) ) );
Dave Rodgman647791d2021-06-23 12:49:59 +01002733 ASSERT_OPERATION_IS_ACTIVE( operation );
Jaeden Ameroab439972019-02-15 14:12:05 +00002734 TEST_EQUAL( psa_cipher_set_iv( &operation,
2735 iv, sizeof( iv ) ),
2736 PSA_ERROR_BAD_STATE );
Dave Rodgman647791d2021-06-23 12:49:59 +01002737 ASSERT_OPERATION_IS_INACTIVE( operation );
Jaeden Ameroab439972019-02-15 14:12:05 +00002738 PSA_ASSERT( psa_cipher_abort( &operation ) );
Dave Rodgman647791d2021-06-23 12:49:59 +01002739 ASSERT_OPERATION_IS_INACTIVE( operation );
Jaeden Ameroab439972019-02-15 14:12:05 +00002740
2741 /* Set an IV after it's already generated. */
Ronald Cron5425a212020-08-04 14:58:35 +02002742 PSA_ASSERT( psa_cipher_encrypt_setup( &operation, key, alg ) );
Jaeden Ameroab439972019-02-15 14:12:05 +00002743 PSA_ASSERT( psa_cipher_generate_iv( &operation,
2744 buffer, sizeof( buffer ),
2745 &length ) );
2746 TEST_EQUAL( psa_cipher_set_iv( &operation,
2747 iv, sizeof( iv ) ),
2748 PSA_ERROR_BAD_STATE );
2749 PSA_ASSERT( psa_cipher_abort( &operation ) );
2750
2751 /* Call update without calling setup beforehand. */
2752 TEST_EQUAL( psa_cipher_update( &operation,
2753 text, sizeof( text ),
2754 buffer, sizeof( buffer ),
2755 &length ),
2756 PSA_ERROR_BAD_STATE );
2757 PSA_ASSERT( psa_cipher_abort( &operation ) );
2758
2759 /* Call update without an IV where an IV is required. */
Dave Rodgman095dadc2021-06-23 12:48:52 +01002760 PSA_ASSERT( psa_cipher_encrypt_setup( &operation, key, alg ) );
Dave Rodgman647791d2021-06-23 12:49:59 +01002761 ASSERT_OPERATION_IS_ACTIVE( operation );
Jaeden Ameroab439972019-02-15 14:12:05 +00002762 TEST_EQUAL( psa_cipher_update( &operation,
2763 text, sizeof( text ),
2764 buffer, sizeof( buffer ),
2765 &length ),
2766 PSA_ERROR_BAD_STATE );
Dave Rodgman647791d2021-06-23 12:49:59 +01002767 ASSERT_OPERATION_IS_INACTIVE( operation );
Jaeden Ameroab439972019-02-15 14:12:05 +00002768 PSA_ASSERT( psa_cipher_abort( &operation ) );
Dave Rodgman647791d2021-06-23 12:49:59 +01002769 ASSERT_OPERATION_IS_INACTIVE( operation );
Jaeden Ameroab439972019-02-15 14:12:05 +00002770
2771 /* Call update after finish. */
Ronald Cron5425a212020-08-04 14:58:35 +02002772 PSA_ASSERT( psa_cipher_encrypt_setup( &operation, key, alg ) );
Jaeden Ameroab439972019-02-15 14:12:05 +00002773 PSA_ASSERT( psa_cipher_set_iv( &operation,
2774 iv, sizeof( iv ) ) );
2775 PSA_ASSERT( psa_cipher_finish( &operation,
2776 buffer, sizeof( buffer ), &length ) );
2777 TEST_EQUAL( psa_cipher_update( &operation,
2778 text, sizeof( text ),
2779 buffer, sizeof( buffer ),
2780 &length ),
2781 PSA_ERROR_BAD_STATE );
2782 PSA_ASSERT( psa_cipher_abort( &operation ) );
2783
2784 /* Call finish without calling setup beforehand. */
2785 TEST_EQUAL( psa_cipher_finish( &operation,
2786 buffer, sizeof( buffer ), &length ),
2787 PSA_ERROR_BAD_STATE );
2788 PSA_ASSERT( psa_cipher_abort( &operation ) );
2789
2790 /* Call finish without an IV where an IV is required. */
Ronald Cron5425a212020-08-04 14:58:35 +02002791 PSA_ASSERT( psa_cipher_encrypt_setup( &operation, key, alg ) );
Jaeden Ameroab439972019-02-15 14:12:05 +00002792 /* Not calling update means we are encrypting an empty buffer, which is OK
2793 * for cipher modes with padding. */
Dave Rodgman647791d2021-06-23 12:49:59 +01002794 ASSERT_OPERATION_IS_ACTIVE( operation );
Jaeden Ameroab439972019-02-15 14:12:05 +00002795 TEST_EQUAL( psa_cipher_finish( &operation,
2796 buffer, sizeof( buffer ), &length ),
2797 PSA_ERROR_BAD_STATE );
Dave Rodgman647791d2021-06-23 12:49:59 +01002798 ASSERT_OPERATION_IS_INACTIVE( operation );
Jaeden Ameroab439972019-02-15 14:12:05 +00002799 PSA_ASSERT( psa_cipher_abort( &operation ) );
Dave Rodgman647791d2021-06-23 12:49:59 +01002800 ASSERT_OPERATION_IS_INACTIVE( operation );
Jaeden Ameroab439972019-02-15 14:12:05 +00002801
2802 /* Call finish twice in a row. */
Ronald Cron5425a212020-08-04 14:58:35 +02002803 PSA_ASSERT( psa_cipher_encrypt_setup( &operation, key, alg ) );
Jaeden Ameroab439972019-02-15 14:12:05 +00002804 PSA_ASSERT( psa_cipher_set_iv( &operation,
2805 iv, sizeof( iv ) ) );
2806 PSA_ASSERT( psa_cipher_finish( &operation,
2807 buffer, sizeof( buffer ), &length ) );
2808 TEST_EQUAL( psa_cipher_finish( &operation,
2809 buffer, sizeof( buffer ), &length ),
2810 PSA_ERROR_BAD_STATE );
2811 PSA_ASSERT( psa_cipher_abort( &operation ) );
2812
Ronald Cron5425a212020-08-04 14:58:35 +02002813 PSA_ASSERT( psa_destroy_key( key ) );
Gilles Peskine76b29a72019-05-28 14:08:50 +02002814
Jaeden Ameroab439972019-02-15 14:12:05 +00002815exit:
Gilles Peskine64f13ef2020-08-25 23:15:20 +02002816 psa_cipher_abort( &operation );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02002817 PSA_DONE( );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002818}
2819/* END_CASE */
2820
2821/* BEGIN_CASE */
gabor-mezei-arma56756e2021-06-25 15:49:14 +02002822void cipher_encrypt_fail( int alg_arg,
2823 int key_type_arg,
2824 data_t *key_data,
2825 data_t *input,
2826 int expected_status_arg )
Gilles Peskine50e586b2018-06-08 14:28:46 +02002827{
Ronald Cron5425a212020-08-04 14:58:35 +02002828 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine50e586b2018-06-08 14:28:46 +02002829 psa_status_t status;
2830 psa_key_type_t key_type = key_type_arg;
2831 psa_algorithm_t alg = alg_arg;
Gilles Peskineb866e2b2018-06-21 09:25:10 +02002832 psa_status_t expected_status = expected_status_arg;
itayzafrir3e02b3b2018-06-12 17:06:52 +03002833 unsigned char *output = NULL;
Gilles Peskine50e586b2018-06-08 14:28:46 +02002834 size_t output_buffer_size = 0;
gabor-mezei-armf494bcd2021-03-01 15:11:46 +01002835 size_t output_length = 0;
2836 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
2837
2838 if ( PSA_ERROR_BAD_STATE != expected_status )
2839 {
2840 PSA_ASSERT( psa_crypto_init( ) );
2841
2842 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
2843 psa_set_key_algorithm( &attributes, alg );
2844 psa_set_key_type( &attributes, key_type );
2845
2846 output_buffer_size = PSA_CIPHER_ENCRYPT_OUTPUT_SIZE( key_type, alg,
2847 input->len );
2848 ASSERT_ALLOC( output, output_buffer_size );
2849
2850 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
2851 &key ) );
2852 }
2853
2854 status = psa_cipher_encrypt( key, alg, input->x, input->len, output,
2855 output_buffer_size, &output_length );
2856
2857 TEST_EQUAL( status, expected_status );
2858
2859exit:
2860 mbedtls_free( output );
2861 psa_destroy_key( key );
2862 PSA_DONE( );
2863}
2864/* END_CASE */
2865
2866/* BEGIN_CASE */
Mateusz Starzyked71e922021-10-21 10:04:57 +02002867void cipher_encrypt_validate_iv_length( int alg, int key_type, data_t* key_data,
2868 data_t *input, int iv_length,
2869 int expected_result )
2870{
2871 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
2872 psa_cipher_operation_t operation = PSA_CIPHER_OPERATION_INIT;
2873 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
2874 size_t output_buffer_size = 0;
2875 unsigned char *output = NULL;
2876
2877 output_buffer_size = PSA_CIPHER_ENCRYPT_OUTPUT_SIZE( key_type, alg, input->len );
2878 ASSERT_ALLOC( output, output_buffer_size );
2879
2880 PSA_ASSERT( psa_crypto_init( ) );
2881
2882 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
2883 psa_set_key_algorithm( &attributes, alg );
2884 psa_set_key_type( &attributes, key_type );
2885
2886 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
2887 &key ) );
2888 PSA_ASSERT( psa_cipher_encrypt_setup( &operation, key, alg ) );
2889 TEST_EQUAL( expected_result, psa_cipher_set_iv( &operation, output,
2890 iv_length ) );
2891
2892exit:
2893 psa_cipher_abort( &operation );
2894 mbedtls_free( output );
2895 psa_destroy_key( key );
2896 PSA_DONE( );
2897}
2898/* END_CASE */
2899
2900/* BEGIN_CASE */
gabor-mezei-arma56756e2021-06-25 15:49:14 +02002901void cipher_encrypt_alg_without_iv( int alg_arg,
2902 int key_type_arg,
2903 data_t *key_data,
2904 data_t *input,
2905 data_t *expected_output )
gabor-mezei-armf494bcd2021-03-01 15:11:46 +01002906{
2907 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
2908 psa_key_type_t key_type = key_type_arg;
2909 psa_algorithm_t alg = alg_arg;
2910 unsigned char *output = NULL;
2911 size_t output_buffer_size = 0;
2912 size_t output_length = 0;
2913 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
2914
2915 PSA_ASSERT( psa_crypto_init( ) );
2916
2917 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
2918 psa_set_key_algorithm( &attributes, alg );
2919 psa_set_key_type( &attributes, key_type );
2920
2921 output_buffer_size = PSA_CIPHER_ENCRYPT_OUTPUT_SIZE( key_type, alg, input->len );
2922 ASSERT_ALLOC( output, output_buffer_size );
2923
2924 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
2925 &key ) );
2926
2927 PSA_ASSERT( psa_cipher_encrypt( key, alg, input->x, input->len, output,
2928 output_buffer_size, &output_length ) );
2929 TEST_ASSERT( output_length <=
2930 PSA_CIPHER_ENCRYPT_OUTPUT_SIZE( key_type, alg, input->len ) );
2931 TEST_ASSERT( output_length <=
2932 PSA_CIPHER_ENCRYPT_OUTPUT_MAX_SIZE( input->len ) );
2933
2934 ASSERT_COMPARE( expected_output->x, expected_output->len,
2935 output, output_length );
2936exit:
2937 mbedtls_free( output );
2938 psa_destroy_key( key );
2939 PSA_DONE( );
2940}
2941/* END_CASE */
2942
2943/* BEGIN_CASE */
Paul Elliotta417f562021-07-14 12:31:21 +01002944void cipher_bad_key( int alg_arg, int key_type_arg, data_t *key_data )
2945{
2946 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
2947 psa_algorithm_t alg = alg_arg;
2948 psa_key_type_t key_type = key_type_arg;
2949 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
2950 psa_cipher_operation_t operation = PSA_CIPHER_OPERATION_INIT;
2951 psa_status_t status;
2952
2953 PSA_ASSERT( psa_crypto_init( ) );
2954
2955 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
2956 psa_set_key_algorithm( &attributes, alg );
2957 psa_set_key_type( &attributes, key_type );
2958
2959 /* Usage of either of these two size macros would cause divide by zero
2960 * with incorrect key types previously. Input length should be irrelevant
2961 * here. */
2962 TEST_EQUAL( PSA_CIPHER_ENCRYPT_OUTPUT_SIZE( key_type, alg, 16 ),
2963 0 );
2964 TEST_EQUAL( PSA_CIPHER_UPDATE_OUTPUT_SIZE( key_type, alg, 16 ), 0 );
2965
2966
2967 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
2968 &key ) );
2969
2970 /* Should fail due to invalid alg type (to support invalid key type).
2971 * Encrypt or decrypt will end up in the same place. */
2972 status = psa_cipher_encrypt_setup( &operation, key, alg );
2973
2974 TEST_EQUAL( status, PSA_ERROR_INVALID_ARGUMENT );
2975
2976exit:
2977 psa_cipher_abort( &operation );
2978 psa_destroy_key( key );
2979 PSA_DONE( );
2980}
2981/* END_CASE */
2982
2983/* BEGIN_CASE */
gabor-mezei-armf494bcd2021-03-01 15:11:46 +01002984void cipher_encrypt_validation( int alg_arg,
2985 int key_type_arg,
2986 data_t *key_data,
2987 data_t *input )
2988{
2989 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
2990 psa_key_type_t key_type = key_type_arg;
2991 psa_algorithm_t alg = alg_arg;
2992 size_t iv_size = PSA_CIPHER_IV_LENGTH ( key_type, alg );
2993 unsigned char *output1 = NULL;
2994 size_t output1_buffer_size = 0;
2995 size_t output1_length = 0;
2996 unsigned char *output2 = NULL;
2997 size_t output2_buffer_size = 0;
2998 size_t output2_length = 0;
Gilles Peskine50e586b2018-06-08 14:28:46 +02002999 size_t function_output_length = 0;
Jaeden Amero5bae2272019-01-04 11:48:27 +00003000 psa_cipher_operation_t operation = PSA_CIPHER_OPERATION_INIT;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02003001 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine50e586b2018-06-08 14:28:46 +02003002
Gilles Peskine8817f612018-12-18 00:18:46 +01003003 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine50e586b2018-06-08 14:28:46 +02003004
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02003005 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
3006 psa_set_key_algorithm( &attributes, alg );
3007 psa_set_key_type( &attributes, key_type );
Moran Pekered346952018-07-05 15:22:45 +03003008
gabor-mezei-armf494bcd2021-03-01 15:11:46 +01003009 output1_buffer_size = PSA_CIPHER_ENCRYPT_OUTPUT_SIZE( key_type, alg, input->len );
3010 output2_buffer_size = PSA_CIPHER_UPDATE_OUTPUT_SIZE( key_type, alg, input->len ) +
3011 PSA_CIPHER_FINISH_OUTPUT_SIZE( key_type, alg );
3012 ASSERT_ALLOC( output1, output1_buffer_size );
3013 ASSERT_ALLOC( output2, output2_buffer_size );
3014
Ronald Cron5425a212020-08-04 14:58:35 +02003015 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
3016 &key ) );
Gilles Peskine50e586b2018-06-08 14:28:46 +02003017
gabor-mezei-arm50c86cf2021-06-25 15:47:50 +02003018 /* The one-shot cipher encryption uses generated iv so validating
3019 the output is not possible. Validating with multipart encryption. */
gabor-mezei-armf494bcd2021-03-01 15:11:46 +01003020 PSA_ASSERT( psa_cipher_encrypt( key, alg, input->x, input->len, output1,
3021 output1_buffer_size, &output1_length ) );
3022 TEST_ASSERT( output1_length <=
3023 PSA_CIPHER_ENCRYPT_OUTPUT_SIZE( key_type, alg, input->len ) );
3024 TEST_ASSERT( output1_length <=
gabor-mezei-armceface22021-01-21 12:26:17 +01003025 PSA_CIPHER_ENCRYPT_OUTPUT_MAX_SIZE( input->len ) );
gabor-mezei-armf494bcd2021-03-01 15:11:46 +01003026
3027 PSA_ASSERT( psa_cipher_encrypt_setup( &operation, key, alg ) );
3028 PSA_ASSERT( psa_cipher_set_iv( &operation, output1, iv_size ) );
Gilles Peskine50e586b2018-06-08 14:28:46 +02003029
Gilles Peskine8817f612018-12-18 00:18:46 +01003030 PSA_ASSERT( psa_cipher_update( &operation,
3031 input->x, input->len,
gabor-mezei-armf494bcd2021-03-01 15:11:46 +01003032 output2, output2_buffer_size,
Gilles Peskine8817f612018-12-18 00:18:46 +01003033 &function_output_length ) );
gabor-mezei-armceface22021-01-21 12:26:17 +01003034 TEST_ASSERT( function_output_length <=
3035 PSA_CIPHER_UPDATE_OUTPUT_SIZE( key_type, alg, input->len ) );
3036 TEST_ASSERT( function_output_length <=
3037 PSA_CIPHER_UPDATE_OUTPUT_MAX_SIZE( input->len ) );
gabor-mezei-armf494bcd2021-03-01 15:11:46 +01003038 output2_length += function_output_length;
gabor-mezei-armceface22021-01-21 12:26:17 +01003039
gabor-mezei-armf494bcd2021-03-01 15:11:46 +01003040 PSA_ASSERT( psa_cipher_finish( &operation,
3041 output2 + output2_length,
3042 output2_buffer_size - output2_length,
3043 &function_output_length ) );
gabor-mezei-armceface22021-01-21 12:26:17 +01003044 TEST_ASSERT( function_output_length <=
3045 PSA_CIPHER_FINISH_OUTPUT_SIZE( key_type, alg ) );
3046 TEST_ASSERT( function_output_length <=
3047 PSA_CIPHER_FINISH_OUTPUT_MAX_SIZE );
gabor-mezei-armf494bcd2021-03-01 15:11:46 +01003048 output2_length += function_output_length;
Gilles Peskinea7ec95f2018-06-08 14:40:59 +02003049
gabor-mezei-armf494bcd2021-03-01 15:11:46 +01003050 PSA_ASSERT( psa_cipher_abort( &operation ) );
3051 ASSERT_COMPARE( output1 + iv_size, output1_length - iv_size,
3052 output2, output2_length );
Gilles Peskinea7ec95f2018-06-08 14:40:59 +02003053
Gilles Peskine50e586b2018-06-08 14:28:46 +02003054exit:
Gilles Peskine64f13ef2020-08-25 23:15:20 +02003055 psa_cipher_abort( &operation );
gabor-mezei-armf494bcd2021-03-01 15:11:46 +01003056 mbedtls_free( output1 );
3057 mbedtls_free( output2 );
Ronald Cron5425a212020-08-04 14:58:35 +02003058 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02003059 PSA_DONE( );
Gilles Peskine50e586b2018-06-08 14:28:46 +02003060}
3061/* END_CASE */
3062
3063/* BEGIN_CASE */
3064void cipher_encrypt_multipart( int alg_arg, int key_type_arg,
Ronald Cron5425a212020-08-04 14:58:35 +02003065 data_t *key_data, data_t *iv,
itayzafrir3e02b3b2018-06-12 17:06:52 +03003066 data_t *input,
Gilles Peskinee0866522019-02-19 19:44:00 +01003067 int first_part_size_arg,
3068 int output1_length_arg, int output2_length_arg,
gabor-mezei-arm95aad832021-06-25 18:21:33 +02003069 data_t *expected_output,
3070 int expected_status_arg )
Gilles Peskine50e586b2018-06-08 14:28:46 +02003071{
Ronald Cron5425a212020-08-04 14:58:35 +02003072 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine50e586b2018-06-08 14:28:46 +02003073 psa_key_type_t key_type = key_type_arg;
3074 psa_algorithm_t alg = alg_arg;
gabor-mezei-arm95aad832021-06-25 18:21:33 +02003075 psa_status_t status;
3076 psa_status_t expected_status = expected_status_arg;
Gilles Peskinee0866522019-02-19 19:44:00 +01003077 size_t first_part_size = first_part_size_arg;
3078 size_t output1_length = output1_length_arg;
3079 size_t output2_length = output2_length_arg;
itayzafrir3e02b3b2018-06-12 17:06:52 +03003080 unsigned char *output = NULL;
Gilles Peskine50e586b2018-06-08 14:28:46 +02003081 size_t output_buffer_size = 0;
3082 size_t function_output_length = 0;
Gilles Peskinea7ec95f2018-06-08 14:40:59 +02003083 size_t total_output_length = 0;
Jaeden Amero5bae2272019-01-04 11:48:27 +00003084 psa_cipher_operation_t operation = PSA_CIPHER_OPERATION_INIT;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02003085 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine50e586b2018-06-08 14:28:46 +02003086
Gilles Peskine8817f612018-12-18 00:18:46 +01003087 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine50e586b2018-06-08 14:28:46 +02003088
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02003089 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
3090 psa_set_key_algorithm( &attributes, alg );
3091 psa_set_key_type( &attributes, key_type );
Moran Pekered346952018-07-05 15:22:45 +03003092
Ronald Cron5425a212020-08-04 14:58:35 +02003093 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
3094 &key ) );
Gilles Peskine50e586b2018-06-08 14:28:46 +02003095
Ronald Cron5425a212020-08-04 14:58:35 +02003096 PSA_ASSERT( psa_cipher_encrypt_setup( &operation, key, alg ) );
Gilles Peskine50e586b2018-06-08 14:28:46 +02003097
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02003098 if( iv->len > 0 )
3099 {
Steven Cooremana6033e92020-08-25 11:47:50 +02003100 PSA_ASSERT( psa_cipher_set_iv( &operation, iv->x, iv->len ) );
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02003101 }
3102
gabor-mezei-armf494bcd2021-03-01 15:11:46 +01003103 output_buffer_size = PSA_CIPHER_UPDATE_OUTPUT_SIZE( key_type, alg, input->len ) +
3104 PSA_CIPHER_FINISH_OUTPUT_SIZE( key_type, alg );
Gilles Peskine8cebbba2018-09-27 13:54:18 +02003105 ASSERT_ALLOC( output, output_buffer_size );
Gilles Peskine50e586b2018-06-08 14:28:46 +02003106
Gilles Peskinee0866522019-02-19 19:44:00 +01003107 TEST_ASSERT( first_part_size <= input->len );
Gilles Peskine8817f612018-12-18 00:18:46 +01003108 PSA_ASSERT( psa_cipher_update( &operation, input->x, first_part_size,
3109 output, output_buffer_size,
3110 &function_output_length ) );
Gilles Peskinee0866522019-02-19 19:44:00 +01003111 TEST_ASSERT( function_output_length == output1_length );
gabor-mezei-armceface22021-01-21 12:26:17 +01003112 TEST_ASSERT( function_output_length <=
3113 PSA_CIPHER_UPDATE_OUTPUT_SIZE( key_type, alg, first_part_size ) );
3114 TEST_ASSERT( function_output_length <=
3115 PSA_CIPHER_UPDATE_OUTPUT_MAX_SIZE( first_part_size) );
Gilles Peskinea7ec95f2018-06-08 14:40:59 +02003116 total_output_length += function_output_length;
gabor-mezei-armceface22021-01-21 12:26:17 +01003117
gabor-mezei-arm95aad832021-06-25 18:21:33 +02003118 if( first_part_size < input->len )
3119 {
3120 PSA_ASSERT( psa_cipher_update( &operation,
3121 input->x + first_part_size,
3122 input->len - first_part_size,
3123 ( output_buffer_size == 0 ? NULL :
3124 output + total_output_length ),
3125 output_buffer_size - total_output_length,
3126 &function_output_length ) );
3127 TEST_ASSERT( function_output_length == output2_length );
3128 TEST_ASSERT( function_output_length <=
3129 PSA_CIPHER_UPDATE_OUTPUT_SIZE( key_type,
3130 alg,
3131 input->len - first_part_size ) );
3132 TEST_ASSERT( function_output_length <=
3133 PSA_CIPHER_UPDATE_OUTPUT_MAX_SIZE( input->len ) );
3134 total_output_length += function_output_length;
3135 }
gabor-mezei-armceface22021-01-21 12:26:17 +01003136
gabor-mezei-arm95aad832021-06-25 18:21:33 +02003137 status = psa_cipher_finish( &operation,
3138 ( output_buffer_size == 0 ? NULL :
3139 output + total_output_length ),
3140 output_buffer_size - total_output_length,
3141 &function_output_length );
gabor-mezei-armceface22021-01-21 12:26:17 +01003142 TEST_ASSERT( function_output_length <=
3143 PSA_CIPHER_FINISH_OUTPUT_SIZE( key_type, alg ) );
3144 TEST_ASSERT( function_output_length <=
3145 PSA_CIPHER_FINISH_OUTPUT_MAX_SIZE );
Gilles Peskinea7ec95f2018-06-08 14:40:59 +02003146 total_output_length += function_output_length;
gabor-mezei-arm95aad832021-06-25 18:21:33 +02003147 TEST_EQUAL( status, expected_status );
Gilles Peskine50e586b2018-06-08 14:28:46 +02003148
gabor-mezei-arm95aad832021-06-25 18:21:33 +02003149 if( expected_status == PSA_SUCCESS )
3150 {
3151 PSA_ASSERT( psa_cipher_abort( &operation ) );
3152
3153 ASSERT_COMPARE( expected_output->x, expected_output->len,
3154 output, total_output_length );
3155 }
Gilles Peskine50e586b2018-06-08 14:28:46 +02003156
3157exit:
Gilles Peskine64f13ef2020-08-25 23:15:20 +02003158 psa_cipher_abort( &operation );
itayzafrir3e02b3b2018-06-12 17:06:52 +03003159 mbedtls_free( output );
Ronald Cron5425a212020-08-04 14:58:35 +02003160 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02003161 PSA_DONE( );
Gilles Peskine50e586b2018-06-08 14:28:46 +02003162}
3163/* END_CASE */
3164
3165/* BEGIN_CASE */
3166void cipher_decrypt_multipart( int alg_arg, int key_type_arg,
Ronald Cron5425a212020-08-04 14:58:35 +02003167 data_t *key_data, data_t *iv,
itayzafrir3e02b3b2018-06-12 17:06:52 +03003168 data_t *input,
Gilles Peskinee0866522019-02-19 19:44:00 +01003169 int first_part_size_arg,
3170 int output1_length_arg, int output2_length_arg,
gabor-mezei-arm95aad832021-06-25 18:21:33 +02003171 data_t *expected_output,
3172 int expected_status_arg )
Gilles Peskine50e586b2018-06-08 14:28:46 +02003173{
Ronald Cron5425a212020-08-04 14:58:35 +02003174 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine50e586b2018-06-08 14:28:46 +02003175 psa_key_type_t key_type = key_type_arg;
3176 psa_algorithm_t alg = alg_arg;
gabor-mezei-arm95aad832021-06-25 18:21:33 +02003177 psa_status_t status;
3178 psa_status_t expected_status = expected_status_arg;
Gilles Peskinee0866522019-02-19 19:44:00 +01003179 size_t first_part_size = first_part_size_arg;
3180 size_t output1_length = output1_length_arg;
3181 size_t output2_length = output2_length_arg;
itayzafrir3e02b3b2018-06-12 17:06:52 +03003182 unsigned char *output = NULL;
Gilles Peskine50e586b2018-06-08 14:28:46 +02003183 size_t output_buffer_size = 0;
3184 size_t function_output_length = 0;
Gilles Peskinea7ec95f2018-06-08 14:40:59 +02003185 size_t total_output_length = 0;
Jaeden Amero5bae2272019-01-04 11:48:27 +00003186 psa_cipher_operation_t operation = PSA_CIPHER_OPERATION_INIT;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02003187 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine50e586b2018-06-08 14:28:46 +02003188
Gilles Peskine8817f612018-12-18 00:18:46 +01003189 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine50e586b2018-06-08 14:28:46 +02003190
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02003191 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DECRYPT );
3192 psa_set_key_algorithm( &attributes, alg );
3193 psa_set_key_type( &attributes, key_type );
Moran Pekered346952018-07-05 15:22:45 +03003194
Ronald Cron5425a212020-08-04 14:58:35 +02003195 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
3196 &key ) );
Gilles Peskine50e586b2018-06-08 14:28:46 +02003197
Ronald Cron5425a212020-08-04 14:58:35 +02003198 PSA_ASSERT( psa_cipher_decrypt_setup( &operation, key, alg ) );
Gilles Peskine50e586b2018-06-08 14:28:46 +02003199
Steven Cooreman177deba2020-09-07 17:14:14 +02003200 if( iv->len > 0 )
3201 {
Steven Cooremana6033e92020-08-25 11:47:50 +02003202 PSA_ASSERT( psa_cipher_set_iv( &operation, iv->x, iv->len ) );
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02003203 }
Gilles Peskine50e586b2018-06-08 14:28:46 +02003204
gabor-mezei-armf494bcd2021-03-01 15:11:46 +01003205 output_buffer_size = PSA_CIPHER_UPDATE_OUTPUT_SIZE( key_type, alg, input->len ) +
3206 PSA_CIPHER_FINISH_OUTPUT_SIZE( key_type, alg );
Gilles Peskine8cebbba2018-09-27 13:54:18 +02003207 ASSERT_ALLOC( output, output_buffer_size );
Gilles Peskine50e586b2018-06-08 14:28:46 +02003208
Gilles Peskinee0866522019-02-19 19:44:00 +01003209 TEST_ASSERT( first_part_size <= input->len );
Gilles Peskine8817f612018-12-18 00:18:46 +01003210 PSA_ASSERT( psa_cipher_update( &operation,
3211 input->x, first_part_size,
3212 output, output_buffer_size,
3213 &function_output_length ) );
Gilles Peskinee0866522019-02-19 19:44:00 +01003214 TEST_ASSERT( function_output_length == output1_length );
gabor-mezei-armceface22021-01-21 12:26:17 +01003215 TEST_ASSERT( function_output_length <=
3216 PSA_CIPHER_UPDATE_OUTPUT_SIZE( key_type, alg, first_part_size ) );
3217 TEST_ASSERT( function_output_length <=
3218 PSA_CIPHER_UPDATE_OUTPUT_MAX_SIZE( first_part_size ) );
Gilles Peskinea7ec95f2018-06-08 14:40:59 +02003219 total_output_length += function_output_length;
gabor-mezei-armceface22021-01-21 12:26:17 +01003220
gabor-mezei-arm95aad832021-06-25 18:21:33 +02003221 if( first_part_size < input->len )
Steven Cooreman177deba2020-09-07 17:14:14 +02003222 {
gabor-mezei-arm95aad832021-06-25 18:21:33 +02003223 PSA_ASSERT( psa_cipher_update( &operation,
3224 input->x + first_part_size,
3225 input->len - first_part_size,
3226 ( output_buffer_size == 0 ? NULL :
3227 output + total_output_length ),
3228 output_buffer_size - total_output_length,
3229 &function_output_length ) );
3230 TEST_ASSERT( function_output_length == output2_length );
3231 TEST_ASSERT( function_output_length <=
3232 PSA_CIPHER_UPDATE_OUTPUT_SIZE( key_type,
3233 alg,
3234 input->len - first_part_size ) );
3235 TEST_ASSERT( function_output_length <=
3236 PSA_CIPHER_UPDATE_OUTPUT_MAX_SIZE( input->len ) );
3237 total_output_length += function_output_length;
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02003238 }
Gilles Peskine50e586b2018-06-08 14:28:46 +02003239
Gilles Peskine50e586b2018-06-08 14:28:46 +02003240 status = psa_cipher_finish( &operation,
Gilles Peskine0c510f32021-03-24 00:41:51 +01003241 ( output_buffer_size == 0 ? NULL :
3242 output + total_output_length ),
Gilles Peskineee46fe72019-02-19 19:05:33 +01003243 output_buffer_size - total_output_length,
Gilles Peskine50e586b2018-06-08 14:28:46 +02003244 &function_output_length );
gabor-mezei-armceface22021-01-21 12:26:17 +01003245 TEST_ASSERT( function_output_length <=
3246 PSA_CIPHER_FINISH_OUTPUT_SIZE( key_type, alg ) );
3247 TEST_ASSERT( function_output_length <=
3248 PSA_CIPHER_FINISH_OUTPUT_MAX_SIZE );
Gilles Peskinea7ec95f2018-06-08 14:40:59 +02003249 total_output_length += function_output_length;
Gilles Peskinefe11b722018-12-18 00:24:04 +01003250 TEST_EQUAL( status, expected_status );
Gilles Peskine50e586b2018-06-08 14:28:46 +02003251
3252 if( expected_status == PSA_SUCCESS )
3253 {
Gilles Peskine8817f612018-12-18 00:18:46 +01003254 PSA_ASSERT( psa_cipher_abort( &operation ) );
gabor-mezei-arm95aad832021-06-25 18:21:33 +02003255
Gilles Peskinebd7dea92018-09-27 13:57:19 +02003256 ASSERT_COMPARE( expected_output->x, expected_output->len,
3257 output, total_output_length );
Gilles Peskine50e586b2018-06-08 14:28:46 +02003258 }
3259
Gilles Peskine50e586b2018-06-08 14:28:46 +02003260exit:
Gilles Peskine64f13ef2020-08-25 23:15:20 +02003261 psa_cipher_abort( &operation );
itayzafrir3e02b3b2018-06-12 17:06:52 +03003262 mbedtls_free( output );
Ronald Cron5425a212020-08-04 14:58:35 +02003263 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02003264 PSA_DONE( );
Gilles Peskine50e586b2018-06-08 14:28:46 +02003265}
3266/* END_CASE */
3267
Gilles Peskine50e586b2018-06-08 14:28:46 +02003268/* BEGIN_CASE */
gabor-mezei-arma56756e2021-06-25 15:49:14 +02003269void cipher_decrypt_fail( int alg_arg,
3270 int key_type_arg,
3271 data_t *key_data,
3272 data_t *iv,
3273 data_t *input_arg,
3274 int expected_status_arg )
gabor-mezei-armf494bcd2021-03-01 15:11:46 +01003275{
3276 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
3277 psa_status_t status;
3278 psa_key_type_t key_type = key_type_arg;
3279 psa_algorithm_t alg = alg_arg;
3280 psa_status_t expected_status = expected_status_arg;
3281 unsigned char *input = NULL;
3282 size_t input_buffer_size = 0;
3283 unsigned char *output = NULL;
3284 size_t output_buffer_size = 0;
3285 size_t output_length = 0;
3286 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
3287
3288 if ( PSA_ERROR_BAD_STATE != expected_status )
3289 {
3290 PSA_ASSERT( psa_crypto_init( ) );
3291
3292 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DECRYPT );
3293 psa_set_key_algorithm( &attributes, alg );
3294 psa_set_key_type( &attributes, key_type );
3295
3296 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
3297 &key ) );
3298 }
3299
3300 /* Allocate input buffer and copy the iv and the plaintext */
3301 input_buffer_size = ( (size_t) input_arg->len + (size_t) iv->len );
3302 if ( input_buffer_size > 0 )
3303 {
3304 ASSERT_ALLOC( input, input_buffer_size );
3305 memcpy( input, iv->x, iv->len );
3306 memcpy( input + iv->len, input_arg->x, input_arg->len );
3307 }
3308
3309 output_buffer_size = PSA_CIPHER_DECRYPT_OUTPUT_SIZE( key_type, alg, input_buffer_size );
3310 ASSERT_ALLOC( output, output_buffer_size );
3311
3312 status = psa_cipher_decrypt( key, alg, input, input_buffer_size, output,
3313 output_buffer_size, &output_length );
3314 TEST_EQUAL( status, expected_status );
3315
3316exit:
3317 mbedtls_free( input );
3318 mbedtls_free( output );
3319 psa_destroy_key( key );
3320 PSA_DONE( );
3321}
3322/* END_CASE */
3323
3324/* BEGIN_CASE */
3325void cipher_decrypt( int alg_arg,
3326 int key_type_arg,
3327 data_t *key_data,
3328 data_t *iv,
3329 data_t *input_arg,
3330 data_t *expected_output )
3331{
3332 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
3333 psa_key_type_t key_type = key_type_arg;
3334 psa_algorithm_t alg = alg_arg;
3335 unsigned char *input = NULL;
3336 size_t input_buffer_size = 0;
3337 unsigned char *output = NULL;
3338 size_t output_buffer_size = 0;
3339 size_t output_length = 0;
3340 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
3341
3342 PSA_ASSERT( psa_crypto_init( ) );
3343
3344 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DECRYPT );
3345 psa_set_key_algorithm( &attributes, alg );
3346 psa_set_key_type( &attributes, key_type );
3347
3348 /* Allocate input buffer and copy the iv and the plaintext */
3349 input_buffer_size = ( (size_t) input_arg->len + (size_t) iv->len );
3350 if ( input_buffer_size > 0 )
3351 {
3352 ASSERT_ALLOC( input, input_buffer_size );
3353 memcpy( input, iv->x, iv->len );
3354 memcpy( input + iv->len, input_arg->x, input_arg->len );
3355 }
3356
3357 output_buffer_size = PSA_CIPHER_DECRYPT_OUTPUT_SIZE( key_type, alg, input_buffer_size );
3358 ASSERT_ALLOC( output, output_buffer_size );
3359
3360 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
3361 &key ) );
3362
3363 PSA_ASSERT( psa_cipher_decrypt( key, alg, input, input_buffer_size, output,
3364 output_buffer_size, &output_length ) );
3365 TEST_ASSERT( output_length <=
3366 PSA_CIPHER_DECRYPT_OUTPUT_SIZE( key_type, alg, input_buffer_size ) );
3367 TEST_ASSERT( output_length <=
3368 PSA_CIPHER_DECRYPT_OUTPUT_MAX_SIZE( input_buffer_size ) );
3369
3370 ASSERT_COMPARE( expected_output->x, expected_output->len,
3371 output, output_length );
3372exit:
3373 mbedtls_free( input );
3374 mbedtls_free( output );
3375 psa_destroy_key( key );
3376 PSA_DONE( );
3377}
3378/* END_CASE */
3379
3380/* BEGIN_CASE */
3381void cipher_verify_output( int alg_arg,
3382 int key_type_arg,
Ronald Cron5425a212020-08-04 14:58:35 +02003383 data_t *key_data,
itayzafrir3e02b3b2018-06-12 17:06:52 +03003384 data_t *input )
mohammad1603d7d7ba52018-03-12 18:51:53 +02003385{
Ronald Cron5425a212020-08-04 14:58:35 +02003386 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
mohammad1603d7d7ba52018-03-12 18:51:53 +02003387 psa_key_type_t key_type = key_type_arg;
3388 psa_algorithm_t alg = alg_arg;
itayzafrir3e02b3b2018-06-12 17:06:52 +03003389 unsigned char *output1 = NULL;
mohammad1603d7d7ba52018-03-12 18:51:53 +02003390 size_t output1_size = 0;
3391 size_t output1_length = 0;
itayzafrir3e02b3b2018-06-12 17:06:52 +03003392 unsigned char *output2 = NULL;
mohammad1603d7d7ba52018-03-12 18:51:53 +02003393 size_t output2_size = 0;
3394 size_t output2_length = 0;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02003395 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
mohammad1603d7d7ba52018-03-12 18:51:53 +02003396
Gilles Peskine8817f612018-12-18 00:18:46 +01003397 PSA_ASSERT( psa_crypto_init( ) );
mohammad1603d7d7ba52018-03-12 18:51:53 +02003398
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02003399 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT | PSA_KEY_USAGE_DECRYPT );
3400 psa_set_key_algorithm( &attributes, alg );
3401 psa_set_key_type( &attributes, key_type );
Moran Pekered346952018-07-05 15:22:45 +03003402
Ronald Cron5425a212020-08-04 14:58:35 +02003403 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
3404 &key ) );
gabor-mezei-armceface22021-01-21 12:26:17 +01003405 output1_size = PSA_CIPHER_ENCRYPT_OUTPUT_SIZE( key_type, alg, input->len );
Gilles Peskine8cebbba2018-09-27 13:54:18 +02003406 ASSERT_ALLOC( output1, output1_size );
Moran Pekerded84402018-06-06 16:36:50 +03003407
gabor-mezei-armf494bcd2021-03-01 15:11:46 +01003408 PSA_ASSERT( psa_cipher_encrypt( key, alg, input->x, input->len,
3409 output1, output1_size,
3410 &output1_length ) );
gabor-mezei-armceface22021-01-21 12:26:17 +01003411 TEST_ASSERT( output1_length <=
gabor-mezei-armf494bcd2021-03-01 15:11:46 +01003412 PSA_CIPHER_ENCRYPT_OUTPUT_SIZE( key_type, alg, input->len ) );
gabor-mezei-armceface22021-01-21 12:26:17 +01003413 TEST_ASSERT( output1_length <=
gabor-mezei-armf494bcd2021-03-01 15:11:46 +01003414 PSA_CIPHER_ENCRYPT_OUTPUT_MAX_SIZE( input->len ) );
Moran Pekerded84402018-06-06 16:36:50 +03003415
3416 output2_size = output1_length;
Gilles Peskine8cebbba2018-09-27 13:54:18 +02003417 ASSERT_ALLOC( output2, output2_size );
Moran Pekerded84402018-06-06 16:36:50 +03003418
gabor-mezei-armf494bcd2021-03-01 15:11:46 +01003419 PSA_ASSERT( psa_cipher_decrypt( key, alg, output1, output1_length,
3420 output2, output2_size,
3421 &output2_length ) );
gabor-mezei-armceface22021-01-21 12:26:17 +01003422 TEST_ASSERT( output2_length <=
gabor-mezei-armf494bcd2021-03-01 15:11:46 +01003423 PSA_CIPHER_DECRYPT_OUTPUT_SIZE( key_type, alg, output1_length ) );
gabor-mezei-armceface22021-01-21 12:26:17 +01003424 TEST_ASSERT( output2_length <=
gabor-mezei-armf494bcd2021-03-01 15:11:46 +01003425 PSA_CIPHER_DECRYPT_OUTPUT_MAX_SIZE( output1_length ) );
Moran Pekerded84402018-06-06 16:36:50 +03003426
Gilles Peskinebd7dea92018-09-27 13:57:19 +02003427 ASSERT_COMPARE( input->x, input->len, output2, output2_length );
Moran Pekerded84402018-06-06 16:36:50 +03003428
3429exit:
itayzafrir3e02b3b2018-06-12 17:06:52 +03003430 mbedtls_free( output1 );
3431 mbedtls_free( output2 );
Ronald Cron5425a212020-08-04 14:58:35 +02003432 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02003433 PSA_DONE( );
Moran Pekerded84402018-06-06 16:36:50 +03003434}
3435/* END_CASE */
3436
3437/* BEGIN_CASE */
Gilles Peskine50e586b2018-06-08 14:28:46 +02003438void cipher_verify_output_multipart( int alg_arg,
3439 int key_type_arg,
Ronald Cron5425a212020-08-04 14:58:35 +02003440 data_t *key_data,
itayzafrir3e02b3b2018-06-12 17:06:52 +03003441 data_t *input,
Gilles Peskinee0866522019-02-19 19:44:00 +01003442 int first_part_size_arg )
Moran Pekerded84402018-06-06 16:36:50 +03003443{
Ronald Cron5425a212020-08-04 14:58:35 +02003444 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Moran Pekerded84402018-06-06 16:36:50 +03003445 psa_key_type_t key_type = key_type_arg;
3446 psa_algorithm_t alg = alg_arg;
Gilles Peskinee0866522019-02-19 19:44:00 +01003447 size_t first_part_size = first_part_size_arg;
Moran Pekerded84402018-06-06 16:36:50 +03003448 unsigned char iv[16] = {0};
3449 size_t iv_size = 16;
3450 size_t iv_length = 0;
itayzafrir3e02b3b2018-06-12 17:06:52 +03003451 unsigned char *output1 = NULL;
Gilles Peskine048b7f02018-06-08 14:20:49 +02003452 size_t output1_buffer_size = 0;
Moran Pekerded84402018-06-06 16:36:50 +03003453 size_t output1_length = 0;
itayzafrir3e02b3b2018-06-12 17:06:52 +03003454 unsigned char *output2 = NULL;
Gilles Peskine048b7f02018-06-08 14:20:49 +02003455 size_t output2_buffer_size = 0;
Moran Pekerded84402018-06-06 16:36:50 +03003456 size_t output2_length = 0;
Gilles Peskine048b7f02018-06-08 14:20:49 +02003457 size_t function_output_length;
Jaeden Amero5bae2272019-01-04 11:48:27 +00003458 psa_cipher_operation_t operation1 = PSA_CIPHER_OPERATION_INIT;
3459 psa_cipher_operation_t operation2 = PSA_CIPHER_OPERATION_INIT;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02003460 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Moran Pekerded84402018-06-06 16:36:50 +03003461
Gilles Peskine8817f612018-12-18 00:18:46 +01003462 PSA_ASSERT( psa_crypto_init( ) );
Moran Pekerded84402018-06-06 16:36:50 +03003463
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02003464 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT | PSA_KEY_USAGE_DECRYPT );
3465 psa_set_key_algorithm( &attributes, alg );
3466 psa_set_key_type( &attributes, key_type );
Moran Pekered346952018-07-05 15:22:45 +03003467
Ronald Cron5425a212020-08-04 14:58:35 +02003468 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
3469 &key ) );
Moran Pekerded84402018-06-06 16:36:50 +03003470
Ronald Cron5425a212020-08-04 14:58:35 +02003471 PSA_ASSERT( psa_cipher_encrypt_setup( &operation1, key, alg ) );
3472 PSA_ASSERT( psa_cipher_decrypt_setup( &operation2, key, alg ) );
Moran Pekerded84402018-06-06 16:36:50 +03003473
Steven Cooreman177deba2020-09-07 17:14:14 +02003474 if( alg != PSA_ALG_ECB_NO_PADDING )
3475 {
Steven Cooremana6033e92020-08-25 11:47:50 +02003476 PSA_ASSERT( psa_cipher_generate_iv( &operation1,
3477 iv, iv_size,
3478 &iv_length ) );
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02003479 }
3480
gabor-mezei-armceface22021-01-21 12:26:17 +01003481 output1_buffer_size = PSA_CIPHER_ENCRYPT_OUTPUT_SIZE( key_type, alg, input->len );
3482 TEST_ASSERT( output1_buffer_size <=
3483 PSA_CIPHER_ENCRYPT_OUTPUT_MAX_SIZE( input->len ) );
Gilles Peskine8cebbba2018-09-27 13:54:18 +02003484 ASSERT_ALLOC( output1, output1_buffer_size );
Moran Pekerded84402018-06-06 16:36:50 +03003485
Gilles Peskinee0866522019-02-19 19:44:00 +01003486 TEST_ASSERT( first_part_size <= input->len );
Gilles Peskine4ca9c3f2018-06-06 18:44:09 +02003487
Gilles Peskine8817f612018-12-18 00:18:46 +01003488 PSA_ASSERT( psa_cipher_update( &operation1, input->x, first_part_size,
3489 output1, output1_buffer_size,
3490 &function_output_length ) );
gabor-mezei-armceface22021-01-21 12:26:17 +01003491 TEST_ASSERT( function_output_length <=
3492 PSA_CIPHER_UPDATE_OUTPUT_SIZE( key_type, alg, first_part_size ) );
3493 TEST_ASSERT( function_output_length <=
3494 PSA_CIPHER_UPDATE_OUTPUT_MAX_SIZE( first_part_size ) );
Gilles Peskine048b7f02018-06-08 14:20:49 +02003495 output1_length += function_output_length;
Moran Pekerded84402018-06-06 16:36:50 +03003496
Gilles Peskine8817f612018-12-18 00:18:46 +01003497 PSA_ASSERT( psa_cipher_update( &operation1,
3498 input->x + first_part_size,
3499 input->len - first_part_size,
3500 output1, output1_buffer_size,
3501 &function_output_length ) );
gabor-mezei-armceface22021-01-21 12:26:17 +01003502 TEST_ASSERT( function_output_length <=
3503 PSA_CIPHER_UPDATE_OUTPUT_SIZE( key_type,
3504 alg,
3505 input->len - first_part_size ) );
3506 TEST_ASSERT( function_output_length <=
3507 PSA_CIPHER_UPDATE_OUTPUT_MAX_SIZE( input->len - first_part_size ) );
Gilles Peskine048b7f02018-06-08 14:20:49 +02003508 output1_length += function_output_length;
Moran Pekerded84402018-06-06 16:36:50 +03003509
Gilles Peskine8817f612018-12-18 00:18:46 +01003510 PSA_ASSERT( psa_cipher_finish( &operation1,
3511 output1 + output1_length,
3512 output1_buffer_size - output1_length,
3513 &function_output_length ) );
gabor-mezei-armceface22021-01-21 12:26:17 +01003514 TEST_ASSERT( function_output_length <=
3515 PSA_CIPHER_FINISH_OUTPUT_SIZE( key_type, alg ) );
3516 TEST_ASSERT( function_output_length <=
3517 PSA_CIPHER_FINISH_OUTPUT_MAX_SIZE );
Gilles Peskine048b7f02018-06-08 14:20:49 +02003518 output1_length += function_output_length;
mohammad1603d7d7ba52018-03-12 18:51:53 +02003519
Gilles Peskine8817f612018-12-18 00:18:46 +01003520 PSA_ASSERT( psa_cipher_abort( &operation1 ) );
mohammad1603d7d7ba52018-03-12 18:51:53 +02003521
Gilles Peskine048b7f02018-06-08 14:20:49 +02003522 output2_buffer_size = output1_length;
gabor-mezei-armceface22021-01-21 12:26:17 +01003523 TEST_ASSERT( output2_buffer_size <=
3524 PSA_CIPHER_DECRYPT_OUTPUT_SIZE( key_type, alg, output1_length ) );
3525 TEST_ASSERT( output2_buffer_size <=
3526 PSA_CIPHER_DECRYPT_OUTPUT_MAX_SIZE( output1_length ) );
Gilles Peskine8cebbba2018-09-27 13:54:18 +02003527 ASSERT_ALLOC( output2, output2_buffer_size );
mohammad1603d7d7ba52018-03-12 18:51:53 +02003528
Steven Cooreman177deba2020-09-07 17:14:14 +02003529 if( iv_length > 0 )
3530 {
Steven Cooremana6033e92020-08-25 11:47:50 +02003531 PSA_ASSERT( psa_cipher_set_iv( &operation2,
3532 iv, iv_length ) );
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02003533 }
Moran Pekerded84402018-06-06 16:36:50 +03003534
Gilles Peskine8817f612018-12-18 00:18:46 +01003535 PSA_ASSERT( psa_cipher_update( &operation2, output1, first_part_size,
3536 output2, output2_buffer_size,
3537 &function_output_length ) );
gabor-mezei-armceface22021-01-21 12:26:17 +01003538 TEST_ASSERT( function_output_length <=
3539 PSA_CIPHER_UPDATE_OUTPUT_SIZE( key_type, alg, first_part_size ) );
3540 TEST_ASSERT( function_output_length <=
3541 PSA_CIPHER_UPDATE_OUTPUT_MAX_SIZE( first_part_size ) );
Gilles Peskine048b7f02018-06-08 14:20:49 +02003542 output2_length += function_output_length;
Moran Pekerded84402018-06-06 16:36:50 +03003543
Gilles Peskine8817f612018-12-18 00:18:46 +01003544 PSA_ASSERT( psa_cipher_update( &operation2,
3545 output1 + first_part_size,
3546 output1_length - first_part_size,
3547 output2, output2_buffer_size,
3548 &function_output_length ) );
gabor-mezei-armceface22021-01-21 12:26:17 +01003549 TEST_ASSERT( function_output_length <=
3550 PSA_CIPHER_UPDATE_OUTPUT_SIZE( key_type,
3551 alg,
3552 output1_length - first_part_size ) );
3553 TEST_ASSERT( function_output_length <=
3554 PSA_CIPHER_UPDATE_OUTPUT_MAX_SIZE( output1_length - first_part_size ) );
Gilles Peskine048b7f02018-06-08 14:20:49 +02003555 output2_length += function_output_length;
Moran Pekerded84402018-06-06 16:36:50 +03003556
Gilles Peskine8817f612018-12-18 00:18:46 +01003557 PSA_ASSERT( psa_cipher_finish( &operation2,
3558 output2 + output2_length,
3559 output2_buffer_size - output2_length,
3560 &function_output_length ) );
gabor-mezei-armceface22021-01-21 12:26:17 +01003561 TEST_ASSERT( function_output_length <=
3562 PSA_CIPHER_FINISH_OUTPUT_SIZE( key_type, alg ) );
3563 TEST_ASSERT( function_output_length <=
3564 PSA_CIPHER_FINISH_OUTPUT_MAX_SIZE );
Gilles Peskine048b7f02018-06-08 14:20:49 +02003565 output2_length += function_output_length;
Gilles Peskine4ca9c3f2018-06-06 18:44:09 +02003566
Gilles Peskine8817f612018-12-18 00:18:46 +01003567 PSA_ASSERT( psa_cipher_abort( &operation2 ) );
mohammad1603d7d7ba52018-03-12 18:51:53 +02003568
Gilles Peskinebd7dea92018-09-27 13:57:19 +02003569 ASSERT_COMPARE( input->x, input->len, output2, output2_length );
mohammad1603d7d7ba52018-03-12 18:51:53 +02003570
3571exit:
Gilles Peskine64f13ef2020-08-25 23:15:20 +02003572 psa_cipher_abort( &operation1 );
3573 psa_cipher_abort( &operation2 );
itayzafrir3e02b3b2018-06-12 17:06:52 +03003574 mbedtls_free( output1 );
3575 mbedtls_free( output2 );
Ronald Cron5425a212020-08-04 14:58:35 +02003576 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02003577 PSA_DONE( );
mohammad1603d7d7ba52018-03-12 18:51:53 +02003578}
3579/* END_CASE */
Gilles Peskine7268afc2018-06-06 15:19:24 +02003580
Gilles Peskine20035e32018-02-03 22:44:14 +01003581/* BEGIN_CASE */
Gilles Peskine7da96b02018-08-17 18:45:42 +02003582void aead_encrypt_decrypt( int key_type_arg, data_t *key_data,
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02003583 int alg_arg,
Gilles Peskine7da96b02018-08-17 18:45:42 +02003584 data_t *nonce,
3585 data_t *additional_data,
3586 data_t *input_data,
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02003587 int expected_result_arg )
Gilles Peskinea1cac842018-06-11 19:33:02 +02003588{
Ronald Cron5425a212020-08-04 14:58:35 +02003589 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskinea1cac842018-06-11 19:33:02 +02003590 psa_key_type_t key_type = key_type_arg;
3591 psa_algorithm_t alg = alg_arg;
Bence Szépkútiec174e22021-03-19 18:46:15 +01003592 size_t key_bits;
Gilles Peskinea1cac842018-06-11 19:33:02 +02003593 unsigned char *output_data = NULL;
3594 size_t output_size = 0;
3595 size_t output_length = 0;
3596 unsigned char *output_data2 = NULL;
3597 size_t output_length2 = 0;
Steven Cooremanf49478b2021-02-15 15:19:25 +01003598 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Gilles Peskine4abf7412018-06-18 16:35:34 +02003599 psa_status_t expected_result = expected_result_arg;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02003600 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskinea1cac842018-06-11 19:33:02 +02003601
Gilles Peskine8817f612018-12-18 00:18:46 +01003602 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003603
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02003604 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT | PSA_KEY_USAGE_DECRYPT );
3605 psa_set_key_algorithm( &attributes, alg );
3606 psa_set_key_type( &attributes, key_type );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003607
Gilles Peskine049c7532019-05-15 20:22:09 +02003608 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02003609 &key ) );
Bence Szépkútiec174e22021-03-19 18:46:15 +01003610 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
3611 key_bits = psa_get_key_bits( &attributes );
3612
3613 output_size = input_data->len + PSA_AEAD_TAG_LENGTH( key_type, key_bits,
3614 alg );
3615 /* For all currently defined algorithms, PSA_AEAD_ENCRYPT_OUTPUT_SIZE
3616 * should be exact. */
3617 if( expected_result != PSA_ERROR_INVALID_ARGUMENT &&
3618 expected_result != PSA_ERROR_NOT_SUPPORTED )
3619 {
3620 TEST_EQUAL( output_size,
3621 PSA_AEAD_ENCRYPT_OUTPUT_SIZE( key_type, alg, input_data->len ) );
3622 TEST_ASSERT( output_size <=
3623 PSA_AEAD_ENCRYPT_OUTPUT_MAX_SIZE( input_data->len ) );
3624 }
3625 ASSERT_ALLOC( output_data, output_size );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003626
Steven Cooremanf49478b2021-02-15 15:19:25 +01003627 status = psa_aead_encrypt( key, alg,
3628 nonce->x, nonce->len,
3629 additional_data->x,
3630 additional_data->len,
3631 input_data->x, input_data->len,
3632 output_data, output_size,
3633 &output_length );
3634
3635 /* If the operation is not supported, just skip and not fail in case the
3636 * encryption involves a common limitation of cryptography hardwares and
3637 * an alternative implementation. */
3638 if( status == PSA_ERROR_NOT_SUPPORTED )
3639 {
3640 MBEDTLS_TEST_PSA_SKIP_IF_ALT_AES_192( key_type, key_data->len * 8 );
3641 MBEDTLS_TEST_PSA_SKIP_IF_ALT_GCM_NOT_12BYTES_NONCE( alg, nonce->len );
3642 }
3643
3644 TEST_EQUAL( status, expected_result );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003645
3646 if( PSA_SUCCESS == expected_result )
3647 {
Gilles Peskine8cebbba2018-09-27 13:54:18 +02003648 ASSERT_ALLOC( output_data2, output_length );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003649
Gilles Peskine003a4a92019-05-14 16:09:40 +02003650 /* For all currently defined algorithms, PSA_AEAD_DECRYPT_OUTPUT_SIZE
3651 * should be exact. */
3652 TEST_EQUAL( input_data->len,
Bence Szépkútiec174e22021-03-19 18:46:15 +01003653 PSA_AEAD_DECRYPT_OUTPUT_SIZE( key_type, alg, output_length ) );
Gilles Peskine003a4a92019-05-14 16:09:40 +02003654
gabor-mezei-armceface22021-01-21 12:26:17 +01003655 TEST_ASSERT( input_data->len <=
3656 PSA_AEAD_DECRYPT_OUTPUT_MAX_SIZE( output_length ) );
3657
Ronald Cron5425a212020-08-04 14:58:35 +02003658 TEST_EQUAL( psa_aead_decrypt( key, alg,
Gilles Peskinefe11b722018-12-18 00:24:04 +01003659 nonce->x, nonce->len,
3660 additional_data->x,
3661 additional_data->len,
3662 output_data, output_length,
3663 output_data2, output_length,
Gilles Peskinef812dcf2018-12-18 00:33:25 +01003664 &output_length2 ),
3665 expected_result );
Gilles Peskine2d277862018-06-18 15:41:12 +02003666
Gilles Peskinebd7dea92018-09-27 13:57:19 +02003667 ASSERT_COMPARE( input_data->x, input_data->len,
3668 output_data2, output_length2 );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003669 }
Gilles Peskine2d277862018-06-18 15:41:12 +02003670
Gilles Peskinea1cac842018-06-11 19:33:02 +02003671exit:
Ronald Cron5425a212020-08-04 14:58:35 +02003672 psa_destroy_key( key );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003673 mbedtls_free( output_data );
3674 mbedtls_free( output_data2 );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02003675 PSA_DONE( );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003676}
3677/* END_CASE */
3678
3679/* BEGIN_CASE */
Gilles Peskine7da96b02018-08-17 18:45:42 +02003680void aead_encrypt( int key_type_arg, data_t *key_data,
3681 int alg_arg,
3682 data_t *nonce,
3683 data_t *additional_data,
3684 data_t *input_data,
3685 data_t *expected_result )
Gilles Peskinea1cac842018-06-11 19:33:02 +02003686{
Ronald Cron5425a212020-08-04 14:58:35 +02003687 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskinea1cac842018-06-11 19:33:02 +02003688 psa_key_type_t key_type = key_type_arg;
3689 psa_algorithm_t alg = alg_arg;
Bence Szépkútiec174e22021-03-19 18:46:15 +01003690 size_t key_bits;
Gilles Peskinea1cac842018-06-11 19:33:02 +02003691 unsigned char *output_data = NULL;
3692 size_t output_size = 0;
3693 size_t output_length = 0;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02003694 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Steven Cooremand588ea12021-01-11 19:36:04 +01003695 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Gilles Peskinea1cac842018-06-11 19:33:02 +02003696
Gilles Peskine8817f612018-12-18 00:18:46 +01003697 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003698
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02003699 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
3700 psa_set_key_algorithm( &attributes, alg );
3701 psa_set_key_type( &attributes, key_type );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003702
Gilles Peskine049c7532019-05-15 20:22:09 +02003703 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02003704 &key ) );
Bence Szépkútiec174e22021-03-19 18:46:15 +01003705 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
3706 key_bits = psa_get_key_bits( &attributes );
3707
3708 output_size = input_data->len + PSA_AEAD_TAG_LENGTH( key_type, key_bits,
3709 alg );
3710 /* For all currently defined algorithms, PSA_AEAD_ENCRYPT_OUTPUT_SIZE
3711 * should be exact. */
3712 TEST_EQUAL( output_size,
3713 PSA_AEAD_ENCRYPT_OUTPUT_SIZE( key_type, alg, input_data->len ) );
3714 TEST_ASSERT( output_size <=
3715 PSA_AEAD_ENCRYPT_OUTPUT_MAX_SIZE( input_data->len ) );
3716 ASSERT_ALLOC( output_data, output_size );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003717
Steven Cooremand588ea12021-01-11 19:36:04 +01003718 status = psa_aead_encrypt( key, alg,
3719 nonce->x, nonce->len,
3720 additional_data->x, additional_data->len,
3721 input_data->x, input_data->len,
3722 output_data, output_size,
3723 &output_length );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003724
Ronald Cron28a45ed2021-02-09 20:35:42 +01003725 /* If the operation is not supported, just skip and not fail in case the
3726 * encryption involves a common limitation of cryptography hardwares and
3727 * an alternative implementation. */
3728 if( status == PSA_ERROR_NOT_SUPPORTED )
Steven Cooremand588ea12021-01-11 19:36:04 +01003729 {
Ronald Cron28a45ed2021-02-09 20:35:42 +01003730 MBEDTLS_TEST_PSA_SKIP_IF_ALT_AES_192( key_type, key_data->len * 8 );
3731 MBEDTLS_TEST_PSA_SKIP_IF_ALT_GCM_NOT_12BYTES_NONCE( alg, nonce->len );
Steven Cooremand588ea12021-01-11 19:36:04 +01003732 }
Steven Cooremand588ea12021-01-11 19:36:04 +01003733
3734 PSA_ASSERT( status );
Gilles Peskinebd7dea92018-09-27 13:57:19 +02003735 ASSERT_COMPARE( expected_result->x, expected_result->len,
3736 output_data, output_length );
Gilles Peskine2d277862018-06-18 15:41:12 +02003737
Gilles Peskinea1cac842018-06-11 19:33:02 +02003738exit:
Ronald Cron5425a212020-08-04 14:58:35 +02003739 psa_destroy_key( key );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003740 mbedtls_free( output_data );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02003741 PSA_DONE( );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003742}
3743/* END_CASE */
3744
3745/* BEGIN_CASE */
Gilles Peskine7da96b02018-08-17 18:45:42 +02003746void aead_decrypt( int key_type_arg, data_t *key_data,
3747 int alg_arg,
3748 data_t *nonce,
3749 data_t *additional_data,
3750 data_t *input_data,
3751 data_t *expected_data,
3752 int expected_result_arg )
Gilles Peskinea1cac842018-06-11 19:33:02 +02003753{
Ronald Cron5425a212020-08-04 14:58:35 +02003754 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskinea1cac842018-06-11 19:33:02 +02003755 psa_key_type_t key_type = key_type_arg;
3756 psa_algorithm_t alg = alg_arg;
Bence Szépkútiec174e22021-03-19 18:46:15 +01003757 size_t key_bits;
Gilles Peskinea1cac842018-06-11 19:33:02 +02003758 unsigned char *output_data = NULL;
3759 size_t output_size = 0;
3760 size_t output_length = 0;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02003761 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine4abf7412018-06-18 16:35:34 +02003762 psa_status_t expected_result = expected_result_arg;
Steven Cooremand588ea12021-01-11 19:36:04 +01003763 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Gilles Peskinea1cac842018-06-11 19:33:02 +02003764
Gilles Peskine8817f612018-12-18 00:18:46 +01003765 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003766
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02003767 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DECRYPT );
3768 psa_set_key_algorithm( &attributes, alg );
3769 psa_set_key_type( &attributes, key_type );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003770
Gilles Peskine049c7532019-05-15 20:22:09 +02003771 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02003772 &key ) );
Bence Szépkútiec174e22021-03-19 18:46:15 +01003773 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
3774 key_bits = psa_get_key_bits( &attributes );
3775
3776 output_size = input_data->len - PSA_AEAD_TAG_LENGTH( key_type, key_bits,
3777 alg );
3778 if( expected_result != PSA_ERROR_INVALID_ARGUMENT &&
3779 expected_result != PSA_ERROR_NOT_SUPPORTED )
3780 {
3781 /* For all currently defined algorithms, PSA_AEAD_DECRYPT_OUTPUT_SIZE
3782 * should be exact. */
3783 TEST_EQUAL( output_size,
3784 PSA_AEAD_DECRYPT_OUTPUT_SIZE( key_type, alg, input_data->len ) );
3785 TEST_ASSERT( output_size <=
3786 PSA_AEAD_DECRYPT_OUTPUT_MAX_SIZE( input_data->len ) );
3787 }
3788 ASSERT_ALLOC( output_data, output_size );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003789
Steven Cooremand588ea12021-01-11 19:36:04 +01003790 status = psa_aead_decrypt( key, alg,
3791 nonce->x, nonce->len,
3792 additional_data->x,
3793 additional_data->len,
3794 input_data->x, input_data->len,
3795 output_data, output_size,
3796 &output_length );
3797
Ronald Cron28a45ed2021-02-09 20:35:42 +01003798 /* If the operation is not supported, just skip and not fail in case the
3799 * decryption involves a common limitation of cryptography hardwares and
3800 * an alternative implementation. */
3801 if( status == PSA_ERROR_NOT_SUPPORTED )
Steven Cooremand588ea12021-01-11 19:36:04 +01003802 {
Ronald Cron28a45ed2021-02-09 20:35:42 +01003803 MBEDTLS_TEST_PSA_SKIP_IF_ALT_AES_192( key_type, key_data->len * 8 );
3804 MBEDTLS_TEST_PSA_SKIP_IF_ALT_GCM_NOT_12BYTES_NONCE( alg, nonce->len );
Steven Cooremand588ea12021-01-11 19:36:04 +01003805 }
Steven Cooremand588ea12021-01-11 19:36:04 +01003806
3807 TEST_EQUAL( status, expected_result );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003808
Gilles Peskine2d277862018-06-18 15:41:12 +02003809 if( expected_result == PSA_SUCCESS )
Gilles Peskinebd7dea92018-09-27 13:57:19 +02003810 ASSERT_COMPARE( expected_data->x, expected_data->len,
3811 output_data, output_length );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003812
Gilles Peskinea1cac842018-06-11 19:33:02 +02003813exit:
Ronald Cron5425a212020-08-04 14:58:35 +02003814 psa_destroy_key( key );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003815 mbedtls_free( output_data );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02003816 PSA_DONE( );
Gilles Peskinea1cac842018-06-11 19:33:02 +02003817}
3818/* END_CASE */
3819
3820/* BEGIN_CASE */
Paul Elliott0023e0a2021-04-27 10:06:22 +01003821void aead_multipart_encrypt( int key_type_arg, data_t *key_data,
3822 int alg_arg,
3823 data_t *nonce,
3824 data_t *additional_data,
Paul Elliott0023e0a2021-04-27 10:06:22 +01003825 data_t *input_data,
Paul Elliott97fd1ba2021-07-21 18:46:06 +01003826 int do_set_lengths,
3827 data_t *expected_output )
Paul Elliott0023e0a2021-04-27 10:06:22 +01003828{
Paul Elliottd3f82412021-06-16 16:52:21 +01003829 size_t ad_part_len = 0;
3830 size_t data_part_len = 0;
Paul Elliottbb979e72021-09-22 12:54:42 +01003831 set_lengths_method_t set_lengths_method = DO_NOT_SET_LENGTHS;
Paul Elliott0023e0a2021-04-27 10:06:22 +01003832
Paul Elliott32f46ba2021-09-23 18:24:36 +01003833 for( ad_part_len = 1; ad_part_len <= additional_data->len; ad_part_len++ )
Paul Elliott0023e0a2021-04-27 10:06:22 +01003834 {
Paul Elliott32f46ba2021-09-23 18:24:36 +01003835 mbedtls_test_set_step( ad_part_len );
3836
3837 if( do_set_lengths )
Paul Elliott0023e0a2021-04-27 10:06:22 +01003838 {
Paul Elliott32f46ba2021-09-23 18:24:36 +01003839 if( ad_part_len & 0x01 )
3840 set_lengths_method = SET_LENGTHS_AFTER_NONCE;
3841 else
3842 set_lengths_method = SET_LENGTHS_BEFORE_NONCE;
Paul Elliott0023e0a2021-04-27 10:06:22 +01003843 }
Paul Elliott32f46ba2021-09-23 18:24:36 +01003844
3845 /* Split ad into length(ad_part_len) parts. */
3846 if( !aead_multipart_internal_func( key_type_arg, key_data,
3847 alg_arg, nonce,
3848 additional_data,
3849 ad_part_len,
3850 input_data, -1,
3851 set_lengths_method,
3852 expected_output,
3853 1, 0 ) )
3854 break;
3855
3856 /* length(0) part, length(ad_part_len) part, length(0) part... */
3857 mbedtls_test_set_step( 1000 + ad_part_len );
3858
3859 if( !aead_multipart_internal_func( key_type_arg, key_data,
3860 alg_arg, nonce,
3861 additional_data,
3862 ad_part_len,
3863 input_data, -1,
3864 set_lengths_method,
3865 expected_output,
3866 1, 1 ) )
3867 break;
Paul Elliott0023e0a2021-04-27 10:06:22 +01003868 }
Paul Elliottd3f82412021-06-16 16:52:21 +01003869
Paul Elliott32f46ba2021-09-23 18:24:36 +01003870 for( data_part_len = 1; data_part_len <= input_data->len; data_part_len++ )
Paul Elliott0023e0a2021-04-27 10:06:22 +01003871 {
Paul Elliott32f46ba2021-09-23 18:24:36 +01003872 /* Split data into length(data_part_len) parts. */
3873 mbedtls_test_set_step( 2000 + data_part_len );
3874
3875 if( do_set_lengths )
Paul Elliott0023e0a2021-04-27 10:06:22 +01003876 {
Paul Elliott32f46ba2021-09-23 18:24:36 +01003877 if( data_part_len & 0x01 )
3878 set_lengths_method = SET_LENGTHS_AFTER_NONCE;
3879 else
3880 set_lengths_method = SET_LENGTHS_BEFORE_NONCE;
Paul Elliott0023e0a2021-04-27 10:06:22 +01003881 }
Paul Elliott0023e0a2021-04-27 10:06:22 +01003882
Paul Elliott32f46ba2021-09-23 18:24:36 +01003883 if( !aead_multipart_internal_func( key_type_arg, key_data,
3884 alg_arg, nonce,
3885 additional_data, -1,
3886 input_data, data_part_len,
3887 set_lengths_method,
3888 expected_output,
3889 1, 0 ) )
3890 break;
3891
3892 /* length(0) part, length(data_part_len) part, length(0) part... */
3893 mbedtls_test_set_step( 3000 + data_part_len );
3894
3895 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, 1 ) )
3902 break;
3903 }
Paul Elliott0023e0a2021-04-27 10:06:22 +01003904
Paul Elliott8fc45162021-06-23 16:06:01 +01003905 /* Goto is required to silence warnings about unused labels, as we
3906 * don't actually do any test assertions in this function. */
3907 goto exit;
Paul Elliott0023e0a2021-04-27 10:06:22 +01003908}
3909/* END_CASE */
3910
3911/* BEGIN_CASE */
Paul Elliott0023e0a2021-04-27 10:06:22 +01003912void aead_multipart_decrypt( int key_type_arg, data_t *key_data,
3913 int alg_arg,
3914 data_t *nonce,
3915 data_t *additional_data,
Paul Elliott0023e0a2021-04-27 10:06:22 +01003916 data_t *input_data,
Paul Elliott97fd1ba2021-07-21 18:46:06 +01003917 int do_set_lengths,
Paul Elliott9961a662021-09-17 19:19:02 +01003918 data_t *expected_output )
Paul Elliott0023e0a2021-04-27 10:06:22 +01003919{
Paul Elliottd3f82412021-06-16 16:52:21 +01003920 size_t ad_part_len = 0;
3921 size_t data_part_len = 0;
Paul Elliottbb979e72021-09-22 12:54:42 +01003922 set_lengths_method_t set_lengths_method = DO_NOT_SET_LENGTHS;
Paul Elliott0023e0a2021-04-27 10:06:22 +01003923
Paul Elliott32f46ba2021-09-23 18:24:36 +01003924 for( ad_part_len = 1; ad_part_len <= additional_data->len; ad_part_len++ )
Paul Elliott0023e0a2021-04-27 10:06:22 +01003925 {
Paul Elliott32f46ba2021-09-23 18:24:36 +01003926 /* Split ad into length(ad_part_len) parts. */
3927 mbedtls_test_set_step( ad_part_len );
3928
3929 if( do_set_lengths )
Paul Elliott0023e0a2021-04-27 10:06:22 +01003930 {
Paul Elliott32f46ba2021-09-23 18:24:36 +01003931 if( ad_part_len & 0x01 )
3932 set_lengths_method = SET_LENGTHS_AFTER_NONCE;
3933 else
3934 set_lengths_method = SET_LENGTHS_BEFORE_NONCE;
Paul Elliott0023e0a2021-04-27 10:06:22 +01003935 }
Paul Elliott32f46ba2021-09-23 18:24:36 +01003936
3937 if( !aead_multipart_internal_func( key_type_arg, key_data,
3938 alg_arg, nonce,
3939 additional_data,
3940 ad_part_len,
3941 input_data, -1,
3942 set_lengths_method,
3943 expected_output,
3944 0, 0 ) )
3945 break;
3946
3947 /* length(0) part, length(ad_part_len) part, length(0) part... */
3948 mbedtls_test_set_step( 1000 + ad_part_len );
3949
3950 if( !aead_multipart_internal_func( key_type_arg, key_data,
3951 alg_arg, nonce,
3952 additional_data,
3953 ad_part_len,
3954 input_data, -1,
3955 set_lengths_method,
3956 expected_output,
3957 0, 1 ) )
3958 break;
Paul Elliott0023e0a2021-04-27 10:06:22 +01003959 }
3960
Paul Elliott32f46ba2021-09-23 18:24:36 +01003961 for( data_part_len = 1; data_part_len <= input_data->len; data_part_len++ )
Paul Elliott0023e0a2021-04-27 10:06:22 +01003962 {
Paul Elliott32f46ba2021-09-23 18:24:36 +01003963 /* Split data into length(data_part_len) parts. */
3964 mbedtls_test_set_step( 2000 + data_part_len );
3965
3966 if( do_set_lengths )
Paul Elliott0023e0a2021-04-27 10:06:22 +01003967 {
Paul Elliott32f46ba2021-09-23 18:24:36 +01003968 if( data_part_len & 0x01 )
3969 set_lengths_method = SET_LENGTHS_AFTER_NONCE;
3970 else
3971 set_lengths_method = SET_LENGTHS_BEFORE_NONCE;
Paul Elliott0023e0a2021-04-27 10:06:22 +01003972 }
Paul Elliott32f46ba2021-09-23 18:24:36 +01003973
3974 if( !aead_multipart_internal_func( key_type_arg, key_data,
3975 alg_arg, nonce,
3976 additional_data, -1,
3977 input_data, data_part_len,
3978 set_lengths_method,
3979 expected_output,
3980 0, 0 ) )
3981 break;
3982
3983 /* length(0) part, length(data_part_len) part, length(0) part... */
3984 mbedtls_test_set_step( 3000 + data_part_len );
3985
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, 1 ) )
3993 break;
Paul Elliott0023e0a2021-04-27 10:06:22 +01003994 }
3995
Paul Elliott8fc45162021-06-23 16:06:01 +01003996 /* Goto is required to silence warnings about unused labels, as we
3997 * don't actually do any test assertions in this function. */
Paul Elliottd3f82412021-06-16 16:52:21 +01003998 goto exit;
Paul Elliott0023e0a2021-04-27 10:06:22 +01003999}
4000/* END_CASE */
4001
4002/* BEGIN_CASE */
Paul Elliott8eb9daf2021-06-04 16:42:21 +01004003void aead_multipart_generate_nonce( int key_type_arg, data_t *key_data,
4004 int alg_arg,
Paul Elliottf1277632021-08-24 18:11:37 +01004005 int nonce_length,
4006 int expected_nonce_length_arg,
Paul Elliott3bd5dba2021-06-23 17:14:40 +01004007 data_t *additional_data,
4008 data_t *input_data,
4009 int expected_status_arg )
Paul Elliott8eb9daf2021-06-04 16:42:21 +01004010{
4011
4012 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
4013 psa_key_type_t key_type = key_type_arg;
4014 psa_algorithm_t alg = alg_arg;
Paul Elliottfbb4c6d2021-09-22 16:44:21 +01004015 psa_aead_operation_t operation = PSA_AEAD_OPERATION_INIT;
Paul Elliott8eb9daf2021-06-04 16:42:21 +01004016 uint8_t nonce_buffer[PSA_AEAD_NONCE_MAX_SIZE];
4017 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
4018 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Paul Elliott693bf312021-07-23 17:40:41 +01004019 psa_status_t expected_status = expected_status_arg;
Paul Elliottf1277632021-08-24 18:11:37 +01004020 size_t actual_nonce_length = 0;
4021 size_t expected_nonce_length = expected_nonce_length_arg;
4022 unsigned char *output = NULL;
4023 unsigned char *ciphertext = NULL;
Paul Elliott3bd5dba2021-06-23 17:14:40 +01004024 size_t output_size = 0;
Paul Elliottf1277632021-08-24 18:11:37 +01004025 size_t ciphertext_size = 0;
4026 size_t ciphertext_length = 0;
Paul Elliott3bd5dba2021-06-23 17:14:40 +01004027 size_t tag_length = 0;
4028 uint8_t tag_buffer[PSA_AEAD_TAG_MAX_SIZE];
Paul Elliott8eb9daf2021-06-04 16:42:21 +01004029
4030 PSA_ASSERT( psa_crypto_init( ) );
4031
4032 psa_set_key_usage_flags( & attributes, PSA_KEY_USAGE_ENCRYPT );
4033 psa_set_key_algorithm( & attributes, alg );
4034 psa_set_key_type( & attributes, key_type );
4035
4036 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
4037 &key ) );
4038
4039 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
4040
Paul Elliott3bd5dba2021-06-23 17:14:40 +01004041 output_size = PSA_AEAD_UPDATE_OUTPUT_SIZE( key_type, alg, input_data->len );
4042
Paul Elliottf1277632021-08-24 18:11:37 +01004043 ASSERT_ALLOC( output, output_size );
Paul Elliott3bd5dba2021-06-23 17:14:40 +01004044
Paul Elliottf1277632021-08-24 18:11:37 +01004045 ciphertext_size = PSA_AEAD_FINISH_OUTPUT_SIZE( key_type, alg );
Paul Elliott3bd5dba2021-06-23 17:14:40 +01004046
Paul Elliottf1277632021-08-24 18:11:37 +01004047 TEST_ASSERT( ciphertext_size <= PSA_AEAD_FINISH_OUTPUT_MAX_SIZE );
Paul Elliott3bd5dba2021-06-23 17:14:40 +01004048
Paul Elliottf1277632021-08-24 18:11:37 +01004049 ASSERT_ALLOC( ciphertext, ciphertext_size );
Paul Elliott3bd5dba2021-06-23 17:14:40 +01004050
Paul Elliott8eb9daf2021-06-04 16:42:21 +01004051 status = psa_aead_encrypt_setup( &operation, key, alg );
4052
4053 /* If the operation is not supported, just skip and not fail in case the
4054 * encryption involves a common limitation of cryptography hardwares and
4055 * an alternative implementation. */
4056 if( status == PSA_ERROR_NOT_SUPPORTED )
4057 {
4058 MBEDTLS_TEST_PSA_SKIP_IF_ALT_AES_192( key_type, key_data->len * 8 );
Paul Elliottf1277632021-08-24 18:11:37 +01004059 MBEDTLS_TEST_PSA_SKIP_IF_ALT_GCM_NOT_12BYTES_NONCE( alg, nonce_length );
Paul Elliott8eb9daf2021-06-04 16:42:21 +01004060 }
4061
4062 PSA_ASSERT( status );
4063
Paul Elliott8eb9daf2021-06-04 16:42:21 +01004064 status = psa_aead_generate_nonce( &operation, nonce_buffer,
Paul Elliottf1277632021-08-24 18:11:37 +01004065 nonce_length,
4066 &actual_nonce_length );
Paul Elliott8eb9daf2021-06-04 16:42:21 +01004067
Paul Elliott693bf312021-07-23 17:40:41 +01004068 TEST_EQUAL( status, expected_status );
Paul Elliott3bd5dba2021-06-23 17:14:40 +01004069
Paul Elliottf1277632021-08-24 18:11:37 +01004070 TEST_EQUAL( actual_nonce_length, expected_nonce_length );
Paul Elliottd85f5472021-07-16 18:20:16 +01004071
Paul Elliott88ecbe12021-09-22 17:23:03 +01004072 if( expected_status == PSA_SUCCESS )
4073 TEST_EQUAL( actual_nonce_length, PSA_AEAD_NONCE_LENGTH( key_type,
4074 alg ) );
4075
Paul Elliottd79c5c52021-10-06 21:49:41 +01004076 TEST_ASSERT( actual_nonce_length <= PSA_AEAD_NONCE_MAX_SIZE );
Paul Elliotte0fcb3b2021-07-16 18:52:03 +01004077
Paul Elliott693bf312021-07-23 17:40:41 +01004078 if( expected_status == PSA_SUCCESS )
Paul Elliott3bd5dba2021-06-23 17:14:40 +01004079 {
Paul Elliott3bd5dba2021-06-23 17:14:40 +01004080 /* Ensure we can still complete operation. */
Paul Elliottd79c5c52021-10-06 21:49:41 +01004081 PSA_ASSERT( psa_aead_set_lengths( &operation, additional_data->len,
4082 input_data->len ) );
Paul Elliott3bd5dba2021-06-23 17:14:40 +01004083
4084 PSA_ASSERT( psa_aead_update_ad( &operation, additional_data->x,
4085 additional_data->len ) );
4086
4087 PSA_ASSERT( psa_aead_update( &operation, input_data->x, input_data->len,
Paul Elliottf1277632021-08-24 18:11:37 +01004088 output, output_size,
4089 &ciphertext_length ) );
Paul Elliott3bd5dba2021-06-23 17:14:40 +01004090
Paul Elliottf1277632021-08-24 18:11:37 +01004091 PSA_ASSERT( psa_aead_finish( &operation, ciphertext, ciphertext_size,
4092 &ciphertext_length, tag_buffer,
Paul Elliott3bd5dba2021-06-23 17:14:40 +01004093 PSA_AEAD_TAG_MAX_SIZE, &tag_length ) );
4094 }
Paul Elliott8eb9daf2021-06-04 16:42:21 +01004095
4096exit:
4097 psa_destroy_key( key );
Paul Elliottf1277632021-08-24 18:11:37 +01004098 mbedtls_free( output );
4099 mbedtls_free( ciphertext );
Paul Elliott8eb9daf2021-06-04 16:42:21 +01004100 psa_aead_abort( &operation );
4101 PSA_DONE( );
4102}
4103/* END_CASE */
4104
4105/* BEGIN_CASE */
Paul Elliott863864a2021-07-23 17:28:31 +01004106void aead_multipart_set_nonce( int key_type_arg, data_t *key_data,
4107 int alg_arg,
Paul Elliott4023ffd2021-09-10 16:21:22 +01004108 int nonce_length_arg,
Paul Elliott863864a2021-07-23 17:28:31 +01004109 data_t *additional_data,
4110 data_t *input_data,
4111 int expected_status_arg )
4112{
4113
4114 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
4115 psa_key_type_t key_type = key_type_arg;
4116 psa_algorithm_t alg = alg_arg;
Paul Elliottfbb4c6d2021-09-22 16:44:21 +01004117 psa_aead_operation_t operation = PSA_AEAD_OPERATION_INIT;
Paul Elliott863864a2021-07-23 17:28:31 +01004118 uint8_t *nonce_buffer = NULL;
4119 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
4120 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
4121 psa_status_t expected_status = expected_status_arg;
Paul Elliott6f0e7202021-08-25 12:57:18 +01004122 unsigned char *output = NULL;
4123 unsigned char *ciphertext = NULL;
Paul Elliott4023ffd2021-09-10 16:21:22 +01004124 size_t nonce_length;
Paul Elliott863864a2021-07-23 17:28:31 +01004125 size_t output_size = 0;
Paul Elliott6f0e7202021-08-25 12:57:18 +01004126 size_t ciphertext_size = 0;
4127 size_t ciphertext_length = 0;
Paul Elliott863864a2021-07-23 17:28:31 +01004128 size_t tag_length = 0;
4129 uint8_t tag_buffer[PSA_AEAD_TAG_MAX_SIZE];
Paul Elliott4023ffd2021-09-10 16:21:22 +01004130 size_t index = 0;
Paul Elliott863864a2021-07-23 17:28:31 +01004131
4132 PSA_ASSERT( psa_crypto_init( ) );
4133
4134 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
4135 psa_set_key_algorithm( &attributes, alg );
4136 psa_set_key_type( &attributes, key_type );
4137
4138 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
4139 &key ) );
4140
4141 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
4142
4143 output_size = PSA_AEAD_UPDATE_OUTPUT_SIZE( key_type, alg, input_data->len );
4144
Paul Elliott6f0e7202021-08-25 12:57:18 +01004145 ASSERT_ALLOC( output, output_size );
Paul Elliott863864a2021-07-23 17:28:31 +01004146
Paul Elliott6f0e7202021-08-25 12:57:18 +01004147 ciphertext_size = PSA_AEAD_FINISH_OUTPUT_SIZE( key_type, alg );
Paul Elliott863864a2021-07-23 17:28:31 +01004148
Paul Elliott6f0e7202021-08-25 12:57:18 +01004149 TEST_ASSERT( ciphertext_size <= PSA_AEAD_FINISH_OUTPUT_MAX_SIZE );
Paul Elliott863864a2021-07-23 17:28:31 +01004150
Paul Elliott6f0e7202021-08-25 12:57:18 +01004151 ASSERT_ALLOC( ciphertext, ciphertext_size );
Paul Elliott863864a2021-07-23 17:28:31 +01004152
Paul Elliott863864a2021-07-23 17:28:31 +01004153 status = psa_aead_encrypt_setup( &operation, key, alg );
4154
4155 /* If the operation is not supported, just skip and not fail in case the
4156 * encryption involves a common limitation of cryptography hardwares and
4157 * an alternative implementation. */
4158 if( status == PSA_ERROR_NOT_SUPPORTED )
4159 {
4160 MBEDTLS_TEST_PSA_SKIP_IF_ALT_AES_192( key_type, key_data->len * 8 );
Paul Elliott4023ffd2021-09-10 16:21:22 +01004161 MBEDTLS_TEST_PSA_SKIP_IF_ALT_GCM_NOT_12BYTES_NONCE( alg, nonce_length_arg );
Paul Elliott863864a2021-07-23 17:28:31 +01004162 }
4163
4164 PSA_ASSERT( status );
4165
Paul Elliott4023ffd2021-09-10 16:21:22 +01004166 /* -1 == zero length and valid buffer, 0 = zero length and NULL buffer. */
4167 if( nonce_length_arg == -1 )
Paul Elliott863864a2021-07-23 17:28:31 +01004168 {
Paul Elliott5e69aa52021-08-25 17:24:37 +01004169 /* Arbitrary size buffer, to test zero length valid buffer. */
4170 ASSERT_ALLOC( nonce_buffer, 4 );
Paul Elliott4023ffd2021-09-10 16:21:22 +01004171 nonce_length = 0;
Paul Elliott66696b52021-08-16 18:42:41 +01004172 }
4173 else
4174 {
Paul Elliott4023ffd2021-09-10 16:21:22 +01004175 /* If length is zero, then this will return NULL. */
4176 nonce_length = ( size_t ) nonce_length_arg;
Paul Elliott6f0e7202021-08-25 12:57:18 +01004177 ASSERT_ALLOC( nonce_buffer, nonce_length );
Paul Elliott66696b52021-08-16 18:42:41 +01004178
Paul Elliott4023ffd2021-09-10 16:21:22 +01004179 if( nonce_buffer )
Paul Elliott66696b52021-08-16 18:42:41 +01004180 {
Paul Elliott4023ffd2021-09-10 16:21:22 +01004181 for( index = 0; index < nonce_length - 1; ++index )
4182 {
4183 nonce_buffer[index] = 'a' + index;
4184 }
Paul Elliott66696b52021-08-16 18:42:41 +01004185 }
Paul Elliott863864a2021-07-23 17:28:31 +01004186 }
4187
Paul Elliott6f0e7202021-08-25 12:57:18 +01004188 status = psa_aead_set_nonce( &operation, nonce_buffer, nonce_length );
Paul Elliott863864a2021-07-23 17:28:31 +01004189
Paul Elliott693bf312021-07-23 17:40:41 +01004190 TEST_EQUAL( status, expected_status );
Paul Elliott863864a2021-07-23 17:28:31 +01004191
4192 if( expected_status == PSA_SUCCESS )
4193 {
4194 /* Ensure we can still complete operation. */
Paul Elliotte4c08ed2021-10-06 18:53:04 +01004195 PSA_ASSERT( psa_aead_set_lengths( &operation, additional_data->len,
4196 input_data->len ) );
Paul Elliott863864a2021-07-23 17:28:31 +01004197
4198 PSA_ASSERT( psa_aead_update_ad( &operation, additional_data->x,
4199 additional_data->len ) );
4200
4201 PSA_ASSERT( psa_aead_update( &operation, input_data->x, input_data->len,
Paul Elliott6f0e7202021-08-25 12:57:18 +01004202 output, output_size,
4203 &ciphertext_length ) );
Paul Elliott863864a2021-07-23 17:28:31 +01004204
Paul Elliott6f0e7202021-08-25 12:57:18 +01004205 PSA_ASSERT( psa_aead_finish( &operation, ciphertext, ciphertext_size,
4206 &ciphertext_length, tag_buffer,
Paul Elliott863864a2021-07-23 17:28:31 +01004207 PSA_AEAD_TAG_MAX_SIZE, &tag_length ) );
4208 }
4209
4210exit:
4211 psa_destroy_key( key );
Paul Elliott6f0e7202021-08-25 12:57:18 +01004212 mbedtls_free( output );
4213 mbedtls_free( ciphertext );
Paul Elliott863864a2021-07-23 17:28:31 +01004214 mbedtls_free( nonce_buffer );
4215 psa_aead_abort( &operation );
4216 PSA_DONE( );
4217}
4218/* END_CASE */
4219
4220/* BEGIN_CASE */
Paul Elliott43fbda62021-07-23 18:30:59 +01004221void aead_multipart_update_buffer_test( int key_type_arg, data_t *key_data,
4222 int alg_arg,
Paul Elliottc6d11d02021-09-01 12:04:23 +01004223 int output_size_arg,
Paul Elliott43fbda62021-07-23 18:30:59 +01004224 data_t *nonce,
4225 data_t *additional_data,
4226 data_t *input_data,
4227 int expected_status_arg )
4228{
4229
4230 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
4231 psa_key_type_t key_type = key_type_arg;
4232 psa_algorithm_t alg = alg_arg;
Paul Elliottfbb4c6d2021-09-22 16:44:21 +01004233 psa_aead_operation_t operation = PSA_AEAD_OPERATION_INIT;
Paul Elliott43fbda62021-07-23 18:30:59 +01004234 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
4235 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
4236 psa_status_t expected_status = expected_status_arg;
Paul Elliottc6d11d02021-09-01 12:04:23 +01004237 unsigned char *output = NULL;
4238 unsigned char *ciphertext = NULL;
4239 size_t output_size = output_size_arg;
4240 size_t ciphertext_size = 0;
4241 size_t ciphertext_length = 0;
Paul Elliott43fbda62021-07-23 18:30:59 +01004242 size_t tag_length = 0;
4243 uint8_t tag_buffer[PSA_AEAD_TAG_MAX_SIZE];
4244
4245 PSA_ASSERT( psa_crypto_init( ) );
4246
4247 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
4248 psa_set_key_algorithm( &attributes, alg );
4249 psa_set_key_type( &attributes, key_type );
4250
4251 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
4252 &key ) );
4253
4254 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
4255
Paul Elliottc6d11d02021-09-01 12:04:23 +01004256 ASSERT_ALLOC( output, output_size );
Paul Elliott43fbda62021-07-23 18:30:59 +01004257
Paul Elliottc6d11d02021-09-01 12:04:23 +01004258 ciphertext_size = PSA_AEAD_FINISH_OUTPUT_SIZE( key_type, alg );
Paul Elliott43fbda62021-07-23 18:30:59 +01004259
Paul Elliottc6d11d02021-09-01 12:04:23 +01004260 ASSERT_ALLOC( ciphertext, ciphertext_size );
Paul Elliott43fbda62021-07-23 18:30:59 +01004261
Paul Elliott43fbda62021-07-23 18:30:59 +01004262 status = psa_aead_encrypt_setup( &operation, key, alg );
4263
4264 /* If the operation is not supported, just skip and not fail in case the
4265 * encryption involves a common limitation of cryptography hardwares and
4266 * an alternative implementation. */
4267 if( status == PSA_ERROR_NOT_SUPPORTED )
4268 {
4269 MBEDTLS_TEST_PSA_SKIP_IF_ALT_AES_192( key_type, key_data->len * 8 );
4270 MBEDTLS_TEST_PSA_SKIP_IF_ALT_GCM_NOT_12BYTES_NONCE( alg, nonce->len );
4271 }
4272
4273 PSA_ASSERT( status );
4274
Paul Elliott47b9a142021-10-07 15:04:57 +01004275 PSA_ASSERT( psa_aead_set_lengths( &operation, additional_data->len,
4276 input_data->len ) );
4277
Paul Elliott43fbda62021-07-23 18:30:59 +01004278 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
4279
4280 PSA_ASSERT( psa_aead_update_ad( &operation, additional_data->x,
4281 additional_data->len ) );
4282
4283 status = psa_aead_update( &operation, input_data->x, input_data->len,
Paul Elliottc6d11d02021-09-01 12:04:23 +01004284 output, output_size, &ciphertext_length );
Paul Elliott43fbda62021-07-23 18:30:59 +01004285
4286 TEST_EQUAL( status, expected_status );
4287
4288 if( expected_status == PSA_SUCCESS )
4289 {
4290 /* Ensure we can still complete operation. */
Paul Elliottc6d11d02021-09-01 12:04:23 +01004291 PSA_ASSERT( psa_aead_finish( &operation, ciphertext, ciphertext_size,
4292 &ciphertext_length, tag_buffer,
Paul Elliott43fbda62021-07-23 18:30:59 +01004293 PSA_AEAD_TAG_MAX_SIZE, &tag_length ) );
4294 }
4295
4296exit:
4297 psa_destroy_key( key );
Paul Elliottc6d11d02021-09-01 12:04:23 +01004298 mbedtls_free( output );
4299 mbedtls_free( ciphertext );
Paul Elliott43fbda62021-07-23 18:30:59 +01004300 psa_aead_abort( &operation );
4301 PSA_DONE( );
4302}
4303/* END_CASE */
4304
Paul Elliott91b021e2021-07-23 18:52:31 +01004305/* BEGIN_CASE */
4306void aead_multipart_finish_buffer_test( int key_type_arg, data_t *key_data,
4307 int alg_arg,
Paul Elliotte58cb1e2021-09-10 18:36:00 +01004308 int finish_ciphertext_size_arg,
Paul Elliott719c1322021-09-13 18:27:22 +01004309 int tag_size_arg,
Paul Elliott91b021e2021-07-23 18:52:31 +01004310 data_t *nonce,
4311 data_t *additional_data,
4312 data_t *input_data,
4313 int expected_status_arg )
4314{
4315
4316 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
4317 psa_key_type_t key_type = key_type_arg;
4318 psa_algorithm_t alg = alg_arg;
Paul Elliottfbb4c6d2021-09-22 16:44:21 +01004319 psa_aead_operation_t operation = PSA_AEAD_OPERATION_INIT;
Paul Elliott91b021e2021-07-23 18:52:31 +01004320 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
4321 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
4322 psa_status_t expected_status = expected_status_arg;
Paul Elliotte58cb1e2021-09-10 18:36:00 +01004323 unsigned char *ciphertext = NULL;
4324 unsigned char *finish_ciphertext = NULL;
Paul Elliott719c1322021-09-13 18:27:22 +01004325 unsigned char *tag_buffer = NULL;
Paul Elliotte58cb1e2021-09-10 18:36:00 +01004326 size_t ciphertext_size = 0;
4327 size_t ciphertext_length = 0;
4328 size_t finish_ciphertext_size = ( size_t ) finish_ciphertext_size_arg;
Paul Elliott719c1322021-09-13 18:27:22 +01004329 size_t tag_size = ( size_t ) tag_size_arg;
Paul Elliott91b021e2021-07-23 18:52:31 +01004330 size_t tag_length = 0;
Paul Elliott91b021e2021-07-23 18:52:31 +01004331
4332 PSA_ASSERT( psa_crypto_init( ) );
4333
4334 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
4335 psa_set_key_algorithm( &attributes, alg );
4336 psa_set_key_type( &attributes, key_type );
4337
4338 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
4339 &key ) );
4340
4341 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
4342
Paul Elliotte58cb1e2021-09-10 18:36:00 +01004343 ciphertext_size = PSA_AEAD_UPDATE_OUTPUT_SIZE( key_type, alg, input_data->len );
Paul Elliott91b021e2021-07-23 18:52:31 +01004344
Paul Elliotte58cb1e2021-09-10 18:36:00 +01004345 ASSERT_ALLOC( ciphertext, ciphertext_size );
Paul Elliott91b021e2021-07-23 18:52:31 +01004346
Paul Elliotte58cb1e2021-09-10 18:36:00 +01004347 ASSERT_ALLOC( finish_ciphertext, finish_ciphertext_size );
Paul Elliott91b021e2021-07-23 18:52:31 +01004348
Paul Elliott719c1322021-09-13 18:27:22 +01004349 ASSERT_ALLOC( tag_buffer, tag_size );
4350
Paul Elliott91b021e2021-07-23 18:52:31 +01004351 status = psa_aead_encrypt_setup( &operation, key, alg );
4352
4353 /* If the operation is not supported, just skip and not fail in case the
4354 * encryption involves a common limitation of cryptography hardwares and
4355 * an alternative implementation. */
4356 if( status == PSA_ERROR_NOT_SUPPORTED )
4357 {
4358 MBEDTLS_TEST_PSA_SKIP_IF_ALT_AES_192( key_type, key_data->len * 8 );
4359 MBEDTLS_TEST_PSA_SKIP_IF_ALT_GCM_NOT_12BYTES_NONCE( alg, nonce->len );
4360 }
4361
4362 PSA_ASSERT( status );
4363
4364 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
4365
Paul Elliott76bda482021-10-07 17:07:23 +01004366 PSA_ASSERT( psa_aead_set_lengths( &operation, additional_data->len,
4367 input_data->len ) );
4368
Paul Elliott91b021e2021-07-23 18:52:31 +01004369 PSA_ASSERT( psa_aead_update_ad( &operation, additional_data->x,
4370 additional_data->len ) );
4371
4372 PSA_ASSERT( psa_aead_update( &operation, input_data->x, input_data->len,
Paul Elliotte58cb1e2021-09-10 18:36:00 +01004373 ciphertext, ciphertext_size, &ciphertext_length ) );
Paul Elliott91b021e2021-07-23 18:52:31 +01004374
4375 /* Ensure we can still complete operation. */
Paul Elliotte58cb1e2021-09-10 18:36:00 +01004376 status = psa_aead_finish( &operation, finish_ciphertext,
4377 finish_ciphertext_size,
4378 &ciphertext_length, tag_buffer,
Paul Elliott719c1322021-09-13 18:27:22 +01004379 tag_size, &tag_length );
Paul Elliott91b021e2021-07-23 18:52:31 +01004380
4381 TEST_EQUAL( status, expected_status );
4382
4383exit:
4384 psa_destroy_key( key );
Paul Elliotte58cb1e2021-09-10 18:36:00 +01004385 mbedtls_free( ciphertext );
4386 mbedtls_free( finish_ciphertext );
Paul Elliott4a760882021-09-20 09:42:21 +01004387 mbedtls_free( tag_buffer );
Paul Elliott91b021e2021-07-23 18:52:31 +01004388 psa_aead_abort( &operation );
4389 PSA_DONE( );
4390}
4391/* END_CASE */
Paul Elliott43fbda62021-07-23 18:30:59 +01004392
4393/* BEGIN_CASE */
Paul Elliott9961a662021-09-17 19:19:02 +01004394void aead_multipart_verify( int key_type_arg, data_t *key_data,
4395 int alg_arg,
4396 data_t *nonce,
4397 data_t *additional_data,
4398 data_t *input_data,
4399 data_t *tag,
Paul Elliott1c67e0b2021-09-19 13:11:50 +01004400 int tag_usage_arg,
Paul Elliott9961a662021-09-17 19:19:02 +01004401 int expected_status_arg )
4402{
4403 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
4404 psa_key_type_t key_type = key_type_arg;
4405 psa_algorithm_t alg = alg_arg;
Paul Elliottfbb4c6d2021-09-22 16:44:21 +01004406 psa_aead_operation_t operation = PSA_AEAD_OPERATION_INIT;
Paul Elliott9961a662021-09-17 19:19:02 +01004407 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
4408 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
4409 psa_status_t expected_status = expected_status_arg;
4410 unsigned char *plaintext = NULL;
4411 unsigned char *finish_plaintext = NULL;
4412 size_t plaintext_size = 0;
4413 size_t plaintext_length = 0;
4414 size_t verify_plaintext_size = 0;
Paul Elliottbb979e72021-09-22 12:54:42 +01004415 tag_usage_method_t tag_usage = tag_usage_arg;
Paul Elliott1c67e0b2021-09-19 13:11:50 +01004416 unsigned char *tag_buffer = NULL;
4417 size_t tag_size = 0;
Paul Elliott9961a662021-09-17 19:19:02 +01004418
4419 PSA_ASSERT( psa_crypto_init( ) );
4420
4421 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DECRYPT );
4422 psa_set_key_algorithm( &attributes, alg );
4423 psa_set_key_type( &attributes, key_type );
4424
4425 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
4426 &key ) );
4427
4428 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
4429
4430 plaintext_size = PSA_AEAD_UPDATE_OUTPUT_SIZE( key_type, alg,
4431 input_data->len );
4432
4433 ASSERT_ALLOC( plaintext, plaintext_size );
4434
4435 verify_plaintext_size = PSA_AEAD_VERIFY_OUTPUT_SIZE( key_type, alg );
4436
4437 ASSERT_ALLOC( finish_plaintext, verify_plaintext_size );
4438
Paul Elliott9961a662021-09-17 19:19:02 +01004439 status = psa_aead_decrypt_setup( &operation, key, alg );
4440
4441 /* If the operation is not supported, just skip and not fail in case the
4442 * encryption involves a common limitation of cryptography hardwares and
4443 * an alternative implementation. */
4444 if( status == PSA_ERROR_NOT_SUPPORTED )
4445 {
4446 MBEDTLS_TEST_PSA_SKIP_IF_ALT_AES_192( key_type, key_data->len * 8 );
4447 MBEDTLS_TEST_PSA_SKIP_IF_ALT_GCM_NOT_12BYTES_NONCE( alg, nonce->len );
4448 }
4449
4450 PSA_ASSERT( status );
4451
4452 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
4453
Paul Elliottfec6f372021-10-06 17:15:02 +01004454 status = psa_aead_set_lengths( &operation, additional_data->len,
4455 input_data->len );
4456
4457 if( status != PSA_SUCCESS )
4458 {
4459 /* Invalid tag lengths are detected in CCM at this point, as they
Paul Elliott37ec16b2021-12-08 20:14:49 +00004460 * would be written into the first block. They should really be
4461 * detected in psa_aead_encrypt/decrypt_setup, and will be fixed
4462 * to do so in the future, until that point, this is a
4463 * workaround.*/
Paul Elliottfec6f372021-10-06 17:15:02 +01004464 TEST_EQUAL( status, expected_status );
4465 goto exit;
4466 }
4467
Paul Elliott9961a662021-09-17 19:19:02 +01004468 PSA_ASSERT( psa_aead_update_ad( &operation, additional_data->x,
4469 additional_data->len ) );
4470
4471 PSA_ASSERT( psa_aead_update( &operation, input_data->x,
4472 input_data->len,
4473 plaintext, plaintext_size,
4474 &plaintext_length ) );
4475
Paul Elliott1c67e0b2021-09-19 13:11:50 +01004476 if( tag_usage == USE_GIVEN_TAG )
4477 {
4478 tag_buffer = tag->x;
4479 tag_size = tag->len;
4480 }
4481
Paul Elliott9961a662021-09-17 19:19:02 +01004482 status = psa_aead_verify( &operation, finish_plaintext,
4483 verify_plaintext_size,
4484 &plaintext_length,
Paul Elliott1c67e0b2021-09-19 13:11:50 +01004485 tag_buffer, tag_size );
Paul Elliott9961a662021-09-17 19:19:02 +01004486
4487 TEST_EQUAL( status, expected_status );
4488
4489exit:
4490 psa_destroy_key( key );
4491 mbedtls_free( plaintext );
4492 mbedtls_free( finish_plaintext );
4493 psa_aead_abort( &operation );
4494 PSA_DONE( );
4495}
4496/* END_CASE */
4497
Paul Elliott9961a662021-09-17 19:19:02 +01004498/* BEGIN_CASE */
Paul Elliott5221ef62021-09-19 17:33:03 +01004499void aead_multipart_setup( int key_type_arg, data_t *key_data,
4500 int alg_arg, int expected_status_arg )
4501{
4502 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
4503 psa_key_type_t key_type = key_type_arg;
4504 psa_algorithm_t alg = alg_arg;
Paul Elliottfbb4c6d2021-09-22 16:44:21 +01004505 psa_aead_operation_t operation = PSA_AEAD_OPERATION_INIT;
Paul Elliott5221ef62021-09-19 17:33:03 +01004506 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
4507 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
4508 psa_status_t expected_status = expected_status_arg;
4509
4510 PSA_ASSERT( psa_crypto_init( ) );
4511
4512 psa_set_key_usage_flags( &attributes,
4513 PSA_KEY_USAGE_ENCRYPT | PSA_KEY_USAGE_DECRYPT );
4514 psa_set_key_algorithm( &attributes, alg );
4515 psa_set_key_type( &attributes, key_type );
4516
4517 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
4518 &key ) );
4519
Paul Elliott5221ef62021-09-19 17:33:03 +01004520 status = psa_aead_encrypt_setup( &operation, key, alg );
4521
4522 TEST_EQUAL( status, expected_status );
4523
4524 psa_aead_abort( &operation );
4525
Paul Elliott5221ef62021-09-19 17:33:03 +01004526 status = psa_aead_decrypt_setup( &operation, key, alg );
4527
4528 TEST_EQUAL(status, expected_status );
4529
4530exit:
4531 psa_destroy_key( key );
4532 psa_aead_abort( &operation );
4533 PSA_DONE( );
4534}
4535/* END_CASE */
4536
4537/* BEGIN_CASE */
Paul Elliottc23a9a02021-06-21 18:32:46 +01004538void aead_multipart_state_test( int key_type_arg, data_t *key_data,
4539 int alg_arg,
4540 data_t *nonce,
4541 data_t *additional_data,
4542 data_t *input_data )
4543{
4544 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
4545 psa_key_type_t key_type = key_type_arg;
4546 psa_algorithm_t alg = alg_arg;
Paul Elliottfbb4c6d2021-09-22 16:44:21 +01004547 psa_aead_operation_t operation = PSA_AEAD_OPERATION_INIT;
Paul Elliottc23a9a02021-06-21 18:32:46 +01004548 unsigned char *output_data = NULL;
4549 unsigned char *final_data = NULL;
4550 size_t output_size = 0;
4551 size_t finish_output_size = 0;
4552 size_t output_length = 0;
4553 size_t key_bits = 0;
4554 size_t tag_length = 0;
4555 size_t tag_size = 0;
4556 size_t nonce_length = 0;
4557 uint8_t nonce_buffer[PSA_AEAD_NONCE_MAX_SIZE];
4558 uint8_t tag_buffer[PSA_AEAD_TAG_MAX_SIZE];
4559 size_t output_part_length = 0;
4560 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
4561
4562 PSA_ASSERT( psa_crypto_init( ) );
4563
4564 psa_set_key_usage_flags( & attributes,
4565 PSA_KEY_USAGE_ENCRYPT | PSA_KEY_USAGE_DECRYPT );
4566 psa_set_key_algorithm( & attributes, alg );
4567 psa_set_key_type( & attributes, key_type );
4568
4569 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
4570 &key ) );
4571
4572 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
4573 key_bits = psa_get_key_bits( &attributes );
4574
4575 tag_length = PSA_AEAD_TAG_LENGTH( key_type, key_bits, alg );
4576
4577 TEST_ASSERT( tag_length <= PSA_AEAD_TAG_MAX_SIZE );
4578
4579 output_size = PSA_AEAD_UPDATE_OUTPUT_SIZE( key_type, alg, input_data->len );
4580
4581 ASSERT_ALLOC( output_data, output_size );
4582
4583 finish_output_size = PSA_AEAD_FINISH_OUTPUT_SIZE( key_type, alg );
4584
4585 TEST_ASSERT( finish_output_size <= PSA_AEAD_FINISH_OUTPUT_MAX_SIZE );
4586
4587 ASSERT_ALLOC( final_data, finish_output_size );
4588
4589 /* Test all operations error without calling setup first. */
4590
Paul Elliottc23a9a02021-06-21 18:32:46 +01004591 TEST_EQUAL( psa_aead_set_nonce( &operation, nonce->x, nonce->len ),
4592 PSA_ERROR_BAD_STATE );
4593
4594 psa_aead_abort( &operation );
4595
Paul Elliottc23a9a02021-06-21 18:32:46 +01004596 TEST_EQUAL( psa_aead_generate_nonce( &operation, nonce_buffer,
4597 PSA_AEAD_NONCE_MAX_SIZE,
4598 &nonce_length ),
4599 PSA_ERROR_BAD_STATE );
4600
4601 psa_aead_abort( &operation );
4602
Paul Elliott481be342021-07-16 17:38:47 +01004603 /* ------------------------------------------------------- */
4604
Paul Elliottc23a9a02021-06-21 18:32:46 +01004605 TEST_EQUAL( psa_aead_set_lengths( &operation, additional_data->len,
4606 input_data->len ),
4607 PSA_ERROR_BAD_STATE );
4608
4609 psa_aead_abort( &operation );
4610
Paul Elliott481be342021-07-16 17:38:47 +01004611 /* ------------------------------------------------------- */
4612
Paul Elliottc23a9a02021-06-21 18:32:46 +01004613 TEST_EQUAL( psa_aead_update_ad( &operation, additional_data->x,
4614 additional_data->len ),
4615 PSA_ERROR_BAD_STATE );
4616
4617 psa_aead_abort( &operation );
4618
Paul Elliott481be342021-07-16 17:38:47 +01004619 /* ------------------------------------------------------- */
4620
Paul Elliottc23a9a02021-06-21 18:32:46 +01004621 TEST_EQUAL( psa_aead_update( &operation, input_data->x,
4622 input_data->len, output_data,
4623 output_size, &output_length ),
4624 PSA_ERROR_BAD_STATE );
4625
4626 psa_aead_abort( &operation );
4627
Paul Elliott481be342021-07-16 17:38:47 +01004628 /* ------------------------------------------------------- */
4629
Paul Elliottc23a9a02021-06-21 18:32:46 +01004630 TEST_EQUAL( psa_aead_finish( &operation, final_data,
4631 finish_output_size,
4632 &output_part_length,
4633 tag_buffer, tag_length,
4634 &tag_size ),
4635 PSA_ERROR_BAD_STATE );
4636
4637 psa_aead_abort( &operation );
4638
Paul Elliott481be342021-07-16 17:38:47 +01004639 /* ------------------------------------------------------- */
4640
Paul Elliottc23a9a02021-06-21 18:32:46 +01004641 TEST_EQUAL( psa_aead_verify( &operation, final_data,
4642 finish_output_size,
4643 &output_part_length,
4644 tag_buffer,
4645 tag_length ),
4646 PSA_ERROR_BAD_STATE );
4647
4648 psa_aead_abort( &operation );
4649
4650 /* Test for double setups. */
4651
Paul Elliottc23a9a02021-06-21 18:32:46 +01004652 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
4653
4654 TEST_EQUAL( psa_aead_encrypt_setup( &operation, key, alg ),
4655 PSA_ERROR_BAD_STATE );
4656
4657 psa_aead_abort( &operation );
4658
Paul Elliott481be342021-07-16 17:38:47 +01004659 /* ------------------------------------------------------- */
4660
Paul Elliottc23a9a02021-06-21 18:32:46 +01004661 PSA_ASSERT( psa_aead_decrypt_setup( &operation, key, alg ) );
4662
4663 TEST_EQUAL( psa_aead_decrypt_setup( &operation, key, alg ),
4664 PSA_ERROR_BAD_STATE );
4665
4666 psa_aead_abort( &operation );
4667
Paul Elliott374a2be2021-07-16 17:53:40 +01004668 /* ------------------------------------------------------- */
4669
Paul Elliott374a2be2021-07-16 17:53:40 +01004670 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
4671
4672 TEST_EQUAL( psa_aead_decrypt_setup( &operation, key, alg ),
4673 PSA_ERROR_BAD_STATE );
4674
4675 psa_aead_abort( &operation );
4676
4677 /* ------------------------------------------------------- */
4678
Paul Elliott374a2be2021-07-16 17:53:40 +01004679 PSA_ASSERT( psa_aead_decrypt_setup( &operation, key, alg ) );
4680
4681 TEST_EQUAL( psa_aead_encrypt_setup( &operation, key, alg ),
4682 PSA_ERROR_BAD_STATE );
4683
4684 psa_aead_abort( &operation );
4685
Paul Elliottc23a9a02021-06-21 18:32:46 +01004686 /* Test for not setting a nonce. */
4687
Paul Elliottc23a9a02021-06-21 18:32:46 +01004688 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
4689
4690 TEST_EQUAL( psa_aead_update_ad( &operation, additional_data->x,
4691 additional_data->len ),
4692 PSA_ERROR_BAD_STATE );
4693
4694 psa_aead_abort( &operation );
4695
Paul Elliott7f628422021-09-01 12:08:29 +01004696 /* ------------------------------------------------------- */
4697
Paul Elliott7f628422021-09-01 12:08:29 +01004698 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
4699
4700 TEST_EQUAL( psa_aead_update( &operation, input_data->x,
4701 input_data->len, output_data,
4702 output_size, &output_length ),
4703 PSA_ERROR_BAD_STATE );
4704
4705 psa_aead_abort( &operation );
4706
Paul Elliottbdc2c682021-09-21 18:37:10 +01004707 /* ------------------------------------------------------- */
4708
Paul Elliottbdc2c682021-09-21 18:37:10 +01004709 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
4710
4711 TEST_EQUAL( psa_aead_finish( &operation, final_data,
4712 finish_output_size,
4713 &output_part_length,
4714 tag_buffer, tag_length,
4715 &tag_size ),
4716 PSA_ERROR_BAD_STATE );
4717
4718 psa_aead_abort( &operation );
4719
4720 /* ------------------------------------------------------- */
4721
Paul Elliottbdc2c682021-09-21 18:37:10 +01004722 PSA_ASSERT( psa_aead_decrypt_setup( &operation, key, alg ) );
4723
4724 TEST_EQUAL( psa_aead_verify( &operation, final_data,
4725 finish_output_size,
4726 &output_part_length,
4727 tag_buffer,
4728 tag_length ),
4729 PSA_ERROR_BAD_STATE );
4730
4731 psa_aead_abort( &operation );
4732
Paul Elliottc23a9a02021-06-21 18:32:46 +01004733 /* Test for double setting nonce. */
4734
Paul Elliottc23a9a02021-06-21 18:32:46 +01004735 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
4736
4737 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
4738
4739 TEST_EQUAL( psa_aead_set_nonce( &operation, nonce->x, nonce->len ),
4740 PSA_ERROR_BAD_STATE );
4741
4742 psa_aead_abort( &operation );
4743
Paul Elliott374a2be2021-07-16 17:53:40 +01004744 /* Test for double generating nonce. */
4745
Paul Elliott374a2be2021-07-16 17:53:40 +01004746 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
4747
4748 PSA_ASSERT( psa_aead_generate_nonce( &operation, nonce_buffer,
4749 PSA_AEAD_NONCE_MAX_SIZE,
4750 &nonce_length ) );
4751
4752 TEST_EQUAL( psa_aead_generate_nonce( &operation, nonce_buffer,
4753 PSA_AEAD_NONCE_MAX_SIZE,
4754 &nonce_length ),
4755 PSA_ERROR_BAD_STATE );
4756
4757
4758 psa_aead_abort( &operation );
4759
4760 /* Test for generate nonce then set and vice versa */
4761
Paul Elliott374a2be2021-07-16 17:53:40 +01004762 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
4763
4764 PSA_ASSERT( psa_aead_generate_nonce( &operation, nonce_buffer,
4765 PSA_AEAD_NONCE_MAX_SIZE,
4766 &nonce_length ) );
4767
4768 TEST_EQUAL( psa_aead_set_nonce( &operation, nonce->x, nonce->len ),
4769 PSA_ERROR_BAD_STATE );
4770
4771 psa_aead_abort( &operation );
4772
Andrzej Kurekad837522021-12-15 15:28:49 +01004773 /* Test for generating nonce after calling set lengths */
4774
4775 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
4776
4777 PSA_ASSERT( psa_aead_set_lengths( &operation, additional_data->len,
4778 input_data->len ) );
4779
4780 PSA_ASSERT( psa_aead_generate_nonce( &operation, nonce_buffer,
4781 PSA_AEAD_NONCE_MAX_SIZE,
4782 &nonce_length ) );
4783
4784 psa_aead_abort( &operation );
4785
4786 /* Test for generating nonce after calling set lengths with UINT32_MAX length */
4787
4788 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
4789
4790 if( operation.alg == PSA_ALG_CCM )
4791 {
4792 TEST_EQUAL( psa_aead_set_lengths( &operation, UINT32_MAX,
4793 input_data->len ),
4794 PSA_ERROR_INVALID_ARGUMENT );
4795 TEST_EQUAL( psa_aead_generate_nonce( &operation, nonce_buffer,
4796 PSA_AEAD_NONCE_MAX_SIZE,
4797 &nonce_length ),
4798 PSA_ERROR_BAD_STATE );
4799 }
4800 else
4801 {
4802 PSA_ASSERT( psa_aead_set_lengths( &operation, UINT32_MAX,
4803 input_data->len ) );
4804 PSA_ASSERT( psa_aead_generate_nonce( &operation, nonce_buffer,
4805 PSA_AEAD_NONCE_MAX_SIZE,
4806 &nonce_length ) );
4807 }
4808
4809 psa_aead_abort( &operation );
4810
4811 /* Test for generating nonce after calling set lengths with SIZE_MAX length */
4812#if SIZE_MAX > UINT32_MAX
4813 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
4814
4815 if( operation.alg == PSA_ALG_CCM || operation.alg == PSA_ALG_GCM )
4816 {
4817 TEST_EQUAL( psa_aead_set_lengths( &operation, SIZE_MAX,
4818 input_data->len ),
4819 PSA_ERROR_INVALID_ARGUMENT );
4820 TEST_EQUAL( psa_aead_generate_nonce( &operation, nonce_buffer,
4821 PSA_AEAD_NONCE_MAX_SIZE,
4822 &nonce_length ),
4823 PSA_ERROR_BAD_STATE );
4824 }
4825 else
4826 {
4827 PSA_ASSERT( psa_aead_set_lengths( &operation, SIZE_MAX,
4828 input_data->len ) );
4829 PSA_ASSERT( psa_aead_generate_nonce( &operation, nonce_buffer,
4830 PSA_AEAD_NONCE_MAX_SIZE,
4831 &nonce_length ) );
4832 }
4833
4834 psa_aead_abort( &operation );
4835#endif
4836
4837 /* Test for calling set lengths with a length too long, after generating nonce */
4838
4839 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
4840
4841 PSA_ASSERT( psa_aead_generate_nonce( &operation, nonce_buffer,
4842 PSA_AEAD_NONCE_MAX_SIZE,
4843 &nonce_length ) );
4844
4845 if( operation.alg == PSA_ALG_CCM )
4846 {
4847 TEST_EQUAL( psa_aead_set_lengths( &operation, UINT32_MAX,
4848 input_data->len ),
4849 PSA_ERROR_INVALID_ARGUMENT );
4850 }
4851 else
4852 {
4853 PSA_ASSERT( psa_aead_set_lengths( &operation, UINT32_MAX,
4854 input_data->len ) );
4855 }
4856
4857 psa_aead_abort( &operation );
4858
4859
Paul Elliott374a2be2021-07-16 17:53:40 +01004860 /* ------------------------------------------------------- */
4861
Paul Elliott374a2be2021-07-16 17:53:40 +01004862 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
4863
4864 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
4865
4866 TEST_EQUAL( psa_aead_generate_nonce( &operation, nonce_buffer,
4867 PSA_AEAD_NONCE_MAX_SIZE,
4868 &nonce_length ),
4869 PSA_ERROR_BAD_STATE );
4870
4871 psa_aead_abort( &operation );
4872
Paul Elliott7220cae2021-06-22 17:25:57 +01004873 /* Test for generating nonce in decrypt setup. */
4874
Paul Elliott7220cae2021-06-22 17:25:57 +01004875 PSA_ASSERT( psa_aead_decrypt_setup( &operation, key, alg ) );
4876
4877 TEST_EQUAL( psa_aead_generate_nonce( &operation, nonce_buffer,
4878 PSA_AEAD_NONCE_MAX_SIZE,
4879 &nonce_length ),
4880 PSA_ERROR_BAD_STATE );
4881
4882 psa_aead_abort( &operation );
4883
Paul Elliottc23a9a02021-06-21 18:32:46 +01004884 /* Test for setting lengths twice. */
4885
Paul Elliottc23a9a02021-06-21 18:32:46 +01004886 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
4887
4888 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
4889
4890 PSA_ASSERT( psa_aead_set_lengths( &operation, additional_data->len,
4891 input_data->len ) );
4892
4893 TEST_EQUAL( psa_aead_set_lengths( &operation, additional_data->len,
4894 input_data->len ),
4895 PSA_ERROR_BAD_STATE );
4896
4897 psa_aead_abort( &operation );
4898
Andrzej Kurekad837522021-12-15 15:28:49 +01004899 /* Test for setting lengths after setting nonce + already starting data. */
Paul Elliottc23a9a02021-06-21 18:32:46 +01004900
Paul Elliottc23a9a02021-06-21 18:32:46 +01004901 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
4902
4903 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
4904
Andrzej Kurekad837522021-12-15 15:28:49 +01004905 if( operation.alg == PSA_ALG_CCM )
4906 {
Paul Elliottf94bd992021-09-19 18:15:59 +01004907
Andrzej Kurekad837522021-12-15 15:28:49 +01004908 TEST_EQUAL( psa_aead_update_ad( &operation, additional_data->x,
4909 additional_data->len ),
4910 PSA_ERROR_BAD_STATE );
4911 }
4912 else
4913 {
4914 PSA_ASSERT( psa_aead_update_ad( &operation, additional_data->x,
4915 additional_data->len ) );
Paul Elliottf94bd992021-09-19 18:15:59 +01004916
Andrzej Kurekad837522021-12-15 15:28:49 +01004917 TEST_EQUAL( psa_aead_set_lengths( &operation, additional_data->len,
4918 input_data->len ),
4919 PSA_ERROR_BAD_STATE );
4920 }
Paul Elliottf94bd992021-09-19 18:15:59 +01004921 psa_aead_abort( &operation );
4922
4923 /* ------------------------------------------------------- */
4924
Paul Elliottf94bd992021-09-19 18:15:59 +01004925 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
4926
4927 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
4928
Andrzej Kurekad837522021-12-15 15:28:49 +01004929 if( operation.alg == PSA_ALG_CCM )
4930 {
4931 TEST_EQUAL( psa_aead_update( &operation, input_data->x,
4932 input_data->len, output_data,
4933 output_size, &output_length ),
4934 PSA_ERROR_BAD_STATE );
Paul Elliottc23a9a02021-06-21 18:32:46 +01004935
Andrzej Kurekad837522021-12-15 15:28:49 +01004936 }
4937 else
4938 {
4939 PSA_ASSERT( psa_aead_update( &operation, input_data->x,
4940 input_data->len, output_data,
4941 output_size, &output_length ) );
Paul Elliottc23a9a02021-06-21 18:32:46 +01004942
Andrzej Kurekad837522021-12-15 15:28:49 +01004943 TEST_EQUAL( psa_aead_set_lengths( &operation, additional_data->len,
4944 input_data->len ),
4945 PSA_ERROR_BAD_STATE );
4946 }
4947 psa_aead_abort( &operation );
4948
4949 /* ------------------------------------------------------- */
4950
4951 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
4952
4953 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
4954
4955 if( operation.alg == PSA_ALG_CCM )
4956 {
4957 PSA_ASSERT( psa_aead_finish( &operation, final_data,
4958 finish_output_size,
4959 &output_part_length,
4960 tag_buffer, tag_length,
4961 &tag_size ) );
4962 }
4963 else
4964 {
4965 PSA_ASSERT( psa_aead_finish( &operation, final_data,
4966 finish_output_size,
4967 &output_part_length,
4968 tag_buffer, tag_length,
4969 &tag_size ) );
4970
4971 TEST_EQUAL( psa_aead_set_lengths( &operation, additional_data->len,
4972 input_data->len ),
4973 PSA_ERROR_BAD_STATE );
4974 }
4975 psa_aead_abort( &operation );
4976
4977 /* Test for setting lengths after generating nonce + already starting data. */
4978
4979 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
4980
4981 PSA_ASSERT( psa_aead_generate_nonce( &operation, nonce_buffer,
4982 PSA_AEAD_NONCE_MAX_SIZE,
4983 &nonce_length ) );
4984 if( operation.alg == PSA_ALG_CCM )
4985 {
4986
4987 TEST_EQUAL( psa_aead_update_ad( &operation, additional_data->x,
4988 additional_data->len ),
4989 PSA_ERROR_BAD_STATE );
4990 }
4991 else
4992 {
4993 PSA_ASSERT( psa_aead_update_ad( &operation, additional_data->x,
4994 additional_data->len ) );
4995
4996 TEST_EQUAL( psa_aead_set_lengths( &operation, additional_data->len,
4997 input_data->len ),
4998 PSA_ERROR_BAD_STATE );
4999 }
5000 psa_aead_abort( &operation );
5001
5002 /* ------------------------------------------------------- */
5003
5004 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
5005
5006 PSA_ASSERT( psa_aead_generate_nonce( &operation, nonce_buffer,
5007 PSA_AEAD_NONCE_MAX_SIZE,
5008 &nonce_length ) );
5009 if( operation.alg == PSA_ALG_CCM )
5010 {
5011 TEST_EQUAL( psa_aead_update( &operation, input_data->x,
5012 input_data->len, output_data,
5013 output_size, &output_length ),
5014 PSA_ERROR_BAD_STATE );
5015
5016 }
5017 else
5018 {
5019 PSA_ASSERT( psa_aead_update( &operation, input_data->x,
5020 input_data->len, output_data,
5021 output_size, &output_length ) );
5022
5023 TEST_EQUAL( psa_aead_set_lengths( &operation, additional_data->len,
5024 input_data->len ),
5025 PSA_ERROR_BAD_STATE );
5026 }
5027 psa_aead_abort( &operation );
5028
5029 /* ------------------------------------------------------- */
5030
5031 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
5032
5033 PSA_ASSERT( psa_aead_generate_nonce( &operation, nonce_buffer,
5034 PSA_AEAD_NONCE_MAX_SIZE,
5035 &nonce_length ) );
5036 if( operation.alg == PSA_ALG_CCM )
5037 {
5038 PSA_ASSERT( psa_aead_finish( &operation, final_data,
5039 finish_output_size,
5040 &output_part_length,
5041 tag_buffer, tag_length,
5042 &tag_size ) );
5043 }
5044 else
5045 {
5046 PSA_ASSERT( psa_aead_finish( &operation, final_data,
5047 finish_output_size,
5048 &output_part_length,
5049 tag_buffer, tag_length,
5050 &tag_size ) );
5051
5052 TEST_EQUAL( psa_aead_set_lengths( &operation, additional_data->len,
5053 input_data->len ),
5054 PSA_ERROR_BAD_STATE );
5055 }
Paul Elliottc23a9a02021-06-21 18:32:46 +01005056 psa_aead_abort( &operation );
5057
Paul Elliott243080c2021-07-21 19:01:17 +01005058 /* Test for not sending any additional data or data after setting non zero
5059 * lengths for them. (encrypt) */
Paul Elliottc23a9a02021-06-21 18:32:46 +01005060
Paul Elliottc23a9a02021-06-21 18:32:46 +01005061 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
5062
5063 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
5064
5065 PSA_ASSERT( psa_aead_set_lengths( &operation, additional_data->len,
5066 input_data->len ) );
5067
5068 TEST_EQUAL( psa_aead_finish( &operation, final_data,
5069 finish_output_size,
5070 &output_part_length,
5071 tag_buffer, tag_length,
5072 &tag_size ),
5073 PSA_ERROR_INVALID_ARGUMENT );
5074
5075 psa_aead_abort( &operation );
5076
Paul Elliott243080c2021-07-21 19:01:17 +01005077 /* Test for not sending any additional data or data after setting non-zero
5078 * lengths for them. (decrypt) */
Paul Elliottc23a9a02021-06-21 18:32:46 +01005079
Paul Elliottc23a9a02021-06-21 18:32:46 +01005080 PSA_ASSERT( psa_aead_decrypt_setup( &operation, key, alg ) );
5081
5082 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
5083
5084 PSA_ASSERT( psa_aead_set_lengths( &operation, additional_data->len,
5085 input_data->len ) );
5086
5087 TEST_EQUAL( psa_aead_verify( &operation, final_data,
5088 finish_output_size,
5089 &output_part_length,
5090 tag_buffer,
5091 tag_length ),
5092 PSA_ERROR_INVALID_ARGUMENT );
5093
5094 psa_aead_abort( &operation );
5095
Paul Elliott243080c2021-07-21 19:01:17 +01005096 /* Test for not sending any additional data after setting a non-zero length
5097 * for it. */
Paul Elliottc23a9a02021-06-21 18:32:46 +01005098
Paul Elliottc23a9a02021-06-21 18:32:46 +01005099 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
5100
5101 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
5102
5103 PSA_ASSERT( psa_aead_set_lengths( &operation, additional_data->len,
5104 input_data->len ) );
5105
5106 TEST_EQUAL( psa_aead_update( &operation, input_data->x,
5107 input_data->len, output_data,
5108 output_size, &output_length ),
5109 PSA_ERROR_INVALID_ARGUMENT );
5110
5111 psa_aead_abort( &operation );
5112
Paul Elliottf94bd992021-09-19 18:15:59 +01005113 /* Test for not sending any data after setting a non-zero length for it.*/
5114
Paul Elliottf94bd992021-09-19 18:15:59 +01005115 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
5116
5117 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
5118
5119 PSA_ASSERT( psa_aead_set_lengths( &operation, additional_data->len,
5120 input_data->len ) );
5121
5122 PSA_ASSERT( psa_aead_update_ad( &operation, additional_data->x,
5123 additional_data->len ) );
5124
5125 TEST_EQUAL( psa_aead_finish( &operation, final_data,
5126 finish_output_size,
5127 &output_part_length,
5128 tag_buffer, tag_length,
5129 &tag_size ),
5130 PSA_ERROR_INVALID_ARGUMENT );
5131
5132 psa_aead_abort( &operation );
5133
Paul Elliottb0450fe2021-09-01 15:06:26 +01005134 /* Test for sending too much additional data after setting lengths. */
5135
Paul Elliottb0450fe2021-09-01 15:06:26 +01005136 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
5137
5138 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
5139
5140 PSA_ASSERT( psa_aead_set_lengths( &operation, 0, 0 ) );
5141
5142
5143 TEST_EQUAL( psa_aead_update_ad( &operation, additional_data->x,
5144 additional_data->len ),
5145 PSA_ERROR_INVALID_ARGUMENT );
5146
5147 psa_aead_abort( &operation );
5148
Paul Elliotta2a09b02021-09-22 14:56:40 +01005149 /* ------------------------------------------------------- */
Paul Elliottfd0c154c2021-09-17 18:03:52 +01005150
5151 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
5152
5153 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
5154
5155 PSA_ASSERT( psa_aead_set_lengths( &operation, additional_data->len,
5156 input_data->len ) );
5157
5158 PSA_ASSERT( psa_aead_update_ad( &operation, additional_data->x,
5159 additional_data->len ) );
5160
5161 TEST_EQUAL( psa_aead_update_ad( &operation, additional_data->x,
5162 1 ),
5163 PSA_ERROR_INVALID_ARGUMENT );
5164
5165 psa_aead_abort( &operation );
5166
Paul Elliottb0450fe2021-09-01 15:06:26 +01005167 /* Test for sending too much data after setting lengths. */
5168
Paul Elliottb0450fe2021-09-01 15:06:26 +01005169 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
5170
5171 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
5172
5173 PSA_ASSERT( psa_aead_set_lengths( &operation, 0, 0 ) );
5174
5175 TEST_EQUAL( psa_aead_update( &operation, input_data->x,
5176 input_data->len, output_data,
5177 output_size, &output_length ),
5178 PSA_ERROR_INVALID_ARGUMENT );
5179
5180 psa_aead_abort( &operation );
5181
Paul Elliotta2a09b02021-09-22 14:56:40 +01005182 /* ------------------------------------------------------- */
Paul Elliottfd0c154c2021-09-17 18:03:52 +01005183
5184 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
5185
5186 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
5187
5188 PSA_ASSERT( psa_aead_set_lengths( &operation, additional_data->len,
5189 input_data->len ) );
5190
5191 PSA_ASSERT( psa_aead_update_ad( &operation, additional_data->x,
5192 additional_data->len ) );
5193
5194 PSA_ASSERT( psa_aead_update( &operation, input_data->x,
5195 input_data->len, output_data,
5196 output_size, &output_length ) );
5197
5198 TEST_EQUAL( psa_aead_update( &operation, input_data->x,
5199 1, output_data,
5200 output_size, &output_length ),
5201 PSA_ERROR_INVALID_ARGUMENT );
5202
5203 psa_aead_abort( &operation );
5204
Paul Elliottc23a9a02021-06-21 18:32:46 +01005205 /* Test sending additional data after data. */
5206
Paul Elliottc23a9a02021-06-21 18:32:46 +01005207 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
5208
5209 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
5210
Andrzej Kurekad837522021-12-15 15:28:49 +01005211 if( operation.alg != PSA_ALG_CCM )
5212 {
5213 PSA_ASSERT( psa_aead_update( &operation, input_data->x,
5214 input_data->len, output_data,
5215 output_size, &output_length ) );
Paul Elliottc23a9a02021-06-21 18:32:46 +01005216
Andrzej Kurekad837522021-12-15 15:28:49 +01005217 TEST_EQUAL( psa_aead_update_ad( &operation, additional_data->x,
5218 additional_data->len ),
5219 PSA_ERROR_BAD_STATE );
5220 }
Paul Elliottc23a9a02021-06-21 18:32:46 +01005221 psa_aead_abort( &operation );
5222
Paul Elliott534d0b42021-06-22 19:15:20 +01005223 /* Test calling finish on decryption. */
5224
Paul Elliott534d0b42021-06-22 19:15:20 +01005225 PSA_ASSERT( psa_aead_decrypt_setup( &operation, key, alg ) );
5226
5227 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
5228
5229 TEST_EQUAL( psa_aead_finish( &operation, final_data,
5230 finish_output_size,
5231 &output_part_length,
5232 tag_buffer, tag_length,
5233 &tag_size ),
5234 PSA_ERROR_BAD_STATE );
5235
5236 psa_aead_abort( &operation );
5237
5238 /* Test calling verify on encryption. */
5239
Paul Elliott534d0b42021-06-22 19:15:20 +01005240 PSA_ASSERT( psa_aead_encrypt_setup( &operation, key, alg ) );
5241
5242 PSA_ASSERT( psa_aead_set_nonce( &operation, nonce->x, nonce->len ) );
5243
5244 TEST_EQUAL( psa_aead_verify( &operation, final_data,
5245 finish_output_size,
5246 &output_part_length,
5247 tag_buffer,
5248 tag_length ),
Paul Elliott5b065cb2021-06-23 08:33:22 +01005249 PSA_ERROR_BAD_STATE );
Paul Elliott534d0b42021-06-22 19:15:20 +01005250
5251 psa_aead_abort( &operation );
5252
5253
Paul Elliottc23a9a02021-06-21 18:32:46 +01005254exit:
5255 psa_destroy_key( key );
5256 psa_aead_abort( &operation );
5257 mbedtls_free( output_data );
5258 mbedtls_free( final_data );
5259 PSA_DONE( );
5260}
5261/* END_CASE */
5262
5263/* BEGIN_CASE */
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02005264void signature_size( int type_arg,
5265 int bits,
5266 int alg_arg,
5267 int expected_size_arg )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005268{
5269 psa_key_type_t type = type_arg;
5270 psa_algorithm_t alg = alg_arg;
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01005271 size_t actual_size = PSA_SIGN_OUTPUT_SIZE( type, bits, alg );
Gilles Peskine841b14b2019-11-26 17:37:37 +01005272
Gilles Peskinefe11b722018-12-18 00:24:04 +01005273 TEST_EQUAL( actual_size, (size_t) expected_size_arg );
Gilles Peskine841b14b2019-11-26 17:37:37 +01005274
Gilles Peskinee59236f2018-01-27 23:32:46 +01005275exit:
5276 ;
5277}
5278/* END_CASE */
5279
5280/* BEGIN_CASE */
gabor-mezei-armb9530232021-04-16 14:21:21 +02005281void sign_hash_deterministic( int key_type_arg, data_t *key_data,
5282 int alg_arg, data_t *input_data,
5283 data_t *output_data )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005284{
Ronald Cron5425a212020-08-04 14:58:35 +02005285 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005286 psa_key_type_t key_type = key_type_arg;
5287 psa_algorithm_t alg = alg_arg;
Gilles Peskine20035e32018-02-03 22:44:14 +01005288 size_t key_bits;
Gilles Peskine20035e32018-02-03 22:44:14 +01005289 unsigned char *signature = NULL;
5290 size_t signature_size;
5291 size_t signature_length = 0xdeadbeef;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02005292 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine20035e32018-02-03 22:44:14 +01005293
Gilles Peskine8817f612018-12-18 00:18:46 +01005294 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine20035e32018-02-03 22:44:14 +01005295
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01005296 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_HASH );
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02005297 psa_set_key_algorithm( &attributes, alg );
5298 psa_set_key_type( &attributes, key_type );
mohammad1603a97cb8c2018-03-28 03:46:26 -07005299
Gilles Peskine049c7532019-05-15 20:22:09 +02005300 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02005301 &key ) );
5302 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02005303 key_bits = psa_get_key_bits( &attributes );
Gilles Peskine20035e32018-02-03 22:44:14 +01005304
Gilles Peskine860ce9d2018-06-28 12:23:00 +02005305 /* Allocate a buffer which has the size advertized by the
5306 * library. */
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01005307 signature_size = PSA_SIGN_OUTPUT_SIZE( key_type,
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02005308 key_bits, alg );
Gilles Peskine20035e32018-02-03 22:44:14 +01005309 TEST_ASSERT( signature_size != 0 );
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01005310 TEST_ASSERT( signature_size <= PSA_SIGNATURE_MAX_SIZE );
Gilles Peskine8cebbba2018-09-27 13:54:18 +02005311 ASSERT_ALLOC( signature, signature_size );
Gilles Peskine20035e32018-02-03 22:44:14 +01005312
Gilles Peskine860ce9d2018-06-28 12:23:00 +02005313 /* Perform the signature. */
Ronald Cron5425a212020-08-04 14:58:35 +02005314 PSA_ASSERT( psa_sign_hash( key, alg,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01005315 input_data->x, input_data->len,
5316 signature, signature_size,
5317 &signature_length ) );
Gilles Peskine9911b022018-06-29 17:30:48 +02005318 /* Verify that the signature is what is expected. */
Gilles Peskinebd7dea92018-09-27 13:57:19 +02005319 ASSERT_COMPARE( output_data->x, output_data->len,
5320 signature, signature_length );
Gilles Peskine20035e32018-02-03 22:44:14 +01005321
5322exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +01005323 /*
5324 * Key attributes may have been returned by psa_get_key_attributes()
5325 * thus reset them as required.
5326 */
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02005327 psa_reset_key_attributes( &attributes );
Ronald Cron3a4f0e32020-11-19 17:55:23 +01005328
Ronald Cron5425a212020-08-04 14:58:35 +02005329 psa_destroy_key( key );
Gilles Peskine0189e752018-02-03 23:57:22 +01005330 mbedtls_free( signature );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02005331 PSA_DONE( );
Gilles Peskine20035e32018-02-03 22:44:14 +01005332}
5333/* END_CASE */
5334
5335/* BEGIN_CASE */
gabor-mezei-armb9530232021-04-16 14:21:21 +02005336void sign_hash_fail( int key_type_arg, data_t *key_data,
5337 int alg_arg, data_t *input_data,
5338 int signature_size_arg, int expected_status_arg )
Gilles Peskine20035e32018-02-03 22:44:14 +01005339{
Ronald Cron5425a212020-08-04 14:58:35 +02005340 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine20035e32018-02-03 22:44:14 +01005341 psa_key_type_t key_type = key_type_arg;
5342 psa_algorithm_t alg = alg_arg;
Gilles Peskine860ce9d2018-06-28 12:23:00 +02005343 size_t signature_size = signature_size_arg;
Gilles Peskine20035e32018-02-03 22:44:14 +01005344 psa_status_t actual_status;
5345 psa_status_t expected_status = expected_status_arg;
Gilles Peskine40f68b92018-03-07 16:43:36 +01005346 unsigned char *signature = NULL;
Gilles Peskine93aa0332018-02-03 23:58:03 +01005347 size_t signature_length = 0xdeadbeef;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02005348 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine20035e32018-02-03 22:44:14 +01005349
Gilles Peskine8cebbba2018-09-27 13:54:18 +02005350 ASSERT_ALLOC( signature, signature_size );
Gilles Peskine20035e32018-02-03 22:44:14 +01005351
Gilles Peskine8817f612018-12-18 00:18:46 +01005352 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine20035e32018-02-03 22:44:14 +01005353
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01005354 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_HASH );
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02005355 psa_set_key_algorithm( &attributes, alg );
5356 psa_set_key_type( &attributes, key_type );
mohammad1603a97cb8c2018-03-28 03:46:26 -07005357
Gilles Peskine049c7532019-05-15 20:22:09 +02005358 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02005359 &key ) );
Gilles Peskine20035e32018-02-03 22:44:14 +01005360
Ronald Cron5425a212020-08-04 14:58:35 +02005361 actual_status = psa_sign_hash( key, alg,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01005362 input_data->x, input_data->len,
5363 signature, signature_size,
5364 &signature_length );
Gilles Peskinefe11b722018-12-18 00:24:04 +01005365 TEST_EQUAL( actual_status, expected_status );
Gilles Peskine860ce9d2018-06-28 12:23:00 +02005366 /* The value of *signature_length is unspecified on error, but
5367 * whatever it is, it should be less than signature_size, so that
5368 * if the caller tries to read *signature_length bytes without
5369 * checking the error code then they don't overflow a buffer. */
5370 TEST_ASSERT( signature_length <= signature_size );
Gilles Peskine20035e32018-02-03 22:44:14 +01005371
5372exit:
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02005373 psa_reset_key_attributes( &attributes );
Ronald Cron5425a212020-08-04 14:58:35 +02005374 psa_destroy_key( key );
Gilles Peskine20035e32018-02-03 22:44:14 +01005375 mbedtls_free( signature );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02005376 PSA_DONE( );
Gilles Peskine20035e32018-02-03 22:44:14 +01005377}
5378/* END_CASE */
mohammad16038cc1cee2018-03-28 01:21:33 +03005379
5380/* BEGIN_CASE */
gabor-mezei-armb9530232021-04-16 14:21:21 +02005381void sign_verify_hash( int key_type_arg, data_t *key_data,
5382 int alg_arg, data_t *input_data )
Gilles Peskine9911b022018-06-29 17:30:48 +02005383{
Ronald Cron5425a212020-08-04 14:58:35 +02005384 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine9911b022018-06-29 17:30:48 +02005385 psa_key_type_t key_type = key_type_arg;
5386 psa_algorithm_t alg = alg_arg;
5387 size_t key_bits;
5388 unsigned char *signature = NULL;
5389 size_t signature_size;
5390 size_t signature_length = 0xdeadbeef;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02005391 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine9911b022018-06-29 17:30:48 +02005392
Gilles Peskine8817f612018-12-18 00:18:46 +01005393 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine9911b022018-06-29 17:30:48 +02005394
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01005395 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_HASH | PSA_KEY_USAGE_VERIFY_HASH );
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02005396 psa_set_key_algorithm( &attributes, alg );
5397 psa_set_key_type( &attributes, key_type );
Gilles Peskine9911b022018-06-29 17:30:48 +02005398
Gilles Peskine049c7532019-05-15 20:22:09 +02005399 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02005400 &key ) );
5401 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02005402 key_bits = psa_get_key_bits( &attributes );
Gilles Peskine9911b022018-06-29 17:30:48 +02005403
5404 /* Allocate a buffer which has the size advertized by the
5405 * library. */
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01005406 signature_size = PSA_SIGN_OUTPUT_SIZE( key_type,
Gilles Peskine9911b022018-06-29 17:30:48 +02005407 key_bits, alg );
5408 TEST_ASSERT( signature_size != 0 );
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01005409 TEST_ASSERT( signature_size <= PSA_SIGNATURE_MAX_SIZE );
Gilles Peskine8cebbba2018-09-27 13:54:18 +02005410 ASSERT_ALLOC( signature, signature_size );
Gilles Peskine9911b022018-06-29 17:30:48 +02005411
5412 /* Perform the signature. */
Ronald Cron5425a212020-08-04 14:58:35 +02005413 PSA_ASSERT( psa_sign_hash( key, alg,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01005414 input_data->x, input_data->len,
5415 signature, signature_size,
5416 &signature_length ) );
Gilles Peskine9911b022018-06-29 17:30:48 +02005417 /* Check that the signature length looks sensible. */
5418 TEST_ASSERT( signature_length <= signature_size );
5419 TEST_ASSERT( signature_length > 0 );
5420
5421 /* Use the library to verify that the signature is correct. */
Ronald Cron5425a212020-08-04 14:58:35 +02005422 PSA_ASSERT( psa_verify_hash( key, alg,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01005423 input_data->x, input_data->len,
5424 signature, signature_length ) );
Gilles Peskine9911b022018-06-29 17:30:48 +02005425
5426 if( input_data->len != 0 )
5427 {
5428 /* Flip a bit in the input and verify that the signature is now
5429 * detected as invalid. Flip a bit at the beginning, not at the end,
5430 * because ECDSA may ignore the last few bits of the input. */
5431 input_data->x[0] ^= 1;
Ronald Cron5425a212020-08-04 14:58:35 +02005432 TEST_EQUAL( psa_verify_hash( key, alg,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01005433 input_data->x, input_data->len,
5434 signature, signature_length ),
Gilles Peskinef812dcf2018-12-18 00:33:25 +01005435 PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine9911b022018-06-29 17:30:48 +02005436 }
5437
5438exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +01005439 /*
5440 * Key attributes may have been returned by psa_get_key_attributes()
5441 * thus reset them as required.
5442 */
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02005443 psa_reset_key_attributes( &attributes );
Ronald Cron3a4f0e32020-11-19 17:55:23 +01005444
Ronald Cron5425a212020-08-04 14:58:35 +02005445 psa_destroy_key( key );
Gilles Peskine9911b022018-06-29 17:30:48 +02005446 mbedtls_free( signature );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02005447 PSA_DONE( );
Gilles Peskine9911b022018-06-29 17:30:48 +02005448}
5449/* END_CASE */
5450
5451/* BEGIN_CASE */
gabor-mezei-armb9530232021-04-16 14:21:21 +02005452void verify_hash( int key_type_arg, data_t *key_data,
5453 int alg_arg, data_t *hash_data,
5454 data_t *signature_data )
itayzafrir5c753392018-05-08 11:18:38 +03005455{
Ronald Cron5425a212020-08-04 14:58:35 +02005456 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
itayzafrir5c753392018-05-08 11:18:38 +03005457 psa_key_type_t key_type = key_type_arg;
5458 psa_algorithm_t alg = alg_arg;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02005459 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
itayzafrir5c753392018-05-08 11:18:38 +03005460
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01005461 TEST_ASSERT( signature_data->len <= PSA_SIGNATURE_MAX_SIZE );
Gilles Peskine69c12672018-06-28 00:07:19 +02005462
Gilles Peskine8817f612018-12-18 00:18:46 +01005463 PSA_ASSERT( psa_crypto_init( ) );
itayzafrir5c753392018-05-08 11:18:38 +03005464
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01005465 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_VERIFY_HASH );
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02005466 psa_set_key_algorithm( &attributes, alg );
5467 psa_set_key_type( &attributes, key_type );
itayzafrir5c753392018-05-08 11:18:38 +03005468
Gilles Peskine049c7532019-05-15 20:22:09 +02005469 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02005470 &key ) );
itayzafrir5c753392018-05-08 11:18:38 +03005471
Ronald Cron5425a212020-08-04 14:58:35 +02005472 PSA_ASSERT( psa_verify_hash( key, alg,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01005473 hash_data->x, hash_data->len,
5474 signature_data->x, signature_data->len ) );
Gilles Peskine0627f982019-11-26 19:12:16 +01005475
itayzafrir5c753392018-05-08 11:18:38 +03005476exit:
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02005477 psa_reset_key_attributes( &attributes );
Ronald Cron5425a212020-08-04 14:58:35 +02005478 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02005479 PSA_DONE( );
itayzafrir5c753392018-05-08 11:18:38 +03005480}
5481/* END_CASE */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005482
5483/* BEGIN_CASE */
gabor-mezei-armb9530232021-04-16 14:21:21 +02005484void verify_hash_fail( int key_type_arg, data_t *key_data,
5485 int alg_arg, data_t *hash_data,
5486 data_t *signature_data,
5487 int expected_status_arg )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005488{
Ronald Cron5425a212020-08-04 14:58:35 +02005489 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005490 psa_key_type_t key_type = key_type_arg;
5491 psa_algorithm_t alg = alg_arg;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005492 psa_status_t actual_status;
5493 psa_status_t expected_status = expected_status_arg;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02005494 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005495
Gilles Peskine8817f612018-12-18 00:18:46 +01005496 PSA_ASSERT( psa_crypto_init( ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005497
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01005498 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_VERIFY_HASH );
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02005499 psa_set_key_algorithm( &attributes, alg );
5500 psa_set_key_type( &attributes, key_type );
Nir Sonnenscheind7082602018-06-04 16:45:27 +03005501
Gilles Peskine049c7532019-05-15 20:22:09 +02005502 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02005503 &key ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005504
Ronald Cron5425a212020-08-04 14:58:35 +02005505 actual_status = psa_verify_hash( key, alg,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01005506 hash_data->x, hash_data->len,
5507 signature_data->x, signature_data->len );
Gilles Peskinefe11b722018-12-18 00:24:04 +01005508 TEST_EQUAL( actual_status, expected_status );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005509
5510exit:
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02005511 psa_reset_key_attributes( &attributes );
Ronald Cron5425a212020-08-04 14:58:35 +02005512 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02005513 PSA_DONE( );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005514}
5515/* END_CASE */
5516
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005517/* BEGIN_CASE */
gabor-mezei-arm53028482021-04-15 18:19:50 +02005518void sign_message_deterministic( int key_type_arg,
5519 data_t *key_data,
5520 int alg_arg,
5521 data_t *input_data,
5522 data_t *output_data )
5523{
5524 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
5525 psa_key_type_t key_type = key_type_arg;
5526 psa_algorithm_t alg = alg_arg;
5527 size_t key_bits;
5528 unsigned char *signature = NULL;
5529 size_t signature_size;
5530 size_t signature_length = 0xdeadbeef;
5531 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
5532
5533 PSA_ASSERT( psa_crypto_init( ) );
5534
5535 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_MESSAGE );
5536 psa_set_key_algorithm( &attributes, alg );
5537 psa_set_key_type( &attributes, key_type );
5538
5539 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
5540 &key ) );
5541 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
5542 key_bits = psa_get_key_bits( &attributes );
5543
5544 signature_size = PSA_SIGN_OUTPUT_SIZE( key_type, key_bits, alg );
5545 TEST_ASSERT( signature_size != 0 );
5546 TEST_ASSERT( signature_size <= PSA_SIGNATURE_MAX_SIZE );
5547 ASSERT_ALLOC( signature, signature_size );
5548
5549 PSA_ASSERT( psa_sign_message( key, alg,
5550 input_data->x, input_data->len,
5551 signature, signature_size,
5552 &signature_length ) );
5553
5554 ASSERT_COMPARE( output_data->x, output_data->len,
5555 signature, signature_length );
5556
5557exit:
5558 psa_reset_key_attributes( &attributes );
5559
5560 psa_destroy_key( key );
5561 mbedtls_free( signature );
5562 PSA_DONE( );
5563
5564}
5565/* END_CASE */
5566
5567/* BEGIN_CASE */
5568void sign_message_fail( int key_type_arg,
5569 data_t *key_data,
5570 int alg_arg,
5571 data_t *input_data,
5572 int signature_size_arg,
5573 int expected_status_arg )
5574{
5575 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
5576 psa_key_type_t key_type = key_type_arg;
5577 psa_algorithm_t alg = alg_arg;
5578 size_t signature_size = signature_size_arg;
5579 psa_status_t actual_status;
5580 psa_status_t expected_status = expected_status_arg;
5581 unsigned char *signature = NULL;
5582 size_t signature_length = 0xdeadbeef;
5583 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
5584
5585 ASSERT_ALLOC( signature, signature_size );
5586
5587 PSA_ASSERT( psa_crypto_init( ) );
5588
5589 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_MESSAGE );
5590 psa_set_key_algorithm( &attributes, alg );
5591 psa_set_key_type( &attributes, key_type );
5592
5593 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
5594 &key ) );
5595
5596 actual_status = psa_sign_message( key, alg,
5597 input_data->x, input_data->len,
5598 signature, signature_size,
5599 &signature_length );
5600 TEST_EQUAL( actual_status, expected_status );
5601 /* The value of *signature_length is unspecified on error, but
5602 * whatever it is, it should be less than signature_size, so that
5603 * if the caller tries to read *signature_length bytes without
5604 * checking the error code then they don't overflow a buffer. */
5605 TEST_ASSERT( signature_length <= signature_size );
5606
5607exit:
5608 psa_reset_key_attributes( &attributes );
5609 psa_destroy_key( key );
5610 mbedtls_free( signature );
5611 PSA_DONE( );
5612}
5613/* END_CASE */
5614
5615/* BEGIN_CASE */
5616void sign_verify_message( int key_type_arg,
5617 data_t *key_data,
5618 int alg_arg,
5619 data_t *input_data )
5620{
5621 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
5622 psa_key_type_t key_type = key_type_arg;
5623 psa_algorithm_t alg = alg_arg;
5624 size_t key_bits;
5625 unsigned char *signature = NULL;
5626 size_t signature_size;
5627 size_t signature_length = 0xdeadbeef;
5628 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
5629
5630 PSA_ASSERT( psa_crypto_init( ) );
5631
5632 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_MESSAGE |
5633 PSA_KEY_USAGE_VERIFY_MESSAGE );
5634 psa_set_key_algorithm( &attributes, alg );
5635 psa_set_key_type( &attributes, key_type );
5636
5637 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
5638 &key ) );
5639 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
5640 key_bits = psa_get_key_bits( &attributes );
5641
5642 signature_size = PSA_SIGN_OUTPUT_SIZE( key_type, key_bits, alg );
5643 TEST_ASSERT( signature_size != 0 );
5644 TEST_ASSERT( signature_size <= PSA_SIGNATURE_MAX_SIZE );
5645 ASSERT_ALLOC( signature, signature_size );
5646
5647 PSA_ASSERT( psa_sign_message( key, alg,
5648 input_data->x, input_data->len,
5649 signature, signature_size,
5650 &signature_length ) );
5651 TEST_ASSERT( signature_length <= signature_size );
5652 TEST_ASSERT( signature_length > 0 );
5653
5654 PSA_ASSERT( psa_verify_message( key, alg,
5655 input_data->x, input_data->len,
5656 signature, signature_length ) );
5657
5658 if( input_data->len != 0 )
5659 {
5660 /* Flip a bit in the input and verify that the signature is now
5661 * detected as invalid. Flip a bit at the beginning, not at the end,
5662 * because ECDSA may ignore the last few bits of the input. */
5663 input_data->x[0] ^= 1;
5664 TEST_EQUAL( psa_verify_message( key, alg,
5665 input_data->x, input_data->len,
5666 signature, signature_length ),
5667 PSA_ERROR_INVALID_SIGNATURE );
5668 }
5669
5670exit:
5671 psa_reset_key_attributes( &attributes );
5672
5673 psa_destroy_key( key );
5674 mbedtls_free( signature );
5675 PSA_DONE( );
5676}
5677/* END_CASE */
5678
5679/* BEGIN_CASE */
5680void verify_message( int key_type_arg,
5681 data_t *key_data,
5682 int alg_arg,
5683 data_t *input_data,
5684 data_t *signature_data )
5685{
5686 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
5687 psa_key_type_t key_type = key_type_arg;
5688 psa_algorithm_t alg = alg_arg;
5689 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
5690
5691 TEST_ASSERT( signature_data->len <= PSA_SIGNATURE_MAX_SIZE );
5692
5693 PSA_ASSERT( psa_crypto_init( ) );
5694
5695 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_VERIFY_MESSAGE );
5696 psa_set_key_algorithm( &attributes, alg );
5697 psa_set_key_type( &attributes, key_type );
5698
5699 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
5700 &key ) );
5701
5702 PSA_ASSERT( psa_verify_message( key, alg,
5703 input_data->x, input_data->len,
5704 signature_data->x, signature_data->len ) );
5705
5706exit:
5707 psa_reset_key_attributes( &attributes );
5708 psa_destroy_key( key );
5709 PSA_DONE( );
5710}
5711/* END_CASE */
5712
5713/* BEGIN_CASE */
5714void verify_message_fail( int key_type_arg,
5715 data_t *key_data,
5716 int alg_arg,
5717 data_t *hash_data,
5718 data_t *signature_data,
5719 int expected_status_arg )
5720{
5721 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
5722 psa_key_type_t key_type = key_type_arg;
5723 psa_algorithm_t alg = alg_arg;
5724 psa_status_t actual_status;
5725 psa_status_t expected_status = expected_status_arg;
5726 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
5727
5728 PSA_ASSERT( psa_crypto_init( ) );
5729
5730 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_VERIFY_MESSAGE );
5731 psa_set_key_algorithm( &attributes, alg );
5732 psa_set_key_type( &attributes, key_type );
5733
5734 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
5735 &key ) );
5736
5737 actual_status = psa_verify_message( key, alg,
5738 hash_data->x, hash_data->len,
5739 signature_data->x,
5740 signature_data->len );
5741 TEST_EQUAL( actual_status, expected_status );
5742
5743exit:
5744 psa_reset_key_attributes( &attributes );
5745 psa_destroy_key( key );
5746 PSA_DONE( );
5747}
5748/* END_CASE */
5749
5750/* BEGIN_CASE */
Gilles Peskine656896e2018-06-29 19:12:28 +02005751void asymmetric_encrypt( int key_type_arg,
5752 data_t *key_data,
5753 int alg_arg,
5754 data_t *input_data,
Gilles Peskine68428122018-06-30 18:42:41 +02005755 data_t *label,
Gilles Peskine656896e2018-06-29 19:12:28 +02005756 int expected_output_length_arg,
5757 int expected_status_arg )
5758{
Ronald Cron5425a212020-08-04 14:58:35 +02005759 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine656896e2018-06-29 19:12:28 +02005760 psa_key_type_t key_type = key_type_arg;
5761 psa_algorithm_t alg = alg_arg;
5762 size_t expected_output_length = expected_output_length_arg;
5763 size_t key_bits;
5764 unsigned char *output = NULL;
5765 size_t output_size;
5766 size_t output_length = ~0;
5767 psa_status_t actual_status;
5768 psa_status_t expected_status = expected_status_arg;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02005769 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine656896e2018-06-29 19:12:28 +02005770
Gilles Peskine8817f612018-12-18 00:18:46 +01005771 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskinebdf309c2018-12-03 15:36:32 +01005772
Gilles Peskine656896e2018-06-29 19:12:28 +02005773 /* Import the key */
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02005774 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
5775 psa_set_key_algorithm( &attributes, alg );
5776 psa_set_key_type( &attributes, key_type );
Gilles Peskine049c7532019-05-15 20:22:09 +02005777 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02005778 &key ) );
Gilles Peskine656896e2018-06-29 19:12:28 +02005779
5780 /* Determine the maximum output length */
Ronald Cron5425a212020-08-04 14:58:35 +02005781 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02005782 key_bits = psa_get_key_bits( &attributes );
gabor-mezei-armceface22021-01-21 12:26:17 +01005783
Gilles Peskine656896e2018-06-29 19:12:28 +02005784 output_size = PSA_ASYMMETRIC_ENCRYPT_OUTPUT_SIZE( key_type, key_bits, alg );
gabor-mezei-armceface22021-01-21 12:26:17 +01005785 TEST_ASSERT( output_size <= PSA_ASYMMETRIC_ENCRYPT_OUTPUT_MAX_SIZE );
Gilles Peskine8cebbba2018-09-27 13:54:18 +02005786 ASSERT_ALLOC( output, output_size );
Gilles Peskine656896e2018-06-29 19:12:28 +02005787
5788 /* Encrypt the input */
Ronald Cron5425a212020-08-04 14:58:35 +02005789 actual_status = psa_asymmetric_encrypt( key, alg,
Gilles Peskine656896e2018-06-29 19:12:28 +02005790 input_data->x, input_data->len,
Gilles Peskine68428122018-06-30 18:42:41 +02005791 label->x, label->len,
Gilles Peskine656896e2018-06-29 19:12:28 +02005792 output, output_size,
5793 &output_length );
Gilles Peskinefe11b722018-12-18 00:24:04 +01005794 TEST_EQUAL( actual_status, expected_status );
5795 TEST_EQUAL( output_length, expected_output_length );
Gilles Peskine656896e2018-06-29 19:12:28 +02005796
Gilles Peskine68428122018-06-30 18:42:41 +02005797 /* If the label is empty, the test framework puts a non-null pointer
5798 * in label->x. Test that a null pointer works as well. */
5799 if( label->len == 0 )
5800 {
5801 output_length = ~0;
Gilles Peskinef7ab5ad2018-09-26 18:19:24 +02005802 if( output_size != 0 )
5803 memset( output, 0, output_size );
Ronald Cron5425a212020-08-04 14:58:35 +02005804 actual_status = psa_asymmetric_encrypt( key, alg,
Gilles Peskine68428122018-06-30 18:42:41 +02005805 input_data->x, input_data->len,
5806 NULL, label->len,
5807 output, output_size,
5808 &output_length );
Gilles Peskinefe11b722018-12-18 00:24:04 +01005809 TEST_EQUAL( actual_status, expected_status );
5810 TEST_EQUAL( output_length, expected_output_length );
Gilles Peskine68428122018-06-30 18:42:41 +02005811 }
5812
Gilles Peskine656896e2018-06-29 19:12:28 +02005813exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +01005814 /*
5815 * Key attributes may have been returned by psa_get_key_attributes()
5816 * thus reset them as required.
5817 */
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02005818 psa_reset_key_attributes( &attributes );
Ronald Cron3a4f0e32020-11-19 17:55:23 +01005819
Ronald Cron5425a212020-08-04 14:58:35 +02005820 psa_destroy_key( key );
Gilles Peskine656896e2018-06-29 19:12:28 +02005821 mbedtls_free( output );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02005822 PSA_DONE( );
Gilles Peskine656896e2018-06-29 19:12:28 +02005823}
5824/* END_CASE */
5825
5826/* BEGIN_CASE */
Gilles Peskine68428122018-06-30 18:42:41 +02005827void asymmetric_encrypt_decrypt( int key_type_arg,
5828 data_t *key_data,
5829 int alg_arg,
5830 data_t *input_data,
5831 data_t *label )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005832{
Ronald Cron5425a212020-08-04 14:58:35 +02005833 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005834 psa_key_type_t key_type = key_type_arg;
5835 psa_algorithm_t alg = alg_arg;
Gilles Peskine55c94dd2018-06-30 18:54:48 +02005836 size_t key_bits;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005837 unsigned char *output = NULL;
Gilles Peskine55c94dd2018-06-30 18:54:48 +02005838 size_t output_size;
5839 size_t output_length = ~0;
Nir Sonnenschein0f3bdbd2018-05-02 23:56:12 +03005840 unsigned char *output2 = NULL;
Gilles Peskine55c94dd2018-06-30 18:54:48 +02005841 size_t output2_size;
5842 size_t output2_length = ~0;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02005843 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005844
Gilles Peskine8817f612018-12-18 00:18:46 +01005845 PSA_ASSERT( psa_crypto_init( ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005846
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02005847 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT | PSA_KEY_USAGE_DECRYPT );
5848 psa_set_key_algorithm( &attributes, alg );
5849 psa_set_key_type( &attributes, key_type );
Nir Sonnenscheind7082602018-06-04 16:45:27 +03005850
Gilles Peskine049c7532019-05-15 20:22:09 +02005851 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02005852 &key ) );
Gilles Peskine55c94dd2018-06-30 18:54:48 +02005853
5854 /* Determine the maximum ciphertext length */
Ronald Cron5425a212020-08-04 14:58:35 +02005855 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02005856 key_bits = psa_get_key_bits( &attributes );
gabor-mezei-armceface22021-01-21 12:26:17 +01005857
Gilles Peskine55c94dd2018-06-30 18:54:48 +02005858 output_size = PSA_ASYMMETRIC_ENCRYPT_OUTPUT_SIZE( key_type, key_bits, alg );
gabor-mezei-armceface22021-01-21 12:26:17 +01005859 TEST_ASSERT( output_size <= PSA_ASYMMETRIC_ENCRYPT_OUTPUT_MAX_SIZE );
Gilles Peskine8cebbba2018-09-27 13:54:18 +02005860 ASSERT_ALLOC( output, output_size );
gabor-mezei-armceface22021-01-21 12:26:17 +01005861
Gilles Peskine55c94dd2018-06-30 18:54:48 +02005862 output2_size = input_data->len;
gabor-mezei-armceface22021-01-21 12:26:17 +01005863 TEST_ASSERT( output2_size <=
5864 PSA_ASYMMETRIC_DECRYPT_OUTPUT_SIZE( key_type, key_bits, alg ) );
5865 TEST_ASSERT( output2_size <= PSA_ASYMMETRIC_DECRYPT_OUTPUT_MAX_SIZE );
Gilles Peskine8cebbba2018-09-27 13:54:18 +02005866 ASSERT_ALLOC( output2, output2_size );
Gilles Peskine55c94dd2018-06-30 18:54:48 +02005867
Gilles Peskineeebd7382018-06-08 18:11:54 +02005868 /* We test encryption by checking that encrypt-then-decrypt gives back
5869 * the original plaintext because of the non-optional random
5870 * part of encryption process which prevents using fixed vectors. */
Ronald Cron5425a212020-08-04 14:58:35 +02005871 PSA_ASSERT( psa_asymmetric_encrypt( key, alg,
Gilles Peskine8817f612018-12-18 00:18:46 +01005872 input_data->x, input_data->len,
5873 label->x, label->len,
5874 output, output_size,
5875 &output_length ) );
Gilles Peskine55c94dd2018-06-30 18:54:48 +02005876 /* We don't know what ciphertext length to expect, but check that
5877 * it looks sensible. */
5878 TEST_ASSERT( output_length <= output_size );
Nir Sonnenschein0f3bdbd2018-05-02 23:56:12 +03005879
Ronald Cron5425a212020-08-04 14:58:35 +02005880 PSA_ASSERT( psa_asymmetric_decrypt( key, alg,
Gilles Peskine8817f612018-12-18 00:18:46 +01005881 output, output_length,
5882 label->x, label->len,
5883 output2, output2_size,
5884 &output2_length ) );
Gilles Peskinebd7dea92018-09-27 13:57:19 +02005885 ASSERT_COMPARE( input_data->x, input_data->len,
5886 output2, output2_length );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005887
5888exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +01005889 /*
5890 * Key attributes may have been returned by psa_get_key_attributes()
5891 * thus reset them as required.
5892 */
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02005893 psa_reset_key_attributes( &attributes );
Ronald Cron3a4f0e32020-11-19 17:55:23 +01005894
Ronald Cron5425a212020-08-04 14:58:35 +02005895 psa_destroy_key( key );
itayzafrir3e02b3b2018-06-12 17:06:52 +03005896 mbedtls_free( output );
5897 mbedtls_free( output2 );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02005898 PSA_DONE( );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005899}
5900/* END_CASE */
5901
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005902/* BEGIN_CASE */
Gilles Peskine68428122018-06-30 18:42:41 +02005903void asymmetric_decrypt( int key_type_arg,
5904 data_t *key_data,
5905 int alg_arg,
5906 data_t *input_data,
5907 data_t *label,
Gilles Peskine66763a02018-06-29 21:54:10 +02005908 data_t *expected_data )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005909{
Ronald Cron5425a212020-08-04 14:58:35 +02005910 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005911 psa_key_type_t key_type = key_type_arg;
5912 psa_algorithm_t alg = alg_arg;
gabor-mezei-armceface22021-01-21 12:26:17 +01005913 size_t key_bits;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005914 unsigned char *output = NULL;
Nir Sonnenscheind70bc482018-06-04 16:31:13 +03005915 size_t output_size = 0;
Gilles Peskine55c94dd2018-06-30 18:54:48 +02005916 size_t output_length = ~0;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02005917 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005918
Gilles Peskine8817f612018-12-18 00:18:46 +01005919 PSA_ASSERT( psa_crypto_init( ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005920
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02005921 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DECRYPT );
5922 psa_set_key_algorithm( &attributes, alg );
5923 psa_set_key_type( &attributes, key_type );
Nir Sonnenscheind7082602018-06-04 16:45:27 +03005924
Gilles Peskine049c7532019-05-15 20:22:09 +02005925 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02005926 &key ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005927
gabor-mezei-armceface22021-01-21 12:26:17 +01005928 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
5929 key_bits = psa_get_key_bits( &attributes );
5930
5931 /* Determine the maximum ciphertext length */
5932 output_size = PSA_ASYMMETRIC_DECRYPT_OUTPUT_SIZE( key_type, key_bits, alg );
5933 TEST_ASSERT( output_size <= PSA_ASYMMETRIC_DECRYPT_OUTPUT_MAX_SIZE );
5934 ASSERT_ALLOC( output, output_size );
5935
Ronald Cron5425a212020-08-04 14:58:35 +02005936 PSA_ASSERT( psa_asymmetric_decrypt( key, alg,
Gilles Peskine8817f612018-12-18 00:18:46 +01005937 input_data->x, input_data->len,
5938 label->x, label->len,
5939 output,
5940 output_size,
5941 &output_length ) );
Gilles Peskinebd7dea92018-09-27 13:57:19 +02005942 ASSERT_COMPARE( expected_data->x, expected_data->len,
5943 output, output_length );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005944
Gilles Peskine68428122018-06-30 18:42:41 +02005945 /* If the label is empty, the test framework puts a non-null pointer
5946 * in label->x. Test that a null pointer works as well. */
5947 if( label->len == 0 )
5948 {
5949 output_length = ~0;
Gilles Peskinef7ab5ad2018-09-26 18:19:24 +02005950 if( output_size != 0 )
5951 memset( output, 0, output_size );
Ronald Cron5425a212020-08-04 14:58:35 +02005952 PSA_ASSERT( psa_asymmetric_decrypt( key, alg,
Gilles Peskine8817f612018-12-18 00:18:46 +01005953 input_data->x, input_data->len,
5954 NULL, label->len,
5955 output,
5956 output_size,
5957 &output_length ) );
Gilles Peskinebd7dea92018-09-27 13:57:19 +02005958 ASSERT_COMPARE( expected_data->x, expected_data->len,
5959 output, output_length );
Gilles Peskine68428122018-06-30 18:42:41 +02005960 }
5961
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005962exit:
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02005963 psa_reset_key_attributes( &attributes );
Ronald Cron5425a212020-08-04 14:58:35 +02005964 psa_destroy_key( key );
itayzafrir3e02b3b2018-06-12 17:06:52 +03005965 mbedtls_free( output );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02005966 PSA_DONE( );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005967}
5968/* END_CASE */
5969
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005970/* BEGIN_CASE */
Gilles Peskine68428122018-06-30 18:42:41 +02005971void asymmetric_decrypt_fail( int key_type_arg,
5972 data_t *key_data,
5973 int alg_arg,
5974 data_t *input_data,
5975 data_t *label,
Jaeden Amerof8daab72019-02-06 12:57:46 +00005976 int output_size_arg,
Gilles Peskine2d277862018-06-18 15:41:12 +02005977 int expected_status_arg )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005978{
Ronald Cron5425a212020-08-04 14:58:35 +02005979 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005980 psa_key_type_t key_type = key_type_arg;
5981 psa_algorithm_t alg = alg_arg;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005982 unsigned char *output = NULL;
Jaeden Amerof8daab72019-02-06 12:57:46 +00005983 size_t output_size = output_size_arg;
Gilles Peskine55c94dd2018-06-30 18:54:48 +02005984 size_t output_length = ~0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005985 psa_status_t actual_status;
5986 psa_status_t expected_status = expected_status_arg;
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02005987 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005988
Gilles Peskine8cebbba2018-09-27 13:54:18 +02005989 ASSERT_ALLOC( output, output_size );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02005990
Gilles Peskine8817f612018-12-18 00:18:46 +01005991 PSA_ASSERT( psa_crypto_init( ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005992
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02005993 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DECRYPT );
5994 psa_set_key_algorithm( &attributes, alg );
5995 psa_set_key_type( &attributes, key_type );
Nir Sonnenscheind7082602018-06-04 16:45:27 +03005996
Gilles Peskine049c7532019-05-15 20:22:09 +02005997 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02005998 &key ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03005999
Ronald Cron5425a212020-08-04 14:58:35 +02006000 actual_status = psa_asymmetric_decrypt( key, alg,
Gilles Peskine4abf7412018-06-18 16:35:34 +02006001 input_data->x, input_data->len,
Gilles Peskine68428122018-06-30 18:42:41 +02006002 label->x, label->len,
Gilles Peskine4abf7412018-06-18 16:35:34 +02006003 output, output_size,
Gilles Peskine2d277862018-06-18 15:41:12 +02006004 &output_length );
Gilles Peskinefe11b722018-12-18 00:24:04 +01006005 TEST_EQUAL( actual_status, expected_status );
Gilles Peskine55c94dd2018-06-30 18:54:48 +02006006 TEST_ASSERT( output_length <= output_size );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03006007
Gilles Peskine68428122018-06-30 18:42:41 +02006008 /* If the label is empty, the test framework puts a non-null pointer
6009 * in label->x. Test that a null pointer works as well. */
6010 if( label->len == 0 )
6011 {
6012 output_length = ~0;
Gilles Peskinef7ab5ad2018-09-26 18:19:24 +02006013 if( output_size != 0 )
6014 memset( output, 0, output_size );
Ronald Cron5425a212020-08-04 14:58:35 +02006015 actual_status = psa_asymmetric_decrypt( key, alg,
Gilles Peskine68428122018-06-30 18:42:41 +02006016 input_data->x, input_data->len,
6017 NULL, label->len,
6018 output, output_size,
6019 &output_length );
Gilles Peskinefe11b722018-12-18 00:24:04 +01006020 TEST_EQUAL( actual_status, expected_status );
Gilles Peskine55c94dd2018-06-30 18:54:48 +02006021 TEST_ASSERT( output_length <= output_size );
Gilles Peskine68428122018-06-30 18:42:41 +02006022 }
6023
Nir Sonnenschein39e59142018-05-02 23:16:26 +03006024exit:
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02006025 psa_reset_key_attributes( &attributes );
Ronald Cron5425a212020-08-04 14:58:35 +02006026 psa_destroy_key( key );
Gilles Peskine2d277862018-06-18 15:41:12 +02006027 mbedtls_free( output );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02006028 PSA_DONE( );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03006029}
Gilles Peskine5b051bc2018-05-31 13:25:48 +02006030/* END_CASE */
Gilles Peskine05d69892018-06-19 22:00:52 +02006031
6032/* BEGIN_CASE */
Gilles Peskinecbe66502019-05-16 16:59:18 +02006033void key_derivation_init( )
Jaeden Amerod94d6712019-01-04 14:11:48 +00006034{
6035 /* Test each valid way of initializing the object, except for `= {0}`, as
6036 * Clang 5 complains when `-Wmissing-field-initializers` is used, even
6037 * though it's OK by the C standard. We could test for this, but we'd need
6038 * to supress the Clang warning for the test. */
Jaeden Amero5229bbb2019-02-07 16:33:37 +00006039 size_t capacity;
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02006040 psa_key_derivation_operation_t func = psa_key_derivation_operation_init( );
6041 psa_key_derivation_operation_t init = PSA_KEY_DERIVATION_OPERATION_INIT;
6042 psa_key_derivation_operation_t zero;
Jaeden Amerod94d6712019-01-04 14:11:48 +00006043
6044 memset( &zero, 0, sizeof( zero ) );
6045
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006046 /* A default operation should not be able to report its capacity. */
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02006047 TEST_EQUAL( psa_key_derivation_get_capacity( &func, &capacity ),
Jaeden Amerocf2010c2019-02-15 13:05:49 +00006048 PSA_ERROR_BAD_STATE );
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02006049 TEST_EQUAL( psa_key_derivation_get_capacity( &init, &capacity ),
Jaeden Amerocf2010c2019-02-15 13:05:49 +00006050 PSA_ERROR_BAD_STATE );
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02006051 TEST_EQUAL( psa_key_derivation_get_capacity( &zero, &capacity ),
Jaeden Amerocf2010c2019-02-15 13:05:49 +00006052 PSA_ERROR_BAD_STATE );
Jaeden Amero5229bbb2019-02-07 16:33:37 +00006053
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006054 /* A default operation should be abortable without error. */
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02006055 PSA_ASSERT( psa_key_derivation_abort(&func) );
6056 PSA_ASSERT( psa_key_derivation_abort(&init) );
6057 PSA_ASSERT( psa_key_derivation_abort(&zero) );
Jaeden Amerod94d6712019-01-04 14:11:48 +00006058}
6059/* END_CASE */
6060
Janos Follath16de4a42019-06-13 16:32:24 +01006061/* BEGIN_CASE */
6062void derive_setup( int alg_arg, int expected_status_arg )
Gilles Peskineea0fb492018-07-12 17:17:20 +02006063{
Gilles Peskineea0fb492018-07-12 17:17:20 +02006064 psa_algorithm_t alg = alg_arg;
Gilles Peskineea0fb492018-07-12 17:17:20 +02006065 psa_status_t expected_status = expected_status_arg;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006066 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Gilles Peskineea0fb492018-07-12 17:17:20 +02006067
Gilles Peskine8817f612018-12-18 00:18:46 +01006068 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskineea0fb492018-07-12 17:17:20 +02006069
Janos Follath16de4a42019-06-13 16:32:24 +01006070 TEST_EQUAL( psa_key_derivation_setup( &operation, alg ),
Gilles Peskinef812dcf2018-12-18 00:33:25 +01006071 expected_status );
Gilles Peskineea0fb492018-07-12 17:17:20 +02006072
6073exit:
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006074 psa_key_derivation_abort( &operation );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02006075 PSA_DONE( );
Gilles Peskineea0fb492018-07-12 17:17:20 +02006076}
6077/* END_CASE */
6078
Janos Follathaf3c2a02019-06-12 12:34:34 +01006079/* BEGIN_CASE */
Janos Follatha27c9272019-06-14 09:59:36 +01006080void derive_set_capacity( int alg_arg, int capacity_arg,
6081 int expected_status_arg )
6082{
6083 psa_algorithm_t alg = alg_arg;
6084 size_t capacity = capacity_arg;
6085 psa_status_t expected_status = expected_status_arg;
6086 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
6087
6088 PSA_ASSERT( psa_crypto_init( ) );
6089
6090 PSA_ASSERT( psa_key_derivation_setup( &operation, alg ) );
6091
6092 TEST_EQUAL( psa_key_derivation_set_capacity( &operation, capacity ),
6093 expected_status );
6094
6095exit:
6096 psa_key_derivation_abort( &operation );
6097 PSA_DONE( );
6098}
6099/* END_CASE */
6100
6101/* BEGIN_CASE */
Janos Follathaf3c2a02019-06-12 12:34:34 +01006102void derive_input( int alg_arg,
Gilles Peskine6842ba42019-09-23 13:49:33 +02006103 int step_arg1, int key_type_arg1, data_t *input1,
Janos Follathaf3c2a02019-06-12 12:34:34 +01006104 int expected_status_arg1,
Gilles Peskine2058c072019-09-24 17:19:33 +02006105 int step_arg2, int key_type_arg2, data_t *input2,
Janos Follathaf3c2a02019-06-12 12:34:34 +01006106 int expected_status_arg2,
Gilles Peskine2058c072019-09-24 17:19:33 +02006107 int step_arg3, int key_type_arg3, data_t *input3,
Gilles Peskine1a2904c2019-09-24 17:45:07 +02006108 int expected_status_arg3,
6109 int output_key_type_arg, int expected_output_status_arg )
Janos Follathaf3c2a02019-06-12 12:34:34 +01006110{
6111 psa_algorithm_t alg = alg_arg;
Gilles Peskine6842ba42019-09-23 13:49:33 +02006112 psa_key_derivation_step_t steps[] = {step_arg1, step_arg2, step_arg3};
6113 psa_key_type_t key_types[] = {key_type_arg1, key_type_arg2, key_type_arg3};
Janos Follathaf3c2a02019-06-12 12:34:34 +01006114 psa_status_t expected_statuses[] = {expected_status_arg1,
6115 expected_status_arg2,
6116 expected_status_arg3};
6117 data_t *inputs[] = {input1, input2, input3};
Ronald Cron5425a212020-08-04 14:58:35 +02006118 mbedtls_svc_key_id_t keys[] = { MBEDTLS_SVC_KEY_ID_INIT,
6119 MBEDTLS_SVC_KEY_ID_INIT,
6120 MBEDTLS_SVC_KEY_ID_INIT };
Janos Follathaf3c2a02019-06-12 12:34:34 +01006121 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
6122 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
6123 size_t i;
Gilles Peskine1a2904c2019-09-24 17:45:07 +02006124 psa_key_type_t output_key_type = output_key_type_arg;
Ronald Cron5425a212020-08-04 14:58:35 +02006125 mbedtls_svc_key_id_t output_key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine1a2904c2019-09-24 17:45:07 +02006126 psa_status_t expected_output_status = expected_output_status_arg;
6127 psa_status_t actual_output_status;
Janos Follathaf3c2a02019-06-12 12:34:34 +01006128
6129 PSA_ASSERT( psa_crypto_init( ) );
6130
6131 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DERIVE );
6132 psa_set_key_algorithm( &attributes, alg );
Janos Follathaf3c2a02019-06-12 12:34:34 +01006133
6134 PSA_ASSERT( psa_key_derivation_setup( &operation, alg ) );
6135
6136 for( i = 0; i < ARRAY_LENGTH( steps ); i++ )
6137 {
Gilles Peskine4023c012021-05-27 13:21:20 +02006138 mbedtls_test_set_step( i );
6139 if( steps[i] == 0 )
6140 {
6141 /* Skip this step */
6142 }
6143 else if( key_types[i] != PSA_KEY_TYPE_NONE )
Janos Follathaf3c2a02019-06-12 12:34:34 +01006144 {
Gilles Peskine6842ba42019-09-23 13:49:33 +02006145 psa_set_key_type( &attributes, key_types[i] );
6146 PSA_ASSERT( psa_import_key( &attributes,
6147 inputs[i]->x, inputs[i]->len,
Ronald Cron5425a212020-08-04 14:58:35 +02006148 &keys[i] ) );
Steven Cooreman0ee0d522020-10-05 16:03:42 +02006149 if( PSA_KEY_TYPE_IS_KEY_PAIR( key_types[i] ) &&
6150 steps[i] == PSA_KEY_DERIVATION_INPUT_SECRET )
6151 {
6152 // When taking a private key as secret input, use key agreement
6153 // to add the shared secret to the derivation
Gilles Peskinec18e25f2021-02-12 23:48:20 +01006154 TEST_EQUAL( mbedtls_test_psa_key_agreement_with_self(
6155 &operation, keys[i] ),
Steven Cooreman0ee0d522020-10-05 16:03:42 +02006156 expected_statuses[i] );
6157 }
6158 else
6159 {
6160 TEST_EQUAL( psa_key_derivation_input_key( &operation, steps[i],
Ronald Cron5425a212020-08-04 14:58:35 +02006161 keys[i] ),
Steven Cooreman0ee0d522020-10-05 16:03:42 +02006162 expected_statuses[i] );
6163 }
Gilles Peskine6842ba42019-09-23 13:49:33 +02006164 }
6165 else
6166 {
6167 TEST_EQUAL( psa_key_derivation_input_bytes(
6168 &operation, steps[i],
6169 inputs[i]->x, inputs[i]->len ),
6170 expected_statuses[i] );
Janos Follathaf3c2a02019-06-12 12:34:34 +01006171 }
6172 }
6173
Gilles Peskine1a2904c2019-09-24 17:45:07 +02006174 if( output_key_type != PSA_KEY_TYPE_NONE )
6175 {
6176 psa_reset_key_attributes( &attributes );
Dave Rodgman491d8492021-11-16 12:12:49 +00006177 psa_set_key_type( &attributes, output_key_type );
Gilles Peskine1a2904c2019-09-24 17:45:07 +02006178 psa_set_key_bits( &attributes, 8 );
6179 actual_output_status =
6180 psa_key_derivation_output_key( &attributes, &operation,
Ronald Cron5425a212020-08-04 14:58:35 +02006181 &output_key );
Gilles Peskine1a2904c2019-09-24 17:45:07 +02006182 }
6183 else
6184 {
6185 uint8_t buffer[1];
6186 actual_output_status =
6187 psa_key_derivation_output_bytes( &operation,
6188 buffer, sizeof( buffer ) );
6189 }
6190 TEST_EQUAL( actual_output_status, expected_output_status );
6191
Janos Follathaf3c2a02019-06-12 12:34:34 +01006192exit:
6193 psa_key_derivation_abort( &operation );
Ronald Cron5425a212020-08-04 14:58:35 +02006194 for( i = 0; i < ARRAY_LENGTH( keys ); i++ )
6195 psa_destroy_key( keys[i] );
6196 psa_destroy_key( output_key );
Janos Follathaf3c2a02019-06-12 12:34:34 +01006197 PSA_DONE( );
6198}
6199/* END_CASE */
6200
Janos Follathd958bb72019-07-03 15:02:16 +01006201/* BEGIN_CASE */
Gilles Peskine1c77edd2021-05-27 11:55:02 +02006202void derive_over_capacity( int alg_arg )
Nir Sonnenscheine5204c92018-10-22 17:24:55 +03006203{
Janos Follathd958bb72019-07-03 15:02:16 +01006204 psa_algorithm_t alg = alg_arg;
Ronald Cron5425a212020-08-04 14:58:35 +02006205 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Nir Sonnenschein4eda37b2018-10-31 12:15:58 +02006206 size_t key_type = PSA_KEY_TYPE_DERIVE;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006207 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Janos Follathd958bb72019-07-03 15:02:16 +01006208 unsigned char input1[] = "Input 1";
6209 size_t input1_length = sizeof( input1 );
6210 unsigned char input2[] = "Input 2";
6211 size_t input2_length = sizeof( input2 );
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03006212 uint8_t buffer[42];
Nir Sonnenschein1caf6d22018-11-01 12:27:20 +02006213 size_t capacity = sizeof( buffer );
Nir Sonnenscheindd69d8b2018-11-01 12:24:23 +02006214 const uint8_t key_data[22] = { 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b,
6215 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b,
6216 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b};
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02006217 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Nir Sonnenscheine5204c92018-10-22 17:24:55 +03006218
Gilles Peskine8817f612018-12-18 00:18:46 +01006219 PSA_ASSERT( psa_crypto_init( ) );
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03006220
Gilles Peskine2c2cf0e2019-04-19 19:58:20 +02006221 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DERIVE );
6222 psa_set_key_algorithm( &attributes, alg );
6223 psa_set_key_type( &attributes, key_type );
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03006224
Gilles Peskine73676cb2019-05-15 20:15:10 +02006225 PSA_ASSERT( psa_import_key( &attributes,
6226 key_data, sizeof( key_data ),
Ronald Cron5425a212020-08-04 14:58:35 +02006227 &key ) );
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03006228
6229 /* valid key derivation */
Gilles Peskinec18e25f2021-02-12 23:48:20 +01006230 if( !mbedtls_test_psa_setup_key_derivation_wrap( &operation, key, alg,
6231 input1, input1_length,
6232 input2, input2_length,
6233 capacity ) )
Janos Follathd958bb72019-07-03 15:02:16 +01006234 goto exit;
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03006235
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006236 /* state of operation shouldn't allow additional generation */
Janos Follathd958bb72019-07-03 15:02:16 +01006237 TEST_EQUAL( psa_key_derivation_setup( &operation, alg ),
Gilles Peskinef812dcf2018-12-18 00:33:25 +01006238 PSA_ERROR_BAD_STATE );
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03006239
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006240 PSA_ASSERT( psa_key_derivation_output_bytes( &operation, buffer, capacity ) );
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03006241
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006242 TEST_EQUAL( psa_key_derivation_output_bytes( &operation, buffer, capacity ),
David Saadab4ecc272019-02-14 13:48:10 +02006243 PSA_ERROR_INSUFFICIENT_DATA );
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03006244
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03006245exit:
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006246 psa_key_derivation_abort( &operation );
Ronald Cron5425a212020-08-04 14:58:35 +02006247 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02006248 PSA_DONE( );
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03006249}
6250/* END_CASE */
6251
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03006252/* BEGIN_CASE */
Gilles Peskine1c77edd2021-05-27 11:55:02 +02006253void derive_actions_without_setup( )
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03006254{
6255 uint8_t output_buffer[16];
6256 size_t buffer_size = 16;
6257 size_t capacity = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006258 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03006259
Gilles Peskinecf7292e2019-05-16 17:53:40 +02006260 TEST_ASSERT( psa_key_derivation_output_bytes( &operation,
6261 output_buffer, buffer_size )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00006262 == PSA_ERROR_BAD_STATE );
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03006263
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006264 TEST_ASSERT( psa_key_derivation_get_capacity( &operation, &capacity )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00006265 == PSA_ERROR_BAD_STATE );
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03006266
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006267 PSA_ASSERT( psa_key_derivation_abort( &operation ) );
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03006268
Gilles Peskinecf7292e2019-05-16 17:53:40 +02006269 TEST_ASSERT( psa_key_derivation_output_bytes( &operation,
6270 output_buffer, buffer_size )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00006271 == PSA_ERROR_BAD_STATE );
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03006272
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006273 TEST_ASSERT( psa_key_derivation_get_capacity( &operation, &capacity )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00006274 == PSA_ERROR_BAD_STATE );
Nir Sonnenscheinb46e7ca2018-10-25 14:46:09 +03006275
6276exit:
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006277 psa_key_derivation_abort( &operation );
Nir Sonnenscheine5204c92018-10-22 17:24:55 +03006278}
6279/* END_CASE */
6280
6281/* BEGIN_CASE */
Gilles Peskine96ee5c72018-07-12 17:24:54 +02006282void derive_output( int alg_arg,
Gilles Peskine1468da72019-05-29 17:35:49 +02006283 int step1_arg, data_t *input1,
6284 int step2_arg, data_t *input2,
6285 int step3_arg, data_t *input3,
Gilles Peskine96ee5c72018-07-12 17:24:54 +02006286 int requested_capacity_arg,
6287 data_t *expected_output1,
6288 data_t *expected_output2 )
6289{
Gilles Peskine96ee5c72018-07-12 17:24:54 +02006290 psa_algorithm_t alg = alg_arg;
Gilles Peskine1468da72019-05-29 17:35:49 +02006291 psa_key_derivation_step_t steps[] = {step1_arg, step2_arg, step3_arg};
6292 data_t *inputs[] = {input1, input2, input3};
Ronald Cron5425a212020-08-04 14:58:35 +02006293 mbedtls_svc_key_id_t keys[] = { MBEDTLS_SVC_KEY_ID_INIT,
6294 MBEDTLS_SVC_KEY_ID_INIT,
6295 MBEDTLS_SVC_KEY_ID_INIT };
Gilles Peskine96ee5c72018-07-12 17:24:54 +02006296 size_t requested_capacity = requested_capacity_arg;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006297 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Gilles Peskine96ee5c72018-07-12 17:24:54 +02006298 uint8_t *expected_outputs[2] =
6299 {expected_output1->x, expected_output2->x};
6300 size_t output_sizes[2] =
6301 {expected_output1->len, expected_output2->len};
6302 size_t output_buffer_size = 0;
6303 uint8_t *output_buffer = NULL;
6304 size_t expected_capacity;
6305 size_t current_capacity;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006306 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine96ee5c72018-07-12 17:24:54 +02006307 psa_status_t status;
Gilles Peskine1468da72019-05-29 17:35:49 +02006308 size_t i;
Gilles Peskine96ee5c72018-07-12 17:24:54 +02006309
6310 for( i = 0; i < ARRAY_LENGTH( expected_outputs ); i++ )
6311 {
6312 if( output_sizes[i] > output_buffer_size )
6313 output_buffer_size = output_sizes[i];
6314 if( output_sizes[i] == 0 )
6315 expected_outputs[i] = NULL;
6316 }
Gilles Peskine8cebbba2018-09-27 13:54:18 +02006317 ASSERT_ALLOC( output_buffer, output_buffer_size );
Gilles Peskine8817f612018-12-18 00:18:46 +01006318 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine96ee5c72018-07-12 17:24:54 +02006319
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006320 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DERIVE );
6321 psa_set_key_algorithm( &attributes, alg );
6322 psa_set_key_type( &attributes, PSA_KEY_TYPE_DERIVE );
Gilles Peskine96ee5c72018-07-12 17:24:54 +02006323
Gilles Peskine96ee5c72018-07-12 17:24:54 +02006324 /* Extraction phase. */
Gilles Peskine1468da72019-05-29 17:35:49 +02006325 PSA_ASSERT( psa_key_derivation_setup( &operation, alg ) );
6326 PSA_ASSERT( psa_key_derivation_set_capacity( &operation,
6327 requested_capacity ) );
6328 for( i = 0; i < ARRAY_LENGTH( steps ); i++ )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006329 {
Gilles Peskine1468da72019-05-29 17:35:49 +02006330 switch( steps[i] )
6331 {
6332 case 0:
6333 break;
6334 case PSA_KEY_DERIVATION_INPUT_SECRET:
6335 PSA_ASSERT( psa_import_key( &attributes,
6336 inputs[i]->x, inputs[i]->len,
Ronald Cron5425a212020-08-04 14:58:35 +02006337 &keys[i] ) );
gabor-mezei-armceface22021-01-21 12:26:17 +01006338
6339 if ( PSA_ALG_IS_TLS12_PSK_TO_MS( alg ) )
6340 {
6341 PSA_ASSERT( psa_get_key_attributes( keys[i], &attributes ) );
6342 TEST_ASSERT( PSA_BITS_TO_BYTES( psa_get_key_bits( &attributes ) ) <=
6343 PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE );
6344 }
6345
Gilles Peskine1468da72019-05-29 17:35:49 +02006346 PSA_ASSERT( psa_key_derivation_input_key(
Ronald Cron5425a212020-08-04 14:58:35 +02006347 &operation, steps[i], keys[i] ) );
Gilles Peskine1468da72019-05-29 17:35:49 +02006348 break;
6349 default:
6350 PSA_ASSERT( psa_key_derivation_input_bytes(
6351 &operation, steps[i],
6352 inputs[i]->x, inputs[i]->len ) );
6353 break;
6354 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006355 }
Gilles Peskine1468da72019-05-29 17:35:49 +02006356
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006357 PSA_ASSERT( psa_key_derivation_get_capacity( &operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02006358 &current_capacity ) );
Gilles Peskinefe11b722018-12-18 00:24:04 +01006359 TEST_EQUAL( current_capacity, requested_capacity );
Gilles Peskine96ee5c72018-07-12 17:24:54 +02006360 expected_capacity = requested_capacity;
6361
6362 /* Expansion phase. */
6363 for( i = 0; i < ARRAY_LENGTH( expected_outputs ); i++ )
6364 {
6365 /* Read some bytes. */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006366 status = psa_key_derivation_output_bytes( &operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02006367 output_buffer, output_sizes[i] );
Gilles Peskine96ee5c72018-07-12 17:24:54 +02006368 if( expected_capacity == 0 && output_sizes[i] == 0 )
6369 {
6370 /* Reading 0 bytes when 0 bytes are available can go either way. */
6371 TEST_ASSERT( status == PSA_SUCCESS ||
David Saadab4ecc272019-02-14 13:48:10 +02006372 status == PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskine96ee5c72018-07-12 17:24:54 +02006373 continue;
6374 }
6375 else if( expected_capacity == 0 ||
6376 output_sizes[i] > expected_capacity )
6377 {
6378 /* Capacity exceeded. */
David Saadab4ecc272019-02-14 13:48:10 +02006379 TEST_EQUAL( status, PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskine96ee5c72018-07-12 17:24:54 +02006380 expected_capacity = 0;
6381 continue;
6382 }
6383 /* Success. Check the read data. */
Gilles Peskine8817f612018-12-18 00:18:46 +01006384 PSA_ASSERT( status );
Gilles Peskine96ee5c72018-07-12 17:24:54 +02006385 if( output_sizes[i] != 0 )
Gilles Peskine0dfba2d2018-12-18 00:40:50 +01006386 ASSERT_COMPARE( output_buffer, output_sizes[i],
6387 expected_outputs[i], output_sizes[i] );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006388 /* Check the operation status. */
Gilles Peskine96ee5c72018-07-12 17:24:54 +02006389 expected_capacity -= output_sizes[i];
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006390 PSA_ASSERT( psa_key_derivation_get_capacity( &operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02006391 &current_capacity ) );
Gilles Peskinefe11b722018-12-18 00:24:04 +01006392 TEST_EQUAL( expected_capacity, current_capacity );
Gilles Peskine96ee5c72018-07-12 17:24:54 +02006393 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006394 PSA_ASSERT( psa_key_derivation_abort( &operation ) );
Gilles Peskine96ee5c72018-07-12 17:24:54 +02006395
6396exit:
6397 mbedtls_free( output_buffer );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006398 psa_key_derivation_abort( &operation );
Ronald Cron5425a212020-08-04 14:58:35 +02006399 for( i = 0; i < ARRAY_LENGTH( keys ); i++ )
6400 psa_destroy_key( keys[i] );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02006401 PSA_DONE( );
Gilles Peskine96ee5c72018-07-12 17:24:54 +02006402}
6403/* END_CASE */
6404
6405/* BEGIN_CASE */
Gilles Peskined54931c2018-07-17 21:06:59 +02006406void derive_full( int alg_arg,
6407 data_t *key_data,
Janos Follath47f27ed2019-06-25 13:24:52 +01006408 data_t *input1,
6409 data_t *input2,
Gilles Peskined54931c2018-07-17 21:06:59 +02006410 int requested_capacity_arg )
6411{
Ronald Cron5425a212020-08-04 14:58:35 +02006412 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined54931c2018-07-17 21:06:59 +02006413 psa_algorithm_t alg = alg_arg;
6414 size_t requested_capacity = requested_capacity_arg;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006415 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Gilles Peskined54931c2018-07-17 21:06:59 +02006416 unsigned char output_buffer[16];
6417 size_t expected_capacity = requested_capacity;
6418 size_t current_capacity;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006419 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskined54931c2018-07-17 21:06:59 +02006420
Gilles Peskine8817f612018-12-18 00:18:46 +01006421 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskined54931c2018-07-17 21:06:59 +02006422
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006423 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DERIVE );
6424 psa_set_key_algorithm( &attributes, alg );
6425 psa_set_key_type( &attributes, PSA_KEY_TYPE_DERIVE );
Gilles Peskined54931c2018-07-17 21:06:59 +02006426
Gilles Peskine049c7532019-05-15 20:22:09 +02006427 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02006428 &key ) );
Gilles Peskined54931c2018-07-17 21:06:59 +02006429
Gilles Peskinec18e25f2021-02-12 23:48:20 +01006430 if( !mbedtls_test_psa_setup_key_derivation_wrap( &operation, key, alg,
6431 input1->x, input1->len,
6432 input2->x, input2->len,
6433 requested_capacity ) )
Janos Follathf2815ea2019-07-03 12:41:36 +01006434 goto exit;
Janos Follath47f27ed2019-06-25 13:24:52 +01006435
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006436 PSA_ASSERT( psa_key_derivation_get_capacity( &operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02006437 &current_capacity ) );
Gilles Peskinefe11b722018-12-18 00:24:04 +01006438 TEST_EQUAL( current_capacity, expected_capacity );
Gilles Peskined54931c2018-07-17 21:06:59 +02006439
6440 /* Expansion phase. */
6441 while( current_capacity > 0 )
6442 {
6443 size_t read_size = sizeof( output_buffer );
6444 if( read_size > current_capacity )
6445 read_size = current_capacity;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006446 PSA_ASSERT( psa_key_derivation_output_bytes( &operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02006447 output_buffer,
6448 read_size ) );
Gilles Peskined54931c2018-07-17 21:06:59 +02006449 expected_capacity -= read_size;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006450 PSA_ASSERT( psa_key_derivation_get_capacity( &operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02006451 &current_capacity ) );
Gilles Peskinefe11b722018-12-18 00:24:04 +01006452 TEST_EQUAL( current_capacity, expected_capacity );
Gilles Peskined54931c2018-07-17 21:06:59 +02006453 }
6454
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006455 /* Check that the operation refuses to go over capacity. */
6456 TEST_EQUAL( psa_key_derivation_output_bytes( &operation, output_buffer, 1 ),
David Saadab4ecc272019-02-14 13:48:10 +02006457 PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskined54931c2018-07-17 21:06:59 +02006458
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006459 PSA_ASSERT( psa_key_derivation_abort( &operation ) );
Gilles Peskined54931c2018-07-17 21:06:59 +02006460
6461exit:
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006462 psa_key_derivation_abort( &operation );
Ronald Cron5425a212020-08-04 14:58:35 +02006463 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02006464 PSA_DONE( );
Gilles Peskined54931c2018-07-17 21:06:59 +02006465}
6466/* END_CASE */
6467
Janos Follathe60c9052019-07-03 13:51:30 +01006468/* BEGIN_CASE */
Gilles Peskine0386fba2018-07-12 17:29:22 +02006469void derive_key_exercise( int alg_arg,
6470 data_t *key_data,
Janos Follathe60c9052019-07-03 13:51:30 +01006471 data_t *input1,
6472 data_t *input2,
Gilles Peskine0386fba2018-07-12 17:29:22 +02006473 int derived_type_arg,
6474 int derived_bits_arg,
6475 int derived_usage_arg,
6476 int derived_alg_arg )
6477{
Ronald Cron5425a212020-08-04 14:58:35 +02006478 mbedtls_svc_key_id_t base_key = MBEDTLS_SVC_KEY_ID_INIT;
6479 mbedtls_svc_key_id_t derived_key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine0386fba2018-07-12 17:29:22 +02006480 psa_algorithm_t alg = alg_arg;
6481 psa_key_type_t derived_type = derived_type_arg;
6482 size_t derived_bits = derived_bits_arg;
6483 psa_key_usage_t derived_usage = derived_usage_arg;
6484 psa_algorithm_t derived_alg = derived_alg_arg;
6485 size_t capacity = PSA_BITS_TO_BYTES( derived_bits );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006486 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006487 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02006488 psa_key_attributes_t got_attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine0386fba2018-07-12 17:29:22 +02006489
Gilles Peskine8817f612018-12-18 00:18:46 +01006490 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine0386fba2018-07-12 17:29:22 +02006491
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006492 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DERIVE );
6493 psa_set_key_algorithm( &attributes, alg );
6494 psa_set_key_type( &attributes, PSA_KEY_TYPE_DERIVE );
Gilles Peskine049c7532019-05-15 20:22:09 +02006495 PSA_ASSERT( psa_import_key( &attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02006496 &base_key ) );
Gilles Peskine0386fba2018-07-12 17:29:22 +02006497
6498 /* Derive a key. */
Gilles Peskinec18e25f2021-02-12 23:48:20 +01006499 if ( mbedtls_test_psa_setup_key_derivation_wrap( &operation, base_key, alg,
6500 input1->x, input1->len,
6501 input2->x, input2->len,
6502 capacity ) )
Janos Follathe60c9052019-07-03 13:51:30 +01006503 goto exit;
6504
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006505 psa_set_key_usage_flags( &attributes, derived_usage );
6506 psa_set_key_algorithm( &attributes, derived_alg );
6507 psa_set_key_type( &attributes, derived_type );
Gilles Peskine3a4f1f82019-04-26 13:49:28 +02006508 psa_set_key_bits( &attributes, derived_bits );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006509 PSA_ASSERT( psa_key_derivation_output_key( &attributes, &operation,
Ronald Cron5425a212020-08-04 14:58:35 +02006510 &derived_key ) );
Gilles Peskine0386fba2018-07-12 17:29:22 +02006511
6512 /* Test the key information */
Ronald Cron5425a212020-08-04 14:58:35 +02006513 PSA_ASSERT( psa_get_key_attributes( derived_key, &got_attributes ) );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02006514 TEST_EQUAL( psa_get_key_type( &got_attributes ), derived_type );
6515 TEST_EQUAL( psa_get_key_bits( &got_attributes ), derived_bits );
Gilles Peskine0386fba2018-07-12 17:29:22 +02006516
6517 /* Exercise the derived key. */
Gilles Peskinec18e25f2021-02-12 23:48:20 +01006518 if( ! mbedtls_test_psa_exercise_key( derived_key, derived_usage, derived_alg ) )
Gilles Peskine0386fba2018-07-12 17:29:22 +02006519 goto exit;
6520
6521exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +01006522 /*
6523 * Key attributes may have been returned by psa_get_key_attributes()
6524 * thus reset them as required.
6525 */
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02006526 psa_reset_key_attributes( &got_attributes );
Ronald Cron3a4f0e32020-11-19 17:55:23 +01006527
6528 psa_key_derivation_abort( &operation );
Ronald Cron5425a212020-08-04 14:58:35 +02006529 psa_destroy_key( base_key );
6530 psa_destroy_key( derived_key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02006531 PSA_DONE( );
Gilles Peskine0386fba2018-07-12 17:29:22 +02006532}
6533/* END_CASE */
6534
Janos Follath42fd8882019-07-03 14:17:09 +01006535/* BEGIN_CASE */
Gilles Peskine0386fba2018-07-12 17:29:22 +02006536void derive_key_export( int alg_arg,
6537 data_t *key_data,
Janos Follath42fd8882019-07-03 14:17:09 +01006538 data_t *input1,
6539 data_t *input2,
Gilles Peskine0386fba2018-07-12 17:29:22 +02006540 int bytes1_arg,
6541 int bytes2_arg )
6542{
Ronald Cron5425a212020-08-04 14:58:35 +02006543 mbedtls_svc_key_id_t base_key = MBEDTLS_SVC_KEY_ID_INIT;
6544 mbedtls_svc_key_id_t derived_key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine0386fba2018-07-12 17:29:22 +02006545 psa_algorithm_t alg = alg_arg;
6546 size_t bytes1 = bytes1_arg;
6547 size_t bytes2 = bytes2_arg;
6548 size_t capacity = bytes1 + bytes2;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006549 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Gilles Peskine8cebbba2018-09-27 13:54:18 +02006550 uint8_t *output_buffer = NULL;
6551 uint8_t *export_buffer = NULL;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006552 psa_key_attributes_t base_attributes = PSA_KEY_ATTRIBUTES_INIT;
6553 psa_key_attributes_t derived_attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine0386fba2018-07-12 17:29:22 +02006554 size_t length;
6555
Gilles Peskine8cebbba2018-09-27 13:54:18 +02006556 ASSERT_ALLOC( output_buffer, capacity );
6557 ASSERT_ALLOC( export_buffer, capacity );
Gilles Peskine8817f612018-12-18 00:18:46 +01006558 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine0386fba2018-07-12 17:29:22 +02006559
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006560 psa_set_key_usage_flags( &base_attributes, PSA_KEY_USAGE_DERIVE );
6561 psa_set_key_algorithm( &base_attributes, alg );
6562 psa_set_key_type( &base_attributes, PSA_KEY_TYPE_DERIVE );
Gilles Peskine049c7532019-05-15 20:22:09 +02006563 PSA_ASSERT( psa_import_key( &base_attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02006564 &base_key ) );
Gilles Peskine0386fba2018-07-12 17:29:22 +02006565
6566 /* Derive some material and output it. */
Gilles Peskinec18e25f2021-02-12 23:48:20 +01006567 if( !mbedtls_test_psa_setup_key_derivation_wrap( &operation, base_key, alg,
6568 input1->x, input1->len,
6569 input2->x, input2->len,
6570 capacity ) )
Janos Follath42fd8882019-07-03 14:17:09 +01006571 goto exit;
6572
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006573 PSA_ASSERT( psa_key_derivation_output_bytes( &operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02006574 output_buffer,
6575 capacity ) );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006576 PSA_ASSERT( psa_key_derivation_abort( &operation ) );
Gilles Peskine0386fba2018-07-12 17:29:22 +02006577
6578 /* Derive the same output again, but this time store it in key objects. */
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 Peskineff5f0e72019-04-18 12:53:30 +02006585 psa_set_key_usage_flags( &derived_attributes, PSA_KEY_USAGE_EXPORT );
6586 psa_set_key_algorithm( &derived_attributes, 0 );
6587 psa_set_key_type( &derived_attributes, PSA_KEY_TYPE_RAW_DATA );
Gilles Peskine3a4f1f82019-04-26 13:49:28 +02006588 psa_set_key_bits( &derived_attributes, PSA_BYTES_TO_BITS( bytes1 ) );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006589 PSA_ASSERT( psa_key_derivation_output_key( &derived_attributes, &operation,
Ronald Cron5425a212020-08-04 14:58:35 +02006590 &derived_key ) );
6591 PSA_ASSERT( psa_export_key( derived_key,
Gilles Peskine8817f612018-12-18 00:18:46 +01006592 export_buffer, bytes1,
6593 &length ) );
Gilles Peskinefe11b722018-12-18 00:24:04 +01006594 TEST_EQUAL( length, bytes1 );
Ronald Cron5425a212020-08-04 14:58:35 +02006595 PSA_ASSERT( psa_destroy_key( derived_key ) );
Gilles Peskine3a4f1f82019-04-26 13:49:28 +02006596 psa_set_key_bits( &derived_attributes, PSA_BYTES_TO_BITS( bytes2 ) );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006597 PSA_ASSERT( psa_key_derivation_output_key( &derived_attributes, &operation,
Ronald Cron5425a212020-08-04 14:58:35 +02006598 &derived_key ) );
6599 PSA_ASSERT( psa_export_key( derived_key,
Gilles Peskine8817f612018-12-18 00:18:46 +01006600 export_buffer + bytes1, bytes2,
6601 &length ) );
Gilles Peskinefe11b722018-12-18 00:24:04 +01006602 TEST_EQUAL( length, bytes2 );
Gilles Peskine0386fba2018-07-12 17:29:22 +02006603
6604 /* Compare the outputs from the two runs. */
Gilles Peskine0dfba2d2018-12-18 00:40:50 +01006605 ASSERT_COMPARE( output_buffer, bytes1 + bytes2,
6606 export_buffer, capacity );
Gilles Peskine0386fba2018-07-12 17:29:22 +02006607
6608exit:
6609 mbedtls_free( output_buffer );
6610 mbedtls_free( export_buffer );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006611 psa_key_derivation_abort( &operation );
Ronald Cron5425a212020-08-04 14:58:35 +02006612 psa_destroy_key( base_key );
6613 psa_destroy_key( derived_key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02006614 PSA_DONE( );
Gilles Peskine0386fba2018-07-12 17:29:22 +02006615}
6616/* END_CASE */
6617
6618/* BEGIN_CASE */
Gilles Peskine7c227ae2019-07-31 15:14:44 +02006619void derive_key( int alg_arg,
6620 data_t *key_data, data_t *input1, data_t *input2,
6621 int type_arg, int bits_arg,
Steven Cooreman83fdb702021-01-21 14:24:39 +01006622 int expected_status_arg,
6623 int is_large_output )
Gilles Peskinec744d992019-07-30 17:26:54 +02006624{
Ronald Cron5425a212020-08-04 14:58:35 +02006625 mbedtls_svc_key_id_t base_key = MBEDTLS_SVC_KEY_ID_INIT;
6626 mbedtls_svc_key_id_t derived_key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskinec744d992019-07-30 17:26:54 +02006627 psa_algorithm_t alg = alg_arg;
Gilles Peskine7c227ae2019-07-31 15:14:44 +02006628 psa_key_type_t type = type_arg;
Gilles Peskinec744d992019-07-30 17:26:54 +02006629 size_t bits = bits_arg;
6630 psa_status_t expected_status = expected_status_arg;
6631 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
6632 psa_key_attributes_t base_attributes = PSA_KEY_ATTRIBUTES_INIT;
6633 psa_key_attributes_t derived_attributes = PSA_KEY_ATTRIBUTES_INIT;
6634
6635 PSA_ASSERT( psa_crypto_init( ) );
6636
6637 psa_set_key_usage_flags( &base_attributes, PSA_KEY_USAGE_DERIVE );
6638 psa_set_key_algorithm( &base_attributes, alg );
6639 psa_set_key_type( &base_attributes, PSA_KEY_TYPE_DERIVE );
6640 PSA_ASSERT( psa_import_key( &base_attributes, key_data->x, key_data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02006641 &base_key ) );
Gilles Peskinec744d992019-07-30 17:26:54 +02006642
Gilles Peskinec18e25f2021-02-12 23:48:20 +01006643 if( !mbedtls_test_psa_setup_key_derivation_wrap( &operation, base_key, alg,
6644 input1->x, input1->len,
6645 input2->x, input2->len,
6646 SIZE_MAX ) )
Gilles Peskinec744d992019-07-30 17:26:54 +02006647 goto exit;
6648
6649 psa_set_key_usage_flags( &derived_attributes, PSA_KEY_USAGE_EXPORT );
6650 psa_set_key_algorithm( &derived_attributes, 0 );
Gilles Peskine7c227ae2019-07-31 15:14:44 +02006651 psa_set_key_type( &derived_attributes, type );
Gilles Peskinec744d992019-07-30 17:26:54 +02006652 psa_set_key_bits( &derived_attributes, bits );
Steven Cooreman83fdb702021-01-21 14:24:39 +01006653
6654 psa_status_t status =
6655 psa_key_derivation_output_key( &derived_attributes,
6656 &operation,
6657 &derived_key );
6658 if( is_large_output > 0 )
6659 TEST_ASSUME( status != PSA_ERROR_INSUFFICIENT_MEMORY );
6660 TEST_EQUAL( status, expected_status );
Gilles Peskinec744d992019-07-30 17:26:54 +02006661
6662exit:
6663 psa_key_derivation_abort( &operation );
Ronald Cron5425a212020-08-04 14:58:35 +02006664 psa_destroy_key( base_key );
6665 psa_destroy_key( derived_key );
Gilles Peskinec744d992019-07-30 17:26:54 +02006666 PSA_DONE( );
6667}
6668/* END_CASE */
6669
6670/* BEGIN_CASE */
Gilles Peskine01d718c2018-09-18 12:01:02 +02006671void key_agreement_setup( int alg_arg,
Steven Cooremance48e852020-10-05 16:02:45 +02006672 int our_key_type_arg, int our_key_alg_arg,
6673 data_t *our_key_data, data_t *peer_key_data,
Gilles Peskine01d718c2018-09-18 12:01:02 +02006674 int expected_status_arg )
6675{
Ronald Cron5425a212020-08-04 14:58:35 +02006676 mbedtls_svc_key_id_t our_key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine01d718c2018-09-18 12:01:02 +02006677 psa_algorithm_t alg = alg_arg;
Steven Cooremanfa5e6312020-10-15 17:07:12 +02006678 psa_algorithm_t our_key_alg = our_key_alg_arg;
Gilles Peskine01d718c2018-09-18 12:01:02 +02006679 psa_key_type_t our_key_type = our_key_type_arg;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006680 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006681 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine77f40d82019-04-11 21:27:06 +02006682 psa_status_t expected_status = expected_status_arg;
6683 psa_status_t status;
Gilles Peskine01d718c2018-09-18 12:01:02 +02006684
Gilles Peskine8817f612018-12-18 00:18:46 +01006685 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine01d718c2018-09-18 12:01:02 +02006686
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006687 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DERIVE );
Steven Cooremanfa5e6312020-10-15 17:07:12 +02006688 psa_set_key_algorithm( &attributes, our_key_alg );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006689 psa_set_key_type( &attributes, our_key_type );
Gilles Peskine049c7532019-05-15 20:22:09 +02006690 PSA_ASSERT( psa_import_key( &attributes,
6691 our_key_data->x, our_key_data->len,
6692 &our_key ) );
Gilles Peskine01d718c2018-09-18 12:01:02 +02006693
Gilles Peskine77f40d82019-04-11 21:27:06 +02006694 /* The tests currently include inputs that should fail at either step.
6695 * Test cases that fail at the setup step should be changed to call
6696 * key_derivation_setup instead, and this function should be renamed
6697 * to key_agreement_fail. */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006698 status = psa_key_derivation_setup( &operation, alg );
Gilles Peskine77f40d82019-04-11 21:27:06 +02006699 if( status == PSA_SUCCESS )
6700 {
Gilles Peskinecf7292e2019-05-16 17:53:40 +02006701 TEST_EQUAL( psa_key_derivation_key_agreement(
6702 &operation, PSA_KEY_DERIVATION_INPUT_SECRET,
6703 our_key,
6704 peer_key_data->x, peer_key_data->len ),
Gilles Peskine77f40d82019-04-11 21:27:06 +02006705 expected_status );
6706 }
6707 else
6708 {
6709 TEST_ASSERT( status == expected_status );
6710 }
Gilles Peskine01d718c2018-09-18 12:01:02 +02006711
6712exit:
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006713 psa_key_derivation_abort( &operation );
Gilles Peskine01d718c2018-09-18 12:01:02 +02006714 psa_destroy_key( our_key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02006715 PSA_DONE( );
Gilles Peskine01d718c2018-09-18 12:01:02 +02006716}
6717/* END_CASE */
6718
6719/* BEGIN_CASE */
Gilles Peskinef0cba732019-04-11 22:12:38 +02006720void raw_key_agreement( int alg_arg,
6721 int our_key_type_arg, data_t *our_key_data,
6722 data_t *peer_key_data,
6723 data_t *expected_output )
6724{
Ronald Cron5425a212020-08-04 14:58:35 +02006725 mbedtls_svc_key_id_t our_key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskinef0cba732019-04-11 22:12:38 +02006726 psa_algorithm_t alg = alg_arg;
6727 psa_key_type_t our_key_type = our_key_type_arg;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006728 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskinef0cba732019-04-11 22:12:38 +02006729 unsigned char *output = NULL;
6730 size_t output_length = ~0;
gabor-mezei-armceface22021-01-21 12:26:17 +01006731 size_t key_bits;
Gilles Peskinef0cba732019-04-11 22:12:38 +02006732
6733 ASSERT_ALLOC( output, expected_output->len );
6734 PSA_ASSERT( psa_crypto_init( ) );
6735
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006736 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DERIVE );
6737 psa_set_key_algorithm( &attributes, alg );
6738 psa_set_key_type( &attributes, our_key_type );
Gilles Peskine049c7532019-05-15 20:22:09 +02006739 PSA_ASSERT( psa_import_key( &attributes,
6740 our_key_data->x, our_key_data->len,
6741 &our_key ) );
Gilles Peskinef0cba732019-04-11 22:12:38 +02006742
gabor-mezei-armceface22021-01-21 12:26:17 +01006743 PSA_ASSERT( psa_get_key_attributes( our_key, &attributes ) );
6744 key_bits = psa_get_key_bits( &attributes );
6745
Gilles Peskinebe697d82019-05-16 18:00:41 +02006746 PSA_ASSERT( psa_raw_key_agreement( alg, our_key,
6747 peer_key_data->x, peer_key_data->len,
6748 output, expected_output->len,
6749 &output_length ) );
Gilles Peskinef0cba732019-04-11 22:12:38 +02006750 ASSERT_COMPARE( output, output_length,
6751 expected_output->x, expected_output->len );
gabor-mezei-armceface22021-01-21 12:26:17 +01006752 TEST_ASSERT( output_length <=
6753 PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE( our_key_type, key_bits ) );
6754 TEST_ASSERT( output_length <=
6755 PSA_RAW_KEY_AGREEMENT_OUTPUT_MAX_SIZE );
Gilles Peskinef0cba732019-04-11 22:12:38 +02006756
6757exit:
6758 mbedtls_free( output );
6759 psa_destroy_key( our_key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02006760 PSA_DONE( );
Gilles Peskinef0cba732019-04-11 22:12:38 +02006761}
6762/* END_CASE */
6763
6764/* BEGIN_CASE */
Gilles Peskine59685592018-09-18 12:11:34 +02006765void key_agreement_capacity( int alg_arg,
6766 int our_key_type_arg, data_t *our_key_data,
6767 data_t *peer_key_data,
6768 int expected_capacity_arg )
6769{
Ronald Cron5425a212020-08-04 14:58:35 +02006770 mbedtls_svc_key_id_t our_key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine59685592018-09-18 12:11:34 +02006771 psa_algorithm_t alg = alg_arg;
6772 psa_key_type_t our_key_type = our_key_type_arg;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006773 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006774 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine59685592018-09-18 12:11:34 +02006775 size_t actual_capacity;
Gilles Peskinebf491972018-10-25 22:36:12 +02006776 unsigned char output[16];
Gilles Peskine59685592018-09-18 12:11:34 +02006777
Gilles Peskine8817f612018-12-18 00:18:46 +01006778 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine59685592018-09-18 12:11:34 +02006779
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006780 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DERIVE );
6781 psa_set_key_algorithm( &attributes, alg );
6782 psa_set_key_type( &attributes, our_key_type );
Gilles Peskine049c7532019-05-15 20:22:09 +02006783 PSA_ASSERT( psa_import_key( &attributes,
6784 our_key_data->x, our_key_data->len,
6785 &our_key ) );
Gilles Peskine59685592018-09-18 12:11:34 +02006786
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006787 PSA_ASSERT( psa_key_derivation_setup( &operation, alg ) );
Gilles Peskinecf7292e2019-05-16 17:53:40 +02006788 PSA_ASSERT( psa_key_derivation_key_agreement(
6789 &operation,
6790 PSA_KEY_DERIVATION_INPUT_SECRET, our_key,
6791 peer_key_data->x, peer_key_data->len ) );
Gilles Peskinef8a9d942019-04-11 22:13:20 +02006792 if( PSA_ALG_IS_HKDF( PSA_ALG_KEY_AGREEMENT_GET_KDF( alg ) ) )
6793 {
6794 /* The test data is for info="" */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006795 PSA_ASSERT( psa_key_derivation_input_bytes( &operation,
Gilles Peskine03410b52019-05-16 16:05:19 +02006796 PSA_KEY_DERIVATION_INPUT_INFO,
Gilles Peskinef8a9d942019-04-11 22:13:20 +02006797 NULL, 0 ) );
6798 }
Gilles Peskine59685592018-09-18 12:11:34 +02006799
Gilles Peskinebf491972018-10-25 22:36:12 +02006800 /* Test the advertized capacity. */
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02006801 PSA_ASSERT( psa_key_derivation_get_capacity(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006802 &operation, &actual_capacity ) );
Gilles Peskinefe11b722018-12-18 00:24:04 +01006803 TEST_EQUAL( actual_capacity, (size_t) expected_capacity_arg );
Gilles Peskine59685592018-09-18 12:11:34 +02006804
Gilles Peskinebf491972018-10-25 22:36:12 +02006805 /* Test the actual capacity by reading the output. */
6806 while( actual_capacity > sizeof( output ) )
6807 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006808 PSA_ASSERT( psa_key_derivation_output_bytes( &operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02006809 output, sizeof( output ) ) );
Gilles Peskinebf491972018-10-25 22:36:12 +02006810 actual_capacity -= sizeof( output );
6811 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006812 PSA_ASSERT( psa_key_derivation_output_bytes( &operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02006813 output, actual_capacity ) );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006814 TEST_EQUAL( psa_key_derivation_output_bytes( &operation, output, 1 ),
David Saadab4ecc272019-02-14 13:48:10 +02006815 PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskinebf491972018-10-25 22:36:12 +02006816
Gilles Peskine59685592018-09-18 12:11:34 +02006817exit:
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006818 psa_key_derivation_abort( &operation );
Gilles Peskine59685592018-09-18 12:11:34 +02006819 psa_destroy_key( our_key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02006820 PSA_DONE( );
Gilles Peskine59685592018-09-18 12:11:34 +02006821}
6822/* END_CASE */
6823
6824/* BEGIN_CASE */
6825void key_agreement_output( int alg_arg,
6826 int our_key_type_arg, data_t *our_key_data,
6827 data_t *peer_key_data,
Gilles Peskine3ec8ed82018-10-25 22:37:15 +02006828 data_t *expected_output1, data_t *expected_output2 )
Gilles Peskine59685592018-09-18 12:11:34 +02006829{
Ronald Cron5425a212020-08-04 14:58:35 +02006830 mbedtls_svc_key_id_t our_key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine59685592018-09-18 12:11:34 +02006831 psa_algorithm_t alg = alg_arg;
6832 psa_key_type_t our_key_type = our_key_type_arg;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006833 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006834 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine3ec8ed82018-10-25 22:37:15 +02006835 uint8_t *actual_output = NULL;
Gilles Peskine59685592018-09-18 12:11:34 +02006836
Gilles Peskine3ec8ed82018-10-25 22:37:15 +02006837 ASSERT_ALLOC( actual_output, MAX( expected_output1->len,
6838 expected_output2->len ) );
Gilles Peskine59685592018-09-18 12:11:34 +02006839
Gilles Peskine8817f612018-12-18 00:18:46 +01006840 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine59685592018-09-18 12:11:34 +02006841
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006842 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DERIVE );
6843 psa_set_key_algorithm( &attributes, alg );
6844 psa_set_key_type( &attributes, our_key_type );
Gilles Peskine049c7532019-05-15 20:22:09 +02006845 PSA_ASSERT( psa_import_key( &attributes,
6846 our_key_data->x, our_key_data->len,
6847 &our_key ) );
Gilles Peskine59685592018-09-18 12:11:34 +02006848
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006849 PSA_ASSERT( psa_key_derivation_setup( &operation, alg ) );
Gilles Peskinecf7292e2019-05-16 17:53:40 +02006850 PSA_ASSERT( psa_key_derivation_key_agreement(
6851 &operation,
6852 PSA_KEY_DERIVATION_INPUT_SECRET, our_key,
6853 peer_key_data->x, peer_key_data->len ) );
Gilles Peskinef8a9d942019-04-11 22:13:20 +02006854 if( PSA_ALG_IS_HKDF( PSA_ALG_KEY_AGREEMENT_GET_KDF( alg ) ) )
6855 {
6856 /* The test data is for info="" */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006857 PSA_ASSERT( psa_key_derivation_input_bytes( &operation,
Gilles Peskine03410b52019-05-16 16:05:19 +02006858 PSA_KEY_DERIVATION_INPUT_INFO,
Gilles Peskinef8a9d942019-04-11 22:13:20 +02006859 NULL, 0 ) );
6860 }
Gilles Peskine59685592018-09-18 12:11:34 +02006861
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006862 PSA_ASSERT( psa_key_derivation_output_bytes( &operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02006863 actual_output,
6864 expected_output1->len ) );
Gilles Peskine0dfba2d2018-12-18 00:40:50 +01006865 ASSERT_COMPARE( actual_output, expected_output1->len,
6866 expected_output1->x, expected_output1->len );
Gilles Peskine3ec8ed82018-10-25 22:37:15 +02006867 if( expected_output2->len != 0 )
6868 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006869 PSA_ASSERT( psa_key_derivation_output_bytes( &operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02006870 actual_output,
6871 expected_output2->len ) );
Gilles Peskine0dfba2d2018-12-18 00:40:50 +01006872 ASSERT_COMPARE( actual_output, expected_output2->len,
6873 expected_output2->x, expected_output2->len );
Gilles Peskine3ec8ed82018-10-25 22:37:15 +02006874 }
Gilles Peskine59685592018-09-18 12:11:34 +02006875
6876exit:
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006877 psa_key_derivation_abort( &operation );
Gilles Peskine59685592018-09-18 12:11:34 +02006878 psa_destroy_key( our_key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02006879 PSA_DONE( );
Gilles Peskine59685592018-09-18 12:11:34 +02006880 mbedtls_free( actual_output );
6881}
6882/* END_CASE */
6883
6884/* BEGIN_CASE */
Gilles Peskinea50d7392018-06-21 10:22:13 +02006885void generate_random( int bytes_arg )
Gilles Peskine05d69892018-06-19 22:00:52 +02006886{
Gilles Peskinea50d7392018-06-21 10:22:13 +02006887 size_t bytes = bytes_arg;
Gilles Peskine8cebbba2018-09-27 13:54:18 +02006888 unsigned char *output = NULL;
6889 unsigned char *changed = NULL;
Gilles Peskinea50d7392018-06-21 10:22:13 +02006890 size_t i;
6891 unsigned run;
Gilles Peskine05d69892018-06-19 22:00:52 +02006892
Simon Butcher49f8e312020-03-03 15:51:50 +00006893 TEST_ASSERT( bytes_arg >= 0 );
6894
Gilles Peskine91892022021-02-08 19:50:26 +01006895 ASSERT_ALLOC( output, bytes );
Gilles Peskine8cebbba2018-09-27 13:54:18 +02006896 ASSERT_ALLOC( changed, bytes );
Gilles Peskine05d69892018-06-19 22:00:52 +02006897
Gilles Peskine8817f612018-12-18 00:18:46 +01006898 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine05d69892018-06-19 22:00:52 +02006899
Gilles Peskinea50d7392018-06-21 10:22:13 +02006900 /* Run several times, to ensure that every output byte will be
6901 * nonzero at least once with overwhelming probability
6902 * (2^(-8*number_of_runs)). */
6903 for( run = 0; run < 10; run++ )
Gilles Peskine05d69892018-06-19 22:00:52 +02006904 {
Gilles Peskinef7ab5ad2018-09-26 18:19:24 +02006905 if( bytes != 0 )
6906 memset( output, 0, bytes );
Gilles Peskine8817f612018-12-18 00:18:46 +01006907 PSA_ASSERT( psa_generate_random( output, bytes ) );
Gilles Peskinea50d7392018-06-21 10:22:13 +02006908
Gilles Peskinea50d7392018-06-21 10:22:13 +02006909 for( i = 0; i < bytes; i++ )
6910 {
6911 if( output[i] != 0 )
6912 ++changed[i];
6913 }
Gilles Peskine05d69892018-06-19 22:00:52 +02006914 }
Gilles Peskinea50d7392018-06-21 10:22:13 +02006915
6916 /* Check that every byte was changed to nonzero at least once. This
6917 * validates that psa_generate_random is overwriting every byte of
6918 * the output buffer. */
6919 for( i = 0; i < bytes; i++ )
6920 {
6921 TEST_ASSERT( changed[i] != 0 );
6922 }
Gilles Peskine05d69892018-06-19 22:00:52 +02006923
6924exit:
Gilles Peskine1153e7b2019-05-28 15:10:21 +02006925 PSA_DONE( );
Gilles Peskinea50d7392018-06-21 10:22:13 +02006926 mbedtls_free( output );
6927 mbedtls_free( changed );
Gilles Peskine05d69892018-06-19 22:00:52 +02006928}
6929/* END_CASE */
Gilles Peskine12313cd2018-06-20 00:20:32 +02006930
6931/* BEGIN_CASE */
6932void generate_key( int type_arg,
6933 int bits_arg,
6934 int usage_arg,
6935 int alg_arg,
Steven Cooreman83fdb702021-01-21 14:24:39 +01006936 int expected_status_arg,
6937 int is_large_key )
Gilles Peskine12313cd2018-06-20 00:20:32 +02006938{
Ronald Cron5425a212020-08-04 14:58:35 +02006939 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine12313cd2018-06-20 00:20:32 +02006940 psa_key_type_t type = type_arg;
6941 psa_key_usage_t usage = usage_arg;
6942 size_t bits = bits_arg;
6943 psa_algorithm_t alg = alg_arg;
6944 psa_status_t expected_status = expected_status_arg;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006945 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02006946 psa_key_attributes_t got_attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine12313cd2018-06-20 00:20:32 +02006947
Gilles Peskine8817f612018-12-18 00:18:46 +01006948 PSA_ASSERT( psa_crypto_init( ) );
Gilles Peskine12313cd2018-06-20 00:20:32 +02006949
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006950 psa_set_key_usage_flags( &attributes, usage );
6951 psa_set_key_algorithm( &attributes, alg );
6952 psa_set_key_type( &attributes, type );
Gilles Peskine3a4f1f82019-04-26 13:49:28 +02006953 psa_set_key_bits( &attributes, bits );
Gilles Peskine12313cd2018-06-20 00:20:32 +02006954
6955 /* Generate a key */
Steven Cooreman83fdb702021-01-21 14:24:39 +01006956 psa_status_t status = psa_generate_key( &attributes, &key );
6957
6958 if( is_large_key > 0 )
6959 TEST_ASSUME( status != PSA_ERROR_INSUFFICIENT_MEMORY );
6960 TEST_EQUAL( status , expected_status );
Gilles Peskinee56e8782019-04-26 17:34:02 +02006961 if( expected_status != PSA_SUCCESS )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006962 goto exit;
Gilles Peskine12313cd2018-06-20 00:20:32 +02006963
6964 /* Test the key information */
Ronald Cron5425a212020-08-04 14:58:35 +02006965 PSA_ASSERT( psa_get_key_attributes( key, &got_attributes ) );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02006966 TEST_EQUAL( psa_get_key_type( &got_attributes ), type );
6967 TEST_EQUAL( psa_get_key_bits( &got_attributes ), bits );
Gilles Peskine12313cd2018-06-20 00:20:32 +02006968
Gilles Peskine818ca122018-06-20 18:16:48 +02006969 /* Do something with the key according to its type and permitted usage. */
Gilles Peskinec18e25f2021-02-12 23:48:20 +01006970 if( ! mbedtls_test_psa_exercise_key( key, usage, alg ) )
Gilles Peskine02b75072018-07-01 22:31:34 +02006971 goto exit;
Gilles Peskine12313cd2018-06-20 00:20:32 +02006972
6973exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +01006974 /*
6975 * Key attributes may have been returned by psa_get_key_attributes()
6976 * thus reset them as required.
6977 */
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02006978 psa_reset_key_attributes( &got_attributes );
Ronald Cron3a4f0e32020-11-19 17:55:23 +01006979
Ronald Cron5425a212020-08-04 14:58:35 +02006980 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02006981 PSA_DONE( );
Gilles Peskine12313cd2018-06-20 00:20:32 +02006982}
6983/* END_CASE */
itayzafrir0adf0fc2018-09-06 16:24:41 +03006984
Ronald Cronee414c72021-03-18 18:50:08 +01006985/* 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 +02006986void generate_key_rsa( int bits_arg,
6987 data_t *e_arg,
6988 int expected_status_arg )
6989{
Ronald Cron5425a212020-08-04 14:58:35 +02006990 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskinec93b80c2019-05-16 19:39:54 +02006991 psa_key_type_t type = PSA_KEY_TYPE_RSA_KEY_PAIR;
Gilles Peskinee56e8782019-04-26 17:34:02 +02006992 size_t bits = bits_arg;
6993 psa_key_usage_t usage = PSA_KEY_USAGE_ENCRYPT | PSA_KEY_USAGE_DECRYPT;
6994 psa_algorithm_t alg = PSA_ALG_RSA_PKCS1V15_SIGN_RAW;
6995 psa_status_t expected_status = expected_status_arg;
6996 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
6997 uint8_t *exported = NULL;
6998 size_t exported_size =
gabor-mezei-armcbcec212020-12-18 14:23:51 +01006999 PSA_EXPORT_KEY_OUTPUT_SIZE( PSA_KEY_TYPE_RSA_PUBLIC_KEY, bits );
Gilles Peskinee56e8782019-04-26 17:34:02 +02007000 size_t exported_length = SIZE_MAX;
7001 uint8_t *e_read_buffer = NULL;
7002 int is_default_public_exponent = 0;
Gilles Peskineaa02c172019-04-28 11:44:17 +02007003 size_t e_read_size = PSA_KEY_DOMAIN_PARAMETERS_SIZE( type, bits );
Gilles Peskinee56e8782019-04-26 17:34:02 +02007004 size_t e_read_length = SIZE_MAX;
7005
7006 if( e_arg->len == 0 ||
7007 ( e_arg->len == 3 &&
7008 e_arg->x[0] == 1 && e_arg->x[1] == 0 && e_arg->x[2] == 1 ) )
7009 {
7010 is_default_public_exponent = 1;
7011 e_read_size = 0;
7012 }
7013 ASSERT_ALLOC( e_read_buffer, e_read_size );
7014 ASSERT_ALLOC( exported, exported_size );
7015
7016 PSA_ASSERT( psa_crypto_init( ) );
7017
7018 psa_set_key_usage_flags( &attributes, usage );
7019 psa_set_key_algorithm( &attributes, alg );
7020 PSA_ASSERT( psa_set_key_domain_parameters( &attributes, type,
7021 e_arg->x, e_arg->len ) );
7022 psa_set_key_bits( &attributes, bits );
7023
7024 /* Generate a key */
Ronald Cron5425a212020-08-04 14:58:35 +02007025 TEST_EQUAL( psa_generate_key( &attributes, &key ), expected_status );
Gilles Peskinee56e8782019-04-26 17:34:02 +02007026 if( expected_status != PSA_SUCCESS )
7027 goto exit;
7028
7029 /* Test the key information */
Ronald Cron5425a212020-08-04 14:58:35 +02007030 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
Gilles Peskinee56e8782019-04-26 17:34:02 +02007031 TEST_EQUAL( psa_get_key_type( &attributes ), type );
7032 TEST_EQUAL( psa_get_key_bits( &attributes ), bits );
7033 PSA_ASSERT( psa_get_key_domain_parameters( &attributes,
7034 e_read_buffer, e_read_size,
7035 &e_read_length ) );
7036 if( is_default_public_exponent )
7037 TEST_EQUAL( e_read_length, 0 );
7038 else
7039 ASSERT_COMPARE( e_read_buffer, e_read_length, e_arg->x, e_arg->len );
7040
7041 /* Do something with the key according to its type and permitted usage. */
Gilles Peskinec18e25f2021-02-12 23:48:20 +01007042 if( ! mbedtls_test_psa_exercise_key( key, usage, alg ) )
Gilles Peskinee56e8782019-04-26 17:34:02 +02007043 goto exit;
7044
7045 /* Export the key and check the public exponent. */
Ronald Cron5425a212020-08-04 14:58:35 +02007046 PSA_ASSERT( psa_export_public_key( key,
Gilles Peskinee56e8782019-04-26 17:34:02 +02007047 exported, exported_size,
7048 &exported_length ) );
7049 {
7050 uint8_t *p = exported;
7051 uint8_t *end = exported + exported_length;
7052 size_t len;
7053 /* RSAPublicKey ::= SEQUENCE {
7054 * modulus INTEGER, -- n
7055 * publicExponent INTEGER } -- e
7056 */
7057 TEST_EQUAL( 0, mbedtls_asn1_get_tag( &p, end, &len,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02007058 MBEDTLS_ASN1_SEQUENCE |
7059 MBEDTLS_ASN1_CONSTRUCTED ) );
Gilles Peskine8e94efe2021-02-13 00:25:53 +01007060 TEST_ASSERT( mbedtls_test_asn1_skip_integer( &p, end, bits, bits, 1 ) );
Gilles Peskinee56e8782019-04-26 17:34:02 +02007061 TEST_EQUAL( 0, mbedtls_asn1_get_tag( &p, end, &len,
7062 MBEDTLS_ASN1_INTEGER ) );
7063 if( len >= 1 && p[0] == 0 )
7064 {
7065 ++p;
7066 --len;
7067 }
7068 if( e_arg->len == 0 )
7069 {
7070 TEST_EQUAL( len, 3 );
7071 TEST_EQUAL( p[0], 1 );
7072 TEST_EQUAL( p[1], 0 );
7073 TEST_EQUAL( p[2], 1 );
7074 }
7075 else
7076 ASSERT_COMPARE( p, len, e_arg->x, e_arg->len );
7077 }
7078
7079exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +01007080 /*
7081 * Key attributes may have been returned by psa_get_key_attributes() or
7082 * set by psa_set_key_domain_parameters() thus reset them as required.
7083 */
Gilles Peskinee56e8782019-04-26 17:34:02 +02007084 psa_reset_key_attributes( &attributes );
Ronald Cron3a4f0e32020-11-19 17:55:23 +01007085
Ronald Cron5425a212020-08-04 14:58:35 +02007086 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02007087 PSA_DONE( );
Gilles Peskinee56e8782019-04-26 17:34:02 +02007088 mbedtls_free( e_read_buffer );
7089 mbedtls_free( exported );
7090}
7091/* END_CASE */
7092
Darryl Greend49a4992018-06-18 17:27:26 +01007093/* BEGIN_CASE depends_on:MBEDTLS_PSA_CRYPTO_STORAGE_C */
Gilles Peskine5c648ab2019-04-19 14:06:53 +02007094void persistent_key_load_key_from_storage( data_t *data,
7095 int type_arg, int bits_arg,
7096 int usage_flags_arg, int alg_arg,
7097 int generation_method )
Darryl Greend49a4992018-06-18 17:27:26 +01007098{
Ronald Cron71016a92020-08-28 19:01:50 +02007099 mbedtls_svc_key_id_t key_id = mbedtls_svc_key_id_make( 1, 1 );
Gilles Peskine5c648ab2019-04-19 14:06:53 +02007100 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Ronald Cron5425a212020-08-04 14:58:35 +02007101 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
7102 mbedtls_svc_key_id_t base_key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine5c648ab2019-04-19 14:06:53 +02007103 psa_key_type_t type = type_arg;
7104 size_t bits = bits_arg;
7105 psa_key_usage_t usage_flags = usage_flags_arg;
7106 psa_algorithm_t alg = alg_arg;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007107 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Darryl Greend49a4992018-06-18 17:27:26 +01007108 unsigned char *first_export = NULL;
7109 unsigned char *second_export = NULL;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01007110 size_t export_size = PSA_EXPORT_KEY_OUTPUT_SIZE( type, bits );
Darryl Greend49a4992018-06-18 17:27:26 +01007111 size_t first_exported_length;
7112 size_t second_exported_length;
7113
Gilles Peskine5c648ab2019-04-19 14:06:53 +02007114 if( usage_flags & PSA_KEY_USAGE_EXPORT )
7115 {
7116 ASSERT_ALLOC( first_export, export_size );
7117 ASSERT_ALLOC( second_export, export_size );
7118 }
Darryl Greend49a4992018-06-18 17:27:26 +01007119
Gilles Peskine8817f612018-12-18 00:18:46 +01007120 PSA_ASSERT( psa_crypto_init() );
Darryl Greend49a4992018-06-18 17:27:26 +01007121
Gilles Peskinec87af662019-05-15 16:12:22 +02007122 psa_set_key_id( &attributes, key_id );
Gilles Peskine5c648ab2019-04-19 14:06:53 +02007123 psa_set_key_usage_flags( &attributes, usage_flags );
7124 psa_set_key_algorithm( &attributes, alg );
7125 psa_set_key_type( &attributes, type );
Gilles Peskine3a4f1f82019-04-26 13:49:28 +02007126 psa_set_key_bits( &attributes, bits );
Darryl Greend49a4992018-06-18 17:27:26 +01007127
Darryl Green0c6575a2018-11-07 16:05:30 +00007128 switch( generation_method )
7129 {
7130 case IMPORT_KEY:
7131 /* Import the key */
Gilles Peskine049c7532019-05-15 20:22:09 +02007132 PSA_ASSERT( psa_import_key( &attributes, data->x, data->len,
Ronald Cron5425a212020-08-04 14:58:35 +02007133 &key ) );
Darryl Green0c6575a2018-11-07 16:05:30 +00007134 break;
Darryl Greend49a4992018-06-18 17:27:26 +01007135
Darryl Green0c6575a2018-11-07 16:05:30 +00007136 case GENERATE_KEY:
7137 /* Generate a key */
Ronald Cron5425a212020-08-04 14:58:35 +02007138 PSA_ASSERT( psa_generate_key( &attributes, &key ) );
Darryl Green0c6575a2018-11-07 16:05:30 +00007139 break;
7140
7141 case DERIVE_KEY:
Steven Cooreman70f654a2021-02-15 10:51:43 +01007142#if defined(PSA_WANT_ALG_HKDF) && defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine5c648ab2019-04-19 14:06:53 +02007143 {
7144 /* Create base key */
7145 psa_algorithm_t derive_alg = PSA_ALG_HKDF( PSA_ALG_SHA_256 );
7146 psa_key_attributes_t base_attributes = PSA_KEY_ATTRIBUTES_INIT;
7147 psa_set_key_usage_flags( &base_attributes,
7148 PSA_KEY_USAGE_DERIVE );
7149 psa_set_key_algorithm( &base_attributes, derive_alg );
7150 psa_set_key_type( &base_attributes, PSA_KEY_TYPE_DERIVE );
Gilles Peskine049c7532019-05-15 20:22:09 +02007151 PSA_ASSERT( psa_import_key( &base_attributes,
7152 data->x, data->len,
7153 &base_key ) );
Gilles Peskine5c648ab2019-04-19 14:06:53 +02007154 /* Derive a key. */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007155 PSA_ASSERT( psa_key_derivation_setup( &operation, derive_alg ) );
Gilles Peskinecf7292e2019-05-16 17:53:40 +02007156 PSA_ASSERT( psa_key_derivation_input_key(
7157 &operation,
7158 PSA_KEY_DERIVATION_INPUT_SECRET, base_key ) );
Gilles Peskine5c648ab2019-04-19 14:06:53 +02007159 PSA_ASSERT( psa_key_derivation_input_bytes(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007160 &operation, PSA_KEY_DERIVATION_INPUT_INFO,
Gilles Peskine5c648ab2019-04-19 14:06:53 +02007161 NULL, 0 ) );
Gilles Peskinecf7292e2019-05-16 17:53:40 +02007162 PSA_ASSERT( psa_key_derivation_output_key( &attributes,
7163 &operation,
Ronald Cron5425a212020-08-04 14:58:35 +02007164 &key ) );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007165 PSA_ASSERT( psa_key_derivation_abort( &operation ) );
Gilles Peskine5c648ab2019-04-19 14:06:53 +02007166 PSA_ASSERT( psa_destroy_key( base_key ) );
Ronald Cron5425a212020-08-04 14:58:35 +02007167 base_key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine5c648ab2019-04-19 14:06:53 +02007168 }
Gilles Peskine6fea21d2021-01-12 00:02:15 +01007169#else
7170 TEST_ASSUME( ! "KDF not supported in this configuration" );
7171#endif
7172 break;
7173
7174 default:
7175 TEST_ASSERT( ! "generation_method not implemented in test" );
7176 break;
Darryl Green0c6575a2018-11-07 16:05:30 +00007177 }
Gilles Peskine5c648ab2019-04-19 14:06:53 +02007178 psa_reset_key_attributes( &attributes );
Darryl Greend49a4992018-06-18 17:27:26 +01007179
Gilles Peskine5c648ab2019-04-19 14:06:53 +02007180 /* Export the key if permitted by the key policy. */
7181 if( usage_flags & PSA_KEY_USAGE_EXPORT )
7182 {
Ronald Cron5425a212020-08-04 14:58:35 +02007183 PSA_ASSERT( psa_export_key( key,
Gilles Peskine5c648ab2019-04-19 14:06:53 +02007184 first_export, export_size,
7185 &first_exported_length ) );
7186 if( generation_method == IMPORT_KEY )
7187 ASSERT_COMPARE( data->x, data->len,
7188 first_export, first_exported_length );
7189 }
Darryl Greend49a4992018-06-18 17:27:26 +01007190
7191 /* Shutdown and restart */
Ronald Cron5425a212020-08-04 14:58:35 +02007192 PSA_ASSERT( psa_purge_key( key ) );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02007193 PSA_DONE();
Gilles Peskine8817f612018-12-18 00:18:46 +01007194 PSA_ASSERT( psa_crypto_init() );
Darryl Greend49a4992018-06-18 17:27:26 +01007195
Darryl Greend49a4992018-06-18 17:27:26 +01007196 /* Check key slot still contains key data */
Ronald Cron5425a212020-08-04 14:58:35 +02007197 PSA_ASSERT( psa_get_key_attributes( key, &attributes ) );
Ronald Cronecfb2372020-07-23 17:13:42 +02007198 TEST_ASSERT( mbedtls_svc_key_id_equal(
7199 psa_get_key_id( &attributes ), key_id ) );
Gilles Peskine5c648ab2019-04-19 14:06:53 +02007200 TEST_EQUAL( psa_get_key_lifetime( &attributes ),
7201 PSA_KEY_LIFETIME_PERSISTENT );
7202 TEST_EQUAL( psa_get_key_type( &attributes ), type );
7203 TEST_EQUAL( psa_get_key_bits( &attributes ), bits );
gabor-mezei-arm4ff73032021-05-13 12:05:01 +02007204 TEST_EQUAL( psa_get_key_usage_flags( &attributes ),
gabor-mezei-arm98a34352021-06-28 14:05:00 +02007205 mbedtls_test_update_key_usage_flags( usage_flags ) );
Gilles Peskine5c648ab2019-04-19 14:06:53 +02007206 TEST_EQUAL( psa_get_key_algorithm( &attributes ), alg );
Darryl Greend49a4992018-06-18 17:27:26 +01007207
Gilles Peskine5c648ab2019-04-19 14:06:53 +02007208 /* Export the key again if permitted by the key policy. */
7209 if( usage_flags & PSA_KEY_USAGE_EXPORT )
Darryl Green0c6575a2018-11-07 16:05:30 +00007210 {
Ronald Cron5425a212020-08-04 14:58:35 +02007211 PSA_ASSERT( psa_export_key( key,
Gilles Peskine5c648ab2019-04-19 14:06:53 +02007212 second_export, export_size,
7213 &second_exported_length ) );
Darryl Green0c6575a2018-11-07 16:05:30 +00007214 ASSERT_COMPARE( first_export, first_exported_length,
7215 second_export, second_exported_length );
Darryl Green0c6575a2018-11-07 16:05:30 +00007216 }
7217
7218 /* Do something with the key according to its type and permitted usage. */
Gilles Peskinec18e25f2021-02-12 23:48:20 +01007219 if( ! mbedtls_test_psa_exercise_key( key, usage_flags, alg ) )
Darryl Green0c6575a2018-11-07 16:05:30 +00007220 goto exit;
Darryl Greend49a4992018-06-18 17:27:26 +01007221
7222exit:
Ronald Cron3a4f0e32020-11-19 17:55:23 +01007223 /*
7224 * Key attributes may have been returned by psa_get_key_attributes()
7225 * thus reset them as required.
7226 */
Gilles Peskinea1ace9c2019-04-26 16:03:33 +02007227 psa_reset_key_attributes( &attributes );
Ronald Cron3a4f0e32020-11-19 17:55:23 +01007228
Darryl Greend49a4992018-06-18 17:27:26 +01007229 mbedtls_free( first_export );
7230 mbedtls_free( second_export );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007231 psa_key_derivation_abort( &operation );
Gilles Peskine5c648ab2019-04-19 14:06:53 +02007232 psa_destroy_key( base_key );
Ronald Cron5425a212020-08-04 14:58:35 +02007233 psa_destroy_key( key );
Gilles Peskine1153e7b2019-05-28 15:10:21 +02007234 PSA_DONE();
Darryl Greend49a4992018-06-18 17:27:26 +01007235}
7236/* END_CASE */