SSHClient Class

Properties   Methods   Events   Configuration Settings   Errors  

The SSHClient class implements a fully functional, open-ended SSH client.

Syntax

IPWorksSSHSSHClient
IPWorksSSHSSHClientSwift

Remarks

The SSHClient class 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 class.

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 class with short descriptions. Click on the links for further details.

- SSHChannelCountThe number of records in the arrays.
- bytesSent:(int)sSHChannelIdThe number of bytes actually sent after a sending channel data.
- channelId:(int)sSHChannelIdAn id generated by the class to identify the current SSH channel.
- dataToSend:(int)sSHChannelIdA string of data to be sent to the remote host.
- readyToSend:(int)sSHChannelIdThis property is True when data can be sent over the SSH Channel.
- recordLength:(int)sSHChannelIdThe length of received data records.
- service:(int)sSHChannelIdThis property holds the channel type that was requested when opening the channel.
- connectedTriggers a connection or disconnection.
- firewallAutoDetectThis property tells the class whether or not to automatically detect and use firewall system settings, if available.
- firewallTypeThis property determines the type of firewall to connect through.
- firewallHostThis property contains the name or IP address of firewall (optional).
- firewallPasswordThis property contains a password if authentication is to be used when connecting through the firewall.
- firewallPortThis property contains the TCP port for the firewall Host .
- firewallUserThis property contains a user name if authentication is to be used connecting through a firewall.
- localHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
- localPortThe TCP port in the local host where the class binds.
- SSHAcceptServerHostKeyEncodedThe certificate (PEM/base64 encoded).
- SSHAuthModeThe authentication method to be used the class when calling SSHLogon .
- SSHCertEncodedThe certificate (PEM/base64 encoded).
- SSHCertStoreThe name of the certificate store for the client certificate.
- SSHCertStorePasswordIf 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.
- SSHCertStoreTypeThe type of certificate store for this certificate.
- SSHCertSubjectThe subject of the certificate used for client authentication.
- SSHCompressionAlgorithmsA comma-separated list containing all allowable compression algorithms.
- SSHEncryptionAlgorithmsA comma-separated list containing all allowable encryption algorithms.
- SSHHostThe address of the SSH host.
- SSHKeyExchangeAlgorithmsA comma-separated list containing all allowable key exchange algorithms.
- SSHMacAlgorithmsA comma-separated list containing all allowable message authentication algorithms.
- SSHPasswordThe password for SSH password-based authentication.
- SSHPortThe port on the SSH server where the SSH service is running; by default, 22.
- SSHPublicKeyAlgorithmsA comma-separated list containing all allowable public key authentication algorithms.
- SSHUserThe username for SSH authentication.
- timeoutA 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.

- closeChannelCloses a existing SSHChannel .
- configSets or retrieves a configuration setting.
- decodePacketDecodes a hex-encoded SSH packet.
- doEventsProcesses events from the internal message queue.
- encodePacketHex encodes an SSH packet.
- exchangeKeysCauses the class to exchange a new set of session keys with the SSHHost .
- getSSHParamUsed to read a field from an SSH packet's payload.
- getSSHParamBytesUsed to read a field from an SSH packet's payload.
- openChannelOpens a new SSHChannel .
- openTcpIpChannelOpens a special TCP/IP tunneling SSHChannel .
- openTerminalCreates a pseudo-terminal to be used to help display data for a channel.
- resetReset the class.
- sendChannelDataUsed to send regular data over an SSH channel.
- sendSSHPacketUsed to send an encoded SSH packet to the server.
- setSSHParamUsed to write a field to the end of a payload.
- SSHLogoffLogoff from the SSH server.
- SSHLogonLogon to the SSHHost using the current SSHUser and SSHPassword .
- startServiceRequests the given service on a target channel.

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.

- onConnectedFired immediately after a connection completes (or fails).
- onConnectionStatusFired to indicate changes in connection state.
- onDisconnectedFired when a connection is closed.
- onErrorInformation about errors during data delivery.
- onLogFires once for each log message.
- onSSHChannelClosedFired when a channel is closed.
- onSSHChannelDataFired when the SSHHost sends channel data to the client.
- onSSHChannelEOFFired when the remote peer signals the end of the data stream for the channel.
- onSSHChannelOpenedFired when a channel is successfully opened.
- onSSHChannelOpenRequestFired when a host attempts to open a new channel.
- onSSHChannelReadyToSendFired when the class is ready to send data.
- onSSHChannelRequestFired when the SSHHost sends a channel request to the client.
- onSSHChannelRequestedFired if the SSHChannelRequest was successful, any further processing for the channel request should be done here.
- onSSHCustomAuthFired when the class is doing custom authentication.
- onSSHKeyboardInteractiveFired when the class receives a request for user input from the server.
- onSSHServerAuthenticationFired after the server presents its public key to the client.
- onSSHStatusShows the progress of the secure connection.

Configuration Settings


The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.

ClientSSHVersionStringThe SSH version string used by the class.
EnablePageantAuthWhether to use a key stored in Pageant to perform client authentication.
KerberosDelegationIf true, asks for credentials with delegation enabled during authentication.
KerberosRealmThe fully qualified domain name of the Kerberos Realm to use for GSSAPI authentication.
KerberosSPNThe Kerberos Service Principal Name of the SSH host.
KeyRenegotiationThresholdSets the threshold for the SSH Key Renegotiation.
LogLevelSpecifies the level of detail that is logged.
MaxPacketSizeThe maximum packet size of the channel, in bytes.
MaxWindowSizeThe maximum window size allowed for the channel, in bytes.
PasswordPromptThe text of the password prompt used in keyboard-interactive authentication.
PreferredDHGroupBitsThe size (in bits) of the preferred modulus (p) to request from the server.
RecordLengthThe length of received data records.
ServerSSHVersionStringThe remote host's SSH version string.
SignedSSHCertThe CA signed client public key used when authenticating.
SSHAcceptAnyServerHostKeyIf set the class will accept any key presented by the server.
SSHAcceptServerCAKeyThe CA public key that signed the server's host key.
SSHAcceptServerHostKeyFingerPrintThe fingerprint of the server key to accept.
SSHFingerprintHashAlgorithmThe algorithm used to calculate the fingerprint.
SSHFingerprintMD5The server hostkey's MD5 fingerprint.
SSHFingerprintSHA1The server hostkey's SHA1 fingerprint.
SSHFingerprintSHA256The server hostkey's SHA256 fingerprint.
SSHKeepAliveCountMaxThe maximum number of keep alive packets to send without a response.
SSHKeepAliveIntervalThe interval between keep alive packets.
SSHKeyExchangeAlgorithmsSpecifies the supported key exchange algorithms.
SSHKeyRenegotiateCauses the class to renegotiate the SSH keys.
SSHMacAlgorithmsSpecifies the supported Mac algorithms.
SSHPubKeyAuthSigAlgorithmsSpecifies the enabled signature algorithms that may be used when attempting public key authentication.
SSHPublicKeyAlgorithmsSpecifies the supported public key algorithms.
SSHVersionPatternThe pattern used to match the remote host's version string.
TryAllAvailableAuthMethodsIf set to true, the class will try all available authentication methods.
WaitForChannelCloseWhether to wait for channels to be closed before disconnected.
WaitForServerDisconnectWhether to wait for the server to close the connection.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the class binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
TcpNoDelayWhether or not to delay when sending packets.
UseIPv6Whether to use IPv6.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
ProcessIdleEventsWhether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillisThe length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPITells the class whether or not to use the system security libraries or an internal implementation.

Copyright (c) 2023 /n software inc. - All rights reserved.
IPWorks SSH 2020 iOS Edition - Version 20.0 [Build 8501]