com.yubico.yubikit.oath

Enum HashAlgorithm

java.lang.Object

java.lang.Enum<HashAlgorithm>

com.yubico.yubikit.oath.HashAlgorithm

All Implemented Interfaces:

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

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

Types of hash algorithms that can be used for TOTP using YubiKey OATH

Enum Constant Summary

Enum Constants

Enum Constant and Description
SHA1
SHA256
SHA512

Field Summary

Fields

Modifier and Type	Field and Description
int	blockSize
static int	MIN_KEY_SIZE
byte	value

Method Summary

Modifier and Type	Method and Description
static HashAlgorithm	fromString(java.lang.String value)
static HashAlgorithm	fromValue(byte value)
byte[]	prepareKey(byte[] key)
static HashAlgorithm	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static HashAlgorithm[]	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

SHA1

public static final HashAlgorithm SHA1

SHA256

public static final HashAlgorithm SHA256

SHA512

public static final HashAlgorithm SHA512

Field Detail

MIN_KEY_SIZE

public static int MIN_KEY_SIZE

value

public final byte value

blockSize

public final int blockSize

Method Detail

values

public static HashAlgorithm[] 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 (HashAlgorithm c : HashAlgorithm.values())
    System.out.println(c);

Returns:

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

valueOf

public static HashAlgorithm 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

prepareKey

public byte[] prepareKey(byte[] key)
                  throws java.security.NoSuchAlgorithmException

Throws:

java.security.NoSuchAlgorithmException

fromValue

public static HashAlgorithm fromValue(byte value)

fromString

public static HashAlgorithm fromString(java.lang.String value)