org.apache.xml.security.encryption.params

Class KeyDerivationParameters

java.lang.Object

org.apache.xml.security.encryption.params.KeyDerivationParameters

Direct Known Subclasses:

ConcatKDFParams, HKDFParams

public abstract class KeyDerivationParameters
extends Object

Abstract key derivation class contains the basic parameters used for the key derivation. The class should be extended to provide algorithm specific parameters.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	KeyDerivationParameters(String algorithm, int keyLength)

Method Summary

Modifier and Type	Method and Description
String	getAlgorithm()
int	getKeyBitLength() The length of the derived key in bits.
int	getKeyLength() The length of the derived key in bytes needed to store the key in bitSize.

Methods inherited from class java.lang.Object

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

Constructor Detail

KeyDerivationParameters

protected KeyDerivationParameters(String algorithm,
                                  int keyLength)

Method Detail

getAlgorithm

public String getAlgorithm()

getKeyBitLength

public int getKeyBitLength()

The length of the derived key in bits.

Returns:

getKeyLength

public int getKeyLength()

The length of the derived key in bytes needed to store the key in bitSize. For example: if the key is 9 bits long, the length of the key in bytes is 2, but the key is stored in 8 bits the length in bytes is 1.

Returns:

the length of the derived key in bytes