SFTPServer Class

Properties   Methods   Events   Config Settings   Errors  

The SFTPServer class provides server-side functionality for SFTP connections.

Syntax

SFTPServer

Remarks

SFTPServer is an implementation for SSH File Transfer Protocol server. It works over a secure SSH channel, and should not be confused with the FTP/FTPS protocol.

Property List

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

Method List

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

Event List

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

Config Settings

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

Active Property (SFTPServer Class)

Specifies whether the SFTP server has started and ready to accept connections.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetActive();

Unicode (Windows)
BOOL GetActive();

int secureblackbox_sftpserver_getactive(void* lpObj);

bool GetActive();

Default Value

FALSE

Remarks

Check this property to find out whether the SFTP server is in active mode. Use Start and Stop methods to activate or deactivate the server.

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

Data Type

Boolean

AuthTypes Property (SFTPServer Class)

Defines allowed authentication types.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAuthTypes();
int SetAuthTypes(int iAuthTypes);

Unicode (Windows)
INT GetAuthTypes();
INT SetAuthTypes(INT iAuthTypes);

int secureblackbox_sftpserver_getauthtypes(void* lpObj);
int secureblackbox_sftpserver_setauthtypes(void* lpObj, int iAuthTypes);

int GetAuthTypes();
int SetAuthTypes(int iAuthTypes);

Default Value

30

Remarks

Use this property to define which authentication types are allowed on the server, set of

Data Type

Integer

BaseDir Property (SFTPServer Class)

Specifies the server's base (root) directory.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetBaseDir();
int SetBaseDir(const char* lpszBaseDir);

Unicode (Windows)
LPWSTR GetBaseDir();
INT SetBaseDir(LPCWSTR lpszBaseDir);

char* secureblackbox_sftpserver_getbasedir(void* lpObj);
int secureblackbox_sftpserver_setbasedir(void* lpObj, const char* lpszBaseDir);

QString GetBaseDir();
int SetBaseDir(QString qsBaseDir);

Default Value

""

Remarks

Use this property to set the base (root) directory on the server.

Data Type

String

ClientFileEntryATime Property (SFTPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetClientFileEntryATime();
int SetClientFileEntryATime(const char* lpszClientFileEntryATime);

Unicode (Windows)
LPWSTR GetClientFileEntryATime();
INT SetClientFileEntryATime(LPCWSTR lpszClientFileEntryATime);

char* secureblackbox_sftpserver_getclientfileentryatime(void* lpObj);
int secureblackbox_sftpserver_setclientfileentryatime(void* lpObj, const char* lpszClientFileEntryATime);

QString GetClientFileEntryATime();
int SetClientFileEntryATime(QString qsClientFileEntryATime);

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

ClientFileEntryCTime Property (SFTPServer Class)

Contains this file's creation time, in UTC.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetClientFileEntryCTime();
int SetClientFileEntryCTime(const char* lpszClientFileEntryCTime);

Unicode (Windows)
LPWSTR GetClientFileEntryCTime();
INT SetClientFileEntryCTime(LPCWSTR lpszClientFileEntryCTime);

char* secureblackbox_sftpserver_getclientfileentryctime(void* lpObj);
int secureblackbox_sftpserver_setclientfileentryctime(void* lpObj, const char* lpszClientFileEntryCTime);

QString GetClientFileEntryCTime();
int SetClientFileEntryCTime(QString qsClientFileEntryCTime);

Default Value

""

Remarks

Contains this file's creation time, in UTC.

This property is not available at design time.

Data Type

String

ClientFileEntryDirectory Property (SFTPServer Class)

Specifies whether this entry is a directory.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetClientFileEntryDirectory();
int SetClientFileEntryDirectory(int bClientFileEntryDirectory);

Unicode (Windows)
BOOL GetClientFileEntryDirectory();
INT SetClientFileEntryDirectory(BOOL bClientFileEntryDirectory);

int secureblackbox_sftpserver_getclientfileentrydirectory(void* lpObj);
int secureblackbox_sftpserver_setclientfileentrydirectory(void* lpObj, int bClientFileEntryDirectory);

bool GetClientFileEntryDirectory();
int SetClientFileEntryDirectory(bool bClientFileEntryDirectory);

Default Value

FALSE

Remarks

Specifies whether this entry is a directory.

This property is not available at design time.

Data Type

Boolean

ClientFileEntryFileType Property (SFTPServer Class)

Specifies the type of this entry, one of the following: cftFile 0 cftDirectory 1 cftSymblink 2 cftSpecial 3 cftUnknown 4 cftSocket 5 cftCharDevice 6 cftBlockDevice 7 cftFIFO 8 .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetClientFileEntryFileType();
int SetClientFileEntryFileType(int iClientFileEntryFileType);

Unicode (Windows)
INT GetClientFileEntryFileType();
INT SetClientFileEntryFileType(INT iClientFileEntryFileType);

CFT_FILE(0), 
CFT_DIRECTORY(1), 
CFT_SYMBLINK(2), 
CFT_SPECIAL(3), 
CFT_UNKNOWN(4), 
CFT_SOCKET(5), 
CFT_CHAR_DEVICE(6), 
CFT_BLOCK_DEVICE(7), 
CFT_FIFO(8)

int secureblackbox_sftpserver_getclientfileentryfiletype(void* lpObj);
int secureblackbox_sftpserver_setclientfileentryfiletype(void* lpObj, int iClientFileEntryFileType);

int GetClientFileEntryFileType();
int SetClientFileEntryFileType(int iClientFileEntryFileType);

Default Value

4

Remarks

Specifies the type of this entry, one of the following:

This property is not available at design time.

Data Type

Integer

ClientFileEntryGroupExecute Property (SFTPServer Class)

Controls file execution permission for the group users.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetClientFileEntryGroupExecute();
int SetClientFileEntryGroupExecute(int bClientFileEntryGroupExecute);

Unicode (Windows)
BOOL GetClientFileEntryGroupExecute();
INT SetClientFileEntryGroupExecute(BOOL bClientFileEntryGroupExecute);

int secureblackbox_sftpserver_getclientfileentrygroupexecute(void* lpObj);
int secureblackbox_sftpserver_setclientfileentrygroupexecute(void* lpObj, int bClientFileEntryGroupExecute);

bool GetClientFileEntryGroupExecute();
int SetClientFileEntryGroupExecute(bool bClientFileEntryGroupExecute);

Default Value

FALSE

Remarks

Controls file execution permission for the group users.

This property is not available at design time.

Data Type

Boolean

ClientFileEntryGroupRead Property (SFTPServer Class)

Controls file read permission for the group users.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetClientFileEntryGroupRead();
int SetClientFileEntryGroupRead(int bClientFileEntryGroupRead);

Unicode (Windows)
BOOL GetClientFileEntryGroupRead();
INT SetClientFileEntryGroupRead(BOOL bClientFileEntryGroupRead);

int secureblackbox_sftpserver_getclientfileentrygroupread(void* lpObj);
int secureblackbox_sftpserver_setclientfileentrygroupread(void* lpObj, int bClientFileEntryGroupRead);

bool GetClientFileEntryGroupRead();
int SetClientFileEntryGroupRead(bool bClientFileEntryGroupRead);

Default Value

FALSE

Remarks

Controls file read permission for the group users.

This property is not available at design time.

Data Type

Boolean

ClientFileEntryGroupWrite Property (SFTPServer Class)

Controls file write permission for the group users.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetClientFileEntryGroupWrite();
int SetClientFileEntryGroupWrite(int bClientFileEntryGroupWrite);

Unicode (Windows)
BOOL GetClientFileEntryGroupWrite();
INT SetClientFileEntryGroupWrite(BOOL bClientFileEntryGroupWrite);

int secureblackbox_sftpserver_getclientfileentrygroupwrite(void* lpObj);
int secureblackbox_sftpserver_setclientfileentrygroupwrite(void* lpObj, int bClientFileEntryGroupWrite);

bool GetClientFileEntryGroupWrite();
int SetClientFileEntryGroupWrite(bool bClientFileEntryGroupWrite);

Default Value

FALSE

Remarks

Controls file write permission for the group users.

This property is not available at design time.

Data Type

Boolean

ClientFileEntryHandle Property (SFTPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetClientFileEntryHandle();
int SetClientFileEntryHandle(int64 lClientFileEntryHandle);

Unicode (Windows)
LONG64 GetClientFileEntryHandle();
INT SetClientFileEntryHandle(LONG64 lClientFileEntryHandle);

int64 secureblackbox_sftpserver_getclientfileentryhandle(void* lpObj);
int secureblackbox_sftpserver_setclientfileentryhandle(void* lpObj, int64 lClientFileEntryHandle);

qint64 GetClientFileEntryHandle();
int SetClientFileEntryHandle(qint64 lClientFileEntryHandle);

Default Value

0

Remarks

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

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

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

This property is not available at design time.

Data Type

Long64

ClientFileEntryLongName Property (SFTPServer Class)

Contains the long name of the file (human-readable, ftp-like).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetClientFileEntryLongName();
int SetClientFileEntryLongName(const char* lpszClientFileEntryLongName);

Unicode (Windows)
LPWSTR GetClientFileEntryLongName();
INT SetClientFileEntryLongName(LPCWSTR lpszClientFileEntryLongName);

char* secureblackbox_sftpserver_getclientfileentrylongname(void* lpObj);
int secureblackbox_sftpserver_setclientfileentrylongname(void* lpObj, const char* lpszClientFileEntryLongName);

QString GetClientFileEntryLongName();
int SetClientFileEntryLongName(QString qsClientFileEntryLongName);

Default Value

""

Remarks

Contains the long name of the file (human-readable, ftp-like).

This property is not available at design time.

Data Type

String

ClientFileEntryMTime Property (SFTPServer Class)

Specifies the last modification time, in UTC.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetClientFileEntryMTime();
int SetClientFileEntryMTime(const char* lpszClientFileEntryMTime);

Unicode (Windows)
LPWSTR GetClientFileEntryMTime();
INT SetClientFileEntryMTime(LPCWSTR lpszClientFileEntryMTime);

char* secureblackbox_sftpserver_getclientfileentrymtime(void* lpObj);
int secureblackbox_sftpserver_setclientfileentrymtime(void* lpObj, const char* lpszClientFileEntryMTime);

QString GetClientFileEntryMTime();
int SetClientFileEntryMTime(QString qsClientFileEntryMTime);

Default Value

""

Remarks

Specifies the last modification time, in UTC.

This property is not available at design time.

Data Type

String

ClientFileEntryName Property (SFTPServer Class)

Specifies the file name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetClientFileEntryName();
int SetClientFileEntryName(const char* lpszClientFileEntryName);

Unicode (Windows)
LPWSTR GetClientFileEntryName();
INT SetClientFileEntryName(LPCWSTR lpszClientFileEntryName);

char* secureblackbox_sftpserver_getclientfileentryname(void* lpObj);
int secureblackbox_sftpserver_setclientfileentryname(void* lpObj, const char* lpszClientFileEntryName);

QString GetClientFileEntryName();
int SetClientFileEntryName(QString qsClientFileEntryName);

Default Value

""

Remarks

Specifies the file name.

This property is not available at design time.

Data Type

String

ClientFileEntryOtherExecute Property (SFTPServer Class)

Controls file execution permission for other users (users that are neither owners, nor belong to the same group).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetClientFileEntryOtherExecute();
int SetClientFileEntryOtherExecute(int bClientFileEntryOtherExecute);

Unicode (Windows)
BOOL GetClientFileEntryOtherExecute();
INT SetClientFileEntryOtherExecute(BOOL bClientFileEntryOtherExecute);

int secureblackbox_sftpserver_getclientfileentryotherexecute(void* lpObj);
int secureblackbox_sftpserver_setclientfileentryotherexecute(void* lpObj, int bClientFileEntryOtherExecute);

bool GetClientFileEntryOtherExecute();
int SetClientFileEntryOtherExecute(bool bClientFileEntryOtherExecute);

Default Value

FALSE

Remarks

Controls file execution permission for other users (users that are neither owners, nor belong to the same group).

This property is not available at design time.

Data Type

Boolean

ClientFileEntryOtherRead Property (SFTPServer Class)

Controls file read permission for other users (users that are neither owners, nor belong to the same group).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetClientFileEntryOtherRead();
int SetClientFileEntryOtherRead(int bClientFileEntryOtherRead);

Unicode (Windows)
BOOL GetClientFileEntryOtherRead();
INT SetClientFileEntryOtherRead(BOOL bClientFileEntryOtherRead);

int secureblackbox_sftpserver_getclientfileentryotherread(void* lpObj);
int secureblackbox_sftpserver_setclientfileentryotherread(void* lpObj, int bClientFileEntryOtherRead);

bool GetClientFileEntryOtherRead();
int SetClientFileEntryOtherRead(bool bClientFileEntryOtherRead);

Default Value

FALSE

Remarks

Controls file read permission for other users (users that are neither owners, nor belong to the same group).

This property is not available at design time.

Data Type

Boolean

ClientFileEntryOtherWrite Property (SFTPServer Class)

Controls file write permission for other users (users that are neither owners, nor belong to the same group).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetClientFileEntryOtherWrite();
int SetClientFileEntryOtherWrite(int bClientFileEntryOtherWrite);

Unicode (Windows)
BOOL GetClientFileEntryOtherWrite();
INT SetClientFileEntryOtherWrite(BOOL bClientFileEntryOtherWrite);

int secureblackbox_sftpserver_getclientfileentryotherwrite(void* lpObj);
int secureblackbox_sftpserver_setclientfileentryotherwrite(void* lpObj, int bClientFileEntryOtherWrite);

bool GetClientFileEntryOtherWrite();
int SetClientFileEntryOtherWrite(bool bClientFileEntryOtherWrite);

Default Value

FALSE

Remarks

Controls file write permission for other users (users that are neither owners, nor belong to the same group).

This property is not available at design time.

Data Type

Boolean

ClientFileEntryOwner Property (SFTPServer Class)

Specifies the owner of the file/directory.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetClientFileEntryOwner();
int SetClientFileEntryOwner(const char* lpszClientFileEntryOwner);

Unicode (Windows)
LPWSTR GetClientFileEntryOwner();
INT SetClientFileEntryOwner(LPCWSTR lpszClientFileEntryOwner);

char* secureblackbox_sftpserver_getclientfileentryowner(void* lpObj);
int secureblackbox_sftpserver_setclientfileentryowner(void* lpObj, const char* lpszClientFileEntryOwner);

QString GetClientFileEntryOwner();
int SetClientFileEntryOwner(QString qsClientFileEntryOwner);

Default Value

""

Remarks

Specifies the owner of the file/directory.

This property is not available at design time.

Data Type

String

ClientFileEntryPath Property (SFTPServer Class)

Contains the full path to the file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetClientFileEntryPath();
int SetClientFileEntryPath(const char* lpszClientFileEntryPath);

Unicode (Windows)
LPWSTR GetClientFileEntryPath();
INT SetClientFileEntryPath(LPCWSTR lpszClientFileEntryPath);

char* secureblackbox_sftpserver_getclientfileentrypath(void* lpObj);
int secureblackbox_sftpserver_setclientfileentrypath(void* lpObj, const char* lpszClientFileEntryPath);

QString GetClientFileEntryPath();
int SetClientFileEntryPath(QString qsClientFileEntryPath);

Default Value

""

Remarks

Contains the full path to the file.

This property is not available at design time.

Data Type

String

ClientFileEntrySize Property (SFTPServer Class)

The size of the file in bytes.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetClientFileEntrySize();
int SetClientFileEntrySize(int64 lClientFileEntrySize);

Unicode (Windows)
LONG64 GetClientFileEntrySize();
INT SetClientFileEntrySize(LONG64 lClientFileEntrySize);

int64 secureblackbox_sftpserver_getclientfileentrysize(void* lpObj);
int secureblackbox_sftpserver_setclientfileentrysize(void* lpObj, int64 lClientFileEntrySize);

qint64 GetClientFileEntrySize();
int SetClientFileEntrySize(qint64 lClientFileEntrySize);

Default Value

0

Remarks

The size of the file in bytes.

This property is not available at design time.

Data Type

Long64

ClientFileEntryUserExecute Property (SFTPServer Class)

Controls file execution permission for the file owner.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetClientFileEntryUserExecute();
int SetClientFileEntryUserExecute(int bClientFileEntryUserExecute);

Unicode (Windows)
BOOL GetClientFileEntryUserExecute();
INT SetClientFileEntryUserExecute(BOOL bClientFileEntryUserExecute);

int secureblackbox_sftpserver_getclientfileentryuserexecute(void* lpObj);
int secureblackbox_sftpserver_setclientfileentryuserexecute(void* lpObj, int bClientFileEntryUserExecute);

bool GetClientFileEntryUserExecute();
int SetClientFileEntryUserExecute(bool bClientFileEntryUserExecute);

Default Value

FALSE

Remarks

Controls file execution permission for the file owner.

This property is not available at design time.

Data Type

Boolean

ClientFileEntryUserRead Property (SFTPServer Class)

Controls file read permission for the file owner.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetClientFileEntryUserRead();
int SetClientFileEntryUserRead(int bClientFileEntryUserRead);

Unicode (Windows)
BOOL GetClientFileEntryUserRead();
INT SetClientFileEntryUserRead(BOOL bClientFileEntryUserRead);

int secureblackbox_sftpserver_getclientfileentryuserread(void* lpObj);
int secureblackbox_sftpserver_setclientfileentryuserread(void* lpObj, int bClientFileEntryUserRead);

bool GetClientFileEntryUserRead();
int SetClientFileEntryUserRead(bool bClientFileEntryUserRead);

Default Value

FALSE

Remarks

Controls file read permission for the file owner.

This property is not available at design time.

Data Type

Boolean

ClientFileEntryUserWrite Property (SFTPServer Class)

Controls file write permission for the file owner.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetClientFileEntryUserWrite();
int SetClientFileEntryUserWrite(int bClientFileEntryUserWrite);

Unicode (Windows)
BOOL GetClientFileEntryUserWrite();
INT SetClientFileEntryUserWrite(BOOL bClientFileEntryUserWrite);

int secureblackbox_sftpserver_getclientfileentryuserwrite(void* lpObj);
int secureblackbox_sftpserver_setclientfileentryuserwrite(void* lpObj, int bClientFileEntryUserWrite);

bool GetClientFileEntryUserWrite();
int SetClientFileEntryUserWrite(bool bClientFileEntryUserWrite);

Default Value

FALSE

Remarks

Controls file write permission for the file owner.

This property is not available at design time.

Data Type

Boolean

CompressionLevel Property (SFTPServer Class)

Specifies the preferable compression level.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCompressionLevel();
int SetCompressionLevel(int iCompressionLevel);

Unicode (Windows)
INT GetCompressionLevel();
INT SetCompressionLevel(INT iCompressionLevel);

int secureblackbox_sftpserver_getcompressionlevel(void* lpObj);
int secureblackbox_sftpserver_setcompressionlevel(void* lpObj, int iCompressionLevel);

int GetCompressionLevel();
int SetCompressionLevel(int iCompressionLevel);

Default Value

9

Remarks

Set this property before starting the server. Possible values range from 0 (lowest compression) to 9 (maximum compression). This property is ignored if compression wasn't accepted.

Data Type

Integer

ExternalCryptoAsyncDocumentID Property (SFTPServer Class)

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

Syntax

• C++
• C
• Qt

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

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

char* secureblackbox_sftpserver_getexternalcryptoasyncdocumentid(void* lpObj);
int secureblackbox_sftpserver_setexternalcryptoasyncdocumentid(void* lpObj, const char* lpszExternalCryptoAsyncDocumentID);

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

Default Value

""

Remarks

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

Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. On the completion stage, this value helps the signing component identify the correct signature in the returned batch of responses.

If using batched requests, make sure to set this property to the same value on both the pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages.

Data Type

String

ExternalCryptoCustomParams Property (SFTPServer Class)

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

Syntax

• C++
• C
• Qt

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

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

char* secureblackbox_sftpserver_getexternalcryptocustomparams(void* lpObj);
int secureblackbox_sftpserver_setexternalcryptocustomparams(void* lpObj, const char* lpszExternalCryptoCustomParams);

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

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

ExternalCryptoData Property (SFTPServer Class)

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

Syntax

• C++
• C
• Qt

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

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

char* secureblackbox_sftpserver_getexternalcryptodata(void* lpObj);
int secureblackbox_sftpserver_setexternalcryptodata(void* lpObj, const char* lpszExternalCryptoData);

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

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

ExternalCryptoExternalHashCalculation Property (SFTPServer Class)

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

Syntax

• C++
• C
• Qt

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

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

int secureblackbox_sftpserver_getexternalcryptoexternalhashcalculation(void* lpObj);
int secureblackbox_sftpserver_setexternalcryptoexternalhashcalculation(void* lpObj, int bExternalCryptoExternalHashCalculation);

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

Default Value

FALSE

Remarks

Specifies whether the message hash is to be calculated at the external endpoint. Please note that this mode is not supported by the DCAuth class.

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

Data Type

Boolean

ExternalCryptoHashAlgorithm Property (SFTPServer Class)

Specifies the request's signature hash algorithm.

Syntax

• C++
• C
• Qt

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

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

char* secureblackbox_sftpserver_getexternalcryptohashalgorithm(void* lpObj);
int secureblackbox_sftpserver_setexternalcryptohashalgorithm(void* lpObj, const char* lpszExternalCryptoHashAlgorithm);

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

Default Value

"SHA256"

Remarks

Specifies the request's signature hash algorithm.

Data Type

String

ExternalCryptoKeyID Property (SFTPServer Class)

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

Syntax

• C++
• C
• Qt

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

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

char* secureblackbox_sftpserver_getexternalcryptokeyid(void* lpObj);
int secureblackbox_sftpserver_setexternalcryptokeyid(void* lpObj, const char* lpszExternalCryptoKeyID);

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

Default Value

""

Remarks

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

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

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

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

Example:

 
 Copy
  signer.ExternalCrypto.KeyID = "MainSigningKey";
  signer.ExternalCrypto.KeySecret = "abcdef0123456789";

Data Type

String

ExternalCryptoKeySecret Property (SFTPServer Class)

The pre-shared key used for DC request authentication.

Syntax

• C++
• C
• Qt

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

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

char* secureblackbox_sftpserver_getexternalcryptokeysecret(void* lpObj);
int secureblackbox_sftpserver_setexternalcryptokeysecret(void* lpObj, const char* lpszExternalCryptoKeySecret);

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

Default Value

""

Remarks

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

Read more about configuring authentication in the ExternalCryptoKeyID topic.

Data Type

String

ExternalCryptoMethod Property (SFTPServer Class)

Specifies the asynchronous signing method.

Syntax

• C++
• C
• Qt

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

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

ASMD_PKCS1(0), 
ASMD_PKCS7(1)

int secureblackbox_sftpserver_getexternalcryptomethod(void* lpObj);
int secureblackbox_sftpserver_setexternalcryptomethod(void* lpObj, int iExternalCryptoMethod);

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

Default Value

0

Remarks

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

Available options:

Data Type

Integer

ExternalCryptoMode Property (SFTPServer Class)

Specifies the external cryptography mode.

Syntax

• C++
• C
• Qt

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

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

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

int secureblackbox_sftpserver_getexternalcryptomode(void* lpObj);
int secureblackbox_sftpserver_setexternalcryptomode(void* lpObj, int iExternalCryptoMode);

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

Default Value

0

Remarks

Specifies the external cryptography mode.

Available options:

This property is not available at design time.

Data Type

Integer

ExternalCryptoPublicKeyAlgorithm Property (SFTPServer Class)

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

Syntax

• C++
• C
• Qt

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

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

char* secureblackbox_sftpserver_getexternalcryptopublickeyalgorithm(void* lpObj);
int secureblackbox_sftpserver_setexternalcryptopublickeyalgorithm(void* lpObj, const char* lpszExternalCryptoPublicKeyAlgorithm);

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

Default Value

""

Remarks

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

Data Type

String

FIPSMode Property (SFTPServer Class)

Reserved.

Syntax

• C++
• C
• Qt

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

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

int secureblackbox_sftpserver_getfipsmode(void* lpObj);
int secureblackbox_sftpserver_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 (SFTPServer Class)

This property specifies whether server explicitly requires data compression.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetForceCompression();
int SetForceCompression(int bForceCompression);

Unicode (Windows)
BOOL GetForceCompression();
INT SetForceCompression(BOOL bForceCompression);

int secureblackbox_sftpserver_getforcecompression(void* lpObj);
int secureblackbox_sftpserver_setforcecompression(void* lpObj, int bForceCompression);

bool GetForceCompression();
int SetForceCompression(bool bForceCompression);

Default Value

FALSE

Remarks

Set this property before starting the server. If it is set to true, the class will explicitly request data compression. If it is set to False, the class will support compression, although compression will be used only if the remote party doesn't support algorithms without compression.

Data Type

Boolean

Host Property (SFTPServer Class)

Specifies server's host name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetHost();
int SetHost(const char* lpszHost);

Unicode (Windows)
LPWSTR GetHost();
INT SetHost(LPCWSTR lpszHost);

char* secureblackbox_sftpserver_gethost(void* lpObj);
int secureblackbox_sftpserver_sethost(void* lpObj, const char* lpszHost);

QString GetHost();
int SetHost(QString qsHost);

Default Value

""

Remarks

Use this property to set the host name for this server.

Data Type

String

KeyFingerprintSHA1 Property (SFTPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetKeyFingerprintSHA1();

Unicode (Windows)
LPWSTR GetKeyFingerprintSHA1();

char* secureblackbox_sftpserver_getkeyfingerprintsha1(void* lpObj);

QString GetKeyFingerprintSHA1();

Default Value

""

Remarks

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

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

Data Type

String

KeyFingerprintSHA256 Property (SFTPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetKeyFingerprintSHA256();

Unicode (Windows)
LPWSTR GetKeyFingerprintSHA256();

char* secureblackbox_sftpserver_getkeyfingerprintsha256(void* lpObj);

QString GetKeyFingerprintSHA256();

Default Value

""

Remarks

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

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

Data Type

String

KeyHandle Property (SFTPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetKeyHandle();

Unicode (Windows)
LONG64 GetKeyHandle();

int64 secureblackbox_sftpserver_getkeyhandle(void* lpObj);

qint64 GetKeyHandle();

Default Value

0

Remarks

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

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

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

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

Data Type

Long64

MaxSFTPVersion Property (SFTPServer Class)

Maximum SFTP version supported.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMaxSFTPVersion();
int SetMaxSFTPVersion(int iMaxSFTPVersion);

Unicode (Windows)
INT GetMaxSFTPVersion();
INT SetMaxSFTPVersion(INT iMaxSFTPVersion);

int secureblackbox_sftpserver_getmaxsftpversion(void* lpObj);
int secureblackbox_sftpserver_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 server.

Data Type

Integer

MinSFTPVersion Property (SFTPServer Class)

Minimum SFTP version supported.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMinSFTPVersion();
int SetMinSFTPVersion(int iMinSFTPVersion);

Unicode (Windows)
INT GetMinSFTPVersion();
INT SetMinSFTPVersion(INT iMinSFTPVersion);

int secureblackbox_sftpserver_getminsftpversion(void* lpObj);
int secureblackbox_sftpserver_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 supported by this server.

Data Type

Integer

PinnedClientAddress Property (SFTPServer Class)

The client's IP address.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPinnedClientAddress();

Unicode (Windows)
LPWSTR GetPinnedClientAddress();

char* secureblackbox_sftpserver_getpinnedclientaddress(void* lpObj);

QString GetPinnedClientAddress();

Default Value

""

Remarks

The client's IP address.

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

Data Type

String

PinnedClientClientKeyAlgorithm Property (SFTPServer Class)

Specifies the client's key algorithm.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPinnedClientClientKeyAlgorithm();

Unicode (Windows)
LPWSTR GetPinnedClientClientKeyAlgorithm();

char* secureblackbox_sftpserver_getpinnedclientclientkeyalgorithm(void* lpObj);

QString GetPinnedClientClientKeyAlgorithm();

Default Value

""

Remarks

Specifies the client's key algorithm.

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

Data Type

String

PinnedClientClientKeyBits Property (SFTPServer Class)

Specifies the length of the client's key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPinnedClientClientKeyBits();

Unicode (Windows)
INT GetPinnedClientClientKeyBits();

int secureblackbox_sftpserver_getpinnedclientclientkeybits(void* lpObj);

int GetPinnedClientClientKeyBits();

Default Value

0

Remarks

Specifies the length of the client's key.

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

Data Type

Integer

PinnedClientClientKeyFingerprint Property (SFTPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPinnedClientClientKeyFingerprint();

Unicode (Windows)
LPWSTR GetPinnedClientClientKeyFingerprint();

char* secureblackbox_sftpserver_getpinnedclientclientkeyfingerprint(void* lpObj);

QString GetPinnedClientClientKeyFingerprint();

Default Value

""

Remarks

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

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

Data Type

String

PinnedClientClientSoftwareName Property (SFTPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPinnedClientClientSoftwareName();

Unicode (Windows)
LPWSTR GetPinnedClientClientSoftwareName();

char* secureblackbox_sftpserver_getpinnedclientclientsoftwarename(void* lpObj);

QString GetPinnedClientClientSoftwareName();

Default Value

""

Remarks

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

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

Data Type

String

PinnedClientCloseReason Property (SFTPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPinnedClientCloseReason();

Unicode (Windows)
LPWSTR GetPinnedClientCloseReason();

char* secureblackbox_sftpserver_getpinnedclientclosereason(void* lpObj);

QString GetPinnedClientCloseReason();

Default Value

""

Remarks

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

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

Data Type

String

PinnedClientCompressionAlgorithmInbound Property (SFTPServer Class)

Compression algorithm for the incoming traffic.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPinnedClientCompressionAlgorithmInbound();

Unicode (Windows)
LPWSTR GetPinnedClientCompressionAlgorithmInbound();

char* secureblackbox_sftpserver_getpinnedclientcompressionalgorithminbound(void* lpObj);

QString GetPinnedClientCompressionAlgorithmInbound();

Default Value

""

Remarks

Compression algorithm for the incoming traffic.

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

Data Type

String

PinnedClientCompressionAlgorithmOutbound Property (SFTPServer Class)

Compression algorithm for the outgoing traffic.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPinnedClientCompressionAlgorithmOutbound();

Unicode (Windows)
LPWSTR GetPinnedClientCompressionAlgorithmOutbound();

char* secureblackbox_sftpserver_getpinnedclientcompressionalgorithmoutbound(void* lpObj);

QString GetPinnedClientCompressionAlgorithmOutbound();

Default Value

""

Remarks

Compression algorithm for the outgoing traffic.

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

Data Type

String

PinnedClientEncryptionAlgorithmInbound Property (SFTPServer Class)

Encryption algorithm for the incoming traffic.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPinnedClientEncryptionAlgorithmInbound();

Unicode (Windows)
LPWSTR GetPinnedClientEncryptionAlgorithmInbound();

char* secureblackbox_sftpserver_getpinnedclientencryptionalgorithminbound(void* lpObj);

QString GetPinnedClientEncryptionAlgorithmInbound();

Default Value

""

Remarks

Encryption algorithm for the incoming traffic.

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

Data Type

String

PinnedClientEncryptionAlgorithmOutbound Property (SFTPServer Class)

Encryption algorithm for the outgoing traffic.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPinnedClientEncryptionAlgorithmOutbound();

Unicode (Windows)
LPWSTR GetPinnedClientEncryptionAlgorithmOutbound();

char* secureblackbox_sftpserver_getpinnedclientencryptionalgorithmoutbound(void* lpObj);

QString GetPinnedClientEncryptionAlgorithmOutbound();

Default Value

""

Remarks

Encryption algorithm for the outgoing traffic.

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

Data Type

String

PinnedClientID Property (SFTPServer Class)

The client connection's unique identifier.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetPinnedClientID();

Unicode (Windows)
LONG64 GetPinnedClientID();

int64 secureblackbox_sftpserver_getpinnedclientid(void* lpObj);

qint64 GetPinnedClientID();

Default Value

-1

Remarks

The client connection's unique identifier. This value is used throughout to refer to a particular client connection.

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

Data Type

Long64

PinnedClientInboundEncryptionKeyBits Property (SFTPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPinnedClientInboundEncryptionKeyBits();

Unicode (Windows)
INT GetPinnedClientInboundEncryptionKeyBits();

int secureblackbox_sftpserver_getpinnedclientinboundencryptionkeybits(void* lpObj);

int GetPinnedClientInboundEncryptionKeyBits();

Default Value

0

Remarks

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

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

Data Type

Integer

PinnedClientKexAlgorithm Property (SFTPServer Class)

The key exchange algorithm used during the SSH handshake.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPinnedClientKexAlgorithm();

Unicode (Windows)
LPWSTR GetPinnedClientKexAlgorithm();

char* secureblackbox_sftpserver_getpinnedclientkexalgorithm(void* lpObj);

QString GetPinnedClientKexAlgorithm();

Default Value

""

Remarks

The key exchange algorithm used during the SSH handshake.

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

Data Type

String

PinnedClientKexBits Property (SFTPServer Class)

The number of bits used by the key exchange algorithm.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPinnedClientKexBits();

Unicode (Windows)
INT GetPinnedClientKexBits();

int secureblackbox_sftpserver_getpinnedclientkexbits(void* lpObj);

int GetPinnedClientKexBits();

Default Value

0

Remarks

The number of bits used by the key exchange algorithm.

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

Data Type

Integer

PinnedClientKexLines Property (SFTPServer Class)

The contents of the received KexInit packet.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPinnedClientKexLines();

Unicode (Windows)
LPWSTR GetPinnedClientKexLines();

char* secureblackbox_sftpserver_getpinnedclientkexlines(void* lpObj);

QString GetPinnedClientKexLines();

Default Value

""

Remarks

The contents of the received KexInit packet.

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

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

Data Type

String

PinnedClientMacAlgorithmInbound Property (SFTPServer Class)

MAC algorithm used for the incoming connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPinnedClientMacAlgorithmInbound();

Unicode (Windows)
LPWSTR GetPinnedClientMacAlgorithmInbound();

char* secureblackbox_sftpserver_getpinnedclientmacalgorithminbound(void* lpObj);

QString GetPinnedClientMacAlgorithmInbound();

Default Value

""

Remarks

MAC algorithm used for the incoming connection.

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

Data Type

String

PinnedClientMacAlgorithmOutbound Property (SFTPServer Class)

MAC algorithm used for outbound connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPinnedClientMacAlgorithmOutbound();

Unicode (Windows)
LPWSTR GetPinnedClientMacAlgorithmOutbound();

char* secureblackbox_sftpserver_getpinnedclientmacalgorithmoutbound(void* lpObj);

QString GetPinnedClientMacAlgorithmOutbound();

Default Value

""

Remarks

MAC algorithm used for outbound connection.

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

Data Type

String

PinnedClientOutboundEncryptionKeyBits Property (SFTPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPinnedClientOutboundEncryptionKeyBits();

Unicode (Windows)
INT GetPinnedClientOutboundEncryptionKeyBits();

int secureblackbox_sftpserver_getpinnedclientoutboundencryptionkeybits(void* lpObj);

int GetPinnedClientOutboundEncryptionKeyBits();

Default Value

0

Remarks

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

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

Data Type

Integer

PinnedClientPort Property (SFTPServer Class)

The remote port of the client connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPinnedClientPort();

Unicode (Windows)
INT GetPinnedClientPort();

int secureblackbox_sftpserver_getpinnedclientport(void* lpObj);

int GetPinnedClientPort();

Default Value

0

Remarks

The remote port of the client connection.

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

Data Type

Integer

PinnedClientPublicKeyAlgorithm Property (SFTPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPinnedClientPublicKeyAlgorithm();

Unicode (Windows)
LPWSTR GetPinnedClientPublicKeyAlgorithm();

char* secureblackbox_sftpserver_getpinnedclientpublickeyalgorithm(void* lpObj);

QString GetPinnedClientPublicKeyAlgorithm();

Default Value

""

Remarks

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

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

Data Type

String

PinnedClientServerKeyBits Property (SFTPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPinnedClientServerKeyBits();

Unicode (Windows)
INT GetPinnedClientServerKeyBits();

int secureblackbox_sftpserver_getpinnedclientserverkeybits(void* lpObj);

int GetPinnedClientServerKeyBits();

Default Value

0

Remarks

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

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

Data Type

Integer

PinnedClientServerKeyFingerprint Property (SFTPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPinnedClientServerKeyFingerprint();

Unicode (Windows)
LPWSTR GetPinnedClientServerKeyFingerprint();

char* secureblackbox_sftpserver_getpinnedclientserverkeyfingerprint(void* lpObj);

QString GetPinnedClientServerKeyFingerprint();

Default Value

""

Remarks

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

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

Data Type

String

PinnedClientTotalBytesReceived Property (SFTPServer Class)

Returns the total number of bytes received over this connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetPinnedClientTotalBytesReceived();

Unicode (Windows)
LONG64 GetPinnedClientTotalBytesReceived();

int64 secureblackbox_sftpserver_getpinnedclienttotalbytesreceived(void* lpObj);

qint64 GetPinnedClientTotalBytesReceived();

Default Value

0

Remarks

Returns the total number of bytes received over this connection.

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

Data Type

Long64

PinnedClientTotalBytesSent Property (SFTPServer Class)

Returns the total number of bytes sent over this connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetPinnedClientTotalBytesSent();

Unicode (Windows)
LONG64 GetPinnedClientTotalBytesSent();

int64 secureblackbox_sftpserver_getpinnedclienttotalbytessent(void* lpObj);

qint64 GetPinnedClientTotalBytesSent();

Default Value

0

Remarks

Returns the total number of bytes sent over this connection.

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

Data Type

Long64

PinnedClientVersion Property (SFTPServer Class)

Specifies SSH protocol version.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPinnedClientVersion();

Unicode (Windows)
INT GetPinnedClientVersion();

int secureblackbox_sftpserver_getpinnedclientversion(void* lpObj);

int GetPinnedClientVersion();

Default Value

2

Remarks

Specifies SSH protocol version.

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

Data Type

Integer

Port Property (SFTPServer Class)

Specifies the listening port number.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPort();
int SetPort(int iPort);

Unicode (Windows)
INT GetPort();
INT SetPort(INT iPort);

int secureblackbox_sftpserver_getport(void* lpObj);
int secureblackbox_sftpserver_setport(void* lpObj, int iPort);

int GetPort();
int SetPort(int iPort);

Default Value

22

Remarks

Use this property to specify on which port the class will be listening to client connections.

Data Type

Integer

ReadOnly Property (SFTPServer Class)

Specifies whether files on the server are read-only.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetReadOnly();
int SetReadOnly(int bReadOnly);

Unicode (Windows)
BOOL GetReadOnly();
INT SetReadOnly(BOOL bReadOnly);

int secureblackbox_sftpserver_getreadonly(void* lpObj);
int secureblackbox_sftpserver_setreadonly(void* lpObj, int bReadOnly);

bool GetReadOnly();
int SetReadOnly(bool bReadOnly);

Default Value

FALSE

Remarks

Set this property to true to deny all client requests to change files on the server.

Data Type

Boolean

ServerKeyCount Property (SFTPServer Class)

The number of records in the ServerKey arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetServerKeyCount();
int SetServerKeyCount(int iServerKeyCount);

Unicode (Windows)
INT GetServerKeyCount();
INT SetServerKeyCount(INT iServerKeyCount);

int secureblackbox_sftpserver_getserverkeycount(void* lpObj);
int secureblackbox_sftpserver_setserverkeycount(void* lpObj, int iServerKeyCount);

int GetServerKeyCount();
int SetServerKeyCount(int iServerKeyCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• ServerKeyAlgorithm
• ServerKeyBits
• ServerKeyFingerprintMD5
• ServerKeyFingerprintSHA1
• ServerKeyHandle

The array indices start at 0 and end at ServerKeyCount - 1.

This property is not available at design time.

Data Type

Integer

ServerKeyAlgorithm Property (SFTPServer Class)

Specifies the key algorithm.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetServerKeyAlgorithm(int iServerKeyIndex);

Unicode (Windows)
LPWSTR GetServerKeyAlgorithm(INT iServerKeyIndex);

char* secureblackbox_sftpserver_getserverkeyalgorithm(void* lpObj, int serverkeyindex);

QString GetServerKeyAlgorithm(int iServerKeyIndex);

Default Value

""

Remarks

Specifies the key algorithm.

The ServerKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerKeyCount property.

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

Data Type

String

ServerKeyBits Property (SFTPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetServerKeyBits(int iServerKeyIndex);

Unicode (Windows)
INT GetServerKeyBits(INT iServerKeyIndex);

int secureblackbox_sftpserver_getserverkeybits(void* lpObj, int serverkeyindex);

int GetServerKeyBits(int iServerKeyIndex);

Default Value

0

Remarks

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

The ServerKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerKeyCount property.

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

Data Type

Integer

ServerKeyFingerprintMD5 Property (SFTPServer Class)

Contains the MD5 fingerprint (hash) of the key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetServerKeyFingerprintMD5(int iServerKeyIndex);

Unicode (Windows)
LPWSTR GetServerKeyFingerprintMD5(INT iServerKeyIndex);

char* secureblackbox_sftpserver_getserverkeyfingerprintmd5(void* lpObj, int serverkeyindex);

QString GetServerKeyFingerprintMD5(int iServerKeyIndex);

Default Value

""

Remarks

Contains the MD5 fingerprint (hash) of the key.

The ServerKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerKeyCount property.

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

Data Type

String

ServerKeyFingerprintSHA1 Property (SFTPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetServerKeyFingerprintSHA1(int iServerKeyIndex);

Unicode (Windows)
LPWSTR GetServerKeyFingerprintSHA1(INT iServerKeyIndex);

char* secureblackbox_sftpserver_getserverkeyfingerprintsha1(void* lpObj, int serverkeyindex);

QString GetServerKeyFingerprintSHA1(int iServerKeyIndex);

Default Value

""

Remarks

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

The ServerKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerKeyCount property.

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

Data Type

String

ServerKeyHandle Property (SFTPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetServerKeyHandle(int iServerKeyIndex);
int SetServerKeyHandle(int iServerKeyIndex, int64 lServerKeyHandle);

Unicode (Windows)
LONG64 GetServerKeyHandle(INT iServerKeyIndex);
INT SetServerKeyHandle(INT iServerKeyIndex, LONG64 lServerKeyHandle);

int64 secureblackbox_sftpserver_getserverkeyhandle(void* lpObj, int serverkeyindex);
int secureblackbox_sftpserver_setserverkeyhandle(void* lpObj, int serverkeyindex, int64 lServerKeyHandle);

qint64 GetServerKeyHandle(int iServerKeyIndex);
int SetServerKeyHandle(int iServerKeyIndex, qint64 lServerKeyHandle);

Default Value

0

Remarks

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

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

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

The ServerKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerKeyCount property.

This property is not available at design time.

Data Type

Long64

SocketIncomingSpeedLimit Property (SFTPServer Class)

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

Syntax

• C++
• C
• Qt

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

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

int secureblackbox_sftpserver_getsocketincomingspeedlimit(void* lpObj);
int secureblackbox_sftpserver_setsocketincomingspeedlimit(void* lpObj, int iSocketIncomingSpeedLimit);

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

Default Value

0

Remarks

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

Data Type

Integer

SocketLocalAddress Property (SFTPServer Class)

The local network interface to bind the socket to.

Syntax

• C++
• C
• Qt

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

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

char* secureblackbox_sftpserver_getsocketlocaladdress(void* lpObj);
int secureblackbox_sftpserver_setsocketlocaladdress(void* lpObj, const char* lpszSocketLocalAddress);

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

Default Value

""

Remarks

The local network interface to bind the socket to.

Data Type

String

SocketLocalPort Property (SFTPServer Class)

The local port number to bind the socket to.

Syntax

• C++
• C
• Qt

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

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

int secureblackbox_sftpserver_getsocketlocalport(void* lpObj);
int secureblackbox_sftpserver_setsocketlocalport(void* lpObj, int iSocketLocalPort);

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

Default Value

0

Remarks

The local port number to bind the socket to.

Data Type

Integer

SocketOutgoingSpeedLimit Property (SFTPServer Class)

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

Syntax

• C++
• C
• Qt

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

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

int secureblackbox_sftpserver_getsocketoutgoingspeedlimit(void* lpObj);
int secureblackbox_sftpserver_setsocketoutgoingspeedlimit(void* lpObj, int iSocketOutgoingSpeedLimit);

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

Default Value

0

Remarks

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

Data Type

Integer

SocketTimeout Property (SFTPServer Class)

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

Syntax

• C++
• C
• Qt

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

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

int secureblackbox_sftpserver_getsockettimeout(void* lpObj);
int secureblackbox_sftpserver_setsockettimeout(void* lpObj, int iSocketTimeout);

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

Default Value

60000

Remarks

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

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

Data Type

Integer

SocketUseIPv6 Property (SFTPServer Class)

Enables or disables IP protocol version 6.

Syntax

• C++
• C
• Qt

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

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

int secureblackbox_sftpserver_getsocketuseipv6(void* lpObj);
int secureblackbox_sftpserver_setsocketuseipv6(void* lpObj, int bSocketUseIPv6);

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

Default Value

FALSE

Remarks

Enables or disables IP protocol version 6.

Data Type

Boolean

SSHSettingsAutoAdjustCiphers Property (SFTPServer Class)

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

Syntax

• C++
• C
• Qt

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

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

int secureblackbox_sftpserver_getsshsettingsautoadjustciphers(void* lpObj);
int secureblackbox_sftpserver_setsshsettingsautoadjustciphers(void* lpObj, int bSSHSettingsAutoAdjustCiphers);

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

Default Value

TRUE

Remarks

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

Data Type

Boolean

SSHSettingsBaseConfiguration Property (SFTPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSHSettingsBaseConfiguration();
int SetSSHSettingsBaseConfiguration(int iSSHSettingsBaseConfiguration);

Unicode (Windows)
INT GetSSHSettingsBaseConfiguration();
INT SetSSHSettingsBaseConfiguration(INT iSSHSettingsBaseConfiguration);

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

int secureblackbox_sftpserver_getsshsettingsbaseconfiguration(void* lpObj);
int secureblackbox_sftpserver_setsshsettingsbaseconfiguration(void* lpObj, int iSSHSettingsBaseConfiguration);

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

Default Value

0

Remarks

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

Data Type

Integer

SSHSettingsCompressionAlgorithms Property (SFTPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSHSettingsCompressionAlgorithms();
int SetSSHSettingsCompressionAlgorithms(const char* lpszSSHSettingsCompressionAlgorithms);

Unicode (Windows)
LPWSTR GetSSHSettingsCompressionAlgorithms();
INT SetSSHSettingsCompressionAlgorithms(LPCWSTR lpszSSHSettingsCompressionAlgorithms);

char* secureblackbox_sftpserver_getsshsettingscompressionalgorithms(void* lpObj);
int secureblackbox_sftpserver_setsshsettingscompressionalgorithms(void* lpObj, const char* lpszSSHSettingsCompressionAlgorithms);

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

Default Value

""

Remarks

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

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

• none
• zlib
• zlib@openssh.com

Data Type

String

SSHSettingsCompressionLevel Property (SFTPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSHSettingsCompressionLevel();
int SetSSHSettingsCompressionLevel(int iSSHSettingsCompressionLevel);

Unicode (Windows)
INT GetSSHSettingsCompressionLevel();
INT SetSSHSettingsCompressionLevel(INT iSSHSettingsCompressionLevel);

int secureblackbox_sftpserver_getsshsettingscompressionlevel(void* lpObj);
int secureblackbox_sftpserver_setsshsettingscompressionlevel(void* lpObj, int iSSHSettingsCompressionLevel);

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

Default Value

6

Remarks

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

Data Type

Integer

SSHSettingsDefaultWindowSize Property (SFTPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSHSettingsDefaultWindowSize();
int SetSSHSettingsDefaultWindowSize(int iSSHSettingsDefaultWindowSize);

Unicode (Windows)
INT GetSSHSettingsDefaultWindowSize();
INT SetSSHSettingsDefaultWindowSize(INT iSSHSettingsDefaultWindowSize);

int secureblackbox_sftpserver_getsshsettingsdefaultwindowsize(void* lpObj);
int secureblackbox_sftpserver_setsshsettingsdefaultwindowsize(void* lpObj, int iSSHSettingsDefaultWindowSize);

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

Default Value

2048000

Remarks

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

Data Type

Integer

SSHSettingsEncryptionAlgorithms Property (SFTPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSHSettingsEncryptionAlgorithms();
int SetSSHSettingsEncryptionAlgorithms(const char* lpszSSHSettingsEncryptionAlgorithms);

Unicode (Windows)
LPWSTR GetSSHSettingsEncryptionAlgorithms();
INT SetSSHSettingsEncryptionAlgorithms(LPCWSTR lpszSSHSettingsEncryptionAlgorithms);

char* secureblackbox_sftpserver_getsshsettingsencryptionalgorithms(void* lpObj);
int secureblackbox_sftpserver_setsshsettingsencryptionalgorithms(void* lpObj, const char* lpszSSHSettingsEncryptionAlgorithms);

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

Default Value

""

Remarks

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

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

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

Data Type

String

SSHSettingsForceCompression Property (SFTPServer Class)

Whether the SSH client should explicitly request compression.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSHSettingsForceCompression();
int SetSSHSettingsForceCompression(int bSSHSettingsForceCompression);

Unicode (Windows)
BOOL GetSSHSettingsForceCompression();
INT SetSSHSettingsForceCompression(BOOL bSSHSettingsForceCompression);

int secureblackbox_sftpserver_getsshsettingsforcecompression(void* lpObj);
int secureblackbox_sftpserver_setsshsettingsforcecompression(void* lpObj, int bSSHSettingsForceCompression);

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

Default Value

FALSE

Remarks

Whether the SSH client should explicitly request compression.

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

Data Type

Boolean

SSHSettingsGSSAuthTypes Property (SFTPServer Class)

A comma-separated list of authentication types.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSHSettingsGSSAuthTypes();
int SetSSHSettingsGSSAuthTypes(const char* lpszSSHSettingsGSSAuthTypes);

Unicode (Windows)
LPWSTR GetSSHSettingsGSSAuthTypes();
INT SetSSHSettingsGSSAuthTypes(LPCWSTR lpszSSHSettingsGSSAuthTypes);

char* secureblackbox_sftpserver_getsshsettingsgssauthtypes(void* lpObj);
int secureblackbox_sftpserver_setsshsettingsgssauthtypes(void* lpObj, const char* lpszSSHSettingsGSSAuthTypes);

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

Default Value

""

Remarks

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

Data Type

String

SSHSettingsGSSDelegateCreds Property (SFTPServer Class)

Switches credential delegation on or off.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSHSettingsGSSDelegateCreds();
int SetSSHSettingsGSSDelegateCreds(int bSSHSettingsGSSDelegateCreds);

Unicode (Windows)
BOOL GetSSHSettingsGSSDelegateCreds();
INT SetSSHSettingsGSSDelegateCreds(BOOL bSSHSettingsGSSDelegateCreds);

int secureblackbox_sftpserver_getsshsettingsgssdelegatecreds(void* lpObj);
int secureblackbox_sftpserver_setsshsettingsgssdelegatecreds(void* lpObj, int bSSHSettingsGSSDelegateCreds);

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

Default Value

FALSE

Remarks

Switches credential delegation on or off.

Data Type

Boolean

SSHSettingsGSSHostname Property (SFTPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSHSettingsGSSHostname();
int SetSSHSettingsGSSHostname(const char* lpszSSHSettingsGSSHostname);

Unicode (Windows)
LPWSTR GetSSHSettingsGSSHostname();
INT SetSSHSettingsGSSHostname(LPCWSTR lpszSSHSettingsGSSHostname);

char* secureblackbox_sftpserver_getsshsettingsgsshostname(void* lpObj);
int secureblackbox_sftpserver_setsshsettingsgsshostname(void* lpObj, const char* lpszSSHSettingsGSSHostname);

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

Default Value

""

Remarks

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

Data Type

String

SSHSettingsGSSLib Property (SFTPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSHSettingsGSSLib();
int SetSSHSettingsGSSLib(const char* lpszSSHSettingsGSSLib);

Unicode (Windows)
LPWSTR GetSSHSettingsGSSLib();
INT SetSSHSettingsGSSLib(LPCWSTR lpszSSHSettingsGSSLib);

char* secureblackbox_sftpserver_getsshsettingsgsslib(void* lpObj);
int secureblackbox_sftpserver_setsshsettingsgsslib(void* lpObj, const char* lpszSSHSettingsGSSLib);

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

Default Value