MCUX CLNS
MCUX Crypto Library Normal Secure
crypto_driver_contexts_primitives.h
1 /*
2  * Declaration of context structures for use with the PSA driver wrapper
3  * interface. This file contains the context structures for 'primitive'
4  * operations, i.e. those operations which do not rely on other contexts.
5  *
6  * Warning: This file will be auto-generated in the future.
7  *
8  * \note This file may not be included directly. Applications must
9  * include psa/crypto.h.
10  *
11  * \note This header and its content is not part of the Mbed TLS API and
12  * applications must not depend on it. Its main purpose is to define the
13  * multi-part state objects of the PSA drivers included in the cryptographic
14  * library. The definition of these objects are then used by crypto_struct.h
15  * to define the implementation-defined types of PSA multi-part state objects.
16  */
17 /* Copyright The Mbed TLS Contributors
18  * SPDX-License-Identifier: Apache-2.0
19  *
20  * Licensed under the Apache License, Version 2.0 (the "License"); you may
21  * not use this file except in compliance with the License.
22  * You may obtain a copy of the License at
23  *
24  * http://www.apache.org/licenses/LICENSE-2.0
25  *
26  * Unless required by applicable law or agreed to in writing, software
27  * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
28  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
29  * See the License for the specific language governing permissions and
30  * limitations under the License.
31  */
32 
33 #ifndef PSA_CRYPTO_DRIVER_CONTEXTS_PRIMITIVES_H
34 #define PSA_CRYPTO_DRIVER_CONTEXTS_PRIMITIVES_H
35 
36 #include "crypto_driver_common.h"
37 
38 /* Include the context structure definitions for the Mbed TLS software drivers */
39 #include "crypto_builtin_primitives.h"
40 
41 /* Include CLNS header files */
42 #include <mcuxClPsaDriver_MemoryConsumption.h>
43 #include <mcuxClKey.h>
44 #include <mcuxClCipher.h>
45 #include <mcuxClCipherModes.h>
46 #include <mcuxClHash.h>
47 
48 
49 /* Include the context structure definitions for those drivers that were
50  * declared during the autogeneration process. */
51 
52 #if defined(MBEDTLS_TEST_LIBTESTDRIVER1)
53 #include <libtestdriver1/include/psa/crypto.h>
54 #endif
55 
56 #if defined(PSA_CRYPTO_DRIVER_TEST)
57 
58 #if defined(MBEDTLS_TEST_LIBTESTDRIVER1) && \
59  defined(LIBTESTDRIVER1_MBEDTLS_PSA_BUILTIN_CIPHER)
60 typedef libtestdriver1_mbedtls_psa_cipher_operation_t
61  mbedtls_transparent_test_driver_cipher_operation_t;
62 
63 #define MBEDTLS_TRANSPARENT_TEST_DRIVER_CIPHER_OPERATION_INIT \
64  LIBTESTDRIVER1_MBEDTLS_PSA_CIPHER_OPERATION_INIT
65 #else
66 typedef mbedtls_psa_cipher_operation_t
67  mbedtls_transparent_test_driver_cipher_operation_t;
68 
69 #define MBEDTLS_TRANSPARENT_TEST_DRIVER_CIPHER_OPERATION_INIT \
70  MBEDTLS_PSA_CIPHER_OPERATION_INIT
71 #endif /* MBEDTLS_TEST_LIBTESTDRIVER1 &&
72  LIBTESTDRIVER1_MBEDTLS_PSA_BUILTIN_CIPHER */
73 
74 #if defined(MBEDTLS_TEST_LIBTESTDRIVER1) && \
75  defined(LIBTESTDRIVER1_MBEDTLS_PSA_BUILTIN_HASH)
76 typedef libtestdriver1_mbedtls_psa_hash_operation_t
77  mbedtls_transparent_test_driver_hash_operation_t;
78 
79 #define MBEDTLS_TRANSPARENT_TEST_DRIVER_HASH_OPERATION_INIT \
80  LIBTESTDRIVER1_MBEDTLS_PSA_HASH_OPERATION_INIT
81 #else
82 typedef mbedtls_psa_hash_operation_t
83  mbedtls_transparent_test_driver_hash_operation_t;
84 
85 #define MBEDTLS_TRANSPARENT_TEST_DRIVER_HASH_OPERATION_INIT \
86  MBEDTLS_PSA_HASH_OPERATION_INIT
87 #endif /* MBEDTLS_TEST_LIBTESTDRIVER1 &&
88  LIBTESTDRIVER1_MBEDTLS_PSA_BUILTIN_HASH */
89 
90 typedef struct {
91  unsigned int initialised : 1;
92  mbedtls_transparent_test_driver_cipher_operation_t ctx;
93 } mbedtls_opaque_test_driver_cipher_operation_t;
94 
95 #define MBEDTLS_OPAQUE_TEST_DRIVER_CIPHER_OPERATION_INIT \
96  { 0, MBEDTLS_TRANSPARENT_TEST_DRIVER_CIPHER_OPERATION_INIT }
97 
98 #endif /* PSA_CRYPTO_DRIVER_TEST */
99 
100 /* Define the context to be used for an operation that is executed through the
101  * PSA Driver wrapper layer as the union of all possible driver's contexts.
102  *
103  * The union members are the driver's context structures, and the member names
104  * are formatted as `'drivername'_ctx`. This allows for procedural generation
105  * of both this file and the content of psa_crypto_driver_wrappers.c */
106 
107 typedef union {
108  unsigned dummy; /* Make sure this union is always non-empty */
109  mbedtls_psa_hash_operation_t mbedtls_ctx;
110 
111 #if defined(PSA_CRYPTO_DRIVER_TEST)
112  mbedtls_transparent_test_driver_hash_operation_t test_driver_ctx;
113 #endif
114 
115  uint8_t clns_data[MCUXCLPSADRIVER_CLNSDATA_HASH_SIZE];
117 
118 typedef union {
119  unsigned dummy; /* Make sure this union is always non-empty */
120  mbedtls_psa_cipher_operation_t mbedtls_ctx;
121 
122  uint8_t clns_data[MCUXCLPSADRIVER_CLNSDATA_CIPHER_SIZE];
123 
124 #if defined(PSA_CRYPTO_DRIVER_TEST)
125  mbedtls_transparent_test_driver_cipher_operation_t transparent_test_driver_ctx;
126  mbedtls_opaque_test_driver_cipher_operation_t opaque_test_driver_ctx;
127 #endif
128 
130 
131 #endif /* PSA_CRYPTO_DRIVER_CONTEXTS_PRIMITIVES_H */
132 /* End of automatically generated file. */
Definition: crypto_driver_contexts_primitives.h:118
Top-level include file for the mcuxClCipher component.
Top-level include file for the mcuxClHash component.
Definition: crypto_driver_contexts_primitives.h:107
Top-level include file for the mcuxClKey component.