KeyMgr Component
Properties Methods Events Configuration Settings Errors
The KeyMgr component is used to create and manage OpenPGP keys.
Syntax
TipcKeyMgr
Remarks
The KeyMgr component 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 component with short descriptions. Click on the links for further details.
| 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. |
| KeyPassphrase | 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 component 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. |
| 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. |
| Reset | Resets the component 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 component 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. |
Configuration Settings
The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.
| ContinueOnInvalidKey | Whether to continue loading the keyring when an invalid key is found. |
| 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. |
| KeyUsage | Flags that show intended use for the key being created. |
| KeyValidityTime | The validity period for the key being created. |
| PublicKeyAlgorithm | The public key algorithm for the key being created. |
| PublicKeyLength | Specifies the public key length when creating a key. |
| DSAPublicSubKeyLength | Specifies the public subkey length when creating a DSA key. |
| PublicKeySignatureHashAlgorithm | The public key signature hash algorithm used when creating a key. |
| PublicKeyringFile | The file name of the public keyring file. |
| SecretKeyringFile | The file name of the secret keyring file. |
| 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. |
| VersionHeader | The Version header value in ASCII armored public keys. |
| AutoSelectDSASignatureHashAlgorithm | Whether or not to select a suitable signature hash algorithm automatically. |
| LogLevel | Specifies the level of detail that is logged. |
| UseFipsCompliantAlgorithms | Restricts the usage to FIPS compliant algorithms only. |
| CodePage | The system code page used for Unicode to Multibyte translations. |