SSHTunnel Class

Properties   Methods   Events   Config Settings   Errors  

The SSHTunnel class can be used to tunnel data through a Secure Shell (SSH) server to a remote location.

Class Name

IPWorksSSH_SSHTunnel

Procedural Interface

 ipworksssh_sshtunnel_open();
 ipworksssh_sshtunnel_close($res);
 ipworksssh_sshtunnel_register_callback($res, $id, $function);
 ipworksssh_sshtunnel_get_last_error($res);
 ipworksssh_sshtunnel_get_last_error_code($res);
 ipworksssh_sshtunnel_set($res, $id, $index, $value);
 ipworksssh_sshtunnel_get($res, $id, $index);
 ipworksssh_sshtunnel_do_config($res, $configurationstring);
 ipworksssh_sshtunnel_do_connect($res);
 ipworksssh_sshtunnel_do_decodepacket($res, $encodedpacket);
 ipworksssh_sshtunnel_do_disconnect($res, $connectionid);
 ipworksssh_sshtunnel_do_doevents($res);
 ipworksssh_sshtunnel_do_encodepacket($res, $packet);
 ipworksssh_sshtunnel_do_getsshparam($res, $payload, $field);
 ipworksssh_sshtunnel_do_getsshparambytes($res, $payload, $field);
 ipworksssh_sshtunnel_do_reset($res);
 ipworksssh_sshtunnel_do_setsshparam($res, $payload, $fieldtype, $fieldvalue);
 ipworksssh_sshtunnel_do_shutdown($res);
 ipworksssh_sshtunnel_do_startlistening($res);
 ipworksssh_sshtunnel_do_stoplistening($res);

Remarks

The SSHTunnel class implements a daemon that accepts connections and tunnels the data from those connections over a Secure Shell (SSH) connection to a remote location.

First, set SSHHost to the server you wish to use to tunnel the data. SSHUser, SSHPassword, and the SSHCert* properties can be used to authenticate the tunneling connection.

Second, set SSHForwardHost to the hostname or IP address of the destination machine, and SSHForwardPort to the port to which you wish to send data. Finally, call StartListening. The class will listen for connections on the interface identified by LocalHost and LocalPort.

When a client attempts to connect to the class, the class will fire a ConnectionRequest event that can be used to accept or reject the connection. If the connection is accepted, the class will attempt to logon to the SSHHost and will tell the server to connect remotely to another machine. Once this process is complete, the tunnel will be established and data can be securely transmitted from end to end.

Example. Connecting Between Networks:

A client that exists in Network A wishes to connect to a resource that exists in Network B. Both networks are secured by a firewall, making it difficult to freely connect to resources within the other network. Network B, however, contains an SSH server that supports tunneling. An SSHTunnel class set up with Network A can be used to access any resource in Network B.

The SSHHost and SSHPort properties must be set to the hostname and port exposed by Network B's firewall. SSHForwardHost and SSHForwardPort are then set to the value of the resource within Network B to which the client in Network A wishes to connect. Any client in Network A can then connect to the SSHTunnel instance's LocalHost and LocalPort.

As clients within Network A connect to the SSHTunnel, the class will forward the connections, secured by SSH, through the network firewalls to the SSH server in Network B. The SSH server will then connect to the resource within Network B and forward all data received from the SSHTunnel instance to that resource. All data received from the resource will then be forwarded to the original client in Network A.

Dynamic Forwarding

Dynamic forwarding is a feature provided by SSH that leverages the SOCKS protocol. With dynamic forwarding, the SSHTunnel component acts as a SOCKS proxy, and all relevant traffic is relayed through the SSH connection to the destination defined by the client that made the request. The SSHTunnel component supports dynamic forwarding automatically when SSHForwardHost and SSHForwardPort are not specified (the forwarding host is determined dynamically).

The client making requests through SSHTunnel must be configured to use a SOCKS proxy, in which case the proxy port is the same as the LocalPort property. In IPWorks components, a SOCKS proxy can be enabled as follows:

// Enable the SOCKS proxy for IPWorks' HTTP component http.Firewall.FirewallType = nsoftware.IPWorks.FirewallTypes.fwSOCKS5; http.Firewall.Port = 1234; //The port set in the SSHTunnel LocalPort property http.Firewall.Host = "localhost"; //The hostname or IP address where SSHTunnel is listening

Note: SSHTunnel can support either dynamic forwarding (SSHForwardHost and SSHForwardPort are not set) or standard forwarding (SSHForwardHost and SSHForwardPort are set). It cannot support both modes at the same time. As a result, it is expected that clients connecting to the SSHTunnel component are configured in a way that matches the configuration of the SSHTunnel component (dynamic or standard forwarding). For example, if SSHTunnel has the SSHForwardHost and SSHForwardPort properties set, then the client must not treat SSHTunnel as a SOCKS proxy. If the SSHTunnel does not have the aforementioned properties set, then the client must treat SSHTunnel as a SOCKS proxy.

Note: Server components are designed to process events as they occur. To ensure that events are processed in a timely manner, DoEvents should be called in a loop after the server is started.

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.

Connected Property (IPWorksSSH_SSHTunnel Class)

Whether the class is connected.

Object Oriented Interface

public function getConnected();

Procedural Interface

ipworksssh_sshtunnel_get($res, 1 );

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

ConnectionBacklog Property (IPWorksSSH_SSHTunnel Class)

This property includes the maximum number of pending connections maintained by the Transmission Control Protocol (TCP)/IP subsystem.

Object Oriented Interface

public function getConnectionBacklog();
public function setConnectionBacklog($value);

Procedural Interface

ipworksssh_sshtunnel_get($res, 2 );
ipworksssh_sshtunnel_set($res, 2, $value );

Default Value

5

Remarks

This property contains the maximum number of pending connections maintained by the TCP/IP subsystem. This value reflects the SOMAXCONN option for the main listening socket. The default value for most systems is 5. You may set this property to a larger value if the server is expected to receive a large number of connections, and queuing them is desirable.

This property is not available at design time.

Data Type

Integer

ClientCount Property (IPWorksSSH_SSHTunnel Class)

The number of records in the Client arrays.

Object Oriented Interface

public function getClientCount();

Procedural Interface

ipworksssh_sshtunnel_get($res, 3 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• ClientAcceptData
• ClientBytesSent
• ClientConnected
• ClientConnectionId
• ClientEOL
• ClientIdleTimeout
• ClientLocalAddress
• ClientReadyToSend
• ClientRecordLength
• ClientRemoteHost
• ClientRemotePort
• ClientSingleLineMode
• ClientTimeout
• ClientUserData

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

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

Data Type

Integer

ClientAcceptData Property (IPWorksSSH_SSHTunnel Class)

This property indicates whether data reception is currently enabled.

Object Oriented Interface

public function getClientAcceptData($clientid);

Procedural Interface

ipworksssh_sshtunnel_get($res, 4 , $clientid);

Default Value

true

Remarks

This property indicates whether data reception is currently enabled. When false, data reception is disabled and the DataIn event will not fire for the connection. Use the PauseData and ProcessData methods to pause and resume data reception.

The $clientid parameter specifies the index of the item in the array. The size of the array is controlled by the ClientCount property.

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

Data Type

Boolean

ClientBytesSent Property (IPWorksSSH_SSHTunnel Class)

This property shows how many bytes were sent after calling Send or SendBytes .

Object Oriented Interface

public function getClientBytesSent($clientid);

Procedural Interface

ipworksssh_sshtunnel_get($res, 5 , $clientid);

Default Value

0

Remarks

This property shows how many bytes were sent after calling Send or SendBytes. Please see Send or SendBytes for more information.

Note: This property will always return 0 when the class is operating in the synchronous mode (i.e., the ClientTimeout property is set to a positive value).

The $clientid parameter specifies the index of the item in the array. The size of the array is controlled by the ClientCount property.

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

Data Type

Integer

ClientConnected Property (IPWorksSSH_SSHTunnel Class)

This property indicates the status of individual connections.

Object Oriented Interface

public function getClientConnected($clientid);

Procedural Interface

ipworksssh_sshtunnel_get($res, 6 , $clientid);

Default Value

false

Remarks

This property indicates the status of individual connections.

When true, the connection is established. Use the Disconnect method to disconnect an existing connection.

The $clientid parameter specifies the index of the item in the array. The size of the array is controlled by the ClientCount property.

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

Data Type

Boolean

ClientConnectionId Property (IPWorksSSH_SSHTunnel Class)

This property contains an identifier generated by the class to identify each connection.

Object Oriented Interface

public function getClientConnectionId($clientid);

Procedural Interface

ipworksssh_sshtunnel_get($res, 7 , $clientid);

Default Value

0

Remarks

This property contains an identifier generated by the class to identify each connection. This identifier is unique to this connection.

The $clientid parameter specifies the index of the item in the array. The size of the array is controlled by the ClientCount property.

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

Data Type

Integer

ClientEOL Property (IPWorksSSH_SSHTunnel Class)

The EOL property is used to define boundaries in the input stream using the value of the property.

Object Oriented Interface

public function getClientEOL($clientid);
public function setClientEOL($clientid, $value);

Procedural Interface

ipworksssh_sshtunnel_get($res, 8 , $clientid);
ipworksssh_sshtunnel_set($res, 8, $value , $clientid);

Default Value

''

Remarks

The ClientEOL property is used to define boundaries in the input stream using the value of the property.

The ClientEOL property is especially useful with ASCII files. By setting it to CRLF ("\r\n") , the incoming ASCII text stream can be split into lines. In this case, one event is fired for each line received (as well as in packet boundaries). The CRLF ("\r\n") . bytes are discarded.

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

When reading the value of the property, if ConnectionId does not belong to a valid connection, then NULL will be returned, and the LastError property will contain a corresponding error message. If no error is encountered, then LastError will contain NULL.

The $clientid parameter specifies the index of the item in the array. The size of the array is controlled by the ClientCount property.

This property is not available at design time.

Data Type

Binary String

ClientIdleTimeout Property (IPWorksSSH_SSHTunnel Class)

This property contains the idle timeout for this connection.

Object Oriented Interface

public function getClientIdleTimeout($clientid);
public function setClientIdleTimeout($clientid, $value);

Procedural Interface

ipworksssh_sshtunnel_get($res, 9 , $clientid);
ipworksssh_sshtunnel_set($res, 9, $value , $clientid);

Default Value

0

Remarks

This property contains the idle timeout for this connection. This property is similar to DefaultIdleTimeout but may be set on a per-connection basis to override DefaultIdleTimeout. This property specifies the idle timeout (in seconds) for the connected client. When set to a positive value, the class will disconnect idle clients after the specified timeout.

This applies only to clients that have not sent to received data within the specified number of seconds.

If set to 0 (default), no idle timeout is applied.

Note: DoEvents must be called for the class to check existing connections.

The $clientid parameter specifies the index of the item in the array. The size of the array is controlled by the ClientCount property.

This property is not available at design time.

Data Type

Integer

ClientLocalAddress Property (IPWorksSSH_SSHTunnel Class)

This property shows the IP address of the interface through which the connection is passing.

Object Oriented Interface

public function getClientLocalAddress($clientid);

Procedural Interface

ipworksssh_sshtunnel_get($res, 10 , $clientid);

Default Value

''

Remarks

This property shows the IP address of the interface through which the connection is passing.

ClientLocalAddress is important for multihomed hosts so that it can be used to find the particular network interface through which an individual connection is going.

The $clientid parameter specifies the index of the item in the array. The size of the array is controlled by the ClientCount property.

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

Data Type

String

ClientReadyToSend Property (IPWorksSSH_SSHTunnel Class)

This property indicates whether the class is ready to send data.

Object Oriented Interface

public function getClientReadyToSend($clientid);

Procedural Interface

ipworksssh_sshtunnel_get($res, 12 , $clientid);

Default Value

false

Remarks

This property indicates whether the class is ready to send data.

This is true after a client connects but will become false after a failed call to Send or SendBytes. After a failed call to Send or SendBytes, the ReadyToSend event will fire and this property will be true when data can be sent again.

The $clientid parameter specifies the index of the item in the array. The size of the array is controlled by the ClientCount property.

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

Data Type

Boolean

ClientRecordLength Property (IPWorksSSH_SSHTunnel Class)

This property holds the current record length set by ChangeRecordLength .

Object Oriented Interface

public function getClientRecordLength($clientid);

Procedural Interface

ipworksssh_sshtunnel_get($res, 13 , $clientid);

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 ClientRecordLength is reached and only then will fire the DataIn event with the data of length ClientRecordLength. 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 DataIn event.

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

The $clientid parameter specifies the index of the item in the array. The size of the array is controlled by the ClientCount property.

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

Data Type

Integer

ClientRemoteHost Property (IPWorksSSH_SSHTunnel Class)

This property shows the IP address of the remote host through which the connection is coming.

Object Oriented Interface

public function getClientRemoteHost($clientid);

Procedural Interface

ipworksssh_sshtunnel_get($res, 14 , $clientid);

Default Value

''

Remarks

This property shows the IP address of the remote host through which the connection is coming.

The connection must be valid or an error will be fired.

If the class is configured to use a SOCKS firewall, the value assigned to this property may be preceded with an "*". If this is the case, the host name is passed to the firewall unresolved and the firewall performs the DNS resolution.

The $clientid parameter specifies the index of the item in the array. The size of the array is controlled by the ClientCount property.

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

Data Type

String

ClientRemotePort Property (IPWorksSSH_SSHTunnel Class)

This property shows the Transmission Control Protocol (TCP) port on the remote host through which the connection is coming.

Object Oriented Interface

public function getClientRemotePort($clientid);

Procedural Interface

ipworksssh_sshtunnel_get($res, 15 , $clientid);

Default Value

0

Remarks

This property shows the Transmission Control Protocol (TCP) port on the remote host through which the connection is coming.

The connection must be valid or an error will be fired.

The $clientid parameter specifies the index of the item in the array. The size of the array is controlled by the ClientCount property.

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

Data Type

Integer

ClientSingleLineMode Property (IPWorksSSH_SSHTunnel Class)

This property shows the special mode for line-oriented protocols.

Object Oriented Interface

public function getClientSingleLineMode($clientid);
public function setClientSingleLineMode($clientid, $value);

Procedural Interface

ipworksssh_sshtunnel_get($res, 16 , $clientid);
ipworksssh_sshtunnel_set($res, 16, $value , $clientid);

Default Value

false

Remarks

This property shows the special mode for line-oriented protocols. When SingleLineMode is True, the class treats the incoming data stream as lines separated by carriage return (CR), line feed (LF), or CRLF. The EOL property is ignored.

The $clientid parameter specifies the index of the item in the array. The size of the array is controlled by the ClientCount property.

This property is not available at design time.

Data Type

Boolean

ClientTimeout Property (IPWorksSSH_SSHTunnel Class)

This property specifies a timeout for the class.

Object Oriented Interface

public function getClientTimeout($clientid);
public function setClientTimeout($clientid, $value);

Procedural Interface

ipworksssh_sshtunnel_get($res, 17 , $clientid);
ipworksssh_sshtunnel_set($res, 17, $value , $clientid);

Default Value

0

Remarks

This property specifies a timeout for the class.

If the ClientTimeout property is set to 0, all operations return immediately, potentially failing with a WOULDBLOCK error if data cannot be sent immediately.

If ClientTimeout 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 ClientTimeout 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 ClientTimeout property is 0 (asynchronous operation).

The $clientid parameter specifies the index of the item in the array. The size of the array is controlled by the ClientCount property.

This property is not available at design time.

Data Type

Integer

ClientUserData Property (IPWorksSSH_SSHTunnel Class)

The UserData property holds connection-specific user-specified data.

Object Oriented Interface

public function getClientUserData($clientid);
public function setClientUserData($clientid, $value);

Procedural Interface

ipworksssh_sshtunnel_get($res, 18 , $clientid);
ipworksssh_sshtunnel_set($res, 18, $value , $clientid);

Default Value

''

Remarks

The ClientUserData property holds connection-specific user-specified data.

User-specified data may be set or retrieved at any point while the connection is valid. This provides a simple way to associate arbitrary data with a specific connection.

The $clientid parameter specifies the index of the item in the array. The size of the array is controlled by the ClientCount property.

This property is not available at design time.

Data Type

Binary String

DefaultEOL Property (IPWorksSSH_SSHTunnel Class)

This property includes a default end-of-line (EOL) value to be used by incoming connections.

Object Oriented Interface

public function getDefaultEOL();
public function setDefaultEOL($value);

Procedural Interface

ipworksssh_sshtunnel_get($res, 19 );
ipworksssh_sshtunnel_set($res, 19, $value );

Default Value

''

Remarks

This property contains a default end-of-line (EOL) value to be used by incoming connections. Once the class accepts and establishes an inbound connection, it will set that connection's EOL to the value in this property. By default, this value is empty (""), meaning that data will be fired as it is received.

Data Type

Binary String

DefaultSingleLineMode Property (IPWorksSSH_SSHTunnel Class)

This property tells the class whether or not to treat new connections as line oriented.

Object Oriented Interface

public function getDefaultSingleLineMode();
public function setDefaultSingleLineMode($value);

Procedural Interface

ipworksssh_sshtunnel_get($res, 20 );
ipworksssh_sshtunnel_set($res, 20, $value );

Default Value

false

Remarks

This property instructs the component whether or not to treat newly established connections as line-oriented protocols. If this value is True, newly accepted connections will read the incoming data stream as lines separated by a carriage return line feed (CRLF), carriage return (CR), or line feed (LF) and will ignore the end of lines (EOLs).

Data Type

Boolean

DefaultTimeout Property (IPWorksSSH_SSHTunnel Class)

This property includes an initial timeout value to be used by incoming connections.

Object Oriented Interface

public function getDefaultTimeout();
public function setDefaultTimeout($value);

Procedural Interface

ipworksssh_sshtunnel_get($res, 21 );
ipworksssh_sshtunnel_set($res, 21, $value );

Default Value

0

Remarks

This property is used by the class to set the operational timeout value of all inbound connections once they are established.

By default, the timeout is 0, meaning that all inbound connections will behave asynchronously.

Data Type

Integer

FirewallAutoDetect Property (IPWorksSSH_SSHTunnel 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_sshtunnel_get($res, 22 );
ipworksssh_sshtunnel_set($res, 22, $value );

Default Value

false

Remarks

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

Data Type

Boolean

FirewallType Property (IPWorksSSH_SSHTunnel Class)

The type of firewall to connect through.

Object Oriented Interface

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

Procedural Interface

ipworksssh_sshtunnel_get($res, 23 );
ipworksssh_sshtunnel_set($res, 23, $value );

Default Value

0

Remarks

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

Data Type

Integer

FirewallHost Property (IPWorksSSH_SSHTunnel Class)

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

Object Oriented Interface

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

Procedural Interface

ipworksssh_sshtunnel_get($res, 24 );
ipworksssh_sshtunnel_set($res, 24, $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_SSHTunnel 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_sshtunnel_get($res, 25 );
ipworksssh_sshtunnel_set($res, 25, $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_SSHTunnel Class)

The Transmission Control Protocol (TCP) port for the firewall Host .

Object Oriented Interface

public function getFirewallPort();
public function setFirewallPort($value);

Procedural Interface

ipworksssh_sshtunnel_get($res, 26 );
ipworksssh_sshtunnel_set($res, 26, $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_SSHTunnel 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_sshtunnel_get($res, 27 );
ipworksssh_sshtunnel_set($res, 27, $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

KeepAlive Property (IPWorksSSH_SSHTunnel Class)

When True, KEEPALIVE packets are enabled (for long connections).

Object Oriented Interface

public function getKeepAlive();
public function setKeepAlive($value);

Procedural Interface

ipworksssh_sshtunnel_get($res, 28 );
ipworksssh_sshtunnel_set($res, 28, $value );

Default Value

false

Remarks

This property enables the SO_KEEPALIVE option on the incoming connections. This option prevents long connections from timing out in case of inactivity.

Note: System Transmission Control Protocol (TCP)/IP stack implementations are not required to support SO_KEEPALIVE.

This property is shared among incoming connections. When the property is set, the corresponding value is set for incoming connections as they are accepted. Existing connections are not modified.

Data Type

Boolean

Linger Property (IPWorksSSH_SSHTunnel Class)

When set to True, connections are terminated gracefully.

Object Oriented Interface

public function getLinger();
public function setLinger($value);

Procedural Interface

ipworksssh_sshtunnel_get($res, 29 );
ipworksssh_sshtunnel_set($res, 29, $value );

Default Value

true

Remarks

This property controls how a connection is closed. The default is True. In this case, the connection is closed only after all the data are sent. Setting it to False forces an abrupt (hard) disconnection. Any data that were in the sending queue may be lost.

The default behavior (which is also the default mode for stream sockets) might result in an indefinite delay in closing the connection. Although the class returns control immediately, the system might indefinitely hold system resources until all pending data are sent (even after your application closes). This means that valuable system resources might be wasted.

Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you have sent (e.g., by a client acknowledgment), then setting this property to False might be the appropriate course of action.

This property is shared among incoming connections. When the property is set, the corresponding value is set for incoming connections as they are accepted. Existing connections are not modified.

Data Type

Boolean

Listening Property (IPWorksSSH_SSHTunnel Class)

This property indicates whether the class is listening for incoming connections on LocalPort.

Object Oriented Interface

public function getListening();

Procedural Interface

ipworksssh_sshtunnel_get($res, 30 );

Default Value

false

Remarks

This property indicates whether the class is listening for connections on the port specified by the LocalPort property. Use the StartListening and StopListening methods to control whether the class is listening.

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

Data Type

Boolean

LocalHost Property (IPWorksSSH_SSHTunnel 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_sshtunnel_get($res, 31 );
ipworksssh_sshtunnel_set($res, 31, $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_SSHTunnel 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_sshtunnel_get($res, 32 );
ipworksssh_sshtunnel_set($res, 32, $value );

Default Value

0

Remarks

This property must be set before the class can start listening. If its value is 0, then the TCP/IP subsystem picks a port number at random. The port number can be found by checking the value of this property after the class is listening (i.e., after successfully assigning True to the Listening property).

The service port is not shared among servers so two classs cannot be listening on the same port at the same time.

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

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSHAcceptServerHostKeyEffectiveDate();

Procedural Interface

ipworksssh_sshtunnel_get($res, 33 );

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

The date on which the certificate expires.

Object Oriented Interface

public function getSSHAcceptServerHostKeyExpirationDate();

Procedural Interface

ipworksssh_sshtunnel_get($res, 34 );

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

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSHAcceptServerHostKeyExtendedKeyUsage();

Procedural Interface

ipworksssh_sshtunnel_get($res, 35 );

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

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

Object Oriented Interface

public function getSSHAcceptServerHostKeyFingerprint();

Procedural Interface

ipworksssh_sshtunnel_get($res, 36 );

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

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

Object Oriented Interface

public function getSSHAcceptServerHostKeyFingerprintSHA1();

Procedural Interface

ipworksssh_sshtunnel_get($res, 37 );

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

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

Object Oriented Interface

public function getSSHAcceptServerHostKeyFingerprintSHA256();

Procedural Interface

ipworksssh_sshtunnel_get($res, 38 );

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

The issuer of the certificate.

Object Oriented Interface

public function getSSHAcceptServerHostKeyIssuer();

Procedural Interface

ipworksssh_sshtunnel_get($res, 39 );

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

The private key of the certificate (if available).

Object Oriented Interface

public function getSSHAcceptServerHostKeyPrivateKey();

Procedural Interface

ipworksssh_sshtunnel_get($res, 40 );

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

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSHAcceptServerHostKeyPrivateKeyAvailable();

Procedural Interface

ipworksssh_sshtunnel_get($res, 41 );

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

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

Object Oriented Interface

public function getSSHAcceptServerHostKeyPrivateKeyContainer();

Procedural Interface

ipworksssh_sshtunnel_get($res, 42 );

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

The public key of the certificate.

Object Oriented Interface

public function getSSHAcceptServerHostKeyPublicKey();

Procedural Interface

ipworksssh_sshtunnel_get($res, 43 );

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

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

Object Oriented Interface

public function getSSHAcceptServerHostKeyPublicKeyAlgorithm();

Procedural Interface

ipworksssh_sshtunnel_get($res, 44 );

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

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

Object Oriented Interface

public function getSSHAcceptServerHostKeyPublicKeyLength();

Procedural Interface

ipworksssh_sshtunnel_get($res, 45 );

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

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSHAcceptServerHostKeySerialNumber();

Procedural Interface

ipworksssh_sshtunnel_get($res, 46 );

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

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSHAcceptServerHostKeySignatureAlgorithm();

Procedural Interface

ipworksssh_sshtunnel_get($res, 47 );

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

The name of the certificate store for the client certificate.

Object Oriented Interface

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

Procedural Interface

ipworksssh_sshtunnel_get($res, 48 );
ipworksssh_sshtunnel_set($res, 48, $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_SSHTunnel 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_sshtunnel_get($res, 49 );
ipworksssh_sshtunnel_set($res, 49, $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_SSHTunnel Class)

The type of certificate store for this certificate.

Object Oriented Interface

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

Procedural Interface

ipworksssh_sshtunnel_get($res, 50 );
ipworksssh_sshtunnel_set($res, 50, $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_SSHTunnel Class)

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

Object Oriented Interface

public function getSSHAcceptServerHostKeySubjectAltNames();

Procedural Interface

ipworksssh_sshtunnel_get($res, 51 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSHAcceptServerHostKeyThumbprintMD5 Property (IPWorksSSH_SSHTunnel Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSHAcceptServerHostKeyThumbprintMD5();

Procedural Interface

ipworksssh_sshtunnel_get($res, 52 );

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

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSHAcceptServerHostKeyThumbprintSHA1();

Procedural Interface

ipworksssh_sshtunnel_get($res, 53 );

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

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSHAcceptServerHostKeyThumbprintSHA256();

Procedural Interface

ipworksssh_sshtunnel_get($res, 54 );

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

The text description of UsageFlags .

Object Oriented Interface

public function getSSHAcceptServerHostKeyUsage();

Procedural Interface

ipworksssh_sshtunnel_get($res, 55 );

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

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSHAcceptServerHostKeyUsageFlags();

Procedural Interface

ipworksssh_sshtunnel_get($res, 56 );

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

The certificate's version number.

Object Oriented Interface

public function getSSHAcceptServerHostKeyVersion();

Procedural Interface

ipworksssh_sshtunnel_get($res, 57 );

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

The subject of the certificate used for client authentication.

Object Oriented Interface

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

Procedural Interface

ipworksssh_sshtunnel_get($res, 58 );
ipworksssh_sshtunnel_set($res, 58, $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_SSHTunnel Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

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

Procedural Interface

ipworksssh_sshtunnel_get($res, 59 );
ipworksssh_sshtunnel_set($res, 59, $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_SSHTunnel 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_sshtunnel_get($res, 60 );
ipworksssh_sshtunnel_set($res, 60, $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_SSHTunnel Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSHCertEffectiveDate();

Procedural Interface

ipworksssh_sshtunnel_get($res, 61 );

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

The date on which the certificate expires.

Object Oriented Interface

public function getSSHCertExpirationDate();

Procedural Interface

ipworksssh_sshtunnel_get($res, 62 );

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

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSHCertExtendedKeyUsage();

Procedural Interface

ipworksssh_sshtunnel_get($res, 63 );

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

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

Object Oriented Interface

public function getSSHCertFingerprint();

Procedural Interface

ipworksssh_sshtunnel_get($res, 64 );

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

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

Object Oriented Interface

public function getSSHCertFingerprintSHA1();

Procedural Interface

ipworksssh_sshtunnel_get($res, 65 );

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

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

Object Oriented Interface

public function getSSHCertFingerprintSHA256();

Procedural Interface

ipworksssh_sshtunnel_get($res, 66 );

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

The issuer of the certificate.

Object Oriented Interface

public function getSSHCertIssuer();

Procedural Interface

ipworksssh_sshtunnel_get($res, 67 );

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

The private key of the certificate (if available).

Object Oriented Interface

public function getSSHCertPrivateKey();

Procedural Interface

ipworksssh_sshtunnel_get($res, 68 );

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

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSHCertPrivateKeyAvailable();

Procedural Interface

ipworksssh_sshtunnel_get($res, 69 );

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

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

Object Oriented Interface

public function getSSHCertPrivateKeyContainer();

Procedural Interface

ipworksssh_sshtunnel_get($res, 70 );

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

The public key of the certificate.

Object Oriented Interface

public function getSSHCertPublicKey();

Procedural Interface

ipworksssh_sshtunnel_get($res, 71 );

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

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

Object Oriented Interface

public function getSSHCertPublicKeyAlgorithm();

Procedural Interface

ipworksssh_sshtunnel_get($res, 72 );

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

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

Object Oriented Interface

public function getSSHCertPublicKeyLength();

Procedural Interface

ipworksssh_sshtunnel_get($res, 73 );

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

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSHCertSerialNumber();

Procedural Interface

ipworksssh_sshtunnel_get($res, 74 );

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

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSHCertSignatureAlgorithm();

Procedural Interface

ipworksssh_sshtunnel_get($res, 75 );

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

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSHCertStore();
public function setSSHCertStore($value);

Procedural Interface

ipworksssh_sshtunnel_get($res, 76 );
ipworksssh_sshtunnel_set($res, 76, $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_SSHTunnel 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_sshtunnel_get($res, 77 );
ipworksssh_sshtunnel_set($res, 77, $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_SSHTunnel Class)

The type of certificate store for this certificate.

Object Oriented Interface

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

Procedural Interface

ipworksssh_sshtunnel_get($res, 78 );
ipworksssh_sshtunnel_set($res, 78, $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_SSHTunnel Class)

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

Object Oriented Interface

public function getSSHCertSubjectAltNames();

Procedural Interface

ipworksssh_sshtunnel_get($res, 79 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSHCertThumbprintMD5 Property (IPWorksSSH_SSHTunnel Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSHCertThumbprintMD5();

Procedural Interface

ipworksssh_sshtunnel_get($res, 80 );

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

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSHCertThumbprintSHA1();

Procedural Interface

ipworksssh_sshtunnel_get($res, 81 );

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

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSHCertThumbprintSHA256();

Procedural Interface

ipworksssh_sshtunnel_get($res, 82 );

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

The text description of UsageFlags .

Object Oriented Interface

public function getSSHCertUsage();

Procedural Interface

ipworksssh_sshtunnel_get($res, 83 );

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

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSHCertUsageFlags();

Procedural Interface

ipworksssh_sshtunnel_get($res, 84 );

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

The certificate's version number.

Object Oriented Interface

public function getSSHCertVersion();

Procedural Interface

ipworksssh_sshtunnel_get($res, 85 );

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

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSHCertSubject();
public function setSSHCertSubject($value);

Procedural Interface

ipworksssh_sshtunnel_get($res, 86 );
ipworksssh_sshtunnel_set($res, 86, $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_SSHTunnel Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

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

Procedural Interface

ipworksssh_sshtunnel_get($res, 87 );
ipworksssh_sshtunnel_set($res, 87, $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_SSHTunnel Class)

The comma-separated list containing all allowable compression algorithms.

Object Oriented Interface

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

Procedural Interface

ipworksssh_sshtunnel_get($res, 88 );
ipworksssh_sshtunnel_set($res, 88, $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_SSHTunnel Class)

The comma-separated list containing all allowable encryption algorithms.

Object Oriented Interface

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

Procedural Interface

ipworksssh_sshtunnel_get($res, 89 );
ipworksssh_sshtunnel_set($res, 89, $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

SSHForwardHost Property (IPWorksSSH_SSHTunnel Class)

The address of the remote host. Domain names are resolved to IP addresses.

Object Oriented Interface

public function getSSHForwardHost();
public function setSSHForwardHost($value);

Procedural Interface

ipworksssh_sshtunnel_get($res, 90 );
ipworksssh_sshtunnel_set($res, 90, $value );

Default Value

''

Remarks

The SSHForwardHost 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 SSHForwardHost property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the SSHForwardHost property is set to the corresponding address. If the search is not successful, an error is returned.

If the class is configured to use a SOCKS firewall, the value assigned to this property may be preceded with an "*". If this is the case, the host name is passed to the firewall unresolved and the firewall performs the DNS resolution.

Data Type

String

SSHForwardPort Property (IPWorksSSH_SSHTunnel Class)

The Transmission Control Protocol (TCP) port in the remote host.

Object Oriented Interface

public function getSSHForwardPort();
public function setSSHForwardPort($value);

Procedural Interface

ipworksssh_sshtunnel_get($res, 91 );
ipworksssh_sshtunnel_set($res, 91, $value );

Default Value

0

Remarks

The SSHForwardPort property specifies a service port on the remote 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

SSHHost Property (IPWorksSSH_SSHTunnel Class)

The address of the Secure Shell (SSH) host.

Object Oriented Interface

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

Procedural Interface

ipworksssh_sshtunnel_get($res, 92 );
ipworksssh_sshtunnel_set($res, 92, $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

SSHPassword Property (IPWorksSSH_SSHTunnel Class)

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

Object Oriented Interface

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

Procedural Interface

ipworksssh_sshtunnel_get($res, 93 );
ipworksssh_sshtunnel_set($res, 93, $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_SSHTunnel 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_sshtunnel_get($res, 94 );
ipworksssh_sshtunnel_set($res, 94, $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

SSHUser Property (IPWorksSSH_SSHTunnel Class)

The username for Secure Shell (SSH) authentication.

Object Oriented Interface

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

Procedural Interface

ipworksssh_sshtunnel_get($res, 95 );
ipworksssh_sshtunnel_set($res, 95, $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

Config Method (IPWorksSSH_SSHTunnel Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

ipworksssh_sshtunnel_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_SSHTunnel Class)

Connects to the Secure Shell (SSH) host without logging in.

Object Oriented Interface

public function doConnect();

Procedural Interface

ipworksssh_sshtunnel_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 StartListening method that 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, when confirming a host is available by first creating the connection.

DecodePacket Method (IPWorksSSH_SSHTunnel Class)

Decodes a hex-encoded Secure Shell (SSH) packet.

Object Oriented Interface

public function doDecodePacket($encodedpacket);

Procedural Interface

ipworksssh_sshtunnel_do_decodepacket($res, $encodedpacket);

Remarks

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

Note: This method is applicable only for reading and creating Secure Shell (SSH) packets for use within the SSHCustomAuth event.

Disconnect Method (IPWorksSSH_SSHTunnel Class)

This method disconnects the specified client.

Object Oriented Interface

public function doDisconnect($connectionid);

Procedural Interface

ipworksssh_sshtunnel_do_disconnect($res, $connectionid);

Remarks

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

In most cases, the StopListening 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.

Calling this method will disconnect the client specified by the ConnectionId parameter.

DoEvents Method (IPWorksSSH_SSHTunnel Class)

This method processes events from the internal message queue.

Object Oriented Interface

public function doEvents();

Procedural Interface

ipworksssh_sshtunnel_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_SSHTunnel Class)

Hex encodes a Secure Shell (SSH) packet.

Object Oriented Interface

public function doEncodePacket($packet);

Procedural Interface

ipworksssh_sshtunnel_do_encodepacket($res, $packet);

Remarks

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

Note: This method is applicable only for reading and creating Secure Shell (SSH) packets for use within the SSHCustomAuth event.

GetSSHParam Method (IPWorksSSH_SSHTunnel Class)

Reads a field from a Secure Shell (SSH) packet's payload.

Object Oriented Interface

public function doGetSSHParam($payload, $field);

Procedural Interface

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

Note: This method is applicable only for reading and creating Secure Shell (SSH) packets for use within the SSHCustomAuth event.

GetSSHParamBytes Method (IPWorksSSH_SSHTunnel Class)

Reads a field from a Secure Shell (SSH) packet's payload.

Object Oriented Interface

public function doGetSSHParamBytes($payload, $field);

Procedural Interface

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

Remarks

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

Note: This method is applicable only for reading and creating Secure Shell (SSH) packets for use within the SSHCustomAuth event.

Reset Method (IPWorksSSH_SSHTunnel Class)

This method will reset the class.

Object Oriented Interface

public function doReset();

Procedural Interface

ipworksssh_sshtunnel_do_reset($res);

Remarks

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

SetSSHParam Method (IPWorksSSH_SSHTunnel Class)

Writes a field to the end of a payload.

Object Oriented Interface

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

Procedural Interface

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

Note: This method is applicable only for reading and creating Secure Shell (SSH) packets for use within the SSHCustomAuth event.

Shutdown Method (IPWorksSSH_SSHTunnel Class)

This method shuts down the server.

Object Oriented Interface

public function doShutdown();

Procedural Interface

ipworksssh_sshtunnel_do_shutdown($res);

Remarks

This method shuts down the server. Calling this method is equivalent to calling StopListening and then breaking every client connection by calling Disconnect.

StartListening Method (IPWorksSSH_SSHTunnel Class)

This method starts listening for incoming connections.

Object Oriented Interface

public function doStartListening();

Procedural Interface

ipworksssh_sshtunnel_do_startlistening($res);

Remarks

This method begins listening for incoming connections on the port specified by LocalPort. Once listening, events will fire as new clients connect and data are transferred.

To stop listening for new connections, call StopListening. To stop listening for new connections and to disconnect all existing clients, call Shutdown.

StopListening Method (IPWorksSSH_SSHTunnel Class)

This method stops listening for new connections.

Object Oriented Interface

public function doStopListening();

Procedural Interface

ipworksssh_sshtunnel_do_stoplistening($res);

Remarks

This method stops listening for new connections. After being called, any new connection attempts will be rejected. Calling this method does not disconnect existing connections.

To stop listening and to disconnect all existing clients, call Shutdown instead.

Connected Event (IPWorksSSH_SSHTunnel Class)

This event is fired immediately after a connection completes (or fails).

Object Oriented Interface

public function fireConnected($param);

Procedural Interface

ipworksssh_sshtunnel_register_callback($res, 1, array($this, 'fireConnected'));

Parameter List

 'connectionid'
 '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 system. Description contains a description of this code. The value of StatusCode is equal to the value of the system error.

Please refer to the Error Codes section for more information.

ConnectionRequest Event (IPWorksSSH_SSHTunnel Class)

This event is fired when a request for connection comes from a remote host.

Object Oriented Interface

public function fireConnectionRequest($param);

Procedural Interface

ipworksssh_sshtunnel_register_callback($res, 2, array($this, 'fireConnectionRequest'));

Parameter List

 'address'
 'port'
 'accept'

Remarks

This event indicates an incoming connection. The connection is accepted by default. Address and Port will contain information about the remote host requesting the inbound connection. If you want to refuse it, you can set the Accept parameter to False.

DataIn Event (IPWorksSSH_SSHTunnel Class)

This event is fired when data come in.

Object Oriented Interface

public function fireDataIn($param);

Procedural Interface

ipworksssh_sshtunnel_register_callback($res, 3, array($this, 'fireDataIn'));

Parameter List

 'connectionid'
 'text'
 'eol'

Remarks

Trapping the DataIn event is your only chance to get the data coming from the other end of the connection specified by ConnectionId. The incoming data are provided through the Text parameter.

EOL indicates whether or not the EOL string was found at the end of Text. If the EOL string was found, then EOL is True.

If Text is part of the data portion of length larger than either DefaultMaxLineLength or with no EOL strings in it, then EOL is False. Please note that this means that one or more DataIn events with EOL set to False can be received during a connection.

If the EOL property is "" (empty string), then EOL can be disregarded (it is always True).

Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

Disconnected Event (IPWorksSSH_SSHTunnel Class)

Fired when a connection is closed.

Object Oriented Interface

public function fireDisconnected($param);

Procedural Interface

ipworksssh_sshtunnel_register_callback($res, 4, array($this, 'fireDisconnected'));

Parameter List

 'connectionid'
 '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 system. Description contains a description of this code. The value of StatusCode is equal to the value of the system error.

Please refer to the Error Codes section for more information.

Note: When the class is disconnected from the Secure Shell (SSH) server for any reason the ConnectionId parameter will be -1.

Error Event (IPWorksSSH_SSHTunnel Class)

Fired when errors occur during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

ipworksssh_sshtunnel_register_callback($res, 5, array($this, 'fireError'));

Parameter List

 'connectionid'
 'errorcode'
 'description'

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

ConnectionId contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Log Event (IPWorksSSH_SSHTunnel Class)

Fired once for each log message.

Object Oriented Interface

public function fireLog($param);

Procedural Interface

ipworksssh_sshtunnel_register_callback($res, 6, 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.

ReconnectAttempt Event (IPWorksSSH_SSHTunnel Class)

Fired when attempting to reconnect.

Object Oriented Interface

public function fireReconnectAttempt($param);

Procedural Interface

ipworksssh_sshtunnel_register_callback($res, 7, array($this, 'fireReconnectAttempt'));

Parameter List

 'host'
 'port'
 'retrycount'
 'retriesremaining'
 'maxretrycount'
 'retryinterval'
 'retrytype'
 'remotelisteningport'
 'cancel'

Remarks

This event fires both when attempting to reconnect to the SSHHost and when reestablishing a Secure Shell (SSH) tunnel.

This is applicable only when AutoReconnect is enabled. To determine which type of connection is being established check the RetryType parameter.

The following table provides details about the parameters:

SSHCustomAuth Event (IPWorksSSH_SSHTunnel Class)

Fired when the class is doing a custom authentication.

Object Oriented Interface

public function fireSSHCustomAuth($param);

Procedural Interface

ipworksssh_sshtunnel_register_callback($res, 8, 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_SSHTunnel Class)

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

Object Oriented Interface

public function fireSSHKeyboardInteractive($param);

Procedural Interface

ipworksssh_sshtunnel_register_callback($res, 9, 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_SSHTunnel Class)

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

Object Oriented Interface

public function fireSSHServerAuthentication($param);

Procedural Interface

ipworksssh_sshtunnel_register_callback($res, 10, 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_SSHTunnel Class)

Fired to track the progress of the secure connection.

Object Oriented Interface

public function fireSSHStatus($param);

Procedural Interface

ipworksssh_sshtunnel_register_callback($res, 11, 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 (SSHTunnel Class)

SSHTunnel Config Settings

SSHClient Config Settings

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

TCPClient Config Settings

Socket Config Settings

TCPServer Config Settings

Base Config Settings

Trappable Errors (SSHTunnel Class)

SSHTunnel Errors

SSHClient Errors

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

TCPClient Errors

TCP/IP Errors