Merge pull request Mbed-TLS#16 from ronald-cron-arm/configs-and-tests

Add two new configurations options and tests

Author: daverodgman

CMakeLists.txt

@@ -52,6 +52,18 @@ endif()
 # Set the project root directory.
 set(PSA_CRYPTO_DIR ${CMAKE_CURRENT_SOURCE_DIR})
 
+# Set-up configuration file
+set(PSA_CRYPTO_CONFIG_FILE include/psa/crypto_config.h CACHE STRING
+    "PSA-Crypto configuration file, absolute path or path relative to the root directory")
+get_filename_component(PSA_CRYPTO_CONFIG_FILE_REALPATH
+                       ${PSA_CRYPTO_CONFIG_FILE} REALPATH BASE_DIR ${PSA_CRYPTO_DIR})
+configure_file(${PSA_CRYPTO_CONFIG_FILE_REALPATH}
+               ${CMAKE_CURRENT_BINARY_DIR}/include/psa/crypto_config.h
+               COPYONLY)
+install(FILES ${CMAKE_CURRENT_BINARY_DIR}/include/psa/crypto_config.h
+        DESTINATION include/psa
+        PERMISSIONS OWNER_READ OWNER_WRITE GROUP_READ WORLD_READ)
+
 option(ENABLE_PROGRAMS "Build PSA cryptography example programs." ON)
 
 option(PSA_CRYPTO_FATAL_WARNINGS "Compiler warnings treated as errors" ON)
@@ -221,6 +233,7 @@ if(ENABLE_TESTING OR ENABLE_PROGRAMS)
     file(GLOB PSA_CRYPTO_TEST_FILES ${CMAKE_CURRENT_SOURCE_DIR}/tests/src/*.c ${CMAKE_CURRENT_SOURCE_DIR}/tests/src/drivers/*.c)
     add_library(psa_crypto_test OBJECT ${PSA_CRYPTO_TEST_FILES})
     target_include_directories(psa_crypto_test
+        PRIVATE ${CMAKE_BINARY_DIR}/include
         PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/include
         PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/drivers/builtin/include
         PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/drivers/builtin/src

configs/ccm-aes-sha256-secp256r1.h

@@ -35,6 +35,7 @@
 //#define PSA_CRYPTO_STD_FUNCTIONS
 #define PSA_CRYPTO_FS_IO
 #define PSA_CRYPTO_MEMORY_BUFFER_ALLOC
+//#define PSA_CRYPTO_PLATFORM_ZEROIZE
 
 /** \} name SECTION: General configuration options */
 
@@ -84,6 +85,7 @@
 //#define PSA_CRYPTO_HMAC_DRBG_HASH PSA_ALG_SHA_256
 //#define PSA_CRYPTO_KEY_SLOT_COUNT 32
 //#define PSA_CRYPTO_PLATFORM_ENTROPY
+//#define PSA_CRYPTO_HARDWARE_ENTROPY
 #define PSA_CRYPTO_ENTROPY_NV_SEED
 #define PSA_CRYPTO_ENTROPY_NV_SEED_FILE "seedfile"
 

configs/ccm-aes-sha256.h

@@ -34,6 +34,7 @@
 //#define PSA_CRYPTO_STD_FUNCTIONS
 #define PSA_CRYPTO_FS_IO
 #define PSA_CRYPTO_MEMORY_BUFFER_ALLOC
+//#define PSA_CRYPTO_PLATFORM_ZEROIZE
 
 /** \} name SECTION: General configuration options */
 
@@ -75,6 +76,7 @@
 //#define PSA_CRYPTO_HMAC_DRBG_HASH PSA_ALG_SHA_256
 //#define PSA_CRYPTO_KEY_SLOT_COUNT 32
 //#define PSA_CRYPTO_PLATFORM_ENTROPY
+//#define PSA_CRYPTO_HARDWARE_ENTROPY
 #define PSA_CRYPTO_ENTROPY_NV_SEED
 //#define PSA_CRYPTO_ENTROPY_NV_SEED_FILE "seedfile"
 

configs/gcm-ccm-cbc-aes-sha256_512-secp256_384r1-rsa.h

@@ -36,6 +36,7 @@
 //#define PSA_CRYPTO_STD_FUNCTIONS
 #define PSA_CRYPTO_FS_IO
 #define PSA_CRYPTO_MEMORY_BUFFER_ALLOC
+//#define PSA_CRYPTO_PLATFORM_ZEROIZE
 
 /** \} name SECTION: General configuration options */
 
@@ -95,6 +96,7 @@
 //#define PSA_CRYPTO_HMAC_DRBG_HASH PSA_ALG_SHA_256
 //#define PSA_CRYPTO_KEY_SLOT_COUNT 32
 //#define PSA_CRYPTO_PLATFORM_ENTROPY
+//#define PSA_CRYPTO_HARDWARE_ENTROPY
 #define PSA_CRYPTO_ENTROPY_NV_SEED
 #define PSA_CRYPTO_ENTROPY_NV_SEED_FILE "seedfile"
 

core/CMakeLists.txt

@@ -83,6 +83,8 @@ endif(USE_SHARED_PSA_CRYPTO_LIBRARY)
 foreach(target IN LISTS target_libraries)
     add_library(PSACrypto::${target} ALIAS ${target})  # add_subdirectory support
     target_include_directories(${target}
+        PUBLIC $<BUILD_INTERFACE:${CMAKE_BINARY_DIR}/include/>
+               $<INSTALL_INTERFACE:include/>
         PUBLIC $<BUILD_INTERFACE:${PSA_CRYPTO_DIR}/include/>
                $<INSTALL_INTERFACE:include/>
         PUBLIC $<BUILD_INTERFACE:${PSA_CRYPTO_DIR}/drivers/builtin/include/>

drivers/builtin/config_psa_ext.h

@@ -0,0 +1,153 @@
+/**
+ * \file config_psa_ext.h
+ * \brief PSA crypto configurations to Mbed TLS configurations extension
+ *
+ *  Extension of the translation of the PSA crypto configurations to the Mbed
+ *  TLS ones handling the PSA-Crypto specific configuration options.
+ */
+/*
+ *  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.
+ */
+
+#if defined(PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
+#define MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
+#endif
+
+#if defined(PSA_CRYPTO_SPM)
+#define MBEDTLS_PSA_CRYPTO_SPM
+#endif
+
+#if !defined(PSA_CRYPTO_STD_FUNCTIONS)
+#include <psa/platform.h>
+#define MBEDTLS_PLATFORM_C
+#define MBEDTLS_PLATFORM_MEMORY
+#define MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
+#define MBEDTLS_PLATFORM_PRINTF_MACRO  psa_crypto_printf
+#define MBEDTLS_PLATFORM_FPRINTF_MACRO  psa_crypto_fprintf
+#define MBEDTLS_PLATFORM_SNPRINTF_MACRO  psa_crypto_snprintf
+#define MBEDTLS_PLATFORM_SETBUF_MACRO  psa_crypto_setbuf
+#if defined(PSA_CRYPTO_MEMORY_BUFFER_ALLOC)
+#define MBEDTLS_MEMORY_BUFFER_ALLOC_C
+#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 8
+#else
+#define MBEDTLS_PLATFORM_CALLOC_MACRO  psa_crypto_calloc
+#define MBEDTLS_PLATFORM_FREE_MACRO  psa_crypto_free
+#endif
+#endif /* !PSA_CRYPTO_STD_FUNCTIONS */
+
+#if defined(PSA_CRYPTO_FS_IO)
+#define MBEDTLS_FS_IO
+#endif
+
+#if defined(PSA_CRYPTO_PLATFORM_ZEROIZE)
+#define MBEDTLS_PLATFORM_ZEROIZE_ALT
+#define mbedtls_platform_zeroize psa_crypto_platform_zeroize
+#endif
+
+#if defined(PSA_CRYPTO_BUILTIN_KEYS)
+#define MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
+#endif
+
+#if defined(PSA_CRYPTO_STORAGE_C)
+#define MBEDTLS_PSA_CRYPTO_STORAGE_C
+#endif
+
+#if defined(PSA_CRYPTO_ITS_FILE_C)
+#define MBEDTLS_PSA_ITS_FILE_C
+#endif
+
+#if defined(PSA_CRYPTO_EXTERNAL_RNG)
+#define MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
+#else /* PSA_CRYPTO_EXTERNAL_RNG */
+#define MBEDTLS_ENTROPY_C
+
+#if defined(PSA_CRYPTO_HMAC_DRBG_HASH)
+#define MBEDTLS_HMAC_DRBG_C
+#define MBEDTLS_MD_C
+
+/*
+ * The macro PSA_CRYPTO_HMAC_DRBG_HASH defines the hash algorithm (SHA-256 or
+ * SHA-512) to be used for HMAC for the PSA DRBG. It defines it using the PSA
+ * macro identifying the hash algorithm. Those macros are not part of the
+ * configuration macros thus they may not be defined at that point. As we need
+ * to use the value of PSA_CRYPTO_HMAC_DRBG_HASH, which is equal to
+ * PSA_ALG_SHA_256 or PSA_ALG_SHA_512 we need those macros to be defined. Their
+ * specific values are not important here, they just have to be different.
+ */
+#if !defined(PSA_ALG_SHA_256)
+#define PSA_ALG_SHA_256 1
+#define PSA_ALG_SHA_512 2
+#define UNDEFINE_PSA_ALG_SHA_256_512
+#endif
+
+#if (PSA_CRYPTO_HMAC_DRBG_HASH == PSA_ALG_SHA_256)
+#define MBEDTLS_PSA_HMAC_DRBG_MD_TYPE MBEDTLS_MD_SHA256
+#if !defined(MBEDTLS_SHA256_C)
+#define MBEDTLS_SHA256_C
+#endif
+#endif /* PSA_CRYPTO_HMAC_DRBG_HASH == PSA_ALG_SHA_256 */
+
+#if (PSA_CRYPTO_HMAC_DRBG_HASH == PSA_ALG_SHA_512)
+#if !defined(MBEDTLS_SHA512_C)
+#define MBEDTLS_SHA512_C
+#endif
+#define MBEDTLS_PSA_HMAC_DRBG_MD_TYPE MBEDTLS_MD_SHA512
+#endif /* PSA_CRYPTO_HMAC_DRBG_HASH == PSA_ALG_SHA_512 */
+
+/* Clean-up of the dummy values for PSA_ALG_SHA_256 and PSA_ALG_SHA_512 */
+#if defined(UNDEFINE_PSA_ALG_SHA_256_512)
+#undef PSA_ALG_SHA_256
+#undef PSA_ALG_SHA_512
+#undef UNDEFINE_PSA_ALG_SHA_256_512
+#endif
+
+#else  /* PSA_CRYPTO_HMAC_DRBG_HASH */
+
+#define MBEDTLS_CTR_DRBG_C
+#if !defined(MBEDTLS_AES_C)
+#define MBEDTLS_AES_C
+#endif
+
+#endif /* !PSA_CRYPTO_HMAC_DRBG_HASH */
+
+#if !defined(PSA_CRYPTO_PLATFORM_ENTROPY)
+#define MBEDTLS_NO_PLATFORM_ENTROPY
+#endif
+
+#if defined(PSA_CRYPTO_HARDWARE_ENTROPY)
+#define MBEDTLS_ENTROPY_HARDWARE_ALT
+#define mbedtls_hardware_poll psa_crypto_hardware_entropy
+#endif
+
+#if defined(PSA_CRYPTO_ENTROPY_NV_SEED)
+#define MBEDTLS_PLATFORM_C
+#define MBEDTLS_ENTROPY_NV_SEED
+#if !defined(PSA_CRYPTO_STD_FUNCTIONS) || !defined(PSA_CRYPTO_FS_IO)
+#include <psa/platform.h>
+#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO  psa_crypto_platform_entropy_nv_seed_read
+#define MBEDTLS_PLATFORM_NV_SEED_WRITE_MACRO  psa_crypto_platform_entropy_nv_seed_write
+#endif
+#endif /* PSA_CRYPTO_ENTROPY_NV_SEED */
+
+#endif /* !PSA_CRYPTO_EXTERNAL_RNG */
+
+#if defined(PSA_CRYPTO_KEY_SLOT_COUNT)
+#define MBEDTLS_PSA_KEY_SLOT_COUNT PSA_CRYPTO_KEY_SLOT_COUNT
+#endif
+
+#if defined(PSA_CRYPTO_ENTROPY_NV_SEED_FILE)
+#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE PSA_CRYPTO_ENTROPY_NV_SEED_FILE
+#endif

include/CMakeLists.txt

@@ -1,5 +1,9 @@
 file(GLOB psa_headers "psa/*.h")
 
+# Do not install the default configuration file as a specific one may have
+# been defined through the PSA_CRYPTO_CONFIG_FILE cached variable.
+list(REMOVE_ITEM psa_headers "${CMAKE_CURRENT_SOURCE_DIR}/psa/crypto_config.h")
+
 install(FILES ${psa_headers}
     DESTINATION include/psa
     PERMISSIONS OWNER_READ OWNER_WRITE GROUP_READ WORLD_READ)

include/psa/crypto_config.h

@@ -114,6 +114,23 @@
  */
 //#define PSA_CRYPTO_MEMORY_BUFFER_ALLOC
 
+/**
+ * Uncomment the macro to let PSA-Crypto use your alternate implementation of
+ * psa_crypto_platform_zeroize() instead of the default implementation.
+ *
+ * psa_crypto_platform_zeroize() is a widely used function across the library
+ * to zero a block of memory. The implementation is expected to be secure in the
+ * sense that it has been written to prevent the compiler from removing calls
+ * to psa_crypto_platform_zeroize() as part of redundant code elimination
+ * optimizations. However, it is difficult to guarantee that calls to
+ * psa_crypto_platform_zeroize() will not be optimized by the compiler as older
+ * versions of the C language standards do not provide a secure implementation
+ * of memset(). Therefore, PSA_CRYPTO_PLATFORM_ZEROIZE enables users to provide
+ * their own implementation of psa_crypto_platform_zeroize(), for
+ * example by using directives specific to their compiler.
+ */
+//#define PSA_CRYPTO_PLATFORM_ZEROIZE
+
 /** \} name SECTION: General configuration options */
 
 /**
@@ -323,6 +340,18 @@
  */
 #define PSA_CRYPTO_PLATFORM_ENTROPY
 
+/**
+ * \def PSA_CRYPTO_HARDWARE_ENTROPY
+ *
+ * Uncomment the macro to let PSA-Crypto use your own hardware entropy
+ * collector.
+ *
+ * Your hardware entropy collector function must be called
+ * \c psa_crypto_hardware_entropy(), see include/psa/platform.h for its
+ * prototype.
+ */
+//#define PSA_CRYPTO_HARDWARE_ENTROPY
+
 /**
  * \def PSA_CRYPTO_ENTROPY_NV_SEED
  *

include/psa/platform.h

@@ -79,6 +79,25 @@ int psa_crypto_fprintf(FILE *stream, const char *format, ...) PSA_CRYPTO_PRINTF_
 int psa_crypto_snprintf(char *s, size_t n, const char *format, ...) PSA_CRYPTO_PRINTF_ATTRIBUTE(3, 4);
 void psa_crypto_setbuf(FILE *stream, char *buf);
 
+/**
+ * \brief  Poll entropy from a hardware source
+ *
+ * \warning  This is not provided by PSA-Crypto.
+ *           See \c PSA_CRYPTO_HARDWARE_ENTROPY in crypto_config.h.
+ *
+ * \param[in]  data    Pointer to function-specific data. NULL must be accepted.
+ * \param[out] output  Buffer to write data in
+ * \param      size    Size of \p output
+ * \param[out] len     Number of bytes written in \p output. As far as possible,
+ *                     should be \p size but may be as low as 0.
+ * 
+ * \return             0 if no critical failure occured, a negative value
+ *                     otherwise.
+ */
+int psa_crypto_hardware_entropy(void *data,
+                                unsigned char *output, size_t size,
+                                size_t *len);
+
 /**
  * \brief   Read an entropy seed from a Non-Volatile (NV) storage.
  *
@@ -134,9 +153,9 @@ int psa_crypto_platform_entropy_nv_seed_write(unsigned char *buf, size_t buf_len
  *        heap before freeing the heap object.
  *
  *        It is extremely difficult to guarantee that calls to
- *        mbedtls_platform_zeroize() are not removed by aggressive
- *        compiler optimizations in a portable way. By disabling the
- *        PSA_CRYPTO_STD_FUNCTIONS configuration option, users of the
+ *        psa_crypto_platform_zeroize() are not removed by aggressive
+ *        compiler optimizations in a portable way. By enabling the
+ *        PSA_CRYPTO_PLATFORM_ZEROIZE configuration option, users of the
  *        psa-crypto library can provide their own implementation suitable for
  *        their platform and needs.
  *

programs/psa/CMakeLists.txt

@@ -11,7 +11,7 @@ if(GEN_FILES)
         OUTPUT
             ${CMAKE_CURRENT_BINARY_DIR}/psa_constant_names_generated.c
         COMMAND
-            ${MBEDTLS_PYTHON_EXECUTABLE}
+            ${PSA_CRYPTO_PYTHON_EXECUTABLE}
                 ${CMAKE_CURRENT_SOURCE_DIR}/../../scripts/generate_psa_constants.py
                 ${CMAKE_CURRENT_BINARY_DIR}
         WORKING_DIRECTORY

scripts/psa_crypto.py

@@ -99,6 +99,7 @@ def copy_from_scripts(mbedtls_root_path, psa_crypto_root_path):
     shutil.copy2(os.path.join(source_path, "generate_driver_wrappers.py"), destination_path)
     shutil.copy2(os.path.join(source_path, "generate_psa_constants.py"), destination_path)
     shutil.copy2(os.path.join(source_path, "output_env.sh"), destination_path)
+    shutil.copy2(os.path.join(source_path, "config.py"), destination_path)
 
     copy_tree(os.path.join(source_path, "mbedtls_dev"),
               os.path.join(destination_path, "mbedtls_dev"))
@@ -178,6 +179,37 @@ def replace_all_sh_components(psa_crypto_root_path):
     new_all_sh.close()
     os.chmod(os.path.join(tests_scripts_path, "all.sh"), stat.S_IEXEC | stat.S_IREAD | stat.S_IWRITE)
 
+def extend_config_psa(psa_crypto_root_path):
+    include_mbedtls_path = os.path.join(psa_crypto_root_path, "drivers", "builtin", "include", "mbedtls")
+    shutil.move(os.path.join(include_mbedtls_path, "config_psa.h"),
+                os.path.join(include_mbedtls_path, "config_psa.h.bak"))
+
+    if_defined_mbedtls_psa_crypto_config_file = re.compile("#if defined\(MBEDTLS_PSA_CRYPTO_CONFIG_FILE\)")
+    include_mbedtls_psa_crypto_config_file = re.compile("#include MBEDTLS_PSA_CRYPTO_CONFIG_FILE")
+    ext_placeholder = re.compile(".*BELOW THIS LINE - PLACEHOLDER FOR PSA-CRYPTO ADDITIONAL CONFIG OPTIONS TRANSLATION")
+    new_config_psa = open(os.path.join(include_mbedtls_path, "config_psa.h"), 'x')
+
+    with open(os.path.join(include_mbedtls_path, "config_psa.h.bak"), 'rt') as config_psa:
+        for line in config_psa:
+            if if_defined_mbedtls_psa_crypto_config_file.match(line) != None:
+                new_config_psa.write("#if defined(PSA_CRYPTO_CONFIG_FILE)\n")
+            elif include_mbedtls_psa_crypto_config_file.match(line) != None:
+                new_config_psa.write("#include PSA_CRYPTO_CONFIG_FILE\n")
+            elif ext_placeholder.match(line) != None:
+                break
+            else:
+                new_config_psa.write(line)
+
+    config_psa.close()
+
+    with open(os.path.join(psa_crypto_root_path, "drivers", "builtin", "config_psa_ext.h"), 'rt') as ext:
+        for line in ext:
+            new_config_psa.write(line)
+
+    new_config_psa.write("\n#endif /* MBEDTLS_PSA_CRYPTO_CONFIG */")
+    new_config_psa.write("\n#endif /* MBEDTLS_CONFIG_PSA_H */")
+    new_config_psa.close()
+
 def main():
     parser = argparse.ArgumentParser(
         description=(
@@ -206,6 +238,7 @@ def main():
     copy_from_programs(mbedtls_root_path, os.getcwd())
     copy_from_docs(mbedtls_root_path, os.getcwd())
     replace_all_sh_components(os.getcwd())
+    extend_config_psa(os.getcwd())
 
 if __name__ == "__main__":
     main()