com.peterphi.std.crypto.digest

Enum DigestAlgorithm

java.lang.Object

java.lang.Enum<DigestAlgorithm>

com.peterphi.std.crypto.digest.DigestAlgorithm

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<DigestAlgorithm>

public enum DigestAlgorithm
extends java.lang.Enum<DigestAlgorithm>

A number of different types of digest algorithm

Enum Constant Summary

Enum Constants

Enum Constant and Description
CRC32 CRC-32 (a hexidecimal-encoded CRC-32 produced using the java.util.zip CRC32 class)
LENGTH Length (an algorithm which takes the length of the data, in decimal, as its digest)
MD2 http://en.wikipedia.org/wiki/MD2_(cryptography)
MD5 http://en.wikipedia.org/wiki/MD5
SHA1 http://en.wikipedia.org/wiki/SHA1
SHA256 SHA-256
SHA512 SHA-512

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.Comparator<DigestAlgorithm>	COMPARE The comparator to use when comparing algorithms ignoring their relative cryptographic security
static java.util.Comparator<DigestAlgorithm>	COMPARE_PREFER_SECURE The comparator to use when comparing algorithms & preferring secure algorithms (will usually be the same as the default comparator, but preferring algorithms marked cryptographically secure)

Method Summary

Methods

Modifier and Type	Method and Description
static DigestAlgorithm	getBest(boolean prioritiseSecure, DigestAlgorithm... algorithms) Determines the best algorithm from a list of choices
static DigestAlgorithm	getBest(boolean prioritiseSecure, java.lang.Iterable<DigestAlgorithm> algorithms) Determines the "best" algorithm from a list of choices
IDigester	getImplementation() Retrieves the implementation of this algorithm
int	getPriority()
boolean	isAvailable() Determines whether this algorithm is available for use
boolean	isBlacklisted() Determines whether this algorithm has been blacklisted. Blacklisted algorithms must not be used
boolean	isCryptographicallySecure()
void	setDefaultImplementation(IDigester digester) Set the default implementation for an algorithm; this will be used if no other implementations are registered
void	setImplementation(IDigester digester) Set a new implementation
void	setImplementation(IDigester digester, int implPriority) Set the implementation, permitted that no other implementations have attempted to register with a higher priority
static DigestAlgorithm	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static DigestAlgorithm[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

LENGTH

public static final DigestAlgorithm LENGTH

Length (an algorithm which takes the length of the data, in decimal, as its digest)

CRC32

public static final DigestAlgorithm CRC32

CRC-32 (a hexidecimal-encoded CRC-32 produced using the java.util.zip CRC32 class)

MD2

public static final DigestAlgorithm MD2

http://en.wikipedia.org/wiki/MD2_(cryptography)

MD5

public static final DigestAlgorithm MD5

http://en.wikipedia.org/wiki/MD5

SHA1

public static final DigestAlgorithm SHA1

http://en.wikipedia.org/wiki/SHA1

SHA256

public static final DigestAlgorithm SHA256

SHA-256

SHA512

public static final DigestAlgorithm SHA512

SHA-512

Field Detail

COMPARE

public static final java.util.Comparator<DigestAlgorithm> COMPARE

The comparator to use when comparing algorithms ignoring their relative cryptographic security

COMPARE_PREFER_SECURE

public static final java.util.Comparator<DigestAlgorithm> COMPARE_PREFER_SECURE

The comparator to use when comparing algorithms & preferring secure algorithms (will usually be the same as the default comparator, but preferring algorithms marked cryptographically secure)

Method Detail

values

public static DigestAlgorithm[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (DigestAlgorithm c : DigestAlgorithm.values())
    System.out.println(c);

Returns:

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

valueOf

public static DigestAlgorithm valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

isCryptographicallySecure

public boolean isCryptographicallySecure()

getPriority

public int getPriority()

isBlacklisted

public boolean isBlacklisted()

Determines whether this algorithm has been blacklisted.
Blacklisted algorithms must not be used

Returns:

isAvailable

public boolean isAvailable()

Determines whether this algorithm is available for use

Returns:

setDefaultImplementation

public void setDefaultImplementation(IDigester digester)

Set the default implementation for an algorithm; this will be used if no other implementations are registered

Parameters:

digester -

setImplementation

public void setImplementation(IDigester digester,
                     int implPriority)

Set the implementation, permitted that no other implementations have attempted to register with a higher priority

Parameters:

digester -

setImplementation

public void setImplementation(IDigester digester)

Set a new implementation

Parameters:

digester -

getImplementation

public IDigester getImplementation()

Retrieves the implementation of this algorithm

Returns:

getBest

public static DigestAlgorithm getBest(boolean prioritiseSecure,
                      DigestAlgorithm... algorithms)

Determines the best algorithm from a list of choices

Parameters:

prioritiseSecure - if true, cryptographically secure algorithms will be prioritised

algorithms - The algorithms

Returns:

The best algorithm (or null if no algorithm was specified)

getBest

public static DigestAlgorithm getBest(boolean prioritiseSecure,
                      java.lang.Iterable<DigestAlgorithm> algorithms)

Determines the "best" algorithm from a list of choices

Parameters:

prioritiseSecure - if true, cryptographically secure algorithms will be prioritised

algorithms - The algorithms

Returns:

The best algorithm (or null if no algorithm was specified)