SSHClient Control
Properties Methods Events Configuration Settings Errors
The SSHClient component implements a fully functional, open-ended SSH client.
Syntax
SSHClient
Remarks
The SSHClient control can be used to perform any number of tasks secured by the Secure Shell (SSH) protocol. First set SSHHost, SSHUser and either SSHPassword or the SSHCert* properties , then call SSHLogon to establish a secure connection.
To open channels, use OpenChannel. To open a channel to tunnel data to a remote machine, call OpenTcpIpChannel. The Channels property contains a list of all of the channels open for the current instance of the control.
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 control 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 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 calling 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 control with short descriptions. Click on the links for further details.
| 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. |
| 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. |
| SendChannelData | Used to send regular data over an SSH 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 control 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 a host attempts to open a new channel. |
| SSHChannelReadyToSend | Fired when the component 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 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 control with short descriptions. Click on the links for further details.
| 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. |