Struct secureblackbox::XMLSigner

Properties   Methods   Events   Config Settings   Errors  

The XMLSigner struct provides a simple interface for digitally signing XML documents according to the XML-Signature Syntax and Processing specification.

Syntax

secureblackbox::XMLSigner

Remarks

XMLSigner implements the most basic XML-SIG signature standard. While this format is still quite widely used, it lacks important facilities that have been gaining popularity in recent years, such as strict chain validation, support for trust environments, and long-term signatures (also known as XAdES). If you are looking for XAdES support, please consider using the alternative XAdESSigner component.

To sign XML data with XMLSigner, you need to specify the data to be signed using the references property first, then select the signature type and signature method type (signature or MAC). References are individual pieces of the XML document that are covered by the signature. You can choose to sign the whole document or one or more individual elements.

Set the path to the file to be signed via the input_file (or input_bytes). Signed data will be saved in output_bytes, or the output_file if provided.

Finally, call the sign method to generate a signature and save the signed data. XMLSigner supports the two product-wide external signing approaches for signing with remote private keys: use sign_external or sign_async_begin to do this as required. XmlSigner.InputFile = "data.xml"; XmlSigner.OutputFile = "data-signed.xml"; XmlSigner.SigningCertificate = CertMgr.Certificate; XmlSigner.Sign();

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

canonicalization_method property (XMLSigner Struct)

Specifies XML canonicalization method to use.

Syntax

fn canonicalization_method(&self ) -> Result<i32, SecureBlackboxError> 
fn set_canonicalization_method(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // None
1   // Canon
2   // CanonComment
3   // ExclCanon
4   // ExclCanonComment
5   // MinCanon
6   // Canon_v1_1
7   // CanonComment_v1_1

Default Value

1

Remarks

Use this property to specify the method for XML canonicalization of SignedInfo element. See XML-Signature Syntax and Processing specification for details.

Supported canonicalization methods:

Data Type

i32

data_bytes property (XMLSigner Struct)

Use this property to pass the external 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

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

Data Type

Vec

data_file property (XMLSigner Struct)

A file containing the external data covered by a detached signature.

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

In the case of a detached signature, use this property to provide the external data to the struct from a file. Alternatively, provide the data via data_stream.

Data Type

String

data_type property (XMLSigner Struct)

Specifies the external data type.

Syntax

fn data_type(&self ) -> Result<i32, SecureBlackboxError> 
fn set_data_type(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // XML
1   // Binary
2   // Base64

Default Value

0

Remarks

Use this property to specify the type of the external data (either data_file, data_stream or data_bytes properties) for struct.

Data Type

i32

data_uri property (XMLSigner Struct)

Specifies a detached data resource URI.

Syntax

fn data_uri(&self ) -> Result<String, SecureBlackboxError> 
fn set_data_uri(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_data_uri_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Specifies a URI used for data being signed, usually the data filename if stored along with a detached signature.

Data Type

String

encoding property (XMLSigner 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

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

hash_algorithm property (XMLSigner Struct)

Specifies the hash algorithm to be used.

Syntax

fn hash_algorithm(&self ) -> Result<String, SecureBlackboxError> 
fn set_hash_algorithm(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_hash_algorithm_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

"SHA256"

Remarks

Use this property to set the hash algorithm for signature calculation.

Supported values:

Data Type

String

input_bytes property (XMLSigner 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 (XMLSigner Struct)

Specifies the XML document to be signed.

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 a path to the XML file to be signed.

Data Type

String

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

A file where the signed document is to 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

Provide a path to the file where the signed document is to be saved.

Data Type

String

reference_count property (XMLSigner Struct)

The number of records in the Reference arrays.

Syntax

fn reference_count(&self ) -> Result<i32, SecureBlackboxError> 
fn set_reference_count(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• reference_auto_generate_element_id
• reference_canonicalization_method
• reference_custom_element_id
• reference_digest_value
• reference_handle
• reference_hash_algorithm
• reference_has_uri
• reference_id
• reference_inclusive_namespaces_prefix_list
• reference_target_data
• reference_target_type
• reference_target_xml_element
• reference_type
• reference_uri
• reference_use_base64_transform
• reference_use_enveloped_signature_transform
• reference_use_xpath_filter2_transform
• reference_use_xpath_transform
• reference_validation_result
• reference_xpath_expression
• reference_xpath_filter2_expressions
• reference_xpath_filter2_filters
• reference_xpath_filter2_prefix_list
• reference_xpath_prefix_list

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

Data Type

i32

reference_auto_generate_element_id property (XMLSigner Struct)

Specifies whether the identifier (ID) attribute for a referenced (target) element should be auto-generated during signing.

Syntax

fn reference_auto_generate_element_id(&self , ReferenceIndex : i32) -> Result<bool, SecureBlackboxError> 
fn set_reference_auto_generate_element_id(&self, ReferenceIndex : i32, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

Specifies whether the identifier (ID) attribute for a referenced (target) element should be auto-generated during signing. Used when the referenced element doesn't have an ID and CustomElementId and URI properties are empty.

The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

Data Type

bool

reference_canonicalization_method property (XMLSigner Struct)

Use this property to specify the canonicalization method for the transform of the reference.

Syntax

fn reference_canonicalization_method(&self , ReferenceIndex : i32) -> Result<i32, SecureBlackboxError> 
fn set_reference_canonicalization_method(&self, ReferenceIndex : i32, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // None
1   // Canon
2   // CanonComment
3   // ExclCanon
4   // ExclCanonComment
5   // MinCanon
6   // Canon_v1_1
7   // CanonComment_v1_1

Default Value

0

Remarks

Use this property to specify the canonicalization method for the transform of the reference. Use cxcmNone value to not to include canonicalization transform in transform chain. See XML-Signature Syntax and Processing specification for details.

The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

Data Type

i32

reference_custom_element_id property (XMLSigner Struct)

Specifies a custom identifier (ID) attribute for a referenced (target) element that will be set on signing.

Syntax

fn reference_custom_element_id(&self , ReferenceIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_reference_custom_element_id(&self, ReferenceIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_reference_custom_element_id_ref(&self, ReferenceIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Specifies a custom identifier (ID) attribute for a referenced (target) element that will be set on signing. Used when the referenced element doesn't have an ID and URI property is empty.

The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

Data Type

String

reference_digest_value property (XMLSigner Struct)

Use this property to get or set the value of the digest calculated over the referenced data.

Syntax

fn reference_digest_value(&self , ReferenceIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 
fn set_reference_digest_value(&self, ReferenceIndex : i32, value : Vec<u8>) ->  Option<SecureBlackboxError> 
fn set_reference_digest_value_ref(&self, ReferenceIndex : i32, value : &[u8]) ->  Option<SecureBlackboxError> 

Remarks

Use this property to get or set the value of the digest calculated over the referenced data.

This property is optional and should be set only if you don't provide the actual data via TargetData or URI. If the data is set, then you don't need to set DigestValue since it will be calculated automatically.

The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

Data Type

Vec

reference_handle property (XMLSigner Struct)

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

Syntax

fn reference_handle(&self , ReferenceIndex : i32) -> Result<i64, SecureBlackboxError> 
fn set_reference_handle(&self, ReferenceIndex : 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 ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

Data Type

i64

reference_hash_algorithm property (XMLSigner Struct)

Specifies the hash algorithm to be used.

Syntax

fn reference_hash_algorithm(&self , ReferenceIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_reference_hash_algorithm(&self, ReferenceIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_reference_hash_algorithm_ref(&self, ReferenceIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

"SHA256"

Remarks

Specifies the hash algorithm to be used.

Supported values:

The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

Data Type

String

reference_has_uri property (XMLSigner Struct)

Specifies whether the URI is set (even when it is empty).

Syntax

fn reference_has_uri(&self , ReferenceIndex : i32) -> Result<bool, SecureBlackboxError> 
fn set_reference_has_uri(&self, ReferenceIndex : i32, value : bool) ->  Option<SecureBlackboxError> 

Default Value

true

Remarks

Specifies whether the URI is set (even when it is empty).

The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

Data Type

bool

reference_id property (XMLSigner Struct)

A user-defined identifier (ID) attribute of this Reference element.

Syntax

fn reference_id(&self , ReferenceIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_reference_id(&self, ReferenceIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_reference_id_ref(&self, ReferenceIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

A user-defined identifier (ID) attribute of this Reference element.

The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

Data Type

String

reference_inclusive_namespaces_prefix_list property (XMLSigner Struct)

Use this property to specify InclusiveNamespaces PrefixList for exclusive canonicalization transform of the reference.

Syntax

fn reference_inclusive_namespaces_prefix_list(&self , ReferenceIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_reference_inclusive_namespaces_prefix_list(&self, ReferenceIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_reference_inclusive_namespaces_prefix_list_ref(&self, ReferenceIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Use this property to specify InclusiveNamespaces PrefixList for exclusive canonicalization transform of the reference. See XML-Signature Syntax and Processing specification for details.

The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

Data Type

String

reference_type property (XMLSigner Struct)

The Reference's type attribute as defined in XMLDSIG specification.

Syntax

fn reference_type(&self , ReferenceIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_reference_type(&self, ReferenceIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_reference_type_ref(&self, ReferenceIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The Reference's type attribute as defined in XMLDSIG specification.

The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

Data Type

String

reference_target_data property (XMLSigner Struct)

Contains the referenced external data when the digest value is not explicitly specified.

Syntax

fn reference_target_data(&self , ReferenceIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 
fn set_reference_target_data(&self, ReferenceIndex : i32, value : Vec<u8>) ->  Option<SecureBlackboxError> 
fn set_reference_target_data_ref(&self, ReferenceIndex : i32, value : &[u8]) ->  Option<SecureBlackboxError> 

Remarks

Contains the referenced external data when the digest value is not explicitly specified.

This property is optional and should only be set if you reference the external data via URI, and you don't provide the digest value explicitly via DigestValue.

The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

Data Type

Vec

reference_target_type property (XMLSigner Struct)

The reference's target type to use.

Syntax

fn reference_target_type(&self , ReferenceIndex : i32) -> Result<i32, SecureBlackboxError> 
fn set_reference_target_type(&self, ReferenceIndex : i32, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // Auto
1   // XMLElement
2   // Data
3   // URI

Default Value

0

Remarks

The reference's target type to use.

Use this property to specify the reference's target type to use when forming the signature.

The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

Data Type

i32

reference_target_xml_element property (XMLSigner Struct)

This property specifies the referenced XML element.

Syntax

fn reference_target_xml_element(&self , ReferenceIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_reference_target_xml_element(&self, ReferenceIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_reference_target_xml_element_ref(&self, ReferenceIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

This property specifies the referenced XML element. Used when the URI property is not set. In this case, the URI value is generated based on the ID of the referenced (target) XML element. If the URI property is set, this property is ignored until the ResolveReference event.

Supported values are:

The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

Data Type

String

reference_uri property (XMLSigner Struct)

Use this property to get or set the URL which references the data.

Syntax

fn reference_uri(&self , ReferenceIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_reference_uri(&self, ReferenceIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_reference_uri_ref(&self, ReferenceIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Use this property to get or set the URL which references the data. If the data is external, the application must set either TargetData or DigestValue. If TargetData is set, the digest is calculated automatically unless it is explicitly set by the application via DigestValue.

The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

Data Type

String

reference_use_base64_transform property (XMLSigner Struct)

Specifies whether Base64 transform is included in transform chain.

Syntax

fn reference_use_base64_transform(&self , ReferenceIndex : i32) -> Result<bool, SecureBlackboxError> 
fn set_reference_use_base64_transform(&self, ReferenceIndex : i32, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

Specifies whether Base64 transform is included in transform chain.

The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

Data Type

bool

reference_use_enveloped_signature_transform property (XMLSigner Struct)

Specifies whether enveloped signature transform is included in transform chain.

Syntax

fn reference_use_enveloped_signature_transform(&self , ReferenceIndex : i32) -> Result<bool, SecureBlackboxError> 
fn set_reference_use_enveloped_signature_transform(&self, ReferenceIndex : i32, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

Specifies whether enveloped signature transform is included in transform chain.

The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

Data Type

bool

reference_use_xpath_filter2_transform property (XMLSigner Struct)

Specifies whether XPath Filter 2.

Syntax

fn reference_use_xpath_filter2_transform(&self , ReferenceIndex : i32) -> Result<bool, SecureBlackboxError> 
fn set_reference_use_xpath_filter2_transform(&self, ReferenceIndex : i32, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

Specifies whether XPath Filter 2.0 transform is included in transform chain.

The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

Data Type

bool

reference_use_xpath_transform property (XMLSigner Struct)

Specifies whether XPath transform is included in transform chain.

Syntax

fn reference_use_xpath_transform(&self , ReferenceIndex : i32) -> Result<bool, SecureBlackboxError> 
fn set_reference_use_xpath_transform(&self, ReferenceIndex : i32, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

Specifies whether XPath transform is included in transform chain.

The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

Data Type

bool

reference_validation_result property (XMLSigner Struct)

The outcome of the cryptographic reference validation.

Syntax

fn reference_validation_result(&self , ReferenceIndex : i32) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

The outcome of the cryptographic reference validation.

The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

This property is read-only.

Data Type

bool

reference_xpath_expression property (XMLSigner Struct)

Use this property to specify XPath expression for XPath transform of the reference.

Syntax

fn reference_xpath_expression(&self , ReferenceIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_reference_xpath_expression(&self, ReferenceIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_reference_xpath_expression_ref(&self, ReferenceIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Use this property to specify XPath expression for XPath transform of the reference.

The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

Data Type

String

reference_xpath_filter2_expressions property (XMLSigner Struct)

Use this property to specify XPointer expression(s) for XPath Filter 2.

Syntax

fn reference_xpath_filter2_expressions(&self , ReferenceIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_reference_xpath_filter2_expressions(&self, ReferenceIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_reference_xpath_filter2_expressions_ref(&self, ReferenceIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Use this property to specify XPointer expression(s) for XPath Filter 2.0 transform of the reference.

The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

Data Type

String

reference_xpath_filter2_filters property (XMLSigner Struct)

Use this property to specify XPointer filter(s) for XPath Filter 2.

Syntax

fn reference_xpath_filter2_filters(&self , ReferenceIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_reference_xpath_filter2_filters(&self, ReferenceIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_reference_xpath_filter2_filters_ref(&self, ReferenceIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Use this property to specify XPointer filter(s) for XPath Filter 2.0 transform of the reference. The prefix list is comma-separated.

Supported values:

The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

Data Type

String

reference_xpath_filter2_prefix_list property (XMLSigner Struct)

Use this property to specify a prefix list for XPath Filter 2.

Syntax

fn reference_xpath_filter2_prefix_list(&self , ReferenceIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_reference_xpath_filter2_prefix_list(&self, ReferenceIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_reference_xpath_filter2_prefix_list_ref(&self, ReferenceIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Use this property to specify a prefix list for XPath Filter 2.0 transform of the reference. The prefix list is space-separated. Namespace URIs that are used are taken from XPathNamespaces property.

The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

Data Type

String

reference_xpath_prefix_list property (XMLSigner Struct)

Use this property to specify a prefix list for XPath transform of the reference.

Syntax

fn reference_xpath_prefix_list(&self , ReferenceIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_reference_xpath_prefix_list(&self, ReferenceIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_reference_xpath_prefix_list_ref(&self, ReferenceIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Use this property to specify a prefix list for XPath transform of the reference. The prefix list is space-separated. Namespace URIs that are used are taken from XPathNamespaces property.

The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

Data Type

String

signature_type property (XMLSigner Struct)

The signature type to employ when signing the document.

Syntax

fn signature_type(&self ) -> Result<i32, SecureBlackboxError> 
fn set_signature_type(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

1   // Detached
2   // Enveloping
4   // Enveloped

Default Value

4

Remarks

This property specifies the signature type to be used when signing the document.

Supported values:

Data Type

i32

signing_cert_bytes property (XMLSigner Struct)

Returns the raw certificate data in DER format.

Syntax

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

Remarks

Returns the raw certificate data in DER format.

This property is read-only.

Data Type

Vec

signing_cert_handle property (XMLSigner Struct)

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

Syntax

fn signing_cert_handle(&self ) -> Result<i64, SecureBlackboxError> 
fn set_signing_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

signing_chain_count property (XMLSigner Struct)

The number of records in the SigningChain arrays.

Syntax

fn signing_chain_count(&self ) -> Result<i32, SecureBlackboxError> 
fn set_signing_chain_count(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• signing_chain_bytes
• signing_chain_handle

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

Data Type

i32

signing_chain_bytes property (XMLSigner Struct)

Returns the raw certificate data in DER format.

Syntax

fn signing_chain_bytes(&self , SigningChainIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

Returns the raw certificate data in DER format.

The SigningChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SigningChainCount property.

This property is read-only.

Data Type

Vec

signing_chain_handle property (XMLSigner Struct)

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

Syntax

fn signing_chain_handle(&self , SigningChainIndex : i32) -> Result<i64, SecureBlackboxError> 
fn set_signing_chain_handle(&self, SigningChainIndex : 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 SigningChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SigningChainCount property.

Data Type

i64

xml_element property (XMLSigner Struct)

Specifies the XML element where to save the signature data.

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

This property specifies the XML element where to save the electronic signature.

Supported values are:

Data Type

String

add_data_reference method (XMLSigner Struct)

Creates a new XML reference to the specified data.

Syntax

fn add_data_reference(&self, data_uri : &str, data : &[u8]) ->  Result<i32, SecureBlackboxError>

Remarks

Use this method to add a reference to the custom data. Pass the reference's URI via DataURI parameter.

This method uses hash_algorithm property to specify the hash algorithm of the reference.

The method returns the index of the new reference entry in the references collection.

add_known_namespace method (XMLSigner 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.

add_reference method (XMLSigner Struct)

Creates a new XML reference to the specified XML element.

Syntax

fn add_reference(&self, target_xml_element : &str, custom_id : &str, auto_generate_id : bool) ->  Result<i32, SecureBlackboxError>

Remarks

Use this method to add a reference to a particular XML element.

The reference's URI is set basing on the ID of the XML element. If the XML element doesn't have an ID then a CustomId value will be used. If CustomId is empty and AutoGenerateId is set, the ID will be generated automatically. An exception will be thrown otherwise.

This method uses canonicalization_method and hash_algorithm properties to specify the canonicalization method and hash algorithm of the reference.

The method returns the index of the new reference entry in the references collection.

config method (XMLSigner 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.

do_action method (XMLSigner 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:

extract_async_data method (XMLSigner Struct)

Extracts user data from the DC signing service response.

Syntax

fn extract_async_data(&self, async_reply : &str) ->  Result<String, SecureBlackboxError>

Remarks

Call this method before finalizing the asynchronous signing process to extract the data passed to the ExternalCrypto.Data property on the pre-signing stage.

The Data parameter can be used to pass some state or document identifier along with the signing request from the pre-signing to the completion async stage.

get_inner_xml method (XMLSigner Struct)

Get the inner XML content of the selected XML element.

Syntax

fn get_inner_xml(&self, xpath : &str) ->  Result<String, SecureBlackboxError>

Remarks

Call this method to get the inner XML content of the selected XML element.

get_outer_xml method (XMLSigner Struct)

Get the outer XML content of the selected XML element.

Syntax

fn get_outer_xml(&self, xpath : &str) ->  Result<String, SecureBlackboxError>

Remarks

Call this method to get the outer XML content of the selected XML element.

get_text_content method (XMLSigner Struct)

Get the text content of the selected XML element.

Syntax

fn get_text_content(&self, xpath : &str) ->  Result<String, SecureBlackboxError>

Remarks

Call this method to get the text content of the selected XML element.

reset method (XMLSigner Struct)

Resets the struct settings.

Syntax

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

Remarks

reset is a generic method available in every struct.

set_inner_xml method (XMLSigner Struct)

Set the inner XML content of the selected XML element.

Syntax

fn set_inner_xml(&self, xpath : &str, value : &str) -> Result<(), SecureBlackboxError>

Remarks

Call this method to set the inner XML content of the selected XML element.

set_text_content method (XMLSigner Struct)

Set the text content of the selected XML element.

Syntax

fn set_text_content(&self, xpath : &str, value : &str) -> Result<(), SecureBlackboxError>

Remarks

Call this method to set the text content of the selected XML element.

sign method (XMLSigner Struct)

Signs an XML document.

Syntax

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

Remarks

Call this method to generate a signature over an XML document.

sign_async_begin method (XMLSigner Struct)

Initiates the asynchronous signing operation.

Syntax

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

Remarks

When using the DC framework, call this method to initiate the asynchronous signing process. Upon completion, a pre-signed copy of the document will be saved in output_file (or output_stream). Keep the pre-signed copy somewhere local, and pass the returned string ('the request state') to the DC processor for handling.

Upon receiving the response state from the DC processor, assign the path to the pre-signed copy to input_file (or input_stream), and call sign_async_end to finalize the signing.

Note that depending on the signing method and DC configuration used, you may still need to provide the public part of the signing certificate via the signing_certificate property.

Use the ExternalCrypto.AsyncDocumentID property to supply a unique document ID to include in the request. This is helpful when creating batches of multiple async requests, as it allows you to pass the whole response batch to sign_async_end and expect it to recover the correct response from the batch automatically.

AsyncState is a message of the distributed cryptography (DC) protocol. The DC protocol is based on the exchange of async states between a DC client (an application that wants to sign a PDF, XML, or Office document) and a DC server (an application that controls access to the private key). An async state can carry one or more signing requests, comprised of document hashes, or one or more signatures produced over those hashes.

In a typical scenario you get a client-side async state from the sign_async_begin method. This state contains document hashes to be signed on the DC server side. You then send the async state to the DC server (often represented by the DCAuth struct), which processes it and produces a matching signature state. The async state produced by the server is then passed to the sign_async_end method.

sign_async_end method (XMLSigner Struct)

Completes the asynchronous signing operation.

Syntax

fn sign_async_end(&self, async_reply : &str) -> Result<(), SecureBlackboxError>

Remarks

When using the DC framework, call this method upon receiving the response state from the DC processor to complete the asynchronous signing process.

Before calling this method, assign the path to the pre-signed copy of the document obtained from the prior sign_async_begin call to input_file (or input_stream). The method will embed the signature into the pre-signed document, and save the complete signed document to output_file (or output_stream).

Note that depending on the signing method and DC configuration used, you may still need to provide the public part of the signing certificate via the signing_certificate property.

Use the ExternalCrypto.AsyncDocumentID parameter to pass a specific document ID if using batched AsyncReply. If used, it should match the value provided on the pre-signing (sign_async_begin) stage.

AsyncState is a message of the distributed cryptography (DC) protocol. The DC protocol is based on the exchange of async states between a DC client (an application that wants to sign a PDF, XML, or Office document) and a DC server (an application that controls access to the private key). An async state can carry one or more signing requests, comprised of document hashes, or one or more signatures produced over those hashes.

In a typical scenario you get a client-side async state from the sign_async_begin method. This state contains document hashes to be signed on the DC server side. You then send the async state to the DC server (often represented by the DCAuth struct), which processes it and produces a matching signature state. The async state produced by the server is then passed to the sign_async_end method.

sign_external method (XMLSigner Struct)

Signs the document using an external signing facility.

Syntax

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

Remarks

Call this method to delegate the low-level signing operation to an external, remote, or custom signing engine. This method is useful if the signature has to be made by a device accessible through a custom or non-standard signing interface.

When all preparations are done and hash is computed, the struct fires on_external_sign event which allows to pass the hash value for signing.

on_error event (XMLSigner Struct)

Reports the details of signing errors.

Syntax

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

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

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

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. For a list of valid error codes and their descriptions, please refer to XML.

on_external_sign event (XMLSigner Struct)

Handles remote or external signing initiated by the SignExternal method or other source.

Syntax

// XMLSignerExternalSignEventArgs carries the XMLSigner ExternalSign event's parameters.
pub struct XMLSignerExternalSignEventArgs {
  fn operation_id(&self) -> &String
  fn hash_algorithm(&self) -> &String
  fn pars(&self) -> &String
  fn data(&self) -> &String
  fn signed_data(&self) -> &String
  fn set_signed_data(&self, value : &str)
  fn set_signed_data_ref(&self, value : &String)
}

// XMLSignerExternalSignEvent defines the signature of the XMLSigner ExternalSign event's handler function.
pub trait XMLSignerExternalSignEvent {
  fn on_external_sign(&self, sender : XMLSigner, e : &mut XMLSignerExternalSignEventArgs);
}

impl <'a> XMLSigner<'a> {
  pub fn on_external_sign(&self) -> &'a dyn XMLSignerExternalSignEvent;
  pub fn set_on_external_sign(&mut self, value : &'a dyn XMLSignerExternalSignEvent);
  ...
}

Remarks

Assign a handler to this event if you need to delegate a low-level signing operation to an external, remote, or custom signing engine. Depending on the settings, the handler will receive a hashed or unhashed value to be signed.

The event handler must pass the value of Data to the signer, obtain the signature, and pass it back to the struct via the SignedData parameter.

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

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

A sample MD5 hash encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16

A sample event handler that uses the .NET RSACryptoServiceProvider class may look like the following: signer.OnExternalSign += (s, e) => { var cert = new X509Certificate2("cert.pfx", "", X509KeyStorageFlags.Exportable); var key = (RSACryptoServiceProvider)cert.PrivateKey; var dataToSign = e.Data.FromBase16String(); var signedData = key.SignHash(dataToSign, "2.16.840.1.101.3.4.2.1"); e.SignedData = signedData.ToBase16String(); };

on_format_element event (XMLSigner Struct)

Reports the XML element that is currently being processed.

Syntax

// XMLSignerFormatElementEventArgs carries the XMLSigner FormatElement event's parameters.
pub struct XMLSignerFormatElementEventArgs {
  fn start_tag_whitespace(&self) -> &String
  fn set_start_tag_whitespace(&self, value : &str)
  fn set_start_tag_whitespace_ref(&self, value : &String)
  fn end_tag_whitespace(&self) -> &String
  fn set_end_tag_whitespace(&self, value : &str)
  fn set_end_tag_whitespace_ref(&self, value : &String)
  fn level(&self) -> i32
  fn path(&self) -> &String
  fn has_child_elements(&self) -> bool
}

// XMLSignerFormatElementEvent defines the signature of the XMLSigner FormatElement event's handler function.
pub trait XMLSignerFormatElementEvent {
  fn on_format_element(&self, sender : XMLSigner, e : &mut XMLSignerFormatElementEventArgs);
}

impl <'a> XMLSigner<'a> {
  pub fn on_format_element(&self) -> &'a dyn XMLSignerFormatElementEvent;
  pub fn set_on_format_element(&mut self, value : &'a dyn XMLSignerFormatElementEvent);
  ...
}

Remarks

Path and Level specify the path to the XML element being processed and its nesting level, respectively.

HasChildElements specify if processed XML element has child elements.

Among other purposes, this event may be used to add whitespace formatting before or after a particular element in the signature.

on_format_text event (XMLSigner Struct)

Reports XML text that is currently being processed.

Syntax

// XMLSignerFormatTextEventArgs carries the XMLSigner FormatText event's parameters.
pub struct XMLSignerFormatTextEventArgs {
  fn text(&self) -> &String
  fn set_text(&self, value : &str)
  fn set_text_ref(&self, value : &String)
  fn text_type(&self) -> i32
  fn level(&self) -> i32
  fn path(&self) -> &String
}

// XMLSignerFormatTextEvent defines the signature of the XMLSigner FormatText event's handler function.
pub trait XMLSignerFormatTextEvent {
  fn on_format_text(&self, sender : XMLSigner, e : &mut XMLSignerFormatTextEventArgs);
}

impl <'a> XMLSigner<'a> {
  pub fn on_format_text(&self) -> &'a dyn XMLSignerFormatTextEvent;
  pub fn set_on_format_text(&mut self, value : &'a dyn XMLSignerFormatTextEvent);
  ...
}

Remarks

TextType parameter specifies the type of the XML text (normal or Base64-encoded) that is stored in the element; Path and Level specify the path to the XML element and its nesting level.

Among other purposes, this event may be used to add whitespace formatting before or after a particular element in the signature.

on_notification event (XMLSigner Struct)

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

Syntax

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

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

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

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.

This struct can fire this event with the following EventID values:

on_resolve_reference event (XMLSigner Struct)

Asks the application to resolve a reference.

Syntax

// XMLSignerResolveReferenceEventArgs carries the XMLSigner ResolveReference event's parameters.
pub struct XMLSignerResolveReferenceEventArgs {
  fn reference_index(&self) -> i32
  fn uri(&self) -> &String
}

// XMLSignerResolveReferenceEvent defines the signature of the XMLSigner ResolveReference event's handler function.
pub trait XMLSignerResolveReferenceEvent {
  fn on_resolve_reference(&self, sender : XMLSigner, e : &mut XMLSignerResolveReferenceEventArgs);
}

impl <'a> XMLSigner<'a> {
  pub fn on_resolve_reference(&self) -> &'a dyn XMLSignerResolveReferenceEvent;
  pub fn set_on_resolve_reference(&mut self, value : &'a dyn XMLSignerResolveReferenceEvent);
  ...
}

Remarks

This event is fired when the control could not automatically resolve a reference and requires custom treatment.

URI contains a reference to the data.

ReferenceIndex specifies the index of the reference to process.

Based on the reference's URI the event handler should set either TargetXMLElement or TargetData property of the reference.

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

XMLSigner Config Settings

Base Config Settings

Trappable Errors (XMLSigner Struct)

XMLSigner Errors