SSHReverseTunnel Class
Properties Methods Events Config Settings Errors
The SSHReverseTunnel class provides a simple way to establish a reverse tunnel with a SSH host.
Syntax
SSHReverseTunnel
Remarks
The SSHReverseTunnel class may be used to establish a reverse tunnel with a SSH host. The SSH host will listen for incoming connections on the specified port and forward traffic to the class through the SSH tunnel.
The SSHHost and SSHPort properties specify the SSH server to use. The SSHUser and SSHPassword properties allow the client to authenticate itself with the server. The SSHServerAuthentication event and/or SSHAcceptServerHostKey property allow you to check the server identity. Finally, the SSHStatus event provides information about the SSH handshake.
To begin call SSHLogon to connect to the SSH host. After this method returns the connection to the SSH server has been successfully established. To establish a reverse tunnel call RequestForwarding. This method takes parameters to tell the SSH host on which port to listen.
The class has two modes that allow data to be dealt with directly from the events, or automatically forwarded on to a different endpoint.
Event Based Operation
In this mode any data received by the class over the tunnel causes the events of the class to fire. For instance:
SSHReverseTunnel.RequestForwarding("0.0.0.0",777,"",0);
In the above code forwarding is request from port 777 on the SSHHost. Any data received on port 777 by the SSHHost will be sent to the class. In the above code the last two parameters are empty or 0 indicating to the class that no local forwarding is requested.
Once RequestForwarding returns the SSH reverse tunnel is established and any connection made to the SSH host on the specified port will trigger events of the class to fire allowing you to handle the connection request and data.
When a client connects to the SSH host on the specified port the SSHChannelOpenRequest event will fire. Within this event choose to accept or reject the connection by setting the e.Accept parameter. This event contains details about the connection that may be used when determining whether to accept the connection.
After the channel is established data is received through the SSHChannelData event. To send data over the channel call the SendChannelData method. To close the channel call the CloseChannel method.
Local Forwarding
In this mode the any data received by the class is automatically forwarded to a separate endpoint.
This allows the class to act as a sort of proxy. There is no need to handle data directly in this case.
For instance:
SSHReverseTunnel.RequestForwarding("0.0.0.0",777,"nsoftware.com",80);
In the above code forwarding is request from port 777 on SSHHost. The class is instructed to establish a connection to "nsoftware.com" on port 80 when a client connect to SSHHost on port 777. Any data received from the client connected to SSHHost on port 777 will automatically be forwarded to "nsoftware.com" on port 80. Any data received back from "nsoftware.com" on port 80 will be sent back to the connected client.
In this mode data may flow freely from the client connected to the SSHHost to the endpoint specified in the RequestForwarding method without any additional code required.
Additional Notes
The following events are applicable when a connection is made to the SSH host:
- SSHChannelClosed
- SSHChannelData
- SSHChannelEOF
- SSHChannelOpened
- SSHChannelOpenRequest
- SSHChannelReadyToSend
- SSHChannelRequested
To stop a previously established reverse tunnel call the CancelForwarding method.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
SSHChannelCount | The number of records in the arrays. |
BytesSent | The number of bytes actually sent after a sending channel data. |
ChannelId | An id generated by the class to identify the current SSH channel. |
ConnectedAddress | This property holds the remote address to which the connection was established. |
ConnectedPort | This property holds the remote port to which the connection was established. |
DataToSend | A string of data to be sent to the remote host. |
ForwardingHost | Holds the host to which incoming traffic is forwarded. |
ForwardingPort | Holds the port to which incoming traffic is forwarded. |
OriginAddress | This property holds the address of the client which originated the connection to the reverse tunnel on SSHHost . |
OriginPort | This property holds the port used by the client which originated the connection to the reverse tunnel on SSHHost . |
Service | This property holds the channel type that was requested when opening the channel. |
Connected | This shows whether the class is connected. |
FirewallAutoDetect | This property tells the class whether or not to automatically detect and use firewall system settings, if available. |
FirewallType | This property determines the type of firewall to connect through. |
FirewallHost | This property contains the name or IP address of firewall (optional). |
FirewallPassword | This property contains a password if authentication is to be used when connecting through the firewall. |
FirewallPort | This property contains the transmission control protocol (TCP) port for the firewall Host . |
FirewallUser | This property contains a user name if authentication is to be used connecting through a firewall. |
LocalHost | 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. |
SSHAcceptServerHostKeyEncoded | This is the certificate (PEM/base64 encoded). |
SSHAuthMode | The authentication method to be used the class when calling SSHLogon . |
SSHCertEncoded | This is the certificate (PEM/base64 encoded). |
SSHCertStore | This is the name of the certificate store for the client certificate. |
SSHCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
SSHCertStoreType | This is the type of certificate store for this certificate. |
SSHCertSubject | This is the subject of the certificate used for client authentication. |
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. |
SSHPassword | The password for SSH password-based authentication. |
SSHPort | The port on the SSH server where the SSH service is running; by default, 22. |
SSHUser | The username for SSH authentication. |
Timeout | A 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.
CancelForwarding | Requests the server to stop forwarding a remote TCP/IP port. |
CloseChannel | Closes a existing SSHChannel . |
Config | Sets or retrieves a configuration setting. |
DecodePacket | Decodes a hex-encoded SSH packet. |
DoEvents | 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. |
RequestForwarding | Requests the server to forward a remote TCP/IP port. |
Reset | Reset the class. |
SendChannelData | Used to send data over an SSH 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 . |
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 | Information about errors during data delivery. |
Log | Fires once for each log message. |
ReconnectAttempt | Fires when attempting to reconnect. |
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 the peer 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.
AutoReconnect | Whether to automatically reconnect. |
DefaultChannelIdleTimeout | The inactivity timeout for channels. |
ForwardedPort | The remote port which is forwarded. |
ForwardingLocalHost | The interface on which to bind when forwarding data. |
MaxRetryCount | The maximum number of retries when reconnecting. |
RetryInterval | The interval in seconds between reconnect attempts. |
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. |
MaxPacketSize | The maximum packet size of the channel, in bytes. |
MaxWindowSize | The maximum window size allowed for the channel, in bytes. |
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. |
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. |
MaskSensitive | 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 | Tells the class whether or not to use the system security libraries or an internal implementation. |
SSHChannelCount Property (SSHReverseTunnel Class)
The number of records in the arrays.
Syntax
ANSI (Cross Platform) int GetSSHChannelCount(); Unicode (Windows) INT GetSSHChannelCount();
int ipworksssh_sshreversetunnel_getsshchannelcount(void* lpObj);
int GetSSHChannelCount();
Default Value
0
Remarks
This property controls the size of the following arrays:
- BytesSent
- ChannelId
- ConnectedAddress
- ConnectedPort
- DataToSend
- FirewallAutoDetect
- FirewallHost
- FirewallPassword
- FirewallPort
- FirewallType
- FirewallUser
- ForwardingHost
- ForwardingPort
- OriginAddress
- OriginPort
- Service
- SSHAcceptServerHostKeyEncoded
- SSHCertEncoded
- SSHCertStore
- SSHCertStorePassword
- SSHCertStoreType
- SSHCertSubject
This property is read-only and not available at design time.
Data Type
Integer
BytesSent Property (SSHReverseTunnel Class)
The number of bytes actually sent after a sending channel data.
Syntax
ANSI (Cross Platform) int GetBytesSent(int iSSHChannelId); Unicode (Windows) INT GetBytesSent(INT iSSHChannelId);
int ipworksssh_sshreversetunnel_getbytessent(void* lpObj, int sshchannelid);
int GetBytesSent(int iSSHChannelId);
Default Value
0
Remarks
The number of bytes actually sent after a sending channel data.
The SSHChannelId parameter specifies the index of the item in the array. The size of the array is controlled by the SSHChannelCount property.
This property is read-only and not available at design time.
Data Type
Integer
ChannelId Property (SSHReverseTunnel Class)
An id generated by the class to identify the current SSH channel.
Syntax
ANSI (Cross Platform) char* GetChannelId(int iSSHChannelId); Unicode (Windows) LPWSTR GetChannelId(INT iSSHChannelId);
char* ipworksssh_sshreversetunnel_getchannelid(void* lpObj, int sshchannelid);
QString GetChannelId(int iSSHChannelId);
Default Value
""
Remarks
An id generated by the class to identify the current SSH channel. This id is unique to this channel.
The SSHChannelId parameter specifies the index of the item in the array. The size of the array is controlled by the SSHChannelCount property.
This property is read-only and not available at design time.
Data Type
String
ConnectedAddress Property (SSHReverseTunnel Class)
This property holds the remote address to which the connection was established.
Syntax
ANSI (Cross Platform) char* GetConnectedAddress(int iSSHChannelId); Unicode (Windows) LPWSTR GetConnectedAddress(INT iSSHChannelId);
char* ipworksssh_sshreversetunnel_getconnectedaddress(void* lpObj, int sshchannelid);
QString GetConnectedAddress(int iSSHChannelId);
Default Value
""
Remarks
This property holds the remote address to which the connection was established. This should match the Address parameter passed to the RequestForwarding method.
The SSHChannelId parameter specifies the index of the item in the array. The size of the array is controlled by the SSHChannelCount property.
This property is read-only and not available at design time.
Data Type
String
ConnectedPort Property (SSHReverseTunnel Class)
This property holds the remote port to which the connection was established.
Syntax
ANSI (Cross Platform) int GetConnectedPort(int iSSHChannelId); Unicode (Windows) INT GetConnectedPort(INT iSSHChannelId);
int ipworksssh_sshreversetunnel_getconnectedport(void* lpObj, int sshchannelid);
int GetConnectedPort(int iSSHChannelId);
Default Value
0
Remarks
This property holds the remote port to which the connection was established. This should match the Port parameter passed to the RequestForwarding method.
The SSHChannelId parameter specifies the index of the item in the array. The size of the array is controlled by the SSHChannelCount property.
This property is read-only and not available at design time.
Data Type
Integer
DataToSend Property (SSHReverseTunnel Class)
A string of data to be sent to the remote host.
Syntax
ANSI (Cross Platform) int SetDataToSend(int iSSHChannelId, const char* lpDataToSend, int lenDataToSend); Unicode (Windows) INT SetDataToSend(INT iSSHChannelId, LPCSTR lpDataToSend, INT lenDataToSend);
int ipworksssh_sshreversetunnel_setdatatosend(void* lpObj, int sshchannelid, const char* lpDataToSend, int lenDataToSend);
int SetDataToSend(int iSSHChannelId, QByteArray qbaDataToSend);
Default Value
""
Remarks
A string of data to be sent to the remote host. Write-only property.
Assigning a string to the DataToSend makes the class send the string to the remote host.
Note:It is recommended to use the SendText or SendBytes method instead of setting this property.
The SSHChannelId parameter specifies the index of the item in the array. The size of the array is controlled by the SSHChannelCount property.
This property is write-only and not available at design time.
Data Type
Binary String
ForwardingHost Property (SSHReverseTunnel Class)
Holds the host to which incoming traffic is forwarded.
Syntax
ANSI (Cross Platform) char* GetForwardingHost(int iSSHChannelId); Unicode (Windows) LPWSTR GetForwardingHost(INT iSSHChannelId);
char* ipworksssh_sshreversetunnel_getforwardinghost(void* lpObj, int sshchannelid);
QString GetForwardingHost(int iSSHChannelId);
Default Value
""
Remarks
Holds the host to which incoming traffic is forwarded. This is only applicable if local forwarding was requested when calling RequestForwarding.
The SSHChannelId parameter specifies the index of the item in the array. The size of the array is controlled by the SSHChannelCount property.
This property is read-only and not available at design time.
Data Type
String
ForwardingPort Property (SSHReverseTunnel Class)
Holds the port to which incoming traffic is forwarded.
Syntax
ANSI (Cross Platform) int GetForwardingPort(int iSSHChannelId); Unicode (Windows) INT GetForwardingPort(INT iSSHChannelId);
int ipworksssh_sshreversetunnel_getforwardingport(void* lpObj, int sshchannelid);
int GetForwardingPort(int iSSHChannelId);
Default Value
0
Remarks
Holds the port to which incoming traffic is forwarded. This is only applicable if local forwarding was requested when calling RequestForwarding.
The SSHChannelId parameter specifies the index of the item in the array. The size of the array is controlled by the SSHChannelCount property.
This property is read-only and not available at design time.
Data Type
Integer
OriginAddress Property (SSHReverseTunnel Class)
This property holds the address of the client which originated the connection to the reverse tunnel on SSHHost .
Syntax
ANSI (Cross Platform) char* GetOriginAddress(int iSSHChannelId); Unicode (Windows) LPWSTR GetOriginAddress(INT iSSHChannelId);
char* ipworksssh_sshreversetunnel_getoriginaddress(void* lpObj, int sshchannelid);
QString GetOriginAddress(int iSSHChannelId);
Default Value
""
Remarks
This property holds the address of the client which originated the connection to the reverse tunnel on SSHHost.
The SSHChannelId parameter specifies the index of the item in the array. The size of the array is controlled by the SSHChannelCount property.
This property is read-only and not available at design time.
Data Type
String
OriginPort Property (SSHReverseTunnel Class)
This property holds the port used by the client which originated the connection to the reverse tunnel on SSHHost .
Syntax
ANSI (Cross Platform) int GetOriginPort(int iSSHChannelId); Unicode (Windows) INT GetOriginPort(INT iSSHChannelId);
int ipworksssh_sshreversetunnel_getoriginport(void* lpObj, int sshchannelid);
int GetOriginPort(int iSSHChannelId);
Default Value
0
Remarks
This property holds the port used by the client which originated the connection to the reverse tunnel on SSHHost.
The SSHChannelId parameter specifies the index of the item in the array. The size of the array is controlled by the SSHChannelCount property.
This property is read-only and not available at design time.
Data Type
Integer
Service Property (SSHReverseTunnel Class)
This property holds the channel type that was requested when opening the channel.
Syntax
ANSI (Cross Platform) char* GetService(int iSSHChannelId); Unicode (Windows) LPWSTR GetService(INT iSSHChannelId);
char* ipworksssh_sshreversetunnel_getservice(void* lpObj, int sshchannelid);
QString GetService(int iSSHChannelId);
Default Value
""
Remarks
This property holds the channel type that was requested when opening the channel. For instance "session" or "forwarded-tcpip".
The SSHChannelId parameter specifies the index of the item in the array. The size of the array is controlled by the SSHChannelCount property.
This property is read-only and not available at design time.
Data Type
String
Connected Property (SSHReverseTunnel Class)
This shows whether the class is connected.
Syntax
ANSI (Cross Platform) int GetConnected();
int SetConnected(int bConnected); Unicode (Windows) BOOL GetConnected();
INT SetConnected(BOOL bConnected);
int ipworksssh_sshreversetunnel_getconnected(void* lpObj);
int ipworksssh_sshreversetunnel_setconnected(void* lpObj, int bConnected);
bool GetConnected();
int SetConnected(bool bConnected);
Default Value
FALSE
Remarks
This property is used to determine whether or not the class is connected to the remote host.
Note: It is recommended to use the Connect or Disconnect method instead of setting this property.
This property is not available at design time.
Data Type
Boolean
FirewallAutoDetect Property (SSHReverseTunnel Class)
This property tells the class whether or not to automatically detect and use firewall system settings, if available.
Syntax
ANSI (Cross Platform) int GetFirewallAutoDetect();
int SetFirewallAutoDetect(int bFirewallAutoDetect); Unicode (Windows) BOOL GetFirewallAutoDetect();
INT SetFirewallAutoDetect(BOOL bFirewallAutoDetect);
int ipworksssh_sshreversetunnel_getfirewallautodetect(void* lpObj);
int ipworksssh_sshreversetunnel_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);
bool GetFirewallAutoDetect();
int SetFirewallAutoDetect(bool bFirewallAutoDetect);
Default Value
FALSE
Remarks
This property tells the class whether or not to automatically detect and use firewall system settings, if available.
Data Type
Boolean
FirewallType Property (SSHReverseTunnel Class)
This property determines the type of firewall to connect through.
Syntax
ANSI (Cross Platform) int GetFirewallType();
int SetFirewallType(int iFirewallType); Unicode (Windows) INT GetFirewallType();
INT SetFirewallType(INT iFirewallType);
Possible Values
FW_NONE(0),
FW_TUNNEL(1),
FW_SOCKS4(2),
FW_SOCKS5(3),
FW_SOCKS4A(10)
int ipworksssh_sshreversetunnel_getfirewalltype(void* lpObj);
int ipworksssh_sshreversetunnel_setfirewalltype(void* lpObj, int iFirewallType);
int GetFirewallType();
int SetFirewallType(int iFirewallType);
Default Value
0
Remarks
This property determines the type of firewall to connect through. The applicable values are as follows:
fwNone (0) | No firewall (default setting). |
fwTunnel (1) | Connect through a tunneling proxy. FirewallPort is set to 80. |
fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. FirewallPort is set to 1080. |
fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. FirewallPort is set to 1080. |
fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. FirewallPort is set to 1080. |
Data Type
Integer
FirewallHost Property (SSHReverseTunnel Class)
This property contains the name or IP address of firewall (optional).
Syntax
ANSI (Cross Platform) char* GetFirewallHost();
int SetFirewallHost(const char* lpszFirewallHost); Unicode (Windows) LPWSTR GetFirewallHost();
INT SetFirewallHost(LPCWSTR lpszFirewallHost);
char* ipworksssh_sshreversetunnel_getfirewallhost(void* lpObj);
int ipworksssh_sshreversetunnel_setfirewallhost(void* lpObj, const char* lpszFirewallHost);
QString GetFirewallHost();
int SetFirewallHost(QString qsFirewallHost);
Default Value
""
Remarks
This property contains the name or IP address of firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.
If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error.
Data Type
String
FirewallPassword Property (SSHReverseTunnel Class)
This property contains a password if authentication is to be used when connecting through the firewall.
Syntax
ANSI (Cross Platform) char* GetFirewallPassword();
int SetFirewallPassword(const char* lpszFirewallPassword); Unicode (Windows) LPWSTR GetFirewallPassword();
INT SetFirewallPassword(LPCWSTR lpszFirewallPassword);
char* ipworksssh_sshreversetunnel_getfirewallpassword(void* lpObj);
int ipworksssh_sshreversetunnel_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);
QString GetFirewallPassword();
int SetFirewallPassword(QString qsFirewallPassword);
Default Value
""
Remarks
This property contains a password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.
Data Type
String
FirewallPort Property (SSHReverseTunnel Class)
This property contains the transmission control protocol (TCP) port for the firewall Host .
Syntax
ANSI (Cross Platform) int GetFirewallPort();
int SetFirewallPort(int iFirewallPort); Unicode (Windows) INT GetFirewallPort();
INT SetFirewallPort(INT iFirewallPort);
int ipworksssh_sshreversetunnel_getfirewallport(void* lpObj);
int ipworksssh_sshreversetunnel_setfirewallport(void* lpObj, int iFirewallPort);
int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);
Default Value
0
Remarks
This property contains the transmission control protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.
Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.
Data Type
Integer
FirewallUser Property (SSHReverseTunnel Class)
This property contains a user name if authentication is to be used connecting through a firewall.
Syntax
ANSI (Cross Platform) char* GetFirewallUser();
int SetFirewallUser(const char* lpszFirewallUser); Unicode (Windows) LPWSTR GetFirewallUser();
INT SetFirewallUser(LPCWSTR lpszFirewallUser);
char* ipworksssh_sshreversetunnel_getfirewalluser(void* lpObj);
int ipworksssh_sshreversetunnel_setfirewalluser(void* lpObj, const char* lpszFirewallUser);
QString GetFirewallUser();
int SetFirewallUser(QString qsFirewallUser);
Default Value
""
Remarks
This property contains a user name if authentication is to be used connecting through a firewall. If the FirewallHost is specified, this property and FirewallPassword properties are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.
Data Type
String
LocalHost Property (SSHReverseTunnel Class)
The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
Syntax
ANSI (Cross Platform) char* GetLocalHost();
int SetLocalHost(const char* lpszLocalHost); Unicode (Windows) LPWSTR GetLocalHost();
INT SetLocalHost(LPCWSTR lpszLocalHost);
char* ipworksssh_sshreversetunnel_getlocalhost(void* lpObj);
int ipworksssh_sshreversetunnel_setlocalhost(void* lpObj, const char* lpszLocalHost);
QString GetLocalHost();
int SetLocalHost(QString qsLocalHost);
Default Value
""
Remarks
The LocalHost property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.
In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.
If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).
NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window.
Data Type
String
LocalPort Property (SSHReverseTunnel Class)
The TCP port in the local host where the class binds.
Syntax
ANSI (Cross Platform) int GetLocalPort();
int SetLocalPort(int iLocalPort); Unicode (Windows) INT GetLocalPort();
INT SetLocalPort(INT iLocalPort);
int ipworksssh_sshreversetunnel_getlocalport(void* lpObj);
int ipworksssh_sshreversetunnel_setlocalport(void* lpObj, int iLocalPort);
int GetLocalPort();
int SetLocalPort(int iLocalPort);
Default Value
0
Remarks
This property must be set before a connection is attempted. It instructs the class to bind to a specific port (or communication endpoint) in the local machine.
Setting this property to 0 (default) enables the system to choose an open port at random. The chosen port will be returned by the LocalPort property after the connection is established.
LocalPort cannot be changed once a connection is made. Any attempt to set this property when a connection is active will generate an error.
This property is useful when trying to connect to services that require a trusted port in the client side.
Data Type
Integer
SSHAcceptServerHostKeyEncoded Property (SSHReverseTunnel Class)
This is the certificate (PEM/base64 encoded).
Syntax
ANSI (Cross Platform) int GetSSHAcceptServerHostKeyEncoded(char* &lpSSHAcceptServerHostKeyEncoded, int &lenSSHAcceptServerHostKeyEncoded);
int SetSSHAcceptServerHostKeyEncoded(const char* lpSSHAcceptServerHostKeyEncoded, int lenSSHAcceptServerHostKeyEncoded); Unicode (Windows) INT GetSSHAcceptServerHostKeyEncoded(LPSTR &lpSSHAcceptServerHostKeyEncoded, INT &lenSSHAcceptServerHostKeyEncoded);
INT SetSSHAcceptServerHostKeyEncoded(LPCSTR lpSSHAcceptServerHostKeyEncoded, INT lenSSHAcceptServerHostKeyEncoded);
int ipworksssh_sshreversetunnel_getsshacceptserverhostkeyencoded(void* lpObj, char** lpSSHAcceptServerHostKeyEncoded, int* lenSSHAcceptServerHostKeyEncoded);
int ipworksssh_sshreversetunnel_setsshacceptserverhostkeyencoded(void* lpObj, const char* lpSSHAcceptServerHostKeyEncoded, int lenSSHAcceptServerHostKeyEncoded);
QByteArray GetSSHAcceptServerHostKeyEncoded();
int SetSSHAcceptServerHostKeyEncoded(QByteArray qbaSSHAcceptServerHostKeyEncoded);
Default Value
""
Remarks
This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSHAcceptServerHostKeyStore and SSHAcceptServerHostKeySubject properties also may be used to specify a certificate.
When SSHAcceptServerHostKeyEncoded is set, a search is initiated in the current SSHAcceptServerHostKeyStore for the private key of the certificate. If the key is found, SSHAcceptServerHostKeySubject is updated to reflect the full subject of the selected certificate; otherwise, SSHAcceptServerHostKeySubject is set to an empty string.
This property is not available at design time.
Data Type
Binary String
SSHAuthMode Property (SSHReverseTunnel Class)
The authentication method to be used the class when calling SSHLogon .
Syntax
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_CUSTOM(6)
int ipworksssh_sshreversetunnel_getsshauthmode(void* lpObj);
int ipworksssh_sshreversetunnel_setsshauthmode(void* lpObj, int iSSHAuthMode);
int GetSSHAuthMode();
int SetSSHAuthMode(int iSSHAuthMode);
Default Value
2
Remarks
The SSH Authentication specification (RFC 4252) specifies multiple methods by which a user can be authenticated by an SSH server. When a call is made to SSHLogon, the class will connect to the SSH server and establish the security layer. After the connection has been secured, the client will send an authentication request to the SSHHost containing the SSHUser. The server will respond containing a list of methods by which that user may be authenticated.
The class will attempt to authenticate the user by one of those methods based on the value of SSHAuthMode and other property values supplied by the user. Currently, the class supports the following authentication methods:
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 in the .NET client. |
amCustom (6) | 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
SSHCertEncoded Property (SSHReverseTunnel Class)
This is the certificate (PEM/base64 encoded).
Syntax
ANSI (Cross Platform) int GetSSHCertEncoded(char* &lpSSHCertEncoded, int &lenSSHCertEncoded);
int SetSSHCertEncoded(const char* lpSSHCertEncoded, int lenSSHCertEncoded); Unicode (Windows) INT GetSSHCertEncoded(LPSTR &lpSSHCertEncoded, INT &lenSSHCertEncoded);
INT SetSSHCertEncoded(LPCSTR lpSSHCertEncoded, INT lenSSHCertEncoded);
int ipworksssh_sshreversetunnel_getsshcertencoded(void* lpObj, char** lpSSHCertEncoded, int* lenSSHCertEncoded);
int ipworksssh_sshreversetunnel_setsshcertencoded(void* lpObj, const char* lpSSHCertEncoded, int lenSSHCertEncoded);
QByteArray GetSSHCertEncoded();
int SetSSHCertEncoded(QByteArray qbaSSHCertEncoded);
Default Value
""
Remarks
This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSHCertStore and SSHCertSubject properties also may be used to specify a certificate.
When SSHCertEncoded is set, a search is initiated in the current SSHCertStore for the private key of the certificate. If the key is found, SSHCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSHCertSubject is set to an empty string.
This property is not available at design time.
Data Type
Binary String
SSHCertStore Property (SSHReverseTunnel Class)
This is the name of the certificate store for the client certificate.
Syntax
ANSI (Cross Platform) int GetSSHCertStore(char* &lpSSHCertStore, int &lenSSHCertStore);
int SetSSHCertStore(const char* lpSSHCertStore, int lenSSHCertStore); Unicode (Windows) INT GetSSHCertStore(LPSTR &lpSSHCertStore, INT &lenSSHCertStore);
INT SetSSHCertStore(LPCSTR lpSSHCertStore, INT lenSSHCertStore);
int ipworksssh_sshreversetunnel_getsshcertstore(void* lpObj, char** lpSSHCertStore, int* lenSSHCertStore);
int ipworksssh_sshreversetunnel_setsshcertstore(void* lpObj, const char* lpSSHCertStore, int lenSSHCertStore);
QByteArray GetSSHCertStore();
int SetSSHCertStore(QByteArray qbaSSHCertStore);
Default Value
"MY"
Remarks
This is the name of the certificate store for the client certificate.
The SSHCertStoreType property denotes the type of the certificate store specified by SSHCertStore. If the store is password protected, specify the password in SSHCertStorePassword.
SSHCertStore is used in conjunction with the SSHCertSubject property to specify client certificates. If SSHCertStore has a value, and SSHCertSubject or SSHCertEncoded is set, a search for a certificate is initiated. Please see the SSHCertSubject property for details.
Designations of certificate stores are platform-dependent.
The following are designations of 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. PKCS12 certificate store).
Data Type
Binary String
SSHCertStorePassword Property (SSHReverseTunnel Class)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
ANSI (Cross Platform) char* GetSSHCertStorePassword();
int SetSSHCertStorePassword(const char* lpszSSHCertStorePassword); Unicode (Windows) LPWSTR GetSSHCertStorePassword();
INT SetSSHCertStorePassword(LPCWSTR lpszSSHCertStorePassword);
char* ipworksssh_sshreversetunnel_getsshcertstorepassword(void* lpObj);
int ipworksssh_sshreversetunnel_setsshcertstorepassword(void* lpObj, const char* lpszSSHCertStorePassword);
QString GetSSHCertStorePassword();
int SetSSHCertStorePassword(QString qsSSHCertStorePassword);
Default Value
""
Remarks
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Data Type
String
SSHCertStoreType Property (SSHReverseTunnel Class)
This is the type of certificate store for this certificate.
Syntax
ANSI (Cross Platform) int GetSSHCertStoreType();
int SetSSHCertStoreType(int iSSHCertStoreType); Unicode (Windows) INT GetSSHCertStoreType();
INT SetSSHCertStoreType(INT iSSHCertStoreType);
Possible Values
CST_USER(0),
CST_MACHINE(1),
CST_PFXFILE(2),
CST_PFXBLOB(3),
CST_JKSFILE(4),
CST_JKSBLOB(5),
CST_PEMKEY_FILE(6),
CST_PEMKEY_BLOB(7),
CST_PUBLIC_KEY_FILE(8),
CST_PUBLIC_KEY_BLOB(9),
CST_SSHPUBLIC_KEY_BLOB(10),
CST_P7BFILE(11),
CST_P7BBLOB(12),
CST_SSHPUBLIC_KEY_FILE(13),
CST_PPKFILE(14),
CST_PPKBLOB(15),
CST_XMLFILE(16),
CST_XMLBLOB(17),
CST_JWKFILE(18),
CST_JWKBLOB(19),
CST_SECURITY_KEY(20),
CST_BCFKSFILE(21),
CST_BCFKSBLOB(22),
CST_PKCS11(23),
CST_AUTO(99)
int ipworksssh_sshreversetunnel_getsshcertstoretype(void* lpObj);
int ipworksssh_sshreversetunnel_setsshcertstoretype(void* lpObj, int iSSHCertStoreType);
int GetSSHCertStoreType();
int SetSSHCertStoreType(int iSSHCertStoreType);
Default Value
0
Remarks
This is the type of certificate store for this certificate.
The class supports both public and private keys in a variety of formats. When the cstAuto value is used the class will automatically determine the type. This property can take one of the following values:
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 (PKCS12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) 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 PKCS7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS7 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 PKCS11 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 PKCS11 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 SSHCertStore and set SSHCertStorePassword 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. |
Data Type
Integer
SSHCertSubject Property (SSHReverseTunnel Class)
This is the subject of the certificate used for client authentication.
Syntax
ANSI (Cross Platform) char* GetSSHCertSubject();
int SetSSHCertSubject(const char* lpszSSHCertSubject); Unicode (Windows) LPWSTR GetSSHCertSubject();
INT SetSSHCertSubject(LPCWSTR lpszSSHCertSubject);
char* ipworksssh_sshreversetunnel_getsshcertsubject(void* lpObj);
int ipworksssh_sshreversetunnel_setsshcertsubject(void* lpObj, const char* lpszSSHCertSubject);
QString GetSSHCertSubject();
int SetSSHCertSubject(QString qsSSHCertSubject);
Default Value
""
Remarks
This is the subject of the certificate used for client authentication.
This property must be set after all other certificate properites are set. When this property is set, a search is performed in the current certificate store certificate with matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are displayed below.
Field | Meaning |
CN | Common Name. This is commonly a host name 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.
Data Type
String
SSHCompressionAlgorithms Property (SSHReverseTunnel 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_sshreversetunnel_getsshcompressionalgorithms(void* lpObj);
int ipworksssh_sshreversetunnel_setsshcompressionalgorithms(void* lpObj, const char* lpszSSHCompressionAlgorithms);
QString GetSSHCompressionAlgorithms();
int SetSSHCompressionAlgorithms(QString qsSSHCompressionAlgorithms);
Default Value
"none,zlib"
Remarks
During the SSH handshake, this list will be used to negotiate the compression algorithm to be used between the client and server. This list is used for both directions: client to server and server to client. When negotiating algorithms, each side sends a list of all algorithms it supports or allows. The algorithm chosen for each direction is the first algorithm to appear in the sender's list that the receiver supports, so it is important to list multiple algorithms in preferential order. If no algorithm can be agreed upon, the class will raise an error and the connection will be aborted.
At least one supported algorithm must appear in this list. The following compression algorithms are supported by the class:
- zlib
- zlib@openssh.com
- none
Data Type
String
SSHEncryptionAlgorithms Property (SSHReverseTunnel Class)
A comma-separated list containing all allowable encryption algorithms.
Syntax
ANSI (Cross Platform) char* GetSSHEncryptionAlgorithms();
int SetSSHEncryptionAlgorithms(const char* lpszSSHEncryptionAlgorithms); Unicode (Windows) LPWSTR GetSSHEncryptionAlgorithms();
INT SetSSHEncryptionAlgorithms(LPCWSTR lpszSSHEncryptionAlgorithms);
char* ipworksssh_sshreversetunnel_getsshencryptionalgorithms(void* lpObj);
int ipworksssh_sshreversetunnel_setsshencryptionalgorithms(void* lpObj, const char* lpszSSHEncryptionAlgorithms);
QString GetSSHEncryptionAlgorithms();
int SetSSHEncryptionAlgorithms(QString qsSSHEncryptionAlgorithms);
Default Value
"aes256-ctr,aes192-ctr,aes128-ctr,aes256-cbc,aes192-cbc,aes128-cbc,3des-ctr,3des-cbc,blowfish-cbc,arcfour256,arcfour128,arcfour,cast128-cbc,aes256-gcm@openssh.com,aes128-gcm@openssh.com,chacha20-poly1305@openssh.com"
Remarks
During the SSH handshake, this list will be used to negotiate the encryption algorithm to be used between the client and server. This list is used for both directions: client to server and server to client. When negotiating algorithms, each side sends a list of all algorithms it supports or allows. The algorithm chosen for each direction is the first algorithm to appear in the sender's list that the receiver supports, so it is important to list multiple algorithms in preferential order. If no algorithm can be agreed upon, the class will raise an error and the connection will be aborted.
At least one supported algorithm must appear in this list. The following encryption algorithms are supported by the class:
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 (SSHReverseTunnel 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_sshreversetunnel_getsshhost(void* lpObj);
int ipworksssh_sshreversetunnel_setsshhost(void* lpObj, const char* lpszSSHHost);
QString GetSSHHost();
int SetSSHHost(QString qsSSHHost);
Default Value
""
Remarks
The SSHHost property specifies the IP address (IP number in dotted internet format) or Domain Name of the remote host. It is set before a connection is attempted and cannot be changed once a connection is established.
If the SSHHost property is set to a Domain Name, a DNS request is initiated, and upon successful termination of the request, the SSHHost property is set to the corresponding address. If the search is not successful, an error is returned.
The SSHHost must be the same host that will be assumed for SSH as for the remote service being connected to.
Data Type
String
SSHPassword Property (SSHReverseTunnel Class)
The password for SSH password-based authentication.
Syntax
ANSI (Cross Platform) char* GetSSHPassword();
int SetSSHPassword(const char* lpszSSHPassword); Unicode (Windows) LPWSTR GetSSHPassword();
INT SetSSHPassword(LPCWSTR lpszSSHPassword);
char* ipworksssh_sshreversetunnel_getsshpassword(void* lpObj);
int ipworksssh_sshreversetunnel_setsshpassword(void* lpObj, const char* lpszSSHPassword);
QString GetSSHPassword();
int SetSSHPassword(QString qsSSHPassword);
Default Value
""
Remarks
SSHPassword specifies the password which is used to authenticate the client to the SSH server.
Data Type
String
SSHPort Property (SSHReverseTunnel Class)
The port on the SSH server where the SSH service is running; by default, 22.
Syntax
ANSI (Cross Platform) int GetSSHPort();
int SetSSHPort(int iSSHPort); Unicode (Windows) INT GetSSHPort();
INT SetSSHPort(INT iSSHPort);
int ipworksssh_sshreversetunnel_getsshport(void* lpObj);
int ipworksssh_sshreversetunnel_setsshport(void* lpObj, int iSSHPort);
int GetSSHPort();
int SetSSHPort(int iSSHPort);
Default Value
22
Remarks
The SSHPort specifies a service port on the SSH host to connect to.
A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before a connection is attempted and cannot be changed once a connection is established. Any attempt to change this property while connected will fail with an error.
Data Type
Integer
SSHUser Property (SSHReverseTunnel Class)
The username for SSH authentication.
Syntax
ANSI (Cross Platform) char* GetSSHUser();
int SetSSHUser(const char* lpszSSHUser); Unicode (Windows) LPWSTR GetSSHUser();
INT SetSSHUser(LPCWSTR lpszSSHUser);
char* ipworksssh_sshreversetunnel_getsshuser(void* lpObj);
int ipworksssh_sshreversetunnel_setsshuser(void* lpObj, const char* lpszSSHUser);
QString GetSSHUser();
int SetSSHUser(QString qsSSHUser);
Default Value
""
Remarks
SSHUser specifies the username which is used to authenticate the client to the SSH server. This property is required.
Example (User/Password Auth):
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 (SSHReverseTunnel Class)
A timeout for the class.
Syntax
ANSI (Cross Platform) int GetTimeout();
int SetTimeout(int iTimeout); Unicode (Windows) INT GetTimeout();
INT SetTimeout(INT iTimeout);
int ipworksssh_sshreversetunnel_gettimeout(void* lpObj);
int ipworksssh_sshreversetunnel_settimeout(void* lpObj, int iTimeout);
int GetTimeout();
int SetTimeout(int iTimeout);
Default Value
60
Remarks
If the Timeout property is set to 0, all operations return immediately, potentially failing with a WOULDBLOCK error if data cannot be sent immediately.
If Timeout is set to a positive value, data is sent in a blocking manner and the class will wait for the operation to complete before returning control. The class will handle any potential WOULDBLOCK errors internally and automatically retry the operation for a maximum of Timeout seconds.
The class will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.
If Timeout expires, and the operation is not yet complete, the class fails with an error.
Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.
The default value for the Timeout property is 60 seconds.
Data Type
Integer
CancelForwarding Method (SSHReverseTunnel Class)
Requests the server to stop forwarding a remote TCP/IP port.
Syntax
ANSI (Cross Platform) int CancelForwarding(const char* lpszAddress, int iPort); Unicode (Windows) INT CancelForwarding(LPCWSTR lpszAddress, INT iPort);
int ipworksssh_sshreversetunnel_cancelforwarding(void* lpObj, const char* lpszAddress, int iPort);
int CancelForwarding(const QString& qsAddress, int iPort);
Remarks
The CancelForwarding cancels a previous TCP/IP port forwarding request. When calling it, provide the same argument values you provided on the RequestForwarding call.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
CloseChannel Method (SSHReverseTunnel Class)
Closes a existing SSHChannel .
Syntax
ANSI (Cross Platform) int CloseChannel(const char* lpszChannelId); Unicode (Windows) INT CloseChannel(LPCWSTR lpszChannelId);
int ipworksssh_sshreversetunnel_closechannel(void* lpObj, const char* lpszChannelId);
int CloseChannel(const QString& qsChannelId);
Remarks
ChannelId is the identifier for the SSH channel to be closed.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Config Method (SSHReverseTunnel Class)
Sets or retrieves a configuration setting.
Syntax
ANSI (Cross Platform) char* Config(const char* lpszConfigurationString); Unicode (Windows) LPWSTR Config(LPCWSTR lpszConfigurationString);
char* ipworksssh_sshreversetunnel_config(void* lpObj, const char* lpszConfigurationString);
QString Config(const QString& qsConfigurationString);
Remarks
Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
Error Handling (C++)
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
DecodePacket Method (SSHReverseTunnel Class)
Decodes a hex-encoded SSH packet.
Syntax
ANSI (Cross Platform) char* DecodePacket(const char* lpszEncodedPacket, int *lpSize = NULL); Unicode (Windows) LPSTR DecodePacket(LPCWSTR lpszEncodedPacket, LPINT lpSize = NULL);
char* ipworksssh_sshreversetunnel_decodepacket(void* lpObj, const char* lpszEncodedPacket, int *lpSize);
QByteArray DecodePacket(const QString& qsEncodedPacket);
Remarks
This method is used to decode an SSH packet created by EncodePacket.
Note: This method is only applicable for reading and creating SSH packets for use within the SSHCustomAuth event.
Error Handling (C++)
This method returns a Binary String value (with length lpSize); after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
DoEvents Method (SSHReverseTunnel Class)
Processes events from the internal message queue.
Syntax
ANSI (Cross Platform) int DoEvents(); Unicode (Windows) INT DoEvents();
int ipworksssh_sshreversetunnel_doevents(void* lpObj);
int DoEvents();
Remarks
When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
EncodePacket Method (SSHReverseTunnel Class)
Hex encodes an SSH packet.
Syntax
ANSI (Cross Platform) char* EncodePacket(const char* lpPacket, int lenPacket); Unicode (Windows) LPWSTR EncodePacket(LPCSTR lpPacket, INT lenPacket);
char* ipworksssh_sshreversetunnel_encodepacket(void* lpObj, const char* lpPacket, int lenPacket);
QString EncodePacket(QByteArray qbaPacket);
Remarks
This method is used to encode a raw SSH packet created by SetSSHParam.
Note: This method is only applicable for reading and creating SSH packets for use within the SSHCustomAuth event.
Error Handling (C++)
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
ExchangeKeys Method (SSHReverseTunnel Class)
Causes the class to exchange a new set of session keys with the SSHHost .
Syntax
ANSI (Cross Platform) int ExchangeKeys(); Unicode (Windows) INT ExchangeKeys();
int ipworksssh_sshreversetunnel_exchangekeys(void* lpObj);
int ExchangeKeys();
Remarks
SSH key renegotiation can be initiated by either end of an established SSH connection. ExchangeKeys allows the user to start such a renegotiation with the SSHHost. During this process, SSHStatus events will fire containing updates regarding the key negotiation process.
The SSH 2.0 specification recommends that key renegotiation be done once for 2 gigabytes (GB) of data processed by the connection, or once every day. This makes it more difficult to break the security of data-intensive or long-lived connections.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
GetSSHParam Method (SSHReverseTunnel Class)
Used to read a field from an SSH packet's payload.
Syntax
ANSI (Cross Platform) char* GetSSHParam(const char* lpPayload, int lenPayload, const char* lpszField); Unicode (Windows) LPWSTR GetSSHParam(LPCSTR lpPayload, INT lenPayload, LPCWSTR lpszField);
char* ipworksssh_sshreversetunnel_getsshparam(void* lpObj, const char* lpPayload, int lenPayload, const char* lpszField);
QString GetSSHParam(QByteArray qbaPayload, const QString& qsField);
Remarks
This method is used to read the value of a particular field from an SSH packet's payload. Payload should contain the full payload of a packet received by an event such as SSHChannelRequest. Field is the name of a field to be read out of the packet.
The following is a list of the names of well-known channel request field names and their encodings:
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.
Note: This method is only applicable for reading and creating SSH packets for use within the SSHCustomAuth event.
Error Handling (C++)
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
GetSSHParamBytes Method (SSHReverseTunnel Class)
Used to read a field from an SSH packet's payload.
Syntax
ANSI (Cross Platform) char* GetSSHParamBytes(const char* lpPayload, int lenPayload, const char* lpszField, int *lpSize = NULL); Unicode (Windows) LPSTR GetSSHParamBytes(LPCSTR lpPayload, INT lenPayload, LPCWSTR lpszField, LPINT lpSize = NULL);
char* ipworksssh_sshreversetunnel_getsshparambytes(void* lpObj, const char* lpPayload, int lenPayload, const char* lpszField, int *lpSize);
QByteArray GetSSHParamBytes(QByteArray qbaPayload, const QString& qsField);
Remarks
This method is the same as calling GetSSHParam, but returns raw bytes instead of strings.
Note: This method is only applicable for reading and creating SSH packets for use within the SSHCustomAuth event.
Error Handling (C++)
This method returns a Binary String value (with length lpSize); after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
RequestForwarding Method (SSHReverseTunnel Class)
Requests the server to forward a remote TCP/IP port.
Syntax
ANSI (Cross Platform) int RequestForwarding(const char* lpszAddress, int iPort, const char* lpszForwardingHost, int iForwardingPort); Unicode (Windows) INT RequestForwarding(LPCWSTR lpszAddress, INT iPort, LPCWSTR lpszForwardingHost, INT iForwardingPort);
int ipworksssh_sshreversetunnel_requestforwarding(void* lpObj, const char* lpszAddress, int iPort, const char* lpszForwardingHost, int iForwardingPort);
int RequestForwarding(const QString& qsAddress, int iPort, const QString& qsForwardingHost, int iForwardingPort);
Remarks
The RequestForwarding method asks the server to listen at the specified TCP/IP Address and Port for connection requests and then forward them as new SSH channels to the class.
ForwardingHost and ForwardingPort may be used to specify an address and port to which traffic will automatically be forwarded. If automatic forwarding is not desired specify an empty string ("") for the ForwardingHost parameter.
The Address argument can specified in different ways:
- "" means that connections are to be accepted on all protocol families supported by the server.
- "0.0.0.0" means to listen on all IPv4 addresses.
- "::" means to listen on all IPv6 addresses.
- "localhost" means to listen on all protocol families supported by the SSH implementation on loopback addresses only.
- "127.0.0.1" and "::1" indicate listening on the loopback interfaces for IPv4 and IPv6, respectively.
Passing a value of 0 for the Port parameter instructs the server to assign a port. In this case, query the ForwardedPort setting to determine the port that was assigned by the server.
The class has two modes that allow data to be dealt with directly from the events, or automatically forwarded on to a different endpoint.
Event Based Operation
In this mode any data received by the class over the tunnel causes the events of the class to fire. For instance:
SSHReverseTunnel.RequestForwarding("0.0.0.0",777,"",0);
In the above code forwarding is request from port 777 on the SSHHost. Any data received on port 777 by the SSHHost will be sent to the class. In the above code the last two parameters are empty or 0 indicating to the class that no local forwarding is requested.
Once RequestForwarding returns the SSH reverse tunnel is established and any connection made to the SSH host on the specified port will trigger events of the class to fire allowing you to handle the connection request and data.
When a client connects to the SSH host on the specified port the SSHChannelOpenRequest event will fire. Within this event choose to accept or reject the connection by setting the e.Accept parameter. This event contains details about the connection that may be used when determining whether to accept the connection.
After the channel is established data is received through the SSHChannelData event. To send data over the channel call the SendChannelData method. To close the channel call the CloseChannel method.
Local Forwarding
In this mode the any data received by the class is automatically forwarded to a separate endpoint.
This allows the class to act as a sort of proxy. There is no need to handle data directly in this case.
For instance:
SSHReverseTunnel.RequestForwarding("0.0.0.0",777,"nsoftware.com",80);
In the above code forwarding is request from port 777 on SSHHost. The class is instructed to establish a connection to "nsoftware.com" on port 80 when a client connect to SSHHost on port 777. Any data received from the client connected to SSHHost on port 777 will automatically be forwarded to "nsoftware.com" on port 80. Any data received back from "nsoftware.com" on port 80 will be sent back to the connected client.
In this mode data may flow freely from the client connected to the SSHHost to the endpoint specified in the RequestForwarding method without any additional code required.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Reset Method (SSHReverseTunnel Class)
Reset the class.
Syntax
ANSI (Cross Platform) int Reset(); Unicode (Windows) INT Reset();
int ipworksssh_sshreversetunnel_reset(void* lpObj);
int Reset();
Remarks
This method will reset the class's properties to their default values.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
SendChannelData Method (SSHReverseTunnel Class)
Used to send data over an SSH channel.
Syntax
ANSI (Cross Platform) int SendChannelData(const char* lpszChannelId, const char* lpData, int lenData); Unicode (Windows) INT SendChannelData(LPCWSTR lpszChannelId, LPCSTR lpData, INT lenData);
int ipworksssh_sshreversetunnel_sendchanneldata(void* lpObj, const char* lpszChannelId, const char* lpData, int lenData);
int SendChannelData(const QString& qsChannelId, QByteArray qbaData);
Remarks
This method can be used to send arbitrary data to the channel with the specified ChannelId.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
SetSSHParam Method (SSHReverseTunnel Class)
Used to write a field to the end of a payload.
Syntax
ANSI (Cross Platform) char* SetSSHParam(const char* lpPayload, int lenPayload, const char* lpszFieldType, const char* lpszFieldValue, int *lpSize = NULL); Unicode (Windows) LPSTR SetSSHParam(LPCSTR lpPayload, INT lenPayload, LPCWSTR lpszFieldType, LPCWSTR lpszFieldValue, LPINT lpSize = NULL);
char* ipworksssh_sshreversetunnel_setsshparam(void* lpObj, const char* lpPayload, int lenPayload, const char* lpszFieldType, const char* lpszFieldValue, int *lpSize);
QByteArray SetSSHParam(QByteArray qbaPayload, const QString& qsFieldType, const QString& qsFieldValue);
Remarks
This method is used to build the payload portion of an SSH packet to be sent later by a call to SendSSHPacket. Payload should contain the result of a previous call to SetSSHParam. FieldType is a string defining the type of field to be written to the packet. FieldValue should be the string representation of the field to be written.
The following is a list of supported field types and a description of how FieldValue should be encoded:
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.
Note: This method is only applicable for reading and creating SSH packets for use within the SSHCustomAuth event.
Error Handling (C++)
This method returns a Binary String value (with length lpSize); after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
SSHLogoff Method (SSHReverseTunnel Class)
Logoff from the SSH server.
Syntax
ANSI (Cross Platform) int SSHLogoff(); Unicode (Windows) INT SSHLogoff();
int ipworksssh_sshreversetunnel_sshlogoff(void* lpObj);
int SSHLogoff();
Remarks
Logoff from the SSH server. If that fails, the connection is terminated by the local host.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
SSHLogon Method (SSHReverseTunnel Class)
Logon to the SSHHost using the current SSHUser and SSHPassword .
Syntax
ANSI (Cross Platform) int SSHLogon(const char* lpszSSHHost, int iSSHPort); Unicode (Windows) INT SSHLogon(LPCWSTR lpszSSHHost, INT iSSHPort);
int ipworksssh_sshreversetunnel_sshlogon(void* lpObj, const char* lpszSSHHost, int iSSHPort);
int SSHLogon(const QString& qsSSHHost, int iSSHPort);
Remarks
Logon to the SSH server using the current SSHUser and SSHPassword. This will perform the SSH handshake and authentication.
Example (Logging On)
SSHClient.SSHUser = "username"
SSHClient.SSHPassword = "password"
SSHClient.SSHLogon("sshHost", sshPort)
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Connected Event (SSHReverseTunnel Class)
This event is fired immediately after a connection completes (or fails).
Syntax
ANSI (Cross Platform) virtual int FireConnected(SSHReverseTunnelConnectedEventParams *e);
typedef struct {
int StatusCode;
const char *Description; int reserved; } SSHReverseTunnelConnectedEventParams;
Unicode (Windows) virtual INT FireConnected(SSHReverseTunnelConnectedEventParams *e);
typedef struct {
INT StatusCode;
LPCWSTR Description; INT reserved; } SSHReverseTunnelConnectedEventParams;
#define EID_SSHREVERSETUNNEL_CONNECTED 1 virtual INT IPWORKSSSH_CALL FireConnected(INT &iStatusCode, LPSTR &lpszDescription);
class SSHReverseTunnelConnectedEventParams { public: int StatusCode(); const QString &Description(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Connected(SSHReverseTunnelConnectedEventParams *e);
// Or, subclass SSHReverseTunnel and override this emitter function. virtual int FireConnected(SSHReverseTunnelConnectedEventParams *e) {...}
Remarks
If the connection is made normally, StatusCode is 0 and Description is "OK".
If the connection fails, StatusCode has the error code returned by the Transmission Control Protocol (TCP)/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.
Please refer to the Error Codes section for more information.
ConnectionStatus Event (SSHReverseTunnel Class)
This event is fired to indicate changes in the connection state.
Syntax
ANSI (Cross Platform) virtual int FireConnectionStatus(SSHReverseTunnelConnectionStatusEventParams *e);
typedef struct {
const char *ConnectionEvent;
int StatusCode;
const char *Description; int reserved; } SSHReverseTunnelConnectionStatusEventParams;
Unicode (Windows) virtual INT FireConnectionStatus(SSHReverseTunnelConnectionStatusEventParams *e);
typedef struct {
LPCWSTR ConnectionEvent;
INT StatusCode;
LPCWSTR Description; INT reserved; } SSHReverseTunnelConnectionStatusEventParams;
#define EID_SSHREVERSETUNNEL_CONNECTIONSTATUS 2 virtual INT IPWORKSSSH_CALL FireConnectionStatus(LPSTR &lpszConnectionEvent, INT &iStatusCode, LPSTR &lpszDescription);
class SSHReverseTunnelConnectionStatusEventParams { public: const QString &ConnectionEvent(); int StatusCode(); const QString &Description(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void ConnectionStatus(SSHReverseTunnelConnectionStatusEventParams *e);
// Or, subclass SSHReverseTunnel and override this emitter function. virtual int FireConnectionStatus(SSHReverseTunnelConnectionStatusEventParams *e) {...}
Remarks
The ConnectionStatus event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake.
The ConnectionEvent parameter indicates the type of connection event. Values may include the following:
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 (SSHReverseTunnel Class)
This event is fired when a connection is closed.
Syntax
ANSI (Cross Platform) virtual int FireDisconnected(SSHReverseTunnelDisconnectedEventParams *e);
typedef struct {
int StatusCode;
const char *Description; int reserved; } SSHReverseTunnelDisconnectedEventParams;
Unicode (Windows) virtual INT FireDisconnected(SSHReverseTunnelDisconnectedEventParams *e);
typedef struct {
INT StatusCode;
LPCWSTR Description; INT reserved; } SSHReverseTunnelDisconnectedEventParams;
#define EID_SSHREVERSETUNNEL_DISCONNECTED 3 virtual INT IPWORKSSSH_CALL FireDisconnected(INT &iStatusCode, LPSTR &lpszDescription);
class SSHReverseTunnelDisconnectedEventParams { public: int StatusCode(); const QString &Description(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Disconnected(SSHReverseTunnelDisconnectedEventParams *e);
// Or, subclass SSHReverseTunnel and override this emitter function. virtual int FireDisconnected(SSHReverseTunnelDisconnectedEventParams *e) {...}
Remarks
If the connection is broken normally, StatusCode is 0 and Description is "OK".
If the connection is broken for any other reason, StatusCode has the error code returned by the Transmission Control Protocol (TCP/IP) subsystem. Description contains a description of this code. The value of StatusCode is equal to the value of the TCP/IP error.
Please refer to the Error Codes section for more information.
Error Event (SSHReverseTunnel Class)
Information about errors during data delivery.
Syntax
ANSI (Cross Platform) virtual int FireError(SSHReverseTunnelErrorEventParams *e);
typedef struct {
int ErrorCode;
const char *Description; int reserved; } SSHReverseTunnelErrorEventParams;
Unicode (Windows) virtual INT FireError(SSHReverseTunnelErrorEventParams *e);
typedef struct {
INT ErrorCode;
LPCWSTR Description; INT reserved; } SSHReverseTunnelErrorEventParams;
#define EID_SSHREVERSETUNNEL_ERROR 4 virtual INT IPWORKSSSH_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);
class SSHReverseTunnelErrorEventParams { public: int ErrorCode(); const QString &Description(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Error(SSHReverseTunnelErrorEventParams *e);
// Or, subclass SSHReverseTunnel and override this emitter function. virtual int FireError(SSHReverseTunnelErrorEventParams *e) {...}
Remarks
The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.
ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.
The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.
ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.
Log Event (SSHReverseTunnel Class)
Fires once for each log message.
Syntax
ANSI (Cross Platform) virtual int FireLog(SSHReverseTunnelLogEventParams *e);
typedef struct {
int LogLevel;
const char *Message;
const char *LogType; int reserved; } SSHReverseTunnelLogEventParams;
Unicode (Windows) virtual INT FireLog(SSHReverseTunnelLogEventParams *e);
typedef struct {
INT LogLevel;
LPCWSTR Message;
LPCWSTR LogType; INT reserved; } SSHReverseTunnelLogEventParams;
#define EID_SSHREVERSETUNNEL_LOG 5 virtual INT IPWORKSSSH_CALL FireLog(INT &iLogLevel, LPSTR &lpszMessage, LPSTR &lpszLogType);
class SSHReverseTunnelLogEventParams { public: int LogLevel(); const QString &Message(); const QString &LogType(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Log(SSHReverseTunnelLogEventParams *e);
// Or, subclass SSHReverseTunnel and override this emitter function. virtual int FireLog(SSHReverseTunnelLogEventParams *e) {...}
Remarks
This event fires once for each log messages generated by the class. The verbosity is controlled by the LogLevel setting.
LogLevel indicates the detail level of the message. Possible values are:
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.
ReconnectAttempt Event (SSHReverseTunnel Class)
Fires when attempting to reconnect.
Syntax
ANSI (Cross Platform) virtual int FireReconnectAttempt(SSHReverseTunnelReconnectAttemptEventParams *e);
typedef struct {
const char *Host;
int Port;
int RetryCount;
int RetriesRemaining;
int MaxRetryCount;
int RetryInterval;
int RetryType;
int RemoteListeningPort;
int Cancel; int reserved; } SSHReverseTunnelReconnectAttemptEventParams;
Unicode (Windows) virtual INT FireReconnectAttempt(SSHReverseTunnelReconnectAttemptEventParams *e);
typedef struct {
LPCWSTR Host;
INT Port;
INT RetryCount;
INT RetriesRemaining;
INT MaxRetryCount;
INT RetryInterval;
INT RetryType;
INT RemoteListeningPort;
BOOL Cancel; INT reserved; } SSHReverseTunnelReconnectAttemptEventParams;
#define EID_SSHREVERSETUNNEL_RECONNECTATTEMPT 6 virtual INT IPWORKSSSH_CALL FireReconnectAttempt(LPSTR &lpszHost, INT &iPort, INT &iRetryCount, INT &iRetriesRemaining, INT &iMaxRetryCount, INT &iRetryInterval, INT &iRetryType, INT &iRemoteListeningPort, BOOL &bCancel);
class SSHReverseTunnelReconnectAttemptEventParams { public: const QString &Host(); int Port(); int RetryCount(); int RetriesRemaining(); int MaxRetryCount(); int RetryInterval(); int RetryType(); int RemoteListeningPort(); bool Cancel(); void SetCancel(bool bCancel); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void ReconnectAttempt(SSHReverseTunnelReconnectAttemptEventParams *e);
// Or, subclass SSHReverseTunnel and override this emitter function. virtual int FireReconnectAttempt(SSHReverseTunnelReconnectAttemptEventParams *e) {...}
Remarks
This event fires both when attempting to reconnect to the SSHHost and when re-establishing a SSH tunnel.
Only applicable when AutoReconnect is enabled. To determine which type of connection is being established check the RetryType parameter.
The following table provides details about the parameters.
Host | The SSH host to which the connection is attempted. |
Port | The Port on the SSH host to which the connection is attempted. |
RetryCount | The current retry attempt. For instance, this may be attempt number 2 out of 5, then RetryCount will hold the value 2. |
RetriesRemaining | The number of retries remaining after this attempt. This number does not include the current attempt. If MaxRetryCount is set to unlimited this will return -1. |
MaxRetryCount | The maximum number of retries as specified in MaxRetryCount. |
RetryInterval | The interval (in seconds) between retry attempts as specified in RetryInterval. |
RetryType | The type of connection being retried. Possible values are:
|
RemoteListeningPort | The port on the SSH host which the reverse tunnel will use. This is only applicable when RetryType is 1. |
Cancel | Maybe set within this event to cancel the retry attempts. If set to True no further retry attempts will be executed. |
SSHChannelClosed Event (SSHReverseTunnel Class)
Fired when a channel is closed.
Syntax
ANSI (Cross Platform) virtual int FireSSHChannelClosed(SSHReverseTunnelSSHChannelClosedEventParams *e);
typedef struct {
const char *ChannelId; int reserved; } SSHReverseTunnelSSHChannelClosedEventParams;
Unicode (Windows) virtual INT FireSSHChannelClosed(SSHReverseTunnelSSHChannelClosedEventParams *e);
typedef struct {
LPCWSTR ChannelId; INT reserved; } SSHReverseTunnelSSHChannelClosedEventParams;
#define EID_SSHREVERSETUNNEL_SSHCHANNELCLOSED 7 virtual INT IPWORKSSSH_CALL FireSSHChannelClosed(LPSTR &lpszChannelId);
class SSHReverseTunnelSSHChannelClosedEventParams { public: const QString &ChannelId(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void SSHChannelClosed(SSHReverseTunnelSSHChannelClosedEventParams *e);
// Or, subclass SSHReverseTunnel and override this emitter function. virtual int FireSSHChannelClosed(SSHReverseTunnelSSHChannelClosedEventParams *e) {...}
Remarks
The SSHChannelClosed event is fired when a channel is closed on an SSH connection.
Note: Processing long-running requests, including sending channel data, inside this event may cause the underlying transport to stop processing SSH data until the event returns. In order to prevent this from happening, all requests should be processed asynchronously in a separate thread outside of this event.
SSHChannelData Event (SSHReverseTunnel Class)
Fired when the SSHHost sends channel data to the client.
Syntax
ANSI (Cross Platform) virtual int FireSSHChannelData(SSHReverseTunnelSSHChannelDataEventParams *e);
typedef struct {
const char *ChannelId;
const char *ChannelData; int lenChannelData; int reserved; } SSHReverseTunnelSSHChannelDataEventParams;
Unicode (Windows) virtual INT FireSSHChannelData(SSHReverseTunnelSSHChannelDataEventParams *e);
typedef struct {
LPCWSTR ChannelId;
LPCSTR ChannelData; INT lenChannelData; INT reserved; } SSHReverseTunnelSSHChannelDataEventParams;
#define EID_SSHREVERSETUNNEL_SSHCHANNELDATA 8 virtual INT IPWORKSSSH_CALL FireSSHChannelData(LPSTR &lpszChannelId, LPSTR &lpChannelData, INT &lenChannelData);
class SSHReverseTunnelSSHChannelDataEventParams { public: const QString &ChannelId(); const QByteArray &ChannelData(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void SSHChannelData(SSHReverseTunnelSSHChannelDataEventParams *e);
// Or, subclass SSHReverseTunnel and override this emitter function. virtual int FireSSHChannelData(SSHReverseTunnelSSHChannelDataEventParams *e) {...}
Remarks
The SSHChannelData event will fire as data is received for the given ChannelId. ChannelData will contain the decrypted contents of the SSH packet.
SSHChannelEOF Event (SSHReverseTunnel Class)
Fired when the remote peer signals the end of the data stream for the channel.
Syntax
ANSI (Cross Platform) virtual int FireSSHChannelEOF(SSHReverseTunnelSSHChannelEOFEventParams *e);
typedef struct {
const char *ChannelId; int reserved; } SSHReverseTunnelSSHChannelEOFEventParams;
Unicode (Windows) virtual INT FireSSHChannelEOF(SSHReverseTunnelSSHChannelEOFEventParams *e);
typedef struct {
LPCWSTR ChannelId; INT reserved; } SSHReverseTunnelSSHChannelEOFEventParams;
#define EID_SSHREVERSETUNNEL_SSHCHANNELEOF 9 virtual INT IPWORKSSSH_CALL FireSSHChannelEOF(LPSTR &lpszChannelId);
class SSHReverseTunnelSSHChannelEOFEventParams { public: const QString &ChannelId(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void SSHChannelEOF(SSHReverseTunnelSSHChannelEOFEventParams *e);
// Or, subclass SSHReverseTunnel and override this emitter function. virtual int FireSSHChannelEOF(SSHReverseTunnelSSHChannelEOFEventParams *e) {...}
Remarks
The SSHChannelEOF event is fired when the end of the data stream for a channel on an SSH connection is reached.
Note: Processing long-running requests, including sending channel data, inside this event may cause the underlying transport to stop processing SSH data until the event returns. In order to prevent this from happening, all requests should be processed asynchronously in a separate thread outside of this event.
SSHChannelOpened Event (SSHReverseTunnel Class)
Fired when a channel is successfully opened.
Syntax
ANSI (Cross Platform) virtual int FireSSHChannelOpened(SSHReverseTunnelSSHChannelOpenedEventParams *e);
typedef struct {
const char *ChannelId; int reserved; } SSHReverseTunnelSSHChannelOpenedEventParams;
Unicode (Windows) virtual INT FireSSHChannelOpened(SSHReverseTunnelSSHChannelOpenedEventParams *e);
typedef struct {
LPCWSTR ChannelId; INT reserved; } SSHReverseTunnelSSHChannelOpenedEventParams;
#define EID_SSHREVERSETUNNEL_SSHCHANNELOPENED 10 virtual INT IPWORKSSSH_CALL FireSSHChannelOpened(LPSTR &lpszChannelId);
class SSHReverseTunnelSSHChannelOpenedEventParams { public: const QString &ChannelId(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void SSHChannelOpened(SSHReverseTunnelSSHChannelOpenedEventParams *e);
// Or, subclass SSHReverseTunnel and override this emitter function. virtual int FireSSHChannelOpened(SSHReverseTunnelSSHChannelOpenedEventParams *e) {...}
Remarks
The SSHChannelOpened event is fired when a channel is successfully opened on an SSH connection.
Note: Processing long-running requests, including sending channel data, inside this event may cause the underlying transport to stop processing SSH data until the event returns. In order to prevent this from happening, all requests should be processed asynchronously in a separate thread outside of this event.
SSHChannelOpenRequest Event (SSHReverseTunnel Class)
Fired when the peer attempts to open a new channel.
Syntax
ANSI (Cross Platform) virtual int FireSSHChannelOpenRequest(SSHReverseTunnelSSHChannelOpenRequestEventParams *e);
typedef struct {
const char *ChannelId;
const char *Service;
const char *ConnectedAddress;
int ConnectedPort;
const char *OriginAddress;
int OriginPort;
int Accept; int reserved; } SSHReverseTunnelSSHChannelOpenRequestEventParams;
Unicode (Windows) virtual INT FireSSHChannelOpenRequest(SSHReverseTunnelSSHChannelOpenRequestEventParams *e);
typedef struct {
LPCWSTR ChannelId;
LPCWSTR Service;
LPCWSTR ConnectedAddress;
INT ConnectedPort;
LPCWSTR OriginAddress;
INT OriginPort;
BOOL Accept; INT reserved; } SSHReverseTunnelSSHChannelOpenRequestEventParams;
#define EID_SSHREVERSETUNNEL_SSHCHANNELOPENREQUEST 11 virtual INT IPWORKSSSH_CALL FireSSHChannelOpenRequest(LPSTR &lpszChannelId, LPSTR &lpszService, LPSTR &lpszConnectedAddress, INT &iConnectedPort, LPSTR &lpszOriginAddress, INT &iOriginPort, BOOL &bAccept);
class SSHReverseTunnelSSHChannelOpenRequestEventParams { public: const QString &ChannelId(); const QString &Service(); const QString &ConnectedAddress(); int ConnectedPort(); const QString &OriginAddress(); int OriginPort(); bool Accept(); void SetAccept(bool bAccept); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void SSHChannelOpenRequest(SSHReverseTunnelSSHChannelOpenRequestEventParams *e);
// Or, subclass SSHReverseTunnel and override this emitter function. virtual int FireSSHChannelOpenRequest(SSHReverseTunnelSSHChannelOpenRequestEventParams *e) {...}
Remarks
This event is fired whenever a peer attempts to open a new channel for a given connection. ChannelId will contain the id of the channel to be created. Service will identify the type of channel that is being requested. Usually, this will be "forwarded-tcpip", in which case ConnectedAddress and ConnectedPort will contain the remote TCP/IP address and port on the peer to which the connection was established; OriginAddress and OriginPort contain the originating TCP/IP address and port of the connection.
By default Accept is True and the channel will be opened. Set Accept to False to reject the request.
SSHChannelReadyToSend Event (SSHReverseTunnel Class)
Fired when the class is ready to send data.
Syntax
ANSI (Cross Platform) virtual int FireSSHChannelReadyToSend(SSHReverseTunnelSSHChannelReadyToSendEventParams *e);
typedef struct {
const char *ChannelId; int reserved; } SSHReverseTunnelSSHChannelReadyToSendEventParams;
Unicode (Windows) virtual INT FireSSHChannelReadyToSend(SSHReverseTunnelSSHChannelReadyToSendEventParams *e);
typedef struct {
LPCWSTR ChannelId; INT reserved; } SSHReverseTunnelSSHChannelReadyToSendEventParams;
#define EID_SSHREVERSETUNNEL_SSHCHANNELREADYTOSEND 12 virtual INT IPWORKSSSH_CALL FireSSHChannelReadyToSend(LPSTR &lpszChannelId);
class SSHReverseTunnelSSHChannelReadyToSendEventParams { public: const QString &ChannelId(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void SSHChannelReadyToSend(SSHReverseTunnelSSHChannelReadyToSendEventParams *e);
// Or, subclass SSHReverseTunnel and override this emitter function. virtual int FireSSHChannelReadyToSend(SSHReverseTunnelSSHChannelReadyToSendEventParams *e) {...}
Remarks
This event fires when data can be sent over the SSH Channel specified by ChannelId.
When a channel is opened this event will fire once the channel is ready and data can be sent.
When Timeout is set to 0 (asynchronous) sending data may result in an error if the channel or underlying socket cannot accept more data to send. Monitor SSHChannelReadyToSend or ReadyToSend to determine when data can be sent again.
When Timeout is set to a positive value the class will block when sending data until the data can be successfully sent and SSHChannelReadyToSend and ReadyToSend do not need to be monitored.
SSHChannelRequest Event (SSHReverseTunnel Class)
Fired when the SSHHost sends a channel request to the client.
Syntax
ANSI (Cross Platform) virtual int FireSSHChannelRequest(SSHReverseTunnelSSHChannelRequestEventParams *e);
typedef struct {
const char *ChannelId;
const char *RequestType;
const char *Packet; int lenPacket;
int Success; int reserved; } SSHReverseTunnelSSHChannelRequestEventParams;
Unicode (Windows) virtual INT FireSSHChannelRequest(SSHReverseTunnelSSHChannelRequestEventParams *e);
typedef struct {
LPCWSTR ChannelId;
LPCWSTR RequestType;
LPCSTR Packet; INT lenPacket;
BOOL Success; INT reserved; } SSHReverseTunnelSSHChannelRequestEventParams;
#define EID_SSHREVERSETUNNEL_SSHCHANNELREQUEST 13 virtual INT IPWORKSSSH_CALL FireSSHChannelRequest(LPSTR &lpszChannelId, LPSTR &lpszRequestType, LPSTR &lpPacket, INT &lenPacket, BOOL &bSuccess);
class SSHReverseTunnelSSHChannelRequestEventParams { public: const QString &ChannelId(); const QString &RequestType(); const QByteArray &Packet(); bool Success(); void SetSuccess(bool bSuccess); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void SSHChannelRequest(SSHReverseTunnelSSHChannelRequestEventParams *e);
// Or, subclass SSHReverseTunnel and override this emitter function. virtual int FireSSHChannelRequest(SSHReverseTunnelSSHChannelRequestEventParams *e) {...}
Remarks
The SSHHost may send requests that affect the status of a particular SSHChannel. Some requests will be automatically handled by the class. However, others may need the attention of the user to be dealt with properly within the scope of the application.
ChannelId identifies the channel receiving the request.
Type will contain the type of the request. These types are dependent upon the type of the channel. For example, a "session" channel executing a command on the remote shell may receive an "exit-status" request containing the return code of that command.
RequestData contains the remainder of the original SSH packet. If the request type has specific parameters, they can be parsed out of this data.
Success should be used to instruct the class to respond to the request with either a success or failure notification. If the request is successful, SSHChannelRequested will fire with the same information in case the request requires further processing.
Note: Processing long-running requests, including sending channel data, inside this event may cause the underlying transport to stop processing SSH data until the event returns. In order to prevent this from happening, all requests should be processed asynchronously in a separate thread outside of this event.
SSHChannelRequested Event (SSHReverseTunnel Class)
Fired if the SSHChannelRequest was successful, any further processing for the channel request should be done here.
Syntax
ANSI (Cross Platform) virtual int FireSSHChannelRequested(SSHReverseTunnelSSHChannelRequestedEventParams *e);
typedef struct {
const char *ChannelId;
const char *RequestType;
const char *Packet; int lenPacket; int reserved; } SSHReverseTunnelSSHChannelRequestedEventParams;
Unicode (Windows) virtual INT FireSSHChannelRequested(SSHReverseTunnelSSHChannelRequestedEventParams *e);
typedef struct {
LPCWSTR ChannelId;
LPCWSTR RequestType;
LPCSTR Packet; INT lenPacket; INT reserved; } SSHReverseTunnelSSHChannelRequestedEventParams;
#define EID_SSHREVERSETUNNEL_SSHCHANNELREQUESTED 14 virtual INT IPWORKSSSH_CALL FireSSHChannelRequested(LPSTR &lpszChannelId, LPSTR &lpszRequestType, LPSTR &lpPacket, INT &lenPacket);
class SSHReverseTunnelSSHChannelRequestedEventParams { public: const QString &ChannelId(); const QString &RequestType(); const QByteArray &Packet(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void SSHChannelRequested(SSHReverseTunnelSSHChannelRequestedEventParams *e);
// Or, subclass SSHReverseTunnel and override this emitter function. virtual int FireSSHChannelRequested(SSHReverseTunnelSSHChannelRequestedEventParams *e) {...}
Remarks
The SSHHost may send requests that affect the status of a particular SSHChannel. Some requests will be automatically handled by the class. However, others may need the attention of the user to be dealt with properly within the scope of the application.
ChannelId identifies the channel receiving the request.
Type will contain the type of the request. These types are dependent upon the type of the channel. For example, a "session" channel executing a command on the remote shell may receive an "exit-status" request containing the return code of that command.
RequestData contains the remainder of the original SSH packet. If the request type has specific parameters, they can be parsed out of this data.
Note: Processing long-running requests, including sending channel data, inside this event may cause the underlying transport to stop processing SSH data until the event returns. In order to prevent this from happening, all requests should be processed asynchronously in a separate thread outside of this event.
SSHCustomAuth Event (SSHReverseTunnel Class)
Fired when the class is doing custom authentication.
Syntax
ANSI (Cross Platform) virtual int FireSSHCustomAuth(SSHReverseTunnelSSHCustomAuthEventParams *e);
typedef struct {
char *Packet; int reserved; } SSHReverseTunnelSSHCustomAuthEventParams;
Unicode (Windows) virtual INT FireSSHCustomAuth(SSHReverseTunnelSSHCustomAuthEventParams *e);
typedef struct {
LPWSTR Packet; INT reserved; } SSHReverseTunnelSSHCustomAuthEventParams;
#define EID_SSHREVERSETUNNEL_SSHCUSTOMAUTH 15 virtual INT IPWORKSSSH_CALL FireSSHCustomAuth(LPSTR &lpszPacket);
class SSHReverseTunnelSSHCustomAuthEventParams { public: const QString &Packet(); void SetPacket(const QString &qsPacket); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void SSHCustomAuth(SSHReverseTunnelSSHCustomAuthEventParams *e);
// Or, subclass SSHReverseTunnel and override this emitter function. virtual int FireSSHCustomAuth(SSHReverseTunnelSSHCustomAuthEventParams *e) {...}
Remarks
SSHCustomAuth is fired during the user authentication stage of the SSH logon process if SSHAuthMode is set to amCustom. Packet contains the raw last SSH packet sent by the server, in HEX-encoded format.
The client should create a new raw SSH packet to send to the server and set Packet to the HEX-encoded representation of the packet to send.
In all cases, Packet will start with the message type field.
To read the incoming packet call DecodePacket and then use the GetSSHParam and GetSSHParamBytes methods. To create a packet use the SetSSHParam method and then call EncodePacket to obtain a HEX-encoded value and assign this to the Packet parameter.
SSHKeyboardInteractive Event (SSHReverseTunnel Class)
Fired when the class receives a request for user input from the server.
Syntax
ANSI (Cross Platform) virtual int FireSSHKeyboardInteractive(SSHReverseTunnelSSHKeyboardInteractiveEventParams *e);
typedef struct {
const char *Name;
const char *Instructions;
const char *Prompt;
char *Response;
int EchoResponse; int reserved; } SSHReverseTunnelSSHKeyboardInteractiveEventParams;
Unicode (Windows) virtual INT FireSSHKeyboardInteractive(SSHReverseTunnelSSHKeyboardInteractiveEventParams *e);
typedef struct {
LPCWSTR Name;
LPCWSTR Instructions;
LPCWSTR Prompt;
LPWSTR Response;
BOOL EchoResponse; INT reserved; } SSHReverseTunnelSSHKeyboardInteractiveEventParams;
#define EID_SSHREVERSETUNNEL_SSHKEYBOARDINTERACTIVE 16 virtual INT IPWORKSSSH_CALL FireSSHKeyboardInteractive(LPSTR &lpszName, LPSTR &lpszInstructions, LPSTR &lpszPrompt, LPSTR &lpszResponse, BOOL &bEchoResponse);
class SSHReverseTunnelSSHKeyboardInteractiveEventParams { public: const QString &Name(); const QString &Instructions(); const QString &Prompt(); const QString &Response(); void SetResponse(const QString &qsResponse); bool EchoResponse(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void SSHKeyboardInteractive(SSHReverseTunnelSSHKeyboardInteractiveEventParams *e);
// Or, subclass SSHReverseTunnel and override this emitter function. virtual int FireSSHKeyboardInteractive(SSHReverseTunnelSSHKeyboardInteractiveEventParams *e) {...}
Remarks
SSHKeyboardInteractive is fired during the user authentication stage of the SSH logon process. During authentication, the class will request a list of available authentication methods for the SSHUser. For example, if the SSHHost responds with "keyboard-interactive", the class will fire this event to allow the client application to set the password.
During authentication, the SSH server may respond with a request for the user's authentication information. Name is a server-provided value associated with the authentication method such as "CRYPTOCard Authentication". Instructions will contain specific instructions, also supplied by the server, for how the user should respond.
Along with these values, the server will also send at least one input Prompt to be displayed to and filled out by the user. Response should be set to the user's input, and will be sent back in the user authentication information response. EchoResponse is a server recommendation for whether or not the user's response should be echoed back during input.
Note: the server may send several prompts in a single packet. The class will fire the SSHKeyboardInteractive event once for each prompt.
SSHServerAuthentication Event (SSHReverseTunnel Class)
Fired after the server presents its public key to the client.
Syntax
ANSI (Cross Platform) virtual int FireSSHServerAuthentication(SSHReverseTunnelSSHServerAuthenticationEventParams *e);
typedef struct {
const char *HostKey; int lenHostKey;
const char *Fingerprint;
const char *KeyAlgorithm;
const char *CertSubject;
const char *CertIssuer;
const char *Status;
int Accept; int reserved; } SSHReverseTunnelSSHServerAuthenticationEventParams;
Unicode (Windows) virtual INT FireSSHServerAuthentication(SSHReverseTunnelSSHServerAuthenticationEventParams *e);
typedef struct {
LPCSTR HostKey; INT lenHostKey;
LPCWSTR Fingerprint;
LPCWSTR KeyAlgorithm;
LPCWSTR CertSubject;
LPCWSTR CertIssuer;
LPCWSTR Status;
BOOL Accept; INT reserved; } SSHReverseTunnelSSHServerAuthenticationEventParams;
#define EID_SSHREVERSETUNNEL_SSHSERVERAUTHENTICATION 17 virtual INT IPWORKSSSH_CALL FireSSHServerAuthentication(LPSTR &lpHostKey, INT &lenHostKey, LPSTR &lpszFingerprint, LPSTR &lpszKeyAlgorithm, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);
class SSHReverseTunnelSSHServerAuthenticationEventParams { public: const QByteArray &HostKey(); const QString &Fingerprint(); const QString &KeyAlgorithm(); const QString &CertSubject(); const QString &CertIssuer(); const QString &Status(); bool Accept(); void SetAccept(bool bAccept); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void SSHServerAuthentication(SSHReverseTunnelSSHServerAuthenticationEventParams *e);
// Or, subclass SSHReverseTunnel and override this emitter function. virtual int FireSSHServerAuthentication(SSHReverseTunnelSSHServerAuthenticationEventParams *e) {...}
Remarks
This event is where the client can decide whether to continue with the connection process or not. If the public key is known to be a valid key for the SSH server, Accept should be set to True within the event. Otherwise, the server will not be authenticated and the connection will be broken.
Accept will be True only if either HostKey or Fingerprint is identical to the value of SSHAcceptServerHostKey.
Accept may be set to True manually to accept the server host key.
Note that SSH's security inherently relies on client verification of the host key. Ignoring the host key and always setting Accept to true is strongly discouraged, and could cause potentially serious security vulnerabilities in your application. It is recommended that clients maintain a list of known keys for each server and check HostKey against this list each time a connection is attempted.
Host Key contains the full binary text of the key, in the same format used internally by SSH.
Fingerprint holds the SHA-256 hash of HostKey in the hex-encoded form: 0a:1b:2c:3d. To configure the hash algorithm used to calculate this value see SSHFingerprintHashAlgorithm.
KeyAlgorithm identifies the host key algorithm. Supported values are:
- ssh-rsa
- ssh-dss
- rsa-sha2-256
- rsa-sha2-512
- x509v3-sign-rsa
- x509v3-sign-dss
- ecdsa-sha2-nistp256
- ecdsa-sha2-nistp384
- ecdsa-sha2-nistp521
CertSubject is the subject of the certificate. This is only applicable when KeyAlgorithm is "x509v3-sign-rsa" or "x509v3-sign-dss".
CertIssuer is the issuer of the certificate. This is only applicable when KeyAlgorithm is "x509v3-sign-rsa" or "x509v3-sign-dss".
Status is reserved for future use.
SSHStatus Event (SSHReverseTunnel Class)
Shows the progress of the secure connection.
Syntax
ANSI (Cross Platform) virtual int FireSSHStatus(SSHReverseTunnelSSHStatusEventParams *e);
typedef struct {
const char *Message; int reserved; } SSHReverseTunnelSSHStatusEventParams;
Unicode (Windows) virtual INT FireSSHStatus(SSHReverseTunnelSSHStatusEventParams *e);
typedef struct {
LPCWSTR Message; INT reserved; } SSHReverseTunnelSSHStatusEventParams;
#define EID_SSHREVERSETUNNEL_SSHSTATUS 18 virtual INT IPWORKSSSH_CALL FireSSHStatus(LPSTR &lpszMessage);
class SSHReverseTunnelSSHStatusEventParams { public: const QString &Message(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void SSHStatus(SSHReverseTunnelSSHStatusEventParams *e);
// Or, subclass SSHReverseTunnel and override this emitter function. virtual int FireSSHStatus(SSHReverseTunnelSSHStatusEventParams *e) {...}
Remarks
The event is fired for informational and logging purposes only. Used to track the progress of the connection.
Config Settings (SSHReverseTunnel Class)
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.SSHReverseTunnel Config Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AutoReconnect:
Whether to automatically reconnect.This setting controls automatic recovery of the SSH connection. If logon is disrupted or the channel is closed the component can be configured to attempt reconnection automatically. Possible values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DefaultChannelIdleTimeout:
The inactivity timeout for channels.This setting specifies the idle timeout in seconds for each connected channel. If there is no activity
on the channel for the specified timeout the channel is closed and the client is disconnected.
The default value is 0 which is treated as an infinite timeout (the channel is never closed due to inactivity). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ForwardedPort: The remote port which is forwarded.When calling RequestForwarding with a value of 0 for the port parameter, the server will assign the port automatically. This setting may be queried to determine the port that was assigned by the server. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ForwardingLocalHost:
The interface on which to bind when forwarding data.When the class is configured to automatically forward data to a destination this setting may be used
to specify the interface to which the class binds when establishing the connection to the forwarding host.
This may be set to an IP address in the form aaa.bbb.ccc.ddd. By default this is unspecified and the system will automatically select the interface. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MaxRetryCount: The maximum number of retries when reconnecting.This setting defines the maximum number of connection attempts performed when re-establishing a broken connection. This setting only applies when AutoReconnect is enabled. By default, the component will reconnect forever. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
RetryInterval: The interval in seconds between reconnect attempts.This setting specifies the number of seconds between reconnection attempts. This setting only applies when AutoReconnect is enabled. The default value is 5. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSHClient Config Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ClientSSHVersionString: The SSH version string used by the class.This configuration setting specifies the SSH version string used by the class. The default value is "SSH-2.0-IPWorks SSH Client 2022". | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
EnablePageantAuth:
Whether to use a key stored in Pageant to perform client authentication.This setting controls whether Pageant authentication is disabled, enabled, or required. When enabled or required, the class attempts to communicate with PuTTY's ssh-agent, called "Pageant", over shared memory to perform public key authentication. Possible values and the corresponding behavior is described below:
Example enabling Pageant:
Note: This functionality is only available on Windows. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
KerberosDelegation: If true, asks for credentials with delegation enabled during authentication.The default value is "True". If set to "False", the client will not ask for credentials delegation support during authentication. Note that even if the client asks for delegation, the server/KDC might not grant it and authentication will still succeed. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
KerberosRealm: The fully qualified domain name of the Kerberos Realm to use for GSSAPI authentication.This property may be set to the fully qualified (DNS) name of the kerberos realm (or Windows Active Directory domain name) to use during GSSAPI authentication. This can be used to force authentication with a given realm if the client and server machines are not part of the same domain. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
KerberosSPN: The Kerberos Service Principal Name of the SSH host.This property can be set to specify the Service Principal Name (SPN) associated with the SSH service on the remote host. This will usually be in the form "host/fqdn.of.sshhost[@REALM]". If not specified, the class will assume the SPN is based on the value of the SSHHost property and the kerberos realm used for authentication. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
KeyRenegotiationThreshold:
Sets the threshold for the SSH Key Renegotiation.This property allows you to specify the threshold, in the number of bytes, for the SSH Key Renegotiation.
The default value for this property is set to 1 GB.
Example (for setting the threshold to 500 MB):
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LogLevel:
Specifies the level of detail that is logged.This setting controls the level of detail that is logged through the Log event. Possible values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MaxPacketSize: The maximum packet size of the channel, in bytes.This setting specifies the maximum size of an individual data packet, in bytes, that can be sent to the sender. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MaxWindowSize: The maximum window size allowed for the channel, in bytes.This setting specifies how many bytes of channel data can be sent to the sender of this message without adjusting the window. Note that this value may be changed during the connection, but the window size can only be increased, not decreased. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PasswordPrompt:
The text of the password prompt used in keyboard-interactive authentication.This setting optionally specifies a pattern to be matched to the prompt received from the server
during keyboard-interactive authentication. If a matching prompt is detected the class
automatically responds to the prompt with the password specified by SSHPassword.
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:
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:
For example, to match the value [Something].txt, specify the pattern [[]Something].txt. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PreferredDHGroupBits: The size (in bits) of the preferred modulus (p) to request from the server.This may be when using the diffie-hellman-group-exchange-sha1 or diffie-hellman-group-exchange-sha256 key exchange algorithms to control the preferred size, in bits, of the modulus (p) prime number to request from the server. Acceptable values are between 1024 and 8192. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
RecordLength:
The length of received data records.If set to a positive value, this setting defines the length of data records to be received. The class will accumulate data
until RecordLength is reached and only then fire the DataIn event with data of length RecordLength.
This allows data to be received as records of known length. This value can be changed at any time, including within the DataIn event.
The default value is 0, meaning this setting is not used. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ServerSSHVersionString: The remote host's SSH version string.This will return the remote host's SSH version string, which can help when identifying problematic servers. This configuration setting is read-only. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SignedSSHCert:
The CA signed client public key used when authenticating.When authenticating via public key authentication this setting may be set to the CA signed client's public key.
This is useful when the server has been configured to trust client keys signed by a particular CA. For instance:
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:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSHAcceptAnyServerHostKey: If set the class will accept any key presented by the server.The default value is "False". Set this to "True" to accept any key presented by the server. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSHAcceptServerCAKey:
The CA public key that signed the server's host key.If the server's host key was signed by a CA, this setting may be used to specify the CA's public key. If specified
the class will trust any server's host key that was signed by the CA. For instance:
component.Config("SSHAcceptServerCAKey=ssh-rsa AAAAB3NzaC1yc2EAAAADAQAB...");
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSHAcceptServerHostKeyFingerPrint:
The fingerprint of the server key to accept.This may be set to a comma-delimited collection of 16-byte MD5 fingerprints that should be accepted as the host's key. You may supply it by HEX
encoding the values in the form "0a:1b:2c:3d". Example:
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.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSHFingerprintHashAlgorithm:
The algorithm used to calculate the fingerprint.This configuration setting controls which hash algorithm is used to calculate the hostkey's fingerprint, displayed when SSHServerAuthentication fires.
Valid values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSHFingerprintMD5: The server hostkey's MD5 fingerprint.This setting may be queried in SSHServerAuthentication to get the server hostkey's MD5 fingerprint. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSHFingerprintSHA1: The server hostkey's SHA1 fingerprint.This setting may be queried in SSHServerAuthentication to get the server hostkey's SHA1 fingerprint. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSHFingerprintSHA256: The server hostkey's SHA256 fingerprint.This setting may be queried in SSHServerAuthentication to get the server hostkey's SHA256 fingerprint. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSHKeepAliveCountMax: The maximum number of keep alive packets to send without a response.This setting specifies the maximum number of keep alive packets to send when no response is received. Normally a response to a keep alive packet is received right away. If no response is received the class will continue to send keep alive packets until SSHKeepAliveCountMax is reached. If this is reached the class will assume the connection is broken and disconnect. The default value is 5. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSHKeepAliveInterval:
The interval between keep alive packets.This setting specifies the number of seconds between keep alive packets. If set to a positive value
the class will send a SSH keep alive packet after KeepAliveInterval seconds of inactivity.
This setting only takes effect when there is no activity, if any data is sent or received over the connection
it will reset the timer.
The default value is 0 meaning no keep alives will be sent. Note: The SSHReverseTunnel class uses a default value of 30. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSHKeyExchangeAlgorithms:
Specifies the supported key exchange algorithms.This may be used to specify the list of supported Key Exchange algorithms used during SSH negotiation. The value should contain
a comma separated list of algorithms. Supported algorithms are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSHKeyRenegotiate:
Causes the component to renegotiate the SSH keys.Once this setting is set the component will renegotiate the SSH keys with the remote host.
Example:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSHMacAlgorithms:
Specifies the supported Mac algorithms.This may be used to specify an alternate list of supported Mac algorithms used during SSH negotiation. This also specifies the order in which the Mac algorithms are preferred.
The value should contain a comma separated list of algorithms. Supported algorithms are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSHPubKeyAuthSigAlgorithms:
Specifies the enabled signature algorithms that may be used when attempting public key authentication.This setting specifies a list of signature algorithms that may be used when authenticating
to the server using public key authentication. This applies only when public key authentication
is performed by the client.
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:
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. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSHPublicKeyAlgorithms:
Specifies the supported public key algorithms for the server's public key.
This setting specifies the allowed public key algorithms for the server's public key. This list controls only the public key
algorithm used when authenticating the server's public key. This list has no bearing on the public key algorithms
that can be used by the client when performing public key authentication to the server. The default value is ssh-ed25519,ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521,rsa-sha2-256,rsa-sha2-512,ssh-rsa,ssh-dss,x509v3-sign-rsa,x509v3-sign-dss.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSHVersionPattern:
The pattern used to match the remote host's version string.This configuration setting specifies the pattern used to accept or deny the remote host's SSH version string. It takes a comma-delimited list of patterns to match. The default value is "*SSH-1.99-*,*SSH-2.0-*" and will accept connections from SSH 1.99 and 2.0 hosts. As an example, the below value would accept connections for SSH 1.99, 2.0, and 2.99 hosts.
*SSH-1.99-*,*SSH-2.0-*,*SSH-2.99-* |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TryAllAvailableAuthMethods: If set to true, the class will try all available authentication methods.The default value is false. When set to true, the class will try to authenticate using all methods that it has credentials for and the server supports. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
WaitForChannelClose:
Whether to wait for channels to be closed before disconnected.This setting controls whether the class will wait for a server response to the SSH_MSG_CHANNEL_CLOSE when disconnecting. When the class disconnects it will first attempt to close all open channels by sending a SSH_MSG_CHANNEL_CLOSE for each channel. This setting controls whether the class will wait for a server response after sending the messages.
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. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
WaitForServerDisconnect:
Whether to wait for the server to close the connection.This setting controls whether to wait for the server to close the connection when SSHLogoff is called.
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 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ConnectionTimeout: Sets a separate timeout value for establishing a connection.When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the class will use Timeout for establishing a connection and transmitting/receiving data. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FirewallAutoDetect: Tells the class whether or not to automatically detect and use firewall system settings, if available.This configuration setting is provided for use by classs that do not directly expose Firewall properties. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FirewallHost:
Name or IP address of firewall (optional).If a FirewallHost is given, requested connections will be authenticated through the specified firewall
when connecting.
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. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FirewallPassword:
Password to be used if authentication is to be used when connecting through the firewall.If FirewallHost is specified, the FirewallUser and FirewallPassword settings
are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.
Note: This setting is provided for use by classs that do not directly expose Firewall properties. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FirewallPort:
The TCP port for the FirewallHost;.The FirewallPort is set automatically when FirewallType is set to a valid value.
Note: This configuration setting is provided for use by classs that do not directly expose Firewall properties. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FirewallType:
Determines the type of firewall to connect through.The appropriate values are as follows:
Note: This setting is provided for use by classs that do not directly expose Firewall properties. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FirewallUser:
A user name if authentication is to be used connecting through a firewall.If the FirewallHost is specified, the FirewallUser and FirewallPassword
settings are used to connect and authenticate to the Firewall. If the authentication fails, the class fails with an error.
Note: This setting is provided for use by classs that do not directly expose Firewall properties. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
KeepAliveInterval:
The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.When set, TCPKeepAlive will automatically be set to True.
A TCP keep-alive packet will be sent after a period of inactivity as
defined by KeepAliveTime. If no acknowledgment is received from the remote host, the keep-alive packet
will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds.
This system default if this value is not specified here is 1 second.
Note: This value is not applicable in macOS. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
KeepAliveRetryCount:
The number of keep-alive packets to be sent before the remotehost is considered disconnected.When set, TCPKeepAlive will automatically be set to True.
A TCP keep-alive packet will be sent after a period of inactivity as
defined by KeepAliveTime. If no acknowledgment is received from the remote host, the keep-alive packet
will be sent again. This configuration setting specifies the number of times that the keep-alive packets will be sent before the remote host
is considered disconnected.
The system default if this value is not specified here is 9.
Note: This configuration setting is only available in the Unix platform. It is not supported in masOS or FreeBSD. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
KeepAliveTime: The inactivity time in milliseconds before a TCP keep-alive packet is sent.When set, TCPKeepAlive will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Linger:
When set to True, connections are terminated gracefully.This property controls how a connection is closed. The default is True.
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. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LingerTime: Time in seconds to have the connection linger. LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LocalHost:
The name of the local host through which connections are initiated or accepted.
The LocalHost setting contains the name of the local host
as obtained by the gethostname() system call, or if the
user has assigned an IP address, the value of that address.
In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface. If the class is connected, the LocalHost 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 multi-homed hosts (machines with more than one IP interface). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LocalPort:
The port in the local host where the class binds.
This 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 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; setting is useful when trying to connect to services that require a trusted port in the client side. An example is the remote shell (rsh) service in UNIX systems. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MaxLineLength:
The maximum amount of data to accumulate when no EOL is found.MaxLineLength is the size of an internal buffer, which holds received data while waiting for an EOL
string.
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. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MaxTransferRate: The transfer rate limit in bytes per second.This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ProxyExceptionsList:
A semicolon separated list of hosts and IPs to bypass when using a proxy.This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use.
When requests are made to hosts specified in this property, the proxy will not be used. For instance:
www.google.com;www.nsoftware.com |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TCPKeepAlive:
Determines whether or not the keep alive socket option is enabled.If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically
to maintain the connection. Set KeepAliveTime and KeepAliveInterval to
configure the timing of the keep-alive packets.
Note: This value is not applicable in Java. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TcpNoDelay:
Whether or not to delay when sending packets.
When true, the socket will send all data that is ready to send at once. When
false, the socket will send smaller buffered packets of data at small intervals.
This is known as the Nagle algorithm.
By default, this config is set to false. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UseIPv6:
Whether to use IPv6.When set to 0 (default), the class will use IPv4 exclusively.
When set to 1, the class will use IPv6 exclusively. To instruct the class to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to 2. The default value is 0.
Possible values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Socket Config Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AbsoluteTimeout:
Determines whether timeouts are inactivity timeouts or absolute timeouts.If AbsoluteTimeout is set to True, any method which does not complete within Timeout seconds
will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.
Note: This option is not valid for UDP ports. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FirewallData: Used to send extra data to the firewall.When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g. headers for custom authentication schemes). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
InBufferSize:
The size in bytes of the incoming queue of the socket.
This is the size of an internal queue in the TCP/IP stack.
You can increase or decrease its size depending on the amount
of data that you will be receiving. Increasing the value of the
InBufferSize setting can provide significant improvements in
performance in some cases.
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. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
OutBufferSize:
The size in bytes of the outgoing queue of the socket.This is the size of an internal queue in the TCP/IP stack.
You can increase or decrease its size depending on the amount
of data that you will be sending. Increasing the value of the
OutBufferSize setting can provide significant improvements in
performance in some cases.
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 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BuildInfo: Information about the product's build.When queried, this setting will return a string containing information about the product's build. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CodePage:
The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001).
The following is a list of valid code page identifiers:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LicenseInfo:
Information about the current license.When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MaskSensitive:
Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to true to mask sensitive data. The default is false.
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. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ProcessIdleEvents: Whether the class uses its internal event loop to process events when the main thread is idle.If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SelectWaitMillis: The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.If there are no events to process when DoEvents is called, the class will wait for the amount of time specified here before returning. The default value is 20. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UseFIPSCompliantAPI:
Tells the class whether or not to use FIPS certified APIs.When set to true, the class will utilize the underlying operating system's certified APIs. Java editions, regardless of OS, utilize Bouncy Castle FIPS, while all the other Windows editions make use of Microsoft security libraries.
FIPS mode can be enabled by setting the UseFIPSCompliantAPI configuration setting to true. This is a static setting which 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 only applicable on Windows. Note: Enabling FIPS-compliance requires a special license; please contact sales@nsoftware.com for details. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UseInternalSecurityAPI:
Tells the class whether or not to use the system security libraries or an internal implementation.
When set to false, the class will use the system security libraries by default to perform cryptographic functions where applicable.
Setting this 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 (SSHReverseTunnel Class)
Error Handling (C++)
Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
SSHReverseTunnel Errors
10057 Reconnection limit exceeded for SSH tunnel. |
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 non-socket. | |
10039 [10039] Destination address required. | |
10040 [10040] Message too long. | |
10041 [10041] Protocol wrong type for socket. | |
10042 [10042] Bad protocol option. | |
10043 [10043] Protocol not supported. | |
10044 [10044] Socket type not supported. | |
10045 [10045] Operation not supported on socket. | |
10046 [10046] Protocol family not supported. | |
10047 [10047] Address family not supported by protocol family. | |
10048 [10048] Address already in use. | |
10049 [10049] Can't 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] Can't send after socket shutdown. | |
10059 [10059] Too many references, can't splice. | |
10060 [10060] Connection timed out. | |
10061 [10061] Connection refused. | |
10062 [10062] Too many levels of symbolic links. | |
10063 [10063] File name too long. | |
10064 [10064] Host is down. | |
10065 [10065] No route to host. | |
10066 [10066] Directory 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 not loaded yet. | |
11001 [11001] Host not found. | |
11002 [11002] Non-authoritative 'Host not found' (try again or check DNS setup). | |
11003 [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP. | |
11004 [11004] Valid name, no data record (check DNS setup). |