SSHServer Class

Properties   Methods   Events   Config Settings   Errors  

The SSHServer class is used to create Secure Shell (SSH) servers. The class handles multiple simultaneous connections on the same TCP/IP port (service port). It is designed to balance the load between connections for a fast, powerful server.

Syntax

SSHServer

Remarks

The SSHServer class is the SSH-enabled equivalent of the IPWorks TCPServer class, extended by a set of new properties and events that deal with SSH security. The SSHCompressionAlgorithms and SSHEncryptionAlgorithms properties determine which protocols are enabled for the SSH handshake. The SSHCert* properties are used to select a certificate for the server (please note that a valid certificate MUST be selected before the server can function). The SSHUserAuthRequest event will allow you to use authenticate clients using digital certificates or passwords. Finally, the SSHStatus event provides information about the SSH handshake and underlying protocol notifications.

By default, each instance of SSHServer can handle up to 1000 simultaneous incoming connections (this number may be increased up to 100,000, or decreased to a lower value by using the MaxConnections configuration setting).

SSH connections are identified by a ConnectionId. Events relating to these connections as a whole will use the ConnectionId to identify the specific connection. Connections may also contained one or more multiplexed channels, which are identified by a ChannelId. Channel-level events will specify the ChannelId to which they relate.

SSHServer can start to listen on a port by setting the Listening property to True. When a remote host asks for a connection, the ConnectionRequest event is fired. At that point, the connection can either be accepted or rejected. If the connection is accepted, a ConnectionId is assigned, and communication can start. From this point on, the operation is very similar to SSHClient. Data can be sent to an individual SSHChannel using SendChannelData. The address and port of the incoming connection can be found by querying the ClientRemoteHost and ClientRemotePort properties.

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.

SSHChannelCount Property (SSHServer Class)

The number of records in the arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSHChannelCount();

Unicode (Windows)
INT GetSSHChannelCount();

int ipworksssh_sshserver_getsshchannelcount(void* lpObj);

int GetSSHChannelCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• BytesSent
• ChannelId
• DataToSend
• KeyboardInteractivePromptEcho
• KeyboardInteractivePromptPrompt
• ReadyToSend
• RecordLength
• Service
• SSHCertEncoded
• SSHCertStore
• SSHCertStorePassword
• SSHCertStoreType
• SSHCertSubject
• SSHConnectionConnected
• SSHConnectionLocalAddress
• SSHConnectionRemoteHost
• SSHConnectionRemotePort
• SSHConnectionTimeout

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

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

Data Type

Integer

BytesSent Property (SSHServer Class)

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

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT GetBytesSent(INT iSSHChannelId);

int ipworksssh_sshserver_getbytessent(void* lpObj, int sshchannelid);

int GetBytesSent(int iSSHChannelId);

Default Value

0

Remarks

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

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

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

Data Type

Integer

ChannelId Property (SSHServer Class)

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

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR GetChannelId(INT iSSHChannelId);

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

QString GetChannelId(int iSSHChannelId);

Default Value

""

Remarks

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

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

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

Data Type

String

DataToSend Property (SSHServer Class)

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

Syntax

• C++
• C
• Qt

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

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

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

int SetDataToSend(int iSSHChannelId, QByteArray qbaDataToSend);

Default Value

""

Remarks

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

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

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

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

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

Data Type

Binary String

ReadyToSend Property (SSHServer Class)

This property is True when data can be sent over the SSH Channel.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
BOOL GetReadyToSend(INT iSSHChannelId);

int ipworksssh_sshserver_getreadytosend(void* lpObj, int sshchannelid);

bool GetReadyToSend(int iSSHChannelId);

Default Value

FALSE

Remarks

This property is True when data can be sent over the SSH Channel.

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

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

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

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

Data Type

Boolean

RecordLength Property (SSHServer Class)

The length of received data records.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRecordLength(int iSSHChannelId);
int SetRecordLength(int iSSHChannelId, int iRecordLength);

Unicode (Windows)
INT GetRecordLength(INT iSSHChannelId);
INT SetRecordLength(INT iSSHChannelId, INT iRecordLength);

int ipworksssh_sshserver_getrecordlength(void* lpObj, int sshchannelid);
int ipworksssh_sshserver_setrecordlength(void* lpObj, int sshchannelid, int iRecordLength);

int GetRecordLength(int iSSHChannelId);
int SetRecordLength(int iSSHChannelId, int iRecordLength);

Default Value

0

Remarks

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

The default value is 0, meaning this setting is not used.

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

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

This property is not available at design time.

Data Type

Integer

Service Property (SSHServer Class)

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

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR GetService(INT iSSHChannelId);

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

QString GetService(int iSSHChannelId);

Default Value

""

Remarks

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

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

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

Data Type

String

ConnectionBacklog Property (SSHServer 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_sshserver_getconnectionbacklog(void* lpObj);
int ipworksssh_sshserver_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

SSHConnectionCount Property (SSHServer Class)

The number of records in the SSHConnection arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSHConnectionCount();

Unicode (Windows)
INT GetSSHConnectionCount();

int ipworksssh_sshserver_getsshconnectioncount(void* lpObj);

int GetSSHConnectionCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• SSHConnectionConnected
• SSHConnectionLocalAddress
• SSHConnectionRemoteHost
• SSHConnectionRemotePort
• SSHConnectionTimeout

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

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

Data Type

Integer

SSHConnectionConnected Property (SSHServer Class)

Used to disconnect individual connections and/or show their status.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSHConnectionConnected(int iConnectionId);
int SetSSHConnectionConnected(int iConnectionId, int bSSHConnectionConnected);

Unicode (Windows)
BOOL GetSSHConnectionConnected(INT iConnectionId);
INT SetSSHConnectionConnected(INT iConnectionId, BOOL bSSHConnectionConnected);

int ipworksssh_sshserver_getsshconnectionconnected(void* lpObj, int connectionid);
int ipworksssh_sshserver_setsshconnectionconnected(void* lpObj, int connectionid, int bSSHConnectionConnected);

bool GetSSHConnectionConnected(int iConnectionId);
int SetSSHConnectionConnected(int iConnectionId, bool bSSHConnectionConnected);

Default Value

FALSE

Remarks

Used to disconnect individual connections and/or show their status.

The Connected is used to close connections.

Connected 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 ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the SSHConnectionCount property.

This property is not available at design time.

Data Type

Boolean

SSHConnectionLocalAddress Property (SSHServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSHConnectionLocalAddress(int iConnectionId);

Unicode (Windows)
LPWSTR GetSSHConnectionLocalAddress(INT iConnectionId);

char* ipworksssh_sshserver_getsshconnectionlocaladdress(void* lpObj, int connectionid);

QString GetSSHConnectionLocalAddress(int iConnectionId);

Default Value

""

Remarks

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

LocalAddress is important for multihomed hosts where it can be used to find which particular network interface an individual connection is going through.

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the SSHConnectionCount property.

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

Data Type

String

SSHConnectionRemoteHost Property (SSHServer Class)

The RemoteHost shows the IP address of the remote host through which the connection is coming.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSHConnectionRemoteHost(int iConnectionId);

Unicode (Windows)
LPWSTR GetSSHConnectionRemoteHost(INT iConnectionId);

char* ipworksssh_sshserver_getsshconnectionremotehost(void* lpObj, int connectionid);

QString GetSSHConnectionRemoteHost(int iConnectionId);

Default Value

""

Remarks

The RemoteHost 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 ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the SSHConnectionCount property.

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

Data Type

String

SSHConnectionRemotePort Property (SSHServer Class)

The RemotePort shows the TCP port on the remote host through which the connection is coming.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT GetSSHConnectionRemotePort(INT iConnectionId);

int ipworksssh_sshserver_getsshconnectionremoteport(void* lpObj, int connectionid);

int GetSSHConnectionRemotePort(int iConnectionId);

Default Value

0

Remarks

The RemotePort shows the TCP port on the remote host through which the connection is coming.

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

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the SSHConnectionCount property.

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

Data Type

Integer

SSHConnectionTimeout Property (SSHServer Class)

A timeout for the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSHConnectionTimeout(int iConnectionId);
int SetSSHConnectionTimeout(int iConnectionId, int iSSHConnectionTimeout);

Unicode (Windows)
INT GetSSHConnectionTimeout(INT iConnectionId);
INT SetSSHConnectionTimeout(INT iConnectionId, INT iSSHConnectionTimeout);

int ipworksssh_sshserver_getsshconnectiontimeout(void* lpObj, int connectionid);
int ipworksssh_sshserver_setsshconnectiontimeout(void* lpObj, int connectionid, int iSSHConnectionTimeout);

int GetSSHConnectionTimeout(int iConnectionId);
int SetSSHConnectionTimeout(int iConnectionId, int iSSHConnectionTimeout);

Default Value

0

Remarks

A timeout for the class.

If the Timeout property is set to 0, all operations return immediately, potentially failing with an 'WOULDBLOCK' error if data can't be sent or received immediately.

If Timeout is set to a positive value, the class will automatically retry each operation that would otherwise result in a 'WOULDBLOCK' error for a maximum of Timeout seconds.

The class will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If Timeout expires, and the operation is not yet complete, the class fails with an error.

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

The default value for the Timeout property is 0 (asynchronous operation).

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the SSHConnectionCount property.

This property is not available at design time.

Data Type

Integer

DefaultAuthMethods Property (SSHServer Class)

Specifies the supported authentication methods.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDefaultAuthMethods();
int SetDefaultAuthMethods(const char* lpszDefaultAuthMethods);

Unicode (Windows)
LPWSTR GetDefaultAuthMethods();
INT SetDefaultAuthMethods(LPCWSTR lpszDefaultAuthMethods);

char* ipworksssh_sshserver_getdefaultauthmethods(void* lpObj);
int ipworksssh_sshserver_setdefaultauthmethods(void* lpObj, const char* lpszDefaultAuthMethods);

QString GetDefaultAuthMethods();
int SetDefaultAuthMethods(QString qsDefaultAuthMethods);

Default Value

"password,publickey"

Remarks

This property specifies the supported authentication methods. The client will choose one of the supported mechanisms when authenticating to the class.

This must be a comma separated list of values. For more information on authenticating clients see the SSHUserAuthRequest event.

The following is a list of methods implemented by the class:

Data Type

String

DefaultIdleTimeout Property (SSHServer Class)

This property includes the default idle timeout for inactive clients.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetDefaultIdleTimeout();
int SetDefaultIdleTimeout(int iDefaultIdleTimeout);

Unicode (Windows)
INT GetDefaultIdleTimeout();
INT SetDefaultIdleTimeout(INT iDefaultIdleTimeout);

int ipworksssh_sshserver_getdefaultidletimeout(void* lpObj);
int ipworksssh_sshserver_setdefaultidletimeout(void* lpObj, int iDefaultIdleTimeout);

int GetDefaultIdleTimeout();
int SetDefaultIdleTimeout(int iDefaultIdleTimeout);

Default Value

0

Remarks

This property specifies the idle timeout (in seconds) for clients. 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 or received data within DefaultIdleTimeout seconds.

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

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

Data Type

Integer

DefaultTimeout Property (SSHServer Class)

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_sshserver_getdefaulttimeout(void* lpObj);
int ipworksssh_sshserver_setdefaulttimeout(void* lpObj, int iDefaultTimeout);

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

Default Value

60

Remarks

This property is used by the class to set the operational timeout value of all inbound connections once they are established. If the timeout is set to 0, all inbound connections will behave asynchronously. The default value is 60, meaning the class will behave synchronously.

Data Type

Integer

KeyboardInteractiveMessage Property (SSHServer Class)

The instructions to send to the client during keyboard-interactive authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetKeyboardInteractiveMessage();
int SetKeyboardInteractiveMessage(const char* lpszKeyboardInteractiveMessage);

Unicode (Windows)
LPWSTR GetKeyboardInteractiveMessage();
INT SetKeyboardInteractiveMessage(LPCWSTR lpszKeyboardInteractiveMessage);

char* ipworksssh_sshserver_getkeyboardinteractivemessage(void* lpObj);
int ipworksssh_sshserver_setkeyboardinteractivemessage(void* lpObj, const char* lpszKeyboardInteractiveMessage);

QString GetKeyboardInteractiveMessage();
int SetKeyboardInteractiveMessage(QString qsKeyboardInteractiveMessage);

Default Value

""

Remarks

This property should be set to the main instructions to send to the client during keyboard-interactive authentication.

Data Type

String

KeyboardInteractivePromptCount Property (SSHServer Class)

The number of records in the KeyboardInteractivePrompt arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeyboardInteractivePromptCount();
int SetKeyboardInteractivePromptCount(int iKeyboardInteractivePromptCount);

Unicode (Windows)
INT GetKeyboardInteractivePromptCount();
INT SetKeyboardInteractivePromptCount(INT iKeyboardInteractivePromptCount);

int ipworksssh_sshserver_getkeyboardinteractivepromptcount(void* lpObj);
int ipworksssh_sshserver_setkeyboardinteractivepromptcount(void* lpObj, int iKeyboardInteractivePromptCount);

int GetKeyboardInteractivePromptCount();
int SetKeyboardInteractivePromptCount(int iKeyboardInteractivePromptCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• KeyboardInteractivePromptEcho
• KeyboardInteractivePromptPrompt

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

This property is not available at design time.

Data Type

Integer

KeyboardInteractivePromptEcho Property (SSHServer Class)

Specifies if the client should echo the value entered by the user or not.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeyboardInteractivePromptEcho(int iPromptIndex);
int SetKeyboardInteractivePromptEcho(int iPromptIndex, int bKeyboardInteractivePromptEcho);

Unicode (Windows)
BOOL GetKeyboardInteractivePromptEcho(INT iPromptIndex);
INT SetKeyboardInteractivePromptEcho(INT iPromptIndex, BOOL bKeyboardInteractivePromptEcho);

int ipworksssh_sshserver_getkeyboardinteractivepromptecho(void* lpObj, int promptindex);
int ipworksssh_sshserver_setkeyboardinteractivepromptecho(void* lpObj, int promptindex, int bKeyboardInteractivePromptEcho);

bool GetKeyboardInteractivePromptEcho(int iPromptIndex);
int SetKeyboardInteractivePromptEcho(int iPromptIndex, bool bKeyboardInteractivePromptEcho);

Default Value

FALSE

Remarks

Specifies if the client should echo the value entered by the user or not.

The PromptIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyboardInteractivePromptCount property.

This property is not available at design time.

Data Type

Boolean

KeyboardInteractivePromptPrompt Property (SSHServer Class)

The prompt label/text the client should present to the user.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetKeyboardInteractivePromptPrompt(int iPromptIndex);
int SetKeyboardInteractivePromptPrompt(int iPromptIndex, const char* lpszKeyboardInteractivePromptPrompt);

Unicode (Windows)
LPWSTR GetKeyboardInteractivePromptPrompt(INT iPromptIndex);
INT SetKeyboardInteractivePromptPrompt(INT iPromptIndex, LPCWSTR lpszKeyboardInteractivePromptPrompt);

char* ipworksssh_sshserver_getkeyboardinteractivepromptprompt(void* lpObj, int promptindex);
int ipworksssh_sshserver_setkeyboardinteractivepromptprompt(void* lpObj, int promptindex, const char* lpszKeyboardInteractivePromptPrompt);

QString GetKeyboardInteractivePromptPrompt(int iPromptIndex);
int SetKeyboardInteractivePromptPrompt(int iPromptIndex, QString qsKeyboardInteractivePromptPrompt);

Default Value

""

Remarks

The prompt label/text the client should present to the user.

The PromptIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyboardInteractivePromptCount property.

This property is not available at design time.

Data Type

String

Listening Property (SSHServer 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_sshserver_getlistening(void* lpObj);
int ipworksssh_sshserver_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 (SSHServer 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_sshserver_getlocalhost(void* lpObj);
int ipworksssh_sshserver_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 (SSHServer Class)

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

Syntax

• C++
• C
• Qt

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

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

int ipworksssh_sshserver_getlocalport(void* lpObj);
int ipworksssh_sshserver_setlocalport(void* lpObj, int iLocalPort);

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

Default Value

22

Remarks

The LocalPort property must be set before TCPServer starts 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 the LocalPort property after TCPServer is in listening mode (after successfully assigning True to the Listening property).

The service port is not shared among servers (i.e. there can be only one TCPServer 'listening' on a particular port at one time).

Data Type

Integer

SSHCertEncoded Property (SSHServer 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_sshserver_getsshcertencoded(void* lpObj, char** lpSSHCertEncoded, int* lenSSHCertEncoded);
int ipworksssh_sshserver_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 Store and Subject properties also may be used to specify a certificate.

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

This property is not available at design time.

Data Type

Binary String

SSHCertStore Property (SSHServer 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_sshserver_getsshcertstore(void* lpObj, char** lpSSHCertStore, int* lenSSHCertStore);
int ipworksssh_sshserver_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 StoreType property denotes the type of the certificate store specified by Store. If the store is password protected, specify the password in StorePassword.

Store is used in conjunction with the Subject property to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject 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 (SSHServer 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_sshserver_getsshcertstorepassword(void* lpObj);
int ipworksssh_sshserver_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 (SSHServer 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_sshserver_getsshcertstoretype(void* lpObj);
int ipworksssh_sshserver_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:

Data Type

Integer

SSHCertSubject Property (SSHServer 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_sshserver_getsshcertsubject(void* lpObj);
int ipworksssh_sshserver_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 (SSHServer 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_sshserver_getsshcompressionalgorithms(void* lpObj);
int ipworksssh_sshserver_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 (SSHServer 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_sshserver_getsshencryptionalgorithms(void* lpObj);
int ipworksssh_sshserver_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

ChangeRecordLength Method (SSHServer Class)

Changes the length of received data records.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ChangeRecordLength(int iChannelId, int iRecordLength);

Unicode (Windows)
INT ChangeRecordLength(INT iChannelId, INT iRecordLength);

int ipworksssh_sshserver_changerecordlength(void* lpObj, int iChannelId, int iRecordLength);

int ChangeRecordLength(int iChannelId, int iRecordLength);

Remarks

This method defines the length of data records to be received (in bytes) for the specified ChannelId.

If RecordLength is set to a positive value, the class will accumulate data until RecordLength bytes of data is received and only then fire the SSHChannelDataIn event with data of length RecordLength. This allows data to be received as records of known length. This method can be called at any time to change the record length, including within the DataIn event.

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

Error Handling (C++)

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

CloseChannel Method (SSHServer Class)

Closes a existing SSHChannel .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CloseChannel(int iChannelId);

Unicode (Windows)
INT CloseChannel(INT iChannelId);

int ipworksssh_sshserver_closechannel(void* lpObj, int iChannelId);

int CloseChannel(int iChannelId);

Remarks

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

Error Handling (C++)

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

Config Method (SSHServer 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_sshserver_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.

Disconnect Method (SSHServer 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_sshserver_disconnect(void* lpObj, int iConnectionId);

int Disconnect(int iConnectionId);

Remarks

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

Processes events from the internal message queue.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();

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

ExchangeKeys Method (SSHServer Class)

Causes the class to exchange a new set of session keys on the specified connection.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT ExchangeKeys(INT iConnectionId);

int ipworksssh_sshserver_exchangekeys(void* lpObj, int iConnectionId);

int ExchangeKeys(int iConnectionId);

Remarks

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

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

Error Handling (C++)

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

GetSSHParam Method (SSHServer 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_sshserver_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.

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 (SSHServer 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_sshserver_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.

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.

OpenChannel Method (SSHServer Class)

Opens a new SSHChannel .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* OpenChannel(int iConnectionId, const char* lpszChannelType);

Unicode (Windows)
LPWSTR OpenChannel(INT iConnectionId, LPCWSTR lpszChannelType);

char* ipworksssh_sshserver_openchannel(void* lpObj, int iConnectionId, const char* lpszChannelType);

QString OpenChannel(int iConnectionId, const QString& qsChannelType);

Remarks

The SSH 2.0 specification allows for multiple channels to be opened over a single TCP/IP connection. The Channels property represents the channels that are currently open. A new SSHChannel can be opened with OpenChannel.

ChannelType represents the type of SSH channel to be opened. The most common type of channel is "session".

If the call to OpenChannel succeeds, an SSHChannel will be created and added to the Channels collection.

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.

Reset Method (SSHServer Class)

Reset the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

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

SendBytes Method (SSHServer Class)

Sends binary data to the specified channel.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SendBytes(int iChannelId, const char* lpData, int lenData);

Unicode (Windows)
INT SendBytes(INT iChannelId, LPCSTR lpData, INT lenData);

int ipworksssh_sshserver_sendbytes(void* lpObj, int iChannelId, const char* lpData, int lenData);

int SendBytes(int iChannelId, QByteArray qbaData);

Remarks

This method sends binary data to the channel identified by ChannelId. To send text use the SendText method 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.)

SendChannelData Method (SSHServer Class)

Used to send data over an SSH channel.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT SendChannelData(INT iChannelId, LPCSTR lpData, INT lenData);

int ipworksssh_sshserver_sendchanneldata(void* lpObj, int iChannelId, const char* lpData, int lenData);

int SendChannelData(int iChannelId, QByteArray qbaData);

Remarks

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

Error Handling (C++)

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

SendSSHPacket Method (SSHServer Class)

Used to send an encoded SSH packet to the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SendSSHPacket(int iChannelId, int iPacketType, const char* lpPayload, int lenPayload);

Unicode (Windows)
INT SendSSHPacket(INT iChannelId, INT iPacketType, LPCSTR lpPayload, INT lenPayload);

int ipworksssh_sshserver_sendsshpacket(void* lpObj, int iChannelId, int iPacketType, const char* lpPayload, int lenPayload);

int SendSSHPacket(int iChannelId, int iPacketType, QByteArray qbaPayload);

Remarks

This method can be used to send a previously built SSH payload to the server. ChannelId identifies the channel that will receive the packet.

PacketType identifies what kind of packet is to be sent. Payload should contain the payload of the packet, which can be built by successive calls to SetSSHParam.

When SendSSHPacket is called, the class will finish building the packet, encrypt it for transport, and send it to the server.

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

SendText Method (SSHServer Class)

Sends text to the specified channel.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SendText(int iChannelId, const char* lpszText);

Unicode (Windows)
INT SendText(INT iChannelId, LPCWSTR lpszText);

int ipworksssh_sshserver_sendtext(void* lpObj, int iChannelId, const char* lpszText);

int SendText(int iChannelId, const QString& qsText);

Remarks

This method sends text to the client identified by ChannelId. To send binary data use the SendBytes method 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.)

SetSSHParam Method (SSHServer 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_sshserver_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.

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

This method shuts down the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Shutdown();

Unicode (Windows)
INT Shutdown();

int ipworksssh_sshserver_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 (SSHServer Class)

This method starts listening for incoming connections.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int StartListening();

Unicode (Windows)
INT StartListening();

int ipworksssh_sshserver_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 (SSHServer Class)

This method stops listening for new connections.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int StopListening();

Unicode (Windows)
INT StopListening();

int ipworksssh_sshserver_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 (SSHServer Class)

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

Syntax

• C++
• C
• Qt

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

typedef struct {
  int ConnectionId;
  int StatusCode;
  const char *Description;
  int CertStoreType;
  char *CertStore;
  char *CertPassword;
  char *CertSubject;
  int reserved;
} SSHServerConnectedEventParams;


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

typedef struct {
  INT ConnectionId;
  INT StatusCode;
  LPCWSTR Description;
  INT CertStoreType;
  LPWSTR CertStore;
  LPWSTR CertPassword;
  LPWSTR CertSubject;
  INT reserved;
} SSHServerConnectedEventParams;

#define EID_SSHSERVER_CONNECTED 1

virtual INT IPWORKSSSH_CALL FireConnected(INT &iConnectionId, INT &iStatusCode, LPSTR &lpszDescription, INT &iCertStoreType, LPSTR &lpszCertStore, LPSTR &lpszCertPassword, LPSTR &lpszCertSubject);

class SSHServerConnectedEventParams {
public:
  int ConnectionId();

  int StatusCode();

  const QString &Description();

  int CertStoreType();
  void SetCertStoreType(int iCertStoreType);

  const QString &CertStore();
  void SetCertStore(const QString &qsCertStore);

  const QString &CertPassword();
  void SetCertPassword(const QString &qsCertPassword);

  const QString &CertSubject();
  void SetCertSubject(const QString &qsCertSubject);

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

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

// Or, subclass SSHServer and override this emitter function.
virtual int FireConnected(SSHServerConnectedEventParams *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.

ConnectionId is the connection Id of the client requesting the connection.

CertStoreType is the store type of the alternate certificate to use for this connection. 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:

CertStore is the store name or location of the alternate certificate to use for this connection.

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

CertPassword is the password of the certificate store containing the alternate certificate to use for this connection.

CertSubject is the subject of the alternate certificate to use for this connection.

The special value * matches any subject and will select the first certificate in the 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.

ConnectionRequest Event (SSHServer 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(SSHServerConnectionRequestEventParams *e);

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


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

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

#define EID_SSHSERVER_CONNECTIONREQUEST 2

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

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

// Or, subclass SSHServer and override this emitter function.
virtual int FireConnectionRequest(SSHServerConnectionRequestEventParams *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.

Disconnected Event (SSHServer Class)

This event is fired when a connection is closed.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SSHSERVER_DISCONNECTED 3

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

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

// Or, subclass SSHServer and override this emitter function.
virtual int FireDisconnected(SSHServerDisconnectedEventParams *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.

Error Event (SSHServer Class)

Information about errors during data delivery.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SSHSERVER_ERROR 4

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

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

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

Fires once for each log message.

Syntax

• C++
• C
• Qt

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

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


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

typedef struct {
  INT ConnectionId;
  INT LogLevel;
  LPCWSTR Message;
  LPCWSTR LogType;
  INT reserved;
} SSHServerLogEventParams;

#define EID_SSHSERVER_LOG 5

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

class SSHServerLogEventParams {
public:
  int ConnectionId();

  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(SSHServerLogEventParams *e);

// Or, subclass SSHServer and override this emitter function.
virtual int FireLog(SSHServerLogEventParams *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.

ConnectionId specifies the connection to which the log message is applicable.

SSHChannelClosed Event (SSHServer Class)

Fired when a channel is closed.

Syntax

• C++
• C
• Qt

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

typedef struct {
  int ConnectionId;
  int ChannelId;
  int reserved;
} SSHServerSSHChannelClosedEventParams;


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

typedef struct {
  INT ConnectionId;
  INT ChannelId;
  INT reserved;
} SSHServerSSHChannelClosedEventParams;

#define EID_SSHSERVER_SSHCHANNELCLOSED 6

virtual INT IPWORKSSSH_CALL FireSSHChannelClosed(INT &iConnectionId, INT &iChannelId);

class SSHServerSSHChannelClosedEventParams {
public:
  int ConnectionId();

  int ChannelId();

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

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

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

Remarks

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

ConnectionId identifies the connection. ChannelId identifies the channel.

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

SSHChannelDataIn Event (SSHServer Class)

Fired when data is received on an SSH channel.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSHChannelDataIn(SSHServerSSHChannelDataInEventParams *e);

typedef struct {
  int ConnectionId;
  int ChannelId;
  const char *Data;
  int lenData;
  int reserved;
} SSHServerSSHChannelDataInEventParams;


Unicode (Windows)
virtual INT FireSSHChannelDataIn(SSHServerSSHChannelDataInEventParams *e);

typedef struct {
  INT ConnectionId;
  INT ChannelId;
  LPCSTR Data;
  INT lenData;
  INT reserved;
} SSHServerSSHChannelDataInEventParams;

#define EID_SSHSERVER_SSHCHANNELDATAIN 7

virtual INT IPWORKSSSH_CALL FireSSHChannelDataIn(INT &iConnectionId, INT &iChannelId, LPSTR &lpData, INT &lenData);

class SSHServerSSHChannelDataInEventParams {
public:
  int ConnectionId();

  int ChannelId();

  const QByteArray &Data();

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

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

// Or, subclass SSHServer and override this emitter function.
virtual int FireSSHChannelDataIn(SSHServerSSHChannelDataInEventParams *e) {...}

Remarks

Whenever a client sends data to an SSH channel, the SSHChannelDataIn event will fire. ChannelId will identify the channel receiving data. Data will contain the raw data being received.

ConnectionId identifies the connection. ChannelId identifies the channel.

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

SSHChannelEOF Event (SSHServer Class)

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

Syntax

• C++
• C
• Qt

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

typedef struct {
  int ConnectionId;
  int ChannelId;
  int reserved;
} SSHServerSSHChannelEOFEventParams;


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

typedef struct {
  INT ConnectionId;
  INT ChannelId;
  INT reserved;
} SSHServerSSHChannelEOFEventParams;

#define EID_SSHSERVER_SSHCHANNELEOF 8

virtual INT IPWORKSSSH_CALL FireSSHChannelEOF(INT &iConnectionId, INT &iChannelId);

class SSHServerSSHChannelEOFEventParams {
public:
  int ConnectionId();

  int ChannelId();

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

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

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

Remarks

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

ConnectionId identifies the connection. ChannelId identifies the channel.

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

SSHChannelOpened Event (SSHServer Class)

Fired when a channel is successfully opened.

Syntax

• C++
• C
• Qt

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

typedef struct {
  int ConnectionId;
  int ChannelId;
  int reserved;
} SSHServerSSHChannelOpenedEventParams;


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

typedef struct {
  INT ConnectionId;
  INT ChannelId;
  INT reserved;
} SSHServerSSHChannelOpenedEventParams;

#define EID_SSHSERVER_SSHCHANNELOPENED 9

virtual INT IPWORKSSSH_CALL FireSSHChannelOpened(INT &iConnectionId, INT &iChannelId);

class SSHServerSSHChannelOpenedEventParams {
public:
  int ConnectionId();

  int ChannelId();

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

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

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

Remarks

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

ConnectionId identifies the connection. ChannelId identifies the channel.

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

SSHChannelOpenRequest Event (SSHServer Class)

Fired when a client attempts to open a new channel.

Syntax

• C++
• C
• Qt

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

typedef struct {
  int ConnectionId;
  int ChannelId;
  const char *Service;
  const char *Parameters;
  int lenParameters;
  int Accept;
  int reserved;
} SSHServerSSHChannelOpenRequestEventParams;


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

typedef struct {
  INT ConnectionId;
  INT ChannelId;
  LPCWSTR Service;
  LPCSTR Parameters;
  INT lenParameters;
  BOOL Accept;
  INT reserved;
} SSHServerSSHChannelOpenRequestEventParams;

#define EID_SSHSERVER_SSHCHANNELOPENREQUEST 10

virtual INT IPWORKSSSH_CALL FireSSHChannelOpenRequest(INT &iConnectionId, INT &iChannelId, LPSTR &lpszService, LPSTR &lpParameters, INT &lenParameters, BOOL &bAccept);

class SSHServerSSHChannelOpenRequestEventParams {
public:
  int ConnectionId();

  int ChannelId();

  const QString &Service();

  const QByteArray &Parameters();

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

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

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

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

Remarks

This event is fired whenever a client attempts to open a new channel for a given connection. ChannelId will contain the id of the channel to be created. Service will identify the type of channel that is being requested (e.g.: "session"). Set Accept to true to accept the channel open request.

ConnectionId identifies the connection. ChannelId identifies the channel.

If the channel open request contains extra information, it will be contained in Parameters; you can extract data from it using GetSSHParam and GetSSHParamBytes. The most common example of a request with parameters would be a request with Service set to "direct-tcpip" (for SSH tunneling); in that case Parameters will contain the host to connect (string), the port to connect (int), the originator IP address (string) and the originator TCP port (int).

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

SSHChannelReadyToSend Event (SSHServer Class)

Fired when the class is ready to send data.

Syntax

• C++
• C
• Qt

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

typedef struct {
  int ConnectionId;
  int ChannelId;
  int reserved;
} SSHServerSSHChannelReadyToSendEventParams;


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

typedef struct {
  INT ConnectionId;
  INT ChannelId;
  INT reserved;
} SSHServerSSHChannelReadyToSendEventParams;

#define EID_SSHSERVER_SSHCHANNELREADYTOSEND 11

virtual INT IPWORKSSSH_CALL FireSSHChannelReadyToSend(INT &iConnectionId, INT &iChannelId);

class SSHServerSSHChannelReadyToSendEventParams {
public:
  int ConnectionId();

  int ChannelId();

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

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

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

Remarks

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

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

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

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

SSHChannelRequest Event (SSHServer Class)

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

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SSHSERVER_SSHCHANNELREQUEST 12

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

class SSHServerSSHChannelRequestEventParams {
public:
  int ConnectionId();

  int ChannelId();

  const QString &RequestType();

  const QByteArray &Packet();

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

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

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

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

Remarks

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

ConnectionId identifies the connection.

ChannelId identifies the channel receiving the request.

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

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

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

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

SSHChannelRequested Event (SSHServer Class)

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

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SSHSERVER_SSHCHANNELREQUESTED 13

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

class SSHServerSSHChannelRequestedEventParams {
public:
  int ConnectionId();

  int ChannelId();

  const QString &RequestType();

  const QByteArray &Packet();

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

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

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

Remarks

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

ConnectionId identifies the connection.

ChannelId identifies the channel receiving the request.

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

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

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

SSHServiceRequest Event (SSHServer Class)

Fired when a client requests a service to be started.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSHServiceRequest(SSHServerSSHServiceRequestEventParams *e);

typedef struct {
  int ConnectionId;
  const char *Service;
  int Accept;
  int reserved;
} SSHServerSSHServiceRequestEventParams;


Unicode (Windows)
virtual INT FireSSHServiceRequest(SSHServerSSHServiceRequestEventParams *e);

typedef struct {
  INT ConnectionId;
  LPCWSTR Service;
  BOOL Accept;
  INT reserved;
} SSHServerSSHServiceRequestEventParams;

#define EID_SSHSERVER_SSHSERVICEREQUEST 14

virtual INT IPWORKSSSH_CALL FireSSHServiceRequest(INT &iConnectionId, LPSTR &lpszService, BOOL &bAccept);

class SSHServerSSHServiceRequestEventParams {
public:
  int ConnectionId();

  const QString &Service();

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

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

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

// Or, subclass SSHServer and override this emitter function.
virtual int FireSSHServiceRequest(SSHServerSSHServiceRequestEventParams *e) {...}

Remarks

The SSHServiceRequest event is fired when a client requests that a service be started for a particular connection, identified by ConnectionId. Service will be the name of the service the client wishes to start. If the connection is authenticated and the user has access to the service, set Accept to true to allow the SSHServer to accept the request.

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

SSHStatus Event (SSHServer Class)

Shows the progress of the secure connection.

Syntax

• C++
• C
• Qt

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

typedef struct {
  int ConnectionId;
  const char *Message;
  int reserved;
} SSHServerSSHStatusEventParams;


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

typedef struct {
  INT ConnectionId;
  LPCWSTR Message;
  INT reserved;
} SSHServerSSHStatusEventParams;

#define EID_SSHSERVER_SSHSTATUS 15

virtual INT IPWORKSSSH_CALL FireSSHStatus(INT &iConnectionId, LPSTR &lpszMessage);

class SSHServerSSHStatusEventParams {
public:
  int ConnectionId();

  const QString &Message();

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

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

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

Remarks

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

SSHTunnelClosed Event (SSHServer Class)

This event will fire when a connected client attempts to close a tunnel.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSHTunnelClosed(SSHServerSSHTunnelClosedEventParams *e);

typedef struct {
  int ConnectionId;
  const char *Address;
  int Port;
  int reserved;
} SSHServerSSHTunnelClosedEventParams;


Unicode (Windows)
virtual INT FireSSHTunnelClosed(SSHServerSSHTunnelClosedEventParams *e);

typedef struct {
  INT ConnectionId;
  LPCWSTR Address;
  INT Port;
  INT reserved;
} SSHServerSSHTunnelClosedEventParams;

#define EID_SSHSERVER_SSHTUNNELCLOSED 16

virtual INT IPWORKSSSH_CALL FireSSHTunnelClosed(INT &iConnectionId, LPSTR &lpszAddress, INT &iPort);

class SSHServerSSHTunnelClosedEventParams {
public:
  int ConnectionId();

  const QString &Address();

  int Port();

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

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

// Or, subclass SSHServer and override this emitter function.
virtual int FireSSHTunnelClosed(SSHServerSSHTunnelClosedEventParams *e) {...}

Remarks

SSHTunnelRequested Event (SSHServer Class)

This event fires when a connected client attempts to establish a forward or reverse tunnel.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSHTunnelRequested(SSHServerSSHTunnelRequestedEventParams *e);

typedef struct {
  int ConnectionId;
  int Direction;
  const char *Address;
  int Port;
  int Accept;
  int reserved;
} SSHServerSSHTunnelRequestedEventParams;


Unicode (Windows)
virtual INT FireSSHTunnelRequested(SSHServerSSHTunnelRequestedEventParams *e);

typedef struct {
  INT ConnectionId;
  INT Direction;
  LPCWSTR Address;
  INT Port;
  BOOL Accept;
  INT reserved;
} SSHServerSSHTunnelRequestedEventParams;

#define EID_SSHSERVER_SSHTUNNELREQUESTED 17

virtual INT IPWORKSSSH_CALL FireSSHTunnelRequested(INT &iConnectionId, INT &iDirection, LPSTR &lpszAddress, INT &iPort, BOOL &bAccept);

class SSHServerSSHTunnelRequestedEventParams {
public:
  int ConnectionId();

  int Direction();

  const QString &Address();

  int Port();
  void SetPort(int iPort);

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

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

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

// Or, subclass SSHServer and override this emitter function.
virtual int FireSSHTunnelRequested(SSHServerSSHTunnelRequestedEventParams *e) {...}

Remarks

SSHUserAuthRequest Event (SSHServer Class)

Fires when a client attempts to authenticate a connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSHUserAuthRequest(SSHServerSSHUserAuthRequestEventParams *e);

typedef struct {
  int ConnectionId;
  const char *User;
  const char *Service;
  const char *AuthMethod;
  const char *AuthParam;
  int Accept;
  int PartialSuccess;
  char *AvailableMethods;
  const char *KeyAlgorithm;
  int reserved;
} SSHServerSSHUserAuthRequestEventParams;


Unicode (Windows)
virtual INT FireSSHUserAuthRequest(SSHServerSSHUserAuthRequestEventParams *e);

typedef struct {
  INT ConnectionId;
  LPCWSTR User;
  LPCWSTR Service;
  LPCWSTR AuthMethod;
  LPCWSTR AuthParam;
  BOOL Accept;
  BOOL PartialSuccess;
  LPWSTR AvailableMethods;
  LPCWSTR KeyAlgorithm;
  INT reserved;
} SSHServerSSHUserAuthRequestEventParams;

#define EID_SSHSERVER_SSHUSERAUTHREQUEST 18

virtual INT IPWORKSSSH_CALL FireSSHUserAuthRequest(INT &iConnectionId, LPSTR &lpszUser, LPSTR &lpszService, LPSTR &lpszAuthMethod, LPSTR &lpszAuthParam, BOOL &bAccept, BOOL &bPartialSuccess, LPSTR &lpszAvailableMethods, LPSTR &lpszKeyAlgorithm);

class SSHServerSSHUserAuthRequestEventParams {
public:
  int ConnectionId();

  const QString &User();

  const QString &Service();

  const QString &AuthMethod();

  const QString &AuthParam();

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

  bool PartialSuccess();
  void SetPartialSuccess(bool bPartialSuccess);

  const QString &AvailableMethods();
  void SetAvailableMethods(const QString &qsAvailableMethods);

  const QString &KeyAlgorithm();

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

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

// Or, subclass SSHServer and override this emitter function.
virtual int FireSSHUserAuthRequest(SSHServerSSHUserAuthRequestEventParams *e) {...}

Remarks

The SSHUserAuthRequest event fires when an SSH client attempts to authenticate itself on a particular connection. ConnectionId will identify the connection being authenticated. User will be the name of the account requesting authentication, and Service will contain the name of the service the client is wishing to access.

AuthMethod will denote which method the client is attempting to use to authenticate itself. AuthParam will contain the value of the authentication token used by the client. If the token is acceptable, you may set Accept to true to allow the class to authenticate the client. If it is not, set Accept to false.

Connecting clients will initially attempt authentication with an AuthMethod of "none". This is done with the expectation that the request will fail and the server will send a list of supported methods back to the client. In your implementation check the AuthMethod parameter, if it is "none" you should set AvailableMethods and reject the request. The client will select one of the available methods and re-authenticate.

You may set AvailableMethods to a comma-delimited string of authentication methods that are available for the user. This list will be sent back to the client so that it may perform further authentication attempts.

The following is a list of methods implemented by the class:

The PartialSuccess parameter is only used when multi-factor authentication is needed. To implement multi-factor authentication when this event fires first verify the AuthParam for the given AuthMethod. If accepted, set PartialSuccess to true and Accept to false. The client should then send the authentication request for a different form of authentication specified in AvailableMethods. You may continue to set PartialSuccess to true until all authentication requirements are satisfied. Once all requirements are satisfied set Accept to true.

KeyAlgorithm hold the signing algorithm used when the client attempts public key authentication. Possible values are:

• ssh-rsa
• rsa-sha2-256
• rsa-sha2-512
• ssh-dss
• ecdsa-sha2-nistp256
• ecdsa-sha2-nistp384
• ecdsa-sha2-nistp521
• x509v3-sign-rsa
• x509v3-sign-dss

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

Config Settings (SSHServer Class)

SSHServer Config Settings

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

TCPServer Config Settings

Base Config Settings

Trappable Errors (SSHServer Class)

Error Handling (C++)

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

SSHServer Errors

TCPServer Errors

TCP/IP Errors