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.

Method List

---

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

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.

Config Settings

---

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

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:

• decrypting_key_handle
• decrypting_key_key_fp
• decrypting_key_key_id
• decrypting_key_passphrase
• decrypting_key_passphrase_valid
• decrypting_key_username

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: ...
def set_decrypting_key_username(decrypting_key_index: int, value: str) -> None: ...

Default Value

""

Remarks

Specifies the name of the user bound to this key.

The PGP username is typically represented with a full name and an email address, but generally can be any non-empty string.

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.

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 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 all components. In particular, components operating with larger objects (PDFSigner, CAdESSigner, XAdESSigner) do not support it.

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.

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 extra protection layer for the protocol and diminishes the risk of 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:

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:

external_crypto_public_key_algorithm Property

Provide 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 public key algorithm here if the certificate is not available on the pre-signing stage.

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 the 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 is completed to read the produced output. This property will only be set if 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:

• signature_certification_type
• signature_creation_time
• signature_expiration_time
• signature_exportable
• signature_handle
• signature_hash_algorithm
• signature_key_expiration_time
• signature_legacy_format
• signature_policy_url
• signature_primary_user_id
• signature_reason_for_revocation
• signature_revocable
• signature_revocation
• signature_signature_class
• signature_signer_key_id
• signature_signer_user_id
• signature_strictly_valid
• signature_text_signature
• signature_trust_amount
• signature_trust_level
• signature_validated
• signature_validity
• signature_version

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.

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

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

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:

• verifying_key_handle
• verifying_key_key_fp
• verifying_key_key_id
• verifying_key_username

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: ...
def set_verifying_key_username(verifying_key_index: int, value: str) -> None: ...

Default Value

""

Remarks

Specifies the name of the user bound to this key.

The PGP username is typically represented with a full name and an email address, but generally can be any non-empty string.

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.

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

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 integrity_protected() -> bool: ...

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

IntegrityProtected 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 a 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 component being used, and may be empty. Algorithm specifies the encryption algorithm being used, and Pars contain algorithm-dependent parameters.

The component uses base16 (hex) encoding for 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.

A 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 filename() -> 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 filename() -> 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_filename() -> 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 component. 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 EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the component, 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:

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

Base Config Settings

PGPReader Errors

PGPReader Errors

	1048577   Invalid parameter value (SB_ERROR_INVALID_PARAMETER)
	1048578   Class is configured incorrectly (SB_ERROR_INVALID_SETUP)
	1048579   Operation cannot be executed in the current state (SB_ERROR_INVALID_STATE)
	1048580   Attempt to set an invalid value to a property (SB_ERROR_INVALID_VALUE)
	1048581   Certificate does not have its private key loaded (SB_ERROR_NO_PRIVATE_KEY)
	1048581   Cancelled by the user (SB_ERROR_CANCELLED_BY_USER) 
	27262977   File does not exist (SB_ERROR_PGP_FILE_NOT_EXISTS)
	27262978   Invalid key (SB_ERROR_PGP_INVALID_KEY)
	27262979   No public key (SB_ERROR_PGP_NO_PUBLIC_KEY)
	27262980   No secret key (SB_ERROR_PGP_NO_SECRET_KEY)
	27262981   Not found (SB_ERROR_PGP_NOT_FOUND)
	27262982   Operation cannot be performed on a subkey (SB_ERROR_PGP_OPERATION_ON_SUBKEY)