# PGPKeyManager Class The PGPKeyManager class manages individual PGP keys. ## Syntax ```text class secureblackbox.PGPKeyManager ``` ## Remarks PGPKeyManager provides means for generating, checking, and editing individual PGP keys. PGPKeyManager can work with RSA, Elgamal (DH), ECDSA, DSS, and EdDSA keypairs with or without subkeys. Public and private PGP keys of versions 2, 3, 4, 5, and 6 are supported. Note: if you are looking to work with multi-key files ('keyrings'), please see the [PGPKeyring](PGPKeyring.md#PGPKeyring) component instead. PGPKeyManager works with individual PGP key structures ('key trees' - one primary key with subkeys). For that same reason, consider using [PGPKeyring](PGPKeyring.md#PGPKeyring) for loading keys that are to be used with [PGPWriter](PGPWriter.md#PGPWriter) and [PGPReader](PGPReader.md#PGPReader) for signing or encryption. It is often the case that even allegedly single-key files actually contain more than one key tree, which may lead to key material loss if they are loaded into PGPKeyManager. Or, putting it in a simple way: - Use PGPKeyManager if you need to *alter* a key (e.g. generate, add or remove subkeys, revoke, re-sign, change password). - Where you need to *use* an existing key (e.g. for signing), use [PGPKeyring](PGPKeyring.md#PGPKeyring), even if it is a standalone key. - To alter a key residing in a keyring, load the keyring files into [PGPKeyring](PGPKeyring.md#PGPKeyring) first. The assign the key in question to PGPKeyManager, make the necessary changes, return it back to the keyring, and re-save the keyring. You can load keys into a PGPKeyManager object in one of the following ways: - By loading it from a file or memory using [import_from_file](#import_from_file-method) or [import_bytes](#import_bytes-method) methods. - By importing it from a PGPKeyring object using [import_pinned](#import_pinned-method) method. - By generating it using [generate_pair](#generate_pair-method) or [create_key](#create_key-method) methods. ```text Mgr.ImportFromFile("key.pub"); ``` Once you have the key loaded in your PGPKeyManager object, you can perform a variety of operations on it: - Iterate over elements of the key tree using subkeys, signatures, and users collections. - Add new subkeys to it using [create_subkey](#create_subkey-method) method. Note that your new subkey is unlikely to be accepted elsewhere unless you sign it. - Add new user records to the key with [create_user](#create_user-method) method. - Signing keys, subkeys, and user records (existing or new) with this or another private key using [sign_key](#sign_key-method), [sign_subkey](#sign_subkey-method), and [sign_user](#sign_user-method) methods. The new signatures are added to the key tree. - Remove or revoke existing subkeys, user records, and signatures. - Change the key protection level or password. Note: Use pinning to copy keys between PGPKeyring and PGPKeyManager: ```text Keyring.PinnedKey = Mgr.Key; Keyring.ImportPinned(); Mgr.PinnedKey = Keyring.SelectedKeys[i]; Mgr.ImportPinned(); ``` Once your work with the key tree has completed, save it to a buffer or file using [export_bytes](#export_bytes-method) and [export_to_file](#export_to_file-method) methods. ## 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](#key_bits_in_key-property) | Indicates the key length in bits. | | [key_can_encrypt](#key_can_encrypt-property) | Returns True if this key can be used for encryption. | | [key_can_sign](#key_can_sign-property) | Returns True if this key can be used for signing. | | [key_curve](#key_curve-property) | Indicates the elliptic curve associated with a EC key. | | [key_enabled](#key_enabled-property) | Enables or disables this key for use in encryption or signing operation. | | [key_encryption_algorithm](#key_encryption_algorithm-property) | Indicates the symmetric algorithm used to encrypt the secret key. | | [key_is_public](#key_is_public-property) | Returns True if this key is a public key, and False otherwise. | | [key_is_secret](#key_is_secret-property) | Returns True if this key is a secret key, and False otherwise. | | [key_is_subkey](#key_is_subkey-property) | Returns True if this key is a subkey of another key, and False otherwise. | | [key_fp](#key_fp-property) | The 20-byte fingerprint (hash value) of this key. | | [key_id](#key_id-property) | Contains a 8-byte key identifier. | | [key_passphrase](#key_passphrase-property) | The key protection password. | | [key_passphrase_valid](#key_passphrase_valid-property) | Use this property to check whether the specified Passphrase is valid and can be used to unlock the secret key. | | [key_primary_key_id](#key_primary_key_id-property) | If this key is a subkey ( IsSubkey returns True), this property contains the identifier of the subkey's primary key. | | [key_protection](#key_protection-property) | Specifies the level of protection applied to the secret key. | | [key_public_key_algorithm](#key_public_key_algorithm-property) | Specifies the asymmetric algorithm of the key. | | [key_q_bits](#key_q_bits-property) | The length of the DSA Q (legitimate range: 160-512). | | [key_timestamp](#key_timestamp-property) | Use this property to check the time the key was generated. | | [key_username](#key_username-property) | Specifies the name of the user bound to this key. | | [key_valid_to](#key_valid_to-property) | Provide accurate expiration moment indication. | | [key_version](#key_version-property) | Indicates the key version. | | [pinned_key_handle](#pinned_key_handle-property) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [signature_count](#signature_count-property) | The number of records in the Signature arrays. | | [signature_certification_type](#signature_certification_type-property) | Specifies the type of a UserID signature. | | [signature_creation_time](#signature_creation_time-property) | The time when the signature was created, in Universal Coordinated Time (UTC). | | [signature_expiration_time](#signature_expiration_time-property) | Specifies signature expiration time, in seconds since its creation time (CreationTime). | | [signature_exportable](#signature_exportable-property) | Specifies whether a certification signature is "exportable", meaning it can be used by entities other than the signature's issuer. | | [signature_handle](#signature_handle-property) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [signature_hash_algorithm](#signature_hash_algorithm-property) | Specifies the hash algorithm used in the signature. | | [signature_hash_mark](#signature_hash_mark-property) | Returns the hash mark attribute of a signature. | | [signature_key_expiration_time](#signature_key_expiration_time-property) | The number of seconds after which the signed key will expire. | | [signature_key_flags](#signature_key_flags-property) | Returns the key flags included in the signature. | | [signature_legacy_format](#signature_legacy_format-property) | Indicates whether signature uses PGP 2. | | [signature_policy_url](#signature_policy_url-property) | Contains the URL of the signature policy. | | [signature_preferred_algorithms](#signature_preferred_algorithms-property) | Contains a list of algorithms preferred by the signed key holder. | | [signature_primary_user_id](#signature_primary_user_id-property) | Indicates whether the UserID covered by the signature is the main user id for this key. | | [signature_reason_for_revocation](#signature_reason_for_revocation-property) | Describes the reason why the key or the certificate was revoked. | | [signature_revocable](#signature_revocable-property) | Specifies whether the signature can be revoked. | | [signature_revocation](#signature_revocation-property) | Indicates whether or not the signature is a revocation signature. | | [signature_class](#signature_class-property) | Indicates the signature class. | | [signature_signer_key_id](#signature_signer_key_id-property) | Indicates the KeyID of the signing key. | | [signature_signer_user_id](#signature_signer_user_id-property) | Indicates the UserID associated with the signing key. | | [signature_strictly_valid](#signature_strictly_valid-property) | Returns True if this signature is valid in a strict way (no compatibility relaxations). | | [signature_target](#signature_target-property) | Indicates the KeyID or Username of the target key or user. | | [signature_text_signature](#signature_text_signature-property) | Indicates whether or not the signature is made over a text document. | | [signature_trust_amount](#signature_trust_amount-property) | Specifies the amount of trust assigned by this signature. | | [signature_trust_level](#signature_trust_level-property) | The trust level assigned by this signature. | | [signature_validated](#signature_validated-property) | Whether the signature has been validated. | | [signature_validity](#signature_validity-property) | Provides the validity status of the signature if the signature has been validated. | | [signature_version](#signature_version-property) | Indicates the signature version. | | [signing_key_handle](#signing_key_handle-property) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [subkey_count](#subkey_count-property) | The number of records in the Subkey arrays. | | [subkey_bits_in_key](#subkey_bits_in_key-property) | Indicates the key length in bits. | | [subkey_can_encrypt](#subkey_can_encrypt-property) | Returns True if this key can be used for encryption. | | [subkey_can_sign](#subkey_can_sign-property) | Returns True if this key can be used for signing. | | [subkey_curve](#subkey_curve-property) | Indicates the elliptic curve associated with a EC key. | | [subkey_enabled](#subkey_enabled-property) | Enables or disables this key for use in encryption or signing operation. | | [subkey_encryption_algorithm](#subkey_encryption_algorithm-property) | Indicates the symmetric algorithm used to encrypt the secret key. | | [subkey_handle](#subkey_handle-property) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [subkey_is_public](#subkey_is_public-property) | Returns True if this key is a public key, and False otherwise. | | [subkey_is_secret](#subkey_is_secret-property) | Returns True if this key is a secret key, and False otherwise. | | [subkey_is_subkey](#subkey_is_subkey-property) | Returns True if this key is a subkey of another key, and False otherwise. | | [subkey_key_fp](#subkey_key_fp-property) | The 20-byte fingerprint (hash value) of this key. | | [subkey_key_id](#subkey_key_id-property) | Contains a 8-byte key identifier. | | [subkey_passphrase](#subkey_passphrase-property) | The key protection password. | | [subkey_passphrase_valid](#subkey_passphrase_valid-property) | Use this property to check whether the specified Passphrase is valid and can be used to unlock the secret key. | | [subkey_primary_key_id](#subkey_primary_key_id-property) | If this key is a subkey ( IsSubkey returns True), this property contains the identifier of the subkey's primary key. | | [subkey_protection](#subkey_protection-property) | Specifies the level of protection applied to the secret key. | | [subkey_public_key_algorithm](#subkey_public_key_algorithm-property) | Specifies the asymmetric algorithm of the key. | | [subkey_q_bits](#subkey_q_bits-property) | The length of the DSA Q (legitimate range: 160-512). | | [subkey_timestamp](#subkey_timestamp-property) | Use this property to check the time the key was generated. | | [subkey_username](#subkey_username-property) | Specifies the name of the user bound to this key. | | [subkey_valid_to](#subkey_valid_to-property) | Provide accurate expiration moment indication. | | [subkey_version](#subkey_version-property) | Indicates the key version. | | [user_count](#user_count-property) | The number of records in the User arrays. | | [user_handle](#user_handle-property) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [username](#username-property) | Specifies the user name of user. | ## Method List *The following is the full list of the methods of the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [change_passphrase](#change_passphrase-method) | Changes the password of the secret key. | | [change_protection](#change_protection-method) | Changes the protection level of the secret key. | | [check_passphrase](#check_passphrase-method) | Checks if the password matches the secret key. | | [config](#config-method) | Sets or retrieves a configuration setting. | | [create_key](#create_key-method) | Generates a new key. | | [create_subkey](#create_subkey-method) | Generates a new subkey. | | [create_user](#create_user-method) | Adds a user to an existing key. | | [do_action](#do_action-method) | Performs an additional action. | | [export_bytes](#export_bytes-method) | Serializes the key to a byte array. | | [export_to_file](#export_to_file-method) | Exports the key to a file. | | [generate_pair](#generate_pair-method) | Generates a new pair of PGP keys. | | [import_bytes](#import_bytes-method) | Loads a key from a byte array. | | [import_from_file](#import_from_file-method) | Loads a key from a file. | | [import_pinned](#import_pinned-method) | Loads a key from a pinned key object. | | [remove_signature](#remove_signature-method) | Unbinds the specified signature from the key, subkey or user. | | [remove_subkey](#remove_subkey-method) | Removes the specified subkey from the key. | | [remove_user](#remove_user-method) | Unbinds the specified user from the key. | | [reset](#reset-method) | Creates a new empty keyring. | | [revoke_key](#revoke_key-method) | Revokes the key. | | [revoke_subkey](#revoke_subkey-method) | Revokes the key's subkey. | | [revoke_user](#revoke_user-method) | Revokes a user certification. | | [sign_key](#sign_key-method) | Sign the key. | | [sign_subkey](#sign_subkey-method) | Sign the key's subkey. | | [sign_user](#sign_user-method) | Creates a user certification. | | [verify](#verify-method) | Verifies the integrity of a key signature. | ## 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](#on_error-event) | Information about errors during PGP key management. | | [on_key_passphrase_needed](#on_key_passphrase_needed-event) | Requests a key protection password from the application. | | [on_notification](#on_notification-event) | This event notifies the application about an underlying control flow event. | ## Config Settings *The following is a list of config settings for the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [Armor](#Armor) | Enables or disables ASCII armouring. | | [ArmorBoundary](#ArmorBoundary) | Specifies the armour boundary/title. | | [ArmorHeaders](#ArmorHeaders) | Specifies armour headers. | | [HashAlgorithm](#HashAlgorithm) | The hash algorithm to use with the operation, when not accepted via a parameter. | | [KeyFlags](#KeyFlags) | Specifies key flags for user certification signatures. | | [KeyHashAlgorithm](#KeyHashAlgorithm) | The hash algorithm associated with the key. | | [PreferredAlgs](#PreferredAlgs) | Specifies preferred algorithms for user certification signatures. | | [RawKeyFormat](#RawKeyFormat) | Specifies whether low-level key format should be used as input or output of an operation. | | [RespectKeyUsage](#RespectKeyUsage) | Enables policy-based key usage checks. | | [SaveKeyTrust](#SaveKeyTrust) | Tells the class to include the trust packets with the serialized keys. | | [SaveSecretKeySignatures](#SaveSecretKeySignatures) | Enforces saving of signature packets to the secret keyring file. | | [SignatureCreationTime](#SignatureCreationTime) | Indicates the signature creation time. | | [SignatureExpirationTime](#SignatureExpirationTime) | Returns or sets the signature expiration time. | | [SignatureHashAlgorithm](#SignatureHashAlgorithm) | The hash algorithm of the signature. | | [SubkeyIndex](#SubkeyIndex) | Allows to select a specific subkey for certain operations. | | [UseLongKeyIDs](#UseLongKeyIDs) | Use full-length KeyID format. | | [ASN1UseGlobalTagCache](#ASN1UseGlobalTagCache) | Controls whether ASN.1 module should use a global object cache. | | [AssignSystemSmartCardPins](#AssignSystemSmartCardPins) | Specifies whether CSP-level PINs should be assigned to CNG keys. | | [CheckKeyIntegrityBeforeUse](#CheckKeyIntegrityBeforeUse) | Enables or disable private key integrity check before use. | | [CookieCaching](#CookieCaching) | Specifies whether a cookie cache should be used for HTTP(S) transports. | | [Cookies](#Cookies) | Gets or sets local cookies for the class. | | [DefDeriveKeyIterations](#DefDeriveKeyIterations) | Specifies the default key derivation algorithm iteration count. | | [DNSLocalSuffix](#DNSLocalSuffix) | The suffix to assign for TLD names. | | [EnableClientSideSSLFFDHE](#EnableClientSideSSLFFDHE) | Enables or disables finite field DHE key exchange support in TLS clients. | | [EnableSSHMLKEM](#EnableSSHMLKEM) | Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server classes. | | [EnableTLSMLKEM](#EnableTLSMLKEM) | Enables support for ML-KEM and hybrid groups in TLS client and server classes. | | [GlobalCookies](#GlobalCookies) | Gets or sets global cookies for all the HTTP transports. | | [HardwareCryptoUsePolicy](#HardwareCryptoUsePolicy) | The hardware crypto usage policy. | | [HttpUserAgent](#HttpUserAgent) | Specifies the user agent name to be used by all HTTP clients. | | [HttpVersion](#HttpVersion) | The HTTP version to use in any inner HTTP client classes created. | | [IgnoreExpiredMSCTLSigningCert](#IgnoreExpiredMSCTLSigningCert) | Whether to tolerate the expired Windows Update signing certificate. | | [ListDelimiter](#ListDelimiter) | The delimiter character for multi-element lists. | | [LogDestination](#LogDestination) | Specifies the debug log destination. | | [LogDetails](#LogDetails) | Specifies the debug log details to dump. | | [LogFile](#LogFile) | Specifies the debug log filename. | | [LogFilters](#LogFilters) | Specifies the debug log filters. | | [LogFlushMode](#LogFlushMode) | Specifies the log flush mode. | | [LogLevel](#LogLevel) | Specifies the debug log level. | | [LogMaxEventCount](#LogMaxEventCount) | Specifies the maximum number of events to cache before further action is taken. | | [LogRotationMode](#LogRotationMode) | Specifies the log rotation mode. | | [MaxASN1BufferLength](#MaxASN1BufferLength) | Specifies the maximal allowed length for ASN.1 primitive tag data. | | [MaxASN1TreeDepth](#MaxASN1TreeDepth) | Specifies the maximal depth for processed ASN.1 trees. | | [OCSPHashAlgorithm](#OCSPHashAlgorithm) | Specifies the hash algorithm to be used to identify certificates in OCSP requests. | | [OldClientSideRSAFallback](#OldClientSideRSAFallback) | Specifies whether the SSH client should use a SHA1 fallback. | | [PKICache](#PKICache) | Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached. | | [PKICachePath](#PKICachePath) | Specifies the file system path where cached PKI data is stored. | | [ProductVersion](#ProductVersion) | Returns the version of the SecureBlackbox library. | | [ServerSSLDHKeyLength](#ServerSSLDHKeyLength) | Sets the size of the TLS DHE key exchange group. | | [StaticDNS](#StaticDNS) | Specifies whether static DNS rules should be used. | | [StaticIPAddress\[domain\]](#StaticIPAddress[domain]) | Gets or sets an IP address for the specified domain name. | | [StaticIPAddresses](#StaticIPAddresses) | Gets or sets all the static DNS rules. | | [Tag](#Tag) | Allows to store any custom data. | | [TLSSessionGroup](#TLSSessionGroup) | Specifies the group name of TLS sessions to be used for session resumption. | | [TLSSessionLifetime](#TLSSessionLifetime) | Specifies lifetime in seconds of the cached TLS session. | | [TLSSessionPurgeInterval](#TLSSessionPurgeInterval) | Specifies how often the session cache should remove the expired TLS sessions. | | [UseCRLObjectCaching](#UseCRLObjectCaching) | Specifies whether reuse of loaded CRL objects is enabled. | | [UseInternalRandom](#UseInternalRandom) | Switches between SecureBlackbox-own and platform PRNGs. | | [UseLegacyAdESValidation](#UseLegacyAdESValidation) | Enables legacy AdES validation mode. | | [UseOCSPResponseObjectCaching](#UseOCSPResponseObjectCaching) | Specifies whether reuse of loaded OCSP response objects is enabled. | | [UseOwnDNSResolver](#UseOwnDNSResolver) | Specifies whether the client classes should use own DNS resolver. | | [UseSharedSystemStorages](#UseSharedSystemStorages) | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. | | [UseSystemNativeSizeCalculation](#UseSystemNativeSizeCalculation) | An internal CryptoAPI access tweak. | | [UseSystemOAEPAndPSS](#UseSystemOAEPAndPSS) | Enforces or disables the use of system-driven RSA OAEP and PSS computations. | | [UseSystemRandom](#UseSystemRandom) | Enables or disables the use of the OS PRNG. | | [XMLRDNDescriptorName\[OID\]](#XMLRDNDescriptorName[OID]) | Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN. | | [XMLRDNDescriptorPriority\[OID\]](#XMLRDNDescriptorPriority[OID]) | Specifies the priority of descriptor names associated with a specific OID. | | [XMLRDNDescriptorReverseOrder](#XMLRDNDescriptorReverseOrder) | Specifies whether to reverse the order of descriptors in RDN. | | [XMLRDNDescriptorSeparator](#XMLRDNDescriptorSeparator) | Specifies the separator used between descriptors in RDN. | # key_bits_in_key property Indicates the key length in bits. ## Syntax ```text def get_key_bits_in_key() -> int: ... key_bits_in_key = property(get_key_bits_in_key, None) ``` ## Default Value 2048 ## Remarks Indicates the key length in bits. This property is read-only. # key_can_encrypt property Returns True if this key can be used for encryption. ## Syntax ```text def get_key_can_encrypt() -> bool: ... key_can_encrypt = property(get_key_can_encrypt, None) ``` ## Default Value FALSE ## Remarks Returns True if this key can be used for encryption. This property is read-only. # key_can_sign property Returns True if this key can be used for signing. ## Syntax ```text def get_key_can_sign() -> bool: ... key_can_sign = property(get_key_can_sign, None) ``` ## Default Value FALSE ## Remarks Returns True if this key can be used for signing. This property is read-only. # key_curve property Indicates the elliptic curve associated with a EC key. ## Syntax ```text def get_key_curve() -> str: ... key_curve = property(get_key_curve, None) ``` ## Default Value "" ## Remarks Indicates the elliptic curve associated with a EC key. Supported values: | | | | | --- | --- | --- | | SB_PGP_CURVE_P256 | P256 | | | SB_PGP_CURVE_P384 | P384 | | | SB_PGP_CURVE_P521 | P521 | | | SB_PGP_CURVE_ED25519 | ED25519 | | | SB_PGP_CURVE_CURVE25519 | CURVE25519 | | | SB_PGP_CURVE_BRAINPOOLP256R1 | BRAINPOOLP256 | | | SB_PGP_CURVE_BRAINPOOLP512R1 | BRAINPOOLP512 | | This property is read-only. # key_enabled property Enables or disables this key for use in encryption or signing operation. ## Syntax ```text def get_key_enabled() -> bool: ... def set_key_enabled(value: bool) -> None: ... key_enabled = property(get_key_enabled, set_key_enabled) ``` ## Default Value FALSE ## Remarks Enables or disables this key for use in encryption or signing operation. # key_encryption_algorithm property Indicates the symmetric algorithm used to encrypt the secret key. ## Syntax ```text def get_key_encryption_algorithm() -> str: ... key_encryption_algorithm = property(get_key_encryption_algorithm, None) ``` ## Default Value "AES128" ## Remarks Indicates the symmetric algorithm used to encrypt the secret key. This property is read-only. # key_is_public property Returns True if this key is a public key, and False otherwise. ## Syntax ```text def get_key_is_public() -> bool: ... key_is_public = property(get_key_is_public, None) ``` ## Default Value FALSE ## Remarks Returns True if this key is a public key, and False otherwise. This property is read-only. # key_is_secret property Returns True if this key is a secret key, and False otherwise. ## Syntax ```text def get_key_is_secret() -> bool: ... key_is_secret = property(get_key_is_secret, None) ``` ## Default Value FALSE ## Remarks Returns True if this key is a secret key, and False otherwise. This property is read-only. # key_is_subkey property Returns True if this key is a subkey of another key, and False otherwise. ## Syntax ```text def get_key_is_subkey() -> bool: ... key_is_subkey = property(get_key_is_subkey, None) ``` ## Default Value FALSE ## Remarks Returns True if this key is a subkey of another key, and False otherwise. This property is read-only. # key_fp property The 20-byte fingerprint (hash value) of this key. ## Syntax ```text def get_key_fp() -> str: ... key_fp = property(get_key_fp, None) ``` ## Default Value "" ## Remarks The 20-byte fingerprint (hash value) of this key. KeyFP could be used to distinguish two keys with the same KeyID. This property is read-only. # key_id property Contains a 8-byte key identifier. ## Syntax ```text def get_key_id() -> str: ... key_id = property(get_key_id, None) ``` ## Default Value "" ## Remarks Contains a 8-byte key identifier. It is quite rare that IDs of two keys collide. If that happens, their fingerprints (KeyFP) can be used for distinguish between the keys. Please note that many PGP implementations show only 4 lowest bytes of the KeyID to the user. This property is read-only. # key_passphrase property The key protection password. ## Syntax ```text def get_key_passphrase() -> str: ... def set_key_passphrase(value: str) -> None: ... key_passphrase = property(get_key_passphrase, set_key_passphrase) ``` ## Default Value "" ## Remarks The key protection password. # key_passphrase_valid property Use this property to check whether the specified Passphrase is valid and can be used to unlock the secret key. ## Syntax ```text def get_key_passphrase_valid() -> bool: ... key_passphrase_valid = property(get_key_passphrase_valid, None) ``` ## Default Value FALSE ## Remarks Use this property to check whether the specified [key_passphrase](#key_passphrase-property) is valid and can be used to unlock the secret key. This property is read-only. # key_primary_key_id property If this key is a subkey ( IsSubkey returns True), this property contains the identifier of the subkey's primary key. ## Syntax ```text def get_key_primary_key_id() -> str: ... key_primary_key_id = property(get_key_primary_key_id, None) ``` ## Default Value "" ## Remarks If this key is a subkey ([key_is_subkey](#key_is_subkey-property) returns True), this property contains the identifier of the subkey's primary key. This property is read-only. # key_protection property Specifies the level of protection applied to the secret key. ## Syntax ```text def get_key_protection() -> int: ... key_protection = property(get_key_protection, None) ``` ## Possible Values ```text 0 # None1 # Low2 # Normal3 # High ``` ## Default Value 0 ## Remarks Specifies the level of protection applied to the secret key. Allowed values: | | | | | --- | --- | --- | | pptNone | 0 | Key is not encrypted | | pptLow | 1 | Only the password hash is used to derive the secret key | | pptNormal | 2 | Password hash with salt is used to derive the secret key | | pptHigh | 3 | Hash from multiple passwords and salt are used for key derivation | This property is read-only. # key_public_key_algorithm property Specifies the asymmetric algorithm of the key. ## Syntax ```text def get_key_public_key_algorithm() -> str: ... key_public_key_algorithm = property(get_key_public_key_algorithm, None) ``` ## Default Value "" ## Remarks Specifies the asymmetric algorithm of the key. This property is read-only. # key_q_bits property The length of the DSA Q (legitimate range: 160-512). ## Syntax ```text def get_key_q_bits() -> int: ... key_q_bits = property(get_key_q_bits, None) ``` ## Default Value 0 ## Remarks The length of the DSA Q (legitimate range: 160-512). This parameter corresponds to the hash algorithm used with the key. For example, if the value of Q is 256, SHA-256 will be used. This property is read-only. # key_timestamp property Use this property to check the time the key was generated. ## Syntax ```text def get_key_timestamp() -> str: ... key_timestamp = property(get_key_timestamp, None) ``` ## Default Value "" ## Remarks Use this property to check the time the key was generated. The date and time are stored and retrieved in Universal Coordinate Time (UTC). This property is read-only. # key_username property Specifies the name of the user bound to this key. ## Syntax ```text def get_key_username() -> str: ... key_username = property(get_key_username, None) ``` ## Default Value "" ## Remarks Specifies the name of the user bound to this key. The PGP username is typically represented with a full name and an email address, but generally can be any non-empty string. This property is read-only. # key_valid_to property Provide accurate expiration moment indication. ## Syntax ```text def get_key_valid_to() -> str: ... key_valid_to = property(get_key_valid_to, None) ``` ## Default Value "0" ## Remarks Provide accurate expiration moment indication. This is different to expires property which only contains expiration time in days in old keys. This property is read-only. # key_version property Indicates the key version. ## Syntax ```text def get_key_version() -> int: ... key_version = property(get_key_version, None) ``` ## Default Value 0 ## Remarks Indicates the key version. The key version refers to the version of the public-key packet format as defined in RFC 4880. Only four versions are currently allowed here: 3, 4, 5 and 6. It is recommended that all new keys are created with version of 6. This property is read-only. # pinned_key_handle property Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax ```text def get_pinned_key_handle() -> int: ... def set_pinned_key_handle(value: int) -> None: ... pinned_key_handle = property(get_pinned_key_handle, set_pinned_key_handle) ``` ## Default Value 0 ## Remarks Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` # signature_count property The number of records in the Signature arrays. ## Syntax ```text def get_signature_count() -> int: ... signature_count = property(get_signature_count, None) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [signature_certification_type](#signature_certification_type-property) - [signature_class](#signature_class-property) - [signature_creation_time](#signature_creation_time-property) - [signature_expiration_time](#signature_expiration_time-property) - [signature_exportable](#signature_exportable-property) - [signature_handle](#signature_handle-property) - [signature_hash_algorithm](#signature_hash_algorithm-property) - [signature_hash_mark](#signature_hash_mark-property) - [signature_key_expiration_time](#signature_key_expiration_time-property) - [signature_key_flags](#signature_key_flags-property) - [signature_legacy_format](#signature_legacy_format-property) - [signature_policy_url](#signature_policy_url-property) - [signature_preferred_algorithms](#signature_preferred_algorithms-property) - [signature_primary_user_id](#signature_primary_user_id-property) - [signature_reason_for_revocation](#signature_reason_for_revocation-property) - [signature_revocable](#signature_revocable-property) - [signature_revocation](#signature_revocation-property) - [signature_signer_key_id](#signature_signer_key_id-property) - [signature_signer_user_id](#signature_signer_user_id-property) - [signature_strictly_valid](#signature_strictly_valid-property) - [signature_target](#signature_target-property) - [signature_text_signature](#signature_text_signature-property) - [signature_trust_amount](#signature_trust_amount-property) - [signature_trust_level](#signature_trust_level-property) - [signature_validated](#signature_validated-property) - [signature_validity](#signature_validity-property) - [signature_version](#signature_version-property) The array indices start at *0* and end at *signature_count - 1*. This property is read-only. # signature_certification_type property Specifies the type of a UserID signature. ## Syntax ```text def get_signature_certification_type(signature_index: int) -> int: ... ``` ## Possible Values ```text 0 # Generic1 # Persona2 # Casual3 # Positive ``` ## Default Value 0 ## Remarks Specifies the type of a UserID signature. | | | | | --- | --- | --- | | pctGeneric | 0 | Generic certification of a User ID and Public Key packet. The issuer of this certification does not make any particular assertion as to how well the certifier has checked that the owner of the key is in fact the person described by the User ID. By default user certifications use Generic type. | | pctPersona | 1 | Persona certification of a User ID and Public Key packet. The issuer of this certification has not done any verification of the claim that the owner of this key corresponds to the specified User ID. | | pctCasual | 2 | Casual certification of a User ID and a Public Key packet. The issuer of this certification has done some casual verification of the claim of identity. | | pctPositive | 3 | Positive certification of a User ID and a Public Key packet. The issuer of this certification has done substantial verification of the claim of identity. | The *signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signature_count](#signature_count-property) property. This property is read-only. # signature_creation_time property The time when the signature was created, in Universal Coordinated Time (UTC). ## Syntax ```text def get_signature_creation_time(signature_index: int) -> str: ... ``` ## Default Value "" ## Remarks The time when the signature was created, in Universal Coordinated Time (UTC). The *signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signature_count](#signature_count-property) property. This property is read-only. # signature_expiration_time property Specifies signature expiration time, in seconds since its creation time (CreationTime). ## Syntax ```text def get_signature_expiration_time(signature_index: int) -> int: ... ``` ## Default Value 0 ## Remarks Specifies signature expiration time, in seconds since its creation time (CreationTime). This property set to 0 indicates that the signature never expires. The *signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signature_count](#signature_count-property) property. This property is read-only. # signature_exportable property Specifies whether a certification signature is "exportable", meaning it can be used by entities other than the signature's issuer. ## Syntax ```text def get_signature_exportable(signature_index: int) -> bool: ... ``` ## Default Value FALSE ## Remarks Specifies whether a certification signature is "exportable", meaning it can be used by entities other than the signature's issuer. The *signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signature_count](#signature_count-property) property. This property is read-only. # signature_handle property Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax ```text def get_signature_handle(signature_index: int) -> int: ... ``` ## Default Value 0 ## Remarks Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` The *signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signature_count](#signature_count-property) property. This property is read-only. # signature_hash_algorithm property Specifies the hash algorithm used in the signature. ## Syntax ```text def get_signature_hash_algorithm(signature_index: int) -> str: ... ``` ## Default Value "" ## Remarks Specifies the hash algorithm used in the signature. The *signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signature_count](#signature_count-property) property. This property is read-only. # signature_hash_mark property Returns the hash mark attribute of a signature. ## Syntax ```text def get_signature_hash_mark(signature_index: int) -> int: ... ``` ## Default Value 0 ## Remarks Returns the hash mark attribute of a signature. Check this property to get a hash mark of a signature. The *signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signature_count](#signature_count-property) property. This property is read-only. # signature_key_expiration_time property The number of seconds after which the signed key will expire. ## Syntax ```text def get_signature_key_expiration_time(signature_index: int) -> int: ... ``` ## Default Value 0 ## Remarks The number of seconds after which the signed key will expire. The *signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signature_count](#signature_count-property) property. This property is read-only. # signature_key_flags property Returns the key flags included in the signature. ## Syntax ```text def get_signature_key_flags(signature_index: int) -> int: ... ``` ## Default Value 0 ## Remarks Returns the key flags included in the signature. Use this property to retrieve the key flags stored in the key signature. The *signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signature_count](#signature_count-property) property. This property is read-only. # signature_legacy_format property Indicates whether signature uses PGP 2. ## Syntax ```text def get_signature_legacy_format(signature_index: int) -> bool: ... ``` ## Default Value FALSE ## Remarks Indicates whether signature uses PGP 2.6.x-compatible packet format. The signature is fully compatible with the 'old' format only if it has version 3, uses MD5 hash algorithm, RSA public key algorithm, and its key length is not greater than 1024 bits. The *signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signature_count](#signature_count-property) property. This property is read-only. # signature_policy_url property Contains the URL of the signature policy. ## Syntax ```text def get_signature_policy_url(signature_index: int) -> str: ... ``` ## Default Value "" ## Remarks Contains the URL of the signature policy. The *signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signature_count](#signature_count-property) property. This property is read-only. # signature_preferred_algorithms property Contains a list of algorithms preferred by the signed key holder. ## Syntax ```text def get_signature_preferred_algorithms(signature_index: int) -> str: ... ``` ## Default Value "" ## Remarks Contains a list of algorithms preferred by the signed key holder. The *signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signature_count](#signature_count-property) property. This property is read-only. # signature_primary_user_id property Indicates whether the UserID covered by the signature is the main user id for this key. ## Syntax ```text def get_signature_primary_user_id(signature_index: int) -> bool: ... ``` ## Default Value FALSE ## Remarks Indicates whether the UserID covered by the signature is the main user id for this key. The *signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signature_count](#signature_count-property) property. This property is read-only. # signature_reason_for_revocation property Describes the reason why the key or the certificate was revoked. ## Syntax ```text def get_signature_reason_for_revocation(signature_index: int) -> str: ... ``` ## Default Value "" ## Remarks Describes the reason why the key or the certificate was revoked. The *signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signature_count](#signature_count-property) property. This property is read-only. # signature_revocable property Specifies whether the signature can be revoked. ## Syntax ```text def get_signature_revocable(signature_index: int) -> bool: ... ``` ## Default Value FALSE ## Remarks Specifies whether the signature can be revoked. The *signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signature_count](#signature_count-property) property. This property is read-only. # signature_revocation property Indicates whether or not the signature is a revocation signature. ## Syntax ```text def get_signature_revocation(signature_index: int) -> bool: ... ``` ## Default Value FALSE ## Remarks Indicates whether or not the signature is a revocation signature. The *signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signature_count](#signature_count-property) property. This property is read-only. # signature_class property Indicates the signature class. ## Syntax ```text def get_signature_class(signature_index: int) -> int: ... ``` ## Possible Values ```text 0 # Document1 # TextDocument2 # Standalone3 # UIDGeneric4 # UIDPersona5 # UIDCasual6 # UIDPositive7 # SubkeyBinding8 # PrimaryKeyBinding9 # DirectKey10 # KeyRevocation11 # SubkeyRevocation12 # CertRevocation13 # Timestamp14 # ThirdParty15 # NotSpecified ``` ## Default Value 0 ## Remarks Indicates the signature class. | | | | | --- | --- | --- | | pscDocument | 0 | Signature over binary file | | pscTextDocument | 1 | Signature over text | | pscStandalone | 2 | A standalone signature | | pscUIDGeneric | 3 | User certification signature | | pscUIDPersona | 4 | User certification signature (persona) | | pscUIDCasual | 5 | User certification signature (casual) | | pscUIDPositive | 6 | User certification signature (positive) | | pscSubkeyBinding | 7 | Subkey binding signature | | pscPrimaryKeyBinding | 8 | Primary key binding signature | | pscDirectKey | 9 | Direct signature over a public key | | pscKeyRevocation | 10 | Key revocation | | pscSubkeyRevocation | 11 | Subkey revocation | | pscCertRevocation | 12 | User revocation | | pscTimestamp | 13 | Timestamp signature | | pscThirdParty | 14 | Third-party signature | | pscNotSpecified | 15 | Signature type not provided | The *signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signature_count](#signature_count-property) property. This property is read-only. # signature_signer_key_id property Indicates the KeyID of the signing key. ## Syntax ```text def get_signature_signer_key_id(signature_index: int) -> str: ... ``` ## Default Value "" ## Remarks Indicates the KeyID of the signing key. The *signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signature_count](#signature_count-property) property. This property is read-only. # signature_signer_user_id property Indicates the UserID associated with the signing key. ## Syntax ```text def get_signature_signer_user_id(signature_index: int) -> str: ... ``` ## Default Value "" ## Remarks Indicates the UserID associated with the signing key. The *signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signature_count](#signature_count-property) property. This property is read-only. # signature_strictly_valid property Returns True if this signature is valid in a strict way (no compatibility relaxations). ## Syntax ```text def get_signature_strictly_valid(signature_index: int) -> bool: ... ``` ## Default Value FALSE ## Remarks Returns True if this signature is valid in a strict way (no compatibility relaxations). The *signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signature_count](#signature_count-property) property. This property is read-only. # signature_target property Indicates the KeyID or Username of the target key or user. ## Syntax ```text def get_signature_target(signature_index: int) -> str: ... ``` ## Default Value "" ## Remarks Indicates the KeyID or Username of the target key or user. The *signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signature_count](#signature_count-property) property. This property is read-only. # signature_text_signature property Indicates whether or not the signature is made over a text document. ## Syntax ```text def get_signature_text_signature(signature_index: int) -> bool: ... ``` ## Default Value FALSE ## Remarks Indicates whether or not the signature is made over a text document. The *signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signature_count](#signature_count-property) property. This property is read-only. # signature_trust_amount property Specifies the amount of trust assigned by this signature. ## Syntax ```text def get_signature_trust_amount(signature_index: int) -> int: ... ``` ## Default Value 0 ## Remarks Specifies the amount of trust assigned by this signature. Specifies the amount of trust, in range 0-255, interpreted such that values less than 120 indicate partial trust and values of 120 or greater indicate complete trust. The *signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signature_count](#signature_count-property) property. This property is read-only. # signature_trust_level property The trust level assigned by this signature. ## Syntax ```text def get_signature_trust_level(signature_index: int) -> int: ... ``` ## Default Value 0 ## Remarks The trust level assigned by this signature. Level 1 means that the signed key is asserted to be a valid trusted introducer, with the 2nd octet of the body specifying the degree of trust. Level n means that the signed key is asserted to be trusted to issue level (n-1)-trust signatures. The *signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signature_count](#signature_count-property) property. This property is read-only. # signature_validated property Whether the signature has been validated. ## Syntax ```text def get_signature_validated(signature_index: int) -> bool: ... ``` ## Default Value FALSE ## Remarks Whether the signature has been validated. The *signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signature_count](#signature_count-property) property. This property is read-only. # signature_validity property Provides the validity status of the signature if the signature has been validated. ## Syntax ```text def get_signature_validity(signature_index: int) -> int: ... ``` ## Possible Values ```text 0 # Valid1 # Unknown2 # Corrupted3 # SignerNotFound4 # Failure5 # ReferenceCorrupted ``` ## Default Value 0 ## Remarks Provides the validity status of the signature if the signature has been validated. | | | | | --- | --- | --- | | svtValid | 0 | The signature is valid | | svtUnknown | 1 | Signature validity is unknown | | svtCorrupted | 2 | The signature is corrupted | | svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. | | svtFailure | 4 | General failure | | svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) | The *signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signature_count](#signature_count-property) property. This property is read-only. # signature_version property Indicates the signature version. ## Syntax ```text def get_signature_version(signature_index: int) -> int: ... ``` ## Default Value 0 ## Remarks Indicates the signature version. RFC 4880 defines two versions for PGP signatures: 3 and 4. The *signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signature_count](#signature_count-property) property. This property is read-only. # signing_key_handle property Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax ```text def get_signing_key_handle() -> int: ... def set_signing_key_handle(value: int) -> None: ... signing_key_handle = property(get_signing_key_handle, set_signing_key_handle) ``` ## Default Value 0 ## Remarks Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` # subkey_count property The number of records in the Subkey arrays. ## Syntax ```text def get_subkey_count() -> int: ... subkey_count = property(get_subkey_count, None) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [subkey_bits_in_key](#subkey_bits_in_key-property) - [subkey_can_encrypt](#subkey_can_encrypt-property) - [subkey_can_sign](#subkey_can_sign-property) - [subkey_curve](#subkey_curve-property) - [subkey_enabled](#subkey_enabled-property) - [subkey_encryption_algorithm](#subkey_encryption_algorithm-property) - [subkey_handle](#subkey_handle-property) - [subkey_is_public](#subkey_is_public-property) - [subkey_is_secret](#subkey_is_secret-property) - [subkey_is_subkey](#subkey_is_subkey-property) - [subkey_key_fp](#subkey_key_fp-property) - [subkey_key_id](#subkey_key_id-property) - [subkey_passphrase](#subkey_passphrase-property) - [subkey_passphrase_valid](#subkey_passphrase_valid-property) - [subkey_primary_key_id](#subkey_primary_key_id-property) - [subkey_protection](#subkey_protection-property) - [subkey_public_key_algorithm](#subkey_public_key_algorithm-property) - [subkey_q_bits](#subkey_q_bits-property) - [subkey_timestamp](#subkey_timestamp-property) - [subkey_username](#subkey_username-property) - [subkey_valid_to](#subkey_valid_to-property) - [subkey_version](#subkey_version-property) The array indices start at *0* and end at *subkey_count - 1*. This property is read-only. # subkey_bits_in_key property Indicates the key length in bits. ## Syntax ```text def get_subkey_bits_in_key(subkey_index: int) -> int: ... ``` ## Default Value 2048 ## Remarks Indicates the key length in bits. The *subkey_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [subkey_count](#subkey_count-property) property. This property is read-only. # subkey_can_encrypt property Returns True if this key can be used for encryption. ## Syntax ```text def get_subkey_can_encrypt(subkey_index: int) -> bool: ... ``` ## Default Value FALSE ## Remarks Returns True if this key can be used for encryption. The *subkey_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [subkey_count](#subkey_count-property) property. This property is read-only. # subkey_can_sign property Returns True if this key can be used for signing. ## Syntax ```text def get_subkey_can_sign(subkey_index: int) -> bool: ... ``` ## Default Value FALSE ## Remarks Returns True if this key can be used for signing. The *subkey_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [subkey_count](#subkey_count-property) property. This property is read-only. # subkey_curve property Indicates the elliptic curve associated with a EC key. ## Syntax ```text def get_subkey_curve(subkey_index: int) -> str: ... ``` ## Default Value "" ## Remarks Indicates the elliptic curve associated with a EC key. Supported values: | | | | | --- | --- | --- | | SB_PGP_CURVE_P256 | P256 | | | SB_PGP_CURVE_P384 | P384 | | | SB_PGP_CURVE_P521 | P521 | | | SB_PGP_CURVE_ED25519 | ED25519 | | | SB_PGP_CURVE_CURVE25519 | CURVE25519 | | | SB_PGP_CURVE_BRAINPOOLP256R1 | BRAINPOOLP256 | | | SB_PGP_CURVE_BRAINPOOLP512R1 | BRAINPOOLP512 | | The *subkey_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [subkey_count](#subkey_count-property) property. This property is read-only. # subkey_enabled property Enables or disables this key for use in encryption or signing operation. ## Syntax ```text def get_subkey_enabled(subkey_index: int) -> bool: ... ``` ## Default Value FALSE ## Remarks Enables or disables this key for use in encryption or signing operation. The *subkey_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [subkey_count](#subkey_count-property) property. This property is read-only. # subkey_encryption_algorithm property Indicates the symmetric algorithm used to encrypt the secret key. ## Syntax ```text def get_subkey_encryption_algorithm(subkey_index: int) -> str: ... ``` ## Default Value "AES128" ## Remarks Indicates the symmetric algorithm used to encrypt the secret key. The *subkey_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [subkey_count](#subkey_count-property) property. This property is read-only. # subkey_handle property Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax ```text def get_subkey_handle(subkey_index: int) -> int: ... ``` ## Default Value 0 ## Remarks Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` The *subkey_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [subkey_count](#subkey_count-property) property. This property is read-only. # subkey_is_public property Returns True if this key is a public key, and False otherwise. ## Syntax ```text def get_subkey_is_public(subkey_index: int) -> bool: ... ``` ## Default Value FALSE ## Remarks Returns True if this key is a public key, and False otherwise. The *subkey_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [subkey_count](#subkey_count-property) property. This property is read-only. # subkey_is_secret property Returns True if this key is a secret key, and False otherwise. ## Syntax ```text def get_subkey_is_secret(subkey_index: int) -> bool: ... ``` ## Default Value FALSE ## Remarks Returns True if this key is a secret key, and False otherwise. The *subkey_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [subkey_count](#subkey_count-property) property. This property is read-only. # subkey_is_subkey property Returns True if this key is a subkey of another key, and False otherwise. ## Syntax ```text def get_subkey_is_subkey(subkey_index: int) -> bool: ... ``` ## Default Value FALSE ## Remarks Returns True if this key is a subkey of another key, and False otherwise. The *subkey_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [subkey_count](#subkey_count-property) property. This property is read-only. # subkey_key_fp property The 20-byte fingerprint (hash value) of this key. ## Syntax ```text def get_subkey_key_fp(subkey_index: int) -> str: ... ``` ## Default Value "" ## Remarks The 20-byte fingerprint (hash value) of this key. KeyFP could be used to distinguish two keys with the same KeyID. The *subkey_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [subkey_count](#subkey_count-property) property. This property is read-only. # subkey_key_id property Contains a 8-byte key identifier. ## Syntax ```text def get_subkey_key_id(subkey_index: int) -> str: ... ``` ## Default Value "" ## Remarks Contains a 8-byte key identifier. It is quite rare that IDs of two keys collide. If that happens, their fingerprints (KeyFP) can be used for distinguish between the keys. Please note that many PGP implementations show only 4 lowest bytes of the KeyID to the user. The *subkey_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [subkey_count](#subkey_count-property) property. This property is read-only. # subkey_passphrase property The key protection password. ## Syntax ```text def get_subkey_passphrase(subkey_index: int) -> str: ... ``` ## Default Value "" ## Remarks The key protection password. The *subkey_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [subkey_count](#subkey_count-property) property. This property is read-only. # subkey_passphrase_valid property Use this property to check whether the specified Passphrase is valid and can be used to unlock the secret key. ## Syntax ```text def get_subkey_passphrase_valid(subkey_index: int) -> bool: ... ``` ## Default Value FALSE ## Remarks Use this property to check whether the specified [subkey_passphrase](#subkey_passphrase-property) is valid and can be used to unlock the secret key. The *subkey_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [subkey_count](#subkey_count-property) property. This property is read-only. # subkey_primary_key_id property If this key is a subkey ( IsSubkey returns True), this property contains the identifier of the subkey's primary key. ## Syntax ```text def get_subkey_primary_key_id(subkey_index: int) -> str: ... ``` ## Default Value "" ## Remarks If this key is a subkey ([subkey_is_subkey](#subkey_is_subkey-property) returns True), this property contains the identifier of the subkey's primary key. The *subkey_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [subkey_count](#subkey_count-property) property. This property is read-only. # subkey_protection property Specifies the level of protection applied to the secret key. ## Syntax ```text def get_subkey_protection(subkey_index: int) -> int: ... ``` ## Possible Values ```text 0 # None1 # Low2 # Normal3 # High ``` ## Default Value 0 ## Remarks Specifies the level of protection applied to the secret key. Allowed values: | | | | | --- | --- | --- | | pptNone | 0 | Key is not encrypted | | pptLow | 1 | Only the password hash is used to derive the secret key | | pptNormal | 2 | Password hash with salt is used to derive the secret key | | pptHigh | 3 | Hash from multiple passwords and salt are used for key derivation | The *subkey_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [subkey_count](#subkey_count-property) property. This property is read-only. # subkey_public_key_algorithm property Specifies the asymmetric algorithm of the key. ## Syntax ```text def get_subkey_public_key_algorithm(subkey_index: int) -> str: ... ``` ## Default Value "" ## Remarks Specifies the asymmetric algorithm of the key. The *subkey_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [subkey_count](#subkey_count-property) property. This property is read-only. # subkey_q_bits property The length of the DSA Q (legitimate range: 160-512). ## Syntax ```text def get_subkey_q_bits(subkey_index: int) -> int: ... ``` ## Default Value 0 ## Remarks The length of the DSA Q (legitimate range: 160-512). This parameter corresponds to the hash algorithm used with the key. For example, if the value of Q is 256, SHA-256 will be used. The *subkey_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [subkey_count](#subkey_count-property) property. This property is read-only. # subkey_timestamp property Use this property to check the time the key was generated. ## Syntax ```text def get_subkey_timestamp(subkey_index: int) -> str: ... ``` ## Default Value "" ## Remarks Use this property to check the time the key was generated. The date and time are stored and retrieved in Universal Coordinate Time (UTC). The *subkey_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [subkey_count](#subkey_count-property) property. This property is read-only. # subkey_username property Specifies the name of the user bound to this key. ## Syntax ```text def get_subkey_username(subkey_index: int) -> str: ... ``` ## Default Value "" ## Remarks Specifies the name of the user bound to this key. The PGP username is typically represented with a full name and an email address, but generally can be any non-empty string. The *subkey_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [subkey_count](#subkey_count-property) property. This property is read-only. # subkey_valid_to property Provide accurate expiration moment indication. ## Syntax ```text def get_subkey_valid_to(subkey_index: int) -> str: ... ``` ## Default Value "0" ## Remarks Provide accurate expiration moment indication. This is different to expires property which only contains expiration time in days in old keys. The *subkey_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [subkey_count](#subkey_count-property) property. This property is read-only. # subkey_version property Indicates the key version. ## Syntax ```text def get_subkey_version(subkey_index: int) -> int: ... ``` ## Default Value 0 ## Remarks Indicates the key version. The key version refers to the version of the public-key packet format as defined in RFC 4880. Only four versions are currently allowed here: 3, 4, 5 and 6. It is recommended that all new keys are created with version of 6. The *subkey_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [subkey_count](#subkey_count-property) property. This property is read-only. # user_count property The number of records in the User arrays. ## Syntax ```text def get_user_count() -> int: ... user_count = property(get_user_count, None) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [user_handle](#user_handle-property) - [username](#username-property) The array indices start at *0* and end at *user_count - 1*. This property is read-only. # user_handle property Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax ```text def get_user_handle(user_index: int) -> int: ... ``` ## Default Value 0 ## Remarks Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` The *user_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [user_count](#user_count-property) property. This property is read-only. # username property Specifies the user name of user. ## Syntax ```text def get_username(user_index: int) -> str: ... ``` ## Default Value "" ## Remarks Specifies the user name of user. The *user_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [user_count](#user_count-property) property. This property is read-only. # change_passphrase method Changes the password of the secret key. ## Syntax ```text def change_passphrase(old_passphrase: str, new_passphrase: str) -> None: ... ``` ## Remarks Call this method to change the password that protects the secret key and all its subkeys. Note: use *SubkeyIndex* configuration setting to change the passphrase on a specific key or subkey only (without touching other subkeys). # change_protection method Changes the protection level of the secret key. ## Syntax ```text def change_protection(old_passphrase: str, new_passphrase: str, prot_type: int, enc_algorithm: str, hash_algorithm: str) -> None: ... ``` ## Remarks Use this method to change the protection level of the key. *OldPassphrase* specifies the current password to decrypt the key, *NewPassphrase* is the new password for the key, *ProtType* is the new protection type (see for more details), *EncAlgorithm* is the key encryption algorithm, and | | | | | --- | --- | --- | | SB_PGP_SYMMETRIC_ALGORITHM_PLAINTEXT | Plaintext | | | SB_PGP_SYMMETRIC_ALGORITHM_IDEA | Idea | | | SB_PGP_SYMMETRIC_ALGORITHM_3DES | 3DES | | | SB_PGP_SYMMETRIC_ALGORITHM_CAST5 | CAST5 | | | SB_PGP_SYMMETRIC_ALGORITHM_BLOWFISH | Blowfish | | | SB_PGP_SYMMETRIC_ALGORITHM_AES128 | AES128 | | | SB_PGP_SYMMETRIC_ALGORITHM_AES192 | AES192 | | | SB_PGP_SYMMETRIC_ALGORITHM_AES256 | AES256 | | | SB_PGP_SYMMETRIC_ALGORITHM_TWOFISH256 | Twofish256 | | and *HashAlgorithm* specify the algorithms to be used for key derivation. | | | | | --- | --- | --- | | SB_HASH_ALGORITHM_MD5 | MD5 | | | SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | | | SB_HASH_ALGORITHM_SHA1 | SHA1 | | | SB_HASH_ALGORITHM_SHA224 | SHA224 | | | SB_HASH_ALGORITHM_SHA256 | SHA256 | | | SB_HASH_ALGORITHM_SHA384 | SHA384 | | | SB_HASH_ALGORITHM_SHA512 | SHA512 | | | SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | | | SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | | | SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | | Note: use *SubkeyIndex* configuration setting to change the passphrase on a specific key or subkey only (without touching other subkeys). # check_passphrase method Checks if the password matches the secret key. ## Syntax ```text def check_passphrase(passphrase: str) -> bool: ... ``` ## Remarks Use this method to check if a password can decrypt the key. # config method Sets or retrieves a configuration setting. ## Syntax ```text def config(configuration_string: str) -> str: ... ``` ## Remarks config is a generic method available in every class. It is used to set and retrieve [configuration settings](#pgpkeymanager-config-settings) for the class. These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these *internal properties* is provided through the config method. To set a configuration setting named *PROPERTY*, you must call *Config("PROPERTY=VALUE")*, where *VALUE* is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter). To read (query) the value of a [configuration setting](#pgpkeymanager-config-settings), you must call *Config("PROPERTY")*. The value will be returned as a string. # create_key method Generates a new key. ## Syntax ```text def create_key(version: int, algorithm: str, bits: int, valid_to: str, password: str) -> None: ... ``` ## Remarks Use this method to generate a new key with the provided parameters. # create_subkey method Generates a new subkey. ## Syntax ```text def create_subkey(algorithm: str, bits: int, valid_to: str, password: str) -> None: ... ``` ## Remarks Use this method to generate a new subkey with the provided parameters. # create_user method Adds a user to an existing key. ## Syntax ```text def create_user(username: str) -> None: ... ``` ## Remarks Use this method to add a user to an existing key. A typical format for a PGP key usage is "Name ", for example "John Johnson ". # do_action method Performs an additional action. ## Syntax ```text def do_action(action_id: str, action_params: str) -> str: ... ``` ## Remarks do_action is a generic method available in every class. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time. The unique identifier (case insensitive) of the action is provided in the *ActionID* parameter. *ActionParams* contains the value of a single parameter, or a list of multiple parameters for the action in the form of *PARAM1=VALUE1;PARAM2=VALUE2;...*. Common ActionIDs: | | | | | | --- | --- | --- | --- | | Action | Parameters | Returned value | Description | | ResetTrustedListCache | none | none | Clears the cached list of trusted lists. | | ResetCertificateCache | none | none | Clears the cached certificates. | | ResetCRLCache | none | none | Clears the cached CRLs. | | ResetOCSPResponseCache | none | none | Clears the cached OCSP responses. | # export_bytes method Serializes the key to a byte array. ## Syntax ```text def export_bytes(secret: bool) -> bytes: ... ``` ## Remarks Use this method to save the key (both the public and secret parts) to a byte array. # export_to_file method Exports the key to a file. ## Syntax ```text def export_to_file(file_name: str, secret: bool) -> None: ... ``` ## Remarks Use this method to save the key (both the public and secret parts) to the file specified in *Filename*. # generate_pair method Generates a new pair of PGP keys. ## Syntax ```text def generate_pair(version: int, username: str, strength: int, valid_to: str, password: str) -> None: ... ``` ## Remarks Use this method to create a standard key-subkey pair. This is the primary method for generating conformant PGP keys. Pass the user ID of the new key via the *Username* property. This typically should be in the format of *User Name *, for example *Robert Frost *, but generally can be an arbitrary text string. This method generates a 'standard' keypair based on the *Version* and *Strength* parameters. This can range from RSA keys for version 3 to strong Ed25519 keys for version 6. The following PGP key versions and strengths are supported: | | | | | --- | --- | --- | | pvDefault | 0 | The default version (situation-specific) | | pv3 | 3 | Version 3 | | pv4 | 4 | Version 4 | | pv5 | 5 | Version 5 | | pv6 | 6 | Version 6 | | | | | | --- | --- | --- | | psNormal | 0 | Normal strength | | psStrong | 1 | Increased strength | | psPostQuantum | 2 | Post-quantum algorithms | Provide the key encryption password and the validity period in days via the *Password* and *ValidTo* parameters. # import_bytes method Loads a key from a byte array. ## Syntax ```text def import_bytes(key: bytes) -> None: ... ``` ## Remarks Use this method to load a key, either public or secret, from a byte array. # import_from_file method Loads a key from a file. ## Syntax ```text def import_from_file(file_name: str) -> None: ... ``` ## Remarks Use this method to load a key, either public or secret, from a file. # import_pinned method Loads a key from a pinned key object. ## Syntax ```text def import_pinned() -> None: ... ``` ## Remarks Use this method to load a PGP key from a pinned_key object. This is an easy way to import a key object from a keyring. # remove_signature method Unbinds the specified signature from the key, subkey or user. ## Syntax ```text def remove_signature(index: int) -> None: ... ``` ## Remarks Use this method to remove the specified signature from the list of Signatures bound to the key, subkey or user. # remove_subkey method Removes the specified subkey from the key. ## Syntax ```text def remove_subkey(index: int) -> None: ... ``` ## Remarks Use this method to remove the subkey referred by its *Index* from the key. # remove_user method Unbinds the specified user from the key. ## Syntax ```text def remove_user(index: int) -> None: ... ``` ## Remarks Use this method to remove the specified user from the list of UserIDs bound to the key. # reset method Creates a new empty keyring. ## Syntax ```text def reset() -> None: ... ``` ## Remarks Use this method to initialize a new empty keyring. # revoke_key method Revokes the key. ## Syntax ```text def revoke_key(reason: int, comment: str) -> None: ... ``` ## Remarks Use this method to revoke the key by adding a revocation signature. # revoke_subkey method Revokes the key's subkey. ## Syntax ```text def revoke_subkey(index: int, reason: int, comment: str) -> None: ... ``` ## Remarks Use this method to revoke the subkey with a given *Index* by adding a revocation signature. # revoke_user method Revokes a user certification. ## Syntax ```text def revoke_user(index: int, reason: int, comment: str) -> None: ... ``` ## Remarks Use this method to revoke the user with the specified *Index* by adding a revocation signature to the key. # sign_key method Sign the key. ## Syntax ```text def sign_key(key_valid_to: str, hash_algorithm: str, preferred_algs: str, key_flags: int) -> None: ... ``` ## Remarks Use this method to sign the main key, or 'create a key binding signature', in terms of the PGP specification. Provide the signing key in signing_key. Use the *KeyValidTo* parameter to specify the key validity period and *HashAlgorithm* to provide the signature hash algorithm. The *PreferredAlgs* parameter is expected to contain a list of algorithms that the signer of the key prefers the senders to use. This value can contain a comma-separated mix of symmetric, hash, and compression algorithms from the following lists: Encryption algorithms: - Plaintext - IDEA - 3DES - Blowfish - AES128 - AES192 - AES256 - Twofish256 - CAST5 - Camellia128 - Camellia192 - Camellia256 Compression algorithms: - ZIP - ZLIB - BZIP2 Hash algorithms: - MD5 - SHA - RIPEMD160 - SHA224 - SHA256 - SHA384 - SHA512 - SHA3-256 - SHA3-384 - SHA3-512 Example: *Camellia192,AES192,SHA256,ZIP* If you leave *PreferredAlgs*, no algorithm preferences information will be saved with the key. The *KeyFlags* parameter is a bitmask that can contain the following bit flags: | | | | | --- | --- | --- | | KeyFlagCertifyOtherKeys | 1 | The key can certify other keys | | KeyFlagSignData | 2 | The key can be used to sign data | | KeyFlagEncryptData | 4 | The key can be used to encrypt data (in transit) | | KeyFlagEncryptStorage | 8 | The key can be used to encrypt data (at rest) | | KeyFlagSplitKey | 16 | The key is part of a split key scheme | | KeyFlagGroupKey | 32 | The key is part of a group key scheme | # sign_subkey method Sign the key's subkey. ## Syntax ```text def sign_subkey(index: int, key_valid_to: str, hash_algorithm: str, preferred_algs: str, key_flags: int) -> None: ... ``` ## Remarks Use this method to sign the subkey with a given *Index* (create a 'subkey binding signature'). Provide the signing key in signing_key. Use the *KeyValidTo* parameter to specify the subkey validity period and *HashAlgorithm* to provide the signature hash algorithm. The *PreferredAlgs* parameter is expected to contain a list of algorithms that the signer of the key prefers the senders to use when using the subkey that is being signed. This value can contain a comma-separated mix of symmetric, hash, and compression algorithms from the following lists: Encryption algorithms: - Plaintext - IDEA - 3DES - Blowfish - AES128 - AES192 - AES256 - Twofish256 - CAST5 - Camellia128 - Camellia192 - Camellia256 Compression algorithms: - ZIP - ZLIB - BZIP2 Hash algorithms: - MD5 - SHA - RIPEMD160 - SHA224 - SHA256 - SHA384 - SHA512 - SHA3-256 - SHA3-384 - SHA3-512 Example: *Camellia256,Twofish256,AES256,ZLIB,SHA512* If you leave *PreferredAlgs*, no algorithm preferences information will be saved with the key. The *KeyFlags* parameter is a bitmask that can contain the following bit flags: | | | | | --- | --- | --- | | KeyFlagCertifyOtherKeys | 1 | The key can certify other keys | | KeyFlagSignData | 2 | The key can be used to sign data | | KeyFlagEncryptData | 4 | The key can be used to encrypt data (in transit) | | KeyFlagEncryptStorage | 8 | The key can be used to encrypt data (at rest) | | KeyFlagSplitKey | 16 | The key is part of a split key scheme | | KeyFlagGroupKey | 32 | The key is part of a group key scheme | # sign_user method Creates a user certification. ## Syntax ```text def sign_user(index: int, key_valid_to: str, hash_algorithm: str, primary: bool, cert_type: int) -> None: ... ``` ## Remarks Use this method to sign the user ID with the specified *Index* using the signing_key. This signature creates a binding between the user ID and their main key. While it is typical to sign user IDs with their own secret keys, occasionally third-party authentication is used where the binding is signed with a third-party key. The *KeyValidTo* parameter indicates the expiration date of the binding. It can be different to that of the signing and/or the main key. The *Primary* parameter indicates whether this should be considered the primary user ID for this key (for example, if the user has more than one email). The *CertType* parameters indicates the type of binding, and should be set to one of the following values (if unsure, use pctGeneric): | | | | | --- | --- | --- | | pctGeneric | 0 | Generic certification of a User ID and Public Key packet. The issuer of this certification does not make any particular assertion as to how well the certifier has checked that the owner of the key is in fact the person described by the User ID. By default user certifications use Generic type. | | pctPersona | 1 | Persona certification of a User ID and Public Key packet. The issuer of this certification has not done any verification of the claim that the owner of this key corresponds to the specified User ID. | | pctCasual | 2 | Casual certification of a User ID and a Public Key packet. The issuer of this certification has done some casual verification of the claim of identity. | | pctPositive | 3 | Positive certification of a User ID and a Public Key packet. The issuer of this certification has done substantial verification of the claim of identity. | # verify method Verifies the integrity of a key signature. ## Syntax ```text def verify(index: int) -> bool: ... ``` ## Remarks Use this method to validate a key signature. Provide the index of the signature as a parameter. # on_error event Information about errors during PGP key management. ## Syntax ```text class PGPKeyManagerErrorEventParams(object): @property def error_code() -> int: ... @property def description() -> str: ... # In class PGPKeyManager: @property def on_error() -> Callable[[PGPKeyManagerErrorEventParams], None]: ... @on_error.setter def on_error(event_hook: Callable[[PGPKeyManagerErrorEventParams], None]) -> None: ... ``` ## Remarks The event is fired in case of exceptional conditions during key management. *ErrorCode* contains an error code and *Description* contains a textual description of the error. # on_key_passphrase_needed event Requests a key protection password from the application. ## Syntax ```text class PGPKeyManagerKeyPassphraseNeededEventParams(object): @property def key_id() -> str: ... @property def user_id() -> str: ... @property def main_key() -> bool: ... @property def passphrase() -> str: ... @passphrase.setter def passphrase(value) -> None: ... @property def skip() -> bool: ... @skip.setter def skip(value) -> None: ... # In class PGPKeyManager: @property def on_key_passphrase_needed() -> Callable[[PGPKeyManagerKeyPassphraseNeededEventParams], None]: ... @on_key_passphrase_needed.setter def on_key_passphrase_needed(event_hook: Callable[[PGPKeyManagerKeyPassphraseNeededEventParams], None]) -> None: ... ``` ## Remarks The class fires this event to request a secret key passphrase from the application. Note that this event asks for a key protection passphrase rather than a message protection passphrase. The class fires it when it attempts to use a secret key to sign the data. This event is fired for every protected secret key residing in signing_keys. *KeyID* specifies the key for which the password is requested, and *UserID* identifies its user. *MainKey* tells whether the key is a master key or a subkey. The handler should provide password via the *Passphrase* parameter, or set *Skip* to True to skip this key. For each key *KeyPassphraseNeeded* is called in a loop until the correct password is provided or the maximum number of password attempts reached. # on_notification event This event notifies the application about an underlying control flow event. ## Syntax ```text class PGPKeyManagerNotificationEventParams(object): @property def event_id() -> str: ... @property def event_param() -> str: ... # In class PGPKeyManager: @property def on_notification() -> Callable[[PGPKeyManagerNotificationEventParams], None]: ... @on_notification.setter def on_notification(event_hook: Callable[[PGPKeyManagerNotificationEventParams], None]) -> None: ... ``` ## Remarks The class fires this event to let the application know about some event, occurrence, or milestone in the class. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time. The unique identifier of the event is provided in the *EventID* parameter. *EventParam* contains any parameters accompanying the occurrence. Depending on the type of the class, the exact action it is performing, or the document being processed, one or both may be omitted. # PGPKeyManager Config Settings The class accepts one or more of the following *configuration settings*. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these *internal properties* is provided through the [config](#config-method) method. ### PGPKeyManager Config Settings **Armor**: Enables or disables ASCII armouring.Adjust this setting to enable or disable ASCII armouring on the outgoing messages. **ArmorBoundary**: Specifies the armour boundary/title.Use this setting to specify custom ASCII armouring titles that go after the -----BEGIN and -----END tokens. **ArmorHeaders**: Specifies armour headers.Use this setting to provide custom ASCII armouring (PEM) headers that should be included in the output. **HashAlgorithm**: The hash algorithm to use with the operation, when not accepted via a parameter.This configuration setting lets you specify the hash algorithm to be used with an operation that does not accept it via a method parameter. **KeyFlags**: Specifies key flags for user certification signatures.Use this setting to pass a bit mask of key flags to the user certification signature: | | | | | --- | --- | --- | | KeyFlagCertifyOtherKeys | 1 | The key can certify other keys | | KeyFlagSignData | 2 | The key can be used to sign data | | KeyFlagEncryptData | 4 | The key can be used to encrypt data (in transit) | | KeyFlagEncryptStorage | 8 | The key can be used to encrypt data (at rest) | | KeyFlagSplitKey | 16 | The key is part of a split key scheme | | KeyFlagGroupKey | 32 | The key is part of a group key scheme | Use this property before calling the [sign_user](#sign_user-method) method. The config setting is cleared after each signing operation. **KeyHashAlgorithm**: The hash algorithm associated with the key.This setting returns the hash algorithm associated with and inherent to the key (such as SHA1 for DSA keys, or SHA512 for EdDSA keys) **PreferredAlgs**: Specifies preferred algorithms for user certification signatures.Use this setting to include a list of preferred algorithms in the certification signature. The algorithms may include symmetric, hash, and compression algorithms. Example: AES256,SHA256,AES128,SHA512,ZIP,ZLIB,CAST5 **RawKeyFormat**: Specifies whether low-level key format should be used as input or output of an operation.This setting specifies whether to use the raw (low-level, such as PKCS#1) key format during import or export operation. **RespectKeyUsage**: Enables policy-based key usage checks.Set this property to true to enable policy-based key usage checks. If set to false (the default value), the values of CanSign and CanEncrypt properties of the key objects are based on the underlying cryptographic algorithm capabilities only. If switched to true, the values of the properties also consider the content of the key flags extension included in the respective key signatures. **SaveKeyTrust**: Tells the component to include the trust packets with the serialized keys.Enables or disables inclusion of trust markers in the output keyring files. The default value is true. **SaveSecretKeySignatures**: Enforces saving of signature packets to the secret keyring file.By default, key binding and user ID signatures are saved with the public part of the PGP keyring, whereas the private part only contains the secret key material. Set this option to true to enforce saving of signatures alongside the private keys. This may be useful when storing the keyring as a single file instead of a public/private pair. **SignatureCreationTime**: Indicates the signature creation time.Returns the signature creation time. **SignatureExpirationTime**: Returns or sets the signature expiration time.Returns the signature expiration time. **SignatureHashAlgorithm**: The hash algorithm of the signature.Use this setting to obtain the hash algorithm of the signature. **SubkeyIndex**: Allows to select a specific subkey for certain operations.It is typical for PGP key trees to employ the same protection parameters and passwords for all the keys and subkeys contained in the tree. This config setting lets you select a specific subkey if you want to apply certain protection parameter exclusively to that subkey. For example, the following code will only change the passphrase on the subkey with the index of 2: ```text mgr.Config("SubkeyIndex=2"); mgr.ChangePassphrase("oldpass", "newpass"); ``` Note: set this property to -2 to apply the setting to the main key. The default value of -1 indicates that any protection operation applies to all keys and subkeys in the tree. **UseLongKeyIDs**: Use full-length KeyID format.It is typical for implementations to use the lower 4 bytes of PGP key IDs. Set this property to true to switch to the full (8-byte) key ID format. ### Base Config Settings **ASN1UseGlobalTagCache**: Controls whether ASN.1 module should use a global object cache.This is a performance setting. It is unlikely that you will ever need to adjust it. **AssignSystemSmartCardPins**: Specifies whether CSP-level PINs should be assigned to CNG keys.This is a low-level tweak for certain cryptographic providers. It is unlikely that you will ever need to adjust it. **CheckKeyIntegrityBeforeUse**: Enables or disable private key integrity check before use.This global property enables or disables private key material check before each signing operation. This slows down performance a bit, but prevents a selection of attacks on RSA keys where keys with unknown origins are used. You can switch this property off to improve performance if your project only uses known, good private keys. **CookieCaching**: Specifies whether a cookie cache should be used for HTTP(S) transports.Set this property to enable or disable cookies caching for the class. Supported values are: | | | | | --- | --- | --- | | off | | No caching (default) | | local | | Local caching | | global | | Global caching | **Cookies**: Gets or sets local cookies for the class.Use this property to get cookies from the internal cookie storage of the class and/or restore them back between application sessions. **DefDeriveKeyIterations**: Specifies the default key derivation algorithm iteration count.This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided. **DNSLocalSuffix**: The suffix to assign for TLD names.Use this global setting to adjust the default suffix to assign to top-level domain names. The default is *.local*. **EnableClientSideSSLFFDHE**: Enables or disables finite field DHE key exchange support in TLS clients.This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower algorithm if compared to EC DHE; enabling it may result in slower connections. This setting only applies to sessions negotiated with TLS version 1.3. **EnableSSHMLKEM**: Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server components.Use this setting to enable hybrid key exchange algorithms in client and server SSH and SFTP components. This is a global setting that enables ML-KEM blanketly in all SSH-dependent components. **EnableTLSMLKEM**: Enables support for ML-KEM and hybrid groups in TLS client and server components.Use this setting to enable ML-KEM and hybrid key exchange groups in client and server TLS components. This is a global setting that enables ML-KEM blanketly in all TLS-dependent components. **GlobalCookies**: Gets or sets global cookies for all the HTTP transports.Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the classes that have its *CookieCaching* property set to "global". **HardwareCryptoUsePolicy**: The hardware crypto usage policy.This global setting controls the hardware cryptography usage policy. Supported Values: | | | | --- | --- | | auto | Use hardware cryptography if available; otherwise, fall back to software-based cryptography (default). | | enable | Always attempt to use hardware cryptography. If unavailable, exception will be thrown. | | disable | Do not use hardware cryptography. | **HttpUserAgent**: Specifies the user agent name to be used by all HTTP clients.This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other classes. **HttpVersion**: The HTTP version to use in any inner HTTP client components created.Set this property to 1.0 or 1.1 to indicate the HTTP version that any internal HTTP clients should use. **IgnoreExpiredMSCTLSigningCert**: Whether to tolerate the expired Windows Update signing certificate.It is not uncommon for Microsoft Windows Update Certificate Trust List to be signed with an expired Microsoft certificate. Setting this global property to true makes SBB ignore the expired factor and take the Trust List into account. **ListDelimiter**: The delimiter character for multi-element lists.Allows to set the delimiter for any multi-entry values returned by the component as a string object, such as file lists. For most of the components, this property is set to a newline sequence. **LogDestination**: Specifies the debug log destination.Contains a comma-separated list of values that specifies where debug log should be dumped. Supported values are: | | | | | --- | --- | --- | | file | | File | | console | | Console | | systemlog | | System Log (supported for Android only) | | debugger | | Debugger (supported for VCL for Windows and .Net) | **LogDetails**: Specifies the debug log details to dump.Contains a comma-separated list of values that specifies which debug log details to dump. Supported values are: | | | | | --- | --- | --- | | time | | Current time | | level | | Level | | package | | Package name | | module | | Module name | | class | | Class name | | method | | Method name | | threadid | | Thread Id | | contenttype | | Content type | | content | | Content | | all | | All details | **LogFile**: Specifies the debug log filename.Use this property to provide a path to the log file. **LogFilters**: Specifies the debug log filters.Contains a comma-separated list of value pairs ("name:value") that describe filters. Supported filter names are: | | | | | --- | --- | --- | | exclude-package | | Exclude a package specified in the value | | exclude-module | | Exclude a module specified in the value | | exclude-class | | Exclude a class specified in the value | | exclude-method | | Exclude a method specified in the value | | include-package | | Include a package specified in the value | | include-module | | Include a module specified in the value | | include-class | | Include a class specified in the value | | include-method | | Include a method specified in the value | **LogFlushMode**: Specifies the log flush mode.Use this property to set the log flush mode. The following values are defined: | | | | | --- | --- | --- | | none | | No flush (caching only) | | immediate | | Immediate flush (real-time logging) | | maxcount | | Flush cached entries upon reaching LogMaxEventCount entries in the cache. | **LogLevel**: Specifies the debug log level.Use this property to provide the desired debug log level. Supported values are: | | | | | --- | --- | --- | | none | | None (by default) | | fatal | | Severe errors that cause premature termination. | | error | | Other runtime errors or unexpected conditions. | | warning | | Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong". | | info | | Interesting runtime events (startup/shutdown). | | debug | | Detailed information on flow of through the system. | | trace | | More detailed information. | **LogMaxEventCount**: Specifies the maximum number of events to cache before further action is taken.Use this property to specify the log event number threshold. This threshold may have different effects, depending on the rotation setting and/or the flush mode. The default value of this setting is 100. **LogRotationMode**: Specifies the log rotation mode.Use this property to set the log rotation mode. The following values are defined: | | | | | --- | --- | --- | | none | | No rotation | | deleteolder | | Delete older entries from the cache upon reaching LogMaxEventCount | | keepolder | | Keep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded) | **MaxASN1BufferLength**: Specifies the maximal allowed length for ASN.1 primitive tag data.This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks. **MaxASN1TreeDepth**: Specifies the maximal depth for processed ASN.1 trees.This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks. **OCSPHashAlgorithm**: Specifies the hash algorithm to be used to identify certificates in OCSP requests.This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful. **OldClientSideRSAFallback**: Specifies whether the SSH client should use a SHA1 fallback.Tells the SSH client to use a legacy ssh-rsa authentication even if the server indicates support for newer algorithms, such as rsa-sha-256. This is a backward-compatibility tweak. **PKICache**: Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached.The PKICache setting specifies which Public Key Infrastructure (PKI) elements should be cached to optimize performance and reduce retrieval times. It supports comma-separated values to indicate the specific types of PKI data that should be cached. Supported Values: | | | | --- | --- | | certificate | Enables caching of certificates. | | crl | Enables caching of Certificate Revocation Lists (CRLs). | | ocsp | Enables caching of OCSP (Online Certificate Status Protocol) responses. | Example (default value): ```text PKICache=certificate,crl,ocsp ``` In this example, the component caches certificates, CRLs, and OCSP responses. **PKICachePath**: Specifies the file system path where cached PKI data is stored.The PKICachePath setting defines the file system path where cached PKI data (e.g., certificates, CRLs, OCSP responses and Trusted Lists) will be stored. This allows the system to persistently save and retrieve PKI cache data, even across application restarts. The default value is an empty string - no cached PKI data is stored on disk. Example: ```text PKICachePath=C:\Temp\cache ``` In this example, the cached PKI data is stored in the C:\Temp\cache directory. **ProductVersion**: Returns the version of the SecureBlackbox library.This property returns the long version string of the SecureBlackbox library being used (major.minor.build.revision). **ServerSSLDHKeyLength**: Sets the size of the TLS DHE key exchange group.Use this property to adjust the length, in bits, of the DHE prime to be used by the TLS server. **StaticDNS**: Specifies whether static DNS rules should be used.Set this property to enable or disable static DNS rules for the class. Works only if *UseOwnDNSResolver* is set to *true*. Supported values are: | | | | | --- | --- | --- | | none | | No static DNS rules (default) | | local | | Local static DNS rules | | global | | Global static DNS rules | **StaticIPAddress[domain]**: Gets or sets an IP address for the specified domain name.Use this property to get or set an IP address for the specified domain name in the internal (of the class) or global DNS rules storage depending on the *StaticDNS* value. The type of the IP address (IPv4 or IPv6) is determined automatically. If both addresses are available, they are divided by the | (pipe) character. **StaticIPAddresses**: Gets or sets all the static DNS rules.Use this property to get static DNS rules from the current rules storage or restore them back between application sessions. If *StaticDNS* of the class is set to "*local*", the property returns/restores the rules from/to the internal storage of the class. If *StaticDNS* of the class is set to "*global*", the property returns/restores the rules from/to the GLOBAL storage. The rules list is returned and accepted in JSON format. **Tag**: Allows to store any custom data.Use this config property to store any custom data. **TLSSessionGroup**: Specifies the group name of TLS sessions to be used for session resumption.Use this property to limit the search of cached TLS sessions to the specified group. Sessions from other groups will be ignored. By default, all sessions are cached with an empty group name and available to all the classes. **TLSSessionLifetime**: Specifies lifetime in seconds of the cached TLS session.Use this property to specify how much time the TLS session should be kept in the session cache. After this time, the session expires and will be automatically removed from the cache. Default value is 300 seconds (5 minutes). **TLSSessionPurgeInterval**: Specifies how often the session cache should remove the expired TLS sessions.Use this property to specify the time interval of purging the expired TLS sessions from the session cache. Default value is 60 seconds (1 minute). **UseCRLObjectCaching**: Specifies whether reuse of loaded CRL objects is enabled.This setting enables or disables the caching of CRL objects. When set to true (the default value), the system checks if a CRL object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where CRL objects are frequently used. **UseInternalRandom**: Switches between SecureBlackbox-own and platform PRNGs.Allows to switch between internal/native PRNG implementation and the one provided by the platform. **UseLegacyAdESValidation**: Enables legacy AdES validation mode.Use this setting to switch the AdES component to the validation approach that was used in SBB 2020/SBB 2022 (less attention to temporal details). **UseOCSPResponseObjectCaching**: Specifies whether reuse of loaded OCSP response objects is enabled.This setting enables or disables the caching of OCSP response objects. When set to true (the default value), the system checks if a OCSP response object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where OCSP response objects are frequently used. **UseOwnDNSResolver**: Specifies whether the client components should use own DNS resolver.Set this global property to false to force all the client components to use the DNS resolver provided by the target OS instead of using own one. **UseSharedSystemStorages**: Specifies whether the validation engine should use a global per-process copy of the system certificate stores.Set this global property to false to make each validation run use its own copy of system certificate stores. **UseSystemNativeSizeCalculation**: An internal CryptoAPI access tweak.This is an internal setting. Please do not use it unless instructed by the support team. **UseSystemOAEPAndPSS**: Enforces or disables the use of system-driven RSA OAEP and PSS computations.This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable. If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations using its own OAEP/PSS implementation. This setting only applies to certificates originating from a Windows system store. **UseSystemRandom**: Enables or disables the use of the OS PRNG.Use this global property to enable or disable the use of operating system-driven pseudorandom number generation. **XMLRDNDescriptorName[OID]**: Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN.This property defines custom mappings between Object Identifiers (OIDs) and descriptor names. This mapping specifies how the certificate's issuer and subject information (ds:IssuerRDN and ds:SubjectRDN elements respectively) are represented in XML signatures. The property accepts comma-separated values where the first descriptor name is used when the OID is mapped, and subsequent values act as aliases for parsing. Syntax: ```text Config("XMLRDNDescriptorName[OID]=PrimaryName,Alias1,Alias2"); ``` Where: OID: The Object Identifier from the certificate's IssuerRDN or SubjectRDN that you want to map. PrimaryName: The main descriptor name used in the XML signature when the OID is encountered. Alias1, Alias2, ...: Optional alternative names recognized during parsing. Usage Examples: Map OID 2.5.4.5 to SERIALNUMBER: ```text Config("XMLRDNDescriptorName[2.5.4.5]=SERIALNUMBER"); ``` Map OID 1.2.840.113549.1.9.1 to E, with aliases EMAIL and EMAILADDRESS: ```text Config("XMLRDNDescriptorName[1.2.840.113549.1.9.1]=E,EMAIL,EMAILADDRESS"); ``` **XMLRDNDescriptorPriority[OID]**: Specifies the priority of descriptor names associated with a specific OID.This property specifies the priority of descriptor names associated with a specific OID that allows to reorder descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during signing. **XMLRDNDescriptorReverseOrder**: Specifies whether to reverse the order of descriptors in RDN.Specifies whether to reverse the order of descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to true (as specified in RFC 2253, 2.1). **XMLRDNDescriptorSeparator**: Specifies the separator used between descriptors in RDN.Specifies the separator used between descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to ", " value. # PGPKeyManager Errors ### PGPKeyManager Errors | | | | --- | --- | | 1048577 | Invalid parameter ([SB_ERROR_INVALID_PARAMETER](constants.md#const_SBERRORINVALIDPARAMETER)) | | 1048578 | Invalid configuration ([SB_ERROR_INVALID_SETUP](constants.md#const_SBERRORINVALIDSETUP)) | | 1048579 | Invalid state ([SB_ERROR_INVALID_STATE](constants.md#const_SBERRORINVALIDSTATE)) | | 1048580 | Invalid value ([SB_ERROR_INVALID_VALUE](constants.md#const_SBERRORINVALIDVALUE)) | | 1048581 | Private key not found ([SB_ERROR_NO_PRIVATE_KEY](constants.md#const_SBERRORNOPRIVATEKEY)) | | 1048582 | Cancelled by the user ([SB_ERROR_CANCELLED_BY_USER](constants.md#const_SBERRORCANCELLEDBYUSER)) | | 1048583 | The file was not found ([SB_ERROR_NO_SUCH_FILE](constants.md#const_SBERRORNOSUCHFILE)) | | 1048584 | Unsupported feature or operation ([SB_ERROR_UNSUPPORTED_FEATURE](constants.md#const_SBERRORUNSUPPORTEDFEATURE)) | | 1048585 | General error ([SB_ERROR_GENERAL_ERROR](constants.md#const_SBERRORGENERALERROR)) | | 27262977 | The file was not found ([SB_ERROR_PGP_FILE_NOT_EXISTS](constants.md#const_SBERRORPGPFILENOTEXISTS)) | | 27262978 | Invalid signing key ([SB_ERROR_PGP_INVALID_KEY](constants.md#const_SBERRORPGPINVALIDKEY)) | | 27262980 | No secret key is available ([SB_ERROR_PGP_NO_SECRET_KEY](constants.md#const_SBERRORPGPNOSECRETKEY)) | | 27262982 | The operation is not supported on a subkey ([SB_ERROR_PGP_OPERATION_ON_SUBKEY](constants.md#const_SBERRORPGPOPERATIONONSUBKEY)) |