PGPKeyring Class
Properties Methods Events Config Settings Errors
The PGPKeyring class manages PGP keyring files.
Syntax
class secureblackbox.PGPKeyring
Remarks
Keyring keep the details of local PGP key collections. A typical keyring consists of two parts, with the first part containing the public keys of other people, and the second part containing the secret keys of the keyring owner (i.e. your secret keys).
PGPKeyring 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.
Depending on your task at hand, you may need to only use the public part, or both. However, there is a couple of catches here. Some PGP implementations operate with just one keyring file that contains both the public and secret keys. The others sometimes mess-up the keys, with secret key accidentally ending up in the public part of the keyring, or the other way round.
Our suggestion therefore is to load all the keyring files that you have into PGPKeyring using consecutive import_from_file (or import_bytes) calls, and then look for the keys that match the required parameters in the keys collection. That would provide fault-tolerant and smooth experience to your customers.
PGPKeyring keyring = new PGPKeyring();
keyring.ImportFromFile("pubring.pkr");
keyring.ImportFromFile("secring.skr");Once you have loaded your keyring files into the keyring, you can perform the following operations on the keys:
- Iterate over the whole set of keys using keys collection.
- Add new keys to the keyring using methods such as import_bytes, import_pinned, or import_from_file.
- Save the updated keyring using export_bytes or export_to_file methods.
- Use select to filter keys by certain criteria (public/private, KeyID) into a separate selected_keys list.
- Remove keys from the keyring.
- Assign the keyring keys to properties like PGPWriter.SigningKeys to use them for encryption or signing.
Once you have completed your work with PGPKeyring, dispose of the object or call reset to clean up all the key information from memory.
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_count | The number of records in the Key arrays. |
| key_bits_in_key | Indicates the key length in bits. |
| key_can_encrypt | Returns True if this key can be used for encryption. |
| key_can_sign | Returns True if this key can be used for signing. |
| key_curve | Indicates the elliptic curve associated with a EC key. |
| key_enabled | Enables or disables this key for use in encryption or signing operation. |
| key_encryption_algorithm | Indicates the symmetric algorithm used to encrypt the secret key. |
| key_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| key_is_public | Returns True if this key is a public key, and False otherwise. |
| key_is_secret | Returns True if this key is a secret key, and False otherwise. |
| key_is_subkey | Returns True if this key is a subkey of another key, and False otherwise. |
| key_key_fp | The 20-byte fingerprint (hash value) of this key. |
| key_key_id | Contains a 8-byte key identifier. |
| key_passphrase | The key protection password. |
| key_passphrase_valid | Use this property to check whether the specified Passphrase is valid and can be used to unlock the secret key. |
| key_primary_key_id | If this key is a subkey ( IsSubkey returns True), this property contains the identifier of the subkey's primary key. |
| key_protection | Specifies the level of protection applied to the secret key. |
| key_public_key_algorithm | Specifies the asymmetric algorithm of the key. |
| key_q_bits | The length of the DSA Q (legitimate range: 160-512). |
| key_timestamp | Use this property to check the time the key was generated. |
| key_username | Specifies the name of the user bound to this key. |
| key_valid_to | Provide accurate expiration moment indication. |
| key_version | Indicates the key version. |
| pinned_key_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| selected_key_count | The number of records in the SelectedKey arrays. |
| selected_key_bits_in_key | Indicates the key length in bits. |
| selected_key_can_encrypt | Returns True if this key can be used for encryption. |
| selected_key_can_sign | Returns True if this key can be used for signing. |
| selected_key_curve | Indicates the elliptic curve associated with a EC key. |
| selected_key_enabled | Enables or disables this key for use in encryption or signing operation. |
| selected_key_encryption_algorithm | Indicates the symmetric algorithm used to encrypt the secret key. |
| selected_key_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| selected_key_is_public | Returns True if this key is a public key, and False otherwise. |
| selected_key_is_secret | Returns True if this key is a secret key, and False otherwise. |
| selected_key_is_subkey | Returns True if this key is a subkey of another key, and False otherwise. |
| selected_key_key_fp | The 20-byte fingerprint (hash value) of this key. |
| selected_key_key_id | Contains a 8-byte key identifier. |
| selected_key_passphrase | The key protection password. |
| selected_key_passphrase_valid | Use this property to check whether the specified Passphrase is valid and can be used to unlock the secret key. |
| selected_key_primary_key_id | If this key is a subkey ( IsSubkey returns True), this property contains the identifier of the subkey's primary key. |
| selected_key_protection | Specifies the level of protection applied to the secret key. |
| selected_key_public_key_algorithm | Specifies the asymmetric algorithm of the key. |
| selected_key_q_bits | The length of the DSA Q (legitimate range: 160-512). |
| selected_key_timestamp | Use this property to check the time the key was generated. |
| selected_key_username | Specifies the name of the user bound to this key. |
| selected_key_valid_to | Provide accurate expiration moment indication. |
| selected_key_version | Indicates the key version. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
| config | Sets or retrieves a configuration setting. |
| do_action | Performs an additional action. |
| export_bytes | Exports the keyring to a byte array. |
| export_to_file | Exports the keyring to disk. |
| import_bytes | Loads a key from a byte array. |
| import_from_file | Loads a key from a file. |
| import_pinned | Imports a pinned secret key to the keyring. |
| remove | Removes the specified key from the keyring. |
| remove_by_id | Removes key by its ID. |
| reset | Creates a new empty keyring. |
| select | Filters a selection of keys from the keyring using a template. |
| update_pinned | Update a pinned key in the keyring. |
Event List
The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.
| on_error | Information about errors during PGP key management. |
| on_notification | This event notifies the application about an underlying control flow event. |
Config Settings
The following is a list of config settings for the class with short descriptions. Click on the links for further details.
| Armor | Enables or disables ASCII armouring. |
| ArmorBoundary | Specifies the armour boundary/title. |
| ArmorHeaders | Specifies armour headers. |
| UseLongKeyIDs | Enables long (8-byte) KeyID representation. |
| ASN1UseGlobalTagCache | Controls whether ASN.1 module should use a global object cache. |
| AssignSystemSmartCardPins | Specifies whether CSP-level PINs should be assigned to CNG keys. |
| CheckKeyIntegrityBeforeUse | Enables or disable private key integrity check before use. |
| CookieCaching | Specifies whether a cookie cache should be used for HTTP(S) transports. |
| Cookies | Gets or sets local cookies for the class. |
| DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
| DNSLocalSuffix | The suffix to assign for TLD names. |
| EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
| GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
| HardwareCryptoUsePolicy | The hardware crypto usage policy. |
| HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
| HttpVersion | The HTTP version to use in any inner HTTP client classes created. |
| IgnoreExpiredMSCTLSigningCert | Whether to tolerate the expired Windows Update signing certificate. |
| ListDelimiter | The delimiter character for multi-element lists. |
| LogDestination | Specifies the debug log destination. |
| LogDetails | Specifies the debug log details to dump. |
| LogFile | Specifies the debug log filename. |
| LogFilters | Specifies the debug log filters. |
| LogFlushMode | Specifies the log flush mode. |
| LogLevel | Specifies the debug log level. |
| LogMaxEventCount | Specifies the maximum number of events to cache before further action is taken. |
| LogRotationMode | Specifies the log rotation mode. |
| MaxASN1BufferLength | Specifies the maximal allowed length for ASN.1 primitive tag data. |
| MaxASN1TreeDepth | Specifies the maximal depth for processed ASN.1 trees. |
| OCSPHashAlgorithm | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
| OldClientSideRSAFallback | Specifies whether the SSH client should use a SHA1 fallback. |
| PKICache | Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached. |
| PKICachePath | Specifies the file system path where cached PKI data is stored. |
| ProductVersion | Returns the version of the SecureBlackbox library. |
| ServerSSLDHKeyLength | Sets the size of the TLS DHE key exchange group. |
| StaticDNS | Specifies whether static DNS rules should be used. |
| StaticIPAddress[domain] | Gets or sets an IP address for the specified domain name. |
| StaticIPAddresses | Gets or sets all the static DNS rules. |
| Tag | Allows to store any custom data. |
| TLSSessionGroup | Specifies the group name of TLS sessions to be used for session resumption. |
| TLSSessionLifetime | Specifies lifetime in seconds of the cached TLS session. |
| TLSSessionPurgeInterval | Specifies how often the session cache should remove the expired TLS sessions. |
| UseCRLObjectCaching | Specifies whether reuse of loaded CRL objects is enabled. |
| UseInternalRandom | Switches between SecureBlackbox-own and platform PRNGs. |
| UseLegacyAdESValidation | Enables legacy AdES validation mode. |
| UseOCSPResponseObjectCaching | Specifies whether reuse of loaded OCSP response objects is enabled. |
| UseOwnDNSResolver | Specifies whether the client classes should use own DNS resolver. |
| UseSharedSystemStorages | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
| UseSystemNativeSizeCalculation | An internal CryptoAPI access tweak. |
| UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
| UseSystemRandom | Enables or disables the use of the OS PRNG. |
| XMLRDNDescriptorName[OID] | Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN. |
| XMLRDNDescriptorPriority[OID] | Specifies the priority of descriptor names associated with a specific OID. |
| XMLRDNDescriptorReverseOrder | Specifies whether to reverse the order of descriptors in RDN. |
| XMLRDNDescriptorSeparator | Specifies the separator used between descriptors in RDN. |
key_count Property
The number of records in the Key arrays.
Syntax
def get_key_count() -> int: ...
key_count = property(get_key_count, None)
Default Value
0
Remarks
This property controls the size of the following arrays:
- key_bits_in_key
- key_can_encrypt
- key_can_sign
- key_curve
- key_enabled
- key_encryption_algorithm
- key_handle
- key_is_public
- key_is_secret
- key_is_subkey
- key_key_fp
- key_key_id
- key_passphrase
- key_passphrase_valid
- key_primary_key_id
- key_protection
- key_public_key_algorithm
- key_q_bits
- key_timestamp
- key_username
- key_valid_to
- key_version
The array indices start at 0 and end at key_count - 1.
This property is read-only.
key_bits_in_key Property
Indicates the key length in bits.
Syntax
def get_key_bits_in_key(key_index: int) -> int: ...
Default Value
2048
Remarks
Indicates the key length in bits.
The key_index parameter specifies the index of the item in the array. The size of the array is controlled by the key_count property.
This property is read-only.
key_can_encrypt Property
Returns True if this key can be used for encryption.
Syntax
def get_key_can_encrypt(key_index: int) -> bool: ...
Default Value
FALSE
Remarks
Returns True if this key can be used for encryption.
The key_index parameter specifies the index of the item in the array. The size of the array is controlled by the key_count property.
This property is read-only.
key_can_sign Property
Returns True if this key can be used for signing.
Syntax
def get_key_can_sign(key_index: int) -> bool: ...
Default Value
FALSE
Remarks
Returns True if this key can be used for signing.
The key_index parameter specifies the index of the item in the array. The size of the array is controlled by the key_count property.
This property is read-only.
key_curve Property
Indicates the elliptic curve associated with a EC key.
Syntax
def get_key_curve(key_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 key_index parameter specifies the index of the item in the array. The size of the array is controlled by the key_count property.
This property is read-only.
key_enabled Property
Enables or disables this key for use in encryption or signing operation.
Syntax
def get_key_enabled(key_index: int) -> bool: ...
Default Value
FALSE
Remarks
Enables or disables this key for use in encryption or signing operation.
The key_index parameter specifies the index of the item in the array. The size of the array is controlled by the key_count property.
This property is read-only.
key_encryption_algorithm Property
Indicates the symmetric algorithm used to encrypt the secret key.
Syntax
def get_key_encryption_algorithm(key_index: int) -> str: ...
Default Value
"AES128"
Remarks
Indicates the symmetric algorithm used to encrypt the secret key.
The key_index parameter specifies the index of the item in the array. The size of the array is controlled by the key_count property.
This property is read-only.
key_handle Property
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
def get_key_handle(key_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.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());The key_index parameter specifies the index of the item in the array. The size of the array is controlled by the key_count property.
This property is read-only.
key_is_public Property
Returns True if this key is a public key, and False otherwise.
Syntax
def get_key_is_public(key_index: int) -> bool: ...
Default Value
FALSE
Remarks
Returns True if this key is a public key, and False otherwise.
The key_index parameter specifies the index of the item in the array. The size of the array is controlled by the key_count property.
This property is read-only.
key_is_secret Property
Returns True if this key is a secret key, and False otherwise.
Syntax
def get_key_is_secret(key_index: int) -> bool: ...
Default Value
FALSE
Remarks
Returns True if this key is a secret key, and False otherwise.
The key_index parameter specifies the index of the item in the array. The size of the array is controlled by the key_count property.
This property is read-only.
key_is_subkey Property
Returns True if this key is a subkey of another key, and False otherwise.
Syntax
def get_key_is_subkey(key_index: int) -> bool: ...
Default Value
FALSE
Remarks
Returns True if this key is a subkey of another key, and False otherwise.
The key_index parameter specifies the index of the item in the array. The size of the array is controlled by the key_count property.
This property is read-only.
key_key_fp Property
The 20-byte fingerprint (hash value) of this key.
Syntax
def get_key_key_fp(key_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 key_index parameter specifies the index of the item in the array. The size of the array is controlled by the key_count property.
This property is read-only.
key_key_id Property
Contains a 8-byte key identifier.
Syntax
def get_key_key_id(key_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 key_index parameter specifies the index of the item in the array. The size of the array is controlled by the key_count property.
This property is read-only.
key_passphrase Property
The key protection password.
Syntax
def get_key_passphrase(key_index: int) -> str: ...
Default Value
""
Remarks
The key protection password.
The key_index parameter specifies the index of the item in the array. The size of the array is controlled by the key_count property.
This property is read-only.
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
def get_key_passphrase_valid(key_index: int) -> bool: ...
Default Value
FALSE
Remarks
Use this property to check whether the specified key_passphrase is valid and can be used to unlock the secret key.
The key_index parameter specifies the index of the item in the array. The size of the array is controlled by the key_count property.
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
def get_key_primary_key_id(key_index: int) -> str: ...
Default Value
""
Remarks
If this key is a subkey (key_is_subkey returns True), this property contains the identifier of the subkey's primary key.
The key_index parameter specifies the index of the item in the array. The size of the array is controlled by the key_count property.
This property is read-only.
key_protection Property
Specifies the level of protection applied to the secret key.
Syntax
def get_key_protection(key_index: int) -> int: ...
Possible Values
0 # None
1 # Low
2 # Normal
3 # 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 key_index parameter specifies the index of the item in the array. The size of the array is controlled by the key_count property.
This property is read-only.
key_public_key_algorithm Property
Specifies the asymmetric algorithm of the key.
Syntax
def get_key_public_key_algorithm(key_index: int) -> str: ...
Default Value
""
Remarks
Specifies the asymmetric algorithm of the key.
The key_index parameter specifies the index of the item in the array. The size of the array is controlled by the key_count property.
This property is read-only.
key_q_bits Property
The length of the DSA Q (legitimate range: 160-512).
Syntax
def get_key_q_bits(key_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 key_index parameter specifies the index of the item in the array. The size of the array is controlled by the key_count property.
This property is read-only.
key_timestamp Property
Use this property to check the time the key was generated.
Syntax
def get_key_timestamp(key_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 key_index parameter specifies the index of the item in the array. The size of the array is controlled by the key_count property.
This property is read-only.
key_username Property
Specifies the name of the user bound to this key.
Syntax
def get_key_username(key_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 key_index parameter specifies the index of the item in the array. The size of the array is controlled by the key_count property.
This property is read-only.
key_valid_to Property
Provide accurate expiration moment indication.
Syntax
def get_key_valid_to(key_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 key_index parameter specifies the index of the item in the array. The size of the array is controlled by the key_count property.
This property is read-only.
key_version Property
Indicates the key version.
Syntax
def get_key_version(key_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 key_index parameter specifies the index of the item in the array. The size of the array is controlled by the key_count property.
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
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.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());selected_key_count Property
The number of records in the SelectedKey arrays.
Syntax
def get_selected_key_count() -> int: ...
selected_key_count = property(get_selected_key_count, None)
Default Value
0
Remarks
This property controls the size of the following arrays:
- selected_key_bits_in_key
- selected_key_can_encrypt
- selected_key_can_sign
- selected_key_curve
- selected_key_enabled
- selected_key_encryption_algorithm
- selected_key_handle
- selected_key_is_public
- selected_key_is_secret
- selected_key_is_subkey
- selected_key_key_fp
- selected_key_key_id
- selected_key_passphrase
- selected_key_passphrase_valid
- selected_key_primary_key_id
- selected_key_protection
- selected_key_public_key_algorithm
- selected_key_q_bits
- selected_key_timestamp
- selected_key_username
- selected_key_valid_to
- selected_key_version
The array indices start at 0 and end at selected_key_count - 1.
This property is read-only.
selected_key_bits_in_key Property
Indicates the key length in bits.
Syntax
def get_selected_key_bits_in_key(selected_key_index: int) -> int: ...
Default Value
2048
Remarks
Indicates the key length in bits.
The selected_key_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_key_count property.
This property is read-only.
selected_key_can_encrypt Property
Returns True if this key can be used for encryption.
Syntax
def get_selected_key_can_encrypt(selected_key_index: int) -> bool: ...
Default Value
FALSE
Remarks
Returns True if this key can be used for encryption.
The selected_key_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_key_count property.
This property is read-only.
selected_key_can_sign Property
Returns True if this key can be used for signing.
Syntax
def get_selected_key_can_sign(selected_key_index: int) -> bool: ...
Default Value
FALSE
Remarks
Returns True if this key can be used for signing.
The selected_key_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_key_count property.
This property is read-only.
selected_key_curve Property
Indicates the elliptic curve associated with a EC key.
Syntax
def get_selected_key_curve(selected_key_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 selected_key_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_key_count property.
This property is read-only.
selected_key_enabled Property
Enables or disables this key for use in encryption or signing operation.
Syntax
def get_selected_key_enabled(selected_key_index: int) -> bool: ...
Default Value
FALSE
Remarks
Enables or disables this key for use in encryption or signing operation.
The selected_key_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_key_count property.
This property is read-only.
selected_key_encryption_algorithm Property
Indicates the symmetric algorithm used to encrypt the secret key.
Syntax
def get_selected_key_encryption_algorithm(selected_key_index: int) -> str: ...
Default Value
"AES128"
Remarks
Indicates the symmetric algorithm used to encrypt the secret key.
The selected_key_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_key_count property.
This property is read-only.
selected_key_handle Property
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
def get_selected_key_handle(selected_key_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.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());The selected_key_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_key_count property.
This property is read-only.
selected_key_is_public Property
Returns True if this key is a public key, and False otherwise.
Syntax
def get_selected_key_is_public(selected_key_index: int) -> bool: ...
Default Value
FALSE
Remarks
Returns True if this key is a public key, and False otherwise.
The selected_key_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_key_count property.
This property is read-only.
selected_key_is_secret Property
Returns True if this key is a secret key, and False otherwise.
Syntax
def get_selected_key_is_secret(selected_key_index: int) -> bool: ...
Default Value
FALSE
Remarks
Returns True if this key is a secret key, and False otherwise.
The selected_key_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_key_count property.
This property is read-only.
selected_key_is_subkey Property
Returns True if this key is a subkey of another key, and False otherwise.
Syntax
def get_selected_key_is_subkey(selected_key_index: int) -> bool: ...
Default Value
FALSE
Remarks
Returns True if this key is a subkey of another key, and False otherwise.
The selected_key_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_key_count property.
This property is read-only.
selected_key_key_fp Property
The 20-byte fingerprint (hash value) of this key.
Syntax
def get_selected_key_key_fp(selected_key_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 selected_key_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_key_count property.
This property is read-only.
selected_key_key_id Property
Contains a 8-byte key identifier.
Syntax
def get_selected_key_key_id(selected_key_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 selected_key_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_key_count property.
This property is read-only.
selected_key_passphrase Property
The key protection password.
Syntax
def get_selected_key_passphrase(selected_key_index: int) -> str: ...
Default Value
""
Remarks
The key protection password.
The selected_key_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_key_count property.
This property is read-only.
selected_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
def get_selected_key_passphrase_valid(selected_key_index: int) -> bool: ...
Default Value
FALSE
Remarks
Use this property to check whether the specified selected_key_passphrase is valid and can be used to unlock the secret key.
The selected_key_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_key_count property.
This property is read-only.
selected_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
def get_selected_key_primary_key_id(selected_key_index: int) -> str: ...
Default Value
""
Remarks
If this key is a subkey (selected_key_is_subkey returns True), this property contains the identifier of the subkey's primary key.
The selected_key_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_key_count property.
This property is read-only.
selected_key_protection Property
Specifies the level of protection applied to the secret key.
Syntax
def get_selected_key_protection(selected_key_index: int) -> int: ...
Possible Values
0 # None
1 # Low
2 # Normal
3 # 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 selected_key_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_key_count property.
This property is read-only.
selected_key_public_key_algorithm Property
Specifies the asymmetric algorithm of the key.
Syntax
def get_selected_key_public_key_algorithm(selected_key_index: int) -> str: ...
Default Value
""
Remarks
Specifies the asymmetric algorithm of the key.
The selected_key_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_key_count property.
This property is read-only.
selected_key_q_bits Property
The length of the DSA Q (legitimate range: 160-512).
Syntax
def get_selected_key_q_bits(selected_key_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 selected_key_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_key_count property.
This property is read-only.
selected_key_timestamp Property
Use this property to check the time the key was generated.
Syntax
def get_selected_key_timestamp(selected_key_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 selected_key_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_key_count property.
This property is read-only.
selected_key_username Property
Specifies the name of the user bound to this key.
Syntax
def get_selected_key_username(selected_key_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 selected_key_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_key_count property.
This property is read-only.
selected_key_valid_to Property
Provide accurate expiration moment indication.
Syntax
def get_selected_key_valid_to(selected_key_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 selected_key_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_key_count property.
This property is read-only.
selected_key_version Property
Indicates the key version.
Syntax
def get_selected_key_version(selected_key_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 selected_key_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_key_count property.
This property is read-only.
config Method
Sets or retrieves a configuration setting.
Syntax
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 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, you must call Config("PROPERTY"). The value will be returned as a string.
do_action Method
Performs an additional action.
Syntax
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
Exports the keyring to a byte array.
Syntax
def export_bytes(secret: bool) -> bytes: ...
Remarks
Use this method to export the keyring to a byte array. PGP software typically uses two files to store keyrings. Use Secret parameter to specify which part of the keyring you would like to export (public or secret).
export_to_file Method
Exports the keyring to disk.
Syntax
def export_to_file(file_name: str, secret: bool) -> None: ...
Remarks
Use this method to export the keyring to disk. PGP software typically uses two files to store keyrings, public and private.
import_bytes Method
Loads a key from a byte array.
Syntax
def import_bytes(keyring: 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
def import_from_file(keyring_file: str) -> None: ...
Remarks
Use this method to load a key, either public or secret, from a file.
import_pinned Method
Imports a pinned secret key to the keyring.
Syntax
def import_pinned() -> None: ...
Remarks
Use this method to import a key provided via pinned_key to the keyring. This can be a public or secret key.
remove Method
Removes the specified key from the keyring.
Syntax
def remove(index: int) -> None: ...
Remarks
Use this method to remove a key from the keyring. Use Index to pass the index of the key to be removed.
remove_by_id Method
Removes key by its ID.
Syntax
def remove_by_id(key_id: str) -> None: ...
Remarks
Call this method to remove the specified key from the keyring.
reset Method
Creates a new empty keyring.
Syntax
def reset() -> None: ...
Remarks
Use this method to initialize a new empty keyring.
select Method
Filters a selection of keys from the keyring using a template.
Syntax
def select(filter: str, secret_only: bool, max_count: int) -> None: ...
Remarks
Use this method to get a list of keys that satisfy the Filter criteria. The filter should follow the "Name=Value" format, where Name can be one of the following:
- userid
- fp or fingerprint
- keyid
Set SecretOnly to True to only search for secret keys. MaxCount allows to limit the number of keys returned.
Once the method completes, the keys that match the criteria will be available in selected_keys property.
update_pinned Method
Update a pinned key in the keyring.
Syntax
def update_pinned() -> None: ...
Remarks
Use this method to update a key provided via pinned_key in the keyring. This can be a public or secret key.
on_error Event
Information about errors during PGP key management.
Syntax
class PGPKeyringErrorEventParams(object): @property def error_code() -> int: ... @property def description() -> str: ... # In class PGPKeyring: @property def on_error() -> Callable[[PGPKeyringErrorEventParams], None]: ... @on_error.setter def on_error(event_hook: Callable[[PGPKeyringErrorEventParams], 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_notification Event
This event notifies the application about an underlying control flow event.
Syntax
class PGPKeyringNotificationEventParams(object): @property def event_id() -> str: ... @property def event_param() -> str: ... # In class PGPKeyring: @property def on_notification() -> Callable[[PGPKeyringNotificationEventParams], None]: ... @on_notification.setter def on_notification(event_hook: Callable[[PGPKeyringNotificationEventParams], 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.
PGPKeyring 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 method.PGPKeyring Config Settings
Adjust this setting to enable or disable ASCII armouring on the outgoing messages.
Use this setting to specify custom ASCII armouring titles that go after the -----BEGIN and -----END tokens.
Use this setting to provide custom ASCII armouring (PEM) headers that should be included in the output.
Switch this setting on to enable long (8-byte/16-char) representation of KeyIDs. The components use the abbreviated 4-byte/8-char representation by default.
Base Config Settings
This is a performance setting. It is unlikely that you will ever need to adjust it.
This is a low-level tweak for certain cryptographic providers. It is unlikely that you will ever need to adjust it.
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.
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 |
Use this property to get cookies from the internal cookie storage of the class and/or restore them back between application sessions.
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.
Use this global setting to adjust the default suffix to assign to top-level domain names. The default is .local.
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.
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".
This global setting controls the hardware cryptography usage policy: auto, enable, or disable.
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.
Set this property to 1.0 or 1.1 to indicate the HTTP version that any internal HTTP clients should use.
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.
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.
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) |
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 |
Use this property to provide a path to the log file.
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 |
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. |
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. |
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.
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) |
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.
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.
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.
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.
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):
PKICache=certificate,crl,ocspThe 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:
PKICachePath=C:\Temp\cacheThis property returns the long version string of the SecureBlackbox library being used (major.minor.build.revision).
Use this property to adjust the length, in bits, of the DHE prime to be used by the TLS server.
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 |
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 devided by the | (pipe) character.
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.
Use this config property to store any custom data.
Use this property to limit the search of chached 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.
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).
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).
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.
Allows to switch between internal/native PRNG implementation and the one provided by the platform.
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).
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.
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.
Set this global property to false to make each validation run use its own copy of system certificate stores.
This is an internal setting. Please do not use it unless instructed by the support team.
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.
Use this global property to enable or disable the use of operating system-driven pseudorandom number generation.
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:
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:
Config("XMLRDNDescriptorName[2.5.4.5]=SERIALNUMBER");Map OID 1.2.840.113549.1.9.1 to E, with aliases EMAIL and EMAILADDRESS:
Config("XMLRDNDescriptorName[1.2.840.113549.1.9.1]=E,EMAIL,EMAILADDRESS");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.
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).
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.
PGPKeyring Errors
PGPKeyring Errors
| 1048577 | Invalid parameter (SB_ERROR_INVALID_PARAMETER) |
| 1048578 | Invalid configuration (SB_ERROR_INVALID_SETUP) |
| 1048579 | Invalid state (SB_ERROR_INVALID_STATE) |
| 1048580 | Invalid value (SB_ERROR_INVALID_VALUE) |
| 1048581 | Private key not found (SB_ERROR_NO_PRIVATE_KEY) |
| 1048582 | Cancelled by the user (SB_ERROR_CANCELLED_BY_USER) |
| 1048583 | The file was not found (SB_ERROR_NO_SUCH_FILE) |
| 1048584 | Unsupported feature or operation (SB_ERROR_UNSUPPORTED_FEATURE) |
| 1048585 | General error (SB_ERROR_GENERAL_ERROR) |
| 27262977 | The file was not found (SB_ERROR_PGP_FILE_NOT_EXISTS) |
| 27262978 | Invalid signing key (SB_ERROR_PGP_INVALID_KEY) |
| 27262980 | No secret key is available (SB_ERROR_PGP_NO_SECRET_KEY) |
| 27262982 | The operation is not supported on a subkey (SB_ERROR_PGP_OPERATION_ON_SUBKEY) |