SSHClient Class
Properties Methods Events Config Settings Errors
The SSHClient class implements a fully functional, open-ended Secure Shell (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.
Channels | A collection of currently open channels. |
Connected | This property shows whether the class is connected. |
Firewall | A set of properties related to firewall access. |
LocalHost | This property includes the name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
LocalPort | The TCP port in the local host where the class binds. |
SSHAcceptServerHostKey | Instructs the class to accept the server host key that matches the supplied key. |
SSHAuthMode | The authentication method to be used the class when calling SSHLogon . |
SSHCert | A certificate to be used for authenticating the SSHUser . |
SSHCompressionAlgorithms | A comma-separated list containing all allowable compression algorithms. |
SSHEncryptionAlgorithms | A comma-separated list containing all allowable encryption algorithms. |
SSHHost | The address of the SSH host. |
SSHKeyExchangeAlgorithms | A comma-separated list containing all allowable key exchange algorithms. |
SSHMacAlgorithms | A comma-separated list containing all allowable message authentication algorithms. |
SSHPassword | The password for SSH password-based authentication. |
SSHPort | The port on the SSH server where the SSH service is running; by default, 22. |
SSHPublicKeyAlgorithms | A comma-separated list containing all allowable public key algorithms for the SSH server's public key. |
SSHUser | The username for SSH authentication. |
Timeout | This property includes the timeout for the class. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
ChangeRecordLength | Changes the length of received data records. |
CloseChannel | Closes a existing SSHChannel . |
Config | Sets or retrieves a configuration setting. |
Connect | Connects to the SSH host without logging in. |
DecodePacket | Decodes a hex-encoded SSH packet. |
Disconnect | This method disconnects from the server without first logging off. |
DoEvents | This method processes events from the internal message queue. |
EncodePacket | Hex encodes an SSH packet. |
ExchangeKeys | Causes the class to exchange a new set of session keys with the SSHHost . |
GetSSHParam | Used to read a field from an SSH packet's payload. |
GetSSHParamBytes | Used to read a field from an SSH packet's payload. |
OpenChannel | Opens a new SSHChannel . |
OpenTcpIpChannel | Opens a special TCP/IP tunneling SSHChannel . |
OpenTerminal | Creates a pseudo-terminal to be used to help display data for a channel. |
Reset | This method will reset the class. |
SendBytes | Sends binary data to the specified channel. |
SendChannelData | Used to send data over an SSH channel. |
SendSSHPacket | Used to send an encoded SSH packet to the server. |
SendText | Sends text to the specified channel. |
SetSSHParam | Used to write a field to the end of a payload. |
SSHLogoff | Logoff from the SSH server. |
SSHLogon | Logon to the SSHHost using the current SSHUser and SSHPassword . |
StartService | Requests the given service on a target channel. |
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.
Connected | This event is fired immediately after a connection completes (or fails). |
ConnectionStatus | This event is fired to indicate changes in the connection state. |
Disconnected | This event is fired when a connection is closed. |
Error | Fired when information is available about errors during data delivery. |
Log | Fires once for each log message. |
SSHChannelClosed | Fired when a channel is closed. |
SSHChannelData | Fired when the SSHHost sends channel data to the client. |
SSHChannelEOF | Fired when the remote peer signals the end of the data stream for the channel. |
SSHChannelOpened | Fired when a channel is successfully opened. |
SSHChannelOpenRequest | Fired when a host attempts to open a new channel. |
SSHChannelReadyToSend | Fired when the class is ready to send data. |
SSHChannelRequest | Fired when the SSHHost sends a channel request to the client. |
SSHChannelRequested | Fired if the SSHChannelRequest was successful, any further processing for the channel request should be done here. |
SSHCustomAuth | Fired when the class is doing custom authentication. |
SSHKeyboardInteractive | Fired when the class receives a request for user input from the server. |
SSHServerAuthentication | Fired after the server presents its public key to the client. |
SSHStatus | Shows the progress of the secure connection. |
Config Settings
The following is a list of config settings for the class with short descriptions. Click on the links for further details.
ChannelDataEOL[ChannelId] | Used to break the incoming data stream into chunks. |
ChannelDataEOLFound[ChannelId] | Determines if ChannelDataEOL was found. |
ClientSSHVersionString | The SSH version string used by the class. |
EnablePageantAuth | Whether to use a key stored in Pageant to perform client authentication. |
KerberosDelegation | If true, asks for credentials with delegation enabled during authentication. |
KerberosRealm | The fully qualified domain name of the Kerberos Realm to use for GSSAPI authentication. |
KerberosSPN | The Kerberos Service Principal Name of the SSH host. |
KeyRenegotiationThreshold | Sets the threshold for the SSH Key Renegotiation. |
LogLevel | Specifies the level of detail that is logged. |
MaxChannelDataLength[ChannelId] | The maximum amount of data to accumulate when no ChannelDataEOL is found. |
MaxPacketSize | The maximum packet size of the channel, in bytes. |
MaxWindowSize | The maximum window size allowed for the channel, in bytes. |
NegotiatedStrictKex | Returns whether strict key exchange was negotiated to be used. |
PasswordPrompt | The text of the password prompt used in keyboard-interactive authentication. |
PreferredDHGroupBits | The size (in bits) of the preferred modulus (p) to request from the server. |
RecordLength | The length of received data records. |
ServerSSHVersionString | The remote host's SSH version string. |
SignedSSHCert | The CA signed client public key used when authenticating. |
SSHAcceptAnyServerHostKey | If set the class will accept any key presented by the server. |
SSHAcceptServerCAKey | The CA public key that signed the server's host key. |
SSHAcceptServerHostKeyFingerPrint | The fingerprint of the server key to accept. |
SSHFingerprintHashAlgorithm | The algorithm used to calculate the fingerprint. |
SSHFingerprintMD5 | The server hostkey's MD5 fingerprint. |
SSHFingerprintSHA1 | The server hostkey's SHA1 fingerprint. |
SSHFingerprintSHA256 | The server hostkey's SHA256 fingerprint. |
SSHKeepAliveCountMax | The maximum number of keep alive packets to send without a response. |
SSHKeepAliveInterval | The interval between keep alive packets. |
SSHKeyExchangeAlgorithms | Specifies the supported key exchange algorithms. |
SSHKeyRenegotiate | Causes the class to renegotiate the SSH keys. |
SSHMacAlgorithms | Specifies the supported Mac algorithms. |
SSHPubKeyAuthSigAlgorithms | Specifies the enabled signature algorithms that may be used when attempting public key authentication. |
SSHPublicKeyAlgorithms | Specifies the supported public key algorithms for the server's public key. |
SSHVersionPattern | The pattern used to match the remote host's version string. |
TryAllAvailableAuthMethods | If set to true, the class will try all available authentication methods. |
UseStrictKeyExchange | Specifies how strict key exchange is supported. |
WaitForChannelClose | Whether to wait for channels to be closed before disconnected. |
WaitForServerDisconnect | Whether to wait for the server to close the connection. |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
FirewallAutoDetect | Tells the class whether or not to automatically detect and use firewall system settings, if available. |
FirewallHost | Name or IP address of firewall (optional). |
FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
FirewallPort | The TCP port for the FirewallHost;. |
FirewallType | Determines the type of firewall to connect through. |
FirewallUser | A user name if authentication is to be used connecting through a firewall. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
KeepAliveRetryCount | The number of keep-alive packets to be sent before the remotehost is considered disconnected. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
Linger | When set to True, connections are terminated gracefully. |
LingerTime | Time in seconds to have the connection linger. |
LocalHost | The name of the local host through which connections are initiated or accepted. |
LocalPort | The port in the local host where the class binds. |
MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
MaxTransferRate | The transfer rate limit in bytes per second. |
ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
TcpNoDelay | Whether or not to delay when sending packets. |
UseIPv6 | Whether to use IPv6. |
AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
FirewallData | Used to send extra data to the firewall. |
InBufferSize | The size in bytes of the incoming queue of the socket. |
OutBufferSize | The size in bytes of the outgoing queue of the socket. |
BuildInfo | Information about the product's build. |
CodePage | The system code page used for Unicode to Multibyte translations. |
LicenseInfo | Information about the current license. |
MaskSensitiveData | Whether sensitive data is masked in log messages. |
ProcessIdleEvents | Whether the class uses its internal event loop to process events when the main thread is idle. |
SelectWaitMillis | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
UseFIPSCompliantAPI | Tells the class whether or not to use FIPS certified APIs. |
UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
Channels Property (SSHClient Class)
A collection of currently open channels.
Syntax
IPWorksSSHList<IPWorksSSHSSHChannel>* GetChannels();
int ipworksssh_sshclient_getsshchannelcount(void* lpObj);
int ipworksssh_sshclient_getbytessent(void* lpObj, int sshchannelid);
char* ipworksssh_sshclient_getchanneleol(void* lpObj, int sshchannelid);
int ipworksssh_sshclient_setchanneleol(void* lpObj, int sshchannelid, const char* lpszChannelEOL);
char* ipworksssh_sshclient_getchannelid(void* lpObj, int sshchannelid);
int ipworksssh_sshclient_getmaxchannellength(void* lpObj, int sshchannelid);
int ipworksssh_sshclient_setmaxchannellength(void* lpObj, int sshchannelid, int iMaxChannelLength);
int ipworksssh_sshclient_getreadytosend(void* lpObj, int sshchannelid);
int ipworksssh_sshclient_getrecordlength(void* lpObj, int sshchannelid);
char* ipworksssh_sshclient_getservice(void* lpObj, int sshchannelid);
int GetSSHChannelCount(); int GetBytesSent(int iSSHChannelId); QString GetChannelEOL(int iSSHChannelId);
int SetChannelEOL(int iSSHChannelId, QString qsChannelEOL); QString GetChannelId(int iSSHChannelId); int GetMaxChannelLength(int iSSHChannelId);
int SetMaxChannelLength(int iSSHChannelId, int iMaxChannelLength); bool GetReadyToSend(int iSSHChannelId); int GetRecordLength(int iSSHChannelId); QString GetService(int iSSHChannelId);
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.
This collection is a hashtable where the channel's Id string is used as the key to the desired SSH channel object.
Example (Sending Data to a Channel)
This property is read-only.
Data Type
Connected Property (SSHClient Class)
This property shows whether the class is connected.
Syntax
ANSI (Cross Platform) int GetConnected(); Unicode (Windows) BOOL GetConnected();
int ipworksssh_sshclient_getconnected(void* lpObj);
bool GetConnected();
Default Value
FALSE
Remarks
This property is used to determine whether or not the class is connected to the remote host. Use the Connect and Disconnect methods to manage the connection.
This property is read-only and not available at design time.
Data Type
Boolean
Firewall Property (SSHClient Class)
A set of properties related to firewall access.
Syntax
IPWorksSSHFirewall* GetFirewall(); int SetFirewall(IPWorksSSHFirewall* val);
int ipworksssh_sshclient_getfirewallautodetect(void* lpObj);
int ipworksssh_sshclient_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);
int ipworksssh_sshclient_getfirewalltype(void* lpObj);
int ipworksssh_sshclient_setfirewalltype(void* lpObj, int iFirewallType);
char* ipworksssh_sshclient_getfirewallhost(void* lpObj);
int ipworksssh_sshclient_setfirewallhost(void* lpObj, const char* lpszFirewallHost);
char* ipworksssh_sshclient_getfirewallpassword(void* lpObj);
int ipworksssh_sshclient_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);
int ipworksssh_sshclient_getfirewallport(void* lpObj);
int ipworksssh_sshclient_setfirewallport(void* lpObj, int iFirewallPort);
char* ipworksssh_sshclient_getfirewalluser(void* lpObj);
int ipworksssh_sshclient_setfirewalluser(void* lpObj, const char* lpszFirewallUser);
bool GetFirewallAutoDetect();
int SetFirewallAutoDetect(bool bFirewallAutoDetect); int GetFirewallType();
int SetFirewallType(int iFirewallType); QString GetFirewallHost();
int SetFirewallHost(QString qsFirewallHost); QString GetFirewallPassword();
int SetFirewallPassword(QString qsFirewallPassword); int GetFirewallPort();
int SetFirewallPort(int iFirewallPort); QString GetFirewallUser();
int SetFirewallUser(QString qsFirewallUser);
Remarks
This is a Firewall-type property, which contains fields describing the firewall through which the class will attempt to connect.
Data Type
LocalHost Property (SSHClient Class)
This property includes the name of the local host or user-assigned IP interface through which connections are initiated or accepted.
Syntax
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 multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.
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 multihomed 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
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 on the client side.
Data Type
Integer
SSHAcceptServerHostKey Property (SSHClient Class)
Instructs the class to accept the server host key that matches the supplied key.
Syntax
IPWorksSSHCertificate* GetSSHAcceptServerHostKey(); int SetSSHAcceptServerHostKey(IPWorksSSHCertificate* val);
char* ipworksssh_sshclient_getsshacceptserverhostkeyeffectivedate(void* lpObj);
char* ipworksssh_sshclient_getsshacceptserverhostkeyexpirationdate(void* lpObj);
char* ipworksssh_sshclient_getsshacceptserverhostkeyextendedkeyusage(void* lpObj);
char* ipworksssh_sshclient_getsshacceptserverhostkeyfingerprint(void* lpObj);
char* ipworksssh_sshclient_getsshacceptserverhostkeyfingerprintsha1(void* lpObj);
char* ipworksssh_sshclient_getsshacceptserverhostkeyfingerprintsha256(void* lpObj);
char* ipworksssh_sshclient_getsshacceptserverhostkeyissuer(void* lpObj);
char* ipworksssh_sshclient_getsshacceptserverhostkeyprivatekey(void* lpObj);
int ipworksssh_sshclient_getsshacceptserverhostkeyprivatekeyavailable(void* lpObj);
char* ipworksssh_sshclient_getsshacceptserverhostkeyprivatekeycontainer(void* lpObj);
char* ipworksssh_sshclient_getsshacceptserverhostkeypublickey(void* lpObj);
char* ipworksssh_sshclient_getsshacceptserverhostkeypublickeyalgorithm(void* lpObj);
int ipworksssh_sshclient_getsshacceptserverhostkeypublickeylength(void* lpObj);
char* ipworksssh_sshclient_getsshacceptserverhostkeyserialnumber(void* lpObj);
char* ipworksssh_sshclient_getsshacceptserverhostkeysignaturealgorithm(void* lpObj);
int ipworksssh_sshclient_getsshacceptserverhostkeystore(void* lpObj, char** lpSSHAcceptServerHostKeyStore, int* lenSSHAcceptServerHostKeyStore);
int ipworksssh_sshclient_setsshacceptserverhostkeystore(void* lpObj, const char* lpSSHAcceptServerHostKeyStore, int lenSSHAcceptServerHostKeyStore);
char* ipworksssh_sshclient_getsshacceptserverhostkeystorepassword(void* lpObj);
int ipworksssh_sshclient_setsshacceptserverhostkeystorepassword(void* lpObj, const char* lpszSSHAcceptServerHostKeyStorePassword);
int ipworksssh_sshclient_getsshacceptserverhostkeystoretype(void* lpObj);
int ipworksssh_sshclient_setsshacceptserverhostkeystoretype(void* lpObj, int iSSHAcceptServerHostKeyStoreType);
char* ipworksssh_sshclient_getsshacceptserverhostkeysubjectaltnames(void* lpObj);
char* ipworksssh_sshclient_getsshacceptserverhostkeythumbprintmd5(void* lpObj);
char* ipworksssh_sshclient_getsshacceptserverhostkeythumbprintsha1(void* lpObj);
char* ipworksssh_sshclient_getsshacceptserverhostkeythumbprintsha256(void* lpObj);
char* ipworksssh_sshclient_getsshacceptserverhostkeyusage(void* lpObj);
int ipworksssh_sshclient_getsshacceptserverhostkeyusageflags(void* lpObj);
char* ipworksssh_sshclient_getsshacceptserverhostkeyversion(void* lpObj);
char* ipworksssh_sshclient_getsshacceptserverhostkeysubject(void* lpObj);
int ipworksssh_sshclient_setsshacceptserverhostkeysubject(void* lpObj, const char* lpszSSHAcceptServerHostKeySubject);
int ipworksssh_sshclient_getsshacceptserverhostkeyencoded(void* lpObj, char** lpSSHAcceptServerHostKeyEncoded, int* lenSSHAcceptServerHostKeyEncoded);
int ipworksssh_sshclient_setsshacceptserverhostkeyencoded(void* lpObj, const char* lpSSHAcceptServerHostKeyEncoded, int lenSSHAcceptServerHostKeyEncoded);
QString GetSSHAcceptServerHostKeyEffectiveDate(); QString GetSSHAcceptServerHostKeyExpirationDate(); QString GetSSHAcceptServerHostKeyExtendedKeyUsage(); QString GetSSHAcceptServerHostKeyFingerprint(); QString GetSSHAcceptServerHostKeyFingerprintSHA1(); QString GetSSHAcceptServerHostKeyFingerprintSHA256(); QString GetSSHAcceptServerHostKeyIssuer(); QString GetSSHAcceptServerHostKeyPrivateKey(); bool GetSSHAcceptServerHostKeyPrivateKeyAvailable(); QString GetSSHAcceptServerHostKeyPrivateKeyContainer(); QString GetSSHAcceptServerHostKeyPublicKey(); QString GetSSHAcceptServerHostKeyPublicKeyAlgorithm(); int GetSSHAcceptServerHostKeyPublicKeyLength(); QString GetSSHAcceptServerHostKeySerialNumber(); QString GetSSHAcceptServerHostKeySignatureAlgorithm(); QByteArray GetSSHAcceptServerHostKeyStore();
int SetSSHAcceptServerHostKeyStore(QByteArray qbaSSHAcceptServerHostKeyStore); QString GetSSHAcceptServerHostKeyStorePassword();
int SetSSHAcceptServerHostKeyStorePassword(QString qsSSHAcceptServerHostKeyStorePassword); int GetSSHAcceptServerHostKeyStoreType();
int SetSSHAcceptServerHostKeyStoreType(int iSSHAcceptServerHostKeyStoreType); QString GetSSHAcceptServerHostKeySubjectAltNames(); QString GetSSHAcceptServerHostKeyThumbprintMD5(); QString GetSSHAcceptServerHostKeyThumbprintSHA1(); QString GetSSHAcceptServerHostKeyThumbprintSHA256(); QString GetSSHAcceptServerHostKeyUsage(); int GetSSHAcceptServerHostKeyUsageFlags(); QString GetSSHAcceptServerHostKeyVersion(); QString GetSSHAcceptServerHostKeySubject();
int SetSSHAcceptServerHostKeySubject(QString qsSSHAcceptServerHostKeySubject); QByteArray GetSSHAcceptServerHostKeyEncoded();
int SetSSHAcceptServerHostKeyEncoded(QByteArray qbaSSHAcceptServerHostKeyEncoded);
Remarks
If the host key that will be used by the server is known in advance, this property may be set to accept the expected key. Otherwise the SSHServerAuthentication event should be trapped, and the key should be accepted or refused in the event.
If this property is not set and the SSHServerAuthentication event is not trapped, the server will not be authenticated and the connection will be terminated by the client.
Data Type
SSHAuthMode Property (SSHClient Class)
The authentication method to be used the class when calling SSHLogon .
Syntax
ANSI (Cross Platform) int GetSSHAuthMode();
int SetSSHAuthMode(int iSSHAuthMode); Unicode (Windows) INT GetSSHAuthMode();
INT SetSSHAuthMode(INT iSSHAuthMode);
Possible Values
AM_NONE(0),
AM_MULTI_FACTOR(1),
AM_PASSWORD(2),
AM_PUBLIC_KEY(3),
AM_KEYBOARD_INTERACTIVE(4),
AM_GSSAPIWITH_MIC(5),
AM_GSSAPIKEYEX(6),
AM_CUSTOM(99)
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:
amNone (0) | No authentication will be performed. The current SSHUser value is ignored, and the connection will be logged in as anonymous. |
amMultiFactor (1) | This allows the class to attempt a multi-step authentication process. The class will send authentication data to the server based on the list of methods allowed for the current user and the authentication property values supplied. The class will continue to send authentication data until the server acknowledges authentication success. If the server rejects an authentication step, the class fails with an error. |
amPassword (2) | The class will use the values of SSHUser and SSHPassword to authenticate the user. |
amPublicKey (3) | The class will use the values of SSHUser and the SSHCert* properties to authenticate the user. the SSHCert* properties must have a private key available for this authentication method to succeed. |
amKeyboardInteractive (4) | At the time of authentication, the class will fire the SSHKeyboardInteractive event containing instructions on how to complete the authentication step. (NOTE: amKeyboardInteractive is not supported in SSHTunnel). |
amGSSAPIWithMic (5) | This allows the class to attempt Kerberos authentication using the GSSAPI-WITH-MIC scheme. The client will try Kerberos authentication using the value of SSHUser (single sign-on), or if SSHPassword is specified as well, it will try Kerberos authentication with alternate credentials. This is currently supported only on Windows, unless using the Java edition, which also provides support for Linux and macOS. |
amGSSAPIKeyex (6) | This allows the class to attempt Kerberos authentication using the GSSAPIKeyex scheme. The client will try Kerberos authentication using the value of SSHUser (single sign-on), or if SSHPassword is specified as well, it will try Kerberos authentication with alternate credentials. This is currently supported only on Windows, unless using the Java edition, which also provides support for Linux and macOS. |
amCustom (99) | This allows the class caller to take over the authentication process completely. When amCustom is set, the class will fire the SSHCustomAuth event as necessary to complete the authentication process. |
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
SSHCert Property (SSHClient Class)
A certificate to be used for authenticating the SSHUser .
Syntax
IPWorksSSHCertificate* GetSSHCert(); int SetSSHCert(IPWorksSSHCertificate* val);
char* ipworksssh_sshclient_getsshcerteffectivedate(void* lpObj);
char* ipworksssh_sshclient_getsshcertexpirationdate(void* lpObj);
char* ipworksssh_sshclient_getsshcertextendedkeyusage(void* lpObj);
char* ipworksssh_sshclient_getsshcertfingerprint(void* lpObj);
char* ipworksssh_sshclient_getsshcertfingerprintsha1(void* lpObj);
char* ipworksssh_sshclient_getsshcertfingerprintsha256(void* lpObj);
char* ipworksssh_sshclient_getsshcertissuer(void* lpObj);
char* ipworksssh_sshclient_getsshcertprivatekey(void* lpObj);
int ipworksssh_sshclient_getsshcertprivatekeyavailable(void* lpObj);
char* ipworksssh_sshclient_getsshcertprivatekeycontainer(void* lpObj);
char* ipworksssh_sshclient_getsshcertpublickey(void* lpObj);
char* ipworksssh_sshclient_getsshcertpublickeyalgorithm(void* lpObj);
int ipworksssh_sshclient_getsshcertpublickeylength(void* lpObj);
char* ipworksssh_sshclient_getsshcertserialnumber(void* lpObj);
char* ipworksssh_sshclient_getsshcertsignaturealgorithm(void* lpObj);
int ipworksssh_sshclient_getsshcertstore(void* lpObj, char** lpSSHCertStore, int* lenSSHCertStore);
int ipworksssh_sshclient_setsshcertstore(void* lpObj, const char* lpSSHCertStore, int lenSSHCertStore);
char* ipworksssh_sshclient_getsshcertstorepassword(void* lpObj);
int ipworksssh_sshclient_setsshcertstorepassword(void* lpObj, const char* lpszSSHCertStorePassword);
int ipworksssh_sshclient_getsshcertstoretype(void* lpObj);
int ipworksssh_sshclient_setsshcertstoretype(void* lpObj, int iSSHCertStoreType);
char* ipworksssh_sshclient_getsshcertsubjectaltnames(void* lpObj);
char* ipworksssh_sshclient_getsshcertthumbprintmd5(void* lpObj);
char* ipworksssh_sshclient_getsshcertthumbprintsha1(void* lpObj);
char* ipworksssh_sshclient_getsshcertthumbprintsha256(void* lpObj);
char* ipworksssh_sshclient_getsshcertusage(void* lpObj);
int ipworksssh_sshclient_getsshcertusageflags(void* lpObj);
char* ipworksssh_sshclient_getsshcertversion(void* lpObj);
char* ipworksssh_sshclient_getsshcertsubject(void* lpObj);
int ipworksssh_sshclient_setsshcertsubject(void* lpObj, const char* lpszSSHCertSubject);
int ipworksssh_sshclient_getsshcertencoded(void* lpObj, char** lpSSHCertEncoded, int* lenSSHCertEncoded);
int ipworksssh_sshclient_setsshcertencoded(void* lpObj, const char* lpSSHCertEncoded, int lenSSHCertEncoded);
QString GetSSHCertEffectiveDate(); QString GetSSHCertExpirationDate(); QString GetSSHCertExtendedKeyUsage(); QString GetSSHCertFingerprint(); QString GetSSHCertFingerprintSHA1(); QString GetSSHCertFingerprintSHA256(); QString GetSSHCertIssuer(); QString GetSSHCertPrivateKey(); bool GetSSHCertPrivateKeyAvailable(); QString GetSSHCertPrivateKeyContainer(); QString GetSSHCertPublicKey(); QString GetSSHCertPublicKeyAlgorithm(); int GetSSHCertPublicKeyLength(); QString GetSSHCertSerialNumber(); QString GetSSHCertSignatureAlgorithm(); QByteArray GetSSHCertStore();
int SetSSHCertStore(QByteArray qbaSSHCertStore); QString GetSSHCertStorePassword();
int SetSSHCertStorePassword(QString qsSSHCertStorePassword); int GetSSHCertStoreType();
int SetSSHCertStoreType(int iSSHCertStoreType); QString GetSSHCertSubjectAltNames(); QString GetSSHCertThumbprintMD5(); QString GetSSHCertThumbprintSHA1(); QString GetSSHCertThumbprintSHA256(); QString GetSSHCertUsage(); int GetSSHCertUsageFlags(); QString GetSSHCertVersion(); QString GetSSHCertSubject();
int SetSSHCertSubject(QString qsSSHCertSubject); QByteArray GetSSHCertEncoded();
int SetSSHCertEncoded(QByteArray qbaSSHCertEncoded);
Remarks
In order to use public key authentication, SSHCert must contain a Certificate with a valid private key. The certificate's public key value is sent to the server along with a signature produced using the private key. The server will first check to see if the public key values match what is known for the user, and then will attempt to use those values to verify the signature.
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
SSHCompressionAlgorithms Property (SSHClient Class)
A comma-separated list containing all allowable compression algorithms.
Syntax
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
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,3des-ctr,arcfour256,arcfour128,arcfour,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:
aes256-ctr | 256-bit AES encryption in CTR mode |
aes256-cbc | 256-bit AES encryption in CBC mode |
aes192-ctr | 192-bit AES encryption in CTR mode |
aes192-cbc | 192-bit AES encryption in CBC mode |
aes128-ctr | 128-bit AES encryption in CTR mode |
aes128-cbc | 128-bit AES encryption in CBC mode |
3des-ctr | 192-bit (3-key) triple DES encryption in CTR mode |
3des-cbc | 192-bit (3-key) triple DES encryption in CBC mode |
cast128-cbc | CAST-128 encryption |
blowfish-cbc | Blowfish encryption |
arcfour | ARC4 encryption |
arcfour128 | 128-bit ARC4 encryption |
arcfour256 | 256-bit ARC4 encryption |
aes256-gcm@openssh.com | 256-bit AES encryption in GCM mode. |
aes128-gcm@openssh.com | 128-bit AES encryption in GCM mode. |
chacha20-poly1305@openssh.com | ChaCha20 with Poly1305-AES encryption. |
Data Type
String
SSHHost Property (SSHClient Class)
The address of the SSH host.
Syntax
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
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
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
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
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
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:
ssh-dss | Raw DSS Key |
ssh-rsa | Raw RSA Key |
rsa-sha2-256 | Raw RSA Key |
rsa-sha2-512 | Raw RSA Key |
x509v3-sign-rsa | X509 RSA Certificate |
x509v3-sign-dss | X509 DSS Certificate |
ecdsa-sha2-nistp256 | Raw EC Key with curve nistp256.
Note: This functionality is only available in Windows. |
ecdsa-sha2-nistp384 | Raw EC Key with curve nistp384.
Note: This functionality is only available in Windows. |
ecdsa-sha2-nistp521 | Raw EC Key with curve nistp521.
Note: This functionality is only available in Windows. |
ssh-ed25519 | Ed25519 Key |
ssh-ed448 | Ed448 Key |
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
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)
This property includes the timeout for the class.
Syntax
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.
Note: By default, all timeouts are inactivity timeouts, that is, 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
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
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
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
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
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
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)
This method processes events from the internal message queue.
Syntax
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
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
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
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:
ChannelId (int32) | The id of the channel that received the packet. |
RequestType (string) | The type of channel request. |
WantsReply (boolean) | Whether or not the client wants a reply to the request. |
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:
TerminalType (string) | The type of terminal being requested (eg: "vt100"). |
TerminalWidthCharacters (int32) | The width, in characters, of the terminal to be opened. |
TerminalHeightRows (int32) | The height, in rows, of the terminal to be opened. |
TerminalWidthPixels (int32) | The width, in pixels, of the terminal to be opened. |
TerminalHeightPixels (int32) | The height, in pixels, of the terminal to be opened. |
TerminalModes (string) | A list of op-val (int32-byte) encoded modes to be used by the terminal. |
x11-req
X11-req is a request to forward x11 sessions over a channel. The following fields are available:
SingleConnection (boolean) | Disallows more than one connection to be forwarded by the channel. |
X11AuthProtocol (string) | The authentication protocol to be used (eg: "MIT-MAGIC-COOKIE-1"). |
X11AuthCookie (string) | A hexadecimal-encoded cookie to be used for authentication. |
X11ScreenNumber (int32) | The x11 screen number to be used. |
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:
VariableName (string) | The name of the variable to be set. |
VariableValue (string) | The value of the variable to be set. |
exec
Exec is a request to execute a command on the channel using the authenticated user's shell. The following field is available:
Command (string) | The command to be executed. |
subsystem
Subsystem is a request to start a subsystem on the specified channel. The following field is available:
Subsystem (string) | The name of the subsystem to be started (eg: "sftp"). |
xon-xoff
Instructs the server to allow or disallow control-S/control-Q style flow control. The following field is available:
ClientCanDo (boolean) | Whether or not the server should enable flow control. |
signal
Sends a signal to the remote process/service. The following field is available:
SignalName (string) | The name of the signal to be sent. |
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
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
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
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
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:
0 | TTY_OP_END Indicates end of options. |
1 | VINTR Interrupt character; 255 if none. Similarly for the other characters. Not all of these characters are supported on all systems. |
2 | VQUIT The quit character (sends SIGQUIT signal on POSIX systems). |
3 | VERASE Erase the character to left of the cursor. |
4 | VKILL Kill the current input line. |
5 | VEOF End-of-file character (sends EOF from the terminal). |
6 | VEOL End-of-line character in addition to carriage return and/or linefeed. |
7 | VEOL2 Additional end-of-line character. |
8 | VSTART Continues paused output (normally control-Q). |
9 | VSTOP Pauses output (normally control-S). |
10 | VSUSP Suspends the current program. |
11 | VDSUSP Another suspend character. |
12 | VREPRINT Reprints the current input line. |
13 | VWERASE Erases a word left of cursor. |
14 | VLNEXT Enter the next character typed literally, even if it is a special character |
15 | VFLUSH Character to flush output. |
16 | VSWTCH Switch to a different shell layer. |
17 | VSTATUS Prints system status line (load, command, pid, etc). |
18 | VDISCARD Toggles the flushing of terminal output. |
30 | IGNPAR The ignore parity flag. The parameter SHOULD be 0 if this flag is FALSE, and 1 if it is TRUE. |
31 | PARMRK Mark parity and framing errors. |
32 | INPCK Enable checking of parity errors. |
33 | ISTRIP Strip 8th bit off characters. |
34 | INLCR Map NL into CR on input. |
35 | IGNCR Ignore CR on input. |
36 | ICRNL Map CR to NL on input. |
37 | IUCLC Translate uppercase characters to lowercase. |
38 | IXON Enable output flow control. |
39 | IXANY Any char will restart after stop. |
40 | IXOFF Enable input flow control. |
41 | IMAXBEL Ring bell on input queue full. |
50 | ISIG Enable signals INTR, QUIT, [D]SUSP. |
51 | ICANON Canonicalize input lines. |
52 | XCASE Enable input and output of uppercase characters by preceding their lowercase equivalents with "\". |
53 | ECHO Enable echoing. |
54 | ECHOE Visually erase chars. |
55 | ECHOK Kill character discards current line. |
56 | ECHONL Echo NL even if ECHO is off. |
57 | NOFLSH Don't flush after interrupt. |
58 | TOSTOP Stop background jobs from output. |
59 | IEXTEN Enable extensions. |
60 | ECHOCTL Echo control characters as ^(Char). |
61 | ECHOKE Visual erase for line kill. |
62 | PENDIN Retype pending input. |
70 | OPOST Enable output processing. |
71 | OLCUC Convert lowercase to uppercase. |
72 | ONLCR Map NL to CR-NL. |
73 | OCRNL Translate carriage return to newline (output). |
74 | ONOCR Translate newline to carriage return-newline (output). |
75 | ONLRET Newline performs a carriage return (output). |
90 | CS7 7 bit mode. |
91 | CS8 8 bit mode. |
92 | PARENB Parity enable. |
93 | PARODD Odd parity, else even. |
128 | TTY_OP_ISPEED Specifies the input baud rate in bits per second. |
129 | TTY_OP_OSPEED Specifies the output baud rate in bits per second. |
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)
This method will reset the class.
Syntax
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
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
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
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
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
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:
s | A plaintext string containing the default system encoding of the data. |
sb | A string containing the hex encoded data. (eg: "A1B23C") |
m | A variable-length large integer, encoded as a textual representation of the value ("1234"). |
i | A 32-bit integer, encoded as a textual representation of the value (eg: "1234"). |
l | A 64-bit integer, encoded as a textual representation of the value (eg: "1234"). |
b | A single byte, encoded as a textual representation of the value (eg: "123"). |
f | A boolean flag, encoded as a textual representation of the value (eg: 'true' or 'false') |
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
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
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
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:
"shell" | Starts a shell on the |
"exec" | Executes the command identified by Parameter. |
"subsystem" | Starts up a subsystem identified by Parameter, such as "sftp". |
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
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
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:
Firewall connection complete. | |
Secure Sockets Layer (SSL) or S/Shell handshake complete (where applicable). | |
Remote host connection complete. | |
Remote host disconnected. | |
SSL or S/Shell connection broken. | |
Firewall host disconnected. |
Disconnected Event (SSHClient Class)
This event is fired when a connection is closed.
Syntax
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
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
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:
0 (None) | No messages are logged. |
1 (Info - Default) | Informational events such as SSH handshake messages are logged. |
2 (Verbose) | Detailed data such as individual packet information is logged. |
3 (Debug) | Debug data including all relevant sent and received bytes are logged. |
Message is the log message.
LogType is reserved for future use.
SSHChannelClosed Event (SSHClient Class)
Fired when a channel is closed.
Syntax
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
ANSI (Cross Platform) virtual int FireSSHChannelData(SSHClientSSHChannelDataEventParams *e);
typedef struct {
const char *ChannelId;
const char *ChannelData; int lenChannelData;
int ChannelDataEOLFound; int reserved; } SSHClientSSHChannelDataEventParams;
Unicode (Windows) virtual INT FireSSHChannelData(SSHClientSSHChannelDataEventParams *e);
typedef struct {
LPCWSTR ChannelId;
LPCSTR ChannelData; INT lenChannelData;
BOOL ChannelDataEOLFound; INT reserved; } SSHClientSSHChannelDataEventParams;
#define EID_SSHCLIENT_SSHCHANNELDATA 7 virtual INT IPWORKSSSH_CALL FireSSHChannelData(LPSTR &lpszChannelId, LPSTR &lpChannelData, INT &lenChannelData, BOOL &bChannelDataEOLFound);
class SSHClientSSHChannelDataEventParams { public: const QString &ChannelId(); const QByteArray &ChannelData(); bool ChannelDataEOLFound(); 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.
ChannelDataEOLFound indicates whether or not the ChannelEOL string for the Channel was found at the end of ChannelData. If the ChannelEOL string was found, then ChannelDataEOLFound is True.
If ChannelData is part of a data portion of length larger than the MaxChannelLength for the Channel with no ChannelEOL strings in it, then ChannelDataEOLFound is False. Note: This means that one of more SSHChannelData events with ChannelDataEOLFound set to False can be received.
If the ChannelEOL property for the Channel is "" (empty string), then ChannelDataEOLFound can be disregarded (it is always True).
SSHChannelEOF Event (SSHClient Class)
Fired when the remote peer signals the end of the data stream for the channel.
Syntax
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
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
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
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
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
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
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
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
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
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.
Certificate Type
This is the digital certificate being used.
Syntax
IPWorksSSHCertificate (declared in ipworksssh.h)
Remarks
This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.
Fields
EffectiveDate
char* (read-only)
Default Value: ""
This is the date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
ExpirationDate
char* (read-only)
Default Value: ""
This is the date the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
ExtendedKeyUsage
char* (read-only)
Default Value: ""
This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
Fingerprint
char* (read-only)
Default Value: ""
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02
FingerprintSHA1
char* (read-only)
Default Value: ""
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84
FingerprintSHA256
char* (read-only)
Default Value: ""
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53
Issuer
char* (read-only)
Default Value: ""
This is the issuer of the certificate. This field contains a string representation of the name of the issuing authority for the certificate.
PrivateKey
char* (read-only)
Default Value: ""
This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The PrivateKey may be available but not exportable. In this case, PrivateKey returns an empty string.
PrivateKeyAvailable
int (read-only)
Default Value: FALSE
This field shows whether a PrivateKey is available for the selected certificate. If PrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).
PrivateKeyContainer
char* (read-only)
Default Value: ""
This is the name of the PrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.
PublicKey
char* (read-only)
Default Value: ""
This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.
PublicKeyAlgorithm
char* (read-only)
Default Value: ""
This field contains the textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
PublicKeyLength
int (read-only)
Default Value: 0
This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
SerialNumber
char* (read-only)
Default Value: ""
This is the serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
SignatureAlgorithm
char* (read-only)
Default Value: ""
The field contains the text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
Store
char*
Default Value: "MY"
This is the name of the certificate store for the client certificate.
The StoreType field denotes the type of the certificate store specified by Store. If the store is password protected, specify the password in StorePassword.
Store is used in conjunction with the Subject field to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject field for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
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).
StorePassword
char*
Default Value: ""
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
StoreType
int
Default Value: 0
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 field can take one of the following values:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: this store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the Store and set StorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
SubjectAltNames
char* (read-only)
Default Value: ""
This field contains comma-separated lists of alternative subject names for the certificate.
ThumbprintMD5
char* (read-only)
Default Value: ""
This field contains the MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
ThumbprintSHA1
char* (read-only)
Default Value: ""
This field contains the SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
ThumbprintSHA256
char* (read-only)
Default Value: ""
This field contains the SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
Usage
char* (read-only)
Default Value: ""
This field contains the text description of UsageFlags.
This value will be of one or more of the following strings and will be separated by commas:
- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
UsageFlags
int (read-only)
Default Value: 0
This field contains the flags that show intended use for the certificate. The value of UsageFlags is a combination of the following flags:
0x80 | Digital Signature |
0x40 | Non-Repudiation |
0x20 | Key Encipherment |
0x10 | Data Encipherment |
0x08 | Key Agreement |
0x04 | Certificate Signing |
0x02 | CRL Signing |
0x01 | Encipher Only |
Please see the Usage field for a text representation of UsageFlags.
This functionality currently is not available when the provider is OpenSSL.
Version
char* (read-only)
Default Value: ""
This field contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".
Subject
char*
Default Value: ""
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 field 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:
Field | Meaning |
CN | Common Name. This is commonly a hostname like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
Encoded
char*
Default Value: ""
This is the certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate.
When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject is set to an empty string.
Constructors
Certificate()
Creates a Certificate instance whose properties can be set. This is useful for use with CERTMGR when generating new certificates.
Certificate(const char* lpEncoded, int lenEncoded)
Parses Encoded as an X.509 public key.
Certificate(int iStoreType, const char* lpStore, int lenStore, const char* lpszStorePassword, const char* lpszSubject)
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or Base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.
Firewall Type
The firewall the component will connect through.
Syntax
IPWorksSSHFirewall (declared in ipworksssh.h)
Remarks
When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall Host and the FirewallType.
Fields
AutoDetect
int
Default Value: FALSE
This field tells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallType
int
Default Value: 0
This field determines the type of firewall to connect through. The applicable values are as follows:
fwNone (0) | No firewall (default setting). |
fwTunnel (1) | Connect through a tunneling proxy. Port is set to 80. |
fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. Port is set to 1080. |
fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. Port is set to 1080. |
fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. Port is set to 1080. |
Host
char*
Default Value: ""
This field contains the name or IP address of the firewall (optional). If a Host is given, the requested connections will be authenticated through the specified firewall when connecting.
If this field is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this field is set to the corresponding address. If the search is not successful, the class fails with an error.
Password
char*
Default Value: ""
This field contains a password if authentication is to be used when connecting through the firewall. If Host is specified, the User and Password fields are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.
Port
int
Default Value: 0
This field contains the Transmission Control Protocol (TCP) port for the firewall Host. See the description of the Host field for details.
Note: This field is set automatically when FirewallType is set to a valid value. See the description of the FirewallType field for details.
User
char*
Default Value: ""
This field contains a username if authentication is to be used when connecting through a firewall. If Host is specified, this field and the Password field are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.
Constructors
Firewall()
SSHChannel Type
A currently open Secure Shell (SSH) channel.
Syntax
IPWorksSSHSSHChannel (declared in ipworksssh.h)
Remarks
This type describes the Secure Shell (SSH) client's currently open channels. You may use the different fields for this type to manage the channel.
Fields
BytesSent
int (read-only)
Default Value: 0
The number of bytes actually sent after a sending channel data.
ChannelEOL
char*
Default Value: ""
This property is used to break the incoming data stream into chunks separated by EOL.
This property is a binary string. Notably, this means that it can be more than one byte long, and it can contain NULL bytes.
ChannelEOL and MaxChannelLength must be set together or unexpected behavior could occur.
ChannelId
char* (read-only)
Default Value: ""
An Id generated by the class to identify the current Secure Shell (SSH) channel.
This Id is unique to this channel.
MaxChannelLength
int
Default Value: 0
The maximum amount of data to accumulate when no EOL is found.
MaxChannelLength is the size of an internal buffer, which holds received data while waiting for a ChannelEOL string.
If the ChannelEOL string is found in the input stream before MaxChannelLength bytes are received, the SSHChannelData event is fired with the ChannelDataEOLFound parameter set to True, and the buffer is reset.
If no ChannelEOL is found, and MaxChannelLength bytes are accumulated in the buffer, the SSHChannelData event is fired with the ChannelDataEOLFound parameter set to False, and the buffer is reset.
ChannelEOL and MaxChannelLength must be set together or unexpected behavior could occur.
ReadyToSend
int (read-only)
Default Value: FALSE
This field is True when data can be sent over the Secure Shell (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.
RecordLength
int (read-only)
Default Value: 0
This field holds the current record length set by ChangeRecordLength. When this value is a positive number, the class will accumulate data until RecordLength is reached and only then will it fire the SSHChannelDataIn event with the data of length RecordLength. This allows data to be received as records of known length. This value can be changed at any time by calling ChangeRecordLength, including within the SSHChannelDataIn event.
A value of 0 (default) means this setting is not used.
Service
char* (read-only)
Default Value: ""
This field holds the channel type that was requested when opening the channel. For instance "session" or "forwarded-tcpip".
IPWorksSSHList Type
Syntax
IPWorksSSHList<T> (declared in ipworksssh.h)
Remarks
IPWorksSSHList is a generic class that is used to hold a collection of objects of type T, where T is one of the custom types supported by the SSHClient class.
Methods | |
GetCount |
This method returns the current size of the collection.
int GetCount() {}
|
SetCount |
This method sets the size of the collection. This method returns 0 if setting the size was successful; or -1 if the collection is ReadOnly. When adding additional objects to a collection call this method to specify the new size. Increasing the size of the collection preserves existing objects in the collection.
int SetCount() {}
|
Get |
This method gets the item at the specified position. The index parameter specifies the index of the item in the collection. This method returns NULL if an invalid index is specified.
T* Get(int index) {}
|
Set |
This method sets the item at the specified position. The index parameter specifies the index of the item in the collection that is being set. This method returns -1 if an invalid index is specified. Note: Objects created using the new operator must be freed using the delete operator; they will not be automatically freed by the class.
T* Set(int index, T* value) {}
|
Config Settings (SSHClient Class)
The class accepts one or more of the following configuration settings. Configuration 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.SSHClient Config Settings
If MaxChannelDataLength > 0 and ChannelDataEOL is a non-empty string the class will internally buffer data waiting to fire SSHChannelData until either MaxChannelDataLength is reached or ChannelDataEOL is found, whichever comes first. Query ChannelDataEOLFound to know which condition was met. The buffer is reset any time SSHChannelData fires.
ChannelDataEOL and MaxChannelDataLength MUST be set together or unexpected behavior could occur.
This config is only valid when queried inside SSHChannelData, MaxChannelDataLength > 0, and ChannelDataEOL is non-empty.
Most SSH servers expect the SSH version string to have the expected format "SSH-protocol version-software version". See above for an example.
Value | Description |
0 (Disabled - default) | No communication with Pageant is attempted. |
1 (Enabled) | Pageant authentication is used if available. If Pageant is not running, or does not contain the expected key no error is thrown. |
2 (Required) | Only Pageant authentication is used. If Pageant is not running, or does not contain the expected key an error is thrown. |
Example enabling Pageant:
component.Config("EnablePageantAuth=1");
component.SSHUser = "sshuser";
component.SSHLogon("localhost", 22);
Note: This functionality is only available on Windows.
Example (for setting the threshold to 500 MB):
SSHComponent.Config("KeyRenegotiationThreshold=524288000")
0 (None) | No messages are logged. |
1 (Info - Default) | Informational events such as SSH handshake messages are logged. |
2 (Verbose) | Detailed data such as individual packet information is logged. |
3 (Debug) | Debug data including all relevant sent and received bytes are logged. |
If MaxChannelDataLength > 0 and ChannelDataEOL is a non-empty string the class will internally buffer data waiting to fire SSHChannelData until either MaxChannelDataLength is reached or ChannelDataEOL is found, whichever comes first. Query ChannelDataEOLFound to know which condition was met. The buffer is reset any time SSHChannelData fires.
ChannelDataEOL and MaxChannelDataLength MUST be set together or unexpected behavior could occur.
component.Config("NegotiatedStrictKex")
This provides an easy way to automatically reply to prompts with the password if one is presented by the server. The password will be auto-filled in the Response parameter of the SSHKeyboardInteractive event in the case of a match.
The following special characters are supported for pattern matching:
? | Any single character. |
* | Any characters or no characters (e.g., C*t matches Cat, Cot, Coast, Ct). |
[,-] | A range of characters (e.g., [a-z], [a], [0-9], [0-9,a-d,f,r-z]). |
\ | The slash is ignored and exact matching is performed on the next character. |
If these characters need to be used as a literal in a pattern, then they must be escaped by surrounding them with brackets []. Note: "]" and "-" do not need to be escaped. See below for the escape sequences:
Character | Escape Sequence |
? | [?] |
* | [*] |
[ | [[] |
\ | [\] |
For example, to match the value [Something].txt, specify the pattern [[]Something].txt.
The default value is 0, meaning this setting is not used.
component.Config("SignedSSHCert=ssh-rsa-cert-v01@openssh.com AAAAB3NzaC1yc2EAAAADAQABAAAB...");
The algorithm such as ssh-rsa-cert-v01@openssh.com in the above string is used as part of the authentication process. To use a different algorithm simply change this value. For instance all of the following are acceptable with the same signed public key:
- ssh-rsa-cert-v01@openssh.com AAAAB3NzaC1yc2EAAAADAQABAAAB...
- rsa-sha2-256-cert-v01@openssh.com AAAAB3NzaC1yc2EAAAADAQABAAAB...
- rsa-sha2-512-cert-v01@openssh.com AAAAB3NzaC1yc2EAAAADAQABAAAB...
component.Config("SSHAcceptServerCAKey=ssh-rsa AAAAB3NzaC1yc2EAAAADAQAB...");
SSHClient.Config("SSHAcceptServerHostKeyFingerprint=0a:1b:2c:3d");
If the server's fingerprint matches one of the values supplied, the class will accept the host key.
- MD5
- SHA1
- SHA256 (default)
The default value is 0 meaning no keep alives will be sent.
Note: The SSHReverseTunnel class uses a default value of 30.
- 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==
Example:
SSHClient.Config("SSHKeyRenegotiate")
- 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
The setting should be a comma separated list of algorithms. At runtime the class will evaluate the specified algorithms and if the algorithm is applicable to the certificate specified in SSHCert it will be used. If the algorithm is not applicable the class will evaluate the next algorithm. Possible values are:
- ssh-rsa
- rsa-sha2-256
- rsa-sha2-512
- ssh-dss
- ecdsa-sha2-nistp256
- ecdsa-sha2-nistp384
- ecdsa-sha2-nistp521
- ssh-ed25519
- x509v3-sign-rsa
- x509v3-sign-dss
The default value in Windows is ssh-rsa,rsa-sha2-256,rsa-sha2-512,ssh-dss,ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521,ssh-ed25519.
rsa-sha2-256 and rsa-sha2-512 notes
The class will query the server for supported algorithms when connecting. If the server indicates support for rsa-sha2-256 or rsa-sha2-512 and the algorithm is present in the list defined by this setting (as in the default value), that algorithm will be used instead of ssh-rsa even when ssh-rsa appears first in the list.
For the rsa-sha2-256 and rsa-sha2-512 algorithms to be automatically preferred the server must support the ext-info-c mechanism. In practice, older servers do not support this and in that case ssh-rsa will be used since it appears first in the list. Newer servers do support this mechanism and in that case rsa-sha2-256 or rsa-sha2-512 will be used even though it appears after ssh-rsa.
This behavior has been carefully designed to provide maximum compatibility while automatically using more secure algorithms when connecting to servers which support them.
*SSH-1.99-*,*SSH-2.0-*,*SSH-2.99-*
Since both client and server must implement strict key exchange to effectively mitigate the Terrapin attack, the class provides options to further control the behavior in different scenarios. Possible values for this setting are:
0 | Disabled. Strict key exchange is not supported in the class. |
1 (default) | Enabled, but not enforced. This setting enables strict key exchange, but if the remote host does not support strict key exchange the connection is still allowed to continue. |
2 | Enabled, but reject affected algorithms if the remote host does not support strict key exchange. If the remote host supports strict key exchange all algorithms may be used. If the remote host does not support strict key exchange the connection will only continue if the selected encryption and MAC algorithms are not affected by the Terrapin attack. |
3 | Required. If the remote host does not support strict key exchange the connection will fail. |
When True (default) the class will wait for a response to the channel close message until the responses have been received, the server closes the connection, or Timeout seconds is reached.
When False the class will still send the channel close messages but will not wait for a response and will proceed to close the connection.
When set to True the class will initiate the disconnection sequence by sending SSH_MSG_DISCONNECT but will not close the connection, and instead will wait for the server to close the connection. Setting this to True may be beneficial in circumstances where many connections are being established, to avoid port exhaustion when sockets are in a TIME_WAIT state. Allowing the server to close the connection avoids the TIME_WAIT state of socket on the client machine.
When set to False (default) the client will close the connection. It is recommended to use this value unless there is a specific need to change it.
TCPClient Config Settings
If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This configuration setting is provided for use by classs that do not directly expose Firewall properties.
0 | No firewall (default setting). |
1 | Connect through a tunneling proxy. FirewallPort is set to 80. |
2 | Connect through a SOCKS4 Proxy. FirewallPort is set to 1080. |
3 | Connect through a SOCKS5 Proxy. FirewallPort is set to 1080. |
10 | Connect through a SOCKS4A Proxy. FirewallPort is set to 1080. |
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This value is not applicable in macOS.
Note: This configuration setting is only available in the Unix platform. It is not supported in masOS or FreeBSD.
In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.
In the second scenario, if LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection.
The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the class returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).
Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.
In multihomed 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 setting 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 multihomed hosts (machines with more than one IP interface).
Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established.
LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.
This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems.
If an EOL string is found in the input stream before MaxLineLength bytes are received, the DataIn event is fired with the EOL parameter set to True, and the buffer is reset.
If no EOL is found, and MaxLineLength bytes are accumulated in the buffer, the DataIn event is fired with the EOL parameter set to False, and the buffer is reset.
The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes.
www.google.com;www.nsoftware.com
Note: This value is not applicable in Java.
By default, this configuration setting is set to False.
0 | IPv4 only |
1 | IPv6 only |
2 | IPv6 with IPv4 fallback |
Socket Config Settings
Note: This option is not valid for User Datagram Protocol (UDP) ports.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Base Config Settings
The following is a list of valid code page identifiers:
Identifier | Name |
037 | IBM EBCDIC - U.S./Canada |
437 | OEM - United States |
500 | IBM EBCDIC - International |
708 | Arabic - ASMO 708 |
709 | Arabic - ASMO 449+, BCON V4 |
710 | Arabic - Transparent Arabic |
720 | Arabic - Transparent ASMO |
737 | OEM - Greek (formerly 437G) |
775 | OEM - Baltic |
850 | OEM - Multilingual Latin I |
852 | OEM - Latin II |
855 | OEM - Cyrillic (primarily Russian) |
857 | OEM - Turkish |
858 | OEM - Multilingual Latin I + Euro symbol |
860 | OEM - Portuguese |
861 | OEM - Icelandic |
862 | OEM - Hebrew |
863 | OEM - Canadian-French |
864 | OEM - Arabic |
865 | OEM - Nordic |
866 | OEM - Russian |
869 | OEM - Modern Greek |
870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
875 | IBM EBCDIC - Modern Greek |
932 | ANSI/OEM - Japanese, Shift-JIS |
936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
949 | ANSI/OEM - Korean (Unified Hangul Code) |
950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
1026 | IBM EBCDIC - Turkish (Latin-5) |
1047 | IBM EBCDIC - Latin 1/Open System |
1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
1147 | IBM EBCDIC - France (20297 + Euro symbol) |
1148 | IBM EBCDIC - International (500 + Euro symbol) |
1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
1201 | Unicode UCS-2 Big-Endian |
1250 | ANSI - Central European |
1251 | ANSI - Cyrillic |
1252 | ANSI - Latin I |
1253 | ANSI - Greek |
1254 | ANSI - Turkish |
1255 | ANSI - Hebrew |
1256 | ANSI - Arabic |
1257 | ANSI - Baltic |
1258 | ANSI/OEM - Vietnamese |
1361 | Korean (Johab) |
10000 | MAC - Roman |
10001 | MAC - Japanese |
10002 | MAC - Traditional Chinese (Big5) |
10003 | MAC - Korean |
10004 | MAC - Arabic |
10005 | MAC - Hebrew |
10006 | MAC - Greek I |
10007 | MAC - Cyrillic |
10008 | MAC - Simplified Chinese (GB 2312) |
10010 | MAC - Romania |
10017 | MAC - Ukraine |
10021 | MAC - Thai |
10029 | MAC - Latin II |
10079 | MAC - Icelandic |
10081 | MAC - Turkish |
10082 | MAC - Croatia |
12000 | Unicode UCS-4 Little-Endian |
12001 | Unicode UCS-4 Big-Endian |
20000 | CNS - Taiwan |
20001 | TCA - Taiwan |
20002 | Eten - Taiwan |
20003 | IBM5550 - Taiwan |
20004 | TeleText - Taiwan |
20005 | Wang - Taiwan |
20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
20106 | IA5 German (7-bit) |
20107 | IA5 Swedish (7-bit) |
20108 | IA5 Norwegian (7-bit) |
20127 | US-ASCII (7-bit) |
20261 | T.61 |
20269 | ISO 6937 Non-Spacing Accent |
20273 | IBM EBCDIC - Germany |
20277 | IBM EBCDIC - Denmark/Norway |
20278 | IBM EBCDIC - Finland/Sweden |
20280 | IBM EBCDIC - Italy |
20284 | IBM EBCDIC - Latin America/Spain |
20285 | IBM EBCDIC - United Kingdom |
20290 | IBM EBCDIC - Japanese Katakana Extended |
20297 | IBM EBCDIC - France |
20420 | IBM EBCDIC - Arabic |
20423 | IBM EBCDIC - Greek |
20424 | IBM EBCDIC - Hebrew |
20833 | IBM EBCDIC - Korean Extended |
20838 | IBM EBCDIC - Thai |
20866 | Russian - KOI8-R |
20871 | IBM EBCDIC - Icelandic |
20880 | IBM EBCDIC - Cyrillic (Russian) |
20905 | IBM EBCDIC - Turkish |
20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
20932 | JIS X 0208-1990 & 0121-1990 |
20936 | Simplified Chinese (GB2312) |
21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
21027 | Extended Alpha Lowercase |
21866 | Ukrainian (KOI8-U) |
28591 | ISO 8859-1 Latin I |
28592 | ISO 8859-2 Central Europe |
28593 | ISO 8859-3 Latin 3 |
28594 | ISO 8859-4 Baltic |
28595 | ISO 8859-5 Cyrillic |
28596 | ISO 8859-6 Arabic |
28597 | ISO 8859-7 Greek |
28598 | ISO 8859-8 Hebrew |
28599 | ISO 8859-9 Latin 5 |
28605 | ISO 8859-15 Latin 9 |
29001 | Europa 3 |
38598 | ISO 8859-8 Hebrew |
50220 | ISO 2022 Japanese with no halfwidth Katakana |
50221 | ISO 2022 Japanese with halfwidth Katakana |
50222 | ISO 2022 Japanese JIS X 0201-1989 |
50225 | ISO 2022 Korean |
50227 | ISO 2022 Simplified Chinese |
50229 | ISO 2022 Traditional Chinese |
50930 | Japanese (Katakana) Extended |
50931 | US/Canada and Japanese |
50933 | Korean Extended and Korean |
50935 | Simplified Chinese Extended and Simplified Chinese |
50936 | Simplified Chinese |
50937 | US/Canada and Traditional Chinese |
50939 | Japanese (Latin) Extended and Japanese |
51932 | EUC - Japanese |
51936 | EUC - Simplified Chinese |
51949 | EUC - Korean |
51950 | EUC - Traditional Chinese |
52936 | HZ-GB2312 Simplified Chinese |
54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
57002 | ISCII Devanagari |
57003 | ISCII Bengali |
57004 | ISCII Tamil |
57005 | ISCII Telugu |
57006 | ISCII Assamese |
57007 | ISCII Oriya |
57008 | ISCII Kannada |
57009 | ISCII Malayalam |
57010 | ISCII Gujarati |
57011 | ISCII Punjabi |
65000 | Unicode UTF-7 |
65001 | Unicode UTF-8 |
Identifier | Name |
1 | ASCII |
2 | NEXTSTEP |
3 | JapaneseEUC |
4 | UTF8 |
5 | ISOLatin1 |
6 | Symbol |
7 | NonLossyASCII |
8 | ShiftJIS |
9 | ISOLatin2 |
10 | Unicode |
11 | WindowsCP1251 |
12 | WindowsCP1252 |
13 | WindowsCP1253 |
14 | WindowsCP1254 |
15 | WindowsCP1250 |
21 | ISO2022JP |
30 | MacOSRoman |
10 | UTF16String |
0x90000100 | UTF16BigEndian |
0x94000100 | UTF16LittleEndian |
0x8c000100 | UTF32String |
0x98000100 | UTF32BigEndian |
0x9c000100 | UTF32LittleEndian |
65536 | Proprietary |
- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.
This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.
FIPS mode can be enabled by setting the UseFIPSCompliantAPI configuration setting to true. This is a static setting that applies to all instances of all classes of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior.
For more details, please see the FIPS 140-2 Compliance article.
Note: This setting is applicable only on Windows.
Note: Enabling FIPS compliance requires a special license; please contact sales@nsoftware.com for details.
Setting this configuration setting to true tells the class to use the internal implementation instead of using the system security libraries.
On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.
To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.
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
1001 | Server has disconnected. |
1002 | Protocol version unsupported or other issue with version string. |
1003 | Cannot negotiate algorithms. |
1005 | Selected algorithm unsupported. |
1006 | Cannot set keys. |
1010 | Unexpected algorithm. |
1011 | Cannot create exchange hash. |
1012 | Cannot make key. |
1013 | Cannot sign data. |
1014 | Cannot encrypt packet. |
1015 | Cannot decrypt packet. |
1016 | Cannot decompress packet. |
1020 | Failure to open channel. |
1021 | Invalid channel ID. |
1022 | Invalid channel data. |
1023 | Invalid channel message. |
1024 | SSH message unimplemented. |
1027 | Server message unsupported. |
1030 | Server's host key was rejected. The host key may be accepted within the SSHServerAuthentication event or using the SSHAcceptServerHostKey property. |
1031 | Cannot verify server's host key. |
1032 | Authentication failed. Check description for details. |
1033 | Channel request failed. |
1034 | Diffie-Hellman exchange failed. |
1036 | SSH connection failed. |
1037 | SSH reconnect limit reached. |
1038 | Elliptic Curve Diffie-Hellman exchange failed. |
1039 | SSH keep-alive limit reached. |
1098 | Request failure. |
1130 | Would block error. |
1133 | Would block, reason: key reExchange. |
The class may also return one of the following error codes, which are inherited from other classes.
TCPClient Errors
100 | You cannot change the RemotePort at this time. A connection is in progress. |
101 | You cannot change the RemoteHost (Server) at this time. A connection is in progress. |
102 | The RemoteHost address is invalid (0.0.0.0). |
104 | Already connected. If you want to reconnect, close the current connection first. |
106 | You cannot change the LocalPort at this time. A connection is in progress. |
107 | You cannot change the LocalHost at this time. A connection is in progress. |
112 | You cannot change MaxLineLength at this time. A connection is in progress. |
116 | RemotePort cannot be zero. Please specify a valid service port number. |
117 | You cannot change the UseConnection option while the class is active. |
135 | Operation would block. |
201 | Timeout. |
211 | Action impossible in control's present state. |
212 | Action impossible while not connected. |
213 | Action impossible while listening. |
301 | Timeout. |
302 | Could not open file. |
434 | Unable to convert string to selected CodePage. |
1105 | Already connecting. If you want to reconnect, close the current connection first. |
1117 | You need to connect first. |
1119 | You cannot change the LocalHost at this time. A connection is in progress. |
1120 | Connection dropped by remote host. |
TCP/IP Errors
10004 | [10004] Interrupted system call. |
10009 | [10009] Bad file number. |
10013 | [10013] Access denied. |
10014 | [10014] Bad address. |
10022 | [10022] Invalid argument. |
10024 | [10024] Too many open files. |
10035 | [10035] Operation would block. |
10036 | [10036] Operation now in progress. |
10037 | [10037] Operation already in progress. |
10038 | [10038] Socket operation on nonsocket. |
10039 | [10039] Destination address required. |
10040 | [10040] Message is too long. |
10041 | [10041] Protocol wrong type for socket. |
10042 | [10042] Bad protocol option. |
10043 | [10043] Protocol is not supported. |
10044 | [10044] Socket type is not supported. |
10045 | [10045] Operation is not supported on socket. |
10046 | [10046] Protocol family is not supported. |
10047 | [10047] Address family is not supported by protocol family. |
10048 | [10048] Address already in use. |
10049 | [10049] Cannot assign requested address. |
10050 | [10050] Network is down. |
10051 | [10051] Network is unreachable. |
10052 | [10052] Net dropped connection or reset. |
10053 | [10053] Software caused connection abort. |
10054 | [10054] Connection reset by peer. |
10055 | [10055] No buffer space available. |
10056 | [10056] Socket is already connected. |
10057 | [10057] Socket is not connected. |
10058 | [10058] Cannot send after socket shutdown. |
10059 | [10059] Too many references, cannot splice. |
10060 | [10060] Connection timed out. |
10061 | [10061] Connection refused. |
10062 | [10062] Too many levels of symbolic links. |
10063 | [10063] File name is too long. |
10064 | [10064] Host is down. |
10065 | [10065] No route to host. |
10066 | [10066] Directory is not empty |
10067 | [10067] Too many processes. |
10068 | [10068] Too many users. |
10069 | [10069] Disc Quota Exceeded. |
10070 | [10070] Stale NFS file handle. |
10071 | [10071] Too many levels of remote in path. |
10091 | [10091] Network subsystem is unavailable. |
10092 | [10092] WINSOCK DLL Version out of range. |
10093 | [10093] Winsock is not loaded yet. |
11001 | [11001] Host not found. |
11002 | [11002] Nonauthoritative 'Host not found' (try again or check DNS setup). |
11003 | [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP. |
11004 | [11004] Valid name, no data record (check DNS setup). |