Package ca.corbett.extras.crypt

Class HashUtil

java.lang.Object
ca.corbett.extras.crypt.HashUtil
public class HashUtil extends Object
A simple wrapper class to simplify hashing functionality a little.
Since:
2012-08-29 (originally written for ICE and then generalized much later)
Author:
scorbo2

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    HashUtil.HashType
     

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    HashUtil()
    Protected constructor to allow subclassing for application-specific utility methods while preventing direct instantiation of this utility class.

  • Method Summary

    Modifier and Type
    Method
    Description
    static String
    byteArrayToHexString(byte[] data)
    Converts a byte array into a hex-encoded printable string.
    static byte[]
    getHash(byte[] data)
    Returns a digest of the data in the given byte array using SHA-1.
    static byte[]
    getHash(HashUtil.HashType hashType, byte[] data)
    Returns a digest of the data in the given byte array using the given HashType.
    static byte[]
    getHash(HashUtil.HashType hashType, File file)
    Returns a digest of the contents of the given file, using the given HashType.
    static byte[]
    getHash(File file)
    Returns a digest of the contents of the given file.
    static String
    getHashString(byte[] data)
    Hashes the given byte array and then returns a printable string (hex format) of the given byte array, using SHA-1 as the hash type.
    static String
    getHashString(HashUtil.HashType hashType, byte[] data)
    Hashes the given byte array using the given HashType and then returns a printable string (hex format) of the output.
    static String
    getHashString(HashUtil.HashType hashType, File file)
    Returns a printable string (hex format) of the hash of the given file contents, using the given HashType.
    static String
    getHashString(File file)
    Returns a printable string (hex format) of the hash of the given file contents.
    static MessageDigest
    getMessageDigest(HashUtil.HashType hashType)
    Returns a new MessageDigest instance for the given HashType.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • HashUtil

      protected HashUtil()
      Protected constructor to allow subclassing for application-specific utility methods while preventing direct instantiation of this utility class.

  • Method Details

    • getMessageDigest

      public static MessageDigest getMessageDigest(HashUtil.HashType hashType)
      Returns a new MessageDigest instance for the given HashType. Every algorithm in HashType is guaranteed to be available in any standard Java implementation, so this method should always succeed unless something is very wrong with the runtime environment.
      Parameters:
      hashType - The HashType to use.
      Returns:
      A new MessageDigest instance for the given HashType, or null if the algorithm is not available.

    • getHash

      public static byte[] getHash(HashUtil.HashType hashType, byte[] data)
      Returns a digest of the data in the given byte array using the given HashType.
      Parameters:
      hashType - The HashType to use.
      data - A byte array of any length.
      Returns:
      A hash of the input array using the specified digest algorithm.

    • getHash

      public static byte[] getHash(byte[] data)
      Returns a digest of the data in the given byte array using SHA-1.
      Parameters:
      data - A byte array of any length.
      Returns:
      A SHA-1 hash of the input array.

    • getHash

      public static byte[] getHash(HashUtil.HashType hashType, File file) throws IOException
      Returns a digest of the contents of the given file, using the given HashType.
      Parameters:
      hashType - The HashType to use.
      file - The input file. Must exist and be readable.
      Returns:
      A hash of the file contents, in the specified digest type.
      Throws:
      IOException - If the file does not exist or is not readable.

    • getHash

      public static byte[] getHash(File file) throws IOException
      Returns a digest of the contents of the given file. File must exist and be readable. Uses SHA-1 as the default hash type.
      Parameters:
      file - The input file. Must exist and be readable.
      Returns:
      A SHA-1 hash of the file contents.
      Throws:
      IOException - If the file does not exist or is not readable.

    • getHashString

      public static String getHashString(HashUtil.HashType hashType, byte[] data)
      Hashes the given byte array using the given HashType and then returns a printable string (hex format) of the output.
      Parameters:
      hashType - The HashType to use.
      data - A byte array of any length.
      Returns:
      A hex-encoded printable string equivalent to the hash of the input.

    • getHashString

      public static String getHashString(byte[] data)
      Hashes the given byte array and then returns a printable string (hex format) of the given byte array, using SHA-1 as the hash type.
      Parameters:
      data - A byte array of any length.
      Returns:
      A hex-encoded printable string equivalent to the hash of the input.

    • getHashString

      public static String getHashString(HashUtil.HashType hashType, File file) throws IOException
      Returns a printable string (hex format) of the hash of the given file contents, using the given HashType.
      Parameters:
      hashType - The HashType to use.
      file - The input file in question. Must exist and be readable.
      Returns:
      A hex-encoded printable string of the hash of the file contents.
      Throws:
      IOException - If the file does not exist or is not readable.

    • getHashString

      public static String getHashString(File file) throws IOException
      Returns a printable string (hex format) of the hash of the given file contents.
      Parameters:
      file - The input file in question. Must exist and be readable.
      Returns:
      A hex-encoded printable string equivalent of the hash of the file contents.
      Throws:
      IOException - If the file does not exist or is not readable.

    • byteArrayToHexString

      public static String byteArrayToHexString(byte[] data)
      Converts a byte array into a hex-encoded printable string. As of swing-extras 2.4, this method simply delegates to the java.util.HexFormat class, which is available as of Java 17.
      Parameters:
      data - An input array of any length.
      Returns:
      A printable hex-encoded string equivalent.