Skip navigation links
A B C D E F G H I J K L M N O P R S T U V W 

A

addArmoredHeaders(Map<String, String>) - Method in class org.c02e.jpgpj.Encryptor
Adds the specified headers - replaces existing ones and adds the new ones.
asBoolean() - Method in class org.c02e.jpgpj.Ring
True if this contains at least one key.

B

bestFileBufferSize(long, int) - Static method in class org.c02e.jpgpj.util.Util
Returns the exact fileSize with a maximum of maxFileBufferSize and a minimum of 1.
bestPacketSize(FileMetadata) - Method in class org.c02e.jpgpj.Encryptor
Calculates optimal PGP packet size, based on plaintext length.
bestPacketSize(long) - Method in class org.c02e.jpgpj.Encryptor
Calculates optimal PGP packet size, based on plaintext length.
byCode(char) - Static method in enum org.c02e.jpgpj.FileMetadata.Format
 

C

clearSecrets() - Method in class org.c02e.jpgpj.Decryptor
Zeroes-out the cached passphrase for all keys, and releases the extracted private key material for garbage collection.
clearSecrets() - Method in class org.c02e.jpgpj.Encryptor
Zeroes-out the cached passphrase for all keys, and releases the extracted private key material for garbage collection.
clearSecrets() - Method in class org.c02e.jpgpj.Key
Zeroes-out the cached passphrase for all subkeys, and releases the extracted private key material for garbage collection.
clearSecrets() - Method in class org.c02e.jpgpj.Ring
Zeroes-out the cached passphrase for all keys, and releases the extracted private key material for garbage collection.
clearSecrets() - Method in class org.c02e.jpgpj.Subkey
Zeroes-out the cached passphrase for this subkey, and releases the extracted private key material for garbage collection.
clone() - Method in class org.c02e.jpgpj.Decryptor
 
clone() - Method in class org.c02e.jpgpj.Encryptor
 
clone() - Method in class org.c02e.jpgpj.Key
 
clone() - Method in class org.c02e.jpgpj.Ring
 
clone() - Method in class org.c02e.jpgpj.Subkey
 
CompressionAlgorithm - Enum in org.c02e.jpgpj
Available compression algorithms for compressing message content.

D

decrypt(File, File) - Method in class org.c02e.jpgpj.Decryptor
Decrypts the first specified file to the output location specified by the second file, and (if Decryptor.isVerificationRequired()) verifies its signatures.
decrypt(Path, Path) - Method in class org.c02e.jpgpj.Decryptor
Decrypts the first specified file to the output location specified by the second file, and (if Decryptor.isVerificationRequired()) verifies its signatures.
decrypt(InputStream, OutputStream) - Method in class org.c02e.jpgpj.Decryptor
Decrypts the specified PGP message into the specified output stream, and (if Decryptor.isVerificationRequired()) verifies the message signatures.
DecryptionException - Exception in org.c02e.jpgpj
Indicates decryption failed, because the message was not encrypted with a required key or symmetric passphrase.
DecryptionException(String) - Constructor for exception org.c02e.jpgpj.DecryptionException
 
DecryptionException(String, Exception) - Constructor for exception org.c02e.jpgpj.DecryptionException
 
DecryptionResult - Class in org.c02e.jpgpj
Holds the most detailed information about a decrypted file
DecryptionResult(FileMetadata, boolean, Collection<String>) - Constructor for class org.c02e.jpgpj.DecryptionResult
 
Decryptor - Class in org.c02e.jpgpj
Decrypts and verifies PGP messages using the decryption and verification Keys supplied on this object's Ring.
Decryptor() - Constructor for class org.c02e.jpgpj.Decryptor
Constructs a decryptor with an empty key ring.
Decryptor(Ring) - Constructor for class org.c02e.jpgpj.Decryptor
Constructs a decryptor with the specified key ring.
Decryptor(Key...) - Constructor for class org.c02e.jpgpj.Decryptor
Constructs a decryptor with the specified keys.
Decryptor.VerificationType - Enum in org.c02e.jpgpj
Type of signature verification done by decryptor.
decryptWithFullDetails(InputStream, OutputStream) - Method in class org.c02e.jpgpj.Decryptor
Decrypts the specified PGP message into the specified output stream, including the armored headers (if stream was armored and contained any such headers).
DEFAULT_ASCII_ARMORED - Static variable in class org.c02e.jpgpj.Encryptor
 
DEFAULT_COMPRESSION_ALGORITHM - Static variable in class org.c02e.jpgpj.Encryptor
 
DEFAULT_COMPRESSION_LEVEL - Static variable in class org.c02e.jpgpj.Encryptor
 
DEFAULT_COPY_FILE_BUFFER_SIZE - Static variable in class org.c02e.jpgpj.Decryptor
 
DEFAULT_ENCRYPTION_ALGORITHM - Static variable in class org.c02e.jpgpj.Encryptor
 
DEFAULT_FORMAT - Static variable in class org.c02e.jpgpj.FileMetadata
 
DEFAULT_KEY_DERIVATION_ALGORITHM - Static variable in class org.c02e.jpgpj.Encryptor
 
DEFAULT_KEY_DERIVATION_ALGORITHM_WORK_FACTOR - Static variable in class org.c02e.jpgpj.Encryptor
 
DEFAULT_LOGGING_ENABLED - Static variable in class org.c02e.jpgpj.Decryptor
 
DEFAULT_LOGGING_ENABLED - Static variable in class org.c02e.jpgpj.Encryptor
 
DEFAULT_MAX_FILE_BUFFER_SIZE - Static variable in class org.c02e.jpgpj.Decryptor
 
DEFAULT_MAX_FILE_BUFFER_SIZE - Static variable in class org.c02e.jpgpj.Encryptor
 
DEFAULT_NAME - Static variable in class org.c02e.jpgpj.FileMetadata
 
DEFAULT_REMOVE_DEFAULT_ARMORED_VERSION_HEADER - Static variable in class org.c02e.jpgpj.Encryptor
 
DEFAULT_SIGNING_ALGORITHM - Static variable in class org.c02e.jpgpj.Encryptor
 
DEFAULT_VERIFICATION_REQUIRED - Static variable in class org.c02e.jpgpj.Decryptor
 
DEFAULT_VERIFICATION_TYPE - Static variable in class org.c02e.jpgpj.Decryptor
 
detectContainer(InputStream) - Static method in class org.c02e.jpgpj.util.FileDetection
Scans the first few bytes of the specified input stream, and tries to determine if it's a known PGP container format.
detectContainer(InputStream, int) - Static method in class org.c02e.jpgpj.util.FileDetection
Scans the first few bytes of the specified input stream, and tries to determine if it's a known PGP container format.
DetectionResult() - Constructor for class org.c02e.jpgpj.util.FileDetection.DetectionResult
 
DetectionResult(InputStream, FileDetection.ContainerType) - Constructor for class org.c02e.jpgpj.util.FileDetection.DetectionResult
 

E

EMPTY - Static variable in interface org.c02e.jpgpj.EncryptedAsciiArmorHeadersManipulator
A manipulator that ignores all headers manipulations
encrypt(File, File) - Method in class org.c02e.jpgpj.Encryptor
Signs, compresses, and encrypts the specified file to the output location specified by the second file.
encrypt(Path, Path) - Method in class org.c02e.jpgpj.Encryptor
Signs, compresses, and encrypts the specified file to the output location specified by the second file.
encrypt(InputStream, OutputStream) - Method in class org.c02e.jpgpj.Encryptor
Signs, compresses, and encrypts the specified content as a PGP message into the specified output stream (with no optional metadata).
encrypt(InputStream, OutputStream, FileMetadata) - Method in class org.c02e.jpgpj.Encryptor
Signs, compresses, and encrypts the specified content as a PGP message into the specified output stream with the specified content metadata.
encryptBytes(byte[], String, File) - Method in class org.c02e.jpgpj.Encryptor
 
encryptBytes(byte[], String, Path) - Method in class org.c02e.jpgpj.Encryptor
 
encryptBytes(byte[], String, OutputStream) - Method in class org.c02e.jpgpj.Encryptor
 
EncryptedAsciiArmorHeadersCallback - Interface in org.c02e.jpgpj
Used by the encryptor to allow users to configure per-file armored headers instead/in addition to the global ones that are set by the encryptor
EncryptedAsciiArmorHeadersManipulator - Interface in org.c02e.jpgpj
 
EncryptionAlgorithm - Enum in org.c02e.jpgpj
Available symmetric-key encryption algorithms for encrypting message content.
Encryptor - Class in org.c02e.jpgpj
Encrypts and signs PGP messages using the encryption and signing Keys supplied on this object's Ring.
Encryptor() - Constructor for class org.c02e.jpgpj.Encryptor
Constructs an encryptor with an empty key ring.
Encryptor(Ring) - Constructor for class org.c02e.jpgpj.Encryptor
Constructs an encryptor with the specified key ring.
Encryptor(Key...) - Constructor for class org.c02e.jpgpj.Encryptor
Constructs an encryptor with the specified keys.
equals(Object) - Method in class org.c02e.jpgpj.FileMetadata
 
estimateOutFileBufferSize(long) - Method in class org.c02e.jpgpj.Encryptor
 

F

FileDetection - Class in org.c02e.jpgpj.util
File detection utilities.
FileDetection() - Constructor for class org.c02e.jpgpj.util.FileDetection
 
FileDetection.ContainerType - Enum in org.c02e.jpgpj.util
 
FileDetection.DetectionResult - Class in org.c02e.jpgpj.util
 
FileMetadata - Class in org.c02e.jpgpj
Optional PGP message metadata.
FileMetadata() - Constructor for class org.c02e.jpgpj.FileMetadata
Constructs a metadata object with default values.
FileMetadata(PGPLiteralData) - Constructor for class org.c02e.jpgpj.FileMetadata
Constructs a metadata object from Bouncy Castle message data.
FileMetadata(File) - Constructor for class org.c02e.jpgpj.FileMetadata
Constructs a metadata object from a file.
FileMetadata(Path) - Constructor for class org.c02e.jpgpj.FileMetadata
Constructs a metadata object from a file.
FileMetadata(String) - Constructor for class org.c02e.jpgpj.FileMetadata
Constructs a metadata object with the specified file name .
FileMetadata(String, FileMetadata.Format) - Constructor for class org.c02e.jpgpj.FileMetadata
Constructs a metadata object with the specified file name and line-ending format.
FileMetadata(String, FileMetadata.Format, long, long) - Constructor for class org.c02e.jpgpj.FileMetadata
Constructs a metadata object with the specified file name, line-ending format, length in bytes, and modified date in ms since the epoch.
FileMetadata.Format - Enum in org.c02e.jpgpj
Format for line-ending normalization.
FileMetadata.Signature - Class in org.c02e.jpgpj
Signature found by decryptor.
findAll(String) - Method in class org.c02e.jpgpj.Key
All subkeys for which the specified string is a case-insensitive substring of either: any subkey's full ID (eg "0x1234567890ABCDEF") any subkey's fingerprint (eg "1234567890ABCDEF1234567890ABCDEF12345678") any one of any subkey's user IDs (eg "Alice (work) <alice@example.com>")
findAll(Pattern) - Method in class org.c02e.jpgpj.Key
All subkeys for which the specified pattern matches any part of either: any subkey's full ID (eg "0x1234567890ABCDEF") any subkey's fingerprint (eg "1234567890ABCDEF1234567890ABCDEF12345678") any one of any subkey's user IDs (eg "Alice (work) <alice@example.com>")
findAll(Long) - Method in class org.c02e.jpgpj.Ring
All keys for which the specified ID is any subkey's full ID.
findAll(String) - Method in class org.c02e.jpgpj.Ring
All keys for which the specified string is a case-insensitive substring of either: any subkey's full ID (eg "0x1234567890ABCDEF") any subkey's fingerprint (eg "1234567890ABCDEF1234567890ABCDEF12345678") any one of any subkey's user IDs (eg "Alice (work) <alice@example.com>")
findAll(Pattern) - Method in class org.c02e.jpgpj.Ring
All keys for which the specified pattern matches any part of either: any subkey's full ID (eg "0x1234567890ABCDEF") any subkey's fingerprint (eg "1234567890ABCDEF1234567890ABCDEF12345678") any one of any subkey's user IDs (eg "Alice (work) <alice@example.com>")
findById(Long) - Method in class org.c02e.jpgpj.Key
Subkey with the specified full ID, or null.
findById(Long) - Method in class org.c02e.jpgpj.Ring
Deprecated.
Use Ring.findAll(java.lang.Long) (to find all subkeys on a ring, in case the same key had been included multiple times with different settings on the same ring).
formatAsHex(byte[]) - Static method in class org.c02e.jpgpj.util.Util
Formats the specified byte array as a hex string.
formatKeyId(Long) - Static method in class org.c02e.jpgpj.util.Util
Formats the specified key id in the "0xlong" format.

G

getArmoredHeader(String) - Method in class org.c02e.jpgpj.Encryptor
Retrieves the value for the specified armored header.
getArmoredHeaders() - Method in class org.c02e.jpgpj.Encryptor
 
getArmorHeaders() - Method in class org.c02e.jpgpj.DecryptionResult
 
getArmorHeadersCallback() - Method in class org.c02e.jpgpj.Encryptor
 
getCode() - Method in enum org.c02e.jpgpj.FileMetadata.Format
 
getCompressionAlgorithm() - Method in class org.c02e.jpgpj.Encryptor
 
getCompressionBuffer(FileMetadata) - Method in class org.c02e.jpgpj.Encryptor
Internal buffer for compressed-data packets, sized based on plaintext length.
getCompressionBuffer(long) - Method in class org.c02e.jpgpj.Encryptor
Internal buffer for compressed-data packets, sized based on plaintext length.
getCompressionLevel() - Method in class org.c02e.jpgpj.Encryptor
 
getCopyBuffer() - Method in class org.c02e.jpgpj.Decryptor
Internal buffer for copying decrypted plaintext into the output stream.
getCopyBuffer(FileMetadata) - Method in class org.c02e.jpgpj.Encryptor
Internal buffer for copying plaintext into the encryption pipeline, sized based on plaintext length.
getCopyBuffer(long) - Method in class org.c02e.jpgpj.Encryptor
Internal buffer for copying plaintext into the encryption pipeline, sized based on plaintext length.
getCopyFileBufferSize() - Method in class org.c02e.jpgpj.Decryptor
 
getDecryption() - Method in class org.c02e.jpgpj.Key
Last subkey that can decrypt, or null.
getDecryptionKeys() - Method in class org.c02e.jpgpj.Ring
All keys that can decrypt, or an empty list.
getEncryption() - Method in class org.c02e.jpgpj.Key
Last subkey that can encrypt, or null.
getEncryptionAlgorithm() - Method in class org.c02e.jpgpj.Encryptor
 
getEncryptionBuffer(FileMetadata) - Method in class org.c02e.jpgpj.Encryptor
Internal buffer for encrypted-data packets, sized based on plaintext length.
getEncryptionBuffer(long) - Method in class org.c02e.jpgpj.Encryptor
Internal buffer for encrypted-data packets, sized based on plaintext length.
getEncryptionKeys() - Method in class org.c02e.jpgpj.Ring
All keys that can encrypt, or an empty list.
getFileMetadata() - Method in class org.c02e.jpgpj.DecryptionResult
 
getFingerprint() - Method in class org.c02e.jpgpj.Subkey
Fingerprint of public key, or empty string if no public key.
getFormat() - Method in class org.c02e.jpgpj.FileMetadata
 
getId() - Method in class org.c02e.jpgpj.Subkey
Full '0xlong' format of public key, or empty string if no public key.
getKey() - Method in class org.c02e.jpgpj.FileMetadata.Signature
Key used for signature, or null.
getKeyDeriviationAlgorithm() - Method in class org.c02e.jpgpj.Encryptor
 
getKeyDeriviationWorkFactor() - Method in class org.c02e.jpgpj.Encryptor
 
getKeyId() - Method in class org.c02e.jpgpj.FileMetadata.Signature
ID of subkey used for signature.
getKeys() - Method in class org.c02e.jpgpj.Ring
All keys, an or an empty list.
getLastModified() - Method in class org.c02e.jpgpj.FileMetadata
 
getLastModifiedDate() - Method in class org.c02e.jpgpj.FileMetadata
 
getLength() - Method in class org.c02e.jpgpj.FileMetadata
 
getLiteralBuffer(FileMetadata) - Method in class org.c02e.jpgpj.Encryptor
Internal buffer for literal-data packets, sized based on plaintext length.
getLiteralBuffer(long) - Method in class org.c02e.jpgpj.Encryptor
Internal buffer for literal-data packets, sized based on plaintext length.
getMaster() - Method in class org.c02e.jpgpj.Key
First subkey or null.
getMaxFileBufferSize() - Method in class org.c02e.jpgpj.Decryptor
 
getMaxFileBufferSize() - Method in class org.c02e.jpgpj.Encryptor
 
getName() - Method in class org.c02e.jpgpj.FileMetadata
 
getPassphrase() - Method in class org.c02e.jpgpj.Subkey
Passphrase needed to unlock the private part of the subkey's public key-pair; or empty string.
getPassphraseChars() - Method in class org.c02e.jpgpj.Subkey
Passphrase needed to unlock the private part of the subkey's public key-pair; or empty char[].
getPrivateKey() - Method in class org.c02e.jpgpj.Subkey
Extracts the Bouncy castle private-key material from this subkey's secret key, using the subkey's passphrase, and caches it in memory until Subkey.clearSecrets() is called.
getPublicKey() - Method in class org.c02e.jpgpj.Subkey
Bouncy castle public-key pair, containing only the public part of the pair; or null.
getRing() - Method in class org.c02e.jpgpj.Decryptor
 
getRing() - Method in class org.c02e.jpgpj.Encryptor
 
getSecretKey() - Method in class org.c02e.jpgpj.Subkey
Bouncy castle public-key pair, containing both the public and private parts of the pair; or null.
getSecurityProvider() - Static method in class org.c02e.jpgpj.JcaContextHelper
Get the security provider which is used for all operations
getShortId() - Method in class org.c02e.jpgpj.Subkey
Abbreviated 'short' format of public key, or empty string if no public key.
getSignatures() - Method in class org.c02e.jpgpj.FileMetadata
Signatures found on the file, including unverified signatures.
getSignatureType() - Method in class org.c02e.jpgpj.FileMetadata
PGP code for the signature type appropriate for the line-ending format of the original file.
getSigning() - Method in class org.c02e.jpgpj.Key
Last subkey that can sign, or null.
getSigningAlgorithm() - Method in class org.c02e.jpgpj.Encryptor
 
getSigningKeys() - Method in class org.c02e.jpgpj.Ring
All keys that can sign, or an empty list.
getSigningUid() - Method in class org.c02e.jpgpj.Key
User ID to use for signing, or empty string.
getSubkeys() - Method in class org.c02e.jpgpj.Key
All subkeys, or an empty list.
getSymmetricPassphrase() - Method in class org.c02e.jpgpj.Decryptor
 
getSymmetricPassphrase() - Method in class org.c02e.jpgpj.Encryptor
 
getSymmetricPassphraseChars() - Method in class org.c02e.jpgpj.Decryptor
 
getSymmetricPassphraseChars() - Method in class org.c02e.jpgpj.Encryptor
 
getUids() - Method in class org.c02e.jpgpj.Key
User ID strings for master subkey (ex ["My Name (comment) <me@example.com>"]).
getUids() - Method in class org.c02e.jpgpj.Subkey
User ID strings of public key (ex ["My Name (comment) <me@example.com>"]), or empty list.
getUsageFlags() - Method in class org.c02e.jpgpj.Subkey
Usage flags as Bouncy castle PGPKeyFlags bits.
getVerification() - Method in class org.c02e.jpgpj.Key
Last subkey that can verify, or null.
getVerificationKeys() - Method in class org.c02e.jpgpj.Ring
All keys that can verify, or an empty list.
getVerificationType() - Method in class org.c02e.jpgpj.Decryptor
Type of signature verification.
getVerified() - Method in class org.c02e.jpgpj.FileMetadata
Keys that signed the file with a verified signature.
getVerifiedKey() - Method in class org.c02e.jpgpj.FileMetadata.Signature
Key used for signature if verified, or null.

H

hashCode() - Method in class org.c02e.jpgpj.FileMetadata
 
HashingAlgorithm - Enum in org.c02e.jpgpj
Available hash algorithms for signing message content, and for deriving a symmetric key from a passphrase.

I

isAsciiArmored() - Method in class org.c02e.jpgpj.DecryptionResult
 
isAsciiArmored() - Method in class org.c02e.jpgpj.Encryptor
 
isEmpty(char[]) - Static method in class org.c02e.jpgpj.util.Util
True if the specified character array is null or empty.
isEmpty(String) - Static method in class org.c02e.jpgpj.util.Util
True if the specified string is null or empty.
isEmpty(Collection<?>) - Static method in class org.c02e.jpgpj.util.Util
True if the specified collection is null or empty.
isEmpty(Map<?, ?>) - Static method in class org.c02e.jpgpj.util.Util
True if the specified map is null or empty.
isForDecryption() - Method in class org.c02e.jpgpj.Key
True if any subkey can be used for decryption.
isForDecryption() - Method in class org.c02e.jpgpj.Subkey
True if the subkey should be used for decrypting messages.
isForEncryption() - Method in class org.c02e.jpgpj.Key
True if any subkey can be used for encryption.
isForEncryption() - Method in class org.c02e.jpgpj.Subkey
True if the subkey should be used for encrypting messages.
isForSigning() - Method in class org.c02e.jpgpj.Key
True if any subkey can be used for signing.
isForSigning() - Method in class org.c02e.jpgpj.Subkey
True if the subkey should be used for signing messages.
isForVerification() - Method in class org.c02e.jpgpj.Key
True if any subkey can be used for verification.
isForVerification() - Method in class org.c02e.jpgpj.Subkey
True if the subkey should be used for verifying messages.
isLoggingEnabled() - Method in class org.c02e.jpgpj.Decryptor
 
isLoggingEnabled() - Method in class org.c02e.jpgpj.Encryptor
 
isNoPassphrase() - Method in class org.c02e.jpgpj.Subkey
True if no passphrase is needed to unlock the private part of the subkey's public key-pair.
isRemoveDefaultArmoredVersionHeader() - Method in class org.c02e.jpgpj.Encryptor
By default the ArmoredOutputStream adds a "Version" header - this setting allows users to remove this header (and perhaps replace it and/or add others - see headers manipulation methods).
isUnlocked() - Method in class org.c02e.jpgpj.Subkey
True if the private key material has been extracted from this subkey's secret key and is currently cached in memory.
isUsableForDecryption() - Method in class org.c02e.jpgpj.Subkey
True if technically usable for decryption.
isUsableForEncryption() - Method in class org.c02e.jpgpj.Subkey
True if technically usable for encryption.
isUsableForSigning() - Method in class org.c02e.jpgpj.Subkey
True if technically usable for signing.
isUsableForVerification() - Method in class org.c02e.jpgpj.Subkey
True if technically usable for verification.
isVerificationRequired() - Method in class org.c02e.jpgpj.Decryptor
 
isVerified() - Method in class org.c02e.jpgpj.FileMetadata.Signature
True if signature was verified.

J

JcaContextHelper - Class in org.c02e.jpgpj
Helper class for Java Cryptography Architecture (JCA) context consisting of provider Note: The following class is not thread safe, the security provider should not be changed during PGP operations

K

Key - Class in org.c02e.jpgpj
The identity of a person (or persona, or non-human actor, etc) as a collection of Subkeys.
Key() - Constructor for class org.c02e.jpgpj.Key
Constructs a new empty key.
Key(List<Subkey>) - Constructor for class org.c02e.jpgpj.Key
Constructs a new key with the specified subkeys.
Key(String) - Constructor for class org.c02e.jpgpj.Key
Loads first key from the specified armored text.
Key(String, char[]) - Constructor for class org.c02e.jpgpj.Key
Loads first key from the specified armored text, and sets the passphrase of all subkeys to the specified passphrase.
Key(String, String) - Constructor for class org.c02e.jpgpj.Key
Loads first key from the specified armored text, and sets the passphrase of all subkeys to the specified passphrase.
Key(File) - Constructor for class org.c02e.jpgpj.Key
Loads first key from the specified file.
Key(File, char[]) - Constructor for class org.c02e.jpgpj.Key
Loads first key from the specified file, and sets the passphrase of all subkeys to the specified passphrase.
Key(File, String) - Constructor for class org.c02e.jpgpj.Key
Loads first key from the specified file, and sets the passphrase of all subkeys to the specified passphrase.
Key(InputStream) - Constructor for class org.c02e.jpgpj.Key
Loads first key from the specified input stream.
Key(InputStream, char[]) - Constructor for class org.c02e.jpgpj.Key
Loads first key from the specified input stream, and sets the passphrase of all subkeys to the specified passphrase.
Key(InputStream, String) - Constructor for class org.c02e.jpgpj.Key
Loads first key from the specified input stream, and sets the passphrase of all subkeys to the specified passphrase.
KeyForDecryption - Class in org.c02e.jpgpj.key
Key that should be used exclusively for decryption.
KeyForDecryption() - Constructor for class org.c02e.jpgpj.key.KeyForDecryption
Constructs a new empty key.
KeyForDecryption(List<Subkey>) - Constructor for class org.c02e.jpgpj.key.KeyForDecryption
Constructs a new key with the specified subkeys.
KeyForDecryption(String) - Constructor for class org.c02e.jpgpj.key.KeyForDecryption
Loads first key from the specified armored text.
KeyForDecryption(String, char[]) - Constructor for class org.c02e.jpgpj.key.KeyForDecryption
Loads first key from the specified armored text, and sets the passphrase of all subkeys to the specified passphrase.
KeyForDecryption(String, String) - Constructor for class org.c02e.jpgpj.key.KeyForDecryption
Loads first key from the specified armored text, and sets the passphrase of all subkeys to the specified passphrase.
KeyForDecryption(File) - Constructor for class org.c02e.jpgpj.key.KeyForDecryption
Loads first key from the specified file.
KeyForDecryption(File, char[]) - Constructor for class org.c02e.jpgpj.key.KeyForDecryption
Loads first key from the specified file, and sets the passphrase of all subkeys to the specified passphrase.
KeyForDecryption(File, String) - Constructor for class org.c02e.jpgpj.key.KeyForDecryption
Loads first key from the specified file, and sets the passphrase of all subkeys to the specified passphrase.
KeyForDecryption(InputStream) - Constructor for class org.c02e.jpgpj.key.KeyForDecryption
Loads first key from the specified input stream.
KeyForDecryption(InputStream, char[]) - Constructor for class org.c02e.jpgpj.key.KeyForDecryption
Loads first key from the specified input stream, and sets the passphrase of all subkeys to the specified passphrase.
KeyForDecryption(InputStream, String) - Constructor for class org.c02e.jpgpj.key.KeyForDecryption
Loads first key from the specified input stream, and sets the passphrase of all subkeys to the specified passphrase.
KeyForEncryption - Class in org.c02e.jpgpj.key
Key that should be used exclusively for encryption.
KeyForEncryption() - Constructor for class org.c02e.jpgpj.key.KeyForEncryption
Constructs a new empty key.
KeyForEncryption(List<Subkey>) - Constructor for class org.c02e.jpgpj.key.KeyForEncryption
Constructs a new key with the specified subkeys.
KeyForEncryption(String) - Constructor for class org.c02e.jpgpj.key.KeyForEncryption
Loads first key from the specified armored text.
KeyForEncryption(File) - Constructor for class org.c02e.jpgpj.key.KeyForEncryption
Loads first key from the specified file.
KeyForEncryption(InputStream) - Constructor for class org.c02e.jpgpj.key.KeyForEncryption
Loads first key from the specified input stream.
KeyForSigning - Class in org.c02e.jpgpj.key
Key that should be used exclusively for signing.
KeyForSigning() - Constructor for class org.c02e.jpgpj.key.KeyForSigning
Constructs a new empty key.
KeyForSigning(List<Subkey>) - Constructor for class org.c02e.jpgpj.key.KeyForSigning
Constructs a new key with the specified subkeys.
KeyForSigning(String) - Constructor for class org.c02e.jpgpj.key.KeyForSigning
Loads first key from the specified armored text.
KeyForSigning(String, char[]) - Constructor for class org.c02e.jpgpj.key.KeyForSigning
Loads first key from the specified armored text, and sets the passphrase of all subkeys to the specified passphrase.
KeyForSigning(String, String) - Constructor for class org.c02e.jpgpj.key.KeyForSigning
Loads first key from the specified armored text, and sets the passphrase of all subkeys to the specified passphrase.
KeyForSigning(File) - Constructor for class org.c02e.jpgpj.key.KeyForSigning
Loads first key from the specified file.
KeyForSigning(File, char[]) - Constructor for class org.c02e.jpgpj.key.KeyForSigning
Loads first key from the specified file, and sets the passphrase of all subkeys to the specified passphrase.
KeyForSigning(File, String) - Constructor for class org.c02e.jpgpj.key.KeyForSigning
Loads first key from the specified file, and sets the passphrase of all subkeys to the specified passphrase.
KeyForSigning(InputStream) - Constructor for class org.c02e.jpgpj.key.KeyForSigning
Loads first key from the specified input stream.
KeyForSigning(InputStream, char[]) - Constructor for class org.c02e.jpgpj.key.KeyForSigning
Loads first key from the specified input stream, and sets the passphrase of all subkeys to the specified passphrase.
KeyForSigning(InputStream, String) - Constructor for class org.c02e.jpgpj.key.KeyForSigning
Loads first key from the specified input stream, and sets the passphrase of all subkeys to the specified passphrase.
KeyForVerification - Class in org.c02e.jpgpj.key
Key that should be used exclusively for encryption.
KeyForVerification() - Constructor for class org.c02e.jpgpj.key.KeyForVerification
Constructs a new empty key.
KeyForVerification(List<Subkey>) - Constructor for class org.c02e.jpgpj.key.KeyForVerification
Constructs a new key with the specified subkeys.
KeyForVerification(String) - Constructor for class org.c02e.jpgpj.key.KeyForVerification
Loads first key from the specified armored text.
KeyForVerification(File) - Constructor for class org.c02e.jpgpj.key.KeyForVerification
Loads first key from the specified file.
KeyForVerification(InputStream) - Constructor for class org.c02e.jpgpj.key.KeyForVerification
Loads first key from the specified input stream.

L

load(String) - Method in class org.c02e.jpgpj.Key
Loads first key from the specified armored text.
load(File) - Method in class org.c02e.jpgpj.Key
Loads first key from the specified file.
load(InputStream) - Method in class org.c02e.jpgpj.Key
Loads first key from the specified input stream.
load(String) - Method in class org.c02e.jpgpj.Ring
Loads all keys from the specified armored text, and adds them to this ring's existing list of keys.
load(File) - Method in class org.c02e.jpgpj.Ring
Loads all keys from the specified file, and adds them to this ring's existing list of keys.
load(InputStream) - Method in class org.c02e.jpgpj.Ring
Loads all keys from the specified input stream, and adds them to this ring's existing list of keys.

M

matches(String) - Method in class org.c02e.jpgpj.Key
True if the string is a case-insensitive substring of either: any subkey's full ID (eg "0x1234567890ABCDEF") any subkey's fingerprint (eg "1234567890ABCDEF1234567890ABCDEF12345678") any one of any subkey's user IDs (eg "Alice (work) <alice@example.com>")
matches(Pattern) - Method in class org.c02e.jpgpj.Key
True if the specified pattern matches any part of either: any subkey's full ID (eg "0x1234567890ABCDEF") any subkey's fingerprint (eg "1234567890ABCDEF1234567890ABCDEF12345678") any one of any subkey's user IDs (eg "Alice (work) <alice@example.com>")
matches(String) - Method in class org.c02e.jpgpj.Subkey
True if the string is a case-insensitive substring of either: the subkey's full ID (eg "0x1234567890ABCDEF"); the subkey's fingerprint (eg "1234567890ABCDEF1234567890ABCDEF12345678"); any subkey's user IDs (eg "Alice (work) <alice@example.com>")
matches(Pattern) - Method in class org.c02e.jpgpj.Subkey
True if the specified pattern matches any part of either: the subkey's full ID (eg "0x1234567890ABCDEF"); the subkey's fingerprint (eg "1234567890ABCDEF1234567890ABCDEF12345678"); any subkey's user IDs (eg "Alice (work) <alice@example.com>")
MAX_ENCRYPT_COPY_BUFFER_SIZE - Static variable in class org.c02e.jpgpj.Encryptor
 

N

NO_PASSPHRASE - Static variable in class org.c02e.jpgpj.Key
Use this value to set the passphrase of a passphrase-less key.

O

org.c02e.jpgpj - package org.c02e.jpgpj
 
org.c02e.jpgpj.key - package org.c02e.jpgpj.key
 
org.c02e.jpgpj.util - package org.c02e.jpgpj.util
 

P

PassphraseException - Exception in org.c02e.jpgpj
Indicates an incorrect passphrase was used to unlock a key.
PassphraseException(String) - Constructor for exception org.c02e.jpgpj.PassphraseException
 
PassphraseException(String, Exception) - Constructor for exception org.c02e.jpgpj.PassphraseException
 
prepareAsciiArmoredHeaders(Encryptor, FileMetadata, EncryptedAsciiArmorHeadersManipulator) - Method in interface org.c02e.jpgpj.EncryptedAsciiArmorHeadersCallback
Invoked by the encryptor after updating the settings with the configured global headers.
prepareCiphertextOutputStream(FileMetadata, File) - Method in class org.c02e.jpgpj.Encryptor
Builds a wrapper OutputStream where everything written to the it is encrypted+compressed+signed according to the encryptor's configuration, and then written to the specified target file.
prepareCiphertextOutputStream(FileMetadata, Path) - Method in class org.c02e.jpgpj.Encryptor
Builds a wrapper OutputStream where everything written to the it is encrypted+compressed+signed according to the encryptor's configuration, and then written to the specified target file.
prepareCiphertextOutputStream(OutputStream, FileMetadata, boolean) - Method in class org.c02e.jpgpj.Encryptor
Builds a new wrapper OutputStream to wrap the original specified OutputStream, where everything written to the it is automatically encrypted+compressed+signed according to the encryptor's configuration, and then written to the original stream.

R

removeArmoredHeader(String) - Method in class org.c02e.jpgpj.Encryptor
Removes the specified armored header Note: affects the output only if armored setting is used.
removeHeader(String) - Method in interface org.c02e.jpgpj.EncryptedAsciiArmorHeadersManipulator
Removes specified header - no-op if header not set anyway
Ring - Class in org.c02e.jpgpj
A collection of Keys.
Ring() - Constructor for class org.c02e.jpgpj.Ring
Constructs a new empty ring.
Ring(Key...) - Constructor for class org.c02e.jpgpj.Ring
Constructs a new ring with the specified array of keys.
Ring(List<Key>) - Constructor for class org.c02e.jpgpj.Ring
Constructs a new ring with the specified list of keys.
Ring(String) - Constructor for class org.c02e.jpgpj.Ring
Loads all keys from the specified armored text.
Ring(File) - Constructor for class org.c02e.jpgpj.Ring
Loads all keys from the specified file.
Ring(InputStream) - Constructor for class org.c02e.jpgpj.Ring
Loads all keys from the specified input stream.

S

setArmoredHeaders(Map<String, String>) - Method in class org.c02e.jpgpj.Encryptor
Replaces the current armored headers with the provided ones.
setArmorHeadersCallback(EncryptedAsciiArmorHeadersCallback) - Method in class org.c02e.jpgpj.Encryptor
Allows users to provide a callback that will be invoked for each encrypted armored output in order to allow them to set specified headers besides the global ones set by the encryptor.
setAsciiArmored(boolean) - Method in class org.c02e.jpgpj.Encryptor
 
setCompressionAlgorithm(CompressionAlgorithm) - Method in class org.c02e.jpgpj.Encryptor
 
setCompressionLevel(int) - Method in class org.c02e.jpgpj.Encryptor
 
setCopyFileBufferSize(int) - Method in class org.c02e.jpgpj.Decryptor
 
setEncryptionAlgorithm(EncryptionAlgorithm) - Method in class org.c02e.jpgpj.Encryptor
 
setFile(File) - Method in class org.c02e.jpgpj.FileMetadata
 
setFile(Path) - Method in class org.c02e.jpgpj.FileMetadata
 
setForDecryption(boolean) - Method in class org.c02e.jpgpj.Subkey
True if the subkey should be used for decrypting messages.
setForEncryption(boolean) - Method in class org.c02e.jpgpj.Subkey
True if the subkey should be used for encrypting messages.
setFormat(FileMetadata.Format) - Method in class org.c02e.jpgpj.FileMetadata
 
setForSigning(boolean) - Method in class org.c02e.jpgpj.Subkey
True if the subkey should be used for signing messages.
setForVerification(boolean) - Method in class org.c02e.jpgpj.Subkey
True if the subkey should be used for verifying messages.
setHeader(String, String) - Method in interface org.c02e.jpgpj.EncryptedAsciiArmorHeadersManipulator
Set the specified header value - replace any previous value
setKey(Key) - Method in class org.c02e.jpgpj.FileMetadata.Signature
Key used for signature, or null.
setKeyDeriviationAlgorithm(HashingAlgorithm) - Method in class org.c02e.jpgpj.Encryptor
 
setKeyDeriviationWorkFactor(int) - Method in class org.c02e.jpgpj.Encryptor
 
setKeyId(long) - Method in class org.c02e.jpgpj.FileMetadata.Signature
ID of subkey used for signature.
setLastModified(long) - Method in class org.c02e.jpgpj.FileMetadata
 
setLength(long) - Method in class org.c02e.jpgpj.FileMetadata
 
setLoggingEnabled(boolean) - Method in class org.c02e.jpgpj.Decryptor
 
setLoggingEnabled(boolean) - Method in class org.c02e.jpgpj.Encryptor
 
setMaxFileBufferSize(int) - Method in class org.c02e.jpgpj.Decryptor
Decryptor will choose the most appropriate read/write buffer size for each file.
setMaxFileBufferSize(int) - Method in class org.c02e.jpgpj.Encryptor
 
setName(String) - Method in class org.c02e.jpgpj.FileMetadata
 
setNoPassphrase(boolean) - Method in class org.c02e.jpgpj.Key
True to flag all subkeys as needing no passphrase to unlock; false to require a passphrase to be (re-)set on all subkeys.
setNoPassphrase(boolean) - Method in class org.c02e.jpgpj.Subkey
True if no passphrase is needed to unlock the private part of the subkey's public key-pair.
setPassphrase(String) - Method in class org.c02e.jpgpj.Key
Sets the passphrase of all subkeys.
setPassphrase(String) - Method in class org.c02e.jpgpj.Subkey
Passphrase needed to unlock the private part of the subkey's public key-pair; or empty string.
setPassphraseChars(char[]) - Method in class org.c02e.jpgpj.Key
Sets the passphrase of all subkeys.
setPassphraseChars(char[]) - Method in class org.c02e.jpgpj.Subkey
Passphrase needed to unlock the private part of the subkey's public key-pair; or empty char[].
setPublicKey(PGPPublicKey) - Method in class org.c02e.jpgpj.Subkey
Bouncy castle public-key pair, containing only the public part of the pair; or null.
setRemoveDefaultArmoredVersionHeader(boolean) - Method in class org.c02e.jpgpj.Encryptor
By default the ArmoredOutputStream adds a "Version" header - this setting allows users to remove this header (and perhaps replace it and/or add others - see headers manipulation methods).
setRing(Ring) - Method in class org.c02e.jpgpj.Decryptor
 
setRing(Ring) - Method in class org.c02e.jpgpj.Encryptor
 
setSecretKey(PGPSecretKey) - Method in class org.c02e.jpgpj.Subkey
Bouncy castle public-key pair, containing both the public and private parts of the pair; or null.
setSecurityProvider(Provider) - Static method in class org.c02e.jpgpj.JcaContextHelper
Set the security provider to be used for all operations.
setSigningAlgorithm(HashingAlgorithm) - Method in class org.c02e.jpgpj.Encryptor
 
setSigningUid(String) - Method in class org.c02e.jpgpj.Key
User ID to use for signing, or empty string.
setSymmetricPassphrase(String) - Method in class org.c02e.jpgpj.Decryptor
 
setSymmetricPassphrase(String) - Method in class org.c02e.jpgpj.Encryptor
 
setSymmetricPassphraseChars(char[]) - Method in class org.c02e.jpgpj.Decryptor
 
setSymmetricPassphraseChars(char[]) - Method in class org.c02e.jpgpj.Encryptor
 
setVerificationRequired(boolean) - Method in class org.c02e.jpgpj.Decryptor
 
setVerificationType(Decryptor.VerificationType) - Method in class org.c02e.jpgpj.Decryptor
Type of signature verification.
setVerified(boolean) - Method in class org.c02e.jpgpj.FileMetadata.Signature
True if signature was verified.
setVerifiedKey(Key) - Method in class org.c02e.jpgpj.FileMetadata.Signature
Key used for signature if verified, or null.
Signature() - Constructor for class org.c02e.jpgpj.FileMetadata.Signature
Constructs blank signature object.
Signature(long) - Constructor for class org.c02e.jpgpj.FileMetadata.Signature
Constructs unverified signature object for the specified subkey ID.
Signature(long, Key) - Constructor for class org.c02e.jpgpj.FileMetadata.Signature
Constructs unverified signature object for the specified key.
stream - Variable in class org.c02e.jpgpj.util.FileDetection.DetectionResult
Wrapper around original input stream.
Subkey - Class in org.c02e.jpgpj
A single public-key pair from a full Key.
Subkey() - Constructor for class org.c02e.jpgpj.Subkey
Constructs a blank subkey.

T

toPublicKey() - Method in class org.c02e.jpgpj.Key
Creates a copy of this with only the public parts of the key.
toString() - Method in class org.c02e.jpgpj.DecryptionResult
 
toString() - Method in class org.c02e.jpgpj.FileMetadata
 
toString() - Method in class org.c02e.jpgpj.Key
Display string for the key, including each subkey's usage flags, short ID, and user IDs.
toString() - Method in class org.c02e.jpgpj.Ring
Display string for this ring, including listing each key on the ring, with each subkey's usage flags, short ID, and user IDs.
toString() - Method in class org.c02e.jpgpj.Subkey
Display string for the subkey, including its usage flags, short ID, and user IDs.
type - Variable in class org.c02e.jpgpj.util.FileDetection.DetectionResult
Container type that was detected.

U

unlock(char[]) - Method in class org.c02e.jpgpj.Subkey
Extracts the private key material from this subkey's secret key using the specified passphrase, and caches it in memory until Subkey.clearSecrets() is called.
updateArmoredHeader(String, String) - Method in class org.c02e.jpgpj.Encryptor
Sets the specified header value - replaces it if already set.
updateHeaders(Map<String, String>) - Method in interface org.c02e.jpgpj.EncryptedAsciiArmorHeadersManipulator
Replaces existing headers and adds missing ones
Util - Class in org.c02e.jpgpj.util
Utility functions, used internally by JPGPJ.
Util() - Constructor for class org.c02e.jpgpj.util.Util
 

V

valueOf(String) - Static method in enum org.c02e.jpgpj.CompressionAlgorithm
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.c02e.jpgpj.Decryptor.VerificationType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.c02e.jpgpj.EncryptionAlgorithm
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.c02e.jpgpj.FileMetadata.Format
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.c02e.jpgpj.HashingAlgorithm
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.c02e.jpgpj.util.FileDetection.ContainerType
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.c02e.jpgpj.CompressionAlgorithm
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.c02e.jpgpj.Decryptor.VerificationType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.c02e.jpgpj.EncryptionAlgorithm
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.c02e.jpgpj.FileMetadata.Format
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.c02e.jpgpj.HashingAlgorithm
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.c02e.jpgpj.util.FileDetection.ContainerType
Returns an array containing the constants of this enum type, in the order they are declared.
VerificationException - Exception in org.c02e.jpgpj
Indicates verification failed, either because the message was not signed with at least one required key, or because the signature of a required key was invalid.
VerificationException(String) - Constructor for exception org.c02e.jpgpj.VerificationException
 
VerificationException(String, Exception) - Constructor for exception org.c02e.jpgpj.VerificationException
 

W

withArmoredHeader(String, String) - Method in class org.c02e.jpgpj.Encryptor
 
withArmoredHeaders(Map<String, String>) - Method in class org.c02e.jpgpj.Encryptor
 
withArmorHeadersCallback(EncryptedAsciiArmorHeadersCallback) - Method in class org.c02e.jpgpj.Encryptor
 
withAsciiArmored(boolean) - Method in class org.c02e.jpgpj.Encryptor
 
withCompressionAlgorithm(CompressionAlgorithm) - Method in class org.c02e.jpgpj.Encryptor
 
withCompressionLevel(int) - Method in class org.c02e.jpgpj.Encryptor
 
withCopyFileBufferSize(int) - Method in class org.c02e.jpgpj.Decryptor
 
withDeriviationAlgorithm(HashingAlgorithm) - Method in class org.c02e.jpgpj.Encryptor
 
withEncryptionAlgorithm(EncryptionAlgorithm) - Method in class org.c02e.jpgpj.Encryptor
 
withFile(File) - Method in class org.c02e.jpgpj.FileMetadata
 
withFile(Path) - Method in class org.c02e.jpgpj.FileMetadata
 
withFormat(FileMetadata.Format) - Method in class org.c02e.jpgpj.FileMetadata
 
withKeyDeriviationWorkFactor(int) - Method in class org.c02e.jpgpj.Encryptor
 
withLastModified(long) - Method in class org.c02e.jpgpj.FileMetadata
 
withLength(long) - Method in class org.c02e.jpgpj.FileMetadata
 
withLoggingEnabled(boolean) - Method in class org.c02e.jpgpj.Decryptor
 
withLoggingEnabled(boolean) - Method in class org.c02e.jpgpj.Encryptor
 
withMaxFileBufferSize(int) - Method in class org.c02e.jpgpj.Decryptor
 
withMaxFileBufferSize(int) - Method in class org.c02e.jpgpj.Encryptor
 
withName(String) - Method in class org.c02e.jpgpj.FileMetadata
 
withRemoveDefaultArmoredVersionHeader(boolean) - Method in class org.c02e.jpgpj.Encryptor
 
withRing(Ring) - Method in class org.c02e.jpgpj.Decryptor
 
withRing(Ring) - Method in class org.c02e.jpgpj.Encryptor
 
withSigningAlgorithm(HashingAlgorithm) - Method in class org.c02e.jpgpj.Encryptor
 
withSymmetricPassphrase(String) - Method in class org.c02e.jpgpj.Decryptor
 
withSymmetricPassphrase(String) - Method in class org.c02e.jpgpj.Encryptor
 
withSymmetricPassphraseChars(char[]) - Method in class org.c02e.jpgpj.Decryptor
 
withSymmetricPassphraseChars(char[]) - Method in class org.c02e.jpgpj.Encryptor
 
withVerificationRequired(boolean) - Method in class org.c02e.jpgpj.Decryptor
 
withVerificationType(Decryptor.VerificationType) - Method in class org.c02e.jpgpj.Decryptor
Type of signature verification.
wrap(ArmoredOutputStream) - Static method in interface org.c02e.jpgpj.EncryptedAsciiArmorHeadersManipulator
Wraps an ArmoredOutputStream
wrapSourceInputStream(InputStream, long) - Method in class org.c02e.jpgpj.Decryptor
 
wrapSourceInputStream(InputStream, long) - Method in class org.c02e.jpgpj.Encryptor
 
wrapTargetOutputStream(OutputStream, long) - Method in class org.c02e.jpgpj.Decryptor
 
wrapTargetOutputStream(OutputStream, long) - Method in class org.c02e.jpgpj.Encryptor
 
A B C D E F G H I J K L M N O P R S T U V W 
Skip navigation links