30#ifndef SIGV4_INTERNAL_H_
31#define SIGV4_INTERNAL_H_
43#ifndef SIGV4_DO_NOT_USE_CUSTOM_CONFIG
44 #include "sigv4_config.h"
53#define MONTH_ASCII_LEN 3U
58#define MONTH_NAMES { "Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec" }
63#define MONTH_DAYS { 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31 }
65#define FORMAT_RFC_3339 "%4Y-%2M-%2DT%2h:%2m:%2sZ"
66#define FORMAT_RFC_3339_LEN sizeof( FORMAT_RFC_3339 ) - 1U
68#define FORMAT_RFC_5322 "%3*, %2D %3M %4Y %2h:%2m:%2s GMT"
69#define FORMAT_RFC_5322_LEN sizeof( FORMAT_RFC_5322 ) - 1U
71#define ISO_YEAR_LEN 4U
72#define ISO_NON_YEAR_LEN 2U
74#define ISO_DATE_SCOPE_LEN 8U
81#define CREDENTIAL_SCOPE_SEPARATOR '/'
82#define CREDENTIAL_SCOPE_SEPARATOR_LEN 1U
87#define CREDENTIAL_SCOPE_TERMINATOR "aws4_request"
88#define CREDENTIAL_SCOPE_TERMINATOR_LEN ( sizeof( CREDENTIAL_SCOPE_TERMINATOR ) - 1U )
93#define HTTP_EMPTY_PATH "/"
94#define HTTP_EMPTY_PATH_LEN ( sizeof( HTTP_EMPTY_PATH ) - 1U )
96#define URI_ENCODED_SPECIAL_CHAR_SIZE 3U
97#define URI_DOUBLE_ENCODED_EQUALS_CHAR_SIZE 5U
99#define LINEFEED_CHAR '\n'
100#define LINEFEED_CHAR_LEN 1U
102#define HTTP_REQUEST_LINE_ENDING "\r\n"
103#define HTTP_REQUEST_LINE_ENDING_LEN ( sizeof( HTTP_REQUEST_LINE_ENDING ) - 1U )
105#define SPACE_CHAR ' '
106#define SPACE_CHAR_LEN 1U
108#define S3_SERVICE_NAME "s3"
109#define S3_SERVICE_NAME_LEN ( sizeof( S3_SERVICE_NAME ) - 1U )
111#define SIGV4_HMAC_SIGNING_KEY_PREFIX "AWS4"
112#define SIGV4_HMAC_SIGNING_KEY_PREFIX_LEN ( sizeof( SIGV4_HMAC_SIGNING_KEY_PREFIX ) - 1U )
114#define AUTH_CREDENTIAL_PREFIX "Credential="
115#define AUTH_CREDENTIAL_PREFIX_LEN ( sizeof( AUTH_CREDENTIAL_PREFIX ) - 1U )
116#define AUTH_SEPARATOR ", "
117#define AUTH_SEPARATOR_LEN ( sizeof( AUTH_SEPARATOR ) - 1U )
118#define AUTH_SIGNED_HEADERS_PREFIX "SignedHeaders="
119#define AUTH_SIGNED_HEADERS_PREFIX_LEN ( sizeof( AUTH_SIGNED_HEADERS_PREFIX ) - 1U )
120#define AUTH_SIGNATURE_PREFIX "Signature="
121#define AUTH_SIGNATURE_PREFIX_LEN ( sizeof( AUTH_SIGNATURE_PREFIX ) - 1U )
123#define HMAC_INNER_PAD_BYTE ( 0x36U )
124#define HMAC_OUTER_PAD_BYTE ( 0x5CU )
125#define HMAX_IPAD_XOR_OPAD_BYTE ( 0x6AU )
130#define LOG_INSUFFICIENT_MEMORY_ERROR( purposeOfWrite, bytesExceeded ) \
132 LogError( ( "Unable to " purposeOfWrite ": Insufficient memory configured in SIGV4_PROCESSING_BUFFER_LENGTH macro. BytesExceeded=%lu", \
133 ( unsigned long ) ( bytesExceeded ) ) ); \
139#define FLAG_IS_SET( bits, flag ) ( ( ( bits ) & ( flag ) ) == ( flag ) )
149#define isWhitespace( c ) ( ( ( c ) == ' ' ) || ( ( c ) == '\t' ) )
156typedef struct SigV4DateTime
171typedef struct SigV4String
182typedef struct SigV4ConstString
193typedef struct SigV4KeyValuePair
203typedef struct CanonicalContext
219typedef struct HmacContext
The default values for configuration macros used by the SigV4 Library.
#define SIGV4_MAX_QUERY_PAIR_COUNT
Macro defining the maximum number of query key/value pairs, used to assist the library in sorting que...
Definition: sigv4_config_defaults.h:105
#define SIGV4_PROCESSING_BUFFER_LENGTH
Macro defining the size of the internal buffer used for incremental canonicalization and hashing.
Definition: sigv4_config_defaults.h:77
#define SIGV4_MAX_HTTP_HEADER_COUNT
Macro defining the maximum number of headers in the request, used to assist the library in sorting he...
Definition: sigv4_config_defaults.h:91
#define SIGV4_HASH_MAX_BLOCK_LENGTH
Macro indicating the largest block size of any hashing algorithm used for SigV4 authentication i....
Definition: sigv4_config_defaults.h:131
An aggregator to maintain the internal state of canonicalization during intermediate calculations.
Definition: sigv4_internal.h:204
size_t bufRemaining
Definition: sigv4_internal.h:210
const char * pHashPayloadLoc
Definition: sigv4_internal.h:211
size_t uxCursorIndex
Definition: sigv4_internal.h:209
size_t hashPayloadLen
Definition: sigv4_internal.h:212
An aggregator to maintain the internal state of HMAC calculations.
Definition: sigv4_internal.h:220
size_t keyLen
The length of the accumulated key data.
Definition: sigv4_internal.h:234
const SigV4CryptoInterface_t * pCryptoInterface
The cryptography interface.
Definition: sigv4_internal.h:224
A library structure holding the string and length values of parameters to be sorted and standardized....
Definition: sigv4_internal.h:183
const char * pData
Definition: sigv4_internal.h:184
size_t dataLen
Definition: sigv4_internal.h:185
The cryptography interface used to supply the user-defined hash implementation.
Definition: sigv4.h:238
An aggregator representing the individually parsed elements of the user-provided date parameter....
Definition: sigv4_internal.h:157
int32_t year
Definition: sigv4_internal.h:158
int32_t sec
Definition: sigv4_internal.h:163
int32_t hour
Definition: sigv4_internal.h:161
int32_t mday
Definition: sigv4_internal.h:160
int32_t mon
Definition: sigv4_internal.h:159
int32_t min
Definition: sigv4_internal.h:162
A key-value pair data structure that allows for sorting of SigV4 string values using internal compari...
Definition: sigv4_internal.h:194
SigV4ConstString_t value
Definition: sigv4_internal.h:196
SigV4ConstString_t key
Definition: sigv4_internal.h:195
A library structure holding the string and length values of parameters to be sorted and standardized....
Definition: sigv4_internal.h:172
char * pData
Definition: sigv4_internal.h:173
size_t dataLen
Definition: sigv4_internal.h:174