1 /*
2 * Test driver for generating and verifying keys.
3 */
4 /* Copyright The Mbed TLS Contributors
5 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
6 */
7
8 #ifndef PSA_CRYPTO_TEST_DRIVERS_KEY_MANAGEMENT_H
9 #define PSA_CRYPTO_TEST_DRIVERS_KEY_MANAGEMENT_H
10
11 #include "mbedtls/build_info.h"
12
13 #if defined(PSA_CRYPTO_DRIVER_TEST)
14 #include <psa/crypto_driver_common.h>
15
16 #define PSA_CRYPTO_TEST_DRIVER_BUILTIN_AES_KEY_SLOT 0
17 #define PSA_CRYPTO_TEST_DRIVER_BUILTIN_ECDSA_KEY_SLOT 1
18
19 typedef struct {
20 /* If non-null, on success, copy this to the output. */
21 void *forced_output;
22 size_t forced_output_length;
23 /* If not PSA_SUCCESS, return this error code instead of processing the
24 * function call. */
25 psa_status_t forced_status;
26 /* Count the amount of times one of the key management driver functions
27 * is called. */
28 unsigned long hits;
29 /* Subset of hits which only counts public key export operations */
30 unsigned long hits_export_public_key;
31 /* Subset of hits which only counts key generation operations */
32 unsigned long hits_generate_key;
33 /* Location of the last key management driver called to import a key. */
34 psa_key_location_t location;
35 } mbedtls_test_driver_key_management_hooks_t;
36
37 /* The location is initialized to the invalid value 0x800000. Invalid in the
38 * sense that no PSA specification will assign a meaning to this location
39 * (stated first in version 1.0.1 of the specification) and that it is not
40 * used as a location of an opaque test drivers. */
41 #define MBEDTLS_TEST_DRIVER_KEY_MANAGEMENT_INIT { NULL, 0, PSA_SUCCESS, 0, 0, 0, 0x800000 }
42 static inline mbedtls_test_driver_key_management_hooks_t
mbedtls_test_driver_key_management_hooks_init(void)43 mbedtls_test_driver_key_management_hooks_init(void)
44 {
45 const mbedtls_test_driver_key_management_hooks_t
46 v = MBEDTLS_TEST_DRIVER_KEY_MANAGEMENT_INIT;
47 return v;
48 }
49
50 /*
51 * In order to convert the plain text keys to Opaque, the size of the key is
52 * padded up by PSA_CRYPTO_TEST_DRIVER_OPAQUE_PAD_PREFIX_SIZE in addition to
53 * xor mangling the key. The pad prefix needs to be accounted for while
54 * sizing for the key.
55 */
56 #define PSA_CRYPTO_TEST_DRIVER_OPAQUE_PAD_PREFIX 0xBEEFED00U
57 #define PSA_CRYPTO_TEST_DRIVER_OPAQUE_PAD_PREFIX_SIZE sizeof( \
58 PSA_CRYPTO_TEST_DRIVER_OPAQUE_PAD_PREFIX)
59
60 size_t mbedtls_test_opaque_size_function(
61 const psa_key_type_t key_type,
62 const size_t key_bits);
63
64 extern mbedtls_test_driver_key_management_hooks_t
65 mbedtls_test_driver_key_management_hooks;
66
67 psa_status_t mbedtls_test_transparent_init(void);
68 void mbedtls_test_transparent_free(void);
69 psa_status_t mbedtls_test_opaque_init(void);
70 void mbedtls_test_opaque_free(void);
71
72 psa_status_t mbedtls_test_opaque_unwrap_key(
73 const uint8_t *wrapped_key, size_t wrapped_key_length, uint8_t *key_buffer,
74 size_t key_buffer_size, size_t *key_buffer_length);
75
76 psa_status_t mbedtls_test_transparent_generate_key(
77 const psa_key_attributes_t *attributes,
78 uint8_t *key, size_t key_size, size_t *key_length);
79
80 psa_status_t mbedtls_test_opaque_generate_key(
81 const psa_key_attributes_t *attributes,
82 uint8_t *key, size_t key_size, size_t *key_length);
83
84 psa_status_t mbedtls_test_opaque_export_key(
85 const psa_key_attributes_t *attributes,
86 const uint8_t *key, size_t key_length,
87 uint8_t *data, size_t data_size, size_t *data_length);
88
89 psa_status_t mbedtls_test_transparent_export_public_key(
90 const psa_key_attributes_t *attributes,
91 const uint8_t *key, size_t key_length,
92 uint8_t *data, size_t data_size, size_t *data_length);
93
94 psa_status_t mbedtls_test_opaque_export_public_key(
95 const psa_key_attributes_t *attributes,
96 const uint8_t *key, size_t key_length,
97 uint8_t *data, size_t data_size, size_t *data_length);
98
99 psa_status_t mbedtls_test_transparent_import_key(
100 const psa_key_attributes_t *attributes,
101 const uint8_t *data,
102 size_t data_length,
103 uint8_t *key_buffer,
104 size_t key_buffer_size,
105 size_t *key_buffer_length,
106 size_t *bits);
107
108 psa_status_t mbedtls_test_opaque_import_key(
109 const psa_key_attributes_t *attributes,
110 const uint8_t *data,
111 size_t data_length,
112 uint8_t *key_buffer,
113 size_t key_buffer_size,
114 size_t *key_buffer_length,
115 size_t *bits);
116
117 psa_status_t mbedtls_test_opaque_get_builtin_key(
118 psa_drv_slot_number_t slot_number,
119 psa_key_attributes_t *attributes,
120 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length);
121
122 psa_status_t mbedtls_test_opaque_copy_key(
123 psa_key_attributes_t *attributes,
124 const uint8_t *source_key,
125 size_t source_key_length,
126 uint8_t *target_key_buffer,
127 size_t target_key_buffer_size,
128 size_t *target_key_buffer_length);
129
130 #endif /* PSA_CRYPTO_DRIVER_TEST */
131 #endif /* PSA_CRYPTO_TEST_DRIVERS_KEY_MANAGEMENT_H */
132
