PGPKeyManager Class

Properties Methods Events Configuration Settings Errors

The PGPKeyManager class manages PGP keys.

Syntax

class secureblackbox.PGPKeyManager

Remarks

PGPKeyManager allows you to load, save, generate, import, and export PGP keys.

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_bits_in_key	Indicates the key length in bits.
key_curve	Indicates the elliptic curve associated with a EC key.
key_encryption_algorithm	Indicates the symmetric algorithm used to encrypt the secret key.
key_expires	Indicates key expiration time in whole days from its generation moment.
key_handle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
key_hash_algorithm	Specifies the hash algorithm associated with the key.
key_old_packet_format	Indicates whether legacy (PGP 2.
key_passphrase	The key protection password.
key_protection	Specifies the level of protection applied to the secret key.
key_public_key_algorithm	Specifies the asymmetric algorithm of the key.
key_q_bits	The length of the DSA Q (legitimate range: 160-512).
key_username	Specifies the name of the user bound to this key.

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_subkey	Adds a new subkey to the Key.
bind_user	Binds a new UserID to the Key.
change_passphrase	Changes the password of the secret key.
change_protection	Changes the protection level of the secret key.
check_passphrase	Checks if the password matches the secret key.
config	Sets or retrieves a configuration setting.
export_key	Serializes the key to a byte array.
export_public_key	Exports the public key to a byte array.
export_public_to_file	Exports the public key to a file.
export_to_file	Exports the key to a file.
generate	Generates a new single PGP key.
generate_legacy	Generates a new key in the old format.
generate_pair	Generates a new pair of PGP keys.
import_from_file	Loads a key from a file.
import_key	Loads a key from a byte array.
remove_subkey	Removes the specified subkey from the key.
remove_user	Unbinds the specified user from the key.
revoke_key	Revokes the key.
revoke_subkey	Revokes the key's subkey.
revoke_subkeyby_id	Revokes the key's subkey.
revoke_user	Revokes a user certification.
revoke_user_by_name	Revokes a user certification.
validate	Validates the 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 PGP key management.
on_notification	This event notifies the application about an underlying control flow event.

Configuration Settings

The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.


TempPath	Path for storing temporary files.
CheckKeyIntegrityBeforeUse	Enables or disable private key integrity check before use.
CookieCaching	Specifies whether a cookie cache should be used for HTTP(S) transports.
Cookies	Gets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only).
DefDeriveKeyIterations	Specifies the default key derivation algorithm iteration count.
EnableClientSideSSLFFDHE	Enables or disables finite field DHE key exchange support in TLS clients.
GlobalCookies	Gets or sets global cookies for all the HTTP transports.
HttpUserAgent	Specifies the user agent name to be used by all HTTP clients.
LogDestination	Specifies the debug log destination.
LogDetails	Specifies the debug log details to dump.
LogFile	Specifies the debug log filename.
LogFilters	Specifies the debug log filters.
LogFlushMode	Specifies the log flush mode.
LogLevel	Specifies the debug log level.
LogMaxEventCount	Specifies the maximum number of events to cache before further action is taken.
LogRotationMode	Specifies the log rotation mode.
MaxASN1BufferLength	Specifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepth	Specifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithm	Specifies the hash algorithm to be used to identify certificates in OCSP requests.
UseOwnDNSResolver	Specifies whether the client classes should use own DNS resolver.
UseSharedSystemStorages	Specifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemOAEPAndPSS	Enforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandom	Enables or disables the use of the OS PRNG.