Package org.cryptacular

Class SaltedHash

java.lang.Object
org.cryptacular.SaltedHash
public class SaltedHash extends Object
Container for the output of a salted hash operation that includes both the digest output and salt value.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final byte[]
    hash
    Digest output.
    private static final int
    MAX_SALT_LENGTH
    Maximum salt length in bytes.
    private final byte[]
    salt
    Salt value.

  • Constructor Summary

    Constructors
    Constructor
    Description
    SaltedHash(byte[] hash, byte[] salt)
    Creates a new instance with digest and salt data.
    SaltedHash(byte[] hashWithSalt, int digestLength, boolean toEnd)
    Creates a new instance from byte input that contains the concatenation of digest output and salt.

  • Method Summary

    Modifier and Type
    Method
    Description
    byte[]
    concatenateSalt(boolean toEnd)
    Gets a byte array containing the concatenation of digest output and salt.
    String
    concatenateSalt(boolean toEnd, Encoder encoder)
    Gets an encoded string of the concatenation of digest output and salt.
    byte[]
    getHash()
     
    byte[]
    getSalt()
     
    byte[]
    getSalt(int n)
    Gets N bytes of salt.

    Methods inherited from class java.lang.Object

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

  • Field Details

    • MAX_SALT_LENGTH

      private static final int MAX_SALT_LENGTH
      Maximum salt length in bytes.

    • hash

      private final byte[] hash
      Digest output.

    • salt

      private final byte[] salt
      Salt value.

  • Constructor Details

    • SaltedHash

      public SaltedHash(byte[] hash, byte[] salt)
      Creates a new instance with digest and salt data.
      Parameters:
      hash - Digest output.
      salt - Salt value used to compute salt.

    • SaltedHash

      public SaltedHash(byte[] hashWithSalt, int digestLength, boolean toEnd)
      Creates a new instance from byte input that contains the concatenation of digest output and salt.
      Parameters:
      hashWithSalt - Concatenation of hash and salt.
      digestLength - Number of bytes in digest output.
      toEnd - True if salt is appended to end of hash, false if salt is prepended to hash.

  • Method Details

    • getHash

      public byte[] getHash()
      Returns:
      Digest output.

    • getSalt

      public byte[] getSalt()
      Returns:
      Salt value.

    • getSalt

      public byte[] getSalt(int n)
      Gets N bytes of salt.
      Parameters:
      n - Number of bytes of salt; must be less than or equal to salt size.
      Returns:
      First N bytes of salt.

    • concatenateSalt

      public String concatenateSalt(boolean toEnd, Encoder encoder)
      Gets an encoded string of the concatenation of digest output and salt.
      Parameters:
      toEnd - True to append salt to end of hash, false to prefix hash with salt.
      encoder - Encodes concatenated bytes to a string.
      Returns:
      Salt concatenated to hash encoded as a string.

    • concatenateSalt

      public byte[] concatenateSalt(boolean toEnd)
      Gets a byte array containing the concatenation of digest output and salt.
      Parameters:
      toEnd - True to append salt to end of hash, false to prefix hash with salt.
      Returns:
      Salt concatenated to hash.