iaik.pkcs.pkcs11.parameters

Class PKCS5PBKD2Parameters

java.lang.Object

iaik.pkcs.pkcs11.parameters.PKCS5PBKD2Parameters

All Implemented Interfaces:

Parameters

public class PKCS5PBKD2Parameters
extends Object
implements Parameters

This class encapsulates parameters for the Mechanism.PKCS5_PKKD2 mechanism.

Version:

1.0

Author:

Karl Scheibelhofer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PKCS5PBKD2Parameters.PseudoRandomFunctionType This interface defines the available pseudo-random function types as defined by PKCS#11: CKP_PKCS5_PBKD2_HMAC_SHA1.
static interface	PKCS5PBKD2Parameters.SaltSourceType This interface defines the available sources of the salt value as defined by PKCS#11: CKZ_SALT_SPECIFIED.

Field Summary

Fields

Modifier and Type	Field and Description
protected long	iterations The number of iterations to perform when generating each block of random data.
protected long	pseudoRandomFunction The pseudo-random function (PRF) to used to generate the key.
protected byte[]	pseudoRandomFunctionData The data used as the input for PRF in addition to the salt value.
protected long	saltSource The source of the salt value.
protected byte[]	saltSourceData The data used as the input for the salt source.

Constructor Summary

Constructors

Constructor and Description
PKCS5PBKD2Parameters(long saltSource, byte[] saltSourceData, long iterations, long pseudoRandomFunction, byte[] pseudoRandomFunctionData) Create a new PBEDeriveParameters object with the given attributes.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object otherObject) Compares all member variables of this object with the other object.
long	getIterations() Get the number of iterations to perform when generating each block of random data.
sun.security.pkcs11.wrapper.CK_PKCS5_PBKD2_PARAMS	getPKCS11ParamsObject() Get this parameters object as an object of the CK_PKCS5_PBKD2_PARAMS class.
long	getPseudoRandomFunction() Get the pseudo-random function (PRF) to used to generate the key.
byte[]	getPseudoRandomFunctionData() Get the data used as the input for PRF in addition to the salt value.
long	getSaltSource() Get the source of the salt value.
byte[]	getSaltSourceData() Get the data used as the input for the salt source.
int	hashCode() The overriding of this method should ensure that the objects of this class work correctly in a hashtable.
void	setIterations(long iterations) Set the number of iterations to perform when generating each block of random data.
void	setPseudoRandomFunction(long pseudoRandomFunction) Set the pseudo-random function (PRF) to used to generate the key.
void	setPseudoRandomFunctionData(byte[] pseudoRandomFunctionData) Set the data used as the input for PRF in addition to the salt value.
void	setSaltSource(long saltSource) Set the source of the salt value.
void	setSaltSourceData(byte[] saltSourceData) Set the data used as the input for the salt source.
String	toString() Returns the string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

saltSource

protected long saltSource

The source of the salt value.

saltSourceData

protected byte[] saltSourceData

The data used as the input for the salt source.

iterations

protected long iterations

The number of iterations to perform when generating each block of random data.

pseudoRandomFunction

protected long pseudoRandomFunction

The pseudo-random function (PRF) to used to generate the key.

pseudoRandomFunctionData

protected byte[] pseudoRandomFunctionData

The data used as the input for PRF in addition to the salt value.

Constructor Detail

PKCS5PBKD2Parameters

public PKCS5PBKD2Parameters(long saltSource,
                            byte[] saltSourceData,
                            long iterations,
                            long pseudoRandomFunction,
                            byte[] pseudoRandomFunctionData)

Create a new PBEDeriveParameters object with the given attributes.

Parameters:

saltSource - The source of the salt value. One of the constants defined in the SaltSourceType interface.

saltSourceData - The data used as the input for the salt source.

iterations - The number of iterations to perform when generating each block of random data.

pseudoRandomFunction - The pseudo-random function (PRF) to used to generate the key. One of the constants defined in the PseudoRandomFunctionType interface.

pseudoRandomFunctionData - The data used as the input for PRF in addition to the salt value.

Method Detail

getPKCS11ParamsObject

public sun.security.pkcs11.wrapper.CK_PKCS5_PBKD2_PARAMS getPKCS11ParamsObject()

Get this parameters object as an object of the CK_PKCS5_PBKD2_PARAMS class.

Specified by:

getPKCS11ParamsObject in interface Parameters

Returns:

This object as a CK_PKCS5_PBKD2_PARAMS object.

getSaltSource

public long getSaltSource()

Get the source of the salt value.

Returns:

The source of the salt value.

getSaltSourceData

public byte[] getSaltSourceData()

Get the data used as the input for the salt source.

Returns:

data used as the input for the salt source.

getIterations

public long getIterations()

Get the number of iterations to perform when generating each block of random data.

Returns:

The number of iterations to perform when generating each block of random data.

getPseudoRandomFunction

public long getPseudoRandomFunction()

Get the pseudo-random function (PRF) to used to generate the key.

Returns:

The pseudo-random function (PRF) to used to generate the key.

getPseudoRandomFunctionData

public byte[] getPseudoRandomFunctionData()

Get the data used as the input for PRF in addition to the salt value.

Returns:

The data used as the input for PRF in addition to the salt value.

setSaltSource

public void setSaltSource(long saltSource)

Set the source of the salt value.

Parameters:

saltSource - The source of the salt value. One of the constants defined in the SaltSourceType interface

setSaltSourceData

public void setSaltSourceData(byte[] saltSourceData)

Set the data used as the input for the salt source.

Parameters:

saltSourceData - The data used as the input for the salt source.

setIterations

public void setIterations(long iterations)

Set the number of iterations to perform when generating each block of random data.

Parameters:

iterations - The number of iterations to perform when generating each block of random data.

setPseudoRandomFunction

public void setPseudoRandomFunction(long pseudoRandomFunction)

Set the pseudo-random function (PRF) to used to generate the key.

Parameters:

pseudoRandomFunction - The pseudo-random function (PRF) to used to generate the key. One of the constants defined in the PseudoRandomFunctionType interface.

setPseudoRandomFunctionData

public void setPseudoRandomFunctionData(byte[] pseudoRandomFunctionData)

Set the data used as the input for PRF in addition to the salt value.

Parameters:

pseudoRandomFunctionData - The data used as the input for PRF in addition to the salt value.

toString

public String toString()

Returns the string representation of this object. Do not parse data from this string, it is for debugging only.

Overrides:

toString in class Object

Returns:

A string representation of this object.

equals

public boolean equals(Object otherObject)

Compares all member variables of this object with the other object. Returns only true, if all are equal in both objects.

Overrides:

equals in class Object

Parameters:

otherObject - The other object to compare to.

Returns:

True, if other is an instance of this class and all member variables of both objects are equal. False, otherwise.

hashCode

public int hashCode()

The overriding of this method should ensure that the objects of this class work correctly in a hashtable.

Overrides:

hashCode in class Object

Returns:

The hash code of this object.