iaik.pkcs.pkcs11.objects

Class ValuedSecretKey

java.lang.Object

iaik.pkcs.pkcs11.objects.PKCS11Object

iaik.pkcs.pkcs11.objects.Storage

iaik.pkcs.pkcs11.objects.Key

iaik.pkcs.pkcs11.objects.SecretKey

iaik.pkcs.pkcs11.objects.ValuedSecretKey

public class ValuedSecretKey
extends SecretKey

Objects of this class represent secret keys as specified by PKCS#11 v2.11.

Author:

Karl Scheibelhofer, Lijun Liao

Nested Class Summary

Nested classes/interfaces inherited from class iaik.pkcs.pkcs11.objects.Key

Key.KeyType, Key.VendorDefinedKeyBuilder

Nested classes/interfaces inherited from class iaik.pkcs.pkcs11.objects.PKCS11Object

PKCS11Object.ObjectClass, PKCS11Object.VendorDefinedObjectBuilder

Field Summary

Fields

Modifier and Type	Field and Description
protected ByteArrayAttribute	value The value attribute of this secret key.
protected LongAttribute	valueLen The length of this secret key in bytes.

Fields inherited from class iaik.pkcs.pkcs11.objects.SecretKey

alwaysSensitive, checkValue, decrypt, encrypt, extractable, neverExtractable, sensitive, sign, trusted, unwrap, unwrapTemplate, verify, wrap, wrapTemplate, wrapWithTrusted

Fields inherited from class iaik.pkcs.pkcs11.objects.Key

allowedMechanisms, derive, endDate, id, keyGenMechanism, keyType, keyTypeNames, local, startDate

Fields inherited from class iaik.pkcs.pkcs11.objects.Storage

label, modifiable, private_, token

Fields inherited from class iaik.pkcs.pkcs11.objects.PKCS11Object

attributeTable, objectClass, objectClassNames, objectHandle, vendorObjectBuilder

Constructor Summary

Constructors

Modifier	Constructor and Description
	ValuedSecretKey(long keyType) Default Constructor.
protected	ValuedSecretKey(Session session, long objectHandle, long keyType) Called by getInstance to create an instance of a PKCS#11 secret key.

Method Summary

Modifier and Type	Method and Description
protected void	allocateAttributes() Allocates the attribute objects for this class and adds them to the attribute table.
boolean	equals(Object otherObject) Compares all member variables of this object with the other object.
static PKCS11Object	getInstance(Session session, long objectHandle, long keyType) The getInstance method of the SecretKey class uses this method to create an instance of a PKCS#11 AES secret key.
ByteArrayAttribute	getValue() Gets the value attribute of this AES key.
LongAttribute	getValueLen() Gets the value length attribute of this AES key (in bytes).
static ValuedSecretKey	newAESSecretKey()
static ValuedSecretKey	newDES3SecretKey()
static ValuedSecretKey	newGenericSecretKey()
static ValuedSecretKey	newSM4SecretKey(Module module)
protected static void	putAttributesInTable(ValuedSecretKey object) Put all attributes of the given object into the attributes table of this object.
void	readAttributes(Session session) Read the values of the attributes of this object from the token.
String	toString() Returns a string representation of the current object.

Methods inherited from class iaik.pkcs.pkcs11.objects.SecretKey

getAlwaysSensitive, getCheckValue, getDecrypt, getEncrypt, getExtractable, getInstance, getNeverExtractable, getSensitive, getSign, getTrusted, getUnknownSecretKey, getUnwrap, getUnwrapTemplate, getVerify, getWrap, getWrapTemplate, getWrapWithTrusted, putAttributesInTable

Methods inherited from class iaik.pkcs.pkcs11.objects.Key

getAllowedMechanisms, getDerive, getEndDate, getId, getKeyGenMechanism, getKeyType, getKeyTypeName, getLocal, getStartDate, hashCode, putAttributesInTable

Methods inherited from class iaik.pkcs.pkcs11.objects.Storage

getLabel, getModifiable, getPrivate, getToken, putAttributesInTable

Methods inherited from class iaik.pkcs.pkcs11.objects.PKCS11Object

getAttribute, getAttributeTable, getAttributeValue, getAttributeValues, getObjectClass, getObjectClassName, getObjectHandle, getSetAttributes, getSetAttributes, getUnknownObject, getVendorDefinedObjectBuilder, putAttribute, putAttributesInTable, removeAttribute, setObjectHandle, setVendorDefinedObjectBuilder, toString

Methods inherited from class java.lang.Object

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

Field Detail

value

protected ByteArrayAttribute value

The value attribute of this secret key.

valueLen

protected LongAttribute valueLen

The length of this secret key in bytes.

Constructor Detail

ValuedSecretKey

public ValuedSecretKey(long keyType)

Default Constructor.

Parameters:

keyType - The type of the key.

ValuedSecretKey

protected ValuedSecretKey(Session session,
                          long objectHandle,
                          long keyType)
                   throws TokenException

Called by getInstance to create an instance of a PKCS#11 secret key.

Parameters:

session - The session to use for reading attributes. This session must have the appropriate rights; i.e. it must be a user-session, if it is a private object.

objectHandle - The object handle as given from the PKCS#111 module.

keyType - The type of the key.

Throws:

TokenException - If getting the attributes failed.

Method Detail

newAESSecretKey

public static ValuedSecretKey newAESSecretKey()

newDES3SecretKey

public static ValuedSecretKey newDES3SecretKey()

newGenericSecretKey

public static ValuedSecretKey newGenericSecretKey()

newSM4SecretKey

public static ValuedSecretKey newSM4SecretKey(Module module)

getInstance

public static PKCS11Object getInstance(Session session,
                                       long objectHandle,
                                       long keyType)
                                throws TokenException

The getInstance method of the SecretKey class uses this method to create an instance of a PKCS#11 AES secret key.

Parameters:

session - The session to use for reading attributes. This session must have the appropriate rights; i.e. it must be a user-session, if it is a private object.

objectHandle - The object handle as given from the PKCS#111 module.

keyType - The type of the key.

Returns:

The object representing the PKCS#11 object. The returned object can be casted to the according sub-class.

Throws:

TokenException - If getting the attributes failed.

putAttributesInTable

protected static void putAttributesInTable(ValuedSecretKey object)

Put all attributes of the given object into the attributes table of this object. This method is only static to be able to access invoke the implementation of this method for each class separately.

Parameters:

object - The object to handle.

allocateAttributes

protected void allocateAttributes()

Allocates the attribute objects for this class and adds them to the attribute table.

Overrides:

allocateAttributes in class SecretKey

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 SecretKey

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.

getValue

public ByteArrayAttribute getValue()

Gets the value attribute of this AES key.

Returns:

The value attribute.

getValueLen

public LongAttribute getValueLen()

Gets the value length attribute of this AES key (in bytes).

Returns:

The value attribute.

readAttributes

public void readAttributes(Session session)
                    throws TokenException

Read the values of the attributes of this object from the token.

Overrides:

readAttributes in class SecretKey

Parameters:

session - The session to use for reading attributes. This session must have the appropriate rights; i.e. it must be a user-session, if it is a private object.

Throws:

TokenException - If getting the attributes failed.

toString

public String toString()

Returns a string representation of the current object. The output is only for debugging purposes and should not be used for other purposes.

Overrides:

toString in class SecretKey

Returns:

A string presentation of this object for debugging output.