Struct secureblackbox::SSHClient

Properties   Methods   Events   Config Settings   Errors  

The SSHClient struct provides client-side SSH protocol functionality.

Syntax

secureblackbox::SSHClient

Remarks

Use SSHClient to establish terminal-like connections to remote systems and run commands remotely. The component supports most of third-party implementations out there, and is capable of working in "shell" and "command" modes.

Start with assigning your sign-in credentials to username and password properties. Where public key authentication is to be used, assign your private authentication key to key property (remember to set username in this case too). Subscribe to events to be notified of the session progress. on_auth_failed, on_auth_succeeded, and on_connect are among those particularly useful.

Special attention should be paid to setting up the server key trust. Struct only allows connections to servers whose public keys are recognized as trusted, much like any other SSH clients do. Assign a path to the file containing the list of trusted keys to trusted_keys_file property. If you don't have such file, or if you would like to make trust decisions on the fly, subscribe to on_known_key_received and on_unknown_key_received events. These are fired whenever a trusted or untrusted key is received from the server. For unknown/untrusted keys, you need to set the Action parameter in your on_unknown_key_received event handler to catAcceptOnce (1) or catAcceptPermanently (2) for the connection to proceed.

Once you are all set up, you can go ahead by calling the connect method. This launches the SSH handshake and, if everything has been set up right, establishes a connection to the server. You can now use send and receive methods to exchange information with the server. You can exchange data in synchronous or asynchronous way; see the description in async_mode topic to learn more about each mode.

When you are done with the session, call disconnect to shut the connection down.

Hint: If you are only interested in a quick-and-dirty execution of a simple, non-interactive command, SSHClient offers a handy shortcut. connect_and_exec method is a self-contained mechanism which sets up a connection, performs the data exchange internally, and returns the command output. Please keep in mind that you still need to set up the server trust settings as described above for this method to work.

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

async_mode property (SSHClient Struct)

Controls the SSH clients mode of work.

Syntax

fn async_mode(&self ) -> Result<bool, SecureBlackboxError> 
fn set_async_mode(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

This property defines the way in which the struct communicates with the application/user code. async_mode set to false makes the component use synchronous single-thread approach. Synchronous mode is generally simpler to integrate and use, but please keep in mind that the calls like connect, receive or send_bytes may block until their execution completes. In asynchronous mode all operations return immediately, but more care should be taken about handling them in your code properly.

Here are a few highlights of each mode.

Synchronous mode:

• All operations are performed within the caller thread context
• Operations like connect or send_bytes may block
• Use poll to check for the availability of data before reading it out with receive or receive_bytes
• Return of a call guarantees completion of the operation
• Connection errors are reported straight from the methods via exceptions

Asynchronous mode:

• All operations are performed in a separate thread (and so are the event calls!)
• Methods like send return immediately
• Use on_data_sent and on_data_received events to be notified about actual data transmissions
• Return of call only marks the beginning of the operation and does not guarantee its successful completion
• Connection errors are reported via on_error event, often followed by on_disconnect.

Please note that this is a very important and sensitive property, which has a wide-scale effect on the way the SSH client works and co-operates with the application. Depending on the value assigned to this setting you may need to work with the component very differently.

When setting this property to true, please make sure that your code is prepared to handle events coming from the context of a different thread.

Data Type

bool

auth_attempts property (SSHClient Struct)

Specifies the number of SSH password authentication attempts.

Syntax

fn auth_attempts(&self ) -> Result<i32, SecureBlackboxError> 
fn set_auth_attempts(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

1

Remarks

In case of password authentication failure provide new password inside the on_auth_failed event handler.

Data Type

i32

commands property (SSHClient Struct)

Specifies the list of commands to execute.

Syntax

fn commands(&self ) -> Result<String, SecureBlackboxError> 
fn set_commands(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_commands_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Use this property to provide a list of commands to execute remotely. Separate different commands with EOL characters.

When this property is set, the component works in the command mode, meaning each command is executed in its own virtual terminal session. No shell connection is established.

If no commands are provided via this property, the component will establish a shell session.

Data Type

String

connected property (SSHClient Struct)

Specifies whether the client is connected to the SFTP server.

Syntax

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

Default Value

false

Remarks

Use this read-only property to check whether the client is connected to the server.

This property is read-only.

Data Type

bool

conn_info_client_key_algorithm property (SSHClient Struct)

Specifies the client's key algorithm.

Syntax

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

Default Value

""

Remarks

Specifies the client's key algorithm.

This property is read-only.

Data Type

String

conn_info_client_key_bits property (SSHClient Struct)

Specifies the length of the client's key.

Syntax

fn conn_info_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

conn_info_client_key_fingerprint property (SSHClient Struct)

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

Syntax

fn conn_info_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

conn_info_close_reason property (SSHClient Struct)

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

Syntax

fn conn_info_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

conn_info_compression_algorithm_inbound property (SSHClient Struct)

Compression algorithm for the incoming traffic.

Syntax

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

Default Value

""

Remarks

Compression algorithm for the incoming traffic.

This property is read-only.

Data Type

String

conn_info_compression_algorithm_outbound property (SSHClient Struct)

Compression algorithm for the outgoing traffic.

Syntax

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

Default Value

""

Remarks

Compression algorithm for the outgoing traffic.

This property is read-only.

Data Type

String

conn_info_encryption_algorithm_inbound property (SSHClient Struct)

Encryption algorithm for the incoming traffic.

Syntax

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

Default Value

""

Remarks

Encryption algorithm for the incoming traffic.

This property is read-only.

Data Type

String

conn_info_encryption_algorithm_outbound property (SSHClient Struct)

Encryption algorithm for the outgoing traffic.

Syntax

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

Default Value

""

Remarks

Encryption algorithm for the outgoing traffic.

This property is read-only.

Data Type

String

conn_info_inbound_encryption_key_bits property (SSHClient Struct)

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

Syntax

fn conn_info_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

conn_info_kex_algorithm property (SSHClient Struct)

The key exchange algorithm used during the SSH handshake.

Syntax

fn conn_info_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

conn_info_kex_bits property (SSHClient Struct)

The number of bits used by the key exchange algorithm.

Syntax

fn conn_info_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

conn_info_kex_lines property (SSHClient Struct)

The contents of the received KexInit packet.

Syntax

fn conn_info_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

conn_info_mac_algorithm_inbound property (SSHClient Struct)

MAC algorithm used for the incoming connection.

Syntax

fn conn_info_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

conn_info_mac_algorithm_outbound property (SSHClient Struct)

MAC algorithm used for outbound connection.

Syntax

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

Default Value

""

Remarks

MAC algorithm used for outbound connection.

This property is read-only.

Data Type

String

conn_info_outbound_encryption_key_bits property (SSHClient Struct)

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

Syntax

fn conn_info_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

conn_info_public_key_algorithm property (SSHClient Struct)

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

Syntax

fn conn_info_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

conn_info_remote_address property (SSHClient Struct)

The client's IP address.

Syntax

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

Default Value

""

Remarks

The client's IP address.

This property is read-only.

Data Type

String

conn_info_remote_port property (SSHClient Struct)

The remote port of the client connection.

Syntax

fn conn_info_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

conn_info_remote_software_name property (SSHClient Struct)

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

Syntax

fn conn_info_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

conn_info_server_key_algorithm property (SSHClient Struct)

Specifies the server's key algorithm.

Syntax

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

Default Value

""

Remarks

Specifies the server's key algorithm.

This property is read-only.

Data Type

String

conn_info_server_key_bits property (SSHClient Struct)

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

Syntax

fn conn_info_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

conn_info_server_key_fingerprint property (SSHClient Struct)

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

Syntax

fn conn_info_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

conn_info_total_bytes_received property (SSHClient Struct)

Returns the total number of bytes received over this connection.

Syntax

fn conn_info_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

conn_info_total_bytes_sent property (SSHClient Struct)

Returns the total number of bytes sent over this connection.

Syntax

fn conn_info_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

conn_info_version property (SSHClient Struct)

Specifies SSH protocol version.

Syntax

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

Default Value

2

Remarks

Specifies SSH protocol version.

This property is read-only.

Data Type

i32

exit_message property (SSHClient Struct)

Contains the last commands exit message.

Syntax

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

Default Value

""

Remarks

Use this property to access the exit message of the last command or shell session. This property normally gets assigned if the command or shell was closed due to an error.

This property is read-only.

Data Type

String

exit_signal property (SSHClient Struct)

Contains the last commands exit signal.

Syntax

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

Default Value

""

Remarks

Use this property to access the exit signal of the last command or shell session. This property normally gets assigned if the command or shell was closed due to an error.

This property is read-only.

Data Type

String

exit_status property (SSHClient Struct)

Contains the last commands exit status.

Syntax

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

Default Value

0

Remarks

Check this property to obtain the exit status (also sometimes referred to as errorlevel) of the last command or shell session.

This property is read-only.

Data Type

i32

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

key_fingerprint_sha1 property (SSHClient Struct)

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

Syntax

fn 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

key_fingerprint_sha256 property (SSHClient Struct)

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

Syntax

fn 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

key_handle property (SSHClient Struct)

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

Syntax

fn key_handle(&self ) -> Result<i64, SecureBlackboxError> 
fn set_key_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

password property (SSHClient Struct)

Specifies user's password on the server.

Syntax

fn password(&self ) -> Result<String, SecureBlackboxError> 
fn set_password(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_password_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Invalid password fires the on_auth_failed event.

Data Type

String

proxy_settings_address property (SSHClient Struct)

The IP address of the proxy server.

Syntax

fn proxy_settings_address(&self ) -> Result<String, SecureBlackboxError> 
fn set_proxy_settings_address(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_proxy_settings_address_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The IP address of the proxy server.

Data Type

String

proxy_settings_authentication property (SSHClient Struct)

The authentication type used by the proxy server.

Syntax

fn proxy_settings_authentication(&self ) -> Result<i32, SecureBlackboxError> 
fn set_proxy_settings_authentication(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // NoAuthentication
1   // Basic
2   // Digest
3   // NTLM

Default Value

0

Remarks

The authentication type used by the proxy server.

Data Type

i32

proxy_settings_password property (SSHClient Struct)

The password to authenticate to the proxy server.

Syntax

fn proxy_settings_password(&self ) -> Result<String, SecureBlackboxError> 
fn set_proxy_settings_password(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_proxy_settings_password_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The password to authenticate to the proxy server.

Data Type

String

proxy_settings_port property (SSHClient Struct)

The port on the proxy server to connect to.

Syntax

fn proxy_settings_port(&self ) -> Result<i32, SecureBlackboxError> 
fn set_proxy_settings_port(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

The port on the proxy server to connect to.

Data Type

i32

proxy_settings_proxy_type property (SSHClient Struct)

The type of the proxy server.

Syntax

fn proxy_settings_proxy_type(&self ) -> Result<i32, SecureBlackboxError> 
fn set_proxy_settings_proxy_type(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // None
1   // Socks4
2   // Socks5
3   // WebTunnel
4   // HTTP

Default Value

0

Remarks

The type of the proxy server.

Data Type

i32

proxy_settings_request_headers property (SSHClient Struct)

Contains HTTP request headers for WebTunnel and HTTP proxy.

Syntax

fn proxy_settings_request_headers(&self ) -> Result<String, SecureBlackboxError> 
fn set_proxy_settings_request_headers(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_proxy_settings_request_headers_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Contains HTTP request headers for WebTunnel and HTTP proxy.

Data Type

String

proxy_settings_response_body property (SSHClient Struct)

Contains the HTTP or HTTPS (WebTunnel) proxy response body.

Syntax

fn proxy_settings_response_body(&self ) -> Result<String, SecureBlackboxError> 
fn set_proxy_settings_response_body(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_proxy_settings_response_body_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Contains the HTTP or HTTPS (WebTunnel) proxy response body.

Data Type

String

proxy_settings_response_headers property (SSHClient Struct)

Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.

Syntax

fn proxy_settings_response_headers(&self ) -> Result<String, SecureBlackboxError> 
fn set_proxy_settings_response_headers(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_proxy_settings_response_headers_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.

Data Type

String

proxy_settings_use_ipv6 property (SSHClient Struct)

Specifies whether IPv6 should be used when connecting through the proxy.

Syntax

fn proxy_settings_use_ipv6(&self ) -> Result<bool, SecureBlackboxError> 
fn set_proxy_settings_use_ipv6(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

Specifies whether IPv6 should be used when connecting through the proxy.

Data Type

bool

proxy_settings_username property (SSHClient Struct)

Specifies the username credential for proxy authentication.

Syntax

fn proxy_settings_username(&self ) -> Result<String, SecureBlackboxError> 
fn set_proxy_settings_username(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_proxy_settings_username_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Specifies the username credential for proxy authentication.

Data Type

String

server_key_algorithm property (SSHClient Struct)

Specifies the key algorithm.

Syntax

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

This property is read-only.

Data Type

String

server_key_bits property (SSHClient Struct)

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

Syntax

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

Default Value

0

Remarks

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

This property is read-only.

Data Type

i32

server_key_comment property (SSHClient Struct)

The comment for the public key.

Syntax

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

Default Value

""

Remarks

The comment for the public key.

This property is read-only.

Data Type

String

server_key_curve property (SSHClient Struct)

Specifies the elliptical curve when EC cryptography is used.

Syntax

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

Default Value

""

Remarks

Specifies the elliptical curve when EC cryptography is used.

The following curves are currently supported:

• NISTP256
• NISTP384
• NISTP521
• NISTK163
• NISTP192
• NISTP224
• NISTK233
• NISTB233
• NISTK283
• NISTK409
• NISTB409
• NISTK571
• CURVE25519 (EdDSA curve)
• CURVE448 (EdDSA curve)

This property is read-only.

Data Type

String

server_key_extractable property (SSHClient Struct)

Whether the key is extractable (e.

Syntax

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

Default Value

false

Remarks

Whether the key is extractable (e.g., from a security token), or not.

This property is read-only.

Data Type

bool

server_key_fingerprint_md5 property (SSHClient Struct)

Contains the MD5 fingerprint (hash) of the key.

Syntax

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

Default Value

""

Remarks

Contains the MD5 fingerprint (hash) of the key.

This property is read-only.

Data Type

String

server_key_fingerprint_sha1 property (SSHClient Struct)

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

Syntax

fn server_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

server_key_fingerprint_sha256 property (SSHClient Struct)

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

Syntax

fn server_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

server_key_handle property (SSHClient Struct)

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

Syntax

fn server_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

server_key_key_format property (SSHClient Struct)

Specifies the format in which the key is stored.

Syntax

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

Possible Values

0   // OpenSSH
1   // OpenSSH2
2   // IETF
3   // PuTTY
4   // X509
5   // Binary
6   // SSH1
7   // PGP
8   // PKCS8
9   // PuTTY3
10   // OpenSSHCert

Default Value

0

Remarks

Specifies the format in which the key is stored.

This property is read-only.

Data Type

i32

server_key_key_protection_algorithm property (SSHClient Struct)

Specifies the key protection algorithm.

Syntax

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

Default Value

""

Remarks

Specifies the key protection algorithm.

This property is read-only.

Data Type

String

server_key_private property (SSHClient Struct)

Whether this key is a private key or not.

Syntax

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

Default Value

false

Remarks

Whether this key is a private key or not.

This property is read-only.

Data Type

bool

server_key_public property (SSHClient Struct)

Whether this key is a public key or not.

Syntax

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

Default Value

false

Remarks

Whether this key is a public key or not.

This property is read-only.

Data Type

bool

server_key_subject property (SSHClient Struct)

Specifies the public key owner (subject).

Syntax

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

Default Value

""

Remarks

Specifies the public key owner (subject). This property is used only for IETF-keys.

This property is read-only.

Data Type

String

socket_dns_mode property (SSHClient Struct)

Selects the DNS resolver to use: the struct's (secure) built-in one, or the one provided by the system.

Syntax

fn socket_dns_mode(&self ) -> Result<i32, SecureBlackboxError> 
fn set_socket_dns_mode(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // Auto
1   // Platform
2   // Own
3   // OwnSecure

Default Value

0

Remarks

Selects the DNS resolver to use: the component's (secure) built-in one, or the one provided by the system.

Data Type

i32

socket_dns_port property (SSHClient Struct)

Specifies the port number to be used for sending queries to the DNS server.

Syntax

fn socket_dns_port(&self ) -> Result<i32, SecureBlackboxError> 
fn set_socket_dns_port(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

Specifies the port number to be used for sending queries to the DNS server.

Data Type

i32

socket_dns_query_timeout property (SSHClient Struct)

The timeout (in milliseconds) for each DNS query.

Syntax

fn socket_dns_query_timeout(&self ) -> Result<i32, SecureBlackboxError> 
fn set_socket_dns_query_timeout(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

The timeout (in milliseconds) for each DNS query. The value of 0 indicates an infinite timeout.

Data Type

i32

socket_dns_servers property (SSHClient Struct)

The addresses of DNS servers to use for address resolution, separated by commas or semicolons.

Syntax

fn socket_dns_servers(&self ) -> Result<String, SecureBlackboxError> 
fn set_socket_dns_servers(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_socket_dns_servers_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The addresses of DNS servers to use for address resolution, separated by commas or semicolons.

Data Type

String

socket_dns_total_timeout property (SSHClient Struct)

The timeout (in milliseconds) for the whole resolution process.

Syntax

fn socket_dns_total_timeout(&self ) -> Result<i32, SecureBlackboxError> 
fn set_socket_dns_total_timeout(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

The timeout (in milliseconds) for the whole resolution process. The value of 0 indicates an infinite timeout.

Data Type

i32

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

subsystem property (SSHClient Struct)

Specifies the subsystem to request from the server.

Syntax

fn subsystem(&self ) -> Result<String, SecureBlackboxError> 
fn set_subsystem(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_subsystem_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Subsystem is a special form of an SSH channel. It is typically used to transfer third-party protocol data, with SFTP being the most widely known.

You can tell struct to set up a subsystem connection (rather than a shell or command) by assigning the subsystem name to this property.

Data Type

String

terminal_cols property (SSHClient Struct)

Specifies the width of the pseudoterminal, in characters.

Syntax

fn terminal_cols(&self ) -> Result<i32, SecureBlackboxError> 
fn set_terminal_cols(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

80

Remarks

Specifies the width of the pseudoterminal, in characters.

Data Type

i32

terminal_environment property (SSHClient Struct)

Specifies the list of environment variables.

Syntax

fn terminal_environment(&self ) -> Result<String, SecureBlackboxError> 
fn set_terminal_environment(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_terminal_environment_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Specifies the list of environment variables.

Data Type

String

terminal_eol_char property (SSHClient Struct)

Specifies the End-of-Line character or sequence.

Syntax

fn terminal_eol_char(&self ) -> Result<Vec<u8>, SecureBlackboxError> 
fn set_terminal_eol_char(&self, value : Vec<u8>) ->  Option<SecureBlackboxError> 
fn set_terminal_eol_char_ref(&self, value : &[u8]) ->  Option<SecureBlackboxError> 

Remarks

Specifies the End-of-Line character or sequence.

Data Type

Vec

terminal_height property (SSHClient Struct)

Specifies the height of the pseudoterminal, in pixels.

Syntax

fn terminal_height(&self ) -> Result<i32, SecureBlackboxError> 
fn set_terminal_height(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

Specifies the height of the pseudoterminal, in pixels.

Data Type

i32

terminal_opcodes property (SSHClient Struct)

Specifies the operation codes specific for the terminal.

Syntax

fn terminal_opcodes(&self ) -> Result<String, SecureBlackboxError> 
fn set_terminal_opcodes(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_terminal_opcodes_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Specifies the operation codes specific for the terminal.

Data Type

String

terminal_protocol property (SSHClient Struct)

The terminal protocol name.

Syntax

fn terminal_protocol(&self ) -> Result<String, SecureBlackboxError> 
fn set_terminal_protocol(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_terminal_protocol_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

"vt100"

Remarks

The terminal protocol name.

Data Type

String

terminal_request_pty property (SSHClient Struct)

Specifies whether to request a pseudoterminal for the session.

Syntax

fn terminal_request_pty(&self ) -> Result<bool, SecureBlackboxError> 
fn set_terminal_request_pty(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

true

Remarks

Specifies whether to request a pseudoterminal for the session.

Data Type

bool

terminal_rows property (SSHClient Struct)

Specifies the height of the pseudoterminal, in lines.

Syntax

fn terminal_rows(&self ) -> Result<i32, SecureBlackboxError> 
fn set_terminal_rows(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

25

Remarks

Specifies the height of the pseudoterminal, in lines.

Data Type

i32

terminal_width property (SSHClient Struct)

Specifies the width of the pseudoterminal, in pixels.

Syntax

fn terminal_width(&self ) -> Result<i32, SecureBlackboxError> 
fn set_terminal_width(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

Specifies the width of the pseudoterminal, in pixels.

Data Type

i32

trusted_keys_file property (SSHClient Struct)

Path to the file containing public keys of authorized servers.

Syntax

fn trusted_keys_file(&self ) -> Result<String, SecureBlackboxError> 
fn set_trusted_keys_file(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_trusted_keys_file_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Path to the file containing public keys of authorized servers.

Data Type

String

username property (SSHClient Struct)

Specifies client's username on the server.

Syntax

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

Default Value

""

Remarks

Client's password is set by password property. ;

Data Type

String

config method (SSHClient 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.

connect method (SSHClient Struct)

Establishes connection to an SSH server.

Syntax

fn connect(&self, address : &str, port : i32) -> Result<(), SecureBlackboxError>

Remarks

Use this method to connect to the SSH server by providing its Address and Port.

Before connecting to the server you might want to set up your credentials using username and password properties. You might also need to configure the server key validation routine. You can do this by subscribing to on_known_key_received and on_unknown_key_received events and implementing the event handlers as required.

Adjust async_mode before connecting to switch the component to either synchronous or asynchronous mode. In synchronous mode, all the calls to the component, such as connect or send_bytes, are executed within the context of the caller thread, and block until the action completes. In asynchronous mode, the component runs the SSH session in a background thread, which makes all such calls return immediately. Find out more about the modes in the async_mode topic.

connect_and_exec method (SSHClient Struct)

Connects to an SSH server and executes a command in one go.

Syntax

fn connect_and_exec(&self, address : &str, port : i32, command : &str, want_stdout : bool, want_std_err : bool) ->  Result<Vec<u8>, SecureBlackboxError>

Remarks

Use this method to connect to an SSH server at Address and Port and execute a command. The method returns the output of the executed command.

This method is a handy shortcut for running non-interactive commands. It encapsulates calls to connect, receive, disconnect internally to save you time and space.

Please note that connect_and_exec always runs synchronously, thus ignoring the async_mode setting.

disconnect method (SSHClient Struct)

Closes connection to the SSH server.

Syntax

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

Remarks

Call this method to terminate the active SSH connection.

Please note that in some cases the component may still have some inbound data cached internally even after the connection is closed. You can read that data out using receive and/or receive_bytes methods.

do_action method (SSHClient 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:

ping method (SSHClient Struct)

Sends a keep-alive request to the SSH server.

Syntax

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

Remarks

Use this method to send a keep-alive message to the SSH server. Keep-alive messages are empty data packets which carry no useful information but are a handy way of checking if the connection is still alive.

poll method (SSHClient Struct)

Checks whether there is any inbound data readily available.

Syntax

fn poll(&self, milliseconds : i32) ->  Result<bool, SecureBlackboxError>

Remarks

Use this method to check whether there is any incoming data available in the connection. If this method returns true, you can read the data with receive or receive_bytes calls.

Use the Milliseconds parameter to tell the component how long it can wait for the data to arrive.

receive method (SSHClient Struct)

Reads a portion of received data into a string.

Syntax

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

Remarks

Use this method to read out a piece of data received from the server into a string.

Note that in synchronous mode this method may block in the absence of any inbound data until the next piece of data is received from the server. Use poll to check if there is any data in the connection that is immediately available for reading.

In asynchronous mode a good time to call this method is upon receiving a read notification in on_data_received event handler. When working in asynchronous mode, this call returns immediately.

This method only returns data that arrives via the stdout channel. Use receive_from to read stderr data.

receive_bytes method (SSHClient Struct)

Reads a portion of received data into a byte array.

Syntax

fn receive_bytes(&self, max_len : i32) ->  Result<Vec<u8>, SecureBlackboxError>

Remarks

Use this method to read out a piece of data received from the server into a byte array. Control the maximum length of the data chunk with the MaxLen parameter.

Note that in synchronous mode this method may block in the absence of any inbound data until the next piece of data is received from the server. Use poll to check if there is any data in the connection that is immediately available for reading.

In asynchronous mode a good time to call this method is upon receiving a read notification in on_data_received event handler. When working in asynchronous mode, this call returns immediately.

This method only returns data that arrives via the stdout channel. Use receive_bytes_from to read stderr data.

receive_bytes_from method (SSHClient Struct)

Reads a portion of data received via a specific channel into a byte array.

Syntax

fn receive_bytes_from(&self, channel : i32, max_len : i32) ->  Result<Vec<u8>, SecureBlackboxError>

Remarks

Use this method to read out a piece of data received from the server into a byte array. Specify the channel that you are interested in reading from (0 for stdout, 1 for stderr) via the Channel parameter, and control the maximum length of the data chunk with the MaxLen parameter.

Note that in synchronous mode this method may block in the absence of any inbound data until the next piece of data is received from the server. Use poll to check if there is any data in the connection that is immediately available for reading.

In asynchronous mode a good time to call this method is upon receiving a read notification in on_data_received event handler. When working in asynchronous mode, this call returns immediately.

Please also note that stdout and stderr channels are fully independent, which implies that data arriving via each channel should be read out separately.

receive_from method (SSHClient Struct)

Reads a portion of data received via a specific channel into a string.

Syntax

fn receive_from(&self, channel : i32) ->  Result<String, SecureBlackboxError>

Remarks

Use this method to read out a piece of data received from the server into a string. Use the Channel parameter to specify the channel that you would like to read from (0 for stdout, 1 for stderr).

Note that in synchronous mode this method may block in the absence of any inbound data until the next piece of data is received from the server. Use poll to check if there is any data in the connection that is immediately available for reading.

In asynchronous mode a good time to call this method is upon receiving a read notification in on_data_received event handler. When working in asynchronous mode, this call returns immediately.

reset method (SSHClient Struct)

Resets the struct settings.

Syntax

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

Remarks

reset is a generic method available in every struct.

send method (SSHClient Struct)

Sends a string to the server.

Syntax

fn send(&self, data_str : &str, add_eol : bool) -> Result<(), SecureBlackboxError>

Remarks

Use this method to send DataStr to the remote command's stdin channel. Set the AddEOL parameter to true to append the end-of-line character to the string automatically.

Note that in synchronous mode this method may block until the whole string is committed to the network connection. In asynchronous mode this method returns immediately; the application is eventually notified that the data has been sent via the on_data_sent event.

send_bytes method (SSHClient Struct)

Sends an array of bytes to the server.

Syntax

fn send_bytes(&self, data : &[u8]) -> Result<(), SecureBlackboxError>

Remarks

Use this method to send Data to the remote command's stdin channel.

Note that in synchronous mode this method may block until the whole byte array is committed to the network connection. In asynchronous mode this method returns immediately; the application is eventually notified that the data has been sent via the on_data_sent event.

send_special method (SSHClient Struct)

Sends a special character to the server or remote command.

Syntax

fn send_special(&self, special_char : &str) -> Result<(), SecureBlackboxError>

Remarks

Use this method to send a special or control character to the SSH server or the command being executed. Specify the character id via the SpecialChar parameter.

Currently the only supported special character is "eof", which is sometimes used as a way to close the stdin channel gracefully.

on_auth_attempt event (SSHClient Struct)

Fires when a single authentication attempt is performed.

Syntax

// SSHClientAuthAttemptEventArgs carries the SSHClient AuthAttempt event's parameters.
pub struct SSHClientAuthAttemptEventArgs {
  fn auth_type(&self) -> i32
}

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

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

Remarks

This event is fired each time a single authentication attempt is performed. AuthType parameter specifies the type of authentication. Note, this event could be fired more than once if the client tries different authentication methods one after another.

on_auth_failed event (SSHClient Struct)

Fires when a single authentication attempt is failed.

Syntax

// SSHClientAuthFailedEventArgs carries the SSHClient AuthFailed event's parameters.
pub struct SSHClientAuthFailedEventArgs {
  fn authentication_type(&self) -> i32
}

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

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

Remarks

This event is fired each time a single authentication attempt fails. AuthType parameter specifies the type of authentication.

As SSH may try a number of authentication attempts of different types or with different parameters (such as public keys) during one session, this event may be fired more than once. It is not critical and may not lead to closing of the connection.

on_auth_succeeded event (SSHClient Struct)

Reports a successful authentication.

Syntax

// SSHClientAuthSucceededEventArgs carries the SSHClient AuthSucceeded event's parameters.
pub struct SSHClientAuthSucceededEventArgs {
}

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

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

Remarks

This event may be preceded by some on_auth_failed events if the client tries different authentication methods one after another.

on_banner event (SSHClient Struct)

Reports the receipt of the Hello message from the server.

Syntax

// SSHClientBannerEventArgs carries the SSHClient Banner event's parameters.
pub struct SSHClientBannerEventArgs {
  fn text(&self) -> &[u8]
  fn language(&self) -> &[u8]
}

// SSHClientBannerEvent defines the signature of the SSHClient Banner event's handler function.
pub trait SSHClientBannerEvent {
  fn on_banner(&self, sender : SSHClient, e : &mut SSHClientBannerEventArgs);
}

impl <'a> SSHClient<'a> {
  pub fn on_banner(&self) -> &'a dyn SSHClientBannerEvent;
  pub fn set_on_banner(&mut self, value : &'a dyn SSHClientBannerEvent);
  ...
}

Remarks

SFTPClient fires this event when it receives hello message from the server.

on_command_completed event (SSHClient Struct)

Signifies completion of the command execution.

Syntax

// SSHClientCommandCompletedEventArgs carries the SSHClient CommandCompleted event's parameters.
pub struct SSHClientCommandCompletedEventArgs {
  fn command(&self) -> &String
  fn exit_status(&self) -> i32
  fn exit_message(&self) -> &String
  fn exit_signal(&self) -> &String
}

// SSHClientCommandCompletedEvent defines the signature of the SSHClient CommandCompleted event's handler function.
pub trait SSHClientCommandCompletedEvent {
  fn on_command_completed(&self, sender : SSHClient, e : &mut SSHClientCommandCompletedEventArgs);
}

impl <'a> SSHClient<'a> {
  pub fn on_command_completed(&self) -> &'a dyn SSHClientCommandCompletedEvent;
  pub fn set_on_command_completed(&mut self, value : &'a dyn SSHClientCommandCompletedEvent);
  ...
}

Remarks

Subscribe to this event to be notified about completion of the remote command execution. This event fires for every command in the commands list. The Command parameter indicates the command being completed.

ExitStatus specifies the command's return code. ExitMessage or ExitSignal parameters provide error details if the command execution was terminated forcefully,

on_command_start event (SSHClient Struct)

Marks the commencement of a command execution.

Syntax

// SSHClientCommandStartEventArgs carries the SSHClient CommandStart event's parameters.
pub struct SSHClientCommandStartEventArgs {
  fn command(&self) -> &String
}

// SSHClientCommandStartEvent defines the signature of the SSHClient CommandStart event's handler function.
pub trait SSHClientCommandStartEvent {
  fn on_command_start(&self, sender : SSHClient, e : &mut SSHClientCommandStartEventArgs);
}

impl <'a> SSHClient<'a> {
  pub fn on_command_start(&self) -> &'a dyn SSHClientCommandStartEvent;
  pub fn set_on_command_start(&mut self, value : &'a dyn SSHClientCommandStartEvent);
  ...
}

Remarks

Subscribe to this event to be notified about the start of execution of a remote command. The Command parameter indicates the command being started.

This event is fired for all commands in the commands list, in order. The completion of the command is reported via the on_command_completed event.

on_connect event (SSHClient Struct)

This event is fired when an SSH session has been established.

Syntax

// SSHClientConnectEventArgs carries the SSHClient Connect event's parameters.
pub struct SSHClientConnectEventArgs {
}

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

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

Remarks

Use this event to track the moment when SSH session has been set up.

on_data_received event (SSHClient Struct)

Reports receipt of another chunk of data from the server.

Syntax

// SSHClientDataReceivedEventArgs carries the SSHClient DataReceived event's parameters.
pub struct SSHClientDataReceivedEventArgs {
  fn channel(&self) -> i32
  fn bytes_received(&self) -> i32
  fn total_bytes_pending(&self) -> i32
}

// SSHClientDataReceivedEvent defines the signature of the SSHClient DataReceived event's handler function.
pub trait SSHClientDataReceivedEvent {
  fn on_data_received(&self, sender : SSHClient, e : &mut SSHClientDataReceivedEventArgs);
}

impl <'a> SSHClient<'a> {
  pub fn on_data_received(&self) -> &'a dyn SSHClientDataReceivedEvent;
  pub fn set_on_data_received(&mut self, value : &'a dyn SSHClientDataReceivedEvent);
  ...
}

Remarks

This event fires in asynchronous mode to report the receipt of another chunk of data from the server. Use receive or receive_bytes methods to read out the received data.

The Channel parameter indicates the channel on which the data was received: stdout (0) or stderr (1). BytesReceived specify the size of the newly received chunk, and TotalBytesPending contain the total number of bytes available for reading.

Please note that just like other asynchronous mode events this event may fire from a secondary thread. Please make sure your code is prepared for that by using appropriate synchronization facilities.

This event does not fire in synchronous mode.

on_data_sent event (SSHClient Struct)

Notifies the application that a piece of data has been sent to the server.

Syntax

// SSHClientDataSentEventArgs carries the SSHClient DataSent event's parameters.
pub struct SSHClientDataSentEventArgs {
  fn bytes_sent(&self) -> i32
  fn bytes_pending(&self) -> i32
}

// SSHClientDataSentEvent defines the signature of the SSHClient DataSent event's handler function.
pub trait SSHClientDataSentEvent {
  fn on_data_sent(&self, sender : SSHClient, e : &mut SSHClientDataSentEventArgs);
}

impl <'a> SSHClient<'a> {
  pub fn on_data_sent(&self) -> &'a dyn SSHClientDataSentEvent;
  pub fn set_on_data_sent(&mut self, value : &'a dyn SSHClientDataSentEvent);
  ...
}

Remarks

Subscribe to this event to be notified about the outbound data flow. This event fires following a call to send or send_bytes methods to notify the application that the data provided has been sent to the server. This event may fire more than once for each send or send_bytes call, subject to the volume of data being sent and the settings of the server.

The BytesSent parameter specifies the number of bytes that has just been sent to the server. The BytesPending indicate the number of bytes that remain cached in the internal buffer. Any bytes cached in such way will be sent again on the next available opportunity and reported via a separate on_data_sent event invocation.

Please note that just like other asynchronous mode events this event may fire from a secondary thread. Please make sure your code is prepared for that by using appropriate synchronization facilities.

This event does not fire in synchronous mode.

on_disconnect event (SSHClient Struct)

This event is fired when the SFTP subsystem connection is closed.

Syntax

// SSHClientDisconnectEventArgs carries the SSHClient Disconnect event's parameters.
pub struct SSHClientDisconnectEventArgs {
  fn close_reason(&self) -> i32
}

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

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

Remarks

Do not perform any file operations after this event has been fired.

on_error event (SSHClient Struct)

Information about errors during SFTP connection.

Syntax

// SSHClientErrorEventArgs carries the SSHClient Error event's parameters.
pub struct SSHClientErrorEventArgs {
  fn error_code(&self) -> i32
  fn description(&self) -> &String
}

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

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

Remarks

The event is fired in case of exceptional conditions during data transfer.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of error codes please refer to SFTP.

on_external_sign event (SSHClient Struct)

Handles remote or external signing initiated by the SignExternal method or other source.

Syntax

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

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

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

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_known_key_received event (SSHClient Struct)

Signals that the server has introduced itself with a known key.

Syntax

// SSHClientKnownKeyReceivedEventArgs carries the SSHClient KnownKeyReceived event's parameters.
pub struct SSHClientKnownKeyReceivedEventArgs {
  fn algorithm(&self) -> &String
  fn bits(&self) -> i32
  fn fingerprint_sha256(&self) -> &String
}

// SSHClientKnownKeyReceivedEvent defines the signature of the SSHClient KnownKeyReceived event's handler function.
pub trait SSHClientKnownKeyReceivedEvent {
  fn on_known_key_received(&self, sender : SSHClient, e : &mut SSHClientKnownKeyReceivedEventArgs);
}

impl <'a> SSHClient<'a> {
  pub fn on_known_key_received(&self) -> &'a dyn SSHClientKnownKeyReceivedEvent;
  pub fn set_on_known_key_received(&mut self, value : &'a dyn SSHClientKnownKeyReceivedEvent);
  ...
}

Remarks

The struct fires this event to tell the application that the server has introduced itself with a known key from trusted_keys_file.

The details of the key are provided: Algorithm and Bits specify the key algorithm and the number of bits. FingerprintSHA256 contains the key's fingerprint.

Use server_key to access more key details.

on_notification event (SSHClient Struct)

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

Syntax

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

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

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

Remarks

The struct fires this event to let the application know about some event, occurrence, or milestone in the struct. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

The unique identifier of the event is provided in the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the struct, the exact action it is performing, or the document being processed, one or both may be omitted.

on_password_change_request event (SSHClient Struct)

This event is fired when a password change is requested.

Syntax

// SSHClientPasswordChangeRequestEventArgs carries the SSHClient PasswordChangeRequest event's parameters.
pub struct SSHClientPasswordChangeRequestEventArgs {
  fn prompt(&self) -> &String
  fn new_password(&self) -> &String
  fn set_new_password(&self, value : &str)
  fn set_new_password_ref(&self, value : &String)
  fn cancel(&self) -> bool
  fn set_cancel(&self, value : bool)
}

// SSHClientPasswordChangeRequestEvent defines the signature of the SSHClient PasswordChangeRequest event's handler function.
pub trait SSHClientPasswordChangeRequestEvent {
  fn on_password_change_request(&self, sender : SSHClient, e : &mut SSHClientPasswordChangeRequestEventArgs);
}

impl <'a> SSHClient<'a> {
  pub fn on_password_change_request(&self) -> &'a dyn SSHClientPasswordChangeRequestEvent;
  pub fn set_on_password_change_request(&mut self, value : &'a dyn SSHClientPasswordChangeRequestEvent);
  ...
}

Remarks

This event is fired by the struct when a password change is requested by the server. Prompt contains the password prompt message. Handler should either provide the new password via NewPassword, or deny the request by setting Cancel to true.

on_private_key_needed event (SSHClient Struct)

This event is fired when client's public key was accepted by the server, but the corresponding secret key is not available.

Syntax

// SSHClientPrivateKeyNeededEventArgs carries the SSHClient PrivateKeyNeeded event's parameters.
pub struct SSHClientPrivateKeyNeededEventArgs {
  fn skip(&self) -> bool
  fn set_skip(&self, value : bool)
}

// SSHClientPrivateKeyNeededEvent defines the signature of the SSHClient PrivateKeyNeeded event's handler function.
pub trait SSHClientPrivateKeyNeededEvent {
  fn on_private_key_needed(&self, sender : SSHClient, e : &mut SSHClientPrivateKeyNeededEventArgs);
}

impl <'a> SSHClient<'a> {
  pub fn on_private_key_needed(&self) -> &'a dyn SSHClientPrivateKeyNeededEvent;
  pub fn set_on_private_key_needed(&mut self, value : &'a dyn SSHClientPrivateKeyNeededEvent);
  ...
}

Remarks

Set Skip to true when it is not possible to load the missing key for some reason.

on_unknown_key_received event (SSHClient Struct)

Signals that the server has introduced itself with an unknown key.

Syntax

// SSHClientUnknownKeyReceivedEventArgs carries the SSHClient UnknownKeyReceived event's parameters.
pub struct SSHClientUnknownKeyReceivedEventArgs {
  fn algorithm(&self) -> &String
  fn bits(&self) -> i32
  fn fingerprint_sha256(&self) -> &String
  fn action(&self) -> i32
  fn set_action(&self, value : i32)
}

// SSHClientUnknownKeyReceivedEvent defines the signature of the SSHClient UnknownKeyReceived event's handler function.
pub trait SSHClientUnknownKeyReceivedEvent {
  fn on_unknown_key_received(&self, sender : SSHClient, e : &mut SSHClientUnknownKeyReceivedEventArgs);
}

impl <'a> SSHClient<'a> {
  pub fn on_unknown_key_received(&self) -> &'a dyn SSHClientUnknownKeyReceivedEvent;
  pub fn set_on_unknown_key_received(&mut self, value : &'a dyn SSHClientUnknownKeyReceivedEvent);
  ...
}

Remarks

The struct fires this event to tell the application that the server has introduced itself with a key not present in trusted_keys_file.

The details of the key are provided: Algorithm and Bits specify the key algorithm and the number of bits. FingerprintSHA256 contains the key's fingerprint.

In this event handler, you need to make a decision whether to proceed with the connection. Use Action to tell the struct what it should do with the key:

Note that accepting an unknown and unchecked key may be risky.

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

SSHClient Config Settings

Base Config Settings

Trappable Errors (SSHClient Struct)