SSHClient Class

Properties   Methods   Events   Config Settings   Errors  

The SSHClient class implements a fully functional, open-ended Secure Shell (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.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

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.

Config Settings

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

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:

• BytesSent
• ChannelEOL
• ChannelId
• FirewallAutoDetect
• FirewallHost
• FirewallPassword
• FirewallPort
• FirewallType
• FirewallUser
• MaxChannelLength
• ReadyToSend
• RecordLength
• Service
• SSHAcceptServerHostKeyEffectiveDate
• SSHAcceptServerHostKeyEncoded
• SSHAcceptServerHostKeyExpirationDate
• SSHAcceptServerHostKeyExtendedKeyUsage
• SSHAcceptServerHostKeyFingerprint
• SSHAcceptServerHostKeyFingerprintSHA1
• SSHAcceptServerHostKeyFingerprintSHA256
• SSHAcceptServerHostKeyIssuer
• SSHAcceptServerHostKeyPrivateKey
• SSHAcceptServerHostKeyPrivateKeyAvailable
• SSHAcceptServerHostKeyPrivateKeyContainer
• SSHAcceptServerHostKeyPublicKey
• SSHAcceptServerHostKeyPublicKeyAlgorithm
• SSHAcceptServerHostKeyPublicKeyLength
• SSHAcceptServerHostKeySerialNumber
• SSHAcceptServerHostKeySignatureAlgorithm
• SSHAcceptServerHostKeyStore
• SSHAcceptServerHostKeyStorePassword
• SSHAcceptServerHostKeyStoreType
• SSHAcceptServerHostKeySubject
• SSHAcceptServerHostKeySubjectAltNames
• SSHAcceptServerHostKeyThumbprintMD5
• SSHAcceptServerHostKeyThumbprintSHA1
• SSHAcceptServerHostKeyThumbprintSHA256
• SSHAcceptServerHostKeyUsage
• SSHAcceptServerHostKeyUsageFlags
• SSHAcceptServerHostKeyVersion
• SSHCertEffectiveDate
• SSHCertEncoded
• SSHCertExpirationDate
• SSHCertExtendedKeyUsage
• SSHCertFingerprint
• SSHCertFingerprintSHA1
• SSHCertFingerprintSHA256
• SSHCertIssuer
• SSHCertPrivateKey
• SSHCertPrivateKeyAvailable
• SSHCertPrivateKeyContainer
• SSHCertPublicKey
• SSHCertPublicKeyAlgorithm
• SSHCertPublicKeyLength
• SSHCertSerialNumber
• SSHCertSignatureAlgorithm
• SSHCertStore
• SSHCertStorePassword
• SSHCertStoreType
• SSHCertSubject
• SSHCertSubjectAltNames
• SSHCertThumbprintMD5
• SSHCertThumbprintSHA1
• SSHCertThumbprintSHA256
• SSHCertUsage
• SSHCertUsageFlags
• SSHCertVersion

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)

This property specifies 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

This property specifies 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

ChannelEOL Property (IPWorksSSH_SSHClient Class)

Breaks the incoming data stream into chunks separated by EOL .

Object Oriented Interface

public function getChannelEOL($sshchannelid);
public function setChannelEOL($sshchannelid, $value);

Procedural Interface

ipworksssh_sshclient_get($res, 3 , $sshchannelid);
ipworksssh_sshclient_set($res, 3, $value , $sshchannelid);

Default Value

''

Remarks

Breaks the incoming data stream into chunks separated by EOL.

This property is a binary string. Notably, this means that it can be more than one byte long, and it can contain NULL bytes.

ChannelEOL and MaxChannelLength must be set together or unexpected behavior could occur.

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

String

ChannelId Property (IPWorksSSH_SSHClient Class)

This property provides an Id generated by the class to identify the current Secure Shell (SSH) channel.

Object Oriented Interface

public function getChannelId($sshchannelid);

Procedural Interface

ipworksssh_sshclient_get($res, 4 , $sshchannelid);

Default Value

''

Remarks

This property provides an Id generated by the class to identify the current Secure Shell (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

MaxChannelLength Property (IPWorksSSH_SSHClient Class)

This property specifies the maximum amount of data to accumulate when no EOL is found.

Object Oriented Interface

public function getMaxChannelLength($sshchannelid);
public function setMaxChannelLength($sshchannelid, $value);

Procedural Interface

ipworksssh_sshclient_get($res, 5 , $sshchannelid);
ipworksssh_sshclient_set($res, 5, $value , $sshchannelid);

Default Value

0

Remarks

This property specifies the maximum amount of data to accumulate when no EOL is found.

MaxChannelLength is the size of an internal buffer, which holds received data while waiting for a ChannelEOL string.

If the ChannelEOL string is found in the input stream before MaxChannelLength bytes are received, the SSHChannelData event is fired with the ChannelDataEOLFound parameter set to True, and the buffer is reset.

If no ChannelEOL is found, and MaxChannelLength bytes are accumulated in the buffer, the SSHChannelData event is fired with the ChannelDataEOLFound parameter set to False, and the buffer is reset.

ChannelEOL and MaxChannelLength must be set together or unexpected behavior could occur.

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

ReadyToSend Property (IPWorksSSH_SSHClient Class)

This property is True when data can be sent over the Secure Shell (SSH) channel.

Object Oriented Interface

public function getReadyToSend($sshchannelid);

Procedural Interface

ipworksssh_sshclient_get($res, 6 , $sshchannelid);

Default Value

false

Remarks

This property is True when data can be sent over the Secure Shell (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)

This property holds the current record length set by ChangeRecordLength .

Object Oriented Interface

public function getRecordLength($sshchannelid);

Procedural Interface

ipworksssh_sshclient_get($res, 7 , $sshchannelid);

Default Value

0

Remarks

This property holds the current record length set by ChangeRecordLength. When this value is a positive number, the class will accumulate data until RecordLength is reached and only then will it fire the SSHChannelDataIn event with the data of length RecordLength. This allows data to be received as records of known length. This value can be changed at any time by calling ChangeRecordLength, including within the SSHChannelDataIn event.

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

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

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, 8 , $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)

Whether the class is connected.

Object Oriented Interface

public function getConnected();

Procedural Interface

ipworksssh_sshclient_get($res, 9 );

Default Value

false

Remarks

This property is used to determine whether or not the class is connected to the remote host. Use the Connect and Disconnect methods to manage the connection.

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

Data Type

Boolean

FirewallAutoDetect Property (IPWorksSSH_SSHClient Class)

Whether 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, 10 );
ipworksssh_sshclient_set($res, 10, $value );

Default Value

false

Remarks

Whether to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (IPWorksSSH_SSHClient Class)

The type of firewall to connect through.

Object Oriented Interface

public function getFirewallType();
public function setFirewallType($value);

Procedural Interface

ipworksssh_sshclient_get($res, 11 );
ipworksssh_sshclient_set($res, 11, $value );

Default Value

0

Remarks

The type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (IPWorksSSH_SSHClient Class)

The name or IP address of the firewall (optional).

Object Oriented Interface

public function getFirewallHost();
public function setFirewallHost($value);

Procedural Interface

ipworksssh_sshclient_get($res, 12 );
ipworksssh_sshclient_set($res, 12, $value );

Default Value

''

Remarks

The name or IP address of the 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)

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

Default Value

''

Remarks

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)

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

Default Value

0

Remarks

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)

A username if authentication is to be used when connecting through a firewall.

Object Oriented Interface

public function getFirewallUser();
public function setFirewallUser($value);

Procedural Interface

ipworksssh_sshclient_get($res, 15 );
ipworksssh_sshclient_set($res, 15, $value );

Default Value

''

Remarks

A username if authentication is to be used when connecting through a firewall. If FirewallHost is specified, this property and the FirewallPassword property 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, 16 );
ipworksssh_sshclient_set($res, 16, $value );

Default Value

''

Remarks

This 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 multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

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 multihomed 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, 17 );
ipworksssh_sshclient_set($res, 17, $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 on the client side.

Data Type

Integer

SSHAcceptServerHostKeyEffectiveDate Property (IPWorksSSH_SSHClient Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSHAcceptServerHostKeyEffectiveDate();

Procedural Interface

ipworksssh_sshclient_get($res, 18 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSHAcceptServerHostKeyExpirationDate Property (IPWorksSSH_SSHClient Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSHAcceptServerHostKeyExpirationDate();

Procedural Interface

ipworksssh_sshclient_get($res, 19 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSHAcceptServerHostKeyExtendedKeyUsage Property (IPWorksSSH_SSHClient Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSHAcceptServerHostKeyExtendedKeyUsage();

Procedural Interface

ipworksssh_sshclient_get($res, 20 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSHAcceptServerHostKeyFingerprint Property (IPWorksSSH_SSHClient Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSHAcceptServerHostKeyFingerprint();

Procedural Interface

ipworksssh_sshclient_get($res, 21 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSHAcceptServerHostKeyFingerprintSHA1 Property (IPWorksSSH_SSHClient Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSHAcceptServerHostKeyFingerprintSHA1();

Procedural Interface

ipworksssh_sshclient_get($res, 22 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSHAcceptServerHostKeyFingerprintSHA256 Property (IPWorksSSH_SSHClient Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSHAcceptServerHostKeyFingerprintSHA256();

Procedural Interface

ipworksssh_sshclient_get($res, 23 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSHAcceptServerHostKeyIssuer Property (IPWorksSSH_SSHClient Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSHAcceptServerHostKeyIssuer();

Procedural Interface

ipworksssh_sshclient_get($res, 24 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSHAcceptServerHostKeyPrivateKey Property (IPWorksSSH_SSHClient Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSHAcceptServerHostKeyPrivateKey();

Procedural Interface

ipworksssh_sshclient_get($res, 25 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSHAcceptServerHostKeyPrivateKey may be available but not exportable. In this case, SSHAcceptServerHostKeyPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSHAcceptServerHostKeyPrivateKeyAvailable Property (IPWorksSSH_SSHClient Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSHAcceptServerHostKeyPrivateKeyAvailable();

Procedural Interface

ipworksssh_sshclient_get($res, 26 );

Default Value

false

Remarks

Whether a SSHAcceptServerHostKeyPrivateKey is available for the selected certificate. If SSHAcceptServerHostKeyPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSHAcceptServerHostKeyPrivateKeyContainer Property (IPWorksSSH_SSHClient Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSHAcceptServerHostKeyPrivateKeyContainer();

Procedural Interface

ipworksssh_sshclient_get($res, 27 );

Default Value

''

Remarks

The name of the SSHAcceptServerHostKeyPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSHAcceptServerHostKeyPublicKey Property (IPWorksSSH_SSHClient Class)

The public key of the certificate.

Object Oriented Interface

public function getSSHAcceptServerHostKeyPublicKey();

Procedural Interface

ipworksssh_sshclient_get($res, 28 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSHAcceptServerHostKeyPublicKeyAlgorithm Property (IPWorksSSH_SSHClient Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSHAcceptServerHostKeyPublicKeyAlgorithm();

Procedural Interface

ipworksssh_sshclient_get($res, 29 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSHAcceptServerHostKeyPublicKeyLength Property (IPWorksSSH_SSHClient Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSHAcceptServerHostKeyPublicKeyLength();

Procedural Interface

ipworksssh_sshclient_get($res, 30 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSHAcceptServerHostKeySerialNumber Property (IPWorksSSH_SSHClient Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSHAcceptServerHostKeySerialNumber();

Procedural Interface

ipworksssh_sshclient_get($res, 31 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSHAcceptServerHostKeySignatureAlgorithm Property (IPWorksSSH_SSHClient Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSHAcceptServerHostKeySignatureAlgorithm();

Procedural Interface

ipworksssh_sshclient_get($res, 32 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSHAcceptServerHostKeyStore Property (IPWorksSSH_SSHClient Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSHAcceptServerHostKeyStore();
public function setSSHAcceptServerHostKeyStore($value);

Procedural Interface

ipworksssh_sshclient_get($res, 33 );
ipworksssh_sshclient_set($res, 33, $value );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The SSHAcceptServerHostKeyStoreType property denotes the type of the certificate store specified by SSHAcceptServerHostKeyStore. If the store is password-protected, specify the password in SSHAcceptServerHostKeyStorePassword.

SSHAcceptServerHostKeyStore is used in conjunction with the SSHAcceptServerHostKeySubject property to specify client certificates. If SSHAcceptServerHostKeyStore has a value, and SSHAcceptServerHostKeySubject or SSHAcceptServerHostKeyEncoded is set, a search for a certificate is initiated. Please see the SSHAcceptServerHostKeySubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

SSHAcceptServerHostKeyStorePassword 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 getSSHAcceptServerHostKeyStorePassword();
public function setSSHAcceptServerHostKeyStorePassword($value);

Procedural Interface

ipworksssh_sshclient_get($res, 34 );
ipworksssh_sshclient_set($res, 34, $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

SSHAcceptServerHostKeyStoreType Property (IPWorksSSH_SSHClient Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSHAcceptServerHostKeyStoreType();
public function setSSHAcceptServerHostKeyStoreType($value);

Procedural Interface

ipworksssh_sshclient_get($res, 35 );
ipworksssh_sshclient_set($res, 35, $value );

Default Value

0

Remarks

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:

Data Type

Integer

SSHAcceptServerHostKeySubjectAltNames Property (IPWorksSSH_SSHClient Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSHAcceptServerHostKeySubjectAltNames();

Procedural Interface

ipworksssh_sshclient_get($res, 36 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSHAcceptServerHostKeyThumbprintMD5 Property (IPWorksSSH_SSHClient Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSHAcceptServerHostKeyThumbprintMD5();

Procedural Interface

ipworksssh_sshclient_get($res, 37 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSHAcceptServerHostKeyThumbprintSHA1 Property (IPWorksSSH_SSHClient Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSHAcceptServerHostKeyThumbprintSHA1();

Procedural Interface

ipworksssh_sshclient_get($res, 38 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSHAcceptServerHostKeyThumbprintSHA256 Property (IPWorksSSH_SSHClient Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSHAcceptServerHostKeyThumbprintSHA256();

Procedural Interface

ipworksssh_sshclient_get($res, 39 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSHAcceptServerHostKeyUsage Property (IPWorksSSH_SSHClient Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSHAcceptServerHostKeyUsage();

Procedural Interface

ipworksssh_sshclient_get($res, 40 );

Default Value

''

Remarks

The text description of SSHAcceptServerHostKeyUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSHAcceptServerHostKeyUsageFlags Property (IPWorksSSH_SSHClient Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSHAcceptServerHostKeyUsageFlags();

Procedural Interface

ipworksssh_sshclient_get($res, 41 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSHAcceptServerHostKeyUsageFlags is a combination of the following flags:

Please see the SSHAcceptServerHostKeyUsage property for a text representation of SSHAcceptServerHostKeyUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSHAcceptServerHostKeyVersion Property (IPWorksSSH_SSHClient Class)

The certificate's version number.

Object Oriented Interface

public function getSSHAcceptServerHostKeyVersion();

Procedural Interface

ipworksssh_sshclient_get($res, 42 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSHAcceptServerHostKeySubject Property (IPWorksSSH_SSHClient Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSHAcceptServerHostKeySubject();
public function setSSHAcceptServerHostKeySubject($value);

Procedural Interface

ipworksssh_sshclient_get($res, 43 );
ipworksssh_sshclient_set($res, 43, $value );

Default Value

''

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a 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 as follows:

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

Data Type

String

SSHAcceptServerHostKeyEncoded Property (IPWorksSSH_SSHClient Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSHAcceptServerHostKeyEncoded();
public function setSSHAcceptServerHostKeyEncoded($value);

Procedural Interface

ipworksssh_sshclient_get($res, 44 );
ipworksssh_sshclient_set($res, 44, $value );

Default Value

''

Remarks

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 with 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 Secure Shell (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:

Example 1. User/Password Authentication: Control.SSHAuthMode = SftpSSHAuthModes.amPassword Control.SSHUser = "username" Control.SSHPassword = "password" Control.SSHLogon("server", 22) Example 2. Public Key Authentication: 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

SSHCertEffectiveDate Property (IPWorksSSH_SSHClient Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSHCertEffectiveDate();

Procedural Interface

ipworksssh_sshclient_get($res, 46 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSHCertExpirationDate Property (IPWorksSSH_SSHClient Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSHCertExpirationDate();

Procedural Interface

ipworksssh_sshclient_get($res, 47 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSHCertExtendedKeyUsage Property (IPWorksSSH_SSHClient Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSHCertExtendedKeyUsage();

Procedural Interface

ipworksssh_sshclient_get($res, 48 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSHCertFingerprint Property (IPWorksSSH_SSHClient Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSHCertFingerprint();

Procedural Interface

ipworksssh_sshclient_get($res, 49 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSHCertFingerprintSHA1 Property (IPWorksSSH_SSHClient Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSHCertFingerprintSHA1();

Procedural Interface

ipworksssh_sshclient_get($res, 50 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSHCertFingerprintSHA256 Property (IPWorksSSH_SSHClient Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSHCertFingerprintSHA256();

Procedural Interface

ipworksssh_sshclient_get($res, 51 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSHCertIssuer Property (IPWorksSSH_SSHClient Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSHCertIssuer();

Procedural Interface

ipworksssh_sshclient_get($res, 52 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSHCertPrivateKey Property (IPWorksSSH_SSHClient Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSHCertPrivateKey();

Procedural Interface

ipworksssh_sshclient_get($res, 53 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSHCertPrivateKey may be available but not exportable. In this case, SSHCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSHCertPrivateKeyAvailable Property (IPWorksSSH_SSHClient Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSHCertPrivateKeyAvailable();

Procedural Interface

ipworksssh_sshclient_get($res, 54 );

Default Value

false

Remarks

Whether a SSHCertPrivateKey is available for the selected certificate. If SSHCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSHCertPrivateKeyContainer Property (IPWorksSSH_SSHClient Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSHCertPrivateKeyContainer();

Procedural Interface

ipworksssh_sshclient_get($res, 55 );

Default Value

''

Remarks

The name of the SSHCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSHCertPublicKey Property (IPWorksSSH_SSHClient Class)

The public key of the certificate.

Object Oriented Interface

public function getSSHCertPublicKey();

Procedural Interface

ipworksssh_sshclient_get($res, 56 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSHCertPublicKeyAlgorithm Property (IPWorksSSH_SSHClient Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSHCertPublicKeyAlgorithm();

Procedural Interface

ipworksssh_sshclient_get($res, 57 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSHCertPublicKeyLength Property (IPWorksSSH_SSHClient Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSHCertPublicKeyLength();

Procedural Interface

ipworksssh_sshclient_get($res, 58 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSHCertSerialNumber Property (IPWorksSSH_SSHClient Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSHCertSerialNumber();

Procedural Interface

ipworksssh_sshclient_get($res, 59 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSHCertSignatureAlgorithm Property (IPWorksSSH_SSHClient Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSHCertSignatureAlgorithm();

Procedural Interface

ipworksssh_sshclient_get($res, 60 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSHCertStore Property (IPWorksSSH_SSHClient Class)

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, 61 );
ipworksssh_sshclient_set($res, 61, $value );

Default Value

'MY'

Remarks

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 designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 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, 62 );
ipworksssh_sshclient_set($res, 62, $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)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSHCertStoreType();
public function setSSHCertStoreType($value);

Procedural Interface

ipworksssh_sshclient_get($res, 63 );
ipworksssh_sshclient_set($res, 63, $value );

Default Value

0

Remarks

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:

Data Type

Integer

SSHCertSubjectAltNames Property (IPWorksSSH_SSHClient Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSHCertSubjectAltNames();

Procedural Interface

ipworksssh_sshclient_get($res, 64 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSHCertThumbprintMD5 Property (IPWorksSSH_SSHClient Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSHCertThumbprintMD5();

Procedural Interface

ipworksssh_sshclient_get($res, 65 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSHCertThumbprintSHA1 Property (IPWorksSSH_SSHClient Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSHCertThumbprintSHA1();

Procedural Interface

ipworksssh_sshclient_get($res, 66 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSHCertThumbprintSHA256 Property (IPWorksSSH_SSHClient Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSHCertThumbprintSHA256();

Procedural Interface

ipworksssh_sshclient_get($res, 67 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSHCertUsage Property (IPWorksSSH_SSHClient Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSHCertUsage();

Procedural Interface

ipworksssh_sshclient_get($res, 68 );

Default Value

''

Remarks

The text description of SSHCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSHCertUsageFlags Property (IPWorksSSH_SSHClient Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSHCertUsageFlags();

Procedural Interface

ipworksssh_sshclient_get($res, 69 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSHCertUsageFlags is a combination of the following flags:

Please see the SSHCertUsage property for a text representation of SSHCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSHCertVersion Property (IPWorksSSH_SSHClient Class)

The certificate's version number.

Object Oriented Interface

public function getSSHCertVersion();

Procedural Interface

ipworksssh_sshclient_get($res, 70 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSHCertSubject Property (IPWorksSSH_SSHClient Class)

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, 71 );
ipworksssh_sshclient_set($res, 71, $value );

Default Value

''

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a 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 as follows:

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

Data Type

String

SSHCertEncoded Property (IPWorksSSH_SSHClient Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSHCertEncoded();
public function setSSHCertEncoded($value);

Procedural Interface

ipworksssh_sshclient_get($res, 72 );
ipworksssh_sshclient_set($res, 72, $value );

Default Value

''

Remarks

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

SSHCompressionAlgorithms Property (IPWorksSSH_SSHClient Class)

The comma-separated list containing all allowable compression algorithms.

Object Oriented Interface

public function getSSHCompressionAlgorithms();
public function setSSHCompressionAlgorithms($value);

Procedural Interface

ipworksssh_sshclient_get($res, 73 );
ipworksssh_sshclient_set($res, 73, $value );

Default Value

'none,zlib'

Remarks

During the Secure Shell (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. Therefore, it is important to list multiple algorithms in preferential order. If no algorithm can be agreed on, 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)

The comma-separated list containing all allowable encryption algorithms.

Object Oriented Interface

public function getSSHEncryptionAlgorithms();
public function setSSHEncryptionAlgorithms($value);

Procedural Interface

ipworksssh_sshclient_get($res, 74 );
ipworksssh_sshclient_set($res, 74, $value );

Default Value

'aes256-ctr,aes192-ctr,aes128-ctr,3des-ctr,arcfour256,arcfour128,arcfour,aes256-gcm@openssh.com,aes128-gcm@openssh.com,chacha20-poly1305@openssh.com'

Remarks

During the Secure Shell (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. Therefore, it is important to list multiple algorithms in preferential order. If no algorithm can be agreed on, 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:

Data Type

String

SSHHost Property (IPWorksSSH_SSHClient Class)

The address of the Secure Shell (SSH) host.

Object Oriented Interface

public function getSSHHost();
public function setSSHHost($value);

Procedural Interface

ipworksssh_sshclient_get($res, 75 );
ipworksssh_sshclient_set($res, 75, $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)

The 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, 76 );
ipworksssh_sshclient_set($res, 76, $value );

Default Value

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

Remarks

Secure Shell (SSH) allows different algorithms to be negotiated for use when establishing the security layer of the connection. This property 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 and RFC 8732 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
• gss-group14-sha256-toWM5Slw5Ew8Mqkay+al2g==
• gss-group16-sha512-toWM5Slw5Ew8Mqkay+al2g==
• gss-nistp256-sha256-toWM5Slw5Ew8Mqkay+al2g==
• gss-curve25519-sha256-toWM5Slw5Ew8Mqkay+al2g==
• gss-group14-sha1-toWM5Slw5Ew8Mqkay+al2g==
• gss-gex-sha1-toWM5Slw5Ew8Mqkay+al2g==

Data Type

String

SSHMacAlgorithms Property (IPWorksSSH_SSHClient Class)

The 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, 77 );
ipworksssh_sshclient_set($res, 77, $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,hmac-sha2-256-96-etm@openssh.com,hmac-sha2-512-96-etm@openssh.com,umac-64@openssh.com,umac-64-etm@openssh.com,umac-128@openssh.com,umac-128-etm@openssh.com'

Remarks

Secure Shell (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 message authentication code (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
• hmac-sha2-256-96-etm@openssh.com
• hmac-sha2-512-96-etm@openssh.com
• umac-64@openssh.com
• umac-64-etm@openssh.com
• umac-128@openssh.com
• umac-128-etm@openssh.com

Data Type

String

SSHPassword Property (IPWorksSSH_SSHClient Class)

The password for Secure Shell (SSH) password-based authentication.

Object Oriented Interface

public function getSSHPassword();
public function setSSHPassword($value);

Procedural Interface

ipworksssh_sshclient_get($res, 78 );
ipworksssh_sshclient_set($res, 78, $value );

Default Value

''

Remarks

SSHPassword specifies the password that is used to authenticate the client to the SSH server.

Data Type

String

SSHPort Property (IPWorksSSH_SSHClient Class)

The port on the Secure Shell (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, 79 );
ipworksssh_sshclient_set($res, 79, $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)

The comma-separated list containing all allowable public key algorithms for the Secure Shell (SSH) server's public key.

Object Oriented Interface

public function getSSHPublicKeyAlgorithms();
public function setSSHPublicKeyAlgorithms($value);

Procedural Interface

ipworksssh_sshclient_get($res, 80 );
ipworksssh_sshclient_set($res, 80, $value );

Default Value

'ssh-ed25519,ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521,rsa-sha2-256,rsa-sha2-512,ssh-rsa,ssh-ed448,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:

Note: The algorithms listed by this property control only the allowed public key algorithms for the SSH server's public key. This is used when authenticating the SSH server's public key. In most SSH server implementations, this list has no bearing on the public key algorithms that can be used by the client when authenticating to the SSH server using public key authentication.

Data Type

String

SSHUser Property (IPWorksSSH_SSHClient Class)

The username for Secure Shell (SSH) authentication.

Object Oriented Interface

public function getSSHUser();
public function setSSHUser($value);

Procedural Interface

ipworksssh_sshclient_get($res, 81 );
ipworksssh_sshclient_set($res, 81, $value );

Default Value

''

Remarks

SSHUser specifies the username that is used to authenticate the client to the SSH server. This property is required.

Example 1. User/Password Authentication: Control.SSHAuthMode = SftpSSHAuthModes.amPassword Control.SSHUser = "username" Control.SSHPassword = "password" Control.SSHLogon("server", 22) Example 2. Public Key Authentication: 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)

This property includes the timeout for the class.

Object Oriented Interface

public function getTimeout();
public function setTimeout($value);

Procedural Interface

ipworksssh_sshclient_get($res, 82 );
ipworksssh_sshclient_set($res, 82, $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.

Note: By default, all timeouts are inactivity timeouts, that is, 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 are received, and then it will fire the SSHChannelDataIn event only 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 Secure Shell (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 Secure Shell (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 in which 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 Secure Shell (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)

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 log off and disconnect from the server. Call the Disconnect method in cases in which it is desirable to immediately disconnect without first logging off.

DoEvents Method (IPWorksSSH_SSHClient Class)

This method 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 a Secure Shell (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

Secure Shell (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. Doing so makes it more difficult to break the security of data-intensive or long-lived connections.

GetSSHParam Method (IPWorksSSH_SSHClient Class)

Reads a field from a Secure Shell (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:

The remaining fields that are available in the payload are dependent on 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:

x11-req

X11-req is a request to forward x11 sessions over a channel. The following fields are available:

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:

exec

Exec is a request to execute a command on the channel using the authenticated user's shell. The following field is available:

subsystem

Subsystem is a request to start a subsystem on the specified channel. The following field is available:

xon-xoff

Xon-xoff instructs the server to allow or disallow control-S/control-Q style flow control. The following field is available:

signal

Sends a signal to the remote process/service. The following field is available:

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)

Reads a field from a Secure Shell (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 it 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 Secure Shell (SSH) 2.0 specification allows for multiple channels to be opened over a single Transmission Control Protocol (TCP)/IP connection. The Channels property represents the channels that are currently open. A new SSHChannel can be opened with OpenChannel, and data can be sent over it with SendChannelData.

ChannelType represents the type of Secure Shell (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 Transmission Control Protocol (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 are 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 Secure Shell (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:

Reset Method (IPWorksSSH_SSHClient Class)

This method will 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)

Sends data over a Secure Shell (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)

Sends an encoded Secure Shell (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)

Writes 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 a Secure Shell (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:

Note: Integer values may be hexadecimal encoded by prefixing "0x" to the beginning of the string; otherwise, the value is assumed to be Base10.

SSHLogoff Method (IPWorksSSH_SSHClient Class)

Logs off from the Secure Shell (SSH) server.

Object Oriented Interface

public function doSSHLogoff();

Procedural Interface

ipworksssh_sshclient_do_sshlogoff($res);

Remarks

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

SSHLogon Method (IPWorksSSH_SSHClient Class)

Logs on 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

Logs on to the Secure Shell (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:

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 Transmission Control Protocol (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 the 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

This event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake.

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

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 Transmission Control Protocol (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)

Fired when information is available 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.

The ErrorCode parameter contains an error code, and the Description parameter 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)

Fired 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

Fired once for each log message generated by the class. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the detail level of the message. Possible values are as follows:

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 a Secure Shell (SSH) connection.

Note: Processing long-running requests, including sending channel data, inside this event may cause the underlying transport to stop processing Secure Shell (SSH) data until the event returns. 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'
 'channeldataeolfound'

Remarks

The SSHChannelData event will fire as data are received for the given ChannelId. ChannelData will contain the decrypted contents of the Secure Shell (SSH) packet.

ChannelDataEOLFound indicates whether or not the ChannelEOL string for the channel was found at the end of ChannelData. If the ChannelEOL string was found, then ChannelDataEOLFound is True.

If ChannelData is part of a data portion of a length that is larger than the MaxChannelLength for the Channel with no ChannelEOL strings in it, then ChannelDataEOLFound is False.

Note: This means that one of more SSHChannelData events with ChannelDataEOLFound set to False can be received.

If the ChannelEOL property for the Channel is "" (empty string), then ChannelDataEOLFound can be disregarded (it is always True).

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 a Secure Shell (SSH) connection is reached.

Note: Processing long-running requests, including sending channel data, inside this event may cause the underlying transport to stop processing Secure Shell (SSH) data until the event returns. 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 a Secure Shell (SSH) connection.

Note: Processing long-running requests, including sending channel data, inside this event may cause the underlying transport to stop processing Secure Shell (SSH) data until the event returns. 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 Secure Shell (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 Transmission Control Protocol (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 Secure Shell (SSH) Channel specified by ChannelId.

When a channel is opened, this event will fire after 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. Others, however, 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 depend on 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 Secure Shell (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 Secure Shell (SSH) data until the event returns. 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. Others, however, 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 depend on 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 Secure Shell (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 Secure Shell (SSH) data until the event returns. 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 a 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 Secure Shell (SSH) logon process if SSHAuthMode is set to amCustom. Packet contains the last raw 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 Secure Shell (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 fired when the client can decide whether or not to continue with the connection process. If the public key is known to be a valid key for the Secure Shell (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: 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. The following values are supported:

• 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

CertSubject is the subject of the certificate. This is applicable only when KeyAlgorithm is "x509v3-sign-rsa" or "x509v3-sign-dss".

CertIssuer is the issuer of the certificate. This is applicable only when KeyAlgorithm is "x509v3-sign-rsa" or "x509v3-sign-dss".

Status is reserved for future use.

SSHStatus Event (IPWorksSSH_SSHClient Class)

Fired to track 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.

Config Settings (SSHClient Class)

SSHClient Config Settings

*SSH-1.99-*,*SSH-2.0-*,*SSH-2.99-*

TCPClient Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (SSHClient Class)

SSHClient Errors

The class may also return one of the following error codes, which are inherited from other classes.

TCPClient Errors

TCP/IP Errors