org.bouncycastle.openpgp

Class PGPSecretKeyRing

java.lang.Object

org.bouncycastle.openpgp.PGPKeyRing

org.bouncycastle.openpgp.PGPSecretKeyRing

public class PGPSecretKeyRing
extends PGPKeyRing

Class to hold a single master secret key and its subkeys.

Often PGP keyring files consist of multiple master keys, if you are trying to process or construct one of these you should use the PGPSecretKeyRingCollection class.

Constructor Summary

Constructors

Constructor and Description
PGPSecretKeyRing(byte[] encoding)
PGPSecretKeyRing(java.io.InputStream in)

Method Summary

Methods

Modifier and Type	Method and Description
static PGPSecretKeyRing	copyWithNewPassword(PGPSecretKeyRing ring, char[] oldPassPhrase, char[] newPassPhrase, int newEncAlgorithm, java.security.SecureRandom rand, java.security.Provider provider) Return a copy of the passed in secret key ring, with the master key and sub keys encrypted using a new password and the passed in algorithm.
static PGPSecretKeyRing	copyWithNewPassword(PGPSecretKeyRing ring, char[] oldPassPhrase, char[] newPassPhrase, int newEncAlgorithm, java.security.SecureRandom rand, java.lang.String provider) Return a copy of the passed in secret key ring, with the master key and sub keys encrypted using a new password and the passed in algorithm.
void	encode(java.io.OutputStream outStream)
byte[]	getEncoded()
java.util.Iterator	getExtraPublicKeys() Return an iterator of the public keys in the secret key ring that have no matching private key.
PGPPublicKey	getPublicKey() Return the public key for the master key.
PGPSecretKey	getSecretKey() Return the master private key.
PGPSecretKey	getSecretKey(long keyId)
java.util.Iterator	getSecretKeys() Return an iterator containing all the secret keys.
static PGPSecretKeyRing	insertSecretKey(PGPSecretKeyRing secRing, PGPSecretKey secKey) Returns a new key ring with the secret key passed in either added or replacing an existing one with the same key ID.
static PGPSecretKeyRing	removeSecretKey(PGPSecretKeyRing secRing, PGPSecretKey secKey) Returns a new key ring with the secret key passed in removed from the key ring.
static PGPSecretKeyRing	replacePublicKeys(PGPSecretKeyRing secretRing, PGPPublicKeyRing publicRing) Replace the public key set on the secret ring with the corresponding key off the public ring.

Methods inherited from class java.lang.Object

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

Constructor Detail

PGPSecretKeyRing

public PGPSecretKeyRing(byte[] encoding)
                 throws java.io.IOException,
                        PGPException

Throws:

java.io.IOException

PGPException

PGPSecretKeyRing

public PGPSecretKeyRing(java.io.InputStream in)
                 throws java.io.IOException,
                        PGPException

Throws:

java.io.IOException

PGPException

Method Detail

getPublicKey

public PGPPublicKey getPublicKey()

Return the public key for the master key.

Returns:

PGPPublicKey

getSecretKey

public PGPSecretKey getSecretKey()

Return the master private key.

Returns:

PGPSecretKey

getSecretKeys

public java.util.Iterator getSecretKeys()

Return an iterator containing all the secret keys.

Returns:

Iterator

getSecretKey

public PGPSecretKey getSecretKey(long keyId)

getExtraPublicKeys

public java.util.Iterator getExtraPublicKeys()

Return an iterator of the public keys in the secret key ring that have no matching private key. At the moment only personal certificate data appears in this fashion.

Returns:

iterator of unattached, or extra, public keys.

getEncoded

public byte[] getEncoded()
                  throws java.io.IOException

Throws:

java.io.IOException

encode

public void encode(java.io.OutputStream outStream)
            throws java.io.IOException

Throws:

java.io.IOException

replacePublicKeys

public static PGPSecretKeyRing replacePublicKeys(PGPSecretKeyRing secretRing,
                                 PGPPublicKeyRing publicRing)

Replace the public key set on the secret ring with the corresponding key off the public ring.

Parameters:

secretRing - secret ring to be changed.

publicRing - public ring containing the new public key set.

copyWithNewPassword

public static PGPSecretKeyRing copyWithNewPassword(PGPSecretKeyRing ring,
                                   char[] oldPassPhrase,
                                   char[] newPassPhrase,
                                   int newEncAlgorithm,
                                   java.security.SecureRandom rand,
                                   java.lang.String provider)
                                            throws PGPException,
                                                   java.security.NoSuchProviderException

Return a copy of the passed in secret key ring, with the master key and sub keys encrypted using a new password and the passed in algorithm.

Parameters:

ring - the PGPSecretKeyRing to be copied.

oldPassPhrase - the current password for key.

newPassPhrase - the new password for the key.

newEncAlgorithm - the algorithm to be used for the encryption.

rand - source of randomness.

provider - name of the provider to use

Throws:

PGPException

java.security.NoSuchProviderException

copyWithNewPassword

public static PGPSecretKeyRing copyWithNewPassword(PGPSecretKeyRing ring,
                                   char[] oldPassPhrase,
                                   char[] newPassPhrase,
                                   int newEncAlgorithm,
                                   java.security.SecureRandom rand,
                                   java.security.Provider provider)
                                            throws PGPException

Return a copy of the passed in secret key ring, with the master key and sub keys encrypted using a new password and the passed in algorithm.

Parameters:

ring - the PGPSecretKeyRing to be copied.

oldPassPhrase - the current password for key.

newPassPhrase - the new password for the key.

newEncAlgorithm - the algorithm to be used for the encryption.

rand - source of randomness.

provider - provider to use

Throws:

PGPException

insertSecretKey

public static PGPSecretKeyRing insertSecretKey(PGPSecretKeyRing secRing,
                               PGPSecretKey secKey)

Returns a new key ring with the secret key passed in either added or replacing an existing one with the same key ID.

Parameters:

secRing - the secret key ring to be modified.

secKey - the secret key to be added.

Returns:

a new secret key ring.

removeSecretKey

public static PGPSecretKeyRing removeSecretKey(PGPSecretKeyRing secRing,
                               PGPSecretKey secKey)

Returns a new key ring with the secret key passed in removed from the key ring.

Parameters:

secRing - the secret key ring to be modified.

secKey - the secret key to be removed.

Returns:

a new secret key ring, or null if secKey is not found.