# Struct secureblackbox::WebDAVServer The WebDAVServer struct offers server-side functionality for the WebDAV protocol. ## Syntax ```text secureblackbox::WebDAVServer ``` ## Remarks Both plain (HTTP) and secure (HTTPS) connection types are supported. ### 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 WebDAVServer struct cannot be disposed of automatically. Please, call the *dispose(&mut; self)* method of WebDAVServer 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-webdavserver-struct) | Indicates whether the server is active and is listening to new connections. | | [auth_realm](#auth_realm-property-webdavserver-struct) | Specifies authentication realm for digest and NTLM authentication. | | [auth_types](#auth_types-property-webdavserver-struct) | Defines allowed HTTP authentication types. | | [bound_port](#bound_port-property-webdavserver-struct) | Indicates the bound listening port. | | [client_file_entry_a_time](#client_file_entry_a_time-property-webdavserver-struct) | Contains the last access time for this object, in UTC. | | [client_file_entry_content_type](#client_file_entry_content_type-property-webdavserver-struct) | The object's content type. | | [client_file_entry_c_time](#client_file_entry_c_time-property-webdavserver-struct) | Contains this object's creation time, in UTC. | | [client_file_entry_directory](#client_file_entry_directory-property-webdavserver-struct) | Specifies whether this object is a directory. | | [client_file_entry_display_name](#client_file_entry_display_name-property-webdavserver-struct) | Contains the display name of the object. | | [client_file_entry_e_tag](#client_file_entry_e_tag-property-webdavserver-struct) | An e-tag of the object. | | [client_file_entry_full_url](#client_file_entry_full_url-property-webdavserver-struct) | A full path to the object. | | [client_file_entry_m_time](#client_file_entry_m_time-property-webdavserver-struct) | The last modification time of the object, in UTC. | | [client_file_entry_parent_url](#client_file_entry_parent_url-property-webdavserver-struct) | Specifies the object's parent URL. | | [client_file_entry_size](#client_file_entry_size-property-webdavserver-struct) | The size of the object in bytes. | | [client_file_entry_supports_exclusive_lock](#client_file_entry_supports_exclusive_lock-property-webdavserver-struct) | Indicates whether the entry supports exclusive locking. | | [client_file_entry_supports_shared_lock](#client_file_entry_supports_shared_lock-property-webdavserver-struct) | Indicates whether the entry supports shared lock. | | [client_file_entry_url](#client_file_entry_url-property-webdavserver-struct) | A URL of the object. | | [document_root](#document_root-property-webdavserver-struct) | The document root of the server. | | [external_crypto_async_document_id](#external_crypto_async_document_id-property-webdavserver-struct) | Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls. | | [external_crypto_custom_params](#external_crypto_custom_params-property-webdavserver-struct) | Custom parameters to be passed to the signing service (uninterpreted). | | [external_crypto_data](#external_crypto_data-property-webdavserver-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-webdavserver-struct) | Specifies whether the message hash is to be calculated at the external endpoint. | | [external_crypto_hash_algorithm](#external_crypto_hash_algorithm-property-webdavserver-struct) | Specifies the request's signature hash algorithm. | | [external_crypto_key_id](#external_crypto_key_id-property-webdavserver-struct) | The ID of the pre-shared key used for DC request authentication. | | [external_crypto_key_secret](#external_crypto_key_secret-property-webdavserver-struct) | The pre-shared key used for DC request authentication. | | [external_crypto_method](#external_crypto_method-property-webdavserver-struct) | Specifies the asynchronous signing method. | | [external_crypto_mode](#external_crypto_mode-property-webdavserver-struct) | Specifies the external cryptography mode. | | [external_crypto_public_key_algorithm](#external_crypto_public_key_algorithm-property-webdavserver-struct) | Provide the public key algorithm here if the certificate is not available on the pre-signing stage. | | [fips_mode](#fips_mode-property-webdavserver-struct) | Reserved. | | [host](#host-property-webdavserver-struct) | The host to bind the listening port to. | | [metadata_flush_timeout](#metadata_flush_timeout-property-webdavserver-struct) | Specifies metadata flush timeout. | | [metadata_root](#metadata_root-property-webdavserver-struct) | The metadata directory root. | | [pinned_client_aead_cipher](#pinned_client_aead_cipher-property-webdavserver-struct) | Indicates whether the encryption algorithm used is an AEAD cipher. | | [pinned_client_chain_validation_details](#pinned_client_chain_validation_details-property-webdavserver-struct) | The details of a certificate chain validation outcome. | | [pinned_client_chain_validation_result](#pinned_client_chain_validation_result-property-webdavserver-struct) | The outcome of a certificate chain validation routine. | | [pinned_client_ciphersuite](#pinned_client_ciphersuite-property-webdavserver-struct) | The cipher suite employed by this connection. | | [pinned_client_client_authenticated](#pinned_client_client_authenticated-property-webdavserver-struct) | Specifies whether client authentication was performed during this connection. | | [pinned_client_client_auth_requested](#pinned_client_client_auth_requested-property-webdavserver-struct) | Specifies whether client authentication was requested during this connection. | | [pinned_client_connection_established](#pinned_client_connection_established-property-webdavserver-struct) | Indicates whether the connection has been established fully. | | [pinned_client_connection_id](#pinned_client_connection_id-property-webdavserver-struct) | The unique identifier assigned to this connection. | | [pinned_client_digest_algorithm](#pinned_client_digest_algorithm-property-webdavserver-struct) | The digest algorithm used in a TLS-enabled connection. | | [pinned_client_encryption_algorithm](#pinned_client_encryption_algorithm-property-webdavserver-struct) | The symmetric encryption algorithm used in a TLS-enabled connection. | | [pinned_client_exportable](#pinned_client_exportable-property-webdavserver-struct) | Indicates whether a TLS connection uses a reduced-strength exportable cipher. | | [pinned_client_group](#pinned_client_group-property-webdavserver-struct) | The elliptic curve used in this connection. | | [pinned_client_id](#pinned_client_id-property-webdavserver-struct) | The client connection's unique identifier. | | [pinned_client_key_exchange_algorithm](#pinned_client_key_exchange_algorithm-property-webdavserver-struct) | The key exchange algorithm used in a TLS-enabled connection. | | [pinned_client_key_exchange_key_bits](#pinned_client_key_exchange_key_bits-property-webdavserver-struct) | The length of the key exchange key of a TLS-enabled connection. | | [pinned_client_pfs_cipher](#pinned_client_pfs_cipher-property-webdavserver-struct) | Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS). | | [pinned_client_pre_shared_identity](#pinned_client_pre_shared_identity-property-webdavserver-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-webdavserver-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-webdavserver-struct) | The length of the public key. | | [pinned_client_remote_address](#pinned_client_remote_address-property-webdavserver-struct) | The client's IP address. | | [pinned_client_remote_port](#pinned_client_remote_port-property-webdavserver-struct) | The remote port of the client connection. | | [pinned_client_resumed_session](#pinned_client_resumed_session-property-webdavserver-struct) | Indicates whether a TLS-enabled connection was spawned from another TLS connection. | | [pinned_client_secure_connection](#pinned_client_secure_connection-property-webdavserver-struct) | Indicates whether TLS or SSL is enabled for this connection. | | [pinned_client_server_authenticated](#pinned_client_server_authenticated-property-webdavserver-struct) | Indicates whether server authentication was performed during a TLS-enabled connection. | | [pinned_client_signature_algorithm](#pinned_client_signature_algorithm-property-webdavserver-struct) | The signature algorithm used in a TLS handshake. | | [pinned_client_symmetric_block_size](#pinned_client_symmetric_block_size-property-webdavserver-struct) | The block size of the symmetric algorithm used. | | [pinned_client_symmetric_key_bits](#pinned_client_symmetric_key_bits-property-webdavserver-struct) | The key length of the symmetric algorithm used. | | [pinned_client_total_bytes_received](#pinned_client_total_bytes_received-property-webdavserver-struct) | The total number of bytes received over this connection. | | [pinned_client_total_bytes_sent](#pinned_client_total_bytes_sent-property-webdavserver-struct) | The total number of bytes sent over this connection. | | [pinned_client_validation_log](#pinned_client_validation_log-property-webdavserver-struct) | Contains the server certificate's chain validation log. | | [pinned_client_version](#pinned_client_version-property-webdavserver-struct) | Indicates the version of SSL/TLS protocol negotiated during this connection. | | [pinned_client_cert_count](#pinned_client_cert_count-property-webdavserver-struct) | The number of records in the PinnedClientCert arrays. | | [pinned_client_cert_bytes](#pinned_client_cert_bytes-property-webdavserver-struct) | Returns the raw certificate data in DER format. | | [pinned_client_cert_ca](#pinned_client_cert_ca-property-webdavserver-struct) | Indicates whether the certificate has a CA capability. | | [pinned_client_cert_ca_key_id](#pinned_client_cert_ca_key_id-property-webdavserver-struct) | A unique identifier (fingerprint) of the CA certificate's cryptographic key. | | [pinned_client_cert_cert_type](#pinned_client_cert_cert_type-property-webdavserver-struct) | Returns the type of the entity contained in the Certificate object. | | [pinned_client_cert_crl_distribution_points](#pinned_client_cert_crl_distribution_points-property-webdavserver-struct) | Contains a list of locations of CRL distribution points used to check this certificate's validity. | | [pinned_client_cert_curve](#pinned_client_cert_curve-property-webdavserver-struct) | Specifies the elliptic curve associated with the certificate's public key. | | [pinned_client_cert_fingerprint](#pinned_client_cert_fingerprint-property-webdavserver-struct) | Contains the fingerprint (a hash imprint) of this certificate. | | [pinned_client_cert_friendly_name](#pinned_client_cert_friendly_name-property-webdavserver-struct) | Contains an associated alias (friendly name) of the certificate. | | [pinned_client_cert_handle](#pinned_client_cert_handle-property-webdavserver-struct) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [pinned_client_cert_hash_algorithm](#pinned_client_cert_hash_algorithm-property-webdavserver-struct) | Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). | | [pinned_client_cert_issuer](#pinned_client_cert_issuer-property-webdavserver-struct) | The common name of the certificate issuer (CA), typically a company name. | | [pinned_client_cert_issuer_rdn](#pinned_client_cert_issuer_rdn-property-webdavserver-struct) | A list of Property=Value pairs that uniquely identify the certificate issuer. | | [pinned_client_cert_key_algorithm](#pinned_client_cert_key_algorithm-property-webdavserver-struct) | Specifies the public key algorithm of this certificate. | | [pinned_client_cert_key_bits](#pinned_client_cert_key_bits-property-webdavserver-struct) | Returns the length of the public key in bits. | | [pinned_client_cert_key_fingerprint](#pinned_client_cert_key_fingerprint-property-webdavserver-struct) | Returns a SHA1 fingerprint of the public key contained in the certificate. | | [pinned_client_cert_key_usage](#pinned_client_cert_key_usage-property-webdavserver-struct) | Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. | | [pinned_client_cert_key_valid](#pinned_client_cert_key_valid-property-webdavserver-struct) | Returns True if the certificate's key is cryptographically valid, and False otherwise. | | [pinned_client_cert_ocsp_locations](#pinned_client_cert_ocsp_locations-property-webdavserver-struct) | Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA. | | [pinned_client_cert_ocsp_no_check](#pinned_client_cert_ocsp_no_check-property-webdavserver-struct) | Accessor to the value of the certificate's ocsp-no-check extension. | | [pinned_client_cert_origin](#pinned_client_cert_origin-property-webdavserver-struct) | Returns the location that the certificate was taken or loaded from. | | [pinned_client_cert_policy_i_ds](#pinned_client_cert_policy_i_ds-property-webdavserver-struct) | Contains identifiers (OIDs) of the applicable certificate policies. | | [pinned_client_cert_private_key_bytes](#pinned_client_cert_private_key_bytes-property-webdavserver-struct) | Returns the certificate's private key in DER-encoded format. | | [pinned_client_cert_private_key_exists](#pinned_client_cert_private_key_exists-property-webdavserver-struct) | Indicates whether the certificate has a usable private key associated with it. | | [pinned_client_cert_private_key_extractable](#pinned_client_cert_private_key_extractable-property-webdavserver-struct) | Indicates whether the private key is extractable (exportable). | | [pinned_client_cert_public_key_bytes](#pinned_client_cert_public_key_bytes-property-webdavserver-struct) | Contains the certificate's public key in DER format. | | [pinned_client_cert_qualified](#pinned_client_cert_qualified-property-webdavserver-struct) | Indicates whether the certificate is qualified. | | [pinned_client_cert_qualified_statements](#pinned_client_cert_qualified_statements-property-webdavserver-struct) | Returns a simplified qualified status of the certificate. | | [pinned_client_cert_qualifiers](#pinned_client_cert_qualifiers-property-webdavserver-struct) | A list of qualifiers. | | [pinned_client_cert_self_signed](#pinned_client_cert_self_signed-property-webdavserver-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-webdavserver-struct) | Returns the certificate's serial number. | | [pinned_client_cert_sig_algorithm](#pinned_client_cert_sig_algorithm-property-webdavserver-struct) | Indicates the algorithm that was used by the CA to sign this certificate. | | [pinned_client_cert_source](#pinned_client_cert_source-property-webdavserver-struct) | Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response. | | [pinned_client_cert_subject](#pinned_client_cert_subject-property-webdavserver-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_alternative_name](#pinned_client_cert_subject_alternative_name-property-webdavserver-struct) | Returns or sets the value of the Subject Alternative Name extension of the certificate. | | [pinned_client_cert_subject_key_id](#pinned_client_cert_subject_key_id-property-webdavserver-struct) | Contains a unique identifier of the certificate's cryptographic key. | | [pinned_client_cert_subject_rdn](#pinned_client_cert_subject_rdn-property-webdavserver-struct) | A list of Property=Value pairs that uniquely identify the certificate holder (subject). | | [pinned_client_cert_valid](#pinned_client_cert_valid-property-webdavserver-struct) | Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request. | | [pinned_client_cert_valid_from](#pinned_client_cert_valid_from-property-webdavserver-struct) | The time point at which the certificate becomes valid, in UTC. | | [pinned_client_cert_valid_to](#pinned_client_cert_valid_to-property-webdavserver-struct) | The time point at which the certificate expires, in UTC. | | [port](#port-property-webdavserver-struct) | Specifies the port number to listen for connections on. | | [port_range_from](#port_range_from-property-webdavserver-struct) | Specifies the lower limit of the listening port range for incoming connections. | | [port_range_to](#port_range_to-property-webdavserver-struct) | Specifies the upper limit of the listening port range for incoming connections. | | [socket_incoming_speed_limit](#socket_incoming_speed_limit-property-webdavserver-struct) | The maximum number of bytes to read from the socket, per second. | | [socket_local_address](#socket_local_address-property-webdavserver-struct) | The local network interface to bind the socket to. | | [socket_local_port](#socket_local_port-property-webdavserver-struct) | The local port number to bind the socket to. | | [socket_outgoing_speed_limit](#socket_outgoing_speed_limit-property-webdavserver-struct) | The maximum number of bytes to write to the socket, per second. | | [socket_timeout](#socket_timeout-property-webdavserver-struct) | The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful. | | [socket_use_ipv6](#socket_use_ipv6-property-webdavserver-struct) | Enables or disables IP protocol version 6. | | [tls_server_cert_count](#tls_server_cert_count-property-webdavserver-struct) | The number of records in the TLSServerCert arrays. | | [tls_server_cert_bytes](#tls_server_cert_bytes-property-webdavserver-struct) | Returns the raw certificate data in DER format. | | [tls_server_cert_handle](#tls_server_cert_handle-property-webdavserver-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-webdavserver-struct) | Specifies whether server-side TLS certificates should be validated automatically using internal validation rules. | | [tls_base_configuration](#tls_base_configuration-property-webdavserver-struct) | Selects the base configuration for the TLS settings. | | [tls_ciphersuites](#tls_ciphersuites-property-webdavserver-struct) | A list of ciphersuites separated with commas or semicolons. | | [tls_client_auth](#tls_client_auth-property-webdavserver-struct) | Enables or disables certificate-based client authentication. | | [tls_extensions](#tls_extensions-property-webdavserver-struct) | Provides access to TLS extensions. | | [tls_force_resume_if_destination_changes](#tls_force_resume_if_destination_changes-property-webdavserver-struct) | Whether to force TLS session resumption when the destination address changes. | | [tls_groups](#tls_groups-property-webdavserver-struct) | Specifies a list of key exchange groups to attempt during the TLS key exchange. | | [tls_pre_shared_identity](#tls_pre_shared_identity-property-webdavserver-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-webdavserver-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-webdavserver-struct) | Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation. | | [tls_renegotiation_attack_prevention_mode](#tls_renegotiation_attack_prevention_mode-property-webdavserver-struct) | Selects the renegotiation attack prevention mechanism. | | [tls_revocation_check](#tls_revocation_check-property-webdavserver-struct) | Specifies the kind(s) of revocation check to perform. | | [tls_ssl_options](#tls_ssl_options-property-webdavserver-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-webdavserver-struct) | Specifies the TLS mode to use. | | [tls_use_extended_master_secret](#tls_use_extended_master_secret-property-webdavserver-struct) | Enables the Extended Master Secret Extension, as defined in RFC 7627. | | [tls_use_session_resumption](#tls_use_session_resumption-property-webdavserver-struct) | Enables or disables the TLS session resumption capability. | | [tls_versions](#tls_versions-property-webdavserver-struct) | The SSL/TLS versions to enable by default. | | [user_count](#user_count-property-webdavserver-struct) | The number of records in the User arrays. | | [user_associated_data](#user_associated_data-property-webdavserver-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-webdavserver-struct) | Base path for this user in the server's file system. | | [user_certificate](#user_certificate-property-webdavserver-struct) | Contains the user's certificate. | | [user_data](#user_data-property-webdavserver-struct) | Contains uninterpreted user-defined data that should be associated with the user account, such as comments or custom settings. | | [user_email](#user_email-property-webdavserver-struct) | The user's email address. | | [user_handle](#user_handle-property-webdavserver-struct) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [user_hash_algorithm](#user_hash_algorithm-property-webdavserver-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-webdavserver-struct) | Specifies the incoming speed limit for this user. | | [user_otp_algorithm](#user_otp_algorithm-property-webdavserver-struct) | The algorithm used to generate one-time passwords (OTP) for this user, either HOTP (Hash-based OTP) or TOTP (Time-based OTP). | | [user_otp_len](#user_otp_len-property-webdavserver-struct) | Specifies the length of the user's OTP password. | | [user_otp_value](#user_otp_value-property-webdavserver-struct) | The user's time interval (TOTP) or Counter (HOTP). | | [user_outgoing_speed_limit](#user_outgoing_speed_limit-property-webdavserver-struct) | Specifies the outgoing speed limit for this user. | | [user_password](#user_password-property-webdavserver-struct) | The user's authentication password. | | [user_shared_secret](#user_shared_secret-property-webdavserver-struct) | Contains the user's secret key, which is essentially a shared secret between the client and server. | | [user_ssh_key](#user_ssh_key-property-webdavserver-struct) | Contains the user's SSH key. | | [username](#username-property-webdavserver-struct) | The registered name (login) of the user. | | [website_name](#website_name-property-webdavserver-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-webdavserver-struct) | Cleans up the server environment by purging expired sessions and cleaning caches. | | [config](#config-method-webdavserver-struct) | Sets or retrieves a configuration setting. | | [do_action](#do_action-method-webdavserver-struct) | Performs an additional action. | | [drop_client](#drop_client-method-webdavserver-struct) | Terminates a client connection. | | [get_client_buffer](#get_client_buffer-method-webdavserver-struct) | Obtains a pending connection buffer. | | [get_request_bytes](#get_request_bytes-method-webdavserver-struct) | Returns the contents of the client's HTTP request. | | [get_request_header](#get_request_header-method-webdavserver-struct) | Returns a request header value. | | [get_request_string](#get_request_string-method-webdavserver-struct) | Returns the contents of the client's HTTP request. | | [get_request_username](#get_request_username-method-webdavserver-struct) | Returns the username for a connection. | | [get_response_header](#get_response_header-method-webdavserver-struct) | Returns a response header value. | | [list_clients](#list_clients-method-webdavserver-struct) | Enumerates the connected clients. | | [pin_client](#pin_client-method-webdavserver-struct) | Takes a snapshot of the connection's properties. | | [process_generic_request](#process_generic_request-method-webdavserver-struct) | Processes a generic HTTP request. | | [reset](#reset-method-webdavserver-struct) | Resets the struct settings. | | [set_client_buffer](#set_client_buffer-method-webdavserver-struct) | Commits a data buffer to the connection. | | [set_client_file_entry](#set_client_file_entry-method-webdavserver-struct) | Commits a file entry to the connection. | | [set_response_bytes](#set_response_bytes-method-webdavserver-struct) | Sets a byte array to be served as a response. | | [set_response_file](#set_response_file-method-webdavserver-struct) | Sets a file to be served as a response. | | [set_response_header](#set_response_header-method-webdavserver-struct) | Sets a response header. | | [set_response_status](#set_response_status-method-webdavserver-struct) | Sets an HTTP status to be sent with the response. | | [set_response_string](#set_response_string-method-webdavserver-struct) | Sets a string to be served as a response. | | [start](#start-method-webdavserver-struct) | Starts the server. | | [stop](#stop-method-webdavserver-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-webdavserver-struct) | Reports an incoming connection. | | [on_after_browse](#on_after_browse-event-webdavserver-struct) | WebDAVServer uses this event to notify the application about the completion of the browsing operation. | | [on_after_copy_object](#on_after_copy_object-event-webdavserver-struct) | This event notifies the application about the completion of the copy operation. | | [on_after_create_calendar](#on_after_create_calendar-event-webdavserver-struct) | This event reports the completion of calendar creation request. | | [on_after_create_collection](#on_after_create_collection-event-webdavserver-struct) | WebDAVServer uses this event to report completion of the collection creation operation. | | [on_after_custom_request](#on_after_custom_request-event-webdavserver-struct) | This event reports the completion of the custom request. | | [on_after_lock_object](#on_after_lock_object-event-webdavserver-struct) | Reports the completion of the object locking operation. | | [on_after_refresh_lock](#on_after_refresh_lock-event-webdavserver-struct) | Reports the completion of the lock refresh operation. | | [on_after_remove_object](#on_after_remove_object-event-webdavserver-struct) | This event notifies the application about the completion of object deletion operation. | | [on_after_rename_object](#on_after_rename_object-event-webdavserver-struct) | The struct uses this event to notify the application about the completion of the object rename operation. | | [on_after_set_attributes](#on_after_set_attributes-event-webdavserver-struct) | WebDAVServer fires this event to notify the application of the completion of the attribute assignment operation. | | [on_after_unlock_object](#on_after_unlock_object-event-webdavserver-struct) | Notifies the application about the completion of the object unlocking operation. | | [on_auth_attempt](#on_auth_attempt-event-webdavserver-struct) | Fires when a connected client makes an authentication attempt. | | [on_before_browse](#on_before_browse-event-webdavserver-struct) | Fires when a Browse request is received. | | [on_before_copy_object](#on_before_copy_object-event-webdavserver-struct) | Fires when a Copy Object request is received. | | [on_before_create_calendar](#on_before_create_calendar-event-webdavserver-struct) | Fires when a Create Calendar request is received from a client. | | [on_before_create_collection](#on_before_create_collection-event-webdavserver-struct) | Fires when a Create Collection request is received from a client. | | [on_before_custom_request](#on_before_custom_request-event-webdavserver-struct) | Notifies the application about an incoming custom request. | | [on_before_download_object](#on_before_download_object-event-webdavserver-struct) | Fires when an object download request is received. | | [on_before_lock_object](#on_before_lock_object-event-webdavserver-struct) | Fires when a lock request is received. | | [on_before_refresh_lock](#on_before_refresh_lock-event-webdavserver-struct) | Reports the receipt of lock refresh request. | | [on_before_remove_object](#on_before_remove_object-event-webdavserver-struct) | Fires when an object deletion request is received. | | [on_before_rename_object](#on_before_rename_object-event-webdavserver-struct) | Reports object renaming requests. | | [on_before_request](#on_before_request-event-webdavserver-struct) | Fires before a DAV request is processed. | | [on_before_set_attributes](#on_before_set_attributes-event-webdavserver-struct) | Notifies the application about attribute change request. | | [on_before_unlock_object](#on_before_unlock_object-event-webdavserver-struct) | Fires when an unlock request is received. | | [on_before_upload_object](#on_before_upload_object-event-webdavserver-struct) | Fires when an object upload request is received. | | [on_clear_attribute](#on_clear_attribute-event-webdavserver-struct) | Reports an attribute clearance request. | | [on_connect](#on_connect-event-webdavserver-struct) | Reports an accepted connection. | | [on_copy_object](#on_copy_object-event-webdavserver-struct) | Lets the application handle the Copy Object request. | | [on_create_calendar](#on_create_calendar-event-webdavserver-struct) | Lets the application handle a calendar creation request. | | [on_create_collection](#on_create_collection-event-webdavserver-struct) | Lets the application respond to collection creation request. | | [on_custom_request](#on_custom_request-event-webdavserver-struct) | Use this event to respond to non-standard DAV requests. | | [on_data](#on_data-event-webdavserver-struct) | Supplies a data chunk received from a client. | | [on_disconnect](#on_disconnect-event-webdavserver-struct) | Fires to report a disconnected client. | | [on_download_object](#on_download_object-event-webdavserver-struct) | Allows the application respond to Download Object request. | | [on_download_object_completed](#on_download_object_completed-event-webdavserver-struct) | This event is fired when a download operation completes. | | [on_error](#on_error-event-webdavserver-struct) | Information about errors during data delivery. | | [on_external_sign](#on_external_sign-event-webdavserver-struct) | Handles remote or external signing initiated by the server protocol. | | [on_file_error](#on_file_error-event-webdavserver-struct) | Reports a file access error to the application. | | [on_headers_prepared](#on_headers_prepared-event-webdavserver-struct) | Fires when the response headers have been formed and are ready to be sent to the server. | | [on_list_attributes](#on_list_attributes-event-webdavserver-struct) | Requests object attributes from the application in fraCustom handling mode. | | [on_list_sub_objects](#on_list_sub_objects-event-webdavserver-struct) | Requests a list of sub-objects of an object. The struct uses this event to request a list of sub-objects of the object residing at Path . The Recursive parameter specifies whether the sub-objects should be browsed and returned recursively. Return the requested list via the Objects parameter by separating individual entries with CRLF. | | [on_lock_object](#on_lock_object-event-webdavserver-struct) | Virtualizes the object locking operation. | | [on_notification](#on_notification-event-webdavserver-struct) | This event notifies the application about an underlying control flow event. | | [on_query_quota](#on_query_quota-event-webdavserver-struct) | Reflects a quota enquiry by a client. | | [on_read_attribute](#on_read_attribute-event-webdavserver-struct) | Requests value of an attribute from the application in fraCustom mode. | | [on_read_object](#on_read_object-event-webdavserver-struct) | Requests a piece of object data from the application. | | [on_refresh_lock](#on_refresh_lock-event-webdavserver-struct) | Notifies the application about a lock refresh request. | | [on_remove_object](#on_remove_object-event-webdavserver-struct) | Notifies the application about object deletion requests. | | [on_rename_object](#on_rename_object-event-webdavserver-struct) | Notifies the application about object name change requests. | | [on_resource_access](#on_resource_access-event-webdavserver-struct) | Reports an attempt to access a resource. | | [on_set_attribute](#on_set_attribute-event-webdavserver-struct) | Lets the application customize attribute assignment requests. | | [on_tls_cert_validate](#on_tls_cert_validate-event-webdavserver-struct) | Fires when a client certificate needs to be validated. | | [on_tls_established](#on_tls_established-event-webdavserver-struct) | Reports the setup of a TLS session. | | [on_tls_handshake](#on_tls_handshake-event-webdavserver-struct) | Fires when a newly established client connection initiates a TLS handshake. | | [on_tls_psk](#on_tls_psk-event-webdavserver-struct) | Requests a pre-shared key for TLS-PSK. | | [on_tls_shutdown](#on_tls_shutdown-event-webdavserver-struct) | Reports closure of a TLS session. | | [on_unlock_object](#on_unlock_object-event-webdavserver-struct) | Virtualizes the object unlocking operation. | | [on_upload_object](#on_upload_object-event-webdavserver-struct) | Lets the application respond to the Upload Object request. | | [on_upload_object_completed](#on_upload_object_completed-event-webdavserver-struct) | This event is fired when a upload operation completes. | | [on_write_object](#on_write_object-event-webdavserver-struct) | Hands a piece of object data to the application. | ## Config Settings *The following is a list of config settings for the struct with short descriptions. Click on the links for further details.* | | | | --- | --- | | [BoundAddress](#BoundAddress) | Returns the bound address of the listening socket. | | [BoundPort](#BoundPort) | The port that was bound by the server. | | [DualStack](#DualStack) | Allows the use of ip4 and ip6 simultaneously. | | [HandshakeTimeout](#HandshakeTimeout) | The HTTPS handshake timeout. | | [Host](#Host) | The host to bind to. | | [HTTPStatusCode\[i\]](#HTTPStatusCode[i]) | Provides means to set a custom HTTP status code. | | [Port](#Port) | The port to listen on. | | [PortRangeFrom](#PortRangeFrom) | The lower bound of allowed port scope to listen on. | | [PortRangeTo](#PortRangeTo) | The higher bound of allowed port scope to listen on. | | [PreSharedIdentityHint](#PreSharedIdentityHint) | Gets or sets the PSK identity hint. | | [SessionTimeout](#SessionTimeout) | The HTTP session timeout. | | [SleepLen](#SleepLen) | Adjusts the server loop idling time. | | [TLSCiphersuites](#TLSCiphersuites) | Returns the list of ciphersuites activated in the struct for the current session. | | [TLSExtensions](#TLSExtensions) | TBD. | | [TLSGroups](#TLSGroups) | Returns the list of TLS key exchange groups enabled in the struct. | | [TLSPeerExtensions](#TLSPeerExtensions) | TBD. | | [TLSServerCertIndex](#TLSServerCertIndex) | Specifies the index of the server certificate to use. | | [TLSVersions](#TLSVersions) | Returns the list of TLS versions enabled in the struct. | | [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 ([WebDAVServer](#struct-secureblackboxwebdavserver) 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 # auth_realm property ([WebDAVServer](#struct-secureblackboxwebdavserver) 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 ([WebDAVServer](#struct-secureblackboxwebdavserver) 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 ([WebDAVServer](#struct-secureblackboxwebdavserver) 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-webdavserver-struct) if it is provided, or is allocated dynamically if configured to fall in the range between [port_range_from](#port_range_from-property-webdavserver-struct) and [port_range_to](#port_range_to-property-webdavserver-struct) constraints. This property is read-only. ## Data Type i32 # client_file_entry_a_time property ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Contains the last access time for this object, in UTC. ## Syntax *Rust Syntax* ```text fn client_file_entry_a_time(&self ) -> Result fn set_client_file_entry_a_time(&self, value : &str) -> Option fn set_client_file_entry_a_time_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks Contains the last access time for this object, in UTC. ## Data Type String # client_file_entry_content_type property ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) The object's content type. ## Syntax *Rust Syntax* ```text fn client_file_entry_content_type(&self ) -> Result fn set_client_file_entry_content_type(&self, value : &str) -> Option fn set_client_file_entry_content_type_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks The object's content type. ## Data Type String # client_file_entry_c_time property ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Contains this object's creation time, in UTC. ## Syntax *Rust Syntax* ```text fn client_file_entry_c_time(&self ) -> Result fn set_client_file_entry_c_time(&self, value : &str) -> Option fn set_client_file_entry_c_time_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks Contains this object's creation time, in UTC. ## Data Type String # client_file_entry_directory property ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Specifies whether this object is a directory. ## Syntax *Rust Syntax* ```text fn client_file_entry_directory(&self ) -> Result fn set_client_file_entry_directory(&self, value : bool) -> Option ``` ## Default Value false ## Remarks Specifies whether this object is a directory. ## Data Type bool # client_file_entry_display_name property ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Contains the display name of the object. ## Syntax *Rust Syntax* ```text fn client_file_entry_display_name(&self ) -> Result fn set_client_file_entry_display_name(&self, value : &str) -> Option fn set_client_file_entry_display_name_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks Contains the display name of the object. ## Data Type String # client_file_entry_e_tag property ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) An e-tag of the object. ## Syntax *Rust Syntax* ```text fn client_file_entry_e_tag(&self ) -> Result fn set_client_file_entry_e_tag(&self, value : &str) -> Option fn set_client_file_entry_e_tag_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks An e-tag of the object. ## Data Type String # client_file_entry_full_url property ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) A full path to the object. ## Syntax *Rust Syntax* ```text fn client_file_entry_full_url(&self ) -> Result fn set_client_file_entry_full_url(&self, value : &str) -> Option fn set_client_file_entry_full_url_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks A full path to the object. ## Data Type String # client_file_entry_m_time property ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) The last modification time of the object, in UTC. ## Syntax *Rust Syntax* ```text fn client_file_entry_m_time(&self ) -> Result fn set_client_file_entry_m_time(&self, value : &str) -> Option fn set_client_file_entry_m_time_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks The last modification time of the object, in UTC. ## Data Type String # client_file_entry_parent_url property ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Specifies the object's parent URL. ## Syntax *Rust Syntax* ```text fn client_file_entry_parent_url(&self ) -> Result fn set_client_file_entry_parent_url(&self, value : &str) -> Option fn set_client_file_entry_parent_url_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks Specifies the object's parent URL. ## Data Type String # client_file_entry_size property ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) The size of the object in bytes. ## Syntax *Rust Syntax* ```text fn client_file_entry_size(&self ) -> Result fn set_client_file_entry_size(&self, value : i64) -> Option ``` ## Default Value 0 ## Remarks The size of the object in bytes. ## Data Type i64 # client_file_entry_supports_exclusive_lock property ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Indicates whether the entry supports exclusive locking. ## Syntax *Rust Syntax* ```text fn client_file_entry_supports_exclusive_lock(&self ) -> Result fn set_client_file_entry_supports_exclusive_lock(&self, value : bool) -> Option ``` ## Default Value false ## Remarks Indicates whether the entry supports exclusive locking. ## Data Type bool # client_file_entry_supports_shared_lock property ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Indicates whether the entry supports shared lock. ## Syntax *Rust Syntax* ```text fn client_file_entry_supports_shared_lock(&self ) -> Result fn set_client_file_entry_supports_shared_lock(&self, value : bool) -> Option ``` ## Default Value false ## Remarks Indicates whether the entry supports shared lock. ## Data Type bool # client_file_entry_url property ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) A URL of the object. ## Syntax *Rust Syntax* ```text fn client_file_entry_url(&self ) -> Result fn set_client_file_entry_url(&self, value : &str) -> Option fn set_client_file_entry_url_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks A URL of the object. ## Data Type String # document_root property ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) The document root of the server. ## Syntax *Rust Syntax* ```text fn document_root(&self ) -> Result fn set_document_root(&self, value : &str) -> Option fn set_document_root_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks Use this property to specify a local folder which is going to be the server's document root (the mount point of the virtual home directory). ## Data Type String # external_crypto_async_document_id property ([WebDAVServer](#struct-secureblackboxwebdavserver) 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 ([WebDAVServer](#struct-secureblackboxwebdavserver) 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 ([WebDAVServer](#struct-secureblackboxwebdavserver) 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 ([WebDAVServer](#struct-secureblackboxwebdavserver) 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 ([WebDAVServer](#struct-secureblackboxwebdavserver) 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 ([WebDAVServer](#struct-secureblackboxwebdavserver) 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-webdavserver-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 ([WebDAVServer](#struct-secureblackboxwebdavserver) 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-webdavserver-struct) topic. ## Data Type String # external_crypto_method property ([WebDAVServer](#struct-secureblackboxwebdavserver) 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 ([WebDAVServer](#struct-secureblackboxwebdavserver) 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 ([WebDAVServer](#struct-secureblackboxwebdavserver) 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 ([WebDAVServer](#struct-secureblackboxwebdavserver) 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 # host property ([WebDAVServer](#struct-secureblackboxwebdavserver) 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 # metadata_flush_timeout property ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Specifies metadata flush timeout. ## Syntax *Rust Syntax* ```text fn metadata_flush_timeout(&self ) -> Result fn set_metadata_flush_timeout(&self, value : i32) -> Option ``` ## Default Value 600 ## Remarks Use this property to specify metadata flush timeout in seconds. ## Data Type i32 # metadata_root property ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) The metadata directory root. ## Syntax *Rust Syntax* ```text fn metadata_root(&self ) -> Result fn set_metadata_root(&self, value : &str) -> Option fn set_metadata_root_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks The metadata directory is a dedicated location for storing properties of the files served by the WebDAVServer. ## Data Type String # pinned_client_aead_cipher property ([WebDAVServer](#struct-secureblackboxwebdavserver) 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 ([WebDAVServer](#struct-secureblackboxwebdavserver) 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 ([WebDAVServer](#struct-secureblackboxwebdavserver) 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 ([WebDAVServer](#struct-secureblackboxwebdavserver) 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 ([WebDAVServer](#struct-secureblackboxwebdavserver) 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 ([WebDAVServer](#struct-secureblackboxwebdavserver) 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 ([WebDAVServer](#struct-secureblackboxwebdavserver) 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 ([WebDAVServer](#struct-secureblackboxwebdavserver) 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 ([WebDAVServer](#struct-secureblackboxwebdavserver) 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 ([WebDAVServer](#struct-secureblackboxwebdavserver) 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 ([WebDAVServer](#struct-secureblackboxwebdavserver) 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 ([WebDAVServer](#struct-secureblackboxwebdavserver) 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 ([WebDAVServer](#struct-secureblackboxwebdavserver) 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 ([WebDAVServer](#struct-secureblackboxwebdavserver) 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 ([WebDAVServer](#struct-secureblackboxwebdavserver) 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 ([WebDAVServer](#struct-secureblackboxwebdavserver) 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 ([WebDAVServer](#struct-secureblackboxwebdavserver) 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 ([WebDAVServer](#struct-secureblackboxwebdavserver) 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 ([WebDAVServer](#struct-secureblackboxwebdavserver) 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 ([WebDAVServer](#struct-secureblackboxwebdavserver) 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 ([WebDAVServer](#struct-secureblackboxwebdavserver) 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 ([WebDAVServer](#struct-secureblackboxwebdavserver) 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 ([WebDAVServer](#struct-secureblackboxwebdavserver) 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 ([WebDAVServer](#struct-secureblackboxwebdavserver) 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 ([WebDAVServer](#struct-secureblackboxwebdavserver) 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 ([WebDAVServer](#struct-secureblackboxwebdavserver) 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 ([WebDAVServer](#struct-secureblackboxwebdavserver) 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 ([WebDAVServer](#struct-secureblackboxwebdavserver) 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 ([WebDAVServer](#struct-secureblackboxwebdavserver) 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 ([WebDAVServer](#struct-secureblackboxwebdavserver) 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 ([WebDAVServer](#struct-secureblackboxwebdavserver) 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 ([WebDAVServer](#struct-secureblackboxwebdavserver) 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-webdavserver-struct) - [pinned_client_cert_ca](#pinned_client_cert_ca-property-webdavserver-struct) - [pinned_client_cert_ca_key_id](#pinned_client_cert_ca_key_id-property-webdavserver-struct) - [pinned_client_cert_cert_type](#pinned_client_cert_cert_type-property-webdavserver-struct) - [pinned_client_cert_crl_distribution_points](#pinned_client_cert_crl_distribution_points-property-webdavserver-struct) - [pinned_client_cert_curve](#pinned_client_cert_curve-property-webdavserver-struct) - [pinned_client_cert_fingerprint](#pinned_client_cert_fingerprint-property-webdavserver-struct) - [pinned_client_cert_friendly_name](#pinned_client_cert_friendly_name-property-webdavserver-struct) - [pinned_client_cert_handle](#pinned_client_cert_handle-property-webdavserver-struct) - [pinned_client_cert_hash_algorithm](#pinned_client_cert_hash_algorithm-property-webdavserver-struct) - [pinned_client_cert_issuer](#pinned_client_cert_issuer-property-webdavserver-struct) - [pinned_client_cert_issuer_rdn](#pinned_client_cert_issuer_rdn-property-webdavserver-struct) - [pinned_client_cert_key_algorithm](#pinned_client_cert_key_algorithm-property-webdavserver-struct) - [pinned_client_cert_key_bits](#pinned_client_cert_key_bits-property-webdavserver-struct) - [pinned_client_cert_key_fingerprint](#pinned_client_cert_key_fingerprint-property-webdavserver-struct) - [pinned_client_cert_key_usage](#pinned_client_cert_key_usage-property-webdavserver-struct) - [pinned_client_cert_key_valid](#pinned_client_cert_key_valid-property-webdavserver-struct) - [pinned_client_cert_ocsp_locations](#pinned_client_cert_ocsp_locations-property-webdavserver-struct) - [pinned_client_cert_ocsp_no_check](#pinned_client_cert_ocsp_no_check-property-webdavserver-struct) - [pinned_client_cert_origin](#pinned_client_cert_origin-property-webdavserver-struct) - [pinned_client_cert_policy_i_ds](#pinned_client_cert_policy_i_ds-property-webdavserver-struct) - [pinned_client_cert_private_key_bytes](#pinned_client_cert_private_key_bytes-property-webdavserver-struct) - [pinned_client_cert_private_key_exists](#pinned_client_cert_private_key_exists-property-webdavserver-struct) - [pinned_client_cert_private_key_extractable](#pinned_client_cert_private_key_extractable-property-webdavserver-struct) - [pinned_client_cert_public_key_bytes](#pinned_client_cert_public_key_bytes-property-webdavserver-struct) - [pinned_client_cert_qualified](#pinned_client_cert_qualified-property-webdavserver-struct) - [pinned_client_cert_qualified_statements](#pinned_client_cert_qualified_statements-property-webdavserver-struct) - [pinned_client_cert_qualifiers](#pinned_client_cert_qualifiers-property-webdavserver-struct) - [pinned_client_cert_self_signed](#pinned_client_cert_self_signed-property-webdavserver-struct) - [pinned_client_cert_serial_number](#pinned_client_cert_serial_number-property-webdavserver-struct) - [pinned_client_cert_sig_algorithm](#pinned_client_cert_sig_algorithm-property-webdavserver-struct) - [pinned_client_cert_source](#pinned_client_cert_source-property-webdavserver-struct) - [pinned_client_cert_subject](#pinned_client_cert_subject-property-webdavserver-struct) - [pinned_client_cert_subject_alternative_name](#pinned_client_cert_subject_alternative_name-property-webdavserver-struct) - [pinned_client_cert_subject_key_id](#pinned_client_cert_subject_key_id-property-webdavserver-struct) - [pinned_client_cert_subject_rdn](#pinned_client_cert_subject_rdn-property-webdavserver-struct) - [pinned_client_cert_valid](#pinned_client_cert_valid-property-webdavserver-struct) - [pinned_client_cert_valid_from](#pinned_client_cert_valid_from-property-webdavserver-struct) - [pinned_client_cert_valid_to](#pinned_client_cert_valid_to-property-webdavserver-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 ([WebDAVServer](#struct-secureblackboxwebdavserver) 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-webdavserver-struct) property. This property is read-only. ## Data Type Vec # pinned_client_cert_ca property ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Indicates whether the certificate has a CA capability. ## Syntax *Rust Syntax* ```text fn pinned_client_cert_ca(&self , PinnedClientCertIndex : i32) -> Result ``` ## Default Value false ## Remarks Indicates whether the certificate has a CA capability. For the certificate to be considered a CA, it must have its Basic Constraints extension set with the CA indicator enabled. Set this property when generating a new certificate to have its Basic Constraints extension generated automatically. 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-webdavserver-struct) property. This property is read-only. ## Data Type bool # pinned_client_cert_ca_key_id property ([WebDAVServer](#struct-secureblackboxwebdavserver) 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-webdavserver-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-webdavserver-struct) property. This property is read-only. ## Data Type Vec # pinned_client_cert_cert_type property ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Returns the type of the entity contained in the Certificate object. ## Syntax *Rust Syntax* ```text fn pinned_client_cert_cert_type(&self , PinnedClientCertIndex : i32) -> Result ``` ## Possible Values ```text 0 // Unknown1 // X509Certificate2 // X509CertificateRequest ``` ## Default Value 0 ## Remarks Returns the type of the entity contained in the [Certificate](#Type_Certificate) object. A [Certificate](#Type_Certificate) object can contain two types of cryptographic objects: a ready-to-use X.509 certificate, or a certificate request ("an unsigned certificate"). Certificate requests can be upgraded to full certificates by signing them with a CA certificate. Use the [CertificateManager](#CertificateManager) struct to load or create new certificate and certificate requests objects. 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-webdavserver-struct) property. This property is read-only. ## Data Type i32 # pinned_client_cert_crl_distribution_points property ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Contains a list of locations of CRL distribution points used to check this certificate's validity. ## Syntax *Rust Syntax* ```text fn pinned_client_cert_crl_distribution_points(&self , PinnedClientCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks Contains a list of locations of CRL distribution points used to check this certificate's validity. The list is taken from the respective certificate extension. Use this property when generating a certificate to provide a list of CRL endpoints that should be made part of the new certificate. The endpoints are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator. 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-webdavserver-struct) property. This property is read-only. ## Data Type String # pinned_client_cert_curve property ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Specifies the elliptic curve associated with the certificate's public key. ## Syntax *Rust Syntax* ```text fn pinned_client_cert_curve(&self , PinnedClientCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks Specifies the elliptic curve associated with the certificate's public key. This setting only applies to certificates containing EC keys. | | | | | --- | --- | --- | | SB_EC_SECP112R1 | SECP112R1 | | | SB_EC_SECP112R2 | SECP112R2 | | | SB_EC_SECP128R1 | SECP128R1 | | | SB_EC_SECP128R2 | SECP128R2 | | | SB_EC_SECP160K1 | SECP160K1 | | | SB_EC_SECP160R1 | SECP160R1 | | | SB_EC_SECP160R2 | SECP160R2 | | | SB_EC_SECP192K1 | SECP192K1 | | | SB_EC_SECP192R1 | SECP192R1 | | | SB_EC_SECP224K1 | SECP224K1 | | | SB_EC_SECP224R1 | SECP224R1 | | | SB_EC_SECP256K1 | SECP256K1 | | | SB_EC_SECP256R1 | SECP256R1 | | | SB_EC_SECP384R1 | SECP384R1 | | | SB_EC_SECP521R1 | SECP521R1 | | | SB_EC_SECT113R1 | SECT113R1 | | | SB_EC_SECT113R2 | SECT113R2 | | | SB_EC_SECT131R1 | SECT131R1 | | | SB_EC_SECT131R2 | SECT131R2 | | | SB_EC_SECT163K1 | SECT163K1 | | | SB_EC_SECT163R1 | SECT163R1 | | | SB_EC_SECT163R2 | SECT163R2 | | | SB_EC_SECT193R1 | SECT193R1 | | | SB_EC_SECT193R2 | SECT193R2 | | | SB_EC_SECT233K1 | SECT233K1 | | | SB_EC_SECT233R1 | SECT233R1 | | | SB_EC_SECT239K1 | SECT239K1 | | | SB_EC_SECT283K1 | SECT283K1 | | | SB_EC_SECT283R1 | SECT283R1 | | | SB_EC_SECT409K1 | SECT409K1 | | | SB_EC_SECT409R1 | SECT409R1 | | | SB_EC_SECT571K1 | SECT571K1 | | | SB_EC_SECT571R1 | SECT571R1 | | | SB_EC_PRIME192V1 | PRIME192V1 | | | SB_EC_PRIME192V2 | PRIME192V2 | | | SB_EC_PRIME192V3 | PRIME192V3 | | | SB_EC_PRIME239V1 | PRIME239V1 | | | SB_EC_PRIME239V2 | PRIME239V2 | | | SB_EC_PRIME239V3 | PRIME239V3 | | | SB_EC_PRIME256V1 | PRIME256V1 | | | SB_EC_C2PNB163V1 | C2PNB163V1 | | | SB_EC_C2PNB163V2 | C2PNB163V2 | | | SB_EC_C2PNB163V3 | C2PNB163V3 | | | SB_EC_C2PNB176W1 | C2PNB176W1 | | | SB_EC_C2TNB191V1 | C2TNB191V1 | | | SB_EC_C2TNB191V2 | C2TNB191V2 | | | SB_EC_C2TNB191V3 | C2TNB191V3 | | | SB_EC_C2ONB191V4 | C2ONB191V4 | | | SB_EC_C2ONB191V5 | C2ONB191V5 | | | SB_EC_C2PNB208W1 | C2PNB208W1 | | | SB_EC_C2TNB239V1 | C2TNB239V1 | | | SB_EC_C2TNB239V2 | C2TNB239V2 | | | SB_EC_C2TNB239V3 | C2TNB239V3 | | | SB_EC_C2ONB239V4 | C2ONB239V4 | | | SB_EC_C2ONB239V5 | C2ONB239V5 | | | SB_EC_C2PNB272W1 | C2PNB272W1 | | | SB_EC_C2PNB304W1 | C2PNB304W1 | | | SB_EC_C2TNB359V1 | C2TNB359V1 | | | SB_EC_C2PNB368W1 | C2PNB368W1 | | | SB_EC_C2TNB431R1 | C2TNB431R1 | | | SB_EC_NISTP192 | NISTP192 | | | SB_EC_NISTP224 | NISTP224 | | | SB_EC_NISTP256 | NISTP256 | | | SB_EC_NISTP384 | NISTP384 | | | SB_EC_NISTP521 | NISTP521 | | | SB_EC_NISTB163 | NISTB163 | | | SB_EC_NISTB233 | NISTB233 | | | SB_EC_NISTB283 | NISTB283 | | | SB_EC_NISTB409 | NISTB409 | | | SB_EC_NISTB571 | NISTB571 | | | SB_EC_NISTK163 | NISTK163 | | | SB_EC_NISTK233 | NISTK233 | | | SB_EC_NISTK283 | NISTK283 | | | SB_EC_NISTK409 | NISTK409 | | | SB_EC_NISTK571 | NISTK571 | | | SB_EC_GOSTCPTEST | GOSTCPTEST | | | SB_EC_GOSTCPA | GOSTCPA | | | SB_EC_GOSTCPB | GOSTCPB | | | SB_EC_GOSTCPC | GOSTCPC | | | SB_EC_GOSTCPXCHA | GOSTCPXCHA | | | SB_EC_GOSTCPXCHB | GOSTCPXCHB | | | SB_EC_BRAINPOOLP160R1 | BRAINPOOLP160R1 | | | SB_EC_BRAINPOOLP160T1 | BRAINPOOLP160T1 | | | SB_EC_BRAINPOOLP192R1 | BRAINPOOLP192R1 | | | SB_EC_BRAINPOOLP192T1 | BRAINPOOLP192T1 | | | SB_EC_BRAINPOOLP224R1 | BRAINPOOLP224R1 | | | SB_EC_BRAINPOOLP224T1 | BRAINPOOLP224T1 | | | SB_EC_BRAINPOOLP256R1 | BRAINPOOLP256R1 | | | SB_EC_BRAINPOOLP256T1 | BRAINPOOLP256T1 | | | SB_EC_BRAINPOOLP320R1 | BRAINPOOLP320R1 | | | SB_EC_BRAINPOOLP320T1 | BRAINPOOLP320T1 | | | SB_EC_BRAINPOOLP384R1 | BRAINPOOLP384R1 | | | SB_EC_BRAINPOOLP384T1 | BRAINPOOLP384T1 | | | SB_EC_BRAINPOOLP512R1 | BRAINPOOLP512R1 | | | SB_EC_BRAINPOOLP512T1 | BRAINPOOLP512T1 | | | SB_EC_CURVE25519 | CURVE25519 | | | SB_EC_CURVE448 | CURVE448 | | 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-webdavserver-struct) property. This property is read-only. ## Data Type String # pinned_client_cert_fingerprint property ([WebDAVServer](#struct-secureblackboxwebdavserver) 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-webdavserver-struct) property. This property is read-only. ## Data Type String # pinned_client_cert_friendly_name property ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Contains an associated alias (friendly name) of the certificate. ## Syntax *Rust Syntax* ```text fn pinned_client_cert_friendly_name(&self , PinnedClientCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks Contains an associated alias (friendly name) of the certificate. The friendly name is not a property of a certificate: it is maintained by the certificate media rather than being included in its DER representation. Windows certificate stores are one example of media that does support friendly names. 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-webdavserver-struct) property. This property is read-only. ## Data Type String # pinned_client_cert_handle property ([WebDAVServer](#struct-secureblackboxwebdavserver) 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-webdavserver-struct) property. This property is read-only. ## Data Type i64 # pinned_client_cert_hash_algorithm property ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). ## Syntax *Rust Syntax* ```text fn pinned_client_cert_hash_algorithm(&self , PinnedClientCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). It is not a property of a certificate; use [pinned_client_cert_sig_algorithm](#pinned_client_cert_sig_algorithm-property-webdavserver-struct) to find out the hash algorithm that is part of the certificate signature. | | | | | --- | --- | --- | | 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 | | 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-webdavserver-struct) property. This property is read-only. ## Data Type String # pinned_client_cert_issuer property ([WebDAVServer](#struct-secureblackboxwebdavserver) 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-webdavserver-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-webdavserver-struct) property. This property is read-only. ## Data Type String # pinned_client_cert_issuer_rdn property ([WebDAVServer](#struct-secureblackboxwebdavserver) 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-webdavserver-struct) property. This property is read-only. ## Data Type String # pinned_client_cert_key_algorithm property ([WebDAVServer](#struct-secureblackboxwebdavserver) 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-webdavserver-struct), [pinned_client_cert_curve](#pinned_client_cert_curve-property-webdavserver-struct), and [pinned_client_cert_public_key_bytes](#pinned_client_cert_public_key_bytes-property-webdavserver-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-webdavserver-struct) property. This property is read-only. ## Data Type String # pinned_client_cert_key_bits property ([WebDAVServer](#struct-secureblackboxwebdavserver) 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-webdavserver-struct) or [pinned_client_cert_private_key_bytes](#pinned_client_cert_private_key_bytes-property-webdavserver-struct) 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-webdavserver-struct) property. This property is read-only. ## Data Type i32 # pinned_client_cert_key_fingerprint property ([WebDAVServer](#struct-secureblackboxwebdavserver) 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-webdavserver-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-webdavserver-struct) property. This property is read-only. ## Data Type String # pinned_client_cert_key_usage property ([WebDAVServer](#struct-secureblackboxwebdavserver) 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-webdavserver-struct) property. This property is read-only. ## Data Type i32 # pinned_client_cert_key_valid property ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Returns True if the certificate's key is cryptographically valid, and False otherwise. ## Syntax *Rust Syntax* ```text fn pinned_client_cert_key_valid(&self , PinnedClientCertIndex : i32) -> Result ``` ## Default Value false ## Remarks Returns *True* if the certificate's key is cryptographically valid, and *False* otherwise. 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-webdavserver-struct) property. This property is read-only. ## Data Type bool # pinned_client_cert_ocsp_locations property ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA. ## Syntax *Rust Syntax* ```text fn pinned_client_cert_ocsp_locations(&self , PinnedClientCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA. Set this property before calling the certificate manager's [generate](#CertificateManager_m_Generate) method to propagate it to the new certificate. The OCSP locations are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator. 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-webdavserver-struct) property. This property is read-only. ## Data Type String # pinned_client_cert_ocsp_no_check property ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Accessor to the value of the certificate's ocsp-no-check extension. ## Syntax *Rust Syntax* ```text fn pinned_client_cert_ocsp_no_check(&self , PinnedClientCertIndex : i32) -> Result ``` ## Default Value false ## Remarks Accessor to the value of the certificate's ocsp-no-check 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-webdavserver-struct) property. This property is read-only. ## Data Type bool # pinned_client_cert_origin property ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Returns the location that the certificate was taken or loaded from. ## Syntax *Rust Syntax* ```text fn pinned_client_cert_origin(&self , PinnedClientCertIndex : i32) -> Result ``` ## Default Value 0 ## Remarks Returns the location that the certificate was taken or loaded from. 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-webdavserver-struct) property. This property is read-only. ## Data Type i32 # pinned_client_cert_policy_i_ds property ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Contains identifiers (OIDs) of the applicable certificate policies. ## Syntax *Rust Syntax* ```text fn pinned_client_cert_policy_i_ds(&self , PinnedClientCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks Contains identifiers (OIDs) of the applicable certificate policies. The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage. Set this property when generating a certificate to propagate the policies information to the new certificate. The policies are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the policy element separator. 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-webdavserver-struct) property. This property is read-only. ## Data Type String # pinned_client_cert_private_key_bytes property ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Returns the certificate's private key in DER-encoded format. ## Syntax *Rust Syntax* ```text fn pinned_client_cert_private_key_bytes(&self , PinnedClientCertIndex : i32) -> Result, SecureBlackboxError> ``` ## Remarks Returns the certificate's private key in DER-encoded format. It is normal for this property to be empty if the private key is non-exportable, which, for example, is typical for certificates originating from hardware security devices. 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-webdavserver-struct) property. This property is read-only. ## Data Type Vec # pinned_client_cert_private_key_exists property ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Indicates whether the certificate has a usable private key associated with it. ## Syntax *Rust Syntax* ```text fn pinned_client_cert_private_key_exists(&self , PinnedClientCertIndex : i32) -> Result ``` ## Default Value false ## Remarks Indicates whether the certificate has a usable private key associated with it. If it is set to *True*, the certificate can be used for private key operations, such as signing or decryption. This property is independent from [pinned_client_cert_private_key_bytes](#pinned_client_cert_private_key_bytes-property-webdavserver-struct), and can be set to *True* even if the former is empty. This would imply that the private key is non-exportable, but still can be used for cryptographic operations. 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-webdavserver-struct) property. This property is read-only. ## Data Type bool # pinned_client_cert_private_key_extractable property ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Indicates whether the private key is extractable (exportable). ## Syntax *Rust Syntax* ```text fn pinned_client_cert_private_key_extractable(&self , PinnedClientCertIndex : i32) -> Result ``` ## Default Value false ## Remarks Indicates whether the private key is extractable (exportable). 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-webdavserver-struct) property. This property is read-only. ## Data Type bool # pinned_client_cert_public_key_bytes property ([WebDAVServer](#struct-secureblackboxwebdavserver) 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-webdavserver-struct) property. This property is read-only. ## Data Type Vec # pinned_client_cert_qualified property ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Indicates whether the certificate is qualified. ## Syntax *Rust Syntax* ```text fn pinned_client_cert_qualified(&self , PinnedClientCertIndex : i32) -> Result ``` ## Default Value false ## Remarks Indicates whether the certificate is qualified. This property is set to *True* if the certificate is confirmed by a Trusted List to be qualified. 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-webdavserver-struct) property. This property is read-only. ## Data Type bool # pinned_client_cert_qualified_statements property ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Returns a simplified qualified status of the certificate. ## Syntax *Rust Syntax* ```text fn pinned_client_cert_qualified_statements(&self , PinnedClientCertIndex : i32) -> Result ``` ## Possible Values ```text 0 // NonQualified1 // QualifiedHardware2 // QualifiedSoftware ``` ## Default Value 0 ## Remarks Returns a simplified qualified status of 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-webdavserver-struct) property. This property is read-only. ## Data Type i32 # pinned_client_cert_qualifiers property ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) A list of qualifiers. ## Syntax *Rust Syntax* ```text fn pinned_client_cert_qualifiers(&self , PinnedClientCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks A list of qualifiers. Contains a comma-separated list of qualifier aliases for the certificate, for example *QCP-n-qscd,QCWithSSCD*. 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-webdavserver-struct) property. This property is read-only. ## Data Type String # pinned_client_cert_self_signed property ([WebDAVServer](#struct-secureblackboxwebdavserver) 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-webdavserver-struct) property. This property is read-only. ## Data Type bool # pinned_client_cert_serial_number property ([WebDAVServer](#struct-secureblackboxwebdavserver) 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-webdavserver-struct) property. This property is read-only. ## Data Type Vec # pinned_client_cert_sig_algorithm property ([WebDAVServer](#struct-secureblackboxwebdavserver) 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-webdavserver-struct) property. This property is read-only. ## Data Type String # pinned_client_cert_source property ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response. ## Syntax *Rust Syntax* ```text fn pinned_client_cert_source(&self , PinnedClientCertIndex : i32) -> Result ``` ## Possible Values ```text 0 // Unknown1 // Signature2 // Document3 // User4 // Local5 // Online ``` ## Default Value 0 ## Remarks Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response. 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-webdavserver-struct) property. This property is read-only. ## Data Type i32 # pinned_client_cert_subject property ([WebDAVServer](#struct-secureblackboxwebdavserver) 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-webdavserver-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-webdavserver-struct) property. This property is read-only. ## Data Type String # pinned_client_cert_subject_alternative_name property ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Returns or sets the value of the Subject Alternative Name extension of the certificate. ## Syntax *Rust Syntax* ```text fn pinned_client_cert_subject_alternative_name(&self , PinnedClientCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks Returns or sets the value of the Subject Alternative Name extension of the certificate. Subject alternative names are used to provide additional names that are impractical to store in the main [pinned_client_cert_subject_rdn](#pinned_client_cert_subject_rdn-property-webdavserver-struct) field. For example, it is often used to store all the domain names that a TLS certificate is authorized to protect. The alternative names are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the element separator. 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-webdavserver-struct) property. This property is read-only. ## Data Type String # pinned_client_cert_subject_key_id property ([WebDAVServer](#struct-secureblackboxwebdavserver) 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-webdavserver-struct) and [pinned_client_cert_ca_key_id](#pinned_client_cert_ca_key_id-property-webdavserver-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-webdavserver-struct) property. This property is read-only. ## Data Type Vec # pinned_client_cert_subject_rdn property ([WebDAVServer](#struct-secureblackboxwebdavserver) 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-webdavserver-struct) property. This property is read-only. ## Data Type String # pinned_client_cert_valid property ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request. ## Syntax *Rust Syntax* ```text fn pinned_client_cert_valid(&self , PinnedClientCertIndex : i32) -> Result ``` ## Default Value false ## Remarks Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request. 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-webdavserver-struct) property. This property is read-only. ## Data Type bool # pinned_client_cert_valid_from property ([WebDAVServer](#struct-secureblackboxwebdavserver) 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-webdavserver-struct) property. This property is read-only. ## Data Type String # pinned_client_cert_valid_to property ([WebDAVServer](#struct-secureblackboxwebdavserver) 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-webdavserver-struct) property. This property is read-only. ## Data Type String # port property ([WebDAVServer](#struct-secureblackboxwebdavserver) 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-webdavserver-struct) and [port_range_to](#port_range_to-property-webdavserver-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-webdavserver-struct). ## Data Type i32 # port_range_from property ([WebDAVServer](#struct-secureblackboxwebdavserver) 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-webdavserver-struct)), the port will be allocated within the requested range by the operating system, and reported in [bound_port](#bound_port-property-webdavserver-struct). ## Data Type i32 # port_range_to property ([WebDAVServer](#struct-secureblackboxwebdavserver) 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-webdavserver-struct)), the port will be allocated within the requested range by the operating system, and reported in [bound_port](#bound_port-property-webdavserver-struct). ## Data Type i32 # socket_incoming_speed_limit property ([WebDAVServer](#struct-secureblackboxwebdavserver) 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 ([WebDAVServer](#struct-secureblackboxwebdavserver) 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 ([WebDAVServer](#struct-secureblackboxwebdavserver) 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 ([WebDAVServer](#struct-secureblackboxwebdavserver) 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 ([WebDAVServer](#struct-secureblackboxwebdavserver) 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 ([WebDAVServer](#struct-secureblackboxwebdavserver) 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 # tls_server_cert_count property ([WebDAVServer](#struct-secureblackboxwebdavserver) 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-webdavserver-struct) - [tls_server_cert_handle](#tls_server_cert_handle-property-webdavserver-struct) The array indices start at *0* and end at *tls_server_cert_count - 1*. ## Data Type i32 # tls_server_cert_bytes property ([WebDAVServer](#struct-secureblackboxwebdavserver) 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-webdavserver-struct) property. This property is read-only. ## Data Type Vec # tls_server_cert_handle property ([WebDAVServer](#struct-secureblackboxwebdavserver) 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-webdavserver-struct) property. ## Data Type i64 # tls_auto_validate_certificates property ([WebDAVServer](#struct-secureblackboxwebdavserver) 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 ([WebDAVServer](#struct-secureblackboxwebdavserver) 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 ([WebDAVServer](#struct-secureblackboxwebdavserver) 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-webdavserver-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 ([WebDAVServer](#struct-secureblackboxwebdavserver) 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 ([WebDAVServer](#struct-secureblackboxwebdavserver) 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 ([WebDAVServer](#struct-secureblackboxwebdavserver) 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 ([WebDAVServer](#struct-secureblackboxwebdavserver) 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 ([WebDAVServer](#struct-secureblackboxwebdavserver) 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 ([WebDAVServer](#struct-secureblackboxwebdavserver) 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 ([WebDAVServer](#struct-secureblackboxwebdavserver) 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 ([WebDAVServer](#struct-secureblackboxwebdavserver) 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 ([WebDAVServer](#struct-secureblackboxwebdavserver) 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 ([WebDAVServer](#struct-secureblackboxwebdavserver) 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 ([WebDAVServer](#struct-secureblackboxwebdavserver) 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 ([WebDAVServer](#struct-secureblackboxwebdavserver) 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 ([WebDAVServer](#struct-secureblackboxwebdavserver) 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 ([WebDAVServer](#struct-secureblackboxwebdavserver) 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 ([WebDAVServer](#struct-secureblackboxwebdavserver) 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-webdavserver-struct) - [user_base_path](#user_base_path-property-webdavserver-struct) - [user_certificate](#user_certificate-property-webdavserver-struct) - [user_data](#user_data-property-webdavserver-struct) - [user_email](#user_email-property-webdavserver-struct) - [user_handle](#user_handle-property-webdavserver-struct) - [user_hash_algorithm](#user_hash_algorithm-property-webdavserver-struct) - [user_incoming_speed_limit](#user_incoming_speed_limit-property-webdavserver-struct) - [username](#username-property-webdavserver-struct) - [user_otp_algorithm](#user_otp_algorithm-property-webdavserver-struct) - [user_otp_len](#user_otp_len-property-webdavserver-struct) - [user_otp_value](#user_otp_value-property-webdavserver-struct) - [user_outgoing_speed_limit](#user_outgoing_speed_limit-property-webdavserver-struct) - [user_password](#user_password-property-webdavserver-struct) - [user_shared_secret](#user_shared_secret-property-webdavserver-struct) - [user_ssh_key](#user_ssh_key-property-webdavserver-struct) The array indices start at *0* and end at *user_count - 1*. ## Data Type i32 # user_associated_data property ([WebDAVServer](#struct-secureblackboxwebdavserver) 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-webdavserver-struct) property. ## Data Type Vec # user_base_path property ([WebDAVServer](#struct-secureblackboxwebdavserver) 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-webdavserver-struct) property. ## Data Type String # user_certificate property ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Contains the user's certificate. ## Syntax *Rust Syntax* ```text fn user_certificate(&self , UserIndex : i32) -> Result, SecureBlackboxError> fn set_user_certificate(&self, UserIndex : i32, value : Vec) -> Option fn set_user_certificate_ref(&self, UserIndex : i32, value : &[u8]) -> Option ``` ## Remarks Contains the user's certificate. 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-webdavserver-struct) property. ## Data Type Vec # user_data property ([WebDAVServer](#struct-secureblackboxwebdavserver) 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-webdavserver-struct) property. ## Data Type String # user_email property ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) The user's email address. ## Syntax *Rust Syntax* ```text fn user_email(&self , UserIndex : i32) -> Result fn set_user_email(&self, UserIndex : i32, value : &str) -> Option fn set_user_email_ref(&self, UserIndex : i32, value : &String) -> Option ``` ## Default Value "" ## Remarks The user's email address. 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-webdavserver-struct) property. ## Data Type String # user_handle property ([WebDAVServer](#struct-secureblackboxwebdavserver) 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-webdavserver-struct) property. ## Data Type i64 # user_hash_algorithm property ([WebDAVServer](#struct-secureblackboxwebdavserver) 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-webdavserver-struct) property. ## Data Type String # user_incoming_speed_limit property ([WebDAVServer](#struct-secureblackboxwebdavserver) 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-webdavserver-struct) property. ## Data Type i32 # user_otp_algorithm property ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) The algorithm used to generate one-time passwords (OTP) for this user, either HOTP (Hash-based OTP) or TOTP (Time-based OTP). ## Syntax *Rust Syntax* ```text fn user_otp_algorithm(&self , UserIndex : i32) -> Result fn set_user_otp_algorithm(&self, UserIndex : i32, value : i32) -> Option ``` ## Possible Values ```text 0 // None1 // Hmac2 // Time ``` ## Default Value 0 ## Remarks The algorithm used to generate one-time passwords (OTP) for this user, either HOTP (Hash-based OTP) or TOTP (Time-based OTP). In the former case, a value of a dedicated counter is used to generate a unique password, while in the latter the password is generated on the basis of the current time value. | | | | | --- | --- | --- | | oaHmac | 0 | | | oaTime | 1 | | 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-webdavserver-struct) property. ## Data Type i32 # user_otp_len property ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Specifies the length of the user's OTP password. ## Syntax *Rust Syntax* ```text fn user_otp_len(&self , UserIndex : i32) -> Result fn set_user_otp_len(&self, UserIndex : i32, value : i32) -> Option ``` ## Default Value 0 ## Remarks Specifies the length of the user's OTP 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-webdavserver-struct) property. ## Data Type i32 # user_otp_value property ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) The user's time interval (TOTP) or Counter (HOTP). ## Syntax *Rust Syntax* ```text fn user_otp_value(&self , UserIndex : i32) -> Result fn set_user_otp_value(&self, UserIndex : i32, value : i32) -> Option ``` ## Default Value 0 ## Remarks The user's time interval (TOTP) or Counter (HOTP). 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-webdavserver-struct) property. ## Data Type i32 # user_outgoing_speed_limit property ([WebDAVServer](#struct-secureblackboxwebdavserver) 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-webdavserver-struct) property. ## Data Type i32 # user_password property ([WebDAVServer](#struct-secureblackboxwebdavserver) 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-webdavserver-struct) property. ## Data Type String # user_shared_secret property ([WebDAVServer](#struct-secureblackboxwebdavserver) 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-webdavserver-struct) property. ## Data Type Vec # user_ssh_key property ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Contains the user's SSH key. ## Syntax *Rust Syntax* ```text fn user_ssh_key(&self , UserIndex : i32) -> Result, SecureBlackboxError> fn set_user_ssh_key(&self, UserIndex : i32, value : Vec) -> Option fn set_user_ssh_key_ref(&self, UserIndex : i32, value : &[u8]) -> Option ``` ## Remarks Contains the user's SSH key. 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-webdavserver-struct) property. ## Data Type Vec # username property ([WebDAVServer](#struct-secureblackboxwebdavserver) 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-webdavserver-struct) property. ## Data Type String # website_name property ([WebDAVServer](#struct-secureblackboxwebdavserver) 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 ([WebDAVServer](#struct-secureblackboxwebdavserver) 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 ([WebDAVServer](#struct-secureblackboxwebdavserver) 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-webdavserver-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-webdavserver-struct), you must call *Config("PROPERTY")*. The value will be returned as a string. # do_action method ([WebDAVServer](#struct-secureblackboxwebdavserver) 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 ([WebDAVServer](#struct-secureblackboxwebdavserver) 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. # get_client_buffer method ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Obtains a pending connection buffer. ## Syntax *Rust Syntax* ```text fn get_client_buffer(&self, connection_id : i64) -> Result, SecureBlackboxError> ``` ## Remarks Use this method to obtain a pending connection buffer from your on_write_file event handler. The connection buffer contains data that have been received from the client but has not been written to the file yet. # get_request_bytes method ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Returns the contents of the client's HTTP request. ## Syntax *Rust Syntax* ```text fn get_request_bytes(&self, connection_id : i64, request_filter : &str) -> Result, SecureBlackboxError> ``` ## Remarks Use this method to get the body of the client's HTTP request in your [on_custom_request](#on_custom_request-event-webdavserver-struct) event handler. Note that the body of GET and HEAD requests is empty. The method returns the requested content. The *RequestFilter* parameter allows you to select the element(s) that you would like to get. An empty request filter makes the whole body to be returned. The following request filters are currently supported: | | | | --- | --- | | params | Request query parameters only. | | params[Index] | A specific request parameter, by index. | | params['Name'] | A specific request parameter, by name. | | parts[Index] | The body of a particular part of a multipart message. | # get_request_header method ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Returns a request header value. ## Syntax *Rust Syntax* ```text fn get_request_header(&self, connection_id : i64, header_name : &str) -> Result ``` ## Remarks Use this method to get the value of a request header. A good place to call this method is a request-marking event, such as [on_before_lock_object](#on_before_lock_object-event-webdavserver-struct) or [on_custom_request](#on_custom_request-event-webdavserver-struct). # get_request_string method ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Returns the contents of the client's HTTP request. ## Syntax *Rust Syntax* ```text fn get_request_string(&self, connection_id : i64, request_filter : &str) -> Result ``` ## Remarks Use this method to get the body of the client's HTTP request to a string. Note that the body of GET and HEAD requests is empty. The *RequestFilter* parameter allows you to select the element(s) of the requests that you would like to get. An empty request filter makes the whole body to be returned. The following request filters are currently supported: | | | | --- | --- | | params | Request query parameters only. | | params[Index] | A specific request parameter, by index. | | params['Name'] | A specific request parameter, by name. | | parts[Index] | The body of a particular part of a multipart message. | # get_request_username method ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Returns the username for a connection. ## Syntax *Rust Syntax* ```text fn get_request_username(&self, connection_id : i64) -> Result ``` ## Remarks Use this method to obtain a username for an active connection. The method will return an empty string if no authentication has been performed on the connection. # get_response_header method ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Returns a response header value. ## Syntax *Rust Syntax* ```text fn get_response_header(&self, connection_id : i64, header_name : &str) -> Result ``` ## Remarks Use this method to get the value of a response header. A good place to call this method is [on_headers_prepared](#on_headers_prepared-event-webdavserver-struct) event. Call the method with empty *HeaderName* to get the whole response header. # list_clients method ([WebDAVServer](#struct-secureblackboxwebdavserver) 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 ([WebDAVServer](#struct-secureblackboxwebdavserver) 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. # process_generic_request method ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Processes a generic HTTP request. ## Syntax *Rust Syntax* ```text fn process_generic_request(&self, connection_id : i64, request_bytes : &[u8]) -> Result, SecureBlackboxError> ``` ## Remarks This method processes a generic HTTP request and produces a response. Use it to generate HTTP responses for requests obtained externally, out of the default HTTP channel. This method respects all current settings of the server object, and invokes the corresponding events to consult about the request and response details with the application. *ConnectionId* allows to identify the request in the events. The method returns the complete HTTP response including HTTP headers. # reset method ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Resets the struct settings. ## Syntax *Rust Syntax* ```text fn reset(&self) -> Result<(), SecureBlackboxError> ``` ## Remarks reset is a generic method available in every struct. # set_client_buffer method ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Commits a data buffer to the connection. ## Syntax *Rust Syntax* ```text fn set_client_buffer(&self, connection_id : i64, value : &[u8]) -> Result<(), SecureBlackboxError> ``` ## Remarks Use this method from your on_read_file event handler to commit a chunk of file data to the server component. # set_client_file_entry method ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Commits a file entry to the connection. ## Syntax *Rust Syntax* ```text fn set_client_file_entry(&self, connection_id : i64) -> Result<(), SecureBlackboxError> ``` ## Remarks Use this method to commit a file details entry provided in client_file_entry property to *ConnectionID* connection. This method is supposed to be used from a on_find_next event handler. Please note that events like on_find_next may be invoked concurrently for several connection threads. Please make sure you use a locking mechanism to avoid mixing up details in client_file_entry. # set_response_bytes method ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Sets a byte array to be served as a response. ## Syntax *Rust Syntax* ```text fn set_response_bytes(&self, connection_id : i64, bytes : &[u8], content_type : &str, response_filter : &str) -> Result<(), SecureBlackboxError> ``` ## Remarks Use this property to provide the response content in a byte array when serving custom requests in your [on_custom_request](#on_custom_request-event-webdavserver-struct) handler. The *ResponseFilter* parameter lets you select the element of the response that you would like to set with this call. The empty filter stands for the entire response body. The only response filter currently supported is *parts*: | | | | --- | --- | | parts[Index] | The body of a particular part of a multipart response. | # set_response_file method ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Sets a file to be served as a response. ## Syntax *Rust Syntax* ```text fn set_response_file(&self, connection_id : i64, file_name : &str, content_type : &str, response_filter : &str) -> Result<(), SecureBlackboxError> ``` ## Remarks Use this property to provide the response content in a file. The *ResponseFilter* parameter lets you select the element of the response that you would like to set with this call. The empty filter stands for the entire response body. The only response filter currently supported is *parts*: | | | | --- | --- | | parts[Index] | The body of a particular part of a multipart response. | # set_response_header method ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Sets a response header. ## Syntax *Rust Syntax* ```text fn set_response_header(&self, connection_id : i64, header_name : &str, value : &str) -> Result<(), SecureBlackboxError> ``` ## Remarks Use this method to set a response header. A good place to call this method is a request-marking event, such as [on_lock_object](#on_lock_object-event-webdavserver-struct) or [on_custom_request](#on_custom_request-event-webdavserver-struct). # set_response_status method ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Sets an HTTP status to be sent with the response. ## Syntax *Rust Syntax* ```text fn set_response_status(&self, connection_id : i64, status_code : i32) -> Result<(), SecureBlackboxError> ``` ## Remarks Use this method to set an HTTP status for the request. A good place to call this method is a request-marking event, such as [on_custom_request](#on_custom_request-event-webdavserver-struct). # set_response_string method ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Sets a string to be served as a response. ## Syntax *Rust Syntax* ```text fn set_response_string(&self, connection_id : i64, data_str : &str, content_type : &str, response_filter : &str) -> Result<(), SecureBlackboxError> ``` ## Remarks Use this property to provide the response content in a string. The *ResponseFilter* parameter lets you select the element of the response that you would like to set with this call. The empty filter stands for the entire response body. The only response filter currently supported is *parts*: | | | | --- | --- | | parts[Index] | The body of a particular part of a multipart response. | # start method ([WebDAVServer](#struct-secureblackboxwebdavserver) 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 ([WebDAVServer](#struct-secureblackboxwebdavserver) 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 ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Reports an incoming connection. ## Syntax *Rust Syntax* ```text // WebDAVServerAcceptEventArgs carries the WebDAVServer Accept event's parameters. pub struct WebDAVServerAcceptEventArgs { fn remote_address(&self) -> &String fn remote_port(&self) -> i32 fn accept(&self) -> bool fn set_accept(&self, value : bool) } // WebDAVServerAcceptEvent defines the signature of the WebDAVServer Accept event's handler function. pub trait WebDAVServerAcceptEvent { fn on_accept(&self, sender : WebDAVServer, e : &mut WebDAVServerAcceptEventArgs); } impl <'a> WebDAVServer<'a> { pub fn on_accept(&self) -> &'a dyn WebDAVServerAcceptEvent; pub fn set_on_accept(&mut self, value : &'a dyn WebDAVServerAcceptEvent); ... } ``` ## 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-webdavserver-struct) event to be notified of every connection that has been set up. # on_after_browse event ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) WebDAVServer uses this event to notify the application about the completion of the browsing operation. ## Syntax *Rust Syntax* ```text // WebDAVServerAfterBrowseEventArgs carries the WebDAVServer AfterBrowse event's parameters. pub struct WebDAVServerAfterBrowseEventArgs { fn connection_id(&self) -> i64 fn path(&self) -> &String fn operation_status(&self) -> i32 fn set_operation_status(&self, value : i32) } // WebDAVServerAfterBrowseEvent defines the signature of the WebDAVServer AfterBrowse event's handler function. pub trait WebDAVServerAfterBrowseEvent { fn on_after_browse(&self, sender : WebDAVServer, e : &mut WebDAVServerAfterBrowseEventArgs); } impl <'a> WebDAVServer<'a> { pub fn on_after_browse(&self) -> &'a dyn WebDAVServerAfterBrowseEvent; pub fn set_on_after_browse(&mut self, value : &'a dyn WebDAVServerAfterBrowseEvent); ... } ``` ## Remarks The *ConnectionID* parameter identifies the client connection, and the *Path* parameter specifies the browsing path. This event is typically fired after the [on_before_browse](#on_before_browse-event-webdavserver-struct) event. Check the operation status, and alter it, if needed, through the *OperationStatus* parameter: | | | | | --- | --- | --- | | ostOk | 1 | | | ostNoSuchFile | 2 | | | ostAccessDenied | 3 | | | ostWriteProtect | 4 | | | ostUnsupported | 5 | | | ostInvalidParameter | 6 | | | ostEOF | 7 | | # on_after_copy_object event ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) This event notifies the application about the completion of the copy operation. ## Syntax *Rust Syntax* ```text // WebDAVServerAfterCopyObjectEventArgs carries the WebDAVServer AfterCopyObject event's parameters. pub struct WebDAVServerAfterCopyObjectEventArgs { fn connection_id(&self) -> i64 fn old_path(&self) -> &String fn new_path(&self) -> &String fn operation_status(&self) -> i32 fn set_operation_status(&self, value : i32) } // WebDAVServerAfterCopyObjectEvent defines the signature of the WebDAVServer AfterCopyObject event's handler function. pub trait WebDAVServerAfterCopyObjectEvent { fn on_after_copy_object(&self, sender : WebDAVServer, e : &mut WebDAVServerAfterCopyObjectEventArgs); } impl <'a> WebDAVServer<'a> { pub fn on_after_copy_object(&self) -> &'a dyn WebDAVServerAfterCopyObjectEvent; pub fn set_on_after_copy_object(&mut self, value : &'a dyn WebDAVServerAfterCopyObjectEvent); ... } ``` ## Remarks AfterCopyObject is typically preceded by [on_before_copy_object](#on_before_copy_object-event-webdavserver-struct) and [on_copy_object](#on_copy_object-event-webdavserver-struct) events. The *OldPath* and *NewPath* parameters contain the origin and destination names of the copied object. Check the operation status, and alter it, if needed, through the *OperationStatus* parameter: | | | | | --- | --- | --- | | ostOk | 1 | | | ostNoSuchFile | 2 | | | ostAccessDenied | 3 | | | ostWriteProtect | 4 | | | ostUnsupported | 5 | | | ostInvalidParameter | 6 | | | ostEOF | 7 | | # on_after_create_calendar event ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) This event reports the completion of calendar creation request. ## Syntax *Rust Syntax* ```text // WebDAVServerAfterCreateCalendarEventArgs carries the WebDAVServer AfterCreateCalendar event's parameters. pub struct WebDAVServerAfterCreateCalendarEventArgs { fn connection_id(&self) -> i64 fn path(&self) -> &String fn operation_status(&self) -> i32 fn set_operation_status(&self, value : i32) } // WebDAVServerAfterCreateCalendarEvent defines the signature of the WebDAVServer AfterCreateCalendar event's handler function. pub trait WebDAVServerAfterCreateCalendarEvent { fn on_after_create_calendar(&self, sender : WebDAVServer, e : &mut WebDAVServerAfterCreateCalendarEventArgs); } impl <'a> WebDAVServer<'a> { pub fn on_after_create_calendar(&self) -> &'a dyn WebDAVServerAfterCreateCalendarEvent; pub fn set_on_after_create_calendar(&mut self, value : &'a dyn WebDAVServerAfterCreateCalendarEvent); ... } ``` ## Remarks Check the operation status, and alter it, if needed, through the *OperationStatus* parameter: | | | | | --- | --- | --- | | ostOk | 1 | | | ostNoSuchFile | 2 | | | ostAccessDenied | 3 | | | ostWriteProtect | 4 | | | ostUnsupported | 5 | | | ostInvalidParameter | 6 | | | ostEOF | 7 | | # on_after_create_collection event ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) WebDAVServer uses this event to report completion of the collection creation operation. ## Syntax *Rust Syntax* ```text // WebDAVServerAfterCreateCollectionEventArgs carries the WebDAVServer AfterCreateCollection event's parameters. pub struct WebDAVServerAfterCreateCollectionEventArgs { fn connection_id(&self) -> i64 fn path(&self) -> &String fn operation_status(&self) -> i32 fn set_operation_status(&self, value : i32) } // WebDAVServerAfterCreateCollectionEvent defines the signature of the WebDAVServer AfterCreateCollection event's handler function. pub trait WebDAVServerAfterCreateCollectionEvent { fn on_after_create_collection(&self, sender : WebDAVServer, e : &mut WebDAVServerAfterCreateCollectionEventArgs); } impl <'a> WebDAVServer<'a> { pub fn on_after_create_collection(&self) -> &'a dyn WebDAVServerAfterCreateCollectionEvent; pub fn set_on_after_create_collection(&mut self, value : &'a dyn WebDAVServerAfterCreateCollectionEvent); ... } ``` ## Remarks This event is preceded by [on_before_create_collection](#on_before_create_collection-event-webdavserver-struct) and [on_create_collection](#on_create_collection-event-webdavserver-struct) events. It lets you alter the operation status passed back to the client. Check the operation status, and alter it, if needed, through the *OperationStatus* parameter: | | | | | --- | --- | --- | | ostOk | 1 | | | ostNoSuchFile | 2 | | | ostAccessDenied | 3 | | | ostWriteProtect | 4 | | | ostUnsupported | 5 | | | ostInvalidParameter | 6 | | | ostEOF | 7 | | # on_after_custom_request event ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) This event reports the completion of the custom request. ## Syntax *Rust Syntax* ```text // WebDAVServerAfterCustomRequestEventArgs carries the WebDAVServer AfterCustomRequest event's parameters. pub struct WebDAVServerAfterCustomRequestEventArgs { fn connection_id(&self) -> i64 fn request_method(&self) -> &String fn path(&self) -> &String fn operation_status(&self) -> i32 fn set_operation_status(&self, value : i32) } // WebDAVServerAfterCustomRequestEvent defines the signature of the WebDAVServer AfterCustomRequest event's handler function. pub trait WebDAVServerAfterCustomRequestEvent { fn on_after_custom_request(&self, sender : WebDAVServer, e : &mut WebDAVServerAfterCustomRequestEventArgs); } impl <'a> WebDAVServer<'a> { pub fn on_after_custom_request(&self) -> &'a dyn WebDAVServerAfterCustomRequestEvent; pub fn set_on_after_custom_request(&mut self, value : &'a dyn WebDAVServerAfterCustomRequestEvent); ... } ``` ## Remarks Use this event to track the completion of an earlier reported custom request and adjust the operation status through the *OperationStatus* parameter as required. | | | | | --- | --- | --- | | ostOk | 1 | | | ostNoSuchFile | 2 | | | ostAccessDenied | 3 | | | ostWriteProtect | 4 | | | ostUnsupported | 5 | | | ostInvalidParameter | 6 | | | ostEOF | 7 | | # on_after_lock_object event ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Reports the completion of the object locking operation. ## Syntax *Rust Syntax* ```text // WebDAVServerAfterLockObjectEventArgs carries the WebDAVServer AfterLockObject event's parameters. pub struct WebDAVServerAfterLockObjectEventArgs { fn connection_id(&self) -> i64 fn path(&self) -> &String fn operation_status(&self) -> i32 fn set_operation_status(&self, value : i32) } // WebDAVServerAfterLockObjectEvent defines the signature of the WebDAVServer AfterLockObject event's handler function. pub trait WebDAVServerAfterLockObjectEvent { fn on_after_lock_object(&self, sender : WebDAVServer, e : &mut WebDAVServerAfterLockObjectEventArgs); } impl <'a> WebDAVServer<'a> { pub fn on_after_lock_object(&self) -> &'a dyn WebDAVServerAfterLockObjectEvent; pub fn set_on_after_lock_object(&mut self, value : &'a dyn WebDAVServerAfterLockObjectEvent); ... } ``` ## Remarks Check the operation status, and alter it, if needed, through the *OperationStatus* parameter: | | | | | --- | --- | --- | | ostOk | 1 | | | ostNoSuchFile | 2 | | | ostAccessDenied | 3 | | | ostWriteProtect | 4 | | | ostUnsupported | 5 | | | ostInvalidParameter | 6 | | | ostEOF | 7 | | # on_after_refresh_lock event ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Reports the completion of the lock refresh operation. ## Syntax *Rust Syntax* ```text // WebDAVServerAfterRefreshLockEventArgs carries the WebDAVServer AfterRefreshLock event's parameters. pub struct WebDAVServerAfterRefreshLockEventArgs { fn connection_id(&self) -> i64 fn path(&self) -> &String fn operation_status(&self) -> i32 fn set_operation_status(&self, value : i32) } // WebDAVServerAfterRefreshLockEvent defines the signature of the WebDAVServer AfterRefreshLock event's handler function. pub trait WebDAVServerAfterRefreshLockEvent { fn on_after_refresh_lock(&self, sender : WebDAVServer, e : &mut WebDAVServerAfterRefreshLockEventArgs); } impl <'a> WebDAVServer<'a> { pub fn on_after_refresh_lock(&self) -> &'a dyn WebDAVServerAfterRefreshLockEvent; pub fn set_on_after_refresh_lock(&mut self, value : &'a dyn WebDAVServerAfterRefreshLockEvent); ... } ``` ## Remarks Check the operation status, and alter it, if needed, through the *OperationStatus* parameter: | | | | | --- | --- | --- | | ostOk | 1 | | | ostNoSuchFile | 2 | | | ostAccessDenied | 3 | | | ostWriteProtect | 4 | | | ostUnsupported | 5 | | | ostInvalidParameter | 6 | | | ostEOF | 7 | | # on_after_remove_object event ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) This event notifies the application about the completion of object deletion operation. ## Syntax *Rust Syntax* ```text // WebDAVServerAfterRemoveObjectEventArgs carries the WebDAVServer AfterRemoveObject event's parameters. pub struct WebDAVServerAfterRemoveObjectEventArgs { fn connection_id(&self) -> i64 fn path(&self) -> &String fn operation_status(&self) -> i32 fn set_operation_status(&self, value : i32) } // WebDAVServerAfterRemoveObjectEvent defines the signature of the WebDAVServer AfterRemoveObject event's handler function. pub trait WebDAVServerAfterRemoveObjectEvent { fn on_after_remove_object(&self, sender : WebDAVServer, e : &mut WebDAVServerAfterRemoveObjectEventArgs); } impl <'a> WebDAVServer<'a> { pub fn on_after_remove_object(&self) -> &'a dyn WebDAVServerAfterRemoveObjectEvent; pub fn set_on_after_remove_object(&mut self, value : &'a dyn WebDAVServerAfterRemoveObjectEvent); ... } ``` ## Remarks This event follows [on_before_remove_object](#on_before_remove_object-event-webdavserver-struct) and [on_remove_object](#on_remove_object-event-webdavserver-struct) events. It is fired upon completion of the operation and lets you adjust the operation status if required: | | | | | --- | --- | --- | | ostOk | 1 | | | ostNoSuchFile | 2 | | | ostAccessDenied | 3 | | | ostWriteProtect | 4 | | | ostUnsupported | 5 | | | ostInvalidParameter | 6 | | | ostEOF | 7 | | # on_after_rename_object event ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) The struct uses this event to notify the application about the completion of the object rename operation. ## Syntax *Rust Syntax* ```text // WebDAVServerAfterRenameObjectEventArgs carries the WebDAVServer AfterRenameObject event's parameters. pub struct WebDAVServerAfterRenameObjectEventArgs { fn connection_id(&self) -> i64 fn old_path(&self) -> &String fn new_path(&self) -> &String fn operation_status(&self) -> i32 fn set_operation_status(&self, value : i32) } // WebDAVServerAfterRenameObjectEvent defines the signature of the WebDAVServer AfterRenameObject event's handler function. pub trait WebDAVServerAfterRenameObjectEvent { fn on_after_rename_object(&self, sender : WebDAVServer, e : &mut WebDAVServerAfterRenameObjectEventArgs); } impl <'a> WebDAVServer<'a> { pub fn on_after_rename_object(&self) -> &'a dyn WebDAVServerAfterRenameObjectEvent; pub fn set_on_after_rename_object(&mut self, value : &'a dyn WebDAVServerAfterRenameObjectEvent); ... } ``` ## Remarks The *OldPath* and *NewPath* provide the old and new path of the renamed object respectively. Check the operation status, and alter it, if needed, through the *OperationStatus* parameter: | | | | | --- | --- | --- | | ostOk | 1 | | | ostNoSuchFile | 2 | | | ostAccessDenied | 3 | | | ostWriteProtect | 4 | | | ostUnsupported | 5 | | | ostInvalidParameter | 6 | | | ostEOF | 7 | | # on_after_set_attributes event ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) WebDAVServer fires this event to notify the application of the completion of the attribute assignment operation. ## Syntax *Rust Syntax* ```text // WebDAVServerAfterSetAttributesEventArgs carries the WebDAVServer AfterSetAttributes event's parameters. pub struct WebDAVServerAfterSetAttributesEventArgs { fn connection_id(&self) -> i64 fn path(&self) -> &String fn operation_status(&self) -> i32 fn set_operation_status(&self, value : i32) } // WebDAVServerAfterSetAttributesEvent defines the signature of the WebDAVServer AfterSetAttributes event's handler function. pub trait WebDAVServerAfterSetAttributesEvent { fn on_after_set_attributes(&self, sender : WebDAVServer, e : &mut WebDAVServerAfterSetAttributesEventArgs); } impl <'a> WebDAVServer<'a> { pub fn on_after_set_attributes(&self) -> &'a dyn WebDAVServerAfterSetAttributesEvent; pub fn set_on_after_set_attributes(&mut self, value : &'a dyn WebDAVServerAfterSetAttributesEvent); ... } ``` ## Remarks Check the operation status, and alter it, if needed, through the *OperationStatus* parameter: | | | | | --- | --- | --- | | ostOk | 1 | | | ostNoSuchFile | 2 | | | ostAccessDenied | 3 | | | ostWriteProtect | 4 | | | ostUnsupported | 5 | | | ostInvalidParameter | 6 | | | ostEOF | 7 | | # on_after_unlock_object event ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Notifies the application about the completion of the object unlocking operation. ## Syntax *Rust Syntax* ```text // WebDAVServerAfterUnlockObjectEventArgs carries the WebDAVServer AfterUnlockObject event's parameters. pub struct WebDAVServerAfterUnlockObjectEventArgs { fn connection_id(&self) -> i64 fn path(&self) -> &String fn operation_status(&self) -> i32 fn set_operation_status(&self, value : i32) } // WebDAVServerAfterUnlockObjectEvent defines the signature of the WebDAVServer AfterUnlockObject event's handler function. pub trait WebDAVServerAfterUnlockObjectEvent { fn on_after_unlock_object(&self, sender : WebDAVServer, e : &mut WebDAVServerAfterUnlockObjectEventArgs); } impl <'a> WebDAVServer<'a> { pub fn on_after_unlock_object(&self) -> &'a dyn WebDAVServerAfterUnlockObjectEvent; pub fn set_on_after_unlock_object(&mut self, value : &'a dyn WebDAVServerAfterUnlockObjectEvent); ... } ``` ## Remarks Check the operation status, and alter it, if needed, through the *OperationStatus* parameter: | | | | | --- | --- | --- | | ostOk | 1 | | | ostNoSuchFile | 2 | | | ostAccessDenied | 3 | | | ostWriteProtect | 4 | | | ostUnsupported | 5 | | | ostInvalidParameter | 6 | | | ostEOF | 7 | | # on_auth_attempt event ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Fires when a connected client makes an authentication attempt. ## Syntax *Rust Syntax* ```text // WebDAVServerAuthAttemptEventArgs carries the WebDAVServer AuthAttempt event's parameters. pub struct WebDAVServerAuthAttemptEventArgs { 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) } // WebDAVServerAuthAttemptEvent defines the signature of the WebDAVServer AuthAttempt event's handler function. pub trait WebDAVServerAuthAttemptEvent { fn on_auth_attempt(&self, sender : WebDAVServer, e : &mut WebDAVServerAuthAttemptEventArgs); } impl <'a> WebDAVServer<'a> { pub fn on_auth_attempt(&self) -> &'a dyn WebDAVServerAuthAttemptEvent; pub fn set_on_auth_attempt(&mut self, value : &'a dyn WebDAVServerAuthAttemptEvent); ... } ``` ## 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_before_browse event ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Fires when a Browse request is received. ## Syntax *Rust Syntax* ```text // WebDAVServerBeforeBrowseEventArgs carries the WebDAVServer BeforeBrowse event's parameters. pub struct WebDAVServerBeforeBrowseEventArgs { fn connection_id(&self) -> i64 fn path(&self) -> &String fn action(&self) -> i32 fn set_action(&self, value : i32) } // WebDAVServerBeforeBrowseEvent defines the signature of the WebDAVServer BeforeBrowse event's handler function. pub trait WebDAVServerBeforeBrowseEvent { fn on_before_browse(&self, sender : WebDAVServer, e : &mut WebDAVServerBeforeBrowseEventArgs); } impl <'a> WebDAVServer<'a> { pub fn on_before_browse(&self) -> &'a dyn WebDAVServerBeforeBrowseEvent; pub fn set_on_before_browse(&mut self, value : &'a dyn WebDAVServerBeforeBrowseEvent); ... } ``` ## Remarks The struct uses this event to notify the application that a Browse request has been received from the client. The *Path* parameter contains the path parameter from the request. *ConnectionID* identifies the connected client. Set *Action* to [fraAuto](constants.md#const_fraAuto) to let the server handle the request automatically, or to fraCustom to handle the request in your code. Choose *Action* as one of the following values: | | | | | --- | --- | --- | | fraAuto | 1 | Handle the requested action automatically by the server | | fraCustom | 2 | Override the action using the user code logic | | fraAbort | 3 | Abort the requested action | If *fraCustom* Action is chosen, this event will be followed by a series of events that request the details of the object residing at *Path*: [on_list_attributes](#on_list_attributes-event-webdavserver-struct), [on_list_sub_objects](#on_list_sub_objects-event-webdavserver-struct), and [on_read_attribute](#on_read_attribute-event-webdavserver-struct). # on_before_copy_object event ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Fires when a Copy Object request is received. ## Syntax *Rust Syntax* ```text // WebDAVServerBeforeCopyObjectEventArgs carries the WebDAVServer BeforeCopyObject event's parameters. pub struct WebDAVServerBeforeCopyObjectEventArgs { fn connection_id(&self) -> i64 fn old_path(&self) -> &String fn new_path(&self) -> &String fn action(&self) -> i32 fn set_action(&self, value : i32) } // WebDAVServerBeforeCopyObjectEvent defines the signature of the WebDAVServer BeforeCopyObject event's handler function. pub trait WebDAVServerBeforeCopyObjectEvent { fn on_before_copy_object(&self, sender : WebDAVServer, e : &mut WebDAVServerBeforeCopyObjectEventArgs); } impl <'a> WebDAVServer<'a> { pub fn on_before_copy_object(&self) -> &'a dyn WebDAVServerBeforeCopyObjectEvent; pub fn set_on_before_copy_object(&mut self, value : &'a dyn WebDAVServerBeforeCopyObjectEvent); ... } ``` ## Remarks The struct fires this event to notify the application that a Copy Object request was received. The *OldPath* and *NewPath* parameters specify the source and destination paths for the object to be copied. *ConnectionID* identifies the connected client. Set *Action* to [fraAuto](constants.md#const_fraAuto) to let the server handle the request automatically, or to fraCustom to handle the request in your code. Choose *Action* as one of the following values: | | | | | --- | --- | --- | | fraAuto | 1 | Handle the requested action automatically by the server | | fraCustom | 2 | Override the action using the user code logic | | fraAbort | 3 | Abort the requested action | If *fraCustom* Action is chosen, this event will be followed by a [on_copy_object](#on_copy_object-event-webdavserver-struct) call, allowing you to virtualize the copy operation. # on_before_create_calendar event ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Fires when a Create Calendar request is received from a client. ## Syntax *Rust Syntax* ```text // WebDAVServerBeforeCreateCalendarEventArgs carries the WebDAVServer BeforeCreateCalendar event's parameters. pub struct WebDAVServerBeforeCreateCalendarEventArgs { fn connection_id(&self) -> i64 fn path(&self) -> &String fn action(&self) -> i32 fn set_action(&self, value : i32) } // WebDAVServerBeforeCreateCalendarEvent defines the signature of the WebDAVServer BeforeCreateCalendar event's handler function. pub trait WebDAVServerBeforeCreateCalendarEvent { fn on_before_create_calendar(&self, sender : WebDAVServer, e : &mut WebDAVServerBeforeCreateCalendarEventArgs); } impl <'a> WebDAVServer<'a> { pub fn on_before_create_calendar(&self) -> &'a dyn WebDAVServerBeforeCreateCalendarEvent; pub fn set_on_before_create_calendar(&mut self, value : &'a dyn WebDAVServerBeforeCreateCalendarEvent); ... } ``` ## Remarks The struct fires this event to notify the application about a received Create Calendar request. The *Path* parameter specifies the location of the new calendar. *ConnectionID* identifies the connected client. Set *Action* to [fraAuto](constants.md#const_fraAuto) to let the server handle the request automatically, or to fraCustom to handle the request in your code. Choose *Action* as one of the following values: | | | | | --- | --- | --- | | fraAuto | 1 | Handle the requested action automatically by the server | | fraCustom | 2 | Override the action using the user code logic | | fraAbort | 3 | Abort the requested action | If *fraCustom* Action is chosen, this event will be followed by a [on_create_calendar](#on_create_calendar-event-webdavserver-struct) call, allowing you to virtualize the calendar creation operation. # on_before_create_collection event ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Fires when a Create Collection request is received from a client. ## Syntax *Rust Syntax* ```text // WebDAVServerBeforeCreateCollectionEventArgs carries the WebDAVServer BeforeCreateCollection event's parameters. pub struct WebDAVServerBeforeCreateCollectionEventArgs { fn connection_id(&self) -> i64 fn path(&self) -> &String fn action(&self) -> i32 fn set_action(&self, value : i32) } // WebDAVServerBeforeCreateCollectionEvent defines the signature of the WebDAVServer BeforeCreateCollection event's handler function. pub trait WebDAVServerBeforeCreateCollectionEvent { fn on_before_create_collection(&self, sender : WebDAVServer, e : &mut WebDAVServerBeforeCreateCollectionEventArgs); } impl <'a> WebDAVServer<'a> { pub fn on_before_create_collection(&self) -> &'a dyn WebDAVServerBeforeCreateCollectionEvent; pub fn set_on_before_create_collection(&mut self, value : &'a dyn WebDAVServerBeforeCreateCollectionEvent); ... } ``` ## Remarks The struct uses this event to notify the application about an incoming collection creation request. The *Path* parameter advises on the location of the new collection. *ConnectionID* identifies the connected client. Set *Action* to [fraAuto](constants.md#const_fraAuto) to let the server handle the request automatically, or to fraCustom to handle the request in your code. Choose *Action* as one of the following values: | | | | | --- | --- | --- | | fraAuto | 1 | Handle the requested action automatically by the server | | fraCustom | 2 | Override the action using the user code logic | | fraAbort | 3 | Abort the requested action | If *fraCustom* Action is chosen, this event will be followed by a [on_create_collection](#on_create_collection-event-webdavserver-struct) call. # on_before_custom_request event ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Notifies the application about an incoming custom request. ## Syntax *Rust Syntax* ```text // WebDAVServerBeforeCustomRequestEventArgs carries the WebDAVServer BeforeCustomRequest event's parameters. pub struct WebDAVServerBeforeCustomRequestEventArgs { fn connection_id(&self) -> i64 fn request_method(&self) -> &String fn path(&self) -> &String fn action(&self) -> i32 fn set_action(&self, value : i32) } // WebDAVServerBeforeCustomRequestEvent defines the signature of the WebDAVServer BeforeCustomRequest event's handler function. pub trait WebDAVServerBeforeCustomRequestEvent { fn on_before_custom_request(&self, sender : WebDAVServer, e : &mut WebDAVServerBeforeCustomRequestEventArgs); } impl <'a> WebDAVServer<'a> { pub fn on_before_custom_request(&self) -> &'a dyn WebDAVServerBeforeCustomRequestEvent; pub fn set_on_before_custom_request(&mut self, value : &'a dyn WebDAVServerBeforeCustomRequestEvent); ... } ``` ## Remarks The struct uses this event to notify the user code about an incoming custom request (a generic request, unknown to the server, and not covered by the other handlers). The *RequestMethod* parameter specifies the HTTP request method used (GET, POST, PUT, ...), and *Path* indicates the requested path. *ConnectionID* identifies the connected client. Set *Action* to [fraAuto](constants.md#const_fraAuto) to let the server handle the request automatically, or to fraCustom to handle the request in your code. Choose *Action* as one of the following values: | | | | | --- | --- | --- | | fraAuto | 1 | Handle the requested action automatically by the server | | fraCustom | 2 | Override the action using the user code logic | | fraAbort | 3 | Abort the requested action | If *fraCustom* Action is chosen, this event will be followed by a [on_custom_request](#on_custom_request-event-webdavserver-struct) call, allowing you to respond to the request. # on_before_download_object event ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Fires when an object download request is received. ## Syntax *Rust Syntax* ```text // WebDAVServerBeforeDownloadObjectEventArgs carries the WebDAVServer BeforeDownloadObject event's parameters. pub struct WebDAVServerBeforeDownloadObjectEventArgs { fn connection_id(&self) -> i64 fn path(&self) -> &String fn action(&self) -> i32 fn set_action(&self, value : i32) } // WebDAVServerBeforeDownloadObjectEvent defines the signature of the WebDAVServer BeforeDownloadObject event's handler function. pub trait WebDAVServerBeforeDownloadObjectEvent { fn on_before_download_object(&self, sender : WebDAVServer, e : &mut WebDAVServerBeforeDownloadObjectEventArgs); } impl <'a> WebDAVServer<'a> { pub fn on_before_download_object(&self) -> &'a dyn WebDAVServerBeforeDownloadObjectEvent; pub fn set_on_before_download_object(&mut self, value : &'a dyn WebDAVServerBeforeDownloadObjectEvent); ... } ``` ## Remarks The struct fires this event to notify the application about an incoming object download request. The *Path* parameter contains the path of the requested object. *ConnectionID* identifies the connected client. Set *Action* to [fraAuto](constants.md#const_fraAuto) to let the server handle the request automatically, or to fraCustom to handle the request in your code. Choose *Action* as one of the following values: | | | | | --- | --- | --- | | fraAuto | 1 | Handle the requested action automatically by the server | | fraCustom | 2 | Override the action using the user code logic | | fraAbort | 3 | Abort the requested action | If *fraCustom* Action is chosen, this event will be followed by [on_download_object](#on_download_object-event-webdavserver-struct), [on_read_object](#on_read_object-event-webdavserver-struct), and [on_download_object_completed](#on_download_object_completed-event-webdavserver-struct) calls, allowing you to supply the object data to the client. # on_before_lock_object event ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Fires when a lock request is received. ## Syntax *Rust Syntax* ```text // WebDAVServerBeforeLockObjectEventArgs carries the WebDAVServer BeforeLockObject event's parameters. pub struct WebDAVServerBeforeLockObjectEventArgs { fn connection_id(&self) -> i64 fn path(&self) -> &String fn action(&self) -> i32 fn set_action(&self, value : i32) } // WebDAVServerBeforeLockObjectEvent defines the signature of the WebDAVServer BeforeLockObject event's handler function. pub trait WebDAVServerBeforeLockObjectEvent { fn on_before_lock_object(&self, sender : WebDAVServer, e : &mut WebDAVServerBeforeLockObjectEventArgs); } impl <'a> WebDAVServer<'a> { pub fn on_before_lock_object(&self) -> &'a dyn WebDAVServerBeforeLockObjectEvent; pub fn set_on_before_lock_object(&mut self, value : &'a dyn WebDAVServerBeforeLockObjectEvent); ... } ``` ## Remarks The struct uses this event to notify the application that an object lock request was received. The *Path* parameter contains the path to be locked. *ConnectionID* identifies the connected client. Set *Action* to [fraAuto](constants.md#const_fraAuto) to let the server handle the request automatically, or to fraCustom to handle the request in your code. Choose *Action* as one of the following values: | | | | | --- | --- | --- | | fraAuto | 1 | Handle the requested action automatically by the server | | fraCustom | 2 | Override the action using the user code logic | | fraAbort | 3 | Abort the requested action | If *fraCustom* Action is chosen, this event will be followed by a [on_lock_object](#on_lock_object-event-webdavserver-struct) call which expects you to perform the locking as required. # on_before_refresh_lock event ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Reports the receipt of lock refresh request. ## Syntax *Rust Syntax* ```text // WebDAVServerBeforeRefreshLockEventArgs carries the WebDAVServer BeforeRefreshLock event's parameters. pub struct WebDAVServerBeforeRefreshLockEventArgs { fn connection_id(&self) -> i64 fn path(&self) -> &String fn action(&self) -> i32 fn set_action(&self, value : i32) } // WebDAVServerBeforeRefreshLockEvent defines the signature of the WebDAVServer BeforeRefreshLock event's handler function. pub trait WebDAVServerBeforeRefreshLockEvent { fn on_before_refresh_lock(&self, sender : WebDAVServer, e : &mut WebDAVServerBeforeRefreshLockEventArgs); } impl <'a> WebDAVServer<'a> { pub fn on_before_refresh_lock(&self) -> &'a dyn WebDAVServerBeforeRefreshLockEvent; pub fn set_on_before_refresh_lock(&mut self, value : &'a dyn WebDAVServerBeforeRefreshLockEvent); ... } ``` ## Remarks Use this event to be notified about refresh requests for existing locks. The *Path* parameter contains the path on which to refresh the lock. *ConnectionID* identifies the connected client. Set *Action* to [fraAuto](constants.md#const_fraAuto) to let the server handle the request automatically, or to fraCustom to handle the request in your code. Choose *Action* as one of the following values: | | | | | --- | --- | --- | | fraAuto | 1 | Handle the requested action automatically by the server | | fraCustom | 2 | Override the action using the user code logic | | fraAbort | 3 | Abort the requested action | If *fraCustom* Action is chosen, this event will be followed by a [on_refresh_lock](#on_refresh_lock-event-webdavserver-struct) call, allowing you to virtualize the operation. # on_before_remove_object event ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Fires when an object deletion request is received. ## Syntax *Rust Syntax* ```text // WebDAVServerBeforeRemoveObjectEventArgs carries the WebDAVServer BeforeRemoveObject event's parameters. pub struct WebDAVServerBeforeRemoveObjectEventArgs { fn connection_id(&self) -> i64 fn path(&self) -> &String fn action(&self) -> i32 fn set_action(&self, value : i32) } // WebDAVServerBeforeRemoveObjectEvent defines the signature of the WebDAVServer BeforeRemoveObject event's handler function. pub trait WebDAVServerBeforeRemoveObjectEvent { fn on_before_remove_object(&self, sender : WebDAVServer, e : &mut WebDAVServerBeforeRemoveObjectEventArgs); } impl <'a> WebDAVServer<'a> { pub fn on_before_remove_object(&self) -> &'a dyn WebDAVServerBeforeRemoveObjectEvent; pub fn set_on_before_remove_object(&mut self, value : &'a dyn WebDAVServerBeforeRemoveObjectEvent); ... } ``` ## Remarks Use this event to track object deletion requests. The *Path* parameter contains the path of the object to be deleted. *ConnectionID* identifies the connected client. Set *Action* to [fraAuto](constants.md#const_fraAuto) to let the server handle the request automatically, or to fraCustom to handle the request in your code. Choose *Action* as one of the following values: | | | | | --- | --- | --- | | fraAuto | 1 | Handle the requested action automatically by the server | | fraCustom | 2 | Override the action using the user code logic | | fraAbort | 3 | Abort the requested action | If *fraCustom* Action is chosen, this event will be followed by a [on_remove_object](#on_remove_object-event-webdavserver-struct) call, allowing you to virtualize the deletion operation. # on_before_rename_object event ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Reports object renaming requests. ## Syntax *Rust Syntax* ```text // WebDAVServerBeforeRenameObjectEventArgs carries the WebDAVServer BeforeRenameObject event's parameters. pub struct WebDAVServerBeforeRenameObjectEventArgs { fn connection_id(&self) -> i64 fn old_path(&self) -> &String fn new_path(&self) -> &String fn action(&self) -> i32 fn set_action(&self, value : i32) } // WebDAVServerBeforeRenameObjectEvent defines the signature of the WebDAVServer BeforeRenameObject event's handler function. pub trait WebDAVServerBeforeRenameObjectEvent { fn on_before_rename_object(&self, sender : WebDAVServer, e : &mut WebDAVServerBeforeRenameObjectEventArgs); } impl <'a> WebDAVServer<'a> { pub fn on_before_rename_object(&self) -> &'a dyn WebDAVServerBeforeRenameObjectEvent; pub fn set_on_before_rename_object(&mut self, value : &'a dyn WebDAVServerBeforeRenameObjectEvent); ... } ``` ## Remarks The server uses this event to notify the application about incoming object rename requests. *OldPath* and *NewPath* contain the existing and the new path for the object. *ConnectionID* identifies the connected client. Set *Action* to [fraAuto](constants.md#const_fraAuto) to let the server handle the request automatically, or to fraCustom to handle the request in your code. Choose *Action* as one of the following values: | | | | | --- | --- | --- | | fraAuto | 1 | Handle the requested action automatically by the server | | fraCustom | 2 | Override the action using the user code logic | | fraAbort | 3 | Abort the requested action | If *fraCustom* Action is chosen, this event will be followed by a [on_rename_object](#on_rename_object-event-webdavserver-struct) call, where your code is expected to perform the renaming operation. # on_before_request event ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Fires before a DAV request is processed. ## Syntax *Rust Syntax* ```text // WebDAVServerBeforeRequestEventArgs carries the WebDAVServer BeforeRequest event's parameters. pub struct WebDAVServerBeforeRequestEventArgs { fn connection_id(&self) -> i64 fn http_method(&self) -> &String fn url(&self) -> &String fn accept(&self) -> bool fn set_accept(&self, value : bool) } // WebDAVServerBeforeRequestEvent defines the signature of the WebDAVServer BeforeRequest event's handler function. pub trait WebDAVServerBeforeRequestEvent { fn on_before_request(&self, sender : WebDAVServer, e : &mut WebDAVServerBeforeRequestEventArgs); } impl <'a> WebDAVServer<'a> { pub fn on_before_request(&self) -> &'a dyn WebDAVServerBeforeRequestEvent; pub fn set_on_before_request(&mut self, value : &'a dyn WebDAVServerBeforeRequestEvent); ... } ``` ## Remarks This event fires before an incoming request is processed. *ConnectionID* indicates the client's unique connection ID; *HTTPMethod* specifies the HTTP method being used to submit the request, and *URL* signifies the object's URL. Use *Accept* parameter to accept or reject the request. # on_before_set_attributes event ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Notifies the application about attribute change request. ## Syntax *Rust Syntax* ```text // WebDAVServerBeforeSetAttributesEventArgs carries the WebDAVServer BeforeSetAttributes event's parameters. pub struct WebDAVServerBeforeSetAttributesEventArgs { fn connection_id(&self) -> i64 fn path(&self) -> &String fn action(&self) -> i32 fn set_action(&self, value : i32) } // WebDAVServerBeforeSetAttributesEvent defines the signature of the WebDAVServer BeforeSetAttributes event's handler function. pub trait WebDAVServerBeforeSetAttributesEvent { fn on_before_set_attributes(&self, sender : WebDAVServer, e : &mut WebDAVServerBeforeSetAttributesEventArgs); } impl <'a> WebDAVServer<'a> { pub fn on_before_set_attributes(&self) -> &'a dyn WebDAVServerBeforeSetAttributesEvent; pub fn set_on_before_set_attributes(&mut self, value : &'a dyn WebDAVServerBeforeSetAttributesEvent); ... } ``` ## Remarks Use this event to react to object attributes change requests. The *Path* parameter contains the object path. *ConnectionID* identifies the connected client. Set *Action* to [fraAuto](constants.md#const_fraAuto) to let the server handle the request automatically, or to fraCustom to handle the request in your code. Choose *Action* as one of the following values: | | | | | --- | --- | --- | | fraAuto | 1 | Handle the requested action automatically by the server | | fraCustom | 2 | Override the action using the user code logic | | fraAbort | 3 | Abort the requested action | If *fraCustom* Action is chosen, this event will be followed by a series of [on_set_attribute](#on_set_attribute-event-webdavserver-struct) and/or [on_clear_attribute](#on_clear_attribute-event-webdavserver-struct) calls, for each attribute to be set or cleared. # on_before_unlock_object event ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Fires when an unlock request is received. ## Syntax *Rust Syntax* ```text // WebDAVServerBeforeUnlockObjectEventArgs carries the WebDAVServer BeforeUnlockObject event's parameters. pub struct WebDAVServerBeforeUnlockObjectEventArgs { fn connection_id(&self) -> i64 fn path(&self) -> &String fn action(&self) -> i32 fn set_action(&self, value : i32) } // WebDAVServerBeforeUnlockObjectEvent defines the signature of the WebDAVServer BeforeUnlockObject event's handler function. pub trait WebDAVServerBeforeUnlockObjectEvent { fn on_before_unlock_object(&self, sender : WebDAVServer, e : &mut WebDAVServerBeforeUnlockObjectEventArgs); } impl <'a> WebDAVServer<'a> { pub fn on_before_unlock_object(&self) -> &'a dyn WebDAVServerBeforeUnlockObjectEvent; pub fn set_on_before_unlock_object(&mut self, value : &'a dyn WebDAVServerBeforeUnlockObjectEvent); ... } ``` ## Remarks The struct uses this event to notify the application about the received unlock request. The *Path* parameter contains the path to be unlocked. *ConnectionID* identifies the connected client. Set *Action* to [fraAuto](constants.md#const_fraAuto) to let the server handle the request automatically, or to fraCustom to handle the request in your code. Choose *Action* as one of the following values: | | | | | --- | --- | --- | | fraAuto | 1 | Handle the requested action automatically by the server | | fraCustom | 2 | Override the action using the user code logic | | fraAbort | 3 | Abort the requested action | If *fraCustom* Action is chosen, this event will be followed by a [on_unlock_object](#on_unlock_object-event-webdavserver-struct) call. # on_before_upload_object event ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Fires when an object upload request is received. ## Syntax *Rust Syntax* ```text // WebDAVServerBeforeUploadObjectEventArgs carries the WebDAVServer BeforeUploadObject event's parameters. pub struct WebDAVServerBeforeUploadObjectEventArgs { fn connection_id(&self) -> i64 fn path(&self) -> &String fn action(&self) -> i32 fn set_action(&self, value : i32) } // WebDAVServerBeforeUploadObjectEvent defines the signature of the WebDAVServer BeforeUploadObject event's handler function. pub trait WebDAVServerBeforeUploadObjectEvent { fn on_before_upload_object(&self, sender : WebDAVServer, e : &mut WebDAVServerBeforeUploadObjectEventArgs); } impl <'a> WebDAVServer<'a> { pub fn on_before_upload_object(&self) -> &'a dyn WebDAVServerBeforeUploadObjectEvent; pub fn set_on_before_upload_object(&mut self, value : &'a dyn WebDAVServerBeforeUploadObjectEvent); ... } ``` ## Remarks The struct fires this event to notify the application about an incoming object upload request. The *Path* parameter contains the path of the requested object. *ConnectionID* identifies the connected client. Set *Action* to [fraAuto](constants.md#const_fraAuto) to let the server handle the request automatically, or to fraCustom to handle the request in your code. Choose *Action* as one of the following values: | | | | | --- | --- | --- | | fraAuto | 1 | Handle the requested action automatically by the server | | fraCustom | 2 | Override the action using the user code logic | | fraAbort | 3 | Abort the requested action | If *fraCustom* Action is chosen, this event will be followed by [on_upload_object](#on_upload_object-event-webdavserver-struct), [on_write_object](#on_write_object-event-webdavserver-struct), and [on_upload_object_completed](#on_upload_object_completed-event-webdavserver-struct) calls, allowing your code to process/store the object data. # on_clear_attribute event ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Reports an attribute clearance request. ## Syntax *Rust Syntax* ```text // WebDAVServerClearAttributeEventArgs carries the WebDAVServer ClearAttribute event's parameters. pub struct WebDAVServerClearAttributeEventArgs { fn connection_id(&self) -> i64 fn path(&self) -> &String fn ns(&self) -> &String fn name(&self) -> &String fn operation_status(&self) -> i32 fn set_operation_status(&self, value : i32) } // WebDAVServerClearAttributeEvent defines the signature of the WebDAVServer ClearAttribute event's handler function. pub trait WebDAVServerClearAttributeEvent { fn on_clear_attribute(&self, sender : WebDAVServer, e : &mut WebDAVServerClearAttributeEventArgs); } impl <'a> WebDAVServer<'a> { pub fn on_clear_attribute(&self) -> &'a dyn WebDAVServerClearAttributeEvent; pub fn set_on_clear_attribute(&mut self, value : &'a dyn WebDAVServerClearAttributeEvent); ... } ``` ## Remarks This event fires to notify the application about an attribute clearance (removal) request. Use this handler to respond to this request by making the necessary changes to the locally stored resource attributes. The *ConnectionID* specifies the unique client ID, *Path* contains the resource path, and the *NS:Name* pair specifies the attribute to be cleared. Check the operation status, and alter it, if needed, through the *OperationStatus* parameter: | | | | | --- | --- | --- | | ostOk | 1 | | | ostNoSuchFile | 2 | | | ostAccessDenied | 3 | | | ostWriteProtect | 4 | | | ostUnsupported | 5 | | | ostInvalidParameter | 6 | | | ostEOF | 7 | | # on_connect event ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Reports an accepted connection. ## Syntax *Rust Syntax* ```text // WebDAVServerConnectEventArgs carries the WebDAVServer Connect event's parameters. pub struct WebDAVServerConnectEventArgs { fn connection_id(&self) -> i64 fn remote_address(&self) -> &String fn remote_port(&self) -> i32 } // WebDAVServerConnectEvent defines the signature of the WebDAVServer Connect event's handler function. pub trait WebDAVServerConnectEvent { fn on_connect(&self, sender : WebDAVServer, e : &mut WebDAVServerConnectEventArgs); } impl <'a> WebDAVServer<'a> { pub fn on_connect(&self) -> &'a dyn WebDAVServerConnectEvent; pub fn set_on_connect(&mut self, value : &'a dyn WebDAVServerConnectEvent); ... } ``` ## Remarks 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_get_request or [on_auth_attempt](#on_auth_attempt-event-webdavserver-struct). # on_copy_object event ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Lets the application handle the Copy Object request. ## Syntax *Rust Syntax* ```text // WebDAVServerCopyObjectEventArgs carries the WebDAVServer CopyObject event's parameters. pub struct WebDAVServerCopyObjectEventArgs { fn connection_id(&self) -> i64 fn old_path(&self) -> &String fn new_path(&self) -> &String fn overwrite(&self) -> bool fn depth(&self) -> i32 fn operation_status(&self) -> i32 fn set_operation_status(&self, value : i32) } // WebDAVServerCopyObjectEvent defines the signature of the WebDAVServer CopyObject event's handler function. pub trait WebDAVServerCopyObjectEvent { fn on_copy_object(&self, sender : WebDAVServer, e : &mut WebDAVServerCopyObjectEventArgs); } impl <'a> WebDAVServer<'a> { pub fn on_copy_object(&self) -> &'a dyn WebDAVServerCopyObjectEvent; pub fn set_on_copy_object(&mut self, value : &'a dyn WebDAVServerCopyObjectEvent); ... } ``` ## Remarks Use this event handler to respond to the received Copy Object request by creating a copy of *OldPath* resource at *NewPath*. *ConnectionID* specifies the unique client connection identifier, *Overwrite* indicates whether any existing resource(s) should be overwritten, and *Depth* specifies the depth of the resource tree to be copied. Check the operation status, and alter it, if needed, through the *OperationStatus* parameter: | | | | | --- | --- | --- | | ostOk | 1 | | | ostNoSuchFile | 2 | | | ostAccessDenied | 3 | | | ostWriteProtect | 4 | | | ostUnsupported | 5 | | | ostInvalidParameter | 6 | | | ostEOF | 7 | | # on_create_calendar event ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Lets the application handle a calendar creation request. ## Syntax *Rust Syntax* ```text // WebDAVServerCreateCalendarEventArgs carries the WebDAVServer CreateCalendar event's parameters. pub struct WebDAVServerCreateCalendarEventArgs { fn connection_id(&self) -> i64 fn path(&self) -> &String fn operation_status(&self) -> i32 fn set_operation_status(&self, value : i32) } // WebDAVServerCreateCalendarEvent defines the signature of the WebDAVServer CreateCalendar event's handler function. pub trait WebDAVServerCreateCalendarEvent { fn on_create_calendar(&self, sender : WebDAVServer, e : &mut WebDAVServerCreateCalendarEventArgs); } impl <'a> WebDAVServer<'a> { pub fn on_create_calendar(&self) -> &'a dyn WebDAVServerCreateCalendarEvent; pub fn set_on_create_calendar(&mut self, value : &'a dyn WebDAVServerCreateCalendarEvent); ... } ``` ## Remarks Use this method to respond to a calendar creation request with a custom action. This event fires if *fraCustom* action was returned from the preceding [on_before_create_calendar](#on_before_create_calendar-event-webdavserver-struct) call. Check the operation status, and alter it, if needed, through the *OperationStatus* parameter: | | | | | --- | --- | --- | | ostOk | 1 | | | ostNoSuchFile | 2 | | | ostAccessDenied | 3 | | | ostWriteProtect | 4 | | | ostUnsupported | 5 | | | ostInvalidParameter | 6 | | | ostEOF | 7 | | # on_create_collection event ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Lets the application respond to collection creation request. ## Syntax *Rust Syntax* ```text // WebDAVServerCreateCollectionEventArgs carries the WebDAVServer CreateCollection event's parameters. pub struct WebDAVServerCreateCollectionEventArgs { fn connection_id(&self) -> i64 fn path(&self) -> &String fn operation_status(&self) -> i32 fn set_operation_status(&self, value : i32) } // WebDAVServerCreateCollectionEvent defines the signature of the WebDAVServer CreateCollection event's handler function. pub trait WebDAVServerCreateCollectionEvent { fn on_create_collection(&self, sender : WebDAVServer, e : &mut WebDAVServerCreateCollectionEventArgs); } impl <'a> WebDAVServer<'a> { pub fn on_create_collection(&self) -> &'a dyn WebDAVServerCreateCollectionEvent; pub fn set_on_create_collection(&mut self, value : &'a dyn WebDAVServerCreateCollectionEvent); ... } ``` ## Remarks The struct uses this event to let the application respond to collection creation requests. This event fires if *fraCustom* action was returned from the preceding [on_before_create_collection](#on_before_create_collection-event-webdavserver-struct) call. The handler of this event is expected to create a new collection at *Path*. Check the operation status, and alter it, if needed, through the *OperationStatus* parameter: | | | | | --- | --- | --- | | ostOk | 1 | | | ostNoSuchFile | 2 | | | ostAccessDenied | 3 | | | ostWriteProtect | 4 | | | ostUnsupported | 5 | | | ostInvalidParameter | 6 | | | ostEOF | 7 | | # on_custom_request event ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Use this event to respond to non-standard DAV requests. ## Syntax *Rust Syntax* ```text // WebDAVServerCustomRequestEventArgs carries the WebDAVServer CustomRequest event's parameters. pub struct WebDAVServerCustomRequestEventArgs { fn connection_id(&self) -> i64 fn request_method(&self) -> &String fn path(&self) -> &String fn operation_status(&self) -> i32 fn set_operation_status(&self, value : i32) } // WebDAVServerCustomRequestEvent defines the signature of the WebDAVServer CustomRequest event's handler function. pub trait WebDAVServerCustomRequestEvent { fn on_custom_request(&self, sender : WebDAVServer, e : &mut WebDAVServerCustomRequestEventArgs); } impl <'a> WebDAVServer<'a> { pub fn on_custom_request(&self) -> &'a dyn WebDAVServerCustomRequestEvent; pub fn set_on_custom_request(&mut self, value : &'a dyn WebDAVServerCustomRequestEvent); ... } ``` ## Remarks This event allows the application to respond in a virtualized manner to non-standard DAV requests. It will fire if *fraCustom* action was selected in the earlier [on_before_custom_request](#on_before_custom_request-event-webdavserver-struct) call. The *RequestMethod* specifies the HTTP method used for this request (GET, PUT, POST etc.), and the *Path* contains the requested path. Check the operation status, and alter it, if needed, through the *OperationStatus* parameter: | | | | | --- | --- | --- | | ostOk | 1 | | | ostNoSuchFile | 2 | | | ostAccessDenied | 3 | | | ostWriteProtect | 4 | | | ostUnsupported | 5 | | | ostInvalidParameter | 6 | | | ostEOF | 7 | | # on_data event ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Supplies a data chunk received from a client. ## Syntax *Rust Syntax* ```text // WebDAVServerDataEventArgs carries the WebDAVServer Data event's parameters. pub struct WebDAVServerDataEventArgs { fn connection_id(&self) -> i64 fn buffer(&self) -> &[u8] } // WebDAVServerDataEvent defines the signature of the WebDAVServer Data event's handler function. pub trait WebDAVServerDataEvent { fn on_data(&self, sender : WebDAVServer, e : &mut WebDAVServerDataEventArgs); } impl <'a> WebDAVServer<'a> { pub fn on_data(&self) -> &'a dyn WebDAVServerDataEvent; pub fn set_on_data(&mut self, value : &'a dyn WebDAVServerDataEvent); ... } ``` ## Remarks This event is fired to supply another piece of data received from a client. This event may fire multiple times. # on_disconnect event ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Fires to report a disconnected client. ## Syntax *Rust Syntax* ```text // WebDAVServerDisconnectEventArgs carries the WebDAVServer Disconnect event's parameters. pub struct WebDAVServerDisconnectEventArgs { fn connection_id(&self) -> i64 } // WebDAVServerDisconnectEvent defines the signature of the WebDAVServer Disconnect event's handler function. pub trait WebDAVServerDisconnectEvent { fn on_disconnect(&self, sender : WebDAVServer, e : &mut WebDAVServerDisconnectEventArgs); } impl <'a> WebDAVServer<'a> { pub fn on_disconnect(&self) -> &'a dyn WebDAVServerDisconnectEvent; pub fn set_on_disconnect(&mut self, value : &'a dyn WebDAVServerDisconnectEvent); ... } ``` ## Remarks struct fires this event when a connected client disconnects. # on_download_object event ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Allows the application respond to Download Object request. ## Syntax *Rust Syntax* ```text // WebDAVServerDownloadObjectEventArgs carries the WebDAVServer DownloadObject event's parameters. pub struct WebDAVServerDownloadObjectEventArgs { fn connection_id(&self) -> i64 fn path(&self) -> &String fn restart_at(&self) -> i64 fn operation_status(&self) -> i32 fn set_operation_status(&self, value : i32) } // WebDAVServerDownloadObjectEvent defines the signature of the WebDAVServer DownloadObject event's handler function. pub trait WebDAVServerDownloadObjectEvent { fn on_download_object(&self, sender : WebDAVServer, e : &mut WebDAVServerDownloadObjectEventArgs); } impl <'a> WebDAVServer<'a> { pub fn on_download_object(&self) -> &'a dyn WebDAVServerDownloadObjectEvent; pub fn set_on_download_object(&mut self, value : &'a dyn WebDAVServerDownloadObjectEvent); ... } ``` ## Remarks Use this event to implement custom handler of the Download operation. This event is followed by a series of [on_read_object](#on_read_object-event-webdavserver-struct) calls, which are then followed by [on_download_object_completed](#on_download_object_completed-event-webdavserver-struct) that signifies completion of the transfer operation. Check the operation status, and alter it, if needed, through the *OperationStatus* parameter: | | | | | --- | --- | --- | | ostOk | 1 | | | ostNoSuchFile | 2 | | | ostAccessDenied | 3 | | | ostWriteProtect | 4 | | | ostUnsupported | 5 | | | ostInvalidParameter | 6 | | | ostEOF | 7 | | # on_download_object_completed event ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) This event is fired when a download operation completes. ## Syntax *Rust Syntax* ```text // WebDAVServerDownloadObjectCompletedEventArgs carries the WebDAVServer DownloadObjectCompleted event's parameters. pub struct WebDAVServerDownloadObjectCompletedEventArgs { fn connection_id(&self) -> i64 fn path(&self) -> &String fn operation_status(&self) -> i32 fn set_operation_status(&self, value : i32) } // WebDAVServerDownloadObjectCompletedEvent defines the signature of the WebDAVServer DownloadObjectCompleted event's handler function. pub trait WebDAVServerDownloadObjectCompletedEvent { fn on_download_object_completed(&self, sender : WebDAVServer, e : &mut WebDAVServerDownloadObjectCompletedEventArgs); } impl <'a> WebDAVServer<'a> { pub fn on_download_object_completed(&self) -> &'a dyn WebDAVServerDownloadObjectCompletedEvent; pub fn set_on_download_object_completed(&mut self, value : &'a dyn WebDAVServerDownloadObjectCompletedEvent); ... } ``` ## Remarks This event is fired when a download operation completes. This event is only fired for operations handled by the user code, i.e. those intercepted with on_before_download_file event, and with Action parameter set to fraCustom. The *ConnectionID* parameter specifies the session to which the event belongs, and *OperationStatus* reports the outcome of the transfer operation. | | | | | --- | --- | --- | | ostOk | 1 | | | ostNoSuchFile | 2 | | | ostAccessDenied | 3 | | | ostWriteProtect | 4 | | | ostUnsupported | 5 | | | ostInvalidParameter | 6 | | | ostEOF | 7 | | # on_error event ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Information about errors during data delivery. ## Syntax *Rust Syntax* ```text // WebDAVServerErrorEventArgs carries the WebDAVServer Error event's parameters. pub struct WebDAVServerErrorEventArgs { fn connection_id(&self) -> i64 fn error_code(&self) -> i32 fn fatal(&self) -> bool fn remote(&self) -> bool fn description(&self) -> &String } // WebDAVServerErrorEvent defines the signature of the WebDAVServer Error event's handler function. pub trait WebDAVServerErrorEvent { fn on_error(&self, sender : WebDAVServer, e : &mut WebDAVServerErrorEventArgs); } impl <'a> WebDAVServer<'a> { pub fn on_error(&self) -> &'a dyn WebDAVServerErrorEvent; pub fn set_on_error(&mut self, value : &'a dyn WebDAVServerErrorEvent); ... } ``` ## 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-webdavserver-struct) section. # on_external_sign event ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Handles remote or external signing initiated by the server protocol. ## Syntax *Rust Syntax* ```text // WebDAVServerExternalSignEventArgs carries the WebDAVServer ExternalSign event's parameters. pub struct WebDAVServerExternalSignEventArgs { 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) } // WebDAVServerExternalSignEvent defines the signature of the WebDAVServer ExternalSign event's handler function. pub trait WebDAVServerExternalSignEvent { fn on_external_sign(&self, sender : WebDAVServer, e : &mut WebDAVServerExternalSignEventArgs); } impl <'a> WebDAVServer<'a> { pub fn on_external_sign(&self) -> &'a dyn WebDAVServerExternalSignEvent; pub fn set_on_external_sign(&mut self, value : &'a dyn WebDAVServerExternalSignEvent); ... } ``` ## 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_file_error event ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Reports a file access error to the application. ## Syntax *Rust Syntax* ```text // WebDAVServerFileErrorEventArgs carries the WebDAVServer FileError event's parameters. pub struct WebDAVServerFileErrorEventArgs { fn connection_id(&self) -> i64 fn file_name(&self) -> &String fn error_code(&self) -> i32 } // WebDAVServerFileErrorEvent defines the signature of the WebDAVServer FileError event's handler function. pub trait WebDAVServerFileErrorEvent { fn on_file_error(&self, sender : WebDAVServer, e : &mut WebDAVServerFileErrorEventArgs); } impl <'a> WebDAVServer<'a> { pub fn on_file_error(&self) -> &'a dyn WebDAVServerFileErrorEvent; pub fn set_on_file_error(&mut self, value : &'a dyn WebDAVServerFileErrorEvent); ... } ``` ## Remarks struct uses this event to report a file access errors. *FileName* and *ErrorCode* contain the file path and the error code respectively. # on_headers_prepared event ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Fires when the response headers have been formed and are ready to be sent to the server. ## Syntax *Rust Syntax* ```text // WebDAVServerHeadersPreparedEventArgs carries the WebDAVServer HeadersPrepared event's parameters. pub struct WebDAVServerHeadersPreparedEventArgs { fn connection_id(&self) -> i64 } // WebDAVServerHeadersPreparedEvent defines the signature of the WebDAVServer HeadersPrepared event's handler function. pub trait WebDAVServerHeadersPreparedEvent { fn on_headers_prepared(&self, sender : WebDAVServer, e : &mut WebDAVServerHeadersPreparedEventArgs); } impl <'a> WebDAVServer<'a> { pub fn on_headers_prepared(&self) -> &'a dyn WebDAVServerHeadersPreparedEvent; pub fn set_on_headers_prepared(&mut self, value : &'a dyn WebDAVServerHeadersPreparedEvent); ... } ``` ## Remarks The struct fires this event when the response headers are ready to be sent to the server. *ConnectionID* indicates the connection that processed the request. Use [get_response_header](#get_response_header-method-webdavserver-struct) method with an empty header name to get the whole response header. # on_list_attributes event ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Requests object attributes from the application in fraCustom handling mode. ## Syntax *Rust Syntax* ```text // WebDAVServerListAttributesEventArgs carries the WebDAVServer ListAttributes event's parameters. pub struct WebDAVServerListAttributesEventArgs { fn connection_id(&self) -> i64 fn path(&self) -> &String fn attributes(&self) -> &String fn set_attributes(&self, value : &str) fn set_attributes_ref(&self, value : &String) } // WebDAVServerListAttributesEvent defines the signature of the WebDAVServer ListAttributes event's handler function. pub trait WebDAVServerListAttributesEvent { fn on_list_attributes(&self, sender : WebDAVServer, e : &mut WebDAVServerListAttributesEventArgs); } impl <'a> WebDAVServer<'a> { pub fn on_list_attributes(&self) -> &'a dyn WebDAVServerListAttributesEvent; pub fn set_on_list_attributes(&mut self, value : &'a dyn WebDAVServerListAttributesEvent); ... } ``` ## Remarks The struct uses this event to request a set of attributes supported/kept for the object at *Path*. Return the list via the *Attributes* parameter as a string of CRLF-separated attribute names. After firing this event, the struct may request values for individual attributes via a series of [on_read_attribute](#on_read_attribute-event-webdavserver-struct) calls. This event only fires if *fraCustom* action type was returned from the preceding [on_before_browse](#on_before_browse-event-webdavserver-struct) event call. # on_list_sub_objects event ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Requests a list of sub-objects of an object. The struct uses this event to request a list of sub-objects of the object residing at Path . The Recursive parameter specifies whether the sub-objects should be browsed and returned recursively. Return the requested list via the Objects parameter by separating individual entries with CRLF. ## Syntax *Rust Syntax* ```text // WebDAVServerListSubObjectsEventArgs carries the WebDAVServer ListSubObjects event's parameters. pub struct WebDAVServerListSubObjectsEventArgs { fn connection_id(&self) -> i64 fn path(&self) -> &String fn recursive(&self) -> bool fn objects(&self) -> &String fn set_objects(&self, value : &str) fn set_objects_ref(&self, value : &String) fn operation_status(&self) -> i32 fn set_operation_status(&self, value : i32) } // WebDAVServerListSubObjectsEvent defines the signature of the WebDAVServer ListSubObjects event's handler function. pub trait WebDAVServerListSubObjectsEvent { fn on_list_sub_objects(&self, sender : WebDAVServer, e : &mut WebDAVServerListSubObjectsEventArgs); } impl <'a> WebDAVServer<'a> { pub fn on_list_sub_objects(&self) -> &'a dyn WebDAVServerListSubObjectsEvent; pub fn set_on_list_sub_objects(&mut self, value : &'a dyn WebDAVServerListSubObjectsEvent); ... } ``` ## Remarks Set the status of the operation through the *OperationStatus* parameter as required: | | | | | --- | --- | --- | | ostOk | 1 | | | ostNoSuchFile | 2 | | | ostAccessDenied | 3 | | | ostWriteProtect | 4 | | | ostUnsupported | 5 | | | ostInvalidParameter | 6 | | | ostEOF | 7 | | # on_lock_object event ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Virtualizes the object locking operation. ## Syntax *Rust Syntax* ```text // WebDAVServerLockObjectEventArgs carries the WebDAVServer LockObject event's parameters. pub struct WebDAVServerLockObjectEventArgs { fn connection_id(&self) -> i64 fn path(&self) -> &String fn owner(&self) -> &String fn exclusive(&self) -> bool fn depth(&self) -> i32 fn timeout(&self) -> i64 fn token(&self) -> &String fn set_token(&self, value : &str) fn set_token_ref(&self, value : &String) } // WebDAVServerLockObjectEvent defines the signature of the WebDAVServer LockObject event's handler function. pub trait WebDAVServerLockObjectEvent { fn on_lock_object(&self, sender : WebDAVServer, e : &mut WebDAVServerLockObjectEventArgs); } impl <'a> WebDAVServer<'a> { pub fn on_lock_object(&self) -> &'a dyn WebDAVServerLockObjectEvent; pub fn set_on_lock_object(&mut self, value : &'a dyn WebDAVServerLockObjectEvent); ... } ``` ## Remarks The struct uses this event to request a lock on the object at *Path* from the application. This event is only fired if *fraCustom* action was returned from the preceding [on_before_lock_object](#on_before_lock_object-event-webdavserver-struct) call. The *Owner*, *Exclusive*, *Depth*, and *Timeout* parameters specify the respective parameters of the requested lock. In response to this event, generate a lock token and return it via the *Token* parameter. # on_notification event ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) This event notifies the application about an underlying control flow event. ## Syntax *Rust Syntax* ```text // WebDAVServerNotificationEventArgs carries the WebDAVServer Notification event's parameters. pub struct WebDAVServerNotificationEventArgs { fn event_id(&self) -> &String fn event_param(&self) -> &String } // WebDAVServerNotificationEvent defines the signature of the WebDAVServer Notification event's handler function. pub trait WebDAVServerNotificationEvent { fn on_notification(&self, sender : WebDAVServer, e : &mut WebDAVServerNotificationEventArgs); } impl <'a> WebDAVServer<'a> { pub fn on_notification(&self) -> &'a dyn WebDAVServerNotificationEvent; pub fn set_on_notification(&mut self, value : &'a dyn WebDAVServerNotificationEvent); ... } ``` ## 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_query_quota event ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Reflects a quota enquiry by a client. ## Syntax *Rust Syntax* ```text // WebDAVServerQueryQuotaEventArgs carries the WebDAVServer QueryQuota event's parameters. pub struct WebDAVServerQueryQuotaEventArgs { fn connection_id(&self) -> i64 fn username(&self) -> &String fn available(&self) -> i64 fn set_available(&self, value : i64) fn used(&self) -> i64 fn set_used(&self, value : i64) } // WebDAVServerQueryQuotaEvent defines the signature of the WebDAVServer QueryQuota event's handler function. pub trait WebDAVServerQueryQuotaEvent { fn on_query_quota(&self, sender : WebDAVServer, e : &mut WebDAVServerQueryQuotaEventArgs); } impl <'a> WebDAVServer<'a> { pub fn on_query_quota(&self) -> &'a dyn WebDAVServerQueryQuotaEvent; pub fn set_on_query_quota(&mut self, value : &'a dyn WebDAVServerQueryQuotaEvent); ... } ``` ## Remarks This event fires in response to a client's enquire about their quota status. Subscribe to this event to react to such enquiries in a customized manner. Use *Available* and *Used* properties to report the respective amounts back to the client. # on_read_attribute event ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Requests value of an attribute from the application in fraCustom mode. ## Syntax *Rust Syntax* ```text // WebDAVServerReadAttributeEventArgs carries the WebDAVServer ReadAttribute event's parameters. pub struct WebDAVServerReadAttributeEventArgs { fn connection_id(&self) -> i64 fn path(&self) -> &String fn ns(&self) -> &String fn name(&self) -> &String fn value(&self) -> &String fn set_value(&self, value : &str) fn set_value_ref(&self, value : &String) fn operation_status(&self) -> i32 fn set_operation_status(&self, value : i32) } // WebDAVServerReadAttributeEvent defines the signature of the WebDAVServer ReadAttribute event's handler function. pub trait WebDAVServerReadAttributeEvent { fn on_read_attribute(&self, sender : WebDAVServer, e : &mut WebDAVServerReadAttributeEventArgs); } impl <'a> WebDAVServer<'a> { pub fn on_read_attribute(&self) -> &'a dyn WebDAVServerReadAttributeEvent; pub fn set_on_read_attribute(&mut self, value : &'a dyn WebDAVServerReadAttributeEvent); ... } ``` ## Remarks The struct fires this event to request value of the *NS:Name* attribute of the object residing at *Path*. In the event handler, pass the attribute value via the *Value* parameter and set *OperationStatus* as required. This event only fires if *fraCustom* action type was returned from the preceding [on_before_browse](#on_before_browse-event-webdavserver-struct) event call. | | | | | --- | --- | --- | | ostOk | 1 | | | ostNoSuchFile | 2 | | | ostAccessDenied | 3 | | | ostWriteProtect | 4 | | | ostUnsupported | 5 | | | ostInvalidParameter | 6 | | | ostEOF | 7 | | # on_read_object event ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Requests a piece of object data from the application. ## Syntax *Rust Syntax* ```text // WebDAVServerReadObjectEventArgs carries the WebDAVServer ReadObject event's parameters. pub struct WebDAVServerReadObjectEventArgs { fn connection_id(&self) -> i64 fn size(&self) -> i32 fn operation_status(&self) -> i32 fn set_operation_status(&self, value : i32) } // WebDAVServerReadObjectEvent defines the signature of the WebDAVServer ReadObject event's handler function. pub trait WebDAVServerReadObjectEvent { fn on_read_object(&self, sender : WebDAVServer, e : &mut WebDAVServerReadObjectEventArgs); } impl <'a> WebDAVServer<'a> { pub fn on_read_object(&self) -> &'a dyn WebDAVServerReadObjectEvent; pub fn set_on_read_object(&mut self, value : &'a dyn WebDAVServerReadObjectEvent); ... } ``` ## Remarks The struct fires this event repeatedly during an overridden download operation to request object data from the application. The handler of this event should read up to *Size* bytes from the downloaded object, and pass them to the component with a [set_client_buffer](#set_client_buffer-method-webdavserver-struct) call. Use the *OperationStatus* parameter to return the operation result back to the server. Set *OperationStatus* to one of the following values: | | | | | --- | --- | --- | | ostOk | 1 | | | ostNoSuchFile | 2 | | | ostAccessDenied | 3 | | | ostWriteProtect | 4 | | | ostUnsupported | 5 | | | ostInvalidParameter | 6 | | | ostEOF | 7 | | # on_refresh_lock event ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Notifies the application about a lock refresh request. ## Syntax *Rust Syntax* ```text // WebDAVServerRefreshLockEventArgs carries the WebDAVServer RefreshLock event's parameters. pub struct WebDAVServerRefreshLockEventArgs { fn connection_id(&self) -> i64 fn path(&self) -> &String fn token(&self) -> &String fn timeout(&self) -> i64 fn lock_found(&self) -> bool fn set_lock_found(&self, value : bool) } // WebDAVServerRefreshLockEvent defines the signature of the WebDAVServer RefreshLock event's handler function. pub trait WebDAVServerRefreshLockEvent { fn on_refresh_lock(&self, sender : WebDAVServer, e : &mut WebDAVServerRefreshLockEventArgs); } impl <'a> WebDAVServer<'a> { pub fn on_refresh_lock(&self) -> &'a dyn WebDAVServerRefreshLockEvent; pub fn set_on_refresh_lock(&mut self, value : &'a dyn WebDAVServerRefreshLockEvent); ... } ``` ## Remarks The struct uses this event to request extension of a lock on the object at *Path*. This event only fires if *fraCustom* action was returned from the preceding [on_before_refresh_lock](#on_before_refresh_lock-event-webdavserver-struct) call. In response to this event, check the validity of the provided *Token* for the object at *Path*, and extend the lock by *Timeout* milliseconds if the values match. Set the *LockFound* result as required. # on_remove_object event ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Notifies the application about object deletion requests. ## Syntax *Rust Syntax* ```text // WebDAVServerRemoveObjectEventArgs carries the WebDAVServer RemoveObject event's parameters. pub struct WebDAVServerRemoveObjectEventArgs { fn connection_id(&self) -> i64 fn path(&self) -> &String fn operation_status(&self) -> i32 fn set_operation_status(&self, value : i32) } // WebDAVServerRemoveObjectEvent defines the signature of the WebDAVServer RemoveObject event's handler function. pub trait WebDAVServerRemoveObjectEvent { fn on_remove_object(&self, sender : WebDAVServer, e : &mut WebDAVServerRemoveObjectEventArgs); } impl <'a> WebDAVServer<'a> { pub fn on_remove_object(&self) -> &'a dyn WebDAVServerRemoveObjectEvent; pub fn set_on_remove_object(&mut self, value : &'a dyn WebDAVServerRemoveObjectEvent); ... } ``` ## Remarks The struct uses this event to notify the application about an incoming deletion request for the object at *Path*. This event only fires if *fraCustom* action was returned from the preceding [on_before_remove_object](#on_before_remove_object-event-webdavserver-struct) call. The handler of this event should remove the object, if appropriate, and set the *OperationStatus* parameter to signify the actual operation result. | | | | | --- | --- | --- | | ostOk | 1 | | | ostNoSuchFile | 2 | | | ostAccessDenied | 3 | | | ostWriteProtect | 4 | | | ostUnsupported | 5 | | | ostInvalidParameter | 6 | | | ostEOF | 7 | | # on_rename_object event ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Notifies the application about object name change requests. ## Syntax *Rust Syntax* ```text // WebDAVServerRenameObjectEventArgs carries the WebDAVServer RenameObject event's parameters. pub struct WebDAVServerRenameObjectEventArgs { fn connection_id(&self) -> i64 fn old_path(&self) -> &String fn new_path(&self) -> &String fn overwrite(&self) -> bool fn operation_status(&self) -> i32 fn set_operation_status(&self, value : i32) } // WebDAVServerRenameObjectEvent defines the signature of the WebDAVServer RenameObject event's handler function. pub trait WebDAVServerRenameObjectEvent { fn on_rename_object(&self, sender : WebDAVServer, e : &mut WebDAVServerRenameObjectEventArgs); } impl <'a> WebDAVServer<'a> { pub fn on_rename_object(&self) -> &'a dyn WebDAVServerRenameObjectEvent; pub fn set_on_rename_object(&mut self, value : &'a dyn WebDAVServerRenameObjectEvent); ... } ``` ## Remarks The struct uses this event to notify the application about an incoming rename request for the object at *OldPath*. The *Overwrite* parameter advises whether any objects currently existing at *NewPath* should be overwritten. This event only fires if *fraCustom* action was returned from the preceding [on_before_rename_object](#on_before_rename_object-event-webdavserver-struct) call. The handler of this event should rename the object to *NewPath* (if appropriate) and set the *OperationStatus* parameter to signify the actual operation result. | | | | | --- | --- | --- | | ostOk | 1 | | | ostNoSuchFile | 2 | | | ostAccessDenied | 3 | | | ostWriteProtect | 4 | | | ostUnsupported | 5 | | | ostInvalidParameter | 6 | | | ostEOF | 7 | | # on_resource_access event ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Reports an attempt to access a resource. ## Syntax *Rust Syntax* ```text // WebDAVServerResourceAccessEventArgs carries the WebDAVServer ResourceAccess event's parameters. pub struct WebDAVServerResourceAccessEventArgs { fn connection_id(&self) -> i64 fn http_method(&self) -> &String fn uri(&self) -> &String fn allow(&self) -> bool fn set_allow(&self, value : bool) fn redirect_uri(&self) -> &String fn set_redirect_uri(&self, value : &str) fn set_redirect_uri_ref(&self, value : &String) } // WebDAVServerResourceAccessEvent defines the signature of the WebDAVServer ResourceAccess event's handler function. pub trait WebDAVServerResourceAccessEvent { fn on_resource_access(&self, sender : WebDAVServer, e : &mut WebDAVServerResourceAccessEventArgs); } impl <'a> WebDAVServer<'a> { pub fn on_resource_access(&self) -> &'a dyn WebDAVServerResourceAccessEvent; pub fn set_on_resource_access(&mut self, value : &'a dyn WebDAVServerResourceAccessEvent); ... } ``` ## Remarks The struct fires this event to notify the application about a request received from the client. The *HTTPMethod* parameter indicates the HTTP method used (GET, POST, etc.) *ConnectionID* indicates the connection that sent the request and *URI* suggests the requested resource. Set *Allow* to false to prevent the client from accessing the resource. The struct will automatically send a "forbidden" status code (403). Set a non-empty value to *RedirectURI* to notify the client that the resource has moved to another place. The struct will automatically send a "found" status code (302). If *Allow* is set to false, the value of *RedirectURI* is ignored. # on_set_attribute event ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Lets the application customize attribute assignment requests. ## Syntax *Rust Syntax* ```text // WebDAVServerSetAttributeEventArgs carries the WebDAVServer SetAttribute event's parameters. pub struct WebDAVServerSetAttributeEventArgs { fn connection_id(&self) -> i64 fn path(&self) -> &String fn ns(&self) -> &String fn name(&self) -> &String fn value(&self) -> &String fn operation_status(&self) -> i32 fn set_operation_status(&self, value : i32) } // WebDAVServerSetAttributeEvent defines the signature of the WebDAVServer SetAttribute event's handler function. pub trait WebDAVServerSetAttributeEvent { fn on_set_attribute(&self, sender : WebDAVServer, e : &mut WebDAVServerSetAttributeEventArgs); } impl <'a> WebDAVServer<'a> { pub fn on_set_attribute(&self) -> &'a dyn WebDAVServerSetAttributeEvent; pub fn set_on_set_attribute(&mut self, value : &'a dyn WebDAVServerSetAttributeEvent); ... } ``` ## Remarks The struct uses this event to pass attribute assignment requests to the application. This event may fire multiple times after a [on_before_set_attributes](#on_before_set_attributes-event-webdavserver-struct) call, one for each attribute, if *fraCustom* action was chosen. In the handler of this event, assign *Value* to the attribute *NS:Name* of the object at *Path*. Set *OperationStatus* in accordance with the outcome of the operation. | | | | | --- | --- | --- | | ostOk | 1 | | | ostNoSuchFile | 2 | | | ostAccessDenied | 3 | | | ostWriteProtect | 4 | | | ostUnsupported | 5 | | | ostInvalidParameter | 6 | | | ostEOF | 7 | | # on_tls_cert_validate event ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Fires when a client certificate needs to be validated. ## Syntax *Rust Syntax* ```text // WebDAVServerTLSCertValidateEventArgs carries the WebDAVServer TLSCertValidate event's parameters. pub struct WebDAVServerTLSCertValidateEventArgs { fn connection_id(&self) -> i64 fn accept(&self) -> bool fn set_accept(&self, value : bool) } // WebDAVServerTLSCertValidateEvent defines the signature of the WebDAVServer TLSCertValidate event's handler function. pub trait WebDAVServerTLSCertValidateEvent { fn on_tls_cert_validate(&self, sender : WebDAVServer, e : &mut WebDAVServerTLSCertValidateEventArgs); } impl <'a> WebDAVServer<'a> { pub fn on_tls_cert_validate(&self) -> &'a dyn WebDAVServerTLSCertValidateEvent; pub fn set_on_tls_cert_validate(&mut self, value : &'a dyn WebDAVServerTLSCertValidateEvent); ... } ``` ## Remarks 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 ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Reports the setup of a TLS session. ## Syntax *Rust Syntax* ```text // WebDAVServerTLSEstablishedEventArgs carries the WebDAVServer TLSEstablished event's parameters. pub struct WebDAVServerTLSEstablishedEventArgs { fn connection_id(&self) -> i64 } // WebDAVServerTLSEstablishedEvent defines the signature of the WebDAVServer TLSEstablished event's handler function. pub trait WebDAVServerTLSEstablishedEvent { fn on_tls_established(&self, sender : WebDAVServer, e : &mut WebDAVServerTLSEstablishedEventArgs); } impl <'a> WebDAVServer<'a> { pub fn on_tls_established(&self) -> &'a dyn WebDAVServerTLSEstablishedEvent; pub fn set_on_tls_established(&mut self, value : &'a dyn WebDAVServerTLSEstablishedEvent); ... } ``` ## Remarks Subscribe to this event to be notified about the setup of a TLS connection by a connected client. # on_tls_handshake event ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Fires when a newly established client connection initiates a TLS handshake. ## Syntax *Rust Syntax* ```text // WebDAVServerTLSHandshakeEventArgs carries the WebDAVServer TLSHandshake event's parameters. pub struct WebDAVServerTLSHandshakeEventArgs { fn connection_id(&self) -> i64 fn server_name(&self) -> &String fn abort(&self) -> bool fn set_abort(&self, value : bool) } // WebDAVServerTLSHandshakeEvent defines the signature of the WebDAVServer TLSHandshake event's handler function. pub trait WebDAVServerTLSHandshakeEvent { fn on_tls_handshake(&self, sender : WebDAVServer, e : &mut WebDAVServerTLSHandshakeEventArgs); } impl <'a> WebDAVServer<'a> { pub fn on_tls_handshake(&self) -> &'a dyn WebDAVServerTLSHandshakeEvent; pub fn set_on_tls_handshake(&mut self, value : &'a dyn WebDAVServerTLSHandshakeEvent); ... } ``` ## 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 ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Requests a pre-shared key for TLS-PSK. ## Syntax *Rust Syntax* ```text // WebDAVServerTLSPSKEventArgs carries the WebDAVServer TLSPSK event's parameters. pub struct WebDAVServerTLSPSKEventArgs { 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) } // WebDAVServerTLSPSKEvent defines the signature of the WebDAVServer TLSPSK event's handler function. pub trait WebDAVServerTLSPSKEvent { fn on_tls_psk(&self, sender : WebDAVServer, e : &mut WebDAVServerTLSPSKEventArgs); } impl <'a> WebDAVServer<'a> { pub fn on_tls_psk(&self) -> &'a dyn WebDAVServerTLSPSKEvent; pub fn set_on_tls_psk(&mut self, value : &'a dyn WebDAVServerTLSPSKEvent); ... } ``` ## 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 ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Reports closure of a TLS session. ## Syntax *Rust Syntax* ```text // WebDAVServerTLSShutdownEventArgs carries the WebDAVServer TLSShutdown event's parameters. pub struct WebDAVServerTLSShutdownEventArgs { fn connection_id(&self) -> i64 } // WebDAVServerTLSShutdownEvent defines the signature of the WebDAVServer TLSShutdown event's handler function. pub trait WebDAVServerTLSShutdownEvent { fn on_tls_shutdown(&self, sender : WebDAVServer, e : &mut WebDAVServerTLSShutdownEventArgs); } impl <'a> WebDAVServer<'a> { pub fn on_tls_shutdown(&self) -> &'a dyn WebDAVServerTLSShutdownEvent; pub fn set_on_tls_shutdown(&mut self, value : &'a dyn WebDAVServerTLSShutdownEvent); ... } ``` ## 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-webdavserver-struct), which marks the closure of the underlying TCP session. # on_unlock_object event ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Virtualizes the object unlocking operation. ## Syntax *Rust Syntax* ```text // WebDAVServerUnlockObjectEventArgs carries the WebDAVServer UnlockObject event's parameters. pub struct WebDAVServerUnlockObjectEventArgs { fn connection_id(&self) -> i64 fn path(&self) -> &String fn token(&self) -> &String fn lock_found(&self) -> bool fn set_lock_found(&self, value : bool) } // WebDAVServerUnlockObjectEvent defines the signature of the WebDAVServer UnlockObject event's handler function. pub trait WebDAVServerUnlockObjectEvent { fn on_unlock_object(&self, sender : WebDAVServer, e : &mut WebDAVServerUnlockObjectEventArgs); } impl <'a> WebDAVServer<'a> { pub fn on_unlock_object(&self) -> &'a dyn WebDAVServerUnlockObjectEvent; pub fn set_on_unlock_object(&mut self, value : &'a dyn WebDAVServerUnlockObjectEvent); ... } ``` ## Remarks The struct uses this event to notify the application of the incoming unlock request. This event only fires if *fraCustom* action was returned from the preceding [on_before_unlock_object](#on_before_unlock_object-event-webdavserver-struct) call. In response to this event, check the validity of the provided *Token* for the object at *Path*, and cancel the lock if the values match. Set the *LockFound* result as required. # on_upload_object event ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Lets the application respond to the Upload Object request. ## Syntax *Rust Syntax* ```text // WebDAVServerUploadObjectEventArgs carries the WebDAVServer UploadObject event's parameters. pub struct WebDAVServerUploadObjectEventArgs { fn connection_id(&self) -> i64 fn path(&self) -> &String fn restart_at(&self) -> i64 fn append(&self) -> bool fn operation_status(&self) -> i32 fn set_operation_status(&self, value : i32) } // WebDAVServerUploadObjectEvent defines the signature of the WebDAVServer UploadObject event's handler function. pub trait WebDAVServerUploadObjectEvent { fn on_upload_object(&self, sender : WebDAVServer, e : &mut WebDAVServerUploadObjectEventArgs); } impl <'a> WebDAVServer<'a> { pub fn on_upload_object(&self) -> &'a dyn WebDAVServerUploadObjectEvent; pub fn set_on_upload_object(&mut self, value : &'a dyn WebDAVServerUploadObjectEvent); ... } ``` ## Remarks Use this event handler to respond to the received Upload Object request by reserving a place for the new object at *Path*. This event, if *OperationStatus* allows, will be followed by a series of [on_write_object](#on_write_object-event-webdavserver-struct) calls, passing object data in chunks, before a [on_upload_object_completed](#on_upload_object_completed-event-webdavserver-struct) call signals completion of the upload operation. Check the operation status, and alter it, if needed, through the *OperationStatus* parameter: | | | | | --- | --- | --- | | ostOk | 1 | | | ostNoSuchFile | 2 | | | ostAccessDenied | 3 | | | ostWriteProtect | 4 | | | ostUnsupported | 5 | | | ostInvalidParameter | 6 | | | ostEOF | 7 | | # on_upload_object_completed event ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) This event is fired when a upload operation completes. ## Syntax *Rust Syntax* ```text // WebDAVServerUploadObjectCompletedEventArgs carries the WebDAVServer UploadObjectCompleted event's parameters. pub struct WebDAVServerUploadObjectCompletedEventArgs { fn connection_id(&self) -> i64 fn path(&self) -> &String fn operation_status(&self) -> i32 fn set_operation_status(&self, value : i32) } // WebDAVServerUploadObjectCompletedEvent defines the signature of the WebDAVServer UploadObjectCompleted event's handler function. pub trait WebDAVServerUploadObjectCompletedEvent { fn on_upload_object_completed(&self, sender : WebDAVServer, e : &mut WebDAVServerUploadObjectCompletedEventArgs); } impl <'a> WebDAVServer<'a> { pub fn on_upload_object_completed(&self) -> &'a dyn WebDAVServerUploadObjectCompletedEvent; pub fn set_on_upload_object_completed(&mut self, value : &'a dyn WebDAVServerUploadObjectCompletedEvent); ... } ``` ## Remarks This event is fired when a upload operation completes. This event is only fired for operations handled by the user code, i.e. those intercepted with on_before_upload_file event, and with Action parameter set to fraCustom. The *ConnectionID* parameter specifies the session to which the event belongs, and *OperationStatus* reports the outcome of the transfer operation. | | | | | --- | --- | --- | | ostOk | 1 | | | ostNoSuchFile | 2 | | | ostAccessDenied | 3 | | | ostWriteProtect | 4 | | | ostUnsupported | 5 | | | ostInvalidParameter | 6 | | | ostEOF | 7 | | # on_write_object event ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) Hands a piece of object data to the application. ## Syntax *Rust Syntax* ```text // WebDAVServerWriteObjectEventArgs carries the WebDAVServer WriteObject event's parameters. pub struct WebDAVServerWriteObjectEventArgs { fn connection_id(&self) -> i64 fn operation_status(&self) -> i32 fn set_operation_status(&self, value : i32) } // WebDAVServerWriteObjectEvent defines the signature of the WebDAVServer WriteObject event's handler function. pub trait WebDAVServerWriteObjectEvent { fn on_write_object(&self, sender : WebDAVServer, e : &mut WebDAVServerWriteObjectEventArgs); } impl <'a> WebDAVServer<'a> { pub fn on_write_object(&self) -> &'a dyn WebDAVServerWriteObjectEvent; pub fn set_on_write_object(&mut self, value : &'a dyn WebDAVServerWriteObjectEvent); ... } ``` ## Remarks The struct fires this event repeatedly during an overridden upload operation to pass object data to the application. The handler of this event should retrieve the pending data buffer with a [get_client_buffer](#get_client_buffer-method-webdavserver-struct) call, and write it to the end of the object that is being uploaded. Use the *OperationStatus* parameter to return the operation result back to the server. Set *OperationStatus* to one of the following values: | | | | | --- | --- | --- | | ostOk | 1 | | | ostNoSuchFile | 2 | | | ostAccessDenied | 3 | | | ostWriteProtect | 4 | | | ostUnsupported | 5 | | | ostInvalidParameter | 6 | | | ostEOF | 7 | | # Config Settings ([WebDAVServer](#struct-secureblackboxwebdavserver) 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-webdavserver-struct) method. ### WebDAVServer Config Settings **BoundAddress**: Returns the bound address of the listening socket.Use this property to obtain the bound address of the listening socket. **BoundPort**: The port that was bound by the server.Returns the port number that was bound by the server. **DualStack**: Allows the use of ip4 and ip6 simultaneously.This setting specifies a socket can use ip4 and ip6 simultaneously. **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. **HTTPStatusCode[i]**: Provides means to set a custom HTTP status code.Use this indexed property to set a custom HTTP status code for a specific client. **Port**: The port to listen on.This config setting mimics the Port property. Please use that instead. **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. **PreSharedIdentityHint**: Gets or sets the PSK identity hint.Use this property to get or set the PSK identity hint to be used during PSK-based TLS handshake. **SessionTimeout**: The HTTP session timeout.The HTTP session timeout in milliseconds. **SleepLen**: Adjusts the server loop idling time.Use this property to adjust the server connection loop idling time between consecutive connection read calls. Increasing this setting may help combat excessive CPU usage in performance-restricted or busy environments. Setting it to zero removes the idling altogether, which maximizes the throughput but may cause excessive CPU load. **TLSCiphersuites**: Returns the list of ciphersuites activated in the component for the current session.Check this property to enumerate the list of TLS ciphersuites enabled in the component. A good place to do that is OnTLSHandshake event handler. **TLSExtensions**: TBD.TBD **TLSGroups**: Returns the list of TLS key exchange groups enabled in the component.Check this property to enumerate the list of TLS key exchange groups enabled in the component. **TLSPeerExtensions**: TBD.TBD **TLSServerCertIndex**: Specifies the index of the server certificate to use.This setting allows your code to specify the exact certificate/chain to use for the TLS handshake that has just commenced, if your server is configured with more than one chain. This property should typically be adjusted from within the OnTLSHandshake event handler. Note: the server component normally picks up the most appropriate certificate automatically. This setting is a wiretap for scenarios where unusual or cherry-picked certificate selection logic may be necessary. **TLSVersions**: Returns the list of TLS versions enabled in the component.Check this property to obtain the list of TLS versions enabled in the component, as an integer bitmask. **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 ([WebDAVServer](#struct-secureblackboxwebdavserver) Struct) ### WebDAVServer Errors | | | | --- | --- | | 1048577 | Invalid parameter ([SB_ERROR_INVALID_PARAMETER](constants.md#const_SBERRORINVALIDPARAMETER)) | | 1048578 | Invalid configuration ([SB_ERROR_INVALID_SETUP](constants.md#const_SBERRORINVALIDSETUP)) | | 1048579 | Invalid state ([SB_ERROR_INVALID_STATE](constants.md#const_SBERRORINVALIDSTATE)) | | 1048580 | Invalid value ([SB_ERROR_INVALID_VALUE](constants.md#const_SBERRORINVALIDVALUE)) | | 1048581 | Private key not found ([SB_ERROR_NO_PRIVATE_KEY](constants.md#const_SBERRORNOPRIVATEKEY)) | | 1048582 | Cancelled by the user ([SB_ERROR_CANCELLED_BY_USER](constants.md#const_SBERRORCANCELLEDBYUSER)) | | 1048583 | The file was not found ([SB_ERROR_NO_SUCH_FILE](constants.md#const_SBERRORNOSUCHFILE)) | | 1048584 | Unsupported feature or operation ([SB_ERROR_UNSUPPORTED_FEATURE](constants.md#const_SBERRORUNSUPPORTEDFEATURE)) | | 1048585 | General error ([SB_ERROR_GENERAL_ERROR](constants.md#const_SBERRORGENERALERROR)) |