sigv4_internal.h

Go to the documentation of this file.

/*
 * SigV4 Library v1.2.0
 * Copyright (C) 2021 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 SIGV4_INTERNAL_H_
#define SIGV4_INTERNAL_H_
 
/* *INDENT-OFF* */
#ifdef __cplusplus
    extern "C" {
#endif
/* *INDENT-ON* */
 
/* SIGV4_DO_NOT_USE_CUSTOM_CONFIG allows building of the SigV4 library without a
 * config file. If a config file is provided, the SIGV4_DO_NOT_USE_CUSTOM_CONFIG
 * macro must not be defined.
 */
#ifndef SIGV4_DO_NOT_USE_CUSTOM_CONFIG
    #include "sigv4_config.h"
#endif
 
/* Include config defaults header to get default values of configurations not
 * defined in sigv4_config.h file. */
#include "sigv4_config_defaults.h"
 
/* Constants for date verification. */
#define YEAR_MIN               1900L               
#define MONTH_ASCII_LEN        3U                  
#define MONTH_NAMES            { "Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec" }
 
#define MONTH_DAYS             { 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31 }
 
#define FORMAT_RFC_3339        "%4Y-%2M-%2DT%2h:%2m:%2sZ"                       
#define FORMAT_RFC_3339_LEN    sizeof( FORMAT_RFC_3339 ) - 1U                   
#define FORMAT_RFC_5322        "%3*, %2D %3M %4Y %2h:%2m:%2s GMT"               
#define FORMAT_RFC_5322_LEN    sizeof( FORMAT_RFC_5322 ) - 1U                   
#define ISO_YEAR_LEN           4U                                               
#define ISO_NON_YEAR_LEN       2U                                               
#define ISO_DATE_SCOPE_LEN     8U                                               
/* SigV4 related string literals and lengths. */
 
#define CREDENTIAL_SCOPE_SEPARATOR             '/'
#define CREDENTIAL_SCOPE_SEPARATOR_LEN         1U 
#define CREDENTIAL_SCOPE_TERMINATOR            "aws4_request"
#define CREDENTIAL_SCOPE_TERMINATOR_LEN        ( sizeof( CREDENTIAL_SCOPE_TERMINATOR ) - 1U ) 
#define HTTP_EMPTY_PATH                        "/"
#define HTTP_EMPTY_PATH_LEN                    ( sizeof( HTTP_EMPTY_PATH ) - 1U )               
#define URI_ENCODED_SPECIAL_CHAR_SIZE          3U                                               
#define URI_DOUBLE_ENCODED_EQUALS_CHAR_SIZE    5U                                               
#define LINEFEED_CHAR                          '\n'                                             
#define LINEFEED_CHAR_LEN                      1U                                               
#define HTTP_REQUEST_LINE_ENDING               "\r\n"                                           
#define HTTP_REQUEST_LINE_ENDING_LEN           ( sizeof( HTTP_REQUEST_LINE_ENDING ) - 1U )      
#define SPACE_CHAR                             ' '                                              
#define SPACE_CHAR_LEN                         1U                                               
#define S3_SERVICE_NAME                        "s3"                                             
#define S3_SERVICE_NAME_LEN                    ( sizeof( S3_SERVICE_NAME ) - 1U )               
#define SIGV4_HMAC_SIGNING_KEY_PREFIX          "AWS4"                                           
#define SIGV4_HMAC_SIGNING_KEY_PREFIX_LEN      ( sizeof( SIGV4_HMAC_SIGNING_KEY_PREFIX ) - 1U ) 
#define AUTH_CREDENTIAL_PREFIX                 "Credential="                                    
#define AUTH_CREDENTIAL_PREFIX_LEN             ( sizeof( AUTH_CREDENTIAL_PREFIX ) - 1U )        
#define AUTH_SEPARATOR                         ", "                                             
#define AUTH_SEPARATOR_LEN                     ( sizeof( AUTH_SEPARATOR ) - 1U )                
#define AUTH_SIGNED_HEADERS_PREFIX             "SignedHeaders="                                 
#define AUTH_SIGNED_HEADERS_PREFIX_LEN         ( sizeof( AUTH_SIGNED_HEADERS_PREFIX ) - 1U )    
#define AUTH_SIGNATURE_PREFIX                  "Signature="                                     
#define AUTH_SIGNATURE_PREFIX_LEN              ( sizeof( AUTH_SIGNATURE_PREFIX ) - 1U )         
#define HMAC_INNER_PAD_BYTE                    ( 0x36U )                                        
#define HMAC_OUTER_PAD_BYTE                    ( 0x5CU )                                        
#define HMAX_IPAD_XOR_OPAD_BYTE                ( 0x6AU )                                        
#define LOG_INSUFFICIENT_MEMORY_ERROR( purposeOfWrite, bytesExceeded )                                                                         \
    {                                                                                                                                          \
        LogError( ( "Unable to " purposeOfWrite ": Insufficient memory configured in SIGV4_PROCESSING_BUFFER_LENGTH macro. BytesExceeded=%lu", \
                    ( unsigned long ) ( bytesExceeded ) ) );                                                                                   \
    }
 
#define FLAG_IS_SET( bits, flag )    ( ( ( bits ) & ( flag ) ) == ( flag ) )
 
#define isWhitespace( c )            ( ( ( c ) == ' ' ) || ( ( c ) == '\t' ) )
 
typedef struct SigV4DateTime
{
    int32_t tm_year; 
    int32_t tm_mon;  
    int32_t tm_mday; 
    int32_t tm_hour; 
    int32_t tm_min;  
    int32_t tm_sec;  
} SigV4DateTime_t;
 
typedef struct SigV4String
{
    char * pData;   
    size_t dataLen; 
} SigV4String_t;
 
typedef struct SigV4ConstString
{
    const char * pData; 
    size_t dataLen;     
} SigV4ConstString_t;
 
typedef struct SigV4KeyValuePair
{
    SigV4ConstString_t key;   
    SigV4ConstString_t value; 
} SigV4KeyValuePair_t;
 
typedef struct CanonicalContext
{
    SigV4KeyValuePair_t pQueryLoc[ SIGV4_MAX_QUERY_PAIR_COUNT ];    
    SigV4KeyValuePair_t pHeadersLoc[ SIGV4_MAX_HTTP_HEADER_COUNT ]; 
    uint8_t pBufProcessing[ SIGV4_PROCESSING_BUFFER_LENGTH ];       
    char * pBufCur;                                                 
    size_t bufRemaining;                                            
    const char * pHashPayloadLoc;                                   
    size_t hashPayloadLen;                                          
} CanonicalContext_t;
 
typedef struct HmacContext
{
    const SigV4CryptoInterface_t * pCryptoInterface;
 
    uint8_t key[ SIGV4_HASH_MAX_BLOCK_LENGTH ];
 
    size_t keyLen;
} HmacContext_t;
 
/* *INDENT-OFF* */
#ifdef __cplusplus
    }
#endif
/* *INDENT-ON* */
 
#endif /* ifndef SIGV4_INTERNAL_H_ */