blob: 7f81f6240612af7237f1b616276634eb665e357f [file] [log] [blame]
Steven Cooremandbf8ced2021-03-04 13:01:18 +01001/*
2 * Declaration of context structures for use with the PSA driver wrapper
Steven Cooreman675501d2021-04-26 11:54:58 +02003 * interface. This file contains the context structures for 'primitive'
4 * operations, i.e. those operations which do not rely on other contexts.
Steven Cooremandbf8ced2021-03-04 13:01:18 +01005 *
6 * Warning: This file will be auto-generated in the future.
Ronald Crondd3b5392021-04-01 15:36:50 +02007 *
8 * \note This file may not be included directly. Applications must
9 * include psa/crypto.h.
10 *
Ronald Cron789cef82023-03-27 16:31:19 +020011 * \note This header and its content are not part of the Mbed TLS API and
Ronald Crondd3b5392021-04-01 15:36:50 +020012 * 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
Ronald Cron789cef82023-03-27 16:31:19 +020014 * library. The definitions of these objects are then used by crypto_struct.h
Ronald Crondd3b5392021-04-01 15:36:50 +020015 * to define the implementation-defined types of PSA multi-part state objects.
Steven Cooremandbf8ced2021-03-04 13:01:18 +010016 */
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
Steven Cooreman675501d2021-04-26 11:54:58 +020033#ifndef PSA_CRYPTO_DRIVER_CONTEXTS_PRIMITIVES_H
34#define PSA_CRYPTO_DRIVER_CONTEXTS_PRIMITIVES_H
Steven Cooremandbf8ced2021-03-04 13:01:18 +010035
Steven Cooremandbf8ced2021-03-04 13:01:18 +010036#include "psa/crypto_driver_common.h"
37
Ronald Cron7975fae2021-09-13 14:50:42 +020038/* Include the context structure definitions for the Mbed TLS software drivers */
39#include "psa/crypto_builtin_primitives.h"
40
Steven Cooreman830aff22021-03-09 09:50:44 +010041/* Include the context structure definitions for those drivers that were
42 * declared during the autogeneration process. */
Steven Cooremandbf8ced2021-03-04 13:01:18 +010043
Ronald Cron7975fae2021-09-13 14:50:42 +020044#if defined(MBEDTLS_TEST_LIBTESTDRIVER1)
45#include <libtestdriver1/include/psa/crypto.h>
46#endif
47
48#if defined(PSA_CRYPTO_DRIVER_TEST)
49
50#if defined(MBEDTLS_TEST_LIBTESTDRIVER1) && \
51 defined(LIBTESTDRIVER1_MBEDTLS_PSA_BUILTIN_CIPHER)
52typedef libtestdriver1_mbedtls_psa_cipher_operation_t
Gilles Peskine449bd832023-01-11 14:50:10 +010053 mbedtls_transparent_test_driver_cipher_operation_t;
Ronald Cron7975fae2021-09-13 14:50:42 +020054
55#define MBEDTLS_TRANSPARENT_TEST_DRIVER_CIPHER_OPERATION_INIT \
Gilles Peskine449bd832023-01-11 14:50:10 +010056 LIBTESTDRIVER1_MBEDTLS_PSA_CIPHER_OPERATION_INIT
Ronald Cron7975fae2021-09-13 14:50:42 +020057#else
58typedef mbedtls_psa_cipher_operation_t
Gilles Peskine449bd832023-01-11 14:50:10 +010059 mbedtls_transparent_test_driver_cipher_operation_t;
Ronald Cron7975fae2021-09-13 14:50:42 +020060
61#define MBEDTLS_TRANSPARENT_TEST_DRIVER_CIPHER_OPERATION_INIT \
Gilles Peskine449bd832023-01-11 14:50:10 +010062 MBEDTLS_PSA_CIPHER_OPERATION_INIT
Ronald Cron7975fae2021-09-13 14:50:42 +020063#endif /* MBEDTLS_TEST_LIBTESTDRIVER1 &&
64 LIBTESTDRIVER1_MBEDTLS_PSA_BUILTIN_CIPHER */
65
66#if defined(MBEDTLS_TEST_LIBTESTDRIVER1) && \
67 defined(LIBTESTDRIVER1_MBEDTLS_PSA_BUILTIN_HASH)
68typedef libtestdriver1_mbedtls_psa_hash_operation_t
Gilles Peskine449bd832023-01-11 14:50:10 +010069 mbedtls_transparent_test_driver_hash_operation_t;
Ronald Cron7975fae2021-09-13 14:50:42 +020070
71#define MBEDTLS_TRANSPARENT_TEST_DRIVER_HASH_OPERATION_INIT \
Gilles Peskine449bd832023-01-11 14:50:10 +010072 LIBTESTDRIVER1_MBEDTLS_PSA_HASH_OPERATION_INIT
Ronald Cron7975fae2021-09-13 14:50:42 +020073#else
74typedef mbedtls_psa_hash_operation_t
Gilles Peskine449bd832023-01-11 14:50:10 +010075 mbedtls_transparent_test_driver_hash_operation_t;
Ronald Cron7975fae2021-09-13 14:50:42 +020076
77#define MBEDTLS_TRANSPARENT_TEST_DRIVER_HASH_OPERATION_INIT \
Gilles Peskine449bd832023-01-11 14:50:10 +010078 MBEDTLS_PSA_HASH_OPERATION_INIT
Ronald Cron7975fae2021-09-13 14:50:42 +020079#endif /* MBEDTLS_TEST_LIBTESTDRIVER1 &&
80 LIBTESTDRIVER1_MBEDTLS_PSA_BUILTIN_HASH */
81
82typedef struct {
83 unsigned int initialised : 1;
84 mbedtls_transparent_test_driver_cipher_operation_t ctx;
85} mbedtls_opaque_test_driver_cipher_operation_t;
86
87#define MBEDTLS_OPAQUE_TEST_DRIVER_CIPHER_OPERATION_INIT \
Gilles Peskine449bd832023-01-11 14:50:10 +010088 { 0, MBEDTLS_TRANSPARENT_TEST_DRIVER_CIPHER_OPERATION_INIT }
Ronald Cron7975fae2021-09-13 14:50:42 +020089
90#endif /* PSA_CRYPTO_DRIVER_TEST */
Steven Cooremandbf8ced2021-03-04 13:01:18 +010091
92/* Define the context to be used for an operation that is executed through the
93 * PSA Driver wrapper layer as the union of all possible driver's contexts.
94 *
95 * The union members are the driver's context structures, and the member names
96 * are formatted as `'drivername'_ctx`. This allows for procedural generation
97 * of both this file and the content of psa_crypto_driver_wrappers.c */
98
Steven Cooremanb1777312021-03-04 15:22:38 +010099typedef union {
Ronald Crone31fd112021-04-01 10:47:14 +0200100 unsigned dummy; /* Make sure this union is always non-empty */
Steven Cooremandbf8ced2021-03-04 13:01:18 +0100101 mbedtls_psa_hash_operation_t mbedtls_ctx;
Steven Cooremanf7638102021-03-04 15:14:36 +0100102#if defined(PSA_CRYPTO_DRIVER_TEST)
Steven Cooreman0f8ffa82021-03-15 11:56:33 +0100103 mbedtls_transparent_test_driver_hash_operation_t test_driver_ctx;
Steven Cooremanf7638102021-03-04 15:14:36 +0100104#endif
Steven Cooremanb1777312021-03-04 15:22:38 +0100105} psa_driver_hash_context_t;
Steven Cooremandbf8ced2021-03-04 13:01:18 +0100106
Ronald Cron7cb9c3d2021-03-10 12:21:48 +0100107typedef union {
Ronald Crone31fd112021-04-01 10:47:14 +0200108 unsigned dummy; /* Make sure this union is always non-empty */
Ronald Cron7cb9c3d2021-03-10 12:21:48 +0100109 mbedtls_psa_cipher_operation_t mbedtls_ctx;
110#if defined(PSA_CRYPTO_DRIVER_TEST)
Ronald Cron9198e8c2021-03-17 14:29:56 +0100111 mbedtls_transparent_test_driver_cipher_operation_t transparent_test_driver_ctx;
112 mbedtls_opaque_test_driver_cipher_operation_t opaque_test_driver_ctx;
Ronald Cron7cb9c3d2021-03-10 12:21:48 +0100113#endif
114} psa_driver_cipher_context_t;
115
Steven Cooreman675501d2021-04-26 11:54:58 +0200116#endif /* PSA_CRYPTO_DRIVER_CONTEXTS_PRIMITIVES_H */
Steven Cooremandbf8ced2021-03-04 13:01:18 +0100117/* End of automatically generated file. */