Util

Typedefs
typedef struct KSI_HmacHasher_st	KSI_HmacHasher

Functions
int	KSI_base32Decode (const char *base32, unsigned char **data, size_t *data_len)
int	KSI_base32Encode (const unsigned char *data, size_t data_len, size_t group_len, char **encoded)
unsigned long	KSI_crc32 (const void *data, size_t length, unsigned long ival)
int	KSI_HMAC_create (KSI_CTX *ctx, KSI_HashAlgorithm algo_id, const char *key, const unsigned char *data, size_t data_len, KSI_DataHash **hmac)
int	KSI_HmacHasher_open (KSI_CTX *ctx, KSI_HashAlgorithm algo_id, const char *key, KSI_HmacHasher **hasher)
int	KSI_HmacHasher_reset (KSI_HmacHasher *hasher)
int	KSI_HmacHasher_add (KSI_HmacHasher *hasher, const void *data, size_t data_length)
int	KSI_HmacHasher_close (KSI_HmacHasher *hasher, KSI_DataHash **hmac)
void	KSI_HmacHasher_free (KSI_HmacHasher *hasher)

Detailed Description

Typedef Documentation

KSI_HmacHasher

typedef struct KSI_HmacHasher_st KSI_HmacHasher

This structure is used for calculating the HMAC hash values.

See also

KSI_DataHash, KSI_HmacHasher_open, KSI_HmacHasher_reset, KSI_HmacHasher_close, KSI_HmacHasher_free

Function Documentation

KSI_base32Decode()

int KSI_base32Decode	(	const char *	base32,
		unsigned char **	data,
		size_t *	data_len
	)

Decodes given base32 encoded data.

Parameters

[in]	base32	Pointer to the base32 encoded source string.
[out]	data	Pointer to the receiving pointer.
[out]	data_len	Pointer to the raw value length variable.

Returns

status code (KSI_OK, when operation succeeded, otherwise an error code).

Note

The caller is responsible for freeing the output memory data.

KSI_base32Encode()

int KSI_base32Encode	(	const unsigned char *	data,
		size_t	data_len,
		size_t	group_len,
		char **	encoded
	)

Encodes given binary data to base32.

Parameters

[in]	data	Pointer to the input data.
[in]	data_len	Length of the input data.
[in]	group_len	Length of a group (the groups are separated with '-')
[out]	encoded	Pointer to the receiving pointer.

Returns

status code (KSI_OK, when operation succeeded, otherwise an error code).

Note

The caller is responsible for freeing the output memory encoded.

KSI_crc32()

unsigned long KSI_crc32	(	const void *	data,
		size_t	length,
		unsigned long	ival
	)

Calculates CRC32 checksum.

Parameters

[in]	data	Pointer to the data.
[in]	length	Length of the data.
[in]	ival	Initial value. Pass 0 for the first or single call to this function and pass result from the previous call for the next part of the data.

Returns

CRC32 of the data.

KSI_HMAC_create()

int KSI_HMAC_create	(	KSI_CTX *	ctx,
		KSI_HashAlgorithm	algo_id,
		const char *	key,
		const unsigned char *	data,
		size_t	data_len,
		KSI_DataHash **	hmac
	)

Creates a KSI_DataHash representing the HMAC value calculated by the key and data using alg as the hash algorithm.

Parameters

[in]	ctx	KSI context.
[in]	algo_id	Hash algorithm ID see KSI_Hash
[in]	key	Key value for the HMAC.
[in]	data	Pointer to the data to be HMAC'ed.
[in]	data_len	Length of the data.
[out]	hmac	Pointer to the receiving pointer.

Returns

status code (KSI_OK, when operation succeeded, otherwise an error code).

See also

KSI_DataHash_free

KSI_HmacHasher_add()

int KSI_HmacHasher_add	(	KSI_HmacHasher *	hasher,
		const void *	data,
		size_t	data_length
	)

Adds data to an open HMAC computation.

Parameters

[in]	hasher	Hasher object.
[in]	data	Pointer to the data to be hashed.
[in]	data_length	Length of the hashed data.

Returns

status code (KSI_OK, when operation succeeded, otherwise an error code).

See also

KSI_HmacHasher_open, KSI_HmacHasher_close

KSI_HmacHasher_close()

int KSI_HmacHasher_close	(	KSI_HmacHasher *	hasher,
		KSI_DataHash **	hmac
	)

Finalizes an HMAC computation.

Parameters

[in]	hasher	Hasher object.
[out]	hmac	Pointer that will receive pointer to the hash object.

Returns

status code (KSI_OK, when operation succeeded, otherwise an error code).

See also

KSI_HmacHasher_open, KSI_HmacHasher_add, KSI_HmacHasher_free

KSI_HmacHasher_free()

void KSI_HmacHasher_free

(

KSI_HmacHasher *

hasher

)

Frees the hasher object.

Parameters

[in]

hasher

Hasher object.

See also

KSI_HmacHasher_open

KSI_HmacHasher_open()

int KSI_HmacHasher_open	(	KSI_CTX *	ctx,
		KSI_HashAlgorithm	algo_id,
		const char *	key,
		KSI_HmacHasher **	hasher
	)

Starts an HMAC computation.

Parameters

[in]	ctx	KSI context.
[in]	algo_id	Identifier of the hash algorithm. See KSI_HashAlgorithm_en for possible values.
[in]	key	Key value for the HMAC.
[out]	hasher	Pointer that will receive pointer to the hasher object.

Returns

status code (KSI_OK, when operation succeeded, otherwise an error code).

See also

KSI_HmacHasher_add, KSI_HmacHasher_close

KSI_HmacHasher_reset()

int KSI_HmacHasher_reset

(

KSI_HmacHasher *

hasher

)

Resets the state of the HMAC computation.

Parameters

[in]

hasher

The hasher.

Returns

status code (KSI_OK, when operation succeeded, otherwise an error code).

See also

KSI_HmacHasher_open, KSI_HmacHasher_close