SFTPClient Class

Properties   Methods   Events   Config Settings   Errors  

The SFTPClient class provides client-side functionality for SFTP (Secure File Transfer Protocol).

Syntax

SFTPClient

Remarks

SFTP is a file transfer subsystem that runs on top of secure shell (SSH) connection. This means that SFTP uses the whole strength of security provided by the SSH protocol, at the same time providing strong file transfer capabilities.

Please do keep in mind that there exist two protocols that offer similar secure file transfer features. SFTP works on top of SSH and normally uses port 22. FTPS works on top of TLS (or SSL) and normally uses ports 21 and 990. The protocols are very different, so please make sure you are after the right component. This component works with SFTP. Use the FTPClient component to connect to FTPS servers.

Below are the typical steps that let you integrate SFTPClient to your project:

  • Set up your Username and Password. SSH uses mandatory client-side authentication, so in most cases you need to provide your username, your password, or, sometimes, your private key. Use Key property to provide your key, if needed.
  • Be ready to handle server authentication, which is also mandatory in SSH. SSH operates a concept of a trusted keys file, where keys of known servers are stored. You can assign a path to your own trusted keys file to the TrustedKeysFile property. When a client receives a server key, it reports it to your code via its KnownKeyReceived or UnknownKeyReceived event, depending on whether the key was found in the trusted list. If you leave TrustedKeysFile empty, SFTPClient will only be able to fire the UnknownKeyReceived event, since there will be no known keys to report.
  • If needed, customize Proxy parameters and SSHSettings.
  • Consider interacting more with SFTPClient by subscribing to AuthAttempt, AuthFailed, and AuthSucceeded events to be notified about the client authentication progress.
  • When you are ready to connect, call Connect, passing the details of the server as parameters. During the initial handshake, the following events will fire: UnknownKeyReceived (or KnownKeyReceived), and then one or more AuthAttempt, AuthFailed and AuthSucceeded.
  • Upon completion of the Connect method, the component is ready for file operations. Use DownloadFile, UploadFile, ListDir, DeleteFile and other file transfer methods to work with the server file system.
  • When you are done with your work, call Disconnect to close the connection.

Some SFTP servers, primarily older ones, may expose various transfer issues. If you come across a weird issue that you believe should not be happening (such as repeated connection closures in the middle of the transfer), please try adjusting the following properties:

These adjustments will put SFTPClient in very conservative transfer setup. While this setup may be quite sluggish with modern servers, it should make SFTPClient interoperable with most older servers.

Property List


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

AuthAttemptsSpecifies the number of SSH authentication attempts.
AutoAdjustTransferBlockSpecifies whether to adjust the send and receive buffer sizes automatically.
ConflictResolutionModeToDo.
ConnectedIndicates if the client is connected to the SFTP server.
ConnectionInfoContains the secure connection info.
CurrentListEntryContains the current entry returned by ListDir .
DownloadBlockSizeThe download block size in bytes.
ExternalCryptoProvides access to external signing and DC parameters.
FIPSModeReserved.
ForceCompressionEnforces compression for the SSH layer.
KeyContains the client's SSH key.
MaxSFTPVersionHigher SFTP version to support.
MinSFTPVersionLower SFTP version to support.
PasswordSpecifies user's authentication password.
PipelineLengthThe number of parallelized transfer requests.
ProxyThe proxy server settings.
ServerKeyReturns the server's public key.
SocketSettingsManages network connection settings.
SSHSettingsThe SSH connection settings.
TrustedKeysFileA file containing the keys of authorized servers.
UploadBlockSizeThe upload block size in bytes.
UsernameThe client's username to authenticate to the server.
UseUTF8Enables UTF8 for all string content.
VersionThe SFTP version negotiated.

Method List


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

AbsolutePathRequests the absolute path for a relative path.
ChangeDirChanges current working directory on the server.
ConfigThis method sets or retrieves a configuration setting.
ConnectConnects to an SFTP server.
CreateLinkCreates a symbolic or hard link to a remote file.
DeleteDirRemoves directory from the SFTP server.
DeleteFileDeletes a file from the SFTP server.
DeleteFilesDeletes a group of files from the SFTP server.
DirExistsChecks if a directory exists on the SFTP server.
DisconnectDisconnects from the SFTP server.
DoActionPerforms an additional action.
DownloadBytesDownloads a file from the server into an array of bytes.
DownloadFileDownloads a file from the SFTP server.
DownloadFilesDownloads multiple files from the SFTP server.
DownloadStreamDownloads a file from the SFTP server.
ExecuteSSHCommandSends an SSH command to the server in the middle of SFTP session.
ExtensionCmdSends an extension command to the server.
FileExistsChecks whether a file exists on the server.
GetCurrentDirReturns the current directory on the SFTP server.
GetFileSizeChecks the size of a remote file.
ListDirLists the content of the current remote directory.
MakeDirCreates a new directory on the server.
RenameFileRenames a file.
RequestAttributesRequests attributes of the remote file.
ResetResets the class settings.
SetAttributesSets the attributes upon a remote file.
UploadBytesUploads a byte array to the server.
UploadFileUploads a file to the server.
UploadFilesUploads multiple files to the server.
UploadStreamUploads a file to the server.

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.

AuthAttemptFires when an authentication attempt is performed.
AuthFailedFires if an authentication attempt fails.
AuthSucceededReports a successful authentication.
BannerReports the receipt of the Welcome message from the server.
DisconnectReports SFTP connection closure.
ErrorInformation about errors during SFTP connection.
ExternalSignHandles remote or external signing initiated by the SignExternal method or other source.
FileNameChangeNeededToDo.
FileOperationSignifies the start of a file transfer operation.
FileOperationResultSignifies the completion of a file transfer operation.
KnownKeyReceivedSignals that the server has introduced itself with a known key.
ListEntryReports a directory listing entry to the application.
NotificationThis event notifies the application about an underlying control flow event.
PasswordChangeRequestSignals that the server requests a password change.
PrivateKeyNeededAsks the application for the client's private key.
ProgressFires periodically during the data transfer.
UnknownKeyReceivedSignals 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.

AdjustFileTimesWhether file times should be adjusted after upload/download.
ASCIIModeWhether ASCII transfer mode is used.
AvailableSpaceReturns details of server disk space availability. This protocol extension must be supported by the server for this request to work.
CaseConversionWhether case conversion must be applied to file names as they are downloaded.
CaseSensitiveSpecifies if file paths are case-sensitive.
CopyModeDefines what to do with each successfully copied file.
DefOutboundBlockSizeThe default outbound block size.
DisablePacketFragmentationEnables or disables SSH packet fragmentation.
ErrorOriginSpecifies whether the error is local or remote.
ErrorSeveritySpecifies whether the error is fatal.
FileHashReturns the hash of the specified file. This protocol extension must be supported by the server for this request to work.
HashAlgorithmThe hash algorithm to use for the protocol operations.
HomeDirReturns a user's home directory. This protocol extension must be supported by the server for this request to work.
IncomingSpeedLimitSpecifies incoming speed limit.
KeepAlivePeriodThe inactivity period after which a keep-alive signal will be sent.
LocalCharsetCharset used on the client machine.
LocalNewLineConventionA character string for the end of line (EOL) indication on the local machine.
NewLineConventionA character string for the end of line (EOL) indication on the server.
OutgoingSpeedLimitSpecifies incoming speed limit.
PreserveExistingFileTimesWhether original file times should be restored upon transfer.
RecursiveWhether subdirectories should also be scanned for matching files.
RedirectStdErrWhether to redirect output to StdErr.
RemoteCharsetCharset used on the server.
SFTPBufferSizeThe size of internal buffer used for data transfer.
SFTPServerExecutableLocationsLocation of the SFTP server executable.
StatVFSReturns VFS details. This protocol extension must be supported by the server for this request to work.
StdErrDataThe buffer for writing StdErr data.
TempFolderReturns the temporary directory offered by the server. This protocol extension must be supported by the server for this request to work.
TempPathLocation where the temporary files are stored.
TreatZeroSizeAsUndefinedWhether zero size returned by STAT should be considered as undefined.
UseStrictKeyExchangeSpecifies how strict key exchange is supported.
UseTruncateFlagOnUploadwhether to use the 'truncate' flag on file upload.
UseUTF8OnV3Whether to apply UTF-8 conversion for SFTP protocol versions 3 and lower.
CheckKeyIntegrityBeforeUseEnables or disable private key integrity check before use.
CookieCachingSpecifies whether a cookie cache should be used for HTTP(S) transports.
CookiesGets or sets local cookies for the class.
DefDeriveKeyIterationsSpecifies the default key derivation algorithm iteration count.
EnableClientSideSSLFFDHEEnables or disables finite field DHE key exchange support in TLS clients.
GlobalCookiesGets or sets global cookies for all the HTTP transports.
HttpUserAgentSpecifies the user agent name to be used by all HTTP clients.
LogDestinationSpecifies the debug log destination.
LogDetailsSpecifies the debug log details to dump.
LogFileSpecifies the debug log filename.
LogFiltersSpecifies the debug log filters.
LogFlushModeSpecifies the log flush mode.
LogLevelSpecifies the debug log level.
LogMaxEventCountSpecifies the maximum number of events to cache before further action is taken.
LogRotationModeSpecifies the log rotation mode.
MaxASN1BufferLengthSpecifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepthSpecifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithmSpecifies the hash algorithm to be used to identify certificates in OCSP requests.
StaticDNSSpecifies whether static DNS rules should be used.
StaticIPAddress[domain]Gets or sets an IP address for the specified domain name.
StaticIPAddressesGets or sets all the static DNS rules.
TagAllows to store any custom data.
TLSSessionGroupSpecifies the group name of TLS sessions to be used for session resumption.
TLSSessionLifetimeSpecifies lifetime in seconds of the cached TLS session.
TLSSessionPurgeIntervalSpecifies how often the session cache should remove the expired TLS sessions.
UseOwnDNSResolverSpecifies whether the client classes should use own DNS resolver.
UseSharedSystemStoragesSpecifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemOAEPAndPSSEnforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandomEnables or disables the use of the OS PRNG.

AuthAttempts Property (SFTPClient Class)

Specifies the number of SSH authentication attempts.

Syntax

ANSI (Cross Platform)
int GetAuthAttempts();
int SetAuthAttempts(int iAuthAttempts); Unicode (Windows) INT GetAuthAttempts();
INT SetAuthAttempts(INT iAuthAttempts);
int secureblackbox_sftpclient_getauthattempts(void* lpObj);
int secureblackbox_sftpclient_setauthattempts(void* lpObj, int iAuthAttempts);
int GetAuthAttempts();
int SetAuthAttempts(int iAuthAttempts);

Default Value

1

Remarks

Use this property to specify the number of authentication attempts to try. The AuthFailed event is fired for every failed attempt.

Data Type

Integer

AutoAdjustTransferBlock Property (SFTPClient Class)

Specifies whether to adjust the send and receive buffer sizes automatically.

Syntax

ANSI (Cross Platform)
int GetAutoAdjustTransferBlock();
int SetAutoAdjustTransferBlock(int bAutoAdjustTransferBlock); Unicode (Windows) BOOL GetAutoAdjustTransferBlock();
INT SetAutoAdjustTransferBlock(BOOL bAutoAdjustTransferBlock);
int secureblackbox_sftpclient_getautoadjusttransferblock(void* lpObj);
int secureblackbox_sftpclient_setautoadjusttransferblock(void* lpObj, int bAutoAdjustTransferBlock);
bool GetAutoAdjustTransferBlock();
int SetAutoAdjustTransferBlock(bool bAutoAdjustTransferBlock);

Default Value

TRUE

Remarks

Automatic transfer block size adjustment may be beneficial for maximizing interoperability and achieving the best transfer speeds.

Use DownloadBlockSize, UploadBlockSize, and PipelineLength properties to adjust the transfer settings manually.

Data Type

Boolean

ConflictResolutionMode Property (SFTPClient Class)

ToDo.

Syntax

ANSI (Cross Platform)
int GetConflictResolutionMode();
int SetConflictResolutionMode(int iConflictResolutionMode); Unicode (Windows) INT GetConflictResolutionMode();
INT SetConflictResolutionMode(INT iConflictResolutionMode);

Possible Values

CFTM_OVERWRITE(0), 
CFTM_SKIP(1),
CFTM_APPEND_TO_END(2),
CFTM_RESUME(3),
CFTM_OVERWRITE_IF_DIFF_SIZE(4),
CFTM_SAVE_WITH_NEW_NAME(5),
CFTM_RENAME_EXISTING_TARGET(6)
int secureblackbox_sftpclient_getconflictresolutionmode(void* lpObj);
int secureblackbox_sftpclient_setconflictresolutionmode(void* lpObj, int iConflictResolutionMode);
int GetConflictResolutionMode();
int SetConflictResolutionMode(int iConflictResolutionMode);

Default Value

0

Remarks

ToDo.

cftmOverwrite0
cftmSkip1
cftmAppendToEnd2The signature is corrupted

cftmResume3
cftmOverwriteIfDiffSize4
cftmSaveWithNewName5
cftmRenameExistingTarget5

Data Type

Integer

Connected Property (SFTPClient Class)

Indicates if the client is connected to the SFTP server.

Syntax

ANSI (Cross Platform)
int GetConnected();

Unicode (Windows)
BOOL GetConnected();
int secureblackbox_sftpclient_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 and not available at design time.

Data Type

Boolean

ConnectionInfo Property (SFTPClient Class)

Contains the secure connection info.

Syntax

SecureBlackboxSSHConnectionInfo* GetConnectionInfo();

char* secureblackbox_sftpclient_getconninfoclientkeyalgorithm(void* lpObj);
int secureblackbox_sftpclient_getconninfoclientkeybits(void* lpObj);
char* secureblackbox_sftpclient_getconninfoclientkeyfingerprint(void* lpObj);
char* secureblackbox_sftpclient_getconninfoclosereason(void* lpObj);
char* secureblackbox_sftpclient_getconninfocompressionalgorithminbound(void* lpObj);
char* secureblackbox_sftpclient_getconninfocompressionalgorithmoutbound(void* lpObj);
char* secureblackbox_sftpclient_getconninfoencryptionalgorithminbound(void* lpObj);
char* secureblackbox_sftpclient_getconninfoencryptionalgorithmoutbound(void* lpObj);
int secureblackbox_sftpclient_getconninfoinboundencryptionkeybits(void* lpObj);
char* secureblackbox_sftpclient_getconninfokexalgorithm(void* lpObj);
int secureblackbox_sftpclient_getconninfokexbits(void* lpObj);
char* secureblackbox_sftpclient_getconninfokexlines(void* lpObj);
char* secureblackbox_sftpclient_getconninfomacalgorithminbound(void* lpObj);
char* secureblackbox_sftpclient_getconninfomacalgorithmoutbound(void* lpObj);
int secureblackbox_sftpclient_getconninfooutboundencryptionkeybits(void* lpObj);
char* secureblackbox_sftpclient_getconninfopublickeyalgorithm(void* lpObj);
char* secureblackbox_sftpclient_getconninforemoteaddress(void* lpObj);
int secureblackbox_sftpclient_getconninforemoteport(void* lpObj);
char* secureblackbox_sftpclient_getconninfoserverkeyalgorithm(void* lpObj);
int secureblackbox_sftpclient_getconninfoserverkeybits(void* lpObj);
char* secureblackbox_sftpclient_getconninfoserverkeyfingerprint(void* lpObj);
char* secureblackbox_sftpclient_getconninfoserversoftwarename(void* lpObj);
int64 secureblackbox_sftpclient_getconninfototalbytesreceived(void* lpObj);
int64 secureblackbox_sftpclient_getconninfototalbytessent(void* lpObj);
int secureblackbox_sftpclient_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

CurrentListEntry Property (SFTPClient Class)

Contains the current entry returned by ListDir .

Syntax

SecureBlackboxFTPListEntry* GetCurrentListEntry();

char* secureblackbox_sftpclient_getcurrlistentryaccesstime(void* lpObj);
char* secureblackbox_sftpclient_getcurrlistentrycreationtime(void* lpObj);
int secureblackbox_sftpclient_getcurrlistentryentryformat(void* lpObj);
int secureblackbox_sftpclient_getcurrlistentryfiletype(void* lpObj);
int64 secureblackbox_sftpclient_getcurrlistentryhandle(void* lpObj);
char* secureblackbox_sftpclient_getcurrlistentrymodificationtime(void* lpObj);
char* secureblackbox_sftpclient_getcurrlistentryname(void* lpObj);
char* secureblackbox_sftpclient_getcurrlistentrypath(void* lpObj);
char* secureblackbox_sftpclient_getcurrlistentryprincipal(void* lpObj);
int64 secureblackbox_sftpclient_getcurrlistentrysize(void* lpObj);
int secureblackbox_sftpclient_getcurrlistentryunixperms(void* lpObj);
char* secureblackbox_sftpclient_getcurrlistentryunparsedname(void* lpObj);
QString GetCurrListEntryAccessTime();

QString GetCurrListEntryCreationTime();

int GetCurrListEntryEntryFormat();

int GetCurrListEntryFileType();

qint64 GetCurrListEntryHandle();

QString GetCurrListEntryModificationTime();

QString GetCurrListEntryName();

QString GetCurrListEntryPath();

QString GetCurrListEntryPrincipal();

qint64 GetCurrListEntrySize();

int GetCurrListEntryUnixPerms();

QString GetCurrListEntryUnparsedName();

Remarks

Use this property to access the current list entry as returned by ListDir call. Entries are passed back to the application one by one, with ListEntry thrown for each entry.

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

Data Type

SecureBlackboxFTPListEntry

DownloadBlockSize Property (SFTPClient Class)

The download block size in bytes.

Syntax

ANSI (Cross Platform)
int GetDownloadBlockSize();
int SetDownloadBlockSize(int iDownloadBlockSize); Unicode (Windows) INT GetDownloadBlockSize();
INT SetDownloadBlockSize(INT iDownloadBlockSize);
int secureblackbox_sftpclient_getdownloadblocksize(void* lpObj);
int secureblackbox_sftpclient_setdownloadblocksize(void* lpObj, int iDownloadBlockSize);
int GetDownloadBlockSize();
int SetDownloadBlockSize(int iDownloadBlockSize);

Default Value

65536

Remarks

Use this property to manually control the size of download blocks. Typically you will only need to adjust this property if the default transfer settings (AutoAdjustTransferBlock) don't work.

Data Type

Integer

ExternalCrypto Property (SFTPClient Class)

Provides access to external signing and DC parameters.

Syntax

SecureBlackboxExternalCrypto* GetExternalCrypto();

char* secureblackbox_sftpclient_getexternalcryptoasyncdocumentid(void* lpObj);
int secureblackbox_sftpclient_setexternalcryptoasyncdocumentid(void* lpObj, const char* lpszExternalCryptoAsyncDocumentID);
char* secureblackbox_sftpclient_getexternalcryptocustomparams(void* lpObj);
int secureblackbox_sftpclient_setexternalcryptocustomparams(void* lpObj, const char* lpszExternalCryptoCustomParams);
char* secureblackbox_sftpclient_getexternalcryptodata(void* lpObj);
int secureblackbox_sftpclient_setexternalcryptodata(void* lpObj, const char* lpszExternalCryptoData);
int secureblackbox_sftpclient_getexternalcryptoexternalhashcalculation(void* lpObj);
int secureblackbox_sftpclient_setexternalcryptoexternalhashcalculation(void* lpObj, int bExternalCryptoExternalHashCalculation);
char* secureblackbox_sftpclient_getexternalcryptohashalgorithm(void* lpObj);
int secureblackbox_sftpclient_setexternalcryptohashalgorithm(void* lpObj, const char* lpszExternalCryptoHashAlgorithm);
char* secureblackbox_sftpclient_getexternalcryptokeyid(void* lpObj);
int secureblackbox_sftpclient_setexternalcryptokeyid(void* lpObj, const char* lpszExternalCryptoKeyID);
char* secureblackbox_sftpclient_getexternalcryptokeysecret(void* lpObj);
int secureblackbox_sftpclient_setexternalcryptokeysecret(void* lpObj, const char* lpszExternalCryptoKeySecret);
int secureblackbox_sftpclient_getexternalcryptomethod(void* lpObj);
int secureblackbox_sftpclient_setexternalcryptomethod(void* lpObj, int iExternalCryptoMethod);
int secureblackbox_sftpclient_getexternalcryptomode(void* lpObj);
int secureblackbox_sftpclient_setexternalcryptomode(void* lpObj, int iExternalCryptoMode);
char* secureblackbox_sftpclient_getexternalcryptopublickeyalgorithm(void* lpObj);
int secureblackbox_sftpclient_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 (SFTPClient Class)

Reserved.

Syntax

ANSI (Cross Platform)
int GetFIPSMode();
int SetFIPSMode(int bFIPSMode); Unicode (Windows) BOOL GetFIPSMode();
INT SetFIPSMode(BOOL bFIPSMode);
int secureblackbox_sftpclient_getfipsmode(void* lpObj);
int secureblackbox_sftpclient_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

ForceCompression Property (SFTPClient Class)

Enforces compression for the SSH layer.

Syntax

ANSI (Cross Platform)
int GetForceCompression();
int SetForceCompression(int bForceCompression); Unicode (Windows) BOOL GetForceCompression();
INT SetForceCompression(BOOL bForceCompression);
int secureblackbox_sftpclient_getforcecompression(void* lpObj);
int secureblackbox_sftpclient_setforcecompression(void* lpObj, int bForceCompression);
bool GetForceCompression();
int SetForceCompression(bool bForceCompression);

Default Value

FALSE

Remarks

Set this property before opening a connection to enforce compression of the SSH packets.

Data Type

Boolean

Key Property (SFTPClient Class)

Contains the client's SSH key.

Syntax

SecureBlackboxSSHKey* GetKey();
int SetKey(SecureBlackboxSSHKey* val);
char* secureblackbox_sftpclient_getkeyfingerprintsha1(void* lpObj);
char* secureblackbox_sftpclient_getkeyfingerprintsha256(void* lpObj);
int64 secureblackbox_sftpclient_getkeyhandle(void* lpObj);
int secureblackbox_sftpclient_setkeyhandle(void* lpObj, int64 lKeyHandle);
QString GetKeyFingerprintSHA1();

QString GetKeyFingerprintSHA256();

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

Remarks

Use this property to provide the client's SSH key for authentication. Note that you may start with providing the public part of the key, and only complete it with the private part in response to PrivateKeyNeeded event.

Alternative, you may load the private key straightaway.

This property is not available at design time.

Data Type

SecureBlackboxSSHKey

MaxSFTPVersion Property (SFTPClient Class)

Higher SFTP version to support.

Syntax

ANSI (Cross Platform)
int GetMaxSFTPVersion();
int SetMaxSFTPVersion(int iMaxSFTPVersion); Unicode (Windows) INT GetMaxSFTPVersion();
INT SetMaxSFTPVersion(INT iMaxSFTPVersion);
int secureblackbox_sftpclient_getmaxsftpversion(void* lpObj);
int secureblackbox_sftpclient_setmaxsftpversion(void* lpObj, int iMaxSFTPVersion);
int GetMaxSFTPVersion();
int SetMaxSFTPVersion(int iMaxSFTPVersion);

Default Value

6

Remarks

MaxSFTPVersion and MinSFTPVersion properties control the range of SFTP protocol versions supported by this client.

Data Type

Integer

MinSFTPVersion Property (SFTPClient Class)

Lower SFTP version to support.

Syntax

ANSI (Cross Platform)
int GetMinSFTPVersion();
int SetMinSFTPVersion(int iMinSFTPVersion); Unicode (Windows) INT GetMinSFTPVersion();
INT SetMinSFTPVersion(INT iMinSFTPVersion);
int secureblackbox_sftpclient_getminsftpversion(void* lpObj);
int secureblackbox_sftpclient_setminsftpversion(void* lpObj, int iMinSFTPVersion);
int GetMinSFTPVersion();
int SetMinSFTPVersion(int iMinSFTPVersion);

Default Value

0

Remarks

MaxSFTPVersion and MinSFTPVersion properties control the range of SFTP protocol versions to be supported by this client.

Data Type

Integer

Password Property (SFTPClient Class)

Specifies user's authentication password.

Syntax

ANSI (Cross Platform)
char* GetPassword();
int SetPassword(const char* lpszPassword); Unicode (Windows) LPWSTR GetPassword();
INT SetPassword(LPCWSTR lpszPassword);
char* secureblackbox_sftpclient_getpassword(void* lpObj);
int secureblackbox_sftpclient_setpassword(void* lpObj, const char* lpszPassword);
QString GetPassword();
int SetPassword(QString qsPassword);

Default Value

""

Remarks

Use this property to provide an authentication password. This property is only applicable for password-based and keyboard-interactive authentication types.

Data Type

String

PipelineLength Property (SFTPClient Class)

The number of parallelized transfer requests.

Syntax

ANSI (Cross Platform)
int GetPipelineLength();
int SetPipelineLength(int iPipelineLength); Unicode (Windows) INT GetPipelineLength();
INT SetPipelineLength(INT iPipelineLength);
int secureblackbox_sftpclient_getpipelinelength(void* lpObj);
int secureblackbox_sftpclient_setpipelinelength(void* lpObj, int iPipelineLength);
int GetPipelineLength();
int SetPipelineLength(int iPipelineLength);

Default Value

32

Remarks

This property controls the number of upload/download requests sent simultaneously. This speeds the transfer up, but may lead to issues with older/immature servers.

Typically you will only need to adjust this property if the default transfer settings (AutoAdjustTransferBlock) don't work.

Data Type

Integer

Proxy Property (SFTPClient Class)

The proxy server settings.

Syntax

char* secureblackbox_sftpclient_getproxyaddress(void* lpObj);
int secureblackbox_sftpclient_setproxyaddress(void* lpObj, const char* lpszProxyAddress);
int secureblackbox_sftpclient_getproxyauthentication(void* lpObj);
int secureblackbox_sftpclient_setproxyauthentication(void* lpObj, int iProxyAuthentication);
char* secureblackbox_sftpclient_getproxypassword(void* lpObj);
int secureblackbox_sftpclient_setproxypassword(void* lpObj, const char* lpszProxyPassword);
int secureblackbox_sftpclient_getproxyport(void* lpObj);
int secureblackbox_sftpclient_setproxyport(void* lpObj, int iProxyPort);
int secureblackbox_sftpclient_getproxyproxytype(void* lpObj);
int secureblackbox_sftpclient_setproxyproxytype(void* lpObj, int iProxyProxyType);
char* secureblackbox_sftpclient_getproxyrequestheaders(void* lpObj);
int secureblackbox_sftpclient_setproxyrequestheaders(void* lpObj, const char* lpszProxyRequestHeaders);
char* secureblackbox_sftpclient_getproxyresponsebody(void* lpObj);
int secureblackbox_sftpclient_setproxyresponsebody(void* lpObj, const char* lpszProxyResponseBody);
char* secureblackbox_sftpclient_getproxyresponseheaders(void* lpObj);
int secureblackbox_sftpclient_setproxyresponseheaders(void* lpObj, const char* lpszProxyResponseHeaders);
int secureblackbox_sftpclient_getproxyuseipv6(void* lpObj);
int secureblackbox_sftpclient_setproxyuseipv6(void* lpObj, int bProxyUseIPv6);
char* secureblackbox_sftpclient_getproxyusername(void* lpObj);
int secureblackbox_sftpclient_setproxyusername(void* lpObj, const char* lpszProxyUsername);
QString GetProxyAddress();
int SetProxyAddress(QString qsProxyAddress); int GetProxyAuthentication();
int SetProxyAuthentication(int iProxyAuthentication); QString GetProxyPassword();
int SetProxyPassword(QString qsProxyPassword); int GetProxyPort();
int SetProxyPort(int iProxyPort); int GetProxyProxyType();
int SetProxyProxyType(int iProxyProxyType); QString GetProxyRequestHeaders();
int SetProxyRequestHeaders(QString qsProxyRequestHeaders); QString GetProxyResponseBody();
int SetProxyResponseBody(QString qsProxyResponseBody); QString GetProxyResponseHeaders();
int SetProxyResponseHeaders(QString qsProxyResponseHeaders); bool GetProxyUseIPv6();
int SetProxyUseIPv6(bool bProxyUseIPv6); QString GetProxyUsername();
int SetProxyUsername(QString qsProxyUsername);

Remarks

Use this property to tune up the proxy server settings.

This property is read-only.

Data Type

SecureBlackboxProxySettings

ServerKey Property (SFTPClient Class)

Returns the server's public key.

Syntax

SecureBlackboxSSHKey* GetServerKey();

char* secureblackbox_sftpclient_getserverkeyalgorithm(void* lpObj);
int secureblackbox_sftpclient_getserverkeybits(void* lpObj);
char* secureblackbox_sftpclient_getserverkeycomment(void* lpObj);
char* secureblackbox_sftpclient_getserverkeycurve(void* lpObj);
int secureblackbox_sftpclient_getserverkeydssg(void* lpObj, char** lpServerKeyDSSG, int* lenServerKeyDSSG);
int secureblackbox_sftpclient_getserverkeydssp(void* lpObj, char** lpServerKeyDSSP, int* lenServerKeyDSSP);
int secureblackbox_sftpclient_getserverkeydssq(void* lpObj, char** lpServerKeyDSSQ, int* lenServerKeyDSSQ);
int secureblackbox_sftpclient_getserverkeydssx(void* lpObj, char** lpServerKeyDSSX, int* lenServerKeyDSSX);
int secureblackbox_sftpclient_getserverkeydssy(void* lpObj, char** lpServerKeyDSSY, int* lenServerKeyDSSY);
int secureblackbox_sftpclient_getserverkeyeccd(void* lpObj, char** lpServerKeyECCD, int* lenServerKeyECCD);
int secureblackbox_sftpclient_getserverkeyeccqx(void* lpObj, char** lpServerKeyECCQX, int* lenServerKeyECCQX);
int secureblackbox_sftpclient_getserverkeyeccqy(void* lpObj, char** lpServerKeyECCQY, int* lenServerKeyECCQY);
int secureblackbox_sftpclient_getserverkeyedprivate(void* lpObj, char** lpServerKeyEdPrivate, int* lenServerKeyEdPrivate);
int secureblackbox_sftpclient_getserverkeyedpublic(void* lpObj, char** lpServerKeyEdPublic, int* lenServerKeyEdPublic);
char* secureblackbox_sftpclient_getserverkeyfingerprintmd5(void* lpObj);
char* secureblackbox_sftpclient_getserverkeyfingerprintsha1(void* lpObj);
char* secureblackbox_sftpclient_getserverkeyfingerprintsha256(void* lpObj);
int64 secureblackbox_sftpclient_getserverkeyhandle(void* lpObj);
int secureblackbox_sftpclient_getserverkeyisextractable(void* lpObj);
int secureblackbox_sftpclient_getserverkeyisprivate(void* lpObj);
int secureblackbox_sftpclient_getserverkeyispublic(void* lpObj);
int secureblackbox_sftpclient_getserverkeykdfrounds(void* lpObj);
int secureblackbox_sftpclient_getserverkeykdfsalt(void* lpObj, char** lpServerKeyKDFSalt, int* lenServerKeyKDFSalt);
int secureblackbox_sftpclient_getserverkeykeyformat(void* lpObj);
char* secureblackbox_sftpclient_getserverkeykeyprotectionalgorithm(void* lpObj);
int secureblackbox_sftpclient_getserverkeyrsaexponent(void* lpObj, char** lpServerKeyRSAExponent, int* lenServerKeyRSAExponent);
int secureblackbox_sftpclient_getserverkeyrsaiqmp(void* lpObj, char** lpServerKeyRSAIQMP, int* lenServerKeyRSAIQMP);
int secureblackbox_sftpclient_getserverkeyrsamodulus(void* lpObj, char** lpServerKeyRSAModulus, int* lenServerKeyRSAModulus);
int secureblackbox_sftpclient_getserverkeyrsap(void* lpObj, char** lpServerKeyRSAP, int* lenServerKeyRSAP);
int secureblackbox_sftpclient_getserverkeyrsaprivateexponent(void* lpObj, char** lpServerKeyRSAPrivateExponent, int* lenServerKeyRSAPrivateExponent);
int secureblackbox_sftpclient_getserverkeyrsaq(void* lpObj, char** lpServerKeyRSAQ, int* lenServerKeyRSAQ);
char* secureblackbox_sftpclient_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

Use this property to check the details of the server public key.

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

Data Type

SecureBlackboxSSHKey

SocketSettings Property (SFTPClient Class)

Manages network connection settings.

Syntax

SecureBlackboxSocketSettings* GetSocketSettings();

int secureblackbox_sftpclient_getsocketdnsmode(void* lpObj);
int secureblackbox_sftpclient_setsocketdnsmode(void* lpObj, int iSocketDNSMode);
int secureblackbox_sftpclient_getsocketdnsport(void* lpObj);
int secureblackbox_sftpclient_setsocketdnsport(void* lpObj, int iSocketDNSPort);
int secureblackbox_sftpclient_getsocketdnsquerytimeout(void* lpObj);
int secureblackbox_sftpclient_setsocketdnsquerytimeout(void* lpObj, int iSocketDNSQueryTimeout);
char* secureblackbox_sftpclient_getsocketdnsservers(void* lpObj);
int secureblackbox_sftpclient_setsocketdnsservers(void* lpObj, const char* lpszSocketDNSServers);
int secureblackbox_sftpclient_getsocketdnstotaltimeout(void* lpObj);
int secureblackbox_sftpclient_setsocketdnstotaltimeout(void* lpObj, int iSocketDNSTotalTimeout);
int secureblackbox_sftpclient_getsocketincomingspeedlimit(void* lpObj);
int secureblackbox_sftpclient_setsocketincomingspeedlimit(void* lpObj, int iSocketIncomingSpeedLimit);
char* secureblackbox_sftpclient_getsocketlocaladdress(void* lpObj);
int secureblackbox_sftpclient_setsocketlocaladdress(void* lpObj, const char* lpszSocketLocalAddress);
int secureblackbox_sftpclient_getsocketlocalport(void* lpObj);
int secureblackbox_sftpclient_setsocketlocalport(void* lpObj, int iSocketLocalPort);
int secureblackbox_sftpclient_getsocketoutgoingspeedlimit(void* lpObj);
int secureblackbox_sftpclient_setsocketoutgoingspeedlimit(void* lpObj, int iSocketOutgoingSpeedLimit);
int secureblackbox_sftpclient_getsockettimeout(void* lpObj);
int secureblackbox_sftpclient_setsockettimeout(void* lpObj, int iSocketTimeout);
int secureblackbox_sftpclient_getsocketuseipv6(void* lpObj);
int secureblackbox_sftpclient_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 (SFTPClient Class)

The SSH connection settings.

Syntax

SecureBlackboxSSHSettings* GetSSHSettings();

int secureblackbox_sftpclient_getsshsettingsautoadjustciphers(void* lpObj);
int secureblackbox_sftpclient_setsshsettingsautoadjustciphers(void* lpObj, int bSSHSettingsAutoAdjustCiphers);
int secureblackbox_sftpclient_getsshsettingsbaseconfiguration(void* lpObj);
int secureblackbox_sftpclient_setsshsettingsbaseconfiguration(void* lpObj, int iSSHSettingsBaseConfiguration);
char* secureblackbox_sftpclient_getsshsettingscompressionalgorithms(void* lpObj);
int secureblackbox_sftpclient_setsshsettingscompressionalgorithms(void* lpObj, const char* lpszSSHSettingsCompressionAlgorithms);
int secureblackbox_sftpclient_getsshsettingscompressionlevel(void* lpObj);
int secureblackbox_sftpclient_setsshsettingscompressionlevel(void* lpObj, int iSSHSettingsCompressionLevel);
int secureblackbox_sftpclient_getsshsettingsdefaultwindowsize(void* lpObj);
int secureblackbox_sftpclient_setsshsettingsdefaultwindowsize(void* lpObj, int iSSHSettingsDefaultWindowSize);
char* secureblackbox_sftpclient_getsshsettingsencryptionalgorithms(void* lpObj);
int secureblackbox_sftpclient_setsshsettingsencryptionalgorithms(void* lpObj, const char* lpszSSHSettingsEncryptionAlgorithms);
int secureblackbox_sftpclient_getsshsettingsforcecompression(void* lpObj);
int secureblackbox_sftpclient_setsshsettingsforcecompression(void* lpObj, int bSSHSettingsForceCompression);
int secureblackbox_sftpclient_getsshsettingsforwardauthagent(void* lpObj);
int secureblackbox_sftpclient_setsshsettingsforwardauthagent(void* lpObj, int bSSHSettingsForwardAuthAgent);
char* secureblackbox_sftpclient_getsshsettingsgssauthtypes(void* lpObj);
int secureblackbox_sftpclient_setsshsettingsgssauthtypes(void* lpObj, const char* lpszSSHSettingsGSSAuthTypes);
int secureblackbox_sftpclient_getsshsettingsgssdelegatecreds(void* lpObj);
int secureblackbox_sftpclient_setsshsettingsgssdelegatecreds(void* lpObj, int bSSHSettingsGSSDelegateCreds);
char* secureblackbox_sftpclient_getsshsettingsgsshostname(void* lpObj);
int secureblackbox_sftpclient_setsshsettingsgsshostname(void* lpObj, const char* lpszSSHSettingsGSSHostname);
char* secureblackbox_sftpclient_getsshsettingsgsslib(void* lpObj);
int secureblackbox_sftpclient_setsshsettingsgsslib(void* lpObj, const char* lpszSSHSettingsGSSLib);
char* secureblackbox_sftpclient_getsshsettingsgssmechanisms(void* lpObj);
int secureblackbox_sftpclient_setsshsettingsgssmechanisms(void* lpObj, const char* lpszSSHSettingsGSSMechanisms);
char* secureblackbox_sftpclient_getsshsettingsgssprotocols(void* lpObj);
int secureblackbox_sftpclient_setsshsettingsgssprotocols(void* lpObj, const char* lpszSSHSettingsGSSProtocols);
int secureblackbox_sftpclient_getsshsettingshandshaketimeout(void* lpObj);
int secureblackbox_sftpclient_setsshsettingshandshaketimeout(void* lpObj, int iSSHSettingsHandshakeTimeout);
char* secureblackbox_sftpclient_getsshsettingskexalgorithms(void* lpObj);
int secureblackbox_sftpclient_setsshsettingskexalgorithms(void* lpObj, const char* lpszSSHSettingsKexAlgorithms);
char* secureblackbox_sftpclient_getsshsettingsmacalgorithms(void* lpObj);
int secureblackbox_sftpclient_setsshsettingsmacalgorithms(void* lpObj, const char* lpszSSHSettingsMacAlgorithms);
int secureblackbox_sftpclient_getsshsettingsmaxsshpacketsize(void* lpObj);
int secureblackbox_sftpclient_setsshsettingsmaxsshpacketsize(void* lpObj, int iSSHSettingsMaxSSHPacketSize);
int secureblackbox_sftpclient_getsshsettingsminwindowsize(void* lpObj);
int secureblackbox_sftpclient_setsshsettingsminwindowsize(void* lpObj, int iSSHSettingsMinWindowSize);
int secureblackbox_sftpclient_getsshsettingsobfuscatehandshake(void* lpObj);
int secureblackbox_sftpclient_setsshsettingsobfuscatehandshake(void* lpObj, int bSSHSettingsObfuscateHandshake);
char* secureblackbox_sftpclient_getsshsettingsobfuscationpassword(void* lpObj);
int secureblackbox_sftpclient_setsshsettingsobfuscationpassword(void* lpObj, const char* lpszSSHSettingsObfuscationPassword);
char* secureblackbox_sftpclient_getsshsettingspublickeyalgorithms(void* lpObj);
int secureblackbox_sftpclient_setsshsettingspublickeyalgorithms(void* lpObj, const char* lpszSSHSettingsPublicKeyAlgorithms);
int secureblackbox_sftpclient_getsshsettingsrequestpasswordchange(void* lpObj);
int secureblackbox_sftpclient_setsshsettingsrequestpasswordchange(void* lpObj, int bSSHSettingsRequestPasswordChange);
char* secureblackbox_sftpclient_getsshsettingssoftwarename(void* lpObj);
int secureblackbox_sftpclient_setsshsettingssoftwarename(void* lpObj, const char* lpszSSHSettingsSoftwareName);
int secureblackbox_sftpclient_getsshsettingstrustallkeys(void* lpObj);
int secureblackbox_sftpclient_setsshsettingstrustallkeys(void* lpObj, int bSSHSettingsTrustAllKeys);
int secureblackbox_sftpclient_getsshsettingsuseauthagent(void* lpObj);
int secureblackbox_sftpclient_setsshsettingsuseauthagent(void* lpObj, int bSSHSettingsUseAuthAgent);
int secureblackbox_sftpclient_getsshsettingsversions(void* lpObj);
int secureblackbox_sftpclient_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 access and tune-up the SSH layer settings.

This property is read-only.

Data Type

SecureBlackboxSSHSettings

TrustedKeysFile Property (SFTPClient Class)

A file containing the 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_sftpclient_gettrustedkeysfile(void* lpObj);
int secureblackbox_sftpclient_settrustedkeysfile(void* lpObj, const char* lpszTrustedKeysFile);
QString GetTrustedKeysFile();
int SetTrustedKeysFile(QString qsTrustedKeysFile);

Default Value

""

Remarks

Use this property to provide a path to the 'authorized_keys' file to be used by the client.

Data Type

String

UploadBlockSize Property (SFTPClient Class)

The upload block size in bytes.

Syntax

ANSI (Cross Platform)
int GetUploadBlockSize();
int SetUploadBlockSize(int iUploadBlockSize); Unicode (Windows) INT GetUploadBlockSize();
INT SetUploadBlockSize(INT iUploadBlockSize);
int secureblackbox_sftpclient_getuploadblocksize(void* lpObj);
int secureblackbox_sftpclient_setuploadblocksize(void* lpObj, int iUploadBlockSize);
int GetUploadBlockSize();
int SetUploadBlockSize(int iUploadBlockSize);

Default Value

32256

Remarks

Use this property to manually control the size of upload blocks. Typically you will only need to adjust this property if the default transfer settings (AutoAdjustTransferBlock) don't work.

Data Type

Integer

Username Property (SFTPClient Class)

The client's username to authenticate to the server.

Syntax

ANSI (Cross Platform)
char* GetUsername();
int SetUsername(const char* lpszUsername); Unicode (Windows) LPWSTR GetUsername();
INT SetUsername(LPCWSTR lpszUsername);
char* secureblackbox_sftpclient_getusername(void* lpObj);
int secureblackbox_sftpclient_setusername(void* lpObj, const char* lpszUsername);
QString GetUsername();
int SetUsername(QString qsUsername);

Default Value

""

Remarks

Use this property to provide an authentication username (login). This property is only applicable for password-based and keyboard-interactive authentication types.

Data Type

String

UseUTF8 Property (SFTPClient Class)

Enables UTF8 for all string content.

Syntax

ANSI (Cross Platform)
int GetUseUTF8();
int SetUseUTF8(int bUseUTF8); Unicode (Windows) BOOL GetUseUTF8();
INT SetUseUTF8(BOOL bUseUTF8);
int secureblackbox_sftpclient_getuseutf8(void* lpObj);
int secureblackbox_sftpclient_setuseutf8(void* lpObj, int bUseUTF8);
bool GetUseUTF8();
int SetUseUTF8(bool bUseUTF8);

Default Value

FALSE

Remarks

If UseUTF8 is true, the class expects all downloaded filenames to be encoded in UTF-8. Set UseUTF8 to false if you connect to a server that does not support UTF8 (e.g., OpenSSH). In this case the file names will be interpreted in the default character set.

Data Type

Boolean

Version Property (SFTPClient Class)

The SFTP version negotiated.

Syntax

ANSI (Cross Platform)
int GetVersion();

Unicode (Windows)
INT GetVersion();
int secureblackbox_sftpclient_getversion(void* lpObj);
int GetVersion();

Default Value

0

Remarks

Use this property to get the negotiated SFTP version.

This property is read-only.

Data Type

Integer

AbsolutePath Method (SFTPClient Class)

Requests the absolute path for a relative path.

Syntax

ANSI (Cross Platform)
char* AbsolutePath(const char* lpszRemotePath);

Unicode (Windows)
LPWSTR AbsolutePath(LPCWSTR lpszRemotePath);
char* secureblackbox_sftpclient_absolutepath(void* lpObj, const char* lpszRemotePath);
QString AbsolutePath(const QString& qsRemotePath);

Remarks

Use this method to ask the SFTP server to convert a relative path to an absolute.

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.

ChangeDir Method (SFTPClient Class)

Changes current working directory on the server.

Syntax

ANSI (Cross Platform)
int ChangeDir(const char* lpszRemoteDir);

Unicode (Windows)
INT ChangeDir(LPCWSTR lpszRemoteDir);
int secureblackbox_sftpclient_changedir(void* lpObj, const char* lpszRemoteDir);
int ChangeDir(const QString& qsRemoteDir);

Remarks

Changes current working directory on the server to RemoteDir.

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

Config Method (SFTPClient Class)

This method sets or retrieves a configuration setting.

Syntax

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

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);
char* secureblackbox_sftpclient_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 (SFTPClient Class)

Connects to an SFTP server.

Syntax

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

Unicode (Windows)
INT Connect(LPCWSTR lpszAddress, INT iPort);
int secureblackbox_sftpclient_connect(void* lpObj, const char* lpszAddress, int iPort);
int Connect(const QString& qsAddress, int iPort);

Remarks

Use this method to connect to the SFTP server identified via its Address and Port.

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

CreateLink Method (SFTPClient Class)

Creates a symbolic or hard link to a remote file.

Syntax

Remarks

Use this method to create a symbolic or hard link on the server. Provide the name of the new link object via the LinkPath parameter, and the destinating file or directory path via the TargetPath parameter. HardLink specifies whether the new link should be hard (true) or symbolic (false).

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

DeleteDir Method (SFTPClient Class)

Removes directory from the SFTP server.

Syntax

ANSI (Cross Platform)
int DeleteDir(const char* lpszRemoteDir);

Unicode (Windows)
INT DeleteDir(LPCWSTR lpszRemoteDir);
int secureblackbox_sftpclient_deletedir(void* lpObj, const char* lpszRemoteDir);
int DeleteDir(const QString& qsRemoteDir);

Remarks

Use RemoteDir to provide a path to the directory to be deleted.

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

DeleteFile Method (SFTPClient Class)

Deletes a file from the SFTP server.

Syntax

ANSI (Cross Platform)
int DeleteFile(const char* lpszRemoteFile);

Unicode (Windows)
INT DeleteFile(LPCWSTR lpszRemoteFile);
int secureblackbox_sftpclient_deletefile(void* lpObj, const char* lpszRemoteFile);
int DeleteFile(const QString& qsRemoteFile);

Remarks

Use the RemoteFile parameter to specify the name of the file to delete.

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

DeleteFiles Method (SFTPClient Class)

Deletes a group of files from the SFTP server.

Syntax

ANSI (Cross Platform)
int DeleteFiles(const char* lpszRemotePath, const char* lpszMask, int bCaseSensitive, int bRecursive, int iErrorHandling);

Unicode (Windows)
INT DeleteFiles(LPCWSTR lpszRemotePath, LPCWSTR lpszMask, BOOL bCaseSensitive, BOOL bRecursive, INT iErrorHandling);
int secureblackbox_sftpclient_deletefiles(void* lpObj, const char* lpszRemotePath, const char* lpszMask, int bCaseSensitive, int bRecursive, int iErrorHandling);
int DeleteFiles(const QString& qsRemotePath, const QString& qsMask, bool bCaseSensitive, bool bRecursive, int iErrorHandling);

Remarks

Use this method to delete a group of files from the SFTP server. Specify the files to be deleted via RemotePath and Mask parameters. Use CaseSensitive and Recursive parameters to tune up the operation.

The ErrorHandling parameter specifies the error handling tactics.

ehStopOnFailure0Stop on the first failure and throw an exception

ehIgnoreErrors1Ignore individual processing errors, just proceed to the next item on the list

ehTryAllItems2Try to process all the items by ignoring any mid-way errors, but throw an exception at the end of the processing if any of the items failed to process

This method is a more efficient way to delete a group of files than deleting them one by one.

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

DirExists Method (SFTPClient Class)

Checks if a directory exists on the SFTP server.

Syntax

ANSI (Cross Platform)
bool DirExists(const char* lpszRemoteDir);

Unicode (Windows)
INT DirExists(LPCWSTR lpszRemoteDir);
bool secureblackbox_sftpclient_direxists(void* lpObj, const char* lpszRemoteDir);
bool DirExists(const QString& qsRemoteDir);

Remarks

RemoteDir specifies the name of the remote directory to check for existence.

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.

Disconnect Method (SFTPClient Class)

Disconnects from the SFTP server.

Syntax

ANSI (Cross Platform)
int Disconnect();

Unicode (Windows)
INT Disconnect();
int secureblackbox_sftpclient_disconnect(void* lpObj);
int Disconnect();

Remarks

Call this method to disconnect from the SFTP server.

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

DoAction Method (SFTPClient 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_sftpclient_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;....

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.

DownloadBytes Method (SFTPClient Class)

Downloads a file from the server into an array of bytes.

Syntax

ANSI (Cross Platform)
char* DownloadBytes(const char* lpszRemoteFile, int *lpSize = NULL);

Unicode (Windows)
LPSTR DownloadBytes(LPCWSTR lpszRemoteFile, LPINT lpSize = NULL);
char* secureblackbox_sftpclient_downloadbytes(void* lpObj, const char* lpszRemoteFile, int *lpSize);
QByteArray DownloadBytes(const QString& qsRemoteFile);

Remarks

Use this method to download RemoteFile into a byte array.

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.

DownloadFile Method (SFTPClient Class)

Downloads a file from the SFTP server.

Syntax

ANSI (Cross Platform)
int DownloadFile(const char* lpszRemoteFile, const char* lpszLocalFile);

Unicode (Windows)
INT DownloadFile(LPCWSTR lpszRemoteFile, LPCWSTR lpszLocalFile);
int secureblackbox_sftpclient_downloadfile(void* lpObj, const char* lpszRemoteFile, const char* lpszLocalFile);
int DownloadFile(const QString& qsRemoteFile, const QString& qsLocalFile);

Remarks

Use this method to download RemoteFile into the location specified by LocalFile.

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

DownloadFiles Method (SFTPClient Class)

Downloads multiple files from the SFTP server.

Syntax

ANSI (Cross Platform)
int DownloadFiles(const char* lpszRemotePath, const char* lpszLocalDir, int bRecursive, int iErrorHandling);

Unicode (Windows)
INT DownloadFiles(LPCWSTR lpszRemotePath, LPCWSTR lpszLocalDir, BOOL bRecursive, INT iErrorHandling);
int secureblackbox_sftpclient_downloadfiles(void* lpObj, const char* lpszRemotePath, const char* lpszLocalDir, int bRecursive, int iErrorHandling);
int DownloadFiles(const QString& qsRemotePath, const QString& qsLocalDir, bool bRecursive, int iErrorHandling);

Remarks

RemotePath contains a file mask or regular expression by which the files are selected for download.

LocalDir specifies the local folder where the files should be saved. The Recursive parameter tells the component whether it should navigate source directories recursively when downloading files. If set to false, only the files residing in the actual RemotePath, but not its subdirectories, will be downloaded.

The ErrorHandling parameter specifies the error handling tactics.

ehStopOnFailure0Stop on the first failure and throw an exception

ehIgnoreErrors1Ignore individual processing errors, just proceed to the next item on the list

ehTryAllItems2Try to process all the items by ignoring any mid-way errors, but throw an exception at the end of the processing if any of the items failed to process

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

DownloadStream Method (SFTPClient Class)

Downloads a file from the SFTP server.

Syntax

ANSI (Cross Platform)
int DownloadStream(const char* lpszRemoteFile, SecureBlackboxStream* sLocalStream);

Unicode (Windows)
INT DownloadStream(LPCWSTR lpszRemoteFile, SecureBlackboxStream* sLocalStream);
int secureblackbox_sftpclient_downloadstream(void* lpObj, const char* lpszRemoteFile, SecureBlackboxStream* sLocalStream);
int DownloadStream(const QString& qsRemoteFile, SecureBlackboxStream* sLocalStream);

Remarks

Use this method to download RemoteFile into a LocalStream object.

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

ExecuteSSHCommand Method (SFTPClient Class)

Sends an SSH command to the server in the middle of SFTP session.

Syntax

ANSI (Cross Platform)
char* ExecuteSSHCommand(const char* lpszCommand, int *lpSize = NULL);

Unicode (Windows)
LPSTR ExecuteSSHCommand(LPCWSTR lpszCommand, LPINT lpSize = NULL);
char* secureblackbox_sftpclient_executesshcommand(void* lpObj, const char* lpszCommand, int *lpSize);
QByteArray ExecuteSSHCommand(const QString& qsCommand);

Remarks

Use this command to send an SSH command to the server in the middle of an SFTP session. The command is executed in a secondary channel, so the SFTP connection is not affected.

This method is suitable for simple commands that do not require interaction with the user. The call returns the command output.

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.

ExtensionCmd Method (SFTPClient Class)

Sends an extension command to the server.

Syntax

ANSI (Cross Platform)
char* ExtensionCmd(const char* lpszExtn, const char* lpDataBuffer, int lenDataBuffer, int *lpSize = NULL);

Unicode (Windows)
LPSTR ExtensionCmd(LPCWSTR lpszExtn, LPCSTR lpDataBuffer, INT lenDataBuffer, LPINT lpSize = NULL);
char* secureblackbox_sftpclient_extensioncmd(void* lpObj, const char* lpszExtn, const char* lpDataBuffer, int lenDataBuffer, int *lpSize);
QByteArray ExtensionCmd(const QString& qsExtn, QByteArray qbaDataBuffer);

Remarks

Use this method to send an extension command to the SFTP server. Provide the extension type via the Extn parameter, and the request body via the DataBuffer parameter.

Upon completion of the command, the method returns the response as received from the server.

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.

FileExists Method (SFTPClient Class)

Checks whether a file exists on the server.

Syntax

ANSI (Cross Platform)
bool FileExists(const char* lpszRemoteFile);

Unicode (Windows)
INT FileExists(LPCWSTR lpszRemoteFile);
bool secureblackbox_sftpclient_fileexists(void* lpObj, const char* lpszRemoteFile);
bool FileExists(const QString& qsRemoteFile);

Remarks

Use this method to check if a RemoteFile exists on the server.

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.

GetCurrentDir Method (SFTPClient Class)

Returns the current directory on the SFTP server.

Syntax

ANSI (Cross Platform)
char* GetCurrentDir();

Unicode (Windows)
LPWSTR GetCurrentDir();
char* secureblackbox_sftpclient_getcurrentdir(void* lpObj);
QString GetCurrentDir();

Remarks

Use this method to retrieve the current directory as stored by the class. This is a virtualized current directory, as SFTP protocol does not maintain a concept of the current directory.

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.

GetFileSize Method (SFTPClient Class)

Checks the size of a remote file.

Syntax

ANSI (Cross Platform)
int64 GetFileSize(const char* lpszRemoteFile);

Unicode (Windows)
LONG64 GetFileSize(LPCWSTR lpszRemoteFile);
int64 secureblackbox_sftpclient_getfilesize(void* lpObj, const char* lpszRemoteFile);
qint64 GetFileSize(const QString& qsRemoteFile);

Remarks

Returns the size of the RemoteFile.

Error Handling (C++)

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

ListDir Method (SFTPClient Class)

Lists the content of the current remote directory.

Syntax

ANSI (Cross Platform)
char* ListDir(int bIncludeFiles, int bIncludeDirectories);

Unicode (Windows)
LPWSTR ListDir(BOOL bIncludeFiles, BOOL bIncludeDirectories);
char* secureblackbox_sftpclient_listdir(void* lpObj, int bIncludeFiles, int bIncludeDirectories);
QString ListDir(bool bIncludeFiles, bool bIncludeDirectories);

Remarks

IncludeFiles specifies whether file names and symlinks should be included in the results. IncludeDirectories specifies whether directory names should be included in the result.

Upon receiving the listing, the component will report each entry in it via ListEntry event.

Error Handling (C++)

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

MakeDir Method (SFTPClient Class)

Creates a new directory on the server.

Syntax

ANSI (Cross Platform)
int MakeDir(const char* lpszRemoteDir);

Unicode (Windows)
INT MakeDir(LPCWSTR lpszRemoteDir);
int secureblackbox_sftpclient_makedir(void* lpObj, const char* lpszRemoteDir);
int MakeDir(const QString& qsRemoteDir);

Remarks

RemoteDir specifies the name of the new directory.

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

RenameFile Method (SFTPClient Class)

Renames a file.

Syntax

ANSI (Cross Platform)
int RenameFile(const char* lpszSourceFile, const char* lpszDestFile);

Unicode (Windows)
INT RenameFile(LPCWSTR lpszSourceFile, LPCWSTR lpszDestFile);
int secureblackbox_sftpclient_renamefile(void* lpObj, const char* lpszSourceFile, const char* lpszDestFile);
int RenameFile(const QString& qsSourceFile, const QString& qsDestFile);

Remarks

Use this method to rename a remote file. Provide the old and the new name via SourceFile and DestFile parameters.

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

RequestAttributes Method (SFTPClient Class)

Requests attributes of the remote file.

Syntax

ANSI (Cross Platform)
char* RequestAttributes(const char* lpszRemotePath, int bFollowSymLinks);

Unicode (Windows)
LPWSTR RequestAttributes(LPCWSTR lpszRemotePath, BOOL bFollowSymLinks);
char* secureblackbox_sftpclient_requestattributes(void* lpObj, const char* lpszRemotePath, int bFollowSymLinks);
QString RequestAttributes(const QString& qsRemotePath, bool bFollowSymLinks);

Remarks

Use this method to request attributes of a remote file. Pass the name of the file via the RemotePath parameter, and use FollowSymLinks to specify whether symbolic links should be resolved.

The method returns the list of attributes as a line of semicolon-separated entries: Size=78220;Owner=user@system;Group=none@system;Permissions=432;ATime=2020-04-28 08:21:00.295;MTime=2020-04-28 08:21:00.302;CTime=2020-04-28 08:21:00.295;AttribBits=24;LinkCount=1.

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.

Reset Method (SFTPClient Class)

Resets the class settings.

Syntax

ANSI (Cross Platform)
int Reset();

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

Remarks

Reset is a generic method available in every class.

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

SetAttributes Method (SFTPClient Class)

Sets the attributes upon a remote file.

Syntax

ANSI (Cross Platform)
int SetAttributes(const char* lpszRemotePath, const char* lpszAttributes);

Unicode (Windows)
INT SetAttributes(LPCWSTR lpszRemotePath, LPCWSTR lpszAttributes);
int secureblackbox_sftpclient_setattributes(void* lpObj, const char* lpszRemotePath, const char* lpszAttributes);
int SetAttributes(const QString& qsRemotePath, const QString& qsAttributes);

Remarks

Use this method to set the attributes of a remote file.

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

UploadBytes Method (SFTPClient Class)

Uploads a byte array to the server.

Syntax

ANSI (Cross Platform)
int UploadBytes(const char* lpBytes, int lenBytes, const char* lpszRemoteFile);

Unicode (Windows)
INT UploadBytes(LPCSTR lpBytes, INT lenBytes, LPCWSTR lpszRemoteFile);
int secureblackbox_sftpclient_uploadbytes(void* lpObj, const char* lpBytes, int lenBytes, const char* lpszRemoteFile);
int UploadBytes(QByteArray qbaBytes, const QString& qsRemoteFile);

Remarks

Use this method to upload Bytes or its part to RemoteFile on the server.

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

UploadFile Method (SFTPClient Class)

Uploads a file to the server.

Syntax

ANSI (Cross Platform)
int UploadFile(const char* lpszLocalFile, const char* lpszRemoteFile);

Unicode (Windows)
INT UploadFile(LPCWSTR lpszLocalFile, LPCWSTR lpszRemoteFile);
int secureblackbox_sftpclient_uploadfile(void* lpObj, const char* lpszLocalFile, const char* lpszRemoteFile);
int UploadFile(const QString& qsLocalFile, const QString& qsRemoteFile);

Remarks

Use this method to upload LocalFile to the RemoteFile location on the server.

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

UploadFiles Method (SFTPClient Class)

Uploads multiple files to the server.

Syntax

ANSI (Cross Platform)
int UploadFiles(const char* lpszLocalPath, const char* lpszRemoteDir, int bRecursive, int iErrorHandling);

Unicode (Windows)
INT UploadFiles(LPCWSTR lpszLocalPath, LPCWSTR lpszRemoteDir, BOOL bRecursive, INT iErrorHandling);
int secureblackbox_sftpclient_uploadfiles(void* lpObj, const char* lpszLocalPath, const char* lpszRemoteDir, int bRecursive, int iErrorHandling);
int UploadFiles(const QString& qsLocalPath, const QString& qsRemoteDir, bool bRecursive, int iErrorHandling);

Remarks

Use this property to upload a batch of files to the server.

LocalPath specifies a wildcard or regular expression by which the local files are picked for uploading. RemoteDir specifies the location on the server where these files should be saved. The Recursive parameter tells the component whether it should navigate source directories recursively when uploading files. If set to false, only the files residing in the actual LocalPath, but not its subdirectories, will be uploaded.

The ErrorHandling parameter specifies one of the pre-defined error handling tactics:

ehStopOnFailure0Stop on the first failure and throw an exception

ehIgnoreErrors1Ignore individual processing errors, just proceed to the next item on the list

ehTryAllItems2Try to process all the items by ignoring any mid-way errors, but throw an exception at the end of the processing if any of the items failed to process

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

UploadStream Method (SFTPClient Class)

Uploads a file to the server.

Syntax

ANSI (Cross Platform)
int UploadStream(SecureBlackboxStream* sLocalStream, const char* lpszRemoteFile);

Unicode (Windows)
INT UploadStream(SecureBlackboxStream* sLocalStream, LPCWSTR lpszRemoteFile);
int secureblackbox_sftpclient_uploadstream(void* lpObj, SecureBlackboxStream* sLocalStream, const char* lpszRemoteFile);
int UploadStream(SecureBlackboxStream* sLocalStream, const QString& qsRemoteFile);

Remarks

Use this method to upload the contents of LocalStream to the RemoteFile location on the server.

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

AuthAttempt Event (SFTPClient Class)

Fires when an authentication attempt is performed.

Syntax

ANSI (Cross Platform)
virtual int FireAuthAttempt(SFTPClientAuthAttemptEventParams *e);
typedef struct {
int AuthType; int reserved; } SFTPClientAuthAttemptEventParams;
Unicode (Windows) virtual INT FireAuthAttempt(SFTPClientAuthAttemptEventParams *e);
typedef struct {
INT AuthType; INT reserved; } SFTPClientAuthAttemptEventParams;
#define EID_SFTPCLIENT_AUTHATTEMPT 1

virtual INT SECUREBLACKBOX_CALL FireAuthAttempt(INT &iAuthType);
class SFTPClientAuthAttemptEventParams {
public:
  int AuthType();

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

Remarks

This event signals the start of an authentication attempt. The AuthType parameter specifies the authentication type. This event may be fired more than once if the client tries different authentication methods one after another.

Supported authentication types:

atRhosts0x01RHOSTS file authentication. Rarely used today.

atPublicKey0x02Public key (sometimes called private key) authentication

atPassword0x04Password-based authentication

atHostbased0x08Hostbased authentication

atKeyboard0x10Keyboard-interactive authentication. This is often used in place of generic password authentication.

atGssWithMic0x20GSS authentication

atGssKeyex0x40GSS authentication with key exchange

atPublicKeyAgent0x80Public key agent authentication

AuthFailed Event (SFTPClient Class)

Fires if an authentication attempt fails.

Syntax

ANSI (Cross Platform)
virtual int FireAuthFailed(SFTPClientAuthFailedEventParams *e);
typedef struct {
int AuthType; int reserved; } SFTPClientAuthFailedEventParams;
Unicode (Windows) virtual INT FireAuthFailed(SFTPClientAuthFailedEventParams *e);
typedef struct {
INT AuthType; INT reserved; } SFTPClientAuthFailedEventParams;
#define EID_SFTPCLIENT_AUTHFAILED 2

virtual INT SECUREBLACKBOX_CALL FireAuthFailed(INT &iAuthType);
class SFTPClientAuthFailedEventParams {
public:
  int AuthType();

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

Remarks

This event fires if an authentication attempt fails (for example, if a bad password had been provided). AuthType parameter indicates the authentication type.

AuthFailed may be fired more than once, depending on the configured authentication parameters and the value assigned to the AuthAttempts property.

This event does not necessarily lead to connection abortion, as the client may still have a chance of authenticating with a different method.

Supported authentication types:

atRhosts0x01RHOSTS file authentication. Rarely used today.

atPublicKey0x02Public key (sometimes called private key) authentication

atPassword0x04Password-based authentication

atHostbased0x08Hostbased authentication

atKeyboard0x10Keyboard-interactive authentication. This is often used in place of generic password authentication.

atGssWithMic0x20GSS authentication

atGssKeyex0x40GSS authentication with key exchange

atPublicKeyAgent0x80Public key agent authentication

AuthSucceeded Event (SFTPClient Class)

Reports a successful authentication.

Syntax

ANSI (Cross Platform)
virtual int FireAuthSucceeded(SFTPClientAuthSucceededEventParams *e);
typedef struct { int reserved; } SFTPClientAuthSucceededEventParams;
Unicode (Windows) virtual INT FireAuthSucceeded(SFTPClientAuthSucceededEventParams *e);
typedef struct { INT reserved; } SFTPClientAuthSucceededEventParams;
#define EID_SFTPCLIENT_AUTHSUCCEEDED 3

virtual INT SECUREBLACKBOX_CALL FireAuthSucceeded();
class SFTPClientAuthSucceededEventParams {
public:
  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void AuthSucceeded(SFTPClientAuthSucceededEventParams *e);
// Or, subclass SFTPClient and override this emitter function. virtual int FireAuthSucceeded(SFTPClientAuthSucceededEventParams *e) {...}

Remarks

This event marks the completion of the authentication procedure, and signifies transition to the SSH connection subprotocol.

Banner Event (SFTPClient Class)

Reports the receipt of the Welcome message from the server.

Syntax

ANSI (Cross Platform)
virtual int FireBanner(SFTPClientBannerEventParams *e);
typedef struct {
const char *Text; int lenText;
const char *Language; int lenLanguage; int reserved; } SFTPClientBannerEventParams;
Unicode (Windows) virtual INT FireBanner(SFTPClientBannerEventParams *e);
typedef struct {
LPCSTR Text; INT lenText;
LPCSTR Language; INT lenLanguage; INT reserved; } SFTPClientBannerEventParams;
#define EID_SFTPCLIENT_BANNER 4

virtual INT SECUREBLACKBOX_CALL FireBanner(LPSTR &lpText, INT &lenText, LPSTR &lpLanguage, INT &lenLanguage);
class SFTPClientBannerEventParams {
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(SFTPClientBannerEventParams *e);
// Or, subclass SFTPClient and override this emitter function. virtual int FireBanner(SFTPClientBannerEventParams *e) {...}

Remarks

The class fires this event when it receives a welcome message from the server. Use the Text parameter to access the encoded message.

Disconnect Event (SFTPClient Class)

Reports SFTP connection closure.

Syntax

ANSI (Cross Platform)
virtual int FireDisconnect(SFTPClientDisconnectEventParams *e);
typedef struct {
int CloseReason; int reserved; } SFTPClientDisconnectEventParams;
Unicode (Windows) virtual INT FireDisconnect(SFTPClientDisconnectEventParams *e);
typedef struct {
INT CloseReason; INT reserved; } SFTPClientDisconnectEventParams;
#define EID_SFTPCLIENT_DISCONNECT 5

virtual INT SECUREBLACKBOX_CALL FireDisconnect(INT &iCloseReason);
class SFTPClientDisconnectEventParams {
public:
  int CloseReason();

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

Remarks

The class fires this event to report connection closure. No more SFTP activity could be done after the disconnect.

Error Event (SFTPClient Class)

Information about errors during SFTP connection.

Syntax

ANSI (Cross Platform)
virtual int FireError(SFTPClientErrorEventParams *e);
typedef struct {
int ErrorCode;
const char *Description; int reserved; } SFTPClientErrorEventParams;
Unicode (Windows) virtual INT FireError(SFTPClientErrorEventParams *e);
typedef struct {
INT ErrorCode;
LPCWSTR Description; INT reserved; } SFTPClientErrorEventParams;
#define EID_SFTPCLIENT_ERROR 6

virtual INT SECUREBLACKBOX_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);
class SFTPClientErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void Error(SFTPClientErrorEventParams *e);
// Or, subclass SFTPClient and override this emitter function. virtual int FireError(SFTPClientErrorEventParams *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 (SFTPClient Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireExternalSign(SFTPClientExternalSignEventParams *e);
typedef struct {
const char *OperationId;
const char *HashAlgorithm;
const char *Pars;
const char *Data;
char *SignedData; int reserved; } SFTPClientExternalSignEventParams;
Unicode (Windows) virtual INT FireExternalSign(SFTPClientExternalSignEventParams *e);
typedef struct {
LPCWSTR OperationId;
LPCWSTR HashAlgorithm;
LPCWSTR Pars;
LPCWSTR Data;
LPWSTR SignedData; INT reserved; } SFTPClientExternalSignEventParams;
#define EID_SFTPCLIENT_EXTERNALSIGN 7

virtual INT SECUREBLACKBOX_CALL FireExternalSign(LPSTR &lpszOperationId, LPSTR &lpszHashAlgorithm, LPSTR &lpszPars, LPSTR &lpszData, LPSTR &lpszSignedData);
class SFTPClientExternalSignEventParams {
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(SFTPClientExternalSignEventParams *e);
// Or, subclass SFTPClient and override this emitter function. virtual int FireExternalSign(SFTPClientExternalSignEventParams *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(); };

FileNameChangeNeeded Event (SFTPClient Class)

ToDo.

Syntax

ANSI (Cross Platform)
virtual int FireFileNameChangeNeeded(SFTPClientFileNameChangeNeededEventParams *e);
typedef struct {
char *FileName;
int Force; int reserved; } SFTPClientFileNameChangeNeededEventParams;
Unicode (Windows) virtual INT FireFileNameChangeNeeded(SFTPClientFileNameChangeNeededEventParams *e);
typedef struct {
LPWSTR FileName;
BOOL Force; INT reserved; } SFTPClientFileNameChangeNeededEventParams;
#define EID_SFTPCLIENT_FILENAMECHANGENEEDED 8

virtual INT SECUREBLACKBOX_CALL FireFileNameChangeNeeded(LPSTR &lpszFileName, BOOL &bForce);
class SFTPClientFileNameChangeNeededEventParams {
public:
  const QString &FileName();
  void SetFileName(const QString &qsFileName);

  bool Force();
  void SetForce(bool bForce);

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

Remarks

ToDo

FileOperation Event (SFTPClient Class)

Signifies the start of a file transfer operation.

Syntax

ANSI (Cross Platform)
virtual int FireFileOperation(SFTPClientFileOperationEventParams *e);
typedef struct {
int Operation;
const char *RemotePath;
const char *LocalPath;
int Skip;
int Cancel; int reserved; } SFTPClientFileOperationEventParams;
Unicode (Windows) virtual INT FireFileOperation(SFTPClientFileOperationEventParams *e);
typedef struct {
INT Operation;
LPCWSTR RemotePath;
LPCWSTR LocalPath;
BOOL Skip;
BOOL Cancel; INT reserved; } SFTPClientFileOperationEventParams;
#define EID_SFTPCLIENT_FILEOPERATION 9

virtual INT SECUREBLACKBOX_CALL FireFileOperation(INT &iOperation, LPSTR &lpszRemotePath, LPSTR &lpszLocalPath, BOOL &bSkip, BOOL &bCancel);
class SFTPClientFileOperationEventParams {
public:
  int Operation();

  const QString &RemotePath();

  const QString &LocalPath();

  bool Skip();
  void SetSkip(bool bSkip);

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

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

Remarks

This event is fired each time the class starts an upload or download operation within a multi-file call. Operation defines the operation about to start, RemotePath specifies the name and path to the remote file, and LocalPath specifies the name and path to the local file.

If needed, set Skip to true to ignore the current file, or Cancel to abort the whole batch.

Supported operations:

cffoDownloadFile0Download file

cffoUploadFile1Upload file

cffoDeleteFile2Delete file

cffoMakeDir3Make directory

FileOperationResult Event (SFTPClient Class)

Signifies the completion of a file transfer operation.

Syntax

ANSI (Cross Platform)
virtual int FireFileOperationResult(SFTPClientFileOperationResultEventParams *e);
typedef struct {
int Operation;
const char *RemotePath;
const char *LocalPath;
int ErrorCode;
const char *Comment;
int Cancel; int reserved; } SFTPClientFileOperationResultEventParams;
Unicode (Windows) virtual INT FireFileOperationResult(SFTPClientFileOperationResultEventParams *e);
typedef struct {
INT Operation;
LPCWSTR RemotePath;
LPCWSTR LocalPath;
INT ErrorCode;
LPCWSTR Comment;
BOOL Cancel; INT reserved; } SFTPClientFileOperationResultEventParams;
#define EID_SFTPCLIENT_FILEOPERATIONRESULT 10

virtual INT SECUREBLACKBOX_CALL FireFileOperationResult(INT &iOperation, LPSTR &lpszRemotePath, LPSTR &lpszLocalPath, INT &iErrorCode, LPSTR &lpszComment, BOOL &bCancel);
class SFTPClientFileOperationResultEventParams {
public:
  int Operation();

  const QString &RemotePath();

  const QString &LocalPath();

  int ErrorCode();

  const QString &Comment();

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

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

Remarks

This event is fired each time the class completes a file transfer within a multi-file call. Operation defines the operation performed on the file, RemotePath specifies the name and path to the remote file, and LocalPath specifies the name and path to the local file.

ErrorCode and Comment return the code and textual description of the error, if it was encountered.

Set Cancel to True to cancel the multi-file operation.

Supported operations:

cffoDownloadFile0Download file

cffoUploadFile1Upload file

cffoDeleteFile2Delete file

cffoMakeDir3Make directory

KnownKeyReceived Event (SFTPClient Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireKnownKeyReceived(SFTPClientKnownKeyReceivedEventParams *e);
typedef struct {
const char *Algorithm;
int Bits;
const char *FingerprintSHA256; int reserved; } SFTPClientKnownKeyReceivedEventParams;
Unicode (Windows) virtual INT FireKnownKeyReceived(SFTPClientKnownKeyReceivedEventParams *e);
typedef struct {
LPCWSTR Algorithm;
INT Bits;
LPCWSTR FingerprintSHA256; INT reserved; } SFTPClientKnownKeyReceivedEventParams;
#define EID_SFTPCLIENT_KNOWNKEYRECEIVED 11

virtual INT SECUREBLACKBOX_CALL FireKnownKeyReceived(LPSTR &lpszAlgorithm, INT &iBits, LPSTR &lpszFingerprintSHA256);
class SFTPClientKnownKeyReceivedEventParams {
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(SFTPClientKnownKeyReceivedEventParams *e);
// Or, subclass SFTPClient and override this emitter function. virtual int FireKnownKeyReceived(SFTPClientKnownKeyReceivedEventParams *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.

ListEntry Event (SFTPClient Class)

Reports a directory listing entry to the application.

Syntax

ANSI (Cross Platform)
virtual int FireListEntry(SFTPClientListEntryEventParams *e);
typedef struct {
const char *FileName; int reserved; } SFTPClientListEntryEventParams;
Unicode (Windows) virtual INT FireListEntry(SFTPClientListEntryEventParams *e);
typedef struct {
LPCWSTR FileName; INT reserved; } SFTPClientListEntryEventParams;
#define EID_SFTPCLIENT_LISTENTRY 12

virtual INT SECUREBLACKBOX_CALL FireListEntry(LPSTR &lpszFileName);
class SFTPClientListEntryEventParams {
public:
  const QString &FileName();

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

Remarks

The class fires this event to report a directory listing entry to the application. FileName contains the entry name.

Use CurrentListEntry to access the details of the entry.

Notification Event (SFTPClient Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireNotification(SFTPClientNotificationEventParams *e);
typedef struct {
const char *EventID;
const char *EventParam; int reserved; } SFTPClientNotificationEventParams;
Unicode (Windows) virtual INT FireNotification(SFTPClientNotificationEventParams *e);
typedef struct {
LPCWSTR EventID;
LPCWSTR EventParam; INT reserved; } SFTPClientNotificationEventParams;
#define EID_SFTPCLIENT_NOTIFICATION 13

virtual INT SECUREBLACKBOX_CALL FireNotification(LPSTR &lpszEventID, LPSTR &lpszEventParam);
class SFTPClientNotificationEventParams {
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(SFTPClientNotificationEventParams *e);
// Or, subclass SFTPClient and override this emitter function. virtual int FireNotification(SFTPClientNotificationEventParams *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 (SFTPClient Class)

Signals that the server requests a password change.

Syntax

ANSI (Cross Platform)
virtual int FirePasswordChangeRequest(SFTPClientPasswordChangeRequestEventParams *e);
typedef struct {
const char *Prompt;
char *NewPassword;
int Cancel; int reserved; } SFTPClientPasswordChangeRequestEventParams;
Unicode (Windows) virtual INT FirePasswordChangeRequest(SFTPClientPasswordChangeRequestEventParams *e);
typedef struct {
LPCWSTR Prompt;
LPWSTR NewPassword;
BOOL Cancel; INT reserved; } SFTPClientPasswordChangeRequestEventParams;
#define EID_SFTPCLIENT_PASSWORDCHANGEREQUEST 14

virtual INT SECUREBLACKBOX_CALL FirePasswordChangeRequest(LPSTR &lpszPrompt, LPSTR &lpszNewPassword, BOOL &bCancel);
class SFTPClientPasswordChangeRequestEventParams {
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(SFTPClientPasswordChangeRequestEventParams *e);
// Or, subclass SFTPClient and override this emitter function. virtual int FirePasswordChangeRequest(SFTPClientPasswordChangeRequestEventParams *e) {...}

Remarks

The class fires this event to pass the password change request from the server to the application. This event is fired during the SSH handshake.

PrivateKeyNeeded Event (SFTPClient Class)

Asks the application for the client's private key.

Syntax

ANSI (Cross Platform)
virtual int FirePrivateKeyNeeded(SFTPClientPrivateKeyNeededEventParams *e);
typedef struct {
int Skip; int reserved; } SFTPClientPrivateKeyNeededEventParams;
Unicode (Windows) virtual INT FirePrivateKeyNeeded(SFTPClientPrivateKeyNeededEventParams *e);
typedef struct {
BOOL Skip; INT reserved; } SFTPClientPrivateKeyNeededEventParams;
#define EID_SFTPCLIENT_PRIVATEKEYNEEDED 15

virtual INT SECUREBLACKBOX_CALL FirePrivateKeyNeeded(BOOL &bSkip);
class SFTPClientPrivateKeyNeededEventParams {
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(SFTPClientPrivateKeyNeededEventParams *e);
// Or, subclass SFTPClient and override this emitter function. virtual int FirePrivateKeyNeeded(SFTPClientPrivateKeyNeededEventParams *e) {...}

Remarks

The class fires this event if the public key provided in Key was accepted by the server, but no private key is available for it.

Use this event handler to attach the private key to your Key. The component will pick the key up and continue the authentication.

Progress Event (SFTPClient Class)

Fires periodically during the data transfer.

Syntax

ANSI (Cross Platform)
virtual int FireProgress(SFTPClientProgressEventParams *e);
typedef struct {
int64 Total;
int64 Current;
int Cancel; int reserved; } SFTPClientProgressEventParams;
Unicode (Windows) virtual INT FireProgress(SFTPClientProgressEventParams *e);
typedef struct {
LONG64 Total;
LONG64 Current;
BOOL Cancel; INT reserved; } SFTPClientProgressEventParams;
#define EID_SFTPCLIENT_PROGRESS 16

virtual INT SECUREBLACKBOX_CALL FireProgress(LONG64 &lTotal, LONG64 &lCurrent, BOOL &bCancel);
class SFTPClientProgressEventParams {
public:
  qint64 Total();

  qint64 Current();

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

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

Remarks

Use this event to check the progress of an upload or download operation. Total indicates the total number of bytes to be transferred; Current specifies how much data has been transferred so far, and Cancel gives you a chance to cancel the operation.

UnknownKeyReceived Event (SFTPClient Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireUnknownKeyReceived(SFTPClientUnknownKeyReceivedEventParams *e);
typedef struct {
const char *Algorithm;
int Bits;
const char *FingerprintSHA256;
int Action; int reserved; } SFTPClientUnknownKeyReceivedEventParams;
Unicode (Windows) virtual INT FireUnknownKeyReceived(SFTPClientUnknownKeyReceivedEventParams *e);
typedef struct {
LPCWSTR Algorithm;
INT Bits;
LPCWSTR FingerprintSHA256;
INT Action; INT reserved; } SFTPClientUnknownKeyReceivedEventParams;
#define EID_SFTPCLIENT_UNKNOWNKEYRECEIVED 17

virtual INT SECUREBLACKBOX_CALL FireUnknownKeyReceived(LPSTR &lpszAlgorithm, INT &iBits, LPSTR &lpszFingerprintSHA256, INT &iAction);
class SFTPClientUnknownKeyReceivedEventParams {
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(SFTPClientUnknownKeyReceivedEventParams *e);
// Or, subclass SFTPClient and override this emitter function. virtual int FireUnknownKeyReceived(SFTPClientUnknownKeyReceivedEventParams *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:

catAcceptOnce1Accept the key for the current session only.
catAcceptPermanently2Accept the key for the current session and store the key to the trusted keys list.
catReject3Reject 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.

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_SHA1SHA1
SB_HASH_ALGORITHM_SHA224SHA224
SB_HASH_ALGORITHM_SHA256SHA256
SB_HASH_ALGORITHM_SHA384SHA384
SB_HASH_ALGORITHM_SHA512SHA512
SB_HASH_ALGORITHM_MD2MD2
SB_HASH_ALGORITHM_MD4MD4
SB_HASH_ALGORITHM_MD5MD5
SB_HASH_ALGORITHM_RIPEMD160RIPEMD160
SB_HASH_ALGORITHM_CRC32CRC32
SB_HASH_ALGORITHM_SSL3SSL3
SB_HASH_ALGORITHM_GOST_R3411_1994GOST1994
SB_HASH_ALGORITHM_WHIRLPOOLWHIRLPOOL
SB_HASH_ALGORITHM_POLY1305POLY1305
SB_HASH_ALGORITHM_SHA3_224SHA3_224
SB_HASH_ALGORITHM_SHA3_256SHA3_256
SB_HASH_ALGORITHM_SHA3_384SHA3_384
SB_HASH_ALGORITHM_SHA3_512SHA3_512
SB_HASH_ALGORITHM_BLAKE2S_128BLAKE2S_128
SB_HASH_ALGORITHM_BLAKE2S_160BLAKE2S_160
SB_HASH_ALGORITHM_BLAKE2S_224BLAKE2S_224
SB_HASH_ALGORITHM_BLAKE2S_256BLAKE2S_256
SB_HASH_ALGORITHM_BLAKE2B_160BLAKE2B_160
SB_HASH_ALGORITHM_BLAKE2B_256BLAKE2B_256
SB_HASH_ALGORITHM_BLAKE2B_384BLAKE2B_384
SB_HASH_ALGORITHM_BLAKE2B_512BLAKE2B_512
SB_HASH_ALGORITHM_SHAKE_128SHAKE_128
SB_HASH_ALGORITHM_SHAKE_256SHAKE_256
SB_HASH_ALGORITHM_SHAKE_128_LENSHAKE_128_LEN
SB_HASH_ALGORITHM_SHAKE_256_LENSHAKE_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 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 topic.

Method
int

Default Value: 0

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

Available options:

asmdPKCS10
asmdPKCS71

Mode
int

Default Value: 0

Specifies the external cryptography mode.

Available options:

ecmDefaultThe default value (0)
ecmDisabledDo not use DC or external signing (1)
ecmGenericGeneric external signing with the OnExternalSign event (2)
ecmDCAuthDCAuth signing (3)
ecmDCAuthJSONDCAuth 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_ENCRYPTIONrsaEncryption
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTIONmd2withRSAEncryption
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTIONmd5withRSAEncryption
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTIONsha1withRSAEncryption
SB_CERT_ALGORITHM_ID_DSAid-dsa
SB_CERT_ALGORITHM_ID_DSA_SHA1id-dsa-with-sha1
SB_CERT_ALGORITHM_DH_PUBLICdhpublicnumber
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTIONsha224WithRSAEncryption
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTIONsha256WithRSAEncryption
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTIONsha384WithRSAEncryption
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTIONsha512WithRSAEncryption
SB_CERT_ALGORITHM_ID_RSAPSSid-RSASSA-PSS
SB_CERT_ALGORITHM_ID_RSAOAEPid-RSAES-OAEP
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160ripemd160withRSA
SB_CERT_ALGORITHM_ID_ELGAMALelGamal
SB_CERT_ALGORITHM_SHA1_ECDSAecdsa-with-SHA1
SB_CERT_ALGORITHM_RECOMMENDED_ECDSAecdsa-recommended
SB_CERT_ALGORITHM_SHA224_ECDSAecdsa-with-SHA224
SB_CERT_ALGORITHM_SHA256_ECDSAecdsa-with-SHA256
SB_CERT_ALGORITHM_SHA384_ECDSAecdsa-with-SHA384
SB_CERT_ALGORITHM_SHA512_ECDSAecdsa-with-SHA512
SB_CERT_ALGORITHM_ECid-ecPublicKey
SB_CERT_ALGORITHM_SPECIFIED_ECDSAecdsa-specified
SB_CERT_ALGORITHM_GOST_R3410_1994id-GostR3410-94
SB_CERT_ALGORITHM_GOST_R3410_2001id-GostR3410-2001
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994id-GostR3411-94-with-GostR3410-94
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001id-GostR3411-94-with-GostR3410-2001
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAINecdsa-plain-SHA1
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAINecdsa-plain-SHA224
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAINecdsa-plain-SHA256
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAINecdsa-plain-SHA384
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAINecdsa-plain-SHA512
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAINecdsa-plain-RIPEMD160
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTIONwhirlpoolWithRSAEncryption
SB_CERT_ALGORITHM_ID_DSA_SHA224id-dsa-with-sha224
SB_CERT_ALGORITHM_ID_DSA_SHA256id-dsa-with-sha256
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-512
SB_CERT_ALGORITHM_SHA3_224_ECDSAid-ecdsa-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_ECDSAid-ecdsa-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_ECDSAid-ecdsa-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_ECDSAid-ecdsa-with-sha3-512
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAINid-ecdsa-plain-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAINid-ecdsa-plain-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAINid-ecdsa-plain-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAINid-ecdsa-plain-with-sha3-512
SB_CERT_ALGORITHM_ID_DSA_SHA3_224id-dsa-with-sha3-224
SB_CERT_ALGORITHM_ID_DSA_SHA3_256id-dsa-with-sha3-256
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b512
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSAid-ecdsa-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSAid-ecdsa-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSAid-ecdsa-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSAid-ecdsa-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSAid-ecdsa-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSAid-ecdsa-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSAid-ecdsa-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSAid-ecdsa-with-blake2b512
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAINid-ecdsa-plain-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAINid-ecdsa-plain-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAINid-ecdsa-plain-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAINid-ecdsa-plain-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAINid-ecdsa-plain-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAINid-ecdsa-plain-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAINid-ecdsa-plain-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAINid-ecdsa-plain-with-blake2b512
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224id-dsa-with-blake2s224
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256id-dsa-with-blake2s256
SB_CERT_ALGORITHM_EDDSA_ED25519id-Ed25519
SB_CERT_ALGORITHM_EDDSA_ED448id-Ed448
SB_CERT_ALGORITHM_EDDSA_ED25519_PHid-Ed25519ph
SB_CERT_ALGORITHM_EDDSA_ED448_PHid-Ed448ph
SB_CERT_ALGORITHM_EDDSAid-EdDSA
SB_CERT_ALGORITHM_EDDSA_SIGNATUREid-EdDSA-sig

Constructors

ExternalCrypto()

Creates a new ExternalCrypto object with default field values.

FTPListEntry Type

Represents a basic container for the remote file details.

Syntax

SecureBlackboxFTPListEntry (declared in secureblackbox.h)

Remarks

The class represents the details of a file entry returned by the FTP server.

Fields

AccessTime
char*

Default Value: ""

Contains the last access time for this file, in UTC.

CreationTime
char*

Default Value: ""

Contains this file's creation time, in UTC.

EntryFormat
int

Default Value: 0

The file listing format:

cfefUnknown0
cfefUnix1
cfefWindows2
cfefMLSD3

FileType
int

Default Value: 0

The type of the entry:

fetUnknown0
fetDirectory1
fetFile2
fetSymlink3
fetSpecial4
fetCurrentDirectory5
fetParentDirectory6
fetSocket7
fetCharDevice8
fetBlockDevice9
fetFIFO10

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

ModificationTime
char*

Default Value: ""

File last modification date/time.

Name
char*

Default Value: ""

The file or directory name.

Path
char*

Default Value: ""

The full path to the file or directory.

Principal
char*

Default Value: ""

Specifies the owner of the file/directory.

Note: in earlier versions this property was called Owner. It was renamed to Principal to avoid clashes with certain SDK namings.

Size
int64

Default Value: 0

File size in bytes.

UnixPerms
int

Default Value: 511

The file Unix permissions bit mask (e.g. rwxrwxrwx=511 (0777); rwxr--r--=484 (0744)).

UnparsedName
char*

Default Value: ""

The unparsed entry as returned by the server. Sometimes this is also known as "long name".

Constructors

FTPListEntry()

Creates a new FTPListEntry object.

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.

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.

patNoAuthentication0
patBasic1
patDigest2
patNTLM3

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.

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

cptNone0
cptSocks41
cptSocks52
cptWebTunnel3
cptHTTP4

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.

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.

dmAuto0
dmPlatform1
dmOwn2
dmOwnSecure3

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.

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.

Fields

Algorithm
char* (read-only)

Default Value: ""

Specifies the key algorithm.

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.

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.

ckfOpenSSH0
ckfOpenSSH21
ckfIETF2
ckfPuTTY3
ckfX5094
ckfBinary5
ckfSSH16
ckfPGP7
ckfPKCS88
ckfPuTTY39

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.

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.

SecureBlackboxStream Type

Syntax

SecureBlackboxStream (declared in secureblackbox.h)

Remarks

The SFTPClient class includes one or more API members that take a stream object as a parameter. To use such API members, create a concrete class that implements the SecureBlackboxStream interface and pass the SFTPClient class an instance of that concrete class.

When implementing the SecureBlackboxStream interface's properties and methods, they must behave as described below. If the concrete class's implementation does not behave as expected, undefined behavior may occur.

Properties

CanRead Whether the stream supports reading.

bool CanRead() { return true; }
CanSeek Whether the stream supports seeking.

bool CanSeek() { return true; }
CanWrite Whether the stream supports writing.

bool CanWrite() { return true; }
Length Gets the length of the stream, in bytes.

int64 GetLength() = 0;

Methods

Close Closes the stream, releasing all resources currently allocated for it.

void Close() {}

This method is called automatically when a SecureBlackboxStream object is deleted.

Flush Forces all data held by the stream's buffers to be written out to storage.

int Flush() { return 0; }

Must return 0 if flushing is successful; or -1 if an error occurs or the stream is closed. If the stream does not support writing, this method must do nothing and return 0.

Read Reads a sequence of bytes from the stream and advances the current position within the stream by the number of bytes read.

int Read(void* buffer, int count) = 0;

Buffer specifies the buffer to populate with data from the stream. Count specifies the number of bytes that should be read from the stream.

Must return the total number of bytes read into Buffer; this may be less than Count if that many bytes are not currently available, or 0 if the end of the stream has been reached. Must return -1 if an error occurs, if reading is not supported, or if the stream is closed.

Seek Sets the current position within the stream based on a particular point of origin.

int64 Seek(int64 offset, int seekOrigin) = 0;

Offset specifies the offset in the stream to seek to, relative to SeekOrigin. Valid values for SeekOrigin are:

  • 0: Seek from beginning.
  • 1: Seek from current position.
  • 2: Seek from end.

Must return the new position within the stream; or -1 if an error occurs, if seeking is not supported, or if the stream is closed (however, see note below). If -1 is returned, the current position within the stream must remain unchanged.

Note: If the stream is not closed, it must always be possible to call this method with an Offset of 0 and a SeekOrigin of 1 to obtain the current position within the stream, even if seeking is not otherwise supported.

Write Writes a sequence of bytes to the stream and advances the current position within the stream by the number of bytes written.

int Write(const void* buffer, int count) = 0;

Buffer specifies the buffer with data to write to the stream. Count specifies the number of bytes that should be written to the stream.

Must return the total number of bytes written to the stream; this may be less than Count if that many bytes could not be written. Must return -1 if an error occurs, if writing is not supported, or if the stream is closed.

Config Settings (SFTPClient 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.

SFTPClient Config Settings

AdjustFileTimes:   Whether file times should be adjusted after upload/download.

If this property value is True, file times (creation, access and last modification times) will be adjusted after upload/download operation.

ASCIIMode:   Whether ASCII transfer mode is used.

When this property is True, ASCII (text) transfer mode is used, otherwise the transfer is performed in binary mode.

AvailableSpace:   Returns details of server disk space availability. This protocol extension must be supported by the server for this request to work.

This config property returns the details of the server disk space. The information is provided in the form of semicolon-separated entries: BytesOnDevice, UnusedBytesOnDevice, BytesAvailableToUser, UnusedBytesAvailableToUser, BytesPerAllocationUnit. You can use this property without parameters, or provide a specific mounting point in brackets: AvailableSpace(./path).

CaseConversion:   Whether case conversion must be applied to file names as they are downloaded.

You can choose to: convert file names to upper case, convert file names to lower case, or to keep them as they are.

CaseSensitive:   Specifies if file paths are case-sensitive.

Set this property to True if all file names, paths and file masks should be case-sensitive.

CopyMode:   Defines what to do with each successfully copied file.

You could choose to: simply copy the file, delete each file's origin right after that file has been copied, or delete all original files only after all files have been copied.

DefOutboundBlockSize:   The default outbound block size.

Use this property to configure the outbound data block size.

DisablePacketFragmentation:   Enables or disables SSH packet fragmentation.

Use this property to enable or disable SSH packet fragmentation. This is one of the settings that is worth a look if encountering unexplained transfer issues.

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.

FileHash:   Returns the hash of the specified file. This protocol extension must be supported by the server for this request to work.

Use this property to request the hash of a remote file. Pass the file name in brackets: FileHash(./path/file.ext). You can adjust the hash algorithm using the HashAlgorithm configuration setting.

HashAlgorithm:   The hash algorithm to use for the protocol operations.

Specifies the hash algorithm to use for file protocol operations, such as FileHash.

HomeDir:   Returns a user's home directory. This protocol extension must be supported by the server for this request to work.

Use this property to request a specific user's home directory on the server. Provide the username in brackets: HomeDir(user2).

IncomingSpeedLimit:   Specifies incoming speed limit.

Use this property to limit the maximum number of bytes per second that client may receive. The value of 0 (zero) means "no limitation".

KeepAlivePeriod:   The inactivity period after which a keep-alive signal will be sent.

Use this property to specify tunnel inactivity period (in milliseconds) after which a keep-alive signal will be sent. The default value is 0 (no keep-alive signals).

LocalCharset:   Charset used on the client machine.

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

LocalNewLineConvention:   A character string for the end of line (EOL) indication on the local machine.

This property contains a character string for the end of line (EOL) indication on the local machine.

NewLineConvention:   A character string for the end of line (EOL) indication on the server.

This property contains a character string for the end of line (EOL) indication used by the server. Usually its value is one of: 0x0d, 0x0d0x0a, 0x0a0x0d, or 0x0a, but it can differ for some servers.

OutgoingSpeedLimit:   Specifies incoming speed limit.

Use this property to limit the maximum number of bytes per second that client may send. The value of 0 (zero) means "no limitation".

PreserveExistingFileTimes:   Whether original file times should be restored upon transfer.

If the destination file exists and PreserveExistingFileTimes option is enabled, the class will remember the file's times before transfer, and restore them after the file has been transferred. The default value is False.

Recursive:   Whether subdirectories should also be scanned for matching files.

Set this property to True to indicate that subdirectories should also be scanned for matching files

RedirectStdErr:   Whether to redirect output to StdErr.

If this property is True, all output will be redirected to StdErr.

RemoteCharset:   Charset used on the server.

This property specifies the charset used on the server.

SFTPBufferSize:   The size of internal buffer used for data transfer.

Use this property to control the size of the internal buffers used for data transfer.

SFTPServerExecutableLocations:   Location of the SFTP server executable.

Specifies the location of the SFTP server executable.

StatVFS:   Returns VFS details. This protocol extension must be supported by the server for this request to work.

This config property returns the VFS details of the server file system. The information is provided in the form of semicolon-separated entries. You can use this property without parameters, or provide a specific mounting point in brackets: StatVFS(./).

StdErrData:   The buffer for writing StdErr data.

This property represents a buffer where StdErr data is written by the class.

TempFolder:   Returns the temporary directory offered by the server. This protocol extension must be supported by the server for this request to work.

Use this property to request a path to the temporary directory maintained by the server.

TempPath:   Location where the temporary files are stored.

This setting specifies an absolute path to the location on disk where temporary files are stored.

TreatZeroSizeAsUndefined:   Whether zero size returned by STAT should be considered as undefined.

This property specifies if the size of zero returned by the STAT command for a particular file should be considered as undefined. It makes sense to set this property to True, because some operating systems (e.g. Unix-based) return zero size for the files of certain type. For instance, most of the files contained in the /proc directory are reported as 0-sized, while actually not being empty.

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:

0Disabled. Strict key exchange is not supported in the class.
1 (default)Enabled, but not enforced. This setting enables strict key exchange, but if the remote host does not support strict key exchange the connection is still allowed to continue.
2Enabled, but 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.
3Required. If the remote host does not support strict key exchange the connection will fail.

UseTruncateFlagOnUpload:   whether to use the 'truncate' flag on file upload.

If this property is True, the existing files are opened truncated on upload, otherwise new files are created. The default value is True.

UseUTF8OnV3:   Whether to apply UTF-8 conversion for SFTP protocol versions 3 and lower.

If this property is True, UTF-8 encoding will be applied to file names for SFTP protocol versions 3 and lower.

Base Config Settings

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

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

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

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

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

Supported values are:

offNo caching (default)
localLocal caching
globalGlobal 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.

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

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

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

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

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

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

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

LogDestination:   Specifies the debug log destination.

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

Supported values are:

fileFile
consoleConsole
systemlogSystem Log (supported for Android only)
debuggerDebugger (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:

timeCurrent time
levelLevel
packagePackage name
moduleModule name
classClass name
methodMethod name
threadidThread Id
contenttypeContent type
contentContent
allAll 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-packageExclude a package specified in the value
exclude-moduleExclude a module specified in the value
exclude-classExclude a class specified in the value
exclude-methodExclude a method specified in the value
include-packageInclude a package specified in the value
include-moduleInclude a module specified in the value
include-classInclude a class specified in the value
include-methodInclude 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:

noneNo flush (caching only)
immediateImmediate flush (real-time logging)
maxcountFlush 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:

noneNone (by default)
fatalSevere errors that cause premature termination.
errorOther runtime errors or unexpected conditions.
warningUse of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong".
infoInteresting runtime events (startup/shutdown).
debugDetailed information on flow of through the system.
traceMore 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:

noneNo rotation
deleteolderDelete older entries from the cache upon reaching LogMaxEventCount
keepolderKeep 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.

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:

noneNo static DNS rules (default)
localLocal static DNS rules
globalGlobal 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).

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.

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

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

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

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

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

Trappable Errors (SFTPClient 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.

SFTPClient Errors

1048577   Invalid parameter (SB_ERROR_INVALID_PARAMETER)
1048578   Invalid configuration (SB_ERROR_INVALID_SETUP)
1048579   Invalid state (SB_ERROR_INVALID_STATE)
1048580   Invalid value (SB_ERROR_INVALID_VALUE)
1048581   Private key not found (SB_ERROR_NO_PRIVATE_KEY)
1048582   Cancelled by the user (SB_ERROR_CANCELLED_BY_USER)
1048583   The file was not found (SB_ERROR_NO_SUCH_FILE)
1048584   Unsupported feature or operation (SB_ERROR_UNSUPPORTED_FEATURE)
1048585   General error (SB_ERROR_GENERAL_ERROR)
31457281   Unsupported file operation (SB_ERROR_SFTP_UNSUPPORTED_FILE_OPERATION)
31457282   Invalid authentication type (SB_ERROR_SFTP_INVALID_AUTH_TYPE)