org.bouncycastle.openpgp.api

Class OpenPGPKey.OpenPGPSecretKey

java.lang.Object

org.bouncycastle.openpgp.api.OpenPGPCertificate.OpenPGPCertificateComponent

org.bouncycastle.openpgp.api.OpenPGPCertificate.OpenPGPComponentKey

org.bouncycastle.openpgp.api.OpenPGPKey.OpenPGPSecretKey

Enclosing class:

OpenPGPKey

public static class OpenPGPKey.OpenPGPSecretKey
extends OpenPGPCertificate.OpenPGPComponentKey

Secret key component of a OpenPGPCertificate.OpenPGPPrimaryKey or OpenPGPCertificate.OpenPGPSubkey.

Field Summary

Fields inherited from class org.bouncycastle.openpgp.api.OpenPGPCertificate.OpenPGPComponentKey

rawPubkey

Constructor Summary

Constructors

Constructor and Description
OpenPGPSecretKey(OpenPGPCertificate.OpenPGPComponentKey pubKey, PGPSecretKey secKey, PBESecretKeyDecryptorBuilderProvider decryptorBuilderProvider) Constructor.

Method Summary

Modifier and Type	Method and Description
OpenPGPCertificate.OpenPGPComponentSignature	getLatestSelfSignature(java.util.Date evaluationTime) Return the (at evaluation time) latest self-signature on the component.
OpenPGPKey	getOpenPGPKey() Return the OpenPGPKey which this OpenPGPKey.OpenPGPSecretKey belongs to.
PGPSecretKey	getPGPSecretKey() Return the underlying PGPSecretKey.
protected OpenPGPCertificate.OpenPGPCertificateComponent	getPublicComponent() Return the public OpenPGPCertificate.OpenPGPCertificateComponent that belongs to this component.
OpenPGPCertificate.OpenPGPComponentKey	getPublicKey() Return the public OpenPGPComponentKey corresponding to this OpenPGPKey.OpenPGPSecretKey.
boolean	isLocked() If true, the secret key is not available in plain and likely needs to be decrypted by providing a key passphrase.
boolean	isPassphraseCorrect(char[] passphrase) Return true if the provided passphrase is correct.
boolean	isPrimaryKey() Return true, if this OpenPGPCertificate.OpenPGPComponentKey represents the primary key of an OpenPGPCertificate.
java.lang.String	toDetailString() Return a detailed String representation of this component.
OpenPGPKey.OpenPGPPrivateKey	unlock() Unlock an unprotected OpenPGPKey.OpenPGPSecretKey.
OpenPGPKey.OpenPGPPrivateKey	unlock(char[] passphrase) Access the PGPKeyPair by unlocking the potentially locked secret key using the provided passphrase.
OpenPGPKey.OpenPGPPrivateKey	unlock(KeyPassphraseProvider passphraseProvider) Unlock a protected OpenPGPKey.OpenPGPSecretKey.

Methods inherited from class org.bouncycastle.openpgp.api.OpenPGPCertificate.OpenPGPComponentKey

equals, getAlgorithm, getCreationTime, getKeyComponent, getKeyIdentifier, getPGPPublicKey, getVersion, hashCode, isCertificationKey, isCertificationKey, isEncryptionKey, isEncryptionKey, isEncryptionKey, isSigningKey, isSigningKey

Methods inherited from class org.bouncycastle.openpgp.api.OpenPGPCertificate.OpenPGPCertificateComponent

getAEADCipherSuitePreferences, getAEADCipherSuitePreferences, getApplyingSubpacket, getCertificate, getCertification, getCertification, getCompressionAlgorithmPreferences, getCompressionAlgorithmPreferences, getFeatures, getFeatures, getHashAlgorithmPreferences, getHashAlgorithmPreferences, getKeyExpirationDate, getKeyExpirationDateAt, getKeyFlags, getKeyFlags, getLatestSelfSignature, getMergedDanglingExternalSignatureChainEndsFrom, getRevocation, getRevocation, getSelfSignatureChains, getSignatureChains, getSymmetricCipherPreferences, getSymmetricCipherPreferences, getThirdPartyCertifications, getThirdPartyRevocations, getThirdPartySignatureChainsBy, hasKeyFlags, isBound, isBoundAt

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenPGPSecretKey

public OpenPGPSecretKey(OpenPGPCertificate.OpenPGPComponentKey pubKey,
                        PGPSecretKey secKey,
                        PBESecretKeyDecryptorBuilderProvider decryptorBuilderProvider)

Constructor.

Parameters:

pubKey - corresponding public key component

secKey - secret key

decryptorBuilderProvider - for unlocking private keys

Method Detail

getPublicComponent

protected OpenPGPCertificate.OpenPGPCertificateComponent getPublicComponent()

Description copied from class: OpenPGPCertificate.OpenPGPCertificateComponent

Return the public OpenPGPCertificate.OpenPGPCertificateComponent that belongs to this component. For public components (pubkeys, identities...), that's simply this, while secret components return their corresponding public component. This is used to properly map secret key and public key components in Maps that use components as map keys.

Overrides:

getPublicComponent in class OpenPGPCertificate.OpenPGPCertificateComponent

Returns:

public certificate component

isPrimaryKey

public boolean isPrimaryKey()

Description copied from class: OpenPGPCertificate.OpenPGPComponentKey

Return true, if this OpenPGPCertificate.OpenPGPComponentKey represents the primary key of an OpenPGPCertificate.

Specified by:

isPrimaryKey in class OpenPGPCertificate.OpenPGPComponentKey

Returns:

true if primary, false if subkey

getLatestSelfSignature

public OpenPGPCertificate.OpenPGPComponentSignature getLatestSelfSignature(java.util.Date evaluationTime)

Description copied from class: OpenPGPCertificate.OpenPGPCertificateComponent

Return the (at evaluation time) latest self-signature on the component. That might either be a certification signature, or a revocation.

Overrides:

getLatestSelfSignature in class OpenPGPCertificate.OpenPGPComponentKey

Parameters:

evaluationTime - reference time

Returns:

latest self signature

getOpenPGPKey

public OpenPGPKey getOpenPGPKey()

Return the OpenPGPKey which this OpenPGPKey.OpenPGPSecretKey belongs to.

Returns:

OpenPGPKey

toDetailString

public java.lang.String toDetailString()

Description copied from class: OpenPGPCertificate.OpenPGPCertificateComponent

Return a detailed String representation of this component.

Specified by:

toDetailString in class OpenPGPCertificate.OpenPGPCertificateComponent

Returns:

detailed String representation

getPGPSecretKey

public PGPSecretKey getPGPSecretKey()

Return the underlying PGPSecretKey.

Returns:

secret key

getPublicKey

public OpenPGPCertificate.OpenPGPComponentKey getPublicKey()

Return the public OpenPGPComponentKey corresponding to this OpenPGPKey.OpenPGPSecretKey.

Returns:

public component key

isLocked

public boolean isLocked()

If true, the secret key is not available in plain and likely needs to be decrypted by providing a key passphrase.

Returns:

true if the key is locked

unlock

public OpenPGPKey.OpenPGPPrivateKey unlock()
                                    throws PGPException

Unlock an unprotected OpenPGPKey.OpenPGPSecretKey.

Returns:

unlocked private key

Throws:

PGPException - if the key cannot be unlocked

unlock

public OpenPGPKey.OpenPGPPrivateKey unlock(KeyPassphraseProvider passphraseProvider)
                                    throws PGPException

Unlock a protected OpenPGPKey.OpenPGPSecretKey.

Parameters:

passphraseProvider - provider for key passphrases

Returns:

unlocked private key

Throws:

PGPException - if the key cannot be unlocked

unlock

public OpenPGPKey.OpenPGPPrivateKey unlock(char[] passphrase)
                                    throws PGPException

Access the PGPKeyPair by unlocking the potentially locked secret key using the provided passphrase. Note: If the key is not locked, it is sufficient to pass null as passphrase.

Parameters:

passphrase - passphrase or null

Returns:

keypair containing unlocked private key

Throws:

PGPException - if the key cannot be unlocked

isPassphraseCorrect

public boolean isPassphraseCorrect(char[] passphrase)

Return true if the provided passphrase is correct. Note: This method will always return false for stripped secret keys.

Parameters:

passphrase - passphrase

Returns:

true if the passphrase is correct