Class BCRSAPrivateKey

java.lang.Object

org.bouncycastle.jcajce.provider.asymmetric.rsa.BCRSAPrivateKey

All Implemented Interfaces:

Serializable, AsymmetricKey, DEREncodablePREVIEW, RSAKey, RSAPrivateKey, Key, PrivateKey, Destroyable, BCKey, PKCS12BagAttributeCarrier

Direct Known Subclasses:

BCRSAPrivateCrtKey

public class BCRSAPrivateKey
extends Object
implements RSAPrivateKey, Destroyable, PKCS12BagAttributeCarrier, BCKey

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected AlgorithmIdentifier	algorithmIdentifier
protected PKCS12BagAttributeCarrierImpl	attrCarrier
protected BigInteger	modulus
protected BigInteger	privateExponent
protected RSAKeyParameters	rsaPrivateKey

Method Summary

Modifier and Type	Method	Description
void	destroy()	Destroy this key, clearing the key material it holds.
boolean	equals(Object o)
String	getAlgorithm()
ASN1Encodable	getBagAttribute(ASN1ObjectIdentifier oid)
Enumeration	getBagAttributeKeys()
byte[]	getEncoded()
String	getFormat()
BigInteger	getModulus()
BigInteger	getPrivateExponent()
boolean	hasFriendlyName()
int	hashCode()
boolean	isDestroyed()
void	setBagAttribute(ASN1ObjectIdentifier oid, ASN1Encodable attribute)
void	setFriendlyName(String friendlyName)
String	toString()

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface RSAPrivateKey

getParams

Field Details

modulus

protected BigInteger modulus

privateExponent

protected BigInteger privateExponent

algorithmIdentifier

protected transient AlgorithmIdentifier algorithmIdentifier

rsaPrivateKey

protected transient RSAKeyParameters rsaPrivateKey

attrCarrier

protected transient PKCS12BagAttributeCarrierImpl attrCarrier

Method Details

getModulus

public BigInteger getModulus()

Specified by:

getModulus in interface RSAKey

getPrivateExponent

public BigInteger getPrivateExponent()

Specified by:

getPrivateExponent in interface RSAPrivateKey

getAlgorithm

public String getAlgorithm()

Specified by:

getAlgorithm in interface Key

getFormat

public String getFormat()

Specified by:

getFormat in interface Key

getEncoded

public byte[] getEncoded()

Specified by:

getEncoded in interface Key

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

destroy

public void destroy()

Destroy this key, clearing the key material it holds.

The values are held as BigIntegers, which are immutable and so cannot be zeroized in place - destruction drops the internal references so the values become unreachable (cleared on garbage collection). The (public) modulus is retained, so hashCode() and getModulus() remain stable across destruction. The underlying RSAKeyParameters object is destroyed as well, so keys sharing it are invalidated too. After destruction isDestroyed() returns true, getEncoded() and getPrivateExponent() throw IllegalStateException, and the key can no longer be serialized.

Specified by:

destroy in interface Destroyable

isDestroyed

public boolean isDestroyed()

Specified by:

isDestroyed in interface Destroyable

setBagAttribute

public void setBagAttribute(ASN1ObjectIdentifier oid,
 ASN1Encodable attribute)

Specified by:

setBagAttribute in interface PKCS12BagAttributeCarrier

getBagAttribute

public ASN1Encodable getBagAttribute(ASN1ObjectIdentifier oid)

Specified by:

getBagAttribute in interface PKCS12BagAttributeCarrier

getBagAttributeKeys

public Enumeration getBagAttributeKeys()

Specified by:

getBagAttributeKeys in interface PKCS12BagAttributeCarrier

hasFriendlyName

public boolean hasFriendlyName()

Specified by:

hasFriendlyName in interface PKCS12BagAttributeCarrier

setFriendlyName

public void setFriendlyName(String friendlyName)

Specified by:

setFriendlyName in interface PKCS12BagAttributeCarrier

toString

public String toString()

Overrides:

toString in class Object