Driver::Crypto::PasswordHash Namespace Reference

The 'PasswordHash' namespace provides a basic 'algorithm' to hash a password when something like 'bcrypt' is not available. More...

Detailed Description

The 'PasswordHash' namespace provides a basic 'algorithm' to hash a password when something like 'bcrypt' is not available.

Functions
DriverCryptoStatus_T	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.

Function Documentation

hash()

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.

Expected use is for a primitive 'hash' of password. The algorithm is:

H = FUNC(HF, plaintext, salt, c)
where:
    - H is output of FUNC (i.e., the final result of the hashing process).
        o The size, in bytes, of H is 32 bytes (i.e., the size of the HF 
          function’s digest).
    - FUNC is the top-level function.
    - HF is the cryptographic hashing function.
    - salt is a N byte array provided by caller
    - plaintext is ASCII plain text, i.e. the password that is being ‘hashed’.
    - c is the number of iterations to run HF hashing algorithm. The first 
      iteration is performed on plaintext + salt, subsequent iterations use 
      plaintext + <previous-iteration-output> as their input.  The output 
      of each iteration is XOR’d to produce the final result.
 
        F(plaintext, salt, c) = U1 ^ U2 … ^ Uc
        where:
            U1 = HF(plaintext + salt)
            U2 = HF(plaintext + U1)
            Uc = HF(plaintext + Uc-1)

Notes:

• The size of 'dstOutputBuffer' MUST be greater than or equal to the size of the hashFunction's digest size.
• The caller is required to provide a 'workBuffer' who's size is equal to OR larger than ALL of the values listed below: o plaintextLength + saltLength o plaintextLength + hashFunction.digestSize()
• The caller is required to provide additional 'workDigest' memory that is used a scratch pad for the hash digest. The size must be greater than or equal to the size of the hashFunction's digest.