com.ibm.crypto.pkcs11impl.provider

Interface PKCS11PrivateKey

All Superinterfaces:

javax.security.auth.Destroyable, java.security.Key, com.ibm.pkcs11.P11Key, PKCS11Key, java.security.PrivateKey, java.io.Serializable

All Known Subinterfaces:

PKCS11DSAPrivateKey, PKCS11RSAPrivateKey

All Known Implementing Classes:

DSAPrivateKey, PKCS11ECPrivateKey, RSAPrivateKey

public interface PKCS11PrivateKey
extends PKCS11Key, java.security.PrivateKey

The interface to a PKCS11 private key, as defined in the PKCS#11 standard

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Method Summary

Modifier and Type	Method and Description
java.lang.Boolean	getAlwaysSensitive() Returns always sensitive
java.lang.Integer	getAuthPinFlags() Returns the auth pin flags
java.lang.Boolean	getDecrypt() Returns decrypt
java.lang.Boolean	getExtractable() Returns if this key can be wrapped by another key
java.lang.Boolean	getNeverExtractable() Returns never extractable
java.lang.Boolean	getSecondaryAuth() Returns secondary auth
java.lang.Boolean	getSensitive() Returns sensitive
java.lang.Boolean	getSign() Returns sign
java.lang.Boolean	getSignRecover() Returns sign recover
byte[]	getSubject() Returns the subject.
java.lang.Boolean	getUnwrap() Returns unwrap
void	setKeyAsToken(boolean token) Sets the token attribute within a Java software key

Methods inherited from interface com.ibm.crypto.pkcs11impl.provider.PKCS11Key

getDerive, getEndDate, getID, getKeyType, getLabel, getLocal, getModifiable, getObject, getPrivate, getSessionManager, getStartDate, getToken, rm

Methods inherited from interface java.security.Key

getAlgorithm, getEncoded, getFormat

Methods inherited from interface javax.security.auth.Destroyable

destroy, isDestroyed

Field Detail

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

Method Detail

getSubject

byte[] getSubject()

Returns the subject.

Returns:

the subject

getSensitive

java.lang.Boolean getSensitive()

Returns sensitive

Returns:

true if sensitive; false otherwise

getSecondaryAuth

java.lang.Boolean getSecondaryAuth()

Returns secondary auth

Returns:

true if the key requires a secondary authentication to take place before its use it allowed.

getAuthPinFlags

java.lang.Integer getAuthPinFlags()

Returns the auth pin flags

Returns:

mask indicating the current state of the secondary authentication PIN.

getDecrypt

java.lang.Boolean getDecrypt()

Returns decrypt

Returns:

true if key supports decryption

getSign

java.lang.Boolean getSign()

Returns sign

Returns:

true if key supports signatures; false otherwise

getSignRecover

java.lang.Boolean getSignRecover()

Returns sign recover

Returns:

true if key supports signatures where the data can be recovered from the signature; false otherwise

getUnwrap

java.lang.Boolean getUnwrap()

Returns unwrap

Returns:

true if key supports unwrapping; false otherwise

getExtractable

java.lang.Boolean getExtractable()

Returns if this key can be wrapped by another key

Returns:

true if key is can be wrapped by another key; false otherwise

getAlwaysSensitive

java.lang.Boolean getAlwaysSensitive()

Returns always sensitive

Returns:

true if key has always had the CKA_SENSITIVE attribute set to TRUE; false otherwise

getNeverExtractable

java.lang.Boolean getNeverExtractable()

Returns never extractable

Returns:

true if key has never had the CKA_EXTRACTABLE attribute set to TRUE; false otherwise

setKeyAsToken

void setKeyAsToken(boolean token)

Sets the token attribute within a Java software key