com.ibm.crypto.pkcs11impl.provider

Interface PKCS11Key

All Superinterfaces:

java.security.Key, com.ibm.pkcs11.P11Key, java.io.Serializable

All Known Subinterfaces:

GeneralPKCS11Key, PKCS11DESedeKey, PKCS11DESKey, PKCS11DSAPrivateKey, PKCS11DSAPublicKey, PKCS11PrivateKey, PKCS11PublicKey, PKCS11RSAPrivateKey, PKCS11RSAPublicKey, PKCS11SecretKey

All Known Implementing Classes:

DSAPrivateKey, DSAPublicKey, GeneralKey, PKCS11ECPrivateKey, PKCS11ECPublicKey, RSAPrivateKey, RSAPublicKey

public interface PKCS11Key
extends com.ibm.pkcs11.P11Key

A PKCS11 key. This interface contains no methods or constants. It merely serves to group (and provide type safety for) all PKCS11 key interfaces.

See Also:

Key

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Method Summary

Modifier and Type	Method and Description
java.lang.Boolean	getDerive() Returns true if key supports key derivation
java.util.Date	getEndDate() Returns the end date
byte[]	getID() Returns the ID
java.lang.Integer	getKeyType() Returns the key type
java.lang.String	getLabel() Returns label
java.lang.Boolean	getLocal() Returns true if key was either: 1, generated locally with a C_GenerateKey or C_GenerateKeyPair call 2, created with a C_CopyObject call as a copy of a key which had its CKA_LOCAL attrobute set to TRUE
java.lang.Boolean	getModifiable() Returns modifiable
com.ibm.pkcs11.PKCS11Object	getObject() Returns the key object
java.lang.Boolean	getPrivate() Returns private
SessionManager	getSessionManager() Returns the session manager associated with the key
java.util.Date	getStartDate() Returns the start date
java.lang.Boolean	getToken() Returns token
void	rm() Returns void removes the key

Methods inherited from interface java.security.Key

getAlgorithm, getEncoded, getFormat

Field Detail

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

Method Detail

getSessionManager

SessionManager getSessionManager()

Returns the session manager associated with the key

Returns:

the session manager associated with the key

getObject

com.ibm.pkcs11.PKCS11Object getObject()

Returns the key object

Specified by:

getObject in interface com.ibm.pkcs11.P11Key

Returns:

the key object

getToken

java.lang.Boolean getToken()

Returns token

Specified by:

getToken in interface com.ibm.pkcs11.P11Key

Returns:

true if object is a token object; false if object is a session object

rm

void rm()

Returns void removes the key

Specified by:

rm in interface com.ibm.pkcs11.P11Key

getPrivate

java.lang.Boolean getPrivate()

Returns private

Specified by:

getPrivate in interface com.ibm.pkcs11.P11Key

Returns:

true if object is a private object; false if object is a public object.

getLabel

java.lang.String getLabel()

Returns label

Specified by:

getLabel in interface com.ibm.pkcs11.P11Key

Returns:

the description of the object

getModifiable

java.lang.Boolean getModifiable()

Returns modifiable

Specified by:

getModifiable in interface com.ibm.pkcs11.P11Key

Returns:

true if object can be modified; false otherwise

getKeyType

java.lang.Integer getKeyType()

Returns the key type

Specified by:

getKeyType in interface com.ibm.pkcs11.P11Key

Returns:

the key type

getID

byte[] getID()

Returns the ID

Specified by:

getID in interface com.ibm.pkcs11.P11Key

Returns:

the ID

getStartDate

java.util.Date getStartDate()

Returns the start date

Specified by:

getStartDate in interface com.ibm.pkcs11.P11Key

Returns:

the start date

getEndDate

java.util.Date getEndDate()

Returns the end date

Specified by:

getEndDate in interface com.ibm.pkcs11.P11Key

Returns:

the end date

getDerive

java.lang.Boolean getDerive()

Returns true if key supports key derivation

Specified by:

getDerive in interface com.ibm.pkcs11.P11Key

Returns:

true if key supports key derivation; false otherwise

getLocal

java.lang.Boolean getLocal()

Returns true if key was either: 1, generated locally with a C_GenerateKey or C_GenerateKeyPair call 2, created with a C_CopyObject call as a copy of a key which had its CKA_LOCAL attrobute set to TRUE

Specified by:

getLocal in interface com.ibm.pkcs11.P11Key

Returns:

true if key was either generated locally or created as a copy of a key which had its CKA_local sttribute set to TRUE