html2/https/iot__https__internal_8h_source.html

/*

 * FreeRTOS HTTPS Client V1.1.3

 * 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 IOT_HTTPS_INTERNAL_H_

#define IOT_HTTPS_INTERNAL_H_


/* The config header is always included first. */

#include "iot_config.h"


/* Standard Includes. */

#include <string.h>

#include <stdbool.h>

#include <stdlib.h>

#include <stdio.h>


/* Third party http-parser include. */

#include "http_parser.h"


/* HTTPS Client library includes. */

#include "iot_https_client.h"


/* Task pool include. */

#include "iot_taskpool.h"


/* Linear containers (lists and queues) include. */

#include "iot_linear_containers.h"


/* Types include. */

#include "types/iot_taskpool_types.h"


/* Platform layer includes. */

#include "platform/iot_threads.h"

#include "platform/iot_network.h"


/* Error handling include. */

#include "private/iot_error.h"


/*-----------------------------------------------------------*/


/* Convenience macros for handling errors in a standard way. */


#define HTTPS_SUCCEEDED( x )                         ( ( x ) == IOT_HTTPS_OK )


#define HTTPS_FAILED( x )                            ( ( x ) != IOT_HTTPS_OK )


#define HTTPS_FUNCTION_ENTRY( result )               IOT_FUNCTION_ENTRY( IotHttpsReturnCode_t, result )


#define HTTPS_GOTO_CLEANUP()                         IOT_GOTO_CLEANUP()


#define HTTPS_SET_AND_GOTO_CLEANUP( statusValue )    IOT_SET_AND_GOTO_CLEANUP( statusValue )


#define HTTPS_FUNCTION_CLEANUP_BEGIN()               IOT_FUNCTION_CLEANUP_BEGIN()


#define HTTPS_FUNCTION_CLEANUP_END()                 IOT_FUNCTION_CLEANUP_END()


#define HTTPS_FUNCTION_EXIT_NO_CLEANUP()             IOT_FUNCTION_EXIT_NO_CLEANUP()


#define HTTPS_ON_NULL_ARG_GOTO_CLEANUP( ptr )                    \

    if( ( ptr == NULL ) )                                        \

    {                                                            \

        IotLogError( # ptr " was NULL." );                       \

        IOT_SET_AND_GOTO_CLEANUP( IOT_HTTPS_INVALID_PARAMETER ); \

    }


#define HTTPS_ON_ARG_ERROR_GOTO_CLEANUP( expr )                  \

    if( ( expr ) == false )                                      \

    {                                                            \

        IotLogError( # expr " must be true." );                  \

        IOT_SET_AND_GOTO_CLEANUP( IOT_HTTPS_INVALID_PARAMETER ); \

    }


#define HTTPS_ON_ARG_ERROR_MSG_GOTO_CLEANUP( expr, statusValue, ... ) \

    if( ( expr ) == false )                                           \

    {                                                                 \

        IotLogError( __VA_ARGS__ );                                   \

        IOT_SET_AND_GOTO_CLEANUP( statusValue );                      \

    }


/* Configure logs for HTTPS Client functions. */

#ifdef IOT_LOG_LEVEL_HTTPS

    #define LIBRARY_LOG_LEVEL        IOT_LOG_LEVEL_HTTPS

#else

    #ifdef IOT_LOG_LEVEL_GLOBAL

        #define LIBRARY_LOG_LEVEL    IOT_LOG_LEVEL_GLOBAL

    #else

        #define LIBRARY_LOG_LEVEL    IOT_LOG_NONE

    #endif

#endif


#define LIBRARY_LOG_NAME    ( "HTTPS Client" )

#include "iot_logging_setup.h"


/*

 * Provide default values for undefined memory allocation functions based on

 * the usage of dynamic memory allocation.

 */

#if IOT_STATIC_MEMORY_ONLY == 1

    #include "private/iot_static_memory.h"

#endif


#ifndef AWS_IOT_HTTPS_ENABLE_METRICS

    #define AWS_IOT_HTTPS_ENABLE_METRICS           ( 1 )

#endif

#ifndef IOT_HTTPS_USER_AGENT

    #define IOT_HTTPS_USER_AGENT                   "amazon-freertos"

#endif

#ifndef IOT_HTTPS_MAX_FLUSH_BUFFER_SIZE

    #define IOT_HTTPS_MAX_FLUSH_BUFFER_SIZE        ( 1024 )

#endif

#ifndef IOT_HTTPS_RESPONSE_WAIT_MS

    #define IOT_HTTPS_RESPONSE_WAIT_MS             ( 1000 )

#endif

#ifndef IOT_HTTPS_MAX_HOST_NAME_LENGTH

    #define IOT_HTTPS_MAX_HOST_NAME_LENGTH         ( 255 ) /* Per FQDN, the maximum host name length is 255 bytes. */

#endif

#ifndef IOT_HTTPS_MAX_ALPN_PROTOCOLS_LENGTH

    #define IOT_HTTPS_MAX_ALPN_PROTOCOLS_LENGTH    ( 255 ) /* The maximum alpn protocols length is chosen arbitrarily. */

#endif


#define HTTPS_PROTOCOL_VERSION                        "HTTP/1.1"


#define HTTPS_EMPTY_PATH                              "/"


#define HTTPS_CONNECT_METHOD                          "CONNECT"


/*

 * Constants for the values of the HTTP "Connection" header field.

 *

 * This is used for writing headers automatically during the sending of the HTTP request.

 * "Connection: keep-alive\r\n" is written automatically for a persistent connection.

 * "Connection: close\r\n" is written automatically for a non-persistent connection.

 */

#define HTTPS_CONNECTION_KEEP_ALIVE_HEADER_VALUE      "keep-alive"

#define HTTPS_CONNECTION_CLOSE_HEADER_VALUE           "close"


#define HTTPS_HEADER_FIELD_SEPARATOR                  ": "

#define HTTPS_HEADER_FIELD_SEPARATOR_LENGTH           ( 2 )

#define COLON_CHARACTER                               ':'

#define SPACE_CHARACTER                               ' '


#define HTTPS_END_OF_HEADER_LINES_INDICATOR           "\r\n"

#define HTTPS_END_OF_HEADER_LINES_INDICATOR_LENGTH    ( 2 )

#define CARRIAGE_RETURN_CHARACTER                     '\r'

#define NEWLINE_CHARACTER                             '\n'


/*

 * Constants for header fields added automatically during the request initialization.

 */

#define HTTPS_USER_AGENT_HEADER                       "User-Agent"

#define HTTPS_HOST_HEADER                             "Host"


/*

 * Constants for the header fields added automatically during the sending of the HTTP request.

 */

#define HTTPS_CONTENT_LENGTH_HEADER                   "Content-Length"

#define HTTPS_CONNECTION_HEADER                       "Connection"


#define HTTPS_MAX_CONTENT_LENGTH_LINE_LENGTH          ( 26 )


#define FAST_MACRO_STRLEN( x )    ( ( sizeof( x ) / sizeof( char ) ) - 1 )


/*-----------------------------------------------------------*/


typedef enum IotHttpsResponseParserState

{

    PARSER_STATE_NONE = 0,

    PARSER_STATE_IN_HEADERS,

    PARSER_STATE_HEADERS_COMPLETE,

    PARSER_STATE_IN_BODY,

    PARSER_STATE_BODY_COMPLETE

} IotHttpsResponseParserState_t;


typedef enum IotHttpsResponseBufferState

{

    PROCESSING_STATE_NONE,

    PROCESSING_STATE_FILLING_HEADER_BUFFER,

    PROCESSING_STATE_FILLING_BODY_BUFFER,

    PROCESSING_STATE_FINISHED,

    PROCESSING_STATE_SEARCHING_HEADER_BUFFER

} IotHttpsResponseBufferState_t;


/*-----------------------------------------------------------*/


typedef struct _httpsConnection

{

    const IotNetworkInterface_t * pNetworkInterface;

    void * pNetworkConnection;

    uint32_t timeout;

    bool isConnected;

    bool isDestroyed;

    IotMutex_t connectionMutex;

    IotDeQueue_t reqQ;

    IotDeQueue_t respQ;

    IotTaskPoolJobStorage_t taskPoolJobStorage;

    IotTaskPoolJob_t taskPoolJob;

} _httpsConnection_t;


typedef struct _httpParserInfo

{

    http_parser responseParser;

    size_t ( * parseFunc )( http_parser * parser,

                            const http_parser_settings * settings,

                            const char * data,

                            size_t len );

    http_parser readHeaderParser;

} _httpParserInfo_t;


typedef struct _httpsResponse

{

    IotLink_t link;

    uint8_t * pHeaders;

    uint8_t * pHeadersEnd;

    uint8_t * pHeadersCur;

    uint8_t * pBody;

    uint8_t * pBodyEnd;

    uint8_t * pBodyCur;

    _httpParserInfo_t httpParserInfo;

    uint16_t status;

    IotHttpsMethod_t method;

    IotHttpsResponseParserState_t parserState;

    IotHttpsResponseBufferState_t bufferProcessingState;

    char * pReadHeaderField;

    size_t readHeaderFieldLength;

    char * pReadHeaderValue;

    size_t readHeaderValueLength;

    bool foundHeaderField;

    struct _httpsConnection * pHttpsConnection;

    bool isAsync;

    uint8_t * pBodyInHeaderBuf;

    uint8_t * pBodyCurInHeaderBuf;

    IotHttpsReturnCode_t bodyRxStatus;

    bool cancelled;

    IotSemaphore_t respFinishedSem;

    IotHttpsReturnCode_t syncStatus;

    bool reqFinishedSending;

    IotHttpsClientCallbacks_t * pCallbacks;

    void * pUserPrivData;

    bool isNonPersistent;

} _httpsResponse_t;


typedef struct _httpsRequest

{

    IotLink_t link;

    uint8_t * pHeaders;

    uint8_t * pHeadersEnd;

    uint8_t * pHeadersCur;

    uint8_t * pBody;

    uint32_t bodyLength;

    IotHttpsMethod_t method;

    IotHttpsConnectionInfo_t * pConnInfo;

    struct _httpsResponse * pHttpsResponse;

    struct _httpsConnection * pHttpsConnection;

    bool isNonPersistent;

    bool isAsync;

    void * pUserPrivData;

    IotHttpsClientCallbacks_t * pCallbacks;

    bool cancelled;

    IotHttpsReturnCode_t bodyTxStatus;

    bool scheduled;

} _httpsRequest_t;


/*-----------------------------------------------------------*/


extern const char * _pHttpsMethodStrings[];


#endif /* IOT_HTTPS_INTERNAL_H_ */