iot_secure_sockets.h

Go to the documentation of this file.

/*
 * FreeRTOS Secure Sockets V1.3.1
 * 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
 */

#ifndef _AWS_SECURE_SOCKETS_H_
#define _AWS_SECURE_SOCKETS_H_

/*
 #ifdef __cplusplus
 *  extern "C" {
 #endif
 */
#include <stdint.h>
#include <stddef.h>
#include "iot_secure_sockets_config.h"
#include "iot_secure_sockets_config_defaults.h"
#include "iot_secure_sockets_wrapper_metrics.h"
#include "iot_lib_init.h"

struct xSOCKET;
typedef struct xSOCKET * Socket_t; 
#define Socklen_t    uint32_t

#define SOCKETS_ERROR_NONE               ( 0 )     
#define SOCKETS_SOCKET_ERROR             ( -1 )    
#define SOCKETS_EWOULDBLOCK              ( -11 )   
#define SOCKETS_ENOMEM                   ( -12 )   
#define SOCKETS_EINVAL                   ( -22 )   
#define SOCKETS_ENOPROTOOPT              ( -109 )  
#define SOCKETS_ENOTCONN                 ( -126 )  
#define SOCKETS_EISCONN                  ( -127 )  
#define SOCKETS_ECLOSED                  ( -128 )  
#define SOCKETS_TLS_INIT_ERROR           ( -1001 ) 
#define SOCKETS_TLS_HANDSHAKE_ERROR      ( -1002 ) 
#define SOCKETS_TLS_SERVER_UNVERIFIED    ( -1003 ) 
#define SOCKETS_TLS_RECV_ERROR           ( -1004 ) 
#define SOCKETS_TLS_SEND_ERROR           ( -1005 ) 
#define SOCKETS_PERIPHERAL_RESET         ( -1006 ) 
#define SOCKETS_INVALID_SOCKET    ( ( Socket_t ) ~0U )

#define SOCKETS_AF_INET     ( 2 )           
#define SOCKETS_PF_INET     SOCKETS_AF_INET 
#define SOCKETS_AF_INET6    ( 10 )          
#define SOCKETS_SOCK_DGRAM     ( 2 )    
#define SOCKETS_SOCK_STREAM    ( 1 )    
#define SOCKETS_IPPROTO_UDP    ( 17 )   
#define SOCKETS_IPPROTO_TCP    ( 6 )    
#define SOCKETS_SO_RCVTIMEO                      ( 0 )  
#define SOCKETS_SO_SNDTIMEO                      ( 1 )  
#define SOCKETS_SO_SNDBUF                        ( 4 )  
#define SOCKETS_SO_RCVBUF                        ( 5 )  
#define SOCKETS_SO_SERVER_NAME_INDICATION        ( 6 )  
#define SOCKETS_SO_TRUSTED_SERVER_CERTIFICATE    ( 7 )  
#define SOCKETS_SO_REQUIRE_TLS                   ( 8 )  
#define SOCKETS_SO_NONBLOCK                      ( 9 )  
#define SOCKETS_SO_ALPN_PROTOCOLS                ( 10 ) 
#define SOCKETS_SO_WAKEUP_CALLBACK               ( 17 ) 
#define SOCKETS_SO_TCPKEEPALIVE                  ( 18 ) 
#define SOCKETS_SO_TCPKEEPALIVE_INTERVAL         ( 19 ) 
#define SOCKETS_SO_TCPKEEPALIVE_COUNT            ( 20 ) 
#define SOCKETS_SO_TCPKEEPALIVE_IDLE_TIME        ( 21 ) 
#define SOCKETS_SHUT_RD      ( 0 )  
#define SOCKETS_SHUT_WR      ( 1 )  
#define SOCKETS_SHUT_RDWR    ( 2 )  
#define securesocketsMAX_DNS_NAME_LENGTH    ( 253 )

typedef struct SocketsSockaddr
{
    uint8_t ucLength;       
    uint8_t ucSocketDomain; 
    uint16_t usPort;        
    uint32_t ulAddress;     
} SocketsSockaddr_t;

#define securesocketsDEFAULT_TLS_DESTINATION_PORT    443

extern BaseType_t SOCKETS_Init( void );

/*
 * 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] */

/* @[declare_secure_sockets_bind] */
int32_t SOCKETS_Bind( Socket_t xSocket,
                      SocketsSockaddr_t * pxAddress,
                      Socklen_t xAddressLength );
/* @[declare_secure_sockets_bind] */

/* @[declare_secure_sockets_connect] */
int32_t SOCKETS_Connect( Socket_t xSocket,
                         SocketsSockaddr_t * pxAddress,
                         Socklen_t xAddressLength );
/* @[declare_secure_sockets_connect] */

/* @[declare_secure_sockets_recv] */
int32_t SOCKETS_Recv( Socket_t xSocket,
                      void * pvBuffer,
                      size_t xBufferLength,
                      uint32_t ulFlags );
/* @[declare_secure_sockets_recv] */

/* @[declare_secure_sockets_send] */
int32_t SOCKETS_Send( Socket_t xSocket,
                      const void * pvBuffer,
                      size_t xDataLength,
                      uint32_t ulFlags );
/* @[declare_secure_sockets_send] */

/* @[declare_secure_sockets_shutdown] */
int32_t SOCKETS_Shutdown( Socket_t xSocket,
                          uint32_t ulHow );
/* @[declare_secure_sockets_shutdown] */

/* @[declare_secure_sockets_close] */
int32_t SOCKETS_Close( Socket_t xSocket );
/* @[declare_secure_sockets_close] */

#define socketsAWS_IOT_ALPN_MQTT    "x-amzn-mqtt-ca"

/* @[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] */

/* @[declare_secure_sockets_gethostbyname] */
uint32_t SOCKETS_GetHostByName( const char * pcHostName );
/* @[declare_secure_sockets_gethostbyname] */



#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

#define SOCKETS_ntohl( usIn )    SOCKETS_htonl( usIn )


#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


#define SOCKETS_ntohs( usIn )    SOCKETS_htons( usIn )

#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 ) ) )

    #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 ) ) )

    #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_ */