A B C D E F G H I K L M N P R S T U V W Z

A

addCertification(long, long, String, String) - Method in class com.didisoft.pgp.KeyStore

Appends certification to a given OpenPGP key in the key store.

AES_128 - Static variable in interface com.didisoft.pgp.CypherAlgorithm

128 bit AES (Rijndael)

AES_192 - Static variable in interface com.didisoft.pgp.CypherAlgorithm

192 bit AES (Rijndael)

AES_256 - Static variable in interface com.didisoft.pgp.CypherAlgorithm

256 bit AES (Rijndael)

assignDesignatedRevoker(String, String, String, String) - Method in class com.didisoft.pgp.RevocationLib

Authorizes the specified key as a designated revoker for this key.

assignDesignatedRevoker(KeyStore, long, String, long) - Method in class com.didisoft.pgp.RevocationLib

Authorizes the specified key as designated revoker for this key.

assignDesignatedRevoker(KeyStore, String, String, String) - Method in class com.didisoft.pgp.RevocationLib

Authorizes the specified key as designated revoker for this key.

B

BLOWFISH - Static variable in interface com.didisoft.pgp.CypherAlgorithm

Blowfish

BZIP2 - Static variable in interface com.didisoft.pgp.CompressionAlgorithm

C

CAST5 - Static variable in interface com.didisoft.pgp.CypherAlgorithm

CAST 5 (Default).

changePrivateKeyPassword(String, String, String) - Method in class com.didisoft.pgp.KeyStore

Changes private key password.

changePrivateKeyPassword(long, String, String) - Method in class com.didisoft.pgp.KeyStore

Changes private key password.

changePrivateKeyPassword(String, String) - Method in class com.didisoft.pgp.PGPKeyPair

Changes the password of this private key.

checkPassword(String) - Method in class com.didisoft.pgp.KeyPairInformation

Checks if a password for a private key is correct

checkPassword(String, String) - Static method in class com.didisoft.pgp.KeyStore

Checks if a password for a key store file is correct Example usage:

clearSignFile(String, String, String, String, String) - Method in class com.didisoft.pgp.PGPLib

OpenPGP clear signs a file.

clearSignFileVersion3(String, String, String, String, String) - Method in class com.didisoft.pgp.PGPLib

OpenPGP clear signs a file, using OpenPGP version 3 signature format (old format used by PGP 2.x)

Use when needed compatibility with PGP 2.x

GPG equivalent command: gpg --force-v3-sigs --clearsign inputFileName

Example:

clearSignString(String, String, String, String) - Method in class com.didisoft.pgp.PGPLib

OpenPGP clear signs a String

Example usage:

clearSignStringVersion3(String, String, String, String) - Method in class com.didisoft.pgp.PGPLib

OpenPGP clear signs a String, using OpenPGP version 3 signature format (the old format)

Use when needed compatibility with PGP 2.x and PGP 5.x systems.

com.didisoft.pgp - package com.didisoft.pgp

Provides easy OpenPGP API for Java Developers.

com.didisoft.pgp.exceptions - package com.didisoft.pgp.exceptions

Detailed OpenPGP exceptions extending BouncyCastle PGPException

CompressionAlgorithm - Interface in com.didisoft.pgp

Interface that lists the supported compression algorithms for OpenPGP encryption.

containsKey(String) - Method in class com.didisoft.pgp.KeyStore

Returns true if public or private key with the specified User ID exists in this KeyStore

Example:

containsKey(long) - Method in class com.didisoft.pgp.KeyStore

Returns true if a public or private key with the specified Key Id exists in this KeyStore

Example:

containsPrivateKey(String) - Method in class com.didisoft.pgp.KeyStore

Returns true if a private key with the specified User ID exists in this KeyStore

Example:

containsPrivateKey(long) - Method in class com.didisoft.pgp.KeyStore

Returns true if a private key with the specified Key Id exists in this KeyStore

Example:

containsPublicKey(String) - Method in class com.didisoft.pgp.KeyStore

Returns true if a public key with the specified User ID exists in this KeyStore

Example:

containsPublicKey(long) - Method in class com.didisoft.pgp.KeyStore

Returns true if a public key with the specified Key Id exists in this KeyStore

Example:

createRevocationCertificateInFile(String, String, byte, String, String) - Method in class com.didisoft.pgp.RevocationLib

Creates a key revocation certificate for a given OpenPGP key file and stores it in a file.

createRevocationCertificateInFile(KeyStore, long, String, byte, String, String) - Method in class com.didisoft.pgp.RevocationLib

Creates a key revocation certificate for a given OpenPGP key located in a KeyStore and stores it in a file.

createRevocationCertificateInFile(KeyStore, String, String, byte, String, String) - Method in class com.didisoft.pgp.RevocationLib

Creates a key revocation certificate for a given OpenPGP key located in a KeyStore and stores it in a file.

createRevocationCertificateText(String, String, byte, String) - Method in class com.didisoft.pgp.RevocationLib

Creates a revocation certificate in ASCII armored string format for a given OpenPGP key.

createRevocationCertificateText(KeyStore, long, String, byte, String) - Method in class com.didisoft.pgp.RevocationLib

Creates a revocation certificate for a given OpenPGP key in ASCII armored string format.

createRevocationCertificateText(KeyStore, String, String, byte, String) - Method in class com.didisoft.pgp.RevocationLib

Creates a revocation certificate for a given OpenPGP key in ASCII armored string format.

CypherAlgorithm - Interface in com.didisoft.pgp

Interface that lists the supported symmetric encryption algorithms used in the library.

D

decryptAndVerifyFile(String, KeyStore, String, String) - Method in class com.didisoft.pgp.PGPLib

Decrypts and verifies one pass encrypted and signed OpenPGP file
Supports OpenPGP version 3 format too (used by PGP 6.5 and below).

decryptAndVerifyFile(String, String, String, String, String) - Method in class com.didisoft.pgp.PGPLib

Decrypts and verifies an OpenPGP encrypted and signed file
Supports OpenPGP version 3 format too (used by PGP(r) 5 and below).

decryptAndVerifyFileTo(String, KeyStore, String, String) - Method in class com.didisoft.pgp.PGPLib

Decrypts and verifies one pass encrypted and signed OpenPGP file
Supports OpenPGP version 3 format too (used by PGP 6.5 and below).

decryptAndVerifyFileTo(String, String, String, String, String) - Method in class com.didisoft.pgp.PGPLib

Decrypts and verifies an OpenPGP encrypted and signed file to a folder
This methods is very suitable for multi file PGP archives.

decryptAndVerifyStream(InputStream, KeyStore, String, OutputStream) - Method in class com.didisoft.pgp.PGPLib

Decrypts and verifies OpenPGP encrypted and signed stream.

decryptAndVerifyStream(InputStream, InputStream, String, InputStream, OutputStream) - Method in class com.didisoft.pgp.PGPLib

Decrypts and verifies OpenPGP encrypted and signed stream.

decryptAndVerifyStreamTo(InputStream, InputStream, String, InputStream, String) - Method in class com.didisoft.pgp.PGPLib

Decrypts and verifies OpenPGP encrypted and signed stream.

decryptAndVerifyStreamTo(InputStream, KeyStore, String, String) - Method in class com.didisoft.pgp.PGPLib

Decrypts and verifies OpenPGP encrypted and signed stream.

decryptAndVerifyString(String, String, String, String, StringBuffer) - Method in class com.didisoft.pgp.PGPLib

Decrypts and verifies an OpenPGP one pass signed end encrypted message.

decryptAndVerifyString(String, String, String, String, StringBuffer, String) - Method in class com.didisoft.pgp.PGPLib

Decrypts and verifies an OpenPGP one pass signed end encrypted message.

decryptFile(String, KeyStore, String, String) - Method in class com.didisoft.pgp.PGPLib

Decrypts an OpenPGP encrypted file using key from a OpenPGP key store.

decryptFile(String, String, String, String) - Method in class com.didisoft.pgp.PGPLib

Decrypts an OpenPGP encrypted file using Private key file.

decryptFile(String, InputStream, String, String) - Method in class com.didisoft.pgp.PGPLib

Decrypts an OpenPGP encrypted file using Private key input stream.

decryptFilePBE(String, String, String) - Method in class com.didisoft.pgp.PGPLib

Decrypts an OpenPGP file that was encrypted with password (PBE, symmetric key encrypted).

decryptFileTo(String, String, String, String) - Method in class com.didisoft.pgp.PGPLib

Decrypts the content of an OpenPGP encrypted file into a folder.

decryptFileTo(String, KeyStore, String, String) - Method in class com.didisoft.pgp.PGPLib

Decrypts the content of an OpenPGP encrypted file into a folder.

decryptStream(InputStream, InputStream, String, OutputStream) - Method in class com.didisoft.pgp.PGPLib

Decrypts an OpenPGP encrypted stream using Private key input stream.

decryptStream(InputStream, KeyStore, String, OutputStream) - Method in class com.didisoft.pgp.PGPLib

Decrypts an OpenPGP encrypted stream using Private key input stream.

decryptStreamTo(InputStream, InputStream, String, String) - Method in class com.didisoft.pgp.PGPLib

Decrypts an OpenPGP encrypted stream to a specified folder.

decryptStreamTo(InputStream, KeyStore, String, String) - Method in class com.didisoft.pgp.PGPLib

Decrypts an OpenPGP encrypted stream to a specified folder.

deleteKeyPair(String) - Method in class com.didisoft.pgp.KeyStore

Deletes the first public and private key pair from this key store that have the specified User Id.

deleteKeyPair(long) - Method in class com.didisoft.pgp.KeyStore

Deletes public and private key pair from this key store that have the specified Key Id.

deletePrivateKey(String) - Method in class com.didisoft.pgp.KeyStore

Deletes the first private key with the specified User Id from this KeyStore.

deletePrivateKey(long) - Method in class com.didisoft.pgp.KeyStore

Deletes the first private key with the specified User Id from this KeyStore.

deletePublicKey(String) - Method in class com.didisoft.pgp.KeyStore

Deletes the first public key with the specified User Id from this KeyStore.

deletePublicKey(long) - Method in class com.didisoft.pgp.KeyStore

Deletes the first public key with the specified Key Id from this KeyStore.

DES - Static variable in interface com.didisoft.pgp.CypherAlgorithm

DES

DSA - Static variable in class com.didisoft.pgp.KeyStore

DSA Algorithm constant, implementation of DH/DSS (signature)

E

ELGAMAL - Static variable in interface com.didisoft.pgp.KeyAlgorithm

ElGamal.

ELGAMAL - Static variable in class com.didisoft.pgp.KeyStore

ElGamal Algorithm constant, implementation of DH/DSS (encryption)

ENCRYPTED - Static variable in class com.didisoft.pgp.PGPFileInformation

encryptFile(String, String, String, boolean) - Method in class com.didisoft.pgp.PGPLib

OpenPGP encrypts given file using the public key of the recipient.

encryptFile(String, String, String, boolean, boolean) - Method in class com.didisoft.pgp.PGPLib

OpenPGP encrypts given file using the public key of the recipient.

encryptFile(String, String[], String, boolean, boolean) - Method in class com.didisoft.pgp.PGPLib

OpenPGP encrypts a file for multiple recipients.


Compression algorithm used is the one specified with PGPLib.setCompression(String)
Symmetric cipher algorithm used is the one specified with PGPLib.setCypher(String)

Example usage:

encryptFile(String, KeyStore, String[], String, boolean, boolean) - Method in class com.didisoft.pgp.PGPLib

OpenPGP encrypts a file for multiple recipients.


Compression algorithm used is the one specified with PGPLib.setCompression(String)
Symmetric cipher algorithm used is the one specified with PGPLib.setCypher(String)

Example:

encryptFile(String, KeyStore, long[], String, boolean, boolean) - Method in class com.didisoft.pgp.PGPLib

OpenPGP encrypts a file for multiple recipients.


Compression algorithm used is the one specified with PGPLib.setCompression(String)
Symmetric cipher algorithm used is the one specified with PGPLib.setCypher(String)

Example:

encryptFile(String, InputStream, String, boolean, boolean) - Method in class com.didisoft.pgp.PGPLib

OpenPGP encrypts given file using the first available public key from a key ring input stream

Compression algorithm used is the one specified with PGPLib.setCompression(String)
Symmetric cipher algorithm used is the one specified with PGPLib.setCypher(String)

Example:

encryptFile(String, KeyStore, String, String, boolean, boolean) - Method in class com.didisoft.pgp.PGPLib

OpenPGP encrypts given file using specified public key, stored in specified OpenPGP key store.

encryptFile(String, KeyStore, String, String) - Method in class com.didisoft.pgp.PGPLib

OpenPGP encrypts given file using specified public key, stored in specified OpenPGP key store.

encryptFile(String, KeyStore, long, String, boolean, boolean) - Method in class com.didisoft.pgp.PGPLib

OpenPGP encrypts given file using specified public key, stored in specified OpenPGP key store.

encryptFile(String, KeyStore, long, String) - Method in class com.didisoft.pgp.PGPLib

OpenPGP encrypts given file using specified public key, stored in specified OpenPGP key store.

encryptFileByKeyId(KeyStore, String, String, String) - Method in class com.didisoft.pgp.PGPLib

Deprecated. Use instead

encryptFileByUserId(KeyStore, String, String, String) - Method in class com.didisoft.pgp.PGPLib

Deprecated. Use instead

encryptFilePBE(String, String, String, String, boolean, boolean) - Method in class com.didisoft.pgp.PGPLib

Encrypts a file with a public key and a passphrase.
The passphrase can be used to decrypt the file if the corressponding private key is lost.

encryptFilePBE(String, String, String, boolean, boolean) - Method in class com.didisoft.pgp.PGPLib

Encrypts a file with a passphrase.
The same passphrase is used to decrypt the file

Equivalent GnuPG command:
gpg -c -e [dataFileName]

Compression algorithm used is the one specified with PGPLib.setCompression(String) if supported by the public key, otherwise the first supported by the key algorithm is used.

encryptFiles(String[], String[], String, boolean, boolean) - Method in class com.didisoft.pgp.PGPLib

OpenPGP encrypts multiple files into one OpenPGP archive.

encryptFiles(String[], KeyStore, String[], String, boolean, boolean) - Method in class com.didisoft.pgp.PGPLib

OpenPGP encrypts multiple files into one OpenPGP archive

Compression algorithm used is the one specified with PGPLib.setCompression(String)
Symmetric cipher algorithm used is the one specified with PGPLib.setCypher(String)

Example:

encryptFiles(String[], KeyStore, long[], String, boolean, boolean) - Method in class com.didisoft.pgp.PGPLib

OpenPGP encrypts multiple files into one OpenPGP archive

Compression algorithm used is the one specified with PGPLib.setCompression(String)
Symmetric cipher algorithm used is the one specified with PGPLib.setCypher(String)

Example usage:

encryptStream(InputStream, String, long, String, OutputStream, boolean) - Method in class com.didisoft.pgp.PGPLib

OpenPGP encrypts stream using the first available public key from a key ring file.

encryptStream(InputStream, String, long, String, OutputStream, boolean, boolean) - Method in class com.didisoft.pgp.PGPLib

OpenPGP encrypts stream using the first available public key from a key ring file.

encryptStream(InputStream, String, KeyStore, String, OutputStream, boolean, boolean) - Method in class com.didisoft.pgp.PGPLib

OpenPGP Encrypts Input Stream using a Public key located in a KeyStore

Compression algorithm used is the one specified with PGPLib.setCompression(String) if supported by the public key, otherwise the first supported by the key algorithm is used.

encryptStream(InputStream, String, KeyStore, long, OutputStream, boolean, boolean) - Method in class com.didisoft.pgp.PGPLib

OpenPGP encrypts input stream using a recipient public key located in a KeyStore

Compression algorithm used is the one specified with PGPLib.setCompression(String) if supported by the public key, otherwise the first supported by the key algorithm is used.

encryptStream(InputStream, String, long, InputStream, OutputStream, boolean, boolean) - Method in class com.didisoft.pgp.PGPLib

OpenPGP encrypts an input stream using the first available public key supplied as an input stream

Compression algorithm used is the one specified with PGPLib.setCompression(String) if supported by the public key, otherwise the first supported by the key algorithm is used.

encryptStream(InputStream, String, InputStream, OutputStream, boolean, boolean) - Method in class com.didisoft.pgp.PGPLib

OpenPGP Encrypts Input Stream using the first available Public key from a Key ring input stream

Compression algorithm used is the one specified with PGPLib.setCompression(String) if supported by the public key, otherwise the first supported by the key algorithm is used.

encryptStreamPBE(InputStream, String, String, OutputStream, boolean, boolean) - Method in class com.didisoft.pgp.PGPLib

Encrypts an input stream with a password based OpenPGP encryption (PBE)

Compression algorithm used is the one specified with PGPLib.setCompression(String) if supported by the public key, otherwise the first supported by the key algorithm is used.

exportKeyRing(String, boolean) - Method in class com.didisoft.pgp.KeyPairInformation

Exports the key pair (both the public and the private key if available) located in this object in one file.

exportKeyRing(String, String) - Method in class com.didisoft.pgp.KeyStore

Exports Key ring (both public and private key) located in this Key store in one file.

exportPrivateKey(String, boolean) - Method in class com.didisoft.pgp.KeyPairInformation

Exports the private key part of this key pair into a file.

exportPrivateKey(String, String, boolean) - Method in class com.didisoft.pgp.KeyStore

Exports private key from this OpenPGP key store, into a file.

exportPrivateKey(String, long, boolean) - Method in class com.didisoft.pgp.KeyStore

Exports private key from this KeyStore instance, into a file.

exportPublicKey(String, boolean) - Method in class com.didisoft.pgp.KeyPairInformation

Exports the public key part of this key pair into a file.

exportPublicKey(String, String, boolean) - Method in class com.didisoft.pgp.KeyStore

Exports public key from this KeyStore instance into a file.

exportPublicKey(String, long, boolean) - Method in class com.didisoft.pgp.KeyStore

Exports public key from this KeyStore instance into a file.

F

FileIsEncryptedException - Class in com.didisoft.pgp.exceptions

Exception that indicates that a file is encrypted.

FileIsEncryptedException(String) - Constructor for class com.didisoft.pgp.exceptions.FileIsEncryptedException

FileIsEncryptedException(String, Exception) - Constructor for class com.didisoft.pgp.exceptions.FileIsEncryptedException

G

generateKeyPair(int, String, String) - Method in class com.didisoft.pgp.KeyStore

Generates OpenPGP Key pair with RSA encryption and predefined values for compression, hashing and cypher like the ones generated with PGP Desktop(tm) key generation wizard.

generateKeyPair(int, String, String, String, String[], String[], String[]) - Method in class com.didisoft.pgp.KeyStore

Generates OpenPGP key pair (public and private key).

generateKeyPair(int, String, String, String, String[], String[], String[], long) - Method in class com.didisoft.pgp.KeyStore

Generates OpenPGP key pair (public and private key).

generateKeyPair(int, String, String, String, String, String, String) - Method in class com.didisoft.pgp.KeyStore

Generates OpenPGP Key pair (public and private key).

generateKeyPair(int, String, String, String, String, String, String, long) - Method in class com.didisoft.pgp.KeyStore

Generates OpenPGP Key pair (public and private key).

generateKeyPair(int, String, String, String, String[], String[], String[], long) - Static method in class com.didisoft.pgp.PGPKeyPair

Generates OpenPGP Key pair (public and private key).

getAction() - Method in class com.didisoft.pgp.PGPFileInformation

getAlgorithm() - Method in class com.didisoft.pgp.KeyPairInformation

Returns the name of the key encryption asymmetric algorithm.

getCompression() - Method in class com.didisoft.pgp.PGPLib

Returns the preferred compression algorithm used by all methods that produce OpenPGP messages (e.g Encrypt, Sign, etc.)
Default is ZIP

getCreationTime() - Method in class com.didisoft.pgp.KeyPairInformation

Returns when was the key created.

getCypher() - Method in class com.didisoft.pgp.PGPLib

Returns the preferred symmetric key algorithm used by all methods that produce OpenPGP messages (e.g Encrypt, Sign, etc.)
Default is CAST5

getFiles() - Method in class com.didisoft.pgp.PGPFileInformation

getFingerprint() - Method in class com.didisoft.pgp.KeyPairInformation

Returns the key fingerprint as string.

getKeyHexIds() - Method in class com.didisoft.pgp.KeyStore

Returns array of Hexadecimal string representation of the key Id's for the keys contained in this KeyStore instance.

getKeyID() - Method in class com.didisoft.pgp.KeyPairInformation

Returns the Key ID of this key pair.

getKeyIdForKeyIdHex(String) - Method in class com.didisoft.pgp.KeyStore

Returns the real Key ID (of type long) corresponding to this Hexadecimal Key Id.

getKeyIdForUserId(String) - Method in class com.didisoft.pgp.KeyStore

Returns the real Key ID (of type long) corresponding to this User Id.

getKeyIDHex() - Method in class com.didisoft.pgp.KeyPairInformation

Returns a string representing the hexadecimal value of the Key ID.

getKeys() - Method in class com.didisoft.pgp.KeyStore

Returns the key pairs stored in this OpenPGP key store.

getKeySize() - Method in class com.didisoft.pgp.KeyPairInformation

Returns key size in bits.

getKeystoreFileName() - Method in class com.didisoft.pgp.KeyStore

Returns this Key store file name (absolute or relative path)

getKeystorePassword() - Method in class com.didisoft.pgp.KeyStore

Returns The password of this KeyStore

getPrivateSubKeys() - Method in class com.didisoft.pgp.KeyPairInformation

Returns an array from all private sub keys.

getPublicSubKeys() - Method in class com.didisoft.pgp.KeyPairInformation

Returns an array from all public sub keys.

getRawPrivateKeyRing() - Method in class com.didisoft.pgp.KeyPairInformation

Returns the Private key ring part of this Key Pair.

getRawPublicKeyRing() - Method in class com.didisoft.pgp.KeyPairInformation

Returns the Public key ring part of this Key Pair

getTrust() - Method in class com.didisoft.pgp.KeyPairInformation

Returns the trust data assigned to this key

getUserIDs() - Method in class com.didisoft.pgp.KeyPairInformation

Returns User Id's associated with this key.

getUserIds() - Method in class com.didisoft.pgp.KeyStore

Returns array of Strings representing all user Id's contained in this KeyStore instance.

getValidDays() - Method in class com.didisoft.pgp.KeyPairInformation

Returns key validity period in days.

getVersion() - Method in class com.didisoft.pgp.KeyPairInformation

Returns key format OpenPGP version.

H

HashAlgorithm - Interface in com.didisoft.pgp

Interface that lists the supported hashing algorithms used in the library.

hasPrivateKey() - Method in class com.didisoft.pgp.KeyPairInformation

Returns is there a private key in this key pair.

I

IDEA - Static variable in interface com.didisoft.pgp.CypherAlgorithm

IDEA.

importKeyRing(String) - Method in class com.didisoft.pgp.KeyStore

Imports OpenPGP key ring into this KeyStore instance.

importKeyRing(String, String) - Method in class com.didisoft.pgp.KeyStore

Imports OpenPGP key ring into this KeyStore instance.

importPrivateKey(String) - Method in class com.didisoft.pgp.KeyStore

Imports a private key file into this KeyStore instance.

importPrivateKey(String, String) - Method in class com.didisoft.pgp.KeyStore

Imports private key file into this KeyStore instance.

importPublicKey(String) - Method in class com.didisoft.pgp.KeyStore

Imports Public key into this KeyStore instance.

importPublickKey(String) - Method in class com.didisoft.pgp.KeyStore

Deprecated. Replaced by KeyStore.importPublicKey(String)

isAutoSave() - Method in class com.didisoft.pgp.KeyStore

Returns is auto save on.

isBackupOnSave() - Method in class com.didisoft.pgp.KeyStore

Returns should backups be made on save.

isEncryptionKey() - Method in class com.didisoft.pgp.KeyPairInformation

Returns true if this key can be used for encryption, otherwise false

isExpired() - Method in class com.didisoft.pgp.KeyPairInformation

Returns is this key expired (not usable any more).

isExpiredOnDate(Date) - Method in class com.didisoft.pgp.KeyPairInformation

Returns will this key be expired on a given date

isRevoked() - Method in class com.didisoft.pgp.KeyPairInformation

Returns is this Key revoked (not usable any more).

isSigningKey() - Method in class com.didisoft.pgp.KeyPairInformation

Returns is this Key used for signing data.

isTrusted(String) - Method in class com.didisoft.pgp.KeyStore

Returns is a public key with the suppled Key User Id trusted in this key store.

isTrusted(long) - Method in class com.didisoft.pgp.KeyStore

Returns is a public key with the suppled Key Id trusted in this key store.

isUseExpiredKeys() - Method in class com.didisoft.pgp.PGPLib

Returns should expired keys still be used
Default is false

isUseRevokedKeys() - Method in class com.didisoft.pgp.PGPLib

Returns should revoked keys still be used
Default is false

K

KeyAlgorithm - Interface in com.didisoft.pgp

Interface that lists the supported asymmetric algorithms for OpenPGP keys.

KeyIsExpiredException - Class in com.didisoft.pgp.exceptions

Exception that indicates that a supplied key is expired.

KeyIsExpiredException(String) - Constructor for class com.didisoft.pgp.exceptions.KeyIsExpiredException

KeyIsExpiredException(String, Exception) - Constructor for class com.didisoft.pgp.exceptions.KeyIsExpiredException

KeyIsRevokedException - Class in com.didisoft.pgp.exceptions

Exception that indicates that a supplied key is revoked.

KeyIsRevokedException(String) - Constructor for class com.didisoft.pgp.exceptions.KeyIsRevokedException

KeyIsRevokedException(String, Exception) - Constructor for class com.didisoft.pgp.exceptions.KeyIsRevokedException

KeyPairInformation - Class in com.didisoft.pgp

Represents an OpenPGP key pair.

KeyPairInformation() - Constructor for class com.didisoft.pgp.KeyPairInformation

KeyStore - Class in com.didisoft.pgp

Represents an OpenPGP Key Store.

KeyStore(String, String) - Constructor for class com.didisoft.pgp.KeyStore

Creates a new Key Store object.

L

listKeys() - Method in class com.didisoft.pgp.KeyStore

Lists keys stored in this OpenPGP key store to Stestem.out like PGP (r) 6.5

Example:

M

MARGINAL - Static variable in interface com.didisoft.pgp.TrustLevel

Partially trusted

MD2 - Static variable in interface com.didisoft.pgp.HashAlgorithm

Message Digest 2

MD5 - Static variable in interface com.didisoft.pgp.HashAlgorithm

Message Digest 5

N

NONE - Static variable in interface com.didisoft.pgp.TrustLevel

Not trusted or not verified yet

NonPGPDataException - Class in com.didisoft.pgp.exceptions

Exception that indicates that a supplied data is not a valid OpenPGP message.

NonPGPDataException(String) - Constructor for class com.didisoft.pgp.exceptions.NonPGPDataException

NonPGPDataException(String, Exception) - Constructor for class com.didisoft.pgp.exceptions.NonPGPDataException

NoPrivateKeyFoundException - Class in com.didisoft.pgp.exceptions

Exception that indicates that a private key has not been found in a supplied file/stream parameter.

NoPrivateKeyFoundException(String) - Constructor for class com.didisoft.pgp.exceptions.NoPrivateKeyFoundException

NoPrivateKeyFoundException(String, Exception) - Constructor for class com.didisoft.pgp.exceptions.NoPrivateKeyFoundException

NoPublicKeyFoundException - Class in com.didisoft.pgp.exceptions

Exception that indicates that a public key has not been found in a supplied file/stream parameter.

NoPublicKeyFoundException(String) - Constructor for class com.didisoft.pgp.exceptions.NoPublicKeyFoundException

NoPublicKeyFoundException(String, Exception) - Constructor for class com.didisoft.pgp.exceptions.NoPublicKeyFoundException

P

PGPException - Class in com.didisoft.pgp

PGPException(String) - Constructor for class com.didisoft.pgp.PGPException

PGPException(String, Exception) - Constructor for class com.didisoft.pgp.PGPException

PGPFileInformation - Class in com.didisoft.pgp

Reserved for future releases.

PGPFileInformation() - Constructor for class com.didisoft.pgp.PGPFileInformation

PGPKeyPair - Class in com.didisoft.pgp

Represents an OpenPGP key loaded from a key file.

PGPKeyPair(String) - Constructor for class com.didisoft.pgp.PGPKeyPair

Initializes the object from a PGP key file.

PGPKeyPair(String, String) - Constructor for class com.didisoft.pgp.PGPKeyPair

Initializes the object from a public and private PGP key files.

PGPLib - Class in com.didisoft.pgp

OpenPGP Library for Java.

PGPLib() - Constructor for class com.didisoft.pgp.PGPLib

R

REASON_KEY_COMPROMISED - Static variable in class com.didisoft.pgp.RevocationLib

Revocation code: Key has been compromised

REASON_KEY_NO_LONGER_USED - Static variable in class com.didisoft.pgp.RevocationLib

Revocation code: Key is no longer used

REASON_KEY_SUPERSEDED - Static variable in class com.didisoft.pgp.RevocationLib

Revocation code: Key is superseded

REASON_NO_REASON - Static variable in class com.didisoft.pgp.RevocationLib

Revocation code: No reason specified

REASON_USER_NO_LONGER_USED - Static variable in class com.didisoft.pgp.RevocationLib

Revocation code: User Id is no longer used

RevocationLib - Class in com.didisoft.pgp

OpenPGP Key Revocation Library for Java.

RevocationLib() - Constructor for class com.didisoft.pgp.RevocationLib

Constructor that initializes the revocation library class.

revokeKey(KeyStore, long, String, byte, String) - Method in class com.didisoft.pgp.RevocationLib

Revokes a public key or sub key from a KeyStore.

revokeKey(KeyStore, String, String, byte, String) - Method in class com.didisoft.pgp.RevocationLib

Revokes a public key or sub key from a KeyStore.

revokeKey(String, String, String, byte, String) - Method in class com.didisoft.pgp.RevocationLib

Revokes a public key.

revokeKeyWithDesignatedRevoker(String, String, String, byte, String) - Method in class com.didisoft.pgp.RevocationLib

Revokes an OpenPGP public key with a designated revoker private key file.

revokeKeyWithDesignatedRevoker(KeyStore, long, long, String, byte, String) - Method in class com.didisoft.pgp.RevocationLib

Revokes an OpenPGP public key located in a KeyStore with a designated revoker.

revokeKeyWithDesignatedRevoker(KeyStore, String, String, String, byte, String) - Method in class com.didisoft.pgp.RevocationLib

Revokes an OpenPGP public key located in a KeyStore with a designated revoker.

revokeKeyWithRevocationCertificateFile(String, String) - Method in class com.didisoft.pgp.RevocationLib

Revokes a key or subkey from an OpenPGP key ring file (*.asc, *.pkr) using a revocation certificate file.

revokeKeyWithRevocationCertificateFile(KeyStore, String) - Method in class com.didisoft.pgp.RevocationLib

Revokes a key or subkey from an OpenPGP key ring located in a KeyStore.

revokeKeyWithRevocationCertificateText(String, String) - Method in class com.didisoft.pgp.RevocationLib

Revokes a key or subkey from an OpenPGP key ring file (*.asc, *.pkr) using a revocation certificate supplied as text.

revokeKeyWithRevocationCertificateText(KeyStore, String) - Method in class com.didisoft.pgp.RevocationLib

Revokes a key or subkey located in an OpenPGP KeyStore using a revocation certificate supplied as text.

revokeUserIdSignature(String, String, String, String, byte, String) - Method in class com.didisoft.pgp.RevocationLib

Revokes a User Id signature binding from an OpenPGP public key file.

revokeUserIdSignature(KeyStore, long, String, String, byte, String) - Method in class com.didisoft.pgp.RevocationLib

Revokes a User Id signature binding from an OpenPGP public key located in a KeyStore
Note: the corresponding private key must also exist in this KeyStore in order the signature to be produced.

revokeUserIdSignature(KeyStore, String, String, byte, String) - Method in class com.didisoft.pgp.RevocationLib

Revokes a User Id signature binding from an OpenPGP public key located in a KeyStore
Note: if more than one key has this User ID signature use @link RevocationLib.revokeUserIdSignature(KeyStore, long, String, String, byte, String) instead

Equivalent GPG command:
gpg --edit-key [userId]
revsig

RIPEMD160 - Static variable in interface com.didisoft.pgp.HashAlgorithm

RIPEMD-160, 160-bit message digest algorithm (RACE Integrity Primitives Evaluation Message Digest)

RSA - Static variable in interface com.didisoft.pgp.KeyAlgorithm

RSA (Rivest, Shamir and Adleman algorithm)

RSA - Static variable in class com.didisoft.pgp.KeyStore

RSA Algorithm constant

S

SAFER - Static variable in interface com.didisoft.pgp.CypherAlgorithm

SAFER

save() - Method in class com.didisoft.pgp.KeyStore

Saves the backing file of this KeyStore instance to disk.

setAction(int) - Method in class com.didisoft.pgp.PGPFileInformation

setAutoSave(boolean) - Method in class com.didisoft.pgp.KeyStore

Sets the KeyStore to call save() automatically after each operation that modifies it (for example import key, delete key, etc.)

setBackupOnSave(boolean) - Method in class com.didisoft.pgp.KeyStore

Sets backup file be created (with extension .bak) for this KeyStore on save() operations.

setCompression(String) - Method in class com.didisoft.pgp.PGPLib

Sets the preferred compression algorithm used by all methods that produce OpenPGP messages (e.g Encrypt, Sign, etc.)

setCypher(String) - Method in class com.didisoft.pgp.PGPLib

Sets the preferred symmetric key algorithm used by all methods that produce OpenPGP messages (e.g Encrypt, Sign, etc.)

setFiles(List) - Method in class com.didisoft.pgp.PGPFileInformation

setHash(String) - Method in class com.didisoft.pgp.PGPLib

Sets the preferred hashing algorithm used by all methods that produce OpenPGP signature (all Sign and SigneAndEncrypt methods)

setPrivateKeyRing(PGPSecretKeyRing) - Method in class com.didisoft.pgp.KeyPairInformation

Sets the Private key ring part of this Key Pair.

setPublicKeyRing(PGPPublicKeyRing) - Method in class com.didisoft.pgp.KeyPairInformation

Sets the Public key ring part of this Key Pair.

setTrust(long, byte) - Method in class com.didisoft.pgp.KeyStore

Sets an internal trust value for a public key, valid only in this KeyStore instance

PGP command line (r) equivalent:
pgp --set-trust keyId --trust trustValue

setTrust(String, byte) - Method in class com.didisoft.pgp.KeyStore

Sets an internal trust value for a public key, valid only in this KeyStore instance

PGP command line (r) equivalent:
pgp --set-trust keyUserId --trust trustValue

setUseExpiredKeys(boolean) - Method in class com.didisoft.pgp.PGPLib

Sets should expired keys still be used

setUseRevokedKeys(boolean) - Method in class com.didisoft.pgp.PGPLib

Sets should revoked keys still be used

SHA1 - Static variable in interface com.didisoft.pgp.HashAlgorithm

Secure Hash Algorithm (SHA-1)

SHA224 - Static variable in interface com.didisoft.pgp.HashAlgorithm

Secure Hash Algorithm 224 bit (SHA-2 224)

SHA256 - Static variable in interface com.didisoft.pgp.HashAlgorithm

Secure Hash Algorithm 256 bit (SHA-2 256)

SHA384 - Static variable in interface com.didisoft.pgp.HashAlgorithm

Secure Hash Algorithm 384 bit (SHA-2 384)

SHA512 - Static variable in interface com.didisoft.pgp.HashAlgorithm

Secure Hash Algorithm 512 bit (SHA-2 512)

signAndEncryptFile(String, String, String, String, String, boolean) - Method in class com.didisoft.pgp.PGPLib

OpenPGP signs and encrypts a file in one pass.

signAndEncryptFile(String, String, String, String, String, boolean, boolean) - Method in class com.didisoft.pgp.PGPLib

OpenPGP signs and encrypts a file in one pass.

signAndEncryptFile(String, InputStream, String, InputStream, OutputStream, boolean, boolean) - Method in class com.didisoft.pgp.PGPLib

OpenPGP signs and encrypts a file in one pass.

signAndEncryptFile(String, KeyStore, String, String, String, String, boolean, boolean) - Method in class com.didisoft.pgp.PGPLib

OpenPGP signs and encrypts a file in one pass.

signAndEncryptFile(String, KeyStore, long, String, long, String, boolean, boolean) - Method in class com.didisoft.pgp.PGPLib

OpenPGP signs and encrypts a file in one pass.

signAndEncryptFileVersion3(String, String, String, String, String, boolean) - Method in class com.didisoft.pgp.PGPLib

OpenPGP signs and encrypts a file in one pass, using OpenPGP version 3 signature format (compatible with PGP 6.5 and below)

(Note that this is not the same as first encrypt and then sign a file, because in that case a double compression is performed.)
Compression algorithm used is the one specified with PGPLib.setCompression(String)
Symmetric cipher algorithm used is the one specified with PGPLib.setCypher(String)
Hashing algorithm used is the one specified with PGPLib.setHash(String)

Example:

signAndEncryptFileVersion3(String, String, String, String, String, boolean, boolean) - Method in class com.didisoft.pgp.PGPLib

OpenPGP signs and encrypts a file in one pass, using OpenPGP version 3 signature format (compatible with PGP 6.5 and below)

(Note that this is not the same as first encrypt and then sign a file, because in that case a double compression is performed.)
Compression algorithm used is the one specified with PGPLib.setCompression(String)
Symmetric cipher algorithm used is the one specified with PGPLib.setCypher(String)
Hashing algorithm used is the one specified with PGPLib.setHash(String)

Example:

signAndEncryptStream(InputStream, String, InputStream, String, InputStream, OutputStream, boolean, boolean) - Method in class com.didisoft.pgp.PGPLib

OpenPGP signs and encrypts a file in one pass.

signAndEncryptStream(InputStream, String, KeyStore, String, String, String, OutputStream, boolean, boolean) - Method in class com.didisoft.pgp.PGPLib

OpenPGP signs and encrypts a file in one pass.

signAndEncryptStreamVersion3(InputStream, String, InputStream, String, InputStream, OutputStream, boolean) - Method in class com.didisoft.pgp.PGPLib

OpenPGP signs and encrypts a file in one pass, using OpenPGP version 3 signature format (compatible with PGP 6.5 and below)
(Note that this is not the same as first encrypt and then sign a file, because in that case a double compression is performed.)
Compression algorithm used is the one specified with PGPLib.setCompression(String)
Symmetric cipher algorithm used is the one specified with PGPLib.setCypher(String)
Hashing algorithm used is the one specified with PGPLib.setHash(String)

Example:

signAndEncryptStreamVersion3(InputStream, String, InputStream, String, InputStream, OutputStream, boolean, boolean) - Method in class com.didisoft.pgp.PGPLib

OpenPGP signs and encrypts a file in one pass, using OpenPGP version 3 signature format (compatible with older PGP 2.x systems)
(Note that this is not the same as first encrypt and then sign a file, because in that case a double compression is performed.)
Compression algorithm used is the one specified with PGPLib.setCompression(String)
Symmetric cipher algorithm used is the one specified with PGPLib.setCypher(String)
Hashing algorithm used is the one specified with PGPLib.setHash(String)

Example:

signAndEncryptString(String, String, String, String) - Method in class com.didisoft.pgp.PGPLib

OpenPGP signs and encrypts a String message in one pass
The input String is assumed to be UTF-8 encoded.

signAndEncryptString(String, String, String, String, String) - Method in class com.didisoft.pgp.PGPLib

OpenPGP signs and encrypts a String message in one pass
Compression algorithm used is the one specified with PGPLib.setCompression(String)
Symmetric cipher algorithm used is the one specified with PGPLib.setCypher(String)
Hashing algorithm used is the one specified with PGPLib.setHash(String)

Example:

signAndEncryptStringVersion3(String, String, String, String) - Method in class com.didisoft.pgp.PGPLib

OpenPGP signs and encrypts a String message in one pass with OpenPGP version 3 signatures
The input String is assumed to be UTF-8 encoded.

signAndEncryptStringVersion3(String, String, String, String, String) - Method in class com.didisoft.pgp.PGPLib

OpenPGP signs and encrypts a String message in one pass creating OpenPGP version 3 signatures
Compression algorithm used is the one specified with PGPLib.setCompression(String)
Symmetric cipher algorithm used is the one specified with PGPLib.setCypher(String)
Hashing algorithm used is the one specified with PGPLib.setHash(String)

Example:

SIGNED - Static variable in class com.didisoft.pgp.PGPFileInformation

SIGNED_AND_ENCRYPTED - Static variable in class com.didisoft.pgp.PGPFileInformation

signFile(KeyStore, String, String, String, String) - Method in class com.didisoft.pgp.PGPLib

OpenPGP signs given file using specified Private Key, using OpenPGP Key Store.

signFile(KeyStore, String, long, String, String) - Method in class com.didisoft.pgp.PGPLib

OpenPGP signs given file using specified Private Key, using OpenPGP Key Store.

signFile(String, KeyStore, String, String, String, boolean) - Method in class com.didisoft.pgp.PGPLib

OpenPGP signs a file, with private key stored in a KeyStore object.

signFile(String, String, String, String, boolean) - Method in class com.didisoft.pgp.PGPLib

OpenPGP signs a file.

signFile(String, InputStream, String, OutputStream, boolean) - Method in class com.didisoft.pgp.PGPLib

OpenPGP signs a file.

signFileVersion3(String, String, String, String, boolean) - Method in class com.didisoft.pgp.PGPLib

Signs a file in OpenPGP version 3 format (compatible with PGP 2.x systems)

Optional settings:
Compression algorithm used is the one specified with PGPLib.setCompression(String)
Hashing algorithm used is the one specified with PGPLib.setHash(String)

Example usage:

signPublicKey(long, long, String) - Method in class com.didisoft.pgp.KeyStore

Signs a public key with a private key.

signPublicKey(String, String, String) - Method in class com.didisoft.pgp.KeyStore

Signs a public key with a private key.

signPublicKeyAsTrustedIntroducer(long, long, String) - Method in class com.didisoft.pgp.KeyStore

Signs a public key trusted introducer with a private key.

signPublicKeyAsTrustedIntroducer(String, String, String) - Method in class com.didisoft.pgp.KeyStore

Signs a public key as a trusted introducer with a private key.

signStream(InputStream, String, InputStream, String, OutputStream, boolean) - Method in class com.didisoft.pgp.PGPLib

OpenPGP signs a stream.

signStream(InputStream, String, KeyStore, String, String, OutputStream, boolean) - Method in class com.didisoft.pgp.PGPLib

OpenPGP signs stream with a private key stored in a KeyStore.

signStream(InputStream, String, KeyStore, long, String, OutputStream, boolean) - Method in class com.didisoft.pgp.PGPLib

OpenPGP signs stream with a private key stored in a KeyStore.

signStreamVersion3(InputStream, String, InputStream, String, OutputStream, boolean) - Method in class com.didisoft.pgp.PGPLib

Signs a stream using OpenPGP version 3 signatures format (compatible with PGP 2.x systems)

Optional settings:
Compression algorithm used is the one specified with PGPLib.setCompression(String)
Hashing algorithm used is the one specified with PGPLib.setHash(String)

Example:

T

TRIPLE_DES - Static variable in interface com.didisoft.pgp.CypherAlgorithm

Triple DES.

TRUSTED - Static variable in interface com.didisoft.pgp.TrustLevel

Maximum trust

TrustLevel - Interface in com.didisoft.pgp

Holds common trust values

TWOFISH - Static variable in interface com.didisoft.pgp.CypherAlgorithm

Twofish.

U

UNCOMPRESSED - Static variable in interface com.didisoft.pgp.CompressionAlgorithm

Data is not compressed

V

verifyFile(String, String, String) - Method in class com.didisoft.pgp.PGPLib

Verifies the incoming file as being correctly signed.

verifyFile(String, KeyStore, String) - Method in class com.didisoft.pgp.PGPLib

Verifies the incoming file as being correctly signed.

verifyFile(String, String) - Method in class com.didisoft.pgp.PGPLib

Verifies the incoming file as being correctly signed.

verifyFile(InputStream, InputStream) - Method in class com.didisoft.pgp.PGPLib

Deprecated. Use PGPLib.verifyStream(InputStream, InputStream)

verifyStream(InputStream, InputStream) - Method in class com.didisoft.pgp.PGPLib

Verifies the incoming stream as being correctly signed.

verifyStream(InputStream, InputStream, OutputStream) - Method in class com.didisoft.pgp.PGPLib

Verifies the incoming stream as being correctly signed.

verifyStream(InputStream, KeyStore, OutputStream) - Method in class com.didisoft.pgp.PGPLib

Verifies the incoming stream as being correctly signed.

verifyString(String, String, StringBuffer) - Method in class com.didisoft.pgp.PGPLib

Verifies an OpenPGP signed only message.

verifyString(String, String, StringBuffer, String) - Method in class com.didisoft.pgp.PGPLib

Verifies an OpenPGP signed only message.

W

WrongPasswordException - Class in com.didisoft.pgp.exceptions

This exception indicates that we have supplied a wrong password for an OpenPGP private key.

WrongPasswordException(String) - Constructor for class com.didisoft.pgp.exceptions.WrongPasswordException

WrongPasswordException(String, Exception) - Constructor for class com.didisoft.pgp.exceptions.WrongPasswordException

WrongPrivateKeyException - Class in com.didisoft.pgp.exceptions

This exception indicates that we have supplied a wrong decryption private key for an OpenPGP archive.

WrongPrivateKeyException(String) - Constructor for class com.didisoft.pgp.exceptions.WrongPrivateKeyException

WrongPrivateKeyException(String, Exception) - Constructor for class com.didisoft.pgp.exceptions.WrongPrivateKeyException

Z

ZIP - Static variable in interface com.didisoft.pgp.CompressionAlgorithm

ZLIB - Static variable in interface com.didisoft.pgp.CompressionAlgorithm

A B C D E F G H I K L M N P R S T U V W Z