Struct secureblackbox::FTPServer

Properties   Methods   Events   Config Settings   Errors  

The FTPServer struct provides server-side functionality for FTP and FTPS protocols.

Syntax

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.

Method List

---

The following is the full list of the methods of the struct with short descriptions. Click on the links for further details.

Event List

---

The following is the full list of the events fired by the struct with short descriptions. Click on the links for further details.

Config Settings

---

The following is a list of config settings for the struct with short descriptions. Click on the links for further details.

active property (FTPServer Struct)

Whether the server is active and can accept incoming connections.

Syntax

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

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)

Allows and disallows anonymous connections.

Syntax

fn allow_anonymous(&self ) -> Result<bool, SecureBlackboxError> 
fn set_allow_anonymous(&self, value : bool) ->  Option<SecureBlackboxError> 

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)

Contains the last access time for this file, in UTC.

Syntax

fn client_file_entry_access_time(&self ) -> Result<String, SecureBlackboxError> 
fn set_client_file_entry_access_time(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_client_file_entry_access_time_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Contains the last access time for this file, in UTC.

Data Type

String

client_file_entry_creation_time property (FTPServer Struct)

Contains this file's creation time, in UTC.

Syntax

fn client_file_entry_creation_time(&self ) -> Result<String, SecureBlackboxError> 
fn set_client_file_entry_creation_time(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_client_file_entry_creation_time_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Contains this file's creation time, in UTC.

Data Type

String

client_file_entry_entry_format property (FTPServer Struct)

The file listing format: cfefUnknown 0 cfefUnix 1 cfefWindows 2 cfefMLSD 3 .

Syntax

fn client_file_entry_entry_format(&self ) -> Result<i32, SecureBlackboxError> 
fn set_client_file_entry_entry_format(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // Unknown
1   // Unix
2   // Windows
3   // MLSD

Default Value

0

Remarks

The file listing format:

Data Type

i32

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 .

Syntax

fn client_file_entry_file_type(&self ) -> Result<i32, SecureBlackboxError> 
fn set_client_file_entry_file_type(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // Unknown
1   // Directory
2   // File
3   // Symlink
4   // Special
5   // CurrentDirectory
6   // ParentDirectory
7   // Socket
8   // CharDevice
9   // BlockDevice
10   // FIFO

Default Value

0

Remarks

The type of the entry:

Data Type

i32

client_file_entry_handle property (FTPServer Struct)

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

Syntax

fn client_file_entry_handle(&self ) -> Result<i64, SecureBlackboxError> 
fn set_client_file_entry_handle(&self, value : i64) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

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

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

Data Type

i64

client_file_entry_modification_time property (FTPServer Struct)

File last modification date/time.

Syntax

fn client_file_entry_modification_time(&self ) -> Result<String, SecureBlackboxError> 
fn set_client_file_entry_modification_time(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_client_file_entry_modification_time_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

File last modification date/time.

Data Type

String

client_file_entry_name property (FTPServer Struct)

The file or directory name.

Syntax

fn client_file_entry_name(&self ) -> Result<String, SecureBlackboxError> 
fn set_client_file_entry_name(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_client_file_entry_name_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The file or directory name.

Data Type

String

client_file_entry_path property (FTPServer Struct)

The full path to the file or directory.

Syntax

fn client_file_entry_path(&self ) -> Result<String, SecureBlackboxError> 
fn set_client_file_entry_path(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_client_file_entry_path_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The full path to the file or directory.

Data Type

String

client_file_entry_principal property (FTPServer Struct)

Specifies the owner of the file/directory.

Syntax

fn client_file_entry_principal(&self ) -> Result<String, SecureBlackboxError> 
fn set_client_file_entry_principal(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_client_file_entry_principal_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

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)

File size in bytes.

Syntax

fn client_file_entry_size(&self ) -> Result<i64, SecureBlackboxError> 
fn set_client_file_entry_size(&self, value : i64) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

File size in bytes.

Data Type

i64

client_file_entry_unix_perms property (FTPServer Struct)

The file Unix permissions bit mask (e.

Syntax

fn client_file_entry_unix_perms(&self ) -> Result<i32, SecureBlackboxError> 
fn set_client_file_entry_unix_perms(&self, value : i32) ->  Option<SecureBlackboxError> 

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)

The unparsed entry as returned by the server.

Syntax

fn client_file_entry_unparsed_name(&self ) -> Result<String, SecureBlackboxError> 
fn set_client_file_entry_unparsed_name(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_client_file_entry_unparsed_name_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

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)

Host address for incoming data channel connections.

Syntax

fn data_host(&self ) -> Result<String, SecureBlackboxError> 
fn set_data_host(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_data_host_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Use this property to specify the address for incoming data channel connections, if it is different to host.

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)

Specifies the lower port range bound for passive mode data connections.

Syntax

fn data_port_range_from(&self ) -> Result<i32, SecureBlackboxError> 
fn set_data_port_range_from(&self, value : i32) ->  Option<SecureBlackboxError> 

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)

Specifies the upper port range bound for passive mode data connections.

Syntax

fn data_port_range_to(&self ) -> Result<i32, SecureBlackboxError> 
fn set_data_port_range_to(&self, value : i32) ->  Option<SecureBlackboxError> 

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)

Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.

Syntax

fn external_crypto_async_document_id(&self ) -> Result<String, SecureBlackboxError> 
fn set_external_crypto_async_document_id(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_external_crypto_async_document_id_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.

Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. On the completion stage, this value helps the signing component identify the correct signature in the returned batch of responses.

If using batched requests, make sure to set this property to the same value on both the pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages.

Data Type

String

external_crypto_custom_params property (FTPServer Struct)

Custom parameters to be passed to the signing service (uninterpreted).

Syntax

fn external_crypto_custom_params(&self ) -> Result<String, SecureBlackboxError> 
fn set_external_crypto_custom_params(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_external_crypto_custom_params_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Custom parameters to be passed to the signing service (uninterpreted).

Data Type

String

external_crypto_data property (FTPServer Struct)

Additional data to be included in the async state and mirrored back by the requestor.

Syntax

fn external_crypto_data(&self ) -> Result<String, SecureBlackboxError> 
fn set_external_crypto_data(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_external_crypto_data_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Additional data to be included in the async state and mirrored back by the requestor.

Data Type

String

external_crypto_external_hash_calculation property (FTPServer Struct)

Specifies whether the message hash is to be calculated at the external endpoint.

Syntax

fn external_crypto_external_hash_calculation(&self ) -> Result<bool, SecureBlackboxError> 
fn set_external_crypto_external_hash_calculation(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

Specifies whether the message hash is to be calculated at the external endpoint. Please note that this mode is not supported by the DCAuth struct.

If set to true, the struct will pass a few kilobytes of to-be-signed data from the document to the OnExternalSign event. This only applies when SignExternal() is called.

Data Type

bool

external_crypto_hash_algorithm property (FTPServer Struct)

Specifies the request's signature hash algorithm.

Syntax

fn external_crypto_hash_algorithm(&self ) -> Result<String, SecureBlackboxError> 
fn set_external_crypto_hash_algorithm(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_external_crypto_hash_algorithm_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

"SHA256"

Remarks

Specifies the request's signature hash algorithm.

Data Type

String

external_crypto_key_id property (FTPServer Struct)

The ID of the pre-shared key used for DC request authentication.

Syntax

fn external_crypto_key_id(&self ) -> Result<String, SecureBlackboxError> 
fn set_external_crypto_key_id(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_external_crypto_key_id_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The ID of the pre-shared key used for DC request authentication.

Asynchronous DCAuth-driven communication requires that parties authenticate each other with a secret pre-shared cryptographic key. This provides an extra protection layer for the protocol and diminishes the risk of the private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use external_crypto_key_secret to pass the key itself.

The same KeyID/KeySecret pair should be used on the DCAuth side for the signing requests to be accepted.

Note: The KeyID/KeySecret scheme is very similar to the AuthKey scheme used in various Cloud service providers to authenticate users.

Example: signer.ExternalCrypto.KeyID = "MainSigningKey"; signer.ExternalCrypto.KeySecret = "abcdef0123456789";

Data Type

String

external_crypto_key_secret property (FTPServer Struct)

The pre-shared key used for DC request authentication.

Syntax

fn external_crypto_key_secret(&self ) -> Result<String, SecureBlackboxError> 
fn set_external_crypto_key_secret(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_external_crypto_key_secret_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The pre-shared key used for DC request authentication. This key must be set and match the key used by the DCAuth counterpart for the scheme to work.

Read more about configuring authentication in the external_crypto_key_id topic.

Data Type

String

external_crypto_method property (FTPServer Struct)

Specifies the asynchronous signing method.

Syntax

fn external_crypto_method(&self ) -> Result<i32, SecureBlackboxError> 
fn set_external_crypto_method(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // PKCS1
1   // PKCS7

Default Value

0

Remarks

Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup.

Available options:

Data Type

i32

external_crypto_mode property (FTPServer Struct)

Specifies the external cryptography mode.

Syntax

fn external_crypto_mode(&self ) -> Result<i32, SecureBlackboxError> 
fn set_external_crypto_mode(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // Default
1   // Disabled
2   // Generic
3   // DCAuth
4   // DCAuthJSON

Default Value

0

Remarks

Specifies the external cryptography mode.

Available options:

Data Type

i32

external_crypto_public_key_algorithm property (FTPServer Struct)

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

Syntax

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

Default Value

""

Remarks

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

Data Type

String

fips_mode property (FTPServer Struct)

Reserved.

Syntax

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

Default Value

false

Remarks

This property is reserved for future use.

Data Type

bool

handshake_timeout property (FTPServer Struct)

Specifies the handshake timeout in milliseconds.

Syntax

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

Default Value

20000

Remarks

Use this property to set the TLS handshake timeout.

Data Type

i32

host property (FTPServer Struct)

Specifies the server host.

Syntax

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

Default Value

""

Remarks

Use this property to specify the IP address on which to listen for incoming FTP connections. Use port to specify the listening port number.

Data Type

String

implicit_ssl property (FTPServer Struct)

Enables or disables implicit SSL mode.

Syntax

fn implicit_ssl(&self ) -> Result<bool, SecureBlackboxError> 
fn set_implicit_ssl(&self, value : bool) ->  Option<SecureBlackboxError> 

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)

The IP address of the passive mode host.

Syntax

fn passive_mode_host(&self ) -> Result<String, SecureBlackboxError> 
fn set_passive_mode_host(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_passive_mode_host_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

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)

Indicates whether the encryption algorithm used is an AEAD cipher.

Syntax

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

Default Value

false

Remarks

Indicates whether the encryption algorithm used is an AEAD cipher.

This property is read-only.

Data Type

bool

pinned_client_chain_validation_details property (FTPServer Struct)

The details of a certificate chain validation outcome.

Syntax

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

Default Value

0

Remarks

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

Returns a bit mask of the following options:

This property is read-only.

Data Type

i32

pinned_client_chain_validation_result property (FTPServer Struct)

The outcome of a certificate chain validation routine.

Syntax

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

Possible Values

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

Default Value

0

Remarks

The outcome of a certificate chain validation routine.

Available options:

Use the ValidationLog property to access the detailed validation log.

This property is read-only.

Data Type

i32

pinned_client_ciphersuite property (FTPServer Struct)

The cipher suite employed by this connection.

Syntax

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

Default Value

""

Remarks

The cipher suite employed by this connection.

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

This property is read-only.

Data Type

String

pinned_client_client_authenticated property (FTPServer Struct)

Specifies whether client authentication was performed during this connection.

Syntax

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

Default Value

false

Remarks

Specifies whether client authentication was performed during this connection.

This property is read-only.

Data Type

bool

pinned_client_client_auth_requested property (FTPServer Struct)

Specifies whether client authentication was requested during this connection.

Syntax

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

Default Value

false

Remarks

Specifies whether client authentication was requested during this connection.

This property is read-only.

Data Type

bool

pinned_client_connection_established property (FTPServer Struct)

Indicates whether the connection has been established fully.

Syntax

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

Default Value

false

Remarks

Indicates whether the connection has been established fully.

This property is read-only.

Data Type

bool

pinned_client_connection_id property (FTPServer Struct)

The unique identifier assigned to this connection.

Syntax

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

Remarks

The unique identifier assigned to this connection.

This property is read-only.

Data Type

Vec

pinned_client_digest_algorithm property (FTPServer Struct)

The digest algorithm used in a TLS-enabled connection.

Syntax

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

Default Value

""

Remarks

The digest algorithm used in a TLS-enabled connection.

This property is read-only.

Data Type

String

pinned_client_encryption_algorithm property (FTPServer Struct)

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

Syntax

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

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

pinned_client_exportable property (FTPServer Struct)

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

Syntax

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

Default Value

false

Remarks

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

This property is read-only.

Data Type

bool

pinned_client_group property (FTPServer Struct)

The elliptic curve used in this connection.

Syntax

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

Default Value

""

Remarks

The elliptic curve used in this connection.

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

This property is read-only.

Data Type

String

pinned_client_id property (FTPServer Struct)

The client connection's unique identifier.

Syntax

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

Default Value

-1

Remarks

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

This property is read-only.

Data Type

i64

pinned_client_key_exchange_algorithm property (FTPServer Struct)

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

Syntax

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

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

pinned_client_key_exchange_key_bits property (FTPServer Struct)

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

Syntax

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

Default Value

0

Remarks

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

This property is read-only.

Data Type

i32

pinned_client_pfs_cipher property (FTPServer Struct)

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

Syntax

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

Default Value

false

Remarks

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

This property is read-only.

Data Type

bool

pinned_client_pre_shared_identity property (FTPServer Struct)

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

Syntax

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

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

pinned_client_pre_shared_identity_hint property (FTPServer Struct)

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

Syntax

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

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

pinned_client_public_key_bits property (FTPServer Struct)

The length of the public key.

Syntax

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

Default Value

0

Remarks

The length of the public key.

This property is read-only.

Data Type

i32

pinned_client_remote_address property (FTPServer Struct)

The client's IP address.

Syntax

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

Default Value

""

Remarks

The client's IP address.

This property is read-only.

Data Type

String

pinned_client_remote_port property (FTPServer Struct)

The remote port of the client connection.

Syntax

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

Default Value

0

Remarks

The remote port of the client connection.

This property is read-only.

Data Type

i32

pinned_client_resumed_session property (FTPServer Struct)

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

Syntax

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

Default Value

false

Remarks

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

This property is read-only.

Data Type

bool

pinned_client_secure_connection property (FTPServer Struct)

Indicates whether TLS or SSL is enabled for this connection.

Syntax

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

Default Value

false

Remarks

Indicates whether TLS or SSL is enabled for this connection.

This property is read-only.

Data Type

bool

pinned_client_server_authenticated property (FTPServer Struct)

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

Syntax

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

Default Value

false

Remarks

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

This property is read-only.

Data Type

bool

pinned_client_signature_algorithm property (FTPServer Struct)

The signature algorithm used in a TLS handshake.

Syntax

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

Default Value

""

Remarks

The signature algorithm used in a TLS handshake.

This property is read-only.

Data Type

String

pinned_client_symmetric_block_size property (FTPServer Struct)

The block size of the symmetric algorithm used.

Syntax

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

Default Value

0

Remarks

The block size of the symmetric algorithm used.

This property is read-only.

Data Type

i32

pinned_client_symmetric_key_bits property (FTPServer Struct)

The key length of the symmetric algorithm used.

Syntax

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

Default Value

0

Remarks

The key length of the symmetric algorithm used.

This property is read-only.

Data Type

i32

pinned_client_total_bytes_received property (FTPServer Struct)

The total number of bytes received over this connection.

Syntax

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

Default Value

0

Remarks

The total number of bytes received over this connection.

This property is read-only.

Data Type

i64

pinned_client_total_bytes_sent property (FTPServer Struct)

The total number of bytes sent over this connection.

Syntax

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

Default Value

0

Remarks

The total number of bytes sent over this connection.

This property is read-only.

Data Type

i64

pinned_client_validation_log property (FTPServer Struct)

Contains the server certificate's chain validation log.

Syntax

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

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

pinned_client_version property (FTPServer Struct)

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

Syntax

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

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

pinned_client_cert_count property (FTPServer Struct)

The number of records in the PinnedClientCert arrays.

Syntax

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

Default Value

0

Remarks

This property controls the size of the following arrays:

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

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

This property is read-only.

Data Type

i32

pinned_client_cert_bytes property (FTPServer Struct)

Returns the raw certificate data in DER format.

Syntax

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

Remarks

Returns the raw certificate data in DER format.

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

This property is read-only.

Data Type

Vec

pinned_client_cert_ca_key_id property (FTPServer Struct)

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

Syntax

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

Remarks

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

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

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

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

This property is read-only.

Data Type

Vec

pinned_client_cert_fingerprint property (FTPServer Struct)

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

Syntax

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

Default Value

""

Remarks

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

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

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

This property is read-only.

Data Type

String

pinned_client_cert_handle property (FTPServer Struct)

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

Syntax

fn pinned_client_cert_handle(&self , PinnedClientCertIndex : i32) -> Result<i64, SecureBlackboxError> 

Default Value

0

Remarks

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

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

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

This property is read-only.

Data Type

i64

pinned_client_cert_issuer property (FTPServer Struct)

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

Syntax

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

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

pinned_client_cert_issuer_rdn property (FTPServer Struct)

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

Syntax

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

Default Value

""

Remarks

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

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

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

This property is read-only.

Data Type

String

pinned_client_cert_key_algorithm property (FTPServer Struct)

Specifies the public key algorithm of this certificate.

Syntax

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

Default Value

"0"

Remarks

Specifies the public key algorithm of this certificate.

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

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

This property is read-only.

Data Type

String

pinned_client_cert_key_bits property (FTPServer Struct)

Returns the length of the public key in bits.

Syntax

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

Default Value

0

Remarks

Returns the length of the public key in bits.

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

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

This property is read-only.

Data Type

i32

pinned_client_cert_key_fingerprint property (FTPServer Struct)

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

Syntax

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

Default Value

""

Remarks

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

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

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

This property is read-only.

Data Type

String

pinned_client_cert_key_usage property (FTPServer Struct)

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

Syntax

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

Default Value

0

Remarks

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

This value is a bit mask of the following values:

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

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

This property is read-only.

Data Type

i32

pinned_client_cert_public_key_bytes property (FTPServer Struct)

Contains the certificate's public key in DER format.

Syntax

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

Remarks

Contains the certificate's public key in DER format.

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

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

This property is read-only.

Data Type

Vec

pinned_client_cert_self_signed property (FTPServer Struct)

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

Syntax

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

Default Value

false

Remarks

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

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

This property is read-only.

Data Type

bool

pinned_client_cert_serial_number property (FTPServer Struct)

Returns the certificate's serial number.

Syntax

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

Remarks

Returns the certificate's serial number.

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

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

This property is read-only.

Data Type

Vec

pinned_client_cert_sig_algorithm property (FTPServer Struct)

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

Syntax

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

Default Value

""

Remarks

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

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

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

This property is read-only.

Data Type

String

pinned_client_cert_subject property (FTPServer Struct)

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

Syntax

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

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

pinned_client_cert_subject_key_id property (FTPServer Struct)

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

Syntax

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

Remarks

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

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

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

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

This property is read-only.

Data Type

Vec

pinned_client_cert_subject_rdn property (FTPServer Struct)

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

Syntax

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

Default Value

""

Remarks

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

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

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

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

This property is read-only.

Data Type

String

pinned_client_cert_valid_from property (FTPServer Struct)

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

Syntax

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

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

pinned_client_cert_valid_to property (FTPServer Struct)

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

Syntax

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

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

port property (FTPServer Struct)

The port number to listen for incoming connections on.

Syntax

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

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)

Makes the server's file system read-only for all users.

Syntax

fn read_only(&self ) -> Result<bool, SecureBlackboxError> 
fn set_read_only(&self, value : bool) ->  Option<SecureBlackboxError> 

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)

Specifies the server's root directory.

Syntax

fn root_directory(&self ) -> Result<String, SecureBlackboxError> 
fn set_root_directory(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_root_directory_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Use this property to specify the shared root directory for all client sessions.

Data Type

String

security_options property (FTPServer Struct)

Various options of the secure connection.

Syntax

fn security_options(&self ) -> Result<i32, SecureBlackboxError> 
fn set_security_options(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

63

Remarks

Various options of the secure connection:

Data Type

i32

session_timeout property (FTPServer Struct)

Specifies the session timeout in milliseconds.

Syntax

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

Default Value

360000

Remarks

Specifies the maximum inactivity time (in milliseconds) after which the session will be forcibly closed.

Data Type

i32

socket_incoming_speed_limit property (FTPServer Struct)

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

Syntax

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

Default Value

0

Remarks

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

Data Type

i32

socket_local_address property (FTPServer Struct)

The local network interface to bind the socket to.

Syntax

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

Default Value

""

Remarks

The local network interface to bind the socket to.

Data Type

String

socket_local_port property (FTPServer Struct)

The local port number to bind the socket to.

Syntax

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

Default Value

0

Remarks

The local port number to bind the socket to.

Data Type

i32

socket_outgoing_speed_limit property (FTPServer Struct)

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

Syntax

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

Default Value

0

Remarks

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

Data Type

i32

socket_timeout property (FTPServer Struct)

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

Syntax

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

Default Value

60000

Remarks

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

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

Data Type

i32

socket_use_ipv6 property (FTPServer Struct)

Enables or disables IP protocol version 6.

Syntax

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

Default Value

false

Remarks

Enables or disables IP protocol version 6.

Data Type

bool

tls_server_cert_count property (FTPServer Struct)

The number of records in the TLSServerCert arrays.

Syntax

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

Default Value

0

Remarks

This property controls the size of the following arrays:

• tls_server_cert_bytes
• tls_server_cert_handle

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

Data Type

i32

tls_server_cert_bytes property (FTPServer Struct)

Returns the raw certificate data in DER format.

Syntax

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

Remarks

Returns the raw certificate data in DER format.

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

This property is read-only.

Data Type

Vec

tls_server_cert_handle property (FTPServer Struct)

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

Syntax

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

Default Value

0

Remarks

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

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

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

Data Type

i64

tls_auto_validate_certificates property (FTPServer Struct)

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

Syntax

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

Default Value

true

Remarks

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

Data Type

bool

tls_base_configuration property (FTPServer Struct)

Selects the base configuration for the TLS settings.

Syntax

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

Possible Values

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

Default Value

0

Remarks

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

Data Type

i32

tls_ciphersuites property (FTPServer Struct)

A list of ciphersuites separated with commas or semicolons.

Syntax

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

Default Value

""

Remarks

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

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

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

Data Type

String

tls_client_auth property (FTPServer Struct)

Enables or disables certificate-based client authentication.

Syntax

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

Possible Values

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

Default Value

0

Remarks

Enables or disables certificate-based client authentication.

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

Data Type

i32

tls_extensions property (FTPServer Struct)

Provides access to TLS extensions.

Syntax

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

Default Value

""

Remarks

Provides access to TLS extensions.

Data Type

String

tls_force_resume_if_destination_changes property (FTPServer Struct)

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

Syntax

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

Default Value

false

Remarks

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

Data Type

bool

tls_groups property (FTPServer Struct)

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

Syntax

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

Default Value

""

Remarks

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

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

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

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

Elliptic curve-based groups:

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

Finite field-based groups:

• FFDHE2048
• FFDHE3072
• FFDHE4096
• FFDHE6144
• FFDHE8192

Post-Quantum and Hybrid groups:

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

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

Data Type

String

tls_pre_shared_identity property (FTPServer Struct)

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

Syntax

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

Default Value

""

Remarks

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

Data Type

String

tls_pre_shared_key property (FTPServer Struct)

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

Syntax

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

Default Value

""

Remarks

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

Data Type

String

tls_pre_shared_key_ciphersuite property (FTPServer Struct)

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

Syntax

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

Default Value

""

Remarks

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

Data Type

String

tls_renegotiation_attack_prevention_mode property (FTPServer Struct)

Selects the renegotiation attack prevention mechanism.

Syntax

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

Possible Values

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

Default Value

2

Remarks

Selects the renegotiation attack prevention mechanism.

The following options are available:

Data Type

i32

tls_revocation_check property (FTPServer Struct)

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

Syntax

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

Possible Values

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

Default Value

1

Remarks

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

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

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

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

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

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

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

Data Type

i32

tls_ssl_options property (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.

Syntax

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

Default Value

16

Remarks

Various SSL (TLS) protocol options, set of

Data Type

i32

tls_mode property (FTPServer Struct)

Specifies the TLS mode to use.

Syntax

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

Possible Values

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

Default Value

0

Remarks

Specifies the TLS mode to use.

Data Type

i32

tls_use_extended_master_secret property (FTPServer Struct)

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

Syntax

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

Default Value

true

Remarks

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

Data Type

bool

tls_use_session_resumption property (FTPServer Struct)

Enables or disables the TLS session resumption capability.

Syntax

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

Default Value

false

Remarks

Enables or disables the TLS session resumption capability.

Data Type

bool

tls_versions property (FTPServer Struct)

The SSL/TLS versions to enable by default.

Syntax

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

Default Value

48

Remarks

The SSL/TLS versions to enable by default.

Data Type

i32

user_count property (FTPServer Struct)

The number of records in the User arrays.

Syntax

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

Default Value

0

Remarks

This property controls the size of the following arrays:

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

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

Data Type

i32

user_associated_data property (FTPServer Struct)

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

Syntax

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

Remarks

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

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

Data Type

Vec

user_base_path property (FTPServer Struct)

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

Syntax

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

Default Value

""

Remarks

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

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

Data Type

String

user_data property (FTPServer Struct)

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

Syntax

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

Default Value

""

Remarks

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

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

Data Type

String

user_handle property (FTPServer Struct)

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

Syntax

fn user_handle(&self , UserIndex : i32) -> Result<i64, SecureBlackboxError> 
fn set_user_handle(&self, UserIndex : i32, value : i64) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

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

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

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

Data Type

i64

user_hash_algorithm property (FTPServer Struct)

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

Syntax

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

Default Value

""

Remarks

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

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

Data Type

String

user_incoming_speed_limit property (FTPServer Struct)

Specifies the incoming speed limit for this user.

Syntax

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

Default Value

0

Remarks

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

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

Data Type

i32

user_outgoing_speed_limit property (FTPServer Struct)

Specifies the outgoing speed limit for this user.

Syntax

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

Default Value

0

Remarks

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

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

Data Type

i32

user_password property (FTPServer Struct)

The user's authentication password.

Syntax

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

Default Value

""

Remarks

The user's authentication password.

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

Data Type

String

user_shared_secret property (FTPServer Struct)

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

Syntax

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

Remarks

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

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

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

Data Type

Vec

username property (FTPServer Struct)

The registered name (login) of the user.

Syntax

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

Default Value

""

Remarks

The registered name (login) of the user.

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

Data Type

String

use_utf8 property (FTPServer Struct)

Enables or disables UTF8 file name conversions.

Syntax

fn use_utf8(&self ) -> Result<bool, SecureBlackboxError> 
fn set_use_utf8(&self, value : bool) ->  Option<SecureBlackboxError> 

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)

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

Syntax

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

Remarks

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

config method (FTPServer Struct)

Sets or retrieves a configuration setting.

Syntax

fn config(&self, configuration_string : &str) ->  Result<String, SecureBlackboxError>

Remarks

config is a generic method available in every struct. It is used to set and retrieve configuration settings for the struct.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, access to these internal properties is provided through the config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

do_action method (FTPServer Struct)

Performs an additional action.

Syntax

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

Remarks

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

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

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

Common ActionIDs:

drop_client method (FTPServer Struct)

Terminates a client connection.

Syntax

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

Remarks

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

get_client_buffer method (FTPServer Struct)

Obtains a pending connection buffer.

Syntax

fn get_client_buffer(&self, connection_id : i64) ->  Result<Vec<u8>, SecureBlackboxError>

Remarks

Use this method to obtain a pending connection buffer from your on_write_file event handler. The connection buffer contains data that have been received from the client but has not been written to the file yet.

list_clients method (FTPServer Struct)

Enumerates the connected clients.

Syntax

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

Remarks

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

pin_client method (FTPServer Struct)

Takes a snapshot of the connection's properties.

Syntax

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

Remarks

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

reset method (FTPServer Struct)

Resets the struct settings.

Syntax

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

Remarks

reset is a generic method available in every struct.

set_client_buffer method (FTPServer Struct)

Commits a data buffer to the connection.

Syntax

fn set_client_buffer(&self, connection_id : i64, value : &[u8]) -> Result<(), SecureBlackboxError>

Remarks

Use this method from your on_read_file event handler to commit a chunk of file data to the server component.

set_client_file_entry method (FTPServer Struct)

Commits a file entry to the connection.

Syntax

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

Remarks

Use this method to commit a file details entry provided in client_file_entry property to ConnectionID connection. This method is supposed to be used from a on_find_next event handler.

Please note that events like on_find_next may be invoked concurrently for several connection threads. Please make sure you use a locking mechanism to avoid mixing up details in client_file_entry.

start method (FTPServer Struct)

Starts the server.

Syntax

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

Remarks

Call this method to start listening for incoming connections on port port. Call stop to deactivate the server.

stop method (FTPServer Struct)

Stops the server.

Syntax

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)

Reports an incoming connection.

Syntax

// 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 event to be notified of every connection that has been set up.

on_after_change_directory event (FTPServer Struct)

Signals the completion of a directory change operation.

Syntax

// 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:

on_after_create_directory event (FTPServer Struct)

Signals the completion of a directory creation operation.

Syntax

// 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:

on_after_remove_directory event (FTPServer Struct)

Signals the completion of a directory removal operation.

Syntax

// 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:

on_after_remove_file event (FTPServer Struct)

Signals the completion of a file removal operation.

Syntax

// 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:

on_after_rename_file event (FTPServer Struct)

Signals the completion of a file renaming operation.

Syntax

// 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:

on_after_request_attributes event (FTPServer Struct)

Signals the completion of an attribute request.

Syntax

// 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:

on_auth_attempt event (FTPServer Struct)

Fires when a connected client makes an authentication attempt.

Syntax

// 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 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)

Notifies about an incoming change directory request.

Syntax

// 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 to let the server handle the request automatically, or to fraCustom to handle the request in your code. Subscribe to on_change_directory to be notified when to perform the request. It is the on_change_directory 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 event will be fired.

Choose Action as one of the following values:

on_before_create_directory event (FTPServer Struct)

Notifies about an incoming create directory request.

Syntax

// 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 to let the server handle the request automatically, or to fraCustom to handle the request in your code. Subscribe to on_create_directory to be notified when to perform the request. It is the on_create_directory 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 event will be fired.

Choose Action as one of the following values:

on_before_download_file event (FTPServer Struct)

Notifies about an incoming file download request.

Syntax

// 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 to let the server handle the request automatically, or to fraCustom to handle the request in your code. Subscribe to on_download_file to be notified when to perform the request. It is the on_download_file event handler where you should perform the overridden action.

Upon completion of the request, either in manual or override mode, the on_transfer_completed event will be fired.

Choose Action as one of the following values:

on_before_find event (FTPServer Struct)

Notifies about an incoming file listing request.

Syntax

// 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 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_next, and on_find_close to be notified when to perform the request. It is the on_find_init and on_find_next 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 event will be fired.

Choose Action as one of the following values:

on_before_remove_directory event (FTPServer Struct)

Notifies about an incoming directory removal request.

Syntax

// 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 to let the server handle the request automatically, or to fraCustom to handle the request in your code. Subscribe to on_remove_directory to be notified when to perform the request. It is the on_remove_directory 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 event will be fired.

Choose Action as one of the following values:

on_before_remove_file event (FTPServer Struct)

Notifies about an incoming file removal request.

Syntax

// 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 to let the server handle the request automatically, or to fraCustom to handle the request in your code. Subscribe to on_remove_file to be notified when to perform the request. It is the on_remove_file 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 event will be fired.

Choose Action as one of the following values:

Note that you must subscribe to on_before_request_attributes and on_request_attributes 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 call.

on_before_rename_file event (FTPServer Struct)

Notifies about an incoming file rename request.

Syntax

// 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 to let the server handle the request automatically, or to fraCustom to handle the request in your code. Subscribe to on_rename_file to be notified when to perform the request. It is the on_rename_file 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 event will be fired.

Choose Action as one of the following values:

Note that you must subscribe to on_before_request_attributes and on_request_attributes 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 call.

on_before_request_attributes event (FTPServer Struct)

Notifies about an incoming attributes request.

Syntax

// 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 to let the server handle the request automatically, or to fraCustom to handle the request in your code. Subscribe to on_request_attributes to be notified when to perform the request. It is the on_request_attributes 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 event will be fired.

Choose Action as one of the following values:

on_before_send_reply event (FTPServer Struct)

Notifies the application of a command reply being sent.

Syntax

// 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)

Notifies about an incoming file upload request.

Syntax

// 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 to let the server handle the request automatically, or to fraCustom to handle the request in your code. Subscribe to on_upload_file to be notified when to perform the request. It is the on_upload_file event handler where you should perform the overridden action.

Upon completion of the request, either in manual or override mode, the on_transfer_completed event will be fired.

Choose Action as one of the following values:

on_change_directory event (FTPServer Struct)

An override for a directory change operation.

Syntax

// 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 was passed back from on_before_change_directory 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 call which will let you make final adjustments to the returned code.

Set OperationStatus to one of the following values:

on_command_processed event (FTPServer Struct)

Signals that a command has been processed by the server.

Syntax

// 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 event handler.

on_command_received event (FTPServer Struct)

Signals that a command has been received from the client.

Syntax

// 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 call.

on_connect event (FTPServer Struct)

Reports an accepted connection.

Syntax

// 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 or on_before_upload_file.

on_create_directory event (FTPServer Struct)

An override for a directory creation operation.

Syntax

// 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 was passed back from on_before_create_directory 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 call which will let you make final adjustments to the returned code.

Set OperationStatus to one of the following values:

on_disconnect event (FTPServer Struct)

Fires to report a disconnected client.

Syntax

// 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)

The struct fires this event to notify the application about the start of a file download.

Syntax

// 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)

Reports the completion of the download operation.

Syntax

// 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)

An override for a file download initiation operation.

Syntax

// 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 was passed back from on_before_download_file 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 calls, requesting the file data from your code, followed by a single on_transfer_completed call.

Set OperationStatus to one of the following values:

on_download_progress event (FTPServer Struct)

Reports the progress of an active download operation.

Syntax

// 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)

Information about errors during data delivery.

Syntax

// 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 section.

on_external_sign event (FTPServer Struct)

Handles remote or external signing initiated by the server protocol.

Syntax

// 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: 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)

Signals the completion of a directory listing request.

Syntax

// 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)

An override for a directory listing initiation operation.

Syntax

// 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 was passed back from on_before_find 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 calls, requesting the directory listing entry by entry from your code, followed by a on_find_close call.

Set OperationStatus to one of the following values:

on_find_next event (FTPServer Struct)

An override for a directory listing entry request operation.

Syntax

// 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 to request one directory entry from the application.

This event only fires if Action = fraCustom was passed back from on_before_find 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 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 call which will let you make final adjustments to the returned code.

Set OperationStatus to one of the following values:

on_notification event (FTPServer Struct)

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

Syntax

// 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:

on_read_file event (FTPServer Struct)

Requests a piece of file data from the application.

Syntax

// 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 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:

on_remove_directory event (FTPServer Struct)

An override for a directory removal operation.

Syntax

// 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 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 call which will let you make final adjustments to the returned code.

Set OperationStatus to one of the following values:

on_remove_file event (FTPServer Struct)

An override for a file remove operation.

Syntax

// 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 was passed back from on_before_remove_file 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 call which will let you make final adjustments to the returned code.

Set OperationStatus to one of the following values:

Please see a remark about virtualizing file removals in the on_before_remove_file topic.

on_rename_file event (FTPServer Struct)

An override for a file rename operation.

Syntax

// 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 was passed back from on_before_rename_file 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 call which will let you make final adjustments to the returned code.

Set OperationStatus to one of the following values:

Please see a remark about virtualizing file renamings in the on_before_rename_file topic.

on_request_attributes event (FTPServer Struct)

An override for an attribute request.

Syntax

// 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 was passed back from on_before_request_attributes 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 call which will let you make final adjustments to the returned code.

Set OperationStatus to one of the following values:

on_tls_cert_validate event (FTPServer Struct)

Fires when a client certificate needs to be validated.

Syntax

// 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)

Reports the setup of a TLS session.

Syntax

// 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)

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

Syntax

// 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)

Requests a pre-shared key for TLS-PSK.

Syntax

// 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)

Reports closure of a TLS session.

Syntax

// 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, which marks the closure of the underlying TCP session.

on_transfer_completed event (FTPServer Struct)

This event is fired when a customized upload or download operation completes.

Syntax

// 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 or on_before_download_file event, and with Action parameter set to fraCustom.

The ConnectionID parameter specifies the session to which the event belongs, and OperationStatus reports the outcome of the transfer operation.

on_upload_begin event (FTPServer Struct)

The server fires this event to notify the application about the start of a file upload operation.

Syntax

// 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)

Reports the completion of the upload operation.

Syntax

// 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)

An override for a file upload initiation operation.

Syntax

// 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 was passed back from on_before_upload_file 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 calls, passing the file data to your code, followed by a single on_transfer_completed call.

Set OperationStatus to one of the following values:

on_upload_progress event (FTPServer Struct)

Reports the progress of an active upload operation.

Syntax

// 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)

Hands a piece of file data to the application.

Syntax

// 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 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:

Config Settings (FTPServer Struct)

The struct accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, access to these internal properties is provided through the config method.

FTPServer Config Settings

Base Config Settings

Trappable Errors (FTPServer Struct)

FTPServer Errors