1 /*
2  *  Context structure declaration of the Mbed TLS software-based PSA drivers
3  *  called through the PSA Crypto driver dispatch layer.
4  *  This file contains the context structures of those algorithms which do not
5  *  rely on other algorithms, i.e. are 'primitive' algorithms.
6  *
7  * \note This file may not be included directly. Applications must
8  * include psa/crypto.h.
9  *
10  * \note This header and its content is not part of the Mbed TLS API and
11  * applications must not depend on it. Its main purpose is to define the
12  * multi-part state objects of the Mbed TLS software-based PSA drivers. The
13  * definition of these objects are then used by crypto_struct.h to define the
14  * implementation-defined types of PSA multi-part state objects.
15  */
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_BUILTIN_PRIMITIVES_H
34 #define PSA_CRYPTO_BUILTIN_PRIMITIVES_H
35 #include "mbedtls/private_access.h"
36 
37 #include <psa/crypto_driver_common.h>
38 
39 /*
40  * Hash multi-part operation definitions.
41  */
42 
43 #include "mbedtls/md5.h"
44 #include "mbedtls/ripemd160.h"
45 #include "mbedtls/sha1.h"
46 #include "mbedtls/sha256.h"
47 #include "mbedtls/sha512.h"
48 
49 #if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5) || \
50     defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160) || \
51     defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1) || \
52     defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224) || \
53     defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256) || \
54     defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384) || \
55     defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
56 #define MBEDTLS_PSA_BUILTIN_HASH
57 #endif
58 
59 typedef struct
60 {
61     psa_algorithm_t MBEDTLS_PRIVATE(alg);
62     union
63     {
64         unsigned MBEDTLS_PRIVATE(dummy); /* Make the union non-empty even with no supported algorithms. */
65 #if defined(MBEDTLS_MD5_C)
66         mbedtls_md5_context MBEDTLS_PRIVATE(md5);
67 #endif
68 #if defined(MBEDTLS_RIPEMD160_C)
69         mbedtls_ripemd160_context MBEDTLS_PRIVATE(ripemd160);
70 #endif
71 #if defined(MBEDTLS_SHA1_C)
72         mbedtls_sha1_context MBEDTLS_PRIVATE(sha1);
73 #endif
74 #if defined(MBEDTLS_SHA256_C)
75         mbedtls_sha256_context MBEDTLS_PRIVATE(sha256);
76 #endif
77 #if defined(MBEDTLS_SHA512_C)
78         mbedtls_sha512_context MBEDTLS_PRIVATE(sha512);
79 #endif
80     } MBEDTLS_PRIVATE(ctx);
81 } mbedtls_psa_hash_operation_t;
82 
83 #define MBEDTLS_PSA_HASH_OPERATION_INIT {0, {0}}
84 
85 /*
86  * Cipher multi-part operation definitions.
87  */
88 
89 #include "mbedtls/cipher.h"
90 
91 #if defined(MBEDTLS_PSA_BUILTIN_ALG_STREAM_CIPHER) || \
92     defined(MBEDTLS_PSA_BUILTIN_ALG_CTR) || \
93     defined(MBEDTLS_PSA_BUILTIN_ALG_CFB) || \
94     defined(MBEDTLS_PSA_BUILTIN_ALG_OFB) || \
95     defined(MBEDTLS_PSA_BUILTIN_ALG_XTS) || \
96     defined(MBEDTLS_PSA_BUILTIN_ALG_ECB_NO_PADDING) || \
97     defined(MBEDTLS_PSA_BUILTIN_ALG_CBC_NO_PADDING) || \
98     defined(MBEDTLS_PSA_BUILTIN_ALG_CBC_PKCS7)
99 #define MBEDTLS_PSA_BUILTIN_CIPHER  1
100 #endif
101 
102 typedef struct {
103     /* Context structure for the Mbed TLS cipher implementation. */
104     psa_algorithm_t MBEDTLS_PRIVATE(alg);
105     uint8_t MBEDTLS_PRIVATE(iv_length);
106     uint8_t MBEDTLS_PRIVATE(block_length);
107     union {
108         unsigned int MBEDTLS_PRIVATE(dummy);
109         mbedtls_cipher_context_t MBEDTLS_PRIVATE(cipher);
110     } MBEDTLS_PRIVATE(ctx);
111 } mbedtls_psa_cipher_operation_t;
112 
113 #define MBEDTLS_PSA_CIPHER_OPERATION_INIT {0, 0, 0, {0}}
114 
115 /*
116  * BEYOND THIS POINT, TEST DRIVER DECLARATIONS ONLY.
117  */
118 #if defined(PSA_CRYPTO_DRIVER_TEST)
119 
120 typedef mbedtls_psa_hash_operation_t mbedtls_transparent_test_driver_hash_operation_t;
121 
122 #define MBEDTLS_TRANSPARENT_TEST_DRIVER_HASH_OPERATION_INIT MBEDTLS_PSA_HASH_OPERATION_INIT
123 
124 typedef mbedtls_psa_cipher_operation_t
125         mbedtls_transparent_test_driver_cipher_operation_t;
126 
127 typedef struct {
128     unsigned int initialised : 1;
129     mbedtls_transparent_test_driver_cipher_operation_t ctx;
130 } mbedtls_opaque_test_driver_cipher_operation_t;
131 
132 #define MBEDTLS_TRANSPARENT_TEST_DRIVER_CIPHER_OPERATION_INIT \
133      MBEDTLS_PSA_CIPHER_OPERATION_INIT
134 
135 #define MBEDTLS_OPAQUE_TEST_DRIVER_CIPHER_OPERATION_INIT \
136      { 0, MBEDTLS_TRANSPARENT_TEST_DRIVER_CIPHER_OPERATION_INIT }
137 
138 #endif /* PSA_CRYPTO_DRIVER_TEST */
139 
140 #endif /* PSA_CRYPTO_BUILTIN_PRIMITIVES_H */
141