PGPKeyring Class

Properties Methods Events Configuration Settings Errors

The PGPKeyring class accesses and manages PGP keyring files.

Syntax

class secureblackbox.PGPKeyring

Remarks

PGPKeyring is used to hold and access PGP keys. It contains information about both public keys and secret keys, which are usually stored in two separate files: "public keyring" and "secret keyring", respectively.

Property List

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


opened	Indicates if the keyring is in an opened state.
pinned_key_handle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
public_key_count	The number of records in the PublicKey arrays.
public_key_bits_in_key	Indicates the key length in bits.
public_key_can_encrypt	Returns True if this key can be used for encryption.
public_key_can_sign	Returns True if this key can be used for signing.
public_key_curve	Indicates the elliptic curve associated with a EC key.
public_key_enabled	Enables or disables this key for use in encryption or signing operation.
public_key_encryption_algorithm	Indicates the symmetric algorithm used to encrypt the secret key.
public_key_expires	Indicates key expiration time in whole days from its generation moment.
public_key_handle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
public_key_hash_algorithm	Specifies the hash algorithm associated with the key.
public_key_is_public	Returns True if this key is a public key, and False otherwise.
public_key_is_secret	Returns True if this key is a secret key, and False otherwise.
public_key_is_subkey	Returns True if this key is a subkey of another key, and False otherwise.
public_key_key_fp	The 20-byte fingerprint (hash value) of this key.
public_key_key_hash_algorithm	Specifies the hash algorithm used with DSA keys to calculate signatures.
public_key_key_id	Contains a 8-byte key identifier.
public_key_old_packet_format	Indicates whether legacy (PGP 2.
public_key_passphrase	The key protection password.
public_key_passphrase_valid	Use this property to check whether the specified Passphrase is valid and can be used to unlock the secret key.
public_key_primary_key_id	If this key is a subkey ( IsSubkey returns True), this property contains the identifier of the subkey's primary key.
public_key_protection	Specifies the level of protection applied to the secret key.
public_key_public_key_algorithm	Specifies the asymmetric algorithm of the key.
public_key_q_bits	The length of the DSA Q (legitimate range: 160-512).
public_key_revoked	Returns True if the key has been revoked, and False otherwise.
public_key_subkey_fp	The 20-byte fingerprint (hash value) of this key's subkey.
public_key_subkey_id	Contains a 8-byte subkey identifier.
public_key_timestamp	Use this property to check the time the key was generated.
public_key_username	Specifies the name of the user bound to this key.
public_key_valid	Indicates the validity status of the key.
public_key_version	Indicates the key version.
secret_key_count	The number of records in the SecretKey arrays.
secret_key_bits_in_key	Indicates the key length in bits.
secret_key_can_encrypt	Returns True if this key can be used for encryption.
secret_key_can_sign	Returns True if this key can be used for signing.
secret_key_curve	Indicates the elliptic curve associated with a EC key.
secret_key_enabled	Enables or disables this key for use in encryption or signing operation.
secret_key_encryption_algorithm	Indicates the symmetric algorithm used to encrypt the secret key.
secret_key_expires	Indicates key expiration time in whole days from its generation moment.
secret_key_handle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
secret_key_hash_algorithm	Specifies the hash algorithm associated with the key.
secret_key_is_public	Returns True if this key is a public key, and False otherwise.
secret_key_is_secret	Returns True if this key is a secret key, and False otherwise.
secret_key_is_subkey	Returns True if this key is a subkey of another key, and False otherwise.
secret_key_key_fp	The 20-byte fingerprint (hash value) of this key.
secret_key_key_hash_algorithm	Specifies the hash algorithm used with DSA keys to calculate signatures.
secret_key_key_id	Contains a 8-byte key identifier.
secret_key_old_packet_format	Indicates whether legacy (PGP 2.
secret_key_passphrase	The key protection password.
secret_key_passphrase_valid	Use this property to check whether the specified Passphrase is valid and can be used to unlock the secret key.
secret_key_primary_key_id	If this key is a subkey ( IsSubkey returns True), this property contains the identifier of the subkey's primary key.
secret_key_protection	Specifies the level of protection applied to the secret key.
secret_key_public_key_algorithm	Specifies the asymmetric algorithm of the key.
secret_key_q_bits	The length of the DSA Q (legitimate range: 160-512).
secret_key_revoked	Returns True if the key has been revoked, and False otherwise.
secret_key_subkey_fp	The 20-byte fingerprint (hash value) of this key's subkey.
secret_key_subkey_id	Contains a 8-byte subkey identifier.
secret_key_timestamp	Use this property to check the time the key was generated.
secret_key_username	Specifies the name of the user bound to this key.
secret_key_valid	Indicates the validity status of the key.
secret_key_version	Indicates the key version.
selected_public_key_count	The number of records in the SelectedPublicKey arrays.
selected_public_key_bits_in_key	Indicates the key length in bits.
selected_public_key_can_encrypt	Returns True if this key can be used for encryption.
selected_public_key_can_sign	Returns True if this key can be used for signing.
selected_public_key_curve	Indicates the elliptic curve associated with a EC key.
selected_public_key_enabled	Enables or disables this key for use in encryption or signing operation.
selected_public_key_encryption_algorithm	Indicates the symmetric algorithm used to encrypt the secret key.
selected_public_key_expires	Indicates key expiration time in whole days from its generation moment.
selected_public_key_handle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
selected_public_key_hash_algorithm	Specifies the hash algorithm associated with the key.
selected_public_key_is_public	Returns True if this key is a public key, and False otherwise.
selected_public_key_is_secret	Returns True if this key is a secret key, and False otherwise.
selected_public_key_is_subkey	Returns True if this key is a subkey of another key, and False otherwise.
selected_public_key_key_fp	The 20-byte fingerprint (hash value) of this key.
selected_public_key_key_hash_algorithm	Specifies the hash algorithm used with DSA keys to calculate signatures.
selected_public_key_key_id	Contains a 8-byte key identifier.
selected_public_key_old_packet_format	Indicates whether legacy (PGP 2.
selected_public_key_passphrase	The key protection password.
selected_public_key_passphrase_valid	Use this property to check whether the specified Passphrase is valid and can be used to unlock the secret key.
selected_public_key_primary_key_id	If this key is a subkey ( IsSubkey returns True), this property contains the identifier of the subkey's primary key.
selected_public_key_protection	Specifies the level of protection applied to the secret key.
selected_public_key_public_key_algorithm	Specifies the asymmetric algorithm of the key.
selected_public_key_q_bits	The length of the DSA Q (legitimate range: 160-512).
selected_public_key_revoked	Returns True if the key has been revoked, and False otherwise.
selected_public_key_subkey_fp	The 20-byte fingerprint (hash value) of this key's subkey.
selected_public_key_subkey_id	Contains a 8-byte subkey identifier.
selected_public_key_timestamp	Use this property to check the time the key was generated.
selected_public_key_username	Specifies the name of the user bound to this key.
selected_public_key_valid	Indicates the validity status of the key.
selected_public_key_version	Indicates the key version.
selected_secret_key_count	The number of records in the SelectedSecretKey arrays.
selected_secret_key_bits_in_key	Indicates the key length in bits.
selected_secret_key_can_encrypt	Returns True if this key can be used for encryption.
selected_secret_key_can_sign	Returns True if this key can be used for signing.
selected_secret_key_curve	Indicates the elliptic curve associated with a EC key.
selected_secret_key_enabled	Enables or disables this key for use in encryption or signing operation.
selected_secret_key_encryption_algorithm	Indicates the symmetric algorithm used to encrypt the secret key.
selected_secret_key_expires	Indicates key expiration time in whole days from its generation moment.
selected_secret_key_handle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
selected_secret_key_hash_algorithm	Specifies the hash algorithm associated with the key.
selected_secret_key_is_public	Returns True if this key is a public key, and False otherwise.
selected_secret_key_is_secret	Returns True if this key is a secret key, and False otherwise.
selected_secret_key_is_subkey	Returns True if this key is a subkey of another key, and False otherwise.
selected_secret_key_key_fp	The 20-byte fingerprint (hash value) of this key.
selected_secret_key_key_hash_algorithm	Specifies the hash algorithm used with DSA keys to calculate signatures.
selected_secret_key_key_id	Contains a 8-byte key identifier.
selected_secret_key_old_packet_format	Indicates whether legacy (PGP 2.
selected_secret_key_passphrase	The key protection password.
selected_secret_key_passphrase_valid	Use this property to check whether the specified Passphrase is valid and can be used to unlock the secret key.
selected_secret_key_primary_key_id	If this key is a subkey ( IsSubkey returns True), this property contains the identifier of the subkey's primary key.
selected_secret_key_protection	Specifies the level of protection applied to the secret key.
selected_secret_key_public_key_algorithm	Specifies the asymmetric algorithm of the key.
selected_secret_key_q_bits	The length of the DSA Q (legitimate range: 160-512).
selected_secret_key_revoked	Returns True if the key has been revoked, and False otherwise.
selected_secret_key_subkey_fp	The 20-byte fingerprint (hash value) of this key's subkey.
selected_secret_key_subkey_id	Contains a 8-byte subkey identifier.
selected_secret_key_timestamp	Use this property to check the time the key was generated.
selected_secret_key_username	Specifies the name of the user bound to this key.
selected_secret_key_valid	Indicates the validity status of the key.
selected_secret_key_version	Indicates the key version.

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_from_file	Adds an existing key to the keyring.
add_from_files	Adds a collection of keys to the keyring.
add_pinned	Adds a pinned secret key to the keyring.
clear	Removes all the keys from the keyring.
close	Closes the keyring.
config	Sets or retrieves a configuration setting.
create_new	Creates a new empty keyring.
load	Loads a keyring from disk.
load_from_bytes	Loads a keyring from two byte arrays.
remove_by_id	Removes key by its ID.
remove_public	Removes the specified public key from the keyring.
remove_secret	Removes the specified secret key from the keyring.
save	Saves the keyring to disk.
save_to_bytes	Saves the keyring to a byte array.
select	Filters a selection of keys from the keyring using a template.

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	Location where the temporary files are stored.
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.