The PGPLib type exposes the following members.

Methods

  NameDescription
Public methodClearSignFile(FileInfo, FileInfo, String, HashAlgorithm, FileInfo)
OpenPGP clear signs a file.
Public methodClearSignFile(String, String, String, String, String)
OpenPGP clear signs a file.
Public methodClearSignFile(String, KeyStore, Int64, String, HashAlgorithm, String)
OpenPGP clear signs a file with a private key located in aKeyStore.
Public methodClearSignFile(String, KeyStore, String, String, HashAlgorithm, String)
OpenPGP clear signs a file with a private key located in aKeyStore.
Public methodClearSignFileV3(FileInfo, FileInfo, String, HashAlgorithm, FileInfo)
OpenPGP clear signs a file, using OpenPGP version 3 signature format (old format)
Public methodClearSignFileV3(String, String, String, String, String)
OpenPGP clear signs a file, using OpenPGP version 3 signature format (old format)

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

GPG equivalent command: gpg --force-v3-sigs --output outputFileName --clearsign inputFileName
Public methodClearSignString(String, FileInfo, String, HashAlgorithm)
OpenPGP clear signs a String message.

GPG equivalent command: gpg --clearsign
Public methodClearSignString(String, String, String, HashAlgorithm)
OpenPGP clear signs a String message.

GPG equivalent command: gpg --clearsign
Public methodClearSignString(String, KeyStore, Int64, String, HashAlgorithm)
OpenPGP clear signs a String message with a private key located in an KeyStore object.

GPG equivalent command: gpg --clearsign
Public methodClearSignString(String, KeyStore, String, String, HashAlgorithm)
OpenPGP clear signs a String message with a private key located in aKeyStore object.
Public methodClearSignStringV3(String, FileInfo, String, HashAlgorithm)
OpenPGP clear signs a String message, using OpenPGP version 3 signature format (old format used by PGP 2.6)
Public methodClearSignStringV3(String, String, String, HashAlgorithm)
OpenPGP clear signs a String message, using OpenPGP version 3 signature format (old format)

GPG equivalent command: gpg --clearsign --force-v3-sigs
Public methodDecryptAndVerifyFile(String, KeyStore, String, String)
Decrypts and verifies a PGP encrypted and signed file
Public methodDecryptAndVerifyFile(String, String, String, String, String)
Decrypts and verifies a PGP encrypted and signed file
Public methodDecryptAndVerifyFilePBE(String, KeyStore, String, String)
Decrypts and verifies the signature of a PGP encrypted and signed file
Public methodDecryptAndVerifyFilePBE(String, String, String, String)
Decrypts and verifies a PGP password based encrypted (PBE) and signed file
Public methodDecryptAndVerifyString(String, KeyStore, String, String%)
Decrypts and verifies PGP encrypted and signed string message
Public methodDecryptAndVerifyString(String, FileInfo, String, FileInfo, String%)
Decrypts and verifies PGP encrypted and signed string message
Public methodDecryptBytes
Decrypts OpenPGP encrypted data in the form of byte array with a private key supplied also as byte array.
Public methodDecryptFile(FileInfo, FileInfo, String, FileInfo)
Decrypts an PGP encrypted file using Private key file.
Public methodDecryptFile(String, KeyStore, String, String)
Decrypts a PGP encrypted file using Private key located inKeyStore.
Public methodDecryptFile(String, Stream, String, String)
Decrypts an OpenPGP encrypted file with a private key supplied as an input stream.
Public methodDecryptFile(String, String, String, String)
Decrypts a PGP encrypted file using Private key file.
Public methodDecryptFileInFolder(String, KeyStore, String, String)
Decrypts a PGP encrypted file that may contain multiple files to a specified directory.
Public methodDecryptFileInFolder(String, String, String, String)
Decrypts a PGP encrypted file that may contain multiple files to a specified directory.
Public methodDecryptFilePBE
Decrypts a PGP conventional password encrypted file (also known as PBE, symmetric key encrypted).
Public methodDecryptFilePBEInFolder
Decrypts a PGP conventional password encrypted file that may contain multiple files to a specified directory.
Public methodDecryptPBETo
Decrypts a PGP conventional password encrypted stream that may contain multiple files to a specified directory.
Public methodDecryptStream(Stream, KeyStore, String, Stream)
Decrypts an OpenPGP encrypted data stream with a private key located in a KeyStore.
Public methodDecryptStream(Stream, Stream, String, Stream)
Decrypts an OpenPGP encrypted data stream with a private key supplied as an input stream.
Public methodDecryptStreamInFolder(Stream, KeyStore, String, String)
Decrypts a PGP encrypted stream that may contain multiple files to a specified directory.
Public methodDecryptStreamInFolder(Stream, Stream, String, String)
Decrypts a PGP encrypted stream that may contain multiple files to a specified directory.
Public methodDecryptStreamPBEInFolder
Decrypts a PGP conventional password encrypted stream that may contain multiple files to a specified directory.
Public methodDecryptString(String, KeyStore, String)
Decrypts OpenPGP encrypted string message
Public methodDecryptString(String, FileInfo, String)
Decrypts a PGP encrypted message.
Public methodDecryptString(String, Stream, String)
Decrypts a PGP encrypted message.
Public methodDecryptString(String, String, String)
Decrypts a PGP encrypted message.
Public methodDecryptTo(Stream, KeyStore, String, String)
Decrypts a PGP encrypted stream that may contain multiple files to a specified directory.
Public methodDecryptTo(Stream, Stream, String, String)
Decrypts a PGP encrypted stream that may contain multiple files to a specified directory.
Public methodDecryptTo(String, KeyStore, String, String)
Decrypts a PGP encrypted file that may contain multiple files to a specified directory.
Public methodDecryptTo(String, String, String, String)
Decrypts a PGP encrypted file that may contain multiple files to a specified directory.
Public methodDetachedSignFile(String, String, String, String, Boolean)
Creates an OpenPGP detached signature for a file.
Public methodDetachedSignFile(String, KeyStore, Int64, String, String, Boolean)
Creates an OpenPGP detached signature for a file.
Public methodDetachedSignFile(String, KeyStore, String, String, String, Boolean)
Creates an OpenPGP detached signature for a file.
Public methodDetachedSignStream(Stream, Stream, String, Stream, Boolean)
Creates an OpenPGP detached signature for a given data stream contents.
Public methodDetachedSignStream(Stream, KeyStore, Int64, String, Stream, Boolean)
Creates an OpenPGP detached signature for a given data stream contents.
Public methodDetachedSignStream(Stream, KeyStore, String, String, Stream, Boolean)
Creates an OpenPGP detached signature for a given data stream contents.
Public methodDetachedSignString
Creates an OpenPGP detached signature for a string message.
Public methodDetachedVerifyStream
Verifies that an OpenPGP detached signature is signed from a trusted sender.
Public methodDetachedVerifyString
Verifies that an OpenPGP detached signature is signed from a trusted sender.
Public methodEncryptFile(FileInfo, FileInfo, FileInfo)
OpenPGP encrypts given file using the first available public OpenPGP key from a key ring file
Public methodEncryptFile(String, String, String)
OpenPGP encrypts given file using the first available public PGP key from a key ring file
Public methodEncryptFile(FileInfo, FileInfo, FileInfo, Boolean)
OpenPGP encrypts given file using the first available public OpenPGP key from a key ring file
Public methodEncryptFile(String, String, String, Boolean)
OpenPGP encrypts given file using the first available public PGP key from a key ring file
Public methodEncryptFile(FileInfo, FileInfo, FileInfo, Boolean, Boolean)
PGP Encrypts given file using the first available Public PGP key from a Key ring file
Public methodEncryptFile(String, array<array<Byte>[]()[][]>[]()[][], String, Boolean, Boolean)
PGP Encrypts a file for miltiple recipients.
Public methodEncryptFile(String, Stream, String, Boolean, Boolean)
PGP Encrypts given file using the first available Public key from a Key ring input stream
Public methodEncryptFile(String, array<Stream>[]()[][], String, Boolean, Boolean)
PGP Encrypts a file for miltiple recipients.
Public methodEncryptFile(String, String, String, Boolean, Boolean)
OpenPGP Encrypts given file using the first available public PGP key from a Key ring file
Public methodEncryptFile(String, array<String>[]()[][], String, Boolean, Boolean)
PGP Encrypts a file for miltiple recipients.
Public methodEncryptFile(String, KeyStore, Int64, String, Boolean, Boolean)
PGP Encrypts given file using Public key from a KeyStore
Public methodEncryptFile(String, KeyStore, String, String, Boolean, Boolean)
PGP Encrypts given file using Public key from a Key store.
If more than one key exists with the specified userId, the first one is used.
Public methodEncryptFile(String, String, String, String, Boolean, Boolean) Obsolete.
PGP Encrypts given file using the first available Public PGP key from a Key ring file and a passphrase that can be used to decrypt the file if the private key is lost.
Public methodEncryptFilePBE(FileInfo, String, FileInfo, Boolean)
Encrypts a file only with a passphrase.
The same passphrase is used to decrypt the file.

Equivalent GnuPG command:
gpg -c -e [dataFileName]
Public methodEncryptFilePBE(String, String, String, Boolean)
Encrypts a file only with a passphrase.
The same passphrase is used to decrypt the file.

Equivalent GnuPG command:
gpg -c -e [dataFileName]
Public methodEncryptFilePBE(FileInfo, String, FileInfo, Boolean, Boolean)
Encrypts a file only with a passphrase.
The same passphrase is used to decrypt the file.

Equivalent GnuPG command:
gpg -c -e [dataFileName]
Public methodEncryptFilePBE(String, String, String, Boolean, Boolean)
Encrypts a file only with a passphrase.
The same passphrase is used to decrypt the file.

Equivalent GnuPG command:
gpg -c -e [dataFileName]
Public methodEncryptFilePBE(String, Stream, String, String, Boolean, Boolean)
Encrypts a file with a public key and a passphrase.
The passphrase can be used to decrypt the file if the corresponding private key is lost.

Example GnuPG command:
gpg -r [public key user id] -c -e [dataFileName]
Public methodEncryptFilePBE(String, String, String, String, Boolean, Boolean)
Encrypts a file with a public key and a passphrase.
The passphrase can be used to decrypt the file if the corresponding private key is lost.

Example GnuPG command:
gpg -r [public key user id] -c -e [dataFileName]
Public methodEncryptFiles(array<FileInfo>[]()[][], array<FileInfo>[]()[][], FileInfo, Boolean, Boolean)
Encrypts multiple files into a single OpenPGP archive, using one ore more recipient public keys.
Public methodEncryptFiles(array<String>[]()[][], array<String>[]()[][], String, Boolean, Boolean)
Encrypts multiple files into a single OpenPGP archive, using one ore more recipient public keys.
Public methodEncryptFiles(array<String>[]()[][], KeyStore, array<Int64>[]()[][], String, Boolean, Boolean)
Encrypts multiple files into a single OpenPGP archive, using one ore more recipient public keys.
Public methodEncryptFiles(array<String>[]()[][], KeyStore, array<String>[]()[][], String, Boolean, Boolean)
Encrypts multiple files into a single OpenPGP archive, using one ore more recipient public keys.
Public methodEncryptFolder(FileInfo, FileInfo, FileInfo, Boolean)
OpenPGP Encrypts given folder with its subfolders and files into a PGP Zip archive
Public methodEncryptFolder(String, String, String, Boolean)
OpenPGP Encrypts given folder with its subfolders and files into a PGP Zip archive
Public methodEncryptFolder(FileInfo, FileInfo, FileInfo, Boolean, Boolean)
OpenPGP Encrypts given folder with its subfolders and files into a PGP Zip archive
Public methodEncryptFolder(String, String, String, Boolean, Boolean)
OpenPGP Encrypts given folder with its subfolders and files into a PGP Zip archive
Public methodEncryptFolderPBE
Encrypts a whole folder with it's contents only with a passphrase.
The same passphrase is used to decrypt the file.
Public methodEncryptStream(Stream, FileInfo, Stream, Boolean)
OpenPGP encrypts given data stream using the first available public OpenPGP key from a key file
Public methodEncryptStream(Stream, Stream, Stream, Boolean)
OpenPGP encrypts given data stream using the first available public OpenPGP key from a key file
Public methodEncryptStream(Stream, KeyStore, Int64, Stream, Boolean)
OpenPGP encrypts given data stream using the first available public OpenPGP key from a key file
Public methodEncryptStream(Stream, KeyStore, String, Stream, Boolean)
OpenPGP encrypts given data stream using the first available public OpenPGP key from a key file
Public methodEncryptStream(Stream, Stream, Stream, Boolean, Boolean)
OpenPGP encrypts given data stream using the first available public OpenPGP key from a key file
Public methodEncryptStream(Stream, String, FileInfo, Stream, Boolean)
OpenPGP encrypts a data stream with an OpenPGP public key
Public methodEncryptStream(Stream, String, Stream, Stream, Boolean)
OpenPGP encrypts a data stream with an OpenPGP public key located in a stream
Public methodEncryptStream(Stream, String, KeyStore, Int64, Stream, Boolean)
OpenPGP encrypts given data stream using the first available public OpenPGP key from a key file
Public methodEncryptStream(Stream, String, KeyStore, String, Stream, Boolean)
OpenPGP encrypts given data stream using the first available public OpenPGP key from a key file
Public methodEncryptStream(Stream, String, Stream, Stream, Boolean, Boolean)
OpenPGP encrypts a data stream with an OpenPGP public key located in a stream
Public methodEncryptStreamPBE(Stream, Stream, String, Stream, Boolean, Boolean)
Encrypts a stream with a public key and a passphrase.
The passphrase can be used to decrypt the file if the corresponding private key is lost.

Example GnuPG command:
gpg -r [public key user id] -c -e [dataFileName]
Public methodEncryptStreamPBE(Stream, String, Stream, String, Stream, Boolean, Boolean)
Encrypts a stream with a public key and a passphrase.
The passphrase can be used to decrypt the file if the corresponding private key is lost.

Example GnuPG command:
gpg -r [public key user id] -c -e [dataFileName]
Public methodEncryptString(String, FileInfo)
Encrypts a String message in OpenPGP ASCII armored format.
Public methodEncryptString(String, array<FileInfo>[]()[][])
Encrypts a String message in OpenPGP ASCII armored format for multiple recipients.
Public methodEncryptString(String, String)
PGP Encrypts given String in OpenPGP ASCII armored format.
Public methodEncryptString(String, KeyStore, Int64)
Encrypts given String in ASCII format.
Public methodEncryptString(String, KeyStore, String)
Encrypts given String in ASCII format.
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodSignAndEncryptFile(FileInfo, FileInfo, String, FileInfo, FileInfo, Boolean, Boolean)
OpenPGP Signs and encrypts given file with supplied public and private key
Public methodSignAndEncryptFile(String, String, String, String, String, Boolean, Boolean)
Signs and encrypts a file in one pass.
Public methodSignAndEncryptFile(String, KeyStore, Int64, String, Int64, String, Boolean, Boolean)
OpenPGP signs and encrypts given file with public and private key located in a KeyStore
Public methodSignAndEncryptFile(String, KeyStore, Int64, String, array<Int64>[]()[][], String, Boolean, Boolean)
OpenPGP signs and encrypts given file with public and private key located in a KeyStore
Public methodSignAndEncryptFile(String, KeyStore, String, String, String, String, Boolean, Boolean)
OpenPGP Signs and encrypts given file with public and private key located in a KeyStore
Public methodSignAndEncryptFile(String, KeyStore, String, String, array<String>[]()[][], String, Boolean, Boolean)
OpenPGP Signs and encrypts given file with public and private key located in a KeyStore
Public methodSignAndEncryptFile(String, String, Stream, String, Stream, Stream, Boolean, Boolean)
OpenPGP signs and encrypts given file with supplied public (encryption) and private (signing) keys
Public methodSignAndEncryptFile(String, String, Stream, String, array<Stream>[]()[][], Stream, Boolean, Boolean)
OpenPGP signs and encrypts given file in one pass for multiple recipients
Public methodSignAndEncryptFilePBE
Signs and encrypts a file in one pass.
The file is encrypted with an additional password that can be used to decrypt the file afterwards.
Public methodSignAndEncryptFileV3(FileInfo, FileInfo, String, FileInfo, FileInfo, Boolean)
OpenPGP Signs and encrypts given file backward compatibile with PGP 6.5 and below
Public methodSignAndEncryptFileV3(String, String, String, String, String, Boolean)
Signs and encrypts a file in one pass, backward compatibile with PGP 6.5 and below
Public methodSignAndEncryptFileV3(String, KeyStore, Int64, String, Int64, String, Boolean)
OpenPGP signs and encrypts given file backward compatible with PGP 6.5 and below, with public and private key located in a KeyStore
Public methodSignAndEncryptFileV3(String, KeyStore, String, String, String, String, Boolean)
OpenPGP Signs and encrypts given file backward compatible with PGP 6.5 and below, with public and private key located in a KeyStore
Public methodSignAndEncryptFileV3(String, String, Stream, String, Stream, Stream, Boolean)
OpenPGP signs and encrypts given file backward compatibile with PGP 6.5 and below
Public methodSignAndEncryptString(String, FileInfo, String, FileInfo)
OpenPGP signs and encrypts a String message in one pass
Public methodSignAndEncryptString(String, KeyStore, Int64, String, Int64)
OpenPGP signs and encrypts given String message in one pass with keys located in a KeyStore
Public methodSignAndEncryptString(String, KeyStore, String, String, String)
OpenPGP Signs and encrypts given String message in one pass with keys located in a KeyStore
Public methodSignAndEncryptStringV3(String, FileInfo, String, FileInfo)
OpenPGP signs and encrypts a String message in one pass, backward compatible with PGP 6.5 and below
Public methodSignAndEncryptStringV3(String, KeyStore, Int64, String, Int64)
OpenPGP signs and encrypts given String message in one pass backward compatible with PGP 6.5 and below, with keys located in a KeyStore
Public methodSignAndEncryptStringV3(String, KeyStore, String, String, String)
OpenPGP signs and encrypts given String message in one pass backward compatible with PGP 6.5 and below, with keys located in a KeyStore
Public methodSignFile(FileInfo, FileInfo, String, FileInfo, Boolean)
OpenPGP digitaly signs a file.
Public methodSignFile(String, Stream, String, Stream, Boolean)
OpenPGP digitaly signs a file.
Public methodSignFile(String, String, String, String, Boolean)
OpenPGP digitaly signs a file.
Public methodSignFile(String, KeyStore, Int64, String, String, Boolean)
OpenPGP digitaly signs a file with a private key located in a KeyStore.
Public methodSignFile(String, KeyStore, String, String, String, Boolean)
OpenPGP digitaly signs a file with a private key located in a KeyStore.
Public methodSignFileV3(FileInfo, FileInfo, String, FileInfo, Boolean)
OpenPGP digitaly signs a file using OpenPGP version 3 signatures format (compatible with PGP 6.5 systems).
Public methodSignFileV3(String, Stream, String, Stream, Boolean)
OpenPGP digitaly signs a file using OpenPGP version 3 signatures format (compatible with PGP 6.5 systems).
Public methodSignFileV3(String, String, String, String, Boolean)
OpenPGP digitaly signs a file using OpenPGP version 3 signatures format (compatible with PGP 6.5 systems).
Public methodSignFileV3(String, KeyStore, Int64, String, String, Boolean)
OpenPGP digitaly signs a file using version 3 signature format (compatible with PGP 6.5 and below).
Public methodSignFileV3(String, KeyStore, String, String, String, Boolean)
OpenPGP digitaly signs a file using version 3 signature format (compatible with PGP 6.5 and below).
Public methodSignString(String, FileInfo, String)
OpenPGP digitaly signs a string message.
Public methodSignString(String, Stream, String)
OpenPGP digitaly signs a string message.
Public methodSignString(String, KeyStore, Int64, String)
OpenPGP signs a string message.
Public methodSignString(String, KeyStore, String, String)
OpenPGP signs a string message.
Public methodSignStringV3(String, Stream, String)
OpenPGP digitaly signs a string message.
Public methodSignStringV3(String, KeyStore, Int64, String)
OpenPGP signs a string message.
Public methodSignStringV3(String, KeyStore, String, String)
OpenPGP signs a string message.
Public methodToString
Returns a String that represents the current Object.
(Inherited from Object.)
Public methodVerifyFile(String, String)
Verifies that the incoming stream is signed from a trusted sender.
Public methodVerifyFile(String, KeyStore, String)
Verifies that the incoming stream is signed from a trusted sender.
Public methodVerifyFile(String, String, String)
Verifies that the incoming stream is OpenPGP signed from a trusted sender.
Public methodVerifyStream(Stream, Stream)
Verifies that the incoming stream is signed from a trusted sender.
Public methodVerifyStream(Stream, KeyStore, Stream)
Verifies that the incoming stream is signed from a trusted sender.
Public methodVerifyStream(Stream, Stream, Stream)
Verifies that the incoming stream is signed from a trusted sender.
Public methodVerifyString(String, Stream)
Verifies that the incoming string is signed from a trusted sender.
Public methodVerifyString(String, KeyStore, String%)
Verifies that the incoming string is signed from a trusted sender.
The sender public key must be already imported in theKeyStore parameter.
Public methodVerifyString(String, FileInfo, String%)
Verifies that the incoming string is signed from a trusted sender.

See Also