SSHReverseTunnel Component
Properties Methods Events Configuration Settings Errors
The SSHReverseTunnel component can be used to support reverse tunneling against a SSH servers.
Syntax
nsoftware.IPWorksSSH.Sshreversetunnel
Remarks
The SSHReverseTunnel component allows you to request to the SSH server to listen on a TCP/IP address/port and forward connections to the local client, and then handling the forwarded connections as needed. The main difference is the introduction of a set of new properties and events that deal with SSH security. 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.
The first step in using the component is specifying the SSHHost, SSHUser and SSHPassword.
Property List
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
| Channels | A collection of currently open channels. |
| Connected | Triggers a connection or disconnection. |
| Firewall | A set of properties related to firewall access. |
| 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 IPPort binds. |
| SSHAcceptServerHostKey | Instructs the component to accept the server host key that matches the supplied key. |
| SSHAuthMode | The authentication method to be used the component when calling SSHLogon . |
| SSHCert | A certificate to be used for authenticating the SSHUser . |
| SSHCompressionAlgorithms | A comma-separated list containing all allowable compression algorithms. |
| SSHEncryptionAlgorithms | A comma-separated list containing all allowable compression 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 component. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
| CancelTcpIpForwarding | 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 component 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. |
| RequestTcpIpForwarding | Requests the server to forward a remote TCP/IP port. |
| SendChannelData | Used to send regular 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 component with short descriptions. Click on the links for further details.
| Connected | Fired immediately after a connection completes (or fails). |
| ConnectionStatus | Fired to indicate changes in connection state. |
| Disconnected | Fired when a connection is closed. |
| Error | Information about errors during data delivery. |
| 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 component is ready to send data. |
| SSHChannelRequested | Fired if the SSHChannelRequest was successful, any further processing for the channel request should be done here. |
| SSHCustomAuth | Fired when the component is doing custom authentication. |
| SSHKeyboardInteractive | Fired when the component 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. |
Configuration Settings
The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.
| ForwardedPort | The remote port which is forwarded. |
| ClientSSHVersionString | The SSH version string used by the component. |
| SignedSSHCert | The CA signed client public key used when authenticating. |
| SSHAcceptServerCAKey | The CA public key that signed the server's host key. |
| SSHAcceptAnyServerHostKey | If set the component will accept any key presented by the server. |
| SSHAcceptServerHostKeyFingerPrint | The fingerprint of the server key to accept. |
| SSHKeyExchangeAlgorithms | Specifies the supported key exchange algorithms. |
| SSHMacAlgorithms | Specifies the supported Mac algorithms. |
| SSHKeyRenegotiate | Causes the component to renegotiate the SSH keys. |
| KeyRenegotiationThreshold | Sets the threshold for the SSH Key Renegotiation. |
| KerberosRealm | The fully qualified domain name of the Kerberos Realm to use for GSSAPI authentication. |
| KerberosDelegation | If true, asks for credentials with delegation enabled during authentication. |
| KerberosSPN | The Kerberos Service Principal Name of the SSH host. |
| LogSSHPackets | If true, detailed SSH packet logging is performed. |
| MaxPacketSize | The maximum packet size of the channel, in bytes. |
| MaxWindowSize | The maximum window size allowed for the channel, in bytes. |
| PreferredDHGroupBits | The size (in bits) of the preferred modulus (p) to request from the server. |
| ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
| FirewallAutoDetect | Tells the component 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. |
| KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
| KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
| 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 TCP port in the local host where the component binds. |
| MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
| MaxTransferRate | The transfer rate limit in bytes per second. |
| RecordLength | The length of received data records. |
| TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
| UseIPv6 | Whether to use IPv6. |
| TcpNoDelay | Whether or not to delay when sending packets. |
| 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. |
| CodePage | The system code page used for Unicode to Multibyte translations. |