SSHTunnel Class
Properties Methods Events Config Settings Errors
The SSHTunnel class can be used to tunnel data through an 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, set Listening to true. 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 which exists in Network A wishes to connect to 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. However, Network B contains an SSH server which supports tunneling. An SSHTunnel class set up with Network A can be used to access any resource in Network B.
The SSHHost and SSHPort property 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 back 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, where the proxy port is the same as the LocalPort property. In IPWorks components a SOCKS proxy can be enabled like so:
// 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.
Connected | This shows whether the class is connected. |
ConnectionBacklog | This property includes the maximum number of pending connections maintained by the Transmission Control Protocol (TCP)/IP subsystem. |
ClientCount | The number of records in the Client arrays. |
ClientAcceptData | Setting this property to False, temporarily disables data reception (and the DataIn event) on the connection. |
ClientBytesSent | This property shows how many bytes were sent after the last assignment to DataToSend . |
ClientConnected | This property is used to disconnect individual connections or to show their status. |
ClientConnectionId | This property contains an identifier generated by the class to identify each connection. |
ClientDataToSend | This property contains a string of data to be sent to the remote host. |
ClientEOL | The EOL property is used to define boundaries in the input stream using the value of the property. |
ClientIdleTimeout | This property contains the idle timeout for this connection. |
ClientLocalAddress | This property shows the IP address of the interface through which the connection is passing. |
ClientReadyToSend | This indicates whether the class is ready to send data. |
ClientRecordLength | If set to a positive value, this setting defines the length of the data records to be received. |
ClientRemoteHost | This property shows the IP address of the remote host through which the connection is coming. |
ClientRemotePort | This property shows the Transmission Control Protocol (TCP) port on the remote host through which the connection is coming. |
ClientSingleLineMode | This property shows the special mode for line-oriented protocols. |
ClientTimeout | This property specifies a timeout for the class. |
ClientUserData | The UserData property holds connection-specific user-specified data. |
DefaultEOL | This property includes a default end-of-line (EOL) value to be used by incoming connections. |
DefaultSingleLineMode | This property tells the class whether or not to treat new connections as line oriented. |
DefaultTimeout | This property includes an initial timeout value to be used by incoming connections. |
FirewallAutoDetect | This property tells the class whether or not to automatically detect and use firewall system settings, if available. |
FirewallType | This property determines the type of firewall to connect through. |
FirewallHost | This property contains the name or IP address of firewall (optional). |
FirewallPassword | This property contains a password if authentication is to be used when connecting through the firewall. |
FirewallPort | This property contains the transmission control protocol (TCP) port for the firewall Host . |
FirewallUser | This property contains a user name if authentication is to be used connecting through a firewall. |
KeepAlive | When True, KEEPALIVE packets are enabled (for long connections). |
Linger | When set to True, connections are terminated gracefully. |
Listening | If set to True, the class accepts incoming connections on LocalPort. |
LocalHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
LocalPort | The TCP port in the local host where the class binds. |
SSHAcceptServerHostKeyEncoded | This is the certificate (PEM/base64 encoded). |
SSHAuthMode | The authentication method to be used the class when calling SSHLogon . |
SSHCertEncoded | This is the certificate (PEM/base64 encoded). |
SSHCertStore | This is the name of the certificate store for the client certificate. |
SSHCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
SSHCertStoreType | This is the type of certificate store for this certificate. |
SSHCertSubject | This is the subject of the certificate used for client authentication. |
SSHCompressionAlgorithms | A comma-separated list containing all allowable compression algorithms. |
SSHEncryptionAlgorithms | A comma-separated list containing all allowable encryption algorithms. |
SSHForwardHost | The address of the remote host. Domain names are resolved to IP addresses. |
SSHForwardPort | The TCP port in the remote host. |
SSHHost | The address of the SSH host. |
SSHPassword | The password for SSH password-based authentication. |
SSHPort | The port on the SSH server where the SSH service is running; by default, 22. |
SSHUser | The username for 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.
Config | Sets or retrieves a configuration setting. |
Connect | Connects to the SSH host without logging in. |
DecodePacket | Decodes a hex-encoded SSH packet. |
Disconnect | This method disconnects from the server without first logging off. |
DoEvents | Processes events from the internal message queue. |
EncodePacket | Hex encodes an SSH packet. |
GetSSHParam | Used to read a field from an SSH packet's payload. |
GetSSHParamBytes | Used to read a field from an SSH packet's payload. |
Reset | Reset the class. |
SetSSHParam | Used to write a field to the end of a payload. |
Shutdown | This method shuts down the server. |
StartListening | This method starts listening for incoming connections. |
StopListening | This 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.
Connected | This event is fired immediately after a connection completes (or fails). |
ConnectionRequest | This event is fired when a request for connection comes from a remote host. |
DataIn | This event is fired when data come in. |
Disconnected | Fired when a connection is closed. |
Error | Information about errors during data delivery. |
Log | Fires once for each log message. |
ReconnectAttempt | Fires when attempting to reconnect. |
SSHCustomAuth | Fired when the class is doing custom authentication. |
SSHKeyboardInteractive | Fired when the class receives a request for user input from the server. |
SSHServerAuthentication | Fired after the server presents its public key to the client. |
SSHStatus | Shows 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.
AutoReconnect | Whether to automatically reconnect. |
MaxRetryCount | The maximum number of retries when reconnecting. |
RetryInterval | The interval in seconds between reconnect attempts. |
ShutdownChannelOnEOF | Whether the client will shutdown the channel after receiving an EOF packet from the remote host. |
ClientSSHVersionString | The SSH version string used by the class. |
EnablePageantAuth | Whether to use a key stored in Pageant to perform client authentication. |
KerberosDelegation | If true, asks for credentials with delegation enabled during authentication. |
KerberosRealm | The fully qualified domain name of the Kerberos Realm to use for GSSAPI authentication. |
KerberosSPN | The Kerberos Service Principal Name of the SSH host. |
KeyRenegotiationThreshold | Sets the threshold for the SSH Key Renegotiation. |
LogLevel | Specifies the level of detail that is logged. |
MaxPacketSize | The maximum packet size of the channel, in bytes. |
MaxWindowSize | The maximum window size allowed for the channel, in bytes. |
PasswordPrompt | The text of the password prompt used in keyboard-interactive authentication. |
PreferredDHGroupBits | The size (in bits) of the preferred modulus (p) to request from the server. |
RecordLength | The length of received data records. |
ServerSSHVersionString | The remote host's SSH version string. |
SignedSSHCert | The CA signed client public key used when authenticating. |
SSHAcceptAnyServerHostKey | If set the class will accept any key presented by the server. |
SSHAcceptServerCAKey | The CA public key that signed the server's host key. |
SSHAcceptServerHostKeyFingerPrint | The fingerprint of the server key to accept. |
SSHFingerprintHashAlgorithm | The algorithm used to calculate the fingerprint. |
SSHFingerprintMD5 | The server hostkey's MD5 fingerprint. |
SSHFingerprintSHA1 | The server hostkey's SHA1 fingerprint. |
SSHFingerprintSHA256 | The server hostkey's SHA256 fingerprint. |
SSHKeepAliveCountMax | The maximum number of keep alive packets to send without a response. |
SSHKeepAliveInterval | The interval between keep alive packets. |
SSHKeyExchangeAlgorithms | Specifies the supported key exchange algorithms. |
SSHKeyRenegotiate | Causes the class to renegotiate the SSH keys. |
SSHMacAlgorithms | Specifies the supported Mac algorithms. |
SSHPubKeyAuthSigAlgorithms | Specifies the enabled signature algorithms that may be used when attempting public key authentication. |
SSHPublicKeyAlgorithms | Specifies the supported public key algorithms for the server's public key. |
SSHVersionPattern | The pattern used to match the remote host's version string. |
TryAllAvailableAuthMethods | If set to true, the class will try all available authentication methods. |
WaitForChannelClose | Whether to wait for channels to be closed before disconnected. |
WaitForServerDisconnect | Whether to wait for the server to close the connection. |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
FirewallAutoDetect | Tells the class whether or not to automatically detect and use firewall system settings, if available. |
FirewallHost | Name or IP address of firewall (optional). |
FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
FirewallPort | The TCP port for the FirewallHost;. |
FirewallType | Determines the type of firewall to connect through. |
FirewallUser | A user name if authentication is to be used connecting through a firewall. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
KeepAliveRetryCount | The number of keep-alive packets to be sent before the remotehost is considered disconnected. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
Linger | When set to True, connections are terminated gracefully. |
LingerTime | Time in seconds to have the connection linger. |
LocalHost | The name of the local host through which connections are initiated or accepted. |
LocalPort | The port in the local host where the class binds. |
MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
MaxTransferRate | The transfer rate limit in bytes per second. |
ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
TcpNoDelay | Whether or not to delay when sending packets. |
UseIPv6 | Whether to use IPv6. |
AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
FirewallData | Used to send extra data to the firewall. |
InBufferSize | The size in bytes of the incoming queue of the socket. |
OutBufferSize | The size in bytes of the outgoing queue of the socket. |
AllowedClients | A comma-separated list of host names or IP addresses that can access the class. |
BindExclusively | Whether or not the class considers a local port reserved for exclusive use. |
BlockedClients | A comma-separated list of host names or IP addresses that cannot access the class. |
ConnectionUID | The unique connectionId for a connection. |
DefaultConnectionTimeout | The inactivity timeout applied to the SSL handshake. |
InBufferSize | The size in bytes of the incoming queue of the socket. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
KeepAliveRetryCount | The number of keep-alive packets to be sent before the remotehost is considered disconnected. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
MaxConnections | The maximum number of connections available. |
MaxReadTime | The maximum time spent reading data from each connection. |
OutBufferSize | The size in bytes of the outgoing queue of the socket. |
TcpNoDelay | Whether or not to delay when sending packets. |
UseIOCP | Whether to use the completion port I/O model. |
UseIPv6 | Whether to use IPv6. |
UseWindowsMessages | Whether to use the WSAAsyncSelect I/O model. |
BuildInfo | Information about the product's build. |
CodePage | The system code page used for Unicode to Multibyte translations. |
LicenseInfo | Information about the current license. |
MaskSensitive | Whether sensitive data is masked in log messages. |
ProcessIdleEvents | Whether the class uses its internal event loop to process events when the main thread is idle. |
SelectWaitMillis | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
UseFIPSCompliantAPI | Tells the class whether or not to use FIPS certified APIs. |
UseInternalSecurityAPI | Tells the class whether or not to use the system security libraries or an internal implementation. |
Connected Property (SSHTunnel Class)
This shows whether the class is connected.
Syntax
ANSI (Cross Platform) int GetConnected();
int SetConnected(int bConnected); Unicode (Windows) BOOL GetConnected();
INT SetConnected(BOOL bConnected);
int ipworksssh_sshtunnel_getconnected(void* lpObj);
int ipworksssh_sshtunnel_setconnected(void* lpObj, int bConnected);
bool GetConnected();
int SetConnected(bool bConnected);
Default Value
FALSE
Remarks
This property is used to determine whether or not the class is connected to the remote host.
Note: It is recommended to use the Connect or Disconnect method instead of setting this property.
This property is not available at design time.
Data Type
Boolean
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
ClientCount Property (SSHTunnel Class)
The number of records in the Client arrays.
Syntax
ANSI (Cross Platform) int GetClientCount(); Unicode (Windows) INT GetClientCount();
int ipworksssh_sshtunnel_getclientcount(void* lpObj);
int GetClientCount();
Default Value
0
Remarks
This property controls the size of the following arrays:
- ClientAcceptData
- ClientBytesSent
- ClientConnected
- ClientConnectionId
- ClientDataToSend
- ClientEOL
- ClientIdleTimeout
- ClientLocalAddress
- ClientReadyToSend
- ClientRecordLength
- ClientRemoteHost
- ClientRemotePort
- ClientSingleLineMode
- ClientTimeout
- ClientUserData
This property is read-only and not available at design time.
Data Type
Integer
ClientAcceptData Property (SSHTunnel Class)
Setting this property to False, temporarily disables data reception (and the DataIn event) on the connection.
Syntax
ANSI (Cross Platform) int GetClientAcceptData(int iClientId);
int SetClientAcceptData(int iClientId, int bClientAcceptData); Unicode (Windows) BOOL GetClientAcceptData(INT iClientId);
INT SetClientAcceptData(INT iClientId, BOOL bClientAcceptData);
int ipworksssh_sshtunnel_getclientacceptdata(void* lpObj, int clientid);
int ipworksssh_sshtunnel_setclientacceptdata(void* lpObj, int clientid, int bClientAcceptData);
bool GetClientAcceptData(int iClientId);
int SetClientAcceptData(int iClientId, bool bClientAcceptData);
Default Value
TRUE
Remarks
Setting this property to False, temporarily disables data reception (and the DataIn event) on the connection. Setting this to True, re-enables data reception.
Note: It is recommended to use the PauseData or ProcessData method instead of setting this property.
The ClientId parameter specifies the index of the item in the array. The size of the array is controlled by the ClientCount property.
This property is not available at design time.
Data Type
Boolean
ClientBytesSent Property (SSHTunnel Class)
This property shows how many bytes were sent after the last assignment to DataToSend .
Syntax
ANSI (Cross Platform) int GetClientBytesSent(int iClientId); Unicode (Windows) INT GetClientBytesSent(INT iClientId);
int ipworksssh_sshtunnel_getclientbytessent(void* lpObj, int clientid);
int GetClientBytesSent(int iClientId);
Default Value
0
Remarks
This property shows how many bytes were sent after the last assignment to ClientDataToSend. Please check ClientDataToSend for more information.
Note: This property will always return 0 when the class is operating in the synchronous mode (i.e., the Timeout property is set to a positive value).
The ClientId parameter specifies the index of the item in the array. The size of the array is controlled by the ClientCount property.
This property is read-only and not available at design time.
Data Type
Integer
ClientConnected Property (SSHTunnel Class)
This property is used to disconnect individual connections or to show their status.
Syntax
ANSI (Cross Platform) int GetClientConnected(int iClientId);
int SetClientConnected(int iClientId, int bClientConnected); Unicode (Windows) BOOL GetClientConnected(INT iClientId);
INT SetClientConnected(INT iClientId, BOOL bClientConnected);
int ipworksssh_sshtunnel_getclientconnected(void* lpObj, int clientid);
int ipworksssh_sshtunnel_setclientconnected(void* lpObj, int clientid, int bClientConnected);
bool GetClientConnected(int iClientId);
int SetClientConnected(int iClientId, bool bClientConnected);
Default Value
FALSE
Remarks
This property is used to disconnect individual connections or to show their status.
The ClientConnected property may be set to false to close the connection.
ClientConnected also shows the status of a particular connection (connected/disconnected).
How and when the connection is closed is controlled by the Linger property. Please refer to its description for more information.
Note: It is recommended to use the Connect or Disconnect method instead of setting this property.
The ClientId parameter specifies the index of the item in the array. The size of the array is controlled by the ClientCount property.
This property is not available at design time.
Data Type
Boolean
ClientConnectionId Property (SSHTunnel Class)
This property contains an identifier generated by the class to identify each connection.
Syntax
ANSI (Cross Platform) char* GetClientConnectionId(int iClientId); Unicode (Windows) LPWSTR GetClientConnectionId(INT iClientId);
char* ipworksssh_sshtunnel_getclientconnectionid(void* lpObj, int clientid);
QString GetClientConnectionId(int iClientId);
Default Value
""
Remarks
This property contains an identifier generated by the class to identify each connection. This identifier is unique to this connection.
The ClientId parameter specifies the index of the item in the array. The size of the array is controlled by the ClientCount property.
This property is read-only and not available at design time.
Data Type
String
ClientDataToSend Property (SSHTunnel Class)
This property contains a string of data to be sent to the remote host.
Syntax
ANSI (Cross Platform) int SetClientDataToSend(int iClientId, const char* lpClientDataToSend, int lenClientDataToSend); Unicode (Windows) INT SetClientDataToSend(INT iClientId, LPCSTR lpClientDataToSend, INT lenClientDataToSend);
int ipworksssh_sshtunnel_setclientdatatosend(void* lpObj, int clientid, const char* lpClientDataToSend, int lenClientDataToSend);
int SetClientDataToSend(int iClientId, QByteArray qbaClientDataToSend);
Default Value
""
Remarks
This property contains a string of data to be sent to the remote host. It is a write-only property.
Assigning a string to the ClientDataToSend makes the class send the string to the remote host. The Send method provides similar functionality.
When ClientTimeout is set to 0, the class will behave asynchronously. If you are sending data to the remote host faster than it can process it, or faster than the network's bandwidth allows, the outgoing queue might fill up. When this happens, the operation fails with error 10035: "[10035] Operation would block" (WSAEWOULDBLOCK). You can check this error, and then try to send the data again. . The BytesSent property shows how many bytes were sent (if any). If 0 bytes were sent, then you can wait for the ReadyToSend event before attempting to send data again.
Note: The ReadyToSend event is not fired when part of the data is sent successfully.
Note: It is recommended to use the Send or SendBytes method instead of setting this property.
The ClientId parameter specifies the index of the item in the array. The size of the array is controlled by the ClientCount property.
This property is write-only and not available at design time.
Data Type
Binary String
ClientEOL Property (SSHTunnel Class)
The EOL property is used to define boundaries in the input stream using the value of the property.
Syntax
ANSI (Cross Platform) int GetClientEOL(int iClientId, char* &lpClientEOL, int &lenClientEOL);
int SetClientEOL(int iClientId, const char* lpClientEOL, int lenClientEOL); Unicode (Windows) INT GetClientEOL(INT iClientId, LPSTR &lpClientEOL, INT &lenClientEOL);
INT SetClientEOL(INT iClientId, LPCSTR lpClientEOL, INT lenClientEOL);
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);
QByteArray GetClientEOL(int iClientId);
int SetClientEOL(int iClientId, QByteArray qbaClientEOL);
Default Value
""
Remarks
The EOL property is used to define boundaries in the input stream using the value of the property.
The EOL property is especially useful with ASCII files. By setting it to CRLF ("\r\n") , the incoming ASCII text stream can be split into lines. In this case, one event is fired for each line received (as well as in packet boundaries). The CRLF ("\r\n") . bytes are discarded.
The EOL property is a binary string. This means that it can be more than one byte long, and it can contain NULL bytes.
When reading the value of the property, if ConnectionId does not belong to a valid connection, then NULL will be returned, and the LastError property will contain a corresponding error message. If no error is encountered, then LastError will contain NULL.
The ClientId parameter specifies the index of the item in the array. The size of the array is controlled by the ClientCount property.
This property is not available at design time.
Data Type
Binary String
ClientIdleTimeout Property (SSHTunnel Class)
This property contains the idle timeout for this connection.
Syntax
ANSI (Cross Platform) int GetClientIdleTimeout(int iClientId);
int SetClientIdleTimeout(int iClientId, int iClientIdleTimeout); Unicode (Windows) INT GetClientIdleTimeout(INT iClientId);
INT SetClientIdleTimeout(INT iClientId, INT iClientIdleTimeout);
int ipworksssh_sshtunnel_getclientidletimeout(void* lpObj, int clientid);
int ipworksssh_sshtunnel_setclientidletimeout(void* lpObj, int clientid, int iClientIdleTimeout);
int GetClientIdleTimeout(int iClientId);
int SetClientIdleTimeout(int iClientId, int iClientIdleTimeout);
Default Value
0
Remarks
This property contains the idle timeout for this connection. This property is similar to DefaultIdleTimeout but may be set on a per-connection basis to override DefaultIdleTimeout. This property specifies the idle timeout (in seconds) for the connected client. When set to a positive value, the class will disconnect idle clients after the specified timeout.
This applies only to clients that have not sent to received data within the specified number of seconds.
If set to 0 (default), no idle timeout is applied.
Note: DoEvents must be called for the class to check existing connections.
The ClientId parameter specifies the index of the item in the array. The size of the array is controlled by the ClientCount property.
This property is not available at design time.
Data Type
Integer
ClientLocalAddress Property (SSHTunnel Class)
This property shows the IP address of the interface through which the connection is passing.
Syntax
ANSI (Cross Platform) char* GetClientLocalAddress(int iClientId); Unicode (Windows) LPWSTR GetClientLocalAddress(INT iClientId);
char* ipworksssh_sshtunnel_getclientlocaladdress(void* lpObj, int clientid);
QString GetClientLocalAddress(int iClientId);
Default Value
""
Remarks
This property shows the IP address of the interface through which the connection is passing.
ClientLocalAddress is important for multihomed hosts so that it can be used to find the particular network interface through which an individual connection is going.
The ClientId parameter specifies the index of the item in the array. The size of the array is controlled by the ClientCount property.
This property is read-only and not available at design time.
Data Type
String
ClientReadyToSend Property (SSHTunnel Class)
This indicates whether the class is ready to send data.
Syntax
ANSI (Cross Platform) int GetClientReadyToSend(int iClientId); Unicode (Windows) BOOL GetClientReadyToSend(INT iClientId);
int ipworksssh_sshtunnel_getclientreadytosend(void* lpObj, int clientid);
bool GetClientReadyToSend(int iClientId);
Default Value
FALSE
Remarks
This indicates whether the class is ready to send data.
This property indicates that the underlying TCP/IP subsystem is ready to accept data. This is True after a client connects but will become False after a failed ClientDataToSend.
After a failed ClientDataToSend, the ReadyToSend event will fire and this property will be True when data can be sent again.
The ClientId parameter specifies the index of the item in the array. The size of the array is controlled by the ClientCount property.
This property is read-only and not available at design time.
Data Type
Boolean
ClientRecordLength Property (SSHTunnel Class)
If set to a positive value, this setting defines the length of the data records to be received.
Syntax
ANSI (Cross Platform) int GetClientRecordLength(int iClientId);
int SetClientRecordLength(int iClientId, int iClientRecordLength); Unicode (Windows) INT GetClientRecordLength(INT iClientId);
INT SetClientRecordLength(INT iClientId, INT iClientRecordLength);
int ipworksssh_sshtunnel_getclientrecordlength(void* lpObj, int clientid);
int ipworksssh_sshtunnel_setclientrecordlength(void* lpObj, int clientid, int iClientRecordLength);
int GetClientRecordLength(int iClientId);
int SetClientRecordLength(int iClientId, int iClientRecordLength);
Default Value
0
Remarks
If set to a positive value, this setting defines the length of the data records to be received. 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, including within the DataIn event.
A value of 0 (default) means this setting is not used.
Note: It is recommended to use the ChangeRecordLength method instead of setting this property.
The ClientId parameter specifies the index of the item in the array. The size of the array is controlled by the ClientCount property.
This property is not available at design time.
Data Type
Integer
ClientRemoteHost Property (SSHTunnel Class)
This property shows the IP address of the remote host through which the connection is coming.
Syntax
ANSI (Cross Platform) char* GetClientRemoteHost(int iClientId); Unicode (Windows) LPWSTR GetClientRemoteHost(INT iClientId);
char* ipworksssh_sshtunnel_getclientremotehost(void* lpObj, int clientid);
QString GetClientRemoteHost(int iClientId);
Default Value
""
Remarks
This property shows the IP address of the remote host through which the connection is coming.
The connection must be valid or an error will be fired.
If the class is configured to use a SOCKS firewall, the value assigned to this property may be preceded with an "*". If this is the case, the host name is passed to the firewall unresolved and the firewall performs the DNS resolution.
The ClientId parameter specifies the index of the item in the array. The size of the array is controlled by the ClientCount property.
This property is read-only and not available at design time.
Data Type
String
ClientRemotePort Property (SSHTunnel Class)
This property shows the Transmission Control Protocol (TCP) port on the remote host through which the connection is coming.
Syntax
ANSI (Cross Platform) int GetClientRemotePort(int iClientId); Unicode (Windows) INT GetClientRemotePort(INT iClientId);
int ipworksssh_sshtunnel_getclientremoteport(void* lpObj, int clientid);
int GetClientRemotePort(int iClientId);
Default Value
0
Remarks
This property shows the Transmission Control Protocol (TCP) port on the remote host through which the connection is coming.
The connection must be valid or an error will be fired.
The ClientId parameter specifies the index of the item in the array. The size of the array is controlled by the ClientCount property.
This property is read-only and not available at design time.
Data Type
Integer
ClientSingleLineMode Property (SSHTunnel Class)
This property shows the special mode for line-oriented protocols.
Syntax
ANSI (Cross Platform) int GetClientSingleLineMode(int iClientId);
int SetClientSingleLineMode(int iClientId, int bClientSingleLineMode); Unicode (Windows) BOOL GetClientSingleLineMode(INT iClientId);
INT SetClientSingleLineMode(INT iClientId, BOOL bClientSingleLineMode);
int ipworksssh_sshtunnel_getclientsinglelinemode(void* lpObj, int clientid);
int ipworksssh_sshtunnel_setclientsinglelinemode(void* lpObj, int clientid, int bClientSingleLineMode);
bool GetClientSingleLineMode(int iClientId);
int SetClientSingleLineMode(int iClientId, bool bClientSingleLineMode);
Default Value
FALSE
Remarks
This property shows the special mode for line-oriented protocols. When SingleLineMode is True, the class treats the incoming data stream as lines separated by carriage return (CR), line feed (LF), or CRLF. The EOL property is ignored.
The ClientId parameter specifies the index of the item in the array. The size of the array is controlled by the ClientCount property.
This property is not available at design time.
Data Type
Boolean
ClientTimeout Property (SSHTunnel Class)
This property specifies a timeout for the class.
Syntax
ANSI (Cross Platform) int GetClientTimeout(int iClientId);
int SetClientTimeout(int iClientId, int iClientTimeout); Unicode (Windows) INT GetClientTimeout(INT iClientId);
INT SetClientTimeout(INT iClientId, INT iClientTimeout);
int ipworksssh_sshtunnel_getclienttimeout(void* lpObj, int clientid);
int ipworksssh_sshtunnel_setclienttimeout(void* lpObj, int clientid, int iClientTimeout);
int GetClientTimeout(int iClientId);
int SetClientTimeout(int iClientId, int iClientTimeout);
Default Value
0
Remarks
This property specifies a timeout for the class.
If the ClientTimeout property is set to 0, all operations return immediately, potentially failing with a WOULDBLOCK error if data cannot be sent immediately.
If ClientTimeout is set to a positive value, data is sent in a blocking manner and the class will wait for the operation to complete before returning control. The class will handle any potential WOULDBLOCK errors internally and automatically retry the operation for a maximum of ClientTimeout seconds.
The class will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.
If Timeout expires, and the operation is not yet complete, the class fails with an error.
Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.
The default value for the ClientTimeout property is 0 (asynchronous operation).
The ClientId parameter specifies the index of the item in the array. The size of the array is controlled by the ClientCount property.
This property is not available at design time.
Data Type
Integer
ClientUserData Property (SSHTunnel Class)
The UserData property holds connection-specific user-specified data.
Syntax
ANSI (Cross Platform) int GetClientUserData(int iClientId, char* &lpClientUserData, int &lenClientUserData);
int SetClientUserData(int iClientId, const char* lpClientUserData, int lenClientUserData); Unicode (Windows) INT GetClientUserData(INT iClientId, LPSTR &lpClientUserData, INT &lenClientUserData);
INT SetClientUserData(INT iClientId, LPCSTR lpClientUserData, INT lenClientUserData);
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);
QByteArray GetClientUserData(int iClientId);
int SetClientUserData(int iClientId, QByteArray qbaClientUserData);
Default Value
""
Remarks
The ClientUserData property holds connection-specific user-specified data.
User-specified data may be set or retrieved at any point while the connection is valid. This provides a simple way to associate arbitrary data with a specific connection.
The ClientId parameter specifies the index of the item in the array. The size of the array is controlled by the ClientCount property.
This property is not available at design time.
Data Type
Binary String
DefaultEOL Property (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
FirewallAutoDetect Property (SSHTunnel Class)
This property tells the class whether or not to automatically detect and use firewall system settings, if available.
Syntax
ANSI (Cross Platform) int GetFirewallAutoDetect();
int SetFirewallAutoDetect(int bFirewallAutoDetect); Unicode (Windows) BOOL GetFirewallAutoDetect();
INT SetFirewallAutoDetect(BOOL bFirewallAutoDetect);
int ipworksssh_sshtunnel_getfirewallautodetect(void* lpObj);
int ipworksssh_sshtunnel_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);
bool GetFirewallAutoDetect();
int SetFirewallAutoDetect(bool bFirewallAutoDetect);
Default Value
FALSE
Remarks
This property tells the class whether or not to automatically detect and use firewall system settings, if available.
Data Type
Boolean
FirewallType Property (SSHTunnel Class)
This property determines the type of firewall to connect through.
Syntax
ANSI (Cross Platform) int GetFirewallType();
int SetFirewallType(int iFirewallType); Unicode (Windows) INT GetFirewallType();
INT SetFirewallType(INT iFirewallType);
Possible Values
FW_NONE(0),
FW_TUNNEL(1),
FW_SOCKS4(2),
FW_SOCKS5(3),
FW_SOCKS4A(10)
int ipworksssh_sshtunnel_getfirewalltype(void* lpObj);
int ipworksssh_sshtunnel_setfirewalltype(void* lpObj, int iFirewallType);
int GetFirewallType();
int SetFirewallType(int iFirewallType);
Default Value
0
Remarks
This property determines the type of firewall to connect through. The applicable values are as follows:
fwNone (0) | No firewall (default setting). |
fwTunnel (1) | Connect through a tunneling proxy. FirewallPort is set to 80. |
fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. FirewallPort is set to 1080. |
fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. FirewallPort is set to 1080. |
fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. FirewallPort is set to 1080. |
Data Type
Integer
FirewallHost Property (SSHTunnel Class)
This property contains the name or IP address of firewall (optional).
Syntax
ANSI (Cross Platform) char* GetFirewallHost();
int SetFirewallHost(const char* lpszFirewallHost); Unicode (Windows) LPWSTR GetFirewallHost();
INT SetFirewallHost(LPCWSTR lpszFirewallHost);
char* ipworksssh_sshtunnel_getfirewallhost(void* lpObj);
int ipworksssh_sshtunnel_setfirewallhost(void* lpObj, const char* lpszFirewallHost);
QString GetFirewallHost();
int SetFirewallHost(QString qsFirewallHost);
Default Value
""
Remarks
This property contains the name or IP address of firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.
If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error.
Data Type
String
FirewallPassword Property (SSHTunnel Class)
This property contains a password if authentication is to be used when connecting through the firewall.
Syntax
ANSI (Cross Platform) char* GetFirewallPassword();
int SetFirewallPassword(const char* lpszFirewallPassword); Unicode (Windows) LPWSTR GetFirewallPassword();
INT SetFirewallPassword(LPCWSTR lpszFirewallPassword);
char* ipworksssh_sshtunnel_getfirewallpassword(void* lpObj);
int ipworksssh_sshtunnel_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);
QString GetFirewallPassword();
int SetFirewallPassword(QString qsFirewallPassword);
Default Value
""
Remarks
This property contains a password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.
Data Type
String
FirewallPort Property (SSHTunnel Class)
This property contains the transmission control protocol (TCP) port for the firewall Host .
Syntax
ANSI (Cross Platform) int GetFirewallPort();
int SetFirewallPort(int iFirewallPort); Unicode (Windows) INT GetFirewallPort();
INT SetFirewallPort(INT iFirewallPort);
int ipworksssh_sshtunnel_getfirewallport(void* lpObj);
int ipworksssh_sshtunnel_setfirewallport(void* lpObj, int iFirewallPort);
int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);
Default Value
0
Remarks
This property contains the transmission control protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.
Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.
Data Type
Integer
FirewallUser Property (SSHTunnel Class)
This property contains a user name if authentication is to be used connecting through a firewall.
Syntax
ANSI (Cross Platform) char* GetFirewallUser();
int SetFirewallUser(const char* lpszFirewallUser); Unicode (Windows) LPWSTR GetFirewallUser();
INT SetFirewallUser(LPCWSTR lpszFirewallUser);
char* ipworksssh_sshtunnel_getfirewalluser(void* lpObj);
int ipworksssh_sshtunnel_setfirewalluser(void* lpObj, const char* lpszFirewallUser);
QString GetFirewallUser();
int SetFirewallUser(QString qsFirewallUser);
Default Value
""
Remarks
This property contains a user name if authentication is to be used connecting through a firewall. If the FirewallHost is specified, this property and FirewallPassword properties are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.
Data Type
String
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)
If set to True, the class accepts incoming connections on LocalPort.
Syntax
ANSI (Cross Platform) int GetListening();
int SetListening(int bListening); Unicode (Windows) BOOL GetListening();
INT SetListening(BOOL bListening);
int ipworksssh_sshtunnel_getlistening(void* lpObj);
int ipworksssh_sshtunnel_setlistening(void* lpObj, int bListening);
bool GetListening();
int SetListening(bool bListening);
Default Value
FALSE
Remarks
This property indicates whether the class is listening for connections on the port specified by the LocalPort property.
Note: Use the StartListening and StopListening methods to control whether the class is listening.
This property is 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
The LocalHost property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.
In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.
If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).
NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window.
Data Type
String
LocalPort Property (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 in the client side.
Data Type
Integer
SSHAcceptServerHostKeyEncoded Property (SSHTunnel Class)
This is the certificate (PEM/base64 encoded).
Syntax
ANSI (Cross Platform) int GetSSHAcceptServerHostKeyEncoded(char* &lpSSHAcceptServerHostKeyEncoded, int &lenSSHAcceptServerHostKeyEncoded);
int SetSSHAcceptServerHostKeyEncoded(const char* lpSSHAcceptServerHostKeyEncoded, int lenSSHAcceptServerHostKeyEncoded); Unicode (Windows) INT GetSSHAcceptServerHostKeyEncoded(LPSTR &lpSSHAcceptServerHostKeyEncoded, INT &lenSSHAcceptServerHostKeyEncoded);
INT SetSSHAcceptServerHostKeyEncoded(LPCSTR lpSSHAcceptServerHostKeyEncoded, INT lenSSHAcceptServerHostKeyEncoded);
int ipworksssh_sshtunnel_getsshacceptserverhostkeyencoded(void* lpObj, char** lpSSHAcceptServerHostKeyEncoded, int* lenSSHAcceptServerHostKeyEncoded);
int ipworksssh_sshtunnel_setsshacceptserverhostkeyencoded(void* lpObj, const char* lpSSHAcceptServerHostKeyEncoded, int lenSSHAcceptServerHostKeyEncoded);
QByteArray GetSSHAcceptServerHostKeyEncoded();
int SetSSHAcceptServerHostKeyEncoded(QByteArray qbaSSHAcceptServerHostKeyEncoded);
Default Value
""
Remarks
This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSHAcceptServerHostKeyStore and SSHAcceptServerHostKeySubject properties also may be used to specify a certificate.
When SSHAcceptServerHostKeyEncoded is set, a search is initiated in the current SSHAcceptServerHostKeyStore for the private key of the certificate. If the key is found, SSHAcceptServerHostKeySubject is updated to reflect the full subject of the selected certificate; otherwise, SSHAcceptServerHostKeySubject is set to an empty string.
This property is not available at design time.
Data Type
Binary String
SSHAuthMode Property (SSHTunnel Class)
The authentication method to be used 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_CUSTOM(6)
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 SSH Authentication specification (RFC 4252) specifies multiple methods by which a user can be authenticated by an SSH server. When a call is made to SSHLogon, the class will connect to the SSH server and establish the security layer. After the connection has been secured, the client will send an authentication request to the SSHHost containing the SSHUser. The server will respond containing a list of methods by which that user may be authenticated.
The class will attempt to authenticate the user by one of those methods based on the value of SSHAuthMode and other property values supplied by the user. Currently, the class supports the following authentication methods:
amNone (0) | No authentication will be performed. The current SSHUser value is ignored, and the connection will be logged in as anonymous. |
amMultiFactor (1) | This allows the class to attempt a multi-step authentication process. The class will send authentication data to the server based on the list of methods allowed for the current user and the authentication property values supplied. The class will continue to send authentication data until the server acknowledges authentication success. If the server rejects an authentication step, the class fails with an error. |
amPassword (2) | The class will use the values of SSHUser and SSHPassword to authenticate the user. |
amPublicKey (3) | The class will use the values of SSHUser and the SSHCert* properties to authenticate the user. the SSHCert* properties must have a private key available for this authentication method to succeed. |
amKeyboardInteractive (4) | At the time of authentication, the class will fire the SSHKeyboardInteractive event containing instructions on how to complete the authentication step. (NOTE: amKeyboardInteractive is not supported in SSHTunnel). |
amGSSAPIWithMic (5) | This allows the class to attempt Kerberos authentication using the GSSAPI-WITH-MIC scheme. The client will try Kerberos authentication using the value of SSHUser (single sign-on), or if SSHPassword is specified as well, it will try Kerberos authentication with alternate credentials. This is currently supported only in the .NET client. |
amCustom (6) | This allows the class caller to take over the authentication process completely. When amCustom is set, the class will fire the SSHCustomAuth event as necessary to complete the authentication process. |
Example (User/Password Auth):
Control.SSHAuthMode = SftpSSHAuthModes.amPassword
Control.SSHUser = "username"
Control.SSHPassword = "password"
Control.SSHLogon("server", 22)
Example (Public Key Auth):
Control.SSHAuthMode = SftpSSHAuthModes.amPublicKey
Control.SSHUser = "username"
Control.SSHCertStoreType = SSHCertStoreTypes.cstPFXFile;
Control.SSHCertStore = "cert.pfx";
Control.SSHCertStorePassword = "certpassword";
Control.SSHCertSubject = "*";
Control.SSHLogon("server", 22)
Data Type
Integer
SSHCertEncoded Property (SSHTunnel Class)
This is the certificate (PEM/base64 encoded).
Syntax
ANSI (Cross Platform) int GetSSHCertEncoded(char* &lpSSHCertEncoded, int &lenSSHCertEncoded);
int SetSSHCertEncoded(const char* lpSSHCertEncoded, int lenSSHCertEncoded); Unicode (Windows) INT GetSSHCertEncoded(LPSTR &lpSSHCertEncoded, INT &lenSSHCertEncoded);
INT SetSSHCertEncoded(LPCSTR lpSSHCertEncoded, INT lenSSHCertEncoded);
int ipworksssh_sshtunnel_getsshcertencoded(void* lpObj, char** lpSSHCertEncoded, int* lenSSHCertEncoded);
int ipworksssh_sshtunnel_setsshcertencoded(void* lpObj, const char* lpSSHCertEncoded, int lenSSHCertEncoded);
QByteArray GetSSHCertEncoded();
int SetSSHCertEncoded(QByteArray qbaSSHCertEncoded);
Default Value
""
Remarks
This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSHCertStore and SSHCertSubject properties also may be used to specify a certificate.
When SSHCertEncoded is set, a search is initiated in the current SSHCertStore for the private key of the certificate. If the key is found, SSHCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSHCertSubject is set to an empty string.
This property is not available at design time.
Data Type
Binary String
SSHCertStore Property (SSHTunnel Class)
This is the name of the certificate store for the client certificate.
Syntax
ANSI (Cross Platform) int GetSSHCertStore(char* &lpSSHCertStore, int &lenSSHCertStore);
int SetSSHCertStore(const char* lpSSHCertStore, int lenSSHCertStore); Unicode (Windows) INT GetSSHCertStore(LPSTR &lpSSHCertStore, INT &lenSSHCertStore);
INT SetSSHCertStore(LPCSTR lpSSHCertStore, INT lenSSHCertStore);
int ipworksssh_sshtunnel_getsshcertstore(void* lpObj, char** lpSSHCertStore, int* lenSSHCertStore);
int ipworksssh_sshtunnel_setsshcertstore(void* lpObj, const char* lpSSHCertStore, int lenSSHCertStore);
QByteArray GetSSHCertStore();
int SetSSHCertStore(QByteArray qbaSSHCertStore);
Default Value
"MY"
Remarks
This is the name of the certificate store for the client certificate.
The SSHCertStoreType property denotes the type of the certificate store specified by SSHCertStore. If the store is password protected, specify the password in SSHCertStorePassword.
SSHCertStore is used in conjunction with the SSHCertSubject property to specify client certificates. If SSHCertStore has a value, and SSHCertSubject or SSHCertEncoded is set, a search for a certificate is initiated. Please see the SSHCertSubject property for details.
Designations of certificate stores are platform-dependent.
The following are designations of the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).
Data Type
Binary String
SSHCertStorePassword Property (SSHTunnel Class)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
ANSI (Cross Platform) char* GetSSHCertStorePassword();
int SetSSHCertStorePassword(const char* lpszSSHCertStorePassword); Unicode (Windows) LPWSTR GetSSHCertStorePassword();
INT SetSSHCertStorePassword(LPCWSTR lpszSSHCertStorePassword);
char* ipworksssh_sshtunnel_getsshcertstorepassword(void* lpObj);
int ipworksssh_sshtunnel_setsshcertstorepassword(void* lpObj, const char* lpszSSHCertStorePassword);
QString GetSSHCertStorePassword();
int SetSSHCertStorePassword(QString qsSSHCertStorePassword);
Default Value
""
Remarks
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Data Type
String
SSHCertStoreType Property (SSHTunnel Class)
This is the type of certificate store for this certificate.
Syntax
ANSI (Cross Platform) int GetSSHCertStoreType();
int SetSSHCertStoreType(int iSSHCertStoreType); Unicode (Windows) INT GetSSHCertStoreType();
INT SetSSHCertStoreType(INT iSSHCertStoreType);
Possible Values
CST_USER(0),
CST_MACHINE(1),
CST_PFXFILE(2),
CST_PFXBLOB(3),
CST_JKSFILE(4),
CST_JKSBLOB(5),
CST_PEMKEY_FILE(6),
CST_PEMKEY_BLOB(7),
CST_PUBLIC_KEY_FILE(8),
CST_PUBLIC_KEY_BLOB(9),
CST_SSHPUBLIC_KEY_BLOB(10),
CST_P7BFILE(11),
CST_P7BBLOB(12),
CST_SSHPUBLIC_KEY_FILE(13),
CST_PPKFILE(14),
CST_PPKBLOB(15),
CST_XMLFILE(16),
CST_XMLBLOB(17),
CST_JWKFILE(18),
CST_JWKBLOB(19),
CST_SECURITY_KEY(20),
CST_BCFKSFILE(21),
CST_BCFKSBLOB(22),
CST_PKCS11(23),
CST_AUTO(99)
int ipworksssh_sshtunnel_getsshcertstoretype(void* lpObj);
int ipworksssh_sshtunnel_setsshcertstoretype(void* lpObj, int iSSHCertStoreType);
int GetSSHCertStoreType();
int SetSSHCertStoreType(int iSSHCertStoreType);
Default Value
0
Remarks
This is the type of certificate store for this certificate.
The class supports both public and private keys in a variety of formats. When the cstAuto value is used the class will automatically determine the type. This property can take one of the following values:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: this store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: this store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: this store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
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 PKCS11 interface.
To use a security key the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS11 dll. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the SSHCertStore and set SSHCertStorePassword to the PIN. Code Example: SSH Authentication with Security Key
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
Data Type
Integer
SSHCertSubject Property (SSHTunnel Class)
This is the subject of the certificate used for client authentication.
Syntax
ANSI (Cross Platform) char* GetSSHCertSubject();
int SetSSHCertSubject(const char* lpszSSHCertSubject); Unicode (Windows) LPWSTR GetSSHCertSubject();
INT SetSSHCertSubject(LPCWSTR lpszSSHCertSubject);
char* ipworksssh_sshtunnel_getsshcertsubject(void* lpObj);
int ipworksssh_sshtunnel_setsshcertsubject(void* lpObj, const char* lpszSSHCertSubject);
QString GetSSHCertSubject();
int SetSSHCertSubject(QString qsSSHCertSubject);
Default Value
""
Remarks
This is the subject of the certificate used for client authentication.
This property must be set after all other certificate properites are set. When this property is set, a search is performed in the current certificate store certificate with matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are displayed below.
Field | Meaning |
CN | Common Name. This is commonly a host name like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma it must be quoted.
Data Type
String
SSHCompressionAlgorithms Property (SSHTunnel Class)
A 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 SSH handshake, this list will be used to negotiate the compression algorithm to be used between the client and server. This list is used for both directions: client to server and server to client. When negotiating algorithms, each side sends a list of all algorithms it supports or allows. The algorithm chosen for each direction is the first algorithm to appear in the sender's list that the receiver supports, so it is important to list multiple algorithms in preferential order. If no algorithm can be agreed upon, the class will raise an error and the connection will be aborted.
At least one supported algorithm must appear in this list. The following compression algorithms are supported by the class:
- zlib
- zlib@openssh.com
- none
Data Type
String
SSHEncryptionAlgorithms Property (SSHTunnel Class)
A 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,aes256-cbc,aes192-cbc,aes128-cbc,3des-ctr,3des-cbc,blowfish-cbc,arcfour256,arcfour128,arcfour,cast128-cbc,aes256-gcm@openssh.com,aes128-gcm@openssh.com,chacha20-poly1305@openssh.com"
Remarks
During the SSH handshake, this list will be used to negotiate the encryption algorithm to be used between the client and server. This list is used for both directions: client to server and server to client. When negotiating algorithms, each side sends a list of all algorithms it supports or allows. The algorithm chosen for each direction is the first algorithm to appear in the sender's list that the receiver supports, so it is important to list multiple algorithms in preferential order. If no algorithm can be agreed upon, the class will raise an error and the connection will be aborted.
At least one supported algorithm must appear in this list. The following encryption algorithms are supported by the class:
aes256-ctr | 256-bit AES encryption in CTR mode |
aes256-cbc | 256-bit AES encryption in CBC mode |
aes192-ctr | 192-bit AES encryption in CTR mode |
aes192-cbc | 192-bit AES encryption in CBC mode |
aes128-ctr | 128-bit AES encryption in CTR mode |
aes128-cbc | 128-bit AES encryption in CBC mode |
3des-ctr | 192-bit (3-key) triple DES encryption in CTR mode |
3des-cbc | 192-bit (3-key) triple DES encryption in CBC mode |
cast128-cbc | CAST-128 encryption |
blowfish-cbc | Blowfish encryption |
arcfour | ARC4 encryption |
arcfour128 | 128-bit ARC4 encryption |
arcfour256 | 256-bit ARC4 encryption |
aes256-gcm@openssh.com | 256-bit AES encryption in GCM mode. |
aes128-gcm@openssh.com | 128-bit AES encryption in GCM mode. |
chacha20-poly1305@openssh.com | ChaCha20 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, and 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 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 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 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 which is used to authenticate the client to the SSH server.
Data Type
String
SSHPort Property (SSHTunnel Class)
The port on the 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 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 which is used to authenticate the client to the SSH server. This property is required.
Example (User/Password Auth):
Control.SSHAuthMode = SftpSSHAuthModes.amPassword
Control.SSHUser = "username"
Control.SSHPassword = "password"
Control.SSHLogon("server", 22)
Example (Public Key Auth):
Control.SSHAuthMode = SftpSSHAuthModes.amPublicKey
Control.SSHUser = "username"
Control.SSHCertStoreType = SSHCertStoreTypes.cstPFXFile;
Control.SSHCertStore = "cert.pfx";
Control.SSHCertStorePassword = "certpassword";
Control.SSHCertSubject = "*";
Control.SSHLogon("server", 22)
Data Type
String
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 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 SSHLogon method which will both establish a connection and log in to the server.
This method may be useful in cases where it is desirable to separate the connection and logon operations, for instance confirming a host is available by first creating the connection.
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 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 only applicable for reading and creating 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 from the server without first logging off.
Syntax
ANSI (Cross Platform) int Disconnect(); Unicode (Windows) INT Disconnect();
int ipworksssh_sshtunnel_disconnect(void* lpObj);
int Disconnect();
Remarks
Calling this method will disconnect the client specified by the ConnectionId parameter.
This method immediately disconnects from the server without first logging off.
In most cases the SSHLogoff method should be used to logoff and disconnect from the server. Call the Disconnect method in cases where it is desirable to immediately disconnect without first logging off.
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)
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 an 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 only applicable for reading and creating 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)
Used to read a field from an 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 request. |
WantsReply (boolean) | Whether or not the client wants a reply to the request. |
The remaining fields that are available in the payload are dependent upon the value of RequestType.
pty-req
Pty-req is a request to open a pseudo terminal on the specified channel. The following fields are available:
TerminalType (string) | The type of terminal being requested (eg: "vt100"). |
TerminalWidthCharacters (int32) | The width, in characters, of the terminal to be opened. |
TerminalHeightRows (int32) | The height, in rows, of the terminal to be opened. |
TerminalWidthPixels (int32) | The width, in pixels, of the terminal to be opened. |
TerminalHeightPixels (int32) | The height, in pixels, of the terminal to be opened. |
TerminalModes (string) | A list of op-val (int32-byte) encoded modes to be used by the terminal. |
x11-req
X11-req is a request to forward x11 sessions over a channel. The following fields are available:
SingleConnection (boolean) | Disallows more than one connection to be forwarded by the channel. |
X11AuthProtocol (string) | The authentication protocol to be used (eg: "MIT-MAGIC-COOKIE-1"). |
X11AuthCookie (string) | A hexadecimal-encoded cookie to be used for authentication. |
X11ScreenNumber (int32) | The x11 screen number to be used. |
env
Env is a request to set an environment variable to be passed into a shell that may be started later. The following fields are available:
VariableName (string) | The name of the variable to be set. |
VariableValue (string) | The value of the variable to be set. |
exec
Exec is a request to execute a command on the channel using the authenticated user's shell. The following field is available:
Command (string) | The command to be executed. |
subsystem
Subsystem is a request to start a subsystem on the specified channel. The following field is available:
Subsystem (string) | The name of the subsystem to be started (eg: "sftp"). |
xon-xoff
Instructs the server to allow or disallow control-S/control-Q style flow control. The following field is available:
ClientCanDo (boolean) | Whether or not the server should enable flow control. |
signal
Sends a signal to the remote process/service. The following field is available:
SignalName (string) | The name of the signal to be sent. |
If the packet type is not well known, Field should start with the special character "%" and contain a comma-separated list of field types as defined in SetSSHParam. For example, reading out the X11AuthProtocol of an x11-req payload, you can use "%s,f".
Note: the return value is a string encoded the same way as the FieldValue param in SetSSHParam.
Note: This method is only applicable for reading and creating 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)
Used to read a field from an 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 returns raw bytes instead of strings.
Note: This method is only applicable for reading and creating 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)
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)
Used to write 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 an SSH packet to be sent later by a call to SendSSHPacket. Payload should contain the result of a previous call to SetSSHParam. FieldType is a string defining the type of field to be written to the packet. FieldValue should be the string representation of the field to be written.
The following is a list of supported field types and a description of how FieldValue should be encoded:
s | A plaintext string containing the default system encoding of the data. |
sb | A string containing the hex encoded data. (eg: "A1B23C") |
m | A variable-length large integer, encoded as a textual representation of the value ("1234"). |
i | A 32-bit integer, encoded as a textual representation of the value (eg: "1234"). |
l | A 64-bit integer, encoded as a textual representation of the value (eg: "1234"). |
b | A single byte, encoded as a textual representation of the value (eg: "123"). |
f | A boolean flag, encoded as a textual representation of the value (eg: 'true' or 'false') |
Note: integer values may be encoded in hexadecimal by prefixing "0x" to the beginning of the string, otherwise the value is assumed to be base-10.
Note: This method is only applicable for reading and creating 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 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 SSH server for any reason the ConnectionId parameter will be -1.
Error Event (SSHTunnel Class)
Information about errors 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)
Fires 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
This event fires once for each log messages generated by the class. The verbosity is controlled by the LogLevel setting.
LogLevel indicates the detail level of the message. Possible values are:
0 (None) | No messages are logged. |
1 (Info - Default) | Informational events such as SSH handshake messages are logged. |
2 (Verbose) | Detailed data such as individual packet information is logged. |
3 (Debug) | Debug data including all relevant sent and received bytes are logged. |
Message is the log message.
LogType is reserved for future use.
ReconnectAttempt Event (SSHTunnel Class)
Fires 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 re-establishing a SSH tunnel.
Only applicable 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:
|
RemoteListeningPort | The port on the SSH host which the reverse tunnel will use. This is only applicable 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 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 SSH logon process if SSHAuthMode is set to amCustom. Packet contains the raw last SSH packet sent by the server, in HEX-encoded format.
The client should create a new raw SSH packet to send to the server and set Packet to the HEX-encoded representation of the packet to send.
In all cases, Packet will start with the message type field.
To read the incoming packet call DecodePacket and then use the GetSSHParam and GetSSHParamBytes methods. To create a packet use the SetSSHParam method and then call EncodePacket to obtain a HEX-encoded value and assign this to the Packet parameter.
SSHKeyboardInteractive Event (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 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 where the client can decide whether to continue with the connection process or not. If the public key is known to be a valid key for the SSH server, Accept should be set to True within the event. Otherwise, the server will not be authenticated and the connection will be broken.
Accept will be True only if either HostKey or Fingerprint is identical to the value of SSHAcceptServerHostKey.
Accept may be set to True manually to accept the server host key.
Note that SSH's security inherently relies on client verification of the host key. Ignoring the host key and always setting Accept to true is strongly discouraged, and could cause potentially serious security vulnerabilities in your application. It is recommended that clients maintain a list of known keys for each server and check HostKey against this list each time a connection is attempted.
Host Key contains the full binary text of the key, in the same format used internally by SSH.
Fingerprint holds the SHA-256 hash of HostKey in the hex-encoded form: 0a:1b:2c:3d. To configure the hash algorithm used to calculate this value see SSHFingerprintHashAlgorithm.
KeyAlgorithm identifies the host key algorithm. Supported values are:
- ssh-rsa
- ssh-dss
- rsa-sha2-256
- rsa-sha2-512
- x509v3-sign-rsa
- x509v3-sign-dss
- ecdsa-sha2-nistp256
- ecdsa-sha2-nistp384
- ecdsa-sha2-nistp521
CertSubject is the subject of the certificate. This is only applicable when KeyAlgorithm is "x509v3-sign-rsa" or "x509v3-sign-dss".
CertIssuer is the issuer of the certificate. This is only applicable when KeyAlgorithm is "x509v3-sign-rsa" or "x509v3-sign-dss".
Status is reserved for future use.
SSHStatus Event (SSHTunnel Class)
Shows 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.
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 setting controls automatic recovery of the SSH connection. If logon is disrupted or the channel is closed the component can be configured to attempt reconnection automatically. Possible values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MaxRetryCount: The maximum number of retries when reconnecting.This setting defines the maximum number of connection attempts performed when re-establishing a broken connection. This setting only applies when AutoReconnect is enabled. By default, the component will reconnect forever. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
RetryInterval: The interval in seconds between reconnect attempts.This setting specifies the number of seconds between reconnection attempts. This setting only applies 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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSHClient Config Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ClientSSHVersionString: The SSH version string used by the class.This configuration setting specifies the SSH version string used by the class. The default value is "SSH-2.0-IPWorks SSH Client 2022". | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
EnablePageantAuth:
Whether to use a key stored in Pageant to perform client authentication.This setting controls whether Pageant authentication is disabled, enabled, or required. When enabled or required, the class attempts to communicate with PuTTY's ssh-agent, called "Pageant", over shared memory to perform public key authentication. Possible values and the corresponding behavior is described below:
Example enabling Pageant:
Note: This functionality is only available on Windows. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
KerberosDelegation: If true, asks for credentials with delegation enabled during authentication.The default value is "True". If set to "False", the client will not ask for credentials delegation support during authentication. Note that even if the client asks for delegation, the server/KDC might not grant it and authentication will still succeed. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
KerberosRealm: The fully qualified domain name of the Kerberos Realm to use for GSSAPI authentication.This property may be set to the fully qualified (DNS) name of the kerberos realm (or Windows Active Directory domain name) to use during GSSAPI authentication. This can be used to force authentication with a given realm if the client and server machines are not part of the same domain. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
KerberosSPN: The Kerberos Service Principal Name of the SSH host.This property can be set to specify the Service Principal Name (SPN) associated with the SSH service on the remote host. This will usually be in the form "host/fqdn.of.sshhost[@REALM]". If not specified, the class will assume the SPN is based on the value of the SSHHost property and the kerberos realm used for authentication. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
KeyRenegotiationThreshold:
Sets the threshold for the SSH Key Renegotiation.This property allows you to specify the threshold, in the number of bytes, for the SSH Key Renegotiation.
The default value for this property is set to 1 GB.
Example (for setting the threshold to 500 MB):
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LogLevel:
Specifies the level of detail that is logged.This setting controls the level of detail that is logged through the Log event. Possible values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MaxPacketSize: The maximum packet size of the channel, in bytes.This setting specifies the maximum size of an individual data packet, in bytes, that can be sent to the sender. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MaxWindowSize: The maximum window size allowed for the channel, in bytes.This setting specifies how many bytes of channel data can be sent to the sender of this message without adjusting the window. Note that this value may be changed during the connection, but the window size can only be increased, not decreased. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PasswordPrompt:
The text of the password prompt used in keyboard-interactive authentication.This setting optionally specifies a pattern to be matched to the prompt received from the server
during keyboard-interactive authentication. If a matching prompt is detected the class
automatically responds to the prompt with the password specified by SSHPassword.
This provides an easy way to automatically reply to prompts with the password if one is presented by the server. The password will be auto-filled in the Response parameter of the SSHKeyboardInteractive event in the case of a match. The following special characters are supported for pattern matching:
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:
For example, to match the value [Something].txt, specify the pattern [[]Something].txt. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PreferredDHGroupBits: The size (in bits) of the preferred modulus (p) to request from the server.This may be when using the diffie-hellman-group-exchange-sha1 or diffie-hellman-group-exchange-sha256 key exchange algorithms to control the preferred size, in bits, of the modulus (p) prime number to request from the server. Acceptable values are between 1024 and 8192. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
RecordLength:
The length of received data records.If set to a positive value, this setting defines the length of data records to be received. The class will accumulate data
until RecordLength is reached and only then fire the DataIn event with data of length RecordLength.
This allows data to be received as records of known length. This value can be changed at any time, including within the DataIn event.
The default value is 0, meaning this setting is not used. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ServerSSHVersionString: The remote host's SSH version string.This will return the remote host's SSH version string, which can help when identifying problematic servers. This configuration setting is read-only. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SignedSSHCert:
The CA signed client public key used when authenticating.When authenticating via public key authentication this setting may be set to the CA signed client's public key.
This is useful when the server has been configured to trust client keys signed by a particular CA. For instance:
component.Config("SignedSSHCert=ssh-rsa-cert-v01@openssh.com AAAAB3NzaC1yc2EAAAADAQABAAAB...");
The algorithm such as ssh-rsa-cert-v01@openssh.com in the above string is used as part of the authentication process. To use a different algorithm simply change this value. For instance all of the following are acceptable with the same signed public key:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSHAcceptAnyServerHostKey: If set the class will accept any key presented by the server.The default value is "False". Set this to "True" to accept any key presented by the server. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSHAcceptServerCAKey:
The CA public key that signed the server's host key.If the server's host key was signed by a CA, this setting may be used to specify the CA's public key. If specified
the class will trust any server's host key that was signed by the CA. For instance:
component.Config("SSHAcceptServerCAKey=ssh-rsa AAAAB3NzaC1yc2EAAAADAQAB...");
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSHAcceptServerHostKeyFingerPrint:
The fingerprint of the server key to accept.This may be set to a comma-delimited collection of 16-byte MD5 fingerprints that should be accepted as the host's key. You may supply it by HEX
encoding the values in the form "0a:1b:2c:3d". Example:
SSHClient.Config("SSHAcceptServerHostKeyFingerprint=0a:1b:2c:3d");
If the server's fingerprint matches one of the values supplied, the class will accept the host key.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSHFingerprintHashAlgorithm:
The algorithm used to calculate the fingerprint.This configuration setting controls which hash algorithm is used to calculate the hostkey's fingerprint, displayed when SSHServerAuthentication fires.
Valid values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSHFingerprintMD5: The server hostkey's MD5 fingerprint.This setting may be queried in SSHServerAuthentication to get the server hostkey's MD5 fingerprint. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSHFingerprintSHA1: The server hostkey's SHA1 fingerprint.This setting may be queried in SSHServerAuthentication to get the server hostkey's SHA1 fingerprint. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSHFingerprintSHA256: The server hostkey's SHA256 fingerprint.This setting may be queried in SSHServerAuthentication to get the server hostkey's SHA256 fingerprint. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSHKeepAliveCountMax: The maximum number of keep alive packets to send without a response.This setting specifies the maximum number of keep alive packets to send when no response is received. Normally a response to a keep alive packet is received right away. If no response is received the class will continue to send keep alive packets until SSHKeepAliveCountMax is reached. If this is reached the class will assume the connection is broken and disconnect. The default value is 5. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSHKeepAliveInterval:
The interval between keep alive packets.This setting specifies the number of seconds between keep alive packets. If set to a positive value
the class will send a SSH keep alive packet after KeepAliveInterval seconds of inactivity.
This setting only takes effect when there is no activity, if any data is sent or received over the connection
it will reset the timer.
The default value is 0 meaning no keep alives will be sent. Note: The SSHReverseTunnel class uses a default value of 30. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSHKeyExchangeAlgorithms:
Specifies the supported key exchange algorithms.This may be used to specify the list of supported Key Exchange algorithms used during SSH negotiation. The value should contain
a comma separated list of algorithms. Supported algorithms are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSHKeyRenegotiate:
Causes the component to renegotiate the SSH keys.Once this setting is set the component will renegotiate the SSH keys with the remote host.
Example:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSHMacAlgorithms:
Specifies the supported Mac algorithms.This may be used to specify an alternate list of supported Mac algorithms used during SSH negotiation. This also specifies the order in which the Mac algorithms are preferred.
The value should contain a comma separated list of algorithms. Supported algorithms are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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:
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 since 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 which support them. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSHPublicKeyAlgorithms:
Specifies the supported public key algorithms for the server's public key.
This 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 below value would accept connections for SSH 1.99, 2.0, and 2.99 hosts.
*SSH-1.99-*,*SSH-2.0-*,*SSH-2.99-* |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TryAllAvailableAuthMethods: If set to true, the class will try all available authentication methods.The default value is false. When set to true, the class will try to authenticate using all methods that it has credentials for and the server supports. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
WaitForChannelClose:
Whether to wait for channels to be closed before disconnected.This setting controls whether the class will wait for a server response to the SSH_MSG_CHANNEL_CLOSE when disconnecting. When the class disconnects it will first attempt to close all open channels by sending a SSH_MSG_CHANNEL_CLOSE for each channel. This setting controls whether the class will wait for a server response after sending the messages.
When True (default) the class will wait for a response to the channel close message until the responses have been received, the server closes the connection, or Timeout seconds is reached. When False the class will still send the channel close messages but will not wait for a response and will proceed to close the connection. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
WaitForServerDisconnect:
Whether to wait for the server to close the connection.This setting controls whether to wait for the server to close the connection when SSHLogoff is called.
When set to True the class will initiate the disconnection sequence by sending SSH_MSG_DISCONNECT but will not close the connection, and instead will wait for the server to close the connection. Setting this to True may be beneficial in circumstances where many connections are being established, to avoid port exhaustion when sockets are in a TIME_WAIT state. Allowing the server to close the connection avoids the TIME_WAIT state of socket on the client machine. When set to False (default) the client will close the connection. It is recommended to use this value unless there is a specific need to change it. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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.The appropriate values are as follows:
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 multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface. If the class is connected, the LocalHost setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LocalPort:
The port in the local host where the class binds.
This must be set before a connection is
attempted. It instructs the class to bind to a specific
port (or communication endpoint) in the local machine.
Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established. LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error. This; setting is useful when trying to connect to services that require a trusted port in the client side. An example is the remote shell (rsh) service in UNIX systems. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MaxLineLength:
The maximum amount of data to accumulate when no EOL is found.MaxLineLength is the size of an internal buffer, which holds received data while waiting for an EOL
string.
If an EOL string is found in the input stream before MaxLineLength bytes are received, the DataIn event is fired with the EOL parameter set to True, and the buffer is reset. If no EOL is found, and MaxLineLength bytes are accumulated in the buffer, the DataIn event is fired with the EOL parameter set to False, and the buffer is reset. The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MaxTransferRate: The transfer rate limit in bytes per second.This 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 true, the socket will send all data that is ready to send at once. When
false, the socket will send smaller buffered packets of data at small intervals.
This is known as the Nagle algorithm.
By default, this config is set to false. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UseIPv6:
Whether to use IPv6.When set to 0 (default), the class will use IPv4 exclusively.
When set to 1, the class will use IPv6 exclusively. To instruct the class to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to 2. The default value is 0.
Possible values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Socket Config Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AbsoluteTimeout:
Determines whether timeouts are inactivity timeouts or absolute timeouts.If AbsoluteTimeout is set to True, any method which does not complete within Timeout seconds
will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.
Note: This option is not valid for UDP ports. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FirewallData: Used to send extra data to the firewall.When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g. headers for custom authentication schemes). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
InBufferSize:
The size in bytes of the incoming queue of the socket.
This is the size of an internal queue in the TCP/IP stack.
You can increase or decrease its size depending on the amount
of data that you will be receiving. Increasing the value of the
InBufferSize setting can provide significant improvements in
performance in some cases.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
OutBufferSize:
The size in bytes of the outgoing queue of the socket.This is the size of an internal queue in the TCP/IP stack.
You can increase or decrease its size depending on the amount
of data that you will be sending. Increasing the value of the
OutBufferSize setting can provide significant improvements in
performance in some cases.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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.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 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 true, the socket will send all data that is ready to send at once. When
false, the socket will send smaller buffered packets of data at small intervals.
This is known as the Nagle algorithm.
By default, this config is set to false. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MaskSensitive:
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 false.
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 FIPS, while all the 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 which 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 only applicable on Windows. Note: Enabling FIPS-compliance requires a special license; please contact sales@nsoftware.com for details. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UseInternalSecurityAPI:
Tells the class 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 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 non-socket. | |
10039 [10039] Destination address required. | |
10040 [10040] Message too long. | |
10041 [10041] Protocol wrong type for socket. | |
10042 [10042] Bad protocol option. | |
10043 [10043] Protocol not supported. | |
10044 [10044] Socket type not supported. | |
10045 [10045] Operation not supported on socket. | |
10046 [10046] Protocol family not supported. | |
10047 [10047] Address family not supported by protocol family. | |
10048 [10048] Address already in use. | |
10049 [10049] Can't assign requested address. | |
10050 [10050] Network is down. | |
10051 [10051] Network is unreachable. | |
10052 [10052] Net dropped connection or reset. | |
10053 [10053] Software caused connection abort. | |
10054 [10054] Connection reset by peer. | |
10055 [10055] No buffer space available. | |
10056 [10056] Socket is already connected. | |
10057 [10057] Socket is not connected. | |
10058 [10058] Can't send after socket shutdown. | |
10059 [10059] Too many references, can't splice. | |
10060 [10060] Connection timed out. | |
10061 [10061] Connection refused. | |
10062 [10062] Too many levels of symbolic links. | |
10063 [10063] File name too long. | |
10064 [10064] Host is down. | |
10065 [10065] No route to host. | |
10066 [10066] Directory not empty | |
10067 [10067] Too many processes. | |
10068 [10068] Too many users. | |
10069 [10069] Disc Quota Exceeded. | |
10070 [10070] Stale NFS file handle. | |
10071 [10071] Too many levels of remote in path. | |
10091 [10091] Network subsystem is unavailable. | |
10092 [10092] WINSOCK DLL Version out of range. | |
10093 [10093] Winsock not loaded yet. | |
11001 [11001] Host not found. | |
11002 [11002] Non-authoritative 'Host not found' (try again or check DNS setup). | |
11003 [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP. | |
11004 [11004] Valid name, no data record (check DNS setup). |