The cryptography interface used to supply the user-defined hash implementation. More...

#include <sigv4.h>

Data Fields
int32_t(*	hashInit )(void *pHashContext)
	Initializes the `pHashContext`.

int32_t(*	hashUpdate )(void pHashContext, const uint8_t pInput, size_t inputLen)
	Calculates an ongoing hash update (SHA-256, for example).

int32_t(*	hashFinal )(void pHashContext, uint8_t pOutput, size_t outputLen)
	Calculates the final binary digest of the hash from the context.

void *	pHashContext
	Context for the hashInit, hashUpdate, and hashFinal interfaces.

size_t	hashBlockLen
	The block length of the hash function.

size_t	hashDigestLen
	The digest length of the hash function.

Detailed Description

The cryptography interface used to supply the user-defined hash implementation.

Field Documentation

int32_t(* SigV4CryptoInterface_t::hashInit) (void *pHashContext)

Initializes the pHashContext.

Parameters

[in] pHashContext Context used to maintain the hash's current state during incremental updates.

int32_t(* SigV4CryptoInterface_t::hashUpdate) (void *pHashContext, const uint8_t *pInput, size_t inputLen)

Calculates an ongoing hash update (SHA-256, for example).

Parameters

[in]	pHashContext	Context used to maintain the hash's current state during incremental updates.
[in]	pInput	Buffer holding the data to hash.
[in]	inputLen	length of the input buffer data.

int32_t(* SigV4CryptoInterface_t::hashFinal) (void *pHashContext, uint8_t *pOutput, size_t outputLen)

Calculates the final binary digest of the hash from the context.

Parameters

[in]	pHashContext	Context used to maintain the hash's current state during incremental updates.
[out]	pOutput	The buffer used to place final hash binary digest output.
[in]	outputLen	The length of the pOutput buffer, which must be larger than the hash digest length specified in SIGV4_HASH_MAX_DIGEST_LENGTH.

The documentation for this struct was generated from the following file: