Package com.yubico.yubikit.piv.jca

Class PivPrivateKey

java.lang.Object

com.yubico.yubikit.piv.jca.PivPrivateKey

All Implemented Interfaces:

Serializable, Key, PrivateKey, Destroyable

public abstract class PivPrivateKey
extends Object
implements PrivateKey, Destroyable

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected char @Nullable []	pin

Fields inherited from interface java.security.PrivateKey

serialVersionUID

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PivPrivateKey(Slot slot, KeyType keyType, @Nullable PinPolicy pinPolicy, @Nullable TouchPolicy touchPolicy, char @Nullable [] pin)

Method Summary

Modifier and Type	Method	Description
void	destroy()
String	getAlgorithm()
byte @Nullable []	getEncoded()
@Nullable String	getFormat()
@Nullable PinPolicy	getPinPolicy()	Get the PIN policy of the key, if available.
Slot	getSlot()	Get the PIV slot where the private key is stored.
@Nullable TouchPolicy	getTouchPolicy()	Get the Touch policy of the key, if available.
boolean	isDestroyed()
void	setPin(char @Nullable [] pin)	Sets the PIN to use when performing key operations with this private key, or to null.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

pin

protected char @Nullable [] pin

Constructor Details

PivPrivateKey

protected PivPrivateKey(Slot slot,
 KeyType keyType,
 @Nullable PinPolicy pinPolicy,
 @Nullable TouchPolicy touchPolicy,
 char @Nullable [] pin)

Method Details

getSlot

public Slot getSlot()

Get the PIV slot where the private key is stored.

getPinPolicy

public @Nullable PinPolicy getPinPolicy()

Get the PIN policy of the key, if available.

getTouchPolicy

public @Nullable TouchPolicy getTouchPolicy()

Get the Touch policy of the key, if available.

setPin

public void setPin(char @Nullable [] pin)

Sets the PIN to use when performing key operations with this private key, or to null. Note that a copy is made of the PIN, which can be cleared out by calling destroy().

destroy

public void destroy()

Specified by:

destroy in interface Destroyable

isDestroyed

public boolean isDestroyed()

Specified by:

isDestroyed in interface Destroyable

getAlgorithm

public String getAlgorithm()

Specified by:

getAlgorithm in interface Key

getFormat

public @Nullable String getFormat()

Specified by:

getFormat in interface Key

getEncoded

public byte @Nullable [] getEncoded()

Specified by:

getEncoded in interface Key