From 168d92132f6f4a1a2a962990c6c39e191eb39d32 Mon Sep 17 00:00:00 2001 From: Oscar Michael Abrina Date: Thu, 8 Oct 2020 13:56:28 -0700 Subject: [PATCH] Move MQTT Mutual Auth Demo from lts-development to master (#331) This moves the MQTT Mutual Auth Demo under FreeRTOS-Plus/Demo/coreMQTT_Windows_Simulator/MQTT_Mutual_Auth The project files such as WIN32.vcxproj and WIN32.vcxproj.filters are updated to point to the sources and includes from the coreMQTT submodule. No changes are made to the actual code. Only paths are updated. Co-authored-by: Muneeb Ahmed <54290492+muneebahmed10@users.noreply.github.com> Co-authored-by: SarenaAWS <6563840+sarenameas@users.noreply.github.com> Co-authored-by: leegeth <51681119+leegeth@users.noreply.github.com> --- .gitmodules | 3 + .../DemoTasks/MutualAuthMQTTExample.c | 873 +++++++++++ .../MQTT_Mutual_Auth/FreeRTOSConfig.h | 214 +++ .../MQTT_Mutual_Auth/FreeRTOSIPConfig.h | 309 ++++ .../MQTT_Mutual_Auth/READ_ME_INSTRUCTIONS.url | 5 + .../MQTT_Mutual_Auth/WIN32.vcxproj | 614 ++++++++ .../MQTT_Mutual_Auth/WIN32.vcxproj.filters | 749 +++++++++ .../MQTT_Mutual_Auth/core_mqtt_config.h | 65 + .../MQTT_Mutual_Auth/demo_config.h | 159 ++ .../MQTT_Mutual_Auth/mbedtls_config.h | 151 ++ .../mqtt_mutual_auth_demo.sln | 25 + .../platform/freertos/mbedtls/mbedtls_error.c | 1336 +++++++++++++++++ .../platform/freertos/mbedtls/mbedtls_error.h | 58 + FreeRTOS-Plus/ThirdParty/mbedtls | 1 + 14 files changed, 4562 insertions(+) create mode 100644 FreeRTOS-Plus/Demo/coreMQTT_Windows_Simulator/MQTT_Mutual_Auth/DemoTasks/MutualAuthMQTTExample.c create mode 100644 FreeRTOS-Plus/Demo/coreMQTT_Windows_Simulator/MQTT_Mutual_Auth/FreeRTOSConfig.h create mode 100644 FreeRTOS-Plus/Demo/coreMQTT_Windows_Simulator/MQTT_Mutual_Auth/FreeRTOSIPConfig.h create mode 100644 FreeRTOS-Plus/Demo/coreMQTT_Windows_Simulator/MQTT_Mutual_Auth/READ_ME_INSTRUCTIONS.url create mode 100644 FreeRTOS-Plus/Demo/coreMQTT_Windows_Simulator/MQTT_Mutual_Auth/WIN32.vcxproj create mode 100644 FreeRTOS-Plus/Demo/coreMQTT_Windows_Simulator/MQTT_Mutual_Auth/WIN32.vcxproj.filters create mode 100644 FreeRTOS-Plus/Demo/coreMQTT_Windows_Simulator/MQTT_Mutual_Auth/core_mqtt_config.h create mode 100644 FreeRTOS-Plus/Demo/coreMQTT_Windows_Simulator/MQTT_Mutual_Auth/demo_config.h create mode 100644 FreeRTOS-Plus/Demo/coreMQTT_Windows_Simulator/MQTT_Mutual_Auth/mbedtls_config.h create mode 100644 FreeRTOS-Plus/Demo/coreMQTT_Windows_Simulator/MQTT_Mutual_Auth/mqtt_mutual_auth_demo.sln create mode 100644 FreeRTOS-Plus/Source/Application-Protocols/platform/freertos/mbedtls/mbedtls_error.c create mode 100644 FreeRTOS-Plus/Source/Application-Protocols/platform/freertos/mbedtls/mbedtls_error.h create mode 160000 FreeRTOS-Plus/ThirdParty/mbedtls diff --git a/.gitmodules b/.gitmodules index 29506748a8..02445bf957 100644 --- a/.gitmodules +++ b/.gitmodules @@ -19,6 +19,9 @@ [submodule "FreeRTOS-Plus/Test/CMock"] path = FreeRTOS-Plus/Test/CMock url = https://github.com/ThrowTheSwitch/CMock +[submodule "FreeRTOS-Plus/ThirdParty/mbedtls"] + path = FreeRTOS-Plus/ThirdParty/mbedtls + url = https://github.com/ARMmbed/mbedtls [submodule "FreeRTOS-Plus/Source/Application-Protocols/corePKCS11"] path = FreeRTOS-Plus/Source/corePKCS11 url = https://github.com/FreeRTOS/corePKCS11.git diff --git a/FreeRTOS-Plus/Demo/coreMQTT_Windows_Simulator/MQTT_Mutual_Auth/DemoTasks/MutualAuthMQTTExample.c b/FreeRTOS-Plus/Demo/coreMQTT_Windows_Simulator/MQTT_Mutual_Auth/DemoTasks/MutualAuthMQTTExample.c new file mode 100644 index 0000000000..4295920e31 --- /dev/null +++ b/FreeRTOS-Plus/Demo/coreMQTT_Windows_Simulator/MQTT_Mutual_Auth/DemoTasks/MutualAuthMQTTExample.c @@ -0,0 +1,873 @@ +/* + * FreeRTOS Kernel V10.3.0 + * 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. + * + * http://www.FreeRTOS.org + * http://aws.amazon.com/freertos + * + */ + +/* + * Demo for showing use of the MQTT API using a mutually authenticated + * network connection. + * + * The Example shown below uses MQTT APIs to create MQTT messages and send them + * over the mutually authenticated network connection established with the + * MQTT broker. This example is single threaded and uses statically allocated + * memory. It uses QoS1 for sending to and receiving messages from the broker. + * + * A mutually authenticated TLS connection is used to connect to the + * MQTT message broker in this example. Define democonfigMQTT_BROKER_ENDPOINT, + * democonfigROOT_CA_PEM, democonfigCLIENT_CERTIFICATE_PEM, + * and democonfigCLIENT_PRIVATE_KEY_PEM in demo_config.h to establish a + * mutually authenticated connection. + */ + +/* Standard includes. */ +#include +#include + +/* Kernel includes. */ +#include "FreeRTOS.h" +#include "task.h" + +/* Demo Specific configs. */ +#include "demo_config.h" + +/* MQTT library includes. */ +#include "core_mqtt.h" + +/* Retry utilities include. */ +#include "retry_utils.h" + +/* Transport interface implementation include header for TLS. */ +#include "tls_freertos.h" + +/*-----------------------------------------------------------*/ + +/* Compile time error for undefined configs. */ +#ifndef democonfigMQTT_BROKER_ENDPOINT + #error "Define the config democonfigMQTT_BROKER_ENDPOINT by following the instructions in file demo_config.h." +#endif +#ifndef democonfigROOT_CA_PEM + #error "Please define Root CA certificate of the MQTT broker(democonfigROOT_CA_PEM) in demo_config.h." +#endif +#ifndef democonfigCLIENT_CERTIFICATE_PEM + #error "Please define client certificate(democonfigCLIENT_CERTIFICATE_PEM) in demo_config.h." +#endif +#ifndef democonfigCLIENT_PRIVATE_KEY_PEM + #error "Please define client private key(democonfigCLIENT_PRIVATE_KEY_PEM) in demo_config.h." +#endif + +/*-----------------------------------------------------------*/ + +/* Default values for configs. */ +#ifndef democonfigCLIENT_IDENTIFIER + +/** + * @brief The MQTT client identifier used in this example. Each client identifier + * must be unique so edit as required to ensure no two clients connecting to the + * same broker use the same client identifier. + * + * @note Appending __TIME__ to the client id string will help to create a unique + * client id every time an application binary is built. Only a single instance of + * this application's compiled binary may be used at a time, since the client ID + * will always be the same. + */ + #define democonfigCLIENT_IDENTIFIER "testClient"__TIME__ +#endif + +#ifndef democonfigMQTT_BROKER_PORT + +/** + * @brief The port to use for the demo. + */ + #define democonfigMQTT_BROKER_PORT ( 8883 ) +#endif + +/*-----------------------------------------------------------*/ + +/** + * @brief Timeout for receiving CONNACK packet in milliseconds. + */ +#define mqttexampleCONNACK_RECV_TIMEOUT_MS ( 1000U ) + +/** + * @brief The topic to subscribe and publish to in the example. + * + * The topic name starts with the client identifier to ensure that each demo + * interacts with a unique topic name. + */ +#define mqttexampleTOPIC democonfigCLIENT_IDENTIFIER "/example/topic" + +/** + * @brief The number of topic filters to subscribe. + */ +#define mqttexampleTOPIC_COUNT ( 1 ) + +/** + * @brief The MQTT message published in this example. + */ +#define mqttexampleMESSAGE "Hello World!" + +/** + * @brief Time in ticks to wait between each cycle of the demo implemented + * by prvMQTTDemoTask(). + */ +#define mqttexampleDELAY_BETWEEN_DEMO_ITERATIONS_TICKS ( pdMS_TO_TICKS( 5000U ) ) + +/** + * @brief Timeout for MQTT_ProcessLoop in milliseconds. + */ +#define mqttexamplePROCESS_LOOP_TIMEOUT_MS ( 500U ) + +/** + * @brief Keep alive time reported to the broker while establishing + * an MQTT connection. + * + * It is the responsibility of the Client to ensure that the interval between + * Control Packets being sent does not exceed the this Keep Alive value. In the + * absence of sending any other Control Packets, the Client MUST send a + * PINGREQ Packet. + */ +#define mqttexampleKEEP_ALIVE_TIMEOUT_SECONDS ( 60U ) + +/** + * @brief Delay (in ticks) between consecutive cycles of MQTT publish operations in a + * demo iteration. + * + * Note that the process loop also has a timeout, so the total time between + * publishes is the sum of the two delays. + */ +#define mqttexampleDELAY_BETWEEN_PUBLISHES_TICKS ( pdMS_TO_TICKS( 2000U ) ) + +/** + * @brief Transport timeout in milliseconds for transport send and receive. + */ +#define mqttexampleTRANSPORT_SEND_RECV_TIMEOUT_MS ( 200U ) + +/** + * @brief Milliseconds per second. + */ +#define _MILLISECONDS_PER_SECOND ( 1000U ) + +/** + * @brief Milliseconds per FreeRTOS tick. + */ +#define _MILLISECONDS_PER_TICK ( _MILLISECONDS_PER_SECOND / configTICK_RATE_HZ ) + +/*-----------------------------------------------------------*/ + +/** + * @brief The task used to demonstrate the MQTT API. + * + * @param[in] pvParameters Parameters as passed at the time of task creation. Not + * used in this example. + */ +static void prvMQTTDemoTask( void * pvParameters ); + +/** + * @brief Connect to MQTT broker with reconnection retries. + * + * If connection fails, retry is attempted after a timeout. + * Timeout value will exponentially increase until maximum + * timeout value is reached or the number of attempts are exhausted. + * + * @param[out] pxNetworkContext The output parameter to return the created network context. + * + * @return The status of the final connection attempt. + */ +static TlsTransportStatus_t prvConnectToServerWithBackoffRetries( NetworkCredentials_t * pxNetworkCredentials, + NetworkContext_t * pNetworkContext ); + +/** + * @brief Sends an MQTT Connect packet over the already connected TLS over TCP connection. + * + * @param[in, out] pxMQTTContext MQTT context pointer. + * @param[in] xNetworkContext Network context. + */ +static void prvCreateMQTTConnectionWithBroker( MQTTContext_t * pxMQTTContext, + NetworkContext_t * pxNetworkContext ); + +/** + * @brief Function to update variable #xTopicFilterContext with status + * information from Subscribe ACK. Called by the event callback after processing + * an incoming SUBACK packet. + * + * @param[in] Server response to the subscription request. + */ +static void prvUpdateSubAckStatus( MQTTPacketInfo_t * pxPacketInfo ); + +/** + * @brief Subscribes to the topic as specified in mqttexampleTOPIC at the top of + * this file. In the case of a Subscribe ACK failure, then subscription is + * retried using an exponential backoff strategy with jitter. + * + * @param[in] pxMQTTContext MQTT context pointer. + */ +static void prvMQTTSubscribeWithBackoffRetries( MQTTContext_t * pxMQTTContext ); + +/** + * @brief Publishes a message mqttexampleMESSAGE on mqttexampleTOPIC topic. + * + * @param[in] pxMQTTContext MQTT context pointer. + */ +static void prvMQTTPublishToTopic( MQTTContext_t * pxMQTTContext ); + +/** + * @brief Unsubscribes from the previously subscribed topic as specified + * in mqttexampleTOPIC. + * + * @param[in] pxMQTTContext MQTT context pointer. + */ +static void prvMQTTUnsubscribeFromTopic( MQTTContext_t * pxMQTTContext ); + +/** + * @brief The timer query function provided to the MQTT context. + * + * @return Time in milliseconds. + */ +static uint32_t prvGetTimeMs( void ); + +/** + * @brief Process a response or ack to an MQTT request (PING, PUBLISH, + * SUBSCRIBE or UNSUBSCRIBE). This function processes PINGRESP, PUBACK, + * SUBACK, and UNSUBACK. + * + * @param[in] pxIncomingPacket is a pointer to structure containing deserialized + * MQTT response. + * @param[in] usPacketId is the packet identifier from the ack received. + */ +static void prvMQTTProcessResponse( MQTTPacketInfo_t * pxIncomingPacket, + uint16_t usPacketId ); + +/** + * @brief Process incoming Publish message. + * + * @param[in] pxPublishInfo is a pointer to structure containing deserialized + * Publish message. + */ +static void prvMQTTProcessIncomingPublish( MQTTPublishInfo_t * pxPublishInfo ); + +/** + * @brief The application callback function for getting the incoming publishes, + * incoming acks, and ping responses reported from the MQTT library. + * + * @param[in] pxMQTTContext MQTT context pointer. + * @param[in] pxPacketInfo Packet Info pointer for the incoming packet. + * @param[in] pxDeserializedInfo Deserialized information from the incoming packet. + */ +static void prvEventCallback( MQTTContext_t * pxMQTTContext, + MQTTPacketInfo_t * pxPacketInfo, + MQTTDeserializedInfo_t * pxDeserializedInfo ); + +/*-----------------------------------------------------------*/ + +/** + * @brief Static buffer used to hold MQTT messages being sent and received. + */ +static uint8_t ucSharedBuffer[ democonfigNETWORK_BUFFER_SIZE ]; + +/** + * @brief Global entry time into the application to use as a reference timestamp + * in the #prvGetTimeMs function. #prvGetTimeMs will always return the difference + * between the current time and the global entry time. This will reduce the chances + * of overflow for the 32 bit unsigned integer used for holding the timestamp. + */ +static uint32_t ulGlobalEntryTimeMs; + +/** + * @brief Packet Identifier generated when Publish request was sent to the broker; + * it is used to match received Publish ACK to the transmitted Publish packet. + */ +static uint16_t usPublishPacketIdentifier; + +/** + * @brief Packet Identifier generated when Subscribe request was sent to the broker; + * it is used to match received Subscribe ACK to the transmitted Subscribe packet. + */ +static uint16_t usSubscribePacketIdentifier; + +/** + * @brief Packet Identifier generated when Unsubscribe request was sent to the broker; + * it is used to match received Unsubscribe response to the transmitted Unsubscribe + * request. + */ +static uint16_t usUnsubscribePacketIdentifier; + +/** + * @brief A pair containing a topic filter and its SUBACK status. + */ +typedef struct topicFilterContext +{ + const char * pcTopicFilter; + MQTTSubAckStatus_t xSubAckStatus; +} topicFilterContext_t; + +/** + * @brief An array containing the context of a SUBACK; the SUBACK status + * of a filter is updated when the event callback processes a SUBACK. + */ +static topicFilterContext_t xTopicFilterContext[ mqttexampleTOPIC_COUNT ] = +{ + { mqttexampleTOPIC, MQTTSubAckFailure } +}; + + +/** @brief Static buffer used to hold MQTT messages being sent and received. */ +static MQTTFixedBuffer_t xBuffer = +{ + ucSharedBuffer, + democonfigNETWORK_BUFFER_SIZE +}; + +/*-----------------------------------------------------------*/ + +/* + * @brief Create the task that demonstrates the MQTT API Demo over a + * mutually authenticated network connection with MQTT broker. + */ +void vStartSimpleMQTTDemo( void ) +{ + /* This example uses a single application task, which in turn is used to + * connect, subscribe, publish, unsubscribe and disconnect from the MQTT + * broker. */ + xTaskCreate( prvMQTTDemoTask, /* Function that implements the task. */ + "MQTTDemo", /* Text name for the task - only used for debugging. */ + democonfigDEMO_STACKSIZE, /* Size of stack (in words, not bytes) to allocate for the task. */ + NULL, /* Task parameter - not used in this case. */ + tskIDLE_PRIORITY, /* Task priority, must be between 0 and configMAX_PRIORITIES - 1. */ + NULL ); /* Used to pass out a handle to the created task - not used in this case. */ +} +/*-----------------------------------------------------------*/ + +/* + * @brief The Example shown below uses MQTT APIs to create MQTT messages and + * send them over the mutually authenticated network connection established with the + * MQTT broker. This example is single threaded and uses statically allocated + * memory. It uses QoS1 for sending to and receiving messages from the broker. + * + * This MQTT client subscribes to the topic as specified in mqttexampleTOPIC at the + * top of this file by sending a subscribe packet and then waiting for a subscribe + * acknowledgment (SUBACK).This client will then publish to the same topic it + * subscribed to, so it will expect all the messages it sends to the broker to be + * sent back to it from the broker. + */ +static void prvMQTTDemoTask( void * pvParameters ) +{ + uint32_t ulPublishCount = 0U, ulTopicCount = 0U; + const uint32_t ulMaxPublishCount = 5UL; + NetworkContext_t xNetworkContext = { 0 }; + NetworkCredentials_t xNetworkCredentials = { 0 }; + MQTTContext_t xMQTTContext = { 0 }; + MQTTStatus_t xMQTTStatus; + TlsTransportStatus_t xNetworkStatus; + + /* Remove compiler warnings about unused parameters. */ + ( void ) pvParameters; + + /* Set the entry time of the demo application. This entry time will be used + * to calculate relative time elapsed in the execution of the demo application, + * by the timer utility function that is provided to the MQTT library. + */ + ulGlobalEntryTimeMs = prvGetTimeMs(); + + for( ; ; ) + { + /****************************** Connect. ******************************/ + + /* Attempt to establish TLS session with MQTT broker. If connection fails, + * retry after a timeout. Timeout value will be exponentially increased + * until the maximum number of attempts are reached or the maximum timeout + * value is reached. The function returns a failure status if the TCP + * connection cannot be established to the broker after the configured + * number of attempts. */ + xNetworkStatus = prvConnectToServerWithBackoffRetries( &xNetworkCredentials, + &xNetworkContext ); + configASSERT( xNetworkStatus == TLS_TRANSPORT_SUCCESS ); + + /* Sends an MQTT Connect packet over the already established TLS connection, + * and waits for connection acknowledgment (CONNACK) packet. */ + LogInfo( ( "Creating an MQTT connection to %s.\r\n", democonfigMQTT_BROKER_ENDPOINT ) ); + prvCreateMQTTConnectionWithBroker( &xMQTTContext, &xNetworkContext ); + + /**************************** Subscribe. ******************************/ + + /* If server rejected the subscription request, attempt to resubscribe to + * topic. Attempts are made according to the exponential backoff retry + * strategy implemented in retryUtils. */ + prvMQTTSubscribeWithBackoffRetries( &xMQTTContext ); + + /* Process incoming packet from the broker. After sending the subscribe, the + * client may receive a publish before it receives a subscribe ack. Therefore, + * call generic incoming packet processing function. Since this demo is + * subscribing to the topic to which no one is publishing, probability of + * receiving Publish message before subscribe ack is zero; but application + * must be ready to receive any packet. This demo uses the generic packet + * processing function everywhere to highlight this fact. */ + xMQTTStatus = MQTT_ProcessLoop( &xMQTTContext, mqttexamplePROCESS_LOOP_TIMEOUT_MS ); + configASSERT( xMQTTStatus == MQTTSuccess ); + + /****************** Publish and Keep Alive Loop. **********************/ + /* Publish messages with QoS1, send and process Keep alive messages. */ + for( ulPublishCount = 0; ulPublishCount < ulMaxPublishCount; ulPublishCount++ ) + { + LogInfo( ( "Publish to the MQTT topic %s.\r\n", mqttexampleTOPIC ) ); + prvMQTTPublishToTopic( &xMQTTContext ); + + /* Process incoming publish echo, since application subscribed to the + * same topic, the broker will send publish message back to the + * application. */ + LogInfo( ( "Attempt to receive publish message from broker.\r\n" ) ); + xMQTTStatus = MQTT_ProcessLoop( &xMQTTContext, mqttexamplePROCESS_LOOP_TIMEOUT_MS ); + configASSERT( xMQTTStatus == MQTTSuccess ); + + /* Leave Connection Idle for some time. */ + LogInfo( ( "Keeping Connection Idle...\r\n\r\n" ) ); + vTaskDelay( mqttexampleDELAY_BETWEEN_PUBLISHES_TICKS ); + } + + /******************** Unsubscribe from the topic. *********************/ + LogInfo( ( "Unsubscribe from the MQTT topic %s.\r\n", mqttexampleTOPIC ) ); + prvMQTTUnsubscribeFromTopic( &xMQTTContext ); + + /* Process incoming UNSUBACK packet from the broker. */ + xMQTTStatus = MQTT_ProcessLoop( &xMQTTContext, mqttexamplePROCESS_LOOP_TIMEOUT_MS ); + configASSERT( xMQTTStatus == MQTTSuccess ); + + /**************************** Disconnect. *****************************/ + + /* Send an MQTT Disconnect packet over the already connected TLS over + * TCP connection. There is no corresponding response for the disconnect + * packet. After sending disconnect, client must close the network + * connection. */ + LogInfo( ( "Disconnecting the MQTT connection with %s.\r\n", + democonfigMQTT_BROKER_ENDPOINT ) ); + xMQTTStatus = MQTT_Disconnect( &xMQTTContext ); + configASSERT( xMQTTStatus == MQTTSuccess ); + + /* Close the network connection. */ + TLS_FreeRTOS_Disconnect( &xNetworkContext ); + + /* Reset SUBACK status for each topic filter after completion of + * subscription request cycle. */ + for( ulTopicCount = 0; ulTopicCount < mqttexampleTOPIC_COUNT; ulTopicCount++ ) + { + xTopicFilterContext[ ulTopicCount ].xSubAckStatus = MQTTSubAckFailure; + } + + /* Wait for some time between two iterations to ensure that we do not + * bombard the broker. */ + LogInfo( ( "prvMQTTDemoTask() completed an iteration successfully. " + "Total free heap is %u.\r\n", + xPortGetFreeHeapSize() ) ); + LogInfo( ( "Demo completed successfully.\r\n" ) ); + LogInfo( ( "Short delay before starting the next iteration.... \r\n\r\n" ) ); + vTaskDelay( mqttexampleDELAY_BETWEEN_DEMO_ITERATIONS_TICKS ); + } +} +/*-----------------------------------------------------------*/ + +static TlsTransportStatus_t prvConnectToServerWithBackoffRetries( NetworkCredentials_t * pxNetworkCredentials, + NetworkContext_t * pxNetworkContext ) +{ + TlsTransportStatus_t xNetworkStatus; + RetryUtilsStatus_t xRetryUtilsStatus = RetryUtilsSuccess; + RetryUtilsParams_t xReconnectParams; + + /* Set the credentials for establishing a TLS connection. */ + pxNetworkCredentials->pRootCa = ( const unsigned char * ) democonfigROOT_CA_PEM; + pxNetworkCredentials->rootCaSize = sizeof( democonfigROOT_CA_PEM ); + pxNetworkCredentials->pClientCert = ( const unsigned char * ) democonfigCLIENT_CERTIFICATE_PEM; + pxNetworkCredentials->clientCertSize = sizeof( democonfigCLIENT_CERTIFICATE_PEM ); + pxNetworkCredentials->pPrivateKey = ( const unsigned char * ) democonfigCLIENT_PRIVATE_KEY_PEM; + pxNetworkCredentials->privateKeySize = sizeof( democonfigCLIENT_PRIVATE_KEY_PEM ); + + /* Initialize reconnect attempts and interval. */ + RetryUtils_ParamsReset( &xReconnectParams ); + xReconnectParams.maxRetryAttempts = MAX_RETRY_ATTEMPTS; + + /* Attempt to connect to MQTT broker. If connection fails, retry after + * a timeout. Timeout value will exponentially increase till maximum + * attempts are reached. + */ + do + { + /* Establish a TLS session with the MQTT broker. This example connects to + * the MQTT broker as specified in democonfigMQTT_BROKER_ENDPOINT and + * democonfigMQTT_BROKER_PORT at the top of this file. */ + LogInfo( ( "Creating a TLS connection to %s:%u.\r\n", + democonfigMQTT_BROKER_ENDPOINT, + democonfigMQTT_BROKER_PORT ) ); + /* Attempt to create a mutually authenticated TLS connection. */ + xNetworkStatus = TLS_FreeRTOS_Connect( pxNetworkContext, + democonfigMQTT_BROKER_ENDPOINT, + democonfigMQTT_BROKER_PORT, + pxNetworkCredentials, + mqttexampleTRANSPORT_SEND_RECV_TIMEOUT_MS, + mqttexampleTRANSPORT_SEND_RECV_TIMEOUT_MS ); + + if( xNetworkStatus != TLS_TRANSPORT_SUCCESS ) + { + LogWarn( ( "Connection to the broker failed. Retrying connection with backoff and jitter." ) ); + xRetryUtilsStatus = RetryUtils_BackoffAndSleep( &xReconnectParams ); + } + + if( xRetryUtilsStatus == RetryUtilsRetriesExhausted ) + { + LogError( ( "Connection to the broker failed, all attempts exhausted." ) ); + xNetworkStatus = TLS_TRANSPORT_CONNECT_FAILURE; + } + } while( ( xNetworkStatus != TLS_TRANSPORT_SUCCESS ) && ( xRetryUtilsStatus == RetryUtilsSuccess ) ); + + return xNetworkStatus; +} +/*-----------------------------------------------------------*/ + +static void prvCreateMQTTConnectionWithBroker( MQTTContext_t * pxMQTTContext, + NetworkContext_t * pxNetworkContext ) +{ + MQTTStatus_t xResult; + MQTTConnectInfo_t xConnectInfo; + bool xSessionPresent; + TransportInterface_t xTransport; + + /*** + * For readability, error handling in this function is restricted to the use of + * asserts(). + ***/ + + /* Fill in Transport Interface send and receive function pointers. */ + xTransport.pNetworkContext = pxNetworkContext; + xTransport.send = TLS_FreeRTOS_send; + xTransport.recv = TLS_FreeRTOS_recv; + + /* Initialize MQTT library. */ + xResult = MQTT_Init( pxMQTTContext, &xTransport, prvGetTimeMs, prvEventCallback, &xBuffer ); + configASSERT( xResult == MQTTSuccess ); + + /* Some fields are not used in this demo so start with everything at 0. */ + ( void ) memset( ( void * ) &xConnectInfo, 0x00, sizeof( xConnectInfo ) ); + + /* Start with a clean session i.e. direct the MQTT broker to discard any + * previous session data. Also, establishing a connection with clean session + * will ensure that the broker does not store any data when this client + * gets disconnected. */ + xConnectInfo.cleanSession = true; + + /* The client identifier is used to uniquely identify this MQTT client to + * the MQTT broker. In a production device the identifier can be something + * unique, such as a device serial number. */ + xConnectInfo.pClientIdentifier = democonfigCLIENT_IDENTIFIER; + xConnectInfo.clientIdentifierLength = ( uint16_t ) strlen( democonfigCLIENT_IDENTIFIER ); + + /* Set MQTT keep-alive period. If the application does not send packets at an interval less than + * the keep-alive period, the MQTT library will send PINGREQ packets. */ + xConnectInfo.keepAliveSeconds = mqttexampleKEEP_ALIVE_TIMEOUT_SECONDS; + + /* Send MQTT CONNECT packet to broker. LWT is not used in this demo, so it + * is passed as NULL. */ + xResult = MQTT_Connect( pxMQTTContext, + &xConnectInfo, + NULL, + mqttexampleCONNACK_RECV_TIMEOUT_MS, + &xSessionPresent ); + configASSERT( xResult == MQTTSuccess ); + + /* Successfully established and MQTT connection with the broker. */ + LogInfo( ( "An MQTT connection is established with %s.", democonfigMQTT_BROKER_ENDPOINT ) ); +} +/*-----------------------------------------------------------*/ + +static void prvUpdateSubAckStatus( MQTTPacketInfo_t * pxPacketInfo ) +{ + MQTTStatus_t xResult = MQTTSuccess; + uint8_t * pucPayload = NULL; + size_t ulSize = 0; + uint32_t ulTopicCount = 0U; + + xResult = MQTT_GetSubAckStatusCodes( pxPacketInfo, &pucPayload, &ulSize ); + + /* MQTT_GetSubAckStatusCodes always returns success if called with packet info + * from the event callback and non-NULL parameters. */ + configASSERT( xResult == MQTTSuccess ); + + for( ulTopicCount = 0; ulTopicCount < ulSize; ulTopicCount++ ) + { + xTopicFilterContext[ ulTopicCount ].xSubAckStatus = pucPayload[ ulTopicCount ]; + } +} +/*-----------------------------------------------------------*/ + +static void prvMQTTSubscribeWithBackoffRetries( MQTTContext_t * pxMQTTContext ) +{ + MQTTStatus_t xResult = MQTTSuccess; + RetryUtilsStatus_t xRetryUtilsStatus = RetryUtilsSuccess; + RetryUtilsParams_t xRetryParams; + MQTTSubscribeInfo_t xMQTTSubscription[ mqttexampleTOPIC_COUNT ]; + bool xFailedSubscribeToTopic = false; + uint32_t ulTopicCount = 0U; + + /* Some fields not used by this demo so start with everything at 0. */ + ( void ) memset( ( void * ) &xMQTTSubscription, 0x00, sizeof( xMQTTSubscription ) ); + + /* Get a unique packet id. */ + usSubscribePacketIdentifier = MQTT_GetPacketId( pxMQTTContext ); + + /* Subscribe to the mqttexampleTOPIC topic filter. This example subscribes to + * only one topic and uses QoS1. */ + xMQTTSubscription[ 0 ].qos = MQTTQoS1; + xMQTTSubscription[ 0 ].pTopicFilter = mqttexampleTOPIC; + xMQTTSubscription[ 0 ].topicFilterLength = ( uint16_t ) strlen( mqttexampleTOPIC ); + + /* Initialize retry attempts and interval. */ + RetryUtils_ParamsReset( &xRetryParams ); + xRetryParams.maxRetryAttempts = MAX_RETRY_ATTEMPTS; + + do + { + /* The client is now connected to the broker. Subscribe to the topic + * as specified in mqttexampleTOPIC at the top of this file by sending a + * subscribe packet then waiting for a subscribe acknowledgment (SUBACK). + * This client will then publish to the same topic it subscribed to, so it + * will expect all the messages it sends to the broker to be sent back to it + * from the broker. This demo uses QOS0 in Subscribe, therefore, the Publish + * messages received from the broker will have QOS0. */ + LogInfo( ( "Attempt to subscribe to the MQTT topic %s.\r\n", mqttexampleTOPIC ) ); + xResult = MQTT_Subscribe( pxMQTTContext, + xMQTTSubscription, + sizeof( xMQTTSubscription ) / sizeof( MQTTSubscribeInfo_t ), + usSubscribePacketIdentifier ); + configASSERT( xResult == MQTTSuccess ); + + LogInfo( ( "SUBSCRIBE sent for topic %s to broker.\n\n", mqttexampleTOPIC ) ); + + /* Process incoming packet from the broker. After sending the subscribe, the + * client may receive a publish before it receives a subscribe ack. Therefore, + * call generic incoming packet processing function. Since this demo is + * subscribing to the topic to which no one is publishing, probability of + * receiving Publish message before subscribe ack is zero; but application + * must be ready to receive any packet. This demo uses the generic packet + * processing function everywhere to highlight this fact. */ + xResult = MQTT_ProcessLoop( pxMQTTContext, mqttexamplePROCESS_LOOP_TIMEOUT_MS ); + configASSERT( xResult == MQTTSuccess ); + + /* Check if recent subscription request has been rejected. #xTopicFilterContext is updated + * in the event callback to reflect the status of the SUBACK sent by the broker. It represents + * either the QoS level granted by the server upon subscription, or acknowledgement of + * server rejection of the subscription request. */ + for( ulTopicCount = 0; ulTopicCount < mqttexampleTOPIC_COUNT; ulTopicCount++ ) + { + if( xTopicFilterContext[ ulTopicCount ].xSubAckStatus == MQTTSubAckFailure ) + { + LogWarn( ( "Server rejected subscription request. Attempting to re-subscribe to topic %s.", + xTopicFilterContext[ ulTopicCount ].pcTopicFilter ) ); + xFailedSubscribeToTopic = true; + xRetryUtilsStatus = RetryUtils_BackoffAndSleep( &xRetryParams ); + break; + } + } + + configASSERT( xRetryUtilsStatus != RetryUtilsRetriesExhausted ); + } while( ( xFailedSubscribeToTopic == true ) && ( xRetryUtilsStatus == RetryUtilsSuccess ) ); +} +/*-----------------------------------------------------------*/ + +static void prvMQTTPublishToTopic( MQTTContext_t * pxMQTTContext ) +{ + MQTTStatus_t xResult; + MQTTPublishInfo_t xMQTTPublishInfo; + + /*** + * For readability, error handling in this function is restricted to the use of + * asserts(). + ***/ + + /* Some fields are not used by this demo so start with everything at 0. */ + ( void ) memset( ( void * ) &xMQTTPublishInfo, 0x00, sizeof( xMQTTPublishInfo ) ); + + /* This demo uses QoS1. */ + xMQTTPublishInfo.qos = MQTTQoS1; + xMQTTPublishInfo.retain = false; + xMQTTPublishInfo.pTopicName = mqttexampleTOPIC; + xMQTTPublishInfo.topicNameLength = ( uint16_t ) strlen( mqttexampleTOPIC ); + xMQTTPublishInfo.pPayload = mqttexampleMESSAGE; + xMQTTPublishInfo.payloadLength = strlen( mqttexampleMESSAGE ); + + /* Get a unique packet id. */ + usPublishPacketIdentifier = MQTT_GetPacketId( pxMQTTContext ); + + /* Send PUBLISH packet. Packet ID is not used for a QoS1 publish. */ + xResult = MQTT_Publish( pxMQTTContext, &xMQTTPublishInfo, usPublishPacketIdentifier ); + + configASSERT( xResult == MQTTSuccess ); +} +/*-----------------------------------------------------------*/ + +static void prvMQTTUnsubscribeFromTopic( MQTTContext_t * pxMQTTContext ) +{ + MQTTStatus_t xResult; + MQTTSubscribeInfo_t xMQTTSubscription[ mqttexampleTOPIC_COUNT ]; + + /* Some fields not used by this demo so start with everything at 0. */ + ( void ) memset( ( void * ) &xMQTTSubscription, 0x00, sizeof( xMQTTSubscription ) ); + + /* Get a unique packet id. */ + usSubscribePacketIdentifier = MQTT_GetPacketId( pxMQTTContext ); + + /* Subscribe to the mqttexampleTOPIC topic filter. This example subscribes to + * only one topic and uses QoS1. */ + xMQTTSubscription[ 0 ].qos = MQTTQoS1; + xMQTTSubscription[ 0 ].pTopicFilter = mqttexampleTOPIC; + xMQTTSubscription[ 0 ].topicFilterLength = ( uint16_t ) strlen( mqttexampleTOPIC ); + + /* Get next unique packet identifier. */ + usUnsubscribePacketIdentifier = MQTT_GetPacketId( pxMQTTContext ); + + /* Send UNSUBSCRIBE packet. */ + xResult = MQTT_Unsubscribe( pxMQTTContext, + xMQTTSubscription, + sizeof( xMQTTSubscription ) / sizeof( MQTTSubscribeInfo_t ), + usUnsubscribePacketIdentifier ); + + configASSERT( xResult == MQTTSuccess ); +} +/*-----------------------------------------------------------*/ + +static void prvMQTTProcessResponse( MQTTPacketInfo_t * pxIncomingPacket, + uint16_t usPacketId ) +{ + uint32_t ulTopicCount = 0U; + + switch( pxIncomingPacket->type ) + { + case MQTT_PACKET_TYPE_PUBACK: + LogInfo( ( "PUBACK received for packet Id %u.\r\n", usPacketId ) ); + /* Make sure ACK packet identifier matches with Request packet identifier. */ + configASSERT( usPublishPacketIdentifier == usPacketId ); + break; + + case MQTT_PACKET_TYPE_SUBACK: + + /* A SUBACK from the broker, containing the server response to our subscription request, has been received. + * It contains the status code indicating server approval/rejection for the subscription to the single topic + * requested. The SUBACK will be parsed to obtain the status code, and this status code will be stored in global + * variable #xTopicFilterContext. */ + prvUpdateSubAckStatus( pxIncomingPacket ); + + for( ulTopicCount = 0; ulTopicCount < mqttexampleTOPIC_COUNT; ulTopicCount++ ) + { + if( xTopicFilterContext[ ulTopicCount ].xSubAckStatus != MQTTSubAckFailure ) + { + LogInfo( ( "Subscribed to the topic %s with maximum QoS %u.\r\n", + xTopicFilterContext[ ulTopicCount ].pcTopicFilter, + xTopicFilterContext[ ulTopicCount ].xSubAckStatus ) ); + } + } + + /* Make sure ACK packet identifier matches with Request packet identifier. */ + configASSERT( usSubscribePacketIdentifier == usPacketId ); + break; + + case MQTT_PACKET_TYPE_UNSUBACK: + LogInfo( ( "Unsubscribed from the topic %s.\r\n", mqttexampleTOPIC ) ); + /* Make sure ACK packet identifier matches with Request packet identifier. */ + configASSERT( usUnsubscribePacketIdentifier == usPacketId ); + break; + + case MQTT_PACKET_TYPE_PINGRESP: + LogInfo( ( "Ping Response successfully received.\r\n" ) ); + break; + + /* Any other packet type is invalid. */ + default: + LogWarn( ( "prvMQTTProcessResponse() called with unknown packet type:(%02X).\r\n", + pxIncomingPacket->type ) ); + } +} + +/*-----------------------------------------------------------*/ + +static void prvMQTTProcessIncomingPublish( MQTTPublishInfo_t * pxPublishInfo ) +{ + configASSERT( pxPublishInfo != NULL ); + + /* Process incoming Publish. */ + LogInfo( ( "Incoming QoS : %d\n", pxPublishInfo->qos ) ); + + /* Verify the received publish is for the we have subscribed to. */ + if( ( pxPublishInfo->topicNameLength == strlen( mqttexampleTOPIC ) ) && + ( 0 == strncmp( mqttexampleTOPIC, pxPublishInfo->pTopicName, pxPublishInfo->topicNameLength ) ) ) + { + LogInfo( ( "\r\nIncoming Publish Topic Name: %.*s matches subscribed topic.\r\n" + "Incoming Publish Message : %.*s\r\n", + pxPublishInfo->topicNameLength, + pxPublishInfo->pTopicName, + pxPublishInfo->payloadLength, + pxPublishInfo->pPayload ) ); + } + else + { + LogInfo( ( "Incoming Publish Topic Name: %.*s does not match subscribed topic.\r\n", + pxPublishInfo->topicNameLength, + pxPublishInfo->pTopicName ) ); + } +} + +/*-----------------------------------------------------------*/ + +static void prvEventCallback( MQTTContext_t * pxMQTTContext, + MQTTPacketInfo_t * pxPacketInfo, + MQTTDeserializedInfo_t * pxDeserializedInfo ) +{ + /* The MQTT context is not used for this demo. */ + ( void ) pxMQTTContext; + + if( ( pxPacketInfo->type & 0xF0U ) == MQTT_PACKET_TYPE_PUBLISH ) + { + prvMQTTProcessIncomingPublish( pxDeserializedInfo->pPublishInfo ); + } + else + { + prvMQTTProcessResponse( pxPacketInfo, pxDeserializedInfo->packetIdentifier ); + } +} + +/*-----------------------------------------------------------*/ + +static uint32_t prvGetTimeMs( void ) +{ + TickType_t xTickCount = 0; + uint32_t ulTimeMs = 0UL; + + /* Get the current tick count. */ + xTickCount = xTaskGetTickCount(); + + /* Convert the ticks to milliseconds. */ + ulTimeMs = ( uint32_t ) xTickCount * _MILLISECONDS_PER_TICK; + + /* Reduce ulGlobalEntryTimeMs from obtained time so as to always return the + * elapsed time in the application. */ + ulTimeMs = ( uint32_t ) ( ulTimeMs - ulGlobalEntryTimeMs ); + + return ulTimeMs; +} + +/*-----------------------------------------------------------*/ diff --git a/FreeRTOS-Plus/Demo/coreMQTT_Windows_Simulator/MQTT_Mutual_Auth/FreeRTOSConfig.h b/FreeRTOS-Plus/Demo/coreMQTT_Windows_Simulator/MQTT_Mutual_Auth/FreeRTOSConfig.h new file mode 100644 index 0000000000..b3fd067b99 --- /dev/null +++ b/FreeRTOS-Plus/Demo/coreMQTT_Windows_Simulator/MQTT_Mutual_Auth/FreeRTOSConfig.h @@ -0,0 +1,214 @@ +/* + * FreeRTOS Kernel V10.3.0 + * 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. + * + * http://www.FreeRTOS.org + * http://aws.amazon.com/freertos + */ + +#ifndef FREERTOS_CONFIG_H +#define FREERTOS_CONFIG_H + +/*----------------------------------------------------------- +* Application specific definitions. +* +* These definitions should be adjusted for your particular hardware and +* application requirements. +* +* THESE PARAMETERS ARE DESCRIBED WITHIN THE 'CONFIGURATION' SECTION OF THE +* FreeRTOS API DOCUMENTATION AVAILABLE ON THE FreeRTOS.org WEB SITE. +* http://www.freertos.org/a00110.html +* +* The bottom of this file contains some constants specific to running the UDP +* stack in this demo. Constants specific to FreeRTOS+TCP itself (rather than +* the demo) are contained in FreeRTOSIPConfig.h. +*----------------------------------------------------------*/ +#define configUSE_PREEMPTION 1 +#define configUSE_PORT_OPTIMISED_TASK_SELECTION 1 +#define configMAX_PRIORITIES ( 7 ) +#define configTICK_RATE_HZ ( 1000 ) /* In this non-real time simulated environment the tick frequency has to be at least a multiple of the Win32 tick frequency, and therefore very slow. */ +#define configMINIMAL_STACK_SIZE ( ( unsigned short ) 60 ) /* In this simulated case, the stack only has to hold one small structure as the real stack is part of the Win32 thread. */ +#define configTOTAL_HEAP_SIZE ( ( size_t ) ( 2048U * 1024U ) ) +#define configMAX_TASK_NAME_LEN ( 15 ) +#define configUSE_TRACE_FACILITY 0 +#define configUSE_16_BIT_TICKS 0 +#define configIDLE_SHOULD_YIELD 1 +#define configUSE_CO_ROUTINES 0 +#define configUSE_MUTEXES 1 +#define configUSE_RECURSIVE_MUTEXES 1 +#define configQUEUE_REGISTRY_SIZE 0 +#define configUSE_APPLICATION_TASK_TAG 0 +#define configUSE_COUNTING_SEMAPHORES 1 +#define configUSE_ALTERNATIVE_API 0 +#define configNUM_THREAD_LOCAL_STORAGE_POINTERS 0 +#define configENABLE_BACKWARD_COMPATIBILITY 1 +#define configSUPPORT_STATIC_ALLOCATION 1 + +/* Hook function related definitions. */ +#define configUSE_TICK_HOOK 0 +#define configUSE_IDLE_HOOK 0 +#define configUSE_MALLOC_FAILED_HOOK 0 +#define configCHECK_FOR_STACK_OVERFLOW 0 /* Not applicable to the Win32 port. */ + +/* Software timer related definitions. */ +#define configUSE_TIMERS 1 +#define configTIMER_TASK_PRIORITY ( configMAX_PRIORITIES - 1 ) +#define configTIMER_QUEUE_LENGTH 5 +#define configTIMER_TASK_STACK_DEPTH ( configMINIMAL_STACK_SIZE * 2 ) + +/* Event group related definitions. */ +#define configUSE_EVENT_GROUPS 1 + +/* Run time stats gathering configuration options. */ +#define configGENERATE_RUN_TIME_STATS 0 + +/* Co-routine definitions. */ +#define configUSE_CO_ROUTINES 0 +#define configMAX_CO_ROUTINE_PRIORITIES ( 2 ) + +/* Set the following definitions to 1 to include the API function, or zero + * to exclude the API function. */ +#define INCLUDE_vTaskPrioritySet 1 +#define INCLUDE_uxTaskPriorityGet 1 +#define INCLUDE_vTaskDelete 1 +#define INCLUDE_vTaskCleanUpResources 0 +#define INCLUDE_vTaskSuspend 1 +#define INCLUDE_vTaskDelayUntil 1 +#define INCLUDE_vTaskDelay 1 +#define INCLUDE_uxTaskGetStackHighWaterMark 1 +#define INCLUDE_xTaskGetSchedulerState 1 +#define INCLUDE_xTimerGetTimerTaskHandle 0 +#define INCLUDE_xTaskGetIdleTaskHandle 0 +#define INCLUDE_xQueueGetMutexHolder 1 +#define INCLUDE_eTaskGetState 1 +#define INCLUDE_xEventGroupSetBitsFromISR 1 +#define INCLUDE_xTimerPendFunctionCall 1 +#define INCLUDE_pcTaskGetTaskName 1 + +/* This demo makes use of one or more example stats formatting functions. These + * format the raw data provided by the uxTaskGetSystemState() function in to human + * readable ASCII form. See the notes in the implementation of vTaskList() within + * FreeRTOS/Source/tasks.c for limitations. configUSE_STATS_FORMATTING_FUNCTIONS + * is set to 2 so the formatting functions are included without the stdio.h being + * included in tasks.c. That is because this project defines its own sprintf() + * functions. */ +#define configUSE_STATS_FORMATTING_FUNCTIONS 1 + +/* Assert call defined for debug builds. */ +#ifdef _DEBUG + extern void vAssertCalled( const char * pcFile, + uint32_t ulLine ); + #define configASSERT( x ) if( ( x ) == 0 ) vAssertCalled( __FILE__, __LINE__ ) +#endif /* _DEBUG */ + + + +/* Application specific definitions follow. **********************************/ + +/* Only used when running in the FreeRTOS Windows simulator. Defines the + * priority of the task used to simulate Ethernet interrupts. */ +#define configMAC_ISR_SIMULATOR_PRIORITY ( configMAX_PRIORITIES - 1 ) + +/* This demo creates a virtual network connection by accessing the raw Ethernet + * or WiFi data to and from a real network connection. Many computers have more + * than one real network port, and configNETWORK_INTERFACE_TO_USE is used to tell + * the demo which real port should be used to create the virtual port. The ports + * available are displayed on the console when the application is executed. For + * example, on my development laptop setting configNETWORK_INTERFACE_TO_USE to 4 + * results in the wired network being used, while setting + * configNETWORK_INTERFACE_TO_USE to 2 results in the wireless network being + * used. */ +#define configNETWORK_INTERFACE_TO_USE 1L + +/* The address to which logging is sent should UDP logging be enabled. */ +#define configUDP_LOGGING_ADDR0 192 +#define configUDP_LOGGING_ADDR1 168 +#define configUDP_LOGGING_ADDR2 0 +#define configUDP_LOGGING_ADDR3 11 + +/* Default MAC address configuration. The demo creates a virtual network + * connection that uses this MAC address by accessing the raw Ethernet/WiFi data + * to and from a real network connection on the host PC. See the + * configNETWORK_INTERFACE_TO_USE definition above for information on how to + * configure the real network connection to use. */ +#define configMAC_ADDR0 0x00 +#define configMAC_ADDR1 0x11 +#define configMAC_ADDR2 0x11 +#define configMAC_ADDR3 0x11 +#define configMAC_ADDR4 0x11 +#define configMAC_ADDR5 0x41 + +/* Default IP address configuration. Used in ipconfigUSE_DNS is set to 0, or + * ipconfigUSE_DNS is set to 1 but a DNS server cannot be contacted. */ +#define configIP_ADDR0 10 +#define configIP_ADDR1 10 +#define configIP_ADDR2 10 +#define configIP_ADDR3 200 + +/* Default gateway IP address configuration. Used in ipconfigUSE_DNS is set to + * 0, or ipconfigUSE_DNS is set to 1 but a DNS server cannot be contacted. */ +#define configGATEWAY_ADDR0 10 +#define configGATEWAY_ADDR1 10 +#define configGATEWAY_ADDR2 10 +#define configGATEWAY_ADDR3 1 + +/* Default DNS server configuration. OpenDNS addresses are 208.67.222.222 and + * 208.67.220.220. Used in ipconfigUSE_DNS is set to 0, or ipconfigUSE_DNS is set + * to 1 but a DNS server cannot be contacted.*/ +#define configDNS_SERVER_ADDR0 208 +#define configDNS_SERVER_ADDR1 67 +#define configDNS_SERVER_ADDR2 222 +#define configDNS_SERVER_ADDR3 222 + +/* Default netmask configuration. Used in ipconfigUSE_DNS is set to 0, or + * ipconfigUSE_DNS is set to 1 but a DNS server cannot be contacted. */ +#define configNET_MASK0 255 +#define configNET_MASK1 0 +#define configNET_MASK2 0 +#define configNET_MASK3 0 + +/* The UDP port to which print messages are sent. */ +#define configPRINT_PORT ( 15000 ) + +/* Task pool definitions for the demos of IoT Libraries. */ +#define configTASKPOOL_ENABLE_ASSERTS 1 +#define configTASKPOOL_NUMBER_OF_WORKERS 1 +#define configTASKPOOL_WORKER_PRIORITY tskIDLE_PRIORITY +#define configTASKPOOL_WORKER_STACK_SIZE_BYTES 2048 + +#if ( defined( _MSC_VER ) && ( _MSC_VER <= 1600 ) && !defined( snprintf ) ) + /* Map to Windows names. */ + #define snprintf _snprintf + #define vsnprintf _vsnprintf +#endif + +/* Visual studio does not have an implementation of strcasecmp(). */ +#define strcasecmp _stricmp +#define strncasecmp _strnicmp +#define strcmpi _strcmpi + +/* Prototype for the function used to print out. In this case it prints to the + * console before the network is connected then a UDP port after the network has + * connected. */ +extern void vLoggingPrintf( const char * pcFormatString, + ... ); +#define configPRINTF( X ) vLoggingPrintf X + +#endif /* FREERTOS_CONFIG_H */ diff --git a/FreeRTOS-Plus/Demo/coreMQTT_Windows_Simulator/MQTT_Mutual_Auth/FreeRTOSIPConfig.h b/FreeRTOS-Plus/Demo/coreMQTT_Windows_Simulator/MQTT_Mutual_Auth/FreeRTOSIPConfig.h new file mode 100644 index 0000000000..194c62ac5e --- /dev/null +++ b/FreeRTOS-Plus/Demo/coreMQTT_Windows_Simulator/MQTT_Mutual_Auth/FreeRTOSIPConfig.h @@ -0,0 +1,309 @@ +/* + * FreeRTOS Kernel V10.3.0 + * 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. + * + * http://www.FreeRTOS.org + * http://aws.amazon.com/freertos + */ + + +/***************************************************************************** +* +* See the following URL for configuration information. +* http://www.freertos.org/FreeRTOS-Plus/FreeRTOS_Plus_TCP/TCP_IP_Configuration.html +* +*****************************************************************************/ + +#ifndef FREERTOS_IP_CONFIG_H +#define FREERTOS_IP_CONFIG_H + +/* Prototype for the function used to print out. In this case it prints to the + * console before the network is connected then a UDP port after the network has + * connected. */ +extern void vLoggingPrintf( const char * pcFormatString, + ... ); + +/* Set to 1 to print out debug messages. If ipconfigHAS_DEBUG_PRINTF is set to + * 1 then FreeRTOS_debug_printf should be defined to the function used to print + * out the debugging messages. */ +#define ipconfigHAS_DEBUG_PRINTF 0 +#if ( ipconfigHAS_DEBUG_PRINTF == 1 ) + #define FreeRTOS_debug_printf( X ) vLoggingPrintf X +#endif + +/* Set to 1 to print out non debugging messages, for example the output of the + * FreeRTOS_netstat() command, and ping replies. If ipconfigHAS_PRINTF is set to 1 + * then FreeRTOS_printf should be set to the function used to print out the + * messages. */ +#define ipconfigHAS_PRINTF 1 +#if ( ipconfigHAS_PRINTF == 1 ) + #define FreeRTOS_printf( X ) vLoggingPrintf X +#endif + +/* Define the byte order of the target MCU (the MCU FreeRTOS+TCP is executing + * on). Valid options are pdFREERTOS_BIG_ENDIAN and pdFREERTOS_LITTLE_ENDIAN. */ +#define ipconfigBYTE_ORDER pdFREERTOS_LITTLE_ENDIAN + +/* If the network card/driver includes checksum offloading (IP/TCP/UDP checksums) + * then set ipconfigDRIVER_INCLUDED_RX_IP_CHECKSUM to 1 to prevent the software + * stack repeating the checksum calculations. */ +#define ipconfigDRIVER_INCLUDED_RX_IP_CHECKSUM 1 + +/* Several API's will block until the result is known, or the action has been + * performed, for example FreeRTOS_send() and FreeRTOS_recv(). The timeouts can be + * set per socket, using setsockopt(). If not set, the times below will be + * used as defaults. */ +#define ipconfigSOCK_DEFAULT_RECEIVE_BLOCK_TIME ( 2000 ) +#define ipconfigSOCK_DEFAULT_SEND_BLOCK_TIME ( 5000 ) + +/* Include support for LLMNR: Link-local Multicast Name Resolution + * (non-Microsoft) */ +#define ipconfigUSE_LLMNR ( 0 ) + +/* Include support for NBNS: NetBIOS Name Service (Microsoft) */ +#define ipconfigUSE_NBNS ( 0 ) + +/* Include support for DNS caching. For TCP, having a small DNS cache is very + * useful. When a cache is present, ipconfigDNS_REQUEST_ATTEMPTS can be kept low + * and also DNS may use small timeouts. If a DNS reply comes in after the DNS + * socket has been destroyed, the result will be stored into the cache. The next + * call to FreeRTOS_gethostbyname() will return immediately, without even creating + * a socket. */ +#define ipconfigUSE_DNS_CACHE ( 1 ) +#define ipconfigDNS_CACHE_NAME_LENGTH ( 64 ) +#define ipconfigDNS_CACHE_ENTRIES ( 4 ) +#define ipconfigDNS_REQUEST_ATTEMPTS ( 2 ) + +/* The IP stack executes it its own task (although any application task can make + * use of its services through the published sockets API). ipconfigUDP_TASK_PRIORITY + * sets the priority of the task that executes the IP stack. The priority is a + * standard FreeRTOS task priority so can take any value from 0 (the lowest + * priority) to (configMAX_PRIORITIES - 1) (the highest priority). + * configMAX_PRIORITIES is a standard FreeRTOS configuration parameter defined in + * FreeRTOSConfig.h, not FreeRTOSIPConfig.h. Consideration needs to be given as to + * the priority assigned to the task executing the IP stack relative to the + * priority assigned to tasks that use the IP stack. */ +#define ipconfigIP_TASK_PRIORITY ( configMAX_PRIORITIES - 2 ) + +/* The size, in words (not bytes), of the stack allocated to the FreeRTOS+TCP + * task. This setting is less important when the FreeRTOS Win32 simulator is used + * as the Win32 simulator only stores a fixed amount of information on the task + * stack. FreeRTOS includes optional stack overflow detection, see: + * http://www.freertos.org/Stacks-and-stack-overflow-checking.html */ +#define ipconfigIP_TASK_STACK_SIZE_WORDS ( configMINIMAL_STACK_SIZE * 5 ) + +/* ipconfigRAND32() is called by the IP stack to generate random numbers for + * things such as a DHCP transaction number or initial sequence number. Random + * number generation is performed via this macro to allow applications to use their + * own random number generation method. For example, it might be possible to + * generate a random number by sampling noise on an analogue input. */ +extern UBaseType_t uxRand(); +#define ipconfigRAND32() uxRand() + +/* If ipconfigUSE_NETWORK_EVENT_HOOK is set to 1 then FreeRTOS+TCP will call the + * network event hook at the appropriate times. If ipconfigUSE_NETWORK_EVENT_HOOK + * is not set to 1 then the network event hook will never be called. See + * http://www.FreeRTOS.org/FreeRTOS-Plus/FreeRTOS_Plus_UDP/API/vApplicationIPNetworkEventHook.shtml + */ +#define ipconfigUSE_NETWORK_EVENT_HOOK 1 + +/* Sockets have a send block time attribute. If FreeRTOS_sendto() is called but + * a network buffer cannot be obtained then the calling task is held in the Blocked + * state (so other tasks can continue to executed) until either a network buffer + * becomes available or the send block time expires. If the send block time expires + * then the send operation is aborted. The maximum allowable send block time is + * capped to the value set by ipconfigMAX_SEND_BLOCK_TIME_TICKS. Capping the + * maximum allowable send block time prevents prevents a deadlock occurring when + * all the network buffers are in use and the tasks that process (and subsequently + * free) the network buffers are themselves blocked waiting for a network buffer. + * ipconfigMAX_SEND_BLOCK_TIME_TICKS is specified in RTOS ticks. A time in + * milliseconds can be converted to a time in ticks by dividing the time in + * milliseconds by portTICK_PERIOD_MS. */ +#define ipconfigUDP_MAX_SEND_BLOCK_TIME_TICKS ( 5000 / portTICK_PERIOD_MS ) + +/* If ipconfigUSE_DHCP is 1 then FreeRTOS+TCP will attempt to retrieve an IP + * address, netmask, DNS server address and gateway address from a DHCP server. If + * ipconfigUSE_DHCP is 0 then FreeRTOS+TCP will use a static IP address. The + * stack will revert to using the static IP address even when ipconfigUSE_DHCP is + * set to 1 if a valid configuration cannot be obtained from a DHCP server for any + * reason. The static configuration used is that passed into the stack by the + * FreeRTOS_IPInit() function call. */ +#define ipconfigUSE_DHCP 1 + +/* When ipconfigUSE_DHCP is set to 1, DHCP requests will be sent out at + * increasing time intervals until either a reply is received from a DHCP server + * and accepted, or the interval between transmissions reaches + * ipconfigMAXIMUM_DISCOVER_TX_PERIOD. The IP stack will revert to using the + * static IP address passed as a parameter to FreeRTOS_IPInit() if the + * re-transmission time interval reaches ipconfigMAXIMUM_DISCOVER_TX_PERIOD without + * a DHCP reply being received. */ +#define ipconfigMAXIMUM_DISCOVER_TX_PERIOD ( 120000 / portTICK_PERIOD_MS ) + +/* The ARP cache is a table that maps IP addresses to MAC addresses. The IP + * stack can only send a UDP message to a remove IP address if it knowns the MAC + * address associated with the IP address, or the MAC address of the router used to + * contact the remote IP address. When a UDP message is received from a remote IP + * address the MAC address and IP address are added to the ARP cache. When a UDP + * message is sent to a remote IP address that does not already appear in the ARP + * cache then the UDP message is replaced by a ARP message that solicits the + * required MAC address information. ipconfigARP_CACHE_ENTRIES defines the maximum + * number of entries that can exist in the ARP table at any one time. */ +#define ipconfigARP_CACHE_ENTRIES 6 + +/* ARP requests that do not result in an ARP response will be re-transmitted a + * maximum of ipconfigMAX_ARP_RETRANSMISSIONS times before the ARP request is + * aborted. */ +#define ipconfigMAX_ARP_RETRANSMISSIONS ( 5 ) + +/* ipconfigMAX_ARP_AGE defines the maximum time between an entry in the ARP + * table being created or refreshed and the entry being removed because it is stale. + * New ARP requests are sent for ARP cache entries that are nearing their maximum + * age. ipconfigMAX_ARP_AGE is specified in tens of seconds, so a value of 150 is + * equal to 1500 seconds (or 25 minutes). */ +#define ipconfigMAX_ARP_AGE 150 + +/* Implementing FreeRTOS_inet_addr() necessitates the use of string handling + * routines, which are relatively large. To save code space the full + * FreeRTOS_inet_addr() implementation is made optional, and a smaller and faster + * alternative called FreeRTOS_inet_addr_quick() is provided. FreeRTOS_inet_addr() + * takes an IP in decimal dot format (for example, "192.168.0.1") as its parameter. + * FreeRTOS_inet_addr_quick() takes an IP address as four separate numerical octets + * (for example, 192, 168, 0, 1) as its parameters. If + * ipconfigINCLUDE_FULL_INET_ADDR is set to 1 then both FreeRTOS_inet_addr() and + * FreeRTOS_indet_addr_quick() are available. If ipconfigINCLUDE_FULL_INET_ADDR is + * not set to 1 then only FreeRTOS_indet_addr_quick() is available. */ +#define ipconfigINCLUDE_FULL_INET_ADDR 1 + +/* ipconfigNUM_NETWORK_BUFFER_DESCRIPTORS defines the total number of network buffer that + * are available to the IP stack. The total number of network buffers is limited + * to ensure the total amount of RAM that can be consumed by the IP stack is capped + * to a pre-determinable value. */ +#define ipconfigNUM_NETWORK_BUFFER_DESCRIPTORS 60 + +/* A FreeRTOS queue is used to send events from application tasks to the IP + * stack. ipconfigEVENT_QUEUE_LENGTH sets the maximum number of events that can + * be queued for processing at any one time. The event queue must be a minimum of + * 5 greater than the total number of network buffers. */ +#define ipconfigEVENT_QUEUE_LENGTH ( ipconfigNUM_NETWORK_BUFFER_DESCRIPTORS + 5 ) + +/* The address of a socket is the combination of its IP address and its port + * number. FreeRTOS_bind() is used to manually allocate a port number to a socket + * (to 'bind' the socket to a port), but manual binding is not normally necessary + * for client sockets (those sockets that initiate outgoing connections rather than + * wait for incoming connections on a known port number). If + * ipconfigALLOW_SOCKET_SEND_WITHOUT_BIND is set to 1 then calling + * FreeRTOS_sendto() on a socket that has not yet been bound will result in the IP + * stack automatically binding the socket to a port number from the range + * socketAUTO_PORT_ALLOCATION_START_NUMBER to 0xffff. If + * ipconfigALLOW_SOCKET_SEND_WITHOUT_BIND is set to 0 then calling FreeRTOS_sendto() + * on a socket that has not yet been bound will result in the send operation being + * aborted. */ +#define ipconfigALLOW_SOCKET_SEND_WITHOUT_BIND 1 + +/* Defines the Time To Live (TTL) values used in outgoing UDP packets. */ +#define ipconfigUDP_TIME_TO_LIVE 128 +#define ipconfigTCP_TIME_TO_LIVE 128 /* also defined in FreeRTOSIPConfigDefaults.h */ + +/* USE_TCP: Use TCP and all its features */ +#define ipconfigUSE_TCP ( 1 ) + +/* Use the TCP socket wake context with a callback. */ +#define ipconfigSOCKET_HAS_USER_WAKE_CALLBACK_WITH_CONTEXT ( 1 ) + +/* USE_WIN: Let TCP use windowing mechanism. */ +#define ipconfigUSE_TCP_WIN ( 1 ) + +/* The MTU is the maximum number of bytes the payload of a network frame can + * contain. For normal Ethernet V2 frames the maximum MTU is 1500. Setting a + * lower value can save RAM, depending on the buffer management scheme used. If + * ipconfigCAN_FRAGMENT_OUTGOING_PACKETS is 1 then (ipconfigNETWORK_MTU - 28) must + * be divisible by 8. */ +#define ipconfigNETWORK_MTU 1200 + +/* Set ipconfigUSE_DNS to 1 to include a basic DNS client/resolver. DNS is used + * through the FreeRTOS_gethostbyname() API function. */ +#define ipconfigUSE_DNS 1 + +/* If ipconfigREPLY_TO_INCOMING_PINGS is set to 1 then the IP stack will + * generate replies to incoming ICMP echo (ping) requests. */ +#define ipconfigREPLY_TO_INCOMING_PINGS 1 + +/* If ipconfigSUPPORT_OUTGOING_PINGS is set to 1 then the + * FreeRTOS_SendPingRequest() API function is available. */ +#define ipconfigSUPPORT_OUTGOING_PINGS 0 + +/* If ipconfigSUPPORT_SELECT_FUNCTION is set to 1 then the FreeRTOS_select() + * (and associated) API function is available. */ +#define ipconfigSUPPORT_SELECT_FUNCTION 1 + +/* If ipconfigFILTER_OUT_NON_ETHERNET_II_FRAMES is set to 1 then Ethernet frames + * that are not in Ethernet II format will be dropped. This option is included for + * potential future IP stack developments. */ +#define ipconfigFILTER_OUT_NON_ETHERNET_II_FRAMES 1 + +/* If ipconfigETHERNET_DRIVER_FILTERS_FRAME_TYPES is set to 1 then it is the + * responsibility of the Ethernet interface to filter out packets that are of no + * interest. If the Ethernet interface does not implement this functionality, then + * set ipconfigETHERNET_DRIVER_FILTERS_FRAME_TYPES to 0 to have the IP stack + * perform the filtering instead (it is much less efficient for the stack to do it + * because the packet will already have been passed into the stack). If the + * Ethernet driver does all the necessary filtering in hardware then software + * filtering can be removed by using a value other than 1 or 0. */ +#define ipconfigETHERNET_DRIVER_FILTERS_FRAME_TYPES 1 + +/* The windows simulator cannot really simulate MAC interrupts, and needs to + * block occasionally to allow other tasks to run. */ +#define configWINDOWS_MAC_INTERRUPT_SIMULATOR_DELAY ( 20 / portTICK_PERIOD_MS ) + +/* Advanced only: in order to access 32-bit fields in the IP packets with + * 32-bit memory instructions, all packets will be stored 32-bit-aligned, plus 16-bits. + * This has to do with the contents of the IP-packets: all 32-bit fields are + * 32-bit-aligned, plus 16-bit(!) */ +#define ipconfigPACKET_FILLER_SIZE 2 + +/* Define the size of the pool of TCP window descriptors. On the average, each + * TCP socket will use up to 2 x 6 descriptors, meaning that it can have 2 x 6 + * outstanding packets (for Rx and Tx). When using up to 10 TP sockets + * simultaneously, one could define TCP_WIN_SEG_COUNT as 120. */ +#define ipconfigTCP_WIN_SEG_COUNT 240 + +/* Each TCP socket has a circular buffers for Rx and Tx, which have a fixed + * maximum size. Define the size of Rx buffer for TCP sockets. */ +#define ipconfigTCP_RX_BUFFER_LENGTH ( 1000 ) + +/* Define the size of Tx buffer for TCP sockets. */ +#define ipconfigTCP_TX_BUFFER_LENGTH ( 1000 ) + +/* When using call-back handlers, the driver may check if the handler points to + * real program memory (RAM or flash) or just has a random non-zero value. */ +#define ipconfigIS_VALID_PROG_ADDRESS( x ) ( ( x ) != NULL ) + +/* Include support for TCP hang protection. All sockets in a connecting or + * disconnecting stage will timeout after a period of non-activity. */ +#define ipconfigTCP_HANG_PROTECTION ( 1 ) +#define ipconfigTCP_HANG_PROTECTION_TIME ( 30 ) + +/* Include support for TCP keep-alive messages. */ +#define ipconfigTCP_KEEP_ALIVE ( 1 ) +#define ipconfigTCP_KEEP_ALIVE_INTERVAL ( 20 ) /* in seconds */ + +#define portINLINE __inline + +#endif /* FREERTOS_IP_CONFIG_H */ diff --git a/FreeRTOS-Plus/Demo/coreMQTT_Windows_Simulator/MQTT_Mutual_Auth/READ_ME_INSTRUCTIONS.url b/FreeRTOS-Plus/Demo/coreMQTT_Windows_Simulator/MQTT_Mutual_Auth/READ_ME_INSTRUCTIONS.url new file mode 100644 index 0000000000..cddcf75a4d --- /dev/null +++ b/FreeRTOS-Plus/Demo/coreMQTT_Windows_Simulator/MQTT_Mutual_Auth/READ_ME_INSTRUCTIONS.url @@ -0,0 +1,5 @@ +[{000214A0-0000-0000-C000-000000000046}] +Prop3=19,11 +[InternetShortcut] +IDList= +URL=https://www.freertos.org/mqtt_lts/ diff --git a/FreeRTOS-Plus/Demo/coreMQTT_Windows_Simulator/MQTT_Mutual_Auth/WIN32.vcxproj b/FreeRTOS-Plus/Demo/coreMQTT_Windows_Simulator/MQTT_Mutual_Auth/WIN32.vcxproj new file mode 100644 index 0000000000..f1bc9c3db2 --- /dev/null +++ b/FreeRTOS-Plus/Demo/coreMQTT_Windows_Simulator/MQTT_Mutual_Auth/WIN32.vcxproj @@ -0,0 +1,614 @@ + + + + + Debug + Win32 + + + Release + Win32 + + + + {C686325E-3261-42F7-AEB1-DDE5280E1CEB} + RTOSDemo + 10.0 + + + + Application + false + MultiByte + v142 + + + Application + false + MultiByte + v142 + + + + + + + + + + + + + + + <_ProjectFileVersion>10.0.30319.1 + .\Debug\ + .\Debug\ + true + .\Release\ + .\Release\ + false + AllRules.ruleset + + + + .\Debug/WIN32.tlb + + + + + Disabled + ..\..\..\..\Source\FreeRTOS-Plus-Trace\Include;..\..\..\..\FreeRTOS-Plus\Source\FreeRTOS-Plus-TCP\include;..\..\..\..\FreeRTOS-Plus\Source\FreeRTOS-Plus-TCP\portable\BufferManagement;..\..\..\..\FreeRTOS-Plus\Source\FreeRTOS-Plus-TCP\portable\Compiler\MSVC;..\..\Common\Logging;..\common\WinPCap;..\..\..\..\FreeRTOS\Source\include;..\..\..\..\FreeRTOS\Source\portable\MSVC-MingW;..\..\..\Source\Application-Protocols\coreMQTT\source\include;..\..\..\Source\Application-Protocols\platform\include;..\..\..\Source\Application-Protocols\platform\freertos\transport\include;..\..\..\Source\Application-Protocols\platform\freertos\mbedtls;..\..\..\..\Source\mbedtls_utils;..\..\..\ThirdParty\mbedtls\include;.;%(AdditionalIncludeDirectories) + MBEDTLS_CONFIG_FILE="mbedtls_config.h";WIN32;_DEBUG;_CONSOLE;_WIN32_WINNT=0x0500;WINVER=0x400;_CRT_SECURE_NO_WARNINGS;%(PreprocessorDefinitions) + false + EnableFastChecks + MultiThreadedDLL + .\Debug/WIN32.pch + .\Debug/ + .\Debug/ + .\Debug/ + Level4 + true + false + EditAndContinue + /wd4210 /wd4127 /wd4214 /wd4201 /wd4244 /wd4310 /wd4200 %(AdditionalOptions) + true + NotUsing + false + CompileAsC + + + _DEBUG;%(PreprocessorDefinitions) + 0x0c09 + + + .\Debug/RTOSDemo.exe + true + true + .\Debug/WIN32.pdb + Console + MachineX86 + wpcap.lib;Bcrypt.lib;%(AdditionalDependencies) + ..\Common\WinPCap + false + false + + + true + .\Debug/WIN32.bsc + + + + + .\Release/WIN32.tlb + + + + + MaxSpeed + OnlyExplicitInline + _WINSOCKAPI_;WIN32;NDEBUG;_CONSOLE;_CRT_SECURE_NO_WARNINGS;%(PreprocessorDefinitions) + true + MultiThreaded + true + .\Release/WIN32.pch + .\Release/ + .\Release/ + .\Release/ + Level3 + true + ..\Common\Utils;..\Common\ethernet\lwip-1.4.0\ports\win32\WinPCap;..\Common\ethernet\lwip-1.4.0\src\include\ipv4;..\Common\ethernet\lwip-1.4.0\src\include;..\..\..\Source\include;..\..\..\Source\portable\MSVC-MingW;..\Common\ethernet\lwip-1.4.0\ports\win32\include;..\Common\Include;.\lwIP_Apps;.;%(AdditionalIncludeDirectories) + + + NDEBUG;%(PreprocessorDefinitions) + 0x0c09 + + + .\Release/RTOSDemo.exe + true + .\Release/WIN32.pdb + Console + MachineX86 + ..\Common\ethernet\lwip-1.4.0\ports\win32\WinPCap + wpcap.lib;Bcrypt.lib;%(AdditionalDependencies) + + + true + .\Release/WIN32.bsc + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + TurnOffAllWarnings + TurnOffAllWarnings + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/FreeRTOS-Plus/Demo/coreMQTT_Windows_Simulator/MQTT_Mutual_Auth/WIN32.vcxproj.filters b/FreeRTOS-Plus/Demo/coreMQTT_Windows_Simulator/MQTT_Mutual_Auth/WIN32.vcxproj.filters new file mode 100644 index 0000000000..69c33ff415 --- /dev/null +++ b/FreeRTOS-Plus/Demo/coreMQTT_Windows_Simulator/MQTT_Mutual_Auth/WIN32.vcxproj.filters @@ -0,0 +1,749 @@ + + + + + {af3445a1-4908-4170-89ed-39345d90d30c} + + + {f32be356-4763-4cae-9020-974a2638cb08} + *.c + + + {88f409e6-d396-4ac5-94bd-7a99c914be46} + + + {e5ad4ec7-23dc-4295-8add-2acaee488f5a} + + + {d2dcd641-8d91-492b-852f-5563ffadaec6} + + + {8672fa26-b119-481f-8b8d-086419c01a3e} + + + {4570be11-ec96-4b55-ac58-24b50ada980a} + + + {5d93ed51-023a-41ad-9243-8d230165d34b} + + + {b71e974a-9f28-4815-972b-d930ba8a34d0} + + + {60717407-397f-4ea5-8492-3314acdd25f0} + + + {8a90222f-d723-4b4e-8e6e-c57afaf7fa92} + + + {2d17d5e6-ed70-4e42-9693-f7a63baf4948} + + + {7158b0be-01e7-42d1-8d3f-c75118a596a2} + + + {6ad56e6d-c330-4830-8f4b-c75b05dfa866} + + + {84613aa2-91dc-4e1a-a3b3-823b6d7bf0e0} + + + {7bedd2e3-adbb-4c95-9632-445132b459ce} + + + {07a14673-4d02-4780-a099-6b8c654dff91} + + + {e875c5e3-40a2-4408-941e-5e1a951cc663} + + + {fcf93295-15e2-4a84-a5e9-b3c162e9f061} + + + {8a0aa896-6b3a-49b3-997e-681f0d1949ae} + + + {c5a01679-3e7a-4320-97ac-ee5b872c1650} + + + {c992824d-4198-46b2-8d59-5f99ab9946ab} + + + {6a35782c-bc09-42d5-a850-98bcb668a4dc} + + + + + FreeRTOS\Source\Portable + + + FreeRTOS\Source + + + FreeRTOS\Source + + + FreeRTOS\Source + + + FreeRTOS\Source + + + FreeRTOS+\FreeRTOS+TCP + + + FreeRTOS+\FreeRTOS+TCP + + + FreeRTOS+\FreeRTOS+TCP + + + FreeRTOS+\FreeRTOS+TCP + + + FreeRTOS+\FreeRTOS+TCP\portable + + + FreeRTOS+\FreeRTOS+TCP\portable + + + FreeRTOS+\FreeRTOS+TCP + + + FreeRTOS+\FreeRTOS+TCP + + + FreeRTOS+\FreeRTOS+TCP + + + FreeRTOS+\FreeRTOS+TCP + + + FreeRTOS\Source + + + FreeRTOS\Source\Portable + + + FreeRTOS+\FreeRTOS+TCP + + + FreeRTOS\Source + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + FreeRTOS+\mbedtls\library + + + + + DemoTasks + + + FreeRTOS+\FreeRTOS IoT Libraries\standard\coreMQTT\src + + + FreeRTOS+\FreeRTOS IoT Libraries\standard\coreMQTT\src + + + FreeRTOS+\FreeRTOS IoT Libraries\standard\coreMQTT\src + + + FreeRTOS+\FreeRTOS IoT Libraries\platform\freertos\mbedtls + + + FreeRTOS+\FreeRTOS IoT Libraries\platform\freertos\mbedtls + + + FreeRTOS+\FreeRTOS IoT Libraries\platform\freertos + + + FreeRTOS+\FreeRTOS IoT Libraries\platform\freertos\transport\src + + + FreeRTOS+\FreeRTOS IoT Libraries\platform\freertos\transport\src + + + + + FreeRTOS+\FreeRTOS+TCP\include + + + FreeRTOS+\FreeRTOS+TCP\include + + + FreeRTOS+\FreeRTOS+TCP\include + + + FreeRTOS+\FreeRTOS+TCP\include + + + FreeRTOS\Source\include + + + FreeRTOS\Source\include + + + FreeRTOS\Source\include + + + FreeRTOS\Source\include + + + FreeRTOS\Source\include + + + FreeRTOS\Source\include + + + FreeRTOS\Source\include + + + FreeRTOS+\FreeRTOS+TCP\include + + + FreeRTOS+\FreeRTOS+TCP\include + + + FreeRTOS+\FreeRTOS+TCP\include + + + FreeRTOS+\FreeRTOS+TCP\include + + + FreeRTOS+\FreeRTOS+TCP\include + + + FreeRTOS+\FreeRTOS+TCP\include + + + FreeRTOS+\FreeRTOS+TCP\include + + + FreeRTOS+\FreeRTOS+TCP\include + + + FreeRTOS+\FreeRTOS+TCP\include + + + + + FreeRTOS+\FreeRTOS+TCP\include + + + FreeRTOS\Source\include + + + FreeRTOS\Source\include + + + + FreeRTOS+\FreeRTOS IoT Libraries\standard\coreMQTT\include + + + FreeRTOS+\FreeRTOS IoT Libraries\standard\coreMQTT\include + + + FreeRTOS+\FreeRTOS IoT Libraries\standard\coreMQTT\include + + + + FreeRTOS+\FreeRTOS IoT Libraries\platform + + + FreeRTOS+\FreeRTOS IoT Libraries\platform + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + FreeRTOS+\mbedtls\include + + + + FreeRTOS+\FreeRTOS IoT Libraries\platform\freertos\mbedtls + + + FreeRTOS+\FreeRTOS IoT Libraries\platform\freertos\mbedtls + + + FreeRTOS+\FreeRTOS IoT Libraries\platform\freertos\transport\include + + + FreeRTOS+\FreeRTOS IoT Libraries\platform\freertos\transport\include + + + \ No newline at end of file diff --git a/FreeRTOS-Plus/Demo/coreMQTT_Windows_Simulator/MQTT_Mutual_Auth/core_mqtt_config.h b/FreeRTOS-Plus/Demo/coreMQTT_Windows_Simulator/MQTT_Mutual_Auth/core_mqtt_config.h new file mode 100644 index 0000000000..4d4a05ab26 --- /dev/null +++ b/FreeRTOS-Plus/Demo/coreMQTT_Windows_Simulator/MQTT_Mutual_Auth/core_mqtt_config.h @@ -0,0 +1,65 @@ +/* + * FreeRTOS Kernel V10.3.0 + * 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. + * + * http://www.FreeRTOS.org + * http://aws.amazon.com/freertos + */ +#ifndef CORE_MQTT_CONFIG_H +#define CORE_MQTT_CONFIG_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 MQTT. + * 3. Include the header file "logging_stack.h", if logging is enabled for MQTT. + */ + +#include "logging_levels.h" + +/* Logging configuration for the MQTT library. */ +#ifndef LIBRARY_LOG_NAME + #define LIBRARY_LOG_NAME "MQTT" +#endif + +#ifndef LIBRARY_LOG_LEVEL + #define LIBRARY_LOG_LEVEL LOG_ERROR +#endif + +#include "logging_stack.h" +/************ End of logging configuration ****************/ + +/** + * @brief The maximum number of MQTT PUBLISH messages that may be pending + * acknowledgement at any time. + * + * QoS 1 and 2 MQTT PUBLISHes require acknowledgment from the server before + * they can be completed. While they are awaiting the acknowledgment, the + * client must maintain information about their state. The value of this + * macro sets the limit on how many simultaneous PUBLISH states an MQTT + * context maintains. + */ +#define MQTT_STATE_ARRAY_MAX_COUNT 10U + +#endif /* ifndef CORE_MQTT_CONFIG_H */ diff --git a/FreeRTOS-Plus/Demo/coreMQTT_Windows_Simulator/MQTT_Mutual_Auth/demo_config.h b/FreeRTOS-Plus/Demo/coreMQTT_Windows_Simulator/MQTT_Mutual_Auth/demo_config.h new file mode 100644 index 0000000000..287e0b7b11 --- /dev/null +++ b/FreeRTOS-Plus/Demo/coreMQTT_Windows_Simulator/MQTT_Mutual_Auth/demo_config.h @@ -0,0 +1,159 @@ +/* + * FreeRTOS Kernel V10.3.0 + * 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. + * + * http://www.FreeRTOS.org + * http://aws.amazon.com/freertos + * + */ + +#ifndef DEMO_CONFIG_H +#define DEMO_CONFIG_H + +/* FreeRTOS config include. */ +#include "FreeRTOSConfig.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 DEMO. + * 3. Include the header file "logging_stack.h", if logging is enabled for DEMO. + */ + +#include "logging_levels.h" + +/* Logging configuration for the Demo. */ +#ifndef LIBRARY_LOG_NAME + #define LIBRARY_LOG_NAME "MQTTDemo" +#endif + +#ifndef LIBRARY_LOG_LEVEL + #define LIBRARY_LOG_LEVEL LOG_INFO +#endif +#include "logging_stack.h" + +/************ End of logging configuration ****************/ + +/** + * @brief The MQTT client identifier used in this example. Each client identifier + * must be unique; so edit as required to ensure that no two clients connecting to + * the same broker use the same client identifier. + * + * #define democonfigCLIENT_IDENTIFIER "insert here." + */ + +/** + * @brief Endpoint of the MQTT broker to connect to. + * + * This demo application can be run with any MQTT broker, that supports mutual + * authentication. + * + * For AWS IoT MQTT broker, this is the Thing's REST API Endpoint. + * + * @note Your AWS IoT Core endpoint can be found in the AWS IoT console under + * Settings/Custom Endpoint, or using the describe-endpoint REST API (with + * AWS CLI command line tool). + * + * #define democonfigMQTT_BROKER_ENDPOINT "...insert here..." + */ + +/** + * @brief The port to use for the demo. + * + * In general, port 8883 is for secured MQTT connections. + * + * @note Port 443 requires use of the ALPN TLS extension with the ALPN protocol + * name. Using ALPN with this demo would require additional changes, including + * setting the `pAlpnProtos` member of the `NetworkCredentials_t` struct before + * forming the TLS connection. When using port 8883, ALPN is not required. + * + * #define democonfigMQTT_BROKER_PORT ( insert here. ) + */ + +/** + * @brief Server's root CA certificate. + * + * For AWS IoT MQTT broker, this certificate is used to identify the AWS IoT + * server and is publicly available. Refer to the AWS documentation available + * in the link below. + * https://docs.aws.amazon.com/iot/latest/developerguide/server-authentication.html#server-authentication-certs + * + * @note This certificate should be PEM-encoded. + * + * Must include the PEM header and footer: + * "-----BEGIN CERTIFICATE-----\n"\ + * "...base64 data...\n"\ + * "-----END CERTIFICATE-----\n" + * + * #define democonfigROOT_CA_PEM "...insert here..." + */ + +/** + * @brief Client certificate. + * + * For AWS IoT MQTT broker, refer to the AWS documentation below for details + * regarding client authentication. + * https://docs.aws.amazon.com/iot/latest/developerguide/client-authentication.html + * + * @note This certificate should be PEM-encoded. + * + * Must include the PEM header and footer: + * "-----BEGIN CERTIFICATE-----\n"\ + * "...base64 data...\n"\ + * "-----END CERTIFICATE-----\n" + * + * #define democonfigCLIENT_CERTIFICATE_PEM "...insert here..." + */ + +/** + * @brief Client's private key. + * + * For AWS IoT MQTT broker, refer to the AWS documentation below for details + * regarding clientauthentication. + * https://docs.aws.amazon.com/iot/latest/developerguide/client-authentication.html + * + * @note This private key should be PEM-encoded. + * + * Must include the PEM header and footer: + * "-----BEGIN RSA PRIVATE KEY-----\n"\ + * "...base64 data...\n"\ + * "-----END RSA PRIVATE KEY-----\n" + * + * #define democonfigCLIENT_PRIVATE_KEY_PEM "...insert here..." + */ + +/** + * @brief Set the stack size of the main demo task. + * + * In the Windows port, this stack only holds a structure. The actual + * stack is created by an operating system thread. + */ +#define democonfigDEMO_STACKSIZE configMINIMAL_STACK_SIZE + +/** + * @brief Size of the network buffer for MQTT packets. + */ +#define democonfigNETWORK_BUFFER_SIZE ( 1024U ) + +#endif /* DEMO_CONFIG_H */ diff --git a/FreeRTOS-Plus/Demo/coreMQTT_Windows_Simulator/MQTT_Mutual_Auth/mbedtls_config.h b/FreeRTOS-Plus/Demo/coreMQTT_Windows_Simulator/MQTT_Mutual_Auth/mbedtls_config.h new file mode 100644 index 0000000000..1d65bb3dfd --- /dev/null +++ b/FreeRTOS-Plus/Demo/coreMQTT_Windows_Simulator/MQTT_Mutual_Auth/mbedtls_config.h @@ -0,0 +1,151 @@ +/* + * Copyright (C) 2006-2018, ARM Limited, All Rights Reserved + * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later + * + * This file is provided under the Apache License 2.0, or the + * GNU General Public License v2.0 or later. + * + * ********** + * Apache License 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. + * + * ********** + * + * ********** + * GNU General Public License v2.0 or later: + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License along + * with this program; if not, write to the Free Software Foundation, Inc., + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + * + * ********** + * + * This repository uses Mbed TLS under Apache 2.0 + */ + +/* This file configures mbed TLS for FreeRTOS. */ + +#ifndef MBEDTLS_CONFIG_H_ +#define MBEDTLS_CONFIG_H_ + +/* FreeRTOS include. */ +#include "FreeRTOS.h" + +/* Generate errors if deprecated functions are used. */ +#define MBEDTLS_DEPRECATED_REMOVED + +/* Place AES tables in ROM. */ +#define MBEDTLS_AES_ROM_TABLES + +/* Enable the following cipher modes. */ +#define MBEDTLS_CIPHER_MODE_CBC +#define MBEDTLS_CIPHER_MODE_CFB +#define MBEDTLS_CIPHER_MODE_CTR + +/* Enable the following cipher padding modes. */ +#define MBEDTLS_CIPHER_PADDING_PKCS7 +#define MBEDTLS_CIPHER_PADDING_ONE_AND_ZEROS +#define MBEDTLS_CIPHER_PADDING_ZEROS_AND_LEN +#define MBEDTLS_CIPHER_PADDING_ZEROS + +/* Cipher suite configuration. */ +#define MBEDTLS_REMOVE_ARC4_CIPHERSUITES +#define MBEDTLS_ECP_DP_SECP256R1_ENABLED +#define MBEDTLS_ECP_NIST_OPTIM +#define MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED +#define MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED + +/* Enable all SSL alert messages. */ +#define MBEDTLS_SSL_ALL_ALERT_MESSAGES + +/* Enable the following SSL features. */ +#define MBEDTLS_SSL_ENCRYPT_THEN_MAC +#define MBEDTLS_SSL_EXTENDED_MASTER_SECRET +#define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH +#define MBEDTLS_SSL_PROTO_TLS1_2 +#define MBEDTLS_SSL_ALPN +#define MBEDTLS_SSL_SERVER_NAME_INDICATION + +/* Check certificate key usage. */ +#define MBEDTLS_X509_CHECK_KEY_USAGE +#define MBEDTLS_X509_CHECK_EXTENDED_KEY_USAGE + +/* Disable platform entropy functions. */ +#define MBEDTLS_NO_PLATFORM_ENTROPY + +/* Enable the following mbed TLS features. */ +#define MBEDTLS_AES_C +#define MBEDTLS_ASN1_PARSE_C +#define MBEDTLS_ASN1_WRITE_C +#define MBEDTLS_BASE64_C +#define MBEDTLS_BIGNUM_C +#define MBEDTLS_CIPHER_C +#define MBEDTLS_CTR_DRBG_C +#define MBEDTLS_ECDH_C +#define MBEDTLS_ECDSA_C +#define MBEDTLS_ECP_C +#define MBEDTLS_ENTROPY_C +#define MBEDTLS_GCM_C +#define MBEDTLS_MD_C +#define MBEDTLS_OID_C +#define MBEDTLS_PEM_PARSE_C +#define MBEDTLS_PK_C +#define MBEDTLS_PK_PARSE_C +#define MBEDTLS_PKCS1_V15 +#define MBEDTLS_PLATFORM_C +#define MBEDTLS_RSA_C +#define MBEDTLS_SHA1_C +#define MBEDTLS_SHA256_C +#define MBEDTLS_SSL_CLI_C +#define MBEDTLS_SSL_TLS_C +#define MBEDTLS_THREADING_ALT +#define MBEDTLS_THREADING_C +#define MBEDTLS_X509_USE_C +#define MBEDTLS_X509_CRT_PARSE_C + +/* Set the memory allocation functions on FreeRTOS. */ +void * mbedtls_platform_calloc( size_t nmemb, + size_t size ); +void mbedtls_platform_free( void * ptr ); +#define MBEDTLS_PLATFORM_MEMORY +#define MBEDTLS_PLATFORM_CALLOC_MACRO mbedtls_platform_calloc +#define MBEDTLS_PLATFORM_FREE_MACRO mbedtls_platform_free + +/* The network send and receive functions on FreeRTOS. */ +int mbedtls_platform_send( void * ctx, + const unsigned char * buf, + size_t len ); +int mbedtls_platform_recv( void * ctx, + unsigned char * buf, + size_t len ); + +/* The entropy poll function. */ +int mbedtls_platform_entropy_poll( void * data, + unsigned char * output, + size_t len, + size_t * olen ); + +#include "mbedtls/check_config.h" + +#endif /* ifndef MBEDTLS_CONFIG_H_ */ diff --git a/FreeRTOS-Plus/Demo/coreMQTT_Windows_Simulator/MQTT_Mutual_Auth/mqtt_mutual_auth_demo.sln b/FreeRTOS-Plus/Demo/coreMQTT_Windows_Simulator/MQTT_Mutual_Auth/mqtt_mutual_auth_demo.sln new file mode 100644 index 0000000000..dcfc1fe098 --- /dev/null +++ b/FreeRTOS-Plus/Demo/coreMQTT_Windows_Simulator/MQTT_Mutual_Auth/mqtt_mutual_auth_demo.sln @@ -0,0 +1,25 @@ + +Microsoft Visual Studio Solution File, Format Version 12.00 +# Visual Studio Version 16 +VisualStudioVersion = 16.0.29215.179 +MinimumVisualStudioVersion = 10.0.40219.1 +Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "RTOSDemo", "WIN32.vcxproj", "{C686325E-3261-42F7-AEB1-DDE5280E1CEB}" +EndProject +Global + GlobalSection(SolutionConfigurationPlatforms) = preSolution + Debug|Win32 = Debug|Win32 + EndGlobalSection + GlobalSection(ProjectConfigurationPlatforms) = postSolution + {C686325E-3261-42F7-AEB1-DDE5280E1CEB}.Debug|Win32.ActiveCfg = Debug|Win32 + {C686325E-3261-42F7-AEB1-DDE5280E1CEB}.Debug|Win32.Build.0 = Debug|Win32 + EndGlobalSection + GlobalSection(SolutionProperties) = preSolution + HideSolutionNode = FALSE + EndGlobalSection + GlobalSection(ExtensibilityGlobals) = postSolution + SolutionGuid = {150F08BF-9D61-4CC2-8DBF-1335172A1EA4} + EndGlobalSection + GlobalSection(TestCaseManagementSettings) = postSolution + CategoryFile = FreeRTOS_Plus_TCP_Minimal.vsmdi + EndGlobalSection +EndGlobal diff --git a/FreeRTOS-Plus/Source/Application-Protocols/platform/freertos/mbedtls/mbedtls_error.c b/FreeRTOS-Plus/Source/Application-Protocols/platform/freertos/mbedtls/mbedtls_error.c new file mode 100644 index 0000000000..bf00edce7d --- /dev/null +++ b/FreeRTOS-Plus/Source/Application-Protocols/platform/freertos/mbedtls/mbedtls_error.c @@ -0,0 +1,1336 @@ +/* + * FreeRTOS Error Code Stringification utilies for mbed TLS v2.16.0 + * 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. + * + * http://aws.amazon.com/freertos + * http://www.FreeRTOS.org + */ + +/** + * @file mbedtls_error.c + * @brief This files defines the stringification utilities for mbed TLS high-level and low-level codes. + */ + +#include "mbedtls_error.h" + +#if !defined( MBEDTLS_CONFIG_FILE ) + #include "mbedtls/config.h" +#else + #include MBEDTLS_CONFIG_FILE +#endif + +#if defined( MBEDTLS_AES_C ) + #include "mbedtls/aes.h" +#endif + +#if defined( MBEDTLS_ARC4_C ) + #include "mbedtls/arc4.h" +#endif + +#if defined( MBEDTLS_ARIA_C ) + #include "mbedtls/aria.h" +#endif + +#if defined( MBEDTLS_BASE64_C ) + #include "mbedtls/base64.h" +#endif + +#if defined( MBEDTLS_BIGNUM_C ) + #include "mbedtls/bignum.h" +#endif + +#if defined( MBEDTLS_BLOWFISH_C ) + #include "mbedtls/blowfish.h" +#endif + +#if defined( MBEDTLS_CAMELLIA_C ) + #include "mbedtls/camellia.h" +#endif + +#if defined( MBEDTLS_CCM_C ) + #include "mbedtls/ccm.h" +#endif + +#if defined( MBEDTLS_CHACHA20_C ) + #include "mbedtls/chacha20.h" +#endif + +#if defined( MBEDTLS_CHACHAPOLY_C ) + #include "mbedtls/chachapoly.h" +#endif + +#if defined( MBEDTLS_CIPHER_C ) + #include "mbedtls/cipher.h" +#endif + +#if defined( MBEDTLS_CMAC_C ) + #include "mbedtls/cmac.h" +#endif + +#if defined( MBEDTLS_CTR_DRBG_C ) + #include "mbedtls/ctr_drbg.h" +#endif + +#if defined( MBEDTLS_DES_C ) + #include "mbedtls/des.h" +#endif + +#if defined( MBEDTLS_DHM_C ) + #include "mbedtls/dhm.h" +#endif + +#if defined( MBEDTLS_ECP_C ) + #include "mbedtls/ecp.h" +#endif + +#if defined( MBEDTLS_ENTROPY_C ) + #include "mbedtls/entropy.h" +#endif + +#if defined( MBEDTLS_GCM_C ) + #include "mbedtls/gcm.h" +#endif + +#if defined( MBEDTLS_HKDF_C ) + #include "mbedtls/hkdf.h" +#endif + +#if defined( MBEDTLS_HMAC_DRBG_C ) + #include "mbedtls/hmac_drbg.h" +#endif + +#if defined( MBEDTLS_MD_C ) + #include "mbedtls/md.h" +#endif + +#if defined( MBEDTLS_MD2_C ) + #include "mbedtls/md2.h" +#endif + +#if defined( MBEDTLS_MD4_C ) + #include "mbedtls/md4.h" +#endif + +#if defined( MBEDTLS_MD5_C ) + #include "mbedtls/md5.h" +#endif + +#if defined( MBEDTLS_NET_C ) + #include "mbedtls/net_sockets.h" +#endif + +#if defined( MBEDTLS_OID_C ) + #include "mbedtls/oid.h" +#endif + +#if defined( MBEDTLS_PADLOCK_C ) + #include "mbedtls/padlock.h" +#endif + +#if defined( MBEDTLS_PEM_PARSE_C ) || defined( MBEDTLS_PEM_WRITE_C ) + #include "mbedtls/pem.h" +#endif + +#if defined( MBEDTLS_PK_C ) + #include "mbedtls/pk.h" +#endif + +#if defined( MBEDTLS_PKCS12_C ) + #include "mbedtls/pkcs12.h" +#endif + +#if defined( MBEDTLS_PKCS5_C ) + #include "mbedtls/pkcs5.h" +#endif + +#if defined( MBEDTLS_PLATFORM_C ) + #include "mbedtls/platform.h" +#endif + +#if defined( MBEDTLS_POLY1305_C ) + #include "mbedtls/poly1305.h" +#endif + +#if defined( MBEDTLS_RIPEMD160_C ) + #include "mbedtls/ripemd160.h" +#endif + +#if defined( MBEDTLS_RSA_C ) + #include "mbedtls/rsa.h" +#endif + +#if defined( MBEDTLS_SHA1_C ) + #include "mbedtls/sha1.h" +#endif + +#if defined( MBEDTLS_SHA256_C ) + #include "mbedtls/sha256.h" +#endif + +#if defined( MBEDTLS_SHA512_C ) + #include "mbedtls/sha512.h" +#endif + +#if defined( MBEDTLS_SSL_TLS_C ) + #include "mbedtls/ssl.h" +#endif + +#if defined( MBEDTLS_THREADING_C ) + #include "mbedtls/threading.h" +#endif + +#if defined( MBEDTLS_X509_USE_C ) || defined( MBEDTLS_X509_CREATE_C ) + #include "mbedtls/x509.h" +#endif + +#if defined( MBEDTLS_XTEA_C ) + #include "mbedtls/xtea.h" +#endif + + +const char * mbedtls_strerror_highlevel( int errnum ) +{ + const char * rc = NULL; + int use_ret; + + if( errnum < 0 ) + { + errnum = -errnum; + } + + if( errnum & 0xFF80 ) + { + use_ret = errnum & 0xFF80; + + /* High level error codes */ + switch( use_ret ) + { + #if defined( MBEDTLS_CIPHER_C ) + case -( MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE ): + rc = "CIPHER - The selected feature is not available"; + break; + + case -( MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA ): + rc = "CIPHER - Bad input parameters"; + break; + + case -( MBEDTLS_ERR_CIPHER_ALLOC_FAILED ): + rc = "CIPHER - Failed to allocate memory"; + break; + + case -( MBEDTLS_ERR_CIPHER_INVALID_PADDING ): + rc = "CIPHER - Input data contains invalid padding and is rejected"; + break; + + case -( MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED ): + rc = "CIPHER - Decryption of block requires a full block"; + break; + + case -( MBEDTLS_ERR_CIPHER_AUTH_FAILED ): + rc = "CIPHER - Authentication failed (for AEAD modes)"; + break; + + case -( MBEDTLS_ERR_CIPHER_INVALID_CONTEXT ): + rc = "CIPHER - The context is invalid. For example, because it was freed"; + break; + + case -( MBEDTLS_ERR_CIPHER_HW_ACCEL_FAILED ): + rc = "CIPHER - Cipher hardware accelerator failed"; + break; + #endif /* MBEDTLS_CIPHER_C */ + + #if defined( MBEDTLS_DHM_C ) + case -( MBEDTLS_ERR_DHM_BAD_INPUT_DATA ): + rc = "DHM - Bad input parameters"; + break; + + case -( MBEDTLS_ERR_DHM_READ_PARAMS_FAILED ): + rc = "DHM - Reading of the DHM parameters failed"; + break; + + case -( MBEDTLS_ERR_DHM_MAKE_PARAMS_FAILED ): + rc = "DHM - Making of the DHM parameters failed"; + break; + + case -( MBEDTLS_ERR_DHM_READ_PUBLIC_FAILED ): + rc = "DHM - Reading of the public values failed"; + break; + + case -( MBEDTLS_ERR_DHM_MAKE_PUBLIC_FAILED ): + rc = "DHM - Making of the public value failed"; + break; + + case -( MBEDTLS_ERR_DHM_CALC_SECRET_FAILED ): + rc = "DHM - Calculation of the DHM secret failed"; + break; + + case -( MBEDTLS_ERR_DHM_INVALID_FORMAT ): + rc = "DHM - The ASN.1 data is not formatted correctly"; + break; + + case -( MBEDTLS_ERR_DHM_ALLOC_FAILED ): + rc = "DHM - Allocation of memory failed"; + break; + + case -( MBEDTLS_ERR_DHM_FILE_IO_ERROR ): + rc = "DHM - Read or write of file failed"; + break; + + case -( MBEDTLS_ERR_DHM_HW_ACCEL_FAILED ): + rc = "DHM - DHM hardware accelerator failed"; + break; + + case -( MBEDTLS_ERR_DHM_SET_GROUP_FAILED ): + rc = "DHM - Setting the modulus and generator failed"; + break; + #endif /* MBEDTLS_DHM_C */ + + #if defined( MBEDTLS_ECP_C ) + case -( MBEDTLS_ERR_ECP_BAD_INPUT_DATA ): + rc = "ECP - Bad input parameters to function"; + break; + + case -( MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL ): + rc = "ECP - The buffer is too small to write to"; + break; + + case -( MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE ): + rc = "ECP - The requested feature is not available, for example, the requested curve is not supported"; + break; + + case -( MBEDTLS_ERR_ECP_VERIFY_FAILED ): + rc = "ECP - The signature is not valid"; + break; + + case -( MBEDTLS_ERR_ECP_ALLOC_FAILED ): + rc = "ECP - Memory allocation failed"; + break; + + case -( MBEDTLS_ERR_ECP_RANDOM_FAILED ): + rc = "ECP - Generation of random value, such as ephemeral key, failed"; + break; + + case -( MBEDTLS_ERR_ECP_INVALID_KEY ): + rc = "ECP - Invalid private or public key"; + break; + + case -( MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH ): + rc = "ECP - The buffer contains a valid signature followed by more data"; + break; + + case -( MBEDTLS_ERR_ECP_HW_ACCEL_FAILED ): + rc = "ECP - The ECP hardware accelerator failed"; + break; + + case -( MBEDTLS_ERR_ECP_IN_PROGRESS ): + rc = "ECP - Operation in progress, call again with the same parameters to continue"; + break; + #endif /* MBEDTLS_ECP_C */ + + #if defined( MBEDTLS_MD_C ) + case -( MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE ): + rc = "MD - The selected feature is not available"; + break; + + case -( MBEDTLS_ERR_MD_BAD_INPUT_DATA ): + rc = "MD - Bad input parameters to function"; + break; + + case -( MBEDTLS_ERR_MD_ALLOC_FAILED ): + rc = "MD - Failed to allocate memory"; + break; + + case -( MBEDTLS_ERR_MD_FILE_IO_ERROR ): + rc = "MD - Opening or reading of file failed"; + break; + + case -( MBEDTLS_ERR_MD_HW_ACCEL_FAILED ): + rc = "MD - MD hardware accelerator failed"; + break; + #endif /* MBEDTLS_MD_C */ + + #if defined( MBEDTLS_PEM_PARSE_C ) || defined( MBEDTLS_PEM_WRITE_C ) + case -( MBEDTLS_ERR_PEM_NO_HEADER_FOOTER_PRESENT ): + rc = "PEM - No PEM header or footer found"; + break; + + case -( MBEDTLS_ERR_PEM_INVALID_DATA ): + rc = "PEM - PEM string is not as expected"; + break; + + case -( MBEDTLS_ERR_PEM_ALLOC_FAILED ): + rc = "PEM - Failed to allocate memory"; + break; + + case -( MBEDTLS_ERR_PEM_INVALID_ENC_IV ): + rc = "PEM - RSA IV is not in hex-format"; + break; + + case -( MBEDTLS_ERR_PEM_UNKNOWN_ENC_ALG ): + rc = "PEM - Unsupported key encryption algorithm"; + break; + + case -( MBEDTLS_ERR_PEM_PASSWORD_REQUIRED ): + rc = "PEM - Private key password can't be empty"; + break; + + case -( MBEDTLS_ERR_PEM_PASSWORD_MISMATCH ): + rc = "PEM - Given private key password does not allow for correct decryption"; + break; + + case -( MBEDTLS_ERR_PEM_FEATURE_UNAVAILABLE ): + rc = "PEM - Unavailable feature, e.g. hashing/encryption combination"; + break; + + case -( MBEDTLS_ERR_PEM_BAD_INPUT_DATA ): + rc = "PEM - Bad input parameters to function"; + break; + #endif /* MBEDTLS_PEM_PARSE_C || MBEDTLS_PEM_WRITE_C */ + + #if defined( MBEDTLS_PK_C ) + case -( MBEDTLS_ERR_PK_ALLOC_FAILED ): + rc = "PK - Memory allocation failed"; + break; + + case -( MBEDTLS_ERR_PK_TYPE_MISMATCH ): + rc = "PK - Type mismatch, eg attempt to encrypt with an ECDSA key"; + break; + + case -( MBEDTLS_ERR_PK_BAD_INPUT_DATA ): + rc = "PK - Bad input parameters to function"; + break; + + case -( MBEDTLS_ERR_PK_FILE_IO_ERROR ): + rc = "PK - Read/write of file failed"; + break; + + case -( MBEDTLS_ERR_PK_KEY_INVALID_VERSION ): + rc = "PK - Unsupported key version"; + break; + + case -( MBEDTLS_ERR_PK_KEY_INVALID_FORMAT ): + rc = "PK - Invalid key tag or value"; + break; + + case -( MBEDTLS_ERR_PK_UNKNOWN_PK_ALG ): + rc = "PK - Key algorithm is unsupported (only RSA and EC are supported)"; + break; + + case -( MBEDTLS_ERR_PK_PASSWORD_REQUIRED ): + rc = "PK - Private key password can't be empty"; + break; + + case -( MBEDTLS_ERR_PK_PASSWORD_MISMATCH ): + rc = "PK - Given private key password does not allow for correct decryption"; + break; + + case -( MBEDTLS_ERR_PK_INVALID_PUBKEY ): + rc = "PK - The pubkey tag or value is invalid (only RSA and EC are supported)"; + break; + + case -( MBEDTLS_ERR_PK_INVALID_ALG ): + rc = "PK - The algorithm tag or value is invalid"; + break; + + case -( MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE ): + rc = "PK - Elliptic curve is unsupported (only NIST curves are supported)"; + break; + + case -( MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE ): + rc = "PK - Unavailable feature, e.g. RSA disabled for RSA key"; + break; + + case -( MBEDTLS_ERR_PK_SIG_LEN_MISMATCH ): + rc = "PK - The buffer contains a valid signature followed by more data"; + break; + + case -( MBEDTLS_ERR_PK_HW_ACCEL_FAILED ): + rc = "PK - PK hardware accelerator failed"; + break; + #endif /* MBEDTLS_PK_C */ + + #if defined( MBEDTLS_PKCS12_C ) + case -( MBEDTLS_ERR_PKCS12_BAD_INPUT_DATA ): + rc = "PKCS12 - Bad input parameters to function"; + break; + + case -( MBEDTLS_ERR_PKCS12_FEATURE_UNAVAILABLE ): + rc = "PKCS12 - Feature not available, e.g. unsupported encryption scheme"; + break; + + case -( MBEDTLS_ERR_PKCS12_PBE_INVALID_FORMAT ): + rc = "PKCS12 - PBE ASN.1 data not as expected"; + break; + + case -( MBEDTLS_ERR_PKCS12_PASSWORD_MISMATCH ): + rc = "PKCS12 - Given private key password does not allow for correct decryption"; + break; + #endif /* MBEDTLS_PKCS12_C */ + + #if defined( MBEDTLS_PKCS5_C ) + case -( MBEDTLS_ERR_PKCS5_BAD_INPUT_DATA ): + rc = "PKCS5 - Bad input parameters to function"; + break; + + case -( MBEDTLS_ERR_PKCS5_INVALID_FORMAT ): + rc = "PKCS5 - Unexpected ASN.1 data"; + break; + + case -( MBEDTLS_ERR_PKCS5_FEATURE_UNAVAILABLE ): + rc = "PKCS5 - Requested encryption or digest alg not available"; + break; + + case -( MBEDTLS_ERR_PKCS5_PASSWORD_MISMATCH ): + rc = "PKCS5 - Given private key password does not allow for correct decryption"; + break; + #endif /* MBEDTLS_PKCS5_C */ + + #if defined( MBEDTLS_RSA_C ) + case -( MBEDTLS_ERR_RSA_BAD_INPUT_DATA ): + rc = "RSA - Bad input parameters to function"; + break; + + case -( MBEDTLS_ERR_RSA_INVALID_PADDING ): + rc = "RSA - Input data contains invalid padding and is rejected"; + break; + + case -( MBEDTLS_ERR_RSA_KEY_GEN_FAILED ): + rc = "RSA - Something failed during generation of a key"; + break; + + case -( MBEDTLS_ERR_RSA_KEY_CHECK_FAILED ): + rc = "RSA - Key failed to pass the validity check of the library"; + break; + + case -( MBEDTLS_ERR_RSA_PUBLIC_FAILED ): + rc = "RSA - The public key operation failed"; + break; + + case -( MBEDTLS_ERR_RSA_PRIVATE_FAILED ): + rc = "RSA - The private key operation failed"; + break; + + case -( MBEDTLS_ERR_RSA_VERIFY_FAILED ): + rc = "RSA - The PKCS#1 verification failed"; + break; + + case -( MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE ): + rc = "RSA - The output buffer for decryption is not large enough"; + break; + + case -( MBEDTLS_ERR_RSA_RNG_FAILED ): + rc = "RSA - The random generator failed to generate non-zeros"; + break; + + case -( MBEDTLS_ERR_RSA_UNSUPPORTED_OPERATION ): + rc = "RSA - The implementation does not offer the requested operation, for example, because of security violations or lack of functionality"; + break; + + case -( MBEDTLS_ERR_RSA_HW_ACCEL_FAILED ): + rc = "RSA - RSA hardware accelerator failed"; + break; + #endif /* MBEDTLS_RSA_C */ + + #if defined( MBEDTLS_SSL_TLS_C ) + case -( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE ): + rc = "SSL - The requested feature is not available"; + break; + + case -( MBEDTLS_ERR_SSL_BAD_INPUT_DATA ): + rc = "SSL - Bad input parameters to function"; + break; + + case -( MBEDTLS_ERR_SSL_INVALID_MAC ): + rc = "SSL - Verification of the message MAC failed"; + break; + + case -( MBEDTLS_ERR_SSL_INVALID_RECORD ): + rc = "SSL - An invalid SSL record was received"; + break; + + case -( MBEDTLS_ERR_SSL_CONN_EOF ): + rc = "SSL - The connection indicated an EOF"; + break; + + case -( MBEDTLS_ERR_SSL_UNKNOWN_CIPHER ): + rc = "SSL - An unknown cipher was received"; + break; + + case -( MBEDTLS_ERR_SSL_NO_CIPHER_CHOSEN ): + rc = "SSL - The server has no ciphersuites in common with the client"; + break; + + case -( MBEDTLS_ERR_SSL_NO_RNG ): + rc = "SSL - No RNG was provided to the SSL module"; + break; + + case -( MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE ): + rc = "SSL - No client certification received from the client, but required by the authentication mode"; + break; + + case -( MBEDTLS_ERR_SSL_CERTIFICATE_TOO_LARGE ): + rc = "SSL - Our own certificate(s) is/are too large to send in an SSL message"; + break; + + case -( MBEDTLS_ERR_SSL_CERTIFICATE_REQUIRED ): + rc = "SSL - The own certificate is not set, but needed by the server"; + break; + + case -( MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED ): + rc = "SSL - The own private key or pre-shared key is not set, but needed"; + break; + + case -( MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED ): + rc = "SSL - No CA Chain is set, but required to operate"; + break; + + case -( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE ): + rc = "SSL - An unexpected message was received from our peer"; + break; + + case -( MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE ): + rc = "SSL - A fatal alert message was received from our peer"; + break; + + case -( MBEDTLS_ERR_SSL_PEER_VERIFY_FAILED ): + rc = "SSL - Verification of our peer failed"; + break; + + case -( MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY ): + rc = "SSL - The peer notified us that the connection is going to be closed"; + break; + + case -( MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO ): + rc = "SSL - Processing of the ClientHello handshake message failed"; + break; + + case -( MBEDTLS_ERR_SSL_BAD_HS_SERVER_HELLO ): + rc = "SSL - Processing of the ServerHello handshake message failed"; + break; + + case -( MBEDTLS_ERR_SSL_BAD_HS_CERTIFICATE ): + rc = "SSL - Processing of the Certificate handshake message failed"; + break; + + case -( MBEDTLS_ERR_SSL_BAD_HS_CERTIFICATE_REQUEST ): + rc = "SSL - Processing of the CertificateRequest handshake message failed"; + break; + + case -( MBEDTLS_ERR_SSL_BAD_HS_SERVER_KEY_EXCHANGE ): + rc = "SSL - Processing of the ServerKeyExchange handshake message failed"; + break; + + case -( MBEDTLS_ERR_SSL_BAD_HS_SERVER_HELLO_DONE ): + rc = "SSL - Processing of the ServerHelloDone handshake message failed"; + break; + + case -( MBEDTLS_ERR_SSL_BAD_HS_CLIENT_KEY_EXCHANGE ): + rc = "SSL - Processing of the ClientKeyExchange handshake message failed"; + break; + + case -( MBEDTLS_ERR_SSL_BAD_HS_CLIENT_KEY_EXCHANGE_RP ): + rc = "SSL - Processing of the ClientKeyExchange handshake message failed in DHM / ECDH Read Public"; + break; + + case -( MBEDTLS_ERR_SSL_BAD_HS_CLIENT_KEY_EXCHANGE_CS ): + rc = "SSL - Processing of the ClientKeyExchange handshake message failed in DHM / ECDH Calculate Secret"; + break; + + case -( MBEDTLS_ERR_SSL_BAD_HS_CERTIFICATE_VERIFY ): + rc = "SSL - Processing of the CertificateVerify handshake message failed"; + break; + + case -( MBEDTLS_ERR_SSL_BAD_HS_CHANGE_CIPHER_SPEC ): + rc = "SSL - Processing of the ChangeCipherSpec handshake message failed"; + break; + + case -( MBEDTLS_ERR_SSL_BAD_HS_FINISHED ): + rc = "SSL - Processing of the Finished handshake message failed"; + break; + + case -( MBEDTLS_ERR_SSL_ALLOC_FAILED ): + rc = "SSL - Memory allocation failed"; + break; + + case -( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED ): + rc = "SSL - Hardware acceleration function returned with error"; + break; + + case -( MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH ): + rc = "SSL - Hardware acceleration function skipped / left alone data"; + break; + + case -( MBEDTLS_ERR_SSL_COMPRESSION_FAILED ): + rc = "SSL - Processing of the compression / decompression failed"; + break; + + case -( MBEDTLS_ERR_SSL_BAD_HS_PROTOCOL_VERSION ): + rc = "SSL - Handshake protocol not within min/max boundaries"; + break; + + case -( MBEDTLS_ERR_SSL_BAD_HS_NEW_SESSION_TICKET ): + rc = "SSL - Processing of the NewSessionTicket handshake message failed"; + break; + + case -( MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED ): + rc = "SSL - Session ticket has expired"; + break; + + case -( MBEDTLS_ERR_SSL_PK_TYPE_MISMATCH ): + rc = "SSL - Public key type mismatch (eg, asked for RSA key exchange and presented EC key)"; + break; + + case -( MBEDTLS_ERR_SSL_UNKNOWN_IDENTITY ): + rc = "SSL - Unknown identity received (eg, PSK identity)"; + break; + + case -( MBEDTLS_ERR_SSL_INTERNAL_ERROR ): + rc = "SSL - Internal error (eg, unexpected failure in lower-level module)"; + break; + + case -( MBEDTLS_ERR_SSL_COUNTER_WRAPPING ): + rc = "SSL - A counter would wrap (eg, too many messages exchanged)"; + break; + + case -( MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO ): + rc = "SSL - Unexpected message at ServerHello in renegotiation"; + break; + + case -( MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED ): + rc = "SSL - DTLS client must retry for hello verification"; + break; + + case -( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL ): + rc = "SSL - A buffer is too small to receive or write a message"; + break; + + case -( MBEDTLS_ERR_SSL_NO_USABLE_CIPHERSUITE ): + rc = "SSL - None of the common ciphersuites is usable (eg, no suitable certificate, see debug messages)"; + break; + + case -( MBEDTLS_ERR_SSL_WANT_READ ): + rc = "SSL - No data of requested type currently available on underlying transport"; + break; + + case -( MBEDTLS_ERR_SSL_WANT_WRITE ): + rc = "SSL - Connection requires a write call"; + break; + + case -( MBEDTLS_ERR_SSL_TIMEOUT ): + rc = "SSL - The operation timed out"; + break; + + case -( MBEDTLS_ERR_SSL_CLIENT_RECONNECT ): + rc = "SSL - The client initiated a reconnect from the same port"; + break; + + case -( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD ): + rc = "SSL - Record header looks valid but is not expected"; + break; + + case -( MBEDTLS_ERR_SSL_NON_FATAL ): + rc = "SSL - The alert message received indicates a non-fatal error"; + break; + + case -( MBEDTLS_ERR_SSL_INVALID_VERIFY_HASH ): + rc = "SSL - Couldn't set the hash for verifying CertificateVerify"; + break; + + case -( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING ): + rc = "SSL - Internal-only message signaling that further message-processing should be done"; + break; + + case -( MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS ): + rc = "SSL - The asynchronous operation is not completed yet"; + break; + + case -( MBEDTLS_ERR_SSL_EARLY_MESSAGE ): + rc = "SSL - Internal-only message signaling that a message arrived early"; + break; + + case -( MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS ): + rc = "SSL - A cryptographic operation is in progress. Try again later"; + break; + #endif /* MBEDTLS_SSL_TLS_C */ + + #if defined( MBEDTLS_X509_USE_C ) || defined( MBEDTLS_X509_CREATE_C ) + case -( MBEDTLS_ERR_X509_FEATURE_UNAVAILABLE ): + rc = "X509 - Unavailable feature, e.g. RSA hashing/encryption combination"; + break; + + case -( MBEDTLS_ERR_X509_UNKNOWN_OID ): + rc = "X509 - Requested OID is unknown"; + break; + + case -( MBEDTLS_ERR_X509_INVALID_FORMAT ): + rc = "X509 - The CRT/CRL/CSR format is invalid, e.g. different type expected"; + break; + + case -( MBEDTLS_ERR_X509_INVALID_VERSION ): + rc = "X509 - The CRT/CRL/CSR version element is invalid"; + break; + + case -( MBEDTLS_ERR_X509_INVALID_SERIAL ): + rc = "X509 - The serial tag or value is invalid"; + break; + + case -( MBEDTLS_ERR_X509_INVALID_ALG ): + rc = "X509 - The algorithm tag or value is invalid"; + break; + + case -( MBEDTLS_ERR_X509_INVALID_NAME ): + rc = "X509 - The name tag or value is invalid"; + break; + + case -( MBEDTLS_ERR_X509_INVALID_DATE ): + rc = "X509 - The date tag or value is invalid"; + break; + + case -( MBEDTLS_ERR_X509_INVALID_SIGNATURE ): + rc = "X509 - The signature tag or value invalid"; + break; + + case -( MBEDTLS_ERR_X509_INVALID_EXTENSIONS ): + rc = "X509 - The extension tag or value is invalid"; + break; + + case -( MBEDTLS_ERR_X509_UNKNOWN_VERSION ): + rc = "X509 - CRT/CRL/CSR has an unsupported version number"; + break; + + case -( MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG ): + rc = "X509 - Signature algorithm (oid) is unsupported"; + break; + + case -( MBEDTLS_ERR_X509_SIG_MISMATCH ): + rc = "X509 - Signature algorithms do not match. (see \\c ::mbedtls_x509_crt sig_oid)"; + break; + + case -( MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ): + rc = "X509 - Certificate verification failed, e.g. CRL, CA or signature check failed"; + break; + + case -( MBEDTLS_ERR_X509_CERT_UNKNOWN_FORMAT ): + rc = "X509 - Format not recognized as DER or PEM"; + break; + + case -( MBEDTLS_ERR_X509_BAD_INPUT_DATA ): + rc = "X509 - Input invalid"; + break; + + case -( MBEDTLS_ERR_X509_ALLOC_FAILED ): + rc = "X509 - Allocation of memory failed"; + break; + + case -( MBEDTLS_ERR_X509_FILE_IO_ERROR ): + rc = "X509 - Read/write of file failed"; + break; + + case -( MBEDTLS_ERR_X509_BUFFER_TOO_SMALL ): + rc = "X509 - Destination buffer is too small"; + break; + + case -( MBEDTLS_ERR_X509_FATAL_ERROR ): + rc = "X509 - A fatal error occured, eg the chain is too long or the vrfy callback failed"; + break; + #endif /* MBEDTLS_X509_USE_C || MBEDTLS_X509_CREATE_C */ + /* END generated code */ + } + } + + return rc; +} + +const char * mbedtls_strerror_lowlevel( int errnum ) +{ + const char * rc = NULL; + int use_ret; + + if( errnum < 0 ) + { + errnum = -errnum; + } + + use_ret = errnum & ~0xFF80; + + if( use_ret == 0 ) + { + return NULL; + } + + /* Low level error codes */ + /* */ + switch( use_ret ) + { + #if defined( MBEDTLS_AES_C ) + case -( MBEDTLS_ERR_AES_INVALID_KEY_LENGTH ): + rc = "AES - Invalid key length"; + break; + + case -( MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH ): + rc = "AES - Invalid data input length"; + break; + + case -( MBEDTLS_ERR_AES_BAD_INPUT_DATA ): + rc = "AES - Invalid input data"; + break; + + case -( MBEDTLS_ERR_AES_FEATURE_UNAVAILABLE ): + rc = "AES - Feature not available. For example, an unsupported AES key size"; + break; + + case -( MBEDTLS_ERR_AES_HW_ACCEL_FAILED ): + rc = "AES - AES hardware accelerator failed"; + break; + #endif /* MBEDTLS_AES_C */ + + #if defined( MBEDTLS_ARC4_C ) + case -( MBEDTLS_ERR_ARC4_HW_ACCEL_FAILED ): + rc = "ARC4 - ARC4 hardware accelerator failed"; + break; + #endif /* MBEDTLS_ARC4_C */ + + #if defined( MBEDTLS_ARIA_C ) + case -( MBEDTLS_ERR_ARIA_BAD_INPUT_DATA ): + rc = "ARIA - Bad input data"; + break; + + case -( MBEDTLS_ERR_ARIA_INVALID_INPUT_LENGTH ): + rc = "ARIA - Invalid data input length"; + break; + + case -( MBEDTLS_ERR_ARIA_FEATURE_UNAVAILABLE ): + rc = "ARIA - Feature not available. For example, an unsupported ARIA key size"; + break; + + case -( MBEDTLS_ERR_ARIA_HW_ACCEL_FAILED ): + rc = "ARIA - ARIA hardware accelerator failed"; + break; + #endif /* MBEDTLS_ARIA_C */ + + #if defined( MBEDTLS_ASN1_PARSE_C ) + case -( MBEDTLS_ERR_ASN1_OUT_OF_DATA ): + rc = "ASN1 - Out of data when parsing an ASN1 data structure"; + break; + + case -( MBEDTLS_ERR_ASN1_UNEXPECTED_TAG ): + rc = "ASN1 - ASN1 tag was of an unexpected value"; + break; + + case -( MBEDTLS_ERR_ASN1_INVALID_LENGTH ): + rc = "ASN1 - Error when trying to determine the length or invalid length"; + break; + + case -( MBEDTLS_ERR_ASN1_LENGTH_MISMATCH ): + rc = "ASN1 - Actual length differs from expected length"; + break; + + case -( MBEDTLS_ERR_ASN1_INVALID_DATA ): + rc = "ASN1 - Data is invalid. (not used)"; + break; + + case -( MBEDTLS_ERR_ASN1_ALLOC_FAILED ): + rc = "ASN1 - Memory allocation failed"; + break; + + case -( MBEDTLS_ERR_ASN1_BUF_TOO_SMALL ): + rc = "ASN1 - Buffer too small when writing ASN.1 data structure"; + break; + #endif /* MBEDTLS_ASN1_PARSE_C */ + + #if defined( MBEDTLS_BASE64_C ) + case -( MBEDTLS_ERR_BASE64_BUFFER_TOO_SMALL ): + rc = "BASE64 - Output buffer too small"; + break; + + case -( MBEDTLS_ERR_BASE64_INVALID_CHARACTER ): + rc = "BASE64 - Invalid character in input"; + break; + #endif /* MBEDTLS_BASE64_C */ + + #if defined( MBEDTLS_BIGNUM_C ) + case -( MBEDTLS_ERR_MPI_FILE_IO_ERROR ): + rc = "BIGNUM - An error occurred while reading from or writing to a file"; + break; + + case -( MBEDTLS_ERR_MPI_BAD_INPUT_DATA ): + rc = "BIGNUM - Bad input parameters to function"; + break; + + case -( MBEDTLS_ERR_MPI_INVALID_CHARACTER ): + rc = "BIGNUM - There is an invalid character in the digit string"; + break; + + case -( MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL ): + rc = "BIGNUM - The buffer is too small to write to"; + break; + + case -( MBEDTLS_ERR_MPI_NEGATIVE_VALUE ): + rc = "BIGNUM - The input arguments are negative or result in illegal output"; + break; + + case -( MBEDTLS_ERR_MPI_DIVISION_BY_ZERO ): + rc = "BIGNUM - The input argument for division is zero, which is not allowed"; + break; + + case -( MBEDTLS_ERR_MPI_NOT_ACCEPTABLE ): + rc = "BIGNUM - The input arguments are not acceptable"; + break; + + case -( MBEDTLS_ERR_MPI_ALLOC_FAILED ): + rc = "BIGNUM - Memory allocation failed"; + break; + #endif /* MBEDTLS_BIGNUM_C */ + + #if defined( MBEDTLS_BLOWFISH_C ) + case -( MBEDTLS_ERR_BLOWFISH_BAD_INPUT_DATA ): + rc = "BLOWFISH - Bad input data"; + break; + + case -( MBEDTLS_ERR_BLOWFISH_INVALID_INPUT_LENGTH ): + rc = "BLOWFISH - Invalid data input length"; + break; + + case -( MBEDTLS_ERR_BLOWFISH_HW_ACCEL_FAILED ): + rc = "BLOWFISH - Blowfish hardware accelerator failed"; + break; + #endif /* MBEDTLS_BLOWFISH_C */ + + #if defined( MBEDTLS_CAMELLIA_C ) + case -( MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA ): + rc = "CAMELLIA - Bad input data"; + break; + + case -( MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH ): + rc = "CAMELLIA - Invalid data input length"; + break; + + case -( MBEDTLS_ERR_CAMELLIA_HW_ACCEL_FAILED ): + rc = "CAMELLIA - Camellia hardware accelerator failed"; + break; + #endif /* MBEDTLS_CAMELLIA_C */ + + #if defined( MBEDTLS_CCM_C ) + case -( MBEDTLS_ERR_CCM_BAD_INPUT ): + rc = "CCM - Bad input parameters to the function"; + break; + + case -( MBEDTLS_ERR_CCM_AUTH_FAILED ): + rc = "CCM - Authenticated decryption failed"; + break; + + case -( MBEDTLS_ERR_CCM_HW_ACCEL_FAILED ): + rc = "CCM - CCM hardware accelerator failed"; + break; + #endif /* MBEDTLS_CCM_C */ + + #if defined( MBEDTLS_CHACHA20_C ) + case -( MBEDTLS_ERR_CHACHA20_BAD_INPUT_DATA ): + rc = "CHACHA20 - Invalid input parameter(s)"; + break; + + case -( MBEDTLS_ERR_CHACHA20_FEATURE_UNAVAILABLE ): + rc = "CHACHA20 - Feature not available. For example, s part of the API is not implemented"; + break; + + case -( MBEDTLS_ERR_CHACHA20_HW_ACCEL_FAILED ): + rc = "CHACHA20 - Chacha20 hardware accelerator failed"; + break; + #endif /* MBEDTLS_CHACHA20_C */ + + #if defined( MBEDTLS_CHACHAPOLY_C ) + case -( MBEDTLS_ERR_CHACHAPOLY_BAD_STATE ): + rc = "CHACHAPOLY - The requested operation is not permitted in the current state"; + break; + + case -( MBEDTLS_ERR_CHACHAPOLY_AUTH_FAILED ): + rc = "CHACHAPOLY - Authenticated decryption failed: data was not authentic"; + break; + #endif /* MBEDTLS_CHACHAPOLY_C */ + + #if defined( MBEDTLS_CMAC_C ) + case -( MBEDTLS_ERR_CMAC_HW_ACCEL_FAILED ): + rc = "CMAC - CMAC hardware accelerator failed"; + break; + #endif /* MBEDTLS_CMAC_C */ + + #if defined( MBEDTLS_CTR_DRBG_C ) + case -( MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED ): + rc = "CTR_DRBG - The entropy source failed"; + break; + + case -( MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG ): + rc = "CTR_DRBG - The requested random buffer length is too big"; + break; + + case -( MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG ): + rc = "CTR_DRBG - The input (entropy + additional data) is too large"; + break; + + case -( MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR ): + rc = "CTR_DRBG - Read or write error in file"; + break; + #endif /* MBEDTLS_CTR_DRBG_C */ + + #if defined( MBEDTLS_DES_C ) + case -( MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH ): + rc = "DES - The data input has an invalid length"; + break; + + case -( MBEDTLS_ERR_DES_HW_ACCEL_FAILED ): + rc = "DES - DES hardware accelerator failed"; + break; + #endif /* MBEDTLS_DES_C */ + + #if defined( MBEDTLS_ENTROPY_C ) + case -( MBEDTLS_ERR_ENTROPY_SOURCE_FAILED ): + rc = "ENTROPY - Critical entropy source failure"; + break; + + case -( MBEDTLS_ERR_ENTROPY_MAX_SOURCES ): + rc = "ENTROPY - No more sources can be added"; + break; + + case -( MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED ): + rc = "ENTROPY - No sources have been added to poll"; + break; + + case -( MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE ): + rc = "ENTROPY - No strong sources have been added to poll"; + break; + + case -( MBEDTLS_ERR_ENTROPY_FILE_IO_ERROR ): + rc = "ENTROPY - Read/write error in file"; + break; + #endif /* MBEDTLS_ENTROPY_C */ + + #if defined( MBEDTLS_GCM_C ) + case -( MBEDTLS_ERR_GCM_AUTH_FAILED ): + rc = "GCM - Authenticated decryption failed"; + break; + + case -( MBEDTLS_ERR_GCM_HW_ACCEL_FAILED ): + rc = "GCM - GCM hardware accelerator failed"; + break; + + case -( MBEDTLS_ERR_GCM_BAD_INPUT ): + rc = "GCM - Bad input parameters to function"; + break; + #endif /* MBEDTLS_GCM_C */ + + #if defined( MBEDTLS_HKDF_C ) + case -( MBEDTLS_ERR_HKDF_BAD_INPUT_DATA ): + rc = "HKDF - Bad input parameters to function"; + break; + #endif /* MBEDTLS_HKDF_C */ + + #if defined( MBEDTLS_HMAC_DRBG_C ) + case -( MBEDTLS_ERR_HMAC_DRBG_REQUEST_TOO_BIG ): + rc = "HMAC_DRBG - Too many random requested in single call"; + break; + + case -( MBEDTLS_ERR_HMAC_DRBG_INPUT_TOO_BIG ): + rc = "HMAC_DRBG - Input too large (Entropy + additional)"; + break; + + case -( MBEDTLS_ERR_HMAC_DRBG_FILE_IO_ERROR ): + rc = "HMAC_DRBG - Read/write error in file"; + break; + + case -( MBEDTLS_ERR_HMAC_DRBG_ENTROPY_SOURCE_FAILED ): + rc = "HMAC_DRBG - The entropy source failed"; + break; + #endif /* MBEDTLS_HMAC_DRBG_C */ + + #if defined( MBEDTLS_MD2_C ) + case -( MBEDTLS_ERR_MD2_HW_ACCEL_FAILED ): + rc = "MD2 - MD2 hardware accelerator failed"; + break; + #endif /* MBEDTLS_MD2_C */ + + #if defined( MBEDTLS_MD4_C ) + case -( MBEDTLS_ERR_MD4_HW_ACCEL_FAILED ): + rc = "MD4 - MD4 hardware accelerator failed"; + break; + #endif /* MBEDTLS_MD4_C */ + + #if defined( MBEDTLS_MD5_C ) + case -( MBEDTLS_ERR_MD5_HW_ACCEL_FAILED ): + rc = "MD5 - MD5 hardware accelerator failed"; + break; + #endif /* MBEDTLS_MD5_C */ + + #if defined( MBEDTLS_NET_C ) + case -( MBEDTLS_ERR_NET_SOCKET_FAILED ): + rc = "NET - Failed to open a socket"; + break; + + case -( MBEDTLS_ERR_NET_CONNECT_FAILED ): + rc = "NET - The connection to the given server / port failed"; + break; + + case -( MBEDTLS_ERR_NET_BIND_FAILED ): + rc = "NET - Binding of the socket failed"; + break; + + case -( MBEDTLS_ERR_NET_LISTEN_FAILED ): + rc = "NET - Could not listen on the socket"; + break; + + case -( MBEDTLS_ERR_NET_ACCEPT_FAILED ): + rc = "NET - Could not accept the incoming connection"; + break; + + case -( MBEDTLS_ERR_NET_RECV_FAILED ): + rc = "NET - Reading information from the socket failed"; + break; + + case -( MBEDTLS_ERR_NET_SEND_FAILED ): + rc = "NET - Sending information through the socket failed"; + break; + + case -( MBEDTLS_ERR_NET_CONN_RESET ): + rc = "NET - Connection was reset by peer"; + break; + + case -( MBEDTLS_ERR_NET_UNKNOWN_HOST ): + rc = "NET - Failed to get an IP address for the given hostname"; + break; + + case -( MBEDTLS_ERR_NET_BUFFER_TOO_SMALL ): + rc = "NET - Buffer is too small to hold the data"; + break; + + case -( MBEDTLS_ERR_NET_INVALID_CONTEXT ): + rc = "NET - The context is invalid, eg because it was free()ed"; + break; + + case -( MBEDTLS_ERR_NET_POLL_FAILED ): + rc = "NET - Polling the net context failed"; + break; + + case -( MBEDTLS_ERR_NET_BAD_INPUT_DATA ): + rc = "NET - Input invalid"; + break; + #endif /* MBEDTLS_NET_C */ + + #if defined( MBEDTLS_OID_C ) + case -( MBEDTLS_ERR_OID_NOT_FOUND ): + rc = "OID - OID is not found"; + break; + + case -( MBEDTLS_ERR_OID_BUF_TOO_SMALL ): + rc = "OID - output buffer is too small"; + break; + #endif /* MBEDTLS_OID_C */ + + #if defined( MBEDTLS_PADLOCK_C ) + case -( MBEDTLS_ERR_PADLOCK_DATA_MISALIGNED ): + rc = "PADLOCK - Input data should be aligned"; + break; + #endif /* MBEDTLS_PADLOCK_C */ + + #if defined( MBEDTLS_PLATFORM_C ) + case -( MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED ): + rc = "PLATFORM - Hardware accelerator failed"; + break; + + case -( MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED ): + rc = "PLATFORM - The requested feature is not supported by the platform"; + break; + #endif /* MBEDTLS_PLATFORM_C */ + + #if defined( MBEDTLS_POLY1305_C ) + case -( MBEDTLS_ERR_POLY1305_BAD_INPUT_DATA ): + rc = "POLY1305 - Invalid input parameter(s)"; + break; + + case -( MBEDTLS_ERR_POLY1305_FEATURE_UNAVAILABLE ): + rc = "POLY1305 - Feature not available. For example, s part of the API is not implemented"; + break; + + case -( MBEDTLS_ERR_POLY1305_HW_ACCEL_FAILED ): + rc = "POLY1305 - Poly1305 hardware accelerator failed"; + break; + #endif /* MBEDTLS_POLY1305_C */ + + #if defined( MBEDTLS_RIPEMD160_C ) + case -( MBEDTLS_ERR_RIPEMD160_HW_ACCEL_FAILED ): + rc = "RIPEMD160 - RIPEMD160 hardware accelerator failed"; + break; + #endif /* MBEDTLS_RIPEMD160_C */ + + #if defined( MBEDTLS_SHA1_C ) + case -( MBEDTLS_ERR_SHA1_HW_ACCEL_FAILED ): + rc = "SHA1 - SHA-1 hardware accelerator failed"; + break; + + case -( MBEDTLS_ERR_SHA1_BAD_INPUT_DATA ): + rc = "SHA1 - SHA-1 input data was malformed"; + break; + #endif /* MBEDTLS_SHA1_C */ + + #if defined( MBEDTLS_SHA256_C ) + case -( MBEDTLS_ERR_SHA256_HW_ACCEL_FAILED ): + rc = "SHA256 - SHA-256 hardware accelerator failed"; + break; + + case -( MBEDTLS_ERR_SHA256_BAD_INPUT_DATA ): + rc = "SHA256 - SHA-256 input data was malformed"; + break; + #endif /* MBEDTLS_SHA256_C */ + + #if defined( MBEDTLS_SHA512_C ) + case -( MBEDTLS_ERR_SHA512_HW_ACCEL_FAILED ): + rc = "SHA512 - SHA-512 hardware accelerator failed"; + break; + + case -( MBEDTLS_ERR_SHA512_BAD_INPUT_DATA ): + rc = "SHA512 - SHA-512 input data was malformed"; + break; + #endif /* MBEDTLS_SHA512_C */ + + #if defined( MBEDTLS_THREADING_C ) + case -( MBEDTLS_ERR_THREADING_FEATURE_UNAVAILABLE ): + rc = "THREADING - The selected feature is not available"; + break; + + case -( MBEDTLS_ERR_THREADING_BAD_INPUT_DATA ): + rc = "THREADING - Bad input parameters to function"; + break; + + case -( MBEDTLS_ERR_THREADING_MUTEX_ERROR ): + rc = "THREADING - Locking / unlocking / free failed with error code"; + break; + #endif /* MBEDTLS_THREADING_C */ + + #if defined( MBEDTLS_XTEA_C ) + case -( MBEDTLS_ERR_XTEA_INVALID_INPUT_LENGTH ): + rc = "XTEA - The data input has an invalid length"; + break; + + case -( MBEDTLS_ERR_XTEA_HW_ACCEL_FAILED ): + rc = "XTEA - XTEA hardware accelerator failed"; + break; + #endif /* MBEDTLS_XTEA_C */ + } + + return rc; +} diff --git a/FreeRTOS-Plus/Source/Application-Protocols/platform/freertos/mbedtls/mbedtls_error.h b/FreeRTOS-Plus/Source/Application-Protocols/platform/freertos/mbedtls/mbedtls_error.h new file mode 100644 index 0000000000..db838074bd --- /dev/null +++ b/FreeRTOS-Plus/Source/Application-Protocols/platform/freertos/mbedtls/mbedtls_error.h @@ -0,0 +1,58 @@ +/* + * FreeRTOS Error Code Stringification utilities for mbed TLS v2.16.0 + * 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. + * + */ + +/** + * @file mbedtls_error.h + * @brief Stringification utilities for high-level and low-level codes of mbed TLS. + */ + + +#ifdef __cplusplus + extern "C" { +#endif + +/** + * @brief Translate an mbed TLS high level code into its string representation. + * Result includes a terminating null byte. + * + * @param errnum The error code containing the high-level code. + * @return The string representation if high-level code is present; otherwise NULL. + * + * @warning The string returned by this function must never be modified. + */ +const char * mbedtls_strerror_highlevel( int errnum ); + +/** + * @brief Translate an mbed TLS low level code into its string representation, + * Result includes a terminating null byte. + * + * @param errnum The error code containing the low-level code. + * @return The string representation if low-level code is present; otherwise NULL. + * + * @warning The string returned by this function must never be modified. + */ +const char * mbedtls_strerror_lowlevel( int errnum ); + +#ifdef __cplusplus + } +#endif diff --git a/FreeRTOS-Plus/ThirdParty/mbedtls b/FreeRTOS-Plus/ThirdParty/mbedtls new file mode 160000 index 0000000000..72ca39737f --- /dev/null +++ b/FreeRTOS-Plus/ThirdParty/mbedtls @@ -0,0 +1 @@ +Subproject commit 72ca39737f974db44723760623d1b29980c00a88