Struct ipworksssh::SSHServer

Properties   Methods   Events   Config Settings   Errors  

The SSHServer struct is used to create Secure Shell (SSH) servers. The struct handles multiple simultaneous connections on the same Transmission Control Protocol (TCP)/IP port (service port). It is designed to balance the load between connections for a fast, powerful server.

Syntax

ipworksssh::SSHServer

Remarks

The SSHServer struct is the Secure Shell (SSH)-enabled equivalent of the IPWorks TCPServer struct, extended by a set of new properties and events that deal with SSH security. The ssh_compression_algorithms and ssh_encryption_algorithms properties determine which protocols are enabled for the SSH handshake. The ssh_cert* properties are used to select a certificate for the server (note that a valid certificate must be selected before the server can function). The on_ssh_user_auth_request event will allow you to use authenticate clients using digital certificates or passwords. Finally, the on_ssh_status event provides information about the SSH handshake and underlying protocol notifications.

By default, each instance of SSHServer can handle up to 1000 simultaneous incoming connections (this number may be increased up to 100,000, or decreased to a lower value by using the MaxConnections configuration setting).

SSH connections are identified by a ConnectionId. Events relating to these connections as a whole will use the ConnectionId to identify the specific connection. Connections may also contain one or more multiplexed channels, which are identified by a ChannelId. Channel-level events will specify the ChannelId to which they relate.

SSHServer can start to listen on a port by setting the listening property to True. When a remote host asks for a connection, the on_connection_request event is fired. At that point, the connection can either be accepted or rejected. If the connection is accepted, a ConnectionId is assigned, and communication can start. From this point on, the operation is similar to SSHClient. Data can be sent to an individual SSHChannel using send_channel_data. The address and port of the incoming connection can be found by querying the client_remote_host and client_remote_port properties.

NOTE: Server components are designed to process events as they occur. To ensure that events are processed in a timely manner, do_events should be called in a loop after the server is started.

Object Lifetime

The new() method returns a mutable reference to a struct instance. The object itself is kept in the global list maintained by IPWorksSSH. Due to this, the SSHServer struct cannot be disposed of automatically. Please, call the dispose(&mut self) method of SSHServer 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.

ssh_channel_count property (SSHServer Struct)

The number of records in the arrays.

Syntax

fn ssh_channel_count(&self ) -> Result<i32, IPWorksSSHError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• bytes_sent
• channel_eol
• channel_id
• keyboard_interactive_prompt_echo
• keyboard_interactive_prompt_prompt
• max_channel_length
• ready_to_send
• record_length
• service
• ssh_cert_effective_date
• ssh_cert_encoded
• ssh_cert_expiration_date
• ssh_cert_extended_key_usage
• ssh_cert_fingerprint
• ssh_cert_fingerprint_sha1
• ssh_cert_fingerprint_sha256
• ssh_cert_issuer
• ssh_cert_private_key
• ssh_cert_private_key_available
• ssh_cert_private_key_container
• ssh_cert_public_key
• ssh_cert_public_key_algorithm
• ssh_cert_public_key_length
• ssh_cert_serial_number
• ssh_cert_signature_algorithm
• ssh_cert_store
• ssh_cert_store_password
• ssh_cert_store_type
• ssh_cert_subject
• ssh_cert_subject_alt_names
• ssh_cert_thumbprint_md5
• ssh_cert_thumbprint_sha1
• ssh_cert_thumbprint_sha256
• ssh_cert_usage
• ssh_cert_usage_flags
• ssh_cert_version
• ssh_connection_connected
• ssh_connection_local_address
• ssh_connection_remote_host
• ssh_connection_remote_port
• ssh_connection_timeout

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

This property is read-only.

Data Type

i32

bytes_sent property (SSHServer Struct)

This property specifies the number of bytes actually sent after a sending channel data.

Syntax

fn bytes_sent(&self , SSHChannelId : i32) -> Result<i32, IPWorksSSHError> 

Default Value

0

Remarks

This property specifies the number of bytes actually sent after a sending channel data.

The SSHChannelId parameter specifies the index of the item in the array. The size of the array is controlled by the SSHChannelCount property.

This property is read-only.

Data Type

i32

channel_eol property (SSHServer Struct)

Breaks the incoming data stream into chunks separated by EOL .

Syntax

fn channel_eol(&self , SSHChannelId : i32) -> Result<String, IPWorksSSHError> 
fn set_channel_eol(&self, SSHChannelId : i32, value : &str) ->  Option<IPWorksSSHError> 
fn set_channel_eol_ref(&self, SSHChannelId : i32, value : &String) ->  Option<IPWorksSSHError> 

Default Value

""

Remarks

Breaks the incoming data stream into chunks separated by EOL.

This property is a binary string. Notably, this means that it can be more than one byte long, and it can contain NULL bytes.

channel_eol and max_channel_length must be set together or unexpected behavior could occur.

The SSHChannelId parameter specifies the index of the item in the array. The size of the array is controlled by the SSHChannelCount property.

Data Type

String

channel_id property (SSHServer Struct)

This property provides an Id generated by the struct to identify the current Secure Shell (SSH) channel.

Syntax

fn channel_id(&self , SSHChannelId : i32) -> Result<String, IPWorksSSHError> 

Default Value

""

Remarks

This property provides an Id generated by the struct to identify the current Secure Shell (SSH) channel.

This Id is unique to this channel.

The SSHChannelId parameter specifies the index of the item in the array. The size of the array is controlled by the SSHChannelCount property.

This property is read-only.

Data Type

String

max_channel_length property (SSHServer Struct)

This property specifies the maximum amount of data to accumulate when no EOL is found.

Syntax

fn max_channel_length(&self , SSHChannelId : i32) -> Result<i32, IPWorksSSHError> 
fn set_max_channel_length(&self, SSHChannelId : i32, value : i32) ->  Option<IPWorksSSHError> 

Default Value

0

Remarks

This property specifies the maximum amount of data to accumulate when no EOL is found.

max_channel_length is the size of an internal buffer, which holds received data while waiting for a channel_eol string.

If the channel_eol string is found in the input stream before MaxChannelLength bytes are received, the on_ssh_channel_data event is fired with the ChannelDataEOLFound parameter set to True, and the buffer is reset.

If no channel_eol is found, and max_channel_length bytes are accumulated in the buffer, the on_ssh_channel_data event is fired with the ChannelDataEOLFound parameter set to False, and the buffer is reset.

channel_eol and max_channel_length must be set together or unexpected behavior could occur.

The SSHChannelId parameter specifies the index of the item in the array. The size of the array is controlled by the SSHChannelCount property.

Data Type

i32

ready_to_send property (SSHServer Struct)

This property is True when data can be sent over the Secure Shell (SSH) channel.

Syntax

fn ready_to_send(&self , SSHChannelId : i32) -> Result<bool, IPWorksSSHError> 

Default Value

false

Remarks

This property is True when data can be sent over the Secure Shell (SSH) channel.

When timeout is set to 0 (asynchronous) sending data may result in an error if the channel or underlying socket cannot accept more data to send. Monitor on_ssh_channel_ready_to_send or ready_to_send to determine when data can be sent again.

When timeout is set to a positive value, the struct will block when sending data until the data can be successfully sent and on_ssh_channel_ready_to_send and ready_to_send do not need to be monitored.

The SSHChannelId parameter specifies the index of the item in the array. The size of the array is controlled by the SSHChannelCount property.

This property is read-only.

Data Type

bool

record_length property (SSHServer Struct)

This property holds the current record length set by ChangeRecordLength .

Syntax

fn record_length(&self , SSHChannelId : i32) -> Result<i32, IPWorksSSHError> 

Default Value

0

Remarks

This property holds the current record length set by change_record_length. When this value is a positive number, the struct will accumulate data until record_length is reached and only then will it fire the on_ssh_channel_data_in event with the data of length record_length. This allows data to be received as records of known length. This value can be changed at any time by calling change_record_length, including within the on_ssh_channel_data_in event.

A value of 0 (default) means this setting is not used.

The SSHChannelId parameter specifies the index of the item in the array. The size of the array is controlled by the SSHChannelCount property.

This property is read-only.

Data Type

i32

service property (SSHServer Struct)

This property holds the channel type that was requested when opening the channel.

Syntax

fn service(&self , SSHChannelId : i32) -> Result<String, IPWorksSSHError> 

Default Value

""

Remarks

This property holds the channel type that was requested when opening the channel. For instance "session" or "forwarded-tcpip".

The SSHChannelId parameter specifies the index of the item in the array. The size of the array is controlled by the SSHChannelCount property.

This property is read-only.

Data Type

String

connection_backlog property (SSHServer Struct)

This property includes the maximum number of pending connections maintained by the Transmission Control Protocol (TCP)/IP subsystem.

Syntax

fn connection_backlog(&self ) -> Result<i32, IPWorksSSHError> 
fn set_connection_backlog(&self, value : i32) ->  Option<IPWorksSSHError> 

Default Value

5

Remarks

This property contains the maximum number of pending connections maintained by the TCP/IP subsystem. This value reflects the SOMAXCONN option for the main listening socket. The default value for most systems is 5. You may set this property to a larger value if the server is expected to receive a large number of connections, and queuing them is desirable.

Data Type

i32

ssh_connection_count property (SSHServer Struct)

The number of records in the SSHConnection arrays.

Syntax

fn ssh_connection_count(&self ) -> Result<i32, IPWorksSSHError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• ssh_connection_connected
• ssh_connection_local_address
• ssh_connection_remote_host
• ssh_connection_remote_port
• ssh_connection_timeout

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

This property is read-only.

Data Type

i32

ssh_connection_connected property (SSHServer Struct)

This property indicates the status of individual connections.

Syntax

fn ssh_connection_connected(&self , ConnectionId : i32) -> Result<bool, IPWorksSSHError> 

Default Value

false

Remarks

This property indicates the status of individual connections.

When true, the connection is established. Use the disconnect method to disconnect an existing connection.

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the SSHConnectionCount property.

This property is read-only.

Data Type

bool

ssh_connection_local_address property (SSHServer Struct)

This property shows the IP address of the interface through which the connection is passing.

Syntax

fn ssh_connection_local_address(&self , ConnectionId : i32) -> Result<String, IPWorksSSHError> 

Default Value

""

Remarks

This property shows the IP address of the interface through which the connection is passing.

local_address is important for multihomed hosts in cases in which it can be used to identify the particular network interface an individual connection is going through.

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the SSHConnectionCount property.

This property is read-only.

Data Type

String

ssh_connection_remote_host property (SSHServer Struct)

The RemoteHost shows the IP address of the remote host through which the connection is coming.

Syntax

fn ssh_connection_remote_host(&self , ConnectionId : i32) -> Result<String, IPWorksSSHError> 

Default Value

""

Remarks

The remote_host shows the IP address of the remote host through which the connection is coming.

The connection must be valid or an error will be fired.

If the struct is configured to use a SOCKS firewall, the value assigned to this property may be preceded with an "*". If this is the case, the host name is passed to the firewall unresolved and the firewall performs the DNS resolution.

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the SSHConnectionCount property.

This property is read-only.

Data Type

String

ssh_connection_remote_port property (SSHServer Struct)

The RemotePort shows the Transmission Control Protocol (TCP) port on the remote host through which the connection is coming.

Syntax

fn ssh_connection_remote_port(&self , ConnectionId : i32) -> Result<i32, IPWorksSSHError> 

Default Value

0

Remarks

The remote_port shows the Transmission Control Protocol (TCP) port on the remote host through which the connection is coming.

The connection must be valid or an error will be fired.

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the SSHConnectionCount property.

This property is read-only.

Data Type

i32

ssh_connection_timeout property (SSHServer Struct)

This property contains a timeout for the struct.

Syntax

fn ssh_connection_timeout(&self , ConnectionId : i32) -> Result<i32, IPWorksSSHError> 
fn set_ssh_connection_timeout(&self, ConnectionId : i32, value : i32) ->  Option<IPWorksSSHError> 

Default Value

0

Remarks

This property contains a timeout for the struct.

If the timeout property is set to 0, all operations return immediately, potentially failing with an 'WOULDBLOCK' error if data cannot be sent or received immediately.

If timeout is set to a positive value, the struct will automatically retry each operation that otherwise would result in a 'WOULDBLOCK' error for a maximum of timeout seconds.

The struct will use do_events to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.

If timeout expires, and the operation is not yet complete, the struct fails with an error.

NOTE: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by timeout seconds when any amount of data is successfully sent or received.

The default value for the timeout property is 0 (asynchronous operation).

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the SSHConnectionCount property.

Data Type

i32

default_auth_methods property (SSHServer Struct)

The supported authentication methods.

Syntax

fn default_auth_methods(&self ) -> Result<String, IPWorksSSHError> 
fn set_default_auth_methods(&self, value : &str) ->  Option<IPWorksSSHError> 
fn set_default_auth_methods_ref(&self, value : &String) ->  Option<IPWorksSSHError> 

Default Value

"password,publickey"

Remarks

This property specifies the supported authentication methods. The client will choose one of the supported mechanisms when authenticating to the struct.

This must be a comma-separated list of values. For more information on authenticating clients, see the on_ssh_user_auth_request event.

The following is a list of methods implemented by the struct:

Data Type

String

default_idle_timeout property (SSHServer Struct)

This property includes the default idle timeout for inactive clients.

Syntax

fn default_idle_timeout(&self ) -> Result<i32, IPWorksSSHError> 
fn set_default_idle_timeout(&self, value : i32) ->  Option<IPWorksSSHError> 

Default Value

0

Remarks

This property specifies the idle timeout (in seconds) for clients. When set to a positive value, the struct will disconnect idle clients after the specified timeout.

This applies only to clients that have not sent or received data within default_idle_timeout seconds.

If set to 0 (default), no idle timeout is applied.

NOTE: do_events must be called for the struct to check existing connections.

Data Type

i32

default_timeout property (SSHServer Struct)

The initial timeout value to be used by incoming connections.

Syntax

fn default_timeout(&self ) -> Result<i32, IPWorksSSHError> 
fn set_default_timeout(&self, value : i32) ->  Option<IPWorksSSHError> 

Default Value

60

Remarks

This property is used by the struct to set the operational timeout value of all inbound connections once they are established. If the timeout is set to 0, all inbound connections will behave asynchronously. The default value is 60, meaning the struct will behave synchronously.

Data Type

i32

keyboard_interactive_message property (SSHServer Struct)

The instructions to send to the client during keyboard-interactive authentication.

Syntax

fn keyboard_interactive_message(&self ) -> Result<String, IPWorksSSHError> 
fn set_keyboard_interactive_message(&self, value : &str) ->  Option<IPWorksSSHError> 
fn set_keyboard_interactive_message_ref(&self, value : &String) ->  Option<IPWorksSSHError> 

Default Value

""

Remarks

This property should be set to the main instructions to send to the client during keyboard-interactive authentication.

Data Type

String

keyboard_interactive_prompt_count property (SSHServer Struct)

The number of records in the KeyboardInteractivePrompt arrays.

Syntax

fn keyboard_interactive_prompt_count(&self ) -> Result<i32, IPWorksSSHError> 
fn set_keyboard_interactive_prompt_count(&self, value : i32) ->  Option<IPWorksSSHError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• keyboard_interactive_prompt_echo
• keyboard_interactive_prompt_prompt

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

Data Type

i32

keyboard_interactive_prompt_echo property (SSHServer Struct)

This property specifies whether or not the client should echo the value entered by the user.

Syntax

fn keyboard_interactive_prompt_echo(&self , PromptIndex : i32) -> Result<bool, IPWorksSSHError> 
fn set_keyboard_interactive_prompt_echo(&self, PromptIndex : i32, value : bool) ->  Option<IPWorksSSHError> 

Default Value

false

Remarks

This property specifies whether or not the client should echo the value entered by the user.

The PromptIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyboardInteractivePromptCount property.

Data Type

bool

keyboard_interactive_prompt_prompt property (SSHServer Struct)

This property contains the prompt label or text the client should present to the user.

Syntax

fn keyboard_interactive_prompt_prompt(&self , PromptIndex : i32) -> Result<String, IPWorksSSHError> 
fn set_keyboard_interactive_prompt_prompt(&self, PromptIndex : i32, value : &str) ->  Option<IPWorksSSHError> 
fn set_keyboard_interactive_prompt_prompt_ref(&self, PromptIndex : i32, value : &String) ->  Option<IPWorksSSHError> 

Default Value

""

Remarks

This property contains the prompt label or text the client should present to the user.

The PromptIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyboardInteractivePromptCount property.

Data Type

String

listening property (SSHServer Struct)

This property indicates whether the struct is listening for incoming connections on LocalPort.

Syntax

fn listening(&self ) -> Result<bool, IPWorksSSHError> 

Default Value

false

Remarks

This property indicates whether the struct is listening for connections on the port specified by the local_port property. Use the start_listening and stop_listening methods to control whether the struct is listening.

This property is read-only.

Data Type

bool

local_host property (SSHServer Struct)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

fn local_host(&self ) -> Result<String, IPWorksSSHError> 
fn set_local_host(&self, value : &str) ->  Option<IPWorksSSHError> 
fn set_local_host_ref(&self, value : &String) ->  Option<IPWorksSSHError> 

Default Value

""

Remarks

This property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the struct initiate connections (or accept in the case of server structs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

If the struct is connected, the local_host property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

NOTE: local_host is not persistent. You must always set it in code, and never in the property window.

Data Type

String

local_port property (SSHServer Struct)

The Transmission Control Protocol (TCP) port in the local host where the struct listens.

Syntax

fn local_port(&self ) -> Result<i32, IPWorksSSHError> 
fn set_local_port(&self, value : i32) ->  Option<IPWorksSSHError> 

Default Value

22

Remarks

The local_port property must be set before TCPServer starts listening. If its value is 0, then the TCP/IP subsystem picks a port number at random. The port number can be found by checking the value of the local_port property after TCPServer is in listening mode (after successfully assigning True to the listening property).

NOTE: The service port is not shared among servers (i.e., only one TCPServer can be 'listening' on a particular port at one time).

Data Type

i32

ssh_cert_count property (SSHServer Struct)

The number of records in the SSHCert arrays.

Syntax

fn ssh_cert_count(&self ) -> Result<i32, IPWorksSSHError> 
fn set_ssh_cert_count(&self, value : i32) ->  Option<IPWorksSSHError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• ssh_cert_effective_date
• ssh_cert_encoded
• ssh_cert_expiration_date
• ssh_cert_extended_key_usage
• ssh_cert_fingerprint
• ssh_cert_fingerprint_sha1
• ssh_cert_fingerprint_sha256
• ssh_cert_issuer
• ssh_cert_private_key
• ssh_cert_private_key_available
• ssh_cert_private_key_container
• ssh_cert_public_key
• ssh_cert_public_key_algorithm
• ssh_cert_public_key_length
• ssh_cert_serial_number
• ssh_cert_signature_algorithm
• ssh_cert_store
• ssh_cert_store_password
• ssh_cert_store_type
• ssh_cert_subject
• ssh_cert_subject_alt_names
• ssh_cert_thumbprint_md5
• ssh_cert_thumbprint_sha1
• ssh_cert_thumbprint_sha256
• ssh_cert_usage
• ssh_cert_usage_flags
• ssh_cert_version

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

Data Type

i32

ssh_cert_effective_date property (SSHServer Struct)

The date on which this certificate becomes valid.

Syntax

fn ssh_cert_effective_date(&self , SSHCertIndex : i32) -> Result<String, IPWorksSSHError> 

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

The SSHCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SSHCertCount property.

This property is read-only.

Data Type

String

ssh_cert_expiration_date property (SSHServer Struct)

The date on which the certificate expires.

Syntax

fn ssh_cert_expiration_date(&self , SSHCertIndex : i32) -> Result<String, IPWorksSSHError> 

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

The SSHCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SSHCertCount property.

This property is read-only.

Data Type

String

ssh_cert_extended_key_usage property (SSHServer Struct)

A comma-delimited list of extended key usage identifiers.

Syntax

fn ssh_cert_extended_key_usage(&self , SSHCertIndex : i32) -> Result<String, IPWorksSSHError> 

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

The SSHCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SSHCertCount property.

This property is read-only.

Data Type

String

ssh_cert_fingerprint property (SSHServer Struct)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

fn ssh_cert_fingerprint(&self , SSHCertIndex : i32) -> Result<String, IPWorksSSHError> 

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

The SSHCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SSHCertCount property.

This property is read-only.

Data Type

String

ssh_cert_fingerprint_sha1 property (SSHServer Struct)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

fn ssh_cert_fingerprint_sha1(&self , SSHCertIndex : i32) -> Result<String, IPWorksSSHError> 

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

The SSHCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SSHCertCount property.

This property is read-only.

Data Type

String

ssh_cert_fingerprint_sha256 property (SSHServer Struct)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

fn ssh_cert_fingerprint_sha256(&self , SSHCertIndex : i32) -> Result<String, IPWorksSSHError> 

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

The SSHCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SSHCertCount property.

This property is read-only.

Data Type

String

ssh_cert_issuer property (SSHServer Struct)

The issuer of the certificate.

Syntax

fn ssh_cert_issuer(&self , SSHCertIndex : i32) -> Result<String, IPWorksSSHError> 

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

The SSHCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SSHCertCount property.

This property is read-only.

Data Type

String

ssh_cert_private_key property (SSHServer Struct)

The private key of the certificate (if available).

Syntax

fn ssh_cert_private_key(&self , SSHCertIndex : i32) -> Result<String, IPWorksSSHError> 

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

NOTE: The private_key may be available but not exportable. In this case, private_key returns an empty string.

The SSHCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SSHCertCount property.

This property is read-only.

Data Type

String

ssh_cert_private_key_available property (SSHServer Struct)

Whether a PrivateKey is available for the selected certificate.

Syntax

fn ssh_cert_private_key_available(&self , SSHCertIndex : i32) -> Result<bool, IPWorksSSHError> 

Default Value

false

Remarks

Whether a private_key is available for the selected certificate. If private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

The SSHCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SSHCertCount property.

This property is read-only.

Data Type

bool

ssh_cert_private_key_container property (SSHServer Struct)

The name of the PrivateKey container for the certificate (if available).

Syntax

fn ssh_cert_private_key_container(&self , SSHCertIndex : i32) -> Result<String, IPWorksSSHError> 

Default Value

""

Remarks

The name of the private_key container for the certificate (if available). This functionality is available only on Windows platforms.

The SSHCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SSHCertCount property.

This property is read-only.

Data Type

String

ssh_cert_public_key property (SSHServer Struct)

The public key of the certificate.

Syntax

fn ssh_cert_public_key(&self , SSHCertIndex : i32) -> Result<String, IPWorksSSHError> 

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

The SSHCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SSHCertCount property.

This property is read-only.

Data Type

String

ssh_cert_public_key_algorithm property (SSHServer Struct)

The textual description of the certificate's public key algorithm.

Syntax

fn ssh_cert_public_key_algorithm(&self , SSHCertIndex : i32) -> Result<String, IPWorksSSHError> 

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

The SSHCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SSHCertCount property.

This property is read-only.

Data Type

String

ssh_cert_public_key_length property (SSHServer Struct)

The length of the certificate's public key (in bits).

Syntax

fn ssh_cert_public_key_length(&self , SSHCertIndex : i32) -> Result<i32, IPWorksSSHError> 

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

The SSHCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SSHCertCount property.

This property is read-only.

Data Type

i32

ssh_cert_serial_number property (SSHServer Struct)

The serial number of the certificate encoded as a string.

Syntax

fn ssh_cert_serial_number(&self , SSHCertIndex : i32) -> Result<String, IPWorksSSHError> 

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

The SSHCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SSHCertCount property.

This property is read-only.

Data Type

String

ssh_cert_signature_algorithm property (SSHServer Struct)

The text description of the certificate's signature algorithm.

Syntax

fn ssh_cert_signature_algorithm(&self , SSHCertIndex : i32) -> Result<String, IPWorksSSHError> 

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

The SSHCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SSHCertCount property.

This property is read-only.

Data Type

String

ssh_cert_store property (SSHServer Struct)

The name of the certificate store for the client certificate.

Syntax

fn ssh_cert_store(&self , SSHCertIndex : i32) -> Result<Vec<u8>, IPWorksSSHError> 
fn set_ssh_cert_store(&self, SSHCertIndex : i32, value : Vec<u8>) ->  Option<IPWorksSSHError> 
fn set_ssh_cert_store_ref(&self, SSHCertIndex : i32, value : &[u8]) ->  Option<IPWorksSSHError> 

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The store_type property denotes the type of the certificate store specified by store. If the store is password-protected, specify the password in store_password.

store is used in conjunction with the subject property to specify client certificates. If store has a value, and subject or encoded is set, a search for a certificate is initiated. Please see the subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

The SSHCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SSHCertCount property.

Data Type

Vec

ssh_cert_store_password property (SSHServer Struct)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

fn ssh_cert_store_password(&self , SSHCertIndex : i32) -> Result<String, IPWorksSSHError> 
fn set_ssh_cert_store_password(&self, SSHCertIndex : i32, value : &str) ->  Option<IPWorksSSHError> 
fn set_ssh_cert_store_password_ref(&self, SSHCertIndex : i32, value : &String) ->  Option<IPWorksSSHError> 

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

The SSHCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SSHCertCount property.

Data Type

String

ssh_cert_store_type property (SSHServer Struct)

The type of certificate store for this certificate.

Syntax

fn ssh_cert_store_type(&self , SSHCertIndex : i32) -> Result<i32, IPWorksSSHError> 
fn set_ssh_cert_store_type(&self, SSHCertIndex : i32, value : i32) ->  Option<IPWorksSSHError> 

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

The struct supports both public and private keys in a variety of formats. When the cstAuto value is used, the struct will automatically determine the type. This property can take one of the following values:

The SSHCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SSHCertCount property.

Data Type

i32

ssh_cert_subject_alt_names property (SSHServer Struct)

Comma-separated lists of alternative subject names for the certificate.

Syntax

fn ssh_cert_subject_alt_names(&self , SSHCertIndex : i32) -> Result<String, IPWorksSSHError> 

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

The SSHCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SSHCertCount property.

This property is read-only.

Data Type

String

ssh_cert_thumbprint_md5 property (SSHServer Struct)

The MD5 hash of the certificate.

Syntax

fn ssh_cert_thumbprint_md5(&self , SSHCertIndex : i32) -> Result<String, IPWorksSSHError> 

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

The SSHCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SSHCertCount property.

This property is read-only.

Data Type

String

ssh_cert_thumbprint_sha1 property (SSHServer Struct)

The SHA-1 hash of the certificate.

Syntax

fn ssh_cert_thumbprint_sha1(&self , SSHCertIndex : i32) -> Result<String, IPWorksSSHError> 

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

The SSHCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SSHCertCount property.

This property is read-only.

Data Type

String

ssh_cert_thumbprint_sha256 property (SSHServer Struct)

The SHA-256 hash of the certificate.

Syntax

fn ssh_cert_thumbprint_sha256(&self , SSHCertIndex : i32) -> Result<String, IPWorksSSHError> 

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

The SSHCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SSHCertCount property.

This property is read-only.

Data Type

String

ssh_cert_usage property (SSHServer Struct)

The text description of UsageFlags .

Syntax

fn ssh_cert_usage(&self , SSHCertIndex : i32) -> Result<String, IPWorksSSHError> 

Default Value

""

Remarks

The text description of usage_flags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

The SSHCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SSHCertCount property.

This property is read-only.

Data Type

String

ssh_cert_usage_flags property (SSHServer Struct)

The flags that show intended use for the certificate.

Syntax

fn ssh_cert_usage_flags(&self , SSHCertIndex : i32) -> Result<i32, IPWorksSSHError> 

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of usage_flags is a combination of the following flags:

Please see the usage property for a text representation of usage_flags.

This functionality currently is not available when the provider is OpenSSL.

The SSHCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SSHCertCount property.

This property is read-only.

Data Type

i32

ssh_cert_version property (SSHServer Struct)

The certificate's version number.

Syntax

fn ssh_cert_version(&self , SSHCertIndex : i32) -> Result<String, IPWorksSSHError> 

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

The SSHCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SSHCertCount property.

This property is read-only.

Data Type

String

ssh_cert_subject property (SSHServer Struct)

The subject of the certificate used for client authentication.

Syntax

fn ssh_cert_subject(&self , SSHCertIndex : i32) -> Result<String, IPWorksSSHError> 
fn set_ssh_cert_subject(&self, SSHCertIndex : i32, value : &str) ->  Option<IPWorksSSHError> 
fn set_ssh_cert_subject_ref(&self, SSHCertIndex : i32, value : &String) ->  Option<IPWorksSSHError> 

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

The SSHCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SSHCertCount property.

Data Type

String

ssh_cert_encoded property (SSHServer Struct)

The certificate (PEM/Base64 encoded).

Syntax

fn ssh_cert_encoded(&self , SSHCertIndex : i32) -> Result<Vec<u8>, IPWorksSSHError> 
fn set_ssh_cert_encoded(&self, SSHCertIndex : i32, value : Vec<u8>) ->  Option<IPWorksSSHError> 
fn set_ssh_cert_encoded_ref(&self, SSHCertIndex : i32, value : &[u8]) ->  Option<IPWorksSSHError> 

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The store and subject properties also may be used to specify a certificate.

When encoded is set, a search is initiated in the current store for the private key of the certificate. If the key is found, subject is updated to reflect the full subject of the selected certificate; otherwise, subject is set to an empty string.

The SSHCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SSHCertCount property.

Data Type

Vec

ssh_compression_algorithms property (SSHServer Struct)

The comma-separated list containing all allowable compression algorithms.

Syntax

fn ssh_compression_algorithms(&self ) -> Result<String, IPWorksSSHError> 
fn set_ssh_compression_algorithms(&self, value : &str) ->  Option<IPWorksSSHError> 
fn set_ssh_compression_algorithms_ref(&self, value : &String) ->  Option<IPWorksSSHError> 

Default Value

"none,zlib"

Remarks

During the Secure Shell (SSH) handshake, this list will be used to negotiate the compression algorithm to be used between the client and server. This list is used for both directions: client to server and server to client. When negotiating algorithms, each side sends a list of all algorithms it supports or allows. The algorithm chosen for each direction is the first algorithm to appear in the sender's list that the receiver supports. Therefore, it is important to list multiple algorithms in preferential order. If no algorithm can be agreed on, the struct will raise an error and the connection will be aborted.

At least one supported algorithm must appear in this list. The following compression algorithms are supported by the struct:

• zlib
• zlib@openssh.com
• none

Data Type

String

ssh_encryption_algorithms property (SSHServer Struct)

The comma-separated list containing all allowable encryption algorithms.

Syntax

fn ssh_encryption_algorithms(&self ) -> Result<String, IPWorksSSHError> 
fn set_ssh_encryption_algorithms(&self, value : &str) ->  Option<IPWorksSSHError> 
fn set_ssh_encryption_algorithms_ref(&self, value : &String) ->  Option<IPWorksSSHError> 

Default Value

"aes256-ctr,aes192-ctr,aes128-ctr,3des-ctr,aes256-gcm@openssh.com,aes128-gcm@openssh.com,chacha20-poly1305@openssh.com"

Remarks

During the Secure Shell (SSH) handshake, this list will be used to negotiate the encryption algorithm to be used between the client and server. This list is used for both directions: client to server and server to client. When negotiating algorithms, each side sends a list of all algorithms it supports or allows. The algorithm chosen for each direction is the first algorithm to appear in the sender's list that the receiver supports. Therefore, it is important to list multiple algorithms in preferential order. If no algorithm can be agreed on, the struct will raise an error and the connection will be aborted.

At least one supported algorithm must appear in this list. The following encryption algorithms are supported by the struct:

• aes256-ctr
• aes256-cbc
• aes192-ctr
• aes192-cbc
• aes128-ctr
• aes128-cbc
• 3des-ctr
• 3des-cbc
• cast128-cbc
• blowfish-cbc
• arcfour
• arcfour128
• arcfour256
• aes256-gcm@openssh.com
• aes128-gcm@openssh.com
• chacha20-poly1305@openssh.com

Data Type

String

change_record_length method (SSHServer Struct)

Changes the length of received data records.

Syntax

fn change_record_length(&self, channel_id : i32, record_length : i32) -> Result<(), IPWorksSSHError>

Remarks

This method defines the length of data records to be received (in bytes) for the specified ChannelId.

If RecordLength is set to a positive value, the struct will accumulate data until RecordLength bytes of data is received and only then will it fire the on_ssh_channel_data_in event with data of length RecordLength. This allows data to be received as records of known length. This method can be called at any time to change the record length, including within the on_data_in event.

A value of 0 (default) means this functionality is not used.

close_channel method (SSHServer Struct)

Closes an existing SSHChannel .

Syntax

fn close_channel(&self, channel_id : i32) -> Result<(), IPWorksSSHError>

Remarks

ChannelId is the identifier for the Secure Shell (SSH) channel to be closed.

config method (SSHServer Struct)

Sets or retrieves a configuration setting.

Syntax

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

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.

disconnect method (SSHServer Struct)

This method disconnects the specified client.

Syntax

fn disconnect(&self, connection_id : i32) -> Result<(), IPWorksSSHError>

Remarks

Calling this method will disconnect the client specified by the connection_id parameter.

do_events method (SSHServer Struct)

This method processes events from the internal message queue.

Syntax

fn do_events(&self) -> Result<(), IPWorksSSHError>

Remarks

When do_events is called, the struct processes any available events. If no events are available, it waits for a preset period of time, and then returns.

exchange_keys method (SSHServer Struct)

Causes the struct to exchange a new set of session keys on the specified connection.

Syntax

fn exchange_keys(&self, connection_id : i32) -> Result<(), IPWorksSSHError>

Remarks

Secure Shell (SSH) key renegotiation can be initiated by either end of an established SSH connection. exchange_keys allows the server to start such a renegotiation with the client. During this process, on_ssh_status events will fire with updates about the key negotiation process.

The SSH 2.0 specification recommends that key renegotiation be done once for 2 gigabytes (GB) of data processed by the connection, or once every day. This makes it more difficult to break the security of data-intensive or long-lived connections.

get_ssh_param method (SSHServer Struct)

Reads a field from a Secure Shell (SSH) packet's payload.

Syntax

fn get_ssh_param(&self, payload : &[u8], field : &str) ->  Result<String, IPWorksSSHError>

Remarks

This method is used to read the value of a particular field from an SSH packet's payload. Payload should contain the full payload of a packet received by an event such as on_ssh_channel_request. Field is the name of a field to be read out of the packet.

The following is a list of the names of well-known channel request field names and their encodings:

The remaining fields that are available in the payload are dependent on the value of RequestType.

pty-req

Pty-req is a request to open a pseudo terminal on the specified channel. The following fields are available:

x11-req

X11-req is a request to forward x11 sessions over a channel. The following fields are available:

env

Env is a request to set an environment variable to be passed into a shell that may be started later. The following fields are available:

exec

Exec is a request to execute a command on the channel using the authenticated user's shell. The following field is available:

subsystem

Subsystem is a request to start a subsystem on the specified channel. The following field is available:

xon-xoff

Xon-xoff instructs the server to allow or disallow control-S/control-Q style flow control. The following field is available:

signal

Sends a signal to the remote process/service. The following field is available:

If the packet type is not well known, Field should start with the special character "%" and contain a comma-separated list of field types as defined in set_ssh_param. For example, reading out the X11AuthProtocol of an x11-req payload, you can use "%s,f".

NOTE: The return value is a string encoded the same way as the FieldValue param in set_ssh_param.

get_ssh_param_bytes method (SSHServer Struct)

Reads a field from a Secure Shell (SSH) packet's payload.

Syntax

fn get_ssh_param_bytes(&self, payload : &[u8], field : &str) ->  Result<Vec<u8>, IPWorksSSHError>

Remarks

This method is the same as calling get_ssh_param, but it returns raw bytes instead of strings.

open_channel method (SSHServer Struct)

Opens a new SSHChannel .

Syntax

fn open_channel(&self, connection_id : i32, channel_type : &str) ->  Result<String, IPWorksSSHError>

Remarks

The Secure Shell (SSH) 2.0 specification allows for multiple channels to be opened over a single Transmission Control Protocol (TCP)/IP connection. The channels property represents the channels that are currently open. A new SSHChannel can be opened with open_channel, and data can be sent over it with send_channel_data.

ChannelType represents the type of Secure Shell (SSH) channel to be opened. The most common type of channel is "session".

If the call to open_channel succeeds, an SSHChannel will be created and added to the channels collection.

reset method (SSHServer Struct)

This method will reset the struct.

Syntax

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

Remarks

This method will reset the struct's properties to their default values.

send_bytes method (SSHServer Struct)

Sends binary data to the specified channel.

Syntax

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

Remarks

This method sends binary data to the channel identified by ChannelId. To send text, use the send_text method instead.

send_channel_data method (SSHServer Struct)

Sends data over a Secure Shell (SSH) channel.

Syntax

fn send_channel_data(&self, channel_id : i32, data : &[u8]) -> Result<(), IPWorksSSHError>

Remarks

This method can be used to send arbitrary data to the channel with the specified ChannelId.

send_ssh_packet method (SSHServer Struct)

Sends an encoded Secure Shell (SSH) packet to the server.

Syntax

fn send_ssh_packet(&self, channel_id : i32, packet_type : i32, payload : &[u8]) -> Result<(), IPWorksSSHError>

Remarks

This method can be used to send a previously built SSH payload to the server. ChannelId identifies the channel that will receive the packet.

PacketType identifies what kind of packet is to be sent. Payload should contain the payload of the packet, which can be built by successive calls to set_ssh_param.

When send_ssh_packet is called, the struct will finish building the packet, encrypt it for transport, and send it to the server.

send_text method (SSHServer Struct)

Sends text to the specified channel.

Syntax

fn send_text(&self, channel_id : i32, text : &str) -> Result<(), IPWorksSSHError>

Remarks

This method sends text to the client identified by ChannelId. To send binary data, use the send_bytes method instead.

set_ssh_param method (SSHServer Struct)

Writes a field to the end of a payload.

Syntax

fn set_ssh_param(&self, payload : &[u8], field_type : &str, field_value : &str) ->  Result<Vec<u8>, IPWorksSSHError>

Remarks

This method is used to build the payload portion of a Secure Shell (SSH) packet to be sent later by a call to send_ssh_packet. Payload should contain the result of a previous call to set_ssh_param. FieldType is a string defining the type of field to be written to the packet. FieldValue should be the string representation of the field to be written.

The following is a list of supported field types and a description of how FieldValue should be encoded:

NOTE: Integer values may be hexadecimal encoded by prefixing "0x" to the beginning of the string; otherwise, the value is assumed to be Base10.

shutdown method (SSHServer Struct)

This method shuts down the server.

Syntax

fn shutdown(&self) -> Result<(), IPWorksSSHError>

Remarks

This method shuts down the server. Calling this method is equivalent to calling stop_listening and then breaking every client connection by calling disconnect.

start_listening method (SSHServer Struct)

This method starts listening for incoming connections.

Syntax

fn start_listening(&self) -> Result<(), IPWorksSSHError>

Remarks

This method begins listening for incoming connections on the port specified by local_port. Once listening, events will fire as new clients connect and data are transferred.

To stop listening for new connections, call stop_listening. To stop listening for new connections and to disconnect all existing clients, call shutdown.

stop_listening method (SSHServer Struct)

This method stops listening for new connections.

Syntax

fn stop_listening(&self) -> Result<(), IPWorksSSHError>

Remarks

This method stops listening for new connections. After being called, any new connection attempts will be rejected. Calling this method does not disconnect existing connections.

To stop listening and to disconnect all existing clients, call shutdown instead.

on_connected event (SSHServer Struct)

Fired immediately after a connection completes (or fails).

Syntax

// SSHServerConnectedEventArgs carries the SSHServer Connected event's parameters.
pub struct SSHServerConnectedEventArgs {
  fn connection_id(&self) -> i32
  fn status_code(&self) -> i32
  fn description(&self) -> &String
  fn cert_store_type(&self) -> i32
  fn set_cert_store_type(&self, value : i32)
  fn cert_store(&self) -> &String
  fn set_cert_store(&self, value : &str)
  fn set_cert_store_ref(&self, value : &String)
  fn cert_password(&self) -> &String
  fn set_cert_password(&self, value : &str)
  fn set_cert_password_ref(&self, value : &String)
  fn cert_subject(&self) -> &String
  fn set_cert_subject(&self, value : &str)
  fn set_cert_subject_ref(&self, value : &String)
}

// SSHServerConnectedEvent defines the signature of the SSHServer Connected event's handler function.
pub trait SSHServerConnectedEvent {
  fn on_connected(&self, sender : SSHServer, e : &mut SSHServerConnectedEventArgs);
}

impl <'a> SSHServer<'a> {
  pub fn on_connected(&self) -> &'a dyn SSHServerConnectedEvent;
  pub fn set_on_connected(&mut self, value : &'a dyn SSHServerConnectedEvent);
  ...
}

Remarks

If the connection is made normally, StatusCode is 0, and Description is "OK".

If the connection fails, StatusCode has the error code returned by the system. Description contains a description of this code. The value of StatusCode is equal to the value of the system error.

Please refer to the Error Codes section for more information.

ConnectionId is the connection Id of the client requesting the connection.

CertStoreType is the store type of the alternate certificate to use for this connection. The struct supports both public and private keys in a variety of formats. When the cstAuto value is used, the struct will automatically determine the type. This property can take one of the following values:

CertStore is the store name or location of the alternate certificate to use for this connection.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

CertPassword is the password of the certificate store containing the alternate certificate to use for this connection.

CertSubject is the subject of the alternate certificate to use for this connection.

The special value * matches any subject and will select the first certificate in the store. The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

on_connection_request event (SSHServer Struct)

This event is fired when a request for connection comes from a remote host.

Syntax

// SSHServerConnectionRequestEventArgs carries the SSHServer ConnectionRequest event's parameters.
pub struct SSHServerConnectionRequestEventArgs {
  fn address(&self) -> &String
  fn port(&self) -> i32
  fn accept(&self) -> bool
  fn set_accept(&self, value : bool)
}

// SSHServerConnectionRequestEvent defines the signature of the SSHServer ConnectionRequest event's handler function.
pub trait SSHServerConnectionRequestEvent {
  fn on_connection_request(&self, sender : SSHServer, e : &mut SSHServerConnectionRequestEventArgs);
}

impl <'a> SSHServer<'a> {
  pub fn on_connection_request(&self) -> &'a dyn SSHServerConnectionRequestEvent;
  pub fn set_on_connection_request(&mut self, value : &'a dyn SSHServerConnectionRequestEvent);
  ...
}

Remarks

This event indicates an incoming connection. The connection is accepted by default. address and port will contain information about the remote host requesting the inbound connection. If you want to refuse it, you can set the accept parameter to False.

on_disconnected event (SSHServer Struct)

This event is fired when a connection is closed.

Syntax

// SSHServerDisconnectedEventArgs carries the SSHServer Disconnected event's parameters.
pub struct SSHServerDisconnectedEventArgs {
  fn connection_id(&self) -> i32
  fn status_code(&self) -> i32
  fn description(&self) -> &String
}

// SSHServerDisconnectedEvent defines the signature of the SSHServer Disconnected event's handler function.
pub trait SSHServerDisconnectedEvent {
  fn on_disconnected(&self, sender : SSHServer, e : &mut SSHServerDisconnectedEventArgs);
}

impl <'a> SSHServer<'a> {
  pub fn on_disconnected(&self) -> &'a dyn SSHServerDisconnectedEvent;
  pub fn set_on_disconnected(&mut self, value : &'a dyn SSHServerDisconnectedEvent);
  ...
}

Remarks

If the connection is broken normally, status_code is 0, and description is "OK".

If the connection is broken for any other reason, status_code has the error code returned by the system. description contains a description of this code. The value of status_code is equal to the value of the system error.

Please refer to the Error Codes section for more information.

on_error event (SSHServer Struct)

Fired when errors occur during data delivery.

Syntax

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

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

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

Remarks

The on_error event is fired in case of exceptional conditions during message processing. Normally the struct fails with an error.

ConnectionId contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

on_log event (SSHServer Struct)

Fired once for each log message.

Syntax

// SSHServerLogEventArgs carries the SSHServer Log event's parameters.
pub struct SSHServerLogEventArgs {
  fn connection_id(&self) -> i32
  fn log_level(&self) -> i32
  fn message(&self) -> &String
  fn log_type(&self) -> &String
}

// SSHServerLogEvent defines the signature of the SSHServer Log event's handler function.
pub trait SSHServerLogEvent {
  fn on_log(&self, sender : SSHServer, e : &mut SSHServerLogEventArgs);
}

impl <'a> SSHServer<'a> {
  pub fn on_log(&self) -> &'a dyn SSHServerLogEvent;
  pub fn set_on_log(&mut self, value : &'a dyn SSHServerLogEvent);
  ...
}

Remarks

Fired once for each log message generated by the struct. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the detail level of the message. Possible values are as follows:

Message is the log message.

LogType is reserved for future use.

ConnectionId specifies the connection to which the log message is applicable.

on_ssh_channel_closed event (SSHServer Struct)

Fired when a channel is closed.

Syntax

// SSHServerSSHChannelClosedEventArgs carries the SSHServer SSHChannelClosed event's parameters.
pub struct SSHServerSSHChannelClosedEventArgs {
  fn connection_id(&self) -> i32
  fn channel_id(&self) -> i32
}

// SSHServerSSHChannelClosedEvent defines the signature of the SSHServer SSHChannelClosed event's handler function.
pub trait SSHServerSSHChannelClosedEvent {
  fn on_ssh_channel_closed(&self, sender : SSHServer, e : &mut SSHServerSSHChannelClosedEventArgs);
}

impl <'a> SSHServer<'a> {
  pub fn on_ssh_channel_closed(&self) -> &'a dyn SSHServerSSHChannelClosedEvent;
  pub fn set_on_ssh_channel_closed(&mut self, value : &'a dyn SSHServerSSHChannelClosedEvent);
  ...
}

Remarks

The on_ssh_channel_closed event is fired when a channel is closed on a Secure Shell (SSH) connection.

ConnectionId identifies the connection.

ChannelId identifies the channel.

NOTE: Processing long-running requests, including sending channel data, inside this event may cause the underlying transport to stop processing Secure Shell (SSH) data until the event returns. To prevent this from happening, all requests should be processed asynchronously in a separate thread outside of this event.

on_ssh_channel_data_in event (SSHServer Struct)

Fired when data are received on a Secure Shell (SSH) channel.

Syntax

// SSHServerSSHChannelDataInEventArgs carries the SSHServer SSHChannelDataIn event's parameters.
pub struct SSHServerSSHChannelDataInEventArgs {
  fn connection_id(&self) -> i32
  fn channel_id(&self) -> i32
  fn data(&self) -> &[u8]
}

// SSHServerSSHChannelDataInEvent defines the signature of the SSHServer SSHChannelDataIn event's handler function.
pub trait SSHServerSSHChannelDataInEvent {
  fn on_ssh_channel_data_in(&self, sender : SSHServer, e : &mut SSHServerSSHChannelDataInEventArgs);
}

impl <'a> SSHServer<'a> {
  pub fn on_ssh_channel_data_in(&self) -> &'a dyn SSHServerSSHChannelDataInEvent;
  pub fn set_on_ssh_channel_data_in(&mut self, value : &'a dyn SSHServerSSHChannelDataInEvent);
  ...
}

Remarks

Whenever a client sends data to an SSH channel, the on_ssh_channel_data_in event will fire. ChannelId will identify the channel receiving data. Data will contain the raw data being received.

ConnectionId identifies the connection. ChannelId identifies the channel.

NOTE: Processing long-running requests, including sending channel data, inside this event may cause the underlying transport to stop processing Secure Shell (SSH) data until the event returns. To prevent this from happening, all requests should be processed asynchronously in a separate thread outside of this event.

on_ssh_channel_eof event (SSHServer Struct)

Fired when the remote peer signals the end of the data stream for the channel.

Syntax

// SSHServerSSHChannelEOFEventArgs carries the SSHServer SSHChannelEOF event's parameters.
pub struct SSHServerSSHChannelEOFEventArgs {
  fn connection_id(&self) -> i32
  fn channel_id(&self) -> i32
}

// SSHServerSSHChannelEOFEvent defines the signature of the SSHServer SSHChannelEOF event's handler function.
pub trait SSHServerSSHChannelEOFEvent {
  fn on_ssh_channel_eof(&self, sender : SSHServer, e : &mut SSHServerSSHChannelEOFEventArgs);
}

impl <'a> SSHServer<'a> {
  pub fn on_ssh_channel_eof(&self) -> &'a dyn SSHServerSSHChannelEOFEvent;
  pub fn set_on_ssh_channel_eof(&mut self, value : &'a dyn SSHServerSSHChannelEOFEvent);
  ...
}

Remarks

The on_ssh_channel_eof event is fired when the end of the data stream for a channel on a Secure Shell (SSH) connection is reached.

ConnectionId identifies the connection. ChannelId identifies the channel.

NOTE: Processing long-running requests, including sending channel data, inside this event may cause the underlying transport to stop processing Secure Shell (SSH) data until the event returns. To prevent this from happening, all requests should be processed asynchronously in a separate thread outside of this event.

on_ssh_channel_opened event (SSHServer Struct)

Fired when a channel is successfully opened.

Syntax

// SSHServerSSHChannelOpenedEventArgs carries the SSHServer SSHChannelOpened event's parameters.
pub struct SSHServerSSHChannelOpenedEventArgs {
  fn connection_id(&self) -> i32
  fn channel_id(&self) -> i32
}

// SSHServerSSHChannelOpenedEvent defines the signature of the SSHServer SSHChannelOpened event's handler function.
pub trait SSHServerSSHChannelOpenedEvent {
  fn on_ssh_channel_opened(&self, sender : SSHServer, e : &mut SSHServerSSHChannelOpenedEventArgs);
}

impl <'a> SSHServer<'a> {
  pub fn on_ssh_channel_opened(&self) -> &'a dyn SSHServerSSHChannelOpenedEvent;
  pub fn set_on_ssh_channel_opened(&mut self, value : &'a dyn SSHServerSSHChannelOpenedEvent);
  ...
}

Remarks

The on_ssh_channel_opened event is fired when a channel is successfully opened on a Secure Shell (SSH) connection.

ConnectionId identifies the connection.

ChannelId identifies the channel.

NOTE: Processing long-running requests, including sending channel data, inside this event may cause the underlying transport to stop processing Secure Shell (SSH) data until the event returns. To prevent this from happening, all requests should be processed asynchronously in a separate thread outside of this event.

on_ssh_channel_open_request event (SSHServer Struct)

Fired when a client attempts to open a new channel.

Syntax

// SSHServerSSHChannelOpenRequestEventArgs carries the SSHServer SSHChannelOpenRequest event's parameters.
pub struct SSHServerSSHChannelOpenRequestEventArgs {
  fn connection_id(&self) -> i32
  fn channel_id(&self) -> i32
  fn service(&self) -> &String
  fn parameters(&self) -> &[u8]
  fn accept(&self) -> bool
  fn set_accept(&self, value : bool)
}

// SSHServerSSHChannelOpenRequestEvent defines the signature of the SSHServer SSHChannelOpenRequest event's handler function.
pub trait SSHServerSSHChannelOpenRequestEvent {
  fn on_ssh_channel_open_request(&self, sender : SSHServer, e : &mut SSHServerSSHChannelOpenRequestEventArgs);
}

impl <'a> SSHServer<'a> {
  pub fn on_ssh_channel_open_request(&self) -> &'a dyn SSHServerSSHChannelOpenRequestEvent;
  pub fn set_on_ssh_channel_open_request(&mut self, value : &'a dyn SSHServerSSHChannelOpenRequestEvent);
  ...
}

Remarks

This event is fired whenever a client attempts to open a new channel for a given connection.

ChannelId will contain the Id of the channel to be created.

Service will identify the type of channel that is being requested (e.g., "session").

Accept must to be set to True to accept the channel open request.

ConnectionId identifies the connection.

ChannelId identifies the channel.

If the channel open request contains extra information, it will be contained in Parameters; you can extract data from it using get_ssh_param and get_ssh_param_bytes. The most common example of a request with parameters would be a request with Service set to "direct-tcpip" (for Secure Shell (SSH) tunneling); in that case, Parameters will contain the host to connect (string), the port to connect (int), the originator IP address (string), and the originator Transmission Control Protocol (TCP) port (int).

NOTE: Processing long-running requests, including sending channel data, inside this event may cause the underlying transport to stop processing Secure Shell (SSH) data until the event returns. To prevent this from happening, all requests should be processed asynchronously in a separate thread outside of this event.

on_ssh_channel_ready_to_send event (SSHServer Struct)

Fired when the struct is ready to send data.

Syntax

// SSHServerSSHChannelReadyToSendEventArgs carries the SSHServer SSHChannelReadyToSend event's parameters.
pub struct SSHServerSSHChannelReadyToSendEventArgs {
  fn connection_id(&self) -> i32
  fn channel_id(&self) -> i32
}

// SSHServerSSHChannelReadyToSendEvent defines the signature of the SSHServer SSHChannelReadyToSend event's handler function.
pub trait SSHServerSSHChannelReadyToSendEvent {
  fn on_ssh_channel_ready_to_send(&self, sender : SSHServer, e : &mut SSHServerSSHChannelReadyToSendEventArgs);
}

impl <'a> SSHServer<'a> {
  pub fn on_ssh_channel_ready_to_send(&self) -> &'a dyn SSHServerSSHChannelReadyToSendEvent;
  pub fn set_on_ssh_channel_ready_to_send(&mut self, value : &'a dyn SSHServerSSHChannelReadyToSendEvent);
  ...
}

Remarks

This event fires when data can be sent over the Secure Shell (SSH) channel specified by ChannelId for the connection specified by ConnectionId.

When a channel is opened, this event will fire once the channel is ready and data can be sent.

When timeout is set to 0 (asynchronous) sending data may result in an error if the channel or underlying socket cannot accept more data to send. Monitor on_ssh_channel_ready_to_send or ready_to_send to determine when data can be sent again.

When timeout is set to a positive value, the struct will block when sending data until the data can be successfully sent and on_ssh_channel_ready_to_send and ready_to_send do not need to be monitored.

on_ssh_channel_request event (SSHServer Struct)

Fired when the client sends a channel request to the SSHHost .

Syntax

// SSHServerSSHChannelRequestEventArgs carries the SSHServer SSHChannelRequest event's parameters.
pub struct SSHServerSSHChannelRequestEventArgs {
  fn connection_id(&self) -> i32
  fn channel_id(&self) -> i32
  fn request_type(&self) -> &String
  fn packet(&self) -> &[u8]
  fn success(&self) -> bool
  fn set_success(&self, value : bool)
}

// SSHServerSSHChannelRequestEvent defines the signature of the SSHServer SSHChannelRequest event's handler function.
pub trait SSHServerSSHChannelRequestEvent {
  fn on_ssh_channel_request(&self, sender : SSHServer, e : &mut SSHServerSSHChannelRequestEventArgs);
}

impl <'a> SSHServer<'a> {
  pub fn on_ssh_channel_request(&self) -> &'a dyn SSHServerSSHChannelRequestEvent;
  pub fn set_on_ssh_channel_request(&mut self, value : &'a dyn SSHServerSSHChannelRequestEvent);
  ...
}

Remarks

The client may send requests that affect the status of a particular SSHChannel. Some requests will be automatically handled by the struct. Others, however, may need the attention of the user to be dealt with properly within the scope of the application.

ConnectionId identifies the connection making the request.

ChannelId identifies the channel receiving the request.

Type will contain the type of the request. These types depend on the type of the channel. For example, a "session" channel executing a command on the remote shell may receive an "exit-status" request containing the return code of that command.

RequestData contains the remainder of the original Secure Shell (SSH) packet. If the request type has specific parameters, they can be parsed out of this data.

Success should be used to instruct the struct to respond to the request with either a success or failure notification. If the request is successful, on_ssh_channel_requested will fire with the same information in case the request requires further processing.

NOTE: Processing long-running requests, including sending channel data, inside this event may cause the underlying transport to stop processing Secure Shell (SSH) data until the event returns. To prevent this from happening, all requests should be processed asynchronously in a separate thread outside of this event.

on_ssh_channel_requested event (SSHServer Struct)

Fired if the SSHChannelRequest was successful, any further processing for the channel request should be done here.

Syntax

// SSHServerSSHChannelRequestedEventArgs carries the SSHServer SSHChannelRequested event's parameters.
pub struct SSHServerSSHChannelRequestedEventArgs {
  fn connection_id(&self) -> i32
  fn channel_id(&self) -> i32
  fn request_type(&self) -> &String
  fn packet(&self) -> &[u8]
}

// SSHServerSSHChannelRequestedEvent defines the signature of the SSHServer SSHChannelRequested event's handler function.
pub trait SSHServerSSHChannelRequestedEvent {
  fn on_ssh_channel_requested(&self, sender : SSHServer, e : &mut SSHServerSSHChannelRequestedEventArgs);
}

impl <'a> SSHServer<'a> {
  pub fn on_ssh_channel_requested(&self) -> &'a dyn SSHServerSSHChannelRequestedEvent;
  pub fn set_on_ssh_channel_requested(&mut self, value : &'a dyn SSHServerSSHChannelRequestedEvent);
  ...
}

Remarks

The client may send requests that affect the status of a particular SSHChannel. Some requests will be automatically handled by the struct. Others, however, may need the attention of the user to be dealt with properly within the scope of the application.

ConnectionId identifies the connection making the request.

ChannelId identifies the channel receiving the request.

Type will contain the type of the request. These types depend on the type of the channel. For example, a "session" channel executing a command on the remote shell may receive an "exit-status" request containing the return code of that command.

RequestData contains the remainder of the original Secure Shell (SSH) packet. If the request type has specific parameters, they can be parsed out of this data.

NOTE: Processing long-running requests, including sending channel data, inside this event may cause the underlying transport to stop processing Secure Shell (SSH) data until the event returns. To prevent this from happening, all requests should be processed asynchronously in a separate thread outside of this event.

on_ssh_service_request event (SSHServer Struct)

Fired when a client requests a service to be started.

Syntax

// SSHServerSSHServiceRequestEventArgs carries the SSHServer SSHServiceRequest event's parameters.
pub struct SSHServerSSHServiceRequestEventArgs {
  fn connection_id(&self) -> i32
  fn service(&self) -> &String
  fn accept(&self) -> bool
  fn set_accept(&self, value : bool)
}

// SSHServerSSHServiceRequestEvent defines the signature of the SSHServer SSHServiceRequest event's handler function.
pub trait SSHServerSSHServiceRequestEvent {
  fn on_ssh_service_request(&self, sender : SSHServer, e : &mut SSHServerSSHServiceRequestEventArgs);
}

impl <'a> SSHServer<'a> {
  pub fn on_ssh_service_request(&self) -> &'a dyn SSHServerSSHServiceRequestEvent;
  pub fn set_on_ssh_service_request(&mut self, value : &'a dyn SSHServerSSHServiceRequestEvent);
  ...
}

Remarks

The on_ssh_service_request event is fired when a client requests that a service be started for a particular connection, identified by ConnectionId. Service will be the name of the service the client wishes to start. If the connection is authenticated and the user has access to the service, set Accept to True to allow the SSHServer to accept the request.

NOTE: Processing long-running requests, including sending channel data, inside this event may cause the underlying transport to stop processing Secure Shell (SSH) data until the event returns. To prevent this from happening, all requests should be processed asynchronously in a separate thread outside of this event.

on_ssh_status event (SSHServer Struct)

Fired to show the progress of the secure connection.

Syntax

// SSHServerSSHStatusEventArgs carries the SSHServer SSHStatus event's parameters.
pub struct SSHServerSSHStatusEventArgs {
  fn connection_id(&self) -> i32
  fn message(&self) -> &String
}

// SSHServerSSHStatusEvent defines the signature of the SSHServer SSHStatus event's handler function.
pub trait SSHServerSSHStatusEvent {
  fn on_ssh_status(&self, sender : SSHServer, e : &mut SSHServerSSHStatusEventArgs);
}

impl <'a> SSHServer<'a> {
  pub fn on_ssh_status(&self) -> &'a dyn SSHServerSSHStatusEvent;
  pub fn set_on_ssh_status(&mut self, value : &'a dyn SSHServerSSHStatusEvent);
  ...
}

Remarks

This event is fired for informational and logging purposes only. It is used to track the progress of the connection.

on_ssh_tunnel_closed event (SSHServer Struct)

Fired when a connected client attempts to close a tunnel.

Syntax

// SSHServerSSHTunnelClosedEventArgs carries the SSHServer SSHTunnelClosed event's parameters.
pub struct SSHServerSSHTunnelClosedEventArgs {
  fn connection_id(&self) -> i32
  fn address(&self) -> &String
  fn port(&self) -> i32
}

// SSHServerSSHTunnelClosedEvent defines the signature of the SSHServer SSHTunnelClosed event's handler function.
pub trait SSHServerSSHTunnelClosedEvent {
  fn on_ssh_tunnel_closed(&self, sender : SSHServer, e : &mut SSHServerSSHTunnelClosedEventArgs);
}

impl <'a> SSHServer<'a> {
  pub fn on_ssh_tunnel_closed(&self) -> &'a dyn SSHServerSSHTunnelClosedEvent;
  pub fn set_on_ssh_tunnel_closed(&mut self, value : &'a dyn SSHServerSSHTunnelClosedEvent);
  ...
}

Remarks

on_ssh_tunnel_requested event (SSHServer Struct)

Fired when a connected client attempts to establish a forward or reverse tunnel.

Syntax

// SSHServerSSHTunnelRequestedEventArgs carries the SSHServer SSHTunnelRequested event's parameters.
pub struct SSHServerSSHTunnelRequestedEventArgs {
  fn connection_id(&self) -> i32
  fn direction(&self) -> i32
  fn address(&self) -> &String
  fn port(&self) -> i32
  fn set_port(&self, value : i32)
  fn accept(&self) -> bool
  fn set_accept(&self, value : bool)
}

// SSHServerSSHTunnelRequestedEvent defines the signature of the SSHServer SSHTunnelRequested event's handler function.
pub trait SSHServerSSHTunnelRequestedEvent {
  fn on_ssh_tunnel_requested(&self, sender : SSHServer, e : &mut SSHServerSSHTunnelRequestedEventArgs);
}

impl <'a> SSHServer<'a> {
  pub fn on_ssh_tunnel_requested(&self) -> &'a dyn SSHServerSSHTunnelRequestedEvent;
  pub fn set_on_ssh_tunnel_requested(&mut self, value : &'a dyn SSHServerSSHTunnelRequestedEvent);
  ...
}

Remarks

on_ssh_user_auth_request event (SSHServer Struct)

Fired when a client attempts to authenticate a connection.

Syntax

// SSHServerSSHUserAuthRequestEventArgs carries the SSHServer SSHUserAuthRequest event's parameters.
pub struct SSHServerSSHUserAuthRequestEventArgs {
  fn connection_id(&self) -> i32
  fn user(&self) -> &String
  fn service(&self) -> &String
  fn auth_method(&self) -> &String
  fn auth_param(&self) -> &String
  fn accept(&self) -> bool
  fn set_accept(&self, value : bool)
  fn partial_success(&self) -> bool
  fn set_partial_success(&self, value : bool)
  fn available_methods(&self) -> &String
  fn set_available_methods(&self, value : &str)
  fn set_available_methods_ref(&self, value : &String)
  fn key_algorithm(&self) -> &String
}

// SSHServerSSHUserAuthRequestEvent defines the signature of the SSHServer SSHUserAuthRequest event's handler function.
pub trait SSHServerSSHUserAuthRequestEvent {
  fn on_ssh_user_auth_request(&self, sender : SSHServer, e : &mut SSHServerSSHUserAuthRequestEventArgs);
}

impl <'a> SSHServer<'a> {
  pub fn on_ssh_user_auth_request(&self) -> &'a dyn SSHServerSSHUserAuthRequestEvent;
  pub fn set_on_ssh_user_auth_request(&mut self, value : &'a dyn SSHServerSSHUserAuthRequestEvent);
  ...
}

Remarks

The on_ssh_user_auth_request event fires when a Secure Shell (SSH) client attempts to authenticate itself on a particular connection. ConnectionId will identify the connection being authenticated. User will be the name of the account requesting authentication, and Service will contain the name of the service the client is wishing to access.

AuthMethod will denote which method the client is attempting to use to authenticate itself. AuthParam will contain the value of the authentication token used by the client. If the token is acceptable, you may set Accept to True to allow the struct to authenticate the client. If it is not, set Accept to False.

Connecting clients will initially attempt authentication with an AuthMethod of "none". This is done with the expectation that the request will fail and the server will send a list of supported methods back to the client. In your implementation, check the AuthMethod parameter; if it is "none", you should set AvailableMethods and reject the request. The client will select one of the available methods and reauthenticate.

You may set AvailableMethods to a comma-delimited string of authentication methods that are available for the user. This list will be sent back to the client so that it may perform further authentication attempts.

The following is a list of methods implemented by the struct:

The PartialSuccess parameter is used only when multifactor authentication is needed. To implement multifactor authentication when this event fires, first verify the AuthParam for the given AuthMethod. If accepted, set PartialSuccess to True and Accept to False. The client should then send the authentication request for a different form of authentication specified in AvailableMethods. You may continue to set PartialSuccess to True until all authentication requirements are satisfied. Once all requirements are satisfied set Accept to True.

KeyAlgorithm holds the signing algorithm used when the client attempts public key authentication. Possible values are as follows:

• ssh-rsa
• rsa-sha2-256
• rsa-sha2-512
• ssh-dss
• ecdsa-sha2-nistp256
• ecdsa-sha2-nistp384
• ecdsa-sha2-nistp521
• x509v3-sign-rsa
• x509v3-sign-dss

NOTE: Processing long-running requests, including sending channel data, inside this event may cause the underlying transport to stop processing Secure Shell (SSH) data until the event returns. To prevent this from happening, all requests should be processed asynchronously in a separate thread outside of this event.

Config Settings (SSHServer Struct)

SSHServer Config Settings

*SSH-1.99-*,*SSH-2.0-*,*SSH-2.99-*

TCPServer Config Settings

Base Config Settings

Trappable Errors (SSHServer Struct)

SSHServer Errors

TCPServer Errors

TCP/IP Errors