Class BCDHPrivateKey

java.lang.Object

org.bouncycastle.jcajce.provider.asymmetric.dh.BCDHPrivateKey

All Implemented Interfaces:

Serializable, AsymmetricKey, DEREncodablePREVIEW, Key, PrivateKey, DHKey, DHPrivateKey, Destroyable, PKCS12BagAttributeCarrier

public class BCDHPrivateKey
extends Object
implements DHPrivateKey, Destroyable, PKCS12BagAttributeCarrier

See Also:

• Serialized Form

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BCDHPrivateKey()
	BCDHPrivateKey(PrivateKeyInfo info)

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()	Return a PKCS8 representation of the key.
String	getFormat()	return the encoding format we produce in getEncoded().
DHParameterSpec	getParams()
BigInteger	getX()
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

Constructor Details

BCDHPrivateKey

protected BCDHPrivateKey()

BCDHPrivateKey

public BCDHPrivateKey(PrivateKeyInfo info)
               throws IOException

Throws:

IOException

Method Details

getAlgorithm

public String getAlgorithm()

Specified by:

getAlgorithm in interface Key

getFormat

public String getFormat()

return the encoding format we produce in getEncoded().

Specified by:

getFormat in interface Key

Returns:

the string "PKCS#8"

getEncoded

public byte[] getEncoded()

Return a PKCS8 representation of the key. The sequence returned represents a full PrivateKeyInfo object.

Specified by:

getEncoded in interface Key

Returns:

a PKCS8 representation of the key.

toString

public String toString()

Overrides:

toString in class Object

getParams

public DHParameterSpec getParams()

Specified by:

getParams in interface AsymmetricKey

Specified by:

getParams in interface DHKey

Specified by:

getParams in interface DHPrivateKey

getX

public BigInteger getX()

Specified by:

getX in interface DHPrivateKey

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 private value is held as a BigInteger, which is immutable and so cannot be zeroized in place - destruction drops the internal reference so the value becomes unreachable (cleared on garbage collection). A PKCS#8 PrivateKeyInfo retained from decoding is dropped with it, and the underlying DHPrivateKeyParameters object, where one is held, is destroyed as well, so keys sharing it are invalidated too. The (public) domain parameters are retained. After destruction isDestroyed() returns true, the secret-bearing accessors (getEncoded() and getX()) throw IllegalStateException, the key can no longer be serialized, and it is equal only to itself; hashCode() retains its pre-destruction value.

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