WebDAVServer Class

Properties   Methods   Events   Config Settings   Errors  

The WebDAVServer class offers server-side functionality for the WebDAV protocol.

Syntax

WebDAVServer

Remarks

Both plain (HTTP) and secure (HTTPS) connection types are supported.

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

Indicates whether the server is active and is listening to new connections.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetActive();

Unicode (Windows)
BOOL GetActive();

int secureblackbox_webdavserver_getactive(void* lpObj);

bool GetActive();

Default Value

FALSE

Remarks

This read-only property returns True if the server is listening to incoming connections.

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

Data Type

Boolean

AuthBasic Property (WebDAVServer Class)

Enables or disables basic authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAuthBasic();
int SetAuthBasic(int bAuthBasic);

Unicode (Windows)
BOOL GetAuthBasic();
INT SetAuthBasic(BOOL bAuthBasic);

int secureblackbox_webdavserver_getauthbasic(void* lpObj);
int secureblackbox_webdavserver_setauthbasic(void* lpObj, int bAuthBasic);

bool GetAuthBasic();
int SetAuthBasic(bool bAuthBasic);

Default Value

FALSE

Remarks

Use this property to enable or disable basic user authentication in the HTTP server.

Data Type

Boolean

AuthDigest Property (WebDAVServer Class)

Enables or disables digest authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAuthDigest();
int SetAuthDigest(int bAuthDigest);

Unicode (Windows)
BOOL GetAuthDigest();
INT SetAuthDigest(BOOL bAuthDigest);

int secureblackbox_webdavserver_getauthdigest(void* lpObj);
int secureblackbox_webdavserver_setauthdigest(void* lpObj, int bAuthDigest);

bool GetAuthDigest();
int SetAuthDigest(bool bAuthDigest);

Default Value

FALSE

Remarks

Use this property to enable or disable digest-based user authentication in the HTTP server.

Data Type

Boolean

AuthDigestExpire Property (WebDAVServer Class)

Specifies digest expiration time for digest authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAuthDigestExpire();
int SetAuthDigestExpire(int iAuthDigestExpire);

Unicode (Windows)
INT GetAuthDigestExpire();
INT SetAuthDigestExpire(INT iAuthDigestExpire);

int secureblackbox_webdavserver_getauthdigestexpire(void* lpObj);
int secureblackbox_webdavserver_setauthdigestexpire(void* lpObj, int iAuthDigestExpire);

int GetAuthDigestExpire();
int SetAuthDigestExpire(int iAuthDigestExpire);

Default Value

20

Remarks

Use this property to specify the digest expiration time for digest authentication, in seconds.

Data Type

Integer

AuthRealm Property (WebDAVServer Class)

Specifies authentication realm for digest and NTLM authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAuthRealm();
int SetAuthRealm(const char* lpszAuthRealm);

Unicode (Windows)
LPWSTR GetAuthRealm();
INT SetAuthRealm(LPCWSTR lpszAuthRealm);

char* secureblackbox_webdavserver_getauthrealm(void* lpObj);
int secureblackbox_webdavserver_setauthrealm(void* lpObj, const char* lpszAuthRealm);

QString GetAuthRealm();
int SetAuthRealm(QString qsAuthRealm);

Default Value

"SecureBlackbox"

Remarks

Specifies authentication realm for digest and NTLM authentication types.

Data Type

String

BoundPort Property (WebDAVServer Class)

Indicates the bound listening port.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetBoundPort();

Unicode (Windows)
INT GetBoundPort();

int secureblackbox_webdavserver_getboundport(void* lpObj);

int GetBoundPort();

Default Value

0

Remarks

Check this property to find out the port that has been allocated to the server by the system. The bound port always equals Port if it is provided, or is allocated dynamically if configured to fall in the range between PortRangeFrom and PortRangeTo constraints.

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

Data Type

Integer

ClientAuth Property (WebDAVServer Class)

Enables or disables certificate-based client authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetClientAuth();
int SetClientAuth(int iClientAuth);

Unicode (Windows)
INT GetClientAuth();
INT SetClientAuth(INT iClientAuth);

CCAT_NO_AUTH(0), 
CCAT_REQUEST_CERT(1), 
CCAT_REQUIRE_CERT(2)

int secureblackbox_webdavserver_getclientauth(void* lpObj);
int secureblackbox_webdavserver_setclientauth(void* lpObj, int iClientAuth);

int GetClientAuth();
int SetClientAuth(int iClientAuth);

Default Value

0

Remarks

Set this property to true to tune up the client authentication type: ccatNoAuth = 0; ccatRequestCert = 1; ccatRequireCert = 2;

Data Type

Integer

ClientFileEntryATime Property (WebDAVServer Class)

Contains the last access time for this object, 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_webdavserver_getclientfileentryatime(void* lpObj);
int secureblackbox_webdavserver_setclientfileentryatime(void* lpObj, const char* lpszClientFileEntryATime);

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

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

ClientFileEntryContentType Property (WebDAVServer Class)

The object's content type.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetClientFileEntryContentType();
int SetClientFileEntryContentType(const char* lpszClientFileEntryContentType);

Unicode (Windows)
LPWSTR GetClientFileEntryContentType();
INT SetClientFileEntryContentType(LPCWSTR lpszClientFileEntryContentType);

char* secureblackbox_webdavserver_getclientfileentrycontenttype(void* lpObj);
int secureblackbox_webdavserver_setclientfileentrycontenttype(void* lpObj, const char* lpszClientFileEntryContentType);

QString GetClientFileEntryContentType();
int SetClientFileEntryContentType(QString qsClientFileEntryContentType);

Default Value

""

Remarks

The object's content type.

This property is not available at design time.

Data Type

String

ClientFileEntryCTime Property (WebDAVServer Class)

Contains this object'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_webdavserver_getclientfileentryctime(void* lpObj);
int secureblackbox_webdavserver_setclientfileentryctime(void* lpObj, const char* lpszClientFileEntryCTime);

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

Default Value

""

Remarks

Contains this object's creation time, in UTC.

This property is not available at design time.

Data Type

String

ClientFileEntryDirectory Property (WebDAVServer Class)

Specifies whether this object 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_webdavserver_getclientfileentrydirectory(void* lpObj);
int secureblackbox_webdavserver_setclientfileentrydirectory(void* lpObj, int bClientFileEntryDirectory);

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

Default Value

FALSE

Remarks

Specifies whether this object is a directory.

This property is not available at design time.

Data Type

Boolean

ClientFileEntryDisplayName Property (WebDAVServer Class)

Contains the display name of the object.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetClientFileEntryDisplayName();
int SetClientFileEntryDisplayName(const char* lpszClientFileEntryDisplayName);

Unicode (Windows)
LPWSTR GetClientFileEntryDisplayName();
INT SetClientFileEntryDisplayName(LPCWSTR lpszClientFileEntryDisplayName);

char* secureblackbox_webdavserver_getclientfileentrydisplayname(void* lpObj);
int secureblackbox_webdavserver_setclientfileentrydisplayname(void* lpObj, const char* lpszClientFileEntryDisplayName);

QString GetClientFileEntryDisplayName();
int SetClientFileEntryDisplayName(QString qsClientFileEntryDisplayName);

Default Value

""

Remarks

Contains the display name of the object.

This property is not available at design time.

Data Type

String

ClientFileEntryETag Property (WebDAVServer Class)

An e-tag of the object.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetClientFileEntryETag();
int SetClientFileEntryETag(const char* lpszClientFileEntryETag);

Unicode (Windows)
LPWSTR GetClientFileEntryETag();
INT SetClientFileEntryETag(LPCWSTR lpszClientFileEntryETag);

char* secureblackbox_webdavserver_getclientfileentryetag(void* lpObj);
int secureblackbox_webdavserver_setclientfileentryetag(void* lpObj, const char* lpszClientFileEntryETag);

QString GetClientFileEntryETag();
int SetClientFileEntryETag(QString qsClientFileEntryETag);

Default Value

""

Remarks

An e-tag of the object.

This property is not available at design time.

Data Type

String

ClientFileEntryFullURL Property (WebDAVServer Class)

A full path to the object.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetClientFileEntryFullURL();
int SetClientFileEntryFullURL(const char* lpszClientFileEntryFullURL);

Unicode (Windows)
LPWSTR GetClientFileEntryFullURL();
INT SetClientFileEntryFullURL(LPCWSTR lpszClientFileEntryFullURL);

char* secureblackbox_webdavserver_getclientfileentryfullurl(void* lpObj);
int secureblackbox_webdavserver_setclientfileentryfullurl(void* lpObj, const char* lpszClientFileEntryFullURL);

QString GetClientFileEntryFullURL();
int SetClientFileEntryFullURL(QString qsClientFileEntryFullURL);

Default Value

""

Remarks

A full path to the object.

This property is not available at design time.

Data Type

String

ClientFileEntryMTime Property (WebDAVServer Class)

The last modification time of the object, 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_webdavserver_getclientfileentrymtime(void* lpObj);
int secureblackbox_webdavserver_setclientfileentrymtime(void* lpObj, const char* lpszClientFileEntryMTime);

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

Default Value

""

Remarks

The last modification time of the object, in UTC.

This property is not available at design time.

Data Type

String

ClientFileEntryParentURL Property (WebDAVServer Class)

Specifies the object's parent URL.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetClientFileEntryParentURL();
int SetClientFileEntryParentURL(const char* lpszClientFileEntryParentURL);

Unicode (Windows)
LPWSTR GetClientFileEntryParentURL();
INT SetClientFileEntryParentURL(LPCWSTR lpszClientFileEntryParentURL);

char* secureblackbox_webdavserver_getclientfileentryparenturl(void* lpObj);
int secureblackbox_webdavserver_setclientfileentryparenturl(void* lpObj, const char* lpszClientFileEntryParentURL);

QString GetClientFileEntryParentURL();
int SetClientFileEntryParentURL(QString qsClientFileEntryParentURL);

Default Value

""

Remarks

Specifies the object's parent URL.

This property is not available at design time.

Data Type

String

ClientFileEntrySize Property (WebDAVServer Class)

The size of the object 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_webdavserver_getclientfileentrysize(void* lpObj);
int secureblackbox_webdavserver_setclientfileentrysize(void* lpObj, int64 lClientFileEntrySize);

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

Default Value

0

Remarks

The size of the object in bytes.

This property is not available at design time.

Data Type

Long64

ClientFileEntrySupportsExclusiveLock Property (WebDAVServer Class)

Indicates whether the entry supports exclusive locking.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetClientFileEntrySupportsExclusiveLock();
int SetClientFileEntrySupportsExclusiveLock(int bClientFileEntrySupportsExclusiveLock);

Unicode (Windows)
BOOL GetClientFileEntrySupportsExclusiveLock();
INT SetClientFileEntrySupportsExclusiveLock(BOOL bClientFileEntrySupportsExclusiveLock);

int secureblackbox_webdavserver_getclientfileentrysupportsexclusivelock(void* lpObj);
int secureblackbox_webdavserver_setclientfileentrysupportsexclusivelock(void* lpObj, int bClientFileEntrySupportsExclusiveLock);

bool GetClientFileEntrySupportsExclusiveLock();
int SetClientFileEntrySupportsExclusiveLock(bool bClientFileEntrySupportsExclusiveLock);

Default Value

FALSE

Remarks

Indicates whether the entry supports exclusive locking.

This property is not available at design time.

Data Type

Boolean

ClientFileEntrySupportsSharedLock Property (WebDAVServer Class)

Indicates whether the entry supports shared lock.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetClientFileEntrySupportsSharedLock();
int SetClientFileEntrySupportsSharedLock(int bClientFileEntrySupportsSharedLock);

Unicode (Windows)
BOOL GetClientFileEntrySupportsSharedLock();
INT SetClientFileEntrySupportsSharedLock(BOOL bClientFileEntrySupportsSharedLock);

int secureblackbox_webdavserver_getclientfileentrysupportssharedlock(void* lpObj);
int secureblackbox_webdavserver_setclientfileentrysupportssharedlock(void* lpObj, int bClientFileEntrySupportsSharedLock);

bool GetClientFileEntrySupportsSharedLock();
int SetClientFileEntrySupportsSharedLock(bool bClientFileEntrySupportsSharedLock);

Default Value

FALSE

Remarks

Indicates whether the entry supports shared lock.

This property is not available at design time.

Data Type

Boolean

ClientFileEntryURL Property (WebDAVServer Class)

A URL of the object.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetClientFileEntryURL();
int SetClientFileEntryURL(const char* lpszClientFileEntryURL);

Unicode (Windows)
LPWSTR GetClientFileEntryURL();
INT SetClientFileEntryURL(LPCWSTR lpszClientFileEntryURL);

char* secureblackbox_webdavserver_getclientfileentryurl(void* lpObj);
int secureblackbox_webdavserver_setclientfileentryurl(void* lpObj, const char* lpszClientFileEntryURL);

QString GetClientFileEntryURL();
int SetClientFileEntryURL(QString qsClientFileEntryURL);

Default Value

""

Remarks

A URL of the object.

This property is not available at design time.

Data Type

String

DocumentRoot Property (WebDAVServer Class)

The document root of the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDocumentRoot();
int SetDocumentRoot(const char* lpszDocumentRoot);

Unicode (Windows)
LPWSTR GetDocumentRoot();
INT SetDocumentRoot(LPCWSTR lpszDocumentRoot);

char* secureblackbox_webdavserver_getdocumentroot(void* lpObj);
int secureblackbox_webdavserver_setdocumentroot(void* lpObj, const char* lpszDocumentRoot);

QString GetDocumentRoot();
int SetDocumentRoot(QString qsDocumentRoot);

Default Value

""

Remarks

Use this property to specify a local folder which is going to be the server's document root (the mount point of the virtual home directory).

Data Type

String

ErrorOrigin Property (WebDAVServer Class)

Indicates the endpoint where the error originates from.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetErrorOrigin();
int SetErrorOrigin(int iErrorOrigin);

Unicode (Windows)
INT GetErrorOrigin();
INT SetErrorOrigin(INT iErrorOrigin);

EO_LOCAL(0), 
EO_REMOTE(1)

int secureblackbox_webdavserver_geterrororigin(void* lpObj);
int secureblackbox_webdavserver_seterrororigin(void* lpObj, int iErrorOrigin);

int GetErrorOrigin();
int SetErrorOrigin(int iErrorOrigin);

Default Value

0

Remarks

Use this property to establish whether the reported error originates from a local or remote endpoint.

This property is not available at design time.

Data Type

Integer

ErrorSeverity Property (WebDAVServer Class)

The severity of the error that happened.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetErrorSeverity();
int SetErrorSeverity(int iErrorSeverity);

Unicode (Windows)
INT GetErrorSeverity();
INT SetErrorSeverity(INT iErrorSeverity);

ES_INFO(0), 
ES_WARNING(1), 
ES_FATAL(2)

int secureblackbox_webdavserver_geterrorseverity(void* lpObj);
int secureblackbox_webdavserver_seterrorseverity(void* lpObj, int iErrorSeverity);

int GetErrorSeverity();
int SetErrorSeverity(int iErrorSeverity);

Default Value

1

Remarks

Use this property to establish whether the error is fatal.

This property is not available at design time.

Data Type

Integer

ExternalCryptoAsyncDocumentID Property (WebDAVServer 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_webdavserver_getexternalcryptoasyncdocumentid(void* lpObj);
int secureblackbox_webdavserver_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 (WebDAVServer 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_webdavserver_getexternalcryptocustomparams(void* lpObj);
int secureblackbox_webdavserver_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 (WebDAVServer 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_webdavserver_getexternalcryptodata(void* lpObj);
int secureblackbox_webdavserver_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 (WebDAVServer 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_webdavserver_getexternalcryptoexternalhashcalculation(void* lpObj);
int secureblackbox_webdavserver_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 (WebDAVServer 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_webdavserver_getexternalcryptohashalgorithm(void* lpObj);
int secureblackbox_webdavserver_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 (WebDAVServer 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_webdavserver_getexternalcryptokeyid(void* lpObj);
int secureblackbox_webdavserver_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 (WebDAVServer 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_webdavserver_getexternalcryptokeysecret(void* lpObj);
int secureblackbox_webdavserver_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 (WebDAVServer 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_webdavserver_getexternalcryptomethod(void* lpObj);
int secureblackbox_webdavserver_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 (WebDAVServer 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_webdavserver_getexternalcryptomode(void* lpObj);
int secureblackbox_webdavserver_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 (WebDAVServer 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_webdavserver_getexternalcryptopublickeyalgorithm(void* lpObj);
int secureblackbox_webdavserver_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 (WebDAVServer 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_webdavserver_getfipsmode(void* lpObj);
int secureblackbox_webdavserver_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

Host Property (WebDAVServer Class)

The host to bind the listening port to.

Syntax

• C++
• C
• Qt

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

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

char* secureblackbox_webdavserver_gethost(void* lpObj);
int secureblackbox_webdavserver_sethost(void* lpObj, const char* lpszHost);

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

Default Value

""

Remarks

Use this property to specify the IP address on which to listen to incoming connections.

Data Type

String

MetadataFlushTimeout Property (WebDAVServer Class)

Specifies metadata flush timeout.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMetadataFlushTimeout();
int SetMetadataFlushTimeout(int iMetadataFlushTimeout);

Unicode (Windows)
INT GetMetadataFlushTimeout();
INT SetMetadataFlushTimeout(INT iMetadataFlushTimeout);

int secureblackbox_webdavserver_getmetadataflushtimeout(void* lpObj);
int secureblackbox_webdavserver_setmetadataflushtimeout(void* lpObj, int iMetadataFlushTimeout);

int GetMetadataFlushTimeout();
int SetMetadataFlushTimeout(int iMetadataFlushTimeout);

Default Value

600

Remarks

Use this property to specify metadata flush timeout in seconds.

Data Type

Integer

MetadataRoot Property (WebDAVServer Class)

The metadata directory root.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMetadataRoot();
int SetMetadataRoot(const char* lpszMetadataRoot);

Unicode (Windows)
LPWSTR GetMetadataRoot();
INT SetMetadataRoot(LPCWSTR lpszMetadataRoot);

char* secureblackbox_webdavserver_getmetadataroot(void* lpObj);
int secureblackbox_webdavserver_setmetadataroot(void* lpObj, const char* lpszMetadataRoot);

QString GetMetadataRoot();
int SetMetadataRoot(QString qsMetadataRoot);

Default Value

""

Remarks

The metadata directory is a dedicated location for storing properties of the files served by the WebDAVServer.

Data Type

String

PinnedClientAddress Property (WebDAVServer Class)

The client's IP address.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPinnedClientAddress();

Unicode (Windows)
LPWSTR GetPinnedClientAddress();

char* secureblackbox_webdavserver_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

PinnedClientChainValidationDetails Property (WebDAVServer Class)

The details of a certificate chain validation outcome.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPinnedClientChainValidationDetails();

Unicode (Windows)
INT GetPinnedClientChainValidationDetails();

int secureblackbox_webdavserver_getpinnedclientchainvalidationdetails(void* lpObj);

int GetPinnedClientChainValidationDetails();

Default Value

0

Remarks

The details of a certificate chain validation outcome. They may often suggest the reasons that contributed to the overall validation result.

Returns a bit mask of the following options:

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

Data Type

Integer

PinnedClientChainValidationResult Property (WebDAVServer Class)

The outcome of a certificate chain validation routine.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPinnedClientChainValidationResult();

Unicode (Windows)
INT GetPinnedClientChainValidationResult();

CVT_VALID(0), 
CVT_VALID_BUT_UNTRUSTED(1), 
CVT_INVALID(2), 
CVT_CANT_BE_ESTABLISHED(3)

int secureblackbox_webdavserver_getpinnedclientchainvalidationresult(void* lpObj);

int GetPinnedClientChainValidationResult();

Default Value

0

Remarks

The outcome of a certificate chain validation routine.

Available options:

Use the ValidationLog property to access the detailed validation log.

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

Data Type

Integer

PinnedClientCiphersuite Property (WebDAVServer Class)

The cipher suite employed by this connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPinnedClientCiphersuite();

Unicode (Windows)
LPWSTR GetPinnedClientCiphersuite();

char* secureblackbox_webdavserver_getpinnedclientciphersuite(void* lpObj);

QString GetPinnedClientCiphersuite();

Default Value

""

Remarks

The cipher suite employed by this connection.

For TLS connections, this property returns the ciphersuite that was/is employed by the connection.

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

Data Type

String

PinnedClientClientAuthenticated Property (WebDAVServer Class)

Specifies whether client authentication was performed during this connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPinnedClientClientAuthenticated();

Unicode (Windows)
BOOL GetPinnedClientClientAuthenticated();

int secureblackbox_webdavserver_getpinnedclientclientauthenticated(void* lpObj);

bool GetPinnedClientClientAuthenticated();

Default Value

FALSE

Remarks

Specifies whether client authentication was performed during this connection.

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

Data Type

Boolean

PinnedClientDigestAlgorithm Property (WebDAVServer Class)

The digest algorithm used in a TLS-enabled connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPinnedClientDigestAlgorithm();

Unicode (Windows)
LPWSTR GetPinnedClientDigestAlgorithm();

char* secureblackbox_webdavserver_getpinnedclientdigestalgorithm(void* lpObj);

QString GetPinnedClientDigestAlgorithm();

Default Value

""

Remarks

The digest algorithm used in a TLS-enabled connection.

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

Data Type

String

PinnedClientEncryptionAlgorithm Property (WebDAVServer Class)

The symmetric encryption algorithm used in a TLS-enabled connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPinnedClientEncryptionAlgorithm();

Unicode (Windows)
LPWSTR GetPinnedClientEncryptionAlgorithm();

char* secureblackbox_webdavserver_getpinnedclientencryptionalgorithm(void* lpObj);

QString GetPinnedClientEncryptionAlgorithm();

Default Value

""

Remarks

The symmetric encryption algorithm used in a TLS-enabled connection.

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

Data Type

String

PinnedClientID Property (WebDAVServer Class)

The client connection's unique identifier.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetPinnedClientID();

Unicode (Windows)
LONG64 GetPinnedClientID();

int64 secureblackbox_webdavserver_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

PinnedClientKeyExchangeAlgorithm Property (WebDAVServer Class)

The key exchange algorithm used in a TLS-enabled connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPinnedClientKeyExchangeAlgorithm();

Unicode (Windows)
LPWSTR GetPinnedClientKeyExchangeAlgorithm();

char* secureblackbox_webdavserver_getpinnedclientkeyexchangealgorithm(void* lpObj);

QString GetPinnedClientKeyExchangeAlgorithm();

Default Value

""

Remarks

The key exchange algorithm used in a TLS-enabled connection.

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

Data Type

String

PinnedClientKeyExchangeKeyBits Property (WebDAVServer Class)

The length of the key exchange key of a TLS-enabled connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPinnedClientKeyExchangeKeyBits();

Unicode (Windows)
INT GetPinnedClientKeyExchangeKeyBits();

int secureblackbox_webdavserver_getpinnedclientkeyexchangekeybits(void* lpObj);

int GetPinnedClientKeyExchangeKeyBits();

Default Value

0

Remarks

The length of the key exchange key of a TLS-enabled connection.

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

Data Type

Integer

PinnedClientNamedECCurve Property (WebDAVServer Class)

The elliptic curve used in this connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPinnedClientNamedECCurve();

Unicode (Windows)
LPWSTR GetPinnedClientNamedECCurve();

char* secureblackbox_webdavserver_getpinnedclientnamedeccurve(void* lpObj);

QString GetPinnedClientNamedECCurve();

Default Value

""

Remarks

The elliptic curve used in this connection.

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

Data Type

String

PinnedClientPFSCipher Property (WebDAVServer Class)

Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPinnedClientPFSCipher();

Unicode (Windows)
BOOL GetPinnedClientPFSCipher();

int secureblackbox_webdavserver_getpinnedclientpfscipher(void* lpObj);

bool GetPinnedClientPFSCipher();

Default Value

FALSE

Remarks

Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS).

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

Data Type

Boolean

PinnedClientPort Property (WebDAVServer Class)

The remote port of the client connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPinnedClientPort();

Unicode (Windows)
INT GetPinnedClientPort();

int secureblackbox_webdavserver_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

PinnedClientPreSharedIdentity Property (WebDAVServer Class)

Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPinnedClientPreSharedIdentity();

Unicode (Windows)
LPWSTR GetPinnedClientPreSharedIdentity();

char* secureblackbox_webdavserver_getpinnedclientpresharedidentity(void* lpObj);

QString GetPinnedClientPreSharedIdentity();

Default Value

""

Remarks

Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.

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

Data Type

String

PinnedClientPublicKeyBits Property (WebDAVServer Class)

The length of the public key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPinnedClientPublicKeyBits();

Unicode (Windows)
INT GetPinnedClientPublicKeyBits();

int secureblackbox_webdavserver_getpinnedclientpublickeybits(void* lpObj);

int GetPinnedClientPublicKeyBits();

Default Value

0

Remarks

The length of the public key.

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

Data Type

Integer

PinnedClientResumedSession Property (WebDAVServer Class)

Indicates whether a TLS-enabled connection was spawned from another TLS connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPinnedClientResumedSession();

Unicode (Windows)
BOOL GetPinnedClientResumedSession();

int secureblackbox_webdavserver_getpinnedclientresumedsession(void* lpObj);

bool GetPinnedClientResumedSession();

Default Value

FALSE

Remarks

Indicates whether a TLS-enabled connection was spawned from another TLS connection

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

Data Type

Boolean

PinnedClientSecureConnection Property (WebDAVServer Class)

Indicates whether TLS or SSL is enabled for this connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPinnedClientSecureConnection();

Unicode (Windows)
BOOL GetPinnedClientSecureConnection();

int secureblackbox_webdavserver_getpinnedclientsecureconnection(void* lpObj);

bool GetPinnedClientSecureConnection();

Default Value

FALSE

Remarks

Indicates whether TLS or SSL is enabled for this connection.

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

Data Type

Boolean

PinnedClientSignatureAlgorithm Property (WebDAVServer Class)

The signature algorithm used in a TLS handshake.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPinnedClientSignatureAlgorithm();

Unicode (Windows)
LPWSTR GetPinnedClientSignatureAlgorithm();

char* secureblackbox_webdavserver_getpinnedclientsignaturealgorithm(void* lpObj);

QString GetPinnedClientSignatureAlgorithm();

Default Value

""

Remarks

The signature algorithm used in a TLS handshake.

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

Data Type

String

PinnedClientSymmetricBlockSize Property (WebDAVServer Class)

The block size of the symmetric algorithm used.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPinnedClientSymmetricBlockSize();

Unicode (Windows)
INT GetPinnedClientSymmetricBlockSize();

int secureblackbox_webdavserver_getpinnedclientsymmetricblocksize(void* lpObj);

int GetPinnedClientSymmetricBlockSize();

Default Value

0

Remarks

The block size of the symmetric algorithm used.

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

Data Type

Integer

PinnedClientSymmetricKeyBits Property (WebDAVServer Class)

The key length of the symmetric algorithm used.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPinnedClientSymmetricKeyBits();

Unicode (Windows)
INT GetPinnedClientSymmetricKeyBits();

int secureblackbox_webdavserver_getpinnedclientsymmetrickeybits(void* lpObj);

int GetPinnedClientSymmetricKeyBits();

Default Value

0

Remarks

The key length of the symmetric algorithm used.

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

Data Type

Integer

PinnedClientTotalBytesReceived Property (WebDAVServer Class)

The total number of bytes received over this connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetPinnedClientTotalBytesReceived();

Unicode (Windows)
LONG64 GetPinnedClientTotalBytesReceived();

int64 secureblackbox_webdavserver_getpinnedclienttotalbytesreceived(void* lpObj);

qint64 GetPinnedClientTotalBytesReceived();

Default Value

0

Remarks

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

The total number of bytes sent over this connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetPinnedClientTotalBytesSent();

Unicode (Windows)
LONG64 GetPinnedClientTotalBytesSent();

int64 secureblackbox_webdavserver_getpinnedclienttotalbytessent(void* lpObj);

qint64 GetPinnedClientTotalBytesSent();

Default Value

0

Remarks

The total number of bytes sent over this connection.

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

Data Type

Long64

PinnedClientValidationLog Property (WebDAVServer Class)

Contains the server certificate's chain validation log.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPinnedClientValidationLog();

Unicode (Windows)
LPWSTR GetPinnedClientValidationLog();

char* secureblackbox_webdavserver_getpinnedclientvalidationlog(void* lpObj);

QString GetPinnedClientValidationLog();

Default Value

""

Remarks

Contains the server certificate's chain validation log. This information may be very useful in investigating chain validation failures.

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

Data Type

String

PinnedClientVersion Property (WebDAVServer Class)

Indicates the version of SSL/TLS protocol negotiated during this connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPinnedClientVersion();

Unicode (Windows)
LPWSTR GetPinnedClientVersion();

char* secureblackbox_webdavserver_getpinnedclientversion(void* lpObj);

QString GetPinnedClientVersion();

Default Value

""

Remarks

Indicates the version of SSL/TLS protocol negotiated during this connection.

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

Data Type

String

PinnedClientCertCount Property (WebDAVServer Class)

The number of records in the PinnedClientCert arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPinnedClientCertCount();

Unicode (Windows)
INT GetPinnedClientCertCount();

int secureblackbox_webdavserver_getpinnedclientcertcount(void* lpObj);

int GetPinnedClientCertCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• PinnedClientCertBytes
• PinnedClientCertCA
• PinnedClientCertCAKeyID
• PinnedClientCertCRLDistributionPoints
• PinnedClientCertCurve
• PinnedClientCertFingerprint
• PinnedClientCertFriendlyName
• PinnedClientCertHandle
• PinnedClientCertHashAlgorithm
• PinnedClientCertIssuer
• PinnedClientCertIssuerRDN
• PinnedClientCertKeyAlgorithm
• PinnedClientCertKeyBits
• PinnedClientCertKeyFingerprint
• PinnedClientCertKeyUsage
• PinnedClientCertKeyValid
• PinnedClientCertOCSPLocations
• PinnedClientCertOCSPNoCheck
• PinnedClientCertOrigin
• PinnedClientCertPolicyIDs
• PinnedClientCertPrivateKeyBytes
• PinnedClientCertPrivateKeyExists
• PinnedClientCertPrivateKeyExtractable
• PinnedClientCertPublicKeyBytes
• PinnedClientCertQualifiedStatements
• PinnedClientCertSelfSigned
• PinnedClientCertSerialNumber
• PinnedClientCertSigAlgorithm
• PinnedClientCertSubject
• PinnedClientCertSubjectAlternativeName
• PinnedClientCertSubjectKeyID
• PinnedClientCertSubjectRDN
• PinnedClientCertValidFrom
• PinnedClientCertValidTo

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

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

Data Type

Integer

PinnedClientCertBytes Property (WebDAVServer Class)

Returns the raw certificate data in DER format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPinnedClientCertBytes(int iPinnedClientCertIndex, char* &lpPinnedClientCertBytes, int &lenPinnedClientCertBytes);

Unicode (Windows)
INT GetPinnedClientCertBytes(INT iPinnedClientCertIndex, LPSTR &lpPinnedClientCertBytes, INT &lenPinnedClientCertBytes);

int secureblackbox_webdavserver_getpinnedclientcertbytes(void* lpObj, int pinnedclientcertindex, char** lpPinnedClientCertBytes, int* lenPinnedClientCertBytes);

QByteArray GetPinnedClientCertBytes(int iPinnedClientCertIndex);

Remarks

Returns the raw certificate data in DER format.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

Byte Array

PinnedClientCertCA Property (WebDAVServer Class)

Indicates whether the certificate has a CA capability (a setting in the BasicConstraints extension).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPinnedClientCertCA(int iPinnedClientCertIndex);

Unicode (Windows)
BOOL GetPinnedClientCertCA(INT iPinnedClientCertIndex);

int secureblackbox_webdavserver_getpinnedclientcertca(void* lpObj, int pinnedclientcertindex);

bool GetPinnedClientCertCA(int iPinnedClientCertIndex);

Default Value

FALSE

Remarks

Indicates whether the certificate has a CA capability (a setting in the BasicConstraints extension).

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

Boolean

PinnedClientCertCAKeyID Property (WebDAVServer Class)

A unique identifier (fingerprint) of the CA certificate's private key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPinnedClientCertCAKeyID(int iPinnedClientCertIndex, char* &lpPinnedClientCertCAKeyID, int &lenPinnedClientCertCAKeyID);

Unicode (Windows)
INT GetPinnedClientCertCAKeyID(INT iPinnedClientCertIndex, LPSTR &lpPinnedClientCertCAKeyID, INT &lenPinnedClientCertCAKeyID);

int secureblackbox_webdavserver_getpinnedclientcertcakeyid(void* lpObj, int pinnedclientcertindex, char** lpPinnedClientCertCAKeyID, int* lenPinnedClientCertCAKeyID);

QByteArray GetPinnedClientCertCAKeyID(int iPinnedClientCertIndex);

Remarks

A unique identifier (fingerprint) of the CA certificate's private key.

Authority Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates produced by the same issuer, but with different public keys.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

Byte Array

PinnedClientCertCRLDistributionPoints Property (WebDAVServer Class)

Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPinnedClientCertCRLDistributionPoints(int iPinnedClientCertIndex);

Unicode (Windows)
LPWSTR GetPinnedClientCertCRLDistributionPoints(INT iPinnedClientCertIndex);

char* secureblackbox_webdavserver_getpinnedclientcertcrldistributionpoints(void* lpObj, int pinnedclientcertindex);

QString GetPinnedClientCertCRLDistributionPoints(int iPinnedClientCertIndex);

Default Value

""

Remarks

Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

String

PinnedClientCertCurve Property (WebDAVServer Class)

Specifies the elliptic curve of the EC public key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPinnedClientCertCurve(int iPinnedClientCertIndex);

Unicode (Windows)
LPWSTR GetPinnedClientCertCurve(INT iPinnedClientCertIndex);

char* secureblackbox_webdavserver_getpinnedclientcertcurve(void* lpObj, int pinnedclientcertindex);

QString GetPinnedClientCertCurve(int iPinnedClientCertIndex);

Default Value

""

Remarks

Specifies the elliptic curve of the EC public key.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

String

PinnedClientCertFingerprint Property (WebDAVServer Class)

Contains the fingerprint (a hash imprint) of this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPinnedClientCertFingerprint(int iPinnedClientCertIndex, char* &lpPinnedClientCertFingerprint, int &lenPinnedClientCertFingerprint);

Unicode (Windows)
INT GetPinnedClientCertFingerprint(INT iPinnedClientCertIndex, LPSTR &lpPinnedClientCertFingerprint, INT &lenPinnedClientCertFingerprint);

int secureblackbox_webdavserver_getpinnedclientcertfingerprint(void* lpObj, int pinnedclientcertindex, char** lpPinnedClientCertFingerprint, int* lenPinnedClientCertFingerprint);

QByteArray GetPinnedClientCertFingerprint(int iPinnedClientCertIndex);

Remarks

Contains the fingerprint (a hash imprint) of this certificate.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

Byte Array

PinnedClientCertFriendlyName Property (WebDAVServer Class)

Contains an associated alias (friendly name) of the certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPinnedClientCertFriendlyName(int iPinnedClientCertIndex);

Unicode (Windows)
LPWSTR GetPinnedClientCertFriendlyName(INT iPinnedClientCertIndex);

char* secureblackbox_webdavserver_getpinnedclientcertfriendlyname(void* lpObj, int pinnedclientcertindex);

QString GetPinnedClientCertFriendlyName(int iPinnedClientCertIndex);

Default Value

""

Remarks

Contains an associated alias (friendly name) of the certificate.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

String

PinnedClientCertHandle Property (WebDAVServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetPinnedClientCertHandle(int iPinnedClientCertIndex);

Unicode (Windows)
LONG64 GetPinnedClientCertHandle(INT iPinnedClientCertIndex);

int64 secureblackbox_webdavserver_getpinnedclientcerthandle(void* lpObj, int pinnedclientcertindex);

qint64 GetPinnedClientCertHandle(int iPinnedClientCertIndex);

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 PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

Long64

PinnedClientCertHashAlgorithm Property (WebDAVServer Class)

Specifies the hash algorithm to be used in the operations on the certificate (such as key signing) SB_HASH_ALGORITHM_SHA1 SHA1 SB_HASH_ALGORITHM_SHA224 SHA224 SB_HASH_ALGORITHM_SHA256 SHA256 SB_HASH_ALGORITHM_SHA384 SHA384 SB_HASH_ALGORITHM_SHA512 SHA512 SB_HASH_ALGORITHM_MD2 MD2 SB_HASH_ALGORITHM_MD4 MD4 SB_HASH_ALGORITHM_MD5 MD5 SB_HASH_ALGORITHM_RIPEMD160 RIPEMD160 SB_HASH_ALGORITHM_CRC32 CRC32 SB_HASH_ALGORITHM_SSL3 SSL3 SB_HASH_ALGORITHM_GOST_R3411_1994 GOST1994 SB_HASH_ALGORITHM_WHIRLPOOL WHIRLPOOL SB_HASH_ALGORITHM_POLY1305 POLY1305 SB_HASH_ALGORITHM_SHA3_224 SHA3_224 SB_HASH_ALGORITHM_SHA3_256 SHA3_256 SB_HASH_ALGORITHM_SHA3_384 SHA3_384 SB_HASH_ALGORITHM_SHA3_512 SHA3_512 SB_HASH_ALGORITHM_BLAKE2S_128 BLAKE2S_128 SB_HASH_ALGORITHM_BLAKE2S_160 BLAKE2S_160 SB_HASH_ALGORITHM_BLAKE2S_224 BLAKE2S_224 SB_HASH_ALGORITHM_BLAKE2S_256 BLAKE2S_256 SB_HASH_ALGORITHM_BLAKE2B_160 BLAKE2B_160 SB_HASH_ALGORITHM_BLAKE2B_256 BLAKE2B_256 SB_HASH_ALGORITHM_BLAKE2B_384 BLAKE2B_384 SB_HASH_ALGORITHM_BLAKE2B_512 BLAKE2B_512 SB_HASH_ALGORITHM_SHAKE_128 SHAKE_128 SB_HASH_ALGORITHM_SHAKE_256 SHAKE_256 SB_HASH_ALGORITHM_SHAKE_128_LEN SHAKE_128_LEN SB_HASH_ALGORITHM_SHAKE_256_LEN SHAKE_256_LEN .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPinnedClientCertHashAlgorithm(int iPinnedClientCertIndex);

Unicode (Windows)
LPWSTR GetPinnedClientCertHashAlgorithm(INT iPinnedClientCertIndex);

char* secureblackbox_webdavserver_getpinnedclientcerthashalgorithm(void* lpObj, int pinnedclientcertindex);

QString GetPinnedClientCertHashAlgorithm(int iPinnedClientCertIndex);

Default Value

""

Remarks

Specifies the hash algorithm to be used in the operations on the certificate (such as key signing)

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

String

PinnedClientCertIssuer Property (WebDAVServer Class)

The common name of the certificate issuer (CA), typically a company name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPinnedClientCertIssuer(int iPinnedClientCertIndex);

Unicode (Windows)
LPWSTR GetPinnedClientCertIssuer(INT iPinnedClientCertIndex);

char* secureblackbox_webdavserver_getpinnedclientcertissuer(void* lpObj, int pinnedclientcertindex);

QString GetPinnedClientCertIssuer(int iPinnedClientCertIndex);

Default Value

""

Remarks

The common name of the certificate issuer (CA), typically a company name.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

String

PinnedClientCertIssuerRDN Property (WebDAVServer Class)

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPinnedClientCertIssuerRDN(int iPinnedClientCertIndex);

Unicode (Windows)
LPWSTR GetPinnedClientCertIssuerRDN(INT iPinnedClientCertIndex);

char* secureblackbox_webdavserver_getpinnedclientcertissuerrdn(void* lpObj, int pinnedclientcertindex);

QString GetPinnedClientCertIssuerRDN(int iPinnedClientCertIndex);

Default Value

""

Remarks

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

String

PinnedClientCertKeyAlgorithm Property (WebDAVServer Class)

Specifies the public key algorithm of this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPinnedClientCertKeyAlgorithm(int iPinnedClientCertIndex);

Unicode (Windows)
LPWSTR GetPinnedClientCertKeyAlgorithm(INT iPinnedClientCertIndex);

char* secureblackbox_webdavserver_getpinnedclientcertkeyalgorithm(void* lpObj, int pinnedclientcertindex);

QString GetPinnedClientCertKeyAlgorithm(int iPinnedClientCertIndex);

Default Value

"0"

Remarks

Specifies the public key algorithm of this certificate.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

String

PinnedClientCertKeyBits Property (WebDAVServer Class)

Returns the length of the public key.