SigV4HttpParameters_t Flags

Flags for SigV4HttpParameters_t.flags. These flags inform the library of parameters already in canonical form. More...

Macros
#define	SIGV4_HTTP_PATH_IS_CANONICAL_FLAG   0x1U
	Set this flag to indicate that the HTTP request path input is already canonicalized. More...
#define	SIGV4_HTTP_QUERY_IS_CANONICAL_FLAG   0x2U
	Set this flag to indicate that the HTTP request query input is already canonicalized. More...
#define	SIGV4_HTTP_HEADERS_ARE_CANONICAL_FLAG   0x4U
	Set this flag to indicate that the HTTP request headers input is already canonicalized. More...
#define	SIGV4_HTTP_PAYLOAD_IS_HASH   0x8U
	Set this flag to indicate that the HTTP request payload is already hashed. More...
#define	SIGV4_HTTP_ALL_ARE_CANONICAL_FLAG   0x7U
	Set this flag to indicate that the HTTP request path, query, and headers are all already canonicalized. More...

Detailed Description

Flags for SigV4HttpParameters_t.flags. These flags inform the library of parameters already in canonical form.

Flags should be bitwise-ORed with each other to change the behavior of SigV4_GenerateHTTPAuthorization.

Macro Definition Documentation

SIGV4_HTTP_PATH_IS_CANONICAL_FLAG

#define SIGV4_HTTP_PATH_IS_CANONICAL_FLAG   0x1U

Set this flag to indicate that the HTTP request path input is already canonicalized.

This flag is valid only for SigV4HttpParameters_t.flags.

SIGV4_HTTP_QUERY_IS_CANONICAL_FLAG

#define SIGV4_HTTP_QUERY_IS_CANONICAL_FLAG   0x2U

Set this flag to indicate that the HTTP request query input is already canonicalized.

This flag is valid only for SigV4HttpParameters_t.flags.

SIGV4_HTTP_HEADERS_ARE_CANONICAL_FLAG

#define SIGV4_HTTP_HEADERS_ARE_CANONICAL_FLAG   0x4U

Set this flag to indicate that the HTTP request headers input is already canonicalized.

This flag is valid only for SigV4HttpParameters_t.flags.

SIGV4_HTTP_PAYLOAD_IS_HASH

#define SIGV4_HTTP_PAYLOAD_IS_HASH   0x8U

Set this flag to indicate that the HTTP request payload is already hashed.

This flag is valid only for SigV4HttpParameters_t.flags.

SIGV4_HTTP_ALL_ARE_CANONICAL_FLAG

#define SIGV4_HTTP_ALL_ARE_CANONICAL_FLAG   0x7U

Set this flag to indicate that the HTTP request path, query, and headers are all already canonicalized.

This flag is valid only for SigV4HttpParameters_t.flags.