org.linguafranca.pwdb.security

Enum Encryption.KeyDerivationFunction

java.lang.Object

java.lang.Enum<Encryption.KeyDerivationFunction>

org.linguafranca.pwdb.security.Encryption.KeyDerivationFunction

All Implemented Interfaces:

Serializable, Comparable<Encryption.KeyDerivationFunction>, KeyDerivationFunction

Enclosing class:

Encryption

public static enum Encryption.KeyDerivationFunction
extends Enum<Encryption.KeyDerivationFunction>
implements KeyDerivationFunction

A list of functions that we can use to transform keys Enum constants forward to underlying implementation.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AES
ARGON2

Method Summary

Modifier and Type	Method and Description
VariantDictionary	createKdfParameters() Create default KDF parameters
static KeyDerivationFunction	getKdf(UUID kdfUuid) Find a KDF that matches this Uuid
UUID	getKdfUuid() The UUID of this key derivation function
String	getName() Get a name
byte[]	getTransformedKey(byte[] key, VariantDictionary transformParams) Transform a key using this key derivation function
static Encryption.KeyDerivationFunction	valueOf(String name) Returns the enum constant of this type with the specified name.
static Encryption.KeyDerivationFunction[]	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

AES

public static final Encryption.KeyDerivationFunction AES

ARGON2

public static final Encryption.KeyDerivationFunction ARGON2

Method Detail

values

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

Returns:

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

valueOf

public static Encryption.KeyDerivationFunction 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

getKdf

public static KeyDerivationFunction getKdf(UUID kdfUuid)

Find a KDF that matches this Uuid

Parameters:

kdfUuid - the Uuid to match

Throws:

IllegalArgumentException - if the Uuid is not known

getKdfUuid

public UUID getKdfUuid()

Description copied from interface: KeyDerivationFunction

The UUID of this key derivation function

Specified by:

getKdfUuid in interface KeyDerivationFunction

getTransformedKey

public byte[] getTransformedKey(byte[] key,
                                VariantDictionary transformParams)

Description copied from interface: KeyDerivationFunction

Transform a key using this key derivation function

Specified by:

getTransformedKey in interface KeyDerivationFunction

Parameters:

key - the key to transform

transformParams - the parameters defining the way the transformation is to be carried out

Returns:

a transformed key

createKdfParameters

public VariantDictionary createKdfParameters()

Description copied from interface: KeyDerivationFunction

Create default KDF parameters

Specified by:

createKdfParameters in interface KeyDerivationFunction

getName

public String getName()

Description copied from interface: KeyDerivationFunction

Get a name

Specified by:

getName in interface KeyDerivationFunction