/* * FreeRTOS Secure Sockets V1.3.1 * Copyright (C) 2021 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 iot_secure_sockets.h * @brief Secure Sockets Interface. * * Secure sockets is a portable layer for establishing a TCP/IP * connection, with the option of using TLS. * * Secure sockets is based on the Berkeley sockets API. * A few difference general differences between Berkeley and SOCKETS are: * - SOCKETS has additional socket options to enable TLS, server name * indication, and per-socket root of trust server certificates. See * SOCKETS_SetSockOpt() for more information. * - SOCKETS API return an error code, rather than returning -1 and setting * a global errno value. * */ #ifndef _AWS_SECURE_SOCKETS_H_ #define _AWS_SECURE_SOCKETS_H_ /* #ifdef __cplusplus * extern "C" { #endif */ #include #include #include "iot_secure_sockets_config.h" #include "iot_secure_sockets_config_defaults.h" #include "iot_lib_init.h" /** * @ingroup SecureSockets_datatypes_handles * @brief The socket handle data type. * * For detail of socket, refer to [Network Sockets] * (https://www.freertos.org/FreeRTOS-Plus/FreeRTOS_Plus_TCP/socket.html) * * Data contained by the Socket_t type is port specific. */ struct xSOCKET; typedef struct xSOCKET * Socket_t; /**< @brief Socket handle data type. */ /** * @brief The "size_t" of secure sockets. * * This type is used for compatibility with the expected Berkeley sockets * naming. */ #define Socklen_t uint32_t /** * @anchor SocketsErrors * @name SocketsErrors * @brief Error codes returned by the SOCKETS API. * * Note that SOCKETS API may also propagate port-specific * error codes when they are more descriptive. See your * port's error codes for more details. * PORT_SPECIFIC_LINK */ /**@{ */ #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_TLS_INIT_ERROR ( -1001 ) /*!< TLS initialization failed. */ #define SOCKETS_TLS_HANDSHAKE_ERROR ( -1002 ) /*!< TLS handshake failed. */ #define SOCKETS_TLS_SERVER_UNVERIFIED ( -1003 ) /*!< A connection was made but the server could not be verified. It is recommended that the socket be closed. */ #define SOCKETS_TLS_RECV_ERROR ( -1004 ) /*!< TLS receive operation failed. */ #define SOCKETS_TLS_SEND_ERROR ( -1005 ) /*!< TLS send operation failed. */ #define SOCKETS_PERIPHERAL_RESET ( -1006 ) /*!< Communications peripheral has been reset. */ /**@} */ /** * @brief Assigned to an Socket_t variable when the socket is not valid. */ #define SOCKETS_INVALID_SOCKET ( ( Socket_t ) ~0U ) /** * @anchor SocketDomains * @name SocketDomains * * @brief Options for the lDomain parameter of SOCKETS_Socket() * function. * * These select the protocol family to be used for communication. */ /**@{ */ #define SOCKETS_AF_INET ( 2 ) /*!< IPv4 Internet Protocols. */ #define SOCKETS_PF_INET SOCKETS_AF_INET /*!< IPv4 Internet Protocol. */ #define SOCKETS_AF_INET6 ( 10 ) /*!< IPv6 Internet Protocols. This option is currently not supported. */ /**@} */ /** * @anchor SocketTypes * @name SocketTypes * * @brief Options for the lType parameter of SOCKETS_Socket() * function. * * These specify the communication semantics. */ /**@{ */ #define SOCKETS_SOCK_DGRAM ( 2 ) /*!< Datagram. */ #define SOCKETS_SOCK_STREAM ( 1 ) /*!< Byte-stream. */ /**@} */ /** * @anchor Protocols * @name Protocols * * @brief Options for the lProtocol parameter of SOCKETS_Socket() function. * */ /**@{ */ #define SOCKETS_IPPROTO_UDP ( 17 ) /*!< UDP. This option is currently not supported. */ #define SOCKETS_IPPROTO_TCP ( 6 ) /*!< TCP. */ /**@} */ /** * @anchor SetSockOptOptions * @name SetSockOptOptions * * @brief Options for lOptionName in SOCKETS_SetSockOpt(). * */ /**@{ */ #define SOCKETS_SO_RCVTIMEO ( 0 ) /**< Set the receive timeout. */ #define SOCKETS_SO_SNDTIMEO ( 1 ) /**< Set the send timeout. */ #define SOCKETS_SO_SNDBUF ( 4 ) /**< Set the size of the send buffer (TCP only). */ #define SOCKETS_SO_RCVBUF ( 5 ) /**< Set the size of the receive buffer (TCP only). */ #define SOCKETS_SO_SERVER_NAME_INDICATION ( 6 ) /**< Toggle client use of TLS SNI. */ #define SOCKETS_SO_TRUSTED_SERVER_CERTIFICATE ( 7 ) /**< Override default TLS server certificate trust. Must be PEM encoded and length must include null terminator. */ #define SOCKETS_SO_REQUIRE_TLS ( 8 ) /**< Toggle client enforcement of TLS. */ #define SOCKETS_SO_NONBLOCK ( 9 ) /**< Socket is nonblocking. */ #define SOCKETS_SO_ALPN_PROTOCOLS ( 10 ) /**< Application protocol list to be included in TLS ClientHello. */ #define SOCKETS_SO_WAKEUP_CALLBACK ( 17 ) /**< Set the callback to be called whenever there is data available on the socket for reading. */ #define SOCKETS_SO_TCPKEEPALIVE ( 18 ) /**< Enable or Disable TCP keep-alive functionality. */ #define SOCKETS_SO_TCPKEEPALIVE_INTERVAL ( 19 ) /**< Set the time in seconds between individual TCP keep-alive probes. */ #define SOCKETS_SO_TCPKEEPALIVE_COUNT ( 20 ) /**< Set the maximum number of keep-alive probes TCP should send before dropping the connection. */ #define SOCKETS_SO_TCPKEEPALIVE_IDLE_TIME ( 21 ) /**< Set the time in seconds for which the connection needs to remain idle before TCP starts sending keep-alive probes. */ /**@} */ /** * @anchor ShutdownFlags
* @name ShutdownFlags * * @brief Options for the ulHow parameter in SOCKETS_Shutdown(). */ /**@{ */ #define SOCKETS_SHUT_RD ( 0 ) /**< No further receives. */ #define SOCKETS_SHUT_WR ( 1 ) /**< No further sends. */ #define SOCKETS_SHUT_RDWR ( 2 ) /**< No further send or receive. */ /**@} */ /** * @brief Maximum length of an ASCII DNS name. */ #define securesocketsMAX_DNS_NAME_LENGTH ( 253 ) /** * @ingroup SecureSockets_datatypes_paramstructs * @brief Socket address. * * \sa PORT_SPECIFIC_LINK */ typedef struct SocketsSockaddr { uint8_t ucLength; /**< Length of SocketsSockaddr structure. */ uint8_t ucSocketDomain; /**< Only SOCKETS_AF_INET is supported. */ uint16_t usPort; /**< Port number. Convention is to call this sin_port. */ uint32_t ulAddress; /**< IP Address. Convention is to call this sin_addr. */ } SocketsSockaddr_t; /** * @brief Well-known port numbers. */ #define securesocketsDEFAULT_TLS_DESTINATION_PORT 443 /** * @brief Secure Sockets library initialization function. * * This function does general initialization and setup. It must be called once * and only once before calling any other function. * * @return * * `pdPASS` if everything succeeds * * `pdFAIL` otherwise. */ extern BaseType_t SOCKETS_Init( void ); /** * @brief Creates a TCP socket. * * See the [FreeRTOS+TCP networking tutorial] * (https://freertos.org/FreeRTOS-Plus/FreeRTOS_Plus_TCP/TCP_Networking_Tutorial.html) * for more information on TCP sockets. * * See the [Berkeley Sockets API] * (https://en.wikipedia.org/wiki/Berkeley_sockets#Socket_API_functions) * in wikipedia * * @sa SOCKETS_Close() * * @param[in] lDomain Must be set to SOCKETS_AF_INET. See @ref SocketDomains. * @param[in] lType Set to SOCKETS_SOCK_STREAM to create a TCP socket. * No other value is valid. See @ref SocketTypes. * @param[in] lProtocol Set to SOCKETS_IPPROTO_TCP to create a TCP socket. * No other value is valid. See @ref Protocols. * * @return * * If a socket is created successfully, then the socket handle is * returned * * @ref SOCKETS_INVALID_SOCKET is returned if an error occurred. */ /* * This call allocates memory and claims a socket resource. */ /* @[declare_secure_sockets_socket] */ Socket_t SOCKETS_Socket( int32_t lDomain, int32_t lType, int32_t lProtocol ); /* @[declare_secure_sockets_socket] */ /** * @brief Bind a TCP socket. * * See the [FreeRTOS+TCP networking tutorial] * (https://freertos.org/FreeRTOS-Plus/FreeRTOS_Plus_TCP/TCP_Networking_Tutorial.html) * for more information on TCP sockets. * * See the [Berkeley Sockets API] * (https://en.wikipedia.org/wiki/Berkeley_sockets#Socket_API_functions) * in wikipedia * * @sa SOCKETS_Bind() * A pre-configured source port allows customers to bind to the specified local port instead of ephemeral port * for security and packet filter reasons. * * Limitations: * * i. The caller of SOCKETS_Bind() API should make sure the socket address has the correct local IP address for the interface. * ii. Some source ports may be unavailable depending on the TCP/IP stack implementation. * * NOTE: If the SOCKETS_Bind() API binds to a source port in ephemeral port range, and the caller calls SOCKETS_Bind() API * before SOCKETS_Connect() API, then a conflict of source port arises as another TCP connection * may pick the the same chosen port via tcp_new_port() API ( by scanning its internal TCP connection list ) * * * @param[in] xSocket The handle of the socket to which specified address to be bound. * @param[in] pxAddress A pointer to a SocketsSockaddr_t structure that contains * the address and port to be bound to the socket. * @param[in] xAddressLength Should be set to sizeof( @ref SocketsSockaddr_t ). * * @return * * If the bind was successful then SOCKETS_ERROR_NONE is returned. * * If an error occurred, a negative value is returned. @ref SocketsErrors */ /* @[declare_secure_sockets_bind] */ int32_t SOCKETS_Bind( Socket_t xSocket, SocketsSockaddr_t * pxAddress, Socklen_t xAddressLength ); /* @[declare_secure_sockets_bind] */ /** * @brief Connects the socket to the specified IP address and port. * * The socket must first have been successfully created by a call to SOCKETS_Socket(). * * \note To create a secure socket, SOCKETS_SetSockOpt() should be called with the * SOCKETS_SO_REQUIRE_TLS option \a before SOCKETS_Connect() is called. * * If this function returns an error the socket is considered invalid. * * \warning SOCKETS_Connect() is not safe to be called on the same socket * from multiple threads simultaneously with SOCKETS_Connect(), * SOCKETS_SetSockOpt(), SOCKETS_Shutdown(), SOCKETS_Close(). * * See the [Berkeley Sockets API] * (https://en.wikipedia.org/wiki/Berkeley_sockets#Socket_API_functions) * in wikipedia * * @param[in] xSocket The handle of the socket to be connected. * @param[in] pxAddress A pointer to a SocketsSockaddr_t structure that contains the * the address to connect the socket to. * @param[in] xAddressLength Should be set to sizeof( @ref SocketsSockaddr_t ). * * @return * * @ref SOCKETS_ERROR_NONE if a connection is established. * * If an error occurred, a negative value is returned. @ref SocketsErrors */ /* @[declare_secure_sockets_connect] */ int32_t SOCKETS_Connect( Socket_t xSocket, SocketsSockaddr_t * pxAddress, Socklen_t xAddressLength ); /* @[declare_secure_sockets_connect] */ /** * @brief Receive data from a TCP socket. * * The socket must have already been created using a call to SOCKETS_Socket() * and connected to a remote socket using SOCKETS_Connect(). * * See the [Berkeley Sockets API] * (https://en.wikipedia.org/wiki/Berkeley_sockets#Socket_API_functions) * in wikipedia * * @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. * @param[in] ulFlags Not currently used. Should be set to 0. * * @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 */ /* @[declare_secure_sockets_recv] */ int32_t SOCKETS_Recv( Socket_t xSocket, void * pvBuffer, size_t xBufferLength, uint32_t ulFlags ); /* @[declare_secure_sockets_recv] */ /** * @brief Transmit data to the remote socket. * * The socket must have already been created using a call to SOCKETS_Socket() and * connected to a remote socket using SOCKETS_Connect(). * * See the [Berkeley Sockets API] * (https://en.wikipedia.org/wiki/Berkeley_sockets#Socket_API_functions) * in wikipedia * * @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. * @param[in] ulFlags Not currently used. Should be set to 0. * * @return * * On success, the number of bytes actually sent is returned. * * If an error occurred, a negative value is returned. @ref SocketsErrors */ /* @[declare_secure_sockets_send] */ int32_t SOCKETS_Send( Socket_t xSocket, const void * pvBuffer, size_t xDataLength, uint32_t ulFlags ); /* @[declare_secure_sockets_send] */ /** * @brief Closes all or part of a full-duplex connection on the socket. * * Disable reads and writes on a connected TCP socket. A connected TCP socket must be gracefully * shut down before it can be closed. * * See the [Berkeley Sockets API] * (https://en.wikipedia.org/wiki/Berkeley_sockets#Socket_API_functions) * in wikipedia * * \warning SOCKETS_Shutdown() is not safe to be called on the same socket * from multiple threads simultaneously with SOCKETS_Connect(), * SOCKETS_SetSockOpt(), SOCKETS_Shutdown(), SOCKETS_Close(). * * @param[in] xSocket The handle of the socket to shutdown. * @param[in] ulHow SOCKETS_SHUT_RD, SOCKETS_SHUT_WR or SOCKETS_SHUT_RDWR. * @ref ShutdownFlags * * @return * * If the operation was successful, 0 is returned. * * If an error occurred, a negative value is returned. @ref SocketsErrors */ /* @[declare_secure_sockets_shutdown] */ int32_t SOCKETS_Shutdown( Socket_t xSocket, uint32_t ulHow ); /* @[declare_secure_sockets_shutdown] */ /** * @brief Closes the socket and frees the related resources. * * A socket should be shutdown gracefully before it is closed, and cannot be used after it has been closed. * * See the [Berkeley Sockets API] * (https://en.wikipedia.org/wiki/Berkeley_sockets#Socket_API_functions) * in wikipedia * * \warning SOCKETS_Close() is not safe to be called on the same socket * from multiple threads simultaneously with SOCKETS_Connect(), * SOCKETS_SetSockOpt(), SOCKETS_Shutdown(), SOCKETS_Close(). * * @param[in] xSocket The handle of the socket to close. * * @return * * On success, 0 is returned. * * If an error occurred, a negative value is returned. @ref SocketsErrors */ /* @[declare_secure_sockets_close] */ int32_t SOCKETS_Close( Socket_t xSocket ); /* @[declare_secure_sockets_close] */ /** * @brief AWS IoT ALPN protocol name for MQTT over TLS on server port 443. */ #define socketsAWS_IOT_ALPN_MQTT "x-amzn-mqtt-ca" /** * @brief Manipulates the options for the socket. * * See the [Berkeley Sockets API] * (https://en.wikipedia.org/wiki/Berkeley_sockets#Socket_API_functions) * in wikipedia * * @param[in] xSocket The handle of the socket to set the option for. * @param[in] lLevel Not currently used. Should be set to 0. * @param[in] lOptionName See @ref SetSockOptOptions. * @param[in] pvOptionValue A buffer containing the value of the option to set. * @param[in] xOptionLength The length of the buffer pointed to by pvOptionValue. * * \warning SOCKETS_Close() is not safe to be called on the same socket * from multiple threads simultaneously with SOCKETS_Connect(), * SOCKETS_SetSockOpt(), SOCKETS_Shutdown(), SOCKETS_Close(). * * @note Socket option support and possible values vary by port. Please see * PORT_SPECIFIC_LINK to check the valid options and limitations of your device. * * - Berkeley Socket Options * - @ref SOCKETS_SO_RCVTIMEO * - Sets the receive timeout * - pvOptionValue (TickType_t) is the number of milliseconds that the * receive function should wait before timing out. * - Setting pvOptionValue = 0 causes receive to wait forever. * - See PORT_SPECIFIC_LINK for device limitations. * - @ref SOCKETS_SO_SNDTIMEO * - Sets the send timeout * - pvOptionValue (TickType_t) is the number of milliseconds that the * send function should wait before timing out. * - Setting pvOptionValue = 0 causes send to wait forever. * - See PORT_SPECIFIC_LINK for device limitations. * - Non-Standard Options * - @ref SOCKETS_SO_NONBLOCK * - Makes a socket non-blocking. * - Non-blocking connect is not supported - socket option should be * called after connect. * - pvOptionValue is ignored for this option. * - @ref SOCKETS_SO_WAKEUP_CALLBACK * - Set the callback to be called whenever there is data available on * the socket for reading * - This option provides an asynchronous way to handle received data * - pvOptionValue is a pointer to the callback function * - See PORT_SPECIFIC_LINK for device limitations. * - Security Sockets Options * - @ref SOCKETS_SO_REQUIRE_TLS * - Use TLS for all connect, send, and receive on this socket. * - This socket options MUST be set for TLS to be used, even * if other secure socket options are set. * - This socket option should be set before SOCKETS_Connect() is * called. * - pvOptionValue is ignored for this option. * - @ref SOCKETS_SO_TRUSTED_SERVER_CERTIFICATE * - Set the root of trust server certificate for the socket. * - This socket option only takes effect if @ref SOCKETS_SO_REQUIRE_TLS * is also set. If @ref SOCKETS_SO_REQUIRE_TLS is not set, * this option will be ignored. * - pvOptionValue is a pointer to the formatted server certificate. * TODO: Link to description of how to format certificates with \n * - xOptionLength (BaseType_t) is the length of the certificate * in bytes. * - @ref SOCKETS_SO_SERVER_NAME_INDICATION * - Use Server Name Indication (SNI) * - This socket option only takes effect if @ref SOCKETS_SO_REQUIRE_TLS * is also set. If @ref SOCKETS_SO_REQUIRE_TLS is not set, * this option will be ignored. * - pvOptionValue is a pointer to a string containing the hostname * - xOptionLength is the length of the hostname string in bytes. * - @ref SOCKETS_SO_ALPN_PROTOCOLS * - Negotiate an application protocol along with TLS. * - The ALPN list is expressed as an array of NULL-terminated ANSI * strings. * - xOptionLength is the number of items in the array. * - @ref SOCKETS_SO_TCPKEEPALIVE * - Enable or disable the TCP keep-alive functionality. * - pvOptionValue is the value to enable or disable Keepalive. * - @ref SOCKETS_SO_TCPKEEPALIVE_INTERVAL * - Set the time in seconds between individual TCP keep-alive probes. * - pvOptionValue is the time in seconds. * - @ref SOCKETS_SO_TCPKEEPALIVE_COUNT * - Set the maximum number of keep-alive probes TCP should send before * dropping the connection. * - pvOptionValue is the maximum number of keep-alive probes. * - @ref SOCKETS_SO_TCPKEEPALIVE_IDLE_TIME * - Set the time in seconds for which the connection needs to remain idle * before TCP starts sending keep-alive probes. * - pvOptionValue is the time in seconds. * * @return * * On success, 0 is returned. * * If an error occurred, a negative value is returned. @ref SocketsErrors */ /* @[declare_secure_sockets_setsockopt] */ int32_t SOCKETS_SetSockOpt( Socket_t xSocket, int32_t lLevel, int32_t lOptionName, const void * pvOptionValue, size_t xOptionLength ); /* @[declare_secure_sockets_setsockopt] */ /** * @brief Resolve a host name using Domain Name Service. * * See the [Berkeley Sockets API] * (https://en.wikipedia.org/wiki/Berkeley_sockets#Socket_API_functions) * in wikipedia * * @param[in] pcHostName The host name to resolve. * @return * * The IPv4 address of the specified host. * * If an error has occurred, 0 is returned. */ /* @[declare_secure_sockets_gethostbyname] */ uint32_t SOCKETS_GetHostByName( const char * pcHostName ); /* @[declare_secure_sockets_gethostbyname] */ /** * @brief Convert an unsigned thirty-two-bit value from host endianness to network * endianness. * * @param[in] usIn The unsigned thirty-two-bit value to convert. */ #if defined( socketsconfigBYTE_ORDER ) && ( socketsconfigBYTE_ORDER == pdLITTLE_ENDIAN ) #define SOCKETS_htonl( ulIn ) ( ( uint32_t ) ( ( ( ulIn & 0xFF ) << 24 ) | ( ( ulIn & 0xFF00 ) << 8 ) | ( ( ulIn & 0xFF0000 ) >> 8 ) | ( ( ulIn & 0xFF000000 ) >> 24 ) ) ) #else #define SOCKETS_htonl( usIn ) ( ( uint32_t ) ( usIn ) ) #endif /** * @brief Convert an unsigned thirty-two-bit value from network endianness to host * endianness. * * @param[in] usIn The unsigned thirty-two-bit value to convert. */ #define SOCKETS_ntohl( usIn ) SOCKETS_htonl( usIn ) /** * @brief Convert an unsigned sixteen-bit value from host endianness to network * endianness. * * @param[in] usIn The unsigned sixteen-bit value to convert. */ #if defined( socketsconfigBYTE_ORDER ) && ( socketsconfigBYTE_ORDER == pdLITTLE_ENDIAN ) #define SOCKETS_htons( usIn ) ( ( uint16_t ) ( ( ( usIn ) << 8U ) | ( ( usIn ) >> 8U ) ) ) #else #define SOCKETS_htons( usIn ) ( ( uint16_t ) ( usIn ) ) #endif /** * @brief Convert an unsigned sixteen-bit value from network endianness to host * endianness. * * @param[in] usIn The unsigned sixteen-bit value to convert. */ #define SOCKETS_ntohs( usIn ) SOCKETS_htons( usIn ) /** * @brief Convert an IP address expressed as four separate numeric octets into a an IP address expressed as a 32-bit number in network byte order * (for example 192, 168, 0, 100) * * @param[in] ucOctet0 0th IP Octet * @param[in] ucOctet1 1st IP Octet * @param[in] ucOctet2 2nd IP Octet * @param[in] ucOctet3 3rd IP Octet */ #if defined( socketsconfigBYTE_ORDER ) && ( socketsconfigBYTE_ORDER == pdLITTLE_ENDIAN ) #define SOCKETS_inet_addr_quick( ucOctet0, ucOctet1, ucOctet2, ucOctet3 ) \ ( ( ( ( uint32_t ) ( ucOctet3 ) ) << 24UL ) | \ ( ( ( uint32_t ) ( ucOctet2 ) ) << 16UL ) | \ ( ( ( uint32_t ) ( ucOctet1 ) ) << 8UL ) | \ ( ( uint32_t ) ( ucOctet0 ) ) ) /** * @brief Convert an IP address expressed as a 32-bit number in network byte order to a string in decimal dot notation. * (for example "192.168.0.100") * * @param[in] ulIPAddress An IP address expressed as a 32-bit value in network byte order. * @param[in] pucBuffer A pointer to a buffer into which the IP address will be written in decimal dot notation. */ #define SOCKETS_inet_ntoa( ulIPAddress, pucBuffer ) \ sprintf( ( char * ) ( pucBuffer ), "%u.%u.%u.%u", \ ( ( unsigned ) ( ( ulIPAddress ) & 0xffUL ) ), \ ( ( unsigned ) ( ( ( ulIPAddress ) >> 8 ) & 0xffUL ) ), \ ( ( unsigned ) ( ( ( ulIPAddress ) >> 16 ) & 0xffUL ) ), \ ( ( unsigned ) ( ( ulIPAddress ) >> 24 ) ) ) #else /* socketsconfigBYTE_ORDER. */ #define SOCKETS_inet_addr_quick( ucOctet0, ucOctet1, ucOctet2, ucOctet3 ) \ ( ( ( ( uint32_t ) ( ucOctet0 ) ) << 24UL ) | \ ( ( ( uint32_t ) ( ucOctet1 ) ) << 16UL ) | \ ( ( ( uint32_t ) ( ucOctet2 ) ) << 8UL ) | \ ( ( uint32_t ) ( ucOctet3 ) ) ) /** * @brief Convert an IP address expressed as a 32-bit number in network byte order to a string in decimal dot notation. * (for example "192.168.0.100") * * @param[in] ulIPAddress An IP address expressed as a 32-bit value in network byte order. * @param[in] pucBuffer A pointer to a buffer into which the IP address will be written in decimal dot notation. */ #define SOCKETS_inet_ntoa( ulIPAddress, pucBuffer ) \ sprintf( ( char * ) ( pucBuffer ), "%u.%u.%u.%u", \ ( ( unsigned ) ( ( ulIPAddress ) >> 24 ) ), \ ( ( unsigned ) ( ( ( ulIPAddress ) >> 16 ) & 0xffUL ) ), \ ( ( unsigned ) ( ( ( ulIPAddress ) >> 8 ) & 0xffUL ) ), \ ( ( unsigned ) ( ( ulIPAddress ) & 0xffUL ) ) ) #endif /* socketsconfigBYTE_ORDER. */ /* #ifdef __cplusplus * } #endif */ #endif /* _AWS_SECURE_SOCKETS_H_ */