From cd1c5e7cf618624b6d31d656858ba43b29b13c6a Mon Sep 17 00:00:00 2001 From: Paul Bartell Date: Mon, 24 Oct 2022 17:12:45 -0700 Subject: [PATCH] Combine core_pkcs11_config.h files into a single one --- .../core_pkcs11_config.h | 210 ------------------ .../Ota_Over_Http_Demo/core_pkcs11_config.h | 187 ---------------- .../Ota_Over_Mqtt_Demo/core_pkcs11_config.h | 187 ---------------- .../core_pkcs11_config.h | 206 ----------------- .../core_pkcs11_config.h | 192 ---------------- .../corePKCS11}/core_pkcs11_config.h | 27 ++- 6 files changed, 21 insertions(+), 988 deletions(-) delete mode 100644 FreeRTOS-Plus/Demo/AWS/Fleet_Provisioning_Windows_Simulator/Fleet_Provisioning_With_CSR_Demo/core_pkcs11_config.h delete mode 100644 FreeRTOS-Plus/Demo/AWS/Ota_Windows_Simulator/Ota_Over_Http_Demo/core_pkcs11_config.h delete mode 100644 FreeRTOS-Plus/Demo/AWS/Ota_Windows_Simulator/Ota_Over_Mqtt_Demo/core_pkcs11_config.h delete mode 100644 FreeRTOS-Plus/Demo/corePKCS11_MQTT_Mutual_Auth_Windows_Simulator/core_pkcs11_config.h delete mode 100644 FreeRTOS-Plus/Demo/coreSNTP_Windows_Simulator/core_pkcs11_config.h rename FreeRTOS-Plus/{Demo/corePKCS11_Windows_Simulator => WindowsSimulator/corePKCS11}/core_pkcs11_config.h (88%) diff --git a/FreeRTOS-Plus/Demo/AWS/Fleet_Provisioning_Windows_Simulator/Fleet_Provisioning_With_CSR_Demo/core_pkcs11_config.h b/FreeRTOS-Plus/Demo/AWS/Fleet_Provisioning_Windows_Simulator/Fleet_Provisioning_With_CSR_Demo/core_pkcs11_config.h deleted file mode 100644 index f4282e1683..0000000000 --- a/FreeRTOS-Plus/Demo/AWS/Fleet_Provisioning_Windows_Simulator/Fleet_Provisioning_With_CSR_Demo/core_pkcs11_config.h +++ /dev/null @@ -1,210 +0,0 @@ -/* - * FreeRTOS V202112.00 - * Copyright (C) 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved. - * - * Permission is hereby granted, free of charge, to any person obtaining a copy of - * this software and associated documentation files (the "Software"), to deal in - * the Software without restriction, including without limitation the rights to - * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of - * the Software, and to permit persons to whom the Software is furnished to do so, - * subject to the following conditions: - * - * The above copyright notice and this permission notice shall be included in all - * copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS - * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR - * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER - * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN - * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - * https://www.FreeRTOS.org - * https://github.com/FreeRTOS - * - */ - -/** - * @file core_pkcs11_config.h - * @brief PCKS#11 config options. - */ - - -#ifndef _CORE_PKCS11_CONFIG_H_ -#define _CORE_PKCS11_CONFIG_H_ - -#include "FreeRTOS.h" - -/**************************************************/ -/******* DO NOT CHANGE the following order ********/ -/**************************************************/ - -/* Include logging header files and define logging macros in the following order: - * 1. Include the header file "logging_levels.h". - * 2. Define the LIBRARY_LOG_NAME and LIBRARY_LOG_LEVEL macros depending on - * the logging configuration for PKCS #11. - * 3. Include the header file "logging_stack.h", if logging is enabled for PKCS #11. - */ -#include "logging_levels.h" - -/* Logging configuration for the PKCS #11 library. */ -#ifndef LIBRARY_LOG_NAME - #define LIBRARY_LOG_NAME "PKCS11" -#endif - -#ifndef LIBRARY_LOG_LEVEL - #define LIBRARY_LOG_LEVEL LOG_ERROR -#endif - -/* Prototype for the function used to print to console on Windows simulator - * of FreeRTOS. - * The function prints to the console before the network is connected; - * then a UDP port after the network has connected. */ -extern void vLoggingPrintf( const char * pcFormatString, - ... ); - -/* Map the SdkLog macro to the logging function to enable logging - * on Windows simulator. */ -#ifndef SdkLog - #define SdkLog( message ) vLoggingPrintf message -#endif - -#include "logging_stack.h" - -/************ End of logging configuration ****************/ - -#include - -/** - * @brief Malloc API used by core_pkcs11.h - */ -#define PKCS11_MALLOC pvPortMalloc - -/** - * @brief Free API used by core_pkcs11.h - */ -#define PKCS11_FREE vPortFree - -/** - * @brief PKCS #11 default user PIN. - * - * The PKCS #11 standard specifies the presence of a user PIN. That feature is - * sensible for applications that have an interactive user interface and memory - * protections. However, since typical microcontroller applications lack one or - * both of those, the user PIN is assumed to be used herein for interoperability - * purposes only, and not as a security feature. - * - * Note: Do not cast this to a pointer! The library calls sizeof to get the length - * of this string. - */ -#define configPKCS11_DEFAULT_USER_PIN "0000" - -/** - * @brief Maximum length (in characters) for a PKCS #11 CKA_LABEL - * attribute. - */ -#define pkcs11configMAX_LABEL_LENGTH 32UL - -/** - * @brief Maximum number of token objects that can be stored - * by the PKCS #11 module. - */ -#define pkcs11configMAX_NUM_OBJECTS 6UL - -/** - * @brief Maximum number of sessions that can be stored - * by the PKCS #11 module. - */ -#define pkcs11configMAX_SESSIONS 10UL - -/** - * @brief Set to 1 if a PAL destroy object is implemented. - * - * If set to 0, no PAL destroy object is implemented, and this functionality - * is implemented in the common PKCS #11 layer. - */ -#define pkcs11configPAL_DESTROY_SUPPORTED 0 - -/** - * @brief Set to 1 if OTA image verification via PKCS #11 module is supported. - * - * If set to 0, OTA code signing certificate is built in via - * aws_ota_codesigner_certificate.h. - */ -#define pkcs11configOTA_SUPPORTED 1 - -/** - * @brief Set to 1 if PAL supports storage for JITP certificate, - * code verify certificate, and trusted server root certificate. - * - * If set to 0, PAL does not support storage mechanism for these, and - * they are accessed via headers compiled into the code. - */ -#define pkcs11configJITP_CODEVERIFY_ROOT_CERT_SUPPORTED 0 - -/** - * @brief The PKCS #11 label for device private key. - * - * Private key for connection to AWS IoT endpoint. The corresponding - * public key should be registered with the AWS IoT endpoint. - */ -#define pkcs11configLABEL_DEVICE_PRIVATE_KEY_FOR_TLS ( "Device Priv TLS Key" ) - -/** - * @brief The PKCS #11 label for device public key. - * - * The public key corresponding to pkcs11configLABEL_DEVICE_PRIVATE_KEY_FOR_TLS. - */ -#define pkcs11configLABEL_DEVICE_PUBLIC_KEY_FOR_TLS ( "Device Pub TLS Key" ) - -/** - * @brief The PKCS #11 label for the device certificate. - * - * Device certificate corresponding to pkcs11configLABEL_DEVICE_PRIVATE_KEY_FOR_TLS. - */ -#define pkcs11configLABEL_DEVICE_CERTIFICATE_FOR_TLS ( "Device Cert" ) - -/** - * @brief The PKCS #11 label for the object to be used for HMAC operations. - */ -#define pkcs11configLABEL_HMAC_KEY ( "HMAC Key" ) - -/** - * @brief The PKCS #11 label for the object to be used for CMAC operations. - */ -#define pkcs11configLABEL_CMAC_KEY ( "CMAC Key" ) - -/** - * @brief The PKCS #11 label for the object to be used for code verification. - * - * Used by over-the-air update code to verify an incoming signed image. - */ -#define pkcs11configLABEL_CODE_VERIFICATION_KEY ( "Code Verify Key" ) - -/** - * @brief The PKCS #11 label for the claim certificate for Fleet Provisioning. - */ -#define pkcs11configLABEL_CLAIM_CERTIFICATE ( "Claim Cert" ) - -/** - * @brief The PKCS #11 label for the claim private key for Fleet Provisioning. - */ -#define pkcs11configLABEL_CLAIM_PRIVATE_KEY ( "Claim Key" ) - -/** - * @brief The PKCS #11 label for Just-In-Time-Provisioning. - * - * The certificate corresponding to the issuer of the device certificate - * (pkcs11configLABEL_DEVICE_CERTIFICATE_FOR_TLS) when using the JITR or - * JITP flow. - */ -#define pkcs11configLABEL_JITP_CERTIFICATE ( "JITP Cert" ) - -/** - * @brief The PKCS #11 label for the AWS Trusted Root Certificate. - * - * @see aws_default_root_certificates.h - */ -#define pkcs11configLABEL_ROOT_CERTIFICATE ( "Root Cert" ) - -#endif /* _CORE_PKCS11_CONFIG_H_ include guard. */ diff --git a/FreeRTOS-Plus/Demo/AWS/Ota_Windows_Simulator/Ota_Over_Http_Demo/core_pkcs11_config.h b/FreeRTOS-Plus/Demo/AWS/Ota_Windows_Simulator/Ota_Over_Http_Demo/core_pkcs11_config.h deleted file mode 100644 index 0eeaa4f8e5..0000000000 --- a/FreeRTOS-Plus/Demo/AWS/Ota_Windows_Simulator/Ota_Over_Http_Demo/core_pkcs11_config.h +++ /dev/null @@ -1,187 +0,0 @@ -/* - * FreeRTOS V202112.00 - * Copyright (C) 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved. - * - * Permission is hereby granted, free of charge, to any person obtaining a copy of - * this software and associated documentation files (the "Software"), to deal in - * the Software without restriction, including without limitation the rights to - * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of - * the Software, and to permit persons to whom the Software is furnished to do so, - * subject to the following conditions: - * - * The above copyright notice and this permission notice shall be included in all - * copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS - * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR - * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER - * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN - * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - * https://www.FreeRTOS.org - * https://github.com/FreeRTOS - * - */ - -/** - * @file core_pkcs11_config.h - * @brief PCKS#11 config options. - */ - - -#ifndef _CORE_PKCS11_CONFIG_H_ -#define _CORE_PKCS11_CONFIG_H_ - -#include "FreeRTOS.h" - -/**************************************************/ -/******* DO NOT CHANGE the following order ********/ -/**************************************************/ - -/* Include logging header files and define logging macros in the following order: - * 1. Include the header file "logging_levels.h". - * 2. Define the LIBRARY_LOG_NAME and LIBRARY_LOG_LEVEL macros depending on - * the logging configuration for PKCS #11. - * 3. Include the header file "logging_stack.h", if logging is enabled for PKCS #11. - */ - -#include "logging_levels.h" - -/* Logging configuration for the PKCS #11 library. */ -#ifndef LIBRARY_LOG_NAME - #define LIBRARY_LOG_NAME "PKCS11" -#endif - -#ifndef LIBRARY_LOG_LEVEL - #define LIBRARY_LOG_LEVEL LOG_ERROR -#endif - -/* Prototype for the function used to print to console on Windows simulator - * of FreeRTOS. - * The function prints to the console before the network is connected; - * then a UDP port after the network has connected. */ -extern void vLoggingPrintf( const char * pcFormatString, - ... ); - -/* Map the SdkLog macro to the logging function to enable logging - * on Windows simulator. */ -#ifndef SdkLog - #define SdkLog( message ) vLoggingPrintf message -#endif - -#include "logging_stack.h" - -/** - * @brief Malloc API used by core_pkcs11.h - */ -#define PKCS11_MALLOC pvPortMalloc - -/** - * @brief Free API used by core_pkcs11.h - */ -#define PKCS11_FREE vPortFree - -/** - * @brief PKCS #11 default user PIN. - * - * The PKCS #11 standard specifies the presence of a user PIN. That feature is - * sensible for applications that have an interactive user interface and memory - * protections. However, since typical microcontroller applications lack one or - * both of those, the user PIN is assumed to be used herein for interoperability - * purposes only, and not as a security feature. - * - * Note: Do not cast this to a pointer! The library calls sizeof to get the length - * of this string. - */ -#define configPKCS11_DEFAULT_USER_PIN "0000" - -/** - * @brief Maximum length (in characters) for a PKCS #11 CKA_LABEL - * attribute. - */ -#define pkcs11configMAX_LABEL_LENGTH 32 - -/** - * @brief Maximum number of token objects that can be stored - * by the PKCS #11 module. - */ -#define pkcs11configMAX_NUM_OBJECTS 6 - -/** - * @brief Maximum number of sessions that can be stored - * by the PKCS #11 module. - */ -#define pkcs11configMAX_SESSIONS 10 - -/** - * @brief Set to 1 if a PAL destroy object is implemented. - * - * If set to 0, no PAL destroy object is implemented, and this functionality - * is implemented in the common PKCS #11 layer. - */ -#define pkcs11configPAL_DESTROY_SUPPORTED 0 - -/** - * @brief Set to 1 if OTA image verification via PKCS #11 module is supported. - * - * If set to 0, OTA code signing certificate is built in via - * aws_ota_codesigner_certificate.h. - */ -#define pkcs11configOTA_SUPPORTED 0 - -/** - * @brief Set to 1 if PAL supports storage for JITP certificate, - * code verify certificate, and trusted server root certificate. - * - * If set to 0, PAL does not support storage mechanism for these, and - * they are accessed via headers compiled into the code. - */ -#define pkcs11configJITP_CODEVERIFY_ROOT_CERT_SUPPORTED 0 - -/** - * @brief The PKCS #11 label for device private key. - * - * Private key for connection to AWS IoT endpoint. The corresponding - * public key should be registered with the AWS IoT endpoint. - */ -#define pkcs11configLABEL_DEVICE_PRIVATE_KEY_FOR_TLS "Device Priv TLS Key" - -/** - * @brief The PKCS #11 label for device public key. - * - * The public key corresponding to pkcs11configLABEL_DEVICE_PRIVATE_KEY_FOR_TLS. - */ -#define pkcs11configLABEL_DEVICE_PUBLIC_KEY_FOR_TLS "Device Pub TLS Key" - -/** - * @brief The PKCS #11 label for the device certificate. - * - * Device certificate corresponding to pkcs11configLABEL_DEVICE_PRIVATE_KEY_FOR_TLS. - */ -#define pkcs11configLABEL_DEVICE_CERTIFICATE_FOR_TLS "Device Cert" - -/** - * @brief The PKCS #11 label for the object to be used for code verification. - * - * Used by over-the-air update code to verify an incoming signed image. - */ -#define pkcs11configLABEL_CODE_VERIFICATION_KEY "Code Verify Key" - -/** - * @brief The PKCS #11 label for Just-In-Time-Provisioning. - * - * The certificate corresponding to the issuer of the device certificate - * (pkcs11configLABEL_DEVICE_CERTIFICATE_FOR_TLS) when using the JITR or - * JITP flow. - */ -#define pkcs11configLABEL_JITP_CERTIFICATE "JITP Cert" - -/** - * @brief The PKCS #11 label for the AWS Trusted Root Certificate. - * - * @see aws_default_root_certificates.h - */ -#define pkcs11configLABEL_ROOT_CERTIFICATE "Root Cert" - -#endif /* _CORE_PKCS11_CONFIG_H_ */ diff --git a/FreeRTOS-Plus/Demo/AWS/Ota_Windows_Simulator/Ota_Over_Mqtt_Demo/core_pkcs11_config.h b/FreeRTOS-Plus/Demo/AWS/Ota_Windows_Simulator/Ota_Over_Mqtt_Demo/core_pkcs11_config.h deleted file mode 100644 index 0eeaa4f8e5..0000000000 --- a/FreeRTOS-Plus/Demo/AWS/Ota_Windows_Simulator/Ota_Over_Mqtt_Demo/core_pkcs11_config.h +++ /dev/null @@ -1,187 +0,0 @@ -/* - * FreeRTOS V202112.00 - * Copyright (C) 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved. - * - * Permission is hereby granted, free of charge, to any person obtaining a copy of - * this software and associated documentation files (the "Software"), to deal in - * the Software without restriction, including without limitation the rights to - * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of - * the Software, and to permit persons to whom the Software is furnished to do so, - * subject to the following conditions: - * - * The above copyright notice and this permission notice shall be included in all - * copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS - * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR - * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER - * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN - * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - * https://www.FreeRTOS.org - * https://github.com/FreeRTOS - * - */ - -/** - * @file core_pkcs11_config.h - * @brief PCKS#11 config options. - */ - - -#ifndef _CORE_PKCS11_CONFIG_H_ -#define _CORE_PKCS11_CONFIG_H_ - -#include "FreeRTOS.h" - -/**************************************************/ -/******* DO NOT CHANGE the following order ********/ -/**************************************************/ - -/* Include logging header files and define logging macros in the following order: - * 1. Include the header file "logging_levels.h". - * 2. Define the LIBRARY_LOG_NAME and LIBRARY_LOG_LEVEL macros depending on - * the logging configuration for PKCS #11. - * 3. Include the header file "logging_stack.h", if logging is enabled for PKCS #11. - */ - -#include "logging_levels.h" - -/* Logging configuration for the PKCS #11 library. */ -#ifndef LIBRARY_LOG_NAME - #define LIBRARY_LOG_NAME "PKCS11" -#endif - -#ifndef LIBRARY_LOG_LEVEL - #define LIBRARY_LOG_LEVEL LOG_ERROR -#endif - -/* Prototype for the function used to print to console on Windows simulator - * of FreeRTOS. - * The function prints to the console before the network is connected; - * then a UDP port after the network has connected. */ -extern void vLoggingPrintf( const char * pcFormatString, - ... ); - -/* Map the SdkLog macro to the logging function to enable logging - * on Windows simulator. */ -#ifndef SdkLog - #define SdkLog( message ) vLoggingPrintf message -#endif - -#include "logging_stack.h" - -/** - * @brief Malloc API used by core_pkcs11.h - */ -#define PKCS11_MALLOC pvPortMalloc - -/** - * @brief Free API used by core_pkcs11.h - */ -#define PKCS11_FREE vPortFree - -/** - * @brief PKCS #11 default user PIN. - * - * The PKCS #11 standard specifies the presence of a user PIN. That feature is - * sensible for applications that have an interactive user interface and memory - * protections. However, since typical microcontroller applications lack one or - * both of those, the user PIN is assumed to be used herein for interoperability - * purposes only, and not as a security feature. - * - * Note: Do not cast this to a pointer! The library calls sizeof to get the length - * of this string. - */ -#define configPKCS11_DEFAULT_USER_PIN "0000" - -/** - * @brief Maximum length (in characters) for a PKCS #11 CKA_LABEL - * attribute. - */ -#define pkcs11configMAX_LABEL_LENGTH 32 - -/** - * @brief Maximum number of token objects that can be stored - * by the PKCS #11 module. - */ -#define pkcs11configMAX_NUM_OBJECTS 6 - -/** - * @brief Maximum number of sessions that can be stored - * by the PKCS #11 module. - */ -#define pkcs11configMAX_SESSIONS 10 - -/** - * @brief Set to 1 if a PAL destroy object is implemented. - * - * If set to 0, no PAL destroy object is implemented, and this functionality - * is implemented in the common PKCS #11 layer. - */ -#define pkcs11configPAL_DESTROY_SUPPORTED 0 - -/** - * @brief Set to 1 if OTA image verification via PKCS #11 module is supported. - * - * If set to 0, OTA code signing certificate is built in via - * aws_ota_codesigner_certificate.h. - */ -#define pkcs11configOTA_SUPPORTED 0 - -/** - * @brief Set to 1 if PAL supports storage for JITP certificate, - * code verify certificate, and trusted server root certificate. - * - * If set to 0, PAL does not support storage mechanism for these, and - * they are accessed via headers compiled into the code. - */ -#define pkcs11configJITP_CODEVERIFY_ROOT_CERT_SUPPORTED 0 - -/** - * @brief The PKCS #11 label for device private key. - * - * Private key for connection to AWS IoT endpoint. The corresponding - * public key should be registered with the AWS IoT endpoint. - */ -#define pkcs11configLABEL_DEVICE_PRIVATE_KEY_FOR_TLS "Device Priv TLS Key" - -/** - * @brief The PKCS #11 label for device public key. - * - * The public key corresponding to pkcs11configLABEL_DEVICE_PRIVATE_KEY_FOR_TLS. - */ -#define pkcs11configLABEL_DEVICE_PUBLIC_KEY_FOR_TLS "Device Pub TLS Key" - -/** - * @brief The PKCS #11 label for the device certificate. - * - * Device certificate corresponding to pkcs11configLABEL_DEVICE_PRIVATE_KEY_FOR_TLS. - */ -#define pkcs11configLABEL_DEVICE_CERTIFICATE_FOR_TLS "Device Cert" - -/** - * @brief The PKCS #11 label for the object to be used for code verification. - * - * Used by over-the-air update code to verify an incoming signed image. - */ -#define pkcs11configLABEL_CODE_VERIFICATION_KEY "Code Verify Key" - -/** - * @brief The PKCS #11 label for Just-In-Time-Provisioning. - * - * The certificate corresponding to the issuer of the device certificate - * (pkcs11configLABEL_DEVICE_CERTIFICATE_FOR_TLS) when using the JITR or - * JITP flow. - */ -#define pkcs11configLABEL_JITP_CERTIFICATE "JITP Cert" - -/** - * @brief The PKCS #11 label for the AWS Trusted Root Certificate. - * - * @see aws_default_root_certificates.h - */ -#define pkcs11configLABEL_ROOT_CERTIFICATE "Root Cert" - -#endif /* _CORE_PKCS11_CONFIG_H_ */ diff --git a/FreeRTOS-Plus/Demo/corePKCS11_MQTT_Mutual_Auth_Windows_Simulator/core_pkcs11_config.h b/FreeRTOS-Plus/Demo/corePKCS11_MQTT_Mutual_Auth_Windows_Simulator/core_pkcs11_config.h deleted file mode 100644 index 5b0db1b9b5..0000000000 --- a/FreeRTOS-Plus/Demo/corePKCS11_MQTT_Mutual_Auth_Windows_Simulator/core_pkcs11_config.h +++ /dev/null @@ -1,206 +0,0 @@ -/* - * FreeRTOS V202112.00 - * Copyright (C) 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved. - * - * Permission is hereby granted, free of charge, to any person obtaining a copy of - * this software and associated documentation files (the "Software"), to deal in - * the Software without restriction, including without limitation the rights to - * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of - * the Software, and to permit persons to whom the Software is furnished to do so, - * subject to the following conditions: - * - * The above copyright notice and this permission notice shall be included in all - * copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS - * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR - * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER - * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN - * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - * https://www.FreeRTOS.org - * https://github.com/FreeRTOS - * - */ - -/** - * @file core_pkcs11_config.h - * @brief PCKS#11 config options. - */ - - -#ifndef _CORE_PKCS11_CONFIG_H_ -#define _CORE_PKCS11_CONFIG_H_ - -#include "FreeRTOS.h" - -/**************************************************/ -/******* DO NOT CHANGE the following order ********/ -/**************************************************/ - -/* Include logging header files and define logging macros in the following order: - * 1. Include the header file "logging_levels.h". - * 2. Define the LIBRARY_LOG_NAME and LIBRARY_LOG_LEVEL macros depending on - * the logging configuration for PKCS #11. - * 3. Include the header file "logging_stack.h", if logging is enabled for PKCS #11. - */ -#include "logging_levels.h" - -/* Logging configuration for the PKCS #11 library. */ -#ifndef LIBRARY_LOG_NAME - #define LIBRARY_LOG_NAME "PKCS11" -#endif - -#ifndef LIBRARY_LOG_LEVEL - #define LIBRARY_LOG_LEVEL LOG_ERROR -#endif - -/* Prototype for the function used to print to console on Windows simulator - * of FreeRTOS. - * The function prints to the console before the network is connected; - * then a UDP port after the network has connected. */ -extern void vLoggingPrintf( const char * pcFormatString, - ... ); - -/* Map the SdkLog macro to the logging function to enable logging - * on Windows simulator. */ -#ifndef SdkLog - #define SdkLog( message ) vLoggingPrintf message -#endif - -#include "logging_stack.h" - -/** - * @brief Malloc API used by core_pkcs11.h - */ -#define PKCS11_MALLOC pvPortMalloc - -/** - * @brief Free API used by core_pkcs11.h - */ -#define PKCS11_FREE vPortFree - -/** - * @brief ESP32 NVS Partition where PKCS #11 data is stored - */ -#define pkcs11configSTORAGE_PARTITION "storage" - -/** - * @brief ESP32 NVS namespace for PKCS #11 data - */ -#define pkcs11configSTORAGE_NS "creds" - -/** - * @brief PKCS #11 default user PIN. - * - * The PKCS #11 standard specifies the presence of a user PIN. That feature is - * sensible for applications that have an interactive user interface and memory - * protections. However, since typical microcontroller applications lack one or - * both of those, the user PIN is assumed to be used herein for interoperability - * purposes only, and not as a security feature. - * - * Note: Do not cast this to a pointer! The library calls sizeof to get the length - * of this string. - */ -#define configPKCS11_DEFAULT_USER_PIN "0000" - -/** - * @brief Maximum length (in characters) for a PKCS #11 CKA_LABEL - * attribute. - */ -#define pkcs11configMAX_LABEL_LENGTH 32UL - -/** - * @brief Maximum number of token objects that can be stored - * by the PKCS #11 module. - */ -#define pkcs11configMAX_NUM_OBJECTS 6UL - -/** - * @brief Maximum number of sessions that can be stored - * by the PKCS #11 module. - */ -#define pkcs11configMAX_SESSIONS 10UL - -/** - * @brief Set to 1 if a PAL destroy object is implemented. - * - * If set to 0, no PAL destroy object is implemented, and this functionality - * is implemented in the common PKCS #11 layer. - */ -#define pkcs11configPAL_DESTROY_SUPPORTED 0 - -/** - * @brief Set to 1 if OTA image verification via PKCS #11 module is supported. - * - * If set to 0, OTA code signing certificate is built in via - * aws_ota_codesigner_certificate.h. - */ -#define pkcs11configOTA_SUPPORTED 1 - -/** - * @brief Set to 1 if PAL supports storage for JITP certificate, - * code verify certificate, and trusted server root certificate. - * - * If set to 0, PAL does not support storage mechanism for these, and - * they are accessed via headers compiled into the code. - */ -#define pkcs11configJITP_CODEVERIFY_ROOT_CERT_SUPPORTED 0 - -/** - * @brief The PKCS #11 label for device private key. - * - * Private key for connection to AWS IoT endpoint. The corresponding - * public key should be registered with the AWS IoT endpoint. - */ -#define pkcs11configLABEL_DEVICE_PRIVATE_KEY_FOR_TLS ( "Device Priv TLS Key" ) - -/** - * @brief The PKCS #11 label for device public key. - * - * The public key corresponding to pkcs11configLABEL_DEVICE_PRIVATE_KEY_FOR_TLS. - */ -#define pkcs11configLABEL_DEVICE_PUBLIC_KEY_FOR_TLS ( "Device Pub TLS Key" ) - -/** - * @brief The PKCS #11 label for the device certificate. - * - * Device certificate corresponding to pkcs11configLABEL_DEVICE_PRIVATE_KEY_FOR_TLS. - */ -#define pkcs11configLABEL_DEVICE_CERTIFICATE_FOR_TLS ( "Device Cert" ) - -/** - * @brief The PKCS #11 label for the object to be used for code verification. - * - * Used by over-the-air update code to verify an incoming signed image. - */ -#define pkcs11configLABEL_CODE_VERIFICATION_KEY ( "Code Verify Key" ) - -/** - * @brief The PKCS #11 label for Just-In-Time-Provisioning. - * - * The certificate corresponding to the issuer of the device certificate - * (pkcs11configLABEL_DEVICE_CERTIFICATE_FOR_TLS) when using the JITR or - * JITP flow. - */ -#define pkcs11configLABEL_JITP_CERTIFICATE ( "JITP Cert" ) - -/** - * @brief The PKCS #11 label for the AWS Trusted Root Certificate. - * - * @see aws_default_root_certificates.h - */ -#define pkcs11configLABEL_ROOT_CERTIFICATE ( "Root Cert" ) - -/** - * @brief The PKCS #11 label for the object to be used for HMAC operations. - */ -#define pkcs11configLABEL_HMAC_KEY "HMAC Key" - - /** - * @brief The PKCS #11 label for the object to be used for CMAC operations. - */ -#define pkcs11configLABEL_CMAC_KEY "CMAC Key" - -#endif /* _CORE_PKCS11_CONFIG_H_ include guard. */ diff --git a/FreeRTOS-Plus/Demo/coreSNTP_Windows_Simulator/core_pkcs11_config.h b/FreeRTOS-Plus/Demo/coreSNTP_Windows_Simulator/core_pkcs11_config.h deleted file mode 100644 index 606a98b7e7..0000000000 --- a/FreeRTOS-Plus/Demo/coreSNTP_Windows_Simulator/core_pkcs11_config.h +++ /dev/null @@ -1,192 +0,0 @@ -/* - * FreeRTOS V202112.00 - * Copyright (C) 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved. - * - * Permission is hereby granted, free of charge, to any person obtaining a copy of - * this software and associated documentation files (the "Software"), to deal in - * the Software without restriction, including without limitation the rights to - * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of - * the Software, and to permit persons to whom the Software is furnished to do so, - * subject to the following conditions: - * - * The above copyright notice and this permission notice shall be included in all - * copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS - * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR - * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER - * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN - * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - * https://www.FreeRTOS.org - * https://github.com/FreeRTOS - * - */ - -/** - * @file core_pkcs11_config.h - * @brief PCKS#11 config options. - */ - - -#ifndef _CORE_PKCS11_CONFIG_H_ -#define _CORE_PKCS11_CONFIG_H_ - -#include "FreeRTOS.h" - -/**************************************************/ -/******* DO NOT CHANGE the following order ********/ -/**************************************************/ - -/* Include logging header files and define logging macros in the following order: - * 1. Include the header file "logging_levels.h". - * 2. Define the LIBRARY_LOG_NAME and LIBRARY_LOG_LEVEL macros depending on - * the logging configuration for PKCS #11. - * 3. Include the header file "logging_stack.h", if logging is enabled for PKCS #11. - */ - -#include "logging_levels.h" - -/* Logging configuration for the PKCS #11 library. */ -#ifndef LIBRARY_LOG_NAME - #define LIBRARY_LOG_NAME "PKCS11" -#endif - -#ifndef LIBRARY_LOG_LEVEL - #define LIBRARY_LOG_LEVEL LOG_ERROR -#endif - -/* Prototype for the function used to print to console on Windows simulator - * of FreeRTOS. - * The function prints to the console before the network is connected; - * then a UDP port after the network has connected. */ -extern void vLoggingPrintf( const char * pcFormatString, - ... ); - -/* Map the SdkLog macro to the logging function to enable logging - * on Windows simulator. */ -#ifndef SdkLog - #define SdkLog( message ) vLoggingPrintf message -#endif - -#include "logging_stack.h" - -/** - * @brief Malloc API used by core_pkcs11.h - */ -#define PKCS11_MALLOC pvPortMalloc - -/** - * @brief Free API used by core_pkcs11.h - */ -#define PKCS11_FREE vPortFree - -/** - * @brief PKCS #11 default user PIN. - * - * The PKCS #11 standard specifies the presence of a user PIN. That feature is - * sensible for applications that have an interactive user interface and memory - * protections. However, since typical microcontroller applications lack one or - * both of those, the user PIN is assumed to be used herein for interoperability - * purposes only, and not as a security feature. - * - * Note: Do not cast this to a pointer! The library calls sizeof to get the length - * of this string. - */ -#define configPKCS11_DEFAULT_USER_PIN "0000" - -/** - * @brief Maximum length (in characters) for a PKCS #11 CKA_LABEL - * attribute. - */ -#define pkcs11configMAX_LABEL_LENGTH 32 - -/** - * @brief Maximum number of token objects that can be stored - * by the PKCS #11 module. - */ -#define pkcs11configMAX_NUM_OBJECTS 6 - -/** - * @brief Maximum number of sessions that can be stored - * by the PKCS #11 module. - */ -#define pkcs11configMAX_SESSIONS 10 - -/** - * @brief Set to 1 if a PAL destroy object is implemented. - * - * If set to 0, no PAL destroy object is implemented, and this functionality - * is implemented in the common PKCS #11 layer. - */ -#define pkcs11configPAL_DESTROY_SUPPORTED 0 - -/** - * @brief Set to 1 if OTA image verification via PKCS #11 module is supported. - * - * If set to 0, OTA code signing certificate is built in via - * aws_ota_codesigner_certificate.h. - */ -#define pkcs11configOTA_SUPPORTED 0 - -/** - * @brief Set to 1 if PAL supports storage for JITP certificate, - * code verify certificate, and trusted server root certificate. - * - * If set to 0, PAL does not support storage mechanism for these, and - * they are accessed via headers compiled into the code. - */ -#define pkcs11configJITP_CODEVERIFY_ROOT_CERT_SUPPORTED 0 - -/** - * @brief The PKCS #11 label for device private key. - * - * Private key for connection to AWS IoT endpoint. The corresponding - * public key should be registered with the AWS IoT endpoint. - */ -#define pkcs11configLABEL_DEVICE_PRIVATE_KEY_FOR_TLS "Device Priv TLS Key" - -/** - * @brief The PKCS #11 label for device public key. - * - * The public key corresponding to pkcs11configLABEL_DEVICE_PRIVATE_KEY_FOR_TLS. - */ -#define pkcs11configLABEL_DEVICE_PUBLIC_KEY_FOR_TLS "Device Pub TLS Key" - -/** - * @brief The PKCS #11 label for the device certificate. - * - * Device certificate corresponding to pkcs11configLABEL_DEVICE_PRIVATE_KEY_FOR_TLS. - */ -#define pkcs11configLABEL_DEVICE_CERTIFICATE_FOR_TLS "Device Cert" - -/** - * @brief The PKCS #11 label for the object to be used for CMAC operations. - */ -#define pkcs11configLABEL_CMAC_KEY "CMAC Key" - -/** - * @brief The PKCS #11 label for the object to be used for code verification. - * - * Used by over-the-air update code to verify an incoming signed image. - */ -#define pkcs11configLABEL_CODE_VERIFICATION_KEY "Code Verify Key" - -/** - * @brief The PKCS #11 label for Just-In-Time-Provisioning. - * - * The certificate corresponding to the issuer of the device certificate - * (pkcs11configLABEL_DEVICE_CERTIFICATE_FOR_TLS) when using the JITR or - * JITP flow. - */ -#define pkcs11configLABEL_JITP_CERTIFICATE "JITP Cert" - -/** - * @brief The PKCS #11 label for the AWS Trusted Root Certificate. - * - * @see aws_default_root_certificates.h - */ -#define pkcs11configLABEL_ROOT_CERTIFICATE "Root Cert" - -#endif /* _CORE_PKCS11_CONFIG_H_ */ diff --git a/FreeRTOS-Plus/Demo/corePKCS11_Windows_Simulator/core_pkcs11_config.h b/FreeRTOS-Plus/WindowsSimulator/corePKCS11/core_pkcs11_config.h similarity index 88% rename from FreeRTOS-Plus/Demo/corePKCS11_Windows_Simulator/core_pkcs11_config.h rename to FreeRTOS-Plus/WindowsSimulator/corePKCS11/core_pkcs11_config.h index fa10304f7d..5a4c0372e5 100644 --- a/FreeRTOS-Plus/Demo/corePKCS11_Windows_Simulator/core_pkcs11_config.h +++ b/FreeRTOS-Plus/WindowsSimulator/corePKCS11/core_pkcs11_config.h @@ -64,6 +64,7 @@ extern void vLoggingPrintf( const char * pcFormatString, ... ); + /* Map the SdkLog macro to the logging function to enable logging * on Windows simulator. */ #ifndef SdkLog @@ -72,6 +73,10 @@ extern void vLoggingPrintf( const char * pcFormatString, #include "logging_stack.h" +/************ End of logging configuration ****************/ + +#include + /** * @brief Malloc API used by core_pkcs11.h */ @@ -100,19 +105,19 @@ extern void vLoggingPrintf( const char * pcFormatString, * @brief Maximum length (in characters) for a PKCS #11 CKA_LABEL * attribute. */ -#define pkcs11configMAX_LABEL_LENGTH 32 +#define pkcs11configMAX_LABEL_LENGTH 32UL /** * @brief Maximum number of token objects that can be stored * by the PKCS #11 module. */ -#define pkcs11configMAX_NUM_OBJECTS 6 +#define pkcs11configMAX_NUM_OBJECTS 6UL /** * @brief Maximum number of sessions that can be stored * by the PKCS #11 module. */ -#define pkcs11configMAX_SESSIONS 10 +#define pkcs11configMAX_SESSIONS 10UL /** * @brief Set to 1 if a PAL destroy object is implemented. @@ -120,7 +125,7 @@ extern void vLoggingPrintf( const char * pcFormatString, * If set to 0, no PAL destroy object is implemented, and this functionality * is implemented in the common PKCS #11 layer. */ -#define pkcs11configPAL_DESTROY_SUPPORTED 0 +#define pkcs11configPAL_DESTROY_SUPPORTED 1 /** * @brief Set to 1 if OTA image verification via PKCS #11 module is supported. @@ -128,7 +133,7 @@ extern void vLoggingPrintf( const char * pcFormatString, * If set to 0, OTA code signing certificate is built in via * aws_ota_codesigner_certificate.h. */ -#define pkcs11configOTA_SUPPORTED 0 +#define pkcs11configOTA_SUPPORTED 1 /** * @brief Set to 1 if PAL supports storage for JITP certificate, @@ -137,7 +142,7 @@ extern void vLoggingPrintf( const char * pcFormatString, * If set to 0, PAL does not support storage mechanism for these, and * they are accessed via headers compiled into the code. */ -#define pkcs11configJITP_CODEVERIFY_ROOT_CERT_SUPPORTED 0 +#define pkcs11configJITP_CODEVERIFY_ROOT_CERT_SUPPORTED 1 /** * @brief The PKCS #11 label for the object to be used for HMAC operations. @@ -178,6 +183,16 @@ extern void vLoggingPrintf( const char * pcFormatString, */ #define pkcs11configLABEL_CODE_VERIFICATION_KEY "Code Verify Key" +/** + * @brief The PKCS #11 label for the claim certificate for Fleet Provisioning. + */ +#define pkcs11configLABEL_CLAIM_CERTIFICATE "Claim Cert" + +/** + * @brief The PKCS #11 label for the claim private key for Fleet Provisioning. + */ +#define pkcs11configLABEL_CLAIM_PRIVATE_KEY "Claim Key" + /** * @brief The PKCS #11 label for Just-In-Time-Provisioning. *