PGPReader Class

Properties   Methods   Events   Config Settings   Errors  

The PGPReader class reads and unprotects protected PGP files.

Syntax

class secureblackbox.PGPReader

Remarks

PGPReader allows you to parse PGP messages and manipulate PGP-secured data. It decrypts the protected data, decompresses it, verifies signatures, and returns "clear" data.

Property List


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

armoredIndicates if the processed message had been base64-armored.
compressedIndicates if the processed message had been compressed.
data_bytesUse this property to pass the original signed data to class in the byte array form.
data_fileThe name of the file containing the original signed data.
decrypting_key_countThe number of records in the DecryptingKey arrays.
decrypting_key_handleAllows to get or set a 'handle', a unique identifier of the underlying property object.
decrypting_key_key_fpThe 20-byte fingerprint (hash value) of this key.
decrypting_key_key_idContains a 8-byte key identifier.
decrypting_key_passphraseThe key protection password.
decrypting_key_passphrase_validUse this property to check whether the specified Passphrase is valid and can be used to unlock the secret key.
decrypting_key_usernameSpecifies the name of the user bound to this key.
external_crypto_async_document_idSpecifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.
external_crypto_custom_paramsCustom parameters to be passed to the signing service (uninterpreted).
external_crypto_dataAdditional data to be included in the async state and mirrored back by the requestor.
external_crypto_external_hash_calculationSpecifies whether the message hash is to be calculated at the external endpoint.
external_crypto_hash_algorithmSpecifies the request's signature hash algorithm.
external_crypto_key_idThe ID of the pre-shared key used for DC request authentication.
external_crypto_key_secretThe pre-shared key used for DC request authentication.
external_crypto_methodSpecifies the asynchronous signing method.
external_crypto_modeSpecifies the external cryptography mode.
external_crypto_public_key_algorithmProvide the public key algorithm here if the certificate is not available on the pre-signing stage.
fips_modeReserved.
input_bytesUse this property to pass the input to class in byte array form.
input_fileProvides a filename of a file to process.
key_passphraseSpecifies a passphrase for the decryption key.
output_bytesUse this property to read the output the class object has produced.
output_fileThe file where the encrypted and/or signed data will be saved.
passphraseSpecifies a message decryption password.
processed_lengthReports the number of bytes processed.
profileSpecifies a pre-defined profile to apply when creating the signature.
signature_countThe number of records in the Signature arrays.
signature_certification_typeSpecifies the type of a UserID signature.
signature_creation_timeThe time when the signature was created, in Universal Coordinated Time (UTC).
signature_expiration_timeSpecifies signature expiration time, in seconds since its creation time (CreationTime).
signature_exportableSpecifies whether a certification signature is "exportable", meaning it can be used by entities other than the signature's issuer.
signature_handleAllows to get or set a 'handle', a unique identifier of the underlying property object.
signature_hash_algorithmSpecifies the hash algorithm used in the signature.
signature_hash_markReturns the hash mark attribute of a signature.
signature_key_expiration_timeThe number of seconds after which the signed key will expire.
signature_key_flagsReturns the key flags included in the signature.
signature_legacy_formatIndicates whether signature uses PGP 2.
signature_policy_urlContains the URL of the signature policy.
signature_preferred_algorithmsContains a list of algorithms preferred by the signed key holder.
signature_primary_user_idIndicates whether the UserID covered by the signature is the main user id for this key.
signature_reason_for_revocationDescribes the reason why the key or the certificate was revoked.
signature_revocableSpecifies whether the signature can be revoked.
signature_revocationIndicates whether or not the signature is a revocation signature.
signature_signature_classIndicates the signature class.
signature_signer_key_idIndicates the KeyID of the signing key.
signature_signer_user_idIndicates the UserID associated with the signing key.
signature_strictly_validReturns True if this signature is valid in a strict way (no compatibility relaxations).
signature_targetIndicates the KeyID or Username of the target key or user.
signature_text_signatureIndicates whether or not the signature is made over a text document.
signature_trust_amountSpecifies the amount of trust assigned by this signature.
signature_trust_levelThe trust level assigned by this signature.
signature_validatedWhether the signature has been validated.
signature_validityProvides the validity status of the signature if the signature has been validated.
signature_versionIndicates the signature version.
verifying_key_countThe number of records in the VerifyingKey arrays.
verifying_key_handleAllows to get or set a 'handle', a unique identifier of the underlying property object.
verifying_key_key_fpThe 20-byte fingerprint (hash value) of this key.
verifying_key_key_idContains a 8-byte key identifier.
verifying_key_usernameSpecifies the name of the user bound to this key.

Method List


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

configSets or retrieves a configuration setting.
decrypt_and_verifyDecrypts and verifies a protected message.
do_actionPerforms an additional action.
resetResets the class settings.
verify_detachedVerifies a detached 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_encryption_infoReports early information on encryption parameters.
on_errorInformation about errors during PGP decryption/verification.
on_external_decryptHandles remote or external decryption.
on_file_extraction_finishReports the ending of file extraction process.
on_file_extraction_startReports the beginning of file extraction process.
on_key_passphrase_neededRequests a key protection password from the application.
on_multiple_files_foundFires if the PGP message is recognized to contain multiple files.
on_notificationThis event notifies the application about an underlying control flow event.
on_passphrase_neededRequests a data protection password from the application.
on_progressReports the progress of the decryption operation.
on_signedNotifies the application about a signed message.

Config Settings


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

IgnoreDataPacketLengthsWhether to check the length of input data packets.
PasswordAttemptsThe number of attempts allowed for entering password.
TempPathPath for storing temporary files.
UndefInputLengthSet this property if you are working with non-seekable streams.
UseGreedyMemoryConsumptionWhether to limit memory consumption for the cost of speed.
ASN1UseGlobalTagCacheControls whether ASN.1 module should use a global object cache.
AssignSystemSmartCardPinsSpecifies whether CSP-level PINs should be assigned to CNG keys.
CheckKeyIntegrityBeforeUseEnables or disable private key integrity check before use.
CookieCachingSpecifies whether a cookie cache should be used for HTTP(S) transports.
CookiesGets or sets local cookies for the class.
DefDeriveKeyIterationsSpecifies the default key derivation algorithm iteration count.
DNSLocalSuffixThe suffix to assign for TLD names.
EnableClientSideSSLFFDHEEnables or disables finite field DHE key exchange support in TLS clients.
GlobalCookiesGets or sets global cookies for all the HTTP transports.
HardwareCryptoUsePolicyThe hardware crypto usage policy.
HttpUserAgentSpecifies the user agent name to be used by all HTTP clients.
HttpVersionThe HTTP version to use in any inner HTTP client classes created.
IgnoreExpiredMSCTLSigningCertWhether to tolerate the expired Windows Update signing certificate.
ListDelimiterThe delimiter character for multi-element lists.
LogDestinationSpecifies the debug log destination.
LogDetailsSpecifies the debug log details to dump.
LogFileSpecifies the debug log filename.
LogFiltersSpecifies the debug log filters.
LogFlushModeSpecifies the log flush mode.
LogLevelSpecifies the debug log level.
LogMaxEventCountSpecifies the maximum number of events to cache before further action is taken.
LogRotationModeSpecifies the log rotation mode.
MaxASN1BufferLengthSpecifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepthSpecifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithmSpecifies the hash algorithm to be used to identify certificates in OCSP requests.
OldClientSideRSAFallbackSpecifies whether the SSH client should use a SHA1 fallback.
ProductVersionReturns the version of the SecureBlackbox library.
ServerSSLDHKeyLengthSets the size of the TLS DHE key exchange group.
StaticDNSSpecifies whether static DNS rules should be used.
StaticIPAddress[domain]Gets or sets an IP address for the specified domain name.
StaticIPAddressesGets or sets all the static DNS rules.
TagAllows to store any custom data.
TLSSessionGroupSpecifies the group name of TLS sessions to be used for session resumption.
TLSSessionLifetimeSpecifies lifetime in seconds of the cached TLS session.
TLSSessionPurgeIntervalSpecifies how often the session cache should remove the expired TLS sessions.
UseInternalRandomSwitches between SecureBlackbox-own and platform PRNGs.
UseLegacyAdESValidationEnables legacy AdES validation mode.
UseOwnDNSResolverSpecifies whether the client classes should use own DNS resolver.
UseSharedSystemStoragesSpecifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemNativeSizeCalculationAn internal CryptoAPI access tweak.
UseSystemOAEPAndPSSEnforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandomEnables or disables the use of the OS PRNG.

armored Property

Indicates if the processed message had been base64-armored.

Syntax

def get_armored() -> bool: ...

armored = property(get_armored, None)

Default Value

FALSE

Remarks

This property is set to true if the supplied message was armored by encoding it into base64 and adding BEGIN and END brackets.

This property is read-only.

compressed Property

Indicates if the processed message had been compressed.

Syntax

def get_compressed() -> bool: ...

compressed = property(get_compressed, None)

Default Value

FALSE

Remarks

This property is set to true if the supplied message was compressed by its creator.

This property is read-only.

data_bytes Property

Use this property to pass the original signed data to class in the byte array form.

Syntax

def get_data_bytes() -> bytes: ...
def set_data_bytes(value: bytes) -> None: ...

data_bytes = property(get_data_bytes, set_data_bytes)

Remarks

When validating detached signatures, assign a byte array containing the signed data to this property.

data_file Property

The name of the file containing the original signed data.

Syntax

def get_data_file() -> str: ...
def set_data_file(value: str) -> None: ...

data_file = property(get_data_file, set_data_file)

Default Value

""

Remarks

Use this property to provide the original data when validating detached signatures with verify_detached.

decrypting_key_count Property

The number of records in the DecryptingKey arrays.

Syntax

def get_decrypting_key_count() -> int: ...
def set_decrypting_key_count(value: int) -> None: ...

decrypting_key_count = property(get_decrypting_key_count, set_decrypting_key_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

The array indices start at 0 and end at decrypting_key_count - 1.

decrypting_key_handle Property

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

def get_decrypting_key_handle(decrypting_key_index: int) -> int: ...
def set_decrypting_key_handle(decrypting_key_index: int, value: int) -> None: ...

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 decrypting_key_index parameter specifies the index of the item in the array. The size of the array is controlled by the decrypting_key_count property.

decrypting_key_key_fp Property

The 20-byte fingerprint (hash value) of this key.

Syntax

def get_decrypting_key_key_fp(decrypting_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 decrypting_key_index parameter specifies the index of the item in the array. The size of the array is controlled by the decrypting_key_count property.

This property is read-only.

decrypting_key_key_id Property

Contains a 8-byte key identifier.

Syntax

def get_decrypting_key_key_id(decrypting_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 decrypting_key_index parameter specifies the index of the item in the array. The size of the array is controlled by the decrypting_key_count property.

This property is read-only.

decrypting_key_passphrase Property

The key protection password.

Syntax

def get_decrypting_key_passphrase(decrypting_key_index: int) -> str: ...
def set_decrypting_key_passphrase(decrypting_key_index: int, value: str) -> None: ...

Default Value

""

Remarks

The key protection password.

The decrypting_key_index parameter specifies the index of the item in the array. The size of the array is controlled by the decrypting_key_count property.

decrypting_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_decrypting_key_passphrase_valid(decrypting_key_index: int) -> bool: ...

Default Value

FALSE

Remarks

Use this property to check whether the specified decrypting_key_passphrase is valid and can be used to unlock the secret key.

The decrypting_key_index parameter specifies the index of the item in the array. The size of the array is controlled by the decrypting_key_count property.

This property is read-only.

decrypting_key_username Property

Specifies the name of the user bound to this key.

Syntax

def get_decrypting_key_username(decrypting_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 decrypting_key_index parameter specifies the index of the item in the array. The size of the array is controlled by the decrypting_key_count property.

This property is read-only.

external_crypto_async_document_id Property

Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.

Syntax

def get_external_crypto_async_document_id() -> str: ...
def set_external_crypto_async_document_id(value: str) -> None: ...

external_crypto_async_document_id = property(get_external_crypto_async_document_id, set_external_crypto_async_document_id)

Default Value

""

Remarks

Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.

Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. On the completion stage, this value helps the signing component identify the correct signature in the returned batch of responses.

If using batched requests, make sure to set this property to the same value on both the pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages.

external_crypto_custom_params Property

Custom parameters to be passed to the signing service (uninterpreted).

Syntax

def get_external_crypto_custom_params() -> str: ...
def set_external_crypto_custom_params(value: str) -> None: ...

external_crypto_custom_params = property(get_external_crypto_custom_params, set_external_crypto_custom_params)

Default Value

""

Remarks

Custom parameters to be passed to the signing service (uninterpreted).

external_crypto_data Property

Additional data to be included in the async state and mirrored back by the requestor.

Syntax

def get_external_crypto_data() -> str: ...
def set_external_crypto_data(value: str) -> None: ...

external_crypto_data = property(get_external_crypto_data, set_external_crypto_data)

Default Value

""

Remarks

Additional data to be included in the async state and mirrored back by the requestor.

external_crypto_external_hash_calculation Property

Specifies whether the message hash is to be calculated at the external endpoint.

Syntax

def get_external_crypto_external_hash_calculation() -> bool: ...
def set_external_crypto_external_hash_calculation(value: bool) -> None: ...

external_crypto_external_hash_calculation = property(get_external_crypto_external_hash_calculation, set_external_crypto_external_hash_calculation)

Default Value

FALSE

Remarks

Specifies whether the message hash is to be calculated at the external endpoint. Please note that this mode is not supported by the DCAuth class.

If set to true, the class will pass a few kilobytes of to-be-signed data from the document to the OnExternalSign event. This only applies when SignExternal() is called.

external_crypto_hash_algorithm Property

Specifies the request's signature hash algorithm.

Syntax

def get_external_crypto_hash_algorithm() -> str: ...
def set_external_crypto_hash_algorithm(value: str) -> None: ...

external_crypto_hash_algorithm = property(get_external_crypto_hash_algorithm, set_external_crypto_hash_algorithm)

Default Value

"SHA256"

Remarks

Specifies the request's signature hash algorithm.

SB_HASH_ALGORITHM_SHA1SHA1
SB_HASH_ALGORITHM_SHA224SHA224
SB_HASH_ALGORITHM_SHA256SHA256
SB_HASH_ALGORITHM_SHA384SHA384
SB_HASH_ALGORITHM_SHA512SHA512
SB_HASH_ALGORITHM_MD2MD2
SB_HASH_ALGORITHM_MD4MD4
SB_HASH_ALGORITHM_MD5MD5
SB_HASH_ALGORITHM_RIPEMD160RIPEMD160
SB_HASH_ALGORITHM_CRC32CRC32
SB_HASH_ALGORITHM_SSL3SSL3
SB_HASH_ALGORITHM_GOST_R3411_1994GOST1994
SB_HASH_ALGORITHM_WHIRLPOOLWHIRLPOOL
SB_HASH_ALGORITHM_POLY1305POLY1305
SB_HASH_ALGORITHM_SHA3_224SHA3_224
SB_HASH_ALGORITHM_SHA3_256SHA3_256
SB_HASH_ALGORITHM_SHA3_384SHA3_384
SB_HASH_ALGORITHM_SHA3_512SHA3_512
SB_HASH_ALGORITHM_BLAKE2S_128BLAKE2S_128
SB_HASH_ALGORITHM_BLAKE2S_160BLAKE2S_160
SB_HASH_ALGORITHM_BLAKE2S_224BLAKE2S_224
SB_HASH_ALGORITHM_BLAKE2S_256BLAKE2S_256
SB_HASH_ALGORITHM_BLAKE2B_160BLAKE2B_160
SB_HASH_ALGORITHM_BLAKE2B_256BLAKE2B_256
SB_HASH_ALGORITHM_BLAKE2B_384BLAKE2B_384
SB_HASH_ALGORITHM_BLAKE2B_512BLAKE2B_512
SB_HASH_ALGORITHM_SHAKE_128SHAKE_128
SB_HASH_ALGORITHM_SHAKE_256SHAKE_256
SB_HASH_ALGORITHM_SHAKE_128_LENSHAKE_128_LEN
SB_HASH_ALGORITHM_SHAKE_256_LENSHAKE_256_LEN

external_crypto_key_id Property

The ID of the pre-shared key used for DC request authentication.

Syntax

def get_external_crypto_key_id() -> str: ...
def set_external_crypto_key_id(value: str) -> None: ...

external_crypto_key_id = property(get_external_crypto_key_id, set_external_crypto_key_id)

Default Value

""

Remarks

The ID of the pre-shared key used for DC request authentication.

Asynchronous DCAuth-driven communication requires that parties authenticate each other with a secret pre-shared cryptographic key. This provides an extra protection layer for the protocol and diminishes the risk of the private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use external_crypto_key_secret to pass the key itself.

The same KeyID/KeySecret pair should be used on the DCAuth side for the signing requests to be accepted.

Note: The KeyID/KeySecret scheme is very similar to the AuthKey scheme used in various Cloud service providers to authenticate users.

Example: signer.ExternalCrypto.KeyID = "MainSigningKey"; signer.ExternalCrypto.KeySecret = "abcdef0123456789";

external_crypto_key_secret Property

The pre-shared key used for DC request authentication.

Syntax

def get_external_crypto_key_secret() -> str: ...
def set_external_crypto_key_secret(value: str) -> None: ...

external_crypto_key_secret = property(get_external_crypto_key_secret, set_external_crypto_key_secret)

Default Value

""

Remarks

The pre-shared key used for DC request authentication. This key must be set and match the key used by the DCAuth counterpart for the scheme to work.

Read more about configuring authentication in the external_crypto_key_id topic.

external_crypto_method Property

Specifies the asynchronous signing method.

Syntax

def get_external_crypto_method() -> int: ...
def set_external_crypto_method(value: int) -> None: ...

external_crypto_method = property(get_external_crypto_method, set_external_crypto_method)

Default Value

0

Remarks

Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup.

Available options:

asmdPKCS10
asmdPKCS71

external_crypto_mode Property

Specifies the external cryptography mode.

Syntax

def get_external_crypto_mode() -> int: ...
def set_external_crypto_mode(value: int) -> None: ...

external_crypto_mode = property(get_external_crypto_mode, set_external_crypto_mode)

Default Value

0

Remarks

Specifies the external cryptography mode.

Available options:

ecmDefaultThe default value (0)
ecmDisabledDo not use DC or external signing (1)
ecmGenericGeneric external signing with the OnExternalSign event (2)
ecmDCAuthDCAuth signing (3)
ecmDCAuthJSONDCAuth signing in JSON format (4)

external_crypto_public_key_algorithm Property

Provide the public key algorithm here if the certificate is not available on the pre-signing stage.

Syntax

def get_external_crypto_public_key_algorithm() -> str: ...
def set_external_crypto_public_key_algorithm(value: str) -> None: ...

external_crypto_public_key_algorithm = property(get_external_crypto_public_key_algorithm, set_external_crypto_public_key_algorithm)

Default Value

""

Remarks

Provide the public key algorithm here if the certificate is not available on the pre-signing stage.

SB_CERT_ALGORITHM_ID_RSA_ENCRYPTIONrsaEncryption
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTIONmd2withRSAEncryption
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTIONmd5withRSAEncryption
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTIONsha1withRSAEncryption
SB_CERT_ALGORITHM_ID_DSAid-dsa
SB_CERT_ALGORITHM_ID_DSA_SHA1id-dsa-with-sha1
SB_CERT_ALGORITHM_DH_PUBLICdhpublicnumber
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTIONsha224WithRSAEncryption
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTIONsha256WithRSAEncryption
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTIONsha384WithRSAEncryption
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTIONsha512WithRSAEncryption
SB_CERT_ALGORITHM_ID_RSAPSSid-RSASSA-PSS
SB_CERT_ALGORITHM_ID_RSAOAEPid-RSAES-OAEP
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160ripemd160withRSA
SB_CERT_ALGORITHM_ID_ELGAMALelGamal
SB_CERT_ALGORITHM_SHA1_ECDSAecdsa-with-SHA1
SB_CERT_ALGORITHM_RECOMMENDED_ECDSAecdsa-recommended
SB_CERT_ALGORITHM_SHA224_ECDSAecdsa-with-SHA224
SB_CERT_ALGORITHM_SHA256_ECDSAecdsa-with-SHA256
SB_CERT_ALGORITHM_SHA384_ECDSAecdsa-with-SHA384
SB_CERT_ALGORITHM_SHA512_ECDSAecdsa-with-SHA512
SB_CERT_ALGORITHM_ECid-ecPublicKey
SB_CERT_ALGORITHM_SPECIFIED_ECDSAecdsa-specified
SB_CERT_ALGORITHM_GOST_R3410_1994id-GostR3410-94
SB_CERT_ALGORITHM_GOST_R3410_2001id-GostR3410-2001
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994id-GostR3411-94-with-GostR3410-94
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001id-GostR3411-94-with-GostR3410-2001
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAINecdsa-plain-SHA1
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAINecdsa-plain-SHA224
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAINecdsa-plain-SHA256
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAINecdsa-plain-SHA384
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAINecdsa-plain-SHA512
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAINecdsa-plain-RIPEMD160
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTIONwhirlpoolWithRSAEncryption
SB_CERT_ALGORITHM_ID_DSA_SHA224id-dsa-with-sha224
SB_CERT_ALGORITHM_ID_DSA_SHA256id-dsa-with-sha256
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-512
SB_CERT_ALGORITHM_SHA3_224_ECDSAid-ecdsa-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_ECDSAid-ecdsa-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_ECDSAid-ecdsa-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_ECDSAid-ecdsa-with-sha3-512
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAINid-ecdsa-plain-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAINid-ecdsa-plain-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAINid-ecdsa-plain-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAINid-ecdsa-plain-with-sha3-512
SB_CERT_ALGORITHM_ID_DSA_SHA3_224id-dsa-with-sha3-224
SB_CERT_ALGORITHM_ID_DSA_SHA3_256id-dsa-with-sha3-256
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b512
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSAid-ecdsa-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSAid-ecdsa-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSAid-ecdsa-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSAid-ecdsa-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSAid-ecdsa-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSAid-ecdsa-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSAid-ecdsa-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSAid-ecdsa-with-blake2b512
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAINid-ecdsa-plain-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAINid-ecdsa-plain-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAINid-ecdsa-plain-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAINid-ecdsa-plain-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAINid-ecdsa-plain-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAINid-ecdsa-plain-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAINid-ecdsa-plain-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAINid-ecdsa-plain-with-blake2b512
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224id-dsa-with-blake2s224
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256id-dsa-with-blake2s256
SB_CERT_ALGORITHM_EDDSA_ED25519id-Ed25519
SB_CERT_ALGORITHM_EDDSA_ED448id-Ed448
SB_CERT_ALGORITHM_EDDSA_ED25519_PHid-Ed25519ph
SB_CERT_ALGORITHM_EDDSA_ED448_PHid-Ed448ph
SB_CERT_ALGORITHM_EDDSAid-EdDSA
SB_CERT_ALGORITHM_EDDSA_SIGNATUREid-EdDSA-sig

fips_mode Property

Reserved.

Syntax

def get_fips_mode() -> bool: ...
def set_fips_mode(value: bool) -> None: ...

fips_mode = property(get_fips_mode, set_fips_mode)

Default Value

FALSE

Remarks

This property is reserved for future use.

input_bytes Property

Use this property to pass the input to class in byte array form.

Syntax

def get_input_bytes() -> bytes: ...
def set_input_bytes(value: bytes) -> None: ...

input_bytes = property(get_input_bytes, set_input_bytes)

Remarks

Assign a byte array containing the data to be processed to this property.

input_file Property

Provides a filename of a file to process.

Syntax

def get_input_file() -> str: ...
def set_input_file(value: str) -> None: ...

input_file = property(get_input_file, set_input_file)

Default Value

""

Remarks

Use this property to provide a path to the file to be encrypted and/or signed.

key_passphrase Property

Specifies a passphrase for the decryption key.

Syntax

def get_key_passphrase() -> str: ...
def set_key_passphrase(value: str) -> None: ...

key_passphrase = property(get_key_passphrase, set_key_passphrase)

Default Value

""

Remarks

Use this property to provide a passphrase for the decryption secret key.

If this property is left empty or a wrong passphrase is provided, the on_key_passphrase_needed event will be fired to request the correct passphrase.

output_bytes Property

Use this property to read the output the class object has produced.

Syntax

def get_output_bytes() -> bytes: ...

output_bytes = property(get_output_bytes, None)

Remarks

Read the contents of this property after the operation has completed to read the produced output. This property will only be set if the output_file and output_stream properties had not been assigned.

This property is read-only.

output_file Property

The file where the encrypted and/or signed data will be saved.

Syntax

def get_output_file() -> str: ...
def set_output_file(value: str) -> None: ...

output_file = property(get_output_file, set_output_file)

Default Value

""

Remarks

Use this property to provide a path to the file where the class should store the encrypted and/or signed data.

passphrase Property

Specifies a message decryption password.

Syntax

def get_passphrase() -> str: ...
def set_passphrase(value: str) -> None: ...

passphrase = property(get_passphrase, set_passphrase)

Default Value

""

Remarks

Use this property to provide a password to decrypt the data. Whether the message can be decrypted with a password is indicated by PassphraseUsed parameter of on_encryption_info event.

Note that this is not the same as a secret key passphrase, which should be provided via key_passphrase property.

If this property is left empty or the assigned passphrase is incorrect, the on_passphrase_needed event will be fired to request the correct one.

processed_length Property

Reports the number of bytes processed.

Syntax

def get_processed_length() -> int: ...

processed_length = property(get_processed_length, None)

Default Value

0

Remarks

Use this property to check the number of bytes that the component has read when processing the protected message.

This property is read-only.

profile Property

Specifies a pre-defined profile to apply when creating the signature.

Syntax

def get_profile() -> str: ...
def set_profile(value: str) -> None: ...

profile = property(get_profile, set_profile)

Default Value

""

Remarks

Advanced signatures come in many variants, which are often defined by parties that needs to process them or by local standards. SecureBlackbox profiles are sets of pre-defined configurations which correspond to particular signature variants. By specifying a profile, you are pre-configuring the component to make it produce the signature that matches the configuration corresponding to that profile.

signature_count Property

The number of records in the Signature arrays.

Syntax

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:

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

def get_signature_certification_type(signature_index: int) -> int: ...

Default Value

0

Remarks

Specifies the type of a UserID signature.

pctGeneric0Generic 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.
pctPersona1Persona 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.
pctCasual2Casual 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.
pctPositive3Positive 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 property.

This property is read-only.

signature_creation_time Property

The time when the signature was created, in Universal Coordinated Time (UTC).

Syntax

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 property.

This property is read-only.

signature_expiration_time Property

Specifies signature expiration time, in seconds since its creation time (CreationTime).

Syntax

def get_signature_expiration_time(signature_index: int) -> int: ...

Default Value

0

Remarks

Specifies signature expiration time, in seconds since its creation time (CreationTime).

Ths 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 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

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 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

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. 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 property.

This property is read-only.

signature_hash_algorithm Property

Specifies the hash algorithm used in the signature.

Syntax

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 property.

This property is read-only.

signature_hash_mark Property

Returns the hash mark attribute of a signature.

Syntax

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 property.

This property is read-only.

signature_key_expiration_time Property

The number of seconds after which the signed key will expire.

Syntax

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 property.

This property is read-only.

signature_key_flags Property

Returns the key flags included in the signature.

Syntax

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 property.

This property is read-only.

signature_legacy_format Property

Indicates whether signature uses PGP 2.

Syntax

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 property.

This property is read-only.

signature_policy_url Property

Contains the URL of the signature policy.

Syntax

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 property.

This property is read-only.

signature_preferred_algorithms Property

Contains a list of algorithms preferred by the signed key holder.

Syntax

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 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

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 property.

This property is read-only.

signature_reason_for_revocation Property

Describes the reason why the key or the certificate was revoked.

Syntax

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 property.

This property is read-only.

signature_revocable Property

Specifies whether the signature can be revoked.

Syntax

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 property.

This property is read-only.

signature_revocation Property

Indicates whether or not the signature is a revocation signature.

Syntax

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 property.

This property is read-only.

signature_signature_class Property

Indicates the signature class.

Syntax

def get_signature_signature_class(signature_index: int) -> int: ...

Default Value

0

Remarks

Indicates the signature class.

pscDocument0Signature over binary file
pscTextDocument1Signature over text
pscStandalone2A standalone signature
pscUIDGeneric3User certification signature
pscUIDPersona4User certification signature (persona)
pscUIDCasual5User certification signature (casual)
pscUIDPositive6User certification signature (positive)
pscSubkeyBinding7Subkey binding signature
pscPrimaryKeyBinding8Primary key binding signature
pscDirectKey9Direct signature over a public key
pscKeyRevocation10Key revocation
pscSubkeyRevocation11Subkey revocation
pscCertRevocation12User revocation
pscTimestamp13Timestamp signature
pscThirdParty14Third-party signature
pscNotSpecified15Signature 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 property.

This property is read-only.

signature_signer_key_id Property

Indicates the KeyID of the signing key.

Syntax

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 property.

This property is read-only.

signature_signer_user_id Property

Indicates the UserID associated with the signing key.

Syntax

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 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

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 property.

This property is read-only.

signature_target Property

Indicates the KeyID or Username of the target key or user.

Syntax

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 property.

This property is read-only.

signature_text_signature Property

Indicates whether or not the signature is made over a text document.

Syntax

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 property.

This property is read-only.

signature_trust_amount Property

Specifies the amount of trust assigned by this signature.

Syntax

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 property.

This property is read-only.

signature_trust_level Property

The trust level assigned by this signature.

Syntax

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 property.

This property is read-only.

signature_validated Property

Whether the signature has been validated.

Syntax

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 property.

This property is read-only.

signature_validity Property

Provides the validity status of the signature if the signature has been validated.

Syntax

def get_signature_validity(signature_index: int) -> int: ...

Default Value

0

Remarks

Provides the validity status of the signature if the signature has been validated.

svtValid0The signature is valid

svtUnknown1Signature validity is unknown

svtCorrupted2The signature is corrupted

svtSignerNotFound3Failed to acquire the signing certificate. The signature cannot be validated.

svtFailure4General failure

svtReferenceCorrupted5Reference 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 property.

This property is read-only.

signature_version Property

Indicates the signature version.

Syntax

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 property.

This property is read-only.

verifying_key_count Property

The number of records in the VerifyingKey arrays.

Syntax

def get_verifying_key_count() -> int: ...
def set_verifying_key_count(value: int) -> None: ...

verifying_key_count = property(get_verifying_key_count, set_verifying_key_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

The array indices start at 0 and end at verifying_key_count - 1.

verifying_key_handle Property

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

def get_verifying_key_handle(verifying_key_index: int) -> int: ...
def set_verifying_key_handle(verifying_key_index: int, value: int) -> None: ...

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 verifying_key_index parameter specifies the index of the item in the array. The size of the array is controlled by the verifying_key_count property.

verifying_key_key_fp Property

The 20-byte fingerprint (hash value) of this key.

Syntax

def get_verifying_key_key_fp(verifying_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 verifying_key_index parameter specifies the index of the item in the array. The size of the array is controlled by the verifying_key_count property.

This property is read-only.

verifying_key_key_id Property

Contains a 8-byte key identifier.

Syntax

def get_verifying_key_key_id(verifying_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 verifying_key_index parameter specifies the index of the item in the array. The size of the array is controlled by the verifying_key_count property.

This property is read-only.

verifying_key_username Property

Specifies the name of the user bound to this key.

Syntax

def get_verifying_key_username(verifying_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 verifying_key_index parameter specifies the index of the item in the array. The size of the array is controlled by the verifying_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.

decrypt_and_verify Method

Decrypts and verifies a protected message.

Syntax

def decrypt_and_verify() -> None: ...

Remarks

Use this method to unprotect a PGP message contained in a byte array (input_bytes), in a file (input_file) or in a stream (input_stream). The method writes the decrypted message to a byte array (output_bytes), to a file (output_file) or to a stream (output_stream).

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;....

reset Method

Resets the class settings.

Syntax

def reset() -> None: ...

Remarks

reset is a generic method available in every class.

verify_detached Method

Verifies a detached signature.

Syntax

def verify_detached() -> None: ...

Remarks

Use this method to verify a detached signature contained in a byte array (data_bytes), in a file (data_file) or in a stream (data_stream) over a message contained in a byte array (input_bytes), in a file (input_file) or in a stream (input_stream).

on_encryption_info Event

Reports early information on encryption parameters.

Syntax

class PGPReaderEncryptionInfoEventParams(object):
  @property
  def key_i_ds() -> str: ...

  @property
  def encrypted_protection() -> int: ...

  @property
  def passphrase_used() -> bool: ...

# In class PGPReader:
@property
def on_encryption_info() -> Callable[[PGPReaderEncryptionInfoEventParams], None]: ...
@on_encryption_info.setter
def on_encryption_info(event_hook: Callable[[PGPReaderEncryptionInfoEventParams], None]) -> None: ...

Remarks

The class fires this event to report early encryption information. Use this event to find out what encryption type is used, and to provide appropriate decryption material (the secret keys or the password) via decrypting_keys or passphrase properties.

KeyIDs contains the IDs of the keys that can be used to decrypt the data. PassphraseUsed shows if the message can also be decrypted with a passphrase. Both can be set at the same time, indicating that each of the decryption routes can be taken.

EncryptedProtection parameter specifies whether the message includes a modification detection record.

on_error Event

Information about errors during PGP decryption/verification.

Syntax

class PGPReaderErrorEventParams(object):
  @property
  def error_code() -> int: ...

  @property
  def description() -> str: ...

# In class PGPReader:
@property
def on_error() -> Callable[[PGPReaderErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[PGPReaderErrorEventParams], None]) -> None: ...

Remarks

The event is fired in case of exceptional conditions during decryption/verification of protected data.

ErrorCode contains an error code and Description contains a textual description of the error.

on_external_decrypt Event

Handles remote or external decryption.

Syntax

class PGPReaderExternalDecryptEventParams(object):
  @property
  def operation_id() -> str: ...

  @property
  def algorithm() -> str: ...

  @property
  def pars() -> str: ...

  @property
  def encrypted_data() -> str: ...

  @property
  def data() -> str: ...
  @data.setter
  def data(value) -> None: ...

# In class PGPReader:
@property
def on_external_decrypt() -> Callable[[PGPReaderExternalDecryptEventParams], None]: ...
@on_external_decrypt.setter
def on_external_decrypt(event_hook: Callable[[PGPReaderExternalDecryptEventParams], None]) -> None: ...

Remarks

Assign a handler to this event if you need to delegate a low-level decryption operation to an external, remote, or custom decryption engine. The handler receives an encrypted value in the EncryptedData parameter, and is expected to decrypt it and place the decrypted value into the Data parameter.

OperationId provides a comment about the operation and its origin. It depends on the exact class being used, and may be empty. Algorithm specifies the encryption algorithm being used, and Pars contains algorithm-dependent parameters.

The class uses base16 (hex) encoding for the EncryptedData, Data, and Pars parameters. If your decryption engine uses a different input and output encoding, you may need to decode and/or encode the data before and/or after the decryption.

Sample data encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16

on_file_extraction_finish Event

Reports the ending of file extraction process.

Syntax

class PGPReaderFileExtractionFinishEventParams(object):
  @property
  def file_name() -> str: ...

  @property
  def timestamp() -> str: ...

# In class PGPReader:
@property
def on_file_extraction_finish() -> Callable[[PGPReaderFileExtractionFinishEventParams], None]: ...
@on_file_extraction_finish.setter
def on_file_extraction_finish(event_hook: Callable[[PGPReaderFileExtractionFinishEventParams], None]) -> None: ...

Remarks

This event informs about the ending of extraction of the next available file. FileName parameter indicates the original file name, and the Timestamp its last modification time.

In the handler, the user can take away the output stream or store the file data from output_bytes.

on_file_extraction_start Event

Reports the beginning of file extraction process.

Syntax

class PGPReaderFileExtractionStartEventParams(object):
  @property
  def file_name() -> str: ...

  @property
  def timestamp() -> str: ...

  @property
  def skip() -> bool: ...
  @skip.setter
  def skip(value) -> None: ...

# In class PGPReader:
@property
def on_file_extraction_start() -> Callable[[PGPReaderFileExtractionStartEventParams], None]: ...
@on_file_extraction_start.setter
def on_file_extraction_start(event_hook: Callable[[PGPReaderFileExtractionStartEventParams], None]) -> None: ...

Remarks

This event informs about the beginning of extraction of the next available file. A PGP message may contain more than one file. FileName parameter indicates the original file name, and the Timestamp its last modification time.

The user should provide an output filename in output_file or a stream in output_stream. If none of them is provided, the extracted file will be placed to output_bytes. After the file is extracted, on_file_extraction_finish event is fired.

on_key_passphrase_needed Event

Requests a key protection password from the application.

Syntax

class PGPReaderKeyPassphraseNeededEventParams(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 PGPReader:
@property
def on_key_passphrase_needed() -> Callable[[PGPReaderKeyPassphraseNeededEventParams], None]: ...
@on_key_passphrase_needed.setter
def on_key_passphrase_needed(event_hook: Callable[[PGPReaderKeyPassphraseNeededEventParams], 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 (which is requested via on_passphrase_needed). The class fires it when it has found a suitable decryption secret key in the keyring, and attempts to use it to decrypt the data.

If the data is encrypted with multiple keys, this event is called for each key in a loop until the password for at least one key is provided correctly. 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_multiple_files_found Event

Fires if the PGP message is recognized to contain multiple files.

Syntax

class PGPReaderMultipleFilesFoundEventParams(object):
  @property
  def tar_file_name() -> str: ...

  @property
  def proceed() -> bool: ...
  @proceed.setter
  def proceed(value) -> None: ...

# In class PGPReader:
@property
def on_multiple_files_found() -> Callable[[PGPReaderMultipleFilesFoundEventParams], None]: ...
@on_multiple_files_found.setter
def on_multiple_files_found(event_hook: Callable[[PGPReaderMultipleFilesFoundEventParams], None]) -> None: ...

Remarks

The class fires this event to report that there is more than one file in the PGP message.

The TarFileName specifies the name of the TAR file containing the files. Tune up Proceed to go ahead or stop the processing.

on_notification Event

This event notifies the application about an underlying control flow event.

Syntax

class PGPReaderNotificationEventParams(object):
  @property
  def event_id() -> str: ...

  @property
  def event_param() -> str: ...

# In class PGPReader:
@property
def on_notification() -> Callable[[PGPReaderNotificationEventParams], None]: ...
@on_notification.setter
def on_notification(event_hook: Callable[[PGPReaderNotificationEventParams], 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.

on_passphrase_needed Event

Requests a data protection password from the application.

Syntax

class PGPReaderPassphraseNeededEventParams(object):
  @property
  def passphrase() -> str: ...
  @passphrase.setter
  def passphrase(value) -> None: ...

  @property
  def skip() -> bool: ...
  @skip.setter
  def skip(value) -> None: ...

# In class PGPReader:
@property
def on_passphrase_needed() -> Callable[[PGPReaderPassphraseNeededEventParams], None]: ...
@on_passphrase_needed.setter
def on_passphrase_needed(event_hook: Callable[[PGPReaderPassphraseNeededEventParams], None]) -> None: ...

Remarks

The class fires this event to request a decryption password. It is only fired if the data can be decrypted without a key.

The event is fired in a loop until the correct password is passed or the number of password attempts is exceeded.

on_progress Event

Reports the progress of the decryption operation.

Syntax

class PGPReaderProgressEventParams(object):
  @property
  def current() -> int: ...

  @property
  def total() -> int: ...

  @property
  def cancel() -> bool: ...
  @cancel.setter
  def cancel(value) -> None: ...

# In class PGPReader:
@property
def on_progress() -> Callable[[PGPReaderProgressEventParams], None]: ...
@on_progress.setter
def on_progress(event_hook: Callable[[PGPReaderProgressEventParams], None]) -> None: ...

Remarks

The class fires this event repeatedly to report the progress of the file extraction operation.

Current indicates the amount of processed data in bytes, and Total is the total number of bytes to be processed. Use Cancel to terminate the extraction process.

on_signed Event

Notifies the application about a signed message.

Syntax

class PGPReaderSignedEventParams(object):
  @property
  def key_i_ds() -> str: ...

  @property
  def signature_type() -> int: ...

# In class PGPReader:
@property
def on_signed() -> Callable[[PGPReaderSignedEventParams], None]: ...
@on_signed.setter
def on_signed(event_hook: Callable[[PGPReaderSignedEventParams], None]) -> None: ...

Remarks

The class fires this event when it identifies a signed message to allow the application to prepare the component for verification.

Use the KeyIDs parameter to identify keys used that were used to sign the message, and make sure they are available in the verifying_keys list.

SignatureType indicates the signature type:

pstNormal0A traditional signature, compatible (algorithm permitting) with PGP 2.6.x

pstOnePass1A newer one-pass signature

pstDetached2A detached signature, i.e., a signature contained in a separate file from the data it covers

pstCleartext3A signature made over textual data and appended to it

PGPReader 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.

PGPReader Config Settings

IgnoreDataPacketLengths:   Whether to check the length of input data packets.

Set this property to True to prevent the class from checking input packet lengths.

PasswordAttempts:   The number of attempts allowed for entering password.

Use this property to specify how many times a wrong password may be entered.

TempPath:   Path for storing temporary files.

This setting specifies an absolute path to the location on disk where temporary files are stored.

UndefInputLength:   Set this property if you are working with non-seekable streams.

Use this property to turn on support for streams with unknown length and position parameters, such as network or database streams. It prevents the class from checking input stream length or position.

UseGreedyMemoryConsumption:   Whether to limit memory consumption for the cost of speed.

When this property is True, the class uses more memory, but decrypts data faster. Otherwise, less memory is consumed, but the decryption is slower.

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:

offNo caching (default)
localLocal caching
globalGlobal 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.

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: auto, enable, or disable.

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:

fileFile
consoleConsole
systemlogSystem Log (supported for Android only)
debuggerDebugger (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:

timeCurrent time
levelLevel
packagePackage name
moduleModule name
classClass name
methodMethod name
threadidThread Id
contenttypeContent type
contentContent
allAll 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-packageExclude a package specified in the value
exclude-moduleExclude a module specified in the value
exclude-classExclude a class specified in the value
exclude-methodExclude a method specified in the value
include-packageInclude a package specified in the value
include-moduleInclude a module specified in the value
include-classInclude a class specified in the value
include-methodInclude 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:

noneNo flush (caching only)
immediateImmediate flush (real-time logging)
maxcountFlush 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:

noneNone (by default)
fatalSevere errors that cause premature termination.
errorOther runtime errors or unexpected conditions.
warningUse of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong".
infoInteresting runtime events (startup/shutdown).
debugDetailed information on flow of through the system.
traceMore 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:

noneNo rotation
deleteolderDelete older entries from the cache upon reaching LogMaxEventCount
keepolderKeep 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.

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:

noneNo static DNS rules (default)
localLocal static DNS rules
globalGlobal 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 devided 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 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.

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).

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).

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.

PGPReader Errors

PGPReader 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)