|
IAIK PKCS#11 Wrapper version 1.2.17 |
||||||||||
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.PrivateKey
This is the base class for private (asymmetric) keys. Objects of this class represent private 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 |
alwaysAuthenticate_
True, if the user has to supply the PIN for each use (sign or decrypt) with the key. |
protected BooleanAttribute |
alwaysSensitive_
True, if this private key was always sensitive. |
protected LongAttribute |
authPinFlags_
The authentication flags for secondary authentication. |
protected BooleanAttribute |
decrypt_
True, if this private key can be used for encryption. |
protected BooleanAttribute |
extractable_
True, if this private key can not be extracted from the token. |
protected BooleanAttribute |
neverExtractable_
True, if this private key was never extractable. |
protected BooleanAttribute |
secondaryAuth_
True, if this private key supports secondary authentication. |
protected BooleanAttribute |
sensitive_
True, if this private key is sensitive. |
protected BooleanAttribute |
sign_
True, if this private key can be used for signing. |
protected BooleanAttribute |
signRecover_
True, if this private key can be used for signing with recover. |
protected ByteArrayAttribute |
subject_
The subject of this private key. |
protected BooleanAttribute |
unwrap_
True, if this private key can be used for unwrapping wrapped keys. |
protected AttributeArray |
unwrapTemplate_
Template of the key, that can be unwrapped. |
protected BooleanAttribute |
wrapWithTrusted_
True, if this private key can only be wrapped with a wrapping key having set the attribute trusted to true. |
Fields inherited from class iaik.pkcs.pkcs11.objects.Key |
allowedMechanisms_, 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 | |
|
PrivateKey()
Default Constructor. |
protected |
PrivateKey(Session session,
long objectHandle)
Called by sub-classes to create an instance of a PKCS#11 private 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 |
getAlwaysAuthenticate()
Gets the always authenticate attribute of this key. |
BooleanAttribute |
getAlwaysSensitive()
Gets the always sensitive attribute of this key. |
LongAttribute |
getAuthPinFlags()
Gets the authentication flags for secondary authentication of this key. |
BooleanAttribute |
getDecrypt()
Gets the decrypt 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 private key. |
BooleanAttribute |
getNeverExtractable()
Gets the never extractable attribute of this key. |
BooleanAttribute |
getSecondaryAuth()
Gets the secondary authentication attribute of this key. |
BooleanAttribute |
getSensitive()
Gets the sensitive attribute of this key. |
BooleanAttribute |
getSign()
Gets the sign attribute of this key. |
BooleanAttribute |
getSignRecover()
Gets the sign recover attribute of this key. |
ByteArrayAttribute |
getSubject()
Gets the subject attribute of this key. |
protected static Object |
getUnknownPrivateKey(Session session,
long objectHandle)
Try to create a key which has no or an unkown private key type type attribute. |
BooleanAttribute |
getUnwrap()
Gets the unwrap attribute of this key. |
AttributeArray |
getUnwrapTemplate()
Gets the unwrap template attribute of this key. |
BooleanAttribute |
getWrapWithTrusted()
Gets the wrap with trusted attribute of this key. |
protected static void |
putAttributesInTable(PrivateKey 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 |
getAllowedMechanisms, 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, getAttributeValues, 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 ByteArrayAttribute subject_
protected BooleanAttribute sensitive_
protected BooleanAttribute secondaryAuth_
protected LongAttribute authPinFlags_
protected BooleanAttribute decrypt_
protected BooleanAttribute sign_
protected BooleanAttribute signRecover_
protected BooleanAttribute unwrap_
protected BooleanAttribute extractable_
protected BooleanAttribute alwaysSensitive_
protected BooleanAttribute neverExtractable_
protected BooleanAttribute wrapWithTrusted_
protected AttributeArray unwrapTemplate_
protected BooleanAttribute alwaysAuthenticate_
Constructor Detail |
public PrivateKey()
protected PrivateKey(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 getUnknownPrivateKey(Session session, long objectHandle) throws TokenException
PrivateKey
.
session
- The session to use.objectHandle
- The handle of the object
TokenException
- If no object could be created.protected static void putAttributesInTable(PrivateKey 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 ByteArrayAttribute getSubject()
public BooleanAttribute getSensitive()
public BooleanAttribute getSecondaryAuth()
public LongAttribute getAuthPinFlags()
public BooleanAttribute getDecrypt()
public BooleanAttribute getSign()
public BooleanAttribute getSignRecover()
public BooleanAttribute getUnwrap()
public BooleanAttribute getExtractable()
public BooleanAttribute getAlwaysSensitive()
public BooleanAttribute getNeverExtractable()
public BooleanAttribute getWrapWithTrusted()
public AttributeArray getUnwrapTemplate()
public BooleanAttribute getAlwaysAuthenticate()
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.17 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |