Module com.aoapps.security

Package com.aoapps.security

Enum HashedKey.Algorithm

java.lang.Object

java.lang.Enum<HashedKey.Algorithm>

com.aoapps.security.HashedKey.Algorithm

All Implemented Interfaces:

Serializable, Comparable<HashedKey.Algorithm>

Enclosing class:

HashedKey

public static enum HashedKey.Algorithm
extends Enum<HashedKey.Algorithm>

See MessageDigest Algorithms.

See Also:

• MessageDigest

Enum Constant Summary

Enum Constants

Enum Constant	Description
MD5	Deprecated. MD5 should not be used for any cryptographic purpose.
SHA_1	Deprecated. SHA-1 should no longer be used for any cryptographic purpose.
SHA_224	Deprecated. Collision resistance of at least 128 bits is required
SHA_256
SHA_384
SHA_512
SHA_512_224	Deprecated. Collision resistance of at least 128 bits is required
SHA_512_256
SHA3_224	Deprecated. Collision resistance of at least 128 bits is required
SHA3_256
SHA3_384
SHA3_512

Method Summary

Modifier and Type	Method	Description
static HashedKey.Algorithm	findAlgorithm(String algorithmName)	Case-insensitive lookup by algorithm name.
UnprotectedKey	generateKey()	Generates a random plaintext key of getKeyBytes() bytes in length using a default SecureRandom instance, which is not a strong instance to avoid blocking.
UnprotectedKey	generateKey(SecureRandom secureRandom)	Generates a random plaintext key of getKeyBytes() bytes in length using the provided SecureRandom source.
UnprotectedKey	generateKey(Random random)	Deprecated. Please use SecureRandom.
String	getAlgorithmName()	Gets the MessageDigest algorithm name.
int	getHashBytes()	Gets the number of bytes required to store the generated hash.
int	getKeyBytes()	Gets the number of bytes of cryptographically strong random data that must be used with this algorithm.
byte[]	hash(byte[] key)	Deprecated, for removal: This API element is subject to removal in a future version. Please use hash(com.aoapps.security.Key) instead.
byte[]	hash(Key key)	Hashes the given key.
String	toString()
<Ex extends Throwable> byte[]	validateHash(Function<? super String,Ex> newThrowable, byte[] hash)
<Ex extends Throwable> byte[]	validateKey(Function<? super String,Ex> newThrowable, byte[] key)	Deprecated, for removal: This API element is subject to removal in a future version. Please use validateKey(java.util.function.Function, com.aoapps.security.Key) instead.
<Ex extends Throwable> Key	validateKey(Function<? super String,Ex> newThrowable, Key key)
static HashedKey.Algorithm	valueOf(String name)	Returns the enum constant of this type with the specified name.
static HashedKey.Algorithm[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

MD5

@Deprecated(forRemoval=false)
public static final HashedKey.Algorithm MD5

Deprecated.

MD5 should not be used for any cryptographic purpose.

SHA_1

@Deprecated(forRemoval=false)
public static final HashedKey.Algorithm SHA_1

Deprecated.

SHA-1 should no longer be used for any cryptographic purpose.

SHA-1 is now considered to have at best 65-bits of collision resistance, if using SHA-1 (which you shouldn't) its key size is correspondingly limited to 128 bits. See:

• Why it’s harder to forge a SHA-1 certificate than it is to find a SHA-1 collision
• Attacks on Hash Functions and Applications - PhD Thesis Marc Stevens - Attacks on Hash Functions and Applications.pdf

SHA_224

@Deprecated(forRemoval=false)
public static final HashedKey.Algorithm SHA_224

Deprecated.

Collision resistance of at least 128 bits is required

SHA_256

public static final HashedKey.Algorithm SHA_256

SHA_384

public static final HashedKey.Algorithm SHA_384

SHA_512

public static final HashedKey.Algorithm SHA_512

SHA_512_224

@Deprecated(forRemoval=false)
public static final HashedKey.Algorithm SHA_512_224

Deprecated.

Collision resistance of at least 128 bits is required

SHA_512_256

public static final HashedKey.Algorithm SHA_512_256

SHA3_224

@Deprecated(forRemoval=false)
public static final HashedKey.Algorithm SHA3_224

Deprecated.

Collision resistance of at least 128 bits is required

SHA3_256

public static final HashedKey.Algorithm SHA3_256

SHA3_384

public static final HashedKey.Algorithm SHA3_384

SHA3_512

public static final HashedKey.Algorithm SHA3_512

Method Details

values

public static HashedKey.Algorithm[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static HashedKey.Algorithm valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

findAlgorithm

public static HashedKey.Algorithm findAlgorithm(String algorithmName)
                                         throws IllegalArgumentException

Case-insensitive lookup by algorithm name.

Returns:

The algorithm or null when algorithmName == null

Throws:

IllegalArgumentException - when no enum with the given algorithm name (case-insensitive) is found

toString

public String toString()

Overrides:

toString in class Enum<HashedKey.Algorithm>

getAlgorithmName

public String getAlgorithmName()

Gets the MessageDigest algorithm name.

getKeyBytes

public int getKeyBytes()

Gets the number of bytes of cryptographically strong random data that must be used with this algorithm.

validateKey

public <Ex extends Throwable> Key validateKey(Function<? super String,Ex> newThrowable,
 Key key)
                                       throws Ex

Type Parameters:

Ex - An arbitrary exception type that may be thrown

Parameters:

key - Is destroyed when invalid

Throws:

Ex

validateKey

@Deprecated(forRemoval=true)
public <Ex extends Throwable> byte[] validateKey(Function<? super String,Ex> newThrowable,
 byte[] key)
                                          throws Ex

Deprecated, for removal: This API element is subject to removal in a future version.

Please use validateKey(java.util.function.Function, com.aoapps.security.Key) instead.

Type Parameters:

Ex - An arbitrary exception type that may be thrown

Parameters:

key - Is not zeroed

Throws:

Ex

generateKey

@Deprecated(forRemoval=false)
public UnprotectedKey generateKey(Random random)

Deprecated.

Please use SecureRandom. This method will stay, but will remain deprecated since it should only be used after careful consideration.

Generates a random plaintext key of getKeyBytes() bytes in length using the provided Random source.

See Also:

• hash(com.aoapps.security.Key)

generateKey

public UnprotectedKey generateKey(SecureRandom secureRandom)

Generates a random plaintext key of getKeyBytes() bytes in length using the provided SecureRandom source.

See Also:

• hash(com.aoapps.security.Key)

generateKey

public UnprotectedKey generateKey()

Generates a random plaintext key of getKeyBytes() bytes in length using a default SecureRandom instance, which is not a strong instance to avoid blocking.

See Also:

• hash(com.aoapps.security.Key)

getHashBytes

public int getHashBytes()

Gets the number of bytes required to store the generated hash.

validateHash

public <Ex extends Throwable> byte[] validateHash(Function<? super String,Ex> newThrowable,
 byte[] hash)
                                           throws Ex

Type Parameters:

Ex - An arbitrary exception type that may be thrown

Throws:

Ex

hash

public byte[] hash(Key key)

Hashes the given key.

Parameters:

key - Is destroyed before this method returns. If the original key is needed, pass a clone to this method.

See Also:

• generateKey()

hash

@Deprecated(forRemoval=true)
public byte[] hash(byte[] key)

Deprecated, for removal: This API element is subject to removal in a future version.

Please use hash(com.aoapps.security.Key) instead.

Hashes the given key.

Parameters:

key - Is not zeroed

See Also:

• generateKey()