SSHClient Class

Properties Methods Events Configuration Settings Errors

The SSHClient class provides client-side SSH protocol functionality.

Syntax

SSHClient

Remarks

Use SSHClient to establish terminal-like connections to remote systems and run commands remotely. The component supports most of third-party implementations out there, and is capable of working in "shell" and "command" modes.

Start with assigning your sign-in credentials to Username and Password properties. Where public key authentication is to be used, assign your private authentication key to Key property (remember to set Username in this case too). Subscribe to events to be notified of the session progress. AuthFailed, AuthSucceeded, and Connect are among those particularly useful.

Special attention should be paid to setting up the server key trust. Class only allows connections to servers whose public keys are recognized as trusted, much like any other SSH clients do. Assign a path to the file containing the list of trusted keys to TrustedKeysFile property. If you don't have such file, or if you would like to make trust decisions on the fly, subscribe to KnownKeyReceived and UnknownKeyReceived events. These are fired whenever a trusted or untrusted key is received from the server. For unknown/untrusted keys, you need to set the Action parameter in your UnknownKeyReceived event handler to catAcceptOnce (1) or catAcceptPermanently (2) for the connection to proceed.

Once you are all set up, you can go ahead by calling the Connect method. This launches the SSH handshake and, if everything has been set up right, establishes a connection to the server. You can now use Send and Receive methods to exchange information with the server. You can exchange data in synchronous or asynchronous way; see the description in AsyncMode topic to learn more about each mode.

When you are done with the session, call Disconnect to shut the connection down.

Hint: If you are only interested in a quick-and-dirty execution of a simple, non-interactive command, SSHClient offers a handy shortcut. ConnectAndExec method is a self-contained mechanism which sets up a connection, performs the data exchange internally, and returns the command output. Please keep in mind that you still need to set up the server trust settings as described above for this method to work.

Property List

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


AsyncMode	Controls the SSH clients mode of work.
AuthAttempts	Specifies the number of SSH password authentication attempts.
Commands	Specifies the list of commands to execute.
Connected	Specifies whether the client is connected to the SFTP server.
ConnInfoClientKeyAlgorithm	Specifies the client's key algorithm.
ConnInfoClientKeyBits	Specifies the length of the client's key.
ConnInfoClientKeyFingerprint	The fingerprint (hash value) of the client's public key.
ConnInfoCloseReason	Contains the line sent by the server just before closing the connection.
ConnInfoCompressionAlgorithmInbound	Compression algorithm for the incoming traffic.
ConnInfoCompressionAlgorithmOutbound	Compression algorithm for the outgoing traffic.
ConnInfoEncryptionAlgorithmInbound	Encryption algorithm for the incoming traffic.
ConnInfoEncryptionAlgorithmOutbound	Encryption algorithm for the outgoing traffic.
ConnInfoInboundEncryptionKeyBits	Specifies the length of the key used to encrypt the incoming traffic.
ConnInfoKexAlgorithm	The key exchange algorithm used during the SSH handshake.
ConnInfoKexBits	The number of bits used by the key exchange algorithm.
ConnInfoKexLines	The contents of the received KexInit packet.
ConnInfoMacAlgorithmInbound	MAC algorithm used for the incoming connection.
ConnInfoMacAlgorithmOutbound	MAC algorithm used for outbound connection.
ConnInfoOutboundEncryptionKeyBits	Specifies the length of the key used to encrypt the outgoing traffic.
ConnInfoPublicKeyAlgorithm	Specifies the public key algorithm which was used during the SSH handshake.
ConnInfoServerKeyBits	Specifies the number of bits in the server's key.
ConnInfoServerKeyFingerprint	The fingerprint (hash value) of the server's public key.
ConnInfoServerSoftwareName	Returns the name of the SSH software running on the server side.
ConnInfoTotalBytesReceived	Returns the total number of bytes received over this connection.
ConnInfoTotalBytesSent	Returns the total number of bytes sent over this connection.
ConnInfoVersion	Specifies SSH protocol version.
ExitMessage	Contains the last commands exit message.
ExitSignal	Contains the last commands exit signal.
ExitStatus	Contains the last commands exit status.
ExternalCryptoAsyncDocumentID	Specifies the document ID for SignAsyncEnd() call Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch.
ExternalCryptoCustomParams	Custom parameters to be passed to the signing service (uninterpreted).
ExternalCryptoData	Additional data to be included in the async state and mirrored back by the requestor.
ExternalCryptoExternalHashCalculation	Specifies whether the message hash is to be calculated at the external endpoint.
ExternalCryptoHashAlgorithm	Specifies the request's signature hash algorithm.
ExternalCryptoKeyID	The ID of the pre-shared key used for DC request authentication.
ExternalCryptoKeySecret	The pre-shared key used for DC request authentication.
ExternalCryptoMethod	Specifies the asynchronous signing method.
ExternalCryptoMode	Specifies the external cryptography mode.
ExternalCryptoPublicKeyAlgorithm	Provide public key algorithm here if the certificate is not available on the pre-signing stage.
FIPSMode	Reserved.
KeyFingerprintSHA1	Contains the SHA-1 fingerprint (hash) of the key.
KeyFingerprintSHA256	Contains the SHA-256 fingerprint (hash) of the key.
KeyHandle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
Password	Specifies user's password on the server.
ProxySettingsAddress	The IP address of the proxy server.
ProxySettingsAuthentication	The authentication type used by the proxy server.
ProxySettingsPassword	The password to authenticate to the proxy server.
ProxySettingsPort	The port on the proxy server to connect to.
ProxySettingsProxyType	The type of the proxy server.
ProxySettingsRequestHeaders	Contains HTTP request headers for WebTunnel and HTTP proxy.
ProxySettingsResponseBody	Contains the HTTP or HTTPS (WebTunnel) proxy response body.
ProxySettingsResponseHeaders	Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.
ProxySettingsUseIPv6	Specifies whether IPv6 should be used when connecting through the proxy.
ProxySettingsUseProxy	Enables or disables proxy-driven connection.
ProxySettingsUsername	Specifies the username credential for proxy authentication.
ServerKeyAlgorithm	Specifies the key algorithm.
ServerKeyBits	The number of bits in the key: the more the better, 2048 or 4096 are typical values.
ServerKeyComment	The comment for the public key.
ServerKeyCurve	Specifies the elliptical curve when EC cryptography is used.
ServerKeyDSSG	The G (Generator) parameter of the DSS signature key.
ServerKeyDSSP	The P (Prime) parameter of the DSS signature key.
ServerKeyDSSQ	The Q (Prime Factor) parameter of the DSS signature key.
ServerKeyDSSX	The X (Private key) parameter of the DSS signature key.
ServerKeyDSSY	The Y (Public key) parameter of the DSS signature key.
ServerKeyECCD	The value of the secret key (the order of the public key, D) if elliptic curve (EC) cryptography is used.
ServerKeyECCQX	The value of the X coordinate of the public key if elliptic curve (EC) cryptography is used.
ServerKeyECCQY	The value of the Y coordinate of the public key if elliptic curve (EC) cryptography is used.
ServerKeyEdPrivate	The value of the private key if EdDSA (Edwards-curve Digital Signature Algorithm) algorithm is used.
ServerKeyEdPublic	The value of the public key if EdDSA (Edwards-curve Digital Signature Algorithm) algorithm is used.
ServerKeyFingerprintMD5	Contains the MD5 fingerprint (hash) of the key.
ServerKeyFingerprintSHA1	Contains the SHA-1 fingerprint (hash) of the key.
ServerKeyFingerprintSHA256	Contains the SHA-256 fingerprint (hash) of the key.
ServerKeyHandle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
ServerKeyIsExtractable	Whether the key is extractable (e.
ServerKeyIsPrivate	Whether this key is a private key or not.
ServerKeyIsPublic	Whether this key is a public key or not.
ServerKeyKDFRounds	Returns the number of iterations of the Key Derivation Function (KDF) used to generate this key.
ServerKeyKDFSalt	The salt value used by the Key Derivation Function (KDF) to generate this key.
ServerKeyKeyFormat	Specifies the format in which the key is stored.
ServerKeyKeyProtectionAlgorithm	Specifies the key protection algorithm.
ServerKeyRSAExponent	Returns the e parameter (public exponent) of the RSA key.
ServerKeyRSAIQMP	Returns the iqmp parameter of the RSA key.
ServerKeyRSAModulus	Returns the m parameter (public modulus) of the RSA key.
ServerKeyRSAP	Returns the p parameter (first factor of the common modulus n) of the RSA key.
ServerKeyRSAPrivateExponent	Returns the d parameter (private exponent) of the RSA key.
ServerKeyRSAQ	Returns the q parameter (second factor of the common modulus n) of the RSA key.
ServerKeySubject	Specifies the public key owner (subject).
SocketDNSMode	Selects the DNS resolver to use: the class's (secure) built-in one, or the one provided by the system.
SocketDNSPort	Specifies the port number to be used for sending queries to the DNS server.
SocketDNSQueryTimeout	The timeout (in milliseconds) for each DNS query.
SocketDNSServers	The addresses of DNS servers to use for address resolution, separated by commas or semicolons.
SocketDNSTotalTimeout	The timeout (in milliseconds) for the whole resolution process.
SocketIncomingSpeedLimit	The maximum number of bytes to read from the socket, per second.
SocketLocalAddress	The local network interface to bind the socket to.
SocketLocalPort	The local port number to bind the socket to.
SocketOutgoingSpeedLimit	The maximum number of bytes to write to the socket, per second.
SocketTimeout	The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.
SocketUseIPv6	Enables or disables IP protocol version 6.
SSHSettingsAutoAdjustCiphers	Whether the SSH client should adjust its list of supported ciphers 'on-the-fly' for greater compatibility with the server it is connecting to.
SSHSettingsBaseConfiguration	Allows to choose base configuration of SSH settings, tuned up for different purposes such as high security or higher compatibility.
SSHSettingsCompressionAlgorithms	A list of session compression algorithms separated with commas or semicolons.
SSHSettingsCompressionLevel	Possible values for the Compression Level range from 0 (minimum compression) to 9 (maximum compression).
SSHSettingsDefaultWindowSize	The SSH window size specifies how many bytes the client can send to the server in the command channel without obtaining pre-authorization for the further send from the server.
SSHSettingsEncryptionAlgorithms	A list of session encryption algorithms separated with commas or semicolons.
SSHSettingsForceCompression	Whether the SSH client should explicitly request compression.
SSHSettingsGSSAuthTypes	A comma-separated list of authentication types.
SSHSettingsGSSDelegateCreds	Switches credential delegation on or off.
SSHSettingsGSSHostname	The GSS host name, in form of a FQDN (e.
SSHSettingsGSSLib	A path to the GSS-API library (DLL or SO).
SSHSettingsGSSMechanisms	A comma-separated list of GSS mechanisms to use.
SSHSettingsGSSProtocols	A comma-separated list of SSPI protocols.
SSHSettingsHandshakeTimeout	Specifies the maximal time for the SSH handshake to proceed, in seconds.
SSHSettingsKexAlgorithms	A list of key exchange algorithms separated with commas or semicolons.
SSHSettingsMacAlgorithms	A list of MAC (for message authentication code ) algorithms separated with commas or semicolons.
SSHSettingsMaxSSHPacketSize	Specifies the maximum length of one SSH packet in bytes.
SSHSettingsMinWindowSize	Specifies the minimal internal window size.
SSHSettingsObfuscateHandshake	Enables or disables handshake obfuscation.
SSHSettingsObfuscationPassword	Specifies the password used to encrypt the handshake when ObfuscateHandshake is set.
SSHSettingsPublicKeyAlgorithms	A list of public key algorithms separated with commas or semicolons.
SSHSettingsRequestPasswordChange	Whether to request a password change when connecting.
SSHSettingsSoftwareName	The name to be used by the class to identify itself.
SSHSettingsTrustAllKeys	Enables or disables explicit trust to all server keys.
SSHSettingsUseAuthAgent	Enables or disables the use of external key agent, such as Putty key agent.
SSHSettingsVersions	Specifies enabled SSH protocol versions (1 or 2).
Subsystem	Specifies the subsystem to request from the server.
TerminalCols	Specifies the width of the pseudoterminal, in characters.
TerminalEnvironment	Specifies the list of environment variables.
TerminalEOLChar	Specifies the End-of-Line character or sequence.
TerminalHeight	Specifies the height of the pseudoterminal, in pixels.
TerminalOpcodes	Specifies the operation codes specific for the terminal.
TerminalProtocol	The terminal protocol name.
TerminalRequestPty	Specifies whether to request a pseudoterminal for the session.
TerminalRows	Specifies the height of the pseudoterminal, in lines.
TerminalWidth	Specifies the width of the pseudoterminal, in pixels.
TrustedKeysFile	Path to the file containing public keys of authorized servers.
Username	Specifies client's username on the server.

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	Establishes connection to an SSH server.
ConnectAndExec	Connects to an SSH server and executes a command in one go.
Disconnect	Closes connection to the SSH server.
DoAction	Performs an additional action.
Ping	Sends a keep-alive request to the SSH server.
Poll	Checks whether there is any inbound data readily available.
Receive	Reads a portion of received data into a string.
ReceiveBytes	Reads a portion of received data into a byte array.
ReceiveBytesFrom	Reads a portion of data received via a specific channel into a byte array.
ReceiveFrom	Reads a portion of data received via a specific channel into a string.
Send	Sends a string to the server.
SendBytes	Sends an array of bytes to the server.
SendSpecial	Sends a special character to the server or remote command.

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.


AuthAttempt	Fires when a single authentication attempt is performed.
AuthFailed	Fires when a single authentication attempt is failed.
AuthSucceeded	Reports a successful authentication.
Banner	Reports the receipt of the Hello message from the server.
CommandCompleted	Signifies completion of the command execution.
CommandStart	Marks the commencement of a command execution.
Connect	This event is fired when an SSH session has been established.
DataReceived	Reports receipt of another chunk of data from the server.
DataSent	Notifies the application that a piece of data has been sent to the server.
Disconnect	This event is fired when the SFTP subsystem connection is closed.
Error	Information about errors during SFTP connection.
ExternalSign	Handles remote or external signing initiated by the SignExternal method or other source.
KnownKeyReceived	Signals that the server has introduced itself with a known key.
Notification	This event notifies the application about an underlying control flow event.
PasswordChangeRequest	This event is fired when a password change is requested.
PrivateKeyNeeded	This event is fired when client's public key was accepted by the server, but the corresponding secret key is not available.
UnknownKeyReceived	Signals that the server has introduced itself with an unknown key.

Configuration Settings

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


BlockSize	The data block size.
ErrorOrigin	Specifies whether the error is local or remote.
ErrorSeverity	Specifies whether the error is fatal.
LocalCharset	Charset used on the client machine.
RemoteCharset	Charset used on the server.
SendCommandEOF	Defines whether EOF control character should be sent after the command data.
ThrottleControl	Enables or disables throttle control for the connection.
CheckKeyIntegrityBeforeUse	Enables or disable private key integrity check before use.
CookieCaching	Specifies whether a cookie cache should be used for HTTP(S) transports.
Cookies	Gets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only).
DefDeriveKeyIterations	Specifies the default key derivation algorithm iteration count.
EnableClientSideSSLFFDHE	Enables or disables finite field DHE key exchange support in TLS clients.
GlobalCookies	Gets or sets global cookies for all the HTTP transports.
HttpUserAgent	Specifies the user agent name to be used by all HTTP clients.
LogDestination	Specifies the debug log destination.
LogDetails	Specifies the debug log details to dump.
LogFile	Specifies the debug log filename.
LogFilters	Specifies the debug log filters.
LogFlushMode	Specifies the log flush mode.
LogLevel	Specifies the debug log level.
LogMaxEventCount	Specifies the maximum number of events to cache before further action is taken.
LogRotationMode	Specifies the log rotation mode.
MaxASN1BufferLength	Specifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepth	Specifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithm	Specifies the hash algorithm to be used to identify certificates in OCSP requests.
Tag	Allows to store any custom data.
UseSharedSystemStorages	Specifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemOAEPAndPSS	Enforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandom	Enables or disables the use of the OS PRNG.

AsyncMode Property (SSHClient Class)

Controls the SSH clients mode of work.

Syntax

bool GetAsyncMode();
int SetAsyncMode(bool bAsyncMode);

Default Value

false

Remarks

This property defines the way in which the class communicates with the application/user code. AsyncMode set to false makes the component use synchronous single-thread approach. Synchronous mode is generally simpler to integrate and use, but please keep in mind that the calls like Connect, Receive or SendBytes may block until their execution completes. In asyncronous mode all operations return immediately, but more care should be taken about handling them in your code properly.

Here are a few highlights of each mode.

Synchronous mode:

All operations are performed within the caller thread context
Operations like Connect or SendBytes may block
Use Poll to check for the availability of data before reading it out with Receive or ReceiveBytes
Return of a call guarantees completion of the operation
Connection errors are reported straight from the methods via exceptions

Asynchronous mode:

All operations are performed in a separate thread (and so are the event calls!)
Methods like Send return immediately
Use DataSent and DataReceived events to be notified about actual data transmissions
Return of call only marks the beginning of the operation and does not guarantee its successful completion
Connection errors are reported via Error event, often followed by Disconnect.

Please note that this is a very important and sensitive property, which has a wide-scale effect on the way the SSH client works and co-operates with the application. Depending on the value assigned to this setting you may need to work with the component very differently.

When setting this property to true, please make sure that your code is prepared to handle events coming from the context of a different thread.

Data Type

Boolean

AuthAttempts Property (SSHClient Class)

Specifies the number of SSH password authentication attempts.

Syntax

int GetAuthAttempts();
int SetAuthAttempts(int iAuthAttempts);

Default Value

Remarks

In case of password authentication failure provide new password inside the AuthFailed event handler.

Data Type

Integer

Commands Property (SSHClient Class)

Specifies the list of commands to execute.

Syntax

QString GetCommands();
int SetCommands(QString qsCommands);

Default Value

Remarks

Use this property to provide a list of commands to execute remotely. Separate different commands with EOL characters.

When this property is set, the component works in the command mode, meaning each command is executed in its own virtual terminal session. No shell connection is established.

If no commands are provided via this property, the component will establish a shell session.

Data Type

String

Connected Property (SSHClient Class)

Specifies whether the client is connected to the SFTP server.

Syntax

bool GetConnected();

Default Value

false

Remarks

Use this read-only property to check whether the client is connected to the server.

This property is read-only.

Data Type

Boolean

ConnInfoClientKeyAlgorithm Property (SSHClient Class)

Specifies the client's key algorithm.

Syntax

QString GetConnInfoClientKeyAlgorithm();

Default Value

Remarks

Specifies the client's key algorithm.

This property is read-only.

Data Type

String

ConnInfoClientKeyBits Property (SSHClient Class)

Specifies the length of the client's key.

Syntax

int GetConnInfoClientKeyBits();

Default Value

Remarks

Specifies the length of the client's key.

This property is read-only.

Data Type

Integer

ConnInfoClientKeyFingerprint Property (SSHClient Class)

The fingerprint (hash value) of the client's public key.

Syntax

QString GetConnInfoClientKeyFingerprint();

Default Value

Remarks

The fingerprint (hash value) of the client's public key.

This property is read-only.

Data Type

String

ConnInfoCloseReason Property (SSHClient Class)

Contains the line sent by the server just before closing the connection.

Syntax

QString GetConnInfoCloseReason();

Default Value

Remarks

Contains the line sent by the server just before closing the connection. It might contain the error description if the connection was not closed gracefully.

This property is read-only.

Data Type

String

ConnInfoCompressionAlgorithmInbound Property (SSHClient Class)

Compression algorithm for the incoming traffic.

Syntax

QString GetConnInfoCompressionAlgorithmInbound();

Default Value

Remarks

Compression algorithm for the incoming traffic.

This property is read-only.

Data Type

String

ConnInfoCompressionAlgorithmOutbound Property (SSHClient Class)

Compression algorithm for the outgoing traffic.

Syntax

QString GetConnInfoCompressionAlgorithmOutbound();

Default Value

Remarks

Compression algorithm for the outgoing traffic.

This property is read-only.

Data Type

String

ConnInfoEncryptionAlgorithmInbound Property (SSHClient Class)

Encryption algorithm for the incoming traffic.

Syntax

QString GetConnInfoEncryptionAlgorithmInbound();

Default Value

Remarks

Encryption algorithm for the incoming traffic.

This property is read-only.

Data Type

String

ConnInfoEncryptionAlgorithmOutbound Property (SSHClient Class)

Encryption algorithm for the outgoing traffic.

Syntax

QString GetConnInfoEncryptionAlgorithmOutbound();

Default Value

Remarks

Encryption algorithm for the outgoing traffic.

This property is read-only.

Data Type

String

ConnInfoInboundEncryptionKeyBits Property (SSHClient Class)

Specifies the length of the key used to encrypt the incoming traffic.

Syntax

int GetConnInfoInboundEncryptionKeyBits();

Default Value

Remarks

Specifies the length of the key used to encrypt the incoming traffic.

This property is read-only.

Data Type

Integer

ConnInfoKexAlgorithm Property (SSHClient Class)

The key exchange algorithm used during the SSH handshake.

Syntax

QString GetConnInfoKexAlgorithm();

Default Value

Remarks

The key exchange algorithm used during the SSH handshake.

This property is read-only.

Data Type

String

ConnInfoKexBits Property (SSHClient Class)

The number of bits used by the key exchange algorithm.

Syntax

int GetConnInfoKexBits();

Default Value

Remarks

The number of bits used by the key exchange algorithm.

This property is read-only.

Data Type

Integer

ConnInfoKexLines Property (SSHClient Class)

The contents of the received KexInit packet.

Syntax

QString GetConnInfoKexLines();

Default Value

Remarks

The contents of the received KexInit packet.

KexInit packet contains the list of algorithms supported by the remote party.

This property is read-only.

Data Type

String

ConnInfoMacAlgorithmInbound Property (SSHClient Class)

MAC algorithm used for the incoming connection.

Syntax

QString GetConnInfoMacAlgorithmInbound();

Default Value

Remarks

MAC algorithm used for the incoming connection.

This property is read-only.

Data Type

String

ConnInfoMacAlgorithmOutbound Property (SSHClient Class)

MAC algorithm used for outbound connection.

Syntax

QString GetConnInfoMacAlgorithmOutbound();

Default Value

Remarks

MAC algorithm used for outbound connection.

This property is read-only.

Data Type

String

ConnInfoOutboundEncryptionKeyBits Property (SSHClient Class)

Specifies the length of the key used to encrypt the outgoing traffic.

Syntax

int GetConnInfoOutboundEncryptionKeyBits();

Default Value

Remarks

Specifies the length of the key used to encrypt the outgoing traffic.

This property is read-only.

Data Type

Integer

ConnInfoPublicKeyAlgorithm Property (SSHClient Class)

Specifies the public key algorithm which was used during the SSH handshake.

Syntax

QString GetConnInfoPublicKeyAlgorithm();

Default Value

Remarks

Specifies the public key algorithm which was used during the SSH handshake.

This property is read-only.

Data Type

String

ConnInfoServerKeyBits Property (SSHClient Class)

Specifies the number of bits in the server's key.

Syntax

int GetConnInfoServerKeyBits();

Default Value

Remarks

Specifies the number of bits in the server's key.

This property is read-only.

Data Type

Integer

ConnInfoServerKeyFingerprint Property (SSHClient Class)

The fingerprint (hash value) of the server's public key.

Syntax

QString GetConnInfoServerKeyFingerprint();

Default Value

Remarks

The fingerprint (hash value) of the server's public key.

This property is read-only.

Data Type

String

ConnInfoServerSoftwareName Property (SSHClient Class)

Returns the name of the SSH software running on the server side.

Syntax

QString GetConnInfoServerSoftwareName();

Default Value

Remarks

Returns the name of the SSH software running on the server side.

This property is read-only.

Data Type

String

ConnInfoTotalBytesReceived Property (SSHClient Class)

Returns the total number of bytes received over this connection.

Syntax

qint64 GetConnInfoTotalBytesReceived();

Default Value

Remarks

Returns the total number of bytes received over this connection.

This property is read-only.

Data Type

Long64

ConnInfoTotalBytesSent Property (SSHClient Class)

Returns the total number of bytes sent over this connection.

Syntax

qint64 GetConnInfoTotalBytesSent();

Default Value

Remarks

Returns the total number of bytes sent over this connection.

This property is read-only.

Data Type

Long64

ConnInfoVersion Property (SSHClient Class)

Specifies SSH protocol version.

Syntax

int GetConnInfoVersion();

Default Value

Remarks

Specifies SSH protocol version.

This property is read-only.

Data Type

Integer

ExitMessage Property (SSHClient Class)

Contains the last commands exit message.

Syntax

QString GetExitMessage();

Default Value

Remarks

Use this property to access the exit message of the last command or shell session. This property normally gets assigned if the command or shell was closed due to an error.

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

Data Type

String

ExitSignal Property (SSHClient Class)

Contains the last commands exit signal.

Syntax

QString GetExitSignal();

Default Value

Remarks

Use this property to access the exit signal of the last command or shell session. This property normally gets assigned if the command or shell was closed due to an error.

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

Data Type

String

ExitStatus Property (SSHClient Class)

Contains the last commands exit status.

Syntax

int GetExitStatus();

Default Value

Remarks

Check this property to obtain the exit status (also sometimes referred to as errorlevel) of the last command or shell session.

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

Data Type

Integer

ExternalCryptoAsyncDocumentID Property (SSHClient Class)

Specifies the document ID for SignAsyncEnd() call Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch.

Syntax

QString GetExternalCryptoAsyncDocumentID();
int SetExternalCryptoAsyncDocumentID(QString qsExternalCryptoAsyncDocumentID);

Default Value

Remarks

Specifies the document ID for SignAsyncEnd() call

Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. This value helps ASiCSigner identify the correct signature in the returned batch of responses. If using batched requests, make sure to set this property to the same value on both pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages.

Data Type

String

ExternalCryptoCustomParams Property (SSHClient Class)

Custom parameters to be passed to the signing service (uninterpreted).

Syntax

QString GetExternalCryptoCustomParams();
int SetExternalCryptoCustomParams(QString qsExternalCryptoCustomParams);

Default Value

Remarks

Custom parameters to be passed to the signing service (uninterpreted).

This property is not available at design time.

Data Type

String

ExternalCryptoData Property (SSHClient Class)

Additional data to be included in the async state and mirrored back by the requestor.

Syntax

QString GetExternalCryptoData();
int SetExternalCryptoData(QString qsExternalCryptoData);

Default Value

Remarks

Additional data to be included in the async state and mirrored back by the requestor

This property is not available at design time.

Data Type

String

ExternalCryptoExternalHashCalculation Property (SSHClient Class)

Specifies whether the message hash is to be calculated at the external endpoint.

Syntax

bool GetExternalCryptoExternalHashCalculation();
int SetExternalCryptoExternalHashCalculation(bool bExternalCryptoExternalHashCalculation);

Default Value

false

Remarks

Specifies whether the message hash is to be calculated at the external endpoint. Please note that this mode is not supported by all components. In particular, components operating with larger objects (PDFSigner, CAdESSigner, XAdESSigner) do not support it.

Data Type

Boolean

ExternalCryptoHashAlgorithm Property (SSHClient Class)

Specifies the request's signature hash algorithm.

Syntax

QString GetExternalCryptoHashAlgorithm();
int SetExternalCryptoHashAlgorithm(QString qsExternalCryptoHashAlgorithm);

Default Value

"SHA256"

Remarks

Specifies the request's signature hash algorithm.


SB_HASH_ALGORITHM_SHA1	`SHA1`
SB_HASH_ALGORITHM_SHA224	`SHA224`
SB_HASH_ALGORITHM_SHA256	`SHA256`
SB_HASH_ALGORITHM_SHA384	`SHA384`
SB_HASH_ALGORITHM_SHA512	`SHA512`
SB_HASH_ALGORITHM_MD2	`MD2`
SB_HASH_ALGORITHM_MD4	`MD4`
SB_HASH_ALGORITHM_MD5	`MD5`
SB_HASH_ALGORITHM_RIPEMD160	`RIPEMD160`
SB_HASH_ALGORITHM_CRC32	`CRC32`
SB_HASH_ALGORITHM_SSL3	`SSL3`
SB_HASH_ALGORITHM_GOST_R3411_1994	`GOST1994`
SB_HASH_ALGORITHM_WHIRLPOOL	`WHIRLPOOL`
SB_HASH_ALGORITHM_POLY1305	`POLY1305`
SB_HASH_ALGORITHM_SHA3_224	`SHA3_224`
SB_HASH_ALGORITHM_SHA3_256	`SHA3_256`
SB_HASH_ALGORITHM_SHA3_384	`SHA3_384`
SB_HASH_ALGORITHM_SHA3_512	`SHA3_512`
SB_HASH_ALGORITHM_BLAKE2S_128	`BLAKE2S_128`
SB_HASH_ALGORITHM_BLAKE2S_160	`BLAKE2S_160`
SB_HASH_ALGORITHM_BLAKE2S_224	`BLAKE2S_224`
SB_HASH_ALGORITHM_BLAKE2S_256	`BLAKE2S_256`
SB_HASH_ALGORITHM_BLAKE2B_160	`BLAKE2B_160`
SB_HASH_ALGORITHM_BLAKE2B_256	`BLAKE2B_256`
SB_HASH_ALGORITHM_BLAKE2B_384	`BLAKE2B_384`
SB_HASH_ALGORITHM_BLAKE2B_512	`BLAKE2B_512`
SB_HASH_ALGORITHM_SHAKE_128	`SHAKE_128`
SB_HASH_ALGORITHM_SHAKE_256	`SHAKE_256`
SB_HASH_ALGORITHM_SHAKE_128_LEN	`SHAKE_128_LEN`
SB_HASH_ALGORITHM_SHAKE_256_LEN	`SHAKE_256_LEN`

Data Type

String

ExternalCryptoKeyID Property (SSHClient Class)

The ID of the pre-shared key used for DC request authentication.

Syntax

QString GetExternalCryptoKeyID();
int SetExternalCryptoKeyID(QString qsExternalCryptoKeyID);

Default Value

Remarks

The ID of the pre-shared key used for DC request authentication.

Asynchronous DCAuth-driven communication requires that parties authenticate each other with a secret pre-shared cryptographic key. This provides extra protection layer for the protocol and diminishes the risk of private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use ExternalCryptoKeySecret to pass the key itself.

The same KeyID/KeySecret pair should be used on the DCAuth side for the signing requests to be accepted.

Note: The KeyID/KeySecret scheme is very similar to the AuthKey scheme used in various Cloud service providers to authenticate users.

Example: signer.ExternalCrypto.KeyID = "MainSigningKey"; signer.ExternalCrypto.KeySecret = "abcdef0123456789";

Data Type

String

ExternalCryptoKeySecret Property (SSHClient Class)

The pre-shared key used for DC request authentication.

Syntax

QString GetExternalCryptoKeySecret();
int SetExternalCryptoKeySecret(QString qsExternalCryptoKeySecret);

Default Value

Remarks

The pre-shared key used for DC request authentication. This key must be set and match the key used by the DCAuth counterpart for the scheme to work.

Read more about configuring authentication in the ExternalCryptoKeyID topic.

Data Type

String

ExternalCryptoMethod Property (SSHClient Class)

Specifies the asynchronous signing method.

Syntax

int GetExternalCryptoMethod();
int SetExternalCryptoMethod(int iExternalCryptoMethod);

Possible Values

ASMD_PKCS1(0), 
ASMD_PKCS7(1)

Default Value

Remarks

Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup.

Available options:


asmdPKCS1	`0`
asmdPKCS7	`1`

Data Type

Integer

ExternalCryptoMode Property (SSHClient Class)

Specifies the external cryptography mode.

Syntax

int GetExternalCryptoMode();
int SetExternalCryptoMode(int iExternalCryptoMode);

Possible Values

ECM_DEFAULT(0), 
ECM_DISABLED(1), 
ECM_GENERIC(2), 
ECM_DCAUTH(3), 
ECM_DCAUTH_JSON(4)

Default Value

Remarks

Specifies the external cryptography mode.

Available options:


ecmDefault	The default value (`0`)
ecmDisabled	Do not use DC or external signing (`1`)
ecmGeneric	Generic external signing with OnExternalSign event (`2`)
ecmDCAuth	DCAuth signing (`3`)
ecmDCAuthJSON	DCAuth signing in JSON format (`4`)

This property is not available at design time.

Data Type

Integer

ExternalCryptoPublicKeyAlgorithm Property (SSHClient Class)

Provide public key algorithm here if the certificate is not available on the pre-signing stage.

Syntax

QString GetExternalCryptoPublicKeyAlgorithm();
int SetExternalCryptoPublicKeyAlgorithm(QString qsExternalCryptoPublicKeyAlgorithm);

Default Value

Remarks

Provide public key algorithm here if the certificate is not available on the pre-signing stage.


SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION	`rsaEncryption`
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION	`md2withRSAEncryption`
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION	`md5withRSAEncryption`
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION	`sha1withRSAEncryption`
SB_CERT_ALGORITHM_ID_DSA	`id-dsa`
SB_CERT_ALGORITHM_ID_DSA_SHA1	`id-dsa-with-sha1`
SB_CERT_ALGORITHM_DH_PUBLIC	`dhpublicnumber`
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION	`sha224WithRSAEncryption`
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION	`sha256WithRSAEncryption`
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION	`sha384WithRSAEncryption`
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION	`sha512WithRSAEncryption`
SB_CERT_ALGORITHM_ID_RSAPSS	`id-RSASSA-PSS`
SB_CERT_ALGORITHM_ID_RSAOAEP	`id-RSAES-OAEP`
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160	`ripemd160withRSA`
SB_CERT_ALGORITHM_ID_ELGAMAL	`elGamal`
SB_CERT_ALGORITHM_SHA1_ECDSA	`ecdsa-with-SHA1`
SB_CERT_ALGORITHM_RECOMMENDED_ECDSA	`ecdsa-recommended`
SB_CERT_ALGORITHM_SHA224_ECDSA	`ecdsa-with-SHA224`
SB_CERT_ALGORITHM_SHA256_ECDSA	`ecdsa-with-SHA256`
SB_CERT_ALGORITHM_SHA384_ECDSA	`ecdsa-with-SHA384`
SB_CERT_ALGORITHM_SHA512_ECDSA	`ecdsa-with-SHA512`
SB_CERT_ALGORITHM_EC	`id-ecPublicKey`
SB_CERT_ALGORITHM_SPECIFIED_ECDSA	`ecdsa-specified`
SB_CERT_ALGORITHM_GOST_R3410_1994	`id-GostR3410-94`
SB_CERT_ALGORITHM_GOST_R3410_2001	`id-GostR3410-2001`
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994	`id-GostR3411-94-with-GostR3410-94`
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001	`id-GostR3411-94-with-GostR3410-2001`
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN	`ecdsa-plain-SHA1`
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN	`ecdsa-plain-SHA224`
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN	`ecdsa-plain-SHA256`
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN	`ecdsa-plain-SHA384`
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN	`ecdsa-plain-SHA512`
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN	`ecdsa-plain-RIPEMD160`
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION	`whirlpoolWithRSAEncryption`
SB_CERT_ALGORITHM_ID_DSA_SHA224	`id-dsa-with-sha224`
SB_CERT_ALGORITHM_ID_DSA_SHA256	`id-dsa-with-sha256`
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-224`
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-256`
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-384`
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-512`
SB_CERT_ALGORITHM_SHA3_224_ECDSA	`id-ecdsa-with-sha3-224`
SB_CERT_ALGORITHM_SHA3_256_ECDSA	`id-ecdsa-with-sha3-256`
SB_CERT_ALGORITHM_SHA3_384_ECDSA	`id-ecdsa-with-sha3-384`
SB_CERT_ALGORITHM_SHA3_512_ECDSA	`id-ecdsa-with-sha3-512`
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-224`
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-256`
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-384`
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-512`
SB_CERT_ALGORITHM_ID_DSA_SHA3_224	`id-dsa-with-sha3-224`
SB_CERT_ALGORITHM_ID_DSA_SHA3_256	`id-dsa-with-sha3-256`
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s128`
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s160`
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s224`
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s256`
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b160`
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b256`
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b384`
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b512`
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA	`id-ecdsa-with-blake2s128`
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA	`id-ecdsa-with-blake2s160`
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA	`id-ecdsa-with-blake2s224`
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA	`id-ecdsa-with-blake2s256`
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA	`id-ecdsa-with-blake2b160`
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA	`id-ecdsa-with-blake2b256`
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA	`id-ecdsa-with-blake2b384`
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA	`id-ecdsa-with-blake2b512`
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s128`
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s160`
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s224`
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s256`
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b160`
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b256`
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b384`
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b512`
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224	`id-dsa-with-blake2s224`
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256	`id-dsa-with-blake2s256`
SB_CERT_ALGORITHM_EDDSA_ED25519	`id-Ed25519`
SB_CERT_ALGORITHM_EDDSA_ED448	`id-Ed448`
SB_CERT_ALGORITHM_EDDSA_ED25519_PH	`id-Ed25519ph`
SB_CERT_ALGORITHM_EDDSA_ED448_PH	`id-Ed448ph`
SB_CERT_ALGORITHM_EDDSA	`id-EdDSA`
SB_CERT_ALGORITHM_EDDSA_SIGNATURE	`id-EdDSA-sig`

Data Type

String

FIPSMode Property (SSHClient Class)

Reserved.

Syntax

bool GetFIPSMode();
int SetFIPSMode(bool bFIPSMode);

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

KeyFingerprintSHA1 Property (SSHClient Class)

Contains the SHA-1 fingerprint (hash) of the key.

Syntax

QString GetKeyFingerprintSHA1();

Default Value

Remarks

Contains the SHA-1 fingerprint (hash) of the key.

This property is read-only.

Data Type

String

KeyFingerprintSHA256 Property (SSHClient Class)

Contains the SHA-256 fingerprint (hash) of the key.

Syntax

QString GetKeyFingerprintSHA256();

Default Value

Remarks

Contains the SHA-256 fingerprint (hash) of the key.

This property is read-only.

Data Type

String

KeyHandle Property (SSHClient Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

qint64 GetKeyHandle();
int SetKeyHandle(qint64 lKeyHandle);

Default Value

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

This property is not available at design time.

Data Type

Long64

Password Property (SSHClient Class)

Specifies user's password on the server.

Syntax

QString GetPassword();
int SetPassword(QString qsPassword);

Default Value

Remarks

Invalid password fires the AuthFailed event.

Data Type

String

ProxySettingsAddress Property (SSHClient Class)

The IP address of the proxy server.

Syntax

QString GetProxySettingsAddress();
int SetProxySettingsAddress(QString qsProxySettingsAddress);

Default Value

Remarks

The IP address of the proxy server.

Data Type

String

ProxySettingsAuthentication Property (SSHClient Class)

The authentication type used by the proxy server.

Syntax

int GetProxySettingsAuthentication();
int SetProxySettingsAuthentication(int iProxySettingsAuthentication);

Possible Values

PAT_NO_AUTHENTICATION(0), 
PAT_BASIC(1), 
PAT_DIGEST(2), 
PAT_NTLM(3)

Default Value

Remarks

The authentication type used by the proxy server.


patNoAuthentication	`0`
patBasic	`1`
patDigest	`2`
patNTLM	`3`

Data Type

Integer

ProxySettingsPassword Property (SSHClient Class)

The password to authenticate to the proxy server.

Syntax

QString GetProxySettingsPassword();
int SetProxySettingsPassword(QString qsProxySettingsPassword);

Default Value

Remarks

The password to authenticate to the proxy server.

Data Type

String

ProxySettingsPort Property (SSHClient Class)

The port on the proxy server to connect to.

Syntax

int GetProxySettingsPort();
int SetProxySettingsPort(int iProxySettingsPort);

Default Value

Remarks

The port on the proxy server to connect to.

Data Type

Integer

ProxySettingsProxyType Property (SSHClient Class)

The type of the proxy server.

Syntax

int GetProxySettingsProxyType();
int SetProxySettingsProxyType(int iProxySettingsProxyType);

Possible Values

CPT_NONE(0), 
CPT_SOCKS_4(1), 
CPT_SOCKS_5(2), 
CPT_WEB_TUNNEL(3), 
CPT_HTTP(4)

Default Value

Remarks

The type of the proxy server.

The WebTunnel proxy is also known as HTTPS proxy. Unlike HTTP proxy, HTTPS proxy (WebTunnel) provides end-to-end security.


cptNone	`0`
cptSocks4	`1`
cptSocks5	`2`
cptWebTunnel	`3`
cptHTTP	`4`

Data Type

Integer

ProxySettingsRequestHeaders Property (SSHClient Class)

Contains HTTP request headers for WebTunnel and HTTP proxy.

Syntax

QString GetProxySettingsRequestHeaders();
int SetProxySettingsRequestHeaders(QString qsProxySettingsRequestHeaders);

Default Value

Remarks

Contains HTTP request headers for WebTunnel and HTTP proxy.

Data Type

String

ProxySettingsResponseBody Property (SSHClient Class)

Contains the HTTP or HTTPS (WebTunnel) proxy response body.

Syntax

QString GetProxySettingsResponseBody();
int SetProxySettingsResponseBody(QString qsProxySettingsResponseBody);

Default Value

Remarks

Contains the HTTP or HTTPS (WebTunnel) proxy response body.

Data Type

String

ProxySettingsResponseHeaders Property (SSHClient Class)

Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.

Syntax

QString GetProxySettingsResponseHeaders();
int SetProxySettingsResponseHeaders(QString qsProxySettingsResponseHeaders);

Default Value

Remarks

Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.

Data Type

String

ProxySettingsUseIPv6 Property (SSHClient Class)

Specifies whether IPv6 should be used when connecting through the proxy.

Syntax

bool GetProxySettingsUseIPv6();
int SetProxySettingsUseIPv6(bool bProxySettingsUseIPv6);

Default Value

false

Remarks

Specifies whether IPv6 should be used when connecting through the proxy.

Data Type

Boolean

ProxySettingsUseProxy Property (SSHClient Class)

Enables or disables proxy-driven connection.

Syntax

bool GetProxySettingsUseProxy();
int SetProxySettingsUseProxy(bool bProxySettingsUseProxy);

Default Value

false

Remarks

Enables or disables proxy-driven connection.

Data Type

Boolean

ProxySettingsUsername Property (SSHClient Class)

Specifies the username credential for proxy authentication.

Syntax

QString GetProxySettingsUsername();
int SetProxySettingsUsername(QString qsProxySettingsUsername);

Default Value

Remarks

Specifies the username credential for proxy authentication.

Data Type

String

ServerKeyAlgorithm Property (SSHClient Class)

Specifies the key algorithm.

Syntax

QString GetServerKeyAlgorithm();

Default Value

Remarks

Specifies the key algorithm.

This property is read-only.

Data Type

String

ServerKeyBits Property (SSHClient Class)

The number of bits in the key: the more the better, 2048 or 4096 are typical values.

Syntax

int GetServerKeyBits();

Default Value

Remarks

The number of bits in the key: the more the better, 2048 or 4096 are typical values.

This property is read-only.

Data Type

Integer

ServerKeyComment Property (SSHClient Class)

The comment for the public key.

Syntax

QString GetServerKeyComment();

Default Value

Remarks

The comment for the public key.

This property is read-only.

Data Type

String

ServerKeyCurve Property (SSHClient Class)

Specifies the elliptical curve when EC cryptography is used.

Syntax

QString GetServerKeyCurve();

QByteArray GetServerKeyDSSX();

Remarks

The X (Private key) parameter of the DSS signature key. The string should contain the binary data of X.

This parameter may be empty if there's no need to sign data with this key (e.g. if the key is a server public key needed only to authenticate the server).

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

Data Type

Byte Array

ServerKeyDSSY Property (SSHClient Class)

The Y (Public key) parameter of the DSS signature key.

Syntax

QByteArray GetServerKeyDSSY();

Remarks

The Y (Public key) parameter of the DSS signature key. The string should contain the binary data of Y.

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

Data Type

Byte Array

ServerKeyECCD Property (SSHClient Class)

The value of the secret key (the order of the public key, D) if elliptic curve (EC) cryptography is used.

Syntax

QByteArray GetServerKeyECCD();

Remarks

The value of the secret key (the order of the public key, D) if elliptic curve (EC) cryptography is used. The string should contain the binary data of D.

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

Data Type

Byte Array

ServerKeyECCQX Property (SSHClient Class)

The value of the X coordinate of the public key if elliptic curve (EC) cryptography is used.

Syntax

QByteArray GetServerKeyECCQX();

Remarks

The value of the X coordinate of the public key if elliptic curve (EC) cryptography is used. The string should contain the binary data of X.

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

Data Type

Byte Array

ServerKeyECCQY Property (SSHClient Class)

The value of the Y coordinate of the public key if elliptic curve (EC) cryptography is used.

Syntax

QByteArray GetServerKeyECCQY();

Remarks

The value of the Y coordinate of the public key if elliptic curve (EC) cryptography is used. The string should contain the binary data of Y.

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

Data Type

Byte Array

ServerKeyEdPrivate Property (SSHClient Class)

The value of the private key if EdDSA (Edwards-curve Digital Signature Algorithm) algorithm is used.

Syntax

QByteArray GetServerKeyEdPrivate();

Remarks

The value of the private key if EdDSA (Edwards-curve Digital Signature Algorithm) algorithm is used.

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

Data Type

Byte Array

ServerKeyEdPublic Property (SSHClient Class)

The value of the public key if EdDSA (Edwards-curve Digital Signature Algorithm) algorithm is used.

Syntax

QByteArray GetServerKeyEdPublic();

Remarks

The value of the public key if EdDSA (Edwards-curve Digital Signature Algorithm) algorithm is used.

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

Data Type

Byte Array

ServerKeyFingerprintMD5 Property (SSHClient Class)

Contains the MD5 fingerprint (hash) of the key.

Syntax

QString GetServerKeyFingerprintMD5();

Default Value

Remarks

Contains the MD5 fingerprint (hash) of the key.

This property is read-only.

Data Type

String

ServerKeyFingerprintSHA1 Property (SSHClient Class)

Contains the SHA-1 fingerprint (hash) of the key.

Syntax

QString GetServerKeyFingerprintSHA1();

Default Value

Remarks

Contains the SHA-1 fingerprint (hash) of the key.

This property is read-only.

Data Type

String

ServerKeyFingerprintSHA256 Property (SSHClient Class)

Contains the SHA-256 fingerprint (hash) of the key.

Syntax

QString GetServerKeyFingerprintSHA256();

Default Value

Remarks

Contains the SHA-256 fingerprint (hash) of the key.

This property is read-only.

Data Type

String

ServerKeyHandle Property (SSHClient Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

qint64 GetServerKeyHandle();

Default Value

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

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

Data Type

Long64

ServerKeyIsExtractable Property (SSHClient Class)

Whether the key is extractable (e.

Syntax

bool GetServerKeyIsExtractable();

Default Value

false

Remarks

Whether the key is extractable (e.g., from a security token), or not.

This property is read-only.

Data Type

Boolean

ServerKeyIsPrivate Property (SSHClient Class)

Whether this key is a private key or not.

Syntax

bool GetServerKeyIsPrivate();

Default Value

false

Remarks

Whether this key is a private key or not.

This property is read-only.

Data Type

Boolean

ServerKeyIsPublic Property (SSHClient Class)

Whether this key is a public key or not.

Syntax

bool GetServerKeyIsPublic();

Default Value

false

Remarks

Whether this key is a public key or not.

This property is read-only.

Data Type

Boolean

ServerKeyKDFRounds Property (SSHClient Class)

Returns the number of iterations of the Key Derivation Function (KDF) used to generate this key.

Syntax

int GetServerKeyKDFRounds();

Default Value

Remarks

Returns the number of iterations of the Key Derivation Function (KDF) used to generate this key.

This property is read-only.

Data Type

Integer

ServerKeyKDFSalt Property (SSHClient Class)

The salt value used by the Key Derivation Function (KDF) to generate this key.

Syntax

QByteArray GetServerKeyKDFSalt();

Remarks

The salt value used by the Key Derivation Function (KDF) to generate this key.

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

Data Type

Byte Array

ServerKeyKeyFormat Property (SSHClient Class)

Specifies the format in which the key is stored.

Syntax

int GetServerKeyKeyFormat();

Possible Values

CKF_OPEN_SSH(0), 
CKF_OPEN_SSH2(1), 
CKF_IETF(2), 
CKF_PU_TTY(3), 
CKF_X509(4), 
CKF_BINARY(5), 
CKF_SSH1(6), 
CKF_PGP(7), 
CKF_PKCS8(8)

Default Value

Remarks

Specifies the format in which the key is stored.


ckfOpenSSH	`0`
ckfOpenSSH2	`1`
ckfIETF	`2`
ckfPuTTY	`3`
ckfX509	`4`
ckfBinary	`5`
ckfSSH1	`6`
ckfPGP	`7`
ckfPKCS8	`8`

This property is read-only.

Data Type

Integer

ServerKeyKeyProtectionAlgorithm Property (SSHClient Class)

Specifies the key protection algorithm.

Syntax

QString GetServerKeyKeyProtectionAlgorithm();

QString GetServerKeySubject();

Default Value

Remarks

Specifies the public key owner (subject). This property is used only for IETF-keys.

This property is read-only.

Data Type

String

SocketDNSMode Property (SSHClient Class)

Selects the DNS resolver to use: the class's (secure) built-in one, or the one provided by the system.

Syntax

int GetSocketDNSMode();
int SetSocketDNSMode(int iSocketDNSMode);

Possible Values

DM_AUTO(0), 
DM_PLATFORM(1), 
DM_OWN(2), 
DM_OWN_SECURE(3)

Default Value

Remarks

Selects the DNS resolver to use: the component's (secure) built-in one, or the one provided by the system.


dmAuto	`0`
dmPlatform	`1`
dmOwn	`2`
dmOwnSecure	`3`

Data Type

Integer

SocketDNSPort Property (SSHClient Class)

Specifies the port number to be used for sending queries to the DNS server.

Syntax

int GetSocketDNSPort();
int SetSocketDNSPort(int iSocketDNSPort);

Default Value

Remarks

Specifies the port number to be used for sending queries to the DNS server.

Data Type

Integer

SocketDNSQueryTimeout Property (SSHClient Class)

The timeout (in milliseconds) for each DNS query.

Syntax

int GetSocketDNSQueryTimeout();
int SetSocketDNSQueryTimeout(int iSocketDNSQueryTimeout);

Default Value

Remarks

The timeout (in milliseconds) for each DNS query. The value of 0 indicates the infinite timeout.

Data Type

Integer

SocketDNSServers Property (SSHClient Class)

The addresses of DNS servers to use for address resolution, separated by commas or semicolons.

Syntax

QString GetSocketDNSServers();
int SetSocketDNSServers(QString qsSocketDNSServers);

Default Value

Remarks

The addresses of DNS servers to use for address resolution, separated by commas or semicolons.

Data Type

String

SocketDNSTotalTimeout Property (SSHClient Class)

The timeout (in milliseconds) for the whole resolution process.

Syntax

int GetSocketDNSTotalTimeout();
int SetSocketDNSTotalTimeout(int iSocketDNSTotalTimeout);

Default Value

Remarks

The timeout (in milliseconds) for the whole resolution process. The value of 0 indicates the infinite timeout.

Data Type

Integer

SocketIncomingSpeedLimit Property (SSHClient Class)

The maximum number of bytes to read from the socket, per second.

Syntax

int GetSocketIncomingSpeedLimit();
int SetSocketIncomingSpeedLimit(int iSocketIncomingSpeedLimit);

Default Value

Remarks

The maximum number of bytes to read from the socket, per second.

Data Type

Integer

SocketLocalAddress Property (SSHClient Class)

The local network interface to bind the socket to.

Syntax

QString GetSocketLocalAddress();
int SetSocketLocalAddress(QString qsSocketLocalAddress);

Default Value

Remarks

The local network interface to bind the socket to.

Data Type

String

SocketLocalPort Property (SSHClient Class)

The local port number to bind the socket to.

Syntax

int GetSocketLocalPort();
int SetSocketLocalPort(int iSocketLocalPort);

Default Value

Remarks

The local port number to bind the socket to.

Data Type

Integer

SocketOutgoingSpeedLimit Property (SSHClient Class)

The maximum number of bytes to write to the socket, per second.

Syntax

int GetSocketOutgoingSpeedLimit();
int SetSocketOutgoingSpeedLimit(int iSocketOutgoingSpeedLimit);

Default Value

Remarks

The maximum number of bytes to write to the socket, per second.

Data Type

Integer

SocketTimeout Property (SSHClient Class)

The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.

Syntax

int GetSocketTimeout();
int SetSocketTimeout(int iSocketTimeout);

Default Value

60000

Remarks

The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.

If Timeout is set to 0, a socket operation will expire after the system-default timeout (2 hrs 8 min for TCP stack).

Data Type

Integer

SocketUseIPv6 Property (SSHClient Class)

Enables or disables IP protocol version 6.

Syntax

bool GetSocketUseIPv6();
int SetSocketUseIPv6(bool bSocketUseIPv6);

Default Value

false

Remarks

Enables or disables IP protocol version 6.

Data Type

Boolean

SSHSettingsAutoAdjustCiphers Property (SSHClient Class)

Whether the SSH client should adjust its list of supported ciphers 'on-the-fly' for greater compatibility with the server it is connecting to.

Syntax

bool GetSSHSettingsAutoAdjustCiphers();
int SetSSHSettingsAutoAdjustCiphers(bool bSSHSettingsAutoAdjustCiphers);

Default Value

true

Remarks

Whether the SSH client should adjust its list of supported ciphers 'on-the-fly' for greater compatibility with the server it is connecting to.

Data Type

Boolean

SSHSettingsBaseConfiguration Property (SSHClient Class)

Allows to choose base configuration of SSH settings, tuned up for different purposes such as high security or higher compatibility.

Syntax

int GetSSHSettingsBaseConfiguration();
int SetSSHSettingsBaseConfiguration(int iSSHSettingsBaseConfiguration);

Possible Values

STPC_DEFAULT(0), 
STPC_COMPATIBLE(1), 
STPC_COMPREHENSIVE_INSECURE(2), 
STPC_HIGHLY_SECURE(3)

Default Value

Remarks

Allows to choose base configuration of SSH settings, tuned up for different purposes such as high security or higher compatibility.

Data Type

Integer

SSHSettingsCompressionAlgorithms Property (SSHClient Class)

A list of session compression algorithms separated with commas or semicolons.

Syntax

QString GetSSHSettingsCompressionAlgorithms();
int SetSSHSettingsCompressionAlgorithms(QString qsSSHSettingsCompressionAlgorithms);

Default Value

Remarks

A list of session compression algorithms separated with commas or semicolons. Each algorithm in the list may be prefixed with a minus sign (-) to indicate that the algorithm should be disabled rather than enabled. Besides the specific algorithm names, this property supports the all (and -all) aliases that allow to blanketly enable or disable all compression algorithms at once.

Note: the list of algorithms provided to this property alters the baseline list of compression algorithms pre-configured for this component. Remember to start your algorithm string with -all; if you need to only enable a specific fixed set of algorithms. The list of supported compression algorithms is provided below:

none
zlib
zlib@openssh.com

Data Type

String

SSHSettingsCompressionLevel Property (SSHClient Class)

Possible values for the Compression Level range from 0 (minimum compression) to 9 (maximum compression).

Syntax

int GetSSHSettingsCompressionLevel();
int SetSSHSettingsCompressionLevel(int iSSHSettingsCompressionLevel);

Default Value

Remarks

Possible values for the Compression Level range from 0 (minimum compression) to 9 (maximum compression). This setting is ignored if compression wasn't accepted.

Data Type

Integer

SSHSettingsDefaultWindowSize Property (SSHClient Class)

The SSH window size specifies how many bytes the client can send to the server in the command channel without obtaining pre-authorization for the further send from the server.

Syntax

int GetSSHSettingsDefaultWindowSize();
int SetSSHSettingsDefaultWindowSize(int iSSHSettingsDefaultWindowSize);

Default Value

2048000

Remarks

The SSH window size specifies how many bytes the client can send to the server in the command channel without obtaining pre-authorization for the further send from the server.

Data Type

Integer

SSHSettingsEncryptionAlgorithms Property (SSHClient Class)

A list of session encryption algorithms separated with commas or semicolons.

Syntax

QString GetSSHSettingsEncryptionAlgorithms();
int SetSSHSettingsEncryptionAlgorithms(QString qsSSHSettingsEncryptionAlgorithms);

Default Value

Remarks

A list of session encryption algorithms separated with commas or semicolons. Each algorithm in the list may be prefixed with a minus sign (-) to indicate that the algorithm should be disabled rather than enabled. Besides the specific algorithm names, this property supports the all (and -all) aliases that allow to blanketly enable or disable all encryption algorithms at once.

Note: the list of algorithms provided to this property alters the baseline list of encryption algorithms pre-configured for this component. Remember to start your algorithm string with -all; if you need to only enable a specific fixed set of algorithms. The list of supported encryption algorithms is provided below:

3des-cbc
blowfish-cbc
twofish256-cbc
twofish192-cbc
twofish128-cbc
aes256-cbc
aes192-cbc
aes128-cbc
serpent256-cbc
serpent192-cbc
serpent128-cbc
arcfour
idea-cbc
cast128-cbc
none
des-cbc
aes128-ctr
aes192-ctr
aes256-ctr
3des-ctr
blowfish-ctr
twofish128-ctr
twofish192-ctr
twofish256-ctr
serpent128-ctr
serpent192-ctr
serpent256-ctr
idea-ctr
cast128-ctr
arcfour128
arcfour256
aes128-gcm
aes256-gcm
aes128-gcm@openssh.com
aes256-gcm@openssh.com
chacha20-poly1305
chacha20-poly1305@openssh.com

Data Type

String

SSHSettingsForceCompression Property (SSHClient Class)

Whether the SSH client should explicitly request compression.

Syntax

bool GetSSHSettingsForceCompression();
int SetSSHSettingsForceCompression(bool bSSHSettingsForceCompression);

Default Value

false

Remarks

Whether the SSH client should explicitly request compression.

If ForceCompression is False, compression will be used only if the server doesn't support algorithms without compression.

Data Type

Boolean

SSHSettingsGSSAuthTypes Property (SSHClient Class)

A comma-separated list of authentication types.

Syntax

QString GetSSHSettingsGSSAuthTypes();
int SetSSHSettingsGSSAuthTypes(QString qsSSHSettingsGSSAuthTypes);

Default Value

Remarks

A comma-separated list of authentication types. Two types are currently supported: gssapi-with-mic and gssapi-keyex.

Data Type

String

SSHSettingsGSSDelegateCreds Property (SSHClient Class)

Switches credential delegation on or off.

Syntax

bool GetSSHSettingsGSSDelegateCreds();
int SetSSHSettingsGSSDelegateCreds(bool bSSHSettingsGSSDelegateCreds);

Default Value

false

Remarks

Switches credential delegation on or off.

Data Type

Boolean

SSHSettingsGSSHostname Property (SSHClient Class)

The GSS host name, in form of a FQDN (e.

Syntax

QString GetSSHSettingsGSSHostname();
int SetSSHSettingsGSSHostname(QString qsSSHSettingsGSSHostname);

Default Value

Remarks

The GSS host name, in form of a FQDN (e.g. hostname.com), a principal name (e.g. 'host@hostname.com), or a cross-real ticket-granting ticket (e.g. krbtgt/test.com@example.com).

Data Type

String

SSHSettingsGSSLib Property (SSHClient Class)

A path to the GSS-API library (DLL or SO).

Syntax

QString GetSSHSettingsGSSLib();
int SetSSHSettingsGSSLib(QString qsSSHSettingsGSSLib);

Default Value

Remarks

A path to the GSS-API library (DLL or SO).

Data Type

String

SSHSettingsGSSMechanisms Property (SSHClient Class)

A comma-separated list of GSS mechanisms to use.

Syntax

QString GetSSHSettingsGSSMechanisms();
int SetSSHSettingsGSSMechanisms(QString qsSSHSettingsGSSMechanisms);

Default Value

Remarks

A comma-separated list of GSS mechanisms to use. Two values are currently supported: lib and SSPI.

Data Type

String

SSHSettingsGSSProtocols Property (SSHClient Class)

A comma-separated list of SSPI protocols.

Syntax

QString GetSSHSettingsGSSProtocols();
int SetSSHSettingsGSSProtocols(QString qsSSHSettingsGSSProtocols);

Default Value

Remarks

A comma-separated list of SSPI protocols. Two protocols are currently supported: kerberos and NTLM.

Data Type

String

SSHSettingsHandshakeTimeout Property (SSHClient Class)

Specifies the maximal time for the SSH handshake to proceed, in seconds.

Syntax

int GetSSHSettingsHandshakeTimeout();
int SetSSHSettingsHandshakeTimeout(int iSSHSettingsHandshakeTimeout);

Default Value

Remarks

Specifies the maximal time for the SSH handshake to proceed, in seconds. If the handshake is not completed within this period, the session is aborted.

Data Type

Integer

SSHSettingsKexAlgorithms Property (SSHClient Class)

A list of key exchange algorithms separated with commas or semicolons.

Syntax

QString GetSSHSettingsKexAlgorithms();
int SetSSHSettingsKexAlgorithms(QString qsSSHSettingsKexAlgorithms);

Default Value

Remarks

A list of key exchange algorithms separated with commas or semicolons. Each algorithm in the list may be prefixed with a minus sign (-) to indicate that the algorithm should be disabled rather than enabled. Besides the specific algorithm names, this property supports the all (and -all) aliases that allow to blanketly enable or disable all key exchange algorithms at once.

Note: the list of algorithms provided to this property alters the baseline list of key exchange algorithms pre-configured for this component. Remember to start your algorithm string with -all; if you need to only enable a specific fixed set of algorithms. The list of supported kex algorithms is provided below:

diffie-hellman-group-exchange-sha1
diffie-hellman-group1-sha1
diffie-hellman-group14-sha1
diffie-hellman-group-exchange-sha256
rsa1024-sha1
rsa2048-sha256
ecdh-sha2-nistp256
ecdh-sha2-nistp384
ecdh-sha2-nistp521
ecdh-sha2-nistk163
ecdh-sha2-nistp192
ecdh-sha2-nistp224
ecdh-sha2-nistk233
ecdh-sha2-nistb233
ecdh-sha2-nistk283
ecdh-sha2-nistk409
ecdh-sha2-nistb409
ecdh-sha2-nistt571
ecdh-sha2-curve25519
curve25519-sha256@libssh.org
curve448-sha512@libssh.org

Data Type

String

SSHSettingsMacAlgorithms Property (SSHClient Class)

A list of MAC (for message authentication code ) algorithms separated with commas or semicolons.

Syntax

QString GetSSHSettingsMacAlgorithms();
int SetSSHSettingsMacAlgorithms(QString qsSSHSettingsMacAlgorithms);

Default Value

Remarks

A list of MAC (for message authentication code) algorithms separated with commas or semicolons. Each algorithm in the list may be prefixed with a minus sign (-) to indicate that the algorithm should be disabled rather than enabled. Besides the specific algorithm names, this property supports the all (and -all) aliases that allow to blanketly enable or disable all MAC algorithms at once.

Note: the list of algorithms provided to this property alters the baseline list of MAC algorithms pre-configured for this component. Remember to start your algorithm string with -all; if you need to only enable a specific fixed set of algorithms. The list of supported MAC algorithms is provided below:

hmac-sha1
hmac-sha1-96
hmac-md5
hmac-md5-96
none
hmac-ripemd160
hmac-ripemd
hmac-ripemd160@openssh.com
hmac-sha256@ssh.com
hmac-sha256-96@ssh.com
umac-32@openssh.com
umac-64@openssh.com
umac-96@openssh.com
umac-128@openssh.com
hmac-sha2-256
hmac-sha2-512
aes128-gcm
aes256-gcm
chacha20-poly1305@openssh.com
hmac-sha2-256-etm@openssh.com
hmac-sha2-512-etm@openssh.com

Data Type

String

SSHSettingsMaxSSHPacketSize Property (SSHClient Class)

Specifies the maximum length of one SSH packet in bytes.

Syntax

int GetSSHSettingsMaxSSHPacketSize();
int SetSSHSettingsMaxSSHPacketSize(int iSSHSettingsMaxSSHPacketSize);

Data Type

Boolean

SSHSettingsObfuscationPassword Property (SSHClient Class)

Specifies the password used to encrypt the handshake when ObfuscateHandshake is set.

Syntax

QString GetSSHSettingsObfuscationPassword();
int SetSSHSettingsObfuscationPassword(QString qsSSHSettingsObfuscationPassword);

Default Value

Remarks

Specifies the password used to encrypt the handshake when ObfuscateHandshake is set.

Data Type

String

SSHSettingsPublicKeyAlgorithms Property (SSHClient Class)

A list of public key algorithms separated with commas or semicolons.

Syntax

QString GetSSHSettingsPublicKeyAlgorithms();
int SetSSHSettingsPublicKeyAlgorithms(QString qsSSHSettingsPublicKeyAlgorithms);

Default Value

Remarks

A list of public key algorithms separated with commas or semicolons. Each algorithm in the list may be prefixed with a minus sign (-) to indicate that the algorithm should be disabled rather than enabled. Besides the specific algorithm names, this property supports the all (and -all) aliases that allow to blanketly enable or disable all public key algorithms at once.

Note: the list of algorithms provided to this property alters the baseline list of public key algorithms pre-configured for this component. Remember to start your algorithm string with -all; if you need to only enable a specific fixed set of algorithms. The list of supported public key algorithms is provided below:

ssh-dss
ssh-rsa
x509v3-sign-rsa
x509v3-sign-dss
spki-sign-rsa,
spki-sign-dss
pgp-sign-rsa
pgp-sign-dss
ecdsa-sha2-nistp256
ecdsa-sha2-nistp384
ecdsa-sha2-nistp521
ecdsa-sha2-nistk163
ecdsa-sha2-nistp192
ecdsa-sha2-nistp224
ecdsa-sha2-nistk233
ecdsa-sha2-nistb233
ecdsa-sha2-nistk283
ecdsa-sha2-nistk409
ecdsa-sha2-nistb409
ecdsa-sha2-nistt571,
ecdsa-sha2-curve25519
x509v3-ssh-rsa
x509v3-ssh-dss
x509v3-rsa2048-sha256
x509v3-ecdsa-sha2-nistp256
x509v3-ecdsa-sha2-nistp384
x509v3-ecdsa-sha2-nistp521
x509v3-ecdsa-sha2-nistk163
x509v3-ecdsa-sha2-nistp192
x509v3-ecdsa-sha2-nistp224
x509v3-ecdsa-sha2-nistk233
x509v3-ecdsa-sha2-nistb233
x509v3-ecdsa-sha2-nistk283
x509v3-ecdsa-sha2-nistk409
x509v3-ecdsa-sha2-nistb409
x509v3-ecdsa-sha2-nistt571
x509v3-ecdsa-sha2-curve25519
ssh-ed25519
ssh-ed448

Data Type

String

SSHSettingsRequestPasswordChange Property (SSHClient Class)

Whether to request a password change when connecting.

Syntax

bool GetSSHSettingsRequestPasswordChange();
int SetSSHSettingsRequestPasswordChange(bool bSSHSettingsRequestPasswordChange);

Default Value

Remarks

Specifies enabled SSH protocol versions (1 or 2).

Data Type

Integer

Subsystem Property (SSHClient Class)

Specifies the subsystem to request from the server.

Syntax

QString GetSubsystem();
int SetSubsystem(QString qsSubsystem);

Default Value

Remarks

Subsystem is a special form of an SSH channel. It is typically used to transfer third-party protocol data, with SFTP being the most widely known.

You can tell class to set up a subsystem connection (rather than a shell or command) by assigning the subsystem name to this property.

Data Type

String

TerminalCols Property (SSHClient Class)

Specifies the width of the pseudoterminal, in characters.

Syntax

int GetTerminalCols();
int SetTerminalCols(int iTerminalCols);

Default Value

Remarks

Specifies the width of the pseudoterminal, in characters.

Data Type

Integer

TerminalEnvironment Property (SSHClient Class)

Specifies the list of environment variables.

Syntax

QString GetTerminalEnvironment();
int SetTerminalEnvironment(QString qsTerminalEnvironment);

Default Value

Remarks

Specifies the list of environment variables.

Data Type

String

TerminalEOLChar Property (SSHClient Class)

Specifies the End-of-Line character or sequence.

Syntax

QByteArray GetTerminalEOLChar();
int SetTerminalEOLChar(QByteArray qbaTerminalEOLChar);

Remarks

Specifies the End-of-Line character or sequence.

This property is not available at design time.

Data Type

Byte Array

TerminalHeight Property (SSHClient Class)

Specifies the height of the pseudoterminal, in pixels.

Syntax

int GetTerminalHeight();
int SetTerminalHeight(int iTerminalHeight);

Default Value

Remarks

Specifies the height of the pseudoterminal, in pixels.

Data Type

Integer

TerminalOpcodes Property (SSHClient Class)

Specifies the operation codes specific for the terminal.

Syntax

QString GetTerminalOpcodes();
int SetTerminalOpcodes(QString qsTerminalOpcodes);

Default Value

Remarks

Specifies the operation codes specific for the terminal.

Data Type

String

TerminalProtocol Property (SSHClient Class)

The terminal protocol name.

Syntax

QString GetTerminalProtocol();
int SetTerminalProtocol(QString qsTerminalProtocol);

Default Value

"vt100"

Remarks

The terminal protocol name.

Data Type

String

TerminalRequestPty Property (SSHClient Class)

Specifies whether to request a pseudoterminal for the session.

Syntax

bool GetTerminalRequestPty();
int SetTerminalRequestPty(bool bTerminalRequestPty);

Default Value

true

Remarks

Specifies whether to request a pseudoterminal for the session.

Data Type

Boolean

TerminalRows Property (SSHClient Class)

Specifies the height of the pseudoterminal, in lines.

Syntax

int GetTerminalRows();
int SetTerminalRows(int iTerminalRows);

Default Value

Remarks

Specifies the height of the pseudoterminal, in lines.

Data Type

Integer

TerminalWidth Property (SSHClient Class)

Specifies the width of the pseudoterminal, in pixels.

Syntax

int GetTerminalWidth();
int SetTerminalWidth(int iTerminalWidth);

Default Value

Remarks

Specifies the width of the pseudoterminal, in pixels.

Data Type

Integer

TrustedKeysFile Property (SSHClient Class)

Path to the file containing public keys of authorized servers.

Syntax

QString GetTrustedKeysFile();
int SetTrustedKeysFile(QString qsTrustedKeysFile);

Default Value

Remarks

Path to the file containing public keys of authorized servers.

Data Type

String

Username Property (SSHClient Class)

Specifies client's username on the server.

Syntax

QString GetUsername();
int SetUsername(QString qsUsername);

Default Value

Remarks

Client's password is set by Password property. ;

Data Type

String

Config Method (SSHClient Class)

Sets or retrieves a configuration setting.

Syntax

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

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

Establishes connection to an SSH server.

Syntax

int Connect(const QString& qsAddress, int iPort);

Remarks

Use this method to connect to the SSH server by providing its Address and Port.

Before connecting to the server you might want to set up your credentials using Username and Password properties. You might also need to configure the server key validation routine. You can do this by subscribing to KnownKeyReceived and UnknownKeyReceived events and implementing the event handlers as required.

Adjust AsyncMode before connecting to switch the component to either synchronous or asynchronous mode. In synchronous mode, all the calls to the component, such as Connect or SendBytes, are executed within the context of the caller thread, and block until the action completes. In asynchronous mode, the component runs the SSH session in a background thread, which makes all such calls return immediately. Find out more about the modes in the AsyncMode topic.

Error Handling

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

ConnectAndExec Method (SSHClient Class)

Connects to an SSH server and executes a command in one go.

Syntax

QByteArray ConnectAndExec(const QString& qsAddress, int iPort, const QString& qsCommand, bool bWantStdout, bool bWantStdErr);

Remarks

Use this method to connect to an SSH server at Address and Port and execute a command. The method returns the output of the executed command.

This method is a handy shortcut for running non-interactive commands. It encapsulates calls to Connect, Receive, Disconnect internally to save you time and space.

Please note that ConnectAndExec always runs synchronously, thus ignoring the AsyncMode setting.

Error Handling

This method returns a Byte Array 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.

Disconnect Method (SSHClient Class)

Closes connection to the SSH server.

Syntax

int Disconnect();

Remarks

Call this method to terminate the active SSH connection.

Please note that in some cases the component may still have some inbound data cached internally even after the connection is closed. You can read that data out using Receive and/or ReceiveBytes methods.

Error Handling

DoAction Method (SSHClient Class)

Performs an additional action.

Syntax

QString DoAction(const QString& qsActionID, const QString& qsActionParams);

Remarks

DoAction is a generic method available in every class. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.

The unique identifier of the action is provided in ActionID parameter. ActionParams contains a list of parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

Error Handling

Ping Method (SSHClient Class)

Sends a keep-alive request to the SSH server.

Syntax

int Ping();

Remarks

Use this method to send a keep-alive message to the SSH server. Keep-alive messages are empty data packets which carry no useful information but are a handy way of checking if the connection is still alive.

Error Handling

Poll Method (SSHClient Class)

Checks whether there is any inbound data readily available.

Syntax

bool Poll(int iMilliseconds);

Remarks

Use this method to check whether there is any incoming data available in the connection. If this method returns true, you can read the data with Receive or ReceiveBytes calls.

Use the Milliseconds parameter to tell the component how long it can wait for the data to arrive.

Error Handling

This method returns a Boolean 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.

Receive Method (SSHClient Class)

Reads a portion of received data into a string.

Syntax

QString Receive();

Remarks

Use this method to read out a piece of data received from the server into a string.

Note that in synchronous mode this method may block in the absence of any inbound data until the next piece of data is received from the server. Use Poll to check if there is any data in the connection that is immediately available for reading.

In asynchronous mode a good time to call this method is upon receiving a read notification in DataReceived event handler. When working in asynchronous mode, this call returns immediately.

This method only returns data that arrives via the stdout channel. Use ReceiveFrom to read stderr data.

Error Handling

ReceiveBytes Method (SSHClient Class)

Reads a portion of received data into a byte array.

Syntax

QByteArray ReceiveBytes(int iMaxLen);

Remarks

Use this method to read out a piece of data received from the server into a byte array. Control the maximum length of the data chunk with the MaxLen parameter.

In asynchronous mode a good time to call this method is upon receiving a read notification in DataReceived event handler. When working in asynchronous mode, this call returns immediately.

This method only returns data that arrives via the stdout channel. Use ReceiveBytesFrom to read stderr data.

Error Handling

ReceiveBytesFrom Method (SSHClient Class)

Reads a portion of data received via a specific channel into a byte array.

Syntax

QByteArray ReceiveBytesFrom(int iChannel, int iMaxLen);

Remarks

Use this method to read out a piece of data received from the server into a byte array. Specify the channel that you are interested in reading from (0 for stdout, 1 for stderr) via the Channel parameter, and control the maximum length of the data chunk with the MaxLen parameter.

In asynchronous mode a good time to call this method is upon receiving a read notification in DataReceived event handler. When working in asynchronous mode, this call returns immediately.

Please also note that stdout and stderr channels are fully independent, which implies that data arriving via each channel should be read out separately.

Error Handling

ReceiveFrom Method (SSHClient Class)

Reads a portion of data received via a specific channel into a string.

Syntax

QString ReceiveFrom(int iChannel);

Remarks

Use this method to read out a piece of data received from the server into a string. Use the Channel parameter to specify the channel that you would like to read from (0 for stdout, 1 for stderr).

In asynchronous mode a good time to call this method is upon receiving a read notification in DataReceived event handler. When working in asynchronous mode, this call returns immediately.

Error Handling

Send Method (SSHClient Class)

Sends a string to the server.

Syntax

int Send(const QString& qsDataStr, bool bAddEOL);

Remarks

Use this method to send DataStr to the remote command's stdin channel. Set the AddEOL parameter to true to append the end-of-line character to the string automatically.

Note that in synchronous mode this method may block until the whole string is commited to the network connection. In asynchronous mode this method returns immediately; the application is eventually notified that the data has been sent via the DataSent event.

Error Handling

SendBytes Method (SSHClient Class)

Sends an array of bytes to the server.

Syntax

int SendBytes(QByteArray qbaData);

Remarks

Use this method to send Data to the remote command's stdin channel.

Note that in synchronous mode this method may block until the whole byte array is commited to the network connection. In asynchronous mode this method returns immediately; the application is eventually notified that the data has been sent via the DataSent event.

Error Handling

SendSpecial Method (SSHClient Class)

Sends a special character to the server or remote command.

Syntax

int SendSpecial(const QString& qsSpecialChar);

Remarks

Use this method to send a special or control character to the SSH server or the command being executed. Specify the character id via the SpecialChar parameter.

Currently the only supported special character is "eof", which is sometimes used as a way to close the stdin channel gracefully.

Error Handling

AuthAttempt Event (SSHClient Class)

Fires when a single authentication attempt is performed.

Syntax

class SSHClientAuthAttemptEventParams {
public:
  int AuthType();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void AuthAttempt(SSHClientAuthAttemptEventParams *e);

// Or, subclass SSHClient and override this emitter function.
virtual int FireAuthAttempt(SSHClientAuthAttemptEventParams *e) {...}

Remarks

This event is fired each time a single authentication attempt is performed. AuthType parameter specifies the type of authentication. Note, this event could be fired more than once if the client tries different authentication methods one after another.

AuthFailed Event (SSHClient Class)

Fires when a single authentication attempt is failed.

Syntax

class SSHClientAuthFailedEventParams {
public:
  int AuthenticationType();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void AuthFailed(SSHClientAuthFailedEventParams *e);

// Or, subclass SSHClient and override this emitter function.
virtual int FireAuthFailed(SSHClientAuthFailedEventParams *e) {...}

Remarks

This event is fired each time a single authentication attempt fails. AuthType parameter specifies the type of authentication.

As SSH may try a number of authentication attempts of different types or with different parameters (such as public keys) during one session, this event may be fired more than once. It is not critical and may not lead to closing of the connection.

AuthSucceeded Event (SSHClient Class)

Reports a successful authentication.

Syntax

class SSHClientAuthSucceededEventParams {
public:
  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void AuthSucceeded(SSHClientAuthSucceededEventParams *e);

// Or, subclass SSHClient and override this emitter function.
virtual int FireAuthSucceeded(SSHClientAuthSucceededEventParams *e) {...}

Remarks

This event may be preceded by some AuthFailed events if the client tries different authentication methods one after another.

Banner Event (SSHClient Class)

Reports the receipt of the Hello message from the server.

Syntax

class SSHClientBannerEventParams {
public:
  const QByteArray &Text();

  const QByteArray &Language();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Banner(SSHClientBannerEventParams *e);

// Or, subclass SSHClient and override this emitter function.
virtual int FireBanner(SSHClientBannerEventParams *e) {...}

Remarks

SFPTClient fires this event when it receives hello message from the server.

CommandCompleted Event (SSHClient Class)

Signifies completion of the command execution.

Syntax

class SSHClientCommandCompletedEventParams {
public:
  const QString &Command();

  int ExitStatus();

  const QString &ExitMessage();

  const QString &ExitSignal();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void CommandCompleted(SSHClientCommandCompletedEventParams *e);

// Or, subclass SSHClient and override this emitter function.
virtual int FireCommandCompleted(SSHClientCommandCompletedEventParams *e) {...}

Remarks

Subscribe to this event to be notified about completion of the remote command execution. This event fires for every command in the Commands list. The Command parameter indicates the command being completed.

ExitStatus specifies the command's return code. ExitMessage or ExitSignal parameters provide error details if the command execution was terminated forcefully,

CommandStart Event (SSHClient Class)

Marks the commencement of a command execution.

Syntax

class SSHClientCommandStartEventParams {
public:
  const QString &Command();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void CommandStart(SSHClientCommandStartEventParams *e);

// Or, subclass SSHClient and override this emitter function.
virtual int FireCommandStart(SSHClientCommandStartEventParams *e) {...}

Remarks

Subscribe to this event to be notified about the start of execution of a remote command. The Command parameter indicates the command being started.

This event is fired for all commands in the Commands list, in order. The completion of the command is reported via the CommandCompleted event.

Connect Event (SSHClient Class)

This event is fired when an SSH session has been established.

Syntax

class SSHClientConnectEventParams {
public:
  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Connect(SSHClientConnectEventParams *e);

// Or, subclass SSHClient and override this emitter function.
virtual int FireConnect(SSHClientConnectEventParams *e) {...}

Remarks

Use this event to track the moment when SSH session has been set up.

DataReceived Event (SSHClient Class)

Reports receipt of another chunk of data from the server.

Syntax

class SSHClientDataReceivedEventParams {
public:
  int Channel();

  int BytesReceived();

  int TotalBytesPending();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void DataReceived(SSHClientDataReceivedEventParams *e);

// Or, subclass SSHClient and override this emitter function.
virtual int FireDataReceived(SSHClientDataReceivedEventParams *e) {...}

Remarks

This event fires in asynchronous mode to report the receipt of another chunk of data from the server. Use Receive or ReceiveBytes methods to read out the received data.

The Channel parameter indicates the channel on which the data was received: stdout (0) or stderr (1). BytesReceived specify the size of the newly received chunk, and TotalBytesPending contain the total number of bytes available for reading.

Please note that just like other asynchronous mode events this event may fire from a secondary thread. Please make sure your code is prepared for that by using appropriate synchronization facilities.

This event does not fire in synchronous mode.

DataSent Event (SSHClient Class)

Notifies the application that a piece of data has been sent to the server.

Syntax

class SSHClientDataSentEventParams {
public:
  int BytesSent();

  int BytesPending();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void DataSent(SSHClientDataSentEventParams *e);

// Or, subclass SSHClient and override this emitter function.
virtual int FireDataSent(SSHClientDataSentEventParams *e) {...}

Remarks

Subscribe to this event to be notified about the outbound data flow. This event fires following a call to Send or SendBytes methods to notify the application that the data provided has been sent to the server. This event may fire more than once for each Send or SendBytes call, subject to the volume of data being sent and the settings of the server.

The BytesSent parameter specifies the number of bytes that has just been sent to the server. The BytesPending indicate the number of bytes that remain cached in the internal buffer. Any bytes cached in such way will be sent again on the next available opportunity and reported via a separate DataSent event invocation.

Please note that just like other asynchronous mode events this event may fire from a secondary thread. Please make sure your code is prepared for that by using appropriate synchronization facilities.

This event does not fire in synchronous mode.

Disconnect Event (SSHClient Class)

This event is fired when the SFTP subsystem connection is closed.

Syntax

class SSHClientDisconnectEventParams {
public:
  int CloseReason();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Disconnect(SSHClientDisconnectEventParams *e);

// Or, subclass SSHClient and override this emitter function.
virtual int FireDisconnect(SSHClientDisconnectEventParams *e) {...}

Remarks

Do not perform any file operations after this event has been fired.

Error Event (SSHClient Class)

Information about errors during SFTP connection.

Syntax

class SSHClientErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(SSHClientErrorEventParams *e);

// Or, subclass SSHClient and override this emitter function.
virtual int FireError(SSHClientErrorEventParams *e) {...}

Remarks

The event is fired in case of exceptional conditions during data transfer.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of error codes please refer to SFTP.

ExternalSign Event (SSHClient Class)

Handles remote or external signing initiated by the SignExternal method or other source.

Syntax

class SSHClientExternalSignEventParams {
public:
  const QString &OperationId();

  const QString &HashAlgorithm();

  const QString &Pars();

  const QString &Data();

  const QString &SignedData();
  void SetSignedData(const QString &qsSignedData);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void ExternalSign(SSHClientExternalSignEventParams *e);

// Or, subclass SSHClient and override this emitter function.
virtual int FireExternalSign(SSHClientExternalSignEventParams *e) {...}

Remarks

Assign a handler to this event if you need to delegate a low-level signing operation to an external, remote, or custom signing engine. Depending on the settings, the handler will receive a hashed or unhashed value to be signed.

The event handler must pass the value of Data to the signer, obtain the signature, and pass it back to the component via SignedData parameter.

OperationId provides a comment about the operation and its origin. It depends on the exact component being used, and may be empty. HashAlgorithm specifies the hash algorithm being used for the operation, and Pars contain algorithm-dependent parameters.

The component uses base16 (hex) encoding for Data, SignedData, and Pars parameters. If your signing engine uses a different input and output encoding, you may need to decode and/or encode the data before and/or after the signing.

A sample MD5 hash encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16

A sample event handler that uses a .NET RSACryptoServiceProvider class may look like the following: signer.OnExternalSign += (s, e) => { var cert = new X509Certificate2("cert.pfx", "", X509KeyStorageFlags.Exportable); var key = (RSACryptoServiceProvider)cert.PrivateKey; var dataToSign = e.Data.FromBase16String(); var signedData = key.SignHash(dataToSign, "2.16.840.1.101.3.4.2.1"); e.SignedData = signedData.ToBase16String(); };

KnownKeyReceived Event (SSHClient Class)

Signals that the server has introduced itself with a known key.

Syntax

class SSHClientKnownKeyReceivedEventParams {
public:
  const QString &Algorithm();

  int Bits();

  const QString &FingerprintSHA256();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void KnownKeyReceived(SSHClientKnownKeyReceivedEventParams *e);

// Or, subclass SSHClient and override this emitter function.
virtual int FireKnownKeyReceived(SSHClientKnownKeyReceivedEventParams *e) {...}

Remarks

The class fires this event to tell the application that the server has introduced itself with a known key from TrustedKeysFile.

The details of the key are provided: Algorithm and Bits specify the key algorithm and the number of bits. FingerprintSHA256 contains the key's fingerprint.

Use ServerKey to access more key details.

Notification Event (SSHClient Class)

This event notifies the application about an underlying control flow event.

Syntax

class SSHClientNotificationEventParams {
public:
  const QString &EventID();

  const QString &EventParam();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Notification(SSHClientNotificationEventParams *e);

// Or, subclass SSHClient and override this emitter function.
virtual int FireNotification(SSHClientNotificationEventParams *e) {...}

Remarks

The class fires this event to let the application know about some event, occurrence, or milestone in the component. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

The unique identifier of the event is provided in EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the component, the exact action it is performing, or the document being processed, one or both may be omitted.

PasswordChangeRequest Event (SSHClient Class)

This event is fired when a password change is requested.

Syntax

class SSHClientPasswordChangeRequestEventParams {
public:
  const QString &Prompt();

  const QString &NewPassword();
  void SetNewPassword(const QString &qsNewPassword);

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

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void PasswordChangeRequest(SSHClientPasswordChangeRequestEventParams *e);

// Or, subclass SSHClient and override this emitter function.
virtual int FirePasswordChangeRequest(SSHClientPasswordChangeRequestEventParams *e) {...}

Remarks

This event is fired by the class when a password change is requested by the server. Prompt contains the password prompt message. Handler should either provide the new password via NewPassword, or deny the request by setting Cancel to true.

PrivateKeyNeeded Event (SSHClient Class)

This event is fired when client's public key was accepted by the server, but the corresponding secret key is not available.

Syntax

class SSHClientPrivateKeyNeededEventParams {
public:
  bool Skip();
  void SetSkip(bool bSkip);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void PrivateKeyNeeded(SSHClientPrivateKeyNeededEventParams *e);

// Or, subclass SSHClient and override this emitter function.
virtual int FirePrivateKeyNeeded(SSHClientPrivateKeyNeededEventParams *e) {...}

Remarks

Set Skip to true when it is not possible to load the missing key for some reason.

UnknownKeyReceived Event (SSHClient Class)

Signals that the server has introduced itself with an unknown key.

Syntax

class SSHClientUnknownKeyReceivedEventParams {
public:
  const QString &Algorithm();

  int Bits();

  const QString &FingerprintSHA256();

  int Action();
  void SetAction(int iAction);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void UnknownKeyReceived(SSHClientUnknownKeyReceivedEventParams *e);

// Or, subclass SSHClient and override this emitter function.
virtual int FireUnknownKeyReceived(SSHClientUnknownKeyReceivedEventParams *e) {...}

Remarks

The class fires this event to tell the application that the server has introduced itself with a key not present in TrustedKeysFile.

The details of the key are provided: Algorithm and Bits specify the key algorithm and the number of bits. FingerprintSHA256 contains the key's fingerprint.

In this event handler, you need to make a decision whether to proceed with the connection. Use Action to tell the class what it should do with the key:


catAcceptOnce	`1`	Accept the key for the current session only.
catAcceptPermanently	`2`	Accept the key for the current session and store the key to the trusted keys list.
catReject	`3`	Reject the key and close the connection.

Note that accepting an unknown and unchecked key may be risky.

Configuration Settings (SSHClient Class)

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

SSHClient Configuration Settings

BlockSize: The data block size.

This property specifies the data block size to use.

ErrorOrigin: Specifies whether the error is local or remote.

Use this property to check where the error took place.

ErrorSeverity: Specifies whether the error is fatal.

Use this property to check whether the error is fatal or not.

LocalCharset: Charset used on the client machine.

This property specifies the charset used on the local client computer.

RemoteCharset: Charset used on the server.

This property specifies the charset used on the server.

SendCommandEOF: Defines whether EOF control character should be sent after the command data.

Enable this property to enforce sending of a trailing EOF character after the command data.

ThrottleControl: Enables or disables throttle control for the connection.

Use this property to enable or disable throttle control.

Base Configuration Settings

CheckKeyIntegrityBeforeUse: Enables or disable private key integrity check before use.

This global property enables or disables private key material check before each signing operation. This slows down performance a bit, but prevents a selection of attacks on RSA keys where keys with unknown origins are used.

You can switch this property off to improve performance if your project only uses known, good private keys.

CookieCaching: Specifies whether a cookie cache should be used for HTTP(S) transports.

Set this property to enable or disable cookies caching for the class.

Supported values are:


off		No caching (default)
local		Local caching (supported for HTTPClient, RESTClient and SOAPClient only)
global		Global caching

Cookies: Gets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only).

Use this property to get cookies from the internal cookie storage of the class and/or restore them back between application sessions.

DefDeriveKeyIterations: Specifies the default key derivation algorithm iteration count.

This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided.

EnableClientSideSSLFFDHE: Enables or disables finite field DHE key exchange support in TLS clients.

This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower algorithm if compared to EC DHE; enabling it may result in slower connections.

This setting only applies to sessions negotiated with TLS version 1.3.

GlobalCookies: Gets or sets global cookies for all the HTTP transports.

Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the classes that have its CookieCaching property set to "global".

HttpUserAgent: Specifies the user agent name to be used by all HTTP clients.

This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other classes.

LogDestination: Specifies the debug log destination.

Contains a comma-separated list of values that specifies where debug log should be dumped.

Supported values are:


file		File
console		Console
systemlog		System Log (supported for Android only)
debugger		Debugger (supported for VCL for Windows and .Net)

LogDetails: Specifies the debug log details to dump.

Contains a comma-separated list of values that specifies which debug log details to dump.

Supported values are:


time		Current time
level		Level
package		Package name
module		Module name
class		Class name
method		Method name
threadid		Thread Id
contenttype		Content type
content		Content
all		All details

LogFile: Specifies the debug log filename.

Use this property to provide a path to the log file.

LogFilters: Specifies the debug log filters.

Contains a comma-separated list of value pairs ("name:value") that describe filters.

Supported filter names are:


exclude-package		Exclude a package specified in the value
exclude-module		Exclude a module specified in the value
exclude-class		Exclude a class specified in the value
exclude-method		Exclude a method specified in the value
include-package		Include a package specified in the value
include-module		Include a module specified in the value
include-class		Include a class specified in the value
include-method		Include a method specified in the value

LogFlushMode: Specifies the log flush mode.

Use this property to set the log flush mode. The following values are defined:


none		No flush (caching only)
immediate		Immediate flush (real-time logging)
maxcount		Flush cached entries upon reaching LogMaxEventCount entries in the cache.

LogLevel: Specifies the debug log level.

Use this property to provide the desired debug log level.

Supported values are:


none		None (by default)
fatal		Severe errors that cause premature termination.
error		Other runtime errors or unexpected conditions.
warning		Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong".
info		Interesting runtime events (startup/shutdown).
debug		Detailed information on flow of through the system.
trace		More detailed information.

LogMaxEventCount: Specifies the maximum number of events to cache before further action is taken.

Use this property to specify the log event number threshold. This threshold may have different effects, depending on the rotation setting and/or the flush mode.

The default value of this setting is 100.

LogRotationMode: Specifies the log rotation mode.

Use this property to set the log rotation mode. The following values are defined:


none		No rotation
deleteolder		Delete older entries from the cache upon reaching LogMaxEventCount
keepolder		Keep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded)

MaxASN1BufferLength: Specifies the maximal allowed length for ASN.1 primitive tag data.

This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks.

MaxASN1TreeDepth: Specifies the maximal depth for processed ASN.1 trees.

This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks.

OCSPHashAlgorithm: Specifies the hash algorithm to be used to identify certificates in OCSP requests.

This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful.

Tag: Allows to store any custom data.

Use this config property to store any custom data.

UseSharedSystemStorages: Specifies whether the validation engine should use a global per-process copy of the system certificate stores.

Set this global property to false to make each validation run use its own copy of system certificate stores.

UseSystemOAEPAndPSS: Enforces or disables the use of system-driven RSA OAEP and PSS computations.

This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable. If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations using its own OAEP/PSS implementation.

This setting only applies to certificates originating from a Windows system store.

UseSystemRandom: Enables or disables the use of the OS PRNG.

Use this global property to enable or disable the use of operating system-driven pseudorandom number generation.

Trappable Errors (SSHClient Class)

SecureBlackbox 2022 Qt Edition

SSHClient Class

Syntax

Remarks

Property List

Method List

Event List

Configuration Settings

AsyncMode Property (SSHClient Class)

Syntax

Default Value

Remarks

Data Type

AuthAttempts Property (SSHClient Class)

Syntax

Default Value

Remarks

Data Type

Commands Property (SSHClient Class)

Syntax

Default Value

Remarks

Data Type

Connected Property (SSHClient Class)

Syntax

Default Value

Remarks

Data Type

ConnInfoClientKeyAlgorithm Property (SSHClient Class)

Syntax

Default Value

Remarks

Data Type

ConnInfoClientKeyBits Property (SSHClient Class)

Syntax

Default Value

Remarks

Data Type

ConnInfoClientKeyFingerprint Property (SSHClient Class)

Syntax

Default Value

Remarks

Data Type

ConnInfoCloseReason Property (SSHClient Class)

Syntax

Default Value

Remarks

Data Type

ConnInfoCompressionAlgorithmInbound Property (SSHClient Class)

Syntax

Default Value

Remarks

Data Type

ConnInfoCompressionAlgorithmOutbound Property (SSHClient Class)

Syntax

Default Value

Remarks

Data Type

ConnInfoEncryptionAlgorithmInbound Property (SSHClient Class)

Syntax

Default Value

Remarks

Data Type

ConnInfoEncryptionAlgorithmOutbound Property (SSHClient Class)

Syntax

Default Value

Remarks

Data Type

ConnInfoInboundEncryptionKeyBits Property (SSHClient Class)

Syntax

Default Value

Remarks

Data Type

ConnInfoKexAlgorithm Property (SSHClient Class)

Syntax

Default Value

Remarks

Data Type

ConnInfoKexBits Property (SSHClient Class)

Syntax