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 need to 5 * rely on other algorithms, i.e. are 'composite' 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_COMPOSITES_H 34 #define PSA_CRYPTO_BUILTIN_COMPOSITES_H 35 #include "mbedtls/private_access.h" 36 37 #include <psa/crypto_driver_common.h> 38 39 /* 40 * MAC multi-part operation definitions. 41 */ 42 #if defined(MBEDTLS_PSA_BUILTIN_ALG_CMAC) || \ 43 defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC) 44 #define MBEDTLS_PSA_BUILTIN_MAC 45 #endif 46 47 #if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC) || defined(PSA_CRYPTO_DRIVER_TEST) 48 typedef struct 49 { 50 /** The HMAC algorithm in use */ 51 psa_algorithm_t MBEDTLS_PRIVATE(alg); 52 /** The hash context. */ 53 struct psa_hash_operation_s hash_ctx; 54 /** The HMAC part of the context. */ 55 uint8_t MBEDTLS_PRIVATE(opad)[PSA_HMAC_MAX_HASH_BLOCK_SIZE]; 56 } mbedtls_psa_hmac_operation_t; 57 58 #define MBEDTLS_PSA_HMAC_OPERATION_INIT {0, PSA_HASH_OPERATION_INIT, {0}} 59 #endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */ 60 61 #include "mbedtls/cmac.h" 62 63 typedef struct 64 { 65 psa_algorithm_t MBEDTLS_PRIVATE(alg); 66 union 67 { 68 unsigned MBEDTLS_PRIVATE(dummy); /* Make the union non-empty even with no supported algorithms. */ 69 #if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC) || defined(PSA_CRYPTO_DRIVER_TEST) 70 mbedtls_psa_hmac_operation_t MBEDTLS_PRIVATE(hmac); 71 #endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */ 72 #if defined(MBEDTLS_PSA_BUILTIN_ALG_CMAC) || defined(PSA_CRYPTO_DRIVER_TEST) 73 mbedtls_cipher_context_t MBEDTLS_PRIVATE(cmac); 74 #endif /* MBEDTLS_PSA_BUILTIN_ALG_CMAC */ 75 } MBEDTLS_PRIVATE(ctx); 76 } mbedtls_psa_mac_operation_t; 77 78 #define MBEDTLS_PSA_MAC_OPERATION_INIT {0, {0}} 79 80 #if defined(MBEDTLS_PSA_BUILTIN_ALG_GCM) || \ 81 defined(MBEDTLS_PSA_BUILTIN_ALG_CCM) || \ 82 defined(MBEDTLS_PSA_BUILTIN_ALG_CHACHA20_POLY1305) 83 #define MBEDTLS_PSA_BUILTIN_AEAD 1 84 #endif 85 86 /* Context structure for the Mbed TLS AEAD implementation. */ 87 typedef struct 88 { 89 psa_algorithm_t MBEDTLS_PRIVATE(alg); 90 psa_key_type_t MBEDTLS_PRIVATE(key_type); 91 92 unsigned int MBEDTLS_PRIVATE(is_encrypt) : 1; 93 94 uint8_t MBEDTLS_PRIVATE(tag_length); 95 96 union 97 { 98 unsigned dummy; /* Enable easier initializing of the union. */ 99 #if defined(MBEDTLS_PSA_BUILTIN_ALG_CCM) 100 mbedtls_ccm_context MBEDTLS_PRIVATE(ccm); 101 #endif /* MBEDTLS_PSA_BUILTIN_ALG_CCM */ 102 #if defined(MBEDTLS_PSA_BUILTIN_ALG_GCM) 103 mbedtls_gcm_context MBEDTLS_PRIVATE(gcm); 104 #endif /* MBEDTLS_PSA_BUILTIN_ALG_GCM */ 105 #if defined(MBEDTLS_PSA_BUILTIN_ALG_CHACHA20_POLY1305) 106 mbedtls_chachapoly_context MBEDTLS_PRIVATE(chachapoly); 107 #endif /* MBEDTLS_PSA_BUILTIN_ALG_CHACHA20_POLY1305 */ 108 109 } ctx; 110 111 } mbedtls_psa_aead_operation_t; 112 113 #define MBEDTLS_PSA_AEAD_OPERATION_INIT {0, 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_mac_operation_t mbedtls_transparent_test_driver_mac_operation_t; 121 typedef mbedtls_psa_mac_operation_t mbedtls_opaque_test_driver_mac_operation_t; 122 123 #define MBEDTLS_TRANSPARENT_TEST_DRIVER_MAC_OPERATION_INIT MBEDTLS_PSA_MAC_OPERATION_INIT 124 #define MBEDTLS_OPAQUE_TEST_DRIVER_MAC_OPERATION_INIT MBEDTLS_PSA_MAC_OPERATION_INIT 125 126 typedef mbedtls_psa_aead_operation_t mbedtls_transparent_test_driver_aead_operation_t; 127 128 #define MBEDTLS_TRANSPARENT_TEST_DRIVER_AEAD_OPERATION_INIT MBEDTLS_PSA_AEAD_OPERATION_INIT 129 130 #endif /* PSA_CRYPTO_DRIVER_TEST */ 131 132 #endif /* PSA_CRYPTO_BUILTIN_COMPOSITES_H */ 133