OpenPGP Control

Properties Methods Events Config Settings Errors

The OpenPGP control is used to encrypt/decrypt and sign/verify PGP messages.

Syntax

OpenPGP

Remarks

The OpenPGP control supports encrypting/decrypting and signing/verifying OpenPGP messages in the format specified by RFC 4880.

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 Key* properties specify the key (with private key) used to sign and decrypt.

The SignerKey* properties specify the key used to verify a signature.

The RecipientKey* properties specify the key used to encrypt.

Input and Output Properties

The control 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.

Property List

The following is the full list of the properties of the control 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.
KeyPass	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 control 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 control 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.
Reset	Resets the control 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 control 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 control with short descriptions. Click on the links for further details.


AllowEmptyInput	Whether to allow empty files for input.
AllowOldPacketType	Whether to allow the older encrypted packet type.
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.
UseFipsCompliantAlgorithms	Restricts the usage to FIPS compliant algorithms only.
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.
CodePage	The system code page used for Unicode to Multibyte translations.
MaskSensitive	Whether sensitive data is masked in log messages.
UseInternalSecurityAPI	Whether or not to use the system security libraries or an internal implementation.

ASCIIArmor Property (OpenPGP Control)

Specifies whether to use ASCII armor to encode the output message.

Syntax

openpgpcontrol.ASCIIArmor[=boolean]

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 (OpenPGP Control)

Whether to automatically select algorithms when encrypting or signing.

Syntax

openpgpcontrol.AutoSelectAlgorithms[=integer]

Default Value

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 perferred algorithms specified by the key.

When Encrypt is called the control 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 control 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 (OpenPGP Control)

Specifies whether or not to create a cleartext signature.

Syntax

openpgpcontrol.ClearSignature[=boolean]

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 (OpenPGP Control)

The compression algorithm used.

Syntax

openpgpcontrol.CompressionMethod[=string]

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

Note: The level of compression is controlled by the CompressionLevel setting.

Data Type

String

DetachedSignature Property (OpenPGP Control)

Specifies whether or not to generate a detached signature when signing a message.

Syntax

openpgpcontrol.DetachedSignature[=boolean]

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 (OpenPGP Control)

The encryption algorithm used when encrypting.

Syntax

openpgpcontrol.EncryptingAlgorithm[=string]

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

Data Type

String

InputFile Property (OpenPGP Control)

The file to process.

Syntax

openpgpcontrol.InputFile[=string]

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 control 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 (OpenPGP Control)

The message to process.

Syntax

openpgpcontrol.InputMessage[=string]

Default Value

Remarks

This property specifies the message to be processed. Set this property to the OpenPGP message content.

Input and Output Properties

The control 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.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .InputMessageB.

Data Type

Binary String

KeyCount Property (OpenPGP Control)

The number of records in the Key arrays.

Syntax

openpgpcontrol.KeyCount[=integer]

Default Value

Remarks

This property controls the size of the following arrays:

KeyEncoded
KeyKeyring
KeyPass
KeyUserId

The array indices start at 0 and end at KeyCount - 1.

This property is not available at design time.

Data Type

Integer

KeyEncoded Property (OpenPGP Control)

The key.

Syntax

openpgpcontrol.KeyEncoded(KeyIndex)[=string]

Default Value

Remarks

The key. This property is used to assign a specific key. The 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.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .KeyEncodedB.

This property is not available at design time.

Data Type

Binary String

KeyKeyring Property (OpenPGP Control)

The location of the keyring.

Syntax

openpgpcontrol.KeyKeyring(KeyIndex)[=string]

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 control will read the keyring and populate the Key* properties 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

KeyPass Property (OpenPGP Control)

The passphrase for the key's secret key (if any).

Syntax

openpgpcontrol.KeyPass(KeyIndex)[=string]

Default Value

Remarks

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 (OpenPGP Control)

The user Id of the key.

Syntax

openpgpcontrol.KeyUserId(KeyIndex)[=string]

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

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 control 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 control'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 (OpenPGP Control)

The number of records in the MessageHeader arrays.

Syntax

openpgpcontrol.MessageHeaderCount[=integer]

Default Value

Remarks

This property controls the size of the following arrays:

MessageHeaderField
MessageHeaderValue

The array indices start at 0 and end at MessageHeaderCount - 1.

This property is not available at design time.

Data Type

Integer

MessageHeaderField Property (OpenPGP Control)

This property contains the name of the HTTP header (this is the same case as it is delivered).

Syntax

openpgpcontrol.MessageHeaderField(MessageHeaderIndex)[=string]

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 (OpenPGP Control)

This property contains the header contents.

Syntax

openpgpcontrol.MessageHeaderValue(MessageHeaderIndex)[=string]

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 (OpenPGP Control)

The output file.

Syntax

openpgpcontrol.OutputFile[=string]

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 control 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

OutputMessage Property (OpenPGP Control)

The output message after processing.

Syntax

openpgpcontrol.OutputMessage[=string]

Default Value

Remarks

This property will be populated with the output from the operation if OutputFile is not set.

Input and Output Properties

The control 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.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .OutputMessageB.

Data Type

Binary String

Overwrite Property (OpenPGP Control)

Indicates whether or not the control should overwrite files.

Syntax

openpgpcontrol.Overwrite[=boolean]

Default Value

False

Remarks

This property indicates whether or not the control 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 (OpenPGP Control)

The number of records in the RecipientKey arrays.

Syntax

openpgpcontrol.RecipientKeyCount[=integer]

Default Value

Remarks

This property controls the size of the following arrays:

RecipientKeyEncoded
RecipientKeyKeyring
RecipientKeyUserId

The array indices start at 0 and end at RecipientKeyCount - 1.

This property is not available at design time.

Data Type

Integer

RecipientKeyEncoded Property (OpenPGP Control)

The key.

Syntax

openpgpcontrol.RecipientKeyEncoded(RecipientKeyIndex)[=string]

Default Value

Remarks

The key. This property is used to assign a specific key. The 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.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .RecipientKeyEncodedB.

This property is not available at design time.

Data Type

Binary String

RecipientKeyKeyring Property (OpenPGP Control)

The location of the keyring.

Syntax

openpgpcontrol.RecipientKeyKeyring(RecipientKeyIndex)[=string]

Default Value

Remarks

The location of the keyring.

When This property is set the control will read the keyring and populate the Key* properties 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 (OpenPGP Control)

The user Id of the key.

Syntax

openpgpcontrol.RecipientKeyUserId(RecipientKeyIndex)[=string]

Default Value

Remarks

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.

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 (OpenPGP Control)

The number of records in the SignerKey arrays.

Syntax

openpgpcontrol.SignerKeyCount[=integer]

Default Value

Remarks

This property controls the size of the following arrays:

SignerKeyEncoded
SignerKeyKeyring
SignerKeyUserId

The array indices start at 0 and end at SignerKeyCount - 1.

This property is not available at design time.

Data Type

Integer

SignerKeyEncoded Property (OpenPGP Control)

The key.

Syntax

openpgpcontrol.SignerKeyEncoded(SignerKeyIndex)[=string]

Default Value

Remarks

The key. This property is used to assign a specific key. The 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.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SignerKeyEncodedB.

This property is not available at design time.

Data Type

Binary String

SignerKeyKeyring Property (OpenPGP Control)

The location of the keyring.

Syntax

openpgpcontrol.SignerKeyKeyring(SignerKeyIndex)[=string]

Default Value

Remarks

The location of the keyring.

When This property is set the control will read the keyring and populate the Key* properties 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 (OpenPGP Control)

The user Id of the key.

Syntax

openpgpcontrol.SignerKeyUserId(SignerKeyIndex)[=string]

Default Value

Remarks

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.

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 (OpenPGP Control)

The signature hash algorithm used when signing.

Syntax

openpgpcontrol.SigningAlgorithm[=string]

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

Data Type

String

Config Method (OpenPGP Control)

Sets or retrieves a configuration setting.

Syntax

openpgpcontrol.Config ConfigurationString

Remarks

Config is a generic method available in every control. It is used to set and retrieve configuration settings for the control.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the control, 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 (OpenPGP Control)

Decrypts the message.

Syntax

openpgpcontrol.Decrypt

Remarks

This method decrypts the specified message.

The message will be decrypted using the keys specified in the Key* properties. Before decryption begins the control 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 (OpenPGP Control)

Decrypts and verifies the signature of the message.

Syntax

openpgpcontrol.DecryptAndVerifySignature

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 control will perform the decryption without error.

The message will be verified using the keys specified in the SignerKey* properties. Before verification begins the control 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 the SignerKey* properties.

By default, if the signature is not valid the control 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 (OpenPGP Control)

Encrypts the message.

Syntax

openpgpcontrol.Encrypt

Remarks

This method encrypts the specified message.

The message is encrypted with the public keys specified in the RecipientKey* properties.

When encrypting, the following properties may be used to further configure the control:

ASCIIArmor
CompressionMethod
EncryptingAlgorithm

GetRecipientInfo Method (OpenPGP Control)

Gets recipient information for an encrypted message.

Syntax

openpgpcontrol.GetRecipientInfo

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, which can be used to identify the correct key to be used for decryption.

Reset Method (OpenPGP Control)

Resets the control properties.

Syntax

openpgpcontrol.Reset

Remarks

This method resets all message and key properties to their default values.

Sign Method (OpenPGP Control)

Signs the message.

Syntax

openpgpcontrol.Sign

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 control:

ASCIIArmor
ClearSignature
DetachedSignature
SigningAlgorithm

SignAndEncrypt Method (OpenPGP Control)

Signs and encrypts the current message.

Syntax

openpgpcontrol.SignAndEncrypt

Remarks

This method signs and encrypts the specified message.

The message is encrypted with the public keys specified in the RecipientKey* properties and signed with the private key specified in the Key* properties .

When encrypting, the following properties may be used to further configure the control:

ASCIIArmor
CompressionMethod
EncryptingAlgorithm

When signing, the following properties may be used to further configure the control:

ASCIIArmor
ClearSignature
DetachedSignature
SigningAlgorithm

VerifySignature Method (OpenPGP Control)

Verifies the signature of the current message.

Syntax

openpgpcontrol.VerifySignature

Remarks

This method verifies the signature of the message.

Error Event (OpenPGP Control)

Fired when information is available about errors during data delivery.

Syntax

Sub openpgpcontrol_Error(ErrorCode As Integer, Description As String)

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the control 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 (OpenPGP Control)

Fired if the passphrase of current key is incorrect or empty.

Syntax

Sub openpgpcontrol_KeyPassphrase(UserId As String, KeyId As String, Passphrase As String)

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 KeyPass property before attempting the operation.

The passphrase is required when using the following methods in KeyMgr:

AddUserId
SignUserId
ChangeExpirationDate
ChangePassphrase

When using the OpenPGP control, or an email-based control, the following methods require a passphrase for the key:

Decrypt
Sign
SignAndEncrypt

Progress Event (OpenPGP Control)

Fired as progress is made.

Syntax

Sub openpgpcontrol_Progress(BytesProcessed As Long64, PercentProcessed As Integer, Operation As Integer, IsEOF As Boolean)

Remarks

This event is fired automatically as data is processed by the control.

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 control. When the Operation is Write (2) this value may be queried to determine when all data has been processed.

RecipientInfo Event (OpenPGP Control)

Fired for each recipient key of the encrypted message.

Syntax

Sub openpgpcontrol_RecipientInfo(KeyId As String, PublicKeyAlgorithm As String)

Remarks

This event fires when the Decrypt or DecryptAndVerifySignature method is called.

KeyId is the 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. It is the hex-encoded, 4- or 8-byte Id of the key. It is the same as the last 4 or 8 bytes of the fingerprint. For instance:

BF52A0AB

This can be used to identify the correct key to specify in Keys. Keys can be set from within this event as this event fires directly before the decryption process begins.

SignatureInfo Event (OpenPGP Control)

Fired during verification of the signed message.

Syntax

Sub openpgpcontrol_SignatureInfo(KeyId As String, SigningAlgorithm As String, PublicKeyAlgorithm As String)

Remarks

This event fires when the VerifySignature or DecryptAndVerifySignature method is called. It provides information about the signature of the message.

KeyId is the 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. It is the hex-encoded, 4- or 8-byte Id of the key. It is the same as the last 4 or 8 bytes of the Fingerprint. For instance:

BF52A0AB

This can be used to identify the correct key to specify in the SignerKey* properties. This property can be set from within this event as this event fires directly before the verification process begins.

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
SHA256
SHA384
SHA512
SHA224
MD5

PublicKeyAlgorithm is the algorithm of the public key used to sign the message. Possible values are:

RSA
DSA
ECDSA
EdDSA

Status Event (OpenPGP Control)

Shows the progress of the operation.

Syntax

Sub openpgpcontrol_Status(Message As String)

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 (OpenPGP Control)

Fired after verification of the signed message.

Syntax

Sub openpgpcontrol_VerificationStatus(KeyId As String, Status As Integer)

Remarks

This event fires when VerifySignature or DecryptAndVerifySignature is called. It provides information about the result.

KeyId is the Id of the key used to sign the message. It is the hex-encoded, 4-or 8-byte Id of the key. It is the same as the last 4 or 8 bytes of the Fingerprint. For instance:

BF52A0AB

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 Control)

The control 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 control, access to these internal properties is provided through the Config method.

OpenPGP Config Settings

AllowEmptyInput: Whether to allow empty files for input.

This setting controls whether the control allows empty input when processing. When True, the control will process 0 byte files specified by InputFile, or 0 byte messages specified by InputMessage. The default value is False.

AllowOldPacketType: Whether to allow the older encrypted packet type.

By default the control will only encrypt data using the newer and more secure integrity protected data packet type. Old implementations such as PGP 6.5.8 may require the older less secure data packet type.

When set to True the control 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.

CloseInputStreamAfterProcessing: Determines whether or not the input stream is closed after processing.

Determines whether or not the input stream set by SetInputStream is closed after processing is complete. The default value is True.

CloseOutputStreamAfterProcessing: Determines whether or not the output stream is closed after processing.

Determines whether or not the output stream set by SetOutputStream is closed after processing is complete. The default value is True.

CompressionLevel: The level of compression used.

This setting specifies the level of compression used: possible values depend on the value of CompressionMethod and are detailed below.


zlib	1-6
zip	1-6
bzip2	1-9

Higher values will cause the control to compress better; lower values will cause the control to compress faster. The default value for all methods is 4.

DeleteOutputFileOnError: Whether to delete the output file on an error.

Set this to true to automatically delete any partially written OutputFile if an error occurs. The default is

DetachedSignatureData: The detached signature.

This setting is used to specify the detached signature before calling VerifySignature. The message data should be specified normally and this setting should be set to the detached signature data. Both hex-string and OpenPGP ASCII-armored message formats are allowed. Hex-encoded data should be provided as a string like so:

89011C04000102000605025100459B000A0910E2...

EnsureValidDSASignatureHashAlgorithm: Whether or not to select a suitable signature hash algorithm automatically.

This setting specifies whether the control ensures a valid hash algorithm is selected for use with the loaded DSA or ECDSA key. The default value is True.

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 control 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 control 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 control 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 control will automatically select a valid hash algorithm based on the curve as follows:


Curve	Hash Algorithm
secp256r1	SHA256
secp384r1	SHA384
secp521r1	SHA512
secp256k1	SHA256

FileName: The original name of the encrypted file.

When encrypting, this configuration setting can be used to specify the original name of the encrypted data. When specifying an InputFile to encrypt from, this is included automatically in the encrypted packet. After decrypting, this will contain the file name of the original encrypted file.

KeyIdLength: The length of the KeyId available.

This controls the length of KeyId available when RecipientInfo fires. Possible values are 4 (default) or 8.

KeySelectionMethod: The method used to select a key for encryption or signing.

When more than one key is present this control can be configured to automatically select a key based on certain criteria (described below) or allow for manual selection.


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.

A key's suitability is determined by its usage flags.

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.

LogLevel: Specifies the level of detail that is logged.

This setting controls the level of detail that is logged through the Status event. Possible values are:


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.

PGPZipDir: The directory used when creating or extracting a PGP zip file.

A PGP zip file is a Tar archive that is encrypted. It is commonly used by utilities to protect multiple files in one OpenPGP message. The control supports creating and extracting these types of files.

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.

ProgressEventThreshold: The amount of data in bytes to process before firing the progress event.

When encrypting or decrypting, the Progress event is fired as data is processed by the control. When this setting is specified, the event will only fire after processing at least the specified number of bytes. The default value is 0.

PublicKeyringFile: The file name of the public keyring file.

This specifies the name of the public keyring file. The default value is "pubring.gpg". This may be set to a file name only, or a full path including the file name.

ReadFromProgressEvent: Whether to read input data from inside the progress event.

When set to True this setting allows input data to be specified from within the Progress event. The control will repeatedly fire the Progress event to ask for data. Inside the event set InputMessage when the Operation parameter of the event is 1 (Read). When all data has been provided set the IsEOF parameter of the event to True. This allows input data to be chunked and provided piece by piece. The default value is False.

RecursiveDecryptMode: Whether the encrypted data should be decrypted recursively.

In some instances data will be encrypted multiple times. This configuration option determines how the control will handle this situation. Options are:


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.

RequireEncryption: Whether to throw an error when decrypting and encryption is not detected.

By default, the component's decryption methods will succeed if the message is not encrypted. To cause an error to be thrown in this case, set this option to true.

The default value is false.

RequireIntegrityProtectedPacket: Whether an MDC packet is required for decryption.

When set to true, the control will throw an exception if the message being decrypted does not contain a Message Detection Code (MDC) packet. The default value is false.

RequireSignature: Whether to throw an error when verifying a signature and no signature is found.

By default, the component's signature verification methods will succeed if the message is not signed. To cause an error to be thrown in this case, set this option to true.

The default value is false.

RequireValidSignature: Specifies if an invalid signature is considered an error condition.

By default, if the signature is not valid the control fails with an error. This setting may be set to False to disable this requirement. When False, the Status parameter of the VerificationStatus event should be checked to determine the result of the operation. The default value is True.

SecretKeyringFile: The file name of the secret keyring file.

This specifies the name of the secret keyring file. The default value is "secring.gpg". This may be set to a file name only, or a full path including the file name.

SplitHeaders: Controls whether ASCII Armor headers are split or not.

By default, when headers are specified via MessageHeaders, the control will split headers over a certain length onto multiple lines. This is done to avoid potential errors during transport of the message. If false, the headers will be on one line regardless of length. The default value is True.

SymmetricPassphrase: The password used for symmetric encryption or decryption.

This setting specifies the passphrase when using symmetric encryption. If a value is provided, symmetric encryption/decryption will be attempted. In this case no keys are used for either encryption or decryption. Only Encrypt and Decrypt are valid operations when a value is set. Sign, SignAndEncrypt, VerifySignature, and DecryptAndVerifySignature are not valid operations when using this option.

UseFipsCompliantAlgorithms: Restricts the usage to FIPS compliant algorithms only.

When enabled the control will only support FIPS compliant algorithms. If a non-FIPS compliant algorithm is used an exception is thrown. The following algorithms are supported when this setting is True:

3DES
AES128
AES192
AES256
RSA
DSA
SHA1
SHA256
SHA384
SHA512
SHA224

The default value is False.

VersionHeader: The Version header value in the ASCII armored OpenPGP message.

This setting specifies the Version header value included in the ASCII armored OpenPGP message. This may be set before calling Encrypt, Sign, or SignAndEncrypt. The default value is "IPWorks! OpenPGP 2022".

This setting will be populated after calling Decrypt, VerifySignature, or DecryptAndVerifySignature.

WriteToProgressEvent: Whether to write output data so it is accessible from inside the progress event.

When set to True this setting allows output data to be obtained from within the Progress event. The control will repeatedly fire the Progress event to provide output data. Inside the event check OutputMessage when the Operation parameter of the event is 2 (Write). The IsEOF parameter should be checked inside the event to determine when all output data has been provided. This allows output data to be chunked and obtained piece by piece. The default value is False.

Base Config Settings

CodePage: The system code page used for Unicode to Multibyte translations.

The default code page is Unicode UTF-8 (65001).

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

The following is a list of valid code page identifiers for Mac OS only:


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

MaskSensitive: Whether sensitive data is masked in log messages.

In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to to mask sensitive data. The default is .

This setting only works on these controls: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

UseInternalSecurityAPI: Whether or not to use the system security libraries or an internal implementation.

When set to , the control will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to tells the control to use the internal implementation instead of using the system security libraries.

This setting is set to by default on all platforms.

Trappable Errors (OpenPGP Control)

OpenPGP Errors


	20102 Cannot decode ASCII Armor data.
	20103 Unknown ASCII Armor data type.
	20104 Checksum failed.
	20105 Unknown ASCII Armor header.
	20106 Cannot decode PGP packet.
	20107 Cannot encode PGP packet.
	20108 Unknown PGP packet tag.
	20109 Unsupported version.
	20110 Unsupported algorithm.
	20111 Unknown subpacket.
	20112 Internal error.
	20113 Feature not supported.
	20114 Secret data was not encrypted.
	20115 Cannot find the key.
	20116 Error reading file.
	20117 Error writing file.
	20118 Error reading key.
	20119 Error writing key.
	20120 Cannot verify signature.
	20121 Cannot create signature.
	20122 Invalid UserId.
	20123 Invalid passphrase.
	20124 Data encryption failed.
	20125 Error creating key.
	20126 Unsupported symmetric algorithm.
	20127 Unsupported hash.
	20128 Unsupported compression algorithm.
	20129 Invalid key usage.
	20130 Component is busy.
	20131 Error decrypting data.
	20132 Data is not compressed.
	20133 Error decompressing data.
	20134 Error compressing data.
	20135 Unsupported signature.
	20136 Failed to overwrite file.
	20142 No input.
	20143 Signing was required, but the message was not signed.
	20144 Encryption was required, but the message was not encrypted.
	20147 No data integrity packet was found (MDC), but one was required.
	20201 Out of memory.