Api.h File Reference

#include "Driver/Crypto/Hash.h"

Include dependency graph for Api.h:

Go to the source code of this file.

Namespaces
namespace	Driver
	namespace
namespace	Driver::Crypto
	The 'Crypto' namespace provides a collection of Cryptographic functions and algorithms.
namespace	Driver::Crypto::PasswordHash
	The 'PasswordHash' namespace provides a basic 'algorithm' to hash a password when something like 'bcrypt' is not available.

Macros
#define	DRIVER_CRYPTO_PASSWORD_SUCCESS   DRIVER_CRYPTO_SUCCESS
	Result: Success.
#define	DRIVER_CRYPTO_PASSWORD_OUTPUT_BAD_SIZE   (DRIVER_CRYPTO_SUCCESS+1)
	Result: Output buffer not large enough to hold the hash output.
#define	DRIVER_CRYPTO_PASSWORD_WORK_BUFFER_BAD_SIZE   (DRIVER_CRYPTO_SUCCESS+2)
	Result: Provided work buffer not large enough.
#define	DRIVER_CRYPTO_PASSWORD_WORK_DIGEST_BAD_SIZE   (DRIVER_CRYPTO_SUCCESS+3)
	Result: Provided work hash digest buffer not large enough.
#define	DRIVER_CRYPTO_PASSWORD_HASH_FUNCTION_ERROR   (DRIVER_CRYPTO_SUCCESS+4)
	Result: Hash function failure.

Functions
DriverCryptoStatus_T	Driver::Crypto::PasswordHash::hash (const char *plaintext, size_t plaintextLength, const void *salt, size_t saltLength, uint8_t *workBuffer, size_t workBufferLength, uint8_t *workDigest, size_t workDigestLength, Driver::Crypto::Hash &hashFunction, size_t numIterations, void *dstOutputBuffer, size_t dstOutputBufferLen) noexcept
	This method takes plain text plus a 'salt' and generates an hashed output.

Macro Definition Documentation

DRIVER_CRYPTO_PASSWORD_HASH_FUNCTION_ERROR

#define DRIVER_CRYPTO_PASSWORD_HASH_FUNCTION_ERROR   (DRIVER_CRYPTO_SUCCESS+4)

Result: Hash function failure.

DRIVER_CRYPTO_PASSWORD_OUTPUT_BAD_SIZE

#define DRIVER_CRYPTO_PASSWORD_OUTPUT_BAD_SIZE   (DRIVER_CRYPTO_SUCCESS+1)

Result: Output buffer not large enough to hold the hash output.

DRIVER_CRYPTO_PASSWORD_SUCCESS

#define DRIVER_CRYPTO_PASSWORD_SUCCESS   DRIVER_CRYPTO_SUCCESS

Result: Success.

DRIVER_CRYPTO_PASSWORD_WORK_BUFFER_BAD_SIZE

#define DRIVER_CRYPTO_PASSWORD_WORK_BUFFER_BAD_SIZE   (DRIVER_CRYPTO_SUCCESS+2)

Result: Provided work buffer not large enough.

DRIVER_CRYPTO_PASSWORD_WORK_DIGEST_BAD_SIZE

#define DRIVER_CRYPTO_PASSWORD_WORK_DIGEST_BAD_SIZE   (DRIVER_CRYPTO_SUCCESS+3)

Result: Provided work hash digest buffer not large enough.