core_http_client_private.h

Go to the documentation of this file.

/*
 * coreHTTP v3.0.0
 * Copyright (C) 2022 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
 *
 * SPDX-License-Identifier: MIT
 *
 * 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.
 */
 
#ifndef CORE_HTTP_CLIENT_PRIVATE_H_
#define CORE_HTTP_CLIENT_PRIVATE_H_
 
#ifndef LLHTTP_STRICT_MODE
    #define LLHTTP_STRICT_MODE    0
#endif
/* Third-party llhttp include. */
#include "llhttp.h"
 
/* *INDENT-OFF* */
#ifdef __cplusplus
    extern "C" {
#endif
/* *INDENT-ON* */
 
#define HTTP_PROTOCOL_VERSION              "HTTP/1.1"
#define HTTP_PROTOCOL_VERSION_LEN          ( sizeof( HTTP_PROTOCOL_VERSION ) - 1U ) 
#define HTTP_EMPTY_PATH                    "/"
#define HTTP_EMPTY_PATH_LEN                ( sizeof( HTTP_EMPTY_PATH ) - 1U ) 
/* Constants for HTTP header formatting. */
#define HTTP_HEADER_LINE_SEPARATOR         "\r\n"                                         
#define HTTP_HEADER_LINE_SEPARATOR_LEN     ( sizeof( HTTP_HEADER_LINE_SEPARATOR ) - 1U )  
#define HTTP_HEADER_END_INDICATOR          "\r\n\r\n"                                     
#define HTTP_HEADER_END_INDICATOR_LEN      ( sizeof( HTTP_HEADER_END_INDICATOR ) - 1U )   
#define HTTP_HEADER_FIELD_SEPARATOR        ": "                                           
#define HTTP_HEADER_FIELD_SEPARATOR_LEN    ( sizeof( HTTP_HEADER_FIELD_SEPARATOR ) - 1U ) 
#define SPACE_CHARACTER                    ' '                                            
#define SPACE_CHARACTER_LEN                ( 1U )                                         
#define DASH_CHARACTER                     '-'                                            
#define DASH_CHARACTER_LEN                 ( 1U )                                         
/* Constants for HTTP header copy checks. */
#define CARRIAGE_RETURN_CHARACTER          '\r' 
#define LINEFEED_CHARACTER                 '\n' 
#define COLON_CHARACTER                    ':'  
#define HTTP_HEADER_STRNCPY_IS_VALUE       0U
 
#define HTTP_HEADER_STRNCPY_IS_FIELD       1U
 
/* Constants for header fields added automatically during the request
 * initialization. */
#define HTTP_USER_AGENT_FIELD              "User-Agent"                             
#define HTTP_USER_AGENT_FIELD_LEN          ( sizeof( HTTP_USER_AGENT_FIELD ) - 1U ) 
#define HTTP_HOST_FIELD                    "Host"                                   
#define HTTP_HOST_FIELD_LEN                ( sizeof( HTTP_HOST_FIELD ) - 1U )       
#define HTTP_USER_AGENT_VALUE_LEN          ( sizeof( HTTP_USER_AGENT_VALUE ) - 1U ) 
/* Constants for header fields added based on flags. */
#define HTTP_CONNECTION_FIELD              "Connection"                                 
#define HTTP_CONNECTION_FIELD_LEN          ( sizeof( HTTP_CONNECTION_FIELD ) - 1U )     
#define HTTP_CONTENT_LENGTH_FIELD          "Content-Length"                             
#define HTTP_CONTENT_LENGTH_FIELD_LEN      ( sizeof( HTTP_CONTENT_LENGTH_FIELD ) - 1U ) 
/* Constants for header values added based on flags. */
 
/* MISRA Ref 5.4.1 [Macro identifiers] */
/* More details at: https://github.com/FreeRTOS/coreHTTP/blob/main/MISRA.md#rule-54 */
/* coverity[other_declaration] */
#define HTTP_CONNECTION_KEEP_ALIVE_VALUE    "keep-alive" 
/* MISRA Ref 5.4.2 [Macro identifiers] */
/* More details at: https://github.com/FreeRTOS/coreHTTP/blob/main/MISRA.md#rule-54 */
/* coverity[misra_c_2012_rule_5_4_violation] */
#define HTTP_CONNECTION_KEEP_ALIVE_VALUE_LEN    ( sizeof( HTTP_CONNECTION_KEEP_ALIVE_VALUE ) - 1U ) 
/* Constants relating to Range Requests. */
 
/* MISRA Ref 5.4.3 [Macro identifiers] */
/* More details at: https://github.com/FreeRTOS/coreHTTP/blob/main/MISRA.md#rule-54 */
/* coverity[other_declaration] */
#define HTTP_RANGE_REQUEST_HEADER_FIELD    "Range" 
/* MISRA Ref 5.4.4 [Macro identifiers] */
/* More details at: https://github.com/FreeRTOS/coreHTTP/blob/main/MISRA.md#rule-54 */
/* coverity[misra_c_2012_rule_5_4_violation] */
#define HTTP_RANGE_REQUEST_HEADER_FIELD_LEN    ( sizeof( HTTP_RANGE_REQUEST_HEADER_FIELD ) - 1U ) 
/* MISRA Ref 5.4.5 [Macro identifiers] */
/* More details at: https://github.com/FreeRTOS/coreHTTP/blob/main/MISRA.md#rule-54 */
/* coverity[other_declaration] */
#define HTTP_RANGE_REQUEST_HEADER_VALUE_PREFIX    "bytes=" 
/* MISRA Ref 5.4.6 [Macro identifiers] */
/* More details at: https://github.com/FreeRTOS/coreHTTP/blob/main/MISRA.md#rule-54 */
/* coverity[misra_c_2012_rule_5_4_violation] */
#define HTTP_RANGE_REQUEST_HEADER_VALUE_PREFIX_LEN    ( sizeof( HTTP_RANGE_REQUEST_HEADER_VALUE_PREFIX ) - 1U ) 
#define MAX_INT32_NO_OF_DECIMAL_DIGITS                10U
 
#define HTTP_MAX_RANGE_REQUEST_VALUE_LEN                                            \
    ( HTTP_RANGE_REQUEST_HEADER_VALUE_PREFIX_LEN + MAX_INT32_NO_OF_DECIMAL_DIGITS + \
      1U /* Dash character '-' */ + MAX_INT32_NO_OF_DECIMAL_DIGITS )
 
#define LLHTTP_CONTINUE_PARSING             0
 
#define LLHTTP_STOP_PARSING                 HPE_USER
 
#define LLHTTP_STOP_PARSING_NO_BODY         1
 
#define LLHTTP_STOP_PARSING_NO_HEADER       1
 
#define HTTP_MINIMUM_REQUEST_LINE_LENGTH    16u
 
typedef enum HTTPParsingState_t
{
    HTTP_PARSING_NONE = 0,   
    HTTP_PARSING_INCOMPLETE, 
    HTTP_PARSING_COMPLETE    
} HTTPParsingState_t;
 
typedef struct findHeaderContext
{
    const char * pField;     
    size_t fieldLen;         
    const char ** pValueLoc; 
    size_t * pValueLen;      
    uint8_t fieldFound;      
    uint8_t valueFound;      
} findHeaderContext_t;
 
typedef struct HTTPParsingContext
{
    llhttp_t llhttpParser;            
    llhttp_settings_t llhttpSettings; 
    HTTPParsingState_t state;         
    HTTPResponse_t * pResponse;       
    uint8_t isHeadResponse;           
    const char * pBufferCur;          
    const char * pLastHeaderField;    
    size_t lastHeaderFieldLen;        
    const char * pLastHeaderValue;    
    size_t lastHeaderValueLen;        
} HTTPParsingContext_t;
 
/* *INDENT-OFF* */
#ifdef __cplusplus
    }
#endif
/* *INDENT-ON* */
 
#endif /* ifndef CORE_HTTP_CLIENT_PRIVATE_H_ */