org.bouncycastle.jcajce.provider.asymmetric.ec

Class BCECPrivateKey

java.lang.Object

org.bouncycastle.jcajce.provider.asymmetric.ec.BCECPrivateKey

All Implemented Interfaces:

java.io.Serializable, java.security.Key, java.security.PrivateKey, javax.security.auth.Destroyable, BCKey, ECKey, ECPointEncoder, ECPrivateKey, PKCS12BagAttributeCarrier

public class BCECPrivateKey
extends java.lang.Object
implements java.security.interfaces.ECPrivateKey, ECPrivateKey, javax.security.auth.Destroyable, PKCS12BagAttributeCarrier, ECPointEncoder, BCKey

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BCECPrivateKey()
	BCECPrivateKey(java.security.interfaces.ECPrivateKey key, ProviderConfiguration configuration)
	BCECPrivateKey(java.lang.String algorithm, BCECPrivateKey key)
	BCECPrivateKey(java.lang.String algorithm, ECPrivateKeyParameters params, BCECPublicKey pubKey, java.security.spec.ECParameterSpec spec, ProviderConfiguration configuration)
	BCECPrivateKey(java.lang.String algorithm, ECPrivateKeyParameters params, BCECPublicKey pubKey, ECParameterSpec spec, ProviderConfiguration configuration)
	BCECPrivateKey(java.lang.String algorithm, ECPrivateKeyParameters params, ProviderConfiguration configuration)
	BCECPrivateKey(java.lang.String algorithm, ECPrivateKeySpec spec, ProviderConfiguration configuration)
	BCECPrivateKey(java.lang.String algorithm, java.security.spec.ECPrivateKeySpec spec, ProviderConfiguration configuration)

Method Summary

Modifier and Type	Method and Description
void	destroy() Destroy this key, clearing the key material it holds.
ECPrivateKeyParameters	engineGetKeyParameters()
boolean	equals(java.lang.Object o)
java.lang.String	getAlgorithm()
ASN1Encodable	getBagAttribute(ASN1ObjectIdentifier oid)
java.util.Enumeration	getBagAttributeKeys()
java.math.BigInteger	getD() return the private value D.
byte[]	getEncoded() Return a PKCS8 representation of the key.
java.lang.String	getFormat() return the encoding format we produce in getEncoded().
ECParameterSpec	getParameters() return a parameter specification representing the EC domain parameters for the key.
java.security.spec.ECParameterSpec	getParams()
java.math.BigInteger	getS()
boolean	hasFriendlyName()
int	hashCode()
boolean	isDestroyed()
void	setBagAttribute(ASN1ObjectIdentifier oid, ASN1Encodable attribute)
void	setFriendlyName(java.lang.String friendlyName)
void	setPointFormat(java.lang.String style) Set the formatting for encoding of points.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

BCECPrivateKey

protected BCECPrivateKey()

BCECPrivateKey

public BCECPrivateKey(java.security.interfaces.ECPrivateKey key,
                      ProviderConfiguration configuration)

BCECPrivateKey

public BCECPrivateKey(java.lang.String algorithm,
                      ECPrivateKeySpec spec,
                      ProviderConfiguration configuration)

BCECPrivateKey

public BCECPrivateKey(java.lang.String algorithm,
                      java.security.spec.ECPrivateKeySpec spec,
                      ProviderConfiguration configuration)

BCECPrivateKey

public BCECPrivateKey(java.lang.String algorithm,
                      BCECPrivateKey key)

BCECPrivateKey

public BCECPrivateKey(java.lang.String algorithm,
                      ECPrivateKeyParameters params,
                      BCECPublicKey pubKey,
                      java.security.spec.ECParameterSpec spec,
                      ProviderConfiguration configuration)

BCECPrivateKey

public BCECPrivateKey(java.lang.String algorithm,
                      ECPrivateKeyParameters params,
                      BCECPublicKey pubKey,
                      ECParameterSpec spec,
                      ProviderConfiguration configuration)

BCECPrivateKey

public BCECPrivateKey(java.lang.String algorithm,
                      ECPrivateKeyParameters params,
                      ProviderConfiguration configuration)

Method Detail

getAlgorithm

public java.lang.String getAlgorithm()

Specified by:

getAlgorithm in interface java.security.Key

getFormat

public java.lang.String getFormat()

return the encoding format we produce in getEncoded().

Specified by:

getFormat in interface java.security.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 java.security.Key

Returns:

a PKCS8 representation of the key.

engineGetKeyParameters

public ECPrivateKeyParameters engineGetKeyParameters()

getParams

public java.security.spec.ECParameterSpec getParams()

getParameters

public ECParameterSpec getParameters()

Description copied from interface: ECKey

return a parameter specification representing the EC domain parameters for the key.

Specified by:

getParameters in interface ECKey

getS

public java.math.BigInteger getS()

getD

public java.math.BigInteger getD()

Description copied from interface: ECPrivateKey

return the private value D.

Specified by:

getD in interface ECPrivateKey

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 java.util.Enumeration getBagAttributeKeys()

Specified by:

getBagAttributeKeys in interface PKCS12BagAttributeCarrier

hasFriendlyName

public boolean hasFriendlyName()

Specified by:

hasFriendlyName in interface PKCS12BagAttributeCarrier

setFriendlyName

public void setFriendlyName(java.lang.String friendlyName)

Specified by:

setFriendlyName in interface PKCS12BagAttributeCarrier

setPointFormat

public void setPointFormat(java.lang.String style)

Description copied from interface: ECPointEncoder

Set the formatting for encoding of points. If the String "UNCOMPRESSED" is passed in point compression will not be used. If the String "COMPRESSED" is passed point compression will be used. The default is "UNCOMPRESSED".

Specified by:

setPointFormat in interface ECPointEncoder

Parameters:

style - the style to use.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.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 references so the values become unreachable (cleared on garbage collection); the cached PKCS#8 encoding is zeroized. The underlying ECPrivateKeyParameters object is destroyed as well, so keys sharing it are invalidated too. After destruction isDestroyed() returns true, the secret-bearing accessors (getEncoded(), getS() and getD()) throw IllegalStateException, and the key can no longer be serialized; hashCode() retains its pre-destruction value.

Specified by:

destroy in interface javax.security.auth.Destroyable

isDestroyed

public boolean isDestroyed()

Specified by:

isDestroyed in interface javax.security.auth.Destroyable