Package org.bouncycastle.bcpg

Class ECSecretBCPGKey

java.lang.Object

org.bouncycastle.bcpg.BCPGObject

org.bouncycastle.bcpg.ECSecretBCPGKey

All Implemented Interfaces:

BCPGKey, org.bouncycastle.util.Encodable

public class ECSecretBCPGKey
extends BCPGObject
implements BCPGKey

Base class for an EC Secret Key. This type is for use with PublicKeyAlgorithmTags.ECDH or PublicKeyAlgorithmTags.ECDSA. The specific curve is identified by providing an OID. Regarding X25519, X448, consider the following: ECDH keys using curve448 are unspecified. ECDH secret keys using curve25519 use big-endian MPI encoding, contrary to X25519SecretBCPGKey which uses native encoding. Modern implementations use dedicated key types X25519SecretBCPGKey, X448SecretBCPGKey along with dedicated algorithm tags PublicKeyAlgorithmTags.X25519, PublicKeyAlgorithmTags.X448. If you want to be compatible with legacy applications however, you should use this class instead. Note though, that for v6 keys, X25519SecretBCPGKey or X448SecretBCPGKey MUST be used for X25519, X448.

See Also:

• OpenPGP - Algorithm-Specific Parts for ECDH Keys
• OpenPGP - Algorithm-Specific Parts for ECDSA Keys
• OpenPGP - Curve25519Legacy ECDH Secret Key Material (deprecated)

Constructor Summary

Constructors

Constructor	Description
ECSecretBCPGKey(BigInteger x)
ECSecretBCPGKey(BCPGInputStream in)

Method Summary

Modifier and Type	Method	Description
void	encode(BCPGOutputStream out)
byte[]	getEncoded()	return the standard PGP encoding of the key.
String	getFormat()	return "PGP"
BigInteger	getX()

Methods inherited from class java.lang.Object

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

Constructor Details

ECSecretBCPGKey

public ECSecretBCPGKey(BCPGInputStream in)
                throws IOException

Parameters:

in -

Throws:

IOException

ECSecretBCPGKey

public ECSecretBCPGKey(BigInteger x)

Parameters:

x -

Method Details

getFormat

public String getFormat()

return "PGP"

Specified by:

getFormat in interface BCPGKey

Returns:

"RAW" or "PGP"

See Also:

• BCPGKey.getFormat()

getEncoded

public byte[] getEncoded()

return the standard PGP encoding of the key.

Specified by:

getEncoded in interface BCPGKey

Specified by:

getEncoded in interface org.bouncycastle.util.Encodable

Overrides:

getEncoded in class BCPGObject

Returns:

byte[]

See Also:

• BCPGKey.getEncoded()

encode

public void encode(BCPGOutputStream out)
            throws IOException

Specified by:

encode in class BCPGObject

Throws:

IOException

getX

public BigInteger getX()

Returns:

x