Struct secureblackbox::SFTPServer

Properties   Methods   Events   Config Settings   Errors  

The SFTPServer struct provides server-side functionality for SFTP connections.

Syntax

secureblackbox::SFTPServer

Remarks

SFTPServer is an implementation for SSH File Transfer Protocol server. It works over a secure SSH channel, and should not be confused with the FTP/FTPS protocol.

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

Specifies whether the SFTP server has started and ready to accept connections.

Syntax

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

Default Value

false

Remarks

Check this property to find out whether the SFTP server is in active mode. Use start and stop methods to activate or deactivate the server.

This property is read-only.

Data Type

bool

auth_types property (SFTPServer Struct)

Defines allowed authentication types.

Syntax

fn auth_types(&self ) -> Result<i32, SecureBlackboxError> 
fn set_auth_types(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

30

Remarks

Use this property to define which authentication types are allowed on the server, set of

Data Type

i32

base_dir property (SFTPServer Struct)

Specifies the server's base (root) directory.

Syntax

fn base_dir(&self ) -> Result<String, SecureBlackboxError> 
fn set_base_dir(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_base_dir_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Use this property to set the base (root) directory on the server.

NOTE: If this property is not specified, it will default to the root of the system drive (C:\ on Windows).

Data Type

String

capabilities property (SFTPServer Struct)

Specifies which elements of the SSH ecosystem the struct must support/enable.

Syntax

fn capabilities(&self ) -> Result<i32, SecureBlackboxError> 
fn set_capabilities(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

1

Remarks

Use this property to specify the capabilities of the SSH framework the component must support by adjusting the following bit flags:

Data Type

i32

client_file_entry_access_time property (SFTPServer 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 (SFTPServer 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 (SFTPServer 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 (SFTPServer 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 (SFTPServer 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 (SFTPServer 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 (SFTPServer 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 (SFTPServer 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 (SFTPServer 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 (SFTPServer 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 (SFTPServer 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 (SFTPServer 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

client_key_fingerprint_sha1 property (SFTPServer Struct)

Contains the SHA-1 fingerprint (hash) of the key.

Syntax

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

Default Value

""

Remarks

Contains the SHA-1 fingerprint (hash) of the key.

This property is read-only.

Data Type

String

client_key_fingerprint_sha256 property (SFTPServer Struct)

Contains the SHA-256 fingerprint (hash) of the key.

Syntax

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

Default Value

""

Remarks

Contains the SHA-256 fingerprint (hash) of the key.

This property is read-only.

Data Type

String

client_key_handle property (SFTPServer Struct)

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

Syntax

fn client_key_handle(&self ) -> 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());

This property is read-only.

Data Type

i64

compression_level property (SFTPServer Struct)

Specifies the preferable compression level.

Syntax

fn compression_level(&self ) -> Result<i32, SecureBlackboxError> 
fn set_compression_level(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

9

Remarks

Set this property before starting the server. Possible values range from 0 (lowest compression) to 9 (maximum compression). This property is ignored if compression wasn't accepted.

Data Type

i32

external_crypto_async_document_id property (SFTPServer 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 (SFTPServer 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 (SFTPServer 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 (SFTPServer 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 (SFTPServer 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 (SFTPServer 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 (SFTPServer 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 (SFTPServer 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 (SFTPServer 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 (SFTPServer 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 (SFTPServer 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

force_compression property (SFTPServer Struct)

This property specifies whether server explicitly requires data compression.

Syntax

fn force_compression(&self ) -> Result<bool, SecureBlackboxError> 
fn set_force_compression(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

Set this property before starting the server. If it is set to true, the struct will explicitly request data compression. If it is set to False, the struct will support compression, although compression will be used only if the remote party doesn't support algorithms without compression.

Data Type

bool

host property (SFTPServer Struct)

Specifies server's host name.

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 set the host name for this server.

Data Type

String

max_sftp_version property (SFTPServer Struct)

Maximum SFTP version supported.

Syntax

fn max_sftp_version(&self ) -> Result<i32, SecureBlackboxError> 
fn set_max_sftp_version(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

6

Remarks

max_sftp_version and min_sftp_version properties control the range of SFTP protocol versions supported by this server.

Data Type

i32

min_sftp_version property (SFTPServer Struct)

Minimum SFTP version supported.

Syntax

fn min_sftp_version(&self ) -> Result<i32, SecureBlackboxError> 
fn set_min_sftp_version(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

max_sftp_version and min_sftp_version properties control the range of SFTP protocol versions supported by this server.

Data Type

i32

pinned_client_client_key_algorithm property (SFTPServer Struct)

Specifies the client's key algorithm.

Syntax

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

Default Value

""

Remarks

Specifies the client's key algorithm.

This property is read-only.

Data Type

String

pinned_client_client_key_bits property (SFTPServer Struct)

Specifies the length of the client's key.

Syntax

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

Default Value

0

Remarks

Specifies the length of the client's key.

This property is read-only.

Data Type

i32

pinned_client_client_key_fingerprint property (SFTPServer Struct)

The fingerprint (hash value) of the client's public key.

Syntax

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

Default Value

""

Remarks

The fingerprint (hash value) of the client's public key.

This property is read-only.

Data Type

String

pinned_client_close_reason property (SFTPServer Struct)

Contains the line sent by the server just before closing the connection.

Syntax

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

Default Value

""

Remarks

Contains the line sent by the server just before closing the connection. It might contain the error description if the connection was not closed gracefully.

This property is read-only.

Data Type

String

pinned_client_compression_algorithm_inbound property (SFTPServer Struct)

Compression algorithm for the incoming traffic.

Syntax

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

Default Value

""

Remarks

Compression algorithm for the incoming traffic.

This property is read-only.

Data Type

String

pinned_client_compression_algorithm_outbound property (SFTPServer Struct)

Compression algorithm for the outgoing traffic.

Syntax

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

Default Value

""

Remarks

Compression algorithm for the outgoing traffic.

This property is read-only.

Data Type

String

pinned_client_encryption_algorithm_inbound property (SFTPServer Struct)

Encryption algorithm for the incoming traffic.

Syntax

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

Default Value

""

Remarks

Encryption algorithm for the incoming traffic.

This property is read-only.

Data Type

String

pinned_client_encryption_algorithm_outbound property (SFTPServer Struct)

Encryption algorithm for the outgoing traffic.

Syntax

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

Default Value

""

Remarks

Encryption algorithm for the outgoing traffic.

This property is read-only.

Data Type

String

pinned_client_inbound_encryption_key_bits property (SFTPServer Struct)

Specifies the length of the key used to encrypt the incoming traffic.

Syntax

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

Default Value

0

Remarks

Specifies the length of the key used to encrypt the incoming traffic.

This property is read-only.

Data Type

i32

pinned_client_kex_algorithm property (SFTPServer Struct)

The key exchange algorithm used during the SSH handshake.

Syntax

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

Default Value

""

Remarks

The key exchange algorithm used during the SSH handshake.

This property is read-only.

Data Type

String

pinned_client_kex_bits property (SFTPServer Struct)

The number of bits used by the key exchange algorithm.

Syntax

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

Default Value

0

Remarks

The number of bits used by the key exchange algorithm.

This property is read-only.

Data Type

i32

pinned_client_kex_lines property (SFTPServer Struct)

The contents of the received KexInit packet.

Syntax

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

Default Value

""

Remarks

The contents of the received KexInit packet.

KexInit packet contains the list of algorithms supported by the remote party.

This property is read-only.

Data Type

String

pinned_client_mac_algorithm_inbound property (SFTPServer Struct)

MAC algorithm used for the incoming connection.

Syntax

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

Default Value

""

Remarks

MAC algorithm used for the incoming connection.

This property is read-only.

Data Type

String

pinned_client_mac_algorithm_outbound property (SFTPServer Struct)

MAC algorithm used for outbound connection.

Syntax

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

Default Value

""

Remarks

MAC algorithm used for outbound connection.

This property is read-only.

Data Type

String

pinned_client_outbound_encryption_key_bits property (SFTPServer Struct)

Specifies the length of the key used to encrypt the outgoing traffic.

Syntax

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

Default Value

0

Remarks

Specifies the length of the key used to encrypt the outgoing traffic.

This property is read-only.

Data Type

i32

pinned_client_public_key_algorithm property (SFTPServer Struct)

Specifies the public key algorithm which was used during the SSH handshake.

Syntax

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

Default Value

""

Remarks

Specifies the public key algorithm which was used during the SSH handshake.

This property is read-only.

Data Type

String

pinned_client_remote_address property (SFTPServer 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 (SFTPServer 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_remote_software_name property (SFTPServer Struct)

Returns the name (self-advertised) of the SSH software running on the other side.

Syntax

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

Default Value

""

Remarks

Returns the name (self-advertised) of the SSH software running on the other side.

This property is read-only.

Data Type

String

pinned_client_server_key_algorithm property (SFTPServer Struct)

Specifies the server's key algorithm.

Syntax

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

Default Value

""

Remarks

Specifies the server's key algorithm.

This property is read-only.

Data Type

String

pinned_client_server_key_bits property (SFTPServer Struct)

Specifies the number of bits in the server's key.

Syntax

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

Default Value

0

Remarks

Specifies the number of bits in the server's key.

This property is read-only.

Data Type

i32

pinned_client_server_key_fingerprint property (SFTPServer Struct)

The fingerprint (hash value) of the server's public key.

Syntax

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

Default Value

""

Remarks

The fingerprint (hash value) of the server's public key.

This property is read-only.

Data Type

String

pinned_client_total_bytes_received property (SFTPServer Struct)

Returns the total number of bytes received over this connection.

Syntax

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

Default Value

0

Remarks

Returns the total number of bytes received over this connection.

This property is read-only.

Data Type

i64

pinned_client_total_bytes_sent property (SFTPServer Struct)

Returns the total number of bytes sent over this connection.

Syntax

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

Default Value

0

Remarks

Returns the total number of bytes sent over this connection.

This property is read-only.

Data Type

i64

pinned_client_version property (SFTPServer Struct)

Specifies SSH protocol version.

Syntax

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

Default Value

2

Remarks

Specifies SSH protocol version.

This property is read-only.

Data Type

i32

port property (SFTPServer Struct)

Specifies the listening port number.

Syntax

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

Default Value

22

Remarks

Use this property to specify on which port the struct will be listening to client connections.

Data Type

i32

read_only property (SFTPServer Struct)

Specifies whether files on the server are read-only.

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 deny all client requests to change files on the server.

Data Type

bool

server_key_count property (SFTPServer Struct)

The number of records in the ServerKey arrays.

Syntax

fn server_key_count(&self ) -> Result<i32, SecureBlackboxError> 
fn set_server_key_count(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• server_key_algorithm
• server_key_bits
• server_key_fingerprint_md5
• server_key_fingerprint_sha1
• server_key_handle

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

Data Type

i32

server_key_algorithm property (SFTPServer Struct)

Specifies the key algorithm.

Syntax

fn server_key_algorithm(&self , ServerKeyIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Specifies the key algorithm.

The following key algorithms are currently supported and can be returned by this property:

• RSA
• DSS
• ECDSA
• EDDSA
• MLDSA
• ECDSA-SK
• EDDSA-SK

The ServerKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerKeyCount property.

This property is read-only.

Data Type

String

server_key_bits property (SFTPServer Struct)

The number of bits in the key: the more the better, 2048 or 4096 are typical values.

Syntax

fn server_key_bits(&self , ServerKeyIndex : i32) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

The number of bits in the key: the more the better, 2048 or 4096 are typical values.

The ServerKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerKeyCount property.

This property is read-only.

Data Type

i32

server_key_fingerprint_md5 property (SFTPServer Struct)

Contains the MD5 fingerprint (hash) of the key.

Syntax

fn server_key_fingerprint_md5(&self , ServerKeyIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Contains the MD5 fingerprint (hash) of the key.

The ServerKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerKeyCount property.

This property is read-only.

Data Type

String

server_key_fingerprint_sha1 property (SFTPServer Struct)

Contains the SHA-1 fingerprint (hash) of the key.

Syntax

fn server_key_fingerprint_sha1(&self , ServerKeyIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Contains the SHA-1 fingerprint (hash) of the key.

The ServerKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerKeyCount property.

This property is read-only.

Data Type

String

server_key_handle property (SFTPServer Struct)

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

Syntax

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

Data Type

i64

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

ssh_settings_auto_adjust_ciphers property (SFTPServer Struct)

Whether the SSH client should adjust its list of supported ciphers 'on-the-fly' for greater compatibility with the server it is connecting to.

Syntax

fn ssh_settings_auto_adjust_ciphers(&self ) -> Result<bool, SecureBlackboxError> 
fn set_ssh_settings_auto_adjust_ciphers(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

true

Remarks

Whether the SSH client should adjust its list of supported ciphers 'on-the-fly' for greater compatibility with the server it is connecting to.

Data Type

bool

ssh_settings_base_configuration property (SFTPServer Struct)

Allows to choose base configuration of SSH settings, tuned up for different purposes such as high security or higher compatibility.

Syntax

fn ssh_settings_base_configuration(&self ) -> Result<i32, SecureBlackboxError> 
fn set_ssh_settings_base_configuration(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

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

Default Value

0

Remarks

Allows to choose base configuration of SSH settings, tuned up for different purposes such as high security or higher compatibility.

Data Type

i32

ssh_settings_compression_algorithms property (SFTPServer Struct)

A list of session compression algorithms separated with commas or semicolons.

Syntax

fn ssh_settings_compression_algorithms(&self ) -> Result<String, SecureBlackboxError> 
fn set_ssh_settings_compression_algorithms(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_ssh_settings_compression_algorithms_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

A list of session compression algorithms separated with commas or semicolons. Each algorithm in the list may be prefixed with a minus sign (-) to indicate that the algorithm should be disabled rather than enabled. Besides the specific algorithm names, this property supports the all (and -all) aliases that allow to blanketly enable or disable all compression algorithms at once.

Note: the list of algorithms provided to this property alters the baseline list of compression algorithms pre-configured for this component. Remember to start your algorithm string with -all; if you need to only enable a specific fixed set of algorithms. The list of supported compression algorithms is provided below:

• none
• zlib
• zlib@openssh.com

Data Type

String

ssh_settings_compression_level property (SFTPServer Struct)

Possible values for the Compression Level range from 0 (minimum compression) to 9 (maximum compression).

Syntax

fn ssh_settings_compression_level(&self ) -> Result<i32, SecureBlackboxError> 
fn set_ssh_settings_compression_level(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

6

Remarks

Possible values for the Compression Level range from 0 (minimum compression) to 9 (maximum compression). This setting is ignored if compression wasn't accepted.

Data Type

i32

ssh_settings_default_window_size property (SFTPServer Struct)

The SSH window size specifies how many bytes the client can send to the server in the command channel without obtaining pre-authorization for the further send from the server.

Syntax

fn ssh_settings_default_window_size(&self ) -> Result<i32, SecureBlackboxError> 
fn set_ssh_settings_default_window_size(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

2048000

Remarks

The SSH window size specifies how many bytes the client can send to the server in the command channel without obtaining pre-authorization for the further send from the server.

Data Type

i32

ssh_settings_encryption_algorithms property (SFTPServer Struct)

A list of session encryption algorithms separated with commas or semicolons.

Syntax

fn ssh_settings_encryption_algorithms(&self ) -> Result<String, SecureBlackboxError> 
fn set_ssh_settings_encryption_algorithms(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_ssh_settings_encryption_algorithms_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

A list of session encryption algorithms separated with commas or semicolons. Each algorithm in the list may be prefixed with a minus sign (-) to indicate that the algorithm should be disabled rather than enabled. Besides the specific algorithm names, this property supports the all (and -all) aliases that allow to blanketly enable or disable all encryption algorithms at once.

Note: the list of algorithms provided to this property alters the baseline list of encryption algorithms pre-configured for this component. Remember to start your algorithm string with -all; if you need to only enable a specific fixed set of algorithms. The list of supported encryption algorithms is provided below:

• 3des-cbc
• blowfish-cbc
• twofish256-cbc
• twofish192-cbc
• twofish128-cbc
• aes256-cbc
• aes192-cbc
• aes128-cbc
• serpent256-cbc
• serpent192-cbc
• serpent128-cbc
• arcfour
• idea-cbc
• cast128-cbc
• none
• des-cbc
• aes128-ctr
• aes192-ctr
• aes256-ctr
• 3des-ctr
• blowfish-ctr
• twofish128-ctr
• twofish192-ctr
• twofish256-ctr
• serpent128-ctr
• serpent192-ctr
• serpent256-ctr
• idea-ctr
• cast128-ctr
• arcfour128
• arcfour256
• aes128-gcm
• aes256-gcm
• aes128-gcm@openssh.com
• aes256-gcm@openssh.com
• chacha20-poly1305
• chacha20-poly1305@openssh.com

Data Type

String

ssh_settings_force_compression property (SFTPServer Struct)

Whether the SSH client should explicitly request compression.

Syntax

fn ssh_settings_force_compression(&self ) -> Result<bool, SecureBlackboxError> 
fn set_ssh_settings_force_compression(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

Whether the SSH client should explicitly request compression.

If ForceCompression is False, compression will be used only if the server doesn't support algorithms without compression.

Data Type

bool

ssh_settings_forward_auth_agent property (SFTPServer Struct)

Enables or disables auth agent forwarding.

Syntax

fn ssh_settings_forward_auth_agent(&self ) -> Result<bool, SecureBlackboxError> 
fn set_ssh_settings_forward_auth_agent(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

Enables or disables auth agent forwarding. This allows the struct to connect to the second and subsequent servers in the chain with the key agent available on the client computer.

Data Type

bool

ssh_settings_gss_auth_types property (SFTPServer Struct)

A comma-separated list of authentication types.

Syntax

fn ssh_settings_gss_auth_types(&self ) -> Result<String, SecureBlackboxError> 
fn set_ssh_settings_gss_auth_types(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_ssh_settings_gss_auth_types_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

A comma-separated list of authentication types. Two types are currently supported: gssapi-with-mic and gssapi-keyex.

Data Type

String

ssh_settings_gss_delegate_creds property (SFTPServer Struct)

Switches credential delegation on or off.

Syntax

fn ssh_settings_gss_delegate_creds(&self ) -> Result<bool, SecureBlackboxError> 
fn set_ssh_settings_gss_delegate_creds(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

Switches credential delegation on or off.

Data Type

bool

ssh_settings_gss_hostname property (SFTPServer Struct)

The GSS host name, in form of a FQDN (e.

Syntax

fn ssh_settings_gss_hostname(&self ) -> Result<String, SecureBlackboxError> 
fn set_ssh_settings_gss_hostname(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_ssh_settings_gss_hostname_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The GSS host name, in form of a FQDN (e.g. hostname.com), a principal name (e.g. 'host@hostname.com), or a cross-real ticket-granting ticket (e.g. krbtgt/test.com@example.com).

Data Type

String

ssh_settings_gss_lib property (SFTPServer Struct)

A path to the GSS-API library (DLL or SO).

Syntax

fn ssh_settings_gss_lib(&self ) -> Result<String, SecureBlackboxError> 
fn set_ssh_settings_gss_lib(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_ssh_settings_gss_lib_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

A path to the GSS-API library (DLL or SO).

Data Type

String

ssh_settings_gss_mechanisms property (SFTPServer Struct)

A comma-separated list of GSS mechanisms to use.

Syntax

fn ssh_settings_gss_mechanisms(&self ) -> Result<String, SecureBlackboxError> 
fn set_ssh_settings_gss_mechanisms(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_ssh_settings_gss_mechanisms_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

A comma-separated list of GSS mechanisms to use. Two values are currently supported: lib and SSPI.

Data Type

String

ssh_settings_gss_protocols property (SFTPServer Struct)

A comma-separated list of SSPI protocols.

Syntax

fn ssh_settings_gss_protocols(&self ) -> Result<String, SecureBlackboxError> 
fn set_ssh_settings_gss_protocols(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_ssh_settings_gss_protocols_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

A comma-separated list of SSPI protocols. Two protocols are currently supported: kerberos and NTLM.

Data Type

String

ssh_settings_handshake_timeout property (SFTPServer Struct)

Specifies the maximal time for the SSH handshake to proceed, in seconds.

Syntax

fn ssh_settings_handshake_timeout(&self ) -> Result<i32, SecureBlackboxError> 
fn set_ssh_settings_handshake_timeout(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

45

Remarks

Specifies the maximal time for the SSH handshake to proceed, in seconds. If the handshake is not completed within this period, the session is aborted.

Data Type

i32

ssh_settings_kex_algorithms property (SFTPServer Struct)

A list of key exchange algorithms separated with commas or semicolons.

Syntax

fn ssh_settings_kex_algorithms(&self ) -> Result<String, SecureBlackboxError> 
fn set_ssh_settings_kex_algorithms(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_ssh_settings_kex_algorithms_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

A list of key exchange algorithms separated with commas or semicolons. Each algorithm in the list may be prefixed with a minus sign (-) to indicate that the algorithm should be disabled rather than enabled. Besides the specific algorithm names, this property supports the all (and -all) aliases that allow to blanketly enable or disable all key exchange algorithms at once.

Note: the list of algorithms provided to this property alters the baseline list of key exchange algorithms pre-configured for this component. Remember to start your algorithm string with -all; if you need to only enable a specific fixed set of algorithms. The list of supported kex algorithms is provided below:

• diffie-hellman-group-exchange-sha1
• diffie-hellman-group1-sha1
• diffie-hellman-group14-sha1
• diffie-hellman-group-exchange-sha256
• rsa1024-sha1
• rsa2048-sha256
• ecdh-sha2-nistp256
• ecdh-sha2-nistp384
• ecdh-sha2-nistp521
• ecdh-sha2-nistk163
• ecdh-sha2-nistp192
• ecdh-sha2-nistp224
• ecdh-sha2-nistk233
• ecdh-sha2-nistb233
• ecdh-sha2-nistk283
• ecdh-sha2-nistk409
• ecdh-sha2-nistb409
• ecdh-sha2-nistt571
• ecdh-sha2-curve25519
• curve25519-sha256@libssh.org
• curve448-sha512@libssh.org
• diffie-hellman-group14-sha256
• diffie-hellman-group15-sha512
• diffie-hellman-group16-sha512
• diffie-hellman-group17-sha512
• diffie-hellman-group18-sha512

Data Type

String

ssh_settings_mac_algorithms property (SFTPServer Struct)

A list of MAC (for message authentication code ) algorithms separated with commas or semicolons.

Syntax

fn ssh_settings_mac_algorithms(&self ) -> Result<String, SecureBlackboxError> 
fn set_ssh_settings_mac_algorithms(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_ssh_settings_mac_algorithms_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

A list of MAC (for message authentication code) algorithms separated with commas or semicolons. Each algorithm in the list may be prefixed with a minus sign (-) to indicate that the algorithm should be disabled rather than enabled. Besides the specific algorithm names, this property supports the all (and -all) aliases that allow to blanketly enable or disable all MAC algorithms at once.

Note: the list of algorithms provided to this property alters the baseline list of MAC algorithms pre-configured for this component. Remember to start your algorithm string with -all; if you need to only enable a specific fixed set of algorithms. The list of supported MAC algorithms is provided below:

• hmac-sha1
• hmac-sha1-96
• hmac-md5
• hmac-md5-96
• none
• hmac-ripemd160
• hmac-ripemd
• hmac-ripemd160@openssh.com
• hmac-sha256@ssh.com
• hmac-sha256-96@ssh.com
• umac-32@openssh.com
• umac-64@openssh.com
• umac-96@openssh.com
• umac-128@openssh.com
• hmac-sha2-256
• hmac-sha2-512
• aes128-gcm
• aes256-gcm
• chacha20-poly1305@openssh.com
• hmac-sha2-256-etm@openssh.com
• hmac-sha2-512-etm@openssh.com

Data Type

String

ssh_settings_max_ssh_packet_size property (SFTPServer Struct)

Specifies the maximum length of one SSH packet in bytes.

Syntax

fn ssh_settings_max_ssh_packet_size(&self ) -> Result<i32, SecureBlackboxError> 
fn set_ssh_settings_max_ssh_packet_size(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

262144

Remarks

Specifies the maximum length of one SSH packet in bytes.

Data Type

i32

ssh_settings_min_window_size property (SFTPServer Struct)

Specifies the minimal internal window size.

Syntax

fn ssh_settings_min_window_size(&self ) -> Result<i32, SecureBlackboxError> 
fn set_ssh_settings_min_window_size(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

2048

Remarks

Specifies the minimal internal window size. When the minimal window size is reached, the 'window extension' request is sent to the server. This request notifies the server that the window was extended, and it can send more data.

Data Type

i32

ssh_settings_obfuscate_handshake property (SFTPServer Struct)

Enables or disables handshake obfuscation.

Syntax

fn ssh_settings_obfuscate_handshake(&self ) -> Result<bool, SecureBlackboxError> 
fn set_ssh_settings_obfuscate_handshake(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

Enables or disables handshake obfuscation.

Data Type

bool

ssh_settings_obfuscation_password property (SFTPServer Struct)

Specifies the password used to encrypt the handshake when ObfuscateHandshake is set.

Syntax

fn ssh_settings_obfuscation_password(&self ) -> Result<String, SecureBlackboxError> 
fn set_ssh_settings_obfuscation_password(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_ssh_settings_obfuscation_password_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Specifies the password used to encrypt the handshake when ObfuscateHandshake is set.

Data Type

String

ssh_settings_public_key_algorithms property (SFTPServer Struct)

A list of public key algorithms separated with commas or semicolons.

Syntax

fn ssh_settings_public_key_algorithms(&self ) -> Result<String, SecureBlackboxError> 
fn set_ssh_settings_public_key_algorithms(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_ssh_settings_public_key_algorithms_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

A list of public key algorithms separated with commas or semicolons. Each algorithm in the list may be prefixed with a minus sign (-) to indicate that the algorithm should be disabled rather than enabled. Besides the specific algorithm names, this property supports the all (and -all) aliases that allow to blanketly enable or disable all public key algorithms at once.

Note: the list of algorithms provided to this property alters the baseline list of public key algorithms pre-configured for this component. Remember to start your algorithm string with -all; if you need to only enable a specific fixed set of algorithms. The list of supported public key algorithms is provided below:

• ssh-dss
• ssh-rsa
• x509v3-sign-rsa
• x509v3-sign-dss
• spki-sign-rsa,
• spki-sign-dss
• pgp-sign-rsa
• pgp-sign-dss
• ecdsa-sha2-nistp256
• ecdsa-sha2-nistp384
• ecdsa-sha2-nistp521
• ecdsa-sha2-nistk163
• ecdsa-sha2-nistp192
• ecdsa-sha2-nistp224
• ecdsa-sha2-nistk233
• ecdsa-sha2-nistb233
• ecdsa-sha2-nistk283
• ecdsa-sha2-nistk409
• ecdsa-sha2-nistb409
• ecdsa-sha2-nistt571,
• ecdsa-sha2-curve25519
• x509v3-ssh-rsa
• x509v3-ssh-dss
• x509v3-rsa2048-sha256
• x509v3-ecdsa-sha2-nistp256
• x509v3-ecdsa-sha2-nistp384
• x509v3-ecdsa-sha2-nistp521
• x509v3-ecdsa-sha2-nistk163
• x509v3-ecdsa-sha2-nistp192
• x509v3-ecdsa-sha2-nistp224
• x509v3-ecdsa-sha2-nistk233
• x509v3-ecdsa-sha2-nistb233
• x509v3-ecdsa-sha2-nistk283
• x509v3-ecdsa-sha2-nistk409
• x509v3-ecdsa-sha2-nistb409
• x509v3-ecdsa-sha2-nistt571
• x509v3-ecdsa-sha2-curve25519
• ssh-ed25519
• ssh-ed448
• rsa-sha2-256
• rsa-sha2-512

Data Type

String

ssh_settings_request_password_change property (SFTPServer Struct)

Whether to request a password change when connecting.

Syntax

fn ssh_settings_request_password_change(&self ) -> Result<bool, SecureBlackboxError> 
fn set_ssh_settings_request_password_change(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

Whether to request a password change when connecting.

Data Type

bool

ssh_settings_software_name property (SFTPServer Struct)

The name to be used by the struct to identify itself.

Syntax

fn ssh_settings_software_name(&self ) -> Result<String, SecureBlackboxError> 
fn set_ssh_settings_software_name(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_ssh_settings_software_name_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

"SecureBlackbox"

Remarks

The name to be used by the component to identify itself.

Data Type

String

ssh_settings_trust_all_keys property (SFTPServer Struct)

Enables or disables explicit trust to all server keys.

Syntax

fn ssh_settings_trust_all_keys(&self ) -> Result<bool, SecureBlackboxError> 
fn set_ssh_settings_trust_all_keys(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

Enables or disables explicit trust to all server keys. Use with care.

Data Type

bool

ssh_settings_use_auth_agent property (SFTPServer Struct)

Enables or disables the use of external key agent, such as Putty key agent.

Syntax

fn ssh_settings_use_auth_agent(&self ) -> Result<bool, SecureBlackboxError> 
fn set_ssh_settings_use_auth_agent(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

Enables or disables the use of external key agent, such as Putty key agent.

Data Type

bool

ssh_settings_versions property (SFTPServer Struct)

Specifies enabled SSH protocol versions (1 or 2).

Syntax

fn ssh_settings_versions(&self ) -> Result<i32, SecureBlackboxError> 
fn set_ssh_settings_versions(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

1

Remarks

Specifies enabled SSH protocol versions (1 or 2).

Data Type

i32

user_count property (SFTPServer 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_certificate
• user_data
• user_email
• user_handle
• user_hash_algorithm
• user_incoming_speed_limit
• username
• user_otp_algorithm
• user_otp_len
• user_otp_value
• user_outgoing_speed_limit
• user_password
• user_shared_secret
• user_ssh_key

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

Data Type

i32

user_associated_data property (SFTPServer 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 (SFTPServer 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_certificate property (SFTPServer Struct)

Contains the user's certificate.

Syntax

fn user_certificate(&self , UserIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 
fn set_user_certificate(&self, UserIndex : i32, value : Vec<u8>) ->  Option<SecureBlackboxError> 
fn set_user_certificate_ref(&self, UserIndex : i32, value : &[u8]) ->  Option<SecureBlackboxError> 

Remarks

Contains the user's certificate.

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

Data Type

Vec

user_data property (SFTPServer 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_email property (SFTPServer Struct)

The user's email address.

Syntax

fn user_email(&self , UserIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_user_email(&self, UserIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_user_email_ref(&self, UserIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The user's email address.

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

Data Type

String

user_handle property (SFTPServer 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 (SFTPServer 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 (SFTPServer 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_otp_algorithm property (SFTPServer Struct)

The algorithm used to generate one-time passwords (OTP) for this user, either HOTP (Hash-based OTP) or TOTP (Time-based OTP).

Syntax

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

Possible Values

0   // None
1   // Hmac
2   // Time

Default Value

0

Remarks

The algorithm used to generate one-time passwords (OTP) for this user, either HOTP (Hash-based OTP) or TOTP (Time-based OTP). In the former case, a value of a dedicated counter is used to generate a unique password, while in the latter the password is generated on the basis of the current time value.

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_otp_len property (SFTPServer Struct)

Specifies the length of the user's OTP password.

Syntax

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

Default Value

0

Remarks

Specifies the length of the user's OTP password.

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

Data Type

i32

user_otp_value property (SFTPServer Struct)

The user's time interval (TOTP) or Counter (HOTP).

Syntax

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

Default Value

0

Remarks

The user's time interval (TOTP) or Counter (HOTP).

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

Data Type

i32

user_outgoing_speed_limit property (SFTPServer 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 (SFTPServer 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 (SFTPServer 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

user_ssh_key property (SFTPServer Struct)

Contains the user's SSH key.

Syntax

fn user_ssh_key(&self , UserIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 
fn set_user_ssh_key(&self, UserIndex : i32, value : Vec<u8>) ->  Option<SecureBlackboxError> 
fn set_user_ssh_key_ref(&self, UserIndex : i32, value : &[u8]) ->  Option<SecureBlackboxError> 

Remarks

Contains the user's SSH key.

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

Data Type

Vec

username property (SFTPServer 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 (SFTPServer Struct)

Specifies whether UTF8 conversion is to be used when parsing file names.

Syntax

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

Default Value

false

Remarks

This property specifies whether UTF8 conversion of filenames is used by the server. It is set automatically according to protocol flow, but user could also set it to the desired value.

Data Type

bool

cleanup method (SFTPServer 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 (SFTPServer 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 (SFTPServer 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 (SFTPServer 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 (SFTPServer Struct)

Acquires a piece of operation data.

Syntax

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

Remarks

Use this method to obtain a piece of data relevant to a transfer operation in a thread-safe way.

A typical place to call this method is inside the on_write_file event handler, when implementing customized file transfers.

get_client_file_entry method (SFTPServer Struct)

Acquires file entry details from the struct.

Syntax

fn get_client_file_entry(&self, connection_id : i64, handle : &str) -> Result<(), SecureBlackboxError>

Remarks

Use this method to acquire the details of a file entry from the server in atomic and thread-safe way. After this method completes, the entry details will be propagated in client_file_entry property.

When calling this method, pass the client connection ID in ConnectionID property, and the opened file handle (if needed) in Handle property.

list_clients method (SFTPServer 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 (SFTPServer 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 property.

reset method (SFTPServer 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 (SFTPServer Struct)

Commits a data buffer to the server struct.

Syntax

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

Remarks

Use this method to commit a data buffer passed via the Value parameter to the server control in a thread-safe way.

One example where you might need to pass your buffer to the server is when customizing upload operations via on_read_file event.

set_client_file_entry method (SFTPServer Struct)

Commits the file entry details to the struct.

Syntax

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

Remarks

Use this method to commit the file entry details configured in client_file_entry property to the server object in a thread-safe way. Pass the client's connection ID via ConnectionID property, and the file entry's handle via Handle.

start method (SFTPServer Struct)

Starts SFTP server operation.

Syntax

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

Remarks

Call this method to start listening to incoming connections.

stop method (SFTPServer Struct)

Stops SFTP server.

Syntax

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

Remarks

Call this method to close all connections and stop listening to clients.

on_accept event (SFTPServer Struct)

This event is fired when new incoming connection is accepted.

Syntax

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

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

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

Remarks

This event is fired by the struct before a new incoming connection is accepted. RemoteAddress contains the IP address of the connecting client. Use the Accept parameter to either accept, or reject the connection.

on_after_create_directory event (SFTPServer Struct)

This event indicates completion of directory creation request.

Syntax

// SFTPServerAfterCreateDirectoryEventArgs carries the SFTPServer AfterCreateDirectory event's parameters.
pub struct SFTPServerAfterCreateDirectoryEventArgs {
  fn connection_id(&self) -> i64
  fn path(&self) -> &String
  fn operation_status(&self) -> i32
  fn set_operation_status(&self, value : i32)
}

// SFTPServerAfterCreateDirectoryEvent defines the signature of the SFTPServer AfterCreateDirectory event's handler function.
pub trait SFTPServerAfterCreateDirectoryEvent {
  fn on_after_create_directory(&self, sender : SFTPServer, e : &mut SFTPServerAfterCreateDirectoryEventArgs);
}

impl <'a> SFTPServer<'a> {
  pub fn on_after_create_directory(&self) -> &'a dyn SFTPServerAfterCreateDirectoryEvent;
  pub fn set_on_after_create_directory(&mut self, value : &'a dyn SFTPServerAfterCreateDirectoryEvent);
  ...
}

Remarks

This event is fired to report completion of a directory creation request. The ConnectionID parameter specifies in which session the request was received, the Path specifies the directory path, and the OperationStatus contains the operation result.

If needed, you can amend the OperationStatus to return a different operation result:

on_after_remove event (SFTPServer Struct)

This event indicates completion of file removal request.

Syntax

// SFTPServerAfterRemoveEventArgs carries the SFTPServer AfterRemove event's parameters.
pub struct SFTPServerAfterRemoveEventArgs {
  fn connection_id(&self) -> i64
  fn path(&self) -> &String
  fn operation_status(&self) -> i32
  fn set_operation_status(&self, value : i32)
}

// SFTPServerAfterRemoveEvent defines the signature of the SFTPServer AfterRemove event's handler function.
pub trait SFTPServerAfterRemoveEvent {
  fn on_after_remove(&self, sender : SFTPServer, e : &mut SFTPServerAfterRemoveEventArgs);
}

impl <'a> SFTPServer<'a> {
  pub fn on_after_remove(&self) -> &'a dyn SFTPServerAfterRemoveEvent;
  pub fn set_on_after_remove(&mut self, value : &'a dyn SFTPServerAfterRemoveEvent);
  ...
}

Remarks

This event is fired when a request to delete a file or directory has been processed by the server. The ConnectionID parameter specifies the session in which the request was received. OperationStatus contains the operation result.

If needed, you can amend the OperationStatus to return a different operation result:

on_after_rename_file event (SFTPServer Struct)

This event indicates completion of a file rename operation.

Syntax

// SFTPServerAfterRenameFileEventArgs carries the SFTPServer AfterRenameFile event's parameters.
pub struct SFTPServerAfterRenameFileEventArgs {
  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)
}

// SFTPServerAfterRenameFileEvent defines the signature of the SFTPServer AfterRenameFile event's handler function.
pub trait SFTPServerAfterRenameFileEvent {
  fn on_after_rename_file(&self, sender : SFTPServer, e : &mut SFTPServerAfterRenameFileEventArgs);
}

impl <'a> SFTPServer<'a> {
  pub fn on_after_rename_file(&self) -> &'a dyn SFTPServerAfterRenameFileEvent;
  pub fn set_on_after_rename_file(&mut self, value : &'a dyn SFTPServerAfterRenameFileEvent);
  ...
}

Remarks

This event is fired when a request to rename a file (from OldPath to NewPath) has been processed. The ConnectionID parameter specifies in which session the request was received, and OperationStatus contains the operation result.

If needed, you can amend the OperationStatus to return a different operation result:

on_after_request_attributes event (SFTPServer Struct)

This event indicates completion of file attributes request.

Syntax

// SFTPServerAfterRequestAttributesEventArgs carries the SFTPServer AfterRequestAttributes event's parameters.
pub struct SFTPServerAfterRequestAttributesEventArgs {
  fn connection_id(&self) -> i64
  fn path(&self) -> &String
  fn operation_status(&self) -> i32
  fn set_operation_status(&self, value : i32)
}

// SFTPServerAfterRequestAttributesEvent defines the signature of the SFTPServer AfterRequestAttributes event's handler function.
pub trait SFTPServerAfterRequestAttributesEvent {
  fn on_after_request_attributes(&self, sender : SFTPServer, e : &mut SFTPServerAfterRequestAttributesEventArgs);
}

impl <'a> SFTPServer<'a> {
  pub fn on_after_request_attributes(&self) -> &'a dyn SFTPServerAfterRequestAttributesEvent;
  pub fn set_on_after_request_attributes(&mut self, value : &'a dyn SFTPServerAfterRequestAttributesEvent);
  ...
}

Remarks

This event is fired when a request for get file attributes has been processed by the server. The ConnectionID parameter specifies in which session the request was received. OperationStatus contains the result of the operation.

If needed, you can amend the OperationStatus to return a different operation result:

on_after_set_attributes event (SFTPServer Struct)

This event indicates completion of a set attributes request.

Syntax

// SFTPServerAfterSetAttributesEventArgs carries the SFTPServer AfterSetAttributes event's parameters.
pub struct SFTPServerAfterSetAttributesEventArgs {
  fn connection_id(&self) -> i64
  fn path(&self) -> &String
  fn operation_status(&self) -> i32
  fn set_operation_status(&self, value : i32)
}

// SFTPServerAfterSetAttributesEvent defines the signature of the SFTPServer AfterSetAttributes event's handler function.
pub trait SFTPServerAfterSetAttributesEvent {
  fn on_after_set_attributes(&self, sender : SFTPServer, e : &mut SFTPServerAfterSetAttributesEventArgs);
}

impl <'a> SFTPServer<'a> {
  pub fn on_after_set_attributes(&self) -> &'a dyn SFTPServerAfterSetAttributesEvent;
  pub fn set_on_after_set_attributes(&mut self, value : &'a dyn SFTPServerAfterSetAttributesEvent);
  ...
}

Remarks

This event is fired when a request for set file attributes has been processed. The ConnectionID parameter specifies in which session the request was received. The OperationStatus parameter contains the operation result.

If needed, you can amend the OperationStatus to return a different operation result:

on_auth_attempt event (SFTPServer Struct)

Reports a user authentication attempt.

Syntax

// SFTPServerAuthAttemptEventArgs carries the SFTPServer AuthAttempt event's parameters.
pub struct SFTPServerAuthAttemptEventArgs {
  fn connection_id(&self) -> i64
  fn username(&self) -> &String
  fn auth_type(&self) -> i32
  fn accept(&self) -> bool
  fn set_accept(&self, value : bool)
}

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

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

Remarks

ConnectionID identifies the session, Username specifies client's username, and AuthType specifies the authentication type. Use the Accept parameter to accept or decline the attempt.

Supported authentication types:

on_auth_failed event (SFTPServer Struct)

Reports user authentication failure.

Syntax

// SFTPServerAuthFailedEventArgs carries the SFTPServer AuthFailed event's parameters.
pub struct SFTPServerAuthFailedEventArgs {
  fn connection_id(&self) -> i64
  fn username(&self) -> &String
  fn auth_type(&self) -> i32
}

// SFTPServerAuthFailedEvent defines the signature of the SFTPServer AuthFailed event's handler function.
pub trait SFTPServerAuthFailedEvent {
  fn on_auth_failed(&self, sender : SFTPServer, e : &mut SFTPServerAuthFailedEventArgs);
}

impl <'a> SFTPServer<'a> {
  pub fn on_auth_failed(&self) -> &'a dyn SFTPServerAuthFailedEvent;
  pub fn set_on_auth_failed(&mut self, value : &'a dyn SFTPServerAuthFailedEvent);
  ...
}

Remarks

ConnectionID identifies the session, Username specify client's username, and AuthType specifies what authentication type was used.

Supported authentication types:

on_auth_password event (SFTPServer Struct)

This event is fired on password authentication attempt from a client.

Syntax

// SFTPServerAuthPasswordEventArgs carries the SFTPServer AuthPassword event's parameters.
pub struct SFTPServerAuthPasswordEventArgs {
  fn connection_id(&self) -> i64
  fn username(&self) -> &String
  fn password(&self) -> &String
  fn accept(&self) -> bool
  fn set_accept(&self, value : bool)
  fn force_change_password(&self) -> bool
  fn set_force_change_password(&self, value : bool)
}

// SFTPServerAuthPasswordEvent defines the signature of the SFTPServer AuthPassword event's handler function.
pub trait SFTPServerAuthPasswordEvent {
  fn on_auth_password(&self, sender : SFTPServer, e : &mut SFTPServerAuthPasswordEventArgs);
}

impl <'a> SFTPServer<'a> {
  pub fn on_auth_password(&self) -> &'a dyn SFTPServerAuthPasswordEvent;
  pub fn set_on_auth_password(&mut self, value : &'a dyn SFTPServerAuthPasswordEvent);
  ...
}

Remarks

Parameters Username and Password contain user credentials. If they are correct, set Accept to true. You can request password change by setting ForceChangePassword to true.

on_auth_public_key event (SFTPServer Struct)

This event is fired on public key authentication attempt from a client.

Syntax

// SFTPServerAuthPublicKeyEventArgs carries the SFTPServer AuthPublicKey event's parameters.
pub struct SFTPServerAuthPublicKeyEventArgs {
  fn connection_id(&self) -> i64
  fn username(&self) -> &String
  fn accept(&self) -> bool
  fn set_accept(&self, value : bool)
}

// SFTPServerAuthPublicKeyEvent defines the signature of the SFTPServer AuthPublicKey event's handler function.
pub trait SFTPServerAuthPublicKeyEvent {
  fn on_auth_public_key(&self, sender : SFTPServer, e : &mut SFTPServerAuthPublicKeyEventArgs);
}

impl <'a> SFTPServer<'a> {
  pub fn on_auth_public_key(&self) -> &'a dyn SFTPServerAuthPublicKeyEvent;
  pub fn set_on_auth_public_key(&mut self, value : &'a dyn SFTPServerAuthPublicKeyEvent);
  ...
}

Remarks

Username specifies client's username, and Accept is used to accept or reject authentication.

The users public key can be accessed via the client_key property. This event is guarded with a critical section so the property always contains the correct key.

on_auth_succeeded event (SFTPServer Struct)

Reports a successful user authentication.

Syntax

// SFTPServerAuthSucceededEventArgs carries the SFTPServer AuthSucceeded event's parameters.
pub struct SFTPServerAuthSucceededEventArgs {
  fn connection_id(&self) -> i64
  fn username(&self) -> &String
  fn auth_type(&self) -> i32
}

// SFTPServerAuthSucceededEvent defines the signature of the SFTPServer AuthSucceeded event's handler function.
pub trait SFTPServerAuthSucceededEvent {
  fn on_auth_succeeded(&self, sender : SFTPServer, e : &mut SFTPServerAuthSucceededEventArgs);
}

impl <'a> SFTPServer<'a> {
  pub fn on_auth_succeeded(&self) -> &'a dyn SFTPServerAuthSucceededEvent;
  pub fn set_on_auth_succeeded(&mut self, value : &'a dyn SFTPServerAuthSucceededEvent);
  ...
}

Remarks

ConnectionID identifies the session, Username specify client's username, and AuthType specifies what authentication type was used.

Supported authentication types:

on_before_create_directory event (SFTPServer Struct)

This event is fired when a client requests to create a directory.

Syntax

// SFTPServerBeforeCreateDirectoryEventArgs carries the SFTPServer BeforeCreateDirectory event's parameters.
pub struct SFTPServerBeforeCreateDirectoryEventArgs {
  fn connection_id(&self) -> i64
  fn path(&self) -> &String
  fn action(&self) -> i32
  fn set_action(&self, value : i32)
}

// SFTPServerBeforeCreateDirectoryEvent defines the signature of the SFTPServer BeforeCreateDirectory event's handler function.
pub trait SFTPServerBeforeCreateDirectoryEvent {
  fn on_before_create_directory(&self, sender : SFTPServer, e : &mut SFTPServerBeforeCreateDirectoryEventArgs);
}

impl <'a> SFTPServer<'a> {
  pub fn on_before_create_directory(&self) -> &'a dyn SFTPServerBeforeCreateDirectoryEvent;
  pub fn set_on_before_create_directory(&mut self, value : &'a dyn SFTPServerBeforeCreateDirectoryEvent);
  ...
}

Remarks

This event is fired when a request to create a directory has been received. The ConnectionID parameter specifies in which session the request was received.

Choose Action as one of the following values:

on_before_download_file event (SFTPServer Struct)

This event is fired when a download file request is received.

Syntax

// SFTPServerBeforeDownloadFileEventArgs carries the SFTPServer BeforeDownloadFile event's parameters.
pub struct SFTPServerBeforeDownloadFileEventArgs {
  fn connection_id(&self) -> i64
  fn path(&self) -> &String
  fn action(&self) -> i32
  fn set_action(&self, value : i32)
}

// SFTPServerBeforeDownloadFileEvent defines the signature of the SFTPServer BeforeDownloadFile event's handler function.
pub trait SFTPServerBeforeDownloadFileEvent {
  fn on_before_download_file(&self, sender : SFTPServer, e : &mut SFTPServerBeforeDownloadFileEventArgs);
}

impl <'a> SFTPServer<'a> {
  pub fn on_before_download_file(&self) -> &'a dyn SFTPServerBeforeDownloadFileEvent;
  pub fn set_on_before_download_file(&mut self, value : &'a dyn SFTPServerBeforeDownloadFileEvent);
  ...
}

Remarks

This event is fired when a request to download file is received from the client. The ConnectionID parameter specifies in which session the request was received.

Choose Action as one of the following values:

on_before_find event (SFTPServer Struct)

This event is fired when a client requests to find files and folders in Path.

Syntax

// SFTPServerBeforeFindEventArgs carries the SFTPServer BeforeFind event's parameters.
pub struct SFTPServerBeforeFindEventArgs {
  fn connection_id(&self) -> i64
  fn path(&self) -> &String
  fn action(&self) -> i32
  fn set_action(&self, value : i32)
}

// SFTPServerBeforeFindEvent defines the signature of the SFTPServer BeforeFind event's handler function.
pub trait SFTPServerBeforeFindEvent {
  fn on_before_find(&self, sender : SFTPServer, e : &mut SFTPServerBeforeFindEventArgs);
}

impl <'a> SFTPServer<'a> {
  pub fn on_before_find(&self) -> &'a dyn SFTPServerBeforeFindEvent;
  pub fn set_on_before_find(&mut self, value : &'a dyn SFTPServerBeforeFindEvent);
  ...
}

Remarks

This event is fired when a request to find files and folders in Path has been received. The ConnectionID parameter specifies in which session the request was received.

Choose Action as one of the following values:

on_before_open_client_forwarding event (SFTPServer Struct)

This event is fired when a client requests to set up client-side (local) forwarding channel.

Syntax

// SFTPServerBeforeOpenClientForwardingEventArgs carries the SFTPServer BeforeOpenClientForwarding event's parameters.
pub struct SFTPServerBeforeOpenClientForwardingEventArgs {
  fn connection_id(&self) -> i64
  fn dest_host(&self) -> &String
  fn set_dest_host(&self, value : &str)
  fn set_dest_host_ref(&self, value : &String)
  fn dest_port(&self) -> i32
  fn set_dest_port(&self, value : i32)
  fn src_host(&self) -> &String
  fn src_port(&self) -> i32
  fn action(&self) -> i32
  fn set_action(&self, value : i32)
}

// SFTPServerBeforeOpenClientForwardingEvent defines the signature of the SFTPServer BeforeOpenClientForwarding event's handler function.
pub trait SFTPServerBeforeOpenClientForwardingEvent {
  fn on_before_open_client_forwarding(&self, sender : SFTPServer, e : &mut SFTPServerBeforeOpenClientForwardingEventArgs);
}

impl <'a> SFTPServer<'a> {
  pub fn on_before_open_client_forwarding(&self) -> &'a dyn SFTPServerBeforeOpenClientForwardingEvent;
  pub fn set_on_before_open_client_forwarding(&mut self, value : &'a dyn SFTPServerBeforeOpenClientForwardingEvent);
  ...
}

Remarks

This event is fired when a request to open a client forwarding has been received. The ConnectionID parameter specifies in which session the request was received.

If permitted, the server will open a connection to DestHost:DestPort and start forwarding any data received from the client to that endpoint. You can enable or disable client forwarding blanketly via the capabilities property.

Choose Action as one of the following values:

on_before_open_command event (SFTPServer Struct)

This event is fired when a client requests a command channel.

Syntax

// SFTPServerBeforeOpenCommandEventArgs carries the SFTPServer BeforeOpenCommand event's parameters.
pub struct SFTPServerBeforeOpenCommandEventArgs {
  fn connection_id(&self) -> i64
  fn command(&self) -> &String
  fn set_command(&self, value : &str)
  fn set_command_ref(&self, value : &String)
  fn action(&self) -> i32
  fn set_action(&self, value : i32)
}

// SFTPServerBeforeOpenCommandEvent defines the signature of the SFTPServer BeforeOpenCommand event's handler function.
pub trait SFTPServerBeforeOpenCommandEvent {
  fn on_before_open_command(&self, sender : SFTPServer, e : &mut SFTPServerBeforeOpenCommandEventArgs);
}

impl <'a> SFTPServer<'a> {
  pub fn on_before_open_command(&self) -> &'a dyn SFTPServerBeforeOpenCommandEvent;
  pub fn set_on_before_open_command(&mut self, value : &'a dyn SFTPServerBeforeOpenCommandEvent);
  ...
}

Remarks

This event is fired when a request to open a command has been received. The ConnectionID parameter specifies in which session the request was received.

If permitted, the component will launch the command in a separate process. Note that allowing command access to all clients can be dangerous. You can enable or disable command support blanketly via the capabilities property.

Choose Action as one of the following values:

on_before_open_server_forwarding event (SFTPServer Struct)

This event is fired when the server has received an incoming connection and needs to set up server-side (remote) forwarding channel.

Syntax

// SFTPServerBeforeOpenServerForwardingEventArgs carries the SFTPServer BeforeOpenServerForwarding event's parameters.
pub struct SFTPServerBeforeOpenServerForwardingEventArgs {
  fn connection_id(&self) -> i64
  fn local_host(&self) -> &String
  fn local_port(&self) -> i32
  fn src_host(&self) -> &String
  fn src_port(&self) -> i32
  fn action(&self) -> i32
  fn set_action(&self, value : i32)
}

// SFTPServerBeforeOpenServerForwardingEvent defines the signature of the SFTPServer BeforeOpenServerForwarding event's handler function.
pub trait SFTPServerBeforeOpenServerForwardingEvent {
  fn on_before_open_server_forwarding(&self, sender : SFTPServer, e : &mut SFTPServerBeforeOpenServerForwardingEventArgs);
}

impl <'a> SFTPServer<'a> {
  pub fn on_before_open_server_forwarding(&self) -> &'a dyn SFTPServerBeforeOpenServerForwardingEvent;
  pub fn set_on_before_open_server_forwarding(&mut self, value : &'a dyn SFTPServerBeforeOpenServerForwardingEvent);
  ...
}

Remarks

The ConnectionID parameter specifies in which session the request was received.

If permitted, the server will accept the connection and ask the client to confirm forwarding to DestHost:DestPort. If that is successful, the server will fire the on_open_server_forwarding event.

You can enable or disable client forwarding blanketly via the capabilities property.

Choose Action as one of the following values:

on_before_open_shell event (SFTPServer Struct)

This event is fired when a client requests a shell channel.

Syntax

// SFTPServerBeforeOpenShellEventArgs carries the SFTPServer BeforeOpenShell event's parameters.
pub struct SFTPServerBeforeOpenShellEventArgs {
  fn connection_id(&self) -> i64
  fn action(&self) -> i32
  fn set_action(&self, value : i32)
}

// SFTPServerBeforeOpenShellEvent defines the signature of the SFTPServer BeforeOpenShell event's handler function.
pub trait SFTPServerBeforeOpenShellEvent {
  fn on_before_open_shell(&self, sender : SFTPServer, e : &mut SFTPServerBeforeOpenShellEventArgs);
}

impl <'a> SFTPServer<'a> {
  pub fn on_before_open_shell(&self) -> &'a dyn SFTPServerBeforeOpenShellEvent;
  pub fn set_on_before_open_shell(&mut self, value : &'a dyn SFTPServerBeforeOpenShellEvent);
  ...
}

Remarks

This event is fired when a request to open a shell has been received. The ConnectionID parameter specifies in which session the request was received.

If permitted, the client will be able to send commands to the shell. Note that allowing shell access to all clients can be dangerous. You can enable or disable shell access blanketly via the capabilities property.

Choose Action as one of the following values:

on_before_remove event (SFTPServer Struct)

This event is fired when a client requests to delete a file or directory.

Syntax

// SFTPServerBeforeRemoveEventArgs carries the SFTPServer BeforeRemove event's parameters.
pub struct SFTPServerBeforeRemoveEventArgs {
  fn connection_id(&self) -> i64
  fn path(&self) -> &String
  fn action(&self) -> i32
  fn set_action(&self, value : i32)
}

// SFTPServerBeforeRemoveEvent defines the signature of the SFTPServer BeforeRemove event's handler function.
pub trait SFTPServerBeforeRemoveEvent {
  fn on_before_remove(&self, sender : SFTPServer, e : &mut SFTPServerBeforeRemoveEventArgs);
}

impl <'a> SFTPServer<'a> {
  pub fn on_before_remove(&self) -> &'a dyn SFTPServerBeforeRemoveEvent;
  pub fn set_on_before_remove(&mut self, value : &'a dyn SFTPServerBeforeRemoveEvent);
  ...
}

Remarks

This event is fired when a request to delete a file or directory is received from the client. The ConnectionID parameter specifies in which session the request was received.

Choose Action as one of the following values:

on_before_rename_file event (SFTPServer Struct)

This event is fired when a client requests to rename a file.

Syntax

// SFTPServerBeforeRenameFileEventArgs carries the SFTPServer BeforeRenameFile event's parameters.
pub struct SFTPServerBeforeRenameFileEventArgs {
  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)
}

// SFTPServerBeforeRenameFileEvent defines the signature of the SFTPServer BeforeRenameFile event's handler function.
pub trait SFTPServerBeforeRenameFileEvent {
  fn on_before_rename_file(&self, sender : SFTPServer, e : &mut SFTPServerBeforeRenameFileEventArgs);
}

impl <'a> SFTPServer<'a> {
  pub fn on_before_rename_file(&self) -> &'a dyn SFTPServerBeforeRenameFileEvent;
  pub fn set_on_before_rename_file(&mut self, value : &'a dyn SFTPServerBeforeRenameFileEvent);
  ...
}

Remarks

This event is fired when a request to rename a file (from OldPath to NewPath) is received from the client. The ConnectionID parameter specifies in which session the request was received.

Choose Action as one of the following values:

on_before_request_attributes event (SFTPServer Struct)

This event is fired when a client requests to get file attributes.

Syntax

// SFTPServerBeforeRequestAttributesEventArgs carries the SFTPServer BeforeRequestAttributes event's parameters.
pub struct SFTPServerBeforeRequestAttributesEventArgs {
  fn connection_id(&self) -> i64
  fn path(&self) -> &String
  fn action(&self) -> i32
  fn set_action(&self, value : i32)
}

// SFTPServerBeforeRequestAttributesEvent defines the signature of the SFTPServer BeforeRequestAttributes event's handler function.
pub trait SFTPServerBeforeRequestAttributesEvent {
  fn on_before_request_attributes(&self, sender : SFTPServer, e : &mut SFTPServerBeforeRequestAttributesEventArgs);
}

impl <'a> SFTPServer<'a> {
  pub fn on_before_request_attributes(&self) -> &'a dyn SFTPServerBeforeRequestAttributesEvent;
  pub fn set_on_before_request_attributes(&mut self, value : &'a dyn SFTPServerBeforeRequestAttributesEvent);
  ...
}

Remarks

This event is fired when a request to get file attributes has been received. The ConnectionID parameter specifies in which session the request was received.

Choose Action as one of the following values:

on_before_set_attributes event (SFTPServer Struct)

This event is fired when a client requests to set file attributes.

Syntax

// SFTPServerBeforeSetAttributesEventArgs carries the SFTPServer BeforeSetAttributes event's parameters.
pub struct SFTPServerBeforeSetAttributesEventArgs {
  fn connection_id(&self) -> i64
  fn path(&self) -> &String
  fn action(&self) -> i32
  fn set_action(&self, value : i32)
}

// SFTPServerBeforeSetAttributesEvent defines the signature of the SFTPServer BeforeSetAttributes event's handler function.
pub trait SFTPServerBeforeSetAttributesEvent {
  fn on_before_set_attributes(&self, sender : SFTPServer, e : &mut SFTPServerBeforeSetAttributesEventArgs);
}

impl <'a> SFTPServer<'a> {
  pub fn on_before_set_attributes(&self) -> &'a dyn SFTPServerBeforeSetAttributesEvent;
  pub fn set_on_before_set_attributes(&mut self, value : &'a dyn SFTPServerBeforeSetAttributesEvent);
  ...
}

Remarks

This event is fired when a request to set file attributes has been received. The ConnectionID parameter specifies in which session the request was received.

Choose Action as one of the following values:

on_before_upload_file event (SFTPServer Struct)

This event is fired when an upload file request is received.

Syntax

// SFTPServerBeforeUploadFileEventArgs carries the SFTPServer BeforeUploadFile event's parameters.
pub struct SFTPServerBeforeUploadFileEventArgs {
  fn connection_id(&self) -> i64
  fn path(&self) -> &String
  fn action(&self) -> i32
  fn set_action(&self, value : i32)
}

// SFTPServerBeforeUploadFileEvent defines the signature of the SFTPServer BeforeUploadFile event's handler function.
pub trait SFTPServerBeforeUploadFileEvent {
  fn on_before_upload_file(&self, sender : SFTPServer, e : &mut SFTPServerBeforeUploadFileEventArgs);
}

impl <'a> SFTPServer<'a> {
  pub fn on_before_upload_file(&self) -> &'a dyn SFTPServerBeforeUploadFileEvent;
  pub fn set_on_before_upload_file(&mut self, value : &'a dyn SFTPServerBeforeUploadFileEvent);
  ...
}

Remarks

This event is fired when an upload file request is received from the client. The ConnectionID parameter specifies in which session the request was received, and Path specifies the location on the server where the file needs to be saved.

Choose Action as one of the following values:

on_close_client_forwarding event (SFTPServer Struct)

This event is fired when a client has closed a previously opened forwarding channel.

Syntax

// SFTPServerCloseClientForwardingEventArgs carries the SFTPServer CloseClientForwarding event's parameters.
pub struct SFTPServerCloseClientForwardingEventArgs {
  fn connection_id(&self) -> i64
  fn dest_host(&self) -> &String
  fn dest_port(&self) -> i32
  fn src_host(&self) -> &String
  fn src_port(&self) -> i32
}

// SFTPServerCloseClientForwardingEvent defines the signature of the SFTPServer CloseClientForwarding event's handler function.
pub trait SFTPServerCloseClientForwardingEvent {
  fn on_close_client_forwarding(&self, sender : SFTPServer, e : &mut SFTPServerCloseClientForwardingEventArgs);
}

impl <'a> SFTPServer<'a> {
  pub fn on_close_client_forwarding(&self) -> &'a dyn SFTPServerCloseClientForwardingEvent;
  pub fn set_on_close_client_forwarding(&mut self, value : &'a dyn SFTPServerCloseClientForwardingEvent);
  ...
}

Remarks

The ConnectionID parameter specifies in which session the request was received.

on_close_command event (SFTPServer Struct)

This event is fired when a client has closed a previously opened SSH command channel.

Syntax

// SFTPServerCloseCommandEventArgs carries the SFTPServer CloseCommand event's parameters.
pub struct SFTPServerCloseCommandEventArgs {
  fn connection_id(&self) -> i64
  fn command(&self) -> &String
}

// SFTPServerCloseCommandEvent defines the signature of the SFTPServer CloseCommand event's handler function.
pub trait SFTPServerCloseCommandEvent {
  fn on_close_command(&self, sender : SFTPServer, e : &mut SFTPServerCloseCommandEventArgs);
}

impl <'a> SFTPServer<'a> {
  pub fn on_close_command(&self) -> &'a dyn SFTPServerCloseCommandEvent;
  pub fn set_on_close_command(&mut self, value : &'a dyn SFTPServerCloseCommandEvent);
  ...
}

Remarks

The ConnectionID parameter specifies in which session the request was received.

on_close_file event (SFTPServer Struct)

This event instructs the application to close an opened file.

Syntax

// SFTPServerCloseFileEventArgs carries the SFTPServer CloseFile event's parameters.
pub struct SFTPServerCloseFileEventArgs {
  fn connection_id(&self) -> i64
  fn handle(&self) -> &String
  fn operation_status(&self) -> i32
  fn set_operation_status(&self, value : i32)
}

// SFTPServerCloseFileEvent defines the signature of the SFTPServer CloseFile event's handler function.
pub trait SFTPServerCloseFileEvent {
  fn on_close_file(&self, sender : SFTPServer, e : &mut SFTPServerCloseFileEventArgs);
}

impl <'a> SFTPServer<'a> {
  pub fn on_close_file(&self) -> &'a dyn SFTPServerCloseFileEvent;
  pub fn set_on_close_file(&mut self, value : &'a dyn SFTPServerCloseFileEvent);
  ...
}

Remarks

This event is fired upon receipt of a close-file packet from a client. Servers implementing virtualized transfers must close the previously opened local file referenced by Handle in this event handler. No further operations are allowed with the closed file.

Set OperationStatus to one of the following values to report the result of this operation to the client:

on_close_server_forwarding event (SFTPServer Struct)

This event is fired when a client has closed a previously opened forwarding channel.

Syntax

// SFTPServerCloseServerForwardingEventArgs carries the SFTPServer CloseServerForwarding event's parameters.
pub struct SFTPServerCloseServerForwardingEventArgs {
  fn connection_id(&self) -> i64
  fn local_host(&self) -> &String
  fn local_port(&self) -> i32
  fn src_host(&self) -> &String
  fn src_port(&self) -> i32
}

// SFTPServerCloseServerForwardingEvent defines the signature of the SFTPServer CloseServerForwarding event's handler function.
pub trait SFTPServerCloseServerForwardingEvent {
  fn on_close_server_forwarding(&self, sender : SFTPServer, e : &mut SFTPServerCloseServerForwardingEventArgs);
}

impl <'a> SFTPServer<'a> {
  pub fn on_close_server_forwarding(&self) -> &'a dyn SFTPServerCloseServerForwardingEvent;
  pub fn set_on_close_server_forwarding(&mut self, value : &'a dyn SFTPServerCloseServerForwardingEvent);
  ...
}

Remarks

The ConnectionID parameter specifies in which session the request was received.

on_close_shell event (SFTPServer Struct)

This event is fired when a client has closed a previously opened shell channel.

Syntax

// SFTPServerCloseShellEventArgs carries the SFTPServer CloseShell event's parameters.
pub struct SFTPServerCloseShellEventArgs {
  fn connection_id(&self) -> i64
}

// SFTPServerCloseShellEvent defines the signature of the SFTPServer CloseShell event's handler function.
pub trait SFTPServerCloseShellEvent {
  fn on_close_shell(&self, sender : SFTPServer, e : &mut SFTPServerCloseShellEventArgs);
}

impl <'a> SFTPServer<'a> {
  pub fn on_close_shell(&self) -> &'a dyn SFTPServerCloseShellEvent;
  pub fn set_on_close_shell(&mut self, value : &'a dyn SFTPServerCloseShellEvent);
  ...
}

Remarks

The ConnectionID parameter specifies in which session the request was received.

on_connect event (SFTPServer Struct)

This event is fired when a remote connection has been established.

Syntax

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

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

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

Remarks

ConnectionID contains a session identifier, and RemoteAddress specifies the client's IP address.

on_create_directory event (SFTPServer Struct)

This event instructs the application to create a directory.

Syntax

// SFTPServerCreateDirectoryEventArgs carries the SFTPServer CreateDirectory event's parameters.
pub struct SFTPServerCreateDirectoryEventArgs {
  fn connection_id(&self) -> i64
  fn path(&self) -> &String
  fn operation_status(&self) -> i32
  fn set_operation_status(&self, value : i32)
}

// SFTPServerCreateDirectoryEvent defines the signature of the SFTPServer CreateDirectory event's handler function.
pub trait SFTPServerCreateDirectoryEvent {
  fn on_create_directory(&self, sender : SFTPServer, e : &mut SFTPServerCreateDirectoryEventArgs);
}

impl <'a> SFTPServer<'a> {
  pub fn on_create_directory(&self) -> &'a dyn SFTPServerCreateDirectoryEvent;
  pub fn set_on_create_directory(&mut self, value : &'a dyn SFTPServerCreateDirectoryEvent);
  ...
}

Remarks

This event is fired when a request to create a directory has been received and needs to be served (virtualized) by the application. The ConnectionID parameter specifies the session that has communicated the request, and Path contains the name of the directory to be created.

Set OperationStatus to one of the below values according to the outcome of the request processing:

on_disconnect event (SFTPServer Struct)

This event is fired when a client has disconnected.

Syntax

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

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

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

Remarks

This event reports loss of connection to the client within the session specified by ConnectionID.

on_error event (SFTPServer Struct)

Information about errors during data delivery.

Syntax

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

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

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

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

on_external_sign event (SFTPServer Struct)

Handles remote or external signing initiated by the server protocol.

Syntax

// SFTPServerExternalSignEventArgs carries the SFTPServer ExternalSign event's parameters.
pub struct SFTPServerExternalSignEventArgs {
  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)
}

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

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

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

This event signifies the completion of a custom file listing operation.

Syntax

// SFTPServerFindCloseEventArgs carries the SFTPServer FindClose event's parameters.
pub struct SFTPServerFindCloseEventArgs {
  fn connection_id(&self) -> i64
  fn handle(&self) -> &String
  fn operation_status(&self) -> i32
  fn set_operation_status(&self, value : i32)
}

// SFTPServerFindCloseEvent defines the signature of the SFTPServer FindClose event's handler function.
pub trait SFTPServerFindCloseEvent {
  fn on_find_close(&self, sender : SFTPServer, e : &mut SFTPServerFindCloseEventArgs);
}

impl <'a> SFTPServer<'a> {
  pub fn on_find_close(&self) -> &'a dyn SFTPServerFindCloseEvent;
  pub fn set_on_find_close(&mut self, value : &'a dyn SFTPServerFindCloseEvent);
  ...
}

Remarks

on_find_close notifies your code about the completion of a custom file listing request. Use it in conjunction with on_find_first and on_find_next to handle file listing requests manually.

See on_find_first topic for the details on implementing customized file listing request processing.

Set OperationStatus to one of the below values according to the outcome of the request processing:

on_find_first event (SFTPServer Struct)

This event signifies the start of the custom file listing retrieval mechanism.

Syntax

// SFTPServerFindFirstEventArgs carries the SFTPServer FindFirst event's parameters.
pub struct SFTPServerFindFirstEventArgs {
  fn connection_id(&self) -> i64
  fn path(&self) -> &String
  fn operation_status(&self) -> i32
  fn set_operation_status(&self, value : i32)
  fn handle(&self) -> &String
  fn set_handle(&self, value : &str)
  fn set_handle_ref(&self, value : &String)
}

// SFTPServerFindFirstEvent defines the signature of the SFTPServer FindFirst event's handler function.
pub trait SFTPServerFindFirstEvent {
  fn on_find_first(&self, sender : SFTPServer, e : &mut SFTPServerFindFirstEventArgs);
}

impl <'a> SFTPServer<'a> {
  pub fn on_find_first(&self) -> &'a dyn SFTPServerFindFirstEvent;
  pub fn set_on_find_first(&mut self, value : &'a dyn SFTPServerFindFirstEvent);
  ...
}

Remarks

on_find_first, on_find_next, and on_find_close events represent a mechanism for providing customized file listings to struct. They are only fired if Action parameter of the preceding on_before_find event was set to fraCustom.

The behaviour of these events mimics that of the standard FindFirst/FindNext/FindClose functions found in many operating systems/frameworks. on_find_first fires once to request the first list entry; on_find_next then fires continuously in a loop to request all subsequent entries. To indicate that the listing is over, set OperationStatus parameter to ostEOF. Not doing so may lead to an endless loop and session freeze, as the component would continue firing on_find_next infinitely waiting for the EOF marker.

The handlers for both on_find_first and on_find_next events should be implemented in the following way: if there are more entries in the directory to pass back to the server component,

• set OperationStatus to ostOK,
• fill in client_file_entry with the details of the next entry,
• commit the entry to the server using set_client_file_entry method.

When all the entries from the requested directory have been passed to the server component, set OperationStatus to ostEOF. The server will then fire on_find_close event to notify your code that the file listing is completed.

Use the by-ref Handle parameter to assign a handle (a unique identifier) to the file listing procedure inside the on_find_first event handler. This identifier will then be passed to all subsequent on_find_next and on_find_close calls to let your code chain the events together.

The ConnectionID parameter specifies in which SFTP session the request was received, and Path indicates the requested directory.

The following operation status constants are available, besides the ones referenced above:

on_find_next event (SFTPServer Struct)

This event retrieves the next entry of a custom file listing.

Syntax

// SFTPServerFindNextEventArgs carries the SFTPServer FindNext event's parameters.
pub struct SFTPServerFindNextEventArgs {
  fn connection_id(&self) -> i64
  fn handle(&self) -> &String
  fn operation_status(&self) -> i32
  fn set_operation_status(&self, value : i32)
}

// SFTPServerFindNextEvent defines the signature of the SFTPServer FindNext event's handler function.
pub trait SFTPServerFindNextEvent {
  fn on_find_next(&self, sender : SFTPServer, e : &mut SFTPServerFindNextEventArgs);
}

impl <'a> SFTPServer<'a> {
  pub fn on_find_next(&self) -> &'a dyn SFTPServerFindNextEvent;
  pub fn set_on_find_next(&mut self, value : &'a dyn SFTPServerFindNextEvent);
  ...
}

Remarks

This event is fired repeatedly after on_find_first to retrieve the directory contents entry-by-entry. Please see the on_find_first topic for more details about implementing a handler of this event.

Remember to set OperationStatus to ostEOF when there are no more entries left to close the listing operation. If there are more entries to pass, set it to ostOK. Other possible values are given in the table below:

on_listening_started event (SFTPServer Struct)

Fires when the server has started accepting connections on a local port.

Syntax

// SFTPServerListeningStartedEventArgs carries the SFTPServer ListeningStarted event's parameters.
pub struct SFTPServerListeningStartedEventArgs {
  fn host(&self) -> &String
  fn port(&self) -> i32
}

// SFTPServerListeningStartedEvent defines the signature of the SFTPServer ListeningStarted event's handler function.
pub trait SFTPServerListeningStartedEvent {
  fn on_listening_started(&self, sender : SFTPServer, e : &mut SFTPServerListeningStartedEventArgs);
}

impl <'a> SFTPServer<'a> {
  pub fn on_listening_started(&self) -> &'a dyn SFTPServerListeningStartedEvent;
  pub fn set_on_listening_started(&mut self, value : &'a dyn SFTPServerListeningStartedEvent);
  ...
}

Remarks

This event is fired when the server is ready to accept incoming SSH/SFTP connections.

on_listening_stopped event (SFTPServer Struct)

Fires when the server has stopped accepting connections on a local port.

Syntax

// SFTPServerListeningStoppedEventArgs carries the SFTPServer ListeningStopped event's parameters.
pub struct SFTPServerListeningStoppedEventArgs {
  fn host(&self) -> &String
  fn port(&self) -> i32
}

// SFTPServerListeningStoppedEvent defines the signature of the SFTPServer ListeningStopped event's handler function.
pub trait SFTPServerListeningStoppedEvent {
  fn on_listening_stopped(&self, sender : SFTPServer, e : &mut SFTPServerListeningStoppedEventArgs);
}

impl <'a> SFTPServer<'a> {
  pub fn on_listening_stopped(&self) -> &'a dyn SFTPServerListeningStoppedEvent;
  pub fn set_on_listening_stopped(&mut self, value : &'a dyn SFTPServerListeningStoppedEvent);
  ...
}

Remarks

This event is fired when the server has closed the listening socket and can no longer accept incoming SSH/SFTP connections.

on_notification event (SFTPServer Struct)

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

Syntax

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

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

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

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_open_client_forwarding event (SFTPServer Struct)

This event is fired when a client opens a client-side (local) forwarding channel.

Syntax

// SFTPServerOpenClientForwardingEventArgs carries the SFTPServer OpenClientForwarding event's parameters.
pub struct SFTPServerOpenClientForwardingEventArgs {
  fn connection_id(&self) -> i64
  fn dest_host(&self) -> &String
  fn dest_port(&self) -> i32
  fn src_host(&self) -> &String
  fn src_port(&self) -> i32
}

// SFTPServerOpenClientForwardingEvent defines the signature of the SFTPServer OpenClientForwarding event's handler function.
pub trait SFTPServerOpenClientForwardingEvent {
  fn on_open_client_forwarding(&self, sender : SFTPServer, e : &mut SFTPServerOpenClientForwardingEventArgs);
}

impl <'a> SFTPServer<'a> {
  pub fn on_open_client_forwarding(&self) -> &'a dyn SFTPServerOpenClientForwardingEvent;
  pub fn set_on_open_client_forwarding(&mut self, value : &'a dyn SFTPServerOpenClientForwardingEvent);
  ...
}

Remarks

This event notifies the application that a client-side forwarding channel has been set up. The ConnectionID parameter specifies in which session the request was received.

The DestHost and DestPort parameters specify the address that the data received from the client will be forwarded to. The SrcHost and SrcPort specify the connection origin that is reported by the client. Note that the details of the origin cannot be verified.

on_open_command event (SFTPServer Struct)

This event is fired when a client has opened an SSH command channel.

Syntax

// SFTPServerOpenCommandEventArgs carries the SFTPServer OpenCommand event's parameters.
pub struct SFTPServerOpenCommandEventArgs {
  fn connection_id(&self) -> i64
  fn command(&self) -> &String
}

// SFTPServerOpenCommandEvent defines the signature of the SFTPServer OpenCommand event's handler function.
pub trait SFTPServerOpenCommandEvent {
  fn on_open_command(&self, sender : SFTPServer, e : &mut SFTPServerOpenCommandEventArgs);
}

impl <'a> SFTPServer<'a> {
  pub fn on_open_command(&self) -> &'a dyn SFTPServerOpenCommandEvent;
  pub fn set_on_open_command(&mut self, value : &'a dyn SFTPServerOpenCommandEvent);
  ...
}

Remarks

The ConnectionID parameter specifies in which session the request was received.

The component fires on_close_command when the command channel is closed.

on_open_file event (SFTPServer Struct)

This event instructs the application to handle the file open request.

Syntax

// SFTPServerOpenFileEventArgs carries the SFTPServer OpenFile event's parameters.
pub struct SFTPServerOpenFileEventArgs {
  fn connection_id(&self) -> i64
  fn path(&self) -> &String
  fn modes(&self) -> i32
  fn access(&self) -> i32
  fn operation_status(&self) -> i32
  fn set_operation_status(&self, value : i32)
  fn handle(&self) -> &String
  fn set_handle(&self, value : &str)
  fn set_handle_ref(&self, value : &String)
}

// SFTPServerOpenFileEvent defines the signature of the SFTPServer OpenFile event's handler function.
pub trait SFTPServerOpenFileEvent {
  fn on_open_file(&self, sender : SFTPServer, e : &mut SFTPServerOpenFileEventArgs);
}

impl <'a> SFTPServer<'a> {
  pub fn on_open_file(&self) -> &'a dyn SFTPServerOpenFileEvent;
  pub fn set_on_open_file(&mut self, value : &'a dyn SFTPServerOpenFileEvent);
  ...
}

Remarks

This event is fired when a file open request is received from the client and needs to be handled (virtualized) by the server. The ConnectionID parameter specifies in which session the request was received, and Path specifies the location of the file.

Modes can be a combination of one or several file open mode flags:

Different client applications may provide different selections of mode flags. For example, some clients specify (cfmCreate + cfmTruncate) when overwriting files, whereas others would specify cfmOpenOrCreate. Please make sure your code is prepared to receive different combinations of flags here and handles them gracefully.

The Access parameter provides additional file access modifiers:

These parameter may also contain a combination of the above flags. Access modifiers are only supported in SFTPv6, and in practice are rarely used by client applications.

The Handle string represents a unique identifier of the opened file, similar to file handles used in Windows or Unix APIs. Handles are unique across all files opened at the same time. Struct generates handles automatically, but you can update the auto-generated values with your own in this event handler (just remember to keep them unique).

Set OperationStatus parameter in accordance with the outcome of the operation to one of the values given below:

on_open_server_forwarding event (SFTPServer Struct)

This event is fired when the server opens a server-side (remote) forwarding channel.

Syntax

// SFTPServerOpenServerForwardingEventArgs carries the SFTPServer OpenServerForwarding event's parameters.
pub struct SFTPServerOpenServerForwardingEventArgs {
  fn connection_id(&self) -> i64
  fn local_host(&self) -> &String
  fn local_port(&self) -> i32
  fn src_host(&self) -> &String
  fn src_port(&self) -> i32
}

// SFTPServerOpenServerForwardingEvent defines the signature of the SFTPServer OpenServerForwarding event's handler function.
pub trait SFTPServerOpenServerForwardingEvent {
  fn on_open_server_forwarding(&self, sender : SFTPServer, e : &mut SFTPServerOpenServerForwardingEventArgs);
}

impl <'a> SFTPServer<'a> {
  pub fn on_open_server_forwarding(&self) -> &'a dyn SFTPServerOpenServerForwardingEvent;
  pub fn set_on_open_server_forwarding(&mut self, value : &'a dyn SFTPServerOpenServerForwardingEvent);
  ...
}

Remarks

This event notifies the application that a server-side forwarding channel has been set up. The ConnectionID parameter specifies in which session the request was received.

The DestHost and DestPort parameters specify the address that the data received from the connection accepted by the server will be forwarded to, according to the client. The SrcHost and SrcPort specify the connection origin.

on_open_shell event (SFTPServer Struct)

This event is fired when a client has opened a shell channel.

Syntax

// SFTPServerOpenShellEventArgs carries the SFTPServer OpenShell event's parameters.
pub struct SFTPServerOpenShellEventArgs {
  fn connection_id(&self) -> i64
}

// SFTPServerOpenShellEvent defines the signature of the SFTPServer OpenShell event's handler function.
pub trait SFTPServerOpenShellEvent {
  fn on_open_shell(&self, sender : SFTPServer, e : &mut SFTPServerOpenShellEventArgs);
}

impl <'a> SFTPServer<'a> {
  pub fn on_open_shell(&self) -> &'a dyn SFTPServerOpenShellEvent;
  pub fn set_on_open_shell(&mut self, value : &'a dyn SFTPServerOpenShellEvent);
  ...
}

Remarks

The ConnectionID parameter specifies in which session the request was received.

The component fires on_close_shell when the shell channel is closed.

on_read_file event (SFTPServer Struct)

This event is fired when a file read request is received.

Syntax

// SFTPServerReadFileEventArgs carries the SFTPServer ReadFile event's parameters.
pub struct SFTPServerReadFileEventArgs {
  fn connection_id(&self) -> i64
  fn handle(&self) -> &String
  fn offset(&self) -> i64
  fn size(&self) -> i32
  fn operation_status(&self) -> i32
  fn set_operation_status(&self, value : i32)
}

// SFTPServerReadFileEvent defines the signature of the SFTPServer ReadFile event's handler function.
pub trait SFTPServerReadFileEvent {
  fn on_read_file(&self, sender : SFTPServer, e : &mut SFTPServerReadFileEventArgs);
}

impl <'a> SFTPServer<'a> {
  pub fn on_read_file(&self) -> &'a dyn SFTPServerReadFileEvent;
  pub fn set_on_read_file(&mut self, value : &'a dyn SFTPServerReadFileEvent);
  ...
}

Remarks

This event is fired when a request to read block from a file is received from the client. The ConnectionID parameter specifies in which session the request was received, and Handle indicates an opened file handle. Offset and Size denote the location and size of the file piece.

Inside the event handler, pass the appropriate file chunk to the component via set_client_buffer method.

Set OperationStatus to one of the below values according to the outcome of the request processing:

on_remove event (SFTPServer Struct)

This event is fired when a client requests to delete a file or directory.

Syntax

// SFTPServerRemoveEventArgs carries the SFTPServer Remove event's parameters.
pub struct SFTPServerRemoveEventArgs {
  fn connection_id(&self) -> i64
  fn path(&self) -> &String
  fn operation_status(&self) -> i32
  fn set_operation_status(&self, value : i32)
}

// SFTPServerRemoveEvent defines the signature of the SFTPServer Remove event's handler function.
pub trait SFTPServerRemoveEvent {
  fn on_remove(&self, sender : SFTPServer, e : &mut SFTPServerRemoveEventArgs);
}

impl <'a> SFTPServer<'a> {
  pub fn on_remove(&self) -> &'a dyn SFTPServerRemoveEvent;
  pub fn set_on_remove(&mut self, value : &'a dyn SFTPServerRemoveEvent);
  ...
}

Remarks

This event is fired when a request to delete a file or directory is received from the client. The ConnectionID parameter specifies in which session the request was received.

Set OperationStatus to one of the below values according to the outcome of the request processing:

on_rename_file event (SFTPServer Struct)

This event is fired when a client requests to rename a file.

Syntax

// SFTPServerRenameFileEventArgs carries the SFTPServer RenameFile event's parameters.
pub struct SFTPServerRenameFileEventArgs {
  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)
}

// SFTPServerRenameFileEvent defines the signature of the SFTPServer RenameFile event's handler function.
pub trait SFTPServerRenameFileEvent {
  fn on_rename_file(&self, sender : SFTPServer, e : &mut SFTPServerRenameFileEventArgs);
}

impl <'a> SFTPServer<'a> {
  pub fn on_rename_file(&self) -> &'a dyn SFTPServerRenameFileEvent;
  pub fn set_on_rename_file(&mut self, value : &'a dyn SFTPServerRenameFileEvent);
  ...
}

Remarks

This event is fired when a request to rename a file (from OldPath to NewPath) is received from the client. The ConnectionID parameter specifies in which session the request was received.

Set OperationStatus to one of the below values according to the outcome of the request processing:

on_request_attributes event (SFTPServer Struct)

This event is fired when a get file attributes request is received.

Syntax

// SFTPServerRequestAttributesEventArgs carries the SFTPServer RequestAttributes event's parameters.
pub struct SFTPServerRequestAttributesEventArgs {
  fn connection_id(&self) -> i64
  fn path(&self) -> &String
  fn handle(&self) -> &String
  fn operation_status(&self) -> i32
  fn set_operation_status(&self, value : i32)
}

// SFTPServerRequestAttributesEvent defines the signature of the SFTPServer RequestAttributes event's handler function.
pub trait SFTPServerRequestAttributesEvent {
  fn on_request_attributes(&self, sender : SFTPServer, e : &mut SFTPServerRequestAttributesEventArgs);
}

impl <'a> SFTPServer<'a> {
  pub fn on_request_attributes(&self) -> &'a dyn SFTPServerRequestAttributesEvent;
  pub fn set_on_request_attributes(&mut self, value : &'a dyn SFTPServerRequestAttributesEvent);
  ...
}

Remarks

This event is fired when a request to get file attributes is received from the client. The ConnectionID parameter specifies in which session the request was received, and Path specifies the file location where the attributes need to be retrieved.

Set OperationStatus to one of the below values according to the outcome of the request processing:

on_server_forwarding_cancel event (SFTPServer Struct)

This event is fired when the client cancels a previously negotiated server-side (remote) forwarding.

Syntax

// SFTPServerServerForwardingCancelEventArgs carries the SFTPServer ServerForwardingCancel event's parameters.
pub struct SFTPServerServerForwardingCancelEventArgs {
  fn connection_id(&self) -> i64
  fn local_host(&self) -> &String
  fn local_port(&self) -> i32
}

// SFTPServerServerForwardingCancelEvent defines the signature of the SFTPServer ServerForwardingCancel event's handler function.
pub trait SFTPServerServerForwardingCancelEvent {
  fn on_server_forwarding_cancel(&self, sender : SFTPServer, e : &mut SFTPServerServerForwardingCancelEventArgs);
}

impl <'a> SFTPServer<'a> {
  pub fn on_server_forwarding_cancel(&self) -> &'a dyn SFTPServerServerForwardingCancelEvent;
  pub fn set_on_server_forwarding_cancel(&mut self, value : &'a dyn SFTPServerServerForwardingCancelEvent);
  ...
}

Remarks

The ConnectionID parameter specifies in which session the request was received. The LocalHost:LocalPort specify the endpoint that the server is listening on.

After receiving the cancellation request the server will no longer listen to connections at the mentioned endpoint.

Choose Action as one of the following values:

on_server_forwarding_open_failed event (SFTPServer Struct)

This event is fired when the client rejects the server request to establish a server forwarding channel.

Syntax

// SFTPServerServerForwardingOpenFailedEventArgs carries the SFTPServer ServerForwardingOpenFailed event's parameters.
pub struct SFTPServerServerForwardingOpenFailedEventArgs {
  fn connection_id(&self) -> i64
  fn local_host(&self) -> &String
  fn local_port(&self) -> i32
  fn src_host(&self) -> &String
  fn src_port(&self) -> i32
}

// SFTPServerServerForwardingOpenFailedEvent defines the signature of the SFTPServer ServerForwardingOpenFailed event's handler function.
pub trait SFTPServerServerForwardingOpenFailedEvent {
  fn on_server_forwarding_open_failed(&self, sender : SFTPServer, e : &mut SFTPServerServerForwardingOpenFailedEventArgs);
}

impl <'a> SFTPServer<'a> {
  pub fn on_server_forwarding_open_failed(&self) -> &'a dyn SFTPServerServerForwardingOpenFailedEvent;
  pub fn set_on_server_forwarding_open_failed(&mut self, value : &'a dyn SFTPServerServerForwardingOpenFailedEvent);
  ...
}

Remarks

This event can follow the on_before_open_server_forwarding and on_open_server_forwarding if the client rejects the server request to forward an accepted TCP connection.

The ConnectionID parameter specifies in which session the request was received. The LocalHost:LocalPort specify the endpoint that the server has received the connection on.

on_server_forwarding_request event (SFTPServer Struct)

This event is fired when the client requests the server to set up server-side (remote) forwarding.

Syntax

// SFTPServerServerForwardingRequestEventArgs carries the SFTPServer ServerForwardingRequest event's parameters.
pub struct SFTPServerServerForwardingRequestEventArgs {
  fn connection_id(&self) -> i64
  fn local_host(&self) -> &String
  fn local_port(&self) -> i32
  fn set_local_port(&self, value : i32)
  fn action(&self) -> i32
  fn set_action(&self, value : i32)
}

// SFTPServerServerForwardingRequestEvent defines the signature of the SFTPServer ServerForwardingRequest event's handler function.
pub trait SFTPServerServerForwardingRequestEvent {
  fn on_server_forwarding_request(&self, sender : SFTPServer, e : &mut SFTPServerServerForwardingRequestEventArgs);
}

impl <'a> SFTPServer<'a> {
  pub fn on_server_forwarding_request(&self) -> &'a dyn SFTPServerServerForwardingRequestEvent;
  pub fn set_on_server_forwarding_request(&mut self, value : &'a dyn SFTPServerServerForwardingRequestEvent);
  ...
}

Remarks

The ConnectionID parameter specifies in which session the request was received. The LocalHost:LocalPort specify the endpoint that the client expects the server to listen on. The server may choose to use a different port, in which case please adjust the LocalPort in the event handler.

If permitted, the server will open the requested port and start listening to incoming connections. All such connections will be reported via on_before_open_server_forwarding and on_open_server_forwarding events.

You can enable or disable server forwarding blanketly via the capabilities property.

Choose Action as one of the following values:

on_session_closed event (SFTPServer Struct)

Reports session closure.

Syntax

// SFTPServerSessionClosedEventArgs carries the SFTPServer SessionClosed event's parameters.
pub struct SFTPServerSessionClosedEventArgs {
  fn connection_id(&self) -> i64
}

// SFTPServerSessionClosedEvent defines the signature of the SFTPServer SessionClosed event's handler function.
pub trait SFTPServerSessionClosedEvent {
  fn on_session_closed(&self, sender : SFTPServer, e : &mut SFTPServerSessionClosedEventArgs);
}

impl <'a> SFTPServer<'a> {
  pub fn on_session_closed(&self) -> &'a dyn SFTPServerSessionClosedEvent;
  pub fn set_on_session_closed(&mut self, value : &'a dyn SFTPServerSessionClosedEvent);
  ...
}

Remarks

This event is fired when a connection identified by ConnectionID has been gracefully closed.

on_session_established event (SFTPServer Struct)

This event is fired when a new session is established.

Syntax

// SFTPServerSessionEstablishedEventArgs carries the SFTPServer SessionEstablished event's parameters.
pub struct SFTPServerSessionEstablishedEventArgs {
  fn connection_id(&self) -> i64
}

// SFTPServerSessionEstablishedEvent defines the signature of the SFTPServer SessionEstablished event's handler function.
pub trait SFTPServerSessionEstablishedEvent {
  fn on_session_established(&self, sender : SFTPServer, e : &mut SFTPServerSessionEstablishedEventArgs);
}

impl <'a> SFTPServer<'a> {
  pub fn on_session_established(&self) -> &'a dyn SFTPServerSessionEstablishedEvent;
  pub fn set_on_session_established(&mut self, value : &'a dyn SFTPServerSessionEstablishedEvent);
  ...
}

Remarks

This event is fired when a new connection identified by ConnectionID has been established with a client.

on_set_attributes event (SFTPServer Struct)

This event is fired when an set file attributes request is received.

Syntax

// SFTPServerSetAttributesEventArgs carries the SFTPServer SetAttributes event's parameters.
pub struct SFTPServerSetAttributesEventArgs {
  fn connection_id(&self) -> i64
  fn path(&self) -> &String
  fn handle(&self) -> &String
  fn operation_status(&self) -> i32
  fn set_operation_status(&self, value : i32)
}

// SFTPServerSetAttributesEvent defines the signature of the SFTPServer SetAttributes event's handler function.
pub trait SFTPServerSetAttributesEvent {
  fn on_set_attributes(&self, sender : SFTPServer, e : &mut SFTPServerSetAttributesEventArgs);
}

impl <'a> SFTPServer<'a> {
  pub fn on_set_attributes(&self) -> &'a dyn SFTPServerSetAttributesEvent;
  pub fn set_on_set_attributes(&mut self, value : &'a dyn SFTPServerSetAttributesEvent);
  ...
}

Remarks

This event is fired when a request to set file attributes is received from the client. The ConnectionID parameter specifies in which session the request was received, and Path specifies the file location which the attributes needs to be set.

Set OperationStatus to one of the below values according to the outcome of the request processing:

on_translate_path event (SFTPServer Struct)

This event is fired when a client requests the server to translate a path to its absolute form.

Syntax

// SFTPServerTranslatePathEventArgs carries the SFTPServer TranslatePath event's parameters.
pub struct SFTPServerTranslatePathEventArgs {
  fn connection_id(&self) -> i64
  fn path(&self) -> &String
  fn absolute_path(&self) -> &String
  fn set_absolute_path(&self, value : &str)
  fn set_absolute_path_ref(&self, value : &String)
  fn action(&self) -> i32
  fn set_action(&self, value : i32)
}

// SFTPServerTranslatePathEvent defines the signature of the SFTPServer TranslatePath event's handler function.
pub trait SFTPServerTranslatePathEvent {
  fn on_translate_path(&self, sender : SFTPServer, e : &mut SFTPServerTranslatePathEventArgs);
}

impl <'a> SFTPServer<'a> {
  pub fn on_translate_path(&self) -> &'a dyn SFTPServerTranslatePathEvent;
  pub fn set_on_translate_path(&mut self, value : &'a dyn SFTPServerTranslatePathEvent);
  ...
}

Remarks

This event is fired when a request to translate a relative path to the corresponding absolute path is received. The ConnectionID parameter specifies the session in which the request was received.

You can let the server do the translation automatically according to the default file system rules, or take care of it yourself. Use the Action parameter to specify who is responsible for the translation. If doing the translation manually, return the translated path via the AbsolutePath parameter. Action can take one of the following values:

on_write_file event (SFTPServer Struct)

This event is fired when a file write request is received.

Syntax

// SFTPServerWriteFileEventArgs carries the SFTPServer WriteFile event's parameters.
pub struct SFTPServerWriteFileEventArgs {
  fn connection_id(&self) -> i64
  fn handle(&self) -> &String
  fn offset(&self) -> i64
  fn operation_status(&self) -> i32
  fn set_operation_status(&self, value : i32)
}

// SFTPServerWriteFileEvent defines the signature of the SFTPServer WriteFile event's handler function.
pub trait SFTPServerWriteFileEvent {
  fn on_write_file(&self, sender : SFTPServer, e : &mut SFTPServerWriteFileEventArgs);
}

impl <'a> SFTPServer<'a> {
  pub fn on_write_file(&self) -> &'a dyn SFTPServerWriteFileEvent;
  pub fn set_on_write_file(&mut self, value : &'a dyn SFTPServerWriteFileEvent);
  ...
}

Remarks

This event is fired when a request to write a data block to a file is received from the client. The ConnectionID parameter specifies the session the request originates from. The Handle parameter references the opened file where the block should be written to. Offset references the position in the file where the block of data should be written.

Use get_client_buffer method to obtain the piece of data that should be written to the file.

Set OperationStatus to one of the below values according to the outcome of the request processing:

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

SFTPServer Config Settings

Base Config Settings

Trappable Errors (SFTPServer Struct)

SFTPServer Errors