KeyMgr Class

Properties Methods Events Configuration Settings Errors

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

Syntax

class ipworksencrypt.KeyMgr

Remarks

The KeyMgr class 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 class with short descriptions. Click on the links for further details.


key_curve	This property specifies the elliptic curve used in the ECDSA or EdDSA key.
key_effective_date	The date when this key becomes valid.
key_encoded	The key.
key_expiration_date	The date the key expires.
key_fingerprint	The hex-encoded, 20-byte fingerprint of the key.
key_id	The hex-encoded, 4-byte key Id.
key_other_user_ids	If the specified key has alternate user Ids associated with it, this property returns a comma-separated list of the other user Ids.
key_passphrase	The passphrase for the key's secret key (if any).
key_public_key	The public key of the key.
key_public_key_algorithm	A text description of the public key algorithm of the key.
key_public_key_length	The length of the public key in bits.
key_revoked	Whether or not the key is revoked.
key_secret_key	The secret key of the key (if available).
key_secret_key_available	Whether or not a secret key is available for the selected key.
key_usage	A text description of UsageFlags .
key_usage_flags	Flags that show the intended use for the key.
key_user_id	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 class with short descriptions. Click on the links for further details.


add_revoker	Adds a designated revoker to the key.
add_user_id	Adds the specified user Id to the current key.
change_expiration_date	Changes the expiration date of the key.
change_passphrase	Changes the passphrase of the current key.
config	Sets or retrieves a configuration setting.
create_key	Creates an OpenPGP key pair.
create_sub_key	Creates a new subkey.
delete_key	Deletes the specified key.
export_public_key	Exports the public key of the current key.
export_secret_key	Exports the private key of the current key.
import_key	Imports the key specified by UserId to the current keyring.
import_keyb	Imports the key specified by UserId to the current keyring.
list_keys	Lists keys in the specified Keyring .
list_signatures	Lists all signatures of the current key.
list_subkeys	Lists the subkeys of the currently selected key.
load_keyring	Loads the keyring from disk.
reset	Resets the class properties.
revoke_key	Revokes the specified key.
save_keyring	Saves the current Keyring to disk.
sign_user_id	Signs the specified user Id of the current key.
verify_passphrase	Verifies the passphrase of specified key.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.


on_error	Information about errors during data delivery.
on_key_list	Fires for each key in the keyring when ListKeys is called.
on_key_passphrase	Fired if the passphrase of current key is incorrect or empty.
on_signature_list	Fires for each signature of the current key when ListSignatures is called.
on_status	Shows the progress of the operation.
on_subkey_list	Fires once for each subkey listed when ListSubkeys is called.

Configuration Settings

The following is a list of configuration settings for the class 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.
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.
BuildInfo	Information about the product's build.
CodePage	The system code page used for Unicode to Multibyte translations.
LicenseInfo	Information about the current license.
ProcessIdleEvents	Whether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillis	The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPI	Tells the class whether or not to use the system security libraries or an internal implementation.