Struct secureblackbox::XMLDecryptor

Properties   Methods   Events   Config Settings   Errors  

The XMLDecryptor struct decrypts XML documents.

Syntax

secureblackbox::XMLDecryptor

Remarks

XMlDecryptor decrypts XML documents encrypted with certificates or generic keys.

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 XMLDecryptor struct cannot be disposed of automatically. Please, call the dispose(&mut self) method of XMLDecryptor 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.

decryption_key property (XMLDecryptor Struct)

The symmetric (session) key used to encrypt the data.

Syntax

fn decryption_key(&self ) -> Result<Vec<u8>, SecureBlackboxError> 
fn set_decryption_key(&self, value : Vec<u8>) ->  Option<SecureBlackboxError> 
fn set_decryption_key_ref(&self, value : &[u8]) ->  Option<SecureBlackboxError> 

Remarks

Use this property to provide the encryption symmetric (session) key that will be used to encrypt a data.

It is required when the encrypt_key property is disabled. If the encrypt_key property is enabled, and no value is set, the component will generate a random session key (recommended).

Data Type

Vec

encoding property (XMLDecryptor Struct)

Specifies XML encoding.

Syntax

fn encoding(&self ) -> Result<String, SecureBlackboxError> 
fn set_encoding(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_encoding_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Use this property to specify the encoding to apply to the XML documents.

Data Type

String

encrypted_data_type property (XMLDecryptor Struct)

Defines the type of data being encrypted.

Syntax

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

Possible Values

0   // Element
1   // Content
2   // External

Default Value

0

Remarks

This property defines what data type is about to be encrypted.

Supported values:

If the xml_node property is set to the empty string, and the input_stream and input_file properties are not provided, then a new XML document will be created with the xenc:EncryptedData element as a document element.

This property is read-only.

Data Type

i32

encryption_method property (XMLDecryptor Struct)

The encryption method used to encrypt the document.

Syntax

fn encryption_method(&self ) -> Result<String, SecureBlackboxError> 

Default Value

"AES256"

Remarks

This property contains the encryption algorithm used to encrypt the XML document.

Supported values:

If use_gcm property is enabled, then supported values are:

This property is read-only.

Data Type

String

encrypt_key property (XMLDecryptor Struct)

Specifies if the encryption key is encrypted.

Syntax

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

Default Value

true

Remarks

Use this property to specify if encryption (session) key should be encrypted and also added to the encrypted data.

This property is read-only.

Data Type

bool

external_crypto_async_document_id property (XMLDecryptor 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 (XMLDecryptor 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 (XMLDecryptor 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 (XMLDecryptor 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 (XMLDecryptor 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 (XMLDecryptor 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 (XMLDecryptor 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 (XMLDecryptor 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 (XMLDecryptor 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 (XMLDecryptor 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

external_data property (XMLDecryptor Struct)

The data that should be encrypted.

Syntax

fn external_data(&self ) -> Result<Vec<u8>, SecureBlackboxError> 
fn set_external_data(&self, value : Vec<u8>) ->  Option<SecureBlackboxError> 
fn set_external_data_ref(&self, value : &[u8]) ->  Option<SecureBlackboxError> 

Remarks

Use this property to provide the data that should be encrypted if encrypted_data_type property is set to cxedtExternal value.

Data Type

Vec

fips_mode property (XMLDecryptor 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 (XMLDecryptor 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 (XMLDecryptor Struct)

The XML file to be decrypted.

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

Provide the path to the XML document to be decrypted.

Data Type

String

key_decryption_cert_bytes property (XMLDecryptor Struct)

Returns the raw certificate data in DER format.

Syntax

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

Remarks

Returns the raw certificate data in DER format.

This property is read-only.

Data Type

Vec

key_decryption_cert_handle property (XMLDecryptor Struct)

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

Syntax

fn key_decryption_cert_handle(&self ) -> Result<i64, SecureBlackboxError> 
fn set_key_decryption_cert_handle(&self, 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());

Data Type

i64

key_decryption_key property (XMLDecryptor Struct)

The symmetric key used to decrypt a session key.

Syntax

fn key_decryption_key(&self ) -> Result<Vec<u8>, SecureBlackboxError> 
fn set_key_decryption_key(&self, value : Vec<u8>) ->  Option<SecureBlackboxError> 
fn set_key_decryption_key_ref(&self, value : &[u8]) ->  Option<SecureBlackboxError> 

Remarks

Use this property to provide the decryption symmetric key that will be used to decrypt a session key. It is required when encrypt_key property is enabled and key_encryption_type set to cxetKeyWrap value.

Data Type

Vec

key_encryption_type property (XMLDecryptor Struct)

Defines how the session key is encrypted.

Syntax

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

Possible Values

0   // KeyTransport
1   // KeyWrap

Default Value

0

Remarks

This property defines how the session key is encrypted.

Supported values:

This property is read-only.

Data Type

i32

key_info_item_count property (XMLDecryptor Struct)

The number of records in the KeyInfoItem arrays.

Syntax

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

Default Value

0

Remarks

This property controls the size of the following arrays:

• key_info_item_issuer_rdn
• key_info_item_serial_number
• key_info_item_subject_key_id
• key_info_item_subject_rdn

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

This property is read-only.

Data Type

i32

key_info_item_issuer_rdn property (XMLDecryptor Struct)

A list of Property=Value pairs that uniquely identify the certificate issuer.

Syntax

fn key_info_item_issuer_rdn(&self , KeyInfoItemIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

A list of Property=Value pairs that uniquely identify the certificate issuer.

Example: /C=US/O=Nationwide CA/CN=Web Certification Authority

The KeyInfoItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyInfoItemCount property.

This property is read-only.

Data Type

String

key_info_item_serial_number property (XMLDecryptor Struct)

Returns the certificate's serial number.

Syntax

fn key_info_item_serial_number(&self , KeyInfoItemIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

Returns the certificate's serial number.

The serial number is a binary string that uniquely identifies a certificate among others issued by the same CA. According to the X.509 standard, the (issuer, serial number) pair should be globally unique to facilitate chain building.

The KeyInfoItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyInfoItemCount property.

This property is read-only.

Data Type

Vec

key_info_item_subject_key_id property (XMLDecryptor Struct)

Contains a unique identifier of the certificate's cryptographic key.

Syntax

fn key_info_item_subject_key_id(&self , KeyInfoItemIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

Contains a unique identifier of the certificate's cryptographic key.

Subject Key Identifier is a certificate extension which allows a specific public key to be associated with a certificate holder. Typically, subject key identifiers of CA certificates are recorded as respective CA key identifiers in the subordinate certificates that they issue, which facilitates chain building.

The key_info_item_subject_key_id and key_info_item_ca_key_id properties of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity.

The KeyInfoItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyInfoItemCount property.

This property is read-only.

Data Type

Vec

key_info_item_subject_rdn property (XMLDecryptor Struct)

A list of Property=Value pairs that uniquely identify the certificate holder (subject).

Syntax

fn key_info_item_subject_rdn(&self , KeyInfoItemIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

A list of Property=Value pairs that uniquely identify the certificate holder (subject).

Depending on the purpose of the certificate and the policies of the CA that issued it, the values included in the subject record may differ drastically and contain business or personal names, web URLs, email addresses, and other data.

Example: /C=US/O=Oranges and Apples, Inc./OU=Accounts Receivable/1.2.3.4.5=Value with unknown OID/CN=Margaret Watkins.

The KeyInfoItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyInfoItemCount property.

This property is read-only.

Data Type

String

key_info_certificate_count property (XMLDecryptor Struct)

The number of records in the KeyInfoCertificate arrays.

Syntax

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

Default Value

0

Remarks

This property controls the size of the following arrays:

• key_info_certificate_bytes
• key_info_certificate_handle

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

This property is read-only.

Data Type

i32

key_info_certificate_bytes property (XMLDecryptor Struct)

Returns the raw certificate data in DER format.

Syntax

fn key_info_certificate_bytes(&self , KeyInfoCertificateIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

Returns the raw certificate data in DER format.

The KeyInfoCertificateIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyInfoCertificateCount property.

This property is read-only.

Data Type

Vec

key_info_certificate_handle property (XMLDecryptor Struct)

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

Syntax

fn key_info_certificate_handle(&self , KeyInfoCertificateIndex : 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 KeyInfoCertificateIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyInfoCertificateCount property.

This property is read-only.

Data Type

i64

key_transport_method property (XMLDecryptor Struct)

Defines how the session key is encrypted.

Syntax

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

Possible Values

0   // RSA15
1   // RSAOAEP

Default Value

0

Remarks

This property defines how the session key is encrypted.

Supported values:

This property is read-only.

Data Type

i32

key_wrap_method property (XMLDecryptor Struct)

The key wrap method used to encrypt the session key.

Syntax

fn key_wrap_method(&self ) -> Result<String, SecureBlackboxError> 

Default Value

"Camellia256"

Remarks

This property specifies the key wrap algorithm used to encrypt the session key.

Supported values:

This property is read-only.

Data Type

String

output_bytes property (XMLDecryptor 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 (XMLDecryptor Struct)

Defines where to save the decrypted XML document.

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

A path where the decrypted XML document should be saved.

Data Type

String

use_gcm property (XMLDecryptor Struct)

Indicates if GCM mode was enabled.

Syntax

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

Default Value

true

Remarks

Use this property to check if GCM encryption mode was enabled.

This property is read-only.

Data Type

bool

xml_element property (XMLDecryptor Struct)

Defines the XML element to decrypt.

Syntax

fn xml_element(&self ) -> Result<String, SecureBlackboxError> 
fn set_xml_element(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_xml_element_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Defines the XML element to decrypt.

Supported values are:

Data Type

String

add_known_namespace method (XMLDecryptor Struct)

Adds known prefix and correspondent namespace URI.

Syntax

fn add_known_namespace(&self, prefix : &str, uri : &str) -> Result<(), SecureBlackboxError>

Remarks

Use this method to add a known prefix and namespace URI that are used in XPath expression within XMLElement/XMLNode property, and within TargetXMLElement and XPathPrefixList properties of the references.

config method (XMLDecryptor 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 method (XMLDecryptor Struct)

Decrypts an XML document.

Syntax

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

Remarks

Call this method to decrypt an XML document.

do_action method (XMLDecryptor 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 (XMLDecryptor Struct)

Resets the struct settings.

Syntax

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

Remarks

reset is a generic method available in every struct.

on_decryption_info_needed event (XMLDecryptor Struct)

Requests decryption information from the application.

Syntax

// XMLDecryptorDecryptionInfoNeededEventArgs carries the XMLDecryptor DecryptionInfoNeeded event's parameters.
pub struct XMLDecryptorDecryptionInfoNeededEventArgs {
  fn cancel_decryption(&self) -> bool
  fn set_cancel_decryption(&self, value : bool)
}

// XMLDecryptorDecryptionInfoNeededEvent defines the signature of the XMLDecryptor DecryptionInfoNeeded event's handler function.
pub trait XMLDecryptorDecryptionInfoNeededEvent {
  fn on_decryption_info_needed(&self, sender : XMLDecryptor, e : &mut XMLDecryptorDecryptionInfoNeededEventArgs);
}

impl <'a> XMLDecryptor<'a> {
  pub fn on_decryption_info_needed(&self) -> &'a dyn XMLDecryptorDecryptionInfoNeededEvent;
  pub fn set_on_decryption_info_needed(&mut self, value : &'a dyn XMLDecryptorDecryptionInfoNeededEvent);
  ...
}

Remarks

This event is fired when the component needs decryption information (the private key) from the user.

Use encrypt_key, Config["KeyName"] and key_encryption_type properties to identify the encryption type and then set decryption_key or key_decryption_key or key_decryption_certificate properties accordingly.

if CancelDecryption property is set to true value (default value) then decryption would fail if provided key/certificate is invalid. Otherwise this event would be fired again.

on_error event (XMLDecryptor Struct)

Information about errors during signing.

Syntax

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

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

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

Remarks

The event is fired in case of exceptional conditions during signing.

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

on_external_decrypt event (XMLDecryptor Struct)

Handles remote or external decryption.

Syntax

// XMLDecryptorExternalDecryptEventArgs carries the XMLDecryptor ExternalDecrypt event's parameters.
pub struct XMLDecryptorExternalDecryptEventArgs {
  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)
}

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

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

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_notification event (XMLDecryptor Struct)

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

Syntax

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

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

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

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_save_external_data event (XMLDecryptor Struct)

Request to save decrypted external data.

Syntax

// XMLDecryptorSaveExternalDataEventArgs carries the XMLDecryptor SaveExternalData event's parameters.
pub struct XMLDecryptorSaveExternalDataEventArgs {
  fn external_data(&self) -> &[u8]
}

// XMLDecryptorSaveExternalDataEvent defines the signature of the XMLDecryptor SaveExternalData event's handler function.
pub trait XMLDecryptorSaveExternalDataEvent {
  fn on_save_external_data(&self, sender : XMLDecryptor, e : &mut XMLDecryptorSaveExternalDataEventArgs);
}

impl <'a> XMLDecryptor<'a> {
  pub fn on_save_external_data(&self) -> &'a dyn XMLDecryptorSaveExternalDataEvent;
  pub fn set_on_save_external_data(&mut self, value : &'a dyn XMLDecryptorSaveExternalDataEvent);
  ...
}

Remarks

This event is fired when the component successfully decrypted an external data and needs to save it. The same data could be read using external_data property.

It makes sense to use this event when the XML document contains several xenc:EncryptedData elements and the component decrypts them all.

Config Settings (XMLDecryptor 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.

XMLDecryptor Config Settings

Base Config Settings

Trappable Errors (XMLDecryptor Struct)

XMLDecryptor Errors