Docs

IPWorks SSH 2022 PHP Edition

Version 22.0 [Build 8172]

SSHClient Class

Properties   Methods   Events   Configuration Settings   Errors  

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

Class Name

IPWorksSSH_SSHClient

Procedural Interface

 ipworksssh_sshclient_open();
 ipworksssh_sshclient_close($res);
 ipworksssh_sshclient_register_callback($res, $id, $function);
 ipworksssh_sshclient_get_last_error($res);
 ipworksssh_sshclient_get_last_error_code($res);
 ipworksssh_sshclient_set($res, $id, $index, $value);
 ipworksssh_sshclient_get($res, $id, $index);
 ipworksssh_sshclient_do_changerecordlength($res, $channelid, $recordlength);

 ipworksssh_sshclient_do_closechannel($res, $channelid);

 ipworksssh_sshclient_do_config($res, $configurationstring);

 ipworksssh_sshclient_do_connect($res);

 ipworksssh_sshclient_do_decodepacket($res, $encodedpacket);

 ipworksssh_sshclient_do_disconnect($res);

 ipworksssh_sshclient_do_doevents($res);

 ipworksssh_sshclient_do_encodepacket($res, $packet);

 ipworksssh_sshclient_do_exchangekeys($res);

 ipworksssh_sshclient_do_getsshparam($res, $payload, $field);

 ipworksssh_sshclient_do_getsshparambytes($res, $payload, $field);

 ipworksssh_sshclient_do_openchannel($res, $channeltype);

 ipworksssh_sshclient_do_opentcpipchannel($res, $desthost, $destport, $srchost, $srcport);

 ipworksssh_sshclient_do_openterminal($res, $channelid, $terminaltype, $width, $height, $usepixels, $modes);

 ipworksssh_sshclient_do_reset($res);

 ipworksssh_sshclient_do_sendbytes($res, $channelid, $data);

 ipworksssh_sshclient_do_sendchanneldata($res, $channelid, $data);

 ipworksssh_sshclient_do_sendsshpacket($res, $channelid, $packettype, $payload);

 ipworksssh_sshclient_do_sendtext($res, $channelid, $text);

 ipworksssh_sshclient_do_setsshparam($res, $payload, $fieldtype, $fieldvalue);

 ipworksssh_sshclient_do_sshlogoff($res);

 ipworksssh_sshclient_do_sshlogon($res, $sshhost, $sshport);

 ipworksssh_sshclient_do_startservice($res, $channelid, $service, $parameter);

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.
BytesSentThe number of bytes actually sent after a sending channel data.
ChannelIdAn id generated by the class to identify the current SSH channel.
DataToSendA string of data to be sent to the remote host.
ReadyToSendThis property is True when data can be sent over the SSH Channel.
RecordLengthThe length of received data records.
ServiceThis property holds the channel type that was requested when opening the channel.
ConnectedShows whether the class is connected.
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 transmission control protocol (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.
SSHAcceptServerHostKeyEncodedThis is the certificate (PEM/base64 encoded).
SSHAuthModeThe authentication method to be used the class when calling SSHLogon .
SSHCertEncodedThis is the certificate (PEM/base64 encoded).
SSHCertStoreThis is the name of the certificate store for the client certificate.
SSHCertStorePasswordIf the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
SSHCertStoreTypeThis is the type of certificate store for this certificate.
SSHCertSubjectThis is the 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.

ChangeRecordLengthChanges the length of received data records.
CloseChannelCloses a existing SSHChannel .
ConfigSets or retrieves a configuration setting.
ConnectConnects to the SSH host without logging in.
DecodePacketDecodes a hex-encoded SSH packet.
DisconnectThis method disconnects from the server without first logging off.
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.
SendBytesSends binary data to the specified channel.
SendChannelDataUsed to send data over an SSH channel.
SendSSHPacketUsed to send an encoded SSH packet to the server.
SendTextSends text to the specified channel.
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.

ConnectedFired immediately after a connection completes (or fails).
ConnectionStatusFired to indicate changes in connection state.
DisconnectedFired when a connection is closed.
ErrorInformation about errors during data delivery.
LogFires once for each log message.
SSHChannelClosedFired when a channel is closed.
SSHChannelDataFired when the SSHHost sends channel data to the client.
SSHChannelEOFFired when the remote peer signals the end of the data stream for the channel.
SSHChannelOpenedFired when a channel is successfully opened.
SSHChannelOpenRequestFired when a host attempts to open a new channel.
SSHChannelReadyToSendFired when the class is ready to send data.
SSHChannelRequestFired when the SSHHost sends a channel request to the client.
SSHChannelRequestedFired if the SSHChannelRequest was successful, any further processing for the channel request should be done here.
SSHCustomAuthFired when the class is doing custom authentication.
SSHKeyboardInteractiveFired when the class receives a request for user input from the server.
SSHServerAuthenticationFired after the server presents its public key to the client.
SSHStatusShows 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 signature algorithm 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.

SSHChannelCount Property (IPWorksSSH_SSHClient Class)

The number of records in the arrays.

Object Oriented Interface


public function getSSHChannelCount();


Procedural Interface


ipworksssh_sshclient_get($res, 1 );


Default Value

0

Remarks

This property controls the size of the following arrays:

The array indices start at 0 and end at SSHChannelCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

BytesSent Property (IPWorksSSH_SSHClient Class)

The number of bytes actually sent after a sending channel data.

Object Oriented Interface


public function getBytesSent($sshchannelid);


Procedural Interface


ipworksssh_sshclient_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_SSHClient Class)

An id generated by the class to identify the current SSH channel.

Object Oriented Interface


public function getChannelId($sshchannelid);


Procedural Interface


ipworksssh_sshclient_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

DataToSend Property (IPWorksSSH_SSHClient Class)

A string of data to be sent to the remote host.

Object Oriented Interface



public function setDataToSend($sshchannelid, $value);

Procedural Interface



ipworksssh_sshclient_set($res, 4, $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

ReadyToSend Property (IPWorksSSH_SSHClient Class)

This property is True when data can be sent over the SSH Channel.

Object Oriented Interface


public function getReadyToSend($sshchannelid);


Procedural Interface


ipworksssh_sshclient_get($res, 5 , $sshchannelid);


Default Value

false

Remarks

This property is True when data can be sent over the SSH Channel.

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.

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

Boolean

RecordLength Property (IPWorksSSH_SSHClient Class)

The length of received data records.

Object Oriented Interface


public function getRecordLength($sshchannelid);


public function setRecordLength($sshchannelid, $value);

Procedural Interface


ipworksssh_sshclient_get($res, 6 , $sshchannelid);


ipworksssh_sshclient_set($res, 6, $value , $sshchannelid);

Default Value

0

Remarks

The length of received data records. If set to a positive value, this setting defines the length of data records to be received. The class will accumulate data until RecordLength is reached and only then fire the SSHChannelDataIn event with data of length RecordLength. This allows data to be received as records of known length. This value can be changed at any time, including within the SSHChannelDataIn event.

The default value is 0, meaning this setting is not used.

Note:It is recommended to use the ChangeRecordLength 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 not available at design time.

Data Type

Integer

Service Property (IPWorksSSH_SSHClient Class)

This property holds the channel type that was requested when opening the channel.

Object Oriented Interface


public function getService($sshchannelid);


Procedural Interface


ipworksssh_sshclient_get($res, 7 , $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_SSHClient Class)

Shows whether the class is connected.

Object Oriented Interface


public function getConnected();


public function setConnected($value);

Procedural Interface


ipworksssh_sshclient_get($res, 8 );


ipworksssh_sshclient_set($res, 8, $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_SSHClient 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_sshclient_get($res, 9 );


ipworksssh_sshclient_set($res, 9, $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_SSHClient Class)

This property determines the type of firewall to connect through.

Object Oriented Interface


public function getFirewallType();


public function setFirewallType($value);

Procedural Interface


ipworksssh_sshclient_get($res, 10 );


ipworksssh_sshclient_set($res, 10, $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_SSHClient 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_sshclient_get($res, 11 );


ipworksssh_sshclient_set($res, 11, $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_SSHClient 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_sshclient_get($res, 12 );


ipworksssh_sshclient_set($res, 12, $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_SSHClient 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_sshclient_get($res, 13 );


ipworksssh_sshclient_set($res, 13, $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_SSHClient 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_sshclient_get($res, 14 );


ipworksssh_sshclient_set($res, 14, $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_SSHClient 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_sshclient_get($res, 15 );


ipworksssh_sshclient_set($res, 15, $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_SSHClient 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_sshclient_get($res, 16 );


ipworksssh_sshclient_set($res, 16, $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_SSHClient Class)

This is the certificate (PEM/base64 encoded).

Object Oriented Interface


public function getSSHAcceptServerHostKeyEncoded();


public function setSSHAcceptServerHostKeyEncoded($value);

Procedural Interface


ipworksssh_sshclient_get($res, 18 );


ipworksssh_sshclient_set($res, 18, $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_SSHClient 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_sshclient_get($res, 45 );


ipworksssh_sshclient_set($res, 45, $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 in the .NET client.
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.

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_SSHClient Class)

This is the certificate (PEM/base64 encoded).

Object Oriented Interface


public function getSSHCertEncoded();


public function setSSHCertEncoded($value);

Procedural Interface


ipworksssh_sshclient_get($res, 47 );


ipworksssh_sshclient_set($res, 47, $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_SSHClient 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_sshclient_get($res, 63 );


ipworksssh_sshclient_set($res, 63, $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 are designations of the most common User and Machine certificate stores in Windows:

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot 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. PKCS12 certificate store).

Data Type

Binary String

SSHCertStorePassword Property (IPWorksSSH_SSHClient 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_sshclient_get($res, 64 );


ipworksssh_sshclient_set($res, 64, $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_SSHClient Class)

This is the type of certificate store for this certificate.

Object Oriented Interface


public function getSSHCertStoreType();


public function setSSHCertStoreType($value);

Procedural Interface


ipworksssh_sshclient_get($res, 65 );


ipworksssh_sshclient_set($res, 65, $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 (PKCS12) file containing certificates.
3 (cstPFXBlob)The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) 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 PKCS7 file containing certificates.
12 (cstP7BBlob)The certificate store is a string (binary) representing a certificate store in PKCS7 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).
20 (cstSecurityKey)The certificate is present on a physical security key accessible via a PKCS11 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 cstSecurityKey, CertStorePassword to the PIN, and CertStore to the full path of the PKCS11 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 certmgr.CertStoreType = CertStoreTypes.cstSecurityKey; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstSecurityKey, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);

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.
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_SSHClient 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_sshclient_get($res, 66 );


ipworksssh_sshclient_set($res, 66, $value );

Default Value

''

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properites are set. When this property is set, a search is performed in the current certificate store certificate with 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 displayed below.

FieldMeaning
CNCommon Name. This is commonly a host name like www.server.com.
OOrganization
OUOrganizational Unit
LLocality
SState
CCountry
EEmail Address

If a field value contains a comma it must be quoted.

Data Type

String

SSHCompressionAlgorithms Property (IPWorksSSH_SSHClient Class)

A comma-separated list containing all allowable compression algorithms.

Object Oriented Interface


public function getSSHCompressionAlgorithms();


public function setSSHCompressionAlgorithms($value);

Procedural Interface


ipworksssh_sshclient_get($res, 74 );


ipworksssh_sshclient_set($res, 74, $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_SSHClient Class)

A comma-separated list containing all allowable encryption algorithms.

Object Oriented Interface


public function getSSHEncryptionAlgorithms();


public function setSSHEncryptionAlgorithms($value);

Procedural Interface


ipworksssh_sshclient_get($res, 75 );


ipworksssh_sshclient_set($res, 75, $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-ctr256-bit AES encryption in CTR mode
aes256-cbc256-bit AES encryption in CBC mode
aes192-ctr192-bit AES encryption in CTR mode
aes192-cbc192-bit AES encryption in CBC mode
aes128-ctr128-bit AES encryption in CTR mode
aes128-cbc128-bit AES encryption in CBC mode
3des-ctr192-bit (3-key) triple DES encryption in CTR mode
3des-cbc192-bit (3-key) triple DES encryption in CBC mode
cast128-cbcCAST-128 encryption
blowfish-cbcBlowfish encryption
arcfourARC4 encryption
arcfour128128-bit ARC4 encryption
arcfour256256-bit ARC4 encryption
aes256-gcm@openssh.com256-bit AES encryption in GCM mode.
aes128-gcm@openssh.com128-bit AES encryption in GCM mode.
chacha20-poly1305@openssh.comChaCha20 with Poly1305-AES encryption.

Data Type

String

SSHHost Property (IPWorksSSH_SSHClient Class)

The address of the SSH host.

Object Oriented Interface


public function getSSHHost();


public function setSSHHost($value);

Procedural Interface


ipworksssh_sshclient_get($res, 76 );


ipworksssh_sshclient_set($res, 76, $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

SSHKeyExchangeAlgorithms Property (IPWorksSSH_SSHClient Class)

A comma-separated list containing all allowable key exchange algorithms.

Object Oriented Interface


public function getSSHKeyExchangeAlgorithms();


public function setSSHKeyExchangeAlgorithms($value);

Procedural Interface


ipworksssh_sshclient_get($res, 77 );


ipworksssh_sshclient_set($res, 77, $value );

Default Value

'curve25519-sha256,curve25519-sha256@libssh.org,diffie-hellman-group14-sha1,diffie-hellman-group1-sha1,diffie-hellman-group14-sha256,diffie-hellman-group-exchange-sha256,diffie-hellman-group-exchange-sha1,ecdh-sha2-nistp256,diffie-hellman-group16-sha512,diffie-hellman-group18-sha512,ecdh-sha2-nistp384,ecdh-sha2-nistp521'

Remarks

SSH allows different algorithms to be negotiated for use when establishing the security layer of the connection. SSHKeyExchangeAlgorithms controls the key-exchange algorithm list supplied by the class to the SSHHost. It is a comma-separated list containing the names of key-exchange algorithms as defined by section 6.5 of the SSH Transport Layer specification (RFC 4253). The Key-exchange algorithms specified in RFC 4419 are also supported.

The value of this property must be a comma-separated list containing one or more of the following values:

  • 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

Data Type

String

SSHMacAlgorithms Property (IPWorksSSH_SSHClient Class)

A comma-separated list containing all allowable message authentication algorithms.

Object Oriented Interface


public function getSSHMacAlgorithms();


public function setSSHMacAlgorithms($value);

Procedural Interface


ipworksssh_sshclient_get($res, 78 );


ipworksssh_sshclient_set($res, 78, $value );

Default Value

'hmac-sha2-256,hmac-sha2-512,hmac-sha1,hmac-md5,hmac-ripemd160,hmac-sha1-96,hmac-md5-96,hmac-sha2-256-96,hmac-sha2-512-96,hmac-ripemd160-96,hmac-sha2-256-etm@openssh.com,hmac-sha2-512-etm@openssh.com'

Remarks

SSH allows different algorithms to be negotiated for use when establishing the security layer of the connection. SSHMacAlgorithms controls the message authentication code (MAC) algorithm list supplied by the class to the SSHHost. It is a comma-separated list containing the names of MAC algorithms as defined by section 6.4 of the SSH Transport Layer specification (RFC 4253).

The value of this property must be a comma-separated list containing one or more of the following values:

  • 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

Data Type

String

SSHPassword Property (IPWorksSSH_SSHClient Class)

The password for SSH password-based authentication.

Object Oriented Interface


public function getSSHPassword();


public function setSSHPassword($value);

Procedural Interface


ipworksssh_sshclient_get($res, 79 );


ipworksssh_sshclient_set($res, 79, $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_SSHClient 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_sshclient_get($res, 80 );


ipworksssh_sshclient_set($res, 80, $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

SSHPublicKeyAlgorithms Property (IPWorksSSH_SSHClient Class)

A comma-separated list containing all allowable public key authentication algorithms.

Object Oriented Interface


public function getSSHPublicKeyAlgorithms();


public function setSSHPublicKeyAlgorithms($value);

Procedural Interface


ipworksssh_sshclient_get($res, 81 );


ipworksssh_sshclient_set($res, 81, $value );

Default Value

'ssh-ed25519,ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521,rsa-sha2-256,rsa-sha2-512,ssh-rsa,ssh-dss,x509v3-sign-rsa,x509v3-sign-dss'

Remarks

SSH allows different algorithms to be negotiated for use when establishing the security layer of the connection. SSHPublicKeyAlgorithms controls the public key algorithm list supplied by the class to the SSHHost. It is a comma-separated list containing the names of public key algorithms as defined by section 6.6 of the SSH Transport Layer specification (RFC 4253).

The value of this property must be a comma-separated list containing one or more of the following values:

ssh-dssRaw DSS Key
ssh-rsaRaw RSA Key
rsa-sha2-256Raw RSA Key
rsa-sha2-512Raw RSA Key
x509v3-sign-rsaX509 RSA Certificate
x509v3-sign-dssX509 DSS Certificate
ecdsa-sha2-nistp256Raw EC Key with curve nistp256.

NOTE: This functionality is only available in Windows.

ecdsa-sha2-nistp384Raw EC Key with curve nistp384.

NOTE: This functionality is only available in Windows.

ecdsa-sha2-nistp521Raw EC Key with curve nistp521.

NOTE: This functionality is only available in Windows.

ssh-ed25519Ed25519 Key

Note: the algorithms listed by this property control only the public key algorithm used when authenticating the SSHHost. In most SSH server implementations, this list has no bearing on the public key algorithms that can be used to authenticate the client.

Data Type

String

SSHUser Property (IPWorksSSH_SSHClient Class)

The username for SSH authentication.

Object Oriented Interface


public function getSSHUser();


public function setSSHUser($value);

Procedural Interface


ipworksssh_sshclient_get($res, 82 );


ipworksssh_sshclient_set($res, 82, $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_SSHClient Class)

A timeout for the class.

Object Oriented Interface


public function getTimeout();


public function setTimeout($value);

Procedural Interface


ipworksssh_sshclient_get($res, 83 );


ipworksssh_sshclient_set($res, 83, $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

ChangeRecordLength Method (IPWorksSSH_SSHClient Class)

Changes the length of received data records.

Object Oriented Interface

public function doChangeRecordLength($channelid, $recordlength);

Procedural Interface

ipworksssh_sshclient_do_changerecordlength($res, $channelid, $recordlength);

Remarks

This method defines the length of data records to be received (in bytes) for the specified ChannelId.

If RecordLength is set to a positive value, the class will accumulate data until RecordLength bytes of data is received and only then fire the SSHChannelDataIn event with data of length RecordLength. This allows data to be received as records of known length. This method can be called at any time to change the record length, including within the DataIn event.

A value of 0 (default) means this functionality is not used.

CloseChannel Method (IPWorksSSH_SSHClient Class)

Closes a existing SSHChannel .

Object Oriented Interface

public function doCloseChannel($channelid);

Procedural Interface

ipworksssh_sshclient_do_closechannel($res, $channelid);

Remarks

ChannelId is the identifier for the SSH channel to be closed.

Config Method (IPWorksSSH_SSHClient Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

ipworksssh_sshclient_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.

Connect Method (IPWorksSSH_SSHClient Class)

Connects to the SSH host without logging in.

Object Oriented Interface

public function doConnect();

Procedural Interface

ipworksssh_sshclient_do_connect($res);

Remarks

This method establishes a connection with the SSHHost but does not log in. In most cases it is recommended to use the SSHLogon method which will both establish a connection and log in to the server.

This method may be useful in cases where it is desirable to separate the connection and logon operations, for instance confirming a host is available by first creating the connection.

DecodePacket Method (IPWorksSSH_SSHClient Class)

Decodes a hex-encoded SSH packet.

Object Oriented Interface

public function doDecodePacket($encodedpacket);

Procedural Interface

ipworksssh_sshclient_do_decodepacket($res, $encodedpacket);

Remarks

This method is used to decode an SSH packet created by EncodePacket.

Disconnect Method (IPWorksSSH_SSHClient Class)

This method disconnects from the server without first logging off.

Object Oriented Interface

public function doDisconnect();

Procedural Interface

ipworksssh_sshclient_do_disconnect($res);

Remarks

This method immediately disconnects from the server without first logging off.

In most cases the SSHLogoff method should be used to logoff and disconnect from the server. Call the Disconnect method in cases where it is desirable to immediately disconnect without first logging off.

DoEvents Method (IPWorksSSH_SSHClient Class)

Processes events from the internal message queue.

Object Oriented Interface

public function doEvents();

Procedural Interface

ipworksssh_sshclient_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_SSHClient Class)

Hex encodes an SSH packet.

Object Oriented Interface

public function doEncodePacket($packet);

Procedural Interface

ipworksssh_sshclient_do_encodepacket($res, $packet);

Remarks

This method is used to encode a raw SSH packet created by SetSSHParam.

ExchangeKeys Method (IPWorksSSH_SSHClient Class)

Causes the class to exchange a new set of session keys with the SSHHost .

Object Oriented Interface

public function doExchangeKeys();

Procedural Interface

ipworksssh_sshclient_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_SSHClient Class)

Used to read a field from an SSH packet's payload.

Object Oriented Interface

public function doGetSSHParam($payload, $field);

Procedural Interface

ipworksssh_sshclient_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.

GetSSHParamBytes Method (IPWorksSSH_SSHClient Class)

Used to read a field from an SSH packet's payload.

Object Oriented Interface

public function doGetSSHParamBytes($payload, $field);

Procedural Interface

ipworksssh_sshclient_do_getsshparambytes($res, $payload, $field);

Remarks

This method is the same as calling GetSSHParam, but returns raw bytes instead of strings.

OpenChannel Method (IPWorksSSH_SSHClient Class)

Opens a new SSHChannel .

Object Oriented Interface

public function doOpenChannel($channeltype);

Procedural Interface

ipworksssh_sshclient_do_openchannel($res, $channeltype);

Remarks

The SSH 2.0 specification allows for multiple channels to be opened over a single TCP/IP connection. The Channels property represents the channels that are currently open. A new SSHChannel can be opened with OpenChannel.

ChannelType represents the type of SSH channel to be opened. The most common type of channel is "session". To open a channel of type "direct-tcpip", use OpenTcpIpChannel.

If the call to OpenChannel succeeds, an SSHChannel will be created and added to the Channels collection.

OpenTcpIpChannel Method (IPWorksSSH_SSHClient Class)

Opens a special TCP/IP tunneling SSHChannel .

Object Oriented Interface

public function doOpenTcpIpChannel($desthost, $destport, $srchost, $srcport);

Procedural Interface

ipworksssh_sshclient_do_opentcpipchannel($res, $desthost, $destport, $srchost, $srcport);

Remarks

OpenTcpIpChannel opens a special SSHChannel of type "direct-tcpip". Unlike channels opened by OpenChannel, "direct-tcpip" channels are secured data tunnels that forward data through the SSHHost to another destination.

DestHost and DestPort represent, respectively, the host name or IP address and the port for which the data of this channel is bound. When OpenTcpIpChannel is called, the SSHHost will attempt to connect to the machine identified by these parameters.

Likewise, SrcHost and SrcPort identify the originator of the data. These may be different from LocalHost and LocalPort if the current instance of the class is being used to forward data from another TCP/IP client.

OpenTerminal Method (IPWorksSSH_SSHClient Class)

Creates a pseudo-terminal to be used to help display data for a channel.

Object Oriented Interface

public function doOpenTerminal($channelid, $terminaltype, $width, $height, $usepixels, $modes);

Procedural Interface

ipworksssh_sshclient_do_openterminal($res, $channelid, $terminaltype, $width, $height, $usepixels, $modes);

Remarks

OpenTerminal is used to establish a pseudo-terminal that will encode data sent over a "session" channel. ChannelId identifies the channel that will receive the terminal. TerminalType identifies the terminal protocol. Currently, only "vt100" is recognized by the SSH protocol specification, but other terminal types may be implemented by SSH server vendors.

Width and Height represent the size of the terminal display. If UsePixels is true, they represent the size in pixels, otherwise they represent the size in terms of fixed-width characters.

Modes is a list of encoded terminal modes. This value must be hex encoded. For instance "350000000000" is the hex encoded representation of the byte sequence 0x53, 0x00, 0x00, 0x00, 0x00, 0x00 (the terminal modes string to disable echo). The encoding of these modes is defined in Section 8 of the SSH Connection Specification (RFC 4254). The modes are encoded to a string as opcode-argument pairs. The opcode is always a single byte. For opcodes 1-159, the argument is a 32-bit integer. Opcodes 160-255 are currently undefined. Opcode '0' terminates the string. Note: a string containing a single NULL byte (ie the character literal '\0') represents an empty mode list.

The following opcodes are defined:

0TTY_OP_END Indicates end of options.
1VINTR Interrupt character; 255 if none. Similarly for the other characters. Not all of these characters are supported on all systems.
2VQUIT The quit character (sends SIGQUIT signal on POSIX systems).
3VERASE Erase the character to left of the cursor.
4VKILL Kill the current input line.
5VEOF End-of-file character (sends EOF from the terminal).
6VEOL End-of-line character in addition to carriage return and/or linefeed.
7VEOL2 Additional end-of-line character.
8VSTART Continues paused output (normally control-Q).
9VSTOP Pauses output (normally control-S).
10VSUSP Suspends the current program.
11VDSUSP Another suspend character.
12VREPRINT Reprints the current input line.
13VWERASE Erases a word left of cursor.
14VLNEXT Enter the next character typed literally, even if it is a special character
15VFLUSH Character to flush output.
16VSWTCH Switch to a different shell layer.
17VSTATUS Prints system status line (load, command, pid, etc).
18VDISCARD Toggles the flushing of terminal output.
30IGNPAR The ignore parity flag. The parameter SHOULD be 0 if this flag is FALSE, and 1 if it is TRUE.
31PARMRK Mark parity and framing errors.
32INPCK Enable checking of parity errors.
33ISTRIP Strip 8th bit off characters.
34INLCR Map NL into CR on input.
35IGNCR Ignore CR on input.
36ICRNL Map CR to NL on input.
37IUCLC Translate uppercase characters to lowercase.
38IXON Enable output flow control.
39IXANY Any char will restart after stop.
40IXOFF Enable input flow control.
41IMAXBEL Ring bell on input queue full.
50ISIG Enable signals INTR, QUIT, [D]SUSP.
51ICANON Canonicalize input lines.
52XCASE Enable input and output of uppercase characters by preceding their lowercase equivalents with "\".
53ECHO Enable echoing.
54ECHOE Visually erase chars.
55ECHOK Kill character discards current line.
56ECHONL Echo NL even if ECHO is off.
57NOFLSH Don't flush after interrupt.
58TOSTOP Stop background jobs from output.
59IEXTEN Enable extensions.
60ECHOCTL Echo control characters as ^(Char).
61ECHOKE Visual erase for line kill.
62PENDIN Retype pending input.
70OPOST Enable output processing.
71OLCUC Convert lowercase to uppercase.
72ONLCR Map NL to CR-NL.
73OCRNL Translate carriage return to newline (output).
74ONOCR Translate newline to carriage return-newline (output).
75ONLRET Newline performs a carriage return (output).
90CS7 7 bit mode.
91CS8 8 bit mode.
92PARENB Parity enable.
93PARODD Odd parity, else even.
128TTY_OP_ISPEED Specifies the input baud rate in bits per second.
129TTY_OP_OSPEED Specifies the output baud rate in bits per second.

Reset Method (IPWorksSSH_SSHClient Class)

Reset the class.

Object Oriented Interface

public function doReset();

Procedural Interface

ipworksssh_sshclient_do_reset($res);

Remarks

This method will reset the class's properties to their default values.

SendBytes Method (IPWorksSSH_SSHClient Class)

Sends binary data to the specified channel.

Object Oriented Interface

public function doSendBytes($channelid, $data);

Procedural Interface

ipworksssh_sshclient_do_sendbytes($res, $channelid, $data);

Remarks

This method sends binary data to the channel identified by ChannelId. To send text use the SendText method instead.

SendChannelData Method (IPWorksSSH_SSHClient Class)

Used to send data over an SSH channel.

Object Oriented Interface

public function doSendChannelData($channelid, $data);

Procedural Interface

ipworksssh_sshclient_do_sendchanneldata($res, $channelid, $data);

Remarks

This method can be used to send arbitrary data to the channel with the specified ChannelId.

SendSSHPacket Method (IPWorksSSH_SSHClient Class)

Used to send an encoded SSH packet to the server.

Object Oriented Interface

public function doSendSSHPacket($channelid, $packettype, $payload);

Procedural Interface

ipworksssh_sshclient_do_sendsshpacket($res, $channelid, $packettype, $payload);

Remarks

This method can be used to send a previously built SSH payload to the server. ChannelId identifies the channel that will receive the packet.

PacketType identifies what kind of packet is to be sent. Payload should contain the payload of the packet, which can be built by successive calls to SetSSHParam.

When SendSSHPacket is called, the class will finish building the packet, encrypt it for transport, and send it to the server.

SendText Method (IPWorksSSH_SSHClient Class)

Sends text to the specified channel.

Object Oriented Interface

public function doSendText($channelid, $text);

Procedural Interface

ipworksssh_sshclient_do_sendtext($res, $channelid, $text);

Remarks

This method sends text to the client identified by ChannelId. To send binary data use the SendBytes method instead.

SetSSHParam Method (IPWorksSSH_SSHClient Class)

Used to write a field to the end of a payload.

Object Oriented Interface

public function doSetSSHParam($payload, $fieldtype, $fieldvalue);

Procedural Interface

ipworksssh_sshclient_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:

sA plaintext string containing the default system encoding of the data.
sbA string containing the hex encoded data. (eg: "A1B23C")
mA variable-length large integer, encoded as a textual representation of the value ("1234").
iA 32-bit integer, encoded as a textual representation of the value (eg: "1234").
lA 64-bit integer, encoded as a textual representation of the value (eg: "1234").
bA single byte, encoded as a textual representation of the value (eg: "123").
fA 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.

SSHLogoff Method (IPWorksSSH_SSHClient Class)

Logoff from the SSH server.

Object Oriented Interface

public function doSSHLogoff();

Procedural Interface

ipworksssh_sshclient_do_sshlogoff($res);

Remarks

Logoff from the SSH server. If that fails, the connection is terminated by the local host.

SSHLogon Method (IPWorksSSH_SSHClient Class)

Logon to the SSHHost using the current SSHUser and SSHPassword .

Object Oriented Interface

public function doSSHLogon($sshhost, $sshport);

Procedural Interface

ipworksssh_sshclient_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)

StartService Method (IPWorksSSH_SSHClient Class)

Requests the given service on a target channel.

Object Oriented Interface

public function doStartService($channelid, $service, $parameter);

Procedural Interface

ipworksssh_sshclient_do_startservice($res, $channelid, $service, $parameter);

Remarks

After a "session" channel has been opened by a call to OpenChannel, a service may be requested for that channel. ChannelId identifies the channel on which the service is to be started.

Service identifies the service being requested. The following list defines some known services:

"shell"Starts a shell on the
"exec"Executes the command identified by Parameter.
"subsystem"Starts up a subsystem identified by Parameter, such as "sftp".

Connected Event (IPWorksSSH_SSHClient Class)

Fired immediately after a connection completes (or fails).

Object Oriented Interface

public function fireConnected($param);

Procedural Interface

ipworksssh_sshclient_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 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_SSHClient Class)

Fired to indicate changes in connection state.

Object Oriented Interface

public function fireConnectionStatus($param);

Procedural Interface

ipworksssh_sshclient_register_callback($res, 2, array($this, 'fireConnectionStatus'));

Parameter List

 'connectionevent'
'statuscode'
'description'

Remarks

The ConnectionStatus event is fired when the connection state changes: completion of a firewall or proxy connection, completion of a security handshake, etc.

The ConnectionEvent parameter indicates the type of connection event. Values may include:

Firewall connection complete.
SSL or S/Shell handshake complete (where applicable).
Remote host connection complete.
Remote host disconnected.
SSL or S/Shell connection broken.
Firewall host disconnected.

StatusCode has the error code returned by the TCP/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.

Disconnected Event (IPWorksSSH_SSHClient Class)

Fired when a connection is closed.

Object Oriented Interface

public function fireDisconnected($param);

Procedural Interface

ipworksssh_sshclient_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 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_SSHClient Class)

Information about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

ipworksssh_sshclient_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.

ErrorCode contains an error code and Description 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_SSHClient Class)

Fires once for each log message.

Object Oriented Interface

public function fireLog($param);

Procedural Interface

ipworksssh_sshclient_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.

SSHChannelClosed Event (IPWorksSSH_SSHClient Class)

Fired when a channel is closed.

Object Oriented Interface

public function fireSSHChannelClosed($param);

Procedural Interface

ipworksssh_sshclient_register_callback($res, 6, 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_SSHClient Class)

Fired when the SSHHost sends channel data to the client.

Object Oriented Interface

public function fireSSHChannelData($param);

Procedural Interface

ipworksssh_sshclient_register_callback($res, 7, 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_SSHClient 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_sshclient_register_callback($res, 8, 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_SSHClient Class)

Fired when a channel is successfully opened.

Object Oriented Interface

public function fireSSHChannelOpened($param);

Procedural Interface

ipworksssh_sshclient_register_callback($res, 9, 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_SSHClient Class)

Fired when a host attempts to open a new channel.

Object Oriented Interface

public function fireSSHChannelOpenRequest($param);

Procedural Interface

ipworksssh_sshclient_register_callback($res, 10, array($this, 'fireSSHChannelOpenRequest'));

Parameter List

 'channelid'
'service'
'parameters'
'accept'

Remarks

This event is fired whenever a host attempts to open a new channel. ChannelId will contain the id of the channel to be created. Service will identify the type of channel that is being requested (e.g.: "session"). Set Accept to true to accept the channel open request.

If the channel open request contains extra information, it will be contained in Parameters; you can extract data from it using GetSSHParam and GetSSHParamBytes. The most common example of a request with parameters would be a request with Service set to "direct-tcpip" (for SSH tunneling); in that case Parameters will contain the host to connect (string), the port to connect (int), the originator IP address (string) and the originator TCP port (int).

SSHChannelReadyToSend Event (IPWorksSSH_SSHClient Class)

Fired when the class is ready to send data.

Object Oriented Interface

public function fireSSHChannelReadyToSend($param);

Procedural Interface

ipworksssh_sshclient_register_callback($res, 11, 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_SSHClient Class)

Fired when the SSHHost sends a channel request to the client.

Object Oriented Interface

public function fireSSHChannelRequest($param);

Procedural Interface

ipworksssh_sshclient_register_callback($res, 12, 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_SSHClient 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_sshclient_register_callback($res, 13, 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_SSHClient Class)

Fired when the class is doing custom authentication.

Object Oriented Interface

public function fireSSHCustomAuth($param);

Procedural Interface

ipworksssh_sshclient_register_callback($res, 14, 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_SSHClient Class)

Fired when the class receives a request for user input from the server.

Object Oriented Interface

public function fireSSHKeyboardInteractive($param);

Procedural Interface

ipworksssh_sshclient_register_callback($res, 15, 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_SSHClient Class)

Fired after the server presents its public key to the client.

Object Oriented Interface

public function fireSSHServerAuthentication($param);

Procedural Interface

ipworksssh_sshclient_register_callback($res, 16, 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
To limit the accepted host key algorithms refer to SSHPublicKeyAlgorithms.

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_SSHClient Class)

Shows the progress of the secure connection.

Object Oriented Interface

public function fireSSHStatus($param);

Procedural Interface

ipworksssh_sshclient_register_callback($res, 17, 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.

Configuration Settings (SSHClient 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.

SSHClient Configuration Settings

ClientSSHVersionString:   The SSH version string used by the class.

This configuration setting specifies the SSH version string used by the class. The default value is "SSH-2.0-IPWorks SSH Client 2022".

EnablePageantAuth:   Whether to use a key stored in Pageant to perform client authentication.

This setting controls whether Pageant authentication is disabled, enabled, or required. When enabled or required, the class attempts to communicate with PuTTY's ssh-agent, called "Pageant", over shared memory to perform public key authentication. Possible values and the corresponding behavior is described below:

ValueDescription
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.

KerberosDelegation:   If true, asks for credentials with delegation enabled during authentication.

The default value is "True". If set to "False", the client will not ask for credentials delegation support during authentication. Note that even if the client asks for delegation, the server/KDC might not grant it and authentication will still succeed.

KerberosRealm:   The fully qualified domain name of the Kerberos Realm to use for GSSAPI authentication.

This property may be set to the fully qualified (DNS) name of the kerberos realm (or Windows Active Directory domain name) to use during GSSAPI authentication. This can be used to force authentication with a given realm if the client and server machines are not part of the same domain.

KerberosSPN:   The Kerberos Service Principal Name of the SSH host.

This property can be set to specify the Service Principal Name (SPN) associated with the SSH service on the remote host. This will usually be in the form "host/fqdn.of.sshhost[@REALM]". If not specified, the class will assume the SPN is based on the value of the SSHHost property and the kerberos realm used for authentication.

KeyRenegotiationThreshold:   Sets the threshold for the SSH Key Renegotiation.

This property allows you to specify the threshold, in the number of bytes, for the SSH Key Renegotiation. The default value for this property is set to 1 GB.

Example (for setting the threshold to 500 MB): SSHComponent.Config("KeyRenegotiationThreshold=524288000")

LogLevel:   Specifies the level of detail that is logged.

This setting controls the level of detail that is logged through the Log event. 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.

MaxPacketSize:   The maximum packet size of the channel, in bytes.

This setting specifies the maximum size of an individual data packet, in bytes, that can be sent to the sender.

MaxWindowSize:   The maximum window size allowed for the channel, in bytes.

This setting specifies how many bytes of channel data can be sent to the sender of this message without adjusting the window. Note that this value may be changed during the connection, but the window size can only be increased, not decreased.

PasswordPrompt:   The text of the password prompt used in keyboard-interactive authentication.

This setting optionally specifies a pattern to be matched to the prompt received from the server during keyboard-interactive authentication. If a matching prompt is detected the class automatically responds to the prompt with the password specified by SSHPassword.

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. I.E., C*t matches Cat, Cot, Coast, Ct, etc)
[,-] A range of characters. E.g.: [a-z], [a], [0-9], [0-9,a-d,f,r-z], etc.
\ The slash is ignored and exact matching is performed on the next character.

If the above characters need to be used as a literal in a pattern then they must be escaped by surrounding them with a []. (Note, "]" and "-" do not need to be escaped) See below for the escape sequences:

CharacterEscape Sequence
? [?]
* [*]
[ [[]
\ [\]

For example, to match the value [Something].txt specify the pattern [[]Something].txt

PreferredDHGroupBits:   The size (in bits) of the preferred modulus (p) to request from the server.

This may be when using the diffie-hellman-group-exchange-sha1 or diffie-hellman-group-exchange-sha256 key exchange algorithms to control the preferred size, in bits, of the modulus (p) prime number to request from the server. Acceptable values are between 1024 and 8192.

RecordLength:   The length of received data records.

If set to a positive value, this setting defines the length of data records to be received. The class will accumulate data until RecordLength is reached and only then fire the DataIn event with data of length RecordLength. This allows data to be received as records of known length. This value can be changed at any time, including within the DataIn event.

The default value is 0, meaning this setting is not used.

ServerSSHVersionString:   The remote host's SSH version string.

This will return the remote host's SSH version string, which can help when identifying problematic servers. This configuration setting is read-only.

SignedSSHCert:   The CA signed client public key used when authenticating.

When authenticating via public key authentication this setting may be set to the CA signed client's public key. This is useful when the server has been configured to trust client keys signed by a particular CA. For instance: 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...

SSHAcceptAnyServerHostKey:   If set the class will accept any key presented by the server.

The default value is "False". Set this to "True" to accept any key presented by the server.

SSHAcceptServerCAKey:   The CA public key that signed the server's host key.

If the server's host key was signed by a CA, this setting may be used to specify the CA's public key. If specified the class will trust any server's host key that was signed by the CA. For instance: component.Config("SSHAcceptServerCAKey=ssh-rsa AAAAB3NzaC1yc2EAAAADAQAB...");

SSHAcceptServerHostKeyFingerPrint:   The fingerprint of the server key to accept.

This may be set to a comma-delimited collection of 16-byte MD5 fingerprints that should be accepted as the host's key. You may supply it by HEX encoding the values in the form "0a:1b:2c:3d". Example: 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.

SSHFingerprintHashAlgorithm:   The algorithm used to calculate the fingerprint.

This configuration setting controls which hash algorithm is used to calculate the hostkey's fingerprint, displayed when SSHServerAuthentication fires. Valid values are:

  • MD5
  • SHA1
  • SHA256 (default)
SSHFingerprintMD5:   The server hostkey's MD5 fingerprint.

This setting may be queried in SSHServerAuthentication to get the server hostkey's MD5 fingerprint.

SSHFingerprintSHA1:   The server hostkey's SHA1 fingerprint.

This setting may be queried in SSHServerAuthentication to get the server hostkey's SHA1 fingerprint.

SSHFingerprintSHA256:   The server hostkey's SHA256 fingerprint.

This setting may be queried in SSHServerAuthentication to get the server hostkey's SHA256 fingerprint.

SSHKeepAliveCountMax:   The maximum number of keep alive packets to send without a response.

This setting specifies the maximum number of keep alive packets to send when no response is received. Normally a response to a keep alive packet is received right away. If no response is received the class will continue to send keep alive packets until SSHKeepAliveCountMax is reached. If this is reached the class will assume the connection is broken and disconnect. The default value is 5.

SSHKeepAliveInterval:   The interval between keep alive packets.

This setting specifies the number of seconds between keep alive packets. If set to a positive value the class will send a SSH keep alive packet after KeepAliveInterval seconds of inactivity. This setting only takes effect when there is no activity, if any data is sent or received over the connection it will reset the timer.

The default value is 0 meaning no keep alives will be sent.

Note: The SSHReverseTunnel class uses a default value of 30.

SSHKeyExchangeAlgorithms:   Specifies the supported key exchange algorithms.

This may be used to specify the list of supported Key Exchange algorithms used during SSH negotiation. The value should contain a comma separated list of algorithms. Supported algorithms are:

  • 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
The default value is: curve25519-sha256,curve25519-sha256@libssh.org,diffie-hellman-group14-sha1,diffie-hellman-group1-sha1,diffie-hellman-group14-sha256,diffie-hellman-group-exchange-sha256,diffie-hellman-group-exchange-sha1,ecdh-sha2-nistp256,diffie-hellman-group16-sha512,diffie-hellman-group18-sha512,ecdh-sha2-nistp384,ecdh-sha2-nistp521.
SSHKeyRenegotiate:   Causes the component to renegotiate the SSH keys.

Once this setting is set the component will renegotiate the SSH keys with the remote host.

Example: SSHClient.Config("SSHKeyRenegotiate")

SSHMacAlgorithms:   Specifies the supported Mac algorithms.

This may be used to specify an alternate list of supported Mac algorithms used during SSH negotiation. This also specifies the order in which the Mac algorithms are preferred. The value should contain a comma separated list of algorithms. Supported algorithms are:

  • 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
The default value is hmac-sha2-256,hmac-sha2-512,hmac-sha1,hmac-md5,hmac-ripemd160,hmac-sha1-96,hmac-md5-96,hmac-sha2-256-96,hmac-sha2-512-96,hmac-ripemd160-96,hmac-sha2-256-etm@openssh.com,hmac-sha2-512-etm@openssh.com.
SSHPubKeyAuthSigAlgorithms:   Specifies the signature algorithm when attempting public key authentication.

This setting specifies a list of signature algorithms that may be used when authenticating to the server using public key authentication. This applies only when public key authentication is performed by the client.

The setting should be a comma separated list of algorithms ordered by preference. At runtime the class will evaluate each algorithm in the order specified here. 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 (default)
  • ssh-dss (default)
  • rsa-sha2-256 (default)
  • rsa-sha2-512 (default)
  • ecdsa-sha2-nistp256 (default - windows only)
  • ecdsa-sha2-nistp384 (default - windows only)
  • ecdsa-sha2-nistp521 (default - windows only)
  • 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.

The default value in Unix/macOS/Java is ssh-rsa,rsa-sha2-256,rsa-sha2-512,ssh-dss.

Note that ECDSA algorithms are only supported in Windows.

SSHPublicKeyAlgorithms:   Specifies the supported public key algorithms.

This setting specifies the allowed public key algorithms. This list controls only the public key algorithm used when authenticating to the server. This list has no bearing on the public key algorithms that can be used to authenticate the client. The default value is ssh-ed25519,ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521,rsa-sha2-256,rsa-sha2-512,ssh-rsa,ssh-dss,x509v3-sign-rsa,x509v3-sign-dss.

SSHVersionPattern:   The pattern used to match the remote host's version string.

This configuration setting specifies the pattern used to accept or deny the remote host's SSH version string. It takes a comma-delimited list of patterns to match. The default value is "*SSH-1.99-*,*SSH-2.0-*" and will accept connections from SSH 1.99 and 2.0 hosts. As an example, the below value would accept connections for SSH 1.99, 2.0, and 2.99 hosts.

*SSH-1.99-*,*SSH-2.0-*,*SSH-2.99-*
TryAllAvailableAuthMethods:   If set to true, the class will try all available authentication methods.

The default value is false. When set to true, the class will try to authenticate using all methods that it has credentials for and the server supports.

WaitForChannelClose:   Whether to wait for channels to be closed before disconnected.

This setting controls whether the class will wait for a server response to the SSH_MSG_CHANNEL_CLOSE when disconnecting. When the class disconnects it will first attempt to close all open channels by sending a SSH_MSG_CHANNEL_CLOSE for each channel. This setting controls whether the class will wait for a server response after sending the messages.

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.

WaitForServerDisconnect:   Whether to wait for the server to close the connection.

This setting controls whether to wait for the server to close the connection when SSHLogoff is called.

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.

IPPort Configuration Settings

ConnectionTimeout:   Sets a separate timeout value for establishing a connection.

When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the class will use Timeout for establishing a connection and transmitting/receiving data.

FirewallAutoDetect:   Tells the class whether or not to automatically detect and use firewall system settings, if available.

This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallHost:   Name or IP address of firewall (optional).

If a FirewallHost is given, requested connections will be authenticated through the specified firewall when connecting.

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.

FirewallPassword:   Password to be used if authentication is to be used when connecting through the firewall.

If FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

NOTE: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallPort:   The TCP port for the FirewallHost;.

Note that the FirewallPort is set automatically when FirewallType is set to a valid value.

NOTE: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallType:   Determines the type of firewall to connect through.

The appropriate values are as follows:

0No firewall (default setting).
1Connect through a tunneling proxy. FirewallPort is set to 80.
2Connect through a SOCKS4 Proxy. FirewallPort is set to 1080.
3Connect through a SOCKS5 Proxy. FirewallPort is set to 1080.
10Connect 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.

FirewallUser:   A user name if authentication is to be used connecting through a firewall.

If the FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the Firewall. If the authentication fails, the class fails with an error.

NOTE: This setting is provided for use by classs that do not directly expose Firewall properties.

KeepAliveInterval:   The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.

When set, TCPKeepAlive will automatically be set to true. A TCP keep-alive packet will be sent after a period of inactivity as defined by KeepAliveTime. If no acknowledgement is received from the remote host the keep-alive packet will be re-sent. This setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second.

Note: This value is not applicable in macOS.

KeepAliveTime:   The inactivity time in milliseconds before a TCP keep-alive packet is sent.

When set, TCPKeepAlive will automatically be set to true. By default the operating system will determine the time a connection is idle before a TCP keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases a shorter interval is more useful. Set this value to the desired interval in milliseconds.

Linger:   When set to True, connections are terminated gracefully.

This property controls how a connection is closed. The default is True.

In the case that Linger is True (default), there are two scenarios for determining how long the connection will linger. The first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP protocol timeout expires.

In the second scenario, 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 is 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 (by a client acknowledgment, for example), setting this property to False might be the appropriate course of action.

LingerTime:   Time in seconds to have the connection linger.

LingerTime is the time, in seconds, to leave the socket connection linger. This value is 0 by default, which means it will use the default IP protocol timeout.

LocalHost:   The name of the local host through which connections are initiated or accepted.

The LocalHost setting 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 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).

LocalPort:   The port in the local host where the class binds.

This 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 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.

MaxLineLength:   The maximum amount of data to accumulate when no EOL is found.

MaxLineLength is the size of an internal buffer, which holds received data while waiting for an EOL string.

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.

MaxTransferRate:   The transfer rate limit in bytes per second.

This setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default this is not set and there is no limit.

ProxyExceptionsList:   A semicolon separated list of hosts and IPs to bypass when using a proxy.

This setting optionally specifies a semicolon separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property the proxy will not be used. For instance:

www.google.com;www.nsoftware.com

TCPKeepAlive:   Determines whether or not the keep alive socket option is enabled.

If set to true, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set KeepAliveTime and KeepAliveInterval to configure the timing of the keep-alive packets.

Note: This value is not applicable in Java.

TcpNoDelay:   Whether or not to delay when sending packets.

When true, the socket will send all data that is ready to send at once. When false, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.

By default, this config is set to false.

UseIPv6:   Whether to use IPv6.

When set to 0 (default), the class will use IPv4 exclusively. When set to 1, the class will use IPv6 exclusively. To instruct the class to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to 2. The default value is 0. Possible values are:

0 IPv4 Only
1 IPv6 Only
2 IPv6 with IPv4 fallback

Socket Configuration Settings

AbsoluteTimeout:   Determines whether timeouts are inactivity timeouts or absolute timeouts.

If AbsoluteTimeout is set to True, any method which does not complete within Timeout seconds will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.

Note: This option is not valid for UDP ports.

FirewallData:   Used to send extra data to the firewall.

When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g. headers for custom authentication schemes).

InBufferSize:   The size in bytes of the incoming queue of the socket.

This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. Increasing the value of the InBufferSize setting can provide significant improvements in performance in some cases.

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.

OutBufferSize:   The size in bytes of the outgoing queue of the socket.

This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. Increasing the value of the OutBufferSize setting can provide significant improvements in performance in some cases.

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 Configuration Settings

BuildInfo:   Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

CodePage:   The system code page used for Unicode to Multibyte translations.

The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

IdentifierName
037IBM EBCDIC - U.S./Canada
437OEM - United States
500IBM EBCDIC - International
708Arabic - ASMO 708
709Arabic - ASMO 449+, BCON V4
710Arabic - Transparent Arabic
720Arabic - Transparent ASMO
737OEM - Greek (formerly 437G)
775OEM - Baltic
850OEM - Multilingual Latin I
852OEM - Latin II
855OEM - Cyrillic (primarily Russian)
857OEM - Turkish
858OEM - Multilingual Latin I + Euro symbol
860OEM - Portuguese
861OEM - Icelandic
862OEM - Hebrew
863OEM - Canadian-French
864OEM - Arabic
865OEM - Nordic
866OEM - Russian
869OEM - Modern Greek
870IBM EBCDIC - Multilingual/ROECE (Latin-2)
874ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875IBM EBCDIC - Modern Greek
932ANSI/OEM - Japanese, Shift-JIS
936ANSI/OEM - Simplified Chinese (PRC, Singapore)
949ANSI/OEM - Korean (Unified Hangul Code)
950ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026IBM EBCDIC - Turkish (Latin-5)
1047IBM EBCDIC - Latin 1/Open System
1140IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141IBM EBCDIC - Germany (20273 + Euro symbol)
1142IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144IBM EBCDIC - Italy (20280 + Euro symbol)
1145IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147IBM EBCDIC - France (20297 + Euro symbol)
1148IBM EBCDIC - International (500 + Euro symbol)
1149IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201Unicode UCS-2 Big-Endian
1250ANSI - Central European
1251ANSI - Cyrillic
1252ANSI - Latin I
1253ANSI - Greek
1254ANSI - Turkish
1255ANSI - Hebrew
1256ANSI - Arabic
1257ANSI - Baltic
1258ANSI/OEM - Vietnamese
1361Korean (Johab)
10000MAC - Roman
10001MAC - Japanese
10002MAC - Traditional Chinese (Big5)
10003MAC - Korean
10004MAC - Arabic
10005MAC - Hebrew
10006MAC - Greek I
10007MAC - Cyrillic
10008MAC - Simplified Chinese (GB 2312)
10010MAC - Romania
10017MAC - Ukraine
10021MAC - Thai
10029MAC - Latin II
10079MAC - Icelandic
10081MAC - Turkish
10082MAC - Croatia
12000Unicode UCS-4 Little-Endian
12001Unicode UCS-4 Big-Endian
20000CNS - Taiwan
20001TCA - Taiwan
20002Eten - Taiwan
20003IBM5550 - Taiwan
20004TeleText - Taiwan
20005Wang - Taiwan
20105IA5 IRV International Alphabet No. 5 (7-bit)
20106IA5 German (7-bit)
20107IA5 Swedish (7-bit)
20108IA5 Norwegian (7-bit)
20127US-ASCII (7-bit)
20261T.61
20269ISO 6937 Non-Spacing Accent
20273IBM EBCDIC - Germany
20277IBM EBCDIC - Denmark/Norway
20278IBM EBCDIC - Finland/Sweden
20280IBM EBCDIC - Italy
20284IBM EBCDIC - Latin America/Spain
20285IBM EBCDIC - United Kingdom
20290IBM EBCDIC - Japanese Katakana Extended
20297IBM EBCDIC - France
20420IBM EBCDIC - Arabic
20423IBM EBCDIC - Greek
20424IBM EBCDIC - Hebrew
20833IBM EBCDIC - Korean Extended
20838IBM EBCDIC - Thai
20866Russian - KOI8-R
20871IBM EBCDIC - Icelandic
20880IBM EBCDIC - Cyrillic (Russian)
20905IBM EBCDIC - Turkish
20924IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932JIS X 0208-1990 & 0121-1990
20936Simplified Chinese (GB2312)
21025IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027Extended Alpha Lowercase
21866Ukrainian (KOI8-U)
28591ISO 8859-1 Latin I
28592ISO 8859-2 Central Europe
28593ISO 8859-3 Latin 3
28594ISO 8859-4 Baltic
28595ISO 8859-5 Cyrillic
28596ISO 8859-6 Arabic
28597ISO 8859-7 Greek
28598ISO 8859-8 Hebrew
28599ISO 8859-9 Latin 5
28605ISO 8859-15 Latin 9
29001Europa 3
38598ISO 8859-8 Hebrew
50220ISO 2022 Japanese with no halfwidth Katakana
50221ISO 2022 Japanese with halfwidth Katakana
50222ISO 2022 Japanese JIS X 0201-1989
50225ISO 2022 Korean
50227ISO 2022 Simplified Chinese
50229ISO 2022 Traditional Chinese
50930Japanese (Katakana) Extended
50931US/Canada and Japanese
50933Korean Extended and Korean
50935Simplified Chinese Extended and Simplified Chinese
50936Simplified Chinese
50937US/Canada and Traditional Chinese
50939Japanese (Latin) Extended and Japanese
51932EUC - Japanese
51936EUC - Simplified Chinese
51949EUC - Korean
51950EUC - Traditional Chinese
52936HZ-GB2312 Simplified Chinese
54936Windows XP: GB18030 Simplified Chinese (4 Byte)
57002ISCII Devanagari
57003ISCII Bengali
57004ISCII Tamil
57005ISCII Telugu
57006ISCII Assamese
57007ISCII Oriya
57008ISCII Kannada
57009ISCII Malayalam
57010ISCII Gujarati
57011ISCII Punjabi
65000Unicode UTF-7
65001Unicode UTF-8

The following is a list of valid code page identifiers for Mac OS only:

IdentifierName
1ASCII
2NEXTSTEP
3JapaneseEUC
4UTF8
5ISOLatin1
6Symbol
7NonLossyASCII
8ShiftJIS
9ISOLatin2
10Unicode
11WindowsCP1251
12WindowsCP1252
13WindowsCP1253
14WindowsCP1254
15WindowsCP1250
21ISO2022JP
30MacOSRoman
10UTF16String
0x90000100UTF16BigEndian
0x94000100UTF16LittleEndian
0x8c000100UTF32String
0x98000100UTF32BigEndian
0x9c000100UTF32LittleEndian
65536Proprietary

LicenseInfo:   Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:

  • 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).
ProcessIdleEvents:   Whether the class uses its internal event loop to process events when the main thread is idle.

If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True.

SelectWaitMillis:   The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.

If there are no events to process when DoEvents is called, the class will wait for the amount of time specified here before returning. The default value is 20.

UseInternalSecurityAPI:   Tells the class whether or not to use the system security libraries or an internal implementation.

By default the class will use the system security libraries to perform cryptographic functions. Setting this to True tells the class to use the internal implementation instead of using the system's security API.

Trappable Errors (SSHClient Class)

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.

IPPort 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   Cannot change 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).

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks SSH 2022 PHP Edition - Version 22.0 [Build 8172]