Struct secureblackbox::PGPReader

Properties   Methods   Events   Config Settings   Errors  

The PGPReader struct unprotects, verifies, and extracts data from protected PGP files.

Syntax

secureblackbox::PGPReader

Remarks

PGPReader lets you process PGP messages, and validate and extract the protected data.

PGPReader supports all modern PGP keys and formats, from last-century PGP 2.6.x to the state-of-the art PGP 6. Single- and multi-file, as well as for-your-eyes-only PGP containers are supported.

The use of PGPReader is quite straightforward: you only need to provide the protected data and the keyring files, and the component will do the rest. PGPReader detects the protection parameters, matches them to the keys, and unwraps the protected data automatically.

Preparing keys

Encryption and signing in PGP is done with asymmetric keys (and sometimes with passwords, but that is a far less common scenario). Keys are normally stored in files called keyrings. More often that not they consist of a pair of files: a public keyring (e.g pubring.pkr) and a secret keyring (secring.skr), although there are exceptions. Sometimes, parties provide each other with standalone public keys that they want them to encrypt or verify data with.

Whichever form your keyring takes, use PGPKeyring to load it. It is recommended to load all the keyring files that you have to make sure that you have all the keys loaded. PGPKeyring can detect duplicate keys, so don't worry about loading the same key twice - any duplicates will be neatly merged together into one key object. PGPKeyring keyring = new PGPKeyring(); keyring.ImportFromFile("pubring.pkr"); keyring.ImportFromFile("secring.skr");

You keyring will typically contain two types of keys: public and private. Private keys (i.e. your keys) are used for signing and decryption. Public keys (someone else's keys) are used for encryption and signature verification. This means that if you are looking to decrypt a file, you need to get your private keys ready. If you are looking to verify someone's signature over the data, you need to get the public keys.

When processing protected files PGPReader can look for the required keys in the keyring and select the appropriate ones automatically. This means that you do not need to comb through your key collection manually, cherry-picking public and private keys. Simply assign the entire collection of keys to PGPReader's decrypting_keys and verifying_keys properties, and PGPReader will find and use the right one: reader.DecryptingKeys = keyring.Keys; reader.VerifyingKeys = keyring.Keys;

When it comes to using your private keys - i.e. when decrypting the data - there is one important catch that you need to keep in mind. Private PGP keys are typically protected with passwords. To be able to use them, you need to provide the valid password to the component when the key needs to be used. You can do that in one of the following three ways:

• By assigning the password to property. You can check whether the provided password is valid using the property.
• By assigning the password to key_passphrase property. This and the previous method assumes that you anticipate which key you will likely need to use.
• By subscribing to on_key_passphrase_needed event and providing the password from within the event handler. This event will be fired in the middle of the decryption process for each eligible private key for which no valid password was provided using the first two methods. This method lets you provide the password on-the-fly, and is handy when you don't know which key you are going to use in advance.

Configuring the component

Unprotection configuration if quite straightforward and encompasses adjustment of the following settings:

• Provide the input data via the input_file (or input_bytes) property.
• Provide the destination in output_file. If no output destination is provided, the output will be generated in output_bytes.
• When processing multi-files PGP archives, consider subscribing to on_multiple_files_found, on_file_extraction_start and on_file_extraction_finish events. These come handy in tracking progress and adjusting output locations for individual files.
• Depending on your circumstances, you may want to subscribe to on_signed and on_encryption_info events to be notified about various protection parameters.

Unprotecting the file

You are all set now. Call the appropriate unprotection method to proceed with operation:

• decrypt_and_verify: process the input data by decrypting any protected data, extracting individual files, and verifying signatures. This is the method that you would likely need to use in most cases.
• verify_detached: verify a detached signature. Remember that you need to provide the original data separately via the data_file or data_bytes properties.

reader.InputFile = "C:\files\input.pgp"; reader.OutputFile = "C:\files\output.txt"; reader.DecryptingKeys = keyring.Keys; reader.VerifyingKeys = keyring.Keys; reader.KeyPassphrase = "password"; reader.DecryptAndVerify();

Object Lifetime

The new() method returns a mutable reference to a struct instance. The object itself is kept in the global list maintained by SecureBlackbox. Due to this, the PGPReader struct cannot be disposed of automatically. Please, call the dispose(&mut self) method of PGPReader when you have finished using the instance.

Property List

---

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

Method List

---

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

Event List

---

The following is the full list of the events fired by the struct with short descriptions. Click on the links for further details.

Config Settings

---

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

armored property (PGPReader Struct)

Indicates if the processed message had been base64-armored.

Syntax

fn armored(&self ) -> Result<bool, SecureBlackboxError> 

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.

Data Type

bool

compressed property (PGPReader Struct)

Indicates if the processed message had been compressed.

Syntax

fn compressed(&self ) -> Result<bool, SecureBlackboxError> 

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 Type

bool

data_bytes property (PGPReader Struct)

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

Syntax

fn data_bytes(&self ) -> Result<Vec<u8>, SecureBlackboxError> 
fn set_data_bytes(&self, value : Vec<u8>) ->  Option<SecureBlackboxError> 
fn set_data_bytes_ref(&self, value : &[u8]) ->  Option<SecureBlackboxError> 

Remarks

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

Data Type

Vec

data_file property (PGPReader Struct)

The name of the file containing the original signed data.

Syntax

fn data_file(&self ) -> Result<String, SecureBlackboxError> 
fn set_data_file(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_data_file_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

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

Data Type

String

decrypting_key_count property (PGPReader Struct)

The number of records in the DecryptingKey arrays.

Syntax

fn decrypting_key_count(&self ) -> Result<i32, SecureBlackboxError> 
fn set_decrypting_key_count(&self, value : i32) ->  Option<SecureBlackboxError> 

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.

Data Type

i32

decrypting_key_handle property (PGPReader Struct)

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

Syntax

fn decrypting_key_handle(&self , DecryptingKeyIndex : i32) -> Result<i64, SecureBlackboxError> 
fn set_decrypting_key_handle(&self, DecryptingKeyIndex : i32, value : i64) ->  Option<SecureBlackboxError> 

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

Data Type

i64

decrypting_key_key_fp property (PGPReader Struct)

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

Syntax

fn decrypting_key_key_fp(&self , DecryptingKeyIndex : i32) -> Result<String, SecureBlackboxError> 

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

This property is read-only.

Data Type

String

decrypting_key_key_id property (PGPReader Struct)

Contains a 8-byte key identifier.

Syntax

fn decrypting_key_key_id(&self , DecryptingKeyIndex : i32) -> Result<String, SecureBlackboxError> 

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

This property is read-only.

Data Type

String

decrypting_key_passphrase property (PGPReader Struct)

The key protection password.

Syntax

fn decrypting_key_passphrase(&self , DecryptingKeyIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_decrypting_key_passphrase(&self, DecryptingKeyIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_decrypting_key_passphrase_ref(&self, DecryptingKeyIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The key protection password.

The DecryptingKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DecryptingKeyCount property.

Data Type

String

decrypting_key_passphrase_valid property (PGPReader Struct)

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

Syntax

fn decrypting_key_passphrase_valid(&self , DecryptingKeyIndex : i32) -> Result<bool, SecureBlackboxError> 

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

This property is read-only.

Data Type

bool

decrypting_key_username property (PGPReader Struct)

Specifies the name of the user bound to this key.

Syntax

fn decrypting_key_username(&self , DecryptingKeyIndex : i32) -> Result<String, SecureBlackboxError> 

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

This property is read-only.

Data Type

String

external_crypto_async_document_id property (PGPReader Struct)

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

Syntax

fn external_crypto_async_document_id(&self ) -> Result<String, SecureBlackboxError> 
fn set_external_crypto_async_document_id(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_external_crypto_async_document_id_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

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.

Data Type

String

external_crypto_custom_params property (PGPReader Struct)

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

Syntax

fn external_crypto_custom_params(&self ) -> Result<String, SecureBlackboxError> 
fn set_external_crypto_custom_params(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_external_crypto_custom_params_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

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

Data Type

String

external_crypto_data property (PGPReader Struct)

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

Syntax

fn external_crypto_data(&self ) -> Result<String, SecureBlackboxError> 
fn set_external_crypto_data(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_external_crypto_data_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

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

Data Type

String

external_crypto_external_hash_calculation property (PGPReader Struct)

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

Syntax

fn external_crypto_external_hash_calculation(&self ) -> Result<bool, SecureBlackboxError> 
fn set_external_crypto_external_hash_calculation(&self, value : bool) ->  Option<SecureBlackboxError> 

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

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

Data Type

bool

external_crypto_hash_algorithm property (PGPReader Struct)

Specifies the request's signature hash algorithm.

Syntax

fn external_crypto_hash_algorithm(&self ) -> Result<String, SecureBlackboxError> 
fn set_external_crypto_hash_algorithm(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_external_crypto_hash_algorithm_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

"SHA256"

Remarks

Specifies the request's signature hash algorithm.

Data Type

String

external_crypto_key_id property (PGPReader Struct)

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

Syntax

fn external_crypto_key_id(&self ) -> Result<String, SecureBlackboxError> 
fn set_external_crypto_key_id(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_external_crypto_key_id_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

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

Data Type

String

external_crypto_key_secret property (PGPReader Struct)

The pre-shared key used for DC request authentication.

Syntax

fn external_crypto_key_secret(&self ) -> Result<String, SecureBlackboxError> 
fn set_external_crypto_key_secret(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_external_crypto_key_secret_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

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.

Data Type

String

external_crypto_method property (PGPReader Struct)

Specifies the asynchronous signing method.

Syntax

fn external_crypto_method(&self ) -> Result<i32, SecureBlackboxError> 
fn set_external_crypto_method(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // PKCS1
1   // PKCS7

Default Value

0

Remarks

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

Available options:

Data Type

i32

external_crypto_mode property (PGPReader Struct)

Specifies the external cryptography mode.

Syntax

fn external_crypto_mode(&self ) -> Result<i32, SecureBlackboxError> 
fn set_external_crypto_mode(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // Default
1   // Disabled
2   // Generic
3   // DCAuth
4   // DCAuthJSON

Default Value

0

Remarks

Specifies the external cryptography mode.

Available options:

Data Type

i32

external_crypto_public_key_algorithm property (PGPReader Struct)

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

Syntax

fn external_crypto_public_key_algorithm(&self ) -> Result<String, SecureBlackboxError> 
fn set_external_crypto_public_key_algorithm(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_external_crypto_public_key_algorithm_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

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

Data Type

String

fips_mode property (PGPReader Struct)

Reserved.

Syntax

fn fips_mode(&self ) -> Result<bool, SecureBlackboxError> 
fn set_fips_mode(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

This property is reserved for future use.

Data Type

bool

input_bytes property (PGPReader Struct)

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

Syntax

fn input_bytes(&self ) -> Result<Vec<u8>, SecureBlackboxError> 
fn set_input_bytes(&self, value : Vec<u8>) ->  Option<SecureBlackboxError> 
fn set_input_bytes_ref(&self, value : &[u8]) ->  Option<SecureBlackboxError> 

Remarks

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

Data Type

Vec

input_file property (PGPReader Struct)

Provides a filename of a file to process.

Syntax

fn input_file(&self ) -> Result<String, SecureBlackboxError> 
fn set_input_file(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_input_file_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

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

Data Type

String

key_passphrase property (PGPReader Struct)

Specifies a passphrase for the decryption key.

Syntax

fn key_passphrase(&self ) -> Result<String, SecureBlackboxError> 
fn set_key_passphrase(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_key_passphrase_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

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.

Data Type

String

output_bytes property (PGPReader Struct)

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

Syntax

fn output_bytes(&self ) -> Result<Vec<u8>, SecureBlackboxError> 

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.

Data Type

Vec

output_file property (PGPReader Struct)

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

Syntax

fn output_file(&self ) -> Result<String, SecureBlackboxError> 
fn set_output_file(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_output_file_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

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

Data Type

String

passphrase property (PGPReader Struct)

Specifies a message decryption password.

Syntax

fn passphrase(&self ) -> Result<String, SecureBlackboxError> 
fn set_passphrase(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_passphrase_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

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.

Data Type

String

processed_length property (PGPReader Struct)

Reports the number of bytes processed.

Syntax

fn processed_length(&self ) -> Result<i64, SecureBlackboxError> 

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.

Data Type

i64

profile property (PGPReader Struct)

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

Syntax

fn profile(&self ) -> Result<String, SecureBlackboxError> 
fn set_profile(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_profile_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

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.

Data Type

String

signature_count property (PGPReader Struct)

The number of records in the Signature arrays.

Syntax

fn signature_count(&self ) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• signature_certification_type
• signature_class
• signature_creation_time
• signature_expiration_time
• signature_exportable
• signature_handle
• signature_hash_algorithm
• signature_hash_mark
• signature_key_expiration_time
• signature_key_flags
• signature_legacy_format
• signature_policy_url
• signature_preferred_algorithms
• signature_primary_user_id
• signature_reason_for_revocation
• signature_revocable
• signature_revocation
• signature_signer_key_id
• signature_signer_user_id
• signature_strictly_valid
• signature_target
• 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.

Data Type

i32

signature_certification_type property (PGPReader Struct)

Specifies the type of a UserID signature.

Syntax

fn signature_certification_type(&self , SignatureIndex : i32) -> Result<i32, SecureBlackboxError> 

Possible Values

0   // Generic
1   // Persona
2   // Casual
3   // Positive

Default Value

0

Remarks

Specifies the type of a UserID signature.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

i32

signature_creation_time property (PGPReader Struct)

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

Syntax

fn signature_creation_time(&self , SignatureIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

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

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

String

signature_expiration_time property (PGPReader Struct)

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

Syntax

fn signature_expiration_time(&self , SignatureIndex : i32) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

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

This property set to 0 indicates that the signature never expires.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

i32

signature_exportable property (PGPReader Struct)

Specifies whether a certification signature is "exportable", meaning it can be used by entities other than the signature's issuer.

Syntax

fn signature_exportable(&self , SignatureIndex : i32) -> Result<bool, SecureBlackboxError> 

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

This property is read-only.

Data Type

bool

signature_handle property (PGPReader Struct)

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

Syntax

fn signature_handle(&self , SignatureIndex : i32) -> Result<i64, SecureBlackboxError> 

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

This property is read-only.

Data Type

i64

signature_hash_algorithm property (PGPReader Struct)

Specifies the hash algorithm used in the signature.

Syntax

fn signature_hash_algorithm(&self , SignatureIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Specifies the hash algorithm used in the signature.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

String

signature_hash_mark property (PGPReader Struct)

Returns the hash mark attribute of a signature.

Syntax

fn signature_hash_mark(&self , SignatureIndex : i32) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

Returns the hash mark attribute of a signature.

Check this property to get a hash mark of a signature.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

i32

signature_key_expiration_time property (PGPReader Struct)

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

Syntax

fn signature_key_expiration_time(&self , SignatureIndex : i32) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

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

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

i32

signature_key_flags property (PGPReader Struct)

Returns the key flags included in the signature.

Syntax

fn signature_key_flags(&self , SignatureIndex : i32) -> Result<i32, SecureBlackboxError> 

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

This property is read-only.

Data Type

i32

signature_legacy_format property (PGPReader Struct)

Indicates whether signature uses PGP 2.

Syntax

fn signature_legacy_format(&self , SignatureIndex : i32) -> Result<bool, SecureBlackboxError> 

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

This property is read-only.

Data Type

bool

signature_policy_url property (PGPReader Struct)

Contains the URL of the signature policy.

Syntax

fn signature_policy_url(&self , SignatureIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Contains the URL of the signature policy.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

String

signature_preferred_algorithms property (PGPReader Struct)

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

Syntax

fn signature_preferred_algorithms(&self , SignatureIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

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

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

String

signature_primary_user_id property (PGPReader Struct)

Indicates whether the UserID covered by the signature is the main user id for this key.

Syntax

fn signature_primary_user_id(&self , SignatureIndex : i32) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

Indicates whether the UserID covered by the signature is the main user id for this key.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

bool

signature_reason_for_revocation property (PGPReader Struct)

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

Syntax

fn signature_reason_for_revocation(&self , SignatureIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

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

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

String

signature_revocable property (PGPReader Struct)

Specifies whether the signature can be revoked.

Syntax

fn signature_revocable(&self , SignatureIndex : i32) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

Specifies whether the signature can be revoked.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

bool

signature_revocation property (PGPReader Struct)

Indicates whether or not the signature is a revocation signature.

Syntax

fn signature_revocation(&self , SignatureIndex : i32) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

Indicates whether or not the signature is a revocation signature.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

bool

signature_class property (PGPReader Struct)

Indicates the signature class.

Syntax

fn signature_class(&self , SignatureIndex : i32) -> Result<i32, SecureBlackboxError> 

Possible Values

0   // Document
1   // TextDocument
2   // Standalone
3   // UIDGeneric
4   // UIDPersona
5   // UIDCasual
6   // UIDPositive
7   // SubkeyBinding
8   // PrimaryKeyBinding
9   // DirectKey
10   // KeyRevocation
11   // SubkeyRevocation
12   // CertRevocation
13   // Timestamp
14   // ThirdParty
15   // NotSpecified

Default Value

0

Remarks

Indicates the signature class.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

i32

signature_signer_key_id property (PGPReader Struct)

Indicates the KeyID of the signing key.

Syntax

fn signature_signer_key_id(&self , SignatureIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Indicates the KeyID of the signing key.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

String

signature_signer_user_id property (PGPReader Struct)

Indicates the UserID associated with the signing key.

Syntax

fn signature_signer_user_id(&self , SignatureIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Indicates the UserID associated with the signing key.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

String

signature_strictly_valid property (PGPReader Struct)

Returns True if this signature is valid in a strict way (no compatibility relaxations).

Syntax

fn signature_strictly_valid(&self , SignatureIndex : i32) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

Returns True if this signature is valid in a strict way (no compatibility relaxations).

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

bool

signature_target property (PGPReader Struct)

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

Syntax

fn signature_target(&self , SignatureIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

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

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

String

signature_text_signature property (PGPReader Struct)

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

Syntax

fn signature_text_signature(&self , SignatureIndex : i32) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

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

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

bool

signature_trust_amount property (PGPReader Struct)

Specifies the amount of trust assigned by this signature.

Syntax

fn signature_trust_amount(&self , SignatureIndex : i32) -> Result<i32, SecureBlackboxError> 

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

This property is read-only.

Data Type

i32

signature_trust_level property (PGPReader Struct)

The trust level assigned by this signature.

Syntax

fn signature_trust_level(&self , SignatureIndex : i32) -> Result<i32, SecureBlackboxError> 

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

This property is read-only.

Data Type

i32

signature_validated property (PGPReader Struct)

Whether the signature has been validated.

Syntax

fn signature_validated(&self , SignatureIndex : i32) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

Whether the signature has been validated.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

bool

signature_validity property (PGPReader Struct)

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

Syntax

fn signature_validity(&self , SignatureIndex : i32) -> Result<i32, SecureBlackboxError> 

Possible Values

0   // Valid
1   // Unknown
2   // Corrupted
3   // SignerNotFound
4   // Failure
5   // ReferenceCorrupted

Default Value

0

Remarks

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

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

i32

signature_version property (PGPReader Struct)

Indicates the signature version.

Syntax

fn signature_version(&self , SignatureIndex : i32) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

Indicates the signature version.

RFC 4880 defines two versions for PGP signatures: 3 and 4.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

i32

verifying_key_count property (PGPReader Struct)

The number of records in the VerifyingKey arrays.

Syntax

fn verifying_key_count(&self ) -> Result<i32, SecureBlackboxError> 
fn set_verifying_key_count(&self, value : i32) ->  Option<SecureBlackboxError> 

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.

Data Type

i32

verifying_key_handle property (PGPReader Struct)

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

Syntax

fn verifying_key_handle(&self , VerifyingKeyIndex : i32) -> Result<i64, SecureBlackboxError> 
fn set_verifying_key_handle(&self, VerifyingKeyIndex : i32, value : i64) ->  Option<SecureBlackboxError> 

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

Data Type

i64

verifying_key_key_fp property (PGPReader Struct)

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

Syntax

fn verifying_key_key_fp(&self , VerifyingKeyIndex : i32) -> Result<String, SecureBlackboxError> 

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

This property is read-only.

Data Type

String

verifying_key_key_id property (PGPReader Struct)

Contains a 8-byte key identifier.

Syntax

fn verifying_key_key_id(&self , VerifyingKeyIndex : i32) -> Result<String, SecureBlackboxError> 

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

This property is read-only.

Data Type

String

verifying_key_username property (PGPReader Struct)

Specifies the name of the user bound to this key.

Syntax

fn verifying_key_username(&self , VerifyingKeyIndex : i32) -> Result<String, SecureBlackboxError> 

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

This property is read-only.

Data Type

String

config method (PGPReader Struct)

Sets or retrieves a configuration setting.

Syntax

fn config(&self, configuration_string : &str) ->  Result<String, SecureBlackboxError>

Remarks

config is a generic method available in every struct. It is used to set and retrieve configuration settings for the struct.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, 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 (PGPReader Struct)

Decrypts and verifies a protected message.

Syntax

fn decrypt_and_verify(&self) -> Result<(), SecureBlackboxError>

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

Performs an additional action.

Syntax

fn do_action(&self, action_id : &str, action_params : &str) ->  Result<String, SecureBlackboxError>

Remarks

do_action is a generic method available in every struct. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.

The unique identifier (case insensitive) of the action is provided in the ActionID parameter.

ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

Common ActionIDs:

reset method (PGPReader Struct)

Resets the struct settings.

Syntax

fn reset(&self) -> Result<(), SecureBlackboxError>

Remarks

reset is a generic method available in every struct.

verify_detached method (PGPReader Struct)

Verifies a detached signature.

Syntax

fn verify_detached(&self) -> Result<(), SecureBlackboxError>

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

Reports early information on encryption parameters.

Syntax

// PGPReaderEncryptionInfoEventArgs carries the PGPReader EncryptionInfo event's parameters.
pub struct PGPReaderEncryptionInfoEventArgs {
  fn key_i_ds(&self) -> &String
  fn encrypted_protection(&self) -> i32
  fn passphrase_used(&self) -> bool
}

// PGPReaderEncryptionInfoEvent defines the signature of the PGPReader EncryptionInfo event's handler function.
pub trait PGPReaderEncryptionInfoEvent {
  fn on_encryption_info(&self, sender : PGPReader, e : &mut PGPReaderEncryptionInfoEventArgs);
}

impl <'a> PGPReader<'a> {
  pub fn on_encryption_info(&self) -> &'a dyn PGPReaderEncryptionInfoEvent;
  pub fn set_on_encryption_info(&mut self, value : &'a dyn PGPReaderEncryptionInfoEvent);
  ...
}

Remarks

The struct 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 (PGPReader Struct)

Information about errors during PGP decryption/verification.

Syntax

// PGPReaderErrorEventArgs carries the PGPReader Error event's parameters.
pub struct PGPReaderErrorEventArgs {
  fn error_code(&self) -> i32
  fn description(&self) -> &String
}

// PGPReaderErrorEvent defines the signature of the PGPReader Error event's handler function.
pub trait PGPReaderErrorEvent {
  fn on_error(&self, sender : PGPReader, e : &mut PGPReaderErrorEventArgs);
}

impl <'a> PGPReader<'a> {
  pub fn on_error(&self) -> &'a dyn PGPReaderErrorEvent;
  pub fn set_on_error(&mut self, value : &'a dyn PGPReaderErrorEvent);
  ...
}

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

Handles remote or external decryption.

Syntax

// PGPReaderExternalDecryptEventArgs carries the PGPReader ExternalDecrypt event's parameters.
pub struct PGPReaderExternalDecryptEventArgs {
  fn operation_id(&self) -> &String
  fn algorithm(&self) -> &String
  fn pars(&self) -> &String
  fn encrypted_data(&self) -> &String
  fn data(&self) -> &String
  fn set_data(&self, value : &str)
  fn set_data_ref(&self, value : &String)
}

// PGPReaderExternalDecryptEvent defines the signature of the PGPReader ExternalDecrypt event's handler function.
pub trait PGPReaderExternalDecryptEvent {
  fn on_external_decrypt(&self, sender : PGPReader, e : &mut PGPReaderExternalDecryptEventArgs);
}

impl <'a> PGPReader<'a> {
  pub fn on_external_decrypt(&self) -> &'a dyn PGPReaderExternalDecryptEvent;
  pub fn set_on_external_decrypt(&mut self, value : &'a dyn PGPReaderExternalDecryptEvent);
  ...
}

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

The struct 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 (PGPReader Struct)

Reports the ending of file extraction process.

Syntax

// PGPReaderFileExtractionFinishEventArgs carries the PGPReader FileExtractionFinish event's parameters.
pub struct PGPReaderFileExtractionFinishEventArgs {
  fn file_name(&self) -> &String
  fn timestamp(&self) -> &String
}

// PGPReaderFileExtractionFinishEvent defines the signature of the PGPReader FileExtractionFinish event's handler function.
pub trait PGPReaderFileExtractionFinishEvent {
  fn on_file_extraction_finish(&self, sender : PGPReader, e : &mut PGPReaderFileExtractionFinishEventArgs);
}

impl <'a> PGPReader<'a> {
  pub fn on_file_extraction_finish(&self) -> &'a dyn PGPReaderFileExtractionFinishEvent;
  pub fn set_on_file_extraction_finish(&mut self, value : &'a dyn PGPReaderFileExtractionFinishEvent);
  ...
}

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

Reports the beginning of file extraction process.

Syntax

// PGPReaderFileExtractionStartEventArgs carries the PGPReader FileExtractionStart event's parameters.
pub struct PGPReaderFileExtractionStartEventArgs {
  fn file_name(&self) -> &String
  fn timestamp(&self) -> &String
  fn skip(&self) -> bool
  fn set_skip(&self, value : bool)
}

// PGPReaderFileExtractionStartEvent defines the signature of the PGPReader FileExtractionStart event's handler function.
pub trait PGPReaderFileExtractionStartEvent {
  fn on_file_extraction_start(&self, sender : PGPReader, e : &mut PGPReaderFileExtractionStartEventArgs);
}

impl <'a> PGPReader<'a> {
  pub fn on_file_extraction_start(&self) -> &'a dyn PGPReaderFileExtractionStartEvent;
  pub fn set_on_file_extraction_start(&mut self, value : &'a dyn PGPReaderFileExtractionStartEvent);
  ...
}

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

Requests a key protection password from the application.

Syntax

// PGPReaderKeyPassphraseNeededEventArgs carries the PGPReader KeyPassphraseNeeded event's parameters.
pub struct PGPReaderKeyPassphraseNeededEventArgs {
  fn key_id(&self) -> &String
  fn user_id(&self) -> &String
  fn main_key(&self) -> bool
  fn passphrase(&self) -> &String
  fn set_passphrase(&self, value : &str)
  fn set_passphrase_ref(&self, value : &String)
  fn skip(&self) -> bool
  fn set_skip(&self, value : bool)
}

// PGPReaderKeyPassphraseNeededEvent defines the signature of the PGPReader KeyPassphraseNeeded event's handler function.
pub trait PGPReaderKeyPassphraseNeededEvent {
  fn on_key_passphrase_needed(&self, sender : PGPReader, e : &mut PGPReaderKeyPassphraseNeededEventArgs);
}

impl <'a> PGPReader<'a> {
  pub fn on_key_passphrase_needed(&self) -> &'a dyn PGPReaderKeyPassphraseNeededEvent;
  pub fn set_on_key_passphrase_needed(&mut self, value : &'a dyn PGPReaderKeyPassphraseNeededEvent);
  ...
}

Remarks

The struct 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 struct 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 (PGPReader Struct)

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

Syntax

// PGPReaderMultipleFilesFoundEventArgs carries the PGPReader MultipleFilesFound event's parameters.
pub struct PGPReaderMultipleFilesFoundEventArgs {
  fn tar_file_name(&self) -> &String
  fn proceed(&self) -> bool
  fn set_proceed(&self, value : bool)
}

// PGPReaderMultipleFilesFoundEvent defines the signature of the PGPReader MultipleFilesFound event's handler function.
pub trait PGPReaderMultipleFilesFoundEvent {
  fn on_multiple_files_found(&self, sender : PGPReader, e : &mut PGPReaderMultipleFilesFoundEventArgs);
}

impl <'a> PGPReader<'a> {
  pub fn on_multiple_files_found(&self) -> &'a dyn PGPReaderMultipleFilesFoundEvent;
  pub fn set_on_multiple_files_found(&mut self, value : &'a dyn PGPReaderMultipleFilesFoundEvent);
  ...
}

Remarks

The struct 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 (PGPReader Struct)

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

Syntax

// PGPReaderNotificationEventArgs carries the PGPReader Notification event's parameters.
pub struct PGPReaderNotificationEventArgs {
  fn event_id(&self) -> &String
  fn event_param(&self) -> &String
}

// PGPReaderNotificationEvent defines the signature of the PGPReader Notification event's handler function.
pub trait PGPReaderNotificationEvent {
  fn on_notification(&self, sender : PGPReader, e : &mut PGPReaderNotificationEventArgs);
}

impl <'a> PGPReader<'a> {
  pub fn on_notification(&self) -> &'a dyn PGPReaderNotificationEvent;
  pub fn set_on_notification(&mut self, value : &'a dyn PGPReaderNotificationEvent);
  ...
}

Remarks

The struct fires this event to let the application know about some event, occurrence, or milestone in the struct. 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 struct, the exact action it is performing, or the document being processed, one or both may be omitted.

on_passphrase_needed event (PGPReader Struct)

Requests a data protection password from the application.

Syntax

// PGPReaderPassphraseNeededEventArgs carries the PGPReader PassphraseNeeded event's parameters.
pub struct PGPReaderPassphraseNeededEventArgs {
  fn passphrase(&self) -> &String
  fn set_passphrase(&self, value : &str)
  fn set_passphrase_ref(&self, value : &String)
  fn skip(&self) -> bool
  fn set_skip(&self, value : bool)
}

// PGPReaderPassphraseNeededEvent defines the signature of the PGPReader PassphraseNeeded event's handler function.
pub trait PGPReaderPassphraseNeededEvent {
  fn on_passphrase_needed(&self, sender : PGPReader, e : &mut PGPReaderPassphraseNeededEventArgs);
}

impl <'a> PGPReader<'a> {
  pub fn on_passphrase_needed(&self) -> &'a dyn PGPReaderPassphraseNeededEvent;
  pub fn set_on_passphrase_needed(&mut self, value : &'a dyn PGPReaderPassphraseNeededEvent);
  ...
}

Remarks

The struct 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 (PGPReader Struct)

Reports the progress of the decryption operation.

Syntax

// PGPReaderProgressEventArgs carries the PGPReader Progress event's parameters.
pub struct PGPReaderProgressEventArgs {
  fn current(&self) -> i64
  fn total(&self) -> i64
  fn cancel(&self) -> bool
  fn set_cancel(&self, value : bool)
}

// PGPReaderProgressEvent defines the signature of the PGPReader Progress event's handler function.
pub trait PGPReaderProgressEvent {
  fn on_progress(&self, sender : PGPReader, e : &mut PGPReaderProgressEventArgs);
}

impl <'a> PGPReader<'a> {
  pub fn on_progress(&self) -> &'a dyn PGPReaderProgressEvent;
  pub fn set_on_progress(&mut self, value : &'a dyn PGPReaderProgressEvent);
  ...
}

Remarks

The struct 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 (PGPReader Struct)

Notifies the application about a signed message.

Syntax

// PGPReaderSignedEventArgs carries the PGPReader Signed event's parameters.
pub struct PGPReaderSignedEventArgs {
  fn key_i_ds(&self) -> &String
  fn signature_type(&self) -> i32
}

// PGPReaderSignedEvent defines the signature of the PGPReader Signed event's handler function.
pub trait PGPReaderSignedEvent {
  fn on_signed(&self, sender : PGPReader, e : &mut PGPReaderSignedEventArgs);
}

impl <'a> PGPReader<'a> {
  pub fn on_signed(&self) -> &'a dyn PGPReaderSignedEvent;
  pub fn set_on_signed(&mut self, value : &'a dyn PGPReaderSignedEvent);
  ...
}

Remarks

The struct 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:

Config Settings (PGPReader Struct)

The struct 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 struct, access to these internal properties is provided through the config method.

PGPReader Config Settings

Base Config Settings

Trappable Errors (PGPReader Struct)

PGPReader Errors