SSHClient Class

Properties   Methods   Events   Config Settings   Errors  

The SSHClient class implements a fully functional, open-ended SSH client.

Syntax

SSHClient

Remarks

The SSHClient class can be used to perform any number of tasks secured by the Secure Shell (SSH) protocol. First set SSHHost, SSHUser and either SSHPassword or the SSHCert* properties , then call SSHLogon to establish a secure connection.

To open channels, use OpenChannel. To open a channel to tunnel data to a remote machine, call OpenTcpIpChannel. The Channels property contains a list of all of the channels open for the current instance of the class.

Once a "session" channel has been opened, you can call StartService to initialize a service on that channel. If you are using a "shell" service, you can call OpenTerminal to establish a pseudo-terminal for formatting the data output from the shell.

Data received from the server will be fired through SSHChannelData events. Any requests received can be processed through the SSHChannelRequest event.

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

The number of records in the arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSHChannelCount();

Unicode (Windows)
INT GetSSHChannelCount();

int ipworksssh_sshclient_getsshchannelcount(void* lpObj);

int GetSSHChannelCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• BytesSent
• ChannelId
• DataToSend
• FirewallAutoDetect
• FirewallHost
• FirewallPassword
• FirewallPort
• FirewallType
• FirewallUser
• ReadyToSend
• RecordLength
• Service
• SSHAcceptServerHostKeyEncoded
• SSHCertEncoded
• SSHCertStore
• SSHCertStorePassword
• SSHCertStoreType
• SSHCertSubject

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

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

Data Type

Integer

BytesSent Property (SSHClient 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_sshclient_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 (SSHClient 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_sshclient_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 (SSHClient 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_sshclient_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 (SSHClient 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_sshclient_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 (SSHClient 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_sshclient_getrecordlength(void* lpObj, int sshchannelid);
int ipworksssh_sshclient_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 (SSHClient 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_sshclient_getservice(void* lpObj, int sshchannelid);

QString GetService(int iSSHChannelId);

Default Value

""

Remarks

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

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

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

Data Type

String

Connected Property (SSHClient Class)

This shows whether the class is connected.

Syntax

• C++
• C
• Qt

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

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

int ipworksssh_sshclient_getconnected(void* lpObj);
int ipworksssh_sshclient_setconnected(void* lpObj, int bConnected);

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

Default Value

FALSE

Remarks

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

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

This property is not available at design time.

Data Type

Boolean

FirewallAutoDetect Property (SSHClient Class)

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

Syntax

• C++
• C
• Qt

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

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

int ipworksssh_sshclient_getfirewallautodetect(void* lpObj);
int ipworksssh_sshclient_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);

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

Default Value

FALSE

Remarks

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

Data Type

Boolean

FirewallType Property (SSHClient Class)

This property determines the type of firewall to connect through.

Syntax

• C++
• C
• Qt

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

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

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

int ipworksssh_sshclient_getfirewalltype(void* lpObj);
int ipworksssh_sshclient_setfirewalltype(void* lpObj, int iFirewallType);

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

Default Value

0

Remarks

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

Data Type

Integer

FirewallHost Property (SSHClient Class)

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

Syntax

• C++
• C
• Qt

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

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

char* ipworksssh_sshclient_getfirewallhost(void* lpObj);
int ipworksssh_sshclient_setfirewallhost(void* lpObj, const char* lpszFirewallHost);

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

Default Value

""

Remarks

This property contains the name or IP address of firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error.

Data Type

String

FirewallPassword Property (SSHClient Class)

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

Syntax

• C++
• C
• Qt

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

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

char* ipworksssh_sshclient_getfirewallpassword(void* lpObj);
int ipworksssh_sshclient_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);

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

Default Value

""

Remarks

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

Data Type

String

FirewallPort Property (SSHClient Class)

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

Syntax

• C++
• C
• Qt

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

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

int ipworksssh_sshclient_getfirewallport(void* lpObj);
int ipworksssh_sshclient_setfirewallport(void* lpObj, int iFirewallPort);

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

Default Value

0

Remarks

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

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

Data Type

Integer

FirewallUser Property (SSHClient Class)

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

Syntax

• C++
• C
• Qt

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

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

char* ipworksssh_sshclient_getfirewalluser(void* lpObj);
int ipworksssh_sshclient_setfirewalluser(void* lpObj, const char* lpszFirewallUser);

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

Default Value

""

Remarks

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

Data Type

String

LocalHost Property (SSHClient 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_sshclient_getlocalhost(void* lpObj);
int ipworksssh_sshclient_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 (SSHClient Class)

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

Syntax

• C++
• C
• Qt

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

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

int ipworksssh_sshclient_getlocalport(void* lpObj);
int ipworksssh_sshclient_setlocalport(void* lpObj, int iLocalPort);

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

Default Value

0

Remarks

This property must be set before a connection is attempted. It instructs the class to bind to a specific port (or communication endpoint) in the local machine.

Setting this property to 0 (default) enables the system to choose an open port at random. The chosen port will be returned by the LocalPort property after the connection is established.

LocalPort cannot be changed once a connection is made. Any attempt to set this property when a connection is active will generate an error.

This property is useful when trying to connect to services that require a trusted port in the client side.

Data Type

Integer

SSHAcceptServerHostKeyEncoded Property (SSHClient Class)

This is the certificate (PEM/Base64 encoded).

Syntax

• C++
• C
• Qt

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

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

int ipworksssh_sshclient_getsshacceptserverhostkeyencoded(void* lpObj, char** lpSSHAcceptServerHostKeyEncoded, int* lenSSHAcceptServerHostKeyEncoded);
int ipworksssh_sshclient_setsshacceptserverhostkeyencoded(void* lpObj, const char* lpSSHAcceptServerHostKeyEncoded, int lenSSHAcceptServerHostKeyEncoded);

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

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSHAuthMode Property (SSHClient Class)

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

Syntax

• C++
• C
• Qt

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

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

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

int ipworksssh_sshclient_getsshauthmode(void* lpObj);
int ipworksssh_sshclient_setsshauthmode(void* lpObj, int iSSHAuthMode);

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

Default Value

2

Remarks

The SSH Authentication specification (RFC 4252) specifies multiple methods by which a user can be authenticated by an SSH server. When a call is made to SSHLogon, the class will connect to the SSH server and establish the security layer. After the connection has been secured, the client will send an authentication request to the SSHHost containing the SSHUser. The server will respond containing a list of methods by which that user may be authenticated.

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

Example (User/Password Auth): Control.SSHAuthMode = SftpSSHAuthModes.amPassword Control.SSHUser = "username" Control.SSHPassword = "password" Control.SSHLogon("server", 22) Example (Public Key Auth): Control.SSHAuthMode = SftpSSHAuthModes.amPublicKey Control.SSHUser = "username" Control.SSHCertStoreType = SSHCertStoreTypes.cstPFXFile; Control.SSHCertStore = "cert.pfx"; Control.SSHCertStorePassword = "certpassword"; Control.SSHCertSubject = "*"; Control.SSHLogon("server", 22)

Data Type

Integer

SSHCertEncoded Property (SSHClient 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_sshclient_getsshcertencoded(void* lpObj, char** lpSSHCertEncoded, int* lenSSHCertEncoded);
int ipworksssh_sshclient_setsshcertencoded(void* lpObj, const char* lpSSHCertEncoded, int lenSSHCertEncoded);

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

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSHCertStore Property (SSHClient 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_sshclient_getsshcertstore(void* lpObj, char** lpSSHCertStore, int* lenSSHCertStore);
int ipworksssh_sshclient_setsshcertstore(void* lpObj, const char* lpSSHCertStore, int lenSSHCertStore);

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

Default Value

"MY"

Remarks

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

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

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

Designations of certificate stores are platform dependent.

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

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

Data Type

Binary String

SSHCertStorePassword Property (SSHClient 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_sshclient_getsshcertstorepassword(void* lpObj);
int ipworksssh_sshclient_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 (SSHClient 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_sshclient_getsshcertstoretype(void* lpObj);
int ipworksssh_sshclient_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 (SSHClient 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_sshclient_getsshcertsubject(void* lpObj);
int ipworksssh_sshclient_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 (SSHClient 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_sshclient_getsshcompressionalgorithms(void* lpObj);
int ipworksssh_sshclient_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 (SSHClient 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_sshclient_getsshencryptionalgorithms(void* lpObj);
int ipworksssh_sshclient_setsshencryptionalgorithms(void* lpObj, const char* lpszSSHEncryptionAlgorithms);

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

Default Value

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

Remarks

During the SSH handshake, this list will be used to negotiate the encryption algorithm to be used between the client and server. This list is used for both directions: client to server and server to client. When negotiating algorithms, each side sends a list of all algorithms it supports or allows. The algorithm chosen for each direction is the first algorithm to appear in the sender's list that the receiver supports, so it is important to list multiple algorithms in preferential order. If no algorithm can be agreed upon, the class will raise an error and the connection will be aborted.

At least one supported algorithm must appear in this list. The following encryption algorithms are supported by the class:

Data Type

String

SSHHost Property (SSHClient Class)

The address of the SSH host.

Syntax

• C++
• C
• Qt

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

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

char* ipworksssh_sshclient_getsshhost(void* lpObj);
int ipworksssh_sshclient_setsshhost(void* lpObj, const char* lpszSSHHost);

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

Default Value

""

Remarks

The SSHHost property specifies the IP address (IP number in dotted internet format) or Domain Name of the remote host. It is set before a connection is attempted and cannot be changed once a connection is established.

If the SSHHost property is set to a Domain Name, a DNS request is initiated, and upon successful termination of the request, the SSHHost property is set to the corresponding address. If the search is not successful, an error is returned.

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

Data Type

String

SSHKeyExchangeAlgorithms Property (SSHClient Class)

A comma-separated list containing all allowable key exchange algorithms.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSHKeyExchangeAlgorithms();
int SetSSHKeyExchangeAlgorithms(const char* lpszSSHKeyExchangeAlgorithms);

Unicode (Windows)
LPWSTR GetSSHKeyExchangeAlgorithms();
INT SetSSHKeyExchangeAlgorithms(LPCWSTR lpszSSHKeyExchangeAlgorithms);

char* ipworksssh_sshclient_getsshkeyexchangealgorithms(void* lpObj);
int ipworksssh_sshclient_setsshkeyexchangealgorithms(void* lpObj, const char* lpszSSHKeyExchangeAlgorithms);

QString GetSSHKeyExchangeAlgorithms();
int SetSSHKeyExchangeAlgorithms(QString qsSSHKeyExchangeAlgorithms);

Default Value

"curve25519-sha256,curve25519-sha256@libssh.org,diffie-hellman-group-exchange-sha256,diffie-hellman-group14-sha256,diffie-hellman-group16-sha512,diffie-hellman-group18-sha512,ecdh-sha2-nistp256,ecdh-sha2-nistp384,ecdh-sha2-nistp521,diffie-hellman-group-exchange-sha1,diffie-hellman-group14-sha1,diffie-hellman-group1-sha1,gss-group14-sha256-toWM5Slw5Ew8Mqkay+al2g==,gss-group16-sha512-toWM5Slw5Ew8Mqkay+al2g==,gss-nistp256-sha256-toWM5Slw5Ew8Mqkay+al2g==,gss-curve25519-sha256-toWM5Slw5Ew8Mqkay+al2g==,gss-group14-sha1-toWM5Slw5Ew8Mqkay+al2g==,gss-gex-sha1-toWM5Slw5Ew8Mqkay+al2g=="

Remarks

SSH allows different algorithms to be negotiated for use when establishing the security layer of the connection. This property controls the key-exchange algorithm list supplied by the class to the SSHHost. It is a comma-separated list containing the names of key-exchange algorithms as defined by section 6.5 of the SSH Transport Layer specification (RFC 4253). The key-exchange algorithms specified in RFCs 4419 and 8732 are also supported.

The value of this property must be a comma-separated list containing one or more of the following values:

• curve25519-sha256
• curve25519-sha256@libssh.org
• diffie-hellman-group1-sha1
• diffie-hellman-group14-sha1
• diffie-hellman-group14-sha256
• diffie-hellman-group16-sha512
• diffie-hellman-group18-sha512
• diffie-hellman-group-exchange-sha256
• diffie-hellman-group-exchange-sha1
• ecdh-sha2-nistp256
• ecdh-sha2-nistp384
• ecdh-sha2-nistp521
• gss-group14-sha256-toWM5Slw5Ew8Mqkay+al2g==
• gss-group16-sha512-toWM5Slw5Ew8Mqkay+al2g==
• gss-nistp256-sha256-toWM5Slw5Ew8Mqkay+al2g==
• gss-curve25519-sha256-toWM5Slw5Ew8Mqkay+al2g==
• gss-group14-sha1-toWM5Slw5Ew8Mqkay+al2g==
• gss-gex-sha1-toWM5Slw5Ew8Mqkay+al2g==

Data Type

String

SSHMacAlgorithms Property (SSHClient Class)

A comma-separated list containing all allowable message authentication algorithms.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSHMacAlgorithms();
int SetSSHMacAlgorithms(const char* lpszSSHMacAlgorithms);

Unicode (Windows)
LPWSTR GetSSHMacAlgorithms();
INT SetSSHMacAlgorithms(LPCWSTR lpszSSHMacAlgorithms);

char* ipworksssh_sshclient_getsshmacalgorithms(void* lpObj);
int ipworksssh_sshclient_setsshmacalgorithms(void* lpObj, const char* lpszSSHMacAlgorithms);

QString GetSSHMacAlgorithms();
int SetSSHMacAlgorithms(QString qsSSHMacAlgorithms);

Default Value

"hmac-sha2-256,hmac-sha2-512,hmac-sha1,hmac-md5,hmac-ripemd160,hmac-sha1-96,hmac-md5-96,hmac-sha2-256-96,hmac-sha2-512-96,hmac-ripemd160-96,hmac-sha2-256-etm@openssh.com,hmac-sha2-512-etm@openssh.com,umac-64@openssh.com,umac-64-etm@openssh.com,umac-128@openssh.com,umac-128-etm@openssh.com"

Remarks

SSH allows different algorithms to be negotiated for use when establishing the security layer of the connection. SSHMacAlgorithms controls the message authentication code (MAC) algorithm list supplied by the class to the SSHHost. It is a comma-separated list containing the names of MAC algorithms as defined by section 6.4 of the SSH Transport Layer specification (RFC 4253).

The value of this property must be a comma-separated list containing one or more of the following values:

• hmac-sha1
• hmac-md5
• hmac-sha1-96
• hmac-md5-96
• hmac-sha2-256
• hmac-sha2-256-96
• hmac-sha2-512
• hmac-sha2-512-96
• hmac-ripemd160
• hmac-ripemd160-96
• hmac-sha2-256-etm@openssh.com
• hmac-sha2-512-etm@openssh.com
• umac-64@openssh.com
• umac-64-etm@openssh.com
• umac-128@openssh.com
• umac-128-etm@openssh.com

Data Type

String

SSHPassword Property (SSHClient Class)

The password for SSH password-based authentication.

Syntax

• C++
• C
• Qt

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

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

char* ipworksssh_sshclient_getsshpassword(void* lpObj);
int ipworksssh_sshclient_setsshpassword(void* lpObj, const char* lpszSSHPassword);

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

Default Value

""

Remarks

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

Data Type

String

SSHPort Property (SSHClient Class)

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

Syntax

• C++
• C
• Qt

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

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

int ipworksssh_sshclient_getsshport(void* lpObj);
int ipworksssh_sshclient_setsshport(void* lpObj, int iSSHPort);

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

Default Value

22

Remarks

The SSHPort specifies a service port on the SSH host to connect to.

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

Data Type

Integer

SSHPublicKeyAlgorithms Property (SSHClient Class)

A comma-separated list containing all allowable public key algorithms for the SSH server's public key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSHPublicKeyAlgorithms();
int SetSSHPublicKeyAlgorithms(const char* lpszSSHPublicKeyAlgorithms);

Unicode (Windows)
LPWSTR GetSSHPublicKeyAlgorithms();
INT SetSSHPublicKeyAlgorithms(LPCWSTR lpszSSHPublicKeyAlgorithms);

char* ipworksssh_sshclient_getsshpublickeyalgorithms(void* lpObj);
int ipworksssh_sshclient_setsshpublickeyalgorithms(void* lpObj, const char* lpszSSHPublicKeyAlgorithms);

QString GetSSHPublicKeyAlgorithms();
int SetSSHPublicKeyAlgorithms(QString qsSSHPublicKeyAlgorithms);

Default Value

"ssh-ed25519,ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521,rsa-sha2-256,rsa-sha2-512,ssh-rsa,ssh-ed448,ssh-dss,x509v3-sign-rsa,x509v3-sign-dss"

Remarks

SSH allows different algorithms to be negotiated for use when establishing the security layer of the connection. SSHPublicKeyAlgorithms controls the public key algorithm list supplied by the class to the SSHHost. It is a comma-separated list containing the names of public key algorithms as defined by section 6.6 of the SSH Transport Layer specification (RFC 4253).

The value of this property must be a comma-separated list containing one or more of the following values:

Note: the algorithms listed by this property control only the allowed public key algorithms for the SSH server's public key. This is used when authenticating the SSH server's public key. In most SSH server implementations, this list has no bearing on the public key algorithms that can be used by the client when authenticating to the SSH server using public key authentication.

Data Type

String

SSHUser Property (SSHClient Class)

The username for SSH authentication.

Syntax

• C++
• C
• Qt

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

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

char* ipworksssh_sshclient_getsshuser(void* lpObj);
int ipworksssh_sshclient_setsshuser(void* lpObj, const char* lpszSSHUser);

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

Default Value

""

Remarks

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

Example (User/Password Auth): Control.SSHAuthMode = SftpSSHAuthModes.amPassword Control.SSHUser = "username" Control.SSHPassword = "password" Control.SSHLogon("server", 22) Example (Public Key Auth): Control.SSHAuthMode = SftpSSHAuthModes.amPublicKey Control.SSHUser = "username" Control.SSHCertStoreType = SSHCertStoreTypes.cstPFXFile; Control.SSHCertStore = "cert.pfx"; Control.SSHCertStorePassword = "certpassword"; Control.SSHCertSubject = "*"; Control.SSHLogon("server", 22)

Data Type

String

Timeout Property (SSHClient Class)

A timeout for the class.

Syntax

• C++
• C
• Qt

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

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

int ipworksssh_sshclient_gettimeout(void* lpObj);
int ipworksssh_sshclient_settimeout(void* lpObj, int iTimeout);

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

Default Value

60

Remarks

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

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

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

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

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

The default value for the Timeout property is 60 seconds.

Data Type

Integer

ChangeRecordLength Method (SSHClient Class)

Changes the length of received data records.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ChangeRecordLength(const char* lpszChannelId, int iRecordLength);

Unicode (Windows)
INT ChangeRecordLength(LPCWSTR lpszChannelId, INT iRecordLength);

int ipworksssh_sshclient_changerecordlength(void* lpObj, const char* lpszChannelId, int iRecordLength);

int ChangeRecordLength(const QString& qsChannelId, 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 (SSHClient Class)

Closes a existing SSHChannel .

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT CloseChannel(LPCWSTR lpszChannelId);

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

int CloseChannel(const QString& qsChannelId);

Remarks

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

Error Handling (C++)

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

Config Method (SSHClient 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_sshclient_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

Remarks

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

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

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

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

Error Handling (C++)

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

Connect Method (SSHClient Class)

Connects to the SSH host without logging in.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Connect();

Unicode (Windows)
INT Connect();

int ipworksssh_sshclient_connect(void* lpObj);

int Connect();

Remarks

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

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

Error Handling (C++)

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

DecodePacket Method (SSHClient Class)

Decodes a hex-encoded SSH packet.

Syntax

• C++
• C
• Qt

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

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

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

QByteArray DecodePacket(const QString& qsEncodedPacket);

Remarks

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

Error Handling (C++)

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

Disconnect Method (SSHClient Class)

This method disconnects from the server without first logging off.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Disconnect();

Unicode (Windows)
INT Disconnect();

int ipworksssh_sshclient_disconnect(void* lpObj);

int Disconnect();

Remarks

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

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

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

Processes events from the internal message queue.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();

int ipworksssh_sshclient_doevents(void* lpObj);

int DoEvents();

Remarks

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

Error Handling (C++)

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

EncodePacket Method (SSHClient Class)

Hex encodes an SSH packet.

Syntax

• C++
• C
• Qt

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

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

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

QString EncodePacket(QByteArray qbaPacket);

Remarks

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

Error Handling (C++)

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

ExchangeKeys Method (SSHClient Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ExchangeKeys();

Unicode (Windows)
INT ExchangeKeys();

int ipworksssh_sshclient_exchangekeys(void* lpObj);

int ExchangeKeys();

Remarks

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

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

Error Handling (C++)

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

GetSSHParam Method (SSHClient 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_sshclient_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 (SSHClient 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_sshclient_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 (SSHClient Class)

Opens a new SSHChannel .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* OpenChannel(const char* lpszChannelType);

Unicode (Windows)
LPWSTR OpenChannel(LPCWSTR lpszChannelType);

char* ipworksssh_sshclient_openchannel(void* lpObj, const char* lpszChannelType);

QString OpenChannel(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". To open a channel of type "direct-tcpip", use OpenTcpIpChannel.

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.

OpenTcpIpChannel Method (SSHClient Class)

Opens a special TCP/IP tunneling SSHChannel .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* OpenTcpIpChannel(const char* lpszDestHost, int iDestPort, const char* lpszSrcHost, int iSrcPort);

Unicode (Windows)
LPWSTR OpenTcpIpChannel(LPCWSTR lpszDestHost, INT iDestPort, LPCWSTR lpszSrcHost, INT iSrcPort);

char* ipworksssh_sshclient_opentcpipchannel(void* lpObj, const char* lpszDestHost, int iDestPort, const char* lpszSrcHost, int iSrcPort);

QString OpenTcpIpChannel(const QString& qsDestHost, int iDestPort, const QString& qsSrcHost, int iSrcPort);

Remarks

OpenTcpIpChannel opens a special SSHChannel of type "direct-tcpip". Unlike channels opened by OpenChannel, "direct-tcpip" channels are secured data tunnels that forward data through the SSHHost to another destination.

DestHost and DestPort represent, respectively, the host name or IP address and the port for which the data of this channel is bound. When OpenTcpIpChannel is called, the SSHHost will attempt to connect to the machine identified by these parameters.

Likewise, SrcHost and SrcPort identify the originator of the data. These may be different from LocalHost and LocalPort if the current instance of the class is being used to forward data from another TCP/IP client.

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.

OpenTerminal Method (SSHClient Class)

Creates a pseudo-terminal to be used to help display data for a channel.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int OpenTerminal(const char* lpszChannelId, const char* lpszTerminalType, int iWidth, int iHeight, int bUsePixels, const char* lpszModes);

Unicode (Windows)
INT OpenTerminal(LPCWSTR lpszChannelId, LPCWSTR lpszTerminalType, INT iWidth, INT iHeight, BOOL bUsePixels, LPCWSTR lpszModes);

int ipworksssh_sshclient_openterminal(void* lpObj, const char* lpszChannelId, const char* lpszTerminalType, int iWidth, int iHeight, int bUsePixels, const char* lpszModes);

int OpenTerminal(const QString& qsChannelId, const QString& qsTerminalType, int iWidth, int iHeight, bool bUsePixels, const QString& qsModes);

Remarks

OpenTerminal is used to establish a pseudo-terminal that will encode data sent over a "session" channel. ChannelId identifies the channel that will receive the terminal. TerminalType identifies the terminal protocol. Currently, only "vt100" is recognized by the SSH protocol specification, but other terminal types may be implemented by SSH server vendors.

Width and Height represent the size of the terminal display. If UsePixels is true, they represent the size in pixels, otherwise they represent the size in terms of fixed-width characters.

Modes is a list of encoded terminal modes. This value must be hex encoded. For instance "350000000000" is the hex encoded representation of the byte sequence 0x53, 0x00, 0x00, 0x00, 0x00, 0x00 (the terminal modes string to disable echo). The encoding of these modes is defined in Section 8 of the SSH Connection Specification (RFC 4254). The modes are encoded to a string as opcode-argument pairs. The opcode is always a single byte. For opcodes 1-159, the argument is a 32-bit integer. Opcodes 160-255 are currently undefined. Opcode '0' terminates the string. Note: a string containing a single NULL byte (ie the character literal '\0') represents an empty mode list.

The following opcodes are defined:

Error Handling (C++)

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

Reset Method (SSHClient Class)

Reset the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int ipworksssh_sshclient_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 (SSHClient Class)

Sends binary data to the specified channel.

Syntax

• C++
• C
• Qt

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

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

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

int SendBytes(const QString& qsChannelId, 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 (SSHClient Class)

Used to send data over an SSH channel.

Syntax

• C++
• C
• Qt

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

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

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

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

Remarks

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

Error Handling (C++)

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

SendSSHPacket Method (SSHClient Class)

Used to send an encoded SSH packet to the server.

Syntax

• C++
• C
• Qt

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

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

int ipworksssh_sshclient_sendsshpacket(void* lpObj, const char* lpszChannelId, int iPacketType, const char* lpPayload, int lenPayload);

int SendSSHPacket(const QString& qsChannelId, 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 (SSHClient Class)

Sends text to the specified channel.

Syntax

• C++
• C
• Qt

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

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

int ipworksssh_sshclient_sendtext(void* lpObj, const char* lpszChannelId, const char* lpszText);

int SendText(const QString& qsChannelId, 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 (SSHClient 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_sshclient_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.

SSHLogoff Method (SSHClient Class)

Logoff from the SSH server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SSHLogoff();

Unicode (Windows)
INT SSHLogoff();

int ipworksssh_sshclient_sshlogoff(void* lpObj);

int SSHLogoff();

Remarks

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

Error Handling (C++)

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

SSHLogon Method (SSHClient Class)

Logon to the SSHHost using the current SSHUser and SSHPassword .

Syntax

• C++
• C
• Qt

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

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

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

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

Remarks

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

Example (Logging On)

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

Error Handling (C++)

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

StartService Method (SSHClient Class)

Requests the given service on a target channel.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int StartService(const char* lpszChannelId, const char* lpszService, const char* lpszParameter);

Unicode (Windows)
INT StartService(LPCWSTR lpszChannelId, LPCWSTR lpszService, LPCWSTR lpszParameter);

int ipworksssh_sshclient_startservice(void* lpObj, const char* lpszChannelId, const char* lpszService, const char* lpszParameter);

int StartService(const QString& qsChannelId, const QString& qsService, const QString& qsParameter);

Remarks

After a "session" channel has been opened by a call to OpenChannel, a service may be requested for that channel. ChannelId identifies the channel on which the service is to be started.

Service identifies the service being requested. The following list defines some known services:

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

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

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SSHCLIENT_CONNECTED 1

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

class SSHClientConnectedEventParams {
public:
  int StatusCode();

  const QString &Description();

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

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

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

Remarks

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

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

Please refer to the Error Codes section for more information.

ConnectionStatus Event (SSHClient Class)

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

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SSHCLIENT_CONNECTIONSTATUS 2

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

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

  int StatusCode();

  const QString &Description();

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

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

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

Remarks

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

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

Disconnected Event (SSHClient Class)

This event is fired when a connection is closed.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SSHCLIENT_DISCONNECTED 3

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

class SSHClientDisconnectedEventParams {
public:
  int StatusCode();

  const QString &Description();

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

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

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

Remarks

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

If the connection is broken for any other reason, StatusCode has the error code returned by the Transmission Control Protocol (TCP/IP) subsystem. Description contains a description of this code. The value of StatusCode is equal to the value of the TCP/IP error.

Please refer to the Error Codes section for more information.

Error Event (SSHClient Class)

Fired when information is available about errors during data delivery.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SSHCLIENT_ERROR 4

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

class SSHClientErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

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

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

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

Remarks

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

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

Log Event (SSHClient Class)

Fires once for each log message.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SSHCLIENT_LOG 5

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

class SSHClientLogEventParams {
public:
  int LogLevel();

  const QString &Message();

  const QString &LogType();

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

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

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

SSHChannelClosed Event (SSHClient Class)

Fired when a channel is closed.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SSHCLIENT_SSHCHANNELCLOSED 6

virtual INT IPWORKSSSH_CALL FireSSHChannelClosed(LPSTR &lpszChannelId);

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

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

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

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

Remarks

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

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

SSHChannelData Event (SSHClient Class)

Fired when the SSHHost sends channel data to the client.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SSHCLIENT_SSHCHANNELDATA 7

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

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

  const QByteArray &ChannelData();

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

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

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

Remarks

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

SSHChannelEOF Event (SSHClient 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(SSHClientSSHChannelEOFEventParams *e);

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


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

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

#define EID_SSHCLIENT_SSHCHANNELEOF 8

virtual INT IPWORKSSSH_CALL FireSSHChannelEOF(LPSTR &lpszChannelId);

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

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

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

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

Remarks

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

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

SSHChannelOpened Event (SSHClient Class)

Fired when a channel is successfully opened.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SSHCLIENT_SSHCHANNELOPENED 9

virtual INT IPWORKSSSH_CALL FireSSHChannelOpened(LPSTR &lpszChannelId);

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

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

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

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

Remarks

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

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

SSHChannelOpenRequest Event (SSHClient Class)

Fired when a host attempts to open a new channel.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SSHCLIENT_SSHCHANNELOPENREQUEST 10

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

class SSHClientSSHChannelOpenRequestEventParams {
public:
  const QString &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(SSHClientSSHChannelOpenRequestEventParams *e);

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

Remarks

This event is fired whenever a host attempts to open a new channel. 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.

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

SSHChannelReadyToSend Event (SSHClient Class)

Fired when the class is ready to send data.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SSHCLIENT_SSHCHANNELREADYTOSEND 11

virtual INT IPWORKSSSH_CALL FireSSHChannelReadyToSend(LPSTR &lpszChannelId);

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

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

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

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

Remarks

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

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

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

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

SSHChannelRequest Event (SSHClient Class)

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

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SSHCLIENT_SSHCHANNELREQUEST 12

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

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

  const QString &RequestType();

  const QByteArray &Packet();

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

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

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

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

Remarks

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

ChannelId identifies the channel receiving the request.

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

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

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

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

SSHChannelRequested Event (SSHClient 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(SSHClientSSHChannelRequestedEventParams *e);

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


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

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

#define EID_SSHCLIENT_SSHCHANNELREQUESTED 13

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

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

  const QString &RequestType();

  const QByteArray &Packet();

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

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

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

Remarks

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

ChannelId identifies the channel receiving the request.

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

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

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

SSHCustomAuth Event (SSHClient Class)

Fired when the class is doing custom authentication.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SSHCLIENT_SSHCUSTOMAUTH 14

virtual INT IPWORKSSSH_CALL FireSSHCustomAuth(LPSTR &lpszPacket);

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

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

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

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

Remarks

SSHCustomAuth is fired during the user authentication stage of the SSH logon process if SSHAuthMode is set to amCustom. Packet contains the raw last SSH packet sent by the server, in HEX-encoded format.

The client should create a new raw SSH packet to send to the server and set Packet to the HEX-encoded representation of the packet to send.

In all cases, Packet will start with the message type field.

To read the incoming packet call DecodePacket and then use the GetSSHParam and GetSSHParamBytes methods. To create a packet use the SetSSHParam method and then call EncodePacket to obtain a HEX-encoded value and assign this to the Packet parameter.

SSHKeyboardInteractive Event (SSHClient Class)

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

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SSHCLIENT_SSHKEYBOARDINTERACTIVE 15

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

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

  const QString &Instructions();

  const QString &Prompt();

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

  bool EchoResponse();

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

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

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

Remarks

SSHKeyboardInteractive is fired during the user authentication stage of the SSH logon process. During authentication, the class will request a list of available authentication methods for the SSHUser. For example, if the SSHHost responds with "keyboard-interactive", the class will fire this event to allow the client application to set the password.

During authentication, the SSH server may respond with a request for the user's authentication information. Name is a server-provided value associated with the authentication method such as "CRYPTOCard Authentication". Instructions will contain specific instructions, also supplied by the server, for how the user should respond.

Along with these values, the server will also send at least one input Prompt to be displayed to and filled out by the user. Response should be set to the user's input, and will be sent back in the user authentication information response. EchoResponse is a server recommendation for whether or not the user's response should be echoed back during input.

Note: the server may send several prompts in a single packet. The class will fire the SSHKeyboardInteractive event once for each prompt.

SSHServerAuthentication Event (SSHClient Class)

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

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SSHCLIENT_SSHSERVERAUTHENTICATION 16

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

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

  const QString &Fingerprint();

  const QString &KeyAlgorithm();

  const QString &CertSubject();

  const QString &CertIssuer();

  const QString &Status();

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

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

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

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

Remarks

This event is where the client can decide whether to continue with the connection process or not. If the public key is known to be a valid key for the SSH server, Accept should be set to True within the event. Otherwise, the server will not be authenticated and the connection will be broken.

Accept will be True only if either HostKey or Fingerprint is identical to the value of SSHAcceptServerHostKey.

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

Note that SSH's security inherently relies on client verification of the host key. Ignoring the host key and always setting Accept to true is strongly discouraged, and could cause potentially serious security vulnerabilities in your application. It is recommended that clients maintain a list of known keys for each server and check HostKey against this list each time a connection is attempted.

Host Key contains the full binary text of the key, in the same format used internally by SSH.

Fingerprint holds the SHA-256 hash of HostKey in the hex-encoded form: 0a:1b:2c:3d. To configure the hash algorithm used to calculate this value see SSHFingerprintHashAlgorithm.

KeyAlgorithm identifies the host key algorithm. Supported values are:

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

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

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

Status is reserved for future use.

SSHStatus Event (SSHClient Class)

Shows the progress of the secure connection.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SSHCLIENT_SSHSTATUS 17

virtual INT IPWORKSSSH_CALL FireSSHStatus(LPSTR &lpszMessage);

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

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

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

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

Remarks

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

Config Settings (SSHClient Class)

SSHClient Config Settings

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

TCPClient Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (SSHClient 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.

SSHClient Errors

The class may also return one of the following error codes, which are inherited from other classes.

TCPClient Errors

TCP/IP Errors