From 830aff2a983c8355462c5849bda51be116400b51 Mon Sep 17 00:00:00 2001 From: Steven Cooreman Date: Tue, 9 Mar 2021 09:50:44 +0100 Subject: [PATCH] Restructure the way driver contexts are declared Drivers (both built-in and external) need to declare their context structures in a way such that they are accessible by the to-be-autogenerated crypto_driver_contexts.h file. That file lives in include/psa, which means all builtin driver context structure declarations also need to live in include/psa. Signed-off-by: Steven Cooreman --- include/psa/crypto_builtin_hash.h | 91 +++++++++++++++++++ .../psa/crypto_driver_contexts.h | 17 ++-- include/psa/crypto_struct.h | 2 +- library/psa_crypto_driver_wrappers.c | 6 +- library/psa_crypto_hash.h | 55 +---------- visualc/VS2010/mbedTLS.vcxproj | 3 +- 6 files changed, 106 insertions(+), 68 deletions(-) create mode 100644 include/psa/crypto_builtin_hash.h rename library/psa_crypto_driver_wrappers_contexts.h => include/psa/crypto_driver_contexts.h (76%) diff --git a/include/psa/crypto_builtin_hash.h b/include/psa/crypto_builtin_hash.h new file mode 100644 index 000000000..0f42fdcb2 --- /dev/null +++ b/include/psa/crypto_builtin_hash.h @@ -0,0 +1,91 @@ +/* + * Context structure declaration of the software-based driver which performs + * hashing through the PSA Crypto driver dispatch layer. + */ +/* + * Copyright The Mbed TLS Contributors + * SPDX-License-Identifier: Apache-2.0 + * + * Licensed under the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +#ifndef PSA_CRYPTO_BUILTIN_HASH_H +#define PSA_CRYPTO_BUILTIN_HASH_H + +#include +#include "mbedtls/md2.h" +#include "mbedtls/md4.h" +#include "mbedtls/md5.h" +#include "mbedtls/ripemd160.h" +#include "mbedtls/sha1.h" +#include "mbedtls/sha256.h" +#include "mbedtls/sha512.h" + +#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2) || \ + defined(MBEDTLS_PSA_BUILTIN_ALG_MD4) || \ + defined(MBEDTLS_PSA_BUILTIN_ALG_MD5) || \ + defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160) || \ + defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1) || \ + defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224) || \ + defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256) || \ + defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384) || \ + defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512) +#define MBEDTLS_PSA_BUILTIN_HASH +#endif + +typedef struct +{ + psa_algorithm_t alg; + union + { + unsigned dummy; /* Make the union non-empty even with no supported algorithms. */ +#if defined(MBEDTLS_MD2_C) + mbedtls_md2_context md2; +#endif +#if defined(MBEDTLS_MD4_C) + mbedtls_md4_context md4; +#endif +#if defined(MBEDTLS_MD5_C) + mbedtls_md5_context md5; +#endif +#if defined(MBEDTLS_RIPEMD160_C) + mbedtls_ripemd160_context ripemd160; +#endif +#if defined(MBEDTLS_SHA1_C) + mbedtls_sha1_context sha1; +#endif +#if defined(MBEDTLS_SHA256_C) + mbedtls_sha256_context sha256; +#endif +#if defined(MBEDTLS_SHA512_C) + mbedtls_sha512_context sha512; +#endif + } ctx; +} mbedtls_psa_hash_operation_t; + +#define MBEDTLS_PSA_HASH_OPERATION_INIT {0, {0}} + +/* + * BEYOND THIS POINT, TEST DRIVER DECLARATIONS ONLY. + */ +#if defined(PSA_CRYPTO_DRIVER_TEST) + +typedef struct { + mbedtls_psa_hash_operation_t operation; +} mbedtls_transparent_test_driver_hash_operation_t; + +#define MBEDTLS_TRANSPARENT_TEST_DRIVER_HASH_OPERATION_INIT { MBEDTLS_PSA_HASH_OPERATION_INIT } + +#endif /* PSA_CRYPTO_DRIVER_TEST */ + +#endif /* PSA_CRYPTO_BUILTIN_HASH_H */ diff --git a/library/psa_crypto_driver_wrappers_contexts.h b/include/psa/crypto_driver_contexts.h similarity index 76% rename from library/psa_crypto_driver_wrappers_contexts.h rename to include/psa/crypto_driver_contexts.h index 8db55c937..524329dd0 100644 --- a/library/psa_crypto_driver_wrappers_contexts.h +++ b/include/psa/crypto_driver_contexts.h @@ -20,20 +20,17 @@ * limitations under the License. */ -#ifndef PSA_CRYPTO_DRIVER_WRAPPERS_CONTEXTS_H -#define PSA_CRYPTO_DRIVER_WRAPPERS_CONTEXTS_H +#ifndef PSA_CRYPTO_DRIVER_CONTEXTS_H +#define PSA_CRYPTO_DRIVER_CONTEXTS_H #include "psa/crypto.h" #include "psa/crypto_driver_common.h" -/* Include all structure definitions for the drivers that have been included - * during the auto-generation of this file (autogeneration not yet in place) */ -#if defined(PSA_CRYPTO_DRIVER_TEST) -#include "test/drivers/test_driver.h" -#endif +/* Include the context structure definitions for those drivers that were + * declared during the autogeneration process. */ -/* Include the structure definitions for the mbed TLS software drivers */ -#include "psa_crypto_hash.h" +/* Include the context structure definitions for the Mbed TLS software drivers */ +#include "psa/crypto_builtin_hash.h" /* Define the context to be used for an operation that is executed through the * PSA Driver wrapper layer as the union of all possible driver's contexts. @@ -50,5 +47,5 @@ typedef union { #endif } psa_driver_hash_context_t; -#endif /* PSA_CRYPTO_DRIVER_WRAPPERS_CONTEXTS_H */ +#endif /* PSA_CRYPTO_DRIVER_CONTEXTS_H */ /* End of automatically generated file. */ diff --git a/include/psa/crypto_struct.h b/include/psa/crypto_struct.h index f22ed50c6..87eefb9b1 100644 --- a/include/psa/crypto_struct.h +++ b/include/psa/crypto_struct.h @@ -70,7 +70,7 @@ extern "C" { #include "mbedtls/gcm.h" /* Include the context definition for the compiled-in drivers */ -#include "../../library/psa_crypto_driver_wrappers_contexts.h" +#include "psa/crypto_driver_contexts.h" typedef struct { /** Unique ID indicating which driver got assigned to do the diff --git a/library/psa_crypto_driver_wrappers.c b/library/psa_crypto_driver_wrappers.c index 97e4ee869..457738f24 100644 --- a/library/psa_crypto_driver_wrappers.c +++ b/library/psa_crypto_driver_wrappers.c @@ -21,6 +21,8 @@ #include "psa_crypto_core.h" #include "psa_crypto_driver_wrappers.h" +#include "psa_crypto_hash.h" + #include "mbedtls/platform.h" #if defined(MBEDTLS_PSA_CRYPTO_DRIVERS) @@ -41,14 +43,14 @@ /* Auto-generated values depending on which drivers are registered. * ID 0 is reserved for unallocated operations. * ID 1 is reserved for the Mbed TLS software driver. */ +#define PSA_CRYPTO_MBED_TLS_DRIVER_ID (1) + #if defined(PSA_CRYPTO_DRIVER_TEST) #define PSA_CRYPTO_TRANSPARENT_TEST_DRIVER_ID (2) #define PSA_CRYPTO_OPAQUE_TEST_DRIVER_ID (3) #endif /* PSA_CRYPTO_DRIVER_TEST */ #endif /* MBEDTLS_PSA_CRYPTO_DRIVERS */ -#define PSA_CRYPTO_MBED_TLS_DRIVER_ID (1) - /* Support the 'old' SE interface when asked to */ #if defined(MBEDTLS_PSA_CRYPTO_SE_C) /* PSA_CRYPTO_DRIVER_PRESENT is defined when either a new-style or old-style diff --git a/library/psa_crypto_hash.h b/library/psa_crypto_hash.h index 7d52624a0..443110eae 100644 --- a/library/psa_crypto_hash.h +++ b/library/psa_crypto_hash.h @@ -22,57 +22,7 @@ #define PSA_CRYPTO_HASH_H #include -#include "mbedtls/md2.h" -#include "mbedtls/md4.h" -#include "mbedtls/md5.h" -#include "mbedtls/ripemd160.h" -#include "mbedtls/sha1.h" -#include "mbedtls/sha256.h" -#include "mbedtls/sha512.h" - -#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2) || \ - defined(MBEDTLS_PSA_BUILTIN_ALG_MD4) || \ - defined(MBEDTLS_PSA_BUILTIN_ALG_MD5) || \ - defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160) || \ - defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1) || \ - defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224) || \ - defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256) || \ - defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384) || \ - defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512) -#define MBEDTLS_PSA_BUILTIN_HASH -#endif - -typedef struct -{ - psa_algorithm_t alg; - union - { - unsigned dummy; /* Make the union non-empty even with no supported algorithms. */ -#if defined(MBEDTLS_MD2_C) - mbedtls_md2_context md2; -#endif -#if defined(MBEDTLS_MD4_C) - mbedtls_md4_context md4; -#endif -#if defined(MBEDTLS_MD5_C) - mbedtls_md5_context md5; -#endif -#if defined(MBEDTLS_RIPEMD160_C) - mbedtls_ripemd160_context ripemd160; -#endif -#if defined(MBEDTLS_SHA1_C) - mbedtls_sha1_context sha1; -#endif -#if defined(MBEDTLS_SHA256_C) - mbedtls_sha256_context sha256; -#endif -#if defined(MBEDTLS_SHA512_C) - mbedtls_sha512_context sha512; -#endif - } ctx; -} mbedtls_psa_hash_operation_t; - -#define MBEDTLS_PSA_HASH_OPERATION_INIT {0, {0}} +#include /** Calculate the hash (digest) of a message using Mbed TLS routines. * @@ -276,9 +226,6 @@ psa_status_t mbedtls_psa_hash_abort( */ #if defined(PSA_CRYPTO_DRIVER_TEST) -typedef struct { - mbedtls_psa_hash_operation_t operation; -} mbedtls_transparent_test_driver_hash_operation_t; psa_status_t mbedtls_transparent_test_driver_hash_compute( psa_algorithm_t alg, diff --git a/visualc/VS2010/mbedTLS.vcxproj b/visualc/VS2010/mbedTLS.vcxproj index c4ec8b674..7a013443f 100644 --- a/visualc/VS2010/mbedTLS.vcxproj +++ b/visualc/VS2010/mbedTLS.vcxproj @@ -222,9 +222,11 @@ + + @@ -250,7 +252,6 @@ -