Class OpenPGPKey

java.lang.Object

org.bouncycastle.openpgp.api.OpenPGPCertificate

org.bouncycastle.openpgp.api.OpenPGPKey

public class OpenPGPKey
extends OpenPGPCertificate

An OpenPGPKey (TSK - transferable secret key) is the pendant to an OpenPGPCertificate, but containing the secret key material in addition to the public components. It consists of one or multiple OpenPGPKey.OpenPGPSecretKey objects.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OpenPGPKey.OpenPGPPrivateKey	Unlocked OpenPGPKey.OpenPGPSecretKey.
static class	OpenPGPKey.OpenPGPSecretKey	Secret key component of a OpenPGPCertificate.OpenPGPPrimaryKey or OpenPGPCertificate.OpenPGPSubkey.

Nested classes/interfaces inherited from class OpenPGPCertificate

OpenPGPCertificate.OpenPGPCertificateComponent, OpenPGPCertificate.OpenPGPComponentKey, OpenPGPCertificate.OpenPGPComponentSignature, OpenPGPCertificate.OpenPGPIdentityComponent, OpenPGPCertificate.OpenPGPPrimaryKey, OpenPGPCertificate.OpenPGPSignatureChain, OpenPGPCertificate.OpenPGPSignatureChains, OpenPGPCertificate.OpenPGPSubkey, OpenPGPCertificate.OpenPGPUserAttribute, OpenPGPCertificate.OpenPGPUserId

Field Summary

Fields inherited from class OpenPGPCertificate

keyRing

Constructor Summary

Constructors

Constructor	Description
OpenPGPKey(PGPSecretKeyRing keyRing)	Create an OpenPGPKey instance based on a PGPSecretKeyRing.
OpenPGPKey(PGPSecretKeyRing keyRing, OpenPGPImplementation implementation)	Create an OpenPGPKey instance based on a PGPSecretKeyRing, a provided OpenPGPImplementation and its OpenPGPPolicy.
OpenPGPKey(PGPSecretKeyRing keyRing, OpenPGPImplementation implementation, OpenPGPPolicy policy)	Create an OpenPGPKey instance based on a PGPSecretKeyRing, a provided OpenPGPImplementation and OpenPGPPolicy.

Method Summary

Modifier and Type	Method	Description
List<OpenPGPCertificate.OpenPGPCertificateComponent>	getComponents()	Return a List containing all components of the certificate.
byte[]	getEncoded(PacketFormat packetFormat)	Return a byte array containing the binary representation of the certificate, encoded using the given packet length encoding format.
PGPSecretKeyRing	getPGPKeyRing()	Return the PGPKeyRing that this certificate is based on.
PGPSecretKeyRing	getPGPSecretKeyRing()	Return the underlying PGPSecretKeyRing.
OpenPGPKey.OpenPGPSecretKey	getPrimarySecretKey()	Return the OpenPGPKey.OpenPGPSecretKey of this key's primary key.
OpenPGPKey.OpenPGPSecretKey	getSecretKey(KeyIdentifier identifier)	Return the OpenPGPKey.OpenPGPSecretKey identified by the passed KeyIdentifier.
OpenPGPKey.OpenPGPSecretKey	getSecretKey(OpenPGPCertificate.OpenPGPComponentKey key)	Return the OpenPGPKey.OpenPGPSecretKey that corresponds to the passed OpenPGPCertificate.OpenPGPComponentKey.
Map<KeyIdentifier, OpenPGPKey.OpenPGPSecretKey>	getSecretKeys()	Return a Map containing all OpenPGPKey.OpenPGPSecretKey components (secret subkeys) of the key.
boolean	isSecretKey()	Return true, if this object is an OpenPGPKey, false otherwise.
OpenPGPCertificate	toCertificate()	Return the OpenPGPCertificate of this OpenPGPKey.

Methods inherited from class OpenPGPCertificate

getAllKeyIdentifiers, getAllUserIds, getCertification, getCertification, getCertificationKeys, getCertificationKeys, getComponentKeysWithFlag, getDelegationBy, getDelegationBy, getEncoded, getEncryptionKeys, getEncryptionKeys, getExpirationTime, getExpirationTime, getFingerprint, getIdentities, getKey, getKeyIdentifier, getKeys, getLastModificationDate, getLastModificationDateAt, getPGPPublicKeyRing, getPrettyFingerprint, getPrimaryKey, getPrimaryUserId, getPrimaryUserId, getPublicKeys, getRevocation, getRevocation, getRevocationBy, getRevocationBy, getSigningKeyFor, getSigningKeys, getSigningKeys, getSubkeys, getUserId, getValidKeys, getValidKeys, getValidUserIds, getValidUserIds, join, join, toAsciiArmoredString, toAsciiArmoredString, toAsciiArmoredString

Methods inherited from class Object

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

Constructor Details

OpenPGPKey

public OpenPGPKey(PGPSecretKeyRing keyRing)

Create an OpenPGPKey instance based on a PGPSecretKeyRing. The OpenPGPImplementation will be acquired by invoking OpenPGPImplementation.getInstance().

Parameters:

keyRing - secret key ring

OpenPGPKey

public OpenPGPKey(PGPSecretKeyRing keyRing,
 OpenPGPImplementation implementation)

Create an OpenPGPKey instance based on a PGPSecretKeyRing, a provided OpenPGPImplementation and its OpenPGPPolicy.

Parameters:

keyRing - secret key ring

implementation - OpenPGP implementation

OpenPGPKey

public OpenPGPKey(PGPSecretKeyRing keyRing,
 OpenPGPImplementation implementation,
 OpenPGPPolicy policy)

Create an OpenPGPKey instance based on a PGPSecretKeyRing, a provided OpenPGPImplementation and OpenPGPPolicy.

Parameters:

keyRing - secret key ring

implementation - OpenPGP implementation

policy - OpenPGP policy

Method Details

isSecretKey

public boolean isSecretKey()

Description copied from class: OpenPGPCertificate

Return true, if this object is an OpenPGPKey, false otherwise.

Overrides:

isSecretKey in class OpenPGPCertificate

Returns:

true if this is a secret key

toCertificate

public OpenPGPCertificate toCertificate()

Return the OpenPGPCertificate of this OpenPGPKey.

Returns:

certificate

getComponents

public List<OpenPGPCertificate.OpenPGPCertificateComponent> getComponents()

Description copied from class: OpenPGPCertificate

Return a List containing all components of the certificate. Components are primary key, subkeys and identities (user-ids, user attributes).

Overrides:

getComponents in class OpenPGPCertificate

Returns:

list of components

getPrimarySecretKey

public OpenPGPKey.OpenPGPSecretKey getPrimarySecretKey()

Return the OpenPGPKey.OpenPGPSecretKey of this key's primary key.

Returns:

primary secret key

getSecretKeys

public Map<KeyIdentifier, OpenPGPKey.OpenPGPSecretKey> getSecretKeys()

Return a Map containing all OpenPGPKey.OpenPGPSecretKey components (secret subkeys) of the key.

Returns:

secret key components

getSecretKey

public OpenPGPKey.OpenPGPSecretKey getSecretKey(KeyIdentifier identifier)

Return the OpenPGPKey.OpenPGPSecretKey identified by the passed KeyIdentifier.

Parameters:

identifier - key identifier

Returns:

corresponding secret key or null

getSecretKey

public OpenPGPKey.OpenPGPSecretKey getSecretKey(OpenPGPCertificate.OpenPGPComponentKey key)

Return the OpenPGPKey.OpenPGPSecretKey that corresponds to the passed OpenPGPCertificate.OpenPGPComponentKey.

Parameters:

key - component key

Returns:

corresponding secret key or null

getPGPKeyRing

public PGPSecretKeyRing getPGPKeyRing()

Description copied from class: OpenPGPCertificate

Return the PGPKeyRing that this certificate is based on.

Overrides:

getPGPKeyRing in class OpenPGPCertificate

Returns:

underlying key ring

getPGPSecretKeyRing

public PGPSecretKeyRing getPGPSecretKeyRing()

Return the underlying PGPSecretKeyRing.

Returns:

secret key ring

getEncoded

public byte[] getEncoded(PacketFormat packetFormat)
                  throws IOException

Description copied from class: OpenPGPCertificate

Return a byte array containing the binary representation of the certificate, encoded using the given packet length encoding format.

Overrides:

getEncoded in class OpenPGPCertificate

Parameters:

packetFormat - packet length encoding format

Returns:

binary encoded certificate

Throws:

IOException - if the certificate cannot be encoded