org.bouncycastle.openpgp.api

Class OpenPGPKey.OpenPGPPrivateKey

java.lang.Object

org.bouncycastle.openpgp.api.OpenPGPKey.OpenPGPPrivateKey

Enclosing class:

OpenPGPKey

public static class OpenPGPKey.OpenPGPPrivateKey
extends java.lang.Object

Unlocked OpenPGPKey.OpenPGPSecretKey.

Constructor Summary

Constructors

Constructor and Description
OpenPGPPrivateKey(OpenPGPKey.OpenPGPSecretKey secretKey, PGPKeyPair unlockedKey)

Method Summary

Modifier and Type	Method and Description
OpenPGPKey.OpenPGPSecretKey	changePassphrase(char[] newPassphrase) Return a NEW instance of the OpenPGPKey.OpenPGPSecretKey locked with the new passphrase.
OpenPGPKey.OpenPGPSecretKey	changePassphrase(char[] newPassphrase, OpenPGPImplementation implementation, boolean useAEAD) Return a NEW instance of the OpenPGPKey.OpenPGPSecretKey locked with the new passphrase.
OpenPGPKey.OpenPGPSecretKey	changePassphrase(char[] newPassphrase, PBESecretKeyEncryptorFactory keyEncryptorFactory) Return a NEW instance of the OpenPGPKey.OpenPGPSecretKey locked with the new passphrase.
OpenPGPKey.OpenPGPSecretKey	changePassphrase(PBESecretKeyEncryptor keyEncryptor) Return a NEW instance of the OpenPGPKey.OpenPGPSecretKey locked using the given PBESecretKeyEncryptor.
PGPKeyPair	getKeyPair() Return the unlocked PGPKeyPair containing the decrypted PGPPrivateKey.
OpenPGPCertificate.OpenPGPComponentKey	getPublicKey() Return the public OpenPGPComponentKey of this OpenPGPKey.OpenPGPPrivateKey.
OpenPGPKey.OpenPGPSecretKey	getSecretKey() Return the OpenPGPKey.OpenPGPSecretKey in its potentially locked form.
OpenPGPKey.OpenPGPSecretKey	removePassphrase() Return a NEW instance of the OpenPGPKey.OpenPGPSecretKey with removed passphrase protection.

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenPGPPrivateKey

public OpenPGPPrivateKey(OpenPGPKey.OpenPGPSecretKey secretKey,
                         PGPKeyPair unlockedKey)

Method Detail

getPublicKey

public OpenPGPCertificate.OpenPGPComponentKey getPublicKey()

Return the public OpenPGPComponentKey of this OpenPGPKey.OpenPGPPrivateKey.

Returns:

public component key

getSecretKey

public OpenPGPKey.OpenPGPSecretKey getSecretKey()

Return the OpenPGPKey.OpenPGPSecretKey in its potentially locked form.

Returns:

secret key

getKeyPair

public PGPKeyPair getKeyPair()

Return the unlocked PGPKeyPair containing the decrypted PGPPrivateKey.

Returns:

unlocked private key

changePassphrase

public OpenPGPKey.OpenPGPSecretKey changePassphrase(char[] newPassphrase)
                                             throws PGPException

Return a NEW instance of the OpenPGPKey.OpenPGPSecretKey locked with the new passphrase. If the key was unprotected before, or if it was protected using AEAD, the new instance will be protected using AEAD as well.

Parameters:

newPassphrase - new passphrase

Returns:

new instance of the key, locked with the new passphrase

Throws:

PGPException - if the key cannot be locked

changePassphrase

public OpenPGPKey.OpenPGPSecretKey changePassphrase(char[] newPassphrase,
                                                    OpenPGPImplementation implementation,
                                                    boolean useAEAD)
                                             throws PGPException

Return a NEW instance of the OpenPGPKey.OpenPGPSecretKey locked with the new passphrase.

Parameters:

newPassphrase - new passphrase

implementation - OpenPGP implementation

useAEAD - whether to protect the key using AEAD

Returns:

new instance of the key, locked with the new passphrase

Throws:

PGPException - if the key cannot be locked

changePassphrase

public OpenPGPKey.OpenPGPSecretKey changePassphrase(char[] newPassphrase,
                                                    PBESecretKeyEncryptorFactory keyEncryptorFactory)
                                             throws PGPException

Return a NEW instance of the OpenPGPKey.OpenPGPSecretKey locked with the new passphrase.

Parameters:

newPassphrase - new passphrase

keyEncryptorFactory - factory for PBESecretKeyEncryptor instances

Returns:

new instance of the key, locked with the new passphrase

Throws:

PGPException - if the key cannot be locked

changePassphrase

public OpenPGPKey.OpenPGPSecretKey changePassphrase(PBESecretKeyEncryptor keyEncryptor)
                                             throws PGPException

Return a NEW instance of the OpenPGPKey.OpenPGPSecretKey locked using the given PBESecretKeyEncryptor.

Parameters:

keyEncryptor - encryptor

Returns:

new instance of the key, locked with the key encryptor

Throws:

PGPException - if the key cannot be locked

removePassphrase

public OpenPGPKey.OpenPGPSecretKey removePassphrase()
                                             throws PGPException

Return a NEW instance of the OpenPGPKey.OpenPGPSecretKey with removed passphrase protection.

Returns:

unlocked new instance of the key

Throws:

PGPException - if the key cannot be unlocked