IPWorks OpenPGP 2020 Python Edition

Questions / Feedback?

KeyMgr Class

Properties   Methods   Events   Configuration Settings   Errors  

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

Syntax

class ipworksopenpgp.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_curveThis property specifies the elliptic curve used in the ECDSA or EdDSA key.
key_effective_dateThe date when this key becomes valid.
key_encodedThe key.
key_expiration_dateThe date the key expires.
key_fingerprintThe hex-encoded, 20-byte fingerprint of the key.
key_idThe hex-encoded, 4-byte key Id.
key_other_user_idsIf the specified key has alternate user Ids associated with it, this property returns a comma-separated list of the other user Ids.
key_passphraseThe passphrase for the key's secret key (if any).
key_public_keyThe public key of the key.
key_public_key_algorithmA text description of the public key algorithm of the key.
key_public_key_lengthThe length of the public key in bits.
key_revokedWhether or not the key is revoked.
key_secret_keyThe secret key of the key (if available).
key_secret_key_availableWhether or not a secret key is available for the selected key.
key_usageA text description of UsageFlags .
key_usage_flagsFlags that show the intended use for the key.
key_user_idThe user Id of the key.
keyringThe 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_revokerAdds a designated revoker to the key.
add_user_idAdds the specified user Id to the current key.
change_expiration_dateChanges the expiration date of the key.
change_passphraseChanges the passphrase of the current key.
configSets or retrieves a configuration setting.
create_keyCreates an OpenPGP key pair.
create_sub_keyCreates a new subkey.
delete_keyDeletes the specified key.
export_public_keyExports the public key of the current key.
export_secret_keyExports the private key of the current key.
import_keyImports the key specified by UserId to the current keyring.
import_keybImports the key specified by UserId to the current keyring.
list_keysLists keys in the specified Keyring .
list_signaturesLists all signatures of the current key.
list_subkeysLists the subkeys of the currently selected key.
load_keyringLoads the keyring from disk.
resetResets the class properties.
revoke_keyRevokes the specified key.
save_keyringSaves the current Keyring to disk.
sign_user_idSigns the specified user Id of the current key.
verify_passphraseVerifies 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_errorInformation about errors during data delivery.
on_key_listFires for each key in the keyring when ListKeys is called.
on_key_passphraseFired if the passphrase of current key is incorrect or empty.
on_signature_listFires for each signature of the current key when ListSignatures is called.
on_statusShows the progress of the operation.
on_subkey_listFires 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.

AllowEmptyPasswordWhether a key can be created without a password.
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.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
ProcessIdleEventsWhether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillisThe length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPITells the class 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 Python Edition - Version 20.0 [Build 8161]