OpenPGP Class
Properties Methods Events Config Settings Errors
The OpenPGP class is used to encrypt/decrypt and sign/verify PGP messages.
Class Name
IPWorksOpenPGP_OpenPGP
Procedural Interface
ipworksopenpgp_openpgp_open(); ipworksopenpgp_openpgp_close($res); ipworksopenpgp_openpgp_register_callback($res, $id, $function); ipworksopenpgp_openpgp_get_last_error($res); ipworksopenpgp_openpgp_get_last_error_code($res); ipworksopenpgp_openpgp_set($res, $id, $index, $value); ipworksopenpgp_openpgp_get($res, $id, $index); ipworksopenpgp_openpgp_do_config($res, $configurationstring); ipworksopenpgp_openpgp_do_decrypt($res); ipworksopenpgp_openpgp_do_decryptandverifysignature($res); ipworksopenpgp_openpgp_do_encrypt($res); ipworksopenpgp_openpgp_do_getrecipientinfo($res); ipworksopenpgp_openpgp_do_interrupt($res); ipworksopenpgp_openpgp_do_reset($res); ipworksopenpgp_openpgp_do_sign($res); ipworksopenpgp_openpgp_do_signandencrypt($res); ipworksopenpgp_openpgp_do_verifysignature($res);
Remarks
The OpenPGP class supports encrypting/decrypting and signing/verifying OpenPGP messages. Supported message formats are specified by RFC 4880, in addition to draft-ietf-openpgp-crypto-refresh-13, which introduces support for OpenPGP Version 6.
The Encrypt, Sign, and SignAndEncrypt methods are used to create a message to be sent to your partner. You can additionally create messages bound for multiple recipients with different keys, simultaneously encrypt and compress with the most popular compression algorithms, and control other aspects such as the encrypting algorithm to use.
When a message is received, the Decrypt, VerifySignature, and DecryptAndVerifySignature methods are used to process the incoming message.
The Keys property holds the key (with private key) used to sign and decrypt.
The SignerKeys property holds the key used to verify a signature.
The RecipientKeys property holds the key used to encrypt.
Input and Output Properties
The class will determine the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
When a valid source is found the search stops. The order in which the output properties are checked is as follows:
- OutputFile
- OutputMessage: The output data is written to this property if no other destination is specified.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
ASCIIArmor | Specifies whether to use ASCII armor to encode the output message. |
AutoSelectAlgorithms | Whether to automatically select algorithms when encrypting or signing. |
ClearSignature | Specifies whether or not to create a cleartext signature. |
CompressionMethod | The compression algorithm used. |
DetachedSignature | Specifies whether or not to generate a detached signature when signing a message. |
EncryptingAlgorithm | The encryption algorithm used when encrypting. |
InputFile | The file to process. |
InputMessage | The message to process. |
KeyCount | The number of records in the Key arrays. |
KeyEncoded | The key. |
KeyKeyring | The location of the keyring. |
KeyPassphrase | The passphrase for the key's secret key (if any). |
KeyUserId | The user Id of the key. |
MessageHeaderCount | The number of records in the MessageHeader arrays. |
MessageHeaderField | This property contains the name of the HTTP header (this is the same case as it is delivered). |
MessageHeaderValue | This property contains the header contents. |
OutputFile | The output file. |
OutputMessage | The output message after processing. |
Overwrite | Indicates whether or not the class should overwrite files. |
RecipientKeyCount | The number of records in the RecipientKey arrays. |
RecipientKeyEncoded | The key. |
RecipientKeyKeyring | The location of the keyring. |
RecipientKeyUserId | The user Id of the key. |
SignerKeyCount | The number of records in the SignerKey arrays. |
SignerKeyEncoded | The key. |
SignerKeyKeyring | The location of the keyring. |
SignerKeyUserId | The user Id of the key. |
SigningAlgorithm | The signature hash algorithm used when signing. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
Config | Sets or retrieves a configuration setting. |
Decrypt | Decrypts the message. |
DecryptAndVerifySignature | Decrypts and verifies the signature of the message. |
Encrypt | Encrypts the message. |
GetRecipientInfo | Gets recipient information for an encrypted message. |
Interrupt | Interrupt the current method. |
Reset | Resets the class properties. |
Sign | Signs the message. |
SignAndEncrypt | Signs and encrypts the current message. |
VerifySignature | Verifies the signature of the current message. |
Event List
The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.
Error | Fired when information is available about errors during data delivery. |
KeyPassphrase | Fired if the passphrase of current key is incorrect or empty. |
Progress | Fired as progress is made. |
RecipientInfo | Fired for each recipient key of the encrypted message. |
SignatureInfo | Fired during verification of the signed message. |
Status | Shows the progress of the operation. |
VerificationStatus | Fired after verification of the signed message. |
Config Settings
The following is a list of config settings for the class with short descriptions. Click on the links for further details.
AEADChunkSizeExp | Specifies the exponent used to calculate the plaintext chunk size for encryption. |
AllowEmptyInput | Whether to allow empty files for input. |
AllowOldPacketType | Whether to allow the older encrypted packet type. |
Argon2Iterations | Specifies the number of iterations used for Argon2. |
Argon2MemorySizeExp | Specifies the exponent used to calculate the memory size used when creating a key. |
Argon2Parallelism | Specifies the degree of parallelism used for Argon2. |
CloseInputStreamAfterProcessing | Determines whether or not the input stream is closed after processing. |
CloseOutputStreamAfterProcessing | Determines whether or not the output stream is closed after processing. |
CompressionLevel | The level of compression used. |
DeleteOutputFileOnError | Whether to delete the output file on an error. |
DetachedSignatureData | The detached signature. |
EnsureValidDSASignatureHashAlgorithm | Whether or not to select a suitable signature hash algorithm automatically. |
FileName | The original name of the encrypted file. |
KeyIdLength | The length of the KeyId available. |
KeySelectionMethod | The method used to select a key for encryption or signing. |
LogLevel | Specifies the level of detail that is logged. |
PGPZipDir | The directory used when creating or extracting a PGP zip file. |
ProgressEventThreshold | The amount of data in bytes to process before firing the progress event. |
PublicKeyringFile | The file name of the public keyring file. |
ReadFromProgressEvent | Whether to read input data from inside the progress event. |
RecursiveDecryptMode | Whether the encrypted data should be decrypted recursively. |
RequireEncryption | Whether to throw an error when decrypting and encryption is not detected. |
RequireIntegrityProtectedPacket | Whether an MDC packet is required for decryption. |
RequireSignature | Whether to throw an error when verifying a signature and no signature is found. |
RequireValidSignature | Specifies if an invalid signature is considered an error condition. |
SecretKeyringFile | The file name of the secret keyring file. |
SplitHeaders | Controls whether ASCII Armor headers are split or not. |
SymmetricPassphrase | The password used for symmetric encryption or decryption. |
UseArgon2 | Whether to use Argon2 for key derivation during symmetric encryption or decryption. |
UsePlatformAES | Whether to use the platform AES implementation. |
VerifyClearTextSignatureWithCache | Whether the cleartext message is cached in memory when verifying a cleartext signature. |
VersionHeader | The Version header value in the ASCII armored OpenPGP message. |
WriteToProgressEvent | Whether to write output data so it is accessible from inside the progress event. |
BuildInfo | Information about the product's build. |
CodePage | The system code page used for Unicode to Multibyte translations. |
LicenseInfo | Information about the current license. |
MaskSensitiveData | Whether sensitive data is masked in log messages. |
ProcessIdleEvents | Whether the class uses its internal event loop to process events when the main thread is idle. |
SelectWaitMillis | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
UseFIPSCompliantAPI | Tells the class whether or not to use FIPS certified APIs. |
UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
ASCIIArmor Property (IPWorksOpenPGP_OpenPGP Class)
Specifies whether to use ASCII armor to encode the output message.
Object Oriented Interface
public function getASCIIArmor(); public function setASCIIArmor($value);
Procedural Interface
ipworksopenpgp_openpgp_get($res, 1 ); ipworksopenpgp_openpgp_set($res, 1, $value );
Default Value
false
Remarks
This property controls whether or not ASCII armoring is used on the output message. The default value is False.
Data Type
Boolean
AutoSelectAlgorithms Property (IPWorksOpenPGP_OpenPGP Class)
Whether to automatically select algorithms when encrypting or signing.
Object Oriented Interface
public function getAutoSelectAlgorithms(); public function setAutoSelectAlgorithms($value);
Procedural Interface
ipworksopenpgp_openpgp_get($res, 2 ); ipworksopenpgp_openpgp_set($res, 2, $value );
Default Value
0
Remarks
This property is set to the binary 'OR' of one or more options indicating which algorithms to automatically select.
When enabled automatic selection is performed by examining the preferred algorithms specified by the key.
When Encrypt is called the class will read the preferred encryption algorithm and compression method from the key specified in the RecipientKey* properties.
If multiple keys are specified the preferred encryption algorithm and compression method from the last key is used. The EncryptingAlgorithm and CompressionMethod properties are ignored.
When Sign is called the class will read the preferred MAC algorithm and compression method from the private key specified in the Key* properties. If multiple keys are specified the preferred MAC algorithm and compression method from the last key is used. The SigningAlgorithm and CompressionMethod properties are ignored.
The list below defines available options.
Compression Algorithm | 1 (Hex 0x01) |
Cipher Algorithm | 2 (Hex 0x02) |
MAC Algorithm | 4 (Hex 0x04) |
The default value is 0 which means algorithms are not automatically selected.
Data Type
Integer
ClearSignature Property (IPWorksOpenPGP_OpenPGP Class)
Specifies whether or not to create a cleartext signature.
Object Oriented Interface
public function getClearSignature(); public function setClearSignature($value);
Procedural Interface
ipworksopenpgp_openpgp_get($res, 3 ); ipworksopenpgp_openpgp_set($res, 3, $value );
Default Value
false
Remarks
This property controls whether or not a cleartext signature is created during signing. The default value is False. When set to true a clear text signature will be created when Sign is called.
Data Type
Boolean
CompressionMethod Property (IPWorksOpenPGP_OpenPGP Class)
The compression algorithm used.
Object Oriented Interface
public function getCompressionMethod(); public function setCompressionMethod($value);
Procedural Interface
ipworksopenpgp_openpgp_get($res, 4 ); ipworksopenpgp_openpgp_set($res, 4, $value );
Default Value
'zip'
Remarks
This property specifies which compression method is used when generating output. Possible values are:
- zip (default)
- zlib
- bzip2
- none or uncompressed
Data Type
String
DetachedSignature Property (IPWorksOpenPGP_OpenPGP Class)
Specifies whether or not to generate a detached signature when signing a message.
Object Oriented Interface
public function getDetachedSignature(); public function setDetachedSignature($value);
Procedural Interface
ipworksopenpgp_openpgp_get($res, 5 ); ipworksopenpgp_openpgp_set($res, 5, $value );
Default Value
false
Remarks
This property specifies whether or not a detached signature is created when signing a message. The default value is False.
If set to true the output will only be the signature. The data being signed will not be included in the output. If set to true ClearSignature will be ignored.
When this property is false (default) the signature is not detached. The output will contain both the signed data and the signature.
Data Type
Boolean
EncryptingAlgorithm Property (IPWorksOpenPGP_OpenPGP Class)
The encryption algorithm used when encrypting.
Object Oriented Interface
public function getEncryptingAlgorithm(); public function setEncryptingAlgorithm($value);
Procedural Interface
ipworksopenpgp_openpgp_get($res, 6 ); ipworksopenpgp_openpgp_set($res, 6, $value );
Default Value
'AES128'
Remarks
This property specifies the encryption algorithm used when encrypting. Possible values are:
- CAST5
- 3DES or TripleDES
- AES256
- AES192
- AES128 (default)
- BLOWFISH
- TWOFISH
- IDEA
- AES256-OCB (AEAD)
- AES192-OCB (AEAD)
- AES128-OCB (AEAD)
- AES256-GCM (AEAD)
- AES192-GCM (AEAD)
- AES128-GCM (AEAD)
Note that if UseArgon2 is enabled, and SymmetricPassphrase is specified, an AEAD encryption algorithm (AES*-OCB and AES*-GCM) must be specified for symmetric encryption. If UseArgon2 is disabled, and an AEAD encryption algorithm is specified, the AEAD mode (OCB or GCM) will be ignored when performing symmetric encryption.
An AEAD encryption algorithm may optionally be utilized when encrypting messages (when calling Encrypt). In this case, the AEADChunkSizeExp configuration will specify the chunk size for splitting plaintext for encryption. Please see AEADChunkSizeExp for additional details.
Data Type
String
InputFile Property (IPWorksOpenPGP_OpenPGP Class)
The file to process.
Object Oriented Interface
public function getInputFile(); public function setInputFile($value);
Procedural Interface
ipworksopenpgp_openpgp_get($res, 7 ); ipworksopenpgp_openpgp_set($res, 7, $value );
Default Value
''
Remarks
This property specifies the file to be processed. Set this property to the full or relative path to the file which will be processed.
Input and Output Properties
The class will determine the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
- InputFile
- InputMessage
When a valid source is found the search stops. The order in which the output properties are checked is as follows:
- OutputFile
- OutputMessage: The output data is written to this property if no other destination is specified.
Data Type
String
InputMessage Property (IPWorksOpenPGP_OpenPGP Class)
The message to process.
Object Oriented Interface
public function getInputMessage(); public function setInputMessage($value);
Procedural Interface
ipworksopenpgp_openpgp_get($res, 8 ); ipworksopenpgp_openpgp_set($res, 8, $value );
Default Value
''
Remarks
This property specifies the message to be processed. Set this property to the OpenPGP message content.
Input and Output Properties
The class will determine the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
- InputFile
- InputMessage
When a valid source is found the search stops. The order in which the output properties are checked is as follows:
- OutputFile
- OutputMessage: The output data is written to this property if no other destination is specified.
Data Type
Binary String
KeyCount Property (IPWorksOpenPGP_OpenPGP Class)
The number of records in the Key arrays.
Object Oriented Interface
public function getKeyCount(); public function setKeyCount($value);
Procedural Interface
ipworksopenpgp_openpgp_get($res, 9 ); ipworksopenpgp_openpgp_set($res, 9, $value );
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at KeyCount - 1.This property is not available at design time.
Data Type
Integer
KeyEncoded Property (IPWorksOpenPGP_OpenPGP Class)
The key.
Object Oriented Interface
public function getKeyEncoded($keyindex); public function setKeyEncoded($keyindex, $value);
Procedural Interface
ipworksopenpgp_openpgp_get($res, 12 , $keyindex); ipworksopenpgp_openpgp_set($res, 12, $value , $keyindex);
Default Value
''
Remarks
The key. This property can be used to assign a specific key. The KeyFingerprint, KeyId, and KeyUserId properties may also be used to specify a key.
The $keyindex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.
This property is not available at design time.
Data Type
Binary String
KeyKeyring Property (IPWorksOpenPGP_OpenPGP Class)
The location of the keyring.
Object Oriented Interface
public function getKeyKeyring($keyindex); public function setKeyKeyring($keyindex, $value);
Procedural Interface
ipworksopenpgp_openpgp_get($res, 16 , $keyindex); ipworksopenpgp_openpgp_set($res, 16, $value , $keyindex);
Default Value
''
Remarks
The location of the keyring.
If the keyring is stored in a directory, set this property to the directory. The directory must contain the files "secring.gpg" and "pubring.gpg". A keyring may also be stored in a single file. If the keyring is a file this property should be set to the path of the file.
When This property is set the class will read the keyring and populate the Key property with the first key found in the keyring. Set KeyUserId to select a different key in the current keyring.
The $keyindex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.
This property is not available at design time.
Data Type
String
KeyPassphrase Property (IPWorksOpenPGP_OpenPGP Class)
The passphrase for the key's secret key (if any).
Object Oriented Interface
public function getKeyPassphrase($keyindex); public function setKeyPassphrase($keyindex, $value);
Procedural Interface
ipworksopenpgp_openpgp_get($res, 18 , $keyindex); ipworksopenpgp_openpgp_set($res, 18, $value , $keyindex);
Default Value
''
Remarks
The passphrase for the key's secret key (if any). This must be specified before operations requiring the secret key are attempted. The passphrase may be supplied in this property or through the KeyPassphrase event, which will fire when a passphrase is required.
The passphrase is required when using the following methods in KeyMgr:
- AddUserId
- SignUserId
- ChangeExpirationDate
- ChangePassphrase
When using the OpenPGP class, or an email-based class, the following methods require a passphrase for the key:
- Decrypt
- Sign
- SignAndEncrypt
The $keyindex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.
This property is not available at design time.
Data Type
String
KeyUserId Property (IPWorksOpenPGP_OpenPGP Class)
The user Id of the key.
Object Oriented Interface
public function getKeyUserId($keyindex); public function setKeyUserId($keyindex, $value);
Procedural Interface
ipworksopenpgp_openpgp_get($res, 27 , $keyindex); ipworksopenpgp_openpgp_set($res, 27, $value , $keyindex);
Default Value
''
Remarks
The user Id of the key. When a key is loaded this property is populated with the user Id associated with the key. This property may be set to load a key from the Keyring. When this property is set the class will search the Keyring for a key associated with the UserId specified.
When loading a key with multiple user Ids, this property will be populated with the UserId that was most recently added to the key. To discover all of the UserIds associated with a key query this property and KeyOtherUserIds after loading the key.
The UserId format is:
FirstName LastName (Comment) <Email>Not all values are required when selecting or generating a key, but at least FirstName or Email are required.
Note that for OpenPGP v6, a key may be created with or without a UserId, as the field is optional. If a key was created without a UserId, the key's Fingerprint can be used as it's identifier instead.
When using this property to select a key you may also specify the key's Id, or any of its subkeys' Ids, instead of a user Id. The class will then search for a key with a matching Id. This is helpful in situations where you do not have the UserId but still need to load the key, such as within the OpenPGP class's RecipientInfo event.
The $keyindex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.
This property is not available at design time.
Data Type
String
MessageHeaderCount Property (IPWorksOpenPGP_OpenPGP Class)
The number of records in the MessageHeader arrays.
Object Oriented Interface
public function getMessageHeaderCount(); public function setMessageHeaderCount($value);
Procedural Interface
ipworksopenpgp_openpgp_get($res, 29 ); ipworksopenpgp_openpgp_set($res, 29, $value );
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at MessageHeaderCount - 1.This property is not available at design time.
Data Type
Integer
MessageHeaderField Property (IPWorksOpenPGP_OpenPGP Class)
This property contains the name of the HTTP header (this is the same case as it is delivered).
Object Oriented Interface
public function getMessageHeaderField($messageheaderindex); public function setMessageHeaderField($messageheaderindex, $value);
Procedural Interface
ipworksopenpgp_openpgp_get($res, 30 , $messageheaderindex); ipworksopenpgp_openpgp_set($res, 30, $value , $messageheaderindex);
Default Value
''
Remarks
This property contains the name of the HTTP Header (this is the same case as it is delivered).
The $messageheaderindex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageHeaderCount property.
This property is not available at design time.
Data Type
String
MessageHeaderValue Property (IPWorksOpenPGP_OpenPGP Class)
This property contains the header contents.
Object Oriented Interface
public function getMessageHeaderValue($messageheaderindex); public function setMessageHeaderValue($messageheaderindex, $value);
Procedural Interface
ipworksopenpgp_openpgp_get($res, 31 , $messageheaderindex); ipworksopenpgp_openpgp_set($res, 31, $value , $messageheaderindex);
Default Value
''
Remarks
This property contains the Header contents.
The $messageheaderindex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageHeaderCount property.
This property is not available at design time.
Data Type
String
OutputFile Property (IPWorksOpenPGP_OpenPGP Class)
The output file.
Object Oriented Interface
public function getOutputFile(); public function setOutputFile($value);
Procedural Interface
ipworksopenpgp_openpgp_get($res, 32 ); ipworksopenpgp_openpgp_set($res, 32, $value );
Default Value
''
Remarks
This property specifies the file to which the output will be written. This may be set to an absolute or relative path.
Input and Output Properties
The class will determine the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
When a valid source is found the search stops. The order in which the output properties are checked is as follows:
- OutputFile
- OutputMessage: The output data is written to this property if no other destination is specified.
Data Type
String
OutputMessage Property (IPWorksOpenPGP_OpenPGP Class)
The output message after processing.
Object Oriented Interface
public function getOutputMessage(); public function setOutputMessage($value);
Procedural Interface
ipworksopenpgp_openpgp_get($res, 33 ); ipworksopenpgp_openpgp_set($res, 33, $value );
Default Value
''
Remarks
This property will be populated with the output from the operation if OutputFile is not set.
Input and Output Properties
The class will determine the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
When a valid source is found the search stops. The order in which the output properties are checked is as follows:
- OutputFile
- OutputMessage: The output data is written to this property if no other destination is specified.
Data Type
Binary String
Overwrite Property (IPWorksOpenPGP_OpenPGP Class)
Indicates whether or not the class should overwrite files.
Object Oriented Interface
public function getOverwrite(); public function setOverwrite($value);
Procedural Interface
ipworksopenpgp_openpgp_get($res, 34 ); ipworksopenpgp_openpgp_set($res, 34, $value );
Default Value
false
Remarks
This property indicates whether or not the class will overwrite OutputFile. If Overwrite is False, an error will be thrown whenever OutputFile exists before an operation. The default value is False.
Data Type
Boolean
RecipientKeyCount Property (IPWorksOpenPGP_OpenPGP Class)
The number of records in the RecipientKey arrays.
Object Oriented Interface
public function getRecipientKeyCount(); public function setRecipientKeyCount($value);
Procedural Interface
ipworksopenpgp_openpgp_get($res, 35 ); ipworksopenpgp_openpgp_set($res, 35, $value );
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at RecipientKeyCount - 1.This property is not available at design time.
Data Type
Integer
RecipientKeyEncoded Property (IPWorksOpenPGP_OpenPGP Class)
The key.
Object Oriented Interface
public function getRecipientKeyEncoded($recipientkeyindex); public function setRecipientKeyEncoded($recipientkeyindex, $value);
Procedural Interface
ipworksopenpgp_openpgp_get($res, 38 , $recipientkeyindex); ipworksopenpgp_openpgp_set($res, 38, $value , $recipientkeyindex);
Default Value
''
Remarks
The key. This property can be used to assign a specific key. The RecipientKeyFingerprint, RecipientKeyId, and RecipientKeyUserId properties may also be used to specify a key.
The $recipientkeyindex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientKeyCount property.
This property is not available at design time.
Data Type
Binary String
RecipientKeyKeyring Property (IPWorksOpenPGP_OpenPGP Class)
The location of the keyring.
Object Oriented Interface
public function getRecipientKeyKeyring($recipientkeyindex); public function setRecipientKeyKeyring($recipientkeyindex, $value);
Procedural Interface
ipworksopenpgp_openpgp_get($res, 42 , $recipientkeyindex); ipworksopenpgp_openpgp_set($res, 42, $value , $recipientkeyindex);
Default Value
''
Remarks
The location of the keyring.
If the keyring is stored in a directory, set this property to the directory. The directory must contain the files "secring.gpg" and "pubring.gpg". A keyring may also be stored in a single file. If the keyring is a file this property should be set to the path of the file.
When This property is set the class will read the keyring and populate the Key property with the first key found in the keyring. Set KeyUserId to select a different key in the current keyring.
The $recipientkeyindex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientKeyCount property.
This property is not available at design time.
Data Type
String
RecipientKeyUserId Property (IPWorksOpenPGP_OpenPGP Class)
The user Id of the key.
Object Oriented Interface
public function getRecipientKeyUserId($recipientkeyindex); public function setRecipientKeyUserId($recipientkeyindex, $value);
Procedural Interface
ipworksopenpgp_openpgp_get($res, 53 , $recipientkeyindex); ipworksopenpgp_openpgp_set($res, 53, $value , $recipientkeyindex);
Default Value
''
Remarks
The user Id of the key. When a key is loaded this property is populated with the user Id associated with the key. This property may be set to load a key from the Keyring. When this property is set the class will search the Keyring for a key associated with the UserId specified.
When loading a key with multiple user Ids, this property will be populated with the UserId that was most recently added to the key. To discover all of the UserIds associated with a key query this property and KeyOtherUserIds after loading the key.
The UserId format is:
FirstName LastName (Comment) <Email>Not all values are required when selecting or generating a key, but at least FirstName or Email are required.
Note that for OpenPGP v6, a key may be created with or without a UserId, as the field is optional. If a key was created without a UserId, the key's Fingerprint can be used as it's identifier instead.
When using this property to select a key you may also specify the key's Id, or any of its subkeys' Ids, instead of a user Id. The class will then search for a key with a matching Id. This is helpful in situations where you do not have the UserId but still need to load the key, such as within the OpenPGP class's RecipientInfo event.
The $recipientkeyindex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientKeyCount property.
This property is not available at design time.
Data Type
String
SignerKeyCount Property (IPWorksOpenPGP_OpenPGP Class)
The number of records in the SignerKey arrays.
Object Oriented Interface
public function getSignerKeyCount(); public function setSignerKeyCount($value);
Procedural Interface
ipworksopenpgp_openpgp_get($res, 55 ); ipworksopenpgp_openpgp_set($res, 55, $value );
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at SignerKeyCount - 1.This property is not available at design time.
Data Type
Integer
SignerKeyEncoded Property (IPWorksOpenPGP_OpenPGP Class)
The key.
Object Oriented Interface
public function getSignerKeyEncoded($signerkeyindex); public function setSignerKeyEncoded($signerkeyindex, $value);
Procedural Interface
ipworksopenpgp_openpgp_get($res, 58 , $signerkeyindex); ipworksopenpgp_openpgp_set($res, 58, $value , $signerkeyindex);
Default Value
''
Remarks
The key. This property can be used to assign a specific key. The SignerKeyFingerprint, SignerKeyId, and SignerKeyUserId properties may also be used to specify a key.
The $signerkeyindex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerKeyCount property.
This property is not available at design time.
Data Type
Binary String
SignerKeyKeyring Property (IPWorksOpenPGP_OpenPGP Class)
The location of the keyring.
Object Oriented Interface
public function getSignerKeyKeyring($signerkeyindex); public function setSignerKeyKeyring($signerkeyindex, $value);
Procedural Interface
ipworksopenpgp_openpgp_get($res, 62 , $signerkeyindex); ipworksopenpgp_openpgp_set($res, 62, $value , $signerkeyindex);
Default Value
''
Remarks
The location of the keyring.
If the keyring is stored in a directory, set this property to the directory. The directory must contain the files "secring.gpg" and "pubring.gpg". A keyring may also be stored in a single file. If the keyring is a file this property should be set to the path of the file.
When This property is set the class will read the keyring and populate the Key property with the first key found in the keyring. Set KeyUserId to select a different key in the current keyring.
The $signerkeyindex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerKeyCount property.
This property is not available at design time.
Data Type
String
SignerKeyUserId Property (IPWorksOpenPGP_OpenPGP Class)
The user Id of the key.
Object Oriented Interface
public function getSignerKeyUserId($signerkeyindex); public function setSignerKeyUserId($signerkeyindex, $value);
Procedural Interface
ipworksopenpgp_openpgp_get($res, 73 , $signerkeyindex); ipworksopenpgp_openpgp_set($res, 73, $value , $signerkeyindex);
Default Value
''
Remarks
The user Id of the key. When a key is loaded this property is populated with the user Id associated with the key. This property may be set to load a key from the Keyring. When this property is set the class will search the Keyring for a key associated with the UserId specified.
When loading a key with multiple user Ids, this property will be populated with the UserId that was most recently added to the key. To discover all of the UserIds associated with a key query this property and KeyOtherUserIds after loading the key.
The UserId format is:
FirstName LastName (Comment) <Email>Not all values are required when selecting or generating a key, but at least FirstName or Email are required.
Note that for OpenPGP v6, a key may be created with or without a UserId, as the field is optional. If a key was created without a UserId, the key's Fingerprint can be used as it's identifier instead.
When using this property to select a key you may also specify the key's Id, or any of its subkeys' Ids, instead of a user Id. The class will then search for a key with a matching Id. This is helpful in situations where you do not have the UserId but still need to load the key, such as within the OpenPGP class's RecipientInfo event.
The $signerkeyindex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerKeyCount property.
This property is not available at design time.
Data Type
String
SigningAlgorithm Property (IPWorksOpenPGP_OpenPGP Class)
The signature hash algorithm used when signing.
Object Oriented Interface
public function getSigningAlgorithm(); public function setSigningAlgorithm($value);
Procedural Interface
ipworksopenpgp_openpgp_get($res, 75 ); ipworksopenpgp_openpgp_set($res, 75, $value );
Default Value
'SHA256'
Remarks
This property specifies the signature hash algorithm used when signing. Possible values are:
- SHA1
- MD5
- SHA256 (default)
- SHA384
- SHA512
- SHA224
- RIPEMD160
- SHA3-256
- SHA3-512
Data Type
String
Config Method (IPWorksOpenPGP_OpenPGP Class)
Sets or retrieves a configuration setting.
Object Oriented Interface
public function doConfig($configurationstring);
Procedural Interface
ipworksopenpgp_openpgp_do_config($res, $configurationstring);
Remarks
Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
Decrypt Method (IPWorksOpenPGP_OpenPGP Class)
Decrypts the message.
Object Oriented Interface
public function doDecrypt();
Procedural Interface
ipworksopenpgp_openpgp_do_decrypt($res);
Remarks
This method decrypts the specified message.
The message will be decrypted using the keys specified in Keys. Before decryption begins the class will fire the RecipientInfo event with information about the encrypted message, including the key used to encrypt the message. Within this event you may use the available information to load the correct key into Keys.
DecryptAndVerifySignature Method (IPWorksOpenPGP_OpenPGP Class)
Decrypts and verifies the signature of the message.
Object Oriented Interface
public function doDecryptAndVerifySignature();
Procedural Interface
ipworksopenpgp_openpgp_do_decryptandverifysignature($res);
Remarks
This method attempts to both decrypt and verify the signature of the message. All of the properties affected by calling the Decrypt and VerifySignature methods are affected in the same manner.
This method may be used when the data is signed, encrypted, or signed and encrypted. For instance, if the data is encrypted but not signed you may still use this method and the class will perform the decryption without error.
The message will be decrypted using the keys specified in Keys. Before decryption begins the class will fire the RecipientInfo event with information about the encrypted message, including the key used to encrypt the message. Within this event you may use the available information to load the correct key into Keys.
The message will be verified using the keys specified in SignerKeys. Before verification begins the class will fire the SignatureInfo event with information about the signature including the key used to sign the message. Within this event you may use the information available to load the correct key into SignerKeys.
By default, if the signature is not valid the class fails with an error. The configuration setting RequireValidSignature may be set to False to disable this requirement. When RequireValidSignature is set to False, the Status parameter of the VerificationStatus event should be checked to determine the result of the operation.
NOTE: This method does not attempt to check the validity of the signing key itself.
Encrypt Method (IPWorksOpenPGP_OpenPGP Class)
Encrypts the message.
Object Oriented Interface
public function doEncrypt();
Procedural Interface
ipworksopenpgp_openpgp_do_encrypt($res);
Remarks
This method encrypts the specified message.
The message is encrypted with the public keys specified in RecipientKeys.
When encrypting, the following properties may be used to further configure the class:
GetRecipientInfo Method (IPWorksOpenPGP_OpenPGP Class)
Gets recipient information for an encrypted message.
Object Oriented Interface
public function doGetRecipientInfo();
Procedural Interface
ipworksopenpgp_openpgp_do_getrecipientinfo($res);
Remarks
This method will fire a RecipientInfo event for every recipient key for which the message has been encrypted. The event will provide the KeyId and Fingerprint, which can be used to identify the correct key to be used for decryption.
Interrupt Method (IPWorksOpenPGP_OpenPGP Class)
Interrupt the current method.
Object Oriented Interface
public function doInterrupt();
Procedural Interface
ipworksopenpgp_openpgp_do_interrupt($res);
Remarks
If there is no method in progress, Interrupt simply returns, doing nothing.
Reset Method (IPWorksOpenPGP_OpenPGP Class)
Resets the class properties.
Object Oriented Interface
public function doReset();
Procedural Interface
ipworksopenpgp_openpgp_do_reset($res);
Remarks
This method resets all message and key properties to their default values.
Sign Method (IPWorksOpenPGP_OpenPGP Class)
Signs the message.
Object Oriented Interface
public function doSign();
Procedural Interface
ipworksopenpgp_openpgp_do_sign($res);
Remarks
This method signs the specified message.
The message is signed with the private key specified in the Key* properties.
When signing, the following properties may be used to further configure the class:
SignAndEncrypt Method (IPWorksOpenPGP_OpenPGP Class)
Signs and encrypts the current message.
Object Oriented Interface
public function doSignAndEncrypt();
Procedural Interface
ipworksopenpgp_openpgp_do_signandencrypt($res);
Remarks
This method signs and encrypts the specified message.
The message is encrypted with the public keys specified in RecipientKeys and signed with the private key specified in Keys.
When encrypting, the following properties may be used to further configure the class:
When signing, the following properties may be used to further configure the class:
VerifySignature Method (IPWorksOpenPGP_OpenPGP Class)
Verifies the signature of the current message.
Object Oriented Interface
public function doVerifySignature();
Procedural Interface
ipworksopenpgp_openpgp_do_verifysignature($res);
Remarks
This method verifies the signature of the message.
The message will be verified using the keys specified in SignerKeys. Before verification begins the class will fire the SignatureInfo event with information about the signature including the key used to sign the message. Within this event you may use the information available to load the correct key into SignerKeys.
By default, if the signature is not valid the class fails with an error. The configuration setting RequireValidSignature may be set to False to disable this requirement. When RequireValidSignature is set to False, the Status parameter of the VerificationStatus event should be checked to determine the result of the operation.
Error Event (IPWorksOpenPGP_OpenPGP Class)
Fired when information is available about errors during data delivery.
Object Oriented Interface
public function fireError($param);
Procedural Interface
ipworksopenpgp_openpgp_register_callback($res, 1, array($this, 'fireError'));
Parameter List
'errorcode'
'description'
Remarks
The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.
The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.
KeyPassphrase Event (IPWorksOpenPGP_OpenPGP Class)
Fired if the passphrase of current key is incorrect or empty.
Object Oriented Interface
public function fireKeyPassphrase($param);
Procedural Interface
ipworksopenpgp_openpgp_register_callback($res, 2, array($this, 'fireKeyPassphrase'));
Parameter List
'userid'
'keyid'
'fingerprint'
'passphrase'
Remarks
This event fires when the passphrase for the key is required. The passphrase must be specified before operations requiring the secret key are attempted. The passphrase may be supplied by setting the Passphrase parameter in this event, or by specifying the KeyPassphrase property before attempting the operation.
The passphrase is required when using the following methods in KeyMgr:
- AddUserId
- SignUserId
- ChangeExpirationDate
- ChangePassphrase
When using the OpenPGP class, or an email-based class, the following methods require a passphrase for the key:
UserId holds the user Id of the key the passphrase is required for.
The UserId format is:
FirstName LastName (Comment) <Email>Not all values are required when selecting or generating a key, but at least FirstName or Email are required.
Note that for OpenPGP v6, a key may be created with or without a UserId, as the field is optional. If a key was created without a UserId, the key's Fingerprint can be used as it's identifier instead.
KeyId is the hex-encoded, 4-byte or 8-byte Id of the key the passphrase is required for. For OpenPGP v4 keys and earlier, the key Id corresponds to the last 4 or 8 bytes of the key's Fingerprint. For OpenPGP v6 keys, the key Id corresponds to the first 8 bytes of the key's Fingerprint instead. For instance:
5E70662EA810E768
Fingerprint holds the hex-encoded, 20-byte fingerprint of the key the passphrase is required for. This is in the form:
5E70662EA810E768391A2FE8F7B7D49C89C9D7B1
Progress Event (IPWorksOpenPGP_OpenPGP Class)
Fired as progress is made.
Object Oriented Interface
public function fireProgress($param);
Procedural Interface
ipworksopenpgp_openpgp_register_callback($res, 3, array($this, 'fireProgress'));
Parameter List
'bytesprocessed'
'percentprocessed'
'operation'
'iseof'
Remarks
This event is fired automatically as data is processed by the class.
The PercentProcessed parameter indicates the current status of the operation.
The BytesProcessed parameter holds the total number of bytes processed so far.
The Operation parameter is only applicable when either ReadFromProgressEvent or WriteToProgressEvent is set to True. This parameter defines whether a Read or Write operation is required. If the configuration settings are not set this parameter will always return 0. Possible values are:
0 | None |
1 | Read |
2 | Write |
The IsEOF parameter is only applicable when either ReadFromProgressEvent or WriteToProgressEvent is set to True. This parameter defines whether the Read or Write operation is complete. When the Operation is Read (1) this parameter must be set to indicate that all data has been supplied to the class. When the Operation is Write (2) this value may be queried to determine when all data has been processed.
RecipientInfo Event (IPWorksOpenPGP_OpenPGP Class)
Fired for each recipient key of the encrypted message.
Object Oriented Interface
public function fireRecipientInfo($param);
Procedural Interface
ipworksopenpgp_openpgp_register_callback($res, 4, array($this, 'fireRecipientInfo'));
Parameter List
'keyid'
'fingerprint'
'publickeyalgorithm'
Remarks
This event fires when the Decrypt or DecryptAndVerifySignature method is called.
KeyId is the hex-encoded 4- or 8-byte Id of the key used to encrypt the message. If a subkey was used to encrypt the message this will be the Id of that subkey. For OpenPGP v4 keys and earlier, the key Id corresponds to the last 4 or 8 bytes of the key's Fingerprint. For OpenPGP v6 keys, the key Id corresponds to the first 8 bytes of the key's Fingerprint instead. For instance:
5E70662EA810E768
Fingerprint holds the hex-encoded, 20-byte fingerprint of the key. This is in the form:
5E70662EA810E768391A2FE8F7B7D49C89C9D7B1
The KeyId and Fingerprint parameters can be used to identify the correct key to specify in the Key* properties. The Key* properties can be set from within this event as this event fires directly before the decryption process begins.
It is recommended to use the Fingerprint to identify the correct key, as it is possible for different keys to have the same KeyId.
PublicKeyAlgorithm is the algorithm of the public key used to encrypt the message. Possible values are:
- RSA
- DSA
- ECDSA
- EdDSA
- Ed25519
- Ed448
- RSA-Legacy
- ECDH (Subkeys only)
- X25519 (Subkeys only)
- X448 (Subkeys only)
SignatureInfo Event (IPWorksOpenPGP_OpenPGP Class)
Fired during verification of the signed message.
Object Oriented Interface
public function fireSignatureInfo($param);
Procedural Interface
ipworksopenpgp_openpgp_register_callback($res, 5, array($this, 'fireSignatureInfo'));
Parameter List
'keyid'
'fingerprint'
'signingalgorithm'
'publickeyalgorithm'
Remarks
This event fires when the VerifySignature or DecryptAndVerifySignature method is called. It provides information about the signature of the message.
KeyId is the hex-encoded 4- or 8-byte Id of the key used to sign the message. If a subkey was used to sign the message this will be the Id of that subkey. For OpenPGP v4 keys and earlier, the key Id corresponds to the last 4 or 8 bytes of the key's Fingerprint. For OpenPGP v6 keys, the key Id corresponds to the first 8 bytes of the key's Fingerprint instead. For instance:
5E70662EA810E768
Fingerprint holds the hex-encoded, 20-byte fingerprint of the key. This is in the form:
5E70662EA810E768391A2FE8F7B7D49C89C9D7B1
The KeyId and Fingerprint parameters can be used to identify the correct key to specify in the SignerKey* properties. The SignerKey* properties can be set from within this event as this event fires directly before the verification process begins.
It is recommended to use the Fingerprint to identify the correct key, as it is possible for different keys to have the same KeyId.
SigningAlgorithm describes the hash algorithm used when the message was originally signed. This value is applicable only to the message signature, not the key used to sign the message. Possible values are:
- SHA1
- MD5
- SHA256
- SHA384
- SHA512
- SHA224
- RIPEMD160
- SHA3-256
- SHA3-512
PublicKeyAlgorithm is the algorithm of the public key used to sign the message. Possible values are:
- RSA
- DSA
- ECDSA
- EdDSA
- Ed25519
- Ed448
- RSA-Legacy
- ECDH (Subkeys only)
- X25519 (Subkeys only)
- X448 (Subkeys only)
Status Event (IPWorksOpenPGP_OpenPGP Class)
Shows the progress of the operation.
Object Oriented Interface
public function fireStatus($param);
Procedural Interface
ipworksopenpgp_openpgp_register_callback($res, 6, array($this, 'fireStatus'));
Parameter List
'message'
Remarks
The event is fired for informational and logging purposes only. It may be used to track the progress of an operation.
The level of detail is controlled by the LogLevel setting.
VerificationStatus Event (IPWorksOpenPGP_OpenPGP Class)
Fired after verification of the signed message.
Object Oriented Interface
public function fireVerificationStatus($param);
Procedural Interface
ipworksopenpgp_openpgp_register_callback($res, 7, array($this, 'fireVerificationStatus'));
Parameter List
'keyid'
'fingerprint'
'status'
Remarks
This event fires when VerifySignature or DecryptAndVerifySignature is called. It provides information about the result.
KeyId is the hex-encoded 4- or 8-byte Id of the key used to sign the message. For OpenPGP v4 keys and earlier, the key Id corresponds to the last 4 or 8 bytes of the key's Fingerprint. For OpenPGP v6 keys, the key Id corresponds to the first 8 bytes of the key's Fingerprint instead. For instance:
5E70662EA810E768
Fingerprint holds the hex-encoded, 20-byte fingerprint of the key. This is in the form:
5E70662EA810E768391A2FE8F7B7D49C89C9D7B1
Status holds the result of the operation. Possible values are:
0 | Verification succeeded |
1 | Verification failed |
2 | The required key could not be found |
3 | Verification succeeded but the key is expired. |
Config Settings (OpenPGP Class)
The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.OpenPGP Config Settings
By default, this value is 6. Valid values range from 6 to 22.
The chunk size is calculated as 2^exp (in octets, or bytes), where exp is the value of this configuration setting. For example, the default chunk size would be: 2^(6) = 64 bytes. In this case, the plaintext would be split into chunks of 64 bytes, each of which will be individually encrypted using the specified EncryptingAlgorithm.
When set to True the class will read the features from the recipient key to determine if the older packet type is required. If the key does require the old packet type, then the older packet type will be used. If the key does not require the old packet type, then the new integrity protected packet type will still be used.
By default this value is False. This means under no conditions is the older less secure packet type used. The newer integrity protected packet type is always used.
Only enable this setting if you have a requirement to do so.
The default value is 3. Valid values range from 1 to 2^(32)-1. Higher values provide more brute-force protection for the key passphrase at the cost of performance. This configuration can be used to tune the running time independently of the memory size (see Argon2MemorySizeExp).
The default value is 16. Valid values range from 3 to 31, though the minimum can vary depending on the value of Argon2Parallelism (see below). The memory size (in KB) is calculated as 2^exp, where exp is the value of this configuration setting. For example, the default memory size would be: 2^(16) = 65,536 KB.
Note: The memory size must be an integer number of kilobytes ranging from 8*p to 2^(32)-1, where p is the value of Argon2Parallelism. Therefore, Argon2MemorySizeExp must be an integer ranging from 3+ceil(log2(p)) to 31. For example, if Argon2Parallelism is set to 8, valid values for Argon2MemorySizeExp range from 6 to 31.
The default value is 4. Valid values range from 1 to 2^(24)-1.
zlib | 1-6 |
zip | 1-6 |
bzip2 | 1-9 |
89011C04000102000605025100459B000A0910E2...
DSA Notes
DSA requires that the hash be 160 bits or larger, which means MD5 is not a suitable algorithm. When DSA Signature Hash Algorithm selection is enabled (default) the class will use the preferred algorithm from the key if it meets the requirements for DSA. If the preferred algorithm is MD5 and does not meed the requirements for DSA the class will automatically use a suitable algorithm based on the Q element of the DSA key (may be SHA1, SHA224, or SHA256).
ECDSA Notes
The ECDSA Signature Hash Algorithm requirements are directly related to the KeyCurve used by the key. When this setting is enabled (default) the class will use the preferred algorithm from the key if it meets the requirements for ECDSA. If the preferred algorithm does not meet the requirements the class will automatically select a valid hash algorithm based on the curve as follows:
Curve | Hash Algorithm |
secp256r1 | SHA256 |
secp384r1 | SHA384 |
secp521r1 | SHA512 |
secp256k1 | SHA256 |
For OpenPGP v4 keys and earlier, the key Id corresponds to the last 4 or 8 bytes of the key's Fingerprint. For OpenPGP v6 keys, the key Id corresponds to the first 8 bytes of the key's Fingerprint instead. For instance:
5E70662EA810E768
0 | Automatic selection, first suitable subkey. Expired keys accepted. |
1 | Automatic selection, first suitable subkey. Expired keys not accepted. |
2 | Automatic selection, newest suitable subkey. Expired keys not accepted (Default). |
99 | Manual Selection. |
Manual Selection
To manually select a key for any operation pass the key's Id in the constructor.
Openpgp pgp = new Openpgp();
pgp.Config("KeySelectionMethod=99");
pgp.RecipientKeys.Add(new Key(@"C:\path\to\key.asc", "7CA1376C39768977")); // Key with Id 7CA1376C39768977 will be used for encryption.
0 (None) | No events are logged. |
1 (Info - default) | Informational events are logged. |
2 (Verbose) | Detailed data is logged. |
3 (Debug) | Debug data is logged. |
- To create a PGP zip file set this value to a location on disk including a filemask and call Encrypt. For instance:
OpenPGP1.Config("PGPZipDir=C:\MyFiles\*.txt"); OpenPGP1.OutputFile = "C:\PGPZip.pgp"; OpenPGP1.Encrypt();
The created file returned in the OutputFile property is the PGP zip. If InputFile is specified it is used to temporarily hold the Tar archive while creating the PGP zip file. The temporary file is not automatically deleted. If InputFile is not specified the Tar archive is held in memory while creating the PGP zip file. - To extract a PGP zip file set this value to a location on disk and call Decrypt. For instance:
OpenPGP1.Config("PGPZipDir=C:\MyFiles"); OpenPGP1.InputFile = "C:\PGPZip.pgp"; OpenPGP1.Decrypt();
The extracted files will be present in the specified directory. If OutputFile is specified it is used to temporarily hold the Tar archive. The temporary file is not automatically deleted. If OutputFile is not specified the Tar archive is held in memory while extracting the PGP zip file. Note that if the OpenPGP message supplied is not a PGP zip file the decryption will occur as normal without error.
0 | Automatic - If the PGP message contains the special header version "PGP Command Line" then recursive decryption will be attempted. (Default) |
1 | Always attempt recursive decryption. |
2 | Never attempt recursive decryption. |
The default value is false.
The default value is false.
This configuration is only applicable when SymmetricPassphrase is specified and when calling Encrypt or Decrypt. Additionally, the following configuration settings are applicable when this config is set to True:
Note that if UseArgon2 is enabled, EncryptingAlgorithm must be specified as an AEAD encryption algorithm (e.g., AES192-OCB). Please see the EncryptingAlgorithm for additional details.
This config is True by default, and must be true when verifying an OpenPGP v6 cleartext signature. When enabled, the cleartext portion will be cached in memory until the signature is fully processed.
Note: If the signature is known to be an OpenPGP v4 cleartext signature beforehand (i.e., signed with a v4 key), this config may be set to False. However, if this config is disabled, the class will be unable to verify OpenPGP v6 cleartext signatures. In this case, the class will throw an exception when calling VerifySignature or DecryptAndVerifySignature.
This setting will be populated after calling Decrypt, VerifySignature, or DecryptAndVerifySignature.
Base Config Settings
The following is a list of valid code page identifiers:
Identifier | Name |
037 | IBM EBCDIC - U.S./Canada |
437 | OEM - United States |
500 | IBM EBCDIC - International |
708 | Arabic - ASMO 708 |
709 | Arabic - ASMO 449+, BCON V4 |
710 | Arabic - Transparent Arabic |
720 | Arabic - Transparent ASMO |
737 | OEM - Greek (formerly 437G) |
775 | OEM - Baltic |
850 | OEM - Multilingual Latin I |
852 | OEM - Latin II |
855 | OEM - Cyrillic (primarily Russian) |
857 | OEM - Turkish |
858 | OEM - Multilingual Latin I + Euro symbol |
860 | OEM - Portuguese |
861 | OEM - Icelandic |
862 | OEM - Hebrew |
863 | OEM - Canadian-French |
864 | OEM - Arabic |
865 | OEM - Nordic |
866 | OEM - Russian |
869 | OEM - Modern Greek |
870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
875 | IBM EBCDIC - Modern Greek |
932 | ANSI/OEM - Japanese, Shift-JIS |
936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
949 | ANSI/OEM - Korean (Unified Hangul Code) |
950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
1026 | IBM EBCDIC - Turkish (Latin-5) |
1047 | IBM EBCDIC - Latin 1/Open System |
1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
1147 | IBM EBCDIC - France (20297 + Euro symbol) |
1148 | IBM EBCDIC - International (500 + Euro symbol) |
1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
1201 | Unicode UCS-2 Big-Endian |
1250 | ANSI - Central European |
1251 | ANSI - Cyrillic |
1252 | ANSI - Latin I |
1253 | ANSI - Greek |
1254 | ANSI - Turkish |
1255 | ANSI - Hebrew |
1256 | ANSI - Arabic |
1257 | ANSI - Baltic |
1258 | ANSI/OEM - Vietnamese |
1361 | Korean (Johab) |
10000 | MAC - Roman |
10001 | MAC - Japanese |
10002 | MAC - Traditional Chinese (Big5) |
10003 | MAC - Korean |
10004 | MAC - Arabic |
10005 | MAC - Hebrew |
10006 | MAC - Greek I |
10007 | MAC - Cyrillic |
10008 | MAC - Simplified Chinese (GB 2312) |
10010 | MAC - Romania |
10017 | MAC - Ukraine |
10021 | MAC - Thai |
10029 | MAC - Latin II |
10079 | MAC - Icelandic |
10081 | MAC - Turkish |
10082 | MAC - Croatia |
12000 | Unicode UCS-4 Little-Endian |
12001 | Unicode UCS-4 Big-Endian |
20000 | CNS - Taiwan |
20001 | TCA - Taiwan |
20002 | Eten - Taiwan |
20003 | IBM5550 - Taiwan |
20004 | TeleText - Taiwan |
20005 | Wang - Taiwan |
20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
20106 | IA5 German (7-bit) |
20107 | IA5 Swedish (7-bit) |
20108 | IA5 Norwegian (7-bit) |
20127 | US-ASCII (7-bit) |
20261 | T.61 |
20269 | ISO 6937 Non-Spacing Accent |
20273 | IBM EBCDIC - Germany |
20277 | IBM EBCDIC - Denmark/Norway |
20278 | IBM EBCDIC - Finland/Sweden |
20280 | IBM EBCDIC - Italy |
20284 | IBM EBCDIC - Latin America/Spain |
20285 | IBM EBCDIC - United Kingdom |
20290 | IBM EBCDIC - Japanese Katakana Extended |
20297 | IBM EBCDIC - France |
20420 | IBM EBCDIC - Arabic |
20423 | IBM EBCDIC - Greek |
20424 | IBM EBCDIC - Hebrew |
20833 | IBM EBCDIC - Korean Extended |
20838 | IBM EBCDIC - Thai |
20866 | Russian - KOI8-R |
20871 | IBM EBCDIC - Icelandic |
20880 | IBM EBCDIC - Cyrillic (Russian) |
20905 | IBM EBCDIC - Turkish |
20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
20932 | JIS X 0208-1990 & 0121-1990 |
20936 | Simplified Chinese (GB2312) |
21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
21027 | Extended Alpha Lowercase |
21866 | Ukrainian (KOI8-U) |
28591 | ISO 8859-1 Latin I |
28592 | ISO 8859-2 Central Europe |
28593 | ISO 8859-3 Latin 3 |
28594 | ISO 8859-4 Baltic |
28595 | ISO 8859-5 Cyrillic |
28596 | ISO 8859-6 Arabic |
28597 | ISO 8859-7 Greek |
28598 | ISO 8859-8 Hebrew |
28599 | ISO 8859-9 Latin 5 |
28605 | ISO 8859-15 Latin 9 |
29001 | Europa 3 |
38598 | ISO 8859-8 Hebrew |
50220 | ISO 2022 Japanese with no halfwidth Katakana |
50221 | ISO 2022 Japanese with halfwidth Katakana |
50222 | ISO 2022 Japanese JIS X 0201-1989 |
50225 | ISO 2022 Korean |
50227 | ISO 2022 Simplified Chinese |
50229 | ISO 2022 Traditional Chinese |
50930 | Japanese (Katakana) Extended |
50931 | US/Canada and Japanese |
50933 | Korean Extended and Korean |
50935 | Simplified Chinese Extended and Simplified Chinese |
50936 | Simplified Chinese |
50937 | US/Canada and Traditional Chinese |
50939 | Japanese (Latin) Extended and Japanese |
51932 | EUC - Japanese |
51936 | EUC - Simplified Chinese |
51949 | EUC - Korean |
51950 | EUC - Traditional Chinese |
52936 | HZ-GB2312 Simplified Chinese |
54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
57002 | ISCII Devanagari |
57003 | ISCII Bengali |
57004 | ISCII Tamil |
57005 | ISCII Telugu |
57006 | ISCII Assamese |
57007 | ISCII Oriya |
57008 | ISCII Kannada |
57009 | ISCII Malayalam |
57010 | ISCII Gujarati |
57011 | ISCII Punjabi |
65000 | Unicode UTF-7 |
65001 | Unicode UTF-8 |
Identifier | Name |
1 | ASCII |
2 | NEXTSTEP |
3 | JapaneseEUC |
4 | UTF8 |
5 | ISOLatin1 |
6 | Symbol |
7 | NonLossyASCII |
8 | ShiftJIS |
9 | ISOLatin2 |
10 | Unicode |
11 | WindowsCP1251 |
12 | WindowsCP1252 |
13 | WindowsCP1253 |
14 | WindowsCP1254 |
15 | WindowsCP1250 |
21 | ISO2022JP |
30 | MacOSRoman |
10 | UTF16String |
0x90000100 | UTF16BigEndian |
0x94000100 | UTF16LittleEndian |
0x8c000100 | UTF32String |
0x98000100 | UTF32BigEndian |
0x9c000100 | UTF32LittleEndian |
65536 | Proprietary |
- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.
This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.
FIPS mode can be enabled by setting the UseFIPSCompliantAPI configuration setting to true. This is a static setting that applies to all instances of all classes of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior.
For more details, please see the FIPS 140-2 Compliance article.
Note: This setting is applicable only on Windows.
Note: Enabling FIPS compliance requires a special license; please contact sales@nsoftware.com for details.
Setting this configuration setting to true tells the class to use the internal implementation instead of using the system security libraries.
On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.
To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.
Trappable Errors (OpenPGP Class)
OpenPGP Errors
101 | Cannot decode ASCII Armor data. |
102 | Unknown ASCII Armor data type. |
103 | Checksum failed. |
104 | Unknown ASCII Armor header. |
105 | Cannot decode PGP packet. |
106 | Cannot encode PGP packet. |
107 | Unknown PGP packet tag. |
108 | Unsupported version. |
109 | Unsupported algorithm. |
110 | Unknown subpacket. |
111 | Internal error. |
112 | Feature not supported. |
113 | Secret data was not encrypted. |
114 | Cannot find the key. |
115 | Error reading file. |
116 | Error writing file. |
117 | Error reading key. |
118 | Error writing key. |
119 | Cannot verify signature. |
120 | Cannot create signature. |
121 | Invalid UserId. |
122 | Invalid passphrase. |
123 | Data encryption failed. |
124 | Error creating key. |
125 | Unsupported symmetric algorithm. |
126 | Unsupported hash. |
127 | Unsupported compression algorithm. |
128 | Invalid key usage. |
129 | Component is busy. |
130 | Error decrypting data. |
131 | Data is not compressed. |
132 | Error decompressing data. |
133 | Error compressing data. |
134 | Unsupported signature. |
135 | Failed to overwrite file. |
141 | No input. |
142 | Signing was required, but the message was not signed. |
143 | Encryption was required, but the message was not encrypted. |
146 | No data integrity packet was found (MDC), but one was required. |
200 | Out of memory. |