SSHReverseTunnel Class

Properties   Methods   Events   Config Settings   Errors  

The SSHReverseTunnel class provides a simple way to establish a reverse tunnel with an SSH host.

Syntax

SSHReverseTunnel

Remarks

The SSHReverseTunnel class may be used to establish a reverse tunnel with an SSH host. The SSH host will listen for incoming connections on the specified port and forward traffic to the class through the SSH tunnel.

The SSHHost and SSHPort properties specify the SSH server to use. The SSHUser and SSHPassword properties allow the client to authenticate itself with the server. The SSHServerAuthentication event and/or SSHAcceptServerHostKey property allow you to check the server identity. Finally, the SSHStatus event provides information about the SSH handshake.

To begin, call SSHLogon to connect to the SSH host. After this method returns, the connection to the SSH server is successfully established. Call RequestForwarding to establish a reverse tunnel. This method takes parameters to tell the SSH host on which port to listen.

The class has two modes that allow data to be dealt with directly from the events, or automatically forwarded on to a different endpoint.

Event Based Operation

In this mode, any data received by the class over the tunnel causes the events of the class to fire. For instance:

 
 Copy
SSHReverseTunnel.RequestForwarding("0.0.0.0", 777, "", 0);

In the above code, forwarding is requested from port 777 on the SSHHost. Any data received on port 777 by the SSHHost will be sent to the class. In the above code, the last two parameters are empty and 0, indicating to the class that no local forwarding is requested.

Once RequestForwarding returns, the SSH reverse tunnel is established. Any connection made to the SSH host on the specified port will then trigger the class's events to fire, allowing you to handle the connection request and data.

When a client connects to the SSH host on the specified port, the SSHChannelOpenRequest event will fire. Within this event, choose to accept or reject the connection by setting the Accept parameter. This event contains details about the connection that may be used when determining whether to accept the connection.

After the channel is established, data is received through the SSHChannelData event. Call the SendChannelData method to send data over the channel, and call the CloseChannel method to close the channel.

Local Forwarding

In this mode, any data received by the class is automatically forwarded to a separate endpoint. This allows the class to act as a sort of proxy. There is no need to handle data directly in this case. For instance:

 
 Copy
SSHReverseTunnel.RequestForwarding("0.0.0.0", 777, "nsoftware.com", 80);

In the above code, forwarding is requested from port 777 on SSHHost. The class is instructed to establish a connection to "nsoftware.com" on port 80 when a client connects to SSHHost on port 777. Any data received from the client connected to SSHHost on port 777 will automatically be forwarded to "nsoftware.com" on port 80. Any data received back from "nsoftware.com" on port 80 will be sent back to the connected client.

In this mode, data may flow freely from the client connected to the SSHHost to the endpoint specified in the RequestForwarding method without any additional code required.

Additional Notes

The following events are applicable when a connection is made to the SSH host:

• SSHChannelClosed
• SSHChannelData
• SSHChannelEOF
• SSHChannelOpened
• SSHChannelOpenRequest
• SSHChannelReadyToSend
• SSHChannelRequested

To stop a previously established reverse tunnel, call the CancelForwarding method.

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

SSHChannelCount Property (SSHReverseTunnel Class)

The number of records in the arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSHChannelCount();

Unicode (Windows)
INT GetSSHChannelCount();

int ipworksssh_sshreversetunnel_getsshchannelcount(void* lpObj);

int GetSSHChannelCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• BytesSent
• ChannelId
• ConnectedAddress
• ConnectedPort
• DataToSend
• FirewallAutoDetect
• FirewallHost
• FirewallPassword
• FirewallPort
• FirewallType
• FirewallUser
• ForwardingHost
• ForwardingPort
• OriginAddress
• OriginPort
• Service
• SSHAcceptServerHostKeyEncoded
• SSHCertEncoded
• SSHCertStore
• SSHCertStorePassword
• SSHCertStoreType
• SSHCertSubject

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

This property is read-only and not available at design time.

Data Type

Integer

BytesSent Property (SSHReverseTunnel Class)

The number of bytes actually sent after a sending channel data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetBytesSent(int iSSHChannelId);

Unicode (Windows)
INT GetBytesSent(INT iSSHChannelId);

int ipworksssh_sshreversetunnel_getbytessent(void* lpObj, int sshchannelid);

int GetBytesSent(int iSSHChannelId);

Default Value

0

Remarks

The number of bytes actually sent after a sending channel data.

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

This property is read-only and not available at design time.

Data Type

Integer

ChannelId Property (SSHReverseTunnel Class)

An id generated by the class to identify the current SSH channel.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetChannelId(int iSSHChannelId);

Unicode (Windows)
LPWSTR GetChannelId(INT iSSHChannelId);

char* ipworksssh_sshreversetunnel_getchannelid(void* lpObj, int sshchannelid);

QString GetChannelId(int iSSHChannelId);

Default Value

""

Remarks

An id generated by the class to identify the current SSH channel. This id is unique to this channel.

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

This property is read-only and not available at design time.

Data Type

String

ConnectedAddress Property (SSHReverseTunnel Class)

This property holds the remote address to which the connection was established.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetConnectedAddress(int iSSHChannelId);

Unicode (Windows)
LPWSTR GetConnectedAddress(INT iSSHChannelId);

char* ipworksssh_sshreversetunnel_getconnectedaddress(void* lpObj, int sshchannelid);

QString GetConnectedAddress(int iSSHChannelId);

Default Value

""

Remarks

This property holds the remote address to which the connection was established. This should match the Address parameter passed to the RequestForwarding method.

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

This property is read-only and not available at design time.

Data Type

String

ConnectedPort Property (SSHReverseTunnel Class)

This property holds the remote port to which the connection was established.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnectedPort(int iSSHChannelId);

Unicode (Windows)
INT GetConnectedPort(INT iSSHChannelId);

int ipworksssh_sshreversetunnel_getconnectedport(void* lpObj, int sshchannelid);

int GetConnectedPort(int iSSHChannelId);

Default Value

0

Remarks

This property holds the remote port to which the connection was established. This should match the Port parameter passed to the RequestForwarding method.

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

This property is read-only and not available at design time.

Data Type

Integer

DataToSend Property (SSHReverseTunnel Class)

A string of data to be sent to the remote host.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetDataToSend(int iSSHChannelId, const char* lpDataToSend, int lenDataToSend);

Unicode (Windows)
INT SetDataToSend(INT iSSHChannelId, LPCSTR lpDataToSend, INT lenDataToSend);

int ipworksssh_sshreversetunnel_setdatatosend(void* lpObj, int sshchannelid, const char* lpDataToSend, int lenDataToSend);

int SetDataToSend(int iSSHChannelId, QByteArray qbaDataToSend);

Default Value

""

Remarks

A string of data to be sent to the remote host. Write-only property.

Assigning a string to the DataToSend makes the class send the string to the remote host.

Note:It is recommended to use the SendText or SendBytes method instead of setting this property.

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

This property is write-only and not available at design time.

Data Type

Binary String

ForwardingHost Property (SSHReverseTunnel Class)

Holds the host to which incoming traffic is forwarded.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetForwardingHost(int iSSHChannelId);

Unicode (Windows)
LPWSTR GetForwardingHost(INT iSSHChannelId);

char* ipworksssh_sshreversetunnel_getforwardinghost(void* lpObj, int sshchannelid);

QString GetForwardingHost(int iSSHChannelId);

Default Value

""

Remarks

Holds the host to which incoming traffic is forwarded. This is only applicable if local forwarding was requested when calling RequestForwarding.

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

This property is read-only and not available at design time.

Data Type

String

ForwardingPort Property (SSHReverseTunnel Class)

Holds the port to which incoming traffic is forwarded.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetForwardingPort(int iSSHChannelId);

Unicode (Windows)
INT GetForwardingPort(INT iSSHChannelId);

int ipworksssh_sshreversetunnel_getforwardingport(void* lpObj, int sshchannelid);

int GetForwardingPort(int iSSHChannelId);

Default Value

0

Remarks

Holds the port to which incoming traffic is forwarded. This is only applicable if local forwarding was requested when calling RequestForwarding.

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

This property is read-only and not available at design time.

Data Type

Integer

OriginAddress Property (SSHReverseTunnel Class)

This property holds the address of the client which originated the connection to the reverse tunnel on SSHHost .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOriginAddress(int iSSHChannelId);

Unicode (Windows)
LPWSTR GetOriginAddress(INT iSSHChannelId);

char* ipworksssh_sshreversetunnel_getoriginaddress(void* lpObj, int sshchannelid);

QString GetOriginAddress(int iSSHChannelId);

Default Value

""

Remarks

This property holds the address of the client which originated the connection to the reverse tunnel on SSHHost.

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

This property is read-only and not available at design time.

Data Type

String

OriginPort Property (SSHReverseTunnel Class)

This property holds the port used by the client which originated the connection to the reverse tunnel on SSHHost .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOriginPort(int iSSHChannelId);

Unicode (Windows)
INT GetOriginPort(INT iSSHChannelId);

int ipworksssh_sshreversetunnel_getoriginport(void* lpObj, int sshchannelid);

int GetOriginPort(int iSSHChannelId);

Default Value

0

Remarks

This property holds the port used by the client which originated the connection to the reverse tunnel on SSHHost.

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

This property is read-only and not available at design time.

Data Type

Integer

Service Property (SSHReverseTunnel Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetService(int iSSHChannelId);

Unicode (Windows)
LPWSTR GetService(INT iSSHChannelId);

char* ipworksssh_sshreversetunnel_getservice(void* lpObj, int sshchannelid);

QString GetService(int iSSHChannelId);

Default Value

""

Remarks

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

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

This property is read-only and not available at design time.

Data Type

String

Connected Property (SSHReverseTunnel Class)

This shows whether the class is connected.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnected();
int SetConnected(int bConnected);

Unicode (Windows)
BOOL GetConnected();
INT SetConnected(BOOL bConnected);

int ipworksssh_sshreversetunnel_getconnected(void* lpObj);
int ipworksssh_sshreversetunnel_setconnected(void* lpObj, int bConnected);

bool GetConnected();
int SetConnected(bool bConnected);

Default Value

FALSE

Remarks

This property is used to determine whether or not the class is connected to the remote host.

Note: It is recommended to use the Connect or Disconnect method instead of setting this property.

This property is not available at design time.

Data Type

Boolean

FirewallAutoDetect Property (SSHReverseTunnel Class)

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallAutoDetect();
int SetFirewallAutoDetect(int bFirewallAutoDetect);

Unicode (Windows)
BOOL GetFirewallAutoDetect();
INT SetFirewallAutoDetect(BOOL bFirewallAutoDetect);

int ipworksssh_sshreversetunnel_getfirewallautodetect(void* lpObj);
int ipworksssh_sshreversetunnel_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);

bool GetFirewallAutoDetect();
int SetFirewallAutoDetect(bool bFirewallAutoDetect);

Default Value

FALSE

Remarks

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (SSHReverseTunnel Class)

This property determines the type of firewall to connect through.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallType();
int SetFirewallType(int iFirewallType);

Unicode (Windows)
INT GetFirewallType();
INT SetFirewallType(INT iFirewallType);

FW_NONE(0), 
FW_TUNNEL(1), 
FW_SOCKS4(2), 
FW_SOCKS5(3), 
FW_SOCKS4A(10)

int ipworksssh_sshreversetunnel_getfirewalltype(void* lpObj);
int ipworksssh_sshreversetunnel_setfirewalltype(void* lpObj, int iFirewallType);

int GetFirewallType();
int SetFirewallType(int iFirewallType);

Default Value

0

Remarks

This property determines the type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (SSHReverseTunnel Class)

This property contains the name or IP address of firewall (optional).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallHost();
int SetFirewallHost(const char* lpszFirewallHost);

Unicode (Windows)
LPWSTR GetFirewallHost();
INT SetFirewallHost(LPCWSTR lpszFirewallHost);

char* ipworksssh_sshreversetunnel_getfirewallhost(void* lpObj);
int ipworksssh_sshreversetunnel_setfirewallhost(void* lpObj, const char* lpszFirewallHost);

QString GetFirewallHost();
int SetFirewallHost(QString qsFirewallHost);

Default Value

""

Remarks

This property contains the name or IP address of firewall (optional). If a FirewallHost 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 class fails with an error.

Data Type

String

FirewallPassword Property (SSHReverseTunnel Class)

This property contains a password if authentication is to be used when connecting through the firewall.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallPassword();
int SetFirewallPassword(const char* lpszFirewallPassword);

Unicode (Windows)
LPWSTR GetFirewallPassword();
INT SetFirewallPassword(LPCWSTR lpszFirewallPassword);

char* ipworksssh_sshreversetunnel_getfirewallpassword(void* lpObj);
int ipworksssh_sshreversetunnel_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);

QString GetFirewallPassword();
int SetFirewallPassword(QString qsFirewallPassword);

Default Value

""

Remarks

This property contains a password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

Data Type

String

FirewallPort Property (SSHReverseTunnel Class)

This property contains the transmission control protocol (TCP) port for the firewall Host .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);

Unicode (Windows)
INT GetFirewallPort();
INT SetFirewallPort(INT iFirewallPort);

int ipworksssh_sshreversetunnel_getfirewallport(void* lpObj);
int ipworksssh_sshreversetunnel_setfirewallport(void* lpObj, int iFirewallPort);

int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);

Default Value

0

Remarks

This property contains the transmission control protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.

Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

Data Type

Integer

FirewallUser Property (SSHReverseTunnel Class)

This property contains a user name if authentication is to be used connecting through a firewall.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallUser();
int SetFirewallUser(const char* lpszFirewallUser);

Unicode (Windows)
LPWSTR GetFirewallUser();
INT SetFirewallUser(LPCWSTR lpszFirewallUser);

char* ipworksssh_sshreversetunnel_getfirewalluser(void* lpObj);
int ipworksssh_sshreversetunnel_setfirewalluser(void* lpObj, const char* lpszFirewallUser);

QString GetFirewallUser();
int SetFirewallUser(QString qsFirewallUser);

Default Value

""

Remarks

This property contains a user name if authentication is to be used connecting through a firewall. If the FirewallHost is specified, this property and FirewallPassword properties are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.

Data Type

String

LocalHost Property (SSHReverseTunnel Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocalHost();
int SetLocalHost(const char* lpszLocalHost);

Unicode (Windows)
LPWSTR GetLocalHost();
INT SetLocalHost(LPCWSTR lpszLocalHost);

char* ipworksssh_sshreversetunnel_getlocalhost(void* lpObj);
int ipworksssh_sshreversetunnel_setlocalhost(void* lpObj, const char* lpszLocalHost);

QString GetLocalHost();
int SetLocalHost(QString qsLocalHost);

Default Value

""

Remarks

The LocalHost 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 multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

If the class is connected, the LocalHost 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 multi-homed hosts (machines with more than one IP interface).

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

Data Type

String

LocalPort Property (SSHReverseTunnel Class)

The TCP port in the local host where the class binds.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetLocalPort();
int SetLocalPort(int iLocalPort);

Unicode (Windows)
INT GetLocalPort();
INT SetLocalPort(INT iLocalPort);

int ipworksssh_sshreversetunnel_getlocalport(void* lpObj);
int ipworksssh_sshreversetunnel_setlocalport(void* lpObj, int iLocalPort);

int GetLocalPort();
int SetLocalPort(int iLocalPort);

Default Value

0

Remarks

This property must be set before a connection is attempted. It instructs the class 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 LocalPort property after the connection is established.

LocalPort 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 in the client side.

Data Type

Integer

SSHAcceptServerHostKeyEncoded Property (SSHReverseTunnel Class)

This is the certificate (PEM/Base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSHAcceptServerHostKeyEncoded(char* &lpSSHAcceptServerHostKeyEncoded, int &lenSSHAcceptServerHostKeyEncoded);
int SetSSHAcceptServerHostKeyEncoded(const char* lpSSHAcceptServerHostKeyEncoded, int lenSSHAcceptServerHostKeyEncoded);

Unicode (Windows)
INT GetSSHAcceptServerHostKeyEncoded(LPSTR &lpSSHAcceptServerHostKeyEncoded, INT &lenSSHAcceptServerHostKeyEncoded);
INT SetSSHAcceptServerHostKeyEncoded(LPCSTR lpSSHAcceptServerHostKeyEncoded, INT lenSSHAcceptServerHostKeyEncoded);

int ipworksssh_sshreversetunnel_getsshacceptserverhostkeyencoded(void* lpObj, char** lpSSHAcceptServerHostKeyEncoded, int* lenSSHAcceptServerHostKeyEncoded);
int ipworksssh_sshreversetunnel_setsshacceptserverhostkeyencoded(void* lpObj, const char* lpSSHAcceptServerHostKeyEncoded, int lenSSHAcceptServerHostKeyEncoded);

QByteArray GetSSHAcceptServerHostKeyEncoded();
int SetSSHAcceptServerHostKeyEncoded(QByteArray qbaSSHAcceptServerHostKeyEncoded);

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSHAuthMode Property (SSHReverseTunnel Class)

The authentication method to be used the class when calling SSHLogon .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSHAuthMode();
int SetSSHAuthMode(int iSSHAuthMode);

Unicode (Windows)
INT GetSSHAuthMode();
INT SetSSHAuthMode(INT iSSHAuthMode);

AM_NONE(0), 
AM_MULTI_FACTOR(1), 
AM_PASSWORD(2), 
AM_PUBLIC_KEY(3), 
AM_KEYBOARD_INTERACTIVE(4), 
AM_GSSAPIWITH_MIC(5), 
AM_CUSTOM(6), 
AM_GSSAPIKEYEX(7)

int ipworksssh_sshreversetunnel_getsshauthmode(void* lpObj);
int ipworksssh_sshreversetunnel_setsshauthmode(void* lpObj, int iSSHAuthMode);

int GetSSHAuthMode();
int SetSSHAuthMode(int iSSHAuthMode);

Default Value

2

Remarks

The 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 SSHLogon, the class 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 SSHHost containing the SSHUser. The server will respond containing a list of methods by which that user may be authenticated.

The class will attempt to authenticate the user by one of those methods based on the value of SSHAuthMode and other property values supplied by the user. Currently, the class supports the following authentication methods:

Example (User/Password Auth):

 
 Copy
Control.SSHAuthMode = SftpSSHAuthModes.amPassword
Control.SSHUser = "username"
Control.SSHPassword = "password"
Control.SSHLogon("server", 22)

 
 Copy
Control.SSHAuthMode = SftpSSHAuthModes.amPublicKey
Control.SSHUser = "username"
Control.SSHCertStoreType = SSHCertStoreTypes.cstPFXFile;
Control.SSHCertStore = "cert.pfx";
Control.SSHCertStorePassword = "certpassword";
Control.SSHCertSubject = "*";  
Control.SSHLogon("server", 22)

Data Type

Integer

SSHCertEncoded Property (SSHReverseTunnel Class)

This is the certificate (PEM/Base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSHCertEncoded(char* &lpSSHCertEncoded, int &lenSSHCertEncoded);
int SetSSHCertEncoded(const char* lpSSHCertEncoded, int lenSSHCertEncoded);

Unicode (Windows)
INT GetSSHCertEncoded(LPSTR &lpSSHCertEncoded, INT &lenSSHCertEncoded);
INT SetSSHCertEncoded(LPCSTR lpSSHCertEncoded, INT lenSSHCertEncoded);

int ipworksssh_sshreversetunnel_getsshcertencoded(void* lpObj, char** lpSSHCertEncoded, int* lenSSHCertEncoded);
int ipworksssh_sshreversetunnel_setsshcertencoded(void* lpObj, const char* lpSSHCertEncoded, int lenSSHCertEncoded);

QByteArray GetSSHCertEncoded();
int SetSSHCertEncoded(QByteArray qbaSSHCertEncoded);

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSHCertStore Property (SSHReverseTunnel Class)

This is the name of the certificate store for the client certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSHCertStore(char* &lpSSHCertStore, int &lenSSHCertStore);
int SetSSHCertStore(const char* lpSSHCertStore, int lenSSHCertStore);

Unicode (Windows)
INT GetSSHCertStore(LPSTR &lpSSHCertStore, INT &lenSSHCertStore);
INT SetSSHCertStore(LPCSTR lpSSHCertStore, INT lenSSHCertStore);

int ipworksssh_sshreversetunnel_getsshcertstore(void* lpObj, char** lpSSHCertStore, int* lenSSHCertStore);
int ipworksssh_sshreversetunnel_setsshcertstore(void* lpObj, const char* lpSSHCertStore, int lenSSHCertStore);

QByteArray GetSSHCertStore();
int SetSSHCertStore(QByteArray qbaSSHCertStore);

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The SSHCertStoreType property denotes the type of the certificate store specified by SSHCertStore. If the store is password protected, specify the password in SSHCertStorePassword.

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

Designations of certificate stores are platform dependent.

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

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

Data Type

Binary String

SSHCertStorePassword Property (SSHReverseTunnel Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSHCertStorePassword();
int SetSSHCertStorePassword(const char* lpszSSHCertStorePassword);

Unicode (Windows)
LPWSTR GetSSHCertStorePassword();
INT SetSSHCertStorePassword(LPCWSTR lpszSSHCertStorePassword);

char* ipworksssh_sshreversetunnel_getsshcertstorepassword(void* lpObj);
int ipworksssh_sshreversetunnel_setsshcertstorepassword(void* lpObj, const char* lpszSSHCertStorePassword);

QString GetSSHCertStorePassword();
int SetSSHCertStorePassword(QString qsSSHCertStorePassword);

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

SSHCertStoreType Property (SSHReverseTunnel Class)

This is the type of certificate store for this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSHCertStoreType();
int SetSSHCertStoreType(int iSSHCertStoreType);

Unicode (Windows)
INT GetSSHCertStoreType();
INT SetSSHCertStoreType(INT iSSHCertStoreType);

CST_USER(0), 
CST_MACHINE(1), 
CST_PFXFILE(2), 
CST_PFXBLOB(3), 
CST_JKSFILE(4), 
CST_JKSBLOB(5), 
CST_PEMKEY_FILE(6), 
CST_PEMKEY_BLOB(7), 
CST_PUBLIC_KEY_FILE(8), 
CST_PUBLIC_KEY_BLOB(9), 
CST_SSHPUBLIC_KEY_BLOB(10), 
CST_P7BFILE(11), 
CST_P7BBLOB(12), 
CST_SSHPUBLIC_KEY_FILE(13), 
CST_PPKFILE(14), 
CST_PPKBLOB(15), 
CST_XMLFILE(16), 
CST_XMLBLOB(17), 
CST_JWKFILE(18), 
CST_JWKBLOB(19), 
CST_SECURITY_KEY(20), 
CST_BCFKSFILE(21), 
CST_BCFKSBLOB(22), 
CST_PKCS11(23), 
CST_AUTO(99)

int ipworksssh_sshreversetunnel_getsshcertstoretype(void* lpObj);
int ipworksssh_sshreversetunnel_setsshcertstoretype(void* lpObj, int iSSHCertStoreType);

int GetSSHCertStoreType();
int SetSSHCertStoreType(int iSSHCertStoreType);

Default Value

0

Remarks

This is the type of certificate store for this certificate.

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

 
 Copy
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);

Data Type

Integer

SSHCertSubject Property (SSHReverseTunnel Class)

This is the subject of the certificate used for client authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSHCertSubject();
int SetSSHCertSubject(const char* lpszSSHCertSubject);

Unicode (Windows)
LPWSTR GetSSHCertSubject();
INT SetSSHCertSubject(LPCWSTR lpszSSHCertSubject);

char* ipworksssh_sshreversetunnel_getsshcertsubject(void* lpObj);
int ipworksssh_sshreversetunnel_setsshcertsubject(void* lpObj, const char* lpszSSHCertSubject);

QString GetSSHCertSubject();
int SetSSHCertSubject(QString qsSSHCertSubject);

Default Value

""

Remarks

This is 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=support@nsoftware.com". Common fields and their meanings are as follows:

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

Data Type

String

SSHCompressionAlgorithms Property (SSHReverseTunnel Class)

A comma-separated list containing all allowable compression algorithms.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSHCompressionAlgorithms();
int SetSSHCompressionAlgorithms(const char* lpszSSHCompressionAlgorithms);

Unicode (Windows)
LPWSTR GetSSHCompressionAlgorithms();
INT SetSSHCompressionAlgorithms(LPCWSTR lpszSSHCompressionAlgorithms);

char* ipworksssh_sshreversetunnel_getsshcompressionalgorithms(void* lpObj);
int ipworksssh_sshreversetunnel_setsshcompressionalgorithms(void* lpObj, const char* lpszSSHCompressionAlgorithms);

QString GetSSHCompressionAlgorithms();
int SetSSHCompressionAlgorithms(QString qsSSHCompressionAlgorithms);

Default Value

"none,zlib"

Remarks

During the 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, so it is important to list multiple algorithms in preferential order. If no algorithm can be agreed upon, the class 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 class:

• zlib
• zlib@openssh.com
• none

Data Type

String

SSHEncryptionAlgorithms Property (SSHReverseTunnel Class)

A comma-separated list containing all allowable encryption algorithms.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSHEncryptionAlgorithms();
int SetSSHEncryptionAlgorithms(const char* lpszSSHEncryptionAlgorithms);

Unicode (Windows)
LPWSTR GetSSHEncryptionAlgorithms();
INT SetSSHEncryptionAlgorithms(LPCWSTR lpszSSHEncryptionAlgorithms);

char* ipworksssh_sshreversetunnel_getsshencryptionalgorithms(void* lpObj);
int ipworksssh_sshreversetunnel_setsshencryptionalgorithms(void* lpObj, const char* lpszSSHEncryptionAlgorithms);

QString GetSSHEncryptionAlgorithms();
int SetSSHEncryptionAlgorithms(QString qsSSHEncryptionAlgorithms);

Default Value

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

Remarks

During the 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, so it is important to list multiple algorithms in preferential order. If no algorithm can be agreed upon, the class 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 class:

Data Type

String

SSHHost Property (SSHReverseTunnel Class)

The address of the SSH host.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSHHost();
int SetSSHHost(const char* lpszSSHHost);

Unicode (Windows)
LPWSTR GetSSHHost();
INT SetSSHHost(LPCWSTR lpszSSHHost);

char* ipworksssh_sshreversetunnel_getsshhost(void* lpObj);
int ipworksssh_sshreversetunnel_setsshhost(void* lpObj, const char* lpszSSHHost);

QString GetSSHHost();
int SetSSHHost(QString qsSSHHost);

Default Value

""

Remarks

The SSHHost 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 SSHHost property is set to a Domain Name, a DNS request is initiated, and upon successful termination of the request, the SSHHost property is set to the corresponding address. If the search is not successful, an error is returned.

The SSHHost must be the same host that will be assumed for SSH as for the remote service being connected to.

Data Type

String

SSHPassword Property (SSHReverseTunnel Class)

The password for SSH password-based authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSHPassword();
int SetSSHPassword(const char* lpszSSHPassword);

Unicode (Windows)
LPWSTR GetSSHPassword();
INT SetSSHPassword(LPCWSTR lpszSSHPassword);

char* ipworksssh_sshreversetunnel_getsshpassword(void* lpObj);
int ipworksssh_sshreversetunnel_setsshpassword(void* lpObj, const char* lpszSSHPassword);

QString GetSSHPassword();
int SetSSHPassword(QString qsSSHPassword);

Default Value

""

Remarks

SSHPassword specifies the password which is used to authenticate the client to the SSH server.

Data Type

String

SSHPort Property (SSHReverseTunnel Class)

The port on the SSH server where the SSH service is running; by default, 22.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSHPort();
int SetSSHPort(int iSSHPort);

Unicode (Windows)
INT GetSSHPort();
INT SetSSHPort(INT iSSHPort);

int ipworksssh_sshreversetunnel_getsshport(void* lpObj);
int ipworksssh_sshreversetunnel_setsshport(void* lpObj, int iSSHPort);

int GetSSHPort();
int SetSSHPort(int iSSHPort);

Default Value

22

Remarks

The SSHPort 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

Integer

SSHUser Property (SSHReverseTunnel Class)

The username for SSH authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSHUser();
int SetSSHUser(const char* lpszSSHUser);

Unicode (Windows)
LPWSTR GetSSHUser();
INT SetSSHUser(LPCWSTR lpszSSHUser);

char* ipworksssh_sshreversetunnel_getsshuser(void* lpObj);
int ipworksssh_sshreversetunnel_setsshuser(void* lpObj, const char* lpszSSHUser);

QString GetSSHUser();
int SetSSHUser(QString qsSSHUser);

Default Value

""

Remarks

SSHUser specifies the username which is used to authenticate the client to the SSH server. This property is required.

Example (User/Password Auth):

 
 Copy
Control.SSHAuthMode = SftpSSHAuthModes.amPassword
Control.SSHUser = "username"
Control.SSHPassword = "password"
Control.SSHLogon("server", 22)

 
 Copy
Control.SSHAuthMode = SftpSSHAuthModes.amPublicKey
Control.SSHUser = "username"
Control.SSHCertStoreType = SSHCertStoreTypes.cstPFXFile;
Control.SSHCertStore = "cert.pfx";
Control.SSHCertStorePassword = "certpassword";
Control.SSHCertSubject = "*";  
Control.SSHLogon("server", 22)

Data Type

String

Timeout Property (SSHReverseTunnel Class)

A timeout for the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTimeout();
int SetTimeout(int iTimeout);

Unicode (Windows)
INT GetTimeout();
INT SetTimeout(INT iTimeout);

int ipworksssh_sshreversetunnel_gettimeout(void* lpObj);
int ipworksssh_sshreversetunnel_settimeout(void* lpObj, int iTimeout);

int GetTimeout();
int SetTimeout(int iTimeout);

Default Value

60

Remarks

If the Timeout property is set to 0, all operations return immediately, potentially failing with a WOULDBLOCK error if data cannot be sent immediately.

If Timeout is set to a positive value, data is sent in a blocking manner and the class will wait for the operation to complete before returning control. The class will handle any potential WOULDBLOCK errors internally and automatically retry the operation for a maximum of Timeout seconds.

The class will use DoEvents 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 class fails with an error.

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

Integer

CancelForwarding Method (SSHReverseTunnel Class)

Requests the server to stop forwarding a remote TCP/IP port.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CancelForwarding(const char* lpszAddress, int iPort);

Unicode (Windows)
INT CancelForwarding(LPCWSTR lpszAddress, INT iPort);

int ipworksssh_sshreversetunnel_cancelforwarding(void* lpObj, const char* lpszAddress, int iPort);

int CancelForwarding(const QString& qsAddress, int iPort);

Remarks

The CancelForwarding cancels a previous TCP/IP port forwarding request. When calling it, provide the same argument values you provided on the RequestForwarding call.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

CloseChannel Method (SSHReverseTunnel Class)

Closes a existing SSHChannel .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CloseChannel(const char* lpszChannelId);

Unicode (Windows)
INT CloseChannel(LPCWSTR lpszChannelId);

int ipworksssh_sshreversetunnel_closechannel(void* lpObj, const char* lpszChannelId);

int CloseChannel(const QString& qsChannelId);

Remarks

ChannelId is the identifier for the SSH channel to be closed.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Config Method (SSHReverseTunnel Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* ipworksssh_sshreversetunnel_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

DecodePacket Method (SSHReverseTunnel Class)

Decodes a hex-encoded SSH packet.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* DecodePacket(const char* lpszEncodedPacket, int *lpSize = NULL);

Unicode (Windows)
LPSTR DecodePacket(LPCWSTR lpszEncodedPacket, LPINT lpSize = NULL);

char* ipworksssh_sshreversetunnel_decodepacket(void* lpObj, const char* lpszEncodedPacket, int *lpSize);

QByteArray DecodePacket(const QString& qsEncodedPacket);

Remarks

This method is used to decode an SSH packet created by EncodePacket.

Note: This method is only applicable for reading and creating SSH packets for use within the SSHCustomAuth event.

Error Handling (C++)

This method returns a Binary String value (with length lpSize); after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

DoEvents Method (SSHReverseTunnel Class)

Processes events from the internal message queue.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();

int ipworksssh_sshreversetunnel_doevents(void* lpObj);

int DoEvents();

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

EncodePacket Method (SSHReverseTunnel Class)

Hex encodes an SSH packet.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* EncodePacket(const char* lpPacket, int lenPacket);

Unicode (Windows)
LPWSTR EncodePacket(LPCSTR lpPacket, INT lenPacket);

char* ipworksssh_sshreversetunnel_encodepacket(void* lpObj, const char* lpPacket, int lenPacket);

QString EncodePacket(QByteArray qbaPacket);

Remarks

This method is used to encode a raw SSH packet created by SetSSHParam.

Note: This method is only applicable for reading and creating SSH packets for use within the SSHCustomAuth event.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

ExchangeKeys Method (SSHReverseTunnel Class)

Causes the class to exchange a new set of session keys with the SSHHost .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ExchangeKeys();

Unicode (Windows)
INT ExchangeKeys();

int ipworksssh_sshreversetunnel_exchangekeys(void* lpObj);

int ExchangeKeys();

Remarks

SSH key renegotiation can be initiated by either end of an established SSH connection. ExchangeKeys allows the user to start such a renegotiation with the SSHHost. During this process, SSHStatus events will fire containing updates regarding the key negotiation process.

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

GetSSHParam Method (SSHReverseTunnel Class)

Used to read a field from an SSH packet's payload.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSHParam(const char* lpPayload, int lenPayload, const char* lpszField);

Unicode (Windows)
LPWSTR GetSSHParam(LPCSTR lpPayload, INT lenPayload, LPCWSTR lpszField);

char* ipworksssh_sshreversetunnel_getsshparam(void* lpObj, const char* lpPayload, int lenPayload, const char* lpszField);

QString GetSSHParam(QByteArray qbaPayload, const QString& qsField);

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 SSHChannelRequest. Field is the name of a field to be read out of the packet.

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

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

pty-req

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

x11-req

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

env

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

exec

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

subsystem

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

xon-xoff

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

signal

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

If the packet type is not well known, Field should start with the special character "%" and contain a comma-separated list of field types as defined in SetSSHParam. 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 SetSSHParam.

Note: This method is only applicable for reading and creating SSH packets for use within the SSHCustomAuth event.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

GetSSHParamBytes Method (SSHReverseTunnel Class)

Used to read a field from an SSH packet's payload.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSHParamBytes(const char* lpPayload, int lenPayload, const char* lpszField, int *lpSize = NULL);

Unicode (Windows)
LPSTR GetSSHParamBytes(LPCSTR lpPayload, INT lenPayload, LPCWSTR lpszField, LPINT lpSize = NULL);

char* ipworksssh_sshreversetunnel_getsshparambytes(void* lpObj, const char* lpPayload, int lenPayload, const char* lpszField, int *lpSize);

QByteArray GetSSHParamBytes(QByteArray qbaPayload, const QString& qsField);

Remarks

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

Note: This method is only applicable for reading and creating SSH packets for use within the SSHCustomAuth event.

Error Handling (C++)

This method returns a Binary String value (with length lpSize); after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

RequestForwarding Method (SSHReverseTunnel Class)

Requests the server to forward a remote TCP/IP port.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int RequestForwarding(const char* lpszAddress, int iPort, const char* lpszForwardingHost, int iForwardingPort);

Unicode (Windows)
INT RequestForwarding(LPCWSTR lpszAddress, INT iPort, LPCWSTR lpszForwardingHost, INT iForwardingPort);

int ipworksssh_sshreversetunnel_requestforwarding(void* lpObj, const char* lpszAddress, int iPort, const char* lpszForwardingHost, int iForwardingPort);

int RequestForwarding(const QString& qsAddress, int iPort, const QString& qsForwardingHost, int iForwardingPort);

Remarks

The RequestForwarding method asks the server to listen at the specified TCP/IP Address and Port for connection requests and then forward them as new SSH channels to the class.

ForwardingHost and ForwardingPort may be used to specify an address and port to which traffic will automatically be forwarded. If automatic forwarding is not desired, specify an empty string ("") for the ForwardingHost parameter.

The Address argument can be specified in different ways:

• "" means that connections are to be accepted on all protocol families supported by the server.
• "0.0.0.0" means to listen on all IPv4 addresses.
• "::" means to listen on all IPv6 addresses.
• "localhost" means to listen on all protocol families supported by the SSH implementation on loopback addresses only.
• "127.0.0.1" and "::1" indicate listening on the loopback interfaces for IPv4 and IPv6, respectively.

Passing a value of 0 for the Port parameter instructs the server to assign a port. In this case, query the ForwardedPort setting to determine the port that was assigned by the server.

The class has two modes that allow data to be dealt with directly from the events, or automatically forwarded on to a different endpoint.

Event Based Operation

In this mode, any data received by the class over the tunnel causes the events of the class to fire. For instance:

 
 Copy
SSHReverseTunnel.RequestForwarding("0.0.0.0", 777, "", 0);

In the above code, forwarding is requested from port 777 on the SSHHost. Any data received on port 777 by the SSHHost will be sent to the class. In the above code, the last two parameters are empty and 0, indicating to the class that no local forwarding is requested.

Once RequestForwarding returns, the SSH reverse tunnel is established. Any connection made to the SSH host on the specified port will then trigger the class's events to fire, allowing you to handle the connection request and data.

When a client connects to the SSH host on the specified port, the SSHChannelOpenRequest event will fire. Within this event, choose to accept or reject the connection by setting the Accept parameter. This event contains details about the connection that may be used when determining whether to accept the connection.

After the channel is established, data is received through the SSHChannelData event. Call the SendChannelData method to send data over the channel, and call the CloseChannel method to close the channel.

Local Forwarding

In this mode, any data received by the class is automatically forwarded to a separate endpoint. This allows the class to act as a sort of proxy. There is no need to handle data directly in this case. For instance:

 
 Copy
SSHReverseTunnel.RequestForwarding("0.0.0.0", 777, "nsoftware.com", 80);

In the above code, forwarding is requested from port 777 on SSHHost. The class is instructed to establish a connection to "nsoftware.com" on port 80 when a client connects to SSHHost on port 777. Any data received from the client connected to SSHHost on port 777 will automatically be forwarded to "nsoftware.com" on port 80. Any data received back from "nsoftware.com" on port 80 will be sent back to the connected client.

In this mode, data may flow freely from the client connected to the SSHHost to the endpoint specified in the RequestForwarding method without any additional code required.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Reset Method (SSHReverseTunnel Class)

Reset the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int ipworksssh_sshreversetunnel_reset(void* lpObj);

int Reset();

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SendChannelData Method (SSHReverseTunnel Class)

Used to send data over an SSH channel.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SendChannelData(const char* lpszChannelId, const char* lpData, int lenData);

Unicode (Windows)
INT SendChannelData(LPCWSTR lpszChannelId, LPCSTR lpData, INT lenData);

int ipworksssh_sshreversetunnel_sendchanneldata(void* lpObj, const char* lpszChannelId, const char* lpData, int lenData);

int SendChannelData(const QString& qsChannelId, QByteArray qbaData);

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SetSSHParam Method (SSHReverseTunnel Class)

Used to write a field to the end of a payload.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* SetSSHParam(const char* lpPayload, int lenPayload, const char* lpszFieldType, const char* lpszFieldValue, int *lpSize = NULL);

Unicode (Windows)
LPSTR SetSSHParam(LPCSTR lpPayload, INT lenPayload, LPCWSTR lpszFieldType, LPCWSTR lpszFieldValue, LPINT lpSize = NULL);

char* ipworksssh_sshreversetunnel_setsshparam(void* lpObj, const char* lpPayload, int lenPayload, const char* lpszFieldType, const char* lpszFieldValue, int *lpSize);

QByteArray SetSSHParam(QByteArray qbaPayload, const QString& qsFieldType, const QString& qsFieldValue);

Remarks

This method is used to build the payload portion of an SSH packet to be sent later by a call to SendSSHPacket. Payload should contain the result of a previous call to SetSSHParam. FieldType is a string defining the type of field to be written to the packet. FieldValue should be the string representation of the field to be written.

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

Note: integer values may be encoded in hexadecimal by prefixing "0x" to the beginning of the string, otherwise the value is assumed to be base-10.

Note: This method is only applicable for reading and creating SSH packets for use within the SSHCustomAuth event.

Error Handling (C++)

This method returns a Binary String value (with length lpSize); after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

SSHLogoff Method (SSHReverseTunnel Class)

Logoff from the SSH server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SSHLogoff();

Unicode (Windows)
INT SSHLogoff();

int ipworksssh_sshreversetunnel_sshlogoff(void* lpObj);

int SSHLogoff();

Remarks

Logoff from the SSH server. If that fails, the connection is terminated by the local host.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SSHLogon Method (SSHReverseTunnel Class)

Logon to the SSHHost using the current SSHUser and SSHPassword .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SSHLogon(const char* lpszSSHHost, int iSSHPort);

Unicode (Windows)
INT SSHLogon(LPCWSTR lpszSSHHost, INT iSSHPort);

int ipworksssh_sshreversetunnel_sshlogon(void* lpObj, const char* lpszSSHHost, int iSSHPort);

int SSHLogon(const QString& qsSSHHost, int iSSHPort);

Remarks

Logon to the SSH server using the current SSHUser and SSHPassword. This will perform the SSH handshake and authentication.

Example (Logging On)

 
 Copy
SSHClient.SSHUser = "username"
SSHClient.SSHPassword = "password"
SSHClient.SSHLogon("sshHost", sshPort)

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Connected Event (SSHReverseTunnel Class)

This event is fired immediately after a connection completes (or fails).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireConnected(SSHReverseTunnelConnectedEventParams *e);

typedef struct {
  int StatusCode;
  const char *Description;
  int reserved;
} SSHReverseTunnelConnectedEventParams;


Unicode (Windows)
virtual INT FireConnected(SSHReverseTunnelConnectedEventParams *e);

typedef struct {
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} SSHReverseTunnelConnectedEventParams;

#define EID_SSHREVERSETUNNEL_CONNECTED 1

virtual INT IPWORKSSSH_CALL FireConnected(INT &iStatusCode, LPSTR &lpszDescription);

class SSHReverseTunnelConnectedEventParams {
public:
  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Connected(SSHReverseTunnelConnectedEventParams *e);

// Or, subclass SSHReverseTunnel and override this emitter function.
virtual int FireConnected(SSHReverseTunnelConnectedEventParams *e) {...}

Remarks

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

If the connection fails, StatusCode has the error code returned by the Transmission Control Protocol (TCP)/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.

Please refer to the Error Codes section for more information.

ConnectionStatus Event (SSHReverseTunnel Class)

This event is fired to indicate changes in the connection state.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireConnectionStatus(SSHReverseTunnelConnectionStatusEventParams *e);

typedef struct {
  const char *ConnectionEvent;
  int StatusCode;
  const char *Description;
  int reserved;
} SSHReverseTunnelConnectionStatusEventParams;


Unicode (Windows)
virtual INT FireConnectionStatus(SSHReverseTunnelConnectionStatusEventParams *e);

typedef struct {
  LPCWSTR ConnectionEvent;
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} SSHReverseTunnelConnectionStatusEventParams;

#define EID_SSHREVERSETUNNEL_CONNECTIONSTATUS 2

virtual INT IPWORKSSSH_CALL FireConnectionStatus(LPSTR &lpszConnectionEvent, INT &iStatusCode, LPSTR &lpszDescription);

class SSHReverseTunnelConnectionStatusEventParams {
public:
  const QString &ConnectionEvent();

  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void ConnectionStatus(SSHReverseTunnelConnectionStatusEventParams *e);

// Or, subclass SSHReverseTunnel and override this emitter function.
virtual int FireConnectionStatus(SSHReverseTunnelConnectionStatusEventParams *e) {...}

Remarks

The ConnectionStatus event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake.

The ConnectionEvent parameter indicates the type of connection event. Values may include the following:

Disconnected Event (SSHReverseTunnel Class)

This event is fired when a connection is closed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireDisconnected(SSHReverseTunnelDisconnectedEventParams *e);

typedef struct {
  int StatusCode;
  const char *Description;
  int reserved;
} SSHReverseTunnelDisconnectedEventParams;


Unicode (Windows)
virtual INT FireDisconnected(SSHReverseTunnelDisconnectedEventParams *e);

typedef struct {
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} SSHReverseTunnelDisconnectedEventParams;

#define EID_SSHREVERSETUNNEL_DISCONNECTED 3

virtual INT IPWORKSSSH_CALL FireDisconnected(INT &iStatusCode, LPSTR &lpszDescription);

class SSHReverseTunnelDisconnectedEventParams {
public:
  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Disconnected(SSHReverseTunnelDisconnectedEventParams *e);

// Or, subclass SSHReverseTunnel and override this emitter function.
virtual int FireDisconnected(SSHReverseTunnelDisconnectedEventParams *e) {...}

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 Transmission Control Protocol (TCP/IP) subsystem. Description contains a description of this code. The value of StatusCode is equal to the value of the TCP/IP error.

Please refer to the Error Codes section for more information.

Error Event (SSHReverseTunnel Class)

Fired when information is available about errors during data delivery.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(SSHReverseTunnelErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} SSHReverseTunnelErrorEventParams;


Unicode (Windows)
virtual INT FireError(SSHReverseTunnelErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} SSHReverseTunnelErrorEventParams;

#define EID_SSHREVERSETUNNEL_ERROR 4

virtual INT IPWORKSSSH_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class SSHReverseTunnelErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(SSHReverseTunnelErrorEventParams *e);

// Or, subclass SSHReverseTunnel and override this emitter function.
virtual int FireError(SSHReverseTunnelErrorEventParams *e) {...}

Remarks

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

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

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

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

Log Event (SSHReverseTunnel Class)

Fires once for each log message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireLog(SSHReverseTunnelLogEventParams *e);

typedef struct {
  int LogLevel;
  const char *Message;
  const char *LogType;
  int reserved;
} SSHReverseTunnelLogEventParams;


Unicode (Windows)
virtual INT FireLog(SSHReverseTunnelLogEventParams *e);

typedef struct {
  INT LogLevel;
  LPCWSTR Message;
  LPCWSTR LogType;
  INT reserved;
} SSHReverseTunnelLogEventParams;

#define EID_SSHREVERSETUNNEL_LOG 5

virtual INT IPWORKSSSH_CALL FireLog(INT &iLogLevel, LPSTR &lpszMessage, LPSTR &lpszLogType);

class SSHReverseTunnelLogEventParams {
public:
  int LogLevel();

  const QString &Message();

  const QString &LogType();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Log(SSHReverseTunnelLogEventParams *e);

// Or, subclass SSHReverseTunnel and override this emitter function.
virtual int FireLog(SSHReverseTunnelLogEventParams *e) {...}

Remarks

This event fires once for each log messages generated by the class. The verbosity is controlled by the LogLevel setting.

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

Message is the log message.

LogType is reserved for future use.

ReconnectAttempt Event (SSHReverseTunnel Class)

Fires when attempting to reconnect.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireReconnectAttempt(SSHReverseTunnelReconnectAttemptEventParams *e);

typedef struct {
  const char *Host;
  int Port;
  int RetryCount;
  int RetriesRemaining;
  int MaxRetryCount;
  int RetryInterval;
  int RetryType;
  int RemoteListeningPort;
  int Cancel;
  int reserved;
} SSHReverseTunnelReconnectAttemptEventParams;


Unicode (Windows)
virtual INT FireReconnectAttempt(SSHReverseTunnelReconnectAttemptEventParams *e);

typedef struct {
  LPCWSTR Host;
  INT Port;
  INT RetryCount;
  INT RetriesRemaining;
  INT MaxRetryCount;
  INT RetryInterval;
  INT RetryType;
  INT RemoteListeningPort;
  BOOL Cancel;
  INT reserved;
} SSHReverseTunnelReconnectAttemptEventParams;

#define EID_SSHREVERSETUNNEL_RECONNECTATTEMPT 6

virtual INT IPWORKSSSH_CALL FireReconnectAttempt(LPSTR &lpszHost, INT &iPort, INT &iRetryCount, INT &iRetriesRemaining, INT &iMaxRetryCount, INT &iRetryInterval, INT &iRetryType, INT &iRemoteListeningPort, BOOL &bCancel);

class SSHReverseTunnelReconnectAttemptEventParams {
public:
  const QString &Host();

  int Port();

  int RetryCount();

  int RetriesRemaining();

  int MaxRetryCount();

  int RetryInterval();

  int RetryType();

  int RemoteListeningPort();

  bool Cancel();
  void SetCancel(bool bCancel);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void ReconnectAttempt(SSHReverseTunnelReconnectAttemptEventParams *e);

// Or, subclass SSHReverseTunnel and override this emitter function.
virtual int FireReconnectAttempt(SSHReverseTunnelReconnectAttemptEventParams *e) {...}

Remarks

This event fires both when attempting to reconnect to the SSHHost and when re-establishing a SSH tunnel.

Only applicable when AutoReconnect is enabled. To determine which type of connection is being established check the RetryType parameter.

The following table provides details about the parameters.

SSHChannelClosed Event (SSHReverseTunnel Class)

Fired when a channel is closed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSHChannelClosed(SSHReverseTunnelSSHChannelClosedEventParams *e);

typedef struct {
  const char *ChannelId;
  int reserved;
} SSHReverseTunnelSSHChannelClosedEventParams;


Unicode (Windows)
virtual INT FireSSHChannelClosed(SSHReverseTunnelSSHChannelClosedEventParams *e);

typedef struct {
  LPCWSTR ChannelId;
  INT reserved;
} SSHReverseTunnelSSHChannelClosedEventParams;

#define EID_SSHREVERSETUNNEL_SSHCHANNELCLOSED 7

virtual INT IPWORKSSSH_CALL FireSSHChannelClosed(LPSTR &lpszChannelId);

class SSHReverseTunnelSSHChannelClosedEventParams {
public:
  const QString &ChannelId();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSHChannelClosed(SSHReverseTunnelSSHChannelClosedEventParams *e);

// Or, subclass SSHReverseTunnel and override this emitter function.
virtual int FireSSHChannelClosed(SSHReverseTunnelSSHChannelClosedEventParams *e) {...}

Remarks

The SSHChannelClosed event is fired when a channel is closed on an SSH connection.

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

SSHChannelData Event (SSHReverseTunnel Class)

Fired when the SSHHost sends channel data to the client.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSHChannelData(SSHReverseTunnelSSHChannelDataEventParams *e);

typedef struct {
  const char *ChannelId;
  const char *ChannelData;
  int lenChannelData;
  int reserved;
} SSHReverseTunnelSSHChannelDataEventParams;


Unicode (Windows)
virtual INT FireSSHChannelData(SSHReverseTunnelSSHChannelDataEventParams *e);

typedef struct {
  LPCWSTR ChannelId;
  LPCSTR ChannelData;
  INT lenChannelData;
  INT reserved;
} SSHReverseTunnelSSHChannelDataEventParams;

#define EID_SSHREVERSETUNNEL_SSHCHANNELDATA 8

virtual INT IPWORKSSSH_CALL FireSSHChannelData(LPSTR &lpszChannelId, LPSTR &lpChannelData, INT &lenChannelData);

class SSHReverseTunnelSSHChannelDataEventParams {
public:
  const QString &ChannelId();

  const QByteArray &ChannelData();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSHChannelData(SSHReverseTunnelSSHChannelDataEventParams *e);

// Or, subclass SSHReverseTunnel and override this emitter function.
virtual int FireSSHChannelData(SSHReverseTunnelSSHChannelDataEventParams *e) {...}

Remarks

The SSHChannelData event will fire as data is received for the given ChannelId. ChannelData will contain the decrypted contents of the SSH packet.

SSHChannelEOF Event (SSHReverseTunnel Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSHChannelEOF(SSHReverseTunnelSSHChannelEOFEventParams *e);

typedef struct {
  const char *ChannelId;
  int reserved;
} SSHReverseTunnelSSHChannelEOFEventParams;


Unicode (Windows)
virtual INT FireSSHChannelEOF(SSHReverseTunnelSSHChannelEOFEventParams *e);

typedef struct {
  LPCWSTR ChannelId;
  INT reserved;
} SSHReverseTunnelSSHChannelEOFEventParams;

#define EID_SSHREVERSETUNNEL_SSHCHANNELEOF 9

virtual INT IPWORKSSSH_CALL FireSSHChannelEOF(LPSTR &lpszChannelId);

class SSHReverseTunnelSSHChannelEOFEventParams {
public:
  const QString &ChannelId();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSHChannelEOF(SSHReverseTunnelSSHChannelEOFEventParams *e);

// Or, subclass SSHReverseTunnel and override this emitter function.
virtual int FireSSHChannelEOF(SSHReverseTunnelSSHChannelEOFEventParams *e) {...}

Remarks

The SSHChannelEOF event is fired when the end of the data stream for a channel on an SSH connection is reached.

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

SSHChannelOpened Event (SSHReverseTunnel Class)

Fired when a channel is successfully opened.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSHChannelOpened(SSHReverseTunnelSSHChannelOpenedEventParams *e);

typedef struct {
  const char *ChannelId;
  int reserved;
} SSHReverseTunnelSSHChannelOpenedEventParams;


Unicode (Windows)
virtual INT FireSSHChannelOpened(SSHReverseTunnelSSHChannelOpenedEventParams *e);

typedef struct {
  LPCWSTR ChannelId;
  INT reserved;
} SSHReverseTunnelSSHChannelOpenedEventParams;

#define EID_SSHREVERSETUNNEL_SSHCHANNELOPENED 10

virtual INT IPWORKSSSH_CALL FireSSHChannelOpened(LPSTR &lpszChannelId);

class SSHReverseTunnelSSHChannelOpenedEventParams {
public:
  const QString &ChannelId();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSHChannelOpened(SSHReverseTunnelSSHChannelOpenedEventParams *e);

// Or, subclass SSHReverseTunnel and override this emitter function.
virtual int FireSSHChannelOpened(SSHReverseTunnelSSHChannelOpenedEventParams *e) {...}

Remarks

The SSHChannelOpened event is fired when a channel is successfully opened on an SSH connection.

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

SSHChannelOpenRequest Event (SSHReverseTunnel Class)

Fired when the peer attempts to open a new channel.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSHChannelOpenRequest(SSHReverseTunnelSSHChannelOpenRequestEventParams *e);

typedef struct {
  const char *ChannelId;
  const char *Service;
  const char *ConnectedAddress;
  int ConnectedPort;
  const char *OriginAddress;
  int OriginPort;
  int Accept;
  int reserved;
} SSHReverseTunnelSSHChannelOpenRequestEventParams;


Unicode (Windows)
virtual INT FireSSHChannelOpenRequest(SSHReverseTunnelSSHChannelOpenRequestEventParams *e);

typedef struct {
  LPCWSTR ChannelId;
  LPCWSTR Service;
  LPCWSTR ConnectedAddress;
  INT ConnectedPort;
  LPCWSTR OriginAddress;
  INT OriginPort;
  BOOL Accept;
  INT reserved;
} SSHReverseTunnelSSHChannelOpenRequestEventParams;

#define EID_SSHREVERSETUNNEL_SSHCHANNELOPENREQUEST 11

virtual INT IPWORKSSSH_CALL FireSSHChannelOpenRequest(LPSTR &lpszChannelId, LPSTR &lpszService, LPSTR &lpszConnectedAddress, INT &iConnectedPort, LPSTR &lpszOriginAddress, INT &iOriginPort, BOOL &bAccept);

class SSHReverseTunnelSSHChannelOpenRequestEventParams {
public:
  const QString &ChannelId();

  const QString &Service();

  const QString &ConnectedAddress();

  int ConnectedPort();

  const QString &OriginAddress();

  int OriginPort();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSHChannelOpenRequest(SSHReverseTunnelSSHChannelOpenRequestEventParams *e);

// Or, subclass SSHReverseTunnel and override this emitter function.
virtual int FireSSHChannelOpenRequest(SSHReverseTunnelSSHChannelOpenRequestEventParams *e) {...}

Remarks

This event is fired whenever a peer attempts to open a new channel for a given connection. ChannelId will contain the id of the channel to be created. Service will identify the type of channel that is being requested. Usually, this will be "forwarded-tcpip", in which case ConnectedAddress and ConnectedPort will contain the remote TCP/IP address and port on the peer to which the connection was established; OriginAddress and OriginPort contain the originating TCP/IP address and port of the connection.

By default Accept is True and the channel will be opened. Set Accept to False to reject the request.

SSHChannelReadyToSend Event (SSHReverseTunnel Class)

Fired when the class is ready to send data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSHChannelReadyToSend(SSHReverseTunnelSSHChannelReadyToSendEventParams *e);

typedef struct {
  const char *ChannelId;
  int reserved;
} SSHReverseTunnelSSHChannelReadyToSendEventParams;


Unicode (Windows)
virtual INT FireSSHChannelReadyToSend(SSHReverseTunnelSSHChannelReadyToSendEventParams *e);

typedef struct {
  LPCWSTR ChannelId;
  INT reserved;
} SSHReverseTunnelSSHChannelReadyToSendEventParams;

#define EID_SSHREVERSETUNNEL_SSHCHANNELREADYTOSEND 12

virtual INT IPWORKSSSH_CALL FireSSHChannelReadyToSend(LPSTR &lpszChannelId);

class SSHReverseTunnelSSHChannelReadyToSendEventParams {
public:
  const QString &ChannelId();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSHChannelReadyToSend(SSHReverseTunnelSSHChannelReadyToSendEventParams *e);

// Or, subclass SSHReverseTunnel and override this emitter function.
virtual int FireSSHChannelReadyToSend(SSHReverseTunnelSSHChannelReadyToSendEventParams *e) {...}

Remarks

This event fires when data can be sent over the SSH Channel specified by ChannelId.

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

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

When Timeout is set to a positive value the class will block when sending data until the data can be successfully sent and SSHChannelReadyToSend and ReadyToSend do not need to be monitored.

SSHChannelRequest Event (SSHReverseTunnel Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSHChannelRequest(SSHReverseTunnelSSHChannelRequestEventParams *e);

typedef struct {
  const char *ChannelId;
  const char *RequestType;
  const char *Packet;
  int lenPacket;
  int Success;
  int reserved;
} SSHReverseTunnelSSHChannelRequestEventParams;


Unicode (Windows)
virtual INT FireSSHChannelRequest(SSHReverseTunnelSSHChannelRequestEventParams *e);

typedef struct {
  LPCWSTR ChannelId;
  LPCWSTR RequestType;
  LPCSTR Packet;
  INT lenPacket;
  BOOL Success;
  INT reserved;
} SSHReverseTunnelSSHChannelRequestEventParams;

#define EID_SSHREVERSETUNNEL_SSHCHANNELREQUEST 13

virtual INT IPWORKSSSH_CALL FireSSHChannelRequest(LPSTR &lpszChannelId, LPSTR &lpszRequestType, LPSTR &lpPacket, INT &lenPacket, BOOL &bSuccess);

class SSHReverseTunnelSSHChannelRequestEventParams {
public:
  const QString &ChannelId();

  const QString &RequestType();

  const QByteArray &Packet();

  bool Success();
  void SetSuccess(bool bSuccess);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSHChannelRequest(SSHReverseTunnelSSHChannelRequestEventParams *e);

// Or, subclass SSHReverseTunnel and override this emitter function.
virtual int FireSSHChannelRequest(SSHReverseTunnelSSHChannelRequestEventParams *e) {...}

Remarks

The SSHHost may send requests that affect the status of a particular SSHChannel. Some requests will be automatically handled by the class. However, others may need the attention of the user to be dealt with properly within the scope of the application.

ChannelId identifies the channel receiving the request.

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

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

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

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

SSHChannelRequested Event (SSHReverseTunnel Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSHChannelRequested(SSHReverseTunnelSSHChannelRequestedEventParams *e);

typedef struct {
  const char *ChannelId;
  const char *RequestType;
  const char *Packet;
  int lenPacket;
  int reserved;
} SSHReverseTunnelSSHChannelRequestedEventParams;


Unicode (Windows)
virtual INT FireSSHChannelRequested(SSHReverseTunnelSSHChannelRequestedEventParams *e);

typedef struct {
  LPCWSTR ChannelId;
  LPCWSTR RequestType;
  LPCSTR Packet;
  INT lenPacket;
  INT reserved;
} SSHReverseTunnelSSHChannelRequestedEventParams;

#define EID_SSHREVERSETUNNEL_SSHCHANNELREQUESTED 14

virtual INT IPWORKSSSH_CALL FireSSHChannelRequested(LPSTR &lpszChannelId, LPSTR &lpszRequestType, LPSTR &lpPacket, INT &lenPacket);

class SSHReverseTunnelSSHChannelRequestedEventParams {
public:
  const QString &ChannelId();

  const QString &RequestType();

  const QByteArray &Packet();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSHChannelRequested(SSHReverseTunnelSSHChannelRequestedEventParams *e);

// Or, subclass SSHReverseTunnel and override this emitter function.
virtual int FireSSHChannelRequested(SSHReverseTunnelSSHChannelRequestedEventParams *e) {...}

Remarks

The SSHHost may send requests that affect the status of a particular SSHChannel. Some requests will be automatically handled by the class. However, others may need the attention of the user to be dealt with properly within the scope of the application.

ChannelId identifies the channel receiving the request.

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

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

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

SSHCustomAuth Event (SSHReverseTunnel Class)

Fired when the class is doing custom authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSHCustomAuth(SSHReverseTunnelSSHCustomAuthEventParams *e);

typedef struct {
  char *Packet;
  int reserved;
} SSHReverseTunnelSSHCustomAuthEventParams;


Unicode (Windows)
virtual INT FireSSHCustomAuth(SSHReverseTunnelSSHCustomAuthEventParams *e);

typedef struct {
  LPWSTR Packet;
  INT reserved;
} SSHReverseTunnelSSHCustomAuthEventParams;

#define EID_SSHREVERSETUNNEL_SSHCUSTOMAUTH 15

virtual INT IPWORKSSSH_CALL FireSSHCustomAuth(LPSTR &lpszPacket);

class SSHReverseTunnelSSHCustomAuthEventParams {
public:
  const QString &Packet();
  void SetPacket(const QString &qsPacket);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSHCustomAuth(SSHReverseTunnelSSHCustomAuthEventParams *e);

// Or, subclass SSHReverseTunnel and override this emitter function.
virtual int FireSSHCustomAuth(SSHReverseTunnelSSHCustomAuthEventParams *e) {...}

Remarks

SSHCustomAuth is fired during the user authentication stage of the SSH logon process if SSHAuthMode is set to amCustom. Packet contains the raw last 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 DecodePacket and then use the GetSSHParam and GetSSHParamBytes methods. To create a packet use the SetSSHParam method and then call EncodePacket to obtain a HEX-encoded value and assign this to the Packet parameter.

SSHKeyboardInteractive Event (SSHReverseTunnel Class)

Fired when the class receives a request for user input from the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSHKeyboardInteractive(SSHReverseTunnelSSHKeyboardInteractiveEventParams *e);

typedef struct {
  const char *Name;
  const char *Instructions;
  const char *Prompt;
  char *Response;
  int EchoResponse;
  int reserved;
} SSHReverseTunnelSSHKeyboardInteractiveEventParams;


Unicode (Windows)
virtual INT FireSSHKeyboardInteractive(SSHReverseTunnelSSHKeyboardInteractiveEventParams *e);

typedef struct {
  LPCWSTR Name;
  LPCWSTR Instructions;
  LPCWSTR Prompt;
  LPWSTR Response;
  BOOL EchoResponse;
  INT reserved;
} SSHReverseTunnelSSHKeyboardInteractiveEventParams;

#define EID_SSHREVERSETUNNEL_SSHKEYBOARDINTERACTIVE 16

virtual INT IPWORKSSSH_CALL FireSSHKeyboardInteractive(LPSTR &lpszName, LPSTR &lpszInstructions, LPSTR &lpszPrompt, LPSTR &lpszResponse, BOOL &bEchoResponse);

class SSHReverseTunnelSSHKeyboardInteractiveEventParams {
public:
  const QString &Name();

  const QString &Instructions();

  const QString &Prompt();

  const QString &Response();
  void SetResponse(const QString &qsResponse);

  bool EchoResponse();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSHKeyboardInteractive(SSHReverseTunnelSSHKeyboardInteractiveEventParams *e);

// Or, subclass SSHReverseTunnel and override this emitter function.
virtual int FireSSHKeyboardInteractive(SSHReverseTunnelSSHKeyboardInteractiveEventParams *e) {...}

Remarks

SSHKeyboardInteractive is fired during the user authentication stage of the SSH logon process. During authentication, the class will request a list of available authentication methods for the SSHUser. For example, if the SSHHost responds with "keyboard-interactive", the class 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 class will fire the SSHKeyboardInteractive event once for each prompt.

SSHServerAuthentication Event (SSHReverseTunnel Class)

Fired after the server presents its public key to the client.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSHServerAuthentication(SSHReverseTunnelSSHServerAuthenticationEventParams *e);

typedef struct {
  const char *HostKey;
  int lenHostKey;
  const char *Fingerprint;
  const char *KeyAlgorithm;
  const char *CertSubject;
  const char *CertIssuer;
  const char *Status;
  int Accept;
  int reserved;
} SSHReverseTunnelSSHServerAuthenticationEventParams;


Unicode (Windows)
virtual INT FireSSHServerAuthentication(SSHReverseTunnelSSHServerAuthenticationEventParams *e);

typedef struct {
  LPCSTR HostKey;
  INT lenHostKey;
  LPCWSTR Fingerprint;
  LPCWSTR KeyAlgorithm;
  LPCWSTR CertSubject;
  LPCWSTR CertIssuer;
  LPCWSTR Status;
  BOOL Accept;
  INT reserved;
} SSHReverseTunnelSSHServerAuthenticationEventParams;

#define EID_SSHREVERSETUNNEL_SSHSERVERAUTHENTICATION 17

virtual INT IPWORKSSSH_CALL FireSSHServerAuthentication(LPSTR &lpHostKey, INT &lenHostKey, LPSTR &lpszFingerprint, LPSTR &lpszKeyAlgorithm, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);

class SSHReverseTunnelSSHServerAuthenticationEventParams {
public:
  const QByteArray &HostKey();

  const QString &Fingerprint();

  const QString &KeyAlgorithm();

  const QString &CertSubject();

  const QString &CertIssuer();

  const QString &Status();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSHServerAuthentication(SSHReverseTunnelSSHServerAuthenticationEventParams *e);

// Or, subclass SSHReverseTunnel and override this emitter function.
virtual int FireSSHServerAuthentication(SSHReverseTunnelSSHServerAuthenticationEventParams *e) {...}

Remarks

This event is where the client can decide whether to continue with the connection process or not. If the public key is known to be a valid key for the 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 SSHAcceptServerHostKey.

Accept may be set to True manually to accept the server host key.

Note that 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.

KeyAlgorithm identifies the host key algorithm. Supported values are:

• 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

CertSubject is the subject of the certificate. This is only applicable when KeyAlgorithm is "x509v3-sign-rsa" or "x509v3-sign-dss".

CertIssuer is the issuer of the certificate. This is only applicable when KeyAlgorithm is "x509v3-sign-rsa" or "x509v3-sign-dss".

Status is reserved for future use.

SSHStatus Event (SSHReverseTunnel Class)

Shows the progress of the secure connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSHStatus(SSHReverseTunnelSSHStatusEventParams *e);

typedef struct {
  const char *Message;
  int reserved;
} SSHReverseTunnelSSHStatusEventParams;


Unicode (Windows)
virtual INT FireSSHStatus(SSHReverseTunnelSSHStatusEventParams *e);

typedef struct {
  LPCWSTR Message;
  INT reserved;
} SSHReverseTunnelSSHStatusEventParams;

#define EID_SSHREVERSETUNNEL_SSHSTATUS 18

virtual INT IPWORKSSSH_CALL FireSSHStatus(LPSTR &lpszMessage);

class SSHReverseTunnelSSHStatusEventParams {
public:
  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSHStatus(SSHReverseTunnelSSHStatusEventParams *e);

// Or, subclass SSHReverseTunnel and override this emitter function.
virtual int FireSSHStatus(SSHReverseTunnelSSHStatusEventParams *e) {...}

Remarks

The event is fired for informational and logging purposes only. Used to track the progress of the connection.

Config Settings (SSHReverseTunnel Class)

SSHReverseTunnel Config Settings

SSHClient Config Settings

 
 Copy
component.Config("EnablePageantAuth=1");
component.SSHUser = "sshuser";
component.SSHLogon("localhost", 22);

 
 Copy
SSHComponent.Config("KeyRenegotiationThreshold=524288000")

 
 Copy
component.Config("NegotiatedStrictKex")

 
 Copy
component.Config("SignedSSHCert=ssh-rsa-cert-v01@openssh.com AAAAB3NzaC1yc2EAAAADAQABAAAB...");

 
 Copy
component.Config("SSHAcceptServerCAKey=ssh-rsa AAAAB3NzaC1yc2EAAAADAQAB...");

 
 Copy
SSHClient.Config("SSHAcceptServerHostKeyFingerprint=0a:1b:2c:3d");

 
 Copy
SSHClient.Config("SSHKeyRenegotiate")

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

TCPClient Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (SSHReverseTunnel Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

SSHReverseTunnel Errors

SSHClient Errors