CkSshTunnel Perl Reference Documentation

CkSshTunnel

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

$obj = chilkat::CkSshTunnel->new();

Properties

AbortCurrent

# $boolVal is a boolean
$boolVal = $sshTunnel->get_AbortCurrent();
$sshTunnel->put_AbortCurrent($boolVal);

Introduced in version 9.5.0.58

When set to 1, 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 0 when the next method is called. When the abort occurs, this property is reset to 0. Both synchronous and asynchronous method calls can be aborted. (A synchronous method call could be aborted by setting this property from a separate thread.)

AcceptLog

# $strVal is a string
# $ckStr is a CkString
$sshTunnel->get_AcceptLog($ckStr);
$strVal = $sshTunnel->acceptLog();
$sshTunnel->put_AcceptLog($strVal);

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

AcceptLogPath

# $strVal is a string
# $ckStr is a CkString
$sshTunnel->get_AcceptLogPath($ckStr);
$strVal = $sshTunnel->acceptLogPath();
$sshTunnel->put_AcceptLogPath($strVal);

Introduced in version 9.5.0.50

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

ClientIdentifier

# $strVal is a string
# $ckStr is a CkString
$sshTunnel->get_ClientIdentifier($ckStr);
$strVal = $sshTunnel->clientIdentifier();
$sshTunnel->put_ClientIdentifier($strVal);

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.

ConnectTimeoutMs

# $intVal is an integer
$intVal = $sshTunnel->get_ConnectTimeoutMs();
$sshTunnel->put_ConnectTimeoutMs($intVal);

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).

DebugLogFilePath

# $strVal is a string
# $ckStr is a CkString
$sshTunnel->get_DebugLogFilePath($ckStr);
$strVal = $sshTunnel->debugLogFilePath();
$sshTunnel->put_DebugLogFilePath($strVal);

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:

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

More Information and Examples

Example showing how to use DebugLogFilePath.

DestHostname

# $strVal is a string
# $ckStr is a CkString
$sshTunnel->get_DestHostname($ckStr);
$strVal = $sshTunnel->destHostname();
$sshTunnel->put_DestHostname($strVal);

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.

DestPort

# $intVal is an integer
$intVal = $sshTunnel->get_DestPort();
$sshTunnel->put_DestPort($intVal);

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

DynamicPortForwarding

# $boolVal is a boolean
$boolVal = $sshTunnel->get_DynamicPortForwarding();
$sshTunnel->put_DynamicPortForwarding($boolVal);

Introduced in version 9.5.0.50

If 1, then this behaves as a SOCKS proxy server for inbound connections. When this property is 1, 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 0.

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

SSH Tunnel with Dynamic Port Forwarding

HostKeyFingerprint

# $strVal is a string
# $ckStr is a CkString
$sshTunnel->get_HostKeyFingerprint($ckStr);
$strVal = $sshTunnel->hostKeyFingerprint();

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"

HttpProxyAuthMethod

# $strVal is a string
# $ckStr is a CkString
$sshTunnel->get_HttpProxyAuthMethod($ckStr);
$strVal = $sshTunnel->httpProxyAuthMethod();
$sshTunnel->put_HttpProxyAuthMethod($strVal);

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.

HttpProxyDomain

# $strVal is a string
# $ckStr is a CkString
$sshTunnel->get_HttpProxyDomain($ckStr);
$strVal = $sshTunnel->httpProxyDomain();
$sshTunnel->put_HttpProxyDomain($strVal);

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.

HttpProxyHostname

# $strVal is a string
# $ckStr is a CkString
$sshTunnel->get_HttpProxyHostname($ckStr);
$strVal = $sshTunnel->httpProxyHostname();
$sshTunnel->put_HttpProxyHostname($strVal);

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.

HttpProxyPassword

# $strVal is a string
# $ckStr is a CkString
$sshTunnel->get_HttpProxyPassword($ckStr);
$strVal = $sshTunnel->httpProxyPassword();
$sshTunnel->put_HttpProxyPassword($strVal);

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.

HttpProxyPort

# $intVal is an integer
$intVal = $sshTunnel->get_HttpProxyPort();
$sshTunnel->put_HttpProxyPort($intVal);

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.

HttpProxyUsername

# $strVal is a string
# $ckStr is a CkString
$sshTunnel->get_HttpProxyUsername($ckStr);
$strVal = $sshTunnel->httpProxyUsername();
$sshTunnel->put_HttpProxyUsername($strVal);

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.

IdleTimeoutMs

# $intVal is an integer
$intVal = $sshTunnel->get_IdleTimeoutMs();
$sshTunnel->put_IdleTimeoutMs($intVal);

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).

InboundSocksPassword

# $strVal is a string
# $ckStr is a CkString
$sshTunnel->get_InboundSocksPassword($ckStr);
$strVal = $sshTunnel->inboundSocksPassword();
$sshTunnel->put_InboundSocksPassword($strVal);

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.

InboundSocksUsername

# $strVal is a string
# $ckStr is a CkString
$sshTunnel->get_InboundSocksUsername($ckStr);
$strVal = $sshTunnel->inboundSocksUsername();
$sshTunnel->put_InboundSocksUsername($strVal);

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.

IsAccepting

# $boolVal is a boolean
$boolVal = $sshTunnel->get_IsAccepting();

1 if a background thread is running and accepting connections.

KeepAcceptLog

# $boolVal is a boolean
$boolVal = $sshTunnel->get_KeepAcceptLog();
$sshTunnel->put_KeepAcceptLog($boolVal);

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

KeepTunnelLog

# $boolVal is a boolean
$boolVal = $sshTunnel->get_KeepTunnelLog();
$sshTunnel->put_KeepTunnelLog($boolVal);

Introduced in version 9.5.0.50

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

LastErrorHtml

# $strVal is a string
# $ckStr is a CkString
$sshTunnel->get_LastErrorHtml($ckStr);
$strVal = $sshTunnel->lastErrorHtml();

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.

LastErrorText

# $strVal is a string
# $ckStr is a CkString
$sshTunnel->get_LastErrorText($ckStr);
$strVal = $sshTunnel->lastErrorText();

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 LastErrorText LastErrorText Standard Information

LastErrorXml

# $strVal is a string
# $ckStr is a CkString
$sshTunnel->get_LastErrorXml($ckStr);
$strVal = $sshTunnel->lastErrorXml();

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.

LastMethodSuccess

# $boolVal is a boolean
$boolVal = $sshTunnel->get_LastMethodSuccess();
$sshTunnel->put_LastMethodSuccess($boolVal);

Indicate whether the last method call succeeded or failed. A value of 1 indicates success, a value of 0 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 = 1 and failure = 0.
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 1. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

ListenBindIpAddress

# $strVal is a string
# $ckStr is a CkString
$sshTunnel->get_ListenBindIpAddress($ckStr);
$strVal = $sshTunnel->listenBindIpAddress();
$sshTunnel->put_ListenBindIpAddress($strVal);

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.

ListenPort

# $intVal is an integer
$intVal = $sshTunnel->get_ListenPort();

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.

OutboundBindIpAddress

# $strVal is a string
# $ckStr is a CkString
$sshTunnel->get_OutboundBindIpAddress($ckStr);
$strVal = $sshTunnel->outboundBindIpAddress();
$sshTunnel->put_OutboundBindIpAddress($strVal);

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.

OutboundBindPort

# $intVal is an integer
$intVal = $sshTunnel->get_OutboundBindPort();
$sshTunnel->put_OutboundBindPort($intVal);

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.)

PreferIpv6

# $boolVal is a boolean
$boolVal = $sshTunnel->get_PreferIpv6();
$sshTunnel->put_PreferIpv6($boolVal);

Introduced in version 9.5.0.70

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

SocksHostname

# $strVal is a string
# $ckStr is a CkString
$sshTunnel->get_SocksHostname($ckStr);
$strVal = $sshTunnel->socksHostname();
$sshTunnel->put_SocksHostname($strVal);

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.

SocksPassword

# $strVal is a string
# $ckStr is a CkString
$sshTunnel->get_SocksPassword($ckStr);
$strVal = $sshTunnel->socksPassword();
$sshTunnel->put_SocksPassword($strVal);

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.

SocksPort

# $intVal is an integer
$intVal = $sshTunnel->get_SocksPort();
$sshTunnel->put_SocksPort($intVal);

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.

SocksUsername

# $strVal is a string
# $ckStr is a CkString
$sshTunnel->get_SocksUsername($ckStr);
$strVal = $sshTunnel->socksUsername();
$sshTunnel->put_SocksUsername($strVal);

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.

SocksVersion

# $intVal is an integer
$intVal = $sshTunnel->get_SocksVersion();
$sshTunnel->put_SocksVersion($intVal);

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.

SoRcvBuf

# $intVal is an integer
$intVal = $sshTunnel->get_SoRcvBuf();
$sshTunnel->put_SoRcvBuf($intVal);

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

SoSndBuf

# $intVal is an integer
$intVal = $sshTunnel->get_SoSndBuf();
$sshTunnel->put_SoSndBuf($intVal);

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

TcpNoDelay

# $boolVal is a boolean
$boolVal = $sshTunnel->get_TcpNoDelay();
$sshTunnel->put_TcpNoDelay($boolVal);

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

TunnelLog

# $strVal is a string
# $ckStr is a CkString
$sshTunnel->get_TunnelLog($ckStr);
$strVal = $sshTunnel->tunnelLog();
$sshTunnel->put_TunnelLog($strVal);

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 1.

TunnelLogPath

# $strVal is a string
# $ckStr is a CkString
$sshTunnel->get_TunnelLogPath($ckStr);
$strVal = $sshTunnel->tunnelLogPath();
$sshTunnel->put_TunnelLogPath($strVal);

Introduced in version 9.5.0.50

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

UncommonOptions

# $strVal is a string
# $ckStr is a CkString
$sshTunnel->get_UncommonOptions($ckStr);
$strVal = $sshTunnel->uncommonOptions();
$sshTunnel->put_UncommonOptions($strVal);

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.
+chacha20-poly1305@openssh.com - Introduced in v9.5.0.97. To mitigate the Terrapin attack, chacha20-poly1305@openssh.com is no longer included by default. It can be re-added by adding this keyword.

Utf8

# $boolVal is a boolean
$boolVal = $sshTunnel->get_Utf8();
$sshTunnel->put_Utf8($boolVal);

When set to 1, all "const char *" arguments are interpreted as utf-8 strings. If set to 0 (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to 1, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to 0, all "const char *" return values are ANSI strings.

VerboseLogging

# $boolVal is a boolean
$boolVal = $sshTunnel->get_VerboseLogging();
$sshTunnel->put_VerboseLogging($boolVal);

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

Version

# $strVal is a string
# $ckStr is a CkString
$sshTunnel->get_Version($ckStr);
$strVal = $sshTunnel->version();

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

More Information and Examples

How to get the Chilkat version at runtime.

Methods

AuthenticatePk

# $username is a string
# $privateKey is a CkSshKey
$status = $sshTunnel->AuthenticatePk($username, $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 support@chilkatsoft.com.

Returns 1 for success, 0 for failure.

More Information and Examples

Beware of too much time between connect and authentication.Use PuTTY Key for SSH Tunnel (PPK Private Key)

AuthenticatePkAsync ⁽¹⁾

# returns a CkTask
# $username is a string
# $privateKey is a CkSshKey
$ret_task = $sshTunnel->AuthenticatePkAsync($username, $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.)

Returns null on failure

AuthenticatePw

# $login is a string
# $password is a string
$status = $sshTunnel->AuthenticatePw($login, $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 support@chilkatsoft.com.
Note: To learn about how to handle password change requests, see the PasswordChangeRequested property (above).

Returns 1 for success, 0 for failure.

More Information and Examples

Beware of too much time between connect and authentication.

AuthenticatePwAsync ⁽¹⁾

# returns a CkTask
# $login is a string
# $password is a string
$ret_task = $sshTunnel->AuthenticatePwAsync($login, $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.)

Returns null on failure

AuthenticatePwPk

# $username is a string
# $password is a string
# $privateKey is a CkSshKey
$status = $sshTunnel->AuthenticatePwPk($username, $password, $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 support@chilkatsoft.com.

Returns 1 for success, 0 for failure.

AuthenticatePwPkAsync ⁽¹⁾

# returns a CkTask
# $username is a string
# $password is a string
# $privateKey is a CkSshKey
$ret_task = $sshTunnel->AuthenticatePwPkAsync($username, $password, $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.)

Returns null on failure

AuthenticateSecPw

# $login is a CkSecureString
# $password is a CkSecureString
$status = $sshTunnel->AuthenticateSecPw($login, $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 1 for success, 0 for failure.

More Information and Examples

SSH Tunnel Authenticate Secure

AuthenticateSecPwAsync ⁽¹⁾

# returns a CkTask
# $login is a CkSecureString
# $password is a CkSecureString
$ret_task = $sshTunnel->AuthenticateSecPwAsync($login, $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.)

Returns null on failure

AuthenticateSecPwPk

# $username is a CkSecureString
# $password is a CkSecureString
# $privateKey is a CkSshKey
$status = $sshTunnel->AuthenticateSecPwPk($username, $password, $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 1 for success, 0 for failure.

AuthenticateSecPwPkAsync ⁽¹⁾

# returns a CkTask
# $username is a CkSecureString
# $password is a CkSecureString
# $privateKey is a CkSshKey
$ret_task = $sshTunnel->AuthenticateSecPwPkAsync($username, $password, $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.)

Returns null on failure

BeginAccepting

# $listenPort is an integer
$status = $sshTunnel->BeginAccepting($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 0, then BeginAccepting failed.

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

Returns 1 for success, 0 for failure.

More Information and Examples

SSH Tunnel for Database Connection (such as ADO, ODBC, etc.)

BeginAcceptingAsync ⁽¹⁾

# returns a CkTask
# $listenPort is an integer
$ret_task = $sshTunnel->BeginAcceptingAsync($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.)

Returns null on failure

CloseTunnel

# $waitForThreads is a boolean
$status = $sshTunnel->CloseTunnel($waitForThreads);

Introduced in version 9.5.0.50

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

Returns 1 for success, 0 for failure.

Connect

# $hostname is a string
# $port is an integer
$status = $sshTunnel->Connect($hostname, $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 1 for success, 0 for failure.

More Information and Examples

SSH Tunnel with Dynamic Port Forwarding

ConnectAsync ⁽¹⁾

# returns a CkTask
# $hostname is a string
# $port is an integer
$ret_task = $sshTunnel->ConnectAsync($hostname, $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.)

Returns null on failure

ConnectThroughSsh

# $ssh is a CkSsh
# $hostname is a string
# $port is an integer
$status = $sshTunnel->ConnectThroughSsh($ssh, $hostname, $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 1 for success, 0 for failure.

ConnectThroughSshAsync ⁽¹⁾

# returns a CkTask
# $ssh is a CkSsh
# $hostname is a string
# $port is an integer
$ret_task = $sshTunnel->ConnectThroughSshAsync($ssh, $hostname, $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.)

Returns null on failure

ContinueKeyboardAuth

# $response is a string
# $outStr is a CkString (output)
$status = $sshTunnel->ContinueKeyboardAuth($response, $outStr);
$retStr = $sshTunnel->continueKeyboardAuth($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 1 for success, 0 for failure.

ContinueKeyboardAuthAsync ⁽¹⁾

# returns a CkTask
# $response is a string
$ret_task = $sshTunnel->ContinueKeyboardAuthAsync($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.)

Returns null on failure

DisconnectAllClients

# $waitForThreads is a boolean
$status = $sshTunnel->DisconnectAllClients($waitForThreads);

Introduced in version 9.5.0.50

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

Returns 1 for success, 0 for failure.

GetCurrentState

# $outStr is a CkString (output)
$status = $sshTunnel->GetCurrentState($outStr);
$retStr = $sshTunnel->getCurrentState();

Introduced in version 9.5.0.65

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

Returns 1 for success, 0 for failure.

IsSshConnected

$retBool = $sshTunnel->IsSshConnected();

Introduced in version 9.5.0.61

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

LoadTaskCaller

# $task is a CkTask
$status = $sshTunnel->LoadTaskCaller($task);

Introduced in version 9.5.0.80

Loads the caller of the task's async method.

Returns 1 for success, 0 for failure.

SetAllowedAlgorithms

# $json is a CkJsonObject
$status = $sshTunnel->SetAllowedAlgorithms($json);

Introduced in version 9.5.0.99

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

Returns 1 for success, 0 for failure.

More Information and Examples

SSH Tunnel Set Allowed Algorithms

StartKeyboardAuth

# $login is a string
# $outStr is a CkString (output)
$status = $sshTunnel->StartKeyboardAuth($login, $outStr);
$retStr = $sshTunnel->startKeyboardAuth($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 1 for success, 0 for failure.

StartKeyboardAuthAsync ⁽¹⁾

# returns a CkTask
# $login is a string
$ret_task = $sshTunnel->StartKeyboardAuthAsync($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.)

Returns null on failure

StopAccepting

# $waitForThread is a boolean
$status = $sshTunnel->StopAccepting($waitForThread);

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

Returns 1 for success, 0 for failure.