SSHClient Component [IP*Works! SSH V8]
Properties
Methods
Events
Configuration Settings
The SSHClient component implements a fully functional, open-ended SSH client.
NOTE: What follows is a very short description of the component interfaces.
For more information, please consult the help files that come with the respective package.
Remarks
The SSHClient component can be used to perform any number of tasks secured by the Secure Shell (SSH) protocol. First set SSHHost, SSHUser and either SSHPassword or SSHCert, then call SSHLogon to establish a secure connection.
To open channels, use OpenChannel. To open a channel to tunnel data to a remote machine, call OpenTcpIpChannel. The Channels property contains a list of all of the channels open for the current instance of the component.
Once a "session" channel has been opened, you can call StartService to initialize a service on that channel. If you are using a "shell" service, you can call OpenTerminal to establish a pseudo-terminal for formatting the data output from the shell.
Data received from the server will be fired through SSHChannelData events. Any requests received can be processed through the SSHChannelRequest event.
Property List
The following is the full list of the properties of the component with short
descriptions. Click on the links for further details.
| |
| SSHChannelCount | The number of records in the arrays. |
| ChannelId | An id generated by the component to identify the current SSH channel. |
| DataToSend | A string of data to be sent to the remote host. |
| Connected | Triggers a connection or disconnection. |
| FirewallAutoDetect | This property tells the component 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 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 IPPort binds. |
| SSHAcceptServerHostKeyEncoded | The certificate (PEM/base64 encoded). |
| SSHAuthMode | The authentication method to be used the component when performing an SSHLogon. |
| SSHCertEncoded | The certificate (PEM/base64 encoded). |
| SSHCertStore | The name of the certificate store for the client certificate. |
| SSHCertStorePassword | If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store. |
| SSHCertStoreType | The type of certificate store for this certificate. |
| SSHCertSubject | 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 compression algorithms. |
| SSHHost | The address of the SSH host. |
| SSHKeyExchangeAlgorithms | A comma-separated list containing all allowable key exchange algorithms. |
| SSHMacAlgorithms | A comma-separated list containing all allowable message authentication algorithms. |
| SSHPassword | The password for SSH password-based authentication. |
| SSHPort | The port on the SSH server where the SSH service is running; by default, 22. |
| SSHPublicKeyAlgorithms | A comma-separated list containing all allowable public key authentication algorithms. |
| 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.
| |
| CloseChannel | Closes a existing SSHChannel. |
| Config | Sets or retrieves a configuration setting. |
| DoEvents | Processes events from the internal message queue. |
| 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. |
| OpenChannel | Opens a new SSHChannel. |
| OpenTcpIpChannel | Opens a special TCP/IP tunneling SSHChannel. |
| OpenTerminal | Creates a pseudo-terminal to be used to help display data for a channel. |
| SendSSHPacket | Used to send an encoded SSH packet to a connected client. |
| SetSSHParam | Used to write a field to the end of a payload. |
| SSHLogoff | Logoff from the SSH server. |
| SSHLogon | Logon to the SSHHost using the current SSHUser and SSHPassword. |
| StartService | Requests the given service on a target channel. |
Event List
The following is the full list of the events fired by the component with short
descriptions. Click on the links for further details.
Configuration Settings
The following is a list of configuration settings for the component with short
descriptions. Click on the links for further details.
