SSHReverseTunnel Class
Properties Methods Events Config Settings Errors
The SSHReverseTunnel class provides a simple way to establish a reverse tunnel with an SSH host.
Class Name
IPWorksSSH_SSHReverseTunnel
Procedural Interface
ipworksssh_sshreversetunnel_open(); ipworksssh_sshreversetunnel_close($res); ipworksssh_sshreversetunnel_register_callback($res, $id, $function); ipworksssh_sshreversetunnel_get_last_error($res); ipworksssh_sshreversetunnel_get_last_error_code($res); ipworksssh_sshreversetunnel_set($res, $id, $index, $value); ipworksssh_sshreversetunnel_get($res, $id, $index); ipworksssh_sshreversetunnel_do_cancelforwarding($res, $address, $port); ipworksssh_sshreversetunnel_do_closechannel($res, $channelid); ipworksssh_sshreversetunnel_do_config($res, $configurationstring); ipworksssh_sshreversetunnel_do_decodepacket($res, $encodedpacket); ipworksssh_sshreversetunnel_do_doevents($res); ipworksssh_sshreversetunnel_do_encodepacket($res, $packet); ipworksssh_sshreversetunnel_do_exchangekeys($res); ipworksssh_sshreversetunnel_do_getsshparam($res, $payload, $field); ipworksssh_sshreversetunnel_do_getsshparambytes($res, $payload, $field); ipworksssh_sshreversetunnel_do_requestforwarding($res, $address, $port, $forwardinghost, $forwardingport); ipworksssh_sshreversetunnel_do_reset($res); ipworksssh_sshreversetunnel_do_sendchanneldata($res, $channelid, $data); ipworksssh_sshreversetunnel_do_setsshparam($res, $payload, $fieldtype, $fieldvalue); ipworksssh_sshreversetunnel_do_sshlogoff($res); ipworksssh_sshreversetunnel_do_sshlogon($res, $sshhost, $sshport);
Remarks
The SSHReverseTunnel class may be used to establish a reverse tunnel with an 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 is successfully established. Call RequestForwarding to establish a reverse tunnel. 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 requested 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 and 0, indicating to the class that no local forwarding is requested.
Once RequestForwarding returns, the SSH reverse tunnel is established. Any connection made to the SSH host on the specified port will then trigger the class's events 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 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. Call the SendChannelData method to send data over the channel, and call the CloseChannel method to close the channel.
Local Forwarding
In this mode, 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 requested from port 777 on SSHHost. The class is instructed to establish a connection to "nsoftware.com" on port 80 when a client connects 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 | Fired when information is available 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. |
ChannelDataEOL[ChannelId] | Used to break the incoming data stream into chunks. |
ChannelDataEOLFound[ChannelId] | Determines if ChannelDataEOL was found. |
ClientSSHVersionString | The SSH version string used by the class. |
EnablePageantAuth | Whether to use a key stored in Pageant to perform client authentication. |
KerberosDelegation | If true, asks for credentials with delegation enabled during authentication. |
KerberosRealm | The fully qualified domain name of the Kerberos Realm to use for GSSAPI authentication. |
KerberosSPN | The Kerberos Service Principal Name of the SSH host. |
KeyRenegotiationThreshold | Sets the threshold for the SSH Key Renegotiation. |
LogLevel | Specifies the level of detail that is logged. |
MaxChannelDataLength[ChannelId] | The maximum amount of data to accumulate when no ChannelDataEOL is found. |
MaxPacketSize | The maximum packet size of the channel, in bytes. |
MaxWindowSize | The maximum window size allowed for the channel, in bytes. |
NegotiatedStrictKex | Returns whether strict key exchange was negotiated to be used. |
PasswordPrompt | The text of the password prompt used in keyboard-interactive authentication. |
PreferredDHGroupBits | The size (in bits) of the preferred modulus (p) to request from the server. |
RecordLength | The length of received data records. |
ServerSSHVersionString | The remote host's SSH version string. |
SignedSSHCert | The CA signed client public key used when authenticating. |
SSHAcceptAnyServerHostKey | If set the class will accept any key presented by the server. |
SSHAcceptServerCAKey | The CA public key that signed the server's host key. |
SSHAcceptServerHostKeyFingerPrint | The fingerprint of the server key to accept. |
SSHFingerprintHashAlgorithm | The algorithm used to calculate the fingerprint. |
SSHFingerprintMD5 | The server hostkey's MD5 fingerprint. |
SSHFingerprintSHA1 | The server hostkey's SHA1 fingerprint. |
SSHFingerprintSHA256 | The server hostkey's SHA256 fingerprint. |
SSHKeepAliveCountMax | The maximum number of keep alive packets to send without a response. |
SSHKeepAliveInterval | The interval between keep alive packets. |
SSHKeyExchangeAlgorithms | Specifies the supported key exchange algorithms. |
SSHKeyRenegotiate | Causes the class to renegotiate the SSH keys. |
SSHMacAlgorithms | Specifies the supported Mac algorithms. |
SSHPubKeyAuthSigAlgorithms | Specifies the enabled signature algorithms that may be used when attempting public key authentication. |
SSHPublicKeyAlgorithms | Specifies the supported public key algorithms for the server's public key. |
SSHVersionPattern | The pattern used to match the remote host's version string. |
TryAllAvailableAuthMethods | If set to true, the class will try all available authentication methods. |
UseStrictKeyExchange | Specifies how strict key exchange is supported. |
WaitForChannelClose | Whether to wait for channels to be closed before disconnected. |
WaitForServerDisconnect | Whether to wait for the server to close the connection. |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
FirewallAutoDetect | Tells the class whether or not to automatically detect and use firewall system settings, if available. |
FirewallHost | Name or IP address of firewall (optional). |
FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
FirewallPort | The TCP port for the FirewallHost;. |
FirewallType | Determines the type of firewall to connect through. |
FirewallUser | A user name if authentication is to be used connecting through a firewall. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
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 | Whether or not to use the system security libraries or an internal implementation. |
SSHChannelCount Property (IPWorksSSH_SSHReverseTunnel Class)
The number of records in the arrays.
Object Oriented Interface
public function getSSHChannelCount();
Procedural Interface
ipworksssh_sshreversetunnel_get($res, 1 );
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 (IPWorksSSH_SSHReverseTunnel Class)
The number of bytes actually sent after a sending channel data.
Object Oriented Interface
public function getBytesSent($sshchannelid);
Procedural Interface
ipworksssh_sshreversetunnel_get($res, 2 , $sshchannelid);
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 (IPWorksSSH_SSHReverseTunnel Class)
An id generated by the class to identify the current SSH channel.
Object Oriented Interface
public function getChannelId($sshchannelid);
Procedural Interface
ipworksssh_sshreversetunnel_get($res, 3 , $sshchannelid);
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 (IPWorksSSH_SSHReverseTunnel Class)
This property holds the remote address to which the connection was established.
Object Oriented Interface
public function getConnectedAddress($sshchannelid);
Procedural Interface
ipworksssh_sshreversetunnel_get($res, 4 , $sshchannelid);
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 (IPWorksSSH_SSHReverseTunnel Class)
This property holds the remote port to which the connection was established.
Object Oriented Interface
public function getConnectedPort($sshchannelid);
Procedural Interface
ipworksssh_sshreversetunnel_get($res, 5 , $sshchannelid);
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 (IPWorksSSH_SSHReverseTunnel Class)
A string of data to be sent to the remote host.
Object Oriented Interface
public function setDataToSend($sshchannelid, $value);
Procedural Interface
ipworksssh_sshreversetunnel_set($res, 6, $value , $sshchannelid);
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 (IPWorksSSH_SSHReverseTunnel Class)
Holds the host to which incoming traffic is forwarded.
Object Oriented Interface
public function getForwardingHost($sshchannelid);
Procedural Interface
ipworksssh_sshreversetunnel_get($res, 7 , $sshchannelid);
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 (IPWorksSSH_SSHReverseTunnel Class)
Holds the port to which incoming traffic is forwarded.
Object Oriented Interface
public function getForwardingPort($sshchannelid);
Procedural Interface
ipworksssh_sshreversetunnel_get($res, 8 , $sshchannelid);
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 (IPWorksSSH_SSHReverseTunnel Class)
This property holds the address of the client which originated the connection to the reverse tunnel on SSHHost .
Object Oriented Interface
public function getOriginAddress($sshchannelid);
Procedural Interface
ipworksssh_sshreversetunnel_get($res, 9 , $sshchannelid);
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 (IPWorksSSH_SSHReverseTunnel Class)
This property holds the port used by the client which originated the connection to the reverse tunnel on SSHHost .
Object Oriented Interface
public function getOriginPort($sshchannelid);
Procedural Interface
ipworksssh_sshreversetunnel_get($res, 10 , $sshchannelid);
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 (IPWorksSSH_SSHReverseTunnel Class)
This property holds the channel type that was requested when opening the channel.
Object Oriented Interface
public function getService($sshchannelid);
Procedural Interface
ipworksssh_sshreversetunnel_get($res, 11 , $sshchannelid);
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 (IPWorksSSH_SSHReverseTunnel Class)
This shows whether the class is connected.
Object Oriented Interface
public function getConnected(); public function setConnected($value);
Procedural Interface
ipworksssh_sshreversetunnel_get($res, 12 ); ipworksssh_sshreversetunnel_set($res, 12, $value );
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 (IPWorksSSH_SSHReverseTunnel Class)
This property tells the class whether or not to automatically detect and use firewall system settings, if available.
Object Oriented Interface
public function getFirewallAutoDetect(); public function setFirewallAutoDetect($value);
Procedural Interface
ipworksssh_sshreversetunnel_get($res, 13 ); ipworksssh_sshreversetunnel_set($res, 13, $value );
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 (IPWorksSSH_SSHReverseTunnel Class)
This property determines the type of firewall to connect through.
Object Oriented Interface
public function getFirewallType(); public function setFirewallType($value);
Procedural Interface
ipworksssh_sshreversetunnel_get($res, 14 ); ipworksssh_sshreversetunnel_set($res, 14, $value );
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 (IPWorksSSH_SSHReverseTunnel Class)
This property contains the name or IP address of firewall (optional).
Object Oriented Interface
public function getFirewallHost(); public function setFirewallHost($value);
Procedural Interface
ipworksssh_sshreversetunnel_get($res, 15 ); ipworksssh_sshreversetunnel_set($res, 15, $value );
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 (IPWorksSSH_SSHReverseTunnel Class)
This property contains a password if authentication is to be used when connecting through the firewall.
Object Oriented Interface
public function getFirewallPassword(); public function setFirewallPassword($value);
Procedural Interface
ipworksssh_sshreversetunnel_get($res, 16 ); ipworksssh_sshreversetunnel_set($res, 16, $value );
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 (IPWorksSSH_SSHReverseTunnel Class)
This property contains the transmission control protocol (TCP) port for the firewall Host .
Object Oriented Interface
public function getFirewallPort(); public function setFirewallPort($value);
Procedural Interface
ipworksssh_sshreversetunnel_get($res, 17 ); ipworksssh_sshreversetunnel_set($res, 17, $value );
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 (IPWorksSSH_SSHReverseTunnel Class)
This property contains a user name if authentication is to be used connecting through a firewall.
Object Oriented Interface
public function getFirewallUser(); public function setFirewallUser($value);
Procedural Interface
ipworksssh_sshreversetunnel_get($res, 18 ); ipworksssh_sshreversetunnel_set($res, 18, $value );
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 (IPWorksSSH_SSHReverseTunnel Class)
The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
Object Oriented Interface
public function getLocalHost(); public function setLocalHost($value);
Procedural Interface
ipworksssh_sshreversetunnel_get($res, 19 ); ipworksssh_sshreversetunnel_set($res, 19, $value );
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 (IPWorksSSH_SSHReverseTunnel Class)
The TCP port in the local host where the class binds.
Object Oriented Interface
public function getLocalPort(); public function setLocalPort($value);
Procedural Interface
ipworksssh_sshreversetunnel_get($res, 20 ); ipworksssh_sshreversetunnel_set($res, 20, $value );
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 (IPWorksSSH_SSHReverseTunnel Class)
This is the certificate (PEM/Base64 encoded).
Object Oriented Interface
public function getSSHAcceptServerHostKeyEncoded(); public function setSSHAcceptServerHostKeyEncoded($value);
Procedural Interface
ipworksssh_sshreversetunnel_get($res, 22 ); ipworksssh_sshreversetunnel_set($res, 22, $value );
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 (IPWorksSSH_SSHReverseTunnel Class)
The authentication method to be used the class when calling SSHLogon .
Object Oriented Interface
public function getSSHAuthMode(); public function setSSHAuthMode($value);
Procedural Interface
ipworksssh_sshreversetunnel_get($res, 49 ); ipworksssh_sshreversetunnel_set($res, 49, $value );
Default Value
2
Remarks
The SSH Authentication specification (RFC 4252) specifies multiple methods by which a user can be authenticated by an SSH server. When a call is made to SSHLogon, the class will connect to the SSH server and establish the security layer. After the connection has been secured, the client will send an authentication request to the SSHHost containing the SSHUser. The server will respond containing a list of methods by which that user may be authenticated.
The class will attempt to authenticate the user by one of those methods based on the value of SSHAuthMode and other property values supplied by the user. Currently, the class supports the following authentication methods:
amNone (0) | No authentication will be performed. The current SSHUser value is ignored, and the connection will be logged in as anonymous. |
amMultiFactor (1) | This allows the class to attempt a multi-step authentication process. The class will send authentication data to the server based on the list of methods allowed for the current user and the authentication property values supplied. The class will continue to send authentication data until the server acknowledges authentication success. If the server rejects an authentication step, the class fails with an error. |
amPassword (2) | The class will use the values of SSHUser and SSHPassword to authenticate the user. |
amPublicKey (3) | The class will use the values of SSHUser and the SSHCert* properties to authenticate the user. the SSHCert* properties must have a private key available for this authentication method to succeed. |
amKeyboardInteractive (4) | At the time of authentication, the class will fire the SSHKeyboardInteractive event containing instructions on how to complete the authentication step. (NOTE: amKeyboardInteractive is not supported in SSHTunnel). |
amGSSAPIWithMic (5) | This allows the class to attempt Kerberos authentication using the GSSAPI-WITH-MIC scheme. The client will try Kerberos authentication using the value of SSHUser (single sign-on), or if SSHPassword is specified as well, it will try Kerberos authentication with alternate credentials. This is currently supported only on Windows, unless using the Java edition, which also provides support for Linux and macOS. |
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. |
amGSSAPIKeyex (7) | This allows the class to attempt Kerberos authentication using the GSSAPIKeyex scheme. The client will try Kerberos authentication using the value of SSHUser (single sign-on), or if SSHPassword is specified as well, it will try Kerberos authentication with alternate credentials. This is currently supported only on Windows, unless using the Java edition, which also provides support for Linux and macOS. |
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 (IPWorksSSH_SSHReverseTunnel Class)
This is the certificate (PEM/Base64 encoded).
Object Oriented Interface
public function getSSHCertEncoded(); public function setSSHCertEncoded($value);
Procedural Interface
ipworksssh_sshreversetunnel_get($res, 51 ); ipworksssh_sshreversetunnel_set($res, 51, $value );
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 (IPWorksSSH_SSHReverseTunnel Class)
This is the name of the certificate store for the client certificate.
Object Oriented Interface
public function getSSHCertStore(); public function setSSHCertStore($value);
Procedural Interface
ipworksssh_sshreversetunnel_get($res, 67 ); ipworksssh_sshreversetunnel_set($res, 67, $value );
Default Value
'MY'
Remarks
This is the name of the certificate store for the client certificate.
The SSHCertStoreType property denotes the type of the certificate store specified by SSHCertStore. If the store is password protected, specify the password in SSHCertStorePassword.
SSHCertStore is used in conjunction with the SSHCertSubject property to specify client certificates. If SSHCertStore has a value, and SSHCertSubject or SSHCertEncoded is set, a search for a certificate is initiated. Please see the SSHCertSubject property for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
Data Type
Binary String
SSHCertStorePassword Property (IPWorksSSH_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.
Object Oriented Interface
public function getSSHCertStorePassword(); public function setSSHCertStorePassword($value);
Procedural Interface
ipworksssh_sshreversetunnel_get($res, 68 ); ipworksssh_sshreversetunnel_set($res, 68, $value );
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 (IPWorksSSH_SSHReverseTunnel Class)
This is the type of certificate store for this certificate.
Object Oriented Interface
public function getSSHCertStoreType(); public function setSSHCertStoreType($value);
Procedural Interface
ipworksssh_sshreversetunnel_get($res, 69 ); ipworksssh_sshreversetunnel_set($res, 69, $value );
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 (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: this store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the 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 (IPWorksSSH_SSHReverseTunnel Class)
This is the subject of the certificate used for client authentication.
Object Oriented Interface
public function getSSHCertSubject(); public function setSSHCertSubject($value);
Procedural Interface
ipworksssh_sshreversetunnel_get($res, 70 ); ipworksssh_sshreversetunnel_set($res, 70, $value );
Default Value
''
Remarks
This is the subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:
Field | Meaning |
CN | Common Name. This is commonly a hostname like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
Data Type
String
SSHCompressionAlgorithms Property (IPWorksSSH_SSHReverseTunnel Class)
A comma-separated list containing all allowable compression algorithms.
Object Oriented Interface
public function getSSHCompressionAlgorithms(); public function setSSHCompressionAlgorithms($value);
Procedural Interface
ipworksssh_sshreversetunnel_get($res, 78 ); ipworksssh_sshreversetunnel_set($res, 78, $value );
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 (IPWorksSSH_SSHReverseTunnel Class)
A comma-separated list containing all allowable encryption algorithms.
Object Oriented Interface
public function getSSHEncryptionAlgorithms(); public function setSSHEncryptionAlgorithms($value);
Procedural Interface
ipworksssh_sshreversetunnel_get($res, 79 ); ipworksssh_sshreversetunnel_set($res, 79, $value );
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 (IPWorksSSH_SSHReverseTunnel Class)
The address of the SSH host.
Object Oriented Interface
public function getSSHHost(); public function setSSHHost($value);
Procedural Interface
ipworksssh_sshreversetunnel_get($res, 80 ); ipworksssh_sshreversetunnel_set($res, 80, $value );
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 (IPWorksSSH_SSHReverseTunnel Class)
The password for SSH password-based authentication.
Object Oriented Interface
public function getSSHPassword(); public function setSSHPassword($value);
Procedural Interface
ipworksssh_sshreversetunnel_get($res, 81 ); ipworksssh_sshreversetunnel_set($res, 81, $value );
Default Value
''
Remarks
SSHPassword specifies the password which is used to authenticate the client to the SSH server.
Data Type
String
SSHPort Property (IPWorksSSH_SSHReverseTunnel Class)
The port on the SSH server where the SSH service is running; by default, 22.
Object Oriented Interface
public function getSSHPort(); public function setSSHPort($value);
Procedural Interface
ipworksssh_sshreversetunnel_get($res, 82 ); ipworksssh_sshreversetunnel_set($res, 82, $value );
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 (IPWorksSSH_SSHReverseTunnel Class)
The username for SSH authentication.
Object Oriented Interface
public function getSSHUser(); public function setSSHUser($value);
Procedural Interface
ipworksssh_sshreversetunnel_get($res, 83 ); ipworksssh_sshreversetunnel_set($res, 83, $value );
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 (IPWorksSSH_SSHReverseTunnel Class)
A timeout for the class.
Object Oriented Interface
public function getTimeout(); public function setTimeout($value);
Procedural Interface
ipworksssh_sshreversetunnel_get($res, 84 ); ipworksssh_sshreversetunnel_set($res, 84, $value );
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 (IPWorksSSH_SSHReverseTunnel Class)
Requests the server to stop forwarding a remote TCP/IP port.
Object Oriented Interface
public function doCancelForwarding($address, $port);
Procedural Interface
ipworksssh_sshreversetunnel_do_cancelforwarding($res, $address, $port);
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.
CloseChannel Method (IPWorksSSH_SSHReverseTunnel Class)
Closes a existing SSHChannel .
Object Oriented Interface
public function doCloseChannel($channelid);
Procedural Interface
ipworksssh_sshreversetunnel_do_closechannel($res, $channelid);
Remarks
ChannelId is the identifier for the SSH channel to be closed.
Config Method (IPWorksSSH_SSHReverseTunnel Class)
Sets or retrieves a configuration setting.
Object Oriented Interface
public function doConfig($configurationstring);
Procedural Interface
ipworksssh_sshreversetunnel_do_config($res, $configurationstring);
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.
DecodePacket Method (IPWorksSSH_SSHReverseTunnel Class)
Decodes a hex-encoded SSH packet.
Object Oriented Interface
public function doDecodePacket($encodedpacket);
Procedural Interface
ipworksssh_sshreversetunnel_do_decodepacket($res, $encodedpacket);
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.
DoEvents Method (IPWorksSSH_SSHReverseTunnel Class)
Processes events from the internal message queue.
Object Oriented Interface
public function doEvents();
Procedural Interface
ipworksssh_sshreversetunnel_do_doevents($res);
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.
EncodePacket Method (IPWorksSSH_SSHReverseTunnel Class)
Hex encodes an SSH packet.
Object Oriented Interface
public function doEncodePacket($packet);
Procedural Interface
ipworksssh_sshreversetunnel_do_encodepacket($res, $packet);
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.
ExchangeKeys Method (IPWorksSSH_SSHReverseTunnel Class)
Causes the class to exchange a new set of session keys with the SSHHost .
Object Oriented Interface
public function doExchangeKeys();
Procedural Interface
ipworksssh_sshreversetunnel_do_exchangekeys($res);
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.
GetSSHParam Method (IPWorksSSH_SSHReverseTunnel Class)
Used to read a field from an SSH packet's payload.
Object Oriented Interface
public function doGetSSHParam($payload, $field);
Procedural Interface
ipworksssh_sshreversetunnel_do_getsshparam($res, $payload, $field);
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.
GetSSHParamBytes Method (IPWorksSSH_SSHReverseTunnel Class)
Used to read a field from an SSH packet's payload.
Object Oriented Interface
public function doGetSSHParamBytes($payload, $field);
Procedural Interface
ipworksssh_sshreversetunnel_do_getsshparambytes($res, $payload, $field);
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.
RequestForwarding Method (IPWorksSSH_SSHReverseTunnel Class)
Requests the server to forward a remote TCP/IP port.
Object Oriented Interface
public function doRequestForwarding($address, $port, $forwardinghost, $forwardingport);
Procedural Interface
ipworksssh_sshreversetunnel_do_requestforwarding($res, $address, $port, $forwardinghost, $forwardingport);
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 be 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 requested 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 and 0, indicating to the class that no local forwarding is requested.
Once RequestForwarding returns, the SSH reverse tunnel is established. Any connection made to the SSH host on the specified port will then trigger the class's events 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 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. Call the SendChannelData method to send data over the channel, and call the CloseChannel method to close the channel.
Local Forwarding
In this mode, 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 requested from port 777 on SSHHost. The class is instructed to establish a connection to "nsoftware.com" on port 80 when a client connects 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.
Reset Method (IPWorksSSH_SSHReverseTunnel Class)
Reset the class.
Object Oriented Interface
public function doReset();
Procedural Interface
ipworksssh_sshreversetunnel_do_reset($res);
Remarks
This method will reset the class's properties to their default values.
SendChannelData Method (IPWorksSSH_SSHReverseTunnel Class)
Used to send data over an SSH channel.
Object Oriented Interface
public function doSendChannelData($channelid, $data);
Procedural Interface
ipworksssh_sshreversetunnel_do_sendchanneldata($res, $channelid, $data);
Remarks
This method can be used to send arbitrary data to the channel with the specified ChannelId.
SetSSHParam Method (IPWorksSSH_SSHReverseTunnel Class)
Used to write a field to the end of a payload.
Object Oriented Interface
public function doSetSSHParam($payload, $fieldtype, $fieldvalue);
Procedural Interface
ipworksssh_sshreversetunnel_do_setsshparam($res, $payload, $fieldtype, $fieldvalue);
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.
SSHLogoff Method (IPWorksSSH_SSHReverseTunnel Class)
Logoff from the SSH server.
Object Oriented Interface
public function doSSHLogoff();
Procedural Interface
ipworksssh_sshreversetunnel_do_sshlogoff($res);
Remarks
Logoff from the SSH server. If that fails, the connection is terminated by the local host.
SSHLogon Method (IPWorksSSH_SSHReverseTunnel Class)
Logon to the SSHHost using the current SSHUser and SSHPassword .
Object Oriented Interface
public function doSSHLogon($sshhost, $sshport);
Procedural Interface
ipworksssh_sshreversetunnel_do_sshlogon($res, $sshhost, $sshport);
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)
Connected Event (IPWorksSSH_SSHReverseTunnel Class)
This event is fired immediately after a connection completes (or fails).
Object Oriented Interface
public function fireConnected($param);
Procedural Interface
ipworksssh_sshreversetunnel_register_callback($res, 1, array($this, 'fireConnected'));
Parameter List
'statuscode'
'description'
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 (IPWorksSSH_SSHReverseTunnel Class)
This event is fired to indicate changes in the connection state.
Object Oriented Interface
public function fireConnectionStatus($param);
Procedural Interface
ipworksssh_sshreversetunnel_register_callback($res, 2, array($this, 'fireConnectionStatus'));
Parameter List
'connectionevent'
'statuscode'
'description'
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 (IPWorksSSH_SSHReverseTunnel Class)
This event is fired when a connection is closed.
Object Oriented Interface
public function fireDisconnected($param);
Procedural Interface
ipworksssh_sshreversetunnel_register_callback($res, 3, array($this, 'fireDisconnected'));
Parameter List
'statuscode'
'description'
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 (IPWorksSSH_SSHReverseTunnel Class)
Fired when information is available about errors during data delivery.
Object Oriented Interface
public function fireError($param);
Procedural Interface
ipworksssh_sshreversetunnel_register_callback($res, 4, array($this, 'fireError'));
Parameter List
'errorcode'
'description'
Remarks
The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.
The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.
The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.
The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.
Log Event (IPWorksSSH_SSHReverseTunnel Class)
Fires once for each log message.
Object Oriented Interface
public function fireLog($param);
Procedural Interface
ipworksssh_sshreversetunnel_register_callback($res, 5, array($this, 'fireLog'));
Parameter List
'loglevel'
'message'
'logtype'
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 (IPWorksSSH_SSHReverseTunnel Class)
Fires when attempting to reconnect.
Object Oriented Interface
public function fireReconnectAttempt($param);
Procedural Interface
ipworksssh_sshreversetunnel_register_callback($res, 6, array($this, 'fireReconnectAttempt'));
Parameter List
'host'
'port'
'retrycount'
'retriesremaining'
'maxretrycount'
'retryinterval'
'retrytype'
'remotelisteningport'
'cancel'
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 (IPWorksSSH_SSHReverseTunnel Class)
Fired when a channel is closed.
Object Oriented Interface
public function fireSSHChannelClosed($param);
Procedural Interface
ipworksssh_sshreversetunnel_register_callback($res, 7, array($this, 'fireSSHChannelClosed'));
Parameter List
'channelid'
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 (IPWorksSSH_SSHReverseTunnel Class)
Fired when the SSHHost sends channel data to the client.
Object Oriented Interface
public function fireSSHChannelData($param);
Procedural Interface
ipworksssh_sshreversetunnel_register_callback($res, 8, array($this, 'fireSSHChannelData'));
Parameter List
'channelid'
'channeldata'
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 (IPWorksSSH_SSHReverseTunnel Class)
Fired when the remote peer signals the end of the data stream for the channel.
Object Oriented Interface
public function fireSSHChannelEOF($param);
Procedural Interface
ipworksssh_sshreversetunnel_register_callback($res, 9, array($this, 'fireSSHChannelEOF'));
Parameter List
'channelid'
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 (IPWorksSSH_SSHReverseTunnel Class)
Fired when a channel is successfully opened.
Object Oriented Interface
public function fireSSHChannelOpened($param);
Procedural Interface
ipworksssh_sshreversetunnel_register_callback($res, 10, array($this, 'fireSSHChannelOpened'));
Parameter List
'channelid'
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 (IPWorksSSH_SSHReverseTunnel Class)
Fired when the peer attempts to open a new channel.
Object Oriented Interface
public function fireSSHChannelOpenRequest($param);
Procedural Interface
ipworksssh_sshreversetunnel_register_callback($res, 11, array($this, 'fireSSHChannelOpenRequest'));
Parameter List
'channelid'
'service'
'connectedaddress'
'connectedport'
'originaddress'
'originport'
'accept'
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 (IPWorksSSH_SSHReverseTunnel Class)
Fired when the class is ready to send data.
Object Oriented Interface
public function fireSSHChannelReadyToSend($param);
Procedural Interface
ipworksssh_sshreversetunnel_register_callback($res, 12, array($this, 'fireSSHChannelReadyToSend'));
Parameter List
'channelid'
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 (IPWorksSSH_SSHReverseTunnel Class)
Fired when the SSHHost sends a channel request to the client.
Object Oriented Interface
public function fireSSHChannelRequest($param);
Procedural Interface
ipworksssh_sshreversetunnel_register_callback($res, 13, array($this, 'fireSSHChannelRequest'));
Parameter List
'channelid'
'requesttype'
'packet'
'success'
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 (IPWorksSSH_SSHReverseTunnel Class)
Fired if the SSHChannelRequest was successful, any further processing for the channel request should be done here.
Object Oriented Interface
public function fireSSHChannelRequested($param);
Procedural Interface
ipworksssh_sshreversetunnel_register_callback($res, 14, array($this, 'fireSSHChannelRequested'));
Parameter List
'channelid'
'requesttype'
'packet'
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 (IPWorksSSH_SSHReverseTunnel Class)
Fired when the class is doing custom authentication.
Object Oriented Interface
public function fireSSHCustomAuth($param);
Procedural Interface
ipworksssh_sshreversetunnel_register_callback($res, 15, array($this, 'fireSSHCustomAuth'));
Parameter List
'packet'
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 (IPWorksSSH_SSHReverseTunnel Class)
Fired when the class receives a request for user input from the server.
Object Oriented Interface
public function fireSSHKeyboardInteractive($param);
Procedural Interface
ipworksssh_sshreversetunnel_register_callback($res, 16, array($this, 'fireSSHKeyboardInteractive'));
Parameter List
'name'
'instructions'
'prompt'
'response'
'echoresponse'
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 (IPWorksSSH_SSHReverseTunnel Class)
Fired after the server presents its public key to the client.
Object Oriented Interface
public function fireSSHServerAuthentication($param);
Procedural Interface
ipworksssh_sshreversetunnel_register_callback($res, 17, array($this, 'fireSSHServerAuthentication'));
Parameter List
'hostkey'
'fingerprint'
'keyalgorithm'
'certsubject'
'certissuer'
'status'
'accept'
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 (IPWorksSSH_SSHReverseTunnel Class)
Shows the progress of the secure connection.
Object Oriented Interface
public function fireSSHStatus($param);
Procedural Interface
ipworksssh_sshreversetunnel_register_callback($res, 18, array($this, 'fireSSHStatus'));
Parameter List
'message'
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
Value | Description |
0 (None) | Do not automatically reconnect. |
1 (Default) | Reconnect if an existing connection is broken. |
2 (Always) | Retry the initial logon as well as recover an existing connection. |
The default value is 0 which is treated as an infinite timeout (the channel is never closed due to inactivity).
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.
SSHClient Config Settings
If MaxChannelDataLength > 0 and ChannelDataEOL is a non-empty string the class will internally buffer data waiting to fire SSHChannelData until either MaxChannelDataLength is reached or ChannelDataEOL is found, whichever comes first. Query ChannelDataEOLFound to know which condition was met. The buffer is reset any time SSHChannelData fires.
ChannelDataEOL and MaxChannelDataLength MUST be set together or unexpected behavior could occur.
This config is only valid when queried inside SSHChannelData, MaxChannelDataLength > 0, and ChannelDataEOL is non-empty.
Most SSH servers expect the SSH version string to have the expected format "SSH-protocol version-software version". See above for an example.
Value | Description |
0 (Disabled - default) | No communication with Pageant is attempted. |
1 (Enabled) | Pageant authentication is used if available. If Pageant is not running, or does not contain the expected key no error is thrown. |
2 (Required) | Only Pageant authentication is used. If Pageant is not running, or does not contain the expected key an error is thrown. |
Example enabling Pageant:
component.Config("EnablePageantAuth=1");
component.SSHUser = "sshuser";
component.SSHLogon("localhost", 22);
Note: This functionality is only available on Windows.
Example (for setting the threshold to 500 MB):
SSHComponent.Config("KeyRenegotiationThreshold=524288000")
0 (None) | No messages are logged. |
1 (Info - Default) | Informational events such as SSH handshake messages are logged. |
2 (Verbose) | Detailed data such as individual packet information is logged. |
3 (Debug) | Debug data including all relevant sent and received bytes are logged. |
If MaxChannelDataLength > 0 and ChannelDataEOL is a non-empty string the class will internally buffer data waiting to fire SSHChannelData until either MaxChannelDataLength is reached or ChannelDataEOL is found, whichever comes first. Query ChannelDataEOLFound to know which condition was met. The buffer is reset any time SSHChannelData fires.
ChannelDataEOL and MaxChannelDataLength MUST be set together or unexpected behavior could occur.
component.Config("NegotiatedStrictKex")
This provides an easy way to automatically reply to prompts with the password if one is presented by the server. The password will be auto-filled in the Response parameter of the SSHKeyboardInteractive event in the case of a match.
The following special characters are supported for pattern matching:
? | Any single character. |
* | Any characters or no characters (e.g., C*t matches Cat, Cot, Coast, Ct). |
[,-] | A range of characters (e.g., [a-z], [a], [0-9], [0-9,a-d,f,r-z]). |
\ | The slash is ignored and exact matching is performed on the next character. |
If these characters need to be used as a literal in a pattern, then they must be escaped by surrounding them with brackets []. Note: "]" and "-" do not need to be escaped. See below for the escape sequences:
Character | Escape Sequence |
? | [?] |
* | [*] |
[ | [[] |
\ | [\] |
For example, to match the value [Something].txt, specify the pattern [[]Something].txt.
The default value is 0, meaning this setting is not used.
component.Config("SignedSSHCert=ssh-rsa-cert-v01@openssh.com AAAAB3NzaC1yc2EAAAADAQABAAAB...");
The algorithm such as ssh-rsa-cert-v01@openssh.com in the above string is used as part of the authentication process. To use a different algorithm simply change this value. For instance all of the following are acceptable with the same signed public key:
- ssh-rsa-cert-v01@openssh.com AAAAB3NzaC1yc2EAAAADAQABAAAB...
- rsa-sha2-256-cert-v01@openssh.com AAAAB3NzaC1yc2EAAAADAQABAAAB...
- rsa-sha2-512-cert-v01@openssh.com AAAAB3NzaC1yc2EAAAADAQABAAAB...
component.Config("SSHAcceptServerCAKey=ssh-rsa AAAAB3NzaC1yc2EAAAADAQAB...");
SSHClient.Config("SSHAcceptServerHostKeyFingerprint=0a:1b:2c:3d");
If the server's fingerprint matches one of the values supplied, the class will accept the host key.
- MD5
- SHA1
- SHA256 (default)
The default value is 0 meaning no keep alives will be sent.
Note: The SSHReverseTunnel class uses a default value of 30.
- curve25519-sha256
- curve25519-sha256@libssh.org
- diffie-hellman-group1-sha1
- diffie-hellman-group14-sha1
- diffie-hellman-group14-sha256
- diffie-hellman-group16-sha512
- diffie-hellman-group18-sha512
- diffie-hellman-group-exchange-sha256
- diffie-hellman-group-exchange-sha1
- ecdh-sha2-nistp256
- ecdh-sha2-nistp384
- ecdh-sha2-nistp521
- gss-group14-sha256-toWM5Slw5Ew8Mqkay+al2g==
- gss-group16-sha512-toWM5Slw5Ew8Mqkay+al2g==
- gss-nistp256-sha256-toWM5Slw5Ew8Mqkay+al2g==
- gss-curve25519-sha256-toWM5Slw5Ew8Mqkay+al2g==
- gss-group14-sha1-toWM5Slw5Ew8Mqkay+al2g==
- gss-gex-sha1-toWM5Slw5Ew8Mqkay+al2g==
Example:
SSHClient.Config("SSHKeyRenegotiate")
- hmac-sha1
- hmac-md5
- hmac-sha1-96
- hmac-md5-96
- hmac-sha2-256
- hmac-sha2-256-96
- hmac-sha2-512
- hmac-sha2-512-96
- hmac-ripemd160
- hmac-ripemd160-96
- hmac-sha2-256-etm@openssh.com
- hmac-sha2-512-etm@openssh.com
- umac-64@openssh.com
- umac-64-etm@openssh.com
- umac-128@openssh.com
- umac-128-etm@openssh.com
The setting should be a comma separated list of algorithms. At runtime the class will evaluate the specified algorithms and if the algorithm is applicable to the certificate specified in SSHCert it will be used. If the algorithm is not applicable the class will evaluate the next algorithm. Possible values are:
- ssh-rsa
- rsa-sha2-256
- rsa-sha2-512
- ssh-dss
- ecdsa-sha2-nistp256
- ecdsa-sha2-nistp384
- ecdsa-sha2-nistp521
- ssh-ed25519
- x509v3-sign-rsa
- x509v3-sign-dss
The default value in Windows is ssh-rsa,rsa-sha2-256,rsa-sha2-512,ssh-dss,ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521,ssh-ed25519.
rsa-sha2-256 and rsa-sha2-512 notes
The class will query the server for supported algorithms when connecting. If the server indicates support for rsa-sha2-256 or rsa-sha2-512 and the algorithm is present in the list defined by this setting (as in the default value), that algorithm will be used instead of ssh-rsa even when ssh-rsa appears first in the list.
For the rsa-sha2-256 and rsa-sha2-512 algorithms to be automatically preferred the server must support the ext-info-c mechanism. In practice, older servers do not support this and in that case ssh-rsa will be used since it appears first in the list. Newer servers do support this mechanism and in that case rsa-sha2-256 or rsa-sha2-512 will be used even though it appears after ssh-rsa.
This behavior has been carefully designed to provide maximum compatibility while automatically using more secure algorithms when connecting to servers which support them.
*SSH-1.99-*,*SSH-2.0-*,*SSH-2.99-*
Since both client and server must implement strict key exchange to effectively mitigate the Terrapin attack, the class provides options to further control the behavior in different scenarios. Possible values for this setting are:
0 | Disabled. Strict key exchange is not supported in the class. |
1 (default) | Enabled, but not enforced. This setting enables strict key exchange, but if the remote host does not support strict key exchange the connection is still allowed to continue. |
2 | Enabled, but reject affected algorithms if the remote host does not support strict key exchange. If the remote host supports strict key exchange all algorithms may be used. If the remote host does not support strict key exchange the connection will only continue if the selected encryption and MAC algorithms are not affected by the Terrapin attack. |
3 | Required. If the remote host does not support strict key exchange the connection will fail. |
When True (default) the class will wait for a response to the channel close message until the responses have been received, the server closes the connection, or Timeout seconds is reached.
When False the class will still send the channel close messages but will not wait for a response and will proceed to close the connection.
When set to True the class will initiate the disconnection sequence by sending SSH_MSG_DISCONNECT but will not close the connection, and instead will wait for the server to close the connection. Setting this to True may be beneficial in circumstances where many connections are being established, to avoid port exhaustion when sockets are in a TIME_WAIT state. Allowing the server to close the connection avoids the TIME_WAIT state of socket on the client machine.
When set to False (default) the client will close the connection. It is recommended to use this value unless there is a specific need to change it.
TCPClient Config Settings
If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This configuration setting is provided for use by classs that do not directly expose Firewall properties.
0 | No firewall (default setting). |
1 | Connect through a tunneling proxy. FirewallPort is set to 80. |
2 | Connect through a SOCKS4 Proxy. FirewallPort is set to 1080. |
3 | Connect through a SOCKS5 Proxy. FirewallPort is set to 1080. |
10 | Connect through a SOCKS4A Proxy. FirewallPort is set to 1080. |
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This value is not applicable in macOS.
In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.
In the second scenario, if LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection.
The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the class returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).
Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.
In 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).
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.
If an EOL string is found in the input stream before MaxLineLength bytes are received, the DataIn event is fired with the EOL parameter set to True, and the buffer is reset.
If no EOL is found, and MaxLineLength bytes are accumulated in the buffer, the DataIn event is fired with the EOL parameter set to False, and the buffer is reset.
The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes.
www.google.com;www.nsoftware.com
Note: This value is not applicable in Java.
By default, this config is set to false.
0 | IPv4 Only |
1 | IPv6 Only |
2 | IPv6 with IPv4 fallback |
Socket Config Settings
Note: This option is not valid for UDP ports.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Base Config Settings
The following is a list of valid code page identifiers:
Identifier | Name |
037 | IBM EBCDIC - U.S./Canada |
437 | OEM - United States |
500 | IBM EBCDIC - International |
708 | Arabic - ASMO 708 |
709 | Arabic - ASMO 449+, BCON V4 |
710 | Arabic - Transparent Arabic |
720 | Arabic - Transparent ASMO |
737 | OEM - Greek (formerly 437G) |
775 | OEM - Baltic |
850 | OEM - Multilingual Latin I |
852 | OEM - Latin II |
855 | OEM - Cyrillic (primarily Russian) |
857 | OEM - Turkish |
858 | OEM - Multilingual Latin I + Euro symbol |
860 | OEM - Portuguese |
861 | OEM - Icelandic |
862 | OEM - Hebrew |
863 | OEM - Canadian-French |
864 | OEM - Arabic |
865 | OEM - Nordic |
866 | OEM - Russian |
869 | OEM - Modern Greek |
870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
875 | IBM EBCDIC - Modern Greek |
932 | ANSI/OEM - Japanese, Shift-JIS |
936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
949 | ANSI/OEM - Korean (Unified Hangul Code) |
950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
1026 | IBM EBCDIC - Turkish (Latin-5) |
1047 | IBM EBCDIC - Latin 1/Open System |
1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
1147 | IBM EBCDIC - France (20297 + Euro symbol) |
1148 | IBM EBCDIC - International (500 + Euro symbol) |
1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
1201 | Unicode UCS-2 Big-Endian |
1250 | ANSI - Central European |
1251 | ANSI - Cyrillic |
1252 | ANSI - Latin I |
1253 | ANSI - Greek |
1254 | ANSI - Turkish |
1255 | ANSI - Hebrew |
1256 | ANSI - Arabic |
1257 | ANSI - Baltic |
1258 | ANSI/OEM - Vietnamese |
1361 | Korean (Johab) |
10000 | MAC - Roman |
10001 | MAC - Japanese |
10002 | MAC - Traditional Chinese (Big5) |
10003 | MAC - Korean |
10004 | MAC - Arabic |
10005 | MAC - Hebrew |
10006 | MAC - Greek I |
10007 | MAC - Cyrillic |
10008 | MAC - Simplified Chinese (GB 2312) |
10010 | MAC - Romania |
10017 | MAC - Ukraine |
10021 | MAC - Thai |
10029 | MAC - Latin II |
10079 | MAC - Icelandic |
10081 | MAC - Turkish |
10082 | MAC - Croatia |
12000 | Unicode UCS-4 Little-Endian |
12001 | Unicode UCS-4 Big-Endian |
20000 | CNS - Taiwan |
20001 | TCA - Taiwan |
20002 | Eten - Taiwan |
20003 | IBM5550 - Taiwan |
20004 | TeleText - Taiwan |
20005 | Wang - Taiwan |
20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
20106 | IA5 German (7-bit) |
20107 | IA5 Swedish (7-bit) |
20108 | IA5 Norwegian (7-bit) |
20127 | US-ASCII (7-bit) |
20261 | T.61 |
20269 | ISO 6937 Non-Spacing Accent |
20273 | IBM EBCDIC - Germany |
20277 | IBM EBCDIC - Denmark/Norway |
20278 | IBM EBCDIC - Finland/Sweden |
20280 | IBM EBCDIC - Italy |
20284 | IBM EBCDIC - Latin America/Spain |
20285 | IBM EBCDIC - United Kingdom |
20290 | IBM EBCDIC - Japanese Katakana Extended |
20297 | IBM EBCDIC - France |
20420 | IBM EBCDIC - Arabic |
20423 | IBM EBCDIC - Greek |
20424 | IBM EBCDIC - Hebrew |
20833 | IBM EBCDIC - Korean Extended |
20838 | IBM EBCDIC - Thai |
20866 | Russian - KOI8-R |
20871 | IBM EBCDIC - Icelandic |
20880 | IBM EBCDIC - Cyrillic (Russian) |
20905 | IBM EBCDIC - Turkish |
20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
20932 | JIS X 0208-1990 & 0121-1990 |
20936 | Simplified Chinese (GB2312) |
21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
21027 | Extended Alpha Lowercase |
21866 | Ukrainian (KOI8-U) |
28591 | ISO 8859-1 Latin I |
28592 | ISO 8859-2 Central Europe |
28593 | ISO 8859-3 Latin 3 |
28594 | ISO 8859-4 Baltic |
28595 | ISO 8859-5 Cyrillic |
28596 | ISO 8859-6 Arabic |
28597 | ISO 8859-7 Greek |
28598 | ISO 8859-8 Hebrew |
28599 | ISO 8859-9 Latin 5 |
28605 | ISO 8859-15 Latin 9 |
29001 | Europa 3 |
38598 | ISO 8859-8 Hebrew |
50220 | ISO 2022 Japanese with no halfwidth Katakana |
50221 | ISO 2022 Japanese with halfwidth Katakana |
50222 | ISO 2022 Japanese JIS X 0201-1989 |
50225 | ISO 2022 Korean |
50227 | ISO 2022 Simplified Chinese |
50229 | ISO 2022 Traditional Chinese |
50930 | Japanese (Katakana) Extended |
50931 | US/Canada and Japanese |
50933 | Korean Extended and Korean |
50935 | Simplified Chinese Extended and Simplified Chinese |
50936 | Simplified Chinese |
50937 | US/Canada and Traditional Chinese |
50939 | Japanese (Latin) Extended and Japanese |
51932 | EUC - Japanese |
51936 | EUC - Simplified Chinese |
51949 | EUC - Korean |
51950 | EUC - Traditional Chinese |
52936 | HZ-GB2312 Simplified Chinese |
54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
57002 | ISCII Devanagari |
57003 | ISCII Bengali |
57004 | ISCII Tamil |
57005 | ISCII Telugu |
57006 | ISCII Assamese |
57007 | ISCII Oriya |
57008 | ISCII Kannada |
57009 | ISCII Malayalam |
57010 | ISCII Gujarati |
57011 | ISCII Punjabi |
65000 | Unicode UTF-7 |
65001 | Unicode UTF-8 |
Identifier | Name |
1 | ASCII |
2 | NEXTSTEP |
3 | JapaneseEUC |
4 | UTF8 |
5 | ISOLatin1 |
6 | Symbol |
7 | NonLossyASCII |
8 | ShiftJIS |
9 | ISOLatin2 |
10 | Unicode |
11 | WindowsCP1251 |
12 | WindowsCP1252 |
13 | WindowsCP1253 |
14 | WindowsCP1254 |
15 | WindowsCP1250 |
21 | ISO2022JP |
30 | MacOSRoman |
10 | UTF16String |
0x90000100 | UTF16BigEndian |
0x94000100 | UTF16LittleEndian |
0x8c000100 | UTF32String |
0x98000100 | UTF32BigEndian |
0x9c000100 | UTF32LittleEndian |
65536 | Proprietary |
- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.
This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.
FIPS mode can be enabled by setting the UseFIPSCompliantAPI configuration setting to true. This is a static setting 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.
Setting this configuration setting to true tells the class to use the internal implementation instead of using the system security libraries.
On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.
To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.
Trappable Errors (SSHReverseTunnel Class)
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). |