SSHTunnel Class

Properties   Methods   Events   Config Settings   Errors  

The SSHTunnel class can be used to tunnel data through an SSH server to a remote location.

Syntax

SSHTunnel

Remarks

The SSHTunnel class implements a daemon that accepts connections and tunnels the data from those connections over a Secure Shell (SSH) connection to a remote location.

First, set SSHHost to the server you wish to use to tunnel the data. SSHUser, SSHPassword and the SSHCert* properties can be used to authenticate the tunneling connection.

Second, set SSHForwardHost to the hostname or IP address of the destination machine, and SSHForwardPort to the port to which you wish to send data. Finally, call StartListening. The class will listen for connections on the interface identified by LocalHost and LocalPort.

When a client attempts to connect to the class, the class will fire a ConnectionRequest event that can be used to accept or reject the connection. If the connection is accepted, the class will attempt to logon to the SSHHost, and will tell the server to connect remotely to another machine. Once this process is complete, the tunnel will be established and data can be securely transmitted from end to end.

Example: Connecting Between Networks

A client which exists in Network A wishes to connect to a resource that exists in Network B. Both networks are secured by a firewall, making it difficult to freely connect to resources within the other network. However, Network B contains an SSH server which supports tunneling. An SSHTunnel class set up with Network A can be used to access any resource in Network B.

The SSHHost and SSHPort properties must be set to the hostname and port exposed by Network B's firewall. SSHForwardHost and SSHForwardPort are then set to the value of the resource within Network B to which the client in Network A wishes to connect. Any client in Network A can then connect to the SSHTunnel instance's LocalHost and LocalPort.

As clients within Network A connect to the SSHTunnel, the class will forward the connections, secured by SSH, through the network firewalls to the SSH server in Network B. The SSH server will then connect to the resource within Network B and forward all data received from the SSHTunnel instance to that resource. All data received from the resource will then be forwarded back to the original client in Network A.

Dynamic Forwarding

Dynamic forwarding is a feature provided by SSH that leverages the SOCKS protocol. With dynamic forwarding, the SSHTunnel component acts as a SOCKS proxy, and all relevant traffic is relayed through the SSH connection to the destination defined by the client that made the request. The SSHTunnel component supports dynamic forwarding automatically when SSHForwardHost and SSHForwardPort are not specified (the forwarding host is determined dynamically).

The client making requests through SSHTunnel must be configured to use a SOCKS proxy, where the proxy port is the same as the LocalPort property. In IPWorks components a SOCKS proxy can be enabled like so:

 
 Copy
// Enable the SOCKS proxy for IPWorks' HTTP component
http.Firewall.FirewallType = nsoftware.IPWorks.FirewallTypes.fwSOCKS5;
http.Firewall.Port = 1234; //The port set in the SSHTunnel LocalPort property
http.Firewall.Host = "localhost"; //The hostname or IP address where SSHTunnel is listening

Note: SSHTunnel can support either dynamic forwarding (SSHForwardHost and SSHForwardPort are not set), or standard forwarding (SSHForwardHost and SSHForwardPort are set). It cannot support both modes at the same time. As a result it is expected that clients connecting to the SSHTunnel component are configured in a way that matches the configuration of the SSHTunnel component (dynamic or standard forwarding). For example, if SSHTunnel has the SSHForwardHost and SSHForwardPort properties set, then the client must NOT treat SSHTunnel as a SOCKS proxy. If the SSHTunnel does not have the aforementioned properties set, then the client MUST treat SSHTunnel as a SOCKS proxy.

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

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.

Connected Property (SSHTunnel 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_sshtunnel_getconnected(void* lpObj);
int ipworksssh_sshtunnel_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

ConnectionBacklog Property (SSHTunnel Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnectionBacklog();
int SetConnectionBacklog(int iConnectionBacklog);

Unicode (Windows)
INT GetConnectionBacklog();
INT SetConnectionBacklog(INT iConnectionBacklog);

int ipworksssh_sshtunnel_getconnectionbacklog(void* lpObj);
int ipworksssh_sshtunnel_setconnectionbacklog(void* lpObj, int iConnectionBacklog);

int GetConnectionBacklog();
int SetConnectionBacklog(int iConnectionBacklog);

Default Value

5

Remarks

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

This property is not available at design time.

Data Type

Integer

ClientCount Property (SSHTunnel Class)

The number of records in the Client arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetClientCount();

Unicode (Windows)
INT GetClientCount();

int ipworksssh_sshtunnel_getclientcount(void* lpObj);

int GetClientCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• ClientAcceptData
• ClientBytesSent
• ClientConnected
• ClientConnectionId
• ClientDataToSend
• ClientEOL
• ClientIdleTimeout
• ClientLocalAddress
• ClientReadyToSend
• ClientRecordLength
• ClientRemoteHost
• ClientRemotePort
• ClientSingleLineMode
• ClientTimeout
• ClientUserData

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

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

Data Type

Integer

ClientAcceptData Property (SSHTunnel Class)

Setting this property to false temporarily disables data reception (and the DataIn event) for the connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetClientAcceptData(int iClientId);
int SetClientAcceptData(int iClientId, int bClientAcceptData);

Unicode (Windows)
BOOL GetClientAcceptData(INT iClientId);
INT SetClientAcceptData(INT iClientId, BOOL bClientAcceptData);

int ipworksssh_sshtunnel_getclientacceptdata(void* lpObj, int clientid);
int ipworksssh_sshtunnel_setclientacceptdata(void* lpObj, int clientid, int bClientAcceptData);

bool GetClientAcceptData(int iClientId);
int SetClientAcceptData(int iClientId, bool bClientAcceptData);

Default Value

TRUE

Remarks

Setting this property to false temporarily disables data reception (and the DataIn event) for the connection. Setting this to true re-enables data reception.

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

The ClientId parameter specifies the index of the item in the array. The size of the array is controlled by the ClientCount property.

This property is not available at design time.

Data Type

Boolean

ClientBytesSent Property (SSHTunnel Class)

This property shows how many bytes were sent after the last assignment to DataToSend .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetClientBytesSent(int iClientId);

Unicode (Windows)
INT GetClientBytesSent(INT iClientId);

int ipworksssh_sshtunnel_getclientbytessent(void* lpObj, int clientid);

int GetClientBytesSent(int iClientId);

Default Value

0

Remarks

This property shows how many bytes were sent after the last assignment to ClientDataToSend. Please check ClientDataToSend for more information.

Note: This property will always return 0 when the class is operating in the synchronous mode (i.e., the ClientTimeout property is set to a positive value).

The ClientId parameter specifies the index of the item in the array. The size of the array is controlled by the ClientCount property.

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

Data Type

Integer

ClientConnected Property (SSHTunnel Class)

This property is used to disconnect individual connections or to show their status.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetClientConnected(int iClientId);
int SetClientConnected(int iClientId, int bClientConnected);

Unicode (Windows)
BOOL GetClientConnected(INT iClientId);
INT SetClientConnected(INT iClientId, BOOL bClientConnected);

int ipworksssh_sshtunnel_getclientconnected(void* lpObj, int clientid);
int ipworksssh_sshtunnel_setclientconnected(void* lpObj, int clientid, int bClientConnected);

bool GetClientConnected(int iClientId);
int SetClientConnected(int iClientId, bool bClientConnected);

Default Value

FALSE

Remarks

This property is used to disconnect individual connections or to show their status.

The ClientConnected property may be set to false to close the connection.

ClientConnected also shows the status of a particular connection (connected/disconnected).

How and when the connection is closed is controlled by the Linger property. Please refer to its description for more information.

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

The ClientId parameter specifies the index of the item in the array. The size of the array is controlled by the ClientCount property.

This property is not available at design time.

Data Type

Boolean

ClientConnectionId Property (SSHTunnel Class)

This property contains an identifier generated by the class to identify each connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetClientConnectionId(int iClientId);

Unicode (Windows)
LPWSTR GetClientConnectionId(INT iClientId);

char* ipworksssh_sshtunnel_getclientconnectionid(void* lpObj, int clientid);

QString GetClientConnectionId(int iClientId);

Default Value

""

Remarks

This property contains an identifier generated by the class to identify each connection. This identifier is unique to this connection.

The ClientId parameter specifies the index of the item in the array. The size of the array is controlled by the ClientCount property.

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

Data Type

String

ClientDataToSend Property (SSHTunnel Class)

This property contains a string of data to be sent to the remote host.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetClientDataToSend(int iClientId, const char* lpClientDataToSend, int lenClientDataToSend);

Unicode (Windows)
INT SetClientDataToSend(INT iClientId, LPCSTR lpClientDataToSend, INT lenClientDataToSend);

int ipworksssh_sshtunnel_setclientdatatosend(void* lpObj, int clientid, const char* lpClientDataToSend, int lenClientDataToSend);

int SetClientDataToSend(int iClientId, QByteArray qbaClientDataToSend);

Default Value

""

Remarks

This property contains a string of data to be sent to the remote host. It is a write-only property.

Assigning a string to the ClientDataToSend makes the class send the string to the remote host. The Send method provides similar functionality.

When ClientTimeout is set to 0, the class will behave asynchronously. If you are sending data to the remote host faster than it can process it, or faster than the network's bandwidth allows, the outgoing queue might fill up. When this happens, the operation fails with error 10035: "[10035] Operation would block" (WSAEWOULDBLOCK). You can check this error, and then try to send the data again. . The BytesSent property shows how many bytes were sent (if any). If 0 bytes were sent, then you can wait for the ReadyToSend event before attempting to send data again.

Note: The ReadyToSend event is not fired when part of the data is sent successfully.

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

The ClientId parameter specifies the index of the item in the array. The size of the array is controlled by the ClientCount property.

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

Data Type

Binary String

ClientEOL Property (SSHTunnel Class)

The EOL property is used to define boundaries in the input stream using the value of the property.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetClientEOL(int iClientId, char* &lpClientEOL, int &lenClientEOL);
int SetClientEOL(int iClientId, const char* lpClientEOL, int lenClientEOL);

Unicode (Windows)
INT GetClientEOL(INT iClientId, LPSTR &lpClientEOL, INT &lenClientEOL);
INT SetClientEOL(INT iClientId, LPCSTR lpClientEOL, INT lenClientEOL);

int ipworksssh_sshtunnel_getclienteol(void* lpObj, int clientid, char** lpClientEOL, int* lenClientEOL);
int ipworksssh_sshtunnel_setclienteol(void* lpObj, int clientid, const char* lpClientEOL, int lenClientEOL);

QByteArray GetClientEOL(int iClientId);
int SetClientEOL(int iClientId, QByteArray qbaClientEOL);

Default Value

""

Remarks

The ClientEOL property is used to define boundaries in the input stream using the value of the property.

The ClientEOL property is especially useful with ASCII files. By setting it to CRLF ("\r\n") , the incoming ASCII text stream can be split into lines. In this case, one event is fired for each line received (as well as in packet boundaries). The CRLF ("\r\n") . bytes are discarded.

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

When reading the value of the property, if ConnectionId does not belong to a valid connection, then NULL will be returned, and the LastError property will contain a corresponding error message. If no error is encountered, then LastError will contain NULL.

The ClientId parameter specifies the index of the item in the array. The size of the array is controlled by the ClientCount property.

This property is not available at design time.

Data Type

Binary String

ClientIdleTimeout Property (SSHTunnel Class)

This property contains the idle timeout for this connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetClientIdleTimeout(int iClientId);
int SetClientIdleTimeout(int iClientId, int iClientIdleTimeout);

Unicode (Windows)
INT GetClientIdleTimeout(INT iClientId);
INT SetClientIdleTimeout(INT iClientId, INT iClientIdleTimeout);

int ipworksssh_sshtunnel_getclientidletimeout(void* lpObj, int clientid);
int ipworksssh_sshtunnel_setclientidletimeout(void* lpObj, int clientid, int iClientIdleTimeout);

int GetClientIdleTimeout(int iClientId);
int SetClientIdleTimeout(int iClientId, int iClientIdleTimeout);

Default Value

0

Remarks

This property contains the idle timeout for this connection. This property is similar to DefaultIdleTimeout but may be set on a per-connection basis to override DefaultIdleTimeout. This property specifies the idle timeout (in seconds) for the connected client. When set to a positive value, the class will disconnect idle clients after the specified timeout.

This applies only to clients that have not sent to received data within the specified number of seconds.

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

Note: DoEvents must be called for the class to check existing connections.

The ClientId parameter specifies the index of the item in the array. The size of the array is controlled by the ClientCount property.

This property is not available at design time.

Data Type

Integer

ClientLocalAddress Property (SSHTunnel Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetClientLocalAddress(int iClientId);

Unicode (Windows)
LPWSTR GetClientLocalAddress(INT iClientId);

char* ipworksssh_sshtunnel_getclientlocaladdress(void* lpObj, int clientid);

QString GetClientLocalAddress(int iClientId);

Default Value

""

Remarks

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

ClientLocalAddress is important for multihomed hosts so that it can be used to find the particular network interface through which an individual connection is going.

The ClientId parameter specifies the index of the item in the array. The size of the array is controlled by the ClientCount property.

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

Data Type

String

ClientReadyToSend Property (SSHTunnel Class)

This indicates whether the class is ready to send data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetClientReadyToSend(int iClientId);

Unicode (Windows)
BOOL GetClientReadyToSend(INT iClientId);

int ipworksssh_sshtunnel_getclientreadytosend(void* lpObj, int clientid);

bool GetClientReadyToSend(int iClientId);

Default Value

FALSE

Remarks

This indicates whether the class is ready to send data.

This property indicates that the underlying TCP/IP subsystem is ready to accept data. This is True after a client connects but will become False after a failed ClientDataToSend.

After a failed ClientDataToSend, the ReadyToSend event will fire and this property will be True when data can be sent again.

The ClientId parameter specifies the index of the item in the array. The size of the array is controlled by the ClientCount property.

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

Data Type

Boolean

ClientRecordLength Property (SSHTunnel Class)

If set to a positive value, this setting defines the length of the data records to be received.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetClientRecordLength(int iClientId);
int SetClientRecordLength(int iClientId, int iClientRecordLength);

Unicode (Windows)
INT GetClientRecordLength(INT iClientId);
INT SetClientRecordLength(INT iClientId, INT iClientRecordLength);

int ipworksssh_sshtunnel_getclientrecordlength(void* lpObj, int clientid);
int ipworksssh_sshtunnel_setclientrecordlength(void* lpObj, int clientid, int iClientRecordLength);

int GetClientRecordLength(int iClientId);
int SetClientRecordLength(int iClientId, int iClientRecordLength);

Default Value

0

Remarks

If set to a positive value, this setting defines the length of the data records to be received. The class will accumulate data until RecordLength is reached and only then will fire the DataIn event with the data of length RecordLength. This allows data to be received as records of known length. This value can be changed at any time, including within the DataIn event.

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

Note: It is recommended to use the ChangeRecordLength method instead of setting this property.

The ClientId parameter specifies the index of the item in the array. The size of the array is controlled by the ClientCount property.

This property is not available at design time.

Data Type

Integer

ClientRemoteHost Property (SSHTunnel Class)

This property shows the IP address of the remote host through which the connection is coming.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetClientRemoteHost(int iClientId);

Unicode (Windows)
LPWSTR GetClientRemoteHost(INT iClientId);

char* ipworksssh_sshtunnel_getclientremotehost(void* lpObj, int clientid);

QString GetClientRemoteHost(int iClientId);

Default Value

""

Remarks

This property shows the IP address of the remote host through which the connection is coming.

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

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

The ClientId parameter specifies the index of the item in the array. The size of the array is controlled by the ClientCount property.

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

Data Type

String

ClientRemotePort Property (SSHTunnel Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetClientRemotePort(int iClientId);

Unicode (Windows)
INT GetClientRemotePort(INT iClientId);

int ipworksssh_sshtunnel_getclientremoteport(void* lpObj, int clientid);

int GetClientRemotePort(int iClientId);

Default Value

0

Remarks

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

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

The ClientId parameter specifies the index of the item in the array. The size of the array is controlled by the ClientCount property.

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

Data Type

Integer

ClientSingleLineMode Property (SSHTunnel Class)

This property shows the special mode for line-oriented protocols.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetClientSingleLineMode(int iClientId);
int SetClientSingleLineMode(int iClientId, int bClientSingleLineMode);

Unicode (Windows)
BOOL GetClientSingleLineMode(INT iClientId);
INT SetClientSingleLineMode(INT iClientId, BOOL bClientSingleLineMode);

int ipworksssh_sshtunnel_getclientsinglelinemode(void* lpObj, int clientid);
int ipworksssh_sshtunnel_setclientsinglelinemode(void* lpObj, int clientid, int bClientSingleLineMode);

bool GetClientSingleLineMode(int iClientId);
int SetClientSingleLineMode(int iClientId, bool bClientSingleLineMode);

Default Value

FALSE

Remarks

This property shows the special mode for line-oriented protocols. When SingleLineMode is True, the class treats the incoming data stream as lines separated by carriage return (CR), line feed (LF), or CRLF. The EOL property is ignored.

The ClientId parameter specifies the index of the item in the array. The size of the array is controlled by the ClientCount property.

This property is not available at design time.

Data Type

Boolean

ClientTimeout Property (SSHTunnel Class)

This property specifies a timeout for the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetClientTimeout(int iClientId);
int SetClientTimeout(int iClientId, int iClientTimeout);

Unicode (Windows)
INT GetClientTimeout(INT iClientId);
INT SetClientTimeout(INT iClientId, INT iClientTimeout);

int ipworksssh_sshtunnel_getclienttimeout(void* lpObj, int clientid);
int ipworksssh_sshtunnel_setclienttimeout(void* lpObj, int clientid, int iClientTimeout);

int GetClientTimeout(int iClientId);
int SetClientTimeout(int iClientId, int iClientTimeout);

Default Value

0

Remarks

This property specifies a timeout for the class.

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

If ClientTimeout 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 ClientTimeout 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 ClientTimeout property is 0 (asynchronous operation).

The ClientId parameter specifies the index of the item in the array. The size of the array is controlled by the ClientCount property.

This property is not available at design time.

Data Type

Integer

ClientUserData Property (SSHTunnel Class)

The UserData property holds connection-specific user-specified data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetClientUserData(int iClientId, char* &lpClientUserData, int &lenClientUserData);
int SetClientUserData(int iClientId, const char* lpClientUserData, int lenClientUserData);

Unicode (Windows)
INT GetClientUserData(INT iClientId, LPSTR &lpClientUserData, INT &lenClientUserData);
INT SetClientUserData(INT iClientId, LPCSTR lpClientUserData, INT lenClientUserData);

int ipworksssh_sshtunnel_getclientuserdata(void* lpObj, int clientid, char** lpClientUserData, int* lenClientUserData);
int ipworksssh_sshtunnel_setclientuserdata(void* lpObj, int clientid, const char* lpClientUserData, int lenClientUserData);

QByteArray GetClientUserData(int iClientId);
int SetClientUserData(int iClientId, QByteArray qbaClientUserData);

Default Value

""

Remarks

The ClientUserData property holds connection-specific user-specified data.

User-specified data may be set or retrieved at any point while the connection is valid. This provides a simple way to associate arbitrary data with a specific connection.

The ClientId parameter specifies the index of the item in the array. The size of the array is controlled by the ClientCount property.

This property is not available at design time.

Data Type

Binary String

DefaultEOL Property (SSHTunnel Class)

This property includes a default end-of-line (EOL) value to be used by incoming connections.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetDefaultEOL(char* &lpDefaultEOL, int &lenDefaultEOL);
int SetDefaultEOL(const char* lpDefaultEOL, int lenDefaultEOL);

Unicode (Windows)
INT GetDefaultEOL(LPSTR &lpDefaultEOL, INT &lenDefaultEOL);
INT SetDefaultEOL(LPCSTR lpDefaultEOL, INT lenDefaultEOL);

int ipworksssh_sshtunnel_getdefaulteol(void* lpObj, char** lpDefaultEOL, int* lenDefaultEOL);
int ipworksssh_sshtunnel_setdefaulteol(void* lpObj, const char* lpDefaultEOL, int lenDefaultEOL);

QByteArray GetDefaultEOL();
int SetDefaultEOL(QByteArray qbaDefaultEOL);

Default Value

""

Remarks

This property contains a default end-of-line (EOL) value to be used by incoming connections. Once the class accepts and establishes an inbound connection, it will set that connection's EOL to the value in this property. By default, this value is empty (""), meaning that data will be fired as it is received.

Data Type

Binary String

DefaultSingleLineMode Property (SSHTunnel Class)

This property tells the class whether or not to treat new connections as line oriented.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetDefaultSingleLineMode();
int SetDefaultSingleLineMode(int bDefaultSingleLineMode);

Unicode (Windows)
BOOL GetDefaultSingleLineMode();
INT SetDefaultSingleLineMode(BOOL bDefaultSingleLineMode);

int ipworksssh_sshtunnel_getdefaultsinglelinemode(void* lpObj);
int ipworksssh_sshtunnel_setdefaultsinglelinemode(void* lpObj, int bDefaultSingleLineMode);

bool GetDefaultSingleLineMode();
int SetDefaultSingleLineMode(bool bDefaultSingleLineMode);

Default Value

FALSE

Remarks

This property instructs the component whether or not to treat newly established connections as line-oriented protocols. If this value is True, newly accepted connections will read the incoming data stream as lines separated by a carriage return line feed (CRLF), carriage return (CR), or line feed (LF) and will ignore the end of lines (EOLs).

Data Type

Boolean

DefaultTimeout Property (SSHTunnel Class)

This property includes an initial timeout value to be used by incoming connections.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetDefaultTimeout();
int SetDefaultTimeout(int iDefaultTimeout);

Unicode (Windows)
INT GetDefaultTimeout();
INT SetDefaultTimeout(INT iDefaultTimeout);

int ipworksssh_sshtunnel_getdefaulttimeout(void* lpObj);
int ipworksssh_sshtunnel_setdefaulttimeout(void* lpObj, int iDefaultTimeout);

int GetDefaultTimeout();
int SetDefaultTimeout(int iDefaultTimeout);

Default Value

0

Remarks

This property is used by the class to set the operational timeout value of all inbound connections once they are established.

By default, the timeout is 0, meaning that all inbound connections will behave asynchronously.

Data Type

Integer

FirewallAutoDetect Property (SSHTunnel 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_sshtunnel_getfirewallautodetect(void* lpObj);
int ipworksssh_sshtunnel_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 (SSHTunnel 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_sshtunnel_getfirewalltype(void* lpObj);
int ipworksssh_sshtunnel_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 (SSHTunnel 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_sshtunnel_getfirewallhost(void* lpObj);
int ipworksssh_sshtunnel_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 (SSHTunnel 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_sshtunnel_getfirewallpassword(void* lpObj);
int ipworksssh_sshtunnel_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 (SSHTunnel 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_sshtunnel_getfirewallport(void* lpObj);
int ipworksssh_sshtunnel_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 (SSHTunnel 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_sshtunnel_getfirewalluser(void* lpObj);
int ipworksssh_sshtunnel_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

KeepAlive Property (SSHTunnel Class)

When True, KEEPALIVE packets are enabled (for long connections).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeepAlive();
int SetKeepAlive(int bKeepAlive);

Unicode (Windows)
BOOL GetKeepAlive();
INT SetKeepAlive(BOOL bKeepAlive);

int ipworksssh_sshtunnel_getkeepalive(void* lpObj);
int ipworksssh_sshtunnel_setkeepalive(void* lpObj, int bKeepAlive);

bool GetKeepAlive();
int SetKeepAlive(bool bKeepAlive);

Default Value

FALSE

Remarks

This property enables the SO_KEEPALIVE option on the incoming connections. This option prevents long connections from timing out in case of inactivity.

Note: System Transmission Control Protocol (TCP)/IP stack implementations are not required to support SO_KEEPALIVE.

This property is shared among incoming connections. When the property is set, the corresponding value is set for incoming connections as they are accepted. Existing connections are not modified.

Data Type

Boolean

Linger Property (SSHTunnel Class)

When set to True, connections are terminated gracefully.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetLinger();
int SetLinger(int bLinger);

Unicode (Windows)
BOOL GetLinger();
INT SetLinger(BOOL bLinger);

int ipworksssh_sshtunnel_getlinger(void* lpObj);
int ipworksssh_sshtunnel_setlinger(void* lpObj, int bLinger);

bool GetLinger();
int SetLinger(bool bLinger);

Default Value

TRUE

Remarks

This property controls how a connection is closed. The default is True. In this case, the connection is closed only after all the data are sent. Setting it to False forces an abrupt (hard) disconnection. Any data that were in the sending queue may be lost.

The default behavior (which is also the default mode for stream sockets) might result in an indefinite delay in closing the connection. Although the class returns control immediately, the system might indefinitely hold system resources until all pending data are sent (even after your application closes). This means that valuable system resources might be wasted.

Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you have sent (e.g., by a client acknowledgment), then setting this property to False might be the appropriate course of action.

This property is shared among incoming connections. When the property is set, the corresponding value is set for incoming connections as they are accepted. Existing connections are not modified.

Data Type

Boolean

Listening Property (SSHTunnel Class)

If set to True, the class accepts incoming connections on LocalPort.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetListening();
int SetListening(int bListening);

Unicode (Windows)
BOOL GetListening();
INT SetListening(BOOL bListening);

int ipworksssh_sshtunnel_getlistening(void* lpObj);
int ipworksssh_sshtunnel_setlistening(void* lpObj, int bListening);

bool GetListening();
int SetListening(bool bListening);

Default Value

FALSE

Remarks

This property indicates whether the class is listening for connections on the port specified by the LocalPort property.

Note: Use the StartListening and StopListening methods to control whether the class is listening.

This property is not available at design time.

Data Type

Boolean

LocalHost Property (SSHTunnel 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_sshtunnel_getlocalhost(void* lpObj);
int ipworksssh_sshtunnel_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 (SSHTunnel 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_sshtunnel_getlocalport(void* lpObj);
int ipworksssh_sshtunnel_setlocalport(void* lpObj, int iLocalPort);

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

Default Value

0

Remarks

This property must be set before the class can start listening. If its value is 0, then the TCP/IP subsystem picks a port number at random. The port number can be found by checking the value of this property after the class is listening (i.e., after successfully assigning True to the Listening property).

The service port is not shared among servers so two classs cannot be listening on the same port at the same time.

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 (SSHTunnel 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_sshtunnel_getsshacceptserverhostkeyencoded(void* lpObj, char** lpSSHAcceptServerHostKeyEncoded, int* lenSSHAcceptServerHostKeyEncoded);
int ipworksssh_sshtunnel_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 (SSHTunnel 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_sshtunnel_getsshauthmode(void* lpObj);
int ipworksssh_sshtunnel_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 (SSHTunnel 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_sshtunnel_getsshcertencoded(void* lpObj, char** lpSSHCertEncoded, int* lenSSHCertEncoded);
int ipworksssh_sshtunnel_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 (SSHTunnel 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_sshtunnel_getsshcertstore(void* lpObj, char** lpSSHCertStore, int* lenSSHCertStore);
int ipworksssh_sshtunnel_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 (SSHTunnel 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_sshtunnel_getsshcertstorepassword(void* lpObj);
int ipworksssh_sshtunnel_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 (SSHTunnel 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_sshtunnel_getsshcertstoretype(void* lpObj);
int ipworksssh_sshtunnel_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 (SSHTunnel 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_sshtunnel_getsshcertsubject(void* lpObj);
int ipworksssh_sshtunnel_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 (SSHTunnel 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_sshtunnel_getsshcompressionalgorithms(void* lpObj);
int ipworksssh_sshtunnel_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 (SSHTunnel 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_sshtunnel_getsshencryptionalgorithms(void* lpObj);
int ipworksssh_sshtunnel_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

SSHForwardHost Property (SSHTunnel Class)

The address of the remote host. Domain names are resolved to IP addresses.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSHForwardHost();
int SetSSHForwardHost(const char* lpszSSHForwardHost);

Unicode (Windows)
LPWSTR GetSSHForwardHost();
INT SetSSHForwardHost(LPCWSTR lpszSSHForwardHost);

char* ipworksssh_sshtunnel_getsshforwardhost(void* lpObj);
int ipworksssh_sshtunnel_setsshforwardhost(void* lpObj, const char* lpszSSHForwardHost);

QString GetSSHForwardHost();
int SetSSHForwardHost(QString qsSSHForwardHost);

Default Value

""

Remarks

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

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

Data Type

String

SSHForwardPort Property (SSHTunnel Class)

The TCP port in the remote host.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSHForwardPort();
int SetSSHForwardPort(int iSSHForwardPort);

Unicode (Windows)
INT GetSSHForwardPort();
INT SetSSHForwardPort(INT iSSHForwardPort);

int ipworksssh_sshtunnel_getsshforwardport(void* lpObj);
int ipworksssh_sshtunnel_setsshforwardport(void* lpObj, int iSSHForwardPort);

int GetSSHForwardPort();
int SetSSHForwardPort(int iSSHForwardPort);

Default Value

0

Remarks

The SSHForwardPort property specifies a service port on the remote host to connect to.

A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before a connection is attempted and cannot be changed once a connection is established. Any attempt to change this property while connected will fail with an error.

Data Type

Integer

SSHHost Property (SSHTunnel 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_sshtunnel_getsshhost(void* lpObj);
int ipworksssh_sshtunnel_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 (SSHTunnel 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_sshtunnel_getsshpassword(void* lpObj);
int ipworksssh_sshtunnel_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 (SSHTunnel 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_sshtunnel_getsshport(void* lpObj);
int ipworksssh_sshtunnel_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 (SSHTunnel 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_sshtunnel_getsshuser(void* lpObj);
int ipworksssh_sshtunnel_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

Config Method (SSHTunnel 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_sshtunnel_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.

Connect Method (SSHTunnel Class)

Connects to the SSH host without logging in.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Connect();

Unicode (Windows)
INT Connect();

int ipworksssh_sshtunnel_connect(void* lpObj);

int Connect();

Remarks

This method establishes a connection with the SSHHost but does not log in. In most cases it is recommended to use the StartListening method which will both establish a connection and log in to the server.

This method may be useful in cases where it is desirable to separate the connection and logon operations, for instance confirming a host is available by first creating the connection.

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

DecodePacket Method (SSHTunnel 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_sshtunnel_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.

Disconnect Method (SSHTunnel Class)

This method disconnects the specified client.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Disconnect(int iConnectionId);

Unicode (Windows)
INT Disconnect(INT iConnectionId);

int ipworksssh_sshtunnel_disconnect(void* lpObj, int iConnectionId);

int Disconnect(int iConnectionId);

Remarks

This method immediately disconnects from the server without first logging off.

In most cases the StopListening method should be used to logoff and disconnect from the server. Call the Disconnect method in cases where it is desirable to immediately disconnect without first logging off.

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

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

DoEvents Method (SSHTunnel Class)

Processes events from the internal message queue.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();

int ipworksssh_sshtunnel_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 (SSHTunnel 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_sshtunnel_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.

GetSSHParam Method (SSHTunnel 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_sshtunnel_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 (SSHTunnel 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_sshtunnel_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.

Reset Method (SSHTunnel Class)

Reset the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

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

SetSSHParam Method (SSHTunnel 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_sshtunnel_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.

Shutdown Method (SSHTunnel Class)

This method shuts down the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Shutdown();

Unicode (Windows)
INT Shutdown();

int ipworksssh_sshtunnel_shutdown(void* lpObj);

int Shutdown();

Remarks

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

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

StartListening Method (SSHTunnel Class)

This method starts listening for incoming connections.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int StartListening();

Unicode (Windows)
INT StartListening();

int ipworksssh_sshtunnel_startlistening(void* lpObj);

int StartListening();

Remarks

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

To stop listening for new connections, call StopListening. To stop listening for new connections and to disconnect all existing clients, call Shutdown.

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

StopListening Method (SSHTunnel Class)

This method stops listening for new connections.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int StopListening();

Unicode (Windows)
INT StopListening();

int ipworksssh_sshtunnel_stoplistening(void* lpObj);

int StopListening();

Remarks

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

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

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 (SSHTunnel Class)

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

Syntax

• C++
• C
• Qt

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

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


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

typedef struct {
  INT ConnectionId;
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} SSHTunnelConnectedEventParams;

#define EID_SSHTUNNEL_CONNECTED 1

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

class SSHTunnelConnectedEventParams {
public:
  int ConnectionId();

  int StatusCode();

  const QString &Description();

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

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

// Or, subclass SSHTunnel and override this emitter function.
virtual int FireConnected(SSHTunnelConnectedEventParams *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 system. Description contains a description of this code. The value of StatusCode is equal to the value of the system error.

Please refer to the Error Codes section for more information.

ConnectionRequest Event (SSHTunnel Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireConnectionRequest(SSHTunnelConnectionRequestEventParams *e);

typedef struct {
  const char *Address;
  int Port;
  int Accept;
  int reserved;
} SSHTunnelConnectionRequestEventParams;


Unicode (Windows)
virtual INT FireConnectionRequest(SSHTunnelConnectionRequestEventParams *e);

typedef struct {
  LPCWSTR Address;
  INT Port;
  BOOL Accept;
  INT reserved;
} SSHTunnelConnectionRequestEventParams;

#define EID_SSHTUNNEL_CONNECTIONREQUEST 2

virtual INT IPWORKSSSH_CALL FireConnectionRequest(LPSTR &lpszAddress, INT &iPort, BOOL &bAccept);

class SSHTunnelConnectionRequestEventParams {
public:
  const QString &Address();

  int Port();

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

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

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

// Or, subclass SSHTunnel and override this emitter function.
virtual int FireConnectionRequest(SSHTunnelConnectionRequestEventParams *e) {...}

Remarks

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

DataIn Event (SSHTunnel Class)

This event is fired when data come in.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireDataIn(SSHTunnelDataInEventParams *e);

typedef struct {
  int ConnectionId;
  const char *Text;
  int lenText;
  int EOL;
  int reserved;
} SSHTunnelDataInEventParams;


Unicode (Windows)
virtual INT FireDataIn(SSHTunnelDataInEventParams *e);

typedef struct {
  INT ConnectionId;
  LPCSTR Text;
  INT lenText;
  BOOL EOL;
  INT reserved;
} SSHTunnelDataInEventParams;

#define EID_SSHTUNNEL_DATAIN 3

virtual INT IPWORKSSSH_CALL FireDataIn(INT &iConnectionId, LPSTR &lpText, INT &lenText, BOOL &bEOL);

class SSHTunnelDataInEventParams {
public:
  int ConnectionId();

  const QByteArray &Text();

  bool EOL();

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

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

// Or, subclass SSHTunnel and override this emitter function.
virtual int FireDataIn(SSHTunnelDataInEventParams *e) {...}

Remarks

Trapping the DataIn event is your only chance to get the data coming from the other end of the connection specified by ConnectionId. The incoming data are provided through the Text parameter.

EOL indicates whether or not the EOL string was found at the end of Text. If the EOL string was found, then EOL is True.

If Text is part of the data portion of length larger than either DefaultMaxLineLength or with no EOL strings in it, then EOL is False. Please note that this means that one or more DataIn events with EOL set to False can be received during a connection.

If the EOL property is "" (empty string), then EOL can be disregarded (it is always True).

Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

Disconnected Event (SSHTunnel Class)

Fired when a connection is closed.

Syntax

• C++
• C
• Qt

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

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


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

typedef struct {
  INT ConnectionId;
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} SSHTunnelDisconnectedEventParams;

#define EID_SSHTUNNEL_DISCONNECTED 4

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

class SSHTunnelDisconnectedEventParams {
public:
  int ConnectionId();

  int StatusCode();

  const QString &Description();

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

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

// Or, subclass SSHTunnel and override this emitter function.
virtual int FireDisconnected(SSHTunnelDisconnectedEventParams *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 system. Description contains a description of this code. The value of StatusCode is equal to the value of the system error.

Please refer to the Error Codes section for more information.

Note: When the class is disconnected from the SSH server for any reason the ConnectionId parameter will be -1.

Error Event (SSHTunnel Class)

Information about errors during data delivery.

Syntax

• C++
• C
• Qt

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

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


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

typedef struct {
  INT ConnectionId;
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} SSHTunnelErrorEventParams;

#define EID_SSHTUNNEL_ERROR 5

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

class SSHTunnelErrorEventParams {
public:
  int ConnectionId();

  int ErrorCode();

  const QString &Description();

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

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

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

Remarks

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

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

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

Log Event (SSHTunnel Class)

Fires once for each log message.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SSHTUNNEL_LOG 6

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

class SSHTunnelLogEventParams {
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(SSHTunnelLogEventParams *e);

// Or, subclass SSHTunnel and override this emitter function.
virtual int FireLog(SSHTunnelLogEventParams *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 (SSHTunnel Class)

Fires when attempting to reconnect.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SSHTUNNEL_RECONNECTATTEMPT 7

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

class SSHTunnelReconnectAttemptEventParams {
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(SSHTunnelReconnectAttemptEventParams *e);

// Or, subclass SSHTunnel and override this emitter function.
virtual int FireReconnectAttempt(SSHTunnelReconnectAttemptEventParams *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.

SSHCustomAuth Event (SSHTunnel Class)

Fired when the class is doing custom authentication.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SSHTUNNEL_SSHCUSTOMAUTH 8

virtual INT IPWORKSSSH_CALL FireSSHCustomAuth(LPSTR &lpszPacket);

class SSHTunnelSSHCustomAuthEventParams {
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(SSHTunnelSSHCustomAuthEventParams *e);

// Or, subclass SSHTunnel and override this emitter function.
virtual int FireSSHCustomAuth(SSHTunnelSSHCustomAuthEventParams *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 (SSHTunnel Class)

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

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SSHTUNNEL_SSHKEYBOARDINTERACTIVE 9

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

class SSHTunnelSSHKeyboardInteractiveEventParams {
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(SSHTunnelSSHKeyboardInteractiveEventParams *e);

// Or, subclass SSHTunnel and override this emitter function.
virtual int FireSSHKeyboardInteractive(SSHTunnelSSHKeyboardInteractiveEventParams *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 (SSHTunnel Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSHServerAuthentication(SSHTunnelSSHServerAuthenticationEventParams *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;
} SSHTunnelSSHServerAuthenticationEventParams;


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

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

#define EID_SSHTUNNEL_SSHSERVERAUTHENTICATION 10

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

class SSHTunnelSSHServerAuthenticationEventParams {
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(SSHTunnelSSHServerAuthenticationEventParams *e);

// Or, subclass SSHTunnel and override this emitter function.
virtual int FireSSHServerAuthentication(SSHTunnelSSHServerAuthenticationEventParams *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 (SSHTunnel Class)

Shows the progress of the secure connection.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SSHTUNNEL_SSHSTATUS 11

virtual INT IPWORKSSSH_CALL FireSSHStatus(LPSTR &lpszMessage);

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

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

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

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

Remarks

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

Config Settings (SSHTunnel Class)

SSHTunnel 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

TCPServer Config Settings

Base Config Settings