# Struct secureblackbox::FTPServer The FTPServer struct provides server-side functionality for FTP and FTPS protocols. ## Syntax ```text secureblackbox::FTPServer ``` ## Remarks FTPServer supports FTP (File Transfer Protocol) and FTPS (FTP-over-SSL) protocols. The FTPS protocol allows you to securely perform file transfer operations on the server over Transport Layer Security (TLS). TLS is a successor to the now deprecated SSL protocol, although the latter abbreviation is still widely used. ### 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 FTPServer struct cannot be disposed of automatically. Please, call the *dispose(&mut; self)* method of FTPServer 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-ftpserver-struct) | Whether the server is active and can accept incoming connections. | | [allow_anonymous](#allow_anonymous-property-ftpserver-struct) | Allows and disallows anonymous connections. | | [client_file_entry_access_time](#client_file_entry_access_time-property-ftpserver-struct) | Contains the last access time for this file, in UTC. | | [client_file_entry_creation_time](#client_file_entry_creation_time-property-ftpserver-struct) | Contains this file's creation time, in UTC. | | [client_file_entry_entry_format](#client_file_entry_entry_format-property-ftpserver-struct) | The file listing format: cfefUnknown 0 cfefUnix 1 cfefWindows 2 cfefMLSD 3 . | | [client_file_entry_file_type](#client_file_entry_file_type-property-ftpserver-struct) | The type of the entry: fetUnknown 0 fetDirectory 1 fetFile 2 fetSymlink 3 fetSpecial 4 fetCurrentDirectory 5 fetParentDirectory 6 fetSocket 7 fetCharDevice 8 fetBlockDevice 9 fetFIFO 10 . | | [client_file_entry_handle](#client_file_entry_handle-property-ftpserver-struct) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [client_file_entry_modification_time](#client_file_entry_modification_time-property-ftpserver-struct) | File last modification date/time. | | [client_file_entry_name](#client_file_entry_name-property-ftpserver-struct) | The file or directory name. | | [client_file_entry_path](#client_file_entry_path-property-ftpserver-struct) | The full path to the file or directory. | | [client_file_entry_principal](#client_file_entry_principal-property-ftpserver-struct) | Specifies the owner of the file/directory. | | [client_file_entry_size](#client_file_entry_size-property-ftpserver-struct) | File size in bytes. | | [client_file_entry_unix_perms](#client_file_entry_unix_perms-property-ftpserver-struct) | The file Unix permissions bit mask (e. | | [client_file_entry_unparsed_name](#client_file_entry_unparsed_name-property-ftpserver-struct) | The unparsed entry as returned by the server. | | [data_host](#data_host-property-ftpserver-struct) | Host address for incoming data channel connections. | | [data_port_range_from](#data_port_range_from-property-ftpserver-struct) | Specifies the lower port range bound for passive mode data connections. | | [data_port_range_to](#data_port_range_to-property-ftpserver-struct) | Specifies the upper port range bound for passive mode data connections. | | [external_crypto_async_document_id](#external_crypto_async_document_id-property-ftpserver-struct) | Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls. | | [external_crypto_custom_params](#external_crypto_custom_params-property-ftpserver-struct) | Custom parameters to be passed to the signing service (uninterpreted). | | [external_crypto_data](#external_crypto_data-property-ftpserver-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-ftpserver-struct) | Specifies whether the message hash is to be calculated at the external endpoint. | | [external_crypto_hash_algorithm](#external_crypto_hash_algorithm-property-ftpserver-struct) | Specifies the request's signature hash algorithm. | | [external_crypto_key_id](#external_crypto_key_id-property-ftpserver-struct) | The ID of the pre-shared key used for DC request authentication. | | [external_crypto_key_secret](#external_crypto_key_secret-property-ftpserver-struct) | The pre-shared key used for DC request authentication. | | [external_crypto_method](#external_crypto_method-property-ftpserver-struct) | Specifies the asynchronous signing method. | | [external_crypto_mode](#external_crypto_mode-property-ftpserver-struct) | Specifies the external cryptography mode. | | [external_crypto_public_key_algorithm](#external_crypto_public_key_algorithm-property-ftpserver-struct) | Provide the public key algorithm here if the certificate is not available on the pre-signing stage. | | [fips_mode](#fips_mode-property-ftpserver-struct) | Reserved. | | [handshake_timeout](#handshake_timeout-property-ftpserver-struct) | Specifies the handshake timeout in milliseconds. | | [host](#host-property-ftpserver-struct) | Specifies the server host. | | [implicit_ssl](#implicit_ssl-property-ftpserver-struct) | Enables or disables implicit SSL mode. | | [passive_mode_host](#passive_mode_host-property-ftpserver-struct) | The IP address of the passive mode host. | | [pinned_client_aead_cipher](#pinned_client_aead_cipher-property-ftpserver-struct) | Indicates whether the encryption algorithm used is an AEAD cipher. | | [pinned_client_chain_validation_details](#pinned_client_chain_validation_details-property-ftpserver-struct) | The details of a certificate chain validation outcome. | | [pinned_client_chain_validation_result](#pinned_client_chain_validation_result-property-ftpserver-struct) | The outcome of a certificate chain validation routine. | | [pinned_client_ciphersuite](#pinned_client_ciphersuite-property-ftpserver-struct) | The cipher suite employed by this connection. | | [pinned_client_client_authenticated](#pinned_client_client_authenticated-property-ftpserver-struct) | Specifies whether client authentication was performed during this connection. | | [pinned_client_client_auth_requested](#pinned_client_client_auth_requested-property-ftpserver-struct) | Specifies whether client authentication was requested during this connection. | | [pinned_client_connection_established](#pinned_client_connection_established-property-ftpserver-struct) | Indicates whether the connection has been established fully. | | [pinned_client_connection_id](#pinned_client_connection_id-property-ftpserver-struct) | The unique identifier assigned to this connection. | | [pinned_client_digest_algorithm](#pinned_client_digest_algorithm-property-ftpserver-struct) | The digest algorithm used in a TLS-enabled connection. | | [pinned_client_encryption_algorithm](#pinned_client_encryption_algorithm-property-ftpserver-struct) | The symmetric encryption algorithm used in a TLS-enabled connection. | | [pinned_client_exportable](#pinned_client_exportable-property-ftpserver-struct) | Indicates whether a TLS connection uses a reduced-strength exportable cipher. | | [pinned_client_group](#pinned_client_group-property-ftpserver-struct) | The elliptic curve used in this connection. | | [pinned_client_id](#pinned_client_id-property-ftpserver-struct) | The client connection's unique identifier. | | [pinned_client_key_exchange_algorithm](#pinned_client_key_exchange_algorithm-property-ftpserver-struct) | The key exchange algorithm used in a TLS-enabled connection. | | [pinned_client_key_exchange_key_bits](#pinned_client_key_exchange_key_bits-property-ftpserver-struct) | The length of the key exchange key of a TLS-enabled connection. | | [pinned_client_pfs_cipher](#pinned_client_pfs_cipher-property-ftpserver-struct) | Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS). | | [pinned_client_pre_shared_identity](#pinned_client_pre_shared_identity-property-ftpserver-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-ftpserver-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-ftpserver-struct) | The length of the public key. | | [pinned_client_remote_address](#pinned_client_remote_address-property-ftpserver-struct) | The client's IP address. | | [pinned_client_remote_port](#pinned_client_remote_port-property-ftpserver-struct) | The remote port of the client connection. | | [pinned_client_resumed_session](#pinned_client_resumed_session-property-ftpserver-struct) | Indicates whether a TLS-enabled connection was spawned from another TLS connection. | | [pinned_client_secure_connection](#pinned_client_secure_connection-property-ftpserver-struct) | Indicates whether TLS or SSL is enabled for this connection. | | [pinned_client_server_authenticated](#pinned_client_server_authenticated-property-ftpserver-struct) | Indicates whether server authentication was performed during a TLS-enabled connection. | | [pinned_client_signature_algorithm](#pinned_client_signature_algorithm-property-ftpserver-struct) | The signature algorithm used in a TLS handshake. | | [pinned_client_symmetric_block_size](#pinned_client_symmetric_block_size-property-ftpserver-struct) | The block size of the symmetric algorithm used. | | [pinned_client_symmetric_key_bits](#pinned_client_symmetric_key_bits-property-ftpserver-struct) | The key length of the symmetric algorithm used. | | [pinned_client_total_bytes_received](#pinned_client_total_bytes_received-property-ftpserver-struct) | The total number of bytes received over this connection. | | [pinned_client_total_bytes_sent](#pinned_client_total_bytes_sent-property-ftpserver-struct) | The total number of bytes sent over this connection. | | [pinned_client_validation_log](#pinned_client_validation_log-property-ftpserver-struct) | Contains the server certificate's chain validation log. | | [pinned_client_version](#pinned_client_version-property-ftpserver-struct) | Indicates the version of SSL/TLS protocol negotiated during this connection. | | [pinned_client_cert_count](#pinned_client_cert_count-property-ftpserver-struct) | The number of records in the PinnedClientCert arrays. | | [pinned_client_cert_bytes](#pinned_client_cert_bytes-property-ftpserver-struct) | Returns the raw certificate data in DER format. | | [pinned_client_cert_ca_key_id](#pinned_client_cert_ca_key_id-property-ftpserver-struct) | A unique identifier (fingerprint) of the CA certificate's cryptographic key. | | [pinned_client_cert_fingerprint](#pinned_client_cert_fingerprint-property-ftpserver-struct) | Contains the fingerprint (a hash imprint) of this certificate. | | [pinned_client_cert_handle](#pinned_client_cert_handle-property-ftpserver-struct) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [pinned_client_cert_issuer](#pinned_client_cert_issuer-property-ftpserver-struct) | The common name of the certificate issuer (CA), typically a company name. | | [pinned_client_cert_issuer_rdn](#pinned_client_cert_issuer_rdn-property-ftpserver-struct) | A list of Property=Value pairs that uniquely identify the certificate issuer. | | [pinned_client_cert_key_algorithm](#pinned_client_cert_key_algorithm-property-ftpserver-struct) | Specifies the public key algorithm of this certificate. | | [pinned_client_cert_key_bits](#pinned_client_cert_key_bits-property-ftpserver-struct) | Returns the length of the public key in bits. | | [pinned_client_cert_key_fingerprint](#pinned_client_cert_key_fingerprint-property-ftpserver-struct) | Returns a SHA1 fingerprint of the public key contained in the certificate. | | [pinned_client_cert_key_usage](#pinned_client_cert_key_usage-property-ftpserver-struct) | Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. | | [pinned_client_cert_public_key_bytes](#pinned_client_cert_public_key_bytes-property-ftpserver-struct) | Contains the certificate's public key in DER format. | | [pinned_client_cert_self_signed](#pinned_client_cert_self_signed-property-ftpserver-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-ftpserver-struct) | Returns the certificate's serial number. | | [pinned_client_cert_sig_algorithm](#pinned_client_cert_sig_algorithm-property-ftpserver-struct) | Indicates the algorithm that was used by the CA to sign this certificate. | | [pinned_client_cert_subject](#pinned_client_cert_subject-property-ftpserver-struct) | The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. | | [pinned_client_cert_subject_key_id](#pinned_client_cert_subject_key_id-property-ftpserver-struct) | Contains a unique identifier of the certificate's cryptographic key. | | [pinned_client_cert_subject_rdn](#pinned_client_cert_subject_rdn-property-ftpserver-struct) | A list of Property=Value pairs that uniquely identify the certificate holder (subject). | | [pinned_client_cert_valid_from](#pinned_client_cert_valid_from-property-ftpserver-struct) | The time point at which the certificate becomes valid, in UTC. | | [pinned_client_cert_valid_to](#pinned_client_cert_valid_to-property-ftpserver-struct) | The time point at which the certificate expires, in UTC. | | [port](#port-property-ftpserver-struct) | The port number to listen for incoming connections on. | | [read_only](#read_only-property-ftpserver-struct) | Makes the server's file system read-only for all users. | | [root_directory](#root_directory-property-ftpserver-struct) | Specifies the server's root directory. | | [security_options](#security_options-property-ftpserver-struct) | Various options of the secure connection. | | [session_timeout](#session_timeout-property-ftpserver-struct) | Specifies the session timeout in milliseconds. | | [socket_incoming_speed_limit](#socket_incoming_speed_limit-property-ftpserver-struct) | The maximum number of bytes to read from the socket, per second. | | [socket_local_address](#socket_local_address-property-ftpserver-struct) | The local network interface to bind the socket to. | | [socket_local_port](#socket_local_port-property-ftpserver-struct) | The local port number to bind the socket to. | | [socket_outgoing_speed_limit](#socket_outgoing_speed_limit-property-ftpserver-struct) | The maximum number of bytes to write to the socket, per second. | | [socket_timeout](#socket_timeout-property-ftpserver-struct) | The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful. | | [socket_use_ipv6](#socket_use_ipv6-property-ftpserver-struct) | Enables or disables IP protocol version 6. | | [tls_server_cert_count](#tls_server_cert_count-property-ftpserver-struct) | The number of records in the TLSServerCert arrays. | | [tls_server_cert_bytes](#tls_server_cert_bytes-property-ftpserver-struct) | Returns the raw certificate data in DER format. | | [tls_server_cert_handle](#tls_server_cert_handle-property-ftpserver-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-ftpserver-struct) | Specifies whether server-side TLS certificates should be validated automatically using internal validation rules. | | [tls_base_configuration](#tls_base_configuration-property-ftpserver-struct) | Selects the base configuration for the TLS settings. | | [tls_ciphersuites](#tls_ciphersuites-property-ftpserver-struct) | A list of ciphersuites separated with commas or semicolons. | | [tls_client_auth](#tls_client_auth-property-ftpserver-struct) | Enables or disables certificate-based client authentication. | | [tls_extensions](#tls_extensions-property-ftpserver-struct) | Provides access to TLS extensions. | | [tls_force_resume_if_destination_changes](#tls_force_resume_if_destination_changes-property-ftpserver-struct) | Whether to force TLS session resumption when the destination address changes. | | [tls_groups](#tls_groups-property-ftpserver-struct) | Specifies a list of key exchange groups to attempt during the TLS key exchange. | | [tls_pre_shared_identity](#tls_pre_shared_identity-property-ftpserver-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-ftpserver-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-ftpserver-struct) | Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation. | | [tls_renegotiation_attack_prevention_mode](#tls_renegotiation_attack_prevention_mode-property-ftpserver-struct) | Selects the renegotiation attack prevention mechanism. | | [tls_revocation_check](#tls_revocation_check-property-ftpserver-struct) | Specifies the kind(s) of revocation check to perform. | | [tls_ssl_options](#tls_ssl_options-property-ftpserver-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-ftpserver-struct) | Specifies the TLS mode to use. | | [tls_use_extended_master_secret](#tls_use_extended_master_secret-property-ftpserver-struct) | Enables the Extended Master Secret Extension, as defined in RFC 7627. | | [tls_use_session_resumption](#tls_use_session_resumption-property-ftpserver-struct) | Enables or disables the TLS session resumption capability. | | [tls_versions](#tls_versions-property-ftpserver-struct) | The SSL/TLS versions to enable by default. | | [user_count](#user_count-property-ftpserver-struct) | The number of records in the User arrays. | | [user_associated_data](#user_associated_data-property-ftpserver-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-ftpserver-struct) | Base path for this user in the server's file system. | | [user_data](#user_data-property-ftpserver-struct) | Contains uninterpreted user-defined data that should be associated with the user account, such as comments or custom settings. | | [user_handle](#user_handle-property-ftpserver-struct) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [user_hash_algorithm](#user_hash_algorithm-property-ftpserver-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-ftpserver-struct) | Specifies the incoming speed limit for this user. | | [user_outgoing_speed_limit](#user_outgoing_speed_limit-property-ftpserver-struct) | Specifies the outgoing speed limit for this user. | | [user_password](#user_password-property-ftpserver-struct) | The user's authentication password. | | [user_shared_secret](#user_shared_secret-property-ftpserver-struct) | Contains the user's secret key, which is essentially a shared secret between the client and server. | | [username](#username-property-ftpserver-struct) | The registered name (login) of the user. | | [use_utf8](#use_utf8-property-ftpserver-struct) | Enables or disables UTF8 file name conversions. | ## 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-ftpserver-struct) | Cleans up the server environment by purging expired sessions and cleaning caches. | | [config](#config-method-ftpserver-struct) | Sets or retrieves a configuration setting. | | [do_action](#do_action-method-ftpserver-struct) | Performs an additional action. | | [drop_client](#drop_client-method-ftpserver-struct) | Terminates a client connection. | | [get_client_buffer](#get_client_buffer-method-ftpserver-struct) | Obtains a pending connection buffer. | | [list_clients](#list_clients-method-ftpserver-struct) | Enumerates the connected clients. | | [pin_client](#pin_client-method-ftpserver-struct) | Takes a snapshot of the connection's properties. | | [reset](#reset-method-ftpserver-struct) | Resets the struct settings. | | [set_client_buffer](#set_client_buffer-method-ftpserver-struct) | Commits a data buffer to the connection. | | [set_client_file_entry](#set_client_file_entry-method-ftpserver-struct) | Commits a file entry to the connection. | | [start](#start-method-ftpserver-struct) | Starts the server. | | [stop](#stop-method-ftpserver-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-ftpserver-struct) | Reports an incoming connection. | | [on_after_change_directory](#on_after_change_directory-event-ftpserver-struct) | Signals the completion of a directory change operation. | | [on_after_create_directory](#on_after_create_directory-event-ftpserver-struct) | Signals the completion of a directory creation operation. | | [on_after_remove_directory](#on_after_remove_directory-event-ftpserver-struct) | Signals the completion of a directory removal operation. | | [on_after_remove_file](#on_after_remove_file-event-ftpserver-struct) | Signals the completion of a file removal operation. | | [on_after_rename_file](#on_after_rename_file-event-ftpserver-struct) | Signals the completion of a file renaming operation. | | [on_after_request_attributes](#on_after_request_attributes-event-ftpserver-struct) | Signals the completion of an attribute request. | | [on_auth_attempt](#on_auth_attempt-event-ftpserver-struct) | Fires when a connected client makes an authentication attempt. | | [on_before_change_directory](#on_before_change_directory-event-ftpserver-struct) | Notifies about an incoming change directory request. | | [on_before_create_directory](#on_before_create_directory-event-ftpserver-struct) | Notifies about an incoming create directory request. | | [on_before_download_file](#on_before_download_file-event-ftpserver-struct) | Notifies about an incoming file download request. | | [on_before_find](#on_before_find-event-ftpserver-struct) | Notifies about an incoming file listing request. | | [on_before_remove_directory](#on_before_remove_directory-event-ftpserver-struct) | Notifies about an incoming directory removal request. | | [on_before_remove_file](#on_before_remove_file-event-ftpserver-struct) | Notifies about an incoming file removal request. | | [on_before_rename_file](#on_before_rename_file-event-ftpserver-struct) | Notifies about an incoming file rename request. | | [on_before_request_attributes](#on_before_request_attributes-event-ftpserver-struct) | Notifies about an incoming attributes request. | | [on_before_send_reply](#on_before_send_reply-event-ftpserver-struct) | Notifies the application of a command reply being sent. | | [on_before_upload_file](#on_before_upload_file-event-ftpserver-struct) | Notifies about an incoming file upload request. | | [on_change_directory](#on_change_directory-event-ftpserver-struct) | An override for a directory change operation. | | [on_command_processed](#on_command_processed-event-ftpserver-struct) | Signals that a command has been processed by the server. | | [on_command_received](#on_command_received-event-ftpserver-struct) | Signals that a command has been received from the client. | | [on_connect](#on_connect-event-ftpserver-struct) | Reports an accepted connection. | | [on_create_directory](#on_create_directory-event-ftpserver-struct) | An override for a directory creation operation. | | [on_disconnect](#on_disconnect-event-ftpserver-struct) | Fires to report a disconnected client. | | [on_download_begin](#on_download_begin-event-ftpserver-struct) | The struct fires this event to notify the application about the start of a file download. | | [on_download_end](#on_download_end-event-ftpserver-struct) | Reports the completion of the download operation. | | [on_download_file](#on_download_file-event-ftpserver-struct) | An override for a file download initiation operation. | | [on_download_progress](#on_download_progress-event-ftpserver-struct) | Reports the progress of an active download operation. | | [on_error](#on_error-event-ftpserver-struct) | Information about errors during data delivery. | | [on_external_sign](#on_external_sign-event-ftpserver-struct) | Handles remote or external signing initiated by the server protocol. | | [on_find_close](#on_find_close-event-ftpserver-struct) | Signals the completion of a directory listing request. | | [on_find_init](#on_find_init-event-ftpserver-struct) | An override for a directory listing initiation operation. | | [on_find_next](#on_find_next-event-ftpserver-struct) | An override for a directory listing entry request operation. | | [on_notification](#on_notification-event-ftpserver-struct) | This event notifies the application about an underlying control flow event. | | [on_read_file](#on_read_file-event-ftpserver-struct) | Requests a piece of file data from the application. | | [on_remove_directory](#on_remove_directory-event-ftpserver-struct) | An override for a directory removal operation. | | [on_remove_file](#on_remove_file-event-ftpserver-struct) | An override for a file remove operation. | | [on_rename_file](#on_rename_file-event-ftpserver-struct) | An override for a file rename operation. | | [on_request_attributes](#on_request_attributes-event-ftpserver-struct) | An override for an attribute request. | | [on_tls_cert_validate](#on_tls_cert_validate-event-ftpserver-struct) | Fires when a client certificate needs to be validated. | | [on_tls_established](#on_tls_established-event-ftpserver-struct) | Reports the setup of a TLS session. | | [on_tls_handshake](#on_tls_handshake-event-ftpserver-struct) | Fires when a newly established client connection initiates a TLS handshake. | | [on_tls_psk](#on_tls_psk-event-ftpserver-struct) | Requests a pre-shared key for TLS-PSK. | | [on_tls_shutdown](#on_tls_shutdown-event-ftpserver-struct) | Reports closure of a TLS session. | | [on_transfer_completed](#on_transfer_completed-event-ftpserver-struct) | This event is fired when a customized upload or download operation completes. | | [on_upload_begin](#on_upload_begin-event-ftpserver-struct) | The server fires this event to notify the application about the start of a file upload operation. | | [on_upload_end](#on_upload_end-event-ftpserver-struct) | Reports the completion of the upload operation. | | [on_upload_file](#on_upload_file-event-ftpserver-struct) | An override for a file upload initiation operation. | | [on_upload_progress](#on_upload_progress-event-ftpserver-struct) | Reports the progress of an active upload operation. | | [on_write_file](#on_write_file-event-ftpserver-struct) | Hands a piece of file 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.* | | | | --- | --- | | [ActiveChannel](#ActiveChannel) | The channel to which the event that is being invoked corresponds. | | [ClientAuth](#ClientAuth) | Enables or disables certificate-based client authentication. | | [ControlChannelLog\[i\]](#ControlChannelLog[i]) | Returns the control channel log for a connection. | | [DataPortRangeFilter](#DataPortRangeFilter) | Provides a flexible mechanism to set multiple passive mode data port ranges. | | [DualStack](#DualStack) | Allows the use of ip4 and ip6 simultaneously. | | [MessageTable\[i\]](#MessageTable[i]) | Provides access to error code descriptions. | | [RefreshUsers](#RefreshUsers) | Enables or disables real-time propagation of user information. | | [SecurityOptions](#SecurityOptions) | Facilitates fine-tuning of lower-level security settings. | | [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 ([FTPServer](#struct-secureblackboxftpserver) Struct) Whether the server is active and can accept incoming connections. ## Syntax *Rust Syntax* ```text fn active(&self ) -> Result ``` ## Default Value false ## Remarks This read-only property returns True if the FTPS server is running and listening for incoming connections, and False otherwise. This property is read-only. ## Data Type bool # allow_anonymous property ([FTPServer](#struct-secureblackboxftpserver) Struct) Allows and disallows anonymous connections. ## Syntax *Rust Syntax* ```text fn allow_anonymous(&self ) -> Result fn set_allow_anonymous(&self, value : bool) -> Option ``` ## Default Value false ## Remarks Use this property to enable and disable support for anonymous connections. ## Data Type bool # client_file_entry_access_time property ([FTPServer](#struct-secureblackboxftpserver) Struct) Contains the last access time for this file, in UTC. ## Syntax *Rust Syntax* ```text fn client_file_entry_access_time(&self ) -> Result fn set_client_file_entry_access_time(&self, value : &str) -> Option fn set_client_file_entry_access_time_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks Contains the last access time for this file, in UTC. ## Data Type String # client_file_entry_creation_time property ([FTPServer](#struct-secureblackboxftpserver) Struct) Contains this file's creation time, in UTC. ## Syntax *Rust Syntax* ```text fn client_file_entry_creation_time(&self ) -> Result fn set_client_file_entry_creation_time(&self, value : &str) -> Option fn set_client_file_entry_creation_time_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks Contains this file's creation time, in UTC. ## Data Type String # client_file_entry_entry_format property ([FTPServer](#struct-secureblackboxftpserver) Struct) The file listing format: cfefUnknown 0 cfefUnix 1 cfefWindows 2 cfefMLSD 3 . ## Syntax *Rust Syntax* ```text fn client_file_entry_entry_format(&self ) -> Result fn set_client_file_entry_entry_format(&self, value : i32) -> Option ``` ## Possible Values ```text 0 // Unknown1 // Unix2 // Windows3 // MLSD ``` ## Default Value 0 ## Remarks The file listing format: | | | | --- | --- | | cfefUnknown | 0 | | cfefUnix | 1 | | cfefWindows | 2 | | cfefMLSD | 3 | ## Data Type i32 # client_file_entry_file_type property ([FTPServer](#struct-secureblackboxftpserver) Struct) The type of the entry: fetUnknown 0 fetDirectory 1 fetFile 2 fetSymlink 3 fetSpecial 4 fetCurrentDirectory 5 fetParentDirectory 6 fetSocket 7 fetCharDevice 8 fetBlockDevice 9 fetFIFO 10 . ## Syntax *Rust Syntax* ```text fn client_file_entry_file_type(&self ) -> Result fn set_client_file_entry_file_type(&self, value : i32) -> Option ``` ## Possible Values ```text 0 // Unknown1 // Directory2 // File3 // Symlink4 // Special5 // CurrentDirectory6 // ParentDirectory7 // Socket8 // CharDevice9 // BlockDevice10 // FIFO ``` ## Default Value 0 ## Remarks The type of the entry: | | | | --- | --- | | fetUnknown | 0 | | fetDirectory | 1 | | fetFile | 2 | | fetSymlink | 3 | | fetSpecial | 4 | | fetCurrentDirectory | 5 | | fetParentDirectory | 6 | | fetSocket | 7 | | fetCharDevice | 8 | | fetBlockDevice | 9 | | fetFIFO | 10 | ## Data Type i32 # client_file_entry_handle property ([FTPServer](#struct-secureblackboxftpserver) Struct) Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax *Rust Syntax* ```text fn client_file_entry_handle(&self ) -> Result fn set_client_file_entry_handle(&self, value : i64) -> Option ``` ## Default Value 0 ## Remarks Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` ## Data Type i64 # client_file_entry_modification_time property ([FTPServer](#struct-secureblackboxftpserver) Struct) File last modification date/time. ## Syntax *Rust Syntax* ```text fn client_file_entry_modification_time(&self ) -> Result fn set_client_file_entry_modification_time(&self, value : &str) -> Option fn set_client_file_entry_modification_time_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks File last modification date/time. ## Data Type String # client_file_entry_name property ([FTPServer](#struct-secureblackboxftpserver) Struct) The file or directory name. ## Syntax *Rust Syntax* ```text fn client_file_entry_name(&self ) -> Result fn set_client_file_entry_name(&self, value : &str) -> Option fn set_client_file_entry_name_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks The file or directory name. ## Data Type String # client_file_entry_path property ([FTPServer](#struct-secureblackboxftpserver) Struct) The full path to the file or directory. ## Syntax *Rust Syntax* ```text fn client_file_entry_path(&self ) -> Result fn set_client_file_entry_path(&self, value : &str) -> Option fn set_client_file_entry_path_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks The full path to the file or directory. ## Data Type String # client_file_entry_principal property ([FTPServer](#struct-secureblackboxftpserver) Struct) Specifies the owner of the file/directory. ## Syntax *Rust Syntax* ```text fn client_file_entry_principal(&self ) -> Result fn set_client_file_entry_principal(&self, value : &str) -> Option fn set_client_file_entry_principal_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks Specifies the owner of the file/directory. Note: in earlier versions this property was called Owner. It was renamed to Principal to avoid clashes with certain SDK namings. ## Data Type String # client_file_entry_size property ([FTPServer](#struct-secureblackboxftpserver) Struct) File size 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 File size in bytes. ## Data Type i64 # client_file_entry_unix_perms property ([FTPServer](#struct-secureblackboxftpserver) Struct) The file Unix permissions bit mask (e. ## Syntax *Rust Syntax* ```text fn client_file_entry_unix_perms(&self ) -> Result fn set_client_file_entry_unix_perms(&self, value : i32) -> Option ``` ## Default Value 511 ## Remarks The file Unix permissions bit mask (e.g. rwxrwxrwx=511 (0777); rwxr--r--=484 (0744)). ## Data Type i32 # client_file_entry_unparsed_name property ([FTPServer](#struct-secureblackboxftpserver) Struct) The unparsed entry as returned by the server. ## Syntax *Rust Syntax* ```text fn client_file_entry_unparsed_name(&self ) -> Result fn set_client_file_entry_unparsed_name(&self, value : &str) -> Option fn set_client_file_entry_unparsed_name_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks The unparsed entry as returned by the server. Sometimes this is also known as "long name". ## Data Type String # data_host property ([FTPServer](#struct-secureblackboxftpserver) Struct) Host address for incoming data channel connections. ## Syntax *Rust Syntax* ```text fn data_host(&self ) -> Result fn set_data_host(&self, value : &str) -> Option fn set_data_host_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks Use this property to specify the address for incoming data channel connections, if it is different to [host](#host-property-ftpserver-struct). In some network environments, in particular, where the server is behind a NAT, there may be a requirement to use a different host address for data connections. ## Data Type String # data_port_range_from property ([FTPServer](#struct-secureblackboxftpserver) Struct) Specifies the lower port range bound for passive mode data connections. ## Syntax *Rust Syntax* ```text fn data_port_range_from(&self ) -> Result fn set_data_port_range_from(&self, value : i32) -> Option ``` ## Default Value 0 ## Remarks Use this property in combination with DataPortRangeT to limit the port range for passive mode data connections. The value of 0 (zero) stands for no lower bound. ## Data Type i32 # data_port_range_to property ([FTPServer](#struct-secureblackboxftpserver) Struct) Specifies the upper port range bound for passive mode data connections. ## Syntax *Rust Syntax* ```text fn data_port_range_to(&self ) -> Result fn set_data_port_range_to(&self, value : i32) -> Option ``` ## Default Value 0 ## Remarks Use this property in combination with DataPortRangeFrom to limit the port range for passive mode data connections. The value of 0 (zero) stands for no upper bound. ## Data Type i32 # external_crypto_async_document_id property ([FTPServer](#struct-secureblackboxftpserver) 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 ([FTPServer](#struct-secureblackboxftpserver) 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 ([FTPServer](#struct-secureblackboxftpserver) 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 ([FTPServer](#struct-secureblackboxftpserver) 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 ([FTPServer](#struct-secureblackboxftpserver) 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 ([FTPServer](#struct-secureblackboxftpserver) 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-ftpserver-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 ([FTPServer](#struct-secureblackboxftpserver) 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-ftpserver-struct) topic. ## Data Type String # external_crypto_method property ([FTPServer](#struct-secureblackboxftpserver) 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 ([FTPServer](#struct-secureblackboxftpserver) 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 ([FTPServer](#struct-secureblackboxftpserver) 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 ([FTPServer](#struct-secureblackboxftpserver) Struct) Reserved. ## Syntax *Rust Syntax* ```text fn fips_mode(&self ) -> Result fn set_fips_mode(&self, value : bool) -> Option ``` ## Default Value false ## Remarks This property is reserved for future use. ## Data Type bool # handshake_timeout property ([FTPServer](#struct-secureblackboxftpserver) Struct) Specifies the handshake timeout in milliseconds. ## Syntax *Rust Syntax* ```text fn handshake_timeout(&self ) -> Result fn set_handshake_timeout(&self, value : i32) -> Option ``` ## Default Value 20000 ## Remarks Use this property to set the TLS handshake timeout. ## Data Type i32 # host property ([FTPServer](#struct-secureblackboxftpserver) Struct) Specifies the server host. ## 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 for incoming FTP connections. Use [port](#port-property-ftpserver-struct) to specify the listening port number. ## Data Type String # implicit_ssl property ([FTPServer](#struct-secureblackboxftpserver) Struct) Enables or disables implicit SSL mode. ## Syntax *Rust Syntax* ```text fn implicit_ssl(&self ) -> Result fn set_implicit_ssl(&self, value : bool) -> Option ``` ## Default Value false ## Remarks The server can only work in one mode, explicit or implicit. Explicit mode, also called AUTH TLS, supports both TLS and plain connections. Implicit mode, also called 'dedicated port mode,' only supports TLS connections. ## Data Type bool # passive_mode_host property ([FTPServer](#struct-secureblackboxftpserver) Struct) The IP address of the passive mode host. ## Syntax *Rust Syntax* ```text fn passive_mode_host(&self ) -> Result fn set_passive_mode_host(&self, value : &str) -> Option fn set_passive_mode_host_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks Use this property to specify the address on which to listen for passive mode connections. ## Data Type String # pinned_client_aead_cipher property ([FTPServer](#struct-secureblackboxftpserver) 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 ([FTPServer](#struct-secureblackboxftpserver) 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 ([FTPServer](#struct-secureblackboxftpserver) 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 ([FTPServer](#struct-secureblackboxftpserver) 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 ([FTPServer](#struct-secureblackboxftpserver) 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 ([FTPServer](#struct-secureblackboxftpserver) 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 ([FTPServer](#struct-secureblackboxftpserver) 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 ([FTPServer](#struct-secureblackboxftpserver) 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 ([FTPServer](#struct-secureblackboxftpserver) 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 ([FTPServer](#struct-secureblackboxftpserver) 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 ([FTPServer](#struct-secureblackboxftpserver) 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 ([FTPServer](#struct-secureblackboxftpserver) 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 ([FTPServer](#struct-secureblackboxftpserver) 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 ([FTPServer](#struct-secureblackboxftpserver) 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 ([FTPServer](#struct-secureblackboxftpserver) 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 ([FTPServer](#struct-secureblackboxftpserver) 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 ([FTPServer](#struct-secureblackboxftpserver) 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 ([FTPServer](#struct-secureblackboxftpserver) 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 ([FTPServer](#struct-secureblackboxftpserver) 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 ([FTPServer](#struct-secureblackboxftpserver) 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 ([FTPServer](#struct-secureblackboxftpserver) 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 ([FTPServer](#struct-secureblackboxftpserver) 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 ([FTPServer](#struct-secureblackboxftpserver) 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 ([FTPServer](#struct-secureblackboxftpserver) 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 ([FTPServer](#struct-secureblackboxftpserver) 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 ([FTPServer](#struct-secureblackboxftpserver) 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 ([FTPServer](#struct-secureblackboxftpserver) 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 ([FTPServer](#struct-secureblackboxftpserver) 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 ([FTPServer](#struct-secureblackboxftpserver) 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 ([FTPServer](#struct-secureblackboxftpserver) 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 ([FTPServer](#struct-secureblackboxftpserver) 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 ([FTPServer](#struct-secureblackboxftpserver) 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-ftpserver-struct) - [pinned_client_cert_ca_key_id](#pinned_client_cert_ca_key_id-property-ftpserver-struct) - [pinned_client_cert_fingerprint](#pinned_client_cert_fingerprint-property-ftpserver-struct) - [pinned_client_cert_handle](#pinned_client_cert_handle-property-ftpserver-struct) - [pinned_client_cert_issuer](#pinned_client_cert_issuer-property-ftpserver-struct) - [pinned_client_cert_issuer_rdn](#pinned_client_cert_issuer_rdn-property-ftpserver-struct) - [pinned_client_cert_key_algorithm](#pinned_client_cert_key_algorithm-property-ftpserver-struct) - [pinned_client_cert_key_bits](#pinned_client_cert_key_bits-property-ftpserver-struct) - [pinned_client_cert_key_fingerprint](#pinned_client_cert_key_fingerprint-property-ftpserver-struct) - [pinned_client_cert_key_usage](#pinned_client_cert_key_usage-property-ftpserver-struct) - [pinned_client_cert_public_key_bytes](#pinned_client_cert_public_key_bytes-property-ftpserver-struct) - [pinned_client_cert_self_signed](#pinned_client_cert_self_signed-property-ftpserver-struct) - [pinned_client_cert_serial_number](#pinned_client_cert_serial_number-property-ftpserver-struct) - [pinned_client_cert_sig_algorithm](#pinned_client_cert_sig_algorithm-property-ftpserver-struct) - [pinned_client_cert_subject](#pinned_client_cert_subject-property-ftpserver-struct) - [pinned_client_cert_subject_key_id](#pinned_client_cert_subject_key_id-property-ftpserver-struct) - [pinned_client_cert_subject_rdn](#pinned_client_cert_subject_rdn-property-ftpserver-struct) - [pinned_client_cert_valid_from](#pinned_client_cert_valid_from-property-ftpserver-struct) - [pinned_client_cert_valid_to](#pinned_client_cert_valid_to-property-ftpserver-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 ([FTPServer](#struct-secureblackboxftpserver) 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-ftpserver-struct) property. This property is read-only. ## Data Type Vec # pinned_client_cert_ca_key_id property ([FTPServer](#struct-secureblackboxftpserver) 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-ftpserver-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-ftpserver-struct) property. This property is read-only. ## Data Type Vec # pinned_client_cert_fingerprint property ([FTPServer](#struct-secureblackboxftpserver) 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-ftpserver-struct) property. This property is read-only. ## Data Type String # pinned_client_cert_handle property ([FTPServer](#struct-secureblackboxftpserver) 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-ftpserver-struct) property. This property is read-only. ## Data Type i64 # pinned_client_cert_issuer property ([FTPServer](#struct-secureblackboxftpserver) 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-ftpserver-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-ftpserver-struct) property. This property is read-only. ## Data Type String # pinned_client_cert_issuer_rdn property ([FTPServer](#struct-secureblackboxftpserver) 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-ftpserver-struct) property. This property is read-only. ## Data Type String # pinned_client_cert_key_algorithm property ([FTPServer](#struct-secureblackboxftpserver) 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-ftpserver-struct), [pinned_client_cert_curve](#FTPServer_p_PinnedClientCertCurve), and [pinned_client_cert_public_key_bytes](#pinned_client_cert_public_key_bytes-property-ftpserver-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-ftpserver-struct) property. This property is read-only. ## Data Type String # pinned_client_cert_key_bits property ([FTPServer](#struct-secureblackboxftpserver) 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-ftpserver-struct) or [pinned_client_cert_private_key_bytes](#FTPServer_p_PinnedClientCertPrivateKeyBytes) property would typically contain auxiliary values, and therefore be longer. The *PinnedClientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PinnedClientCertCount](#pinned_client_cert_count-property-ftpserver-struct) property. This property is read-only. ## Data Type i32 # pinned_client_cert_key_fingerprint property ([FTPServer](#struct-secureblackboxftpserver) 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-ftpserver-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-ftpserver-struct) property. This property is read-only. ## Data Type String # pinned_client_cert_key_usage property ([FTPServer](#struct-secureblackboxftpserver) 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-ftpserver-struct) property. This property is read-only. ## Data Type i32 # pinned_client_cert_public_key_bytes property ([FTPServer](#struct-secureblackboxftpserver) 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-ftpserver-struct) property. This property is read-only. ## Data Type Vec # pinned_client_cert_self_signed property ([FTPServer](#struct-secureblackboxftpserver) 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-ftpserver-struct) property. This property is read-only. ## Data Type bool # pinned_client_cert_serial_number property ([FTPServer](#struct-secureblackboxftpserver) 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-ftpserver-struct) property. This property is read-only. ## Data Type Vec # pinned_client_cert_sig_algorithm property ([FTPServer](#struct-secureblackboxftpserver) 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-ftpserver-struct) property. This property is read-only. ## Data Type String # pinned_client_cert_subject property ([FTPServer](#struct-secureblackboxftpserver) 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-ftpserver-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-ftpserver-struct) property. This property is read-only. ## Data Type String # pinned_client_cert_subject_key_id property ([FTPServer](#struct-secureblackboxftpserver) 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-ftpserver-struct) and [pinned_client_cert_ca_key_id](#pinned_client_cert_ca_key_id-property-ftpserver-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-ftpserver-struct) property. This property is read-only. ## Data Type Vec # pinned_client_cert_subject_rdn property ([FTPServer](#struct-secureblackboxftpserver) 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-ftpserver-struct) property. This property is read-only. ## Data Type String # pinned_client_cert_valid_from property ([FTPServer](#struct-secureblackboxftpserver) 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-ftpserver-struct) property. This property is read-only. ## Data Type String # pinned_client_cert_valid_to property ([FTPServer](#struct-secureblackboxftpserver) 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-ftpserver-struct) property. This property is read-only. ## Data Type String # port property ([FTPServer](#struct-secureblackboxftpserver) Struct) The port number to listen for incoming connections on. ## Syntax *Rust Syntax* ```text fn port(&self ) -> Result fn set_port(&self, value : i32) -> Option ``` ## Default Value 21 ## Remarks Use this property to specify the port number to listen for incoming connections on. ## Data Type i32 # read_only property ([FTPServer](#struct-secureblackboxftpserver) Struct) Makes the server's file system read-only for all users. ## Syntax *Rust Syntax* ```text fn read_only(&self ) -> Result fn set_read_only(&self, value : bool) -> Option ``` ## Default Value false ## Remarks Set this property to true to present the server's file system as read-only for all connecting users. ## Data Type bool # root_directory property ([FTPServer](#struct-secureblackboxftpserver) Struct) Specifies the server's root directory. ## Syntax *Rust Syntax* ```text fn root_directory(&self ) -> Result fn set_root_directory(&self, value : &str) -> Option fn set_root_directory_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks Use this property to specify the shared root directory for all client sessions. ## Data Type String # security_options property ([FTPServer](#struct-secureblackboxftpserver) Struct) Various options of the secure connection. ## Syntax *Rust Syntax* ```text fn security_options(&self ) -> Result fn set_security_options(&self, value : i32) -> Option ``` ## Default Value 63 ## Remarks Various options of the secure connection: | | | | | --- | --- | --- | | cfsoPlainLogin | 1 | Allow logins over insecure connections | | cfsoEncryption | 2 | Enable encryption | | cfsoAuth | 4 | Enable AUTH command (explicit TLS) | | cfsoClearControlChannel | 8 | Allow clear control channel mode | | cfsoClearDataChannel | 16 | Allow clear data channel TLS connections | | cfsoEncryptedDataChannel | 32 | Allow encrypted data channel TLS connections | ## Data Type i32 # session_timeout property ([FTPServer](#struct-secureblackboxftpserver) Struct) Specifies the session timeout in milliseconds. ## Syntax *Rust Syntax* ```text fn session_timeout(&self ) -> Result fn set_session_timeout(&self, value : i32) -> Option ``` ## Default Value 360000 ## Remarks Specifies the maximum inactivity time (in milliseconds) after which the session will be forcibly closed. ## Data Type i32 # socket_incoming_speed_limit property ([FTPServer](#struct-secureblackboxftpserver) 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 ([FTPServer](#struct-secureblackboxftpserver) 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 ([FTPServer](#struct-secureblackboxftpserver) 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 ([FTPServer](#struct-secureblackboxftpserver) 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 ([FTPServer](#struct-secureblackboxftpserver) 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 ([FTPServer](#struct-secureblackboxftpserver) 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 ([FTPServer](#struct-secureblackboxftpserver) 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-ftpserver-struct) - [tls_server_cert_handle](#tls_server_cert_handle-property-ftpserver-struct) The array indices start at *0* and end at *tls_server_cert_count - 1*. ## Data Type i32 # tls_server_cert_bytes property ([FTPServer](#struct-secureblackboxftpserver) 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-ftpserver-struct) property. This property is read-only. ## Data Type Vec # tls_server_cert_handle property ([FTPServer](#struct-secureblackboxftpserver) 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-ftpserver-struct) property. ## Data Type i64 # tls_auto_validate_certificates property ([FTPServer](#struct-secureblackboxftpserver) 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 ([FTPServer](#struct-secureblackboxftpserver) 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 ([FTPServer](#struct-secureblackboxftpserver) 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-ftpserver-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 ([FTPServer](#struct-secureblackboxftpserver) 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 ([FTPServer](#struct-secureblackboxftpserver) 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 ([FTPServer](#struct-secureblackboxftpserver) 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 ([FTPServer](#struct-secureblackboxftpserver) 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 ([FTPServer](#struct-secureblackboxftpserver) 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 ([FTPServer](#struct-secureblackboxftpserver) 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 ([FTPServer](#struct-secureblackboxftpserver) 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 ([FTPServer](#struct-secureblackboxftpserver) 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 ([FTPServer](#struct-secureblackboxftpserver) 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 ([FTPServer](#struct-secureblackboxftpserver) 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 ([FTPServer](#struct-secureblackboxftpserver) 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 ([FTPServer](#struct-secureblackboxftpserver) 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 ([FTPServer](#struct-secureblackboxftpserver) 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 ([FTPServer](#struct-secureblackboxftpserver) 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 ([FTPServer](#struct-secureblackboxftpserver) 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-ftpserver-struct) - [user_base_path](#user_base_path-property-ftpserver-struct) - [user_data](#user_data-property-ftpserver-struct) - [user_handle](#user_handle-property-ftpserver-struct) - [user_hash_algorithm](#user_hash_algorithm-property-ftpserver-struct) - [user_incoming_speed_limit](#user_incoming_speed_limit-property-ftpserver-struct) - [username](#username-property-ftpserver-struct) - [user_outgoing_speed_limit](#user_outgoing_speed_limit-property-ftpserver-struct) - [user_password](#user_password-property-ftpserver-struct) - [user_shared_secret](#user_shared_secret-property-ftpserver-struct) The array indices start at *0* and end at *user_count - 1*. ## Data Type i32 # user_associated_data property ([FTPServer](#struct-secureblackboxftpserver) 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-ftpserver-struct) property. ## Data Type Vec # user_base_path property ([FTPServer](#struct-secureblackboxftpserver) 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-ftpserver-struct) property. ## Data Type String # user_data property ([FTPServer](#struct-secureblackboxftpserver) 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-ftpserver-struct) property. ## Data Type String # user_handle property ([FTPServer](#struct-secureblackboxftpserver) 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-ftpserver-struct) property. ## Data Type i64 # user_hash_algorithm property ([FTPServer](#struct-secureblackboxftpserver) 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-ftpserver-struct) property. ## Data Type String # user_incoming_speed_limit property ([FTPServer](#struct-secureblackboxftpserver) 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-ftpserver-struct) property. ## Data Type i32 # user_outgoing_speed_limit property ([FTPServer](#struct-secureblackboxftpserver) 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-ftpserver-struct) property. ## Data Type i32 # user_password property ([FTPServer](#struct-secureblackboxftpserver) 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-ftpserver-struct) property. ## Data Type String # user_shared_secret property ([FTPServer](#struct-secureblackboxftpserver) 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-ftpserver-struct) property. ## Data Type Vec # username property ([FTPServer](#struct-secureblackboxftpserver) 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-ftpserver-struct) property. ## Data Type String # use_utf8 property ([FTPServer](#struct-secureblackboxftpserver) Struct) Enables or disables UTF8 file name conversions. ## Syntax *Rust Syntax* ```text fn use_utf8(&self ) -> Result fn set_use_utf8(&self, value : bool) -> Option ``` ## Default Value true ## Remarks Use this property to enable and disable UTF8 file name conversion. The server typically adjusts to the right setting automatically, but you may use this property to enforce the needed behaviour. ## Data Type bool # cleanup method ([FTPServer](#struct-secureblackboxftpserver) 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 ([FTPServer](#struct-secureblackboxftpserver) 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-ftpserver-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-ftpserver-struct), you must call *Config("PROPERTY")*. The value will be returned as a string. # do_action method ([FTPServer](#struct-secureblackboxftpserver) 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 ([FTPServer](#struct-secureblackboxftpserver) 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 ([FTPServer](#struct-secureblackboxftpserver) 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](#on_write_file-event-ftpserver-struct) event handler. The connection buffer contains data that have been received from the client but has not been written to the file yet. # list_clients method ([FTPServer](#struct-secureblackboxftpserver) 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 ([FTPServer](#struct-secureblackboxftpserver) Struct) Takes a snapshot of the connection's properties. ## Syntax *Rust Syntax* ```text fn pin_client(&self, connection_id : i64) -> Result<(), SecureBlackboxError> ``` ## Remarks Use this method to take a snapshot of a connected client. The captured properties are populated in pinned_client and pinned_client_chain properties. # reset method ([FTPServer](#struct-secureblackboxftpserver) 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 ([FTPServer](#struct-secureblackboxftpserver) 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](#on_read_file-event-ftpserver-struct) event handler to commit a chunk of file data to the server component. # set_client_file_entry method ([FTPServer](#struct-secureblackboxftpserver) 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](#on_find_next-event-ftpserver-struct) event handler. Please note that events like [on_find_next](#on_find_next-event-ftpserver-struct) 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. # start method ([FTPServer](#struct-secureblackboxftpserver) Struct) Starts the server. ## Syntax *Rust Syntax* ```text fn start(&self) -> Result<(), SecureBlackboxError> ``` ## Remarks Call this method to start listening for incoming connections on port [port](#port-property-ftpserver-struct). Call [stop](#stop-method-ftpserver-struct) to deactivate the server. # stop method ([FTPServer](#struct-secureblackboxftpserver) Struct) Stops the server. ## Syntax *Rust Syntax* ```text fn stop(&self) -> Result<(), SecureBlackboxError> ``` ## Remarks Call this method to terminate all active sessions and stop listening for new incoming connections. # on_accept event ([FTPServer](#struct-secureblackboxftpserver) Struct) Reports an incoming connection. ## Syntax *Rust Syntax* ```text // FTPServerAcceptEventArgs carries the FTPServer Accept event's parameters. pub struct FTPServerAcceptEventArgs { fn remote_address(&self) -> &String fn remote_port(&self) -> i32 fn accept(&self) -> bool fn set_accept(&self, value : bool) } // FTPServerAcceptEvent defines the signature of the FTPServer Accept event's handler function. pub trait FTPServerAcceptEvent { fn on_accept(&self, sender : FTPServer, e : &mut FTPServerAcceptEventArgs); } impl <'a> FTPServer<'a> { pub fn on_accept(&self) -> &'a dyn FTPServerAcceptEvent; pub fn set_on_accept(&mut self, value : &'a dyn FTPServerAcceptEvent); ... } ``` ## 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-ftpserver-struct) event to be notified of every connection that has been set up. # on_after_change_directory event ([FTPServer](#struct-secureblackboxftpserver) Struct) Signals the completion of a directory change operation. ## Syntax *Rust Syntax* ```text // FTPServerAfterChangeDirectoryEventArgs carries the FTPServer AfterChangeDirectory event's parameters. pub struct FTPServerAfterChangeDirectoryEventArgs { fn connection_id(&self) -> i64 fn directory(&self) -> &String fn operation_status(&self) -> i32 fn set_operation_status(&self, value : i32) } // FTPServerAfterChangeDirectoryEvent defines the signature of the FTPServer AfterChangeDirectory event's handler function. pub trait FTPServerAfterChangeDirectoryEvent { fn on_after_change_directory(&self, sender : FTPServer, e : &mut FTPServerAfterChangeDirectoryEventArgs); } impl <'a> FTPServer<'a> { pub fn on_after_change_directory(&self) -> &'a dyn FTPServerAfterChangeDirectoryEvent; pub fn set_on_after_change_directory(&mut self, value : &'a dyn FTPServerAfterChangeDirectoryEvent); ... } ``` ## Remarks The struct fires this event upon completion of a directory change 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_after_create_directory event ([FTPServer](#struct-secureblackboxftpserver) Struct) Signals the completion of a directory creation operation. ## Syntax *Rust Syntax* ```text // FTPServerAfterCreateDirectoryEventArgs carries the FTPServer AfterCreateDirectory event's parameters. pub struct FTPServerAfterCreateDirectoryEventArgs { fn connection_id(&self) -> i64 fn directory(&self) -> &String fn operation_status(&self) -> i32 fn set_operation_status(&self, value : i32) } // FTPServerAfterCreateDirectoryEvent defines the signature of the FTPServer AfterCreateDirectory event's handler function. pub trait FTPServerAfterCreateDirectoryEvent { fn on_after_create_directory(&self, sender : FTPServer, e : &mut FTPServerAfterCreateDirectoryEventArgs); } impl <'a> FTPServer<'a> { pub fn on_after_create_directory(&self) -> &'a dyn FTPServerAfterCreateDirectoryEvent; pub fn set_on_after_create_directory(&mut self, value : &'a dyn FTPServerAfterCreateDirectoryEvent); ... } ``` ## Remarks The struct fires this event upon completion of a directory creation 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_after_remove_directory event ([FTPServer](#struct-secureblackboxftpserver) Struct) Signals the completion of a directory removal operation. ## Syntax *Rust Syntax* ```text // FTPServerAfterRemoveDirectoryEventArgs carries the FTPServer AfterRemoveDirectory event's parameters. pub struct FTPServerAfterRemoveDirectoryEventArgs { fn connection_id(&self) -> i64 fn directory(&self) -> &String fn operation_status(&self) -> i32 fn set_operation_status(&self, value : i32) } // FTPServerAfterRemoveDirectoryEvent defines the signature of the FTPServer AfterRemoveDirectory event's handler function. pub trait FTPServerAfterRemoveDirectoryEvent { fn on_after_remove_directory(&self, sender : FTPServer, e : &mut FTPServerAfterRemoveDirectoryEventArgs); } impl <'a> FTPServer<'a> { pub fn on_after_remove_directory(&self) -> &'a dyn FTPServerAfterRemoveDirectoryEvent; pub fn set_on_after_remove_directory(&mut self, value : &'a dyn FTPServerAfterRemoveDirectoryEvent); ... } ``` ## Remarks The struct fires this event upon completion of a directory removal 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_after_remove_file event ([FTPServer](#struct-secureblackboxftpserver) Struct) Signals the completion of a file removal operation. ## Syntax *Rust Syntax* ```text // FTPServerAfterRemoveFileEventArgs carries the FTPServer AfterRemoveFile event's parameters. pub struct FTPServerAfterRemoveFileEventArgs { fn connection_id(&self) -> i64 fn path(&self) -> &String fn operation_status(&self) -> i32 fn set_operation_status(&self, value : i32) } // FTPServerAfterRemoveFileEvent defines the signature of the FTPServer AfterRemoveFile event's handler function. pub trait FTPServerAfterRemoveFileEvent { fn on_after_remove_file(&self, sender : FTPServer, e : &mut FTPServerAfterRemoveFileEventArgs); } impl <'a> FTPServer<'a> { pub fn on_after_remove_file(&self) -> &'a dyn FTPServerAfterRemoveFileEvent; pub fn set_on_after_remove_file(&mut self, value : &'a dyn FTPServerAfterRemoveFileEvent); ... } ``` ## Remarks The struct fires this event upon completion of a file removal 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_after_rename_file event ([FTPServer](#struct-secureblackboxftpserver) Struct) Signals the completion of a file renaming operation. ## Syntax *Rust Syntax* ```text // FTPServerAfterRenameFileEventArgs carries the FTPServer AfterRenameFile event's parameters. pub struct FTPServerAfterRenameFileEventArgs { 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) } // FTPServerAfterRenameFileEvent defines the signature of the FTPServer AfterRenameFile event's handler function. pub trait FTPServerAfterRenameFileEvent { fn on_after_rename_file(&self, sender : FTPServer, e : &mut FTPServerAfterRenameFileEventArgs); } impl <'a> FTPServer<'a> { pub fn on_after_rename_file(&self) -> &'a dyn FTPServerAfterRenameFileEvent; pub fn set_on_after_rename_file(&mut self, value : &'a dyn FTPServerAfterRenameFileEvent); ... } ``` ## Remarks The struct fires this event upon completion of a file renaming 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_after_request_attributes event ([FTPServer](#struct-secureblackboxftpserver) Struct) Signals the completion of an attribute request. ## Syntax *Rust Syntax* ```text // FTPServerAfterRequestAttributesEventArgs carries the FTPServer AfterRequestAttributes event's parameters. pub struct FTPServerAfterRequestAttributesEventArgs { fn connection_id(&self) -> i64 fn path(&self) -> &String fn operation_status(&self) -> i32 fn set_operation_status(&self, value : i32) } // FTPServerAfterRequestAttributesEvent defines the signature of the FTPServer AfterRequestAttributes event's handler function. pub trait FTPServerAfterRequestAttributesEvent { fn on_after_request_attributes(&self, sender : FTPServer, e : &mut FTPServerAfterRequestAttributesEventArgs); } impl <'a> FTPServer<'a> { pub fn on_after_request_attributes(&self) -> &'a dyn FTPServerAfterRequestAttributesEvent; pub fn set_on_after_request_attributes(&mut self, value : &'a dyn FTPServerAfterRequestAttributesEvent); ... } ``` ## Remarks The struct fires this event upon completion of an attribute request. 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 ([FTPServer](#struct-secureblackboxftpserver) Struct) Fires when a connected client makes an authentication attempt. ## Syntax *Rust Syntax* ```text // FTPServerAuthAttemptEventArgs carries the FTPServer AuthAttempt event's parameters. pub struct FTPServerAuthAttemptEventArgs { fn connection_id(&self) -> i64 fn username(&self) -> &String fn password(&self) -> &String fn allow(&self) -> bool fn set_allow(&self, value : bool) fn base_path(&self) -> &String fn set_base_path(&self, value : &str) fn set_base_path_ref(&self, value : &String) } // FTPServerAuthAttemptEvent defines the signature of the FTPServer AuthAttempt event's handler function. pub trait FTPServerAuthAttemptEvent { fn on_auth_attempt(&self, sender : FTPServer, e : &mut FTPServerAuthAttemptEventArgs); } impl <'a> FTPServer<'a> { pub fn on_auth_attempt(&self) -> &'a dyn FTPServerAuthAttemptEvent; pub fn set_on_auth_attempt(&mut self, value : &'a dyn FTPServerAuthAttemptEvent); ... } ``` ## Remarks The struct fires this event whenever a client attempts to authenticate itself. Use the *Allow* parameter to let the client through. The *BasePath* parameter specifies the home directory that will be used for this client. This is taken from the client's record in users, or from [root_directory](#root_directory-property-ftpserver-struct) if the client is not present in the list. You can adjust it in the event handler if required. *ConnectionID* contains the unique session identifier for that client, and *Username* and *Password* contain the professed credentials. # on_before_change_directory event ([FTPServer](#struct-secureblackboxftpserver) Struct) Notifies about an incoming change directory request. ## Syntax *Rust Syntax* ```text // FTPServerBeforeChangeDirectoryEventArgs carries the FTPServer BeforeChangeDirectory event's parameters. pub struct FTPServerBeforeChangeDirectoryEventArgs { fn connection_id(&self) -> i64 fn directory(&self) -> &String fn action(&self) -> i32 fn set_action(&self, value : i32) } // FTPServerBeforeChangeDirectoryEvent defines the signature of the FTPServer BeforeChangeDirectory event's handler function. pub trait FTPServerBeforeChangeDirectoryEvent { fn on_before_change_directory(&self, sender : FTPServer, e : &mut FTPServerBeforeChangeDirectoryEventArgs); } impl <'a> FTPServer<'a> { pub fn on_before_change_directory(&self) -> &'a dyn FTPServerBeforeChangeDirectoryEvent; pub fn set_on_before_change_directory(&mut self, value : &'a dyn FTPServerBeforeChangeDirectoryEvent); ... } ``` ## Remarks The struct fires this event to notify the application about a received directory change 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. Subscribe to [on_change_directory](#on_change_directory-event-ftpserver-struct) to be notified when to perform the request. It is the [on_change_directory](#on_change_directory-event-ftpserver-struct) event handler where you should perform the overridden action. Upon completion of the request, either in manual or override mode, the [on_after_change_directory](#on_after_change_directory-event-ftpserver-struct) event will be fired. 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 | # on_before_create_directory event ([FTPServer](#struct-secureblackboxftpserver) Struct) Notifies about an incoming create directory request. ## Syntax *Rust Syntax* ```text // FTPServerBeforeCreateDirectoryEventArgs carries the FTPServer BeforeCreateDirectory event's parameters. pub struct FTPServerBeforeCreateDirectoryEventArgs { fn connection_id(&self) -> i64 fn directory(&self) -> &String fn action(&self) -> i32 fn set_action(&self, value : i32) } // FTPServerBeforeCreateDirectoryEvent defines the signature of the FTPServer BeforeCreateDirectory event's handler function. pub trait FTPServerBeforeCreateDirectoryEvent { fn on_before_create_directory(&self, sender : FTPServer, e : &mut FTPServerBeforeCreateDirectoryEventArgs); } impl <'a> FTPServer<'a> { pub fn on_before_create_directory(&self) -> &'a dyn FTPServerBeforeCreateDirectoryEvent; pub fn set_on_before_create_directory(&mut self, value : &'a dyn FTPServerBeforeCreateDirectoryEvent); ... } ``` ## Remarks The struct fires this event to notify the application about a received MKDIR 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. Subscribe to [on_create_directory](#on_create_directory-event-ftpserver-struct) to be notified when to perform the request. It is the [on_create_directory](#on_create_directory-event-ftpserver-struct) event handler where you should perform the overridden action. Upon completion of the request, either in manual or override mode, the [on_after_create_directory](#on_after_create_directory-event-ftpserver-struct) event will be fired. 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 | # on_before_download_file event ([FTPServer](#struct-secureblackboxftpserver) Struct) Notifies about an incoming file download request. ## Syntax *Rust Syntax* ```text // FTPServerBeforeDownloadFileEventArgs carries the FTPServer BeforeDownloadFile event's parameters. pub struct FTPServerBeforeDownloadFileEventArgs { fn connection_id(&self) -> i64 fn path(&self) -> &String fn restart_at(&self) -> i64 fn action(&self) -> i32 fn set_action(&self, value : i32) } // FTPServerBeforeDownloadFileEvent defines the signature of the FTPServer BeforeDownloadFile event's handler function. pub trait FTPServerBeforeDownloadFileEvent { fn on_before_download_file(&self, sender : FTPServer, e : &mut FTPServerBeforeDownloadFileEventArgs); } impl <'a> FTPServer<'a> { pub fn on_before_download_file(&self) -> &'a dyn FTPServerBeforeDownloadFileEvent; pub fn set_on_before_download_file(&mut self, value : &'a dyn FTPServerBeforeDownloadFileEvent); ... } ``` ## Remarks The struct fires this event to notify the application about a received download 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. Subscribe to [on_download_file](#on_download_file-event-ftpserver-struct) to be notified when to perform the request. It is the [on_download_file](#on_download_file-event-ftpserver-struct) event handler where you should perform the overridden action. Upon completion of the request, either in manual or override mode, the [on_transfer_completed](#on_transfer_completed-event-ftpserver-struct) event will be fired. 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 | # on_before_find event ([FTPServer](#struct-secureblackboxftpserver) Struct) Notifies about an incoming file listing request. ## Syntax *Rust Syntax* ```text // FTPServerBeforeFindEventArgs carries the FTPServer BeforeFind event's parameters. pub struct FTPServerBeforeFindEventArgs { fn connection_id(&self) -> i64 fn directory(&self) -> &String fn action(&self) -> i32 fn set_action(&self, value : i32) } // FTPServerBeforeFindEvent defines the signature of the FTPServer BeforeFind event's handler function. pub trait FTPServerBeforeFindEvent { fn on_before_find(&self, sender : FTPServer, e : &mut FTPServerBeforeFindEventArgs); } impl <'a> FTPServer<'a> { pub fn on_before_find(&self) -> &'a dyn FTPServerBeforeFindEvent; pub fn set_on_before_find(&mut self, value : &'a dyn FTPServerBeforeFindEvent); ... } ``` ## Remarks The struct fires this event to notify the application about a received file listing 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. Subscribe to [on_find_init](#on_find_init-event-ftpserver-struct), [on_find_next](#on_find_next-event-ftpserver-struct), and [on_find_close](#on_find_close-event-ftpserver-struct) to be notified when to perform the request. It is the [on_find_init](#on_find_init-event-ftpserver-struct) and [on_find_next](#on_find_next-event-ftpserver-struct) events handler where you should perform the overridden listing actions. Upon completion of the request, either in manual or override mode, the [on_find_close](#on_find_close-event-ftpserver-struct) event will be fired. 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 | # on_before_remove_directory event ([FTPServer](#struct-secureblackboxftpserver) Struct) Notifies about an incoming directory removal request. ## Syntax *Rust Syntax* ```text // FTPServerBeforeRemoveDirectoryEventArgs carries the FTPServer BeforeRemoveDirectory event's parameters. pub struct FTPServerBeforeRemoveDirectoryEventArgs { fn connection_id(&self) -> i64 fn directory(&self) -> &String fn action(&self) -> i32 fn set_action(&self, value : i32) } // FTPServerBeforeRemoveDirectoryEvent defines the signature of the FTPServer BeforeRemoveDirectory event's handler function. pub trait FTPServerBeforeRemoveDirectoryEvent { fn on_before_remove_directory(&self, sender : FTPServer, e : &mut FTPServerBeforeRemoveDirectoryEventArgs); } impl <'a> FTPServer<'a> { pub fn on_before_remove_directory(&self) -> &'a dyn FTPServerBeforeRemoveDirectoryEvent; pub fn set_on_before_remove_directory(&mut self, value : &'a dyn FTPServerBeforeRemoveDirectoryEvent); ... } ``` ## Remarks The struct fires this event to notify the application about a received directory removal 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. Subscribe to [on_remove_directory](#on_remove_directory-event-ftpserver-struct) to be notified when to perform the request. It is the [on_remove_directory](#on_remove_directory-event-ftpserver-struct) event handler where you should perform the overridden action. Upon completion of the request, either in manual or override mode, the [on_after_remove_directory](#on_after_remove_directory-event-ftpserver-struct) event will be fired. 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 | # on_before_remove_file event ([FTPServer](#struct-secureblackboxftpserver) Struct) Notifies about an incoming file removal request. ## Syntax *Rust Syntax* ```text // FTPServerBeforeRemoveFileEventArgs carries the FTPServer BeforeRemoveFile event's parameters. pub struct FTPServerBeforeRemoveFileEventArgs { fn connection_id(&self) -> i64 fn path(&self) -> &String fn action(&self) -> i32 fn set_action(&self, value : i32) } // FTPServerBeforeRemoveFileEvent defines the signature of the FTPServer BeforeRemoveFile event's handler function. pub trait FTPServerBeforeRemoveFileEvent { fn on_before_remove_file(&self, sender : FTPServer, e : &mut FTPServerBeforeRemoveFileEventArgs); } impl <'a> FTPServer<'a> { pub fn on_before_remove_file(&self) -> &'a dyn FTPServerBeforeRemoveFileEvent; pub fn set_on_before_remove_file(&mut self, value : &'a dyn FTPServerBeforeRemoveFileEvent); ... } ``` ## Remarks The struct fires this event to notify the application about a received file deletion 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. Subscribe to [on_remove_file](#on_remove_file-event-ftpserver-struct) to be notified when to perform the request. It is the [on_remove_file](#on_remove_file-event-ftpserver-struct) event handler where you should perform the overridden action. Upon completion of the request, either in manual or override mode, the [on_after_remove_file](#on_after_remove_file-event-ftpserver-struct) event will be fired. 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 | Note that you must subscribe to [on_before_request_attributes](#on_before_request_attributes-event-ftpserver-struct) and [on_request_attributes](#on_request_attributes-event-ftpserver-struct) events to be able to use this event in an FTP server attached to a virtual file system. This is because the server checks the existence of the source file before commencing the deletion procedure. In the virtualized case, you can confirm the existence of the file by returning its details from [on_request_attributes](#on_request_attributes-event-ftpserver-struct) call. # on_before_rename_file event ([FTPServer](#struct-secureblackboxftpserver) Struct) Notifies about an incoming file rename request. ## Syntax *Rust Syntax* ```text // FTPServerBeforeRenameFileEventArgs carries the FTPServer BeforeRenameFile event's parameters. pub struct FTPServerBeforeRenameFileEventArgs { 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) } // FTPServerBeforeRenameFileEvent defines the signature of the FTPServer BeforeRenameFile event's handler function. pub trait FTPServerBeforeRenameFileEvent { fn on_before_rename_file(&self, sender : FTPServer, e : &mut FTPServerBeforeRenameFileEventArgs); } impl <'a> FTPServer<'a> { pub fn on_before_rename_file(&self) -> &'a dyn FTPServerBeforeRenameFileEvent; pub fn set_on_before_rename_file(&mut self, value : &'a dyn FTPServerBeforeRenameFileEvent); ... } ``` ## Remarks The struct fires this event to notify the application about a received file rename 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. Subscribe to [on_rename_file](#on_rename_file-event-ftpserver-struct) to be notified when to perform the request. It is the [on_rename_file](#on_rename_file-event-ftpserver-struct) event handler where you should perform the overridden action. Upon completion of the request, either in manual or override mode, the [on_after_rename_file](#on_after_rename_file-event-ftpserver-struct) event will be fired. 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 | Note that you must subscribe to [on_before_request_attributes](#on_before_request_attributes-event-ftpserver-struct) and [on_request_attributes](#on_request_attributes-event-ftpserver-struct) events to be able to use this event in an FTP server attached to a virtual file system. This is because the server checks the existence of the source file before commencing the renaming procedure. In the virtualized case, you can confirm the existence of the file by returning its details from [on_request_attributes](#on_request_attributes-event-ftpserver-struct) call. # on_before_request_attributes event ([FTPServer](#struct-secureblackboxftpserver) Struct) Notifies about an incoming attributes request. ## Syntax *Rust Syntax* ```text // FTPServerBeforeRequestAttributesEventArgs carries the FTPServer BeforeRequestAttributes event's parameters. pub struct FTPServerBeforeRequestAttributesEventArgs { fn connection_id(&self) -> i64 fn path(&self) -> &String fn action(&self) -> i32 fn set_action(&self, value : i32) } // FTPServerBeforeRequestAttributesEvent defines the signature of the FTPServer BeforeRequestAttributes event's handler function. pub trait FTPServerBeforeRequestAttributesEvent { fn on_before_request_attributes(&self, sender : FTPServer, e : &mut FTPServerBeforeRequestAttributesEventArgs); } impl <'a> FTPServer<'a> { pub fn on_before_request_attributes(&self) -> &'a dyn FTPServerBeforeRequestAttributesEvent; pub fn set_on_before_request_attributes(&mut self, value : &'a dyn FTPServerBeforeRequestAttributesEvent); ... } ``` ## Remarks The struct fires this event to notify the application about a received attributes 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. Subscribe to [on_request_attributes](#on_request_attributes-event-ftpserver-struct) to be notified when to perform the request. It is the [on_request_attributes](#on_request_attributes-event-ftpserver-struct) event handler where you should perform the overridden action. Upon completion of the request, either in manual or override mode, the [on_after_request_attributes](#on_after_request_attributes-event-ftpserver-struct) event will be fired. 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 | # on_before_send_reply event ([FTPServer](#struct-secureblackboxftpserver) Struct) Notifies the application of a command reply being sent. ## Syntax *Rust Syntax* ```text // FTPServerBeforeSendReplyEventArgs carries the FTPServer BeforeSendReply event's parameters. pub struct FTPServerBeforeSendReplyEventArgs { fn connection_id(&self) -> i64 fn code(&self) -> i32 fn set_code(&self, value : i32) fn reply(&self) -> &String fn set_reply(&self, value : &str) fn set_reply_ref(&self, value : &String) fn command(&self) -> &String } // FTPServerBeforeSendReplyEvent defines the signature of the FTPServer BeforeSendReply event's handler function. pub trait FTPServerBeforeSendReplyEvent { fn on_before_send_reply(&self, sender : FTPServer, e : &mut FTPServerBeforeSendReplyEventArgs); } impl <'a> FTPServer<'a> { pub fn on_before_send_reply(&self) -> &'a dyn FTPServerBeforeSendReplyEvent; pub fn set_on_before_send_reply(&mut self, value : &'a dyn FTPServerBeforeSendReplyEvent); ... } ``` ## Remarks The struct fires this event to tell the application that a command reply is about to be sent. The *Command* parameter indicates the command that induced the reply, and *Code* and *Reply* indicate the pre-generated response. You can alter the response parameters in your code to send bespoke replies. # on_before_upload_file event ([FTPServer](#struct-secureblackboxftpserver) Struct) Notifies about an incoming file upload request. ## Syntax *Rust Syntax* ```text // FTPServerBeforeUploadFileEventArgs carries the FTPServer BeforeUploadFile event's parameters. pub struct FTPServerBeforeUploadFileEventArgs { fn connection_id(&self) -> i64 fn path(&self) -> &String fn restart_at(&self) -> i64 fn append(&self) -> bool fn action(&self) -> i32 fn set_action(&self, value : i32) } // FTPServerBeforeUploadFileEvent defines the signature of the FTPServer BeforeUploadFile event's handler function. pub trait FTPServerBeforeUploadFileEvent { fn on_before_upload_file(&self, sender : FTPServer, e : &mut FTPServerBeforeUploadFileEventArgs); } impl <'a> FTPServer<'a> { pub fn on_before_upload_file(&self) -> &'a dyn FTPServerBeforeUploadFileEvent; pub fn set_on_before_upload_file(&mut self, value : &'a dyn FTPServerBeforeUploadFileEvent); ... } ``` ## Remarks The struct fires this event to notify the application about a received upload 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. Subscribe to [on_upload_file](#on_upload_file-event-ftpserver-struct) to be notified when to perform the request. It is the [on_upload_file](#on_upload_file-event-ftpserver-struct) event handler where you should perform the overridden action. Upon completion of the request, either in manual or override mode, the [on_transfer_completed](#on_transfer_completed-event-ftpserver-struct) event will be fired. 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 | # on_change_directory event ([FTPServer](#struct-secureblackboxftpserver) Struct) An override for a directory change operation. ## Syntax *Rust Syntax* ```text // FTPServerChangeDirectoryEventArgs carries the FTPServer ChangeDirectory event's parameters. pub struct FTPServerChangeDirectoryEventArgs { fn connection_id(&self) -> i64 fn directory(&self) -> &String fn set_directory(&self, value : &str) fn set_directory_ref(&self, value : &String) fn operation_status(&self) -> i32 fn set_operation_status(&self, value : i32) } // FTPServerChangeDirectoryEvent defines the signature of the FTPServer ChangeDirectory event's handler function. pub trait FTPServerChangeDirectoryEvent { fn on_change_directory(&self, sender : FTPServer, e : &mut FTPServerChangeDirectoryEventArgs); } impl <'a> FTPServer<'a> { pub fn on_change_directory(&self) -> &'a dyn FTPServerChangeDirectoryEvent; pub fn set_on_change_directory(&mut self, value : &'a dyn FTPServerChangeDirectoryEvent); ... } ``` ## Remarks The struct fires this event to let the application perform an overridden directory change operation. This event only fires if Action = [fraCustom](constants.md#const_fraCustom) was passed back from [on_before_change_directory](#on_before_change_directory-event-ftpserver-struct) event, and expects your code to perform the requested operation inside the handler. No default operation will be performed by the server component. Use the *OperationStatus* parameter to return the operation result back to the server. This event will be followed by [on_after_change_directory](#on_after_change_directory-event-ftpserver-struct) call which will let you make final adjustments to the returned code. Set *OperationStatus* to one of the following values: | | | | | --- | --- | --- | | ostOk | 1 | | | ostNoSuchFile | 2 | | | ostAccessDenied | 3 | | | ostWriteProtect | 4 | | | ostUnsupported | 5 | | | ostInvalidParameter | 6 | | | ostEOF | 7 | | # on_command_processed event ([FTPServer](#struct-secureblackboxftpserver) Struct) Signals that a command has been processed by the server. ## Syntax *Rust Syntax* ```text // FTPServerCommandProcessedEventArgs carries the FTPServer CommandProcessed event's parameters. pub struct FTPServerCommandProcessedEventArgs { fn connection_id(&self) -> i64 fn current_directory(&self) -> &String fn command(&self) -> &String fn reply_code(&self) -> i32 } // FTPServerCommandProcessedEvent defines the signature of the FTPServer CommandProcessed event's handler function. pub trait FTPServerCommandProcessedEvent { fn on_command_processed(&self, sender : FTPServer, e : &mut FTPServerCommandProcessedEventArgs); } impl <'a> FTPServer<'a> { pub fn on_command_processed(&self) -> &'a dyn FTPServerCommandProcessedEvent; pub fn set_on_command_processed(&mut self, value : &'a dyn FTPServerCommandProcessedEvent); ... } ``` ## Remarks The struct fires this event to signal that a command has been processed by the server, and a reply code has been generated. You can adjust the reply code and the textual comment associated with it in [on_before_send_reply](#on_before_send_reply-event-ftpserver-struct) event handler. # on_command_received event ([FTPServer](#struct-secureblackboxftpserver) Struct) Signals that a command has been received from the client. ## Syntax *Rust Syntax* ```text // FTPServerCommandReceivedEventArgs carries the FTPServer CommandReceived event's parameters. pub struct FTPServerCommandReceivedEventArgs { fn connection_id(&self) -> i64 fn command(&self) -> &String fn parameters(&self) -> &String fn ignore(&self) -> bool fn set_ignore(&self, value : bool) } // FTPServerCommandReceivedEvent defines the signature of the FTPServer CommandReceived event's handler function. pub trait FTPServerCommandReceivedEvent { fn on_command_received(&self, sender : FTPServer, e : &mut FTPServerCommandReceivedEventArgs); } impl <'a> FTPServer<'a> { pub fn on_command_received(&self) -> &'a dyn FTPServerCommandReceivedEvent; pub fn set_on_command_received(&mut self, value : &'a dyn FTPServerCommandReceivedEvent); ... } ``` ## Remarks The struct fires this event to notify the application of an incoming command. Set *Ignore* to True to stop the server from handling the command. When the command has been processed, the server will report it via the [on_command_processed](#on_command_processed-event-ftpserver-struct) call. # on_connect event ([FTPServer](#struct-secureblackboxftpserver) Struct) Reports an accepted connection. ## Syntax *Rust Syntax* ```text // FTPServerConnectEventArgs carries the FTPServer Connect event's parameters. pub struct FTPServerConnectEventArgs { fn connection_id(&self) -> i64 fn remote_address(&self) -> &String fn port(&self) -> i32 } // FTPServerConnectEvent defines the signature of the FTPServer Connect event's handler function. pub trait FTPServerConnectEvent { fn on_connect(&self, sender : FTPServer, e : &mut FTPServerConnectEventArgs); } impl <'a> FTPServer<'a> { pub fn on_connect(&self) -> &'a dyn FTPServerConnectEvent; pub fn set_on_connect(&mut self, value : &'a dyn FTPServerConnectEvent); ... } ``` ## Remarks The struct fires this event to report that a new connection has been established. *ConnectionId* indicates the unique ID assigned to this connection. The same ID will be supplied to any other events related to this connection, such as [on_auth_attempt](#on_auth_attempt-event-ftpserver-struct) or [on_before_upload_file](#on_before_upload_file-event-ftpserver-struct). # on_create_directory event ([FTPServer](#struct-secureblackboxftpserver) Struct) An override for a directory creation operation. ## Syntax *Rust Syntax* ```text // FTPServerCreateDirectoryEventArgs carries the FTPServer CreateDirectory event's parameters. pub struct FTPServerCreateDirectoryEventArgs { fn connection_id(&self) -> i64 fn directory(&self) -> &String fn set_directory(&self, value : &str) fn set_directory_ref(&self, value : &String) fn operation_status(&self) -> i32 fn set_operation_status(&self, value : i32) } // FTPServerCreateDirectoryEvent defines the signature of the FTPServer CreateDirectory event's handler function. pub trait FTPServerCreateDirectoryEvent { fn on_create_directory(&self, sender : FTPServer, e : &mut FTPServerCreateDirectoryEventArgs); } impl <'a> FTPServer<'a> { pub fn on_create_directory(&self) -> &'a dyn FTPServerCreateDirectoryEvent; pub fn set_on_create_directory(&mut self, value : &'a dyn FTPServerCreateDirectoryEvent); ... } ``` ## Remarks The struct fires this event to let the application perform an overridden directory creation operation. This event only fires if Action = [fraCustom](constants.md#const_fraCustom) was passed back from [on_before_create_directory](#on_before_create_directory-event-ftpserver-struct) event, and expects your code to perform the requested operation inside the handler. No default operation will be performed by the server component. Use the *OperationStatus* parameter to return the operation result back to the server. This event will be followed by [on_after_create_directory](#on_after_create_directory-event-ftpserver-struct) call which will let you make final adjustments to the returned code. Set *OperationStatus* to one of the following values: | | | | | --- | --- | --- | | ostOk | 1 | | | ostNoSuchFile | 2 | | | ostAccessDenied | 3 | | | ostWriteProtect | 4 | | | ostUnsupported | 5 | | | ostInvalidParameter | 6 | | | ostEOF | 7 | | # on_disconnect event ([FTPServer](#struct-secureblackboxftpserver) Struct) Fires to report a disconnected client. ## Syntax *Rust Syntax* ```text // FTPServerDisconnectEventArgs carries the FTPServer Disconnect event's parameters. pub struct FTPServerDisconnectEventArgs { fn connection_id(&self) -> i64 } // FTPServerDisconnectEvent defines the signature of the FTPServer Disconnect event's handler function. pub trait FTPServerDisconnectEvent { fn on_disconnect(&self, sender : FTPServer, e : &mut FTPServerDisconnectEventArgs); } impl <'a> FTPServer<'a> { pub fn on_disconnect(&self) -> &'a dyn FTPServerDisconnectEvent; pub fn set_on_disconnect(&mut self, value : &'a dyn FTPServerDisconnectEvent); ... } ``` ## Remarks The struct fires this event when a connected client disconnects. # on_download_begin event ([FTPServer](#struct-secureblackboxftpserver) Struct) The struct fires this event to notify the application about the start of a file download. ## Syntax *Rust Syntax* ```text // FTPServerDownloadBeginEventArgs carries the FTPServer DownloadBegin event's parameters. pub struct FTPServerDownloadBeginEventArgs { fn connection_id(&self) -> i64 fn path(&self) -> &String } // FTPServerDownloadBeginEvent defines the signature of the FTPServer DownloadBegin event's handler function. pub trait FTPServerDownloadBeginEvent { fn on_download_begin(&self, sender : FTPServer, e : &mut FTPServerDownloadBeginEventArgs); } impl <'a> FTPServer<'a> { pub fn on_download_begin(&self) -> &'a dyn FTPServerDownloadBeginEvent; pub fn set_on_download_begin(&mut self, value : &'a dyn FTPServerDownloadBeginEvent); ... } ``` ## Remarks Subscribe to this event to get notified about the beginning of a file download operation. The requested file is specified via the *Path* property. # on_download_end event ([FTPServer](#struct-secureblackboxftpserver) Struct) Reports the completion of the download operation. ## Syntax *Rust Syntax* ```text // FTPServerDownloadEndEventArgs carries the FTPServer DownloadEnd event's parameters. pub struct FTPServerDownloadEndEventArgs { fn connection_id(&self) -> i64 fn path(&self) -> &String } // FTPServerDownloadEndEvent defines the signature of the FTPServer DownloadEnd event's handler function. pub trait FTPServerDownloadEndEvent { fn on_download_end(&self, sender : FTPServer, e : &mut FTPServerDownloadEndEventArgs); } impl <'a> FTPServer<'a> { pub fn on_download_end(&self) -> &'a dyn FTPServerDownloadEndEvent; pub fn set_on_download_end(&mut self, value : &'a dyn FTPServerDownloadEndEvent); ... } ``` ## Remarks Use this event to get notified about completion of the early initiated file download operation. # on_download_file event ([FTPServer](#struct-secureblackboxftpserver) Struct) An override for a file download initiation operation. ## Syntax *Rust Syntax* ```text // FTPServerDownloadFileEventArgs carries the FTPServer DownloadFile event's parameters. pub struct FTPServerDownloadFileEventArgs { 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) } // FTPServerDownloadFileEvent defines the signature of the FTPServer DownloadFile event's handler function. pub trait FTPServerDownloadFileEvent { fn on_download_file(&self, sender : FTPServer, e : &mut FTPServerDownloadFileEventArgs); } impl <'a> FTPServer<'a> { pub fn on_download_file(&self) -> &'a dyn FTPServerDownloadFileEvent; pub fn set_on_download_file(&mut self, value : &'a dyn FTPServerDownloadFileEvent); ... } ``` ## Remarks The struct fires this event to let the application perform an overridden file download initiation operation. This event only fires if Action = [fraCustom](constants.md#const_fraCustom) was passed back from [on_before_download_file](#on_before_download_file-event-ftpserver-struct) event, and expects your code to perform the requested operation inside the handler. No default operation will be performed by the server component. Use the *OperationStatus* parameter to return the operation result back to the server. This event will be followed by a number of [on_read_file](#on_read_file-event-ftpserver-struct) calls, requesting the file data from your code, followed by a single [on_transfer_completed](#on_transfer_completed-event-ftpserver-struct) call. Set *OperationStatus* to one of the following values: | | | | | --- | --- | --- | | ostOk | 1 | | | ostNoSuchFile | 2 | | | ostAccessDenied | 3 | | | ostWriteProtect | 4 | | | ostUnsupported | 5 | | | ostInvalidParameter | 6 | | | ostEOF | 7 | | # on_download_progress event ([FTPServer](#struct-secureblackboxftpserver) Struct) Reports the progress of an active download operation. ## Syntax *Rust Syntax* ```text // FTPServerDownloadProgressEventArgs carries the FTPServer DownloadProgress event's parameters. pub struct FTPServerDownloadProgressEventArgs { fn connection_id(&self) -> i64 fn path(&self) -> &String fn progress(&self) -> i64 fn total(&self) -> i64 } // FTPServerDownloadProgressEvent defines the signature of the FTPServer DownloadProgress event's handler function. pub trait FTPServerDownloadProgressEvent { fn on_download_progress(&self, sender : FTPServer, e : &mut FTPServerDownloadProgressEventArgs); } impl <'a> FTPServer<'a> { pub fn on_download_progress(&self) -> &'a dyn FTPServerDownloadProgressEvent; pub fn set_on_download_progress(&mut self, value : &'a dyn FTPServerDownloadProgressEvent); ... } ``` ## Remarks Subscribe to this event to be notified about the progress of an active download operation. The *Path* parameter contains the path to the file being downloaded, and *Progress* and *Total* reflect the operation progress. Note that the *Total* parameter may be set to -1 if the size of the downloaded file is not known. # on_error event ([FTPServer](#struct-secureblackboxftpserver) Struct) Information about errors during data delivery. ## Syntax *Rust Syntax* ```text // FTPServerErrorEventArgs carries the FTPServer Error event's parameters. pub struct FTPServerErrorEventArgs { fn connection_id(&self) -> i64 fn error_code(&self) -> i32 fn fatal(&self) -> bool fn remote(&self) -> bool fn description(&self) -> &String } // FTPServerErrorEvent defines the signature of the FTPServer Error event's handler function. pub trait FTPServerErrorEvent { fn on_error(&self, sender : FTPServer, e : &mut FTPServerErrorEventArgs); } impl <'a> FTPServer<'a> { pub fn on_error(&self) -> &'a dyn FTPServerErrorEvent; pub fn set_on_error(&mut self, value : &'a dyn FTPServerErrorEvent); ... } ``` ## 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 [FTP](#trappable-errors-ftpserver-struct) section. # on_external_sign event ([FTPServer](#struct-secureblackboxftpserver) Struct) Handles remote or external signing initiated by the server protocol. ## Syntax *Rust Syntax* ```text // FTPServerExternalSignEventArgs carries the FTPServer ExternalSign event's parameters. pub struct FTPServerExternalSignEventArgs { 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) } // FTPServerExternalSignEvent defines the signature of the FTPServer ExternalSign event's handler function. pub trait FTPServerExternalSignEvent { fn on_external_sign(&self, sender : FTPServer, e : &mut FTPServerExternalSignEventArgs); } impl <'a> FTPServer<'a> { pub fn on_external_sign(&self) -> &'a dyn FTPServerExternalSignEvent; pub fn set_on_external_sign(&mut self, value : &'a dyn FTPServerExternalSignEvent); ... } ``` ## 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_find_close event ([FTPServer](#struct-secureblackboxftpserver) Struct) Signals the completion of a directory listing request. ## Syntax *Rust Syntax* ```text // FTPServerFindCloseEventArgs carries the FTPServer FindClose event's parameters. pub struct FTPServerFindCloseEventArgs { fn connection_id(&self) -> i64 fn operation_status(&self) -> i32 fn set_operation_status(&self, value : i32) } // FTPServerFindCloseEvent defines the signature of the FTPServer FindClose event's handler function. pub trait FTPServerFindCloseEvent { fn on_find_close(&self, sender : FTPServer, e : &mut FTPServerFindCloseEventArgs); } impl <'a> FTPServer<'a> { pub fn on_find_close(&self) -> &'a dyn FTPServerFindCloseEvent; pub fn set_on_find_close(&mut self, value : &'a dyn FTPServerFindCloseEvent); ... } ``` ## Remarks The struct fires this event upon completion of a directory listing request. Check the operation status, and alter it, if needed, through the *OperationStatus* parameter. # on_find_init event ([FTPServer](#struct-secureblackboxftpserver) Struct) An override for a directory listing initiation operation. ## Syntax *Rust Syntax* ```text // FTPServerFindInitEventArgs carries the FTPServer FindInit event's parameters. pub struct FTPServerFindInitEventArgs { fn connection_id(&self) -> i64 fn directory(&self) -> &String fn set_directory(&self, value : &str) fn set_directory_ref(&self, value : &String) fn operation_status(&self) -> i32 fn set_operation_status(&self, value : i32) } // FTPServerFindInitEvent defines the signature of the FTPServer FindInit event's handler function. pub trait FTPServerFindInitEvent { fn on_find_init(&self, sender : FTPServer, e : &mut FTPServerFindInitEventArgs); } impl <'a> FTPServer<'a> { pub fn on_find_init(&self) -> &'a dyn FTPServerFindInitEvent; pub fn set_on_find_init(&mut self, value : &'a dyn FTPServerFindInitEvent); ... } ``` ## Remarks The struct fires this event to let the application prepare for directory listing retrieval. This event only fires if Action = [fraCustom](constants.md#const_fraCustom) was passed back from [on_before_find](#on_before_find-event-ftpserver-struct) event, and expects your code to perform the requested operation inside the handler. No default operation will be performed by the server component. Use the *OperationStatus* parameter to return the operation result back to the server. This event will be followed by a number of [on_find_next](#on_find_next-event-ftpserver-struct) calls, requesting the directory listing entry by entry from your code, followed by a [on_find_close](#on_find_close-event-ftpserver-struct) call. Set *OperationStatus* to one of the following values: | | | | | --- | --- | --- | | ostOk | 1 | | | ostNoSuchFile | 2 | | | ostAccessDenied | 3 | | | ostWriteProtect | 4 | | | ostUnsupported | 5 | | | ostInvalidParameter | 6 | | | ostEOF | 7 | | # on_find_next event ([FTPServer](#struct-secureblackboxftpserver) Struct) An override for a directory listing entry request operation. ## Syntax *Rust Syntax* ```text // FTPServerFindNextEventArgs carries the FTPServer FindNext event's parameters. pub struct FTPServerFindNextEventArgs { fn connection_id(&self) -> i64 fn operation_status(&self) -> i32 fn set_operation_status(&self, value : i32) } // FTPServerFindNextEvent defines the signature of the FTPServer FindNext event's handler function. pub trait FTPServerFindNextEvent { fn on_find_next(&self, sender : FTPServer, e : &mut FTPServerFindNextEventArgs); } impl <'a> FTPServer<'a> { pub fn on_find_next(&self) -> &'a dyn FTPServerFindNextEvent; pub fn set_on_find_next(&mut self, value : &'a dyn FTPServerFindNextEvent); ... } ``` ## Remarks The struct fires this event in a loop after calling [on_find_init](#on_find_init-event-ftpserver-struct) to request one directory entry from the application. This event only fires if Action = [fraCustom](constants.md#const_fraCustom) was passed back from [on_before_find](#on_before_find-event-ftpserver-struct) event. No default listing operation will be performed by the server component. Inside the handler, pass the entry details to the server component by tuning up the client_file_entry object to contain the details of the requested entry, and committing those details to the component with [set_client_file_entry](#set_client_file_entry-method-ftpserver-struct) method. Use the *OperationStatus* parameter to return the operation result back to the server. After submitting all the directory entries to the component, set *OperationStatus* to ostEOF to tell the components that no more entries are left. This event will be followed by [on_find_close](#on_find_close-event-ftpserver-struct) call which will let you make final adjustments to the returned code. Set *OperationStatus* to one of the following values: | | | | | --- | --- | --- | | ostOk | 1 | | | ostNoSuchFile | 2 | | | ostAccessDenied | 3 | | | ostWriteProtect | 4 | | | ostUnsupported | 5 | | | ostInvalidParameter | 6 | | | ostEOF | 7 | | # on_notification event ([FTPServer](#struct-secureblackboxftpserver) Struct) This event notifies the application about an underlying control flow event. ## Syntax *Rust Syntax* ```text // FTPServerNotificationEventArgs carries the FTPServer Notification event's parameters. pub struct FTPServerNotificationEventArgs { fn event_id(&self) -> &String fn event_param(&self) -> &String } // FTPServerNotificationEvent defines the signature of the FTPServer Notification event's handler function. pub trait FTPServerNotificationEvent { fn on_notification(&self, sender : FTPServer, e : &mut FTPServerNotificationEventArgs); } impl <'a> FTPServer<'a> { pub fn on_notification(&self) -> &'a dyn FTPServerNotificationEvent; pub fn set_on_notification(&mut self, value : &'a dyn FTPServerNotificationEvent); ... } ``` ## Remarks The struct fires this event to let the application know about some event, occurrence, or milestone in the struct. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time. The unique identifier of the event is provided in the *EventID* parameter. *EventParam* contains any parameters accompanying the occurrence. Depending on the type of the struct, the exact action it is performing, or the document being processed, one or both may be omitted. This struct can fire this event with the following *EventID* values: | | | | --- | --- | | DownloadProgress | Reports the progress of the current download operation. The EventParam value passed with this EventID is a string of the following format: ConnectionID=3;Path=/dir/file;Progress=2048;Total=16000 | | UploadProgress | Reports the progress of the current upload operation. The format of EventParam is identical to the one used by the DownloadProgress. | | DownloadBegin | Indicates the start of the download operation. The EventParam value has the following format: ConnectionID=8;Path=/dir/file | | UploadBegin | Indicates the start of the upload operation. The EventParam format is the same as with the DownloadBegin event ID. | | DownloadEnd | Indicates the completion of the download operation. The EventParam value has the following format: ConnectionID=8;Path=/dir/file | | UploadEnd | Indicates the completion of the upload operation. The EventParam format is the same as with the DownloadEnd event ID. | | ListeningStarted | Notifies the application that the server has started listening for incoming connections. | | ListeningStopped | Notifies the application that the server has stopped listening to incoming connections. | # on_read_file event ([FTPServer](#struct-secureblackboxftpserver) Struct) Requests a piece of file data from the application. ## Syntax *Rust Syntax* ```text // FTPServerReadFileEventArgs carries the FTPServer ReadFile event's parameters. pub struct FTPServerReadFileEventArgs { fn connection_id(&self) -> i64 fn size(&self) -> i32 fn operation_status(&self) -> i32 fn set_operation_status(&self, value : i32) } // FTPServerReadFileEvent defines the signature of the FTPServer ReadFile event's handler function. pub trait FTPServerReadFileEvent { fn on_read_file(&self, sender : FTPServer, e : &mut FTPServerReadFileEventArgs); } impl <'a> FTPServer<'a> { pub fn on_read_file(&self) -> &'a dyn FTPServerReadFileEvent; pub fn set_on_read_file(&mut self, value : &'a dyn FTPServerReadFileEvent); ... } ``` ## Remarks The struct fires this event repeatedly during an overridden download operation to request file data from the application. The handler of this event should read up to *Size* bytes from the downloaded file, and pass them to the component with a [set_client_buffer](#set_client_buffer-method-ftpserver-struct) call. Use the *OperationStatus* parameter to return the operation result back to the server. When the file has been read up to its end, set *OperationStatus* to ostEOF to tell the components that no more on_read_file calls are needed. Set *OperationStatus* to one of the following values: | | | | | --- | --- | --- | | ostOk | 1 | | | ostNoSuchFile | 2 | | | ostAccessDenied | 3 | | | ostWriteProtect | 4 | | | ostUnsupported | 5 | | | ostInvalidParameter | 6 | | | ostEOF | 7 | | # on_remove_directory event ([FTPServer](#struct-secureblackboxftpserver) Struct) An override for a directory removal operation. ## Syntax *Rust Syntax* ```text // FTPServerRemoveDirectoryEventArgs carries the FTPServer RemoveDirectory event's parameters. pub struct FTPServerRemoveDirectoryEventArgs { fn connection_id(&self) -> i64 fn directory(&self) -> &String fn set_directory(&self, value : &str) fn set_directory_ref(&self, value : &String) fn operation_status(&self) -> i32 fn set_operation_status(&self, value : i32) } // FTPServerRemoveDirectoryEvent defines the signature of the FTPServer RemoveDirectory event's handler function. pub trait FTPServerRemoveDirectoryEvent { fn on_remove_directory(&self, sender : FTPServer, e : &mut FTPServerRemoveDirectoryEventArgs); } impl <'a> FTPServer<'a> { pub fn on_remove_directory(&self) -> &'a dyn FTPServerRemoveDirectoryEvent; pub fn set_on_remove_directory(&mut self, value : &'a dyn FTPServerRemoveDirectoryEvent); ... } ``` ## Remarks The struct fires this event to let the application perform an overridden directory removal operation. This event only fires if Action = fraCustom was passed back from [on_before_remove_directory](#on_before_remove_directory-event-ftpserver-struct) event, and expects your code to perform the requested operation inside the handler. No default operation will be performed by the server component. Use the *OperationStatus* parameter to return the operation result back to the server. This event will be followed by [on_after_remove_directory](#on_after_remove_directory-event-ftpserver-struct) call which will let you make final adjustments to the returned code. Set *OperationStatus* to one of the following values: | | | | | --- | --- | --- | | ostOk | 1 | | | ostNoSuchFile | 2 | | | ostAccessDenied | 3 | | | ostWriteProtect | 4 | | | ostUnsupported | 5 | | | ostInvalidParameter | 6 | | | ostEOF | 7 | | # on_remove_file event ([FTPServer](#struct-secureblackboxftpserver) Struct) An override for a file remove operation. ## Syntax *Rust Syntax* ```text // FTPServerRemoveFileEventArgs carries the FTPServer RemoveFile event's parameters. pub struct FTPServerRemoveFileEventArgs { fn connection_id(&self) -> i64 fn path(&self) -> &String fn operation_status(&self) -> i32 fn set_operation_status(&self, value : i32) } // FTPServerRemoveFileEvent defines the signature of the FTPServer RemoveFile event's handler function. pub trait FTPServerRemoveFileEvent { fn on_remove_file(&self, sender : FTPServer, e : &mut FTPServerRemoveFileEventArgs); } impl <'a> FTPServer<'a> { pub fn on_remove_file(&self) -> &'a dyn FTPServerRemoveFileEvent; pub fn set_on_remove_file(&mut self, value : &'a dyn FTPServerRemoveFileEvent); ... } ``` ## Remarks The struct fires this event to let the application perform an overridden file removal operation. This event only fires if Action = [fraCustom](constants.md#const_fraCustom) was passed back from [on_before_remove_file](#on_before_remove_file-event-ftpserver-struct) event, and expects your code to perform the requested operation inside the handler. No default operation will be performed by the server component. Use the *OperationStatus* parameter to return the operation result back to the server. This event will be followed by [on_after_remove_file](#on_after_remove_file-event-ftpserver-struct) call which will let you make final adjustments to the returned code. Set *OperationStatus* to one of the following values: | | | | | --- | --- | --- | | ostOk | 1 | | | ostNoSuchFile | 2 | | | ostAccessDenied | 3 | | | ostWriteProtect | 4 | | | ostUnsupported | 5 | | | ostInvalidParameter | 6 | | | ostEOF | 7 | | Please see a remark about virtualizing file removals in the [on_before_remove_file](#on_before_remove_file-event-ftpserver-struct) topic. # on_rename_file event ([FTPServer](#struct-secureblackboxftpserver) Struct) An override for a file rename operation. ## Syntax *Rust Syntax* ```text // FTPServerRenameFileEventArgs carries the FTPServer RenameFile event's parameters. pub struct FTPServerRenameFileEventArgs { 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) } // FTPServerRenameFileEvent defines the signature of the FTPServer RenameFile event's handler function. pub trait FTPServerRenameFileEvent { fn on_rename_file(&self, sender : FTPServer, e : &mut FTPServerRenameFileEventArgs); } impl <'a> FTPServer<'a> { pub fn on_rename_file(&self) -> &'a dyn FTPServerRenameFileEvent; pub fn set_on_rename_file(&mut self, value : &'a dyn FTPServerRenameFileEvent); ... } ``` ## Remarks The struct fires this event to let the application perform an overridden file rename operation. This event only fires if Action = [fraCustom](constants.md#const_fraCustom) was passed back from [on_before_rename_file](#on_before_rename_file-event-ftpserver-struct) event, and expects your code to perform the requested operation inside the handler. No default operation will be performed by the server component. Use the *OperationStatus* parameter to return the operation result back to the server. This event will be followed by [on_after_rename_file](#on_after_rename_file-event-ftpserver-struct) call which will let you make final adjustments to the returned code. Set *OperationStatus* to one of the following values: | | | | | --- | --- | --- | | ostOk | 1 | | | ostNoSuchFile | 2 | | | ostAccessDenied | 3 | | | ostWriteProtect | 4 | | | ostUnsupported | 5 | | | ostInvalidParameter | 6 | | | ostEOF | 7 | | Please see a remark about virtualizing file renamings in the [on_before_rename_file](#on_before_rename_file-event-ftpserver-struct) topic. # on_request_attributes event ([FTPServer](#struct-secureblackboxftpserver) Struct) An override for an attribute request. ## Syntax *Rust Syntax* ```text // FTPServerRequestAttributesEventArgs carries the FTPServer RequestAttributes event's parameters. pub struct FTPServerRequestAttributesEventArgs { fn connection_id(&self) -> i64 fn path(&self) -> &String fn operation_status(&self) -> i32 fn set_operation_status(&self, value : i32) } // FTPServerRequestAttributesEvent defines the signature of the FTPServer RequestAttributes event's handler function. pub trait FTPServerRequestAttributesEvent { fn on_request_attributes(&self, sender : FTPServer, e : &mut FTPServerRequestAttributesEventArgs); } impl <'a> FTPServer<'a> { pub fn on_request_attributes(&self) -> &'a dyn FTPServerRequestAttributesEvent; pub fn set_on_request_attributes(&mut self, value : &'a dyn FTPServerRequestAttributesEvent); ... } ``` ## Remarks The struct fires this event to let the application handle an overridden attribute request operation. This event only fires if Action = [fraCustom](constants.md#const_fraCustom) was passed back from [on_before_request_attributes](#on_before_request_attributes-event-ftpserver-struct) event, and expects your code to perform the requested operation inside the handler. No default operation will be performed by the server component. Use the *OperationStatus* parameter to return the operation result back to the server. This event will be followed by [on_after_request_attributes](#on_after_request_attributes-event-ftpserver-struct) call which will let you make final adjustments to the returned code. Set *OperationStatus* to one of the following values: | | | | | --- | --- | --- | | ostOk | 1 | | | ostNoSuchFile | 2 | | | ostAccessDenied | 3 | | | ostWriteProtect | 4 | | | ostUnsupported | 5 | | | ostInvalidParameter | 6 | | | ostEOF | 7 | | # on_tls_cert_validate event ([FTPServer](#struct-secureblackboxftpserver) Struct) Fires when a client certificate needs to be validated. ## Syntax *Rust Syntax* ```text // FTPServerTLSCertValidateEventArgs carries the FTPServer TLSCertValidate event's parameters. pub struct FTPServerTLSCertValidateEventArgs { fn connection_id(&self) -> i64 fn accept(&self) -> bool fn set_accept(&self, value : bool) } // FTPServerTLSCertValidateEvent defines the signature of the FTPServer TLSCertValidate event's handler function. pub trait FTPServerTLSCertValidateEvent { fn on_tls_cert_validate(&self, sender : FTPServer, e : &mut FTPServerTLSCertValidateEventArgs); } impl <'a> FTPServer<'a> { pub fn on_tls_cert_validate(&self) -> &'a dyn FTPServerTLSCertValidateEvent; pub fn set_on_tls_cert_validate(&mut self, value : &'a dyn FTPServerTLSCertValidateEvent); ... } ``` ## Remarks The struct fires this event to notify the application of an authenticating client. Use the event handler to validate the certificate and pass your decision back to the server component via the *Accept* parameter. # on_tls_established event ([FTPServer](#struct-secureblackboxftpserver) Struct) Reports the setup of a TLS session. ## Syntax *Rust Syntax* ```text // FTPServerTLSEstablishedEventArgs carries the FTPServer TLSEstablished event's parameters. pub struct FTPServerTLSEstablishedEventArgs { fn connection_id(&self) -> i64 } // FTPServerTLSEstablishedEvent defines the signature of the FTPServer TLSEstablished event's handler function. pub trait FTPServerTLSEstablishedEvent { fn on_tls_established(&self, sender : FTPServer, e : &mut FTPServerTLSEstablishedEventArgs); } impl <'a> FTPServer<'a> { pub fn on_tls_established(&self) -> &'a dyn FTPServerTLSEstablishedEvent; pub fn set_on_tls_established(&mut self, value : &'a dyn FTPServerTLSEstablishedEvent); ... } ``` ## Remarks Subscribe to this event to be notified about the setup of a TLS connection by a connected client. # on_tls_handshake event ([FTPServer](#struct-secureblackboxftpserver) Struct) Fires when a newly established client connection initiates a TLS handshake. ## Syntax *Rust Syntax* ```text // FTPServerTLSHandshakeEventArgs carries the FTPServer TLSHandshake event's parameters. pub struct FTPServerTLSHandshakeEventArgs { fn connection_id(&self) -> i64 fn server_name(&self) -> &String fn abort(&self) -> bool fn set_abort(&self, value : bool) } // FTPServerTLSHandshakeEvent defines the signature of the FTPServer TLSHandshake event's handler function. pub trait FTPServerTLSHandshakeEvent { fn on_tls_handshake(&self, sender : FTPServer, e : &mut FTPServerTLSHandshakeEventArgs); } impl <'a> FTPServer<'a> { pub fn on_tls_handshake(&self) -> &'a dyn FTPServerTLSHandshakeEvent; pub fn set_on_tls_handshake(&mut self, value : &'a dyn FTPServerTLSHandshakeEvent); ... } ``` ## 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 ([FTPServer](#struct-secureblackboxftpserver) Struct) Requests a pre-shared key for TLS-PSK. ## Syntax *Rust Syntax* ```text // FTPServerTLSPSKEventArgs carries the FTPServer TLSPSK event's parameters. pub struct FTPServerTLSPSKEventArgs { 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) } // FTPServerTLSPSKEvent defines the signature of the FTPServer TLSPSK event's handler function. pub trait FTPServerTLSPSKEvent { fn on_tls_psk(&self, sender : FTPServer, e : &mut FTPServerTLSPSKEventArgs); } impl <'a> FTPServer<'a> { pub fn on_tls_psk(&self) -> &'a dyn FTPServerTLSPSKEvent; pub fn set_on_tls_psk(&mut self, value : &'a dyn FTPServerTLSPSKEvent); ... } ``` ## 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 ([FTPServer](#struct-secureblackboxftpserver) Struct) Reports closure of a TLS session. ## Syntax *Rust Syntax* ```text // FTPServerTLSShutdownEventArgs carries the FTPServer TLSShutdown event's parameters. pub struct FTPServerTLSShutdownEventArgs { fn connection_id(&self) -> i64 } // FTPServerTLSShutdownEvent defines the signature of the FTPServer TLSShutdown event's handler function. pub trait FTPServerTLSShutdownEvent { fn on_tls_shutdown(&self, sender : FTPServer, e : &mut FTPServerTLSShutdownEventArgs); } impl <'a> FTPServer<'a> { pub fn on_tls_shutdown(&self) -> &'a dyn FTPServerTLSShutdownEvent; pub fn set_on_tls_shutdown(&mut self, value : &'a dyn FTPServerTLSShutdownEvent); ... } ``` ## 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-ftpserver-struct), which marks the closure of the underlying TCP session. # on_transfer_completed event ([FTPServer](#struct-secureblackboxftpserver) Struct) This event is fired when a customized upload or download operation completes. ## Syntax *Rust Syntax* ```text // FTPServerTransferCompletedEventArgs carries the FTPServer TransferCompleted event's parameters. pub struct FTPServerTransferCompletedEventArgs { fn connection_id(&self) -> i64 fn operation_status(&self) -> i32 fn set_operation_status(&self, value : i32) } // FTPServerTransferCompletedEvent defines the signature of the FTPServer TransferCompleted event's handler function. pub trait FTPServerTransferCompletedEvent { fn on_transfer_completed(&self, sender : FTPServer, e : &mut FTPServerTransferCompletedEventArgs); } impl <'a> FTPServer<'a> { pub fn on_transfer_completed(&self) -> &'a dyn FTPServerTransferCompletedEvent; pub fn set_on_transfer_completed(&mut self, value : &'a dyn FTPServerTransferCompletedEvent); ... } ``` ## Remarks This event is fired when a customized transfer operation completes. This event is only fired for operations handled by the user code, i.e. those intercepted with [on_before_upload_file](#on_before_upload_file-event-ftpserver-struct) or [on_before_download_file](#on_before_download_file-event-ftpserver-struct) 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_upload_begin event ([FTPServer](#struct-secureblackboxftpserver) Struct) The server fires this event to notify the application about the start of a file upload operation. ## Syntax *Rust Syntax* ```text // FTPServerUploadBeginEventArgs carries the FTPServer UploadBegin event's parameters. pub struct FTPServerUploadBeginEventArgs { fn connection_id(&self) -> i64 fn path(&self) -> &String } // FTPServerUploadBeginEvent defines the signature of the FTPServer UploadBegin event's handler function. pub trait FTPServerUploadBeginEvent { fn on_upload_begin(&self, sender : FTPServer, e : &mut FTPServerUploadBeginEventArgs); } impl <'a> FTPServer<'a> { pub fn on_upload_begin(&self) -> &'a dyn FTPServerUploadBeginEvent; pub fn set_on_upload_begin(&mut self, value : &'a dyn FTPServerUploadBeginEvent); ... } ``` ## Remarks Use this event to get notified about the beginning of a file upload operation. The file that is about to be uploaded is specified via the *Path* property. # on_upload_end event ([FTPServer](#struct-secureblackboxftpserver) Struct) Reports the completion of the upload operation. ## Syntax *Rust Syntax* ```text // FTPServerUploadEndEventArgs carries the FTPServer UploadEnd event's parameters. pub struct FTPServerUploadEndEventArgs { fn connection_id(&self) -> i64 fn path(&self) -> &String } // FTPServerUploadEndEvent defines the signature of the FTPServer UploadEnd event's handler function. pub trait FTPServerUploadEndEvent { fn on_upload_end(&self, sender : FTPServer, e : &mut FTPServerUploadEndEventArgs); } impl <'a> FTPServer<'a> { pub fn on_upload_end(&self) -> &'a dyn FTPServerUploadEndEvent; pub fn set_on_upload_end(&mut self, value : &'a dyn FTPServerUploadEndEvent); ... } ``` ## Remarks Use this event to receive notifications about completion of file upload operations. # on_upload_file event ([FTPServer](#struct-secureblackboxftpserver) Struct) An override for a file upload initiation operation. ## Syntax *Rust Syntax* ```text // FTPServerUploadFileEventArgs carries the FTPServer UploadFile event's parameters. pub struct FTPServerUploadFileEventArgs { 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) } // FTPServerUploadFileEvent defines the signature of the FTPServer UploadFile event's handler function. pub trait FTPServerUploadFileEvent { fn on_upload_file(&self, sender : FTPServer, e : &mut FTPServerUploadFileEventArgs); } impl <'a> FTPServer<'a> { pub fn on_upload_file(&self) -> &'a dyn FTPServerUploadFileEvent; pub fn set_on_upload_file(&mut self, value : &'a dyn FTPServerUploadFileEvent); ... } ``` ## Remarks The struct fires this event to let the application perform an overridden file upload initiation operation. This event only fires if Action = [fraCustom](constants.md#const_fraCustom) was passed back from [on_before_upload_file](#on_before_upload_file-event-ftpserver-struct) event, and expects your code to perform the requested operation inside the handler. No default operation will be performed by the server component. Use the *OperationStatus* parameter to return the operation result back to the server. This event will be followed by a number of [on_write_file](#on_write_file-event-ftpserver-struct) calls, passing the file data to your code, followed by a single [on_transfer_completed](#on_transfer_completed-event-ftpserver-struct) call. Set *OperationStatus* to one of the following values: | | | | | --- | --- | --- | | ostOk | 1 | | | ostNoSuchFile | 2 | | | ostAccessDenied | 3 | | | ostWriteProtect | 4 | | | ostUnsupported | 5 | | | ostInvalidParameter | 6 | | | ostEOF | 7 | | # on_upload_progress event ([FTPServer](#struct-secureblackboxftpserver) Struct) Reports the progress of an active upload operation. ## Syntax *Rust Syntax* ```text // FTPServerUploadProgressEventArgs carries the FTPServer UploadProgress event's parameters. pub struct FTPServerUploadProgressEventArgs { fn connection_id(&self) -> i64 fn path(&self) -> &String fn progress(&self) -> i64 fn total(&self) -> i64 } // FTPServerUploadProgressEvent defines the signature of the FTPServer UploadProgress event's handler function. pub trait FTPServerUploadProgressEvent { fn on_upload_progress(&self, sender : FTPServer, e : &mut FTPServerUploadProgressEventArgs); } impl <'a> FTPServer<'a> { pub fn on_upload_progress(&self) -> &'a dyn FTPServerUploadProgressEvent; pub fn set_on_upload_progress(&mut self, value : &'a dyn FTPServerUploadProgressEvent); ... } ``` ## Remarks Subscribe to this event to be notified about the progress of an active upload operation. The *Path* parameter specifies the path to the file being uploaded, and *Progress* and *Total* reflect the operation progress. The *Total* parameter may be set to -1 if the size of the uploaded file is not known. # on_write_file event ([FTPServer](#struct-secureblackboxftpserver) Struct) Hands a piece of file data to the application. ## Syntax *Rust Syntax* ```text // FTPServerWriteFileEventArgs carries the FTPServer WriteFile event's parameters. pub struct FTPServerWriteFileEventArgs { fn connection_id(&self) -> i64 fn operation_status(&self) -> i32 fn set_operation_status(&self, value : i32) } // FTPServerWriteFileEvent defines the signature of the FTPServer WriteFile event's handler function. pub trait FTPServerWriteFileEvent { fn on_write_file(&self, sender : FTPServer, e : &mut FTPServerWriteFileEventArgs); } impl <'a> FTPServer<'a> { pub fn on_write_file(&self) -> &'a dyn FTPServerWriteFileEvent; pub fn set_on_write_file(&mut self, value : &'a dyn FTPServerWriteFileEvent); ... } ``` ## Remarks The struct fires this event repeatedly during an overridden upload operation to pass file data to the application. The handler of this event should retrieve the pending data buffer with a [get_client_buffer](#get_client_buffer-method-ftpserver-struct) call, and write it to the end of the file 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 ([FTPServer](#struct-secureblackboxftpserver) 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-ftpserver-struct) method. ### FTPServer Config Settings **ActiveChannel**: The channel to which the event that is being invoked corresponds.Use this property to find out which channel, command or data, has invoked the current event. This property returns reliable values and should only be checked while inside an event handler. facCmd = 0; facData = 1; **ClientAuth**: Enables or disables certificate-based client authentication.Set this property to one of the below values to tune up the client authentication logic: | | | | | --- | --- | --- | | 0 | | No client authentication (the default setting) | | 1 | | Request certificates. The server will ask connecting clients for their certificates. Non-authenticated client connections will be accepted anyway. | | 2 | | Require certificates. The server will ask connecting clients for their certificates. If a client fails to provide a certificate, the server will terminate the connection. | If this property is set to 1 or 2, the component will request certificates from the connecting clients. Depending on the setting, the clients that fail to provide their certificate in response will be allowed or disallowed to proceed with the connection. The server signals about a received certificate by firing its on_certificate_validate event. Use [pin_client](#pin_client-method-ftpserver-struct) method in the event handler to pin the client details, and access the provided certificate chain via the pinned_client_chain property. Note that this event is fired from the connecting clients threads, so please make sure you avoid bottlenecks in the event handler and put appropriate thread safety measures in place. Unlike the client-side components, the server component does not perform automated certificate validation against the local security policy. You must perform appropriate certificate validation steps in your on_certificate_validate event handler. **ControlChannelLog[i]**: Returns the control channel log for a connection.Use this setting to retrieve the control channel log for a particular client connection. Any sensitive data, such as passwords, is returned masked. **DataPortRangeFilter**: Provides a flexible mechanism to set multiple passive mode data port ranges.Use this property to provide multiple data port ranges to be used for passive mode transfers. This configuration setting accepts a comma-separated list of port ranges or individual port numbers. Make sure that all the ranges are mutually exclusive and none of any two ranges intersect. Example: 1500,1505-1512,1520,1521-1531. **DualStack**: Allows the use of ip4 and ip6 simultaneously.This setting specifies a socket can use ip4 and ip6 simultaneously. **MessageTable[i]**: Provides access to error code descriptions.Use this property to get or set textual error code descriptions (e.g. 226 = Transfer Complete). **RefreshUsers**: Enables or disables real-time propagation of user information.Set this property to true to make the content of the Users property propagate to the server immediately. The default setting is false, which delays the effect of any changes in the Users setting until the server is restarted. **SecurityOptions**: Facilitates fine-tuning of lower-level security settings.This property is a bit mask offering the following individual parameters: - cfsoPlainLogin (1) - cfsoEncryption (2) - cfsoAuth (4); - cfsoClearControlChannel (8) - cfsoClearDataChannel (16) - cfsoEncryptedDataChannel (32) Combine the above parameters to enable or disable certain security aspects of the server. ### 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 ([FTPServer](#struct-secureblackboxftpserver) Struct) ### FTPServer 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)) | | 18874369 | Unsupported file operation ([SB_ERROR_FTP_UNSUPPORTED_FILE_OPERATION](constants.md#const_SBERRORFTPUNSUPPORTEDFILEOPERATION)) |