|
Bouncy Castle Cryptography Library 1.45 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.bouncycastle.openpgp.PGPKeyRing
org.bouncycastle.openpgp.PGPSecretKeyRing
public class PGPSecretKeyRing
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 | |
---|---|
PGPSecretKeyRing(byte[] encoding)
|
|
PGPSecretKeyRing(java.io.InputStream in)
|
Method Summary | |
---|---|
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 |
---|
public PGPSecretKeyRing(byte[] encoding) throws java.io.IOException, PGPException
java.io.IOException
PGPException
public PGPSecretKeyRing(java.io.InputStream in) throws java.io.IOException, PGPException
java.io.IOException
PGPException
Method Detail |
---|
public PGPPublicKey getPublicKey()
public PGPSecretKey getSecretKey()
public java.util.Iterator getSecretKeys()
public PGPSecretKey getSecretKey(long keyId)
public java.util.Iterator getExtraPublicKeys()
public byte[] getEncoded() throws java.io.IOException
java.io.IOException
public void encode(java.io.OutputStream outStream) throws java.io.IOException
java.io.IOException
public static PGPSecretKeyRing replacePublicKeys(PGPSecretKeyRing secretRing, PGPPublicKeyRing publicRing)
secretRing
- secret ring to be changed.publicRing
- public ring containing the new public key set.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
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
PGPException
java.security.NoSuchProviderException
public static PGPSecretKeyRing copyWithNewPassword(PGPSecretKeyRing ring, char[] oldPassPhrase, char[] newPassPhrase, int newEncAlgorithm, java.security.SecureRandom rand, java.security.Provider provider) throws PGPException
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
PGPException
public static PGPSecretKeyRing insertSecretKey(PGPSecretKeyRing secRing, PGPSecretKey secKey)
secRing
- the secret key ring to be modified.secKey
- the secret key to be added.
public static PGPSecretKeyRing removeSecretKey(PGPSecretKeyRing secRing, PGPSecretKey secKey)
secRing
- the secret key ring to be modified.secKey
- the secret key to be removed.
|
Bouncy Castle Cryptography Library 1.45 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |