# Struct secureblackbox::DCAuthWebServer The DCAuthWebServer Struct offers higher-level access to 'private key side' functionality of SecureBlackbox DC protocol. ## Syntax ```text 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](#port-property-dcauthwebserver-struct) or a port chosen between [port_range_from](#port_range_from-property-dcauthwebserver-struct) and [port_range_to](#port_range_to-property-dcauthwebserver-struct). Use [DCAuth](DCAuth.md#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.* | | | | --- | --- | | [active](#active-property-dcauthwebserver-struct) | Indicates whether the server is active and is listening to new connections. | | [allow_origin](#allow_origin-property-dcauthwebserver-struct) | Specifies the content of AllowOrigin header of the service reply. | | [auth_realm](#auth_realm-property-dcauthwebserver-struct) | Specifies authentication realm for digest and NTLM authentication. | | [auth_types](#auth_types-property-dcauthwebserver-struct) | Defines allowed HTTP authentication types. | | [bound_port](#bound_port-property-dcauthwebserver-struct) | Indicates the bound listening port. | | [external_crypto_async_document_id](#external_crypto_async_document_id-property-dcauthwebserver-struct) | Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls. | | [external_crypto_custom_params](#external_crypto_custom_params-property-dcauthwebserver-struct) | Custom parameters to be passed to the signing service (uninterpreted). | | [external_crypto_data](#external_crypto_data-property-dcauthwebserver-struct) | Additional data to be included in the async state and mirrored back by the requestor. | | [external_crypto_external_hash_calculation](#external_crypto_external_hash_calculation-property-dcauthwebserver-struct) | Specifies whether the message hash is to be calculated at the external endpoint. | | [external_crypto_hash_algorithm](#external_crypto_hash_algorithm-property-dcauthwebserver-struct) | Specifies the request's signature hash algorithm. | | [external_crypto_key_id](#external_crypto_key_id-property-dcauthwebserver-struct) | The ID of the pre-shared key used for DC request authentication. | | [external_crypto_key_secret](#external_crypto_key_secret-property-dcauthwebserver-struct) | The pre-shared key used for DC request authentication. | | [external_crypto_method](#external_crypto_method-property-dcauthwebserver-struct) | Specifies the asynchronous signing method. | | [external_crypto_mode](#external_crypto_mode-property-dcauthwebserver-struct) | Specifies the external cryptography mode. | | [external_crypto_public_key_algorithm](#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. | | [fips_mode](#fips_mode-property-dcauthwebserver-struct) | Reserved. | | [handshake_timeout](#handshake_timeout-property-dcauthwebserver-struct) | Specifies the handshake timeout in milliseconds. | | [host](#host-property-dcauthwebserver-struct) | The host to bind the listening port to. | | [key_id](#key_id-property-dcauthwebserver-struct) | Specifies the KeyID of the pre-shared authentication key. | | [key_secret](#key_secret-property-dcauthwebserver-struct) | The pre-shared authentication key. | | [pinned_client_aead_cipher](#pinned_client_aead_cipher-property-dcauthwebserver-struct) | Indicates whether the encryption algorithm used is an AEAD cipher. | | [pinned_client_chain_validation_details](#pinned_client_chain_validation_details-property-dcauthwebserver-struct) | The details of a certificate chain validation outcome. | | [pinned_client_chain_validation_result](#pinned_client_chain_validation_result-property-dcauthwebserver-struct) | The outcome of a certificate chain validation routine. | | [pinned_client_ciphersuite](#pinned_client_ciphersuite-property-dcauthwebserver-struct) | The cipher suite employed by this connection. | | [pinned_client_client_authenticated](#pinned_client_client_authenticated-property-dcauthwebserver-struct) | Specifies whether client authentication was performed during this connection. | | [pinned_client_client_auth_requested](#pinned_client_client_auth_requested-property-dcauthwebserver-struct) | Specifies whether client authentication was requested during this connection. | | [pinned_client_connection_established](#pinned_client_connection_established-property-dcauthwebserver-struct) | Indicates whether the connection has been established fully. | | [pinned_client_connection_id](#pinned_client_connection_id-property-dcauthwebserver-struct) | The unique identifier assigned to this connection. | | [pinned_client_digest_algorithm](#pinned_client_digest_algorithm-property-dcauthwebserver-struct) | The digest algorithm used in a TLS-enabled connection. | | [pinned_client_encryption_algorithm](#pinned_client_encryption_algorithm-property-dcauthwebserver-struct) | The symmetric encryption algorithm used in a TLS-enabled connection. | | [pinned_client_exportable](#pinned_client_exportable-property-dcauthwebserver-struct) | Indicates whether a TLS connection uses a reduced-strength exportable cipher. | | [pinned_client_group](#pinned_client_group-property-dcauthwebserver-struct) | The elliptic curve used in this connection. | | [pinned_client_id](#pinned_client_id-property-dcauthwebserver-struct) | The client connection's unique identifier. | | [pinned_client_key_exchange_algorithm](#pinned_client_key_exchange_algorithm-property-dcauthwebserver-struct) | The key exchange algorithm used in a TLS-enabled connection. | | [pinned_client_key_exchange_key_bits](#pinned_client_key_exchange_key_bits-property-dcauthwebserver-struct) | The length of the key exchange key of a TLS-enabled connection. | | [pinned_client_pfs_cipher](#pinned_client_pfs_cipher-property-dcauthwebserver-struct) | Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS). | | [pinned_client_pre_shared_identity](#pinned_client_pre_shared_identity-property-dcauthwebserver-struct) | Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. | | [pinned_client_pre_shared_identity_hint](#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. | | [pinned_client_public_key_bits](#pinned_client_public_key_bits-property-dcauthwebserver-struct) | The length of the public key. | | [pinned_client_remote_address](#pinned_client_remote_address-property-dcauthwebserver-struct) | The client's IP address. | | [pinned_client_remote_port](#pinned_client_remote_port-property-dcauthwebserver-struct) | The remote port of the client connection. | | [pinned_client_resumed_session](#pinned_client_resumed_session-property-dcauthwebserver-struct) | Indicates whether a TLS-enabled connection was spawned from another TLS connection. | | [pinned_client_secure_connection](#pinned_client_secure_connection-property-dcauthwebserver-struct) | Indicates whether TLS or SSL is enabled for this connection. | | [pinned_client_server_authenticated](#pinned_client_server_authenticated-property-dcauthwebserver-struct) | Indicates whether server authentication was performed during a TLS-enabled connection. | | [pinned_client_signature_algorithm](#pinned_client_signature_algorithm-property-dcauthwebserver-struct) | The signature algorithm used in a TLS handshake. | | [pinned_client_symmetric_block_size](#pinned_client_symmetric_block_size-property-dcauthwebserver-struct) | The block size of the symmetric algorithm used. | | [pinned_client_symmetric_key_bits](#pinned_client_symmetric_key_bits-property-dcauthwebserver-struct) | The key length of the symmetric algorithm used. | | [pinned_client_total_bytes_received](#pinned_client_total_bytes_received-property-dcauthwebserver-struct) | The total number of bytes received over this connection. | | [pinned_client_total_bytes_sent](#pinned_client_total_bytes_sent-property-dcauthwebserver-struct) | The total number of bytes sent over this connection. | | [pinned_client_validation_log](#pinned_client_validation_log-property-dcauthwebserver-struct) | Contains the server certificate's chain validation log. | | [pinned_client_version](#pinned_client_version-property-dcauthwebserver-struct) | Indicates the version of SSL/TLS protocol negotiated during this connection. | | [pinned_client_cert_count](#pinned_client_cert_count-property-dcauthwebserver-struct) | The number of records in the PinnedClientCert arrays. | | [pinned_client_cert_bytes](#pinned_client_cert_bytes-property-dcauthwebserver-struct) | Returns the raw certificate data in DER format. | | [pinned_client_cert_ca_key_id](#pinned_client_cert_ca_key_id-property-dcauthwebserver-struct) | A unique identifier (fingerprint) of the CA certificate's cryptographic key. | | [pinned_client_cert_fingerprint](#pinned_client_cert_fingerprint-property-dcauthwebserver-struct) | Contains the fingerprint (a hash imprint) of this certificate. | | [pinned_client_cert_handle](#pinned_client_cert_handle-property-dcauthwebserver-struct) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [pinned_client_cert_issuer](#pinned_client_cert_issuer-property-dcauthwebserver-struct) | The common name of the certificate issuer (CA), typically a company name. | | [pinned_client_cert_issuer_rdn](#pinned_client_cert_issuer_rdn-property-dcauthwebserver-struct) | A list of Property=Value pairs that uniquely identify the certificate issuer. | | [pinned_client_cert_key_algorithm](#pinned_client_cert_key_algorithm-property-dcauthwebserver-struct) | Specifies the public key algorithm of this certificate. | | [pinned_client_cert_key_bits](#pinned_client_cert_key_bits-property-dcauthwebserver-struct) | Returns the length of the public key in bits. | | [pinned_client_cert_key_fingerprint](#pinned_client_cert_key_fingerprint-property-dcauthwebserver-struct) | Returns a SHA1 fingerprint of the public key contained in the certificate. | | [pinned_client_cert_key_usage](#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. | | [pinned_client_cert_public_key_bytes](#pinned_client_cert_public_key_bytes-property-dcauthwebserver-struct) | Contains the certificate's public key in DER format. | | [pinned_client_cert_self_signed](#pinned_client_cert_self_signed-property-dcauthwebserver-struct) | Indicates whether the certificate is self-signed (root) or signed by an external CA. | | [pinned_client_cert_serial_number](#pinned_client_cert_serial_number-property-dcauthwebserver-struct) | Returns the certificate's serial number. | | [pinned_client_cert_sig_algorithm](#pinned_client_cert_sig_algorithm-property-dcauthwebserver-struct) | Indicates the algorithm that was used by the CA to sign this certificate. | | [pinned_client_cert_subject](#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. | | [pinned_client_cert_subject_key_id](#pinned_client_cert_subject_key_id-property-dcauthwebserver-struct) | Contains a unique identifier of the certificate's cryptographic key. | | [pinned_client_cert_subject_rdn](#pinned_client_cert_subject_rdn-property-dcauthwebserver-struct) | A list of Property=Value pairs that uniquely identify the certificate holder (subject). | | [pinned_client_cert_valid_from](#pinned_client_cert_valid_from-property-dcauthwebserver-struct) | The time point at which the certificate becomes valid, in UTC. | | [pinned_client_cert_valid_to](#pinned_client_cert_valid_to-property-dcauthwebserver-struct) | The time point at which the certificate expires, in UTC. | | [policies](#policies-property-dcauthwebserver-struct) | Specifies the policies to use when processing requests. | | [port](#port-property-dcauthwebserver-struct) | Specifies the port number to listen for connections on. | | [port_range_from](#port_range_from-property-dcauthwebserver-struct) | Specifies the lower limit of the listening port range for incoming connections. | | [port_range_to](#port_range_to-property-dcauthwebserver-struct) | Specifies the upper limit of the listening port range for incoming connections. | | [session_timeout](#session_timeout-property-dcauthwebserver-struct) | Specifies the default session timeout value in milliseconds. | | [sign_endpoint](#sign_endpoint-property-dcauthwebserver-struct) | The signing service endpoint. | | [signing_cert_bytes](#signing_cert_bytes-property-dcauthwebserver-struct) | Returns the raw certificate data in DER format. | | [signing_cert_handle](#signing_cert_handle-property-dcauthwebserver-struct) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [signing_chain_count](#signing_chain_count-property-dcauthwebserver-struct) | The number of records in the SigningChain arrays. | | [signing_chain_bytes](#signing_chain_bytes-property-dcauthwebserver-struct) | Returns the raw certificate data in DER format. | | [signing_chain_handle](#signing_chain_handle-property-dcauthwebserver-struct) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [socket_incoming_speed_limit](#socket_incoming_speed_limit-property-dcauthwebserver-struct) | The maximum number of bytes to read from the socket, per second. | | [socket_local_address](#socket_local_address-property-dcauthwebserver-struct) | The local network interface to bind the socket to. | | [socket_local_port](#socket_local_port-property-dcauthwebserver-struct) | The local port number to bind the socket to. | | [socket_outgoing_speed_limit](#socket_outgoing_speed_limit-property-dcauthwebserver-struct) | The maximum number of bytes to write to the socket, per second. | | [socket_timeout](#socket_timeout-property-dcauthwebserver-struct) | The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful. | | [socket_use_ipv6](#socket_use_ipv6-property-dcauthwebserver-struct) | Enables or disables IP protocol version 6. | | [storage_id](#storage_id-property-dcauthwebserver-struct) | Specifies the signing certificate residing in an alternative location. | | [timestamp_server](#timestamp_server-property-dcauthwebserver-struct) | The address of the timestamping server. | | [tls_server_cert_count](#tls_server_cert_count-property-dcauthwebserver-struct) | The number of records in the TLSServerCert arrays. | | [tls_server_cert_bytes](#tls_server_cert_bytes-property-dcauthwebserver-struct) | Returns the raw certificate data in DER format. | | [tls_server_cert_handle](#tls_server_cert_handle-property-dcauthwebserver-struct) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [tls_auto_validate_certificates](#tls_auto_validate_certificates-property-dcauthwebserver-struct) | Specifies whether server-side TLS certificates should be validated automatically using internal validation rules. | | [tls_base_configuration](#tls_base_configuration-property-dcauthwebserver-struct) | Selects the base configuration for the TLS settings. | | [tls_ciphersuites](#tls_ciphersuites-property-dcauthwebserver-struct) | A list of ciphersuites separated with commas or semicolons. | | [tls_client_auth](#tls_client_auth-property-dcauthwebserver-struct) | Enables or disables certificate-based client authentication. | | [tls_extensions](#tls_extensions-property-dcauthwebserver-struct) | Provides access to TLS extensions. | | [tls_force_resume_if_destination_changes](#tls_force_resume_if_destination_changes-property-dcauthwebserver-struct) | Whether to force TLS session resumption when the destination address changes. | | [tls_groups](#tls_groups-property-dcauthwebserver-struct) | Specifies a list of key exchange groups to attempt during the TLS key exchange. | | [tls_pre_shared_identity](#tls_pre_shared_identity-property-dcauthwebserver-struct) | Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. | | [tls_pre_shared_key](#tls_pre_shared_key-property-dcauthwebserver-struct) | Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16. | | [tls_pre_shared_key_ciphersuite](#tls_pre_shared_key_ciphersuite-property-dcauthwebserver-struct) | Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation. | | [tls_renegotiation_attack_prevention_mode](#tls_renegotiation_attack_prevention_mode-property-dcauthwebserver-struct) | Selects the renegotiation attack prevention mechanism. | | [tls_revocation_check](#tls_revocation_check-property-dcauthwebserver-struct) | Specifies the kind(s) of revocation check to perform. | | [tls_ssl_options](#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. | | [tls_mode](#tls_mode-property-dcauthwebserver-struct) | Specifies the TLS mode to use. | | [tls_use_extended_master_secret](#tls_use_extended_master_secret-property-dcauthwebserver-struct) | Enables the Extended Master Secret Extension, as defined in RFC 7627. | | [tls_use_session_resumption](#tls_use_session_resumption-property-dcauthwebserver-struct) | Enables or disables the TLS session resumption capability. | | [tls_versions](#tls_versions-property-dcauthwebserver-struct) | The SSL/TLS versions to enable by default. | | [user_count](#user_count-property-dcauthwebserver-struct) | The number of records in the User arrays. | | [user_associated_data](#user_associated_data-property-dcauthwebserver-struct) | Contains the user's Associated Data when SSH AEAD (Authenticated Encryption with Associated Data) algorithm is used. | | [user_base_path](#user_base_path-property-dcauthwebserver-struct) | Base path for this user in the server's file system. | | [user_data](#user_data-property-dcauthwebserver-struct) | Contains uninterpreted user-defined data that should be associated with the user account, such as comments or custom settings. | | [user_handle](#user_handle-property-dcauthwebserver-struct) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [user_hash_algorithm](#user_hash_algorithm-property-dcauthwebserver-struct) | Specifies the hash algorithm used to generate TOTP (Time-based One-Time Passwords) passwords for this user. | | [user_incoming_speed_limit](#user_incoming_speed_limit-property-dcauthwebserver-struct) | Specifies the incoming speed limit for this user. | | [user_outgoing_speed_limit](#user_outgoing_speed_limit-property-dcauthwebserver-struct) | Specifies the outgoing speed limit for this user. | | [user_password](#user_password-property-dcauthwebserver-struct) | The user's authentication password. | | [user_shared_secret](#user_shared_secret-property-dcauthwebserver-struct) | Contains the user's secret key, which is essentially a shared secret between the client and server. | | [username](#username-property-dcauthwebserver-struct) | The registered name (login) of the user. | | [website_name](#website_name-property-dcauthwebserver-struct) | Specifies the web site name to use in the certificate. | ## Method List *The following is the full list of the methods of the struct with short descriptions. Click on the links for further details.* | | | | --- | --- | | [cleanup](#cleanup-method-dcauthwebserver-struct) | Cleans up the server environment by purging expired sessions and cleaning caches. | | [config](#config-method-dcauthwebserver-struct) | Sets or retrieves a configuration setting. | | [do_action](#do_action-method-dcauthwebserver-struct) | Performs an additional action. | | [drop_client](#drop_client-method-dcauthwebserver-struct) | Terminates a client connection. | | [list_clients](#list_clients-method-dcauthwebserver-struct) | Enumerates the connected clients. | | [pin_client](#pin_client-method-dcauthwebserver-struct) | Takes a snapshot of the connection's properties. | | [reset](#reset-method-dcauthwebserver-struct) | Resets the struct settings. | | [start](#start-method-dcauthwebserver-struct) | Starts the server. | | [stop](#stop-method-dcauthwebserver-struct) | Stops the server. | ## 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.* | | | | --- | --- | | [on_accept](#on_accept-event-dcauthwebserver-struct) | Reports an incoming connection. | | [on_auth_attempt](#on_auth_attempt-event-dcauthwebserver-struct) | Fires when a connected client makes an authentication attempt. | | [on_connect](#on_connect-event-dcauthwebserver-struct) | Reports an accepted connection. | | [on_custom_parameters_received](#on_custom_parameters_received-event-dcauthwebserver-struct) | Passes custom request parameters to the application. | | [on_disconnect](#on_disconnect-event-dcauthwebserver-struct) | Fires to report a disconnected client. | | [on_error](#on_error-event-dcauthwebserver-struct) | Information about errors during data delivery. | | [on_external_sign](#on_external_sign-event-dcauthwebserver-struct) | Handles remote or external signing initiated by the server protocol. | | [on_key_secret_needed](#on_key_secret_needed-event-dcauthwebserver-struct) | Requests the key secret from the application. | | [on_log](#on_log-event-dcauthwebserver-struct) | Reports a single log line. | | [on_notification](#on_notification-event-dcauthwebserver-struct) | This event notifies the application about an underlying control flow event. | | [on_parameter_received](#on_parameter_received-event-dcauthwebserver-struct) | Passes a standard request parameter to the user code. | | [on_password_needed](#on_password_needed-event-dcauthwebserver-struct) | Requests a password from the application. | | [on_read_option](#on_read_option-event-dcauthwebserver-struct) | Fires when the client sends in a read option request. | | [on_select_cert](#on_select_cert-event-dcauthwebserver-struct) | Requests certificate selection criteria from the application. | | [on_sign_request](#on_sign_request-event-dcauthwebserver-struct) | This event signifies the processing of an atomic signing request. | | [on_sign_request_completed](#on_sign_request_completed-event-dcauthwebserver-struct) | This event signifies completion of the processing of an atomic signing request. | | [on_timestamp_request](#on_timestamp_request-event-dcauthwebserver-struct) | Fires when the struct is ready to request a timestamp from an external TSA. | | [on_tls_cert_validate](#on_tls_cert_validate-event-dcauthwebserver-struct) | Fires when a client certificate needs to be validated. | | [on_tls_established](#on_tls_established-event-dcauthwebserver-struct) | Reports the setup of a TLS session. | | [on_tls_handshake](#on_tls_handshake-event-dcauthwebserver-struct) | Fires when a newly established client connection initiates a TLS handshake. | | [on_tls_psk](#on_tls_psk-event-dcauthwebserver-struct) | Requests a pre-shared key for TLS-PSK. | | [on_tls_shutdown](#on_tls_shutdown-event-dcauthwebserver-struct) | Reports closure of a TLS session. | | [on_write_option](#on_write_option-event-dcauthwebserver-struct) | Fires when the client sends in a write option request. | ## Config Settings *The following is a list of config settings for the struct with short descriptions. Click on the links for further details.* | | | | --- | --- | | [CertPassword](#CertPassword) | TBD. | | [CertStoragePath](#CertStoragePath) | TBD. | | [DataURL](#DataURL) | (obsolete) The DataURL parameter to pass to the signer. | | [DualStack](#DualStack) | Allows the use of ip4 and ip6 simultaneously. | | [FingerprintAlgorithm](#FingerprintAlgorithm) | The fingerprint algorithm to use. | | [GoURL](#GoURL) | (obsolete) The GoURL parameter to pass to the signer. | | [HandshakeTimeout](#HandshakeTimeout) | The HTTPS handshake timeout. | | [Host](#Host) | The host to bind to. | | [Is64BitProcess](#Is64BitProcess) | TBD. | | [KeysEndpoint](#KeysEndpoint) | TBD. | | [KeyStoragePath](#KeyStoragePath) | TBD. | | [PolicyHash](#PolicyHash) | The EPES policy hash. | | [PolicyHashAlgorithm](#PolicyHashAlgorithm) | The EPES policy hash algorithm. | | [PolicyID](#PolicyID) | The EPES policy identifier. | | [PolicyURI](#PolicyURI) | The EPES policy URL. | | [Port](#Port) | The port to listen on. | | [Port64](#Port64) | TBD. | | [PortRangeFrom](#PortRangeFrom) | The lower bound of allowed port scope to listen on. | | [PortRangeTo](#PortRangeTo) | The higher bound of allowed port scope to listen on. | | [ReadOnlyMode](#ReadOnlyMode) | TBD. | | [RequireDefinedSignCert](#RequireDefinedSignCert) | (obsolete) The RequireDefinedSignCert parameter to pass to the signer. | | [SchemeParams](#SchemeParams) | The algorithm scheme parameters to employ. | | [ServerCertificatePassword](#ServerCertificatePassword) | TBD. | | [ServerCertificatePath](#ServerCertificatePath) | TBD. | | [SessionID](#SessionID) | (obsolete) The SessionID parameter to pass to the signer. | | [SessionTimeout](#SessionTimeout) | The HTTP session timeout. | | [SettingsEndpoint](#SettingsEndpoint) | TBD. | | [StatusEndpoint](#StatusEndpoint) | TBD. | | [TLSChainValidationDetails](#TLSChainValidationDetails) | Contains the advanced details of the TLS server certificate validation. | | [TLSChainValidationResult](#TLSChainValidationResult) | Contains the result of the TLS server certificate validation. | | [TLSClientAuthRequested](#TLSClientAuthRequested) | Indicates whether the TLS server requests client authentication. | | [TLSExtensions](#TLSExtensions) | TBD. | | [TLSValidationLog](#TLSValidationLog) | Contains the log of the TLS server certificate validation. | | [TokenName](#TokenName) | The TokenName parameter to pass to the signer. | | [TokensLibraries](#TokensLibraries) | (obsolete) The TokensLibraries parameter to pass to the signer. | | [TspAttemptCount](#TspAttemptCount) | Specifies the number of timestamping request attempts. | | [TspHashAlgorithm](#TspHashAlgorithm) | Sets a specific hash algorithm for use with the timestamping service. | | [TspReqPolicy](#TspReqPolicy) | Sets a request policy ID to include in the timestamping request. | | [Use64BitService](#Use64BitService) | TBD. | | [WebsiteName](#WebsiteName) | The website name for the TLS certificate. | | [ASN1UseGlobalTagCache](#ASN1UseGlobalTagCache) | Controls whether ASN.1 module should use a global object cache. | | [AssignSystemSmartCardPins](#AssignSystemSmartCardPins) | Specifies whether CSP-level PINs should be assigned to CNG keys. | | [CheckKeyIntegrityBeforeUse](#CheckKeyIntegrityBeforeUse) | Enables or disable private key integrity check before use. | | [CookieCaching](#CookieCaching) | Specifies whether a cookie cache should be used for HTTP(S) transports. | | [Cookies](#Cookies) | Gets or sets local cookies for the struct. | | [DefDeriveKeyIterations](#DefDeriveKeyIterations) | Specifies the default key derivation algorithm iteration count. | | [DNSLocalSuffix](#DNSLocalSuffix) | The suffix to assign for TLD names. | | [EnableClientSideSSLFFDHE](#EnableClientSideSSLFFDHE) | Enables or disables finite field DHE key exchange support in TLS clients. | | [EnableSSHMLKEM](#EnableSSHMLKEM) | Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server structs. | | [EnableTLSMLKEM](#EnableTLSMLKEM) | Enables support for ML-KEM and hybrid groups in TLS client and server structs. | | [GlobalCookies](#GlobalCookies) | Gets or sets global cookies for all the HTTP transports. | | [HardwareCryptoUsePolicy](#HardwareCryptoUsePolicy) | The hardware crypto usage policy. | | [HttpUserAgent](#HttpUserAgent) | Specifies the user agent name to be used by all HTTP clients. | | [HttpVersion](#HttpVersion) | The HTTP version to use in any inner HTTP client structs created. | | [IgnoreExpiredMSCTLSigningCert](#IgnoreExpiredMSCTLSigningCert) | Whether to tolerate the expired Windows Update signing certificate. | | [ListDelimiter](#ListDelimiter) | The delimiter character for multi-element lists. | | [LogDestination](#LogDestination) | Specifies the debug log destination. | | [LogDetails](#LogDetails) | Specifies the debug log details to dump. | | [LogFile](#LogFile) | Specifies the debug log filename. | | [LogFilters](#LogFilters) | Specifies the debug log filters. | | [LogFlushMode](#LogFlushMode) | Specifies the log flush mode. | | [LogLevel](#LogLevel) | Specifies the debug log level. | | [LogMaxEventCount](#LogMaxEventCount) | Specifies the maximum number of events to cache before further action is taken. | | [LogRotationMode](#LogRotationMode) | Specifies the log rotation mode. | | [MaxASN1BufferLength](#MaxASN1BufferLength) | Specifies the maximal allowed length for ASN.1 primitive tag data. | | [MaxASN1TreeDepth](#MaxASN1TreeDepth) | Specifies the maximal depth for processed ASN.1 trees. | | [OCSPHashAlgorithm](#OCSPHashAlgorithm) | Specifies the hash algorithm to be used to identify certificates in OCSP requests. | | [OldClientSideRSAFallback](#OldClientSideRSAFallback) | Specifies whether the SSH client should use a SHA1 fallback. | | [PKICache](#PKICache) | Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached. | | [PKICachePath](#PKICachePath) | Specifies the file system path where cached PKI data is stored. | | [ProductVersion](#ProductVersion) | Returns the version of the SecureBlackbox library. | | [ServerSSLDHKeyLength](#ServerSSLDHKeyLength) | Sets the size of the TLS DHE key exchange group. | | [StaticDNS](#StaticDNS) | Specifies whether static DNS rules should be used. | | [StaticIPAddress\[domain\]](#StaticIPAddress[domain]) | Gets or sets an IP address for the specified domain name. | | [StaticIPAddresses](#StaticIPAddresses) | Gets or sets all the static DNS rules. | | [Tag](#Tag) | Allows to store any custom data. | | [TLSSessionGroup](#TLSSessionGroup) | Specifies the group name of TLS sessions to be used for session resumption. | | [TLSSessionLifetime](#TLSSessionLifetime) | Specifies lifetime in seconds of the cached TLS session. | | [TLSSessionPurgeInterval](#TLSSessionPurgeInterval) | Specifies how often the session cache should remove the expired TLS sessions. | | [UseCRLObjectCaching](#UseCRLObjectCaching) | Specifies whether reuse of loaded CRL objects is enabled. | | [UseInternalRandom](#UseInternalRandom) | Switches between SecureBlackbox-own and platform PRNGs. | | [UseLegacyAdESValidation](#UseLegacyAdESValidation) | Enables legacy AdES validation mode. | | [UseOCSPResponseObjectCaching](#UseOCSPResponseObjectCaching) | Specifies whether reuse of loaded OCSP response objects is enabled. | | [UseOwnDNSResolver](#UseOwnDNSResolver) | Specifies whether the client structs should use own DNS resolver. | | [UseSharedSystemStorages](#UseSharedSystemStorages) | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. | | [UseSystemNativeSizeCalculation](#UseSystemNativeSizeCalculation) | An internal CryptoAPI access tweak. | | [UseSystemOAEPAndPSS](#UseSystemOAEPAndPSS) | Enforces or disables the use of system-driven RSA OAEP and PSS computations. | | [UseSystemRandom](#UseSystemRandom) | Enables or disables the use of the OS PRNG. | | [XMLRDNDescriptorName\[OID\]](#XMLRDNDescriptorName[OID]) | Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN. | | [XMLRDNDescriptorPriority\[OID\]](#XMLRDNDescriptorPriority[OID]) | Specifies the priority of descriptor names associated with a specific OID. | | [XMLRDNDescriptorReverseOrder](#XMLRDNDescriptorReverseOrder) | Specifies whether to reverse the order of descriptors in RDN. | | [XMLRDNDescriptorSeparator](#XMLRDNDescriptorSeparator) | Specifies the separator used between descriptors in RDN. | # active property ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) Indicates whether the server is active and is listening to new connections. ## Syntax *Rust Syntax* ```text fn active(&self ) -> Result ``` ## 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-secureblackboxdcauthwebserver) Struct) Specifies the content of AllowOrigin header of the service reply. ## Syntax *Rust Syntax* ```text fn allow_origin(&self ) -> Result fn set_allow_origin(&self, value : &str) -> Option fn set_allow_origin_ref(&self, value : &String) -> Option ``` ## 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-secureblackboxdcauthwebserver) Struct) Specifies authentication realm for digest and NTLM authentication. ## Syntax *Rust Syntax* ```text fn auth_realm(&self ) -> Result fn set_auth_realm(&self, value : &str) -> Option fn set_auth_realm_ref(&self, value : &String) -> Option ``` ## Default Value "SecureBlackbox" ## Remarks Specifies authentication realm for digest and NTLM authentication types. ## Data Type String # auth_types property ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) Defines allowed HTTP authentication types. ## Syntax *Rust Syntax* ```text fn auth_types(&self ) -> Result fn set_auth_types(&self, value : i32) -> Option ``` ## 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: | | | | | --- | --- | --- | | haBasic | 0x01 | Basic authentication | | haDigest | 0x02 | Digest authentication (RFC 2617) | | haNTLM | 0x04 | Windows NTLM authentication | | haKerberos | 0x08 | Kerberos (Negotiate) authentication | | haOAuth2 | 0x10 | OAuth2 authentication | ## Data Type i32 # bound_port property ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) Indicates the bound listening port. ## Syntax *Rust Syntax* ```text fn bound_port(&self ) -> Result ``` ## 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](#port-property-dcauthwebserver-struct) if it is provided, or is allocated dynamically if configured to fall in the range between [port_range_from](#port_range_from-property-dcauthwebserver-struct) and [port_range_to](#port_range_to-property-dcauthwebserver-struct) constraints. This property is read-only. ## Data Type i32 # external_crypto_async_document_id property ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls. ## Syntax *Rust Syntax* ```text fn external_crypto_async_document_id(&self ) -> Result fn set_external_crypto_async_document_id(&self, value : &str) -> Option fn set_external_crypto_async_document_id_ref(&self, value : &String) -> Option ``` ## 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-secureblackboxdcauthwebserver) Struct) Custom parameters to be passed to the signing service (uninterpreted). ## Syntax *Rust Syntax* ```text fn external_crypto_custom_params(&self ) -> Result fn set_external_crypto_custom_params(&self, value : &str) -> Option fn set_external_crypto_custom_params_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks Custom parameters to be passed to the signing service (uninterpreted). ## Data Type String # external_crypto_data property ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) Additional data to be included in the async state and mirrored back by the requestor. ## Syntax *Rust Syntax* ```text fn external_crypto_data(&self ) -> Result fn set_external_crypto_data(&self, value : &str) -> Option fn set_external_crypto_data_ref(&self, value : &String) -> Option ``` ## 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-secureblackboxdcauthwebserver) Struct) Specifies whether the message hash is to be calculated at the external endpoint. ## Syntax *Rust Syntax* ```text fn external_crypto_external_hash_calculation(&self ) -> Result fn set_external_crypto_external_hash_calculation(&self, value : bool) -> Option ``` ## 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-secureblackboxdcauthwebserver) Struct) Specifies the request's signature hash algorithm. ## Syntax *Rust Syntax* ```text fn external_crypto_hash_algorithm(&self ) -> Result fn set_external_crypto_hash_algorithm(&self, value : &str) -> Option fn set_external_crypto_hash_algorithm_ref(&self, value : &String) -> Option ``` ## Default Value "SHA256" ## Remarks Specifies the request's signature hash algorithm. | | | | | --- | --- | --- | | SB_HASH_ALGORITHM_SHA1 | SHA1 | | | SB_HASH_ALGORITHM_SHA224 | SHA224 | | | SB_HASH_ALGORITHM_SHA256 | SHA256 | | | SB_HASH_ALGORITHM_SHA384 | SHA384 | | | SB_HASH_ALGORITHM_SHA512 | SHA512 | | | SB_HASH_ALGORITHM_MD2 | MD2 | | | SB_HASH_ALGORITHM_MD4 | MD4 | | | SB_HASH_ALGORITHM_MD5 | MD5 | | | SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | | | SB_HASH_ALGORITHM_CRC32 | CRC32 | | | SB_HASH_ALGORITHM_SSL3 | SSL3 | | | SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | | | SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | | | SB_HASH_ALGORITHM_POLY1305 | POLY1305 | | | SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | | | SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | | | SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | | | SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | | | SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | | | SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | | | SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | | | SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | | | SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | | | SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | | | SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | | | SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | | | SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | | | SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | | | SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | | | SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN | | ## Data Type String # external_crypto_key_id property ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) The ID of the pre-shared key used for DC request authentication. ## Syntax *Rust Syntax* ```text fn external_crypto_key_id(&self ) -> Result fn set_external_crypto_key_id(&self, value : &str) -> Option fn set_external_crypto_key_id_ref(&self, value : &String) -> Option ``` ## 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](#external_crypto_key_secret-property-dcauthwebserver-struct) 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: ```text signer.ExternalCrypto.KeyID = "MainSigningKey"; signer.ExternalCrypto.KeySecret = "abcdef0123456789"; ``` ## Data Type String # external_crypto_key_secret property ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) The pre-shared key used for DC request authentication. ## Syntax *Rust Syntax* ```text fn external_crypto_key_secret(&self ) -> Result fn set_external_crypto_key_secret(&self, value : &str) -> Option fn set_external_crypto_key_secret_ref(&self, value : &String) -> Option ``` ## 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](#external_crypto_key_id-property-dcauthwebserver-struct) topic. ## Data Type String # external_crypto_method property ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) Specifies the asynchronous signing method. ## Syntax *Rust Syntax* ```text fn external_crypto_method(&self ) -> Result fn set_external_crypto_method(&self, value : i32) -> Option ``` ## Possible Values ```text 0 // PKCS11 // PKCS7 ``` ## Default Value 0 ## Remarks Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup. Available options: | | | | --- | --- | | asmdPKCS1 | 0 | | asmdPKCS7 | 1 | ## Data Type i32 # external_crypto_mode property ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) Specifies the external cryptography mode. ## Syntax *Rust Syntax* ```text fn external_crypto_mode(&self ) -> Result fn set_external_crypto_mode(&self, value : i32) -> Option ``` ## Possible Values ```text 0 // Default1 // Disabled2 // Generic3 // DCAuth4 // DCAuthJSON ``` ## Default Value 0 ## Remarks Specifies the external cryptography mode. Available options: | | | | --- | --- | | ecmDefault | The default value (0) | | ecmDisabled | Do not use DC or external signing (1) | | ecmGeneric | Generic external signing with the OnExternalSign event (2) | | ecmDCAuth | DCAuth signing (3) | | ecmDCAuthJSON | DCAuth signing in JSON format (4) | ## Data Type i32 # external_crypto_public_key_algorithm property ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) Provide the public key algorithm here if the certificate is not available on the pre-signing stage. ## Syntax *Rust Syntax* ```text fn external_crypto_public_key_algorithm(&self ) -> Result fn set_external_crypto_public_key_algorithm(&self, value : &str) -> Option fn set_external_crypto_public_key_algorithm_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks Provide the public key algorithm here if the certificate is not available on the pre-signing stage. | | | | | --- | --- | --- | | SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption | | | SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption | | | SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption | | | SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption | | | SB_CERT_ALGORITHM_ID_DSA | id-dsa | | | SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 | | | SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber | | | SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption | | | SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption | | | SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption | | | SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption | | | SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS | | | SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP | | | SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA | | | SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal | | | SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 | | | SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended | | | SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 | | | SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 | | | SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 | | | SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 | | | SB_CERT_ALGORITHM_EC | id-ecPublicKey | | | SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified | | | SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 | | | SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 | | | SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 | | | SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 | | | SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 | | | SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 | | | SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 | | | SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 | | | SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 | | | SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 | | | SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption | | | SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 | | | SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 | | | SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 | | | SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 | | | SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 | | | SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 | | | SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 | | | SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 | | | SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 | | | SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 | | | SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 | | | SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 | | | SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 | | | SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 | | | SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 | | | SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 | | | SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 | | | SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 | | | SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 | | | SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 | | | SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 | | | SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 | | | SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 | | | SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 | | | SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 | | | SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 | | | SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 | | | SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 | | | SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 | | | SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 | | | SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 | | | SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 | | | SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 | | | SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 | | | SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 | | | SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 | | | SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 | | | SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 | | | SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 | | | SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 | | | SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 | | | SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 | | | SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 | | | SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 | | | SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph | | | SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph | | | SB_CERT_ALGORITHM_EDDSA | id-EdDSA | | | SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig | | | SB_CERT_ALGORITHM_MLDSA_44 | id-ml-dsa-44 | | | SB_CERT_ALGORITHM_MLDSA_65 | id-ml-dsa-65 | | | SB_CERT_ALGORITHM_MLDSA_87 | id-ml-dsa-87 | | | SB_CERT_ALGORITHM_HASH_MLDSA_44_SHA512 | id-hash-ml-dsa-44-with-sha512 | | | SB_CERT_ALGORITHM_HASH_MLDSA_65_SHA512 | id-hash-ml-dsa-65-with-sha512 | | | SB_CERT_ALGORITHM_HASH_MLDSA_87_SHA512 | id-hash-ml-dsa-87-with-sha512 | | | SB_CERT_ALGORITHM_MLKEM_512 | id-ml-kem-512 | | | SB_CERT_ALGORITHM_MLKEM_768 | id-ml-kem-768 | | | SB_CERT_ALGORITHM_MLKEM_1024 | id-ml-kem-1024 | | ## Data Type String # fips_mode property ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) Reserved. ## Syntax *Rust Syntax* ```text fn fips_mode(&self ) -> Result fn set_fips_mode(&self, value : bool) -> Option ``` ## Default Value false ## Remarks This property is reserved for future use. ## Data Type bool # handshake_timeout property ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) Specifies the handshake timeout in milliseconds. ## Syntax *Rust Syntax* ```text fn handshake_timeout(&self ) -> Result fn set_handshake_timeout(&self, value : i32) -> Option ``` ## Default Value 20000 ## Remarks Use this property to set the TLS handshake timeout. ## Data Type i32 # host property ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) The host to bind the listening port to. ## Syntax *Rust Syntax* ```text fn host(&self ) -> Result fn set_host(&self, value : &str) -> Option fn set_host_ref(&self, value : &String) -> Option ``` ## 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-secureblackboxdcauthwebserver) Struct) Specifies the KeyID of the pre-shared authentication key. ## Syntax *Rust Syntax* ```text fn key_id(&self ) -> Result fn set_key_id(&self, value : &str) -> Option fn set_key_id_ref(&self, value : &String) -> Option ``` ## 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](#key_secret-property-dcauthwebserver-struct) property. If you expect to receive requests from many parties with different authentication keys, use [on_key_secret_needed](#on_key_secret_needed-event-dcauthwebserver-struct) event instead. ## Data Type String # key_secret property ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) The pre-shared authentication key. ## Syntax *Rust Syntax* ```text fn key_secret(&self ) -> Result fn set_key_secret(&self, value : &str) -> Option fn set_key_secret_ref(&self, value : &String) -> Option ``` ## 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](#key_id-property-dcauthwebserver-struct) 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](#on_key_secret_needed-event-dcauthwebserver-struct) event instead. ## Data Type String # pinned_client_aead_cipher property ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) Indicates whether the encryption algorithm used is an AEAD cipher. ## Syntax *Rust Syntax* ```text fn pinned_client_aead_cipher(&self ) -> Result ``` ## 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-secureblackboxdcauthwebserver) Struct) The details of a certificate chain validation outcome. ## Syntax *Rust Syntax* ```text fn pinned_client_chain_validation_details(&self ) -> Result ``` ## 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: | | | | | --- | --- | --- | | cvrBadData | 0x0001 | One or more certificates in the validation path are malformed | | cvrRevoked | 0x0002 | One or more certificates are revoked | | cvrNotYetValid | 0x0004 | One or more certificates are not yet valid | | cvrExpired | 0x0008 | One or more certificates are expired | | cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature | | cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) | | cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA | | cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified | | cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified | | cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate | | cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates | | cvrBlocked | 0x0800 | One or more certificates are blocked | | cvrFailure | 0x1000 | General validation failure | | cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself | | cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements | | cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code | This property is read-only. ## Data Type i32 # pinned_client_chain_validation_result property ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) The outcome of a certificate chain validation routine. ## Syntax *Rust Syntax* ```text fn pinned_client_chain_validation_result(&self ) -> Result ``` ## Possible Values ```text 0 // Valid1 // ValidButUntrusted2 // Invalid3 // CantBeEstablished ``` ## Default Value 0 ## Remarks The outcome of a certificate chain validation routine. Available options: | | | | | --- | --- | --- | | cvtValid | 0 | The chain is valid | | cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted | | cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) | | cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) | Use the ValidationLog property to access the detailed validation log. This property is read-only. ## Data Type i32 # pinned_client_ciphersuite property ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) The cipher suite employed by this connection. ## Syntax *Rust Syntax* ```text fn pinned_client_ciphersuite(&self ) -> Result ``` ## 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-secureblackboxdcauthwebserver) Struct) Specifies whether client authentication was performed during this connection. ## Syntax *Rust Syntax* ```text fn pinned_client_client_authenticated(&self ) -> Result ``` ## 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-secureblackboxdcauthwebserver) Struct) Specifies whether client authentication was requested during this connection. ## Syntax *Rust Syntax* ```text fn pinned_client_client_auth_requested(&self ) -> Result ``` ## 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-secureblackboxdcauthwebserver) Struct) Indicates whether the connection has been established fully. ## Syntax *Rust Syntax* ```text fn pinned_client_connection_established(&self ) -> Result ``` ## 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-secureblackboxdcauthwebserver) Struct) The unique identifier assigned to this connection. ## Syntax *Rust Syntax* ```text fn pinned_client_connection_id(&self ) -> Result, SecureBlackboxError> ``` ## Remarks The unique identifier assigned to this connection. This property is read-only. ## Data Type Vec # pinned_client_digest_algorithm property ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) The digest algorithm used in a TLS-enabled connection. ## Syntax *Rust Syntax* ```text fn pinned_client_digest_algorithm(&self ) -> Result ``` ## 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-secureblackboxdcauthwebserver) Struct) The symmetric encryption algorithm used in a TLS-enabled connection. ## Syntax *Rust Syntax* ```text fn pinned_client_encryption_algorithm(&self ) -> Result ``` ## 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-secureblackboxdcauthwebserver) Struct) Indicates whether a TLS connection uses a reduced-strength exportable cipher. ## Syntax *Rust Syntax* ```text fn pinned_client_exportable(&self ) -> Result ``` ## 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-secureblackboxdcauthwebserver) Struct) The elliptic curve used in this connection. ## Syntax *Rust Syntax* ```text fn pinned_client_group(&self ) -> Result ``` ## 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-secureblackboxdcauthwebserver) Struct) The client connection's unique identifier. ## Syntax *Rust Syntax* ```text fn pinned_client_id(&self ) -> Result ``` ## 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-secureblackboxdcauthwebserver) Struct) The key exchange algorithm used in a TLS-enabled connection. ## Syntax *Rust Syntax* ```text fn pinned_client_key_exchange_algorithm(&self ) -> Result ``` ## 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-secureblackboxdcauthwebserver) Struct) The length of the key exchange key of a TLS-enabled connection. ## Syntax *Rust Syntax* ```text fn pinned_client_key_exchange_key_bits(&self ) -> Result ``` ## 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-secureblackboxdcauthwebserver) Struct) Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS). ## Syntax *Rust Syntax* ```text fn pinned_client_pfs_cipher(&self ) -> Result ``` ## 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-secureblackboxdcauthwebserver) Struct) Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. ## Syntax *Rust Syntax* ```text fn pinned_client_pre_shared_identity(&self ) -> Result ``` ## 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-secureblackboxdcauthwebserver) Struct) A hint professed by the server to help the client select the PSK identity to use. ## Syntax *Rust Syntax* ```text fn pinned_client_pre_shared_identity_hint(&self ) -> Result ``` ## 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-secureblackboxdcauthwebserver) Struct) The length of the public key. ## Syntax *Rust Syntax* ```text fn pinned_client_public_key_bits(&self ) -> Result ``` ## 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-secureblackboxdcauthwebserver) Struct) The client's IP address. ## Syntax *Rust Syntax* ```text fn pinned_client_remote_address(&self ) -> Result ``` ## Default Value "" ## Remarks The client's IP address. This property is read-only. ## Data Type String # pinned_client_remote_port property ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) The remote port of the client connection. ## Syntax *Rust Syntax* ```text fn pinned_client_remote_port(&self ) -> Result ``` ## 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-secureblackboxdcauthwebserver) Struct) Indicates whether a TLS-enabled connection was spawned from another TLS connection. ## Syntax *Rust Syntax* ```text fn pinned_client_resumed_session(&self ) -> Result ``` ## 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-secureblackboxdcauthwebserver) Struct) Indicates whether TLS or SSL is enabled for this connection. ## Syntax *Rust Syntax* ```text fn pinned_client_secure_connection(&self ) -> Result ``` ## 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-secureblackboxdcauthwebserver) Struct) Indicates whether server authentication was performed during a TLS-enabled connection. ## Syntax *Rust Syntax* ```text fn pinned_client_server_authenticated(&self ) -> Result ``` ## 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-secureblackboxdcauthwebserver) Struct) The signature algorithm used in a TLS handshake. ## Syntax *Rust Syntax* ```text fn pinned_client_signature_algorithm(&self ) -> Result ``` ## 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-secureblackboxdcauthwebserver) Struct) The block size of the symmetric algorithm used. ## Syntax *Rust Syntax* ```text fn pinned_client_symmetric_block_size(&self ) -> Result ``` ## 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-secureblackboxdcauthwebserver) Struct) The key length of the symmetric algorithm used. ## Syntax *Rust Syntax* ```text fn pinned_client_symmetric_key_bits(&self ) -> Result ``` ## 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-secureblackboxdcauthwebserver) Struct) The total number of bytes received over this connection. ## Syntax *Rust Syntax* ```text fn pinned_client_total_bytes_received(&self ) -> Result ``` ## 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-secureblackboxdcauthwebserver) Struct) The total number of bytes sent over this connection. ## Syntax *Rust Syntax* ```text fn pinned_client_total_bytes_sent(&self ) -> Result ``` ## 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-secureblackboxdcauthwebserver) Struct) Contains the server certificate's chain validation log. ## Syntax *Rust Syntax* ```text fn pinned_client_validation_log(&self ) -> Result ``` ## 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-secureblackboxdcauthwebserver) Struct) Indicates the version of SSL/TLS protocol negotiated during this connection. ## Syntax *Rust Syntax* ```text fn pinned_client_version(&self ) -> Result ``` ## 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-secureblackboxdcauthwebserver) Struct) The number of records in the PinnedClientCert arrays. ## Syntax *Rust Syntax* ```text fn pinned_client_cert_count(&self ) -> Result ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [pinned_client_cert_bytes](#pinned_client_cert_bytes-property-dcauthwebserver-struct) - [pinned_client_cert_ca_key_id](#pinned_client_cert_ca_key_id-property-dcauthwebserver-struct) - [pinned_client_cert_fingerprint](#pinned_client_cert_fingerprint-property-dcauthwebserver-struct) - [pinned_client_cert_handle](#pinned_client_cert_handle-property-dcauthwebserver-struct) - [pinned_client_cert_issuer](#pinned_client_cert_issuer-property-dcauthwebserver-struct) - [pinned_client_cert_issuer_rdn](#pinned_client_cert_issuer_rdn-property-dcauthwebserver-struct) - [pinned_client_cert_key_algorithm](#pinned_client_cert_key_algorithm-property-dcauthwebserver-struct) - [pinned_client_cert_key_bits](#pinned_client_cert_key_bits-property-dcauthwebserver-struct) - [pinned_client_cert_key_fingerprint](#pinned_client_cert_key_fingerprint-property-dcauthwebserver-struct) - [pinned_client_cert_key_usage](#pinned_client_cert_key_usage-property-dcauthwebserver-struct) - [pinned_client_cert_public_key_bytes](#pinned_client_cert_public_key_bytes-property-dcauthwebserver-struct) - [pinned_client_cert_self_signed](#pinned_client_cert_self_signed-property-dcauthwebserver-struct) - [pinned_client_cert_serial_number](#pinned_client_cert_serial_number-property-dcauthwebserver-struct) - [pinned_client_cert_sig_algorithm](#pinned_client_cert_sig_algorithm-property-dcauthwebserver-struct) - [pinned_client_cert_subject](#pinned_client_cert_subject-property-dcauthwebserver-struct) - [pinned_client_cert_subject_key_id](#pinned_client_cert_subject_key_id-property-dcauthwebserver-struct) - [pinned_client_cert_subject_rdn](#pinned_client_cert_subject_rdn-property-dcauthwebserver-struct) - [pinned_client_cert_valid_from](#pinned_client_cert_valid_from-property-dcauthwebserver-struct) - [pinned_client_cert_valid_to](#pinned_client_cert_valid_to-property-dcauthwebserver-struct) 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-secureblackboxdcauthwebserver) Struct) Returns the raw certificate data in DER format. ## Syntax *Rust Syntax* ```text fn pinned_client_cert_bytes(&self , PinnedClientCertIndex : i32) -> Result, 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](#pinned_client_cert_count-property-dcauthwebserver-struct) property. This property is read-only. ## Data Type Vec # pinned_client_cert_ca_key_id property ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) A unique identifier (fingerprint) of the CA certificate's cryptographic key. ## Syntax *Rust Syntax* ```text fn pinned_client_cert_ca_key_id(&self , PinnedClientCertIndex : i32) -> Result, 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](#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](#pinned_client_cert_subject_key_id-property-dcauthwebserver-struct) 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](#pinned_client_cert_count-property-dcauthwebserver-struct) property. This property is read-only. ## Data Type Vec # pinned_client_cert_fingerprint property ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) Contains the fingerprint (a hash imprint) of this certificate. ## Syntax *Rust Syntax* ```text fn pinned_client_cert_fingerprint(&self , PinnedClientCertIndex : i32) -> Result ``` ## 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](#pinned_client_cert_count-property-dcauthwebserver-struct) property. This property is read-only. ## Data Type String # pinned_client_cert_handle property ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax *Rust Syntax* ```text fn pinned_client_cert_handle(&self , PinnedClientCertIndex : i32) -> Result ``` ## 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. ```text 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](#pinned_client_cert_count-property-dcauthwebserver-struct) property. This property is read-only. ## Data Type i64 # pinned_client_cert_issuer property ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) The common name of the certificate issuer (CA), typically a company name. ## Syntax *Rust Syntax* ```text fn pinned_client_cert_issuer(&self , PinnedClientCertIndex : i32) -> Result ``` ## 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](#pinned_client_cert_issuer_rdn-property-dcauthwebserver-struct). The *PinnedClientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PinnedClientCertCount](#pinned_client_cert_count-property-dcauthwebserver-struct) property. This property is read-only. ## Data Type String # pinned_client_cert_issuer_rdn property ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) A list of Property=Value pairs that uniquely identify the certificate issuer. ## Syntax *Rust Syntax* ```text fn pinned_client_cert_issuer_rdn(&self , PinnedClientCertIndex : i32) -> Result ``` ## 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](#pinned_client_cert_count-property-dcauthwebserver-struct) property. This property is read-only. ## Data Type String # pinned_client_cert_key_algorithm property ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) Specifies the public key algorithm of this certificate. ## Syntax *Rust Syntax* ```text fn pinned_client_cert_key_algorithm(&self , PinnedClientCertIndex : i32) -> Result ``` ## Default Value "0" ## Remarks Specifies the public key algorithm of this certificate. | | | | | --- | --- | --- | | SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption | | | SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption | | | SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption | | | SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption | | | SB_CERT_ALGORITHM_ID_DSA | id-dsa | | | SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 | | | SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber | | | SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption | | | SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption | | | SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption | | | SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption | | | SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS | | | SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP | | | SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA | | | SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal | | | SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 | | | SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended | | | SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 | | | SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 | | | SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 | | | SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 | | | SB_CERT_ALGORITHM_EC | id-ecPublicKey | | | SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified | | | SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 | | | SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 | | | SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 | | | SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 | | | SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 | | | SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 | | | SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 | | | SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 | | | SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 | | | SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 | | | SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption | | | SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 | | | SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 | | | SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 | | | SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 | | | SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 | | | SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 | | | SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 | | | SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 | | | SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 | | | SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 | | | SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 | | | SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 | | | SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 | | | SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 | | | SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 | | | SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 | | | SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 | | | SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 | | | SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 | | | SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 | | | SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 | | | SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 | | | SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 | | | SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 | | | SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 | | | SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 | | | SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 | | | SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 | | | SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 | | | SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 | | | SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 | | | SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 | | | SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 | | | SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 | | | SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 | | | SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 | | | SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 | | | SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 | | | SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 | | | SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 | | | SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 | | | SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 | | | SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 | | | SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 | | | SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph | | | SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph | | | SB_CERT_ALGORITHM_EDDSA | id-EdDSA | | | SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig | | | SB_CERT_ALGORITHM_MLDSA_44 | id-ml-dsa-44 | | | SB_CERT_ALGORITHM_MLDSA_65 | id-ml-dsa-65 | | | SB_CERT_ALGORITHM_MLDSA_87 | id-ml-dsa-87 | | | SB_CERT_ALGORITHM_HASH_MLDSA_44_SHA512 | id-hash-ml-dsa-44-with-sha512 | | | SB_CERT_ALGORITHM_HASH_MLDSA_65_SHA512 | id-hash-ml-dsa-65-with-sha512 | | | SB_CERT_ALGORITHM_HASH_MLDSA_87_SHA512 | id-hash-ml-dsa-87-with-sha512 | | | SB_CERT_ALGORITHM_MLKEM_512 | id-ml-kem-512 | | | SB_CERT_ALGORITHM_MLKEM_768 | id-ml-kem-768 | | | SB_CERT_ALGORITHM_MLKEM_1024 | id-ml-kem-1024 | | Use the [pinned_client_cert_key_bits](#pinned_client_cert_key_bits-property-dcauthwebserver-struct), [pinned_client_cert_curve](#DCAuthWebServer_p_PinnedClientCertCurve), and [pinned_client_cert_public_key_bytes](#pinned_client_cert_public_key_bytes-property-dcauthwebserver-struct) 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](#pinned_client_cert_count-property-dcauthwebserver-struct) property. This property is read-only. ## Data Type String # pinned_client_cert_key_bits property ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) Returns the length of the public key in bits. ## Syntax *Rust Syntax* ```text fn pinned_client_cert_key_bits(&self , PinnedClientCertIndex : i32) -> Result ``` ## 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](#pinned_client_cert_public_key_bytes-property-dcauthwebserver-struct) or [pinned_client_cert_private_key_bytes](#DCAuthWebServer_p_PinnedClientCertPrivateKeyBytes) 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](#pinned_client_cert_count-property-dcauthwebserver-struct) property. This property is read-only. ## Data Type i32 # pinned_client_cert_key_fingerprint property ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) Returns a SHA1 fingerprint of the public key contained in the certificate. ## Syntax *Rust Syntax* ```text fn pinned_client_cert_key_fingerprint(&self , PinnedClientCertIndex : i32) -> Result ``` ## 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](#pinned_client_cert_fingerprint-property-dcauthwebserver-struct) 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](#pinned_client_cert_count-property-dcauthwebserver-struct) property. This property is read-only. ## Data Type String # pinned_client_cert_key_usage property ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. ## Syntax *Rust Syntax* ```text fn pinned_client_cert_key_usage(&self , PinnedClientCertIndex : i32) -> Result ``` ## 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: | | | | | --- | --- | --- | | ckuUnknown | 0x00000 | Unknown key usage | | ckuDigitalSignature | 0x00001 | Digital signature | | ckuNonRepudiation | 0x00002 | Non-repudiation | | ckuKeyEncipherment | 0x00004 | Key encipherment | | ckuDataEncipherment | 0x00008 | Data encipherment | | ckuKeyAgreement | 0x00010 | Key agreement | | ckuKeyCertSign | 0x00020 | Certificate signing | | ckuCRLSign | 0x00040 | Revocation signing | | ckuEncipherOnly | 0x00080 | Encipher only | | ckuDecipherOnly | 0x00100 | Decipher only | | ckuServerAuthentication | 0x00200 | Server authentication | | ckuClientAuthentication | 0x00400 | Client authentication | | ckuCodeSigning | 0x00800 | Code signing | | ckuEmailProtection | 0x01000 | Email protection | | ckuTimeStamping | 0x02000 | Timestamping | | ckuOCSPSigning | 0x04000 | OCSP signing | | ckuSmartCardLogon | 0x08000 | Smartcard logon | | ckuKeyPurposeClientAuth | 0x10000 | Kerberos - client authentication | | ckuKeyPurposeKDC | 0x20000 | Kerberos - KDC | 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](#pinned_client_cert_count-property-dcauthwebserver-struct) property. This property is read-only. ## Data Type i32 # pinned_client_cert_public_key_bytes property ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) Contains the certificate's public key in DER format. ## Syntax *Rust Syntax* ```text fn pinned_client_cert_public_key_bytes(&self , PinnedClientCertIndex : i32) -> Result, 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](#pinned_client_cert_count-property-dcauthwebserver-struct) property. This property is read-only. ## Data Type Vec # pinned_client_cert_self_signed property ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) Indicates whether the certificate is self-signed (root) or signed by an external CA. ## Syntax *Rust Syntax* ```text fn pinned_client_cert_self_signed(&self , PinnedClientCertIndex : i32) -> Result ``` ## 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](#pinned_client_cert_count-property-dcauthwebserver-struct) property. This property is read-only. ## Data Type bool # pinned_client_cert_serial_number property ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) Returns the certificate's serial number. ## Syntax *Rust Syntax* ```text fn pinned_client_cert_serial_number(&self , PinnedClientCertIndex : i32) -> Result, 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](#pinned_client_cert_count-property-dcauthwebserver-struct) property. This property is read-only. ## Data Type Vec # pinned_client_cert_sig_algorithm property ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) Indicates the algorithm that was used by the CA to sign this certificate. ## Syntax *Rust Syntax* ```text fn pinned_client_cert_sig_algorithm(&self , PinnedClientCertIndex : i32) -> Result ``` ## 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](#pinned_client_cert_count-property-dcauthwebserver-struct) property. This property is read-only. ## Data Type String # pinned_client_cert_subject property ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. ## Syntax *Rust Syntax* ```text fn pinned_client_cert_subject(&self , PinnedClientCertIndex : i32) -> Result ``` ## 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](#pinned_client_cert_subject_rdn-property-dcauthwebserver-struct). The *PinnedClientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PinnedClientCertCount](#pinned_client_cert_count-property-dcauthwebserver-struct) property. This property is read-only. ## Data Type String # pinned_client_cert_subject_key_id property ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) Contains a unique identifier of the certificate's cryptographic key. ## Syntax *Rust Syntax* ```text fn pinned_client_cert_subject_key_id(&self , PinnedClientCertIndex : i32) -> Result, 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](#pinned_client_cert_subject_key_id-property-dcauthwebserver-struct) and [pinned_client_cert_ca_key_id](#pinned_client_cert_ca_key_id-property-dcauthwebserver-struct) 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](#pinned_client_cert_count-property-dcauthwebserver-struct) property. This property is read-only. ## Data Type Vec # pinned_client_cert_subject_rdn property ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) A list of Property=Value pairs that uniquely identify the certificate holder (subject). ## Syntax *Rust Syntax* ```text fn pinned_client_cert_subject_rdn(&self , PinnedClientCertIndex : i32) -> Result ``` ## 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](#pinned_client_cert_count-property-dcauthwebserver-struct) property. This property is read-only. ## Data Type String # pinned_client_cert_valid_from property ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) The time point at which the certificate becomes valid, in UTC. ## Syntax *Rust Syntax* ```text fn pinned_client_cert_valid_from(&self , PinnedClientCertIndex : i32) -> Result ``` ## 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](#pinned_client_cert_count-property-dcauthwebserver-struct) property. This property is read-only. ## Data Type String # pinned_client_cert_valid_to property ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) The time point at which the certificate expires, in UTC. ## Syntax *Rust Syntax* ```text fn pinned_client_cert_valid_to(&self , PinnedClientCertIndex : i32) -> Result ``` ## 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](#pinned_client_cert_count-property-dcauthwebserver-struct) property. This property is read-only. ## Data Type String # policies property ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) Specifies the policies to use when processing requests. ## Syntax *Rust Syntax* ```text fn policies(&self ) -> Result fn set_policies(&self, value : i32) -> Option ``` ## 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](#on_sign_request-event-dcauthwebserver-struct) (allows you to track individual requests) and/or [on_external_sign](#on_external_sign-event-dcauthwebserver-struct) (lets you perform the signing manually) events. This setting is a bit mask of the following flags: | | | | | --- | --- | --- | | aspAcceptUnsignedRequests | 1 | Allows the component to accept unauthenticated messages (those not signed with KeyID/KeySecret). Use with extreme care. | | aspIgnorePKCS1Requests | 2 | Ignore requests of PKCS1 type. | | aspIgnorePKCS7Requests | 4 | Ignore requests of PKCS7 type. | | aspIgnoreRequestTSA | 8 | Ignore the TSA URL provided in the request, and either stick with the service provided via TimestampServer property, or not timestamp the message altogether. | | aspIgnoreRequestSigningTime | 16 | Ignore the signing time included in the request. | | aspIgnoreRequestPKCS7Settings | 32 | Ignore auxiliary PKCS7 settings (content type, attributes) included in the request. | | aspAlwaysTimestampSigs | 64 | Timestamp created signatures (PKCS7 only), even if the client did not request it. | ## Data Type i32 # port property ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) Specifies the port number to listen for connections on. ## Syntax *Rust Syntax* ```text fn port(&self ) -> Result fn set_port(&self, value : i32) -> Option ``` ## 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](#port_range_from-property-dcauthwebserver-struct) and [port_range_to](#port_range_to-property-dcauthwebserver-struct) properties. In this case the port will be allocated within the requested range by the operating system, and reported in [bound_port](#bound_port-property-dcauthwebserver-struct). ## Data Type i32 # port_range_from property ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) Specifies the lower limit of the listening port range for incoming connections. ## Syntax *Rust Syntax* ```text fn port_range_from(&self ) -> Result fn set_port_range_from(&self, value : i32) -> Option ``` ## 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](#port-property-dcauthwebserver-struct)), the port will be allocated within the requested range by the operating system, and reported in [bound_port](#bound_port-property-dcauthwebserver-struct). Note that this property is ignored if the [port](#port-property-dcauthwebserver-struct) 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-secureblackboxdcauthwebserver) Struct) Specifies the upper limit of the listening port range for incoming connections. ## Syntax *Rust Syntax* ```text fn port_range_to(&self ) -> Result fn set_port_range_to(&self, value : i32) -> Option ``` ## 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](#port-property-dcauthwebserver-struct)), the port will be allocated within the requested range by the operating system, and reported in [bound_port](#bound_port-property-dcauthwebserver-struct). Note that this property is ignored if the [port](#port-property-dcauthwebserver-struct) 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-secureblackboxdcauthwebserver) Struct) Specifies the default session timeout value in milliseconds. ## Syntax *Rust Syntax* ```text fn session_timeout(&self ) -> Result fn set_session_timeout(&self, value : i32) -> Option ``` ## 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-secureblackboxdcauthwebserver) Struct) The signing service endpoint. ## Syntax *Rust Syntax* ```text fn sign_endpoint(&self ) -> Result fn set_sign_endpoint(&self, value : &str) -> Option fn set_sign_endpoint_ref(&self, value : &String) -> Option ``` ## 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-secureblackboxdcauthwebserver) Struct) Returns the raw certificate data in DER format. ## Syntax *Rust Syntax* ```text fn signing_cert_bytes(&self ) -> Result, SecureBlackboxError> ``` ## Remarks Returns the raw certificate data in DER format. This property is read-only. ## Data Type Vec # signing_cert_handle property ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax *Rust Syntax* ```text fn signing_cert_handle(&self ) -> Result fn set_signing_cert_handle(&self, value : i64) -> Option ``` ## 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. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` ## Data Type i64 # signing_chain_count property ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) The number of records in the SigningChain arrays. ## Syntax *Rust Syntax* ```text fn signing_chain_count(&self ) -> Result fn set_signing_chain_count(&self, value : i32) -> Option ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [signing_chain_bytes](#signing_chain_bytes-property-dcauthwebserver-struct) - [signing_chain_handle](#signing_chain_handle-property-dcauthwebserver-struct) The array indices start at *0* and end at *signing_chain_count - 1*. ## Data Type i32 # signing_chain_bytes property ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) Returns the raw certificate data in DER format. ## Syntax *Rust Syntax* ```text fn signing_chain_bytes(&self , SigningChainIndex : i32) -> Result, 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](#signing_chain_count-property-dcauthwebserver-struct) property. This property is read-only. ## Data Type Vec # signing_chain_handle property ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax *Rust Syntax* ```text fn signing_chain_handle(&self , SigningChainIndex : i32) -> Result fn set_signing_chain_handle(&self, SigningChainIndex : i32, value : i64) -> Option ``` ## 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. ```text 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](#signing_chain_count-property-dcauthwebserver-struct) property. ## Data Type i64 # socket_incoming_speed_limit property ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) The maximum number of bytes to read from the socket, per second. ## Syntax *Rust Syntax* ```text fn socket_incoming_speed_limit(&self ) -> Result fn set_socket_incoming_speed_limit(&self, value : i32) -> Option ``` ## 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-secureblackboxdcauthwebserver) Struct) The local network interface to bind the socket to. ## Syntax *Rust Syntax* ```text fn socket_local_address(&self ) -> Result fn set_socket_local_address(&self, value : &str) -> Option fn set_socket_local_address_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks The local network interface to bind the socket to. ## Data Type String # socket_local_port property ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) The local port number to bind the socket to. ## Syntax *Rust Syntax* ```text fn socket_local_port(&self ) -> Result fn set_socket_local_port(&self, value : i32) -> Option ``` ## Default Value 0 ## Remarks The local port number to bind the socket to. ## Data Type i32 # socket_outgoing_speed_limit property ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) The maximum number of bytes to write to the socket, per second. ## Syntax *Rust Syntax* ```text fn socket_outgoing_speed_limit(&self ) -> Result fn set_socket_outgoing_speed_limit(&self, value : i32) -> Option ``` ## Default Value 0 ## Remarks The maximum number of bytes to write to the socket, per second. ## Data Type i32 # socket_timeout property ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful. ## Syntax *Rust Syntax* ```text fn socket_timeout(&self ) -> Result fn set_socket_timeout(&self, value : i32) -> Option ``` ## 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-secureblackboxdcauthwebserver) Struct) Enables or disables IP protocol version 6. ## Syntax *Rust Syntax* ```text fn socket_use_ipv6(&self ) -> Result fn set_socket_use_ipv6(&self, value : bool) -> Option ``` ## Default Value false ## Remarks Enables or disables IP protocol version 6. ## Data Type bool # storage_id property ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) Specifies the signing certificate residing in an alternative location. ## Syntax *Rust Syntax* ```text fn storage_id(&self ) -> Result fn set_storage_id(&self, value : &str) -> Option fn set_storage_id_ref(&self, value : &String) -> Option ``` ## 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-secureblackboxdcauthwebserver) Struct) The address of the timestamping server. ## Syntax *Rust Syntax* ```text fn timestamp_server(&self ) -> Result fn set_timestamp_server(&self, value : &str) -> Option fn set_timestamp_server_ref(&self, value : &String) -> Option ``` ## 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](#on_notification-event-dcauthwebserver-struct) 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-secureblackboxdcauthwebserver) Struct) The number of records in the TLSServerCert arrays. ## Syntax *Rust Syntax* ```text fn tls_server_cert_count(&self ) -> Result fn set_tls_server_cert_count(&self, value : i32) -> Option ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [tls_server_cert_bytes](#tls_server_cert_bytes-property-dcauthwebserver-struct) - [tls_server_cert_handle](#tls_server_cert_handle-property-dcauthwebserver-struct) The array indices start at *0* and end at *tls_server_cert_count - 1*. ## Data Type i32 # tls_server_cert_bytes property ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) Returns the raw certificate data in DER format. ## Syntax *Rust Syntax* ```text fn tls_server_cert_bytes(&self , TLSServerCertIndex : i32) -> Result, 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](#tls_server_cert_count-property-dcauthwebserver-struct) property. This property is read-only. ## Data Type Vec # tls_server_cert_handle property ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax *Rust Syntax* ```text fn tls_server_cert_handle(&self , TLSServerCertIndex : i32) -> Result fn set_tls_server_cert_handle(&self, TLSServerCertIndex : i32, value : i64) -> Option ``` ## 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. ```text 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](#tls_server_cert_count-property-dcauthwebserver-struct) property. ## Data Type i64 # tls_auto_validate_certificates property ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) Specifies whether server-side TLS certificates should be validated automatically using internal validation rules. ## Syntax *Rust Syntax* ```text fn tls_auto_validate_certificates(&self ) -> Result fn set_tls_auto_validate_certificates(&self, value : bool) -> Option ``` ## 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-secureblackboxdcauthwebserver) Struct) Selects the base configuration for the TLS settings. ## Syntax *Rust Syntax* ```text fn tls_base_configuration(&self ) -> Result fn set_tls_base_configuration(&self, value : i32) -> Option ``` ## Possible Values ```text 0 // Default1 // Compatible2 // ComprehensiveInsecure3 // 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. | | | | | --- | --- | --- | | stpcDefault | 0 | | | stpcCompatible | 1 | | | stpcComprehensiveInsecure | 2 | | | stpcHighlySecure | 3 | | ## Data Type i32 # tls_ciphersuites property ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) A list of ciphersuites separated with commas or semicolons. ## Syntax *Rust Syntax* ```text fn tls_ciphersuites(&self ) -> Result fn set_tls_ciphersuites(&self, value : &str) -> Option fn set_tls_ciphersuites_ref(&self, value : &String) -> Option ``` ## 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](#tls_base_configuration-property-dcauthwebserver-struct). 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-secureblackboxdcauthwebserver) Struct) Enables or disables certificate-based client authentication. ## Syntax *Rust Syntax* ```text fn tls_client_auth(&self ) -> Result fn set_tls_client_auth(&self, value : i32) -> Option ``` ## Possible Values ```text 0 // NoAuth1 // RequestCert2 // RequireCert ``` ## Default Value 0 ## Remarks Enables or disables certificate-based client authentication. Set this property to true to tune up the client authentication type: | | | | | --- | --- | --- | | ccatNoAuth | 0 | | | ccatRequestCert | 1 | | | ccatRequireCert | 2 | | ## Data Type i32 # tls_extensions property ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) Provides access to TLS extensions. ## Syntax *Rust Syntax* ```text fn tls_extensions(&self ) -> Result fn set_tls_extensions(&self, value : &str) -> Option fn set_tls_extensions_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks Provides access to TLS extensions. ## Data Type String # tls_force_resume_if_destination_changes property ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) Whether to force TLS session resumption when the destination address changes. ## Syntax *Rust Syntax* ```text fn tls_force_resume_if_destination_changes(&self ) -> Result fn set_tls_force_resume_if_destination_changes(&self, value : bool) -> Option ``` ## Default Value false ## Remarks Whether to force TLS session resumption when the destination address changes. ## Data Type bool # tls_groups property ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) Specifies a list of key exchange groups to attempt during the TLS key exchange. ## Syntax *Rust Syntax* ```text fn tls_groups(&self ) -> Result fn set_tls_groups(&self, value : &str) -> Option fn set_tls_groups_ref(&self, value : &String) -> Option ``` ## 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: ```text // 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-secureblackboxdcauthwebserver) Struct) Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. ## Syntax *Rust Syntax* ```text fn tls_pre_shared_identity(&self ) -> Result fn set_tls_pre_shared_identity(&self, value : &str) -> Option fn set_tls_pre_shared_identity_ref(&self, value : &String) -> Option ``` ## 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-secureblackboxdcauthwebserver) Struct) Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16. ## Syntax *Rust Syntax* ```text fn tls_pre_shared_key(&self ) -> Result fn set_tls_pre_shared_key(&self, value : &str) -> Option fn set_tls_pre_shared_key_ref(&self, value : &String) -> Option ``` ## 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-secureblackboxdcauthwebserver) Struct) Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation. ## Syntax *Rust Syntax* ```text fn tls_pre_shared_key_ciphersuite(&self ) -> Result fn set_tls_pre_shared_key_ciphersuite(&self, value : &str) -> Option fn set_tls_pre_shared_key_ciphersuite_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation. ## Data Type String # tls_renegotiation_attack_prevention_mode property ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) Selects the renegotiation attack prevention mechanism. ## Syntax *Rust Syntax* ```text fn tls_renegotiation_attack_prevention_mode(&self ) -> Result fn set_tls_renegotiation_attack_prevention_mode(&self, value : i32) -> Option ``` ## Possible Values ```text 0 // Compatible1 // Strict2 // Auto ``` ## Default Value 2 ## Remarks Selects the renegotiation attack prevention mechanism. The following options are available: | | | | | --- | --- | --- | | crapmCompatible | 0 | TLS 1.0 and 1.1 compatibility mode (renegotiation indication extension is disabled). | | crapmStrict | 1 | Renegotiation attack prevention is enabled and enforced. | | crapmAuto | 2 | Automatically choose whether to enable or disable renegotiation attack prevention. | ## Data Type i32 # tls_revocation_check property ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) Specifies the kind(s) of revocation check to perform. ## Syntax *Rust Syntax* ```text fn tls_revocation_check(&self ) -> Result fn set_tls_revocation_check(&self, value : i32) -> Option ``` ## Possible Values ```text 0 // None1 // Auto2 // AllCRL3 // AllOCSP4 // AllCRLAndOCSP5 // AnyCRL6 // AnyOCSP7 // AnyCRLOrOCSP8 // 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. | | | | | --- | --- | --- | | crcNone | 0 | No revocation checking. | | crcAuto | 1 | Automatic mode selection. Currently this maps to crcAnyOCSPOrCRL, but it may change in the future. | | crcAllCRL | 2 | All provided CRL endpoints will be checked, and all checks must succeed. | | crcAllOCSP | 3 | All provided OCSP endpoints will be checked, and all checks must succeed. | | crcAllCRLAndOCSP | 4 | All provided CRL and OCSP endpoints will be checked, and all checks must succeed. | | crcAnyCRL | 5 | All provided CRL endpoints will be checked, and at least one check must succeed. | | crcAnyOCSP | 6 | All provided OCSP endpoints will be checked, and at least one check must succeed. | | crcAnyCRLOrOCSP | 7 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. CRL endpoints are checked first. | | crcAnyOCSPOrCRL | 8 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. OCSP endpoints are checked first. | 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-secureblackboxdcauthwebserver) 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 *Rust Syntax* ```text fn tls_ssl_options(&self ) -> Result fn set_tls_ssl_options(&self, value : i32) -> Option ``` ## Default Value 16 ## Remarks 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. It is unlikely that you will ever need to adjust it. | | cssloForceUseOfClientCertHashAlg | 0x008 | Enforce the use of the client certificate hash algorithm. It is unlikely that you will ever need to adjust it. | | cssloAutoAddServerNameExtension | 0x010 | Automatically add the server name extension when known | | cssloAcceptTrustedSRPPrimesOnly | 0x020 | Accept trusted SRP primes only | | cssloDisableSignatureAlgorithmsExtension | 0x040 | Disable (do not send) the signature algorithms extension. It is unlikely that you will ever need to adjust it. | | cssloIntolerateHigherProtocolVersions | 0x080 | (server option) Do not allow fallback from TLS versions higher than currently enabled | | cssloStickToPrefCertHashAlg | 0x100 | Stick to preferred certificate hash algorithms | | cssloNoImplicitTLS12Fallback | 0x200 | Disable implicit TLS 1.3 to 1.2 fallbacks | | cssloUseHandshakeBatches | 0x400 | Send the handshake message as large batches rather than individually | ## Data Type i32 # tls_mode property ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) Specifies the TLS mode to use. ## Syntax *Rust Syntax* ```text fn tls_mode(&self ) -> Result fn set_tls_mode(&self, value : i32) -> Option ``` ## Possible Values ```text 0 // Default1 // NoTLS2 // ExplicitTLS3 // ImplicitTLS4 // MixedTLS ``` ## Default Value 0 ## Remarks Specifies the TLS mode to use. | | | | | --- | --- | --- | | smDefault | 0 | | | smNoTLS | 1 | Do not use TLS | | smExplicitTLS | 2 | Connect to the server without any encryption and then request an SSL session. | | smImplicitTLS | 3 | Connect to the specified port, and establish the SSL session at once. | | smMixedTLS | 4 | Connect to the specified port, and establish the SSL session at once, but allow plain data. | ## Data Type i32 # tls_use_extended_master_secret property ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) Enables the Extended Master Secret Extension, as defined in RFC 7627. ## Syntax *Rust Syntax* ```text fn tls_use_extended_master_secret(&self ) -> Result fn set_tls_use_extended_master_secret(&self, value : bool) -> Option ``` ## 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-secureblackboxdcauthwebserver) Struct) Enables or disables the TLS session resumption capability. ## Syntax *Rust Syntax* ```text fn tls_use_session_resumption(&self ) -> Result fn set_tls_use_session_resumption(&self, value : bool) -> Option ``` ## Default Value false ## Remarks Enables or disables the TLS session resumption capability. ## Data Type bool # tls_versions property ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) The SSL/TLS versions to enable by default. ## Syntax *Rust Syntax* ```text fn tls_versions(&self ) -> Result fn set_tls_versions(&self, value : i32) -> Option ``` ## Default Value 48 ## Remarks The SSL/TLS versions to enable by default. | | | | | --- | --- | --- | | csbSSL2 | 0x01 | SSL 2 | | csbSSL3 | 0x02 | SSL 3 | | csbTLS1 | 0x04 | TLS 1.0 | | csbTLS11 | 0x08 | TLS 1.1 | | csbTLS12 | 0x10 | TLS 1.2 | | csbTLS13 | 0x20 | TLS 1.3 | ## Data Type i32 # user_count property ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) The number of records in the User arrays. ## Syntax *Rust Syntax* ```text fn user_count(&self ) -> Result fn set_user_count(&self, value : i32) -> Option ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [user_associated_data](#user_associated_data-property-dcauthwebserver-struct) - [user_base_path](#user_base_path-property-dcauthwebserver-struct) - [user_data](#user_data-property-dcauthwebserver-struct) - [user_handle](#user_handle-property-dcauthwebserver-struct) - [user_hash_algorithm](#user_hash_algorithm-property-dcauthwebserver-struct) - [user_incoming_speed_limit](#user_incoming_speed_limit-property-dcauthwebserver-struct) - [username](#username-property-dcauthwebserver-struct) - [user_outgoing_speed_limit](#user_outgoing_speed_limit-property-dcauthwebserver-struct) - [user_password](#user_password-property-dcauthwebserver-struct) - [user_shared_secret](#user_shared_secret-property-dcauthwebserver-struct) The array indices start at *0* and end at *user_count - 1*. ## Data Type i32 # user_associated_data property ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) Contains the user's Associated Data when SSH AEAD (Authenticated Encryption with Associated Data) algorithm is used. ## Syntax *Rust Syntax* ```text fn user_associated_data(&self , UserIndex : i32) -> Result, SecureBlackboxError> fn set_user_associated_data(&self, UserIndex : i32, value : Vec) -> Option fn set_user_associated_data_ref(&self, UserIndex : i32, value : &[u8]) -> Option ``` ## 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](#user_count-property-dcauthwebserver-struct) property. ## Data Type Vec # user_base_path property ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) Base path for this user in the server's file system. ## Syntax *Rust Syntax* ```text fn user_base_path(&self , UserIndex : i32) -> Result fn set_user_base_path(&self, UserIndex : i32, value : &str) -> Option fn set_user_base_path_ref(&self, UserIndex : i32, value : &String) -> Option ``` ## 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](#user_count-property-dcauthwebserver-struct) property. ## Data Type String # user_data property ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) Contains uninterpreted user-defined data that should be associated with the user account, such as comments or custom settings. ## Syntax *Rust Syntax* ```text fn user_data(&self , UserIndex : i32) -> Result fn set_user_data(&self, UserIndex : i32, value : &str) -> Option fn set_user_data_ref(&self, UserIndex : i32, value : &String) -> Option ``` ## 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](#user_count-property-dcauthwebserver-struct) property. ## Data Type String # user_handle property ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax *Rust Syntax* ```text fn user_handle(&self , UserIndex : i32) -> Result fn set_user_handle(&self, UserIndex : i32, value : i64) -> Option ``` ## 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. ```text 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](#user_count-property-dcauthwebserver-struct) property. ## Data Type i64 # user_hash_algorithm property ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) Specifies the hash algorithm used to generate TOTP (Time-based One-Time Passwords) passwords for this user. ## Syntax *Rust Syntax* ```text fn user_hash_algorithm(&self , UserIndex : i32) -> Result fn set_user_hash_algorithm(&self, UserIndex : i32, value : &str) -> Option fn set_user_hash_algorithm_ref(&self, UserIndex : i32, value : &String) -> Option ``` ## 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: | | | | | --- | --- | --- | | SB_MAC_ALGORITHM_HMAC_SHA1 | SHA1 | | | SB_MAC_ALGORITHM_HMAC_SHA256 | SHA256 | | | SB_MAC_ALGORITHM_HMAC_SHA512 | SHA512 | | The *UserIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [UserCount](#user_count-property-dcauthwebserver-struct) property. ## Data Type String # user_incoming_speed_limit property ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) Specifies the incoming speed limit for this user. ## Syntax *Rust Syntax* ```text fn user_incoming_speed_limit(&self , UserIndex : i32) -> Result fn set_user_incoming_speed_limit(&self, UserIndex : i32, value : i32) -> Option ``` ## 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](#user_count-property-dcauthwebserver-struct) property. ## Data Type i32 # user_outgoing_speed_limit property ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) Specifies the outgoing speed limit for this user. ## Syntax *Rust Syntax* ```text fn user_outgoing_speed_limit(&self , UserIndex : i32) -> Result fn set_user_outgoing_speed_limit(&self, UserIndex : i32, value : i32) -> Option ``` ## 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](#user_count-property-dcauthwebserver-struct) property. ## Data Type i32 # user_password property ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) The user's authentication password. ## Syntax *Rust Syntax* ```text fn user_password(&self , UserIndex : i32) -> Result fn set_user_password(&self, UserIndex : i32, value : &str) -> Option fn set_user_password_ref(&self, UserIndex : i32, value : &String) -> Option ``` ## 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](#user_count-property-dcauthwebserver-struct) property. ## Data Type String # user_shared_secret property ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) Contains the user's secret key, which is essentially a shared secret between the client and server. ## Syntax *Rust Syntax* ```text fn user_shared_secret(&self , UserIndex : i32) -> Result, SecureBlackboxError> fn set_user_shared_secret(&self, UserIndex : i32, value : Vec) -> Option fn set_user_shared_secret_ref(&self, UserIndex : i32, value : &[u8]) -> Option ``` ## 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](#user_count-property-dcauthwebserver-struct) property. ## Data Type Vec # username property ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) The registered name (login) of the user. ## Syntax *Rust Syntax* ```text fn username(&self , UserIndex : i32) -> Result fn set_username(&self, UserIndex : i32, value : &str) -> Option fn set_username_ref(&self, UserIndex : i32, value : &String) -> Option ``` ## 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](#user_count-property-dcauthwebserver-struct) property. ## Data Type String # website_name property ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) Specifies the web site name to use in the certificate. ## Syntax *Rust Syntax* ```text fn website_name(&self ) -> Result fn set_website_name(&self, value : &str) -> Option fn set_website_name_ref(&self, value : &String) -> Option ``` ## 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-secureblackboxdcauthwebserver) Struct) Cleans up the server environment by purging expired sessions and cleaning caches. ## Syntax *Rust Syntax* ```text 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-secureblackboxdcauthwebserver) Struct) Sets or retrieves a configuration setting. ## Syntax *Rust Syntax* ```text fn config(&self, configuration_string : &str) -> Result ``` ## Remarks config is a generic method available in every struct. It is used to set and retrieve [configuration settings](#config-settings-dcauthwebserver-struct) 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](#config-settings-dcauthwebserver-struct), you must call *Config("PROPERTY")*. The value will be returned as a string. # do_action method ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) Performs an additional action. ## Syntax *Rust Syntax* ```text fn do_action(&self, action_id : &str, action_params : &str) -> Result ``` ## 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: | | | | | | --- | --- | --- | --- | | Action | Parameters | Returned value | Description | | ResetTrustedListCache | none | none | Clears the cached list of trusted lists. | | ResetCertificateCache | none | none | Clears the cached certificates. | | ResetCRLCache | none | none | Clears the cached CRLs. | | ResetOCSPResponseCache | none | none | Clears the cached OCSP responses. | # drop_client method ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) Terminates a client connection. ## Syntax *Rust Syntax* ```text 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-secureblackboxdcauthwebserver) Struct) Enumerates the connected clients. ## Syntax *Rust Syntax* ```text fn list_clients(&self) -> Result ``` ## 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-secureblackboxdcauthwebserver) Struct) Takes a snapshot of the connection's properties. ## Syntax *Rust Syntax* ```text 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-secureblackboxdcauthwebserver) Struct) Resets the struct settings. ## Syntax *Rust Syntax* ```text fn reset(&self) -> Result<(), SecureBlackboxError> ``` ## Remarks reset is a generic method available in every struct. # start method ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) Starts the server. ## Syntax *Rust Syntax* ```text fn start(&self) -> Result<(), SecureBlackboxError> ``` ## Remarks Use this method to activate the server and start listening to incoming connections. # stop method ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) Stops the server. ## Syntax *Rust Syntax* ```text fn stop(&self) -> Result<(), SecureBlackboxError> ``` ## Remarks Call this method to stop listening to incoming connections and deactivate the server. # on_accept event ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) Reports an incoming connection. ## Syntax *Rust Syntax* ```text // 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](#on_connect-event-dcauthwebserver-struct) event to be notified of every connection that has been set up. # on_auth_attempt event ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) Fires when a connected client makes an authentication attempt. ## Syntax *Rust Syntax* ```text // 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-secureblackboxdcauthwebserver) Struct) Reports an accepted connection. ## Syntax *Rust Syntax* ```text // 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](#on_tls_handshake-event-dcauthwebserver-struct) or on_data. # on_custom_parameters_received event ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) Passes custom request parameters to the application. ## Syntax *Rust Syntax* ```text // 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-secureblackboxdcauthwebserver) Struct) Fires to report a disconnected client. ## Syntax *Rust Syntax* ```text // 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-secureblackboxdcauthwebserver) Struct) Information about errors during data delivery. ## Syntax *Rust Syntax* ```text // 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](#trappable-errors-dcauthwebserver-struct) section. # on_external_sign event ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) Handles remote or external signing initiated by the server protocol. ## Syntax *Rust Syntax* ```text // 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: ```text 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-secureblackboxdcauthwebserver) Struct) Requests the key secret from the application. ## Syntax *Rust Syntax* ```text // 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](#key_secret-property-dcauthwebserver-struct) 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](#key_id-property-dcauthwebserver-struct) and [key_secret](#key_secret-property-dcauthwebserver-struct) properties would be an easier route. # on_log event ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) Reports a single log line. ## Syntax *Rust Syntax* ```text // 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-secureblackboxdcauthwebserver) Struct) This event notifies the application about an underlying control flow event. ## Syntax *Rust Syntax* ```text // 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-secureblackboxdcauthwebserver) Struct) Passes a standard request parameter to the user code. ## Syntax *Rust Syntax* ```text // 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-secureblackboxdcauthwebserver) Struct) Requests a password from the application. ## Syntax *Rust Syntax* ```text // 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-secureblackboxdcauthwebserver) Struct) Fires when the client sends in a read option request. ## Syntax *Rust Syntax* ```text // 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-secureblackboxdcauthwebserver) Struct) Requests certificate selection criteria from the application. ## Syntax *Rust Syntax* ```text // 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-secureblackboxdcauthwebserver) Struct) This event signifies the processing of an atomic signing request. ## Syntax *Rust Syntax* ```text // 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: | | | | --- | --- | | asmdPKCS1 | 0 | | asmdPKCS7 | 1 | 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](#on_external_sign-event-dcauthwebserver-struct), 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](#on_sign_request_completed-event-dcauthwebserver-struct) event to track completion of the initiated operation. # on_sign_request_completed event ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) This event signifies completion of the processing of an atomic signing request. ## Syntax *Rust Syntax* ```text // 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](#on_sign_request-event-dcauthwebserver-struct) event. # on_timestamp_request event ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) Fires when the struct is ready to request a timestamp from an external TSA. ## Syntax *Rust Syntax* ```text // 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](#timestamp_server-property-dcauthwebserver-struct) 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-secureblackboxdcauthwebserver) Struct) Fires when a client certificate needs to be validated. ## Syntax *Rust Syntax* ```text // 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-secureblackboxdcauthwebserver) Struct) Reports the setup of a TLS session. ## Syntax *Rust Syntax* ```text // 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-secureblackboxdcauthwebserver) Struct) Fires when a newly established client connection initiates a TLS handshake. ## Syntax *Rust Syntax* ```text // 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-secureblackboxdcauthwebserver) Struct) Requests a pre-shared key for TLS-PSK. ## Syntax *Rust Syntax* ```text // 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-secureblackboxdcauthwebserver) Struct) Reports closure of a TLS session. ## Syntax *Rust Syntax* ```text // 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](#on_disconnect-event-dcauthwebserver-struct), which marks the closure of the underlying TCP session. # on_write_option event ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct) Fires when the client sends in a write option request. ## Syntax *Rust Syntax* ```text // 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-secureblackboxdcauthwebserver) 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](#config-method-dcauthwebserver-struct) method. ### DCAuthWebServer Config Settings **CertPassword**: TBD.TBD **CertStoragePath**: TBD.TBD **DataURL**: (obsolete) The DataURL parameter to pass to the signer.(obsolete) The DataURL parameter to pass to the signer. **DualStack**: Allows the use of ip4 and ip6 simultaneously.This setting specifies a socket can use ip4 and ip6 simultaneously. **FingerprintAlgorithm**: The fingerprint algorithm to use.The fingerprint algorithm is used for auxiliary tasks, such as for generating a certificate imprint in SigningCertificateV2 attribute. **GoURL**: (obsolete) The GoURL parameter to pass to the signer.(obsolete) The GoURL parameter to pass to the signer. **HandshakeTimeout**: The HTTPS handshake timeout.The HTTPS handshake timeout in milliseconds. **Host**: The host to bind to.Specifies a specific interface the server should listen on. **Is64BitProcess**: TBD.TBD **KeysEndpoint**: TBD.TBD **KeyStoragePath**: TBD.TBD **PolicyHash**: The EPES policy hash.The EPES policy hash to use, in hex. **PolicyHashAlgorithm**: The EPES policy hash algorithm.The EPES policy hash algorithm. **PolicyID**: The EPES policy identifier.The EPES policy identifier, as OID string (1.2.3.4.5) **PolicyURI**: The EPES policy URL.The EPES policy URL. **Port**: The port to listen on.This config setting mimics the Port property. Please use that instead. **Port64**: TBD.TBD **PortRangeFrom**: The lower bound of allowed port scope to listen on.Specifies the lowest port number the server may use if dynamic allocation is used. **PortRangeTo**: The higher bound of allowed port scope to listen on.Specifies the highest port number the server may use if dynamic allocation is used. **ReadOnlyMode**: TBD.TBD **RequireDefinedSignCert**: (obsolete) The RequireDefinedSignCert parameter to pass to the signer.(obsolete) The RequireDefinedSignCert parameter to pass to the signer. **SchemeParams**: The algorithm scheme parameters to employ.Use this property to specify the parameters of the algorithm scheme if needed. This setting is used to provide parameters for some cryptographic schemes. Use the Name1=Value1;Name2=Value2;... syntax to encode the parameters. For example: *Scheme=PSS;SaltSize=32;TrailerField=1*. **ServerCertificatePassword**: TBD.TBD **ServerCertificatePath**: TBD.TBD **SessionID**: (obsolete) The SessionID parameter to pass to the signer.(obsolete) The SessionID parameter to pass to the signer. **SessionTimeout**: The HTTP session timeout.The HTTP session timeout in milliseconds. **SettingsEndpoint**: TBD.TBD **StatusEndpoint**: TBD.TBD **TLSChainValidationDetails**: Contains the advanced details of the TLS server certificate validation.Check this property in the TLSCertValidate event handler to access the TLS certificate validation details. **TLSChainValidationResult**: Contains the result of the TLS server certificate validation.Check this property in the TLSCertValidate event handler to obtain the TLS certificate validation result. **TLSClientAuthRequested**: Indicates whether the TLS server requests client authentication.Check this property in the TLSCertValidate event handler to find out whether the TLS server requests the client to provide the authentication certificate. If this property is set to true, provide your certificate via the TLSClientChain property. Note that the struct may fire this event more than once during each operation, as more than one TLS-enabled server may need to be contacted. **TLSExtensions**: TBD.TBD **TLSValidationLog**: Contains the log of the TLS server certificate validation.Check this property in the TLSCertValidate event handler to retrieve the validation log of the TLS server. **TokenName**: The TokenName parameter to pass to the signer.(obsolete) The TokenName parameter to pass to the signer. **TokensLibraries**: (obsolete) The TokensLibraries parameter to pass to the signer.(obsolete) The TokensLibraries parameter to pass to the signer. **TspAttemptCount**: Specifies the number of timestamping request attempts.Use this property to specify a number of timestamping request attempts. In case of a timestamping failure, provide new TSA and HTTP settings inside the [on_notification](#on_notification-event-dcauthwebserver-struct) event handler ('BeforeTimestamp' and 'TimestampError' event IDs). **TspHashAlgorithm**: Sets a specific hash algorithm for use with the timestamping service.In default configuration struct uses the 'SHA256' hash algorithm. Use this property to specify a different hash algorithm for the timestamp. Note: Unlike other structs, [PDFSigner](PDFSigner.md#PDFSigner) struct uses the same hash algorithm for the main signature and any associated timestamps during signing. Use this property to specify a different hash algorithm for the timestamp. **TspReqPolicy**: Sets a request policy ID to include in the timestamping request.Use this property to provide a specific request policy OID to include in the timestamping request. Use the standard human-readable OID notation (1.2.3.4.5). **Use64BitService**: TBD.TBD **WebsiteName**: The website name for the TLS certificate.Assign this property with a name to put in a self-generated TLS certificate. ### Base Config Settings **ASN1UseGlobalTagCache**: Controls whether ASN.1 module should use a global object cache.This is a performance setting. It is unlikely that you will ever need to adjust it. **AssignSystemSmartCardPins**: Specifies whether CSP-level PINs should be assigned to CNG keys.This is a low-level tweak for certain cryptographic providers. It is unlikely that you will ever need to adjust it. **CheckKeyIntegrityBeforeUse**: Enables or disable private key integrity check before use.This global property enables or disables private key material check before each signing operation. This slows down performance a bit, but prevents a selection of attacks on RSA keys where keys with unknown origins are used. You can switch this property off to improve performance if your project only uses known, good private keys. **CookieCaching**: Specifies whether a cookie cache should be used for HTTP(S) transports.Set this property to enable or disable cookies caching for the struct. Supported values are: | | | | | --- | --- | --- | | off | | No caching (default) | | local | | Local caching | | global | | Global caching | **Cookies**: Gets or sets local cookies for the struct.Use this property to get cookies from the internal cookie storage of the struct and/or restore them back between application sessions. **DefDeriveKeyIterations**: Specifies the default key derivation algorithm iteration count.This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided. **DNSLocalSuffix**: The suffix to assign for TLD names.Use this global setting to adjust the default suffix to assign to top-level domain names. The default is *.local*. **EnableClientSideSSLFFDHE**: Enables or disables finite field DHE key exchange support in TLS clients.This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower algorithm if compared to EC DHE; enabling it may result in slower connections. This setting only applies to sessions negotiated with TLS version 1.3. **EnableSSHMLKEM**: Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server components.Use this setting to enable hybrid key exchange algorithms in client and server SSH and SFTP components. This is a global setting that enables ML-KEM blanketly in all SSH-dependent components. **EnableTLSMLKEM**: Enables support for ML-KEM and hybrid groups in TLS client and server components.Use this setting to enable ML-KEM and hybrid key exchange groups in client and server TLS components. This is a global setting that enables ML-KEM blanketly in all TLS-dependent components. **GlobalCookies**: Gets or sets global cookies for all the HTTP transports.Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the structs that have its *CookieCaching* property set to "global". **HardwareCryptoUsePolicy**: The hardware crypto usage policy.This global setting controls the hardware cryptography usage policy. Supported Values: | | | | --- | --- | | auto | Use hardware cryptography if available; otherwise, fall back to software-based cryptography (default). | | enable | Always attempt to use hardware cryptography. If unavailable, exception will be thrown. | | disable | Do not use hardware cryptography. | **HttpUserAgent**: Specifies the user agent name to be used by all HTTP clients.This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other structs. **HttpVersion**: The HTTP version to use in any inner HTTP client components created.Set this property to 1.0 or 1.1 to indicate the HTTP version that any internal HTTP clients should use. **IgnoreExpiredMSCTLSigningCert**: Whether to tolerate the expired Windows Update signing certificate.It is not uncommon for Microsoft Windows Update Certificate Trust List to be signed with an expired Microsoft certificate. Setting this global property to true makes SBB ignore the expired factor and take the Trust List into account. **ListDelimiter**: The delimiter character for multi-element lists.Allows to set the delimiter for any multi-entry values returned by the component as a string object, such as file lists. For most of the components, this property is set to a newline sequence. **LogDestination**: Specifies the debug log destination.Contains a comma-separated list of values that specifies where debug log should be dumped. Supported values are: | | | | | --- | --- | --- | | file | | File | | console | | Console | | systemlog | | System Log (supported for Android only) | | debugger | | Debugger (supported for VCL for Windows and .Net) | **LogDetails**: Specifies the debug log details to dump.Contains a comma-separated list of values that specifies which debug log details to dump. Supported values are: | | | | | --- | --- | --- | | time | | Current time | | level | | Level | | package | | Package name | | module | | Module name | | class | | Class name | | method | | Method name | | threadid | | Thread Id | | contenttype | | Content type | | content | | Content | | all | | All details | **LogFile**: Specifies the debug log filename.Use this property to provide a path to the log file. **LogFilters**: Specifies the debug log filters.Contains a comma-separated list of value pairs ("name:value") that describe filters. Supported filter names are: | | | | | --- | --- | --- | | exclude-package | | Exclude a package specified in the value | | exclude-module | | Exclude a module specified in the value | | exclude-class | | Exclude a class specified in the value | | exclude-method | | Exclude a method specified in the value | | include-package | | Include a package specified in the value | | include-module | | Include a module specified in the value | | include-class | | Include a class specified in the value | | include-method | | Include a method specified in the value | **LogFlushMode**: Specifies the log flush mode.Use this property to set the log flush mode. The following values are defined: | | | | | --- | --- | --- | | none | | No flush (caching only) | | immediate | | Immediate flush (real-time logging) | | maxcount | | Flush cached entries upon reaching LogMaxEventCount entries in the cache. | **LogLevel**: Specifies the debug log level.Use this property to provide the desired debug log level. Supported values are: | | | | | --- | --- | --- | | none | | None (by default) | | fatal | | Severe errors that cause premature termination. | | error | | Other runtime errors or unexpected conditions. | | warning | | Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong". | | info | | Interesting runtime events (startup/shutdown). | | debug | | Detailed information on flow of through the system. | | trace | | More detailed information. | **LogMaxEventCount**: Specifies the maximum number of events to cache before further action is taken.Use this property to specify the log event number threshold. This threshold may have different effects, depending on the rotation setting and/or the flush mode. The default value of this setting is 100. **LogRotationMode**: Specifies the log rotation mode.Use this property to set the log rotation mode. The following values are defined: | | | | | --- | --- | --- | | none | | No rotation | | deleteolder | | Delete older entries from the cache upon reaching LogMaxEventCount | | keepolder | | Keep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded) | **MaxASN1BufferLength**: Specifies the maximal allowed length for ASN.1 primitive tag data.This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks. **MaxASN1TreeDepth**: Specifies the maximal depth for processed ASN.1 trees.This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks. **OCSPHashAlgorithm**: Specifies the hash algorithm to be used to identify certificates in OCSP requests.This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful. **OldClientSideRSAFallback**: Specifies whether the SSH client should use a SHA1 fallback.Tells the SSH client to use a legacy ssh-rsa authentication even if the server indicates support for newer algorithms, such as rsa-sha-256. This is a backward-compatibility tweak. **PKICache**: Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached.The PKICache setting specifies which Public Key Infrastructure (PKI) elements should be cached to optimize performance and reduce retrieval times. It supports comma-separated values to indicate the specific types of PKI data that should be cached. Supported Values: | | | | --- | --- | | certificate | Enables caching of certificates. | | crl | Enables caching of Certificate Revocation Lists (CRLs). | | ocsp | Enables caching of OCSP (Online Certificate Status Protocol) responses. | Example (default value): ```text PKICache=certificate,crl,ocsp ``` In this example, the component caches certificates, CRLs, and OCSP responses. **PKICachePath**: Specifies the file system path where cached PKI data is stored.The PKICachePath setting defines the file system path where cached PKI data (e.g., certificates, CRLs, OCSP responses and Trusted Lists) will be stored. This allows the system to persistently save and retrieve PKI cache data, even across application restarts. The default value is an empty string - no cached PKI data is stored on disk. Example: ```text PKICachePath=C:\Temp\cache ``` In this example, the cached PKI data is stored in the C:\Temp\cache directory. **ProductVersion**: Returns the version of the SecureBlackbox library.This property returns the long version string of the SecureBlackbox library being used (major.minor.build.revision). **ServerSSLDHKeyLength**: Sets the size of the TLS DHE key exchange group.Use this property to adjust the length, in bits, of the DHE prime to be used by the TLS server. **StaticDNS**: Specifies whether static DNS rules should be used.Set this property to enable or disable static DNS rules for the struct. Works only if *UseOwnDNSResolver* is set to *true*. Supported values are: | | | | | --- | --- | --- | | none | | No static DNS rules (default) | | local | | Local static DNS rules | | global | | Global static DNS rules | **StaticIPAddress[domain]**: Gets or sets an IP address for the specified domain name.Use this property to get or set an IP address for the specified domain name in the internal (of the struct) or global DNS rules storage depending on the *StaticDNS* value. The type of the IP address (IPv4 or IPv6) is determined automatically. If both addresses are available, they are divided by the | (pipe) character. **StaticIPAddresses**: Gets or sets all the static DNS rules.Use this property to get static DNS rules from the current rules storage or restore them back between application sessions. If *StaticDNS* of the struct is set to "*local*", the property returns/restores the rules from/to the internal storage of the struct. If *StaticDNS* of the struct is set to "*global*", the property returns/restores the rules from/to the GLOBAL storage. The rules list is returned and accepted in JSON format. **Tag**: Allows to store any custom data.Use this config property to store any custom data. **TLSSessionGroup**: Specifies the group name of TLS sessions to be used for session resumption.Use this property to limit the search of cached TLS sessions to the specified group. Sessions from other groups will be ignored. By default, all sessions are cached with an empty group name and available to all the structs. **TLSSessionLifetime**: Specifies lifetime in seconds of the cached TLS session.Use this property to specify how much time the TLS session should be kept in the session cache. After this time, the session expires and will be automatically removed from the cache. Default value is 300 seconds (5 minutes). **TLSSessionPurgeInterval**: Specifies how often the session cache should remove the expired TLS sessions.Use this property to specify the time interval of purging the expired TLS sessions from the session cache. Default value is 60 seconds (1 minute). **UseCRLObjectCaching**: Specifies whether reuse of loaded CRL objects is enabled.This setting enables or disables the caching of CRL objects. When set to true (the default value), the system checks if a CRL object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where CRL objects are frequently used. **UseInternalRandom**: Switches between SecureBlackbox-own and platform PRNGs.Allows to switch between internal/native PRNG implementation and the one provided by the platform. **UseLegacyAdESValidation**: Enables legacy AdES validation mode.Use this setting to switch the AdES component to the validation approach that was used in SBB 2020/SBB 2022 (less attention to temporal details). **UseOCSPResponseObjectCaching**: Specifies whether reuse of loaded OCSP response objects is enabled.This setting enables or disables the caching of OCSP response objects. When set to true (the default value), the system checks if a OCSP response object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where OCSP response objects are frequently used. **UseOwnDNSResolver**: Specifies whether the client components should use own DNS resolver.Set this global property to false to force all the client components to use the DNS resolver provided by the target OS instead of using own one. **UseSharedSystemStorages**: Specifies whether the validation engine should use a global per-process copy of the system certificate stores.Set this global property to false to make each validation run use its own copy of system certificate stores. **UseSystemNativeSizeCalculation**: An internal CryptoAPI access tweak.This is an internal setting. Please do not use it unless instructed by the support team. **UseSystemOAEPAndPSS**: Enforces or disables the use of system-driven RSA OAEP and PSS computations.This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable. If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations using its own OAEP/PSS implementation. This setting only applies to certificates originating from a Windows system store. **UseSystemRandom**: Enables or disables the use of the OS PRNG.Use this global property to enable or disable the use of operating system-driven pseudorandom number generation. **XMLRDNDescriptorName[OID]**: Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN.This property defines custom mappings between Object Identifiers (OIDs) and descriptor names. This mapping specifies how the certificate's issuer and subject information (ds:IssuerRDN and ds:SubjectRDN elements respectively) are represented in XML signatures. The property accepts comma-separated values where the first descriptor name is used when the OID is mapped, and subsequent values act as aliases for parsing. Syntax: ```text Config("XMLRDNDescriptorName[OID]=PrimaryName,Alias1,Alias2"); ``` Where: OID: The Object Identifier from the certificate's IssuerRDN or SubjectRDN that you want to map. PrimaryName: The main descriptor name used in the XML signature when the OID is encountered. Alias1, Alias2, ...: Optional alternative names recognized during parsing. Usage Examples: Map OID 2.5.4.5 to SERIALNUMBER: ```text Config("XMLRDNDescriptorName[2.5.4.5]=SERIALNUMBER"); ``` Map OID 1.2.840.113549.1.9.1 to E, with aliases EMAIL and EMAILADDRESS: ```text Config("XMLRDNDescriptorName[1.2.840.113549.1.9.1]=E,EMAIL,EMAILADDRESS"); ``` **XMLRDNDescriptorPriority[OID]**: Specifies the priority of descriptor names associated with a specific OID.This property specifies the priority of descriptor names associated with a specific OID that allows to reorder descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during signing. **XMLRDNDescriptorReverseOrder**: Specifies whether to reverse the order of descriptors in RDN.Specifies whether to reverse the order of descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to true (as specified in RFC 2253, 2.1). **XMLRDNDescriptorSeparator**: Specifies the separator used between descriptors in RDN.Specifies the separator used between descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to ", " value. # Trappable Errors ([DCAuthWebServer](#struct-secureblackboxdcauthwebserver) Struct)