|
IAIK PKCS#11 Wrapper version 1.2.16 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectiaik.pkcs.pkcs11.objects.Object
iaik.pkcs.pkcs11.objects.Storage
iaik.pkcs.pkcs11.objects.Key
iaik.pkcs.pkcs11.objects.SecretKey
This is the base class for secret (symmetric) keys. Objects of this class represent secret keys as specified by PKCS#11 v2.11.
Nested Class Summary |
Nested classes inherited from class iaik.pkcs.pkcs11.objects.Key |
Key.KeyType, Key.VendorDefinedKeyBuilder |
Nested classes inherited from class iaik.pkcs.pkcs11.objects.Object |
Object.ObjectClass, Object.VendorDefinedObjectBuilder |
Field Summary | |
protected BooleanAttribute |
alwaysSensitive_
True, if this key was always sensitive. |
protected BooleanAttribute |
decrypt_
True, if this key can be used for decryption. |
protected BooleanAttribute |
encrypt_
True, if this key can be used for encryption. |
protected BooleanAttribute |
extractable_
True, if this key is extractable from the token. |
protected BooleanAttribute |
neverExtractable_
True, if this key was never extractable. |
protected BooleanAttribute |
sensitive_
True, if this key is sensitive. |
protected BooleanAttribute |
sign_
True, if this key can be used for signing. |
protected BooleanAttribute |
unwrap_
True, if this key can be used for unwrapping other keys. |
protected BooleanAttribute |
verify_
True, if this key can be used for verification. |
protected BooleanAttribute |
wrap_
True, if this key can be used for wrapping other keys. |
Fields inherited from class iaik.pkcs.pkcs11.objects.Key |
derive_, endDate_, id_, keyGenMechanism_, keyType_, keyTypeNames_, local_, startDate_, vendorKeyBuilder_ |
Fields inherited from class iaik.pkcs.pkcs11.objects.Storage |
label_, modifiable_, private_, token_ |
Fields inherited from class iaik.pkcs.pkcs11.objects.Object |
attributeTable_, objectClass_, objectClassNames_, objectHandle_, vendorObjectBuilder_ |
Constructor Summary | |
|
SecretKey()
Deafult Constructor. |
protected |
SecretKey(Session session,
long objectHandle)
Called by sub-classes to create an instance of a PKCS#11 secret key. |
Method Summary | |
protected void |
allocateAttributes()
Allocates the attribute objects for this class and adds them to the attribute table. |
Object |
clone()
Create a (deep) clone of this object. |
boolean |
equals(Object otherObject)
Compares all member variables of this object with the other object. |
BooleanAttribute |
getAlwaysSensitive()
Gets the always sensitive attribute of this key. |
BooleanAttribute |
getDecrypt()
Gets the decrypt attribute of this key. |
BooleanAttribute |
getEncrypt()
Gets the encrypt attribute of this key. |
BooleanAttribute |
getExtractable()
Gets the extractable attribute of this key. |
static Object |
getInstance(Session session,
long objectHandle)
The getInstance method of the Object class uses this method to create an instance of a PKCS#11 secret key. |
BooleanAttribute |
getNeverExtractable()
Gets the never extractable attribute of this key. |
BooleanAttribute |
getSensitive()
Gets the sensitive attribute of this key. |
BooleanAttribute |
getSign()
Gets the sign attribute of this key. |
protected static Object |
getUnknownSecretKey(Session session,
long objectHandle)
Try to create a key which has no or an unkown secret key type type attribute. |
BooleanAttribute |
getUnwrap()
Gets the unwrap attribute of this key. |
BooleanAttribute |
getVerify()
Gets the verify attribute of this key. |
BooleanAttribute |
getWrap()
Gets the wrap attribute of this key. |
protected static void |
putAttributesInTable(SecretKey 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()
This method returns a string representation of the current object. |
Methods inherited from class iaik.pkcs.pkcs11.objects.Key |
getDerive, getEndDate, getId, getKeyGenMechanism, getKeyType, getKeyTypeName, getLocal, getStartDate, getVendorDefinedKeyBuilder, hashCode, putAttributesInTable, setVendorDefinedKeyBuilder |
Methods inherited from class iaik.pkcs.pkcs11.objects.Storage |
getLabel, getModifiable, getPrivate, getToken, putAttributesInTable |
Methods inherited from class iaik.pkcs.pkcs11.objects.Object |
getAttributeTable, getAttributeValue, getObjectClass, getObjectClassName, getObjectHandle, getSetAttributes, getSetAttributes, getUnknownObject, getVendorDefinedObjectBuilder, putAttributesInTable, setObjectHandle, setVendorDefinedObjectBuilder |
Methods inherited from class java.lang.Object |
finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
protected BooleanAttribute sensitive_
protected BooleanAttribute encrypt_
protected BooleanAttribute decrypt_
protected BooleanAttribute sign_
protected BooleanAttribute verify_
protected BooleanAttribute wrap_
protected BooleanAttribute unwrap_
protected BooleanAttribute extractable_
protected BooleanAttribute alwaysSensitive_
protected BooleanAttribute neverExtractable_
Constructor Detail |
public SecretKey()
protected SecretKey(Session session, long objectHandle) throws TokenException
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.
TokenException
- If getting the attributes failed.Method Detail |
public static Object getInstance(Session session, long objectHandle) throws TokenException
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.
TokenException
- If getting the attributes failed.protected static Object getUnknownSecretKey(Session session, long objectHandle) throws TokenException
SecretKey
.
session
- The session to use.objectHandle
- The handle of the object
TokenException
- If no object could be created.protected static void putAttributesInTable(SecretKey object)
object
- The object to handle.protected void allocateAttributes()
allocateAttributes
in class Key
public Object clone()
clone
in class Key
public boolean equals(Object otherObject)
equals
in class Key
otherObject
- The other object to compare to.
public BooleanAttribute getSensitive()
public BooleanAttribute getEncrypt()
public BooleanAttribute getVerify()
public BooleanAttribute getDecrypt()
public BooleanAttribute getSign()
public BooleanAttribute getWrap()
public BooleanAttribute getUnwrap()
public BooleanAttribute getExtractable()
public BooleanAttribute getAlwaysSensitive()
public BooleanAttribute getNeverExtractable()
public void readAttributes(Session session) throws TokenException
readAttributes
in class Key
session
- The session handle 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.
TokenException
- If getting the attributes failed.public String toString()
toString
in class Key
|
IAIK PKCS#11 Wrapper version 1.2.16 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |