iqr_hash.h

Go to the documentation of this file.

#ifndef IQR_HASH_H
#define IQR_HASH_H

#ifdef __cplusplus
extern "C" {
#endif

#include "iqr_api.h"
#include "iqr_context.h"
#include "iqr_retval.h"

#include <stddef.h>
#include <stdint.h>

// ---------------------------------------------------------------------------------------------------------------------------------
// Opaque data type.
// ---------------------------------------------------------------------------------------------------------------------------------

typedef struct iqr_Hash_struct iqr_Hash;

// ---------------------------------------------------------------------------------------------------------------------------------
// Constants.
// ---------------------------------------------------------------------------------------------------------------------------------

typedef enum {
    IQR_HASHALGO_SHA2_256,

    IQR_HASHALGO_SHA2_512,

    IQR_HASHALGO_SHA3_256,

    IQR_HASHALGO_SHA3_512,

    // Maintain a count of supported algorithms. MUST BE LAST.
    IQR_HASHALGO_MAX,
} iqr_HashAlgorithmType;

#define IQR_SHA2_224_DIGEST_SIZE    28  
#define IQR_SHA2_256_DIGEST_SIZE    32  
#define IQR_SHA2_384_DIGEST_SIZE    48  
#define IQR_SHA2_512_DIGEST_SIZE    64  

#define IQR_SHA3_224_DIGEST_SIZE    28  
#define IQR_SHA3_256_DIGEST_SIZE    32  
#define IQR_SHA3_384_DIGEST_SIZE    48  
#define IQR_SHA3_512_DIGEST_SIZE    64  

// ---------------------------------------------------------------------------------------------------------------------------------
// Data structure.
// ---------------------------------------------------------------------------------------------------------------------------------

typedef struct {
    iqr_retval (*initialize)(void **state);

    iqr_retval (*begin)(void *state);

    iqr_retval (*update)(void *state, const uint8_t *data, size_t size);

    iqr_retval (*end)(void *state, uint8_t *digest, size_t size);

    iqr_retval (*cleanup)(void **state);
} iqr_HashCallbacks;

// ---------------------------------------------------------------------------------------------------------------------------------
// Global function registration.
// ---------------------------------------------------------------------------------------------------------------------------------

IQR_EXTERN
const iqr_HashCallbacks IQR_HASH_DEFAULT_SHA2_256;

IQR_EXTERN
const iqr_HashCallbacks IQR_HASH_DEFAULT_SHA2_512;

IQR_EXTERN
const iqr_HashCallbacks IQR_HASH_DEFAULT_SHA3_256;

IQR_EXTERN
const iqr_HashCallbacks IQR_HASH_DEFAULT_SHA3_512;

IQR_API
iqr_retval iqr_HashRegisterCallbacks(iqr_Context *ctx, iqr_HashAlgorithmType algo, const iqr_HashCallbacks *cb);

// ---------------------------------------------------------------------------------------------------------------------------------
// Hash object management.
// ---------------------------------------------------------------------------------------------------------------------------------

IQR_API
iqr_retval iqr_HashCreate(const iqr_Context *ctx, iqr_HashAlgorithmType algo, iqr_Hash **obj);

IQR_API_UNENFORCED_RETURN
iqr_retval iqr_HashDestroy(iqr_Hash **obj);

// ---------------------------------------------------------------------------------------------------------------------------------
// Hashing functionality.
// ---------------------------------------------------------------------------------------------------------------------------------

IQR_API
iqr_retval iqr_HashBegin(iqr_Hash *obj);

IQR_API
iqr_retval iqr_HashUpdate(iqr_Hash *obj, const uint8_t *data, size_t size);

IQR_API
iqr_retval iqr_HashEnd(iqr_Hash *obj, uint8_t *digest, size_t digest_size);

IQR_API
iqr_retval iqr_HashMessage(iqr_Hash *obj, const uint8_t *data, size_t data_size, uint8_t *digest, size_t digest_size);

IQR_API
iqr_retval iqr_HashGetDigestSize(const iqr_Hash *obj, size_t *size);

IQR_API
iqr_retval iqr_HashGetAlgorithmType(const iqr_Hash *obj, iqr_HashAlgorithmType *algo);

IQR_API
iqr_retval iqr_HashAlgorithmGetDigestSize(const iqr_HashAlgorithmType algo, size_t *digest_size);

// ---------------------------------------------------------------------------------------------------------------------------------
// Randomized extension to hashing functionality.
// ---------------------------------------------------------------------------------------------------------------------------------

IQR_API
iqr_retval iqr_HashSetSalt(iqr_Hash *obj, const uint8_t *salt, size_t salt_size);

IQR_API
iqr_retval iqr_HashGetSalt(const iqr_Hash *obj, uint8_t *salt, size_t salt_size);

IQR_API
iqr_retval iqr_HashGetSaltSize(const iqr_Hash *obj, size_t *salt_size);

#ifdef __cplusplus
}
#endif

#endif /* IQR_HASH_H */