Index

A B C D E F G H I J K L M N O P R S T U V W Z
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

addArmoredHeaders(Map<String, String>) - Method in class org.c02e.jpgpj.Encryptor

Adds the specified headers - replaces existing ones and adds the new ones.

Aead - Enum constant in enum class org.c02e.jpgpj.EncryptionProtection

RFC 9580 AEAD-protected symmetric encryption.

AeadAlgorithm - Enum Class in org.c02e.jpgpj

AEAD mode for OpenPGP symmetric encryption (RFC 9580 / LibrePGP).

AeadPacketStyle - Enum Class in org.c02e.jpgpj

AEAD packet layout version used when EncryptionProtection.Aead is selected.

AES128 - Enum constant in enum class org.c02e.jpgpj.EncryptionAlgorithm

AES192 - Enum constant in enum class org.c02e.jpgpj.EncryptionAlgorithm

AES256 - Enum constant in enum class org.c02e.jpgpj.EncryptionAlgorithm

applyPassphraseDerivation(PGPEncryptedDataList) - Method in class org.c02e.jpgpj.EncryptionDetails

applyS2kFrom(PGPPBEEncryptedData) - Method in class org.c02e.jpgpj.EncryptionDetails

Argon2 - Enum constant in enum class org.c02e.jpgpj.PassphraseKeyDerivation

Argon2 S2K (RFC 9580 / GnuPG 2.4+).

Argon2Parameters - Class in org.c02e.jpgpj

Argon2 parameters for symmetric passphrase encryption (RFC 9580).

Argon2Parameters(int, int, int) - Constructor for class org.c02e.jpgpj.Argon2Parameters

asBoolean() - Method in class org.c02e.jpgpj.Ring

True if this contains at least one key.

ASCII_ARMOR - Enum constant in enum class org.c02e.jpgpj.util.FileDetection.ContainerType

ASCII armor container.

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(long) - Method in class org.c02e.jpgpj.Encryptor

Calculates optimal PGP packet size, based on plaintext length.

bestPacketSize(FileMetadata) - Method in class org.c02e.jpgpj.Encryptor

Calculates optimal PGP packet size, based on plaintext length.

BINARY - Enum constant in enum class org.c02e.jpgpj.FileMetadata.Format

No line-ending normalization (default).

Blowfish - Enum constant in enum class org.c02e.jpgpj.EncryptionAlgorithm

byCode(char) - Static method in enum class org.c02e.jpgpj.FileMetadata.Format

BZip2 - Enum constant in enum class org.c02e.jpgpj.CompressionAlgorithm

C

Camellia128 - Enum constant in enum class org.c02e.jpgpj.EncryptionAlgorithm

Camellia192 - Enum constant in enum class org.c02e.jpgpj.EncryptionAlgorithm

Camellia256 - Enum constant in enum class org.c02e.jpgpj.EncryptionAlgorithm

CAST5 - Enum constant in enum class org.c02e.jpgpj.EncryptionAlgorithm

Classic - Enum constant in enum class org.c02e.jpgpj.OpenPgpProfile

RFC 4880 / gpg 2.2 era: AES128, MDC, SHA512 signing, SHA512 iterated+salted S2K, ZLIB compression.

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 Class in org.c02e.jpgpj

Available compression algorithms for compressing message content.

copy() - Method in class org.c02e.jpgpj.EncryptionDetails

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(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.

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.

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(Key...) - Constructor for class org.c02e.jpgpj.Decryptor

Constructs a decryptor with the specified keys.

Decryptor(Ring) - Constructor for class org.c02e.jpgpj.Decryptor

Constructs a decryptor with the specified key ring.

Decryptor.VerificationType - Enum Class 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_AEAD_ALGORITHM - Static variable in class org.c02e.jpgpj.Encryptor

DEFAULT_AEAD_CHUNK_SIZE - Static variable in class org.c02e.jpgpj.Encryptor

AEAD chunk size octet (RFC 9580: 2^(value + 6) bytes; 6 = 4096 bytes).

DEFAULT_AEAD_PACKET_STYLE - Static variable in class org.c02e.jpgpj.Encryptor

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_ENCRYPTION_PROTECTION - 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_OPENPGP_PROFILE - Static variable in class org.c02e.jpgpj.Encryptor

DEFAULT_PASSPHRASE_KEY_DERIVATION - Static variable in class org.c02e.jpgpj.Encryptor

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

Eax - Enum constant in enum class org.c02e.jpgpj.AeadAlgorithm

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(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.

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.

encryptBytes(byte[], String, File) - Method in class org.c02e.jpgpj.Encryptor

encryptBytes(byte[], String, OutputStream) - Method in class org.c02e.jpgpj.Encryptor

encryptBytes(byte[], String, Path) - 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 Class in org.c02e.jpgpj

Available symmetric-key encryption algorithms for encrypting message content.

EncryptionDetails - Class in org.c02e.jpgpj

Encryption parameters detected or applied to a message.

EncryptionDetails() - Constructor for class org.c02e.jpgpj.EncryptionDetails

EncryptionProtection - Enum Class in org.c02e.jpgpj

How the symmetric session key protects the encrypted payload.

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(Key...) - Constructor for class org.c02e.jpgpj.Encryptor

Constructs an encryptor with the specified keys.

Encryptor(Ring) - Constructor for class org.c02e.jpgpj.Encryptor

Constructs an encryptor with the specified key ring.

equals(Object) - Method in class org.c02e.jpgpj.Argon2Parameters

equals(Object) - Method in class org.c02e.jpgpj.EncryptionDetails

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 Class 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(File) - 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(Path) - Constructor for class org.c02e.jpgpj.FileMetadata

Constructs a metadata object from a file.

FileMetadata(PGPLiteralData) - Constructor for class org.c02e.jpgpj.FileMetadata

Constructs a metadata object from Bouncy Castle message data.

FileMetadata.Format - Enum Class in org.c02e.jpgpj

Format for line-ending normalization.

FileMetadata.Signature - Class in org.c02e.jpgpj

Signature found by decryptor.

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.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(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.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(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.

fromBc(S2K.Argon2Params) - Static method in class org.c02e.jpgpj.Argon2Parameters

fromEncryptedData(PGPEncryptedData) - Static method in class org.c02e.jpgpj.EncryptionDetails

fromEncryptedData(PGPEncryptedData, Integer) - Static method in class org.c02e.jpgpj.EncryptionDetails

fromOpenPgpTag(int) - Static method in enum class org.c02e.jpgpj.AeadAlgorithm

fromOpenPgpTag(int) - Static method in enum class org.c02e.jpgpj.EncryptionAlgorithm

Resolves a Bouncy Castle / OpenPGP cipher tag to the matching enum value, or null if unknown.

fromOpenPgpTag(int) - Static method in enum class org.c02e.jpgpj.HashingAlgorithm

Resolves a Bouncy Castle / OpenPGP hash tag to the matching enum value, or null if unknown.

G

Gcm - Enum constant in enum class org.c02e.jpgpj.AeadAlgorithm

getAeadAlgorithm() - Method in class org.c02e.jpgpj.EncryptionDetails

getAeadAlgorithm() - Method in class org.c02e.jpgpj.Encryptor

getAeadChunkSize() - Method in class org.c02e.jpgpj.EncryptionDetails

getAeadChunkSize() - Method in class org.c02e.jpgpj.Encryptor

getAeadPacketStyle() - Method in class org.c02e.jpgpj.EncryptionDetails

getAeadPacketStyle() - Method in class org.c02e.jpgpj.Encryptor

getArgon2Parameters() - Method in class org.c02e.jpgpj.EncryptionDetails

getArgon2Parameters() - Method in class org.c02e.jpgpj.Encryptor

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 class org.c02e.jpgpj.FileMetadata.Format

getCompressionAlgorithm() - Method in class org.c02e.jpgpj.Encryptor

getCompressionBuffer(long) - Method in class org.c02e.jpgpj.Encryptor

Internal buffer for compressed-data packets, sized based on plaintext length.

getCompressionBuffer(FileMetadata) - 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(long) - Method in class org.c02e.jpgpj.Encryptor

Internal buffer for copying plaintext into the encryption pipeline, sized based on plaintext length.

getCopyBuffer(FileMetadata) - 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.

getDetectedProfile() - Method in class org.c02e.jpgpj.EncryptionDetails

getEncryption() - Method in class org.c02e.jpgpj.Key

Last subkey that can encrypt, or null.

getEncryptionAlgorithm() - Method in class org.c02e.jpgpj.Encryptor

getEncryptionBuffer(long) - Method in class org.c02e.jpgpj.Encryptor

Internal buffer for encrypted-data packets, sized based on plaintext length.

getEncryptionBuffer(FileMetadata) - Method in class org.c02e.jpgpj.Encryptor

Internal buffer for encrypted-data packets, sized based on plaintext length.

getEncryptionDetails() - Method in class org.c02e.jpgpj.FileMetadata

Encryption parameters detected during decryption, or null if unencrypted.

getEncryptionKeys() - Method in class org.c02e.jpgpj.Ring

All keys that can encrypt, or an empty list.

getEncryptionProtection() - Method in class org.c02e.jpgpj.Encryptor

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

getHashAlgorithm() - Method in class org.c02e.jpgpj.FileMetadata.Signature

Hash algorithm used for this signature, if known.

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(long) - Method in class org.c02e.jpgpj.Encryptor

Internal buffer for literal-data packets, sized based on plaintext length.

getLiteralBuffer(FileMetadata) - 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

getMemorySizeExponent() - Method in class org.c02e.jpgpj.Argon2Parameters

Memory cost as exponent: allocated memory is 2^memorySizeExponent KiB.

getName() - Method in class org.c02e.jpgpj.FileMetadata

getOpenPgpProfile() - Method in class org.c02e.jpgpj.Encryptor

getOpenPgpTag() - Method in enum class org.c02e.jpgpj.AeadAlgorithm

getOpenPgpTag() - Method in enum class org.c02e.jpgpj.CompressionAlgorithm

OpenPGP compression algorithm tag.

getOpenPgpTag() - Method in enum class org.c02e.jpgpj.EncryptionAlgorithm

OpenPGP symmetric cipher tag (RFC 4880 / RFC 9580).

getOpenPgpTag() - Method in enum class org.c02e.jpgpj.HashingAlgorithm

OpenPGP hash algorithm tag (RFC 4880 / RFC 9580).

getParallelism() - Method in class org.c02e.jpgpj.Argon2Parameters

getPasses() - Method in class org.c02e.jpgpj.Argon2Parameters

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[].

getPassphraseKeyDerivation() - Method in class org.c02e.jpgpj.EncryptionDetails

getPassphraseKeyDerivation() - Method in class org.c02e.jpgpj.Encryptor

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.

getProtection() - Method in class org.c02e.jpgpj.EncryptionDetails

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.

getSessionCipher() - Method in class org.c02e.jpgpj.EncryptionDetails

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.

GPG_RECOMMENDED - Static variable in class org.c02e.jpgpj.Argon2Parameters

H

hashCode() - Method in class org.c02e.jpgpj.Argon2Parameters

hashCode() - Method in class org.c02e.jpgpj.EncryptionDetails

hashCode() - Method in class org.c02e.jpgpj.FileMetadata

HashingAlgorithm - Enum Class in org.c02e.jpgpj

Available hash algorithms for signing message content, and for deriving a symmetric key from a passphrase.

I

IDEA - Enum constant in enum class org.c02e.jpgpj.EncryptionAlgorithm

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.

IteratedSalted - Enum constant in enum class org.c02e.jpgpj.PassphraseKeyDerivation

Iterated+salted S2K with a hash algorithm and work factor (classic gpg).

J

JcaContextHelper - Class in org.c02e.jpgpj

Helper class for Java Cryptography Architecture (JCA) context consisting of provider.

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(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.

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(List<Subkey>) - Constructor for class org.c02e.jpgpj.Key

Constructs a new key with the specified subkeys.

KEYBOX - Enum constant in enum class org.c02e.jpgpj.util.FileDetection.ContainerType

GPG keybox container.

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(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.

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(List<Subkey>) - Constructor for class org.c02e.jpgpj.key.KeyForDecryption

Constructs a new key with the specified subkeys.

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(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.

KeyForEncryption(String) - Constructor for class org.c02e.jpgpj.key.KeyForEncryption

Loads first key from the specified armored text.

KeyForEncryption(List<Subkey>) - Constructor for class org.c02e.jpgpj.key.KeyForEncryption

Constructs a new key with the specified subkeys.

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(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.

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(List<Subkey>) - Constructor for class org.c02e.jpgpj.key.KeyForSigning

Constructs a new key with the specified subkeys.

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(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.

KeyForVerification(String) - Constructor for class org.c02e.jpgpj.key.KeyForVerification

Loads first key from the specified armored text.

KeyForVerification(List<Subkey>) - Constructor for class org.c02e.jpgpj.key.KeyForVerification

Constructs a new key with the specified subkeys.

L

load(File) - Method in class org.c02e.jpgpj.Key

Loads first key from the specified file.

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.Key

Loads first key from the specified input stream.

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.

load(String) - Method in class org.c02e.jpgpj.Key

Loads first key from the specified armored text.

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.

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(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.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(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

MD5 - Enum constant in enum class org.c02e.jpgpj.HashingAlgorithm

Mdc - Enum constant in enum class org.c02e.jpgpj.EncryptionProtection

RFC 4880 modification detection code (MDC).

MEMORY_CONSTRAINED - Static variable in class org.c02e.jpgpj.Argon2Parameters

Modern - Enum constant in enum class org.c02e.jpgpj.OpenPgpProfile

RFC 9580 / gpg 2.4+ era: AES256, AEAD-OCB v6, SHA512 signing, Argon2 S2K when passphrase-encrypting, ZLIB compression.

N

NO_PASSPHRASE - Static variable in class org.c02e.jpgpj.Key

Use this value to set the passphrase of a passphrase-less key.

None - Enum constant in enum class org.c02e.jpgpj.Decryptor.VerificationType

No signature verification.

O

Ocb - Enum constant in enum class org.c02e.jpgpj.AeadAlgorithm

OpenPgpProfile - Enum Class in org.c02e.jpgpj

High-level interop preset analogous to GnuPG defaults for a given era.

Optional - Enum constant in enum class org.c02e.jpgpj.Decryptor.VerificationType

Optional signature verification.

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

PassphraseKeyDerivation - Enum Class in org.c02e.jpgpj

How a symmetric passphrase is stretched into a session key for encryption.

PBE_ENCRYPTED_DATA_KEY_DATA_FIELD - Static variable in class org.c02e.jpgpj.EncryptionDetails

Bouncy Castle internal field name on PGPPBEEncryptedData; accessed reflectively for S2K metadata.

PGP - Enum constant in enum class org.c02e.jpgpj.util.FileDetection.ContainerType

PGP binary container.

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(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.

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.

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

Required - Enum constant in enum class org.c02e.jpgpj.Decryptor.VerificationType

Full signature verification.

Reserved4 - Enum constant in enum class org.c02e.jpgpj.HashingAlgorithm

Reserved5 - Enum constant in enum class org.c02e.jpgpj.EncryptionAlgorithm

Reserved5 - Enum constant in enum class org.c02e.jpgpj.HashingAlgorithm

Reserved6 - Enum constant in enum class org.c02e.jpgpj.EncryptionAlgorithm

Reserved6 - Enum constant in enum class org.c02e.jpgpj.HashingAlgorithm

Reserved7 - Enum constant in enum class org.c02e.jpgpj.HashingAlgorithm

Ring - Class in org.c02e.jpgpj

A collection of Keys.

Ring() - Constructor for class org.c02e.jpgpj.Ring

Constructs a new empty ring.

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.

Ring(String) - Constructor for class org.c02e.jpgpj.Ring

Loads all keys from the specified armored text.

Ring(List<Key>) - Constructor for class org.c02e.jpgpj.Ring

Constructs a new ring with the specified list of keys.

Ring(Key...) - Constructor for class org.c02e.jpgpj.Ring

Constructs a new ring with the specified array of keys.

RIPEMD160 - Enum constant in enum class org.c02e.jpgpj.HashingAlgorithm

S

SECURITY_PROVIDER_PROPERTY - Static variable in class org.c02e.jpgpj.JcaContextHelper

setAeadAlgorithm(AeadAlgorithm) - Method in class org.c02e.jpgpj.EncryptionDetails

setAeadAlgorithm(AeadAlgorithm) - Method in class org.c02e.jpgpj.Encryptor

setAeadChunkSize(int) - Method in class org.c02e.jpgpj.EncryptionDetails

setAeadChunkSize(int) - Method in class org.c02e.jpgpj.Encryptor

setAeadPacketStyle(AeadPacketStyle) - Method in class org.c02e.jpgpj.EncryptionDetails

setAeadPacketStyle(AeadPacketStyle) - Method in class org.c02e.jpgpj.Encryptor

setArgon2Parameters(Argon2Parameters) - Method in class org.c02e.jpgpj.EncryptionDetails

setArgon2Parameters(Argon2Parameters) - Method in class org.c02e.jpgpj.Encryptor

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

setDetectedProfile(OpenPgpProfile) - Method in class org.c02e.jpgpj.EncryptionDetails

setEncryptionAlgorithm(EncryptionAlgorithm) - Method in class org.c02e.jpgpj.Encryptor

setEncryptionDetails(EncryptionDetails) - Method in class org.c02e.jpgpj.FileMetadata

Encryption parameters detected during decryption.

setEncryptionProtection(EncryptionProtection) - 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.

setHashAlgorithm(HashingAlgorithm) - Method in class org.c02e.jpgpj.FileMetadata.Signature

Hash algorithm used for this signature, if known.

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.

setOpenPgpProfile(OpenPgpProfile) - Method in class org.c02e.jpgpj.Encryptor

Applies algorithm defaults for the specified profile.

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[].

setPassphraseKeyDerivation(PassphraseKeyDerivation) - Method in class org.c02e.jpgpj.EncryptionDetails

setPassphraseKeyDerivation(PassphraseKeyDerivation) - Method in class org.c02e.jpgpj.Encryptor

setProtection(EncryptionProtection) - Method in class org.c02e.jpgpj.EncryptionDetails

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.

setSessionCipher(EncryptionAlgorithm) - Method in class org.c02e.jpgpj.EncryptionDetails

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.

SHA1 - Enum constant in enum class org.c02e.jpgpj.HashingAlgorithm

SHA224 - Enum constant in enum class org.c02e.jpgpj.HashingAlgorithm

SHA256 - Enum constant in enum class org.c02e.jpgpj.HashingAlgorithm

SHA3_256 - Enum constant in enum class org.c02e.jpgpj.HashingAlgorithm

SHA3_512 - Enum constant in enum class org.c02e.jpgpj.HashingAlgorithm

SHA384 - Enum constant in enum class org.c02e.jpgpj.HashingAlgorithm

SHA512 - Enum constant in enum class org.c02e.jpgpj.HashingAlgorithm

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

TEXT - Enum constant in enum class org.c02e.jpgpj.FileMetadata.Format

Text with CRLF line-endings.

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.Argon2Parameters

toString() - Method in class org.c02e.jpgpj.DecryptionResult

toString() - Method in class org.c02e.jpgpj.EncryptionDetails

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.

TripleDES - Enum constant in enum class org.c02e.jpgpj.EncryptionAlgorithm

Twofish - Enum constant in enum class org.c02e.jpgpj.EncryptionAlgorithm

type - Variable in class org.c02e.jpgpj.util.FileDetection.DetectionResult

Container type that was detected.

U

Uncompressed - Enum constant in enum class org.c02e.jpgpj.CompressionAlgorithm

Unencrypted - Enum constant in enum class org.c02e.jpgpj.EncryptionAlgorithm

UNKNOWN - Enum constant in enum class org.c02e.jpgpj.util.FileDetection.ContainerType

Not a recognized format.

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.

Unsigned - Enum constant in enum class org.c02e.jpgpj.HashingAlgorithm

JPGPJ sentinel for unsigned content; not passed to Bouncy Castle.

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

UTF8 - Enum constant in enum class org.c02e.jpgpj.FileMetadata.Format

UTF-8 encoded text with CRLF line-endings.

Util - Class in org.c02e.jpgpj.util

Utility functions, used internally by JPGPJ.

Util() - Constructor for class org.c02e.jpgpj.util.Util

V

V5 - Enum constant in enum class org.c02e.jpgpj.AeadPacketStyle

OpenPGP v5 AEAD packet layout.

V6 - Enum constant in enum class org.c02e.jpgpj.AeadPacketStyle

OpenPGP v6 AEAD packet layout (GnuPG 2.4+ default for modern keys).

valueOf(String) - Static method in enum class org.c02e.jpgpj.AeadAlgorithm

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.c02e.jpgpj.AeadPacketStyle

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.c02e.jpgpj.CompressionAlgorithm

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.c02e.jpgpj.Decryptor.VerificationType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.c02e.jpgpj.EncryptionAlgorithm

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.c02e.jpgpj.EncryptionProtection

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.c02e.jpgpj.FileMetadata.Format

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.c02e.jpgpj.HashingAlgorithm

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.c02e.jpgpj.OpenPgpProfile

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.c02e.jpgpj.PassphraseKeyDerivation

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.c02e.jpgpj.util.FileDetection.ContainerType

Returns the enum constant of this class with the specified name.

values() - Static method in enum class org.c02e.jpgpj.AeadAlgorithm

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class org.c02e.jpgpj.AeadPacketStyle

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class org.c02e.jpgpj.CompressionAlgorithm

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class org.c02e.jpgpj.Decryptor.VerificationType

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class org.c02e.jpgpj.EncryptionAlgorithm

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class org.c02e.jpgpj.EncryptionProtection

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class org.c02e.jpgpj.FileMetadata.Format

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class org.c02e.jpgpj.HashingAlgorithm

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class org.c02e.jpgpj.OpenPgpProfile

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class org.c02e.jpgpj.PassphraseKeyDerivation

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class org.c02e.jpgpj.util.FileDetection.ContainerType

Returns an array containing the constants of this enum class, 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

withAeadAlgorithm(AeadAlgorithm) - Method in class org.c02e.jpgpj.Encryptor

withAeadChunkSize(int) - Method in class org.c02e.jpgpj.Encryptor

withAeadPacketStyle(AeadPacketStyle) - Method in class org.c02e.jpgpj.Encryptor

withArgon2Parameters(Argon2Parameters) - Method in class org.c02e.jpgpj.Encryptor

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

withEncryptionDetails(EncryptionDetails) - Method in class org.c02e.jpgpj.FileMetadata

withEncryptionProtection(EncryptionProtection) - 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

withModernDefaults() - Method in class org.c02e.jpgpj.Encryptor

Convenience for Encryptor.setOpenPgpProfile(OpenPgpProfile) with OpenPgpProfile.Modern.

withName(String) - Method in class org.c02e.jpgpj.FileMetadata

withOpenPgpProfile(OpenPgpProfile) - Method in class org.c02e.jpgpj.Encryptor

withPassphraseKeyDerivation(PassphraseKeyDerivation) - Method in class org.c02e.jpgpj.Encryptor

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

Z

ZIP - Enum constant in enum class org.c02e.jpgpj.CompressionAlgorithm

ZLIB - Enum constant in enum class org.c02e.jpgpj.CompressionAlgorithm

A B C D E F G H I J K L M N O P R S T U V W Z
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form