XMLSigner Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

class secureblackbox.XMLSigner

Remarks

To sign the data, you need to specify the data to be signed using the references property, then select the signature type and signature method type (signature or MAC).

Set the path to the file to be signed via the input_file. Signed data will be saved in the output_file. Finally, call the sign method to generate a signature and save signed data. It is possible to generate a signature remotely: use sign_external method to do this.

Asynchronous signing is also supported. Call sign_async_begin to generate a signature and save the generated XML-DSIG without signature value into the document. To complete the signing, call sign_async_end.

XMLSigner only performs basic signing of XML documents. For richer features, such as XAdES and/or chain validation, please see the XAdESSigner class

Property List

---

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

Method List

---

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

Event List

---

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

Config Settings

---

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

canonicalization_method Property

Specifies XML canonicalization method to use.

Syntax

def get_canonicalization_method() -> int: ...
def set_canonicalization_method(value: int) -> None: ...

canonicalization_method = property(get_canonicalization_method, set_canonicalization_method)

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

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

Syntax

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

data_bytes = property(get_data_bytes, set_data_bytes)

Remarks

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

data_file Property

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

Syntax

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

data_file = property(get_data_file, set_data_file)

Default Value

""

Remarks

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

data_type Property

Specifies the external data type.

Syntax

def get_data_type() -> int: ...
def set_data_type(value: int) -> None: ...

data_type = property(get_data_type, set_data_type)

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

data_uri Property

Specifies a detached data resource URI.

Syntax

def get_data_uri() -> str: ...
def set_data_uri(value: str) -> None: ...

data_uri = property(get_data_uri, set_data_uri)

Default Value

""

Remarks

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

encoding Property

Specifies XML encoding.

Syntax

def get_encoding() -> str: ...
def set_encoding(value: str) -> None: ...

encoding = property(get_encoding, set_encoding)

Default Value

""

Remarks

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

external_crypto_async_document_id Property

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

Syntax

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

external_crypto_async_document_id = property(get_external_crypto_async_document_id, set_external_crypto_async_document_id)

Default Value

""

Remarks

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

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

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

external_crypto_custom_params Property

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

Syntax

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

external_crypto_custom_params = property(get_external_crypto_custom_params, set_external_crypto_custom_params)

Default Value

""

Remarks

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

external_crypto_data Property

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

Syntax

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

external_crypto_data = property(get_external_crypto_data, set_external_crypto_data)

Default Value

""

Remarks

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

external_crypto_external_hash_calculation Property

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

Syntax

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

external_crypto_external_hash_calculation = property(get_external_crypto_external_hash_calculation, set_external_crypto_external_hash_calculation)

Default Value

FALSE

Remarks

Specifies whether the message hash is to be calculated at the external endpoint. Please note that this mode is not supported by all components. In particular, components operating with larger objects (PDFSigner, CAdESSigner, XAdESSigner) do not support it.

external_crypto_hash_algorithm Property

Specifies the request's signature hash algorithm.

Syntax

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

external_crypto_hash_algorithm = property(get_external_crypto_hash_algorithm, set_external_crypto_hash_algorithm)

Default Value

"SHA256"

Remarks

Specifies the request's signature hash algorithm.

external_crypto_key_id Property

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

Syntax

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

external_crypto_key_id = property(get_external_crypto_key_id, set_external_crypto_key_id)

Default Value

""

Remarks

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

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

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

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

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

external_crypto_key_secret Property

The pre-shared key used for DC request authentication.

Syntax

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

external_crypto_key_secret = property(get_external_crypto_key_secret, set_external_crypto_key_secret)

Default Value

""

Remarks

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

Read more about configuring authentication in the external_crypto_key_id topic.

external_crypto_method Property

Specifies the asynchronous signing method.

Syntax

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

external_crypto_method = property(get_external_crypto_method, set_external_crypto_method)

Default Value

0

Remarks

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

Available options:

external_crypto_mode Property

Specifies the external cryptography mode.

Syntax

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

external_crypto_mode = property(get_external_crypto_mode, set_external_crypto_mode)

Default Value

0

Remarks

Specifies the external cryptography mode.

Available options:

external_crypto_public_key_algorithm Property

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

Syntax

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

external_crypto_public_key_algorithm = property(get_external_crypto_public_key_algorithm, set_external_crypto_public_key_algorithm)

Default Value

""

Remarks

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

fips_mode Property

Reserved.

Syntax

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

fips_mode = property(get_fips_mode, set_fips_mode)

Default Value

FALSE

Remarks

This property is reserved for future use.

hash_algorithm Property

Specifies the hash algorithm to be used.

Syntax

def get_hash_algorithm() -> str: ...
def set_hash_algorithm(value: str) -> None: ...

hash_algorithm = property(get_hash_algorithm, set_hash_algorithm)

Default Value

"SHA256"

Remarks

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

Supported values:

input_bytes Property

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

Syntax

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

input_bytes = property(get_input_bytes, set_input_bytes)

Remarks

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

input_file Property

Specifies the XML document to be signed.

Syntax

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

input_file = property(get_input_file, set_input_file)

Default Value

""

Remarks

Provide a path to the XML file to be signed.

output_bytes Property

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

Syntax

def get_output_bytes() -> bytes: ...

output_bytes = property(get_output_bytes, None)

Remarks

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

This property is read-only.

output_file Property

A file where the signed document is to be saved.

Syntax

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

output_file = property(get_output_file, set_output_file)

Default Value

""

Remarks

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

reference_count Property

The number of records in the Reference arrays.

Syntax

def get_reference_count() -> int: ...
def set_reference_count(value: int) -> None: ...

reference_count = property(get_reference_count, set_reference_count)

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_reference_type
• reference_signature_index
• reference_target_data
• reference_target_type
• reference_target_xml_element
• reference_uri
• reference_use_base64_transform
• reference_use_enveloped_signature_transform
• reference_use_xpath_filter2_transform
• reference_use_xpath_transform
• 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.

reference_auto_generate_element_id Property

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

Syntax

def get_reference_auto_generate_element_id(reference_index: int) -> bool: ...
def set_reference_auto_generate_element_id(reference_index: int, value: bool) -> None: ...

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

reference_canonicalization_method Property

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

Syntax

def get_reference_canonicalization_method(reference_index: int) -> int: ...
def set_reference_canonicalization_method(reference_index: int, value: int) -> None: ...

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

reference_custom_element_id Property

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

Syntax

def get_reference_custom_element_id(reference_index: int) -> str: ...
def set_reference_custom_element_id(reference_index: int, value: str) -> None: ...

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

reference_digest_value Property

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

Syntax

def get_reference_digest_value(reference_index: int) -> bytes: ...
def set_reference_digest_value(reference_index: int, value: bytes) -> None: ...

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

reference_handle Property

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

Syntax

def get_reference_handle(reference_index: int) -> int: ...
def set_reference_handle(reference_index: int, value: int) -> None: ...

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The reference_index parameter specifies the index of the item in the array. The size of the array is controlled by the reference_count property.

reference_hash_algorithm Property

Specifies the hash algorithm to be used.

Syntax

def get_reference_hash_algorithm(reference_index: int) -> str: ...
def set_reference_hash_algorithm(reference_index: int, value: str) -> None: ...

Default Value

"SHA256"

Remarks

Specifies the hash algorithm to be used.

Supported values:

The reference_index parameter specifies the index of the item in the array. The size of the array is controlled by the reference_count property.

reference_has_uri Property

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

Syntax

def get_reference_has_uri(reference_index: int) -> bool: ...
def set_reference_has_uri(reference_index: int, value: bool) -> None: ...

Default Value

TRUE

Remarks

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

The reference_index parameter specifies the index of the item in the array. The size of the array is controlled by the reference_count property.

reference_id Property

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

Syntax

def get_reference_id(reference_index: int) -> str: ...
def set_reference_id(reference_index: int, value: str) -> None: ...

Default Value

""

Remarks

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

The reference_index parameter specifies the index of the item in the array. The size of the array is controlled by the reference_count property.

reference_inclusive_namespaces_prefix_list Property

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

Syntax

def get_reference_inclusive_namespaces_prefix_list(reference_index: int) -> str: ...
def set_reference_inclusive_namespaces_prefix_list(reference_index: int, value: str) -> None: ...

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

reference_reference_type Property

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

Syntax

def get_reference_reference_type(reference_index: int) -> str: ...
def set_reference_reference_type(reference_index: int, value: str) -> None: ...

Default Value

""

Remarks

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

The reference_index parameter specifies the index of the item in the array. The size of the array is controlled by the reference_count property.

reference_signature_index Property

Returns the index of the owner signature, if applicable.

Syntax

def get_reference_signature_index(reference_index: int) -> int: ...

Default Value

-1

Remarks

Returns the index of the owner signature, if applicable.

Use this property to establish the index of the associated signature object in the signature collection.

The reference_index parameter specifies the index of the item in the array. The size of the array is controlled by the reference_count property.

This property is read-only.

reference_target_data Property

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

Syntax

def get_reference_target_data(reference_index: int) -> bytes: ...
def set_reference_target_data(reference_index: int, value: bytes) -> None: ...

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

reference_target_type Property

The reference's target type to use.

Syntax

def get_reference_target_type(reference_index: int) -> int: ...
def set_reference_target_type(reference_index: int, value: int) -> None: ...

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

reference_target_xml_element Property

This property specifies the referenced XML element.

Syntax

def get_reference_target_xml_element(reference_index: int) -> str: ...
def set_reference_target_xml_element(reference_index: int, value: str) -> None: ...

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

reference_uri Property

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

Syntax

def get_reference_uri(reference_index: int) -> str: ...
def set_reference_uri(reference_index: int, value: str) -> None: ...

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

reference_use_base64_transform Property

Specifies whether Base64 transform is included in transform chain.

Syntax

def get_reference_use_base64_transform(reference_index: int) -> bool: ...
def set_reference_use_base64_transform(reference_index: int, value: bool) -> None: ...

Default Value

FALSE

Remarks

Specifies whether Base64 transform is included in transform chain.

The reference_index parameter specifies the index of the item in the array. The size of the array is controlled by the reference_count property.

reference_use_enveloped_signature_transform Property

Specifies whether enveloped signature transform is included in transform chain.

Syntax

def get_reference_use_enveloped_signature_transform(reference_index: int) -> bool: ...
def set_reference_use_enveloped_signature_transform(reference_index: int, value: bool) -> None: ...

Default Value

FALSE

Remarks

Specifies whether enveloped signature transform is included in transform chain.

The reference_index parameter specifies the index of the item in the array. The size of the array is controlled by the reference_count property.

reference_use_xpath_filter2_transform Property

Specifies whether XPath Filter 2.

Syntax

def get_reference_use_xpath_filter2_transform(reference_index: int) -> bool: ...
def set_reference_use_xpath_filter2_transform(reference_index: int, value: bool) -> None: ...

Default Value

FALSE

Remarks

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

The reference_index parameter specifies the index of the item in the array. The size of the array is controlled by the reference_count property.

reference_use_xpath_transform Property

Specifies whether XPath transform is included in transform chain.

Syntax

def get_reference_use_xpath_transform(reference_index: int) -> bool: ...
def set_reference_use_xpath_transform(reference_index: int, value: bool) -> None: ...

Default Value

FALSE

Remarks

Specifies whether XPath transform is included in transform chain.

The reference_index parameter specifies the index of the item in the array. The size of the array is controlled by the reference_count property.

reference_xpath_expression Property

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

Syntax

def get_reference_xpath_expression(reference_index: int) -> str: ...
def set_reference_xpath_expression(reference_index: int, value: str) -> None: ...

Default Value

""

Remarks

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

The reference_index parameter specifies the index of the item in the array. The size of the array is controlled by the reference_count property.

reference_xpath_filter2_expressions Property

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

Syntax

def get_reference_xpath_filter2_expressions(reference_index: int) -> str: ...
def set_reference_xpath_filter2_expressions(reference_index: int, value: str) -> None: ...

Default Value

""

Remarks

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

The reference_index parameter specifies the index of the item in the array. The size of the array is controlled by the reference_count property.

reference_xpath_filter2_filters Property

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

Syntax

def get_reference_xpath_filter2_filters(reference_index: int) -> str: ...
def set_reference_xpath_filter2_filters(reference_index: int, value: str) -> None: ...

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

reference_xpath_filter2_prefix_list Property

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

Syntax

def get_reference_xpath_filter2_prefix_list(reference_index: int) -> str: ...
def set_reference_xpath_filter2_prefix_list(reference_index: int, value: str) -> None: ...

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

reference_xpath_prefix_list Property

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

Syntax

def get_reference_xpath_prefix_list(reference_index: int) -> str: ...
def set_reference_xpath_prefix_list(reference_index: int, value: str) -> None: ...

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

signature_type Property

The signature type to employ when signing the document.

Syntax

def get_signature_type() -> int: ...
def set_signature_type(value: int) -> None: ...

signature_type = property(get_signature_type, set_signature_type)

Default Value

4

Remarks

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

Supported values:

signing_cert_bytes Property

Returns raw certificate data in DER format.

Syntax

def get_signing_cert_bytes() -> bytes: ...

signing_cert_bytes = property(get_signing_cert_bytes, None)

Remarks

Returns raw certificate data in DER format.

This property is read-only.

signing_cert_handle Property

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

Syntax

def get_signing_cert_handle() -> int: ...
def set_signing_cert_handle(value: int) -> None: ...

signing_cert_handle = property(get_signing_cert_handle, set_signing_cert_handle)

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());

signing_chain_count Property

The number of records in the SigningChain arrays.

Syntax

def get_signing_chain_count() -> int: ...
def set_signing_chain_count(value: int) -> None: ...

signing_chain_count = property(get_signing_chain_count, set_signing_chain_count)

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.

signing_chain_bytes Property

Returns raw certificate data in DER format.

Syntax

def get_signing_chain_bytes(signing_chain_index: int) -> bytes: ...

Remarks

Returns raw certificate data in DER format.

The signing_chain_index parameter specifies the index of the item in the array. The size of the array is controlled by the signing_chain_count property.

This property is read-only.

signing_chain_handle Property

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

Syntax

def get_signing_chain_handle(signing_chain_index: int) -> int: ...
def set_signing_chain_handle(signing_chain_index: int, value: int) -> None: ...

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The signing_chain_index parameter specifies the index of the item in the array. The size of the array is controlled by the signing_chain_count property.

xml_element Property

Specifies the XML element where to save the signature data.

Syntax

def get_xml_element() -> str: ...
def set_xml_element(value: str) -> None: ...

xml_element = property(get_xml_element, set_xml_element)

Default Value

""

Remarks

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

Supported values are:

namespace_count Property

The number of records in the Namespace arrays.

Syntax

def get_namespace_count() -> int: ...
def set_namespace_count(value: int) -> None: ...

namespace_count = property(get_namespace_count, set_namespace_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• namespace_prefix
• namespace_uri

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

namespace_prefix Property

A user-defined prefix value of a namespace.

Syntax

def get_namespace_prefix(namespace_index: int) -> str: ...
def set_namespace_prefix(namespace_index: int, value: str) -> None: ...

Default Value

""

Remarks

A user-defined prefix value of a namespace.

The namespace_index parameter specifies the index of the item in the array. The size of the array is controlled by the namespace_count property.

namespace_uri Property

A user-defined URI value of a namespace.

Syntax

def get_namespace_uri(namespace_index: int) -> str: ...
def set_namespace_uri(namespace_index: int, value: str) -> None: ...

Default Value

""

Remarks

A user-defined URI value of a namespace.

The namespace_index parameter specifies the index of the item in the array. The size of the array is controlled by the namespace_count property.

add_data_reference Method

Creates a new XML reference to the specified data.

Syntax

def add_data_reference(data_uri: str, data: bytes) -> int: ...

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

Creates a new XML reference to the specified XML element.

Syntax

def add_reference(target_xml_element: str, custom_id: str, auto_generate_id: bool) -> int: ...

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

Sets or retrieves a configuration setting.

Syntax

def config(configuration_string: str) -> str: ...

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

do_action Method

Performs an additional action.

Syntax

def do_action(action_id: str, action_params: str) -> str: ...

Remarks

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

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

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

extract_async_data Method

Extracts user data from the DC signing service response.

Syntax

def extract_async_data(async_reply: str) -> str: ...

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 completion async stage.

get_inner_xml Method

Get the inner XML content of the selected XML element.

Syntax

def get_inner_xml(xpath: str) -> str: ...

Remarks

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

get_outer_xml Method

Get the outer XML content of the selected XML element.

Syntax

def get_outer_xml(xpath: str) -> str: ...

Remarks

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

get_text_content Method

Get the text content of the selected XML element.

Syntax

def get_text_content(xpath: str) -> str: ...

Remarks

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

set_inner_xml Method

Set the inner XML content of the selected XML element.

Syntax

def set_inner_xml(xpath: str, value: str) -> None: ...

Remarks

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

set_text_content Method

Set the text content of the selected XML element.

Syntax

def set_text_content(xpath: str, value: str) -> None: ...

Remarks

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

sign Method

Signs an XML document.

Syntax

def sign() -> None: ...

Remarks

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

sign_async_begin Method

Initiates the asynchronous signing operation.

Syntax

def sign_async_begin() -> str: ...

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. DC protocol is based on 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 control), which processes it and produces a matching signatures state. The async state produced by the server is then passed to the sign_async_end method.

sign_async_end Method

Completes the asynchronous signing operation.

Syntax

def sign_async_end(async_reply: str) -> None: ...

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 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. DC protocol is based on 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 control), which processes it and produces a matching signatures state. The async state produced by the server is then passed to the sign_async_end method.

sign_external Method

Signs the document using an external signing facility.

Syntax

def sign_external() -> None: ...

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 class fires on_external_sign event which allows to pass the hash value for signing.

on_error Event

Reports the details of signing errors.

Syntax

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

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

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

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

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

Syntax

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

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

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

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

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

# In class XMLSigner:
@property
def on_external_sign() -> Callable[[XMLSignerExternalSignEventParams], None]: ...
@on_external_sign.setter
def on_external_sign(event_hook: Callable[[XMLSignerExternalSignEventParams], None]) -> None: ...

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 component via SignedData parameter.

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

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

Reports the XML element that is currently being processed.

Syntax

class XMLSignerFormatElementEventParams(object):
  @property
  def start_tag_whitespace() -> str: ...
  @start_tag_whitespace.setter
  def start_tag_whitespace(value) -> None: ...

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

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

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

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

# In class XMLSigner:
@property
def on_format_element() -> Callable[[XMLSignerFormatElementEventParams], None]: ...
@on_format_element.setter
def on_format_element(event_hook: Callable[[XMLSignerFormatElementEventParams], None]) -> None: ...

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

Reports XML text that is currently being processed.

Syntax

class XMLSignerFormatTextEventParams(object):
  @property
  def text() -> str: ...
  @text.setter
  def text(value) -> None: ...

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

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

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

# In class XMLSigner:
@property
def on_format_text() -> Callable[[XMLSignerFormatTextEventParams], None]: ...
@on_format_text.setter
def on_format_text(event_hook: Callable[[XMLSignerFormatTextEventParams], None]) -> None: ...

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

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

Syntax

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

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

# In class XMLSigner:
@property
def on_notification() -> Callable[[XMLSignerNotificationEventParams], None]: ...
@on_notification.setter
def on_notification(event_hook: Callable[[XMLSignerNotificationEventParams], None]) -> None: ...

Remarks

The class fires this event to let the application know about some event, occurrence, or milestone in the component. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

The unique identifier of the event is provided in EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the component, the exact action it is performing, or the document being processed, one or both may be omitted.

on_resolve_reference Event

Asks the application to resolve a reference.

Syntax

class XMLSignerResolveReferenceEventParams(object):
  @property
  def reference_index() -> int: ...

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

# In class XMLSigner:
@property
def on_resolve_reference() -> Callable[[XMLSignerResolveReferenceEventParams], None]: ...
@on_resolve_reference.setter
def on_resolve_reference(event_hook: Callable[[XMLSignerResolveReferenceEventParams], None]) -> None: ...

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.

XMLSigner Config Settings

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the config method.

XMLSigner Config Settings

Base Config Settings

XMLSigner Errors

XMLSigner Errors

	1048577   Invalid parameter value (SB_ERROR_INVALID_PARAMETER)
	1048578   Class is configured incorrectly (SB_ERROR_INVALID_SETUP)
	1048579   Operation cannot be executed in the current state (SB_ERROR_INVALID_STATE)
	1048580   Attempt to set an invalid value to a property (SB_ERROR_INVALID_VALUE)
	1048581   Certificate does not have its private key loaded (SB_ERROR_NO_PRIVATE_KEY)
	1048581   Cancelled by the user (SB_ERROR_CANCELLED_BY_USER) 
	39845889   Input file does not exist (SB_ERROR_XML_INPUTFILE_NOT_EXISTS)
	39845890   Data file does not exist (SB_ERROR_XML_DATAFILE_NOT_EXISTS)
	39845891   Unsupported signature method type (SB_ERROR_XML_UNSUPPORTED_SIGNATURE_METHOD_TYPE)
	39845892   Unsupported has algorithm (SB_ERROR_XML_UNSUPPORTED_HASH_ALGORITHM)
	39845893   Unsupported key type (SB_ERROR_XML_UNSUPPORTED_KEY_TYPE)
	39845894   Invalid key type (SB_ERROR_XML_INVALID_KEY_TYPE)
	39845895   Invalid encryption method (SB_ERROR_XML_INVALID_ENCRYPTION_METHOD)
	39845896   Not found (SB_ERROR_XML_NOT_FOUND)
	39845897   No element ID (SB_ERROR_XML_NO_ELEMENT_ID)