SSHClient Class

Properties   Methods   Events   Config 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.

Method List

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

Event List

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

Config Settings

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

AsyncMode Property (SSHClient Class)

Controls the SSH clients mode of work.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAsyncMode();
int SetAsyncMode(int bAsyncMode);

Unicode (Windows)
BOOL GetAsyncMode();
INT SetAsyncMode(BOOL bAsyncMode);

int secureblackbox_sshclient_getasyncmode(void* lpObj);
int secureblackbox_sshclient_setasyncmode(void* lpObj, int bAsyncMode);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAuthAttempts();
int SetAuthAttempts(int iAuthAttempts);

Unicode (Windows)
INT GetAuthAttempts();
INT SetAuthAttempts(INT iAuthAttempts);

int secureblackbox_sshclient_getauthattempts(void* lpObj);
int secureblackbox_sshclient_setauthattempts(void* lpObj, int iAuthAttempts);

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

Default Value

1

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCommands();
int SetCommands(const char* lpszCommands);

Unicode (Windows)
LPWSTR GetCommands();
INT SetCommands(LPCWSTR lpszCommands);

char* secureblackbox_sshclient_getcommands(void* lpObj);
int secureblackbox_sshclient_setcommands(void* lpObj, const char* lpszCommands);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnected();

Unicode (Windows)
BOOL GetConnected();

int secureblackbox_sshclient_getconnected(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetConnInfoClientKeyAlgorithm();

Unicode (Windows)
LPWSTR GetConnInfoClientKeyAlgorithm();

char* secureblackbox_sshclient_getconninfoclientkeyalgorithm(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnInfoClientKeyBits();

Unicode (Windows)
INT GetConnInfoClientKeyBits();

int secureblackbox_sshclient_getconninfoclientkeybits(void* lpObj);

int GetConnInfoClientKeyBits();

Default Value

0

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetConnInfoClientKeyFingerprint();

Unicode (Windows)
LPWSTR GetConnInfoClientKeyFingerprint();

char* secureblackbox_sshclient_getconninfoclientkeyfingerprint(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetConnInfoCloseReason();

Unicode (Windows)
LPWSTR GetConnInfoCloseReason();

char* secureblackbox_sshclient_getconninfoclosereason(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetConnInfoCompressionAlgorithmInbound();

Unicode (Windows)
LPWSTR GetConnInfoCompressionAlgorithmInbound();

char* secureblackbox_sshclient_getconninfocompressionalgorithminbound(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetConnInfoCompressionAlgorithmOutbound();

Unicode (Windows)
LPWSTR GetConnInfoCompressionAlgorithmOutbound();

char* secureblackbox_sshclient_getconninfocompressionalgorithmoutbound(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetConnInfoEncryptionAlgorithmInbound();

Unicode (Windows)
LPWSTR GetConnInfoEncryptionAlgorithmInbound();

char* secureblackbox_sshclient_getconninfoencryptionalgorithminbound(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetConnInfoEncryptionAlgorithmOutbound();

Unicode (Windows)
LPWSTR GetConnInfoEncryptionAlgorithmOutbound();

char* secureblackbox_sshclient_getconninfoencryptionalgorithmoutbound(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnInfoInboundEncryptionKeyBits();

Unicode (Windows)
INT GetConnInfoInboundEncryptionKeyBits();

int secureblackbox_sshclient_getconninfoinboundencryptionkeybits(void* lpObj);

int GetConnInfoInboundEncryptionKeyBits();

Default Value

0

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetConnInfoKexAlgorithm();

Unicode (Windows)
LPWSTR GetConnInfoKexAlgorithm();

char* secureblackbox_sshclient_getconninfokexalgorithm(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnInfoKexBits();

Unicode (Windows)
INT GetConnInfoKexBits();

int secureblackbox_sshclient_getconninfokexbits(void* lpObj);

int GetConnInfoKexBits();

Default Value

0

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetConnInfoKexLines();

Unicode (Windows)
LPWSTR GetConnInfoKexLines();

char* secureblackbox_sshclient_getconninfokexlines(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetConnInfoMacAlgorithmInbound();

Unicode (Windows)
LPWSTR GetConnInfoMacAlgorithmInbound();

char* secureblackbox_sshclient_getconninfomacalgorithminbound(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetConnInfoMacAlgorithmOutbound();

Unicode (Windows)
LPWSTR GetConnInfoMacAlgorithmOutbound();

char* secureblackbox_sshclient_getconninfomacalgorithmoutbound(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnInfoOutboundEncryptionKeyBits();

Unicode (Windows)
INT GetConnInfoOutboundEncryptionKeyBits();

int secureblackbox_sshclient_getconninfooutboundencryptionkeybits(void* lpObj);

int GetConnInfoOutboundEncryptionKeyBits();

Default Value

0

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetConnInfoPublicKeyAlgorithm();

Unicode (Windows)
LPWSTR GetConnInfoPublicKeyAlgorithm();

char* secureblackbox_sshclient_getconninfopublickeyalgorithm(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnInfoServerKeyBits();

Unicode (Windows)
INT GetConnInfoServerKeyBits();

int secureblackbox_sshclient_getconninfoserverkeybits(void* lpObj);

int GetConnInfoServerKeyBits();

Default Value

0

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetConnInfoServerKeyFingerprint();

Unicode (Windows)
LPWSTR GetConnInfoServerKeyFingerprint();

char* secureblackbox_sshclient_getconninfoserverkeyfingerprint(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetConnInfoServerSoftwareName();

Unicode (Windows)
LPWSTR GetConnInfoServerSoftwareName();

char* secureblackbox_sshclient_getconninfoserversoftwarename(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetConnInfoTotalBytesReceived();

Unicode (Windows)
LONG64 GetConnInfoTotalBytesReceived();

int64 secureblackbox_sshclient_getconninfototalbytesreceived(void* lpObj);

qint64 GetConnInfoTotalBytesReceived();

Default Value

0

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

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetConnInfoTotalBytesSent();

Unicode (Windows)
LONG64 GetConnInfoTotalBytesSent();

int64 secureblackbox_sshclient_getconninfototalbytessent(void* lpObj);

qint64 GetConnInfoTotalBytesSent();

Default Value

0

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnInfoVersion();

Unicode (Windows)
INT GetConnInfoVersion();

int secureblackbox_sshclient_getconninfoversion(void* lpObj);

int GetConnInfoVersion();

Default Value

2

Remarks

Specifies SSH protocol version.

This property is read-only.

Data Type

Integer

ExitMessage Property (SSHClient Class)

Contains the last commands exit message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExitMessage();

Unicode (Windows)
LPWSTR GetExitMessage();

char* secureblackbox_sshclient_getexitmessage(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExitSignal();

Unicode (Windows)
LPWSTR GetExitSignal();

char* secureblackbox_sshclient_getexitsignal(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetExitStatus();

Unicode (Windows)
INT GetExitStatus();

int secureblackbox_sshclient_getexitstatus(void* lpObj);

int GetExitStatus();

Default Value

0

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 an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExternalCryptoAsyncDocumentID();
int SetExternalCryptoAsyncDocumentID(const char* lpszExternalCryptoAsyncDocumentID);

Unicode (Windows)
LPWSTR GetExternalCryptoAsyncDocumentID();
INT SetExternalCryptoAsyncDocumentID(LPCWSTR lpszExternalCryptoAsyncDocumentID);

char* secureblackbox_sshclient_getexternalcryptoasyncdocumentid(void* lpObj);
int secureblackbox_sshclient_setexternalcryptoasyncdocumentid(void* lpObj, const char* lpszExternalCryptoAsyncDocumentID);

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

Default Value

""

Remarks

Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.

Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. On the completion stage, this value helps the signing component 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 the 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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExternalCryptoCustomParams();
int SetExternalCryptoCustomParams(const char* lpszExternalCryptoCustomParams);

Unicode (Windows)
LPWSTR GetExternalCryptoCustomParams();
INT SetExternalCryptoCustomParams(LPCWSTR lpszExternalCryptoCustomParams);

char* secureblackbox_sshclient_getexternalcryptocustomparams(void* lpObj);
int secureblackbox_sshclient_setexternalcryptocustomparams(void* lpObj, const char* lpszExternalCryptoCustomParams);

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExternalCryptoData();
int SetExternalCryptoData(const char* lpszExternalCryptoData);

Unicode (Windows)
LPWSTR GetExternalCryptoData();
INT SetExternalCryptoData(LPCWSTR lpszExternalCryptoData);

char* secureblackbox_sshclient_getexternalcryptodata(void* lpObj);
int secureblackbox_sshclient_setexternalcryptodata(void* lpObj, const char* lpszExternalCryptoData);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetExternalCryptoExternalHashCalculation();
int SetExternalCryptoExternalHashCalculation(int bExternalCryptoExternalHashCalculation);

Unicode (Windows)
BOOL GetExternalCryptoExternalHashCalculation();
INT SetExternalCryptoExternalHashCalculation(BOOL bExternalCryptoExternalHashCalculation);

int secureblackbox_sshclient_getexternalcryptoexternalhashcalculation(void* lpObj);
int secureblackbox_sshclient_setexternalcryptoexternalhashcalculation(void* lpObj, int bExternalCryptoExternalHashCalculation);

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 the DCAuth class.

If set to true, the class will pass a few kilobytes of to-be-signed data from the document to the OnExternalSign event. This only applies when SignExternal() is called.

Data Type

Boolean

ExternalCryptoHashAlgorithm Property (SSHClient Class)

Specifies the request's signature hash algorithm.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExternalCryptoHashAlgorithm();
int SetExternalCryptoHashAlgorithm(const char* lpszExternalCryptoHashAlgorithm);

Unicode (Windows)
LPWSTR GetExternalCryptoHashAlgorithm();
INT SetExternalCryptoHashAlgorithm(LPCWSTR lpszExternalCryptoHashAlgorithm);

char* secureblackbox_sshclient_getexternalcryptohashalgorithm(void* lpObj);
int secureblackbox_sshclient_setexternalcryptohashalgorithm(void* lpObj, const char* lpszExternalCryptoHashAlgorithm);

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

Default Value

"SHA256"

Remarks

Specifies the request's signature hash algorithm.

Data Type

String

ExternalCryptoKeyID Property (SSHClient Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExternalCryptoKeyID();
int SetExternalCryptoKeyID(const char* lpszExternalCryptoKeyID);

Unicode (Windows)
LPWSTR GetExternalCryptoKeyID();
INT SetExternalCryptoKeyID(LPCWSTR lpszExternalCryptoKeyID);

char* secureblackbox_sshclient_getexternalcryptokeyid(void* lpObj);
int secureblackbox_sshclient_setexternalcryptokeyid(void* lpObj, const char* lpszExternalCryptoKeyID);

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 an extra protection layer for the protocol and diminishes the risk of the 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:

 
 Copy
  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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExternalCryptoKeySecret();
int SetExternalCryptoKeySecret(const char* lpszExternalCryptoKeySecret);

Unicode (Windows)
LPWSTR GetExternalCryptoKeySecret();
INT SetExternalCryptoKeySecret(LPCWSTR lpszExternalCryptoKeySecret);

char* secureblackbox_sshclient_getexternalcryptokeysecret(void* lpObj);
int secureblackbox_sshclient_setexternalcryptokeysecret(void* lpObj, const char* lpszExternalCryptoKeySecret);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetExternalCryptoMethod();
int SetExternalCryptoMethod(int iExternalCryptoMethod);

Unicode (Windows)
INT GetExternalCryptoMethod();
INT SetExternalCryptoMethod(INT iExternalCryptoMethod);

ASMD_PKCS1(0), 
ASMD_PKCS7(1)

int secureblackbox_sshclient_getexternalcryptomethod(void* lpObj);
int secureblackbox_sshclient_setexternalcryptomethod(void* lpObj, int iExternalCryptoMethod);

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

Default Value

0

Remarks

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

Available options:

Data Type

Integer

ExternalCryptoMode Property (SSHClient Class)

Specifies the external cryptography mode.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetExternalCryptoMode();
int SetExternalCryptoMode(int iExternalCryptoMode);

Unicode (Windows)
INT GetExternalCryptoMode();
INT SetExternalCryptoMode(INT iExternalCryptoMode);

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

int secureblackbox_sshclient_getexternalcryptomode(void* lpObj);
int secureblackbox_sshclient_setexternalcryptomode(void* lpObj, int iExternalCryptoMode);

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

Default Value

0

Remarks

Specifies the external cryptography mode.

Available options:

This property is not available at design time.

Data Type

Integer

ExternalCryptoPublicKeyAlgorithm Property (SSHClient Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExternalCryptoPublicKeyAlgorithm();
int SetExternalCryptoPublicKeyAlgorithm(const char* lpszExternalCryptoPublicKeyAlgorithm);

Unicode (Windows)
LPWSTR GetExternalCryptoPublicKeyAlgorithm();
INT SetExternalCryptoPublicKeyAlgorithm(LPCWSTR lpszExternalCryptoPublicKeyAlgorithm);

char* secureblackbox_sshclient_getexternalcryptopublickeyalgorithm(void* lpObj);
int secureblackbox_sshclient_setexternalcryptopublickeyalgorithm(void* lpObj, const char* lpszExternalCryptoPublicKeyAlgorithm);

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

Default Value

""

Remarks

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

Data Type

String

FIPSMode Property (SSHClient Class)

Reserved.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFIPSMode();
int SetFIPSMode(int bFIPSMode);

Unicode (Windows)
BOOL GetFIPSMode();
INT SetFIPSMode(BOOL bFIPSMode);

int secureblackbox_sshclient_getfipsmode(void* lpObj);
int secureblackbox_sshclient_setfipsmode(void* lpObj, int bFIPSMode);

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetKeyFingerprintSHA1();

Unicode (Windows)
LPWSTR GetKeyFingerprintSHA1();

char* secureblackbox_sshclient_getkeyfingerprintsha1(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetKeyFingerprintSHA256();

Unicode (Windows)
LPWSTR GetKeyFingerprintSHA256();

char* secureblackbox_sshclient_getkeyfingerprintsha256(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetKeyHandle();
int SetKeyHandle(int64 lKeyHandle);

Unicode (Windows)
LONG64 GetKeyHandle();
INT SetKeyHandle(LONG64 lKeyHandle);

int64 secureblackbox_sshclient_getkeyhandle(void* lpObj);
int secureblackbox_sshclient_setkeyhandle(void* lpObj, int64 lKeyHandle);

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

Default Value

0

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.

 
 Copy
  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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPassword();
int SetPassword(const char* lpszPassword);

Unicode (Windows)
LPWSTR GetPassword();
INT SetPassword(LPCWSTR lpszPassword);

char* secureblackbox_sshclient_getpassword(void* lpObj);
int secureblackbox_sshclient_setpassword(void* lpObj, const char* lpszPassword);

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxySettingsAddress();
int SetProxySettingsAddress(const char* lpszProxySettingsAddress);

Unicode (Windows)
LPWSTR GetProxySettingsAddress();
INT SetProxySettingsAddress(LPCWSTR lpszProxySettingsAddress);

char* secureblackbox_sshclient_getproxysettingsaddress(void* lpObj);
int secureblackbox_sshclient_setproxysettingsaddress(void* lpObj, const char* lpszProxySettingsAddress);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxySettingsAuthentication();
int SetProxySettingsAuthentication(int iProxySettingsAuthentication);

Unicode (Windows)
INT GetProxySettingsAuthentication();
INT SetProxySettingsAuthentication(INT iProxySettingsAuthentication);

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

int secureblackbox_sshclient_getproxysettingsauthentication(void* lpObj);
int secureblackbox_sshclient_setproxysettingsauthentication(void* lpObj, int iProxySettingsAuthentication);

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

Default Value

0

Remarks

The authentication type used by the proxy server.

Data Type

Integer

ProxySettingsPassword Property (SSHClient Class)

The password to authenticate to the proxy server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxySettingsPassword();
int SetProxySettingsPassword(const char* lpszProxySettingsPassword);

Unicode (Windows)
LPWSTR GetProxySettingsPassword();
INT SetProxySettingsPassword(LPCWSTR lpszProxySettingsPassword);

char* secureblackbox_sshclient_getproxysettingspassword(void* lpObj);
int secureblackbox_sshclient_setproxysettingspassword(void* lpObj, const char* lpszProxySettingsPassword);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxySettingsPort();
int SetProxySettingsPort(int iProxySettingsPort);

Unicode (Windows)
INT GetProxySettingsPort();
INT SetProxySettingsPort(INT iProxySettingsPort);

int secureblackbox_sshclient_getproxysettingsport(void* lpObj);
int secureblackbox_sshclient_setproxysettingsport(void* lpObj, int iProxySettingsPort);

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

Default Value

0

Remarks

The port on the proxy server to connect to.

Data Type

Integer

ProxySettingsProxyType Property (SSHClient Class)

The type of the proxy server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxySettingsProxyType();
int SetProxySettingsProxyType(int iProxySettingsProxyType);

Unicode (Windows)
INT GetProxySettingsProxyType();
INT SetProxySettingsProxyType(INT iProxySettingsProxyType);

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

int secureblackbox_sshclient_getproxysettingsproxytype(void* lpObj);
int secureblackbox_sshclient_setproxysettingsproxytype(void* lpObj, int iProxySettingsProxyType);

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

Default Value

0

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.

Data Type

Integer

ProxySettingsRequestHeaders Property (SSHClient Class)

Contains HTTP request headers for WebTunnel and HTTP proxy.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxySettingsRequestHeaders();
int SetProxySettingsRequestHeaders(const char* lpszProxySettingsRequestHeaders);

Unicode (Windows)
LPWSTR GetProxySettingsRequestHeaders();
INT SetProxySettingsRequestHeaders(LPCWSTR lpszProxySettingsRequestHeaders);

char* secureblackbox_sshclient_getproxysettingsrequestheaders(void* lpObj);
int secureblackbox_sshclient_setproxysettingsrequestheaders(void* lpObj, const char* lpszProxySettingsRequestHeaders);

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxySettingsResponseBody();
int SetProxySettingsResponseBody(const char* lpszProxySettingsResponseBody);

Unicode (Windows)
LPWSTR GetProxySettingsResponseBody();
INT SetProxySettingsResponseBody(LPCWSTR lpszProxySettingsResponseBody);

char* secureblackbox_sshclient_getproxysettingsresponsebody(void* lpObj);
int secureblackbox_sshclient_setproxysettingsresponsebody(void* lpObj, const char* lpszProxySettingsResponseBody);

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxySettingsResponseHeaders();
int SetProxySettingsResponseHeaders(const char* lpszProxySettingsResponseHeaders);

Unicode (Windows)
LPWSTR GetProxySettingsResponseHeaders();
INT SetProxySettingsResponseHeaders(LPCWSTR lpszProxySettingsResponseHeaders);

char* secureblackbox_sshclient_getproxysettingsresponseheaders(void* lpObj);
int secureblackbox_sshclient_setproxysettingsresponseheaders(void* lpObj, const char* lpszProxySettingsResponseHeaders);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxySettingsUseIPv6();
int SetProxySettingsUseIPv6(int bProxySettingsUseIPv6);

Unicode (Windows)
BOOL GetProxySettingsUseIPv6();
INT SetProxySettingsUseIPv6(BOOL bProxySettingsUseIPv6);

int secureblackbox_sshclient_getproxysettingsuseipv6(void* lpObj);
int secureblackbox_sshclient_setproxysettingsuseipv6(void* lpObj, int bProxySettingsUseIPv6);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxySettingsUseProxy();
int SetProxySettingsUseProxy(int bProxySettingsUseProxy);

Unicode (Windows)
BOOL GetProxySettingsUseProxy();
INT SetProxySettingsUseProxy(BOOL bProxySettingsUseProxy);

int secureblackbox_sshclient_getproxysettingsuseproxy(void* lpObj);
int secureblackbox_sshclient_setproxysettingsuseproxy(void* lpObj, int bProxySettingsUseProxy);

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxySettingsUsername();
int SetProxySettingsUsername(const char* lpszProxySettingsUsername);

Unicode (Windows)
LPWSTR GetProxySettingsUsername();
INT SetProxySettingsUsername(LPCWSTR lpszProxySettingsUsername);

char* secureblackbox_sshclient_getproxysettingsusername(void* lpObj);
int secureblackbox_sshclient_setproxysettingsusername(void* lpObj, const char* lpszProxySettingsUsername);

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetServerKeyAlgorithm();

Unicode (Windows)
LPWSTR GetServerKeyAlgorithm();

char* secureblackbox_sshclient_getserverkeyalgorithm(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetServerKeyBits();

Unicode (Windows)
INT GetServerKeyBits();

int secureblackbox_sshclient_getserverkeybits(void* lpObj);

int GetServerKeyBits();

Default Value

0

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetServerKeyComment();

Unicode (Windows)
LPWSTR GetServerKeyComment();

char* secureblackbox_sshclient_getserverkeycomment(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetServerKeyCurve();

Unicode (Windows)
LPWSTR GetServerKeyCurve();

char* secureblackbox_sshclient_getserverkeycurve(void* lpObj);

QString GetServerKeyCurve();

Default Value

""

Remarks

Specifies the elliptical curve when EC cryptography is used.

This property is read-only.

Data Type

String

ServerKeyDSSG Property (SSHClient Class)

The G (Generator) parameter of the DSS signature key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetServerKeyDSSG(char* &lpServerKeyDSSG, int &lenServerKeyDSSG);

Unicode (Windows)
INT GetServerKeyDSSG(LPSTR &lpServerKeyDSSG, INT &lenServerKeyDSSG);

int secureblackbox_sshclient_getserverkeydssg(void* lpObj, char** lpServerKeyDSSG, int* lenServerKeyDSSG);

QByteArray GetServerKeyDSSG();

Remarks

The G (Generator) parameter of the DSS signature key. The string should contain the binary data of G.

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

Data Type

Byte Array

ServerKeyDSSP Property (SSHClient Class)

The P (Prime) parameter of the DSS signature key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetServerKeyDSSP(char* &lpServerKeyDSSP, int &lenServerKeyDSSP);

Unicode (Windows)
INT GetServerKeyDSSP(LPSTR &lpServerKeyDSSP, INT &lenServerKeyDSSP);

int secureblackbox_sshclient_getserverkeydssp(void* lpObj, char** lpServerKeyDSSP, int* lenServerKeyDSSP);

QByteArray GetServerKeyDSSP();

Remarks

The P (Prime) parameter of the DSS signature key. The string should contain the binary data of P.

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

Data Type

Byte Array

ServerKeyDSSQ Property (SSHClient Class)

The Q (Prime Factor) parameter of the DSS signature key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetServerKeyDSSQ(char* &lpServerKeyDSSQ, int &lenServerKeyDSSQ);

Unicode (Windows)
INT GetServerKeyDSSQ(LPSTR &lpServerKeyDSSQ, INT &lenServerKeyDSSQ);

int secureblackbox_sshclient_getserverkeydssq(void* lpObj, char** lpServerKeyDSSQ, int* lenServerKeyDSSQ);

QByteArray GetServerKeyDSSQ();

Remarks

The Q (Prime Factor) parameter of the DSS signature key. The string should contain the binary data of Q.

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

Data Type

Byte Array

ServerKeyDSSX Property (SSHClient Class)

The X (Private key) parameter of the DSS signature key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetServerKeyDSSX(char* &lpServerKeyDSSX, int &lenServerKeyDSSX);

Unicode (Windows)
INT GetServerKeyDSSX(LPSTR &lpServerKeyDSSX, INT &lenServerKeyDSSX);

int secureblackbox_sshclient_getserverkeydssx(void* lpObj, char** lpServerKeyDSSX, int* lenServerKeyDSSX);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetServerKeyDSSY(char* &lpServerKeyDSSY, int &lenServerKeyDSSY);

Unicode (Windows)
INT GetServerKeyDSSY(LPSTR &lpServerKeyDSSY, INT &lenServerKeyDSSY);

int secureblackbox_sshclient_getserverkeydssy(void* lpObj, char** lpServerKeyDSSY, int* lenServerKeyDSSY);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetServerKeyECCD(char* &lpServerKeyECCD, int &lenServerKeyECCD);

Unicode (Windows)
INT GetServerKeyECCD(LPSTR &lpServerKeyECCD, INT &lenServerKeyECCD);

int secureblackbox_sshclient_getserverkeyeccd(void* lpObj, char** lpServerKeyECCD, int* lenServerKeyECCD);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetServerKeyECCQX(char* &lpServerKeyECCQX, int &lenServerKeyECCQX);

Unicode (Windows)
INT GetServerKeyECCQX(LPSTR &lpServerKeyECCQX, INT &lenServerKeyECCQX);

int secureblackbox_sshclient_getserverkeyeccqx(void* lpObj, char** lpServerKeyECCQX, int* lenServerKeyECCQX);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetServerKeyECCQY(char* &lpServerKeyECCQY, int &lenServerKeyECCQY);

Unicode (Windows)
INT GetServerKeyECCQY(LPSTR &lpServerKeyECCQY, INT &lenServerKeyECCQY);

int secureblackbox_sshclient_getserverkeyeccqy(void* lpObj, char** lpServerKeyECCQY, int* lenServerKeyECCQY);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetServerKeyEdPrivate(char* &lpServerKeyEdPrivate, int &lenServerKeyEdPrivate);

Unicode (Windows)
INT GetServerKeyEdPrivate(LPSTR &lpServerKeyEdPrivate, INT &lenServerKeyEdPrivate);

int secureblackbox_sshclient_getserverkeyedprivate(void* lpObj, char** lpServerKeyEdPrivate, int* lenServerKeyEdPrivate);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetServerKeyEdPublic(char* &lpServerKeyEdPublic, int &lenServerKeyEdPublic);

Unicode (Windows)
INT GetServerKeyEdPublic(LPSTR &lpServerKeyEdPublic, INT &lenServerKeyEdPublic);

int secureblackbox_sshclient_getserverkeyedpublic(void* lpObj, char** lpServerKeyEdPublic, int* lenServerKeyEdPublic);

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetServerKeyFingerprintMD5();

Unicode (Windows)
LPWSTR GetServerKeyFingerprintMD5();

char* secureblackbox_sshclient_getserverkeyfingerprintmd5(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetServerKeyFingerprintSHA1();

Unicode (Windows)
LPWSTR GetServerKeyFingerprintSHA1();

char* secureblackbox_sshclient_getserverkeyfingerprintsha1(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetServerKeyFingerprintSHA256();

Unicode (Windows)
LPWSTR GetServerKeyFingerprintSHA256();

char* secureblackbox_sshclient_getserverkeyfingerprintsha256(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetServerKeyHandle();

Unicode (Windows)
LONG64 GetServerKeyHandle();

int64 secureblackbox_sshclient_getserverkeyhandle(void* lpObj);

qint64 GetServerKeyHandle();

Default Value

0

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.

 
 Copy
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetServerKeyIsExtractable();

Unicode (Windows)
BOOL GetServerKeyIsExtractable();

int secureblackbox_sshclient_getserverkeyisextractable(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetServerKeyIsPrivate();

Unicode (Windows)
BOOL GetServerKeyIsPrivate();

int secureblackbox_sshclient_getserverkeyisprivate(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetServerKeyIsPublic();

Unicode (Windows)
BOOL GetServerKeyIsPublic();

int secureblackbox_sshclient_getserverkeyispublic(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetServerKeyKDFRounds();

Unicode (Windows)
INT GetServerKeyKDFRounds();

int secureblackbox_sshclient_getserverkeykdfrounds(void* lpObj);

int GetServerKeyKDFRounds();

Default Value

0

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetServerKeyKDFSalt(char* &lpServerKeyKDFSalt, int &lenServerKeyKDFSalt);

Unicode (Windows)
INT GetServerKeyKDFSalt(LPSTR &lpServerKeyKDFSalt, INT &lenServerKeyKDFSalt);

int secureblackbox_sshclient_getserverkeykdfsalt(void* lpObj, char** lpServerKeyKDFSalt, int* lenServerKeyKDFSalt);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetServerKeyKeyFormat();

Unicode (Windows)
INT GetServerKeyKeyFormat();

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), 
CKF_PU_TTY3(9)

int secureblackbox_sshclient_getserverkeykeyformat(void* lpObj);

int GetServerKeyKeyFormat();

Default Value

0

Remarks

Specifies the format in which the key is stored.

This property is read-only.

Data Type

Integer

ServerKeyKeyProtectionAlgorithm Property (SSHClient Class)

Specifies the key protection algorithm.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetServerKeyKeyProtectionAlgorithm();

Unicode (Windows)
LPWSTR GetServerKeyKeyProtectionAlgorithm();

char* secureblackbox_sshclient_getserverkeykeyprotectionalgorithm(void* lpObj);

QString GetServerKeyKeyProtectionAlgorithm();

Default Value

""

Remarks

Specifies the key protection algorithm.

This property is read-only.

Data Type

String

ServerKeyRSAExponent Property (SSHClient Class)

Returns the e parameter (public exponent) of the RSA key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetServerKeyRSAExponent(char* &lpServerKeyRSAExponent, int &lenServerKeyRSAExponent);

Unicode (Windows)
INT GetServerKeyRSAExponent(LPSTR &lpServerKeyRSAExponent, INT &lenServerKeyRSAExponent);

int secureblackbox_sshclient_getserverkeyrsaexponent(void* lpObj, char** lpServerKeyRSAExponent, int* lenServerKeyRSAExponent);

QByteArray GetServerKeyRSAExponent();

Remarks

Returns the e parameter (public exponent) of the RSA key.

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

Data Type

Byte Array

ServerKeyRSAIQMP Property (SSHClient Class)

Returns the iqmp parameter of the RSA key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetServerKeyRSAIQMP(char* &lpServerKeyRSAIQMP, int &lenServerKeyRSAIQMP);

Unicode (Windows)
INT GetServerKeyRSAIQMP(LPSTR &lpServerKeyRSAIQMP, INT &lenServerKeyRSAIQMP);

int secureblackbox_sshclient_getserverkeyrsaiqmp(void* lpObj, char** lpServerKeyRSAIQMP, int* lenServerKeyRSAIQMP);

QByteArray GetServerKeyRSAIQMP();

Remarks

Returns the iqmp parameter of the RSA key.

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

Data Type

Byte Array

ServerKeyRSAModulus Property (SSHClient Class)

Returns the m parameter (public modulus) of the RSA key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetServerKeyRSAModulus(char* &lpServerKeyRSAModulus, int &lenServerKeyRSAModulus);

Unicode (Windows)
INT GetServerKeyRSAModulus(LPSTR &lpServerKeyRSAModulus, INT &lenServerKeyRSAModulus);

int secureblackbox_sshclient_getserverkeyrsamodulus(void* lpObj, char** lpServerKeyRSAModulus, int* lenServerKeyRSAModulus);

QByteArray GetServerKeyRSAModulus();

Remarks

Returns the m parameter (public modulus) of the RSA key.

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

Data Type

Byte Array

ServerKeyRSAP Property (SSHClient Class)

Returns the p parameter (first factor of the common modulus n) of the RSA key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetServerKeyRSAP(char* &lpServerKeyRSAP, int &lenServerKeyRSAP);

Unicode (Windows)
INT GetServerKeyRSAP(LPSTR &lpServerKeyRSAP, INT &lenServerKeyRSAP);

int secureblackbox_sshclient_getserverkeyrsap(void* lpObj, char** lpServerKeyRSAP, int* lenServerKeyRSAP);

QByteArray GetServerKeyRSAP();

Remarks

Returns the p parameter (first factor of the common modulus n) of the RSA key.

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

Data Type

Byte Array

ServerKeyRSAPrivateExponent Property (SSHClient Class)

Returns the d parameter (private exponent) of the RSA key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetServerKeyRSAPrivateExponent(char* &lpServerKeyRSAPrivateExponent, int &lenServerKeyRSAPrivateExponent);

Unicode (Windows)
INT GetServerKeyRSAPrivateExponent(LPSTR &lpServerKeyRSAPrivateExponent, INT &lenServerKeyRSAPrivateExponent);

int secureblackbox_sshclient_getserverkeyrsaprivateexponent(void* lpObj, char** lpServerKeyRSAPrivateExponent, int* lenServerKeyRSAPrivateExponent);

QByteArray GetServerKeyRSAPrivateExponent();

Remarks

Returns the d parameter (private exponent) of the RSA key.

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

Data Type

Byte Array

ServerKeyRSAQ Property (SSHClient Class)

Returns the q parameter (second factor of the common modulus n) of the RSA key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetServerKeyRSAQ(char* &lpServerKeyRSAQ, int &lenServerKeyRSAQ);

Unicode (Windows)
INT GetServerKeyRSAQ(LPSTR &lpServerKeyRSAQ, INT &lenServerKeyRSAQ);

int secureblackbox_sshclient_getserverkeyrsaq(void* lpObj, char** lpServerKeyRSAQ, int* lenServerKeyRSAQ);

QByteArray GetServerKeyRSAQ();

Remarks

Returns the q parameter (second factor of the common modulus n) of the RSA key.

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

Data Type

Byte Array

ServerKeySubject Property (SSHClient Class)

Specifies the public key owner (subject).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetServerKeySubject();

Unicode (Windows)
LPWSTR GetServerKeySubject();

char* secureblackbox_sshclient_getserverkeysubject(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSocketDNSMode();
int SetSocketDNSMode(int iSocketDNSMode);

Unicode (Windows)
INT GetSocketDNSMode();
INT SetSocketDNSMode(INT iSocketDNSMode);

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

int secureblackbox_sshclient_getsocketdnsmode(void* lpObj);
int secureblackbox_sshclient_setsocketdnsmode(void* lpObj, int iSocketDNSMode);

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

Default Value

0

Remarks

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

Data Type

Integer

SocketDNSPort Property (SSHClient Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSocketDNSPort();
int SetSocketDNSPort(int iSocketDNSPort);

Unicode (Windows)
INT GetSocketDNSPort();
INT SetSocketDNSPort(INT iSocketDNSPort);

int secureblackbox_sshclient_getsocketdnsport(void* lpObj);
int secureblackbox_sshclient_setsocketdnsport(void* lpObj, int iSocketDNSPort);

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

Default Value

0

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSocketDNSQueryTimeout();
int SetSocketDNSQueryTimeout(int iSocketDNSQueryTimeout);

Unicode (Windows)
INT GetSocketDNSQueryTimeout();
INT SetSocketDNSQueryTimeout(INT iSocketDNSQueryTimeout);

int secureblackbox_sshclient_getsocketdnsquerytimeout(void* lpObj);
int secureblackbox_sshclient_setsocketdnsquerytimeout(void* lpObj, int iSocketDNSQueryTimeout);

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

Default Value

0

Remarks

The timeout (in milliseconds) for each DNS query. The value of 0 indicates an 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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSocketDNSServers();
int SetSocketDNSServers(const char* lpszSocketDNSServers);

Unicode (Windows)
LPWSTR GetSocketDNSServers();
INT SetSocketDNSServers(LPCWSTR lpszSocketDNSServers);

char* secureblackbox_sshclient_getsocketdnsservers(void* lpObj);
int secureblackbox_sshclient_setsocketdnsservers(void* lpObj, const char* lpszSocketDNSServers);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSocketDNSTotalTimeout();
int SetSocketDNSTotalTimeout(int iSocketDNSTotalTimeout);

Unicode (Windows)
INT GetSocketDNSTotalTimeout();
INT SetSocketDNSTotalTimeout(INT iSocketDNSTotalTimeout);

int secureblackbox_sshclient_getsocketdnstotaltimeout(void* lpObj);
int secureblackbox_sshclient_setsocketdnstotaltimeout(void* lpObj, int iSocketDNSTotalTimeout);

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

Default Value

0

Remarks

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

Data Type

Integer

SocketIncomingSpeedLimit Property (SSHClient Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSocketIncomingSpeedLimit();
int SetSocketIncomingSpeedLimit(int iSocketIncomingSpeedLimit);

Unicode (Windows)
INT GetSocketIncomingSpeedLimit();
INT SetSocketIncomingSpeedLimit(INT iSocketIncomingSpeedLimit);

int secureblackbox_sshclient_getsocketincomingspeedlimit(void* lpObj);
int secureblackbox_sshclient_setsocketincomingspeedlimit(void* lpObj, int iSocketIncomingSpeedLimit);

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

Default Value

0

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSocketLocalAddress();
int SetSocketLocalAddress(const char* lpszSocketLocalAddress);

Unicode (Windows)
LPWSTR GetSocketLocalAddress();
INT SetSocketLocalAddress(LPCWSTR lpszSocketLocalAddress);

char* secureblackbox_sshclient_getsocketlocaladdress(void* lpObj);
int secureblackbox_sshclient_setsocketlocaladdress(void* lpObj, const char* lpszSocketLocalAddress);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSocketLocalPort();
int SetSocketLocalPort(int iSocketLocalPort);

Unicode (Windows)
INT GetSocketLocalPort();
INT SetSocketLocalPort(INT iSocketLocalPort);

int secureblackbox_sshclient_getsocketlocalport(void* lpObj);
int secureblackbox_sshclient_setsocketlocalport(void* lpObj, int iSocketLocalPort);

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

Default Value

0

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSocketOutgoingSpeedLimit();
int SetSocketOutgoingSpeedLimit(int iSocketOutgoingSpeedLimit);

Unicode (Windows)
INT GetSocketOutgoingSpeedLimit();
INT SetSocketOutgoingSpeedLimit(INT iSocketOutgoingSpeedLimit);

int secureblackbox_sshclient_getsocketoutgoingspeedlimit(void* lpObj);
int secureblackbox_sshclient_setsocketoutgoingspeedlimit(void* lpObj, int iSocketOutgoingSpeedLimit);

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

Default Value

0

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSocketTimeout();
int SetSocketTimeout(int iSocketTimeout);

Unicode (Windows)
INT GetSocketTimeout();
INT SetSocketTimeout(INT iSocketTimeout);

int secureblackbox_sshclient_getsockettimeout(void* lpObj);
int secureblackbox_sshclient_setsockettimeout(void* lpObj, int iSocketTimeout);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSocketUseIPv6();
int SetSocketUseIPv6(int bSocketUseIPv6);

Unicode (Windows)
BOOL GetSocketUseIPv6();
INT SetSocketUseIPv6(BOOL bSocketUseIPv6);

int secureblackbox_sshclient_getsocketuseipv6(void* lpObj);
int secureblackbox_sshclient_setsocketuseipv6(void* lpObj, int bSocketUseIPv6);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSHSettingsAutoAdjustCiphers();
int SetSSHSettingsAutoAdjustCiphers(int bSSHSettingsAutoAdjustCiphers);

Unicode (Windows)
BOOL GetSSHSettingsAutoAdjustCiphers();
INT SetSSHSettingsAutoAdjustCiphers(BOOL bSSHSettingsAutoAdjustCiphers);