Add cellular library submodule path and demo (#695)

* [Cellular] Add cellulr lib submodule and demo app

* [Cellular] Fix memory violation in transport layer and add using LoggingPrintf

* Update FreeRTOS Cellular Interface

* Change the mbedtls usage in FreeRTOS-Plus

* [Cellular] Fix missing spell

* [Cellular] Add manifest.yml

* Fix missing spell

* Update manifest.yml

* [Cellular] Add integration test

* Modify the demo log level to LOG_INFO

* Update cellular interface

* The modification of the folder structure for cellular library

* Rename the naming of demo

* Adjust the location of using_mbedtls and socket_wrapper

* Adjust project setting for relocating using_mbedtls and socket_wrapper

* Turn off PSM mode

* Add start marker for CI validation.

* The modification for mbedtls platform send/recv function for cellular

* Change the project file due to the changes of mbedtls platform send/recv function for cellular

* Fix missing newline and remove unused file

* Add missing configuration.

* Make cellular and freertos tcp plus use the same transport implementation

* Add comment for the macro MBEDTLS_SSL_SEND and MBEDTLS_SSL_RECV

* Make changes from the github comment.

FreeRTOS-Plus/Source/Application-Protocols/network_transport/sockets_wrapper/cellular/sockets_wrapper.h

@@ -0,0 +1,136 @@
+/*
+ * Amazon FreeRTOS CELLULAR Preview Release
+ * 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 sockets_wrapper.h
+ * @brief FreeRTOS Sockets connect and disconnect function wrapper.
+ */
+
+#ifndef SOCKETS_WRAPPER_H
+#define SOCKETS_WRAPPER_H
+
+/**************************************************/
+/******* DO NOT CHANGE the following order ********/
+/**************************************************/
+
+/* Logging related header files are required to be included in the following order:
+ * 1. Include the header file "logging_levels.h".
+ * 2. Define LIBRARY_LOG_NAME and  LIBRARY_LOG_LEVEL.
+ * 3. Include the header file "logging_stack.h".
+ */
+
+/* Include header that defines log levels. */
+#include "logging_levels.h"
+
+/* Logging configuration for the Sockets. */
+#ifndef LIBRARY_LOG_NAME
+    #define LIBRARY_LOG_NAME     "Sockets"
+#endif
+#ifndef LIBRARY_LOG_LEVEL
+    #define LIBRARY_LOG_LEVEL    LOG_INFO
+#endif
+
+#include "logging_stack.h"
+
+/************ End of logging configuration ****************/
+
+#define SOCKETS_ERROR_NONE          ( 0 )          /*!< No error. */
+#define SOCKETS_SOCKET_ERROR        ( -1 )         /*!< Catch-all sockets error code. */
+#define SOCKETS_EWOULDBLOCK         ( -11 )        /*!< A resource is temporarily unavailable. */
+#define SOCKETS_ENOMEM              ( -12 )        /*!< Memory allocation failed. */
+#define SOCKETS_EINVAL              ( -22 )        /*!< Invalid argument. */
+#define SOCKETS_ENOPROTOOPT         ( -109 )       /*!< A bad option was specified . */
+#define SOCKETS_ENOTCONN            ( -126 )       /*!< The supplied socket is not connected. */
+#define SOCKETS_EISCONN             ( -127 )       /*!< The supplied socket is already connected. */
+#define SOCKETS_ECLOSED             ( -128 )       /*!< The supplied socket has already been closed. */
+#define SOCKETS_PERIPHERAL_RESET    ( -1006 )      /*!< Communications peripheral has been reset. */
+
+#define SOCKETS_INVALID_SOCKET      ( ( Socket_t ) ~0U )
+
+struct xSOCKET;
+typedef struct xSOCKET * Socket_t; /**< @brief Socket handle data type. */
+
+/**
+ * @brief Establish a connection to server.
+ *
+ * @param[out] pTcpSocket The output parameter to return the created socket descriptor.
+ * @param[in] pHostName Server hostname to connect to.
+ * @param[in] pServerInfo Server port to connect to.
+ * @param[in] receiveTimeoutMs Timeout (in milliseconds) for transport receive.
+ * @param[in] sendTimeoutMs Timeout (in milliseconds) for transport send.
+ *
+ * @note A timeout of 0 means infinite timeout.
+ *
+ * @return Non-zero value on error, 0 on success.
+ */
+BaseType_t Sockets_Connect( Socket_t * pTcpSocket,
+                            const char * pHostName,
+                            uint16_t port,
+                            uint32_t receiveTimeoutMs,
+                            uint32_t sendTimeoutMs );
+
+/**
+ * @brief End connection to server.
+ *
+ * @param[in] tcpSocket The socket descriptor.
+ */
+void Sockets_Disconnect( Socket_t tcpSocket );
+
+/**
+ * @brief Transmit data to the remote socket.
+ *
+ * The socket must have already been created using a call to Sockets_Connect().
+ *
+ * @param[in] xSocket The handle of the sending socket.
+ * @param[in] pvBuffer The buffer containing the data to be sent.
+ * @param[in] xDataLength The length of the data to be sent.
+ *
+ * @return
+ * * On success, the number of bytes actually sent is returned.
+ * * If an error occurred, a negative value is returned. @ref SocketsErrors
+ */
+int32_t Sockets_Send( Socket_t xSocket,
+                      const void * pvBuffer,
+                      size_t xDataLength );
+
+/**
+ * @brief Receive data from a TCP socket.
+ *
+ * The socket must have already been created using a call to Sockets_Connect().
+ *
+ * @param[in] xSocket The handle of the socket from which data is being received.
+ * @param[out] pvBuffer The buffer into which the received data will be placed.
+ * @param[in] xBufferLength The maximum number of bytes which can be received.
+ * pvBuffer must be at least xBufferLength bytes long.
+ *
+ * @return
+ * * If the receive was successful then the number of bytes received (placed in the
+ *   buffer pointed to by pvBuffer) is returned.
+ * * If a timeout occurred before data could be received then 0 is returned (timeout
+ *   is set using @ref SOCKETS_SO_RCVTIMEO).
+ * * If an error occurred, a negative value is returned. @ref SocketsErrors
+ */
+int32_t Sockets_Recv( Socket_t xSocket,
+                      void * pvBuffer,
+                      size_t xBufferLength );
+
+#endif /* ifndef SOCKETS_WRAPPER_H */

FreeRTOS-Plus/Source/Application-Protocols/network_transport/using_mbedtls/using_mbedtls/using_mbedtls.c

@@ -48,8 +48,8 @@
 
 /*-----------------------------------------------------------*/
 
-/** 
- * @brief Each compilation unit that consumes the NetworkContext must define it. 
+/**
+ * @brief Each compilation unit that consumes the NetworkContext must define it.
  * It should contain a single pointer as seen below whenever the header file
  * of this transport implementation is included to your project.
  *
@@ -79,7 +79,7 @@ static const char * pNoLowLevelMbedTlsCodeStr = "<No-Low-Level-Code>";
  * @brief Utility for converting the high-level code in an mbedTLS error to string,
  * if the code-contains a high-level code; otherwise, using a default string.
  */
-#define mbedtlsHighLevelCodeOrDefault( mbedTlsCode )        \
+#define mbedtlsHighLevelCodeOrDefault( mbedTlsCode )       \
     ( mbedtls_high_level_strerr( mbedTlsCode ) != NULL ) ? \
     mbedtls_high_level_strerr( mbedTlsCode ) : pNoHighLevelMbedTlsCodeStr
 
@@ -87,7 +87,7 @@ static const char * pNoLowLevelMbedTlsCodeStr = "<No-Low-Level-Code>";
  * @brief Utility for converting the level-level code in an mbedTLS error to string,
  * if the code-contains a level-level code; otherwise, using a default string.
  */
-#define mbedtlsLowLevelCodeOrDefault( mbedTlsCode )        \
+#define mbedtlsLowLevelCodeOrDefault( mbedTlsCode )       \
     ( mbedtls_low_level_strerr( mbedTlsCode ) != NULL ) ? \
     mbedtls_low_level_strerr( mbedTlsCode ) : pNoLowLevelMbedTlsCodeStr
 
@@ -525,10 +525,14 @@ static TlsTransportStatus_t tlsHandshake( NetworkContext_t * pNetworkContext,
          * #mbedtls_ssl_set_bio requires the second parameter as void *.
          */
         /* coverity[misra_c_2012_rule_11_2_violation] */
+
+        /* These two macros MBEDTLS_SSL_SEND and MBEDTLS_SSL_RECV need to be
+         * defined in mbedtls_config.h according to which implementation you use.
+         */
         mbedtls_ssl_set_bio( &( pTlsTransportParams->sslContext.context ),
                              ( void * ) pTlsTransportParams->tcpSocket,
-                             mbedtls_platform_send,
-                             mbedtls_platform_recv,
+                             MBEDTLS_SSL_SEND,
+                             MBEDTLS_SSL_RECV,
                              NULL );
     }
 

FreeRTOS-Plus/Source/Application-Protocols/network_transport/using_mbedtls/using_mbedtls_pkcs11/using_mbedtls_pkcs11.c

@@ -389,8 +389,8 @@ static TlsTransportStatus_t tlsSetup( NetworkContext_t * pNetworkContext,
             /* coverity[misra_c_2012_rule_11_2_violation] */
             mbedtls_ssl_set_bio( &( pTlsTransportParams->sslContext.context ),
                                  ( void * ) pTlsTransportParams->tcpSocket,
-                                 mbedtls_platform_send,
-                                 mbedtls_platform_recv,
+                                 MBEDTLS_SSL_SEND,
+                                 MBEDTLS_SSL_RECV,
                                  NULL );
         }
     }

FreeRTOS-Plus/Source/Utilities/mbedtls_freertos/mbedtls_bio_freertos_cellular.c

@@ -0,0 +1,96 @@
+/*
+ * FreeRTOS V202107.00
+ * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of
+ * this software and associated documentation files (the "Software"), to deal in
+ * the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+ * the Software, and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+ * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+ * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ *
+ * https://www.FreeRTOS.org
+ * https://github.com/FreeRTOS
+ *
+ */
+
+/**
+ * @file mbedtls_bio_freertos_cellular.c
+ * @brief Implements mbed TLS platform send/receive functions for cellular.
+ */
+
+/* FreeRTOS includes. */
+#include "FreeRTOS.h"
+#include "FreeRTOS_Sockets.h"
+
+/* mbed TLS includes. */
+#include "mbedtls_config.h"
+#include "threading_alt.h"
+#include "mbedtls/entropy.h"
+#include "mbedtls/ssl.h"
+
+/*-----------------------------------------------------------*/
+
+/**
+ * @brief Sends data over cellular sockets.
+ *
+ * @param[in] ctx The network context containing the socket handle.
+ * @param[in] buf Buffer containing the bytes to send.
+ * @param[in] len Number of bytes to send from the buffer.
+ *
+ * @return Number of bytes sent on success; else a negative value.
+ */
+int mbedtls_cellular_send( void * ctx,
+                           const unsigned char * buf,
+                           size_t len )
+{
+    configASSERT( ctx != NULL );
+    configASSERT( buf != NULL );
+
+    return Sockets_Send( ( Socket_t ) ctx, buf, len );
+}
+
+/*-----------------------------------------------------------*/
+
+/**
+ * @brief Receives data from cellular socket.
+ *
+ * @param[in] ctx The network context containing the socket handle.
+ * @param[out] buf Buffer to receive bytes into.
+ * @param[in] len Number of bytes to receive from the network.
+ *
+ * @return Number of bytes received if successful; Negative value on error.
+ */
+int mbedtls_cellular_recv( void * ctx,
+                           unsigned char * buf,
+                           size_t len )
+{
+    int recvStatus = 0;
+    int returnStatus = -1;
+
+    configASSERT( ctx != NULL );
+    configASSERT( buf != NULL );
+
+    recvStatus = Sockets_Recv( ( Socket_t ) ctx, buf, len );
+
+    if( recvStatus < 0 )
+    {
+        returnStatus = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
+    }
+    else
+    {
+        returnStatus = recvStatus;
+    }
+
+    return returnStatus;
+}

FreeRTOS-Plus/Source/Utilities/mbedtls_freertos/mbedtls_bio_freertos_plus_tcp.c

@@ -0,0 +1,136 @@
+/*
+ * FreeRTOS V202107.00
+ * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of
+ * this software and associated documentation files (the "Software"), to deal in
+ * the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+ * the Software, and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+ * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+ * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ *
+ * https://www.FreeRTOS.org
+ * https://github.com/FreeRTOS
+ *
+ */
+
+/**
+ * @file mbedtls_bio_freertos_plus_tcp.c
+ * @brief Implements mbed TLS platform send/receive functions for freertos plus tcp.
+ */
+
+/* FreeRTOS includes. */
+#include "FreeRTOS.h"
+#include "FreeRTOS_Sockets.h"
+
+/* mbed TLS includes. */
+#include "mbedtls_config.h"
+#include "threading_alt.h"
+#include "mbedtls/entropy.h"
+#include "mbedtls/ssl.h"
+
+/*-----------------------------------------------------------*/
+
+/**
+ * @brief Sends data over FreeRTOS+TCP sockets.
+ *
+ * @param[in] ctx The network context containing the socket handle.
+ * @param[in] buf Buffer containing the bytes to send.
+ * @param[in] len Number of bytes to send from the buffer.
+ *
+ * @return Number of bytes sent on success; else a negative value.
+ */
+int mbedtls_platform_send( void * ctx,
+                           const unsigned char * buf,
+                           size_t len )
+{
+    BaseType_t sendStatus = 0;
+    int returnStatus = -1;
+
+    configASSERT( ctx != NULL );
+    configASSERT( buf != NULL );
+
+    sendStatus = FreeRTOS_send( ( Socket_t ) ctx, buf, len, 0 );
+
+    switch( sendStatus )
+    {
+        /* Socket was closed or just got closed. */
+        case -pdFREERTOS_ERRNO_ENOTCONN:
+        /* Not enough memory for the socket to create either an Rx or Tx stream. */
+        case -pdFREERTOS_ERRNO_ENOMEM:
+        /* Socket is not valid, is not a TCP socket, or is not bound. */
+        case -pdFREERTOS_ERRNO_EINVAL:
+        /* Socket received a signal, causing the read operation to be aborted. */
+        case -pdFREERTOS_ERRNO_EINTR:
+            returnStatus = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
+            break;
+
+        /* A timeout occurred before any data could be sent. */
+        case -pdFREERTOS_ERRNO_ENOSPC:
+            returnStatus = MBEDTLS_ERR_SSL_TIMEOUT;
+            break;
+
+        default:
+            returnStatus = ( int ) sendStatus;
+            break;
+    }
+
+    return returnStatus;
+}
+
+/*-----------------------------------------------------------*/
+
+/**
+ * @brief Receives data from FreeRTOS+TCP socket.
+ *
+ * @param[in] ctx The network context containing the socket handle.
+ * @param[out] buf Buffer to receive bytes into.
+ * @param[in] len Number of bytes to receive from the network.
+ *
+ * @return Number of bytes received if successful; Negative value on error.
+ */
+int mbedtls_platform_recv( void * ctx,
+                           unsigned char * buf,
+                           size_t len )
+{
+    BaseType_t recvStatus = 0;
+    int returnStatus = -1;
+
+    configASSERT( ctx != NULL );
+    configASSERT( buf != NULL );
+
+    recvStatus = FreeRTOS_recv( ( Socket_t ) ctx, buf, len, 0 );
+
+    switch( recvStatus )
+    {
+        /* No data could be sent because the socket was or just got closed. */
+        case -pdFREERTOS_ERRNO_ENOTCONN:
+        /* No data could be sent because there was insufficient memory. */
+        case -pdFREERTOS_ERRNO_ENOMEM:
+        /* No data could be sent because xSocket was not a valid TCP socket. */
+        case -pdFREERTOS_ERRNO_EINVAL:
+            returnStatus = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
+            break;
+
+        /* A timeout occurred before any data could be received. */
+        case 0:
+            returnStatus = MBEDTLS_ERR_SSL_WANT_READ;
+            break;
+
+        default:
+            returnStatus = ( int ) recvStatus;
+            break;
+    }
+
+    return returnStatus;
+}

FreeRTOS-Plus/Source/Utilities/mbedtls_freertos/mbedtls_freertos_port.c

@@ -98,107 +98,6 @@ void mbedtls_platform_free( void * ptr )
 
 /*-----------------------------------------------------------*/
 
-/**
- * @brief Sends data over FreeRTOS+TCP sockets.
- *
- * @param[in] ctx The network context containing the socket handle.
- * @param[in] buf Buffer containing the bytes to send.
- * @param[in] len Number of bytes to send from the buffer.
- *
- * @return Number of bytes sent on success; else a negative value.
- */
-int mbedtls_platform_send( void * ctx,
-                           const unsigned char * buf,
-                           size_t len )
-{
-    Socket_t socket;
-    BaseType_t sendStatus = 0;
-    int returnStatus = -1;
-
-    configASSERT( ctx != NULL );
-    configASSERT( buf != NULL );
-
-    socket = ( Socket_t ) ctx;
-    sendStatus = FreeRTOS_send( socket, buf, len, 0 );
-
-    switch( sendStatus )
-    {
-        /* Socket was closed or just got closed. */
-        case -pdFREERTOS_ERRNO_ENOTCONN:
-        /* Not enough memory for the socket to create either an Rx or Tx stream. */
-        case -pdFREERTOS_ERRNO_ENOMEM:
-        /* Socket is not valid, is not a TCP socket, or is not bound. */
-        case -pdFREERTOS_ERRNO_EINVAL:
-        /* Socket received a signal, causing the read operation to be aborted. */
-        case -pdFREERTOS_ERRNO_EINTR:
-            returnStatus = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
-            break;
-
-        /* A timeout occurred before any data could be sent. */
-        case -pdFREERTOS_ERRNO_ENOSPC:
-            returnStatus = MBEDTLS_ERR_SSL_TIMEOUT;
-            break;
-
-        default:
-            returnStatus = ( int ) sendStatus;
-            break;
-    }
-
-    return returnStatus;
-}
-
-/*-----------------------------------------------------------*/
-
-/**
- * @brief Receives data from FreeRTOS+TCP socket.
- *
- * @param[in] ctx The network context containing the socket handle.
- * @param[out] buf Buffer to receive bytes into.
- * @param[in] len Number of bytes to receive from the network.
- *
- * @return Number of bytes received if successful; Negative value on error.
- */
-int mbedtls_platform_recv( void * ctx,
-                           unsigned char * buf,
-                           size_t len )
-{
-    Socket_t socket;
-    BaseType_t recvStatus = 0;
-    int returnStatus = -1;
-
-    configASSERT( ctx != NULL );
-    configASSERT( buf != NULL );
-
-    socket = ( Socket_t ) ctx;
-
-    recvStatus = FreeRTOS_recv( socket, buf, len, 0 );
-
-    switch( recvStatus )
-    {
-        /* No data could be sent because the socket was or just got closed. */
-        case -pdFREERTOS_ERRNO_ENOTCONN:
-        /* No data could be sent because there was insufficient memory. */
-        case -pdFREERTOS_ERRNO_ENOMEM:
-        /* No data could be sent because xSocket was not a valid TCP socket. */
-        case -pdFREERTOS_ERRNO_EINVAL:
-            returnStatus = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
-            break;
-
-        /* A timeout occurred before any data could be received. */
-        case 0:
-            returnStatus = MBEDTLS_ERR_SSL_WANT_READ;
-            break;
-
-        default:
-            returnStatus = ( int ) recvStatus;
-            break;
-    }
-
-    return returnStatus;
-}
-
-/*-----------------------------------------------------------*/
-
 /**
  * @brief Creates a mutex.
  *