Class KeyForDecryption

java.lang.Object
org.c02e.jpgpj.Key
org.c02e.jpgpj.key.KeyForDecryption
All Implemented Interfaces:
Cloneable

public class KeyForDecryption extends Key
Key that should be used exclusively for decryption.

Regardless of PGP usage flags associated with the original key source, all subkeys of this key will be flagged to be used for decryption and nothing else (so the Decryptor will try all subkeys of this key when decrypting, but will ignore all subkeys when verifying; and the Encryptor will ignore this key entirely).

Use like the following:


 new Decryptor(
     new KeyForVerification(new File("path/to/my/keys/alice-pub.gpg")),
     new KeyForDecryption(new File("path/to/my/keys/bob-sec.gpg"), "b0bru1z!")
 ).decrypt(
     new File("path/to/ciphertext.txt.gpg"),
     new File("path/back-to/plaintext.txt")
 );
 
See Also:
  • Constructor Details

    • KeyForDecryption

      public KeyForDecryption()
      Constructs a new empty key.
    • KeyForDecryption

      public KeyForDecryption(List<Subkey> subkeys)
      Constructs a new key with the specified subkeys.
    • KeyForDecryption

      public KeyForDecryption(String armor) throws IOException, org.bouncycastle.openpgp.PGPException
      Loads first key from the specified armored text.
      Throws:
      org.bouncycastle.openpgp.PGPException - if the text contains no keys.
      IOException
    • KeyForDecryption

      public KeyForDecryption(String armor, char[] passphraseChars) throws IOException, org.bouncycastle.openpgp.PGPException
      Loads first key from the specified armored text, and sets the passphrase of all subkeys to the specified passphrase.
      Throws:
      org.bouncycastle.openpgp.PGPException - if the text contains no keys.
      IOException
    • KeyForDecryption

      public KeyForDecryption(String armor, String passphrase) throws IOException, org.bouncycastle.openpgp.PGPException
      Loads first key from the specified armored text, and sets the passphrase of all subkeys to the specified passphrase. Prefer KeyForDecryption(String, char[]) to avoid creating extra copies of the passphrase in memory that cannot be cleaned up.
      Throws:
      org.bouncycastle.openpgp.PGPException - if the text contains no keys.
      IOException
    • KeyForDecryption

      public KeyForDecryption(File file) throws IOException, org.bouncycastle.openpgp.PGPException
      Loads first key from the specified file.
      Throws:
      org.bouncycastle.openpgp.PGPException - if the file contains no keys.
      IOException
    • KeyForDecryption

      public KeyForDecryption(File file, char[] passphraseChars) throws IOException, org.bouncycastle.openpgp.PGPException
      Loads first key from the specified file, and sets the passphrase of all subkeys to the specified passphrase.
      Throws:
      org.bouncycastle.openpgp.PGPException - if the file contains no keys.
      IOException
    • KeyForDecryption

      public KeyForDecryption(File file, String passphrase) throws IOException, org.bouncycastle.openpgp.PGPException
      Loads first key from the specified file, and sets the passphrase of all subkeys to the specified passphrase. Prefer KeyForDecryption(File, char[]) to avoid creating extra copies of the passphrase in memory that cannot be cleaned up.
      Throws:
      org.bouncycastle.openpgp.PGPException - if the file contains no keys.
      IOException
    • KeyForDecryption

      public KeyForDecryption(InputStream stream) throws IOException, org.bouncycastle.openpgp.PGPException
      Loads first key from the specified input stream.
      Throws:
      org.bouncycastle.openpgp.PGPException - if the input streame contains no keys.
      IOException
    • KeyForDecryption

      public KeyForDecryption(InputStream stream, char[] passphraseChars) throws IOException, org.bouncycastle.openpgp.PGPException
      Loads first key from the specified input stream, and sets the passphrase of all subkeys to the specified passphrase.
      Throws:
      org.bouncycastle.openpgp.PGPException - if the input streame contains no keys.
      IOException
    • KeyForDecryption

      public KeyForDecryption(InputStream stream, String passphrase) throws IOException, org.bouncycastle.openpgp.PGPException
      Loads first key from the specified input stream, and sets the passphrase of all subkeys to the specified passphrase. Prefer KeyForDecryption(InputStream, char[]) to avoid creating extra copies of the passphrase in memory that cannot be cleaned up.
      Throws:
      org.bouncycastle.openpgp.PGPException - if the input streame contains no keys.
      IOException
  • Method Details

    • setSubkeys

      protected void setSubkeys(List<Subkey> x)
      Description copied from class: Key
      All subkeys, or an empty list.
      Overrides:
      setSubkeys in class Key
    • setSubkeysUsage

      protected void setSubkeysUsage()