mbed TLS v3.1.0
crypto_builtin_primitives.h
Go to the documentation of this file.
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 "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 {
62  union
63  {
64  unsigned dummy; /* Make the union non-empty even with no supported algorithms. */
65 #if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
66  mbedtls_md5_context md5;
67 #endif
68 #if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
69  mbedtls_ripemd160_context ripemd160;
70 #endif
71 #if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
72  mbedtls_sha1_context sha1;
73 #endif
74 #if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256) || \
75  defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
76  mbedtls_sha256_context sha256;
77 #endif
78 #if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512) || \
79  defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
80  mbedtls_sha512_context sha512;
81 #endif
82  } MBEDTLS_PRIVATE(ctx);
84 
85 #define MBEDTLS_PSA_HASH_OPERATION_INIT {0, {0}}
86 
87 /*
88  * Cipher multi-part operation definitions.
89  */
90 
91 #include "mbedtls/cipher.h"
92 
93 #if defined(MBEDTLS_PSA_BUILTIN_ALG_STREAM_CIPHER) || \
94  defined(MBEDTLS_PSA_BUILTIN_ALG_CTR) || \
95  defined(MBEDTLS_PSA_BUILTIN_ALG_CFB) || \
96  defined(MBEDTLS_PSA_BUILTIN_ALG_OFB) || \
97  defined(MBEDTLS_PSA_BUILTIN_ALG_XTS) || \
98  defined(MBEDTLS_PSA_BUILTIN_ALG_ECB_NO_PADDING) || \
99  defined(MBEDTLS_PSA_BUILTIN_ALG_CBC_NO_PADDING) || \
100  defined(MBEDTLS_PSA_BUILTIN_ALG_CBC_PKCS7)
101 #define MBEDTLS_PSA_BUILTIN_CIPHER 1
102 #endif
103 
104 typedef struct {
105  /* Context structure for the Mbed TLS cipher implementation. */
107  uint8_t MBEDTLS_PRIVATE(iv_length);
108  uint8_t MBEDTLS_PRIVATE(block_length);
109  union {
110  unsigned int MBEDTLS_PRIVATE(dummy);
112  } MBEDTLS_PRIVATE(ctx);
114 
115 #define MBEDTLS_PSA_CIPHER_OPERATION_INIT {0, 0, 0, {0}}
116 
117 #endif /* PSA_CRYPTO_BUILTIN_PRIMITIVES_H */
#define MBEDTLS_PRIVATE(member)
RIPE MD-160 message digest.
uint32_t psa_algorithm_t
Encoding of a cryptographic algorithm.
Definition: crypto_types.h:106
Macro wrapper for struct's memebrs.
This file contains an abstraction interface for use with the cipher primitives provided by the librar...
mbedtls_ripemd160_context ripemd160
This file contains SHA-1 definitions and functions.
Definitions for all PSA crypto drivers.
This file contains SHA-384 and SHA-512 definitions and functions.
MD5 message digest algorithm (hash function)
This file contains SHA-224 and SHA-256 definitions and functions.