Struct secureblackbox::SOAPClient

Properties   Methods   Events   Config Settings   Errors  

The SOAPClient struct sends SOAP messages.

Syntax

secureblackbox::SOAPClient

Remarks

The SOAPClient struct implements client-side functionality of the SOAP version 1.1 and 1.2 protocols over HTTP/HTTPS.

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

attachment_bytes property (SOAPClient Struct)

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

Syntax

fn attachment_bytes(&self ) -> Result<Vec<u8>, SecureBlackboxError> 
fn set_attachment_bytes(&self, value : Vec<u8>) ->  Option<SecureBlackboxError> 
fn set_attachment_bytes_ref(&self, value : &[u8]) ->  Option<SecureBlackboxError> 

Remarks

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

Data Type

Vec

attachment_file property (SOAPClient Struct)

Specifies the attachment file to be sent with the request.

Syntax

fn attachment_file(&self ) -> Result<String, SecureBlackboxError> 
fn set_attachment_file(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_attachment_file_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Provide a full path to the attachment file to be sent with the SOAP request. Use send_message_with_attachments method to send the request.

Subscribe to on_before_send_attachment to pass more than one attachment.

Data Type

String

auth_types property (SOAPClient Struct)

Defines allowed HTTP authentication types.

Syntax

fn auth_types(&self ) -> Result<i32, SecureBlackboxError> 
fn set_auth_types(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

Use this property to define which authentication types the component should support or attempt to use by enabling the relevant bitmask flags:

Data Type

i32

blocked_cert_count property (SOAPClient Struct)

The number of records in the BlockedCert arrays.

Syntax

fn blocked_cert_count(&self ) -> Result<i32, SecureBlackboxError> 
fn set_blocked_cert_count(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• blocked_cert_bytes
• blocked_cert_handle

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

Data Type

i32

blocked_cert_bytes property (SOAPClient Struct)

Returns the raw certificate data in DER format.

Syntax

fn blocked_cert_bytes(&self , BlockedCertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

Returns the raw certificate data in DER format.

The BlockedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BlockedCertCount property.

This property is read-only.

Data Type

Vec

blocked_cert_handle property (SOAPClient Struct)

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

Syntax

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

Data Type

i64

conn_info_aead_cipher property (SOAPClient Struct)

Indicates whether the encryption algorithm used is an AEAD cipher.

Syntax

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

Default Value

false

Remarks

Indicates whether the encryption algorithm used is an AEAD cipher.

This property is read-only.

Data Type

bool

conn_info_chain_validation_details property (SOAPClient Struct)

The details of a certificate chain validation outcome.

Syntax

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

Default Value

0

Remarks

The details of a certificate chain validation outcome. They may often suggest the reasons that contributed to the overall validation result.

Returns a bit mask of the following options:

This property is read-only.

Data Type

i32

conn_info_chain_validation_result property (SOAPClient Struct)

The outcome of a certificate chain validation routine.

Syntax

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

Possible Values

0   // Valid
1   // ValidButUntrusted
2   // Invalid
3   // CantBeEstablished

Default Value

0

Remarks

The outcome of a certificate chain validation routine.

Available options:

Use the ValidationLog property to access the detailed validation log.

This property is read-only.

Data Type

i32

conn_info_ciphersuite property (SOAPClient Struct)

The cipher suite employed by this connection.

Syntax

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

Default Value

""

Remarks

The cipher suite employed by this connection.

For TLS connections, this property returns the ciphersuite that was/is employed by the connection.

This property is read-only.

Data Type

String

conn_info_client_authenticated property (SOAPClient Struct)

Specifies whether client authentication was performed during this connection.

Syntax

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

Default Value

false

Remarks

Specifies whether client authentication was performed during this connection.

This property is read-only.

Data Type

bool

conn_info_client_auth_requested property (SOAPClient Struct)

Specifies whether client authentication was requested during this connection.

Syntax

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

Default Value

false

Remarks

Specifies whether client authentication was requested during this connection.

This property is read-only.

Data Type

bool

conn_info_connection_established property (SOAPClient Struct)

Indicates whether the connection has been established fully.

Syntax

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

Default Value

false

Remarks

Indicates whether the connection has been established fully.

This property is read-only.

Data Type

bool

conn_info_connection_id property (SOAPClient Struct)

The unique identifier assigned to this connection.

Syntax

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

Remarks

The unique identifier assigned to this connection.

This property is read-only.

Data Type

Vec

conn_info_digest_algorithm property (SOAPClient Struct)

The digest algorithm used in a TLS-enabled connection.

Syntax

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

Default Value

""

Remarks

The digest algorithm used in a TLS-enabled connection.

This property is read-only.

Data Type

String

conn_info_encryption_algorithm property (SOAPClient Struct)

The symmetric encryption algorithm used in a TLS-enabled connection.

Syntax

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

Default Value

""

Remarks

The symmetric encryption algorithm used in a TLS-enabled connection.

This property is read-only.

Data Type

String

conn_info_exportable property (SOAPClient Struct)

Indicates whether a TLS connection uses a reduced-strength exportable cipher.

Syntax

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

Default Value

false

Remarks

Indicates whether a TLS connection uses a reduced-strength exportable cipher.

This property is read-only.

Data Type

bool

conn_info_group property (SOAPClient Struct)

The elliptic curve used in this connection.

Syntax

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

Default Value

""

Remarks

The elliptic curve used in this connection.

This property was named NamedECCurve in SecureBlackbox 2024 and earlier versions.

This property is read-only.

Data Type

String

conn_info_id property (SOAPClient Struct)

The client connection's unique identifier.

Syntax

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

Default Value

-1

Remarks

The client connection's unique identifier. This value is used throughout to refer to a particular client connection.

This property is read-only.

Data Type

i64

conn_info_key_exchange_algorithm property (SOAPClient Struct)

The key exchange algorithm used in a TLS-enabled connection.

Syntax

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

Default Value

""

Remarks

The key exchange algorithm used in a TLS-enabled connection.

This property is read-only.

Data Type

String

conn_info_key_exchange_key_bits property (SOAPClient Struct)

The length of the key exchange key of a TLS-enabled connection.

Syntax

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

Default Value

0

Remarks

The length of the key exchange key of a TLS-enabled connection.

This property is read-only.

Data Type

i32

conn_info_pfs_cipher property (SOAPClient Struct)

Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS).

Syntax

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

Default Value

false

Remarks

Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS).

This property is read-only.

Data Type

bool

conn_info_pre_shared_identity property (SOAPClient Struct)

Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.

Syntax

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

Default Value

""

Remarks

Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.

This property is read-only.

Data Type

String

conn_info_pre_shared_identity_hint property (SOAPClient Struct)

A hint professed by the server to help the client select the PSK identity to use.

Syntax

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

Default Value

""

Remarks

A hint professed by the server to help the client select the PSK identity to use.

This property is read-only.

Data Type

String

conn_info_public_key_bits property (SOAPClient Struct)

The length of the public key.

Syntax

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

Default Value

0

Remarks

The length of the public key.

This property is read-only.

Data Type

i32

conn_info_remote_address property (SOAPClient Struct)

The client's IP address.

Syntax

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

Default Value

""

Remarks

The client's IP address.

This property is read-only.

Data Type

String

conn_info_remote_port property (SOAPClient Struct)

The remote port of the client connection.

Syntax

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

Default Value

0

Remarks

The remote port of the client connection.

This property is read-only.

Data Type

i32

conn_info_resumed_session property (SOAPClient Struct)

Indicates whether a TLS-enabled connection was spawned from another TLS connection.

Syntax

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

Default Value

false

Remarks

Indicates whether a TLS-enabled connection was spawned from another TLS connection

This property is read-only.

Data Type

bool

conn_info_secure_connection property (SOAPClient Struct)

Indicates whether TLS or SSL is enabled for this connection.

Syntax

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

Default Value

false

Remarks

Indicates whether TLS or SSL is enabled for this connection.

This property is read-only.

Data Type

bool

conn_info_server_authenticated property (SOAPClient Struct)

Indicates whether server authentication was performed during a TLS-enabled connection.

Syntax

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

Default Value

false

Remarks

Indicates whether server authentication was performed during a TLS-enabled connection.

This property is read-only.

Data Type

bool

conn_info_signature_algorithm property (SOAPClient Struct)

The signature algorithm used in a TLS handshake.

Syntax

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

Default Value

""

Remarks

The signature algorithm used in a TLS handshake.

This property is read-only.

Data Type

String

conn_info_symmetric_block_size property (SOAPClient Struct)

The block size of the symmetric algorithm used.

Syntax

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

Default Value

0

Remarks

The block size of the symmetric algorithm used.

This property is read-only.

Data Type

i32

conn_info_symmetric_key_bits property (SOAPClient Struct)

The key length of the symmetric algorithm used.

Syntax

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

Default Value

0

Remarks

The key length of the symmetric algorithm used.

This property is read-only.

Data Type

i32

conn_info_total_bytes_received property (SOAPClient Struct)

The total number of bytes received over this connection.

Syntax

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

Default Value

0

Remarks

The total number of bytes received over this connection.

This property is read-only.

Data Type

i64

conn_info_total_bytes_sent property (SOAPClient Struct)

The total number of bytes sent over this connection.

Syntax

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

Default Value

0

Remarks

The total number of bytes sent over this connection.

This property is read-only.

Data Type

i64

conn_info_validation_log property (SOAPClient Struct)

Contains the server certificate's chain validation log.

Syntax

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

Default Value

""

Remarks

Contains the server certificate's chain validation log. This information may be very useful in investigating chain validation failures.

This property is read-only.

Data Type

String

conn_info_version property (SOAPClient Struct)

Indicates the version of SSL/TLS protocol negotiated during this connection.

Syntax

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

Default Value

""

Remarks

Indicates the version of SSL/TLS protocol negotiated during this connection.

This property is read-only.

Data Type

String

encoding property (SOAPClient Struct)

Specifies SOAP message 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 SOAP message.

Data Type

String

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

fault_actor property (SOAPClient Struct)

Specifies the entity that caused the fault.

Syntax

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

Default Value

""

Remarks

Use this property to get the URI associated with the actor (SOAP node) that caused the fault. In RPC-style messaging, the actor is the URI of the Web service.

This property is read-only.

Data Type

String

fault_code property (SOAPClient Struct)

Specifies the error code.

Syntax

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

Default Value

""

Remarks

Use this property to get the standard code that provides more information about the fault. A set of code values is predefined by the SOAP specification. This set of fault code values can be extended by the application.

This property is read-only.

Data Type

String

fault_detail property (SOAPClient Struct)

Contains application-specific error information.

Syntax

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

Default Value

""

Remarks

Use this property to get the application-specific information, such as the exception that was thrown. This element can be an XML structure or plain text.

This property is read-only.

Data Type

String

fault_string property (SOAPClient Struct)

Specifies a human-readable description of the fault.

Syntax

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

Default Value

""

Remarks

Use this property to get the human-readable description of the error that happened.

This property is read-only.

Data Type

String

fips_mode property (SOAPClient Struct)

Reserved.

Syntax

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

Default Value

false

Remarks

This property is reserved for future use.

Data Type

bool

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

A path to the file containing the SOAP message to be sent.

Syntax

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

Default Value

""

Remarks

Use this property to provide a full path to the file containing the SOAP message to be sent to the server.

Data Type

String

keep_alive_policy property (SOAPClient Struct)

Defines the keep-alive handling policy.

Syntax

fn keep_alive_policy(&self ) -> Result<i32, SecureBlackboxError> 
fn set_keep_alive_policy(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // StandardDefined
1   // PreferKeepAlive
2   // RelyOnServer
3   // KeepAlivesDisabled

Default Value

0

Remarks

Use this property to tune-up the keep-alive mechanism as per the needs of your application.

Data Type

i32

known_cert_count property (SOAPClient Struct)

The number of records in the KnownCert arrays.

Syntax

fn known_cert_count(&self ) -> Result<i32, SecureBlackboxError> 
fn set_known_cert_count(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• known_cert_bytes
• known_cert_handle

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

Data Type

i32

known_cert_bytes property (SOAPClient Struct)

Returns the raw certificate data in DER format.

Syntax

fn known_cert_bytes(&self , KnownCertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

Returns the raw certificate data in DER format.

The KnownCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCertCount property.

This property is read-only.

Data Type

Vec

known_cert_handle property (SOAPClient Struct)

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

Syntax

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

Data Type

i64

known_crl_count property (SOAPClient Struct)

The number of records in the KnownCRL arrays.

Syntax

fn known_crl_count(&self ) -> Result<i32, SecureBlackboxError> 
fn set_known_crl_count(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• known_crl_bytes
• known_crl_handle

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

Data Type

i32

known_crl_bytes property (SOAPClient Struct)

Returns the raw CRL data in DER format.

Syntax

fn known_crl_bytes(&self , KnownCRLIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

Returns the raw CRL data in DER format.

The KnownCRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCRLCount property.

This property is read-only.

Data Type

Vec

known_crl_handle property (SOAPClient Struct)

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

Syntax

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

Data Type

i64

known_ocsp_count property (SOAPClient Struct)

The number of records in the KnownOCSP arrays.

Syntax

fn known_ocsp_count(&self ) -> Result<i32, SecureBlackboxError> 
fn set_known_ocsp_count(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• known_ocsp_bytes
• known_ocsp_handle

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

Data Type

i32

known_ocsp_bytes property (SOAPClient Struct)

A buffer containing the raw OCSP response data.

Syntax

fn known_ocsp_bytes(&self , KnownOCSPIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

A buffer containing the raw OCSP response data.

The KnownOCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownOCSPCount property.

This property is read-only.

Data Type

Vec

known_ocsp_handle property (SOAPClient Struct)

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

Syntax

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

Data Type

i64

mime_type property (SOAPClient Struct)

Specifies the SOAP message MIME type.

Syntax

fn mime_type(&self ) -> Result<String, SecureBlackboxError> 
fn set_mime_type(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_mime_type_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Use this property to specify the MIME type attribute of the SOAP message.

Data Type

String

operation_name property (SOAPClient Struct)

Specifies the SOAP operation name.

Syntax

fn operation_name(&self ) -> Result<String, SecureBlackboxError> 
fn set_operation_name(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_operation_name_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Use this property to specify the name of the operation that the SOAP message corresponds to.

Set this property if input_file, input_bytes or input_stream only contains the parameters of the operation in XML format. In this case, a new SOAP message will be created and sent to the service.

If one of the Input properties contains a valid SOAP message or an operation request in XML format, this property can be left empty.

Data Type

String

operation_namespace_uri property (SOAPClient Struct)

Specifies the SOAP message operation namespace URI.

Syntax

fn operation_namespace_uri(&self ) -> Result<String, SecureBlackboxError> 
fn set_operation_namespace_uri(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_operation_namespace_uri_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

This property specifies the operation namespace URI of the SOAP message.

Data Type

String

operation_response_name property (SOAPClient Struct)

Specifies the operation name of the response message.

Syntax

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

Default Value

""

Remarks

Use this property to get the operation name from the response message received from the SOAP service.

This property is read-only.

Data Type

String

operation_response_namespace_uri property (SOAPClient Struct)

Specifies the response SOAP message operation namespace URI.

Syntax

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

Default Value

""

Remarks

Use this property to get the operation namespace URI from the response SOAP message.

This property is read-only.

Data Type

String

operation_response_text_content property (SOAPClient Struct)

Returns the text content of the response message.

Syntax

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

Default Value

""

Remarks

Use this property to get the text content of the operation of the response SOAP message.

This property is read-only.

Data Type

String

operation_response_xml property (SOAPClient Struct)

Returns the XML content of the response SOAP message.

Syntax

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

Default Value

""

Remarks

Use this property to get the XML content of the response message.

This property is read-only.

Data Type

String

output_attachment_bytes property (SOAPClient Struct)

Use this property to read the attachment received from the service.

Syntax

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

Remarks

Check the content of this property after the operation has completed to read the received attachment data.

This property will only be set if output_attachment_file and output_attachment_stream properties had not been assigned.

This property is read-only.

Data Type

Vec

output_attachment_file property (SOAPClient Struct)

A path to a file where to save the attachment data.

Syntax

fn output_attachment_file(&self ) -> Result<String, SecureBlackboxError> 
fn set_output_attachment_file(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_output_attachment_file_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Provide a full path to the file where the attachment should be saved.

Data Type

String

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

A file where the response will be saved.

Syntax

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

Default Value

""

Remarks

Provide a full path to the file where the service response should be saved.

Data Type

String

proxy_address property (SOAPClient Struct)

The IP address of the proxy server.

Syntax

fn proxy_address(&self ) -> Result<String, SecureBlackboxError> 
fn set_proxy_address(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_proxy_address_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The IP address of the proxy server.

Data Type

String

proxy_authentication property (SOAPClient Struct)

The authentication type used by the proxy server.

Syntax

fn proxy_authentication(&self ) -> Result<i32, SecureBlackboxError> 
fn set_proxy_authentication(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // NoAuthentication
1   // Basic
2   // Digest
3   // NTLM

Default Value

0

Remarks

The authentication type used by the proxy server.

Data Type

i32

proxy_password property (SOAPClient Struct)

The password to authenticate to the proxy server.

Syntax

fn proxy_password(&self ) -> Result<String, SecureBlackboxError> 
fn set_proxy_password(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_proxy_password_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The password to authenticate to the proxy server.

Data Type

String

proxy_port property (SOAPClient Struct)

The port on the proxy server to connect to.

Syntax

fn proxy_port(&self ) -> Result<i32, SecureBlackboxError> 
fn set_proxy_port(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

The port on the proxy server to connect to.

Data Type

i32

proxy_type property (SOAPClient Struct)

The type of the proxy server.

Syntax

fn proxy_type(&self ) -> Result<i32, SecureBlackboxError> 
fn set_proxy_type(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // None
1   // Socks4
2   // Socks5
3   // WebTunnel
4   // HTTP

Default Value

0

Remarks

The type of the proxy server.

Data Type

i32

proxy_request_headers property (SOAPClient Struct)

Contains HTTP request headers for WebTunnel and HTTP proxy.

Syntax

fn proxy_request_headers(&self ) -> Result<String, SecureBlackboxError> 
fn set_proxy_request_headers(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_proxy_request_headers_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Contains HTTP request headers for WebTunnel and HTTP proxy.

Data Type

String

proxy_response_body property (SOAPClient Struct)

Contains the HTTP or HTTPS (WebTunnel) proxy response body.

Syntax

fn proxy_response_body(&self ) -> Result<String, SecureBlackboxError> 
fn set_proxy_response_body(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_proxy_response_body_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Contains the HTTP or HTTPS (WebTunnel) proxy response body.

Data Type

String

proxy_response_headers property (SOAPClient Struct)

Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.

Syntax

fn proxy_response_headers(&self ) -> Result<String, SecureBlackboxError> 
fn set_proxy_response_headers(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_proxy_response_headers_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.

Data Type

String

proxy_use_ipv6 property (SOAPClient Struct)

Specifies whether IPv6 should be used when connecting through the proxy.

Syntax

fn proxy_use_ipv6(&self ) -> Result<bool, SecureBlackboxError> 
fn set_proxy_use_ipv6(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

Specifies whether IPv6 should be used when connecting through the proxy.

Data Type

bool

proxy_username property (SOAPClient Struct)

Specifies the username credential for proxy authentication.

Syntax

fn proxy_username(&self ) -> Result<String, SecureBlackboxError> 
fn set_proxy_username(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_proxy_username_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Specifies the username credential for proxy authentication.

Data Type

String

reason_phrase property (SOAPClient Struct)

Contains the Reason Phrase element of the server's response.

Syntax

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

Default Value

""

Remarks

Use this property to access the reason phrase supplied by the server in its response (such as OK in HTTP 200 OK).

This property is read-only.

Data Type

String

req_header_count property (SOAPClient Struct)

The number of records in the ReqHeader arrays.

Syntax

fn req_header_count(&self ) -> Result<i32, SecureBlackboxError> 
fn set_req_header_count(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• req_header_category
• req_header_format
• req_header_name
• req_header_value

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

Data Type

i32

req_header_category property (SOAPClient Struct)

Specifies the string category of the contained value.

Syntax

fn req_header_category(&self , ReqHeaderIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_req_header_category(&self, ReqHeaderIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_req_header_category_ref(&self, ReqHeaderIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Specifies the string category of the contained value.

This property allows to check or set the category (or type) associated with the contained value. Depending on the format used to load or save the string, the category parameter may or may not be used.

For example, for ASN.1 property lists the category contains the ASN.1 tag of the contained data (OCTETSTRING, UTF8STRING, INTEGER, ...). For basic (name, value) pairs, such as HTTP headers, the category parameter is not used.

The ReqHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReqHeaderCount property.

Data Type

String

req_header_format property (SOAPClient Struct)

Specifies the format (encoding) of the value contained in the Value property.

Syntax

fn req_header_format(&self , ReqHeaderIndex : i32) -> Result<i32, SecureBlackboxError> 
fn set_req_header_format(&self, ReqHeaderIndex : i32, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

Specifies the format (encoding) of the value contained in the req_header_value property.

Use this property to check or set the format of the contained value. Remember to provide the actual value in the appropriate format that matches this setting: utils.NameValuePairs[0].Name = "key"; utils.NameValuePairs[0].Format = svfBinary; utils.NameValuePairs[0].Name = "0a1b2c3d4e5f6071";

The following formats are currently supported:

The ReqHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReqHeaderCount property.

Data Type

i32

req_header_name property (SOAPClient Struct)

The name element in a (name, value) pair.

Syntax

fn req_header_name(&self , ReqHeaderIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_req_header_name(&self, ReqHeaderIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_req_header_name_ref(&self, ReqHeaderIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The name element in a (name, value) pair.

The ReqHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReqHeaderCount property.

Data Type

String

req_header_value property (SOAPClient Struct)

The value element in a (name, value) pair.

Syntax

fn req_header_value(&self , ReqHeaderIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_req_header_value(&self, ReqHeaderIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_req_header_value_ref(&self, ReqHeaderIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The value element in a (name, value) pair.

The ReqHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReqHeaderCount property.

Data Type

String

req_params_accept property (SOAPClient Struct)

Specifies the Accept header property of the HTTP request.

Syntax

fn req_params_accept(&self ) -> Result<String, SecureBlackboxError> 
fn set_req_params_accept(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_req_params_accept_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Specifies the Accept header field of the HTTP request. The Accept field defines which media types are accepted in the response.

Data Type

String

req_params_accept_charset property (SOAPClient Struct)

Specifies the Accept-Charset header property of the HTTP request.

Syntax

fn req_params_accept_charset(&self ) -> Result<String, SecureBlackboxError> 
fn set_req_params_accept_charset(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_req_params_accept_charset_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Specifies the Accept-Charset header field of the HTTP request. The Accept-Charset field specifies the character set which the client can understand.

Data Type

String

req_params_accept_language property (SOAPClient Struct)

Specifies the Accept-Language header property of the HTTP request.

Syntax

fn req_params_accept_language(&self ) -> Result<String, SecureBlackboxError> 
fn set_req_params_accept_language(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_req_params_accept_language_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Specifies the Accept-Language header field of the HTTP request. The Accept-Language field specifies the language (and locale) which the client can understand.

Data Type

String

req_params_accept_range_end property (SOAPClient Struct)

This property, in combination with AcceptRangeStart, defines the media-range of the HTTP request.

Syntax

fn req_params_accept_range_end(&self ) -> Result<i64, SecureBlackboxError> 
fn set_req_params_accept_range_end(&self, value : i64) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

This property, in combination with AcceptRangeStart, defines the media-range of the HTTP request.

Data Type

i64

req_params_accept_range_start property (SOAPClient Struct)

This property, in combination with AcceptRangeEnd, defines the media-range of the HTTP request.

Syntax

fn req_params_accept_range_start(&self ) -> Result<i64, SecureBlackboxError> 
fn set_req_params_accept_range_start(&self, value : i64) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

This property, in combination with AcceptRangeEnd, defines the media-range of the HTTP request.

Data Type

i64

req_params_authorization property (SOAPClient Struct)

Specifies the Authorization header of the HTTP request.

Syntax

fn req_params_authorization(&self ) -> Result<String, SecureBlackboxError> 
fn set_req_params_authorization(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_req_params_authorization_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Specifies the Authorization header of the HTTP request. This header contains the credentials to authenticate a user with a server.

Data Type

String

req_params_connection property (SOAPClient Struct)

Specifies the value to pass to the Connection header property of HTTP request.

Syntax

fn req_params_connection(&self ) -> Result<String, SecureBlackboxError> 
fn set_req_params_connection(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_req_params_connection_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Specifies the value to pass to the Connection header field of HTTP request.

Data Type

String

req_params_content_length property (SOAPClient Struct)

Specifies the size of the entity-body of the HTTP request.

Syntax

fn req_params_content_length(&self ) -> Result<i64, SecureBlackboxError> 
fn set_req_params_content_length(&self, value : i64) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

Specifies the size of the entity-body of the HTTP request. Leave this field set to 0 to make the struct calculate it automatically.

Data Type

i64

req_params_content_range_end property (SOAPClient Struct)

Specifies the upper bound used in the Content-Range header of the HTTP request.

Syntax

fn req_params_content_range_end(&self ) -> Result<i64, SecureBlackboxError> 
fn set_req_params_content_range_end(&self, value : i64) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

Specifies the upper bound used in the Content-Range header of the HTTP request.

Data Type

i64

req_params_content_range_full_size property (SOAPClient Struct)

Specifies the total length of the full entity-body of the HTTP request.

Syntax

fn req_params_content_range_full_size(&self ) -> Result<i64, SecureBlackboxError> 
fn set_req_params_content_range_full_size(&self, value : i64) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

Specifies the total length of the full entity-body of the HTTP request.

Data Type

i64

req_params_content_range_start property (SOAPClient Struct)

Specifies the lower bound used in the Content-Range header of the HTTP request.

Syntax

fn req_params_content_range_start(&self ) -> Result<i64, SecureBlackboxError> 
fn set_req_params_content_range_start(&self, value : i64) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

Specifies the lower bound used in the Content-Range header of the HTTP request.

Data Type

i64

req_params_content_type property (SOAPClient Struct)

The Content-Type header property of the HTTP request.

Syntax

fn req_params_content_type(&self ) -> Result<String, SecureBlackboxError> 
fn set_req_params_content_type(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_req_params_content_type_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The Content-Type header field of the HTTP request.

Data Type

String

req_params_cookie property (SOAPClient Struct)

This header is expected to be assigned with cookies previously received from the server and stored by the client.

Syntax

fn req_params_cookie(&self ) -> Result<String, SecureBlackboxError> 
fn set_req_params_cookie(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_req_params_cookie_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

This header is expected to be assigned with cookies previously received from the server and stored by the client.

Data Type

String

req_params_custom_headers property (SOAPClient Struct)

Assign any custom HTTP headers to be passed to the server to this property.

Syntax

fn req_params_custom_headers(&self ) -> Result<String, SecureBlackboxError> 
fn set_req_params_custom_headers(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_req_params_custom_headers_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Assign any custom HTTP headers to be passed to the server to this property.

Data Type

String

req_params_date property (SOAPClient Struct)

The date and time of the request.

Syntax

fn req_params_date(&self ) -> Result<String, SecureBlackboxError> 
fn set_req_params_date(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_req_params_date_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The date and time of the request.

Data Type

String

req_params_from property (SOAPClient Struct)

Contains the From header property of the HTTP request.

Syntax

fn req_params_from(&self ) -> Result<String, SecureBlackboxError> 
fn set_req_params_from(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_req_params_from_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Contains the From header field of the HTTP request. It specifies the e-mail address for the human user who controls the requesting user agent.

Data Type

String

req_params_host property (SOAPClient Struct)

This property contains the Host header property of the HTTP request.

Syntax

fn req_params_host(&self ) -> Result<String, SecureBlackboxError> 
fn set_req_params_host(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_req_params_host_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

This property contains the Host header field of the HTTP request. It specifies the host and port number of the resource being requested.

Data Type

String

req_params_http_version property (SOAPClient Struct)

Specifies the version of HTTP protocol to use: 1.

Syntax

fn req_params_http_version(&self ) -> Result<i32, SecureBlackboxError> 
fn set_req_params_http_version(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // HTTP10
1   // HTTP11

Default Value

1

Remarks

Specifies the version of HTTP protocol to use: 1.0 or 1.1.

Data Type

i32

req_params_if_match property (SOAPClient Struct)

Contains the If-Match request header property.

Syntax

fn req_params_if_match(&self ) -> Result<String, SecureBlackboxError> 
fn set_req_params_if_match(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_req_params_if_match_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Contains the If-Match request header field. This property makes the requested method conditional: when If-Match field is set, only the entities matching the included entity tags will be returned by the server.

Data Type

String

req_params_if_modified_since property (SOAPClient Struct)

Contains the If-Modified-Since request header property.

Syntax

fn req_params_if_modified_since(&self ) -> Result<String, SecureBlackboxError> 
fn set_req_params_if_modified_since(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_req_params_if_modified_since_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Contains the If-Modified-Since request header field. This property makes the requested method conditional: when If-Modified-Since field is set, only the modified entities will be returned by the server.

Data Type

String

req_params_if_none_match property (SOAPClient Struct)

Contains the If-None-Match request header property.

Syntax

fn req_params_if_none_match(&self ) -> Result<String, SecureBlackboxError> 
fn set_req_params_if_none_match(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_req_params_if_none_match_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Contains the If-None-Match request header field. This property makes the requested method conditional: when If-None-Match field is set, only the entities which doesn't match the included entity tags will be returned by the server.

Data Type

String

req_params_if_unmodified_since property (SOAPClient Struct)

Contains the If-Unmodified-Since request header property.

Syntax

fn req_params_if_unmodified_since(&self ) -> Result<String, SecureBlackboxError> 
fn set_req_params_if_unmodified_since(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_req_params_if_unmodified_since_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Contains the If-Unmodified-Since request header field. This property makes the requested method conditional: when If-Unmodified-Since field is set, only the unmodified entities will be returned by the server.

Data Type

String

req_params_password property (SOAPClient Struct)

Assign this property with the user's password.

Syntax

fn req_params_password(&self ) -> Result<String, SecureBlackboxError> 
fn set_req_params_password(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_req_params_password_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Assign this property with the user's password.

Data Type

String

req_params_referer property (SOAPClient Struct)

The Referer property of the HTTP request header specifies the address of the resource from which the Request-URI was obtained (the referrer).

Syntax

fn req_params_referer(&self ) -> Result<String, SecureBlackboxError> 
fn set_req_params_referer(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_req_params_referer_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The Referer field of the HTTP request header specifies the address of the resource from which the Request-URI was obtained (the referrer).

Data Type

String

req_params_user_agent property (SOAPClient Struct)

The User-Agent property of the HTTP request provides information about the software that initiates the request.

Syntax

fn req_params_user_agent(&self ) -> Result<String, SecureBlackboxError> 
fn set_req_params_user_agent(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_req_params_user_agent_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The User-Agent field of the HTTP request provides information about the software that initiates the request.

Data Type

String

req_params_username property (SOAPClient Struct)

Assign this property with the user's login name.

Syntax

fn req_params_username(&self ) -> Result<String, SecureBlackboxError> 
fn set_req_params_username(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_req_params_username_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Assign this property with the user's login name.

Data Type

String

resp_header_count property (SOAPClient Struct)

The number of records in the RespHeader arrays.

Syntax

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

Default Value

0

Remarks

This property controls the size of the following arrays:

• resp_header_category
• resp_header_format
• resp_header_name
• resp_header_value

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

This property is read-only.

Data Type

i32

resp_header_category property (SOAPClient Struct)

Specifies the string category of the contained value.

Syntax

fn resp_header_category(&self , RespHeaderIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Specifies the string category of the contained value.

This property allows to check or set the category (or type) associated with the contained value. Depending on the format used to load or save the string, the category parameter may or may not be used.

For example, for ASN.1 property lists the category contains the ASN.1 tag of the contained data (OCTETSTRING, UTF8STRING, INTEGER, ...). For basic (name, value) pairs, such as HTTP headers, the category parameter is not used.

The RespHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RespHeaderCount property.

This property is read-only.

Data Type

String

resp_header_format property (SOAPClient Struct)

Specifies the format (encoding) of the value contained in the Value property.

Syntax

fn resp_header_format(&self , RespHeaderIndex : i32) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

Specifies the format (encoding) of the value contained in the resp_header_value property.

Use this property to check or set the format of the contained value. Remember to provide the actual value in the appropriate format that matches this setting: utils.NameValuePairs[0].Name = "key"; utils.NameValuePairs[0].Format = svfBinary; utils.NameValuePairs[0].Name = "0a1b2c3d4e5f6071";

The following formats are currently supported:

The RespHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RespHeaderCount property.

This property is read-only.

Data Type

i32

resp_header_name property (SOAPClient Struct)

The name element in a (name, value) pair.

Syntax

fn resp_header_name(&self , RespHeaderIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

The name element in a (name, value) pair.

The RespHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RespHeaderCount property.

This property is read-only.

Data Type

String

resp_header_value property (SOAPClient Struct)

The value element in a (name, value) pair.

Syntax

fn resp_header_value(&self , RespHeaderIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

The value element in a (name, value) pair.

The RespHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RespHeaderCount property.

This property is read-only.

Data Type

String

resp_params_content_length property (SOAPClient Struct)

Indicates the length of the response content in bytes.

Syntax

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

Default Value

0

Remarks

Indicates the length of the response content in bytes.

This property is read-only.

Data Type

i64

resp_params_content_type property (SOAPClient Struct)

Returns the content type of the server response, as included in the response headers.

Syntax

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

Default Value

""

Remarks

Returns the content type of the server response, as included in the response headers.

This property is read-only.

Data Type

String

resp_params_date property (SOAPClient Struct)

The date and time at which the response was generated, in server time, in UTC.

Syntax

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

Default Value

""

Remarks

The date and time at which the response was generated, in server time, in UTC.

This property is read-only.

Data Type

String

resp_params_reason_phrase property (SOAPClient Struct)

Contains the reason phrase (a human-readable comment) of the request processing status, which corresponds to, and complements, the status code.

Syntax

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

Default Value

""

Remarks

Contains the reason phrase (a human-readable comment) of the request processing status, which corresponds to, and complements, the status code.

This property is read-only.

Data Type

String

resp_params_status_code property (SOAPClient Struct)

The server-generated status code of the request processing status.

Syntax

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

Default Value

0

Remarks

The server-generated status code of the request processing status.

The code is a 3-digit integer where the first digit defines the class of the response:

Common examples are 200 (page served successfully), 404 (page not found), 302 (redirect), and 500 (internal server error).

This property is read-only.

Data Type

i32

soap_action property (SOAPClient Struct)

Specifies the SOAP action.

Syntax

fn soap_action(&self ) -> Result<String, SecureBlackboxError> 
fn set_soap_action(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_soap_action_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Use this property to specify the value for the SOAPAction/action HTTP request header field. This field is normally used to indicate the intent of the SOAP request.

Data Type

String

soap_response_type property (SOAPClient Struct)

The type of the response.

Syntax

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

Possible Values

0   // Unknown
1   // Binary
2   // XMLDocument
3   // SOAPMessage

Default Value

0

Remarks

Use this property to learn about the type (format) of the response provided by the SOAP service.

This property is read-only.

Data Type

i32

soap_version property (SOAPClient Struct)

Specifies SOAP version.

Syntax

fn soap_version(&self ) -> Result<i32, SecureBlackboxError> 
fn set_soap_version(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // Auto
1   // 11
2   // 12

Default Value

0

Remarks

This property specifies the version of the SOAP protocol. This SOAP version will be used to create a SOAP message (if needed) and to communicate with the service.

Data Type

i32

socket_dns_mode property (SOAPClient Struct)

Selects the DNS resolver to use: the struct's (secure) built-in one, or the one provided by the system.

Syntax

fn socket_dns_mode(&self ) -> Result<i32, SecureBlackboxError> 
fn set_socket_dns_mode(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // Auto
1   // Platform
2   // Own
3   // OwnSecure

Default Value

0

Remarks

Selects the DNS resolver to use: the component's (secure) built-in one, or the one provided by the system.

Data Type

i32

socket_dns_port property (SOAPClient Struct)

Specifies the port number to be used for sending queries to the DNS server.

Syntax

fn socket_dns_port(&self ) -> Result<i32, SecureBlackboxError> 
fn set_socket_dns_port(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

Specifies the port number to be used for sending queries to the DNS server.

Data Type

i32

socket_dns_query_timeout property (SOAPClient Struct)

The timeout (in milliseconds) for each DNS query.

Syntax

fn socket_dns_query_timeout(&self ) -> Result<i32, SecureBlackboxError> 
fn set_socket_dns_query_timeout(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

The timeout (in milliseconds) for each DNS query. The value of 0 indicates an infinite timeout.

Data Type

i32

socket_dns_servers property (SOAPClient Struct)

The addresses of DNS servers to use for address resolution, separated by commas or semicolons.

Syntax

fn socket_dns_servers(&self ) -> Result<String, SecureBlackboxError> 
fn set_socket_dns_servers(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_socket_dns_servers_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The addresses of DNS servers to use for address resolution, separated by commas or semicolons.

Data Type

String

socket_dns_total_timeout property (SOAPClient Struct)

The timeout (in milliseconds) for the whole resolution process.

Syntax

fn socket_dns_total_timeout(&self ) -> Result<i32, SecureBlackboxError> 
fn set_socket_dns_total_timeout(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

The timeout (in milliseconds) for the whole resolution process. The value of 0 indicates an infinite timeout.

Data Type

i32

socket_incoming_speed_limit property (SOAPClient Struct)

The maximum number of bytes to read from the socket, per second.

Syntax

fn socket_incoming_speed_limit(&self ) -> Result<i32, SecureBlackboxError> 
fn set_socket_incoming_speed_limit(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

The maximum number of bytes to read from the socket, per second.

Data Type

i32

socket_local_address property (SOAPClient Struct)

The local network interface to bind the socket to.

Syntax

fn socket_local_address(&self ) -> Result<String, SecureBlackboxError> 
fn set_socket_local_address(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_socket_local_address_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The local network interface to bind the socket to.

Data Type

String

socket_local_port property (SOAPClient Struct)

The local port number to bind the socket to.

Syntax

fn socket_local_port(&self ) -> Result<i32, SecureBlackboxError> 
fn set_socket_local_port(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

The local port number to bind the socket to.

Data Type

i32

socket_outgoing_speed_limit property (SOAPClient Struct)

The maximum number of bytes to write to the socket, per second.

Syntax

fn socket_outgoing_speed_limit(&self ) -> Result<i32, SecureBlackboxError> 
fn set_socket_outgoing_speed_limit(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

The maximum number of bytes to write to the socket, per second.

Data Type

i32

socket_timeout property (SOAPClient Struct)

The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.

Syntax

fn socket_timeout(&self ) -> Result<i32, SecureBlackboxError> 
fn set_socket_timeout(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

60000

Remarks

The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.

If Timeout is set to 0, a socket operation will expire after the system-default timeout (2 hrs 8 min for TCP stack).

Data Type

i32

socket_use_ipv6 property (SOAPClient Struct)

Enables or disables IP protocol version 6.

Syntax

fn socket_use_ipv6(&self ) -> Result<bool, SecureBlackboxError> 
fn set_socket_use_ipv6(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

Enables or disables IP protocol version 6.

Data Type

bool

status_code property (SOAPClient Struct)

Contains the Status Code element of the server's response.

Syntax

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

Default Value

0

Remarks

Use this property to access the status code supplied by the server in its response (such as 200 in HTTP 200 OK).

This property is read-only.

Data Type

i32

tls_client_cert_count property (SOAPClient Struct)

The number of records in the TLSClientCert arrays.

Syntax

fn tls_client_cert_count(&self ) -> Result<i32, SecureBlackboxError> 
fn set_tls_client_cert_count(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• tls_client_cert_bytes
• tls_client_cert_handle

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

Data Type

i32

tls_client_cert_bytes property (SOAPClient Struct)

Returns the raw certificate data in DER format.

Syntax

fn tls_client_cert_bytes(&self , TLSClientCertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

Returns the raw certificate data in DER format.

The TLSClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSClientCertCount property.

This property is read-only.

Data Type

Vec

tls_client_cert_handle property (SOAPClient Struct)

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

Syntax

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

Data Type

i64

tls_server_cert_count property (SOAPClient Struct)

The number of records in the TLSServerCert arrays.

Syntax

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

Default Value

0

Remarks

This property controls the size of the following arrays:

• tls_server_cert_bytes
• tls_server_cert_fingerprint
• tls_server_cert_handle
• tls_server_cert_issuer
• tls_server_cert_issuer_rdn
• tls_server_cert_key_algorithm
• tls_server_cert_key_bits
• tls_server_cert_key_usage
• tls_server_cert_self_signed
• tls_server_cert_serial_number
• tls_server_cert_sig_algorithm
• tls_server_cert_subject
• tls_server_cert_subject_rdn
• tls_server_cert_valid_from
• tls_server_cert_valid_to

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

This property is read-only.

Data Type

i32

tls_server_cert_bytes property (SOAPClient Struct)

Returns the raw certificate data in DER format.

Syntax

fn tls_server_cert_bytes(&self , TLSServerCertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

Returns the raw certificate data in DER format.

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

This property is read-only.

Data Type

Vec

tls_server_cert_fingerprint property (SOAPClient Struct)

Contains the fingerprint (a hash imprint) of this certificate.

Syntax

fn tls_server_cert_fingerprint(&self , TLSServerCertIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Contains the fingerprint (a hash imprint) of this certificate.

While there is no formal standard defining what a fingerprint is, a SHA1 hash of the certificate's DER-encoded body is typically used.

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

This property is read-only.

Data Type

String

tls_server_cert_handle property (SOAPClient Struct)

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

Syntax

fn tls_server_cert_handle(&self , TLSServerCertIndex : i32) -> Result<i64, SecureBlackboxError> 

Default Value

0

Remarks

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

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

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

This property is read-only.

Data Type

i64

tls_server_cert_issuer property (SOAPClient Struct)

The common name of the certificate issuer (CA), typically a company name.

Syntax

fn tls_server_cert_issuer(&self , TLSServerCertIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

The common name of the certificate issuer (CA), typically a company name. This is part of a larger set of credentials available via tls_issuer_rdn.

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

This property is read-only.

Data Type

String

tls_server_cert_issuer_rdn property (SOAPClient Struct)

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

Syntax

fn tls_server_cert_issuer_rdn(&self , TLSServerCertIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

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

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

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

This property is read-only.

Data Type

String

tls_server_cert_key_algorithm property (SOAPClient Struct)

Specifies the public key algorithm of this certificate.

Syntax

fn tls_server_cert_key_algorithm(&self , TLSServerCertIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

"0"

Remarks

Specifies the public key algorithm of this certificate.

Use the tls_key_bits, tls_curve, and tls_public_key_bytes properties to get more details about the key the certificate contains.

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

This property is read-only.

Data Type

String

tls_server_cert_key_bits property (SOAPClient Struct)

Returns the length of the public key in bits.

Syntax

fn tls_server_cert_key_bits(&self , TLSServerCertIndex : i32) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

Returns the length of the public key in bits.

This value indicates the length of the principal cryptographic parameter of the key, such as the length of the RSA modulus or ECDSA field. The key data returned by the tls_public_key_bytes or tls_private_key_bytes property would typically contain auxiliary values, and therefore be longer.

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

This property is read-only.

Data Type

i32

tls_server_cert_key_usage property (SOAPClient Struct)

Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.

Syntax

fn tls_server_cert_key_usage(&self , TLSServerCertIndex : i32) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.

This value is a bit mask of the following values:

Set this property before generating the certificate to propagate the key usage flags to the new certificate.

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

This property is read-only.

Data Type

i32

tls_server_cert_self_signed property (SOAPClient Struct)

Indicates whether the certificate is self-signed (root) or signed by an external CA.

Syntax

fn tls_server_cert_self_signed(&self , TLSServerCertIndex : i32) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

Indicates whether the certificate is self-signed (root) or signed by an external CA.

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

This property is read-only.

Data Type

bool

tls_server_cert_serial_number property (SOAPClient Struct)

Returns the certificate's serial number.

Syntax

fn tls_server_cert_serial_number(&self , TLSServerCertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

Returns the certificate's serial number.

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

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

This property is read-only.

Data Type

Vec

tls_server_cert_sig_algorithm property (SOAPClient Struct)

Indicates the algorithm that was used by the CA to sign this certificate.

Syntax

fn tls_server_cert_sig_algorithm(&self , TLSServerCertIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Indicates the algorithm that was used by the CA to sign this certificate.

A signature algorithm typically combines hash and public key algorithms together, such as sha256WithRSAEncryption or ecdsa-with-SHA256.

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

This property is read-only.

Data Type

String

tls_server_cert_subject property (SOAPClient Struct)

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.

Syntax

fn tls_server_cert_subject(&self , TLSServerCertIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. This is part of a larger set of credentials available via tls_subject_rdn.

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

This property is read-only.

Data Type

String

tls_server_cert_subject_rdn property (SOAPClient Struct)

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

Syntax

fn tls_server_cert_subject_rdn(&self , TLSServerCertIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

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

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

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

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

This property is read-only.

Data Type

String

tls_server_cert_valid_from property (SOAPClient Struct)

The time point at which the certificate becomes valid, in UTC.

Syntax

fn tls_server_cert_valid_from(&self , TLSServerCertIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

The time point at which the certificate becomes valid, in UTC.

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

This property is read-only.

Data Type

String

tls_server_cert_valid_to property (SOAPClient Struct)

The time point at which the certificate expires, in UTC.

Syntax

fn tls_server_cert_valid_to(&self , TLSServerCertIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

The time point at which the certificate expires, in UTC.

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

This property is read-only.

Data Type

String

tls_auto_validate_certificates property (SOAPClient Struct)

Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.

Syntax

fn tls_auto_validate_certificates(&self ) -> Result<bool, SecureBlackboxError> 
fn set_tls_auto_validate_certificates(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

true

Remarks

Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.

Data Type

bool

tls_base_configuration property (SOAPClient Struct)

Selects the base configuration for the TLS settings.

Syntax

fn tls_base_configuration(&self ) -> Result<i32, SecureBlackboxError> 
fn set_tls_base_configuration(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // Default
1   // Compatible
2   // ComprehensiveInsecure
3   // HighlySecure

Default Value

0

Remarks

Selects the base configuration for the TLS settings. Several profiles are offered and tuned up for different purposes, such as high security or higher compatibility.

Data Type

i32

tls_ciphersuites property (SOAPClient Struct)

A list of ciphersuites separated with commas or semicolons.

Syntax

fn tls_ciphersuites(&self ) -> Result<String, SecureBlackboxError> 
fn set_tls_ciphersuites(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_tls_ciphersuites_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

A list of ciphersuites separated with commas or semicolons. Each ciphersuite in the list may be prefixed with a minus sign (-) to indicate that the ciphersuite should be disabled rather than enabled. Besides the specific ciphersuite modifiers, this property supports the all (and -all) aliases, allowing all ciphersuites to be blanketly enabled or disabled at once.

Note: the list of ciphersuites provided to this property alters the baseline list of ciphersuites as defined by tls_base_configuration. Remember to start your ciphersuite string with -all; if you need to only enable a specific fixed set of ciphersuites. The list of supported ciphersuites is provided below:

• NULL_NULL_NULL
• RSA_NULL_MD5
• RSA_NULL_SHA
• RSA_RC4_MD5
• RSA_RC4_SHA
• RSA_RC2_MD5
• RSA_IDEA_MD5
• RSA_IDEA_SHA
• RSA_DES_MD5
• RSA_DES_SHA
• RSA_3DES_MD5
• RSA_3DES_SHA
• RSA_AES128_SHA
• RSA_AES256_SHA
• DH_DSS_DES_SHA
• DH_DSS_3DES_SHA
• DH_DSS_AES128_SHA
• DH_DSS_AES256_SHA
• DH_RSA_DES_SHA
• DH_RSA_3DES_SHA
• DH_RSA_AES128_SHA
• DH_RSA_AES256_SHA
• DHE_DSS_DES_SHA
• DHE_DSS_3DES_SHA
• DHE_DSS_AES128_SHA
• DHE_DSS_AES256_SHA
• DHE_RSA_DES_SHA
• DHE_RSA_3DES_SHA
• DHE_RSA_AES128_SHA
• DHE_RSA_AES256_SHA
• DH_ANON_RC4_MD5
• DH_ANON_DES_SHA
• DH_ANON_3DES_SHA
• DH_ANON_AES128_SHA
• DH_ANON_AES256_SHA
• RSA_RC2_MD5_EXPORT
• RSA_RC4_MD5_EXPORT
• RSA_DES_SHA_EXPORT
• DH_DSS_DES_SHA_EXPORT
• DH_RSA_DES_SHA_EXPORT
• DHE_DSS_DES_SHA_EXPORT
• DHE_RSA_DES_SHA_EXPORT
• DH_ANON_RC4_MD5_EXPORT
• DH_ANON_DES_SHA_EXPORT
• RSA_CAMELLIA128_SHA
• DH_DSS_CAMELLIA128_SHA
• DH_RSA_CAMELLIA128_SHA
• DHE_DSS_CAMELLIA128_SHA
• DHE_RSA_CAMELLIA128_SHA
• DH_ANON_CAMELLIA128_SHA
• RSA_CAMELLIA256_SHA
• DH_DSS_CAMELLIA256_SHA
• DH_RSA_CAMELLIA256_SHA
• DHE_DSS_CAMELLIA256_SHA
• DHE_RSA_CAMELLIA256_SHA
• DH_ANON_CAMELLIA256_SHA
• PSK_RC4_SHA
• PSK_3DES_SHA
• PSK_AES128_SHA
• PSK_AES256_SHA
• DHE_PSK_RC4_SHA
• DHE_PSK_3DES_SHA
• DHE_PSK_AES128_SHA
• DHE_PSK_AES256_SHA
• RSA_PSK_RC4_SHA
• RSA_PSK_3DES_SHA
• RSA_PSK_AES128_SHA
• RSA_PSK_AES256_SHA
• RSA_SEED_SHA
• DH_DSS_SEED_SHA
• DH_RSA_SEED_SHA
• DHE_DSS_SEED_SHA
• DHE_RSA_SEED_SHA
• DH_ANON_SEED_SHA
• SRP_SHA_3DES_SHA
• SRP_SHA_RSA_3DES_SHA
• SRP_SHA_DSS_3DES_SHA
• SRP_SHA_AES128_SHA
• SRP_SHA_RSA_AES128_SHA
• SRP_SHA_DSS_AES128_SHA
• SRP_SHA_AES256_SHA
• SRP_SHA_RSA_AES256_SHA
• SRP_SHA_DSS_AES256_SHA
• ECDH_ECDSA_NULL_SHA
• ECDH_ECDSA_RC4_SHA
• ECDH_ECDSA_3DES_SHA
• ECDH_ECDSA_AES128_SHA
• ECDH_ECDSA_AES256_SHA
• ECDHE_ECDSA_NULL_SHA
• ECDHE_ECDSA_RC4_SHA
• ECDHE_ECDSA_3DES_SHA
• ECDHE_ECDSA_AES128_SHA
• ECDHE_ECDSA_AES256_SHA
• ECDH_RSA_NULL_SHA
• ECDH_RSA_RC4_SHA
• ECDH_RSA_3DES_SHA
• ECDH_RSA_AES128_SHA
• ECDH_RSA_AES256_SHA
• ECDHE_RSA_NULL_SHA
• ECDHE_RSA_RC4_SHA
• ECDHE_RSA_3DES_SHA
• ECDHE_RSA_AES128_SHA
• ECDHE_RSA_AES256_SHA
• ECDH_ANON_NULL_SHA
• ECDH_ANON_RC4_SHA
• ECDH_ANON_3DES_SHA
• ECDH_ANON_AES128_SHA
• ECDH_ANON_AES256_SHA
• RSA_NULL_SHA256
• RSA_AES128_SHA256
• RSA_AES256_SHA256
• DH_DSS_AES128_SHA256
• DH_RSA_AES128_SHA256
• DHE_DSS_AES128_SHA256
• DHE_RSA_AES128_SHA256
• DH_DSS_AES256_SHA256
• DH_RSA_AES256_SHA256
• DHE_DSS_AES256_SHA256
• DHE_RSA_AES256_SHA256
• DH_ANON_AES128_SHA256
• DH_ANON_AES256_SHA256
• RSA_AES128_GCM_SHA256
• RSA_AES256_GCM_SHA384
• DHE_RSA_AES128_GCM_SHA256
• DHE_RSA_AES256_GCM_SHA384
• DH_RSA_AES128_GCM_SHA256
• DH_RSA_AES256_GCM_SHA384
• DHE_DSS_AES128_GCM_SHA256
• DHE_DSS_AES256_GCM_SHA384
• DH_DSS_AES128_GCM_SHA256
• DH_DSS_AES256_GCM_SHA384
• DH_ANON_AES128_GCM_SHA256
• DH_ANON_AES256_GCM_SHA384
• ECDHE_ECDSA_AES128_SHA256
• ECDHE_ECDSA_AES256_SHA384
• ECDH_ECDSA_AES128_SHA256
• ECDH_ECDSA_AES256_SHA384
• ECDHE_RSA_AES128_SHA256
• ECDHE_RSA_AES256_SHA384
• ECDH_RSA_AES128_SHA256
• ECDH_RSA_AES256_SHA384
• ECDHE_ECDSA_AES128_GCM_SHA256
• ECDHE_ECDSA_AES256_GCM_SHA384
• ECDH_ECDSA_AES128_GCM_SHA256
• ECDH_ECDSA_AES256_GCM_SHA384
• ECDHE_RSA_AES128_GCM_SHA256
• ECDHE_RSA_AES256_GCM_SHA384
• ECDH_RSA_AES128_GCM_SHA256
• ECDH_RSA_AES256_GCM_SHA384
• PSK_AES128_GCM_SHA256
• PSK_AES256_GCM_SHA384
• DHE_PSK_AES128_GCM_SHA256
• DHE_PSK_AES256_GCM_SHA384
• RSA_PSK_AES128_GCM_SHA256
• RSA_PSK_AES256_GCM_SHA384
• PSK_AES128_SHA256
• PSK_AES256_SHA384
• PSK_NULL_SHA256
• PSK_NULL_SHA384
• DHE_PSK_AES128_SHA256
• DHE_PSK_AES256_SHA384
• DHE_PSK_NULL_SHA256
• DHE_PSK_NULL_SHA384
• RSA_PSK_AES128_SHA256
• RSA_PSK_AES256_SHA384
• RSA_PSK_NULL_SHA256
• RSA_PSK_NULL_SHA384
• RSA_CAMELLIA128_SHA256
• DH_DSS_CAMELLIA128_SHA256
• DH_RSA_CAMELLIA128_SHA256
• DHE_DSS_CAMELLIA128_SHA256
• DHE_RSA_CAMELLIA128_SHA256
• DH_ANON_CAMELLIA128_SHA256
• RSA_CAMELLIA256_SHA256
• DH_DSS_CAMELLIA256_SHA256
• DH_RSA_CAMELLIA256_SHA256
• DHE_DSS_CAMELLIA256_SHA256
• DHE_RSA_CAMELLIA256_SHA256
• DH_ANON_CAMELLIA256_SHA256
• ECDHE_ECDSA_CAMELLIA128_SHA256
• ECDHE_ECDSA_CAMELLIA256_SHA384
• ECDH_ECDSA_CAMELLIA128_SHA256
• ECDH_ECDSA_CAMELLIA256_SHA384
• ECDHE_RSA_CAMELLIA128_SHA256
• ECDHE_RSA_CAMELLIA256_SHA384
• ECDH_RSA_CAMELLIA128_SHA256
• ECDH_RSA_CAMELLIA256_SHA384
• RSA_CAMELLIA128_GCM_SHA256
• RSA_CAMELLIA256_GCM_SHA384
• DHE_RSA_CAMELLIA128_GCM_SHA256
• DHE_RSA_CAMELLIA256_GCM_SHA384
• DH_RSA_CAMELLIA128_GCM_SHA256
• DH_RSA_CAMELLIA256_GCM_SHA384
• DHE_DSS_CAMELLIA128_GCM_SHA256
• DHE_DSS_CAMELLIA256_GCM_SHA384
• DH_DSS_CAMELLIA128_GCM_SHA256
• DH_DSS_CAMELLIA256_GCM_SHA384
• DH_anon_CAMELLIA128_GCM_SHA256
• DH_anon_CAMELLIA256_GCM_SHA384
• ECDHE_ECDSA_CAMELLIA128_GCM_SHA256
• ECDHE_ECDSA_CAMELLIA256_GCM_SHA384
• ECDH_ECDSA_CAMELLIA128_GCM_SHA256
• ECDH_ECDSA_CAMELLIA256_GCM_SHA384
• ECDHE_RSA_CAMELLIA128_GCM_SHA256
• ECDHE_RSA_CAMELLIA256_GCM_SHA384
• ECDH_RSA_CAMELLIA128_GCM_SHA256
• ECDH_RSA_CAMELLIA256_GCM_SHA384
• PSK_CAMELLIA128_GCM_SHA256
• PSK_CAMELLIA256_GCM_SHA384
• DHE_PSK_CAMELLIA128_GCM_SHA256
• DHE_PSK_CAMELLIA256_GCM_SHA384
• RSA_PSK_CAMELLIA128_GCM_SHA256
• RSA_PSK_CAMELLIA256_GCM_SHA384
• PSK_CAMELLIA128_SHA256
• PSK_CAMELLIA256_SHA384
• DHE_PSK_CAMELLIA128_SHA256
• DHE_PSK_CAMELLIA256_SHA384
• RSA_PSK_CAMELLIA128_SHA256
• RSA_PSK_CAMELLIA256_SHA384
• ECDHE_PSK_CAMELLIA128_SHA256
• ECDHE_PSK_CAMELLIA256_SHA384
• ECDHE_PSK_RC4_SHA
• ECDHE_PSK_3DES_SHA
• ECDHE_PSK_AES128_SHA
• ECDHE_PSK_AES256_SHA
• ECDHE_PSK_AES128_SHA256
• ECDHE_PSK_AES256_SHA384
• ECDHE_PSK_NULL_SHA
• ECDHE_PSK_NULL_SHA256
• ECDHE_PSK_NULL_SHA384
• ECDHE_RSA_CHACHA20_POLY1305_SHA256
• ECDHE_ECDSA_CHACHA20_POLY1305_SHA256
• DHE_RSA_CHACHA20_POLY1305_SHA256
• PSK_CHACHA20_POLY1305_SHA256
• ECDHE_PSK_CHACHA20_POLY1305_SHA256
• DHE_PSK_CHACHA20_POLY1305_SHA256
• RSA_PSK_CHACHA20_POLY1305_SHA256
• AES128_GCM_SHA256
• AES256_GCM_SHA384
• CHACHA20_POLY1305_SHA256
• AES128_CCM_SHA256
• AES128_CCM8_SHA256

Data Type

String

tls_client_auth property (SOAPClient Struct)

Enables or disables certificate-based client authentication.

Syntax

fn tls_client_auth(&self ) -> Result<i32, SecureBlackboxError> 
fn set_tls_client_auth(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // NoAuth
1   // RequestCert
2   // RequireCert

Default Value

0

Remarks

Enables or disables certificate-based client authentication.

Set this property to true to tune up the client authentication type:

Data Type

i32

tls_extensions property (SOAPClient Struct)

Provides access to TLS extensions.

Syntax

fn tls_extensions(&self ) -> Result<String, SecureBlackboxError> 
fn set_tls_extensions(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_tls_extensions_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Provides access to TLS extensions.

Data Type

String

tls_force_resume_if_destination_changes property (SOAPClient Struct)

Whether to force TLS session resumption when the destination address changes.

Syntax

fn tls_force_resume_if_destination_changes(&self ) -> Result<bool, SecureBlackboxError> 
fn set_tls_force_resume_if_destination_changes(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

Whether to force TLS session resumption when the destination address changes.

Data Type

bool

tls_groups property (SOAPClient Struct)

Specifies a list of key exchange groups to attempt during the TLS key exchange.

Syntax

fn tls_groups(&self ) -> Result<String, SecureBlackboxError> 
fn set_tls_groups(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_tls_groups_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Specifies a list of key exchange groups to attempt during the TLS key exchange.

Keep this setting at its default value (empty string) to stick with the default list of key exchange groups. You can tweak the list by using '+' and '-' modifiers that are immediately followed by a group name or the all placeholder:

// Ensure the two x25519-based groups are enabled and the finite field DHE2048 is disabled client.TLSSettings.Groups = "+x25519mlkem768;+x25519;-ffdhe2048"; // Only enable the hybrid X25519/ML-KEM768 group client.TLSSettings.Groups = "-all;+x25519mlkem768";

The list of groups supported by the component is provided below. All the names are case-insensitive:

Elliptic curve-based groups:

• SECT163K1
• SECT163R1
• SECT163R2
• SECT193R1
• SECT193R2
• SECT233K1
• SECT233R1
• SECT239K1
• SECT283K1
• SECT283R1
• SECT409K1
• SECT409R1
• SECT571K1
• SECT571R1
• SECP160K1
• SECP160R1
• SECP160R2
• SECP192K1
• SECP192R1
• SECP224K1
• SECP224R1
• SECP256K1
• SECP256R1
• SECP384R1
• SECP521R1
• BRAINPOOLP256R1
• BRAINPOOLP384R1
• BRAINPOOLP512R1
• X25519
• X448

Finite field-based groups:

• FFDHE2048
• FFDHE3072
• FFDHE4096
• FFDHE6144
• FFDHE8192

Post-Quantum and Hybrid groups:

• MLKEM512
• MLKEM768
• MLKEM1024
• SECP256R1MLKEM768
• X25519MLKEM768
• SECP384R1MLKEM1024

Note: this property was called ECCurves in SecureBlackbox 2024 and older.

Data Type

String

tls_pre_shared_identity property (SOAPClient Struct)

Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.

Syntax

fn tls_pre_shared_identity(&self ) -> Result<String, SecureBlackboxError> 
fn set_tls_pre_shared_identity(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_tls_pre_shared_identity_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.

Data Type

String

tls_pre_shared_key property (SOAPClient Struct)

Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.

Syntax

fn tls_pre_shared_key(&self ) -> Result<String, SecureBlackboxError> 
fn set_tls_pre_shared_key(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_tls_pre_shared_key_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.

Data Type

String

tls_pre_shared_key_ciphersuite property (SOAPClient Struct)

Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.

Syntax

fn tls_pre_shared_key_ciphersuite(&self ) -> Result<String, SecureBlackboxError> 
fn set_tls_pre_shared_key_ciphersuite(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_tls_pre_shared_key_ciphersuite_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.

Data Type

String

tls_renegotiation_attack_prevention_mode property (SOAPClient Struct)

Selects the renegotiation attack prevention mechanism.

Syntax

fn tls_renegotiation_attack_prevention_mode(&self ) -> Result<i32, SecureBlackboxError> 
fn set_tls_renegotiation_attack_prevention_mode(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // Compatible
1   // Strict
2   // Auto

Default Value

2

Remarks

Selects the renegotiation attack prevention mechanism.

The following options are available:

Data Type

i32

tls_revocation_check property (SOAPClient Struct)

Specifies the kind(s) of revocation check to perform.

Syntax

fn tls_revocation_check(&self ) -> Result<i32, SecureBlackboxError> 
fn set_tls_revocation_check(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // None
1   // Auto
2   // AllCRL
3   // AllOCSP
4   // AllCRLAndOCSP
5   // AnyCRL
6   // AnyOCSP
7   // AnyCRLOrOCSP
8   // AnyOCSPOrCRL

Default Value

1

Remarks

Specifies the kind(s) of revocation check to perform.

Revocation checking is necessary to ensure the integrity of the chain and obtain up-to-date certificate validity and trustworthiness information.

This setting controls the way the revocation checks are performed for every certificate in the chain. Typically certificates come with two types of revocation information sources: CRL (certificate revocation lists) and OCSP responders. CRLs are static objects periodically published by the CA at some online location. OCSP responders are active online services maintained by the CA that can provide up-to-date information on certificate statuses in near real time.

There are some conceptual differences between the two. CRLs are normally larger in size. Their use involves some latency because there is normally some delay between the time when a certificate was revoked and the time the subsequent CRL mentioning that is published. The benefits of CRL is that the same object can provide statuses for all certificates issued by a particular CA, and that the whole technology is much simpler than OCSP (and thus is supported by more CAs).

This setting lets you adjust the validation course by including or excluding certain types of revocation sources from the validation process. The crcAnyOCSPOrCRL setting (give preference to the faster OCSP route and only demand one source to succeed) is a good choice for most typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential.

NOTE: If no CRL or OCSP endpoints are provided by the CA, the revocation check will be considered successful. This is because the CA chose not to supply revocation information for its certificates, meaning they are considered irrevocable.

NOTE: Within each of the above settings, if any retrieved CRL or OCSP response indicates that the certificate has been revoked, the revocation check fails.

Data Type

i32

tls_ssl_options property (SOAPClient Struct)

Various SSL (TLS) protocol options, set of cssloExpectShutdownMessage 0x001 Wait for the close-notify message when shutting down the connection cssloOpenSSLDTLSWorkaround 0x002 (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions cssloDisableKexLengthAlignment 0x004 Do not align the client-side PMS by the RSA modulus size.

Syntax

fn tls_ssl_options(&self ) -> Result<i32, SecureBlackboxError> 
fn set_tls_ssl_options(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

16

Remarks

Various SSL (TLS) protocol options, set of

Data Type

i32

tls_mode property (SOAPClient Struct)

Specifies the TLS mode to use.

Syntax

fn tls_mode(&self ) -> Result<i32, SecureBlackboxError> 
fn set_tls_mode(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // Default
1   // NoTLS
2   // ExplicitTLS
3   // ImplicitTLS
4   // MixedTLS

Default Value

0

Remarks

Specifies the TLS mode to use.

Data Type

i32

tls_use_extended_master_secret property (SOAPClient Struct)

Enables the Extended Master Secret Extension, as defined in RFC 7627.

Syntax

fn tls_use_extended_master_secret(&self ) -> Result<bool, SecureBlackboxError> 
fn set_tls_use_extended_master_secret(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

true

Remarks

Enables the Extended Master Secret Extension, as defined in RFC 7627.

Data Type

bool

tls_use_session_resumption property (SOAPClient Struct)

Enables or disables the TLS session resumption capability.

Syntax

fn tls_use_session_resumption(&self ) -> Result<bool, SecureBlackboxError> 
fn set_tls_use_session_resumption(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

Enables or disables the TLS session resumption capability.

Data Type

bool

tls_versions property (SOAPClient Struct)

The SSL/TLS versions to enable by default.

Syntax

fn tls_versions(&self ) -> Result<i32, SecureBlackboxError> 
fn set_tls_versions(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

48

Remarks

The SSL/TLS versions to enable by default.

Data Type

i32

trusted_cert_count property (SOAPClient Struct)

The number of records in the TrustedCert arrays.

Syntax

fn trusted_cert_count(&self ) -> Result<i32, SecureBlackboxError> 
fn set_trusted_cert_count(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• trusted_cert_bytes
• trusted_cert_handle

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

Data Type

i32

trusted_cert_bytes property (SOAPClient Struct)

Returns the raw certificate data in DER format.

Syntax

fn trusted_cert_bytes(&self , TrustedCertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

Returns the raw certificate data in DER format.

The TrustedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

This property is read-only.

Data Type

Vec

trusted_cert_handle property (SOAPClient Struct)

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

Syntax

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

Data Type

i64

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

Performs an additional action.

Syntax

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

Remarks

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

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

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

Common ActionIDs:

reset method (SOAPClient Struct)

Resets the struct settings.

Syntax

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

Remarks

reset is a generic method available in every struct.

send_message method (SOAPClient Struct)

Sends a SOAP message to the server.

Syntax

fn send_message(&self, url : &str) -> Result<(), SecureBlackboxError>

Remarks

The SendMessage() does the following:

• Loads the data from input_bytes, input_file or input_stream properties.

  If the data contains a SOAP message, no pre-send processing is performed.

  If the data contains XML content, then basing on operation_name, operation_namespace_uri and soap_version properties new SOAP envelope will be created. The XML content will be used either as either the operation itself or the operation parameters, depending on operation_name value.

• Sends the SOAP message to the service Url.

  Use soap_action, encoding and mime_type properties to set SOAP HTTP request parameters.

• If the request is successful, the received content is saved in either output_bytes, output_file or output_stream.

  If the response contains attachment(s) then on_before_receive_attachment event will be fired for each attachment, following which the attachment will be saved to either output_attachment_bytes, output_attachment_file or output_attachment_stream.

  Use soap_response_type to get the type of the received content. If the received content is recognized as a SOAP message, then operation_response_name, operation_response_namespace_uri operation_response_text_content and operation_response_xml properties will be populated.

• If an error happens during the request, an exception is thrown.

  Use soap_response_type to identify the received content. The type set to Unknown means that either a connection error has occurred or the service has returned an unexpected HTTP status code. In this case, the error details are published in status_code and reason_phrase properties.

  If soap_response_type set to a different value indicates that the service has returned HTTP status code in the range 500 - 599, indicating a service error.

  If the type of received content is SOAP message, then fault_actor, fault_code, fault_detail and fault_string properties will contain error details returned by the service.

  If the request has succeeded then the received content will also be available in either output_bytes, output_file or output_stream properties.

send_message_with_attachments method (SOAPClient Struct)

Sends a SOAP message with attachment(s) to the server.

Syntax

fn send_message_with_attachments(&self, url : &str, primary_message_id : &str) -> Result<(), SecureBlackboxError>

Remarks

This method follows the general pattern used by send_message method. It also lets you pass a selection of attachments to the service.

Assign the attachment content to attachment_bytes, attachment_file, or attachment_stream property. Subscribe to on_before_send_attachment to pass more than one attachment.

on_before_receive_attachment event (SOAPClient Struct)

Marks the start of receiving an attachment.

Syntax

// SOAPClientBeforeReceiveAttachmentEventArgs carries the SOAPClient BeforeReceiveAttachment event's parameters.
pub struct SOAPClientBeforeReceiveAttachmentEventArgs {
}

// SOAPClientBeforeReceiveAttachmentEvent defines the signature of the SOAPClient BeforeReceiveAttachment event's handler function.
pub trait SOAPClientBeforeReceiveAttachmentEvent {
  fn on_before_receive_attachment(&self, sender : SOAPClient, e : &mut SOAPClientBeforeReceiveAttachmentEventArgs);
}

impl <'a> SOAPClient<'a> {
  pub fn on_before_receive_attachment(&self) -> &'a dyn SOAPClientBeforeReceiveAttachmentEvent;
  pub fn set_on_before_receive_attachment(&mut self, value : &'a dyn SOAPClientBeforeReceiveAttachmentEvent);
  ...
}

Remarks

This event fires for every new attachment being received from the service.

Tune up output_attachment_bytes, output_attachment_file or output_attachment_stream properties inside the event handler to indicate where the attachment content should be saved.

on_before_send_attachment event (SOAPClient Struct)

Marks the start of sending an attachment.

Syntax

// SOAPClientBeforeSendAttachmentEventArgs carries the SOAPClient BeforeSendAttachment event's parameters.
pub struct SOAPClientBeforeSendAttachmentEventArgs {
  fn last_attachment(&self) -> bool
  fn set_last_attachment(&self, value : bool)
}

// SOAPClientBeforeSendAttachmentEvent defines the signature of the SOAPClient BeforeSendAttachment event's handler function.
pub trait SOAPClientBeforeSendAttachmentEvent {
  fn on_before_send_attachment(&self, sender : SOAPClient, e : &mut SOAPClientBeforeSendAttachmentEventArgs);
}

impl <'a> SOAPClient<'a> {
  pub fn on_before_send_attachment(&self) -> &'a dyn SOAPClientBeforeSendAttachmentEvent;
  pub fn set_on_before_send_attachment(&mut self, value : &'a dyn SOAPClientBeforeSendAttachmentEvent);
  ...
}

Remarks

Use either attachment_bytes, attachment_file or attachment_stream properties to pass attachment to the struct.

Set LastAttachment parameter to False to indicate that you have more than one attachment to pass.

on_cookie event (SOAPClient Struct)

Fired to report a received cookie.

Syntax

// SOAPClientCookieEventArgs carries the SOAPClient Cookie event's parameters.
pub struct SOAPClientCookieEventArgs {
  fn cookie_text(&self) -> &String
}

// SOAPClientCookieEvent defines the signature of the SOAPClient Cookie event's handler function.
pub trait SOAPClientCookieEvent {
  fn on_cookie(&self, sender : SOAPClient, e : &mut SOAPClientCookieEventArgs);
}

impl <'a> SOAPClient<'a> {
  pub fn on_cookie(&self) -> &'a dyn SOAPClientCookieEvent;
  pub fn set_on_cookie(&mut self, value : &'a dyn SOAPClientCookieEvent);
  ...
}

Remarks

The CookieText parameter contains the text of the cookie.

on_document_begin event (SOAPClient Struct)

Marks the start of the incoming HTML document or file.

Syntax

// SOAPClientDocumentBeginEventArgs carries the SOAPClient DocumentBegin event's parameters.
pub struct SOAPClientDocumentBeginEventArgs {
}

// SOAPClientDocumentBeginEvent defines the signature of the SOAPClient DocumentBegin event's handler function.
pub trait SOAPClientDocumentBeginEvent {
  fn on_document_begin(&self, sender : SOAPClient, e : &mut SOAPClientDocumentBeginEventArgs);
}

impl <'a> SOAPClient<'a> {
  pub fn on_document_begin(&self) -> &'a dyn SOAPClientDocumentBeginEvent;
  pub fn set_on_document_begin(&mut self, value : &'a dyn SOAPClientDocumentBeginEvent);
  ...
}

Remarks

This event is followed by one or more on_progress calls. When the document has been received in full, the on_document_end event is fired.

on_document_end event (SOAPClient Struct)

Marks the successful receipt of the incoming HTML document or file.

Syntax

// SOAPClientDocumentEndEventArgs carries the SOAPClient DocumentEnd event's parameters.
pub struct SOAPClientDocumentEndEventArgs {
}

// SOAPClientDocumentEndEvent defines the signature of the SOAPClient DocumentEnd event's handler function.
pub trait SOAPClientDocumentEndEvent {
  fn on_document_end(&self, sender : SOAPClient, e : &mut SOAPClientDocumentEndEventArgs);
}

impl <'a> SOAPClient<'a> {
  pub fn on_document_end(&self) -> &'a dyn SOAPClientDocumentEndEvent;
  pub fn set_on_document_end(&mut self, value : &'a dyn SOAPClientDocumentEndEvent);
  ...
}

Remarks

This event fires when the document has been received in full.

on_error event (SOAPClient Struct)

Information about errors during data delivery.

Syntax

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

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

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

Remarks

The event is fired in case of exceptional conditions during message processing.

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 the HTTPS section.

on_external_sign event (SOAPClient Struct)

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

Syntax

// SOAPClientExternalSignEventArgs carries the SOAPClient ExternalSign event's parameters.
pub struct SOAPClientExternalSignEventArgs {
  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)
}

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

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

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_headers_prepared event (SOAPClient Struct)

Fires when the request headers have been formed and are about to be sent to the server.

Syntax

// SOAPClientHeadersPreparedEventArgs carries the SOAPClient HeadersPrepared event's parameters.
pub struct SOAPClientHeadersPreparedEventArgs {
}

// SOAPClientHeadersPreparedEvent defines the signature of the SOAPClient HeadersPrepared event's handler function.
pub trait SOAPClientHeadersPreparedEvent {
  fn on_headers_prepared(&self, sender : SOAPClient, e : &mut SOAPClientHeadersPreparedEventArgs);
}

impl <'a> SOAPClient<'a> {
  pub fn on_headers_prepared(&self) -> &'a dyn SOAPClientHeadersPreparedEvent;
  pub fn set_on_headers_prepared(&mut self, value : &'a dyn SOAPClientHeadersPreparedEvent);
  ...
}

Remarks

The prepared headers are available in request_headers property. This event provides you the last chance to review/alter them.

on_headers_received event (SOAPClient Struct)

Fires when the HTTP response headers have just been received from the server.

Syntax

// SOAPClientHeadersReceivedEventArgs carries the SOAPClient HeadersReceived event's parameters.
pub struct SOAPClientHeadersReceivedEventArgs {
}

// SOAPClientHeadersReceivedEvent defines the signature of the SOAPClient HeadersReceived event's handler function.
pub trait SOAPClientHeadersReceivedEvent {
  fn on_headers_received(&self, sender : SOAPClient, e : &mut SOAPClientHeadersReceivedEventArgs);
}

impl <'a> SOAPClient<'a> {
  pub fn on_headers_received(&self) -> &'a dyn SOAPClientHeadersReceivedEvent;
  pub fn set_on_headers_received(&mut self, value : &'a dyn SOAPClientHeadersReceivedEvent);
  ...
}

Remarks

The received headers are available via the response_headers property.

on_notification event (SOAPClient Struct)

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

Syntax

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

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

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

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_progress event (SOAPClient Struct)

Fires periodically during the data transfer.

Syntax

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

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

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

Remarks

Use this event to check the progress of an upload or download operation. Total indicates the total number of bytes to be transferred; Current specifies how much data has been transferred so far, and Cancel gives you a chance to cancel the operation.

on_redirection event (SOAPClient Struct)

Fires when the server suggests a redirect.

Syntax

// SOAPClientRedirectionEventArgs carries the SOAPClient Redirection event's parameters.
pub struct SOAPClientRedirectionEventArgs {
  fn old_url(&self) -> &String
  fn new_url(&self) -> &String
  fn set_new_url(&self, value : &str)
  fn set_new_url_ref(&self, value : &String)
  fn allow_redirection(&self) -> bool
  fn set_allow_redirection(&self, value : bool)
}

// SOAPClientRedirectionEvent defines the signature of the SOAPClient Redirection event's handler function.
pub trait SOAPClientRedirectionEvent {
  fn on_redirection(&self, sender : SOAPClient, e : &mut SOAPClientRedirectionEventArgs);
}

impl <'a> SOAPClient<'a> {
  pub fn on_redirection(&self) -> &'a dyn SOAPClientRedirectionEvent;
  pub fn set_on_redirection(&mut self, value : &'a dyn SOAPClientRedirectionEvent);
  ...
}

Remarks

This event is fired when the server suggests a redirection request (typically via a 301 or 302 response). OldURL indicates the 'from' page, and NewURL indicates the 'to' one. The destination page can be altered by the application if needed. Use AllowRedirection to block undesirable redirects.

Generally, this is a notification event: the component handles redirections automatically. Use the MaxRedirections config property to limit the number of redirection hops.

on_tls_cert_needed event (SOAPClient Struct)

Fires when a remote TLS party requests a client certificate.

Syntax

// SOAPClientTLSCertNeededEventArgs carries the SOAPClient TLSCertNeeded event's parameters.
pub struct SOAPClientTLSCertNeededEventArgs {
  fn host(&self) -> &String
  fn ca_names(&self) -> &String
}

// SOAPClientTLSCertNeededEvent defines the signature of the SOAPClient TLSCertNeeded event's handler function.
pub trait SOAPClientTLSCertNeededEvent {
  fn on_tls_cert_needed(&self, sender : SOAPClient, e : &mut SOAPClientTLSCertNeededEventArgs);
}

impl <'a> SOAPClient<'a> {
  pub fn on_tls_cert_needed(&self) -> &'a dyn SOAPClientTLSCertNeededEvent;
  pub fn set_on_tls_cert_needed(&mut self, value : &'a dyn SOAPClientTLSCertNeededEvent);
  ...
}

Remarks

This event fires to notify the implementation that a remote TLS server has requested a client certificate. The Host parameter identifies the host that makes a request, and the CANames parameter (optional, according to the TLS spec) advises on the accepted issuing CAs.

Use the tls_client_chain property in response to this event to provide the requested certificate. Please make sure the client certificate includes the associated private key. Note that you may set the certificates before the connection without waiting for this event to fire.

This event is preceded by the on_tls_handshake event for the given host and, if the certificate was accepted, succeeded by the on_tls_established event.

on_tls_cert_validate event (SOAPClient Struct)

This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance.

Syntax

// SOAPClientTLSCertValidateEventArgs carries the SOAPClient TLSCertValidate event's parameters.
pub struct SOAPClientTLSCertValidateEventArgs {
  fn server_host(&self) -> &String
  fn server_ip(&self) -> &String
  fn accept(&self) -> bool
  fn set_accept(&self, value : bool)
}

// SOAPClientTLSCertValidateEvent defines the signature of the SOAPClient TLSCertValidate event's handler function.
pub trait SOAPClientTLSCertValidateEvent {
  fn on_tls_cert_validate(&self, sender : SOAPClient, e : &mut SOAPClientTLSCertValidateEventArgs);
}

impl <'a> SOAPClient<'a> {
  pub fn on_tls_cert_validate(&self) -> &'a dyn SOAPClientTLSCertValidateEvent;
  pub fn set_on_tls_cert_validate(&mut self, value : &'a dyn SOAPClientTLSCertValidateEvent);
  ...
}

Remarks

This event is fired during a TLS handshake. Use the tls_server_chain property to access the certificate chain. In general, structs may contact a number of TLS endpoints during their work, depending on their configuration.

Accept is assigned in accordance with the outcome of the internal validation check performed by the struct, and can be adjusted if needed.

on_tls_established event (SOAPClient Struct)

Fires when a TLS handshake with Host successfully completes.

Syntax

// SOAPClientTLSEstablishedEventArgs carries the SOAPClient TLSEstablished event's parameters.
pub struct SOAPClientTLSEstablishedEventArgs {
  fn host(&self) -> &String
  fn version(&self) -> &String
  fn ciphersuite(&self) -> &String
  fn connection_id(&self) -> &[u8]
  fn abort(&self) -> bool
  fn set_abort(&self, value : bool)
}

// SOAPClientTLSEstablishedEvent defines the signature of the SOAPClient TLSEstablished event's handler function.
pub trait SOAPClientTLSEstablishedEvent {
  fn on_tls_established(&self, sender : SOAPClient, e : &mut SOAPClientTLSEstablishedEventArgs);
}

impl <'a> SOAPClient<'a> {
  pub fn on_tls_established(&self) -> &'a dyn SOAPClientTLSEstablishedEvent;
  pub fn set_on_tls_established(&mut self, value : &'a dyn SOAPClientTLSEstablishedEvent);
  ...
}

Remarks

The struct uses this event to notify the application about a successful completion of a TLS handshake.

The Version, Ciphersuite, and ConnectionId parameters indicate the security parameters of the new connection. Use the Abort parameter if you need to terminate the connection at this stage.

on_tls_handshake event (SOAPClient Struct)

Fires when a new TLS handshake is initiated, before the handshake commences.

Syntax

// SOAPClientTLSHandshakeEventArgs carries the SOAPClient TLSHandshake event's parameters.
pub struct SOAPClientTLSHandshakeEventArgs {
  fn host(&self) -> &String
  fn abort(&self) -> bool
  fn set_abort(&self, value : bool)
}

// SOAPClientTLSHandshakeEvent defines the signature of the SOAPClient TLSHandshake event's handler function.
pub trait SOAPClientTLSHandshakeEvent {
  fn on_tls_handshake(&self, sender : SOAPClient, e : &mut SOAPClientTLSHandshakeEventArgs);
}

impl <'a> SOAPClient<'a> {
  pub fn on_tls_handshake(&self) -> &'a dyn SOAPClientTLSHandshakeEvent;
  pub fn set_on_tls_handshake(&mut self, value : &'a dyn SOAPClientTLSHandshakeEvent);
  ...
}

Remarks

The struct uses this event to notify the application about the start of a new TLS handshake to Host. If the handshake is successful, this event will be followed by the on_tls_established event. If the server chooses to request a client certificate, the on_tls_cert_needed event will also be fired.

on_tls_psk event (SOAPClient Struct)

Notifies the application about the PSK key exchange.

Syntax

// SOAPClientTLSPSKEventArgs carries the SOAPClient TLSPSK event's parameters.
pub struct SOAPClientTLSPSKEventArgs {
  fn host(&self) -> &String
  fn hint(&self) -> &String
}

// SOAPClientTLSPSKEvent defines the signature of the SOAPClient TLSPSK event's handler function.
pub trait SOAPClientTLSPSKEvent {
  fn on_tls_psk(&self, sender : SOAPClient, e : &mut SOAPClientTLSPSKEventArgs);
}

impl <'a> SOAPClient<'a> {
  pub fn on_tls_psk(&self) -> &'a dyn SOAPClientTLSPSKEvent;
  pub fn set_on_tls_psk(&mut self, value : &'a dyn SOAPClientTLSPSKEvent);
  ...
}

Remarks

The struct fires this event to notify the application about the beginning of TLS-PSK key exchange with Host. The Hint parameter may be used by the server to identify the key or service to use. Use the PreSharedKey field of tls_settings to provide the pre-shared key to the component.

on_tls_shutdown event (SOAPClient Struct)

Reports the graceful closure of a TLS connection.

Syntax

// SOAPClientTLSShutdownEventArgs carries the SOAPClient TLSShutdown event's parameters.
pub struct SOAPClientTLSShutdownEventArgs {
  fn host(&self) -> &String
}

// SOAPClientTLSShutdownEvent defines the signature of the SOAPClient TLSShutdown event's handler function.
pub trait SOAPClientTLSShutdownEvent {
  fn on_tls_shutdown(&self, sender : SOAPClient, e : &mut SOAPClientTLSShutdownEventArgs);
}

impl <'a> SOAPClient<'a> {
  pub fn on_tls_shutdown(&self) -> &'a dyn SOAPClientTLSShutdownEvent;
  pub fn set_on_tls_shutdown(&mut self, value : &'a dyn SOAPClientTLSShutdownEvent);
  ...
}

Remarks

This event notifies the application about the closure of an earlier established TLS connection. Note that only graceful connection closures are reported.

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

HTTPClient Config Settings

Base Config Settings

Trappable Errors (SOAPClient Struct)

SOAPClient Errors