SshTunnel C# Reference Documentation

SshTunnel

Current Version: 10.0.0
Requires Chilkat Bundle License

The SSH tunnel class provides for the ability to run a self-contained SSH tunnel in a background thread. It can behave as a SOCKS proxy, accepting connections from SOCKS4 or SOCK5 proxy clients and fowarding connections through an SSH tunnel. This is the "dynamic port forwarding" mode of operation. It can also behave in a static port forwarding mode (where it accepts connections and forwards the connection to a pre-defined remote destination IP:port).

Object Creation

Chilkat.SshTunnel obj = new Chilkat.SshTunnel();

Properties

AbortCurrent
public bool AbortCurrent {get; set; }
Introduced in version 9.5.0.58

When set to true, causes the currently running method to abort. Methods that always finish quickly (i.e.have no length file operations or network communications) are not affected. If no method is running, then this property is automatically reset to false when the next method is called. When the abort occurs, this property is reset to false. Both synchronous and asynchronous method calls can be aborted. (A synchronous method call could be aborted by setting this property from a separate thread.)

top
AcceptLog
public string AcceptLog {get; set; }

Contains an in-memory log of the listen thread. This will only contain content if the KeepAcceptLog property is true.

top
AcceptLogPath
public string AcceptLogPath {get; set; }
Introduced in version 9.5.0.50

Specifies a log file to be kept for the activity in the listen thread.

top
ClientIdentifier
public string ClientIdentifier {get; set; }
Introduced in version 9.5.0.95

The client-identifier string to be used when connecting to an SSH/SFTP server. Starting in Chilkat v9.5.0.99, the default is "SSH-2.0-Chilkat_" + the Chilkat version number, such as "SSH-2.0-Chilkat_9.5.0.99".

Note: The client identifier should always begin with "SSH-2.0-". SSH servers may disconnect if it does not.

top
ConnectTimeoutMs
public int ConnectTimeoutMs {get; set; }

Maximum number of milliseconds to wait when connecting to an SSH server. The default value is 10000 (i.e. 10 seconds). A value of 0 indicates no timeout (wait forever).

top
DebugLogFilePath
public string DebugLogFilePath {get; set; }

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

More Information and Examples
(.NET Core C#) Example showing how to use DebugLogFilePath.(C#) Example showing how to use DebugLogFilePath.(Mono C#) Example showing how to use DebugLogFilePath.(PowerShell) Example showing how to use DebugLogFilePath.
top
DestHostname
public string DestHostname {get; set; }

The destination hostname or IP address (in dotted decimal notation) of the service (such as a database server). Data sent through the SSH tunnel is forwarded by the SSH server to this destination. Data received from the destination (by the SSH server) is forwarded back to the client through the SSH tunnel.

top
DestPort
public int DestPort {get; set; }

The destination port of the service (such as a database server).

top
DynamicPortForwarding
public bool DynamicPortForwarding {get; set; }
Introduced in version 9.5.0.50

If true, then this behaves as a SOCKS proxy server for inbound connections. When this property is true, the DestHostname and DestPort properties are unused because the destination IP:port is dynamically provided by the SOCKS client. The default value of this property is false.

When dynamic port forwarding is used, the InboundSocksVersion property must be set to 4 or 5. If inbound SOCKS5 is used, then the InboundSocksUsername and InboundSocksPassword may be set to the required login/password for a client to gain access.

More Information and Examples
(.NET Core C#) SSH Tunnel with Dynamic Port Forwarding(C#) SSH Tunnel with Dynamic Port Forwarding(Mono C#) SSH Tunnel with Dynamic Port Forwarding(PowerShell) SSH Tunnel with Dynamic Port Forwarding
top
HostKeyFingerprint
public string HostKeyFingerprint {get; }
Introduced in version 9.5.0.56

Set after connecting to an SSH server. The format of the fingerprint looks like this: "ssh-rsa 1024 68:ff:d1:4e:6c:ff:d7:b0:d6:58:73:85:07:bc:2e:d5"

top
HttpProxyAuthMethod
public string HttpProxyAuthMethod {get; set; }

If an HTTP proxy requiring authentication is to be used, set this property to the HTTP proxy authentication method name. Valid choices are "Basic" or "NTLM".

Note: This is for the outbound connection to the SSH server. It is used when the outbound connection to the SSH server must go through an HTTP proxy.

top
HttpProxyDomain
public string HttpProxyDomain {get; set; }

The NTLM authentication domain (optional) if NTLM authentication is used w/ the HTTP proxy.

Note: This is for the outbound connection to the SSH server. It is used when the outbound connection to the SSH server must go through an HTTP proxy.

top
HttpProxyHostname
public string HttpProxyHostname {get; set; }

If an HTTP proxy is to be used, set this property to the HTTP proxy hostname or IPv4 address (in dotted decimal notation).

Note: This is for the outbound connection to the SSH server. It is used when the outbound connection to the SSH server must go through an HTTP proxy.

top
HttpProxyPassword
public string HttpProxyPassword {get; set; }

If an HTTP proxy requiring authentication is to be used, set this property to the HTTP proxy password.

Note: This is for the outbound connection to the SSH server. It is used when the outbound connection to the SSH server must go through an HTTP proxy.

top
HttpProxyPort
public int HttpProxyPort {get; set; }

If an HTTP proxy is to be used, set this property to the HTTP proxy port number. (Two commonly used HTTP proxy ports are 8080 and 3128.)

Note: This is for the outbound connection to the SSH server. It is used when the outbound connection to the SSH server must go through an HTTP proxy.

top
HttpProxyUsername
public string HttpProxyUsername {get; set; }

If an HTTP proxy requiring authentication is to be used, set this property to the HTTP proxy login name.

Note: This is for the outbound connection to the SSH server. It is used when the outbound connection to the SSH server must go through an HTTP proxy.

top
IdleTimeoutMs
public int IdleTimeoutMs {get; set; }

A tunnel will fail when progress for sending or receiving data halts for more than this number of milliseconds. The default value is 10,000 (which is 10 seconds). A timeout of 0 indicates an infinite wait time (i.e. no timeout).

top
InboundSocksPassword
public string InboundSocksPassword {get; set; }
Introduced in version 9.5.0.50

If dynamic port forwarding is used, then this may be set to the password required for authenticating inbound connections.

top
InboundSocksUsername
public string InboundSocksUsername {get; set; }
Introduced in version 9.5.0.50

If dynamic port forwarding is used, then this may be set to the username required for authenticating inbound connections. If no username is set, then the inbound connection needs no authentication.

top
IsAccepting
public bool IsAccepting {get; }

true if a background thread is running and accepting connections.

top
KeepAcceptLog
public bool KeepAcceptLog {get; set; }

If true, then an in-memory log of the listen thread is kept. The default value is false.

top
KeepTunnelLog
public bool KeepTunnelLog {get; set; }
Introduced in version 9.5.0.50

If true, then a log of the SSH tunnel thread activity is kept in memory. The default value is false.

top
LastErrorHtml
public string LastErrorHtml {get; }

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorText
public string LastErrorText {get; }

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

More Information and Examples
Concept of LastErrorTextLastErrorText Standard Information
top
LastErrorXml
public string LastErrorXml {get; }

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastMethodSuccess
public bool LastMethodSuccess {get; set; }

Indicate whether the last method call succeeded or failed. A value of true indicates success, a value of false indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = true and failure = false.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to true. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
ListenBindIpAddress
public string ListenBindIpAddress {get; set; }

In most cases, this property does not need to be set. It is provided for cases where it is required to bind the listen socket to a specific IP address (usually for computers with multiple network interfaces or IP addresses). For computers with a single network interface (i.e. most computers), this property should not be set. For multihoming computers, the default IP address is automatically used if this property is not set.

top
ListenPort
public int ListenPort {get; }

If a port number equal to 0 is passed to BeginAccepting, then this property will contain the actual allocated port number used. Otherwise it is equal to the port number passed to BeginAccepting, or 0 if BeginAccepting was never called.

top
OutboundBindIpAddress
public string OutboundBindIpAddress {get; set; }

In most cases, this property does not need to be set. It is provided for cases where it is required to bind the socket that is to connect to the SSH server (in the background thread) to a specific IP address (usually for computers with multiple network interfaces or IP addresses). For computers with a single network interface (i.e. most computers), this property should not be set. For multihoming computers, the default IP address is automatically used if this property is not set.

top
OutboundBindPort
public int OutboundBindPort {get; set; }

Unless there is a specific requirement for binding to a specific port, leave this unset (at the default value of 0). (99.9% of all users should never need to set this property.)

top
PreferIpv6
public bool PreferIpv6 {get; set; }
Introduced in version 9.5.0.70

If true, then use IPv6 over IPv4 when both are supported for a particular domain. The default value of this property is false, which will choose IPv4 over IPv6.

top
SocksHostname
public string SocksHostname {get; set; }

The SOCKS4/SOCKS5 hostname or IPv4 address (in dotted decimal notation). This property is only used if the SocksVersion property is set to 4 or 5).

Note: This is for the outbound connection to the SSH server. It is used when the outbound connection to the SSH server must go through a SOCKS4 or SOCKS5 proxy.

top
SocksPassword
public string SocksPassword {get; set; }

The SOCKS5 password (if required). The SOCKS4 protocol does not include the use of a password, so this does not apply to SOCKS4.

Note: This is for the outbound connection to the SSH server. It is used when the outbound connection to the SSH server must go through a SOCKS4 or SOCKS5 proxy.

top
SocksPort
public int SocksPort {get; set; }

The SOCKS4/SOCKS5 proxy port. The default value is 1080. This property only applies if a SOCKS proxy is used (if the SocksVersion property is set to 4 or 5).

Note: This is for the outbound connection to the SSH server. It is used when the outbound connection to the SSH server must go through a SOCKS4 or SOCKS5 proxy.

top
SocksUsername
public string SocksUsername {get; set; }

The SOCKS4/SOCKS5 proxy username. This property is only used if the SocksVersion property is set to 4 or 5).

Note: This is for the outbound connection to the SSH server. It is used when the outbound connection to the SSH server must go through a SOCKS4 or SOCKS5 proxy.

top
SocksVersion
public int SocksVersion {get; set; }

SocksVersion May be set to one of the following integer values:

0 - No SOCKS proxy is used. This is the default.
4 - Connect via a SOCKS4 proxy.
5 - Connect via a SOCKS5 proxy.

Note: This is for the outbound connection to the SSH server. It is used when the outbound connection to the SSH server must go through a SOCKS4 or SOCKS5 proxy.

top
SoRcvBuf
public int SoRcvBuf {get; set; }

Sets the receive buffer size socket option. Normally, this property should be left unchanged. The default value is 4194304.

This property can be increased if download performance seems slow. It is recommended to be a multiple of 4096.

More Information and Examples
More Information about TCP performance and Buffer Sizes
top
SoSndBuf
public int SoSndBuf {get; set; }

Sets the send buffer size socket option. Normally, this property should be left unchanged. The default value is 262144.

This property can be increased if upload performance seems slow. It is recommended to be a multiple of 4096. Testing with sizes such as 512K and 1MB is reasonable.

More Information and Examples
More Information about TCP performance and Buffer Sizes
top
TcpNoDelay
public bool TcpNoDelay {get; set; }

Controls whether the TCP_NODELAY socket option is used for the underlying TCP/IP socket. The default value is false. Setting this property equal to true disables the Nagle algorithm and allows for better performance when small amounts of data are sent.

top
TunnelLog
public string TunnelLog {get; set; }
Introduced in version 9.5.0.50

Contains an in-memory log of the SSH tunnel thread. This will only contain content if the KeepTunnelLog property is true.

top
TunnelLogPath
public string TunnelLogPath {get; set; }
Introduced in version 9.5.0.50

Set to keep a log file of the SSH tunnel thread.

top
UncommonOptions
public string UncommonOptions {get; set; }
Introduced in version 9.5.0.73

This is a catch-all property to be used for uncommon needs. This property defaults to the empty string, and should typically remain empty.

Can be set to a list of the following comma separated keywords:

  • ForceUserAuthRsaSha1 - Introduced in v9.5.0.98. When doing public-key authentication, forces rsa-sha1 to be used for the userauth algorithm even if the server supports rsa-sha2-256, rsa-sha2-512, but still requires SHA1 for the userauth algorithm. Make sure to set this option before connecting to the server.
  • NoKeepAliveIgnoreMsg - Introduced in v9.5.0.76. Prevents the default behavior of the SSH tunnel sending an "ignore" message every 20 seconds to keep an unused connection alive.
  • no-weak-mac-algs - Introduced in v9.5.0.98. Removes all weaker MAC algorithms from the list offered to the SSH server when negotiating the connection parameters during a Connect. Specifically, removes hmac-sha1-96, hmac-sha1, hmac-md5, and hmac-ripemd160. Note: Stronger algorithms such as hmac-sha2-256, hmac-sha2-512, etc., will already be automatically chosen because they are given higher preference. The only way a weaker algorithm is chosen is if the SSH server ONLY supports weaker algorithms. This option would only be set if you explicitly want to avoid connecting to older SSH servers, or servers configured in some unusual way where only weaker algorithms are supported on the server (which is rare).
  • ProtectFromVpn - Introduced in v9.5.0.80. On Android systems, will bypass any VPN that may be installed or active.
  • +ssh-hmac-etm - Introduced in v9.5.0.97. Version 9.5.0.97 disabled the *-etm MAC algorithms to mitigate the Terrapin attack. Use this keyword to include the etm MAC algorithms.
  • [email protected] - Introduced in v9.5.0.97. To mitigate the Terrapin attack, [email protected] is no longer included by default. It can be re-added by adding this keyword.

top
VerboseLogging
public bool VerboseLogging {get; set; }

If set to true, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is false. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

top
Version
public string Version {get; }

Version of the component/library, such as "9.5.0.94"

More Information and Examples
(.NET Core C#) How to get the Chilkat version at runtime.(C#) How to get the Chilkat version at runtime.(Mono C#) How to get the Chilkat version at runtime.(PowerShell) How to get the Chilkat version at runtime.
top

Methods

AuthenticatePk
public bool AuthenticatePk(string username, SshKey privateKey);
Introduced in version 9.5.0.50

Authenticates with the SSH server using public-key authentication. The corresponding public key must have been installed on the SSH server for the username. Authentication will succeed if the matching privateKey is provided.

Important: When reporting problems, please send the full contents of the LastErrorText property to [email protected].

Returns true for success, false for failure.

More Information and Examples
Beware of too much time between connect and authentication.(.NET Core C#) Use PuTTY Key for SSH Tunnel (PPK Private Key)(C#) Use PuTTY Key for SSH Tunnel (PPK Private Key)(Mono C#) Use PuTTY Key for SSH Tunnel (PPK Private Key)(PowerShell) Use PuTTY Key for SSH Tunnel (PPK Private Key)
top
AuthenticatePkAsync (.NET Core C#) (C#) (Mono C#) (PowerShell)
public Task AuthenticatePkAsync(string username, SshKey privateKey);
Introduced in version 9.5.0.50

Creates an asynchronous task to call the AuthenticatePk method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns null on failure

top
AuthenticatePw
public bool AuthenticatePw(string login, string password);
Introduced in version 9.5.0.50

Authenticates with the SSH server using a login and password.

An SSH session always begins by first calling Connect to connect to the SSH server, and then calling either AuthenticatePw or AuthenticatePk to login.

Important: When reporting problems, please send the full contents of the LastErrorText property to [email protected].
Note: To learn about how to handle password change requests, see the PasswordChangeRequested property (above).

Returns true for success, false for failure.

More Information and Examples
Beware of too much time between connect and authentication.
top
AuthenticatePwAsync (.NET Core C#) (C#) (Mono C#) (PowerShell)
public Task AuthenticatePwAsync(string login, string password);
Introduced in version 9.5.0.50

Creates an asynchronous task to call the AuthenticatePw method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns null on failure

top
AuthenticatePwPk
public bool AuthenticatePwPk(string username, string password, SshKey privateKey);
Introduced in version 9.5.0.50

Authentication for SSH servers that require both a password and private key. (Most SSH servers are configured to require one or the other, but not both.)

Important: When reporting problems, please send the full contents of the LastErrorText property to [email protected].

Returns true for success, false for failure.

top
AuthenticatePwPkAsync (.NET Core C#) (C#) (Mono C#) (PowerShell)
public Task AuthenticatePwPkAsync(string username, string password, SshKey privateKey);
Introduced in version 9.5.0.50

Creates an asynchronous task to call the AuthenticatePwPk method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns null on failure

top
AuthenticateSecPw
public bool AuthenticateSecPw(SecureString login, SecureString password);
Introduced in version 9.5.0.71

The same as AuthenticatePw, except the login and password strings are passed in secure string objects.

Returns true for success, false for failure.

More Information and Examples
(.NET Core C#) SSH Tunnel Authenticate Secure(C#) SSH Tunnel Authenticate Secure(Mono C#) SSH Tunnel Authenticate Secure(PowerShell) SSH Tunnel Authenticate Secure
top
AuthenticateSecPwAsync (.NET Core C#) (C#) (Mono C#) (PowerShell)
public Task AuthenticateSecPwAsync(SecureString login, SecureString password);
Introduced in version 9.5.0.71

Creates an asynchronous task to call the AuthenticateSecPw method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns null on failure

top
AuthenticateSecPwPk
public bool AuthenticateSecPwPk(SecureString username, SecureString password, SshKey privateKey);
Introduced in version 9.5.0.71

The same as AuthenticatePwPk, except the login and password strings are passed in secure string objects.

Returns true for success, false for failure.

top
AuthenticateSecPwPkAsync (.NET Core C#) (C#) (Mono C#) (PowerShell)
public Task AuthenticateSecPwPkAsync(SecureString username, SecureString password, SshKey privateKey);
Introduced in version 9.5.0.71

Creates an asynchronous task to call the AuthenticateSecPwPk method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns null on failure

top
BeginAccepting
public bool BeginAccepting(int listenPort);

Starts a background thread for listening on listenPort. A new SSH tunnel is created and managed for each accepted connection. SSH tunnels are managed in a 2nd background thread: the SSH tunnel pool thread.

BeginAccepting starts a background thread that creates a socket, binds to the port, and begins listening. If the bind fails (meaning something else may have already bound to the same port), then the background thread exits. You may check to see if BeginAccepting succeeds by waiting a short time (perhaps 50 millisec) and then examine the IsAccepting property. If it is false, then BeginAccepting failed.

Important: The listenPort must be a port number that nothing else on the local computer is listening on.

Returns true for success, false for failure.

More Information and Examples
(.NET Core C#) SSH Tunnel for Database Connection (such as ADO, ODBC, etc.)(C#) SSH Tunnel for Database Connection (such as ADO, ODBC, etc.)(Mono C#) SSH Tunnel for Database Connection (such as ADO, ODBC, etc.)(PowerShell) SSH Tunnel for Database Connection (such as ADO, ODBC, etc.)
top
BeginAcceptingAsync (.NET Core C#) (C#) (Mono C#) (PowerShell)
public Task BeginAcceptingAsync(int listenPort);

Creates an asynchronous task to call the BeginAccepting method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns null on failure

top
CloseTunnel
public bool CloseTunnel(bool waitForThreads);
Introduced in version 9.5.0.50

Closes the SSH tunnel and disconnects all existing clients. If waitForThreads is true, the method will wait for the tunnel and client threads to exit before returning.

Returns true for success, false for failure.

top
Connect
public bool Connect(string hostname, int port);
Introduced in version 9.5.0.50

Connects to the SSH server to be used for SSH tunneling.

Important: Make sure to call CloseTunnel when finished with the tunnel, such as before exiting your program.

Note: Chilkat automatically sends an "ignore" message every 20 seconds to keep the connection with the SSH server alive. This can be turned off by adding the "NoKeepAliveIgnoreMsg" to the UncommonOptions property.

Returns true for success, false for failure.

More Information and Examples
(.NET Core C#) SSH Tunnel with Dynamic Port Forwarding(C#) SSH Tunnel with Dynamic Port Forwarding(Mono C#) SSH Tunnel with Dynamic Port Forwarding(PowerShell) SSH Tunnel with Dynamic Port Forwarding
top
ConnectAsync (.NET Core C#) (C#) (Mono C#) (PowerShell)
public Task ConnectAsync(string hostname, int port);
Introduced in version 9.5.0.50

Creates an asynchronous task to call the Connect method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns null on failure

top
ConnectThroughSsh
public bool ConnectThroughSsh(Ssh ssh, string hostname, int port);
Introduced in version 9.5.0.55

Connects to an SSH server through an existing SSH connection. The ssh is an existing connected and authenticated SSH object. The connection to hostname:port is made through the existing SSH connection via port-forwarding. If successful, the connection is as follows: application => ServerSSH1 => ServerSSH2. (where ServerSSH1 is the ssh and ServerSSH2 is the SSH server at hostname:port) Once connected in this way, all communications are routed through ServerSSH1 to ServerSSH2. This includes authentication -- which means the application must still call one of the Authenticate* methods to authenticate with ServerSSH2.

Returns true for success, false for failure.

top
ConnectThroughSshAsync (.NET Core C#) (C#) (Mono C#) (PowerShell)
public Task ConnectThroughSshAsync(Ssh ssh, string hostname, int port);
Introduced in version 9.5.0.55

Creates an asynchronous task to call the ConnectThroughSsh method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns null on failure

top
ContinueKeyboardAuth
public string ContinueKeyboardAuth(string response);
Introduced in version 9.5.0.78

Continues keyboard-interactive authentication with the SSH server. The response is typically the password. If multiple responses are required (because there were multiple prompts in the infoRequest XML returned by StartKeyboardAuth), then the response should be formatted as XML (as shown below) otherwise the response simply contains the single response string. 

<response>
    <response1>response to first prompt</response1>
    <response2>response to second prompt</response2>
    ...
    <responseN>response to Nth prompt</responseN>
</response>

If the interactive authentication completed with success or failure, the XML response will be: 

<success>success_message</success>

or

<error>error_message</error>
If additional steps are required to complete the interactive authentication, then an XML string that provides the name, instruction, and prompts is returned. The XML has the following format: 
 	<infoRequest numPrompts="N">
	    <name>name_string</name>
	    <instruction>instruction_string</instruction>
	    <prompt1 echo="1_or_0">prompt_string</prompt1>
	    ...
	    <promptN echo="1_or_0">prompt_string</promptN>
	</infoRequest>

Returns null on failure

top
ContinueKeyboardAuthAsync (.NET Core C#) (C#) (Mono C#) (PowerShell)
public Task ContinueKeyboardAuthAsync(string response);
Introduced in version 9.5.0.78

Creates an asynchronous task to call the ContinueKeyboardAuth method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns null on failure

top
DisconnectAllClients
public bool DisconnectAllClients(bool waitForThreads);
Introduced in version 9.5.0.50

Disconnects all clients, keeping the SSH tunnel open. If waitForThreads is true, the method will wait for the client threads to exit before returning.

Returns true for success, false for failure.

top
GetCurrentState
public string GetCurrentState();
Introduced in version 9.5.0.65

Returns the current state of existing tunnels in an XML string.

Returns null on failure

top
IsSshConnected
public bool IsSshConnected();
Introduced in version 9.5.0.61

Returns true if connected to the SSH server. Returns false if the connection has been lost (or was never established).

top
LoadTaskCaller
public bool LoadTaskCaller(Task task);
Introduced in version 9.5.0.80

Loads the caller of the task's async method.

Returns true for success, false for failure.

top
SetAllowedAlgorithms
public bool SetAllowedAlgorithms(JsonObject json);
Introduced in version 9.5.0.99

Provides a way to specific the exact set of algorithms allowed for the connection.

Returns true for success, false for failure.

More Information and Examples
(.NET Core C#) SSH Tunnel Set Allowed Algorithms(C#) SSH Tunnel Set Allowed Algorithms(Mono C#) SSH Tunnel Set Allowed Algorithms(PowerShell) SSH Tunnel Set Allowed Algorithms
top
StartKeyboardAuth
public string StartKeyboardAuth(string login);
Introduced in version 9.5.0.78

Begins keyboard-interactive authentication with the SSH server. Returns an XML string providing the name, instruction, and prompts. The XML has the following format: 

 	<infoRequest numPrompts="N">
	    <name>name_string</name>
	    <instruction>instruction_string</instruction>
	    <prompt1 echo="1_or_0">prompt_string</prompt1>
	    ...
	    <promptN echo="1_or_0">prompt_string</promptN>
	</infoRequest>

If the authentication immediately succeeds because no password is required, or immediately fails, the XML response can be: 

<success>success_message</success>

or

<error>error_message</error>

Returns null on failure

top
StartKeyboardAuthAsync (.NET Core C#) (C#) (Mono C#) (PowerShell)
public Task StartKeyboardAuthAsync(string login);
Introduced in version 9.5.0.78

Creates an asynchronous task to call the StartKeyboardAuth method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns null on failure

top
StopAccepting
public bool StopAccepting(bool waitForThread);

Stops the listen background thread. It is possible to continue accepting connections by re-calling BeginAccepting. If waitForThread is true, the method will wait for the listen thread to exit before returning.

Returns true for success, false for failure.

top

Events

AbortCheck
public event AbortCheckEventHandler OnAbortCheck;

Provides the opportunity for a method call to be aborted. The AbortCheck event is fired periodically based on the value of the HeartbeatMs property. If HeartbeatMs is 0, then no AbortCheck events will fire. As an example, to fire 5 AbortCheck events per second, set the HeartbeatMs property equal to 200.

Chilkat .NET Event Implementation

Args are passed using Chilkat.AbortCheckEventArgs

Event callback implementation:

private void sshtunnel_OnAbortCheck(object sender, Chilkat.AbortCheckEventArgs args)
	{
	    // application code goes here.
	}

To add an event handler:

Chilkat.SshTunnel sshtunnel = new Chilkat.SshTunnel();
sshtunnel.OnAbortCheck += sshtunnel_OnAbortCheck;

Chilkat Mono/.NET Core Event Implementation

Event callback implementation:

public void handleAbortCheck(out bool abort)
	{
	    // application code goes here.
	}

To add an event handler:

Chilkat.SshTunnel sshtunnel = new Chilkat.SshTunnel();
// ...
Chilkat.SshTunnel.AbortCheck abortCheck = new Chilkat.SshTunnel.AbortCheck(handleAbortCheck);
sshtunnel.setAbortCheckCb(abortCheck);
top
PercentDone
public event PercentDoneEventHandler OnPercentDone;

Provides the percentage completed for any method that involves network communications or time-consuming processing (assuming it is a method where a percentage completion can be measured). This event is only fired when it is possible to know a percentage completion, and when it makes sense to express the operation as a percentage completed. The pctDone argument will have a value from 1 to 100. For operations (Chilkat method calls) that complete very quickly, the number of PercentDone callbacks will vary, but the final callback should have a value of 100. For long running operations, no more than one callback per percentage point will occur (for example: 1, 2, 3, ... 98, 99, 100).

The PercentDone callback counts as an AbortCheck event. For method calls that complete quickly such that PercentDone events fire, it may be that AbortCheck events don't fire because the opportunity to abort is already provided in the PercentDone callback. For time consuming operations, where the amount of time between PercentDone callbacks are long, AbortCheck callbacks may be used to allow for the operation to be aborted in a more responsive manner.

The abort output argument provides a means for aborting the operation. Setting it to true will cause the method to abort and return a failed status (or whatever return value indicates failure).

Chilkat .NET Event Implementation

Args are passed using Chilkat.PercentDoneEventArgs

Event callback implementation:

private void sshtunnel_OnPercentDone(object sender, Chilkat.PercentDoneEventArgs args)
	{
	    // application code goes here.
	}

To add an event handler:

Chilkat.SshTunnel sshtunnel = new Chilkat.SshTunnel();
sshtunnel.OnPercentDone += sshtunnel_OnPercentDone;

Chilkat Mono/.NET Core Event Implementation

Event callback implementation:

public void handlePercentDone(int pctDone, out bool abort)
	{
	    // application code goes here.
	}

To add an event handler:

Chilkat.SshTunnel sshtunnel = new Chilkat.SshTunnel();
// ...
Chilkat.SshTunnel.PercentDone percentDone = new Chilkat.SshTunnel.PercentDone(handlePercentDone);
sshtunnel.setPercentDoneCb(percentDone);
top
ProgressInfo
public event ProgressInfoEventHandler OnProgressInfo;

A general name/value event that provides information about what is happening during a method call. To find out what information is available, write code to handle this event and log the name/value pairs. Most are self-explanatory.

Chilkat .NET Event Implementation

Args are passed using Chilkat.ProgressInfoEventArgs

Event callback implementation:

private void sshtunnel_OnProgressInfo(object sender, Chilkat.ProgressInfoEventArgs args)
	{
	    // application code goes here.
	}

To add an event handler:

Chilkat.SshTunnel sshtunnel = new Chilkat.SshTunnel();
sshtunnel.OnProgressInfo += sshtunnel_OnProgressInfo;

Chilkat Mono/.NET Core Event Implementation

Event callback implementation:

public void handleProgressInfo(string name, string value)
	{
	    // application code goes here.
	}

To add an event handler:

Chilkat.SshTunnel sshtunnel = new Chilkat.SshTunnel();
// ...
Chilkat.SshTunnel.ProgressInfo progressInfo = new Chilkat.SshTunnel.ProgressInfo(handleProgressInfo);
sshtunnel.setProgressInfoCb(progressInfo);
top
TaskCompleted
public event TaskCompletedEventHandler OnTaskCompleted;

Called in the background thread when an asynchronous task completes.

More Information and Examples
C# .NET Framework TaskCompleted Event Callback ExampleC# .NET Core TaskCompleted Event Callback Example

Chilkat .NET Event Implementation

Args are passed using Chilkat.TaskCompletedEventArgs

Event callback implementation:

private void sshtunnel_OnTaskCompleted(object sender, Chilkat.TaskCompletedEventArgs args)
	{
	    // application code goes here.
	}

To add an event handler:

Chilkat.SshTunnel sshtunnel = new Chilkat.SshTunnel();
sshtunnel.OnTaskCompleted += sshtunnel_OnTaskCompleted;

Chilkat Mono/.NET Core Event Implementation

Event callback implementation:

public void handleTaskIdCompleted(int taskId)
	{
	    // application code goes here.
	}

To add an event handler:

Chilkat.SshTunnel sshtunnel = new Chilkat.SshTunnel();
// ...
Chilkat.SshTunnel.TaskIdCompleted taskIdCompleted = new Chilkat.SshTunnel.TaskIdCompleted(handleTaskIdCompleted);
sshtunnel.setTaskIdCompletedCb(taskIdCompleted);
top