# Struct ipworksssh::SSHTunnel The SSHTunnel struct can be used to tunnel data through a Secure Shell (SSH) server to a remote location. ## Syntax ```text ipworksssh::SSHTunnel ``` ## Remarks The SSHTunnel struct implements a daemon that accepts connections and tunnels the data from those connections over a Secure Shell (SSH) connection to a remote location. First, set [ssh_host](#ssh_host-property-sshtunnel-struct) to the server you wish to use to tunnel the data. [ssh_user](#ssh_user-property-sshtunnel-struct), [ssh_password](#ssh_password-property-sshtunnel-struct), and the ssh_cert* properties can be used to authenticate the tunneling connection. Second, set [ssh_forward_host](#ssh_forward_host-property-sshtunnel-struct) to the hostname or IP address of the destination machine, and [ssh_forward_port](#ssh_forward_port-property-sshtunnel-struct) to the port to which you wish to send data. Finally, call [start_listening](#start_listening-method-sshtunnel-struct). The struct will listen for connections on the interface identified by [local_host](#local_host-property-sshtunnel-struct) and [local_port](#local_port-property-sshtunnel-struct). When a client attempts to connect to the struct, the struct will fire a [on_connection_request](#on_connection_request-event-sshtunnel-struct) event that can be used to accept or reject the connection. If the connection is accepted, the struct will attempt to logon to the [ssh_host](#ssh_host-property-sshtunnel-struct) and will tell the server to connect remotely to another machine. Once this process is complete, the tunnel will be established and data can be securely transmitted from end to end. **Example. Connecting Between Networks:** A client that exists in Network A wishes to connect to a resource that exists in Network B. Both networks are secured by a firewall, making it difficult to freely connect to resources within the other network. Network B, however, contains an SSH server that supports tunneling. An SSHTunnel struct set up with Network A can be used to access any resource in Network B. The [ssh_host](#ssh_host-property-sshtunnel-struct) and [ssh_port](#ssh_port-property-sshtunnel-struct) properties must be set to the hostname and port exposed by Network B's firewall. [ssh_forward_host](#ssh_forward_host-property-sshtunnel-struct) and [ssh_forward_port](#ssh_forward_port-property-sshtunnel-struct) are then set to the value of the resource within Network B to which the client in Network A wishes to connect. Any client in Network A can then connect to the SSHTunnel instance's [local_host](#local_host-property-sshtunnel-struct) and [local_port](#local_port-property-sshtunnel-struct). As clients within Network A connect to the SSHTunnel, the struct will forward the connections, secured by SSH, through the network firewalls to the SSH server in Network B. The SSH server will then connect to the resource within Network B and forward all data received from the SSHTunnel instance to that resource. All data received from the resource will then be forwarded to the original client in Network A. **Dynamic Forwarding** Dynamic forwarding is a feature provided by SSH that leverages the SOCKS protocol. With dynamic forwarding, the SSHTunnel component acts as a SOCKS proxy, and all relevant traffic is relayed through the SSH connection to the destination defined by the client that made the request. The SSHTunnel component supports dynamic forwarding automatically when [ssh_forward_host](#ssh_forward_host-property-sshtunnel-struct) and [ssh_forward_port](#ssh_forward_port-property-sshtunnel-struct) are not specified (the forwarding host is determined dynamically). The client making requests through SSHTunnel must be configured to use a SOCKS proxy, in which case the proxy port is the same as the [local_port](#local_port-property-sshtunnel-struct) property. In IPWorks components, a SOCKS proxy can be enabled as follows: ```text // Enable the SOCKS proxy for IPWorks' HTTP component http.Firewall.FirewallType = nsoftware.IPWorks.FirewallTypes.fwSOCKS5; http.Firewall.Port = 1234; //The port set in the SSHTunnel LocalPort property http.Firewall.Host = "localhost"; //The hostname or IP address where SSHTunnel is listening ``` ** Note:** SSHTunnel can support either dynamic forwarding ([ssh_forward_host](#ssh_forward_host-property-sshtunnel-struct) and [ssh_forward_port](#ssh_forward_port-property-sshtunnel-struct) are not set) or standard forwarding ([ssh_forward_host](#ssh_forward_host-property-sshtunnel-struct) and [ssh_forward_port](#ssh_forward_port-property-sshtunnel-struct) are set). It cannot support both modes at the same time. As a result, it is expected that clients connecting to the SSHTunnel component are configured in a way that matches the configuration of the SSHTunnel component (dynamic or standard forwarding). For example, if SSHTunnel has the [ssh_forward_host](#ssh_forward_host-property-sshtunnel-struct) and [ssh_forward_port](#ssh_forward_port-property-sshtunnel-struct) properties set, then the client must **not** treat SSHTunnel as a SOCKS proxy. If the SSHTunnel does not have the aforementioned properties set, then the client **must** treat SSHTunnel as a SOCKS proxy. NOTE: Server components are designed to process events as they occur. To ensure that events are processed in a timely manner, [do_events](#do_events-method-sshtunnel-struct) 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 SSHTunnel struct cannot be disposed of automatically. Please, call the *dispose(&mut; self)* method of SSHTunnel 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.* | | | | --- | --- | | [connected](#connected-property-sshtunnel-struct) | Whether the struct is connected. | | [connection_backlog](#connection_backlog-property-sshtunnel-struct) | This property includes the maximum number of pending connections maintained by the Transmission Control Protocol (TCP)/IP subsystem. | | [client_count](#client_count-property-sshtunnel-struct) | The number of records in the Client arrays. | | [client_accept_data](#client_accept_data-property-sshtunnel-struct) | This property indicates whether data reception is currently enabled. | | [client_bytes_sent](#client_bytes_sent-property-sshtunnel-struct) | This property shows how many bytes were sent after calling Send or SendBytes . | | [client_connected](#client_connected-property-sshtunnel-struct) | This property indicates the status of individual connections. | | [client_connection_id](#client_connection_id-property-sshtunnel-struct) | This property contains an identifier generated by the struct to identify each connection. | | [client_eol](#client_eol-property-sshtunnel-struct) | The EOL property is used to define boundaries in the input stream using the value of the property. | | [client_idle_timeout](#client_idle_timeout-property-sshtunnel-struct) | This property contains the idle timeout for this connection. | | [client_local_address](#client_local_address-property-sshtunnel-struct) | This property shows the IP address of the interface through which the connection is passing. | | [client_ready_to_send](#client_ready_to_send-property-sshtunnel-struct) | This property indicates whether the struct is ready to send data. | | [client_record_length](#client_record_length-property-sshtunnel-struct) | This property holds the current record length set by ChangeRecordLength . | | [client_remote_host](#client_remote_host-property-sshtunnel-struct) | This property shows the IP address of the remote host through which the connection is coming. | | [client_remote_port](#client_remote_port-property-sshtunnel-struct) | This property shows the Transmission Control Protocol (TCP) port on the remote host through which the connection is coming. | | [client_single_line_mode](#client_single_line_mode-property-sshtunnel-struct) | This property shows the special mode for line-oriented protocols. | | [client_timeout](#client_timeout-property-sshtunnel-struct) | This property specifies a timeout for the struct. | | [client_user_data](#client_user_data-property-sshtunnel-struct) | The UserData property holds connection-specific user-specified data. | | [default_eol](#default_eol-property-sshtunnel-struct) | This property includes a default end-of-line (EOL) value to be used by incoming connections. | | [default_single_line_mode](#default_single_line_mode-property-sshtunnel-struct) | This property tells the struct whether or not to treat new connections as line oriented. | | [default_timeout](#default_timeout-property-sshtunnel-struct) | This property includes an initial timeout value to be used by incoming connections. | | [firewall_auto_detect](#firewall_auto_detect-property-sshtunnel-struct) | Whether to automatically detect and use firewall system settings, if available. | | [firewall_type](#firewall_type-property-sshtunnel-struct) | The type of firewall to connect through. | | [firewall_host](#firewall_host-property-sshtunnel-struct) | The name or IP address of the firewall (optional). | | [firewall_password](#firewall_password-property-sshtunnel-struct) | A password if authentication is to be used when connecting through the firewall. | | [firewall_port](#firewall_port-property-sshtunnel-struct) | The Transmission Control Protocol (TCP) port for the firewall Host . | | [firewall_user](#firewall_user-property-sshtunnel-struct) | A username if authentication is to be used when connecting through a firewall. | | [keep_alive](#keep_alive-property-sshtunnel-struct) | When True, KEEPALIVE packets are enabled (for long connections). | | [linger](#linger-property-sshtunnel-struct) | When set to True, connections are terminated gracefully. | | [listening](#listening-property-sshtunnel-struct) | This property indicates whether the struct is listening for incoming connections on LocalPort. | | [local_host](#local_host-property-sshtunnel-struct) | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. | | [local_port](#local_port-property-sshtunnel-struct) | The TCP port in the local host where the struct binds. | | [ssh_accept_server_host_key_effective_date](#ssh_accept_server_host_key_effective_date-property-sshtunnel-struct) | The date on which this certificate becomes valid. | | [ssh_accept_server_host_key_expiration_date](#ssh_accept_server_host_key_expiration_date-property-sshtunnel-struct) | The date on which the certificate expires. | | [ssh_accept_server_host_key_extended_key_usage](#ssh_accept_server_host_key_extended_key_usage-property-sshtunnel-struct) | A comma-delimited list of extended key usage identifiers. | | [ssh_accept_server_host_key_fingerprint](#ssh_accept_server_host_key_fingerprint-property-sshtunnel-struct) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [ssh_accept_server_host_key_fingerprint_sha1](#ssh_accept_server_host_key_fingerprint_sha1-property-sshtunnel-struct) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [ssh_accept_server_host_key_fingerprint_sha256](#ssh_accept_server_host_key_fingerprint_sha256-property-sshtunnel-struct) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [ssh_accept_server_host_key_issuer](#ssh_accept_server_host_key_issuer-property-sshtunnel-struct) | The issuer of the certificate. | | [ssh_accept_server_host_key_private_key](#ssh_accept_server_host_key_private_key-property-sshtunnel-struct) | The private key of the certificate (if available). | | [ssh_accept_server_host_key_private_key_available](#ssh_accept_server_host_key_private_key_available-property-sshtunnel-struct) | Whether a PrivateKey is available for the selected certificate. | | [ssh_accept_server_host_key_private_key_container](#ssh_accept_server_host_key_private_key_container-property-sshtunnel-struct) | The name of the PrivateKey container for the certificate (if available). | | [ssh_accept_server_host_key_public_key](#ssh_accept_server_host_key_public_key-property-sshtunnel-struct) | The public key of the certificate. | | [ssh_accept_server_host_key_public_key_algorithm](#ssh_accept_server_host_key_public_key_algorithm-property-sshtunnel-struct) | The textual description of the certificate's public key algorithm. | | [ssh_accept_server_host_key_public_key_length](#ssh_accept_server_host_key_public_key_length-property-sshtunnel-struct) | The length of the certificate's public key (in bits). | | [ssh_accept_server_host_key_serial_number](#ssh_accept_server_host_key_serial_number-property-sshtunnel-struct) | The serial number of the certificate encoded as a string. | | [ssh_accept_server_host_key_signature_algorithm](#ssh_accept_server_host_key_signature_algorithm-property-sshtunnel-struct) | The text description of the certificate's signature algorithm. | | [ssh_accept_server_host_key_store](#ssh_accept_server_host_key_store-property-sshtunnel-struct) | The name of the certificate store for the client certificate. | | [ssh_accept_server_host_key_store_password](#ssh_accept_server_host_key_store_password-property-sshtunnel-struct) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. | | [ssh_accept_server_host_key_store_type](#ssh_accept_server_host_key_store_type-property-sshtunnel-struct) | The type of certificate store for this certificate. | | [ssh_accept_server_host_key_subject_alt_names](#ssh_accept_server_host_key_subject_alt_names-property-sshtunnel-struct) | Comma-separated lists of alternative subject names for the certificate. | | [ssh_accept_server_host_key_thumbprint_md5](#ssh_accept_server_host_key_thumbprint_md5-property-sshtunnel-struct) | The MD5 hash of the certificate. | | [ssh_accept_server_host_key_thumbprint_sha1](#ssh_accept_server_host_key_thumbprint_sha1-property-sshtunnel-struct) | The SHA-1 hash of the certificate. | | [ssh_accept_server_host_key_thumbprint_sha256](#ssh_accept_server_host_key_thumbprint_sha256-property-sshtunnel-struct) | The SHA-256 hash of the certificate. | | [ssh_accept_server_host_key_usage](#ssh_accept_server_host_key_usage-property-sshtunnel-struct) | The text description of UsageFlags . | | [ssh_accept_server_host_key_usage_flags](#ssh_accept_server_host_key_usage_flags-property-sshtunnel-struct) | The flags that show intended use for the certificate. | | [ssh_accept_server_host_key_version](#ssh_accept_server_host_key_version-property-sshtunnel-struct) | The certificate's version number. | | [ssh_accept_server_host_key_subject](#ssh_accept_server_host_key_subject-property-sshtunnel-struct) | The subject of the certificate used for client authentication. | | [ssh_accept_server_host_key_encoded](#ssh_accept_server_host_key_encoded-property-sshtunnel-struct) | The certificate (PEM/Base64 encoded). | | [ssh_auth_mode](#ssh_auth_mode-property-sshtunnel-struct) | The authentication method to be used with the struct when calling StartListening or Connect . | | [ssh_cert_effective_date](#ssh_cert_effective_date-property-sshtunnel-struct) | The date on which this certificate becomes valid. | | [ssh_cert_expiration_date](#ssh_cert_expiration_date-property-sshtunnel-struct) | The date on which the certificate expires. | | [ssh_cert_extended_key_usage](#ssh_cert_extended_key_usage-property-sshtunnel-struct) | A comma-delimited list of extended key usage identifiers. | | [ssh_cert_fingerprint](#ssh_cert_fingerprint-property-sshtunnel-struct) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [ssh_cert_fingerprint_sha1](#ssh_cert_fingerprint_sha1-property-sshtunnel-struct) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [ssh_cert_fingerprint_sha256](#ssh_cert_fingerprint_sha256-property-sshtunnel-struct) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [ssh_cert_issuer](#ssh_cert_issuer-property-sshtunnel-struct) | The issuer of the certificate. | | [ssh_cert_private_key](#ssh_cert_private_key-property-sshtunnel-struct) | The private key of the certificate (if available). | | [ssh_cert_private_key_available](#ssh_cert_private_key_available-property-sshtunnel-struct) | Whether a PrivateKey is available for the selected certificate. | | [ssh_cert_private_key_container](#ssh_cert_private_key_container-property-sshtunnel-struct) | The name of the PrivateKey container for the certificate (if available). | | [ssh_cert_public_key](#ssh_cert_public_key-property-sshtunnel-struct) | The public key of the certificate. | | [ssh_cert_public_key_algorithm](#ssh_cert_public_key_algorithm-property-sshtunnel-struct) | The textual description of the certificate's public key algorithm. | | [ssh_cert_public_key_length](#ssh_cert_public_key_length-property-sshtunnel-struct) | The length of the certificate's public key (in bits). | | [ssh_cert_serial_number](#ssh_cert_serial_number-property-sshtunnel-struct) | The serial number of the certificate encoded as a string. | | [ssh_cert_signature_algorithm](#ssh_cert_signature_algorithm-property-sshtunnel-struct) | The text description of the certificate's signature algorithm. | | [ssh_cert_store](#ssh_cert_store-property-sshtunnel-struct) | The name of the certificate store for the client certificate. | | [ssh_cert_store_password](#ssh_cert_store_password-property-sshtunnel-struct) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. | | [ssh_cert_store_type](#ssh_cert_store_type-property-sshtunnel-struct) | The type of certificate store for this certificate. | | [ssh_cert_subject_alt_names](#ssh_cert_subject_alt_names-property-sshtunnel-struct) | Comma-separated lists of alternative subject names for the certificate. | | [ssh_cert_thumbprint_md5](#ssh_cert_thumbprint_md5-property-sshtunnel-struct) | The MD5 hash of the certificate. | | [ssh_cert_thumbprint_sha1](#ssh_cert_thumbprint_sha1-property-sshtunnel-struct) | The SHA-1 hash of the certificate. | | [ssh_cert_thumbprint_sha256](#ssh_cert_thumbprint_sha256-property-sshtunnel-struct) | The SHA-256 hash of the certificate. | | [ssh_cert_usage](#ssh_cert_usage-property-sshtunnel-struct) | The text description of UsageFlags . | | [ssh_cert_usage_flags](#ssh_cert_usage_flags-property-sshtunnel-struct) | The flags that show intended use for the certificate. | | [ssh_cert_version](#ssh_cert_version-property-sshtunnel-struct) | The certificate's version number. | | [ssh_cert_subject](#ssh_cert_subject-property-sshtunnel-struct) | The subject of the certificate used for client authentication. | | [ssh_cert_encoded](#ssh_cert_encoded-property-sshtunnel-struct) | The certificate (PEM/Base64 encoded). | | [ssh_compression_algorithms](#ssh_compression_algorithms-property-sshtunnel-struct) | The comma-separated list containing all allowable compression algorithms. | | [ssh_encryption_algorithms](#ssh_encryption_algorithms-property-sshtunnel-struct) | The comma-separated list containing all allowable encryption algorithms. | | [ssh_forward_host](#ssh_forward_host-property-sshtunnel-struct) | The address of the remote host. Domain names are resolved to IP addresses. | | [ssh_forward_port](#ssh_forward_port-property-sshtunnel-struct) | The Transmission Control Protocol (TCP) port in the remote host. | | [ssh_host](#ssh_host-property-sshtunnel-struct) | The address of the Secure Shell (SSH) host. | | [ssh_password](#ssh_password-property-sshtunnel-struct) | The password for Secure Shell (SSH) password-based authentication. | | [ssh_port](#ssh_port-property-sshtunnel-struct) | The port on the Secure Shell (SSH) server where the SSH service is running; by default, 22. | | [ssh_user](#ssh_user-property-sshtunnel-struct) | The username for Secure Shell (SSH) authentication. | ## Method List *The following is the full list of the methods of the struct with short descriptions. Click on the links for further details.* | | | | --- | --- | | [config](#config-method-sshtunnel-struct) | Sets or retrieves a configuration setting. | | [connect](#connect-method-sshtunnel-struct) | Connects to the Secure Shell (SSH) host without logging in. | | [decode_packet](#decode_packet-method-sshtunnel-struct) | Decodes a hex-encoded Secure Shell (SSH) packet. | | [disconnect](#disconnect-method-sshtunnel-struct) | This method disconnects the specified client. | | [do_events](#do_events-method-sshtunnel-struct) | This method processes events from the internal message queue. | | [encode_packet](#encode_packet-method-sshtunnel-struct) | Hex encodes a Secure Shell (SSH) packet. | | [get_ssh_param](#get_ssh_param-method-sshtunnel-struct) | Reads a field from a Secure Shell (SSH) packet's payload. | | [get_ssh_param_bytes](#get_ssh_param_bytes-method-sshtunnel-struct) | Reads a field from a Secure Shell (SSH) packet's payload. | | [interrupt](#interrupt-method-sshtunnel-struct) | This method interrupts the current method. | | [reset](#reset-method-sshtunnel-struct) | This method will reset the struct. | | [set_ssh_param](#set_ssh_param-method-sshtunnel-struct) | Writes a field to the end of a payload. | | [shutdown](#shutdown-method-sshtunnel-struct) | This method shuts down the server. | | [start_listening](#start_listening-method-sshtunnel-struct) | This method starts listening for incoming connections. | | [stop_listening](#stop_listening-method-sshtunnel-struct) | This method stops listening for new connections. | ## Event List *The following is the full list of the events fired by the struct with short descriptions. Click on the links for further details.* | | | | --- | --- | | [on_connected](#on_connected-event-sshtunnel-struct) | This event is fired immediately after a connection completes (or fails). | | [on_connection_request](#on_connection_request-event-sshtunnel-struct) | This event is fired when a request for connection comes from a remote host. | | [on_data_in](#on_data_in-event-sshtunnel-struct) | This event is fired when data come in. | | [on_disconnected](#on_disconnected-event-sshtunnel-struct) | Fired when a connection is closed. | | [on_error](#on_error-event-sshtunnel-struct) | Fired when errors occur during data delivery. | | [on_log](#on_log-event-sshtunnel-struct) | Fired once for each log message. | | [on_reconnect_attempt](#on_reconnect_attempt-event-sshtunnel-struct) | Fired when attempting to reconnect. | | [on_ssh_custom_auth](#on_ssh_custom_auth-event-sshtunnel-struct) | Fired when the struct is doing a custom authentication. | | [on_ssh_keyboard_interactive](#on_ssh_keyboard_interactive-event-sshtunnel-struct) | Fired when the struct receives a request for user input from the server. | | [on_ssh_server_authentication](#on_ssh_server_authentication-event-sshtunnel-struct) | Fired after the server presents its public key to the client. | | [on_ssh_status](#on_ssh_status-event-sshtunnel-struct) | Fired to track the progress of the secure connection. | ## Config Settings *The following is a list of config settings for the struct with short descriptions. Click on the links for further details.* | | | | --- | --- | | [AutoReconnect](#AutoReconnect) | Whether to automatically reconnect. | | [MaxRetryCount](#MaxRetryCount) | The maximum number of retries when reconnecting. | | [RetryInterval](#RetryInterval) | The interval in seconds between reconnect attempts. | | [ShutdownChannelOnEOF](#ShutdownChannelOnEOF) | Whether the client will shutdown the channel after receiving an EOF packet from the remote host. | | [SSHForwardSocketPath](#SSHForwardSocketPath) | The path to the Unix domain socket where the traffic will be forwarded. | | [ChannelDataEOL\[ChannelId\]](#ChannelDataEOL[ChannelId]) | Used to break the incoming data stream into chunks. | | [ChannelDataEOLFound\[ChannelId\]](#ChannelDataEOLFound[ChannelId]) | Determines if ChannelDataEOL was found. | | [ClientSSHVersionString](#ClientSSHVersionString) | The SSH version string used by the struct. | | [ConnectAndLogin](#ConnectAndLogin) | Whether the struct performs a full SSH login. | | [DoNotRepeatAuthMethods](#DoNotRepeatAuthMethods) | Whether the struct will repeat authentication methods during multifactor authentication. | | [EnablePageantAuth](#EnablePageantAuth) | Whether to use a key stored in Pageant to perform client authentication. | | [KerberosDelegation](#KerberosDelegation) | If true, asks for credentials with delegation enabled during authentication. | | [KerberosRealm](#KerberosRealm) | The fully qualified domain name of the Kerberos Realm to use for GSSAPI authentication. | | [KerberosSPN](#KerberosSPN) | The Kerberos Service Principal Name of the SSH host. | | [KeyRenegotiationThreshold](#KeyRenegotiationThreshold) | Sets the threshold for the SSH Key Renegotiation. | | [LogLevel](#LogLevel) | Specifies the level of detail that is logged. | | [MaxChannelDataLength\[ChannelId\]](#MaxChannelDataLength[ChannelId]) | The maximum amount of data to accumulate when no ChannelDataEOL is found. | | [MaxPacketSize](#MaxPacketSize) | The maximum packet size of the channel, in bytes. | | [MaxWindowSize](#MaxWindowSize) | The maximum window size allowed for the channel, in bytes. | | [NegotiatedStrictKex](#NegotiatedStrictKex) | Returns whether strict key exchange was negotiated to be used. | | [PasswordPrompt](#PasswordPrompt) | The text of the password prompt used in keyboard-interactive authentication. | | [PreferredDHGroupBits](#PreferredDHGroupBits) | The size (in bits) of the preferred modulus (p) to request from the server. | | [RecordLength](#RecordLength) | The length of received data records. | | [ServerSSHVersionString](#ServerSSHVersionString) | The remote host's SSH version string. | | [SignedSSHCert](#SignedSSHCert) | The CA signed client public key used when authenticating. | | [SSHAcceptAnyServerHostKey](#SSHAcceptAnyServerHostKey) | If set the struct will accept any key presented by the server. | | [SSHAcceptServerCAKey](#SSHAcceptServerCAKey) | The CA public key that signed the server's host key. | | [SSHAcceptServerHostKeyFingerPrint](#SSHAcceptServerHostKeyFingerPrint) | The fingerprint(s) of the server host keys to accept. | | [SSHFingerprintEncoding](#SSHFingerprintEncoding) | Specifies the encoding used when displaying the SSH host key fingerprint. | | [SSHFingerprintHashAlgorithm](#SSHFingerprintHashAlgorithm) | The algorithm used to calculate the fingerprint. | | [SSHFingerprintMD5](#SSHFingerprintMD5) | The server hostkey's MD5 fingerprint. | | [SSHFingerprintSHA1](#SSHFingerprintSHA1) | The server hostkey's SHA1 fingerprint. | | [SSHFingerprintSHA256](#SSHFingerprintSHA256) | The server hostkey's SHA256 fingerprint. | | [SSHKeepAliveCountMax](#SSHKeepAliveCountMax) | The maximum number of keep alive packets to send without a response. | | [SSHKeepAliveInterval](#SSHKeepAliveInterval) | The interval between keep alive packets. | | [SSHKeyExchangeAlgorithms](#SSHKeyExchangeAlgorithms) | Specifies the supported key exchange algorithms. | | [SSHKeyRenegotiate](#SSHKeyRenegotiate) | Causes the struct to renegotiate the SSH keys. | | [SSHMacAlgorithms](#SSHMacAlgorithms) | Specifies the supported Mac algorithms. | | [SSHPubKeyAuthSigAlgorithms](#SSHPubKeyAuthSigAlgorithms) | Specifies the enabled signature algorithms that may be used when attempting public key authentication. | | [SSHPublicKeyAlgorithms](#SSHPublicKeyAlgorithms) | Specifies the supported public key algorithms for the server's public key. | | [SSHVersionPattern](#SSHVersionPattern) | The pattern used to match the remote host's version string. | | [TryAllAvailableAuthMethods](#TryAllAvailableAuthMethods) | If set to true, the struct will try all available authentication methods. | | [UseStrictKeyExchange](#UseStrictKeyExchange) | Specifies how strict key exchange is supported. | | [WaitForChannelClose](#WaitForChannelClose) | Whether to wait for channels to be closed before disconnected. | | [WaitForServerDisconnect](#WaitForServerDisconnect) | Whether to wait for the server to close the connection. | | [ConnectionTimeout](#ConnectionTimeout) | Sets a separate timeout value for establishing a connection. | | [FirewallAutoDetect](#FirewallAutoDetect) | Tells the struct whether or not to automatically detect and use firewall system settings, if available. | | [FirewallHost](#FirewallHost) | Name or IP address of firewall (optional). | | [FirewallHTTPVersion](#FirewallHTTPVersion) | The HTTP version to be used when connecting through a tunneling proxy. | | [FirewallPassword](#FirewallPassword) | Password to be used if authentication is to be used when connecting through the firewall. | | [FirewallPort](#FirewallPort) | The TCP port for the FirewallHost;. | | [FirewallType](#FirewallType) | Determines the type of firewall to connect through. | | [FirewallUser](#FirewallUser) | A user name if authentication is to be used connecting through a firewall. | | [KeepAliveInterval](#KeepAliveInterval) | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. | | [KeepAliveTime](#KeepAliveTime) | The inactivity time in milliseconds before a TCP keep-alive packet is sent. | | [Linger](#Linger) | When set to True, connections are terminated gracefully. | | [LingerTime](#LingerTime) | Time in seconds to have the connection linger. | | [LocalHost](#LocalHost) | The name of the local host through which connections are initiated or accepted. | | [LocalPort](#LocalPort) | The port in the local host where the struct binds. | | [MaxLineLength](#MaxLineLength) | The maximum amount of data to accumulate when no EOL is found. | | [MaxTransferRate](#MaxTransferRate) | The transfer rate limit in bytes per second. | | [ProxyExceptionsList](#ProxyExceptionsList) | A semicolon separated list of hosts and IPs to bypass when using a proxy. | | [TCPKeepAlive](#TCPKeepAlive) | Determines whether or not the keep alive socket option is enabled. | | [TcpNoDelay](#TcpNoDelay) | Whether or not to delay when sending packets. | | [UseIPv6](#UseIPv6) | Whether to use IPv6. | | [UseNTLMv2](#UseNTLMv2) | Whether to use NTLM V2. | | [AbsoluteTimeout](#AbsoluteTimeout) | Determines whether timeouts are inactivity timeouts or absolute timeouts. | | [FirewallData](#FirewallData) | Used to send extra data to the firewall. | | [InBufferSize](#InBufferSize) | The size in bytes of the incoming queue of the socket. | | [OutBufferSize](#OutBufferSize) | The size in bytes of the outgoing queue of the socket. | | [AllowedClients](#AllowedClients) | A comma-separated list of host names or IP addresses that can access the struct. | | [BindExclusively](#BindExclusively) | Whether or not the struct considers a local port reserved for exclusive use. | | [BlockedClients](#BlockedClients) | A comma-separated list of host names or IP addresses that cannot access the struct. | | [DefaultConnectionTimeout](#DefaultConnectionTimeout) | The inactivity timeout applied to the SSL handshake. | | [InBufferSize](#InBufferSize) | The size in bytes of the incoming queue of the socket. | | [KeepAliveInterval](#KeepAliveInterval) | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. | | [KeepAliveTime](#KeepAliveTime) | The inactivity time in milliseconds before a TCP keep-alive packet is sent. | | [MaxConnections](#MaxConnections) | The maximum number of connections available. | | [OutBufferSize](#OutBufferSize) | The size in bytes of the outgoing queue of the socket. | | [TcpNoDelay](#TcpNoDelay) | Whether or not to delay when sending packets. | | [UseIPv6](#UseIPv6) | Whether to use IPv6. | | [BuildInfo](#BuildInfo) | Information about the product's build. | | [CodePage](#CodePage) | The system code page used for Unicode to Multibyte translations. | | [LicenseInfo](#LicenseInfo) | Information about the current license. | | [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. | | [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. | # connected property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) Whether the struct is connected. ## Syntax *Rust Syntax* ```text fn connected(&self ) -> Result ``` ## Default Value false ## Remarks This property is used to determine whether or not the struct is connected to the remote host. Use the [connect](#connect-method-sshtunnel-struct) and [disconnect](#disconnect-method-sshtunnel-struct) methods to manage the connection. This property is read-only. ## Data Type bool # connection_backlog property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) This property includes the maximum number of pending connections maintained by the Transmission Control Protocol (TCP)/IP subsystem. ## Syntax *Rust Syntax* ```text fn connection_backlog(&self ) -> Result fn set_connection_backlog(&self, value : i32) -> Option ``` ## 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 # client_count property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) The number of records in the Client arrays. ## Syntax *Rust Syntax* ```text fn client_count(&self ) -> Result ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [client_accept_data](#client_accept_data-property-sshtunnel-struct) - [client_bytes_sent](#client_bytes_sent-property-sshtunnel-struct) - [client_connected](#client_connected-property-sshtunnel-struct) - [client_connection_id](#client_connection_id-property-sshtunnel-struct) - [client_eol](#client_eol-property-sshtunnel-struct) - [client_idle_timeout](#client_idle_timeout-property-sshtunnel-struct) - [client_local_address](#client_local_address-property-sshtunnel-struct) - [client_ready_to_send](#client_ready_to_send-property-sshtunnel-struct) - [client_record_length](#client_record_length-property-sshtunnel-struct) - [client_remote_host](#client_remote_host-property-sshtunnel-struct) - [client_remote_port](#client_remote_port-property-sshtunnel-struct) - [client_single_line_mode](#client_single_line_mode-property-sshtunnel-struct) - [client_timeout](#client_timeout-property-sshtunnel-struct) - [client_user_data](#client_user_data-property-sshtunnel-struct) The array indices start at *0* and end at *client_count - 1*. This property is read-only. ## Data Type i32 # client_accept_data property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) This property indicates whether data reception is currently enabled. ## Syntax *Rust Syntax* ```text fn client_accept_data(&self , ClientId : i32) -> Result ``` ## Default Value true ## Remarks This property indicates whether data reception is currently enabled. When *false*, data reception is disabled and the on_data_in event will not fire for the connection. Use the pause_data and process_data methods to pause and resume data reception. The *ClientId* parameter specifies the index of the item in the array. The size of the array is controlled by the [ClientCount](#client_count-property-sshtunnel-struct) property. This property is read-only. ## Data Type bool # client_bytes_sent property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) This property shows how many bytes were sent after calling Send or SendBytes . ## Syntax *Rust Syntax* ```text fn client_bytes_sent(&self , ClientId : i32) -> Result ``` ## Default Value 0 ## Remarks This property shows how many bytes were sent after calling send or send_bytes. Please see send or send_bytes for more information. NOTE: This property will always return 0 when the struct is operating in the synchronous mode (i.e., the [client_timeout](#client_timeout-property-sshtunnel-struct) property is set to a positive value). The *ClientId* parameter specifies the index of the item in the array. The size of the array is controlled by the [ClientCount](#client_count-property-sshtunnel-struct) property. This property is read-only. ## Data Type i32 # client_connected property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) This property indicates the status of individual connections. ## Syntax *Rust Syntax* ```text fn client_connected(&self , ClientId : i32) -> Result ``` ## 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 *ClientId* parameter specifies the index of the item in the array. The size of the array is controlled by the [ClientCount](#client_count-property-sshtunnel-struct) property. This property is read-only. ## Data Type bool # client_connection_id property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) This property contains an identifier generated by the struct to identify each connection. ## Syntax *Rust Syntax* ```text fn client_connection_id(&self , ClientId : i32) -> Result ``` ## Default Value 0 ## Remarks This property contains an identifier generated by the struct to identify each connection. This identifier is unique to this connection. The *ClientId* parameter specifies the index of the item in the array. The size of the array is controlled by the [ClientCount](#client_count-property-sshtunnel-struct) property. This property is read-only. ## Data Type i32 # client_eol property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) The EOL property is used to define boundaries in the input stream using the value of the property. ## Syntax *Rust Syntax* ```text fn client_eol(&self , ClientId : i32) -> Result, IPWorksSSHError> fn set_client_eol(&self, ClientId : i32, value : Vec) -> Option fn set_client_eol_ref(&self, ClientId : i32, value : &[u8]) -> Option ``` ## Default Value "" ## Remarks The [client_eol](#client_eol-property-sshtunnel-struct) property is used to define boundaries in the input stream using the value of the property. The [client_eol](#client_eol-property-sshtunnel-struct) property is especially useful with ASCII files. By setting it to CRLF (*"\r\n"*) , the incoming ASCII text stream can be split into lines. In this case, one event is fired for each line received (as well as in packet boundaries). The CRLF (*"\r\n"*) . bytes are discarded. The [client_eol](#client_eol-property-sshtunnel-struct) property is a binary string. This means that it can be more than one byte long, and it can contain NULL bytes. When reading the value of the property, if *ConnectionId* does not belong to a valid connection, then NULL will be returned, and the last_error property will contain a corresponding error message. If no error is encountered, then last_error will contain NULL. The *ClientId* parameter specifies the index of the item in the array. The size of the array is controlled by the [ClientCount](#client_count-property-sshtunnel-struct) property. ## Data Type Vec # client_idle_timeout property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) This property contains the idle timeout for this connection. ## Syntax *Rust Syntax* ```text fn client_idle_timeout(&self , ClientId : i32) -> Result fn set_client_idle_timeout(&self, ClientId : i32, value : i32) -> Option ``` ## Default Value 0 ## Remarks This property contains the idle timeout for this connection. This property is similar to default_idle_timeout but may be set on a per-connection basis to override default_idle_timeout. This property specifies the idle timeout (in seconds) for the connected client. 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 to received data within the specified number of seconds. If set to 0 (default), no idle timeout is applied. NOTE: do_events must be called for the struct to check existing connections. The *ClientId* parameter specifies the index of the item in the array. The size of the array is controlled by the [ClientCount](#client_count-property-sshtunnel-struct) property. ## Data Type i32 # client_local_address property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) This property shows the IP address of the interface through which the connection is passing. ## Syntax *Rust Syntax* ```text fn client_local_address(&self , ClientId : i32) -> Result ``` ## Default Value "" ## Remarks This property shows the IP address of the interface through which the connection is passing. [client_local_address](#client_local_address-property-sshtunnel-struct) is important for multihomed hosts so that it can be used to find the particular network interface through which an individual connection is going. The *ClientId* parameter specifies the index of the item in the array. The size of the array is controlled by the [ClientCount](#client_count-property-sshtunnel-struct) property. This property is read-only. ## Data Type String # client_ready_to_send property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) This property indicates whether the struct is ready to send data. ## Syntax *Rust Syntax* ```text fn client_ready_to_send(&self , ClientId : i32) -> Result ``` ## Default Value false ## Remarks This property indicates whether the struct is ready to send data. This is *true* after a client connects but will become *false* after a failed call to send or send_bytes. After a failed call to send or send_bytes, the on_ready_to_send event will fire and this property will be *true* when data can be sent again. The *ClientId* parameter specifies the index of the item in the array. The size of the array is controlled by the [ClientCount](#client_count-property-sshtunnel-struct) property. This property is read-only. ## Data Type bool # client_record_length property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) This property holds the current record length set by ChangeRecordLength . ## Syntax *Rust Syntax* ```text fn client_record_length(&self , ClientId : i32) -> Result ``` ## 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 [client_record_length](#client_record_length-property-sshtunnel-struct) is reached and only then will fire the on_data_in event with the data of length [client_record_length](#client_record_length-property-sshtunnel-struct). 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_data_in event. A value of 0 (default) means this setting is not used. The *ClientId* parameter specifies the index of the item in the array. The size of the array is controlled by the [ClientCount](#client_count-property-sshtunnel-struct) property. This property is read-only. ## Data Type i32 # client_remote_host property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) This property shows the IP address of the remote host through which the connection is coming. ## Syntax *Rust Syntax* ```text fn client_remote_host(&self , ClientId : i32) -> Result ``` ## Default Value "" ## Remarks This property 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 *ClientId* parameter specifies the index of the item in the array. The size of the array is controlled by the [ClientCount](#client_count-property-sshtunnel-struct) property. This property is read-only. ## Data Type String # client_remote_port property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) This property shows the Transmission Control Protocol (TCP) port on the remote host through which the connection is coming. ## Syntax *Rust Syntax* ```text fn client_remote_port(&self , ClientId : i32) -> Result ``` ## Default Value 0 ## Remarks This property 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 *ClientId* parameter specifies the index of the item in the array. The size of the array is controlled by the [ClientCount](#client_count-property-sshtunnel-struct) property. This property is read-only. ## Data Type i32 # client_single_line_mode property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) This property shows the special mode for line-oriented protocols. ## Syntax *Rust Syntax* ```text fn client_single_line_mode(&self , ClientId : i32) -> Result fn set_client_single_line_mode(&self, ClientId : i32, value : bool) -> Option ``` ## Default Value false ## Remarks This property shows the special mode for line-oriented protocols. When single_line_mode is True, the struct treats the incoming data stream as lines separated by carriage return (CR), line feed (LF), or CRLF. The eol property is ignored. The *ClientId* parameter specifies the index of the item in the array. The size of the array is controlled by the [ClientCount](#client_count-property-sshtunnel-struct) property. ## Data Type bool # client_timeout property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) This property specifies a timeout for the struct. ## Syntax *Rust Syntax* ```text fn client_timeout(&self , ClientId : i32) -> Result fn set_client_timeout(&self, ClientId : i32, value : i32) -> Option ``` ## Default Value 0 ## Remarks This property specifies a timeout for the struct. If the [client_timeout](#client_timeout-property-sshtunnel-struct) property is set to 0, all operations return immediately, potentially failing with a *WOULDBLOCK* error if data cannot be sent immediately. If [client_timeout](#client_timeout-property-sshtunnel-struct) is set to a positive value, data is sent in a blocking manner and the struct will wait for the operation to complete before returning control. The struct will handle any potential *WOULDBLOCK* errors internally and automatically retry the operation for a maximum of [client_timeout](#client_timeout-property-sshtunnel-struct) 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 [client_timeout](#client_timeout-property-sshtunnel-struct) property is 0 (asynchronous operation). The *ClientId* parameter specifies the index of the item in the array. The size of the array is controlled by the [ClientCount](#client_count-property-sshtunnel-struct) property. ## Data Type i32 # client_user_data property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) The UserData property holds connection-specific user-specified data. ## Syntax *Rust Syntax* ```text fn client_user_data(&self , ClientId : i32) -> Result, IPWorksSSHError> fn set_client_user_data(&self, ClientId : i32, value : Vec) -> Option fn set_client_user_data_ref(&self, ClientId : i32, value : &[u8]) -> Option ``` ## Default Value "" ## Remarks The [client_user_data](#client_user_data-property-sshtunnel-struct) property holds connection-specific user-specified data. User-specified data may be set or retrieved at any point while the connection is valid. This provides a simple way to associate arbitrary data with a specific connection. The *ClientId* parameter specifies the index of the item in the array. The size of the array is controlled by the [ClientCount](#client_count-property-sshtunnel-struct) property. ## Data Type Vec # default_eol property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) This property includes a default end-of-line (EOL) value to be used by incoming connections. ## Syntax *Rust Syntax* ```text fn default_eol(&self ) -> Result, IPWorksSSHError> fn set_default_eol(&self, value : Vec) -> Option fn set_default_eol_ref(&self, value : &[u8]) -> Option ``` ## Default Value "" ## Remarks This property contains a default end-of-line (EOL) value to be used by incoming connections. Once the struct accepts and establishes an inbound connection, it will set that connection's EOL to the value in this property. By default, this value is empty (""), meaning that data will be fired as it is received. ## Data Type Vec # default_single_line_mode property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) This property tells the struct whether or not to treat new connections as line oriented. ## Syntax *Rust Syntax* ```text fn default_single_line_mode(&self ) -> Result fn set_default_single_line_mode(&self, value : bool) -> Option ``` ## Default Value false ## Remarks This property instructs the component whether or not to treat newly established connections as line-oriented protocols. If this value is True, newly accepted connections will read the incoming data stream as lines separated by a carriage return line feed (CRLF), carriage return (CR), or line feed (LF) and will ignore the end of lines (EOLs). ## Data Type bool # default_timeout property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) This property includes an initial timeout value to be used by incoming connections. ## Syntax *Rust Syntax* ```text fn default_timeout(&self ) -> Result fn set_default_timeout(&self, value : i32) -> Option ``` ## Default Value 0 ## Remarks This property is used by the struct to set the operational timeout value of all inbound connections once they are established. By default, the timeout is 0, meaning that all inbound connections will behave asynchronously. ## Data Type i32 # firewall_auto_detect property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) Whether to automatically detect and use firewall system settings, if available. ## Syntax *Rust Syntax* ```text fn firewall_auto_detect(&self ) -> Result fn set_firewall_auto_detect(&self, value : bool) -> Option ``` ## Default Value false ## Remarks Whether to automatically detect and use firewall system settings, if available. ## Data Type bool # firewall_type property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) The type of firewall to connect through. ## Syntax *Rust Syntax* ```text fn firewall_type(&self ) -> Result fn set_firewall_type(&self, value : i32) -> Option ``` ## Possible Values ```text 0 // None1 // Tunnel2 // SOCKS43 // SOCKS510 // SOCKS4A ``` ## Default Value 0 ## Remarks The type of firewall to connect through. The applicable values are as follows: | | | | --- | --- | | fwNone (0) | No firewall (default setting). | | fwTunnel (1) | Connect through a tunneling proxy. [firewall_port](#firewall_port-property-sshtunnel-struct) is set to 80. | | fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. [firewall_port](#firewall_port-property-sshtunnel-struct) is set to 1080. | | fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. [firewall_port](#firewall_port-property-sshtunnel-struct) is set to 1080. | | fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. [firewall_port](#firewall_port-property-sshtunnel-struct) is set to 1080. | ## Data Type i32 # firewall_host property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) The name or IP address of the firewall (optional). ## Syntax *Rust Syntax* ```text fn firewall_host(&self ) -> Result fn set_firewall_host(&self, value : &str) -> Option fn set_firewall_host_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks The name or IP address of the firewall (optional). If a [firewall_host](#firewall_host-property-sshtunnel-struct) is given, the requested connections will be authenticated through the specified firewall when connecting. If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the struct fails with an error. ## Data Type String # firewall_password property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) A password if authentication is to be used when connecting through the firewall. ## Syntax *Rust Syntax* ```text fn firewall_password(&self ) -> Result fn set_firewall_password(&self, value : &str) -> Option fn set_firewall_password_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks A password if authentication is to be used when connecting through the firewall. If [firewall_host](#firewall_host-property-sshtunnel-struct) is specified, the [firewall_user](#firewall_user-property-sshtunnel-struct) and [firewall_password](#firewall_password-property-sshtunnel-struct) properties are used to connect and authenticate to the given firewall. If the authentication fails, the struct fails with an error. ## Data Type String # firewall_port property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) The Transmission Control Protocol (TCP) port for the firewall Host . ## Syntax *Rust Syntax* ```text fn firewall_port(&self ) -> Result fn set_firewall_port(&self, value : i32) -> Option ``` ## Default Value 0 ## Remarks The Transmission Control Protocol (TCP) port for the firewall [firewall_host](#firewall_host-property-sshtunnel-struct). See the description of the [firewall_host](#firewall_host-property-sshtunnel-struct) property for details. NOTE: This property is set automatically when [firewall_firewall_type](#SSHTunnel_p_FirewallFirewallType) is set to a valid value. See the description of the [firewall_firewall_type](#SSHTunnel_p_FirewallFirewallType) property for details. ## Data Type i32 # firewall_user property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) A username if authentication is to be used when connecting through a firewall. ## Syntax *Rust Syntax* ```text fn firewall_user(&self ) -> Result fn set_firewall_user(&self, value : &str) -> Option fn set_firewall_user_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks A username if authentication is to be used when connecting through a firewall. If [firewall_host](#firewall_host-property-sshtunnel-struct) is specified, this property and the [firewall_password](#firewall_password-property-sshtunnel-struct) property are used to connect and authenticate to the given [Firewall](#Type_Firewall). If the authentication fails, the struct fails with an error. ## Data Type String # keep_alive property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) When True, KEEPALIVE packets are enabled (for long connections). ## Syntax *Rust Syntax* ```text fn keep_alive(&self ) -> Result fn set_keep_alive(&self, value : bool) -> Option ``` ## Default Value false ## Remarks This property enables the SO_KEEPALIVE option on the incoming connections. This option prevents long connections from timing out in case of inactivity. NOTE: System Transmission Control Protocol (TCP)/IP stack implementations are not required to support SO_KEEPALIVE. This property is shared among incoming connections. When the property is set, the corresponding value is set for incoming connections as they are accepted. Existing connections are not modified. ## Data Type bool # linger property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) When set to True, connections are terminated gracefully. ## Syntax *Rust Syntax* ```text fn linger(&self ) -> Result fn set_linger(&self, value : bool) -> Option ``` ## Default Value true ## Remarks This property controls how a connection is closed. The default is True. In this case, the connection is closed only after all the data are sent. Setting it to False forces an abrupt (hard) disconnection. Any data that were in the sending queue may be lost. The default behavior (which is also the default mode for stream sockets) might result in an indefinite delay in closing the connection. Although the struct returns control immediately, the system might indefinitely hold system resources until all pending data are sent (even after your application closes). This means that valuable system resources might be wasted. Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you have sent (e.g., by a client acknowledgment), then setting this property to False might be the appropriate course of action. This property is shared among incoming connections. When the property is set, the corresponding value is set for incoming connections as they are accepted. Existing connections are not modified. ## Data Type bool # listening property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) This property indicates whether the struct is listening for incoming connections on LocalPort. ## Syntax *Rust Syntax* ```text fn listening(&self ) -> Result ``` ## Default Value false ## Remarks This property indicates whether the struct is listening for connections on the port specified by the [local_port](#local_port-property-sshtunnel-struct) property. Use the [start_listening](#start_listening-method-sshtunnel-struct) and [stop_listening](#stop_listening-method-sshtunnel-struct) methods to control whether the struct is listening. This property is read-only. ## Data Type bool # local_host property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) The name of the local host or user-assigned IP interface through which connections are initiated or accepted. ## Syntax *Rust Syntax* ```text fn local_host(&self ) -> Result fn set_local_host(&self, value : &str) -> Option fn set_local_host_ref(&self, value : &String) -> Option ``` ## 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 ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) The TCP port in the local host where the struct binds. ## Syntax *Rust Syntax* ```text fn local_port(&self ) -> Result fn set_local_port(&self, value : i32) -> Option ``` ## Default Value 0 ## Remarks This property must be set before the struct can start 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 this property after the struct is listening (i.e., after successfully assigning True to the [listening](#listening-property-sshtunnel-struct) property). The service port is not shared among servers so two structs cannot be listening on the same port at the same time. This property must be set before a connection is attempted. It instructs the struct to bind to a specific port (or communication endpoint) in the local machine. Setting this property to 0 (default) enables the system to choose an open port at random. The chosen port will be returned by the local_port property after the connection is established. local_port cannot be changed once a connection is made. Any attempt to set this property when a connection is active will generate an error. This property is useful when trying to connect to services that require a trusted port on the client side. ## Data Type i32 # ssh_accept_server_host_key_effective_date property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) The date on which this certificate becomes valid. ## Syntax *Rust Syntax* ```text fn ssh_accept_server_host_key_effective_date(&self ) -> Result ``` ## 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. This property is read-only. ## Data Type String # ssh_accept_server_host_key_expiration_date property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) The date on which the certificate expires. ## Syntax *Rust Syntax* ```text fn ssh_accept_server_host_key_expiration_date(&self ) -> Result ``` ## 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. This property is read-only. ## Data Type String # ssh_accept_server_host_key_extended_key_usage property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) A comma-delimited list of extended key usage identifiers. ## Syntax *Rust Syntax* ```text fn ssh_accept_server_host_key_extended_key_usage(&self ) -> Result ``` ## Default Value "" ## Remarks A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). This property is read-only. ## Data Type String # ssh_accept_server_host_key_fingerprint property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn ssh_accept_server_host_key_fingerprint(&self ) -> Result ``` ## 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* This property is read-only. ## Data Type String # ssh_accept_server_host_key_fingerprint_sha1 property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn ssh_accept_server_host_key_fingerprint_sha1(&self ) -> Result ``` ## 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* This property is read-only. ## Data Type String # ssh_accept_server_host_key_fingerprint_sha256 property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn ssh_accept_server_host_key_fingerprint_sha256(&self ) -> Result ``` ## 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* This property is read-only. ## Data Type String # ssh_accept_server_host_key_issuer property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) The issuer of the certificate. ## Syntax *Rust Syntax* ```text fn ssh_accept_server_host_key_issuer(&self ) -> Result ``` ## Default Value "" ## Remarks The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate. This property is read-only. ## Data Type String # ssh_accept_server_host_key_private_key property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) The private key of the certificate (if available). ## Syntax *Rust Syntax* ```text fn ssh_accept_server_host_key_private_key(&self ) -> Result ``` ## Default Value "" ## Remarks The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [ssh_accept_server_host_key_private_key](#ssh_accept_server_host_key_private_key-property-sshtunnel-struct) may be available but not exportable. In this case, [ssh_accept_server_host_key_private_key](#ssh_accept_server_host_key_private_key-property-sshtunnel-struct) returns an empty string. This property is read-only. ## Data Type String # ssh_accept_server_host_key_private_key_available property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) Whether a PrivateKey is available for the selected certificate. ## Syntax *Rust Syntax* ```text fn ssh_accept_server_host_key_private_key_available(&self ) -> Result ``` ## Default Value false ## Remarks Whether a [ssh_accept_server_host_key_private_key](#ssh_accept_server_host_key_private_key-property-sshtunnel-struct) is available for the selected certificate. If [ssh_accept_server_host_key_private_key_available](#ssh_accept_server_host_key_private_key_available-property-sshtunnel-struct) is True, the certificate may be used for authentication purposes (e.g., server authentication). This property is read-only. ## Data Type bool # ssh_accept_server_host_key_private_key_container property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) The name of the PrivateKey container for the certificate (if available). ## Syntax *Rust Syntax* ```text fn ssh_accept_server_host_key_private_key_container(&self ) -> Result ``` ## Default Value "" ## Remarks The name of the [ssh_accept_server_host_key_private_key](#ssh_accept_server_host_key_private_key-property-sshtunnel-struct) container for the certificate (if available). This functionality is available only on Windows platforms. This property is read-only. ## Data Type String # ssh_accept_server_host_key_public_key property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) The public key of the certificate. ## Syntax *Rust Syntax* ```text fn ssh_accept_server_host_key_public_key(&self ) -> Result ``` ## Default Value "" ## Remarks The public key of the certificate. The key is provided as PEM/Base64-encoded data. This property is read-only. ## Data Type String # ssh_accept_server_host_key_public_key_algorithm property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) The textual description of the certificate's public key algorithm. ## Syntax *Rust Syntax* ```text fn ssh_accept_server_host_key_public_key_algorithm(&self ) -> Result ``` ## 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. This property is read-only. ## Data Type String # ssh_accept_server_host_key_public_key_length property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) The length of the certificate's public key (in bits). ## Syntax *Rust Syntax* ```text fn ssh_accept_server_host_key_public_key_length(&self ) -> Result ``` ## Default Value 0 ## Remarks The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. This property is read-only. ## Data Type i32 # ssh_accept_server_host_key_serial_number property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) The serial number of the certificate encoded as a string. ## Syntax *Rust Syntax* ```text fn ssh_accept_server_host_key_serial_number(&self ) -> Result ``` ## 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. This property is read-only. ## Data Type String # ssh_accept_server_host_key_signature_algorithm property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) The text description of the certificate's signature algorithm. ## Syntax *Rust Syntax* ```text fn ssh_accept_server_host_key_signature_algorithm(&self ) -> Result ``` ## 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. This property is read-only. ## Data Type String # ssh_accept_server_host_key_store property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) The name of the certificate store for the client certificate. ## Syntax *Rust Syntax* ```text fn ssh_accept_server_host_key_store(&self ) -> Result, IPWorksSSHError> fn set_ssh_accept_server_host_key_store(&self, value : Vec) -> Option fn set_ssh_accept_server_host_key_store_ref(&self, value : &[u8]) -> Option ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [ssh_accept_server_host_key_store_type](#ssh_accept_server_host_key_store_type-property-sshtunnel-struct) property denotes the type of the certificate store specified by [ssh_accept_server_host_key_store](#ssh_accept_server_host_key_store-property-sshtunnel-struct). If the store is password-protected, specify the password in [ssh_accept_server_host_key_store_password](#ssh_accept_server_host_key_store_password-property-sshtunnel-struct). [ssh_accept_server_host_key_store](#ssh_accept_server_host_key_store-property-sshtunnel-struct) is used in conjunction with the [ssh_accept_server_host_key_subject](#ssh_accept_server_host_key_subject-property-sshtunnel-struct) property to specify client certificates. If [ssh_accept_server_host_key_store](#ssh_accept_server_host_key_store-property-sshtunnel-struct) has a value, and [ssh_accept_server_host_key_subject](#ssh_accept_server_host_key_subject-property-sshtunnel-struct) or [ssh_accept_server_host_key_encoded](#ssh_accept_server_host_key_encoded-property-sshtunnel-struct) is set, a search for a certificate is initiated. Please see the [ssh_accept_server_host_key_subject](#ssh_accept_server_host_key_subject-property-sshtunnel-struct) property for details. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | 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). ## Data Type Vec # ssh_accept_server_host_key_store_password property ([SSHTunnel](#struct-ipworkssshsshtunnel) 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 *Rust Syntax* ```text fn ssh_accept_server_host_key_store_password(&self ) -> Result fn set_ssh_accept_server_host_key_store_password(&self, value : &str) -> Option fn set_ssh_accept_server_host_key_store_password_ref(&self, value : &String) -> Option ``` ## 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. ## Data Type String # ssh_accept_server_host_key_store_type property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) The type of certificate store for this certificate. ## Syntax *Rust Syntax* ```text fn ssh_accept_server_host_key_store_type(&self ) -> Result fn set_ssh_accept_server_host_key_store_type(&self, value : i32) -> Option ``` ## Possible Values ```text 0 // User1 // Machine2 // PFXFile3 // PFXBlob4 // JKSFile5 // JKSBlob6 // PEMKeyFile7 // PEMKeyBlob8 // PublicKeyFile9 // PublicKeyBlob10 // SSHPublicKeyBlob11 // P7BFile12 // P7BBlob13 // SSHPublicKeyFile14 // PPKFile15 // PPKBlob16 // XMLFile17 // XMLBlob18 // JWKFile19 // JWKBlob20 // SecurityKey21 // BCFKSFile22 // BCFKSBlob23 // PKCS1199 // 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: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. | | 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. | | 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. | | 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. | | 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. | | 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. | | 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. | | 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. | | 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. | | 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. | | 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. | | 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. | | 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. | | 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. | | 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). | | 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). | | 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. | | 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. | | 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). | | 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). | | 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. | | 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. | | 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [ssh_accept_server_host_key_store_type](#ssh_accept_server_host_key_store_type-property-sshtunnel-struct), the full path of the PKCS#11 DLL as the [ssh_accept_server_host_key_store](#ssh_accept_server_host_key_store-property-sshtunnel-struct), and the PIN as the [ssh_accept_server_host_key_store_password](#ssh_accept_server_host_key_store_password-property-sshtunnel-struct). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) struct by calling the [list_store_certificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [on_cert_list](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [ssh_accept_server_host_key_store](#ssh_accept_server_host_key_store-property-sshtunnel-struct) and set [ssh_accept_server_host_key_store_password](#ssh_accept_server_host_key_store_password-property-sshtunnel-struct) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. | ## Data Type i32 # ssh_accept_server_host_key_subject_alt_names property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) Comma-separated lists of alternative subject names for the certificate. ## Syntax *Rust Syntax* ```text fn ssh_accept_server_host_key_subject_alt_names(&self ) -> Result ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. This property is read-only. ## Data Type String # ssh_accept_server_host_key_thumbprint_md5 property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) The MD5 hash of the certificate. ## Syntax *Rust Syntax* ```text fn ssh_accept_server_host_key_thumbprint_md5(&self ) -> Result ``` ## 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. This property is read-only. ## Data Type String # ssh_accept_server_host_key_thumbprint_sha1 property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) The SHA-1 hash of the certificate. ## Syntax *Rust Syntax* ```text fn ssh_accept_server_host_key_thumbprint_sha1(&self ) -> Result ``` ## 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. This property is read-only. ## Data Type String # ssh_accept_server_host_key_thumbprint_sha256 property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) The SHA-256 hash of the certificate. ## Syntax *Rust Syntax* ```text fn ssh_accept_server_host_key_thumbprint_sha256(&self ) -> Result ``` ## 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. This property is read-only. ## Data Type String # ssh_accept_server_host_key_usage property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) The text description of UsageFlags . ## Syntax *Rust Syntax* ```text fn ssh_accept_server_host_key_usage(&self ) -> Result ``` ## Default Value "" ## Remarks The text description of [ssh_accept_server_host_key_usage_flags](#ssh_accept_server_host_key_usage_flags-property-sshtunnel-struct). 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. This property is read-only. ## Data Type String # ssh_accept_server_host_key_usage_flags property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) The flags that show intended use for the certificate. ## Syntax *Rust Syntax* ```text fn ssh_accept_server_host_key_usage_flags(&self ) -> Result ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [ssh_accept_server_host_key_usage_flags](#ssh_accept_server_host_key_usage_flags-property-sshtunnel-struct) is a combination of the following flags: | | | | --- | --- | | 0x80 | Digital Signature | | 0x40 | Non-Repudiation | | 0x20 | Key Encipherment | | 0x10 | Data Encipherment | | 0x08 | Key Agreement | | 0x04 | Certificate Signing | | 0x02 | CRL Signing | | 0x01 | Encipher Only | Please see the [ssh_accept_server_host_key_usage](#ssh_accept_server_host_key_usage-property-sshtunnel-struct) property for a text representation of [ssh_accept_server_host_key_usage_flags](#ssh_accept_server_host_key_usage_flags-property-sshtunnel-struct). This functionality currently is not available when the provider is OpenSSL. This property is read-only. ## Data Type i32 # ssh_accept_server_host_key_version property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) The certificate's version number. ## Syntax *Rust Syntax* ```text fn ssh_accept_server_host_key_version(&self ) -> Result ``` ## Default Value "" ## Remarks The certificate's version number. The possible values are the strings "V1", "V2", and "V3". This property is read-only. ## Data Type String # ssh_accept_server_host_key_subject property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) The subject of the certificate used for client authentication. ## Syntax *Rust Syntax* ```text fn ssh_accept_server_host_key_subject(&self ) -> Result fn set_ssh_accept_server_host_key_subject(&self, value : &str) -> Option fn set_ssh_accept_server_host_key_subject_ref(&self, value : &String) -> Option ``` ## 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: | Field | Meaning | | --- | --- | | CN | Common Name. This is commonly a hostname like www.server.com. | | O | Organization | | OU | Organizational Unit | | L | Locality | | S | State | | C | Country | | E | Email Address | If a field value contains a comma, it must be quoted. ## Data Type String # ssh_accept_server_host_key_encoded property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) The certificate (PEM/Base64 encoded). ## Syntax *Rust Syntax* ```text fn ssh_accept_server_host_key_encoded(&self ) -> Result, IPWorksSSHError> fn set_ssh_accept_server_host_key_encoded(&self, value : Vec) -> Option fn set_ssh_accept_server_host_key_encoded_ref(&self, value : &[u8]) -> Option ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [ssh_accept_server_host_key_store](#ssh_accept_server_host_key_store-property-sshtunnel-struct) and [ssh_accept_server_host_key_subject](#ssh_accept_server_host_key_subject-property-sshtunnel-struct) properties also may be used to specify a certificate. When [ssh_accept_server_host_key_encoded](#ssh_accept_server_host_key_encoded-property-sshtunnel-struct) is set, a search is initiated in the current [ssh_accept_server_host_key_store](#ssh_accept_server_host_key_store-property-sshtunnel-struct) for the private key of the certificate. If the key is found, [ssh_accept_server_host_key_subject](#ssh_accept_server_host_key_subject-property-sshtunnel-struct) is updated to reflect the full subject of the selected certificate; otherwise, [ssh_accept_server_host_key_subject](#ssh_accept_server_host_key_subject-property-sshtunnel-struct) is set to an empty string. ## Data Type Vec # ssh_auth_mode property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) The authentication method to be used with the struct when calling StartListening or Connect . ## Syntax *Rust Syntax* ```text fn ssh_auth_mode(&self ) -> Result fn set_ssh_auth_mode(&self, value : i32) -> Option ``` ## Possible Values ```text 0 // None1 // MultiFactor2 // Password3 // PublicKey4 // KeyboardInteractive5 // GSSAPIWithMic6 // GSSAPIKeyex99 // Custom ``` ## Default Value 2 ## Remarks The Secure Shell (SSH) Authentication specification (RFC 4252) specifies multiple methods by which a user can be authenticated by an SSH server. When a call is made to [start_listening](#start_listening-method-sshtunnel-struct) or [connect](#connect-method-sshtunnel-struct), the struct will connect to the SSH server and establish the security layer. After the connection has been secured, the client will send an authentication request to the [ssh_host](#ssh_host-property-sshtunnel-struct) containing the [ssh_user](#ssh_user-property-sshtunnel-struct). The server will respond containing a list of methods by which that user may be authenticated. The struct will attempt to authenticate the user by one of those methods based on the value of ssh_auth_mode and other property values supplied by the user. Currently, the struct supports the following authentication methods: | | | | --- | --- | | amNone (0) | No authentication will be performed. The current [ssh_user](#ssh_user-property-sshtunnel-struct) value is ignored, and the connection will be logged as anonymous. | | amMultiFactor (1) | This allows the struct to attempt a multistep authentication process. The struct will send authentication data to the server based on the list of methods allowed for the current user and the authentication property values supplied. The struct will continue to send authentication data until the server acknowledges authentication success. If the server rejects an authentication step, the struct fails with an error. | | amPassword (2) | The struct will use the values of [ssh_user](#ssh_user-property-sshtunnel-struct) and [ssh_password](#ssh_password-property-sshtunnel-struct) to authenticate the user. | | amPublicKey (3) | The struct will use the values of [ssh_user](#ssh_user-property-sshtunnel-struct) and the ssh_cert* properties to authenticate the user. the ssh_cert* properties must have a private key available for this authentication method to succeed. | | amKeyboardInteractive (4) | At the time of authentication, the struct will fire the [on_ssh_keyboard_interactive](#on_ssh_keyboard_interactive-event-sshtunnel-struct) event containing instructions on how to complete the authentication step. NOTE: amKeyboardInteractive is not supported in SSHTunnel. | | amGSSAPIWithMic (5) | This allows the struct to attempt Kerberos authentication using the GSSAPI-WITH-MIC scheme. The client will try Kerberos authentication using the value of [ssh_user](#ssh_user-property-sshtunnel-struct) (single sign-on), or if [ssh_password](#ssh_password-property-sshtunnel-struct) is specified as well, it will try Kerberos authentication with alternate credentials. This is currently supported only on Windows, unless using the Java edition, which also provides support for Linux and macOS. | | amGSSAPIKeyex (6) | This allows the struct to attempt Kerberos authentication using the GSSAPIKeyex scheme. The client will try Kerberos authentication using the value of [ssh_user](#ssh_user-property-sshtunnel-struct) (single sign-on), or if [ssh_password](#ssh_password-property-sshtunnel-struct) is specified as well, it will try Kerberos authentication with alternate credentials. This is currently supported only on Windows, unless using the Java edition, which also provides support for Linux and macOS. | | amCustom (99) | This allows the struct caller to take over the authentication process completely. When amCustom is set, the struct will fire the [on_ssh_custom_auth](#on_ssh_custom_auth-event-sshtunnel-struct) event as necessary to complete the authentication process. | **Example 1. User/Password Authentication:** ```text Control.SSHAuthMode = SftpSSHAuthModes.amPassword Control.SSHUser = "username" Control.SSHPassword = "password" Control.StartListening() ``` **Example 2. Public Key Authentication:** ```text Control.SSHAuthMode = SftpSSHAuthModes.amPublicKey Control.SSHUser = "username" Control.SSHCertStoreType = SSHCertStoreTypes.cstPFXFile; Control.SSHCertStore = "cert.pfx"; Control.SSHCertStorePassword = "certpassword"; Control.SSHCertSubject = "*"; Control.StartListening() ``` ## Data Type i32 # ssh_cert_effective_date property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) The date on which this certificate becomes valid. ## Syntax *Rust Syntax* ```text fn ssh_cert_effective_date(&self ) -> Result ``` ## 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. This property is read-only. ## Data Type String # ssh_cert_expiration_date property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) The date on which the certificate expires. ## Syntax *Rust Syntax* ```text fn ssh_cert_expiration_date(&self ) -> Result ``` ## 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. This property is read-only. ## Data Type String # ssh_cert_extended_key_usage property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) A comma-delimited list of extended key usage identifiers. ## Syntax *Rust Syntax* ```text fn ssh_cert_extended_key_usage(&self ) -> Result ``` ## Default Value "" ## Remarks A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). This property is read-only. ## Data Type String # ssh_cert_fingerprint property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn ssh_cert_fingerprint(&self ) -> Result ``` ## 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* This property is read-only. ## Data Type String # ssh_cert_fingerprint_sha1 property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn ssh_cert_fingerprint_sha1(&self ) -> Result ``` ## 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* This property is read-only. ## Data Type String # ssh_cert_fingerprint_sha256 property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn ssh_cert_fingerprint_sha256(&self ) -> Result ``` ## 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* This property is read-only. ## Data Type String # ssh_cert_issuer property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) The issuer of the certificate. ## Syntax *Rust Syntax* ```text fn ssh_cert_issuer(&self ) -> Result ``` ## Default Value "" ## Remarks The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate. This property is read-only. ## Data Type String # ssh_cert_private_key property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) The private key of the certificate (if available). ## Syntax *Rust Syntax* ```text fn ssh_cert_private_key(&self ) -> Result ``` ## Default Value "" ## Remarks The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [ssh_cert_private_key](#ssh_cert_private_key-property-sshtunnel-struct) may be available but not exportable. In this case, [ssh_cert_private_key](#ssh_cert_private_key-property-sshtunnel-struct) returns an empty string. This property is read-only. ## Data Type String # ssh_cert_private_key_available property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) Whether a PrivateKey is available for the selected certificate. ## Syntax *Rust Syntax* ```text fn ssh_cert_private_key_available(&self ) -> Result ``` ## Default Value false ## Remarks Whether a [ssh_cert_private_key](#ssh_cert_private_key-property-sshtunnel-struct) is available for the selected certificate. If [ssh_cert_private_key_available](#ssh_cert_private_key_available-property-sshtunnel-struct) is True, the certificate may be used for authentication purposes (e.g., server authentication). This property is read-only. ## Data Type bool # ssh_cert_private_key_container property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) The name of the PrivateKey container for the certificate (if available). ## Syntax *Rust Syntax* ```text fn ssh_cert_private_key_container(&self ) -> Result ``` ## Default Value "" ## Remarks The name of the [ssh_cert_private_key](#ssh_cert_private_key-property-sshtunnel-struct) container for the certificate (if available). This functionality is available only on Windows platforms. This property is read-only. ## Data Type String # ssh_cert_public_key property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) The public key of the certificate. ## Syntax *Rust Syntax* ```text fn ssh_cert_public_key(&self ) -> Result ``` ## Default Value "" ## Remarks The public key of the certificate. The key is provided as PEM/Base64-encoded data. This property is read-only. ## Data Type String # ssh_cert_public_key_algorithm property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) The textual description of the certificate's public key algorithm. ## Syntax *Rust Syntax* ```text fn ssh_cert_public_key_algorithm(&self ) -> Result ``` ## 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. This property is read-only. ## Data Type String # ssh_cert_public_key_length property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) The length of the certificate's public key (in bits). ## Syntax *Rust Syntax* ```text fn ssh_cert_public_key_length(&self ) -> Result ``` ## Default Value 0 ## Remarks The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. This property is read-only. ## Data Type i32 # ssh_cert_serial_number property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) The serial number of the certificate encoded as a string. ## Syntax *Rust Syntax* ```text fn ssh_cert_serial_number(&self ) -> Result ``` ## 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. This property is read-only. ## Data Type String # ssh_cert_signature_algorithm property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) The text description of the certificate's signature algorithm. ## Syntax *Rust Syntax* ```text fn ssh_cert_signature_algorithm(&self ) -> Result ``` ## 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. This property is read-only. ## Data Type String # ssh_cert_store property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) The name of the certificate store for the client certificate. ## Syntax *Rust Syntax* ```text fn ssh_cert_store(&self ) -> Result, IPWorksSSHError> fn set_ssh_cert_store(&self, value : Vec) -> Option fn set_ssh_cert_store_ref(&self, value : &[u8]) -> Option ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [ssh_cert_store_type](#ssh_cert_store_type-property-sshtunnel-struct) property denotes the type of the certificate store specified by [ssh_cert_store](#ssh_cert_store-property-sshtunnel-struct). If the store is password-protected, specify the password in [ssh_cert_store_password](#ssh_cert_store_password-property-sshtunnel-struct). [ssh_cert_store](#ssh_cert_store-property-sshtunnel-struct) is used in conjunction with the [ssh_cert_subject](#ssh_cert_subject-property-sshtunnel-struct) property to specify client certificates. If [ssh_cert_store](#ssh_cert_store-property-sshtunnel-struct) has a value, and [ssh_cert_subject](#ssh_cert_subject-property-sshtunnel-struct) or [ssh_cert_encoded](#ssh_cert_encoded-property-sshtunnel-struct) is set, a search for a certificate is initiated. Please see the [ssh_cert_subject](#ssh_cert_subject-property-sshtunnel-struct) property for details. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | 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). ## Data Type Vec # ssh_cert_store_password property ([SSHTunnel](#struct-ipworkssshsshtunnel) 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 *Rust Syntax* ```text fn ssh_cert_store_password(&self ) -> Result fn set_ssh_cert_store_password(&self, value : &str) -> Option fn set_ssh_cert_store_password_ref(&self, value : &String) -> Option ``` ## 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. ## Data Type String # ssh_cert_store_type property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) The type of certificate store for this certificate. ## Syntax *Rust Syntax* ```text fn ssh_cert_store_type(&self ) -> Result fn set_ssh_cert_store_type(&self, value : i32) -> Option ``` ## Possible Values ```text 0 // User1 // Machine2 // PFXFile3 // PFXBlob4 // JKSFile5 // JKSBlob6 // PEMKeyFile7 // PEMKeyBlob8 // PublicKeyFile9 // PublicKeyBlob10 // SSHPublicKeyBlob11 // P7BFile12 // P7BBlob13 // SSHPublicKeyFile14 // PPKFile15 // PPKBlob16 // XMLFile17 // XMLBlob18 // JWKFile19 // JWKBlob20 // SecurityKey21 // BCFKSFile22 // BCFKSBlob23 // PKCS1199 // 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: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. | | 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. | | 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. | | 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. | | 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. | | 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. | | 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. | | 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. | | 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. | | 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. | | 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. | | 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. | | 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. | | 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. | | 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). | | 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). | | 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. | | 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. | | 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). | | 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). | | 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. | | 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. | | 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [ssh_cert_store_type](#ssh_cert_store_type-property-sshtunnel-struct), the full path of the PKCS#11 DLL as the [ssh_cert_store](#ssh_cert_store-property-sshtunnel-struct), and the PIN as the [ssh_cert_store_password](#ssh_cert_store_password-property-sshtunnel-struct). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) struct by calling the [list_store_certificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [on_cert_list](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [ssh_cert_store](#ssh_cert_store-property-sshtunnel-struct) and set [ssh_cert_store_password](#ssh_cert_store_password-property-sshtunnel-struct) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. | ## Data Type i32 # ssh_cert_subject_alt_names property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) Comma-separated lists of alternative subject names for the certificate. ## Syntax *Rust Syntax* ```text fn ssh_cert_subject_alt_names(&self ) -> Result ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. This property is read-only. ## Data Type String # ssh_cert_thumbprint_md5 property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) The MD5 hash of the certificate. ## Syntax *Rust Syntax* ```text fn ssh_cert_thumbprint_md5(&self ) -> Result ``` ## 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. This property is read-only. ## Data Type String # ssh_cert_thumbprint_sha1 property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) The SHA-1 hash of the certificate. ## Syntax *Rust Syntax* ```text fn ssh_cert_thumbprint_sha1(&self ) -> Result ``` ## 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. This property is read-only. ## Data Type String # ssh_cert_thumbprint_sha256 property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) The SHA-256 hash of the certificate. ## Syntax *Rust Syntax* ```text fn ssh_cert_thumbprint_sha256(&self ) -> Result ``` ## 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. This property is read-only. ## Data Type String # ssh_cert_usage property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) The text description of UsageFlags . ## Syntax *Rust Syntax* ```text fn ssh_cert_usage(&self ) -> Result ``` ## Default Value "" ## Remarks The text description of [ssh_cert_usage_flags](#ssh_cert_usage_flags-property-sshtunnel-struct). 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. This property is read-only. ## Data Type String # ssh_cert_usage_flags property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) The flags that show intended use for the certificate. ## Syntax *Rust Syntax* ```text fn ssh_cert_usage_flags(&self ) -> Result ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [ssh_cert_usage_flags](#ssh_cert_usage_flags-property-sshtunnel-struct) is a combination of the following flags: | | | | --- | --- | | 0x80 | Digital Signature | | 0x40 | Non-Repudiation | | 0x20 | Key Encipherment | | 0x10 | Data Encipherment | | 0x08 | Key Agreement | | 0x04 | Certificate Signing | | 0x02 | CRL Signing | | 0x01 | Encipher Only | Please see the [ssh_cert_usage](#ssh_cert_usage-property-sshtunnel-struct) property for a text representation of [ssh_cert_usage_flags](#ssh_cert_usage_flags-property-sshtunnel-struct). This functionality currently is not available when the provider is OpenSSL. This property is read-only. ## Data Type i32 # ssh_cert_version property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) The certificate's version number. ## Syntax *Rust Syntax* ```text fn ssh_cert_version(&self ) -> Result ``` ## Default Value "" ## Remarks The certificate's version number. The possible values are the strings "V1", "V2", and "V3". This property is read-only. ## Data Type String # ssh_cert_subject property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) The subject of the certificate used for client authentication. ## Syntax *Rust Syntax* ```text fn ssh_cert_subject(&self ) -> Result fn set_ssh_cert_subject(&self, value : &str) -> Option fn set_ssh_cert_subject_ref(&self, value : &String) -> Option ``` ## 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: | Field | Meaning | | --- | --- | | CN | Common Name. This is commonly a hostname like www.server.com. | | O | Organization | | OU | Organizational Unit | | L | Locality | | S | State | | C | Country | | E | Email Address | If a field value contains a comma, it must be quoted. ## Data Type String # ssh_cert_encoded property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) The certificate (PEM/Base64 encoded). ## Syntax *Rust Syntax* ```text fn ssh_cert_encoded(&self ) -> Result, IPWorksSSHError> fn set_ssh_cert_encoded(&self, value : Vec) -> Option fn set_ssh_cert_encoded_ref(&self, value : &[u8]) -> Option ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [ssh_cert_store](#ssh_cert_store-property-sshtunnel-struct) and [ssh_cert_subject](#ssh_cert_subject-property-sshtunnel-struct) properties also may be used to specify a certificate. When [ssh_cert_encoded](#ssh_cert_encoded-property-sshtunnel-struct) is set, a search is initiated in the current [ssh_cert_store](#ssh_cert_store-property-sshtunnel-struct) for the private key of the certificate. If the key is found, [ssh_cert_subject](#ssh_cert_subject-property-sshtunnel-struct) is updated to reflect the full subject of the selected certificate; otherwise, [ssh_cert_subject](#ssh_cert_subject-property-sshtunnel-struct) is set to an empty string. ## Data Type Vec # ssh_compression_algorithms property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) The comma-separated list containing all allowable compression algorithms. ## Syntax *Rust Syntax* ```text fn ssh_compression_algorithms(&self ) -> Result fn set_ssh_compression_algorithms(&self, value : &str) -> Option fn set_ssh_compression_algorithms_ref(&self, value : &String) -> Option ``` ## 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 ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) The comma-separated list containing all allowable encryption algorithms. ## Syntax *Rust Syntax* ```text fn ssh_encryption_algorithms(&self ) -> Result fn set_ssh_encryption_algorithms(&self, value : &str) -> Option fn set_ssh_encryption_algorithms_ref(&self, value : &String) -> Option ``` ## 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 # ssh_forward_host property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) The address of the remote host. Domain names are resolved to IP addresses. ## Syntax *Rust Syntax* ```text fn ssh_forward_host(&self ) -> Result fn set_ssh_forward_host(&self, value : &str) -> Option fn set_ssh_forward_host_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks The ssh_forward_host property specifies the IP address (IP number in dotted internet format) or domain name of the remote host. It is set before a connection is attempted and cannot be changed once a connection is established. If the ssh_forward_host property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the ssh_forward_host property is set to the corresponding address. If the search is not successful, an error is returned. 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. ## Data Type String # ssh_forward_port property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) The Transmission Control Protocol (TCP) port in the remote host. ## Syntax *Rust Syntax* ```text fn ssh_forward_port(&self ) -> Result fn set_ssh_forward_port(&self, value : i32) -> Option ``` ## Default Value 0 ## Remarks The ssh_forward_port property specifies a service port on the remote host to connect to. A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before a connection is attempted and cannot be changed once a connection is established. Any attempt to change this property while connected will fail with an error. ## Data Type i32 # ssh_host property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) The address of the Secure Shell (SSH) host. ## Syntax *Rust Syntax* ```text fn ssh_host(&self ) -> Result fn set_ssh_host(&self, value : &str) -> Option fn set_ssh_host_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks The ssh_host property specifies the IP address (IP number in dotted internet format) or domain name of the remote host. It is set before a connection is attempted and cannot be changed once a connection is established. If the ssh_host property is set to a domain name, a DNS request is initiated, and upon successful termination of the request, the ssh_host property is set to the corresponding address. If the search is not successful, an error is returned. The ssh_host must be the same host that will be assumed for SSH as for the remote service being connected to. ## Data Type String # ssh_password property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) The password for Secure Shell (SSH) password-based authentication. ## Syntax *Rust Syntax* ```text fn ssh_password(&self ) -> Result fn set_ssh_password(&self, value : &str) -> Option fn set_ssh_password_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks ssh_password specifies the password that is used to authenticate the client to the SSH server. ## Data Type String # ssh_port property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) The port on the Secure Shell (SSH) server where the SSH service is running; by default, 22. ## Syntax *Rust Syntax* ```text fn ssh_port(&self ) -> Result fn set_ssh_port(&self, value : i32) -> Option ``` ## Default Value 22 ## Remarks The ssh_port specifies a service port on the SSH host to connect to. A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before a connection is attempted and cannot be changed once a connection is established. Any attempt to change this property while connected will fail with an error. ## Data Type i32 # ssh_user property ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) The username for Secure Shell (SSH) authentication. ## Syntax *Rust Syntax* ```text fn ssh_user(&self ) -> Result fn set_ssh_user(&self, value : &str) -> Option fn set_ssh_user_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks ssh_user specifies the username that is used to authenticate the client to the SSH server. This property is required. **Example 1. User/Password Authentication:** ```text Control.SSHAuthMode = SftpSSHAuthModes.amPassword Control.SSHUser = "username" Control.SSHPassword = "password" Control.StartListening() ``` **Example 2. Public Key Authentication:** ```text Control.SSHAuthMode = SftpSSHAuthModes.amPublicKey Control.SSHUser = "username" Control.SSHCertStoreType = SSHCertStoreTypes.cstPFXFile; Control.SSHCertStore = "cert.pfx"; Control.SSHCertStorePassword = "certpassword"; Control.SSHCertSubject = "*"; Control.StartListening() ``` ## Data Type String # config method ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) Sets or retrieves a configuration setting. ## Syntax *Rust Syntax* ```text fn config(&self, configuration_string : &str) -> Result ``` ## Remarks config is a generic method available in every struct. It is used to set and retrieve [configuration settings](#config-settings-sshtunnel-struct) for the struct. These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, access to these *internal properties* is provided through the config method. To set a configuration setting named *PROPERTY*, you must call *Config("PROPERTY=VALUE")*, where *VALUE* is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter). To read (query) the value of a [configuration setting](#config-settings-sshtunnel-struct), you must call *Config("PROPERTY")*. The value will be returned as a string. # connect method ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) Connects to the Secure Shell (SSH) host without logging in. ## Syntax *Rust Syntax* ```text fn connect(&self) -> Result<(), IPWorksSSHError> ``` ## Remarks This method establishes a connection with the [ssh_host](#ssh_host-property-sshtunnel-struct) but does not log in. In most cases, it is recommended to use the [start_listening](#start_listening-method-sshtunnel-struct) method that will both establish a connection and log in to the server. This method may be useful in cases in which it is desirable to separate the connection and logon operations, for instance, when confirming a host is available by first creating the connection. # decode_packet method ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) Decodes a hex-encoded Secure Shell (SSH) packet. ## Syntax *Rust Syntax* ```text fn decode_packet(&self, encoded_packet : &str) -> Result, IPWorksSSHError> ``` ## Remarks This method is used to decode an SSH packet created by [encode_packet](#encode_packet-method-sshtunnel-struct). NOTE: This method is applicable only for reading and creating Secure Shell (SSH) packets for use within the [on_ssh_custom_auth](#on_ssh_custom_auth-event-sshtunnel-struct) event. # disconnect method ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) This method disconnects the specified client. ## Syntax *Rust Syntax* ```text fn disconnect(&self, connection_id : i32) -> Result<(), IPWorksSSHError> ``` ## Remarks This method immediately disconnects from the server without first logging off. In most cases, the [stop_listening](#stop_listening-method-sshtunnel-struct) method should be used to log off and disconnect from the server. Call the disconnect method in cases in which it is desirable to immediately disconnect without first logging off. Calling this method will disconnect the client specified by the *connection_id* parameter. # do_events method ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) This method processes events from the internal message queue. ## Syntax *Rust Syntax* ```text 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. # encode_packet method ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) Hex encodes a Secure Shell (SSH) packet. ## Syntax *Rust Syntax* ```text fn encode_packet(&self, packet : &[u8]) -> Result ``` ## Remarks This method is used to encode a raw SSH packet created by [set_ssh_param](#set_ssh_param-method-sshtunnel-struct). NOTE: This method is applicable only for reading and creating Secure Shell (SSH) packets for use within the [on_ssh_custom_auth](#on_ssh_custom_auth-event-sshtunnel-struct) event. # get_ssh_param method ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) Reads a field from a Secure Shell (SSH) packet's payload. ## Syntax *Rust Syntax* ```text fn get_ssh_param(&self, payload : &[u8], field : &str) -> Result ``` ## 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: | | | | --- | --- | | ChannelId (int32) | The Id of the channel that received the packet. | | RequestType (string) | The type of channel requested. | | WantsReply (boolean) | Whether or not the client wants a reply to the request. | 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: | | | | --- | --- | | TerminalType (string) | The type of terminal being requested (e.g., "vt100"). | | TerminalWidthCharacters (int32) | The width, in characters, of the terminal to be opened. | | TerminalHeightRows (int32) | The height, in rows, of the terminal to be opened. | | TerminalWidthPixels (int32) | The width, in pixels, of the terminal to be opened. | | TerminalHeightPixels (int32) | The height, in pixels, of the terminal to be opened. | | TerminalModes (string) | A list of op-val (int32-byte) encoded modes to be used by the terminal. | **x11-req** X11-req is a request to forward x11 sessions over a channel. The following fields are available: | | | | --- | --- | | SingleConnection (boolean) | Disallows more than one connection to be forwarded by the channel. | | X11AuthProtocol (string) | The authentication protocol to be used (e.g., "MIT-MAGIC-COOKIE-1"). | | X11AuthCookie (string) | A hexadecimal-encoded cookie to be used for authentication. | | X11ScreenNumber (int32) | The x11 screen number to be used. | **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: | | | | --- | --- | | VariableName (string) | The name of the variable to be set. | | VariableValue (string) | The value of the variable to be set. | **exec** Exec is a request to execute a command on the channel using the authenticated user's shell. The following field is available: | | | | --- | --- | | Command (string) | The command to be executed. | **subsystem** Subsystem is a request to start a subsystem on the specified channel. The following field is available: | | | | --- | --- | | Subsystem (string) | The name of the subsystem to be started (e.g., "sftp"). | **xon-xoff** Xon-xoff instructs the server to allow or disallow control-S/control-Q style flow control. The following field is available: | | | | --- | --- | | ClientCanDo (boolean) | Whether or not the server should enable flow control. | **signal** Sends a signal to the remote process/service. The following field is available: | | | | --- | --- | | SignalName (string) | The name of the signal to be sent. | 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](#set_ssh_param-method-sshtunnel-struct). 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](#set_ssh_param-method-sshtunnel-struct). NOTE: This method is applicable only for reading and creating Secure Shell (SSH) packets for use within the [on_ssh_custom_auth](#on_ssh_custom_auth-event-sshtunnel-struct) event. # get_ssh_param_bytes method ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) Reads a field from a Secure Shell (SSH) packet's payload. ## Syntax *Rust Syntax* ```text fn get_ssh_param_bytes(&self, payload : &[u8], field : &str) -> Result, IPWorksSSHError> ``` ## Remarks This method is the same as calling [get_ssh_param](#get_ssh_param-method-sshtunnel-struct), but it returns raw bytes instead of strings. NOTE: This method is applicable only for reading and creating Secure Shell (SSH) packets for use within the [on_ssh_custom_auth](#on_ssh_custom_auth-event-sshtunnel-struct) event. # interrupt method ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) This method interrupts the current method. ## Syntax *Rust Syntax* ```text fn interrupt(&self) -> Result<(), IPWorksSSHError> ``` ## Remarks If there is no method in progress, interrupt simply returns, doing nothing. # reset method ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) This method will reset the struct. ## Syntax *Rust Syntax* ```text fn reset(&self) -> Result<(), IPWorksSSHError> ``` ## Remarks This method will reset the struct's properties to their default values. # set_ssh_param method ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) Writes a field to the end of a payload. ## Syntax *Rust Syntax* ```text fn set_ssh_param(&self, payload : &[u8], field_type : &str, field_value : &str) -> Result, 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: | | | | --- | --- | | s | A plaintext string containing the default system encoding of the data. | | sb | A string containing the hex-encoded data (e.g., "A1B23C") | | m | A variable-length large integer, encoded as a textual representation of the value (e.g., "1234"). | | i | A 32-bit integer, encoded as a textual representation of the value (e.g., "1234"). | | l | A 64-bit integer, encoded as a textual representation of the value (e.g., "1234"). | | b | A single byte, encoded as a textual representation of the value (e.g., "123"). | | f | A boolean flag, encoded as a textual representation of the value (e.g., 'True' or 'False') | NOTE: Integer values may be hexadecimal encoded by prefixing "0x" to the beginning of the string; otherwise, the value is assumed to be Base10. NOTE: This method is applicable only for reading and creating Secure Shell (SSH) packets for use within the [on_ssh_custom_auth](#on_ssh_custom_auth-event-sshtunnel-struct) event. # shutdown method ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) This method shuts down the server. ## Syntax *Rust Syntax* ```text fn shutdown(&self) -> Result<(), IPWorksSSHError> ``` ## Remarks This method shuts down the server. Calling this method is equivalent to calling [stop_listening](#stop_listening-method-sshtunnel-struct) and then breaking every client connection by calling [disconnect](#disconnect-method-sshtunnel-struct). # start_listening method ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) This method starts listening for incoming connections. ## Syntax *Rust Syntax* ```text fn start_listening(&self) -> Result<(), IPWorksSSHError> ``` ## Remarks This method begins listening for incoming connections on the port specified by [local_port](#local_port-property-sshtunnel-struct). Once listening, events will fire as new clients connect and data are transferred. To stop listening for new connections, call [stop_listening](#stop_listening-method-sshtunnel-struct). To stop listening for new connections and to disconnect all existing clients, call [shutdown](#shutdown-method-sshtunnel-struct). # stop_listening method ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) This method stops listening for new connections. ## Syntax *Rust Syntax* ```text 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](#shutdown-method-sshtunnel-struct) instead. # on_connected event ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) This event is fired immediately after a connection completes (or fails). ## Syntax *Rust Syntax* ```text // SSHTunnelConnectedEventArgs carries the SSHTunnel Connected event's parameters. pub struct SSHTunnelConnectedEventArgs { fn connection_id(&self) -> i32 fn status_code(&self) -> i32 fn description(&self) -> &String } // SSHTunnelConnectedEvent defines the signature of the SSHTunnel Connected event's handler function. pub trait SSHTunnelConnectedEvent { fn on_connected(&self, sender : SSHTunnel, e : &mut SSHTunnelConnectedEventArgs); } impl <'a> SSHTunnel<'a> { pub fn on_connected(&self) -> &'a dyn SSHTunnelConnectedEvent; pub fn set_on_connected(&mut self, value : &'a dyn SSHTunnelConnectedEvent); ... } ``` ## Remarks If the connection is made normally, *status_code* is 0, and *description* is "OK". If the connection fails, *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](#trappable-errors-sshtunnel-struct) section for more information. # on_connection_request event ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) This event is fired when a request for connection comes from a remote host. ## Syntax *Rust Syntax* ```text // SSHTunnelConnectionRequestEventArgs carries the SSHTunnel ConnectionRequest event's parameters. pub struct SSHTunnelConnectionRequestEventArgs { fn address(&self) -> &String fn port(&self) -> i32 fn accept(&self) -> bool fn set_accept(&self, value : bool) } // SSHTunnelConnectionRequestEvent defines the signature of the SSHTunnel ConnectionRequest event's handler function. pub trait SSHTunnelConnectionRequestEvent { fn on_connection_request(&self, sender : SSHTunnel, e : &mut SSHTunnelConnectionRequestEventArgs); } impl <'a> SSHTunnel<'a> { pub fn on_connection_request(&self) -> &'a dyn SSHTunnelConnectionRequestEvent; pub fn set_on_connection_request(&mut self, value : &'a dyn SSHTunnelConnectionRequestEvent); ... } ``` ## 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_data_in event ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) This event is fired when data come in. ## Syntax *Rust Syntax* ```text // SSHTunnelDataInEventArgs carries the SSHTunnel DataIn event's parameters. pub struct SSHTunnelDataInEventArgs { fn connection_id(&self) -> i32 fn text(&self) -> &[u8] fn eol(&self) -> bool } // SSHTunnelDataInEvent defines the signature of the SSHTunnel DataIn event's handler function. pub trait SSHTunnelDataInEvent { fn on_data_in(&self, sender : SSHTunnel, e : &mut SSHTunnelDataInEventArgs); } impl <'a> SSHTunnel<'a> { pub fn on_data_in(&self) -> &'a dyn SSHTunnelDataInEvent; pub fn set_on_data_in(&mut self, value : &'a dyn SSHTunnelDataInEvent); ... } ``` ## Remarks Trapping the on_data_in event is your only chance to get the data coming from the other end of the connection specified by *connection_id*. The incoming data are provided through the *text* parameter. *eol* indicates whether or not the eol string was found at the end of *text*. If the eol string was found, then *eol* is True. If Text is part of the data portion of length larger than either default_max_line_length or with no eol strings in it, then *eol* is False. Please note that this means that one or more on_data_in events with *eol* set to False can be received during a connection. If the eol property is "" (empty string), then *eol* can be disregarded (it is always True). NOTE: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance. # on_disconnected event ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) Fired when a connection is closed. ## Syntax *Rust Syntax* ```text // SSHTunnelDisconnectedEventArgs carries the SSHTunnel Disconnected event's parameters. pub struct SSHTunnelDisconnectedEventArgs { fn connection_id(&self) -> i32 fn status_code(&self) -> i32 fn description(&self) -> &String } // SSHTunnelDisconnectedEvent defines the signature of the SSHTunnel Disconnected event's handler function. pub trait SSHTunnelDisconnectedEvent { fn on_disconnected(&self, sender : SSHTunnel, e : &mut SSHTunnelDisconnectedEventArgs); } impl <'a> SSHTunnel<'a> { pub fn on_disconnected(&self) -> &'a dyn SSHTunnelDisconnectedEvent; pub fn set_on_disconnected(&mut self, value : &'a dyn SSHTunnelDisconnectedEvent); ... } ``` ## Remarks If the connection is broken normally, *StatusCode* is 0, and *Description* is "OK". If the connection is broken for any other reason, *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](#trappable-errors-sshtunnel-struct) section for more information. NOTE: When the struct is disconnected from the Secure Shell (SSH) server for any reason the *ConnectionId* parameter will be *-1*. # on_error event ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) Fired when errors occur during data delivery. ## Syntax *Rust Syntax* ```text // SSHTunnelErrorEventArgs carries the SSHTunnel Error event's parameters. pub struct SSHTunnelErrorEventArgs { fn connection_id(&self) -> i32 fn error_code(&self) -> i32 fn description(&self) -> &String } // SSHTunnelErrorEvent defines the signature of the SSHTunnel Error event's handler function. pub trait SSHTunnelErrorEvent { fn on_error(&self, sender : SSHTunnel, e : &mut SSHTunnelErrorEventArgs); } impl <'a> SSHTunnel<'a> { pub fn on_error(&self) -> &'a dyn SSHTunnelErrorEvent; pub fn set_on_error(&mut self, value : &'a dyn SSHTunnelErrorEvent); ... } ``` ## 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](#trappable-errors-sshtunnel-struct) 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](#trappable-errors-sshtunnel-struct) section. # on_log event ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) Fired once for each log message. ## Syntax *Rust Syntax* ```text // SSHTunnelLogEventArgs carries the SSHTunnel Log event's parameters. pub struct SSHTunnelLogEventArgs { fn log_level(&self) -> i32 fn message(&self) -> &String fn log_type(&self) -> &String } // SSHTunnelLogEvent defines the signature of the SSHTunnel Log event's handler function. pub trait SSHTunnelLogEvent { fn on_log(&self, sender : SSHTunnel, e : &mut SSHTunnelLogEventArgs); } impl <'a> SSHTunnel<'a> { pub fn on_log(&self) -> &'a dyn SSHTunnelLogEvent; pub fn set_on_log(&mut self, value : &'a dyn SSHTunnelLogEvent); ... } ``` ## Remarks Fired once for each log message generated by the struct. The verbosity is controlled by the [LogLevel](#LogLevel) setting. *LogLevel* indicates the detail level of the message. Possible values are as follows: | | | | --- | --- | | 0 (None) | No messages are logged. | | 1 (Info - Default) | Informational events such as Secure Shell (SSH) handshake messages are logged. | | 2 (Verbose) | Detailed data such as individual packet information are logged. | | 3 (Debug) | Debug data including all relevant sent and received bytes are logged. | *Message* is the log message. *LogType* is reserved for future use. # on_reconnect_attempt event ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) Fired when attempting to reconnect. ## Syntax *Rust Syntax* ```text // SSHTunnelReconnectAttemptEventArgs carries the SSHTunnel ReconnectAttempt event's parameters. pub struct SSHTunnelReconnectAttemptEventArgs { fn host(&self) -> &String fn port(&self) -> i32 fn retry_count(&self) -> i32 fn retries_remaining(&self) -> i32 fn max_retry_count(&self) -> i32 fn retry_interval(&self) -> i32 fn retry_type(&self) -> i32 fn remote_listening_port(&self) -> i32 fn cancel(&self) -> bool fn set_cancel(&self, value : bool) } // SSHTunnelReconnectAttemptEvent defines the signature of the SSHTunnel ReconnectAttempt event's handler function. pub trait SSHTunnelReconnectAttemptEvent { fn on_reconnect_attempt(&self, sender : SSHTunnel, e : &mut SSHTunnelReconnectAttemptEventArgs); } impl <'a> SSHTunnel<'a> { pub fn on_reconnect_attempt(&self) -> &'a dyn SSHTunnelReconnectAttemptEvent; pub fn set_on_reconnect_attempt(&mut self, value : &'a dyn SSHTunnelReconnectAttemptEvent); ... } ``` ## Remarks This event fires both when attempting to reconnect to the [ssh_host](#ssh_host-property-sshtunnel-struct) and when reestablishing a Secure Shell (SSH) tunnel. This is applicable only when [AutoReconnect](#AutoReconnect) is enabled. To determine which type of connection is being established check the *RetryType* parameter. The following table provides details about the parameters: | | | | --- | --- | | Host | The SSH host to which the connection is attempted. | | Port | The port on the SSH host to which the connection is attempted. | | RetryCount | The current retry attempt. For instance, this may be attempt number 2 out of 5, then RetryCount will hold the value 2. | | RetriesRemaining | The number of retries remaining after this attempt. This number does not include the current attempt. If [MaxRetryCount](#MaxRetryCount) is set to unlimited, this will return -1. | | MaxRetryCount | The maximum number of retries as specified in [MaxRetryCount](#MaxRetryCount). | | RetryInterval | The interval (in seconds) between retry attempts as specified in [RetryInterval](#RetryInterval). | | RetryType | The type of connection being retried. Possible values are as follows: 0 - SSH 1 - Tunnel | | RemoteListeningPort | The port on the SSH host that the reverse tunnel will use. This is applicable only when RetryType is 1. | | Cancel | Maybe set within this event to cancel the retry attempts. If set to True, no further retry attempts will be executed. | # on_ssh_custom_auth event ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) Fired when the struct is doing a custom authentication. ## Syntax *Rust Syntax* ```text // SSHTunnelSSHCustomAuthEventArgs carries the SSHTunnel SSHCustomAuth event's parameters. pub struct SSHTunnelSSHCustomAuthEventArgs { fn packet(&self) -> &String fn set_packet(&self, value : &str) fn set_packet_ref(&self, value : &String) } // SSHTunnelSSHCustomAuthEvent defines the signature of the SSHTunnel SSHCustomAuth event's handler function. pub trait SSHTunnelSSHCustomAuthEvent { fn on_ssh_custom_auth(&self, sender : SSHTunnel, e : &mut SSHTunnelSSHCustomAuthEventArgs); } impl <'a> SSHTunnel<'a> { pub fn on_ssh_custom_auth(&self) -> &'a dyn SSHTunnelSSHCustomAuthEvent; pub fn set_on_ssh_custom_auth(&mut self, value : &'a dyn SSHTunnelSSHCustomAuthEvent); ... } ``` ## Remarks on_ssh_custom_auth is fired during the user authentication stage of the Secure Shell (SSH) logon process if [ssh_auth_mode](#ssh_auth_mode-property-sshtunnel-struct) is set to amCustom. *Packet* contains the last raw SSH packet sent by the server, in HEX-encoded format. The client should create a new raw SSH packet to send to the server and set *Packet* to the HEX-encoded representation of the packet to send. In all cases, *Packet* will start with the message type field. To read the incoming packet, call [decode_packet](#decode_packet-method-sshtunnel-struct) and then use the [get_ssh_param](#get_ssh_param-method-sshtunnel-struct) and [get_ssh_param_bytes](#get_ssh_param_bytes-method-sshtunnel-struct) methods. To create a packet, use the [set_ssh_param](#set_ssh_param-method-sshtunnel-struct) method and then call [encode_packet](#encode_packet-method-sshtunnel-struct) to obtain a HEX-encoded value and assign this to the *Packet* parameter. # on_ssh_keyboard_interactive event ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) Fired when the struct receives a request for user input from the server. ## Syntax *Rust Syntax* ```text // SSHTunnelSSHKeyboardInteractiveEventArgs carries the SSHTunnel SSHKeyboardInteractive event's parameters. pub struct SSHTunnelSSHKeyboardInteractiveEventArgs { fn name(&self) -> &String fn instructions(&self) -> &String fn prompt(&self) -> &String fn response(&self) -> &String fn set_response(&self, value : &str) fn set_response_ref(&self, value : &String) fn echo_response(&self) -> bool } // SSHTunnelSSHKeyboardInteractiveEvent defines the signature of the SSHTunnel SSHKeyboardInteractive event's handler function. pub trait SSHTunnelSSHKeyboardInteractiveEvent { fn on_ssh_keyboard_interactive(&self, sender : SSHTunnel, e : &mut SSHTunnelSSHKeyboardInteractiveEventArgs); } impl <'a> SSHTunnel<'a> { pub fn on_ssh_keyboard_interactive(&self) -> &'a dyn SSHTunnelSSHKeyboardInteractiveEvent; pub fn set_on_ssh_keyboard_interactive(&mut self, value : &'a dyn SSHTunnelSSHKeyboardInteractiveEvent); ... } ``` ## Remarks on_ssh_keyboard_interactive is fired during the user authentication stage of the Secure Shell (SSH) logon process. During authentication, the struct will request a list of available authentication methods for the [ssh_user](#ssh_user-property-sshtunnel-struct). For example, if the [ssh_host](#ssh_host-property-sshtunnel-struct) responds with "keyboard-interactive", the struct will fire this event to allow the client application to set the password. During authentication, the SSH server may respond with a request for the user's authentication information. *Name* is a server-provided value associated with the authentication method such as "CRYPTOCard Authentication". *Instructions* will contain specific instructions, also supplied by the server, for how the user should respond. Along with these values, the server will also send at least one input *Prompt* to be displayed to and filled out by the user. *Response* should be set to the user's input, and will be sent back in the user authentication information response. *EchoResponse* is a server recommendation for whether or not the user's response should be echoed back during input. NOTE: The server may send several prompts in a single packet. The struct will fire the on_ssh_keyboard_interactive event once for each prompt. # on_ssh_server_authentication event ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) Fired after the server presents its public key to the client. ## Syntax *Rust Syntax* ```text // SSHTunnelSSHServerAuthenticationEventArgs carries the SSHTunnel SSHServerAuthentication event's parameters. pub struct SSHTunnelSSHServerAuthenticationEventArgs { fn host_key(&self) -> &[u8] fn fingerprint(&self) -> &String fn key_algorithm(&self) -> &String fn cert_subject(&self) -> &String fn cert_issuer(&self) -> &String fn status(&self) -> &String fn accept(&self) -> bool fn set_accept(&self, value : bool) } // SSHTunnelSSHServerAuthenticationEvent defines the signature of the SSHTunnel SSHServerAuthentication event's handler function. pub trait SSHTunnelSSHServerAuthenticationEvent { fn on_ssh_server_authentication(&self, sender : SSHTunnel, e : &mut SSHTunnelSSHServerAuthenticationEventArgs); } impl <'a> SSHTunnel<'a> { pub fn on_ssh_server_authentication(&self) -> &'a dyn SSHTunnelSSHServerAuthenticationEvent; pub fn set_on_ssh_server_authentication(&mut self, value : &'a dyn SSHTunnelSSHServerAuthenticationEvent); ... } ``` ## Remarks This event is fired when the client can decide whether or not to continue with the connection process. If the public key is known to be a valid key for the Secure Shell (SSH) server, *Accept* should be set to True within the event. Otherwise, the server will not be authenticated and the connection will be broken. *Accept* will be True only if either *HostKey* or *Fingerprint* is identical to the value of ssh_accept_server_host_key. Accept may be set to True manually to accept the server host key. NOTE: SSH's security inherently relies on client verification of the host key. Ignoring the host key and always setting *Accept* to True is strongly discouraged, and could cause potentially serious security vulnerabilities in your application. It is recommended that clients maintain a list of known keys for each server and check *HostKey* against this list each time a connection is attempted. **Host Key** contains the full binary text of the key, in the same format used internally by SSH. *Fingerprint* holds the SHA-256 hash of *HostKey* in the hex-encoded form: *0a:1b:2c:3d*. To configure the hash algorithm used to calculate this value, see [SSHFingerprintHashAlgorithm](#SSHFingerprintHashAlgorithm). To configure the encoding format used when displaying this value, see [SSHFingerprintEncoding](#SSHFingerprintEncoding). *KeyAlgorithm* identifies the host key algorithm. The following values are supported: - ssh-rsa - ssh-dss - rsa-sha2-256 - rsa-sha2-512 - x509v3-sign-rsa - x509v3-sign-dss - ecdsa-sha2-nistp256 - ecdsa-sha2-nistp384 - ecdsa-sha2-nistp521 To limit the accepted host key algorithms, refer to [SSHPublicKeyAlgorithms](#SSHPublicKeyAlgorithms). *CertSubject* is the subject of the certificate. This is applicable only when *KeyAlgorithm* is "x509v3-sign-rsa" or "x509v3-sign-dss". *CertIssuer* is the issuer of the certificate. This is applicable only when *KeyAlgorithm* is "x509v3-sign-rsa" or "x509v3-sign-dss". *Status* is reserved for future use. # on_ssh_status event ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) Fired to track the progress of the secure connection. ## Syntax *Rust Syntax* ```text // SSHTunnelSSHStatusEventArgs carries the SSHTunnel SSHStatus event's parameters. pub struct SSHTunnelSSHStatusEventArgs { fn message(&self) -> &String } // SSHTunnelSSHStatusEvent defines the signature of the SSHTunnel SSHStatus event's handler function. pub trait SSHTunnelSSHStatusEvent { fn on_ssh_status(&self, sender : SSHTunnel, e : &mut SSHTunnelSSHStatusEventArgs); } impl <'a> SSHTunnel<'a> { pub fn on_ssh_status(&self) -> &'a dyn SSHTunnelSSHStatusEvent; pub fn set_on_ssh_status(&mut self, value : &'a dyn SSHTunnelSSHStatusEvent); ... } ``` ## Remarks The event is fired for informational and logging purposes only. Used to track the progress of the connection. # Config Settings ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) The struct accepts one or more of the following *configuration settings*. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, access to these *internal properties* is provided through the [config](#config-method-sshtunnel-struct) method. ### SSHTunnel Config Settings **AutoReconnect**: Whether to automatically reconnect.This configuration setting controls automatic recovery of the Secure Shell (SSH) connection. If logon is disrupted or the channel is closed, the component can be configured to attempt reconnection automatically. Possible values follow: | Value | Description | | --- | --- | | 0 (None) | Do not automatically reconnect. | | 1 (Default) | Reconnect if an existing connection is broken. | | 2 (Always) | Retry the initial logon as well as recover an existing connection. | See [MaxRetryCount](#MaxRetryCount) and [RetryInterval](#RetryInterval) for additional related settings. **MaxRetryCount**: The maximum number of retries when reconnecting.This configuration setting defines the maximum number of connection attempts performed when reestablishing a broken connection. This configuration setting applies only when [AutoReconnect](#AutoReconnect) is enabled. By default, the component will reconnect forever. **RetryInterval**: The interval in seconds between reconnect attempts.This configuration setting specifies the number of seconds between reconnection attempts. This setting applies only when [AutoReconnect](#AutoReconnect) is enabled. The default value is *5*. **ShutdownChannelOnEOF**: Whether the client will shutdown the channel after receiving an EOF packet from the remote host.The default value is *False*. Set this to *True* to send the channel close packet when an EOF packet is received. **SSHForwardSocketPath**: The path to the Unix domain socket where the traffic will be forwarded.To enable this feature, specify the full path to the Unix socket you wish to connect to. When this configuration is set, all traffic will be securely forwarded over the Secure Shell (SSH) tunnel to the specified Unix socket. Use this setting in place of the [ssh_forward_host](#ssh_forward_host-property-sshtunnel-struct) and [ssh_forward_port](#ssh_forward_port-property-sshtunnel-struct) properties when working with Unix sockets. **Example:** ```text component.LocalPort = 777; component.SSHHost = "remotehost"; component.SSHUser = "sshuser"; component.SSHPassword = "pass"; component.Config("SSHForwardSocketPath=/path/to/unix/test.sock"); component.StartListening(); ``` ### SSHClient Config Settings **ChannelDataEOL[ChannelId]**: Used to break the incoming data stream into chunks.By *default* [MaxChannelDataLength](#MaxChannelDataLength) is *0* and [ChannelDataEOL](#ChannelDataEOL) is an empty string. on_ssh_channel_data fires whenever an SSH_MSG_CHANNEL_DATA packet is received. If [MaxChannelDataLength](#MaxChannelDataLength) is greater than *0* and [ChannelDataEOL](#ChannelDataEOL) is a nonempty string, the struct will internally buffer data waiting to fire on_ssh_channel_data until either [MaxChannelDataLength](#MaxChannelDataLength) is reached or [ChannelDataEOL](#ChannelDataEOL) is found, whichever comes first. Query [ChannelDataEOLFound](#ChannelDataEOLFound) to know which condition was met. The buffer is reset any time on_ssh_channel_data fires. [ChannelDataEOL](#ChannelDataEOL) and [MaxChannelDataLength](#MaxChannelDataLength) *must* be set together or unexpected behavior could occur. **ChannelDataEOLFound[ChannelId]**: Determines if ChannelDataEOL was found.If *true*,then [ChannelDataEOL](#ChannelDataEOL) was found. If *false*, then [MaxChannelDataLength](#MaxChannelDataLength) was reached. This configuration setting is valid only when queried inside on_ssh_channel_data, [MaxChannelDataLength](#MaxChannelDataLength) > 0, and [ChannelDataEOL](#ChannelDataEOL) is nonempty. **ClientSSHVersionString**: The SSH version string used by the struct.This configuration setting specifies the Secure Shell (SSH) version string used by the struct. The default value is "SSH-2.0-IPWorks SSH Client 2024". Most SSH servers expect the SSH version string to have the expected format "SSH-protocol version-software version". See above for an example. **ConnectAndLogin**: Whether the struct performs a full SSH login.The default value is *true*. When enabled, calling the [connect](#connect-method-sshtunnel-struct) method establishes the TCP connection and performs a full SSH login. When set to *false*, calling [connect](#connect-method-sshtunnel-struct) will only establish the underlying TCP connection; the SSH login will not be performed. This may be useful in cases in which it is desirable to separate the connection and logon operations; for instance, confirming a host is available before authenticating with it. When [ConnectAndLogin](#ConnectAndLogin) is *false*, call ssh_logon with the same [ssh_host](#ssh_host-property-sshtunnel-struct) and [ssh_port](#ssh_port-property-sshtunnel-struct) used to connect in order to complete the SSH login over the existing connection. Note that ssh_logon always performs a full SSH login regardless of the value of this configuration setting. **DoNotRepeatAuthMethods**: Whether the struct will repeat authentication methods during multifactor authentication.The default value is *true*. When set to *false*, the struct will repeat authentication methods that have already been completed during multifactor authentication. **EnablePageantAuth**: Whether to use a key stored in Pageant to perform client authentication.This configuration setting controls whether Pageant authentication is disabled, enabled, or required. When enabled or required, the struct attempts to communicate with PuTTY's ssh-agent, called "Pageant", over shared memory to perform public key authentication. Possible values and the corresponding behavior is described as follows: | Value | Description | | --- | --- | | 0 (Disabled - default) | No communication with Pageant is attempted. | | 1 (Enabled) | Pageant authentication is used if available. If Pageant is not running, or does not contain the expected key, no error is thrown. | | 2 (Required) | Only Pageant authentication is used. If Pageant is not running, or does not contain the expected key, an error is thrown. | **Example 1. Enabling Pageant:** ```text component.Config("EnablePageantAuth=1"); component.SSHUser = "sshuser"; component.SSHLogon("localhost", 22); ``` NOTE: This functionality is available only on Windows. **KerberosDelegation**: If true, asks for credentials with delegation enabled during authentication.The default value is "True". If set to "False", the client will not ask for credentials delegation support during authentication. NOTE: Even if the client asks for delegation, the server/KDC might not grant it, and authentication will still succeed. **KerberosRealm**: The fully qualified domain name of the Kerberos Realm to use for GSSAPI authentication.This property may be set to the fully qualified (DNS) name of the kerberos realm (or Windows Active Directory domain name) to use during GSSAPI authentication. This can be used to force authentication with a given realm if the client and server machines are not part of the same domain. **KerberosSPN**: The Kerberos Service Principal Name of the SSH host.This property can be set to specify the Service Principal Name (SPN) associated with the SSH service on the remote host. This will usually be in the form "host/fqdn.of.sshhost[@REALM]". If not specified, the struct will assume the SPN is based on the value of the [ssh_host](#ssh_host-property-sshtunnel-struct) property and the kerberos realm used for authentication. **KeyRenegotiationThreshold**: Sets the threshold for the SSH Key Renegotiation.This property allows you to specify the threshold, in the number of bytes, for the Secure Shell (SSH) key renegotiation. The default value for this property is set to 1 GB. **Example. Setting the Threshold to 500 MB:** ```text SSHComponent.Config("KeyRenegotiationThreshold=524288000") ``` **LogLevel**: Specifies the level of detail that is logged.This configuration setting controls the level of detail that is logged through the [on_log](#on_log-event-sshtunnel-struct) event. Possible values are as follows: | | | | --- | --- | | 0 (None) | No messages are logged. | | 1 (Info - Default) | Informational events such as Secure Shell (SSH) handshake messages are logged. | | 2 (Verbose) | Detailed data such as individual packet information are logged. | | 3 (Debug) | Debug data including all relevant sent and received bytes are logged. | **MaxChannelDataLength[ChannelId]**: The maximum amount of data to accumulate when no ChannelDataEOL is found.By *default* [MaxChannelDataLength](#MaxChannelDataLength) is *0* and [ChannelDataEOL](#ChannelDataEOL) is an empty string. on_ssh_channel_data fires whenever an SSH_MSG_CHANNEL_DATA packet is received. If [MaxChannelDataLength](#MaxChannelDataLength) is greater than *0* and [ChannelDataEOL](#ChannelDataEOL) is a nonempty string, the struct will internally buffer data waiting to fire on_ssh_channel_data until either [MaxChannelDataLength](#MaxChannelDataLength) is reached or [ChannelDataEOL](#ChannelDataEOL) is found, whichever comes first. Query [ChannelDataEOLFound](#ChannelDataEOLFound) to know which condition was met. The buffer is reset any time on_ssh_channel_data fires. [ChannelDataEOL](#ChannelDataEOL) and [MaxChannelDataLength](#MaxChannelDataLength) *must* be set together or unexpected behavior could occur. **MaxPacketSize**: The maximum packet size of the channel, in bytes.This configuration setting specifies the maximum size of an individual data packet, in bytes, that can be sent to the sender. **MaxWindowSize**: The maximum window size allowed for the channel, in bytes.This configuration setting specifies how many bytes of channel data can be sent to the sender of this message without adjusting the window. NOTE: This value may be changed during the connection, but the window size can only be increased, not decreased. **NegotiatedStrictKex**: Returns whether strict key exchange was negotiated to be used.This configuration setting specifies whether strict key exchange (strict kex) was negotiated during the SSH handshake. If strict kex is being used, then this will return *"True"*. If strict kex is not being used, then this will return *"False"*. ```text component.Config("NegotiatedStrictKex") ``` **PasswordPrompt**: The text of the password prompt used in keyboard-interactive authentication.This configuration setting optionally specifies a pattern to be matched to the prompt received from the server during keyboard-interactive authentication. If a matching prompt is detected the struct automatically responds to the prompt with the password specified by [ssh_password](#ssh_password-property-sshtunnel-struct). This provides an easy way to automatically reply to prompts with the password if one is presented by the server. The password will be autofilled in the *Response* parameter of the [on_ssh_keyboard_interactive](#on_ssh_keyboard_interactive-event-sshtunnel-struct) event in the case of a match. The following special characters are supported for pattern matching: | | | | --- | --- | | ? | Any single character. | | * | Any characters or no characters (e.g., C*t matches Cat, Cot, Coast, Ct). | | [,-] | A range of characters (e.g., [a-z], [a], [0-9], [0-9,a-d,f,r-z]). | | \ | The slash is ignored and exact matching is performed on the next character. | If these characters need to be used as a literal in a pattern, then they must be escaped by surrounding them with brackets []. NOTE: "]" and "-" do not need to be escaped. See below for the escape sequences: | Character | Escape Sequence | | --- | --- | | ? | [?] | | * | [*] | | [ | [[] | | \ | [\] | For example, to match the value [Something].txt, specify the pattern [[]Something].txt. **PreferredDHGroupBits**: The size (in bits) of the preferred modulus (p) to request from the server.This configuration setting may be when using the diffie-hellman-group-exchange-sha1 or diffie-hellman-group-exchange-sha256 key exchange algorithms to control the preferred size, in bits, of the modulus (p) prime number to request from the server. Acceptable values are between 1024 and 8192. **RecordLength**: The length of received data records.If set to a positive value, this configuration setting defines the length of data records to be received. The struct will accumulate data until RecordLength is reached and only then will it fire the [on_data_in](#on_data_in-event-sshtunnel-struct) event with data of length RecordLength. This allows data to be received as records of known length. This value can be changed at any time, including within the [on_data_in](#on_data_in-event-sshtunnel-struct) event. The default value is 0, meaning this setting is not used. **ServerSSHVersionString**: The remote host's SSH version string.This configuration setting will return the remote host's SSH version string, which can help when identifying problematic servers. This configuration setting is read-only. **SignedSSHCert**: The CA signed client public key used when authenticating.When authenticating via public key authentication, this setting may be set to the certificate authority (CA) signed client's public key. This is useful when the server has been configured to trust client keys signed by a particular CA. For instance: ```text component.Config("SignedSSHCert=ssh-rsa-cert-v01@openssh.com AAAAB3NzaC1yc2EAAAADAQABAAAB..."); ``` The algorithm such as *ssh-rsa-cert-v01@openssh.com* in the previous string is used as part of the authentication process. To use a different algorithm, simply change this value. For instance, all of the following are acceptable with the same signed public key: - *ssh-rsa-cert-v01@openssh.com AAAAB3NzaC1yc2EAAAADAQABAAAB...* - *rsa-sha2-256-cert-v01@openssh.com AAAAB3NzaC1yc2EAAAADAQABAAAB...* - *rsa-sha2-512-cert-v01@openssh.com AAAAB3NzaC1yc2EAAAADAQABAAAB...* **SSHAcceptAnyServerHostKey**: If set the struct will accept any key presented by the server.The default value is "False". Set this to "True" to accept any key presented by the server. **SSHAcceptServerCAKey**: The CA public key that signed the server's host key.If the server's host key was signed by a CA, this configuration setting may be used to specify the CA's public key. If specified, the struct will trust any server's host key that was signed by the CA. For instance: ```text component.Config("SSHAcceptServerCAKey=ssh-rsa AAAAB3NzaC1yc2EAAAADAQAB..."); ``` **SSHAcceptServerHostKeyFingerPrint**: The fingerprint(s) of the server host keys to accept.This configuration setting specifies one or more fingerprints that should be accepted as the servers host key. Each fingerprint should be represented using the hash algorithm and encoding format defined by the [SSHFingerprintHashAlgorithm](#SSHFingerprintHashAlgorithm) and [SSHFingerprintEncoding](#SSHFingerprintEncoding) configs, respectively. By default, this config should be specified as the comma-separated list of hex-encoded SHA256 hashes of possible server host keys. **Example:** ```text // Assuming default values. Hex-encoded, SHA256 hash of the expected host key SSHClient.Config("SSHAcceptServerHostKeyFingerPrint=61:2d:89:9c:55:67:5e:ca:22:86:fc:f6:07:59:67:e0:c7:77:08:1f:cc:d9:93:f3:f9:63:21:15:3e:0c:a2:1b"); // Base64-encoded, SHA256 hash of the expected host key SSHClient.Config("SSHFingerprintEncoding=1"); SSHClient.Config("SSHAcceptServerHostKeyFingerPrint=n4bQgYhMfWWaL+qgxVrQFaO/TxsrC4Is0V1sFbDwCgg="); ``` If the server's fingerprint matches one of the values supplied, the struct will accept the host key. **SSHFingerprintEncoding**: Specifies the encoding used when displaying the SSH host key fingerprint.This setting determines how the SSH host key fingerprint is displayed after it has been computed using the algorithm specified by [SSHFingerprintHashAlgorithm](#SSHFingerprintHashAlgorithm). Possible values are: - *0* (Hex Encoded) - *1* (Base64 Encoded - Default) For example, when set to *0*, the Fingerprint parameter in [on_ssh_server_authentication](#on_ssh_server_authentication-event-sshtunnel-struct) will be formatted like: *0a:1b:2c:3d*. When set to *1*, the Fingerprint parameter in [on_ssh_server_authentication](#on_ssh_server_authentication-event-sshtunnel-struct) will be formatted like: ```plaintext n4bQgYhMfWWaL+qgxVrQFaO/TxsrC4Is0V1sFbDwCgg= ``` . Note that this config is also applicable when querying the [SSHFingerprintMD5](#SSHFingerprintMD5), [SSHFingerprintSHA1](#SSHFingerprintSHA1), or [SSHFingerprintSHA256](#SSHFingerprintSHA256) configuration settings. Additionally, note that this config is also applicable if specifying the host key fingerprint via [SSHAcceptServerHostKeyFingerPrint](#SSHAcceptServerHostKeyFingerPrint). The value specified via [SSHAcceptServerHostKeyFingerPrint](#SSHAcceptServerHostKeyFingerPrint) should be specified according to the format or encoding specified by this configuration setting. **SSHFingerprintHashAlgorithm**: The algorithm used to calculate the fingerprint.This configuration setting controls which hash algorithm is used to calculate the hostkey's fingerprint, displayed when [on_ssh_server_authentication](#on_ssh_server_authentication-event-sshtunnel-struct) fires. Valid values are as follows: - *MD5* - *SHA1* - *SHA256* (default) **SSHFingerprintMD5**: The server hostkey's MD5 fingerprint.This configuration setting may be queried in [on_ssh_server_authentication](#on_ssh_server_authentication-event-sshtunnel-struct) to get the server hostkey's MD5 fingerprint. **SSHFingerprintSHA1**: The server hostkey's SHA1 fingerprint.This configuration setting may be queried in [on_ssh_server_authentication](#on_ssh_server_authentication-event-sshtunnel-struct) to get the server hostkey's SHA-1 fingerprint. **SSHFingerprintSHA256**: The server hostkey's SHA256 fingerprint.This configuration setting may be queried in [on_ssh_server_authentication](#on_ssh_server_authentication-event-sshtunnel-struct) to get the server hostkey's SHA-256 fingerprint. **SSHKeepAliveCountMax**: The maximum number of keep alive packets to send without a response.This configuration setting specifies the maximum number of keep-alive packets to send when no response is received. Normally a response to a keep-alive packet is received right away. If no response is received, the struct will continue to send keep-alive packets until [SSHKeepAliveCountMax](#SSHKeepAliveCountMax) is reached. If this is reached, the struct will assume the connection is broken and disconnect. The default value is 5. **SSHKeepAliveInterval**: The interval between keep alive packets.This configuration setting specifies the number of seconds between keep alive packets. If set to a positive value, the struct will send a SSH keep-alive packet after [KeepAliveInterval](#KeepAliveInterval) seconds of inactivity. This configuration setting takes effect only when there is no activity; if any data are sent or received over the connection, it will reset the timer. The default value is 0, meaning no keep alives will be sent. NOTE: The [SSHReverseTunnel](SSHReverseTunnel.md#SSHReverseTunnel) struct uses a default value of 30. **SSHKeyExchangeAlgorithms**: Specifies the supported key exchange algorithms.This configuration setting may be used to specify the list of supported key exchange algorithms used during Secure Shell (SSH) negotiation. The value should contain a comma-separated list of algorithms. Supported algorithms are as follows: - curve25519-sha256 - curve25519-sha256@libssh.org - diffie-hellman-group1-sha1 - diffie-hellman-group14-sha1 - diffie-hellman-group14-sha256 - diffie-hellman-group16-sha512 - diffie-hellman-group18-sha512 - diffie-hellman-group-exchange-sha256 - diffie-hellman-group-exchange-sha1 - ecdh-sha2-nistp256 - ecdh-sha2-nistp384 - ecdh-sha2-nistp521 - gss-group14-sha256 - gss-group16-sha512 - gss-nistp256-sha256 - gss-curve25519-sha256 - gss-group14-sha1 - gss-gex-sha1 - mlkem768x25519-sha256 The default value is *curve25519-sha256,curve25519-sha256@libssh.org,diffie-hellman-group-exchange-sha256,diffie-hellman-group14-sha256,diffie-hellman-group16-sha512,diffie-hellman-group18-sha512,ecdh-sha2-nistp256,ecdh-sha2-nistp384,ecdh-sha2-nistp521,mlkem768x25519-sha256,diffie-hellman-group-exchange-sha1,diffie-hellman-group14-sha1,diffie-hellman-group1-sha1,gss-group14-sha256,gss-group16-sha512,gss-nistp256-sha256,gss-curve25519-sha256,gss-group14-sha1,gss-gex-sha1*. **SSHKeyRenegotiate**: Causes the component to renegotiate the SSH keys.Once this configuration setting is queried, the component will renegotiate the SSH keys with the remote host. **Example 3. Renegotiating SSH Keys:** ```text SSHClient.Config("SSHKeyRenegotiate") ``` **SSHMacAlgorithms**: Specifies the supported Mac algorithms.This configuration setting may be used to specify an alternate list of supported Mac algorithms used during SSH negotiation. This also specifies the order in which the Mac algorithms are preferred. The value should contain a comma-separated list of algorithms. Supported algorithms are as follows: - hmac-sha1 - hmac-md5 - hmac-sha1-96 - hmac-md5-96 - hmac-sha2-256 - hmac-sha2-256-96 - hmac-sha2-512 - hmac-sha2-512-96 - hmac-ripemd160 - hmac-ripemd160-96 - hmac-sha2-256-etm@openssh.com - hmac-sha2-512-etm@openssh.com - hmac-sha2-256-96-etm@openssh.com - hmac-sha2-512-96-etm@openssh.com - umac-64@openssh.com - umac-64-etm@openssh.com - umac-128@openssh.com - umac-128-etm@openssh.com The default value is *hmac-sha2-256,hmac-sha2-512,hmac-sha1,hmac-md5,hmac-ripemd160,hmac-sha1-96,hmac-md5-96,hmac-sha2-256-96,hmac-sha2-512-96,hmac-ripemd160-96,hmac-sha2-256-etm@openssh.com,hmac-sha2-512-etm@openssh.com,umac-64@openssh.com,umac-64-etm@openssh.com,umac-128@openssh.com,umac-128-etm@openssh.com*. **SSHPubKeyAuthSigAlgorithms**: Specifies the enabled signature algorithms that may be used when attempting public key authentication.This setting specifies a list of signature algorithms that may be used when authenticating to the server using public key authentication. This applies only when public key authentication is performed by the client. The setting should be a comma-separated list of algorithms. At runtime, the struct will evaluate the specified algorithms, and if the algorithm is applicable to the certificate specified in ssh_cert, it will be used. If the algorithm is not applicable, the struct will evaluate the next algorithm. Possible values are as follows: - ssh-rsa - rsa-sha2-256 - rsa-sha2-512 - ssh-dss - ecdsa-sha2-nistp256 - ecdsa-sha2-nistp384 - ecdsa-sha2-nistp521 - ssh-ed25519 - x509v3-sign-rsa - x509v3-sign-dss The default value in Windows is *ssh-rsa,rsa-sha2-256,rsa-sha2-512,ssh-dss,ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521,ssh-ed25519*. **rsa-sha2-256 and rsa-sha2-512 notes** The struct will query the server for supported algorithms when connecting. If the server indicates support for *rsa-sha2-256* or *rsa-sha2-512* and the algorithm is present in the list defined by this setting (as in the default value), that algorithm will be used instead of *ssh-rsa* even when *ssh-rsa* appears first in the list. For the *rsa-sha2-256* and *rsa-sha2-512* algorithms to be automatically preferred, the server must support the *ext-info-c* mechanism. In practice, older servers do not support this, and in that case, *ssh-rsa* will be used because it appears first in the list. Newer servers do support this mechanism, and in that case, *rsa-sha2-256* or *rsa-sha2-512* will be used even though it appears after *ssh-rsa*. This behavior has been carefully designed to provide maximum compatibility while automatically using more secure algorithms when connecting to servers that support them. **SSHPublicKeyAlgorithms**: Specifies the supported public key algorithms for the server's public key. This configuration setting specifies the allowed public key algorithms for the server's public key. This list controls only the public key algorithm used when authenticating the server's public key. This list has no bearing on the public key algorithms that can be used by the client when performing public key authentication to the server. The default value is *ssh-ed25519,ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521,rsa-sha2-256,rsa-sha2-512,ssh-rsa,ssh-dss,x509v3-sign-rsa,x509v3-sign-dss*. **SSHVersionPattern**: The pattern used to match the remote host's version string.This configuration setting specifies the pattern used to accept or deny the remote host's SSH version string. It takes a comma-delimited list of patterns to match. The default value is "*SSH-1.99-*,*SSH-2.0-*" and will accept connections from SSH 1.99 and 2.0 hosts. As an example, the following value would accept connections for SSH 1.99, 2.0, and 2.99 hosts. ```text *SSH-1.99-*,*SSH-2.0-*,*SSH-2.99-* ``` **TryAllAvailableAuthMethods**: If set to true, the struct will try all available authentication methods.The default value is *false*. When set to *true*, the struct will try to authenticate using all methods that it has credentials for and the server supports. **UseStrictKeyExchange**: Specifies how strict key exchange is supported.This configuration setting controls whether strict key exchange (strict kex) is enabled to mitigate the Terrapin attack. When enabled, the struct will indicate support for strict key exchange by automatically including the pseudo-algorithm *kex-strict-c-v00@openssh.com* for client structs and *kex-strict-s-v00@openssh.com* for server structs in the list of supported key exchange algorithms. Because both client and server must implement strict key exchange to effectively mitigate the Terrapin attack, the struct provides options to further control the behavior in different scenarios. Possible values for this setting are as follows: | | | | --- | --- | | 0 | Disabled. Strict key exchange is not supported in the struct. | | 1 (default) | Enabled, but not enforced. This setting enables strict key exchange, but if the remote host does not support strict key exchange the connection is still allowed to continue. | | 2 | Enabled, but will reject affected algorithms if the remote host does not support strict key exchange. If the remote host supports strict key exchange, all algorithms may be used. If the remote host does not support strict key exchange, the connection will continue only if the selected encryption and message authentication code (MAC) algorithms are not affected by the Terrapin attack. | | 3 | Required. If the remote host does not support strict key exchange, the connection will fail. | **WaitForChannelClose**: Whether to wait for channels to be closed before disconnected.This configuration setting controls whether the struct will wait for a server response to the SSH_MSG_CHANNEL_CLOSE when disconnecting. When the struct disconnects, it will first attempt to close all open channels by sending a SSH_MSG_CHANNEL_CLOSE for each channel. This configuration setting controls whether the struct will wait for a server response after sending the messages. When *True* (default), the struct will wait for a response to the channel close message until the responses have been received, the server closes the connection, or timeout seconds is reached. When *False*, the struct will still send the channel close messages, but it will not wait for a response and will proceed to close the connection. **WaitForServerDisconnect**: Whether to wait for the server to close the connection.This configuration setting controls whether to wait for the server to close the connection when ssh_logoff is called. When set to *True*, the struct will initiate the disconnection sequence by sending SSH_MSG_DISCONNECT, but it will not close the connection and instead will wait for the server to close the connection. Setting this to True may be beneficial in circumstances in which many connections are being established, to avoid port exhaustion when sockets are in a TIME_WAIT state. Allowing the server to close the connection avoids the TIME_WAIT state of socket on the client machine. When set to *False* (default), the client will close the connection. It is recommended to use this value unless there is a specific need to change it. ### TCPClient Config Settings **ConnectionTimeout**: Sets a separate timeout value for establishing a connection.When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the struct will use timeout for establishing a connection and transmitting/receiving data. **FirewallAutoDetect**: Tells the struct whether or not to automatically detect and use firewall system settings, if available.This configuration setting is provided for use by structs that do not directly expose Firewall properties. **FirewallHost**: Name or IP address of firewall (optional).If a [FirewallHost](#FirewallHost) is given, requested connections will be authenticated through the specified firewall when connecting. If the [FirewallHost](#FirewallHost) setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the [FirewallHost](#FirewallHost) setting is set to the corresponding address. If the search is not successful, an error is returned. NOTE: This setting is provided for use by structs that do not directly expose Firewall properties. **FirewallHTTPVersion**: The HTTP version to be used when connecting through a tunneling proxy.When [FirewallType](#FirewallType) is set to a tunneling proxy, this setting dictates which HTTP version is used when connecting. **FirewallPassword**: Password to be used if authentication is to be used when connecting through the firewall.If [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the given firewall. If the authentication fails, the struct fails with an error. NOTE: This setting is provided for use by structs that do not directly expose Firewall properties. **FirewallPort**: The TCP port for the FirewallHost;.The [FirewallPort](#FirewallPort) is set automatically when [FirewallType](#FirewallType) is set to a valid value. NOTE: This configuration setting is provided for use by structs that do not directly expose Firewall properties. **FirewallType**: Determines the type of firewall to connect through.Possible values are as follows: | | | | --- | --- | | 0 | No firewall (default setting). | | 1 | Connect through a tunneling proxy. [FirewallPort](#FirewallPort) is set to 80. | | 2 | Connect through a SOCKS4 Proxy. [FirewallPort](#FirewallPort) is set to 1080. | | 3 | Connect through a SOCKS5 Proxy. [FirewallPort](#FirewallPort) is set to 1080. | | 10 | Connect through a SOCKS4A Proxy. [FirewallPort](#FirewallPort) is set to 1080. | NOTE: This setting is provided for use by structs that do not directly expose Firewall properties. **FirewallUser**: A user name if authentication is to be used connecting through a firewall.If the [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the Firewall. If the authentication fails, the struct fails with an error. NOTE: This setting is provided for use by structs that do not directly expose Firewall properties. **KeepAliveInterval**: The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.When set, [TCPKeepAlive](#TCPKeepAlive) will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by [KeepAliveTime](#KeepAliveTime). If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second. NOTE: This value is not applicable in macOS. **KeepAliveTime**: The inactivity time in milliseconds before a TCP keep-alive packet is sent.When set, [TCPKeepAlive](#TCPKeepAlive) will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds. **Linger**: When set to True, connections are terminated gracefully.This property controls how a connection is closed. The default is True. In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if [LingerTime](#LingerTime) is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires. In the second scenario, if [LingerTime](#LingerTime) is a positive value, the system will attempt to send pending data until the specified [LingerTime](#LingerTime) is reached. If this attempt fails, then the system will reset the connection. The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the struct returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes). Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action. **LingerTime**: Time in seconds to have the connection linger. LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout. **LocalHost**: The name of the local host through which connections are initiated or accepted. The [local_host](#local_host-property-sshtunnel-struct) setting 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 value of an interface will make the struct initiate connections (or accept in the case of server structs) only through that interface. If the struct is connected, the [local_host](#local_host-property-sshtunnel-struct) setting 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). **LocalPort**: The port in the local host where the struct binds. This configuration setting must be set before a connection is attempted. It instructs the struct to bind to a specific port (or communication endpoint) in the local machine. Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by [local_port](#local_port-property-sshtunnel-struct) after the connection is established. [local_port](#local_port-property-sshtunnel-struct) cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error. This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems. **MaxLineLength**: The maximum amount of data to accumulate when no EOL is found.[MaxLineLength](#MaxLineLength) is the size of an internal buffer, which holds received data while waiting for an eol string. If an eol string is found in the input stream before [MaxLineLength](#MaxLineLength) bytes are received, the [on_data_in](#on_data_in-event-sshtunnel-struct) event is fired with the *EOL* parameter set to True, and the buffer is reset. If no eol is found, and [MaxLineLength](#MaxLineLength) bytes are accumulated in the buffer, the [on_data_in](#on_data_in-event-sshtunnel-struct) event is fired with the *EOL* parameter set to False, and the buffer is reset. The minimum value for [MaxLineLength](#MaxLineLength) is 256 bytes. The default value is 2048 bytes. **MaxTransferRate**: The transfer rate limit in bytes per second.This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit. **ProxyExceptionsList**: A semicolon separated list of hosts and IPs to bypass when using a proxy.This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance: *www.google.com;www.example.com* **TCPKeepAlive**: Determines whether or not the keep alive socket option is enabled.If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set [KeepAliveTime](#KeepAliveTime) and [KeepAliveInterval](#KeepAliveInterval) to configure the timing of the keep-alive packets. NOTE: This value is not applicable in Java. **TcpNoDelay**: Whether or not to delay when sending packets. When set to True, the socket will send all data that are ready to send at once. When set to False, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm. By default, this configuration setting is set to False. **UseIPv6**: Whether to use IPv6.When set to *0* (default), the struct will use IPv4 exclusively. When set to *1*, the struct will use IPv6 exclusively. To instruct the struct to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to *2*. The default value is *0*. Possible values are as follows: | | | | --- | --- | | 0 | IPv4 only | | 1 | IPv6 only | | 2 | IPv6 with IPv4 fallback | **UseNTLMv2**: Whether to use NTLM V2.When authenticating with NTLM, this setting specifies whether NTLM V2 is used. By default this value is True and NTLM V2 will be used. Set this to False to use NTLM V1. ### Socket Config Settings **AbsoluteTimeout**: Determines whether timeouts are inactivity timeouts or absolute timeouts.If [AbsoluteTimeout](#AbsoluteTimeout) is set to True, any method that does not complete within timeout seconds will be aborted. By default, *AbsoluteTimeout* is False, and the timeout is an inactivity timeout. NOTE: This option is not valid for User Datagram Protocol (UDP) ports. **FirewallData**: Used to send extra data to the firewall.When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g., headers for custom authentication schemes). **InBufferSize**: The size in bytes of the incoming queue of the socket.This is the size of an internal queue in the Transmission Control Protocol (TCP)/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. In some cases, increasing the value of the *InBufferSize* setting can provide significant improvements in performance. Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the struct is activated the *InBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small. **OutBufferSize**: The size in bytes of the outgoing queue of the socket.This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. In some cases, increasing the value of the *OutBufferSize* setting can provide significant improvements in performance. Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the struct is activated the *OutBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small. ### TCPServer Config Settings **AllowedClients**: A comma-separated list of host names or IP addresses that can access the struct.This configuration setting defines a comma-separated list of host names or IPv4 addresses that may access the struct. The wildcard character "*" is supported. The default value is "*" and all connections are accepted. When a client connects, the client's address is checked against the list defined here. If there is no match, the [on_connection_request](#on_connection_request-event-sshtunnel-struct) event fires with an *Accept* value set to *false*. If no action is taken within the [on_connection_request](#on_connection_request-event-sshtunnel-struct) event, the client will be disconnected. **BindExclusively**: Whether or not the component considers a local port reserved for exclusive use.If this is *true* (default), the component will bind to the local port with the ExclusiveAddressUse option set, meaning that nothing else can bind to the same port. Also the component will not be able to bind to local ports that are already in use by some other instance, and attempts to do so will result in failure. **BlockedClients**: A comma-separated list of host names or IP addresses that cannot access the struct.This configuration setting defines a comma-separated list of host names or IPv4 addresses that cannot access the struct.The default value is "" and all connections are accepted. When a client connects, the client's address is checked against the list defined here. If there is a match, the [on_connection_request](#on_connection_request-event-sshtunnel-struct) event fires with an *Accept* value set to *false*. If no action is taken within the [on_connection_request](#on_connection_request-event-sshtunnel-struct) event, the client will not be connected. **DefaultConnectionTimeout**: The inactivity timeout applied to the SSL handshake.This configuration setting specifies the inactivity (in seconds) to apply to incoming Secure Sockets Layer (SSL) connections. When set to a positive value, if the other end is unresponsive for the specified number of seconds, the connection will timeout. This is not applicable to the entire handshake. It is applicable only to the inactivity of the connecting client during the handshake if a response is expected and none is received within the timeout window. The default value is 0, and no connection-specific timeout is applied. NOTE: This is applicable only to incoming SSL connections. This should be set only if there is a specific reason to do so. **InBufferSize**: The size in bytes of the incoming queue of the socket. This is the size of an internal queue in the Transmission Control Protocol (TCP)/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. Increasing the value of the [InBufferSize](#InBufferSize) setting can provide significant improvements in performance in some cases. Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the struct is activated, the [InBufferSize](#InBufferSize) reverts to its defined size. The same thing will happen if you attempt to make it too large or too small. [InBufferSize](#InBufferSize) is shared among incoming connections. When the setting is set, the corresponding value is set for incoming connections as they are accepted. Existing connections are not modified. **KeepAliveInterval**: The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.A TCP keep-alive packet will be sent after a period of inactivity, as defined by [KeepAliveTime](#KeepAliveTime). If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. If this value is not specified here, the system default is 1 second. This setting is applicable to all connections. NOTE: This value is not applicable in macOS. **KeepAliveTime**: The inactivity time in milliseconds before a TCP keep-alive packet is sent.By default, the operating system will determine the time a connection is idle before a TCP keep-alive packet is sent. If this value is not specified here, the system default is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds. This setting is applicable to all connections. **MaxConnections**: The maximum number of connections available. This is the maximum number of connections available. This setting must be set before [listening](#listening-property-sshtunnel-struct) is set to *true*, and once set, it can no longer be changed for the current instance of the struct. The maximum value for this setting is 100,000 connections. Use this setting with caution. Extremely large values may affect performance. The default value is 1000. NOTE: Unix/Linux operating systems limit the number of simultaneous connections to 1024. **OutBufferSize**: The size in bytes of the outgoing queue of the socket.This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. Increasing the value of the [OutBufferSize](#OutBufferSize) setting can provide significant improvements in performance in some cases. Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the struct is activated the [OutBufferSize](#OutBufferSize) reverts to its defined size. The same thing will happen if you attempt to make it too large or too small. [OutBufferSize](#OutBufferSize) is shared among incoming connections. When the setting is set, the corresponding value is set for incoming connections as they are accepted. Existing connections are not modified. **TcpNoDelay**: Whether or not to delay when sending packets. When set to True, the socket will send all data that are ready to send at once. When set to False, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm. By default, this configuration setting is set to False. **UseIPv6**: Whether to use IPv6.When set to 0 (default), the struct will use IPv4 exclusively. When set to 1, the struct will use IPv6 exclusively. When set to 2, the struct will listen for both IPv4 and IPv6 connections. If IPv6 is not available on the system, only IPv4 will be used. The default value is 0. Possible values are as follows: | | | | --- | --- | | 0 | IPv4 Only | | 1 | IPv6 Only | | 2 | IPv6 and IPv4 | ### Base Config Settings **BuildInfo**: Information about the product's build.When queried, this setting will return a string containing information about the product's build. **CodePage**: The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001). The following is a list of valid code page identifiers: | | | | --- | --- | | Identifier | Name | | 037 | IBM EBCDIC - U.S./Canada | | 437 | OEM - United States | | 500 | IBM EBCDIC - International | | 708 | Arabic - ASMO 708 | | 709 | Arabic - ASMO 449+, BCON V4 | | 710 | Arabic - Transparent Arabic | | 720 | Arabic - Transparent ASMO | | 737 | OEM - Greek (formerly 437G) | | 775 | OEM - Baltic | | 850 | OEM - Multilingual Latin I | | 852 | OEM - Latin II | | 855 | OEM - Cyrillic (primarily Russian) | | 857 | OEM - Turkish | | 858 | OEM - Multilingual Latin I + Euro symbol | | 860 | OEM - Portuguese | | 861 | OEM - Icelandic | | 862 | OEM - Hebrew | | 863 | OEM - Canadian-French | | 864 | OEM - Arabic | | 865 | OEM - Nordic | | 866 | OEM - Russian | | 869 | OEM - Modern Greek | | 870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) | | 874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) | | 875 | IBM EBCDIC - Modern Greek | | 932 | ANSI/OEM - Japanese, Shift-JIS | | 936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) | | 949 | ANSI/OEM - Korean (Unified Hangul Code) | | 950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) | | 1026 | IBM EBCDIC - Turkish (Latin-5) | | 1047 | IBM EBCDIC - Latin 1/Open System | | 1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) | | 1141 | IBM EBCDIC - Germany (20273 + Euro symbol) | | 1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) | | 1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) | | 1144 | IBM EBCDIC - Italy (20280 + Euro symbol) | | 1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) | | 1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) | | 1147 | IBM EBCDIC - France (20297 + Euro symbol) | | 1148 | IBM EBCDIC - International (500 + Euro symbol) | | 1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) | | 1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) | | 1201 | Unicode UCS-2 Big-Endian | | 1250 | ANSI - Central European | | 1251 | ANSI - Cyrillic | | 1252 | ANSI - Latin I | | 1253 | ANSI - Greek | | 1254 | ANSI - Turkish | | 1255 | ANSI - Hebrew | | 1256 | ANSI - Arabic | | 1257 | ANSI - Baltic | | 1258 | ANSI/OEM - Vietnamese | | 1361 | Korean (Johab) | | 10000 | MAC - Roman | | 10001 | MAC - Japanese | | 10002 | MAC - Traditional Chinese (Big5) | | 10003 | MAC - Korean | | 10004 | MAC - Arabic | | 10005 | MAC - Hebrew | | 10006 | MAC - Greek I | | 10007 | MAC - Cyrillic | | 10008 | MAC - Simplified Chinese (GB 2312) | | 10010 | MAC - Romania | | 10017 | MAC - Ukraine | | 10021 | MAC - Thai | | 10029 | MAC - Latin II | | 10079 | MAC - Icelandic | | 10081 | MAC - Turkish | | 10082 | MAC - Croatia | | 12000 | Unicode UCS-4 Little-Endian | | 12001 | Unicode UCS-4 Big-Endian | | 20000 | CNS - Taiwan | | 20001 | TCA - Taiwan | | 20002 | Eten - Taiwan | | 20003 | IBM5550 - Taiwan | | 20004 | TeleText - Taiwan | | 20005 | Wang - Taiwan | | 20105 | IA5 IRV International Alphabet No. 5 (7-bit) | | 20106 | IA5 German (7-bit) | | 20107 | IA5 Swedish (7-bit) | | 20108 | IA5 Norwegian (7-bit) | | 20127 | US-ASCII (7-bit) | | 20261 | T.61 | | 20269 | ISO 6937 Non-Spacing Accent | | 20273 | IBM EBCDIC - Germany | | 20277 | IBM EBCDIC - Denmark/Norway | | 20278 | IBM EBCDIC - Finland/Sweden | | 20280 | IBM EBCDIC - Italy | | 20284 | IBM EBCDIC - Latin America/Spain | | 20285 | IBM EBCDIC - United Kingdom | | 20290 | IBM EBCDIC - Japanese Katakana Extended | | 20297 | IBM EBCDIC - France | | 20420 | IBM EBCDIC - Arabic | | 20423 | IBM EBCDIC - Greek | | 20424 | IBM EBCDIC - Hebrew | | 20833 | IBM EBCDIC - Korean Extended | | 20838 | IBM EBCDIC - Thai | | 20866 | Russian - KOI8-R | | 20871 | IBM EBCDIC - Icelandic | | 20880 | IBM EBCDIC - Cyrillic (Russian) | | 20905 | IBM EBCDIC - Turkish | | 20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) | | 20932 | JIS X 0208-1990 & 0121-1990 | | 20936 | Simplified Chinese (GB2312) | | 21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) | | 21027 | Extended Alpha Lowercase | | 21866 | Ukrainian (KOI8-U) | | 28591 | ISO 8859-1 Latin I | | 28592 | ISO 8859-2 Central Europe | | 28593 | ISO 8859-3 Latin 3 | | 28594 | ISO 8859-4 Baltic | | 28595 | ISO 8859-5 Cyrillic | | 28596 | ISO 8859-6 Arabic | | 28597 | ISO 8859-7 Greek | | 28598 | ISO 8859-8 Hebrew | | 28599 | ISO 8859-9 Latin 5 | | 28605 | ISO 8859-15 Latin 9 | | 29001 | Europa 3 | | 38598 | ISO 8859-8 Hebrew | | 50220 | ISO 2022 Japanese with no halfwidth Katakana | | 50221 | ISO 2022 Japanese with halfwidth Katakana | | 50222 | ISO 2022 Japanese JIS X 0201-1989 | | 50225 | ISO 2022 Korean | | 50227 | ISO 2022 Simplified Chinese | | 50229 | ISO 2022 Traditional Chinese | | 50930 | Japanese (Katakana) Extended | | 50931 | US/Canada and Japanese | | 50933 | Korean Extended and Korean | | 50935 | Simplified Chinese Extended and Simplified Chinese | | 50936 | Simplified Chinese | | 50937 | US/Canada and Traditional Chinese | | 50939 | Japanese (Latin) Extended and Japanese | | 51932 | EUC - Japanese | | 51936 | EUC - Simplified Chinese | | 51949 | EUC - Korean | | 51950 | EUC - Traditional Chinese | | 52936 | HZ-GB2312 Simplified Chinese | | 54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) | | 57002 | ISCII Devanagari | | 57003 | ISCII Bengali | | 57004 | ISCII Tamil | | 57005 | ISCII Telugu | | 57006 | ISCII Assamese | | 57007 | ISCII Oriya | | 57008 | ISCII Kannada | | 57009 | ISCII Malayalam | | 57010 | ISCII Gujarati | | 57011 | ISCII Punjabi | | 65000 | Unicode UTF-7 | | 65001 | Unicode UTF-8 | The following is a list of valid code page identifiers for Mac OS only: | | | | --- | --- | | Identifier | Name | | 1 | ASCII | | 2 | NEXTSTEP | | 3 | JapaneseEUC | | 4 | UTF8 | | 5 | ISOLatin1 | | 6 | Symbol | | 7 | NonLossyASCII | | 8 | ShiftJIS | | 9 | ISOLatin2 | | 10 | Unicode | | 11 | WindowsCP1251 | | 12 | WindowsCP1252 | | 13 | WindowsCP1253 | | 14 | WindowsCP1254 | | 15 | WindowsCP1250 | | 21 | ISO2022JP | | 30 | MacOSRoman | | 10 | UTF16String | | 0x90000100 | UTF16BigEndian | | 0x94000100 | UTF16LittleEndian | | 0x8c000100 | UTF32String | | 0x98000100 | UTF32BigEndian | | 0x9c000100 | UTF32LittleEndian | | 65536 | Proprietary | **LicenseInfo**: Information about the current license.When queried, this setting will return a string containing information about the license this instance of a struct is using. It will return the following information: - Product: The product the license is for. - Product Key: The key the license was generated from. - License Source: Where the license was found (e.g., RuntimeLicense, License File). - License Type: The type of license installed (e.g., Royalty Free, Single Server). - Last Valid Build: The last valid build number for which the license will work. **MaskSensitiveData**: Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to *true* to mask sensitive data. The default is *true*. **UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *false*, the struct will use the system security libraries by default to perform cryptographic functions where applicable. Setting this configuration setting to *true* tells the struct to use the internal implementation instead of using the system security libraries. On Windows, this setting is set to *false* by default. On Linux/macOS, this setting is set to *true* by default. To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the [OpenSSL Notes](platforms.md) section. # Trappable Errors ([SSHTunnel](#struct-ipworkssshsshtunnel) Struct) ### SSHTunnel Errors | | | | --- | --- | | 100 | You cannot change the remote_port at this time. A connection is in progress. | | 101 | You cannot change the remote_host at this time. A connection is in progress. | | 102 | The remote_host address is invalid (0.0.0.0). | | 104 | TCPServer is already listening. | | 106 | Cannot change [local_port](#local_port-property-sshtunnel-struct) when TCPServer is listening. | | 107 | Cannot change [local_host](#local_host-property-sshtunnel-struct) when TCPServer is listening. | | 108 | Cannot change [MaxConnections](#MaxConnections) when TCPServer is listening. | | 112 | You cannot change [MaxLineLength](#MaxLineLength) at this time. A connection is in progress. | | 116 | remote_port cannot be zero. Please specify a valid service port number. | | 126 | Invalid ConnectionId. | | 1201 | Could not forward connection. A detailed message follows. | | 1202 | Could not forward connection/channel data. A detailed message follows. | ### SSHClient Errors | | | | --- | --- | | 1001 | Server has disconnected. | | 1002 | Protocol version unsupported or other issue with version string. | | 1003 | Cannot negotiate algorithms. | | 1005 | Selected algorithm unsupported. | | 1006 | Cannot set keys. | | 1010 | Unexpected algorithm. | | 1011 | Cannot create exchange hash. | | 1012 | Cannot make key. | | 1013 | Cannot sign data. | | 1014 | Cannot encrypt packet. | | 1015 | Cannot decrypt packet. | | 1016 | Cannot decompress packet. | | 1020 | Failure to open channel. | | 1021 | Invalid channel Id. | | 1022 | Invalid channel data. | | 1023 | Invalid channel message. | | 1024 | SSH message unimplemented. | | 1027 | Server message unsupported. | | 1030 | Server's host key was rejected. The host key may be accepted within the [on_ssh_server_authentication](#on_ssh_server_authentication-event-sshtunnel-struct) event or using the ssh_accept_server_host_key property. | | 1031 | Cannot verify server's host key. | | 1032 | Authentication failed. Check description for details. | | 1033 | Channel request failed. | | 1034 | Diffie-Hellman exchange failed. | | 1036 | SSH connection failed. | | 1037 | SSH reconnect limit reached. | | 1038 | Elliptic curve Diffie-Hellman exchange failed. | | 1039 | SSH keep-alive limit reached. | | 1098 | Request failure. | | 1130 | Would block error. | | 1133 | Would block, reason: key reExchange. | The class may also return one of the following error codes, which are inherited from other classes. ### TCPClient Errors | | | | --- | --- | | 100 | You cannot change the remote_port at this time. A connection is in progress. | | 101 | You cannot change the remote_host (Server) at this time. A connection is in progress. | | 102 | The remote_host address is invalid (0.0.0.0). | | 104 | Already connected. If you want to reconnect, close the current connection first. | | 106 | You cannot change the [local_port](#local_port-property-sshtunnel-struct) at this time. A connection is in progress. | | 107 | You cannot change the [local_host](#local_host-property-sshtunnel-struct) at this time. A connection is in progress. | | 112 | You cannot change [MaxLineLength](#MaxLineLength) at this time. A connection is in progress. | | 116 | remote_port cannot be zero. Please specify a valid service port number. | | 117 | You cannot change the UseConnection option while the struct is active. | | 135 | Operation would block. | | 201 | Timeout. | | 211 | Action impossible in control's present state. | | 212 | Action impossible while not connected. | | 213 | Action impossible while listening. | | 301 | Timeout. | | 302 | Could not open file. | | 434 | Unable to convert string to selected CodePage. | | 1105 | Already connecting. If you want to reconnect, close the current connection first. | | 1117 | You need to connect first. | | 1119 | You cannot change the LocalHost at this time. A connection is in progress. | | 1120 | Connection dropped by remote host. | ### TCP/IP Errors | | | | --- | --- | | 10004 | [10004] Interrupted system call. | | 10009 | [10009] Bad file number. | | 10013 | [10013] Access denied. | | 10014 | [10014] Bad address. | | 10022 | [10022] Invalid argument. | | 10024 | [10024] Too many open files. | | 10035 | [10035] Operation would block. | | 10036 | [10036] Operation now in progress. | | 10037 | [10037] Operation already in progress. | | 10038 | [10038] Socket operation on nonsocket. | | 10039 | [10039] Destination address required. | | 10040 | [10040] Message is too long. | | 10041 | [10041] Protocol wrong type for socket. | | 10042 | [10042] Bad protocol option. | | 10043 | [10043] Protocol is not supported. | | 10044 | [10044] Socket type is not supported. | | 10045 | [10045] Operation is not supported on socket. | | 10046 | [10046] Protocol family is not supported. | | 10047 | [10047] Address family is not supported by protocol family. | | 10048 | [10048] Address already in use. | | 10049 | [10049] Cannot assign requested address. | | 10050 | [10050] Network is down. | | 10051 | [10051] Network is unreachable. | | 10052 | [10052] Net dropped connection or reset. | | 10053 | [10053] Software caused connection abort. | | 10054 | [10054] Connection reset by peer. | | 10055 | [10055] No buffer space available. | | 10056 | [10056] Socket is already connected. | | 10057 | [10057] Socket is not connected. | | 10058 | [10058] Cannot send after socket shutdown. | | 10059 | [10059] Too many references, cannot splice. | | 10060 | [10060] Connection timed out. | | 10061 | [10061] Connection refused. | | 10062 | [10062] Too many levels of symbolic links. | | 10063 | [10063] File name is too long. | | 10064 | [10064] Host is down. | | 10065 | [10065] No route to host. | | 10066 | [10066] Directory is not empty | | 10067 | [10067] Too many processes. | | 10068 | [10068] Too many users. | | 10069 | [10069] Disc Quota Exceeded. | | 10070 | [10070] Stale NFS file handle. | | 10071 | [10071] Too many levels of remote in path. | | 10091 | [10091] Network subsystem is unavailable. | | 10092 | [10092] WINSOCK DLL Version out of range. | | 10093 | [10093] Winsock is not loaded yet. | | 11001 | [11001] Host not found. | | 11002 | [11002] Nonauthoritative 'Host not found' (try again or check DNS setup). | | 11003 | [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP. | | 11004 | [11004] Valid name, no data record (check DNS setup). |