KeyMgr Control

Properties   Methods   Events   Config Settings   Errors  

The KeyMgr control is used to create and manage OpenPGP keys.

Syntax

KeyMgr

Remarks

The KeyMgr control can be used to perform a variety of key-related actions. You can create, delete, import, export, and manage keys. Both individual keys and keyrings can be created and used.

Property List

---

The following is the full list of the properties of the control with short descriptions. Click on the links for further details.

KeyCurve	This property specifies the elliptic curve used in the ECDSA or EdDSA key.
KeyEffectiveDate	The date when this key becomes valid.
KeyEncoded	The key.
KeyExpirationDate	The date the key expires.
KeyFingerprint	The hex-encoded, 20-byte fingerprint of the key.
KeyId	The hex-encoded, 4-byte key Id.
KeyOtherUserIds	If the specified key has alternate user Ids associated with it, this property returns a comma-separated list of the other user Ids.
KeyPass	The passphrase for the key's secret key (if any).
KeyPublicKey	The public key of the key.
KeyPublicKeyAlgorithm	A text description of the public key algorithm of the key.
KeyPublicKeyLength	The length of the public key in bits.
KeyRevoked	Whether or not the key is revoked.
KeySecretKey	The secret key of the key (if available).
KeySecretKeyAvailable	Whether or not a secret key is available for the selected key.
KeyUsage	A text description of UsageFlags .
KeyUsageFlags	Flags that show the intended use for the key.
KeyUserId	The user Id of the key.
Keyring	The location on disk of the keyring.

Method List

---

The following is the full list of the methods of the control with short descriptions. Click on the links for further details.

AddRevoker	Adds a designated revoker to the key.
AddUserId	Adds the specified user Id to the current key.
ChangeExpirationDate	Changes the expiration date of the key.
ChangePassphrase	Changes the passphrase of the current key.
Config	Sets or retrieves a configuration setting.
CreateKey	Creates an OpenPGP key pair.
CreateSubKey	Creates a new subkey.
DeleteKey	Deletes the specified key.
ExportPublicKey	Exports the public key of the current key.
ExportSecretKey	Exports the private key of the current key.
ImportKey	Imports the key specified by UserId to the current keyring.
ImportKeyB	Imports the key specified by UserId to the current keyring.
ListKeys	Lists keys in the specified Keyring .
ListSignatures	Lists all signatures of the current key.
ListSubkeys	Lists the subkeys of the currently selected key.
LoadKeyring	Loads the keyring from disk.
LoadKeyringB	Loads the keyring from SecretKeyringData and PublicKeyringData .
Reset	Resets the control properties.
RevokeKey	Revokes the specified key.
SaveKeyring	Saves the current Keyring to disk.
SignUserId	Signs the specified user Id of the current key.
VerifyPassphrase	Verifies the passphrase of specified key.

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	Information about errors during data delivery.
KeyList	Fires for each key in the keyring when ListKeys is called.
KeyPassphrase	Fired if the passphrase of current key is incorrect or empty.
SignatureList	Fires for each signature of the current key when ListSignatures is called.
Status	Shows the progress of the operation.
SubkeyList	Fires once for each subkey listed when ListSubkeys is called.

Config Settings

---

The following is a list of config settings for the control with short descriptions. Click on the links for further details.

AllowEmptyPassword	Whether a key can be created without a password.
ContinueOnInvalidKey	Whether to continue loading the keyring when an invalid key is found.
CreateRSASubkeyforEncrypt	Whether to create a subkey when creating an RSA key.
CurrentKeyPrimaryKeyUsageFlags	The usage flags of the currently selected primary key.
Curve	The elliptic curve used when calling CreateKey.
DSAPublicSubKeyLength	Specifies the public subkey length when creating a DSA key.
EnsureValidDSASignatureHashAlgorithm	Whether or not to select a suitable signature hash algorithm automatically.
ImportAllKeys	Whether or not to import all keys found in a key file.
KeyEncryptionAlgorithm	The encryption algorithm used when creating a key.
KeyIdLength	Specifies the length of the key's Id.
KeyringFormat	Which format of keyring to use.
KeyUsage	Flags that show intended use for the key being created.
KeyValidityTime	The validity period for the key being created.
LogLevel	Specifies the level of detail that is logged.
PublicKeyAlgorithm	The public key algorithm for the key being created.
PublicKeyLength	Specifies the public key length when creating a key.
PublicKeyringFile	The file name of the public keyring file.
PublicKeySignatureHashAlgorithm	The public key signature hash algorithm used when creating a key.
RawKeyData	Returns detailed key and keyring data for debugging purposes.
RevocationCode	The reason why the key was revoked.
RevocationReason	Text describing why the key was revoked.
Revoker	The revoker's key Id.
SecretKeyringFile	The file name of the secret keyring file.
SubKeyAlgorithm	The subkey algorithm for the subkey being created.
SubKeyCurve	The elliptic curve of the sub key.
SubKeyUsage	Flags that show intended use for the subkey being created.
UseFipsCompliantAlgorithms	Restricts the usage to FIPS compliant algorithms only.
VersionHeader	The Version header value in ASCII armored public keys.
CodePage	The system code page used for Unicode to Multibyte translations.
MaskSensitive	Whether sensitive data is masked in log messages.
UseInternalSecurityAPI	Tells the control whether or not to use the system security libraries or an internal implementation.

KeyCurve Property (KeyMgr Control)

This property specifies the elliptic curve used in the ECDSA or EdDSA key.

Syntax

keymgrcontrol.KeyCurve

Default Value

""

Remarks

This property specifies the elliptic curve used in the ECDSA or EdDSA key. This property is only applicable if KeyPublicKeyAlgorithm is ECDSA or EdDSA. Possible values are:

Value	PublicKeyAlgorithm	Description
secp256r1	ECDSA	NIST curve P-256
secp384r1	ECDSA	NIST curve P-384
secp521r1	ECDSA	NIST curve P-521
Ed25519	EdDSA	Ed25519
secp256k1	EdDSA	Secp256k1

This property is read-only and not available at design time.

Data Type

String

KeyEffectiveDate Property (KeyMgr Control)

The date when this key becomes valid.

Syntax

keymgrcontrol.KeyEffectiveDate

Default Value

""

Remarks

The date when this key becomes valid. Prior to this it is not valid. The following is an example of a valid encoded date:

23-Jan-2000 15:00:00.

This property is read-only and not available at design time.

Data Type

String

KeyEncoded Property (KeyMgr Control)

The key.

Syntax

keymgrcontrol.KeyEncoded[=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.

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

KeyExpirationDate Property (KeyMgr Control)

The date the key expires.

Syntax

keymgrcontrol.KeyExpirationDate

Default Value

""

Remarks

The date the key expires. After this date the key will no longer be valid. The following is an example of a valid encoded date:

23-Jan-2001 15:00:00.

This property is read-only and not available at design time.

Data Type

String

KeyFingerprint Property (KeyMgr Control)

The hex-encoded, 20-byte fingerprint of the key.

Syntax

keymgrcontrol.KeyFingerprint

Default Value

""

Remarks

The hex-encoded, 20-byte fingerprint of the key.

This is in the form:

5E70662EA810E768391A2FE8F7B7D49C89C9D7B1

This property is read-only and not available at design time.

Data Type

String

KeyId Property (KeyMgr Control)

The hex-encoded, 4-byte key Id.

Syntax

keymgrcontrol.KeyId

Default Value

""

Remarks

The hex-encoded, 4-byte key Id. It is same as last 4 bytes of KeyFingerprint.

This is in the form:

89C9D7B1

The KeyIdLength setting may be set to a value of 8 to return the last 8 bytes instead of the last 4 bytes.

This property is read-only and not available at design time.

Data Type

String

KeyOtherUserIds Property (KeyMgr Control)

If the specified key has alternate user Ids associated with it, this property returns a comma-separated list of the other user Ids.

Syntax

keymgrcontrol.KeyOtherUserIds

Default Value

""

Remarks

If the specified key has alternate user Ids associated with it, this property returns a comma-separated list of the other user Ids.

This property is read-only and not available at design time.

Data Type

String

KeyPass Property (KeyMgr Control)

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

Syntax

keymgrcontrol.KeyPass[=string]

Default Value

""

Remarks

This property is not available at design time.

Data Type

String

KeyPublicKey Property (KeyMgr Control)

The public key of the key.

Syntax

keymgrcontrol.KeyPublicKey

Default Value

""

Remarks

The public key of the key. The key is provided as ASCII armored data.

This property is read-only and not available at design time.

Data Type

String

KeyPublicKeyAlgorithm Property (KeyMgr Control)

A text description of the public key algorithm of the key.

Syntax

keymgrcontrol.KeyPublicKeyAlgorithm

Default Value

""

Remarks

A text description of the public key algorithm of the key. Possible values are:

• RSA
• DSA
• ECDSA
• EdDSA
• RSA-Legacy

This property is read-only and not available at design time.

Data Type

String

KeyPublicKeyLength Property (KeyMgr Control)

The length of the public key in bits.

Syntax

keymgrcontrol.KeyPublicKeyLength

Default Value

0

Remarks

The length of the public key in bits. Common values are 512, 1024, and 2048.

If the KeyPublicKeyAlgorithm property is ECDSA or EcDSA the length of the public key is determined by the KeyCurve. Possible lenghts are:

Curve	Public Key Length (bits)
secp256r1	256
secp384r1	384
secp521r1	521
Ed25519	256
secp256k1	256

This property is read-only and not available at design time.

Data Type

Integer

KeyRevoked Property (KeyMgr Control)

Whether or not the key is revoked.

Syntax

keymgrcontrol.KeyRevoked

Default Value

False

Remarks

Whether or not the key is revoked.

This property is read-only and not available at design time.

Data Type

Boolean

KeySecretKey Property (KeyMgr Control)

The secret key of the key (if available).

Syntax

keymgrcontrol.KeySecretKey

Default Value

""

Remarks

The secret key of the key (if available). The key is provided as ASCII armored data.

This property is read-only and not available at design time.

Data Type

String

KeySecretKeyAvailable Property (KeyMgr Control)

Whether or not a secret key is available for the selected key.

Syntax

keymgrcontrol.KeySecretKeyAvailable

Default Value

False

Remarks

Whether or not a secret key is available for the selected key.

This property is read-only and not available at design time.

Data Type

Boolean

KeyUsage Property (KeyMgr Control)

A text description of UsageFlags .

Syntax

keymgrcontrol.KeyUsage

Default Value

""

Remarks

A text description of KeyUsageFlags.

The value will be of one or more of the following strings, separated by commas:

• Certifying Other Certificates
• Signing Emails and Files
• Encrypting Emails and Files
• Split Key
• Authenticate Against Servers
• Group Key

This property is read-only and not available at design time.

Data Type

String

KeyUsageFlags Property (KeyMgr Control)

Flags that show the intended use for the key.

Syntax

keymgrcontrol.KeyUsageFlags

Default Value

47

Remarks

Flags that show the intended use for the key. The default value is 0x0F. The value of KeyUsageFlags is a combination of the following flags:

0x01	This key may be used to certify other keys.
0x02	This key may be used to sign data.
0x0C	This key may be used to encrypt communications and encrypt storage.
0x10	The private component of this key may have been split by a secret-sharing mechanism.
0x20	This key may be used for authentication.
0x80	The private component of this key may be in the possession of more than one person.

Please refer to the KeyUsage property for a text representation of KeyUsageFlags.

This property is read-only and not available at design time.

Data Type

Integer

KeyUserId Property (KeyMgr Control)

The user Id of the key.

Syntax

keymgrcontrol.KeyUserId[=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.

This property is not available at design time.

Data Type

String

Keyring Property (KeyMgr Control)

The location on disk of the keyring.

Syntax

keymgrcontrol.Keyring

Default Value

""

Remarks

To load a keyring use the LoadKeyring method.

This property is read-only.

Data Type

String

AddRevoker Method (KeyMgr Control)

Adds a designated revoker to the key.

Syntax

keymgrcontrol.AddRevoker UserId

Remarks

This method adds a designated revoker to the selected Key. The UserId parameter specifies the revoker to add. The revoker's key must be present in the current keyring. Use this with caution: once added, a revoker cannot be removed. The key's passphrase is required for this operation and may be specified via KeyPass or through the KeyPassphrase event.

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.

AddUserId Method (KeyMgr Control)

Adds the specified user Id to the current key.

Syntax

keymgrcontrol.AddUserId UserId

Remarks

The key's passphrase is required for this operation and may be specified via KeyPass or through the KeyPassphrase event.

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.

ChangeExpirationDate Method (KeyMgr Control)

Changes the expiration date of the key.

Syntax

keymgrcontrol.ChangeExpirationDate ExpirationDate

Remarks

This method changes the expiration date of the current Key. The ExpirationDate parameter specifies the number of days for which the key is valid starting today. For instance a value of "31" means the key is valid for the next 31 days.

The special value "0" means the key will never expire.

The key's passphrase is required for this operation and may be specified via KeyPass or through the KeyPassphrase event.

Note: See KeyValidityTime for information on specifying the expiration date when creating the key with CreateKey.

ChangePassphrase Method (KeyMgr Control)

Changes the passphrase of the current key.

Syntax

keymgrcontrol.ChangePassphrase Passphrase

Remarks

The Passphrase parameter specifies the new passphrase.

The key's passphrase is required for this operation and may be specified via KeyPass or through the KeyPassphrase event.

Config Method (KeyMgr Control)

Sets or retrieves a configuration setting.

Syntax

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

CreateKey Method (KeyMgr Control)

Creates an OpenPGP key pair.

Syntax

keymgrcontrol.CreateKey UserId, Passphrase

Remarks

This method creates a new OpenPGP key pair. The UserId parameter specifies the user Id of 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.

Additional configuration settings may be set to further configure the details of the key being created. Please see the following settings for details:

• KeyEncryptionAlgorithm
• KeyUsage
• KeyValidityTime
• PublicKeyLength
• PublicKeyAlgorithm
• PublicKeySignatureHashAlgorithm
• Curve
• SubKeyCurve

CreateSubKey Method (KeyMgr Control)

Creates a new subkey.

Syntax

keymgrcontrol.CreateSubKey 

Remarks

This method creates a new subkey. Before calling this method the KeyId property must be set to a valid private key.

The following settings may optionally be set to define specific values for the created subkey:

• KeyValidityTime
• PublicKeyLength
• SubKeyAlgorithm
• SubKeyCurve
• SubKeyUsage

DeleteKey Method (KeyMgr Control)

Deletes the specified key.

Syntax

keymgrcontrol.DeleteKey UserId

Remarks

This method deletes the key specified by UserId from the current keyring. Below is a table of the type of Ids that may be specified to identify the key:

Id Type	Example
UserId	FirstName LastName <user@mail.com>
UserId (name only)	FirstName LastName
UserId (first name only)	FirstName
UserId (email only)	user@mail.com
Short KeyId	89C9D7B1
Long KeyId	F7B7D49C89C9D7B1

ExportPublicKey Method (KeyMgr Control)

Exports the public key of the current key.

Syntax

keymgrcontrol.ExportPublicKey FileName, useAsciiArmor

Remarks

This method exports the public key of the currently selected Key. The FileName parameter specifies the file on disk to which the public key will be written. The UseAsciiArmor parameter determines whether or not ASCII armoring is used when writing the key to disk.

Note: When UseAsciiArmor is set to True the VersionHeader setting may also be set to specify your own header value.

ExportSecretKey Method (KeyMgr Control)

Exports the private key of the current key.

Syntax

keymgrcontrol.ExportSecretKey FileName, useAsciiArmor

Remarks

This method exports the private key of the currently selected Key. The FileName parameter specifies the file on disk that the private key will be written to. The UseAsciiArmor parameter determines whether or not ASCII armoring is used when writing the key to disk.

ImportKey Method (KeyMgr Control)

Imports the key specified by UserId to the current keyring.

Syntax

keymgrcontrol.ImportKey FileName, UserId

Remarks

This method imports the key specified by UserId from the key file specified by FileName into the current Keyring. The imported key will be automatically selected and available in the Key property.

If the FileName specifies a key file which contains multiple keys only the key belonging to UserId will be imported.

If UserId is set to "*" or "" (empty string) all keys in the key file will be imported. The ImportAllKeys setting controls the behavior of the control in this case.

Note: If you simply wish to select a key in the current ring set KeyUserId instead.

ImportKeyB Method (KeyMgr Control)

Imports the key specified by UserId to the current keyring.

Syntax

keymgrcontrol.ImportKeyB Data, UserId

Remarks

This method imports the key specified by UserId from the key data specified by Data into the current Keyring. The imported key will be automatically selected and available in the Key property.

If the Data specifies key data that contains multiple keys only the key belonging to UserId will be imported.

If UserId is set to "*" or "" (empty string) all keys in the key data will be imported. The ImportAllKeys setting controls the behavior of the control in this case.

Note: If you simply wish to select a key in the current ring set KeyUserId instead.

ListKeys Method (KeyMgr Control)

Lists keys in the specified Keyring .

Syntax

keymgrcontrol.ListKeys 

Remarks

This method lists the keys (public/private key pairs) in the specified keyring. The results are provided through the KeyList event.

KeyList data will also be returned from this method, however it is recommended to use the KeyList event if possible.

ListSignatures Method (KeyMgr Control)

Lists all signatures of the current key.

Syntax

keymgrcontrol.ListSignatures 

Remarks

This method lists all the signatures of the currently selected key. The SignatureList event will fire for each signature.

SignatureList data will also be returned from this method. However, it is recommended to use the SignatureList event if possible.

ListSubkeys Method (KeyMgr Control)

Lists the subkeys of the currently selected key.

Syntax

keymgrcontrol.ListSubkeys 

Remarks

This method lists all subkeys of current key. The SubkeyList event will be fired for each subkey.

SubkeyList data will also be returned from this method, however it is recommended to use the SubkeyList event if possible.

LoadKeyring Method (KeyMgr Control)

Loads the keyring from disk.

Syntax

keymgrcontrol.LoadKeyring KeyringPath

Remarks

This method loads the keyring from disk. If the keyring is stored in a directory, set KeyringPath 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 KeyringPath should be set to the path of the file.

When this method is called the control 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.

LoadKeyringB Method (KeyMgr Control)

Loads the keyring from SecretKeyringData and PublicKeyringData .

Syntax

keymgrcontrol.LoadKeyringB SecretKeyringData, PublicKeyringData

Remarks

This method loads the keyring from SecretKeyringData and PublicKeyringData.

When this method is called the control 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.

Reset Method (KeyMgr Control)

Resets the control properties.

Syntax

keymgrcontrol.Reset 

Remarks

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

RevokeKey Method (KeyMgr Control)

Revokes the specified key.

Syntax

keymgrcontrol.RevokeKey KeyId

Remarks

This method revokes the key specified by KeyId and returns the revocation certificate.

When creating a revocation certificate there are two supported formats. The first format includes only the revocation signature. This format is returned by this method. The second format includes both the public key and the revocation signature. This format can be obtained by calling ExportPublicKey after calling this method. Both formats are common, and both formats are acceptable when calling ImportKey.

Before calling this method a key must be selected and available in the Key* properties.

The KeyId may be the Id of the main key or a subkey.

SaveKeyring Method (KeyMgr Control)

Saves the current Keyring to disk.

Syntax

keymgrcontrol.SaveKeyring KeyringPath

Remarks

This method saves the current keyring to disk. There are two output options. The keyring may either be saved to a single key file or may be saved to a directory.

To save the keyring to a directory set KeyringPath to the path. The directory must already exist. The control will create a "pubring.gpg" and "secring.gpg" file in the specified directory. If the files already exist they will be overwritten.

To save the keyring to a key file set KeyringPath to a path and file name. If the file already exists it will be overwritten.

SignUserId Method (KeyMgr Control)

Signs the specified user Id of the current key.

Syntax

keymgrcontrol.SignUserId UserId, IssuerUserId

Remarks

This method signs the UserId with the IssuerUserId.

To sign all user Ids in the current key set the UserId parameter to "*".

The key's passphrase is required for this operation and may be specified via KeyPass or through the KeyPassphrase event.

VerifyPassphrase Method (KeyMgr Control)

Verifies the passphrase of specified key.

Syntax

keymgrcontrol.VerifyPassphrase Passphrase

Remarks

This method verifies the passphrase of the key specified by UserId.

If the password is correct, this method returns True; otherwise, this method returns False.

Error Event (KeyMgr Control)

Information about errors during data delivery.

Syntax

Sub keymgrcontrol_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.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

KeyList Event (KeyMgr Control)

Fires for each key in the keyring when ListKeys is called.

Syntax

Sub keymgrcontrol_KeyList(UserId As String, KeyId As String, Fingerprint As String, HasSecretKey As Boolean, PublicKeyAlgorithm As String, PublicKeyLength As Integer, Curve As String)

Remarks

This event fires once for each key in the Keyring when ListKeys is called.

UserId holds the current user Id of 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.

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

BF52A0AB

Fingerprint holds the hex-encoded, 20-byte fingerprint of the key. This is in the form:

5E70662EA810E768391A2FE8F7B7D49C89C9D7B1

HasSecretKey returns True if the key contains a secret key.

PublicKeyAlgorithm is the public key algorithm. Possible values are:

• RSA
• DSA
• ECDSA
• EdDSA

PublicKeyLength is the length of the public key. Common values are 512, 1024, and 2048. If the PublicKeyAlgorithm is ECDSA or EdDSA the length of the public key is determined by the Curve. Possible lengths are:

Curve	Public Key Length (bits)
secp256r1	256
secp384r1	384
secp521r1	521
Ed25519	256
secp256k1	256

Curve is the curve used by the key when PublicKeyAlgorithm is ECDSA or EdDSA. Possible values are:

Value	PublicKeyAlgorithm	Description
secp256r1	ECDSA	NIST curve P-256
secp384r1	ECDSA	NIST curve P-384
secp521r1	ECDSA	NIST curve P-521
Ed25519	EdDSA	Ed25519
secp256k1	EdDSA	Secp256k1

KeyPassphrase Event (KeyMgr Control)

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

Syntax

Sub keymgrcontrol_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

SignatureList Event (KeyMgr Control)

Fires for each signature of the current key when ListSignatures is called.

Syntax

Sub keymgrcontrol_SignatureList(UserId As String, IssuerKeyId As String, IssuerUserId As String, PublicKeyAlgorithm As String, Curve As String, HashAlgorithm As String, EffectiveDate As String, SignatureClass As Integer, ValidityStatus As Integer)

Remarks

This event fires once for each signature of the current key when ListSignatures is called.

UserId holds the current user Id of 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.

IssuerKeyId is the hex-encoded, 4- or-8-byte Id of the issuer's key. It is the same as the last 4 or 8 bytes of the Fingerprint. For instance: BF52A0AB

IssuerUserId is the user Id of the issuer. If this is empty the issuer's key could not be found in the current keyring.

PublicKeyAlgorithm is the public key algorithm. Possible values are:

• RSA
• DSA
• ECDSA
• EdDSA

Curve is the curve used by the key when PublicKeyAlgorithm is ECDSA or EdDSA. Possible values are:

Value	PublicKeyAlgorithm	Description
secp256r1	ECDSA	NIST curve P-256
secp384r1	ECDSA	NIST curve P-384
secp521r1	ECDSA	NIST curve P-521
Ed25519	EdDSA	Ed25519
secp256k1	EdDSA	Secp256k1

HashAlgorithm is the hash algorithm used by the signature. Possible values are:

• SHA1
• SHA256
• SHA384
• SHA512
• SHA224
• MD5

EffectiveDate is the date when this signature became valid. The following example illustrates the format of an encoded date: 23-Jan-2000 15:00:00 .

SignatureClass is the type of signature. Possible values are:

16	Generic Signature
17	Personal Signature
18	Casual Signature
19	Positive Signature (self-signed)

ValidityStatus specifies the current validity status of the signature. Possible values are:

1	Invalid
2	Valid
3	Unknown (the issuer's public key could not be found)

Status Event (KeyMgr Control)

Shows the progress of the operation.

Syntax

Sub keymgrcontrol_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.

SubkeyList Event (KeyMgr Control)

Fires once for each subkey listed when ListSubkeys is called.

Syntax

Sub keymgrcontrol_SubkeyList(KeyId As String, Fingerprint As String, PublicKeyAlgorithm As String, PublicKeyLength As Integer, Curve As String, UsageFlags As Integer, Usage As String, EffectiveDate As String, ExpirationDate As String, Revoked As Boolean)

Remarks

This event fires once for each subkey when ListSubkeys is called.

KeyId 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

Fingerprint holds the hex-encoded, 20-byte fingerprint of the key. This is in the form:

5E70662EA810E768391A2FE8F7B7D49C89C9D7B1

PublicKeyAlgorithm is the public key algorithm. Possible values are:

• RSA
• Elgamal
• ECDH (Only used with ECDSA and EdDSA keys)

PublicKeyLength is the length of the public key. Common values are 512, 1024, and 2048.

Curve is the curve used by the key when PublicKeyAlgorithm is ECDH. Possible values are:

Value	Description
secp256r1	NIST curve P-256
secp384r1	NIST curve P-384
secp521r1	NIST curve P-521
Curve25519	Curve25519
Ed25519	Ed25519

Usage is the textual description of UsageFlags.

The value will be of one or more of the following strings, separated by commas:

• Certifying Other Certificates
• Signing Emails and Files
• Encrypting Emails and Files
• Split Key
• Authenticate Against Servers
• Group Key

UsageFlags is an integer flag that shows the intended use for the key. The value is a combination of the following flags:

0x01	This key may be used to certify other keys.
0x02	This key may be used to sign data.
0x0C	This key may be used to encrypt communications and encrypt storage.
0x10	The private component of this key may have been split by a secret-sharing mechanism.
0x20	This key may be used for authentication.
0x80	The private component of this key may be in the possession of more than one person.

EffectiveDate is the date when this key became valid. The following example illustrates the format of an encoded date: 23-Jan-2000 15:00:00.

ExpirationDate is the date the key expires. After this date the key will no longer be valid. The following example illustrates the format of an encoded date: 23-Jan-2000 15:00:00. If the ExpirationDate is not populated this indicates that the key never expires.

Revoked Indicates whether the subkey is revoked or not.

Config Settings (KeyMgr 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.

KeyMgr Config Settings

AllowEmptyPassword:   Whether a key can be created without a password. This controls whether a password will be used to encrypt a key. When true, CreateKey will accept an empty string as the password, leaving the key unencrypted. The default is false.

ContinueOnInvalidKey:   Whether to continue loading the keyring when an invalid key is found. This setting determines whether the control will continue loading keys when an invalid key is found. This is applicable when calling LoadKeyring. If set to False (default) the control fails with an error. If set to True the control will fire the Error event with information about the key which failed to load, and then continue loading additional keys.

CreateRSASubkeyforEncrypt:   Whether to create a subkey when creating an RSA key. This setting determines whether the control will additionally create a subkey marked for encryption when calling CreateKey when PublicKeyAlgorithm is set to "RSA". The default is true.

CurrentKeyPrimaryKeyUsageFlags:   The usage flags of the currently selected primary key. When queried, this will return the usage flags of the currently selected primary key, returned in decimal representation. Individual flags may be checked against the list at KeyUsageFlags.

Curve:   The elliptic curve used when calling CreateKey. This setting specifies the curve to use when creating ECDSA or EdDSA keys. This setting is only applicable when PublicKeyAlgorithm is set to ECDSA or EdDSA. Possible values are: Value PublicKeyAlgorithm Description secp256r1 ECDSA NIST curve P-256 secp384r1 ECDSA NIST curve P-384 secp521r1 ECDSA NIST curve P-521 Ed25519 EdDSA Ed25519 secp256k1 EdDSA Secp256k1 The default value is secp256r1 for ECDSA keys and Ed25519 for EdDSA keys.

DSAPublicSubKeyLength:   Specifies the public subkey length when creating a DSA key. This setting is only applicable when creating DSA keys with CreateKey. This specifies the length of the public ElGamal subkey. The value is 0 means this setting is not used and the subkey will have the length defined in PublicKeyLength. The default value is 0.

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

ImportAllKeys:   Whether or not to import all keys found in a key file. When calling ImportKey with a UserId parameter of "*" or "", the control will import all keys found in the file if this property is set to True (default). If this is set to False when the UserId parameter of ImportKey is set to "*" or "", only the first key found in the file will be imported. The default value is True.

KeyEncryptionAlgorithm:   The encryption algorithm used when creating a key. Specifies the encryption algorithm to use when calling CreateKey. The default value is "CAST5". Possible values are "CAST5", "3DES", "AES256", "AES192", "AES128", "IDEA", and "BLOWFISH".

KeyIdLength:   Specifies the length of the key's Id. When querying the KeyId property the value will be returned with the length (in octets) specified. The default value is 4. The only other acceptable value is 8.

KeyringFormat:   Which format of keyring to use. GPG has two formats to store multiple keys. Set this to the correct format. keymgr1.Config("KeyringFormat=2"); Config Value Keyring Format 1 GPG 2.0 and older (Default) 2 GPG 2.1 and newer Versions 2.0 and older use keyrings. Public keys are stored in pubring.gpg. Secret keys are stored in secring.gpg. Versions 2.1 and newer use a keybox. Public keys are stored in a .kbx file. Private keys are stored in private-keys-v1.d.

KeyUsage:   Flags that show intended use for the key being created. When calling CreateKey this setting defines the flags that show the intended use for the key. The default value is (0x0F). The value of KeyUsage is a combination of the following flags: 0x01 This key may be used to certify other keys. 0x02 This key may be used to sign data. 0x0C This key may be used to encrypt communications and encrypt storage. 0x10 The private component of this key may have been split by a secret-sharing mechanism. 0x20 This key may be used for authentication. 0x80 The private component of this key may be in the possession of more than one person.

KeyValidityTime:   The validity period for the key being created. When CreateKey creates a new key, the key is valid the moment it is created. KeyValidityTime determines the number of days until expiration. The default value is 365 days. The special value 0 means the key will never expire.

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.

PublicKeyAlgorithm:   The public key algorithm for the key being created. Specifies the public key algorithm to use when creating the key via CreateKey. The default value is "RSA". Possible values are: RSA DSA ECDSA EdDSA RSA-Legacy The "RSA-Legacy" algorithm should not be used under normal circumstances. It should only be used to create PGP 2.6.2 compatible keys, when required. This type of key will not have subkeys. Note: When creating a DSA key only PublicKeyLength values of 512 and 1024 are supported. Additionally the PublicKeySignatureHashAlgorithm value "MD5" is not supported with DSA keys. ECDSA and EdDSA Notes When creating an ECDSA or EdDSA key the PublicKeyLength value is automatically determined based on the Curve. The Curve and SubKeyCurve settings is also applicable. If Curve and SubKeyCurve are not specified the following defaults will be used: PublicKeyAlgorithm Default Curve ECDSA secp256r1 EdDSA Ed2519

PublicKeyLength:   Specifies the public key length when creating a key. Specifies the length of the public key when calling CreateKey. The default value is 1024. Common values are 512, 1024, and 2048. When PublicKeyAlgorithm is set to ECDSA or EdDSA this setting is not applicable and the public key length is automatically determined based on the Curve selected. The public key length values are as follows: Curve Public Key Length (bits) secp256r1 256 secp384r1 384 secp521r1 521 Ed25519 256 secp256k1 256

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.

PublicKeySignatureHashAlgorithm:   The public key signature hash algorithm used when creating a key. This setting specifies the public key signature algorithm to be used when calling CreateKey. The default value is "SHA256". Possible values are: SHA1 MD5 SHA256 (default) SHA384 SHA512 SHA224

RawKeyData:   Returns detailed key and keyring data for debugging purposes. This setting will return detailed debugging information about the current key and keyring.

RevocationCode:   The reason why the key was revoked. This setting specifies why the key was revoked. It is only applicable if KeyRevoked is True. This may be set before calling RevokeKey and may be inspected after importing and selecting a revoked key. Possible values are: 0 No reason specified 1 Key is superseded 2 Key material has been compromised 3 Key is retired and no longer used 4 User Id information is no longer valid 100-110 Private Use The default value is 0.

RevocationReason:   Text describing why the key was revoked. This setting specifies text description of why the key was revoked. It is only applicable if KeyRevoked is True. This may be set before calling RevokeKey and may be queried after importing and selecting a revoked key. The default value is an empty string.

Revoker:   The revoker's key Id. This setting returns the key Id of the designated revoker associated with this key. This will only be present if a separate revoker was added to the key (for instance by calling AddRevoker). If more than one revoker was added this setting will return a comma-separated list of key Ids.

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.

SubKeyAlgorithm:   The subkey algorithm for the subkey being created. Specifies the public key algorithm to use when creating the key via CreateKey. The default value is "RSA". Possible values are: Key Algorithm Supported Operations RSA Sign and Encrypt DSA Sign Elgamal Encrypt ECDSA Sign EdDSA Sign ECDH Encrypt

SubKeyCurve:   The elliptic curve of the sub key. When calling CreateKey and PublicKeyAlgorithm is set to ECDSA or EdDSA this setting may optionally be specified to set a curve for the subkey which differs from the key curve specified by Curve. Possible values are: Value Description secp256r1 NIST curve P-256 secp384r1 NIST curve P-384 secp521r1 NIST curve P-521 Curve25519 Curve25519 Ed25519 Ed25519 The default value for ECDSA keys is the same value as specified in Curve. The default value for EdDSA keys is Curve25519. Note: It is valid to specify the subkey curve of Curve25519 when Curve is set to secp256r1, secp384r1, or secp521r1. It is also valid to set a subkey curve of secp256r1, secp384r1, or secp521r1 when Curve is set to Ed25519.

SubKeyUsage:   Flags that show intended use for the subkey being created. When calling CreateSubKey this setting defines the flags that show the intended use for the key. The default value is (0x0C). The value of SubKeyUsage is a combination of the following flags: 0x01 This key may be used to certify other keys. 0x02 This key may be used to sign data. 0x0C This key may be used to encrypt communications and encrypt storage. 0x10 The private component of this key may have been split by a secret-sharing mechanism. 0x20 This key may be used for authentication. 0x80 The private component of this key may be in the possession of more than one person.

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 ASCII armored public keys. This setting specifies the Version header value included in newly created public keys. This includes keys that are exported via ExportPublicKey where the UseAsciiArmor parameter is true. The default value is "IPWorks! OpenPGP v9.0".

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:   Tells the control 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 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 (KeyMgr 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.