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.


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.
ConnectionInfo	Contains the secure connection info.
ExitMessage	Contains the last commands exit message.
ExitSignal	Contains the last commands exit signal.
ExitStatus	Contains the last commands exit status.
ExternalCrypto	Provides access to external signing and DC parameters.
FIPSMode	Reserved.
Key	Contains client's SSH key.
Password	Specifies user's password on the server.
Proxy	Allows connection through a proxy server.
ServerKey	Returns server's public key.
SocketSettings	Manages network connection settings.
SSHSettings	Provides access to SSH connection settings.
Subsystem	Specifies the subsystem to request from the server.
Terminal	Provides access to SSH terminal settings object.
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.
Reset	Resets the class settings.
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.

Config Settings

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


AllAlgorithms	Returns the list of algorithms enabled in the class.
BlockSize	The data block size.
CommandTimeout	Specifies the command timeout.
CompressionAlgorithms	Returns the list of compression algorithms enabled in the class.
EarlyIdString	Enables the proactive approach to SSH handshake.
EncryptionAlgorithms	Returns the list of encryption algorithms enabled in the class.
ErrorOrigin	Specifies whether the error is local or remote.
ErrorSeverity	Specifies whether the error is fatal.
KexAlgorithms	Returns the list of key exchange algorithms enabled in the class.
LocalCharset	Charset used on the client machine.
MacAlgorithms	Returns the list of MAC algorithms enabled in the class.
PublicKeyAlgorithms	Returns the list of public key algorithms enabled in the class.
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.
UseStrictKeyExchange	Specifies how strict key exchange is supported.
ASN1UseGlobalTagCache	Controls whether ASN.1 module should use a global object cache.
AssignSystemSmartCardPins	Specifies whether CSP-level PINs should be assigned to CNG keys.
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.
DefDeriveKeyIterations	Specifies the default key derivation algorithm iteration count.
DNSLocalSuffix	The suffix to assign for TLD names.
EnableClientSideSSLFFDHE	Enables or disables finite field DHE key exchange support in TLS clients.
GlobalCookies	Gets or sets global cookies for all the HTTP transports.
HardwareCryptoUsePolicy	The hardware crypto usage policy.
HttpUserAgent	Specifies the user agent name to be used by all HTTP clients.
HttpVersion	The HTTP version to use in any inner HTTP client classes created.
IgnoreExpiredMSCTLSigningCert	Whether to tolerate the expired Windows Update signing certificate.
ListDelimiter	The delimiter character for multi-element lists.
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.
OldClientSideRSAFallback	Specifies whether the SSH client should use a SHA1 fallback.
PKICache	Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached.
PKICachePath	Specifies the file system path where cached PKI data is stored.
ProductVersion	Returns the version of the SecureBlackbox library.
ServerSSLDHKeyLength	Sets the size of the TLS DHE key exchange group.
StaticDNS	Specifies whether static DNS rules should be used.
StaticIPAddress[domain]	Gets or sets an IP address for the specified domain name.
StaticIPAddresses	Gets or sets all the static DNS rules.
Tag	Allows to store any custom data.
TLSSessionGroup	Specifies the group name of TLS sessions to be used for session resumption.
TLSSessionLifetime	Specifies lifetime in seconds of the cached TLS session.
TLSSessionPurgeInterval	Specifies how often the session cache should remove the expired TLS sessions.
UseCRLObjectCaching	Specifies whether reuse of loaded CRL objects is enabled.
UseInternalRandom	Switches between SecureBlackbox-own and platform PRNGs.
UseLegacyAdESValidation	Enables legacy AdES validation mode.
UseOCSPResponseObjectCaching	Specifies whether reuse of loaded OCSP response objects is enabled.
UseOwnDNSResolver	Specifies whether the client classes should use own DNS resolver.
UseSharedSystemStorages	Specifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemNativeSizeCalculation	An internal CryptoAPI access tweak.
UseSystemOAEPAndPSS	Enforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandom	Enables or disables the use of the OS PRNG.
XMLRDNDescriptorName[OID]	Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN.
XMLRDNDescriptorPriority[OID]	Specifies the priority of descriptor names associated with a specific OID.
XMLRDNDescriptorReverseOrder	Specifies whether to reverse the order of descriptors in RDN.
XMLRDNDescriptorSeparator	Specifies the separator used between descriptors in RDN.

AsyncMode Property (SSHClient Class)

Controls the SSH clients mode of work.

Syntax

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

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

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

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

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

ConnectionInfo Property (SSHClient Class)

Contains the secure connection info.

Syntax

SecureBlackboxSSHConnectionInfo* GetConnectionInfo();

char* secureblackbox_sshclient_getconninfoclientkeyalgorithm(void* lpObj);

int secureblackbox_sshclient_getconninfoclientkeybits(void* lpObj);

char* secureblackbox_sshclient_getconninfoclientkeyfingerprint(void* lpObj);

char* secureblackbox_sshclient_getconninfoclosereason(void* lpObj);

char* secureblackbox_sshclient_getconninfocompressionalgorithminbound(void* lpObj);

char* secureblackbox_sshclient_getconninfocompressionalgorithmoutbound(void* lpObj);

char* secureblackbox_sshclient_getconninfoencryptionalgorithminbound(void* lpObj);

char* secureblackbox_sshclient_getconninfoencryptionalgorithmoutbound(void* lpObj);

int secureblackbox_sshclient_getconninfoinboundencryptionkeybits(void* lpObj);

char* secureblackbox_sshclient_getconninfokexalgorithm(void* lpObj);

int secureblackbox_sshclient_getconninfokexbits(void* lpObj);

char* secureblackbox_sshclient_getconninfokexlines(void* lpObj);

char* secureblackbox_sshclient_getconninfomacalgorithminbound(void* lpObj);

char* secureblackbox_sshclient_getconninfomacalgorithmoutbound(void* lpObj);

int secureblackbox_sshclient_getconninfooutboundencryptionkeybits(void* lpObj);

char* secureblackbox_sshclient_getconninfopublickeyalgorithm(void* lpObj);

char* secureblackbox_sshclient_getconninforemoteaddress(void* lpObj);

int secureblackbox_sshclient_getconninforemoteport(void* lpObj);

char* secureblackbox_sshclient_getconninfoserverkeyalgorithm(void* lpObj);

int secureblackbox_sshclient_getconninfoserverkeybits(void* lpObj);

char* secureblackbox_sshclient_getconninfoserverkeyfingerprint(void* lpObj);

char* secureblackbox_sshclient_getconninfoserversoftwarename(void* lpObj);

int64 secureblackbox_sshclient_getconninfototalbytesreceived(void* lpObj);

int64 secureblackbox_sshclient_getconninfototalbytessent(void* lpObj);

int secureblackbox_sshclient_getconninfoversion(void* lpObj);

QString GetConnInfoClientKeyAlgorithm();

int GetConnInfoClientKeyBits();

QString GetConnInfoClientKeyFingerprint();

QString GetConnInfoCloseReason();

QString GetConnInfoCompressionAlgorithmInbound();

QString GetConnInfoCompressionAlgorithmOutbound();

QString GetConnInfoEncryptionAlgorithmInbound();

QString GetConnInfoEncryptionAlgorithmOutbound();

int GetConnInfoInboundEncryptionKeyBits();

QString GetConnInfoKexAlgorithm();

int GetConnInfoKexBits();

QString GetConnInfoKexLines();

QString GetConnInfoMacAlgorithmInbound();

QString GetConnInfoMacAlgorithmOutbound();

int GetConnInfoOutboundEncryptionKeyBits();

QString GetConnInfoPublicKeyAlgorithm();

QString GetConnInfoRemoteAddress();

int GetConnInfoRemotePort();

QString GetConnInfoServerKeyAlgorithm();

int GetConnInfoServerKeyBits();

QString GetConnInfoServerKeyFingerprint();

QString GetConnInfoServerSoftwareName();

qint64 GetConnInfoTotalBytesReceived();

qint64 GetConnInfoTotalBytesSent();

int GetConnInfoVersion();

Remarks

This property contains various information about the secure connection.

This property is read-only.

Data Type

SecureBlackboxSSHConnectionInfo

ExitMessage Property (SSHClient Class)

Contains the last commands exit message.

Syntax

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

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

ANSI (Cross Platform)
int GetExitStatus();

Unicode (Windows)
INT GetExitStatus();

int secureblackbox_sshclient_getexitstatus(void* lpObj);

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

ExternalCrypto Property (SSHClient Class)

Provides access to external signing and DC parameters.

Syntax

SecureBlackboxExternalCrypto* GetExternalCrypto();

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Remarks

Use this property to tune-up remote cryptography settings. SecureBlackbox supports two independent types of external cryptography: synchronous (based on the ExternalSign event) and asynchronous (based on the DC protocol and the DCAuth signing component).

This property is read-only.

Data Type

SecureBlackboxExternalCrypto

FIPSMode Property (SSHClient Class)

Reserved.

Syntax

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

Key Property (SSHClient Class)

Contains client's SSH key.

Syntax

SecureBlackboxSSHKey* GetKey();
int SetKey(SecureBlackboxSSHKey* val);

char* secureblackbox_sshclient_getkeyfingerprintsha1(void* lpObj);

char* secureblackbox_sshclient_getkeyfingerprintsha256(void* lpObj);

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

QString GetKeyFingerprintSHA1();

QString GetKeyFingerprintSHA256();

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

Remarks

Server's public key is returned by ServerKey property.

Data Type

SecureBlackboxSSHKey

Password Property (SSHClient Class)

Specifies user's password on the server.

Syntax

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

Proxy Property (SSHClient Class)

Allows connection through a proxy server.

Syntax

SecureBlackboxProxySettings* GetProxy();

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Remarks

Set this property if the connection should be established through a proxy server.

This property is read-only.

Data Type

SecureBlackboxProxySettings

ServerKey Property (SSHClient Class)

Returns server's public key.

Syntax

SecureBlackboxSSHKey* GetServerKey();

char* secureblackbox_sshclient_getserverkeyalgorithm(void* lpObj);

int secureblackbox_sshclient_getserverkeybits(void* lpObj);

char* secureblackbox_sshclient_getserverkeycomment(void* lpObj);

char* secureblackbox_sshclient_getserverkeycurve(void* lpObj);

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

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

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

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

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

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

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

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

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

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

char* secureblackbox_sshclient_getserverkeyfingerprintmd5(void* lpObj);

char* secureblackbox_sshclient_getserverkeyfingerprintsha1(void* lpObj);

char* secureblackbox_sshclient_getserverkeyfingerprintsha256(void* lpObj);

int64 secureblackbox_sshclient_getserverkeyhandle(void* lpObj);

int secureblackbox_sshclient_getserverkeyisextractable(void* lpObj);

int secureblackbox_sshclient_getserverkeyisprivate(void* lpObj);

int secureblackbox_sshclient_getserverkeyispublic(void* lpObj);

int secureblackbox_sshclient_getserverkeykdfrounds(void* lpObj);

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

int secureblackbox_sshclient_getserverkeykeyformat(void* lpObj);

char* secureblackbox_sshclient_getserverkeykeyprotectionalgorithm(void* lpObj);

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

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

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

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

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

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

char* secureblackbox_sshclient_getserverkeysubject(void* lpObj);

QString GetServerKeyAlgorithm();

int GetServerKeyBits();

QString GetServerKeyComment();

QString GetServerKeyCurve();

QByteArray GetServerKeyDSSG();

QByteArray GetServerKeyDSSP();

QByteArray GetServerKeyDSSQ();

QByteArray GetServerKeyDSSX();

QByteArray GetServerKeyDSSY();

QByteArray GetServerKeyECCD();

QByteArray GetServerKeyECCQX();

QByteArray GetServerKeyECCQY();

QByteArray GetServerKeyEdPrivate();

QByteArray GetServerKeyEdPublic();

QString GetServerKeyFingerprintMD5();

QString GetServerKeyFingerprintSHA1();

QString GetServerKeyFingerprintSHA256();

qint64 GetServerKeyHandle();

bool GetServerKeyIsExtractable();

bool GetServerKeyIsPrivate();

bool GetServerKeyIsPublic();

int GetServerKeyKDFRounds();

QByteArray GetServerKeyKDFSalt();

int GetServerKeyKeyFormat();

QString GetServerKeyKeyProtectionAlgorithm();

QByteArray GetServerKeyRSAExponent();

QByteArray GetServerKeyRSAIQMP();

QByteArray GetServerKeyRSAModulus();

QByteArray GetServerKeyRSAP();

QByteArray GetServerKeyRSAPrivateExponent();

QByteArray GetServerKeyRSAQ();

QString GetServerKeySubject();

Remarks

Client's SSH key is specified by Key.

This property is read-only.

Data Type

SecureBlackboxSSHKey

SocketSettings Property (SSHClient Class)

Manages network connection settings.

Syntax

SecureBlackboxSocketSettings* GetSocketSettings();

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Remarks

Use this property to tune up network connection parameters.

This property is read-only.

Data Type

SecureBlackboxSocketSettings

SSHSettings Property (SSHClient Class)

Provides access to SSH connection settings.

Syntax

SecureBlackboxSSHSettings* GetSSHSettings();

int secureblackbox_sshclient_getsshsettingsautoadjustciphers(void* lpObj);
int secureblackbox_sshclient_setsshsettingsautoadjustciphers(void* lpObj, int bSSHSettingsAutoAdjustCiphers);

int secureblackbox_sshclient_getsshsettingsbaseconfiguration(void* lpObj);
int secureblackbox_sshclient_setsshsettingsbaseconfiguration(void* lpObj, int iSSHSettingsBaseConfiguration);

char* secureblackbox_sshclient_getsshsettingscompressionalgorithms(void* lpObj);
int secureblackbox_sshclient_setsshsettingscompressionalgorithms(void* lpObj, const char* lpszSSHSettingsCompressionAlgorithms);

int secureblackbox_sshclient_getsshsettingscompressionlevel(void* lpObj);
int secureblackbox_sshclient_setsshsettingscompressionlevel(void* lpObj, int iSSHSettingsCompressionLevel);

int secureblackbox_sshclient_getsshsettingsdefaultwindowsize(void* lpObj);
int secureblackbox_sshclient_setsshsettingsdefaultwindowsize(void* lpObj, int iSSHSettingsDefaultWindowSize);

char* secureblackbox_sshclient_getsshsettingsencryptionalgorithms(void* lpObj);
int secureblackbox_sshclient_setsshsettingsencryptionalgorithms(void* lpObj, const char* lpszSSHSettingsEncryptionAlgorithms);

int secureblackbox_sshclient_getsshsettingsforcecompression(void* lpObj);
int secureblackbox_sshclient_setsshsettingsforcecompression(void* lpObj, int bSSHSettingsForceCompression);

int secureblackbox_sshclient_getsshsettingsforwardauthagent(void* lpObj);
int secureblackbox_sshclient_setsshsettingsforwardauthagent(void* lpObj, int bSSHSettingsForwardAuthAgent);

char* secureblackbox_sshclient_getsshsettingsgssauthtypes(void* lpObj);
int secureblackbox_sshclient_setsshsettingsgssauthtypes(void* lpObj, const char* lpszSSHSettingsGSSAuthTypes);

int secureblackbox_sshclient_getsshsettingsgssdelegatecreds(void* lpObj);
int secureblackbox_sshclient_setsshsettingsgssdelegatecreds(void* lpObj, int bSSHSettingsGSSDelegateCreds);

char* secureblackbox_sshclient_getsshsettingsgsshostname(void* lpObj);
int secureblackbox_sshclient_setsshsettingsgsshostname(void* lpObj, const char* lpszSSHSettingsGSSHostname);

char* secureblackbox_sshclient_getsshsettingsgsslib(void* lpObj);
int secureblackbox_sshclient_setsshsettingsgsslib(void* lpObj, const char* lpszSSHSettingsGSSLib);

char* secureblackbox_sshclient_getsshsettingsgssmechanisms(void* lpObj);
int secureblackbox_sshclient_setsshsettingsgssmechanisms(void* lpObj, const char* lpszSSHSettingsGSSMechanisms);

char* secureblackbox_sshclient_getsshsettingsgssprotocols(void* lpObj);
int secureblackbox_sshclient_setsshsettingsgssprotocols(void* lpObj, const char* lpszSSHSettingsGSSProtocols);

int secureblackbox_sshclient_getsshsettingshandshaketimeout(void* lpObj);
int secureblackbox_sshclient_setsshsettingshandshaketimeout(void* lpObj, int iSSHSettingsHandshakeTimeout);

char* secureblackbox_sshclient_getsshsettingskexalgorithms(void* lpObj);
int secureblackbox_sshclient_setsshsettingskexalgorithms(void* lpObj, const char* lpszSSHSettingsKexAlgorithms);

char* secureblackbox_sshclient_getsshsettingsmacalgorithms(void* lpObj);
int secureblackbox_sshclient_setsshsettingsmacalgorithms(void* lpObj, const char* lpszSSHSettingsMacAlgorithms);

int secureblackbox_sshclient_getsshsettingsmaxsshpacketsize(void* lpObj);
int secureblackbox_sshclient_setsshsettingsmaxsshpacketsize(void* lpObj, int iSSHSettingsMaxSSHPacketSize);

int secureblackbox_sshclient_getsshsettingsminwindowsize(void* lpObj);
int secureblackbox_sshclient_setsshsettingsminwindowsize(void* lpObj, int iSSHSettingsMinWindowSize);

int secureblackbox_sshclient_getsshsettingsobfuscatehandshake(void* lpObj);
int secureblackbox_sshclient_setsshsettingsobfuscatehandshake(void* lpObj, int bSSHSettingsObfuscateHandshake);

char* secureblackbox_sshclient_getsshsettingsobfuscationpassword(void* lpObj);
int secureblackbox_sshclient_setsshsettingsobfuscationpassword(void* lpObj, const char* lpszSSHSettingsObfuscationPassword);

char* secureblackbox_sshclient_getsshsettingspublickeyalgorithms(void* lpObj);
int secureblackbox_sshclient_setsshsettingspublickeyalgorithms(void* lpObj, const char* lpszSSHSettingsPublicKeyAlgorithms);

int secureblackbox_sshclient_getsshsettingsrequestpasswordchange(void* lpObj);
int secureblackbox_sshclient_setsshsettingsrequestpasswordchange(void* lpObj, int bSSHSettingsRequestPasswordChange);

char* secureblackbox_sshclient_getsshsettingssoftwarename(void* lpObj);
int secureblackbox_sshclient_setsshsettingssoftwarename(void* lpObj, const char* lpszSSHSettingsSoftwareName);

int secureblackbox_sshclient_getsshsettingstrustallkeys(void* lpObj);
int secureblackbox_sshclient_setsshsettingstrustallkeys(void* lpObj, int bSSHSettingsTrustAllKeys);

int secureblackbox_sshclient_getsshsettingsuseauthagent(void* lpObj);
int secureblackbox_sshclient_setsshsettingsuseauthagent(void* lpObj, int bSSHSettingsUseAuthAgent);

int secureblackbox_sshclient_getsshsettingsversions(void* lpObj);
int secureblackbox_sshclient_setsshsettingsversions(void* lpObj, int iSSHSettingsVersions);

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

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

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

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

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

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

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

bool GetSSHSettingsForwardAuthAgent();
int SetSSHSettingsForwardAuthAgent(bool bSSHSettingsForwardAuthAgent);

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

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

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

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

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

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

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

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

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

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

int GetSSHSettingsMinWindowSize();
int SetSSHSettingsMinWindowSize(int iSSHSettingsMinWindowSize);

bool GetSSHSettingsObfuscateHandshake();
int SetSSHSettingsObfuscateHandshake(bool bSSHSettingsObfuscateHandshake);

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

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

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

QString GetSSHSettingsSoftwareName();
int SetSSHSettingsSoftwareName(QString qsSSHSettingsSoftwareName);

bool GetSSHSettingsTrustAllKeys();
int SetSSHSettingsTrustAllKeys(bool bSSHSettingsTrustAllKeys);

bool GetSSHSettingsUseAuthAgent();
int SetSSHSettingsUseAuthAgent(bool bSSHSettingsUseAuthAgent);

int GetSSHSettingsVersions();
int SetSSHSettingsVersions(int iSSHSettingsVersions);

Remarks

Use this property to configure SSH protocol settings.

This property is read-only.

Data Type

SecureBlackboxSSHSettings

Subsystem Property (SSHClient Class)

Specifies the subsystem to request from the server.

Syntax

ANSI (Cross Platform)
char* GetSubsystem();
int SetSubsystem(const char* lpszSubsystem);

Unicode (Windows)
LPWSTR GetSubsystem();
INT SetSubsystem(LPCWSTR lpszSubsystem);

char* secureblackbox_sshclient_getsubsystem(void* lpObj);
int secureblackbox_sshclient_setsubsystem(void* lpObj, const char* lpszSubsystem);

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

Terminal Property (SSHClient Class)

Provides access to SSH terminal settings object.

Syntax

SecureBlackboxSSHTerm* GetTerminal();

int secureblackbox_sshclient_getterminalcols(void* lpObj);
int secureblackbox_sshclient_setterminalcols(void* lpObj, int iTerminalCols);

char* secureblackbox_sshclient_getterminalenvironment(void* lpObj);
int secureblackbox_sshclient_setterminalenvironment(void* lpObj, const char* lpszTerminalEnvironment);

int secureblackbox_sshclient_getterminaleolchar(void* lpObj, char** lpTerminalEOLChar, int* lenTerminalEOLChar);
int secureblackbox_sshclient_setterminaleolchar(void* lpObj, const char* lpTerminalEOLChar, int lenTerminalEOLChar);

int secureblackbox_sshclient_getterminalheight(void* lpObj);
int secureblackbox_sshclient_setterminalheight(void* lpObj, int iTerminalHeight);

char* secureblackbox_sshclient_getterminalopcodes(void* lpObj);
int secureblackbox_sshclient_setterminalopcodes(void* lpObj, const char* lpszTerminalOpcodes);

char* secureblackbox_sshclient_getterminalprotocol(void* lpObj);
int secureblackbox_sshclient_setterminalprotocol(void* lpObj, const char* lpszTerminalProtocol);

int secureblackbox_sshclient_getterminalrequestpty(void* lpObj);
int secureblackbox_sshclient_setterminalrequestpty(void* lpObj, int bTerminalRequestPty);

int secureblackbox_sshclient_getterminalrows(void* lpObj);
int secureblackbox_sshclient_setterminalrows(void* lpObj, int iTerminalRows);

int secureblackbox_sshclient_getterminalwidth(void* lpObj);
int secureblackbox_sshclient_setterminalwidth(void* lpObj, int iTerminalWidth);

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

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

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

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

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

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

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

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

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

Remarks

Use this property to configure the pseudo-terminal parameters before opening a shell or command connection.

This property is read-only.

Data Type

SecureBlackboxSSHTerm

TrustedKeysFile Property (SSHClient Class)

Path to the file containing public keys of authorized servers.

Syntax

ANSI (Cross Platform)
char* GetTrustedKeysFile();
int SetTrustedKeysFile(const char* lpszTrustedKeysFile);

Unicode (Windows)
LPWSTR GetTrustedKeysFile();
INT SetTrustedKeysFile(LPCWSTR lpszTrustedKeysFile);

char* secureblackbox_sshclient_gettrustedkeysfile(void* lpObj);
int secureblackbox_sshclient_settrustedkeysfile(void* lpObj, const char* lpszTrustedKeysFile);

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

ANSI (Cross Platform)
char* GetUsername();
int SetUsername(const char* lpszUsername);

Unicode (Windows)
LPWSTR GetUsername();
INT SetUsername(LPCWSTR lpszUsername);

char* secureblackbox_sshclient_getusername(void* lpObj);
int secureblackbox_sshclient_setusername(void* lpObj, const char* lpszUsername);

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

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

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* secureblackbox_sshclient_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Error Handling (C++)

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

Connect Method (SSHClient Class)

Establishes connection to an SSH server.

Syntax

ANSI (Cross Platform)
int Connect(const char* lpszAddress, int iPort);

Unicode (Windows)
INT Connect(LPCWSTR lpszAddress, INT iPort);

int secureblackbox_sshclient_connect(void* lpObj, const char* lpszAddress, int iPort);

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 (C++)

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

ConnectAndExec Method (SSHClient Class)

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

Syntax

ANSI (Cross Platform)
char* ConnectAndExec(const char* lpszAddress, int iPort, const char* lpszCommand, int bWantStdout, int bWantStdErr, int *lpSize = NULL);

Unicode (Windows)
LPSTR ConnectAndExec(LPCWSTR lpszAddress, INT iPort, LPCWSTR lpszCommand, BOOL bWantStdout, BOOL bWantStdErr, LPINT lpSize = NULL);

char* secureblackbox_sshclient_connectandexec(void* lpObj, const char* lpszAddress, int iPort, const char* lpszCommand, int bWantStdout, int bWantStdErr, int *lpSize);

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 (C++)

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

Disconnect Method (SSHClient Class)

Closes connection to the SSH server.

Syntax

ANSI (Cross Platform)
int Disconnect();

Unicode (Windows)
INT Disconnect();

int secureblackbox_sshclient_disconnect(void* lpObj);

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 (C++)

DoAction Method (SSHClient Class)

Performs an additional action.

Syntax

ANSI (Cross Platform)
char* DoAction(const char* lpszActionID, const char* lpszActionParams);

Unicode (Windows)
LPWSTR DoAction(LPCWSTR lpszActionID, LPCWSTR lpszActionParams);

char* secureblackbox_sshclient_doaction(void* lpObj, const char* lpszActionID, const char* lpszActionParams);

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 (case insensitive) of the action is provided in the ActionID parameter.

ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

Common ActionIDs:


Action	Parameters	Returned value	Description
ResetTrustedListCache	none	none	Clears the cached list of trusted lists.
ResetCertificateCache	none	none	Clears the cached certificates.
ResetCRLCache	none	none	Clears the cached CRLs.
ResetOCSPResponseCache	none	none	Clears the cached OCSP responses.

Error Handling (C++)

Ping Method (SSHClient Class)

Sends a keep-alive request to the SSH server.

Syntax

ANSI (Cross Platform)
int Ping();

Unicode (Windows)
INT Ping();

int secureblackbox_sshclient_ping(void* lpObj);

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 (C++)

Poll Method (SSHClient Class)

Checks whether there is any inbound data readily available.

Syntax

ANSI (Cross Platform)
bool Poll(int iMilliseconds);

Unicode (Windows)
bool Poll(INT iMilliseconds);

bool secureblackbox_sshclient_poll(void* lpObj, int iMilliseconds);

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 (C++)

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

ANSI (Cross Platform)
char* Receive();

Unicode (Windows)
LPWSTR Receive();

char* secureblackbox_sshclient_receive(void* lpObj);

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 (C++)

ReceiveBytes Method (SSHClient Class)

Reads a portion of received data into a byte array.

Syntax

ANSI (Cross Platform)
char* ReceiveBytes(int iMaxLen, int *lpSize = NULL);

Unicode (Windows)
LPSTR ReceiveBytes(INT iMaxLen, LPINT lpSize = NULL);

char* secureblackbox_sshclient_receivebytes(void* lpObj, int iMaxLen, int *lpSize);

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 (C++)

ReceiveBytesFrom Method (SSHClient Class)

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

Syntax

ANSI (Cross Platform)
char* ReceiveBytesFrom(int iChannel, int iMaxLen, int *lpSize = NULL);

Unicode (Windows)
LPSTR ReceiveBytesFrom(INT iChannel, INT iMaxLen, LPINT lpSize = NULL);

char* secureblackbox_sshclient_receivebytesfrom(void* lpObj, int iChannel, int iMaxLen, int *lpSize);

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 (C++)

ReceiveFrom Method (SSHClient Class)

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

Syntax

ANSI (Cross Platform)
char* ReceiveFrom(int iChannel);

Unicode (Windows)
LPWSTR ReceiveFrom(INT iChannel);

char* secureblackbox_sshclient_receivefrom(void* lpObj, int iChannel);

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 (C++)

Reset Method (SSHClient Class)

Resets the class settings.

Syntax

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int secureblackbox_sshclient_reset(void* lpObj);

int Reset();

Remarks

Reset is a generic method available in every class.

Error Handling (C++)

Send Method (SSHClient Class)

Sends a string to the server.

Syntax

ANSI (Cross Platform)
int Send(const char* lpszDataStr, int bAddEOL);

Unicode (Windows)
INT Send(LPCWSTR lpszDataStr, BOOL bAddEOL);

int secureblackbox_sshclient_send(void* lpObj, const char* lpszDataStr, int bAddEOL);

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 (C++)

SendBytes Method (SSHClient Class)

Sends an array of bytes to the server.

Syntax

ANSI (Cross Platform)
int SendBytes(const char* lpData, int lenData);

Unicode (Windows)
INT SendBytes(LPCSTR lpData, INT lenData);

int secureblackbox_sshclient_sendbytes(void* lpObj, const char* lpData, int lenData);

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 (C++)

SendSpecial Method (SSHClient Class)

Sends a special character to the server or remote command.

Syntax

ANSI (Cross Platform)
int SendSpecial(const char* lpszSpecialChar);

Unicode (Windows)
INT SendSpecial(LPCWSTR lpszSpecialChar);

int secureblackbox_sshclient_sendspecial(void* lpObj, const char* lpszSpecialChar);

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 (C++)

AuthAttempt Event (SSHClient Class)

Fires when a single authentication attempt is performed.

Syntax

ANSI (Cross Platform)
virtual int FireAuthAttempt(SSHClientAuthAttemptEventParams *e);

typedef struct {
  int AuthType;
  int reserved;
} SSHClientAuthAttemptEventParams;


Unicode (Windows)
virtual INT FireAuthAttempt(SSHClientAuthAttemptEventParams *e);

typedef struct {
  INT AuthType;
  INT reserved;
} SSHClientAuthAttemptEventParams;

#define EID_SSHCLIENT_AUTHATTEMPT 1

virtual INT SECUREBLACKBOX_CALL FireAuthAttempt(INT &iAuthType);

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

ANSI (Cross Platform)
virtual int FireAuthFailed(SSHClientAuthFailedEventParams *e);

typedef struct {
  int AuthenticationType;
  int reserved;
} SSHClientAuthFailedEventParams;


Unicode (Windows)
virtual INT FireAuthFailed(SSHClientAuthFailedEventParams *e);

typedef struct {
  INT AuthenticationType;
  INT reserved;
} SSHClientAuthFailedEventParams;

#define EID_SSHCLIENT_AUTHFAILED 2

virtual INT SECUREBLACKBOX_CALL FireAuthFailed(INT &iAuthenticationType);

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

ANSI (Cross Platform)
virtual int FireAuthSucceeded(SSHClientAuthSucceededEventParams *e);

typedef struct {
  int reserved;
} SSHClientAuthSucceededEventParams;


Unicode (Windows)
virtual INT FireAuthSucceeded(SSHClientAuthSucceededEventParams *e);

typedef struct {
  INT reserved;
} SSHClientAuthSucceededEventParams;

#define EID_SSHCLIENT_AUTHSUCCEEDED 3

virtual INT SECUREBLACKBOX_CALL FireAuthSucceeded();

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

ANSI (Cross Platform)
virtual int FireBanner(SSHClientBannerEventParams *e);

typedef struct {
  const char *Text;
  int lenText;
  const char *Language;
  int lenLanguage;
  int reserved;
} SSHClientBannerEventParams;


Unicode (Windows)
virtual INT FireBanner(SSHClientBannerEventParams *e);

typedef struct {
  LPCSTR Text;
  INT lenText;
  LPCSTR Language;
  INT lenLanguage;
  INT reserved;
} SSHClientBannerEventParams;

#define EID_SSHCLIENT_BANNER 4

virtual INT SECUREBLACKBOX_CALL FireBanner(LPSTR &lpText, INT &lenText, LPSTR &lpLanguage, INT &lenLanguage);

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

ANSI (Cross Platform)
virtual int FireCommandCompleted(SSHClientCommandCompletedEventParams *e);

typedef struct {
  const char *Command;
  int ExitStatus;
  const char *ExitMessage;
  const char *ExitSignal;
  int reserved;
} SSHClientCommandCompletedEventParams;


Unicode (Windows)
virtual INT FireCommandCompleted(SSHClientCommandCompletedEventParams *e);

typedef struct {
  LPCWSTR Command;
  INT ExitStatus;
  LPCWSTR ExitMessage;
  LPCWSTR ExitSignal;
  INT reserved;
} SSHClientCommandCompletedEventParams;

#define EID_SSHCLIENT_COMMANDCOMPLETED 5

virtual INT SECUREBLACKBOX_CALL FireCommandCompleted(LPSTR &lpszCommand, INT &iExitStatus, LPSTR &lpszExitMessage, LPSTR &lpszExitSignal);

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

ANSI (Cross Platform)
virtual int FireCommandStart(SSHClientCommandStartEventParams *e);

typedef struct {
  const char *Command;
  int reserved;
} SSHClientCommandStartEventParams;


Unicode (Windows)
virtual INT FireCommandStart(SSHClientCommandStartEventParams *e);

typedef struct {
  LPCWSTR Command;
  INT reserved;
} SSHClientCommandStartEventParams;

#define EID_SSHCLIENT_COMMANDSTART 6

virtual INT SECUREBLACKBOX_CALL FireCommandStart(LPSTR &lpszCommand);

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

ANSI (Cross Platform)
virtual int FireConnect(SSHClientConnectEventParams *e);

typedef struct {
  int reserved;
} SSHClientConnectEventParams;


Unicode (Windows)
virtual INT FireConnect(SSHClientConnectEventParams *e);

typedef struct {
  INT reserved;
} SSHClientConnectEventParams;

#define EID_SSHCLIENT_CONNECT 7

virtual INT SECUREBLACKBOX_CALL FireConnect();

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

ANSI (Cross Platform)
virtual int FireDataReceived(SSHClientDataReceivedEventParams *e);

typedef struct {
  int Channel;
  int BytesReceived;
  int TotalBytesPending;
  int reserved;
} SSHClientDataReceivedEventParams;


Unicode (Windows)
virtual INT FireDataReceived(SSHClientDataReceivedEventParams *e);

typedef struct {
  INT Channel;
  INT BytesReceived;
  INT TotalBytesPending;
  INT reserved;
} SSHClientDataReceivedEventParams;

#define EID_SSHCLIENT_DATARECEIVED 8

virtual INT SECUREBLACKBOX_CALL FireDataReceived(INT &iChannel, INT &iBytesReceived, INT &iTotalBytesPending);

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

ANSI (Cross Platform)
virtual int FireDataSent(SSHClientDataSentEventParams *e);

typedef struct {
  int BytesSent;
  int BytesPending;
  int reserved;
} SSHClientDataSentEventParams;


Unicode (Windows)
virtual INT FireDataSent(SSHClientDataSentEventParams *e);

typedef struct {
  INT BytesSent;
  INT BytesPending;
  INT reserved;
} SSHClientDataSentEventParams;

#define EID_SSHCLIENT_DATASENT 9

virtual INT SECUREBLACKBOX_CALL FireDataSent(INT &iBytesSent, INT &iBytesPending);

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

ANSI (Cross Platform)
virtual int FireDisconnect(SSHClientDisconnectEventParams *e);

typedef struct {
  int CloseReason;
  int reserved;
} SSHClientDisconnectEventParams;


Unicode (Windows)
virtual INT FireDisconnect(SSHClientDisconnectEventParams *e);

typedef struct {
  INT CloseReason;
  INT reserved;
} SSHClientDisconnectEventParams;

#define EID_SSHCLIENT_DISCONNECT 10

virtual INT SECUREBLACKBOX_CALL FireDisconnect(INT &iCloseReason);

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

ANSI (Cross Platform)
virtual int FireError(SSHClientErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} SSHClientErrorEventParams;


Unicode (Windows)
virtual INT FireError(SSHClientErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} SSHClientErrorEventParams;

#define EID_SSHCLIENT_ERROR 11

virtual INT SECUREBLACKBOX_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

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

ANSI (Cross Platform)
virtual int FireExternalSign(SSHClientExternalSignEventParams *e);

typedef struct {
  const char *OperationId;
  const char *HashAlgorithm;
  const char *Pars;
  const char *Data;
  char *SignedData;
  int reserved;
} SSHClientExternalSignEventParams;


Unicode (Windows)
virtual INT FireExternalSign(SSHClientExternalSignEventParams *e);

typedef struct {
  LPCWSTR OperationId;
  LPCWSTR HashAlgorithm;
  LPCWSTR Pars;
  LPCWSTR Data;
  LPWSTR SignedData;
  INT reserved;
} SSHClientExternalSignEventParams;

#define EID_SSHCLIENT_EXTERNALSIGN 12

virtual INT SECUREBLACKBOX_CALL FireExternalSign(LPSTR &lpszOperationId, LPSTR &lpszHashAlgorithm, LPSTR &lpszPars, LPSTR &lpszData, LPSTR &lpszSignedData);

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 class via the SignedData parameter.

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

The class uses base16 (hex) encoding for the 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 the .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

ANSI (Cross Platform)
virtual int FireKnownKeyReceived(SSHClientKnownKeyReceivedEventParams *e);

typedef struct {
  const char *Algorithm;
  int Bits;
  const char *FingerprintSHA256;
  int reserved;
} SSHClientKnownKeyReceivedEventParams;


Unicode (Windows)
virtual INT FireKnownKeyReceived(SSHClientKnownKeyReceivedEventParams *e);

typedef struct {
  LPCWSTR Algorithm;
  INT Bits;
  LPCWSTR FingerprintSHA256;
  INT reserved;
} SSHClientKnownKeyReceivedEventParams;

#define EID_SSHCLIENT_KNOWNKEYRECEIVED 13

virtual INT SECUREBLACKBOX_CALL FireKnownKeyReceived(LPSTR &lpszAlgorithm, INT &iBits, LPSTR &lpszFingerprintSHA256);

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

ANSI (Cross Platform)
virtual int FireNotification(SSHClientNotificationEventParams *e);

typedef struct {
  const char *EventID;
  const char *EventParam;
  int reserved;
} SSHClientNotificationEventParams;


Unicode (Windows)
virtual INT FireNotification(SSHClientNotificationEventParams *e);

typedef struct {
  LPCWSTR EventID;
  LPCWSTR EventParam;
  INT reserved;
} SSHClientNotificationEventParams;

#define EID_SSHCLIENT_NOTIFICATION 14

virtual INT SECUREBLACKBOX_CALL FireNotification(LPSTR &lpszEventID, LPSTR &lpszEventParam);

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 class. 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 the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the class, 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

ANSI (Cross Platform)
virtual int FirePasswordChangeRequest(SSHClientPasswordChangeRequestEventParams *e);

typedef struct {
  const char *Prompt;
  char *NewPassword;
  int Cancel;
  int reserved;
} SSHClientPasswordChangeRequestEventParams;


Unicode (Windows)
virtual INT FirePasswordChangeRequest(SSHClientPasswordChangeRequestEventParams *e);

typedef struct {
  LPCWSTR Prompt;
  LPWSTR NewPassword;
  BOOL Cancel;
  INT reserved;
} SSHClientPasswordChangeRequestEventParams;

#define EID_SSHCLIENT_PASSWORDCHANGEREQUEST 15

virtual INT SECUREBLACKBOX_CALL FirePasswordChangeRequest(LPSTR &lpszPrompt, LPSTR &lpszNewPassword, BOOL &bCancel);

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

ANSI (Cross Platform)
virtual int FirePrivateKeyNeeded(SSHClientPrivateKeyNeededEventParams *e);

typedef struct {
  int Skip;
  int reserved;
} SSHClientPrivateKeyNeededEventParams;


Unicode (Windows)
virtual INT FirePrivateKeyNeeded(SSHClientPrivateKeyNeededEventParams *e);

typedef struct {
  BOOL Skip;
  INT reserved;
} SSHClientPrivateKeyNeededEventParams;

#define EID_SSHCLIENT_PRIVATEKEYNEEDED 16

virtual INT SECUREBLACKBOX_CALL FirePrivateKeyNeeded(BOOL &bSkip);

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

ANSI (Cross Platform)
virtual int FireUnknownKeyReceived(SSHClientUnknownKeyReceivedEventParams *e);

typedef struct {
  const char *Algorithm;
  int Bits;
  const char *FingerprintSHA256;
  int Action;
  int reserved;
} SSHClientUnknownKeyReceivedEventParams;


Unicode (Windows)
virtual INT FireUnknownKeyReceived(SSHClientUnknownKeyReceivedEventParams *e);

typedef struct {
  LPCWSTR Algorithm;
  INT Bits;
  LPCWSTR FingerprintSHA256;
  INT Action;
  INT reserved;
} SSHClientUnknownKeyReceivedEventParams;

#define EID_SSHCLIENT_UNKNOWNKEYRECEIVED 17

virtual INT SECUREBLACKBOX_CALL FireUnknownKeyReceived(LPSTR &lpszAlgorithm, INT &iBits, LPSTR &lpszFingerprintSHA256, INT &iAction);

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.

ExternalCrypto Type

Specifies the parameters of external cryptographic calls.

Syntax

SecureBlackboxExternalCrypto (declared in secureblackbox.h)

Remarks

External cryptocalls are used in a Distributed Cryptography (DC) subsystem, which allows the delegation of security operations to the remote agent. For instance, it can be used to compute the signature value on the server, while retaining the client's private key locally.

The following fields are available:

AsyncDocumentID

CustomParams

Data

ExternalHashCalculation

Fields

AsyncDocumentID
char*
Default Value: ""

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.

CustomParams
char*
Default Value: ""

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

Data
char*
Default Value: ""

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

ExternalHashCalculation
int
Default Value: FALSE

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.

HashAlgorithm
char*
Default Value: "SHA256"

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`

KeyID
char*
Default Value: ""

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 KeySecret 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";

KeySecret
char*
Default Value: ""

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 KeyID topic.

Method
int
Default Value: 0

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

Available options:


asmdPKCS1	`0`
asmdPKCS7	`1`

Mode
int
Default Value: 0

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 the OnExternalSign event (`2`)
ecmDCAuth	DCAuth signing (`3`)
ecmDCAuthJSON	DCAuth signing in JSON format (`4`)

PublicKeyAlgorithm
char*
Default Value: ""

Provide the 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`

Constructors

ExternalCrypto()

Creates a new ExternalCrypto object with default field values.

ProxySettings Type

A container for proxy server settings.

Syntax

SecureBlackboxProxySettings (declared in secureblackbox.h)

Remarks

This type exposes a collection of properties for tuning up the proxy server configuration.

The following fields are available:

Fields

Address
char*
Default Value: ""

The IP address of the proxy server.

Authentication
int
Default Value: 0

The authentication type used by the proxy server.


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

Password
char*
Default Value: ""

The password to authenticate to the proxy server.

Port
int
Default Value: 0

The port on the proxy server to connect to.

ProxyType
int
Default Value: 0

The type of the proxy server.


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

RequestHeaders
char*
Default Value: ""

Contains HTTP request headers for WebTunnel and HTTP proxy.

ResponseBody
char*
Default Value: ""

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

ResponseHeaders
char*
Default Value: ""

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

UseIPv6
int
Default Value: FALSE

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

Username
char*
Default Value: ""

Specifies the username credential for proxy authentication.

Constructors

ProxySettings()

Creates a new ProxySettings object.

SocketSettings Type

A container for the socket settings.

Syntax

SecureBlackboxSocketSettings (declared in secureblackbox.h)

Remarks

This type is a container for socket-layer parameters.

The following fields are available:

Fields

DNSMode
int
Default Value: 0

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`

DNSPort
int
Default Value: 0

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

DNSQueryTimeout
int
Default Value: 0

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

DNSServers
char*
Default Value: ""

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

DNSTotalTimeout
int
Default Value: 0

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

IncomingSpeedLimit
int
Default Value: 0

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

LocalAddress
char*
Default Value: ""

The local network interface to bind the socket to.

LocalPort
int
Default Value: 0

The local port number to bind the socket to.

OutgoingSpeedLimit
int
Default Value: 0

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

Timeout
int
Default Value: 60000

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

UseIPv6
int
Default Value: FALSE

Enables or disables IP protocol version 6.

Constructors

SocketSettings()

Creates a new SocketSettings object.

SSHConnectionInfo Type

Contains information about SSH connection.

Syntax

SecureBlackboxSSHConnectionInfo (declared in secureblackbox.h)

Remarks

SSHConnectionInfo object contains information about one SSH connection.

The following fields are available:

Fields

ClientKeyAlgorithm
char* (read-only)
Default Value: ""

Specifies the client's key algorithm.

ClientKeyBits
int (read-only)
Default Value: 0

Specifies the length of the client's key.

ClientKeyFingerprint
char* (read-only)
Default Value: ""

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

CloseReason
char* (read-only)
Default Value: ""

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.

CompressionAlgorithmInbound
char* (read-only)
Default Value: ""

Compression algorithm for the incoming traffic.

CompressionAlgorithmOutbound
char* (read-only)
Default Value: ""

Compression algorithm for the outgoing traffic.

EncryptionAlgorithmInbound
char* (read-only)
Default Value: ""

Encryption algorithm for the incoming traffic.

EncryptionAlgorithmOutbound
char* (read-only)
Default Value: ""

Encryption algorithm for the outgoing traffic.

InboundEncryptionKeyBits
int (read-only)
Default Value: 0

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

KexAlgorithm
char* (read-only)
Default Value: ""

The key exchange algorithm used during the SSH handshake.

KexBits
int (read-only)
Default Value: 0

The number of bits used by the key exchange algorithm.

KexLines
char* (read-only)
Default Value: ""

The contents of the received KexInit packet.

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

MacAlgorithmInbound
char* (read-only)
Default Value: ""

MAC algorithm used for the incoming connection.

MacAlgorithmOutbound
char* (read-only)
Default Value: ""

MAC algorithm used for outbound connection.

OutboundEncryptionKeyBits
int (read-only)
Default Value: 0

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

PublicKeyAlgorithm
char* (read-only)
Default Value: ""

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

RemoteAddress
char* (read-only)
Default Value: ""

The client's IP address.

RemotePort
int (read-only)
Default Value: 0

The remote port of the client connection.

ServerKeyAlgorithm
char* (read-only)
Default Value: ""

Specifies the server's key algorithm.

ServerKeyBits
int (read-only)
Default Value: 0

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

ServerKeyFingerprint
char* (read-only)
Default Value: ""

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

ServerSoftwareName
char* (read-only)
Default Value: ""

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

TotalBytesReceived
int64 (read-only)
Default Value: 0

Returns the total number of bytes received over this connection.

TotalBytesSent
int64 (read-only)
Default Value: 0

Returns the total number of bytes sent over this connection.

Version
int (read-only)
Default Value: 2

Specifies SSH protocol version.

Constructors

SSHConnectionInfo()

Creates an empty object representing a SSH connection info.

SSHKey Type

SSHKey is used to store information about single compound public-key algorithm (such as RSA or DSA) key.

Syntax

SecureBlackboxSSHKey (declared in secureblackbox.h)

Remarks

SSH keys are used to secure the SSH protocol flow. They support different algorithms and key lengths, a very typical example being RSA-2048 bits.

The following fields are available:

Fields

Algorithm
char* (read-only)
Default Value: ""

Specifies the key algorithm.

The following algorithms are currently supported:

RSA
DSS
ECDSA
EDDSA

Bits
int (read-only)
Default Value: 0

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

Comment
char*
Default Value: ""

The comment for the public key.

Curve
char* (read-only)
Default Value: ""

Specifies the elliptical curve when EC cryptography is used.

The following curves are currently supported:

NISTP256
NISTP384
NISTP521
NISTK163
NISTP192
NISTP224
NISTK233
NISTB233
NISTK283
NISTK409
NISTB409
NISTK571
CURVE25519 (EdDSA curve)
CURVE448 (EdDSA curve)

DSSG
char* (read-only)
Default Value:

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

DSSP
char* (read-only)
Default Value:

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

DSSQ
char* (read-only)
Default Value:

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

DSSX
char* (read-only)
Default Value:

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

DSSY
char* (read-only)
Default Value:

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

ECCD
char* (read-only)
Default Value:

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.

ECCQX
char* (read-only)
Default Value:

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.

ECCQY
char* (read-only)
Default Value:

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.

EdPrivate
char* (read-only)
Default Value:

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

EdPublic
char* (read-only)
Default Value:

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

FingerprintMD5
char* (read-only)
Default Value: ""

Contains the MD5 fingerprint (hash) of the key.

FingerprintSHA1
char* (read-only)
Default Value: ""

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

FingerprintSHA256
char* (read-only)
Default Value: ""

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

Handle
int64
Default Value: 0

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());

IsExtractable
int (read-only)
Default Value: FALSE

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

IsPrivate
int (read-only)
Default Value: FALSE

Whether this key is a private key or not.

IsPublic
int (read-only)
Default Value: FALSE

Whether this key is a public key or not.

KDFRounds
int (read-only)
Default Value: 0

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

KDFSalt
char* (read-only)
Default Value:

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

KeyFormat
int (read-only)
Default Value: 0

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`
ckfPuTTY3	`9`

KeyProtectionAlgorithm
char* (read-only)
Default Value: ""

Specifies the key protection algorithm.

RSAExponent
char* (read-only)
Default Value:

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

RSAIQMP
char* (read-only)
Default Value:

Returns the iqmp parameter of the RSA key.

RSAModulus
char* (read-only)
Default Value:

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

RSAP
char* (read-only)
Default Value:

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

RSAPrivateExponent
char* (read-only)
Default Value:

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

RSAQ
char* (read-only)
Default Value:

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

Subject
char*
Default Value: ""

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

Constructors

SSHKey()

Creates a new key.

SSHSettings Type

A container for various SSH protocol settings.

Syntax

SecureBlackboxSSHSettings (declared in secureblackbox.h)

Remarks

SSHSettings stores various settings of SSH client or server.

The following fields are available:

Fields

AutoAdjustCiphers
int
Default Value: TRUE

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

BaseConfiguration
int
Default Value: 0

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

CompressionAlgorithms
char*
Default Value: ""

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

CompressionLevel
int
Default Value: 6

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

DefaultWindowSize
int
Default Value: 2048000

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.

EncryptionAlgorithms
char*
Default Value: ""

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

ForceCompression
int
Default Value: FALSE

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.

ForwardAuthAgent
int
Default Value: FALSE

Enables or disables auth agent forwarding. This allows the class to connect to the second and subsequent servers in the chain with the key agent available on the client computer.

GSSAuthTypes
char*
Default Value: ""

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

GSSDelegateCreds
int
Default Value: FALSE

Switches credential delegation on or off.

GSSHostname
char*
Default Value: ""

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

GSSLib
char*
Default Value: ""

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

GSSMechanisms
char*
Default Value: ""

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

GSSProtocols
char*
Default Value: ""

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

HandshakeTimeout
int
Default Value: 45

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.

KexAlgorithms
char*
Default Value: ""

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
diffie-hellman-group14-sha256
diffie-hellman-group15-sha512
diffie-hellman-group16-sha512
diffie-hellman-group17-sha512
diffie-hellman-group18-sha512

MacAlgorithms
char*
Default Value: ""

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

MaxSSHPacketSize
int
Default Value: 262144

Specifies the maximum length of one SSH packet in bytes.

MinWindowSize
int
Default Value: 2048

Specifies the minimal internal window size. When the minimal window size is reached, the 'window extension' request is sent to the server. This request notifies the server that the window was extended, and it can send more data.

ObfuscateHandshake
int
Default Value: FALSE

Enables or disables handshake obfuscation.

ObfuscationPassword
char*
Default Value: ""

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

PublicKeyAlgorithms
char*
Default Value: ""

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
rsa-sha2-256
rsa-sha2-512

RequestPasswordChange
int
Default Value: FALSE

Whether to request a password change when connecting.

SoftwareName
char*
Default Value: "SecureBlackbox"

The name to be used by the component to identify itself.

TrustAllKeys
int
Default Value: FALSE

Enables or disables explicit trust to all server keys. Use with care.

UseAuthAgent
int
Default Value: FALSE

Enables or disables the use of external key agent, such as Putty key agent.

Versions
int
Default Value: 1

Specifies enabled SSH protocol versions (1 or 2).

Constructors

SSHSettings()

Creates a new object with default settings.

SSHTerm Type

A container for SSH terminal settings.

Syntax

SecureBlackboxSSHTerm (declared in secureblackbox.h)

Remarks

SSHTerm stores terminal settings of the SSH client.

The following fields are available:

Fields

Cols
int
Default Value: 80

Specifies the width of the pseudoterminal, in characters.

Environment
char*
Default Value: ""

Specifies the list of environment variables.

EOLChar
char*
Default Value:

Specifies the End-of-Line character or sequence.

Height
int
Default Value: 0

Specifies the height of the pseudoterminal, in pixels.

Opcodes
char*
Default Value: ""

Specifies the operation codes specific for the terminal.

Protocol
char*
Default Value: "vt100"

The terminal protocol name.

RequestPty
int
Default Value: TRUE

Specifies whether to request a pseudoterminal for the session.

Rows
int
Default Value: 25

Specifies the height of the pseudoterminal, in lines.

Width
int
Default Value: 0

Specifies the width of the pseudoterminal, in pixels.

Config 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 Config Settings

AllAlgorithms: Returns the list of algorithms enabled in the component.

Use this configuration setting to obtain the list of algorithms currently enabled in the component in the kexinit format.

BlockSize: The data block size.

This property specifies the data block size to use.

CommandTimeout: Specifies the command timeout.

Specifies the command timeout (the maximum time to expect the result from the SSH command), in milliseconds.

CompressionAlgorithms: Returns the list of compression algorithms enabled in the component.

Use this configuration setting to get the list of compression algorithms currently enabled in the component, as a respective kexinit block line.

EarlyIdString: Enables the proactive approach to SSH handshake.

The rule of thumb in the majority of SSH environments is for the server to initiate the handshake with its identification string (and for the client to respond). By setting this property to true you can tell the client to initiate the handshake by sending out the identification string proactively without waiting for the server to send one in. This setting may help in situations where your SSH or SFTP connection fails unexpectedly due to a timeout or network error.

EncryptionAlgorithms: Returns the list of encryption algorithms enabled in the component.

Use this configuration setting to get the list of symmetric encryption algorithms currently enabled in the component, as a respective kexinit block line.

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.

KexAlgorithms: Returns the list of key exchange algorithms enabled in the component.

Use this configuration setting to get the list of key exchange algorithms currently enabled in the component, as a respective kexinit block line.

LocalCharset: Charset used on the client machine.

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

MacAlgorithms: Returns the list of MAC algorithms enabled in the component.

Use this configuration setting to get the list of MAC algorithms currently enabled in the component, as a respective kexinit block line.

PublicKeyAlgorithms: Returns the list of public key algorithms enabled in the component.

Use this configuration setting to get the list of public key algorithms currently enabled in the component, as a respective kexinit block line.

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.

UseStrictKeyExchange: Specifies how strict key exchange is supported.

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

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


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

Base Config Settings

ASN1UseGlobalTagCache: Controls whether ASN.1 module should use a global object cache.

This is a performance setting. It is unlikely that you will ever need to adjust it.

AssignSystemSmartCardPins: Specifies whether CSP-level PINs should be assigned to CNG keys.

This is a low-level tweak for certain cryptographic providers. It is unlikely that you will ever need to adjust it.

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
global		Global caching

Cookies: Gets or sets local cookies for the class.

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.

DNSLocalSuffix: The suffix to assign for TLD names.

Use this global setting to adjust the default suffix to assign to top-level domain names. The default is .local.

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

HardwareCryptoUsePolicy: The hardware crypto usage policy.

This global setting controls the hardware cryptography usage policy: auto, enable, or disable.

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.

HttpVersion: The HTTP version to use in any inner HTTP client components created.

Set this property to 1.0 or 1.1 to indicate the HTTP version that any internal HTTP clients should use.

IgnoreExpiredMSCTLSigningCert: Whether to tolerate the expired Windows Update signing certificate.

It is not uncommon for Microsoft Windows Update Certificate Trust List to be signed with an expired Microsoft certificate. Setting this global property to true makes SBB ignore the expired factor and take the Trust List into account.

ListDelimiter: The delimiter character for multi-element lists.

Allows to set the delimiter for any multi-entry values returned by the component as a string object, such as file lists. For most of the components, this property is set to a newline sequence.

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.

OldClientSideRSAFallback: Specifies whether the SSH client should use a SHA1 fallback.

Tells the SSH client to use a legacy ssh-rsa authentication even if the server indicates support for newer algorithms, such as rsa-sha-256. This is a backward-compatibility tweak.

PKICache: Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached.

The PKICache setting specifies which Public Key Infrastructure (PKI) elements should be cached to optimize performance and reduce retrieval times. It supports comma-separated values to indicate the specific types of PKI data that should be cached.

Supported Values:


certificate	Enables caching of certificates.
crl	Enables caching of Certificate Revocation Lists (CRLs).
ocsp	Enables caching of OCSP (Online Certificate Status Protocol) responses.

Example (default value): PKICache=certificate,crl,ocsp In this example, the component caches certificates, CRLs, and OCSP responses.

PKICachePath: Specifies the file system path where cached PKI data is stored.

The PKICachePath setting defines the file system path where cached PKI data (e.g., certificates, CRLs, OCSP responses and Trusted Lists) will be stored. This allows the system to persistently save and retrieve PKI cache data, even across application restarts.

The default value is an empty string - no cached PKI data is stored on disk.

Example: PKICachePath=C:\Temp\cache In this example, the cached PKI data is stored in the C:\Temp\cache directory.

ProductVersion: Returns the version of the SecureBlackbox library.

This property returns the long version string of the SecureBlackbox library being used (major.minor.build.revision).

ServerSSLDHKeyLength: Sets the size of the TLS DHE key exchange group.

Use this property to adjust the length, in bits, of the DHE prime to be used by the TLS server.

StaticDNS: Specifies whether static DNS rules should be used.

Set this property to enable or disable static DNS rules for the class. Works only if UseOwnDNSResolver is set to true.

Supported values are:


none		No static DNS rules (default)
local		Local static DNS rules
global		Global static DNS rules

StaticIPAddress[domain]: Gets or sets an IP address for the specified domain name.

Use this property to get or set an IP address for the specified domain name in the internal (of the class) or global DNS rules storage depending on the StaticDNS value. The type of the IP address (IPv4 or IPv6) is determined automatically. If both addresses are available, they are devided by the | (pipe) character.

StaticIPAddresses: Gets or sets all the static DNS rules.

Use this property to get static DNS rules from the current rules storage or restore them back between application sessions. If StaticDNS of the class is set to "local", the property returns/restores the rules from/to the internal storage of the class. If StaticDNS of the class is set to "global", the property returns/restores the rules from/to the GLOBAL storage. The rules list is returned and accepted in JSON format.

Tag: Allows to store any custom data.

Use this config property to store any custom data.

TLSSessionGroup: Specifies the group name of TLS sessions to be used for session resumption.

Use this property to limit the search of chached TLS sessions to the specified group. Sessions from other groups will be ignored. By default, all sessions are cached with an empty group name and available to all the classes.

TLSSessionLifetime: Specifies lifetime in seconds of the cached TLS session.

Use this property to specify how much time the TLS session should be kept in the session cache. After this time, the session expires and will be automatically removed from the cache. Default value is 300 seconds (5 minutes).

TLSSessionPurgeInterval: Specifies how often the session cache should remove the expired TLS sessions.

Use this property to specify the time interval of purging the expired TLS sessions from the session cache. Default value is 60 seconds (1 minute).

UseCRLObjectCaching: Specifies whether reuse of loaded CRL objects is enabled.

This setting enables or disables the caching of CRL objects. When set to true (the default value), the system checks if a CRL object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where CRL objects are frequently used.

UseInternalRandom: Switches between SecureBlackbox-own and platform PRNGs.

Allows to switch between internal/native PRNG implementation and the one provided by the platform.

UseLegacyAdESValidation: Enables legacy AdES validation mode.

Use this setting to switch the AdES component to the validation approach that was used in SBB 2020/SBB 2022 (less attention to temporal details).

UseOCSPResponseObjectCaching: Specifies whether reuse of loaded OCSP response objects is enabled.

This setting enables or disables the caching of OCSP response objects. When set to true (the default value), the system checks if a OCSP response object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where OCSP response objects are frequently used.

UseOwnDNSResolver: Specifies whether the client components should use own DNS resolver.

Set this global property to false to force all the client components to use the DNS resolver provided by the target OS instead of using own one.

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.

UseSystemNativeSizeCalculation: An internal CryptoAPI access tweak.

This is an internal setting. Please do not use it unless instructed by the support team.

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.

XMLRDNDescriptorName[OID]: Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN.

This property defines custom mappings between Object Identifiers (OIDs) and descriptor names. This mapping specifies how the certificate's issuer and subject information (ds:IssuerRDN and ds:SubjectRDN elements respectively) are represented in XML signatures.

The property accepts comma-separated values where the first descriptor name is used when the OID is mapped, and subsequent values act as aliases for parsing.

Syntax: Config("XMLRDNDescriptorName[OID]=PrimaryName,Alias1,Alias2");

Where:

OID: The Object Identifier from the certificate's IssuerRDN or SubjectRDN that you want to map.

PrimaryName: The main descriptor name used in the XML signature when the OID is encountered.

Alias1, Alias2, ...: Optional alternative names recognized during parsing.

Usage Examples:

Map OID 2.5.4.5 to SERIALNUMBER: Config("XMLRDNDescriptorName[2.5.4.5]=SERIALNUMBER");

Map OID 1.2.840.113549.1.9.1 to E, with aliases EMAIL and EMAILADDRESS: Config("XMLRDNDescriptorName[1.2.840.113549.1.9.1]=E,EMAIL,EMAILADDRESS");

XMLRDNDescriptorPriority[OID]: Specifies the priority of descriptor names associated with a specific OID.

This property specifies the priority of descriptor names associated with a specific OID that allows to reorder descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during signing.

XMLRDNDescriptorReverseOrder: Specifies whether to reverse the order of descriptors in RDN.

Specifies whether to reverse the order of descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to true (as specified in RFC 2253, 2.1).

XMLRDNDescriptorSeparator: Specifies the separator used between descriptors in RDN.

Specifies the separator used between descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to ", " value.

Trappable Errors (SSHClient Class)

Error Handling (C++)

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