Struct secureblackbox::DCAuthWebServer

Properties   Methods   Events   Config Settings   Errors  

The DCAuthWebServer Struct offers higher-level access to 'private key side' functionality of SecureBlackbox DC protocol.

Syntax

secureblackbox::DCAuthWebServer

Remarks

DCAuthWebServer provides a built-in REST responder for DC requests. Use it in conjunction with the in-browser Javascript that comes with DC package, or with standalone DC requestors. DCAuthWebServer listens to DC requests on a specific port or a port chosen between port_range_from and port_range_to. Use DCAuth, which provides a lower-level access to the signing engine, to implement DC in applications, apps, or services.

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

active property (DCAuthWebServer Struct)

Indicates whether the server is active and is listening to new connections.

Syntax

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

Default Value

false

Remarks

This read-only property returns True if the server is listening to incoming connections.

This property is read-only.

Data Type

bool

allow_origin property (DCAuthWebServer Struct)

Specifies the content of AllowOrigin header of the service reply.

Syntax

fn allow_origin(&self ) -> Result<String, SecureBlackboxError> 
fn set_allow_origin(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_allow_origin_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Use this property to specify the content of AllowOrigin header included with the service reply. If left empty, the * header will be returned.

Data Type

String

auth_realm property (DCAuthWebServer Struct)

Specifies authentication realm for digest and NTLM authentication.

Syntax

fn auth_realm(&self ) -> Result<String, SecureBlackboxError> 
fn set_auth_realm(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_auth_realm_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

"SecureBlackbox"

Remarks

Specifies authentication realm for digest and NTLM authentication types.

Data Type

String

auth_types property (DCAuthWebServer 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

bound_port property (DCAuthWebServer Struct)

Indicates the bound listening port.

Syntax

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

Default Value

0

Remarks

Check this property to find out the port that has been allocated to the server by the system. The bound port always equals port if it is provided, or is allocated dynamically if configured to fall in the range between port_range_from and port_range_to constraints.

This property is read-only.

Data Type

i32

external_crypto_async_document_id property (DCAuthWebServer 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 (DCAuthWebServer 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 (DCAuthWebServer 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 (DCAuthWebServer 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 (DCAuthWebServer 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 (DCAuthWebServer 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 (DCAuthWebServer 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 (DCAuthWebServer 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 (DCAuthWebServer 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 (DCAuthWebServer Struct)

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

Syntax

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

Default Value

""

Remarks

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

Data Type

String

fips_mode property (DCAuthWebServer 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

handshake_timeout property (DCAuthWebServer Struct)

Specifies the handshake timeout in milliseconds.

Syntax

fn handshake_timeout(&self ) -> Result<i32, SecureBlackboxError> 
fn set_handshake_timeout(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

20000

Remarks

Use this property to set the TLS handshake timeout.

Data Type

i32

host property (DCAuthWebServer Struct)

The host to bind the listening port to.

Syntax

fn host(&self ) -> Result<String, SecureBlackboxError> 
fn set_host(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_host_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Use this property to specify the IP address on which to listen to incoming connections.

Data Type

String

key_id property (DCAuthWebServer Struct)

Specifies the KeyID of the pre-shared authentication key.

Syntax

fn key_id(&self ) -> Result<String, SecureBlackboxError> 
fn set_key_id(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_key_id_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

If processing requests from a single known party, assign the Id of the key you pre-shared with them to this property, and the key itself to the key_secret property. If you expect to receive requests from many parties with different authentication keys, use on_key_secret_needed event instead.

Data Type

String

key_secret property (DCAuthWebServer Struct)

The pre-shared authentication key.

Syntax

fn key_secret(&self ) -> Result<String, SecureBlackboxError> 
fn set_key_secret(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_key_secret_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

If processing requests from a single known party, assign the key you pre-shared with them to this property. Use key_id property to assign the ID of that key. If you expect to receive requests from many parties with different authentication keys, use on_key_secret_needed event instead.

Data Type

String

pinned_client_aead_cipher property (DCAuthWebServer Struct)

Indicates whether the encryption algorithm used is an AEAD cipher.

Syntax

fn pinned_client_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

pinned_client_chain_validation_details property (DCAuthWebServer Struct)

The details of a certificate chain validation outcome.

Syntax

fn pinned_client_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

pinned_client_chain_validation_result property (DCAuthWebServer Struct)

The outcome of a certificate chain validation routine.

Syntax

fn pinned_client_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

pinned_client_ciphersuite property (DCAuthWebServer Struct)

The cipher suite employed by this connection.

Syntax

fn pinned_client_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

pinned_client_client_authenticated property (DCAuthWebServer Struct)

Specifies whether client authentication was performed during this connection.

Syntax

fn pinned_client_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

pinned_client_client_auth_requested property (DCAuthWebServer Struct)

Specifies whether client authentication was requested during this connection.

Syntax

fn pinned_client_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

pinned_client_connection_established property (DCAuthWebServer Struct)

Indicates whether the connection has been established fully.

Syntax

fn pinned_client_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

pinned_client_connection_id property (DCAuthWebServer Struct)

The unique identifier assigned to this connection.

Syntax

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

Remarks

The unique identifier assigned to this connection.

This property is read-only.

Data Type

Vec

pinned_client_digest_algorithm property (DCAuthWebServer Struct)

The digest algorithm used in a TLS-enabled connection.

Syntax

fn pinned_client_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

pinned_client_encryption_algorithm property (DCAuthWebServer Struct)

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

Syntax

fn pinned_client_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

pinned_client_exportable property (DCAuthWebServer Struct)

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

Syntax

fn pinned_client_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

pinned_client_group property (DCAuthWebServer Struct)

The elliptic curve used in this connection.

Syntax

fn pinned_client_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

pinned_client_id property (DCAuthWebServer Struct)

The client connection's unique identifier.

Syntax

fn pinned_client_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

pinned_client_key_exchange_algorithm property (DCAuthWebServer Struct)

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

Syntax

fn pinned_client_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

pinned_client_key_exchange_key_bits property (DCAuthWebServer Struct)

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

Syntax

fn pinned_client_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

pinned_client_pfs_cipher property (DCAuthWebServer Struct)

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

Syntax

fn pinned_client_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

pinned_client_pre_shared_identity property (DCAuthWebServer Struct)

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

Syntax

fn pinned_client_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

pinned_client_pre_shared_identity_hint property (DCAuthWebServer Struct)

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

Syntax

fn pinned_client_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

pinned_client_public_key_bits property (DCAuthWebServer Struct)

The length of the public key.

Syntax

fn pinned_client_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

pinned_client_remote_address property (DCAuthWebServer Struct)

The client's IP address.

Syntax

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

Default Value

""

Remarks

The client's IP address.

This property is read-only.

Data Type

String

pinned_client_remote_port property (DCAuthWebServer Struct)

The remote port of the client connection.

Syntax

fn pinned_client_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

pinned_client_resumed_session property (DCAuthWebServer Struct)

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

Syntax

fn pinned_client_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

pinned_client_secure_connection property (DCAuthWebServer Struct)

Indicates whether TLS or SSL is enabled for this connection.

Syntax

fn pinned_client_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

pinned_client_server_authenticated property (DCAuthWebServer Struct)

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

Syntax

fn pinned_client_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

pinned_client_signature_algorithm property (DCAuthWebServer Struct)

The signature algorithm used in a TLS handshake.

Syntax

fn pinned_client_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

pinned_client_symmetric_block_size property (DCAuthWebServer Struct)

The block size of the symmetric algorithm used.

Syntax

fn pinned_client_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

pinned_client_symmetric_key_bits property (DCAuthWebServer Struct)

The key length of the symmetric algorithm used.

Syntax

fn pinned_client_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

pinned_client_total_bytes_received property (DCAuthWebServer Struct)

The total number of bytes received over this connection.

Syntax

fn pinned_client_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

pinned_client_total_bytes_sent property (DCAuthWebServer Struct)

The total number of bytes sent over this connection.

Syntax

fn pinned_client_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

pinned_client_validation_log property (DCAuthWebServer Struct)

Contains the server certificate's chain validation log.

Syntax

fn pinned_client_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

pinned_client_version property (DCAuthWebServer Struct)

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

Syntax

fn pinned_client_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

pinned_client_cert_count property (DCAuthWebServer Struct)

The number of records in the PinnedClientCert arrays.

Syntax

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

Default Value

0

Remarks

This property controls the size of the following arrays:

• pinned_client_cert_bytes
• pinned_client_cert_ca_key_id
• pinned_client_cert_fingerprint
• pinned_client_cert_handle
• pinned_client_cert_issuer
• pinned_client_cert_issuer_rdn
• pinned_client_cert_key_algorithm
• pinned_client_cert_key_bits
• pinned_client_cert_key_fingerprint
• pinned_client_cert_key_usage
• pinned_client_cert_public_key_bytes
• pinned_client_cert_self_signed
• pinned_client_cert_serial_number
• pinned_client_cert_sig_algorithm
• pinned_client_cert_subject
• pinned_client_cert_subject_key_id
• pinned_client_cert_subject_rdn
• pinned_client_cert_valid_from
• pinned_client_cert_valid_to

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

This property is read-only.

Data Type

i32

pinned_client_cert_bytes property (DCAuthWebServer Struct)

Returns the raw certificate data in DER format.

Syntax

fn pinned_client_cert_bytes(&self , PinnedClientCertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

Returns the raw certificate data in DER format.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only.

Data Type

Vec

pinned_client_cert_ca_key_id property (DCAuthWebServer Struct)

A unique identifier (fingerprint) of the CA certificate's cryptographic key.

Syntax

fn pinned_client_cert_ca_key_id(&self , PinnedClientCertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

A unique identifier (fingerprint) of the CA certificate's cryptographic key.

Authority Key Identifier is a certificate extension which allows identification of certificates belonging to the same issuer, but with different public keys. It is a de-facto standard to include this extension in all certificates to facilitate chain building.

This setting cannot be set when generating a certificate as it always derives from another certificate property. CertificateManager generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the pinned_client_cert_subject_key_id setting, and for lower-level certificates, from the parent certificate's subject key ID extension.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only.

Data Type

Vec

pinned_client_cert_fingerprint property (DCAuthWebServer Struct)

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

Syntax

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

This property is read-only.

Data Type

String

pinned_client_cert_handle property (DCAuthWebServer Struct)

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

Syntax

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

This property is read-only.

Data Type

i64

pinned_client_cert_issuer property (DCAuthWebServer Struct)

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

Syntax

fn pinned_client_cert_issuer(&self , PinnedClientCertIndex : 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 pinned_client_cert_issuer_rdn.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only.

Data Type

String

pinned_client_cert_issuer_rdn property (DCAuthWebServer Struct)

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

Syntax

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

This property is read-only.

Data Type

String

pinned_client_cert_key_algorithm property (DCAuthWebServer Struct)

Specifies the public key algorithm of this certificate.

Syntax

fn pinned_client_cert_key_algorithm(&self , PinnedClientCertIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

"0"

Remarks

Specifies the public key algorithm of this certificate.

Use the pinned_client_cert_key_bits, pinned_client_cert_curve, and pinned_client_cert_public_key_bytes properties to get more details about the key the certificate contains.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only.

Data Type

String

pinned_client_cert_key_bits property (DCAuthWebServer Struct)

Returns the length of the public key in bits.

Syntax

fn pinned_client_cert_key_bits(&self , PinnedClientCertIndex : 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 pinned_client_cert_public_key_bytes or pinned_client_cert_private_key_bytes property would typically contain auxiliary values, and therefore be longer.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only.

Data Type

i32

pinned_client_cert_key_fingerprint property (DCAuthWebServer Struct)

Returns a SHA1 fingerprint of the public key contained in the certificate.

Syntax

fn pinned_client_cert_key_fingerprint(&self , PinnedClientCertIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Returns a SHA1 fingerprint of the public key contained in the certificate.

Note that the key fingerprint is different from the certificate fingerprint accessible via the pinned_client_cert_fingerprint property. The key fingerprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only.

Data Type

String

pinned_client_cert_key_usage property (DCAuthWebServer Struct)

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

Syntax

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

This property is read-only.

Data Type

i32

pinned_client_cert_public_key_bytes property (DCAuthWebServer Struct)

Contains the certificate's public key in DER format.

Syntax

fn pinned_client_cert_public_key_bytes(&self , PinnedClientCertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

Contains the certificate's public key in DER format.

This typically would contain an ASN.1-encoded public key value. The exact format depends on the type of the public key contained in the certificate.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only.

Data Type

Vec

pinned_client_cert_self_signed property (DCAuthWebServer Struct)

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

Syntax

fn pinned_client_cert_self_signed(&self , PinnedClientCertIndex : i32) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

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

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only.

Data Type

bool

pinned_client_cert_serial_number property (DCAuthWebServer Struct)

Returns the certificate's serial number.

Syntax

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

This property is read-only.

Data Type

Vec

pinned_client_cert_sig_algorithm property (DCAuthWebServer Struct)

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

Syntax

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

This property is read-only.

Data Type

String

pinned_client_cert_subject property (DCAuthWebServer 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 pinned_client_cert_subject(&self , PinnedClientCertIndex : 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 pinned_client_cert_subject_rdn.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only.

Data Type

String

pinned_client_cert_subject_key_id property (DCAuthWebServer Struct)

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

Syntax

fn pinned_client_cert_subject_key_id(&self , PinnedClientCertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

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

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

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

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only.

Data Type

Vec

pinned_client_cert_subject_rdn property (DCAuthWebServer Struct)

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

Syntax

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

This property is read-only.

Data Type

String

pinned_client_cert_valid_from property (DCAuthWebServer Struct)

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

Syntax

fn pinned_client_cert_valid_from(&self , PinnedClientCertIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

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

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only.

Data Type

String

pinned_client_cert_valid_to property (DCAuthWebServer Struct)

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

Syntax

fn pinned_client_cert_valid_to(&self , PinnedClientCertIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

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

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only.

Data Type

String

policies property (DCAuthWebServer Struct)

Specifies the policies to use when processing requests.

Syntax

fn policies(&self ) -> Result<i32, SecureBlackboxError> 
fn set_policies(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

This property lets you specify policies to apply blanketly to the requests. If this property does not give you enough flexibility - for example, if you need to cherry-pick requests basing on their content - please consider using the on_sign_request (allows you to track individual requests) and/or on_external_sign (lets you perform the signing manually) events. This setting is a bit mask of the following flags:

Data Type

i32

port property (DCAuthWebServer Struct)

Specifies the port number to listen for connections on.

Syntax

fn port(&self ) -> Result<i32, SecureBlackboxError> 
fn set_port(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

80

Remarks

Use this property to specify the port number to listen to connections on. Standard port numbers are 80 for an HTTP server, and 443 for an HTTPS server.

Alternatively, you may specify the acceptable range of listening ports via port_range_from and port_range_to properties. In this case the port will be allocated within the requested range by the operating system, and reported in bound_port.

Data Type

i32

port_range_from property (DCAuthWebServer Struct)

Specifies the lower limit of the listening port range for incoming connections.

Syntax

fn port_range_from(&self ) -> Result<i32, SecureBlackboxError> 
fn set_port_range_from(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

Use this property to specify the lower limit of the port range to listen to connections on. When a port range is used to specify the listening port (as opposed to a fixed value provided via port), the port will be allocated within the requested range by the operating system, and reported in bound_port.

Note that this property is ignored if the port property is set to a non-zero value, in which case the server always aims to listen on that fixed port.

Data Type

i32

port_range_to property (DCAuthWebServer Struct)

Specifies the upper limit of the listening port range for incoming connections.

Syntax

fn port_range_to(&self ) -> Result<i32, SecureBlackboxError> 
fn set_port_range_to(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

Use this property to specify the upper limit of the port range to listen to connections on. When a port range is used to specify the listening port (as opposed to a fixed value provided via port), the port will be allocated within the requested range by the operating system, and reported in bound_port.

Note that this property is ignored if the port property is set to a non-zero value, in which case the server always aims to listen on that fixed port.

Data Type

i32

session_timeout property (DCAuthWebServer Struct)

Specifies the default session timeout value in milliseconds.

Syntax

fn session_timeout(&self ) -> Result<i32, SecureBlackboxError> 
fn set_session_timeout(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

360000

Remarks

Specifies the period of inactivity (in milliseconds) after which the connection will be terminated by the server.

Data Type

i32

sign_endpoint property (DCAuthWebServer Struct)

The signing service endpoint.

Syntax

fn sign_endpoint(&self ) -> Result<String, SecureBlackboxError> 
fn set_sign_endpoint(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_sign_endpoint_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

"/sign"

Remarks

Use this property to specify the signing service end point on the server.

Data Type

String

signing_cert_bytes property (DCAuthWebServer Struct)

Returns the raw certificate data in DER format.

Syntax

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

Remarks

Returns the raw certificate data in DER format.

This property is read-only.

Data Type

Vec

signing_cert_handle property (DCAuthWebServer Struct)

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

Syntax

fn signing_cert_handle(&self ) -> Result<i64, SecureBlackboxError> 
fn set_signing_cert_handle(&self, value : i64) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

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

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

Data Type

i64

signing_chain_count property (DCAuthWebServer Struct)

The number of records in the SigningChain arrays.

Syntax

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

Default Value

0

Remarks

This property controls the size of the following arrays:

• signing_chain_bytes
• signing_chain_handle

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

Data Type

i32

signing_chain_bytes property (DCAuthWebServer Struct)

Returns the raw certificate data in DER format.

Syntax

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

Remarks

Returns the raw certificate data in DER format.

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

This property is read-only.

Data Type

Vec

signing_chain_handle property (DCAuthWebServer Struct)

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

Syntax

fn signing_chain_handle(&self , SigningChainIndex : i32) -> Result<i64, SecureBlackboxError> 
fn set_signing_chain_handle(&self, SigningChainIndex : i32, value : i64) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

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

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

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

Data Type

i64

socket_incoming_speed_limit property (DCAuthWebServer 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 (DCAuthWebServer 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 (DCAuthWebServer 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 (DCAuthWebServer 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 (DCAuthWebServer 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 (DCAuthWebServer 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

storage_id property (DCAuthWebServer Struct)

Specifies the signing certificate residing in an alternative location.

Syntax

fn storage_id(&self ) -> Result<String, SecureBlackboxError> 
fn set_storage_id(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_storage_id_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Use this property to specify the signing certificate contained on alternative media, such as a hardware device or in a system certificate store.

Example 1: The certificate resides on a PKCS#11 device

pkcs11://user:pin@/c:/windows/system32/pkcsdriver.dll?slot=0&readonly=1

Example 2: The certificate resides in a system store

system://localmachine@/?store=MY

You can use the following URI modifiers to provide more accurate specifiers for the needed certificate:

• cn: the common name of the certificate subject.
• keyid: the unique identifier included in subject key identifier extension of the certificate.
• keyusage: a comma-separated list of enabled (+) or disabled (-) key usages. The following usages are supported: signature, nonrepudiation, keyencipherment, dataencipherment, keyagreement, keycertsign, crlsign, encipheronly, decipheronly, serverauth, clientauth, codesigning, emailprotection, timestamping, ocspsigning, smartcardlogon, keypurposeclientauth, keypurposekdc.
• fingerprint: the fingerprint of the certificate.

Example 3: selecting the certificate with a given fingerprint:

pkcs11://user:pin@/c:/windows/system32/pkcsdriver.dll?slot=0&readonly=1&fingerprint=001122334455667788aabbccddeeff0011223344

Data Type

String

timestamp_server property (DCAuthWebServer Struct)

The address of the timestamping server.

Syntax

fn timestamp_server(&self ) -> Result<String, SecureBlackboxError> 
fn set_timestamp_server(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_timestamp_server_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Use this property to provide the address of the Time Stamping Authority (TSA) server to be used for timestamping the signature.

SecureBlackbox supports RFC3161-compliant timestamping servers, available via HTTP or HTTPS.

If your timestamping service enforces credential-based user authentication (basic or digest), you can provide the credentials in the same URL:

http://user:password@timestamp.server.com/TsaService

For TSAs using certificate-based TLS authentication, provide the client certificate via the tls_client_chain property.

If this property is left empty, no timestamp will be added to the signature.

Starting from summer 2021 update (Vol. 2), the virtual timestamping service is supported, which allows you to intervene in the timestamping routine and provide your own handling for the TSA exchange. This may be handy if the service that you are requesting timestamps from uses a non-standard TSP protocol or requires special authentication option.

To employ the virtual service, assign an URI of the following format to this property:

virtual://localhost?hashonly=true&includecerts=true&reqpolicy=1.2.3.4.5&halg=SHA256&ignorenonce=true

Subscribe to on_notification event to get notified about the virtualized timestamping event. The EventID of the timestamping event is TimestampRequest. Inside the event handler, read the base16-encoded request from the EventParam parameter and forward it to the timestamping authority. Upon receiving the response, pass it back to the component, encoded in base16, via the TimestampResponse config property:

component.Config("TimestampResponse=308208ab...");

Note that all the exchange with your custom TSA should take place within the same invocation of the Notification event.

The hashonly parameter of the virtual URI tells the component to only return the timestamp message imprint via the EventParam parameter. If set to false, EventParam will contain the complete RFC3161 timestamping request.

The includecerts parameter specifies that the requestCertificates parameter of the timestamping request should be set to true.

The reqpolicy parameter lets you specify the request policy, and the halg parameter specifies the hash algorithm to use for timestamping.

The ignorenonce parameter allows you to switch off client nonce verification to enable compatibility with TSA services that do not support nonce mirroring.

All the parameters are optional.

Data Type

String

tls_server_cert_count property (DCAuthWebServer Struct)

The number of records in the TLSServerCert arrays.

Syntax

fn tls_server_cert_count(&self ) -> Result<i32, SecureBlackboxError> 
fn set_tls_server_cert_count(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• tls_server_cert_bytes
• tls_server_cert_handle

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

Data Type

i32

tls_server_cert_bytes property (DCAuthWebServer 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_handle property (DCAuthWebServer 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> 
fn set_tls_server_cert_handle(&self, TLSServerCertIndex : 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 TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

Data Type

i64

tls_auto_validate_certificates property (DCAuthWebServer 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 (DCAuthWebServer 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 (DCAuthWebServer 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 (DCAuthWebServer 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 (DCAuthWebServer 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 (DCAuthWebServer 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 (DCAuthWebServer 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 (DCAuthWebServer 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 (DCAuthWebServer 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 (DCAuthWebServer 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 (DCAuthWebServer 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 (DCAuthWebServer 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 (DCAuthWebServer 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 (DCAuthWebServer 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 (DCAuthWebServer 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 (DCAuthWebServer 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 (DCAuthWebServer 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

user_count property (DCAuthWebServer Struct)

The number of records in the User arrays.

Syntax

fn user_count(&self ) -> Result<i32, SecureBlackboxError> 
fn set_user_count(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• user_associated_data
• user_base_path
• user_data
• user_handle
• user_hash_algorithm
• user_incoming_speed_limit
• username
• user_outgoing_speed_limit
• user_password
• user_shared_secret

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

Data Type

i32

user_associated_data property (DCAuthWebServer Struct)

Contains the user's Associated Data when SSH AEAD (Authenticated Encryption with Associated Data) algorithm is used.

Syntax

fn user_associated_data(&self , UserIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 
fn set_user_associated_data(&self, UserIndex : i32, value : Vec<u8>) ->  Option<SecureBlackboxError> 
fn set_user_associated_data_ref(&self, UserIndex : i32, value : &[u8]) ->  Option<SecureBlackboxError> 

Remarks

Contains the user's Associated Data when SSH AEAD (Authenticated Encryption with Associated Data) algorithm is used.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

Vec

user_base_path property (DCAuthWebServer Struct)

Base path for this user in the server's file system.

Syntax

fn user_base_path(&self , UserIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_user_base_path(&self, UserIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_user_base_path_ref(&self, UserIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Base path for this user in the server's file system.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

String

user_data property (DCAuthWebServer Struct)

Contains uninterpreted user-defined data that should be associated with the user account, such as comments or custom settings.

Syntax

fn user_data(&self , UserIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_user_data(&self, UserIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_user_data_ref(&self, UserIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Contains uninterpreted user-defined data that should be associated with the user account, such as comments or custom settings.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

String

user_handle property (DCAuthWebServer Struct)

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

Syntax

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

Data Type

i64

user_hash_algorithm property (DCAuthWebServer Struct)

Specifies the hash algorithm used to generate TOTP (Time-based One-Time Passwords) passwords for this user.

Syntax

fn user_hash_algorithm(&self , UserIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_user_hash_algorithm(&self, UserIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_user_hash_algorithm_ref(&self, UserIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Specifies the hash algorithm used to generate TOTP (Time-based One-Time Passwords) passwords for this user. Three HMAC algorithms are supported, with SHA-1, SHA-256, and SHA-512 digests:

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

String

user_incoming_speed_limit property (DCAuthWebServer Struct)

Specifies the incoming speed limit for this user.

Syntax

fn user_incoming_speed_limit(&self , UserIndex : i32) -> Result<i32, SecureBlackboxError> 
fn set_user_incoming_speed_limit(&self, UserIndex : i32, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

Specifies the incoming speed limit for this user. The value of 0 (zero) means "no limitation".

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

i32

user_outgoing_speed_limit property (DCAuthWebServer Struct)

Specifies the outgoing speed limit for this user.

Syntax

fn user_outgoing_speed_limit(&self , UserIndex : i32) -> Result<i32, SecureBlackboxError> 
fn set_user_outgoing_speed_limit(&self, UserIndex : i32, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

Specifies the outgoing speed limit for this user. The value of 0 (zero) means "no limitation".

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

i32

user_password property (DCAuthWebServer Struct)

The user's authentication password.

Syntax

fn user_password(&self , UserIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_user_password(&self, UserIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_user_password_ref(&self, UserIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The user's authentication password.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

String

user_shared_secret property (DCAuthWebServer Struct)

Contains the user's secret key, which is essentially a shared secret between the client and server.

Syntax

fn user_shared_secret(&self , UserIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 
fn set_user_shared_secret(&self, UserIndex : i32, value : Vec<u8>) ->  Option<SecureBlackboxError> 
fn set_user_shared_secret_ref(&self, UserIndex : i32, value : &[u8]) ->  Option<SecureBlackboxError> 

Remarks

Contains the user's secret key, which is essentially a shared secret between the client and server.

Shared secrets can be used in TLS-driven protocols, as well as in OTP (where it is called a 'key secret') for generating one-time passwords on one side, and validate them on the other.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

Vec

username property (DCAuthWebServer Struct)

The registered name (login) of the user.

Syntax

fn username(&self , UserIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_username(&self, UserIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_username_ref(&self, UserIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The registered name (login) of the user.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

String

website_name property (DCAuthWebServer Struct)

Specifies the web site name to use in the certificate.

Syntax

fn website_name(&self ) -> Result<String, SecureBlackboxError> 
fn set_website_name(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_website_name_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

"secureblackbox"

Remarks

If using an internally-generated certificate, use this property to specify the web site name to be included as a common name. A typical common name consists of the host name, such as '192.168.10.10' or 'domain.com'.

Data Type

String

cleanup method (DCAuthWebServer Struct)

Cleans up the server environment by purging expired sessions and cleaning caches.

Syntax

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

Remarks

Call this method while the server is active to clean up the environment allocated for the server by releasing unused resources and cleaning caches.

config method (DCAuthWebServer 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 (DCAuthWebServer 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:

drop_client method (DCAuthWebServer Struct)

Terminates a client connection.

Syntax

fn drop_client(&self, connection_id : i64, forced : bool) -> Result<(), SecureBlackboxError>

Remarks

Call this method to shut down a connected client. Forced indicates whether the connection should be closed in a graceful manner.

list_clients method (DCAuthWebServer Struct)

Enumerates the connected clients.

Syntax

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

Remarks

This method enumerates the connected clients. It returns a list of strings, with each string being of 'ConnectionID|Address|Port' format, and representing a single connection.

pin_client method (DCAuthWebServer Struct)

Takes a snapshot of the connection's properties.

Syntax

fn pin_client(&self, connection_id : i64) -> Result<(), SecureBlackboxError>

Remarks

Use this method to take a snapshot of a connected client. The captured properties are populated in pinned_client and pinned_client_chain properties.

reset method (DCAuthWebServer Struct)

Resets the struct settings.

Syntax

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

Remarks

reset is a generic method available in every struct.

start method (DCAuthWebServer Struct)

Starts the server.

Syntax

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

Remarks

Use this method to activate the server and start listening to incoming connections.

stop method (DCAuthWebServer Struct)

Stops the server.

Syntax

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

Remarks

Call this method to stop listening to incoming connections and deactivate the server.

on_accept event (DCAuthWebServer Struct)

Reports an incoming connection.

Syntax

// DCAuthWebServerAcceptEventArgs carries the DCAuthWebServer Accept event's parameters.
pub struct DCAuthWebServerAcceptEventArgs {
  fn remote_address(&self) -> &String
  fn remote_port(&self) -> i32
  fn accept(&self) -> bool
  fn set_accept(&self, value : bool)
}

// DCAuthWebServerAcceptEvent defines the signature of the DCAuthWebServer Accept event's handler function.
pub trait DCAuthWebServerAcceptEvent {
  fn on_accept(&self, sender : DCAuthWebServer, e : &mut DCAuthWebServerAcceptEventArgs);
}

impl <'a> DCAuthWebServer<'a> {
  pub fn on_accept(&self) -> &'a dyn DCAuthWebServerAcceptEvent;
  pub fn set_on_accept(&mut self, value : &'a dyn DCAuthWebServerAcceptEvent);
  ...
}

Remarks

This event is fired when a new connection from RemoteAddress:RemotePort is ready to be accepted. Use the Accept parameter to accept or decline it.

Subscribe to on_connect event to be notified of every connection that has been set up.

on_auth_attempt event (DCAuthWebServer Struct)

Fires when a connected client makes an authentication attempt.

Syntax

// DCAuthWebServerAuthAttemptEventArgs carries the DCAuthWebServer AuthAttempt event's parameters.
pub struct DCAuthWebServerAuthAttemptEventArgs {
  fn connection_id(&self) -> i64
  fn http_method(&self) -> &String
  fn uri(&self) -> &String
  fn auth_method(&self) -> &String
  fn username(&self) -> &String
  fn password(&self) -> &String
  fn allow(&self) -> bool
  fn set_allow(&self, value : bool)
}

// DCAuthWebServerAuthAttemptEvent defines the signature of the DCAuthWebServer AuthAttempt event's handler function.
pub trait DCAuthWebServerAuthAttemptEvent {
  fn on_auth_attempt(&self, sender : DCAuthWebServer, e : &mut DCAuthWebServerAuthAttemptEventArgs);
}

impl <'a> DCAuthWebServer<'a> {
  pub fn on_auth_attempt(&self) -> &'a dyn DCAuthWebServerAuthAttemptEvent;
  pub fn set_on_auth_attempt(&mut self, value : &'a dyn DCAuthWebServerAuthAttemptEvent);
  ...
}

Remarks

The struct fires this event whenever a client attempts to authenticate itself. Use the Allow parameter to let the client through.

ConnectionID contains the unique session identifier for that client, HTTPMethod specifies the HTTP method (GET, POST, etc.) used to access the URI resource, AuthMethod specifies the authentication method, and Username and Password contain the professed credentials.

Note: In case of OAuth 2.0 authentication, Password contains an access token to be validated.

on_connect event (DCAuthWebServer Struct)

Reports an accepted connection.

Syntax

// DCAuthWebServerConnectEventArgs carries the DCAuthWebServer Connect event's parameters.
pub struct DCAuthWebServerConnectEventArgs {
  fn connection_id(&self) -> i64
  fn remote_address(&self) -> &String
  fn remote_port(&self) -> i32
}

// DCAuthWebServerConnectEvent defines the signature of the DCAuthWebServer Connect event's handler function.
pub trait DCAuthWebServerConnectEvent {
  fn on_connect(&self, sender : DCAuthWebServer, e : &mut DCAuthWebServerConnectEventArgs);
}

impl <'a> DCAuthWebServer<'a> {
  pub fn on_connect(&self) -> &'a dyn DCAuthWebServerConnectEvent;
  pub fn set_on_connect(&mut self, value : &'a dyn DCAuthWebServerConnectEvent);
  ...
}

Remarks

The struct fires this event to report that a new connection has been established. ConnectionId indicates the unique ID assigned to this connection. The same ID will be supplied to any other events related to this connection, such as on_tls_handshake or on_data.

on_custom_parameters_received event (DCAuthWebServer Struct)

Passes custom request parameters to the application.

Syntax

// DCAuthWebServerCustomParametersReceivedEventArgs carries the DCAuthWebServer CustomParametersReceived event's parameters.
pub struct DCAuthWebServerCustomParametersReceivedEventArgs {
  fn connection_id(&self) -> i64
  fn value(&self) -> &String
}

// DCAuthWebServerCustomParametersReceivedEvent defines the signature of the DCAuthWebServer CustomParametersReceived event's handler function.
pub trait DCAuthWebServerCustomParametersReceivedEvent {
  fn on_custom_parameters_received(&self, sender : DCAuthWebServer, e : &mut DCAuthWebServerCustomParametersReceivedEventArgs);
}

impl <'a> DCAuthWebServer<'a> {
  pub fn on_custom_parameters_received(&self) -> &'a dyn DCAuthWebServerCustomParametersReceivedEvent;
  pub fn set_on_custom_parameters_received(&mut self, value : &'a dyn DCAuthWebServerCustomParametersReceivedEvent);
  ...
}

Remarks

Subscribe to this event to access custom signing parameters supplied by the signer in their request. The Value string contains the parameters as included by the requestor.

on_disconnect event (DCAuthWebServer Struct)

Fires to report a disconnected client.

Syntax

// DCAuthWebServerDisconnectEventArgs carries the DCAuthWebServer Disconnect event's parameters.
pub struct DCAuthWebServerDisconnectEventArgs {
  fn connection_id(&self) -> i64
}

// DCAuthWebServerDisconnectEvent defines the signature of the DCAuthWebServer Disconnect event's handler function.
pub trait DCAuthWebServerDisconnectEvent {
  fn on_disconnect(&self, sender : DCAuthWebServer, e : &mut DCAuthWebServerDisconnectEventArgs);
}

impl <'a> DCAuthWebServer<'a> {
  pub fn on_disconnect(&self) -> &'a dyn DCAuthWebServerDisconnectEvent;
  pub fn set_on_disconnect(&mut self, value : &'a dyn DCAuthWebServerDisconnectEvent);
  ...
}

Remarks

The struct fires this event when a connected client disconnects.

on_error event (DCAuthWebServer Struct)

Information about errors during data delivery.

Syntax

// DCAuthWebServerErrorEventArgs carries the DCAuthWebServer Error event's parameters.
pub struct DCAuthWebServerErrorEventArgs {
  fn connection_id(&self) -> i64
  fn error_code(&self) -> i32
  fn fatal(&self) -> bool
  fn remote(&self) -> bool
  fn description(&self) -> &String
}

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

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

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

Handles remote or external signing initiated by the server protocol.

Syntax

// DCAuthWebServerExternalSignEventArgs carries the DCAuthWebServer ExternalSign event's parameters.
pub struct DCAuthWebServerExternalSignEventArgs {
  fn connection_id(&self) -> i64
  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)
}

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

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

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_key_secret_needed event (DCAuthWebServer Struct)

Requests the key secret from the application.

Syntax

// DCAuthWebServerKeySecretNeededEventArgs carries the DCAuthWebServer KeySecretNeeded event's parameters.
pub struct DCAuthWebServerKeySecretNeededEventArgs {
  fn connection_id(&self) -> i64
  fn key_id(&self) -> &String
  fn key_secret(&self) -> &String
  fn set_key_secret(&self, value : &str)
  fn set_key_secret_ref(&self, value : &String)
}

// DCAuthWebServerKeySecretNeededEvent defines the signature of the DCAuthWebServer KeySecretNeeded event's handler function.
pub trait DCAuthWebServerKeySecretNeededEvent {
  fn on_key_secret_needed(&self, sender : DCAuthWebServer, e : &mut DCAuthWebServerKeySecretNeededEventArgs);
}

impl <'a> DCAuthWebServer<'a> {
  pub fn on_key_secret_needed(&self) -> &'a dyn DCAuthWebServerKeySecretNeededEvent;
  pub fn set_on_key_secret_needed(&mut self, value : &'a dyn DCAuthWebServerKeySecretNeededEvent);
  ...
}

Remarks

Subscribe to this event to pass the key secret (a pre-shared request authentication code) to the signing component when it is needed. The authentication combination consists of the KeyId, a non-secret unique key identifier, and the KeySecret, shared by the parties, which should be kept private. This event is an alternative for key_secret property. Use it when you expect to process requests from requestors with different KeyIds and secrets. If you only expect to receive requests from a single requestor with a known KeyId, providing the key secret via key_id and key_secret properties would be an easier route.

on_log event (DCAuthWebServer Struct)

Reports a single log line.

Syntax

// DCAuthWebServerLogEventArgs carries the DCAuthWebServer Log event's parameters.
pub struct DCAuthWebServerLogEventArgs {
  fn connection_id(&self) -> i64
  fn log_type(&self) -> i32
  fn details(&self) -> &String
}

// DCAuthWebServerLogEvent defines the signature of the DCAuthWebServer Log event's handler function.
pub trait DCAuthWebServerLogEvent {
  fn on_log(&self, sender : DCAuthWebServer, e : &mut DCAuthWebServerLogEventArgs);
}

impl <'a> DCAuthWebServer<'a> {
  pub fn on_log(&self) -> &'a dyn DCAuthWebServerLogEvent;
  pub fn set_on_log(&mut self, value : &'a dyn DCAuthWebServerLogEvent);
  ...
}

Remarks

This event is fired repeatedly during the component's work to inform the application about the flow of the signing process. The application may use this event to create an operation log.

on_notification event (DCAuthWebServer Struct)

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

Syntax

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

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

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

Remarks

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

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

on_parameter_received event (DCAuthWebServer Struct)

Passes a standard request parameter to the user code.

Syntax

// DCAuthWebServerParameterReceivedEventArgs carries the DCAuthWebServer ParameterReceived event's parameters.
pub struct DCAuthWebServerParameterReceivedEventArgs {
  fn connection_id(&self) -> i64
  fn name(&self) -> &String
  fn value(&self) -> &String
}

// DCAuthWebServerParameterReceivedEvent defines the signature of the DCAuthWebServer ParameterReceived event's handler function.
pub trait DCAuthWebServerParameterReceivedEvent {
  fn on_parameter_received(&self, sender : DCAuthWebServer, e : &mut DCAuthWebServerParameterReceivedEventArgs);
}

impl <'a> DCAuthWebServer<'a> {
  pub fn on_parameter_received(&self) -> &'a dyn DCAuthWebServerParameterReceivedEvent;
  pub fn set_on_parameter_received(&mut self, value : &'a dyn DCAuthWebServerParameterReceivedEvent);
  ...
}

Remarks

This event is fired when one of 'standard' protocol parameters has been found in the request:

• SessionID
• DataURL
• GoURL
• Token
• PKCS11Libraries
• AllowFileStorage
• AllowTokenStorage
• AllowWindowsStorage
• AllowOSStorage

Parameters are reported one-by-one upon being processed.

on_password_needed event (DCAuthWebServer Struct)

Requests a password from the application.

Syntax

// DCAuthWebServerPasswordNeededEventArgs carries the DCAuthWebServer PasswordNeeded event's parameters.
pub struct DCAuthWebServerPasswordNeededEventArgs {
  fn needed_for(&self) -> &String
  fn id(&self) -> &String
  fn password(&self) -> &String
  fn set_password(&self, value : &str)
  fn set_password_ref(&self, value : &String)
  fn cancel(&self) -> bool
  fn set_cancel(&self, value : bool)
}

// DCAuthWebServerPasswordNeededEvent defines the signature of the DCAuthWebServer PasswordNeeded event's handler function.
pub trait DCAuthWebServerPasswordNeededEvent {
  fn on_password_needed(&self, sender : DCAuthWebServer, e : &mut DCAuthWebServerPasswordNeededEventArgs);
}

impl <'a> DCAuthWebServer<'a> {
  pub fn on_password_needed(&self) -> &'a dyn DCAuthWebServerPasswordNeededEvent;
  pub fn set_on_password_needed(&mut self, value : &'a dyn DCAuthWebServerPasswordNeededEvent);
  ...
}

Remarks

Subscribe to this event to pass a password to the server component. The NeededFor parameter specifies the entity a password for which is being requested (which is typically a certificate). The Id parameter provides the entity's identifier, such as a path to the certificate being loaded. When handling this event, assign the Password to the valid password if you have it; otherwise, set Cancel to true to abort the operation.

on_read_option event (DCAuthWebServer Struct)

Fires when the client sends in a read option request.

Syntax

// DCAuthWebServerReadOptionEventArgs carries the DCAuthWebServer ReadOption event's parameters.
pub struct DCAuthWebServerReadOptionEventArgs {
  fn connection_id(&self) -> i64
  fn name(&self) -> &String
  fn value(&self) -> &String
  fn set_value(&self, value : &str)
  fn set_value_ref(&self, value : &String)
  fn success(&self) -> bool
  fn set_success(&self, value : bool)
}

// DCAuthWebServerReadOptionEvent defines the signature of the DCAuthWebServer ReadOption event's handler function.
pub trait DCAuthWebServerReadOptionEvent {
  fn on_read_option(&self, sender : DCAuthWebServer, e : &mut DCAuthWebServerReadOptionEventArgs);
}

impl <'a> DCAuthWebServer<'a> {
  pub fn on_read_option(&self) -> &'a dyn DCAuthWebServerReadOptionEvent;
  pub fn set_on_read_option(&mut self, value : &'a dyn DCAuthWebServerReadOptionEvent);
  ...
}

Remarks

Subscribe to this event to respond to the clients' read option requests. The handler should retrieve the value of the requested option from a local configuration setting and assign it to the Value parameter.

on_select_cert event (DCAuthWebServer Struct)

Requests certificate selection criteria from the application.

Syntax

// DCAuthWebServerSelectCertEventArgs carries the DCAuthWebServer SelectCert event's parameters.
pub struct DCAuthWebServerSelectCertEventArgs {
  fn connection_id(&self) -> i64
  fn common_name(&self) -> &String
  fn set_common_name(&self, value : &str)
  fn set_common_name_ref(&self, value : &String)
  fn key_id(&self) -> &String
  fn set_key_id(&self, value : &str)
  fn set_key_id_ref(&self, value : &String)
  fn key_usage(&self) -> &String
  fn set_key_usage(&self, value : &str)
  fn set_key_usage_ref(&self, value : &String)
  fn fingerprint(&self) -> &String
  fn set_fingerprint(&self, value : &str)
  fn set_fingerprint_ref(&self, value : &String)
  fn store_type(&self) -> &String
  fn set_store_type(&self, value : &str)
  fn set_store_type_ref(&self, value : &String)
}

// DCAuthWebServerSelectCertEvent defines the signature of the DCAuthWebServer SelectCert event's handler function.
pub trait DCAuthWebServerSelectCertEvent {
  fn on_select_cert(&self, sender : DCAuthWebServer, e : &mut DCAuthWebServerSelectCertEventArgs);
}

impl <'a> DCAuthWebServer<'a> {
  pub fn on_select_cert(&self) -> &'a dyn DCAuthWebServerSelectCertEvent;
  pub fn set_on_select_cert(&mut self, value : &'a dyn DCAuthWebServerSelectCertEvent);
  ...
}

Remarks

Subscribe to this event to provide signing certificate details on the fly, right before the hash is signed.

on_sign_request event (DCAuthWebServer Struct)

This event signifies the processing of an atomic signing request.

Syntax

// DCAuthWebServerSignRequestEventArgs carries the DCAuthWebServer SignRequest event's parameters.
pub struct DCAuthWebServerSignRequestEventArgs {
  fn connection_id(&self) -> i64
  fn method(&self) -> i32
  fn hash_algorithm(&self) -> &String
  fn hash(&self) -> &[u8]
  fn key_id(&self) -> &String
  fn pars(&self) -> &String
  fn method_pars(&self) -> &String
  fn allow(&self) -> bool
  fn set_allow(&self, value : bool)
}

// DCAuthWebServerSignRequestEvent defines the signature of the DCAuthWebServer SignRequest event's handler function.
pub trait DCAuthWebServerSignRequestEvent {
  fn on_sign_request(&self, sender : DCAuthWebServer, e : &mut DCAuthWebServerSignRequestEventArgs);
}

impl <'a> DCAuthWebServer<'a> {
  pub fn on_sign_request(&self) -> &'a dyn DCAuthWebServerSignRequestEvent;
  pub fn set_on_sign_request(&mut self, value : &'a dyn DCAuthWebServerSignRequestEvent);
  ...
}

Remarks

Subscribe to this event to be notified of every signature request processed by the DC server. Note that any one request coming from the requestor may contain multiple individual signature requests (so-called 'batching'). This event is a good mechanism to track signature requests for accountability purposes, and provide basic access control over the signing operations. The Method parameter specifies the async signing method requested by the client:

The Hash parameter contains the hash, made using HashAlgorithm, that needs to be signed. KeyID contains the key identifier of the requestor.

The Pars string contains a semicolon-separated string of the principal signature parameters. This has the same format and content that is passed to on_external_sign, if it is used. The MethodPars contains a similar parameter string, but for the specific async signing method used. For the PKCS1 method there are no defined method parameters, while the PKCS7 method supports a selection of settings that tune up the CMS blob.

Set Allow to false to reject the request. Use the on_sign_request_completed event to track completion of the initiated operation.

on_sign_request_completed event (DCAuthWebServer Struct)

This event signifies completion of the processing of an atomic signing request.

Syntax

// DCAuthWebServerSignRequestCompletedEventArgs carries the DCAuthWebServer SignRequestCompleted event's parameters.
pub struct DCAuthWebServerSignRequestCompletedEventArgs {
  fn connection_id(&self) -> i64
  fn method(&self) -> i32
  fn hash_algorithm(&self) -> &String
  fn hash(&self) -> &[u8]
  fn key_id(&self) -> &String
  fn pars(&self) -> &String
  fn method_pars(&self) -> &String
  fn signature(&self) -> &[u8]
}

// DCAuthWebServerSignRequestCompletedEvent defines the signature of the DCAuthWebServer SignRequestCompleted event's handler function.
pub trait DCAuthWebServerSignRequestCompletedEvent {
  fn on_sign_request_completed(&self, sender : DCAuthWebServer, e : &mut DCAuthWebServerSignRequestCompletedEventArgs);
}

impl <'a> DCAuthWebServer<'a> {
  pub fn on_sign_request_completed(&self) -> &'a dyn DCAuthWebServerSignRequestCompletedEvent;
  pub fn set_on_sign_request_completed(&mut self, value : &'a dyn DCAuthWebServerSignRequestCompletedEvent);
  ...
}

Remarks

Use this event to track completion of signing request processing. The Hash parameter contains the hash that is signed, as supplied by the requestor, and the Signature parameter contains the resulting cryptographic signature. The Username parameter matches the parameter in on_sign_request event.

on_timestamp_request event (DCAuthWebServer Struct)

Fires when the struct is ready to request a timestamp from an external TSA.

Syntax

// DCAuthWebServerTimestampRequestEventArgs carries the DCAuthWebServer TimestampRequest event's parameters.
pub struct DCAuthWebServerTimestampRequestEventArgs {
  fn tsa(&self) -> &String
  fn timestamp_request(&self) -> &String
  fn timestamp_response(&self) -> &String
  fn set_timestamp_response(&self, value : &str)
  fn set_timestamp_response_ref(&self, value : &String)
  fn suppress_default(&self) -> bool
  fn set_suppress_default(&self, value : bool)
}

// DCAuthWebServerTimestampRequestEvent defines the signature of the DCAuthWebServer TimestampRequest event's handler function.
pub trait DCAuthWebServerTimestampRequestEvent {
  fn on_timestamp_request(&self, sender : DCAuthWebServer, e : &mut DCAuthWebServerTimestampRequestEventArgs);
}

impl <'a> DCAuthWebServer<'a> {
  pub fn on_timestamp_request(&self) -> &'a dyn DCAuthWebServerTimestampRequestEvent;
  pub fn set_on_timestamp_request(&mut self, value : &'a dyn DCAuthWebServerTimestampRequestEvent);
  ...
}

Remarks

Subscribe to this event to intercept timestamp requests. You can use it to override timestamping requests and perform them in your code.

The TSA parameter indicates the timestamping service being used. It matches the value passed to the timestamp_server property. Set the SuppressDefault parameter to true if you would like to stop the built-in TSA request from going ahead. The built-in TSA request is also not performed if the returned TimestampResponse parameter is not empty.

on_tls_cert_validate event (DCAuthWebServer Struct)

Fires when a client certificate needs to be validated.

Syntax

// DCAuthWebServerTLSCertValidateEventArgs carries the DCAuthWebServer TLSCertValidate event's parameters.
pub struct DCAuthWebServerTLSCertValidateEventArgs {
  fn connection_id(&self) -> i64
  fn accept(&self) -> bool
  fn set_accept(&self, value : bool)
}

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

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

Remarks

The struct fires this event to notify the application of an authenticating client. Use the event handler to validate the certificate and pass your decision back to the server component via the Accept parameter.

on_tls_established event (DCAuthWebServer Struct)

Reports the setup of a TLS session.

Syntax

// DCAuthWebServerTLSEstablishedEventArgs carries the DCAuthWebServer TLSEstablished event's parameters.
pub struct DCAuthWebServerTLSEstablishedEventArgs {
  fn connection_id(&self) -> i64
}

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

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

Remarks

Subscribe to this event to be notified about the setup of a TLS connection by a connected client.

on_tls_handshake event (DCAuthWebServer Struct)

Fires when a newly established client connection initiates a TLS handshake.

Syntax

// DCAuthWebServerTLSHandshakeEventArgs carries the DCAuthWebServer TLSHandshake event's parameters.
pub struct DCAuthWebServerTLSHandshakeEventArgs {
  fn connection_id(&self) -> i64
  fn server_name(&self) -> &String
  fn abort(&self) -> bool
  fn set_abort(&self, value : bool)
}

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

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

Remarks

Use this event to get notified about the initiation of the TLS handshake by the remote client. The ServerName parameter specifies the requested host from the client hello message.

on_tls_psk event (DCAuthWebServer Struct)

Requests a pre-shared key for TLS-PSK.

Syntax

// DCAuthWebServerTLSPSKEventArgs carries the DCAuthWebServer TLSPSK event's parameters.
pub struct DCAuthWebServerTLSPSKEventArgs {
  fn connection_id(&self) -> i64
  fn identity(&self) -> &String
  fn psk(&self) -> &String
  fn set_psk(&self, value : &str)
  fn set_psk_ref(&self, value : &String)
  fn ciphersuite(&self) -> &String
  fn set_ciphersuite(&self, value : &str)
  fn set_ciphersuite_ref(&self, value : &String)
}

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

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

Remarks

The struct fires this event to report that a client has requested a TLS-PSK negotiation. ConnectionId indicates the unique connection ID that requested the PSK handshake.

Use Identity to look up for the corresponding pre-shared key in the server's database, then assign the key to the PSK parameter. If TLS 1.3 PSK is used, you will also need to assign the Ciphersuite parameter with the cipher suite associated with that identity and their key.

on_tls_shutdown event (DCAuthWebServer Struct)

Reports closure of a TLS session.

Syntax

// DCAuthWebServerTLSShutdownEventArgs carries the DCAuthWebServer TLSShutdown event's parameters.
pub struct DCAuthWebServerTLSShutdownEventArgs {
  fn connection_id(&self) -> i64
}

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

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

Remarks

The struct fires this event when a connected client closes their TLS session gracefully. This event is typically followed by a on_disconnect, which marks the closure of the underlying TCP session.

on_write_option event (DCAuthWebServer Struct)

Fires when the client sends in a write option request.

Syntax

// DCAuthWebServerWriteOptionEventArgs carries the DCAuthWebServer WriteOption event's parameters.
pub struct DCAuthWebServerWriteOptionEventArgs {
  fn connection_id(&self) -> i64
  fn name(&self) -> &String
  fn value(&self) -> &String
}

// DCAuthWebServerWriteOptionEvent defines the signature of the DCAuthWebServer WriteOption event's handler function.
pub trait DCAuthWebServerWriteOptionEvent {
  fn on_write_option(&self, sender : DCAuthWebServer, e : &mut DCAuthWebServerWriteOptionEventArgs);
}

impl <'a> DCAuthWebServer<'a> {
  pub fn on_write_option(&self) -> &'a dyn DCAuthWebServerWriteOptionEvent;
  pub fn set_on_write_option(&mut self, value : &'a dyn DCAuthWebServerWriteOptionEvent);
  ...
}

Remarks

Subscribe to this event to respond to the clients' write option requests. The handler should save the Value of the Name option to a local configuration database.

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

DCAuthWebServer Config Settings

Base Config Settings

Trappable Errors (DCAuthWebServer Struct)