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.

Syntax

SSHTunnel

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.

ConnectedWhether the class is connected.
ConnectionBacklogThis property includes the maximum number of pending connections maintained by the Transmission Control Protocol (TCP)/IP subsystem.
ConnectionsThis property includes a collection of currently connected clients.
DefaultEOLThis property includes a default end-of-line (EOL) value to be used by incoming connections.
DefaultSingleLineModeThis property tells the class whether or not to treat new connections as line oriented.
DefaultTimeoutThis property includes an initial timeout value to be used by incoming connections.
FirewallA set of properties related to firewall access.
KeepAliveWhen True, KEEPALIVE packets are enabled (for long connections).
LingerWhen set to True, connections are terminated gracefully.
ListeningThis property indicates whether the class is listening for incoming connections on LocalPort.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
LocalPortThe TCP port in the local host where the class binds.
SSHAcceptServerHostKeyInstructs the class to accept the server host key that matches the supplied key.
SSHAuthModeThe authentication method to be used with the class when calling SSHLogon .
SSHCertA certificate to be used for authenticating the SSHUser .
SSHCompressionAlgorithmsThe comma-separated list containing all allowable compression algorithms.
SSHEncryptionAlgorithmsThe comma-separated list containing all allowable encryption algorithms.
SSHForwardHostThe address of the remote host. Domain names are resolved to IP addresses.
SSHForwardPortThe Transmission Control Protocol (TCP) port in the remote host.
SSHHostThe address of the Secure Shell (SSH) host.
SSHPasswordThe password for Secure Shell (SSH) password-based authentication.
SSHPortThe port on the Secure Shell (SSH) server where the SSH service is running; by default, 22.
SSHUserThe username for Secure Shell (SSH) authentication.

Method List


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

ConfigSets or retrieves a configuration setting.
ConnectConnects to the Secure Shell (SSH) host without logging in.
DecodePacketDecodes a hex-encoded Secure Shell (SSH) packet.
DisconnectThis method disconnects the specified client.
DoEventsThis method processes events from the internal message queue.
EncodePacketHex encodes a Secure Shell (SSH) packet.
GetSSHParamReads a field from a Secure Shell (SSH) packet's payload.
GetSSHParamBytesReads a field from a Secure Shell (SSH) packet's payload.
ResetThis method will reset the class.
SetSSHParamWrites a field to the end of a payload.
ShutdownThis method shuts down the server.
StartListeningThis method starts listening for incoming connections.
StopListeningThis method stops listening for new connections.

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.

ConnectedThis event is fired immediately after a connection completes (or fails).
ConnectionRequestThis event is fired when a request for connection comes from a remote host.
DataInThis event is fired when data come in.
DisconnectedFired when a connection is closed.
ErrorFired when errors occur during data delivery.
LogFired once for each log message.
ReconnectAttemptFired when attempting to reconnect.
SSHCustomAuthFired when the class is doing a custom authentication.
SSHKeyboardInteractiveFired when the class receives a request for user input from the server.
SSHServerAuthenticationFired after the server presents its public key to the client.
SSHStatusFired to track the progress of the secure connection.

Config Settings


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

AutoReconnectWhether to automatically reconnect.
MaxRetryCountThe maximum number of retries when reconnecting.
RetryIntervalThe interval in seconds between reconnect attempts.
ShutdownChannelOnEOFWhether the client will shutdown the channel after receiving an EOF packet from the remote host.
SSHForwardSocketPathThe path to the Unix domain socket where the traffic will be forwarded.
ChannelDataEOL[ChannelId]Used to break the incoming data stream into chunks.
ChannelDataEOLFound[ChannelId]Determines if ChannelDataEOL was found.
ClientSSHVersionStringThe SSH version string used by the class.
DoNotRepeatAuthMethodsWhether the class will repeat authentication methods during multifactor authentication.
EnablePageantAuthWhether to use a key stored in Pageant to perform client authentication.
KerberosDelegationIf true, asks for credentials with delegation enabled during authentication.
KerberosRealmThe fully qualified domain name of the Kerberos Realm to use for GSSAPI authentication.
KerberosSPNThe Kerberos Service Principal Name of the SSH host.
KeyRenegotiationThresholdSets the threshold for the SSH Key Renegotiation.
LogLevelSpecifies the level of detail that is logged.
MaxChannelDataLength[ChannelId]The maximum amount of data to accumulate when no ChannelDataEOL is found.
MaxPacketSizeThe maximum packet size of the channel, in bytes.
MaxWindowSizeThe maximum window size allowed for the channel, in bytes.
NegotiatedStrictKexReturns whether strict key exchange was negotiated to be used.
PasswordPromptThe text of the password prompt used in keyboard-interactive authentication.
PreferredDHGroupBitsThe size (in bits) of the preferred modulus (p) to request from the server.
RecordLengthThe length of received data records.
ServerSSHVersionStringThe remote host's SSH version string.
SignedSSHCertThe CA signed client public key used when authenticating.
SSHAcceptAnyServerHostKeyIf set the class will accept any key presented by the server.
SSHAcceptServerCAKeyThe CA public key that signed the server's host key.
SSHAcceptServerHostKeyFingerPrintThe fingerprint of the server key to accept.
SSHFingerprintHashAlgorithmThe algorithm used to calculate the fingerprint.
SSHFingerprintMD5The server hostkey's MD5 fingerprint.
SSHFingerprintSHA1The server hostkey's SHA1 fingerprint.
SSHFingerprintSHA256The server hostkey's SHA256 fingerprint.
SSHKeepAliveCountMaxThe maximum number of keep alive packets to send without a response.
SSHKeepAliveIntervalThe interval between keep alive packets.
SSHKeyExchangeAlgorithmsSpecifies the supported key exchange algorithms.
SSHKeyRenegotiateCauses the class to renegotiate the SSH keys.
SSHMacAlgorithmsSpecifies the supported Mac algorithms.
SSHPubKeyAuthSigAlgorithmsSpecifies the enabled signature algorithms that may be used when attempting public key authentication.
SSHPublicKeyAlgorithmsSpecifies the supported public key algorithms for the server's public key.
SSHVersionPatternThe pattern used to match the remote host's version string.
TryAllAvailableAuthMethodsIf set to true, the class will try all available authentication methods.
UseStrictKeyExchangeSpecifies how strict key exchange is supported.
WaitForChannelCloseWhether to wait for channels to be closed before disconnected.
WaitForServerDisconnectWhether to wait for the server to close the connection.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveRetryCountThe number of keep-alive packets to be sent before the remotehost is considered disconnected.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the class binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
TcpNoDelayWhether or not to delay when sending packets.
UseIPv6Whether to use IPv6.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
AllowedClientsA comma-separated list of host names or IP addresses that can access the class.
BindExclusivelyWhether or not the class considers a local port reserved for exclusive use.
BlockedClientsA comma-separated list of host names or IP addresses that cannot access the class.
ConnectionUIDThe unique connectionId for a connection.
DefaultConnectionTimeoutThe inactivity timeout applied to the SSL handshake.
InBufferSizeThe size in bytes of the incoming queue of the socket.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveRetryCountThe number of keep-alive packets to be sent before the remotehost is considered disconnected.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
MaxConnectionsThe maximum number of connections available.
MaxReadTimeThe maximum time spent reading data from each connection.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
TcpNoDelayWhether or not to delay when sending packets.
UseIOCPWhether to use the completion port I/O model.
UseIPv6Whether to use IPv6.
UseWindowsMessagesWhether to use the WSAAsyncSelect I/O model.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
MaskSensitiveDataWhether sensitive data is masked in log messages.
ProcessIdleEventsWhether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillisThe length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseFIPSCompliantAPITells the class whether or not to use FIPS certified APIs.
UseInternalSecurityAPIWhether or not to use the system security libraries or an internal implementation.

Connected Property (SSHTunnel Class)

Whether the class is connected.

Syntax

ANSI (Cross Platform)
int GetConnected();

Unicode (Windows)
BOOL GetConnected();
int ipworksssh_sshtunnel_getconnected(void* lpObj);
bool GetConnected();

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 (SSHTunnel Class)

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

Syntax

ANSI (Cross Platform)
int GetConnectionBacklog();
int SetConnectionBacklog(int iConnectionBacklog); Unicode (Windows) INT GetConnectionBacklog();
INT SetConnectionBacklog(INT iConnectionBacklog);
int ipworksssh_sshtunnel_getconnectionbacklog(void* lpObj);
int ipworksssh_sshtunnel_setconnectionbacklog(void* lpObj, int iConnectionBacklog);
int GetConnectionBacklog();
int SetConnectionBacklog(int iConnectionBacklog);

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

Connections Property (SSHTunnel Class)

This property includes a collection of currently connected clients.

Syntax

IPWorksSSHList<IPWorksSSHConnection>* GetConnections();

int ipworksssh_sshtunnel_getclientcount(void* lpObj);
int ipworksssh_sshtunnel_getclientacceptdata(void* lpObj, int clientid);
int ipworksssh_sshtunnel_getclientbytessent(void* lpObj, int clientid);
int ipworksssh_sshtunnel_getclientconnected(void* lpObj, int clientid);
int ipworksssh_sshtunnel_getclientconnectionid(void* lpObj, int clientid);
int ipworksssh_sshtunnel_getclienteol(void* lpObj, int clientid, char** lpClientEOL, int* lenClientEOL);
int ipworksssh_sshtunnel_setclienteol(void* lpObj, int clientid, const char* lpClientEOL, int lenClientEOL);
int ipworksssh_sshtunnel_getclientidletimeout(void* lpObj, int clientid);
int ipworksssh_sshtunnel_setclientidletimeout(void* lpObj, int clientid, int iClientIdleTimeout);
char* ipworksssh_sshtunnel_getclientlocaladdress(void* lpObj, int clientid);
int ipworksssh_sshtunnel_getclientreadytosend(void* lpObj, int clientid);
int ipworksssh_sshtunnel_getclientrecordlength(void* lpObj, int clientid);
char* ipworksssh_sshtunnel_getclientremotehost(void* lpObj, int clientid);
int ipworksssh_sshtunnel_getclientremoteport(void* lpObj, int clientid);
int ipworksssh_sshtunnel_getclientsinglelinemode(void* lpObj, int clientid);
int ipworksssh_sshtunnel_setclientsinglelinemode(void* lpObj, int clientid, int bClientSingleLineMode);
int ipworksssh_sshtunnel_getclienttimeout(void* lpObj, int clientid);
int ipworksssh_sshtunnel_setclienttimeout(void* lpObj, int clientid, int iClientTimeout);
int ipworksssh_sshtunnel_getclientuserdata(void* lpObj, int clientid, char** lpClientUserData, int* lenClientUserData);
int ipworksssh_sshtunnel_setclientuserdata(void* lpObj, int clientid, const char* lpClientUserData, int lenClientUserData);
int GetClientCount();

bool GetClientAcceptData(int iClientId);

int GetClientBytesSent(int iClientId);

bool GetClientConnected(int iClientId);

int GetClientConnectionId(int iClientId);

QByteArray GetClientEOL(int iClientId);
int SetClientEOL(int iClientId, QByteArray qbaClientEOL); int GetClientIdleTimeout(int iClientId);
int SetClientIdleTimeout(int iClientId, int iClientIdleTimeout); QString GetClientLocalAddress(int iClientId); bool GetClientReadyToSend(int iClientId); int GetClientRecordLength(int iClientId); QString GetClientRemoteHost(int iClientId); int GetClientRemotePort(int iClientId); bool GetClientSingleLineMode(int iClientId);
int SetClientSingleLineMode(int iClientId, bool bClientSingleLineMode); int GetClientTimeout(int iClientId);
int SetClientTimeout(int iClientId, int iClientTimeout); QByteArray GetClientUserData(int iClientId);
int SetClientUserData(int iClientId, QByteArray qbaClientUserData);

Remarks

This property contains a collection of currently connected clients. All of the connections may be managed using this property. Each connection is described by the different fields of the Connection type.

This collection is a hash-table type of collection, in which the Connection Id string is used as the key to the desired connection. You may acquire the key for a given connection through the Connected event.

Example (Broadcasting Data) For i = 0 to Control.ConnectionCount Control.DataToSend(Control.ConnectionId(i)) = "Broadcast Data" Next i

This property is read-only.

Data Type

IPWorksSSHConnection

DefaultEOL Property (SSHTunnel Class)

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

Syntax

ANSI (Cross Platform)
int GetDefaultEOL(char* &lpDefaultEOL, int &lenDefaultEOL);
int SetDefaultEOL(const char* lpDefaultEOL, int lenDefaultEOL); Unicode (Windows) INT GetDefaultEOL(LPSTR &lpDefaultEOL, INT &lenDefaultEOL);
INT SetDefaultEOL(LPCSTR lpDefaultEOL, INT lenDefaultEOL);
int ipworksssh_sshtunnel_getdefaulteol(void* lpObj, char** lpDefaultEOL, int* lenDefaultEOL);
int ipworksssh_sshtunnel_setdefaulteol(void* lpObj, const char* lpDefaultEOL, int lenDefaultEOL);
QByteArray GetDefaultEOL();
int SetDefaultEOL(QByteArray qbaDefaultEOL);

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 (SSHTunnel Class)

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

Syntax

ANSI (Cross Platform)
int GetDefaultSingleLineMode();
int SetDefaultSingleLineMode(int bDefaultSingleLineMode); Unicode (Windows) BOOL GetDefaultSingleLineMode();
INT SetDefaultSingleLineMode(BOOL bDefaultSingleLineMode);
int ipworksssh_sshtunnel_getdefaultsinglelinemode(void* lpObj);
int ipworksssh_sshtunnel_setdefaultsinglelinemode(void* lpObj, int bDefaultSingleLineMode);
bool GetDefaultSingleLineMode();
int SetDefaultSingleLineMode(bool bDefaultSingleLineMode);

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 (SSHTunnel Class)

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

Syntax

ANSI (Cross Platform)
int GetDefaultTimeout();
int SetDefaultTimeout(int iDefaultTimeout); Unicode (Windows) INT GetDefaultTimeout();
INT SetDefaultTimeout(INT iDefaultTimeout);
int ipworksssh_sshtunnel_getdefaulttimeout(void* lpObj);
int ipworksssh_sshtunnel_setdefaulttimeout(void* lpObj, int iDefaultTimeout);
int GetDefaultTimeout();
int SetDefaultTimeout(int iDefaultTimeout);

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

Firewall Property (SSHTunnel Class)

A set of properties related to firewall access.

Syntax

IPWorksSSHFirewall* GetFirewall();
int SetFirewall(IPWorksSSHFirewall* val);
int ipworksssh_sshtunnel_getfirewallautodetect(void* lpObj);
int ipworksssh_sshtunnel_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);
int ipworksssh_sshtunnel_getfirewalltype(void* lpObj);
int ipworksssh_sshtunnel_setfirewalltype(void* lpObj, int iFirewallType);
char* ipworksssh_sshtunnel_getfirewallhost(void* lpObj);
int ipworksssh_sshtunnel_setfirewallhost(void* lpObj, const char* lpszFirewallHost);
char* ipworksssh_sshtunnel_getfirewallpassword(void* lpObj);
int ipworksssh_sshtunnel_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);
int ipworksssh_sshtunnel_getfirewallport(void* lpObj);
int ipworksssh_sshtunnel_setfirewallport(void* lpObj, int iFirewallPort);
char* ipworksssh_sshtunnel_getfirewalluser(void* lpObj);
int ipworksssh_sshtunnel_setfirewalluser(void* lpObj, const char* lpszFirewallUser);
bool GetFirewallAutoDetect();
int SetFirewallAutoDetect(bool bFirewallAutoDetect); int GetFirewallType();
int SetFirewallType(int iFirewallType); QString GetFirewallHost();
int SetFirewallHost(QString qsFirewallHost); QString GetFirewallPassword();
int SetFirewallPassword(QString qsFirewallPassword); int GetFirewallPort();
int SetFirewallPort(int iFirewallPort); QString GetFirewallUser();
int SetFirewallUser(QString qsFirewallUser);

Remarks

This is a Firewall-type property, which contains fields describing the firewall through which the class will attempt to connect.

Data Type

IPWorksSSHFirewall

KeepAlive Property (SSHTunnel Class)

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

Syntax

ANSI (Cross Platform)
int GetKeepAlive();
int SetKeepAlive(int bKeepAlive); Unicode (Windows) BOOL GetKeepAlive();
INT SetKeepAlive(BOOL bKeepAlive);
int ipworksssh_sshtunnel_getkeepalive(void* lpObj);
int ipworksssh_sshtunnel_setkeepalive(void* lpObj, int bKeepAlive);
bool GetKeepAlive();
int SetKeepAlive(bool bKeepAlive);

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 (SSHTunnel Class)

When set to True, connections are terminated gracefully.

Syntax

ANSI (Cross Platform)
int GetLinger();
int SetLinger(int bLinger); Unicode (Windows) BOOL GetLinger();
INT SetLinger(BOOL bLinger);
int ipworksssh_sshtunnel_getlinger(void* lpObj);
int ipworksssh_sshtunnel_setlinger(void* lpObj, int bLinger);
bool GetLinger();
int SetLinger(bool bLinger);

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 (SSHTunnel Class)

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

Syntax

ANSI (Cross Platform)
int GetListening();

Unicode (Windows)
BOOL GetListening();
int ipworksssh_sshtunnel_getlistening(void* lpObj);
bool GetListening();

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 (SSHTunnel Class)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

ANSI (Cross Platform)
char* GetLocalHost();
int SetLocalHost(const char* lpszLocalHost); Unicode (Windows) LPWSTR GetLocalHost();
INT SetLocalHost(LPCWSTR lpszLocalHost);
char* ipworksssh_sshtunnel_getlocalhost(void* lpObj);
int ipworksssh_sshtunnel_setlocalhost(void* lpObj, const char* lpszLocalHost);
QString GetLocalHost();
int SetLocalHost(QString qsLocalHost);

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 (SSHTunnel Class)

The TCP port in the local host where the class binds.

Syntax

ANSI (Cross Platform)
int GetLocalPort();
int SetLocalPort(int iLocalPort); Unicode (Windows) INT GetLocalPort();
INT SetLocalPort(INT iLocalPort);
int ipworksssh_sshtunnel_getlocalport(void* lpObj);
int ipworksssh_sshtunnel_setlocalport(void* lpObj, int iLocalPort);
int GetLocalPort();
int SetLocalPort(int iLocalPort);

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

SSHAcceptServerHostKey Property (SSHTunnel Class)

Instructs the class to accept the server host key that matches the supplied key.

Syntax

IPWorksSSHCertificate* GetSSHAcceptServerHostKey();
int SetSSHAcceptServerHostKey(IPWorksSSHCertificate* val);
char* ipworksssh_sshtunnel_getsshacceptserverhostkeyeffectivedate(void* lpObj);
char* ipworksssh_sshtunnel_getsshacceptserverhostkeyexpirationdate(void* lpObj);
char* ipworksssh_sshtunnel_getsshacceptserverhostkeyextendedkeyusage(void* lpObj);
char* ipworksssh_sshtunnel_getsshacceptserverhostkeyfingerprint(void* lpObj);
char* ipworksssh_sshtunnel_getsshacceptserverhostkeyfingerprintsha1(void* lpObj);
char* ipworksssh_sshtunnel_getsshacceptserverhostkeyfingerprintsha256(void* lpObj);
char* ipworksssh_sshtunnel_getsshacceptserverhostkeyissuer(void* lpObj);
char* ipworksssh_sshtunnel_getsshacceptserverhostkeyprivatekey(void* lpObj);
int ipworksssh_sshtunnel_getsshacceptserverhostkeyprivatekeyavailable(void* lpObj);
char* ipworksssh_sshtunnel_getsshacceptserverhostkeyprivatekeycontainer(void* lpObj);
char* ipworksssh_sshtunnel_getsshacceptserverhostkeypublickey(void* lpObj);
char* ipworksssh_sshtunnel_getsshacceptserverhostkeypublickeyalgorithm(void* lpObj);
int ipworksssh_sshtunnel_getsshacceptserverhostkeypublickeylength(void* lpObj);
char* ipworksssh_sshtunnel_getsshacceptserverhostkeyserialnumber(void* lpObj);
char* ipworksssh_sshtunnel_getsshacceptserverhostkeysignaturealgorithm(void* lpObj);
int ipworksssh_sshtunnel_getsshacceptserverhostkeystore(void* lpObj, char** lpSSHAcceptServerHostKeyStore, int* lenSSHAcceptServerHostKeyStore);
int ipworksssh_sshtunnel_setsshacceptserverhostkeystore(void* lpObj, const char* lpSSHAcceptServerHostKeyStore, int lenSSHAcceptServerHostKeyStore);
char* ipworksssh_sshtunnel_getsshacceptserverhostkeystorepassword(void* lpObj);
int ipworksssh_sshtunnel_setsshacceptserverhostkeystorepassword(void* lpObj, const char* lpszSSHAcceptServerHostKeyStorePassword);
int ipworksssh_sshtunnel_getsshacceptserverhostkeystoretype(void* lpObj);
int ipworksssh_sshtunnel_setsshacceptserverhostkeystoretype(void* lpObj, int iSSHAcceptServerHostKeyStoreType);
char* ipworksssh_sshtunnel_getsshacceptserverhostkeysubjectaltnames(void* lpObj);
char* ipworksssh_sshtunnel_getsshacceptserverhostkeythumbprintmd5(void* lpObj);
char* ipworksssh_sshtunnel_getsshacceptserverhostkeythumbprintsha1(void* lpObj);
char* ipworksssh_sshtunnel_getsshacceptserverhostkeythumbprintsha256(void* lpObj);
char* ipworksssh_sshtunnel_getsshacceptserverhostkeyusage(void* lpObj);
int ipworksssh_sshtunnel_getsshacceptserverhostkeyusageflags(void* lpObj);
char* ipworksssh_sshtunnel_getsshacceptserverhostkeyversion(void* lpObj);
char* ipworksssh_sshtunnel_getsshacceptserverhostkeysubject(void* lpObj);
int ipworksssh_sshtunnel_setsshacceptserverhostkeysubject(void* lpObj, const char* lpszSSHAcceptServerHostKeySubject);
int ipworksssh_sshtunnel_getsshacceptserverhostkeyencoded(void* lpObj, char** lpSSHAcceptServerHostKeyEncoded, int* lenSSHAcceptServerHostKeyEncoded);
int ipworksssh_sshtunnel_setsshacceptserverhostkeyencoded(void* lpObj, const char* lpSSHAcceptServerHostKeyEncoded, int lenSSHAcceptServerHostKeyEncoded);
QString GetSSHAcceptServerHostKeyEffectiveDate();

QString GetSSHAcceptServerHostKeyExpirationDate();

QString GetSSHAcceptServerHostKeyExtendedKeyUsage();

QString GetSSHAcceptServerHostKeyFingerprint();

QString GetSSHAcceptServerHostKeyFingerprintSHA1();

QString GetSSHAcceptServerHostKeyFingerprintSHA256();

QString GetSSHAcceptServerHostKeyIssuer();

QString GetSSHAcceptServerHostKeyPrivateKey();

bool GetSSHAcceptServerHostKeyPrivateKeyAvailable();

QString GetSSHAcceptServerHostKeyPrivateKeyContainer();

QString GetSSHAcceptServerHostKeyPublicKey();

QString GetSSHAcceptServerHostKeyPublicKeyAlgorithm();

int GetSSHAcceptServerHostKeyPublicKeyLength();

QString GetSSHAcceptServerHostKeySerialNumber();

QString GetSSHAcceptServerHostKeySignatureAlgorithm();

QByteArray GetSSHAcceptServerHostKeyStore();
int SetSSHAcceptServerHostKeyStore(QByteArray qbaSSHAcceptServerHostKeyStore); QString GetSSHAcceptServerHostKeyStorePassword();
int SetSSHAcceptServerHostKeyStorePassword(QString qsSSHAcceptServerHostKeyStorePassword); int GetSSHAcceptServerHostKeyStoreType();
int SetSSHAcceptServerHostKeyStoreType(int iSSHAcceptServerHostKeyStoreType); QString GetSSHAcceptServerHostKeySubjectAltNames(); QString GetSSHAcceptServerHostKeyThumbprintMD5(); QString GetSSHAcceptServerHostKeyThumbprintSHA1(); QString GetSSHAcceptServerHostKeyThumbprintSHA256(); QString GetSSHAcceptServerHostKeyUsage(); int GetSSHAcceptServerHostKeyUsageFlags(); QString GetSSHAcceptServerHostKeyVersion(); QString GetSSHAcceptServerHostKeySubject();
int SetSSHAcceptServerHostKeySubject(QString qsSSHAcceptServerHostKeySubject); QByteArray GetSSHAcceptServerHostKeyEncoded();
int SetSSHAcceptServerHostKeyEncoded(QByteArray qbaSSHAcceptServerHostKeyEncoded);

Remarks

If the host key that will be used by the server is known in advance, this property may be set to accept the expected key. Otherwise, the SSHServerAuthentication event should be trapped, and the key should be accepted or refused in the event.

If this property is not set and the SSHServerAuthentication event is not trapped, the server will not be authenticated and the connection will be terminated by the client.

Data Type

IPWorksSSHCertificate

SSHAuthMode Property (SSHTunnel Class)

The authentication method to be used with the class when calling SSHLogon .

Syntax

ANSI (Cross Platform)
int GetSSHAuthMode();
int SetSSHAuthMode(int iSSHAuthMode); Unicode (Windows) INT GetSSHAuthMode();
INT SetSSHAuthMode(INT iSSHAuthMode);

Possible Values

AM_NONE(0), 
AM_MULTI_FACTOR(1),
AM_PASSWORD(2),
AM_PUBLIC_KEY(3),
AM_KEYBOARD_INTERACTIVE(4),
AM_GSSAPIWITH_MIC(5),
AM_GSSAPIKEYEX(6),
AM_CUSTOM(99)
int ipworksssh_sshtunnel_getsshauthmode(void* lpObj);
int ipworksssh_sshtunnel_setsshauthmode(void* lpObj, int iSSHAuthMode);
int GetSSHAuthMode();
int SetSSHAuthMode(int iSSHAuthMode);

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:

amNone (0)No authentication will be performed. The current SSHUser value is ignored, and the connection will be logged as anonymous.
amMultiFactor (1)This allows the class to attempt a multistep authentication process. The class will send authentication data to the server based on the list of methods allowed for the current user and the authentication property values supplied. The class will continue to send authentication data until the server acknowledges authentication success. If the server rejects an authentication step, the class fails with an error.
amPassword (2)The class will use the values of SSHUser and SSHPassword to authenticate the user.
amPublicKey (3)The class will use the values of SSHUser and the SSHCert* properties to authenticate the user. the SSHCert* properties must have a private key available for this authentication method to succeed.
amKeyboardInteractive (4)At the time of authentication, the class will fire the SSHKeyboardInteractive event containing instructions on how to complete the authentication step.

Note: amKeyboardInteractive is not supported in SSHTunnel.

amGSSAPIWithMic (5)This allows the class to attempt Kerberos authentication using the GSSAPI-WITH-MIC scheme. The client will try Kerberos authentication using the value of SSHUser (single sign-on), or if SSHPassword is specified as well, it will try Kerberos authentication with alternate credentials. This is currently supported only on Windows, unless using the Java edition, which also provides support for Linux and macOS.
amGSSAPIKeyex (6)This allows the class to attempt Kerberos authentication using the GSSAPIKeyex scheme. The client will try Kerberos authentication using the value of SSHUser (single sign-on), or if SSHPassword is specified as well, it will try Kerberos authentication with alternate credentials. This is currently supported only on Windows, unless using the Java edition, which also provides support for Linux and macOS.
amCustom (99)This allows the class caller to take over the authentication process completely. When amCustom is set, the class will fire the SSHCustomAuth event as necessary to complete the authentication process.

Example 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

SSHCert Property (SSHTunnel Class)

A certificate to be used for authenticating the SSHUser .

Syntax

IPWorksSSHCertificate* GetSSHCert();
int SetSSHCert(IPWorksSSHCertificate* val);
char* ipworksssh_sshtunnel_getsshcerteffectivedate(void* lpObj);
char* ipworksssh_sshtunnel_getsshcertexpirationdate(void* lpObj);
char* ipworksssh_sshtunnel_getsshcertextendedkeyusage(void* lpObj);
char* ipworksssh_sshtunnel_getsshcertfingerprint(void* lpObj);
char* ipworksssh_sshtunnel_getsshcertfingerprintsha1(void* lpObj);
char* ipworksssh_sshtunnel_getsshcertfingerprintsha256(void* lpObj);
char* ipworksssh_sshtunnel_getsshcertissuer(void* lpObj);
char* ipworksssh_sshtunnel_getsshcertprivatekey(void* lpObj);
int ipworksssh_sshtunnel_getsshcertprivatekeyavailable(void* lpObj);
char* ipworksssh_sshtunnel_getsshcertprivatekeycontainer(void* lpObj);
char* ipworksssh_sshtunnel_getsshcertpublickey(void* lpObj);
char* ipworksssh_sshtunnel_getsshcertpublickeyalgorithm(void* lpObj);
int ipworksssh_sshtunnel_getsshcertpublickeylength(void* lpObj);
char* ipworksssh_sshtunnel_getsshcertserialnumber(void* lpObj);
char* ipworksssh_sshtunnel_getsshcertsignaturealgorithm(void* lpObj);
int ipworksssh_sshtunnel_getsshcertstore(void* lpObj, char** lpSSHCertStore, int* lenSSHCertStore);
int ipworksssh_sshtunnel_setsshcertstore(void* lpObj, const char* lpSSHCertStore, int lenSSHCertStore);
char* ipworksssh_sshtunnel_getsshcertstorepassword(void* lpObj);
int ipworksssh_sshtunnel_setsshcertstorepassword(void* lpObj, const char* lpszSSHCertStorePassword);
int ipworksssh_sshtunnel_getsshcertstoretype(void* lpObj);
int ipworksssh_sshtunnel_setsshcertstoretype(void* lpObj, int iSSHCertStoreType);
char* ipworksssh_sshtunnel_getsshcertsubjectaltnames(void* lpObj);
char* ipworksssh_sshtunnel_getsshcertthumbprintmd5(void* lpObj);
char* ipworksssh_sshtunnel_getsshcertthumbprintsha1(void* lpObj);
char* ipworksssh_sshtunnel_getsshcertthumbprintsha256(void* lpObj);
char* ipworksssh_sshtunnel_getsshcertusage(void* lpObj);
int ipworksssh_sshtunnel_getsshcertusageflags(void* lpObj);
char* ipworksssh_sshtunnel_getsshcertversion(void* lpObj);
char* ipworksssh_sshtunnel_getsshcertsubject(void* lpObj);
int ipworksssh_sshtunnel_setsshcertsubject(void* lpObj, const char* lpszSSHCertSubject);
int ipworksssh_sshtunnel_getsshcertencoded(void* lpObj, char** lpSSHCertEncoded, int* lenSSHCertEncoded);
int ipworksssh_sshtunnel_setsshcertencoded(void* lpObj, const char* lpSSHCertEncoded, int lenSSHCertEncoded);
QString GetSSHCertEffectiveDate();

QString GetSSHCertExpirationDate();

QString GetSSHCertExtendedKeyUsage();

QString GetSSHCertFingerprint();

QString GetSSHCertFingerprintSHA1();

QString GetSSHCertFingerprintSHA256();

QString GetSSHCertIssuer();

QString GetSSHCertPrivateKey();

bool GetSSHCertPrivateKeyAvailable();

QString GetSSHCertPrivateKeyContainer();

QString GetSSHCertPublicKey();

QString GetSSHCertPublicKeyAlgorithm();

int GetSSHCertPublicKeyLength();

QString GetSSHCertSerialNumber();

QString GetSSHCertSignatureAlgorithm();

QByteArray GetSSHCertStore();
int SetSSHCertStore(QByteArray qbaSSHCertStore); QString GetSSHCertStorePassword();
int SetSSHCertStorePassword(QString qsSSHCertStorePassword); int GetSSHCertStoreType();
int SetSSHCertStoreType(int iSSHCertStoreType); QString GetSSHCertSubjectAltNames(); QString GetSSHCertThumbprintMD5(); QString GetSSHCertThumbprintSHA1(); QString GetSSHCertThumbprintSHA256(); QString GetSSHCertUsage(); int GetSSHCertUsageFlags(); QString GetSSHCertVersion(); QString GetSSHCertSubject();
int SetSSHCertSubject(QString qsSSHCertSubject); QByteArray GetSSHCertEncoded();
int SetSSHCertEncoded(QByteArray qbaSSHCertEncoded);

Remarks

To use public key authentication, SSHCert must contain a Certificate with a valid private key. The certificate's public key value is sent to the server along with a signature produced using the private key. The server will first check to see if the public key values match what is known for the user, and then it will attempt to use those values to verify the signature.

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

IPWorksSSHCertificate

SSHCompressionAlgorithms Property (SSHTunnel Class)

The comma-separated list containing all allowable compression algorithms.

Syntax

ANSI (Cross Platform)
char* GetSSHCompressionAlgorithms();
int SetSSHCompressionAlgorithms(const char* lpszSSHCompressionAlgorithms); Unicode (Windows) LPWSTR GetSSHCompressionAlgorithms();
INT SetSSHCompressionAlgorithms(LPCWSTR lpszSSHCompressionAlgorithms);
char* ipworksssh_sshtunnel_getsshcompressionalgorithms(void* lpObj);
int ipworksssh_sshtunnel_setsshcompressionalgorithms(void* lpObj, const char* lpszSSHCompressionAlgorithms);
QString GetSSHCompressionAlgorithms();
int SetSSHCompressionAlgorithms(QString qsSSHCompressionAlgorithms);

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 (SSHTunnel Class)

The comma-separated list containing all allowable encryption algorithms.

Syntax

ANSI (Cross Platform)
char* GetSSHEncryptionAlgorithms();
int SetSSHEncryptionAlgorithms(const char* lpszSSHEncryptionAlgorithms); Unicode (Windows) LPWSTR GetSSHEncryptionAlgorithms();
INT SetSSHEncryptionAlgorithms(LPCWSTR lpszSSHEncryptionAlgorithms);
char* ipworksssh_sshtunnel_getsshencryptionalgorithms(void* lpObj);
int ipworksssh_sshtunnel_setsshencryptionalgorithms(void* lpObj, const char* lpszSSHEncryptionAlgorithms);
QString GetSSHEncryptionAlgorithms();
int SetSSHEncryptionAlgorithms(QString qsSSHEncryptionAlgorithms);

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:

aes256-ctr256-bit AES encryption in CTR mode.
aes256-cbc256-bit AES encryption in CBC mode.
aes192-ctr192-bit AES encryption in CTR mode.
aes192-cbc192-bit AES encryption in CBC mode.
aes128-ctr128-bit AES encryption in CTR mode.
aes128-cbc128-bit AES encryption in CBC mode.
3des-ctr192-bit (3-key) triple DES encryption in CTR mode.
3des-cbc192-bit (3-key) triple DES encryption in CBC mode.
cast128-cbcCAST-128 encryption.
blowfish-cbcBlowfish encryption.
arcfourARC4 encryption.
arcfour128128-bit ARC4 encryption.
arcfour256256-bit ARC4 encryption.
aes256-gcm@openssh.com256-bit AES encryption in GCM mode.
aes128-gcm@openssh.com128-bit AES encryption in GCM mode.
chacha20-poly1305@openssh.comChaCha20 with Poly1305-AES encryption.

Data Type

String

SSHForwardHost Property (SSHTunnel Class)

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

Syntax

ANSI (Cross Platform)
char* GetSSHForwardHost();
int SetSSHForwardHost(const char* lpszSSHForwardHost); Unicode (Windows) LPWSTR GetSSHForwardHost();
INT SetSSHForwardHost(LPCWSTR lpszSSHForwardHost);
char* ipworksssh_sshtunnel_getsshforwardhost(void* lpObj);
int ipworksssh_sshtunnel_setsshforwardhost(void* lpObj, const char* lpszSSHForwardHost);
QString GetSSHForwardHost();
int SetSSHForwardHost(QString qsSSHForwardHost);

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 (SSHTunnel Class)

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

Syntax

ANSI (Cross Platform)
int GetSSHForwardPort();
int SetSSHForwardPort(int iSSHForwardPort); Unicode (Windows) INT GetSSHForwardPort();
INT SetSSHForwardPort(INT iSSHForwardPort);
int ipworksssh_sshtunnel_getsshforwardport(void* lpObj);
int ipworksssh_sshtunnel_setsshforwardport(void* lpObj, int iSSHForwardPort);
int GetSSHForwardPort();
int SetSSHForwardPort(int iSSHForwardPort);

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 (SSHTunnel Class)

The address of the Secure Shell (SSH) host.

Syntax

ANSI (Cross Platform)
char* GetSSHHost();
int SetSSHHost(const char* lpszSSHHost); Unicode (Windows) LPWSTR GetSSHHost();
INT SetSSHHost(LPCWSTR lpszSSHHost);
char* ipworksssh_sshtunnel_getsshhost(void* lpObj);
int ipworksssh_sshtunnel_setsshhost(void* lpObj, const char* lpszSSHHost);
QString GetSSHHost();
int SetSSHHost(QString qsSSHHost);

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 (SSHTunnel Class)

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

Syntax

ANSI (Cross Platform)
char* GetSSHPassword();
int SetSSHPassword(const char* lpszSSHPassword); Unicode (Windows) LPWSTR GetSSHPassword();
INT SetSSHPassword(LPCWSTR lpszSSHPassword);
char* ipworksssh_sshtunnel_getsshpassword(void* lpObj);
int ipworksssh_sshtunnel_setsshpassword(void* lpObj, const char* lpszSSHPassword);
QString GetSSHPassword();
int SetSSHPassword(QString qsSSHPassword);

Default Value

""

Remarks

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

Data Type

String

SSHPort Property (SSHTunnel Class)

The port on the Secure Shell (SSH) server where the SSH service is running; by default, 22.

Syntax

ANSI (Cross Platform)
int GetSSHPort();
int SetSSHPort(int iSSHPort); Unicode (Windows) INT GetSSHPort();
INT SetSSHPort(INT iSSHPort);
int ipworksssh_sshtunnel_getsshport(void* lpObj);
int ipworksssh_sshtunnel_setsshport(void* lpObj, int iSSHPort);
int GetSSHPort();
int SetSSHPort(int iSSHPort);

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 (SSHTunnel Class)

The username for Secure Shell (SSH) authentication.

Syntax

ANSI (Cross Platform)
char* GetSSHUser();
int SetSSHUser(const char* lpszSSHUser); Unicode (Windows) LPWSTR GetSSHUser();
INT SetSSHUser(LPCWSTR lpszSSHUser);
char* ipworksssh_sshtunnel_getsshuser(void* lpObj);
int ipworksssh_sshtunnel_setsshuser(void* lpObj, const char* lpszSSHUser);
QString GetSSHUser();
int SetSSHUser(QString qsSSHUser);

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 (SSHTunnel Class)

Sets or retrieves a configuration setting.

Syntax

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);
char* ipworksssh_sshtunnel_config(void* lpObj, const char* lpszConfigurationString);
QString Config(const QString& qsConfigurationString);

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.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Connect Method (SSHTunnel Class)

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

Syntax

ANSI (Cross Platform)
int Connect();

Unicode (Windows)
INT Connect();
int ipworksssh_sshtunnel_connect(void* lpObj);
int Connect();

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

DecodePacket Method (SSHTunnel Class)

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

Syntax

ANSI (Cross Platform)
char* DecodePacket(const char* lpszEncodedPacket, int *lpSize = NULL);

Unicode (Windows)
LPSTR DecodePacket(LPCWSTR lpszEncodedPacket, LPINT lpSize = NULL);
char* ipworksssh_sshtunnel_decodepacket(void* lpObj, const char* lpszEncodedPacket, int *lpSize);
QByteArray DecodePacket(const QString& qsEncodedPacket);

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.

Error Handling (C++)

This method returns a Binary String value (with length lpSize); after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Disconnect Method (SSHTunnel Class)

This method disconnects the specified client.

Syntax

ANSI (Cross Platform)
int Disconnect(int iConnectionId);

Unicode (Windows)
INT Disconnect(INT iConnectionId);
int ipworksssh_sshtunnel_disconnect(void* lpObj, int iConnectionId);
int Disconnect(int iConnectionId);

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

DoEvents Method (SSHTunnel Class)

This method processes events from the internal message queue.

Syntax

ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();
int ipworksssh_sshtunnel_doevents(void* lpObj);
int DoEvents();

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

EncodePacket Method (SSHTunnel Class)

Hex encodes a Secure Shell (SSH) packet.

Syntax

ANSI (Cross Platform)
char* EncodePacket(const char* lpPacket, int lenPacket);

Unicode (Windows)
LPWSTR EncodePacket(LPCSTR lpPacket, INT lenPacket);
char* ipworksssh_sshtunnel_encodepacket(void* lpObj, const char* lpPacket, int lenPacket);
QString EncodePacket(QByteArray qbaPacket);

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.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

GetSSHParam Method (SSHTunnel Class)

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

Syntax

ANSI (Cross Platform)
char* GetSSHParam(const char* lpPayload, int lenPayload, const char* lpszField);

Unicode (Windows)
LPWSTR GetSSHParam(LPCSTR lpPayload, INT lenPayload, LPCWSTR lpszField);
char* ipworksssh_sshtunnel_getsshparam(void* lpObj, const char* lpPayload, int lenPayload, const char* lpszField);
QString GetSSHParam(QByteArray qbaPayload, const QString& qsField);

Remarks

This method is used to read the value of a particular field from an SSH packet's payload. Payload should contain the full payload of a packet received by an event such as SSHChannelRequest. Field is the name of a field to be read out of the packet.

The following is a list of the names of well-known channel request field names and their encodings:

ChannelId (int32)The Id of the channel that received the packet.
RequestType (string)The type of channel requested.
WantsReply (boolean)Whether or not the client wants a reply to the request.

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:

TerminalType (string)The type of terminal being requested (e.g., "vt100").
TerminalWidthCharacters (int32)The width, in characters, of the terminal to be opened.
TerminalHeightRows (int32)The height, in rows, of the terminal to be opened.
TerminalWidthPixels (int32)The width, in pixels, of the terminal to be opened.
TerminalHeightPixels (int32)The height, in pixels, of the terminal to be opened.
TerminalModes (string)A list of op-val (int32-byte) encoded modes to be used by the terminal.

x11-req

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

SingleConnection (boolean)Disallows more than one connection to be forwarded by the channel.
X11AuthProtocol (string)The authentication protocol to be used (e.g., "MIT-MAGIC-COOKIE-1").
X11AuthCookie (string)A hexadecimal-encoded cookie to be used for authentication.
X11ScreenNumber (int32)The x11 screen number to be used.

env

Env is a request to set an environment variable to be passed into a shell that may be started later. The following fields are available:

VariableName (string)The name of the variable to be set.
VariableValue (string)The value of the variable to be set.

exec

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

Command (string)The command to be executed.

subsystem

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

Subsystem (string)The name of the subsystem to be started (e.g., "sftp").

xon-xoff

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

ClientCanDo (boolean)Whether or not the server should enable flow control.

signal

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

SignalName (string)The name of the signal to be sent.

If the packet type is not well known, Field should start with the special character "%" and contain a comma-separated list of field types as defined in SetSSHParam. For example, reading out the X11AuthProtocol of an x11-req payload, you can use "%s,f".

Note: The return value is a string encoded the same way as the FieldValue param in SetSSHParam.

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

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

GetSSHParamBytes Method (SSHTunnel Class)

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

Syntax

ANSI (Cross Platform)
char* GetSSHParamBytes(const char* lpPayload, int lenPayload, const char* lpszField, int *lpSize = NULL);

Unicode (Windows)
LPSTR GetSSHParamBytes(LPCSTR lpPayload, INT lenPayload, LPCWSTR lpszField, LPINT lpSize = NULL);
char* ipworksssh_sshtunnel_getsshparambytes(void* lpObj, const char* lpPayload, int lenPayload, const char* lpszField, int *lpSize);
QByteArray GetSSHParamBytes(QByteArray qbaPayload, const QString& qsField);

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.

Error Handling (C++)

This method returns a Binary String value (with length lpSize); after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Reset Method (SSHTunnel Class)

This method will reset the class.

Syntax

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();
int ipworksssh_sshtunnel_reset(void* lpObj);
int Reset();

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SetSSHParam Method (SSHTunnel Class)

Writes a field to the end of a payload.

Syntax

ANSI (Cross Platform)
char* SetSSHParam(const char* lpPayload, int lenPayload, const char* lpszFieldType, const char* lpszFieldValue, int *lpSize = NULL);

Unicode (Windows)
LPSTR SetSSHParam(LPCSTR lpPayload, INT lenPayload, LPCWSTR lpszFieldType, LPCWSTR lpszFieldValue, LPINT lpSize = NULL);
char* ipworksssh_sshtunnel_setsshparam(void* lpObj, const char* lpPayload, int lenPayload, const char* lpszFieldType, const char* lpszFieldValue, int *lpSize);
QByteArray SetSSHParam(QByteArray qbaPayload, const QString& qsFieldType, const QString& qsFieldValue);

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:

sA plaintext string containing the default system encoding of the data.
sbA string containing the hex-encoded data (e.g., "A1B23C")
mA variable-length large integer, encoded as a textual representation of the value (e.g., "1234").
iA 32-bit integer, encoded as a textual representation of the value (e.g., "1234").
lA 64-bit integer, encoded as a textual representation of the value (e.g., "1234").
bA single byte, encoded as a textual representation of the value (e.g., "123").
fA boolean flag, encoded as a textual representation of the value (e.g., 'True' or 'False')

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.

Error Handling (C++)

This method returns a Binary String value (with length lpSize); after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Shutdown Method (SSHTunnel Class)

This method shuts down the server.

Syntax

ANSI (Cross Platform)
int Shutdown();

Unicode (Windows)
INT Shutdown();
int ipworksssh_sshtunnel_shutdown(void* lpObj);
int Shutdown();

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

StartListening Method (SSHTunnel Class)

This method starts listening for incoming connections.

Syntax

ANSI (Cross Platform)
int StartListening();

Unicode (Windows)
INT StartListening();
int ipworksssh_sshtunnel_startlistening(void* lpObj);
int StartListening();

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

StopListening Method (SSHTunnel Class)

This method stops listening for new connections.

Syntax

ANSI (Cross Platform)
int StopListening();

Unicode (Windows)
INT StopListening();
int ipworksssh_sshtunnel_stoplistening(void* lpObj);
int StopListening();

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Connected Event (SSHTunnel Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireConnected(SSHTunnelConnectedEventParams *e);
typedef struct {
int ConnectionId;
int StatusCode;
const char *Description; int reserved; } SSHTunnelConnectedEventParams;
Unicode (Windows) virtual INT FireConnected(SSHTunnelConnectedEventParams *e);
typedef struct {
INT ConnectionId;
INT StatusCode;
LPCWSTR Description; INT reserved; } SSHTunnelConnectedEventParams;
#define EID_SSHTUNNEL_CONNECTED 1

virtual INT IPWORKSSSH_CALL FireConnected(INT &iConnectionId, INT &iStatusCode, LPSTR &lpszDescription);
class SSHTunnelConnectedEventParams {
public:
  int ConnectionId();

  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void Connected(SSHTunnelConnectedEventParams *e);
// Or, subclass SSHTunnel and override this emitter function. virtual int FireConnected(SSHTunnelConnectedEventParams *e) {...}

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 (SSHTunnel Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireConnectionRequest(SSHTunnelConnectionRequestEventParams *e);
typedef struct {
const char *Address;
int Port;
int Accept; int reserved; } SSHTunnelConnectionRequestEventParams;
Unicode (Windows) virtual INT FireConnectionRequest(SSHTunnelConnectionRequestEventParams *e);
typedef struct {
LPCWSTR Address;
INT Port;
BOOL Accept; INT reserved; } SSHTunnelConnectionRequestEventParams;
#define EID_SSHTUNNEL_CONNECTIONREQUEST 2

virtual INT IPWORKSSSH_CALL FireConnectionRequest(LPSTR &lpszAddress, INT &iPort, BOOL &bAccept);
class SSHTunnelConnectionRequestEventParams {
public:
  const QString &Address();

  int Port();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void ConnectionRequest(SSHTunnelConnectionRequestEventParams *e);
// Or, subclass SSHTunnel and override this emitter function. virtual int FireConnectionRequest(SSHTunnelConnectionRequestEventParams *e) {...}

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 (SSHTunnel Class)

This event is fired when data come in.

Syntax

ANSI (Cross Platform)
virtual int FireDataIn(SSHTunnelDataInEventParams *e);
typedef struct {
int ConnectionId;
const char *Text; int lenText;
int EOL; int reserved; } SSHTunnelDataInEventParams;
Unicode (Windows) virtual INT FireDataIn(SSHTunnelDataInEventParams *e);
typedef struct {
INT ConnectionId;
LPCSTR Text; INT lenText;
BOOL EOL; INT reserved; } SSHTunnelDataInEventParams;
#define EID_SSHTUNNEL_DATAIN 3

virtual INT IPWORKSSSH_CALL FireDataIn(INT &iConnectionId, LPSTR &lpText, INT &lenText, BOOL &bEOL);
class SSHTunnelDataInEventParams {
public:
  int ConnectionId();

  const QByteArray &Text();

  bool EOL();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void DataIn(SSHTunnelDataInEventParams *e);
// Or, subclass SSHTunnel and override this emitter function. virtual int FireDataIn(SSHTunnelDataInEventParams *e) {...}

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 MaxLineLength 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 (SSHTunnel Class)

Fired when a connection is closed.

Syntax

ANSI (Cross Platform)
virtual int FireDisconnected(SSHTunnelDisconnectedEventParams *e);
typedef struct {
int ConnectionId;
int StatusCode;
const char *Description; int reserved; } SSHTunnelDisconnectedEventParams;
Unicode (Windows) virtual INT FireDisconnected(SSHTunnelDisconnectedEventParams *e);
typedef struct {
INT ConnectionId;
INT StatusCode;
LPCWSTR Description; INT reserved; } SSHTunnelDisconnectedEventParams;
#define EID_SSHTUNNEL_DISCONNECTED 4

virtual INT IPWORKSSSH_CALL FireDisconnected(INT &iConnectionId, INT &iStatusCode, LPSTR &lpszDescription);
class SSHTunnelDisconnectedEventParams {
public:
  int ConnectionId();

  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void Disconnected(SSHTunnelDisconnectedEventParams *e);
// Or, subclass SSHTunnel and override this emitter function. virtual int FireDisconnected(SSHTunnelDisconnectedEventParams *e) {...}

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 (SSHTunnel Class)

Fired when errors occur during data delivery.

Syntax

ANSI (Cross Platform)
virtual int FireError(SSHTunnelErrorEventParams *e);
typedef struct {
int ConnectionId;
int ErrorCode;
const char *Description; int reserved; } SSHTunnelErrorEventParams;
Unicode (Windows) virtual INT FireError(SSHTunnelErrorEventParams *e);
typedef struct {
INT ConnectionId;
INT ErrorCode;
LPCWSTR Description; INT reserved; } SSHTunnelErrorEventParams;
#define EID_SSHTUNNEL_ERROR 5

virtual INT IPWORKSSSH_CALL FireError(INT &iConnectionId, INT &iErrorCode, LPSTR &lpszDescription);
class SSHTunnelErrorEventParams {
public:
  int ConnectionId();

  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void Error(SSHTunnelErrorEventParams *e);
// Or, subclass SSHTunnel and override this emitter function. virtual int FireError(SSHTunnelErrorEventParams *e) {...}

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 (SSHTunnel Class)

Fired once for each log message.

Syntax

ANSI (Cross Platform)
virtual int FireLog(SSHTunnelLogEventParams *e);
typedef struct {
int LogLevel;
const char *Message;
const char *LogType; int reserved; } SSHTunnelLogEventParams;
Unicode (Windows) virtual INT FireLog(SSHTunnelLogEventParams *e);
typedef struct {
INT LogLevel;
LPCWSTR Message;
LPCWSTR LogType; INT reserved; } SSHTunnelLogEventParams;
#define EID_SSHTUNNEL_LOG 6

virtual INT IPWORKSSSH_CALL FireLog(INT &iLogLevel, LPSTR &lpszMessage, LPSTR &lpszLogType);
class SSHTunnelLogEventParams {
public:
  int LogLevel();

  const QString &Message();

  const QString &LogType();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void Log(SSHTunnelLogEventParams *e);
// Or, subclass SSHTunnel and override this emitter function. virtual int FireLog(SSHTunnelLogEventParams *e) {...}

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:

0 (None) No messages are logged.
1 (Info - Default) Informational events such as Secure Shell (SSH) handshake messages are logged.
2 (Verbose) Detailed data such as individual packet information are logged.
3 (Debug) Debug data including all relevant sent and received bytes are logged.

Message is the log message.

LogType is reserved for future use.

ReconnectAttempt Event (SSHTunnel Class)

Fired when attempting to reconnect.

Syntax

ANSI (Cross Platform)
virtual int FireReconnectAttempt(SSHTunnelReconnectAttemptEventParams *e);
typedef struct {
const char *Host;
int Port;
int RetryCount;
int RetriesRemaining;
int MaxRetryCount;
int RetryInterval;
int RetryType;
int RemoteListeningPort;
int Cancel; int reserved; } SSHTunnelReconnectAttemptEventParams;
Unicode (Windows) virtual INT FireReconnectAttempt(SSHTunnelReconnectAttemptEventParams *e);
typedef struct {
LPCWSTR Host;
INT Port;
INT RetryCount;
INT RetriesRemaining;
INT MaxRetryCount;
INT RetryInterval;
INT RetryType;
INT RemoteListeningPort;
BOOL Cancel; INT reserved; } SSHTunnelReconnectAttemptEventParams;
#define EID_SSHTUNNEL_RECONNECTATTEMPT 7

virtual INT IPWORKSSSH_CALL FireReconnectAttempt(LPSTR &lpszHost, INT &iPort, INT &iRetryCount, INT &iRetriesRemaining, INT &iMaxRetryCount, INT &iRetryInterval, INT &iRetryType, INT &iRemoteListeningPort, BOOL &bCancel);
class SSHTunnelReconnectAttemptEventParams {
public:
  const QString &Host();

  int Port();

  int RetryCount();

  int RetriesRemaining();

  int MaxRetryCount();

  int RetryInterval();

  int RetryType();

  int RemoteListeningPort();

  bool Cancel();
  void SetCancel(bool bCancel);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void ReconnectAttempt(SSHTunnelReconnectAttemptEventParams *e);
// Or, subclass SSHTunnel and override this emitter function. virtual int FireReconnectAttempt(SSHTunnelReconnectAttemptEventParams *e) {...}

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:

Host The SSH host to which the connection is attempted.
Port The port on the SSH host to which the connection is attempted.
RetryCount The current retry attempt. For instance, this may be attempt number 2 out of 5, then RetryCount will hold the value 2.
RetriesRemaining The number of retries remaining after this attempt. This number does not include the current attempt. If MaxRetryCount is set to unlimited, this will return -1.
MaxRetryCount The maximum number of retries as specified in MaxRetryCount.
RetryInterval The interval (in seconds) between retry attempts as specified in RetryInterval.
RetryType The type of connection being retried. Possible values are as follows:
  • 0 - SSH
  • 1 - Tunnel
RemoteListeningPort The port on the SSH host that the reverse tunnel will use. This is applicable only when RetryType is 1.
Cancel Maybe set within this event to cancel the retry attempts. If set to True, no further retry attempts will be executed.

SSHCustomAuth Event (SSHTunnel Class)

Fired when the class is doing a custom authentication.

Syntax

ANSI (Cross Platform)
virtual int FireSSHCustomAuth(SSHTunnelSSHCustomAuthEventParams *e);
typedef struct {
char *Packet; int reserved; } SSHTunnelSSHCustomAuthEventParams;
Unicode (Windows) virtual INT FireSSHCustomAuth(SSHTunnelSSHCustomAuthEventParams *e);
typedef struct {
LPWSTR Packet; INT reserved; } SSHTunnelSSHCustomAuthEventParams;
#define EID_SSHTUNNEL_SSHCUSTOMAUTH 8

virtual INT IPWORKSSSH_CALL FireSSHCustomAuth(LPSTR &lpszPacket);
class SSHTunnelSSHCustomAuthEventParams {
public:
  const QString &Packet();
  void SetPacket(const QString &qsPacket);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void SSHCustomAuth(SSHTunnelSSHCustomAuthEventParams *e);
// Or, subclass SSHTunnel and override this emitter function. virtual int FireSSHCustomAuth(SSHTunnelSSHCustomAuthEventParams *e) {...}

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 (SSHTunnel Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireSSHKeyboardInteractive(SSHTunnelSSHKeyboardInteractiveEventParams *e);
typedef struct {
const char *Name;
const char *Instructions;
const char *Prompt;
char *Response;
int EchoResponse; int reserved; } SSHTunnelSSHKeyboardInteractiveEventParams;
Unicode (Windows) virtual INT FireSSHKeyboardInteractive(SSHTunnelSSHKeyboardInteractiveEventParams *e);
typedef struct {
LPCWSTR Name;
LPCWSTR Instructions;
LPCWSTR Prompt;
LPWSTR Response;
BOOL EchoResponse; INT reserved; } SSHTunnelSSHKeyboardInteractiveEventParams;
#define EID_SSHTUNNEL_SSHKEYBOARDINTERACTIVE 9

virtual INT IPWORKSSSH_CALL FireSSHKeyboardInteractive(LPSTR &lpszName, LPSTR &lpszInstructions, LPSTR &lpszPrompt, LPSTR &lpszResponse, BOOL &bEchoResponse);
class SSHTunnelSSHKeyboardInteractiveEventParams {
public:
  const QString &Name();

  const QString &Instructions();

  const QString &Prompt();

  const QString &Response();
  void SetResponse(const QString &qsResponse);

  bool EchoResponse();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void SSHKeyboardInteractive(SSHTunnelSSHKeyboardInteractiveEventParams *e);
// Or, subclass SSHTunnel and override this emitter function. virtual int FireSSHKeyboardInteractive(SSHTunnelSSHKeyboardInteractiveEventParams *e) {...}

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 (SSHTunnel Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireSSHServerAuthentication(SSHTunnelSSHServerAuthenticationEventParams *e);
typedef struct {
const char *HostKey; int lenHostKey;
const char *Fingerprint;
const char *KeyAlgorithm;
const char *CertSubject;
const char *CertIssuer;
const char *Status;
int Accept; int reserved; } SSHTunnelSSHServerAuthenticationEventParams;
Unicode (Windows) virtual INT FireSSHServerAuthentication(SSHTunnelSSHServerAuthenticationEventParams *e);
typedef struct {
LPCSTR HostKey; INT lenHostKey;
LPCWSTR Fingerprint;
LPCWSTR KeyAlgorithm;
LPCWSTR CertSubject;
LPCWSTR CertIssuer;
LPCWSTR Status;
BOOL Accept; INT reserved; } SSHTunnelSSHServerAuthenticationEventParams;
#define EID_SSHTUNNEL_SSHSERVERAUTHENTICATION 10

virtual INT IPWORKSSSH_CALL FireSSHServerAuthentication(LPSTR &lpHostKey, INT &lenHostKey, LPSTR &lpszFingerprint, LPSTR &lpszKeyAlgorithm, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);
class SSHTunnelSSHServerAuthenticationEventParams {
public:
  const QByteArray &HostKey();

  const QString &Fingerprint();

  const QString &KeyAlgorithm();

  const QString &CertSubject();

  const QString &CertIssuer();

  const QString &Status();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void SSHServerAuthentication(SSHTunnelSSHServerAuthenticationEventParams *e);
// Or, subclass SSHTunnel and override this emitter function. virtual int FireSSHServerAuthentication(SSHTunnelSSHServerAuthenticationEventParams *e) {...}

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

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 (SSHTunnel Class)

Fired to track the progress of the secure connection.

Syntax

ANSI (Cross Platform)
virtual int FireSSHStatus(SSHTunnelSSHStatusEventParams *e);
typedef struct {
const char *Message; int reserved; } SSHTunnelSSHStatusEventParams;
Unicode (Windows) virtual INT FireSSHStatus(SSHTunnelSSHStatusEventParams *e);
typedef struct {
LPCWSTR Message; INT reserved; } SSHTunnelSSHStatusEventParams;
#define EID_SSHTUNNEL_SSHSTATUS 11

virtual INT IPWORKSSSH_CALL FireSSHStatus(LPSTR &lpszMessage);
class SSHTunnelSSHStatusEventParams {
public:
  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void SSHStatus(SSHTunnelSSHStatusEventParams *e);
// Or, subclass SSHTunnel and override this emitter function. virtual int FireSSHStatus(SSHTunnelSSHStatusEventParams *e) {...}

Remarks

The event is fired for informational and logging purposes only. Used to track the progress of the connection.

Certificate Type

This is the digital certificate being used.

Syntax

IPWorksSSHCertificate (declared in ipworksssh.h)

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

The following fields are available:

Fields

EffectiveDate
char* (read-only)

Default Value: ""

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.

ExpirationDate
char* (read-only)

Default Value: ""

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.

ExtendedKeyUsage
char* (read-only)

Default Value: ""

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

Fingerprint
char* (read-only)

Default Value: ""

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

FingerprintSHA1
char* (read-only)

Default Value: ""

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

FingerprintSHA256
char* (read-only)

Default Value: ""

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

Issuer
char* (read-only)

Default Value: ""

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

PrivateKey
char* (read-only)

Default Value: ""

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

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

PrivateKeyAvailable
int (read-only)

Default Value: FALSE

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

PrivateKeyContainer
char* (read-only)

Default Value: ""

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

PublicKey
char* (read-only)

Default Value: ""

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

PublicKeyAlgorithm
char* (read-only)

Default Value: ""

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.

PublicKeyLength
int (read-only)

Default Value: 0

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

SerialNumber
char* (read-only)

Default Value: ""

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.

SignatureAlgorithm
char* (read-only)

Default Value: ""

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.

Store
char*

Default Value: "MY"

The name of the certificate store for the client certificate.

The StoreType field denotes the type of the certificate store specified by Store. If the store is password-protected, specify the password in StorePassword.

Store is used in conjunction with the Subject field to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject field for details.

Designations of certificate stores are platform dependent.

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

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot certificates.

When the certificate store type is 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).

StorePassword
char*

Default Value: ""

If the type of certificate store requires a password, this field is used to specify the password needed to open the certificate store.

StoreType
int

Default Value: 0

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 field can take one of the following values:

0 (cstUser - default)For Windows, this specifies that the certificate store is a certificate store owned by the current user.

Note: This store type is not available in Java.

1 (cstMachine)For Windows, this specifies that the certificate store is a machine store.

Note: This store type is not available in Java.

2 (cstPFXFile)The certificate store is the name of a PFX (PKCS#12) file containing certificates.
3 (cstPFXBlob)The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format.
4 (cstJKSFile)The certificate store is the name of a Java Key Store (JKS) file containing certificates.

Note: This store type is only available in Java.

5 (cstJKSBlob)The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.

Note: This store type is only available in Java.

6 (cstPEMKeyFile)The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)The certificate store is the name of a PKCS#7 file containing certificates.
12 (cstP7BBlob)The certificate store is a string (binary) representing a certificate store in PKCS#7 format.
13 (cstSSHPublicKeyFile)The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)The certificate store is a string that contains a JWK (JSON Web Key).
21 (cstBCFKSFile)The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).

Note: This store type is only available in Java and .NET.

22 (cstBCFKSBlob)The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.

Note: This store type is only available in Java and .NET.

23 (cstPKCS11)The certificate is present on a physical security key accessible via a PKCS#11 interface.

To use a security key, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use.

When using a certificate, pass the previously saved security key information as the Store and set StorePassword to the PIN.

Code Example. SSH Authentication with Security Key: certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);

99 (cstAuto)The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

SubjectAltNames
char* (read-only)

Default Value: ""

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

ThumbprintMD5
char* (read-only)

Default Value: ""

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.

ThumbprintSHA1
char* (read-only)

Default Value: ""

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.

ThumbprintSHA256
char* (read-only)

Default Value: ""

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.

Usage
char* (read-only)

Default Value: ""

The text description of UsageFlags.

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.

UsageFlags
int (read-only)

Default Value: 0

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

0x80Digital Signature
0x40Non-Repudiation
0x20Key Encipherment
0x10Data Encipherment
0x08Key Agreement
0x04Certificate Signing
0x02CRL Signing
0x01Encipher Only

Please see the Usage field for a text representation of UsageFlags.

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

Version
char* (read-only)

Default Value: ""

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

Subject
char*

Default Value: ""

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

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

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

Encoded
char*

Default Value: ""

The certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate.

When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject is set to an empty string.

Constructors

Certificate()

Creates a instance whose properties can be set. This is useful for use with when generating new certificates.

Certificate(const char* lpEncoded, int lenEncoded)

Parses Encoded as an X.509 public key.

Certificate(int iStoreType, const char* lpStore, int lenStore, const char* lpszStorePassword, const char* lpszSubject)

StoreType identifies the type of certificate store to use. See for descriptions of the different certificate stores. Store is a byte array containing the certificate data. StorePassword is the password used to protect the store.

After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.

Connection Type

This is a currently connected client.

Syntax

IPWorksSSHConnection (declared in ipworksssh.h)

Remarks

This type describes the connection of a client that is currently connected to the class. You may use the different fields of this type to manage the connection.

The following fields are available:

Fields

AcceptData
int (read-only)

Default Value: TRUE

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

BytesSent
int (read-only)

Default Value: 0

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

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

Connected
int (read-only)

Default Value: FALSE

This field indicates the status of individual connections.

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

ConnectionId
int (read-only)

Default Value: 0

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

EOL
char*

Default Value: ""

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

The EOL field 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 EOL field 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 field, 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.

IdleTimeout
int

Default Value: 0

This field contains the idle timeout for this connection. This field is similar to DefaultIdleTimeout but may be set on a per-connection basis to override DefaultIdleTimeout. This field 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.

LocalAddress
char* (read-only)

Default Value: ""

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

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

MaxLineLength
int

Default Value: 2048

This field is the size of an internal buffer that holds received data while waiting for an EOL string.

If an EOL string is found in the input stream before MaxLineLength bytes are received, the DataIn event is fired with the EOL parameter set to True, and the buffer is reset.

If no EOL is found, and MaxLineLength bytes are accumulated in the buffer, the DataIn event is fired with the EOL parameter set to False, and the buffer is reset.

The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes.

ReadyToSend
int (read-only)

Default Value: FALSE

This field 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 field will be true when data can be sent again.

RecordLength
int (read-only)

Default Value: 0

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

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

RemoteHost
char* (read-only)

Default Value: ""

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

RemotePort
int (read-only)

Default Value: 0

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

SingleLineMode
int

Default Value: FALSE

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

Timeout
int

Default Value: 0

This field specifies a timeout for the class.

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

If Timeout is set to a positive value, data is sent in a blocking manner and the class will wait for the operation to complete before returning control. The class will handle any potential WOULDBLOCK errors internally and automatically retry the operation for a maximum of Timeout seconds.

The class will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.

If Timeout expires, and the operation is not yet complete, the class fails with an error.

Note: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout field is 0 (asynchronous operation).

UserData
char*

Default Value: ""

The UserData field 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.

Constructors

Connection()

Firewall Type

The firewall the component will connect through.

Syntax

IPWorksSSHFirewall (declared in ipworksssh.h)

Remarks

When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall Host and the FirewallType.

The following fields are available:

Fields

AutoDetect
int

Default Value: FALSE

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

FirewallType
int

Default Value: 0

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

fwNone (0)No firewall (default setting).
fwTunnel (1)Connect through a tunneling proxy. Port is set to 80.
fwSOCKS4 (2)Connect through a SOCKS4 Proxy. Port is set to 1080.
fwSOCKS5 (3)Connect through a SOCKS5 Proxy. Port is set to 1080.
fwSOCKS4A (10)Connect through a SOCKS4A Proxy. Port is set to 1080.

Host
char*

Default Value: ""

The name or IP address of the firewall (optional). If a Host is given, the requested connections will be authenticated through the specified firewall when connecting.

If this field is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this field is set to the corresponding address. If the search is not successful, the class fails with an error.

Password
char*

Default Value: ""

A password if authentication is to be used when connecting through the firewall. If Host is specified, the User and Password fields are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

Port
int

Default Value: 0

The Transmission Control Protocol (TCP) port for the firewall Host. See the description of the Host field for details.

Note: This field is set automatically when FirewallType is set to a valid value. See the description of the FirewallType field for details.

User
char*

Default Value: ""

A username if authentication is to be used when connecting through a firewall. If Host is specified, this field and the Password field are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.

Constructors

Firewall()

IPWorksSSHList Type

Syntax

IPWorksSSHList<T> (declared in ipworksssh.h)

Remarks

IPWorksSSHList is a generic class that is used to hold a collection of objects of type T, where T is one of the custom types supported by the SSHTunnel class.

Methods

GetCount This method returns the current size of the collection.

int GetCount() {}

SetCount This method sets the size of the collection. This method returns 0 if setting the size was successful; or -1 if the collection is ReadOnly. When adding additional objects to a collection call this method to specify the new size. Increasing the size of the collection preserves existing objects in the collection.

int SetCount(int count) {}

Get This method gets the item at the specified position. The index parameter specifies the index of the item in the collection. This method returns NULL if an invalid index is specified.

T* Get(int index) {}

Set This method sets the item at the specified position. The index parameter specifies the index of the item in the collection that is being set. This method returns -1 if an invalid index is specified. Note: Objects created using the new operator must be freed using the delete operator; they will not be automatically freed by the class.

T* Set(int index, T* value) {}

Config Settings (SSHTunnel Class)

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

SSHTunnel Config Settings

AutoReconnect:   Whether to automatically reconnect.

This configuration setting controls automatic recovery of the Secure Shell (SSH) connection. If logon is disrupted or the channel is closed, the component can be configured to attempt reconnection automatically. Possible values follow:

ValueDescription
0 (None) Do not automatically reconnect.
1 (Default) Reconnect if an existing connection is broken.
2 (Always) Retry the initial logon as well as recover an existing connection.

See MaxRetryCount and RetryInterval for additional related settings.

MaxRetryCount:   The maximum number of retries when reconnecting.

This configuration setting defines the maximum number of connection attempts performed when reestablishing a broken connection. This configuration setting applies only when AutoReconnect is enabled. By default, the component will reconnect forever.

RetryInterval:   The interval in seconds between reconnect attempts.

This configuration setting specifies the number of seconds between reconnection attempts. This setting applies only when AutoReconnect is enabled. The default value is 5.

ShutdownChannelOnEOF:   Whether the client will shutdown the channel after receiving an EOF packet from the remote host.

The default value is False. Set this to True to send the channel close packet when an EOF packet is received.

SSHForwardSocketPath:   The path to the Unix domain socket where the traffic will be forwarded.

To enable this feature, specify the full path to the Unix socket you wish to connect to. When this configuration is set, all traffic will be securely forwarded over the Secure Shell (SSH) tunnel to the specified Unix socket. Use this setting in place of the SSHForwardHost and SSHForwardPort properties when working with Unix sockets.

Example: component.LocalPort = 777; component.SSHHost = "remotehost"; component.SSHUser = "sshuser"; component.SSHPassword = "pass"; component.Config("SSHForwardSocketPath=/path/to/unix/test.sock"); component.StartListening();

SSHClient Config Settings

ChannelDataEOL[ChannelId]:   Used to break the incoming data stream into chunks.

By default MaxChannelDataLength is 0 and ChannelDataEOL is an empty string. SSHChannelData fires whenever an SSH_MSG_CHANNEL_DATA packet is received.

If MaxChannelDataLength is greater than 0 and ChannelDataEOL is a nonempty string, the class will internally buffer data waiting to fire SSHChannelData until either MaxChannelDataLength is reached or ChannelDataEOL is found, whichever comes first. Query ChannelDataEOLFound to know which condition was met. The buffer is reset any time SSHChannelData fires.

ChannelDataEOL and MaxChannelDataLength must be set together or unexpected behavior could occur.

ChannelDataEOLFound[ChannelId]:   Determines if ChannelDataEOL was found.

If true,then ChannelDataEOL was found. If false, then MaxChannelDataLength was reached.

This configuration setting is valid only when queried inside SSHChannelData, MaxChannelDataLength > 0, and ChannelDataEOL is nonempty.

ClientSSHVersionString:   The SSH version string used by the class.

This configuration setting specifies the Secure Shell (SSH) version string used by the class. The default value is "SSH-2.0-IPWorks SSH Client 2024".

Most SSH servers expect the SSH version string to have the expected format "SSH-protocol version-software version". See above for an example.

DoNotRepeatAuthMethods:   Whether the class will repeat authentication methods during multifactor authentication.

The default value is true. When set to false, the class will repeat authentication methods that have already been completed during multifactor authentication.

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

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

ValueDescription
0 (Disabled - default) No communication with Pageant is attempted.
1 (Enabled) Pageant authentication is used if available. If Pageant is not running, or does not contain the expected key, no error is thrown.
2 (Required) Only Pageant authentication is used. If Pageant is not running, or does not contain the expected key, an error is thrown.

Example 1. Enabling Pageant: component.Config("EnablePageantAuth=1"); component.SSHUser = "sshuser"; component.SSHLogon("localhost", 22);

Note: This functionality is available only on Windows.

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

The default value is "True". If set to "False", the client will not ask for credentials delegation support during authentication.

Note: Even if the client asks for delegation, the server/KDC might not grant it, and authentication will still succeed.

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

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

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

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

KeyRenegotiationThreshold:   Sets the threshold for the SSH Key Renegotiation.

This property allows you to specify the threshold, in the number of bytes, for the Secure Shell (SSH) key renegotiation. The default value for this property is set to 1 GB.

Example. Setting the Threshold to 500 MB: SSHComponent.Config("KeyRenegotiationThreshold=524288000")

LogLevel:   Specifies the level of detail that is logged.

This configuration setting controls the level of detail that is logged through the Log event. Possible values are as follows:

0 (None) No messages are logged.
1 (Info - Default) Informational events such as Secure Shell (SSH) handshake messages are logged.
2 (Verbose) Detailed data such as individual packet information are logged.
3 (Debug) Debug data including all relevant sent and received bytes are logged.

MaxChannelDataLength[ChannelId]:   The maximum amount of data to accumulate when no ChannelDataEOL is found.

By default MaxChannelDataLength is 0 and ChannelDataEOL is an empty string. SSHChannelData fires whenever an SSH_MSG_CHANNEL_DATA packet is received.

If MaxChannelDataLength is greater than 0 and ChannelDataEOL is a nonempty string, the class will internally buffer data waiting to fire SSHChannelData until either MaxChannelDataLength is reached or ChannelDataEOL is found, whichever comes first. Query ChannelDataEOLFound to know which condition was met. The buffer is reset any time SSHChannelData fires.

ChannelDataEOL and MaxChannelDataLength must be set together or unexpected behavior could occur.

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

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

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

This configuration setting specifies how many bytes of channel data can be sent to the sender of this message without adjusting the window.

Note: This value may be changed during the connection, but the window size can only be increased, not decreased.

NegotiatedStrictKex:   Returns whether strict key exchange was negotiated to be used.

This configuration setting specifies whether strict key exchange (strict kex) was negotiated during the SSH handshake. If strict kex is being used, then this will return "True". If strict kex is not being used, then this will return "False".

component.Config("NegotiatedStrictKex")

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

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

This provides an easy way to automatically reply to prompts with the password if one is presented by the server. The password will be autofilled in the Response parameter of the SSHKeyboardInteractive event in the case of a match.

The following special characters are supported for pattern matching:

? Any single character.
* Any characters or no characters (e.g., C*t matches Cat, Cot, Coast, Ct).
[,-] A range of characters (e.g., [a-z], [a], [0-9], [0-9,a-d,f,r-z]).
\ The slash is ignored and exact matching is performed on the next character.

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

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

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

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

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

RecordLength:   The length of received data records.

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

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

ServerSSHVersionString:   The remote host's SSH version string.

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

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

When authenticating via public key authentication, this setting may be set to the certificate authority (CA) signed client's public key. This is useful when the server has been configured to trust client keys signed by a particular CA. For instance: component.Config("SignedSSHCert=ssh-rsa-cert-v01@openssh.com AAAAB3NzaC1yc2EAAAADAQABAAAB..."); The algorithm such as ssh-rsa-cert-v01@openssh.com in the previous string is used as part of the authentication process. To use a different algorithm, simply change this value. For instance, all of the following are acceptable with the same signed public key:

  • ssh-rsa-cert-v01@openssh.com AAAAB3NzaC1yc2EAAAADAQABAAAB...
  • rsa-sha2-256-cert-v01@openssh.com AAAAB3NzaC1yc2EAAAADAQABAAAB...
  • rsa-sha2-512-cert-v01@openssh.com AAAAB3NzaC1yc2EAAAADAQABAAAB...

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

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

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

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

SSHAcceptServerHostKeyFingerPrint:   The fingerprint of the server key to accept.

This configuration setting may be set to a comma-delimited collection of 16-byte MD5 fingerprints that should be accepted as the host's key. You may supply it by hex- encoding the values in the form "0a:1b:2c:3d". Example 2. Accepting Fingerprints: SSHClient.Config("SSHAcceptServerHostKeyFingerprint=0a:1b:2c:3d"); If the server's fingerprint matches one of the values supplied, the class will accept the host key.

SSHFingerprintHashAlgorithm:   The algorithm used to calculate the fingerprint.

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

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

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

SSHFingerprintSHA1:   The server hostkey's SHA1 fingerprint.

This configuration setting may be queried in SSHServerAuthentication to get the server hostkey's SHA-1 fingerprint.

SSHFingerprintSHA256:   The server hostkey's SHA256 fingerprint.

This configuration setting may be queried in SSHServerAuthentication to get the server hostkey's SHA-256 fingerprint.

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

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

SSHKeepAliveInterval:   The interval between keep alive packets.

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

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

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

SSHKeyExchangeAlgorithms:   Specifies the supported key exchange algorithms.

This configuration setting may be used to specify the list of supported key exchange algorithms used during Secure Shell (SSH) negotiation. The value should contain a comma-separated list of algorithms. Supported algorithms are as follows:

  • curve25519-sha256
  • curve25519-sha256@libssh.org
  • diffie-hellman-group1-sha1
  • diffie-hellman-group14-sha1
  • diffie-hellman-group14-sha256
  • diffie-hellman-group16-sha512
  • diffie-hellman-group18-sha512
  • diffie-hellman-group-exchange-sha256
  • diffie-hellman-group-exchange-sha1
  • ecdh-sha2-nistp256
  • ecdh-sha2-nistp384
  • ecdh-sha2-nistp521
  • gss-group14-sha256-toWM5Slw5Ew8Mqkay+al2g==
  • gss-group16-sha512-toWM5Slw5Ew8Mqkay+al2g==
  • gss-nistp256-sha256-toWM5Slw5Ew8Mqkay+al2g==
  • gss-curve25519-sha256-toWM5Slw5Ew8Mqkay+al2g==
  • gss-group14-sha1-toWM5Slw5Ew8Mqkay+al2g==
  • gss-gex-sha1-toWM5Slw5Ew8Mqkay+al2g==
The default value is curve25519-sha256,curve25519-sha256@libssh.org,diffie-hellman-group-exchange-sha256,diffie-hellman-group14-sha256,diffie-hellman-group16-sha512,diffie-hellman-group18-sha512,ecdh-sha2-nistp256,ecdh-sha2-nistp384,ecdh-sha2-nistp521,diffie-hellman-group-exchange-sha1,diffie-hellman-group14-sha1,diffie-hellman-group1-sha1,gss-group14-sha256-toWM5Slw5Ew8Mqkay+al2g==,gss-group16-sha512-toWM5Slw5Ew8Mqkay+al2g==,gss-nistp256-sha256-toWM5Slw5Ew8Mqkay+al2g==,gss-curve25519-sha256-toWM5Slw5Ew8Mqkay+al2g==,gss-group14-sha1-toWM5Slw5Ew8Mqkay+al2g==,gss-gex-sha1-toWM5Slw5Ew8Mqkay+al2g==.
SSHKeyRenegotiate:   Causes the component to renegotiate the SSH keys.

Once this configuration setting is queried, the component will renegotiate the SSH keys with the remote host.

Example 3. Renegotiating SSH Keys: SSHClient.Config("SSHKeyRenegotiate")

SSHMacAlgorithms:   Specifies the supported Mac algorithms.

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

  • hmac-sha1
  • hmac-md5
  • hmac-sha1-96
  • hmac-md5-96
  • hmac-sha2-256
  • hmac-sha2-256-96
  • hmac-sha2-512
  • hmac-sha2-512-96
  • hmac-ripemd160
  • hmac-ripemd160-96
  • hmac-sha2-256-etm@openssh.com
  • hmac-sha2-512-etm@openssh.com
  • hmac-sha2-256-96-etm@openssh.com
  • hmac-sha2-512-96-etm@openssh.com
  • umac-64@openssh.com
  • umac-64-etm@openssh.com
  • umac-128@openssh.com
  • umac-128-etm@openssh.com
The default value is hmac-sha2-256,hmac-sha2-512,hmac-sha1,hmac-md5,hmac-ripemd160,hmac-sha1-96,hmac-md5-96,hmac-sha2-256-96,hmac-sha2-512-96,hmac-ripemd160-96,hmac-sha2-256-etm@openssh.com,hmac-sha2-512-etm@openssh.com,umac-64@openssh.com,umac-64-etm@openssh.com,umac-128@openssh.com,umac-128-etm@openssh.com.
SSHPubKeyAuthSigAlgorithms:   Specifies the enabled signature algorithms that may be used when attempting public key authentication.

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

The setting should be a comma-separated list of algorithms. At runtime, the class will evaluate the specified algorithms, and if the algorithm is applicable to the certificate specified in SSHCert, it will be used. If the algorithm is not applicable, the class will evaluate the next algorithm. Possible values are as follows:

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

The default value in Windows is ssh-rsa,rsa-sha2-256,rsa-sha2-512,ssh-dss,ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521,ssh-ed25519.

rsa-sha2-256 and rsa-sha2-512 notes

The class will query the server for supported algorithms when connecting. If the server indicates support for rsa-sha2-256 or rsa-sha2-512 and the algorithm is present in the list defined by this setting (as in the default value), that algorithm will be used instead of ssh-rsa even when ssh-rsa appears first in the list.

For the rsa-sha2-256 and rsa-sha2-512 algorithms to be automatically preferred, the server must support the ext-info-c mechanism. In practice, older servers do not support this, and in that case, ssh-rsa will be used because it appears first in the list. Newer servers do support this mechanism, and in that case, rsa-sha2-256 or rsa-sha2-512 will be used even though it appears after ssh-rsa.

This behavior has been carefully designed to provide maximum compatibility while automatically using more secure algorithms when connecting to servers that support them.

SSHPublicKeyAlgorithms:   Specifies the supported public key algorithms for the server's public key.

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

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

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

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

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

UseStrictKeyExchange:   Specifies how strict key exchange is supported.

This configuration setting controls whether strict key exchange (strict kex) is enabled to mitigate the Terrapin attack. When enabled, the class will indicate support for strict key exchange by automatically including the pseudo-algorithm kex-strict-c-v00@openssh.com for client classes and kex-strict-s-v00@openssh.com for server classes in the list of supported key exchange algorithms.

Because both client and server must implement strict key exchange to effectively mitigate the Terrapin attack, the class provides options to further control the behavior in different scenarios. Possible values for this setting are as follows:

0Disabled. Strict key exchange is not supported in the class.
1 (default)Enabled, but not enforced. This setting enables strict key exchange, but if the remote host does not support strict key exchange the connection is still allowed to continue.
2Enabled, but will reject affected algorithms if the remote host does not support strict key exchange. If the remote host supports strict key exchange, all algorithms may be used. If the remote host does not support strict key exchange, the connection will continue only if the selected encryption and message authentication code (MAC) algorithms are not affected by the Terrapin attack.
3Required. If the remote host does not support strict key exchange, the connection will fail.

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

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

When True (default), the class will wait for a response to the channel close message until the responses have been received, the server closes the connection, or Timeout seconds is reached.

When False, the class will still send the channel close messages, but it will not wait for a response and will proceed to close the connection.

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

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

When set to True, the class will initiate the disconnection sequence by sending SSH_MSG_DISCONNECT, but it will not close the connection and instead will wait for the server to close the connection. Setting this to True may be beneficial in circumstances in which many connections are being established, to avoid port exhaustion when sockets are in a TIME_WAIT state. Allowing the server to close the connection avoids the TIME_WAIT state of socket on the client machine.

When set to False (default), the client will close the connection. It is recommended to use this value unless there is a specific need to change it.

TCPClient Config Settings

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

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

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

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

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

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

If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned.

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

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

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

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

FirewallPort:   The TCP port for the FirewallHost;.

The FirewallPort is set automatically when FirewallType is set to a valid value.

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

FirewallType:   Determines the type of firewall to connect through.

Possible values are as follows:

0No firewall (default setting).
1Connect through a tunneling proxy. FirewallPort is set to 80.
2Connect through a SOCKS4 Proxy. FirewallPort is set to 1080.
3Connect through a SOCKS5 Proxy. FirewallPort is set to 1080.
10Connect through a SOCKS4A Proxy. FirewallPort is set to 1080.

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

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

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

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

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

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

Note: This value is not applicable in macOS.

KeepAliveRetryCount:   The number of keep-alive packets to be sent before the remotehost is considered disconnected.

When set, TCPKeepAlive will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by KeepAliveTime. If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the number of times that the keep-alive packets will be sent before the remote host is considered disconnected. The system default if this value is not specified here is 9.

Note: This configuration setting is only available in the Unix platform. It is not supported in masOS or FreeBSD.

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

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

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

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

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

In the second scenario, if LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection.

The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the class returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).

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

LingerTime:   Time in seconds to have the connection linger.

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

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

The LocalHost setting contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface), setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

If the class is connected, the LocalHost setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

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

This configuration setting must be set before a connection is attempted. It instructs the class to bind to a specific port (or communication endpoint) in the local machine.

Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established.

LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.

This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems.

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

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

If an EOL string is found in the input stream before MaxLineLength bytes are received, the DataIn event is fired with the EOL parameter set to True, and the buffer is reset.

If no EOL is found, and MaxLineLength bytes are accumulated in the buffer, the DataIn event is fired with the EOL parameter set to False, and the buffer is reset.

The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes.

MaxTransferRate:   The transfer rate limit in bytes per second.

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

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

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

www.google.com;www.nsoftware.com

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

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

Note: This value is not applicable in Java.

TcpNoDelay:   Whether or not to delay when sending packets.

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

By default, this configuration setting is set to False.

UseIPv6:   Whether to use IPv6.

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

0 IPv4 only
1 IPv6 only
2 IPv6 with IPv4 fallback

Socket Config Settings

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

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

Note: This option is not valid for User Datagram Protocol (UDP) ports.

FirewallData:   Used to send extra data to the firewall.

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

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

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

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

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

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

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

TCPServer Config Settings

AllowedClients:   A comma-separated list of host names or IP addresses that can access the class.

This configuration setting defines a comma-separated list of host names or IPv4 addresses that may access the class. The wildcard character "*" is supported. The default value is "*" and all connections are accepted.

When a client connects, the client's address is checked against the list defined here. If there is no match, the ConnectionRequest event fires with an Accept value set to false. If no action is taken within the ConnectionRequest event, the client will be disconnected.

BindExclusively:   Whether or not the component considers a local port reserved for exclusive use.

If this is true (default), the component will bind to the local port with the ExclusiveAddressUse option set, meaning that nothing else can bind to the same port. Also the component will not be able to bind to local ports that are already in use by some other instance, and attempts to do so will result in failure.

BlockedClients:   A comma-separated list of host names or IP addresses that cannot access the class.

This configuration setting defines a comma-separated list of host names or IPv4 addresses that cannot access the class.The default value is "" and all connections are accepted.

When a client connects, the client's address is checked against the list defined here. If there is a match, the ConnectionRequest event fires with an Accept value set to false. If no action is taken within the ConnectionRequest event, the client will not be connected.

ConnectionUID:   The unique connectionId for a connection.

Connection Ids may be reused as clients connect and disconnect. Querying ConnectionUID will return a unique identifier for that connection Id. If the specified connection Id does not exist, then ConnectionUID will return 0. For example:

Connection5UID = obj.config("ConnectionUID[5]")

DefaultConnectionTimeout:   The inactivity timeout applied to the SSL handshake.

This configuration setting specifies the inactivity (in seconds) to apply to incoming Secure Sockets Layer (SSL) connections. When set to a positive value, if the other end is unresponsive for the specified number of seconds, the connection will timeout. This is not applicable to the entire handshake. It is applicable only to the inactivity of the connecting client during the handshake if a response is expected and none is received within the timeout window. The default value is 0, and no connection-specific timeout is applied.

Note: This is applicable only to incoming SSL connections. This should be set only if there is a specific reason to do so.

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

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

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated, the InBufferSize reverts to its defined size. The same thing will happen if you attempt to make it too large or too small.

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

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

A TCP keep-alive packet will be sent after a period of inactivity, as defined by KeepAliveTime. If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. If this value is not specified here, the system default is 1 second. This setting is applicable to all connections.

Note: This value is not applicable in macOS.

KeepAliveRetryCount:   The number of keep-alive packets to be sent before the remotehost is considered disconnected.

A TCP keep-alive packet will be sent after a period of inactivity, as defined by KeepAliveTime. If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This setting specifies the number of times that the keep-alive packets will be sent again before the remote host is considered disconnected. If this value is not specified here, the system default is 9.

Note: This configuration setting is available only in the Unix platform, and it is not supported in macOS or FreeBSD.

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

By default, the operating system will determine the time a connection is idle before a TCP keep-alive packet is sent. If this value is not specified here, the system default is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds. This setting is applicable to all connections.

MaxConnections:   The maximum number of connections available.

This is the maximum number of connections available. This property must be set before Listening is set to true, and once set, it can no longer be changed for the current instance of the class. The maximum value for this setting is 100,000 connections. Use this setting with caution. Extremely large values may affect performance. The default value is 1000.

Note: Unix/Linux operating systems limit the number of simultaneous connections to 1024.

MaxReadTime:   The maximum time spent reading data from each connection.

This setting specifies the maximum time in milliseconds that the class will spend reading data from a particular connection before servicing other connections. When a single client is sending data to the class at a high rate this setting is used to ensure that other connections are serviced in a timely manner. Specifying a positive value prevents a single client from monopolizing the class's resources. The special value of 0 indicates no limit and is generally not recommended.

The default value is 50 (milliseconds).

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

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

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the OutBufferSize reverts to its defined size. The same thing will happen if you attempt to make it too large or too small.

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

TcpNoDelay:   Whether or not to delay when sending packets.

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

By default, this configuration setting is set to False.

UseIOCP:   Whether to use the completion port I/O model.

The default value is false. When set to true, the class will use an I/O Completion Port (IOCP) to manage operations on sockets. A single completion port allows the asynchronous notification of network events on an entire group of sockets. This property must be set before Listening is set to true.

Nothing else is required to begin accepting IOCP connections. One major benefit to using this model is that there will be no thread blocked waiting for a request to complete. The system notifies the process through an Asynchronous Procedure Call (APC) once the device driver finishes servicing the I/O request. IOCP allows a single I/O worker thread handle multiple clients' input/output "fairly".

Note: When set to true, this setting will automatically set UseWindowsMessages to false.

UseIPv6:   Whether to use IPv6.

When set to 0 (default), the class will use IPv4 exclusively. When set to 1, the class will use IPv6 exclusively. When set to 2, the class will listen for both IPv4 and IPv6 connections. If IPv6 is not available on the system, only IPv4 will be used. The default value is 0. Possible values are as follows:

0 IPv4 Only
1 IPv6 Only
2 IPv6 and IPv4
UseWindowsMessages:   Whether to use the WSAAsyncSelect I/O model.

The default value is true, and the class will receive a Windows message-based notification of network events. Turning on Windows message notifications allows the application to get connect, send, receive, and socket closure network event notifications on a socket. This property must be set before Listening is set to true.

Nothing else is required to begin accepting connections using the Windows message queue. In high-traffic environments, messages will be discarded if the queue is full. Additionally, because a single window procedure will service all events on thousands of sockets, the Windows message queue is not scalable from a performance perspective.

If this setting is set to false, the class will instead use the Winsock select model instead. The component supports additional I/O models. Please see UseIOCP for more information.

Base Config Settings

BuildInfo:   Information about the product's build.

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

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

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

The following is a list of valid code page identifiers:

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

LicenseInfo:   Information about the current license.

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

  • Product: The product the license is for.
  • Product Key: The key the license was generated from.
  • License Source: Where the license was found (e.g., RuntimeLicense, License File).
  • License Type: The type of license installed (e.g., Royalty Free, Single Server).
  • Last Valid Build: The last valid build number for which the license will work.
MaskSensitiveData:   Whether sensitive data is masked in log messages.

In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to true to mask sensitive data. The default is true.

This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

ProcessIdleEvents:   Whether the class uses its internal event loop to process events when the main thread is idle.

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

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

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

UseFIPSCompliantAPI:   Tells the class whether or not to use FIPS certified APIs.

When set to true, the class will utilize the underlying operating system's certified APIs. Java editions, regardless of OS, utilize Bouncy Castle Federal Information Processing Standards (FIPS), while all other Windows editions make use of Microsoft security libraries.

FIPS mode can be enabled by setting the UseFIPSCompliantAPI configuration setting to true. This is a static setting that applies to all instances of all classes of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior.

For more details, please see the FIPS 140-2 Compliance article.

Note: This setting is applicable only on Windows.

Note: Enabling FIPS compliance requires a special license; please contact sales@nsoftware.com for details.

UseInternalSecurityAPI:   Whether or not to use the system security libraries or an internal implementation.

When set to false, the class will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to true tells the class to use the internal implementation instead of using the system security libraries.

On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.

To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.

Trappable Errors (SSHTunnel Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

SSHTunnel Errors

100   You cannot change the RemotePort at this time. A connection is in progress.
101   You cannot change the RemoteHost at this time. A connection is in progress.
102   The RemoteHost address is invalid (0.0.0.0).
104   TCPServer is already listening.
106   Cannot change LocalPort when TCPServer is listening.
107   Cannot change LocalHost when TCPServer is listening.
108   Cannot change MaxConnections when TCPServer is listening.
112   You cannot change MaxLineLength at this time. A connection is in progress.
116   RemotePort cannot be zero. Please specify a valid service port number.
126   Invalid ConnectionId.
1201   Could not forward connection. A detailed message follows.
1202   Could not forward connection/channel data. A detailed message follows.

SSHClient Errors

1001   Server has disconnected.
1002   Protocol version unsupported or other issue with version string.
1003   Cannot negotiate algorithms.
1005   Selected algorithm unsupported.
1006   Cannot set keys.
1010   Unexpected algorithm.
1011   Cannot create exchange hash.
1012   Cannot make key.
1013   Cannot sign data.
1014   Cannot encrypt packet.
1015   Cannot decrypt packet.
1016   Cannot decompress packet.
1020   Failure to open channel.
1021   Invalid channel Id.
1022   Invalid channel data.
1023   Invalid channel message.
1024   SSH message unimplemented.
1027   Server message unsupported.
1030   Server's host key was rejected. The host key may be accepted within the SSHServerAuthentication event or using the SSHAcceptServerHostKey property.
1031   Cannot verify server's host key.
1032   Authentication failed. Check description for details.
1033   Channel request failed.
1034   Diffie-Hellman exchange failed.
1036   SSH connection failed.
1037   SSH reconnect limit reached.
1038   Elliptic curve Diffie-Hellman exchange failed.
1039   SSH keep-alive limit reached.
1098   Request failure.
1130   Would block error.
1133   Would block, reason: key reExchange.

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

TCPClient Errors

100   You cannot change the RemotePort at this time. A connection is in progress.
101   You cannot change the RemoteHost (Server) at this time. A connection is in progress.
102   The RemoteHost address is invalid (0.0.0.0).
104   Already connected. If you want to reconnect, close the current connection first.
106   You cannot change the LocalPort at this time. A connection is in progress.
107   You cannot change the LocalHost at this time. A connection is in progress.
112   You cannot change MaxLineLength at this time. A connection is in progress.
116   RemotePort cannot be zero. Please specify a valid service port number.
117   You cannot change the UseConnection option while the class is active.
135   Operation would block.
201   Timeout.
211   Action impossible in control's present state.
212   Action impossible while not connected.
213   Action impossible while listening.
301   Timeout.
302   Could not open file.
434   Unable to convert string to selected CodePage.
1105   Already connecting. If you want to reconnect, close the current connection first.
1117   You need to connect first.
1119   You cannot change the LocalHost at this time. A connection is in progress.
1120   Connection dropped by remote host.

TCP/IP Errors

10004   [10004] Interrupted system call.
10009   [10009] Bad file number.
10013   [10013] Access denied.
10014   [10014] Bad address.
10022   [10022] Invalid argument.
10024   [10024] Too many open files.
10035   [10035] Operation would block.
10036   [10036] Operation now in progress.
10037   [10037] Operation already in progress.
10038   [10038] Socket operation on nonsocket.
10039   [10039] Destination address required.
10040   [10040] Message is too long.
10041   [10041] Protocol wrong type for socket.
10042   [10042] Bad protocol option.
10043   [10043] Protocol is not supported.
10044   [10044] Socket type is not supported.
10045   [10045] Operation is not supported on socket.
10046   [10046] Protocol family is not supported.
10047   [10047] Address family is not supported by protocol family.
10048   [10048] Address already in use.
10049   [10049] Cannot assign requested address.
10050   [10050] Network is down.
10051   [10051] Network is unreachable.
10052   [10052] Net dropped connection or reset.
10053   [10053] Software caused connection abort.
10054   [10054] Connection reset by peer.
10055   [10055] No buffer space available.
10056   [10056] Socket is already connected.
10057   [10057] Socket is not connected.
10058   [10058] Cannot send after socket shutdown.
10059   [10059] Too many references, cannot splice.
10060   [10060] Connection timed out.
10061   [10061] Connection refused.
10062   [10062] Too many levels of symbolic links.
10063   [10063] File name is too long.
10064   [10064] Host is down.
10065   [10065] No route to host.
10066   [10066] Directory is not empty
10067   [10067] Too many processes.
10068   [10068] Too many users.
10069   [10069] Disc Quota Exceeded.
10070   [10070] Stale NFS file handle.
10071   [10071] Too many levels of remote in path.
10091   [10091] Network subsystem is unavailable.
10092   [10092] WINSOCK DLL Version out of range.
10093   [10093] Winsock is not loaded yet.
11001   [11001] Host not found.
11002   [11002] Nonauthoritative 'Host not found' (try again or check DNS setup).
11003   [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP.
11004   [11004] Valid name, no data record (check DNS setup).