org.antfarmer.ejce.util

Class MessageDigestUtil

java.lang.Object

org.antfarmer.ejce.util.MessageDigestUtil

public class MessageDigestUtil
extends Object

Utility providing methods to compute simple message digests (hashes) using various algorithms.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALGORITHM_MD2 The MD2 message digest algorithm as defined in RFC 1319.
static String	ALGORITHM_MD5 The MD5 message digest algorithm as defined in RFC 1321.
static String	ALGORITHM_SHA1 The SHA1 algorithm defined in FIPS PUB 180-4.
static String	ALGORITHM_SHA2_224 The SHA-224 algorithm defined in FIPS PUB 180-4.
static String	ALGORITHM_SHA2_256 The SHA-256 algorithm defined in FIPS PUB 180-4.
static String	ALGORITHM_SHA2_384 The SHA-384 algorithm defined in FIPS PUB 180-4.
static String	ALGORITHM_SHA2_512 The SHA-512 algorithm defined in FIPS PUB 180-4.
static String	ALGORITHM_SHA2_512_224 The SHA-512/224 algorithm defined in FIPS PUB 180-4.
static String	ALGORITHM_SHA2_512_256 The SHA-512/256 algorithm defined in FIPS PUB 180-4.
static String	ALGORITHM_SHA3_224 The SHA3-224 Permutation-based hash and extendable-output function as defined in FIPS PUB 202.
static String	ALGORITHM_SHA3_256 The SHA3-256 Permutation-based hash and extendable-output function as defined in FIPS PUB 202.
static String	ALGORITHM_SHA3_384 The SHA3-384 Permutation-based hash and extendable-output function as defined in FIPS PUB 202.
static String	ALGORITHM_SHA3_512 The SHA3-512 Permutation-based hash and extendable-output function as defined in FIPS PUB 202.

Method Summary

Modifier and Type	Method and Description
static byte[]	hashBytes(byte[] bytes, String algorithm) Hashes the given bytes using the given MessageDigest algorithm.
static byte[]	hashBytes(byte[] bytes, String algorithm, Provider provider, String providerName) Hashes the given bytes using the given MessageDigest algorithm.
static String	hashString(String text, Charset charset, String algorithm) Hashes the given text using the given MessageDigest algorithm and encodes the result using a Base64Encoder.
static String	hashString(String text, Charset charset, String algorithm, Provider provider, String providerName) Hashes the given text using the given MessageDigest algorithm and encodes the result using a Base64Encoder.
static String	hashString(String text, Charset charset, String algorithm, Provider provider, String providerName, TextEncoder encoder) Hashes the given text using the given MessageDigest algorithm and encodes the result using the given TextEncoder.
static String	hashString(String text, Charset charset, String algorithm, TextEncoder encoder) Hashes the given text using the given MessageDigest algorithm and encodes the result using the given TextEncoder.
static String	hashString(String text, String algorithm) Hashes the given text using the given MessageDigest algorithm and encodes the result using a Base64Encoder.
static String	hashString(String text, String algorithm, Provider provider, String providerName) Hashes the given text using the given MessageDigest algorithm and encodes the result using a Base64Encoder.
static String	hashString(String text, String algorithm, Provider provider, String providerName, TextEncoder encoder) Hashes the given text using the given MessageDigest algorithm and encodes the result using the given TextEncoder.
static String	hashString(String text, String algorithm, TextEncoder encoder) Hashes the given text using the given MessageDigest algorithm and encodes the result using the given TextEncoder.

Methods inherited from class java.lang.Object

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

Field Detail

ALGORITHM_MD2

public static final String ALGORITHM_MD2

The MD2 message digest algorithm as defined in RFC 1319. Produces a 128 bit digest.

See Also:

Constant Field Values

ALGORITHM_MD5

public static final String ALGORITHM_MD5

The MD5 message digest algorithm as defined in RFC 1321. Produces a 128 bit digest.

See Also:

Constant Field Values

ALGORITHM_SHA1

public static final String ALGORITHM_SHA1

The SHA1 algorithm defined in FIPS PUB 180-4. Produces a 160 bit digest.

See Also:

Constant Field Values

ALGORITHM_SHA2_224

public static final String ALGORITHM_SHA2_224

The SHA-224 algorithm defined in FIPS PUB 180-4. Produces a 224 bit digest.

See Also:

Constant Field Values

ALGORITHM_SHA2_256

public static final String ALGORITHM_SHA2_256

The SHA-256 algorithm defined in FIPS PUB 180-4. Produces a 256 bit digest.

See Also:

Constant Field Values

ALGORITHM_SHA2_384

public static final String ALGORITHM_SHA2_384

The SHA-384 algorithm defined in FIPS PUB 180-4. Produces a 384 bit digest.

See Also:

Constant Field Values

ALGORITHM_SHA2_512

public static final String ALGORITHM_SHA2_512

The SHA-512 algorithm defined in FIPS PUB 180-4. Produces a 512 bit digest.

See Also:

Constant Field Values

ALGORITHM_SHA2_512_224

public static final String ALGORITHM_SHA2_512_224

The SHA-512/224 algorithm defined in FIPS PUB 180-4.

See Also:

Constant Field Values

ALGORITHM_SHA2_512_256

public static final String ALGORITHM_SHA2_512_256

The SHA-512/256 algorithm defined in FIPS PUB 180-4.

See Also:

Constant Field Values

ALGORITHM_SHA3_224

public static final String ALGORITHM_SHA3_224

The SHA3-224 Permutation-based hash and extendable-output function as defined in FIPS PUB 202. SHA3-224 produces a 224 bit digest.

See Also:

Constant Field Values

ALGORITHM_SHA3_256

public static final String ALGORITHM_SHA3_256

The SHA3-256 Permutation-based hash and extendable-output function as defined in FIPS PUB 202. SHA3-256 produces a 256 bit digest.

See Also:

Constant Field Values

ALGORITHM_SHA3_384

public static final String ALGORITHM_SHA3_384

The SHA3-384 Permutation-based hash and extendable-output function as defined in FIPS PUB 202. SHA3-384 produces a 384 bit digest.

See Also:

Constant Field Values

ALGORITHM_SHA3_512

public static final String ALGORITHM_SHA3_512

The SHA3-512 Permutation-based hash and extendable-output function as defined in FIPS PUB 202. SHA3-512 produces a 512 bit digest.

See Also:

Constant Field Values

Method Detail

hashString

public static String hashString(String text,
                                String algorithm)
                         throws NoSuchAlgorithmException

Hashes the given text using the given MessageDigest algorithm and encodes the result using a Base64Encoder.

Parameters:

text - the text

algorithm - the MessageDigest algorithm

Returns:

a hash of the given text

Throws:

NoSuchAlgorithmException - NoSuchAlgorithmException

hashString

public static String hashString(String text,
                                Charset charset,
                                String algorithm)
                         throws NoSuchAlgorithmException

Hashes the given text using the given MessageDigest algorithm and encodes the result using a Base64Encoder.

Parameters:

text - the text

charset - the Charset used for the given text

algorithm - the MessageDigest algorithm

Returns:

a hash of the given text

Throws:

NoSuchAlgorithmException - NoSuchAlgorithmException

hashString

public static String hashString(String text,
                                String algorithm,
                                TextEncoder encoder)
                         throws NoSuchAlgorithmException

Hashes the given text using the given MessageDigest algorithm and encodes the result using the given TextEncoder.

Parameters:

text - the text

algorithm - the MessageDigest algorithm

encoder - the TextEncoder

Returns:

a hash of the given text

Throws:

NoSuchAlgorithmException - NoSuchAlgorithmException

hashString

public static String hashString(String text,
                                Charset charset,
                                String algorithm,
                                TextEncoder encoder)
                         throws NoSuchAlgorithmException

Hashes the given text using the given MessageDigest algorithm and encodes the result using the given TextEncoder.

Parameters:

text - the text

charset - the Charset used for the given text

algorithm - the MessageDigest algorithm

encoder - the TextEncoder

Returns:

a hash of the given text

Throws:

NoSuchAlgorithmException - NoSuchAlgorithmException

hashString

public static String hashString(String text,
                                String algorithm,
                                Provider provider,
                                String providerName)
                         throws NoSuchAlgorithmException,
                                NoSuchProviderException

Hashes the given text using the given MessageDigest algorithm and encodes the result using a Base64Encoder.

Parameters:

text - the text

algorithm - the MessageDigest algorithm

provider - the JCE-compliant provider (may be null)

providerName - the name of the JCE-compliant provider (may be null)

Returns:

a hash of the given text

Throws:

NoSuchAlgorithmException - NoSuchAlgorithmException

NoSuchProviderException - NoSuchProviderException

hashString

public static String hashString(String text,
                                Charset charset,
                                String algorithm,
                                Provider provider,
                                String providerName)
                         throws NoSuchAlgorithmException,
                                NoSuchProviderException

Hashes the given text using the given MessageDigest algorithm and encodes the result using a Base64Encoder.

Parameters:

text - the text

charset - the Charset used for the given text

algorithm - the MessageDigest algorithm

provider - the JCE-compliant provider (may be null)

providerName - the name of the JCE-compliant provider (may be null)

Returns:

a hash of the given text

Throws:

NoSuchAlgorithmException - NoSuchAlgorithmException

NoSuchProviderException - NoSuchProviderException

hashString

public static String hashString(String text,
                                String algorithm,
                                Provider provider,
                                String providerName,
                                TextEncoder encoder)
                         throws NoSuchAlgorithmException,
                                NoSuchProviderException

Hashes the given text using the given MessageDigest algorithm and encodes the result using the given TextEncoder.

Parameters:

text - the text

algorithm - the MessageDigest algorithm

provider - the JCE-compliant provider (may be null)

providerName - the name of the JCE-compliant provider (may be null)

encoder - the TextEncoder

Returns:

a hash of the given text

Throws:

NoSuchAlgorithmException - NoSuchAlgorithmException

NoSuchProviderException - NoSuchProviderException

hashString

public static String hashString(String text,
                                Charset charset,
                                String algorithm,
                                Provider provider,
                                String providerName,
                                TextEncoder encoder)
                         throws NoSuchAlgorithmException,
                                NoSuchProviderException

Hashes the given text using the given MessageDigest algorithm and encodes the result using the given TextEncoder.

Parameters:

text - the text

charset - the Charset used for the given text

algorithm - the MessageDigest algorithm

provider - the JCE-compliant provider (may be null)

providerName - the name of the JCE-compliant provider (may be null)

encoder - the TextEncoder

Returns:

a hash of the given text

Throws:

NoSuchAlgorithmException - NoSuchAlgorithmException

NoSuchProviderException - NoSuchProviderException

hashBytes

public static byte[] hashBytes(byte[] bytes,
                               String algorithm)
                        throws NoSuchAlgorithmException

Hashes the given bytes using the given MessageDigest algorithm.

Parameters:

bytes - the bytes

algorithm - the MessageDigest algorithm

Returns:

a hash of the given bytes

Throws:

NoSuchAlgorithmException - NoSuchAlgorithmException

hashBytes

public static byte[] hashBytes(byte[] bytes,
                               String algorithm,
                               Provider provider,
                               String providerName)
                        throws NoSuchAlgorithmException,
                               NoSuchProviderException

Hashes the given bytes using the given MessageDigest algorithm.

Parameters:

bytes - the bytes

algorithm - the MessageDigest algorithm

provider - the JCE-compliant provider (may be null)

providerName - the name of the JCE-compliant provider (may be null)

Returns:

a hash of the given bytes

Throws:

NoSuchAlgorithmException - NoSuchAlgorithmException

NoSuchProviderException - NoSuchProviderException