at.favre.lib.crypto.bkdf

Class CompoundHashData

java.lang.Object

at.favre.lib.crypto.bkdf.CompoundHashData

public final class CompoundHashData
extends Object

A data format encapsulating possible multiple hash configs which were applied to given hash.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CompoundHashData.Config

Field Summary

Fields

Modifier and Type	Field and Description
List<CompoundHashData.Config>	configList
byte[]	rawHash
byte[]	rawSalt

Constructor Summary

Constructors

Constructor and Description
CompoundHashData(List<CompoundHashData.Config> configList, byte[] rawSalt, byte[] rawHash)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
static CompoundHashData	from(HashData hashData) Convert normal hash data to compound format
byte[]	getAsBlobMessageFormat() Create the serialized message in raw byte array / blob format.
String	getAsEncodedMessageFormat() Similar to getAsBlobMessageFormat() but returns as Base64 url-encoded string
int	hashCode()
static CompoundHashData	parse(byte[] rawHashMessage) Parse given raw blob hash message in compound format and returns this data model.
static CompoundHashData	parse(String base64BkdfCompoundHashMsg) Parse given base64 hash message in compound format and returns this data model.
void	wipe() Wipes salt and hash internally.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

configList

public final List<CompoundHashData.Config> configList

rawSalt

public final byte[] rawSalt

rawHash

public final byte[] rawHash

Constructor Detail

CompoundHashData

public CompoundHashData(List<CompoundHashData.Config> configList,
                        byte[] rawSalt,
                        byte[] rawHash)

Method Detail

from

public static CompoundHashData from(HashData hashData)

Convert normal hash data to compound format

Parameters:

hashData - to convert

Returns:

compound format

parse

public static CompoundHashData parse(String base64BkdfCompoundHashMsg)

Parse given base64 hash message in compound format and returns this data model.

Parameters:

base64BkdfCompoundHashMsg - base64-url encoded msg, see getAsEncodedMessageFormat()

Returns:

new instance

parse

public static CompoundHashData parse(byte[] rawHashMessage)

Parse given raw blob hash message in compound format and returns this data model.

See getAsBlobMessageFormat().

Parameters:

rawHashMessage - to parse

Returns:

new instance

Throws:

Version.UnsupportedBkdfVersionException - if version identifier is not compound type

wipe

public void wipe()

Wipes salt and hash internally. This instance cannot be used after calling wipe.

getAsBlobMessageFormat

public byte[] getAsBlobMessageFormat()

Create the serialized message in raw byte array / blob format.

The format is V L CC CC CC CC ... SSSSSSSSSSSSSSSS HHHHHHHHHHHHHHHH

• V: the version byte
• L: unsigned byte of count of hash configs (each 2 byte)
• CC: 2 byte of bkdf version byte and cost factor
• S: 16 byte salt
• H: 23/24 byte hash

Returns:

blob message

getAsEncodedMessageFormat

public String getAsEncodedMessageFormat()

Similar to getAsBlobMessageFormat() but returns as Base64 url-encoded string

Returns:

base64-url encoded string

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object