IPWorks OpenPGP 2020 Android Edition

Questions / Feedback?

KeyMgr Component

Properties   Methods   Events   Configuration Settings   Errors  

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

Syntax

IPWorksOpenPGP.Keymgr

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.

KeyThe currently selected key.
KeyringThe 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.

addRevokerAdds a designated revoker to the key.
addUserIdAdds the specified user Id to the current key.
changeExpirationDateChanges the expiration date of the key.
changePassphraseChanges the passphrase of the current key.
configSets or retrieves a configuration setting.
createKeyCreates an OpenPGP key pair.
createSubKeyCreates a new subkey.
deleteKeyDeletes the specified key.
exportPublicKeyExports the public key of the current key.
exportSecretKeyExports the private key of the current key.
importKeyImports the key specified by UserId to the current keyring.
importKeyBImports the key specified by UserId to the current keyring.
listKeysLists keys in the specified Keyring .
listSignaturesLists all signatures of the current key.
listSubkeysLists the subkeys of the currently selected key.
loadKeyringLoads the keyring from disk.
resetResets the component properties.
revokeKeyRevokes the specified key.
saveKeyringSaves the current Keyring to disk.
signUserIdSigns the specified user Id of the current key.
verifyPassphraseVerifies 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.

ErrorInformation about errors during data delivery.
KeyListFires for each key in the keyring when ListKeys is called.
KeyPassphraseFired if the passphrase of current key is incorrect or empty.
SignatureListFires for each signature of the current key when ListSignatures is called.
StatusShows the progress of the operation.
SubkeyListFires 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.

AllowEmptyPasswordWhether a key can be created without a password.
ChangeSubkeyPassphraseWhether or not the passphrase for subkey's should be changed.
ContinueOnInvalidKeyWhether to continue loading the keyring when an invalid key is found.
CreateRSASubkeyforEncryptWhether to create a subkey when creating an RSA key.
CurrentKeyPrimaryKeyUsageFlagsThe usage flags of the currently selected primary key.
CurveThe elliptic curve used when calling CreateKey.
DSAPublicSubKeyLengthSpecifies the public subkey length when creating a DSA key.
EnsureValidDSASignatureHashAlgorithmWhether or not to select a suitable signature hash algorithm automatically.
ImportAllKeysWhether or not to import all keys found in a key file.
KeyEncryptionAlgorithmThe encryption algorithm used when creating a key.
KeyIdLengthSpecifies the length of the key's Id.
KeyUsageFlags that show intended use for the key being created.
KeyValidityTimeThe validity period for the key being created.
LogLevelSpecifies the level of detail that is logged.
PublicKeyAlgorithmThe public key algorithm for the key being created.
PublicKeyLengthSpecifies the public key length when creating a key.
PublicKeyringFileThe file name of the public keyring file.
PublicKeySignatureHashAlgorithmThe public key signature hash algorithm used when creating a key.
RawKeyDataReturns detailed key and keyring data for debugging purposes.
RevocationCodeThe reason why the key was revoked.
RevocationReasonText describing why the key was revoked.
RevokerThe revoker's key Id.
SecretKeyringFileThe file name of the secret keyring file.
SubKeyAlgorithmThe subkey algorithm for the subkey being created.
SubKeyCurveThe elliptic curve of the sub key.
SubKeyUsageFlags that show intended use for the subkey being created.
UseFipsCompliantAlgorithmsRestricts the usage to FIPS compliant algorithms only.
VersionHeaderThe Version header value in ASCII armored public keys.
BuildInfoInformation about the product's build.
GUIAvailableTells the component whether or not a message loop is available for processing events.
LicenseInfoInformation about the current license.
UseDaemonThreadsWhether threads created by the component are daemon threads.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks OpenPGP 2020 Android Edition - Version 20.0 [Build 8161]