KeyMgr Configuration
The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.KeyMgr Configuration Settings
| ContinueOnInvalidKey:
Whether to continue loading the keyring when an invalid key is found. This setting determines whether the class will continue loading keys when an invalid key is found. This is applicable when calling LoadKeyring. If set to False (default) the class fails with an error. If set to True the class 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 class will additionally create a subkey marked for encryption when calling CreateKey when PublicKeyAlgorithm is set to "RSA". The default is false. | |||||||||||||
| ImportAllKeys:
Whether or not to import all keys found in a key file. When calling ImportKey with a UserId parameter of "*" or "", the class 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. | |||||||||||||
| 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:
| |||||||||||||
| 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. | |||||||||||||
| 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", and "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. | |||||||||||||
| 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. | |||||||||||||
| 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. | |||||||||||||
| 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:
| |||||||||||||
| 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. | |||||||||||||
| 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. | |||||||||||||
| 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:
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. | |||||||||||||
| 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". | |||||||||||||
| EnsureValidDSASignatureHashAlgorithm:
Whether or not to select a suitable signature hash algorithm automatically. The DSA Signature Hash Algorithm selection will ensure that a valid algorithm compatible with DSA is selected. DSA requires that the hash be 160 bits or larger, which means MD5 is not a suitable algorithm. When DSA Signature Hash Algorithm selection is enabled (default) the class will use the preferred algorithm from the key if it meets the requirements for DSA. If the preferred algorithm is MD5 and does not meed the requirements for DSA the class will automatically use a suitable based on the Q element of the DSA key (may be SHA1, SHA224, or SHA256). | |||||||||||||
| 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:
| |||||||||||||
| UseFipsCompliantAlgorithms:
Restricts the usage to FIPS compliant algorithms only. When enabled the class 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:
|
Base Configuration Settings
| SelectWaitMillis:
The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. If there are no events to process when DoEvents is called, the class will wait for the amount of time specified here before returning. The default value is 20. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| CodePage:
The system code page used for Unicode to Multibyte translations. The default code page is the Active Code Page (0). The following is a list of valid code page identifiers:
The following is a list of valid code page identifiers for Mac OS only:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| UseInternalSecurityAPI:
Tells the class whether or not to use the system security libraries or an internal implementation. By default the class will use the system security libraries to perform cryptographic functions. Setting this to True tells the class to use the internal implementation instead of using the system's security API. |